botocore-1.5.7/0000777454262600001440000000000013042511310014400 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/0000777454262600001440000000000013042511307016222 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/stub.py0000666454262600001440000003235713042511306017562 0ustar pysdk-ciamazon00000000000000# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import copy from collections import deque from pprint import pformat from botocore.validate import validate_parameters from botocore.exceptions import ParamValidationError, \ StubResponseError, StubAssertionError from botocore.vendored.requests.models import Response class _ANY(object): """ A helper object that compares equal to everything. Copied from unittest.mock """ def __eq__(self, other): return True def __ne__(self, other): return False def __repr__(self): return '' ANY = _ANY() class Stubber(object): """ This class will allow you to stub out requests so you don't have to hit an endpoint to write tests. Responses are returned first in, first out. If operations are called out of order, or are called with no remaining queued responses, an error will be raised. **Example:** :: import datetime import botocore.session from botocore.stub import Stubber s3 = botocore.session.get_session().create_client('s3') stubber = Stubber(s3) response = { 'IsTruncated': False, 'Name': 'test-bucket', 'MaxKeys': 1000, 'Prefix': '', 'Contents': [{ 'Key': 'test.txt', 'ETag': '"abc123"', 'StorageClass': 'STANDARD', 'LastModified': datetime.datetime(2016, 1, 20, 22, 9), 'Owner': {'ID': 'abc123', 'DisplayName': 'myname'}, 'Size': 14814 }], 'EncodingType': 'url', 'ResponseMetadata': { 'RequestId': 'abc123', 'HTTPStatusCode': 200, 'HostId': 'abc123' }, 'Marker': '' } expected_params = {'Bucket': 'test-bucket'} stubber.add_response('list_objects', response, expected_params) stubber.activate() service_response = s3.list_objects(Bucket='test-bucket') assert service_response == response This class can also be called as a context manager, which will handle activation / deactivation for you. **Example:** :: import datetime import botocore.session from botocore.stub import Stubber s3 = botocore.session.get_session().create_client('s3') response = { "Owner": { "ID": "foo", "DisplayName": "bar" }, "Buckets": [{ "CreationDate": datetime.datetime(2016, 1, 20, 22, 9), "Name": "baz" }] } with Stubber(s3) as stubber: stubber.add_response('list_buckets', response, {}) service_response = s3.list_buckets() assert service_response == response If you have an input paramter that is a randomly generated value, or you otherwise don't care about its value, you can use stub.ANY to ignore it in validation. **Example:** :: import datetime import botocore.session from botocore.stub import Stubber, ANY s3 = botocore.session.get_session().create_client('s3') stubber = Stubber(s3) response = { 'IsTruncated': False, 'Name': 'test-bucket', 'MaxKeys': 1000, 'Prefix': '', 'Contents': [{ 'Key': 'test.txt', 'ETag': '"abc123"', 'StorageClass': 'STANDARD', 'LastModified': datetime.datetime(2016, 1, 20, 22, 9), 'Owner': {'ID': 'abc123', 'DisplayName': 'myname'}, 'Size': 14814 }], 'EncodingType': 'url', 'ResponseMetadata': { 'RequestId': 'abc123', 'HTTPStatusCode': 200, 'HostId': 'abc123' }, 'Marker': '' } expected_params = {'Bucket': ANY} stubber.add_response('list_objects', response, expected_params) with stubber: service_response = s3.list_objects(Bucket='test-bucket') assert service_response == response """ def __init__(self, client): """ :param client: The client to add your stubs to. """ self.client = client self._event_id = 'boto_stubber' self._expected_params_event_id = 'boto_stubber_expected_params' self._queue = deque() def __enter__(self): self.activate() return self def __exit__(self, exception_type, exception_value, traceback): self.deactivate() def activate(self): """ Activates the stubber on the client """ self.client.meta.events.register_first( 'before-parameter-build.*.*', self._assert_expected_params, unique_id=self._expected_params_event_id) self.client.meta.events.register( 'before-call.*.*', self._get_response_handler, unique_id=self._event_id) def deactivate(self): """ Deactivates the stubber on the client """ self.client.meta.events.unregister( 'before-parameter-build.*.*', self._assert_expected_params, unique_id=self._expected_params_event_id) self.client.meta.events.unregister( 'before-call.*.*', self._get_response_handler, unique_id=self._event_id) def add_response(self, method, service_response, expected_params=None): """ Adds a service response to the response queue. This will be validated against the service model to ensure correctness. It should be noted, however, that while missing attributes are often considered correct, your code may not function properly if you leave them out. Therefore you should always fill in every value you see in a typical response for your particular request. :param method: The name of the client method to stub. :type method: str :param service_response: A dict response stub. Provided parameters will be validated against the service model. :type service_response: dict :param expected_params: A dictionary of the expected parameters to be called for the provided service response. The parameters match the names of keyword arguments passed to that client call. If any of the parameters differ a ``StubResponseError`` is thrown. You can use stub.ANY to indicate a particular parameter to ignore in validation. stub.ANY is only valid for top level params. """ self._add_response(method, service_response, expected_params) def _add_response(self, method, service_response, expected_params): if not hasattr(self.client, method): raise ValueError( "Client %s does not have method: %s" % (self.client.meta.service_model.service_name, method)) # Create a successful http response http_response = Response() http_response.status_code = 200 http_response.reason = 'OK' operation_name = self.client.meta.method_to_api_mapping.get(method) self._validate_response(operation_name, service_response) # Add the service_response to the queue for returning responses response = { 'operation_name': operation_name, 'response': (http_response, service_response), 'expected_params': expected_params } self._queue.append(response) def add_client_error(self, method, service_error_code='', service_message='', http_status_code=400, service_error_meta=None, expected_params=None): """ Adds a ``ClientError`` to the response queue. :param method: The name of the service method to return the error on. :type method: str :param service_error_code: The service error code to return, e.g. ``NoSuchBucket`` :type service_error_code: str :param service_message: The service message to return, e.g. 'The specified bucket does not exist.' :type service_message: str :param http_status_code: The HTTP status code to return, e.g. 404, etc :type http_status_code: int :param service_error_meta: Additional keys to be added to the service Error :type service_error_meta: dict :param expected_params: A dictionary of the expected parameters to be called for the provided service response. The parameters match the names of keyword arguments passed to that client call. If any of the parameters differ a ``StubResponseError`` is thrown. You can use stub.ANY to indicate a particular parameter to ignore in validation. """ http_response = Response() http_response.status_code = http_status_code # We don't look to the model to build this because the caller would # need to know the details of what the HTTP body would need to # look like. parsed_response = { 'ResponseMetadata': {'HTTPStatusCode': http_status_code}, 'Error': { 'Message': service_message, 'Code': service_error_code } } if service_error_meta is not None: parsed_response['Error'].update(service_error_meta) operation_name = self.client.meta.method_to_api_mapping.get(method) # Note that we do not allow for expected_params while # adding errors into the queue yet. response = { 'operation_name': operation_name, 'response': (http_response, parsed_response), 'expected_params': expected_params, } self._queue.append(response) def assert_no_pending_responses(self): """ Asserts that all expected calls were made. """ remaining = len(self._queue) if remaining != 0: raise AssertionError( "%d responses remaining in queue." % remaining) def _assert_expected_call_order(self, model, params): if not self._queue: raise StubResponseError( operation_name=model.name, reason=('Unexpected API Call: called with parameters:\n%s' % pformat(params))) name = self._queue[0]['operation_name'] if name != model.name: raise StubResponseError( operation_name=model.name, reason='Operation mismatch: found response for %s.' % name) def _get_response_handler(self, model, params, **kwargs): self._assert_expected_call_order(model, params) # Pop off the entire response once everything has been validated return self._queue.popleft()['response'] def _assert_expected_params(self, model, params, **kwargs): self._assert_expected_call_order(model, params) expected_params = self._queue[0]['expected_params'] if expected_params is None: return # Validate the parameters are equal for param, value in expected_params.items(): if param not in params or expected_params[param] != params[param]: raise StubAssertionError( operation_name=model.name, reason='Expected parameters:\n%s,\nbut received:\n%s' % ( pformat(expected_params), pformat(params))) # Ensure there are no extra params hanging around if sorted(expected_params.keys()) != sorted(params.keys()): raise StubAssertionError( operation_name=model.name, reason='Expected parameters:\n%s,\nbut received:\n%s' % ( pformat(expected_params), pformat(params))) def _validate_response(self, operation_name, service_response): service_model = self.client.meta.service_model operation_model = service_model.operation_model(operation_name) output_shape = operation_model.output_shape # Remove ResponseMetadata so that the validator doesn't attempt to # perform validation on it. response = service_response if 'ResponseMetadata' in response: response = copy.copy(service_response) del response['ResponseMetadata'] if output_shape is not None: validate_parameters(response, output_shape) elif response: # If the output shape is None, that means the response should be # empty apart from ResponseMetadata raise ParamValidationError( report=( "Service response should only contain ResponseMetadata.")) botocore-1.5.7/botocore/serialize.py0000666454262600001440000006507213042511306020574 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. """Protocol input serializes. This module contains classes that implement input serialization for the various AWS protocol types. These classes essentially take user input, a model object that represents what the expected input should look like, and it returns a dictionary that contains the various parts of a request. A few high level design decisions: * Each protocol type maps to a separate class, all inherit from ``Serializer``. * The return value for ``serialize_to_request`` (the main entry point) returns a dictionary that represents a request. This will have keys like ``url_path``, ``query_string``, etc. This is done so that it's a) easy to test and b) not tied to a particular HTTP library. See the ``serialize_to_request`` docstring for more details. Unicode ------- The input to the serializers should be text (str/unicode), not bytes, with the exception of blob types. Those are assumed to be binary, and if a str/unicode type is passed in, it will be encoded as utf-8. """ import re import base64 from xml.etree import ElementTree import calendar from botocore.compat import six from botocore.compat import json, formatdate from botocore.utils import parse_to_aware_datetime from botocore.utils import percent_encode from botocore import validate # From the spec, the default timestamp format if not specified is iso8601. DEFAULT_TIMESTAMP_FORMAT = 'iso8601' ISO8601 = '%Y-%m-%dT%H:%M:%SZ' # Same as ISO8601, but with microsecond precision. ISO8601_MICRO = '%Y-%m-%dT%H:%M:%S.%fZ' def create_serializer(protocol_name, include_validation=True): # TODO: Unknown protocols. serializer = SERIALIZERS[protocol_name]() if include_validation: validator = validate.ParamValidator() serializer = validate.ParamValidationDecorator(validator, serializer) return serializer class Serializer(object): DEFAULT_METHOD = 'POST' # Clients can change this to a different MutableMapping # (i.e OrderedDict) if they want. This is used in the # compliance test to match the hash ordering used in the # tests. MAP_TYPE = dict DEFAULT_ENCODING = 'utf-8' def serialize_to_request(self, parameters, operation_model): """Serialize parameters into an HTTP request. This method takes user provided parameters and a shape model and serializes the parameters to an HTTP request. More specifically, this method returns information about parts of the HTTP request, it does not enforce a particular interface or standard for an HTTP request. It instead returns a dictionary of: * 'url_path' * 'query_string' * 'headers' * 'body' * 'method' It is then up to consumers to decide how to map this to a Request object of their HTTP library of choice. Below is an example return value:: {'body': {'Action': 'OperationName', 'Bar': 'val2', 'Foo': 'val1', 'Version': '2014-01-01'}, 'headers': {}, 'method': 'POST', 'query_string': '', 'url_path': '/'} :param parameters: The dictionary input parameters for the operation (i.e the user input). :param operation_model: The OperationModel object that describes the operation. """ raise NotImplementedError("serialize_to_request") def _create_default_request(self): # Creates a boilerplate default request dict that subclasses # can use as a starting point. serialized = { 'url_path': '/', 'query_string': '', 'method': self.DEFAULT_METHOD, 'headers': {}, # An empty body is represented as an empty byte string. 'body': b'' } return serialized # Some extra utility methods subclasses can use. def _timestamp_iso8601(self, value): if value.microsecond > 0: timestamp_format = ISO8601_MICRO else: timestamp_format = ISO8601 return value.strftime(timestamp_format) def _timestamp_unixtimestamp(self, value): return int(calendar.timegm(value.timetuple())) def _timestamp_rfc822(self, value): return formatdate(value, usegmt=True) def _convert_timestamp_to_str(self, value): datetime_obj = parse_to_aware_datetime(value) converter = getattr( self, '_timestamp_%s' % self.TIMESTAMP_FORMAT.lower()) final_value = converter(datetime_obj) return final_value def _get_serialized_name(self, shape, default_name): # Returns the serialized name for the shape if it exists. # Otherwise it will return the passed in default_name. return shape.serialization.get('name', default_name) def _get_base64(self, value): # Returns the base64-encoded version of value, handling # both strings and bytes. The returned value is a string # via the default encoding. if isinstance(value, six.text_type): value = value.encode(self.DEFAULT_ENCODING) return base64.b64encode(value).strip().decode( self.DEFAULT_ENCODING) class QuerySerializer(Serializer): TIMESTAMP_FORMAT = 'iso8601' def serialize_to_request(self, parameters, operation_model): shape = operation_model.input_shape serialized = self._create_default_request() serialized['method'] = operation_model.http.get('method', self.DEFAULT_METHOD) # The query serializer only deals with body params so # that's what we hand off the _serialize_* methods. body_params = self.MAP_TYPE() body_params['Action'] = operation_model.name body_params['Version'] = operation_model.metadata['apiVersion'] if shape is not None: self._serialize(body_params, parameters, shape) serialized['body'] = body_params return serialized def _serialize(self, serialized, value, shape, prefix=''): # serialized: The dict that is incrementally added to with the # final serialized parameters. # value: The current user input value. # shape: The shape object that describes the structure of the # input. # prefix: The incrementally built up prefix for the serialized # key (i.e Foo.bar.members.1). method = getattr(self, '_serialize_type_%s' % shape.type_name, self._default_serialize) method(serialized, value, shape, prefix=prefix) def _serialize_type_structure(self, serialized, value, shape, prefix=''): members = shape.members for key, value in value.items(): member_shape = members[key] member_prefix = self._get_serialized_name(member_shape, key) if prefix: member_prefix = '%s.%s' % (prefix, member_prefix) self._serialize(serialized, value, member_shape, member_prefix) def _serialize_type_list(self, serialized, value, shape, prefix=''): if not value: # The query protocol serializes empty lists. serialized[prefix] = '' return if self._is_shape_flattened(shape): list_prefix = prefix if shape.member.serialization.get('name'): name = self._get_serialized_name(shape.member, default_name='') # Replace '.Original' with '.{name}'. list_prefix = '.'.join(prefix.split('.')[:-1] + [name]) else: list_name = shape.member.serialization.get('name', 'member') list_prefix = '%s.%s' % (prefix, list_name) for i, element in enumerate(value, 1): element_prefix = '%s.%s' % (list_prefix, i) element_shape = shape.member self._serialize(serialized, element, element_shape, element_prefix) def _serialize_type_map(self, serialized, value, shape, prefix=''): if self._is_shape_flattened(shape): full_prefix = prefix else: full_prefix = '%s.entry' % prefix template = full_prefix + '.{i}.{suffix}' key_shape = shape.key value_shape = shape.value key_suffix = self._get_serialized_name(key_shape, default_name='key') value_suffix = self._get_serialized_name(value_shape, 'value') for i, key in enumerate(value, 1): key_prefix = template.format(i=i, suffix=key_suffix) value_prefix = template.format(i=i, suffix=value_suffix) self._serialize(serialized, key, key_shape, key_prefix) self._serialize(serialized, value[key], value_shape, value_prefix) def _serialize_type_blob(self, serialized, value, shape, prefix=''): # Blob args must be base64 encoded. serialized[prefix] = self._get_base64(value) def _serialize_type_timestamp(self, serialized, value, shape, prefix=''): serialized[prefix] = self._convert_timestamp_to_str(value) def _serialize_type_boolean(self, serialized, value, shape, prefix=''): if value: serialized[prefix] = 'true' else: serialized[prefix] = 'false' def _default_serialize(self, serialized, value, shape, prefix=''): serialized[prefix] = value def _is_shape_flattened(self, shape): return shape.serialization.get('flattened') class EC2Serializer(QuerySerializer): """EC2 specific customizations to the query protocol serializers. The EC2 model is almost, but not exactly, similar to the query protocol serializer. This class encapsulates those differences. The model will have be marked with a ``protocol`` of ``ec2``, so you don't need to worry about wiring this class up correctly. """ def _get_serialized_name(self, shape, default_name): # Returns the serialized name for the shape if it exists. # Otherwise it will return the passed in default_name. if 'queryName' in shape.serialization: return shape.serialization['queryName'] elif 'name' in shape.serialization: # A locationName is always capitalized # on input for the ec2 protocol. name = shape.serialization['name'] return name[0].upper() + name[1:] else: return default_name def _serialize_type_list(self, serialized, value, shape, prefix=''): for i, element in enumerate(value, 1): element_prefix = '%s.%s' % (prefix, i) element_shape = shape.member self._serialize(serialized, element, element_shape, element_prefix) class JSONSerializer(Serializer): TIMESTAMP_FORMAT = 'unixtimestamp' def serialize_to_request(self, parameters, operation_model): target = '%s.%s' % (operation_model.metadata['targetPrefix'], operation_model.name) json_version = operation_model.metadata['jsonVersion'] serialized = self._create_default_request() serialized['method'] = operation_model.http.get('method', self.DEFAULT_METHOD) serialized['headers'] = { 'X-Amz-Target': target, 'Content-Type': 'application/x-amz-json-%s' % json_version, } body = {} input_shape = operation_model.input_shape if input_shape is not None: self._serialize(body, parameters, input_shape) serialized['body'] = json.dumps(body).encode(self.DEFAULT_ENCODING) return serialized def _serialize(self, serialized, value, shape, key=None): method = getattr(self, '_serialize_type_%s' % shape.type_name, self._default_serialize) method(serialized, value, shape, key) def _serialize_type_structure(self, serialized, value, shape, key): if key is not None: # If a key is provided, this is a result of a recursive # call so we need to add a new child dict as the value # of the passed in serialized dict. We'll then add # all the structure members as key/vals in the new serialized # dictionary we just created. new_serialized = self.MAP_TYPE() serialized[key] = new_serialized serialized = new_serialized members = shape.members for member_key, member_value in value.items(): member_shape = members[member_key] if 'name' in member_shape.serialization: member_key = member_shape.serialization['name'] self._serialize(serialized, member_value, member_shape, member_key) def _serialize_type_map(self, serialized, value, shape, key): map_obj = self.MAP_TYPE() serialized[key] = map_obj for sub_key, sub_value in value.items(): self._serialize(map_obj, sub_value, shape.value, sub_key) def _serialize_type_list(self, serialized, value, shape, key): list_obj = [] serialized[key] = list_obj for list_item in value: wrapper = {} # The JSON list serialization is the only case where we aren't # setting a key on a dict. We handle this by using # a __current__ key on a wrapper dict to serialize each # list item before appending it to the serialized list. self._serialize(wrapper, list_item, shape.member, "__current__") list_obj.append(wrapper["__current__"]) def _default_serialize(self, serialized, value, shape, key): serialized[key] = value def _serialize_type_timestamp(self, serialized, value, shape, key): serialized[key] = self._convert_timestamp_to_str(value) def _serialize_type_blob(self, serialized, value, shape, key): serialized[key] = self._get_base64(value) class BaseRestSerializer(Serializer): """Base class for rest protocols. The only variance between the various rest protocols is the way that the body is serialized. All other aspects (headers, uri, etc.) are the same and logic for serializing those aspects lives here. Subclasses must implement the ``_serialize_body_params`` method. """ # This is a list of known values for the "location" key in the # serialization dict. The location key tells us where on the request # to put the serialized value. KNOWN_LOCATIONS = ['uri', 'querystring', 'header', 'headers'] def serialize_to_request(self, parameters, operation_model): serialized = self._create_default_request() serialized['method'] = operation_model.http.get('method', self.DEFAULT_METHOD) shape = operation_model.input_shape if shape is None: serialized['url_path'] = operation_model.http['requestUri'] return serialized shape_members = shape.members # While the ``serialized`` key holds the final serialized request # data, we need interim dicts for the various locations of the # request. We need this for the uri_path_kwargs and the # query_string_kwargs because they are templated, so we need # to gather all the needed data for the string template, # then we render the template. The body_kwargs is needed # because once we've collected them all, we run them through # _serialize_body_params, which for rest-json, creates JSON, # and for rest-xml, will create XML. This is what the # ``partitioned`` dict below is for. partitioned = { 'uri_path_kwargs': self.MAP_TYPE(), 'query_string_kwargs': self.MAP_TYPE(), 'body_kwargs': self.MAP_TYPE(), 'headers': self.MAP_TYPE(), } for param_name, param_value in parameters.items(): if param_value is None: # Don't serialize any parameter with a None value. continue self._partition_parameters(partitioned, param_name, param_value, shape_members) serialized['url_path'] = self._render_uri_template( operation_model.http['requestUri'], partitioned['uri_path_kwargs']) # Note that we lean on the http implementation to handle the case # where the requestUri path already has query parameters. # The bundled http client, requests, already supports this. serialized['query_string'] = partitioned['query_string_kwargs'] if partitioned['headers']: serialized['headers'] = partitioned['headers'] self._serialize_payload(partitioned, parameters, serialized, shape, shape_members) return serialized def _render_uri_template(self, uri_template, params): # We need to handle two cases:: # # /{Bucket}/foo # /{Key+}/bar # A label ending with '+' is greedy. There can only # be one greedy key. encoded_params = {} for template_param in re.findall(r'{(.*?)}', uri_template): if template_param.endswith('+'): encoded_params[template_param] = percent_encode( params[template_param[:-1]], safe='/~') else: encoded_params[template_param] = percent_encode( params[template_param]) return uri_template.format(**encoded_params) def _serialize_payload(self, partitioned, parameters, serialized, shape, shape_members): # partitioned - The user input params partitioned by location. # parameters - The user input params. # serialized - The final serialized request dict. # shape - Describes the expected input shape # shape_members - The members of the input struct shape payload_member = shape.serialization.get('payload') if payload_member is not None and \ shape_members[payload_member].type_name in ['blob', 'string']: # If it's streaming, then the body is just the # value of the payload. body_payload = parameters.get(payload_member, b'') body_payload = self._encode_payload(body_payload) serialized['body'] = body_payload elif payload_member is not None: # If there's a payload member, we serialized that # member to they body. body_params = parameters.get(payload_member) if body_params is not None: serialized['body'] = self._serialize_body_params( body_params, shape_members[payload_member]) elif partitioned['body_kwargs']: serialized['body'] = self._serialize_body_params( partitioned['body_kwargs'], shape) def _encode_payload(self, body): if isinstance(body, six.text_type): return body.encode(self.DEFAULT_ENCODING) return body def _partition_parameters(self, partitioned, param_name, param_value, shape_members): # This takes the user provided input parameter (``param``) # and figures out where they go in the request dict. # Some params are HTTP headers, some are used in the URI, some # are in the request body. This method deals with this. member = shape_members[param_name] location = member.serialization.get('location') key_name = member.serialization.get('name', param_name) if location == 'uri': partitioned['uri_path_kwargs'][key_name] = param_value elif location == 'querystring': if isinstance(param_value, dict): partitioned['query_string_kwargs'].update(param_value) elif isinstance(param_value, bool): partitioned['query_string_kwargs'][ key_name] = str(param_value).lower() else: partitioned['query_string_kwargs'][key_name] = param_value elif location == 'header': shape = shape_members[param_name] value = self._convert_header_value(shape, param_value) partitioned['headers'][key_name] = str(value) elif location == 'headers': # 'headers' is a bit of an oddball. The ``key_name`` # is actually really a prefix for the header names: header_prefix = key_name # The value provided by the user is a dict so we'll be # creating multiple header key/val pairs. The key # name to use for each header is the header_prefix (``key_name``) # plus the key provided by the user. self._do_serialize_header_map(header_prefix, partitioned['headers'], param_value) else: partitioned['body_kwargs'][param_name] = param_value def _do_serialize_header_map(self, header_prefix, headers, user_input): for key, val in user_input.items(): full_key = header_prefix + key headers[full_key] = val def _serialize_body_params(self, params, shape): raise NotImplementedError('_serialize_body_params') def _convert_header_value(self, shape, value): if shape.type_name == 'timestamp': datetime_obj = parse_to_aware_datetime(value) timestamp = calendar.timegm(datetime_obj.utctimetuple()) return self._timestamp_rfc822(timestamp) else: return value class RestJSONSerializer(BaseRestSerializer, JSONSerializer): def _serialize_body_params(self, params, shape): serialized_body = self.MAP_TYPE() self._serialize(serialized_body, params, shape) return json.dumps(serialized_body).encode(self.DEFAULT_ENCODING) class RestXMLSerializer(BaseRestSerializer): TIMESTAMP_FORMAT = 'iso8601' def _serialize_body_params(self, params, shape): root_name = shape.serialization['name'] pseudo_root = ElementTree.Element('') self._serialize(shape, params, pseudo_root, root_name) real_root = list(pseudo_root)[0] return ElementTree.tostring(real_root, encoding=self.DEFAULT_ENCODING) def _serialize(self, shape, params, xmlnode, name): method = getattr(self, '_serialize_type_%s' % shape.type_name, self._default_serialize) method(xmlnode, params, shape, name) def _serialize_type_structure(self, xmlnode, params, shape, name): structure_node = ElementTree.SubElement(xmlnode, name) if 'xmlNamespace' in shape.serialization: namespace_metadata = shape.serialization['xmlNamespace'] attribute_name = 'xmlns' if namespace_metadata.get('prefix'): attribute_name += ':%s' % namespace_metadata['prefix'] structure_node.attrib[attribute_name] = namespace_metadata['uri'] for key, value in params.items(): member_shape = shape.members[key] member_name = member_shape.serialization.get('name', key) # We need to special case member shapes that are marked as an # xmlAttribute. Rather than serializing into an XML child node, # we instead serialize the shape to an XML attribute of the # *current* node. if value is None: # Don't serialize any param whose value is None. return if member_shape.serialization.get('xmlAttribute'): # xmlAttributes must have a serialization name. xml_attribute_name = member_shape.serialization['name'] structure_node.attrib[xml_attribute_name] = value continue self._serialize(member_shape, value, structure_node, member_name) def _serialize_type_list(self, xmlnode, params, shape, name): member_shape = shape.member if shape.serialization.get('flattened'): element_name = name list_node = xmlnode else: element_name = member_shape.serialization.get('name', 'member') list_node = ElementTree.SubElement(xmlnode, name) for item in params: self._serialize(member_shape, item, list_node, element_name) def _serialize_type_map(self, xmlnode, params, shape, name): # Given the ``name`` of MyMap, and input of {"key1": "val1"} # we serialize this as: # # # key1 # val1 # # node = ElementTree.SubElement(xmlnode, name) # TODO: handle flattened maps. for key, value in params.items(): entry_node = ElementTree.SubElement(node, 'entry') key_name = self._get_serialized_name(shape.key, default_name='key') val_name = self._get_serialized_name(shape.value, default_name='value') self._serialize(shape.key, key, entry_node, key_name) self._serialize(shape.value, value, entry_node, val_name) def _serialize_type_boolean(self, xmlnode, params, shape, name): # For scalar types, the 'params' attr is actually just a scalar # value representing the data we need to serialize as a boolean. # It will either be 'true' or 'false' node = ElementTree.SubElement(xmlnode, name) if params: str_value = 'true' else: str_value = 'false' node.text = str_value def _serialize_type_blob(self, xmlnode, params, shape, name): node = ElementTree.SubElement(xmlnode, name) node.text = self._get_base64(params) def _serialize_type_timestamp(self, xmlnode, params, shape, name): node = ElementTree.SubElement(xmlnode, name) node.text = self._convert_timestamp_to_str(params) def _default_serialize(self, xmlnode, params, shape, name): node = ElementTree.SubElement(xmlnode, name) node.text = six.text_type(params) SERIALIZERS = { 'ec2': EC2Serializer, 'query': QuerySerializer, 'json': JSONSerializer, 'rest-json': RestJSONSerializer, 'rest-xml': RestXMLSerializer, } botocore-1.5.7/botocore/auth.py0000666454262600001440000007725613042511306017555 0ustar pysdk-ciamazon00000000000000# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. 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 import time import calendar import json from botocore.exceptions import NoCredentialsError from botocore.utils import normalize_url_path, percent_encode_sequence from botocore.compat import HTTPHeaders from botocore.compat import quote, unquote, urlsplit, parse_qs from botocore.compat import urlunsplit from botocore.compat import encodebytes from botocore.compat import six from botocore.compat import json from botocore.compat import MD5_AVAILABLE 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 ISO8601 = '%Y-%m-%dT%H:%M:%SZ' SIGV4_TIMESTAMP = '%Y%m%dT%H%M%SZ' SIGNED_HEADERS_BLACKLIST = [ 'expect', 'user-agent', 'x-amzn-trace-id', ] 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 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): # Any previous signature should not be a part of this # one, so we skip that particular key. This prevents # issues during retries. if key == 'Signature': continue value = six.text_type(params[key]) pairs.append(quote(key.encode('utf-8'), safe='') + '=' + quote(value.encode('utf-8'), 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 self.credentials is None: raise NoCredentialsError 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'] = time.strftime(ISO8601, time.gmtime()) 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 def add_auth(self, request): if self.credentials is None: raise NoCredentialsError if 'Date' in request.headers: del request.headers['Date'] request.headers['Date'] = formatdate(usegmt=True) if self.credentials.token: if 'X-Amz-Security-Token' in request.headers: del request.headers['X-Amz-Security-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 = encodebytes(new_hmac.digest()).strip() signature = ('AWS3-HTTPS AWSAccessKeyId=%s,Algorithm=%s,Signature=%s' % (self.credentials.access_key, 'HmacSHA256', encoded_signature.decode('utf-8'))) if 'X-Amzn-Authorization' in request.headers: del request.headers['X-Amzn-Authorization'] 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 # 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. 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() if lname not in SIGNED_HEADERS_BLACKLIST: header_map[lname] = value if 'host' not in header_map: header_map['host'] = split.netloc return header_map def canonical_query_string(self, request): # The query string can come from two parts. One is the # params attribute of the request. The other is from the request # url (in which case we have to re-split the url into its components # and parse out the query string component). if request.params: return self._canonical_query_string_params(request.params) else: return self._canonical_query_string_url(urlsplit(request.url)) def _canonical_query_string_params(self, params): l = [] for param in sorted(params): value = str(params[param]) l.append('%s=%s' % (quote(param, safe='-_.~'), quote(value, safe='-_.~'))) cqs = '&'.join(l) return cqs def _canonical_query_string_url(self, parts): canonical_query_string = '' if parts.query: # [(key, value), (key2, value2)] key_val_pairs = [] for pair in parts.query.split('&'): key, _, value = pair.partition('=') key_val_pairs.append((key, value)) sorted_key_vals = [] # Sort by the key names, and in the case of # repeated keys, then sort by the value. for key, value in sorted(key_val_pairs): sorted_key_vals.append('%s=%s' % (key, value)) canonical_query_string = '&'.join(sorted_key_vals) return canonical_query_string 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: # The request serialization has ensured that # request.body is a bytes() type. return sha256(request.body).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): normalized_path = quote(normalize_url_path(path), safe='/~') return normalized_path def scope(self, request): scope = [self.credentials.access_key] scope.append(request.context['timestamp'][0:8]) scope.append(self._region_name) scope.append(self._service_name) scope.append('aws4_request') return '/'.join(scope) def credential_scope(self, request): scope = [] scope.append(request.context['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(request.context['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, request): key = self.credentials.secret_key k_date = self._sign(('AWS4' + key).encode('utf-8'), request.context['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): if self.credentials is None: raise NoCredentialsError datetime_now = datetime.datetime.utcnow() request.context['timestamp'] = datetime_now.strftime(SIGV4_TIMESTAMP) # This could be a retry. Make sure the previous # authorization header is removed first. self._modify_request_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, request) logger.debug('Signature:\n%s', signature) self._inject_signature_to_request(request, signature) def _inject_signature_to_request(self, request, 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 _modify_request_before_signing(self, request): if 'Authorization' in request.headers: del request.headers['Authorization'] self._set_necessary_date_headers(request) if self.credentials.token: if 'X-Amz-Security-Token' in request.headers: del request.headers['X-Amz-Security-Token'] request.headers['X-Amz-Security-Token'] = self.credentials.token def _set_necessary_date_headers(self, request): # The spec allows for either the Date _or_ the X-Amz-Date value to be # used so we check both. If there's a Date header, we use the date # header. Otherwise we use the X-Amz-Date header. if 'Date' in request.headers: del request.headers['Date'] datetime_timestamp = datetime.datetime.strptime( request.context['timestamp'], SIGV4_TIMESTAMP) request.headers['Date'] = formatdate( int(calendar.timegm(datetime_timestamp.timetuple()))) if 'X-Amz-Date' in request.headers: del request.headers['X-Amz-Date'] else: if 'X-Amz-Date' in request.headers: del request.headers['X-Amz-Date'] request.headers['X-Amz-Date'] = request.context['timestamp'] class S3SigV4Auth(SigV4Auth): def __init__(self, credentials, service_name, region_name): super(S3SigV4Auth, self).__init__( credentials, service_name, region_name) self._default_region_name = region_name def add_auth(self, request): # If we ever decide to share auth sessions, this could potentially be # a source of concurrency bugs. signing_context = request.context.get('signing', {}) self._region_name = signing_context.get( 'region', self._default_region_name) super(S3SigV4Auth, self).add_auth(request) def _modify_request_before_signing(self, request): super(S3SigV4Auth, self)._modify_request_before_signing(request) if 'X-Amz-Content-SHA256' in request.headers: del request.headers['X-Amz-Content-SHA256'] if self._should_sha256_sign_payload(request): request.headers['X-Amz-Content-SHA256'] = self.payload(request) else: request.headers['X-Amz-Content-SHA256'] = 'UNSIGNED-PAYLOAD' def _should_sha256_sign_payload(self, request): # S3 allows optional body signing, so to minimize the performance # impact, we opt to not SHA256 sign the body on streaming uploads, # provided that we're on https. client_config = request.context.get('client_config') s3_config = getattr(client_config, 's3', None) # The config could be None if it isn't set, or if the customer sets it # to None. if s3_config is None: s3_config = {} sign_payload = s3_config.get('payload_signing_enabled', None) if sign_payload is not None: return sign_payload if 'Content-MD5' in request.headers and 'https' in request.url and \ request.context.get('has_streaming_input', False): return False return True def _normalize_url_path(self, path): # For S3, we do not normalize the path. return path class SigV4QueryAuth(SigV4Auth): DEFAULT_EXPIRES = 3600 def __init__(self, credentials, service_name, region_name, expires=DEFAULT_EXPIRES): super(SigV4QueryAuth, self).__init__(credentials, service_name, region_name) self._expires = expires def _modify_request_before_signing(self, request): # Note that we're not including X-Amz-Signature. # From the docs: "The Canonical Query String must include all the query # parameters from the preceding table except for X-Amz-Signature. signed_headers = self.signed_headers(self.headers_to_sign(request)) auth_params = { 'X-Amz-Algorithm': 'AWS4-HMAC-SHA256', 'X-Amz-Credential': self.scope(request), 'X-Amz-Date': request.context['timestamp'], 'X-Amz-Expires': self._expires, 'X-Amz-SignedHeaders': signed_headers, } if self.credentials.token is not None: auth_params['X-Amz-Security-Token'] = self.credentials.token # Now parse the original query string to a dict, inject our new query # params, and serialize back to a query string. url_parts = urlsplit(request.url) # parse_qs makes each value a list, but in our case we know we won't # have repeated keys so we know we have single element lists which we # can convert back to scalar values. query_dict = dict( [(k, v[0]) for k, v in parse_qs(url_parts.query, keep_blank_values=True).items()]) # The spec is particular about this. It *has* to be: # https://?& # You can't mix the two types of params together, i.e just keep doing # new_query_params.update(op_params) # new_query_params.update(auth_params) # percent_encode_sequence(new_query_params) operation_params = '' if request.data: # We also need to move the body params into the query string. To # do this, we first have to convert it to a dict. query_dict.update(self._get_body_as_dict(request)) request.data = '' if query_dict: operation_params = percent_encode_sequence(query_dict) + '&' new_query_string = (operation_params + percent_encode_sequence(auth_params)) # url_parts is a tuple (and therefore immutable) so we need to create # a new url_parts with the new query string. # - # scheme - 0 # netloc - 1 # path - 2 # query - 3 <-- we're replacing this. # fragment - 4 p = url_parts new_url_parts = (p[0], p[1], p[2], new_query_string, p[4]) request.url = urlunsplit(new_url_parts) def _get_body_as_dict(self, request): # For query services, request.data is form-encoded and is already a # dict, but for other services such as rest-json it could be a json # string or bytes. In those cases we attempt to load the data as a # dict. data = request.data if isinstance(data, six.binary_type): data = json.loads(data.decode('utf-8')) elif isinstance(data, six.string_types): data = json.loads(data) return data def _inject_signature_to_request(self, request, signature): # Rather than calculating an "Authorization" header, for the query # param quth, we just append an 'X-Amz-Signature' param to the end # of the query string. request.url += '&X-Amz-Signature=%s' % signature class S3SigV4QueryAuth(SigV4QueryAuth): """S3 SigV4 auth using query parameters. This signer will sign a request using query parameters and signature version 4, i.e a "presigned url" signer. Based off of: http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html """ def _normalize_url_path(self, path): # For S3, we do not normalize the path. return path def payload(self, request): # From the doc link above: # "You don't include a payload hash in the Canonical Request, because # when you create a presigned URL, you don't know anything about the # payload. Instead, you use a constant string "UNSIGNED-PAYLOAD". return "UNSIGNED-PAYLOAD" class S3SigV4PostAuth(SigV4Auth): """ Presigns a s3 post Implementation doc here: http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-UsingHTTPPOST.html """ def add_auth(self, request): datetime_now = datetime.datetime.utcnow() request.context['timestamp'] = datetime_now.strftime(SIGV4_TIMESTAMP) fields = {} if request.context.get('s3-presign-post-fields', None) is not None: fields = request.context['s3-presign-post-fields'] policy = {} conditions = [] if request.context.get('s3-presign-post-policy', None) is not None: policy = request.context['s3-presign-post-policy'] if policy.get('conditions', None) is not None: conditions = policy['conditions'] policy['conditions'] = conditions fields['x-amz-algorithm'] = 'AWS4-HMAC-SHA256' fields['x-amz-credential'] = self.scope(request) fields['x-amz-date'] = request.context['timestamp'] conditions.append({'x-amz-algorithm': 'AWS4-HMAC-SHA256'}) conditions.append({'x-amz-credential': self.scope(request)}) conditions.append({'x-amz-date': request.context['timestamp']}) if self.credentials.token is not None: fields['x-amz-security-token'] = self.credentials.token conditions.append({'x-amz-security-token': self.credentials.token}) # Dump the base64 encoded policy into the fields dictionary. fields['policy'] = base64.b64encode( json.dumps(policy).encode('utf-8')).decode('utf-8') fields['x-amz-signature'] = self.signature(fields['policy'], request) request.context['s3-presign-post-fields'] = fields request.context['s3-presign-post-policy'] = policy class HmacV1Auth(BaseSigner): # List of Query String Arguments of Interest QSAOfInterest = ['accelerate', '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', 'replication', 'requestPayment', 'analytics', 'metrics', 'inventory'] def __init__(self, credentials, service_name=None, region_name=None): self.credentials = credentials 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 encodebytes(new_hmac.digest()).strip().decode('utf-8') def canonical_standard_headers(self, headers): interesting_headers = ['content-md5', 'content-type', 'date'] hoi = [] if 'Date' in headers: del headers['Date'] headers['Date'] = self._get_date() 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): hoi = [] custom_headers = {} for key in headers: lk = key.lower() if headers[key] is not None: 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()) 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, auth_path=None): # 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 auth_path is not None: buf = 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, auth_path=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, auth_path=auth_path) return cs def get_signature(self, method, split, headers, expires=None, auth_path=None): if self.credentials.token: del headers['x-amz-security-token'] headers['x-amz-security-token'] = self.credentials.token string_to_sign = self.canonical_string(method, split, headers, auth_path=auth_path) logger.debug('StringToSign:\n%s', string_to_sign) return self.sign_string(string_to_sign) def add_auth(self, request): if self.credentials is None: raise NoCredentialsError 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, auth_path=request.auth_path) self._inject_signature(request, signature) def _get_date(self): return formatdate(usegmt=True) def _inject_signature(self, request, signature): if 'Authorization' in request.headers: # We have to do this because request.headers is not # normal dictionary. It has the (unintuitive) behavior # of aggregating repeated setattr calls for the same # key value. For example: # headers['foo'] = 'a'; headers['foo'] = 'b' # list(headers) will print ['foo', 'foo']. del request.headers['Authorization'] request.headers['Authorization'] = ( "AWS %s:%s" % (self.credentials.access_key, signature)) class HmacV1QueryAuth(HmacV1Auth): """ Generates a presigned request for s3. Spec from this document: http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html #RESTAuthenticationQueryStringAuth """ DEFAULT_EXPIRES = 3600 def __init__(self, credentials, expires=DEFAULT_EXPIRES): self.credentials = credentials self._expires = expires def _get_date(self): return str(int(time.time() + int(self._expires))) def _inject_signature(self, request, signature): query_dict = {} query_dict['AWSAccessKeyId'] = self.credentials.access_key query_dict['Signature'] = signature for header_key in request.headers: lk = header_key.lower() # For query string requests, Expires is used instead of the # Date header. if header_key == 'Date': query_dict['Expires'] = request.headers['Date'] # We only want to include relevant headers in the query string. # These can be anything that starts with x-amz, is Content-MD5, # or is Content-Type. elif lk.startswith('x-amz-') or lk in ['content-md5', 'content-type']: query_dict[lk] = request.headers[lk] # Combine all of the identified headers into an encoded # query string new_query_string = percent_encode_sequence(query_dict) # Create a new url with the presigned url. p = urlsplit(request.url) if p[3]: # If there was a pre-existing query string, we should # add that back before injecting the new query string. new_query_string = '%s&%s' % (p[3], new_query_string) new_url_parts = (p[0], p[1], p[2], new_query_string, p[4]) request.url = urlunsplit(new_url_parts) class HmacV1PostAuth(HmacV1Auth): """ Generates a presigned post for s3. Spec from this document: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingHTTPPOST.html """ def add_auth(self, request): fields = {} if request.context.get('s3-presign-post-fields', None) is not None: fields = request.context['s3-presign-post-fields'] policy = {} conditions = [] if request.context.get('s3-presign-post-policy', None) is not None: policy = request.context['s3-presign-post-policy'] if policy.get('conditions', None) is not None: conditions = policy['conditions'] policy['conditions'] = conditions fields['AWSAccessKeyId'] = self.credentials.access_key if self.credentials.token is not None: fields['x-amz-security-token'] = self.credentials.token conditions.append({'x-amz-security-token': self.credentials.token}) # Dump the base64 encoded policy into the fields dictionary. fields['policy'] = base64.b64encode( json.dumps(policy).encode('utf-8')).decode('utf-8') fields['signature'] = self.sign_string(fields['policy']) request.context['s3-presign-post-fields'] = fields request.context['s3-presign-post-policy'] = policy # 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, 'v4-query': SigV4QueryAuth, 'v3': SigV3Auth, 'v3https': SigV3Auth, 's3': HmacV1Auth, 's3-query': HmacV1QueryAuth, 's3-presign-post': HmacV1PostAuth, 's3v4': S3SigV4Auth, 's3v4-query': S3SigV4QueryAuth, 's3v4-presign-post': S3SigV4PostAuth, } botocore-1.5.7/botocore/docs/0000777454262600001440000000000013042511307017152 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/docs/shape.py0000666454262600001440000001060613042511306020626 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. # NOTE: This class should not be instantiated and its # ``traverse_and_document_shape`` method called directly. It should be # inherited from a Documenter class with the appropriate methods # and attributes. class ShapeDocumenter(object): EVENT_NAME = '' def __init__(self, service_name, operation_name, event_emitter, context=None): self._service_name = service_name self._operation_name = operation_name self._event_emitter = event_emitter self._context = context if context is None: self._context = { 'special_shape_types': {} } def traverse_and_document_shape(self, section, shape, history, include=None, exclude=None, name=None, is_required=False): """Traverses and documents a shape Will take a self class and call its appropriate methods as a shape is traversed. :param section: The section to document. :param history: A list of the names of the shapes that have been traversed. :type include: Dictionary where keys are parameter names and values are the shapes of the parameter names. :param include: The parameter shapes to include in the documentation. :type exclude: List of the names of the parameters to exclude. :param exclude: The names of the parameters to exclude from documentation. :param name: The name of the shape. :param is_required: If the shape is a required member. """ param_type = shape.type_name if shape.name in history: self.document_recursive_shape(section, shape, name=name) else: history.append(shape.name) is_top_level_param = (len(history) == 2) getattr(self, 'document_shape_type_%s' % param_type, self.document_shape_default)( section, shape, history=history, name=name, include=include, exclude=exclude, is_top_level_param=is_top_level_param, is_required=is_required) if is_top_level_param: self._event_emitter.emit( 'docs.%s.%s.%s.%s' % (self.EVENT_NAME, self._service_name, self._operation_name, name), section=section) at_overlying_method_section = (len(history) == 1) if at_overlying_method_section: self._event_emitter.emit( 'docs.%s.%s.%s.complete-section' % (self.EVENT_NAME, self._service_name, self._operation_name), section=section) history.pop() def _get_special_py_default(self, shape): special_defaults = { 'streaming_input_shape': 'b\'bytes\'|file', 'streaming_output_shape': 'StreamingBody()' } return self._get_value_for_special_type(shape, special_defaults) def _get_special_py_type_name(self, shape): special_type_names = { 'streaming_input_shape': 'bytes or seekable file-like object', 'streaming_output_shape': ':class:`.StreamingBody`' } return self._get_value_for_special_type(shape, special_type_names) def _get_value_for_special_type(self, shape, special_type_map): for special_type, marked_shape in self._context[ 'special_shape_types'].items(): if special_type in special_type_map: if shape == marked_shape: return special_type_map[special_type] return None botocore-1.5.7/botocore/docs/paginator.py0000666454262600001440000001551213042511306021513 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from botocore import xform_name from botocore.compat import OrderedDict from botocore.docs.utils import DocumentedShape from botocore.utils import get_service_module_name from botocore.docs.method import document_model_driven_method class PaginatorDocumenter(object): def __init__(self, client, service_paginator_model): self._client = client self._service_name = self._client.meta.service_model.service_name self._service_paginator_model = service_paginator_model def document_paginators(self, section): """Documents the various paginators for a service param section: The section to write to. """ section.style.h2('Paginators') section.style.new_line() section.writeln('The available paginators are:') paginator_names = sorted( self._service_paginator_model._paginator_config) # List the available paginators and then document each paginator. for paginator_name in paginator_names: section.style.li( ':py:class:`%s.Paginator.%s`' % ( self._client.__class__.__name__, paginator_name)) self._add_paginator(section, paginator_name) def _add_paginator(self, section, paginator_name): section = section.add_new_section(paginator_name) # Docment the paginator class section.style.start_sphinx_py_class( class_name='%s.Paginator.%s' % ( self._client.__class__.__name__, paginator_name)) section.style.start_codeblock() section.style.new_line() # Document how to instantiate the paginator. section.write( 'paginator = client.get_paginator(\'%s\')' % xform_name( paginator_name) ) section.style.end_codeblock() section.style.new_line() # Get the pagination model for the particular paginator. paginator_config = self._service_paginator_model.get_paginator( paginator_name) document_paginate_method( section=section, paginator_name=paginator_name, event_emitter=self._client.meta.events, service_model=self._client.meta.service_model, paginator_config=paginator_config ) def document_paginate_method(section, paginator_name, event_emitter, service_model, paginator_config, include_signature=True): """Documents the paginate method of a paginator :param section: The section to write to :param paginator_name: The name of the paginator. It is snake cased. :param event_emitter: The event emitter to use to emit events :param service_model: The service model :param paginator_config: The paginator config associated to a particular paginator. :param include_signature: Whether or not to include the signature. It is useful for generating docstrings. """ # Retrieve the operation model of the underlying operation. operation_model = service_model.operation_model( paginator_name) # Add representations of the request and response parameters # we want to include in the description of the paginate method. # These are parameters we expose via the botocore interface. pagination_config_members = OrderedDict() pagination_config_members['MaxItems'] = DocumentedShape( name='MaxItems', type_name='integer', documentation=( '

The total number of items to return. If the total ' 'number of items available is more than the value ' 'specified in max-items then a NextToken ' 'will be provided in the output that you can use to ' 'resume pagination.

')) pagination_config_members['PageSize'] = DocumentedShape( name='PageSize', type_name='integer', documentation='

The size of each page.

') pagination_config_members['StartingToken'] = DocumentedShape( name='StartingToken', type_name='string', documentation=( '

A token to specify where to start paginating. ' 'This is the NextToken from a previous ' 'response.

')) botocore_pagination_params = [ DocumentedShape( name='PaginationConfig', type_name='structure', documentation=( '

A dictionary that provides parameters to control ' 'pagination.

'), members=pagination_config_members) ] botocore_pagination_response_params = [ DocumentedShape( name='NextToken', type_name='string', documentation=( '

A token to resume pagination.

')) ] service_pagination_params = [] # Add the normal input token of the method to a list # of input paramters that we wish to hide since we expose our own. if isinstance(paginator_config['input_token'], list): service_pagination_params += paginator_config['input_token'] else: service_pagination_params.append(paginator_config['input_token']) # Hide the limit key in the documentation. if paginator_config.get('limit_key', None): service_pagination_params.append(paginator_config['limit_key']) # Hide the output tokens in the documentation. service_pagination_response_params = [] if isinstance(paginator_config['output_token'], list): service_pagination_response_params += paginator_config[ 'output_token'] else: service_pagination_response_params.append(paginator_config[ 'output_token']) paginate_description = ( 'Creates an iterator that will paginate through responses ' 'from :py:meth:`{0}.Client.{1}`.'.format( get_service_module_name(service_model), xform_name(paginator_name)) ) document_model_driven_method( section, 'paginate', operation_model, event_emitter=event_emitter, method_description=paginate_description, example_prefix='response_iterator = paginator.paginate', include_input=botocore_pagination_params, include_output=botocore_pagination_response_params, exclude_input=service_pagination_params, exclude_output=service_pagination_response_params, include_signature=include_signature ) botocore-1.5.7/botocore/docs/docstring.py0000666454262600001440000000716313042511306021526 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from botocore.docs.method import document_model_driven_method from botocore.docs.waiter import document_wait_method from botocore.docs.paginator import document_paginate_method from botocore.docs.bcdoc.restdoc import DocumentStructure class LazyLoadedDocstring(str): """Used for lazily loading docstrings You can instantiate this class and assign it to a __doc__ value. The docstring will not be generated till accessed via __doc__ or help(). Note that all docstring classes **must** subclass from this class. It cannot be used directly as a docstring. """ def __init__(self, *args, **kwargs): """ The args and kwargs are the same as the underlying document generation function. These just get proxied to the underlying function. """ super(LazyLoadedDocstring, self).__init__() self._gen_args = args self._gen_kwargs = kwargs self._docstring = None def __new__(cls, *args, **kwargs): # Needed in order to sub class from str with args and kwargs return super(LazyLoadedDocstring, cls).__new__(cls) def _write_docstring(self, *args, **kwargs): raise NotImplementedError( '_write_docstring is not implemented. Please subclass from ' 'this class and provide your own _write_docstring method' ) def expandtabs(self, tabsize=8): """Expands tabs to spaces So this is a big hack in order to get lazy loaded docstring work for the ``help()``. In the ``help()`` function, ``pydoc`` and ``inspect`` are used. At some point the ``inspect.cleandoc`` method is called. To clean the docs ``expandtabs`` is called and that is where we override the method to generate and return the docstrings. """ if self._docstring is None: self._generate() return self._docstring.expandtabs(tabsize) def __str__(self): return self._generate() # __doc__ of target will use either __repr__ or __str__ of this class. __repr__ = __str__ def _generate(self): # Generate the docstring if it is not already cached. if self._docstring is None: self._docstring = self._create_docstring() return self._docstring def _create_docstring(self): docstring_structure = DocumentStructure('docstring', target='html') # Call the document method function with the args and kwargs # passed to the class. self._write_docstring( docstring_structure, *self._gen_args, **self._gen_kwargs) return docstring_structure.flush_structure().decode('utf-8') class ClientMethodDocstring(LazyLoadedDocstring): def _write_docstring(self, *args, **kwargs): document_model_driven_method(*args, **kwargs) class WaiterDocstring(LazyLoadedDocstring): def _write_docstring(self, *args, **kwargs): document_wait_method(*args, **kwargs) class PaginatorDocstring(LazyLoadedDocstring): def _write_docstring(self, *args, **kwargs): document_paginate_method(*args, **kwargs) botocore-1.5.7/botocore/docs/method.py0000666454262600001440000002415213042511306021007 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import inspect from botocore.docs.params import RequestParamsDocumenter from botocore.docs.params import ResponseParamsDocumenter from botocore.docs.example import ResponseExampleDocumenter from botocore.docs.example import RequestExampleDocumenter AWS_DOC_BASE = 'https://docs.aws.amazon.com/goto/WebAPI' def get_instance_public_methods(instance): """Retrieves an objects public methods :param instance: The instance of the class to inspect :rtype: dict :returns: A dictionary that represents an instance's methods where the keys are the name of the methods and the values are the handler to the method. """ instance_members = inspect.getmembers(instance) instance_methods = {} for name, member in instance_members: if not name.startswith('_'): if inspect.ismethod(member): instance_methods[name] = member return instance_methods def document_model_driven_signature(section, name, operation_model, include=None, exclude=None): """Documents the signature of a model-driven method :param section: The section to write the documentation to. :param name: The name of the method :param operation_model: The operation model for the method :type include: Dictionary where keys are parameter names and values are the shapes of the parameter names. :param include: The parameter shapes to include in the documentation. :type exclude: List of the names of the parameters to exclude. :param exclude: The names of the parameters to exclude from documentation. """ params = {} if operation_model.input_shape: params = operation_model.input_shape.members parameter_names = list(params.keys()) if include is not None: for member in include: parameter_names.append(member.name) if exclude is not None: for member in exclude: if member in parameter_names: parameter_names.remove(member) signature_params = '' if parameter_names: signature_params = '**kwargs' section.style.start_sphinx_py_method(name, signature_params) def document_custom_signature(section, name, method, include=None, exclude=None): """Documents the signature of a custom method :param section: The section to write the documentation to. :param name: The name of the method :param method: The handle to the method being documented :type include: Dictionary where keys are parameter names and values are the shapes of the parameter names. :param include: The parameter shapes to include in the documentation. :type exclude: List of the names of the parameters to exclude. :param exclude: The names of the parameters to exclude from documentation. """ args, varargs, keywords, defaults = inspect.getargspec(method) args = args[1:] signature_params = inspect.formatargspec( args, varargs, keywords, defaults) signature_params = signature_params.lstrip('(') signature_params = signature_params.rstrip(')') section.style.start_sphinx_py_method(name, signature_params) def document_custom_method(section, method_name, method): """Documents a non-data driven method :param section: The section to write the documentation to. :param method_name: The name of the method :param method: The handle to the method being documented """ document_custom_signature( section, method_name, method) method_intro_section = section.add_new_section('method-intro') method_intro_section.writeln('') doc_string = inspect.getdoc(method) if doc_string is not None: method_intro_section.style.write_py_doc_string(doc_string) def document_model_driven_method(section, method_name, operation_model, event_emitter, method_description=None, example_prefix=None, include_input=None, include_output=None, exclude_input=None, exclude_output=None, document_output=True, include_signature=True): """Documents an individual method :param section: The section to write to :param method_name: The name of the method :param operation_model: The model of the operation :param event_emitter: The event emitter to use to emit events :param example_prefix: The prefix to use in the method example. :type include_input: Dictionary where keys are parameter names and values are the shapes of the parameter names. :param include_input: The parameter shapes to include in the input documentation. :type include_output: Dictionary where keys are parameter names and values are the shapes of the parameter names. :param include_input: The parameter shapes to include in the output documentation. :type exclude_input: List of the names of the parameters to exclude. :param exclude_input: The names of the parameters to exclude from input documentation. :type exclude_output: List of the names of the parameters to exclude. :param exclude_input: The names of the parameters to exclude from output documentation. :param document_output: A boolean flag to indicate whether to document the output. :param include_signature: Whether or not to include the signature. It is useful for generating docstrings. """ # Add the signature if specified. if include_signature: document_model_driven_signature( section, method_name, operation_model, include=include_input, exclude=exclude_input) # Add the description for the method. method_intro_section = section.add_new_section('method-intro') method_intro_section.include_doc_string(method_description) service_uid = operation_model.service_model.metadata.get('uid') if service_uid is not None: method_intro_section.style.new_paragraph() method_intro_section.write("See also: ") link = '%s/%s/%s' % (AWS_DOC_BASE, service_uid, operation_model.name) method_intro_section.style.external_link(title="AWS API Documentation", link=link) method_intro_section.writeln('') # Add the example section. example_section = section.add_new_section('example') example_section.style.new_paragraph() example_section.style.bold('Request Syntax') context = { 'special_shape_types': { 'streaming_input_shape': operation_model.get_streaming_input(), 'streaming_output_shape': operation_model.get_streaming_output(), }, } if operation_model.input_shape: RequestExampleDocumenter( service_name=operation_model.service_model.service_name, operation_name=operation_model.name, event_emitter=event_emitter, context=context).document_example( example_section, operation_model.input_shape, prefix=example_prefix, include=include_input, exclude=exclude_input) else: example_section.style.new_paragraph() example_section.style.start_codeblock() example_section.write(example_prefix + '()') # Add the request parameter documentation. request_params_section = section.add_new_section('request-params') if operation_model.input_shape: RequestParamsDocumenter( service_name=operation_model.service_model.service_name, operation_name=operation_model.name, event_emitter=event_emitter, context=context).document_params( request_params_section, operation_model.input_shape, include=include_input, exclude=exclude_input) # Add the return value documentation return_section = section.add_new_section('return') return_section.style.new_line() if operation_model.output_shape is not None and document_output: return_section.write(':rtype: dict') return_section.style.new_line() return_section.write(':returns: ') return_section.style.indent() return_section.style.new_line() # Add an example return value return_example_section = return_section.add_new_section('example') return_example_section.style.new_line() return_example_section.style.bold('Response Syntax') return_example_section.style.new_paragraph() ResponseExampleDocumenter( service_name=operation_model.service_model.service_name, operation_name=operation_model.name, event_emitter=event_emitter, context=context).document_example( return_example_section, operation_model.output_shape, include=include_output, exclude=exclude_output) # Add a description for the return value return_description_section = return_section.add_new_section( 'description') return_description_section.style.new_line() return_description_section.style.bold('Response Structure') return_description_section.style.new_paragraph() ResponseParamsDocumenter( service_name=operation_model.service_model.service_name, operation_name=operation_model.name, event_emitter=event_emitter, context=context).document_params( return_description_section, operation_model.output_shape, include=include_output, exclude=exclude_output) else: return_section.write(':returns: None') botocore-1.5.7/botocore/docs/bcdoc/0000777454262600001440000000000013042511307020224 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/docs/bcdoc/restdoc.py0000666454262600001440000001607213042511306022246 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import logging from botocore.compat import OrderedDict from botocore.docs.bcdoc.docstringparser import DocStringParser from botocore.docs.bcdoc.style import ReSTStyle LOG = logging.getLogger('bcdocs') class ReSTDocument(object): def __init__(self, target='man'): self.style = ReSTStyle(self) self.target = target self.parser = DocStringParser(self) self.keep_data = True self.do_translation = False self.translation_map = {} self.hrefs = {} self._writes = [] self._last_doc_string = None def _write(self, s): if self.keep_data and s is not None: self._writes.append(s) def write(self, content): """ Write content into the document. """ self._write(content) def writeln(self, content): """ Write content on a newline. """ self._write('%s%s\n' % (self.style.spaces(), content)) def peek_write(self): """ Returns the last content written to the document without removing it from the stack. """ return self._writes[-1] def pop_write(self): """ Removes and returns the last content written to the stack. """ return self._writes.pop() def push_write(self, s): """ Places new content on the stack. """ self._writes.append(s) def getvalue(self): """ Returns the current content of the document as a string. """ if self.hrefs: self.style.new_paragraph() for refname, link in self.hrefs.items(): self.style.link_target_definition(refname, link) return ''.join(self._writes).encode('utf-8') def translate_words(self, words): return [self.translation_map.get(w, w) for w in words] def handle_data(self, data): if data and self.keep_data: self._write(data) def include_doc_string(self, doc_string): if doc_string: try: start = len(self._writes) self.parser.feed(doc_string) self.parser.close() end = len(self._writes) self._last_doc_string = (start, end) except Exception: LOG.debug('Error parsing doc string', exc_info=True) LOG.debug(doc_string) def remove_last_doc_string(self): # Removes all writes inserted by last doc string if self._last_doc_string is not None: start, end = self._last_doc_string del self._writes[start:end] class DocumentStructure(ReSTDocument): def __init__(self, name, section_names=None, target='man', context=None): """Provides a Hierarichial structure to a ReSTDocument You can write to it similiar to as you can to a ReSTDocument but has an innate structure for more orginaztion and abstraction. :param name: The name of the document :param section_names: A list of sections to be included in the document. :param target: The target documentation of the Document structure :param context: A dictionary of data to store with the strucuture. These are only stored per section not the entire structure. """ super(DocumentStructure, self).__init__(target=target) self._name = name self._structure = OrderedDict() self._path = [self._name] self._context = {} if context is not None: self._context = context if section_names is not None: self._generate_structure(section_names) @property def name(self): """The name of the document structure""" return self._name @property def path(self): """ A list of where to find a particular document structure in the overlying document structure. """ return self._path @path.setter def path(self, value): self._path = value @property def available_sections(self): return list(self._structure) @property def context(self): return self._context def _generate_structure(self, section_names): for section_name in section_names: self.add_new_section(section_name) def add_new_section(self, name, context=None): """Adds a new section to the current document structure This document structure will be considered a section to the current document structure but will in itself be an entirely new document structure that can be written to and have sections as well :param name: The name of the section. :param context: A dictionary of data to store with the strucuture. These are only stored per section not the entire structure. :rtype: DocumentStructure :returns: A new document structure to add to but lives as a section to the document structure it was instantiated from. """ # Add a new section section = self.__class__(name=name, target=self.target, context=context) section.path = self.path + [name] # Indent the section apporpriately as well section.style.indentation = self.style.indentation section.translation_map = self.translation_map section.hrefs = self.hrefs self._structure[name] = section return section def get_section(self, name): """Retrieve a section""" return self._structure[name] def delete_section(self, name): """Delete a section""" del self._structure[name] def flush_structure(self): """Flushes a doc structure to a ReSTructed string The document is flushed out in a DFS style where sections and their subsections' values are added to the string as they are visited. """ # We are at the root flush the links at the beginning of the # document if len(self.path) == 1: if self.hrefs: self.style.new_paragraph() for refname, link in self.hrefs.items(): self.style.link_target_definition(refname, link) value = self.getvalue() for name, section in self._structure.items(): value += section.flush_structure() return value def getvalue(self): return ''.join(self._writes).encode('utf-8') def remove_all_sections(self): self._structure = OrderedDict() def clear_text(self): self._writes = [] botocore-1.5.7/botocore/docs/bcdoc/style.py0000666454262600001440000002555313042511306021747 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import logging logger = logging.getLogger('bcdocs') class BaseStyle(object): def __init__(self, doc, indent_width=2): self.doc = doc self.indent_width = indent_width self._indent = 0 self.keep_data = True @property def indentation(self): return self._indent @indentation.setter def indentation(self, value): self._indent = value def new_paragraph(self): return '\n%s' % self.spaces() def indent(self): self._indent += 1 def dedent(self): if self._indent > 0: self._indent -= 1 def spaces(self): return ' ' * (self._indent * self.indent_width) def bold(self, s): return s def ref(self, link, title=None): return link def h2(self, s): return s def h3(self, s): return s def underline(self, s): return s def italics(self, s): return s class ReSTStyle(BaseStyle): def __init__(self, doc, indent_width=2): BaseStyle.__init__(self, doc, indent_width) self.do_p = True self.a_href = None self.list_depth = 0 def new_paragraph(self): self.doc.write('\n\n%s' % self.spaces()) def new_line(self): self.doc.write('\n%s' % self.spaces()) def _start_inline(self, markup): self.doc.write(markup) def _end_inline(self, markup): # Sometimes the HTML markup has whitespace between the end # of the text inside the inline markup and the closing element # (e.g. foobar ). This trailing space will cause # problems in the ReST inline markup so we remove it here # by popping the last item written off the stack, striping # the whitespace and then pushing it back on the stack. last_write = self.doc.pop_write() self.doc.push_write(last_write.rstrip(' ')) self.doc.write(markup + ' ') def start_bold(self, attrs=None): self._start_inline('**') def end_bold(self): self._end_inline('**') def start_b(self, attrs=None): self.doc.do_translation = True self.start_bold(attrs) def end_b(self): self.doc.do_translation = False self.end_bold() def bold(self, s): if s: self.start_bold() self.doc.write(s) self.end_bold() def ref(self, title, link=None): if link is None: link = title self.doc.write(':doc:`%s <%s>`' % (title, link)) def _heading(self, s, border_char): border = border_char * len(s) self.new_paragraph() self.doc.write('%s\n%s\n%s' % (border, s, border)) self.new_paragraph() def h1(self, s): self._heading(s, '*') def h2(self, s): self._heading(s, '=') def h3(self, s): self._heading(s, '-') def start_italics(self, attrs=None): self._start_inline('*') def end_italics(self): self._end_inline('*') def italics(self, s): if s: self.start_italics() self.doc.write(s) self.end_italics() def start_p(self, attrs=None): if self.do_p: self.doc.write('\n\n%s' % self.spaces()) def end_p(self): if self.do_p: self.doc.write('\n\n%s' % self.spaces()) def start_code(self, attrs=None): self.doc.do_translation = True self._start_inline('``') def end_code(self): self.doc.do_translation = False self._end_inline('``') def code(self, s): if s: self.start_code() self.doc.write(s) self.end_code() def start_note(self, attrs=None): self.new_paragraph() self.doc.write('.. note::') self.indent() self.new_paragraph() def end_note(self): self.dedent() self.new_paragraph() def start_important(self, attrs=None): self.new_paragraph() self.doc.write('.. warning::') self.indent() self.new_paragraph() def end_important(self): self.dedent() self.new_paragraph() def start_a(self, attrs=None): if attrs: for attr_key, attr_value in attrs: if attr_key == 'href': self.a_href = attr_value self.doc.write('`') else: # There are some model documentation that # looks like this: DescribeInstances. # In this case we just write out an empty # string. self.doc.write(' ') self.doc.do_translation = True def link_target_definition(self, refname, link): self.doc.writeln('.. _%s: %s' % (refname, link)) def sphinx_reference_label(self, label, text=None): if text is None: text = label if self.doc.target == 'html': self.doc.write(':ref:`%s <%s>`' % (text, label)) else: self.doc.write(text) def end_a(self): self.doc.do_translation = False if self.a_href: last_write = self.doc.pop_write() last_write = last_write.rstrip(' ') if last_write and last_write != '`': if ':' in last_write: last_write = last_write.replace(':', r'\:') self.doc.push_write(last_write) self.doc.hrefs[last_write] = self.a_href self.doc.write('`_') elif last_write == '`': # Look at start_a(). It will do a self.doc.write('`') # which is the start of the link title. If that is the # case then there was no link text. We should just # use an inline link. The syntax of this is # ``_ self.doc.push_write('`<%s>`_' % self.a_href) else: self.doc.push_write(self.a_href) self.doc.hrefs[self.a_href] = self.a_href self.doc.write('`_') self.a_href = None self.doc.write(' ') def start_i(self, attrs=None): self.doc.do_translation = True self.start_italics() def end_i(self): self.doc.do_translation = False self.end_italics() def start_li(self, attrs=None): self.new_line() self.do_p = False self.doc.write('* ') def end_li(self): self.do_p = True self.new_line() def li(self, s): if s: self.start_li() self.doc.writeln(s) self.end_li() def start_ul(self, attrs=None): if self.list_depth != 0: self.indent() self.list_depth += 1 self.new_paragraph() def end_ul(self): self.list_depth -= 1 if self.list_depth != 0: self.dedent() self.new_paragraph() def start_ol(self, attrs=None): # TODO: Need to control the bullets used for LI items if self.list_depth != 0: self.indent() self.list_depth += 1 self.new_paragraph() def end_ol(self): self.list_depth -= 1 if self.list_depth != 0: self.dedent() self.new_paragraph() def start_examples(self, attrs=None): self.doc.keep_data = False def end_examples(self): self.doc.keep_data = True def start_fullname(self, attrs=None): self.doc.keep_data = False def end_fullname(self): self.doc.keep_data = True def start_codeblock(self, attrs=None): self.doc.write('::') self.indent() self.new_paragraph() def end_codeblock(self): self.dedent() self.new_paragraph() def codeblock(self, code): """ Literal code blocks are introduced by ending a paragraph with the special marker ::. The literal block must be indented (and, like all paragraphs, separated from the surrounding ones by blank lines). """ self.start_codeblock() self.doc.writeln(code) self.end_codeblock() def toctree(self): if self.doc.target == 'html': self.doc.write('\n.. toctree::\n') self.doc.write(' :maxdepth: 1\n') self.doc.write(' :titlesonly:\n\n') else: self.start_ul() def tocitem(self, item, file_name=None): if self.doc.target == 'man': self.li(item) else: if file_name: self.doc.writeln(' %s' % file_name) else: self.doc.writeln(' %s' % item) def hidden_toctree(self): if self.doc.target == 'html': self.doc.write('\n.. toctree::\n') self.doc.write(' :maxdepth: 1\n') self.doc.write(' :hidden:\n\n') def hidden_tocitem(self, item): if self.doc.target == 'html': self.tocitem(item) def table_of_contents(self, title=None, depth=None): self.doc.write('.. contents:: ') if title is not None: self.doc.writeln(title) if depth is not None: self.doc.writeln(' :depth: %s' % depth) def start_sphinx_py_class(self, class_name): self.new_paragraph() self.doc.write('.. py:class:: %s' % class_name) self.indent() self.new_paragraph() def end_sphinx_py_class(self): self.dedent() self.new_paragraph() def start_sphinx_py_method(self, method_name, parameters=None): self.new_paragraph() content = '.. py:method:: %s' % method_name if parameters is not None: content += '(%s)' % parameters self.doc.write(content) self.indent() self.new_paragraph() def end_sphinx_py_method(self): self.dedent() self.new_paragraph() def start_sphinx_py_attr(self, attr_name): self.new_paragraph() self.doc.write('.. py:attribute:: %s' % attr_name) self.indent() self.new_paragraph() def end_sphinx_py_attr(self): self.dedent() self.new_paragraph() def write_py_doc_string(self, docstring): docstring_lines = docstring.splitlines() for docstring_line in docstring_lines: self.doc.writeln(docstring_line) def external_link(self, title, link): if self.doc.target == 'html': self.doc.write('`%s <%s>`_' % (title, link)) else: self.doc.write(title) botocore-1.5.7/botocore/docs/bcdoc/docstringparser.py0000666454262600001440000001340113042511306024005 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from botocore.compat import six class DocStringParser(six.moves.html_parser.HTMLParser): """ A simple HTML parser. Focused on converting the subset of HTML that appears in the documentation strings of the JSON models into simple ReST format. """ def __init__(self, doc): self.tree = None self.doc = doc six.moves.html_parser.HTMLParser.__init__(self) def reset(self): six.moves.html_parser.HTMLParser.reset(self) self.tree = HTMLTree(self.doc) def feed(self, data): # HTMLParser is an old style class, so the super() method will not work. six.moves.html_parser.HTMLParser.feed(self, data) self.tree.write() self.tree = HTMLTree(self.doc) def close(self): six.moves.html_parser.HTMLParser.close(self) # Write if there is anything remaining. self.tree.write() self.tree = HTMLTree(self.doc) def handle_starttag(self, tag, attrs): self.tree.add_tag(tag, attrs=attrs) def handle_endtag(self, tag): self.tree.add_tag(tag, is_start=False) def handle_data(self, data): self.tree.add_data(data) class HTMLTree(object): """ A tree which handles HTML nodes. Designed to work with a python HTML parser, meaning that the current_node will be the most recently opened tag. When a tag is closed, the current_node moves up to the parent node. """ def __init__(self, doc): self.doc = doc self.head = StemNode() self.current_node = self.head self.unhandled_tags = [] def add_tag(self, tag, attrs=None, is_start=True): if not self._doc_has_handler(tag, is_start): self.unhandled_tags.append(tag) return if is_start: if tag == 'li': node = LineItemNode(attrs) else: node = TagNode(tag, attrs) self.current_node.add_child(node) self.current_node = node else: self.current_node = self.current_node.parent def _doc_has_handler(self, tag, is_start): if is_start: handler_name = 'start_%s' % tag else: handler_name = 'end_%s' % tag return hasattr(self.doc.style, handler_name) def add_data(self, data): self.current_node.add_child(DataNode(data)) def write(self): self.head.write(self.doc) class Node(object): def __init__(self, parent=None): self.parent = parent def write(self, doc): raise NotImplementedError class StemNode(Node): def __init__(self, parent=None): super(StemNode, self).__init__(parent) self.children = [] def add_child(self, child): child.parent = self self.children.append(child) def write(self, doc): self._write_children(doc) def _write_children(self, doc): for child in self.children: child.write(doc) class TagNode(StemNode): """ A generic Tag node. It will verify that handlers exist before writing. """ def __init__(self, tag, attrs=None, parent=None): super(TagNode, self).__init__(parent) self.attrs = attrs self.tag = tag def write(self, doc): self._write_start(doc) self._write_children(doc) self._write_end(doc) def _write_start(self, doc): handler_name = 'start_%s' % self.tag if hasattr(doc.style, handler_name): getattr(doc.style, handler_name)(self.attrs) def _write_end(self, doc): handler_name = 'end_%s' % self.tag if hasattr(doc.style, handler_name): getattr(doc.style, handler_name)() class LineItemNode(TagNode): def __init__(self, attrs=None, parent=None): super(LineItemNode, self).__init__('li', attrs, parent) def write(self, doc): self._lstrip(self) super(LineItemNode, self).write(doc) def _lstrip(self, node): """ Traverses the tree, stripping out whitespace until text data is found :param node: The node to strip :return: True if non-whitespace data was found, False otherwise """ for child in node.children: if isinstance(child, DataNode): child.lstrip() if child.data: return True else: found = self._lstrip(child) if found: return True return False class DataNode(Node): """ A Node that contains only string data. """ def __init__(self, data, parent=None): super(DataNode, self).__init__(parent) if not isinstance(data, six.string_types): raise ValueError("Expecting string type, %s given." % type(data)) self.data = data def lstrip(self): self.data = self.data.lstrip() def write(self, doc): if not self.data: return if self.data.isspace(): str_data = ' ' else: end_space = self.data[-1].isspace() words = self.data.split() words = doc.translate_words(words) str_data = ' '.join(words) if end_space: str_data += ' ' doc.handle_data(str_data) botocore-1.5.7/botocore/docs/bcdoc/textwriter.py0000666454262600001440000005020313042511306023016 0ustar pysdk-ciamazon00000000000000# -*- coding: utf-8 -*- """ Custom docutils writer for plain text. Based heavily on the Sphinx text writer. See copyright below. :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. """ import os import re import textwrap from docutils import nodes, writers class TextWrapper(textwrap.TextWrapper): """Custom subclass that uses a different word separator regex.""" wordsep_re = re.compile( r'(\s+|' # any whitespace r'(?<=\s)(?::[a-z-]+:)?`\S+|' # interpreted text start r'[^\s\w]*\w+[a-zA-Z]-(?=\w+[a-zA-Z])|' # hyphenated words r'(?<=[\w\!\"\'\&\.\,\?])-{2,}(?=\w))') # em-dash MAXWIDTH = 70 STDINDENT = 3 def my_wrap(text, width=MAXWIDTH, **kwargs): w = TextWrapper(width=width, **kwargs) return w.wrap(text) class TextWriter(writers.Writer): supported = ('text',) settings_spec = ('No options here.', '', ()) settings_defaults = {} output = None def __init__(self): writers.Writer.__init__(self) def translate(self): visitor = TextTranslator(self.document) self.document.walkabout(visitor) self.output = visitor.body class TextTranslator(nodes.NodeVisitor): sectionchars = '*=-~"+`' def __init__(self, document): nodes.NodeVisitor.__init__(self, document) self.nl = os.linesep self.states = [[]] self.stateindent = [0] self.list_counter = [] self.sectionlevel = 0 self.table = None def add_text(self, text): self.states[-1].append((-1, text)) def new_state(self, indent=STDINDENT): self.states.append([]) self.stateindent.append(indent) def end_state(self, wrap=True, end=[''], first=None): content = self.states.pop() maxindent = sum(self.stateindent) indent = self.stateindent.pop() result = [] toformat = [] def do_format(): if not toformat: return if wrap: res = my_wrap(''.join(toformat), width=MAXWIDTH-maxindent) else: res = ''.join(toformat).splitlines() if end: res += end result.append((indent, res)) for itemindent, item in content: if itemindent == -1: toformat.append(item) else: do_format() result.append((indent + itemindent, item)) toformat = [] do_format() if first is not None and result: itemindent, item = result[0] if item: result.insert(0, (itemindent - indent, [first + item[0]])) result[1] = (itemindent, item[1:]) self.states[-1].extend(result) def visit_document(self, node): self.new_state(0) def depart_document(self, node): self.end_state() self.body = self.nl.join(line and (' '*indent + line) for indent, lines in self.states[0] for line in lines) # XXX header/footer? def visit_highlightlang(self, node): raise nodes.SkipNode def visit_section(self, node): self._title_char = self.sectionchars[self.sectionlevel] self.sectionlevel += 1 def depart_section(self, node): self.sectionlevel -= 1 def visit_topic(self, node): self.new_state(0) def depart_topic(self, node): self.end_state() visit_sidebar = visit_topic depart_sidebar = depart_topic def visit_rubric(self, node): self.new_state(0) self.add_text('-[ ') def depart_rubric(self, node): self.add_text(' ]-') self.end_state() def visit_compound(self, node): pass def depart_compound(self, node): pass def visit_glossary(self, node): pass def depart_glossary(self, node): pass def visit_title(self, node): if isinstance(node.parent, nodes.Admonition): self.add_text(node.astext()+': ') raise nodes.SkipNode self.new_state(0) def depart_title(self, node): if isinstance(node.parent, nodes.section): char = self._title_char else: char = '^' text = ''.join(x[1] for x in self.states.pop() if x[0] == -1) self.stateindent.pop() self.states[-1].append((0, ['', text, '%s' % (char * len(text)), ''])) def visit_subtitle(self, node): pass def depart_subtitle(self, node): pass def visit_attribution(self, node): self.add_text('-- ') def depart_attribution(self, node): pass def visit_desc(self, node): pass def depart_desc(self, node): pass def visit_desc_signature(self, node): self.new_state(0) if node.parent['objtype'] in ('class', 'exception'): self.add_text('%s ' % node.parent['objtype']) def depart_desc_signature(self, node): # XXX: wrap signatures in a way that makes sense self.end_state(wrap=False, end=None) def visit_desc_name(self, node): pass def depart_desc_name(self, node): pass def visit_desc_addname(self, node): pass def depart_desc_addname(self, node): pass def visit_desc_type(self, node): pass def depart_desc_type(self, node): pass def visit_desc_returns(self, node): self.add_text(' -> ') def depart_desc_returns(self, node): pass def visit_desc_parameterlist(self, node): self.add_text('(') self.first_param = 1 def depart_desc_parameterlist(self, node): self.add_text(')') def visit_desc_parameter(self, node): if not self.first_param: self.add_text(', ') else: self.first_param = 0 self.add_text(node.astext()) raise nodes.SkipNode def visit_desc_optional(self, node): self.add_text('[') def depart_desc_optional(self, node): self.add_text(']') def visit_desc_annotation(self, node): pass def depart_desc_annotation(self, node): pass def visit_refcount(self, node): pass def depart_refcount(self, node): pass def visit_desc_content(self, node): self.new_state() self.add_text(self.nl) def depart_desc_content(self, node): self.end_state() def visit_figure(self, node): self.new_state() def depart_figure(self, node): self.end_state() def visit_caption(self, node): pass def depart_caption(self, node): pass def visit_productionlist(self, node): self.new_state() names = [] for production in node: names.append(production['tokenname']) maxlen = max(len(name) for name in names) for production in node: if production['tokenname']: self.add_text(production['tokenname'].ljust(maxlen) + ' ::=') lastname = production['tokenname'] else: self.add_text('%s ' % (' '*len(lastname))) self.add_text(production.astext() + self.nl) self.end_state(wrap=False) raise nodes.SkipNode def visit_seealso(self, node): self.new_state() def depart_seealso(self, node): self.end_state(first='') def visit_footnote(self, node): self._footnote = node.children[0].astext().strip() self.new_state(len(self._footnote) + 3) def depart_footnote(self, node): self.end_state(first='[%s] ' % self._footnote) def visit_citation(self, node): if len(node) and isinstance(node[0], nodes.label): self._citlabel = node[0].astext() else: self._citlabel = '' self.new_state(len(self._citlabel) + 3) def depart_citation(self, node): self.end_state(first='[%s] ' % self._citlabel) def visit_label(self, node): raise nodes.SkipNode # XXX: option list could use some better styling def visit_option_list(self, node): pass def depart_option_list(self, node): pass def visit_option_list_item(self, node): self.new_state(0) def depart_option_list_item(self, node): self.end_state() def visit_option_group(self, node): self._firstoption = True def depart_option_group(self, node): self.add_text(' ') def visit_option(self, node): if self._firstoption: self._firstoption = False else: self.add_text(', ') def depart_option(self, node): pass def visit_option_string(self, node): pass def depart_option_string(self, node): pass def visit_option_argument(self, node): self.add_text(node['delimiter']) def depart_option_argument(self, node): pass def visit_description(self, node): pass def depart_description(self, node): pass def visit_tabular_col_spec(self, node): raise nodes.SkipNode def visit_colspec(self, node): self.table[0].append(node['colwidth']) raise nodes.SkipNode def visit_tgroup(self, node): pass def depart_tgroup(self, node): pass def visit_thead(self, node): pass def depart_thead(self, node): pass def visit_tbody(self, node): self.table.append('sep') def depart_tbody(self, node): pass def visit_row(self, node): self.table.append([]) def depart_row(self, node): pass def visit_entry(self, node): if 'morerows' in node or 'morecols' in node: raise NotImplementedError('Column or row spanning cells are ' 'not implemented.') self.new_state(0) def depart_entry(self, node): text = self.nl.join(self.nl.join(x[1]) for x in self.states.pop()) self.stateindent.pop() self.table[-1].append(text) def visit_table(self, node): if self.table: raise NotImplementedError('Nested tables are not supported.') self.new_state(0) self.table = [[]] def depart_table(self, node): lines = self.table[1:] fmted_rows = [] colwidths = self.table[0] realwidths = colwidths[:] separator = 0 # don't allow paragraphs in table cells for now for line in lines: if line == 'sep': separator = len(fmted_rows) else: cells = [] for i, cell in enumerate(line): par = my_wrap(cell, width=colwidths[i]) if par: maxwidth = max(map(len, par)) else: maxwidth = 0 realwidths[i] = max(realwidths[i], maxwidth) cells.append(par) fmted_rows.append(cells) def writesep(char='-'): out = ['+'] for width in realwidths: out.append(char * (width+2)) out.append('+') self.add_text(''.join(out) + self.nl) def writerow(row): lines = zip(*row) for line in lines: out = ['|'] for i, cell in enumerate(line): if cell: out.append(' ' + cell.ljust(realwidths[i]+1)) else: out.append(' ' * (realwidths[i] + 2)) out.append('|') self.add_text(''.join(out) + self.nl) for i, row in enumerate(fmted_rows): if separator and i == separator: writesep('=') else: writesep('-') writerow(row) writesep('-') self.table = None self.end_state(wrap=False) def visit_acks(self, node): self.new_state(0) self.add_text( ', '.join(n.astext() for n in node.children[0].children) + '.') self.end_state() raise nodes.SkipNode def visit_image(self, node): if 'alt' in node.attributes: self.add_text(_('[image: %s]') % node['alt']) self.add_text(_('[image]')) raise nodes.SkipNode def visit_transition(self, node): indent = sum(self.stateindent) self.new_state(0) self.add_text('=' * (MAXWIDTH - indent)) self.end_state() raise nodes.SkipNode def visit_bullet_list(self, node): self.list_counter.append(-1) def depart_bullet_list(self, node): self.list_counter.pop() def visit_enumerated_list(self, node): self.list_counter.append(0) def depart_enumerated_list(self, node): self.list_counter.pop() def visit_definition_list(self, node): self.list_counter.append(-2) def depart_definition_list(self, node): self.list_counter.pop() def visit_list_item(self, node): if self.list_counter[-1] == -1: # bullet list self.new_state(2) elif self.list_counter[-1] == -2: # definition list pass else: # enumerated list self.list_counter[-1] += 1 self.new_state(len(str(self.list_counter[-1])) + 2) def depart_list_item(self, node): if self.list_counter[-1] == -1: self.end_state(first='* ', end=None) elif self.list_counter[-1] == -2: pass else: self.end_state(first='%s. ' % self.list_counter[-1], end=None) def visit_definition_list_item(self, node): self._li_has_classifier = len(node) >= 2 and \ isinstance(node[1], nodes.classifier) def depart_definition_list_item(self, node): pass def visit_term(self, node): self.new_state(0) def depart_term(self, node): if not self._li_has_classifier: self.end_state(end=None) def visit_termsep(self, node): self.add_text(', ') raise nodes.SkipNode def visit_classifier(self, node): self.add_text(' : ') def depart_classifier(self, node): self.end_state(end=None) def visit_definition(self, node): self.new_state() def depart_definition(self, node): self.end_state() def visit_field_list(self, node): pass def depart_field_list(self, node): pass def visit_field(self, node): pass def depart_field(self, node): pass def visit_field_name(self, node): self.new_state(0) def depart_field_name(self, node): self.add_text(':') self.end_state(end=None) def visit_field_body(self, node): self.new_state() def depart_field_body(self, node): self.end_state() def visit_centered(self, node): pass def depart_centered(self, node): pass def visit_hlist(self, node): pass def depart_hlist(self, node): pass def visit_hlistcol(self, node): pass def depart_hlistcol(self, node): pass def visit_admonition(self, node): self.new_state(0) def depart_admonition(self, node): self.end_state() def visit_versionmodified(self, node): self.new_state(0) def depart_versionmodified(self, node): self.end_state() def visit_literal_block(self, node): self.new_state() def depart_literal_block(self, node): self.end_state(wrap=False) def visit_doctest_block(self, node): self.new_state(0) def depart_doctest_block(self, node): self.end_state(wrap=False) def visit_line_block(self, node): self.new_state(0) def depart_line_block(self, node): self.end_state(wrap=False) def visit_line(self, node): pass def depart_line(self, node): pass def visit_block_quote(self, node): self.new_state() def depart_block_quote(self, node): self.end_state() def visit_compact_paragraph(self, node): pass def depart_compact_paragraph(self, node): pass def visit_paragraph(self, node): self.new_state(0) def depart_paragraph(self, node): self.end_state() def visit_target(self, node): raise nodes.SkipNode def visit_index(self, node): raise nodes.SkipNode def visit_substitution_definition(self, node): raise nodes.SkipNode def visit_pending_xref(self, node): pass def depart_pending_xref(self, node): pass def visit_reference(self, node): pass def depart_reference(self, node): pass def visit_download_reference(self, node): pass def depart_download_reference(self, node): pass def visit_emphasis(self, node): self.add_text('*') def depart_emphasis(self, node): self.add_text('*') def visit_literal_emphasis(self, node): self.add_text('*') def depart_literal_emphasis(self, node): self.add_text('*') def visit_strong(self, node): self.add_text('**') def depart_strong(self, node): self.add_text('**') def visit_abbreviation(self, node): self.add_text('') def depart_abbreviation(self, node): if node.hasattr('explanation'): self.add_text(' (%s)' % node['explanation']) def visit_title_reference(self, node): self.add_text('*') def depart_title_reference(self, node): self.add_text('*') def visit_literal(self, node): self.add_text('"') def depart_literal(self, node): self.add_text('"') def visit_subscript(self, node): self.add_text('_') def depart_subscript(self, node): pass def visit_superscript(self, node): self.add_text('^') def depart_superscript(self, node): pass def visit_footnote_reference(self, node): self.add_text('[%s]' % node.astext()) raise nodes.SkipNode def visit_citation_reference(self, node): self.add_text('[%s]' % node.astext()) raise nodes.SkipNode def visit_Text(self, node): self.add_text(node.astext()) def depart_Text(self, node): pass def visit_generated(self, node): pass def depart_generated(self, node): pass def visit_inline(self, node): pass def depart_inline(self, node): pass def visit_problematic(self, node): self.add_text('>>') def depart_problematic(self, node): self.add_text('<<') def visit_system_message(self, node): self.new_state(0) self.add_text('' % node.astext()) self.end_state() raise nodes.SkipNode def visit_comment(self, node): raise nodes.SkipNode def visit_meta(self, node): # only valid for HTML raise nodes.SkipNode def visit_raw(self, node): if 'text' in node.get('format', '').split(): self.body.append(node.astext()) raise nodes.SkipNode def _visit_admonition(self, node): self.new_state(2) def _make_depart_admonition(name): def depart_admonition(self, node): self.end_state(first=name.capitalize() + ': ') return depart_admonition visit_attention = _visit_admonition depart_attention = _make_depart_admonition('attention') visit_caution = _visit_admonition depart_caution = _make_depart_admonition('caution') visit_danger = _visit_admonition depart_danger = _make_depart_admonition('danger') visit_error = _visit_admonition depart_error = _make_depart_admonition('error') visit_hint = _visit_admonition depart_hint = _make_depart_admonition('hint') visit_important = _visit_admonition depart_important = _make_depart_admonition('important') visit_note = _visit_admonition depart_note = _make_depart_admonition('note') visit_tip = _visit_admonition depart_tip = _make_depart_admonition('tip') visit_warning = _visit_admonition depart_warning = _make_depart_admonition('warning') def unknown_visit(self, node): raise NotImplementedError('Unknown node: ' + node.__class__.__name__) botocore-1.5.7/botocore/docs/bcdoc/__init__.py0000666454262600001440000000111413042511306022331 0ustar pysdk-ciamazon00000000000000# Copyright 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. __version__ = '0.16.0' botocore-1.5.7/botocore/docs/bcdoc/docevents.py0000666454262600001440000001117513042511306022574 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. DOC_EVENTS = { 'doc-breadcrumbs': '.%s', 'doc-title': '.%s', 'doc-description': '.%s', 'doc-synopsis-start': '.%s', 'doc-synopsis-option': '.%s.%s', 'doc-synopsis-end': '.%s', 'doc-options-start': '.%s', 'doc-option': '.%s.%s', 'doc-option-example': '.%s.%s', 'doc-options-end': '.%s', 'doc-examples': '.%s', 'doc-output': '.%s', 'doc-subitems-start': '.%s', 'doc-subitem': '.%s.%s', 'doc-subitems-end': '.%s', 'doc-relateditems-start': '.%s', 'doc-relateditem': '.%s.%s', 'doc-relateditems-end': '.%s' } def generate_events(session, help_command): # Now generate the documentation events session.emit('doc-breadcrumbs.%s' % help_command.event_class, help_command=help_command) session.emit('doc-title.%s' % help_command.event_class, help_command=help_command) session.emit('doc-description.%s' % help_command.event_class, help_command=help_command) session.emit('doc-synopsis-start.%s' % help_command.event_class, help_command=help_command) if help_command.arg_table: for arg_name in help_command.arg_table: # An argument can set an '_UNDOCUMENTED' attribute # to True to indicate a parameter that exists # but shouldn't be documented. This can be used # for backwards compatibility of deprecated arguments. if getattr(help_command.arg_table[arg_name], '_UNDOCUMENTED', False): continue session.emit( 'doc-synopsis-option.%s.%s' % (help_command.event_class, arg_name), arg_name=arg_name, help_command=help_command) session.emit('doc-synopsis-end.%s' % help_command.event_class, help_command=help_command) session.emit('doc-options-start.%s' % help_command.event_class, help_command=help_command) if help_command.arg_table: for arg_name in help_command.arg_table: if getattr(help_command.arg_table[arg_name], '_UNDOCUMENTED', False): continue session.emit('doc-option.%s.%s' % (help_command.event_class, arg_name), arg_name=arg_name, help_command=help_command) session.emit('doc-option-example.%s.%s' % (help_command.event_class, arg_name), arg_name=arg_name, help_command=help_command) session.emit('doc-options-end.%s' % help_command.event_class, help_command=help_command) session.emit('doc-subitems-start.%s' % help_command.event_class, help_command=help_command) if help_command.command_table: for command_name in sorted(help_command.command_table.keys()): if hasattr(help_command.command_table[command_name], '_UNDOCUMENTED'): continue session.emit('doc-subitem.%s.%s' % (help_command.event_class, command_name), command_name=command_name, help_command=help_command) session.emit('doc-subitems-end.%s' % help_command.event_class, help_command=help_command) session.emit('doc-examples.%s' % help_command.event_class, help_command=help_command) session.emit('doc-output.%s' % help_command.event_class, help_command=help_command) session.emit('doc-relateditems-start.%s' % help_command.event_class, help_command=help_command) if help_command.related_items: for related_item in sorted(help_command.related_items): session.emit('doc-relateditem.%s.%s' % (help_command.event_class, related_item), help_command=help_command, related_item=related_item) session.emit('doc-relateditems-end.%s' % help_command.event_class, help_command=help_command) botocore-1.5.7/botocore/docs/waiter.py0000666454262600001440000000736113042511306021025 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from botocore import xform_name from botocore.utils import get_service_module_name from botocore.docs.method import document_model_driven_method class WaiterDocumenter(object): def __init__(self, client, service_waiter_model): self._client = client self._service_name = self._client.meta.service_model.service_name self._service_waiter_model = service_waiter_model def document_waiters(self, section): """Documents the various waiters for a service. :param section: The section to write to. """ section.style.h2('Waiters') section.style.new_line() section.writeln('The available waiters are:') for waiter_name in self._service_waiter_model.waiter_names: section.style.li( ':py:class:`%s.Waiter.%s`' % ( self._client.__class__.__name__, waiter_name)) self._add_single_waiter(section, waiter_name) def _add_single_waiter(self, section, waiter_name): section = section.add_new_section(waiter_name) section.style.start_sphinx_py_class( class_name='%s.Waiter.%s' % ( self._client.__class__.__name__, waiter_name)) # Add example on how to instantiate waiter. section.style.start_codeblock() section.style.new_line() section.write( 'waiter = client.get_waiter(\'%s\')' % xform_name(waiter_name) ) section.style.end_codeblock() # Add information on the wait() method section.style.new_line() document_wait_method( section=section, waiter_name=waiter_name, event_emitter=self._client.meta.events, service_model=self._client.meta.service_model, service_waiter_model=self._service_waiter_model ) def document_wait_method(section, waiter_name, event_emitter, service_model, service_waiter_model, include_signature=True): """Documents a the wait method of a waiter :param section: The section to write to :param waiter_name: The name of the waiter :param event_emitter: The event emitter to use to emit events :param service_model: The service model :param service_waiter_model: The waiter model associated to the service :param include_signature: Whether or not to include the signature. It is useful for generating docstrings. """ waiter_model = service_waiter_model.get_waiter(waiter_name) operation_model = service_model.operation_model( waiter_model.operation) wait_description = ( 'Polls :py:meth:`{0}.Client.{1}` every {2} ' 'seconds until a successful state is reached. An error is ' 'returned after {3} failed checks.'.format( get_service_module_name(service_model), xform_name(waiter_model.operation), waiter_model.delay, waiter_model.max_attempts) ) document_model_driven_method( section, 'wait', operation_model, event_emitter=event_emitter, method_description=wait_description, example_prefix='waiter.wait', document_output=False, include_signature=include_signature ) botocore-1.5.7/botocore/docs/utils.py0000666454262600001440000001505513042511306020671 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from collections import namedtuple def py_type_name(type_name): """Get the Python type name for a given model type. >>> py_type_name('list') 'list' >>> py_type_name('structure') 'dict' :rtype: string """ return { 'blob': 'bytes', 'character': 'string', 'double': 'float', 'long': 'integer', 'map': 'dict', 'structure': 'dict', 'timestamp': 'datetime', }.get(type_name, type_name) def py_default(type_name): """Get the Python default value for a given model type. >>> py_default('string') '\'string\'' >>> py_default('list') '[...]' >>> py_default('unknown') '...' :rtype: string """ return { 'double': '123.0', 'long': '123', 'integer': '123', 'string': "'string'", 'blob': "b'bytes'", 'boolean': 'True|False', 'list': '[...]', 'map': '{...}', 'structure': '{...}', 'timestamp': 'datetime(2015, 1, 1)', }.get(type_name, '...') def get_official_service_name(service_model): """Generate the official name of an AWS Service :param service_model: The service model representing the service """ official_name = service_model.metadata.get('serviceFullName') short_name = service_model.metadata.get('serviceAbbreviation', '') if short_name.startswith('Amazon'): short_name = short_name[7:] if short_name.startswith('AWS'): short_name = short_name[4:] if short_name and short_name.lower() not in official_name.lower(): official_name += ' ({0})'.format(short_name) return official_name _DocumentedShape = namedtuple( 'DocumentedShape', ['name', 'type_name', 'documentation', 'metadata', 'members', 'required_members']) class DocumentedShape (_DocumentedShape): """Use this class to inject new shapes into a model for documentation""" def __new__(cls, name, type_name, documentation, metadata=None, members=None, required_members=None): if metadata is None: metadata = [] if members is None: members = [] if required_members is None: required_members = [] return super(DocumentedShape, cls).__new__( cls, name, type_name, documentation, metadata, members, required_members) class AutoPopulatedParam(object): def __init__(self, name, param_description=None): self.name = name self.param_description = param_description if param_description is None: self.param_description = ( 'Please note that this parameter is automatically populated ' 'if it is not provided. Including this parameter is not ' 'required\n') def document_auto_populated_param(self, event_name, section, **kwargs): """Documents auto populated parameters It will remove any required marks for the parameter, remove the parameter from the example, and add a snippet about the parameter being autopopulated in the description. """ if event_name.startswith('docs.request-params'): if self.name in section.available_sections: section = section.get_section(self.name) if 'is-required' in section.available_sections: section.delete_section('is-required') description_section = section.get_section( 'param-documentation') description_section.writeln(self.param_description) elif event_name.startswith('docs.request-example'): section = section.get_section('structure-value') if self.name in section.available_sections: section.delete_section(self.name) class HideParamFromOperations(object): """Hides a single parameter from multiple operations. This method will remove a parameter from documentation and from examples. This method is typically used for things that are automatically populated because a user would be unable to provide a value (e.g., a checksum of a serialized XML request body).""" def __init__(self, service_name, parameter_name, operation_names): """ :type service_name: str :param service_name: Name of the service to modify. :type parameter_name: str :param parameter_name: Name of the parameter to modify. :type operation_names: list :param operation_names: Operation names to modify. """ self._parameter_name = parameter_name self._params_events = set() self._example_events = set() # Build up the sets of relevant event names. param_template = 'docs.request-params.%s.%s.complete-section' example_template = 'docs.request-example.%s.%s.complete-section' for name in operation_names: self._params_events.add(param_template % (service_name, name)) self._example_events.add(example_template % (service_name, name)) def hide_param(self, event_name, section, **kwargs): if event_name in self._example_events: # Modify the structure value for example events. section = section.get_section('structure-value') elif event_name not in self._params_events: return if self._parameter_name in section.available_sections: section.delete_section(self._parameter_name) class AppendParamDocumentation(object): """Appends documentation to a specific parameter""" def __init__(self, parameter_name, doc_string): self._parameter_name = parameter_name self._doc_string = doc_string def append_documentation(self, event_name, section, **kwargs): if self._parameter_name in section.available_sections: section = section.get_section(self._parameter_name) description_section = section.get_section( 'param-documentation') description_section.writeln(self._doc_string) botocore-1.5.7/botocore/docs/service.py0000666454262600001440000000663013042511306021170 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from botocore.exceptions import DataNotFoundError from botocore.docs.utils import get_official_service_name from botocore.docs.client import ClientDocumenter from botocore.docs.waiter import WaiterDocumenter from botocore.docs.paginator import PaginatorDocumenter from botocore.docs.bcdoc.restdoc import DocumentStructure class ServiceDocumenter(object): def __init__(self, service_name, session): self._session = session self._service_name = service_name self._client = self._session.create_client( service_name, region_name='us-east-1', aws_access_key_id='foo', aws_secret_access_key='bar') self.sections = [ 'title', 'table-of-contents', 'client-api', 'paginator-api', 'waiter-api' ] def document_service(self): """Documents an entire service. :returns: The reStructured text of the documented service. """ doc_structure = DocumentStructure( self._service_name, section_names=self.sections, target='html') self.title(doc_structure.get_section('title')) self.table_of_contents(doc_structure.get_section('table-of-contents')) self.client_api(doc_structure.get_section('client-api')) self.paginator_api(doc_structure.get_section('paginator-api')) self.waiter_api(doc_structure.get_section('waiter-api')) return doc_structure.flush_structure() def title(self, section): section.style.h1(self._client.__class__.__name__) def table_of_contents(self, section): section.style.table_of_contents(title='Table of Contents', depth=2) def client_api(self, section): examples = None try: examples = self.get_examples(self._service_name) except DataNotFoundError: pass ClientDocumenter(self._client, examples).document_client(section) def paginator_api(self, section): try: service_paginator_model = self._session.get_paginator_model( self._service_name) except DataNotFoundError: return paginator_documenter = PaginatorDocumenter( self._client, service_paginator_model) paginator_documenter.document_paginators(section) def waiter_api(self, section): if self._client.waiter_names: service_waiter_model = self._session.get_waiter_model( self._service_name) waiter_documenter = WaiterDocumenter( self._client, service_waiter_model) waiter_documenter.document_waiters(section) def get_examples(self, service_name, api_version=None): loader = self._session.get_component('data_loader') examples = loader.load_service_model( service_name, 'examples-1', api_version) return examples['examples'] botocore-1.5.7/botocore/docs/sharedexample.py0000666454262600001440000002177713042511306022363 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import re import numbers from botocore.utils import parse_timestamp from datetime import datetime class SharedExampleDocumenter(object): def document_shared_example(self, example, prefix, section, operation_model): """Documents a single shared example based on its definition. :param example: The model of the example :param prefix: The prefix to use in the method example. :param section: The section to write to. :param operation_model: The model of the operation used in the example """ section.style.new_paragraph() section.write(example.get('description')) section.style.new_line() self.document_input(section, example, prefix, operation_model.input_shape) self.document_output(section, example, operation_model.output_shape) def document_input(self, section, example, prefix, shape): input_section = section.add_new_section('input') input_section.style.start_codeblock() if prefix is not None: input_section.write(prefix) params = example.get('input', {}) comments = example.get('comments') if comments: comments = comments.get('input') param_section = input_section.add_new_section('parameters') self._document_params(param_section, params, comments, [], shape) closing_section = input_section.add_new_section('input-close') closing_section.style.new_line() closing_section.style.new_line() closing_section.write('print(response)') closing_section.style.end_codeblock() def document_output(self, section, example, shape): output_section = section.add_new_section('output') output_section.style.new_line() output_section.write('Expected Output:') output_section.style.new_line() output_section.style.start_codeblock() params = example.get('output', {}) # There might not be an output, but we will return metadata anyway params['ResponseMetadata'] = {"...": "..."} comments = example.get('comments') if comments: comments = comments.get('output') self._document_dict(output_section, params, comments, [], shape, True) closing_section = output_section.add_new_section('output-close') closing_section.style.end_codeblock() def _document(self, section, value, comments, path, shape): """ :param section: The section to add the docs to. :param value: The input / output values representing the parameters that are included in the example. :param comments: The dictionary containing all the comments to be applied to the example. :param path: A list describing where the documenter is in traversing the parameters. This is used to find the equivalent location in the comments dictionary. """ if isinstance(value, dict): self._document_dict(section, value, comments, path, shape) elif isinstance(value, list): self._document_list(section, value, comments, path, shape) elif isinstance(value, numbers.Number): self._document_number(section, value, path) elif shape and shape.type_name == 'timestamp': self._document_datetime(section, value, path) else: self._document_str(section, value, path) def _document_dict(self, section, value, comments, path, shape, top_level=False): dict_section = section.add_new_section('dict-value') self._start_nested_value(dict_section, '{') for key, val in value.items(): path.append('.%s' % key) item_section = dict_section.add_new_section(key) item_section.style.new_line() item_comment = self._get_comment(path, comments) if item_comment: item_section.write(item_comment) item_section.style.new_line() item_section.write("'%s': " % key) # Shape could be none if there is no output besides ResponseMetadata item_shape = None if shape: if shape.type_name == 'structure': item_shape = shape.members.get(key) elif shape.type_name == 'map': item_shape = shape.value self._document(item_section, val, comments, path, item_shape) path.pop() dict_section_end = dict_section.add_new_section('ending-brace') self._end_nested_value(dict_section_end, '}') if not top_level: dict_section_end.write(',') def _document_params(self, section, value, comments, path, shape): param_section = section.add_new_section('param-values') self._start_nested_value(param_section, '(') for key, val in value.items(): path.append('.%s' % key) item_section = param_section.add_new_section(key) item_section.style.new_line() item_comment = self._get_comment(path, comments) if item_comment: item_section.write(item_comment) item_section.style.new_line() item_section.write(key + '=') # Shape could be none if there are no input parameters item_shape = None if shape: item_shape = shape.members.get(key) self._document(item_section, val, comments, path, item_shape) path.pop() param_section_end = param_section.add_new_section('ending-parenthesis') self._end_nested_value(param_section_end, ')') def _document_list(self, section, value, comments, path, shape): list_section = section.add_new_section('list-section') self._start_nested_value(list_section, '[') item_shape = shape.member for index, val in enumerate(value): item_section = list_section.add_new_section(index) item_section.style.new_line() path.append('[%s]' % index) item_comment = self._get_comment(path, comments) if item_comment: item_section.write(item_comment) item_section.style.new_line() self._document(item_section, val, comments, path, item_shape) path.pop() list_section_end = list_section.add_new_section('ending-bracket') self._end_nested_value(list_section_end, '],') def _document_str(self, section, value, path): # We do the string conversion because this might accept a type that # we don't specifically address. section.write("'%s'," % str(value)) def _document_number(self, section, value, path): section.write("%s," % str(value)) def _document_datetime(self, section, value, path): datetime_tuple = parse_timestamp(value).timetuple() datetime_str = str(datetime_tuple[0]) for i in range(1, len(datetime_tuple)): datetime_str += ", " + str(datetime_tuple[i]) section.write("datetime(%s)," % datetime_str) def _get_comment(self, path, comments): key = re.sub('^\.', '', ''.join(path)) if comments and key in comments: return '# ' + comments[key] else: return '' def _start_nested_value(self, section, start): section.write(start) section.style.indent() section.style.indent() def _end_nested_value(self, section, end): section.style.dedent() section.style.dedent() section.style.new_line() section.write(end) def document_shared_examples(section, operation_model, example_prefix, shared_examples): """Documents the shared examples :param section: The section to write to. :param operation_model: The model of the operation. :param example_prefix: The prefix to use in the method example. :param shared_examples: The shared JSON examples from the model. """ container_section = section.add_new_section('shared-examples') container_section.style.new_paragraph() container_section.style.bold('Examples') documenter = SharedExampleDocumenter() for example in shared_examples: documenter.document_shared_example( example=example, section=container_section.add_new_section(example['id']), prefix=example_prefix, operation_model=operation_model ) botocore-1.5.7/botocore/docs/params.py0000666454262600001440000002221613042511306021011 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from botocore.docs.shape import ShapeDocumenter from botocore.docs.utils import py_type_name class BaseParamsDocumenter(ShapeDocumenter): def document_params(self, section, shape, include=None, exclude=None): """Fills out the documentation for a section given a model shape. :param section: The section to write the documentation to. :param shape: The shape of the operation. :type include: Dictionary where keys are parameter names and values are the shapes of the parameter names. :param include: The parameter shapes to include in the documentation. :type exclude: List of the names of the parameters to exclude. :param exclude: The names of the parameters to exclude from documentation. """ history = [] self.traverse_and_document_shape( section=section, shape=shape, history=history, name=None, include=include, exclude=exclude) def document_recursive_shape(self, section, shape, **kwargs): self._add_member_documentation(section, shape, **kwargs) def document_shape_default(self, section, shape, history, include=None, exclude=None, **kwargs): self._add_member_documentation(section, shape, **kwargs) def document_shape_type_list(self, section, shape, history, include=None, exclude=None, **kwargs): self._add_member_documentation(section, shape, **kwargs) param_shape = shape.member param_section = section.add_new_section( param_shape.name, context={'shape': shape.member.name}) self._start_nested_param(param_section) self.traverse_and_document_shape( section=param_section, shape=param_shape, history=history, name=None) section = section.add_new_section('end-list') self._end_nested_param(section) def document_shape_type_map(self, section, shape, history, include=None, exclude=None, **kwargs): self._add_member_documentation(section, shape, **kwargs) key_section = section.add_new_section( 'key', context={'shape': shape.key.name}) self._start_nested_param(key_section) self._add_member_documentation(key_section, shape.key) param_section = section.add_new_section( shape.value.name, context={'shape': shape.value.name}) param_section.style.indent() self._start_nested_param(param_section) self.traverse_and_document_shape( section=param_section, shape=shape.value, history=history, name=None) end_section = section.add_new_section('end-map') self._end_nested_param(end_section) self._end_nested_param(end_section) def document_shape_type_structure(self, section, shape, history, include=None, exclude=None, name=None, **kwargs): members = self._add_members_to_shape(shape.members, include) self._add_member_documentation(section, shape, name=name) for param in members: if exclude and param in exclude: continue param_shape = members[param] param_section = section.add_new_section( param, context={'shape': param_shape.name}) self._start_nested_param(param_section) self.traverse_and_document_shape( section=param_section, shape=param_shape, history=history, name=param) section = section.add_new_section('end-structure') self._end_nested_param(section) def _add_member_documentation(self, section, shape, **kwargs): pass def _add_members_to_shape(self, members, include): if include: members = members.copy() for param in include: members[param.name] = param return members def _document_non_top_level_param_type(self, type_section, shape): special_py_type = self._get_special_py_type_name(shape) py_type = py_type_name(shape.type_name) type_format = '(%s) -- ' if special_py_type is not None: # Special type can reference a linked class. # Italicizing it blows away the link. type_section.write(type_format % special_py_type) else: type_section.style.italics(type_format % py_type) def _start_nested_param(self, section): section.style.indent() section.style.new_line() def _end_nested_param(self, section): section.style.dedent() section.style.new_line() class ResponseParamsDocumenter(BaseParamsDocumenter): """Generates the description for the response parameters""" EVENT_NAME = 'response-params' def _add_member_documentation(self, section, shape, name=None, **kwargs): name_section = section.add_new_section('param-name') name_section.write('- ') if name is not None: name_section.style.bold('%s ' % name) type_section = section.add_new_section('param-type') self._document_non_top_level_param_type(type_section, shape) documentation_section = section.add_new_section('param-documentation') if shape.documentation: documentation_section.style.indent() documentation_section.include_doc_string(shape.documentation) section.style.new_paragraph() class RequestParamsDocumenter(BaseParamsDocumenter): """Generates the description for the request parameters""" EVENT_NAME = 'request-params' def document_shape_type_structure(self, section, shape, history, include=None, exclude=None, **kwargs): if len(history) > 1: self._add_member_documentation(section, shape, **kwargs) section.style.indent() members = self._add_members_to_shape(shape.members, include) for i, param in enumerate(members): if exclude and param in exclude: continue param_shape = members[param] param_section = section.add_new_section( param, context={'shape': param_shape.name}) param_section.style.new_line() is_required = param in shape.required_members self.traverse_and_document_shape( section=param_section, shape=param_shape, history=history, name=param, is_required=is_required) section = section.add_new_section('end-structure') if len(history) > 1: section.style.dedent() section.style.new_line() def _add_member_documentation(self, section, shape, name=None, is_top_level_param=False, is_required=False, **kwargs): py_type = self._get_special_py_type_name(shape) if py_type is None: py_type = py_type_name(shape.type_name) if is_top_level_param: type_section = section.add_new_section('param-type') type_section.write(':type %s: %s' % (name, py_type)) end_type_section = type_section.add_new_section('end-param-type') end_type_section.style.new_line() name_section = section.add_new_section('param-name') name_section.write(':param %s: ' % name) else: name_section = section.add_new_section('param-name') name_section.write('- ') if name is not None: name_section.style.bold('%s ' % name) type_section = section.add_new_section('param-type') self._document_non_top_level_param_type(type_section, shape) if is_required: is_required_section = section.add_new_section('is-required') is_required_section.style.indent() is_required_section.style.bold('[REQUIRED] ') if shape.documentation: documentation_section = section.add_new_section( 'param-documentation') documentation_section.style.indent() documentation_section.include_doc_string(shape.documentation) self._add_special_trait_documentation(documentation_section, shape) end_param_section = section.add_new_section('end-param') end_param_section.style.new_paragraph() def _add_special_trait_documentation(self, section, shape): if 'idempotencyToken' in shape.metadata: self._append_idempotency_documentation(section) def _append_idempotency_documentation(self, section): docstring = 'This field is autopopulated if not provided.' section.write(docstring) botocore-1.5.7/botocore/docs/__init__.py0000666454262600001440000000300713042511306021262 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import os from botocore.docs.service import ServiceDocumenter def generate_docs(root_dir, session): """Generates the reference documentation for botocore This will go through every available AWS service and output ReSTructured text files documenting each service. :param root_dir: The directory to write the reference files to. Each service's reference documentation is loacated at root_dir/reference/services/service-name.rst """ services_doc_path = os.path.join(root_dir, 'reference', 'services') if not os.path.exists(services_doc_path): os.makedirs(services_doc_path) # Generate reference docs and write them out. for service_name in session.get_available_services(): docs = ServiceDocumenter(service_name, session).document_service() service_doc_path = os.path.join( services_doc_path, service_name + '.rst') with open(service_doc_path, 'wb') as f: f.write(docs) botocore-1.5.7/botocore/docs/example.py0000666454262600001440000002021313042511306021154 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from botocore.docs.shape import ShapeDocumenter from botocore.docs.utils import py_default class BaseExampleDocumenter(ShapeDocumenter): def document_example(self, section, shape, prefix=None, include=None, exclude=None): """Generates an example based on a shape :param section: The section to write the documentation to. :param shape: The shape of the operation. :param prefix: Anything to be included before the example :type include: Dictionary where keys are parameter names and values are the shapes of the parameter names. :param include: The parameter shapes to include in the documentation. :type exclude: List of the names of the parameters to exclude. :param exclude: The names of the parameters to exclude from documentation. """ history = [] section.style.new_line() section.style.start_codeblock() if prefix is not None: section.write(prefix) self.traverse_and_document_shape( section=section, shape=shape, history=history, include=include, exclude=exclude) def document_recursive_shape(self, section, shape, **kwargs): section.write('{\'... recursive ...\'}') def document_shape_default(self, section, shape, history, include=None, exclude=None, **kwargs): py_type = self._get_special_py_default(shape) if py_type is None: py_type = py_default(shape.type_name) if self._context.get('streaming_shape') == shape: py_type = 'StreamingBody()' section.write(py_type) def document_shape_type_string(self, section, shape, history, include=None, exclude=None, **kwargs): if 'enum' in shape.metadata: for i, enum in enumerate(shape.metadata['enum']): section.write('\'%s\'' % enum) if i < len(shape.metadata['enum']) - 1: section.write('|') else: self.document_shape_default(section, shape, history) def document_shape_type_list(self, section, shape, history, include=None, exclude=None, **kwargs): param_shape = shape.member list_section = section.add_new_section('list-value') self._start_nested_param(list_section, '[') param_section = list_section.add_new_section( 'member', context={'shape': param_shape.name}) self.traverse_and_document_shape( section=param_section, shape=param_shape, history=history) ending_comma_section = list_section.add_new_section('ending-comma') ending_comma_section.write(',') ending_bracket_section = list_section.add_new_section( 'ending-bracket') self._end_nested_param(ending_bracket_section, ']') def document_shape_type_structure(self, section, shape, history, include=None, exclude=None, **kwargs): section = section.add_new_section('structure-value') self._start_nested_param(section, '{') input_members = self._add_members_to_shape(shape.members, include) for i, param in enumerate(input_members): if exclude and param in exclude: continue param_section = section.add_new_section(param) param_section.write('\'%s\': ' % param) param_shape = input_members[param] param_value_section = param_section.add_new_section( 'member-value', context={'shape': param_shape.name}) self.traverse_and_document_shape( section=param_value_section, shape=param_shape, history=history, name=param) if i < len(input_members) - 1: ending_comma_section = param_section.add_new_section( 'ending-comma') ending_comma_section.write(',') ending_comma_section.style.new_line() self._end_structure(section, '{', '}') def document_shape_type_map(self, section, shape, history, include=None, exclude=None, **kwargs): map_section = section.add_new_section('map-value') self._start_nested_param(map_section, '{') value_shape = shape.value key_section = map_section.add_new_section( 'key', context={'shape': shape.key.name}) key_section.write('\'string\': ') value_section = map_section.add_new_section( 'value', context={'shape': value_shape.name}) self.traverse_and_document_shape( section=value_section, shape=value_shape, history=history) end_bracket_section = map_section.add_new_section('ending-bracket') self._end_nested_param(end_bracket_section, '}') def _add_members_to_shape(self, members, include): if include: members = members.copy() for param in include: members[param.name] = param return members def _start_nested_param(self, section, start=None): if start is not None: section.write(start) section.style.indent() section.style.indent() section.style.new_line() def _end_nested_param(self, section, end=None): section.style.dedent() section.style.dedent() section.style.new_line() if end is not None: section.write(end) def _end_structure(self, section, start, end): # If there are no members in the strucuture, then make sure the # start and the end bracket are on the same line, by removing all # previous text and writing the start and end. if not section.available_sections: section.clear_text() section.write(start + end) self._end_nested_param(section) else: end_bracket_section = section.add_new_section('ending-bracket') self._end_nested_param(end_bracket_section, end) class ResponseExampleDocumenter(BaseExampleDocumenter): EVENT_NAME = 'response-example' class RequestExampleDocumenter(BaseExampleDocumenter): EVENT_NAME = 'request-example' def document_shape_type_structure(self, section, shape, history, include=None, exclude=None, **kwargs): param_format = '\'%s\'' operator = ': ' start = '{' end = '}' if len(history) <= 1: operator = '=' start = '(' end = ')' param_format = '%s' section = section.add_new_section('structure-value') self._start_nested_param(section, start) input_members = self._add_members_to_shape(shape.members, include) for i, param in enumerate(input_members): if exclude and param in exclude: continue param_section = section.add_new_section(param) param_section.write(param_format % param) param_section.write(operator) param_shape = input_members[param] param_value_section = param_section.add_new_section( 'member-value', context={'shape': param_shape.name}) self.traverse_and_document_shape( section=param_value_section, shape=param_shape, history=history, name=param) if i < len(input_members) - 1: ending_comma_section = param_section.add_new_section( 'ending-comma') ending_comma_section.write(',') ending_comma_section.style.new_line() self._end_structure(section, start, end) botocore-1.5.7/botocore/docs/client.py0000666454262600001440000001074413042511306021007 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import inspect from botocore.docs.utils import get_official_service_name from botocore.docs.method import document_custom_method from botocore.docs.method import document_model_driven_method from botocore.docs.method import get_instance_public_methods from botocore.docs.sharedexample import document_shared_examples class ClientDocumenter(object): def __init__(self, client, shared_examples=None): self._client = client self._shared_examples = shared_examples if self._shared_examples is None: self._shared_examples = {} self._service_name = self._client.meta.service_model.service_name def document_client(self, section): """Documents a client and its methods :param section: The section to write to. """ self._add_title(section) self._add_class_signature(section) client_methods = get_instance_public_methods(self._client) self._add_client_intro(section, client_methods) self._add_client_methods(section, client_methods) def _add_title(self, section): section.style.h2('Client') def _add_client_intro(self, section, client_methods): section = section.add_new_section('intro') # Write out the top level description for the client. official_service_name = get_official_service_name( self._client.meta.service_model) section.write( 'A low-level client representing %s' % official_service_name) # Write out the client example instantiation. self._add_client_creation_example(section) # List out all of the possible client methods. section.style.new_line() section.write('These are the available methods:') section.style.new_line() for method_name in sorted(client_methods): section.style.li(':py:meth:`%s`' % (method_name)) def _add_class_signature(self, section): section.style.start_sphinx_py_class( class_name='%s.Client' % self._client.__class__.__name__) def _add_client_creation_example(self, section): section.style.start_codeblock() section.style.new_line() section.write( 'client = session.create_client(\'{service}\')'.format( service=self._service_name) ) section.style.end_codeblock() def _add_client_methods(self, section, client_methods): section = section.add_new_section('methods') for method_name in sorted(client_methods): self._add_client_method( section, method_name, client_methods[method_name]) def _add_client_method(self, section, method_name, method): section = section.add_new_section(method_name) if self._is_custom_method(method_name): self._add_custom_method(section, method_name, method) else: self._add_model_driven_method(section, method_name) def _is_custom_method(self, method_name): return method_name not in self._client.meta.method_to_api_mapping def _add_custom_method(self, section, method_name, method): document_custom_method(section, method_name, method) def _add_model_driven_method(self, section, method_name): service_model = self._client.meta.service_model operation_name = self._client.meta.method_to_api_mapping[method_name] operation_model = service_model.operation_model(operation_name) example_prefix = 'response = client.%s' % method_name document_model_driven_method( section, method_name, operation_model, event_emitter=self._client.meta.events, method_description=operation_model.documentation, example_prefix=example_prefix, ) # Add the shared examples shared_examples = self._shared_examples.get(operation_name) if shared_examples: document_shared_examples( section, operation_model, example_prefix, shared_examples) botocore-1.5.7/botocore/model.py0000666454262600001440000005676513042511306017716 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. """Abstractions to interact with service models.""" from collections import defaultdict from botocore.utils import CachedProperty, instance_cache from botocore.compat import OrderedDict NOT_SET = object() class NoShapeFoundError(Exception): pass class InvalidShapeError(Exception): pass class OperationNotFoundError(Exception): pass class InvalidShapeReferenceError(Exception): pass class UndefinedModelAttributeError(Exception): pass class Shape(object): """Object representing a shape from the service model.""" # To simplify serialization logic, all shape params that are # related to serialization are moved from the top level hash into # a 'serialization' hash. This list below contains the names of all # the attributes that should be moved. SERIALIZED_ATTRS = ['locationName', 'queryName', 'flattened', 'location', 'payload', 'streaming', 'timestampFormat', 'xmlNamespace', 'resultWrapper', 'xmlAttribute'] METADATA_ATTRS = ['required', 'min', 'max', 'sensitive', 'enum', 'idempotencyToken', 'error', 'exception'] MAP_TYPE = OrderedDict def __init__(self, shape_name, shape_model, shape_resolver=None): """ :type shape_name: string :param shape_name: The name of the shape. :type shape_model: dict :param shape_model: The shape model. This would be the value associated with the key in the "shapes" dict of the service model (i.e ``model['shapes'][shape_name]``) :type shape_resolver: botocore.model.ShapeResolver :param shape_resolver: A shape resolver object. This is used to resolve references to other shapes. For scalar shape types (string, integer, boolean, etc.), this argument is not required. If a shape_resolver is not provided for a complex type, then a ``ValueError`` will be raised when an attempt to resolve a shape is made. """ self.name = shape_name self.type_name = shape_model['type'] self.documentation = shape_model.get('documentation', '') self._shape_model = shape_model if shape_resolver is None: # If a shape_resolver is not provided, we create an object # that will throw errors if you attempt to resolve # a shape. This is actually ok for scalar shapes # because they don't need to resolve shapes and shouldn't # be required to provide an object they won't use. shape_resolver = UnresolvableShapeMap() self._shape_resolver = shape_resolver self._cache = {} @CachedProperty def serialization(self): """Serialization information about the shape. This contains information that may be needed for input serialization or response parsing. This can include: * name * queryName * flattened * location * payload * streaming * xmlNamespace * resultWrapper * xmlAttribute :rtype: dict :return: Serialization information about the shape. """ model = self._shape_model serialization = {} for attr in self.SERIALIZED_ATTRS: if attr in self._shape_model: serialization[attr] = model[attr] # For consistency, locationName is renamed to just 'name'. if 'locationName' in serialization: serialization['name'] = serialization.pop('locationName') return serialization @CachedProperty def metadata(self): """Metadata about the shape. This requires optional information about the shape, including: * min * max * enum * sensitive * required * idempotencyToken :rtype: dict :return: Metadata about the shape. """ model = self._shape_model metadata = {} for attr in self.METADATA_ATTRS: if attr in self._shape_model: metadata[attr] = model[attr] return metadata @CachedProperty def required_members(self): """A list of members that are required. A structure shape can define members that are required. This value will return a list of required members. If there are no required members an empty list is returned. """ return self.metadata.get('required', []) def _resolve_shape_ref(self, shape_ref): return self._shape_resolver.resolve_shape_ref(shape_ref) def __repr__(self): return "<%s(%s)>" % (self.__class__.__name__, self.name) class StructureShape(Shape): @CachedProperty def members(self): members = self._shape_model['members'] # The members dict looks like: # 'members': { # 'MemberName': {'shape': 'shapeName'}, # 'MemberName2': {'shape': 'shapeName'}, # } # We return a dict of member name to Shape object. shape_members = self.MAP_TYPE() for name, shape_ref in members.items(): shape_members[name] = self._resolve_shape_ref(shape_ref) return shape_members class ListShape(Shape): @CachedProperty def member(self): return self._resolve_shape_ref(self._shape_model['member']) class MapShape(Shape): @CachedProperty def key(self): return self._resolve_shape_ref(self._shape_model['key']) @CachedProperty def value(self): return self._resolve_shape_ref(self._shape_model['value']) class StringShape(Shape): @CachedProperty def enum(self): return self.metadata.get('enum', []) class ServiceModel(object): """ :ivar service_description: The parsed service description dictionary. """ def __init__(self, service_description, service_name=None): """ :type service_description: dict :param service_description: The service description model. This value is obtained from a botocore.loader.Loader, or from directly loading the file yourself:: service_description = json.load( open('/path/to/service-description-model.json')) model = ServiceModel(service_description) :type service_name: str :param service_name: The name of the service. Normally this is the endpoint prefix defined in the service_description. However, you can override this value to provide a more convenient name. This is done in a few places in botocore (ses instead of email, emr instead of elasticmapreduce). If this value is not provided, it will default to the endpointPrefix defined in the model. """ self._service_description = service_description # We want clients to be able to access metadata directly. self.metadata = service_description.get('metadata', {}) self._shape_resolver = ShapeResolver( service_description.get('shapes', {})) self._signature_version = NOT_SET self._service_name = service_name self._instance_cache = {} def shape_for(self, shape_name, member_traits=None): return self._shape_resolver.get_shape_by_name( shape_name, member_traits) def resolve_shape_ref(self, shape_ref): return self._shape_resolver.resolve_shape_ref(shape_ref) @CachedProperty def shape_names(self): return list(self._service_description.get('shapes', {})) @instance_cache def operation_model(self, operation_name): try: model = self._service_description['operations'][operation_name] except KeyError: raise OperationNotFoundError(operation_name) return OperationModel(model, self, operation_name) @CachedProperty def documentation(self): return self._service_description.get('documentation', '') @CachedProperty def operation_names(self): return list(self._service_description.get('operations', [])) @CachedProperty def service_name(self): """The name of the service. This defaults to the endpointPrefix defined in the service model. However, this value can be overriden when a ``ServiceModel`` is created. If a service_name was not provided when the ``ServiceModel`` was created and if there is no endpointPrefix defined in the service model, then an ``UndefinedModelAttributeError`` exception will be raised. """ if self._service_name is not None: return self._service_name else: return self.endpoint_prefix @CachedProperty def signing_name(self): """The name to use when computing signatures. If the model does not define a signing name, this value will be the endpoint prefix defined in the model. """ signing_name = self.metadata.get('signingName') if signing_name is None: signing_name = self.endpoint_prefix return signing_name @CachedProperty def api_version(self): return self._get_metadata_property('apiVersion') @CachedProperty def protocol(self): return self._get_metadata_property('protocol') @CachedProperty def endpoint_prefix(self): return self._get_metadata_property('endpointPrefix') def _get_metadata_property(self, name): try: return self.metadata[name] except KeyError: raise UndefinedModelAttributeError( '"%s" not defined in the metadata of the the model: %s' % (name, self)) # Signature version is one of the rare properties # than can be modified so a CachedProperty is not used here. @property def signature_version(self): if self._signature_version is NOT_SET: signature_version = self.metadata.get('signatureVersion') self._signature_version = signature_version return self._signature_version @signature_version.setter def signature_version(self, value): self._signature_version = value class OperationModel(object): def __init__(self, operation_model, service_model, name=None): """ :type operation_model: dict :param operation_model: The operation model. This comes from the service model, and is the value associated with the operation name in the service model (i.e ``model['operations'][op_name]``). :type service_model: botocore.model.ServiceModel :param service_model: The service model associated with the operation. :type name: string :param name: The operation name. This is the operation name exposed to the users of this model. This can potentially be different from the "wire_name", which is the operation name that *must* by provided over the wire. For example, given:: "CreateCloudFrontOriginAccessIdentity":{ "name":"CreateCloudFrontOriginAccessIdentity2014_11_06", ... } The ``name`` would be ``CreateCloudFrontOriginAccessIdentity``, but the ``self.wire_name`` would be ``CreateCloudFrontOriginAccessIdentity2014_11_06``, which is the value we must send in the corresponding HTTP request. """ self._operation_model = operation_model self._service_model = service_model self._api_name = name # Clients can access '.name' to get the operation name # and '.metadata' to get the top level metdata of the service. self._wire_name = operation_model.get('name') self.metadata = service_model.metadata self.http = operation_model.get('http', {}) @CachedProperty def name(self): if self._api_name is not None: return self._api_name else: return self.wire_name @property def wire_name(self): """The wire name of the operation. In many situations this is the same value as the ``name``, value, but in some services, the operation name exposed to the user is different from the operaiton name we send across the wire (e.g cloudfront). Any serialization code should use ``wire_name``. """ return self._operation_model.get('name') @property def service_model(self): return self._service_model @CachedProperty def documentation(self): return self._operation_model.get('documentation', '') @CachedProperty def input_shape(self): if 'input' not in self._operation_model: # Some operations do not accept any input and do not define an # input shape. return None return self._service_model.resolve_shape_ref( self._operation_model['input']) @CachedProperty def output_shape(self): if 'output' not in self._operation_model: # Some operations do not define an output shape, # in which case we return None to indicate the # operation has no expected output. return None return self._service_model.resolve_shape_ref( self._operation_model['output']) @CachedProperty def idempotent_members(self): input_shape = self.input_shape if not input_shape: return [] return [name for (name, shape) in input_shape.members.items() if 'idempotencyToken' in shape.metadata and shape.metadata['idempotencyToken']] @CachedProperty def error_shapes(self): shapes = self._operation_model.get("errors", []) return list(self._service_model.resolve_shape_ref(s) for s in shapes) @CachedProperty def has_streaming_input(self): return self.get_streaming_input() is not None @CachedProperty def has_streaming_output(self): return self.get_streaming_output() is not None def get_streaming_input(self): return self._get_streaming_body(self.input_shape) def get_streaming_output(self): return self._get_streaming_body(self.output_shape) def _get_streaming_body(self, shape): """Returns the streaming member's shape if any; or None otherwise.""" if shape is None: return None payload = shape.serialization.get('payload') if payload is not None: payload_shape = shape.members[payload] if payload_shape.type_name == 'blob': return payload_shape return None def __repr__(self): return '%s(name=%s)' % (self.__class__.__name__, self.name) class ShapeResolver(object): """Resolves shape references.""" # Any type not in this mapping will default to the Shape class. SHAPE_CLASSES = { 'structure': StructureShape, 'list': ListShape, 'map': MapShape, 'string': StringShape } def __init__(self, shape_map): self._shape_map = shape_map self._shape_cache = {} def get_shape_by_name(self, shape_name, member_traits=None): try: shape_model = self._shape_map[shape_name] except KeyError: raise NoShapeFoundError(shape_name) try: shape_cls = self.SHAPE_CLASSES.get(shape_model['type'], Shape) except KeyError: raise InvalidShapeError("Shape is missing required key 'type': %s" % shape_model) if member_traits: shape_model = shape_model.copy() shape_model.update(member_traits) result = shape_cls(shape_name, shape_model, self) return result def resolve_shape_ref(self, shape_ref): # A shape_ref is a dict that has a 'shape' key that # refers to a shape name as well as any additional # member traits that are then merged over the shape # definition. For example: # {"shape": "StringType", "locationName": "Foobar"} if len(shape_ref) == 1 and 'shape' in shape_ref: # It's just a shape ref with no member traits, we can avoid # a .copy(). This is the common case so it's specifically # called out here. return self.get_shape_by_name(shape_ref['shape']) else: member_traits = shape_ref.copy() try: shape_name = member_traits.pop('shape') except KeyError: raise InvalidShapeReferenceError( "Invalid model, missing shape reference: %s" % shape_ref) return self.get_shape_by_name(shape_name, member_traits) class UnresolvableShapeMap(object): """A ShapeResolver that will throw ValueErrors when shapes are resolved. """ def get_shape_by_name(self, shape_name, member_traits=None): raise ValueError("Attempted to lookup shape '%s', but no shape " "map was provided.") def resolve_shape_ref(self, shape_ref): raise ValueError("Attempted to resolve shape '%s', but no shape " "map was provided.") class DenormalizedStructureBuilder(object): """Build a StructureShape from a denormalized model. This is a convenience builder class that makes it easy to construct ``StructureShape``s based on a denormalized model. It will handle the details of creating unique shape names and creating the appropriate shape map needed by the ``StructureShape`` class. Example usage:: builder = DenormalizedStructureBuilder() shape = builder.with_members({ 'A': { 'type': 'structure', 'members': { 'B': { 'type': 'structure', 'members': { 'C': { 'type': 'string', } } } } } }).build_model() # ``shape`` is now an instance of botocore.model.StructureShape :type dict_type: class :param dict_type: The dictionary type to use, allowing you to opt-in to using OrderedDict or another dict type. This can be particularly useful for testing when order matters, such as for documentation. """ def __init__(self, name=None): self.members = OrderedDict() self._name_generator = ShapeNameGenerator() if name is None: self.name = self._name_generator.new_shape_name('structure') def with_members(self, members): """ :type members: dict :param members: The denormalized members. :return: self """ self._members = members return self def build_model(self): """Build the model based on the provided members. :rtype: botocore.model.StructureShape :return: The built StructureShape object. """ shapes = OrderedDict() denormalized = { 'type': 'structure', 'members': self._members, } self._build_model(denormalized, shapes, self.name) resolver = ShapeResolver(shape_map=shapes) return StructureShape(shape_name=self.name, shape_model=shapes[self.name], shape_resolver=resolver) def _build_model(self, model, shapes, shape_name): if model['type'] == 'structure': shapes[shape_name] = self._build_structure(model, shapes) elif model['type'] == 'list': shapes[shape_name] = self._build_list(model, shapes) elif model['type'] == 'map': shapes[shape_name] = self._build_map(model, shapes) elif model['type'] in ['string', 'integer', 'boolean', 'blob', 'float', 'timestamp', 'long', 'double', 'char']: shapes[shape_name] = self._build_scalar(model) else: raise InvalidShapeError("Unknown shape type: %s" % model['type']) def _build_structure(self, model, shapes): members = OrderedDict() shape = self._build_initial_shape(model) shape['members'] = members for name, member_model in model['members'].items(): member_shape_name = self._get_shape_name(member_model) members[name] = {'shape': member_shape_name} self._build_model(member_model, shapes, member_shape_name) return shape def _build_list(self, model, shapes): member_shape_name = self._get_shape_name(model) shape = self._build_initial_shape(model) shape['member'] = {'shape': member_shape_name} self._build_model(model['member'], shapes, member_shape_name) return shape def _build_map(self, model, shapes): key_shape_name = self._get_shape_name(model['key']) value_shape_name = self._get_shape_name(model['value']) shape = self._build_initial_shape(model) shape['key'] = {'shape': key_shape_name} shape['value'] = {'shape': value_shape_name} self._build_model(model['key'], shapes, key_shape_name) self._build_model(model['value'], shapes, value_shape_name) return shape def _build_initial_shape(self, model): shape = { 'type': model['type'], } if 'documentation' in model: shape['documentation'] = model['documentation'] if 'enum' in model: shape['enum'] = model['enum'] return shape def _build_scalar(self, model): return self._build_initial_shape(model) def _get_shape_name(self, model): if 'shape_name' in model: return model['shape_name'] else: return self._name_generator.new_shape_name(model['type']) class ShapeNameGenerator(object): """Generate unique shape names for a type. This class can be used in conjunction with the DenormalizedStructureBuilder to generate unique shape names for a given type. """ def __init__(self): self._name_cache = defaultdict(int) def new_shape_name(self, type_name): """Generate a unique shape name. This method will guarantee a unique shape name each time it is called with the same type. :: >>> s = ShapeNameGenerator() >>> s.new_shape_name('structure') 'StructureType1' >>> s.new_shape_name('structure') 'StructureType2' >>> s.new_shape_name('list') 'ListType1' >>> s.new_shape_name('list') 'ListType2' :type type_name: string :param type_name: The type name (structure, list, map, string, etc.) :rtype: string :return: A unique shape name for the given type """ self._name_cache[type_name] += 1 current_index = self._name_cache[type_name] return '%sType%s' % (type_name.capitalize(), current_index) botocore-1.5.7/botocore/errorfactory.py0000666454262600001440000000777313042511306021332 0ustar pysdk-ciamazon00000000000000# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from botocore.exceptions import ClientError from botocore.utils import get_service_module_name class BaseClientExceptions(object): ClientError = ClientError def __init__(self, code_to_exception): """Base class for exceptions object on a client :type code_to_exception: dict :param code_to_exception: Mapping of error codes (strings) to exception class that should be raised when encountering a particular error code. """ self._code_to_exception = code_to_exception def from_code(self, error_code): """Retrieves the error class based on the error code This is helpful for identifying the exception class needing to be caught based on the ClientError.parsed_reponse['Error']['Code'] value :type error_code: string :param error_code: The error code associated to a ClientError exception :rtype: ClientError or a subclass of ClientError :returns: The appropriate modeled exception class for that error code. If the error code does not match any of the known modeled exceptions then return a generic ClientError. """ return self._code_to_exception.get(error_code, self.ClientError) def __getattr__(self, name): exception_cls_names = [ exception_cls.__name__ for exception_cls in self._code_to_exception.values() ] raise AttributeError( '%r object has no attribute %r. Valid exceptions are: %s' % ( self, name, ', '.join(exception_cls_names))) class ClientExceptionsFactory(object): def __init__(self): self._client_exceptions_cache = {} def create_client_exceptions(self, service_model): """Creates a ClientExceptions object for the particular service client :type service_model: botocore.model.ServiceModel :param service_model: The service model for the client :rtype: object that subclasses from BaseClientExceptions :returns: The exceptions object of a client that can be used to grab the various different modeled exceptions. """ service_name = service_model.service_name if service_name not in self._client_exceptions_cache: client_exceptions = self._create_client_exceptions(service_model) self._client_exceptions_cache[service_name] = client_exceptions return self._client_exceptions_cache[service_name] def _create_client_exceptions(self, service_model): cls_props = {} code_to_exception = {} for shape_name in service_model.shape_names: shape = service_model.shape_for(shape_name) if shape.metadata.get('exception', False): exception_name = str(shape.name) exception_cls = type(exception_name, (ClientError,), {}) code = shape.metadata.get("error", {}).get("code") cls_props[exception_name] = exception_cls if code: code_to_exception[code] = exception_cls else: # Use the exception name if there is no explicit code # modeled code_to_exception[exception_name] = exception_cls cls_name = str(get_service_module_name(service_model) + 'Exceptions') client_exceptions_cls = type( cls_name, (BaseClientExceptions,), cls_props) return client_exceptions_cls(code_to_exception) botocore-1.5.7/botocore/loaders.py0000666454262600001440000004171313042511306020232 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. """Module for loading various model files. This module provides the classes that are used to load models used by botocore. This can include: * Service models (e.g. the model for EC2, S3, DynamoDB, etc.) * Service model extras which customize the service models * Other models associated with a service (pagination, waiters) * Non service-specific config (Endpoint data, retry config) Loading a module is broken down into several steps: * Determining the path to load * Search the data_path for files to load * The mechanics of loading the file * Searching for extras and applying them to the loaded file The last item is used so that other faster loading mechanism besides the default JSON loader can be used. The Search Path =============== Similar to how the PATH environment variable is to finding executables and the PYTHONPATH environment variable is to finding python modules to import, the botocore loaders have the concept of a data path exposed through AWS_DATA_PATH. This enables end users to provide additional search paths where we will attempt to load models outside of the models we ship with botocore. When you create a ``Loader``, there are two paths automatically added to the model search path: * /data/ * ~/.aws/models The first value is the path where all the model files shipped with botocore are located. The second path is so that users can just drop new model files in ``~/.aws/models`` without having to mess around with the AWS_DATA_PATH. The AWS_DATA_PATH using the platform specific path separator to separate entries (typically ``:`` on linux and ``;`` on windows). Directory Layout ================ The Loader expects a particular directory layout. In order for any directory specified in AWS_DATA_PATH to be considered, it must have this structure for service models:: | |-- servicename1 | |-- 2012-10-25 | |-- service-2.json |-- ec2 | |-- 2014-01-01 | | |-- paginators-1.json | | |-- service-2.json | | |-- waiters-2.json | |-- 2015-03-01 | |-- paginators-1.json | |-- service-2.json | |-- waiters-2.json | |-- service-2.sdk-extras.json That is: * The root directory contains sub directories that are the name of the services. * Within each service directory, there's a sub directory for each available API version. * Within each API version, there are model specific files, including (but not limited to): service-2.json, waiters-2.json, paginators-1.json The ``-1`` and ``-2`` suffix at the end of the model files denote which version schema is used within the model. Even though this information is available in the ``version`` key within the model, this version is also part of the filename so that code does not need to load the JSON model in order to determine which version to use. The ``sdk-extras`` and similar files represent extra data that needs to be applied to the model after it is loaded. Data in these files might represent information that doesn't quite fit in the original models, but is still needed for the sdk. For instance, additional operation parameters might be added here which don't represent the actual service api. """ import os import logging from botocore import BOTOCORE_ROOT from botocore.compat import json from botocore.compat import OrderedDict from botocore.exceptions import DataNotFoundError, UnknownServiceError from botocore.utils import deep_merge logger = logging.getLogger(__name__) def instance_cache(func): """Cache the result of a method on a per instance basis. This is not a general purpose caching decorator. In order for this to be used, it must be used on methods on an instance, and that instance *must* provide a ``self._cache`` dictionary. """ def _wrapper(self, *args, **kwargs): key = (func.__name__,) + args for pair in sorted(kwargs.items()): key += pair if key in self._cache: return self._cache[key] data = func(self, *args, **kwargs) self._cache[key] = data return data return _wrapper class JSONFileLoader(object): """Loader JSON files. This class can load the default format of models, which is a JSON file. """ def exists(self, file_path): """Checks if the file exists. :type file_path: str :param file_path: The full path to the file to load without the '.json' extension. :return: True if file path exists, False otherwise. """ return os.path.isfile(file_path + '.json') def load_file(self, file_path): """Attempt to load the file path. :type file_path: str :param file_path: The full path to the file to load without the '.json' extension. :return: The loaded data if it exists, otherwise None. """ full_path = file_path + '.json' if not os.path.isfile(full_path): return # By default the file will be opened with locale encoding on Python 3. # We specify "utf8" here to ensure the correct behavior. with open(full_path, 'rb') as fp: payload = fp.read().decode('utf-8') logger.debug("Loading JSON file: %s", full_path) return json.loads(payload, object_pairs_hook=OrderedDict) def create_loader(search_path_string=None): """Create a Loader class. This factory function creates a loader given a search string path. :type search_string_path: str :param search_string_path: The AWS_DATA_PATH value. A string of data path values separated by the ``os.path.pathsep`` value, which is typically ``:`` on POSIX platforms and ``;`` on windows. :return: A ``Loader`` instance. """ if search_path_string is None: return Loader() paths = [] extra_paths = search_path_string.split(os.pathsep) for path in extra_paths: path = os.path.expanduser(os.path.expandvars(path)) paths.append(path) return Loader(extra_search_paths=paths) class Loader(object): """Find and load data models. This class will handle searching for and loading data models. The main method used here is ``load_service_model``, which is a convenience method over ``load_data`` and ``determine_latest_version``. """ FILE_LOADER_CLASS = JSONFileLoader # The included models in botocore/data/ that we ship with botocore. BUILTIN_DATA_PATH = os.path.join(BOTOCORE_ROOT, 'data') # For convenience we automatically add ~/.aws/models to the data path. CUSTOMER_DATA_PATH = os.path.join(os.path.expanduser('~'), '.aws', 'models') BUILTIN_EXTRAS_TYPES = ['sdk'] def __init__(self, extra_search_paths=None, file_loader=None, cache=None, include_default_search_paths=True, include_default_extras=True): self._cache = {} if file_loader is None: file_loader = self.FILE_LOADER_CLASS() self.file_loader = file_loader if extra_search_paths is not None: self._search_paths = extra_search_paths else: self._search_paths = [] if include_default_search_paths: self._search_paths.extend([self.CUSTOMER_DATA_PATH, self.BUILTIN_DATA_PATH]) self._extras_types = [] if include_default_extras: self._extras_types.extend(self.BUILTIN_EXTRAS_TYPES) self._extras_processor = ExtrasProcessor() @property def search_paths(self): return self._search_paths @property def extras_types(self): return self._extras_types @instance_cache def list_available_services(self, type_name): """List all known services. This will traverse the search path and look for all known services. :type type_name: str :param type_name: The type of the service (service-2, paginators-1, waiters-2, etc). This is needed because the list of available services depends on the service type. For example, the latest API version available for a resource-1.json file may not be the latest API version available for a services-2.json file. :return: A list of all services. The list of services will be sorted. """ services = set() for possible_path in self._potential_locations(): # Any directory in the search path is potentially a service. # We'll collect any initial list of potential services, # but we'll then need to further process these directories # by searching for the corresponding type_name in each # potential directory. possible_services = [ d for d in os.listdir(possible_path) if os.path.isdir(os.path.join(possible_path, d))] for service_name in possible_services: full_dirname = os.path.join(possible_path, service_name) api_versions = os.listdir(full_dirname) for api_version in api_versions: full_load_path = os.path.join(full_dirname, api_version, type_name) if self.file_loader.exists(full_load_path): services.add(service_name) break return sorted(services) @instance_cache def determine_latest_version(self, service_name, type_name): """Find the latest API version available for a service. :type service_name: str :param service_name: The name of the service. :type type_name: str :param type_name: The type of the service (service-2, paginators-1, waiters-2, etc). This is needed because the latest API version available can depend on the service type. For example, the latest API version available for a resource-1.json file may not be the latest API version available for a services-2.json file. :rtype: str :return: The latest API version. If the service does not exist or does not have any available API data, then a ``DataNotFoundError`` exception will be raised. """ return max(self.list_api_versions(service_name, type_name)) @instance_cache def list_api_versions(self, service_name, type_name): """List all API versions available for a particular service type :type service_name: str :param service_name: The name of the service :type type_name: str :param type_name: The type name for the service (i.e service-2, paginators-1, etc.) :rtype: list :return: A list of API version strings in sorted order. """ known_api_versions = set() for possible_path in self._potential_locations(service_name, must_exist=True, is_dir=True): for dirname in os.listdir(possible_path): full_path = os.path.join(possible_path, dirname, type_name) # Only add to the known_api_versions if the directory # contains a service-2, paginators-1, etc. file corresponding # to the type_name passed in. if self.file_loader.exists(full_path): known_api_versions.add(dirname) if not known_api_versions: raise DataNotFoundError(data_path=service_name) return sorted(known_api_versions) @instance_cache def load_service_model(self, service_name, type_name, api_version=None): """Load a botocore service model This is the main method for loading botocore models (e.g. a service model, pagination configs, waiter configs, etc.). :type service_name: str :param service_name: The name of the service (e.g ``ec2``, ``s3``). :type type_name: str :param type_name: The model type. Valid types include, but are not limited to: ``service-2``, ``paginators-1``, ``waiters-2``. :type api_version: str :param api_version: The API version to load. If this is not provided, then the latest API version will be used. :type load_extras: bool :param load_extras: Whether or not to load the tool extras which contain additional data to be added to the model. :raises: UnknownServiceError if there is no known service with the provided service_name. :raises: DataNotFoundError if no data could be found for the service_name/type_name/api_version. :return: The loaded data, as a python type (e.g. dict, list, etc). """ # Wrapper around the load_data. This will calculate the path # to call load_data with. known_services = self.list_available_services(type_name) if service_name not in known_services: raise UnknownServiceError( service_name=service_name, known_service_names=', '.join(sorted(known_services))) if api_version is None: api_version = self.determine_latest_version( service_name, type_name) full_path = os.path.join(service_name, api_version, type_name) model = self.load_data(full_path) # Load in all the extras extras_data = self._find_extras(service_name, type_name, api_version) self._extras_processor.process(model, extras_data) return model def _find_extras(self, service_name, type_name, api_version): """Creates an iterator over all the extras data.""" for extras_type in self.extras_types: extras_name = '%s.%s-extras' % (type_name, extras_type) full_path = os.path.join(service_name, api_version, extras_name) try: yield self.load_data(full_path) except DataNotFoundError: pass @instance_cache def load_data(self, name): """Load data given a data path. This is a low level method that will search through the various search paths until it's able to load a value. This is typically only needed to load *non* model files (such as _endpoints and _retry). If you need to load model files, you should prefer ``load_service_model``. :type name: str :param name: The data path, i.e ``ec2/2015-03-01/service-2``. :return: The loaded data. If no data could be found then a DataNotFoundError is raised. """ for possible_path in self._potential_locations(name): found = self.file_loader.load_file(possible_path) if found is not None: return found # We didn't find anything that matched on any path. raise DataNotFoundError(data_path=name) def _potential_locations(self, name=None, must_exist=False, is_dir=False): # Will give an iterator over the full path of potential locations # according to the search path. for path in self.search_paths: if os.path.isdir(path): full_path = path if name is not None: full_path = os.path.join(path, name) if not must_exist: yield full_path else: if is_dir and os.path.isdir(full_path): yield full_path elif os.path.exists(full_path): yield full_path class ExtrasProcessor(object): """Processes data from extras files into service models.""" def process(self, original_model, extra_models): """Processes data from a list of loaded extras files into a model :type original_model: dict :param original_model: The service model to load all the extras into. :type extra_models: iterable of dict :param extra_models: A list of loaded extras models. """ for extras in extra_models: self._process(original_model, extras) def _process(self, model, extra_model): """Process a single extras model into a service model.""" if 'merge' in extra_model: deep_merge(model, extra_model['merge']) botocore-1.5.7/botocore/regions.py0000666454262600001440000002034413042511306020244 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. """Resolves regions and endpoints. This module implements endpoint resolution, including resolving endpoints for a given service and region and resolving the available endpoints for a service in a specific AWS partition. """ import logging import re from botocore.exceptions import NoRegionError LOG = logging.getLogger(__name__) DEFAULT_URI_TEMPLATE = '{service}.{region}.{dnsSuffix}' DEFAULT_SERVICE_DATA = {'endpoints': {}} class BaseEndpointResolver(object): """Resolves regions and endpoints. Must be subclassed.""" def construct_endpoint(self, service_name, region_name=None): """Resolves an endpoint for a service and region combination. :type service_name: string :param service_name: Name of the service to resolve an endpoint for (e.g., s3) :type region_name: string :param region_name: Region/endpoint name to resolve (e.g., us-east-1) if no region is provided, the first found partition-wide endpoint will be used if available. :rtype: dict :return: Returns a dict containing the following keys: - partition: (string, required) Resolved partition name - endpointName: (string, required) Resolved endpoint name - hostname: (string, required) Hostname to use for this endpoint - sslCommonName: (string) sslCommonName to use for this endpoint. - credentialScope: (dict) Signature version 4 credential scope - region: (string) region name override when signing. - service: (string) service name override when signing. - signatureVersions: (list) A list of possible signature versions, including s3, v4, v2, and s3v4 - protocols: (list) A list of supported protocols (e.g., http, https) - ...: Other keys may be included as well based on the metadata """ raise NotImplementedError def get_available_partitions(self): """Lists the partitions available to the endpoint resolver. :return: Returns a list of partition names (e.g., ["aws", "aws-cn"]). """ raise NotImplementedError def get_available_endpoints(self, service_name, partition_name='aws', allow_non_regional=False): """Lists the endpoint names of a particular partition. :type service_name: string :param service_name: Name of a service to list endpoint for (e.g., s3) :type partition_name: string :param partition_name: Name of the partition to limit endpoints to. (e.g., aws for the public AWS endpoints, aws-cn for AWS China endpoints, aws-us-gov for AWS GovCloud (US) Endpoints, etc. :type allow_non_regional: bool :param allow_non_regional: Set to True to include endpoints that are not regional endpoints (e.g., s3-external-1, fips-us-gov-west-1, etc). :return: Returns a list of endpoint names (e.g., ["us-east-1"]). """ raise NotImplementedError class EndpointResolver(BaseEndpointResolver): """Resolves endpoints based on partition endpoint metadata""" def __init__(self, endpoint_data): """ :param endpoint_data: A dict of partition data. """ if 'partitions' not in endpoint_data: raise ValueError('Missing "partitions" in endpoint data') self._endpoint_data = endpoint_data def get_available_partitions(self): result = [] for partition in self._endpoint_data['partitions']: result.append(partition['partition']) return result def get_available_endpoints(self, service_name, partition_name='aws', allow_non_regional=False): result = [] for partition in self._endpoint_data['partitions']: if partition['partition'] != partition_name: continue services = partition['services'] if service_name not in services: continue for endpoint_name in services[service_name]['endpoints']: if allow_non_regional or endpoint_name in partition['regions']: result.append(endpoint_name) return result def construct_endpoint(self, service_name, region_name=None): # Iterate over each partition until a match is found. for partition in self._endpoint_data['partitions']: result = self._endpoint_for_partition( partition, service_name, region_name) if result: return result def _endpoint_for_partition(self, partition, service_name, region_name): # Get the service from the partition, or an empty template. service_data = partition['services'].get( service_name, DEFAULT_SERVICE_DATA) # Use the partition endpoint if no region is supplied. if region_name is None: if 'partitionEndpoint' in service_data: region_name = service_data['partitionEndpoint'] else: raise NoRegionError() # Attempt to resolve the exact region for this partition. if region_name in service_data['endpoints']: return self._resolve( partition, service_name, service_data, region_name) # Check to see if the endpoint provided is valid for the partition. if self._region_match(partition, region_name): # Use the partition endpoint if set and not regionalized. partition_endpoint = service_data.get('partitionEndpoint') is_regionalized = service_data.get('isRegionalized', True) if partition_endpoint and not is_regionalized: LOG.debug('Using partition endpoint for %s, %s: %s', service_name, region_name, partition_endpoint) return self._resolve( partition, service_name, service_data, partition_endpoint) LOG.debug('Creating a regex based endpoint for %s, %s', service_name, region_name) return self._resolve( partition, service_name, service_data, region_name) def _region_match(self, partition, region_name): if region_name in partition['regions']: return True if 'regionRegex' in partition: return re.compile(partition['regionRegex']).match(region_name) return False def _resolve(self, partition, service_name, service_data, endpoint_name): result = service_data['endpoints'].get(endpoint_name, {}) result['partition'] = partition['partition'] result['endpointName'] = endpoint_name # Merge in the service defaults then the partition defaults. self._merge_keys(service_data.get('defaults', {}), result) self._merge_keys(partition.get('defaults', {}), result) hostname = result.get('hostname', DEFAULT_URI_TEMPLATE) result['hostname'] = self._expand_template( partition, result['hostname'], service_name, endpoint_name) if 'sslCommonName' in result: result['sslCommonName'] = self._expand_template( partition, result['sslCommonName'], service_name, endpoint_name) result['dnsSuffix'] = partition['dnsSuffix'] return result def _merge_keys(self, from_data, result): for key in from_data: if key not in result: result[key] = from_data[key] def _expand_template(self, partition, template, service_name, endpoint_name): return template.format( service=service_name, region=endpoint_name, dnsSuffix=partition['dnsSuffix']) botocore-1.5.7/botocore/awsrequest.py0000666454262600001440000004465613042511306021015 0ustar pysdk-ciamazon00000000000000# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import sys import logging import select import functools import socket import inspect from botocore.compat import six from botocore.compat import HTTPHeaders, HTTPResponse, urlunsplit, urlsplit from botocore.exceptions import UnseekableStreamError from botocore.utils import percent_encode_sequence from botocore.vendored.requests import models from botocore.vendored.requests.sessions import REDIRECT_STATI from botocore.vendored.requests.packages.urllib3.connection import \ VerifiedHTTPSConnection from botocore.vendored.requests.packages.urllib3.connection import \ HTTPConnection from botocore.vendored.requests.packages.urllib3.connectionpool import \ HTTPConnectionPool from botocore.vendored.requests.packages.urllib3.connectionpool import \ HTTPSConnectionPool logger = logging.getLogger(__name__) class AWSHTTPResponse(HTTPResponse): # The *args, **kwargs is used because the args are slightly # different in py2.6 than in py2.7/py3. def __init__(self, *args, **kwargs): self._status_tuple = kwargs.pop('status_tuple') HTTPResponse.__init__(self, *args, **kwargs) def _read_status(self): if self._status_tuple is not None: status_tuple = self._status_tuple self._status_tuple = None return status_tuple else: return HTTPResponse._read_status(self) class AWSHTTPConnection(HTTPConnection): """HTTPConnection that supports Expect 100-continue. This is conceptually a subclass of httplib.HTTPConnection (though technically we subclass from urllib3, which subclasses httplib.HTTPConnection) and we only override this class to support Expect 100-continue, which we need for S3. As far as I can tell, this is general purpose enough to not be specific to S3, but I'm being tentative and keeping it in botocore because I've only tested this against AWS services. """ def __init__(self, *args, **kwargs): HTTPConnection.__init__(self, *args, **kwargs) self._original_response_cls = self.response_class # We'd ideally hook into httplib's states, but they're all # __mangled_vars so we use our own state var. This variable is set # when we receive an early response from the server. If this value is # set to True, any calls to send() are noops. This value is reset to # false every time _send_request is called. This is to workaround the # fact that py2.6 (and only py2.6) has a separate send() call for the # body in _send_request, as opposed to endheaders(), which is where the # body is sent in all versions > 2.6. self._response_received = False self._expect_header_set = False def close(self): HTTPConnection.close(self) # Reset all of our instance state we were tracking. self._response_received = False self._expect_header_set = False self.response_class = self._original_response_cls def _tunnel(self): # Works around a bug in py26 which is fixed in later versions of # python. Bug involves hitting an infinite loop if readline() returns # nothing as opposed to just ``\r\n``. # As much as I don't like having if py2: code blocks, this seems # the cleanest way to handle this workaround. Fortunately, the # difference from py26 to py3 is very minimal. We're essentially # just overriding the while loop. if sys.version_info[:2] != (2, 6): return HTTPConnection._tunnel(self) # Otherwise we workaround the issue. self._set_hostport(self._tunnel_host, self._tunnel_port) self.send("CONNECT %s:%d HTTP/1.0\r\n" % (self.host, self.port)) for header, value in self._tunnel_headers.iteritems(): self.send("%s: %s\r\n" % (header, value)) self.send("\r\n") response = self.response_class(self.sock, strict=self.strict, method=self._method) (version, code, message) = response._read_status() if code != 200: self.close() raise socket.error("Tunnel connection failed: %d %s" % (code, message.strip())) while True: line = response.fp.readline() if not line: break if line in (b'\r\n', b'\n', b''): break def _send_request(self, method, url, body, headers, *args, **kwargs): self._response_received = False if headers.get('Expect', b'') == b'100-continue': self._expect_header_set = True else: self._expect_header_set = False self.response_class = self._original_response_cls rval = HTTPConnection._send_request( self, method, url, body, headers, *args, **kwargs) self._expect_header_set = False return rval def _convert_to_bytes(self, mixed_buffer): # Take a list of mixed str/bytes and convert it # all into a single bytestring. # Any six.text_types will be encoded as utf-8. bytes_buffer = [] for chunk in mixed_buffer: if isinstance(chunk, six.text_type): bytes_buffer.append(chunk.encode('utf-8')) else: bytes_buffer.append(chunk) msg = b"\r\n".join(bytes_buffer) return msg def _send_output(self, message_body=None, *args, **kwargs): self._buffer.extend((b"", b"")) msg = self._convert_to_bytes(self._buffer) del self._buffer[:] # If msg and message_body are sent in a single send() call, # it will avoid performance problems caused by the interaction # between delayed ack and the Nagle algorithm. if isinstance(message_body, bytes): msg += message_body message_body = None self.send(msg) if self._expect_header_set: # This is our custom behavior. If the Expect header was # set, it will trigger this custom behavior. logger.debug("Waiting for 100 Continue response.") # Wait for 1 second for the server to send a response. read, write, exc = select.select([self.sock], [], [self.sock], 1) if read: self._handle_expect_response(message_body) return else: # From the RFC: # Because of the presence of older implementations, the # protocol allows ambiguous situations in which a client may # send "Expect: 100-continue" without receiving either a 417 # (Expectation Failed) status or a 100 (Continue) status. # Therefore, when a client sends this header field to an origin # server (possibly via a proxy) from which it has never seen a # 100 (Continue) status, the client SHOULD NOT wait for an # indefinite period before sending the request body. logger.debug("No response seen from server, continuing to " "send the response body.") if message_body is not None: # message_body was not a string (i.e. it is a file), and # we must run the risk of Nagle. self.send(message_body) def _consume_headers(self, fp): # Most servers (including S3) will just return # the CLRF after the 100 continue response. However, # some servers (I've specifically seen this for squid when # used as a straight HTTP proxy) will also inject a # Connection: keep-alive header. To account for this # we'll read until we read '\r\n', and ignore any headers # that come immediately after the 100 continue response. current = None while current != b'\r\n': current = fp.readline() def _handle_expect_response(self, message_body): # This is called when we sent the request headers containing # an Expect: 100-continue header and received a response. # We now need to figure out what to do. fp = self.sock.makefile('rb', 0) try: maybe_status_line = fp.readline() parts = maybe_status_line.split(None, 2) if self._is_100_continue_status(maybe_status_line): self._consume_headers(fp) logger.debug("100 Continue response seen, " "now sending request body.") self._send_message_body(message_body) elif len(parts) == 3 and parts[0].startswith(b'HTTP/'): # From the RFC: # Requirements for HTTP/1.1 origin servers: # # - Upon receiving a request which includes an Expect # request-header field with the "100-continue" # expectation, an origin server MUST either respond with # 100 (Continue) status and continue to read from the # input stream, or respond with a final status code. # # So if we don't get a 100 Continue response, then # whatever the server has sent back is the final response # and don't send the message_body. logger.debug("Received a non 100 Continue response " "from the server, NOT sending request body.") status_tuple = (parts[0].decode('ascii'), int(parts[1]), parts[2].decode('ascii')) response_class = functools.partial( AWSHTTPResponse, status_tuple=status_tuple) self.response_class = response_class self._response_received = True finally: fp.close() def _send_message_body(self, message_body): if message_body is not None: self.send(message_body) def send(self, str): if self._response_received: logger.debug("send() called, but reseponse already received. " "Not sending data.") return return HTTPConnection.send(self, str) def _is_100_continue_status(self, maybe_status_line): parts = maybe_status_line.split(None, 2) # Check for HTTP/ 100 Continue\r\n return ( len(parts) >= 3 and parts[0].startswith(b'HTTP/') and parts[1] == b'100') class AWSHTTPSConnection(VerifiedHTTPSConnection): pass # Now we need to set the methods we overrode from AWSHTTPConnection # onto AWSHTTPSConnection. This is just a shortcut to avoid # copy/pasting the same code into AWSHTTPSConnection. for name, function in AWSHTTPConnection.__dict__.items(): if inspect.isfunction(function): setattr(AWSHTTPSConnection, name, function) def prepare_request_dict(request_dict, endpoint_url, context=None, user_agent=None): """ This method prepares a request dict to be created into an AWSRequestObject. This prepares the request dict by adding the url and the user agent to the request dict. :type request_dict: dict :param request_dict: The request dict (created from the ``serialize`` module). :type user_agent: string :param user_agent: The user agent to use for this request. :type endpoint_url: string :param endpoint_url: The full endpoint url, which contains at least the scheme, the hostname, and optionally any path components. """ r = request_dict if user_agent is not None: headers = r['headers'] headers['User-Agent'] = user_agent url = _urljoin(endpoint_url, r['url_path']) if r['query_string']: encoded_query_string = percent_encode_sequence(r['query_string']) if '?' not in url: url += '?%s' % encoded_query_string else: url += '&%s' % encoded_query_string r['url'] = url r['context'] = context if context is None: r['context'] = {} def create_request_object(request_dict): """ This method takes a request dict and creates an AWSRequest object from it. :type request_dict: dict :param request_dict: The request dict (created from the ``prepare_request_dict`` method). :rtype: ``botocore.awsrequest.AWSRequest`` :return: An AWSRequest object based on the request_dict. """ r = request_dict request_object = AWSRequest( method=r['method'], url=r['url'], data=r['body'], headers=r['headers']) request_object.context.update(r['context']) return request_object def _urljoin(endpoint_url, url_path): p = urlsplit(endpoint_url) # - # scheme - p[0] # netloc - p[1] # path - p[2] # query - p[3] # fragment - p[4] if not url_path or url_path == '/': # If there's no path component, ensure the URL ends with # a '/' for backwards compatibility. if not p[2]: return endpoint_url + '/' return endpoint_url if p[2].endswith('/') and url_path.startswith('/'): new_path = p[2][:-1] + url_path else: new_path = p[2] + url_path reconstructed = urlunsplit((p[0], p[1], new_path, p[3], p[4])) return reconstructed 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 # This is a dictionary to hold information that is used when # processing the request. What is inside of ``context`` is open-ended. # For example, it may have a timestamp key that is used for holding # what the timestamp is when signing the request. Note that none # of the information that is inside of ``context`` is directly # sent over the wire; the information is only used to assist in # creating what is sent over the wire. self.context = {} 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) if isinstance(p.body, six.text_type): p.body = p.body.encode('utf-8') 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 \ self._looks_like_file(self.body): logger.debug("Redirect received, rewinding stream: %s", self.body) self.reset_stream() def _looks_like_file(self, body): return hasattr(body, 'read') and hasattr(body, 'seek') 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) def prepare_body(self, data, files, json=None): """Prepares the given HTTP body data.""" super(AWSPreparedRequest, self).prepare_body(data, files, json) # Calculate the Content-Length by trying to seek the file as # requests cannot determine content length for some seekable file-like # objects. if 'Content-Length' not in self.headers: if hasattr(data, 'seek') and hasattr(data, 'tell'): orig_pos = data.tell() data.seek(0, 2) end_file_pos = data.tell() self.headers['Content-Length'] = str(end_file_pos - orig_pos) data.seek(orig_pos) # If the Content-Length was added this way, a # Transfer-Encoding was added by requests because it did # not add a Content-Length header. However, the # Transfer-Encoding header is not supported for # AWS Services so remove it if it is added. if 'Transfer-Encoding' in self.headers: self.headers.pop('Transfer-Encoding') HTTPSConnectionPool.ConnectionCls = AWSHTTPSConnection HTTPConnectionPool.ConnectionCls = AWSHTTPConnection botocore-1.5.7/botocore/retryhandler.py0000666454262600001440000003302313042511306021277 0ustar pysdk-ciamazon00000000000000# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import random import functools import logging from binascii import crc32 from botocore.vendored.requests import ConnectionError, Timeout from botocore.vendored.requests.packages.urllib3.exceptions import ClosedPoolError from botocore.exceptions import ChecksumError, EndpointConnectionError 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, Timeout, EndpointConnectionError ], } 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: # explicitly set MaxAttemptsReached if response is not None and 'ResponseMetadata' in response[1]: response[1]['ResponseMetadata']['MaxAttemptsReached'] = True 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: actual_error_code = response[1].get('Error', {}).get('Code') if actual_error_code == self._error_code: 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-1.5.7/botocore/hooks.py0000666454262600001440000005054713042511306017731 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import copy import logging from collections import defaultdict, deque, namedtuple from botocore.compat import accepts_kwargs, six logger = logging.getLogger(__name__) _NodeList = namedtuple('NodeList', ['first', 'middle', 'last']) _FIRST = 0 _MIDDLE = 1 _LAST = 2 class NodeList(_NodeList): def __copy__(self): first_copy = copy.copy(self.first) middle_copy = copy.copy(self.middle) last_copy = copy.copy(self.last) copied = NodeList(first_copy, middle_copy, last_copy) return copied 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): """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)`` """ return [] def register(self, event_name, handler, unique_id=None, unique_id_uses_count=False): """Register an event handler for a given event. If a ``unique_id`` is given, the handler will not be registered if a handler with the ``unique_id`` has already been registered. Handlers are called in the order they have been registered. Note handlers can also be registered with ``register_first()`` and ``register_last()``. All handlers registered with ``register_first()`` are called before handlers registered with ``register()`` which are called before handlers registered with ``register_last()``. """ self._verify_and_register(event_name, handler, unique_id, register_method=self._register, unique_id_uses_count=unique_id_uses_count) def register_first(self, event_name, handler, unique_id=None, unique_id_uses_count=False): """Register an event handler to be called first for an event. All event handlers registered with ``register_first()`` will be called before handlers registered with ``register()`` and ``register_last()``. """ self._verify_and_register(event_name, handler, unique_id, register_method=self._register_first, unique_id_uses_count=unique_id_uses_count) def register_last(self, event_name, handler, unique_id=None, unique_id_uses_count=False): """Register an event handler to be called last for an event. All event handlers registered with ``register_last()`` will be called after handlers registered with ``register_first()`` and ``register()``. """ self._verify_and_register(event_name, handler, unique_id, register_method=self._register_last, unique_id_uses_count=unique_id_uses_count) def _verify_and_register(self, event_name, handler, unique_id, register_method, unique_id_uses_count): self._verify_is_callable(handler) self._verify_accept_kwargs(handler) register_method(event_name, handler, unique_id, unique_id_uses_count) def unregister(self, event_name, handler=None, unique_id=None, unique_id_uses_count=False): """Unregister an event handler for a given event. If no ``unique_id`` was given during registration, then the first instance of the event handler is removed (if the event handler has been registered multiple times). """ 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: if not accepts_kwargs(func): raise ValueError("Event handler %s must accept keyword " "arguments (**kwargs)" % func) except TypeError: return False 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_handlers = {} def _emit(self, event_name, kwargs, stop_on_response=False): """ Emit an event with optional keyword arguments. :type event_name: string :param event_name: Name of the event :type kwargs: dict :param kwargs: Arguments to be passed to the handler functions. :type stop_on_response: boolean :param stop_on_response: Whether to stop on the first non-None response. If False, then all handlers will be called. This is especially useful to handlers which mutate data and then want to stop propagation of the event. :rtype: list :return: List of (handler, response) tuples from all processed handlers. """ 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)) if stop_on_response and response is not None: return responses return responses def emit(self, event_name, **kwargs): """ Emit an event by name with arguments passed as keyword args. >>> responses = emitter.emit( ... 'my-event.service.operation', arg1='one', arg2='two') :rtype: list :return: List of (handler, response) tuples from all processed handlers. """ return self._emit(event_name, kwargs) def emit_until_response(self, event_name, **kwargs): """ Emit an event by name with arguments passed as keyword args, until the first non-``None`` response is received. This method prevents subsequent handlers from being invoked. >>> handler, response = emitter.emit_until_response( 'my-event.service.operation', arg1='one', arg2='two') :rtype: tuple :return: The first (handler, response) tuple where the response is not ``None``, otherwise (``None``, ``None``). """ responses = self._emit(event_name, kwargs, stop_on_response=True) if responses: return responses[-1] else: return (None, None) def _register(self, event_name, handler, unique_id=None, unique_id_uses_count=False): self._register_section(event_name, handler, unique_id, unique_id_uses_count, section=_MIDDLE) def _register_first(self, event_name, handler, unique_id=None, unique_id_uses_count=False): self._register_section(event_name, handler, unique_id, unique_id_uses_count, section=_FIRST) def _register_last(self, event_name, handler, unique_id, unique_id_uses_count=False): self._register_section(event_name, handler, unique_id, unique_id_uses_count, section=_LAST) def _register_section(self, event_name, handler, unique_id, unique_id_uses_count, section): if unique_id is not None: if unique_id in self._unique_id_handlers: # We've already registered a handler using this unique_id # so we don't need to register it again. count = self._unique_id_handlers[unique_id].get('count', None) if unique_id_uses_count: if not count: raise ValueError( "Initial registration of unique id %s was " "specified to use a counter. Subsequent register " "calls to unique id must specify use of a counter " "as well." % unique_id) else: self._unique_id_handlers[unique_id]['count'] += 1 else: if count: raise ValueError( "Initial registration of unique id %s was " "specified to not use a counter. Subsequent " "register calls to unique id must specify not to " "use a counter as well." % unique_id) return else: # Note that the trie knows nothing about the unique # id. We track uniqueness in this class via the # _unique_id_handlers. self._handlers.append_item(event_name, handler, section=section) unique_id_handler_item = {'handler': handler} if unique_id_uses_count: unique_id_handler_item['count'] = 1 self._unique_id_handlers[unique_id] = unique_id_handler_item else: self._handlers.append_item(event_name, handler, section=section) # 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, unique_id_uses_count=False): if unique_id is not None: try: count = self._unique_id_handlers[unique_id].get('count', None) except KeyError: # There's no handler matching that unique_id so we have # nothing to unregister. return if unique_id_uses_count: if count is None: raise ValueError( "Initial registration of unique id %s was specified to " "use a counter. Subsequent unregister calls to unique " "id must specify use of a counter as well." % unique_id) elif count == 1: handler = self._unique_id_handlers.pop(unique_id)['handler'] else: self._unique_id_handlers[unique_id]['count'] -= 1 return else: if count: raise ValueError( "Initial registration of unique id %s was specified " "to not use a counter. Subsequent unregister calls " "to unique id must specify not to use a counter as " "well." % unique_id) handler = self._unique_id_handlers.pop(unique_id)['handler'] try: self._handlers.remove_item(event_name, handler) self._lookup_cache = {} except ValueError: pass def __copy__(self): new_instance = self.__class__() new_state = self.__dict__.copy() new_state['_handlers'] = copy.copy(self._handlers) new_state['_unique_id_handlers'] = copy.copy(self._unique_id_handlers) new_instance.__dict__ = new_state return new_instance 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, section=_MIDDLE): """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'] = NodeList([], [], []) current['values'][section].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']: # 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. extendleft() also adds its items # in right-left order so .extendleft([1, 2, 3]) # will result in final_list = [3, 2, 1], which is # why we reverse the lists. node_list = current_node['values'] complete_order = (node_list.first + node_list.middle + node_list.last) collected.extendleft(reversed(complete_order)) 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: node_list = next_node['values'] if value in node_list.first: node_list.first.remove(value) elif value in node_list.middle: node_list.middle.remove(value) elif value in node_list.last: node_list.last.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)) def __copy__(self): # The fact that we're using a nested dict under the covers # is an implementation detail, and the user shouldn't have # to know that they'd normally need a deepcopy so we expose # __copy__ instead of __deepcopy__. new_copy = self.__class__() copied_attrs = self._recursive_copy(self.__dict__) new_copy.__dict__ = copied_attrs return new_copy def _recursive_copy(self, node): # We can't use copy.deepcopy because we actually only want to copy # the structure of the trie, not the handlers themselves. # Each node has a chunk, children, and values. copied_node = {} for key, value in node.items(): if isinstance(value, NodeList): copied_node[key] = copy.copy(value) elif isinstance(value, dict): copied_node[key] = self._recursive_copy(value) else: copied_node[key] = value return copied_node botocore-1.5.7/botocore/waiter.py0000666454262600001440000002776513042511306020107 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import jmespath import logging import time from botocore.utils import get_service_module_name from botocore.docs.docstring import WaiterDocstring from .exceptions import WaiterError, ClientError, WaiterConfigError from . import xform_name logger = logging.getLogger(__name__) def create_waiter_with_client(waiter_name, waiter_model, client): """ :type waiter_name: str :param waiter_name: The name of the waiter. The name should match the name (including the casing) of the key name in the waiter model file (typically this is CamelCasing). :type waiter_model: botocore.waiter.WaiterModel :param waiter_model: The model for the waiter configuration. :type client: botocore.client.BaseClient :param client: The botocore client associated with the service. :rtype: botocore.waiter.Waiter :return: The waiter object. """ single_waiter_config = waiter_model.get_waiter(waiter_name) operation_name = xform_name(single_waiter_config.operation) operation_method = NormalizedOperationMethod( getattr(client, operation_name)) # Create a new wait method that will serve as a proxy to the underlying # Waiter.wait method. This is needed to attach a docstring to the # method. def wait(self, **kwargs): Waiter.wait(self, **kwargs) wait.__doc__ = WaiterDocstring( waiter_name=waiter_name, event_emitter=client.meta.events, service_model=client.meta.service_model, service_waiter_model=waiter_model, include_signature=False ) # Rename the waiter class based on the type of waiter. waiter_class_name = str('%s.Waiter.%s' % ( get_service_module_name(client.meta.service_model), waiter_name)) # Create the new waiter class documented_waiter_cls = type( waiter_class_name, (Waiter,), {'wait': wait}) # Return an instance of the new waiter class. return documented_waiter_cls( waiter_name, single_waiter_config, operation_method ) class NormalizedOperationMethod(object): def __init__(self, client_method): self._client_method = client_method def __call__(self, **kwargs): try: return self._client_method(**kwargs) except ClientError as e: return e.response class WaiterModel(object): SUPPORTED_VERSION = 2 def __init__(self, waiter_config): """ Note that the WaiterModel takes ownership of the waiter_config. It may or may not mutate the waiter_config. If this is a concern, it is best to make a copy of the waiter config before passing it to the WaiterModel. :type waiter_config: dict :param waiter_config: The loaded waiter config from the *.waiters.json file. This can be obtained from a botocore Loader object as well. """ self._waiter_config = waiter_config['waiters'] # These are part of the public API. Changing these # will result in having to update the consuming code, # so don't change unless you really need to. version = waiter_config.get('version', 'unknown') self._verify_supported_version(version) self.version = version self.waiter_names = list(sorted(waiter_config['waiters'].keys())) def _verify_supported_version(self, version): if version != self.SUPPORTED_VERSION: raise WaiterConfigError( error_msg=("Unsupported waiter version, supported version " "must be: %s, but version of waiter config " "is: %s" % (self.SUPPORTED_VERSION, version))) def get_waiter(self, waiter_name): try: single_waiter_config = self._waiter_config[waiter_name] except KeyError: raise ValueError("Waiter does not exist: %s" % waiter_name) return SingleWaiterConfig(single_waiter_config) class SingleWaiterConfig(object): """Represents the waiter configuration for a single waiter. A single waiter is considered the configuration for a single value associated with a named waiter (i.e TableExists). """ def __init__(self, single_waiter_config): self._config = single_waiter_config # These attributes are part of the public API. self.description = single_waiter_config.get('description', '') # Per the spec, these three fields are required. self.operation = single_waiter_config['operation'] self.delay = single_waiter_config['delay'] self.max_attempts = single_waiter_config['maxAttempts'] @property def acceptors(self): acceptors = [] for acceptor_config in self._config['acceptors']: acceptor = AcceptorConfig(acceptor_config) acceptors.append(acceptor) return acceptors class AcceptorConfig(object): def __init__(self, config): self.state = config['state'] self.matcher = config['matcher'] self.expected = config['expected'] self.argument = config.get('argument') self.matcher_func = self._create_matcher_func() def _create_matcher_func(self): # An acceptor function is a callable that takes a single value. The # parsed AWS response. Note that the parsed error response is also # provided in the case of errors, so it's entirely possible to # handle all the available matcher capabilities in the future. # There's only three supported matchers, so for now, this is all # contained to a single method. If this grows, we can expand this # out to separate methods or even objects. if self.matcher == 'path': return self._create_path_matcher() elif self.matcher == 'pathAll': return self._create_path_all_matcher() elif self.matcher == 'pathAny': return self._create_path_any_matcher() elif self.matcher == 'status': return self._create_status_matcher() elif self.matcher == 'error': return self._create_error_matcher() else: raise WaiterConfigError( error_msg="Unknown acceptor: %s" % self.matcher) def _create_path_matcher(self): expression = jmespath.compile(self.argument) expected = self.expected def acceptor_matches(response): if 'Error' in response: return return expression.search(response) == expected return acceptor_matches def _create_path_all_matcher(self): expression = jmespath.compile(self.argument) expected = self.expected def acceptor_matches(response): if 'Error' in response: return result = expression.search(response) if not isinstance(result, list) or not result: # pathAll matcher must result in a list. # Also we require at least one element in the list, # that is, an empty list should not result in this # acceptor match. return False for element in result: if element != expected: return False return True return acceptor_matches def _create_path_any_matcher(self): expression = jmespath.compile(self.argument) expected = self.expected def acceptor_matches(response): if 'Error' in response: return result = expression.search(response) if not isinstance(result, list) or not result: # pathAny matcher must result in a list. # Also we require at least one element in the list, # that is, an empty list should not result in this # acceptor match. return False for element in result: if element == expected: return True return False return acceptor_matches def _create_status_matcher(self): expected = self.expected def acceptor_matches(response): # We don't have any requirements on the expected incoming data # other than it is a dict, so we don't assume there's # a ResponseMetadata.HTTPStatusCode. status_code = response.get('ResponseMetadata', {}).get( 'HTTPStatusCode') return status_code == expected return acceptor_matches def _create_error_matcher(self): expected = self.expected def acceptor_matches(response): # When the client encounters an error, it will normally raise # an exception. However, the waiter implementation will catch # this exception, and instead send us the parsed error # response. So response is still a dictionary, and in the case # of an error response will contain the "Error" and # "ResponseMetadata" key. return response.get("Error", {}).get("Code", "") == expected return acceptor_matches class Waiter(object): def __init__(self, name, config, operation_method): """ :type name: string :param name: The name of the waiter :type config: botocore.waiter.SingleWaiterConfig :param config: The configuration for the waiter. :type operation_method: callable :param operation_method: A callable that accepts **kwargs and returns a response. For example, this can be a method from a botocore client. """ self._operation_method = operation_method # The two attributes are exposed to allow for introspection # and documentation. self.name = name self.config = config def wait(self, **kwargs): acceptors = list(self.config.acceptors) current_state = 'waiting' sleep_amount = self.config.delay num_attempts = 0 max_attempts = self.config.max_attempts while True: response = self._operation_method(**kwargs) num_attempts += 1 for acceptor in acceptors: if acceptor.matcher_func(response): current_state = acceptor.state break else: # If none of the acceptors matched, we should # transition to the failure state if an error # response was received. if 'Error' in response: # Transition to a failure state, which we # can just handle here by raising an exception. raise WaiterError( name=self.name, reason=response['Error'].get('Message', 'Unknown'), last_response=response ) if current_state == 'success': logger.debug("Waiting complete, waiter matched the " "success state.") return if current_state == 'failure': raise WaiterError( name=self.name, reason='Waiter encountered a terminal failure state', last_response=response, ) if num_attempts >= max_attempts: raise WaiterError( name=self.name, reason='Max attempts exceeded', last_response=response ) time.sleep(sleep_amount) botocore-1.5.7/botocore/credentials.py0000666454262600001440000012263613042511307021103 0ustar pysdk-ciamazon00000000000000# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import time import datetime import logging import os import getpass import threading from collections import namedtuple from dateutil.parser import parse from dateutil.tz import tzlocal import botocore.configloader import botocore.compat from botocore.compat import total_seconds from botocore.exceptions import UnknownCredentialError from botocore.exceptions import PartialCredentialsError from botocore.exceptions import ConfigNotFound from botocore.exceptions import InvalidConfigError from botocore.exceptions import RefreshWithMFAUnsupportedError from botocore.exceptions import MetadataRetrievalError from botocore.exceptions import CredentialRetrievalError from botocore.utils import InstanceMetadataFetcher, parse_key_val_file from botocore.utils import ContainerMetadataFetcher logger = logging.getLogger(__name__) ReadOnlyCredentials = namedtuple('ReadOnlyCredentials', ['access_key', 'secret_key', 'token']) def create_credential_resolver(session): """Create a default credential resolver. This creates a pre-configured credential resolver that includes the default lookup chain for credentials. """ profile_name = session.get_config_variable('profile') or 'default' credential_file = session.get_config_variable('credentials_file') config_file = session.get_config_variable('config_file') metadata_timeout = session.get_config_variable('metadata_service_timeout') num_attempts = session.get_config_variable('metadata_service_num_attempts') env_provider = EnvProvider() providers = [ env_provider, AssumeRoleProvider( load_config=lambda: session.full_config, client_creator=session.create_client, cache={}, profile_name=profile_name, ), SharedCredentialProvider( creds_filename=credential_file, profile_name=profile_name ), # The new config file has precedence over the legacy # config file. ConfigProvider(config_filename=config_file, profile_name=profile_name), OriginalEC2Provider(), BotoProvider(), ContainerProvider(), InstanceMetadataProvider( iam_role_fetcher=InstanceMetadataFetcher( timeout=metadata_timeout, num_attempts=num_attempts) ) ] explicit_profile = session.get_config_variable('profile', methods=('instance',)) if explicit_profile is not None: # An explicitly provided profile will negate an EnvProvider. # We will defer to providers that understand the "profile" # concept to retrieve credentials. # The one edge case if is all three values are provided via # env vars: # export AWS_ACCESS_KEY_ID=foo # export AWS_SECRET_ACCESS_KEY=bar # export AWS_PROFILE=baz # Then, just like our client() calls, the explicit credentials # will take precedence. # # This precedence is enforced by leaving the EnvProvider in the chain. # This means that the only way a "profile" would win is if the # EnvProvider does not return credentials, which is what we want # in this scenario. providers.remove(env_provider) logger.debug('Skipping environment variable credential check' ' because profile name was explicitly set.') resolver = CredentialResolver(providers=providers) return resolver def get_credentials(session): resolver = create_credential_resolver(session) return resolver.load_credentials() def _local_now(): return datetime.datetime.now(tzlocal()) def _parse_if_needed(value): if isinstance(value, datetime.datetime): return value return parse(value) def _serialize_if_needed(value): if isinstance(value, datetime.datetime): return value.strftime('%Y-%m-%dT%H:%M:%S%Z') return value def create_assume_role_refresher(client, params): def refresh(): response = client.assume_role(**params) credentials = response['Credentials'] # We need to normalize the credential names to # the values expected by the refresh creds. return { 'access_key': credentials['AccessKeyId'], 'secret_key': credentials['SecretAccessKey'], 'token': credentials['SessionToken'], 'expiry_time': _serialize_if_needed(credentials['Expiration']), } return refresh def create_mfa_serial_refresher(): def _refresher(): # We can explore an option in the future to support # reprompting for MFA, but for now we just error out # when the temp creds expire. raise RefreshWithMFAUnsupportedError() return _refresher class Credentials(object): """ Holds the credentials needed to authenticate requests. :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. """ def __init__(self, access_key, secret_key, token=None, method=None): self.access_key = access_key self.secret_key = secret_key self.token = token if method is None: method = 'explicit' self.method = method self._normalize() def _normalize(self): # Keys would sometimes (accidentally) contain non-ascii characters. # It would cause a confusing UnicodeDecodeError in Python 2. # We explicitly convert them into unicode to avoid such error. # # Eventually the service will decide whether to accept the credential. # This also complies with the behavior in Python 3. self.access_key = botocore.compat.ensure_unicode(self.access_key) self.secret_key = botocore.compat.ensure_unicode(self.secret_key) def get_frozen_credentials(self): return ReadOnlyCredentials(self.access_key, self.secret_key, self.token) class RefreshableCredentials(Credentials): """ Holds the credentials needed to authenticate requests. In addition, it knows how to refresh itself. :ivar refresh_timeout: How long a given set of credentials are valid for. Useful for credentials fetched over the network. :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. """ # The time at which we'll attempt to refresh, but not # block if someone else is refreshing. _advisory_refresh_timeout = 15 * 60 # The time at which all threads will block waiting for # refreshed credentials. _mandatory_refresh_timeout = 10 * 60 def __init__(self, access_key, secret_key, token, expiry_time, refresh_using, method, time_fetcher=_local_now): self._refresh_using = refresh_using self._access_key = access_key self._secret_key = secret_key self._token = token self._expiry_time = expiry_time self._time_fetcher = time_fetcher self._refresh_lock = threading.Lock() self.method = method self._frozen_credentials = ReadOnlyCredentials( access_key, secret_key, token) self._normalize() def _normalize(self): self._access_key = botocore.compat.ensure_unicode(self._access_key) self._secret_key = botocore.compat.ensure_unicode(self._secret_key) @classmethod def create_from_metadata(cls, metadata, refresh_using, method): instance = cls( access_key=metadata['access_key'], secret_key=metadata['secret_key'], token=metadata['token'], expiry_time=cls._expiry_datetime(metadata['expiry_time']), method=method, refresh_using=refresh_using ) return instance @property def access_key(self): """Warning: Using this property can lead to race conditions if you access another property subsequently along the refresh boundary. Please use get_frozen_credentials instead. """ self._refresh() return self._access_key @access_key.setter def access_key(self, value): self._access_key = value @property def secret_key(self): """Warning: Using this property can lead to race conditions if you access another property subsequently along the refresh boundary. Please use get_frozen_credentials instead. """ self._refresh() return self._secret_key @secret_key.setter def secret_key(self, value): self._secret_key = value @property def token(self): """Warning: Using this property can lead to race conditions if you access another property subsequently along the refresh boundary. Please use get_frozen_credentials instead. """ self._refresh() return self._token @token.setter def token(self, value): self._token = value def _seconds_remaining(self): delta = self._expiry_time - self._time_fetcher() return total_seconds(delta) def refresh_needed(self, refresh_in=None): """Check if a refresh is needed. A refresh is needed if the expiry time associated with the temporary credentials is less than the provided ``refresh_in``. If ``time_delta`` is not provided, ``self.advisory_refresh_needed`` will be used. For example, if your temporary credentials expire in 10 minutes and the provided ``refresh_in`` is ``15 * 60``, then this function will return ``True``. :type refresh_in: int :param refresh_in: The number of seconds before the credentials expire in which refresh attempts should be made. :return: True if refresh neeeded, False otherwise. """ if self._expiry_time is None: # No expiration, so assume we don't need to refresh. return False if refresh_in is None: refresh_in = self._advisory_refresh_timeout # The credentials should be refreshed if they're going to expire # in less than 5 minutes. if self._seconds_remaining() >= refresh_in: # There's enough time left. Don't refresh. return False logger.debug("Credentials need to be refreshed.") return True def _is_expired(self): # Checks if the current credentials are expired. return self.refresh_needed(refresh_in=0) def _refresh(self): # In the common case where we don't need a refresh, we # can immediately exit and not require acquiring the # refresh lock. if not self.refresh_needed(self._advisory_refresh_timeout): return # acquire() doesn't accept kwargs, but False is indicating # that we should not block if we can't acquire the lock. # If we aren't able to acquire the lock, we'll trigger # the else clause. if self._refresh_lock.acquire(False): try: if not self.refresh_needed(self._advisory_refresh_timeout): return is_mandatory_refresh = self.refresh_needed( self._mandatory_refresh_timeout) self._protected_refresh(is_mandatory=is_mandatory_refresh) return finally: self._refresh_lock.release() elif self.refresh_needed(self._mandatory_refresh_timeout): # If we're within the mandatory refresh window, # we must block until we get refreshed credentials. with self._refresh_lock: if not self.refresh_needed(self._mandatory_refresh_timeout): return self._protected_refresh(is_mandatory=True) def _protected_refresh(self, is_mandatory): # precondition: this method should only be called if you've acquired # the self._refresh_lock. try: metadata = self._refresh_using() except Exception as e: period_name = 'mandatory' if is_mandatory else 'advisory' logger.warning("Refreshing temporary credentials failed " "during %s refresh period.", period_name, exc_info=True) if is_mandatory: # If this is a mandatory refresh, then # all errors that occur when we attempt to refresh # credentials are propagated back to the user. raise # Otherwise we'll just return. # The end result will be that we'll use the current # set of temporary credentials we have. return self._set_from_data(metadata) if self._is_expired(): # We successfully refreshed credentials but for whatever # reason, our refreshing function returned credentials # that are still expired. In this scenario, the only # thing we can do is let the user know and raise # an exception. msg = ("Credentials were refreshed, but the " "refreshed credentials are still expired.") logger.warning(msg) raise RuntimeError(msg) self._frozen_credentials = ReadOnlyCredentials( self._access_key, self._secret_key, self._token) @staticmethod def _expiry_datetime(time_str): return parse(time_str) def _set_from_data(self, data): self.access_key = data['access_key'] self.secret_key = data['secret_key'] self.token = data['token'] self._expiry_time = parse(data['expiry_time']) logger.debug("Retrieved credentials will expire at: %s", self._expiry_time) self._normalize() def get_frozen_credentials(self): """Return immutable credentials. The ``access_key``, ``secret_key``, and ``token`` properties on this class will always check and refresh credentials if needed before returning the particular credentials. This has an edge case where you can get inconsistent credentials. Imagine this: # Current creds are "t1" tmp.access_key ---> expired? no, so return t1.access_key # ---- time is now expired, creds need refreshing to "t2" ---- tmp.secret_key ---> expired? yes, refresh and return t2.secret_key This means we're using the access key from t1 with the secret key from t2. To fix this issue, you can request a frozen credential object which is guaranteed not to change. The frozen credentials returned from this method should be used immediately and then discarded. The typical usage pattern would be:: creds = RefreshableCredentials(...) some_code = SomeSignerObject() # I'm about to sign the request. # The frozen credentials are only used for the # duration of generate_presigned_url and will be # immediately thrown away. request = some_code.sign_some_request( with_credentials=creds.get_frozen_credentials()) print("Signed request:", request) """ self._refresh() return self._frozen_credentials class CredentialProvider(object): # Implementations must provide a method. METHOD = None def __init__(self, session=None): self.session = session def load(self): """ Loads the credentials from their source & sets them on the object. Subclasses should implement this method (by reading from disk, the environment, the network or wherever), returning ``True`` if they were found & loaded. If not found, this method should return ``False``, indictating that the ``CredentialResolver`` should fall back to the next available method. The default implementation does nothing, assuming the user has set the ``access_key/secret_key/token`` themselves. :returns: Whether credentials were found & set :rtype: boolean """ return True def _extract_creds_from_mapping(self, mapping, *key_names): found = [] for key_name in key_names: try: found.append(mapping[key_name]) except KeyError: raise PartialCredentialsError(provider=self.METHOD, cred_var=key_name) return found class InstanceMetadataProvider(CredentialProvider): METHOD = 'iam-role' def __init__(self, iam_role_fetcher): self._role_fetcher = iam_role_fetcher def load(self): fetcher = self._role_fetcher # We do the first request, to see if we get useful data back. # If not, we'll pass & move on to whatever's next in the credential # chain. metadata = fetcher.retrieve_iam_role_credentials() if not metadata: return None logger.debug('Found credentials from IAM Role: %s', metadata['role_name']) # We manually set the data here, since we already made the request & # have it. When the expiry is hit, the credentials will auto-refresh # themselves. creds = RefreshableCredentials.create_from_metadata( metadata, method=self.METHOD, refresh_using=fetcher.retrieve_iam_role_credentials, ) return creds class EnvProvider(CredentialProvider): METHOD = 'env' ACCESS_KEY = 'AWS_ACCESS_KEY_ID' SECRET_KEY = 'AWS_SECRET_ACCESS_KEY' # The token can come from either of these env var. # AWS_SESSION_TOKEN is what other AWS SDKs have standardized on. TOKENS = ['AWS_SECURITY_TOKEN', 'AWS_SESSION_TOKEN'] def __init__(self, environ=None, mapping=None): """ :param environ: The environment variables (defaults to ``os.environ`` if no value is provided). :param mapping: An optional mapping of variable names to environment variable names. Use this if you want to change the mapping of access_key->AWS_ACCESS_KEY_ID, etc. The dict can have up to 3 keys: ``access_key``, ``secret_key``, ``session_token``. """ if environ is None: environ = os.environ self.environ = environ self._mapping = self._build_mapping(mapping) def _build_mapping(self, mapping): # Mapping of variable name to env var name. var_mapping = {} if mapping is None: # Use the class var default. var_mapping['access_key'] = self.ACCESS_KEY var_mapping['secret_key'] = self.SECRET_KEY var_mapping['token'] = self.TOKENS else: var_mapping['access_key'] = mapping.get( 'access_key', self.ACCESS_KEY) var_mapping['secret_key'] = mapping.get( 'secret_key', self.SECRET_KEY) var_mapping['token'] = mapping.get( 'token', self.TOKENS) if not isinstance(var_mapping['token'], list): var_mapping['token'] = [var_mapping['token']] return var_mapping def load(self): """ Search for credentials in explicit environment variables. """ if self._mapping['access_key'] in self.environ: logger.info('Found credentials in environment variables.') access_key, secret_key = self._extract_creds_from_mapping( self.environ, self._mapping['access_key'], self._mapping['secret_key']) token = self._get_session_token() return Credentials(access_key, secret_key, token, method=self.METHOD) else: return None def _get_session_token(self): for token_envvar in self._mapping['token']: if token_envvar in self.environ: return self.environ[token_envvar] class OriginalEC2Provider(CredentialProvider): METHOD = 'ec2-credentials-file' CRED_FILE_ENV = 'AWS_CREDENTIAL_FILE' ACCESS_KEY = 'AWSAccessKeyId' SECRET_KEY = 'AWSSecretKey' def __init__(self, environ=None, parser=None): if environ is None: environ = os.environ if parser is None: parser = parse_key_val_file self._environ = environ self._parser = parser def load(self): """ Search for a credential file used by original EC2 CLI tools. """ if 'AWS_CREDENTIAL_FILE' in self._environ: full_path = os.path.expanduser(self._environ['AWS_CREDENTIAL_FILE']) creds = self._parser(full_path) if self.ACCESS_KEY in creds: logger.info('Found credentials in AWS_CREDENTIAL_FILE.') access_key = creds[self.ACCESS_KEY] secret_key = creds[self.SECRET_KEY] # EC2 creds file doesn't support session tokens. return Credentials(access_key, secret_key, method=self.METHOD) else: return None class SharedCredentialProvider(CredentialProvider): METHOD = 'shared-credentials-file' ACCESS_KEY = 'aws_access_key_id' SECRET_KEY = 'aws_secret_access_key' # Same deal as the EnvProvider above. Botocore originally supported # aws_security_token, but the SDKs are standardizing on aws_session_token # so we support both. TOKENS = ['aws_security_token', 'aws_session_token'] def __init__(self, creds_filename, profile_name=None, ini_parser=None): self._creds_filename = creds_filename if profile_name is None: profile_name = 'default' self._profile_name = profile_name if ini_parser is None: ini_parser = botocore.configloader.raw_config_parse self._ini_parser = ini_parser def load(self): try: available_creds = self._ini_parser(self._creds_filename) except ConfigNotFound: return None if self._profile_name in available_creds: config = available_creds[self._profile_name] if self.ACCESS_KEY in config: logger.info("Found credentials in shared credentials file: %s", self._creds_filename) access_key, secret_key = self._extract_creds_from_mapping( config, self.ACCESS_KEY, self.SECRET_KEY) token = self._get_session_token(config) return Credentials(access_key, secret_key, token, method=self.METHOD) def _get_session_token(self, config): for token_envvar in self.TOKENS: if token_envvar in config: return config[token_envvar] class ConfigProvider(CredentialProvider): """INI based config provider with profile sections.""" METHOD = 'config-file' ACCESS_KEY = 'aws_access_key_id' SECRET_KEY = 'aws_secret_access_key' # Same deal as the EnvProvider above. Botocore originally supported # aws_security_token, but the SDKs are standardizing on aws_session_token # so we support both. TOKENS = ['aws_security_token', 'aws_session_token'] def __init__(self, config_filename, profile_name, config_parser=None): """ :param config_filename: The session configuration scoped to the current profile. This is available via ``session.config``. :param profile_name: The name of the current profile. :param config_parser: A config parser callable. """ self._config_filename = config_filename self._profile_name = profile_name if config_parser is None: config_parser = botocore.configloader.load_config self._config_parser = config_parser def load(self): """ If there is are credentials in the configuration associated with the session, use those. """ try: full_config = self._config_parser(self._config_filename) except ConfigNotFound: return None if self._profile_name in full_config['profiles']: profile_config = full_config['profiles'][self._profile_name] if self.ACCESS_KEY in profile_config: logger.info("Credentials found in config file: %s", self._config_filename) access_key, secret_key = self._extract_creds_from_mapping( profile_config, self.ACCESS_KEY, self.SECRET_KEY) token = self._get_session_token(profile_config) return Credentials(access_key, secret_key, token, method=self.METHOD) else: return None def _get_session_token(self, profile_config): for token_name in self.TOKENS: if token_name in profile_config: return profile_config[token_name] class BotoProvider(CredentialProvider): METHOD = 'boto-config' BOTO_CONFIG_ENV = 'BOTO_CONFIG' DEFAULT_CONFIG_FILENAMES = ['/etc/boto.cfg', '~/.boto'] ACCESS_KEY = 'aws_access_key_id' SECRET_KEY = 'aws_secret_access_key' def __init__(self, environ=None, ini_parser=None): if environ is None: environ = os.environ if ini_parser is None: ini_parser = botocore.configloader.raw_config_parse self._environ = environ self._ini_parser = ini_parser def load(self): """ Look for credentials in boto config file. """ if self.BOTO_CONFIG_ENV in self._environ: potential_locations = [self._environ[self.BOTO_CONFIG_ENV]] else: potential_locations = self.DEFAULT_CONFIG_FILENAMES for filename in potential_locations: try: config = self._ini_parser(filename) except ConfigNotFound: # Move on to the next potential config file name. continue if 'Credentials' in config: credentials = config['Credentials'] if self.ACCESS_KEY in credentials: logger.info("Found credentials in boto config file: %s", filename) access_key, secret_key = self._extract_creds_from_mapping( credentials, self.ACCESS_KEY, self.SECRET_KEY) return Credentials(access_key, secret_key, method=self.METHOD) class AssumeRoleProvider(CredentialProvider): METHOD = 'assume-role' ROLE_CONFIG_VAR = 'role_arn' # Credentials are considered expired (and will be refreshed) once the total # remaining time left until the credentials expires is less than the # EXPIRY_WINDOW. EXPIRY_WINDOW_SECONDS = 60 * 15 def __init__(self, load_config, client_creator, cache, profile_name, prompter=getpass.getpass): """ :type load_config: callable :param load_config: A function that accepts no arguments, and when called, will return the full configuration dictionary for the session (``session.full_config``). :type client_creator: callable :param client_creator: A factory function that will create a client when called. Has the same interface as ``botocore.session.Session.create_client``. :type cache: JSONFileCache :param cache: An object that supports ``__getitem__``, ``__setitem__``, and ``__contains__``. An example of this is the ``JSONFileCache`` class. :type profile_name: str :param profile_name: The name of the profile. :type prompter: callable :param prompter: A callable that returns input provided by the user (i.e raw_input, getpass.getpass, etc.). """ #: The cache used to first check for assumed credentials. #: This is checked before making the AssumeRole API #: calls and can be useful if you have short lived #: scripts and you'd like to avoid calling AssumeRole #: until the credentials are expired. self.cache = cache self._load_config = load_config # client_creator is a callable that creates function. # It's basically session.create_client self._client_creator = client_creator self._profile_name = profile_name self._prompter = prompter # The _loaded_config attribute will be populated from the # load_config() function once the configuration is actually # loaded. The reason we go through all this instead of just # requiring that the loaded_config be passed to us is to that # we can defer configuration loaded until we actually try # to load credentials (as opposed to when the object is # instantiated). self._loaded_config = {} def load(self): self._loaded_config = self._load_config() if self._has_assume_role_config_vars(): return self._load_creds_via_assume_role() def _has_assume_role_config_vars(self): profiles = self._loaded_config.get('profiles', {}) return self.ROLE_CONFIG_VAR in profiles.get(self._profile_name, {}) def _load_creds_via_assume_role(self): # We can get creds in one of two ways: # * It can either be cached on disk from an pre-existing session # * Cache doesn't have the creds (or is expired) so we need to make # an assume role call to get temporary creds, which we then cache # for subsequent requests. creds = self._load_creds_from_cache() if creds is not None: logger.debug("Credentials for role retrieved from cache.") return creds else: # We get the Credential used by botocore as well # as the original parsed response from the server. creds, response = self._retrieve_temp_credentials() cache_key = self._create_cache_key() self._write_cached_credentials(response, cache_key) return creds def _load_creds_from_cache(self): cache_key = self._create_cache_key() try: from_cache = self.cache[cache_key] if self._is_expired(from_cache): # Don't need to delete the cache entry, # when we refresh via AssumeRole, we'll # update the cache with the new entry. logger.debug( "Credentials were found in cache, but they are expired.") return None else: return self._create_creds_from_response(from_cache) except KeyError: return None def _is_expired(self, credentials): end_time = parse(credentials['Credentials']['Expiration']) now = datetime.datetime.now(tzlocal()) seconds = total_seconds(end_time - now) return seconds < self.EXPIRY_WINDOW_SECONDS def _create_cache_key(self): role_config = self._get_role_config_values() # On windows, ':' is not allowed in filenames, so we'll # replace them with '_' instead. role_arn = role_config['role_arn'].replace(':', '_') role_session_name = role_config.get('role_session_name') if role_session_name: cache_key = '%s--%s--%s' % (self._profile_name, role_arn, role_session_name) else: cache_key = '%s--%s' % (self._profile_name, role_arn) return cache_key.replace('/', '-') def _write_cached_credentials(self, creds, cache_key): self.cache[cache_key] = creds def _get_role_config_values(self): # This returns the role related configuration. profiles = self._loaded_config.get('profiles', {}) try: source_profile = profiles[self._profile_name]['source_profile'] role_arn = profiles[self._profile_name]['role_arn'] mfa_serial = profiles[self._profile_name].get('mfa_serial') except KeyError as e: raise PartialCredentialsError(provider=self.METHOD, cred_var=str(e)) external_id = profiles[self._profile_name].get('external_id') role_session_name = \ profiles[self._profile_name].get('role_session_name') if source_profile not in profiles: raise InvalidConfigError( error_msg=( 'The source_profile "%s" referenced in ' 'the profile "%s" does not exist.' % ( source_profile, self._profile_name))) source_cred_values = profiles[source_profile] return { 'role_arn': role_arn, 'external_id': external_id, 'source_profile': source_profile, 'mfa_serial': mfa_serial, 'source_cred_values': source_cred_values, 'role_session_name': role_session_name } def _create_creds_from_response(self, response): config = self._get_role_config_values() if config.get('mfa_serial') is not None: # MFA would require getting a new TokenCode which would require # prompting the user for a new token, so we use a different # refresh_func. refresh_func = create_mfa_serial_refresher() else: refresh_func = create_assume_role_refresher( self._create_client_from_config(config), self._assume_role_base_kwargs(config)) return RefreshableCredentials( access_key=response['Credentials']['AccessKeyId'], secret_key=response['Credentials']['SecretAccessKey'], token=response['Credentials']['SessionToken'], method=self.METHOD, expiry_time=_parse_if_needed( response['Credentials']['Expiration']), refresh_using=refresh_func) def _create_client_from_config(self, config): source_cred_values = config['source_cred_values'] client = self._client_creator( 'sts', aws_access_key_id=source_cred_values['aws_access_key_id'], aws_secret_access_key=source_cred_values['aws_secret_access_key'], aws_session_token=source_cred_values.get('aws_session_token'), ) return client def _retrieve_temp_credentials(self): logger.debug("Retrieving credentials via AssumeRole.") config = self._get_role_config_values() client = self._create_client_from_config(config) assume_role_kwargs = self._assume_role_base_kwargs(config) response = client.assume_role(**assume_role_kwargs) creds = self._create_creds_from_response(response) return creds, response def _assume_role_base_kwargs(self, config): assume_role_kwargs = {'RoleArn': config['role_arn']} if config['external_id'] is not None: assume_role_kwargs['ExternalId'] = config['external_id'] if config['mfa_serial'] is not None: token_code = self._prompter("Enter MFA code: ") assume_role_kwargs['SerialNumber'] = config['mfa_serial'] assume_role_kwargs['TokenCode'] = token_code if config['role_session_name'] is not None: assume_role_kwargs['RoleSessionName'] = config['role_session_name'] else: role_session_name = 'AWS-CLI-session-%s' % (int(time.time())) assume_role_kwargs['RoleSessionName'] = role_session_name return assume_role_kwargs class ContainerProvider(CredentialProvider): METHOD = 'container-role' ENV_VAR = 'AWS_CONTAINER_CREDENTIALS_RELATIVE_URI' def __init__(self, environ=None, fetcher=None): if environ is None: environ = os.environ if fetcher is None: fetcher = ContainerMetadataFetcher() self._environ = environ self._fetcher = fetcher def load(self): if self.ENV_VAR not in self._environ: # This cred provider is only triggered if the # self.ENV_VAR is set, which only happens if you opt # into this feature on ECS. return None return self._retrieve_or_fail(self._environ[self.ENV_VAR]) def _retrieve_or_fail(self, relative_uri): fetcher = self._create_fetcher(relative_uri) creds = fetcher() return RefreshableCredentials( access_key=creds['access_key'], secret_key=creds['secret_key'], token=creds['token'], method=self.METHOD, expiry_time=_parse_if_needed(creds['expiry_time']), refresh_using=fetcher, ) def _create_fetcher(self, relative_uri): def fetch_creds(): try: response = self._fetcher.retrieve_uri(relative_uri) except MetadataRetrievalError as e: logger.debug("Error retrieving ECS metadata: %s", e, exc_info=True) raise CredentialRetrievalError(provider=self.METHOD, error_msg=str(e)) return { 'access_key': response['AccessKeyId'], 'secret_key': response['SecretAccessKey'], 'token': response['Token'], 'expiry_time': response['Expiration'], } return fetch_creds class CredentialResolver(object): def __init__(self, providers): """ :param providers: A list of ``CredentialProvider`` instances. """ self.providers = providers def insert_before(self, name, credential_provider): """ Inserts a new instance of ``CredentialProvider`` into the chain that will be tried before an existing one. :param name: The short name of the credentials you'd like to insert the new credentials before. (ex. ``env`` or ``config``). Existing names & ordering can be discovered via ``self.available_methods``. :type name: string :param cred_instance: An instance of the new ``Credentials`` object you'd like to add to the chain. :type cred_instance: A subclass of ``Credentials`` """ try: offset = [p.METHOD for p in self.providers].index(name) except ValueError: raise UnknownCredentialError(name=name) self.providers.insert(offset, credential_provider) def insert_after(self, name, credential_provider): """ Inserts a new type of ``Credentials`` instance into the chain that will be tried after an existing one. :param name: The short name of the credentials you'd like to insert the new credentials after. (ex. ``env`` or ``config``). Existing names & ordering can be discovered via ``self.available_methods``. :type name: string :param cred_instance: An instance of the new ``Credentials`` object you'd like to add to the chain. :type cred_instance: A subclass of ``Credentials`` """ offset = self._get_provider_offset(name) self.providers.insert(offset + 1, credential_provider) def remove(self, name): """ Removes a given ``Credentials`` instance from the chain. :param name: The short name of the credentials instance to remove. :type name: string """ available_methods = [p.METHOD for p in self.providers] if name not in available_methods: # It's not present. Fail silently. return offset = available_methods.index(name) self.providers.pop(offset) def get_provider(self, name): """Return a credential provider by name. :type name: str :param name: The name of the provider. :raises UnknownCredentialError: Raised if no credential provider by the provided name is found. """ return self.providers[self._get_provider_offset(name)] def _get_provider_offset(self, name): try: return [p.METHOD for p in self.providers].index(name) except ValueError: raise UnknownCredentialError(name=name) def load_credentials(self): """ Goes through the credentials chain, returning the first ``Credentials`` that could be loaded. """ # First provider to return a non-None response wins. for provider in self.providers: logger.debug("Looking for credentials via: %s", provider.METHOD) creds = provider.load() if creds is not None: return creds # If we got here, no credentials could be found. # This feels like it should be an exception, but historically, ``None`` # is returned. # # +1 # -js return None botocore-1.5.7/botocore/exceptions.py0000666454262600001440000003123613042511306020761 0ustar pysdk-ciamazon00000000000000# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from __future__ import unicode_literals from botocore.vendored.requests.exceptions import ConnectionError class BotoCoreError(Exception): """ The base exception class for BotoCore exceptions. :ivar msg: The descriptive message associated with the error. """ fmt = 'An unspecified error occurred' 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 UnknownServiceError(DataNotFoundError): """Raised when trying to load data for an unknown service. :ivar service_name: The name of the unknown service. """ fmt = ( "Unknown service: '{service_name}'. Valid service names are: " "{known_service_names}") class ApiVersionNotFoundError(BotoCoreError): """ The data associated with either that API version or a compatible one could not be loaded. :ivar path: The data path that the user attempted to load. :ivar path: The API version that the user attempted to load. """ fmt = 'Unable to load data {data_path} for: {api_version}' class EndpointConnectionError(BotoCoreError): fmt = ( 'Could not connect to the endpoint URL: "{endpoint_url}"') class ConnectionClosedError(ConnectionError): fmt = ( 'Connection was closed before we received a valid response ' 'from endpoint URL: "{endpoint_url}".') def __init__(self, **kwargs): msg = self.fmt.format(**kwargs) kwargs.pop('endpoint_url') super(ConnectionClosedError, self).__init__(msg, **kwargs) class NoCredentialsError(BotoCoreError): """ No credentials could be found """ fmt = 'Unable to locate credentials' class PartialCredentialsError(BotoCoreError): """ Only partial credentials were found. :ivar cred_var: The missing credential variable name. """ fmt = 'Partial credentials found in {provider}, missing: {cred_var}' class CredentialRetrievalError(BotoCoreError): """ Error attempting to retrieve credentials from a remote source. :ivar provider: The name of the credential provider. :ivar error_msg: The msg explaning why credentials could not be retrieved. """ fmt = 'Error when retrieving credentials from {provider}: {error_msg}' 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 BaseEndpointResolverError(BotoCoreError): """Base error for endpoint resolving errors. Should never be raised directly, but clients can catch this exception if they want to generically handle any errors during the endpoint resolution process. """ class NoRegionError(BaseEndpointResolverError): """No region was specified.""" fmt = 'You must specify a region.' class UnknownEndpointError(BaseEndpointResolverError, ValueError): """ Could not construct an endpoint. :ivar service_name: The name of the service. :ivar region_name: The name of the region. """ fmt = ( 'Unable to construct an endpoint for ' '{service_name} 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} ") class ParamValidationError(BotoCoreError): fmt = 'Parameter validation failed:\n{report}' # 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 AliasConflictParameterError(ValidationError): """ Error when an alias is provided for a parameter as well as the original. :ivar original: The name of the original parameter. :ivar alias: The name of the alias :ivar operation: The name of the operation. """ fmt = ( "Parameter '{original}' and its alias '{alias}' were provided " "for operation {operation}. Only one of them may be used." ) 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 OperationNotPageableError(BotoCoreError): fmt = 'Operation cannot be paginated: {operation_name}' 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}' def __init__(self, name, reason, last_response): super(WaiterError, self).__init__(name=name, reason=reason) self.last_response = last_response class IncompleteReadError(BotoCoreError): """HTTP response did not return expected number of bytes.""" fmt = ('{actual_bytes} read, but total bytes ' 'expected is {expected_bytes}.') class InvalidExpressionError(BotoCoreError): """Expression is either invalid or too complex.""" fmt = 'Invalid expression {expression}: Only dotted lookups are supported.' class UnknownCredentialError(BotoCoreError): """Tried to insert before/after an unregistered credential type.""" fmt = 'Credential named {name} not found.' class WaiterConfigError(BotoCoreError): """Error when processing waiter configuration.""" fmt = 'Error processing waiter config: {error_msg}' class UnknownClientMethodError(BotoCoreError): """Error when trying to access a method on a client that does not exist.""" fmt = 'Client does not have method: {method_name}' class UnsupportedSignatureVersionError(BotoCoreError): """Error when trying to access a method on a client that does not exist.""" fmt = 'Signature version is not supported: {signature_version}' class ClientError(Exception): MSG_TEMPLATE = ( 'An error occurred ({error_code}) when calling the {operation_name} ' 'operation{retry_info}: {error_message}') def __init__(self, error_response, operation_name): retry_info = self._get_retry_info(error_response) msg = self.MSG_TEMPLATE.format( error_code=error_response['Error'].get('Code', 'Unknown'), error_message=error_response['Error'].get('Message', 'Unknown'), operation_name=operation_name, retry_info=retry_info, ) super(ClientError, self).__init__(msg) self.response = error_response self.operation_name = operation_name def _get_retry_info(self, response): retry_info = '' if 'ResponseMetadata' in response: metadata = response['ResponseMetadata'] if metadata.get('MaxAttemptsReached', False): if 'RetryAttempts' in metadata: retry_info = (' (reached max retries: %s)' % metadata['RetryAttempts']) return retry_info class UnsupportedTLSVersionWarning(Warning): """Warn when an openssl version that uses TLS 1.2 is required""" pass class ImminentRemovalWarning(Warning): pass class InvalidDNSNameError(BotoCoreError): """Error when virtual host path is forced on a non-DNS compatible bucket""" fmt = ( 'Bucket named {bucket_name} is not DNS compatible. Virtual ' 'hosted-style addressing cannot be used. The addressing style ' 'can be configured by removing the addressing_style value ' 'or setting that value to \'path\' or \'auto\' in the AWS Config ' 'file or in the botocore.client.Config object.' ) class InvalidS3AddressingStyleError(BotoCoreError): """Error when an invalid path style is specified""" fmt = ( 'S3 addressing style {s3_addressing_style} is invaild. Valid options ' 'are: \'auto\', \'virtual\', and \'path\'' ) class StubResponseError(BotoCoreError): fmt = 'Error getting response stub for operation {operation_name}: {reason}' class StubAssertionError(StubResponseError, AssertionError): fmt = 'Error getting response stub for operation {operation_name}: {reason}' class InvalidConfigError(BotoCoreError): fmt = '{error_msg}' class RefreshWithMFAUnsupportedError(BotoCoreError): fmt = 'Cannot refresh credentials: MFA token required.' class MD5UnavailableError(BotoCoreError): fmt = "This system does not support MD5 generation." class MetadataRetrievalError(BotoCoreError): fmt = "Error retrieving metadata: {error_msg}" botocore-1.5.7/botocore/endpoint.py0000666454262600001440000003074513042511306020424 0ustar pysdk-ciamazon00000000000000# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import os import logging import time import threading from botocore.vendored.requests.adapters import HTTPAdapter from botocore.vendored.requests.sessions import Session from botocore.vendored.requests.utils import get_environ_proxies from botocore.vendored.requests.exceptions import ConnectionError from botocore.vendored import six from botocore.awsrequest import create_request_object from botocore.exceptions import UnknownEndpointError from botocore.exceptions import EndpointConnectionError from botocore.exceptions import ConnectionClosedError from botocore.compat import filter_ssl_warnings from botocore.utils import is_valid_endpoint_url from botocore.hooks import first_non_none_response from botocore.response import StreamingBody from botocore import parsers logger = logging.getLogger(__name__) DEFAULT_TIMEOUT = 60 MAX_POOL_CONNECTIONS = 10 filter_ssl_warnings() try: from botocore.vendored.requests.packages.urllib3.contrib import pyopenssl pyopenssl.extract_from_urllib3() except ImportError: pass def convert_to_response_dict(http_response, operation_model): """Convert an HTTP response object to a request dict. This converts the requests library's HTTP response object to a dictionary. :type http_response: botocore.vendored.requests.model.Response :param http_response: The HTTP response from an AWS service request. :rtype: dict :return: A response dictionary which will contain the following keys: * headers (dict) * status_code (int) * body (string or file-like object) """ response_dict = { 'headers': http_response.headers, 'status_code': http_response.status_code, } if response_dict['status_code'] >= 300: response_dict['body'] = http_response.content elif operation_model.has_streaming_output: response_dict['body'] = StreamingBody( http_response.raw, response_dict['headers'].get('content-length')) else: response_dict['body'] = http_response.content return response_dict class BotocoreHTTPSession(Session): """Internal session class used to workaround requests behavior. This class is intended to be used only by the Endpoint class. """ def __init__(self, max_pool_connections=MAX_POOL_CONNECTIONS, http_adapter_cls=HTTPAdapter): super(BotocoreHTTPSession, self).__init__() # In order to support a user provided "max_pool_connections", we need # to recreate the HTTPAdapter and pass in our max_pool_connections # value. adapter = http_adapter_cls(pool_maxsize=max_pool_connections) # requests uses an HTTPAdapter for mounting both http:// and https:// self.mount('https://', adapter) self.mount('http://', adapter) def rebuild_auth(self, prepared_request, response): # Keep the existing auth information from the original prepared request. # Normally this method would be where auth is regenerated as needed. # By making this a noop, we're keeping the existing auth info. pass 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, host, endpoint_prefix, event_emitter, proxies=None, verify=True, timeout=DEFAULT_TIMEOUT, response_parser_factory=None, max_pool_connections=MAX_POOL_CONNECTIONS): self._endpoint_prefix = endpoint_prefix self._event_emitter = event_emitter self.host = host self.verify = verify if proxies is None: proxies = {} self.proxies = proxies self.http_session = BotocoreHTTPSession( max_pool_connections=max_pool_connections) self.timeout = timeout self.max_pool_connections = max_pool_connections logger.debug('Setting %s timeout as %s', endpoint_prefix, self.timeout) self._lock = threading.Lock() if response_parser_factory is None: response_parser_factory = parsers.ResponseParserFactory() self._response_parser_factory = response_parser_factory def __repr__(self): return '%s(%s)' % (self._endpoint_prefix, self.host) def make_request(self, operation_model, request_dict): logger.debug("Making request for %s (verify_ssl=%s) with params: %s", operation_model, self.verify, request_dict) return self._send_request(request_dict, operation_model) def create_request(self, params, operation_model=None): request = create_request_object(params) if operation_model: event_name = 'request-created.{endpoint_prefix}.{op_name}'.format( endpoint_prefix=self._endpoint_prefix, op_name=operation_model.name) self._event_emitter.emit(event_name, request=request, operation_name=operation_model.name) prepared_request = self.prepare_request(request) return prepared_request def _encode_headers(self, headers): # In place encoding of headers to utf-8 if they are unicode. for key, value in headers.items(): if isinstance(value, six.text_type): headers[key] = value.encode('utf-8') def prepare_request(self, request): self._encode_headers(request.headers) return request.prepare() def _send_request(self, request_dict, operation_model): attempts = 1 request = self.create_request(request_dict, operation_model) success_response, exception = self._get_response( request, operation_model, attempts) while self._needs_retry(attempts, operation_model, request_dict, success_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() # Create a new request when retried (including a new signature). request = self.create_request( request_dict, operation_model) success_response, exception = self._get_response( request, operation_model, attempts) if success_response is not None and \ 'ResponseMetadata' in success_response[1]: # We want to share num retries, not num attempts. total_retries = attempts - 1 success_response[1]['ResponseMetadata']['RetryAttempts'] = \ total_retries if exception is not None: raise exception else: return success_response def _get_response(self, request, operation_model, attempts): # This will return a tuple of (success_response, exception) # and success_response is itself a tuple of # (http_response, parsed_dict). # If an exception occurs then the success_response is None. # If no exception occurs then exception is None. try: logger.debug("Sending http request: %s", request) http_response = self.http_session.send( request, verify=self.verify, stream=operation_model.has_streaming_output, proxies=self.proxies, timeout=self.timeout) except ConnectionError as e: # For a connection error, if it looks like it's a DNS # lookup issue, 99% of the time this is due to a misconfigured # region/endpoint so we'll raise a more specific error message # to help users. logger.debug("ConnectionError received when sending HTTP request.", exc_info=True) if self._looks_like_dns_error(e): endpoint_url = e.request.url better_exception = EndpointConnectionError( endpoint_url=endpoint_url, error=e) return (None, better_exception) elif self._looks_like_bad_status_line(e): better_exception = ConnectionClosedError( endpoint_url=e.request.url, request=e.request) return (None, better_exception) else: return (None, e) except Exception as e: logger.debug("Exception received when sending HTTP request.", exc_info=True) return (None, e) # This returns the http_response and the parsed_data. response_dict = convert_to_response_dict(http_response, operation_model) parser = self._response_parser_factory.create_parser( operation_model.metadata['protocol']) parsed_response = parser.parse( response_dict, operation_model.output_shape) return (http_response, parsed_response), None def _looks_like_dns_error(self, e): return 'gaierror' in str(e) and e.request is not None def _looks_like_bad_status_line(self, e): return 'BadStatusLine' in str(e) and e.request is not None def _needs_retry(self, attempts, operation_model, request_dict, response=None, caught_exception=None): event_name = 'needs-retry.%s.%s' % (self._endpoint_prefix, operation_model.name) responses = self._event_emitter.emit( event_name, response=response, endpoint=self, operation=operation_model, attempts=attempts, caught_exception=caught_exception, request_dict=request_dict) handler_response = first_non_none_response(responses) 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 EndpointCreator(object): def __init__(self, event_emitter): self._event_emitter = event_emitter def create_endpoint(self, service_model, region_name, endpoint_url, verify=None, response_parser_factory=None, timeout=DEFAULT_TIMEOUT, max_pool_connections=MAX_POOL_CONNECTIONS): if not is_valid_endpoint_url(endpoint_url): raise ValueError("Invalid endpoint: %s" % endpoint_url) return Endpoint( endpoint_url, endpoint_prefix=service_model.endpoint_prefix, event_emitter=self._event_emitter, proxies=self._get_proxies(endpoint_url), verify=self._get_verify_value(verify), timeout=timeout, max_pool_connections=max_pool_connections, response_parser_factory=response_parser_factory) def _get_proxies(self, 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_verify_value(self, verify): # This is to account for: # https://github.com/kennethreitz/requests/issues/1436 # where we need to honor REQUESTS_CA_BUNDLE because we're creating our # own request objects. # First, if verify is not None, then the user explicitly specified # a value so this automatically wins. if verify is not None: return verify # Otherwise use the value from REQUESTS_CA_BUNDLE, or default to # True if the env var does not exist. return os.environ.get('REQUESTS_CA_BUNDLE', True) botocore-1.5.7/botocore/signers.py0000666454262600001440000005777613042511306020273 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import datetime import weakref import json import base64 import botocore import botocore.auth from botocore.compat import six, OrderedDict from botocore.awsrequest import create_request_object, prepare_request_dict from botocore.exceptions import UnknownSignatureVersionError from botocore.exceptions import UnknownClientMethodError from botocore.exceptions import UnsupportedSignatureVersionError from botocore.utils import fix_s3_host, datetime2timestamp class RequestSigner(object): """ An object to sign requests before they go out over the wire using one of the authentication mechanisms defined in ``auth.py``. This class fires two events scoped to a service and operation name: * choose-signer: Allows overriding the auth signer name. * before-sign: Allows mutating the request before signing. Together these events allow for customization of the request signing pipeline, including overrides, request path manipulation, and disabling signing per operation. :type service_name: string :param service_name: Name of the service, e.g. ``S3`` :type region_name: string :param region_name: Name of the service region, e.g. ``us-east-1`` :type signing_name: string :param signing_name: Service signing name. This is usually the same as the service name, but can differ. E.g. ``emr`` vs. ``elasticmapreduce``. :type signature_version: string :param signature_version: Signature name like ``v4``. :type credentials: :py:class:`~botocore.credentials.Credentials` :param credentials: User credentials with which to sign requests. :type event_emitter: :py:class:`~botocore.hooks.BaseEventHooks` :param event_emitter: Extension mechanism to fire events. """ def __init__(self, service_name, region_name, signing_name, signature_version, credentials, event_emitter): self._service_name = service_name self._region_name = region_name self._signing_name = signing_name self._signature_version = signature_version self._credentials = credentials # We need weakref to prevent leaking memory in Python 2.6 on Linux 2.6 self._event_emitter = weakref.proxy(event_emitter) @property def region_name(self): return self._region_name @property def signature_version(self): return self._signature_version @property def signing_name(self): return self._signing_name def handler(self, operation_name=None, request=None, **kwargs): # This is typically hooked up to the "request-created" event # from a client's event emitter. When a new request is created # this method is invoked to sign the request. # Don't call this method directly. return self.sign(operation_name, request) def sign(self, operation_name, request, region_name=None, signing_type='standard', expires_in=None): """Sign a request before it goes out over the wire. :type operation_name: string :param operation_name: The name of the current operation, e.g. ``ListBuckets``. :type request: AWSRequest :param request: The request object to be sent over the wire. :type region_name: str :param region_name: The region to sign the request for. :type signing_type: str :param signing_type: The type of signing to perform. This can be one of three possible values: * 'standard' - This should be used for most requests. * 'presign-url' - This should be used when pre-signing a request. * 'presign-post' - This should be used when pre-signing an S3 post. :type expires_in: int :param expires_in: The number of seconds the presigned url is valid for. This parameter is only valid for signing type 'presign-url'. """ if region_name is None: region_name = self._region_name signature_version = self._choose_signer(operation_name, signing_type) # Allow mutating request before signing self._event_emitter.emit( 'before-sign.{0}.{1}'.format(self._service_name, operation_name), request=request, signing_name=self._signing_name, region_name=self._region_name, signature_version=signature_version, request_signer=self) if signature_version != botocore.UNSIGNED: kwargs = { 'signing_name': self._signing_name, 'region_name': region_name, 'signature_version': signature_version } if expires_in is not None: kwargs['expires'] = expires_in try: auth = self.get_auth_instance(**kwargs) except UnknownSignatureVersionError as e: if signing_type != 'standard': raise UnsupportedSignatureVersionError( signature_version=signature_version) else: raise e auth.add_auth(request) def _choose_signer(self, operation_name, signing_type): """ Allow setting the signature version via the choose-signer event. A value of `botocore.UNSIGNED` means no signing will be performed. :param operation_name: The operation to sign. :param signing_type: The type of signing that the signer is to be used for. :return: The signature version to sign with. """ signing_type_suffix_map = { 'presign-post': '-presign-post', 'presign-url': '-query' } suffix = signing_type_suffix_map.get(signing_type, '') signature_version = self._signature_version if signature_version is not botocore.UNSIGNED and not \ signature_version.endswith(suffix): signature_version += suffix handler, response = self._event_emitter.emit_until_response( 'choose-signer.{0}.{1}'.format(self._service_name, operation_name), signing_name=self._signing_name, region_name=self._region_name, signature_version=signature_version) if response is not None: signature_version = response # The suffix needs to be checked again in case we get an improper # signature version from choose-signer. if signature_version is not botocore.UNSIGNED and not \ signature_version.endswith(suffix): signature_version += suffix return signature_version def get_auth_instance(self, signing_name, region_name, signature_version=None, **kwargs): """ Get an auth instance which can be used to sign a request using the given signature version. :type signing_name: string :param signing_name: Service signing name. This is usually the same as the service name, but can differ. E.g. ``emr`` vs. ``elasticmapreduce``. :type region_name: string :param region_name: Name of the service region, e.g. ``us-east-1`` :type signature_version: string :param signature_version: Signature name like ``v4``. :rtype: :py:class:`~botocore.auth.BaseSigner` :return: Auth instance to sign a request. """ if signature_version is None: signature_version = self._signature_version cls = botocore.auth.AUTH_TYPE_MAPS.get(signature_version) if cls is None: raise UnknownSignatureVersionError( signature_version=signature_version) # If there's no credentials provided (i.e credentials is None), # then we'll pass a value of "None" over to the auth classes, # which already handle the cases where no credentials have # been provided. frozen_credentials = None if self._credentials is not None: frozen_credentials = self._credentials.get_frozen_credentials() kwargs['credentials'] = frozen_credentials if cls.REQUIRES_REGION: if self._region_name is None: raise botocore.exceptions.NoRegionError() kwargs['region_name'] = region_name kwargs['service_name'] = signing_name auth = cls(**kwargs) return auth # Alias get_auth for backwards compatibility. get_auth = get_auth_instance def generate_presigned_url(self, request_dict, operation_name, expires_in=3600, region_name=None): """Generates a presigned url :type request_dict: dict :param request_dict: The prepared request dictionary returned by ``botocore.awsrequest.prepare_request_dict()`` :type operation_name: str :param operation_name: The operation being signed. :type expires_in: int :param expires_in: The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds) :type region_name: string :param region_name: The region name to sign the presigned url. :returns: The presigned url """ request = create_request_object(request_dict) self.sign(operation_name, request, region_name, 'presign-url', expires_in) request.prepare() return request.url class CloudFrontSigner(object): '''A signer to create a signed CloudFront URL. First you create a cloudfront signer based on a normalized RSA signer:: import rsa def rsa_signer(message): private_key = open('private_key.pem', 'r').read() return rsa.sign( message, rsa.PrivateKey.load_pkcs1(private_key.encode('utf8')), 'SHA-1') # CloudFront requires SHA-1 hash cf_signer = CloudFrontSigner(key_id, rsa_signer) To sign with a canned policy:: signed_url = cf_signer.generate_signed_url( url, date_less_than=datetime(2015, 12, 1)) To sign with a custom policy:: signed_url = cf_signer.generate_signed_url(url, policy=my_policy) ''' def __init__(self, key_id, rsa_signer): """Create a CloudFrontSigner. :type key_id: str :param key_id: The CloudFront Key Pair ID :type rsa_signer: callable :param rsa_signer: An RSA signer. Its only input parameter will be the message to be signed, and its output will be the signed content as a binary string. The hash algorithm needed by CloudFront is SHA-1. """ self.key_id = key_id self.rsa_signer = rsa_signer def generate_presigned_url(self, url, date_less_than=None, policy=None): """Creates a signed CloudFront URL based on given parameters. :type url: str :param url: The URL of the protected object :type date_less_than: datetime :param date_less_than: The URL will expire after that date and time :type policy: str :param policy: The custom policy, possibly built by self.build_policy() :rtype: str :return: The signed URL. """ if (date_less_than is not None and policy is not None or date_less_than is None and policy is None): e = 'Need to provide either date_less_than or policy, but not both' raise ValueError(e) if date_less_than is not None: # We still need to build a canned policy for signing purpose policy = self.build_policy(url, date_less_than) if isinstance(policy, six.text_type): policy = policy.encode('utf8') if date_less_than is not None: params = ['Expires=%s' % int(datetime2timestamp(date_less_than))] else: params = ['Policy=%s' % self._url_b64encode(policy).decode('utf8')] signature = self.rsa_signer(policy) params.extend([ 'Signature=%s' % self._url_b64encode(signature).decode('utf8'), 'Key-Pair-Id=%s' % self.key_id, ]) return self._build_url(url, params) def _build_url(self, base_url, extra_params): separator = '&' if '?' in base_url else '?' return base_url + separator + '&'.join(extra_params) def build_policy(self, resource, date_less_than, date_greater_than=None, ip_address=None): """A helper to build policy. :type resource: str :param resource: The URL or the stream filename of the protected object :type date_less_than: datetime :param date_less_than: The URL will expire after the time has passed :type date_greater_than: datetime :param date_greater_than: The URL will not be valid until this time :type ip_address: str :param ip_address: Use 'x.x.x.x' for an IP, or 'x.x.x.x/x' for a subnet :rtype: str :return: The policy in a compact string. """ # Note: # 1. Order in canned policy is significant. Special care has been taken # to ensure the output will match the order defined by the document. # There is also a test case to ensure that order. # SEE: http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-canned-policy.html#private-content-canned-policy-creating-policy-statement # 2. Albeit the order in custom policy is not required by CloudFront, # we still use OrderedDict internally to ensure the result is stable # and also matches canned policy requirement. # SEE: http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html moment = int(datetime2timestamp(date_less_than)) condition = OrderedDict({"DateLessThan": {"AWS:EpochTime": moment}}) if ip_address: if '/' not in ip_address: ip_address += '/32' condition["IpAddress"] = {"AWS:SourceIp": ip_address} if date_greater_than: moment = int(datetime2timestamp(date_greater_than)) condition["DateGreaterThan"] = {"AWS:EpochTime": moment} ordered_payload = [('Resource', resource), ('Condition', condition)] custom_policy = {"Statement": [OrderedDict(ordered_payload)]} return json.dumps(custom_policy, separators=(',', ':')) def _url_b64encode(self, data): # Required by CloudFront. See also: # http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-linux-openssl.html return base64.b64encode( data).replace(b'+', b'-').replace(b'=', b'_').replace(b'/', b'~') class S3PostPresigner(object): def __init__(self, request_signer): self._request_signer = request_signer def generate_presigned_post(self, request_dict, fields=None, conditions=None, expires_in=3600, region_name=None): """Generates the url and the form fields used for a presigned s3 post :type request_dict: dict :param request_dict: The prepared request dictionary returned by ``botocore.awsrequest.prepare_request_dict()`` :type fields: dict :param fields: A dictionary of prefilled form fields to build on top of. :type conditions: list :param conditions: A list of conditions to include in the policy. Each element can be either a list or a structure. For example: [ {"acl": "public-read"}, {"bucket": "mybucket"}, ["starts-with", "$key", "mykey"] ] :type expires_in: int :param expires_in: The number of seconds the presigned post is valid for. :type region_name: string :param region_name: The region name to sign the presigned post to. :rtype: dict :returns: A dictionary with two elements: ``url`` and ``fields``. Url is the url to post to. Fields is a dictionary filled with the form fields and respective values to use when submitting the post. For example: {'url': 'https://mybucket.s3.amazonaws.com 'fields': {'acl': 'public-read', 'key': 'mykey', 'signature': 'mysignature', 'policy': 'mybase64 encoded policy'} } """ if fields is None: fields = {} if conditions is None: conditions = [] # Create the policy for the post. policy = {} # Create an expiration date for the policy datetime_now = datetime.datetime.utcnow() expire_date = datetime_now + datetime.timedelta(seconds=expires_in) policy['expiration'] = expire_date.strftime(botocore.auth.ISO8601) # Append all of the conditions that the user supplied. policy['conditions'] = [] for condition in conditions: policy['conditions'].append(condition) # Store the policy and the fields in the request for signing request = create_request_object(request_dict) request.context['s3-presign-post-fields'] = fields request.context['s3-presign-post-policy'] = policy self._request_signer.sign( 'PutObject', request, region_name, 'presign-post') # Return the url and the fields for th form to post. return {'url': request.url, 'fields': fields} def add_generate_presigned_url(class_attributes, **kwargs): class_attributes['generate_presigned_url'] = generate_presigned_url def generate_presigned_url(self, ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None): """Generate a presigned url given a client, its method, and arguments :type ClientMethod: string :param ClientMethod: The client method to presign for :type Params: dict :param Params: The parameters normally passed to ``ClientMethod``. :type ExpiresIn: int :param ExpiresIn: The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds) :type HttpMethod: string :param HttpMethod: The http method to use on the generated url. By default, the http method is whatever is used in the method's model. :returns: The presigned url """ client_method = ClientMethod params = Params expires_in = ExpiresIn http_method = HttpMethod request_signer = self._request_signer serializer = self._serializer try: operation_name = self._PY_TO_OP_NAME[client_method] except KeyError: raise UnknownClientMethodError(method_name=client_method) operation_model = self.meta.service_model.operation_model( operation_name) # Create a request dict based on the params to serialize. request_dict = serializer.serialize_to_request( params, operation_model) # Switch out the http method if user specified it. if http_method is not None: request_dict['method'] = http_method # Prepare the request dict by including the client's endpoint url. prepare_request_dict( request_dict, endpoint_url=self.meta.endpoint_url) # Generate the presigned url. return request_signer.generate_presigned_url( request_dict=request_dict, expires_in=expires_in, operation_name=operation_name) def add_generate_presigned_post(class_attributes, **kwargs): class_attributes['generate_presigned_post'] = generate_presigned_post def generate_presigned_post(self, Bucket, Key, Fields=None, Conditions=None, ExpiresIn=3600): """Builds the url and the form fields used for a presigned s3 post :type Bucket: string :param Bucket: The name of the bucket to presign the post to. Note that bucket related conditions should not be included in the ``conditions`` parameter. :type Key: string :param Key: Key name, optionally add ${filename} to the end to attach the submitted filename. Note that key related conditions and fields are filled out for you and should not be included in the ``Fields`` or ``Conditions`` parameter. :type Fields: dict :param Fields: A dictionary of prefilled form fields to build on top of. Elements that may be included are acl, Cache-Control, Content-Type, Content-Disposition, Content-Encoding, Expires, success_action_redirect, redirect, success_action_status, and x-amz-meta-. Note that if a particular element is included in the fields dictionary it will not be automatically added to the conditions list. You must specify a condition for the element as well. :type Conditions: list :param Conditions: A list of conditions to include in the policy. Each element can be either a list or a structure. For example: [ {"acl": "public-read"}, ["content-length-range", 2, 5], ["starts-with", "$success_action_redirect", ""] ] Conditions that are included may pertain to acl, content-length-range, Cache-Control, Content-Type, Content-Disposition, Content-Encoding, Expires, success_action_redirect, redirect, success_action_status, and/or x-amz-meta-. Note that if you include a condition, you must specify the a valid value in the fields dictionary as well. A value will not be added automatically to the fields dictionary based on the conditions. :type ExpiresIn: int :param ExpiresIn: The number of seconds the presigned post is valid for. :rtype: dict :returns: A dictionary with two elements: ``url`` and ``fields``. Url is the url to post to. Fields is a dictionary filled with the form fields and respective values to use when submitting the post. For example: {'url': 'https://mybucket.s3.amazonaws.com 'fields': {'acl': 'public-read', 'key': 'mykey', 'signature': 'mysignature', 'policy': 'mybase64 encoded policy'} } """ bucket = Bucket key = Key fields = Fields conditions = Conditions expires_in = ExpiresIn if fields is None: fields = {} if conditions is None: conditions = [] post_presigner = S3PostPresigner(self._request_signer) serializer = self._serializer # We choose the CreateBucket operation model because its url gets # serialized to what a presign post requires. operation_model = self.meta.service_model.operation_model( 'CreateBucket') # Create a request dict based on the params to serialize. request_dict = serializer.serialize_to_request( {'Bucket': bucket}, operation_model) # Prepare the request dict by including the client's endpoint url. prepare_request_dict( request_dict, endpoint_url=self.meta.endpoint_url) # Append that the bucket name to the list of conditions. conditions.append({'bucket': bucket}) # If the key ends with filename, the only constraint that can be # imposed is if it starts with the specified prefix. if key.endswith('${filename}'): conditions.append(["starts-with", '$key', key[:-len('${filename}')]]) else: conditions.append({'key': key}) # Add the key to the fields. fields['key'] = key return post_presigner.generate_presigned_post( request_dict=request_dict, fields=fields, conditions=conditions, expires_in=expires_in) botocore-1.5.7/botocore/utils.py0000666454262600001440000011170413042511306017737 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import re import time import logging import datetime import hashlib import binascii import functools import weakref from six import string_types, text_type import dateutil.parser from dateutil.tz import tzlocal, tzutc import botocore from botocore.exceptions import InvalidExpressionError, ConfigNotFound from botocore.exceptions import InvalidDNSNameError, ClientError from botocore.exceptions import MetadataRetrievalError from botocore.compat import json, quote, zip_longest, urlsplit, urlunsplit from botocore.vendored import requests from botocore.compat import OrderedDict logger = logging.getLogger(__name__) DEFAULT_METADATA_SERVICE_TIMEOUT = 1 METADATA_SECURITY_CREDENTIALS_URL = ( 'http://169.254.169.254/latest/meta-data/iam/security-credentials/' ) # These are chars that do not need to be urlencoded. # Based on rfc2986, section 2.3 SAFE_CHARS = '-._~' LABEL_RE = re.compile('[a-z0-9][a-z0-9\-]*[a-z0-9]') RESTRICTED_REGIONS = [ 'us-gov-west-1', 'fips-us-gov-west-1', ] RETRYABLE_HTTP_ERRORS = (requests.Timeout, requests.ConnectionError) S3_ACCELERATE_WHITELIST = ['dualstack'] class _RetriesExceededError(Exception): """Internal exception used when the number of retries are exceeded.""" pass def get_service_module_name(service_model): """Returns the module name for a service This is the value used in both the documentation and client class name """ name = service_model.metadata.get( 'serviceAbbreviation', service_model.metadata.get( 'serviceFullName', service_model.service_name)) name = name.replace('Amazon', '') name = name.replace('AWS', '') name = re.sub('\W+', '', name) return name def normalize_url_path(path): if not path: return '/' return remove_dot_segments(path) def remove_dot_segments(url): # RFC 3986, section 5.2.4 "Remove Dot Segments" # Also, AWS services require consecutive slashes to be removed, # so that's done here as well if not url: return '' input_url = url.split('/') output_list = [] for x in input_url: if x and x != '.': if x == '..': if output_list: output_list.pop() else: output_list.append(x) if url[0] == '/': first = '/' else: first = '' if url[-1] == '/' and output_list: last = '/' else: last = '' return first + '/'.join(output_list) + last def validate_jmespath_for_set(expression): # Validates a limited jmespath expression to determine if we can set a # value based on it. Only works with dotted paths. if not expression or expression == '.': raise InvalidExpressionError(expression=expression) for invalid in ['[', ']', '*']: if invalid in expression: raise InvalidExpressionError(expression=expression) def set_value_from_jmespath(source, expression, value, is_first=True): # This takes a (limited) jmespath-like expression & can set a value based # on it. # Limitations: # * Only handles dotted lookups # * No offsets/wildcards/slices/etc. if is_first: validate_jmespath_for_set(expression) bits = expression.split('.', 1) current_key, remainder = bits[0], bits[1] if len(bits) > 1 else '' if not current_key: raise InvalidExpressionError(expression=expression) if remainder: if current_key not in source: # We've got something in the expression that's not present in the # source (new key). If there's any more bits, we'll set the key # with an empty dictionary. source[current_key] = {} return set_value_from_jmespath( source[current_key], remainder, value, is_first=False ) # If we're down to a single key, set it. source[current_key] = value class InstanceMetadataFetcher(object): def __init__(self, timeout=DEFAULT_METADATA_SERVICE_TIMEOUT, num_attempts=1, url=METADATA_SECURITY_CREDENTIALS_URL): self._timeout = timeout self._num_attempts = num_attempts self._url = url def _get_request(self, url, timeout, num_attempts=1): for i in range(num_attempts): try: response = requests.get(url, timeout=timeout) except RETRYABLE_HTTP_ERRORS as e: logger.debug("Caught exception while trying to retrieve " "credentials: %s", e, exc_info=True) else: if response.status_code == 200: return response raise _RetriesExceededError() def retrieve_iam_role_credentials(self): data = {} url = self._url timeout = self._timeout num_attempts = self._num_attempts try: r = self._get_request(url, timeout, num_attempts) if r.content: fields = r.content.decode('utf-8').split('\n') for field in fields: if field.endswith('/'): data[field[0:-1]] = self.retrieve_iam_role_credentials( url + field, timeout, num_attempts) else: val = self._get_request( url + field, timeout=timeout, num_attempts=num_attempts).content.decode('utf-8') if val[0] == '{': val = json.loads(val) data[field] = val else: logger.debug("Metadata service returned non 200 status code " "of %s for url: %s, content body: %s", r.status_code, url, r.content) except _RetriesExceededError: logger.debug("Max number of attempts exceeded (%s) when " "attempting to retrieve data from metadata service.", num_attempts) # We sort for stable ordering. In practice, this should only consist # of one role, but may need revisiting if this expands in the future. final_data = {} for role_name in sorted(data): final_data = { 'role_name': role_name, 'access_key': data[role_name]['AccessKeyId'], 'secret_key': data[role_name]['SecretAccessKey'], 'token': data[role_name]['Token'], 'expiry_time': data[role_name]['Expiration'], } return final_data def merge_dicts(dict1, dict2, append_lists=False): """Given two dict, merge the second dict into the first. The dicts can have arbitrary nesting. :param append_lists: If true, instead of clobbering a list with the new value, append all of the new values onto the original list. """ for key in dict2: if isinstance(dict2[key], dict): if key in dict1 and key in dict2: merge_dicts(dict1[key], dict2[key]) else: dict1[key] = dict2[key] # If the value is a list and the ``append_lists`` flag is set, # append the new values onto the original list elif isinstance(dict2[key], list) and append_lists: # The value in dict1 must be a list in order to append new # values onto it. if key in dict1 and isinstance(dict1[key], list): dict1[key].extend(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 parse_key_val_file(filename, _open=open): try: with _open(filename) as f: contents = f.read() return parse_key_val_file_contents(contents) except OSError: raise ConfigNotFound(path=filename) def parse_key_val_file_contents(contents): # This was originally extracted from the EC2 credential provider, which was # fairly lenient in its parsing. We only try to parse key/val pairs if # there's a '=' in the line. final = {} for line in contents.splitlines(): if '=' not in line: continue key, val = line.split('=', 1) key = key.strip() val = val.strip() final[key] = val return final def percent_encode_sequence(mapping, safe=SAFE_CHARS): """Urlencode a dict or list into a string. This is similar to urllib.urlencode except that: * It uses quote, and not quote_plus * It has a default list of safe chars that don't need to be encoded, which matches what AWS services expect. If any value in the input ``mapping`` is a list type, then each list element wil be serialized. This is the equivalent to ``urlencode``'s ``doseq=True`` argument. This function should be preferred over the stdlib ``urlencode()`` function. :param mapping: Either a dict to urlencode or a list of ``(key, value)`` pairs. """ encoded_pairs = [] if hasattr(mapping, 'items'): pairs = mapping.items() else: pairs = mapping for key, value in pairs: if isinstance(value, list): for element in value: encoded_pairs.append('%s=%s' % (percent_encode(key), percent_encode(element))) else: encoded_pairs.append('%s=%s' % (percent_encode(key), percent_encode(value))) return '&'.join(encoded_pairs) def percent_encode(input_str, safe=SAFE_CHARS): """Urlencodes a string. Whereas percent_encode_sequence handles taking a dict/sequence and producing a percent encoded string, this function deals only with taking a string (not a dict/sequence) and percent encoding it. """ if not isinstance(input_str, string_types): input_str = text_type(input_str) return quote(text_type(input_str).encode('utf-8'), safe=safe) def parse_timestamp(value): """Parse a timestamp into a datetime object. Supported formats: * iso8601 * rfc822 * epoch (value is an integer) This will return a ``datetime.datetime`` object. """ if isinstance(value, (int, float)): # Possibly an epoch time. return datetime.datetime.fromtimestamp(value, tzlocal()) else: try: return datetime.datetime.fromtimestamp(float(value), tzlocal()) except (TypeError, ValueError): pass try: # In certain cases, a timestamp marked with GMT can be parsed into a # different time zone, so here we provide a context which will # enforce that GMT == UTC. return dateutil.parser.parse(value, tzinfos={'GMT': tzutc()}) except (TypeError, ValueError) as e: raise ValueError('Invalid timestamp "%s": %s' % (value, e)) def parse_to_aware_datetime(value): """Converted the passed in value to a datetime object with tzinfo. This function can be used to normalize all timestamp inputs. This function accepts a number of different types of inputs, but will always return a datetime.datetime object with time zone information. The input param ``value`` can be one of several types: * A datetime object (both naive and aware) * An integer representing the epoch time (can also be a string of the integer, i.e '0', instead of 0). The epoch time is considered to be UTC. * An iso8601 formatted timestamp. This does not need to be a complete timestamp, it can contain just the date portion without the time component. The returned value will be a datetime object that will have tzinfo. If no timezone info was provided in the input value, then UTC is assumed, not local time. """ # This is a general purpose method that handles several cases of # converting the provided value to a string timestamp suitable to be # serialized to an http request. It can handle: # 1) A datetime.datetime object. if isinstance(value, datetime.datetime): datetime_obj = value else: # 2) A string object that's formatted as a timestamp. # We document this as being an iso8601 timestamp, although # parse_timestamp is a bit more flexible. datetime_obj = parse_timestamp(value) if datetime_obj.tzinfo is None: # I think a case would be made that if no time zone is provided, # we should use the local time. However, to restore backwards # compat, the previous behavior was to assume UTC, which is # what we're going to do here. datetime_obj = datetime_obj.replace(tzinfo=tzutc()) else: datetime_obj = datetime_obj.astimezone(tzutc()) return datetime_obj def datetime2timestamp(dt, default_timezone=None): """Calculate the timestamp based on the given datetime instance. :type dt: datetime :param dt: A datetime object to be converted into timestamp :type default_timezone: tzinfo :param default_timezone: If it is provided as None, we treat it as tzutc(). But it is only used when dt is a naive datetime. :returns: The timestamp """ epoch = datetime.datetime(1970, 1, 1) if dt.tzinfo is None: if default_timezone is None: default_timezone = tzutc() dt = dt.replace(tzinfo=default_timezone) d = dt.replace(tzinfo=None) - dt.utcoffset() - epoch if hasattr(d, "total_seconds"): return d.total_seconds() # Works in Python 2.7+ return (d.microseconds + (d.seconds + d.days * 24 * 3600) * 10**6) / 10**6 def calculate_sha256(body, as_hex=False): """Calculate a sha256 checksum. This method will calculate the sha256 checksum of a file like object. Note that this method will iterate through the entire file contents. The caller is responsible for ensuring the proper starting position of the file and ``seek()``'ing the file back to its starting location if other consumers need to read from the file like object. :param body: Any file like object. The file must be opened in binary mode such that a ``.read()`` call returns bytes. :param as_hex: If True, then the hex digest is returned. If False, then the digest (as binary bytes) is returned. :returns: The sha256 checksum """ checksum = hashlib.sha256() for chunk in iter(lambda: body.read(1024 * 1024), b''): checksum.update(chunk) if as_hex: return checksum.hexdigest() else: return checksum.digest() def calculate_tree_hash(body): """Calculate a tree hash checksum. For more information see: http://docs.aws.amazon.com/amazonglacier/latest/dev/checksum-calculations.html :param body: Any file like object. This has the same constraints as the ``body`` param in calculate_sha256 :rtype: str :returns: The hex version of the calculated tree hash """ chunks = [] required_chunk_size = 1024 * 1024 sha256 = hashlib.sha256 for chunk in iter(lambda: body.read(required_chunk_size), b''): chunks.append(sha256(chunk).digest()) if not chunks: return sha256(b'').hexdigest() while len(chunks) > 1: new_chunks = [] for first, second in _in_pairs(chunks): if second is not None: new_chunks.append(sha256(first + second).digest()) else: # We're at the end of the list and there's no pair left. new_chunks.append(first) chunks = new_chunks return binascii.hexlify(chunks[0]).decode('ascii') def _in_pairs(iterable): # Creates iterator that iterates over the list in pairs: # for a, b in _in_pairs([0, 1, 2, 3, 4]): # print(a, b) # # will print: # 0, 1 # 2, 3 # 4, None shared_iter = iter(iterable) # Note that zip_longest is a compat import that uses # the itertools izip_longest. This creates an iterator, # this call below does _not_ immediately create the list # of pairs. return zip_longest(shared_iter, shared_iter) class CachedProperty(object): """A read only property that caches the initially computed value. This descriptor will only call the provided ``fget`` function once. Subsequent access to this property will return the cached value. """ def __init__(self, fget): self._fget = fget def __get__(self, obj, cls): if obj is None: return self else: computed_value = self._fget(obj) obj.__dict__[self._fget.__name__] = computed_value return computed_value class ArgumentGenerator(object): """Generate sample input based on a shape model. This class contains a ``generate_skeleton`` method that will take an input/output shape (created from ``botocore.model``) and generate a sample dictionary corresponding to the input/output shape. The specific values used are place holder values. For strings either an empty string or the member name can be used, for numbers 0 or 0.0 is used. The intended usage of this class is to generate the *shape* of the input structure. This can be useful for operations that have complex input shapes. This allows a user to just fill in the necessary data instead of worrying about the specific structure of the input arguments. Example usage:: s = botocore.session.get_session() ddb = s.get_service_model('dynamodb') arg_gen = ArgumentGenerator() sample_input = arg_gen.generate_skeleton( ddb.operation_model('CreateTable').input_shape) print("Sample input for dynamodb.CreateTable: %s" % sample_input) """ def __init__(self, use_member_names=False): self._use_member_names = use_member_names def generate_skeleton(self, shape): """Generate a sample input. :type shape: ``botocore.model.Shape`` :param shape: The input shape. :return: The generated skeleton input corresponding to the provided input shape. """ stack = [] return self._generate_skeleton(shape, stack) def _generate_skeleton(self, shape, stack, name=''): stack.append(shape.name) try: if shape.type_name == 'structure': return self._generate_type_structure(shape, stack) elif shape.type_name == 'list': return self._generate_type_list(shape, stack) elif shape.type_name == 'map': return self._generate_type_map(shape, stack) elif shape.type_name == 'string': if self._use_member_names: return name return '' elif shape.type_name in ['integer', 'long']: return 0 elif shape.type_name == 'float': return 0.0 elif shape.type_name == 'boolean': return True elif shape.type_name == 'timestamp': return datetime.datetime(1970, 1, 1, 0, 0, 0) finally: stack.pop() def _generate_type_structure(self, shape, stack): if stack.count(shape.name) > 1: return {} skeleton = OrderedDict() for member_name, member_shape in shape.members.items(): skeleton[member_name] = self._generate_skeleton( member_shape, stack, name=member_name) return skeleton def _generate_type_list(self, shape, stack): # For list elements we've arbitrarily decided to # return two elements for the skeleton list. name = '' if self._use_member_names: name = shape.member.name return [ self._generate_skeleton(shape.member, stack, name), ] def _generate_type_map(self, shape, stack): key_shape = shape.key value_shape = shape.value assert key_shape.type_name == 'string' return OrderedDict([ ('KeyName', self._generate_skeleton(value_shape, stack)), ]) def is_valid_endpoint_url(endpoint_url): """Verify the endpoint_url is valid. :type endpoint_url: string :param endpoint_url: An endpoint_url. Must have at least a scheme and a hostname. :return: True if the endpoint url is valid. False otherwise. """ parts = urlsplit(endpoint_url) hostname = parts.hostname if hostname is None: return False if len(hostname) > 255: return False if hostname[-1] == ".": hostname = hostname[:-1] allowed = re.compile( "^((?!-)[A-Z\d-]{1,63}(? 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(request, signature_version, region_name, default_endpoint_url='s3.amazonaws.com', **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. """ # By default we do not use virtual hosted style addressing when # signed with signature version 4. if signature_version is not botocore.UNSIGNED and \ 's3v4' in signature_version: return elif not _allowed_region(region_name): return try: switch_to_virtual_host_style( request, signature_version, default_endpoint_url) except InvalidDNSNameError as e: bucket_name = e.kwargs['bucket_name'] logger.debug('Not changing URI, bucket is not DNS compatible: %s', bucket_name) def switch_to_virtual_host_style(request, signature_version, default_endpoint_url=None, **kwargs): """ This is a handler to force virtual host style s3 addressing no matter the signature version (which is taken in consideration for the default case). If the bucket is not DNS compatible an InvalidDNSName is thrown. :param request: A AWSRequest object that is about to be sent. :param signature_version: The signature version to sign with :param default_endpoint_url: The endpoint to use when switching to a virtual style. If None is supplied, the virtual host will be constructed from the url of the request. """ if request.auth_path is not None: # The auth_path has already been applied (this may be a # retried request). We don't need to perform this # customization again. return elif _is_get_bucket_location_request(request): # For the GetBucketLocation response, we should not be using # the virtual host style addressing so we can avoid any sigv4 # issues. logger.debug("Request is GetBucketLocation operation, not checking " "for DNS compatibility.") return parts = urlsplit(request.url) request.auth_path = parts.path path_parts = parts.path.split('/') # Retrieve what the endpoint we will be prepending the bucket name to. if default_endpoint_url is None: default_endpoint_url = parts.netloc if len(path_parts) > 1: bucket_name = path_parts[1] if not bucket_name: # If the bucket name is empty we should not be checking for # dns compatibility. return logger.debug('Checking for DNS compatible bucket for: %s', request.url) if check_dns_name(bucket_name): # If the operation is on a bucket, the auth_path must be # terminated with a '/' character. if len(path_parts) == 2: if request.auth_path[-1] != '/': request.auth_path += '/' path_parts.remove(bucket_name) # At the very least the path must be a '/', such as with the # CreateBucket operation when DNS style is being used. If this # is not used you will get an empty path which is incorrect. path = '/'.join(path_parts) or '/' global_endpoint = default_endpoint_url host = bucket_name + '.' + global_endpoint new_tuple = (parts.scheme, host, path, parts.query, '') new_uri = urlunsplit(new_tuple) request.url = new_uri logger.debug('URI updated to: %s', new_uri) else: raise InvalidDNSNameError(bucket_name=bucket_name) def _is_get_bucket_location_request(request): return request.url.endswith('?location') def _allowed_region(region_name): return region_name not in RESTRICTED_REGIONS def instance_cache(func): """Method decorator for caching method calls to a single instance. **This is not a general purpose caching decorator.** In order to use this, you *must* provide an ``_instance_cache`` attribute on the instance. This decorator is used to cache method calls. The cache is only scoped to a single instance though such that multiple instances will maintain their own cache. In order to keep things simple, this decorator requires that you provide an ``_instance_cache`` attribute on your instance. """ func_name = func.__name__ @functools.wraps(func) def _cache_guard(self, *args, **kwargs): cache_key = (func_name, args) if kwargs: kwarg_items = tuple(sorted(kwargs.items())) cache_key = (func_name, args, kwarg_items) result = self._instance_cache.get(cache_key) if result is not None: return result result = func(self, *args, **kwargs) self._instance_cache[cache_key] = result return result return _cache_guard def switch_host_s3_accelerate(request, operation_name, **kwargs): """Switches the current s3 endpoint with an S3 Accelerate endpoint""" # Note that when registered the switching of the s3 host happens # before it gets changed to virtual. So we are not concerned with ensuring # that the bucket name is translated to the virtual style here and we # can hard code the Accelerate endpoint. parts = urlsplit(request.url).netloc.split('.') parts = [p for p in parts if p in S3_ACCELERATE_WHITELIST] endpoint = 'https://s3-accelerate.' if len(parts) > 0: endpoint += '.'.join(parts) + '.' endpoint += 'amazonaws.com' if operation_name in ['ListBuckets', 'CreateBucket', 'DeleteBucket']: return _switch_hosts(request, endpoint, use_new_scheme=False) def switch_host_with_param(request, param_name): """Switches the host using a parameter value from a JSON request body""" request_json = json.loads(request.data.decode('utf-8')) if request_json.get(param_name): new_endpoint = request_json[param_name] _switch_hosts(request, new_endpoint) def _switch_hosts(request, new_endpoint, use_new_scheme=True): final_endpoint = _get_new_endpoint( request.url, new_endpoint, use_new_scheme) request.url = final_endpoint def _get_new_endpoint(original_endpoint, new_endpoint, use_new_scheme=True): new_endpoint_components = urlsplit(new_endpoint) original_endpoint_components = urlsplit(original_endpoint) scheme = original_endpoint_components.scheme if use_new_scheme: scheme = new_endpoint_components.scheme final_endpoint_components = ( scheme, new_endpoint_components.netloc, original_endpoint_components.path, original_endpoint_components.query, '' ) final_endpoint = urlunsplit(final_endpoint_components) logger.debug('Updating URI from %s to %s' % ( original_endpoint, final_endpoint)) return final_endpoint def deep_merge(base, extra): """Deeply two dictionaries, overriding existing keys in the base. :param base: The base dictionary which will be merged into. :param extra: The dictionary to merge into the base. Keys from this dictionary will take precedence. """ for key in extra: # If the key represents a dict on both given dicts, merge the sub-dicts if key in base and isinstance(base[key], dict)\ and isinstance(extra[key], dict): deep_merge(base[key], extra[key]) continue # Otherwise, set the key on the base to be the value of the extra. base[key] = extra[key] class S3RegionRedirector(object): def __init__(self, endpoint_bridge, client, cache=None): self._endpoint_resolver = endpoint_bridge self._cache = cache if self._cache is None: self._cache = {} # This needs to be a weak ref in order to prevent memory leaks on # python 2.6 self._client = weakref.proxy(client) def register(self, event_emitter=None): emitter = event_emitter or self._client.meta.events emitter.register('needs-retry.s3', self.redirect_from_error) emitter.register('before-call.s3', self.set_request_url) emitter.register('before-parameter-build.s3', self.redirect_from_cache) def redirect_from_error(self, request_dict, response, operation, **kwargs): """ An S3 request sent to the wrong region will return an error that contains the endpoint the request should be sent to. This handler will add the redirect information to the signing context and then redirect the request. """ if response is None: # This could be none if there was a ConnectionError or other # transport error. return error = response[1].get('Error', {}) error_code = error.get('Code') if error_code == '301': # A raw 301 error might be returned for several reasons, but we # only want to try to redirect it if it's a HeadObject or # HeadBucket because all other operations will return # PermanentRedirect if region is incorrect. if operation.name not in ['HeadObject', 'HeadBucket']: return elif error_code != 'PermanentRedirect': return bucket = request_dict['context']['signing']['bucket'] client_region = request_dict['context'].get('client_region') new_region = self.get_bucket_region(bucket, response) if new_region is None: logger.debug( "S3 client configured for region %s but the bucket %s is not " "in that region and the proper region could not be " "automatically determined." % (client_region, bucket)) return logger.debug( "S3 client configured for region %s but the bucket %s is in region" " %s; Please configure the proper region to avoid multiple " "unnecessary redirects and signing attempts." % ( client_region, bucket, new_region)) endpoint = self._endpoint_resolver.resolve('s3', new_region) endpoint = endpoint['endpoint_url'] signing_context = { 'region': new_region, 'bucket': bucket, 'endpoint': endpoint } request_dict['context']['signing'] = signing_context self._cache[bucket] = signing_context self.set_request_url(request_dict, request_dict['context']) # Return 0 so it doesn't wait to retry return 0 def get_bucket_region(self, bucket, response): """ There are multiple potential sources for the new region to redirect to, but they aren't all universally available for use. This will try to find region from response elements, but will fall back to calling HEAD on the bucket if all else fails. :param bucket: The bucket to find the region for. This is necessary if the region is not available in the error response. :param response: A response representing a service request that failed due to incorrect region configuration. """ # First try to source the region from the headers. service_response = response[1] response_headers = service_response['ResponseMetadata']['HTTPHeaders'] if 'x-amz-bucket-region' in response_headers: return response_headers['x-amz-bucket-region'] # Next, check the error body region = service_response.get('Error', {}).get('Region', None) if region is not None: return region # Finally, HEAD the bucket. No other choice sadly. try: response = self._client.head_bucket(Bucket=bucket) headers = response['ResponseMetadata']['HTTPHeaders'] except ClientError as e: headers = e.response['ResponseMetadata']['HTTPHeaders'] region = headers.get('x-amz-bucket-region', None) return region def set_request_url(self, params, context, **kwargs): endpoint = context.get('signing', {}).get('endpoint', None) if endpoint is not None: params['url'] = _get_new_endpoint(params['url'], endpoint, False) def redirect_from_cache(self, params, context, **kwargs): """ This handler retrieves a given bucket's signing context from the cache and adds it into the request context. """ bucket = params.get('Bucket') signing_context = self._cache.get(bucket) if signing_context is not None: context['signing'] = signing_context else: context['signing'] = {'bucket': bucket} class ContainerMetadataFetcher(object): TIMEOUT_SECONDS = 2 RETRY_ATTEMPTS = 3 SLEEP_TIME = 1 IP_ADDRESS = '169.254.170.2' def __init__(self, session=None, sleep=time.sleep): if session is None: session = requests.Session() self._session = session self._sleep = sleep def retrieve_uri(self, relative_uri): """Retrieve JSON metadata from ECS metadata. :type relative_uri: str :param relative_uri: A relative URI, e.g "/foo/bar?id=123" :return: The parsed JSON response. """ full_url = self._full_url(relative_uri) headers = {'Accept': 'application/json'} attempts = 0 while True: try: return self._get_response(full_url, headers, self.TIMEOUT_SECONDS) except MetadataRetrievalError as e: logger.debug("Received error when attempting to retrieve " "ECS metadata: %s", e, exc_info=True) self._sleep(self.SLEEP_TIME) attempts += 1 if attempts >= self.RETRY_ATTEMPTS: raise def _get_response(self, full_url, headers, timeout): try: response = self._session.get(full_url, headers=headers, timeout=timeout) if response.status_code != 200: raise MetadataRetrievalError( error_msg="Received non 200 response (%s) from ECS metadata: %s" % (response.status_code, response.text)) try: return json.loads(response.text) except ValueError: raise MetadataRetrievalError( error_msg=("Unable to parse JSON returned from " "ECS metadata: %s" % response.text)) except RETRYABLE_HTTP_ERRORS as e: error_msg = ("Received error when attempting to retrieve " "ECS metadata: %s" % e) raise MetadataRetrievalError(error_msg=error_msg) def _full_url(self, relative_uri): return 'http://%s%s' % (self.IP_ADDRESS, relative_uri) botocore-1.5.7/botocore/session.py0000666454262600001440000011422413042511306020262 0ustar pysdk-ciamazon00000000000000# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. """ This module contains the main interface to the botocore package, the Session object. """ import copy import logging import os import platform from botocore import __version__ import botocore.configloader import botocore.credentials import botocore.client from botocore.exceptions import ConfigNotFound, ProfileNotFound from botocore.exceptions import UnknownServiceError, PartialCredentialsError from botocore.errorfactory import ClientExceptionsFactory from botocore import handlers from botocore.hooks import HierarchicalEmitter, first_non_none_response from botocore.loaders import create_loader from botocore.parsers import ResponseParserFactory from botocore.regions import EndpointResolver from botocore.model import ServiceModel from botocore import paginate from botocore import waiter from botocore import retryhandler, translate class Session(object): """ The Session object collects together useful functionality from `botocore` as well as important data such as configuration information and credentials into a single, easy-to-use object. :ivar available_profiles: A list of profiles defined in the config file associated with this session. :ivar profile: The current profile. """ #: 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_config_variable`` method of the :class:`botocore.session.Session` #: class. #: These form the keys of the dictionary. The values in the dictionary #: are tuples of (, , , #: ). #: The conversion func is a function that takes the configuration value #: as an argument and returns the converted value. If this value is #: None, then the configuration value is returned unmodified. This #: conversion function can be used to type convert config values to #: values other than the default values of strings. #: The ``profile`` and ``config_file`` variables should always have a #: None value for the first entry in the tuple because it doesn't make #: sense to look inside the config file for the location of the config #: file or for the default profile to use. #: The ``config_name`` is the name to look for in the configuration file, #: the ``env var`` is the OS environment variable (``os.environ``) to #: use, and ``default_value`` is the value to use if no value is otherwise #: found. SESSION_VARIABLES = { # logical: config_file, env_var, default_value, conversion_func 'profile': (None, ['AWS_DEFAULT_PROFILE', 'AWS_PROFILE'], None, None), 'region': ('region', 'AWS_DEFAULT_REGION', None, None), 'data_path': ('data_path', 'AWS_DATA_PATH', None, None), 'config_file': (None, 'AWS_CONFIG_FILE', '~/.aws/config', None), 'ca_bundle': ('ca_bundle', 'AWS_CA_BUNDLE', None, None), 'api_versions': ('api_versions', None, {}, None), # This is the shared credentials file amongst sdks. 'credentials_file': (None, 'AWS_SHARED_CREDENTIALS_FILE', '~/.aws/credentials', None), # These variables only exist in the config file. # This is the number of seconds until we time out a request to # the instance metadata service. 'metadata_service_timeout': ( 'metadata_service_timeout', 'AWS_METADATA_SERVICE_TIMEOUT', 1, int), # This is the number of request attempts we make until we give # up trying to retrieve data from the instance metadata service. 'metadata_service_num_attempts': ( 'metadata_service_num_attempts', 'AWS_METADATA_SERVICE_NUM_ATTEMPTS', 1, int), 'parameter_validation': ('parameter_validation', None, True, None), } #: The default format string to use when configuring the botocore logger. LOG_FORMAT = '%(asctime)s - %(name)s - %(levelname)s - %(message)s' def __init__(self, session_vars=None, event_hooks=None, include_builtin_handlers=True, profile=None): """ Create a new Session object. :type session_vars: dict :param session_vars: A dictionary that is used to override some or all of the environment variables associated with this session. The key/value pairs defined in this dictionary will override the corresponding variables defined in ``SESSION_VARIABLES``. :type event_hooks: BaseEventHooks :param event_hooks: The event hooks object to use. If one is not provided, an event hooks object will be automatically created for you. :type include_builtin_handlers: bool :param include_builtin_handlers: Indicates whether or not to automatically register builtin handlers. :type profile: str :param profile: The name of the profile to use for this session. Note that the profile can only be set when the session is created. """ self.session_var_map = copy.copy(self.SESSION_VARIABLES) if session_vars: self.session_var_map.update(session_vars) if event_hooks is None: self._events = HierarchicalEmitter() else: self._events = event_hooks if include_builtin_handlers: self._register_builtin_handlers(self._events) self.user_agent_name = 'Botocore' self.user_agent_version = __version__ self.user_agent_extra = '' # The _profile attribute is just used to cache the value # of the current profile to avoid going through the normal # config lookup process each access time. self._profile = None self._config = None self._credentials = None self._profile_map = None # This is a dict that stores per session specific config variable # overrides via set_config_variable(). self._session_instance_vars = {} if profile is not None: self._session_instance_vars['profile'] = profile self._client_config = None self._components = ComponentLocator() self._register_components() def _register_components(self): self._register_credential_provider() self._register_data_loader() self._register_endpoint_resolver() self._register_event_emitter() self._register_response_parser_factory() self._register_exceptions_factory() def _register_event_emitter(self): self._components.register_component('event_emitter', self._events) def _register_credential_provider(self): self._components.lazy_register_component( 'credential_provider', lambda: botocore.credentials.create_credential_resolver(self)) def _register_data_loader(self): self._components.lazy_register_component( 'data_loader', lambda: create_loader(self.get_config_variable('data_path'))) def _register_endpoint_resolver(self): def create_default_resolver(): loader = self.get_component('data_loader') endpoints = loader.load_data('endpoints') return EndpointResolver(endpoints) self._components.lazy_register_component( 'endpoint_resolver', create_default_resolver) def _register_response_parser_factory(self): self._components.register_component('response_parser_factory', ResponseParserFactory()) def _register_exceptions_factory(self): self._components.register_component( 'exceptions_factory', ClientExceptionsFactory()) def _register_builtin_handlers(self, events): for spec in handlers.BUILTIN_HANDLERS: if len(spec) == 2: event_name, handler = spec self.register(event_name, handler) else: event_name, handler, register_type = spec if register_type is handlers.REGISTER_FIRST: self._events.register_first(event_name, handler) elif register_type is handlers.REGISTER_LAST: self._events.register_last(event_name, handler) @property def available_profiles(self): return list(self._build_profile_map().keys()) def _build_profile_map(self): # This will build the profile map if it has not been created, # otherwise it will return the cached value. The profile map # is a list of profile names, to the config values for the profile. if self._profile_map is None: self._profile_map = self.full_config['profiles'] return self._profile_map @property def profile(self): if self._profile is None: profile = self.get_config_variable('profile') self._profile = profile return self._profile def get_config_variable(self, logical_name, methods=('instance', 'env', 'config')): """ Retrieve the value associated with the specified logical_name from the environment or the config file. Values found in the environment variable take precedence of values found in the config file. If no value can be found, a None will be returned. :type logical_name: str :param logical_name: The logical name of the session variable you want to retrieve. This name will be mapped to the appropriate environment variable name for this session as well as the appropriate config file entry. :type method: tuple :param method: Defines which methods will be used to find the variable value. By default, all available methods are tried but you can limit which methods are used by supplying a different value to this parameter. Valid choices are: instance|env|config :returns: value of variable or None if not defined. """ # Handle all the short circuit special cases first. if logical_name not in self.session_var_map: return # Do the actual lookups. We need to handle # 'instance', 'env', and 'config' locations, in that order. value = None var_config = self.session_var_map[logical_name] if self._found_in_instance_vars(methods, logical_name): return self._session_instance_vars[logical_name] elif self._found_in_env(methods, var_config): value = self._retrieve_from_env(var_config[1], os.environ) elif self._found_in_config_file(methods, var_config): value = self.get_scoped_config()[var_config[0]] if value is None: value = var_config[2] if var_config[3] is not None: value = var_config[3](value) return value def _found_in_instance_vars(self, methods, logical_name): if 'instance' in methods: return logical_name in self._session_instance_vars return False def _found_in_env(self, methods, var_config): return ( 'env' in methods and var_config[1] is not None and self._retrieve_from_env(var_config[1], os.environ) is not None) def _found_in_config_file(self, methods, var_config): if 'config' in methods and var_config[0] is not None: return var_config[0] in self.get_scoped_config() return False def _retrieve_from_env(self, names, environ): # We need to handle the case where names is either # a single value or a list of variables. if not isinstance(names, list): names = [names] for name in names: if name in environ: return environ[name] return None def set_config_variable(self, logical_name, value): """Set a configuration variable to a specific value. By using this method, you can override the normal lookup process used in ``get_config_variable`` by explicitly setting a value. Subsequent calls to ``get_config_variable`` will use the ``value``. This gives you per-session specific configuration values. :: >>> # Assume logical name 'foo' maps to env var 'FOO' >>> os.environ['FOO'] = 'myvalue' >>> s.get_config_variable('foo') 'myvalue' >>> s.set_config_variable('foo', 'othervalue') >>> s.get_config_variable('foo') 'othervalue' :type logical_name: str :param logical_name: The logical name of the session variable you want to set. These are the keys in ``SESSION_VARIABLES``. :param value: The value to associate with the config variable. """ self._session_instance_vars[logical_name] = value def get_scoped_config(self): """ Returns the config values from the config file scoped to the current profile. The configuration data is loaded **only** from the config file. It does not resolve variables based on different locations (e.g. first from the session instance, then from environment variables, then from the config file). If you want this lookup behavior, use the ``get_config_variable`` method instead. Note that this configuration is specific to a single profile (the ``profile`` session variable). If the ``profile`` session variable is set and the profile does not exist in the config file, a ``ProfileNotFound`` exception will be raised. :raises: ConfigNotFound, ConfigParseError, ProfileNotFound :rtype: dict """ profile_name = self.get_config_variable('profile') profile_map = self._build_profile_map() # If a profile is not explicitly set return the default # profile config or an empty config dict if we don't have # a default profile. if profile_name is None: return profile_map.get('default', {}) elif profile_name not in profile_map: # Otherwise if they specified a profile, it has to # exist (even if it's the default profile) otherwise # we complain. raise ProfileNotFound(profile=profile_name) else: return profile_map[profile_name] @property def full_config(self): """Return the parsed config file. The ``get_config`` method returns the config associated with the specified profile. This property returns the contents of the **entire** config file. :rtype: dict """ if self._config is None: try: config_file = self.get_config_variable('config_file') self._config = botocore.configloader.load_config(config_file) except ConfigNotFound: self._config = {'profiles': {}} try: # Now we need to inject the profiles from the # credentials file. We don't actually need the values # in the creds file, only the profile names so that we # can validate the user is not referring to a nonexistent # profile. cred_file = self.get_config_variable('credentials_file') cred_profiles = botocore.configloader.raw_config_parse( cred_file) for profile in cred_profiles: cred_vars = cred_profiles[profile] if profile not in self._config['profiles']: self._config['profiles'][profile] = cred_vars else: self._config['profiles'][profile].update(cred_vars) except ConfigNotFound: pass return self._config def get_default_client_config(self): """Retrieves the default config for creating clients :rtype: botocore.client.Config :returns: The default client config object when creating clients. If the value is ``None`` then there is no default config object attached to the session. """ return self._client_config def set_default_client_config(self, client_config): """Sets the default config for creating clients :type client_config: botocore.client.Config :param client_config: The default client config object when creating clients. If the value is ``None`` then there is no default config object attached to the session. """ self._client_config = client_config def set_credentials(self, access_key, secret_key, token=None): """ Manually create credentials for this session. If you would prefer to use botocore without a config file, environment variables, or IAM roles, you can pass explicit credentials into this method to establish credentials for this session. :type access_key: str :param access_key: The access key part of the credentials. :type secret_key: str :param secret_key: The secret key part of the credentials. :type token: str :param token: An option session token used by STS session credentials. """ self._credentials = botocore.credentials.Credentials(access_key, secret_key, token) def get_credentials(self): """ Return the :class:`botocore.credential.Credential` object associated with this session. If the credentials have not yet been loaded, this will attempt to load them. If they have already been loaded, this will return the cached credentials. """ if self._credentials is None: self._credentials = self._components.get_component( 'credential_provider').load_credentials() return self._credentials def user_agent(self): """ Return a string suitable for use as a User-Agent header. The string will be of the form: / 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 - exec_env is exec-env/$AWS_EXECUTION_ENV If ``user_agent_extra`` is not empty, then this value will be appended to the end of the user agent string. """ base = '%s/%s Python/%s %s/%s' % (self.user_agent_name, self.user_agent_version, platform.python_version(), platform.system(), platform.release()) if os.environ.get('AWS_EXECUTION_ENV') is not None: base += ' exec-env/%s' % os.environ.get('AWS_EXECUTION_ENV') if self.user_agent_extra: base += ' %s' % self.user_agent_extra return base 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 self.get_component('data_loader').load_data(data_path) def get_service_model(self, service_name, api_version=None): """Get the service model object. :type service_name: string :param service_name: The service name :type api_version: string :param api_version: The API version of the service. If none is provided, then the latest API version will be used. :rtype: L{botocore.model.ServiceModel} :return: The botocore service model for the service. """ service_description = self.get_service_data(service_name, api_version) return ServiceModel(service_description, service_name=service_name) def get_waiter_model(self, service_name, api_version=None): loader = self.get_component('data_loader') waiter_config = loader.load_service_model( service_name, 'waiters-2', api_version) return waiter.WaiterModel(waiter_config) def get_paginator_model(self, service_name, api_version=None): loader = self.get_component('data_loader') paginator_config = loader.load_service_model( service_name, 'paginators-1', api_version) return paginate.PaginatorModel(paginator_config) def get_service_data(self, service_name, api_version=None): """ Retrieve the fully merged data associated with a service. """ data_path = service_name service_data = self.get_component('data_loader').load_service_model( data_path, type_name='service-2', api_version=api_version ) self._events.emit('service-data-loaded.%s' % service_name, service_data=service_data, service_name=service_name, session=self) return service_data def get_available_services(self): """ Return a list of names of available services. """ return self.get_component('data_loader')\ .list_available_services(type_name='service-2') 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.LOG_FORMAT``. """ 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.LOG_FORMAT 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.LOG_FORMAT) # add formatter to ch ch.setFormatter(formatter) # add ch to logger log.addHandler(ch) def register(self, event_name, handler, unique_id=None, unique_id_uses_count=False): """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. :param unique_id_uses_count: boolean :param unique_id_uses_count: Specifies if the event should maintain a count when a ``unique_id`` is registered and unregisted. The event can only be completely unregistered once every register call using the unique id has been matched by an ``unregister`` call. If ``unique_id`` is specified, subsequent ``register`` calls must use the same value for ``unique_id_uses_count`` as the ``register`` call that first registered the event. :raises ValueError: If the call to ``register`` uses ``unique_id`` but the value for ``unique_id_uses_count`` differs from the ``unique_id_uses_count`` value declared by the very first ``register`` call for that ``unique_id``. """ self._events.register(event_name, handler, unique_id, unique_id_uses_count=unique_id_uses_count) def unregister(self, event_name, handler=None, unique_id=None, unique_id_uses_count=False): """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. :param unique_id_uses_count: boolean :param unique_id_uses_count: Specifies if the event should maintain a count when a ``unique_id`` is registered and unregisted. The event can only be completely unregistered once every ``register`` call using the ``unique_id`` has been matched by an ``unregister`` call. If the ``unique_id`` is specified, subsequent ``unregister`` calls must use the same value for ``unique_id_uses_count`` as the ``register`` call that first registered the event. :raises ValueError: If the call to ``unregister`` uses ``unique_id`` but the value for ``unique_id_uses_count`` differs from the ``unique_id_uses_count`` value declared by the very first ``register`` call for that ``unique_id``. """ self._events.unregister(event_name, handler=handler, unique_id=unique_id, unique_id_uses_count=unique_id_uses_count) 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_component(self, name): return self._components.get_component(name) def register_component(self, name, component): self._components.register_component(name, component) def lazy_register_component(self, name, component): self._components.lazy_register_component(name, component) def create_client(self, service_name, region_name=None, api_version=None, use_ssl=True, verify=None, endpoint_url=None, aws_access_key_id=None, aws_secret_access_key=None, aws_session_token=None, config=None): """Create a botocore client. :type service_name: string :param service_name: The name of the service for which a client will be created. You can use the ``Sesssion.get_available_services()`` method to get a list of all available service names. :type region_name: string :param region_name: The name of the region associated with the client. A client is associated with a single region. :type api_version: string :param api_version: The API version to use. By default, botocore will use the latest API version when creating a client. You only need to specify this parameter if you want to use a previous API version of the client. :type use_ssl: boolean :param use_ssl: Whether or not to use SSL. By default, SSL is used. Note that not all services support non-ssl connections. :type verify: boolean/string :param verify: Whether or not to verify SSL certificates. By default SSL certificates are verified. You can provide the following values: * False - do not validate SSL certificates. SSL will still be used (unless use_ssl is False), but SSL certificates will not be verified. * path/to/cert/bundle.pem - A filename of the CA cert bundle to uses. You can specify this argument if you want to use a different CA cert bundle than the one used by botocore. :type endpoint_url: string :param endpoint_url: The complete URL to use for the constructed client. Normally, botocore will automatically construct the appropriate URL to use when communicating with a service. You can specify a complete URL (including the "http/https" scheme) to override this behavior. If this value is provided, then ``use_ssl`` is ignored. :type aws_access_key_id: string :param aws_access_key_id: The access key to use when creating the client. This is entirely optional, and if not provided, the credentials configured for the session will automatically be used. You only need to provide this argument if you want to override the credentials used for this specific client. :type aws_secret_access_key: string :param aws_secret_access_key: The secret key to use when creating the client. Same semantics as aws_access_key_id above. :type aws_session_token: string :param aws_session_token: The session token to use when creating the client. Same semantics as aws_access_key_id above. :type config: botocore.client.Config :param config: Advanced client configuration options. If a value is specified in the client config, its value will take precedence over environment variables and configuration values, but not over a value passed explicitly to the method. If a default config object is set on the session, the config object used when creating the client will be the result of calling ``merge()`` on the default config with the config provided to this call. :rtype: botocore.client.BaseClient :return: A botocore client instance """ default_client_config = self.get_default_client_config() # If a config is provided and a default config is set, then # use the config resulting from merging the two. if config is not None and default_client_config is not None: config = default_client_config.merge(config) # If a config was not provided then use the default # client config from the session elif default_client_config is not None: config = default_client_config # Figure out the user-provided region based on the various # configuration options. if region_name is None: if config and config.region_name is not None: region_name = config.region_name else: region_name = self.get_config_variable('region') # Figure out the verify value base on the various # configuration options. if verify is None: verify = self.get_config_variable('ca_bundle') if api_version is None: api_version = self.get_config_variable('api_versions').get( service_name, None) loader = self.get_component('data_loader') event_emitter = self.get_component('event_emitter') response_parser_factory = self.get_component( 'response_parser_factory') if aws_access_key_id is not None and aws_secret_access_key is not None: credentials = botocore.credentials.Credentials( access_key=aws_access_key_id, secret_key=aws_secret_access_key, token=aws_session_token) elif self._missing_cred_vars(aws_access_key_id, aws_secret_access_key): raise PartialCredentialsError( provider='explicit', cred_var=self._missing_cred_vars(aws_access_key_id, aws_secret_access_key)) else: credentials = self.get_credentials() endpoint_resolver = self.get_component('endpoint_resolver') exceptions_factory = self.get_component('exceptions_factory') client_creator = botocore.client.ClientCreator( loader, endpoint_resolver, self.user_agent(), event_emitter, retryhandler, translate, response_parser_factory, exceptions_factory) client = client_creator.create_client( service_name=service_name, region_name=region_name, is_secure=use_ssl, endpoint_url=endpoint_url, verify=verify, credentials=credentials, scoped_config=self.get_scoped_config(), client_config=config, api_version=api_version) return client def _missing_cred_vars(self, access_key, secret_key): if access_key is not None and secret_key is None: return 'aws_secret_access_key' if secret_key is not None and access_key is None: return 'aws_access_key_id' return None def get_available_partitions(self): """Lists the available partitions found on disk :rtype: list :return: Returns a list of partition names (e.g., ["aws", "aws-cn"]) """ resolver = self.get_component('endpoint_resolver') return resolver.get_available_partitions() def get_available_regions(self, service_name, partition_name='aws', allow_non_regional=False): """Lists the region and endpoint names of a particular partition. :type service_name: string :param service_name: Name of a service to list endpoint for (e.g., s3). This parameter accepts a service name (e.g., "elb") or endpoint prefix (e.g., "elasticloadbalancing"). :type partition_name: string :param partition_name: Name of the partition to limit endpoints to. (e.g., aws for the public AWS endpoints, aws-cn for AWS China endpoints, aws-us-gov for AWS GovCloud (US) Endpoints, etc. :type allow_non_regional: bool :param allow_non_regional: Set to True to include endpoints that are not regional endpoints (e.g., s3-external-1, fips-us-gov-west-1, etc). :return: Returns a list of endpoint names (e.g., ["us-east-1"]). """ resolver = self.get_component('endpoint_resolver') results = [] try: service_data = self.get_service_data(service_name) endpoint_prefix = service_data['metadata'].get( 'endpointPrefix', service_name) results = resolver.get_available_endpoints( endpoint_prefix, partition_name, allow_non_regional) except UnknownServiceError: pass return results class ComponentLocator(object): """Service locator for session components.""" def __init__(self): self._components = {} self._deferred = {} def get_component(self, name): if name in self._deferred: factory = self._deferred[name] self._components[name] = factory() # Only delete the component from the deferred dict after # successfully creating the object from the factory as well as # injecting the instantiated value into the _components dict. del self._deferred[name] try: return self._components[name] except KeyError: raise ValueError("Unknown component: %s" % name) def register_component(self, name, component): self._components[name] = component try: del self._deferred[name] except KeyError: pass def lazy_register_component(self, name, no_arg_factory): self._deferred[name] = no_arg_factory try: del self._components[name] except KeyError: pass def get_session(env_vars=None): """ Return a new session object. """ return Session(env_vars) botocore-1.5.7/botocore/handlers.py0000666454262600001440000011560613042511306020404 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. """Builtin event handlers. This module contains builtin handlers for events emitted by botocore. """ import base64 import logging import xml.etree.cElementTree import copy import re import warnings import uuid from botocore.compat import unquote, json, six, unquote_str, \ ensure_bytes, get_md5, MD5_AVAILABLE from botocore.docs.utils import AutoPopulatedParam from botocore.docs.utils import HideParamFromOperations from botocore.docs.utils import AppendParamDocumentation from botocore.signers import add_generate_presigned_url from botocore.signers import add_generate_presigned_post from botocore.exceptions import ParamValidationError from botocore.exceptions import AliasConflictParameterError from botocore.exceptions import UnsupportedTLSVersionWarning from botocore.utils import percent_encode, SAFE_CHARS from botocore.utils import switch_host_with_param from botocore import retryhandler from botocore import utils from botocore import translate import botocore import botocore.auth logger = logging.getLogger(__name__) REGISTER_FIRST = object() REGISTER_LAST = object() # From the S3 docs: # The rules for bucket names in the US Standard region allow bucket names # to be as long as 255 characters, and bucket names can contain any # combination of uppercase letters, lowercase letters, numbers, periods # (.), hyphens (-), and underscores (_). VALID_BUCKET = re.compile('^[a-zA-Z0-9.\-_]{1,255}$') VERSION_ID_SUFFIX = re.compile(r'\?versionId=[^\s]+$') def check_for_200_error(response, **kwargs): # From: http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectCOPY.html # There are two opportunities for a copy request to return an error. One # can occur when Amazon S3 receives the copy request and the other can # occur while Amazon S3 is copying the files. If the error occurs before # the copy operation starts, you receive a standard Amazon S3 error. If the # error occurs during the copy operation, the error response is embedded in # the 200 OK response. This means that a 200 OK response can contain either # a success or an error. Make sure to design your application to parse the # contents of the response and handle it appropriately. # # So this handler checks for this case. Even though the server sends a # 200 response, conceptually this should be handled exactly like a # 500 response (with respect to raising exceptions, retries, etc.) # We're connected *before* all the other retry logic handlers, so as long # as we switch the error code to 500, we'll retry the error as expected. if response is None: # A None response can happen if an exception is raised while # trying to retrieve the response. See Endpoint._get_response(). return http_response, parsed = response if _looks_like_special_case_error(http_response): logger.debug("Error found for response with 200 status code, " "errors: %s, changing status code to " "500.", parsed) http_response.status_code = 500 def _looks_like_special_case_error(http_response): if http_response.status_code == 200: parser = xml.etree.cElementTree.XMLParser( target=xml.etree.cElementTree.TreeBuilder(), encoding='utf-8') parser.feed(http_response.content) root = parser.close() if root.tag == 'Error': return True return False def decode_console_output(parsed, **kwargs): if 'Output' in parsed: try: # We're using 'replace' for errors because it is # possible that console output contains non string # chars we can't utf-8 decode. value = base64.b64decode(six.b(parsed['Output'])).decode( 'utf-8', 'replace') parsed['Output'] = value except (ValueError, TypeError, AttributeError): logger.debug('Error decoding base64', exc_info=True) def generate_idempotent_uuid(params, model, **kwargs): for name in model.idempotent_members: if name not in params: params[name] = str(uuid.uuid4()) logger.debug("injecting idempotency token (%s) into param '%s'." % (params[name], name)) def decode_quoted_jsondoc(value): try: value = json.loads(unquote(value)) except (ValueError, TypeError): logger.debug('Error loading quoted JSON', exc_info=True) return value def json_decode_template_body(parsed, **kwargs): if 'TemplateBody' in parsed: try: value = json.loads(parsed['TemplateBody']) parsed['TemplateBody'] = value except (ValueError, TypeError): logger.debug('error loading JSON', exc_info=True) def calculate_md5(params, **kwargs): request_dict = params if request_dict['body'] and 'Content-MD5' not in params['headers']: body = request_dict['body'] if isinstance(body, (bytes, bytearray)): binary_md5 = _calculate_md5_from_bytes(body) else: binary_md5 = _calculate_md5_from_file(body) base64_md5 = base64.b64encode(binary_md5).decode('ascii') params['headers']['Content-MD5'] = base64_md5 def _calculate_md5_from_bytes(body_bytes): md5 = get_md5(body_bytes) return md5.digest() def _calculate_md5_from_file(fileobj): start_position = fileobj.tell() md5 = get_md5() for chunk in iter(lambda: fileobj.read(1024 * 1024), b''): md5.update(chunk) fileobj.seek(start_position) return md5.digest() def conditionally_calculate_md5(params, context, request_signer, **kwargs): """Only add a Content-MD5 if the system supports it.""" if MD5_AVAILABLE: calculate_md5(params, **kwargs) def validate_bucket_name(params, **kwargs): if 'Bucket' not in params: return bucket = params['Bucket'] if VALID_BUCKET.search(bucket) is None: error_msg = ( 'Invalid bucket name "%s": Bucket name must match ' 'the regex "%s"' % (bucket, VALID_BUCKET.pattern)) raise ParamValidationError(report=error_msg) def sse_md5(params, **kwargs): """ S3 server-side encryption requires the encryption key to be sent to the server base64 encoded, as well as a base64-encoded MD5 hash of the encryption key. This handler does both if the MD5 has not been set by the caller. """ _sse_md5(params, 'SSECustomer') def copy_source_sse_md5(params, **kwargs): """ S3 server-side encryption requires the encryption key to be sent to the server base64 encoded, as well as a base64-encoded MD5 hash of the encryption key. This handler does both if the MD5 has not been set by the caller specifically if the parameter is for the copy-source sse-c key. """ _sse_md5(params, 'CopySourceSSECustomer') def _sse_md5(params, sse_member_prefix='SSECustomer'): if not _needs_s3_sse_customization(params, sse_member_prefix): return sse_key_member = sse_member_prefix + 'Key' sse_md5_member = sse_member_prefix + 'KeyMD5' key_as_bytes = params[sse_key_member] if isinstance(key_as_bytes, six.text_type): key_as_bytes = key_as_bytes.encode('utf-8') key_md5_str = base64.b64encode( get_md5(key_as_bytes).digest()).decode('utf-8') key_b64_encoded = base64.b64encode(key_as_bytes).decode('utf-8') params[sse_key_member] = key_b64_encoded params[sse_md5_member] = key_md5_str def _needs_s3_sse_customization(params, sse_member_prefix): return (params.get(sse_member_prefix + 'Key') is not None and sse_member_prefix + 'KeyMD5' not in params) def register_retries_for_service(service_data, session, service_name, **kwargs): loader = session.get_component('data_loader') endpoint_prefix = service_data.get('metadata', {}).get('endpointPrefix') if endpoint_prefix is None: logger.debug("Not registering retry handlers, could not endpoint " "prefix from model for service %s", service_name) return config = _load_retry_config(loader, endpoint_prefix) if not config: return logger.debug("Registering retry handlers for service: %s", service_name) handler = retryhandler.create_retry_handler( config, endpoint_prefix) unique_id = 'retry-config-%s' % endpoint_prefix session.register('needs-retry.%s' % endpoint_prefix, handler, unique_id=unique_id) _register_for_operations(config, session, service_name=endpoint_prefix) def _load_retry_config(loader, endpoint_prefix): original_config = loader.load_data('_retry') retry_config = translate.build_retry_config( endpoint_prefix, original_config['retry'], original_config.get('definitions', {})) return retry_config 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 disable_signing(**kwargs): """ This handler disables request signing by setting the signer name to a special sentinel value. """ return botocore.UNSIGNED def add_expect_header(model, params, **kwargs): if model.http.get('method', '') not in ['PUT', 'POST']: return if 'body' in params: body = params['body'] if hasattr(body, 'read'): # Any file like object will use an expect 100-continue # header regardless of size. logger.debug("Adding expect 100 continue header to request.") params['headers']['Expect'] = '100-continue' def document_copy_source_form(section, event_name, **kwargs): if 'request-example' in event_name: parent = section.get_section('structure-value') param_line = parent.get_section('CopySource') value_portion = param_line.get_section('member-value') value_portion.clear_text() value_portion.write("'string' or {'Bucket': 'string', " "'Key': 'string', 'VersionId': 'string'}") elif 'request-params' in event_name: param_section = section.get_section('CopySource') type_section = param_section.get_section('param-type') type_section.clear_text() type_section.write(':type CopySource: str or dict') doc_section = param_section.get_section('param-documentation') doc_section.clear_text() doc_section.write( "The name of the source bucket, key name of the source object, " "and optional version ID of the source object. You can either " "provide this value as a string or a dictionary. The " "string form is {bucket}/{key} or " "{bucket}/{key}?versionId={versionId} if you want to copy a " "specific version. You can also provide this value as a " "dictionary. The dictionary format is recommended over " "the string format because it is more explicit. The dictionary " "format is: {'Bucket': 'bucket', 'Key': 'key', 'VersionId': 'id'}." " Note that the VersionId key is optional and may be omitted." ) def handle_copy_source_param(params, **kwargs): """Convert CopySource param for CopyObject/UploadPartCopy. This handler will deal with two cases: * CopySource provided as a string. We'll make a best effort to URL encode the key name as required. This will require parsing the bucket and version id from the CopySource value and only encoding the key. * CopySource provided as a dict. In this case we're explicitly given the Bucket, Key, and VersionId so we're able to encode the key and ensure this value is serialized and correctly sent to S3. """ source = params.get('CopySource') if source is None: # The call will eventually fail but we'll let the # param validator take care of this. It will # give a better error message. return if isinstance(source, six.string_types): params['CopySource'] = _quote_source_header(source) elif isinstance(source, dict): params['CopySource'] = _quote_source_header_from_dict(source) def _quote_source_header_from_dict(source_dict): try: bucket = source_dict['Bucket'] key = percent_encode(source_dict['Key'], safe=SAFE_CHARS + '/') version_id = source_dict.get('VersionId') except KeyError as e: raise ParamValidationError( report='Missing required parameter: %s' % str(e)) final = '%s/%s' % (bucket, key) if version_id is not None: final += '?versionId=%s' % version_id return final def _quote_source_header(value): result = VERSION_ID_SUFFIX.search(value) if result is None: return percent_encode(value, safe=SAFE_CHARS + '/') else: first, version_id = value[:result.start()], value[result.start():] return percent_encode(first, safe=SAFE_CHARS + '/') + version_id def _get_cross_region_presigned_url(request_signer, request_dict, model, source_region, destination_region): # The better way to do this is to actually get the # endpoint_resolver and get the endpoint_url given the # source region. In this specific case, we know that # we can safely replace the dest region with the source # region because of the supported EC2 regions, but in # general this is not a safe assumption to make. # I think eventually we should try to plumb through something # that allows us to resolve endpoints from regions. request_dict_copy = copy.deepcopy(request_dict) request_dict_copy['body']['DestinationRegion'] = destination_region request_dict_copy['url'] = request_dict['url'].replace( destination_region, source_region) request_dict_copy['method'] = 'GET' request_dict_copy['headers'] = {} return request_signer.generate_presigned_url( request_dict_copy, region_name=source_region, operation_name=model.name) def _get_presigned_url_source_and_destination_regions(request_signer, params): # Gets the source and destination regions to be used destination_region = request_signer._region_name source_region = params.get('SourceRegion') return source_region, destination_region def inject_presigned_url_ec2(params, request_signer, model, **kwargs): # The customer can still provide this, so we should pass if they do. if 'PresignedUrl' in params['body']: return src, dest = _get_presigned_url_source_and_destination_regions( request_signer, params['body']) url = _get_cross_region_presigned_url( request_signer, params, model, src, dest) params['body']['PresignedUrl'] = url # EC2 Requires that the destination region be sent over the wire in # addition to the source region. params['body']['DestinationRegion'] = dest def inject_presigned_url_rds(params, request_signer, model, **kwargs): # SourceRegion is not required for RDS operations, so it's possible that # it isn't set. In that case it's probably a local copy so we don't need # to do anything else. if 'SourceRegion' not in params['body']: return src, dest = _get_presigned_url_source_and_destination_regions( request_signer, params['body']) # Since SourceRegion isn't actually modeled for RDS, it needs to be # removed from the request params before we send the actual request. del params['body']['SourceRegion'] if 'PreSignedUrl' in params['body']: return url = _get_cross_region_presigned_url( request_signer, params, model, src, dest) params['body']['PreSignedUrl'] = url def json_decode_policies(parsed, model, **kwargs): # Any time an IAM operation returns a policy document # it is a string that is json that has been urlencoded, # i.e urlencode(json.dumps(policy_document)). # To give users something more useful, we will urldecode # this value and json.loads() the result so that they have # the policy document as a dictionary. output_shape = model.output_shape if output_shape is not None: _decode_policy_types(parsed, model.output_shape) def _decode_policy_types(parsed, shape): # IAM consistently uses the policyDocumentType shape to indicate # strings that have policy documents. shape_name = 'policyDocumentType' if shape.type_name == 'structure': for member_name, member_shape in shape.members.items(): if member_shape.type_name == 'string' and \ member_shape.name == shape_name and \ member_name in parsed: parsed[member_name] = decode_quoted_jsondoc( parsed[member_name]) elif member_name in parsed: _decode_policy_types(parsed[member_name], member_shape) if shape.type_name == 'list': shape_member = shape.member for item in parsed: _decode_policy_types(item, shape_member) def parse_get_bucket_location(parsed, http_response, **kwargs): # s3.GetBucketLocation cannot be modeled properly. To # account for this we just manually parse the XML document. # The "parsed" passed in only has the ResponseMetadata # filled out. This handler will fill in the LocationConstraint # value. if 'LocationConstraint' in parsed: # Response already set - a stub? return response_body = http_response.content parser = xml.etree.cElementTree.XMLParser( target=xml.etree.cElementTree.TreeBuilder(), encoding='utf-8') parser.feed(response_body) root = parser.close() region = root.text parsed['LocationConstraint'] = region def base64_encode_user_data(params, **kwargs): if 'UserData' in params: if isinstance(params['UserData'], six.text_type): # Encode it to bytes if it is text. params['UserData'] = params['UserData'].encode('utf-8') params['UserData'] = base64.b64encode( params['UserData']).decode('utf-8') def document_base64_encoding(param): description = ('**This value will be base64 encoded automatically. Do ' 'not base64 encode this value prior to performing the ' 'operation.**') append = AppendParamDocumentation(param, description) return append.append_documentation def validate_ascii_metadata(params, **kwargs): """Verify S3 Metadata only contains ascii characters. From: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html "Amazon S3 stores user-defined metadata in lowercase. Each name, value pair must conform to US-ASCII when using REST and UTF-8 when using SOAP or browser-based uploads via POST." """ metadata = params.get('Metadata') if not metadata or not isinstance(metadata, dict): # We have to at least type check the metadata as a dict type # because this handler is called before param validation. # We'll go ahead and return because the param validator will # give a descriptive error message for us. # We might need a post-param validation event. return for key, value in metadata.items(): try: key.encode('ascii') value.encode('ascii') except UnicodeEncodeError as e: error_msg = ( 'Non ascii characters found in S3 metadata ' 'for key "%s", value: "%s". \nS3 metadata can only ' 'contain ASCII characters. ' % (key, value) ) raise ParamValidationError( report=error_msg) def fix_route53_ids(params, model, **kwargs): """ Check for and split apart Route53 resource IDs, setting only the last piece. This allows the output of one operation (e.g. ``'foo/1234'``) to be used as input in another operation (e.g. it expects just ``'1234'``). """ input_shape = model.input_shape if not input_shape or not hasattr(input_shape, 'members'): return members = [name for (name, shape) in input_shape.members.items() if shape.name in ['ResourceId', 'DelegationSetId']] for name in members: if name in params: orig_value = params[name] params[name] = orig_value.split('/')[-1] logger.debug('%s %s -> %s', name, orig_value, params[name]) def inject_account_id(params, **kwargs): if params.get('accountId') is None: # Glacier requires accountId, but allows you # to specify '-' for the current owners account. # We add this default value if the user does not # provide the accountId as a convenience. params['accountId'] = '-' def add_glacier_version(model, params, **kwargs): request_dict = params request_dict['headers']['x-amz-glacier-version'] = model.metadata[ 'apiVersion'] def add_accept_header(model, params, **kwargs): if params['headers'].get('Accept', None) is None: request_dict = params request_dict['headers']['Accept'] = 'application/json' def add_glacier_checksums(params, **kwargs): """Add glacier checksums to the http request. This will add two headers to the http request: * x-amz-content-sha256 * x-amz-sha256-tree-hash These values will only be added if they are not present in the HTTP request. """ request_dict = params headers = request_dict['headers'] body = request_dict['body'] if isinstance(body, six.binary_type): # If the user provided a bytes type instead of a file # like object, we're temporarily create a BytesIO object # so we can use the util functions to calculate the # checksums which assume file like objects. Note that # we're not actually changing the body in the request_dict. body = six.BytesIO(body) starting_position = body.tell() if 'x-amz-content-sha256' not in headers: headers['x-amz-content-sha256'] = utils.calculate_sha256( body, as_hex=True) body.seek(starting_position) if 'x-amz-sha256-tree-hash' not in headers: headers['x-amz-sha256-tree-hash'] = utils.calculate_tree_hash(body) body.seek(starting_position) def document_glacier_tree_hash_checksum(): doc = ''' This is a required field. Ideally you will want to compute this value with checksums from previous uploaded parts, using the algorithm described in `Glacier documentation `_. But if you prefer, you can also use botocore.util.calculate_tree_hash() to compute it from raw file by:: checksum = calculate_tree_hash(open('your_file.txt', 'rb')) ''' return AppendParamDocumentation('checksum', doc).append_documentation def document_cloudformation_get_template_return_type(section, event_name, **kwargs): if 'response-params' in event_name: template_body_section = section.get_section('TemplateBody') type_section = template_body_section.get_section('param-type') type_section.clear_text() type_section.write('(*dict*) --') elif 'response-example' in event_name: parent = section.get_section('structure-value') param_line = parent.get_section('TemplateBody') value_portion = param_line.get_section('member-value') value_portion.clear_text() value_portion.write('{}') def switch_host_machinelearning(request, **kwargs): switch_host_with_param(request, 'PredictEndpoint') def check_openssl_supports_tls_version_1_2(**kwargs): import ssl try: openssl_version_tuple = ssl.OPENSSL_VERSION_INFO if openssl_version_tuple[0] < 1 or openssl_version_tuple[2] < 1: warnings.warn( 'Currently installed openssl version: %s does not ' 'support TLS 1.2, which is required for use of iot-data. ' 'Please use python installed with openssl version 1.0.1 or ' 'higher.' % (ssl.OPENSSL_VERSION), UnsupportedTLSVersionWarning ) # We cannot check the openssl version on python2.6, so we should just # pass on this conveniency check. except AttributeError: pass def change_get_to_post(request, **kwargs): # This is useful when we need to change a potentially large GET request # into a POST with x-www-form-urlencoded encoding. if request.method == 'GET' and '?' in request.url: request.headers['Content-Type'] = 'application/x-www-form-urlencoded' request.method = 'POST' request.url, request.data = request.url.split('?', 1) def set_list_objects_encoding_type_url(params, context, **kwargs): if 'EncodingType' not in params: # We set this context so that we know it wasn't the customer that # requested the encoding. context['encoding_type_auto_set'] = True params['EncodingType'] = 'url' def decode_list_object(parsed, context, **kwargs): # This is needed because we are passing url as the encoding type. Since the # paginator is based on the key, we need to handle it before it can be # round tripped. # # From the documentation: If you specify encoding-type request parameter, # Amazon S3 includes this element in the response, and returns encoded key # name values in the following response elements: # Delimiter, Marker, Prefix, NextMarker, Key. if parsed.get('EncodingType') == 'url' and \ context.get('encoding_type_auto_set'): # URL decode top-level keys in the response if present. top_level_keys = ['Delimiter', 'Marker', 'NextMarker'] for key in top_level_keys: if key in parsed: parsed[key] = unquote_str(parsed[key]) # URL decode nested keys from the response if present. nested_keys = [('Contents', 'Key'), ('CommonPrefixes', 'Prefix')] for (top_key, child_key) in nested_keys: if top_key in parsed: for member in parsed[top_key]: member[child_key] = unquote_str(member[child_key]) def convert_body_to_file_like_object(params, **kwargs): if 'Body' in params: if isinstance(params['Body'], six.string_types): params['Body'] = six.BytesIO(ensure_bytes(params['Body'])) elif isinstance(params['Body'], six.binary_type): params['Body'] = six.BytesIO(params['Body']) def _add_parameter_aliases(handler_list): # Mapping of original parameter to parameter alias. # The key is ..parameter # The first part of the key is used for event registration. # The last part is the original parameter name and the value is the # alias to expose in documentation. aliases = { 'ec2.*.Filter': 'Filters', 'logs.CreateExportTask.from': 'fromTime', 'cloudsearchdomain.Search.return': 'returnFields' } for original, new_name in aliases.items(): event_portion, original_name = original.rsplit('.', 1) parameter_alias = ParameterAlias(original_name, new_name) # Add the handlers to the list of handlers. # One handler is to handle when users provide the alias. # The other handler is to update the documentation to show only # the alias. parameter_build_event_handler_tuple = ( 'before-parameter-build.' + event_portion, parameter_alias.alias_parameter_in_call, REGISTER_FIRST ) docs_event_handler_tuple = ( 'docs.*.' + event_portion + '.complete-section', parameter_alias.alias_parameter_in_documentation) handler_list.append(parameter_build_event_handler_tuple) handler_list.append(docs_event_handler_tuple) class ParameterAlias(object): def __init__(self, original_name, alias_name): self._original_name = original_name self._alias_name = alias_name def alias_parameter_in_call(self, params, model, **kwargs): if model.input_shape: # Only consider accepting the alias if it is modeled in the # input shape. if self._original_name in model.input_shape.members: if self._alias_name in params: if self._original_name in params: raise AliasConflictParameterError( original=self._original_name, alias=self._alias_name, operation=model.name ) # Remove the alias parameter value and use the old name # instead. params[self._original_name] = params.pop(self._alias_name) def alias_parameter_in_documentation(self, event_name, section, **kwargs): if event_name.startswith('docs.request-params'): if self._original_name not in section.available_sections: return # Replace the name for parameter type param_section = section.get_section(self._original_name) param_type_section = param_section.get_section('param-type') self._replace_content(param_type_section) # Replace the name for the parameter description param_name_section = param_section.get_section('param-name') self._replace_content(param_name_section) elif event_name.startswith('docs.request-example'): section = section.get_section('structure-value') if self._original_name not in section.available_sections: return # Replace the name for the example param_section = section.get_section(self._original_name) self._replace_content(param_section) def _replace_content(self, section): content = section.getvalue().decode('utf-8') updated_content = content.replace( self._original_name, self._alias_name) section.clear_text() section.write(updated_content) # 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 = [ ('before-parameter-build.s3.UploadPart', convert_body_to_file_like_object, REGISTER_LAST), ('before-parameter-build.s3.PutObject', convert_body_to_file_like_object, REGISTER_LAST), ('creating-client-class', add_generate_presigned_url), ('creating-client-class.s3', add_generate_presigned_post), ('creating-client-class.iot-data', check_openssl_supports_tls_version_1_2), ('after-call.iam', json_decode_policies), ('after-call.ec2.GetConsoleOutput', decode_console_output), ('after-call.cloudformation.GetTemplate', json_decode_template_body), ('after-call.s3.GetBucketLocation', parse_get_bucket_location), ('before-parameter-build', generate_idempotent_uuid), ('before-parameter-build.s3', validate_bucket_name), ('before-parameter-build.s3.ListObjects', set_list_objects_encoding_type_url), ('before-call.s3.PutBucketTagging', calculate_md5), ('before-call.s3.PutBucketLifecycle', calculate_md5), ('before-call.s3.PutBucketLifecycleConfiguration', calculate_md5), ('before-call.s3.PutBucketCors', calculate_md5), ('before-call.s3.DeleteObjects', calculate_md5), ('before-call.s3.PutBucketReplication', calculate_md5), ('before-call.s3.PutObject', conditionally_calculate_md5), ('before-call.s3.UploadPart', conditionally_calculate_md5), ('before-call.s3.PutBucketAcl', conditionally_calculate_md5), ('before-call.s3.PutBucketLogging', conditionally_calculate_md5), ('before-call.s3.PutBucketNotification', conditionally_calculate_md5), ('before-call.s3.PutBucketPolicy', conditionally_calculate_md5), ('before-call.s3.PutBucketRequestPayment', conditionally_calculate_md5), ('before-call.s3.PutBucketVersioning', conditionally_calculate_md5), ('before-call.s3.PutBucketWebsite', conditionally_calculate_md5), ('before-call.s3.PutObjectAcl', conditionally_calculate_md5), ('before-parameter-build.s3.CopyObject', handle_copy_source_param), ('before-parameter-build.s3.UploadPartCopy', handle_copy_source_param), ('before-parameter-build.s3.CopyObject', validate_ascii_metadata), ('before-parameter-build.s3.PutObject', validate_ascii_metadata), ('before-parameter-build.s3.CreateMultipartUpload', validate_ascii_metadata), ('docs.*.s3.CopyObject.complete-section', document_copy_source_form), ('docs.*.s3.UploadPartCopy.complete-section', document_copy_source_form), ('before-call.s3', add_expect_header), ('before-call.glacier', add_glacier_version), ('before-call.apigateway', add_accept_header), ('before-call.glacier.UploadArchive', add_glacier_checksums), ('before-call.glacier.UploadMultipartPart', add_glacier_checksums), ('before-call.ec2.CopySnapshot', inject_presigned_url_ec2), ('before-call.rds.CopyDBSnapshot', inject_presigned_url_rds), ('before-call.rds.CreateDBInstanceReadReplica', inject_presigned_url_rds), ('request-created.machinelearning.Predict', switch_host_machinelearning), ('needs-retry.s3.UploadPartCopy', check_for_200_error, REGISTER_FIRST), ('needs-retry.s3.CopyObject', check_for_200_error, REGISTER_FIRST), ('needs-retry.s3.CompleteMultipartUpload', check_for_200_error, REGISTER_FIRST), ('service-data-loaded', register_retries_for_service), ('choose-signer.cognito-identity.GetId', disable_signing), ('choose-signer.cognito-identity.GetOpenIdToken', disable_signing), ('choose-signer.cognito-identity.UnlinkIdentity', disable_signing), ('choose-signer.cognito-identity.GetCredentialsForIdentity', disable_signing), ('choose-signer.sts.AssumeRoleWithSAML', disable_signing), ('choose-signer.sts.AssumeRoleWithWebIdentity', disable_signing), ('choose-signer.cognito-idp.ConfirmSignUp', disable_signing), ('choose-signer.cognito-idp.VerifyUserAttribute', disable_signing), ('choose-signer.cognito-idp.ForgotPassword', disable_signing), ('choose-signer.cognito-idp.SignUp', disable_signing), ('choose-signer.cognito-idp.UpdateUserAttributes', disable_signing), ('choose-signer.cognito-idp.ConfirmForgotPassword', disable_signing), ('choose-signer.cognito-idp.ResendConfirmationCode', disable_signing), ('choose-signer.cognito-idp.GetUserAttributeVerificationCode', disable_signing), ('choose-signer.cognito-idp.GetUser', disable_signing), ('choose-signer.cognito-idp.ChangePassword', disable_signing), ('choose-signer.cognito-idp.GetOpenIdConfiguration', disable_signing), ('choose-signer.cognito-idp.DeleteUser', disable_signing), ('choose-signer.cognito-idp.SetUserSettings', disable_signing), ('choose-signer.cognito-idp.GetJWKS', disable_signing), ('choose-signer.cognito-idp.DeleteUserAttributes', disable_signing), ('before-parameter-build.s3.HeadObject', sse_md5), ('before-parameter-build.s3.GetObject', sse_md5), ('before-parameter-build.s3.PutObject', sse_md5), ('before-parameter-build.s3.CopyObject', sse_md5), ('before-parameter-build.s3.CopyObject', copy_source_sse_md5), ('before-parameter-build.s3.CreateMultipartUpload', sse_md5), ('before-parameter-build.s3.UploadPart', sse_md5), ('before-parameter-build.s3.UploadPartCopy', sse_md5), ('before-parameter-build.s3.UploadPartCopy', copy_source_sse_md5), ('before-parameter-build.ec2.RunInstances', base64_encode_user_data), ('before-parameter-build.autoscaling.CreateLaunchConfiguration', base64_encode_user_data), ('before-parameter-build.route53', fix_route53_ids), ('before-parameter-build.glacier', inject_account_id), ('after-call.s3.ListObjects', decode_list_object), # Cloudsearchdomain search operation will be sent by HTTP POST ('request-created.cloudsearchdomain.Search', change_get_to_post), # Glacier documentation customizations ('docs.*.glacier.*.complete-section', AutoPopulatedParam('accountId', 'Note: this parameter is set to "-" by' 'default if no value is not specified.') .document_auto_populated_param), ('docs.*.glacier.UploadArchive.complete-section', AutoPopulatedParam('checksum').document_auto_populated_param), ('docs.*.glacier.UploadMultipartPart.complete-section', AutoPopulatedParam('checksum').document_auto_populated_param), ('docs.request-params.glacier.CompleteMultipartUpload.complete-section', document_glacier_tree_hash_checksum()), # Cloudformation documentation customizations ('docs.*.cloudformation.GetTemplate.complete-section', document_cloudformation_get_template_return_type), # UserData base64 encoding documentation customizations ('docs.*.ec2.RunInstances.complete-section', document_base64_encoding('UserData')), ('docs.*.autoscaling.CreateLaunchConfiguration.complete-section', document_base64_encoding('UserData')), # EC2 CopySnapshot documentation customizations ('docs.*.ec2.CopySnapshot.complete-section', AutoPopulatedParam('PresignedUrl').document_auto_populated_param), ('docs.*.ec2.CopySnapshot.complete-section', AutoPopulatedParam('DestinationRegion').document_auto_populated_param), # S3 SSE documentation modifications ('docs.*.s3.*.complete-section', AutoPopulatedParam('SSECustomerKeyMD5').document_auto_populated_param), # S3 SSE Copy Source documentation modifications ('docs.*.s3.*.complete-section', AutoPopulatedParam( 'CopySourceSSECustomerKeyMD5').document_auto_populated_param), # Add base64 information to Lambda ('docs.*.lambda.UpdateFunctionCode.complete-section', document_base64_encoding('ZipFile')), # The following S3 operations cannot actually accept a ContentMD5 ('docs.*.s3.*.complete-section', HideParamFromOperations( 's3', 'ContentMD5', ['DeleteObjects', 'PutBucketAcl', 'PutBucketCors', 'PutBucketLifecycle', 'PutBucketLogging', 'PutBucketNotification', 'PutBucketPolicy', 'PutBucketReplication', 'PutBucketRequestPayment', 'PutBucketTagging', 'PutBucketVersioning', 'PutBucketWebsite', 'PutObjectAcl']).hide_param) ] _add_parameter_aliases(BUILTIN_HANDLERS) botocore-1.5.7/botocore/response.py0000666454262600001440000001123613042511306020434 0ustar pysdk-ciamazon00000000000000# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import sys import xml.etree.cElementTree import logging from botocore import ScalarTypes from botocore.hooks import first_non_none_response from botocore.compat import json, set_socket_timeout, XMLParseError from botocore.exceptions import IncompleteReadError from botocore import parsers logger = logging.getLogger(__name__) class StreamingBody(object): """Wrapper class for an http response body. This provides a few additional conveniences that do not exist in the urllib3 model: * Set the timeout on the socket (i.e read() timeouts) * Auto validation of content length, if the amount of bytes we read does not match the content length, an exception is raised. """ def __init__(self, raw_stream, content_length): self._raw_stream = raw_stream self._content_length = content_length self._amount_read = 0 def set_socket_timeout(self, timeout): """Set the timeout seconds on the socket.""" # The problem we're trying to solve is to prevent .read() calls from # hanging. This can happen in rare cases. What we'd like to ideally # do is set a timeout on the .read() call so that callers can retry # the request. # Unfortunately, this isn't currently possible in requests. # See: https://github.com/kennethreitz/requests/issues/1803 # So what we're going to do is reach into the guts of the stream and # grab the socket object, which we can set the timeout on. We're # putting in a check here so in case this interface goes away, we'll # know. try: # To further complicate things, the way to grab the # underlying socket object from an HTTPResponse is different # in py2 and py3. So this code has been pushed to botocore.compat. set_socket_timeout(self._raw_stream, timeout) except AttributeError: logger.error("Cannot access the socket object of " "a streaming response. It's possible " "the interface has changed.", exc_info=True) raise def read(self, amt=None): """Read at most amt bytes from the stream. If the amt argument is omitted, read all data. """ chunk = self._raw_stream.read(amt) self._amount_read += len(chunk) if not chunk or amt is None: # If the server sends empty contents or # we ask to read all of the contents, then we know # we need to verify the content length. self._verify_content_length() return chunk def _verify_content_length(self): # See: https://github.com/kennethreitz/requests/issues/1855 # Basically, our http library doesn't do this for us, so we have # to do this ourself. if self._content_length is not None and \ self._amount_read != int(self._content_length): raise IncompleteReadError( actual_bytes=self._amount_read, expected_bytes=int(self._content_length)) def close(self): """Close the underlying http response stream.""" self._raw_stream.close() def get_response(operation_model, http_response): protocol = operation_model.metadata['protocol'] response_dict = { 'headers': http_response.headers, 'status_code': http_response.status_code, } # TODO: Unfortunately, we have to have error logic here. # If it looks like an error, in the streaming response case we # need to actually grab the contents. if response_dict['status_code'] >= 300: response_dict['body'] = http_response.content elif operation_model.has_streaming_output: response_dict['body'] = StreamingBody( http_response.raw, response_dict['headers'].get('content-length')) else: response_dict['body'] = http_response.content parser = parsers.create_parser(protocol) return http_response, parser.parse(response_dict, operation_model.output_shape) botocore-1.5.7/botocore/data/0000777454262600001440000000000013042511307017133 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/lightsail/0000777454262600001440000000000013042511307021113 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/lightsail/2016-11-28/0000777454262600001440000000000013042511307022151 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/lightsail/2016-11-28/paginators-1.json0000666454262600001440000000315713042511306025356 0ustar pysdk-ciamazon00000000000000{ "pagination": { "GetActiveNames": { "input_token": "pageToken", "output_token": "nextPageToken", "result_key": "activeNames" }, "GetBlueprints": { "input_token": "pageToken", "output_token": "nextPageToken", "result_key": "blueprints" }, "GetBundles": { "input_token": "pageToken", "output_token": "nextPageToken", "result_key": "bundles" }, "GetDomains": { "input_token": "pageToken", "output_token": "nextPageToken", "result_key": "domains" }, "GetInstanceSnapshots": { "input_token": "pageToken", "output_token": "nextPageToken", "result_key": "instanceSnapshots" }, "GetInstances": { "input_token": "pageToken", "output_token": "nextPageToken", "result_key": "instances" }, "GetKeyPairs": { "input_token": "pageToken", "output_token": "nextPageToken", "result_key": "keyPairs" }, "GetOperations": { "input_token": "pageToken", "output_token": "nextPageToken", "result_key": "operations" }, "GetStaticIps": { "input_token": "pageToken", "output_token": "nextPageToken", "result_key": "staticIps" }, "GetActiveNames": { "input_token": "pageToken", "output_token": "nextPageToken", "result_key": "activeNames" } } } botocore-1.5.7/botocore/data/lightsail/2016-11-28/service-2.json0000666454262600001440000031555713042511306024662 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-11-28", "endpointPrefix":"lightsail", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Amazon Lightsail", "signatureVersion":"v4", "targetPrefix":"Lightsail_20161128", "uid":"lightsail-2016-11-28" }, "operations":{ "AllocateStaticIp":{ "name":"AllocateStaticIp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AllocateStaticIpRequest"}, "output":{"shape":"AllocateStaticIpResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Allocates a static IP address.

" }, "AttachStaticIp":{ "name":"AttachStaticIp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachStaticIpRequest"}, "output":{"shape":"AttachStaticIpResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Attaches a static IP address to a specific Amazon Lightsail instance.

" }, "CloseInstancePublicPorts":{ "name":"CloseInstancePublicPorts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CloseInstancePublicPortsRequest"}, "output":{"shape":"CloseInstancePublicPortsResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Closes the public ports on a specific Amazon Lightsail instance.

" }, "CreateDomain":{ "name":"CreateDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDomainRequest"}, "output":{"shape":"CreateDomainResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Creates a domain resource for the specified domain (e.g., example.com).

" }, "CreateDomainEntry":{ "name":"CreateDomainEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDomainEntryRequest"}, "output":{"shape":"CreateDomainEntryResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.

" }, "CreateInstanceSnapshot":{ "name":"CreateInstanceSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInstanceSnapshotRequest"}, "output":{"shape":"CreateInstanceSnapshotResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Creates a snapshot of a specific virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot.

" }, "CreateInstances":{ "name":"CreateInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInstancesRequest"}, "output":{"shape":"CreateInstancesResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Creates one or more Amazon Lightsail virtual private servers, or instances.

" }, "CreateInstancesFromSnapshot":{ "name":"CreateInstancesFromSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInstancesFromSnapshotRequest"}, "output":{"shape":"CreateInstancesFromSnapshotResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.

" }, "CreateKeyPair":{ "name":"CreateKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateKeyPairRequest"}, "output":{"shape":"CreateKeyPairResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Creates sn SSH key pair.

" }, "DeleteDomain":{ "name":"DeleteDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDomainRequest"}, "output":{"shape":"DeleteDomainResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Deletes the specified domain recordset and all of its domain records.

" }, "DeleteDomainEntry":{ "name":"DeleteDomainEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDomainEntryRequest"}, "output":{"shape":"DeleteDomainEntryResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Deletes a specific domain entry.

" }, "DeleteInstance":{ "name":"DeleteInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteInstanceRequest"}, "output":{"shape":"DeleteInstanceResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Deletes a specific Amazon Lightsail virtual private server, or instance.

" }, "DeleteInstanceSnapshot":{ "name":"DeleteInstanceSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteInstanceSnapshotRequest"}, "output":{"shape":"DeleteInstanceSnapshotResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Deletes a specific snapshot of a virtual private server (or instance).

" }, "DeleteKeyPair":{ "name":"DeleteKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteKeyPairRequest"}, "output":{"shape":"DeleteKeyPairResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Deletes a specific SSH key pair.

" }, "DetachStaticIp":{ "name":"DetachStaticIp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachStaticIpRequest"}, "output":{"shape":"DetachStaticIpResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Detaches a static IP from the Amazon Lightsail instance to which it is attached.

" }, "DownloadDefaultKeyPair":{ "name":"DownloadDefaultKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DownloadDefaultKeyPairRequest"}, "output":{"shape":"DownloadDefaultKeyPairResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Downloads the default SSH key pair from the user's account.

" }, "GetActiveNames":{ "name":"GetActiveNames", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetActiveNamesRequest"}, "output":{"shape":"GetActiveNamesResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns the names of all active (not deleted) resources.

" }, "GetBlueprints":{ "name":"GetBlueprints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetBlueprintsRequest"}, "output":{"shape":"GetBlueprintsResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns the list of available instance images, or blueprints. You can use a blueprint to create a new virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.

" }, "GetBundles":{ "name":"GetBundles", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetBundlesRequest"}, "output":{"shape":"GetBundlesResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).

" }, "GetDomain":{ "name":"GetDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDomainRequest"}, "output":{"shape":"GetDomainResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns information about a specific domain recordset.

" }, "GetDomains":{ "name":"GetDomains", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDomainsRequest"}, "output":{"shape":"GetDomainsResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns a list of all domains in the user's account.

" }, "GetInstance":{ "name":"GetInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInstanceRequest"}, "output":{"shape":"GetInstanceResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns information about a specific Amazon Lightsail instance, which is a virtual private server.

" }, "GetInstanceAccessDetails":{ "name":"GetInstanceAccessDetails", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInstanceAccessDetailsRequest"}, "output":{"shape":"GetInstanceAccessDetailsResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.

" }, "GetInstanceMetricData":{ "name":"GetInstanceMetricData", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInstanceMetricDataRequest"}, "output":{"shape":"GetInstanceMetricDataResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.

" }, "GetInstancePortStates":{ "name":"GetInstancePortStates", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInstancePortStatesRequest"}, "output":{"shape":"GetInstancePortStatesResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns the port states for a specific virtual private server, or instance.

" }, "GetInstanceSnapshot":{ "name":"GetInstanceSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInstanceSnapshotRequest"}, "output":{"shape":"GetInstanceSnapshotResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns information about a specific instance snapshot.

" }, "GetInstanceSnapshots":{ "name":"GetInstanceSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInstanceSnapshotsRequest"}, "output":{"shape":"GetInstanceSnapshotsResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns all instance snapshots for the user's account.

" }, "GetInstanceState":{ "name":"GetInstanceState", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInstanceStateRequest"}, "output":{"shape":"GetInstanceStateResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns the state of a specific instance. Works on one instance at a time.

" }, "GetInstances":{ "name":"GetInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInstancesRequest"}, "output":{"shape":"GetInstancesResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns information about all Amazon Lightsail virtual private servers, or instances.

" }, "GetKeyPair":{ "name":"GetKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetKeyPairRequest"}, "output":{"shape":"GetKeyPairResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns information about a specific key pair.

" }, "GetKeyPairs":{ "name":"GetKeyPairs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetKeyPairsRequest"}, "output":{"shape":"GetKeyPairsResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns information about all key pairs in the user's account.

" }, "GetOperation":{ "name":"GetOperation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetOperationRequest"}, "output":{"shape":"GetOperationResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.

" }, "GetOperations":{ "name":"GetOperations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetOperationsRequest"}, "output":{"shape":"GetOperationsResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns information about all operations.

Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request.

" }, "GetOperationsForResource":{ "name":"GetOperationsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetOperationsForResourceRequest"}, "output":{"shape":"GetOperationsForResourceResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Gets operations for a specific resource (e.g., an instance or a static IP).

" }, "GetRegions":{ "name":"GetRegions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRegionsRequest"}, "output":{"shape":"GetRegionsResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns a list of all valid regions for Amazon Lightsail.

" }, "GetStaticIp":{ "name":"GetStaticIp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetStaticIpRequest"}, "output":{"shape":"GetStaticIpResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns information about a specific static IP.

" }, "GetStaticIps":{ "name":"GetStaticIps", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetStaticIpsRequest"}, "output":{"shape":"GetStaticIpsResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns information about all static IPs in the user's account.

" }, "ImportKeyPair":{ "name":"ImportKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportKeyPairRequest"}, "output":{"shape":"ImportKeyPairResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Imports a public SSH key from a specific key pair.

" }, "IsVpcPeered":{ "name":"IsVpcPeered", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"IsVpcPeeredRequest"}, "output":{"shape":"IsVpcPeeredResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Returns a Boolean value indicating whether your Lightsail VPC is peered.

" }, "OpenInstancePublicPorts":{ "name":"OpenInstancePublicPorts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"OpenInstancePublicPortsRequest"}, "output":{"shape":"OpenInstancePublicPortsResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Adds public ports to an Amazon Lightsail instance.

" }, "PeerVpc":{ "name":"PeerVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PeerVpcRequest"}, "output":{"shape":"PeerVpcResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Tries to peer the Lightsail VPC with the user's default VPC.

" }, "RebootInstance":{ "name":"RebootInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootInstanceRequest"}, "output":{"shape":"RebootInstanceResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Restarts a specific instance. When your Amazon Lightsail instance is finished rebooting, Lightsail assigns a new public IP address. To use the same IP address after restarting, create a static IP address and attach it to the instance.

" }, "ReleaseStaticIp":{ "name":"ReleaseStaticIp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReleaseStaticIpRequest"}, "output":{"shape":"ReleaseStaticIpResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Deletes a specific static IP from your account.

" }, "StartInstance":{ "name":"StartInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartInstanceRequest"}, "output":{"shape":"StartInstanceResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.

" }, "StopInstance":{ "name":"StopInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopInstanceRequest"}, "output":{"shape":"StopInstanceResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Stops a specific Amazon Lightsail instance that is currently running.

" }, "UnpeerVpc":{ "name":"UnpeerVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnpeerVpcRequest"}, "output":{"shape":"UnpeerVpcResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Attempts to unpeer the Lightsail VPC from the user's default VPC.

" }, "UpdateDomainEntry":{ "name":"UpdateDomainEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDomainEntryRequest"}, "output":{"shape":"UpdateDomainEntryResult"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidInputException"}, {"shape":"NotFoundException"}, {"shape":"OperationFailureException"}, {"shape":"AccessDeniedException"}, {"shape":"AccountSetupInProgressException"}, {"shape":"UnauthenticatedException"} ], "documentation":"

Updates a domain recordset after it is created.

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "code":{"shape":"string"}, "docs":{"shape":"string"}, "message":{"shape":"string"}, "tip":{"shape":"string"} }, "documentation":"

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.

", "exception":true }, "AccessDirection":{ "type":"string", "enum":[ "inbound", "outbound" ] }, "AccountSetupInProgressException":{ "type":"structure", "members":{ "code":{"shape":"string"}, "docs":{"shape":"string"}, "message":{"shape":"string"}, "tip":{"shape":"string"} }, "documentation":"

Lightsail throws this exception when an account is still in the setup in progress state.

", "exception":true }, "AllocateStaticIpRequest":{ "type":"structure", "required":["staticIpName"], "members":{ "staticIpName":{ "shape":"ResourceName", "documentation":"

The name of the static IP address.

" } } }, "AllocateStaticIpResult":{ "type":"structure", "members":{ "operations":{ "shape":"OperationList", "documentation":"

An array of key-value pairs containing information about the static IP address you allocated.

" } } }, "AttachStaticIpRequest":{ "type":"structure", "required":[ "staticIpName", "instanceName" ], "members":{ "staticIpName":{ "shape":"ResourceName", "documentation":"

The name of the static IP.

" }, "instanceName":{ "shape":"ResourceName", "documentation":"

The instance name to which you want to attach the static IP address.

" } } }, "AttachStaticIpResult":{ "type":"structure", "members":{ "operations":{ "shape":"OperationList", "documentation":"

An array of key-value pairs containing information about your API operations.

" } } }, "AvailabilityZone":{ "type":"structure", "members":{ "zoneName":{ "shape":"NonEmptyString", "documentation":"

The name of the Availability Zone.

" }, "state":{ "shape":"NonEmptyString", "documentation":"

The state of the Availability Zone.

" } }, "documentation":"

Describes an Availability Zone.

" }, "AvailabilityZoneList":{ "type":"list", "member":{"shape":"AvailabilityZone"} }, "Base64":{"type":"string"}, "Blueprint":{ "type":"structure", "members":{ "blueprintId":{ "shape":"NonEmptyString", "documentation":"

The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).

" }, "name":{ "shape":"ResourceName", "documentation":"

The friendly name of the blueprint (e.g., Amazon Linux).

" }, "group":{ "shape":"NonEmptyString", "documentation":"

The group name of the blueprint (e.g., amazon-linux).

" }, "type":{ "shape":"BlueprintType", "documentation":"

The type of the blueprint (e.g., os or app).

" }, "description":{ "shape":"string", "documentation":"

The description of the blueprint.

" }, "isActive":{ "shape":"boolean", "documentation":"

A Boolean value indicating whether the blueprint is active. When you update your blueprints, you will inactivate old blueprints and keep the most recent versions active.

" }, "minPower":{ "shape":"integer", "documentation":"

The minimum machine size required to run this blueprint. 0 indicates that the blueprint runs on all instances.

" }, "version":{ "shape":"string", "documentation":"

The version number of the operating system, application, or stack (e.g., 2016.03.0).

" }, "versionCode":{ "shape":"string", "documentation":"

The version code.

" }, "productUrl":{ "shape":"string", "documentation":"

The product URL to learn more about the image or blueprint.

" }, "licenseUrl":{ "shape":"string", "documentation":"

The end-user license agreement URL for the image or blueprint.

" } }, "documentation":"

Describes a blueprint (a virtual private server image).

" }, "BlueprintList":{ "type":"list", "member":{"shape":"Blueprint"} }, "BlueprintType":{ "type":"string", "enum":[ "os", "app" ] }, "Bundle":{ "type":"structure", "members":{ "price":{ "shape":"float", "documentation":"

The price in US dollars (e.g., 5.0).

" }, "cpuCount":{ "shape":"integer", "documentation":"

The number of vCPUs included in the bundle (e.g., 2).

" }, "diskSizeInGb":{ "shape":"integer", "documentation":"

The size of the SSD (e.g., 30).

" }, "bundleId":{ "shape":"NonEmptyString", "documentation":"

The bundle ID (e.g., micro_1_0).

" }, "instanceType":{ "shape":"string", "documentation":"

The Amazon EC2 instance type (e.g., t2.micro).

" }, "isActive":{ "shape":"boolean", "documentation":"

A Boolean value indicating whether the bundle is active.

" }, "name":{ "shape":"string", "documentation":"

A friendly name for the bundle (e.g., Micro).

" }, "power":{ "shape":"integer", "documentation":"

The power of the bundle (e.g., 500).

" }, "ramSizeInGb":{ "shape":"float", "documentation":"

The amount of RAM in GB (e.g., 2.0).

" }, "transferPerMonthInGb":{ "shape":"integer", "documentation":"

The data transfer rate per month in GB (e.g., 2000).

" } }, "documentation":"

Describes a bundle, which is a set of specs describing your virtual private server (or instance).

" }, "BundleList":{ "type":"list", "member":{"shape":"Bundle"} }, "CloseInstancePublicPortsRequest":{ "type":"structure", "required":[ "portInfo", "instanceName" ], "members":{ "portInfo":{ "shape":"PortInfo", "documentation":"

Information about the public port you are trying to close.

" }, "instanceName":{ "shape":"ResourceName", "documentation":"

The name of the instance on which you're attempting to close the public ports.

" } } }, "CloseInstancePublicPortsResult":{ "type":"structure", "members":{ "operation":{ "shape":"Operation", "documentation":"

An array of key-value pairs that contains information about the operation.

" } } }, "CreateDomainEntryRequest":{ "type":"structure", "required":[ "domainName", "domainEntry" ], "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The domain name (e.g., example.com) for which you want to create the domain entry.

" }, "domainEntry":{ "shape":"DomainEntry", "documentation":"

An array of key-value pairs containing information about the domain entry request.

" } } }, "CreateDomainEntryResult":{ "type":"structure", "members":{ "operation":{ "shape":"Operation", "documentation":"

An array of key-value pairs containing information about the operation.

" } } }, "CreateDomainRequest":{ "type":"structure", "required":["domainName"], "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The domain name to manage (e.g., example.com).

You cannot register a new domain name using Lightsail. You must register a domain name using Amazon Route 53 or another domain name registrar. If you have already registered your domain, you can enter its name in this parameter to manage the DNS records for that domain.

" } } }, "CreateDomainResult":{ "type":"structure", "members":{ "operation":{ "shape":"Operation", "documentation":"

An array of key-value pairs containing information about the domain resource you created.

" } } }, "CreateInstanceSnapshotRequest":{ "type":"structure", "required":[ "instanceSnapshotName", "instanceName" ], "members":{ "instanceSnapshotName":{ "shape":"ResourceName", "documentation":"

The name for your new snapshot.

" }, "instanceName":{ "shape":"ResourceName", "documentation":"

The Lightsail instance on which to base your snapshot.

" } } }, "CreateInstanceSnapshotResult":{ "type":"structure", "members":{ "operations":{ "shape":"OperationList", "documentation":"

An array of key-value pairs containing information about the results of your create instances snapshot request.

" } } }, "CreateInstancesFromSnapshotRequest":{ "type":"structure", "required":[ "instanceNames", "availabilityZone", "instanceSnapshotName", "bundleId" ], "members":{ "instanceNames":{ "shape":"StringList", "documentation":"

The names for your new instances.

" }, "availabilityZone":{ "shape":"string", "documentation":"

The Availability Zone where you want to create your instances. Use the following formatting: us-east-1a (case sensitive).

" }, "instanceSnapshotName":{ "shape":"ResourceName", "documentation":"

The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.

" }, "bundleId":{ "shape":"NonEmptyString", "documentation":"

The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).

" }, "userData":{ "shape":"string", "documentation":"

You can create a launch script that configures a server with additional user data. For example, apt-get –y update.

Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Dev Guide.

" }, "keyPairName":{ "shape":"ResourceName", "documentation":"

The name for your key pair.

" } } }, "CreateInstancesFromSnapshotResult":{ "type":"structure", "members":{ "operations":{ "shape":"OperationList", "documentation":"

An array of key-value pairs containing information about the results of your create instances from snapshot request.

" } } }, "CreateInstancesRequest":{ "type":"structure", "required":[ "instanceNames", "availabilityZone", "blueprintId", "bundleId" ], "members":{ "instanceNames":{ "shape":"StringList", "documentation":"

The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: [\"MyFirstInstance\",\"MySecondInstance\"]

" }, "availabilityZone":{ "shape":"string", "documentation":"

The Availability Zone in which to create your instance. Use the following format: us-east-1a (case sensitive).

" }, "customImageName":{ "shape":"ResourceName", "documentation":"

The name for your custom image.

" }, "blueprintId":{ "shape":"NonEmptyString", "documentation":"

The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0). Use the get blueprints operation to return a list of available images (or blueprints).

" }, "bundleId":{ "shape":"NonEmptyString", "documentation":"

The bundle of specification information for your virtual private server (or instance), including the pricing plan (e.g., micro_1_0).

" }, "userData":{ "shape":"string", "documentation":"

A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get –y update.

Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Dev Guide.

" }, "keyPairName":{ "shape":"ResourceName", "documentation":"

The name of your key pair.

" } } }, "CreateInstancesResult":{ "type":"structure", "members":{ "operations":{ "shape":"OperationList", "documentation":"

An array of key-value pairs containing information about the results of your create instances request.

" } } }, "CreateKeyPairRequest":{ "type":"structure", "required":["keyPairName"], "members":{ "keyPairName":{ "shape":"ResourceName", "documentation":"

The name for your new key pair.

" } } }, "CreateKeyPairResult":{ "type":"structure", "members":{ "keyPair":{ "shape":"KeyPair", "documentation":"

An array of key-value pairs containing information about the new key pair you just created.

" }, "publicKeyBase64":{ "shape":"Base64", "documentation":"

A base64-encoded public key of the ssh-rsa type.

" }, "privateKeyBase64":{ "shape":"Base64", "documentation":"

A base64-encoded RSA private key.

" }, "operation":{ "shape":"Operation", "documentation":"

An array of key-value pairs containing information about the results of your create key pair request.

" } } }, "DeleteDomainEntryRequest":{ "type":"structure", "required":[ "domainName", "domainEntry" ], "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The name of the domain entry to delete.

" }, "domainEntry":{ "shape":"DomainEntry", "documentation":"

An array of key-value pairs containing information about your domain entries.

" } } }, "DeleteDomainEntryResult":{ "type":"structure", "members":{ "operation":{ "shape":"Operation", "documentation":"

An array of key-value pairs containing information about the results of your delete domain entry request.

" } } }, "DeleteDomainRequest":{ "type":"structure", "required":["domainName"], "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The specific domain name to delete.

" } } }, "DeleteDomainResult":{ "type":"structure", "members":{ "operation":{ "shape":"Operation", "documentation":"

An array of key-value pairs containing information about the results of your delete domain request.

" } } }, "DeleteInstanceRequest":{ "type":"structure", "required":["instanceName"], "members":{ "instanceName":{ "shape":"ResourceName", "documentation":"

The name of the instance to delete.

" } } }, "DeleteInstanceResult":{ "type":"structure", "members":{ "operations":{ "shape":"OperationList", "documentation":"

An array of key-value pairs containing information about the results of your delete instance request.

" } } }, "DeleteInstanceSnapshotRequest":{ "type":"structure", "required":["instanceSnapshotName"], "members":{ "instanceSnapshotName":{ "shape":"ResourceName", "documentation":"

The name of the snapshot to delete.

" } } }, "DeleteInstanceSnapshotResult":{ "type":"structure", "members":{ "operations":{ "shape":"OperationList", "documentation":"

An array of key-value pairs containing information about the results of your delete instance snapshot request.

" } } }, "DeleteKeyPairRequest":{ "type":"structure", "required":["keyPairName"], "members":{ "keyPairName":{ "shape":"ResourceName", "documentation":"

The name of the key pair to delete.

" } } }, "DeleteKeyPairResult":{ "type":"structure", "members":{ "operation":{ "shape":"Operation", "documentation":"

An array of key-value pairs containing information about the results of your delete key pair request.

" } } }, "DetachStaticIpRequest":{ "type":"structure", "required":["staticIpName"], "members":{ "staticIpName":{ "shape":"ResourceName", "documentation":"

The name of the static IP to detach from the instance.

" } } }, "DetachStaticIpResult":{ "type":"structure", "members":{ "operations":{ "shape":"OperationList", "documentation":"

An array of key-value pairs containing information about the results of your detach static IP request.

" } } }, "Disk":{ "type":"structure", "members":{ "name":{ "shape":"ResourceName", "documentation":"

The name of the disk.

" }, "arn":{ "shape":"NonEmptyString", "documentation":"

The Amazon Resource Name (ARN) of the disk.

" }, "supportCode":{ "shape":"string", "documentation":"

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

" }, "createdAt":{ "shape":"IsoDate", "documentation":"

The date when the disk was created.

" }, "location":{ "shape":"ResourceLocation", "documentation":"

The region and Availability Zone where the disk is located.

" }, "resourceType":{ "shape":"ResourceType", "documentation":"

The resource type of the disk.

" }, "sizeInGb":{ "shape":"integer", "documentation":"

The size of the disk in GB.

" }, "gbInUse":{ "shape":"integer", "documentation":"

The number of GB in use by the disk.

" }, "isSystemDisk":{ "shape":"boolean", "documentation":"

A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

" }, "iops":{ "shape":"integer", "documentation":"

The input/output operations per second (IOPS) of the disk.

" }, "path":{ "shape":"string", "documentation":"

The disk path.

" }, "attachedTo":{ "shape":"string", "documentation":"

The resources to which the disk is attached.

" }, "isAttached":{ "shape":"boolean", "documentation":"

A Boolean value indicating whether the disk is attached.

" }, "attachmentState":{ "shape":"string", "documentation":"

The attachment state of the disk.

" } }, "documentation":"

Describes the hard disk (an SSD).

" }, "DiskList":{ "type":"list", "member":{"shape":"Disk"} }, "Domain":{ "type":"structure", "members":{ "name":{ "shape":"ResourceName", "documentation":"

The name of the domain.

" }, "arn":{ "shape":"NonEmptyString", "documentation":"

The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).

" }, "supportCode":{ "shape":"string", "documentation":"

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

" }, "createdAt":{ "shape":"IsoDate", "documentation":"

The date when the domain recordset was created.

" }, "location":{ "shape":"ResourceLocation", "documentation":"

The AWS Region and Availability Zones where the domain recordset was created.

" }, "resourceType":{ "shape":"ResourceType", "documentation":"

The resource type.

" }, "domainEntries":{ "shape":"DomainEntryList", "documentation":"

An array of key-value pairs containing information about the domain entries.

" } }, "documentation":"

Describes a domain where you are storing recordsets in Lightsail.

" }, "DomainEntry":{ "type":"structure", "members":{ "id":{ "shape":"NonEmptyString", "documentation":"

The ID of the domain recordset entry.

" }, "name":{ "shape":"DomainName", "documentation":"

The name of the domain.

" }, "target":{ "shape":"string", "documentation":"

The target AWS name server (e.g., ns-111.awsdns-22.com.).

" }, "type":{ "shape":"DomainEntryType", "documentation":"

The type of domain entry (e.g., SOA or NS).

" }, "options":{ "shape":"DomainEntryOptions", "documentation":"

The options for the domain entry.

" } }, "documentation":"

Describes a domain recordset entry.

" }, "DomainEntryList":{ "type":"list", "member":{"shape":"DomainEntry"} }, "DomainEntryOptions":{ "type":"map", "key":{"shape":"DomainEntryOptionsKeys"}, "value":{"shape":"string"} }, "DomainEntryOptionsKeys":{"type":"string"}, "DomainEntryType":{"type":"string"}, "DomainList":{ "type":"list", "member":{"shape":"Domain"} }, "DomainName":{"type":"string"}, "DownloadDefaultKeyPairRequest":{ "type":"structure", "members":{ } }, "DownloadDefaultKeyPairResult":{ "type":"structure", "members":{ "publicKeyBase64":{ "shape":"Base64", "documentation":"

A base64-encoded public key of the ssh-rsa type.

" }, "privateKeyBase64":{ "shape":"Base64", "documentation":"

A base64-encoded RSA private key.

" } } }, "GetActiveNamesRequest":{ "type":"structure", "members":{ "pageToken":{ "shape":"string", "documentation":"

A token used for paginating results from your get active names request.

" } } }, "GetActiveNamesResult":{ "type":"structure", "members":{ "activeNames":{ "shape":"StringList", "documentation":"

The list of active names returned by the get active names request.

" }, "nextPageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get active names request.

" } } }, "GetBlueprintsRequest":{ "type":"structure", "members":{ "includeInactive":{ "shape":"boolean", "documentation":"

A Boolean value indicating whether to include inactive results in your request.

" }, "pageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get blueprints request.

" } } }, "GetBlueprintsResult":{ "type":"structure", "members":{ "blueprints":{ "shape":"BlueprintList", "documentation":"

An array of key-value pairs that contains information about the available blueprints.

" }, "nextPageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get blueprints request.

" } } }, "GetBundlesRequest":{ "type":"structure", "members":{ "includeInactive":{ "shape":"boolean", "documentation":"

A Boolean value that indicates whether to include inactive bundle results in your request.

" }, "pageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get bundles request.

" } } }, "GetBundlesResult":{ "type":"structure", "members":{ "bundles":{ "shape":"BundleList", "documentation":"

An array of key-value pairs that contains information about the available bundles.

" }, "nextPageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get active names request.

" } } }, "GetDomainRequest":{ "type":"structure", "required":["domainName"], "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The domain name for which your want to return information about.

" } } }, "GetDomainResult":{ "type":"structure", "members":{ "domain":{ "shape":"Domain", "documentation":"

An array of key-value pairs containing information about your get domain request.

" } } }, "GetDomainsRequest":{ "type":"structure", "members":{ "pageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get domains request.

" } } }, "GetDomainsResult":{ "type":"structure", "members":{ "domains":{ "shape":"DomainList", "documentation":"

An array of key-value pairs containing information about each of the domain entries in the user's account.

" }, "nextPageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get active names request.

" } } }, "GetInstanceAccessDetailsRequest":{ "type":"structure", "required":["instanceName"], "members":{ "instanceName":{ "shape":"ResourceName", "documentation":"

The name of the instance to access.

" }, "protocol":{ "shape":"InstanceAccessProtocol", "documentation":"

The protocol to use to connect to your instance. Defaults to ssh.

" } } }, "GetInstanceAccessDetailsResult":{ "type":"structure", "members":{ "accessDetails":{ "shape":"InstanceAccessDetails", "documentation":"

An array of key-value pairs containing information about a get instance access request.

" } } }, "GetInstanceMetricDataRequest":{ "type":"structure", "required":[ "instanceName", "metricName", "period", "startTime", "endTime", "unit", "statistics" ], "members":{ "instanceName":{ "shape":"ResourceName", "documentation":"

The name of the instance for which you want to get metrics data.

" }, "metricName":{ "shape":"InstanceMetricName", "documentation":"

The metric name to get data about.

" }, "period":{ "shape":"MetricPeriod", "documentation":"

The time period for which you are requesting data.

" }, "startTime":{ "shape":"timestamp", "documentation":"

The start time of the time period.

" }, "endTime":{ "shape":"timestamp", "documentation":"

The end time of the time period.

" }, "unit":{ "shape":"MetricUnit", "documentation":"

The unit. The list of valid values is below.

" }, "statistics":{ "shape":"MetricStatisticList", "documentation":"

The instance statistics.

" } } }, "GetInstanceMetricDataResult":{ "type":"structure", "members":{ "metricName":{ "shape":"InstanceMetricName", "documentation":"

The metric name to return data for.

" }, "metricData":{ "shape":"MetricDatapointList", "documentation":"

An array of key-value pairs containing information about the results of your get instance metric data request.

" } } }, "GetInstancePortStatesRequest":{ "type":"structure", "required":["instanceName"], "members":{ "instanceName":{ "shape":"ResourceName", "documentation":"

The name of the instance.

" } } }, "GetInstancePortStatesResult":{ "type":"structure", "members":{ "portStates":{ "shape":"PortStateList", "documentation":"

Information about the port states resulting from your request.

" } } }, "GetInstanceRequest":{ "type":"structure", "required":["instanceName"], "members":{ "instanceName":{ "shape":"ResourceName", "documentation":"

The name of the instance.

" } } }, "GetInstanceResult":{ "type":"structure", "members":{ "instance":{ "shape":"Instance", "documentation":"

An array of key-value pairs containing information about the specified instance.

" } } }, "GetInstanceSnapshotRequest":{ "type":"structure", "required":["instanceSnapshotName"], "members":{ "instanceSnapshotName":{ "shape":"ResourceName", "documentation":"

The name of the snapshot for which you are requesting information.

" } } }, "GetInstanceSnapshotResult":{ "type":"structure", "members":{ "instanceSnapshot":{ "shape":"InstanceSnapshot", "documentation":"

An array of key-value pairs containing information about the results of your get instance snapshot request.

" } } }, "GetInstanceSnapshotsRequest":{ "type":"structure", "members":{ "pageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get instance snapshots request.

" } } }, "GetInstanceSnapshotsResult":{ "type":"structure", "members":{ "instanceSnapshots":{ "shape":"InstanceSnapshotList", "documentation":"

An array of key-value pairs containing information about the results of your get instance snapshots request.

" }, "nextPageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get instance snapshots request.

" } } }, "GetInstanceStateRequest":{ "type":"structure", "required":["instanceName"], "members":{ "instanceName":{ "shape":"ResourceName", "documentation":"

The name of the instance to get state information about.

" } } }, "GetInstanceStateResult":{ "type":"structure", "members":{ "state":{ "shape":"InstanceState", "documentation":"

The state of the instance.

" } } }, "GetInstancesRequest":{ "type":"structure", "members":{ "pageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get instances request.

" } } }, "GetInstancesResult":{ "type":"structure", "members":{ "instances":{ "shape":"InstanceList", "documentation":"

An array of key-value pairs containing information about your instances.

" }, "nextPageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get instances request.

" } } }, "GetKeyPairRequest":{ "type":"structure", "required":["keyPairName"], "members":{ "keyPairName":{ "shape":"ResourceName", "documentation":"

The name of the key pair for which you are requesting information.

" } } }, "GetKeyPairResult":{ "type":"structure", "members":{ "keyPair":{ "shape":"KeyPair", "documentation":"

An array of key-value pairs containing information about the key pair.

" } } }, "GetKeyPairsRequest":{ "type":"structure", "members":{ "pageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get key pairs request.

" } } }, "GetKeyPairsResult":{ "type":"structure", "members":{ "keyPairs":{ "shape":"KeyPairList", "documentation":"

An array of key-value pairs containing information about the key pairs.

" }, "nextPageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get key pairs request.

" } } }, "GetOperationRequest":{ "type":"structure", "required":["operationId"], "members":{ "operationId":{ "shape":"NonEmptyString", "documentation":"

A GUID used to identify the operation.

" } } }, "GetOperationResult":{ "type":"structure", "members":{ "operation":{ "shape":"Operation", "documentation":"

An array of key-value pairs containing information about the results of your get operation request.

" } } }, "GetOperationsForResourceRequest":{ "type":"structure", "required":["resourceName"], "members":{ "resourceName":{ "shape":"ResourceName", "documentation":"

The name of the resource for which you are requesting information.

" }, "pageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get operations for resource request.

" } } }, "GetOperationsForResourceResult":{ "type":"structure", "members":{ "operations":{ "shape":"OperationList", "documentation":"

An array of key-value pairs containing information about the results of your get operations for resource request.

" }, "nextPageCount":{ "shape":"string", "documentation":"

Returns the number of pages of results that remain.

" } } }, "GetOperationsRequest":{ "type":"structure", "members":{ "pageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get operations request.

" } } }, "GetOperationsResult":{ "type":"structure", "members":{ "operations":{ "shape":"OperationList", "documentation":"

An array of key-value pairs containing information about the results of your get operations request.

" }, "nextPageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get operations request.

" } } }, "GetRegionsRequest":{ "type":"structure", "members":{ "includeAvailabilityZones":{ "shape":"boolean", "documentation":"

A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: e.g., us-east-1a.

" } } }, "GetRegionsResult":{ "type":"structure", "members":{ "regions":{ "shape":"RegionList", "documentation":"

An array of key-value pairs containing information about your get regions request.

" } } }, "GetStaticIpRequest":{ "type":"structure", "required":["staticIpName"], "members":{ "staticIpName":{ "shape":"ResourceName", "documentation":"

The name of the static IP in Lightsail.

" } } }, "GetStaticIpResult":{ "type":"structure", "members":{ "staticIp":{ "shape":"StaticIp", "documentation":"

An array of key-value pairs containing information about the requested static IP.

" } } }, "GetStaticIpsRequest":{ "type":"structure", "members":{ "pageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get static IPs request.

" } } }, "GetStaticIpsResult":{ "type":"structure", "members":{ "staticIps":{ "shape":"StaticIpList", "documentation":"

An array of key-value pairs containing information about your get static IPs request.

" }, "nextPageToken":{ "shape":"string", "documentation":"

A token used for advancing to the next page of results from your get static IPs request.

" } } }, "ImportKeyPairRequest":{ "type":"structure", "required":[ "keyPairName", "publicKeyBase64" ], "members":{ "keyPairName":{ "shape":"ResourceName", "documentation":"

The name of the key pair for which you want to import the public key.

" }, "publicKeyBase64":{ "shape":"Base64", "documentation":"

A base64-encoded public key of the ssh-rsa type.

" } } }, "ImportKeyPairResult":{ "type":"structure", "members":{ "operation":{ "shape":"Operation", "documentation":"

An array of key-value pairs containing information about the request operation.

" } } }, "Instance":{ "type":"structure", "members":{ "name":{ "shape":"ResourceName", "documentation":"

The name the user gave the instance (e.g., Amazon_Linux-1GB-Virginia-1).

" }, "arn":{ "shape":"NonEmptyString", "documentation":"

The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-1:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).

" }, "supportCode":{ "shape":"string", "documentation":"

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

" }, "createdAt":{ "shape":"IsoDate", "documentation":"

The timestamp when the instance was created (e.g., 1479734909.17).

" }, "location":{ "shape":"ResourceLocation", "documentation":"

The region name and availability zone where the instance is located.

" }, "resourceType":{ "shape":"ResourceType", "documentation":"

The type of resource (usually Instance).

" }, "blueprintId":{ "shape":"NonEmptyString", "documentation":"

The blueprint ID (e.g., os_amlinux_2016_03).

" }, "blueprintName":{ "shape":"NonEmptyString", "documentation":"

The friendly name of the blueprint (e.g., Amazon Linux).

" }, "bundleId":{ "shape":"NonEmptyString", "documentation":"

The bundle for the instance (e.g., micro_1_0).

" }, "isStaticIp":{ "shape":"boolean", "documentation":"

A Boolean value indicating whether this instance has a static IP assigned to it.

" }, "privateIpAddress":{ "shape":"IpAddress", "documentation":"

The private IP address of the instance.

" }, "publicIpAddress":{ "shape":"IpAddress", "documentation":"

The public IP address of the instance.

" }, "ipv6Address":{ "shape":"IpV6Address", "documentation":"

The IPv6 address of the instance.

" }, "hardware":{ "shape":"InstanceHardware", "documentation":"

The size of the vCPU and the amount of RAM for the instance.

" }, "networking":{ "shape":"InstanceNetworking", "documentation":"

Information about the public ports and monthly data transfer rates for the instance.

" }, "state":{ "shape":"InstanceState", "documentation":"

The status code and the state (e.g., running) for the instance.

" }, "username":{ "shape":"NonEmptyString", "documentation":"

The user name for connecting to the instance (e.g., ec2-user).

" }, "sshKeyName":{ "shape":"ResourceName", "documentation":"

The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).

" } }, "documentation":"

Describes an instance (a virtual private server).

" }, "InstanceAccessDetails":{ "type":"structure", "members":{ "certKey":{ "shape":"string", "documentation":"

For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey-cert.pub.

" }, "expiresAt":{ "shape":"IsoDate", "documentation":"

For SSH access, the date on which the temporary keys expire.

" }, "ipAddress":{ "shape":"IpAddress", "documentation":"

The public IP address of the Amazon Lightsail instance.

" }, "password":{ "shape":"string", "documentation":"

For RDP access, the temporary password of the Amazon EC2 instance.

" }, "privateKey":{ "shape":"string", "documentation":"

For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey).

" }, "protocol":{ "shape":"InstanceAccessProtocol", "documentation":"

The protocol for these Amazon Lightsail instance access details.

" }, "instanceName":{ "shape":"ResourceName", "documentation":"

The name of this Amazon Lightsail instance.

" }, "username":{ "shape":"string", "documentation":"

The user name to use when logging in to the Amazon Lightsail instance.

" } }, "documentation":"

The parameters for gaining temporary access to one of your Amazon Lightsail instances.

" }, "InstanceAccessProtocol":{ "type":"string", "enum":[ "ssh", "rdp" ] }, "InstanceHardware":{ "type":"structure", "members":{ "cpuCount":{ "shape":"integer", "documentation":"

The number of vCPUs the instance has.

" }, "disks":{ "shape":"DiskList", "documentation":"

The disks attached to the instance.

" }, "ramSizeInGb":{ "shape":"float", "documentation":"

The amount of RAM in GB on the instance (e.g., 1.0).

" } }, "documentation":"

Describes the hardware for the instance.

" }, "InstanceList":{ "type":"list", "member":{"shape":"Instance"} }, "InstanceMetricName":{ "type":"string", "enum":[ "CPUUtilization", "NetworkIn", "NetworkOut", "StatusCheckFailed", "StatusCheckFailed_Instance", "StatusCheckFailed_System" ] }, "InstanceNetworking":{ "type":"structure", "members":{ "monthlyTransfer":{ "shape":"MonthlyTransfer", "documentation":"

The amount of data in GB allocated for monthly data transfers.

" }, "ports":{ "shape":"InstancePortInfoList", "documentation":"

An array of key-value pairs containing information about the ports on the instance.

" } }, "documentation":"

Describes monthly data transfer rates and port information for an instance.

" }, "InstancePortInfo":{ "type":"structure", "members":{ "fromPort":{ "shape":"Port", "documentation":"

The first port in the range.

" }, "toPort":{ "shape":"Port", "documentation":"

The last port in the range.

" }, "protocol":{ "shape":"NetworkProtocol", "documentation":"

The protocol.

" }, "accessFrom":{ "shape":"string", "documentation":"

The location from which access is allowed (e.g., Anywhere (0.0.0.0/0)).

" }, "accessType":{ "shape":"PortAccessType", "documentation":"

The type of access (Public or Private).

" }, "commonName":{ "shape":"string", "documentation":"

The common name.

" }, "accessDirection":{ "shape":"AccessDirection", "documentation":"

The access direction (inbound or outbound).

" } }, "documentation":"

Describes information about the instance ports.

" }, "InstancePortInfoList":{ "type":"list", "member":{"shape":"InstancePortInfo"} }, "InstanceSnapshot":{ "type":"structure", "members":{ "name":{ "shape":"ResourceName", "documentation":"

The name of the snapshot.

" }, "arn":{ "shape":"NonEmptyString", "documentation":"

The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-1:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

" }, "supportCode":{ "shape":"string", "documentation":"

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

" }, "createdAt":{ "shape":"IsoDate", "documentation":"

The timestamp when the snapshot was created (e.g., 1479907467.024).

" }, "location":{ "shape":"ResourceLocation", "documentation":"

The region name and availability zone where you created the snapshot.

" }, "resourceType":{ "shape":"ResourceType", "documentation":"

The type of resource (usually InstanceSnapshot).

" }, "state":{ "shape":"InstanceSnapshotState", "documentation":"

The state the snapshot is in.

" }, "progress":{ "shape":"string", "documentation":"

The progress of the snapshot.

" }, "fromInstanceName":{ "shape":"ResourceName", "documentation":"

The instance from which the snapshot was created.

" }, "fromInstanceArn":{ "shape":"NonEmptyString", "documentation":"

The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-1:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

" }, "fromBlueprintId":{ "shape":"string", "documentation":"

The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A blueprint is a virtual private server (or instance) image used to create instances quickly.

" }, "fromBundleId":{ "shape":"string", "documentation":"

The bundle ID from which you created the snapshot (e.g., micro_1_0).

" }, "sizeInGb":{ "shape":"integer", "documentation":"

The size in GB of the SSD.

" } }, "documentation":"

Describes the snapshot of the virtual private server, or instance.

" }, "InstanceSnapshotList":{ "type":"list", "member":{"shape":"InstanceSnapshot"} }, "InstanceSnapshotState":{ "type":"string", "enum":[ "pending", "error", "available" ] }, "InstanceState":{ "type":"structure", "members":{ "code":{ "shape":"integer", "documentation":"

The status code for the instance.

" }, "name":{ "shape":"string", "documentation":"

The state of the instance (e.g., running or pending).

" } }, "documentation":"

Describes the virtual private server (or instance) status.

" }, "InvalidInputException":{ "type":"structure", "members":{ "code":{"shape":"string"}, "docs":{"shape":"string"}, "message":{"shape":"string"}, "tip":{"shape":"string"} }, "documentation":"

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

", "exception":true }, "IpAddress":{ "type":"string", "pattern":"([0-9]{1,3}\\.){3}[0-9]{1,3}" }, "IpV6Address":{ "type":"string", "pattern":"([A-F0-9]{1,4}:){7}[A-F0-9]{1,4}" }, "IsVpcPeeredRequest":{ "type":"structure", "members":{ } }, "IsVpcPeeredResult":{ "type":"structure", "members":{ "isPeered":{ "shape":"boolean", "documentation":"

Returns true if the Lightsail VPC is peered; otherwise, false.

" } } }, "IsoDate":{"type":"timestamp"}, "KeyPair":{ "type":"structure", "members":{ "name":{ "shape":"ResourceName", "documentation":"

The friendly name of the SSH key pair.

" }, "arn":{ "shape":"NonEmptyString", "documentation":"

The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-1:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).

" }, "supportCode":{ "shape":"string", "documentation":"

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

" }, "createdAt":{ "shape":"IsoDate", "documentation":"

The timestamp when the key pair was created (e.g., 1479816991.349).

" }, "location":{ "shape":"ResourceLocation", "documentation":"

The region name and Availability Zone where the key pair was created.

" }, "resourceType":{ "shape":"ResourceType", "documentation":"

The resource type (usually KeyPair).

" }, "fingerprint":{ "shape":"Base64", "documentation":"

The RSA fingerprint of the key pair.

" } }, "documentation":"

Describes the SSH key pair.

" }, "KeyPairList":{ "type":"list", "member":{"shape":"KeyPair"} }, "MetricDatapoint":{ "type":"structure", "members":{ "average":{ "shape":"double", "documentation":"

The average.

" }, "maximum":{ "shape":"double", "documentation":"

The maximum.

" }, "minimum":{ "shape":"double", "documentation":"

The minimum.

" }, "sampleCount":{ "shape":"double", "documentation":"

The sample count.

" }, "sum":{ "shape":"double", "documentation":"

The sum.

" }, "timestamp":{ "shape":"timestamp", "documentation":"

The timestamp (e.g., 1479816991.349).

" }, "unit":{ "shape":"MetricUnit", "documentation":"

The unit.

" } }, "documentation":"

Describes the metric data point.

" }, "MetricDatapointList":{ "type":"list", "member":{"shape":"MetricDatapoint"} }, "MetricPeriod":{ "type":"integer", "max":86400, "min":60 }, "MetricStatistic":{ "type":"string", "enum":[ "Minimum", "Maximum", "Sum", "Average", "SampleCount" ] }, "MetricStatisticList":{ "type":"list", "member":{"shape":"MetricStatistic"} }, "MetricUnit":{ "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" ] }, "MonthlyTransfer":{ "type":"structure", "members":{ "gbPerMonthAllocated":{ "shape":"integer", "documentation":"

The amount allocated per month (in GB).

" } }, "documentation":"

Describes the monthly data transfer in and out of your virtual private server (or instance).

" }, "NetworkProtocol":{ "type":"string", "enum":[ "tcp", "all", "udp" ] }, "NonEmptyString":{ "type":"string", "pattern":".*\\S.*" }, "NotFoundException":{ "type":"structure", "members":{ "code":{"shape":"string"}, "docs":{"shape":"string"}, "message":{"shape":"string"}, "tip":{"shape":"string"} }, "documentation":"

Lightsail throws this exception when it cannot find a resource.

", "exception":true }, "OpenInstancePublicPortsRequest":{ "type":"structure", "required":[ "portInfo", "instanceName" ], "members":{ "portInfo":{ "shape":"PortInfo", "documentation":"

An array of key-value pairs containing information about the port mappings.

" }, "instanceName":{ "shape":"ResourceName", "documentation":"

The name of the instance for which you want to open the public ports.

" } } }, "OpenInstancePublicPortsResult":{ "type":"structure", "members":{ "operation":{ "shape":"Operation", "documentation":"

An array of key-value pairs containing information about the request operation.

" } } }, "Operation":{ "type":"structure", "members":{ "id":{ "shape":"NonEmptyString", "documentation":"

The ID of the operation.

" }, "resourceName":{ "shape":"ResourceName", "documentation":"

The resource name.

" }, "resourceType":{ "shape":"ResourceType", "documentation":"

The resource type.

" }, "createdAt":{ "shape":"IsoDate", "documentation":"

The timestamp when the operation was initialized (e.g., 1479816991.349).

" }, "location":{ "shape":"ResourceLocation", "documentation":"

The region and Availability Zone.

" }, "isTerminal":{ "shape":"boolean", "documentation":"

A Boolean value indicating whether the operation is terminal.

" }, "operationDetails":{ "shape":"string", "documentation":"

Details about the operation (e.g., Debian-1GB-Virginia-1).

" }, "operationType":{ "shape":"OperationType", "documentation":"

The type of operation.

" }, "status":{ "shape":"OperationStatus", "documentation":"

The status of the operation.

" }, "statusChangedAt":{ "shape":"IsoDate", "documentation":"

The timestamp when the status was changed (e.g., 1479816991.349).

" }, "errorCode":{ "shape":"string", "documentation":"

The error code.

" }, "errorDetails":{ "shape":"string", "documentation":"

The error details.

" } }, "documentation":"

Describes the API operation.

" }, "OperationFailureException":{ "type":"structure", "members":{ "code":{"shape":"string"}, "docs":{"shape":"string"}, "message":{"shape":"string"}, "tip":{"shape":"string"} }, "documentation":"

Lightsail throws this exception when an operation fails to execute.

", "exception":true }, "OperationList":{ "type":"list", "member":{"shape":"Operation"} }, "OperationStatus":{ "type":"string", "enum":[ "NotStarted", "Started", "Failed", "Completed" ] }, "OperationType":{ "type":"string", "enum":[ "DeleteInstance", "CreateInstance", "StopInstance", "StartInstance", "RebootInstance", "OpenInstancePublicPorts", "CloseInstancePublicPorts", "AllocateStaticIp", "ReleaseStaticIp", "AttachStaticIp", "DetachStaticIp", "UpdateDomainEntry", "DeleteDomainEntry", "CreateDomain", "DeleteDomain", "CreateInstanceSnapshot", "DeleteInstanceSnapshot", "CreateInstancesFromSnapshot" ] }, "PeerVpcRequest":{ "type":"structure", "members":{ } }, "PeerVpcResult":{ "type":"structure", "members":{ "operation":{ "shape":"Operation", "documentation":"

An array of key-value pairs containing information about the request operation.

" } } }, "Port":{ "type":"integer", "max":65535, "min":0 }, "PortAccessType":{ "type":"string", "enum":[ "Public", "Private" ] }, "PortInfo":{ "type":"structure", "members":{ "fromPort":{ "shape":"Port", "documentation":"

The first port in the range.

" }, "toPort":{ "shape":"Port", "documentation":"

The last port in the range.

" }, "protocol":{ "shape":"NetworkProtocol", "documentation":"

The protocol.

" } }, "documentation":"

Describes information about the ports on your virtual private server (or instance).

" }, "PortState":{ "type":"string", "enum":[ "open", "closed" ] }, "PortStateList":{ "type":"list", "member":{"shape":"PortState"} }, "RebootInstanceRequest":{ "type":"structure", "required":["instanceName"], "members":{ "instanceName":{ "shape":"ResourceName", "documentation":"

The name of the instance to reboot.

" } } }, "RebootInstanceResult":{ "type":"structure", "members":{ "operations":{ "shape":"OperationList", "documentation":"

An array of key-value pairs containing information about the request operation.

" } } }, "Region":{ "type":"structure", "members":{ "continentCode":{ "shape":"string", "documentation":"

The continent code (e.g., NA, meaning North America).

" }, "description":{ "shape":"string", "documentation":"

The description of the AWS Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada).

" }, "displayName":{ "shape":"string", "documentation":"

The display name (e.g., Virginia).

" }, "name":{ "shape":"RegionName", "documentation":"

The region name (e.g., us-east-1).

" }, "availabilityZones":{ "shape":"AvailabilityZoneList", "documentation":"

The Availability Zones.

" } }, "documentation":"

Describes the AWS Region.

" }, "RegionList":{ "type":"list", "member":{"shape":"Region"} }, "RegionName":{ "type":"string", "enum":[ "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2" ] }, "ReleaseStaticIpRequest":{ "type":"structure", "required":["staticIpName"], "members":{ "staticIpName":{ "shape":"ResourceName", "documentation":"

The name of the static IP to delete.

" } } }, "ReleaseStaticIpResult":{ "type":"structure", "members":{ "operations":{ "shape":"OperationList", "documentation":"

An array of key-value pairs containing information about the request operation.

" } } }, "ResourceLocation":{ "type":"structure", "members":{ "availabilityZone":{ "shape":"string", "documentation":"

The Availability Zone.

" }, "regionName":{ "shape":"RegionName", "documentation":"

The AWS Region name.

" } }, "documentation":"

Describes the resource location.

" }, "ResourceName":{ "type":"string", "pattern":"\\w[\\w\\-]*\\w" }, "ResourceType":{ "type":"string", "enum":[ "Instance", "StaticIp", "KeyPair", "InstanceSnapshot", "Domain", "PeeredVpc" ] }, "ServiceException":{ "type":"structure", "members":{ "code":{"shape":"string"}, "docs":{"shape":"string"}, "message":{"shape":"string"}, "tip":{"shape":"string"} }, "documentation":"

A general service exception.

", "exception":true }, "StartInstanceRequest":{ "type":"structure", "required":["instanceName"], "members":{ "instanceName":{ "shape":"ResourceName", "documentation":"

The name of the instance (a virtual private server) to start.

" } } }, "StartInstanceResult":{ "type":"structure", "members":{ "operations":{ "shape":"OperationList", "documentation":"

An array of key-value pairs containing information about the request operation.

" } } }, "StaticIp":{ "type":"structure", "members":{ "name":{ "shape":"ResourceName", "documentation":"

The name of the static IP (e.g., StaticIP-Virginia-EXAMPLE).

" }, "arn":{ "shape":"NonEmptyString", "documentation":"

The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-1:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).

" }, "supportCode":{ "shape":"string", "documentation":"

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

" }, "createdAt":{ "shape":"IsoDate", "documentation":"

The timestamp when the static IP was created (e.g., 1479735304.222).

" }, "location":{ "shape":"ResourceLocation", "documentation":"

The region and Availability Zone where the static IP was created.

" }, "resourceType":{ "shape":"ResourceType", "documentation":"

The resource type (usually StaticIp).

" }, "ipAddress":{ "shape":"IpAddress", "documentation":"

The static IP address.

" }, "attachedTo":{ "shape":"ResourceName", "documentation":"

The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Virginia-1).

" }, "isAttached":{ "shape":"boolean", "documentation":"

A Boolean value indicating whether the static IP is attached.

" } }, "documentation":"

Describes the static IP.

" }, "StaticIpList":{ "type":"list", "member":{"shape":"StaticIp"} }, "StopInstanceRequest":{ "type":"structure", "required":["instanceName"], "members":{ "instanceName":{ "shape":"ResourceName", "documentation":"

The name of the instance (a virtual private server) to stop.

" } } }, "StopInstanceResult":{ "type":"structure", "members":{ "operations":{ "shape":"OperationList", "documentation":"

An array of key-value pairs containing information about the request operation.

" } } }, "StringList":{ "type":"list", "member":{"shape":"string"} }, "UnauthenticatedException":{ "type":"structure", "members":{ "code":{"shape":"string"}, "docs":{"shape":"string"}, "message":{"shape":"string"}, "tip":{"shape":"string"} }, "documentation":"

Lightsail throws this exception when the user has not been authenticated.

", "exception":true }, "UnpeerVpcRequest":{ "type":"structure", "members":{ } }, "UnpeerVpcResult":{ "type":"structure", "members":{ "operation":{ "shape":"Operation", "documentation":"

An array of key-value pairs containing information about the request operation.

" } } }, "UpdateDomainEntryRequest":{ "type":"structure", "required":[ "domainName", "domainEntry" ], "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The name of the domain recordset to update.

" }, "domainEntry":{ "shape":"DomainEntry", "documentation":"

An array of key-value pairs containing information about the domain entry.

" } } }, "UpdateDomainEntryResult":{ "type":"structure", "members":{ "operations":{ "shape":"OperationList", "documentation":"

An array of key-value pairs containing information about the request operation.

" } } }, "boolean":{"type":"boolean"}, "double":{"type":"double"}, "float":{"type":"float"}, "integer":{"type":"integer"}, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} }, "documentation":"

Amazon Lightsail is the easiest way to get started with AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).

For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.

To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, see the Lightsail Dev Guide.

" } botocore-1.5.7/botocore/data/waf-regional/0000777454262600001440000000000013042511307021506 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/waf-regional/2016-11-28/0000777454262600001440000000000013042511307022544 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/waf-regional/2016-11-28/service-2.json0000666454262600001440000057011513042511306025246 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-11-28", "endpointPrefix":"waf-regional", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"WAF Regional", "serviceFullName":"AWS WAF Regional", "signatureVersion":"v4", "targetPrefix":"AWSWAF_Regional_20161128", "uid":"waf-regional-2016-11-28" }, "operations":{ "AssociateWebACL":{ "name":"AssociateWebACL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateWebACLRequest"}, "output":{"shape":"AssociateWebACLResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFUnavailableEntityException"} ], "documentation":"

Associates a web ACL with a resource.

" }, "CreateByteMatchSet":{ "name":"CreateByteMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateByteMatchSetRequest"}, "output":{"shape":"CreateByteMatchSetResponse"}, "errors":[ {"shape":"WAFDisallowedNameException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests.

To create and configure a ByteMatchSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request.

  2. Submit a CreateByteMatchSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.

  4. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "CreateIPSet":{ "name":"CreateIPSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateIPSetRequest"}, "output":{"shape":"CreateIPSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFDisallowedNameException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Creates an IPSet, which you use to specify which web requests you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.

To create and configure an IPSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request.

  2. Submit a CreateIPSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

  4. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "CreateRule":{ "name":"CreateRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRuleRequest"}, "output":{"shape":"CreateRuleResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFDisallowedNameException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose you add the following to a Rule:

  • An IPSet that matches the IP address 192.0.2.44/32

  • A ByteMatchSet that matches BadBot in the User-Agent header

You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.

To create and configure a Rule, perform the following steps:

  1. Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.

  3. Submit a CreateRule request.

  4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.

  5. Submit an UpdateRule request to specify the predicates that you want to include in the Rule.

  6. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "CreateSizeConstraintSet":{ "name":"CreateSizeConstraintSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSizeConstraintSetRequest"}, "output":{"shape":"CreateSizeConstraintSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFDisallowedNameException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.

To create and configure a SizeConstraintSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request.

  2. Submit a CreateSizeConstraintSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.

  4. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "CreateSqlInjectionMatchSet":{ "name":"CreateSqlInjectionMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSqlInjectionMatchSetRequest"}, "output":{"shape":"CreateSqlInjectionMatchSetResponse"}, "errors":[ {"shape":"WAFDisallowedNameException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

To create and configure a SqlInjectionMatchSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request.

  2. Submit a CreateSqlInjectionMatchSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request.

  4. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "CreateWebACL":{ "name":"CreateWebACL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateWebACLRequest"}, "output":{"shape":"CreateWebACLResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFDisallowedNameException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule.

You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action.

To create and configure a WebACL, perform the following steps:

  1. Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

  2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request.

  4. Submit a CreateWebACL request.

  5. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.

  6. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.

For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.

" }, "CreateXssMatchSet":{ "name":"CreateXssMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateXssMatchSetRequest"}, "output":{"shape":"CreateXssMatchSetResponse"}, "errors":[ {"shape":"WAFDisallowedNameException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

To create and configure an XssMatchSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request.

  2. Submit a CreateXssMatchSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request.

  4. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "DeleteByteMatchSet":{ "name":"DeleteByteMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteByteMatchSetRequest"}, "output":{"shape":"DeleteByteMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters).

If you just want to remove a ByteMatchSet from a Rule, use UpdateRule.

To permanently delete a ByteMatchSet, perform the following steps:

  1. Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request.

  3. Submit a DeleteByteMatchSet request.

" }, "DeleteIPSet":{ "name":"DeleteIPSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteIPSetRequest"}, "output":{"shape":"DeleteIPSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses.

If you just want to remove an IPSet from a Rule, use UpdateRule.

To permanently delete an IPSet from AWS WAF, perform the following steps:

  1. Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request.

  3. Submit a DeleteIPSet request.

" }, "DeleteRule":{ "name":"DeleteRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRuleRequest"}, "output":{"shape":"DeleteRuleResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.

If you just want to remove a Rule from a WebACL, use UpdateWebACL.

To permanently delete a Rule from AWS WAF, perform the following steps:

  1. Update the Rule to remove predicates, if any. For more information, see UpdateRule.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request.

  3. Submit a DeleteRule request.

" }, "DeleteSizeConstraintSet":{ "name":"DeleteSizeConstraintSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSizeConstraintSetRequest"}, "output":{"shape":"DeleteSizeConstraintSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters).

If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule.

To permanently delete a SizeConstraintSet, perform the following steps:

  1. Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request.

  3. Submit a DeleteSizeConstraintSet request.

" }, "DeleteSqlInjectionMatchSet":{ "name":"DeleteSqlInjectionMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSqlInjectionMatchSetRequest"}, "output":{"shape":"DeleteSqlInjectionMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects.

If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule.

To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps:

  1. Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request.

  3. Submit a DeleteSqlInjectionMatchSet request.

" }, "DeleteWebACL":{ "name":"DeleteWebACL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteWebACLRequest"}, "output":{"shape":"DeleteWebACLResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules.

To delete a WebACL, perform the following steps:

  1. Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request.

  3. Submit a DeleteWebACL request.

" }, "DeleteXssMatchSet":{ "name":"DeleteXssMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteXssMatchSetRequest"}, "output":{"shape":"DeleteXssMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects.

If you just want to remove an XssMatchSet from a Rule, use UpdateRule.

To permanently delete an XssMatchSet from AWS WAF, perform the following steps:

  1. Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request.

  3. Submit a DeleteXssMatchSet request.

" }, "DisassociateWebACL":{ "name":"DisassociateWebACL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateWebACLRequest"}, "output":{"shape":"DisassociateWebACLResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

Removes a web ACL from the specified resource.

" }, "GetByteMatchSet":{ "name":"GetByteMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetByteMatchSetRequest"}, "output":{"shape":"GetByteMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

Returns the ByteMatchSet specified by ByteMatchSetId.

" }, "GetChangeToken":{ "name":"GetChangeToken", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetChangeTokenRequest"}, "output":{"shape":"GetChangeTokenResponse"}, "errors":[ {"shape":"WAFInternalErrorException"} ], "documentation":"

When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.

Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request.

When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.

" }, "GetChangeTokenStatus":{ "name":"GetChangeTokenStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetChangeTokenStatusRequest"}, "output":{"shape":"GetChangeTokenStatusResponse"}, "errors":[ {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInternalErrorException"} ], "documentation":"

Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values:

  • PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object.

  • PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.

  • IN_SYNC: Propagation is complete.

" }, "GetIPSet":{ "name":"GetIPSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetIPSetRequest"}, "output":{"shape":"GetIPSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

Returns the IPSet that is specified by IPSetId.

" }, "GetRule":{ "name":"GetRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRuleRequest"}, "output":{"shape":"GetRuleResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

Returns the Rule that is specified by the RuleId that you included in the GetRule request.

" }, "GetSampledRequests":{ "name":"GetSampledRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSampledRequestsRequest"}, "output":{"shape":"GetSampledRequestsResponse"}, "errors":[ {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInternalErrorException"} ], "documentation":"

Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 100 requests, and you can specify any time range in the previous three hours.

GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

" }, "GetSizeConstraintSet":{ "name":"GetSizeConstraintSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSizeConstraintSetRequest"}, "output":{"shape":"GetSizeConstraintSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

Returns the SizeConstraintSet specified by SizeConstraintSetId.

" }, "GetSqlInjectionMatchSet":{ "name":"GetSqlInjectionMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSqlInjectionMatchSetRequest"}, "output":{"shape":"GetSqlInjectionMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.

" }, "GetWebACL":{ "name":"GetWebACL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetWebACLRequest"}, "output":{"shape":"GetWebACLResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

Returns the WebACL that is specified by WebACLId.

" }, "GetWebACLForResource":{ "name":"GetWebACLForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetWebACLForResourceRequest"}, "output":{"shape":"GetWebACLForResourceResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFUnavailableEntityException"} ], "documentation":"

Returns the web ACL for the specified resource.

" }, "GetXssMatchSet":{ "name":"GetXssMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetXssMatchSetRequest"}, "output":{"shape":"GetXssMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

Returns the XssMatchSet that is specified by XssMatchSetId.

" }, "ListByteMatchSets":{ "name":"ListByteMatchSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListByteMatchSetsRequest"}, "output":{"shape":"ListByteMatchSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

Returns an array of ByteMatchSetSummary objects.

" }, "ListIPSets":{ "name":"ListIPSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListIPSetsRequest"}, "output":{"shape":"ListIPSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

Returns an array of IPSetSummary objects in the response.

" }, "ListResourcesForWebACL":{ "name":"ListResourcesForWebACL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListResourcesForWebACLRequest"}, "output":{"shape":"ListResourcesForWebACLResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

Returns an array of resources associated with the specified web ACL.

" }, "ListRules":{ "name":"ListRules", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRulesRequest"}, "output":{"shape":"ListRulesResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

Returns an array of RuleSummary objects.

" }, "ListSizeConstraintSets":{ "name":"ListSizeConstraintSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSizeConstraintSetsRequest"}, "output":{"shape":"ListSizeConstraintSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

Returns an array of SizeConstraintSetSummary objects.

" }, "ListSqlInjectionMatchSets":{ "name":"ListSqlInjectionMatchSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSqlInjectionMatchSetsRequest"}, "output":{"shape":"ListSqlInjectionMatchSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

Returns an array of SqlInjectionMatchSet objects.

" }, "ListWebACLs":{ "name":"ListWebACLs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListWebACLsRequest"}, "output":{"shape":"ListWebACLsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

Returns an array of WebACLSummary objects in the response.

" }, "ListXssMatchSets":{ "name":"ListXssMatchSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListXssMatchSetsRequest"}, "output":{"shape":"ListXssMatchSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

Returns an array of XssMatchSet objects.

" }, "UpdateByteMatchSet":{ "name":"UpdateByteMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateByteMatchSetRequest"}, "output":{"shape":"UpdateByteMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.

  • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

  • The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.

  • Where to look, such as at the beginning or the end of a query string.

  • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.

To create and configure a ByteMatchSet, perform the following steps:

  1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.

  3. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "UpdateIPSet":{ "name":"UpdateIPSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateIPSetRequest"}, "output":{"shape":"UpdateIPSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one.

  • The IP address version, IPv4 or IPv6.

  • The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44).

AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

IPv6 addresses can be represented using any of the following formats:

  • 1111:0000:0000:0000:0000:0000:0000:0111/128

  • 1111:0:0:0:0:0:0:0111/128

  • 1111::0111/128

  • 1111::111/128

You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.

To create and configure an IPSet, perform the following steps:

  1. Submit a CreateIPSet request.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

  3. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "UpdateRule":{ "name":"UpdateRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateRuleRequest"}, "output":{"shape":"UpdateRuleResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a Rule:

  • A ByteMatchSet that matches the value BadBot in the User-Agent header

  • An IPSet that matches the IP address 192.0.2.44

You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.

To create and configure a Rule, perform the following steps:

  1. Create and update the predicates that you want to include in the Rule.

  2. Create the Rule. See CreateRule.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.

  4. Submit an UpdateRule request to add predicates to the Rule.

  5. Create and update a WebACL that contains the Rule. See CreateWebACL.

If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "UpdateSizeConstraintSet":{ "name":"UpdateSizeConstraintSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateSizeConstraintSetRequest"}, "output":{"shape":"UpdateSizeConstraintSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one.

  • The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header.

  • Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF.

  • A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on.

  • The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.

For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests.

To create and configure a SizeConstraintSet, perform the following steps:

  1. Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.

  3. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "UpdateSqlInjectionMatchSet":{ "name":"UpdateSqlInjectionMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateSqlInjectionMatchSetRequest"}, "output":{"shape":"UpdateSqlInjectionMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:

  • Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.

  • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.

  • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.

You use SqlInjectionMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

To create and configure a SqlInjectionMatchSet, perform the following steps:

  1. Submit a CreateSqlInjectionMatchSet request.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

  3. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "UpdateWebACL":{ "name":"UpdateWebACL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateWebACLRequest"}, "output":{"shape":"UpdateWebACLResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:

  • A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL.

  • The Rules that you want to add and/or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one.

  • For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule.

  • The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all of the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any.

  • The CloudFront distribution that you want to associate with the WebACL.

To create and configure a WebACL, perform the following steps:

  1. Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

  2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.

  3. Create a WebACL. See CreateWebACL.

  4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.

  5. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "UpdateXssMatchSet":{ "name":"UpdateXssMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateXssMatchSetRequest"}, "output":{"shape":"UpdateXssMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:

  • Action: Whether to insert the object into or delete the object from the array. To change a XssMatchTuple, you delete the existing object and add a new one.

  • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.

  • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.

You use XssMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

To create and configure an XssMatchSet, perform the following steps:

  1. Submit a CreateXssMatchSet request.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

  3. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" } }, "shapes":{ "Action":{"type":"string"}, "ActivatedRule":{ "type":"structure", "required":[ "Priority", "RuleId", "Action" ], "members":{ "Priority":{ "shape":"RulePriority", "documentation":"

Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

" }, "RuleId":{ "shape":"ResourceId", "documentation":"

The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

" }, "Action":{ "shape":"WafAction", "documentation":"

Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

  • ALLOW: CloudFront responds with the requested object.

  • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.

  • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

" } }, "documentation":"

The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

To specify whether to insert or delete a Rule, use the Action parameter in the WebACLUpdate data type.

" }, "ActivatedRules":{ "type":"list", "member":{"shape":"ActivatedRule"} }, "AssociateWebACLRequest":{ "type":"structure", "required":[ "WebACLId", "ResourceArn" ], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

A unique identifier (ID) for the web ACL.

" }, "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The ARN (Amazon Resource Name) of the resource to be protected.

" } } }, "AssociateWebACLResponse":{ "type":"structure", "members":{ } }, "ByteMatchSet":{ "type":"structure", "required":[ "ByteMatchSetId", "ByteMatchTuples" ], "members":{ "ByteMatchSetId":{ "shape":"ResourceId", "documentation":"

The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

" }, "ByteMatchTuples":{ "shape":"ByteMatchTuples", "documentation":"

Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

" } }, "documentation":"

In a GetByteMatchSet request, ByteMatchSet is a complex type that contains the ByteMatchSetId and Name of a ByteMatchSet, and the values that you specified when you updated the ByteMatchSet.

A complex type that contains ByteMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a ByteMatchSet contains more than one ByteMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

" }, "ByteMatchSetSummaries":{ "type":"list", "member":{"shape":"ByteMatchSetSummary"} }, "ByteMatchSetSummary":{ "type":"structure", "required":[ "ByteMatchSetId", "Name" ], "members":{ "ByteMatchSetId":{ "shape":"ResourceId", "documentation":"

The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF.

ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

" } }, "documentation":"

Returned by ListByteMatchSets. Each ByteMatchSetSummary object includes the Name and ByteMatchSetId for one ByteMatchSet.

" }, "ByteMatchSetUpdate":{ "type":"structure", "required":[ "Action", "ByteMatchTuple" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specifies whether to insert or delete a ByteMatchTuple.

" }, "ByteMatchTuple":{ "shape":"ByteMatchTuple", "documentation":"

Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify DELETE for the value of Action, the ByteMatchTuple values must exactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet.

" } }, "documentation":"

In an UpdateByteMatchSet request, ByteMatchSetUpdate specifies whether to insert or delete a ByteMatchTuple and includes the settings for the ByteMatchTuple.

" }, "ByteMatchSetUpdates":{ "type":"list", "member":{"shape":"ByteMatchSetUpdate"} }, "ByteMatchTargetString":{"type":"blob"}, "ByteMatchTuple":{ "type":"structure", "required":[ "FieldToMatch", "TargetString", "TextTransformation", "PositionalConstraint" ], "members":{ "FieldToMatch":{ "shape":"FieldToMatch", "documentation":"

The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch.

" }, "TargetString":{ "shape":"ByteMatchTargetString", "documentation":"

The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.

Valid values depend on the values that you specified for FieldToMatch:

  • HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header.

  • METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

  • QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character.

  • URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg.

  • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

If you're using the AWS WAF API

Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64 encoding and include the resulting value, QmFkQm90, in the value of TargetString.

If you're using the AWS CLI or one of the AWS SDKs

The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.

" }, "TextTransformation":{ "shape":"TextTransformation", "documentation":"

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

  • Delete the following characters: \\ \" ' ^

  • Delete spaces before the following characters: / (

  • Replace the following characters with a space: , ;

  • Replace multiple spaces with one space

  • Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

  • \\f, formfeed, decimal 12

  • \\t, tab, decimal 9

  • \\n, newline, decimal 10

  • \\r, carriage return, decimal 13

  • \\v, vertical tab, decimal 11

  • non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

  • Replaces (ampersand)quot; with \"

  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

  • Replaces (ampersand)lt; with a \"less than\" symbol

  • Replaces (ampersand)gt; with >

  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

" }, "PositionalConstraint":{ "shape":"PositionalConstraint", "documentation":"

Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:

CONTAINS

The specified part of the web request must include the value of TargetString, but the location doesn't matter.

CONTAINS_WORD

The specified part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, which means one of the following:

  • TargetString exactly matches the value of the specified part of the web request, such as the value of a header.

  • TargetString is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot;.

  • TargetString is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example, ;BadBot.

  • TargetString is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, -BadBot;.

EXACTLY

The value of the specified part of the web request must exactly match the value of TargetString.

STARTS_WITH

The value of TargetString must appear at the beginning of the specified part of the web request.

ENDS_WITH

The value of TargetString must appear at the end of the specified part of the web request.

" } }, "documentation":"

The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

" }, "ByteMatchTuples":{ "type":"list", "member":{"shape":"ByteMatchTuple"} }, "ChangeAction":{ "type":"string", "enum":[ "INSERT", "DELETE" ] }, "ChangeToken":{ "type":"string", "min":1 }, "ChangeTokenStatus":{ "type":"string", "enum":[ "PROVISIONED", "PENDING", "INSYNC" ] }, "ComparisonOperator":{ "type":"string", "enum":[ "EQ", "NE", "LE", "LT", "GE", "GT" ] }, "Country":{"type":"string"}, "CreateByteMatchSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "CreateByteMatchSetResponse":{ "type":"structure", "members":{ "ByteMatchSet":{ "shape":"ByteMatchSet", "documentation":"

A ByteMatchSet that contains no ByteMatchTuple objects.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "CreateIPSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the IPSet. You can't change Name after you create the IPSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "CreateIPSetResponse":{ "type":"structure", "members":{ "IPSet":{ "shape":"IPSet", "documentation":"

The IPSet returned in the CreateIPSet response.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the CreateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "CreateRuleRequest":{ "type":"structure", "required":[ "Name", "MetricName", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the Rule.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "CreateRuleResponse":{ "type":"structure", "members":{ "Rule":{ "shape":"Rule", "documentation":"

The Rule returned in the CreateRule response.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the CreateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "CreateSizeConstraintSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the SizeConstraintSet. You can't change Name after you create a SizeConstraintSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "CreateSizeConstraintSetResponse":{ "type":"structure", "members":{ "SizeConstraintSet":{ "shape":"SizeConstraintSet", "documentation":"

A SizeConstraintSet that contains no SizeConstraint objects.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the CreateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "CreateSqlInjectionMatchSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name after you create the SqlInjectionMatchSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } }, "documentation":"

A request to create a SqlInjectionMatchSet.

" }, "CreateSqlInjectionMatchSetResponse":{ "type":"structure", "members":{ "SqlInjectionMatchSet":{ "shape":"SqlInjectionMatchSet", "documentation":"

A SqlInjectionMatchSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the CreateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } }, "documentation":"

The response to a CreateSqlInjectionMatchSet request.

" }, "CreateWebACLRequest":{ "type":"structure", "required":[ "Name", "MetricName", "DefaultAction", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the WebACL. You can't change Name after you create the WebACL.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the WebACL.

" }, "DefaultAction":{ "shape":"WafAction", "documentation":"

The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "CreateWebACLResponse":{ "type":"structure", "members":{ "WebACL":{ "shape":"WebACL", "documentation":"

The WebACL returned in the CreateWebACL response.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the CreateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "CreateXssMatchSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } }, "documentation":"

A request to create an XssMatchSet.

" }, "CreateXssMatchSetResponse":{ "type":"structure", "members":{ "XssMatchSet":{ "shape":"XssMatchSet", "documentation":"

An XssMatchSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } }, "documentation":"

The response to a CreateXssMatchSet request.

" }, "DeleteByteMatchSetRequest":{ "type":"structure", "required":[ "ByteMatchSetId", "ChangeToken" ], "members":{ "ByteMatchSetId":{ "shape":"ResourceId", "documentation":"

The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteByteMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "DeleteIPSetRequest":{ "type":"structure", "required":[ "IPSetId", "ChangeToken" ], "members":{ "IPSetId":{ "shape":"ResourceId", "documentation":"

The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteIPSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the DeleteIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "DeleteRuleRequest":{ "type":"structure", "required":[ "RuleId", "ChangeToken" ], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteRuleResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the DeleteRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "DeleteSizeConstraintSetRequest":{ "type":"structure", "required":[ "SizeConstraintSetId", "ChangeToken" ], "members":{ "SizeConstraintSetId":{ "shape":"ResourceId", "documentation":"

The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteSizeConstraintSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "DeleteSqlInjectionMatchSetRequest":{ "type":"structure", "required":[ "SqlInjectionMatchSetId", "ChangeToken" ], "members":{ "SqlInjectionMatchSetId":{ "shape":"ResourceId", "documentation":"

The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } }, "documentation":"

A request to delete a SqlInjectionMatchSet from AWS WAF.

" }, "DeleteSqlInjectionMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } }, "documentation":"

The response to a request to delete a SqlInjectionMatchSet from AWS WAF.

" }, "DeleteWebACLRequest":{ "type":"structure", "required":[ "WebACLId", "ChangeToken" ], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteWebACLResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the DeleteWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "DeleteXssMatchSetRequest":{ "type":"structure", "required":[ "XssMatchSetId", "ChangeToken" ], "members":{ "XssMatchSetId":{ "shape":"ResourceId", "documentation":"

The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } }, "documentation":"

A request to delete an XssMatchSet from AWS WAF.

" }, "DeleteXssMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the DeleteXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } }, "documentation":"

The response to a request to delete an XssMatchSet from AWS WAF.

" }, "DisassociateWebACLRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The ARN (Amazon Resource Name) of the resource from which the web ACL is being removed.

" } } }, "DisassociateWebACLResponse":{ "type":"structure", "members":{ } }, "FieldToMatch":{ "type":"structure", "required":["Type"], "members":{ "Type":{ "shape":"MatchFieldType", "documentation":"

The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

  • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

  • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

  • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

  • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

  • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

" }, "Data":{ "shape":"MatchFieldData", "documentation":"

When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. If the value of Type is any other value, omit Data.

The name of the header is not case sensitive.

" } }, "documentation":"

Specifies where in a web request to look for TargetString.

" }, "GetByteMatchSetRequest":{ "type":"structure", "required":["ByteMatchSetId"], "members":{ "ByteMatchSetId":{ "shape":"ResourceId", "documentation":"

The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

" } } }, "GetByteMatchSetResponse":{ "type":"structure", "members":{ "ByteMatchSet":{ "shape":"ByteMatchSet", "documentation":"

Information about the ByteMatchSet that you specified in the GetByteMatchSet request. For more information, see the following topics:

  • ByteMatchSet: Contains ByteMatchSetId, ByteMatchTuples, and Name

  • ByteMatchTuples: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple object contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation

  • FieldToMatch: Contains Data and Type

" } } }, "GetChangeTokenRequest":{ "type":"structure", "members":{ } }, "GetChangeTokenResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request.

" } } }, "GetChangeTokenStatusRequest":{ "type":"structure", "required":["ChangeToken"], "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The change token for which you want to get the status. This change token was previously returned in the GetChangeToken response.

" } } }, "GetChangeTokenStatusResponse":{ "type":"structure", "members":{ "ChangeTokenStatus":{ "shape":"ChangeTokenStatus", "documentation":"

The status of the change token.

" } } }, "GetIPSetRequest":{ "type":"structure", "required":["IPSetId"], "members":{ "IPSetId":{ "shape":"ResourceId", "documentation":"

The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets.

" } } }, "GetIPSetResponse":{ "type":"structure", "members":{ "IPSet":{ "shape":"IPSet", "documentation":"

Information about the IPSet that you specified in the GetIPSet request. For more information, see the following topics:

  • IPSet: Contains IPSetDescriptors, IPSetId, and Name

  • IPSetDescriptors: Contains an array of IPSetDescriptor objects. Each IPSetDescriptor object contains Type and Value

" } } }, "GetRuleRequest":{ "type":"structure", "required":["RuleId"], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules.

" } } }, "GetRuleResponse":{ "type":"structure", "members":{ "Rule":{ "shape":"Rule", "documentation":"

Information about the Rule that you specified in the GetRule request. For more information, see the following topics:

  • Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId

  • Predicate: Each Predicate object contains DataId, Negated, and Type

" } } }, "GetSampledRequestsRequest":{ "type":"structure", "required":[ "WebAclId", "RuleId", "TimeWindow", "MaxItems" ], "members":{ "WebAclId":{ "shape":"ResourceId", "documentation":"

The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

" }, "RuleId":{ "shape":"ResourceId", "documentation":"

RuleId is one of two values:

  • The RuleId of the Rule for which you want GetSampledRequests to return a sample of requests.

  • Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL.

" }, "TimeWindow":{ "shape":"TimeWindow", "documentation":"

The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. Specify the date and time in the following format: \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

" }, "MaxItems":{ "shape":"ListMaxItems", "documentation":"

The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

" } } }, "GetSampledRequestsResponse":{ "type":"structure", "members":{ "SampledRequests":{ "shape":"SampledHTTPRequests", "documentation":"

A complex type that contains detailed information about each of the requests in the sample.

" }, "PopulationSize":{ "shape":"PopulationSize", "documentation":"

The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range.

" }, "TimeWindow":{ "shape":"TimeWindow", "documentation":"

Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests.

" } } }, "GetSizeConstraintSetRequest":{ "type":"structure", "required":["SizeConstraintSetId"], "members":{ "SizeConstraintSetId":{ "shape":"ResourceId", "documentation":"

The SizeConstraintSetId of the SizeConstraintSet that you want to get. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

" } } }, "GetSizeConstraintSetResponse":{ "type":"structure", "members":{ "SizeConstraintSet":{ "shape":"SizeConstraintSet", "documentation":"

Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet request. For more information, see the following topics:

" } } }, "GetSqlInjectionMatchSetRequest":{ "type":"structure", "required":["SqlInjectionMatchSetId"], "members":{ "SqlInjectionMatchSetId":{ "shape":"ResourceId", "documentation":"

The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

" } }, "documentation":"

A request to get a SqlInjectionMatchSet.

" }, "GetSqlInjectionMatchSetResponse":{ "type":"structure", "members":{ "SqlInjectionMatchSet":{ "shape":"SqlInjectionMatchSet", "documentation":"

Information about the SqlInjectionMatchSet that you specified in the GetSqlInjectionMatchSet request. For more information, see the following topics:

" } }, "documentation":"

The response to a GetSqlInjectionMatchSet request.

" }, "GetWebACLForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The ARN (Amazon Resource Name) of the resource for which to get the web ACL.

" } } }, "GetWebACLForResourceResponse":{ "type":"structure", "members":{ "WebACLSummary":{ "shape":"WebACLSummary", "documentation":"

Information about the web ACL that you specified in the GetWebACLForResource request. If there is no associated resource, a null WebACLSummary is returned.

" } } }, "GetWebACLRequest":{ "type":"structure", "required":["WebACLId"], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs.

" } } }, "GetWebACLResponse":{ "type":"structure", "members":{ "WebACL":{ "shape":"WebACL", "documentation":"

Information about the WebACL that you specified in the GetWebACL request. For more information, see the following topics:

  • WebACL: Contains DefaultAction, MetricName, Name, an array of Rule objects, and WebACLId

  • DefaultAction (Data type is WafAction): Contains Type

  • Rules: Contains an array of ActivatedRule objects, which contain Action, Priority, and RuleId

  • Action: Contains Type

" } } }, "GetXssMatchSetRequest":{ "type":"structure", "required":["XssMatchSetId"], "members":{ "XssMatchSetId":{ "shape":"ResourceId", "documentation":"

The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

" } }, "documentation":"

A request to get an XssMatchSet.

" }, "GetXssMatchSetResponse":{ "type":"structure", "members":{ "XssMatchSet":{ "shape":"XssMatchSet", "documentation":"

Information about the XssMatchSet that you specified in the GetXssMatchSet request. For more information, see the following topics:

  • XssMatchSet: Contains Name, XssMatchSetId, and an array of XssMatchTuple objects

  • XssMatchTuple: Each XssMatchTuple object contains FieldToMatch and TextTransformation

  • FieldToMatch: Contains Data and Type

" } }, "documentation":"

The response to a GetXssMatchSet request.

" }, "HTTPHeader":{ "type":"structure", "members":{ "Name":{ "shape":"HeaderName", "documentation":"

The name of one of the headers in the sampled web request.

" }, "Value":{ "shape":"HeaderValue", "documentation":"

The value of one of the headers in the sampled web request.

" } }, "documentation":"

The response from a GetSampledRequests request includes an HTTPHeader complex type that appears as Headers in the response syntax. HTTPHeader contains the names and values of all of the headers that appear in one of the web requests that were returned by GetSampledRequests.

" }, "HTTPHeaders":{ "type":"list", "member":{"shape":"HTTPHeader"} }, "HTTPMethod":{"type":"string"}, "HTTPRequest":{ "type":"structure", "members":{ "ClientIP":{ "shape":"IPString", "documentation":"

The IP address that the request originated from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

  • c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request

  • x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

" }, "Country":{ "shape":"Country", "documentation":"

The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.

" }, "URI":{ "shape":"URIString", "documentation":"

The part of a web request that identifies the resource, for example, /images/daily-ad.jpg.

" }, "Method":{ "shape":"HTTPMethod", "documentation":"

The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

" }, "HTTPVersion":{ "shape":"HTTPVersion", "documentation":"

The HTTP version specified in the sampled web request, for example, HTTP/1.1.

" }, "Headers":{ "shape":"HTTPHeaders", "documentation":"

A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.

" } }, "documentation":"

The response from a GetSampledRequests request includes an HTTPRequest complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests that were returned by GetSampledRequests.

" }, "HTTPVersion":{"type":"string"}, "HeaderName":{"type":"string"}, "HeaderValue":{"type":"string"}, "IPSet":{ "type":"structure", "required":[ "IPSetId", "IPSetDescriptors" ], "members":{ "IPSetId":{ "shape":"ResourceId", "documentation":"

The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).

IPSetId is returned by CreateIPSet and by ListIPSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

" }, "IPSetDescriptors":{ "shape":"IPSetDescriptors", "documentation":"

The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

  • c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request

  • x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

" } }, "documentation":"

Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6.

To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/31. To block a range of IP addresses, you can specify a /128, /64, /56, /48, /32, /24, /16, or /8 CIDR. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

" }, "IPSetDescriptor":{ "type":"structure", "required":[ "Type", "Value" ], "members":{ "Type":{ "shape":"IPSetDescriptorType", "documentation":"

Specify IPV4 or IPV6.

" }, "Value":{ "shape":"IPSetDescriptorValue", "documentation":"

Specify an IPv4 address by using CIDR notation. For example:

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Specify an IPv6 address by using CIDR notation. For example:

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

" } }, "documentation":"

Specifies the IP address type (IPV4 or IPV6) and the IP address range (in CIDR format) that web requests originate from.

" }, "IPSetDescriptorType":{ "type":"string", "enum":[ "IPV4", "IPV6" ] }, "IPSetDescriptorValue":{"type":"string"}, "IPSetDescriptors":{ "type":"list", "member":{"shape":"IPSetDescriptor"} }, "IPSetSummaries":{ "type":"list", "member":{"shape":"IPSetSummary"} }, "IPSetSummary":{ "type":"structure", "required":[ "IPSetId", "Name" ], "members":{ "IPSetId":{ "shape":"ResourceId", "documentation":"

The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed information about an IPSet.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

" } }, "documentation":"

Contains the identifier and the name of the IPSet.

" }, "IPSetUpdate":{ "type":"structure", "required":[ "Action", "IPSetDescriptor" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specifies whether to insert or delete an IP address with UpdateIPSet.

" }, "IPSetDescriptor":{ "shape":"IPSetDescriptor", "documentation":"

The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from.

" } }, "documentation":"

Specifies the type of update to perform to an IPSet with UpdateIPSet.

" }, "IPSetUpdates":{ "type":"list", "member":{"shape":"IPSetUpdate"} }, "IPString":{"type":"string"}, "ListByteMatchSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListByteMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more ByteMatchSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ByteMatchSet objects.

" } } }, "ListByteMatchSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you have more ByteMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ByteMatchSet objects, submit another ListByteMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

" }, "ByteMatchSets":{ "shape":"ByteMatchSetSummaries", "documentation":"

An array of ByteMatchSetSummary objects.

" } } }, "ListIPSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you specify a value for Limit and you have more IPSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of IPSets. For the second and subsequent ListIPSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have more IPSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of IPSet objects.

" } } }, "ListIPSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you have more IPSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more IPSet objects, submit another ListIPSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

" }, "IPSets":{ "shape":"IPSetSummaries", "documentation":"

An array of IPSetSummary objects.

" } } }, "ListMaxItems":{ "type":"long", "max":100, "min":1 }, "ListResourcesForWebACLRequest":{ "type":"structure", "required":["WebACLId"], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

The unique identifier (ID) of the web ACL for which to list the associated resources.

" } } }, "ListResourcesForWebACLResponse":{ "type":"structure", "members":{ "ResourceArns":{ "shape":"ResourceArns", "documentation":"

An array of ARNs (Amazon Resource Names) of the resources associated with the specified web ACL. An array with zero elements is returned if there are no resources associated with the web ACL.

" } } }, "ListRulesRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

" } } }, "ListRulesResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

" }, "Rules":{ "shape":"RuleSummaries", "documentation":"

An array of RuleSummary objects.

" } } }, "ListSizeConstraintSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you specify a value for Limit and you have more SizeConstraintSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SizeConstraintSets. For the second and subsequent ListSizeConstraintSets requests, specify the value of NextMarker from the previous response to get information about another batch of SizeConstraintSets.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

Specifies the number of SizeConstraintSet objects that you want AWS WAF to return for this request. If you have more SizeConstraintSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of SizeConstraintSet objects.

" } } }, "ListSizeConstraintSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you have more SizeConstraintSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SizeConstraintSet objects, submit another ListSizeConstraintSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

" }, "SizeConstraintSets":{ "shape":"SizeConstraintSetSummaries", "documentation":"

An array of SizeConstraintSetSummary objects.

" } } }, "ListSqlInjectionMatchSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you specify a value for Limit and you have more SqlInjectionMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SqlInjectionMatchSets. For the second and subsequent ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of SqlInjectionMatchSets.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If you have more SqlInjectionMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

" } }, "documentation":"

A request to list the SqlInjectionMatchSet objects created by the current AWS account.

" }, "ListSqlInjectionMatchSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

" }, "SqlInjectionMatchSets":{ "shape":"SqlInjectionMatchSetSummaries", "documentation":"

An array of SqlInjectionMatchSetSummary objects.

" } }, "documentation":"

The response to a ListSqlInjectionMatchSets request.

" }, "ListWebACLsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of WebACL objects. For the second and subsequent ListWebACLs requests, specify the value of NextMarker from the previous response to get information about another batch of WebACL objects.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have more WebACL objects than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of WebACL objects.

" } } }, "ListWebACLsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you have more WebACL objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more WebACL objects, submit another ListWebACLs request, and specify the NextMarker value from the response in the NextMarker value in the next request.

" }, "WebACLs":{ "shape":"WebACLSummaries", "documentation":"

An array of WebACLSummary objects.

" } } }, "ListXssMatchSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you specify a value for Limit and you have more XssMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of XssMatchSets.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more XssMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

" } }, "documentation":"

A request to list the XssMatchSet objects created by the current AWS account.

" }, "ListXssMatchSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

" }, "XssMatchSets":{ "shape":"XssMatchSetSummaries", "documentation":"

An array of XssMatchSetSummary objects.

" } }, "documentation":"

The response to a ListXssMatchSets request.

" }, "MatchFieldData":{"type":"string"}, "MatchFieldType":{ "type":"string", "enum":[ "URI", "QUERY_STRING", "HEADER", "METHOD", "BODY" ] }, "MetricName":{"type":"string"}, "Negated":{"type":"boolean"}, "NextMarker":{ "type":"string", "min":1 }, "PaginationLimit":{ "type":"integer", "max":100, "min":0 }, "ParameterExceptionField":{ "type":"string", "enum":[ "CHANGE_ACTION", "WAF_ACTION", "PREDICATE_TYPE", "IPSET_TYPE", "BYTE_MATCH_FIELD_TYPE", "SQL_INJECTION_MATCH_FIELD_TYPE", "BYTE_MATCH_TEXT_TRANSFORMATION", "BYTE_MATCH_POSITIONAL_CONSTRAINT", "SIZE_CONSTRAINT_COMPARISON_OPERATOR" ] }, "ParameterExceptionParameter":{ "type":"string", "min":1 }, "ParameterExceptionReason":{ "type":"string", "enum":[ "INVALID_OPTION", "ILLEGAL_COMBINATION" ] }, "PopulationSize":{"type":"long"}, "PositionalConstraint":{ "type":"string", "enum":[ "EXACTLY", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "CONTAINS_WORD" ] }, "Predicate":{ "type":"structure", "required":[ "Negated", "Type", "DataId" ], "members":{ "Negated":{ "shape":"Negated", "documentation":"

Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

" }, "Type":{ "shape":"PredicateType", "documentation":"

The type of predicate in a Rule, such as ByteMatchSet or IPSet.

" }, "DataId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

" } }, "documentation":"

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.

" }, "PredicateType":{ "type":"string", "enum":[ "IPMatch", "ByteMatch", "SqlInjectionMatch", "SizeConstraint", "XssMatch" ] }, "Predicates":{ "type":"list", "member":{"shape":"Predicate"} }, "ResourceArn":{ "type":"string", "max":1224, "min":1 }, "ResourceArns":{ "type":"list", "member":{"shape":"ResourceArn"} }, "ResourceId":{ "type":"string", "max":128, "min":1 }, "ResourceName":{ "type":"string", "max":128, "min":1 }, "Rule":{ "type":"structure", "required":[ "RuleId", "Predicates" ], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the Rule.

" }, "Predicates":{ "shape":"Predicates", "documentation":"

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

" } }, "documentation":"

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates:

  • An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44

  • A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot.

To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot.

" }, "RulePriority":{"type":"integer"}, "RuleSummaries":{ "type":"list", "member":{"shape":"RuleSummary"} }, "RuleSummary":{ "type":"structure", "required":[ "RuleId", "Name" ], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

" } }, "documentation":"

Contains the identifier and the friendly name or description of the Rule.

" }, "RuleUpdate":{ "type":"structure", "required":[ "Action", "Predicate" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate from a Rule.

" }, "Predicate":{ "shape":"Predicate", "documentation":"

The ID of the Predicate (such as an IPSet) that you want to add to a Rule.

" } }, "documentation":"

Specifies a Predicate (such as an IPSet) and indicates whether you want to add it to a Rule or delete it from a Rule.

" }, "RuleUpdates":{ "type":"list", "member":{"shape":"RuleUpdate"} }, "SampleWeight":{ "type":"long", "min":0 }, "SampledHTTPRequest":{ "type":"structure", "required":[ "Request", "Weight" ], "members":{ "Request":{ "shape":"HTTPRequest", "documentation":"

A complex type that contains detailed information about the request.

" }, "Weight":{ "shape":"SampleWeight", "documentation":"

A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2 represents roughly twice as many CloudFront web requests as a result that has a weight of 1.

" }, "Timestamp":{ "shape":"Timestamp", "documentation":"

The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

" }, "Action":{ "shape":"Action", "documentation":"

The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT.

" } }, "documentation":"

The response from a GetSampledRequests request includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains one SampledHTTPRequest object for each web request that is returned by GetSampledRequests.

" }, "SampledHTTPRequests":{ "type":"list", "member":{"shape":"SampledHTTPRequest"} }, "Size":{ "type":"long", "max":21474836480, "min":0 }, "SizeConstraint":{ "type":"structure", "required":[ "FieldToMatch", "TextTransformation", "ComparisonOperator", "Size" ], "members":{ "FieldToMatch":{ "shape":"FieldToMatch", "documentation":"

Specifies where in a web request to look for the size constraint.

" }, "TextTransformation":{ "shape":"TextTransformation", "documentation":"

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection.

NONE

Specify NONE if you don't want to perform any text transformations.

CMD_LINE

When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

  • Delete the following characters: \\ \" ' ^

  • Delete spaces before the following characters: / (

  • Replace the following characters with a space: , ;

  • Replace multiple spaces with one space

  • Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

  • \\f, formfeed, decimal 12

  • \\t, tab, decimal 9

  • \\n, newline, decimal 10

  • \\r, carriage return, decimal 13

  • \\v, vertical tab, decimal 11

  • non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

  • Replaces (ampersand)quot; with \"

  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

  • Replaces (ampersand)lt; with a \"less than\" symbol

  • Replaces (ampersand)gt; with >

  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

" }, "ComparisonOperator":{ "shape":"ComparisonOperator", "documentation":"

The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.

EQ: Used to test if the Size is equal to the size of the FieldToMatch

NE: Used to test if the Size is not equal to the size of the FieldToMatch

LE: Used to test if the Size is less than or equal to the size of the FieldToMatch

LT: Used to test if the Size is strictly less than the size of the FieldToMatch

GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch

GT: Used to test if the Size is strictly greater than the size of the FieldToMatch

" }, "Size":{ "shape":"Size", "documentation":"

The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.

Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).

If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

" } }, "documentation":"

Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.

" }, "SizeConstraintSet":{ "type":"structure", "required":[ "SizeConstraintSetId", "SizeConstraints" ], "members":{ "SizeConstraintSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).

SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name, if any, of the SizeConstraintSet.

" }, "SizeConstraints":{ "shape":"SizeConstraints", "documentation":"

Specifies the parts of web requests that you want to inspect the size of.

" } }, "documentation":"

A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match.

" }, "SizeConstraintSetSummaries":{ "type":"list", "member":{"shape":"SizeConstraintSetSummary"} }, "SizeConstraintSetSummary":{ "type":"structure", "required":[ "SizeConstraintSetId", "Name" ], "members":{ "SizeConstraintSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).

SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name of the SizeConstraintSet, if any.

" } }, "documentation":"

The Id and Name of a SizeConstraintSet.

" }, "SizeConstraintSetUpdate":{ "type":"structure", "required":[ "Action", "SizeConstraint" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet.

" }, "SizeConstraint":{ "shape":"SizeConstraint", "documentation":"

Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.

" } }, "documentation":"

Specifies the part of a web request that you want to inspect the size of and indicates whether you want to add the specification to a SizeConstraintSet or delete it from a SizeConstraintSet.

" }, "SizeConstraintSetUpdates":{ "type":"list", "member":{"shape":"SizeConstraintSetUpdate"} }, "SizeConstraints":{ "type":"list", "member":{"shape":"SizeConstraint"} }, "SqlInjectionMatchSet":{ "type":"structure", "required":[ "SqlInjectionMatchSetId", "SqlInjectionMatchTuples" ], "members":{ "SqlInjectionMatchSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet).

SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name, if any, of the SqlInjectionMatchSet.

" }, "SqlInjectionMatchTuples":{ "shape":"SqlInjectionMatchTuples", "documentation":"

Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.

" } }, "documentation":"

A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match.

" }, "SqlInjectionMatchSetSummaries":{ "type":"list", "member":{"shape":"SqlInjectionMatchSetSummary"} }, "SqlInjectionMatchSetSummary":{ "type":"structure", "required":[ "SqlInjectionMatchSetId", "Name" ], "members":{ "SqlInjectionMatchSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet).

SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name of the SqlInjectionMatchSet, if any, specified by Id.

" } }, "documentation":"

The Id and Name of a SqlInjectionMatchSet.

" }, "SqlInjectionMatchSetUpdate":{ "type":"structure", "required":[ "Action", "SqlInjectionMatchTuple" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet.

" }, "SqlInjectionMatchTuple":{ "shape":"SqlInjectionMatchTuple", "documentation":"

Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

" } }, "documentation":"

Specifies the part of a web request that you want to inspect for snippets of malicious SQL code and indicates whether you want to add the specification to a SqlInjectionMatchSet or delete it from a SqlInjectionMatchSet.

" }, "SqlInjectionMatchSetUpdates":{ "type":"list", "member":{"shape":"SqlInjectionMatchSetUpdate"} }, "SqlInjectionMatchTuple":{ "type":"structure", "required":[ "FieldToMatch", "TextTransformation" ], "members":{ "FieldToMatch":{ "shape":"FieldToMatch", "documentation":"

Specifies where in a web request to look for snippets of malicious SQL code.

" }, "TextTransformation":{ "shape":"TextTransformation", "documentation":"

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

  • Delete the following characters: \\ \" ' ^

  • Delete spaces before the following characters: / (

  • Replace the following characters with a space: , ;

  • Replace multiple spaces with one space

  • Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

  • \\f, formfeed, decimal 12

  • \\t, tab, decimal 9

  • \\n, newline, decimal 10

  • \\r, carriage return, decimal 13

  • \\v, vertical tab, decimal 11

  • non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

  • Replaces (ampersand)quot; with \"

  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

  • Replaces (ampersand)lt; with a \"less than\" symbol

  • Replaces (ampersand)gt; with >

  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

" } }, "documentation":"

Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

" }, "SqlInjectionMatchTuples":{ "type":"list", "member":{"shape":"SqlInjectionMatchTuple"} }, "TextTransformation":{ "type":"string", "enum":[ "NONE", "COMPRESS_WHITE_SPACE", "HTML_ENTITY_DECODE", "LOWERCASE", "CMD_LINE", "URL_DECODE" ] }, "TimeWindow":{ "type":"structure", "required":[ "StartTime", "EndTime" ], "members":{ "StartTime":{ "shape":"Timestamp", "documentation":"

The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

" }, "EndTime":{ "shape":"Timestamp", "documentation":"

The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

" } }, "documentation":"

In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want AWS WAF to return a sample of web requests.

In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request.

" }, "Timestamp":{"type":"timestamp"}, "URIString":{"type":"string"}, "UpdateByteMatchSetRequest":{ "type":"structure", "required":[ "ByteMatchSetId", "ChangeToken", "Updates" ], "members":{ "ByteMatchSetId":{ "shape":"ResourceId", "documentation":"

The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"ByteMatchSetUpdates", "documentation":"

An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:

" } } }, "UpdateByteMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the UpdateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "UpdateIPSetRequest":{ "type":"structure", "required":[ "IPSetId", "ChangeToken", "Updates" ], "members":{ "IPSetId":{ "shape":"ResourceId", "documentation":"

The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"IPSetUpdates", "documentation":"

An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types:

" } } }, "UpdateIPSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the UpdateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "UpdateRuleRequest":{ "type":"structure", "required":[ "RuleId", "ChangeToken", "Updates" ], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"RuleUpdates", "documentation":"

An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:

" } } }, "UpdateRuleResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the UpdateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "UpdateSizeConstraintSetRequest":{ "type":"structure", "required":[ "SizeConstraintSetId", "ChangeToken", "Updates" ], "members":{ "SizeConstraintSetId":{ "shape":"ResourceId", "documentation":"

The SizeConstraintSetId of the SizeConstraintSet that you want to update. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"SizeConstraintSetUpdates", "documentation":"

An array of SizeConstraintSetUpdate objects that you want to insert into or delete from a SizeConstraintSet. For more information, see the applicable data types:

" } } }, "UpdateSizeConstraintSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the UpdateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "UpdateSqlInjectionMatchSetRequest":{ "type":"structure", "required":[ "SqlInjectionMatchSetId", "ChangeToken", "Updates" ], "members":{ "SqlInjectionMatchSetId":{ "shape":"ResourceId", "documentation":"

The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"SqlInjectionMatchSetUpdates", "documentation":"

An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a SqlInjectionMatchSet. For more information, see the applicable data types:

" } }, "documentation":"

A request to update a SqlInjectionMatchSet.

" }, "UpdateSqlInjectionMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the UpdateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } }, "documentation":"

The response to an UpdateSqlInjectionMatchSets request.

" }, "UpdateWebACLRequest":{ "type":"structure", "required":[ "WebACLId", "ChangeToken" ], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"WebACLUpdates", "documentation":"

An array of updates to make to the WebACL.

An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:

" }, "DefaultAction":{ "shape":"WafAction", "documentation":"

A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL.

" } } }, "UpdateWebACLResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the UpdateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "UpdateXssMatchSetRequest":{ "type":"structure", "required":[ "XssMatchSetId", "ChangeToken", "Updates" ], "members":{ "XssMatchSetId":{ "shape":"ResourceId", "documentation":"

The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"XssMatchSetUpdates", "documentation":"

An array of XssMatchSetUpdate objects that you want to insert into or delete from a XssMatchSet. For more information, see the applicable data types:

" } }, "documentation":"

A request to update an XssMatchSet.

" }, "UpdateXssMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the UpdateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } }, "documentation":"

The response to an UpdateXssMatchSets request.

" }, "WAFDisallowedNameException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The name specified is invalid.

", "exception":true }, "WAFInternalErrorException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because of a system problem, even though the request was valid. Retry your request.

", "exception":true, "fault":true }, "WAFInvalidAccountException":{ "type":"structure", "members":{ }, "documentation":"

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

", "exception":true }, "WAFInvalidOperationException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because there was nothing to do. For example:

  • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

  • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

  • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

  • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

  • You tried to add an IP address to an IPSet, but the IP address already exists in the specified IPSet.

  • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

", "exception":true }, "WAFInvalidParameterException":{ "type":"structure", "members":{ "field":{"shape":"ParameterExceptionField"}, "parameter":{"shape":"ParameterExceptionParameter"}, "reason":{"shape":"ParameterExceptionReason"} }, "documentation":"

The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

  • You specified an invalid parameter name.

  • You specified an invalid value.

  • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

  • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

  • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

  • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, QUERY_STRING, or URI.

  • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

", "exception":true }, "WAFLimitsExceededException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.

", "exception":true }, "WAFNonEmptyEntityException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because you tried to delete an object that isn't empty. For example:

  • You tried to delete a WebACL that still contains one or more Rule objects.

  • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

  • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

  • You tried to delete an IPSet that references one or more IP addresses.

", "exception":true }, "WAFNonexistentContainerException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

  • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

  • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

  • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

  • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

", "exception":true }, "WAFNonexistentItemException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because the referenced object doesn't exist.

", "exception":true }, "WAFReferencedItemException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because you tried to delete an object that is still in use. For example:

  • You tried to delete a ByteMatchSet that is still referenced by a Rule.

  • You tried to delete a Rule that is still referenced by a WebACL.

", "exception":true }, "WAFStaleDataException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

", "exception":true }, "WAFUnavailableEntityException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because the entity referenced is temporarily unavailable. Retry your request.

", "exception":true }, "WafAction":{ "type":"structure", "required":["Type"], "members":{ "Type":{ "shape":"WafActionType", "documentation":"

Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

  • ALLOW: AWS WAF allows requests

  • BLOCK: AWS WAF blocks requests

  • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

" } }, "documentation":"

For the action that is associated with a rule in a WebACL, specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL, specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL.

" }, "WafActionType":{ "type":"string", "enum":[ "BLOCK", "ALLOW", "COUNT" ] }, "WebACL":{ "type":"structure", "required":[ "WebACLId", "DefaultAction", "Rules" ], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the WebACL.

" }, "DefaultAction":{ "shape":"WafAction", "documentation":"

The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

" }, "Rules":{ "shape":"ActivatedRules", "documentation":"

An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

" } }, "documentation":"

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. For more information, see UpdateWebACL.

" }, "WebACLSummaries":{ "type":"list", "member":{"shape":"WebACLSummary"} }, "WebACLSummary":{ "type":"structure", "required":[ "WebACLId", "Name" ], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

" } }, "documentation":"

Contains the identifier and the name or description of the WebACL.

" }, "WebACLUpdate":{ "type":"structure", "required":[ "Action", "ActivatedRule" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specifies whether to insert a Rule into or delete a Rule from a WebACL.

" }, "ActivatedRule":{ "shape":"ActivatedRule", "documentation":"

The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

" } }, "documentation":"

Specifies whether to insert a Rule into or delete a Rule from a WebACL.

" }, "WebACLUpdates":{ "type":"list", "member":{"shape":"WebACLUpdate"} }, "XssMatchSet":{ "type":"structure", "required":[ "XssMatchSetId", "XssMatchTuples" ], "members":{ "XssMatchSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name, if any, of the XssMatchSet.

" }, "XssMatchTuples":{ "shape":"XssMatchTuples", "documentation":"

Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

" } }, "documentation":"

A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match.

" }, "XssMatchSetSummaries":{ "type":"list", "member":{"shape":"XssMatchSetSummary"} }, "XssMatchSetSummary":{ "type":"structure", "required":[ "XssMatchSetId", "Name" ], "members":{ "XssMatchSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name of the XssMatchSet, if any, specified by Id.

" } }, "documentation":"

The Id and Name of an XssMatchSet.

" }, "XssMatchSetUpdate":{ "type":"structure", "required":[ "Action", "XssMatchTuple" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specify INSERT to add a XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove a XssMatchSetUpdate from an XssMatchSet.

" }, "XssMatchTuple":{ "shape":"XssMatchTuple", "documentation":"

Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

" } }, "documentation":"

Specifies the part of a web request that you want to inspect for cross-site scripting attacks and indicates whether you want to add the specification to an XssMatchSet or delete it from an XssMatchSet.

" }, "XssMatchSetUpdates":{ "type":"list", "member":{"shape":"XssMatchSetUpdate"} }, "XssMatchTuple":{ "type":"structure", "required":[ "FieldToMatch", "TextTransformation" ], "members":{ "FieldToMatch":{ "shape":"FieldToMatch", "documentation":"

Specifies where in a web request to look for cross-site scripting attacks.

" }, "TextTransformation":{ "shape":"TextTransformation", "documentation":"

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

  • Delete the following characters: \\ \" ' ^

  • Delete spaces before the following characters: / (

  • Replace the following characters with a space: , ;

  • Replace multiple spaces with one space

  • Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

  • \\f, formfeed, decimal 12

  • \\t, tab, decimal 9

  • \\n, newline, decimal 10

  • \\r, carriage return, decimal 13

  • \\v, vertical tab, decimal 11

  • non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

  • Replaces (ampersand)quot; with \"

  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

  • Replaces (ampersand)lt; with a \"less than\" symbol

  • Replaces (ampersand)gt; with >

  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

" } }, "documentation":"

Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

" }, "XssMatchTuples":{ "type":"list", "member":{"shape":"XssMatchTuple"} }, "errorMessage":{"type":"string"} }, "documentation":"

This is the AWS WAF Regional API Reference for using AWS WAF with Elastic Load Balancing (ELB) Application Load Balancers. The AWS WAF actions and data types listed in the reference are available for protecting Application Load Balancers. You can use these actions and data types by means of the endpoints listed in AWS Regions and Endpoints. This guide is for developers who need detailed information about the AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use the AWS WAF API, see the AWS WAF Developer Guide.

" } botocore-1.5.7/botocore/data/ec2/0000777454262600001440000000000013042511307017604 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ec2/2015-03-01/0000777454262600001440000000000013042511307020631 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ec2/2015-03-01/waiters-2.json0000666454262600001440000002544013042511306023345 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "BundleTaskComplete": { "delay": 15, "operation": "DescribeBundleTasks", "maxAttempts": 40, "acceptors": [ { "expected": "complete", "matcher": "pathAll", "state": "success", "argument": "BundleTasks[].State" }, { "expected": "failed", "matcher": "pathAny", "state": "failure", "argument": "BundleTasks[].State" } ] }, "ConversionTaskCancelled": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "cancelled", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" } ] }, "ConversionTaskCompleted": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" }, { "expected": "cancelled", "matcher": "pathAny", "state": "failure", "argument": "ConversionTasks[].State" }, { "expected": "cancelling", "matcher": "pathAny", "state": "failure", "argument": "ConversionTasks[].State" } ] }, "ConversionTaskDeleted": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" } ] }, "CustomerGatewayAvailable": { "delay": 15, "operation": "DescribeCustomerGateways", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "CustomerGateways[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "CustomerGateways[].State" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "CustomerGateways[].State" } ] }, "ExportTaskCancelled": { "delay": 15, "operation": "DescribeExportTasks", "maxAttempts": 40, "acceptors": [ { "expected": "cancelled", "matcher": "pathAll", "state": "success", "argument": "ExportTasks[].State" } ] }, "ExportTaskCompleted": { "delay": 15, "operation": "DescribeExportTasks", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "ExportTasks[].State" } ] }, "ImageAvailable": { "operation": "DescribeImages", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "Images[].State", "expected": "available" }, { "state": "failure", "matcher": "pathAny", "argument": "Images[].State", "expected": "failed" } ] }, "InstanceRunning": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "running", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "shutting-down", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "InstanceStatusOk": { "operation": "DescribeInstanceStatus", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "InstanceStatuses[].InstanceStatus.Status", "expected": "ok" } ] }, "InstanceStopped": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "stopped", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "InstanceTerminated": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "terminated", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "PasswordDataAvailable": { "operation": "GetPasswordData", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "path", "argument": "length(PasswordData) > `0`", "expected": true } ] }, "SnapshotCompleted": { "delay": 15, "operation": "DescribeSnapshots", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "Snapshots[].State" } ] }, "SpotInstanceRequestFulfilled": { "operation": "DescribeSpotInstanceRequests", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "SpotInstanceRequests[].Status.Code", "expected": "fulfilled" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "schedule-expired" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "canceled-before-fulfillment" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "bad-parameters" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "system-error" } ] }, "SubnetAvailable": { "delay": 15, "operation": "DescribeSubnets", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Subnets[].State" } ] }, "SystemStatusOk": { "operation": "DescribeInstanceStatus", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "InstanceStatuses[].SystemStatus.Status", "expected": "ok" } ] }, "VolumeAvailable": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Volumes[].State" } ] }, "VolumeDeleted": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" } ] }, "VolumeInUse": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "in-use", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Volumes[].State" } ] }, "VpcAvailable": { "delay": 15, "operation": "DescribeVpcs", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Vpcs[].State" } ] }, "VpnConnectionAvailable": { "delay": 15, "operation": "DescribeVpnConnections", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "VpnConnections[].State" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" } ] }, "VpnConnectionDeleted": { "delay": 15, "operation": "DescribeVpnConnections", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "VpnConnections[].State" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" } ] } } } botocore-1.5.7/botocore/data/ec2/2015-03-01/paginators-1.json0000666454262600001440000000263713042511306024040 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeInstanceStatus": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "InstanceStatuses" }, "DescribeInstances": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Reservations" }, "DescribeReservedInstancesModifications": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "ReservedInstancesModifications" }, "DescribeReservedInstancesOfferings": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "ReservedInstancesOfferings" }, "DescribeSpotPriceHistory": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "SpotPriceHistory" }, "DescribeTags": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Tags" }, "DescribeVolumeStatus": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "VolumeStatuses" }, "DescribeSnapshots": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Snapshots" } } } botocore-1.5.7/botocore/data/ec2/2015-03-01/service-2.json0000666454262600001440000217511713042511306023340 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-03-01", "endpointPrefix":"ec2", "serviceAbbreviation":"Amazon EC2", "serviceFullName":"Amazon Elastic Compute Cloud", "signatureVersion":"v4", "xmlNamespace":"http://ec2.amazonaws.com/doc/2015-03-01", "protocol":"ec2" }, "documentation":"Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.

", "operations":{ "AcceptVpcPeeringConnection":{ "name":"AcceptVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, "output":{"shape":"AcceptVpcPeeringConnectionResult"}, "documentation":"

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.

" }, "AllocateAddress":{ "name":"AllocateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AllocateAddressRequest"}, "output":{"shape":"AllocateAddressResult"}, "documentation":"

Acquires an Elastic IP address.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "AssignPrivateIpAddresses":{ "name":"AssignPrivateIpAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssignPrivateIpAddressesRequest"}, "documentation":"

Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

AssignPrivateIpAddresses is available only in EC2-VPC.

" }, "AssociateAddress":{ "name":"AssociateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateAddressRequest"}, "output":{"shape":"AssociateAddressResult"}, "documentation":"

Associates an Elastic IP address with an instance or a network interface.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" }, "AssociateDhcpOptions":{ "name":"AssociateDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateDhcpOptionsRequest"}, "documentation":"

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "AssociateRouteTable":{ "name":"AssociateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateRouteTableRequest"}, "output":{"shape":"AssociateRouteTableResult"}, "documentation":"

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "AttachClassicLinkVpc":{ "name":"AttachClassicLinkVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachClassicLinkVpcRequest"}, "output":{"shape":"AttachClassicLinkVpcResult"}, "documentation":"

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" }, "AttachInternetGateway":{ "name":"AttachInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachInternetGatewayRequest"}, "documentation":"

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" }, "AttachNetworkInterface":{ "name":"AttachNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachNetworkInterfaceRequest"}, "output":{"shape":"AttachNetworkInterfaceResult"}, "documentation":"

Attaches a network interface to an instance.

" }, "AttachVolume":{ "name":"AttachVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachVolumeRequest"}, "output":{ "shape":"VolumeAttachment", "locationName":"attachment" }, "documentation":"

Attaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.

For a list of supported device names, see Attaching an Amazon EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for Amazon EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide for Linux.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.
  • AWS Marketplace product codes are copied from the volume to the instance.
  • You must be subscribed to the product.
  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For an overview of the AWS Marketplace, see Introducing AWS Marketplace.

For more information about Amazon EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "AttachVpnGateway":{ "name":"AttachVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachVpnGatewayRequest"}, "output":{"shape":"AttachVpnGatewayResult"}, "documentation":"

Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "AuthorizeSecurityGroupEgress":{ "name":"AuthorizeSecurityGroupEgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, "documentation":"

Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC.

You can have up to 50 rules per security group (covering both ingress and egress rules).

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

" }, "AuthorizeSecurityGroupIngress":{ "name":"AuthorizeSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, "documentation":"

Adds one or more ingress rules to a security group.

EC2-Classic: You can have up to 100 rules per group.

EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.

[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.

" }, "BundleInstance":{ "name":"BundleInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BundleInstanceRequest"}, "output":{"shape":"BundleInstanceResult"}, "documentation":"

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

For more information, see Creating an Instance Store-Backed Windows AMI.

" }, "CancelBundleTask":{ "name":"CancelBundleTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelBundleTaskRequest"}, "output":{"shape":"CancelBundleTaskResult"}, "documentation":"

Cancels a bundling operation for an instance store-backed Windows instance.

" }, "CancelConversionTask":{ "name":"CancelConversionTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelConversionRequest"}, "documentation":"

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CancelExportTask":{ "name":"CancelExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelExportTaskRequest"}, "documentation":"

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" }, "CancelImportTask":{ "name":"CancelImportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelImportTaskRequest"}, "output":{"shape":"CancelImportTaskResult"}, "documentation":"

Cancels an in-process import virtual machine or import snapshot task.

" }, "CancelReservedInstancesListing":{ "name":"CancelReservedInstancesListing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelReservedInstancesListingRequest"}, "output":{"shape":"CancelReservedInstancesListingResult"}, "documentation":"

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CancelSpotInstanceRequests":{ "name":"CancelSpotInstanceRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelSpotInstanceRequestsRequest"}, "output":{"shape":"CancelSpotInstanceRequestsResult"}, "documentation":"

Cancels one or more Spot Instance requests. Spot Instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide for Linux.

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

" }, "ConfirmProductInstance":{ "name":"ConfirmProductInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmProductInstanceRequest"}, "output":{"shape":"ConfirmProductInstanceResult"}, "documentation":"

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.

" }, "CopyImage":{ "name":"CopyImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyImageRequest"}, "output":{"shape":"CopyImageResult"}, "documentation":"

Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted Amazon EBS snapshots cannot be copied with this method.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CopySnapshot":{ "name":"CopySnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopySnapshotRequest"}, "output":{"shape":"CopySnapshotResult"}, "documentation":"

Copies a point-in-time snapshot of an Amazon EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create Amazon EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted Amazon EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted.

Copying snapshots that were encrypted with non-default AWS Key Management Service (KMS) master keys is not supported at this time.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateCustomerGateway":{ "name":"CreateCustomerGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCustomerGatewayRequest"}, "output":{"shape":"CreateCustomerGatewayResult"}, "documentation":"

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.

" }, "CreateDhcpOptions":{ "name":"CreateDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDhcpOptionsRequest"}, "output":{"shape":"CreateDhcpOptionsResult"}, "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.
  • domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.
  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateImage":{ "name":"CreateImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateImageRequest"}, "output":{"shape":"CreateImageResult"}, "documentation":"

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateInstanceExportTask":{ "name":"CreateInstanceExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInstanceExportTaskRequest"}, "output":{"shape":"CreateInstanceExportTaskResult"}, "documentation":"

Exports a running or stopped instance to an Amazon S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting EC2 Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateInternetGateway":{ "name":"CreateInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInternetGatewayRequest"}, "output":{"shape":"CreateInternetGatewayResult"}, "documentation":"

Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" }, "CreateKeyPair":{ "name":"CreateKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateKeyPairRequest"}, "output":{ "shape":"KeyPair", "documentation":"

Information about the key pair.

", "locationName":"keyPair" }, "documentation":"

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateNetworkAcl":{ "name":"CreateNetworkAcl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkAclRequest"}, "output":{"shape":"CreateNetworkAclResult"}, "documentation":"

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkAclEntry":{ "name":"CreateNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkAclEntryRequest"}, "documentation":"

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkInterface":{ "name":"CreateNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkInterfaceRequest"}, "output":{"shape":"CreateNetworkInterfaceResult"}, "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreatePlacementGroup":{ "name":"CreatePlacementGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlacementGroupRequest"}, "documentation":"

Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.

For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateReservedInstancesListing":{ "name":"CreateReservedInstancesListing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateReservedInstancesListingRequest"}, "output":{"shape":"CreateReservedInstancesListingResult"}, "documentation":"

Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the DescribeReservedInstances operation.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Reserved Instances, you must first register as a Seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateRoute":{ "name":"CreateRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRouteRequest"}, "documentation":"

Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "CreateRouteTable":{ "name":"CreateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRouteTableRequest"}, "output":{"shape":"CreateRouteTableResult"}, "documentation":"

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "CreateSecurityGroup":{ "name":"CreateSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSecurityGroupRequest"}, "output":{"shape":"CreateSecurityGroupResult"}, "documentation":"

Creates a security group.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide for Linux and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

EC2-Classic: You can have up to 500 security groups.

EC2-VPC: You can create up to 100 security groups per VPC.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

" }, "CreateSnapshot":{ "name":"CreateSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSnapshotRequest"}, "output":{ "shape":"Snapshot", "locationName":"snapshot" }, "documentation":"

Creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of Amazon EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateSpotDatafeedSubscription":{ "name":"CreateSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, "documentation":"

Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateSubnet":{ "name":"CreateSubnet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSubnetRequest"}, "output":{"shape":"CreateSubnetResult"}, "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).

AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateTags":{ "name":"CreateTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTagsRequest"}, "documentation":"

Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateVolume":{ "name":"CreateVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVolumeRequest"}, "output":{ "shape":"Volume", "locationName":"volume" }, "documentation":"

Creates an Amazon EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an Amazon EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateVpc":{ "name":"CreateVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcRequest"}, "output":{"shape":"CreateVpcResult"}, "documentation":"

Creates a VPC with the specified CIDR block.

The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpcPeeringConnection":{ "name":"CreateVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcPeeringConnectionRequest"}, "output":{"shape":"CreateVpcPeeringConnectionResult"}, "documentation":"

Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.

The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.

" }, "CreateVpnConnection":{ "name":"CreateVpnConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnConnectionRequest"}, "output":{"shape":"CreateVpnConnectionResult"}, "documentation":"

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpnConnectionRoute":{ "name":"CreateVpnConnectionRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnConnectionRouteRequest"}, "documentation":"

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpnGateway":{ "name":"CreateVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnGatewayRequest"}, "output":{"shape":"CreateVpnGatewayResult"}, "documentation":"

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DeleteCustomerGateway":{ "name":"DeleteCustomerGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCustomerGatewayRequest"}, "documentation":"

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" }, "DeleteDhcpOptions":{ "name":"DeleteDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDhcpOptionsRequest"}, "documentation":"

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" }, "DeleteInternetGateway":{ "name":"DeleteInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteInternetGatewayRequest"}, "documentation":"

Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.

" }, "DeleteKeyPair":{ "name":"DeleteKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteKeyPairRequest"}, "documentation":"

Deletes the specified key pair, by removing the public key from Amazon EC2.

" }, "DeleteNetworkAcl":{ "name":"DeleteNetworkAcl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkAclRequest"}, "documentation":"

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" }, "DeleteNetworkAclEntry":{ "name":"DeleteNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkAclEntryRequest"}, "documentation":"

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" }, "DeleteNetworkInterface":{ "name":"DeleteNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkInterfaceRequest"}, "documentation":"

Deletes the specified network interface. You must detach the network interface before you can delete it.

" }, "DeletePlacementGroup":{ "name":"DeletePlacementGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePlacementGroupRequest"}, "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DeleteRoute":{ "name":"DeleteRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRouteRequest"}, "documentation":"

Deletes the specified route from the specified route table.

" }, "DeleteRouteTable":{ "name":"DeleteRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRouteTableRequest"}, "documentation":"

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" }, "DeleteSecurityGroup":{ "name":"DeleteSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSecurityGroupRequest"}, "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" }, "DeleteSnapshot":{ "name":"DeleteSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSnapshotRequest"}, "documentation":"

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an Amazon EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DeleteSpotDatafeedSubscription":{ "name":"DeleteSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSpotDatafeedSubscriptionRequest"}, "documentation":"

Deletes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DeleteSubnet":{ "name":"DeleteSubnet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSubnetRequest"}, "documentation":"

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsRequest"}, "documentation":"

Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DeleteVolume":{ "name":"DeleteVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVolumeRequest"}, "documentation":"

Deletes the specified Amazon EBS volume. The volume must be in the available state (not attached to an instance).

The volume may remain in the deleting state for several minutes.

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DeleteVpc":{ "name":"DeleteVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcRequest"}, "documentation":"

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" }, "DeleteVpcPeeringConnection":{ "name":"DeleteVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, "output":{"shape":"DeleteVpcPeeringConnectionResult"}, "documentation":"

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.

" }, "DeleteVpnConnection":{ "name":"DeleteVpnConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnConnectionRequest"}, "documentation":"

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" }, "DeleteVpnConnectionRoute":{ "name":"DeleteVpnConnectionRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnConnectionRouteRequest"}, "documentation":"

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" }, "DeleteVpnGateway":{ "name":"DeleteVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnGatewayRequest"}, "documentation":"

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" }, "DeregisterImage":{ "name":"DeregisterImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterImageRequest"}, "documentation":"

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

This command does not delete the AMI.

" }, "DescribeAccountAttributes":{ "name":"DescribeAccountAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAccountAttributesRequest"}, "output":{"shape":"DescribeAccountAttributesResult"}, "documentation":"

Describes attributes of your AWS account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: The maximum number of On-Demand instances that you can run.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

" }, "DescribeAddresses":{ "name":"DescribeAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAddressesRequest"}, "output":{"shape":"DescribeAddressesResult"}, "documentation":"

Describes one or more of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeAvailabilityZones":{ "name":"DescribeAvailabilityZones", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAvailabilityZonesRequest"}, "output":{"shape":"DescribeAvailabilityZonesResult"}, "documentation":"

Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeBundleTasks":{ "name":"DescribeBundleTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeBundleTasksRequest"}, "output":{"shape":"DescribeBundleTasksResult"}, "documentation":"

Describes one or more of your bundling tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

" }, "DescribeClassicLinkInstances":{ "name":"DescribeClassicLinkInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClassicLinkInstancesRequest"}, "output":{"shape":"DescribeClassicLinkInstancesResult"}, "documentation":"

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.

" }, "DescribeConversionTasks":{ "name":"DescribeConversionTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConversionTasksRequest"}, "output":{"shape":"DescribeConversionTasksResult"}, "documentation":"

Describes one or more of your conversion tasks. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeCustomerGateways":{ "name":"DescribeCustomerGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCustomerGatewaysRequest"}, "output":{"shape":"DescribeCustomerGatewaysResult"}, "documentation":"

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeDhcpOptions":{ "name":"DescribeDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDhcpOptionsRequest"}, "output":{"shape":"DescribeDhcpOptionsResult"}, "documentation":"

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeExportTasks":{ "name":"DescribeExportTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeExportTasksRequest"}, "output":{"shape":"DescribeExportTasksResult"}, "documentation":"

Describes one or more of your export tasks.

" }, "DescribeImageAttribute":{ "name":"DescribeImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImageAttributeRequest"}, "output":{ "shape":"ImageAttribute", "documentation":"

Information about the image attribute.

", "locationName":"imageAttribute" }, "documentation":"

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" }, "DescribeImages":{ "name":"DescribeImages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImagesRequest"}, "output":{"shape":"DescribeImagesResult"}, "documentation":"

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

Deregistered images are included in the returned results for an unspecified interval after deregistration.

" }, "DescribeImportImageTasks":{ "name":"DescribeImportImageTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImportImageTasksRequest"}, "output":{"shape":"DescribeImportImageTasksResult"}, "documentation":"

Displays details about an import virtual machine or import snapshot tasks that are already created.

" }, "DescribeImportSnapshotTasks":{ "name":"DescribeImportSnapshotTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImportSnapshotTasksRequest"}, "output":{"shape":"DescribeImportSnapshotTasksResult"}, "documentation":"

Displays details about an import snapshot tasks that is already created.

" }, "DescribeInstanceAttribute":{ "name":"DescribeInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceAttributeRequest"}, "output":{"shape":"InstanceAttribute"}, "documentation":"

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" }, "DescribeInstanceStatus":{ "name":"DescribeInstanceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceStatusRequest"}, "output":{"shape":"DescribeInstanceStatusResult"}, "documentation":"

Describes the status of one or more instances, including any scheduled events.

Instance status has two main components:

  • System Status reports impaired functionality that stems from issues related to the systems that support an instance, such as such as hardware failures and network connectivity problems. This call reports such problems as impaired reachability.

  • Instance Status reports impaired functionality that arises from problems internal to the instance. This call reports such problems as impaired reachability.

Instance status provides information about four types of scheduled events for an instance that may require your attention:

  • Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the instances status returns one of two event codes: system-reboot or instance-reboot. System reboot commonly occurs if certain maintenance or upgrade operations require a reboot of the underlying host that supports an instance. Instance reboot commonly occurs if the instance must be rebooted, rather than the underlying host. Rebooting events include a scheduled start and end time.

  • System Maintenance: When Amazon EC2 determines that an instance requires maintenance that requires power or network impact, the instance status is the event code system-maintenance. System maintenance is either power maintenance or network maintenance. For power maintenance, your instance will be unavailable for a brief period of time and then rebooted. For network maintenance, your instance will experience a brief loss of network connectivity. System maintenance events include a scheduled start and end time. You will also be notified by email if one of your instances is set for system maintenance. The email message indicates when your instance is scheduled for maintenance.

  • Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the instance status is the event code instance-retirement. Retirement commonly occurs when the underlying host is degraded and must be replaced. Retirement events include a scheduled start and end time. You will also be notified by email if one of your instances is set to retiring. The email message indicates when your instance will be permanently retired.

  • Scheduled Stop: When Amazon EC2 determines that an instance must be shut down, the instances status returns an event code called instance-stop. Stop events include a scheduled start and end time. You will also be notified by email if one of your instances is set to stop. The email message indicates when your instance will be stopped.

When your instance is retired, it will either be terminated (if its root device type is the instance-store) or stopped (if its root device type is an EBS volume). Instances stopped due to retirement will not be restarted, but you can do so manually. You can also avoid retirement of EBS-backed instances by manually restarting your instance when its event code is instance-retirement. This ensures that your instance is started on a different underlying host.

For more information about failed status checks, see Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide for Linux. For more information about working with scheduled events, see Working with an Instance That Has a Scheduled Event in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeInstances":{ "name":"DescribeInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancesRequest"}, "output":{"shape":"DescribeInstancesResult"}, "documentation":"

Describes one or more of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

" }, "DescribeInternetGateways":{ "name":"DescribeInternetGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInternetGatewaysRequest"}, "output":{"shape":"DescribeInternetGatewaysResult"}, "documentation":"

Describes one or more of your Internet gateways.

" }, "DescribeKeyPairs":{ "name":"DescribeKeyPairs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeKeyPairsRequest"}, "output":{"shape":"DescribeKeyPairsResult"}, "documentation":"

Describes one or more of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeNetworkAcls":{ "name":"DescribeNetworkAcls", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkAclsRequest"}, "output":{"shape":"DescribeNetworkAclsResult"}, "documentation":"

Describes one or more of your network ACLs.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeNetworkInterfaceAttribute":{ "name":"DescribeNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, "documentation":"

Describes a network interface attribute. You can specify only one attribute at a time.

" }, "DescribeNetworkInterfaces":{ "name":"DescribeNetworkInterfaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkInterfacesRequest"}, "output":{"shape":"DescribeNetworkInterfacesResult"}, "documentation":"

Describes one or more of your network interfaces.

" }, "DescribePlacementGroups":{ "name":"DescribePlacementGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePlacementGroupsRequest"}, "output":{"shape":"DescribePlacementGroupsResult"}, "documentation":"

Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeRegions":{ "name":"DescribeRegions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRegionsRequest"}, "output":{"shape":"DescribeRegionsResult"}, "documentation":"

Describes one or more regions that are currently available to you.

For a list of the regions supported by Amazon EC2, see Regions and Endpoints.

" }, "DescribeReservedInstances":{ "name":"DescribeReservedInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesRequest"}, "output":{"shape":"DescribeReservedInstancesResult"}, "documentation":"

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeReservedInstancesListings":{ "name":"DescribeReservedInstancesListings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesListingsRequest"}, "output":{"shape":"DescribeReservedInstancesListingsResult"}, "documentation":"

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeReservedInstancesModifications":{ "name":"DescribeReservedInstancesModifications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, "output":{"shape":"DescribeReservedInstancesModificationsResult"}, "documentation":"

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeReservedInstancesOfferings":{ "name":"DescribeReservedInstancesOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, "documentation":"

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeRouteTables":{ "name":"DescribeRouteTables", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRouteTablesRequest"}, "output":{"shape":"DescribeRouteTablesResult"}, "documentation":"

Describes one or more of your route tables.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeSecurityGroups":{ "name":"DescribeSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSecurityGroupsRequest"}, "output":{"shape":"DescribeSecurityGroupsResult"}, "documentation":"

Describes one or more of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide for Linux and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeSnapshotAttribute":{ "name":"DescribeSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotAttributeRequest"}, "output":{"shape":"DescribeSnapshotAttributeResult"}, "documentation":"

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeSnapshots":{ "name":"DescribeSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotsRequest"}, "output":{"shape":"DescribeSnapshotsResult"}, "documentation":"

Describes one or more of the Amazon EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.
  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.
  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeSpotDatafeedSubscription":{ "name":"DescribeSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, "documentation":"

Describes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeSpotInstanceRequests":{ "name":"DescribeSpotInstanceRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, "output":{"shape":"DescribeSpotInstanceRequestsResult"}, "documentation":"

Describes the Spot Instance requests that belong to your account. Spot Instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide for Linux.

You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

" }, "DescribeSpotPriceHistory":{ "name":"DescribeSpotPriceHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotPriceHistoryRequest"}, "output":{"shape":"DescribeSpotPriceHistoryResult"}, "documentation":"

Describes the Spot Price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see Spot Instance Pricing History in the Amazon Elastic Compute Cloud User Guide for Linux.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" }, "DescribeSubnets":{ "name":"DescribeSubnets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSubnetsRequest"}, "output":{"shape":"DescribeSubnetsResult"}, "documentation":"

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsRequest"}, "output":{"shape":"DescribeTagsResult"}, "documentation":"

Describes one or more of the tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeVolumeAttribute":{ "name":"DescribeVolumeAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumeAttributeRequest"}, "output":{"shape":"DescribeVolumeAttributeResult"}, "documentation":"

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeVolumeStatus":{ "name":"DescribeVolumeStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumeStatusRequest"}, "output":{"shape":"DescribeVolumeStatusResult"}, "documentation":"

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

" }, "DescribeVolumes":{ "name":"DescribeVolumes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumesRequest"}, "output":{"shape":"DescribeVolumesResult"}, "documentation":"

Describes the specified Amazon EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeVpcAttribute":{ "name":"DescribeVpcAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcAttributeRequest"}, "output":{"shape":"DescribeVpcAttributeResult"}, "documentation":"

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" }, "DescribeVpcClassicLink":{ "name":"DescribeVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcClassicLinkRequest"}, "output":{"shape":"DescribeVpcClassicLinkResult"}, "documentation":"

Describes the ClassicLink status of one or more VPCs.

" }, "DescribeVpcPeeringConnections":{ "name":"DescribeVpcPeeringConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, "documentation":"

Describes one or more of your VPC peering connections.

" }, "DescribeVpcs":{ "name":"DescribeVpcs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcsRequest"}, "output":{"shape":"DescribeVpcsResult"}, "documentation":"

Describes one or more of your VPCs.

" }, "DescribeVpnConnections":{ "name":"DescribeVpnConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpnConnectionsRequest"}, "output":{"shape":"DescribeVpnConnectionsResult"}, "documentation":"

Describes one or more of your VPN connections.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeVpnGateways":{ "name":"DescribeVpnGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpnGatewaysRequest"}, "output":{"shape":"DescribeVpnGatewaysResult"}, "documentation":"

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DetachClassicLinkVpc":{ "name":"DetachClassicLinkVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachClassicLinkVpcRequest"}, "output":{"shape":"DetachClassicLinkVpcResult"}, "documentation":"

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" }, "DetachInternetGateway":{ "name":"DetachInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachInternetGatewayRequest"}, "documentation":"

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.

" }, "DetachNetworkInterface":{ "name":"DetachNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachNetworkInterfaceRequest"}, "documentation":"

Detaches a network interface from an instance.

" }, "DetachVolume":{ "name":"DetachVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachVolumeRequest"}, "output":{ "shape":"VolumeAttachment", "locationName":"attachment" }, "documentation":"

Detaches an Amazon EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching.

If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DetachVpnGateway":{ "name":"DetachVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachVpnGatewayRequest"}, "documentation":"

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" }, "DisableVgwRoutePropagation":{ "name":"DisableVgwRoutePropagation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVgwRoutePropagationRequest"}, "documentation":"

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" }, "DisableVpcClassicLink":{ "name":"DisableVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVpcClassicLinkRequest"}, "output":{"shape":"DisableVpcClassicLinkResult"}, "documentation":"

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

" }, "DisassociateAddress":{ "name":"DisassociateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateAddressRequest"}, "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" }, "DisassociateRouteTable":{ "name":"DisassociateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateRouteTableRequest"}, "documentation":"

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "EnableVgwRoutePropagation":{ "name":"EnableVgwRoutePropagation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVgwRoutePropagationRequest"}, "documentation":"

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" }, "EnableVolumeIO":{ "name":"EnableVolumeIO", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVolumeIORequest"}, "documentation":"

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" }, "EnableVpcClassicLink":{ "name":"EnableVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVpcClassicLinkRequest"}, "output":{"shape":"EnableVpcClassicLinkResult"}, "documentation":"

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "GetConsoleOutput":{ "name":"GetConsoleOutput", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetConsoleOutputRequest"}, "output":{"shape":"GetConsoleOutputResult"}, "documentation":"

Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.

For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output includes output from the EC2Config service.

" }, "GetPasswordData":{ "name":"GetPasswordData", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPasswordDataRequest"}, "output":{"shape":"GetPasswordDataResult"}, "documentation":"

Retrieves the encrypted administrator password for an instance running Windows.

The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" }, "ImportImage":{ "name":"ImportImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportImageRequest"}, "output":{"shape":"ImportImageResult"}, "documentation":"

Import single or multi-volume disk images or Amazon EBS snapshots into an Amazon Machine Image (AMI).

" }, "ImportInstance":{ "name":"ImportInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportInstanceRequest"}, "output":{"shape":"ImportInstanceResult"}, "documentation":"

Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. After importing the image, you then upload it using the ec2-import-volume command in the EC2 command line tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "ImportKeyPair":{ "name":"ImportKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportKeyPairRequest"}, "output":{"shape":"ImportKeyPairResult"}, "documentation":"

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "ImportSnapshot":{ "name":"ImportSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportSnapshotRequest"}, "output":{"shape":"ImportSnapshotResult"}, "documentation":"

Import a disk into an Amazon Elastic Block Store (Amazon EBS) snapshot.

" }, "ImportVolume":{ "name":"ImportVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportVolumeRequest"}, "output":{"shape":"ImportVolumeResult"}, "documentation":"

Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the Amazon EC2 command-line interface (CLI) tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "ModifyImageAttribute":{ "name":"ModifyImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyImageAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

" }, "ModifyInstanceAttribute":{ "name":"ModifyInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyInstanceAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "ModifyNetworkInterfaceAttribute":{ "name":"ModifyNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, "documentation":"

Modifies the specified network interface attribute. You can specify only one attribute at a time.

" }, "ModifyReservedInstances":{ "name":"ModifyReservedInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyReservedInstancesRequest"}, "output":{"shape":"ModifyReservedInstancesResult"}, "documentation":"

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "ModifySnapshotAttribute":{ "name":"ModifySnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySnapshotAttributeRequest"}, "documentation":"

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.

Snapshots with AWS Marketplace product codes cannot be made public.

" }, "ModifySubnetAttribute":{ "name":"ModifySubnetAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySubnetAttributeRequest"}, "documentation":"

Modifies a subnet attribute.

" }, "ModifyVolumeAttribute":{ "name":"ModifyVolumeAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVolumeAttributeRequest"}, "documentation":"

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" }, "ModifyVpcAttribute":{ "name":"ModifyVpcAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified VPC.

" }, "MonitorInstances":{ "name":"MonitorInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MonitorInstancesRequest"}, "output":{"shape":"MonitorInstancesResult"}, "documentation":"

Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "PurchaseReservedInstancesOffering":{ "name":"PurchaseReservedInstancesOffering", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, "documentation":"

Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time. You pay a lower usage rate than with On-Demand instances for the time that you actually use the capacity reservation.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "RebootInstances":{ "name":"RebootInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootInstancesRequest"}, "documentation":"

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If a Linux/Unix instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "RegisterImage":{ "name":"RegisterImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterImageRequest"}, "output":{"shape":"RegisterImageResult"}, "documentation":"

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide for Linux.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide for Linux.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

" }, "RejectVpcPeeringConnection":{ "name":"RejectVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RejectVpcPeeringConnectionRequest"}, "output":{"shape":"RejectVpcPeeringConnectionResult"}, "documentation":"

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" }, "ReleaseAddress":{ "name":"ReleaseAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReleaseAddressRequest"}, "documentation":"

Releases the specified Elastic IP address.

After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

" }, "ReplaceNetworkAclAssociation":{ "name":"ReplaceNetworkAclAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceNetworkAclAssociationRequest"}, "output":{"shape":"ReplaceNetworkAclAssociationResult"}, "documentation":"

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceNetworkAclEntry":{ "name":"ReplaceNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceNetworkAclEntryRequest"}, "documentation":"

Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceRoute":{ "name":"ReplaceRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceRouteRequest"}, "documentation":"

Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceRouteTableAssociation":{ "name":"ReplaceRouteTableAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceRouteTableAssociationRequest"}, "output":{"shape":"ReplaceRouteTableAssociationResult"}, "documentation":"

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" }, "ReportInstanceStatus":{ "name":"ReportInstanceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReportInstanceStatusRequest"}, "documentation":"

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" }, "RequestSpotInstances":{ "name":"RequestSpotInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RequestSpotInstancesRequest"}, "output":{"shape":"RequestSpotInstancesResult"}, "documentation":"

Creates a Spot Instance request. Spot Instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "ResetImageAttribute":{ "name":"ResetImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetImageAttributeRequest"}, "documentation":"

Resets an attribute of an AMI to its default value.

The productCodes attribute can't be reset.

" }, "ResetInstanceAttribute":{ "name":"ResetInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetInstanceAttributeRequest"}, "documentation":"

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the SourceDestCheck, the instance can be either running or stopped.

The SourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" }, "ResetNetworkInterfaceAttribute":{ "name":"ResetNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetNetworkInterfaceAttributeRequest"}, "documentation":"

Resets a network interface attribute. You can specify only one attribute at a time.

" }, "ResetSnapshotAttribute":{ "name":"ResetSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetSnapshotAttributeRequest"}, "documentation":"

Resets permission settings for the specified snapshot.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "RevokeSecurityGroupEgress":{ "name":"RevokeSecurityGroupEgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSecurityGroupEgressRequest"}, "documentation":"

Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" }, "RevokeSecurityGroupIngress":{ "name":"RevokeSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSecurityGroupIngressRequest"}, "documentation":"

Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" }, "RunInstances":{ "name":"RunInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RunInstancesRequest"}, "output":{ "shape":"Reservation", "documentation":"

One or more reservations.

", "locationName":"reservation" }, "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

When you launch an instance, it enters the pending state. After the instance is ready for you, it enters the running state. To check the state of your instance, call DescribeInstances.

If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide for Linux.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.

You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide for Linux.

If any of the AMIs have a product code attached for which the user has not subscribed, RunInstances fails.

T2 instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, RunInstances fails.

For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "StartInstances":{ "name":"StartInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartInstancesRequest"}, "output":{"shape":"StartInstancesResult"}, "documentation":"

Starts an Amazon EBS-backed AMI that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "StopInstances":{ "name":"StopInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopInstancesRequest"}, "output":{"shape":"StopInstancesResult"}, "documentation":"

Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

You can't start or stop Spot Instances.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide for Linux.

For more information about troubleshooting, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "TerminateInstances":{ "name":"TerminateInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateInstancesRequest"}, "output":{"shape":"TerminateInstancesResult"}, "documentation":"

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all Amazon EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide for Linux.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "UnassignPrivateIpAddresses":{ "name":"UnassignPrivateIpAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnassignPrivateIpAddressesRequest"}, "documentation":"

Unassigns one or more secondary private IP addresses from a network interface.

" }, "UnmonitorInstances":{ "name":"UnmonitorInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnmonitorInstancesRequest"}, "output":{"shape":"UnmonitorInstancesResult"}, "documentation":"

Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" } }, "shapes":{ "AcceptVpcPeeringConnectionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "AcceptVpcPeeringConnectionResult":{ "type":"structure", "members":{ "VpcPeeringConnection":{ "shape":"VpcPeeringConnection", "documentation":"

Information about the VPC peering connection.

", "locationName":"vpcPeeringConnection" } } }, "AccountAttribute":{ "type":"structure", "members":{ "AttributeName":{ "shape":"String", "documentation":"

The name of the account attribute.

", "locationName":"attributeName" }, "AttributeValues":{ "shape":"AccountAttributeValueList", "documentation":"

One or more values for the account attribute.

", "locationName":"attributeValueSet" } }, "documentation":"

Describes an account attribute.

" }, "AccountAttributeList":{ "type":"list", "member":{ "shape":"AccountAttribute", "locationName":"item" } }, "AccountAttributeName":{ "type":"string", "enum":[ "supported-platforms", "default-vpc" ] }, "AccountAttributeNameStringList":{ "type":"list", "member":{ "shape":"AccountAttributeName", "locationName":"attributeName" } }, "AccountAttributeValue":{ "type":"structure", "members":{ "AttributeValue":{ "shape":"String", "documentation":"

The value of the attribute.

", "locationName":"attributeValue" } }, "documentation":"

Describes a value of an account attribute.

" }, "AccountAttributeValueList":{ "type":"list", "member":{ "shape":"AccountAttributeValue", "locationName":"item" } }, "Address":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance the address is associated with (if any).

", "locationName":"instanceId" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "AllocationId":{ "shape":"String", "documentation":"

The ID representing the allocation of the address for use with EC2-VPC.

", "locationName":"allocationId" }, "AssociationId":{ "shape":"String", "documentation":"

The ID representing the association of the address with an instance in a VPC.

", "locationName":"associationId" }, "Domain":{ "shape":"DomainType", "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", "locationName":"domain" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "NetworkInterfaceOwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that owns the network interface.

", "locationName":"networkInterfaceOwnerId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address associated with the Elastic IP address.

", "locationName":"privateIpAddress" } }, "documentation":"

Describes an Elastic IP address.

" }, "AddressList":{ "type":"list", "member":{ "shape":"Address", "locationName":"item" } }, "AllocateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Domain":{ "shape":"DomainType", "documentation":"

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" } } }, "AllocateAddressResult":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "Domain":{ "shape":"DomainType", "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", "locationName":"domain" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", "locationName":"allocationId" } } }, "AllocationIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"AllocationId" } }, "ArchitectureValues":{ "type":"string", "enum":[ "i386", "x86_64" ] }, "AssignPrivateIpAddressesRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", "locationName":"privateIpAddress" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", "locationName":"secondaryPrivateIpAddressCount" }, "AllowReassignment":{ "shape":"Boolean", "documentation":"

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", "locationName":"allowReassignment" } } }, "AssociateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address. This is required for EC2-Classic.

" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

", "locationName":"networkInterfaceId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", "locationName":"privateIpAddress" }, "AllowReassociation":{ "shape":"Boolean", "documentation":"

[EC2-VPC] Allows an Elastic IP address that is already associated with an instance or network interface to be re-associated with the specified instance or network interface. Otherwise, the operation fails.

Default: false

", "locationName":"allowReassociation" } } }, "AssociateAddressResult":{ "type":"structure", "members":{ "AssociationId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", "locationName":"associationId" } } }, "AssociateDhcpOptionsRequest":{ "type":"structure", "required":[ "DhcpOptionsId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } } }, "AssociateRouteTableRequest":{ "type":"structure", "required":[ "SubnetId", "RouteTableId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" } } }, "AssociateRouteTableResult":{ "type":"structure", "members":{ "AssociationId":{ "shape":"String", "documentation":"

The route table association ID (needed to disassociate the route table).

", "locationName":"associationId" } } }, "AttachClassicLinkVpcRequest":{ "type":"structure", "required":[ "InstanceId", "VpcId", "Groups" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of a ClassicLink-enabled VPC.

", "locationName":"vpcId" }, "Groups":{ "shape":"GroupIdStringList", "documentation":"

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", "locationName":"SecurityGroupId" } } }, "AttachClassicLinkVpcResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "AttachInternetGatewayRequest":{ "type":"structure", "required":[ "InternetGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "AttachNetworkInterfaceRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "InstanceId", "DeviceIndex" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device for the network interface attachment.

", "locationName":"deviceIndex" } } }, "AttachNetworkInterfaceResult":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" } } }, "AttachVolumeRequest":{ "type":"structure", "required":[ "VolumeId", "InstanceId", "Device" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "Device":{ "shape":"String", "documentation":"

The device name to expose to the instance (for example, /dev/sdh or xvdh).

" } } }, "AttachVpnGatewayRequest":{ "type":"structure", "required":[ "VpnGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } } }, "AttachVpnGatewayResult":{ "type":"structure", "members":{ "VpcAttachment":{ "shape":"VpcAttachment", "documentation":"

Information about the attachment.

", "locationName":"attachment" } } }, "AttachmentStatus":{ "type":"string", "enum":[ "attaching", "attached", "detaching", "detached" ] }, "AttributeBooleanValue":{ "type":"structure", "members":{ "Value":{ "shape":"Boolean", "documentation":"

Valid values are true or false.

", "locationName":"value" } }, "documentation":"

The value to use when a resource attribute accepts a Boolean value.

" }, "AttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"String", "documentation":"

Valid values are case-sensitive and vary by action.

", "locationName":"value" } }, "documentation":"

The value to use for a resource attribute.

" }, "AuthorizeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

", "locationName":"toPort" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

", "locationName":"cidrIp" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"ipPermissions" } } }, "AuthorizeSecurityGroupIngressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a nondefault VPC.

" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.

" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. Can be used to specify multiple rules in a single command.

" } } }, "AvailabilityZone":{ "type":"structure", "members":{ "ZoneName":{ "shape":"String", "documentation":"

The name of the Availability Zone.

", "locationName":"zoneName" }, "State":{ "shape":"AvailabilityZoneState", "documentation":"

The state of the Availability Zone (available | impaired | unavailable).

", "locationName":"zoneState" }, "RegionName":{ "shape":"String", "documentation":"

The name of the region.

", "locationName":"regionName" }, "Messages":{ "shape":"AvailabilityZoneMessageList", "documentation":"

Any messages about the Availability Zone.

", "locationName":"messageSet" } }, "documentation":"

Describes an Availability Zone.

" }, "AvailabilityZoneList":{ "type":"list", "member":{ "shape":"AvailabilityZone", "locationName":"item" } }, "AvailabilityZoneMessage":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

The message about the Availability Zone.

", "locationName":"message" } }, "documentation":"

Describes a message about an Availability Zone.

" }, "AvailabilityZoneMessageList":{ "type":"list", "member":{ "shape":"AvailabilityZoneMessage", "locationName":"item" } }, "AvailabilityZoneState":{ "type":"string", "enum":["available"] }, "BlockDeviceMapping":{ "type":"structure", "members":{ "VirtualName":{ "shape":"String", "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", "locationName":"virtualName" }, "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsBlockDevice", "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", "locationName":"ebs" }, "NoDevice":{ "shape":"String", "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", "locationName":"noDevice" } }, "documentation":"

Describes a block device mapping.

" }, "BlockDeviceMappingList":{ "type":"list", "member":{ "shape":"BlockDeviceMapping", "locationName":"item" } }, "BlockDeviceMappingRequestList":{ "type":"list", "member":{ "shape":"BlockDeviceMapping", "locationName":"BlockDeviceMapping" } }, "Boolean":{"type":"boolean"}, "BundleIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"BundleId" } }, "BundleInstanceRequest":{ "type":"structure", "required":[ "InstanceId", "Storage" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

" }, "Storage":{ "shape":"Storage", "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" } } }, "BundleInstanceResult":{ "type":"structure", "members":{ "BundleTask":{ "shape":"BundleTask", "documentation":"

Information about the bundle task.

", "locationName":"bundleInstanceTask" } } }, "BundleTask":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance associated with this bundle task.

", "locationName":"instanceId" }, "BundleId":{ "shape":"String", "documentation":"

The ID of the bundle task.

", "locationName":"bundleId" }, "State":{ "shape":"BundleTaskState", "documentation":"

The state of the task.

", "locationName":"state" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time this task started.

", "locationName":"startTime" }, "UpdateTime":{ "shape":"DateTime", "documentation":"

The time of the most recent update for the task.

", "locationName":"updateTime" }, "Storage":{ "shape":"Storage", "documentation":"

The Amazon S3 storage locations.

", "locationName":"storage" }, "Progress":{ "shape":"String", "documentation":"

The level of task completion, as a percent (for example, 20%).

", "locationName":"progress" }, "BundleTaskError":{ "shape":"BundleTaskError", "documentation":"

If the task fails, a description of the error.

", "locationName":"error" } }, "documentation":"

Describes a bundle task.

" }, "BundleTaskError":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The error message.

", "locationName":"message" } }, "documentation":"

Describes an error for BundleInstance.

" }, "BundleTaskList":{ "type":"list", "member":{ "shape":"BundleTask", "locationName":"item" } }, "BundleTaskState":{ "type":"string", "enum":[ "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed" ] }, "CancelBundleTaskRequest":{ "type":"structure", "required":["BundleId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "BundleId":{ "shape":"String", "documentation":"

The ID of the bundle task.

" } } }, "CancelBundleTaskResult":{ "type":"structure", "members":{ "BundleTask":{ "shape":"BundleTask", "documentation":"

The bundle task.

", "locationName":"bundleInstanceTask" } } }, "CancelConversionRequest":{ "type":"structure", "required":["ConversionTaskId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ConversionTaskId":{ "shape":"String", "documentation":"

The ID of the conversion task.

", "locationName":"conversionTaskId" }, "ReasonMessage":{ "shape":"String", "locationName":"reasonMessage" } } }, "CancelExportTaskRequest":{ "type":"structure", "required":["ExportTaskId"], "members":{ "ExportTaskId":{ "shape":"String", "documentation":"

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", "locationName":"exportTaskId" } } }, "CancelImportTaskRequest":{ "type":"structure", "members":{ "DryRun":{"shape":"Boolean"}, "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the ImportImage or ImportSnapshot task to be cancelled.

" }, "CancelReason":{ "shape":"String", "documentation":"

The reason for canceling the task.

" } } }, "CancelImportTaskResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The task ID of the ImportImage or ImportSnapshot task being canceled.

", "locationName":"importTaskId" }, "State":{ "shape":"String", "documentation":"

The current state of the ImportImage or ImportSnapshot task being canceled.

", "locationName":"state" }, "PreviousState":{ "shape":"String", "documentation":"

The current state of the ImportImage or ImportSnapshot task being canceled.

", "locationName":"previousState" } } }, "CancelReservedInstancesListingRequest":{ "type":"structure", "required":["ReservedInstancesListingId"], "members":{ "ReservedInstancesListingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance listing.

", "locationName":"reservedInstancesListingId" } } }, "CancelReservedInstancesListingResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

The Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } } }, "CancelSpotInstanceRequestState":{ "type":"string", "enum":[ "active", "open", "closed", "cancelled", "completed" ] }, "CancelSpotInstanceRequestsRequest":{ "type":"structure", "required":["SpotInstanceRequestIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SpotInstanceRequestIds":{ "shape":"SpotInstanceRequestIdList", "documentation":"

One or more Spot Instance request IDs.

", "locationName":"SpotInstanceRequestId" } } }, "CancelSpotInstanceRequestsResult":{ "type":"structure", "members":{ "CancelledSpotInstanceRequests":{ "shape":"CancelledSpotInstanceRequestList", "documentation":"

One or more Spot Instance requests.

", "locationName":"spotInstanceRequestSet" } } }, "CancelledSpotInstanceRequest":{ "type":"structure", "members":{ "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot Instance request.

", "locationName":"spotInstanceRequestId" }, "State":{ "shape":"CancelSpotInstanceRequestState", "documentation":"

The state of the Spot Instance request.

", "locationName":"state" } }, "documentation":"

Describes a request to cancel a Spot Instance.

" }, "CancelledSpotInstanceRequestList":{ "type":"list", "member":{ "shape":"CancelledSpotInstanceRequest", "locationName":"item" } }, "ClassicLinkInstance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

A list of security groups.

", "locationName":"groupSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the instance.

", "locationName":"tagSet" } }, "documentation":"

Describes a linked EC2-Classic instance.

" }, "ClassicLinkInstanceList":{ "type":"list", "member":{ "shape":"ClassicLinkInstance", "locationName":"item" } }, "ClientData":{ "type":"structure", "members":{ "UploadStart":{ "shape":"DateTime", "documentation":"

The time that the disk upload starts.

" }, "UploadEnd":{ "shape":"DateTime", "documentation":"

The time that the disk upload ends.

" }, "UploadSize":{ "shape":"Double", "documentation":"

The size of the uploaded disk image.

" }, "Comment":{ "shape":"String", "documentation":"

User-defined comment about the upload.

" } }, "documentation":"

Client-specific data.

" }, "ConfirmProductInstanceRequest":{ "type":"structure", "required":[ "ProductCode", "InstanceId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ProductCode":{ "shape":"String", "documentation":"

The product code. This must be a product code that you own.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" } } }, "ConfirmProductInstanceResult":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", "locationName":"ownerId" } } }, "ContainerFormat":{ "type":"string", "enum":["ova"] }, "ConversionIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "ConversionTask":{ "type":"structure", "required":[ "ConversionTaskId", "State" ], "members":{ "ConversionTaskId":{ "shape":"String", "documentation":"

The ID of the conversion task.

", "locationName":"conversionTaskId" }, "ExpirationTime":{ "shape":"String", "documentation":"

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", "locationName":"expirationTime" }, "ImportInstance":{ "shape":"ImportInstanceTaskDetails", "documentation":"

If the task is for importing an instance, this contains information about the import instance task.

", "locationName":"importInstance" }, "ImportVolume":{ "shape":"ImportVolumeTaskDetails", "documentation":"

If the task is for importing a volume, this contains information about the import volume task.

", "locationName":"importVolume" }, "State":{ "shape":"ConversionTaskState", "documentation":"

The state of the conversion task.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message related to the conversion task.

", "locationName":"statusMessage" }, "Tags":{ "shape":"TagList", "locationName":"tagSet" } }, "documentation":"

Describes a conversion task.

" }, "ConversionTaskState":{ "type":"string", "enum":[ "active", "cancelling", "cancelled", "completed" ] }, "CopyImageRequest":{ "type":"structure", "required":[ "SourceRegion", "SourceImageId", "Name" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SourceRegion":{ "shape":"String", "documentation":"

The name of the region that contains the AMI to copy.

" }, "SourceImageId":{ "shape":"String", "documentation":"

The ID of the AMI to copy.

" }, "Name":{ "shape":"String", "documentation":"

The name of the new AMI in the destination region.

" }, "Description":{ "shape":"String", "documentation":"

A description for the new AMI in the destination region.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide for Linux.

" } } }, "CopyImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the new AMI.

", "locationName":"imageId" } } }, "CopySnapshotRequest":{ "type":"structure", "required":[ "SourceRegion", "SourceSnapshotId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SourceRegion":{ "shape":"String", "documentation":"

The ID of the region that contains the snapshot to be copied.

" }, "SourceSnapshotId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS snapshot to copy.

" }, "Description":{ "shape":"String", "documentation":"

A description for the new Amazon EBS snapshot.

" }, "DestinationRegion":{ "shape":"String", "documentation":"

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

", "locationName":"destinationRegion" }, "PresignedUrl":{ "shape":"String", "documentation":"

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because Amazon EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", "locationName":"presignedUrl" } } }, "CopySnapshotResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the new snapshot.

", "locationName":"snapshotId" } } }, "CreateCustomerGatewayRequest":{ "type":"structure", "required":[ "Type", "PublicIp", "BgpAsn" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection that this customer gateway supports (ipsec.1).

" }, "PublicIp":{ "shape":"String", "documentation":"

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", "locationName":"IpAddress" }, "BgpAsn":{ "shape":"Integer", "documentation":"

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" } } }, "CreateCustomerGatewayResult":{ "type":"structure", "members":{ "CustomerGateway":{ "shape":"CustomerGateway", "documentation":"

Information about the customer gateway.

", "locationName":"customerGateway" } } }, "CreateDhcpOptionsRequest":{ "type":"structure", "required":["DhcpConfigurations"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "DhcpConfigurations":{ "shape":"NewDhcpConfigurationList", "documentation":"

A DHCP configuration option.

", "locationName":"dhcpConfiguration" } } }, "CreateDhcpOptionsResult":{ "type":"structure", "members":{ "DhcpOptions":{ "shape":"DhcpOptions", "documentation":"

A set of DHCP options.

", "locationName":"dhcpOptions" } } }, "CreateImageRequest":{ "type":"structure", "required":[ "InstanceId", "Name" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Name":{ "shape":"String", "documentation":"

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

A description for the new image.

", "locationName":"description" }, "NoReboot":{ "shape":"Boolean", "documentation":"

By default, this parameter is set to false, which means Amazon EC2 attempts to shut down the instance cleanly before image creation and then reboots the instance. When the parameter is set to true, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", "locationName":"noReboot" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

Information about one or more block device mappings.

", "locationName":"blockDeviceMapping" } } }, "CreateImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the new AMI.

", "locationName":"imageId" } } }, "CreateInstanceExportTaskRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "Description":{ "shape":"String", "documentation":"

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", "locationName":"description" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "TargetEnvironment":{ "shape":"ExportEnvironment", "documentation":"

The target virtualization environment.

", "locationName":"targetEnvironment" }, "ExportToS3Task":{ "shape":"ExportToS3TaskSpecification", "locationName":"exportToS3" } } }, "CreateInstanceExportTaskResult":{ "type":"structure", "members":{ "ExportTask":{ "shape":"ExportTask", "locationName":"exportTask" } } }, "CreateInternetGatewayRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" } } }, "CreateInternetGatewayResult":{ "type":"structure", "members":{ "InternetGateway":{ "shape":"InternetGateway", "documentation":"

Information about the Internet gateway.

", "locationName":"internetGateway" } } }, "CreateKeyPairRequest":{ "type":"structure", "required":["KeyName"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" } } }, "CreateNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Protocol", "RuleAction", "Egress", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The protocol. A value of -1 means all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.

", "locationName":"Icmp" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", "locationName":"portRange" } } }, "CreateNetworkAclRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "CreateNetworkAclResult":{ "type":"structure", "members":{ "NetworkAcl":{ "shape":"NetworkAcl", "documentation":"

Information about the network ACL.

", "locationName":"networkAcl" } } }, "CreateNetworkInterfaceRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet to associate with the network interface.

", "locationName":"subnetId" }, "Description":{ "shape":"String", "documentation":"

A description for the network interface.

", "locationName":"description" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", "locationName":"privateIpAddress" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

The IDs of one or more security groups.

", "locationName":"SecurityGroupId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", "documentation":"

One or more private IP addresses.

", "locationName":"privateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide for Linux.

", "locationName":"secondaryPrivateIpAddressCount" }, "DryRun":{ "shape":"Boolean", "locationName":"dryRun" } } }, "CreateNetworkInterfaceResult":{ "type":"structure", "members":{ "NetworkInterface":{ "shape":"NetworkInterface", "documentation":"

Information about the network interface.

", "locationName":"networkInterface" } } }, "CreatePlacementGroupRequest":{ "type":"structure", "required":[ "GroupName", "Strategy" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

A name for the placement group.

Constraints: Up to 255 ASCII characters

", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"

The placement strategy.

", "locationName":"strategy" } } }, "CreateReservedInstancesListingRequest":{ "type":"structure", "required":[ "ReservedInstancesId", "InstanceCount", "PriceSchedules", "ClientToken" ], "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the active Reserved Instance.

", "locationName":"reservedInstancesId" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", "locationName":"instanceCount" }, "PriceSchedules":{ "shape":"PriceScheduleSpecificationList", "documentation":"

A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.

", "locationName":"priceSchedules" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } } }, "CreateReservedInstancesListingResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

Information about the Reserved Instances listing.

", "locationName":"reservedInstancesListingsSet" } } }, "CreateRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table for the route.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of an Internet gateway or virtual private gateway attached to your VPC.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", "locationName":"instanceId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of a network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of a VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "CreateRouteTableRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "CreateRouteTableResult":{ "type":"structure", "members":{ "RouteTable":{ "shape":"RouteTable", "documentation":"

Information about the route table.

", "locationName":"routeTable" } } }, "CreateSecurityGroupRequest":{ "type":"structure", "required":[ "GroupName", "Description" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

" }, "Description":{ "shape":"String", "documentation":"

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", "locationName":"GroupDescription" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" } } }, "CreateSecurityGroupResult":{ "type":"structure", "members":{ "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } } }, "CreateSnapshotRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS volume.

" }, "Description":{ "shape":"String", "documentation":"

A description for the snapshot.

" } } }, "CreateSpotDatafeedSubscriptionRequest":{ "type":"structure", "required":["Bucket"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket in which to store the Spot Instance data feed.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

A prefix for the data feed file names.

", "locationName":"prefix" } } }, "CreateSpotDatafeedSubscriptionResult":{ "type":"structure", "members":{ "SpotDatafeedSubscription":{ "shape":"SpotDatafeedSubscription", "documentation":"

The Spot Instance data feed subscription.

", "locationName":"spotDatafeedSubscription" } } }, "CreateSubnetRequest":{ "type":"structure", "required":[ "VpcId", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the subnet.

Default: Amazon EC2 selects one for you (recommended).

" } } }, "CreateSubnetResult":{ "type":"structure", "members":{ "Subnet":{ "shape":"Subnet", "documentation":"

Information about the subnet.

", "locationName":"subnet" } } }, "CreateTagsRequest":{ "type":"structure", "required":[ "Resources", "Tags" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Resources":{ "shape":"ResourceIdList", "documentation":"

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

", "locationName":"ResourceId" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", "locationName":"Tag" } } }, "CreateVolumePermission":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

", "locationName":"userId" }, "Group":{ "shape":"PermissionGroup", "documentation":"

The specific group that is to be added or removed from a volume's list of create volume permissions.

", "locationName":"group" } } }, "CreateVolumePermissionList":{ "type":"list", "member":{ "shape":"CreateVolumePermission", "locationName":"item" } }, "CreateVolumePermissionModifications":{ "type":"structure", "members":{ "Add":{ "shape":"CreateVolumePermissionList", "documentation":"

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

" }, "Remove":{ "shape":"CreateVolumePermissionList", "documentation":"

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

" } } }, "CreateVolumeRequest":{ "type":"structure", "required":["AvailabilityZone"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Size":{ "shape":"Integer", "documentation":"

The size of the volume, in GiBs.

Constraints: 1-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot from which to create the volume.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

Default: standard

" }, "Iops":{ "shape":"Integer", "documentation":"

Only valid for Provisioned IOPS (SSD) volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (KMS) master key to use when creating the encrypted volume. This parameter is only required if you want to use a non-default master key; if this parameter is not specified, the default master key is used. The ARN contains the arn:aws:kms namespace, followed by the region of the master key, the AWS account ID of the master key owner, the key namespace, and then the master key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

" } } }, "CreateVpcPeeringConnectionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the requester VPC.

", "locationName":"vpcId" }, "PeerVpcId":{ "shape":"String", "documentation":"

The ID of the VPC with which you are creating the VPC peering connection.

", "locationName":"peerVpcId" }, "PeerOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

", "locationName":"peerOwnerId" } } }, "CreateVpcPeeringConnectionResult":{ "type":"structure", "members":{ "VpcPeeringConnection":{ "shape":"VpcPeeringConnection", "documentation":"

Information about the VPC peering connection.

", "locationName":"vpcPeeringConnection" } } }, "CreateVpcRequest":{ "type":"structure", "required":["CidrBlock"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The supported tenancy options for instances launched into the VPC. A value of default means that instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC are launched as dedicated tenancy instances regardless of the tenancy assigned to the instance at launch. Dedicated tenancy instances run on single-tenant hardware.

Default: default

", "locationName":"instanceTenancy" } } }, "CreateVpcResult":{ "type":"structure", "members":{ "Vpc":{ "shape":"Vpc", "documentation":"

Information about the VPC.

", "locationName":"vpc" } } }, "CreateVpnConnectionRequest":{ "type":"structure", "required":[ "Type", "CustomerGatewayId", "VpnGatewayId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Type":{ "shape":"String", "documentation":"

The type of VPN connection (ipsec.1).

" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "Options":{ "shape":"VpnConnectionOptionsSpecification", "documentation":"

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

", "locationName":"options" } } }, "CreateVpnConnectionResult":{ "type":"structure", "members":{ "VpnConnection":{ "shape":"VpnConnection", "documentation":"

Information about the VPN connection.

", "locationName":"vpnConnection" } } }, "CreateVpnConnectionRouteRequest":{ "type":"structure", "required":[ "VpnConnectionId", "DestinationCidrBlock" ], "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer network.

" } } }, "CreateVpnGatewayRequest":{ "type":"structure", "required":["Type"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection this virtual private gateway supports.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the virtual private gateway.

" } } }, "CreateVpnGatewayResult":{ "type":"structure", "members":{ "VpnGateway":{ "shape":"VpnGateway", "documentation":"

Information about the virtual private gateway.

", "locationName":"vpnGateway" } } }, "CurrencyCodeValues":{ "type":"string", "enum":["USD"] }, "CustomerGateway":{ "type":"structure", "members":{ "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

", "locationName":"customerGatewayId" }, "State":{ "shape":"String", "documentation":"

The current state of the customer gateway (pending | available | deleting | deleted).

", "locationName":"state" }, "Type":{ "shape":"String", "documentation":"

The type of VPN connection the customer gateway supports (ipsec.1).

", "locationName":"type" }, "IpAddress":{ "shape":"String", "documentation":"

The Internet-routable IP address of the customer gateway's outside interface.

", "locationName":"ipAddress" }, "BgpAsn":{ "shape":"String", "documentation":"

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", "locationName":"bgpAsn" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the customer gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes a customer gateway.

" }, "CustomerGatewayIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"CustomerGatewayId" } }, "CustomerGatewayList":{ "type":"list", "member":{ "shape":"CustomerGateway", "locationName":"item" } }, "DatafeedSubscriptionState":{ "type":"string", "enum":[ "Active", "Inactive" ] }, "DateTime":{"type":"timestamp"}, "DeleteCustomerGatewayRequest":{ "type":"structure", "required":["CustomerGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

" } } }, "DeleteDhcpOptionsRequest":{ "type":"structure", "required":["DhcpOptionsId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the DHCP options set.

" } } }, "DeleteInternetGatewayRequest":{ "type":"structure", "required":["InternetGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" } } }, "DeleteKeyPairRequest":{ "type":"structure", "required":["KeyName"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

" } } }, "DeleteNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Egress" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number of the entry to delete.

", "locationName":"ruleNumber" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether the rule is an egress rule.

", "locationName":"egress" } } }, "DeleteNetworkAclRequest":{ "type":"structure", "required":["NetworkAclId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" } } }, "DeleteNetworkInterfaceRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" } } }, "DeletePlacementGroupRequest":{ "type":"structure", "required":["GroupName"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

", "locationName":"groupName" } } }, "DeleteRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", "locationName":"destinationCidrBlock" } } }, "DeleteRouteTableRequest":{ "type":"structure", "required":["RouteTableId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" } } }, "DeleteSecurityGroupRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a nondefault VPC.

" } } }, "DeleteSnapshotRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS snapshot.

" } } }, "DeleteSpotDatafeedSubscriptionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" } } }, "DeleteSubnetRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

" } } }, "DeleteTagsRequest":{ "type":"structure", "required":["Resources"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Resources":{ "shape":"ResourceIdList", "documentation":"

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

", "locationName":"resourceId" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

", "locationName":"tag" } } }, "DeleteVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" } } }, "DeleteVpcPeeringConnectionRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "DeleteVpcPeeringConnectionResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "DeleteVpcRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } } }, "DeleteVpnConnectionRequest":{ "type":"structure", "required":["VpnConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" } } }, "DeleteVpnConnectionRouteRequest":{ "type":"structure", "required":[ "VpnConnectionId", "DestinationCidrBlock" ], "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer network.

" } } }, "DeleteVpnGatewayRequest":{ "type":"structure", "required":["VpnGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } } }, "DeregisterImageRequest":{ "type":"structure", "required":["ImageId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" } } }, "DescribeAccountAttributesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AttributeNames":{ "shape":"AccountAttributeNameStringList", "documentation":"

One or more account attribute names.

", "locationName":"attributeName" } } }, "DescribeAccountAttributesResult":{ "type":"structure", "members":{ "AccountAttributes":{ "shape":"AccountAttributeList", "documentation":"

Information about one or more account attributes.

", "locationName":"accountAttributeSet" } } }, "DescribeAddressesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "PublicIps":{ "shape":"PublicIpStringList", "documentation":"

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", "locationName":"PublicIp" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

", "locationName":"Filter" }, "AllocationIds":{ "shape":"AllocationIdList", "documentation":"

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

", "locationName":"AllocationId" } } }, "DescribeAddressesResult":{ "type":"structure", "members":{ "Addresses":{ "shape":"AddressList", "documentation":"

Information about one or more Elastic IP addresses.

", "locationName":"addressesSet" } } }, "DescribeAvailabilityZonesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ZoneNames":{ "shape":"ZoneNameStringList", "documentation":"

The names of one or more Availability Zones.

", "locationName":"ZoneName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | impaired | unavailable).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", "locationName":"Filter" } } }, "DescribeAvailabilityZonesResult":{ "type":"structure", "members":{ "AvailabilityZones":{ "shape":"AvailabilityZoneList", "documentation":"

Information about one or more Availability Zones.

", "locationName":"availabilityZoneInfo" } } }, "DescribeBundleTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "BundleIds":{ "shape":"BundleIdStringList", "documentation":"

One or more bundle task IDs.

Default: Describes all your bundle tasks.

", "locationName":"BundleId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", "locationName":"Filter" } } }, "DescribeBundleTasksResult":{ "type":"structure", "members":{ "BundleTasks":{ "shape":"BundleTaskList", "documentation":"

Information about one or more bundle tasks.

", "locationName":"bundleInstanceTasksSet" } } }, "DescribeClassicLinkInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC that the instance is linked to.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

", "locationName":"maxResults" } } }, "DescribeClassicLinkInstancesResult":{ "type":"structure", "members":{ "Instances":{ "shape":"ClassicLinkInstanceList", "documentation":"

Information about one or more linked EC2-Classic instances.

", "locationName":"instancesSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeConversionTaskList":{ "type":"list", "member":{ "shape":"ConversionTask", "locationName":"item" } }, "DescribeConversionTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Filters":{ "shape":"FilterList", "locationName":"filter" }, "ConversionTaskIds":{ "shape":"ConversionIdStringList", "documentation":"

One or more conversion task IDs.

", "locationName":"conversionTaskId" } } }, "DescribeConversionTasksResult":{ "type":"structure", "members":{ "ConversionTasks":{ "shape":"DescribeConversionTaskList", "locationName":"conversionTasks" } } }, "DescribeCustomerGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "CustomerGatewayIds":{ "shape":"CustomerGatewayIdStringList", "documentation":"

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", "locationName":"CustomerGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } } }, "DescribeCustomerGatewaysResult":{ "type":"structure", "members":{ "CustomerGateways":{ "shape":"CustomerGatewayList", "documentation":"

Information about one or more customer gateways.

", "locationName":"customerGatewaySet" } } }, "DescribeDhcpOptionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "DhcpOptionsIds":{ "shape":"DhcpOptionsIdStringList", "documentation":"

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", "locationName":"DhcpOptionsId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • dhcp-options-id - The ID of a set of DHCP options.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } } }, "DescribeDhcpOptionsResult":{ "type":"structure", "members":{ "DhcpOptions":{ "shape":"DhcpOptionsList", "documentation":"

Information about one or more DHCP options sets.

", "locationName":"dhcpOptionsSet" } } }, "DescribeExportTasksRequest":{ "type":"structure", "members":{ "ExportTaskIds":{ "shape":"ExportTaskIdStringList", "documentation":"

One or more export task IDs.

", "locationName":"exportTaskId" } } }, "DescribeExportTasksResult":{ "type":"structure", "members":{ "ExportTasks":{ "shape":"ExportTaskList", "locationName":"exportTaskSet" } } }, "DescribeImageAttributeRequest":{ "type":"structure", "required":[ "ImageId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"ImageAttributeName", "documentation":"

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

" } } }, "DescribeImagesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageIds":{ "shape":"ImageIdStringList", "documentation":"

One or more image IDs.

Default: Describes all images available to you.

", "locationName":"ImageId" }, "Owners":{ "shape":"OwnerStringList", "documentation":"

Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

", "locationName":"Owner" }, "ExecutableUsers":{ "shape":"ExecutableByStringList", "documentation":"

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", "locationName":"ExecutableBy" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • architecture - The image architecture (i386 | x86_64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the Amazon EBS volume (gp2 | standard | io1).

  • description - The description of the image (provided during image creation).

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - The AWS account alias (for example, amazon).

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", "locationName":"Filter" } } }, "DescribeImagesResult":{ "type":"structure", "members":{ "Images":{ "shape":"ImageList", "documentation":"

Information about one or more images.

", "locationName":"imagesSet" } } }, "DescribeImportImageTasksRequest":{ "type":"structure", "members":{ "DryRun":{"shape":"Boolean"}, "ImportTaskIds":{ "shape":"ImportTaskIdList", "documentation":"

A list of ImportImage task IDs to describe.

", "locationName":"ImportTaskId" }, "NextToken":{ "shape":"String", "documentation":"

The token to get the next page of paginated describe requests.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results in a page.

" }, "Filters":{ "shape":"FilterList", "documentation":"

Filters to be applied on a describe request.

" } } }, "DescribeImportImageTasksResult":{ "type":"structure", "members":{ "ImportImageTasks":{ "shape":"ImportImageTaskList", "documentation":"

A list of zero or more ImportImage tasks that are currently active or completed/cancelled in the previous 7 days.

", "locationName":"importImageTaskSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to get the next page of paginated describe requests.

", "locationName":"nextToken" } } }, "DescribeImportSnapshotTasksRequest":{ "type":"structure", "members":{ "DryRun":{"shape":"Boolean"}, "ImportTaskIds":{ "shape":"ImportTaskIdList", "documentation":"

A list of IDs of the ImportSnapshot tasks to describe.

", "locationName":"ImportTaskId" }, "NextToken":{ "shape":"String", "documentation":"

The token to get to the next page of paginated describe requests.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results in a page.

" }, "Filters":{ "shape":"FilterList", "documentation":"

The filters to be applied on a describe request.

" } } }, "DescribeImportSnapshotTasksResult":{ "type":"structure", "members":{ "ImportSnapshotTasks":{ "shape":"ImportSnapshotTaskList", "documentation":"

A list of zero or more ImportSnapshot tasks that are currently active or completed/cancelled in the previous 7 days.

", "locationName":"importSnapshotTaskSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to get to the next page of paginated describe requests.

", "locationName":"nextToken" } } }, "DescribeInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The instance attribute.

", "locationName":"attribute" } } }, "DescribeInstanceStatusRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code identifying the type of event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.not-after - The latest end time for the scheduled event, for example: 2010-09-15T17:15:20.000Z.

  • event.not-before - The earliest start time for the scheduled event, for example: 2010-09-15T17:15:20.000Z.

  • instance-state-code - A code representing the state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

" }, "IncludeAllInstances":{ "shape":"Boolean", "documentation":"

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", "locationName":"includeAllInstances" } } }, "DescribeInstanceStatusResult":{ "type":"structure", "members":{ "InstanceStatuses":{ "shape":"InstanceStatusList", "documentation":"

One or more instance status descriptions.

", "locationName":"instanceStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Default: Describes all your instances.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • architecture - The instance architecture (i386 | x86_64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - 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 - A Boolean that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the Amazon EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the Amazon EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance (spot).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IP address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - 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 - The time when the instance was launched.

  • monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.

  • private-dns-name - The private DNS name of the instance.

  • private-ip-address - The private IP address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - 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 - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - 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 - The name of the root device for the instance (for example, /dev/sda1 or /dev/xvda).

  • root-device-type - The type of root device that the instance uses (ebs | instance-store).

  • source-dest-check - 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 - The ID of the Spot Instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • tenancy - The tenancy of an instance (dedicated | default).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

  • network-interface.description - The description of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • network-interface.network-interface.id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface-private-dns-name - The private DNS name of the network interface.

  • network-interface.source-dest-check - 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.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.addresses.private-ip-address - The private IP address associated with the network interface.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to request the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

", "locationName":"maxResults" } } }, "DescribeInstancesResult":{ "type":"structure", "members":{ "Reservations":{ "shape":"ReservationList", "documentation":"

One or more reservations.

", "locationName":"reservationSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeInternetGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InternetGatewayIds":{ "shape":"ValueStringList", "documentation":"

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

", "locationName":"internetGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } } }, "DescribeInternetGatewaysResult":{ "type":"structure", "members":{ "InternetGateways":{ "shape":"InternetGatewayList", "documentation":"

Information about one or more Internet gateways.

", "locationName":"internetGatewaySet" } } }, "DescribeKeyPairsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "KeyNames":{ "shape":"KeyNameStringList", "documentation":"

One or more key pair names.

Default: Describes all your key pairs.

", "locationName":"KeyName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", "locationName":"Filter" } } }, "DescribeKeyPairsResult":{ "type":"structure", "members":{ "KeyPairs":{ "shape":"KeyPairList", "documentation":"

Information about one or more key pairs.

", "locationName":"keySet" } } }, "DescribeNetworkAclsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkAclIds":{ "shape":"ValueStringList", "documentation":"

One or more network ACL IDs.

Default: Describes all your network ACLs.

", "locationName":"NetworkAclId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The CIDR range specified in the entry.

  • entry.egress - Indicates whether the entry applies to egress traffic.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.

  • network-acl-id - The ID of the network ACL.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network ACL.

", "locationName":"Filter" } } }, "DescribeNetworkAclsResult":{ "type":"structure", "members":{ "NetworkAcls":{ "shape":"NetworkAclList", "documentation":"

Information about one or more network ACLs.

", "locationName":"networkAclSet" } } }, "DescribeNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Attribute":{ "shape":"NetworkInterfaceAttribute", "documentation":"

The attribute of the network interface.

", "locationName":"attribute" } } }, "DescribeNetworkInterfaceAttributeResult":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Description":{ "shape":"AttributeValue", "documentation":"

The description of the network interface.

", "locationName":"description" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

The security groups associated with the network interface.

", "locationName":"groupSet" }, "Attachment":{ "shape":"NetworkInterfaceAttachment", "documentation":"

The attachment (if any) of the network interface.

", "locationName":"attachment" } } }, "DescribeNetworkInterfacesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceIds":{ "shape":"NetworkInterfaceIdList", "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", "locationName":"NetworkInterfaceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IP addresses associated with the network interface.

  • addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface.

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • attachment.attach.time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IP address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-desk-check - 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 - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network interface.

", "locationName":"filter" } } }, "DescribeNetworkInterfacesResult":{ "type":"structure", "members":{ "NetworkInterfaces":{ "shape":"NetworkInterfaceList", "documentation":"

Information about one or more network interfaces.

", "locationName":"networkInterfaceSet" } } }, "DescribePlacementGroupsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupNames":{ "shape":"PlacementGroupStringList", "documentation":"

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

", "locationName":"groupName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster).

", "locationName":"Filter" } } }, "DescribePlacementGroupsResult":{ "type":"structure", "members":{ "PlacementGroups":{ "shape":"PlacementGroupList", "documentation":"

One or more placement groups.

", "locationName":"placementGroupSet" } } }, "DescribeRegionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RegionNames":{ "shape":"RegionNameStringList", "documentation":"

The names of one or more regions.

", "locationName":"RegionName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

  • region-name - The name of the region (for example, us-east-1).

", "locationName":"Filter" } } }, "DescribeRegionsResult":{ "type":"structure", "members":{ "Regions":{ "shape":"RegionList", "documentation":"

Information about one or more regions.

", "locationName":"regionInfo" } } }, "DescribeReservedInstancesListingsRequest":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

One or more Reserved Instance IDs.

", "locationName":"reservedInstancesId" }, "ReservedInstancesListingId":{ "shape":"String", "documentation":"

One or more Reserved Instance Listing IDs.

", "locationName":"reservedInstancesListingId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", "locationName":"filters" } } }, "DescribeReservedInstancesListingsResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

Information about the Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } } }, "DescribeReservedInstancesModificationsRequest":{ "type":"structure", "members":{ "ReservedInstancesModificationIds":{ "shape":"ReservedInstancesModificationIdStringList", "documentation":"

IDs for the submitted modification request.

", "locationName":"ReservedInstancesModificationId" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

", "locationName":"Filter" } } }, "DescribeReservedInstancesModificationsResult":{ "type":"structure", "members":{ "ReservedInstancesModifications":{ "shape":"ReservedInstancesModificationList", "documentation":"

The Reserved Instance modification information.

", "locationName":"reservedInstancesModificationsSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeReservedInstancesOfferingsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ReservedInstancesOfferingIds":{ "shape":"ReservedInstancesOfferingIdStringList", "documentation":"

One or more Reserved Instances offering IDs.

", "locationName":"ReservedInstancesOfferingId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type on which the Reserved Instance can be used.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from AWS and Reserved Instance Marketplace are listed.

  • product-description - The description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)).

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", "locationName":"Filter" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the Reserved Instance offering. A Reserved Instance with dedicated tenancy runs on single-tenant hardware and can only be launched within a VPC.

Default: default

", "locationName":"instanceTenancy" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", "locationName":"offeringType" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

", "locationName":"maxResults" }, "IncludeMarketplace":{ "shape":"Boolean", "documentation":"

Include Marketplace offerings in the response.

" }, "MinDuration":{ "shape":"Long", "documentation":"

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

" }, "MaxDuration":{ "shape":"Long", "documentation":"

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

" }, "MaxInstanceCount":{ "shape":"Integer", "documentation":"

The maximum number of instances to filter when searching for offerings.

Default: 20

" } } }, "DescribeReservedInstancesOfferingsResult":{ "type":"structure", "members":{ "ReservedInstancesOfferings":{ "shape":"ReservedInstancesOfferingList", "documentation":"

A list of Reserved Instances offerings.

", "locationName":"reservedInstancesOfferingsSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeReservedInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ReservedInstancesIds":{ "shape":"ReservedInstancesIdStringList", "documentation":"

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

", "locationName":"ReservedInstancesId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2014-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type on which the Reserved Instance can be used.

  • product-description - The product description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (pending-payment | active | payment-failed | retired).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", "locationName":"Filter" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", "locationName":"offeringType" } } }, "DescribeReservedInstancesResult":{ "type":"structure", "members":{ "ReservedInstances":{ "shape":"ReservedInstancesList", "documentation":"

A list of Reserved Instances.

", "locationName":"reservedInstancesSet" } } }, "DescribeRouteTablesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs.

Default: Describes all your route tables.

", "locationName":"RouteTableId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC.

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The CIDR range specified in a route in the table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). 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).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the route table.

", "locationName":"Filter" } } }, "DescribeRouteTablesResult":{ "type":"structure", "members":{ "RouteTables":{ "shape":"RouteTableList", "documentation":"

Information about one or more route tables.

", "locationName":"routeTableSet" } } }, "DescribeSecurityGroupsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupNames":{ "shape":"GroupNameStringList", "documentation":"

[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

", "locationName":"GroupName" }, "GroupIds":{ "shape":"GroupIdStringList", "documentation":"

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

", "locationName":"GroupId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • description - The description of the security group.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - A CIDR range that has been granted permission.

  • ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been granted permission.

  • ip-permission.group-name - The name of a security group that has been granted permission.

  • ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been granted permission.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag-key - The key of a tag assigned to the security group.

  • tag-value - The value of a tag assigned to the security group.

  • vpc-id - The ID of the VPC specified when the security group was created.

", "locationName":"Filter" } } }, "DescribeSecurityGroupsResult":{ "type":"structure", "members":{ "SecurityGroups":{ "shape":"SecurityGroupList", "documentation":"

Information about one or more security groups.

", "locationName":"securityGroupInfo" } } }, "DescribeSnapshotAttributeRequest":{ "type":"structure", "required":[ "SnapshotId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The snapshot attribute you would like to view.

" } } }, "DescribeSnapshotAttributeResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS snapshot.

", "locationName":"snapshotId" }, "CreateVolumePermissions":{ "shape":"CreateVolumePermissionList", "documentation":"

A list of permissions for creating volumes from the snapshot.

", "locationName":"createVolumePermission" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" } } }, "DescribeSnapshotsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SnapshotIds":{ "shape":"SnapshotIdStringList", "documentation":"

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

", "locationName":"SnapshotId" }, "OwnerIds":{ "shape":"OwnerStringList", "documentation":"

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

", "locationName":"Owner" }, "RestorableByUserIds":{ "shape":"RestorableByStringList", "documentation":"

One or more AWS accounts IDs that can create volumes from the snapshot.

", "locationName":"RestorableBy" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • description - A description of the snapshot.

  • owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

  • owner-id - The ID of the AWS account that owns the snapshot.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

" } } }, "DescribeSnapshotsResult":{ "type":"structure", "members":{ "Snapshots":{ "shape":"SnapshotList", "locationName":"snapshotSet" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeSpotDatafeedSubscriptionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" } } }, "DescribeSpotDatafeedSubscriptionResult":{ "type":"structure", "members":{ "SpotDatafeedSubscription":{ "shape":"SpotDatafeedSubscription", "documentation":"

The Spot Instance data feed subscription.

", "locationName":"spotDatafeedSubscription" } } }, "DescribeSpotInstanceRequestsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SpotInstanceRequestIds":{ "shape":"SpotInstanceRequestIdList", "documentation":"

One or more Spot Instance request IDs.

", "locationName":"SpotInstanceRequestId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot Instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot Instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume (gp2 | standard | io1).

  • launch.group-id - The security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m1.small).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether monitoring is enabled for the Spot Instance.

  • launch.ramdisk-id - The RAM disk ID.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • network-interface.description - A description of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.group-name - The name of the security group associated with the network interface.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot Instance request ID.

  • spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.

  • state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide for Linux.

  • status-code - The short code describing the most recent evaluation of your Spot Instance request.

  • status-message - The message explaining the status of the Spot Instance request.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of Spot Instance request (one-time | persistent).

  • launched-availability-zone - The Availability Zone in which the bid is launched.

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", "locationName":"Filter" } } }, "DescribeSpotInstanceRequestsResult":{ "type":"structure", "members":{ "SpotInstanceRequests":{ "shape":"SpotInstanceRequestList", "documentation":"

One or more Spot Instance requests.

", "locationName":"spotInstanceRequestSet" } } }, "DescribeSpotPriceHistoryRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "StartTime":{ "shape":"DateTime", "documentation":"

The date and time, up to the past 90 days, from which to start retrieving the price history data.

", "locationName":"startTime" }, "EndTime":{ "shape":"DateTime", "documentation":"

The date and time, up to the current date, from which to stop retrieving the price history data.

", "locationName":"endTime" }, "InstanceTypes":{ "shape":"InstanceTypeList", "documentation":"

Filters the results by the specified instance types.

", "locationName":"InstanceType" }, "ProductDescriptions":{ "shape":"ProductDescriptionList", "documentation":"

Filters the results by the specified basic product descriptions.

", "locationName":"ProductDescription" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m1.small).

  • product-description - The product description for the Spot Price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot Price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - 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.

", "locationName":"Filter" }, "AvailabilityZone":{ "shape":"String", "documentation":"

Filters the results by the specified Availability Zone.

", "locationName":"availabilityZone" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" } } }, "DescribeSpotPriceHistoryResult":{ "type":"structure", "members":{ "SpotPriceHistory":{ "shape":"SpotPriceHistoryList", "documentation":"

The historical Spot Prices.

", "locationName":"spotPriceHistorySet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeSubnetsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SubnetIds":{ "shape":"SubnetIdStringList", "documentation":"

One or more subnet IDs.

Default: Describes all your subnets.

", "locationName":"SubnetId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

  • available-ip-address-count - The number of IP addresses in the subnet that are available.

  • cidrBlock - 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. You can also use cidr or cidr-block as the filter names.

  • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

  • state - The state of the subnet (pending | available).

  • subnet-id - The ID of the subnet.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the subnet.

", "locationName":"Filter" } } }, "DescribeSubnetsResult":{ "type":"structure", "members":{ "Subnets":{ "shape":"SubnetList", "documentation":"

Information about one or more subnets.

", "locationName":"subnetSet" } } }, "DescribeTagsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • key - The tag key.

  • resource-id - The resource ID.

  • resource-type - The resource type (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).

  • value - The tag value.

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" } } }, "DescribeTagsResult":{ "type":"structure", "members":{ "Tags":{ "shape":"TagDescriptionList", "documentation":"

A list of tags.

", "locationName":"tagSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return..

", "locationName":"nextToken" } } }, "DescribeVolumeAttributeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "Attribute":{ "shape":"VolumeAttributeName", "documentation":"

The instance attribute.

" } } }, "DescribeVolumeAttributeResult":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "AutoEnableIO":{ "shape":"AttributeBooleanValue", "documentation":"

The state of autoEnableIO attribute.

", "locationName":"autoEnableIO" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" } } }, "DescribeVolumeStatusRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeIds":{ "shape":"VolumeIdStringList", "documentation":"

One or more volume IDs.

Default: Describes all your volumes.

", "locationName":"VolumeId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

" } } }, "DescribeVolumeStatusResult":{ "type":"structure", "members":{ "VolumeStatuses":{ "shape":"VolumeStatusList", "documentation":"

A list of volumes.

", "locationName":"volumeStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeVolumesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeIds":{ "shape":"VolumeIdStringList", "documentation":"

One or more volume IDs.

", "locationName":"VolumeId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - The encryption status of the volume.

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The status of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

", "locationName":"maxResults" } } }, "DescribeVolumesResult":{ "type":"structure", "members":{ "Volumes":{ "shape":"VolumeList", "locationName":"volumeSet" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeVpcAttributeRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "Attribute":{ "shape":"VpcAttributeName", "documentation":"

The VPC attribute.

" } } }, "DescribeVpcAttributeResult":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "EnableDnsSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

", "locationName":"enableDnsSupport" }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

", "locationName":"enableDnsHostnames" } } }, "DescribeVpcClassicLinkRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcIds":{ "shape":"VpcClassicLinkIdList", "documentation":"

One or more VPCs for which you want to describe the ClassicLink status.

", "locationName":"VpcId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } } }, "DescribeVpcClassicLinkResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"VpcClassicLinkList", "documentation":"

The ClassicLink status of one or more VPCs.

", "locationName":"vpcSet" } } }, "DescribeVpcPeeringConnectionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcPeeringConnectionIds":{ "shape":"ValueStringList", "documentation":"

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

", "locationName":"VpcPeeringConnectionId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

  • accepter-vpc-info.vpc-id - The ID of the peer VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

", "locationName":"Filter" } } }, "DescribeVpcPeeringConnectionsResult":{ "type":"structure", "members":{ "VpcPeeringConnections":{ "shape":"VpcPeeringConnectionList", "documentation":"

Information about the VPC peering connections.

", "locationName":"vpcPeeringConnectionSet" } } }, "DescribeVpcsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcIds":{ "shape":"VpcIdStringList", "documentation":"

One or more VPC IDs.

Default: Describes all your VPCs.

", "locationName":"VpcId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • cidr - 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. Must contain the slash followed by one or two digits (for example, /28).

  • dhcp-options-id - The ID of a set of DHCP options.

  • isDefault - Indicates whether the VPC is the default VPC.

  • state - The state of the VPC (pending | available).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC.

", "locationName":"Filter" } } }, "DescribeVpcsResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"VpcList", "documentation":"

Information about one or more VPCs.

", "locationName":"vpcSet" } } }, "DescribeVpnConnectionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnConnectionIds":{ "shape":"VpnConnectionIdStringList", "documentation":"

One or more VPN connection IDs.

Default: Describes your VPN connections.

", "locationName":"VpnConnectionId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

", "locationName":"Filter" } } }, "DescribeVpnConnectionsResult":{ "type":"structure", "members":{ "VpnConnections":{ "shape":"VpnConnectionList", "documentation":"

Information about one or more VPN connections.

", "locationName":"vpnConnectionSet" } } }, "DescribeVpnGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnGatewayIds":{ "shape":"VpnGatewayIdStringList", "documentation":"

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

", "locationName":"VpnGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway.

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

", "locationName":"Filter" } } }, "DescribeVpnGatewaysResult":{ "type":"structure", "members":{ "VpnGateways":{ "shape":"VpnGatewayList", "documentation":"

Information about one or more virtual private gateways.

", "locationName":"vpnGatewaySet" } } }, "DetachClassicLinkVpcRequest":{ "type":"structure", "required":[ "InstanceId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance to unlink from the VPC.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC to which the instance is linked.

", "locationName":"vpcId" } } }, "DetachClassicLinkVpcResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "DetachInternetGatewayRequest":{ "type":"structure", "required":[ "InternetGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "DetachNetworkInterfaceRequest":{ "type":"structure", "required":["AttachmentId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AttachmentId":{ "shape":"String", "documentation":"

The ID of the attachment.

", "locationName":"attachmentId" }, "Force":{ "shape":"Boolean", "documentation":"

Specifies whether to force a detachment.

", "locationName":"force" } } }, "DetachVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "Device":{ "shape":"String", "documentation":"

The device name.

" }, "Force":{ "shape":"Boolean", "documentation":"

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

" } } }, "DetachVpnGatewayRequest":{ "type":"structure", "required":[ "VpnGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } } }, "DeviceType":{ "type":"string", "enum":[ "ebs", "instance-store" ] }, "DhcpConfiguration":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The name of a DHCP option.

", "locationName":"key" }, "Values":{ "shape":"DhcpConfigurationValueList", "documentation":"

One or more values for the DHCP option.

", "locationName":"valueSet" } }, "documentation":"

Describes a DHCP configuration option.

" }, "DhcpConfigurationList":{ "type":"list", "member":{ "shape":"DhcpConfiguration", "locationName":"item" } }, "DhcpOptions":{ "type":"structure", "members":{ "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the set of DHCP options.

", "locationName":"dhcpOptionsId" }, "DhcpConfigurations":{ "shape":"DhcpConfigurationList", "documentation":"

One or more DHCP options in the set.

", "locationName":"dhcpConfigurationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the DHCP options set.

", "locationName":"tagSet" } }, "documentation":"

Describes a set of DHCP options.

" }, "DhcpOptionsIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"DhcpOptionsId" } }, "DhcpOptionsList":{ "type":"list", "member":{ "shape":"DhcpOptions", "locationName":"item" } }, "DisableVgwRoutePropagationRequest":{ "type":"structure", "required":[ "RouteTableId", "GatewayId" ], "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } } }, "DisableVpcClassicLinkRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "DisableVpcClassicLinkResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "DisassociateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" }, "AssociationId":{ "shape":"String", "documentation":"

[EC2-VPC] The association ID. Required for EC2-VPC.

" } } }, "DisassociateRouteTableRequest":{ "type":"structure", "required":["AssociationId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID representing the current association between the route table and subnet.

", "locationName":"associationId" } } }, "DiskImage":{ "type":"structure", "members":{ "Image":{"shape":"DiskImageDetail"}, "Description":{"shape":"String"}, "Volume":{"shape":"VolumeDetail"} }, "documentation":"

Describes a disk image.

" }, "DiskImageDescription":{ "type":"structure", "required":[ "Format", "Size", "ImportManifestUrl" ], "members":{ "Format":{ "shape":"DiskImageFormat", "documentation":"

The disk image format.

", "locationName":"format" }, "Size":{ "shape":"Long", "documentation":"

The size of the disk image.

", "locationName":"size" }, "ImportManifestUrl":{ "shape":"String", "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

", "locationName":"importManifestUrl" }, "Checksum":{ "shape":"String", "documentation":"

The checksum computed for the disk image.

", "locationName":"checksum" } } }, "DiskImageDetail":{ "type":"structure", "required":[ "Format", "Bytes", "ImportManifestUrl" ], "members":{ "Format":{ "shape":"DiskImageFormat", "documentation":"

The disk image format.

", "locationName":"format" }, "Bytes":{ "shape":"Long", "locationName":"bytes" }, "ImportManifestUrl":{ "shape":"String", "documentation":"

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

", "locationName":"importManifestUrl" } } }, "DiskImageFormat":{ "type":"string", "enum":[ "VMDK", "RAW", "VHD" ] }, "DiskImageList":{ "type":"list", "member":{"shape":"DiskImage"} }, "DiskImageVolumeDescription":{ "type":"structure", "required":["Id"], "members":{ "Size":{ "shape":"Long", "documentation":"

The size of the volume.

", "locationName":"size" }, "Id":{ "shape":"String", "documentation":"

The volume identifier.

", "locationName":"id" } } }, "DomainType":{ "type":"string", "enum":[ "vpc", "standard" ] }, "Double":{"type":"double"}, "EbsBlockDevice":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

", "locationName":"snapshotId" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

Constraints: 1-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

", "locationName":"volumeSize" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the Amazon EBS volume is deleted on instance termination.

", "locationName":"deleteOnTermination" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

", "locationName":"volumeType" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide for Linux.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

", "locationName":"iops" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

", "locationName":"encrypted" } }, "documentation":"

Describes an Amazon EBS block device.

" }, "EbsInstanceBlockDevice":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS volume.

", "locationName":"volumeId" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a parameter used to set up an Amazon EBS volume in a block device mapping.

" }, "EbsInstanceBlockDeviceSpecification":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS volume.

", "locationName":"volumeId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } } }, "EnableVgwRoutePropagationRequest":{ "type":"structure", "required":[ "RouteTableId", "GatewayId" ], "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } } }, "EnableVolumeIORequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" } } }, "EnableVpcClassicLinkRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "EnableVpcClassicLinkResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "EventCode":{ "type":"string", "enum":[ "instance-reboot", "system-reboot", "system-maintenance", "instance-retirement", "instance-stop" ] }, "ExecutableByStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ExecutableBy" } }, "ExportEnvironment":{ "type":"string", "enum":[ "citrix", "vmware", "microsoft" ] }, "ExportTask":{ "type":"structure", "members":{ "ExportTaskId":{ "shape":"String", "documentation":"

The ID of the export task.

", "locationName":"exportTaskId" }, "Description":{ "shape":"String", "documentation":"

A description of the resource being exported.

", "locationName":"description" }, "State":{ "shape":"ExportTaskState", "documentation":"

The state of the conversion task.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message related to the export task.

", "locationName":"statusMessage" }, "InstanceExportDetails":{ "shape":"InstanceExportDetails", "documentation":"

The instance being exported.

", "locationName":"instanceExport" }, "ExportToS3Task":{ "shape":"ExportToS3Task", "locationName":"exportToS3" } }, "documentation":"

Describes an export task.

" }, "ExportTaskIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ExportTaskId" } }, "ExportTaskList":{ "type":"list", "member":{ "shape":"ExportTask", "locationName":"item" } }, "ExportTaskState":{ "type":"string", "enum":[ "active", "cancelling", "cancelled", "completed" ] }, "ExportToS3Task":{ "type":"structure", "members":{ "DiskImageFormat":{ "shape":"DiskImageFormat", "documentation":"

The format for the exported image.

", "locationName":"diskImageFormat" }, "ContainerFormat":{ "shape":"ContainerFormat", "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", "locationName":"containerFormat" }, "S3Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", "locationName":"s3Bucket" }, "S3Key":{ "shape":"String", "locationName":"s3Key" } } }, "ExportToS3TaskSpecification":{ "type":"structure", "members":{ "DiskImageFormat":{ "shape":"DiskImageFormat", "locationName":"diskImageFormat" }, "ContainerFormat":{ "shape":"ContainerFormat", "locationName":"containerFormat" }, "S3Bucket":{ "shape":"String", "locationName":"s3Bucket" }, "S3Prefix":{ "shape":"String", "documentation":"

The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

", "locationName":"s3Prefix" } } }, "Filter":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the filter. Filter names are case-sensitive.

" }, "Values":{ "shape":"ValueStringList", "documentation":"

One or more filter values. Filter values are case-sensitive.

", "locationName":"Value" } }, "documentation":"

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.

" }, "FilterList":{ "type":"list", "member":{ "shape":"Filter", "locationName":"Filter" } }, "Float":{"type":"float"}, "GatewayType":{ "type":"string", "enum":["ipsec.1"] }, "GetConsoleOutputRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" } } }, "GetConsoleOutputResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The time the output was last updated.

", "locationName":"timestamp" }, "Output":{ "shape":"String", "documentation":"

The console output, Base64 encoded.

", "locationName":"output" } } }, "GetPasswordDataRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the Windows instance.

" } } }, "GetPasswordDataResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the Windows instance.

", "locationName":"instanceId" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The time the data was last updated.

", "locationName":"timestamp" }, "PasswordData":{ "shape":"String", "documentation":"

The password of the instance.

", "locationName":"passwordData" } } }, "GroupIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"groupId" } }, "GroupIdentifier":{ "type":"structure", "members":{ "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } }, "documentation":"

Describes a security group.

" }, "GroupIdentifierList":{ "type":"list", "member":{ "shape":"GroupIdentifier", "locationName":"item" } }, "GroupNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"GroupName" } }, "HypervisorType":{ "type":"string", "enum":[ "ovm", "xen" ] }, "IamInstanceProfile":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", "locationName":"arn" }, "Id":{ "shape":"String", "documentation":"

The ID of the instance profile.

", "locationName":"id" } }, "documentation":"

Describes an IAM instance profile.

" }, "IamInstanceProfileSpecification":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", "locationName":"arn" }, "Name":{ "shape":"String", "documentation":"

The name of the instance profile.

", "locationName":"name" } }, "documentation":"

Describes an IAM instance profile.

" }, "IcmpTypeCode":{ "type":"structure", "members":{ "Type":{ "shape":"Integer", "documentation":"

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", "locationName":"type" }, "Code":{ "shape":"Integer", "documentation":"

The ICMP type. A value of -1 means all types.

", "locationName":"code" } }, "documentation":"

Describes the ICMP type and code.

" }, "Image":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "ImageLocation":{ "shape":"String", "documentation":"

The location of the AMI.

", "locationName":"imageLocation" }, "State":{ "shape":"ImageState", "documentation":"

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", "locationName":"imageState" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the image owner.

", "locationName":"imageOwnerId" }, "CreationDate":{ "shape":"String", "documentation":"

The date and time the image was created.

", "locationName":"creationDate" }, "Public":{ "shape":"Boolean", "documentation":"

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

", "locationName":"isPublic" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

Any product codes associated with the AMI.

", "locationName":"productCodes" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the image.

", "locationName":"architecture" }, "ImageType":{ "shape":"ImageTypeValues", "documentation":"

The type of image.

", "locationName":"imageType" }, "KernelId":{ "shape":"String", "documentation":"

The kernel associated with the image, if any. Only applicable for machine images.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The RAM disk associated with the image, if any. Only applicable for machine images.

", "locationName":"ramdiskId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The value is Windows for Windows AMIs; otherwise blank.

", "locationName":"platform" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Specifies whether enhanced networking is enabled.

", "locationName":"sriovNetSupport" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason for the state change.

", "locationName":"stateReason" }, "ImageOwnerAlias":{ "shape":"String", "documentation":"

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

", "locationName":"imageOwnerAlias" }, "Name":{ "shape":"String", "documentation":"

The name of the AMI that was provided during image creation.

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

The description of the AMI that was provided during image creation.

", "locationName":"description" }, "RootDeviceType":{ "shape":"DeviceType", "documentation":"

The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

", "locationName":"rootDeviceType" }, "RootDeviceName":{ "shape":"String", "documentation":"

The device name of the root device (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

Any block device mapping entries.

", "locationName":"blockDeviceMapping" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The type of virtualization of the AMI.

", "locationName":"virtualizationType" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the image.

", "locationName":"tagSet" }, "Hypervisor":{ "shape":"HypervisorType", "documentation":"

The hypervisor type of the image.

", "locationName":"hypervisor" } }, "documentation":"

Describes an image.

" }, "ImageAttribute":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "LaunchPermissions":{ "shape":"LaunchPermissionList", "documentation":"

One or more launch permissions.

", "locationName":"launchPermission" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

One or more product codes.

", "locationName":"productCodes" }, "KernelId":{ "shape":"AttributeValue", "documentation":"

The kernel ID.

", "locationName":"kernel" }, "RamdiskId":{ "shape":"AttributeValue", "documentation":"

The RAM disk ID.

", "locationName":"ramdisk" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the AMI.

", "locationName":"description" }, "SriovNetSupport":{ "shape":"AttributeValue", "locationName":"sriovNetSupport" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" } }, "documentation":"

Describes an image attribute.

" }, "ImageAttributeName":{ "type":"string", "enum":[ "description", "kernel", "ramdisk", "launchPermission", "productCodes", "blockDeviceMapping", "sriovNetSupport" ] }, "ImageDiskContainer":{ "type":"structure", "members":{ "Description":{ "shape":"String", "documentation":"

The description of the disk image (optional).

" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image being imported (optional).

" }, "Url":{ "shape":"String", "documentation":"

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)

" }, "UserBucket":{"shape":"UserBucket"}, "DeviceName":{ "shape":"String", "documentation":"

The Amazon EBS block device mapping for the disk (optional).

" }, "SnapshotId":{ "shape":"String", "documentation":"

The Amazon EBS snapshot ID to be used for importing the snapshot.

" } }, "documentation":"

The disk container object for an ImportImage task.

" }, "ImageDiskContainerList":{ "type":"list", "member":{ "shape":"ImageDiskContainer", "locationName":"item" } }, "ImageIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ImageId" } }, "ImageList":{ "type":"list", "member":{ "shape":"Image", "locationName":"item" } }, "ImageState":{ "type":"string", "enum":[ "pending", "available", "invalid", "deregistered", "transient", "failed", "error" ] }, "ImageTypeValues":{ "type":"string", "enum":[ "machine", "kernel", "ramdisk" ] }, "ImportImageRequest":{ "type":"structure", "members":{ "DryRun":{"shape":"Boolean"}, "Description":{ "shape":"String", "documentation":"

A description string for the import image task (optional).

" }, "DiskContainers":{ "shape":"ImageDiskContainerList", "locationName":"DiskContainer" }, "LicenseType":{ "shape":"String", "documentation":"

The license type to be used for the Amazon Machine Image (AMI) after importing (optional).

Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see VM Import/Export Prerequisites in the Amazon Elastic Compute Cloud User Guide for Linux.

Valid Values: AWS | BYOL

" }, "Hypervisor":{ "shape":"String", "documentation":"

The target hypervisor platform to use (optional).

" }, "Architecture":{ "shape":"String", "documentation":"

The architecture of the virtual machine being imported (optional).

" }, "Platform":{ "shape":"String", "documentation":"

The operating system of the virtual machine being imported (optional).

" }, "ClientData":{ "shape":"ClientData", "documentation":"

Client-specific data.

" }, "ClientToken":{ "shape":"String", "documentation":"

The token to enable idempotency for VM import requests (optional).

" }, "RoleName":{ "shape":"String", "documentation":"

The name of the role to use when not using the default role name 'vmimport' (optional).

" } } }, "ImportImageResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The task id of the ImportImage task.

", "locationName":"importTaskId" }, "Architecture":{ "shape":"String", "documentation":"

Architecture of the virtual machine being imported.

", "locationName":"architecture" }, "LicenseType":{ "shape":"String", "documentation":"

License type of the virtual machine being imported.

", "locationName":"licenseType" }, "Platform":{ "shape":"String", "documentation":"

Operating system of the VM being imported.

", "locationName":"platform" }, "Hypervisor":{ "shape":"String", "documentation":"

Target hypervisor of the import task.

", "locationName":"hypervisor" }, "Description":{ "shape":"String", "documentation":"

A description of the import task.

", "locationName":"description" }, "SnapshotDetails":{ "shape":"SnapshotDetailList", "locationName":"snapshotDetailSet" }, "ImageId":{ "shape":"String", "documentation":"

The Amazon Machine Image (AMI) ID created by the import task.

", "locationName":"imageId" }, "Progress":{ "shape":"String", "documentation":"

The task's progress.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message of the import task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status of the task.

", "locationName":"status" } } }, "ImportImageTask":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import task.

", "locationName":"importTaskId" }, "Architecture":{ "shape":"String", "documentation":"

Architecture of the VM being imported.

", "locationName":"architecture" }, "LicenseType":{ "shape":"String", "documentation":"

License type of the VM being imported.

", "locationName":"licenseType" }, "Platform":{ "shape":"String", "documentation":"

The description string for the import image task.

", "locationName":"platform" }, "Hypervisor":{ "shape":"String", "documentation":"

Target hypervisor for the import task.

", "locationName":"hypervisor" }, "Description":{ "shape":"String", "documentation":"

Description of the import task.

", "locationName":"description" }, "SnapshotDetails":{ "shape":"SnapshotDetailList", "locationName":"snapshotDetailSet" }, "ImageId":{ "shape":"String", "documentation":"

The Amazon Machine Image (AMI) ID of the imported virtual machine.

", "locationName":"imageId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of progress of the ImportImage task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A descriptive status message for the ImportImage task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status for the ImportImage task.

", "locationName":"status" } } }, "ImportImageTaskList":{ "type":"list", "member":{ "shape":"ImportImageTask", "locationName":"item" } }, "ImportInstanceLaunchSpecification":{ "type":"structure", "members":{ "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the instance.

", "locationName":"architecture" }, "GroupNames":{ "shape":"SecurityGroupStringList", "documentation":"

One or more security group names.

", "locationName":"GroupName" }, "GroupIds":{ "shape":"SecurityGroupIdStringList", "documentation":"

One or more security group IDs.

", "locationName":"GroupId" }, "AdditionalInfo":{ "shape":"String", "locationName":"additionalInfo" }, "UserData":{ "shape":"UserData", "documentation":"

User data to be made available to the instance.

", "locationName":"userData" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. This is not supported for VMs imported into a VPC, which are assigned the default security group. After a VM is imported into a VPC, you can specify another security group using the AWS Management Console. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux. For more information about the Linux instance types you can import, see Before You Get Started in the Amazon Elastic Compute Cloud User Guide for Linux.

", "locationName":"instanceType" }, "Placement":{ "shape":"Placement", "locationName":"placement" }, "Monitoring":{ "shape":"Boolean", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

", "locationName":"subnetId" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] Optionally, you can use this parameter to assign the instance a specific available IP address from the IP address range of the subnet.

", "locationName":"privateIpAddress" } } }, "ImportInstanceRequest":{ "type":"structure", "required":["Platform"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Description":{ "shape":"String", "documentation":"

A description for the instance being imported.

", "locationName":"description" }, "LaunchSpecification":{ "shape":"ImportInstanceLaunchSpecification", "locationName":"launchSpecification" }, "DiskImages":{ "shape":"DiskImageList", "locationName":"diskImage" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The instance operating system.

", "locationName":"platform" } } }, "ImportInstanceResult":{ "type":"structure", "members":{ "ConversionTask":{ "shape":"ConversionTask", "locationName":"conversionTask" } } }, "ImportInstanceTaskDetails":{ "type":"structure", "required":["Volumes"], "members":{ "Volumes":{ "shape":"ImportInstanceVolumeDetailSet", "locationName":"volumes" }, "InstanceId":{ "shape":"String", "locationName":"instanceId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The instance operating system.

", "locationName":"platform" }, "Description":{ "shape":"String", "locationName":"description" } } }, "ImportInstanceVolumeDetailItem":{ "type":"structure", "required":[ "BytesConverted", "AvailabilityZone", "Image", "Volume", "Status" ], "members":{ "BytesConverted":{ "shape":"Long", "documentation":"

The number of bytes converted so far.

", "locationName":"bytesConverted" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the resulting instance will reside.

", "locationName":"availabilityZone" }, "Image":{ "shape":"DiskImageDescription", "documentation":"

The image.

", "locationName":"image" }, "Volume":{ "shape":"DiskImageVolumeDescription", "documentation":"

The volume.

", "locationName":"volume" }, "Status":{ "shape":"String", "documentation":"

The status of the import of this particular disk image.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The status information or errors related to the disk image.

", "locationName":"statusMessage" }, "Description":{ "shape":"String", "locationName":"description" } }, "documentation":"

Describes an import volume task.

" }, "ImportInstanceVolumeDetailSet":{ "type":"list", "member":{ "shape":"ImportInstanceVolumeDetailItem", "locationName":"item" } }, "ImportKeyPairRequest":{ "type":"structure", "required":[ "KeyName", "PublicKeyMaterial" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

A unique name for the key pair.

", "locationName":"keyName" }, "PublicKeyMaterial":{ "shape":"Blob", "documentation":"

The public key. You must base64 encode the public key material before sending it to AWS.

", "locationName":"publicKeyMaterial" } } }, "ImportKeyPairResult":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The key pair name you provided.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", "locationName":"keyFingerprint" } } }, "ImportSnapshotRequest":{ "type":"structure", "members":{ "DryRun":{"shape":"Boolean"}, "Description":{ "shape":"String", "documentation":"

The description string for the ImportSnapshot task.

" }, "DiskContainer":{"shape":"SnapshotDiskContainer"}, "ClientData":{"shape":"ClientData"}, "ClientToken":{ "shape":"String", "documentation":"

Token to enable idempotency for VM import requests (optional).

" }, "RoleName":{ "shape":"String", "documentation":"

The name of the role to use when not using the default role name 'vmimport' (optional).

" } } }, "ImportSnapshotResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

Task ID of the ImportSnapshot task.

", "locationName":"importTaskId" }, "SnapshotTaskDetail":{ "shape":"SnapshotTaskDetail", "locationName":"snapshotTaskDetail" }, "Description":{ "shape":"String", "documentation":"

Description of the import snapshot task.

", "locationName":"description" } } }, "ImportSnapshotTask":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The task ID of the ImportSnapshot task.

", "locationName":"importTaskId" }, "SnapshotTaskDetail":{ "shape":"SnapshotTaskDetail", "locationName":"snapshotTaskDetail" }, "Description":{ "shape":"String", "documentation":"

Description for the import snapshot task.

", "locationName":"description" } } }, "ImportSnapshotTaskList":{ "type":"list", "member":{ "shape":"ImportSnapshotTask", "locationName":"item" } }, "ImportTaskIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"ImportTaskId" } }, "ImportVolumeRequest":{ "type":"structure", "required":[ "AvailabilityZone", "Image", "Volume" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the resulting Amazon EBS volume.

", "locationName":"availabilityZone" }, "Image":{ "shape":"DiskImageDetail", "locationName":"image" }, "Description":{ "shape":"String", "documentation":"

An optional description for the volume being imported.

", "locationName":"description" }, "Volume":{ "shape":"VolumeDetail", "locationName":"volume" } } }, "ImportVolumeResult":{ "type":"structure", "members":{ "ConversionTask":{ "shape":"ConversionTask", "locationName":"conversionTask" } } }, "ImportVolumeTaskDetails":{ "type":"structure", "required":[ "BytesConverted", "AvailabilityZone", "Image", "Volume" ], "members":{ "BytesConverted":{ "shape":"Long", "documentation":"

The number of bytes converted so far.

", "locationName":"bytesConverted" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the resulting volume will reside.

", "locationName":"availabilityZone" }, "Description":{ "shape":"String", "documentation":"

The description you provided when starting the import volume task.

", "locationName":"description" }, "Image":{ "shape":"DiskImageDescription", "documentation":"

The image.

", "locationName":"image" }, "Volume":{ "shape":"DiskImageVolumeDescription", "documentation":"

The volume.

", "locationName":"volume" } }, "documentation":"

Describes an import volume task.

" }, "Instance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI used to launch the instance.

", "locationName":"imageId" }, "State":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

", "locationName":"instanceState" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

", "locationName":"privateDnsName" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name assigned to the instance. This name is not available until the instance enters the running state.

", "locationName":"dnsName" }, "StateTransitionReason":{ "shape":"String", "documentation":"

The reason for the most recent state transition. This might be an empty string.

", "locationName":"reason" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair, if this instance was launched with an associated key pair.

", "locationName":"keyName" }, "AmiLaunchIndex":{ "shape":"Integer", "documentation":"

The AMI launch index, which can be used to find this instance in the launch group.

", "locationName":"amiLaunchIndex" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

The product codes attached to this instance.

", "locationName":"productCodes" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "LaunchTime":{ "shape":"DateTime", "documentation":"

The time the instance was launched.

", "locationName":"launchTime" }, "Placement":{ "shape":"Placement", "documentation":"

The location where the instance launched.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The kernel associated with this instance.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The RAM disk associated with this instance.

", "locationName":"ramdiskId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The value is Windows for Windows instances; otherwise blank.

", "locationName":"platform" }, "Monitoring":{ "shape":"Monitoring", "documentation":"

The monitoring information for the instance.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which the instance is running.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC in which the instance is running.

", "locationName":"vpcId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address assigned to the instance.

", "locationName":"privateIpAddress" }, "PublicIpAddress":{ "shape":"String", "documentation":"

The public IP address assigned to the instance.

", "locationName":"ipAddress" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason for the most recent state transition.

", "locationName":"stateReason" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the image.

", "locationName":"architecture" }, "RootDeviceType":{ "shape":"DeviceType", "documentation":"

The root device type used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

", "locationName":"rootDeviceType" }, "RootDeviceName":{ "shape":"String", "documentation":"

The root device name (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"

Any block device mapping entries for the instance.

", "locationName":"blockDeviceMapping" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The virtualization type of the instance.

", "locationName":"virtualizationType" }, "InstanceLifecycle":{ "shape":"InstanceLifecycleType", "documentation":"

Indicates whether this is a Spot Instance.

", "locationName":"instanceLifecycle" }, "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot Instance request.

", "locationName":"spotInstanceRequestId" }, "ClientToken":{ "shape":"String", "documentation":"

The idempotency token you provided when you launched the instance.

", "locationName":"clientToken" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the instance.

", "locationName":"tagSet" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups for the instance.

", "locationName":"groupSet" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", "locationName":"sourceDestCheck" }, "Hypervisor":{ "shape":"HypervisorType", "documentation":"

The hypervisor type of the instance.

", "locationName":"hypervisor" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceList", "documentation":"

[EC2-VPC] One or more network interfaces for the instance.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfile", "documentation":"

The IAM instance profile associated with the instance.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Specifies whether enhanced networking is enabled.

", "locationName":"sriovNetSupport" } }, "documentation":"

Describes an instance.

" }, "InstanceAttribute":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "InstanceType":{ "shape":"AttributeValue", "documentation":"

The instance type.

", "locationName":"instanceType" }, "KernelId":{ "shape":"AttributeValue", "documentation":"

The kernel ID.

", "locationName":"kernel" }, "RamdiskId":{ "shape":"AttributeValue", "documentation":"

The RAM disk ID.

", "locationName":"ramdisk" }, "UserData":{ "shape":"AttributeValue", "documentation":"

The Base64-encoded MIME user data.

", "locationName":"userData" }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", "documentation":"

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ "shape":"AttributeValue", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "RootDeviceName":{ "shape":"AttributeValue", "documentation":"

The name of the root device (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"

The block device mapping of the instance.

", "locationName":"blockDeviceMapping" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" }, "EbsOptimized":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instance is optimized for EBS I/O.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"AttributeValue", "locationName":"sriovNetSupport" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

The security groups associated with the instance.

", "locationName":"groupSet" } }, "documentation":"

Describes an instance attribute.

" }, "InstanceAttributeName":{ "type":"string", "enum":[ "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "rootDeviceName", "blockDeviceMapping", "productCodes", "sourceDestCheck", "groupSet", "ebsOptimized", "sriovNetSupport" ] }, "InstanceBlockDeviceMapping":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsInstanceBlockDevice", "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", "locationName":"ebs" } }, "documentation":"

Describes a block device mapping.

" }, "InstanceBlockDeviceMappingList":{ "type":"list", "member":{ "shape":"InstanceBlockDeviceMapping", "locationName":"item" } }, "InstanceBlockDeviceMappingSpecification":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsInstanceBlockDeviceSpecification", "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", "locationName":"ebs" }, "VirtualName":{ "shape":"String", "documentation":"

The virtual device name.

", "locationName":"virtualName" }, "NoDevice":{ "shape":"String", "documentation":"

suppress the specified device included in the block device mapping.

", "locationName":"noDevice" } }, "documentation":"

Describes a block device mapping entry.

" }, "InstanceBlockDeviceMappingSpecificationList":{ "type":"list", "member":{ "shape":"InstanceBlockDeviceMappingSpecification", "locationName":"item" } }, "InstanceCount":{ "type":"structure", "members":{ "State":{ "shape":"ListingState", "documentation":"

The states of the listed Reserved Instances.

", "locationName":"state" }, "InstanceCount":{ "shape":"Integer", "documentation":"

he number of listed Reserved Instances in the state specified by the state.

", "locationName":"instanceCount" } }, "documentation":"

Describes a Reserved Instance listing state.

" }, "InstanceCountList":{ "type":"list", "member":{ "shape":"InstanceCount", "locationName":"item" } }, "InstanceExportDetails":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the resource being exported.

", "locationName":"instanceId" }, "TargetEnvironment":{ "shape":"ExportEnvironment", "documentation":"

The target virtualization environment.

", "locationName":"targetEnvironment" } }, "documentation":"

Describes an instance export task.

" }, "InstanceIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"InstanceId" } }, "InstanceLifecycleType":{ "type":"string", "enum":["spot"] }, "InstanceList":{ "type":"list", "member":{ "shape":"Instance", "locationName":"item" } }, "InstanceMonitoring":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Monitoring":{ "shape":"Monitoring", "documentation":"

The monitoring information.

", "locationName":"monitoring" } }, "documentation":"

Describes the monitoring information of the instance.

" }, "InstanceMonitoringList":{ "type":"list", "member":{ "shape":"InstanceMonitoring", "locationName":"item" } }, "InstanceNetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Description":{ "shape":"String", "documentation":"

The description.

", "locationName":"description" }, "OwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that created the network interface.

", "locationName":"ownerId" }, "Status":{ "shape":"NetworkInterfaceStatus", "documentation":"

The status of the network interface.

", "locationName":"status" }, "MacAddress":{ "shape":"String", "documentation":"

The MAC address.

", "locationName":"macAddress" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Indicates whether to validate network traffic to or from this network interface.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups.

", "locationName":"groupSet" }, "Attachment":{ "shape":"InstanceNetworkInterfaceAttachment", "documentation":"

The network interface attachment.

", "locationName":"attachment" }, "Association":{ "shape":"InstanceNetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP associated with the network interface.

", "locationName":"association" }, "PrivateIpAddresses":{ "shape":"InstancePrivateIpAddressList", "documentation":"

The private IP addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" } }, "documentation":"

Describes a network interface.

" }, "InstanceNetworkInterfaceAssociation":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The public IP address or Elastic IP address bound to the network interface.

", "locationName":"publicIp" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name.

", "locationName":"publicDnsName" }, "IpOwnerId":{ "shape":"String", "documentation":"

The ID of the owner of the Elastic IP address.

", "locationName":"ipOwnerId" } }, "documentation":"

Describes association information for an Elastic IP address.

" }, "InstanceNetworkInterfaceAttachment":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device on the instance for the network interface attachment.

", "locationName":"deviceIndex" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a network interface attachment.

" }, "InstanceNetworkInterfaceList":{ "type":"list", "member":{ "shape":"InstanceNetworkInterface", "locationName":"item" } }, "InstanceNetworkInterfaceSpecification":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

", "locationName":"deviceIndex" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

", "locationName":"subnetId" }, "Description":{ "shape":"String", "documentation":"

The description of the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"description" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"privateIpAddress" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"SecurityGroupId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

", "locationName":"deleteOnTermination" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", "documentation":"

One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.

", "locationName":"privateIpAddressesSet", "queryName":"PrivateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.

", "locationName":"secondaryPrivateIpAddressCount" }, "AssociatePublicIpAddress":{ "shape":"Boolean", "documentation":"

Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

", "locationName":"associatePublicIpAddress" } }, "documentation":"

Describes a network interface.

" }, "InstanceNetworkInterfaceSpecificationList":{ "type":"list", "member":{ "shape":"InstanceNetworkInterfaceSpecification", "locationName":"item" } }, "InstancePrivateIpAddress":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the network interface.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", "locationName":"primary" }, "Association":{ "shape":"InstanceNetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address for the network interface.

", "locationName":"association" } }, "documentation":"

Describes a private IP address.

" }, "InstancePrivateIpAddressList":{ "type":"list", "member":{ "shape":"InstancePrivateIpAddress", "locationName":"item" } }, "InstanceState":{ "type":"structure", "members":{ "Code":{ "shape":"Integer", "documentation":"

The low byte represents the state. The high byte is an opaque internal value and should be ignored.

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

", "locationName":"code" }, "Name":{ "shape":"InstanceStateName", "documentation":"

The current state of the instance.

", "locationName":"name" } }, "documentation":"

Describes the current state of the instance.

" }, "InstanceStateChange":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "CurrentState":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

", "locationName":"currentState" }, "PreviousState":{ "shape":"InstanceState", "documentation":"

The previous state of the instance.

", "locationName":"previousState" } }, "documentation":"

Describes an instance state change.

" }, "InstanceStateChangeList":{ "type":"list", "member":{ "shape":"InstanceStateChange", "locationName":"item" } }, "InstanceStateName":{ "type":"string", "enum":[ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ] }, "InstanceStatus":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the instance.

", "locationName":"availabilityZone" }, "Events":{ "shape":"InstanceStatusEventList", "documentation":"

Extra information regarding events associated with the instance.

", "locationName":"eventsSet" }, "InstanceState":{ "shape":"InstanceState", "documentation":"

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

", "locationName":"instanceState" }, "SystemStatus":{ "shape":"InstanceStatusSummary", "documentation":"

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

", "locationName":"systemStatus" }, "InstanceStatus":{ "shape":"InstanceStatusSummary", "documentation":"

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

", "locationName":"instanceStatus" } }, "documentation":"

Describes the status of an instance.

" }, "InstanceStatusDetails":{ "type":"structure", "members":{ "Name":{ "shape":"StatusName", "documentation":"

The type of instance status.

", "locationName":"name" }, "Status":{ "shape":"StatusType", "documentation":"

The status.

", "locationName":"status" }, "ImpairedSince":{ "shape":"DateTime", "documentation":"

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

", "locationName":"impairedSince" } }, "documentation":"

Describes the instance status.

" }, "InstanceStatusDetailsList":{ "type":"list", "member":{ "shape":"InstanceStatusDetails", "locationName":"item" } }, "InstanceStatusEvent":{ "type":"structure", "members":{ "Code":{ "shape":"EventCode", "documentation":"

The associated code of the event.

", "locationName":"code" }, "Description":{ "shape":"String", "documentation":"

A description of the event.

", "locationName":"description" }, "NotBefore":{ "shape":"DateTime", "documentation":"

The earliest scheduled start time for the event.

", "locationName":"notBefore" }, "NotAfter":{ "shape":"DateTime", "documentation":"

The latest scheduled end time for the event.

", "locationName":"notAfter" } }, "documentation":"

Describes an instance event.

" }, "InstanceStatusEventList":{ "type":"list", "member":{ "shape":"InstanceStatusEvent", "locationName":"item" } }, "InstanceStatusList":{ "type":"list", "member":{ "shape":"InstanceStatus", "locationName":"item" } }, "InstanceStatusSummary":{ "type":"structure", "members":{ "Status":{ "shape":"SummaryStatus", "documentation":"

The status.

", "locationName":"status" }, "Details":{ "shape":"InstanceStatusDetailsList", "documentation":"

The system instance health or application instance health.

", "locationName":"details" } }, "documentation":"

Describes the status of an instance.

" }, "InstanceType":{ "type":"string", "enum":[ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "t2.micro", "t2.small", "t2.medium", "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", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge" ] }, "InstanceTypeList":{ "type":"list", "member":{"shape":"InstanceType"} }, "Integer":{"type":"integer"}, "InternetGateway":{ "type":"structure", "members":{ "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "Attachments":{ "shape":"InternetGatewayAttachmentList", "documentation":"

Any VPCs attached to the Internet gateway.

", "locationName":"attachmentSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the Internet gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes an Internet gateway.

" }, "InternetGatewayAttachment":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"AttachmentStatus", "documentation":"

The current state of the attachment.

", "locationName":"state" } }, "documentation":"

Describes the attachment of a VPC to an Internet gateway.

" }, "InternetGatewayAttachmentList":{ "type":"list", "member":{ "shape":"InternetGatewayAttachment", "locationName":"item" } }, "InternetGatewayList":{ "type":"list", "member":{ "shape":"InternetGateway", "locationName":"item" } }, "IpPermission":{ "type":"structure", "members":{ "IpProtocol":{ "shape":"String", "documentation":"

The protocol.

When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers. (VPC only) When you call AuthorizeSecurityGroupIngress, you can use -1 to specify all.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

", "locationName":"toPort" }, "UserIdGroupPairs":{ "shape":"UserIdGroupPairList", "documentation":"

One or more security group and AWS account ID pairs.

", "locationName":"groups" }, "IpRanges":{ "shape":"IpRangeList", "documentation":"

One or more IP ranges.

", "locationName":"ipRanges" } }, "documentation":"

Describes a security group rule.

" }, "IpPermissionList":{ "type":"list", "member":{ "shape":"IpPermission", "locationName":"item" } }, "IpRange":{ "type":"structure", "members":{ "CidrIp":{ "shape":"String", "documentation":"

The CIDR range. You can either specify a CIDR range or a source security group, not both.

", "locationName":"cidrIp" } }, "documentation":"

Describes an IP range.

" }, "IpRangeList":{ "type":"list", "member":{ "shape":"IpRange", "locationName":"item" } }, "KeyNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"KeyName" } }, "KeyPair":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

The SHA-1 digest of the DER encoded private key.

", "locationName":"keyFingerprint" }, "KeyMaterial":{ "shape":"String", "documentation":"

An unencrypted PEM encoded RSA private key.

", "locationName":"keyMaterial" } }, "documentation":"

Describes a key pair.

" }, "KeyPairInfo":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", "locationName":"keyFingerprint" } }, "documentation":"

Describes a key pair.

" }, "KeyPairList":{ "type":"list", "member":{ "shape":"KeyPairInfo", "locationName":"item" } }, "LaunchPermission":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The AWS account ID.

", "locationName":"userId" }, "Group":{ "shape":"PermissionGroup", "documentation":"

The name of the group.

", "locationName":"group" } }, "documentation":"

Describes a launch permission.

" }, "LaunchPermissionList":{ "type":"list", "member":{ "shape":"LaunchPermission", "locationName":"item" } }, "LaunchPermissionModifications":{ "type":"structure", "members":{ "Add":{ "shape":"LaunchPermissionList", "documentation":"

The AWS account ID to add to the list of launch permissions for the AMI.

" }, "Remove":{ "shape":"LaunchPermissionList", "documentation":"

The AWS account ID to remove from the list of launch permissions for the AMI.

" } }, "documentation":"

Describes a launch permission modification.

" }, "LaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups. To request an instance in a nondefault VPC, you must specify the ID of the security group. To request an instance in EC2-Classic or a default VPC, you can specify the name or the ID of the security group.

", "locationName":"groupSet" }, "UserData":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" } }, "documentation":"

Describes the launch specification for an instance.

" }, "ListingState":{ "type":"string", "enum":[ "available", "sold", "cancelled", "pending" ] }, "ListingStatus":{ "type":"string", "enum":[ "active", "pending", "cancelled", "closed" ] }, "Long":{"type":"long"}, "ModifyImageAttributeRequest":{ "type":"structure", "required":["ImageId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"String", "documentation":"

The name of the attribute to modify.

" }, "OperationType":{ "shape":"String", "documentation":"

The operation type.

" }, "UserIds":{ "shape":"UserIdStringList", "documentation":"

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

", "locationName":"UserId" }, "UserGroups":{ "shape":"UserGroupStringList", "documentation":"

One or more user groups. This is only valid when modifying the launchPermission attribute.

", "locationName":"UserGroup" }, "ProductCodes":{ "shape":"ProductCodeStringList", "documentation":"

One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

", "locationName":"ProductCode" }, "Value":{ "shape":"String", "documentation":"

The value of the attribute being modified. This is only valid when modifying the description attribute.

" }, "LaunchPermission":{ "shape":"LaunchPermissionModifications", "documentation":"

A launch permission modification.

" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the AMI.

" } } }, "ModifyInstanceAttributeRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The name of the attribute.

", "locationName":"attribute" }, "Value":{ "shape":"String", "documentation":"

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or intanceInitiateShutdownBehavior attribute.

", "locationName":"value" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingSpecificationList", "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

", "locationName":"blockDeviceMapping" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

" }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", "documentation":"

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.

", "locationName":"disableApiTermination" }, "InstanceType":{ "shape":"AttributeValue", "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", "locationName":"instanceType" }, "Kernel":{ "shape":"AttributeValue", "documentation":"

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", "locationName":"kernel" }, "Ramdisk":{ "shape":"AttributeValue", "documentation":"

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", "locationName":"ramdisk" }, "UserData":{ "shape":"BlobAttributeValue", "documentation":"

Changes the instance's user data to the specified value.

", "locationName":"userData" }, "InstanceInitiatedShutdownBehavior":{ "shape":"AttributeValue", "documentation":"

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "Groups":{ "shape":"GroupIdStringList", "documentation":"

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

", "locationName":"GroupId" }, "EbsOptimized":{ "shape":"AttributeBooleanValue", "documentation":"

Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"AttributeValue", "documentation":"

Set to simple to enable enhanced networking for the instance.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", "locationName":"sriovNetSupport" } } }, "ModifyNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the network interface.

", "locationName":"description" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", "locationName":"SecurityGroupId" }, "Attachment":{ "shape":"NetworkInterfaceAttachmentChanges", "documentation":"

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

", "locationName":"attachment" } } }, "ModifyReservedInstancesRequest":{ "type":"structure", "required":[ "ReservedInstancesIds", "TargetConfigurations" ], "members":{ "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" }, "ReservedInstancesIds":{ "shape":"ReservedInstancesIdStringList", "documentation":"

The IDs of the Reserved Instances to modify.

", "locationName":"ReservedInstancesId" }, "TargetConfigurations":{ "shape":"ReservedInstancesConfigurationList", "documentation":"

The configuration settings for the Reserved Instances to modify.

", "locationName":"ReservedInstancesConfigurationSetItemType" } } }, "ModifyReservedInstancesResult":{ "type":"structure", "members":{ "ReservedInstancesModificationId":{ "shape":"String", "documentation":"

The ID for the modification.

", "locationName":"reservedInstancesModificationId" } } }, "ModifySnapshotAttributeRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The snapshot attribute to modify.

" }, "OperationType":{ "shape":"String", "documentation":"

The type of operation to perform to the attribute.

" }, "UserIds":{ "shape":"UserIdStringList", "documentation":"

The account ID to modify for the snapshot.

", "locationName":"UserId" }, "GroupNames":{ "shape":"GroupNameStringList", "documentation":"

The group to modify for the snapshot.

", "locationName":"UserGroup" }, "CreateVolumePermission":{ "shape":"CreateVolumePermissionModifications", "documentation":"

A JSON representation of the snapshot attribute modification.

" } } }, "ModifySubnetAttributeRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "MapPublicIpOnLaunch":{ "shape":"AttributeBooleanValue", "documentation":"

Specify true to indicate that instances launched into the specified subnet should be assigned public IP address.

" } } }, "ModifyVolumeAttributeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "AutoEnableIO":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the volume should be auto-enabled for I/O operations.

" } } }, "ModifyVpcAttributeRequest":{ "type":"structure", "required":["VpcId"], "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "EnableDnsSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

" }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You can only enable DNS hostnames if you also enable DNS support.

" } } }, "MonitorInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } } }, "MonitorInstancesResult":{ "type":"structure", "members":{ "InstanceMonitorings":{ "shape":"InstanceMonitoringList", "documentation":"

Monitoring information for one or more instances.

", "locationName":"instancesSet" } } }, "Monitoring":{ "type":"structure", "members":{ "State":{ "shape":"MonitoringState", "documentation":"

Indicates whether monitoring is enabled for the instance.

", "locationName":"state" } }, "documentation":"

Describes the monitoring for the instance.

" }, "MonitoringState":{ "type":"string", "enum":[ "disabled", "disabling", "enabled", "pending" ] }, "NetworkAcl":{ "type":"structure", "members":{ "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for the network ACL.

", "locationName":"vpcId" }, "IsDefault":{ "shape":"Boolean", "documentation":"

Indicates whether this is the default network ACL for the VPC.

", "locationName":"default" }, "Entries":{ "shape":"NetworkAclEntryList", "documentation":"

One or more entries (rules) in the network ACL.

", "locationName":"entrySet" }, "Associations":{ "shape":"NetworkAclAssociationList", "documentation":"

Any associations between the network ACL and one or more subnets

", "locationName":"associationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the network ACL.

", "locationName":"tagSet" } }, "documentation":"

Describes a network ACL.

" }, "NetworkAclAssociation":{ "type":"structure", "members":{ "NetworkAclAssociationId":{ "shape":"String", "documentation":"

The ID of the association between a network ACL and a subnet.

", "locationName":"networkAclAssociationId" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" } }, "documentation":"

Describes an association between a network ACL and a subnet.

" }, "NetworkAclAssociationList":{ "type":"list", "member":{ "shape":"NetworkAclAssociation", "locationName":"item" } }, "NetworkAclEntry":{ "type":"structure", "members":{ "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The protocol. A value of -1 means all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation.

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code.

", "locationName":"icmpTypeCode" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", "locationName":"portRange" } }, "documentation":"

Describes an entry in a network ACL.

" }, "NetworkAclEntryList":{ "type":"list", "member":{ "shape":"NetworkAclEntry", "locationName":"item" } }, "NetworkAclList":{ "type":"list", "member":{ "shape":"NetworkAcl", "locationName":"item" } }, "NetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "Description":{ "shape":"String", "documentation":"

A description.

", "locationName":"description" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the network interface.

", "locationName":"ownerId" }, "RequesterId":{ "shape":"String", "documentation":"

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", "locationName":"requesterId" }, "RequesterManaged":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is being managed by AWS.

", "locationName":"requesterManaged" }, "Status":{ "shape":"NetworkInterfaceStatus", "documentation":"

The status of the network interface.

", "locationName":"status" }, "MacAddress":{ "shape":"String", "documentation":"

The MAC address.

", "locationName":"macAddress" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Indicates whether traffic to or from the instance is validated.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

Any security groups for the network interface.

", "locationName":"groupSet" }, "Attachment":{ "shape":"NetworkInterfaceAttachment", "documentation":"

The network interface attachment.

", "locationName":"attachment" }, "Association":{ "shape":"NetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP associated with the network interface.

", "locationName":"association" }, "TagSet":{ "shape":"TagList", "documentation":"

Any tags assigned to the network interface.

", "locationName":"tagSet" }, "PrivateIpAddresses":{ "shape":"NetworkInterfacePrivateIpAddressList", "documentation":"

The private IP addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" } }, "documentation":"

Describes a network interface.

" }, "NetworkInterfaceAssociation":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The address of the Elastic IP address bound to the network interface.

", "locationName":"publicIp" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name.

", "locationName":"publicDnsName" }, "IpOwnerId":{ "shape":"String", "documentation":"

The ID of the Elastic IP address owner.

", "locationName":"ipOwnerId" }, "AllocationId":{ "shape":"String", "documentation":"

The allocation ID.

", "locationName":"allocationId" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID.

", "locationName":"associationId" } }, "documentation":"

Describes association information for an Elastic IP address.

" }, "NetworkInterfaceAttachment":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "InstanceOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the instance.

", "locationName":"instanceOwnerId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The device index of the network interface attachment on the instance.

", "locationName":"deviceIndex" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The timestamp indicating when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a network interface attachment.

" }, "NetworkInterfaceAttachmentChanges":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes an attachment change.

" }, "NetworkInterfaceAttribute":{ "type":"string", "enum":[ "description", "groupSet", "sourceDestCheck", "attachment" ] }, "NetworkInterfaceIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "NetworkInterfaceList":{ "type":"list", "member":{ "shape":"NetworkInterface", "locationName":"item" } }, "NetworkInterfacePrivateIpAddress":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", "locationName":"primary" }, "Association":{ "shape":"NetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address associated with the network interface.

", "locationName":"association" } }, "documentation":"

Describes the private IP address of a network interface.

" }, "NetworkInterfacePrivateIpAddressList":{ "type":"list", "member":{ "shape":"NetworkInterfacePrivateIpAddress", "locationName":"item" } }, "NetworkInterfaceStatus":{ "type":"string", "enum":[ "available", "attaching", "in-use", "detaching" ] }, "OfferingTypeValues":{ "type":"string", "enum":[ "Heavy Utilization", "Medium Utilization", "Light Utilization", "No Upfront", "Partial Upfront", "All Upfront" ] }, "OwnerStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"Owner" } }, "PermissionGroup":{ "type":"string", "enum":["all"] }, "Placement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the instance.

", "locationName":"availabilityZone" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group the instance is in (for cluster compute instances).

", "locationName":"groupName" }, "Tenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

", "locationName":"tenancy" } }, "documentation":"

Describes the placement for the instance.

" }, "PlacementGroup":{ "type":"structure", "members":{ "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"

The placement strategy.

", "locationName":"strategy" }, "State":{ "shape":"PlacementGroupState", "documentation":"

The state of the placement group.

", "locationName":"state" } }, "documentation":"

Describes a placement group.

" }, "PlacementGroupList":{ "type":"list", "member":{ "shape":"PlacementGroup", "locationName":"item" } }, "PlacementGroupState":{ "type":"string", "enum":[ "pending", "available", "deleting", "deleted" ] }, "PlacementGroupStringList":{ "type":"list", "member":{"shape":"String"} }, "PlacementStrategy":{ "type":"string", "enum":["cluster"] }, "PlatformValues":{ "type":"string", "enum":["Windows"] }, "PortRange":{ "type":"structure", "members":{ "From":{ "shape":"Integer", "documentation":"

The first port in the range.

", "locationName":"from" }, "To":{ "shape":"Integer", "documentation":"

The last port in the range.

", "locationName":"to" } }, "documentation":"

Describes a range of ports.

" }, "PriceSchedule":{ "type":"structure", "members":{ "Term":{ "shape":"Long", "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"

The fixed price for the term.

", "locationName":"price" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "Active":{ "shape":"Boolean", "documentation":"

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", "locationName":"active" } }, "documentation":"

Describes the price for a Reserved Instance.

" }, "PriceScheduleList":{ "type":"list", "member":{ "shape":"PriceSchedule", "locationName":"item" } }, "PriceScheduleSpecification":{ "type":"structure", "members":{ "Term":{ "shape":"Long", "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"

The fixed price for the term.

", "locationName":"price" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } }, "documentation":"

Describes the price for a Reserved Instance.

" }, "PriceScheduleSpecificationList":{ "type":"list", "member":{ "shape":"PriceScheduleSpecification", "locationName":"item" } }, "PricingDetail":{ "type":"structure", "members":{ "Price":{ "shape":"Double", "documentation":"

The price per instance.

", "locationName":"price" }, "Count":{ "shape":"Integer", "documentation":"

The number of instances available for the price.

", "locationName":"count" } }, "documentation":"

Describes a Reserved Instance offering.

" }, "PricingDetailsList":{ "type":"list", "member":{ "shape":"PricingDetail", "locationName":"item" } }, "PrivateIpAddressSpecification":{ "type":"structure", "required":["PrivateIpAddress"], "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP addresses.

", "locationName":"privateIpAddress" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

", "locationName":"primary" } }, "documentation":"

Describes a secondary private IP address for a network interface.

" }, "PrivateIpAddressSpecificationList":{ "type":"list", "member":{ "shape":"PrivateIpAddressSpecification", "locationName":"item" } }, "PrivateIpAddressStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"PrivateIpAddress" } }, "ProductCode":{ "type":"structure", "members":{ "ProductCodeId":{ "shape":"String", "documentation":"

The product code.

", "locationName":"productCode" }, "ProductCodeType":{ "shape":"ProductCodeValues", "documentation":"

The type of product code.

", "locationName":"type" } }, "documentation":"

Describes a product code.

" }, "ProductCodeList":{ "type":"list", "member":{ "shape":"ProductCode", "locationName":"item" } }, "ProductCodeStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ProductCode" } }, "ProductCodeValues":{ "type":"string", "enum":[ "devpay", "marketplace" ] }, "ProductDescriptionList":{ "type":"list", "member":{"shape":"String"} }, "PropagatingVgw":{ "type":"structure", "members":{ "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway (VGW).

", "locationName":"gatewayId" } }, "documentation":"

Describes a virtual private gateway propagating route.

" }, "PropagatingVgwList":{ "type":"list", "member":{ "shape":"PropagatingVgw", "locationName":"item" } }, "PublicIpStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"PublicIp" } }, "PurchaseReservedInstancesOfferingRequest":{ "type":"structure", "required":[ "ReservedInstancesOfferingId", "InstanceCount" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance offering to purchase.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of Reserved Instances to purchase.

" }, "LimitPrice":{ "shape":"ReservedInstanceLimitPrice", "documentation":"

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", "locationName":"limitPrice" } } }, "PurchaseReservedInstancesOfferingResult":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The IDs of the purchased Reserved Instances.

", "locationName":"reservedInstancesId" } } }, "RIProductDescription":{ "type":"string", "enum":[ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ] }, "ReasonCodesList":{ "type":"list", "member":{ "shape":"ReportInstanceReasonCodes", "locationName":"item" } }, "RebootInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } } }, "RecurringCharge":{ "type":"structure", "members":{ "Frequency":{ "shape":"RecurringChargeFrequency", "documentation":"

The frequency of the recurring charge.

", "locationName":"frequency" }, "Amount":{ "shape":"Double", "documentation":"

The amount of the recurring charge.

", "locationName":"amount" } }, "documentation":"

Describes a recurring charge.

" }, "RecurringChargeFrequency":{ "type":"string", "enum":["Hourly"] }, "RecurringChargesList":{ "type":"list", "member":{ "shape":"RecurringCharge", "locationName":"item" } }, "Region":{ "type":"structure", "members":{ "RegionName":{ "shape":"String", "documentation":"

The name of the region.

", "locationName":"regionName" }, "Endpoint":{ "shape":"String", "documentation":"

The region service endpoint.

", "locationName":"regionEndpoint" } }, "documentation":"

Describes a region.

" }, "RegionList":{ "type":"list", "member":{ "shape":"Region", "locationName":"item" } }, "RegionNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"RegionName" } }, "RegisterImageRequest":{ "type":"structure", "required":["Name"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageLocation":{ "shape":"String", "documentation":"

The full path to your AMI manifest in Amazon S3 storage.

" }, "Name":{ "shape":"String", "documentation":"

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

A description for your AMI.

", "locationName":"description" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

", "locationName":"architecture" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "RootDeviceName":{ "shape":"String", "documentation":"

The name of the root device (for example, /dev/sda1, or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

One or more block device mapping entries.

", "locationName":"BlockDeviceMapping" }, "VirtualizationType":{ "shape":"String", "documentation":"

The type of virtualization.

Default: paravirtual

", "locationName":"virtualizationType" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Set to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", "locationName":"sriovNetSupport" } } }, "RegisterImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the newly registered AMI.

", "locationName":"imageId" } } }, "RejectVpcPeeringConnectionRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "RejectVpcPeeringConnectionResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "ReleaseAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" } } }, "ReplaceNetworkAclAssociationRequest":{ "type":"structure", "required":[ "AssociationId", "NetworkAclId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The ID of the current association between the original network ACL and the subnet.

", "locationName":"associationId" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the new network ACL to associate with the subnet.

", "locationName":"networkAclId" } } }, "ReplaceNetworkAclAssociationResult":{ "type":"structure", "members":{ "NewAssociationId":{ "shape":"String", "documentation":"

The ID of the new association.

", "locationName":"newAssociationId" } } }, "ReplaceNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Protocol", "RuleAction", "Egress", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number of the entry to replace.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The IP protocol. You can specify all or -1 to mean all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation.

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.

", "locationName":"Icmp" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.

", "locationName":"portRange" } } }, "ReplaceRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of an Internet gateway or virtual private gateway.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC.

", "locationName":"instanceId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of a network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of a VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "ReplaceRouteTableAssociationRequest":{ "type":"structure", "required":[ "AssociationId", "RouteTableId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID.

", "locationName":"associationId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the new route table to associate with the subnet.

", "locationName":"routeTableId" } } }, "ReplaceRouteTableAssociationResult":{ "type":"structure", "members":{ "NewAssociationId":{ "shape":"String", "documentation":"

The ID of the new association.

", "locationName":"newAssociationId" } } }, "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" ] }, "ReportInstanceStatusRequest":{ "type":"structure", "required":[ "Instances", "Status", "ReasonCodes" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Instances":{ "shape":"InstanceIdStringList", "documentation":"

One or more instances.

", "locationName":"instanceId" }, "Status":{ "shape":"ReportStatusType", "documentation":"

The status of all instances listed.

", "locationName":"status" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time at which the reported instance health state began.

", "locationName":"startTime" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time at which the reported instance health state ended.

", "locationName":"endTime" }, "ReasonCodes":{ "shape":"ReasonCodesList", "documentation":"

One or more reason codes that describes the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems which I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

", "locationName":"reasonCode" }, "Description":{ "shape":"String", "documentation":"

Descriptive text about the health state of your instance.

", "locationName":"description" } } }, "ReportStatusType":{ "type":"string", "enum":[ "ok", "impaired" ] }, "RequestSpotInstancesRequest":{ "type":"structure", "required":["SpotPrice"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

", "locationName":"spotPrice" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The maximum number of Spot Instances to launch.

Default: 1

", "locationName":"instanceCount" }, "Type":{ "shape":"SpotInstanceType", "documentation":"

The Spot Instance request type.

Default: one-time

", "locationName":"type" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

Default: The request is effective indefinitely.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

Default: The request is effective indefinitely.

", "locationName":"validUntil" }, "LaunchGroup":{ "shape":"String", "documentation":"

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

", "locationName":"launchGroup" }, "AvailabilityZoneGroup":{ "shape":"String", "documentation":"

The user-specified name for a logical grouping of bids.

When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", "locationName":"availabilityZoneGroup" }, "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} } }, "RequestSpotInstancesResult":{ "type":"structure", "members":{ "SpotInstanceRequests":{ "shape":"SpotInstanceRequestList", "documentation":"

One or more Spot Instance requests.

", "locationName":"spotInstanceRequestSet" } } }, "Reservation":{ "type":"structure", "members":{ "ReservationId":{ "shape":"String", "documentation":"

The ID of the reservation.

", "locationName":"reservationId" }, "OwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that owns the reservation.

", "locationName":"ownerId" }, "RequesterId":{ "shape":"String", "documentation":"

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

", "locationName":"requesterId" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups.

", "locationName":"groupSet" }, "Instances":{ "shape":"InstanceList", "documentation":"

One or more instances.

", "locationName":"instancesSet" } }, "documentation":"

Describes a reservation.

" }, "ReservationList":{ "type":"list", "member":{ "shape":"Reservation", "locationName":"item" } }, "ReservedInstanceLimitPrice":{ "type":"structure", "members":{ "Amount":{ "shape":"Double", "documentation":"

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", "locationName":"amount" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } }, "documentation":"

Describes the limit price of a Reserved Instance offering.

" }, "ReservedInstanceState":{ "type":"string", "enum":[ "payment-pending", "active", "payment-failed", "retired" ] }, "ReservedInstances":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used.

", "locationName":"instanceType" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", "locationName":"availabilityZone" }, "Start":{ "shape":"DateTime", "documentation":"

The date and time the Reserved Instance started.

", "locationName":"start" }, "End":{ "shape":"DateTime", "documentation":"

The time when the Reserved Instance expires.

", "locationName":"end" }, "Duration":{ "shape":"Long", "documentation":"

The duration of the Reserved Instance, in seconds.

", "locationName":"duration" }, "UsagePrice":{ "shape":"Float", "documentation":"

The usage price of the Reserved Instance, per hour.

", "locationName":"usagePrice" }, "FixedPrice":{ "shape":"Float", "documentation":"

The purchase price of the Reserved Instance.

", "locationName":"fixedPrice" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of Reserved Instances purchased.

", "locationName":"instanceCount" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance description.

", "locationName":"productDescription" }, "State":{ "shape":"ReservedInstanceState", "documentation":"

The state of the Reserved Instance purchase.

", "locationName":"state" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the reserved instance.

", "locationName":"instanceTenancy" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type.

", "locationName":"offeringType" }, "RecurringCharges":{ "shape":"RecurringChargesList", "documentation":"

The recurring charge tag assigned to the resource.

", "locationName":"recurringCharges" } }, "documentation":"

Describes a Reserved Instance.

" }, "ReservedInstancesConfiguration":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the modified Reserved Instances.

", "locationName":"availabilityZone" }, "Platform":{ "shape":"String", "documentation":"

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", "locationName":"platform" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of modified Reserved Instances.

", "locationName":"instanceCount" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type for the modified Reserved Instances.

", "locationName":"instanceType" } }, "documentation":"

Describes the configuration settings for the modified Reserved Instances.

" }, "ReservedInstancesConfigurationList":{ "type":"list", "member":{ "shape":"ReservedInstancesConfiguration", "locationName":"item" } }, "ReservedInstancesId":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" } }, "documentation":"

Describes the ID of a Reserved Instance.

" }, "ReservedInstancesIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstancesId" } }, "ReservedInstancesList":{ "type":"list", "member":{ "shape":"ReservedInstances", "locationName":"item" } }, "ReservedInstancesListing":{ "type":"structure", "members":{ "ReservedInstancesListingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance listing.

", "locationName":"reservedInstancesListingId" }, "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The time the listing was created.

", "locationName":"createDate" }, "UpdateDate":{ "shape":"DateTime", "documentation":"

The last modified timestamp of the listing.

", "locationName":"updateDate" }, "Status":{ "shape":"ListingStatus", "documentation":"

The status of the Reserved Instance listing.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The reason for the current status of the Reserved Instance listing. The response can be blank.

", "locationName":"statusMessage" }, "InstanceCounts":{ "shape":"InstanceCountList", "documentation":"

The number of instances in this state.

", "locationName":"instanceCounts" }, "PriceSchedules":{ "shape":"PriceScheduleList", "documentation":"

The price of the Reserved Instance listing.

", "locationName":"priceSchedules" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Describes a Reserved Instance listing.

" }, "ReservedInstancesListingList":{ "type":"list", "member":{ "shape":"ReservedInstancesListing", "locationName":"item" } }, "ReservedInstancesModification":{ "type":"structure", "members":{ "ReservedInstancesModificationId":{ "shape":"String", "documentation":"

A unique ID for the Reserved Instance modification.

", "locationName":"reservedInstancesModificationId" }, "ReservedInstancesIds":{ "shape":"ReservedIntancesIds", "documentation":"

The IDs of one or more Reserved Instances.

", "locationName":"reservedInstancesSet" }, "ModificationResults":{ "shape":"ReservedInstancesModificationResultList", "documentation":"

Contains target configurations along with their corresponding new Reserved Instance IDs.

", "locationName":"modificationResultSet" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The time when the modification request was created.

", "locationName":"createDate" }, "UpdateDate":{ "shape":"DateTime", "documentation":"

The time when the modification request was last updated.

", "locationName":"updateDate" }, "EffectiveDate":{ "shape":"DateTime", "documentation":"

The time for the modification to become effective.

", "locationName":"effectiveDate" }, "Status":{ "shape":"String", "documentation":"

The status of the Reserved Instances modification request.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The reason for the status.

", "locationName":"statusMessage" }, "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Describes a Reserved Instance modification.

" }, "ReservedInstancesModificationIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstancesModificationId" } }, "ReservedInstancesModificationList":{ "type":"list", "member":{ "shape":"ReservedInstancesModification", "locationName":"item" } }, "ReservedInstancesModificationResult":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", "locationName":"reservedInstancesId" }, "TargetConfiguration":{ "shape":"ReservedInstancesConfiguration", "documentation":"

The target Reserved Instances configurations supplied as part of the modification request.

", "locationName":"targetConfiguration" } } }, "ReservedInstancesModificationResultList":{ "type":"list", "member":{ "shape":"ReservedInstancesModificationResult", "locationName":"item" } }, "ReservedInstancesOffering":{ "type":"structure", "members":{ "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance offering.

", "locationName":"reservedInstancesOfferingId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used.

", "locationName":"instanceType" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", "locationName":"availabilityZone" }, "Duration":{ "shape":"Long", "documentation":"

The duration of the Reserved Instance, in seconds.

", "locationName":"duration" }, "UsagePrice":{ "shape":"Float", "documentation":"

The usage price of the Reserved Instance, per hour.

", "locationName":"usagePrice" }, "FixedPrice":{ "shape":"Float", "documentation":"

The purchase price of the Reserved Instance.

", "locationName":"fixedPrice" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance description.

", "locationName":"productDescription" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the reserved instance.

", "locationName":"instanceTenancy" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type.

", "locationName":"offeringType" }, "RecurringCharges":{ "shape":"RecurringChargesList", "documentation":"

The recurring charge tag assigned to the resource.

", "locationName":"recurringCharges" }, "Marketplace":{ "shape":"Boolean", "documentation":"

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

", "locationName":"marketplace" }, "PricingDetails":{ "shape":"PricingDetailsList", "documentation":"

The pricing details of the Reserved Instance offering.

", "locationName":"pricingDetailsSet" } }, "documentation":"

Describes a Reserved Instance offering.

" }, "ReservedInstancesOfferingIdStringList":{ "type":"list", "member":{"shape":"String"} }, "ReservedInstancesOfferingList":{ "type":"list", "member":{ "shape":"ReservedInstancesOffering", "locationName":"item" } }, "ReservedIntancesIds":{ "type":"list", "member":{ "shape":"ReservedInstancesId", "locationName":"item" } }, "ResetImageAttributeName":{ "type":"string", "enum":["launchPermission"] }, "ResetImageAttributeRequest":{ "type":"structure", "required":[ "ImageId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"ResetImageAttributeName", "documentation":"

The attribute to reset (currently you can only reset the launch permission attribute).

" } } }, "ResetInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The attribute to reset.

", "locationName":"attribute" } } }, "ResetNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SourceDestCheck":{ "shape":"String", "documentation":"

The source/destination checking attribute. Resets the value to true.

", "locationName":"sourceDestCheck" } } }, "ResetSnapshotAttributeRequest":{ "type":"structure", "required":[ "SnapshotId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The attribute to reset (currently only the attribute for permission to create volumes can be reset).

" } } }, "ResourceIdList":{ "type":"list", "member":{"shape":"String"} }, "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" ] }, "RestorableByStringList":{ "type":"list", "member":{"shape":"String"} }, "RevokeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

", "locationName":"toPort" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

", "locationName":"cidrIp" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"ipPermissions" } } }, "RevokeSecurityGroupIngressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" } } }, "Route":{ "type":"structure", "members":{ "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block used for the destination match.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of a gateway attached to your VPC.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC.

", "locationName":"instanceId" }, "InstanceOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the instance.

", "locationName":"instanceOwnerId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" }, "State":{ "shape":"RouteState", "documentation":"

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

", "locationName":"state" }, "Origin":{ "shape":"RouteOrigin", "documentation":"

Describes how the route was created.

  • CreateRouteTable indicates that route was automatically created when the route table was created.
  • CreateRoute indicates that the route was manually added to the route table.
  • EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
", "locationName":"origin" } }, "documentation":"

Describes a route in a route table.

" }, "RouteList":{ "type":"list", "member":{ "shape":"Route", "locationName":"item" } }, "RouteOrigin":{ "type":"string", "enum":[ "CreateRouteTable", "CreateRoute", "EnableVgwRoutePropagation" ] }, "RouteState":{ "type":"string", "enum":[ "active", "blackhole" ] }, "RouteTable":{ "type":"structure", "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Routes":{ "shape":"RouteList", "documentation":"

The routes in the route table.

", "locationName":"routeSet" }, "Associations":{ "shape":"RouteTableAssociationList", "documentation":"

The associations between the route table and one or more subnets.

", "locationName":"associationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the route table.

", "locationName":"tagSet" }, "PropagatingVgws":{ "shape":"PropagatingVgwList", "documentation":"

Any virtual private gateway (VGW) propagating routes.

", "locationName":"propagatingVgwSet" } }, "documentation":"

Describes a route table.

" }, "RouteTableAssociation":{ "type":"structure", "members":{ "RouteTableAssociationId":{ "shape":"String", "documentation":"

The ID of the association between a route table and a subnet.

", "locationName":"routeTableAssociationId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "Main":{ "shape":"Boolean", "documentation":"

Indicates whether this is the main route table.

", "locationName":"main" } }, "documentation":"

Describes an association between a route table and a subnet.

" }, "RouteTableAssociationList":{ "type":"list", "member":{ "shape":"RouteTableAssociation", "locationName":"item" } }, "RouteTableList":{ "type":"list", "member":{ "shape":"RouteTable", "locationName":"item" } }, "RuleAction":{ "type":"string", "enum":[ "allow", "deny" ] }, "RunInstancesMonitoringEnabled":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Indicates whether monitoring is enabled for the instance.

", "locationName":"enabled" } }, "documentation":"

Describes the monitoring for the instance.

" }, "RunInstancesRequest":{ "type":"structure", "required":[ "ImageId", "MinCount", "MaxCount" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI, which you can get by calling DescribeImages.

" }, "MinCount":{ "shape":"Integer", "documentation":"

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" }, "MaxCount":{ "shape":"Integer", "documentation":"

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you launch an instance without specifying a key pair, you can't connect to the instance.

" }, "SecurityGroups":{ "shape":"SecurityGroupStringList", "documentation":"

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

", "locationName":"SecurityGroup" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdStringList", "documentation":"

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

", "locationName":"SecurityGroupId" }, "UserData":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data for the instances.

" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux.

Default: m1.small

" }, "Placement":{ "shape":"Placement", "documentation":"

The placement for the instance.

" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

The block device mapping.

", "locationName":"BlockDeviceMapping" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "documentation":"

The monitoring for the instance.

" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

" }, "DisableApiTermination":{ "shape":"Boolean", "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

", "locationName":"instanceInitiatedShutdownBehavior" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.

Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.

Default: We select an IP address from the IP address range of the subnet.

", "locationName":"privateIpAddress" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

", "locationName":"clientToken" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterface" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

", "locationName":"ebsOptimized" } } }, "S3Storage":{ "type":"structure", "members":{ "Bucket":{ "shape":"String", "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

The beginning of the file name of the AMI.

", "locationName":"prefix" }, "AWSAccessKeyId":{ "shape":"String", "documentation":"

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

" }, "UploadPolicy":{ "shape":"Blob", "documentation":"

A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", "locationName":"uploadPolicy" }, "UploadPolicySignature":{ "shape":"String", "documentation":"

The signature of the Base64 encoded JSON document.

", "locationName":"uploadPolicySignature" } }, "documentation":"

Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI.

" }, "SecurityGroup":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the security group.

", "locationName":"ownerId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "Description":{ "shape":"String", "documentation":"

A description of the security group.

", "locationName":"groupDescription" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

One or more inbound rules associated with the security group.

", "locationName":"ipPermissions" }, "IpPermissionsEgress":{ "shape":"IpPermissionList", "documentation":"

[EC2-VPC] One or more outbound rules associated with the security group.

", "locationName":"ipPermissionsEgress" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC for the security group.

", "locationName":"vpcId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the security group.

", "locationName":"tagSet" } }, "documentation":"

Describes a security group

" }, "SecurityGroupIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroupId" } }, "SecurityGroupList":{ "type":"list", "member":{ "shape":"SecurityGroup", "locationName":"item" } }, "SecurityGroupStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroup" } }, "ShutdownBehavior":{ "type":"string", "enum":[ "stop", "terminate" ] }, "Snapshot":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

", "locationName":"snapshotId" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "State":{ "shape":"SnapshotState", "documentation":"

The snapshot state.

", "locationName":"status" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time stamp when the snapshot was initiated.

", "locationName":"startTime" }, "Progress":{ "shape":"String", "documentation":"

The progress of the snapshot, as a percentage.

", "locationName":"progress" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the Amazon EBS snapshot owner.

", "locationName":"ownerId" }, "Description":{ "shape":"String", "documentation":"

The description for the snapshot.

", "locationName":"description" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

", "locationName":"volumeSize" }, "OwnerAlias":{ "shape":"String", "documentation":"

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

", "locationName":"ownerAlias" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the snapshot.

", "locationName":"tagSet" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the snapshot is encrypted.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the parent volume.

", "locationName":"kmsKeyId" } }, "documentation":"

Describes a snapshot.

" }, "SnapshotAttributeName":{ "type":"string", "enum":[ "productCodes", "createVolumePermission" ] }, "SnapshotDetail":{ "type":"structure", "members":{ "DiskImageSize":{ "shape":"Double", "documentation":"

The size of the disk in the snapshot.

", "locationName":"diskImageSize" }, "Description":{ "shape":"String", "documentation":"

Description for the snapshot.

", "locationName":"description" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image from which the snapshot is created.

", "locationName":"format" }, "Url":{ "shape":"String", "documentation":"

The URL used to access the disk image.

", "locationName":"url" }, "UserBucket":{ "shape":"UserBucketDetails", "locationName":"userBucket" }, "DeviceName":{ "shape":"String", "documentation":"

The Amazon EBS block device mapping for the snapshot.

", "locationName":"deviceName" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot ID of the disk being imported.

", "locationName":"snapshotId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of progress for the task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message for the snapshot creation.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status of the snapshot creation.

", "locationName":"status" } }, "documentation":"

The details of the snapshot created from the imported disk.

" }, "SnapshotDetailList":{ "type":"list", "member":{ "shape":"SnapshotDetail", "locationName":"item" } }, "SnapshotDiskContainer":{ "type":"structure", "members":{ "Description":{ "shape":"String", "documentation":"

The description of the disk image being imported.

" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image being imported.

" }, "Url":{ "shape":"String", "documentation":"

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).

" }, "UserBucket":{"shape":"UserBucket"} }, "documentation":"

The disk container object for the ImportSnapshot request.

" }, "SnapshotIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SnapshotId" } }, "SnapshotList":{ "type":"list", "member":{ "shape":"Snapshot", "locationName":"item" } }, "SnapshotState":{ "type":"string", "enum":[ "pending", "completed", "error" ] }, "SnapshotTaskDetail":{ "type":"structure", "members":{ "DiskImageSize":{ "shape":"Double", "documentation":"

The size of the disk in the snapshot.

", "locationName":"diskImageSize" }, "Description":{ "shape":"String", "documentation":"

The description of the snapshot.

", "locationName":"description" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image from which the snapshot is created.

", "locationName":"format" }, "Url":{ "shape":"String", "documentation":"

The URL of the disk image from which the snapshot is created.

", "locationName":"url" }, "UserBucket":{ "shape":"UserBucketDetails", "locationName":"userBucket" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot ID of the disk being imported.

", "locationName":"snapshotId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of completion for the ImportSnapshot task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message for the ImportSnapshot task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status for the ImportSnapshot task.

", "locationName":"status" } }, "documentation":"

Details about the import snapshot task.

" }, "SpotDatafeedSubscription":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the account.

", "locationName":"ownerId" }, "Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket where the Spot Instance data feed is located.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

The prefix that is prepended to data feed files.

", "locationName":"prefix" }, "State":{ "shape":"DatafeedSubscriptionState", "documentation":"

The state of the Spot Instance data feed subscription.

", "locationName":"state" }, "Fault":{ "shape":"SpotInstanceStateFault", "documentation":"

The fault codes for the Spot Instance request, if any.

", "locationName":"fault" } }, "documentation":"

Describes the data feed for a Spot Instance.

" }, "SpotInstanceRequest":{ "type":"structure", "members":{ "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot Instance request.

", "locationName":"spotInstanceRequestId" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

", "locationName":"spotPrice" }, "Type":{ "shape":"SpotInstanceType", "documentation":"

The Spot Instance request type.

", "locationName":"type" }, "State":{ "shape":"SpotInstanceState", "documentation":"

The state of the Spot Instance request. Spot bid status information can help you track your Spot Instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide for Linux.

", "locationName":"state" }, "Fault":{ "shape":"SpotInstanceStateFault", "documentation":"

The fault codes for the Spot Instance request, if any.

", "locationName":"fault" }, "Status":{ "shape":"SpotInstanceStatus", "documentation":"

The status code and status message describing the Spot Instance request.

", "locationName":"status" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.

", "locationName":"validUntil" }, "LaunchGroup":{ "shape":"String", "documentation":"

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

", "locationName":"launchGroup" }, "AvailabilityZoneGroup":{ "shape":"String", "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.

", "locationName":"availabilityZoneGroup" }, "LaunchSpecification":{ "shape":"LaunchSpecification", "documentation":"

Additional information for launching instances.

", "locationName":"launchSpecification" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID, if an instance has been launched to fulfill the Spot Instance request.

", "locationName":"instanceId" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The time stamp when the Spot Instance request was created.

", "locationName":"createTime" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The product description associated with the Spot Instance.

", "locationName":"productDescription" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "LaunchedAvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the bid is launched.

", "locationName":"launchedAvailabilityZone" } }, "documentation":"

Describe a Spot Instance request.

" }, "SpotInstanceRequestIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"SpotInstanceRequestId" } }, "SpotInstanceRequestList":{ "type":"list", "member":{ "shape":"SpotInstanceRequest", "locationName":"item" } }, "SpotInstanceState":{ "type":"string", "enum":[ "open", "active", "closed", "cancelled", "failed" ] }, "SpotInstanceStateFault":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The reason code for the Spot Instance state change.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The message for the Spot Instance state change.

", "locationName":"message" } }, "documentation":"

Describes a Spot Instance state change.

" }, "SpotInstanceStatus":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The status code.

", "locationName":"code" }, "UpdateTime":{ "shape":"DateTime", "documentation":"

The time of the most recent status update.

", "locationName":"updateTime" }, "Message":{ "shape":"String", "documentation":"

The description for the status code.

", "locationName":"message" } }, "documentation":"

Describes the status of a Spot Instance request.

" }, "SpotInstanceType":{ "type":"string", "enum":[ "one-time", "persistent" ] }, "SpotPlacement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group (for cluster instances).

", "locationName":"groupName" } }, "documentation":"

Describes Spot Instance placement.

" }, "SpotPrice":{ "type":"structure", "members":{ "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

A general description of the AMI.

", "locationName":"productDescription" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum price (bid) that you are willing to pay for a Spot Instance.

", "locationName":"spotPrice" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The date and time the request was created.

", "locationName":"timestamp" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" } }, "documentation":"

Describes the maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

" }, "SpotPriceHistoryList":{ "type":"list", "member":{ "shape":"SpotPrice", "locationName":"item" } }, "StartInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "DryRun":{ "shape":"Boolean", "locationName":"dryRun" } } }, "StartInstancesResult":{ "type":"structure", "members":{ "StartingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more started instances.

", "locationName":"instancesSet" } } }, "StateReason":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The reason code for the state change.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The message for the state change.

  • Server.SpotInstanceTermination: A Spot Instance was terminated due to an increase in the market price.

  • Server.InternalError: An internal error occurred during instance launch, resulting in termination.

  • Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

  • Client.InternalError: A client error caused the instance to terminate on launch.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The volume limit was exceeded.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

", "locationName":"message" } }, "documentation":"

Describes a state change.

" }, "StatusName":{ "type":"string", "enum":["reachability"] }, "StatusType":{ "type":"string", "enum":[ "passed", "failed", "insufficient-data" ] }, "StopInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" }, "Force":{ "shape":"Boolean", "documentation":"

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

", "locationName":"force" } } }, "StopInstancesResult":{ "type":"structure", "members":{ "StoppingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more stopped instances.

", "locationName":"instancesSet" } } }, "Storage":{ "type":"structure", "members":{ "S3":{ "shape":"S3Storage", "documentation":"

An Amazon S3 storage location.

" } }, "documentation":"

Describes the storage location for an instance store-backed AMI.

" }, "String":{"type":"string"}, "Subnet":{ "type":"structure", "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "State":{ "shape":"SubnetState", "documentation":"

The current state of the subnet.

", "locationName":"state" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC the subnet is in.

", "locationName":"vpcId" }, "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block assigned to the subnet.

", "locationName":"cidrBlock" }, "AvailableIpAddressCount":{ "shape":"Integer", "documentation":"

The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.

", "locationName":"availableIpAddressCount" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the subnet.

", "locationName":"availabilityZone" }, "DefaultForAz":{ "shape":"Boolean", "documentation":"

Indicates whether this is the default subnet for the Availability Zone.

", "locationName":"defaultForAz" }, "MapPublicIpOnLaunch":{ "shape":"Boolean", "documentation":"

Indicates whether instances launched in this subnet receive a public IP address.

", "locationName":"mapPublicIpOnLaunch" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the subnet.

", "locationName":"tagSet" } }, "documentation":"

Describes a subnet.

" }, "SubnetIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SubnetId" } }, "SubnetList":{ "type":"list", "member":{ "shape":"Subnet", "locationName":"item" } }, "SubnetState":{ "type":"string", "enum":[ "pending", "available" ] }, "SummaryStatus":{ "type":"string", "enum":[ "ok", "impaired", "insufficient-data", "not-applicable" ] }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", "locationName":"value" } }, "documentation":"

Describes a tag.

" }, "TagDescription":{ "type":"structure", "members":{ "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource. For example, ami-1a2b3c4d.

", "locationName":"resourceId" }, "ResourceType":{ "shape":"ResourceType", "documentation":"

The resource type.

", "locationName":"resourceType" }, "Key":{ "shape":"String", "documentation":"

The tag key.

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The tag value.

", "locationName":"value" } }, "documentation":"

Describes a tag.

" }, "TagDescriptionList":{ "type":"list", "member":{ "shape":"TagDescription", "locationName":"item" } }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"item" } }, "TelemetryStatus":{ "type":"string", "enum":[ "UP", "DOWN" ] }, "Tenancy":{ "type":"string", "enum":[ "default", "dedicated" ] }, "TerminateInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } } }, "TerminateInstancesResult":{ "type":"structure", "members":{ "TerminatingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more terminated instances.

", "locationName":"instancesSet" } } }, "UnassignPrivateIpAddressesRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "PrivateIpAddresses" ], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", "documentation":"

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

", "locationName":"privateIpAddress" } } }, "UnmonitorInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } } }, "UnmonitorInstancesResult":{ "type":"structure", "members":{ "InstanceMonitorings":{ "shape":"InstanceMonitoringList", "documentation":"

Monitoring information for one or more instances.

", "locationName":"instancesSet" } } }, "UserBucket":{ "type":"structure", "members":{ "S3Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket name where the disk image is located.

" }, "S3Key":{ "shape":"String", "documentation":"

The Amazon S3 Key for the disk image.

" } }, "documentation":"

User's Amazon S3 bucket details used to access the image.

" }, "UserBucketDetails":{ "type":"structure", "members":{ "S3Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket from which the disk image was created.

", "locationName":"s3Bucket" }, "S3Key":{ "shape":"String", "documentation":"

The Amazon S3 key from which the disk image was created.

", "locationName":"s3Key" } }, "documentation":"

User's Amazon S3 bucket details used to access the image.

" }, "UserData":{ "type":"structure", "members":{ "Data":{ "shape":"String", "locationName":"data" } } }, "UserGroupStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"UserGroup" } }, "UserIdGroupPair":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The ID of an AWS account. EC2-Classic only.

", "locationName":"userId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use GroupId.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } }, "documentation":"

Describes a security group and AWS account ID pair.

" }, "UserIdGroupPairList":{ "type":"list", "member":{ "shape":"UserIdGroupPair", "locationName":"item" } }, "UserIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"UserId" } }, "ValueStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "VgwTelemetry":{ "type":"structure", "members":{ "OutsideIpAddress":{ "shape":"String", "documentation":"

The Internet-routable IP address of the virtual private gateway's outside interface.

", "locationName":"outsideIpAddress" }, "Status":{ "shape":"TelemetryStatus", "documentation":"

The status of the VPN tunnel.

", "locationName":"status" }, "LastStatusChange":{ "shape":"DateTime", "documentation":"

The date and time of the last change in status.

", "locationName":"lastStatusChange" }, "StatusMessage":{ "shape":"String", "documentation":"

If an error occurs, a description of the error.

", "locationName":"statusMessage" }, "AcceptedRouteCount":{ "shape":"Integer", "documentation":"

The number of accepted routes.

", "locationName":"acceptedRouteCount" } }, "documentation":"

Describes telemetry for a VPN tunnel.

" }, "VgwTelemetryList":{ "type":"list", "member":{ "shape":"VgwTelemetry", "locationName":"item" } }, "VirtualizationType":{ "type":"string", "enum":[ "hvm", "paravirtual" ] }, "Volume":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "Size":{ "shape":"Integer", "documentation":"

The size of the volume, in GiBs.

", "locationName":"size" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot from which the volume was created, if applicable.

", "locationName":"snapshotId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the volume.

", "locationName":"availabilityZone" }, "State":{ "shape":"VolumeState", "documentation":"

The volume state.

", "locationName":"status" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The time stamp when volume creation was initiated.

", "locationName":"createTime" }, "Attachments":{ "shape":"VolumeAttachmentList", "locationName":"attachmentSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the volume.

", "locationName":"tagSet" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

", "locationName":"volumeType" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide for Linux.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

", "locationName":"iops" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the volume will be encrypted.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the volume.

", "locationName":"kmsKeyId" } }, "documentation":"

Describes a volume.

" }, "VolumeAttachment":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Device":{ "shape":"String", "documentation":"

The device name.

", "locationName":"device" }, "State":{ "shape":"VolumeAttachmentState", "documentation":"

The attachment state of the volume.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the Amazon EBS volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes volume attachment details.

" }, "VolumeAttachmentList":{ "type":"list", "member":{ "shape":"VolumeAttachment", "locationName":"item" } }, "VolumeAttachmentState":{ "type":"string", "enum":[ "attaching", "attached", "detaching", "detached" ] }, "VolumeAttributeName":{ "type":"string", "enum":[ "autoEnableIO", "productCodes" ] }, "VolumeDetail":{ "type":"structure", "required":["Size"], "members":{ "Size":{ "shape":"Long", "documentation":"

The size of the volume, in GiB.

", "locationName":"size" } }, "documentation":"

Describes an Amazon EBS volume.

" }, "VolumeIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VolumeId" } }, "VolumeList":{ "type":"list", "member":{ "shape":"Volume", "locationName":"item" } }, "VolumeState":{ "type":"string", "enum":[ "creating", "available", "in-use", "deleting", "deleted", "error" ] }, "VolumeStatusAction":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The code identifying the operation, for example, enable-volume-io.

", "locationName":"code" }, "Description":{ "shape":"String", "documentation":"

A description of the operation.

", "locationName":"description" }, "EventType":{ "shape":"String", "documentation":"

The event type associated with this operation.

", "locationName":"eventType" }, "EventId":{ "shape":"String", "documentation":"

The ID of the event associated with this operation.

", "locationName":"eventId" } }, "documentation":"

Describes a volume status operation code.

" }, "VolumeStatusActionsList":{ "type":"list", "member":{ "shape":"VolumeStatusAction", "locationName":"item" } }, "VolumeStatusDetails":{ "type":"structure", "members":{ "Name":{ "shape":"VolumeStatusName", "documentation":"

The name of the volume status.

", "locationName":"name" }, "Status":{ "shape":"String", "documentation":"

The intended status of the volume status.

", "locationName":"status" } }, "documentation":"

Describes a volume status.

" }, "VolumeStatusDetailsList":{ "type":"list", "member":{ "shape":"VolumeStatusDetails", "locationName":"item" } }, "VolumeStatusEvent":{ "type":"structure", "members":{ "EventType":{ "shape":"String", "documentation":"

The type of this event.

", "locationName":"eventType" }, "Description":{ "shape":"String", "documentation":"

A description of the event.

", "locationName":"description" }, "NotBefore":{ "shape":"DateTime", "documentation":"

The earliest start time of the event.

", "locationName":"notBefore" }, "NotAfter":{ "shape":"DateTime", "documentation":"

The latest end time of the event.

", "locationName":"notAfter" }, "EventId":{ "shape":"String", "documentation":"

The ID of this event.

", "locationName":"eventId" } }, "documentation":"

Describes a volume status event.

" }, "VolumeStatusEventsList":{ "type":"list", "member":{ "shape":"VolumeStatusEvent", "locationName":"item" } }, "VolumeStatusInfo":{ "type":"structure", "members":{ "Status":{ "shape":"VolumeStatusInfoStatus", "documentation":"

The status of the volume.

", "locationName":"status" }, "Details":{ "shape":"VolumeStatusDetailsList", "documentation":"

The details of the volume status.

", "locationName":"details" } }, "documentation":"

Describes the status of a volume.

" }, "VolumeStatusInfoStatus":{ "type":"string", "enum":[ "ok", "impaired", "insufficient-data" ] }, "VolumeStatusItem":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

", "locationName":"volumeId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the volume.

", "locationName":"availabilityZone" }, "VolumeStatus":{ "shape":"VolumeStatusInfo", "documentation":"

The volume status.

", "locationName":"volumeStatus" }, "Events":{ "shape":"VolumeStatusEventsList", "documentation":"

A list of events associated with the volume.

", "locationName":"eventsSet" }, "Actions":{ "shape":"VolumeStatusActionsList", "documentation":"

The details of the operation.

", "locationName":"actionsSet" } }, "documentation":"

Describes the volume status.

" }, "VolumeStatusList":{ "type":"list", "member":{ "shape":"VolumeStatusItem", "locationName":"item" } }, "VolumeStatusName":{ "type":"string", "enum":[ "io-enabled", "io-performance" ] }, "VolumeType":{ "type":"string", "enum":[ "standard", "io1", "gp2" ] }, "Vpc":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"VpcState", "documentation":"

The current state of the VPC.

", "locationName":"state" }, "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block for the VPC.

", "locationName":"cidrBlock" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

", "locationName":"dhcpOptionsId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPC.

", "locationName":"tagSet" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The allowed tenancy of instances launched into the VPC.

", "locationName":"instanceTenancy" }, "IsDefault":{ "shape":"Boolean", "documentation":"

Indicates whether the VPC is the default VPC.

", "locationName":"isDefault" } }, "documentation":"

Describes a VPC.

" }, "VpcAttachment":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"AttachmentStatus", "documentation":"

The current state of the attachment.

", "locationName":"state" } }, "documentation":"

Describes an attachment between a virtual private gateway and a VPC.

" }, "VpcAttachmentList":{ "type":"list", "member":{ "shape":"VpcAttachment", "locationName":"item" } }, "VpcAttributeName":{ "type":"string", "enum":[ "enableDnsSupport", "enableDnsHostnames" ] }, "VpcClassicLink":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "ClassicLinkEnabled":{ "shape":"Boolean", "documentation":"

Indicates whether the VPC is enabled for ClassicLink.

", "locationName":"classicLinkEnabled" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPC.

", "locationName":"tagSet" } }, "documentation":"

Describes whether a VPC is enabled for ClassicLink.

" }, "VpcClassicLinkIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcId" } }, "VpcClassicLinkList":{ "type":"list", "member":{ "shape":"VpcClassicLink", "locationName":"item" } }, "VpcIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcId" } }, "VpcList":{ "type":"list", "member":{ "shape":"Vpc", "locationName":"item" } }, "VpcPeeringConnection":{ "type":"structure", "members":{ "AccepterVpcInfo":{ "shape":"VpcPeeringConnectionVpcInfo", "documentation":"

The information of the peer VPC.

", "locationName":"accepterVpcInfo" }, "ExpirationTime":{ "shape":"DateTime", "documentation":"

The time that an unaccepted VPC peering connection will expire.

", "locationName":"expirationTime" }, "RequesterVpcInfo":{ "shape":"VpcPeeringConnectionVpcInfo", "documentation":"

The information of the requester VPC.

", "locationName":"requesterVpcInfo" }, "Status":{ "shape":"VpcPeeringConnectionStateReason", "documentation":"

The status of the VPC peering connection.

", "locationName":"status" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Describes a VPC peering connection.

" }, "VpcPeeringConnectionList":{ "type":"list", "member":{ "shape":"VpcPeeringConnection", "locationName":"item" } }, "VpcPeeringConnectionStateReason":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The status of the VPC peering connection.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

A message that provides more information about the status, if applicable.

", "locationName":"message" } }, "documentation":"

Describes the status of a VPC peering connection.

" }, "VpcPeeringConnectionVpcInfo":{ "type":"structure", "members":{ "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block for the VPC.

", "locationName":"cidrBlock" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the VPC owner.

", "locationName":"ownerId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Describes a VPC in a VPC peering connection.

" }, "VpcState":{ "type":"string", "enum":[ "pending", "available" ] }, "VpnConnection":{ "type":"structure", "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

", "locationName":"vpnConnectionId" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the VPN connection.

", "locationName":"state" }, "CustomerGatewayConfiguration":{ "shape":"String", "documentation":"

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

", "locationName":"customerGatewayConfiguration" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection.

", "locationName":"type" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway at your end of the VPN connection.

", "locationName":"customerGatewayId" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

", "locationName":"vpnGatewayId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPN connection.

", "locationName":"tagSet" }, "VgwTelemetry":{ "shape":"VgwTelemetryList", "documentation":"

Information about the VPN tunnel.

", "locationName":"vgwTelemetry" }, "Options":{ "shape":"VpnConnectionOptions", "documentation":"

The VPN connection options.

", "locationName":"options" }, "Routes":{ "shape":"VpnStaticRouteList", "documentation":"

The static routes associated with the VPN connection.

", "locationName":"routes" } }, "documentation":"

Describes a VPN connection.

" }, "VpnConnectionIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpnConnectionId" } }, "VpnConnectionList":{ "type":"list", "member":{ "shape":"VpnConnection", "locationName":"item" } }, "VpnConnectionOptions":{ "type":"structure", "members":{ "StaticRoutesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "locationName":"staticRoutesOnly" } }, "documentation":"

Describes VPN connection options.

" }, "VpnConnectionOptionsSpecification":{ "type":"structure", "members":{ "StaticRoutesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "locationName":"staticRoutesOnly" } }, "documentation":"

Describes VPN connection options.

" }, "VpnGateway":{ "type":"structure", "members":{ "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

", "locationName":"vpnGatewayId" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the virtual private gateway.

", "locationName":"state" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection the virtual private gateway supports.

", "locationName":"type" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the virtual private gateway was created.

", "locationName":"availabilityZone" }, "VpcAttachments":{ "shape":"VpcAttachmentList", "documentation":"

Any VPCs attached to the virtual private gateway.

", "locationName":"attachments" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the virtual private gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes a virtual private gateway.

" }, "VpnGatewayIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpnGatewayId" } }, "VpnGatewayList":{ "type":"list", "member":{ "shape":"VpnGateway", "locationName":"item" } }, "VpnState":{ "type":"string", "enum":[ "pending", "available", "deleting", "deleted" ] }, "VpnStaticRoute":{ "type":"structure", "members":{ "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer data center.

", "locationName":"destinationCidrBlock" }, "Source":{ "shape":"VpnStaticRouteSource", "documentation":"

Indicates how the routes were provided.

", "locationName":"source" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the static route.

", "locationName":"state" } }, "documentation":"

Describes a static route for a VPN connection.

" }, "VpnStaticRouteList":{ "type":"list", "member":{ "shape":"VpnStaticRoute", "locationName":"item" } }, "VpnStaticRouteSource":{ "type":"string", "enum":["Static"] }, "ZoneNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ZoneName" } }, "NewDhcpConfigurationList":{ "type":"list", "member":{ "shape":"NewDhcpConfiguration", "locationName":"item" } }, "NewDhcpConfiguration":{ "type":"structure", "members":{ "Key":{ "shape":"String", "locationName":"key" }, "Values":{ "shape":"ValueStringList", "locationName":"Value" } } }, "DhcpConfigurationValueList":{ "type":"list", "member":{ "shape":"AttributeValue", "locationName":"item" } }, "Blob":{"type":"blob"}, "BlobAttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"Blob", "locationName":"value" } } }, "RequestSpotLaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"ValueStringList", "locationName":"SecurityGroup" }, "UserData":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"NetworkInterface" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" }, "SecurityGroupIds":{ "shape":"ValueStringList", "locationName":"SecurityGroupId" } }, "documentation":"

Describes the launch specification for an instance.

" } } } botocore-1.5.7/botocore/data/ec2/2016-11-15/0000777454262600001440000000000013042511307020636 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ec2/2016-11-15/examples-1.json0000777454262600001440000032713613042511306023523 0ustar pysdk-ciamazon00000000000000{ "version": "1.0", "examples": { "AllocateAddress": [ { "input": { "Domain": "vpc" }, "output": { "AllocationId": "eipalloc-64d5890a", "Domain": "vpc", "PublicIp": "203.0.113.0" }, "comments": { "input": { }, "output": { } }, "description": "This example allocates an Elastic IP address to use with an instance in a VPC.", "id": "ec2-allocate-address-1", "title": "To allocate an Elastic IP address for EC2-VPC" }, { "output": { "Domain": "standard", "PublicIp": "198.51.100.0" }, "comments": { "input": { }, "output": { } }, "description": "This example allocates an Elastic IP address to use with an instance in EC2-Classic.", "id": "ec2-allocate-address-2", "title": "To allocate an Elastic IP address for EC2-Classic" } ], "AssignPrivateIpAddresses": [ { "input": { "NetworkInterfaceId": "eni-e5aa89a3", "PrivateIpAddresses": [ "10.0.0.82" ] }, "comments": { "input": { }, "output": { } }, "description": "This example assigns the specified secondary private IP address to the specified network interface.", "id": "ec2-assign-private-ip-addresses-1", "title": "To assign a specific secondary private IP address to an interface" }, { "input": { "NetworkInterfaceId": "eni-e5aa89a3", "SecondaryPrivateIpAddressCount": 2 }, "comments": { "input": { }, "output": { } }, "description": "This example assigns two secondary private IP addresses to the specified network interface. Amazon EC2 automatically assigns these IP addresses from the available IP addresses in the CIDR block range of the subnet the network interface is associated with.", "id": "ec2-assign-private-ip-addresses-2", "title": "To assign secondary private IP addresses that Amazon EC2 selects to an interface" } ], "AssociateAddress": [ { "input": { "AllocationId": "eipalloc-64d5890a", "InstanceId": "i-0b263919b6498b123" }, "output": { "AssociationId": "eipassoc-2bebb745" }, "comments": { "input": { }, "output": { } }, "description": "This example associates the specified Elastic IP address with the specified instance in a VPC.", "id": "ec2-associate-address-1", "title": "To associate an Elastic IP address in EC2-VPC" }, { "input": { "AllocationId": "eipalloc-64d5890a", "NetworkInterfaceId": "eni-1a2b3c4d" }, "output": { "AssociationId": "eipassoc-2bebb745" }, "comments": { "input": { }, "output": { } }, "description": "This example associates the specified Elastic IP address with the specified network interface.", "id": "ec2-associate-address-2", "title": "To associate an Elastic IP address with a network interface" }, { "input": { "InstanceId": "i-07ffe74c7330ebf53", "PublicIp": "198.51.100.0" }, "comments": { "input": { }, "output": { } }, "description": "This example associates an Elastic IP address with an instance in EC2-Classic.", "id": "ec2-associate-address-3", "title": "To associate an Elastic IP address in EC2-Classic" } ], "AssociateDhcpOptions": [ { "input": { "DhcpOptionsId": "dopt-d9070ebb", "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example associates the specified DHCP options set with the specified VPC.", "id": "ec2-associate-dhcp-options-1", "title": "To associate a DHCP options set with a VPC" }, { "input": { "DhcpOptionsId": "default", "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example associates the default DHCP options set with the specified VPC.", "id": "ec2-associate-dhcp-options-2", "title": "To associate the default DHCP options set with a VPC" } ], "AssociateRouteTable": [ { "input": { "RouteTableId": "rtb-22574640", "SubnetId": "subnet-9d4a7b6" }, "output": { "AssociationId": "rtbassoc-781d0d1a" }, "comments": { "input": { }, "output": { } }, "description": "This example associates the specified route table with the specified subnet.", "id": "ec2-associate-route-table-1", "title": "To associate a route table with a subnet" } ], "AttachInternetGateway": [ { "input": { "InternetGatewayId": "igw-c0a643a9", "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example attaches the specified Internet gateway to the specified VPC.", "id": "ec2-attach-internet-gateway-1", "title": "To attach an Internet gateway to a VPC" } ], "AttachNetworkInterface": [ { "input": { "DeviceIndex": 1, "InstanceId": "i-1234567890abcdef0", "NetworkInterfaceId": "eni-e5aa89a3" }, "output": { "AttachmentId": "eni-attach-66c4350a" }, "comments": { "input": { }, "output": { } }, "description": "This example attaches the specified network interface to the specified instance.", "id": "ec2-attach-network-interface-1", "title": "To attach a network interface to an instance" } ], "AttachVolume": [ { "input": { "Device": "/dev/sdf", "InstanceId": "i-01474ef662b89480", "VolumeId": "vol-1234567890abcdef0" }, "output": { "AttachTime": "2016-08-29T18:52:32.724Z", "Device": "/dev/sdf", "InstanceId": "i-01474ef662b89480", "State": "attaching", "VolumeId": "vol-1234567890abcdef0" }, "comments": { "input": { }, "output": { } }, "description": "This example attaches a volume (``vol-1234567890abcdef0``) to an instance (``i-01474ef662b89480``) as ``/dev/sdf``.", "id": "to-attach-a-volume-to-an-instance-1472499213109", "title": "To attach a volume to an instance" } ], "CancelSpotFleetRequests": [ { "input": { "SpotFleetRequestIds": [ "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" ], "TerminateInstances": true }, "output": { "SuccessfulFleetRequests": [ { "CurrentSpotFleetRequestState": "cancelled_running", "PreviousSpotFleetRequestState": "active", "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example cancels the specified Spot fleet request and terminates its associated Spot Instances.", "id": "ec2-cancel-spot-fleet-requests-1", "title": "To cancel a Spot fleet request" }, { "input": { "SpotFleetRequestIds": [ "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" ], "TerminateInstances": false }, "output": { "SuccessfulFleetRequests": [ { "CurrentSpotFleetRequestState": "cancelled_terminating", "PreviousSpotFleetRequestState": "active", "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example cancels the specified Spot fleet request without terminating its associated Spot Instances.", "id": "ec2-cancel-spot-fleet-requests-2", "title": "To cancel a Spot fleet request without terminating its Spot Instances" } ], "CancelSpotInstanceRequests": [ { "input": { "SpotInstanceRequestIds": [ "sir-08b93456" ] }, "output": { "CancelledSpotInstanceRequests": [ { "SpotInstanceRequestId": "sir-08b93456", "State": "cancelled" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example cancels a Spot Instance request.", "id": "ec2-cancel-spot-instance-requests-1", "title": "To cancel Spot Instance requests" } ], "ConfirmProductInstance": [ { "input": { "InstanceId": "i-1234567890abcdef0", "ProductCode": "774F4FF8" }, "output": { "OwnerId": "123456789012" }, "comments": { "input": { }, "output": { } }, "description": "This example determines whether the specified product code is associated with the specified instance.", "id": "to-confirm-the-product-instance-1472712108494", "title": "To confirm the product instance" } ], "CopySnapshot": [ { "input": { "Description": "This is my copied snapshot.", "DestinationRegion": "us-east-1", "SourceRegion": "us-west-2", "SourceSnapshotId": "snap-066877671789bd71b" }, "output": { "SnapshotId": "snap-066877671789bd71b" }, "comments": { "input": { }, "output": { } }, "description": "This example copies a snapshot with the snapshot ID of ``snap-066877671789bd71b`` from the ``us-west-2`` region to the ``us-east-1`` region and adds a short description to identify the snapshot.", "id": "to-copy-a-snapshot-1472502259774", "title": "To copy a snapshot" } ], "CreateCustomerGateway": [ { "input": { "BgpAsn": 65534, "PublicIp": "12.1.2.3", "Type": "ipsec.1" }, "output": { "CustomerGateway": { "BgpAsn": "65534", "CustomerGatewayId": "cgw-0e11f167", "IpAddress": "12.1.2.3", "State": "available", "Type": "ipsec.1" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a customer gateway with the specified IP address for its outside interface.", "id": "ec2-create-customer-gateway-1", "title": "To create a customer gateway" } ], "CreateDhcpOptions": [ { "input": { "DhcpConfigurations": [ { "Key": "domain-name-servers", "Values": [ "10.2.5.1", "10.2.5.2" ] } ] }, "output": { "DhcpOptions": { "DhcpConfigurations": [ { "Key": "domain-name-servers", "Values": [ { "Value": "10.2.5.2" }, { "Value": "10.2.5.1" } ] } ], "DhcpOptionsId": "dopt-d9070ebb" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a DHCP options set.", "id": "ec2-create-dhcp-options-1", "title": "To create a DHCP options set" } ], "CreateInternetGateway": [ { "output": { "InternetGateway": { "Attachments": [ ], "InternetGatewayId": "igw-c0a643a9", "Tags": [ ] } }, "comments": { "input": { }, "output": { } }, "description": "This example creates an Internet gateway.", "id": "ec2-create-internet-gateway-1", "title": "To create an Internet gateway" } ], "CreateKeyPair": [ { "input": { "KeyName": "my-key-pair" }, "comments": { "input": { }, "output": { } }, "description": "This example creates a key pair named my-key-pair.", "id": "ec2-create-key-pair-1", "title": "To create a key pair" } ], "CreateNatGateway": [ { "input": { "AllocationId": "eipalloc-37fc1a52", "SubnetId": "subnet-1a2b3c4d" }, "output": { "NatGateway": { "CreateTime": "2015-12-17T12:45:26.732Z", "NatGatewayAddresses": [ { "AllocationId": "eipalloc-37fc1a52" } ], "NatGatewayId": "nat-08d48af2a8e83edfd", "State": "pending", "SubnetId": "subnet-1a2b3c4d", "VpcId": "vpc-1122aabb" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a NAT gateway in subnet subnet-1a2b3c4d and associates an Elastic IP address with the allocation ID eipalloc-37fc1a52 with the NAT gateway.", "id": "ec2-create-nat-gateway-1", "title": "To create a NAT gateway" } ], "CreateNetworkAcl": [ { "input": { "VpcId": "vpc-a01106c2" }, "output": { "NetworkAcl": { "Associations": [ ], "Entries": [ { "CidrBlock": "0.0.0.0/0", "Egress": true, "Protocol": "-1", "RuleAction": "deny", "RuleNumber": 32767 }, { "CidrBlock": "0.0.0.0/0", "Egress": false, "Protocol": "-1", "RuleAction": "deny", "RuleNumber": 32767 } ], "IsDefault": false, "NetworkAclId": "acl-5fb85d36", "Tags": [ ], "VpcId": "vpc-a01106c2" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a network ACL for the specified VPC.", "id": "ec2-create-network-acl-1", "title": "To create a network ACL" } ], "CreateNetworkAclEntry": [ { "input": { "CidrBlock": "0.0.0.0/0", "Egress": false, "NetworkAclId": "acl-5fb85d36", "PortRange": { "From": 53, "To": 53 }, "Protocol": "udp", "RuleAction": "allow", "RuleNumber": 100 }, "comments": { "input": { }, "output": { } }, "description": "This example creates an entry for the specified network ACL. The rule allows ingress traffic from anywhere (0.0.0.0/0) on UDP port 53 (DNS) into any associated subnet.", "id": "ec2-create-network-acl-entry-1", "title": "To create a network ACL entry" } ], "CreateNetworkInterface": [ { "input": { "Description": "my network interface", "Groups": [ "sg-903004f8" ], "PrivateIpAddress": "10.0.2.17", "SubnetId": "subnet-9d4a7b6c" }, "output": { "NetworkInterface": { "AvailabilityZone": "us-east-1d", "Description": "my network interface", "Groups": [ { "GroupId": "sg-903004f8", "GroupName": "default" } ], "MacAddress": "02:1a:80:41:52:9c", "NetworkInterfaceId": "eni-e5aa89a3", "OwnerId": "123456789012", "PrivateIpAddress": "10.0.2.17", "PrivateIpAddresses": [ { "Primary": true, "PrivateIpAddress": "10.0.2.17" } ], "RequesterManaged": false, "SourceDestCheck": true, "Status": "pending", "SubnetId": "subnet-9d4a7b6c", "TagSet": [ ], "VpcId": "vpc-a01106c2" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a network interface for the specified subnet.", "id": "ec2-create-network-interface-1", "title": "To create a network interface" } ], "CreatePlacementGroup": [ { "input": { "GroupName": "my-cluster", "Strategy": "cluster" }, "output": { }, "comments": { "input": { }, "output": { } }, "description": "This example creates a placement group with the specified name.", "id": "to-create-a-placement-group-1472712245768", "title": "To create a placement group" } ], "CreateRoute": [ { "input": { "DestinationCidrBlock": "0.0.0.0/0", "GatewayId": "igw-c0a643a9", "RouteTableId": "rtb-22574640" }, "comments": { "input": { }, "output": { } }, "description": "This example creates a route for the specified route table. The route matches all traffic (0.0.0.0/0) and routes it to the specified Internet gateway.", "id": "ec2-create-route-1", "title": "To create a route" } ], "CreateRouteTable": [ { "input": { "VpcId": "vpc-a01106c2" }, "output": { "RouteTable": { "Associations": [ ], "PropagatingVgws": [ ], "RouteTableId": "rtb-22574640", "Routes": [ { "DestinationCidrBlock": "10.0.0.0/16", "GatewayId": "local", "State": "active" } ], "Tags": [ ], "VpcId": "vpc-a01106c2" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a route table for the specified VPC.", "id": "ec2-create-route-table-1", "title": "To create a route table" } ], "CreateSnapshot": [ { "input": { "Description": "This is my root volume snapshot.", "VolumeId": "vol-1234567890abcdef0" }, "output": { "Description": "This is my root volume snapshot.", "OwnerId": "012345678910", "SnapshotId": "snap-066877671789bd71b", "StartTime": "2014-02-28T21:06:01.000Z", "State": "pending", "Tags": [ ], "VolumeId": "vol-1234567890abcdef0", "VolumeSize": 8 }, "comments": { "input": { }, "output": { } }, "description": "This example creates a snapshot of the volume with a volume ID of ``vol-1234567890abcdef0`` and a short description to identify the snapshot.", "id": "to-create-a-snapshot-1472502529790", "title": "To create a snapshot" } ], "CreateSpotDatafeedSubscription": [ { "input": { "Bucket": "my-s3-bucket", "Prefix": "spotdata" }, "output": { "SpotDatafeedSubscription": { "Bucket": "my-s3-bucket", "OwnerId": "123456789012", "Prefix": "spotdata", "State": "Active" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a Spot Instance data feed for your AWS account.", "id": "ec2-create-spot-datafeed-subscription-1", "title": "To create a Spot Instance datafeed" } ], "CreateSubnet": [ { "input": { "CidrBlock": "10.0.1.0/24", "VpcId": "vpc-a01106c2" }, "output": { "Subnet": { "AvailabilityZone": "us-west-2c", "AvailableIpAddressCount": 251, "CidrBlock": "10.0.1.0/24", "State": "pending", "SubnetId": "subnet-9d4a7b6c", "VpcId": "vpc-a01106c2" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a subnet in the specified VPC with the specified CIDR block. We recommend that you let us select an Availability Zone for you.", "id": "ec2-create-subnet-1", "title": "To create a subnet" } ], "CreateTags": [ { "input": { "Resources": [ "ami-78a54011" ], "Tags": [ { "Key": "Stack", "Value": "production" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example adds the tag Stack=production to the specified image, or overwrites an existing tag for the AMI where the tag key is Stack.", "id": "ec2-create-tags-1", "title": "To add a tag to a resource" } ], "CreateVolume": [ { "input": { "AvailabilityZone": "us-east-1a", "Size": 80, "VolumeType": "gp2" }, "output": { "AvailabilityZone": "us-east-1a", "CreateTime": "2016-08-29T18:52:32.724Z", "Encrypted": false, "Iops": 240, "Size": 80, "SnapshotId": "", "State": "creating", "VolumeId": "vol-6b60b7c7", "VolumeType": "gp2" }, "comments": { "input": { }, "output": { } }, "description": "This example creates an 80 GiB General Purpose (SSD) volume in the Availability Zone ``us-east-1a``.", "id": "to-create-a-new-volume-1472496724296", "title": "To create a new volume" }, { "input": { "AvailabilityZone": "us-east-1a", "Iops": 1000, "SnapshotId": "snap-066877671789bd71b", "VolumeType": "io1" }, "output": { "Attachments": [ ], "AvailabilityZone": "us-east-1a", "CreateTime": "2016-08-29T18:52:32.724Z", "Iops": 1000, "Size": 500, "SnapshotId": "snap-066877671789bd71b", "State": "creating", "Tags": [ ], "VolumeId": "vol-1234567890abcdef0", "VolumeType": "io1" }, "comments": { "input": { }, "output": { } }, "description": "This example creates a new Provisioned IOPS (SSD) volume with 1000 provisioned IOPS from a snapshot in the Availability Zone ``us-east-1a``.", "id": "to-create-a-new-provisioned-iops-ssd-volume-from-a-snapshot-1472498975176", "title": "To create a new Provisioned IOPS (SSD) volume from a snapshot" } ], "CreateVpc": [ { "input": { "CidrBlock": "10.0.0.0/16" }, "output": { "Vpc": { "CidrBlock": "10.0.0.0/16", "DhcpOptionsId": "dopt-7a8b9c2d", "InstanceTenancy": "default", "State": "pending", "VpcId": "vpc-a01106c2" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a VPC with the specified CIDR block.", "id": "ec2-create-vpc-1", "title": "To create a VPC" } ], "DeleteCustomerGateway": [ { "input": { "CustomerGatewayId": "cgw-0e11f167" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified customer gateway.", "id": "ec2-delete-customer-gateway-1", "title": "To delete a customer gateway" } ], "DeleteDhcpOptions": [ { "input": { "DhcpOptionsId": "dopt-d9070ebb" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified DHCP options set.", "id": "ec2-delete-dhcp-options-1", "title": "To delete a DHCP options set" } ], "DeleteInternetGateway": [ { "input": { "InternetGatewayId": "igw-c0a643a9" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified Internet gateway.", "id": "ec2-delete-internet-gateway-1", "title": "To delete an Internet gateway" } ], "DeleteKeyPair": [ { "input": { "KeyName": "my-key-pair" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified key pair.", "id": "ec2-delete-key-pair-1", "title": "To delete a key pair" } ], "DeleteNatGateway": [ { "input": { "NatGatewayId": "nat-04ae55e711cec5680" }, "output": { "NatGatewayId": "nat-04ae55e711cec5680" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified NAT gateway.", "id": "ec2-delete-nat-gateway-1", "title": "To delete a NAT gateway" } ], "DeleteNetworkAcl": [ { "input": { "NetworkAclId": "acl-5fb85d36" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified network ACL.", "id": "ec2-delete-network-acl-1", "title": "To delete a network ACL" } ], "DeleteNetworkAclEntry": [ { "input": { "Egress": true, "NetworkAclId": "acl-5fb85d36", "RuleNumber": 100 }, "comments": { "input": { }, "output": { } }, "description": "This example deletes ingress rule number 100 from the specified network ACL.", "id": "ec2-delete-network-acl-entry-1", "title": "To delete a network ACL entry" } ], "DeleteNetworkInterface": [ { "input": { "NetworkInterfaceId": "eni-e5aa89a3" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified network interface.", "id": "ec2-delete-network-interface-1", "title": "To delete a network interface" } ], "DeletePlacementGroup": [ { "input": { "GroupName": "my-cluster" }, "output": { }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified placement group.\n", "id": "to-delete-a-placement-group-1472712349959", "title": "To delete a placement group" } ], "DeleteRoute": [ { "input": { "DestinationCidrBlock": "0.0.0.0/0", "RouteTableId": "rtb-22574640" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified route from the specified route table.", "id": "ec2-delete-route-1", "title": "To delete a route" } ], "DeleteRouteTable": [ { "input": { "RouteTableId": "rtb-22574640" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified route table.", "id": "ec2-delete-route-table-1", "title": "To delete a route table" } ], "DeleteSnapshot": [ { "input": { "SnapshotId": "snap-1234567890abcdef0" }, "output": { }, "comments": { "input": { }, "output": { } }, "description": "This example deletes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.", "id": "to-delete-a-snapshot-1472503042567", "title": "To delete a snapshot" } ], "DeleteSpotDatafeedSubscription": [ { "comments": { "input": { }, "output": { } }, "description": "This example deletes a Spot data feed subscription for the account.", "id": "ec2-delete-spot-datafeed-subscription-1", "title": "To cancel a Spot Instance data feed subscription" } ], "DeleteSubnet": [ { "input": { "SubnetId": "subnet-9d4a7b6c" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified subnet.", "id": "ec2-delete-subnet-1", "title": "To delete a subnet" } ], "DeleteTags": [ { "input": { "Resources": [ "ami-78a54011" ], "Tags": [ { "Key": "Stack", "Value": "test" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the tag Stack=test from the specified image.", "id": "ec2-delete-tags-1", "title": "To delete a tag from a resource" } ], "DeleteVolume": [ { "input": { "VolumeId": "vol-049df61146c4d7901" }, "output": { }, "comments": { "input": { }, "output": { } }, "description": "This example deletes an available volume with the volume ID of ``vol-049df61146c4d7901``. If the command succeeds, no output is returned.", "id": "to-delete-a-volume-1472503111160", "title": "To delete a volume" } ], "DeleteVpc": [ { "input": { "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified VPC.", "id": "ec2-delete-vpc-1", "title": "To delete a VPC" } ], "DescribeAccountAttributes": [ { "input": { "AttributeNames": [ "supported-platforms" ] }, "output": { "AccountAttributes": [ { "AttributeName": "supported-platforms", "AttributeValues": [ { "AttributeValue": "EC2" }, { "AttributeValue": "VPC" } ] } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the supported-platforms attribute for your AWS account.", "id": "ec2-describe-account-attributes-1", "title": "To describe a single attribute for your AWS account" }, { "output": { "AccountAttributes": [ { "AttributeName": "supported-platforms", "AttributeValues": [ { "AttributeValue": "EC2" }, { "AttributeValue": "VPC" } ] }, { "AttributeName": "vpc-max-security-groups-per-interface", "AttributeValues": [ { "AttributeValue": "5" } ] }, { "AttributeName": "max-elastic-ips", "AttributeValues": [ { "AttributeValue": "5" } ] }, { "AttributeName": "max-instances", "AttributeValues": [ { "AttributeValue": "20" } ] }, { "AttributeName": "vpc-max-elastic-ips", "AttributeValues": [ { "AttributeValue": "5" } ] }, { "AttributeName": "default-vpc", "AttributeValues": [ { "AttributeValue": "none" } ] } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the attributes for your AWS account.", "id": "ec2-describe-account-attributes-2", "title": "To describe all attributes for your AWS account" } ], "DescribeAddresses": [ { "output": { "Addresses": [ { "Domain": "standard", "InstanceId": "i-1234567890abcdef0", "PublicIp": "198.51.100.0" }, { "AllocationId": "eipalloc-12345678", "AssociationId": "eipassoc-12345678", "Domain": "vpc", "InstanceId": "i-1234567890abcdef0", "NetworkInterfaceId": "eni-12345678", "NetworkInterfaceOwnerId": "123456789012", "PrivateIpAddress": "10.0.1.241", "PublicIp": "203.0.113.0" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes your Elastic IP addresses.", "id": "ec2-describe-addresses-1", "title": "To describe your Elastic IP addresses" }, { "input": { "Filters": [ { "Name": "domain", "Values": [ "vpc" ] } ] }, "output": { "Addresses": [ { "AllocationId": "eipalloc-12345678", "AssociationId": "eipassoc-12345678", "Domain": "vpc", "InstanceId": "i-1234567890abcdef0", "NetworkInterfaceId": "eni-12345678", "NetworkInterfaceOwnerId": "123456789012", "PrivateIpAddress": "10.0.1.241", "PublicIp": "203.0.113.0" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes your Elastic IP addresses for use with instances in a VPC.", "id": "ec2-describe-addresses-2", "title": "To describe your Elastic IP addresses for EC2-VPC" }, { "input": { "Filters": [ { "Name": "domain", "Values": [ "standard" ] } ] }, "output": { "Addresses": [ { "Domain": "standard", "InstanceId": "i-1234567890abcdef0", "PublicIp": "198.51.100.0" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes your Elastic IP addresses for use with instances in EC2-Classic.", "id": "ec2-describe-addresses-3", "title": "To describe your Elastic IP addresses for EC2-Classic" } ], "DescribeAvailabilityZones": [ { "output": { "AvailabilityZones": [ { "Messages": [ ], "RegionName": "us-east-1", "State": "available", "ZoneName": "us-east-1b" }, { "Messages": [ ], "RegionName": "us-east-1", "State": "available", "ZoneName": "us-east-1c" }, { "Messages": [ ], "RegionName": "us-east-1", "State": "available", "ZoneName": "us-east-1d" }, { "Messages": [ ], "RegionName": "us-east-1", "State": "available", "ZoneName": "us-east-1e" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the Availability Zones that are available to you. The response includes Availability Zones only for the current region.", "id": "ec2-describe-availability-zones-1", "title": "To describe your Availability Zones" } ], "DescribeCustomerGateways": [ { "input": { "CustomerGatewayIds": [ "cgw-0e11f167" ] }, "output": { "CustomerGateways": [ { "BgpAsn": "65534", "CustomerGatewayId": "cgw-0e11f167", "IpAddress": "12.1.2.3", "State": "available", "Type": "ipsec.1" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the specified customer gateway.", "id": "ec2-describe-customer-gateways-1", "title": "To describe a customer gateway" } ], "DescribeDhcpOptions": [ { "input": { "DhcpOptionsIds": [ "dopt-d9070ebb" ] }, "output": { "DhcpOptions": [ { "DhcpConfigurations": [ { "Key": "domain-name-servers", "Values": [ { "Value": "10.2.5.2" }, { "Value": "10.2.5.1" } ] } ], "DhcpOptionsId": "dopt-d9070ebb" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the specified DHCP options set.", "id": "ec2-describe-dhcp-options-1", "title": "To describe a DHCP options set" } ], "DescribeInstanceAttribute": [ { "input": { "Attribute": "instanceType", "InstanceId": "i-1234567890abcdef0" }, "output": { "InstanceId": "i-1234567890abcdef0", "InstanceType": { "Value": "t1.micro" } }, "comments": { "input": { }, "output": { } }, "description": "This example describes the instance type of the specified instance.\n", "id": "to-describe-the-instance-type-1472712432132", "title": "To describe the instance type" }, { "input": { "Attribute": "disableApiTermination", "InstanceId": "i-1234567890abcdef0" }, "output": { "DisableApiTermination": { "Value": "false" }, "InstanceId": "i-1234567890abcdef0" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the ``disableApiTermination`` attribute of the specified instance.\n", "id": "to-describe-the-disableapitermination-attribute-1472712533466", "title": "To describe the disableApiTermination attribute" }, { "input": { "Attribute": "blockDeviceMapping", "InstanceId": "i-1234567890abcdef0" }, "output": { "BlockDeviceMappings": [ { "DeviceName": "/dev/sda1", "Ebs": { "AttachTime": "2013-05-17T22:42:34.000Z", "DeleteOnTermination": true, "Status": "attached", "VolumeId": "vol-049df61146c4d7901" } }, { "DeviceName": "/dev/sdf", "Ebs": { "AttachTime": "2013-09-10T23:07:00.000Z", "DeleteOnTermination": false, "Status": "attached", "VolumeId": "vol-049df61146c4d7901" } } ], "InstanceId": "i-1234567890abcdef0" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the ``blockDeviceMapping`` attribute of the specified instance.\n", "id": "to-describe-the-block-device-mapping-for-an-instance-1472712645423", "title": "To describe the block device mapping for an instance" } ], "DescribeInternetGateways": [ { "input": { "Filters": [ { "Name": "attachment.vpc-id", "Values": [ "vpc-a01106c2" ] } ] }, "output": { "InternetGateways": [ { "Attachments": [ { "State": "available", "VpcId": "vpc-a01106c2" } ], "InternetGatewayId": "igw-c0a643a9", "Tags": [ ] } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the Internet gateway for the specified VPC.", "id": "ec2-describe-internet-gateways-1", "title": "To describe the Internet gateway for a VPC" } ], "DescribeKeyPairs": [ { "input": { "KeyNames": [ "my-key-pair" ] }, "output": { "KeyPairs": [ { "KeyFingerprint": "1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f", "KeyName": "my-key-pair" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example displays the fingerprint for the specified key.", "id": "ec2-describe-key-pairs-1", "title": "To display a key pair" } ], "DescribeMovingAddresses": [ { "output": { "MovingAddressStatuses": [ { "MoveStatus": "MovingToVpc", "PublicIp": "198.51.100.0" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes all of your moving Elastic IP addresses.", "id": "ec2-describe-moving-addresses-1", "title": "To describe your moving addresses" } ], "DescribeNatGateways": [ { "input": { "Filter": [ { "Name": "vpc-id", "Values": [ "vpc-1a2b3c4d" ] } ] }, "output": { "NatGateways": [ { "CreateTime": "2015-12-01T12:26:55.983Z", "NatGatewayAddresses": [ { "AllocationId": "eipalloc-89c620ec", "NetworkInterfaceId": "eni-9dec76cd", "PrivateIp": "10.0.0.149", "PublicIp": "198.11.222.333" } ], "NatGatewayId": "nat-05dba92075d71c408", "State": "available", "SubnetId": "subnet-847e4dc2", "VpcId": "vpc-1a2b3c4d" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the NAT gateway for the specified VPC.", "id": "ec2-describe-nat-gateways-1", "title": "To describe a NAT gateway" } ], "DescribeNetworkAcls": [ { "input": { "NetworkAclIds": [ "acl-5fb85d36" ] }, "output": { "NetworkAcls": [ { "Associations": [ { "NetworkAclAssociationId": "aclassoc-66ea5f0b", "NetworkAclId": "acl-9aeb5ef7", "SubnetId": "subnet-65ea5f08" } ], "Entries": [ { "CidrBlock": "0.0.0.0/0", "Egress": true, "Protocol": "-1", "RuleAction": "deny", "RuleNumber": 32767 }, { "CidrBlock": "0.0.0.0/0", "Egress": false, "Protocol": "-1", "RuleAction": "deny", "RuleNumber": 32767 } ], "IsDefault": false, "NetworkAclId": "acl-5fb85d36", "Tags": [ ], "VpcId": "vpc-a01106c2" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the specified network ACL.", "id": "ec2-", "title": "To describe a network ACL" } ], "DescribeNetworkInterfaceAttribute": [ { "input": { "Attribute": "attachment", "NetworkInterfaceId": "eni-686ea200" }, "output": { "Attachment": { "AttachTime": "2015-05-21T20:02:20.000Z", "AttachmentId": "eni-attach-43348162", "DeleteOnTermination": true, "DeviceIndex": 0, "InstanceId": "i-1234567890abcdef0", "InstanceOwnerId": "123456789012", "Status": "attached" }, "NetworkInterfaceId": "eni-686ea200" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the attachment attribute of the specified network interface.", "id": "ec2-describe-network-interface-attribute-1", "title": "To describe the attachment attribute of a network interface" }, { "input": { "Attribute": "description", "NetworkInterfaceId": "eni-686ea200" }, "output": { "Description": { "Value": "My description" }, "NetworkInterfaceId": "eni-686ea200" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the description attribute of the specified network interface.", "id": "ec2-describe-network-interface-attribute-2", "title": "To describe the description attribute of a network interface" }, { "input": { "Attribute": "groupSet", "NetworkInterfaceId": "eni-686ea200" }, "output": { "Groups": [ { "GroupId": "sg-903004f8", "GroupName": "my-security-group" } ], "NetworkInterfaceId": "eni-686ea200" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the groupSet attribute of the specified network interface.", "id": "ec2-describe-network-interface-attribute-3", "title": "To describe the groupSet attribute of a network interface" }, { "input": { "Attribute": "sourceDestCheck", "NetworkInterfaceId": "eni-686ea200" }, "output": { "NetworkInterfaceId": "eni-686ea200", "SourceDestCheck": { "Value": true } }, "comments": { "input": { }, "output": { } }, "description": "This example describes the sourceDestCheck attribute of the specified network interface.", "id": "ec2-describe-network-interface-attribute-4", "title": "To describe the sourceDestCheck attribute of a network interface" } ], "DescribeNetworkInterfaces": [ { "input": { "NetworkInterfaceIds": [ "eni-e5aa89a3" ] }, "output": { "NetworkInterfaces": [ { "Association": { "AssociationId": "eipassoc-0fbb766a", "IpOwnerId": "123456789012", "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", "PublicIp": "203.0.113.12" }, "Attachment": { "AttachTime": "2013-11-30T23:36:42.000Z", "AttachmentId": "eni-attach-66c4350a", "DeleteOnTermination": false, "DeviceIndex": 1, "InstanceId": "i-1234567890abcdef0", "InstanceOwnerId": "123456789012", "Status": "attached" }, "AvailabilityZone": "us-east-1d", "Description": "my network interface", "Groups": [ { "GroupId": "sg-8637d3e3", "GroupName": "default" } ], "MacAddress": "02:2f:8f:b0:cf:75", "NetworkInterfaceId": "eni-e5aa89a3", "OwnerId": "123456789012", "PrivateDnsName": "ip-10-0-1-17.ec2.internal", "PrivateIpAddress": "10.0.1.17", "PrivateIpAddresses": [ { "Association": { "AssociationId": "eipassoc-0fbb766a", "IpOwnerId": "123456789012", "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", "PublicIp": "203.0.113.12" }, "Primary": true, "PrivateDnsName": "ip-10-0-1-17.ec2.internal", "PrivateIpAddress": "10.0.1.17" } ], "RequesterManaged": false, "SourceDestCheck": true, "Status": "in-use", "SubnetId": "subnet-b61f49f0", "TagSet": [ ], "VpcId": "vpc-a01106c2" } ] }, "comments": { "input": { }, "output": { } }, "description": "", "id": "ec2-describe-network-interfaces-1", "title": "To describe a network interface" } ], "DescribeRegions": [ { "output": { "Regions": [ { "Endpoint": "ec2.ap-south-1.amazonaws.com", "RegionName": "ap-south-1" }, { "Endpoint": "ec2.eu-west-1.amazonaws.com", "RegionName": "eu-west-1" }, { "Endpoint": "ec2.ap-southeast-1.amazonaws.com", "RegionName": "ap-southeast-1" }, { "Endpoint": "ec2.ap-southeast-2.amazonaws.com", "RegionName": "ap-southeast-2" }, { "Endpoint": "ec2.eu-central-1.amazonaws.com", "RegionName": "eu-central-1" }, { "Endpoint": "ec2.ap-northeast-2.amazonaws.com", "RegionName": "ap-northeast-2" }, { "Endpoint": "ec2.ap-northeast-1.amazonaws.com", "RegionName": "ap-northeast-1" }, { "Endpoint": "ec2.us-east-1.amazonaws.com", "RegionName": "us-east-1" }, { "Endpoint": "ec2.sa-east-1.amazonaws.com", "RegionName": "sa-east-1" }, { "Endpoint": "ec2.us-west-1.amazonaws.com", "RegionName": "us-west-1" }, { "Endpoint": "ec2.us-west-2.amazonaws.com", "RegionName": "us-west-2" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes all the regions that are available to you.", "id": "ec2-describe-regions-1", "title": "To describe your regions" } ], "DescribeRouteTables": [ { "input": { "RouteTableIds": [ "rtb-1f382e7d" ] }, "output": { "RouteTables": [ { "Associations": [ { "Main": true, "RouteTableAssociationId": "rtbassoc-d8ccddba", "RouteTableId": "rtb-1f382e7d" } ], "PropagatingVgws": [ ], "RouteTableId": "rtb-1f382e7d", "Routes": [ { "DestinationCidrBlock": "10.0.0.0/16", "GatewayId": "local", "State": "active" } ], "Tags": [ ], "VpcId": "vpc-a01106c2" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the specified route table.", "id": "ec2-describe-route-tables-1", "title": "To describe a route table" } ], "DescribeScheduledInstanceAvailability": [ { "input": { "FirstSlotStartTimeRange": { "EarliestTime": "2016-01-31T00:00:00Z", "LatestTime": "2016-01-31T04:00:00Z" }, "Recurrence": { "Frequency": "Weekly", "Interval": 1, "OccurrenceDays": [ 1 ] } }, "output": { "ScheduledInstanceAvailabilitySet": [ { "AvailabilityZone": "us-west-2b", "AvailableInstanceCount": 20, "FirstSlotStartTime": "2016-01-31T00:00:00Z", "HourlyPrice": "0.095", "InstanceType": "c4.large", "MaxTermDurationInDays": 366, "MinTermDurationInDays": 366, "NetworkPlatform": "EC2-VPC", "Platform": "Linux/UNIX", "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi...", "Recurrence": { "Frequency": "Weekly", "Interval": 1, "OccurrenceDaySet": [ 1 ], "OccurrenceRelativeToEnd": false }, "SlotDurationInHours": 23, "TotalScheduledInstanceHours": 1219 } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes a schedule that occurs every week on Sunday, starting on the specified date. Note that the output contains a single schedule as an example.", "id": "ec2-describe-scheduled-instance-availability-1", "title": "To describe an available schedule" } ], "DescribeScheduledInstances": [ { "input": { "ScheduledInstanceIds": [ "sci-1234-1234-1234-1234-123456789012" ] }, "output": { "ScheduledInstanceSet": [ { "AvailabilityZone": "us-west-2b", "CreateDate": "2016-01-25T21:43:38.612Z", "HourlyPrice": "0.095", "InstanceCount": 1, "InstanceType": "c4.large", "NetworkPlatform": "EC2-VPC", "NextSlotStartTime": "2016-01-31T09:00:00Z", "Platform": "Linux/UNIX", "Recurrence": { "Frequency": "Weekly", "Interval": 1, "OccurrenceDaySet": [ 1 ], "OccurrenceRelativeToEnd": false, "OccurrenceUnit": "" }, "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012", "SlotDurationInHours": 32, "TermEndDate": "2017-01-31T09:00:00Z", "TermStartDate": "2016-01-31T09:00:00Z", "TotalScheduledInstanceHours": 1696 } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the specified Scheduled Instance.", "id": "ec2-describe-scheduled-instances-1", "title": "To describe your Scheduled Instances" } ], "DescribeSnapshotAttribute": [ { "input": { "Attribute": "createVolumePermission", "SnapshotId": "snap-066877671789bd71b" }, "output": { "CreateVolumePermissions": [ ], "SnapshotId": "snap-066877671789bd71b" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the ``createVolumePermission`` attribute on a snapshot with the snapshot ID of ``snap-066877671789bd71b``.", "id": "to-describe-snapshot-attributes-1472503199736", "title": "To describe snapshot attributes" } ], "DescribeSnapshots": [ { "input": { "SnapshotIds": [ "snap-1234567890abcdef0" ] }, "output": { "NextToken": "", "Snapshots": [ { "Description": "This is my snapshot.", "OwnerId": "012345678910", "Progress": "100%", "SnapshotId": "snap-1234567890abcdef0", "StartTime": "2014-02-28T21:28:32.000Z", "State": "completed", "VolumeId": "vol-049df61146c4d7901", "VolumeSize": 8 } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``.", "id": "to-describe-a-snapshot-1472503807850", "title": "To describe a snapshot" }, { "input": { "Filters": [ { "Name": "status", "Values": [ "pending" ] } ], "OwnerIds": [ "012345678910" ] }, "output": { "NextToken": "", "Snapshots": [ { "Description": "This is my copied snapshot.", "OwnerId": "012345678910", "Progress": "87%", "SnapshotId": "snap-066877671789bd71b", "StartTime": "2014-02-28T21:37:27.000Z", "State": "pending", "VolumeId": "vol-1234567890abcdef0", "VolumeSize": 8 } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes all snapshots owned by the ID 012345678910 that are in the ``pending`` status.", "id": "to-describe-snapshots-using-filters-1472503929793", "title": "To describe snapshots using filters" } ], "DescribeSpotDatafeedSubscription": [ { "output": { "SpotDatafeedSubscription": { "Bucket": "my-s3-bucket", "OwnerId": "123456789012", "Prefix": "spotdata", "State": "Active" } }, "comments": { "input": { }, "output": { } }, "description": "This example describes the Spot Instance datafeed subscription for your AWS account.", "id": "ec2-describe-spot-datafeed-subscription-1", "title": "To describe the datafeed for your AWS account" } ], "DescribeSpotFleetInstances": [ { "input": { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" }, "output": { "ActiveInstances": [ { "InstanceId": "i-1234567890abcdef0", "InstanceType": "m3.medium", "SpotInstanceRequestId": "sir-08b93456" } ], "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" }, "comments": { "input": { }, "output": { } }, "description": "This example lists the Spot Instances associated with the specified Spot fleet.", "id": "ec2-describe-spot-fleet-instances-1", "title": "To describe the Spot Instances associated with a Spot fleet" } ], "DescribeSpotFleetRequestHistory": [ { "input": { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "StartTime": "2015-05-26T00:00:00Z" }, "output": { "HistoryRecords": [ { "EventInformation": { "EventSubType": "submitted" }, "EventType": "fleetRequestChange", "Timestamp": "2015-05-26T23:17:20.697Z" }, { "EventInformation": { "EventSubType": "active" }, "EventType": "fleetRequestChange", "Timestamp": "2015-05-26T23:17:20.873Z" }, { "EventInformation": { "EventSubType": "launched", "InstanceId": "i-1234567890abcdef0" }, "EventType": "instanceChange", "Timestamp": "2015-05-26T23:21:21.712Z" }, { "EventInformation": { "EventSubType": "launched", "InstanceId": "i-1234567890abcdef1" }, "EventType": "instanceChange", "Timestamp": "2015-05-26T23:21:21.816Z" } ], "NextToken": "CpHNsscimcV5oH7bSbub03CI2Qms5+ypNpNm+53MNlR0YcXAkp0xFlfKf91yVxSExmbtma3awYxMFzNA663ZskT0AHtJ6TCb2Z8bQC2EnZgyELbymtWPfpZ1ZbauVg+P+TfGlWxWWB/Vr5dk5d4LfdgA/DRAHUrYgxzrEXAMPLE=", "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "StartTime": "2015-05-26T00:00:00Z" }, "comments": { "input": { }, "output": { } }, "description": "This example returns the history for the specified Spot fleet starting at the specified time.", "id": "ec2-describe-spot-fleet-request-history-1", "title": "To describe Spot fleet history" } ], "DescribeSpotFleetRequests": [ { "input": { "SpotFleetRequestIds": [ "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" ] }, "output": { "SpotFleetRequestConfigs": [ { "SpotFleetRequestConfig": { "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", "LaunchSpecifications": [ { "EbsOptimized": false, "ImageId": "ami-1a2b3c4d", "InstanceType": "cc2.8xlarge", "NetworkInterfaces": [ { "AssociatePublicIpAddress": true, "DeleteOnTermination": false, "DeviceIndex": 0, "SecondaryPrivateIpAddressCount": 0, "SubnetId": "subnet-a61dafcf" } ] }, { "EbsOptimized": false, "ImageId": "ami-1a2b3c4d", "InstanceType": "r3.8xlarge", "NetworkInterfaces": [ { "AssociatePublicIpAddress": true, "DeleteOnTermination": false, "DeviceIndex": 0, "SecondaryPrivateIpAddressCount": 0, "SubnetId": "subnet-a61dafcf" } ] } ], "SpotPrice": "0.05", "TargetCapacity": 20 }, "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "SpotFleetRequestState": "active" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the specified Spot fleet request.", "id": "ec2-describe-spot-fleet-requests-1", "title": "To describe a Spot fleet request" } ], "DescribeSpotInstanceRequests": [ { "input": { "SpotInstanceRequestIds": [ "sir-08b93456" ] }, "output": { "SpotInstanceRequests": [ { "CreateTime": "2014-04-30T18:14:55.000Z", "InstanceId": "i-1234567890abcdef0", "LaunchSpecification": { "BlockDeviceMappings": [ { "DeviceName": "/dev/sda1", "Ebs": { "DeleteOnTermination": true, "VolumeSize": 8, "VolumeType": "standard" } } ], "EbsOptimized": false, "ImageId": "ami-7aba833f", "InstanceType": "m1.small", "KeyName": "my-key-pair", "SecurityGroups": [ { "GroupId": "sg-e38f24a7", "GroupName": "my-security-group" } ] }, "LaunchedAvailabilityZone": "us-west-1b", "ProductDescription": "Linux/UNIX", "SpotInstanceRequestId": "sir-08b93456", "SpotPrice": "0.010000", "State": "active", "Status": { "Code": "fulfilled", "Message": "Your Spot request is fulfilled.", "UpdateTime": "2014-04-30T18:16:21.000Z" }, "Type": "one-time" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the specified Spot Instance request.", "id": "ec2-describe-spot-instance-requests-1", "title": "To describe a Spot Instance request" } ], "DescribeSpotPriceHistory": [ { "input": { "EndTime": "2014-01-06T08:09:10", "InstanceTypes": [ "m1.xlarge" ], "ProductDescriptions": [ "Linux/UNIX (Amazon VPC)" ], "StartTime": "2014-01-06T07:08:09" }, "output": { "SpotPriceHistory": [ { "AvailabilityZone": "us-west-1a", "InstanceType": "m1.xlarge", "ProductDescription": "Linux/UNIX (Amazon VPC)", "SpotPrice": "0.080000", "Timestamp": "2014-01-06T04:32:53.000Z" }, { "AvailabilityZone": "us-west-1c", "InstanceType": "m1.xlarge", "ProductDescription": "Linux/UNIX (Amazon VPC)", "SpotPrice": "0.080000", "Timestamp": "2014-01-05T11:28:26.000Z" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example returns the Spot Price history for m1.xlarge, Linux/UNIX (Amazon VPC) instances for a particular day in January.", "id": "ec2-describe-spot-price-history-1", "title": "To describe Spot price history for Linux/UNIX (Amazon VPC)" } ], "DescribeSubnets": [ { "input": { "Filters": [ { "Name": "vpc-id", "Values": [ "vpc-a01106c2" ] } ] }, "output": { "Subnets": [ { "AvailabilityZone": "us-east-1c", "AvailableIpAddressCount": 251, "CidrBlock": "10.0.1.0/24", "DefaultForAz": false, "MapPublicIpOnLaunch": false, "State": "available", "SubnetId": "subnet-9d4a7b6c", "VpcId": "vpc-a01106c2" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the subnets for the specified VPC.", "id": "ec2-describe-subnets-1", "title": "To describe the subnets for a VPC" } ], "DescribeTags": [ { "input": { "Filters": [ { "Name": "resource-id", "Values": [ "i-1234567890abcdef8" ] } ] }, "output": { "Tags": [ { "Key": "Stack", "ResourceId": "i-1234567890abcdef8", "ResourceType": "instance", "Value": "test" }, { "Key": "Name", "ResourceId": "i-1234567890abcdef8", "ResourceType": "instance", "Value": "Beta Server" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the tags for the specified instance.", "id": "ec2-describe-tags-1", "title": "To describe the tags for a single resource" } ], "DescribeVolumeAttribute": [ { "input": { "Attribute": "autoEnableIO", "VolumeId": "vol-049df61146c4d7901" }, "output": { "AutoEnableIO": { "Value": false }, "VolumeId": "vol-049df61146c4d7901" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the ``autoEnableIo`` attribute of the volume with the ID ``vol-049df61146c4d7901``.", "id": "to-describe-a-volume-attribute-1472505773492", "title": "To describe a volume attribute" } ], "DescribeVolumeStatus": [ { "input": { "VolumeIds": [ "vol-1234567890abcdef0" ] }, "output": { "VolumeStatuses": [ { "Actions": [ ], "AvailabilityZone": "us-east-1a", "Events": [ ], "VolumeId": "vol-1234567890abcdef0", "VolumeStatus": { "Details": [ { "Name": "io-enabled", "Status": "passed" }, { "Name": "io-performance", "Status": "not-applicable" } ], "Status": "ok" } } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the status for the volume ``vol-1234567890abcdef0``.", "id": "to-describe-the-status-of-a-single-volume-1472507016193", "title": "To describe the status of a single volume" }, { "input": { "Filters": [ { "Name": "volume-status.status", "Values": [ "impaired" ] } ] }, "output": { "VolumeStatuses": [ ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the status for all volumes that are impaired. In this example output, there are no impaired volumes.", "id": "to-describe-the-status-of-impaired-volumes-1472507239821", "title": "To describe the status of impaired volumes" } ], "DescribeVolumes": [ { "input": { }, "output": { "NextToken": "", "Volumes": [ { "Attachments": [ { "AttachTime": "2013-12-18T22:35:00.000Z", "DeleteOnTermination": true, "Device": "/dev/sda1", "InstanceId": "i-1234567890abcdef0", "State": "attached", "VolumeId": "vol-049df61146c4d7901" } ], "AvailabilityZone": "us-east-1a", "CreateTime": "2013-12-18T22:35:00.084Z", "Size": 8, "SnapshotId": "snap-1234567890abcdef0", "State": "in-use", "VolumeId": "vol-049df61146c4d7901", "VolumeType": "standard" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes all of your volumes in the default region.", "id": "to-describe-all-volumes-1472506358883", "title": "To describe all volumes" }, { "input": { "Filters": [ { "Name": "attachment.instance-id", "Values": [ "i-1234567890abcdef0" ] }, { "Name": "attachment.delete-on-termination", "Values": [ "true" ] } ] }, "output": { "Volumes": [ { "Attachments": [ { "AttachTime": "2013-12-18T22:35:00.000Z", "DeleteOnTermination": true, "Device": "/dev/sda1", "InstanceId": "i-1234567890abcdef0", "State": "attached", "VolumeId": "vol-049df61146c4d7901" } ], "AvailabilityZone": "us-east-1a", "CreateTime": "2013-12-18T22:35:00.084Z", "Size": 8, "SnapshotId": "snap-1234567890abcdef0", "State": "in-use", "VolumeId": "vol-049df61146c4d7901", "VolumeType": "standard" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes all volumes that are both attached to the instance with the ID i-1234567890abcdef0 and set to delete when the instance terminates.", "id": "to-describe-volumes-that-are-attached-to-a-specific-instance-1472506613578", "title": "To describe volumes that are attached to a specific instance" } ], "DescribeVpcAttribute": [ { "input": { "Attribute": "enableDnsSupport", "VpcId": "vpc-a01106c2" }, "output": { "EnableDnsSupport": { "Value": true }, "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.", "id": "ec2-describe-vpc-attribute-1", "title": "To describe the enableDnsSupport attribute" }, { "input": { "Attribute": "enableDnsHostnames", "VpcId": "vpc-a01106c2" }, "output": { "EnableDnsHostnames": { "Value": true }, "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the enableDnsHostnames attribute. This attribute indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.", "id": "ec2-describe-vpc-attribute-2", "title": "To describe the enableDnsHostnames attribute" } ], "DescribeVpcs": [ { "input": { "VpcIds": [ "vpc-a01106c2" ] }, "output": { "Vpcs": [ { "CidrBlock": "10.0.0.0/16", "DhcpOptionsId": "dopt-7a8b9c2d", "InstanceTenancy": "default", "IsDefault": false, "State": "available", "Tags": [ { "Key": "Name", "Value": "MyVPC" } ], "VpcId": "vpc-a01106c2" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the specified VPC.", "id": "ec2-describe-vpcs-1", "title": "To describe a VPC" } ], "DetachInternetGateway": [ { "input": { "InternetGatewayId": "igw-c0a643a9", "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example detaches the specified Internet gateway from the specified VPC.", "id": "ec2-detach-internet-gateway-1", "title": "To detach an Internet gateway from a VPC" } ], "DetachNetworkInterface": [ { "input": { "AttachmentId": "eni-attach-66c4350a" }, "comments": { "input": { }, "output": { } }, "description": "This example detaches the specified network interface from its attached instance.", "id": "ec2-detach-network-interface-1", "title": "To detach a network interface from an instance" } ], "DetachVolume": [ { "input": { "VolumeId": "vol-1234567890abcdef0" }, "output": { "AttachTime": "2014-02-27T19:23:06.000Z", "Device": "/dev/sdb", "InstanceId": "i-1234567890abcdef0", "State": "detaching", "VolumeId": "vol-049df61146c4d7901" }, "comments": { "input": { }, "output": { } }, "description": "This example detaches the volume (``vol-049df61146c4d7901``) from the instance it is attached to.", "id": "to-detach-a-volume-from-an-instance-1472507977694", "title": "To detach a volume from an instance" } ], "DisableVgwRoutePropagation": [ { "input": { "GatewayId": "vgw-9a4cacf3", "RouteTableId": "rtb-22574640" }, "comments": { "input": { }, "output": { } }, "description": "This example disables the specified virtual private gateway from propagating static routes to the specified route table.", "id": "ec2-disable-vgw-route-propagation-1", "title": "To disable route propagation" } ], "DisassociateAddress": [ { "input": { "AssociationId": "eipassoc-2bebb745" }, "comments": { "input": { }, "output": { } }, "description": "This example disassociates an Elastic IP address from an instance in a VPC.", "id": "ec2-disassociate-address-1", "title": "To disassociate an Elastic IP address in EC2-VPC" }, { "input": { "PublicIp": "198.51.100.0" }, "comments": { "input": { }, "output": { } }, "description": "This example disassociates an Elastic IP address from an instance in EC2-Classic.", "id": "ec2-disassociate-address-2", "title": "To disassociate an Elastic IP addresses in EC2-Classic" } ], "DisassociateRouteTable": [ { "input": { "AssociationId": "rtbassoc-781d0d1a" }, "comments": { "input": { }, "output": { } }, "description": "This example disassociates the specified route table from its associated subnet.", "id": "ec2-disassociate-route-table-1", "title": "To disassociate a route table" } ], "EnableVgwRoutePropagation": [ { "input": { "GatewayId": "vgw-9a4cacf3", "RouteTableId": "rtb-22574640" }, "comments": { "input": { }, "output": { } }, "description": "This example enables the specified virtual private gateway to propagate static routes to the specified route table.", "id": "ec2-enable-vgw-route-propagation-1", "title": "To enable route propagation" } ], "EnableVolumeIO": [ { "input": { "VolumeId": "vol-1234567890abcdef0" }, "comments": { "input": { }, "output": { } }, "description": "This example enables I/O on volume ``vol-1234567890abcdef0``.", "id": "to-enable-io-for-a-volume-1472508114867", "title": "To enable I/O for a volume" } ], "ModifyNetworkInterfaceAttribute": [ { "input": { "Attachment": { "AttachmentId": "eni-attach-43348162", "DeleteOnTermination": false }, "NetworkInterfaceId": "eni-686ea200" }, "comments": { "input": { }, "output": { } }, "description": "This example modifies the attachment attribute of the specified network interface.", "id": "ec2-modify-network-interface-attribute-1", "title": "To modify the attachment attribute of a network interface" }, { "input": { "Description": { "Value": "My description" }, "NetworkInterfaceId": "eni-686ea200" }, "comments": { "input": { }, "output": { } }, "description": "This example modifies the description attribute of the specified network interface.", "id": "ec2-modify-network-interface-attribute-2", "title": "To modify the description attribute of a network interface" }, { "input": { "Groups": [ "sg-903004f8", "sg-1a2b3c4d" ], "NetworkInterfaceId": "eni-686ea200" }, "comments": { "input": { }, "output": { } }, "description": "This example command modifies the groupSet attribute of the specified network interface.", "id": "ec2-modify-network-interface-attribute-3", "title": "To modify the groupSet attribute of a network interface" }, { "input": { "NetworkInterfaceId": "eni-686ea200", "SourceDestCheck": { "Value": false } }, "comments": { "input": { }, "output": { } }, "description": "This example command modifies the sourceDestCheck attribute of the specified network interface.", "id": "ec2-modify-network-interface-attribute-4", "title": "To modify the sourceDestCheck attribute of a network interface" } ], "ModifySnapshotAttribute": [ { "input": { "Attribute": "createVolumePermission", "OperationType": "remove", "SnapshotId": "snap-1234567890abcdef0", "UserIds": [ "123456789012" ] }, "output": { }, "comments": { "input": { }, "output": { } }, "description": "This example modifies snapshot ``snap-1234567890abcdef0`` to remove the create volume permission for a user with the account ID ``123456789012``. If the command succeeds, no output is returned.", "id": "to-modify-a-snapshot-attribute-1472508385907", "title": "To modify a snapshot attribute" }, { "input": { "Attribute": "createVolumePermission", "GroupNames": [ "all" ], "OperationType": "add", "SnapshotId": "snap-1234567890abcdef0" }, "output": { }, "comments": { "input": { }, "output": { } }, "description": "This example makes the snapshot ``snap-1234567890abcdef0`` public.", "id": "to-make-a-snapshot-public-1472508470529", "title": "To make a snapshot public" } ], "ModifySpotFleetRequest": [ { "input": { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "TargetCapacity": 20 }, "output": { "Return": true }, "comments": { "input": { }, "output": { } }, "description": "This example increases the target capacity of the specified Spot fleet request.", "id": "ec2-modify-spot-fleet-request-1", "title": "To increase the target capacity of a Spot fleet request" }, { "input": { "ExcessCapacityTerminationPolicy": "NoTermination ", "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "TargetCapacity": 10 }, "output": { "Return": true }, "comments": { "input": { }, "output": { } }, "description": "This example decreases the target capacity of the specified Spot fleet request without terminating any Spot Instances as a result.", "id": "ec2-modify-spot-fleet-request-2", "title": "To decrease the target capacity of a Spot fleet request" } ], "ModifySubnetAttribute": [ { "input": { "MapPublicIpOnLaunch": { "Value": true }, "SubnetId": "subnet-1a2b3c4d" }, "comments": { "input": { }, "output": { } }, "description": "This example modifies the specified subnet so that all instances launched into this subnet are assigned a public IP address.", "id": "ec2-modify-subnet-attribute-1", "title": "To change a subnet's public IP addressing behavior" } ], "ModifyVolumeAttribute": [ { "input": { "AutoEnableIO": { "Value": true }, "DryRun": true, "VolumeId": "vol-1234567890abcdef0" }, "output": { }, "comments": { "input": { }, "output": { } }, "description": "This example sets the ``autoEnableIo`` attribute of the volume with the ID ``vol-1234567890abcdef0`` to ``true``. If the command succeeds, no output is returned.", "id": "to-modify-a-volume-attribute-1472508596749", "title": "To modify a volume attribute" } ], "ModifyVpcAttribute": [ { "input": { "EnableDnsSupport": { "Value": false }, "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example modifies the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for instances in the VPC to their corresponding IP addresses; otherwise, it does not.", "id": "ec2-modify-vpc-attribute-1", "title": "To modify the enableDnsSupport attribute" }, { "input": { "EnableDnsHostnames": { "Value": false }, "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example modifies the enableDnsHostnames attribute. This attribute indicates whether instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.", "id": "ec2-modify-vpc-attribute-2", "title": "To modify the enableDnsHostnames attribute" } ], "MoveAddressToVpc": [ { "input": { "PublicIp": "54.123.4.56" }, "output": { "Status": "MoveInProgress" }, "comments": { "input": { }, "output": { } }, "description": "This example moves the specified Elastic IP address to the EC2-VPC platform.", "id": "ec2-move-address-to-vpc-1", "title": "To move an address to EC2-VPC" } ], "PurchaseScheduledInstances": [ { "input": { "PurchaseRequests": [ { "InstanceCount": 1, "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi..." } ] }, "output": { "ScheduledInstanceSet": [ { "AvailabilityZone": "us-west-2b", "CreateDate": "2016-01-25T21:43:38.612Z", "HourlyPrice": "0.095", "InstanceCount": 1, "InstanceType": "c4.large", "NetworkPlatform": "EC2-VPC", "NextSlotStartTime": "2016-01-31T09:00:00Z", "Platform": "Linux/UNIX", "Recurrence": { "Frequency": "Weekly", "Interval": 1, "OccurrenceDaySet": [ 1 ], "OccurrenceRelativeToEnd": false, "OccurrenceUnit": "" }, "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012", "SlotDurationInHours": 32, "TermEndDate": "2017-01-31T09:00:00Z", "TermStartDate": "2016-01-31T09:00:00Z", "TotalScheduledInstanceHours": 1696 } ] }, "comments": { "input": { }, "output": { } }, "description": "This example purchases a Scheduled Instance.", "id": "ec2-purchase-scheduled-instances-1", "title": "To purchase a Scheduled Instance" } ], "ReleaseAddress": [ { "input": { "AllocationId": "eipalloc-64d5890a" }, "comments": { "input": { }, "output": { } }, "description": "This example releases an Elastic IP address for use with instances in a VPC.", "id": "ec2-release-address-1", "title": "To release an Elastic IP address for EC2-VPC" }, { "input": { "PublicIp": "198.51.100.0" }, "comments": { "input": { }, "output": { } }, "description": "This example releases an Elastic IP address for use with instances in EC2-Classic.", "id": "ec2-release-address-2", "title": "To release an Elastic IP addresses for EC2-Classic" } ], "ReplaceNetworkAclAssociation": [ { "input": { "AssociationId": "aclassoc-e5b95c8c", "NetworkAclId": "acl-5fb85d36" }, "output": { "NewAssociationId": "aclassoc-3999875b" }, "comments": { "input": { }, "output": { } }, "description": "This example associates the specified network ACL with the subnet for the specified network ACL association.", "id": "ec2-replace-network-acl-association-1", "title": "To replace the network ACL associated with a subnet" } ], "ReplaceNetworkAclEntry": [ { "input": { "CidrBlock": "203.0.113.12/24", "Egress": false, "NetworkAclId": "acl-5fb85d36", "PortRange": { "From": 53, "To": 53 }, "Protocol": "udp", "RuleAction": "allow", "RuleNumber": 100 }, "comments": { "input": { }, "output": { } }, "description": "This example replaces an entry for the specified network ACL. The new rule 100 allows ingress traffic from 203.0.113.12/24 on UDP port 53 (DNS) into any associated subnet.", "id": "ec2-replace-network-acl-entry-1", "title": "To replace a network ACL entry" } ], "ReplaceRoute": [ { "input": { "DestinationCidrBlock": "10.0.0.0/16", "GatewayId": "vgw-9a4cacf3", "RouteTableId": "rtb-22574640" }, "comments": { "input": { }, "output": { } }, "description": "This example replaces the specified route in the specified table table. The new route matches the specified CIDR and sends the traffic to the specified virtual private gateway.", "id": "ec2-replace-route-1", "title": "To replace a route" } ], "ReplaceRouteTableAssociation": [ { "input": { "AssociationId": "rtbassoc-781d0d1a", "RouteTableId": "rtb-22574640" }, "output": { "NewAssociationId": "rtbassoc-3a1f0f58" }, "comments": { "input": { }, "output": { } }, "description": "This example associates the specified route table with the subnet for the specified route table association.", "id": "ec2-replace-route-table-association-1", "title": "To replace the route table associated with a subnet" } ], "RequestSpotFleet": [ { "input": { "SpotFleetRequestConfig": { "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", "LaunchSpecifications": [ { "IamInstanceProfile": { "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" }, "ImageId": "ami-1a2b3c4d", "InstanceType": "m3.medium", "KeyName": "my-key-pair", "SecurityGroups": [ { "GroupId": "sg-1a2b3c4d" } ], "SubnetId": "subnet-1a2b3c4d, subnet-3c4d5e6f" } ], "SpotPrice": "0.04", "TargetCapacity": 2 } }, "output": { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" }, "comments": { "input": { }, "output": { } }, "description": "This example creates a Spot fleet request with two launch specifications that differ only by subnet. The Spot fleet launches the instances in the specified subnet with the lowest price. If the instances are launched in a default VPC, they receive a public IP address by default. If the instances are launched in a nondefault VPC, they do not receive a public IP address by default. Note that you can't specify different subnets from the same Availability Zone in a Spot fleet request.", "id": "ec2-request-spot-fleet-1", "title": "To request a Spot fleet in the subnet with the lowest price" }, { "input": { "SpotFleetRequestConfig": { "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", "LaunchSpecifications": [ { "IamInstanceProfile": { "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" }, "ImageId": "ami-1a2b3c4d", "InstanceType": "m3.medium", "KeyName": "my-key-pair", "Placement": { "AvailabilityZone": "us-west-2a, us-west-2b" }, "SecurityGroups": [ { "GroupId": "sg-1a2b3c4d" } ] } ], "SpotPrice": "0.04", "TargetCapacity": 2 } }, "output": { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" }, "comments": { "input": { }, "output": { } }, "description": "This example creates a Spot fleet request with two launch specifications that differ only by Availability Zone. The Spot fleet launches the instances in the specified Availability Zone with the lowest price. If your account supports EC2-VPC only, Amazon EC2 launches the Spot instances in the default subnet of the Availability Zone. If your account supports EC2-Classic, Amazon EC2 launches the instances in EC2-Classic in the Availability Zone.", "id": "ec2-request-spot-fleet-2", "title": "To request a Spot fleet in the Availability Zone with the lowest price" }, { "input": { "SpotFleetRequestConfig": { "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", "LaunchSpecifications": [ { "IamInstanceProfile": { "Arn": "arn:aws:iam::880185128111:instance-profile/my-iam-role" }, "ImageId": "ami-1a2b3c4d", "InstanceType": "m3.medium", "KeyName": "my-key-pair", "NetworkInterfaces": [ { "AssociatePublicIpAddress": true, "DeviceIndex": 0, "Groups": [ "sg-1a2b3c4d" ], "SubnetId": "subnet-1a2b3c4d" } ] } ], "SpotPrice": "0.04", "TargetCapacity": 2 } }, "output": { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" }, "comments": { "input": { }, "output": { } }, "description": "This example assigns public addresses to instances launched in a nondefault VPC. Note that when you specify a network interface, you must include the subnet ID and security group ID using the network interface.", "id": "ec2-request-spot-fleet-3", "title": "To launch Spot instances in a subnet and assign them public IP addresses" }, { "input": { "SpotFleetRequestConfig": { "AllocationStrategy": "diversified", "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", "LaunchSpecifications": [ { "ImageId": "ami-1a2b3c4d", "InstanceType": "c4.2xlarge", "SubnetId": "subnet-1a2b3c4d" }, { "ImageId": "ami-1a2b3c4d", "InstanceType": "m3.2xlarge", "SubnetId": "subnet-1a2b3c4d" }, { "ImageId": "ami-1a2b3c4d", "InstanceType": "r3.2xlarge", "SubnetId": "subnet-1a2b3c4d" } ], "SpotPrice": "0.70", "TargetCapacity": 30 } }, "output": { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" }, "comments": { "input": { }, "output": { } }, "description": "This example creates a Spot fleet request that launches 30 instances using the diversified allocation strategy. The launch specifications differ by instance type. The Spot fleet distributes the instances across the launch specifications such that there are 10 instances of each type.", "id": "ec2-request-spot-fleet-4", "title": "To request a Spot fleet using the diversified allocation strategy" } ], "RequestSpotInstances": [ { "input": { "InstanceCount": 5, "LaunchSpecification": { "IamInstanceProfile": { "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" }, "ImageId": "ami-1a2b3c4d", "InstanceType": "m3.medium", "KeyName": "my-key-pair", "Placement": { "AvailabilityZone": "us-west-2a" }, "SecurityGroupIds": [ "sg-1a2b3c4d" ] }, "SpotPrice": "0.03", "Type": "one-time" }, "comments": { "input": { }, "output": { } }, "description": "This example creates a one-time Spot Instance request for five instances in the specified Availability Zone. If your account supports EC2-VPC only, Amazon EC2 launches the instances in the default subnet of the specified Availability Zone. If your account supports EC2-Classic, Amazon EC2 launches the instances in EC2-Classic in the specified Availability Zone.", "id": "ec2-request-spot-instances-1", "title": "To create a one-time Spot Instance request" }, { "input": { "InstanceCount": 5, "LaunchSpecification": { "IamInstanceProfile": { "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" }, "ImageId": "ami-1a2b3c4d", "InstanceType": "m3.medium", "SecurityGroupIds": [ "sg-1a2b3c4d" ], "SubnetId": "subnet-1a2b3c4d" }, "SpotPrice": "0.050", "Type": "one-time" }, "comments": { "input": { }, "output": { } }, "description": "This example command creates a one-time Spot Instance request for five instances in the specified subnet. Amazon EC2 launches the instances in the specified subnet. If the VPC is a nondefault VPC, the instances do not receive a public IP address by default.", "id": "ec2-request-spot-instances-2", "title": "To create a one-time Spot Instance request" } ], "ResetSnapshotAttribute": [ { "input": { "Attribute": "createVolumePermission", "SnapshotId": "snap-1234567890abcdef0" }, "output": { }, "comments": { "input": { }, "output": { } }, "description": "This example resets the create volume permissions for snapshot ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.", "id": "to-reset-a-snapshot-attribute-1472508825735", "title": "To reset a snapshot attribute" } ], "RestoreAddressToClassic": [ { "input": { "PublicIp": "198.51.100.0" }, "output": { "PublicIp": "198.51.100.0", "Status": "MoveInProgress" }, "comments": { "input": { }, "output": { } }, "description": "This example restores the specified Elastic IP address to the EC2-Classic platform.", "id": "ec2-restore-address-to-classic-1", "title": "To restore an address to EC2-Classic" } ], "RunScheduledInstances": [ { "input": { "InstanceCount": 1, "LaunchSpecification": { "IamInstanceProfile": { "Name": "my-iam-role" }, "ImageId": "ami-12345678", "InstanceType": "c4.large", "KeyName": "my-key-pair", "NetworkInterfaces": [ { "AssociatePublicIpAddress": true, "DeviceIndex": 0, "Groups": [ "sg-12345678" ], "SubnetId": "subnet-12345678" } ] }, "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012" }, "output": { "InstanceIdSet": [ "i-1234567890abcdef0" ] }, "comments": { "input": { }, "output": { } }, "description": "This example launches the specified Scheduled Instance in a VPC.", "id": "ec2-run-scheduled-instances-1", "title": "To launch a Scheduled Instance in a VPC" }, { "input": { "InstanceCount": 1, "LaunchSpecification": { "IamInstanceProfile": { "Name": "my-iam-role" }, "ImageId": "ami-12345678", "InstanceType": "c4.large", "KeyName": "my-key-pair", "Placement": { "AvailabilityZone": "us-west-2b" }, "SecurityGroupIds": [ "sg-12345678" ] }, "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012" }, "output": { "InstanceIdSet": [ "i-1234567890abcdef0" ] }, "comments": { "input": { }, "output": { } }, "description": "This example launches the specified Scheduled Instance in EC2-Classic.", "id": "ec2-run-scheduled-instances-2", "title": "To launch a Scheduled Instance in EC2-Classic" } ], "UnassignPrivateIpAddresses": [ { "input": { "NetworkInterfaceId": "eni-e5aa89a3", "PrivateIpAddresses": [ "10.0.0.82" ] }, "comments": { "input": { }, "output": { } }, "description": "This example unassigns the specified private IP address from the specified network interface.", "id": "ec2-unassign-private-ip-addresses-1", "title": "To unassign a secondary private IP address from a network interface" } ] } } botocore-1.5.7/botocore/data/ec2/2016-11-15/waiters-2.json0000777454262600001440000003415413042511306023357 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "InstanceExists": { "delay": 5, "maxAttempts": 40, "operation": "DescribeInstances", "acceptors": [ { "matcher": "path", "expected": true, "argument": "length(Reservations[]) > `0`", "state": "success" }, { "matcher": "error", "expected": "InvalidInstanceID.NotFound", "state": "retry" } ] }, "BundleTaskComplete": { "delay": 15, "operation": "DescribeBundleTasks", "maxAttempts": 40, "acceptors": [ { "expected": "complete", "matcher": "pathAll", "state": "success", "argument": "BundleTasks[].State" }, { "expected": "failed", "matcher": "pathAny", "state": "failure", "argument": "BundleTasks[].State" } ] }, "ConversionTaskCancelled": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "cancelled", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" } ] }, "ConversionTaskCompleted": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" }, { "expected": "cancelled", "matcher": "pathAny", "state": "failure", "argument": "ConversionTasks[].State" }, { "expected": "cancelling", "matcher": "pathAny", "state": "failure", "argument": "ConversionTasks[].State" } ] }, "ConversionTaskDeleted": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" } ] }, "CustomerGatewayAvailable": { "delay": 15, "operation": "DescribeCustomerGateways", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "CustomerGateways[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "CustomerGateways[].State" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "CustomerGateways[].State" } ] }, "ExportTaskCancelled": { "delay": 15, "operation": "DescribeExportTasks", "maxAttempts": 40, "acceptors": [ { "expected": "cancelled", "matcher": "pathAll", "state": "success", "argument": "ExportTasks[].State" } ] }, "ExportTaskCompleted": { "delay": 15, "operation": "DescribeExportTasks", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "ExportTasks[].State" } ] }, "ImageExists": { "operation": "DescribeImages", "maxAttempts": 40, "delay": 15, "acceptors": [ { "matcher": "path", "expected": true, "argument": "length(Images[]) > `0`", "state": "success" }, { "matcher": "error", "expected": "InvalidAMIID.NotFound", "state": "retry" } ] }, "ImageAvailable": { "operation": "DescribeImages", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "Images[].State", "expected": "available" }, { "state": "failure", "matcher": "pathAny", "argument": "Images[].State", "expected": "failed" } ] }, "InstanceRunning": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "running", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "shutting-down", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "matcher": "error", "expected": "InvalidInstanceID.NotFound", "state": "retry" } ] }, "InstanceStatusOk": { "operation": "DescribeInstanceStatus", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "InstanceStatuses[].InstanceStatus.Status", "expected": "ok" }, { "matcher": "error", "expected": "InvalidInstanceID.NotFound", "state": "retry" } ] }, "InstanceStopped": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "stopped", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "InstanceTerminated": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "terminated", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "NatGatewayAvailable": { "operation": "DescribeNatGateways", "delay": 15, "maxAttempts": 40, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "NatGateways[].State", "expected": "available" }, { "state": "failure", "matcher": "pathAny", "argument": "NatGateways[].State", "expected": "failed" }, { "state": "failure", "matcher": "pathAny", "argument": "NatGateways[].State", "expected": "deleting" }, { "state": "failure", "matcher": "pathAny", "argument": "NatGateways[].State", "expected": "deleted" }, { "state": "retry", "matcher": "error", "expected": "NatGatewayNotFound" } ] }, "NetworkInterfaceAvailable": { "operation": "DescribeNetworkInterfaces", "delay": 20, "maxAttempts": 10, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "NetworkInterfaces[].Status" }, { "expected": "InvalidNetworkInterfaceID.NotFound", "matcher": "error", "state": "failure" } ] }, "PasswordDataAvailable": { "operation": "GetPasswordData", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "path", "argument": "length(PasswordData) > `0`", "expected": true } ] }, "SnapshotCompleted": { "delay": 15, "operation": "DescribeSnapshots", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "Snapshots[].State" } ] }, "SpotInstanceRequestFulfilled": { "operation": "DescribeSpotInstanceRequests", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "SpotInstanceRequests[].Status.Code", "expected": "fulfilled" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "schedule-expired" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "canceled-before-fulfillment" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "bad-parameters" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "system-error" } ] }, "SubnetAvailable": { "delay": 15, "operation": "DescribeSubnets", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Subnets[].State" } ] }, "SystemStatusOk": { "operation": "DescribeInstanceStatus", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "InstanceStatuses[].SystemStatus.Status", "expected": "ok" } ] }, "VolumeAvailable": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Volumes[].State" } ] }, "VolumeDeleted": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "matcher": "error", "expected": "InvalidVolume.NotFound", "state": "success" } ] }, "VolumeInUse": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "in-use", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Volumes[].State" } ] }, "VpcAvailable": { "delay": 15, "operation": "DescribeVpcs", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Vpcs[].State" } ] }, "VpcExists": { "operation": "DescribeVpcs", "delay": 1, "maxAttempts": 5, "acceptors": [ { "matcher": "status", "expected": 200, "state": "success" }, { "matcher": "error", "expected": "InvalidVpcID.NotFound", "state": "retry" } ] }, "VpnConnectionAvailable": { "delay": 15, "operation": "DescribeVpnConnections", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "VpnConnections[].State" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" } ] }, "VpnConnectionDeleted": { "delay": 15, "operation": "DescribeVpnConnections", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "VpnConnections[].State" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" } ] }, "VpcPeeringConnectionExists": { "delay": 15, "operation": "DescribeVpcPeeringConnections", "maxAttempts": 40, "acceptors": [ { "matcher": "status", "expected": 200, "state": "success" }, { "matcher": "error", "expected": "InvalidVpcPeeringConnectionID.NotFound", "state": "retry" } ] } } } botocore-1.5.7/botocore/data/ec2/2016-11-15/paginators-1.json0000666454262600001440000000340113042511306024033 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeInstanceStatus": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "InstanceStatuses" }, "DescribeInstances": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Reservations" }, "DescribeReservedInstancesOfferings": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "ReservedInstancesOfferings" }, "DescribeReservedInstancesModifications": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "ReservedInstancesModifications" }, "DescribeSnapshots": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Snapshots" }, "DescribeSpotFleetRequests": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "SpotFleetRequestConfigs" }, "DescribeSpotPriceHistory": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "SpotPriceHistory" }, "DescribeTags": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Tags" }, "DescribeVolumeStatus": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "VolumeStatuses" }, "DescribeVolumes": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Volumes" } } } botocore-1.5.7/botocore/data/ec2/2016-11-15/service-2.json0000777454262600001440000343554713042511307023360 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-11-15", "endpointPrefix":"ec2", "protocol":"ec2", "serviceAbbreviation":"Amazon EC2", "serviceFullName":"Amazon Elastic Compute Cloud", "signatureVersion":"v4", "uid":"ec2-2016-11-15", "xmlNamespace":"http://ec2.amazonaws.com/doc/2016-11-15" }, "operations":{ "AcceptReservedInstancesExchangeQuote":{ "name":"AcceptReservedInstancesExchangeQuote", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AcceptReservedInstancesExchangeQuoteRequest"}, "output":{"shape":"AcceptReservedInstancesExchangeQuoteResult"}, "documentation":"

Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.

" }, "AcceptVpcPeeringConnection":{ "name":"AcceptVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, "output":{"shape":"AcceptVpcPeeringConnectionResult"}, "documentation":"

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.

" }, "AllocateAddress":{ "name":"AllocateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AllocateAddressRequest"}, "output":{"shape":"AllocateAddressResult"}, "documentation":"

Acquires an Elastic IP address.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" }, "AllocateHosts":{ "name":"AllocateHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AllocateHostsRequest"}, "output":{"shape":"AllocateHostsResult"}, "documentation":"

Allocates a Dedicated Host to your account. At minimum you need to specify the instance size type, Availability Zone, and quantity of hosts you want to allocate.

" }, "AssignIpv6Addresses":{ "name":"AssignIpv6Addresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssignIpv6AddressesRequest"}, "output":{"shape":"AssignIpv6AddressesResult"}, "documentation":"

Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

" }, "AssignPrivateIpAddresses":{ "name":"AssignPrivateIpAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssignPrivateIpAddressesRequest"}, "documentation":"

Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

AssignPrivateIpAddresses is available only in EC2-VPC.

" }, "AssociateAddress":{ "name":"AssociateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateAddressRequest"}, "output":{"shape":"AssociateAddressResult"}, "documentation":"

Associates an Elastic IP address with an instance or a network interface.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.

" }, "AssociateDhcpOptions":{ "name":"AssociateDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateDhcpOptionsRequest"}, "documentation":"

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "AssociateRouteTable":{ "name":"AssociateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateRouteTableRequest"}, "output":{"shape":"AssociateRouteTableResult"}, "documentation":"

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "AssociateSubnetCidrBlock":{ "name":"AssociateSubnetCidrBlock", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateSubnetCidrBlockRequest"}, "output":{"shape":"AssociateSubnetCidrBlockResult"}, "documentation":"

Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64.

" }, "AssociateVpcCidrBlock":{ "name":"AssociateVpcCidrBlock", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateVpcCidrBlockRequest"}, "output":{"shape":"AssociateVpcCidrBlockResult"}, "documentation":"

Associates a CIDR block with your VPC. You can only associate a single Amazon-provided IPv6 CIDR block with your VPC. The IPv6 CIDR block size is fixed at /56.

" }, "AttachClassicLinkVpc":{ "name":"AttachClassicLinkVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachClassicLinkVpcRequest"}, "output":{"shape":"AttachClassicLinkVpcResult"}, "documentation":"

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" }, "AttachInternetGateway":{ "name":"AttachInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachInternetGatewayRequest"}, "documentation":"

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" }, "AttachNetworkInterface":{ "name":"AttachNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachNetworkInterfaceRequest"}, "output":{"shape":"AttachNetworkInterfaceResult"}, "documentation":"

Attaches a network interface to an instance.

" }, "AttachVolume":{ "name":"AttachVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachVolumeRequest"}, "output":{"shape":"VolumeAttachment"}, "documentation":"

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For a list of supported device names, see Attaching an EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.

  • AWS Marketplace product codes are copied from the volume to the instance.

  • You must be subscribed to the product.

  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For an overview of the AWS Marketplace, see Introducing AWS Marketplace.

For more information about EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "AttachVpnGateway":{ "name":"AttachVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachVpnGatewayRequest"}, "output":{"shape":"AttachVpnGatewayResult"}, "documentation":"

Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "AuthorizeSecurityGroupEgress":{ "name":"AuthorizeSecurityGroupEgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, "documentation":"

[EC2-VPC only] Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination IPv4 or IPv6 CIDR address ranges, or to one or more destination security groups for the same VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide. For more information about security group limits, see Amazon VPC Limits.

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

" }, "AuthorizeSecurityGroupIngress":{ "name":"AuthorizeSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, "documentation":"

Adds one or more ingress rules to a security group.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

[EC2-Classic] This action gives one or more IPv4 CIDR address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another. You can have up to 100 rules per group.

[EC2-VPC] This action gives one or more IPv4 or IPv6 CIDR address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC or a peer VPC in a VPC peering connection. For more information about VPC security group limits, see Amazon VPC Limits.

" }, "BundleInstance":{ "name":"BundleInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BundleInstanceRequest"}, "output":{"shape":"BundleInstanceResult"}, "documentation":"

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

For more information, see Creating an Instance Store-Backed Windows AMI.

" }, "CancelBundleTask":{ "name":"CancelBundleTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelBundleTaskRequest"}, "output":{"shape":"CancelBundleTaskResult"}, "documentation":"

Cancels a bundling operation for an instance store-backed Windows instance.

" }, "CancelConversionTask":{ "name":"CancelConversionTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelConversionRequest"}, "documentation":"

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

" }, "CancelExportTask":{ "name":"CancelExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelExportTaskRequest"}, "documentation":"

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" }, "CancelImportTask":{ "name":"CancelImportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelImportTaskRequest"}, "output":{"shape":"CancelImportTaskResult"}, "documentation":"

Cancels an in-process import virtual machine or import snapshot task.

" }, "CancelReservedInstancesListing":{ "name":"CancelReservedInstancesListing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelReservedInstancesListingRequest"}, "output":{"shape":"CancelReservedInstancesListingResult"}, "documentation":"

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "CancelSpotFleetRequests":{ "name":"CancelSpotFleetRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelSpotFleetRequestsRequest"}, "output":{"shape":"CancelSpotFleetRequestsResponse"}, "documentation":"

Cancels the specified Spot fleet requests.

After you cancel a Spot fleet request, the Spot fleet launches no new Spot instances. You must specify whether the Spot fleet should also terminate its Spot instances. If you terminate the instances, the Spot fleet request enters the cancelled_terminating state. Otherwise, the Spot fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.

" }, "CancelSpotInstanceRequests":{ "name":"CancelSpotInstanceRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelSpotInstanceRequestsRequest"}, "output":{"shape":"CancelSpotInstanceRequestsResult"}, "documentation":"

Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

Canceling a Spot instance request does not terminate running Spot instances associated with the request.

" }, "ConfirmProductInstance":{ "name":"ConfirmProductInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmProductInstanceRequest"}, "output":{"shape":"ConfirmProductInstanceResult"}, "documentation":"

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.

" }, "CopyImage":{ "name":"CopyImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyImageRequest"}, "output":{"shape":"CopyImageResult"}, "documentation":"

Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide.

" }, "CopySnapshot":{ "name":"CopySnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopySnapshotRequest"}, "output":{"shape":"CopySnapshotResult"}, "documentation":"

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the KmsKeyId parameter.

To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.

Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateCustomerGateway":{ "name":"CreateCustomerGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCustomerGatewayRequest"}, "output":{"shape":"CreateCustomerGatewayResult"}, "documentation":"

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.

" }, "CreateDhcpOptions":{ "name":"CreateDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDhcpOptionsRequest"}, "output":{"shape":"CreateDhcpOptionsResult"}, "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. If you want your instance to receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.

  • domain-name - If you're using AmazonProvidedDNS in \"us-east-1\", specify \"ec2.internal\". If you're using AmazonProvidedDNS in another region, specify \"region.compute.internal\" (for example, \"ap-northeast-1.compute.internal\"). Otherwise, specify a domain name (for example, \"MyCompany.com\"). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.

  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.

  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.

  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateEgressOnlyInternetGateway":{ "name":"CreateEgressOnlyInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateEgressOnlyInternetGatewayRequest"}, "output":{"shape":"CreateEgressOnlyInternetGatewayResult"}, "documentation":"

[IPv6 only] Creates an egress-only Internet gateway for your VPC. An egress-only Internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the Internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.

" }, "CreateFlowLogs":{ "name":"CreateFlowLogs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateFlowLogsRequest"}, "output":{"shape":"CreateFlowLogsResult"}, "documentation":"

Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs.

In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs.

" }, "CreateImage":{ "name":"CreateImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateImageRequest"}, "output":{"shape":"CreateImageResult"}, "documentation":"

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateInstanceExportTask":{ "name":"CreateInstanceExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInstanceExportTaskRequest"}, "output":{"shape":"CreateInstanceExportTaskResult"}, "documentation":"

Exports a running or stopped instance to an S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide.

" }, "CreateInternetGateway":{ "name":"CreateInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInternetGatewayRequest"}, "output":{"shape":"CreateInternetGatewayResult"}, "documentation":"

Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" }, "CreateKeyPair":{ "name":"CreateKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateKeyPairRequest"}, "output":{"shape":"KeyPair"}, "documentation":"

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateNatGateway":{ "name":"CreateNatGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNatGatewayRequest"}, "output":{"shape":"CreateNatGatewayResult"}, "documentation":"

Creates a NAT gateway in the specified subnet. A NAT gateway can be used to enable instances in a private subnet to connect to the Internet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkAcl":{ "name":"CreateNetworkAcl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkAclRequest"}, "output":{"shape":"CreateNetworkAclResult"}, "documentation":"

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkAclEntry":{ "name":"CreateNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkAclEntryRequest"}, "documentation":"

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkInterface":{ "name":"CreateNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkInterfaceRequest"}, "output":{"shape":"CreateNetworkInterfaceResult"}, "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.

" }, "CreatePlacementGroup":{ "name":"CreatePlacementGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlacementGroupRequest"}, "documentation":"

Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.

For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateReservedInstancesListing":{ "name":"CreateReservedInstancesListing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateReservedInstancesListingRequest"}, "output":{"shape":"CreateReservedInstancesListingResult"}, "documentation":"

Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.

Only Standard Reserved Instances with a capacity reservation can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances and Standard Reserved Instances with a regional benefit cannot be sold.

The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateRoute":{ "name":"CreateRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRouteRequest"}, "output":{"shape":"CreateRouteResult"}, "documentation":"

Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only Internet gateway.

When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "CreateRouteTable":{ "name":"CreateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRouteTableRequest"}, "output":{"shape":"CreateRouteTableResult"}, "documentation":"

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "CreateSecurityGroup":{ "name":"CreateSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSecurityGroupRequest"}, "output":{"shape":"CreateSecurityGroupResult"}, "documentation":"

Creates a security group.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

EC2-Classic: You can have up to 500 security groups.

EC2-VPC: You can create up to 500 security groups per VPC.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

" }, "CreateSnapshot":{ "name":"CreateSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSnapshotRequest"}, "output":{"shape":"Snapshot"}, "documentation":"

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateSpotDatafeedSubscription":{ "name":"CreateSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, "documentation":"

Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateSubnet":{ "name":"CreateSubnet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSubnetRequest"}, "output":{"shape":"CreateSubnetResult"}, "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's IPv4 CIDR block can be the same as the VPC's IPv4 CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's IPv4 CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest IPv4 subnet (and VPC) you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses).

If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.

AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateTags":{ "name":"CreateTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTagsRequest"}, "documentation":"

Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateVolume":{ "name":"CreateVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVolumeRequest"}, "output":{"shape":"Volume"}, "documentation":"

Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateVpc":{ "name":"CreateVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcRequest"}, "output":{"shape":"CreateVpcResult"}, "documentation":"

Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

You can optionally request an Amazon-provided IPv6 CIDR block for the VPC. The IPv6 CIDR block uses a /56 prefix length, and is allocated from Amazon's pool of IPv6 addresses. You cannot choose the IPv6 range for your VPC.

By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateVpcEndpoint":{ "name":"CreateVpcEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcEndpointRequest"}, "output":{"shape":"CreateVpcEndpointResult"}, "documentation":"

Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.

Use DescribeVpcEndpointServices to get a list of supported AWS services.

" }, "CreateVpcPeeringConnection":{ "name":"CreateVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcPeeringConnectionRequest"}, "output":{"shape":"CreateVpcPeeringConnectionResult"}, "documentation":"

Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.

The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.

" }, "CreateVpnConnection":{ "name":"CreateVpnConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnConnectionRequest"}, "output":{"shape":"CreateVpnConnectionResult"}, "documentation":"

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpnConnectionRoute":{ "name":"CreateVpnConnectionRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnConnectionRouteRequest"}, "documentation":"

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpnGateway":{ "name":"CreateVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnGatewayRequest"}, "output":{"shape":"CreateVpnGatewayResult"}, "documentation":"

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DeleteCustomerGateway":{ "name":"DeleteCustomerGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCustomerGatewayRequest"}, "documentation":"

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" }, "DeleteDhcpOptions":{ "name":"DeleteDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDhcpOptionsRequest"}, "documentation":"

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" }, "DeleteEgressOnlyInternetGateway":{ "name":"DeleteEgressOnlyInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteEgressOnlyInternetGatewayRequest"}, "output":{"shape":"DeleteEgressOnlyInternetGatewayResult"}, "documentation":"

Deletes an egress-only Internet gateway.

" }, "DeleteFlowLogs":{ "name":"DeleteFlowLogs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteFlowLogsRequest"}, "output":{"shape":"DeleteFlowLogsResult"}, "documentation":"

Deletes one or more flow logs.

" }, "DeleteInternetGateway":{ "name":"DeleteInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteInternetGatewayRequest"}, "documentation":"

Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.

" }, "DeleteKeyPair":{ "name":"DeleteKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteKeyPairRequest"}, "documentation":"

Deletes the specified key pair, by removing the public key from Amazon EC2.

" }, "DeleteNatGateway":{ "name":"DeleteNatGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNatGatewayRequest"}, "output":{"shape":"DeleteNatGatewayResult"}, "documentation":"

Deletes the specified NAT gateway. Deleting a NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.

" }, "DeleteNetworkAcl":{ "name":"DeleteNetworkAcl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkAclRequest"}, "documentation":"

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" }, "DeleteNetworkAclEntry":{ "name":"DeleteNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkAclEntryRequest"}, "documentation":"

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" }, "DeleteNetworkInterface":{ "name":"DeleteNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkInterfaceRequest"}, "documentation":"

Deletes the specified network interface. You must detach the network interface before you can delete it.

" }, "DeletePlacementGroup":{ "name":"DeletePlacementGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePlacementGroupRequest"}, "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteRoute":{ "name":"DeleteRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRouteRequest"}, "documentation":"

Deletes the specified route from the specified route table.

" }, "DeleteRouteTable":{ "name":"DeleteRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRouteTableRequest"}, "documentation":"

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" }, "DeleteSecurityGroup":{ "name":"DeleteSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSecurityGroupRequest"}, "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" }, "DeleteSnapshot":{ "name":"DeleteSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSnapshotRequest"}, "documentation":"

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteSpotDatafeedSubscription":{ "name":"DeleteSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSpotDatafeedSubscriptionRequest"}, "documentation":"

Deletes the data feed for Spot instances.

" }, "DeleteSubnet":{ "name":"DeleteSubnet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSubnetRequest"}, "documentation":"

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsRequest"}, "documentation":"

Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteVolume":{ "name":"DeleteVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVolumeRequest"}, "documentation":"

Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).

The volume may remain in the deleting state for several minutes.

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteVpc":{ "name":"DeleteVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcRequest"}, "documentation":"

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" }, "DeleteVpcEndpoints":{ "name":"DeleteVpcEndpoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcEndpointsRequest"}, "output":{"shape":"DeleteVpcEndpointsResult"}, "documentation":"

Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint.

" }, "DeleteVpcPeeringConnection":{ "name":"DeleteVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, "output":{"shape":"DeleteVpcPeeringConnectionResult"}, "documentation":"

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.

" }, "DeleteVpnConnection":{ "name":"DeleteVpnConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnConnectionRequest"}, "documentation":"

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" }, "DeleteVpnConnectionRoute":{ "name":"DeleteVpnConnectionRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnConnectionRouteRequest"}, "documentation":"

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" }, "DeleteVpnGateway":{ "name":"DeleteVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnGatewayRequest"}, "documentation":"

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" }, "DeregisterImage":{ "name":"DeregisterImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterImageRequest"}, "documentation":"

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

This command does not delete the AMI.

" }, "DescribeAccountAttributes":{ "name":"DescribeAccountAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAccountAttributesRequest"}, "output":{"shape":"DescribeAccountAttributesResult"}, "documentation":"

Describes attributes of your AWS account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: The maximum number of On-Demand instances that you can run.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

" }, "DescribeAddresses":{ "name":"DescribeAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAddressesRequest"}, "output":{"shape":"DescribeAddressesResult"}, "documentation":"

Describes one or more of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeAvailabilityZones":{ "name":"DescribeAvailabilityZones", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAvailabilityZonesRequest"}, "output":{"shape":"DescribeAvailabilityZonesResult"}, "documentation":"

Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeBundleTasks":{ "name":"DescribeBundleTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeBundleTasksRequest"}, "output":{"shape":"DescribeBundleTasksResult"}, "documentation":"

Describes one or more of your bundling tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

" }, "DescribeClassicLinkInstances":{ "name":"DescribeClassicLinkInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClassicLinkInstancesRequest"}, "output":{"shape":"DescribeClassicLinkInstancesResult"}, "documentation":"

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.

" }, "DescribeConversionTasks":{ "name":"DescribeConversionTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConversionTasksRequest"}, "output":{"shape":"DescribeConversionTasksResult"}, "documentation":"

Describes one or more of your conversion tasks. For more information, see the VM Import/Export User Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" }, "DescribeCustomerGateways":{ "name":"DescribeCustomerGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCustomerGatewaysRequest"}, "output":{"shape":"DescribeCustomerGatewaysResult"}, "documentation":"

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeDhcpOptions":{ "name":"DescribeDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDhcpOptionsRequest"}, "output":{"shape":"DescribeDhcpOptionsResult"}, "documentation":"

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeEgressOnlyInternetGateways":{ "name":"DescribeEgressOnlyInternetGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEgressOnlyInternetGatewaysRequest"}, "output":{"shape":"DescribeEgressOnlyInternetGatewaysResult"}, "documentation":"

Describes one or more of your egress-only Internet gateways.

" }, "DescribeExportTasks":{ "name":"DescribeExportTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeExportTasksRequest"}, "output":{"shape":"DescribeExportTasksResult"}, "documentation":"

Describes one or more of your export tasks.

" }, "DescribeFlowLogs":{ "name":"DescribeFlowLogs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFlowLogsRequest"}, "output":{"shape":"DescribeFlowLogsResult"}, "documentation":"

Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.

" }, "DescribeHostReservationOfferings":{ "name":"DescribeHostReservationOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHostReservationOfferingsRequest"}, "output":{"shape":"DescribeHostReservationOfferingsResult"}, "documentation":"

Describes the Dedicated Host Reservations that are available to purchase.

The results describe all the Dedicated Host Reservation offerings, including offerings that may not match the instance family and region of your Dedicated Hosts. When purchasing an offering, ensure that the the instance family and region of the offering matches that of the Dedicated Host/s it will be associated with. For an overview of supported instance types, see Dedicated Hosts Overview in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeHostReservations":{ "name":"DescribeHostReservations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHostReservationsRequest"}, "output":{"shape":"DescribeHostReservationsResult"}, "documentation":"

Describes Dedicated Host Reservations which are associated with Dedicated Hosts in your account.

" }, "DescribeHosts":{ "name":"DescribeHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHostsRequest"}, "output":{"shape":"DescribeHostsResult"}, "documentation":"

Describes one or more of your Dedicated Hosts.

The results describe only the Dedicated Hosts in the region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released will be listed with the state released.

" }, "DescribeIdFormat":{ "name":"DescribeIdFormat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeIdFormatRequest"}, "output":{"shape":"DescribeIdFormatResult"}, "documentation":"

Describes the ID format settings for your resources on a per-region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.

The following resource types support longer IDs: instance | reservation | snapshot | volume.

These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" }, "DescribeIdentityIdFormat":{ "name":"DescribeIdentityIdFormat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeIdentityIdFormatRequest"}, "output":{"shape":"DescribeIdentityIdFormatResult"}, "documentation":"

Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

The following resource types support longer IDs: instance | reservation | snapshot | volume.

These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.

" }, "DescribeImageAttribute":{ "name":"DescribeImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImageAttributeRequest"}, "output":{"shape":"ImageAttribute"}, "documentation":"

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" }, "DescribeImages":{ "name":"DescribeImages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImagesRequest"}, "output":{"shape":"DescribeImagesResult"}, "documentation":"

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

Deregistered images are included in the returned results for an unspecified interval after deregistration.

" }, "DescribeImportImageTasks":{ "name":"DescribeImportImageTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImportImageTasksRequest"}, "output":{"shape":"DescribeImportImageTasksResult"}, "documentation":"

Displays details about an import virtual machine or import snapshot tasks that are already created.

" }, "DescribeImportSnapshotTasks":{ "name":"DescribeImportSnapshotTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImportSnapshotTasksRequest"}, "output":{"shape":"DescribeImportSnapshotTasksResult"}, "documentation":"

Describes your import snapshot tasks.

" }, "DescribeInstanceAttribute":{ "name":"DescribeInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceAttributeRequest"}, "output":{"shape":"InstanceAttribute"}, "documentation":"

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" }, "DescribeInstanceStatus":{ "name":"DescribeInstanceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceStatusRequest"}, "output":{"shape":"DescribeInstanceStatusResult"}, "documentation":"

Describes the status of one or more instances. By default, only running instances are described, unless specified otherwise.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeInstances":{ "name":"DescribeInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancesRequest"}, "output":{"shape":"DescribeInstancesResult"}, "documentation":"

Describes one or more of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.

" }, "DescribeInternetGateways":{ "name":"DescribeInternetGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInternetGatewaysRequest"}, "output":{"shape":"DescribeInternetGatewaysResult"}, "documentation":"

Describes one or more of your Internet gateways.

" }, "DescribeKeyPairs":{ "name":"DescribeKeyPairs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeKeyPairsRequest"}, "output":{"shape":"DescribeKeyPairsResult"}, "documentation":"

Describes one or more of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeMovingAddresses":{ "name":"DescribeMovingAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMovingAddressesRequest"}, "output":{"shape":"DescribeMovingAddressesResult"}, "documentation":"

Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

" }, "DescribeNatGateways":{ "name":"DescribeNatGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNatGatewaysRequest"}, "output":{"shape":"DescribeNatGatewaysResult"}, "documentation":"

Describes one or more of the your NAT gateways.

" }, "DescribeNetworkAcls":{ "name":"DescribeNetworkAcls", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkAclsRequest"}, "output":{"shape":"DescribeNetworkAclsResult"}, "documentation":"

Describes one or more of your network ACLs.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeNetworkInterfaceAttribute":{ "name":"DescribeNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, "documentation":"

Describes a network interface attribute. You can specify only one attribute at a time.

" }, "DescribeNetworkInterfaces":{ "name":"DescribeNetworkInterfaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkInterfacesRequest"}, "output":{"shape":"DescribeNetworkInterfacesResult"}, "documentation":"

Describes one or more of your network interfaces.

" }, "DescribePlacementGroups":{ "name":"DescribePlacementGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePlacementGroupsRequest"}, "output":{"shape":"DescribePlacementGroupsResult"}, "documentation":"

Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribePrefixLists":{ "name":"DescribePrefixLists", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePrefixListsRequest"}, "output":{"shape":"DescribePrefixListsResult"}, "documentation":"

Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a VPC endpoint.

" }, "DescribeRegions":{ "name":"DescribeRegions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRegionsRequest"}, "output":{"shape":"DescribeRegionsResult"}, "documentation":"

Describes one or more regions that are currently available to you.

For a list of the regions supported by Amazon EC2, see Regions and Endpoints.

" }, "DescribeReservedInstances":{ "name":"DescribeReservedInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesRequest"}, "output":{"shape":"DescribeReservedInstancesResult"}, "documentation":"

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesListings":{ "name":"DescribeReservedInstancesListings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesListingsRequest"}, "output":{"shape":"DescribeReservedInstancesListingsResult"}, "documentation":"

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesModifications":{ "name":"DescribeReservedInstancesModifications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, "output":{"shape":"DescribeReservedInstancesModificationsResult"}, "documentation":"

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesOfferings":{ "name":"DescribeReservedInstancesOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, "documentation":"

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeRouteTables":{ "name":"DescribeRouteTables", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRouteTablesRequest"}, "output":{"shape":"DescribeRouteTablesResult"}, "documentation":"

Describes one or more of your route tables.

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeScheduledInstanceAvailability":{ "name":"DescribeScheduledInstanceAvailability", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeScheduledInstanceAvailabilityRequest"}, "output":{"shape":"DescribeScheduledInstanceAvailabilityResult"}, "documentation":"

Finds available schedules that meet the specified criteria.

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.

" }, "DescribeScheduledInstances":{ "name":"DescribeScheduledInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeScheduledInstancesRequest"}, "output":{"shape":"DescribeScheduledInstancesResult"}, "documentation":"

Describes one or more of your Scheduled Instances.

" }, "DescribeSecurityGroupReferences":{ "name":"DescribeSecurityGroupReferences", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSecurityGroupReferencesRequest"}, "output":{"shape":"DescribeSecurityGroupReferencesResult"}, "documentation":"

[EC2-VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.

" }, "DescribeSecurityGroups":{ "name":"DescribeSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSecurityGroupsRequest"}, "output":{"shape":"DescribeSecurityGroupsResult"}, "documentation":"

Describes one or more of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeSnapshotAttribute":{ "name":"DescribeSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotAttributeRequest"}, "output":{"shape":"DescribeSnapshotAttributeResult"}, "documentation":"

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSnapshots":{ "name":"DescribeSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotsRequest"}, "output":{"shape":"DescribeSnapshotsResult"}, "documentation":"

Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.

  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.

  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSpotDatafeedSubscription":{ "name":"DescribeSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, "documentation":"

Describes the data feed for Spot instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSpotFleetInstances":{ "name":"DescribeSpotFleetInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotFleetInstancesRequest"}, "output":{"shape":"DescribeSpotFleetInstancesResponse"}, "documentation":"

Describes the running instances for the specified Spot fleet.

" }, "DescribeSpotFleetRequestHistory":{ "name":"DescribeSpotFleetRequestHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotFleetRequestHistoryRequest"}, "output":{"shape":"DescribeSpotFleetRequestHistoryResponse"}, "documentation":"

Describes the events for the specified Spot fleet request during the specified time.

Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event.

" }, "DescribeSpotFleetRequests":{ "name":"DescribeSpotFleetRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotFleetRequestsRequest"}, "output":{"shape":"DescribeSpotFleetRequestsResponse"}, "documentation":"

Describes your Spot fleet requests.

Spot fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

" }, "DescribeSpotInstanceRequests":{ "name":"DescribeSpotInstanceRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, "output":{"shape":"DescribeSpotInstanceRequestsResult"}, "documentation":"

Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

You can use DescribeSpotInstanceRequests to find a running Spot instance by examining the response. If the status of the Spot instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

Spot instance requests are deleted 4 hours after they are canceled and their instances are terminated.

" }, "DescribeSpotPriceHistory":{ "name":"DescribeSpotPriceHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotPriceHistoryRequest"}, "output":{"shape":"DescribeSpotPriceHistoryResult"}, "documentation":"

Describes the Spot price history. For more information, see Spot Instance Pricing History in the Amazon Elastic Compute Cloud User Guide.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" }, "DescribeStaleSecurityGroups":{ "name":"DescribeStaleSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStaleSecurityGroupsRequest"}, "output":{"shape":"DescribeStaleSecurityGroupsResult"}, "documentation":"

[EC2-VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.

" }, "DescribeSubnets":{ "name":"DescribeSubnets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSubnetsRequest"}, "output":{"shape":"DescribeSubnetsResult"}, "documentation":"

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsRequest"}, "output":{"shape":"DescribeTagsResult"}, "documentation":"

Describes one or more of the tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVolumeAttribute":{ "name":"DescribeVolumeAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumeAttributeRequest"}, "output":{"shape":"DescribeVolumeAttributeResult"}, "documentation":"

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVolumeStatus":{ "name":"DescribeVolumeStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumeStatusRequest"}, "output":{"shape":"DescribeVolumeStatusResult"}, "documentation":"

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

" }, "DescribeVolumes":{ "name":"DescribeVolumes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumesRequest"}, "output":{"shape":"DescribeVolumesResult"}, "documentation":"

Describes the specified EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVpcAttribute":{ "name":"DescribeVpcAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcAttributeRequest"}, "output":{"shape":"DescribeVpcAttributeResult"}, "documentation":"

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" }, "DescribeVpcClassicLink":{ "name":"DescribeVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcClassicLinkRequest"}, "output":{"shape":"DescribeVpcClassicLinkResult"}, "documentation":"

Describes the ClassicLink status of one or more VPCs.

" }, "DescribeVpcClassicLinkDnsSupport":{ "name":"DescribeVpcClassicLinkDnsSupport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcClassicLinkDnsSupportRequest"}, "output":{"shape":"DescribeVpcClassicLinkDnsSupportResult"}, "documentation":"

Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVpcEndpointServices":{ "name":"DescribeVpcEndpointServices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcEndpointServicesRequest"}, "output":{"shape":"DescribeVpcEndpointServicesResult"}, "documentation":"

Describes all supported AWS services that can be specified when creating a VPC endpoint.

" }, "DescribeVpcEndpoints":{ "name":"DescribeVpcEndpoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcEndpointsRequest"}, "output":{"shape":"DescribeVpcEndpointsResult"}, "documentation":"

Describes one or more of your VPC endpoints.

" }, "DescribeVpcPeeringConnections":{ "name":"DescribeVpcPeeringConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, "documentation":"

Describes one or more of your VPC peering connections.

" }, "DescribeVpcs":{ "name":"DescribeVpcs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcsRequest"}, "output":{"shape":"DescribeVpcsResult"}, "documentation":"

Describes one or more of your VPCs.

" }, "DescribeVpnConnections":{ "name":"DescribeVpnConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpnConnectionsRequest"}, "output":{"shape":"DescribeVpnConnectionsResult"}, "documentation":"

Describes one or more of your VPN connections.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeVpnGateways":{ "name":"DescribeVpnGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpnGatewaysRequest"}, "output":{"shape":"DescribeVpnGatewaysResult"}, "documentation":"

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DetachClassicLinkVpc":{ "name":"DetachClassicLinkVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachClassicLinkVpcRequest"}, "output":{"shape":"DetachClassicLinkVpcResult"}, "documentation":"

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" }, "DetachInternetGateway":{ "name":"DetachInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachInternetGatewayRequest"}, "documentation":"

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.

" }, "DetachNetworkInterface":{ "name":"DetachNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachNetworkInterfaceRequest"}, "documentation":"

Detaches a network interface from an instance.

" }, "DetachVolume":{ "name":"DetachVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachVolumeRequest"}, "output":{"shape":"VolumeAttachment"}, "documentation":"

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "DetachVpnGateway":{ "name":"DetachVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachVpnGatewayRequest"}, "documentation":"

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" }, "DisableVgwRoutePropagation":{ "name":"DisableVgwRoutePropagation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVgwRoutePropagationRequest"}, "documentation":"

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" }, "DisableVpcClassicLink":{ "name":"DisableVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVpcClassicLinkRequest"}, "output":{"shape":"DisableVpcClassicLinkResult"}, "documentation":"

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

" }, "DisableVpcClassicLinkDnsSupport":{ "name":"DisableVpcClassicLinkDnsSupport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVpcClassicLinkDnsSupportRequest"}, "output":{"shape":"DisableVpcClassicLinkDnsSupportResult"}, "documentation":"

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "DisassociateAddress":{ "name":"DisassociateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateAddressRequest"}, "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" }, "DisassociateRouteTable":{ "name":"DisassociateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateRouteTableRequest"}, "documentation":"

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "DisassociateSubnetCidrBlock":{ "name":"DisassociateSubnetCidrBlock", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateSubnetCidrBlockRequest"}, "output":{"shape":"DisassociateSubnetCidrBlockResult"}, "documentation":"

Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.

" }, "DisassociateVpcCidrBlock":{ "name":"DisassociateVpcCidrBlock", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateVpcCidrBlockRequest"}, "output":{"shape":"DisassociateVpcCidrBlockResult"}, "documentation":"

Disassociates a CIDR block from a VPC. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.

" }, "EnableVgwRoutePropagation":{ "name":"EnableVgwRoutePropagation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVgwRoutePropagationRequest"}, "documentation":"

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" }, "EnableVolumeIO":{ "name":"EnableVolumeIO", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVolumeIORequest"}, "documentation":"

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" }, "EnableVpcClassicLink":{ "name":"EnableVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVpcClassicLinkRequest"}, "output":{"shape":"EnableVpcClassicLinkResult"}, "documentation":"

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "EnableVpcClassicLinkDnsSupport":{ "name":"EnableVpcClassicLinkDnsSupport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVpcClassicLinkDnsSupportRequest"}, "output":{"shape":"EnableVpcClassicLinkDnsSupportResult"}, "documentation":"

Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "GetConsoleOutput":{ "name":"GetConsoleOutput", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetConsoleOutputRequest"}, "output":{"shape":"GetConsoleOutputResult"}, "documentation":"

Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.

For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output includes output from the EC2Config service.

" }, "GetConsoleScreenshot":{ "name":"GetConsoleScreenshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetConsoleScreenshotRequest"}, "output":{"shape":"GetConsoleScreenshotResult"}, "documentation":"

Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.

The returned content is Base64-encoded.

" }, "GetHostReservationPurchasePreview":{ "name":"GetHostReservationPurchasePreview", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetHostReservationPurchasePreviewRequest"}, "output":{"shape":"GetHostReservationPurchasePreviewResult"}, "documentation":"

Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.

This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.

" }, "GetPasswordData":{ "name":"GetPasswordData", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPasswordDataRequest"}, "output":{"shape":"GetPasswordDataResult"}, "documentation":"

Retrieves the encrypted administrator password for an instance running Windows.

The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" }, "GetReservedInstancesExchangeQuote":{ "name":"GetReservedInstancesExchangeQuote", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetReservedInstancesExchangeQuoteRequest"}, "output":{"shape":"GetReservedInstancesExchangeQuoteResult"}, "documentation":"

Returns details about the values and term of your specified Convertible Reserved Instances. When a target configuration is specified, it returns information about whether the exchange is valid and can be performed.

" }, "ImportImage":{ "name":"ImportImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportImageRequest"}, "output":{"shape":"ImportImageResult"}, "documentation":"

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). For more information, see Importing a VM as an Image Using VM Import/Export in the VM Import/Export User Guide.

" }, "ImportInstance":{ "name":"ImportInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportInstanceRequest"}, "output":{"shape":"ImportInstanceResult"}, "documentation":"

Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" }, "ImportKeyPair":{ "name":"ImportKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportKeyPairRequest"}, "output":{"shape":"ImportKeyPairResult"}, "documentation":"

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "ImportSnapshot":{ "name":"ImportSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportSnapshotRequest"}, "output":{"shape":"ImportSnapshotResult"}, "documentation":"

Imports a disk into an EBS snapshot.

" }, "ImportVolume":{ "name":"ImportVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportVolumeRequest"}, "output":{"shape":"ImportVolumeResult"}, "documentation":"

Creates an import volume task using metadata from the specified disk image.For more information, see Importing Disks to Amazon EBS.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" }, "ModifyHosts":{ "name":"ModifyHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyHostsRequest"}, "output":{"shape":"ModifyHostsResult"}, "documentation":"

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, AWS will place instances that you launch with a tenancy of host, but without targeting a specific host ID, onto any available Dedicated Host in your account which has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID if you want the instance to launch onto a specific host. If no host ID is provided, the instance will be launched onto a suitable host which has auto-placement enabled.

" }, "ModifyIdFormat":{ "name":"ModifyIdFormat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyIdFormatRequest"}, "documentation":"

Modifies the ID format for the specified resource on a per-region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created. The following resource types support longer IDs: instance | reservation | snapshot | volume.

This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" }, "ModifyIdentityIdFormat":{ "name":"ModifyIdentityIdFormat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyIdentityIdFormatRequest"}, "documentation":"

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.

The following resource types support longer IDs: instance | reservation | snapshot | volume. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" }, "ModifyImageAttribute":{ "name":"ModifyImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyImageAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

The SriovNetSupport enhanced networking attribute cannot be changed using this command. Instead, enable SriovNetSupport on an instance and create an AMI from the instance. This will result in an image with SriovNetSupport enabled.

" }, "ModifyInstanceAttribute":{ "name":"ModifyInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyInstanceAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifyInstancePlacement":{ "name":"ModifyInstancePlacement", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyInstancePlacementRequest"}, "output":{"shape":"ModifyInstancePlacementResult"}, "documentation":"

Set the instance affinity value for a specific stopped instance and modify the instance tenancy setting.

Instance affinity is disabled by default. When instance affinity is host and it is not associated with a specific Dedicated Host, the next time it is launched it will automatically be associated with the host it lands on. This relationship will persist if the instance is stopped/started, or rebooted.

You can modify the host ID associated with a stopped instance. If a stopped instance has a new host ID association, the instance will target that host when restarted.

You can modify the tenancy of a stopped instance with a tenancy of host or dedicated.

Affinity, hostID, and tenancy are not required parameters, but at least one of them must be specified in the request. Affinity and tenancy can be modified in the same request, but tenancy can only be modified on instances that are stopped.

" }, "ModifyNetworkInterfaceAttribute":{ "name":"ModifyNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, "documentation":"

Modifies the specified network interface attribute. You can specify only one attribute at a time.

" }, "ModifyReservedInstances":{ "name":"ModifyReservedInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyReservedInstancesRequest"}, "output":{"shape":"ModifyReservedInstancesResult"}, "documentation":"

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Standard Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifySnapshotAttribute":{ "name":"ModifySnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySnapshotAttributeRequest"}, "documentation":"

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifySpotFleetRequest":{ "name":"ModifySpotFleetRequest", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySpotFleetRequestRequest"}, "output":{"shape":"ModifySpotFleetRequestResponse"}, "documentation":"

Modifies the specified Spot fleet request.

While the Spot fleet request is being modified, it is in the modifying state.

To scale up your Spot fleet, increase its target capacity. The Spot fleet launches the additional Spot instances according to the allocation strategy for the Spot fleet request. If the allocation strategy is lowestPrice, the Spot fleet launches instances using the Spot pool with the lowest price. If the allocation strategy is diversified, the Spot fleet distributes the instances across the Spot pools.

To scale down your Spot fleet, decrease its target capacity. First, the Spot fleet cancels any open bids that exceed the new target capacity. You can request that the Spot fleet terminate Spot instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot fleet terminates the instances with the highest price per unit. If the allocation strategy is diversified, the Spot fleet terminates instances across the Spot pools. Alternatively, you can request that the Spot fleet keep the fleet at its current size, but not replace any Spot instances that are interrupted or that you terminate manually.

" }, "ModifySubnetAttribute":{ "name":"ModifySubnetAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySubnetAttributeRequest"}, "documentation":"

Modifies a subnet attribute. You can only modify one attribute at a time.

" }, "ModifyVolumeAttribute":{ "name":"ModifyVolumeAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVolumeAttributeRequest"}, "documentation":"

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" }, "ModifyVpcAttribute":{ "name":"ModifyVpcAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified VPC.

" }, "ModifyVpcEndpoint":{ "name":"ModifyVpcEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcEndpointRequest"}, "output":{"shape":"ModifyVpcEndpointResult"}, "documentation":"

Modifies attributes of a specified VPC endpoint. You can modify the policy associated with the endpoint, and you can add and remove route tables associated with the endpoint.

" }, "ModifyVpcPeeringConnectionOptions":{ "name":"ModifyVpcPeeringConnectionOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcPeeringConnectionOptionsRequest"}, "output":{"shape":"ModifyVpcPeeringConnectionOptionsResult"}, "documentation":"

Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:

  • Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.

  • Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.

  • Enable/disable a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

If the peered VPCs are in different accounts, each owner must initiate a separate request to modify the peering connection options, depending on whether their VPC was the requester or accepter for the VPC peering connection. If the peered VPCs are in the same account, you can modify the requester and accepter options in the same request. To confirm which VPC is the accepter and requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

" }, "MonitorInstances":{ "name":"MonitorInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MonitorInstancesRequest"}, "output":{"shape":"MonitorInstancesResult"}, "documentation":"

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

To disable detailed monitoring, see .

" }, "MoveAddressToVpc":{ "name":"MoveAddressToVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MoveAddressToVpcRequest"}, "output":{"shape":"MoveAddressToVpcResult"}, "documentation":"

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

" }, "PurchaseHostReservation":{ "name":"PurchaseHostReservation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseHostReservationRequest"}, "output":{"shape":"PurchaseHostReservationResult"}, "documentation":"

Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.

" }, "PurchaseReservedInstancesOffering":{ "name":"PurchaseReservedInstancesOffering", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, "documentation":"

Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "PurchaseScheduledInstances":{ "name":"PurchaseScheduledInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseScheduledInstancesRequest"}, "output":{"shape":"PurchaseScheduledInstancesResult"}, "documentation":"

Purchases one or more Scheduled Instances with the specified schedule.

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.

After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.

" }, "RebootInstances":{ "name":"RebootInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootInstancesRequest"}, "documentation":"

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "RegisterImage":{ "name":"RegisterImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterImageRequest"}, "output":{"shape":"RegisterImageResult"}, "documentation":"

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide.

Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billingProduct code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure.

Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI.

To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see CreateImage.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

" }, "RejectVpcPeeringConnection":{ "name":"RejectVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RejectVpcPeeringConnectionRequest"}, "output":{"shape":"RejectVpcPeeringConnectionResult"}, "documentation":"

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" }, "ReleaseAddress":{ "name":"ReleaseAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReleaseAddressRequest"}, "documentation":"

Releases the specified Elastic IP address.

After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

" }, "ReleaseHosts":{ "name":"ReleaseHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReleaseHostsRequest"}, "output":{"shape":"ReleaseHostsResult"}, "documentation":"

When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, e.g., ModifyHosts. You must stop or terminate all instances on a host before it can be released.

When Dedicated Hosts are released, it make take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated hosts. Try waiting a few minutes, and then try again.

Released hosts will still appear in a DescribeHosts response.

" }, "ReplaceNetworkAclAssociation":{ "name":"ReplaceNetworkAclAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceNetworkAclAssociationRequest"}, "output":{"shape":"ReplaceNetworkAclAssociationResult"}, "documentation":"

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceNetworkAclEntry":{ "name":"ReplaceNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceNetworkAclEntryRequest"}, "documentation":"

Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceRoute":{ "name":"ReplaceRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceRouteRequest"}, "documentation":"

Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only Internet gateway.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceRouteTableAssociation":{ "name":"ReplaceRouteTableAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceRouteTableAssociationRequest"}, "output":{"shape":"ReplaceRouteTableAssociationResult"}, "documentation":"

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" }, "ReportInstanceStatus":{ "name":"ReportInstanceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReportInstanceStatusRequest"}, "documentation":"

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" }, "RequestSpotFleet":{ "name":"RequestSpotFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RequestSpotFleetRequest"}, "output":{"shape":"RequestSpotFleetResponse"}, "documentation":"

Creates a Spot fleet request.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet.

For more information, see Spot Fleet Requests in the Amazon Elastic Compute Cloud User Guide.

" }, "RequestSpotInstances":{ "name":"RequestSpotInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RequestSpotInstancesRequest"}, "output":{"shape":"RequestSpotInstancesResult"}, "documentation":"

Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

" }, "ResetImageAttribute":{ "name":"ResetImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetImageAttributeRequest"}, "documentation":"

Resets an attribute of an AMI to its default value.

The productCodes attribute can't be reset.

" }, "ResetInstanceAttribute":{ "name":"ResetInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetInstanceAttributeRequest"}, "documentation":"

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.

The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" }, "ResetNetworkInterfaceAttribute":{ "name":"ResetNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetNetworkInterfaceAttributeRequest"}, "documentation":"

Resets a network interface attribute. You can specify only one attribute at a time.

" }, "ResetSnapshotAttribute":{ "name":"ResetSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetSnapshotAttributeRequest"}, "documentation":"

Resets permission settings for the specified snapshot.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "RestoreAddressToClassic":{ "name":"RestoreAddressToClassic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreAddressToClassicRequest"}, "output":{"shape":"RestoreAddressToClassicResult"}, "documentation":"

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

" }, "RevokeSecurityGroupEgress":{ "name":"RevokeSecurityGroupEgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSecurityGroupEgressRequest"}, "documentation":"

[EC2-VPC only] Removes one or more egress rules from a security group for EC2-VPC. This action doesn't apply to security groups for use in EC2-Classic. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.

Each rule consists of the protocol and the IPv4 or IPv6 CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" }, "RevokeSecurityGroupIngress":{ "name":"RevokeSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSecurityGroupIngressRequest"}, "documentation":"

Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" }, "RunInstances":{ "name":"RunInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RunInstancesRequest"}, "output":{"shape":"Reservation"}, "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

You can specify a number of options, or leave the default options. The following rules apply:

  • [EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.

  • [EC2-Classic] If don't specify an Availability Zone, we choose one for you.

  • Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance Types Available Only in a VPC.

  • [EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.

  • Not all instance types support IPv6 addresses. For more information, see Amazon EC2 Instance Types.

  • If you don't specify a security group ID, we use the default security group. For more information, see Security Groups.

  • If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.

To ensure faster instance launches, break up large requests into smaller batches. For example, create 5 separate launch requests for 100 instances each instead of 1 launch request for 500 instances.

An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. After launch, you can apply tags to your running instance (requires a resource ID). For more information, see CreateTags and Tagging Your Amazon EC2 Resources.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

For troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "RunScheduledInstances":{ "name":"RunScheduledInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RunScheduledInstancesRequest"}, "output":{"shape":"RunScheduledInstancesResult"}, "documentation":"

Launches the specified Scheduled Instances.

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "StartInstances":{ "name":"StartInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartInstancesRequest"}, "output":{"shape":"StartInstancesResult"}, "documentation":"

Starts an Amazon EBS-backed AMI that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "StopInstances":{ "name":"StopInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopInstancesRequest"}, "output":{"shape":"StopInstancesResult"}, "documentation":"

Stops an Amazon EBS-backed instance.

We don't charge hourly usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

You can't start or stop Spot instances, and you can't stop instance store-backed instances.

When you stop an instance, we shut it down. You can restart your instance at any time. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Stopping an instance is different to rebooting or terminating it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "TerminateInstances":{ "name":"TerminateInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateInstancesRequest"}, "output":{"shape":"TerminateInstancesResult"}, "documentation":"

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "UnassignIpv6Addresses":{ "name":"UnassignIpv6Addresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnassignIpv6AddressesRequest"}, "output":{"shape":"UnassignIpv6AddressesResult"}, "documentation":"

Unassigns one or more IPv6 addresses from a network interface.

" }, "UnassignPrivateIpAddresses":{ "name":"UnassignPrivateIpAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnassignPrivateIpAddressesRequest"}, "documentation":"

Unassigns one or more secondary private IP addresses from a network interface.

" }, "UnmonitorInstances":{ "name":"UnmonitorInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnmonitorInstancesRequest"}, "output":{"shape":"UnmonitorInstancesResult"}, "documentation":"

Disables detailed monitoring for a running instance. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" } }, "shapes":{ "AcceptReservedInstancesExchangeQuoteRequest":{ "type":"structure", "required":["ReservedInstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ReservedInstanceIds":{ "shape":"ReservedInstanceIdSet", "documentation":"

The IDs of the Convertible Reserved Instances to exchange for other Convertible Reserved Instances of the same or higher value.

", "locationName":"ReservedInstanceId" }, "TargetConfigurations":{ "shape":"TargetConfigurationRequestSet", "documentation":"

The configurations of the Convertible Reserved Instance offerings that you are purchasing in this exchange.

", "locationName":"TargetConfiguration" } }, "documentation":"

Contains the parameters for accepting the quote.

" }, "AcceptReservedInstancesExchangeQuoteResult":{ "type":"structure", "members":{ "ExchangeId":{ "shape":"String", "documentation":"

The ID of the successful exchange.

", "locationName":"exchangeId" } }, "documentation":"

The result of the exchange and whether it was successful.

" }, "AcceptVpcPeeringConnectionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Contains the parameters for AcceptVpcPeeringConnection.

" }, "AcceptVpcPeeringConnectionResult":{ "type":"structure", "members":{ "VpcPeeringConnection":{ "shape":"VpcPeeringConnection", "documentation":"

Information about the VPC peering connection.

", "locationName":"vpcPeeringConnection" } }, "documentation":"

Contains the output of AcceptVpcPeeringConnection.

" }, "AccountAttribute":{ "type":"structure", "members":{ "AttributeName":{ "shape":"String", "documentation":"

The name of the account attribute.

", "locationName":"attributeName" }, "AttributeValues":{ "shape":"AccountAttributeValueList", "documentation":"

One or more values for the account attribute.

", "locationName":"attributeValueSet" } }, "documentation":"

Describes an account attribute.

" }, "AccountAttributeList":{ "type":"list", "member":{ "shape":"AccountAttribute", "locationName":"item" } }, "AccountAttributeName":{ "type":"string", "enum":[ "supported-platforms", "default-vpc" ] }, "AccountAttributeNameStringList":{ "type":"list", "member":{ "shape":"AccountAttributeName", "locationName":"attributeName" } }, "AccountAttributeValue":{ "type":"structure", "members":{ "AttributeValue":{ "shape":"String", "documentation":"

The value of the attribute.

", "locationName":"attributeValue" } }, "documentation":"

Describes a value of an account attribute.

" }, "AccountAttributeValueList":{ "type":"list", "member":{ "shape":"AccountAttributeValue", "locationName":"item" } }, "ActiveInstance":{ "type":"structure", "members":{ "InstanceType":{ "shape":"String", "documentation":"

The instance type.

", "locationName":"instanceType" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot instance request.

", "locationName":"spotInstanceRequestId" }, "InstanceHealth":{ "shape":"InstanceHealthStatus", "documentation":"

The health status of the instance. If the status of both the instance status check and the system status check is impaired, the health status of the instance is unhealthy. Otherwise, the health status is healthy.

", "locationName":"instanceHealth" } }, "documentation":"

Describes a running instance in a Spot fleet.

" }, "ActiveInstanceSet":{ "type":"list", "member":{ "shape":"ActiveInstance", "locationName":"item" } }, "ActivityStatus":{ "type":"string", "enum":[ "error", "pending_fulfillment", "pending_termination", "fulfilled" ] }, "Address":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance that the address is associated with (if any).

", "locationName":"instanceId" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "AllocationId":{ "shape":"String", "documentation":"

The ID representing the allocation of the address for use with EC2-VPC.

", "locationName":"allocationId" }, "AssociationId":{ "shape":"String", "documentation":"

The ID representing the association of the address with an instance in a VPC.

", "locationName":"associationId" }, "Domain":{ "shape":"DomainType", "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", "locationName":"domain" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "NetworkInterfaceOwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that owns the network interface.

", "locationName":"networkInterfaceOwnerId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address associated with the Elastic IP address.

", "locationName":"privateIpAddress" } }, "documentation":"

Describes an Elastic IP address.

" }, "AddressList":{ "type":"list", "member":{ "shape":"Address", "locationName":"item" } }, "Affinity":{ "type":"string", "enum":[ "default", "host" ] }, "AllocateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Domain":{ "shape":"DomainType", "documentation":"

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" } }, "documentation":"

Contains the parameters for AllocateAddress.

" }, "AllocateAddressResult":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "Domain":{ "shape":"DomainType", "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", "locationName":"domain" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", "locationName":"allocationId" } }, "documentation":"

Contains the output of AllocateAddress.

" }, "AllocateHostsRequest":{ "type":"structure", "required":[ "InstanceType", "Quantity", "AvailabilityZone" ], "members":{ "AutoPlacement":{ "shape":"AutoPlacement", "documentation":"

This is enabled by default. This property allows instances to be automatically placed onto available Dedicated Hosts, when you are launching instances without specifying a host ID.

Default: Enabled

", "locationName":"autoPlacement" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"clientToken" }, "InstanceType":{ "shape":"String", "documentation":"

Specify the instance type that you want your Dedicated Hosts to be configured for. When you specify the instance type, that is the only instance type that you can launch onto that host.

", "locationName":"instanceType" }, "Quantity":{ "shape":"Integer", "documentation":"

The number of Dedicated Hosts you want to allocate to your account with these parameters.

", "locationName":"quantity" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the Dedicated Hosts.

", "locationName":"availabilityZone" } }, "documentation":"

Contains the parameters for AllocateHosts.

" }, "AllocateHostsResult":{ "type":"structure", "members":{ "HostIds":{ "shape":"ResponseHostIdList", "documentation":"

The ID of the allocated Dedicated Host. This is used when you want to launch an instance onto a specific host.

", "locationName":"hostIdSet" } }, "documentation":"

Contains the output of AllocateHosts.

" }, "AllocationIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"AllocationId" } }, "AllocationState":{ "type":"string", "enum":[ "available", "under-assessment", "permanent-failure", "released", "released-permanent-failure" ] }, "AllocationStrategy":{ "type":"string", "enum":[ "lowestPrice", "diversified" ] }, "ArchitectureValues":{ "type":"string", "enum":[ "i386", "x86_64" ] }, "AssignIpv6AddressesRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Ipv6Addresses":{ "shape":"Ipv6AddressList", "documentation":"

One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.

", "locationName":"ipv6Addresses" }, "Ipv6AddressCount":{ "shape":"Integer", "documentation":"

The number of IPv6 addresses to assign to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.

", "locationName":"ipv6AddressCount" } } }, "AssignIpv6AddressesResult":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "AssignedIpv6Addresses":{ "shape":"Ipv6AddressList", "documentation":"

The IPv6 addresses assigned to the network interface.

", "locationName":"assignedIpv6Addresses" } } }, "AssignPrivateIpAddressesRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", "locationName":"privateIpAddress" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", "locationName":"secondaryPrivateIpAddressCount" }, "AllowReassignment":{ "shape":"Boolean", "documentation":"

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", "locationName":"allowReassignment" } }, "documentation":"

Contains the parameters for AssignPrivateIpAddresses.

" }, "AssociateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address. This is required for EC2-Classic.

" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

", "locationName":"networkInterfaceId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", "locationName":"privateIpAddress" }, "AllowReassociation":{ "shape":"Boolean", "documentation":"

[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

", "locationName":"allowReassociation" } }, "documentation":"

Contains the parameters for AssociateAddress.

" }, "AssociateAddressResult":{ "type":"structure", "members":{ "AssociationId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", "locationName":"associationId" } }, "documentation":"

Contains the output of AssociateAddress.

" }, "AssociateDhcpOptionsRequest":{ "type":"structure", "required":[ "DhcpOptionsId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for AssociateDhcpOptions.

" }, "AssociateRouteTableRequest":{ "type":"structure", "required":[ "SubnetId", "RouteTableId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" } }, "documentation":"

Contains the parameters for AssociateRouteTable.

" }, "AssociateRouteTableResult":{ "type":"structure", "members":{ "AssociationId":{ "shape":"String", "documentation":"

The route table association ID (needed to disassociate the route table).

", "locationName":"associationId" } }, "documentation":"

Contains the output of AssociateRouteTable.

" }, "AssociateSubnetCidrBlockRequest":{ "type":"structure", "required":[ "SubnetId", "Ipv6CidrBlock" ], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of your subnet.

", "locationName":"subnetId" }, "Ipv6CidrBlock":{ "shape":"String", "documentation":"

The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length.

", "locationName":"ipv6CidrBlock" } } }, "AssociateSubnetCidrBlockResult":{ "type":"structure", "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "Ipv6CidrBlockAssociation":{ "shape":"SubnetIpv6CidrBlockAssociation", "documentation":"

Information about the IPv6 CIDR block association.

", "locationName":"ipv6CidrBlockAssociation" } } }, "AssociateVpcCidrBlockRequest":{ "type":"structure", "required":["VpcId"], "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "AmazonProvidedIpv6CidrBlock":{ "shape":"Boolean", "documentation":"

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.

", "locationName":"amazonProvidedIpv6CidrBlock" } } }, "AssociateVpcCidrBlockResult":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Ipv6CidrBlockAssociation":{ "shape":"VpcIpv6CidrBlockAssociation", "documentation":"

Information about the IPv6 CIDR block association.

", "locationName":"ipv6CidrBlockAssociation" } } }, "AttachClassicLinkVpcRequest":{ "type":"structure", "required":[ "InstanceId", "VpcId", "Groups" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of a ClassicLink-enabled VPC.

", "locationName":"vpcId" }, "Groups":{ "shape":"GroupIdStringList", "documentation":"

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", "locationName":"SecurityGroupId" } }, "documentation":"

Contains the parameters for AttachClassicLinkVpc.

" }, "AttachClassicLinkVpcResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of AttachClassicLinkVpc.

" }, "AttachInternetGatewayRequest":{ "type":"structure", "required":[ "InternetGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for AttachInternetGateway.

" }, "AttachNetworkInterfaceRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "InstanceId", "DeviceIndex" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device for the network interface attachment.

", "locationName":"deviceIndex" } }, "documentation":"

Contains the parameters for AttachNetworkInterface.

" }, "AttachNetworkInterfaceResult":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" } }, "documentation":"

Contains the output of AttachNetworkInterface.

" }, "AttachVolumeRequest":{ "type":"structure", "required":[ "VolumeId", "InstanceId", "Device" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "Device":{ "shape":"String", "documentation":"

The device name to expose to the instance (for example, /dev/sdh or xvdh).

" } }, "documentation":"

Contains the parameters for AttachVolume.

" }, "AttachVpnGatewayRequest":{ "type":"structure", "required":[ "VpnGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for AttachVpnGateway.

" }, "AttachVpnGatewayResult":{ "type":"structure", "members":{ "VpcAttachment":{ "shape":"VpcAttachment", "documentation":"

Information about the attachment.

", "locationName":"attachment" } }, "documentation":"

Contains the output of AttachVpnGateway.

" }, "AttachmentStatus":{ "type":"string", "enum":[ "attaching", "attached", "detaching", "detached" ] }, "AttributeBooleanValue":{ "type":"structure", "members":{ "Value":{ "shape":"Boolean", "documentation":"

The attribute value. The valid values are true or false.

", "locationName":"value" } }, "documentation":"

Describes a value for a resource attribute that is a Boolean value.

" }, "AttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"String", "documentation":"

The attribute value. Note that the value is case-sensitive.

", "locationName":"value" } }, "documentation":"

Describes a value for a resource attribute that is a String.

" }, "AuthorizeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

The name of a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account number for a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", "locationName":"toPort" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IPv4 address range. We recommend that you specify the CIDR range in a set of IP permissions instead.

", "locationName":"cidrIp" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"ipPermissions" } }, "documentation":"

Contains the parameters for AuthorizeSecurityGroupEgress.

" }, "AuthorizeSecurityGroupIngressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a nondefault VPC.

" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.

" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

[EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all protocols. If you specify -1, or a protocol number other than tcp, udp, icmp, or 58 (ICMPv6), traffic on all ports is allowed, regardless of any ports you specify. For tcp, udp, and icmp, you must specify a port range. For protocol 58 (ICMPv6), you can optionally specify a port range; if you don't, traffic for all types and codes is allowed.

" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. For the ICMP/ICMPv6 type number, use -1 to specify all types.

" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code number. For the ICMP/ICMPv6 code number, use -1 to specify all codes.

" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IPv4 address range. You can't specify this parameter when specifying a source security group.

" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. Can be used to specify multiple rules in a single command.

" } }, "documentation":"

Contains the parameters for AuthorizeSecurityGroupIngress.

" }, "AutoPlacement":{ "type":"string", "enum":[ "on", "off" ] }, "AvailabilityZone":{ "type":"structure", "members":{ "ZoneName":{ "shape":"String", "documentation":"

The name of the Availability Zone.

", "locationName":"zoneName" }, "State":{ "shape":"AvailabilityZoneState", "documentation":"

The state of the Availability Zone.

", "locationName":"zoneState" }, "RegionName":{ "shape":"String", "documentation":"

The name of the region.

", "locationName":"regionName" }, "Messages":{ "shape":"AvailabilityZoneMessageList", "documentation":"

Any messages about the Availability Zone.

", "locationName":"messageSet" } }, "documentation":"

Describes an Availability Zone.

" }, "AvailabilityZoneList":{ "type":"list", "member":{ "shape":"AvailabilityZone", "locationName":"item" } }, "AvailabilityZoneMessage":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

The message about the Availability Zone.

", "locationName":"message" } }, "documentation":"

Describes a message about an Availability Zone.

" }, "AvailabilityZoneMessageList":{ "type":"list", "member":{ "shape":"AvailabilityZoneMessage", "locationName":"item" } }, "AvailabilityZoneState":{ "type":"string", "enum":[ "available", "information", "impaired", "unavailable" ] }, "AvailableCapacity":{ "type":"structure", "members":{ "AvailableInstanceCapacity":{ "shape":"AvailableInstanceCapacityList", "documentation":"

The total number of instances that the Dedicated Host supports.

", "locationName":"availableInstanceCapacity" }, "AvailableVCpus":{ "shape":"Integer", "documentation":"

The number of vCPUs available on the Dedicated Host.

", "locationName":"availableVCpus" } }, "documentation":"

The capacity information for instances launched onto the Dedicated Host.

" }, "AvailableInstanceCapacityList":{ "type":"list", "member":{ "shape":"InstanceCapacity", "locationName":"item" } }, "BatchState":{ "type":"string", "enum":[ "submitted", "active", "cancelled", "failed", "cancelled_running", "cancelled_terminating", "modifying" ] }, "Blob":{"type":"blob"}, "BlobAttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"Blob", "locationName":"value" } } }, "BlockDeviceMapping":{ "type":"structure", "members":{ "VirtualName":{ "shape":"String", "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", "locationName":"virtualName" }, "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsBlockDevice", "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", "locationName":"ebs" }, "NoDevice":{ "shape":"String", "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", "locationName":"noDevice" } }, "documentation":"

Describes a block device mapping.

" }, "BlockDeviceMappingList":{ "type":"list", "member":{ "shape":"BlockDeviceMapping", "locationName":"item" } }, "BlockDeviceMappingRequestList":{ "type":"list", "member":{ "shape":"BlockDeviceMapping", "locationName":"BlockDeviceMapping" } }, "Boolean":{"type":"boolean"}, "BundleIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"BundleId" } }, "BundleInstanceRequest":{ "type":"structure", "required":[ "InstanceId", "Storage" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

" }, "Storage":{ "shape":"Storage", "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" } }, "documentation":"

Contains the parameters for BundleInstance.

" }, "BundleInstanceResult":{ "type":"structure", "members":{ "BundleTask":{ "shape":"BundleTask", "documentation":"

Information about the bundle task.

", "locationName":"bundleInstanceTask" } }, "documentation":"

Contains the output of BundleInstance.

" }, "BundleTask":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance associated with this bundle task.

", "locationName":"instanceId" }, "BundleId":{ "shape":"String", "documentation":"

The ID of the bundle task.

", "locationName":"bundleId" }, "State":{ "shape":"BundleTaskState", "documentation":"

The state of the task.

", "locationName":"state" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time this task started.

", "locationName":"startTime" }, "UpdateTime":{ "shape":"DateTime", "documentation":"

The time of the most recent update for the task.

", "locationName":"updateTime" }, "Storage":{ "shape":"Storage", "documentation":"

The Amazon S3 storage locations.

", "locationName":"storage" }, "Progress":{ "shape":"String", "documentation":"

The level of task completion, as a percent (for example, 20%).

", "locationName":"progress" }, "BundleTaskError":{ "shape":"BundleTaskError", "documentation":"

If the task fails, a description of the error.

", "locationName":"error" } }, "documentation":"

Describes a bundle task.

" }, "BundleTaskError":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The error message.

", "locationName":"message" } }, "documentation":"

Describes an error for BundleInstance.

" }, "BundleTaskList":{ "type":"list", "member":{ "shape":"BundleTask", "locationName":"item" } }, "BundleTaskState":{ "type":"string", "enum":[ "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed" ] }, "CancelBatchErrorCode":{ "type":"string", "enum":[ "fleetRequestIdDoesNotExist", "fleetRequestIdMalformed", "fleetRequestNotInCancellableState", "unexpectedError" ] }, "CancelBundleTaskRequest":{ "type":"structure", "required":["BundleId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "BundleId":{ "shape":"String", "documentation":"

The ID of the bundle task.

" } }, "documentation":"

Contains the parameters for CancelBundleTask.

" }, "CancelBundleTaskResult":{ "type":"structure", "members":{ "BundleTask":{ "shape":"BundleTask", "documentation":"

Information about the bundle task.

", "locationName":"bundleInstanceTask" } }, "documentation":"

Contains the output of CancelBundleTask.

" }, "CancelConversionRequest":{ "type":"structure", "required":["ConversionTaskId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ConversionTaskId":{ "shape":"String", "documentation":"

The ID of the conversion task.

", "locationName":"conversionTaskId" }, "ReasonMessage":{ "shape":"String", "documentation":"

The reason for canceling the conversion task.

", "locationName":"reasonMessage" } }, "documentation":"

Contains the parameters for CancelConversionTask.

" }, "CancelExportTaskRequest":{ "type":"structure", "required":["ExportTaskId"], "members":{ "ExportTaskId":{ "shape":"String", "documentation":"

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", "locationName":"exportTaskId" } }, "documentation":"

Contains the parameters for CancelExportTask.

" }, "CancelImportTaskRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import image or import snapshot task to be canceled.

" }, "CancelReason":{ "shape":"String", "documentation":"

The reason for canceling the task.

" } }, "documentation":"

Contains the parameters for CancelImportTask.

" }, "CancelImportTaskResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the task being canceled.

", "locationName":"importTaskId" }, "State":{ "shape":"String", "documentation":"

The current state of the task being canceled.

", "locationName":"state" }, "PreviousState":{ "shape":"String", "documentation":"

The current state of the task being canceled.

", "locationName":"previousState" } }, "documentation":"

Contains the output for CancelImportTask.

" }, "CancelReservedInstancesListingRequest":{ "type":"structure", "required":["ReservedInstancesListingId"], "members":{ "ReservedInstancesListingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance listing.

", "locationName":"reservedInstancesListingId" } }, "documentation":"

Contains the parameters for CancelReservedInstancesListing.

" }, "CancelReservedInstancesListingResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

The Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } }, "documentation":"

Contains the output of CancelReservedInstancesListing.

" }, "CancelSpotFleetRequestsError":{ "type":"structure", "required":[ "Code", "Message" ], "members":{ "Code":{ "shape":"CancelBatchErrorCode", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The description for the error code.

", "locationName":"message" } }, "documentation":"

Describes a Spot fleet error.

" }, "CancelSpotFleetRequestsErrorItem":{ "type":"structure", "required":[ "SpotFleetRequestId", "Error" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "Error":{ "shape":"CancelSpotFleetRequestsError", "documentation":"

The error.

", "locationName":"error" } }, "documentation":"

Describes a Spot fleet request that was not successfully canceled.

" }, "CancelSpotFleetRequestsErrorSet":{ "type":"list", "member":{ "shape":"CancelSpotFleetRequestsErrorItem", "locationName":"item" } }, "CancelSpotFleetRequestsRequest":{ "type":"structure", "required":[ "SpotFleetRequestIds", "TerminateInstances" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestIds":{ "shape":"ValueStringList", "documentation":"

The IDs of the Spot fleet requests.

", "locationName":"spotFleetRequestId" }, "TerminateInstances":{ "shape":"Boolean", "documentation":"

Indicates whether to terminate instances for a Spot fleet request if it is canceled successfully.

", "locationName":"terminateInstances" } }, "documentation":"

Contains the parameters for CancelSpotFleetRequests.

" }, "CancelSpotFleetRequestsResponse":{ "type":"structure", "members":{ "UnsuccessfulFleetRequests":{ "shape":"CancelSpotFleetRequestsErrorSet", "documentation":"

Information about the Spot fleet requests that are not successfully canceled.

", "locationName":"unsuccessfulFleetRequestSet" }, "SuccessfulFleetRequests":{ "shape":"CancelSpotFleetRequestsSuccessSet", "documentation":"

Information about the Spot fleet requests that are successfully canceled.

", "locationName":"successfulFleetRequestSet" } }, "documentation":"

Contains the output of CancelSpotFleetRequests.

" }, "CancelSpotFleetRequestsSuccessItem":{ "type":"structure", "required":[ "SpotFleetRequestId", "CurrentSpotFleetRequestState", "PreviousSpotFleetRequestState" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "CurrentSpotFleetRequestState":{ "shape":"BatchState", "documentation":"

The current state of the Spot fleet request.

", "locationName":"currentSpotFleetRequestState" }, "PreviousSpotFleetRequestState":{ "shape":"BatchState", "documentation":"

The previous state of the Spot fleet request.

", "locationName":"previousSpotFleetRequestState" } }, "documentation":"

Describes a Spot fleet request that was successfully canceled.

" }, "CancelSpotFleetRequestsSuccessSet":{ "type":"list", "member":{ "shape":"CancelSpotFleetRequestsSuccessItem", "locationName":"item" } }, "CancelSpotInstanceRequestState":{ "type":"string", "enum":[ "active", "open", "closed", "cancelled", "completed" ] }, "CancelSpotInstanceRequestsRequest":{ "type":"structure", "required":["SpotInstanceRequestIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotInstanceRequestIds":{ "shape":"SpotInstanceRequestIdList", "documentation":"

One or more Spot instance request IDs.

", "locationName":"SpotInstanceRequestId" } }, "documentation":"

Contains the parameters for CancelSpotInstanceRequests.

" }, "CancelSpotInstanceRequestsResult":{ "type":"structure", "members":{ "CancelledSpotInstanceRequests":{ "shape":"CancelledSpotInstanceRequestList", "documentation":"

One or more Spot instance requests.

", "locationName":"spotInstanceRequestSet" } }, "documentation":"

Contains the output of CancelSpotInstanceRequests.

" }, "CancelledSpotInstanceRequest":{ "type":"structure", "members":{ "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot instance request.

", "locationName":"spotInstanceRequestId" }, "State":{ "shape":"CancelSpotInstanceRequestState", "documentation":"

The state of the Spot instance request.

", "locationName":"state" } }, "documentation":"

Describes a request to cancel a Spot instance.

" }, "CancelledSpotInstanceRequestList":{ "type":"list", "member":{ "shape":"CancelledSpotInstanceRequest", "locationName":"item" } }, "ClassicLinkDnsSupport":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "ClassicLinkDnsSupported":{ "shape":"Boolean", "documentation":"

Indicates whether ClassicLink DNS support is enabled for the VPC.

", "locationName":"classicLinkDnsSupported" } }, "documentation":"

Describes the ClassicLink DNS support status of a VPC.

" }, "ClassicLinkDnsSupportList":{ "type":"list", "member":{ "shape":"ClassicLinkDnsSupport", "locationName":"item" } }, "ClassicLinkInstance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

A list of security groups.

", "locationName":"groupSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the instance.

", "locationName":"tagSet" } }, "documentation":"

Describes a linked EC2-Classic instance.

" }, "ClassicLinkInstanceList":{ "type":"list", "member":{ "shape":"ClassicLinkInstance", "locationName":"item" } }, "ClientData":{ "type":"structure", "members":{ "UploadStart":{ "shape":"DateTime", "documentation":"

The time that the disk upload starts.

" }, "UploadEnd":{ "shape":"DateTime", "documentation":"

The time that the disk upload ends.

" }, "UploadSize":{ "shape":"Double", "documentation":"

The size of the uploaded disk image, in GiB.

" }, "Comment":{ "shape":"String", "documentation":"

A user-defined comment about the disk upload.

" } }, "documentation":"

Describes the client-specific data.

" }, "ConfirmProductInstanceRequest":{ "type":"structure", "required":[ "ProductCode", "InstanceId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ProductCode":{ "shape":"String", "documentation":"

The product code. This must be a product code that you own.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" } }, "documentation":"

Contains the parameters for ConfirmProductInstance.

" }, "ConfirmProductInstanceResult":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", "locationName":"ownerId" }, "Return":{ "shape":"Boolean", "documentation":"

The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.

", "locationName":"return" } }, "documentation":"

Contains the output of ConfirmProductInstance.

" }, "ContainerFormat":{ "type":"string", "enum":["ova"] }, "ConversionIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "ConversionTask":{ "type":"structure", "required":[ "ConversionTaskId", "State" ], "members":{ "ConversionTaskId":{ "shape":"String", "documentation":"

The ID of the conversion task.

", "locationName":"conversionTaskId" }, "ExpirationTime":{ "shape":"String", "documentation":"

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", "locationName":"expirationTime" }, "ImportInstance":{ "shape":"ImportInstanceTaskDetails", "documentation":"

If the task is for importing an instance, this contains information about the import instance task.

", "locationName":"importInstance" }, "ImportVolume":{ "shape":"ImportVolumeTaskDetails", "documentation":"

If the task is for importing a volume, this contains information about the import volume task.

", "locationName":"importVolume" }, "State":{ "shape":"ConversionTaskState", "documentation":"

The state of the conversion task.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message related to the conversion task.

", "locationName":"statusMessage" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the task.

", "locationName":"tagSet" } }, "documentation":"

Describes a conversion task.

" }, "ConversionTaskState":{ "type":"string", "enum":[ "active", "cancelling", "cancelled", "completed" ] }, "CopyImageRequest":{ "type":"structure", "required":[ "SourceRegion", "SourceImageId", "Name" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SourceRegion":{ "shape":"String", "documentation":"

The name of the region that contains the AMI to copy.

" }, "SourceImageId":{ "shape":"String", "documentation":"

The ID of the AMI to copy.

" }, "Name":{ "shape":"String", "documentation":"

The name of the new AMI in the destination region.

" }, "Description":{ "shape":"String", "documentation":"

A description for the new AMI in the destination region.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

", "locationName":"kmsKeyId" } }, "documentation":"

Contains the parameters for CopyImage.

" }, "CopyImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the new AMI.

", "locationName":"imageId" } }, "documentation":"

Contains the output of CopyImage.

" }, "CopySnapshotRequest":{ "type":"structure", "required":[ "SourceRegion", "SourceSnapshotId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SourceRegion":{ "shape":"String", "documentation":"

The ID of the region that contains the snapshot to be copied.

" }, "SourceSnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot to copy.

" }, "Description":{ "shape":"String", "documentation":"

A description for the EBS snapshot.

" }, "DestinationRegion":{ "shape":"String", "documentation":"

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

", "locationName":"destinationRegion" }, "PresignedUrl":{ "shape":"String", "documentation":"

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", "locationName":"presignedUrl" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the destination snapshot should be encrypted. You can encrypt a copy of an unencrypted snapshot using this flag, but you cannot use it to create an unencrypted copy from an encrypted snapshot. Your default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

", "locationName":"kmsKeyId" } }, "documentation":"

Contains the parameters for CopySnapshot.

" }, "CopySnapshotResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the new snapshot.

", "locationName":"snapshotId" } }, "documentation":"

Contains the output of CopySnapshot.

" }, "CreateCustomerGatewayRequest":{ "type":"structure", "required":[ "Type", "PublicIp", "BgpAsn" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection that this customer gateway supports (ipsec.1).

" }, "PublicIp":{ "shape":"String", "documentation":"

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", "locationName":"IpAddress" }, "BgpAsn":{ "shape":"Integer", "documentation":"

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" } }, "documentation":"

Contains the parameters for CreateCustomerGateway.

" }, "CreateCustomerGatewayResult":{ "type":"structure", "members":{ "CustomerGateway":{ "shape":"CustomerGateway", "documentation":"

Information about the customer gateway.

", "locationName":"customerGateway" } }, "documentation":"

Contains the output of CreateCustomerGateway.

" }, "CreateDhcpOptionsRequest":{ "type":"structure", "required":["DhcpConfigurations"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpConfigurations":{ "shape":"NewDhcpConfigurationList", "documentation":"

A DHCP configuration option.

", "locationName":"dhcpConfiguration" } }, "documentation":"

Contains the parameters for CreateDhcpOptions.

" }, "CreateDhcpOptionsResult":{ "type":"structure", "members":{ "DhcpOptions":{ "shape":"DhcpOptions", "documentation":"

A set of DHCP options.

", "locationName":"dhcpOptions" } }, "documentation":"

Contains the output of CreateDhcpOptions.

" }, "CreateEgressOnlyInternetGatewayRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for which to create the egress-only Internet gateway.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" } } }, "CreateEgressOnlyInternetGatewayResult":{ "type":"structure", "members":{ "EgressOnlyInternetGateway":{ "shape":"EgressOnlyInternetGateway", "documentation":"

Information about the egress-only Internet gateway.

", "locationName":"egressOnlyInternetGateway" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", "locationName":"clientToken" } } }, "CreateFlowLogsRequest":{ "type":"structure", "required":[ "ResourceIds", "ResourceType", "TrafficType", "LogGroupName", "DeliverLogsPermissionArn" ], "members":{ "ResourceIds":{ "shape":"ValueStringList", "documentation":"

One or more subnet, network interface, or VPC IDs.

Constraints: Maximum of 1000 resources

", "locationName":"ResourceId" }, "ResourceType":{ "shape":"FlowLogsResourceType", "documentation":"

The type of resource on which to create the flow log.

" }, "TrafficType":{ "shape":"TrafficType", "documentation":"

The type of traffic to log.

" }, "LogGroupName":{ "shape":"String", "documentation":"

The name of the CloudWatch log group.

" }, "DeliverLogsPermissionArn":{ "shape":"String", "documentation":"

The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" } }, "documentation":"

Contains the parameters for CreateFlowLogs.

" }, "CreateFlowLogsResult":{ "type":"structure", "members":{ "FlowLogIds":{ "shape":"ValueStringList", "documentation":"

The IDs of the flow logs.

", "locationName":"flowLogIdSet" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", "locationName":"clientToken" }, "Unsuccessful":{ "shape":"UnsuccessfulItemSet", "documentation":"

Information about the flow logs that could not be created successfully.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of CreateFlowLogs.

" }, "CreateImageRequest":{ "type":"structure", "required":[ "InstanceId", "Name" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Name":{ "shape":"String", "documentation":"

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

A description for the new image.

", "locationName":"description" }, "NoReboot":{ "shape":"Boolean", "documentation":"

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", "locationName":"noReboot" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

Information about one or more block device mappings.

", "locationName":"blockDeviceMapping" } }, "documentation":"

Contains the parameters for CreateImage.

" }, "CreateImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the new AMI.

", "locationName":"imageId" } }, "documentation":"

Contains the output of CreateImage.

" }, "CreateInstanceExportTaskRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "Description":{ "shape":"String", "documentation":"

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", "locationName":"description" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "TargetEnvironment":{ "shape":"ExportEnvironment", "documentation":"

The target virtualization environment.

", "locationName":"targetEnvironment" }, "ExportToS3Task":{ "shape":"ExportToS3TaskSpecification", "documentation":"

The format and location for an instance export task.

", "locationName":"exportToS3" } }, "documentation":"

Contains the parameters for CreateInstanceExportTask.

" }, "CreateInstanceExportTaskResult":{ "type":"structure", "members":{ "ExportTask":{ "shape":"ExportTask", "documentation":"

Information about the instance export task.

", "locationName":"exportTask" } }, "documentation":"

Contains the output for CreateInstanceExportTask.

" }, "CreateInternetGatewayRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for CreateInternetGateway.

" }, "CreateInternetGatewayResult":{ "type":"structure", "members":{ "InternetGateway":{ "shape":"InternetGateway", "documentation":"

Information about the Internet gateway.

", "locationName":"internetGateway" } }, "documentation":"

Contains the output of CreateInternetGateway.

" }, "CreateKeyPairRequest":{ "type":"structure", "required":["KeyName"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" } }, "documentation":"

Contains the parameters for CreateKeyPair.

" }, "CreateNatGatewayRequest":{ "type":"structure", "required":[ "SubnetId", "AllocationId" ], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The subnet in which to create the NAT gateway.

" }, "AllocationId":{ "shape":"String", "documentation":"

The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Constraint: Maximum 64 ASCII characters.

" } }, "documentation":"

Contains the parameters for CreateNatGateway.

" }, "CreateNatGatewayResult":{ "type":"structure", "members":{ "NatGateway":{ "shape":"NatGateway", "documentation":"

Information about the NAT gateway.

", "locationName":"natGateway" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

", "locationName":"clientToken" } }, "documentation":"

Contains the output of CreateNatGateway.

" }, "CreateNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Protocol", "RuleAction", "Egress" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The protocol. A value of -1 or all means all protocols. If you specify all, -1, or a protocol number other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports or ICMP types or codes you specify. If you specify protocol 58 (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol 58 (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", "locationName":"cidrBlock" }, "Ipv6CidrBlock":{ "shape":"String", "documentation":"

The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).

", "locationName":"ipv6CidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying the ICMP protocol, or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", "locationName":"Icmp" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", "locationName":"portRange" } }, "documentation":"

Contains the parameters for CreateNetworkAclEntry.

" }, "CreateNetworkAclRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for CreateNetworkAcl.

" }, "CreateNetworkAclResult":{ "type":"structure", "members":{ "NetworkAcl":{ "shape":"NetworkAcl", "documentation":"

Information about the network ACL.

", "locationName":"networkAcl" } }, "documentation":"

Contains the output of CreateNetworkAcl.

" }, "CreateNetworkInterfaceRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet to associate with the network interface.

", "locationName":"subnetId" }, "Description":{ "shape":"String", "documentation":"

A description for the network interface.

", "locationName":"description" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", "locationName":"privateIpAddress" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

The IDs of one or more security groups.

", "locationName":"SecurityGroupId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", "documentation":"

One or more private IPv4 addresses.

", "locationName":"privateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.

", "locationName":"secondaryPrivateIpAddressCount" }, "Ipv6Addresses":{ "shape":"InstanceIpv6AddressList", "documentation":"

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.

", "locationName":"ipv6Addresses" }, "Ipv6AddressCount":{ "shape":"Integer", "documentation":"

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting.

", "locationName":"ipv6AddressCount" }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for CreateNetworkInterface.

" }, "CreateNetworkInterfaceResult":{ "type":"structure", "members":{ "NetworkInterface":{ "shape":"NetworkInterface", "documentation":"

Information about the network interface.

", "locationName":"networkInterface" } }, "documentation":"

Contains the output of CreateNetworkInterface.

" }, "CreatePlacementGroupRequest":{ "type":"structure", "required":[ "GroupName", "Strategy" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

A name for the placement group.

Constraints: Up to 255 ASCII characters

", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"

The placement strategy.

", "locationName":"strategy" } }, "documentation":"

Contains the parameters for CreatePlacementGroup.

" }, "CreateReservedInstancesListingRequest":{ "type":"structure", "required":[ "ReservedInstancesId", "InstanceCount", "PriceSchedules", "ClientToken" ], "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the active Standard Reserved Instance.

", "locationName":"reservedInstancesId" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", "locationName":"instanceCount" }, "PriceSchedules":{ "shape":"PriceScheduleSpecificationList", "documentation":"

A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.

", "locationName":"priceSchedules" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Contains the parameters for CreateReservedInstancesListing.

" }, "CreateReservedInstancesListingResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

Information about the Standard Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } }, "documentation":"

Contains the output of CreateReservedInstancesListing.

" }, "CreateRouteRequest":{ "type":"structure", "required":["RouteTableId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table for the route.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of an Internet gateway or virtual private gateway attached to your VPC.

", "locationName":"gatewayId" }, "DestinationIpv6CidrBlock":{ "shape":"String", "documentation":"

The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

", "locationName":"destinationIpv6CidrBlock" }, "EgressOnlyInternetGatewayId":{ "shape":"String", "documentation":"

[IPv6 traffic only] The ID of an egress-only Internet gateway.

", "locationName":"egressOnlyInternetGatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", "locationName":"instanceId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of a network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of a VPC peering connection.

", "locationName":"vpcPeeringConnectionId" }, "NatGatewayId":{ "shape":"String", "documentation":"

[IPv4 traffic only] The ID of a NAT gateway.

", "locationName":"natGatewayId" } }, "documentation":"

Contains the parameters for CreateRoute.

" }, "CreateRouteResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of CreateRoute.

" }, "CreateRouteTableRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for CreateRouteTable.

" }, "CreateRouteTableResult":{ "type":"structure", "members":{ "RouteTable":{ "shape":"RouteTable", "documentation":"

Information about the route table.

", "locationName":"routeTable" } }, "documentation":"

Contains the output of CreateRouteTable.

" }, "CreateSecurityGroupRequest":{ "type":"structure", "required":[ "GroupName", "Description" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

" }, "Description":{ "shape":"String", "documentation":"

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", "locationName":"GroupDescription" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" } }, "documentation":"

Contains the parameters for CreateSecurityGroup.

" }, "CreateSecurityGroupResult":{ "type":"structure", "members":{ "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } }, "documentation":"

Contains the output of CreateSecurityGroup.

" }, "CreateSnapshotRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume.

" }, "Description":{ "shape":"String", "documentation":"

A description for the snapshot.

" } }, "documentation":"

Contains the parameters for CreateSnapshot.

" }, "CreateSpotDatafeedSubscriptionRequest":{ "type":"structure", "required":["Bucket"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket in which to store the Spot instance data feed.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

A prefix for the data feed file names.

", "locationName":"prefix" } }, "documentation":"

Contains the parameters for CreateSpotDatafeedSubscription.

" }, "CreateSpotDatafeedSubscriptionResult":{ "type":"structure", "members":{ "SpotDatafeedSubscription":{ "shape":"SpotDatafeedSubscription", "documentation":"

The Spot instance data feed subscription.

", "locationName":"spotDatafeedSubscription" } }, "documentation":"

Contains the output of CreateSpotDatafeedSubscription.

" }, "CreateSubnetRequest":{ "type":"structure", "required":[ "VpcId", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "CidrBlock":{ "shape":"String", "documentation":"

The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" }, "Ipv6CidrBlock":{ "shape":"String", "documentation":"

The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the subnet.

Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.

" } }, "documentation":"

Contains the parameters for CreateSubnet.

" }, "CreateSubnetResult":{ "type":"structure", "members":{ "Subnet":{ "shape":"Subnet", "documentation":"

Information about the subnet.

", "locationName":"subnet" } }, "documentation":"

Contains the output of CreateSubnet.

" }, "CreateTagsRequest":{ "type":"structure", "required":[ "Resources", "Tags" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Resources":{ "shape":"ResourceIdList", "documentation":"

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

", "locationName":"ResourceId" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", "locationName":"Tag" } }, "documentation":"

Contains the parameters for CreateTags.

" }, "CreateVolumePermission":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

", "locationName":"userId" }, "Group":{ "shape":"PermissionGroup", "documentation":"

The specific group that is to be added or removed from a volume's list of create volume permissions.

", "locationName":"group" } }, "documentation":"

Describes the user or group to be added or removed from the permissions for a volume.

" }, "CreateVolumePermissionList":{ "type":"list", "member":{ "shape":"CreateVolumePermission", "locationName":"item" } }, "CreateVolumePermissionModifications":{ "type":"structure", "members":{ "Add":{ "shape":"CreateVolumePermissionList", "documentation":"

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

" }, "Remove":{ "shape":"CreateVolumePermissionList", "documentation":"

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

" } }, "documentation":"

Describes modifications to the permissions for a volume.

" }, "CreateVolumeRequest":{ "type":"structure", "required":["AvailabilityZone"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Size":{ "shape":"Integer", "documentation":"

The size of the volume, in GiBs.

Constraints: 1-16384 for gp2, 4-16384 for io1, 500-16384 for st1, 500-16384 for sc1, and 1-1024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot from which to create the volume.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: standard

" }, "Iops":{ "shape":"Integer", "documentation":"

Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If a KmsKeyId is specified, the Encrypted flag must also be set.

" } }, "documentation":"

Contains the parameters for CreateVolume.

" }, "CreateVpcEndpointRequest":{ "type":"structure", "required":[ "VpcId", "ServiceName" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC in which the endpoint will be used.

" }, "ServiceName":{ "shape":"String", "documentation":"

The AWS service name, in the form com.amazonaws.region.service . To get a list of available services, use the DescribeVpcEndpointServices request.

" }, "PolicyDocument":{ "shape":"String", "documentation":"

A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs.

", "locationName":"RouteTableId" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" } }, "documentation":"

Contains the parameters for CreateVpcEndpoint.

" }, "CreateVpcEndpointResult":{ "type":"structure", "members":{ "VpcEndpoint":{ "shape":"VpcEndpoint", "documentation":"

Information about the endpoint.

", "locationName":"vpcEndpoint" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", "locationName":"clientToken" } }, "documentation":"

Contains the output of CreateVpcEndpoint.

" }, "CreateVpcPeeringConnectionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the requester VPC.

", "locationName":"vpcId" }, "PeerVpcId":{ "shape":"String", "documentation":"

The ID of the VPC with which you are creating the VPC peering connection.

", "locationName":"peerVpcId" }, "PeerOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

", "locationName":"peerOwnerId" } }, "documentation":"

Contains the parameters for CreateVpcPeeringConnection.

" }, "CreateVpcPeeringConnectionResult":{ "type":"structure", "members":{ "VpcPeeringConnection":{ "shape":"VpcPeeringConnection", "documentation":"

Information about the VPC peering connection.

", "locationName":"vpcPeeringConnection" } }, "documentation":"

Contains the output of CreateVpcPeeringConnection.

" }, "CreateVpcRequest":{ "type":"structure", "required":["CidrBlock"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "CidrBlock":{ "shape":"String", "documentation":"

The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

", "locationName":"instanceTenancy" }, "AmazonProvidedIpv6CidrBlock":{ "shape":"Boolean", "documentation":"

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.

", "locationName":"amazonProvidedIpv6CidrBlock" } }, "documentation":"

Contains the parameters for CreateVpc.

" }, "CreateVpcResult":{ "type":"structure", "members":{ "Vpc":{ "shape":"Vpc", "documentation":"

Information about the VPC.

", "locationName":"vpc" } }, "documentation":"

Contains the output of CreateVpc.

" }, "CreateVpnConnectionRequest":{ "type":"structure", "required":[ "Type", "CustomerGatewayId", "VpnGatewayId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Type":{ "shape":"String", "documentation":"

The type of VPN connection (ipsec.1).

" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "Options":{ "shape":"VpnConnectionOptionsSpecification", "documentation":"

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

", "locationName":"options" } }, "documentation":"

Contains the parameters for CreateVpnConnection.

" }, "CreateVpnConnectionResult":{ "type":"structure", "members":{ "VpnConnection":{ "shape":"VpnConnection", "documentation":"

Information about the VPN connection.

", "locationName":"vpnConnection" } }, "documentation":"

Contains the output of CreateVpnConnection.

" }, "CreateVpnConnectionRouteRequest":{ "type":"structure", "required":[ "VpnConnectionId", "DestinationCidrBlock" ], "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer network.

" } }, "documentation":"

Contains the parameters for CreateVpnConnectionRoute.

" }, "CreateVpnGatewayRequest":{ "type":"structure", "required":["Type"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection this virtual private gateway supports.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the virtual private gateway.

" } }, "documentation":"

Contains the parameters for CreateVpnGateway.

" }, "CreateVpnGatewayResult":{ "type":"structure", "members":{ "VpnGateway":{ "shape":"VpnGateway", "documentation":"

Information about the virtual private gateway.

", "locationName":"vpnGateway" } }, "documentation":"

Contains the output of CreateVpnGateway.

" }, "CurrencyCodeValues":{ "type":"string", "enum":["USD"] }, "CustomerGateway":{ "type":"structure", "members":{ "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

", "locationName":"customerGatewayId" }, "State":{ "shape":"String", "documentation":"

The current state of the customer gateway (pending | available | deleting | deleted).

", "locationName":"state" }, "Type":{ "shape":"String", "documentation":"

The type of VPN connection the customer gateway supports (ipsec.1).

", "locationName":"type" }, "IpAddress":{ "shape":"String", "documentation":"

The Internet-routable IP address of the customer gateway's outside interface.

", "locationName":"ipAddress" }, "BgpAsn":{ "shape":"String", "documentation":"

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", "locationName":"bgpAsn" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the customer gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes a customer gateway.

" }, "CustomerGatewayIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"CustomerGatewayId" } }, "CustomerGatewayList":{ "type":"list", "member":{ "shape":"CustomerGateway", "locationName":"item" } }, "DatafeedSubscriptionState":{ "type":"string", "enum":[ "Active", "Inactive" ] }, "DateTime":{"type":"timestamp"}, "DeleteCustomerGatewayRequest":{ "type":"structure", "required":["CustomerGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

" } }, "documentation":"

Contains the parameters for DeleteCustomerGateway.

" }, "DeleteDhcpOptionsRequest":{ "type":"structure", "required":["DhcpOptionsId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the DHCP options set.

" } }, "documentation":"

Contains the parameters for DeleteDhcpOptions.

" }, "DeleteEgressOnlyInternetGatewayRequest":{ "type":"structure", "required":["EgressOnlyInternetGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "EgressOnlyInternetGatewayId":{ "shape":"EgressOnlyInternetGatewayId", "documentation":"

The ID of the egress-only Internet gateway.

" } } }, "DeleteEgressOnlyInternetGatewayResult":{ "type":"structure", "members":{ "ReturnCode":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"returnCode" } } }, "DeleteFlowLogsRequest":{ "type":"structure", "required":["FlowLogIds"], "members":{ "FlowLogIds":{ "shape":"ValueStringList", "documentation":"

One or more flow log IDs.

", "locationName":"FlowLogId" } }, "documentation":"

Contains the parameters for DeleteFlowLogs.

" }, "DeleteFlowLogsResult":{ "type":"structure", "members":{ "Unsuccessful":{ "shape":"UnsuccessfulItemSet", "documentation":"

Information about the flow logs that could not be deleted successfully.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of DeleteFlowLogs.

" }, "DeleteInternetGatewayRequest":{ "type":"structure", "required":["InternetGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" } }, "documentation":"

Contains the parameters for DeleteInternetGateway.

" }, "DeleteKeyPairRequest":{ "type":"structure", "required":["KeyName"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

" } }, "documentation":"

Contains the parameters for DeleteKeyPair.

" }, "DeleteNatGatewayRequest":{ "type":"structure", "required":["NatGatewayId"], "members":{ "NatGatewayId":{ "shape":"String", "documentation":"

The ID of the NAT gateway.

" } }, "documentation":"

Contains the parameters for DeleteNatGateway.

" }, "DeleteNatGatewayResult":{ "type":"structure", "members":{ "NatGatewayId":{ "shape":"String", "documentation":"

The ID of the NAT gateway.

", "locationName":"natGatewayId" } }, "documentation":"

Contains the output of DeleteNatGateway.

" }, "DeleteNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Egress" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number of the entry to delete.

", "locationName":"ruleNumber" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether the rule is an egress rule.

", "locationName":"egress" } }, "documentation":"

Contains the parameters for DeleteNetworkAclEntry.

" }, "DeleteNetworkAclRequest":{ "type":"structure", "required":["NetworkAclId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" } }, "documentation":"

Contains the parameters for DeleteNetworkAcl.

" }, "DeleteNetworkInterfaceRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" } }, "documentation":"

Contains the parameters for DeleteNetworkInterface.

" }, "DeletePlacementGroupRequest":{ "type":"structure", "required":["GroupName"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

", "locationName":"groupName" } }, "documentation":"

Contains the parameters for DeletePlacementGroup.

" }, "DeleteRouteRequest":{ "type":"structure", "required":["RouteTableId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", "locationName":"destinationCidrBlock" }, "DestinationIpv6CidrBlock":{ "shape":"String", "documentation":"

The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", "locationName":"destinationIpv6CidrBlock" } }, "documentation":"

Contains the parameters for DeleteRoute.

" }, "DeleteRouteTableRequest":{ "type":"structure", "required":["RouteTableId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" } }, "documentation":"

Contains the parameters for DeleteRouteTable.

" }, "DeleteSecurityGroupRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a nondefault VPC.

" } }, "documentation":"

Contains the parameters for DeleteSecurityGroup.

" }, "DeleteSnapshotRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot.

" } }, "documentation":"

Contains the parameters for DeleteSnapshot.

" }, "DeleteSpotDatafeedSubscriptionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for DeleteSpotDatafeedSubscription.

" }, "DeleteSubnetRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

" } }, "documentation":"

Contains the parameters for DeleteSubnet.

" }, "DeleteTagsRequest":{ "type":"structure", "required":["Resources"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Resources":{ "shape":"ResourceIdList", "documentation":"

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

", "locationName":"resourceId" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

", "locationName":"tag" } }, "documentation":"

Contains the parameters for DeleteTags.

" }, "DeleteVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" } }, "documentation":"

Contains the parameters for DeleteVolume.

" }, "DeleteVpcEndpointsRequest":{ "type":"structure", "required":["VpcEndpointIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcEndpointIds":{ "shape":"ValueStringList", "documentation":"

One or more endpoint IDs.

", "locationName":"VpcEndpointId" } }, "documentation":"

Contains the parameters for DeleteVpcEndpoints.

" }, "DeleteVpcEndpointsResult":{ "type":"structure", "members":{ "Unsuccessful":{ "shape":"UnsuccessfulItemSet", "documentation":"

Information about the endpoints that were not successfully deleted.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of DeleteVpcEndpoints.

" }, "DeleteVpcPeeringConnectionRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Contains the parameters for DeleteVpcPeeringConnection.

" }, "DeleteVpcPeeringConnectionResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of DeleteVpcPeeringConnection.

" }, "DeleteVpcRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for DeleteVpc.

" }, "DeleteVpnConnectionRequest":{ "type":"structure", "required":["VpnConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" } }, "documentation":"

Contains the parameters for DeleteVpnConnection.

" }, "DeleteVpnConnectionRouteRequest":{ "type":"structure", "required":[ "VpnConnectionId", "DestinationCidrBlock" ], "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer network.

" } }, "documentation":"

Contains the parameters for DeleteVpnConnectionRoute.

" }, "DeleteVpnGatewayRequest":{ "type":"structure", "required":["VpnGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } }, "documentation":"

Contains the parameters for DeleteVpnGateway.

" }, "DeregisterImageRequest":{ "type":"structure", "required":["ImageId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" } }, "documentation":"

Contains the parameters for DeregisterImage.

" }, "DescribeAccountAttributesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AttributeNames":{ "shape":"AccountAttributeNameStringList", "documentation":"

One or more account attribute names.

", "locationName":"attributeName" } }, "documentation":"

Contains the parameters for DescribeAccountAttributes.

" }, "DescribeAccountAttributesResult":{ "type":"structure", "members":{ "AccountAttributes":{ "shape":"AccountAttributeList", "documentation":"

Information about one or more account attributes.

", "locationName":"accountAttributeSet" } }, "documentation":"

Contains the output of DescribeAccountAttributes.

" }, "DescribeAddressesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIps":{ "shape":"PublicIpStringList", "documentation":"

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", "locationName":"PublicIp" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

", "locationName":"Filter" }, "AllocationIds":{ "shape":"AllocationIdList", "documentation":"

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

", "locationName":"AllocationId" } }, "documentation":"

Contains the parameters for DescribeAddresses.

" }, "DescribeAddressesResult":{ "type":"structure", "members":{ "Addresses":{ "shape":"AddressList", "documentation":"

Information about one or more Elastic IP addresses.

", "locationName":"addressesSet" } }, "documentation":"

Contains the output of DescribeAddresses.

" }, "DescribeAvailabilityZonesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ZoneNames":{ "shape":"ZoneNameStringList", "documentation":"

The names of one or more Availability Zones.

", "locationName":"ZoneName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | information | impaired | unavailable).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeAvailabilityZones.

" }, "DescribeAvailabilityZonesResult":{ "type":"structure", "members":{ "AvailabilityZones":{ "shape":"AvailabilityZoneList", "documentation":"

Information about one or more Availability Zones.

", "locationName":"availabilityZoneInfo" } }, "documentation":"

Contains the output of DescribeAvailabiltyZones.

" }, "DescribeBundleTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "BundleIds":{ "shape":"BundleIdStringList", "documentation":"

One or more bundle task IDs.

Default: Describes all your bundle tasks.

", "locationName":"BundleId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeBundleTasks.

" }, "DescribeBundleTasksResult":{ "type":"structure", "members":{ "BundleTasks":{ "shape":"BundleTaskList", "documentation":"

Information about one or more bundle tasks.

", "locationName":"bundleInstanceTasksSet" } }, "documentation":"

Contains the output of DescribeBundleTasks.

" }, "DescribeClassicLinkInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC that the instance is linked to.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeClassicLinkInstances.

" }, "DescribeClassicLinkInstancesResult":{ "type":"structure", "members":{ "Instances":{ "shape":"ClassicLinkInstanceList", "documentation":"

Information about one or more linked EC2-Classic instances.

", "locationName":"instancesSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeClassicLinkInstances.

" }, "DescribeConversionTaskList":{ "type":"list", "member":{ "shape":"ConversionTask", "locationName":"item" } }, "DescribeConversionTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ConversionTaskIds":{ "shape":"ConversionIdStringList", "documentation":"

One or more conversion task IDs.

", "locationName":"conversionTaskId" } }, "documentation":"

Contains the parameters for DescribeConversionTasks.

" }, "DescribeConversionTasksResult":{ "type":"structure", "members":{ "ConversionTasks":{ "shape":"DescribeConversionTaskList", "documentation":"

Information about the conversion tasks.

", "locationName":"conversionTasks" } }, "documentation":"

Contains the output for DescribeConversionTasks.

" }, "DescribeCustomerGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "CustomerGatewayIds":{ "shape":"CustomerGatewayIdStringList", "documentation":"

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", "locationName":"CustomerGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeCustomerGateways.

" }, "DescribeCustomerGatewaysResult":{ "type":"structure", "members":{ "CustomerGateways":{ "shape":"CustomerGatewayList", "documentation":"

Information about one or more customer gateways.

", "locationName":"customerGatewaySet" } }, "documentation":"

Contains the output of DescribeCustomerGateways.

" }, "DescribeDhcpOptionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpOptionsIds":{ "shape":"DhcpOptionsIdStringList", "documentation":"

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", "locationName":"DhcpOptionsId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • dhcp-options-id - The ID of a set of DHCP options.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeDhcpOptions.

" }, "DescribeDhcpOptionsResult":{ "type":"structure", "members":{ "DhcpOptions":{ "shape":"DhcpOptionsList", "documentation":"

Information about one or more DHCP options sets.

", "locationName":"dhcpOptionsSet" } }, "documentation":"

Contains the output of DescribeDhcpOptions.

" }, "DescribeEgressOnlyInternetGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "EgressOnlyInternetGatewayIds":{ "shape":"EgressOnlyInternetGatewayIdList", "documentation":"

One or more egress-only Internet gateway IDs.

", "locationName":"EgressOnlyInternetGatewayId" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.

" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" } } }, "DescribeEgressOnlyInternetGatewaysResult":{ "type":"structure", "members":{ "EgressOnlyInternetGateways":{ "shape":"EgressOnlyInternetGatewayList", "documentation":"

Information about the egress-only Internet gateways.

", "locationName":"egressOnlyInternetGatewaySet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results.

", "locationName":"nextToken" } } }, "DescribeExportTasksRequest":{ "type":"structure", "members":{ "ExportTaskIds":{ "shape":"ExportTaskIdStringList", "documentation":"

One or more export task IDs.

", "locationName":"exportTaskId" } }, "documentation":"

Contains the parameters for DescribeExportTasks.

" }, "DescribeExportTasksResult":{ "type":"structure", "members":{ "ExportTasks":{ "shape":"ExportTaskList", "documentation":"

Information about the export tasks.

", "locationName":"exportTaskSet" } }, "documentation":"

Contains the output for DescribeExportTasks.

" }, "DescribeFlowLogsRequest":{ "type":"structure", "members":{ "FlowLogIds":{ "shape":"ValueStringList", "documentation":"

One or more flow log IDs.

", "locationName":"FlowLogId" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

  • flow-log-id - The ID of the flow log.

  • log-group-name - The name of the log group.

  • resource-id - The ID of the VPC, subnet, or network interface.

  • traffic-type - The type of traffic (ACCEPT | REJECT | ALL)

" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the flow log IDs parameter in the same request.

" } }, "documentation":"

Contains the parameters for DescribeFlowLogs.

" }, "DescribeFlowLogsResult":{ "type":"structure", "members":{ "FlowLogs":{ "shape":"FlowLogSet", "documentation":"

Information about the flow logs.

", "locationName":"flowLogSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeFlowLogs.

" }, "DescribeHostReservationOfferingsRequest":{ "type":"structure", "members":{ "OfferingId":{ "shape":"String", "documentation":"

The ID of the reservation offering.

" }, "MinDuration":{ "shape":"Integer", "documentation":"

This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.

" }, "MaxDuration":{ "shape":"Integer", "documentation":"

This is the maximum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.

" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • instance-family - The instance family of the offering (e.g., m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error.

" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results.

" } } }, "DescribeHostReservationOfferingsResult":{ "type":"structure", "members":{ "OfferingSet":{ "shape":"HostOfferingSet", "documentation":"

Information about the offerings.

", "locationName":"offeringSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeHostReservationsRequest":{ "type":"structure", "members":{ "HostReservationIdSet":{ "shape":"HostReservationIdSet", "documentation":"

One or more host reservation IDs.

" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • instance-family - The instance family (e.g., m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | retired).

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error.

" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results.

" } } }, "DescribeHostReservationsResult":{ "type":"structure", "members":{ "HostReservationSet":{ "shape":"HostReservationSet", "documentation":"

Details about the reservation's configuration.

", "locationName":"hostReservationSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeHostsRequest":{ "type":"structure", "members":{ "HostIds":{ "shape":"RequestHostIdList", "documentation":"

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

", "locationName":"hostId" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error. You cannot specify this parameter and the host IDs parameter in the same request.

", "locationName":"maxResults" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • host-reservation-id - The ID of the reservation assigned to this host.

  • client-token - The idempotency token you provided when you launched the instance

  • state- The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • availability-zone - The Availability Zone of the host.

", "locationName":"filter" } }, "documentation":"

Contains the parameters for DescribeHosts.

" }, "DescribeHostsResult":{ "type":"structure", "members":{ "Hosts":{ "shape":"HostList", "documentation":"

Information about the Dedicated Hosts.

", "locationName":"hostSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeHosts.

" }, "DescribeIdFormatRequest":{ "type":"structure", "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource: instance | reservation | snapshot | volume

" } }, "documentation":"

Contains the parameters for DescribeIdFormat.

" }, "DescribeIdFormatResult":{ "type":"structure", "members":{ "Statuses":{ "shape":"IdFormatList", "documentation":"

Information about the ID format for the resource.

", "locationName":"statusSet" } }, "documentation":"

Contains the output of DescribeIdFormat.

" }, "DescribeIdentityIdFormatRequest":{ "type":"structure", "required":["PrincipalArn"], "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource: instance | reservation | snapshot | volume

", "locationName":"resource" }, "PrincipalArn":{ "shape":"String", "documentation":"

The ARN of the principal, which can be an IAM role, IAM user, or the root user.

", "locationName":"principalArn" } }, "documentation":"

Contains the parameters for DescribeIdentityIdFormat.

" }, "DescribeIdentityIdFormatResult":{ "type":"structure", "members":{ "Statuses":{ "shape":"IdFormatList", "documentation":"

Information about the ID format for the resources.

", "locationName":"statusSet" } }, "documentation":"

Contains the output of DescribeIdentityIdFormat.

" }, "DescribeImageAttributeRequest":{ "type":"structure", "required":[ "ImageId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"ImageAttributeName", "documentation":"

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

" } }, "documentation":"

Contains the parameters for DescribeImageAttribute.

" }, "DescribeImagesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageIds":{ "shape":"ImageIdStringList", "documentation":"

One or more image IDs.

Default: Describes all images available to you.

", "locationName":"ImageId" }, "Owners":{ "shape":"OwnerStringList", "documentation":"

Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace | microsoft). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

", "locationName":"Owner" }, "ExecutableUsers":{ "shape":"ExecutableByStringList", "documentation":"

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", "locationName":"ExecutableBy" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • architecture - The image architecture (i386 | x86_64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

  • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

  • description - The description of the image (provided during image creation).

  • ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - String value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeImages.

" }, "DescribeImagesResult":{ "type":"structure", "members":{ "Images":{ "shape":"ImageList", "documentation":"

Information about one or more images.

", "locationName":"imagesSet" } }, "documentation":"

Contains the output of DescribeImages.

" }, "DescribeImportImageTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ImportTaskIds":{ "shape":"ImportTaskIdList", "documentation":"

A list of import image task IDs.

", "locationName":"ImportTaskId" }, "NextToken":{ "shape":"String", "documentation":"

A token that indicates the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" }, "Filters":{ "shape":"FilterList", "documentation":"

Filter tasks using the task-state filter and one of the following values: active, completed, deleting, deleted.

" } }, "documentation":"

Contains the parameters for DescribeImportImageTasks.

" }, "DescribeImportImageTasksResult":{ "type":"structure", "members":{ "ImportImageTasks":{ "shape":"ImportImageTaskList", "documentation":"

A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.

", "locationName":"importImageTaskSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output for DescribeImportImageTasks.

" }, "DescribeImportSnapshotTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ImportTaskIds":{ "shape":"ImportTaskIdList", "documentation":"

A list of import snapshot task IDs.

", "locationName":"ImportTaskId" }, "NextToken":{ "shape":"String", "documentation":"

A token that indicates the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

" } }, "documentation":"

Contains the parameters for DescribeImportSnapshotTasks.

" }, "DescribeImportSnapshotTasksResult":{ "type":"structure", "members":{ "ImportSnapshotTasks":{ "shape":"ImportSnapshotTaskList", "documentation":"

A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.

", "locationName":"importSnapshotTaskSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output for DescribeImportSnapshotTasks.

" }, "DescribeInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The instance attribute.

Note: The enaSupport attribute is not supported at this time.

", "locationName":"attribute" } }, "documentation":"

Contains the parameters for DescribeInstanceAttribute.

" }, "DescribeInstanceStatusRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

" }, "IncludeAllInstances":{ "shape":"Boolean", "documentation":"

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", "locationName":"includeAllInstances" } }, "documentation":"

Contains the parameters for DescribeInstanceStatus.

" }, "DescribeInstanceStatusResult":{ "type":"structure", "members":{ "InstanceStatuses":{ "shape":"InstanceStatusList", "documentation":"

One or more instance status descriptions.

", "locationName":"instanceStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeInstanceStatus.

" }, "DescribeInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Default: Describes all your instances.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • affinity - The affinity setting for an instance running on a Dedicated Host (default | host).

  • architecture - The instance architecture (i386 | x86_64).

  • association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

  • association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • host-id - The ID of the Dedicated Host on which the instance is running, if applicable.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IPv4 address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - 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 - The time when the instance was launched.

  • monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).

  • network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.

  • network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.description - The description of the network interface.

  • network-interface.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.private-dns-name - The private DNS name of the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.source-dest-check - 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.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.

  • private-dns-name - The private IPv4 DNS name of the instance.

  • private-ip-address - The private IPv4 address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - 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 - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - 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 - The name of the root device for the instance (for example, /dev/sda1 or /dev/xvda).

  • root-device-type - The type of root device that the instance uses (ebs | instance-store).

  • source-dest-check - 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 - The ID of the Spot instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • tenancy - The tenancy of an instance (dedicated | default | host).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to request the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter or tag filters in the same call.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeInstances.

" }, "DescribeInstancesResult":{ "type":"structure", "members":{ "Reservations":{ "shape":"ReservationList", "documentation":"

Zero or more reservations.

", "locationName":"reservationSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeInstances.

" }, "DescribeInternetGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayIds":{ "shape":"ValueStringList", "documentation":"

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

", "locationName":"internetGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeInternetGateways.

" }, "DescribeInternetGatewaysResult":{ "type":"structure", "members":{ "InternetGateways":{ "shape":"InternetGatewayList", "documentation":"

Information about one or more Internet gateways.

", "locationName":"internetGatewaySet" } }, "documentation":"

Contains the output of DescribeInternetGateways.

" }, "DescribeKeyPairsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyNames":{ "shape":"KeyNameStringList", "documentation":"

One or more key pair names.

Default: Describes all your key pairs.

", "locationName":"KeyName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeKeyPairs.

" }, "DescribeKeyPairsResult":{ "type":"structure", "members":{ "KeyPairs":{ "shape":"KeyPairList", "documentation":"

Information about one or more key pairs.

", "locationName":"keySet" } }, "documentation":"

Contains the output of DescribeKeyPairs.

" }, "DescribeMovingAddressesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIps":{ "shape":"ValueStringList", "documentation":"

One or more Elastic IP addresses.

", "locationName":"publicIp" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results.

", "locationName":"nextToken" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).

", "locationName":"filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.

Default: If no value is provided, the default is 1000.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeMovingAddresses.

" }, "DescribeMovingAddressesResult":{ "type":"structure", "members":{ "MovingAddressStatuses":{ "shape":"MovingAddressStatusSet", "documentation":"

The status for each Elastic IP address.

", "locationName":"movingAddressStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeMovingAddresses.

" }, "DescribeNatGatewaysRequest":{ "type":"structure", "members":{ "NatGatewayIds":{ "shape":"ValueStringList", "documentation":"

One or more NAT gateway IDs.

", "locationName":"NatGatewayId" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

  • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" } }, "documentation":"

Contains the parameters for DescribeNatGateways.

" }, "DescribeNatGatewaysResult":{ "type":"structure", "members":{ "NatGateways":{ "shape":"NatGatewayList", "documentation":"

Information about the NAT gateways.

", "locationName":"natGatewaySet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeNatGateways.

" }, "DescribeNetworkAclsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclIds":{ "shape":"ValueStringList", "documentation":"

One or more network ACL IDs.

Default: Describes all your network ACLs.

", "locationName":"NetworkAclId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The IPv4 CIDR range specified in the entry.

  • entry.egress - Indicates whether the entry applies to egress traffic.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.

  • network-acl-id - The ID of the network ACL.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network ACL.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeNetworkAcls.

" }, "DescribeNetworkAclsResult":{ "type":"structure", "members":{ "NetworkAcls":{ "shape":"NetworkAclList", "documentation":"

Information about one or more network ACLs.

", "locationName":"networkAclSet" } }, "documentation":"

Contains the output of DescribeNetworkAcls.

" }, "DescribeNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Attribute":{ "shape":"NetworkInterfaceAttribute", "documentation":"

The attribute of the network interface.

", "locationName":"attribute" } }, "documentation":"

Contains the parameters for DescribeNetworkInterfaceAttribute.

" }, "DescribeNetworkInterfaceAttributeResult":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Description":{ "shape":"AttributeValue", "documentation":"

The description of the network interface.

", "locationName":"description" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

The security groups associated with the network interface.

", "locationName":"groupSet" }, "Attachment":{ "shape":"NetworkInterfaceAttachment", "documentation":"

The attachment (if any) of the network interface.

", "locationName":"attachment" } }, "documentation":"

Contains the output of DescribeNetworkInterfaceAttribute.

" }, "DescribeNetworkInterfacesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceIds":{ "shape":"NetworkInterfaceIdList", "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", "locationName":"NetworkInterfaceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IPv4 addresses associated with the network interface.

  • addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

  • association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface (IPv4).

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.attach.time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.nat-gateway-id - The ID of the NAT gateway to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IPv4 address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface (IPv4).

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-desk-check - 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 - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network interface.

", "locationName":"filter" } }, "documentation":"

Contains the parameters for DescribeNetworkInterfaces.

" }, "DescribeNetworkInterfacesResult":{ "type":"structure", "members":{ "NetworkInterfaces":{ "shape":"NetworkInterfaceList", "documentation":"

Information about one or more network interfaces.

", "locationName":"networkInterfaceSet" } }, "documentation":"

Contains the output of DescribeNetworkInterfaces.

" }, "DescribePlacementGroupsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupNames":{ "shape":"PlacementGroupStringList", "documentation":"

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

", "locationName":"groupName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribePlacementGroups.

" }, "DescribePlacementGroupsResult":{ "type":"structure", "members":{ "PlacementGroups":{ "shape":"PlacementGroupList", "documentation":"

One or more placement groups.

", "locationName":"placementGroupSet" } }, "documentation":"

Contains the output of DescribePlacementGroups.

" }, "DescribePrefixListsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "PrefixListIds":{ "shape":"ValueStringList", "documentation":"

One or more prefix list IDs.

", "locationName":"PrefixListId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • prefix-list-id: The ID of a prefix list.

  • prefix-list-name: The name of a prefix list.

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } }, "documentation":"

Contains the parameters for DescribePrefixLists.

" }, "DescribePrefixListsResult":{ "type":"structure", "members":{ "PrefixLists":{ "shape":"PrefixListSet", "documentation":"

All available prefix lists.

", "locationName":"prefixListSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribePrefixLists.

" }, "DescribeRegionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RegionNames":{ "shape":"RegionNameStringList", "documentation":"

The names of one or more regions.

", "locationName":"RegionName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

  • region-name - The name of the region (for example, us-east-1).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeRegions.

" }, "DescribeRegionsResult":{ "type":"structure", "members":{ "Regions":{ "shape":"RegionList", "documentation":"

Information about one or more regions.

", "locationName":"regionInfo" } }, "documentation":"

Contains the output of DescribeRegions.

" }, "DescribeReservedInstancesListingsRequest":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

One or more Reserved Instance IDs.

", "locationName":"reservedInstancesId" }, "ReservedInstancesListingId":{ "shape":"String", "documentation":"

One or more Reserved Instance listing IDs.

", "locationName":"reservedInstancesListingId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeReservedInstancesListings.

" }, "DescribeReservedInstancesListingsResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

Information about the Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } }, "documentation":"

Contains the output of DescribeReservedInstancesListings.

" }, "DescribeReservedInstancesModificationsRequest":{ "type":"structure", "members":{ "ReservedInstancesModificationIds":{ "shape":"ReservedInstancesModificationIdStringList", "documentation":"

IDs for the submitted modification request.

", "locationName":"ReservedInstancesModificationId" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeReservedInstancesModifications.

" }, "DescribeReservedInstancesModificationsResult":{ "type":"structure", "members":{ "ReservedInstancesModifications":{ "shape":"ReservedInstancesModificationList", "documentation":"

The Reserved Instance modification information.

", "locationName":"reservedInstancesModificationsSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeReservedInstancesModifications.

" }, "DescribeReservedInstancesOfferingsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ReservedInstancesOfferingIds":{ "shape":"ReservedInstancesOfferingIdStringList", "documentation":"

One or more Reserved Instances offering IDs.

", "locationName":"ReservedInstancesOfferingId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • scope - The scope of the Reserved Instance (Availability Zone or Region).

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", "locationName":"Filter" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

Default: default

", "locationName":"instanceTenancy" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", "locationName":"offeringType" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

", "locationName":"maxResults" }, "IncludeMarketplace":{ "shape":"Boolean", "documentation":"

Include Reserved Instance Marketplace offerings in the response.

" }, "MinDuration":{ "shape":"Long", "documentation":"

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

" }, "MaxDuration":{ "shape":"Long", "documentation":"

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

" }, "MaxInstanceCount":{ "shape":"Integer", "documentation":"

The maximum number of instances to filter when searching for offerings.

Default: 20

" }, "OfferingClass":{ "shape":"OfferingClassType", "documentation":"

The offering class of the Reserved Instance. Can be standard or convertible.

" } }, "documentation":"

Contains the parameters for DescribeReservedInstancesOfferings.

" }, "DescribeReservedInstancesOfferingsResult":{ "type":"structure", "members":{ "ReservedInstancesOfferings":{ "shape":"ReservedInstancesOfferingList", "documentation":"

A list of Reserved Instances offerings.

", "locationName":"reservedInstancesOfferingsSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeReservedInstancesOfferings.

" }, "DescribeReservedInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ReservedInstancesIds":{ "shape":"ReservedInstancesIdStringList", "documentation":"

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

", "locationName":"ReservedInstancesId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • scope - The scope of the Reserved Instance (Region or Availability Zone).

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", "locationName":"Filter" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", "locationName":"offeringType" }, "OfferingClass":{ "shape":"OfferingClassType", "documentation":"

Describes whether the Reserved Instance is Standard or Convertible.

" } }, "documentation":"

Contains the parameters for DescribeReservedInstances.

" }, "DescribeReservedInstancesResult":{ "type":"structure", "members":{ "ReservedInstances":{ "shape":"ReservedInstancesList", "documentation":"

A list of Reserved Instances.

", "locationName":"reservedInstancesSet" } }, "documentation":"

Contains the output for DescribeReservedInstances.

" }, "DescribeRouteTablesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs.

Default: Describes all your route tables.

", "locationName":"RouteTableId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC (true | false).

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.

  • route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.

  • route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table.

  • route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.nat-gateway-id - The ID of a NAT gateway.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). 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).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the route table.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeRouteTables.

" }, "DescribeRouteTablesResult":{ "type":"structure", "members":{ "RouteTables":{ "shape":"RouteTableList", "documentation":"

Information about one or more route tables.

", "locationName":"routeTableSet" } }, "documentation":"

Contains the output of DescribeRouteTables.

" }, "DescribeScheduledInstanceAvailabilityRequest":{ "type":"structure", "required":[ "Recurrence", "FirstSlotStartTimeRange" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "Recurrence":{ "shape":"ScheduledInstanceRecurrenceRequest", "documentation":"

The schedule recurrence.

" }, "FirstSlotStartTimeRange":{ "shape":"SlotDateTimeRangeRequest", "documentation":"

The time period for the first schedule to start.

" }, "MinSlotDurationInHours":{ "shape":"Integer", "documentation":"

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

" }, "MaxSlotDurationInHours":{ "shape":"Integer", "documentation":"

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned NextToken value.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeScheduledInstanceAvailability.

" }, "DescribeScheduledInstanceAvailabilityResult":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" }, "ScheduledInstanceAvailabilitySet":{ "shape":"ScheduledInstanceAvailabilitySet", "documentation":"

Information about the available Scheduled Instances.

", "locationName":"scheduledInstanceAvailabilitySet" } }, "documentation":"

Contains the output of DescribeScheduledInstanceAvailability.

" }, "DescribeScheduledInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ScheduledInstanceIds":{ "shape":"ScheduledInstanceIdRequestSet", "documentation":"

One or more Scheduled Instance IDs.

", "locationName":"ScheduledInstanceId" }, "SlotStartTimeRange":{ "shape":"SlotStartTimeRangeRequest", "documentation":"

The time period for the first schedule to start.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeScheduledInstances.

" }, "DescribeScheduledInstancesResult":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" }, "ScheduledInstanceSet":{ "shape":"ScheduledInstanceSet", "documentation":"

Information about the Scheduled Instances.

", "locationName":"scheduledInstanceSet" } }, "documentation":"

Contains the output of DescribeScheduledInstances.

" }, "DescribeSecurityGroupReferencesRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "GroupId":{ "shape":"GroupIds", "documentation":"

One or more security group IDs in your account.

" } } }, "DescribeSecurityGroupReferencesResult":{ "type":"structure", "members":{ "SecurityGroupReferenceSet":{ "shape":"SecurityGroupReferences", "documentation":"

Information about the VPCs with the referencing security groups.

", "locationName":"securityGroupReferenceSet" } } }, "DescribeSecurityGroupsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupNames":{ "shape":"GroupNameStringList", "documentation":"

[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

", "locationName":"GroupName" }, "GroupIds":{ "shape":"GroupIdStringList", "documentation":"

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

", "locationName":"GroupId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which the security group allows access.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - An IPv4 CIDR range that has been granted permission in a security group rule.

  • ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been granted permission.

  • ip-permission.group-name - The name of a security group that has been granted permission.

  • ip-permission.ipv6-cidr - An IPv6 CIDR range that has been granted permission in a security group rule.

  • ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been granted permission.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag-key - The key of a tag assigned to the security group.

  • tag-value - The value of a tag assigned to the security group.

  • vpc-id - The ID of the VPC specified when the security group was created.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeSecurityGroups.

" }, "DescribeSecurityGroupsResult":{ "type":"structure", "members":{ "SecurityGroups":{ "shape":"SecurityGroupList", "documentation":"

Information about one or more security groups.

", "locationName":"securityGroupInfo" } }, "documentation":"

Contains the output of DescribeSecurityGroups.

" }, "DescribeSnapshotAttributeRequest":{ "type":"structure", "required":[ "SnapshotId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The snapshot attribute you would like to view.

" } }, "documentation":"

Contains the parameters for DescribeSnapshotAttribute.

" }, "DescribeSnapshotAttributeResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot.

", "locationName":"snapshotId" }, "CreateVolumePermissions":{ "shape":"CreateVolumePermissionList", "documentation":"

A list of permissions for creating volumes from the snapshot.

", "locationName":"createVolumePermission" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" } }, "documentation":"

Contains the output of DescribeSnapshotAttribute.

" }, "DescribeSnapshotsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotIds":{ "shape":"SnapshotIdStringList", "documentation":"

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

", "locationName":"SnapshotId" }, "OwnerIds":{ "shape":"OwnerStringList", "documentation":"

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

", "locationName":"Owner" }, "RestorableByUserIds":{ "shape":"RestorableByStringList", "documentation":"

One or more AWS accounts IDs that can create volumes from the snapshot.

", "locationName":"RestorableBy" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • description - A description of the snapshot.

  • owner-alias - Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM consolew.

  • owner-id - The ID of the AWS account that owns the snapshot.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

" } }, "documentation":"

Contains the parameters for DescribeSnapshots.

" }, "DescribeSnapshotsResult":{ "type":"structure", "members":{ "Snapshots":{ "shape":"SnapshotList", "documentation":"

Information about the snapshots.

", "locationName":"snapshotSet" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSnapshots.

" }, "DescribeSpotDatafeedSubscriptionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for DescribeSpotDatafeedSubscription.

" }, "DescribeSpotDatafeedSubscriptionResult":{ "type":"structure", "members":{ "SpotDatafeedSubscription":{ "shape":"SpotDatafeedSubscription", "documentation":"

The Spot instance data feed subscription.

", "locationName":"spotDatafeedSubscription" } }, "documentation":"

Contains the output of DescribeSpotDatafeedSubscription.

" }, "DescribeSpotFleetInstancesRequest":{ "type":"structure", "required":["SpotFleetRequestId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeSpotFleetInstances.

" }, "DescribeSpotFleetInstancesResponse":{ "type":"structure", "required":[ "SpotFleetRequestId", "ActiveInstances" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "ActiveInstances":{ "shape":"ActiveInstanceSet", "documentation":"

The running instances. Note that this list is refreshed periodically and might be out of date.

", "locationName":"activeInstanceSet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotFleetInstances.

" }, "DescribeSpotFleetRequestHistoryRequest":{ "type":"structure", "required":[ "SpotFleetRequestId", "StartTime" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "EventType":{ "shape":"EventType", "documentation":"

The type of events to describe. By default, all events are described.

", "locationName":"eventType" }, "StartTime":{ "shape":"DateTime", "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"startTime" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeSpotFleetRequestHistory.

" }, "DescribeSpotFleetRequestHistoryResponse":{ "type":"structure", "required":[ "SpotFleetRequestId", "StartTime", "LastEvaluatedTime", "HistoryRecords" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "StartTime":{ "shape":"DateTime", "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"startTime" }, "LastEvaluatedTime":{ "shape":"DateTime", "documentation":"

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

If nextToken indicates that there are more results, this value is not present.

", "locationName":"lastEvaluatedTime" }, "HistoryRecords":{ "shape":"HistoryRecords", "documentation":"

Information about the events in the history of the Spot fleet request.

", "locationName":"historyRecordSet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotFleetRequestHistory.

" }, "DescribeSpotFleetRequestsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestIds":{ "shape":"ValueStringList", "documentation":"

The IDs of the Spot fleet requests.

", "locationName":"spotFleetRequestId" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeSpotFleetRequests.

" }, "DescribeSpotFleetRequestsResponse":{ "type":"structure", "required":["SpotFleetRequestConfigs"], "members":{ "SpotFleetRequestConfigs":{ "shape":"SpotFleetRequestConfigSet", "documentation":"

Information about the configuration of your Spot fleet.

", "locationName":"spotFleetRequestConfigSet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotFleetRequests.

" }, "DescribeSpotInstanceRequestsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotInstanceRequestIds":{ "shape":"SpotInstanceRequestIdList", "documentation":"

One or more Spot instance request IDs.

", "locationName":"SpotInstanceRequestId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume: gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.

  • launch.group-id - The security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m3.medium).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether monitoring is enabled for the Spot instance.

  • launch.ramdisk-id - The RAM disk ID.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • network-interface.description - A description of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.group-name - The name of the security group associated with the network interface.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot instance request ID.

  • spot-price - The maximum hourly price for any Spot instance launched to fulfill the request.

  • state - The state of the Spot instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

  • status-code - The short code describing the most recent evaluation of your Spot instance request.

  • status-message - The message explaining the status of the Spot instance request.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of Spot instance request (one-time | persistent).

  • launched-availability-zone - The Availability Zone in which the bid is launched.

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeSpotInstanceRequests.

" }, "DescribeSpotInstanceRequestsResult":{ "type":"structure", "members":{ "SpotInstanceRequests":{ "shape":"SpotInstanceRequestList", "documentation":"

One or more Spot instance requests.

", "locationName":"spotInstanceRequestSet" } }, "documentation":"

Contains the output of DescribeSpotInstanceRequests.

" }, "DescribeSpotPriceHistoryRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "StartTime":{ "shape":"DateTime", "documentation":"

The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"startTime" }, "EndTime":{ "shape":"DateTime", "documentation":"

The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"endTime" }, "InstanceTypes":{ "shape":"InstanceTypeList", "documentation":"

Filters the results by the specified instance types. Note that T2 and HS1 instance types are not supported.

", "locationName":"InstanceType" }, "ProductDescriptions":{ "shape":"ProductDescriptionList", "documentation":"

Filters the results by the specified basic product descriptions.

", "locationName":"ProductDescription" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m3.medium).

  • product-description - The product description for the Spot price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - The timestamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

", "locationName":"Filter" }, "AvailabilityZone":{ "shape":"String", "documentation":"

Filters the results by the specified Availability Zone.

", "locationName":"availabilityZone" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" } }, "documentation":"

Contains the parameters for DescribeSpotPriceHistory.

" }, "DescribeSpotPriceHistoryResult":{ "type":"structure", "members":{ "SpotPriceHistory":{ "shape":"SpotPriceHistoryList", "documentation":"

The historical Spot prices.

", "locationName":"spotPriceHistorySet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotPriceHistory.

" }, "DescribeStaleSecurityGroupsRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } } }, "DescribeStaleSecurityGroupsResult":{ "type":"structure", "members":{ "StaleSecurityGroupSet":{ "shape":"StaleSecurityGroupSet", "documentation":"

Information about the stale security groups.

", "locationName":"staleSecurityGroupSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } } }, "DescribeSubnetsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SubnetIds":{ "shape":"SubnetIdStringList", "documentation":"

One or more subnet IDs.

Default: Describes all your subnets.

", "locationName":"SubnetId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

  • available-ip-address-count - The number of IPv4 addresses in the subnet that are available.

  • cidrBlock - The IPv4 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. You can also use cidr or cidr-block as the filter names.

  • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

  • ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

  • ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

  • ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

  • state - The state of the subnet (pending | available).

  • subnet-id - The ID of the subnet.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the subnet.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeSubnets.

" }, "DescribeSubnetsResult":{ "type":"structure", "members":{ "Subnets":{ "shape":"SubnetList", "documentation":"

Information about one or more subnets.

", "locationName":"subnetSet" } }, "documentation":"

Contains the output of DescribeSubnets.

" }, "DescribeTagsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • key - The tag key.

  • resource-id - The resource ID.

  • resource-type - The resource type (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).

  • value - The tag value.

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" } }, "documentation":"

Contains the parameters for DescribeTags.

" }, "DescribeTagsResult":{ "type":"structure", "members":{ "Tags":{ "shape":"TagDescriptionList", "documentation":"

A list of tags.

", "locationName":"tagSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return..

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeTags.

" }, "DescribeVolumeAttributeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "Attribute":{ "shape":"VolumeAttributeName", "documentation":"

The instance attribute.

" } }, "documentation":"

Contains the parameters for DescribeVolumeAttribute.

" }, "DescribeVolumeAttributeResult":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "AutoEnableIO":{ "shape":"AttributeBooleanValue", "documentation":"

The state of autoEnableIO attribute.

", "locationName":"autoEnableIO" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" } }, "documentation":"

Contains the output of DescribeVolumeAttribute.

" }, "DescribeVolumeStatusRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeIds":{ "shape":"VolumeIdStringList", "documentation":"

One or more volume IDs.

Default: Describes all your volumes.

", "locationName":"VolumeId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

" } }, "documentation":"

Contains the parameters for DescribeVolumeStatus.

" }, "DescribeVolumeStatusResult":{ "type":"structure", "members":{ "VolumeStatuses":{ "shape":"VolumeStatusList", "documentation":"

A list of volumes.

", "locationName":"volumeStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVolumeStatus.

" }, "DescribeVolumesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeIds":{ "shape":"VolumeIdStringList", "documentation":"

One or more volume IDs.

", "locationName":"VolumeId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - The encryption status of the volume.

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The status of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeVolumes.

" }, "DescribeVolumesResult":{ "type":"structure", "members":{ "Volumes":{ "shape":"VolumeList", "documentation":"

Information about the volumes.

", "locationName":"volumeSet" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVolumes.

" }, "DescribeVpcAttributeRequest":{ "type":"structure", "required":[ "VpcId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "Attribute":{ "shape":"VpcAttributeName", "documentation":"

The VPC attribute.

" } }, "documentation":"

Contains the parameters for DescribeVpcAttribute.

" }, "DescribeVpcAttributeResult":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "EnableDnsSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

", "locationName":"enableDnsSupport" }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

", "locationName":"enableDnsHostnames" } }, "documentation":"

Contains the output of DescribeVpcAttribute.

" }, "DescribeVpcClassicLinkDnsSupportRequest":{ "type":"structure", "members":{ "VpcIds":{ "shape":"VpcClassicLinkIdList", "documentation":"

One or more VPC IDs.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

", "locationName":"nextToken" } }, "documentation":"

Contains the parameters for DescribeVpcClassicLinkDnsSupport.

" }, "DescribeVpcClassicLinkDnsSupportResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"ClassicLinkDnsSupportList", "documentation":"

Information about the ClassicLink DNS support status of the VPCs.

", "locationName":"vpcs" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVpcClassicLinkDnsSupport.

" }, "DescribeVpcClassicLinkRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcIds":{ "shape":"VpcClassicLinkIdList", "documentation":"

One or more VPCs for which you want to describe the ClassicLink status.

", "locationName":"VpcId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpcClassicLink.

" }, "DescribeVpcClassicLinkResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"VpcClassicLinkList", "documentation":"

The ClassicLink status of one or more VPCs.

", "locationName":"vpcSet" } }, "documentation":"

Contains the output of DescribeVpcClassicLink.

" }, "DescribeVpcEndpointServicesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } }, "documentation":"

Contains the parameters for DescribeVpcEndpointServices.

" }, "DescribeVpcEndpointServicesResult":{ "type":"structure", "members":{ "ServiceNames":{ "shape":"ValueStringList", "documentation":"

A list of supported AWS services.

", "locationName":"serviceNameSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVpcEndpointServices.

" }, "DescribeVpcEndpointsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcEndpointIds":{ "shape":"ValueStringList", "documentation":"

One or more endpoint IDs.

", "locationName":"VpcEndpointId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • service-name: The name of the AWS service.

  • vpc-id: The ID of the VPC in which the endpoint resides.

  • vpc-endpoint-id: The ID of the endpoint.

  • vpc-endpoint-state: The state of the endpoint. (pending | available | deleting | deleted)

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } }, "documentation":"

Contains the parameters for DescribeVpcEndpoints.

" }, "DescribeVpcEndpointsResult":{ "type":"structure", "members":{ "VpcEndpoints":{ "shape":"VpcEndpointSet", "documentation":"

Information about the endpoints.

", "locationName":"vpcEndpointSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVpcEndpoints.

" }, "DescribeVpcPeeringConnectionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionIds":{ "shape":"ValueStringList", "documentation":"

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

", "locationName":"VpcPeeringConnectionId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • accepter-vpc-info.cidr-block - The IPv4 CIDR block of the peer VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

  • accepter-vpc-info.vpc-id - The ID of the peer VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpcPeeringConnections.

" }, "DescribeVpcPeeringConnectionsResult":{ "type":"structure", "members":{ "VpcPeeringConnections":{ "shape":"VpcPeeringConnectionList", "documentation":"

Information about the VPC peering connections.

", "locationName":"vpcPeeringConnectionSet" } }, "documentation":"

Contains the output of DescribeVpcPeeringConnections.

" }, "DescribeVpcsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcIds":{ "shape":"VpcIdStringList", "documentation":"

One or more VPC IDs.

Default: Describes all your VPCs.

", "locationName":"VpcId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • cidr - The IPv4 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. Must contain the slash followed by one or two digits (for example, /28).

  • dhcp-options-id - The ID of a set of DHCP options.

  • ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.

  • ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.

  • ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.

  • isDefault - Indicates whether the VPC is the default VPC.

  • state - The state of the VPC (pending | available).

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpcs.

" }, "DescribeVpcsResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"VpcList", "documentation":"

Information about one or more VPCs.

", "locationName":"vpcSet" } }, "documentation":"

Contains the output of DescribeVpcs.

" }, "DescribeVpnConnectionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnConnectionIds":{ "shape":"VpnConnectionIdStringList", "documentation":"

One or more VPN connection IDs.

Default: Describes your VPN connections.

", "locationName":"VpnConnectionId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpnConnections.

" }, "DescribeVpnConnectionsResult":{ "type":"structure", "members":{ "VpnConnections":{ "shape":"VpnConnectionList", "documentation":"

Information about one or more VPN connections.

", "locationName":"vpnConnectionSet" } }, "documentation":"

Contains the output of DescribeVpnConnections.

" }, "DescribeVpnGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayIds":{ "shape":"VpnGatewayIdStringList", "documentation":"

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

", "locationName":"VpnGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway (if applicable).

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpnGateways.

" }, "DescribeVpnGatewaysResult":{ "type":"structure", "members":{ "VpnGateways":{ "shape":"VpnGatewayList", "documentation":"

Information about one or more virtual private gateways.

", "locationName":"vpnGatewaySet" } }, "documentation":"

Contains the output of DescribeVpnGateways.

" }, "DetachClassicLinkVpcRequest":{ "type":"structure", "required":[ "InstanceId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance to unlink from the VPC.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC to which the instance is linked.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for DetachClassicLinkVpc.

" }, "DetachClassicLinkVpcResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of DetachClassicLinkVpc.

" }, "DetachInternetGatewayRequest":{ "type":"structure", "required":[ "InternetGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for DetachInternetGateway.

" }, "DetachNetworkInterfaceRequest":{ "type":"structure", "required":["AttachmentId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AttachmentId":{ "shape":"String", "documentation":"

The ID of the attachment.

", "locationName":"attachmentId" }, "Force":{ "shape":"Boolean", "documentation":"

Specifies whether to force a detachment.

", "locationName":"force" } }, "documentation":"

Contains the parameters for DetachNetworkInterface.

" }, "DetachVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "Device":{ "shape":"String", "documentation":"

The device name.

" }, "Force":{ "shape":"Boolean", "documentation":"

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

" } }, "documentation":"

Contains the parameters for DetachVolume.

" }, "DetachVpnGatewayRequest":{ "type":"structure", "required":[ "VpnGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for DetachVpnGateway.

" }, "DeviceType":{ "type":"string", "enum":[ "ebs", "instance-store" ] }, "DhcpConfiguration":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The name of a DHCP option.

", "locationName":"key" }, "Values":{ "shape":"DhcpConfigurationValueList", "documentation":"

One or more values for the DHCP option.

", "locationName":"valueSet" } }, "documentation":"

Describes a DHCP configuration option.

" }, "DhcpConfigurationList":{ "type":"list", "member":{ "shape":"DhcpConfiguration", "locationName":"item" } }, "DhcpConfigurationValueList":{ "type":"list", "member":{ "shape":"AttributeValue", "locationName":"item" } }, "DhcpOptions":{ "type":"structure", "members":{ "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the set of DHCP options.

", "locationName":"dhcpOptionsId" }, "DhcpConfigurations":{ "shape":"DhcpConfigurationList", "documentation":"

One or more DHCP options in the set.

", "locationName":"dhcpConfigurationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the DHCP options set.

", "locationName":"tagSet" } }, "documentation":"

Describes a set of DHCP options.

" }, "DhcpOptionsIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"DhcpOptionsId" } }, "DhcpOptionsList":{ "type":"list", "member":{ "shape":"DhcpOptions", "locationName":"item" } }, "DisableVgwRoutePropagationRequest":{ "type":"structure", "required":[ "RouteTableId", "GatewayId" ], "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } }, "documentation":"

Contains the parameters for DisableVgwRoutePropagation.

" }, "DisableVpcClassicLinkDnsSupportRequest":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for DisableVpcClassicLinkDnsSupport.

" }, "DisableVpcClassicLinkDnsSupportResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of DisableVpcClassicLinkDnsSupport.

" }, "DisableVpcClassicLinkRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for DisableVpcClassicLink.

" }, "DisableVpcClassicLinkResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of DisableVpcClassicLink.

" }, "DisassociateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" }, "AssociationId":{ "shape":"String", "documentation":"

[EC2-VPC] The association ID. Required for EC2-VPC.

" } }, "documentation":"

Contains the parameters for DisassociateAddress.

" }, "DisassociateRouteTableRequest":{ "type":"structure", "required":["AssociationId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID representing the current association between the route table and subnet.

", "locationName":"associationId" } }, "documentation":"

Contains the parameters for DisassociateRouteTable.

" }, "DisassociateSubnetCidrBlockRequest":{ "type":"structure", "required":["AssociationId"], "members":{ "AssociationId":{ "shape":"String", "documentation":"

The association ID for the CIDR block.

", "locationName":"associationId" } } }, "DisassociateSubnetCidrBlockResult":{ "type":"structure", "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "Ipv6CidrBlockAssociation":{ "shape":"SubnetIpv6CidrBlockAssociation", "documentation":"

Information about the IPv6 CIDR block association.

", "locationName":"ipv6CidrBlockAssociation" } } }, "DisassociateVpcCidrBlockRequest":{ "type":"structure", "required":["AssociationId"], "members":{ "AssociationId":{ "shape":"String", "documentation":"

The association ID for the CIDR block.

", "locationName":"associationId" } } }, "DisassociateVpcCidrBlockResult":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Ipv6CidrBlockAssociation":{ "shape":"VpcIpv6CidrBlockAssociation", "documentation":"

Information about the IPv6 CIDR block association.

", "locationName":"ipv6CidrBlockAssociation" } } }, "DiskImage":{ "type":"structure", "members":{ "Image":{ "shape":"DiskImageDetail", "documentation":"

Information about the disk image.

" }, "Description":{ "shape":"String", "documentation":"

A description of the disk image.

" }, "Volume":{ "shape":"VolumeDetail", "documentation":"

Information about the volume.

" } }, "documentation":"

Describes a disk image.

" }, "DiskImageDescription":{ "type":"structure", "required":[ "Format", "Size", "ImportManifestUrl" ], "members":{ "Format":{ "shape":"DiskImageFormat", "documentation":"

The disk image format.

", "locationName":"format" }, "Size":{ "shape":"Long", "documentation":"

The size of the disk image, in GiB.

", "locationName":"size" }, "ImportManifestUrl":{ "shape":"String", "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

", "locationName":"importManifestUrl" }, "Checksum":{ "shape":"String", "documentation":"

The checksum computed for the disk image.

", "locationName":"checksum" } }, "documentation":"

Describes a disk image.

" }, "DiskImageDetail":{ "type":"structure", "required":[ "Format", "Bytes", "ImportManifestUrl" ], "members":{ "Format":{ "shape":"DiskImageFormat", "documentation":"

The disk image format.

", "locationName":"format" }, "Bytes":{ "shape":"Long", "documentation":"

The size of the disk image, in GiB.

", "locationName":"bytes" }, "ImportManifestUrl":{ "shape":"String", "documentation":"

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

", "locationName":"importManifestUrl" } }, "documentation":"

Describes a disk image.

" }, "DiskImageFormat":{ "type":"string", "enum":[ "VMDK", "RAW", "VHD" ] }, "DiskImageList":{ "type":"list", "member":{"shape":"DiskImage"} }, "DiskImageVolumeDescription":{ "type":"structure", "required":["Id"], "members":{ "Size":{ "shape":"Long", "documentation":"

The size of the volume, in GiB.

", "locationName":"size" }, "Id":{ "shape":"String", "documentation":"

The volume identifier.

", "locationName":"id" } }, "documentation":"

Describes a disk image volume.

" }, "DomainType":{ "type":"string", "enum":[ "vpc", "standard" ] }, "Double":{"type":"double"}, "EbsBlockDevice":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

", "locationName":"snapshotId" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

", "locationName":"volumeSize" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", "locationName":"deleteOnTermination" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type: gp2, io1, st1, sc1, or standard.

Default: standard

", "locationName":"volumeType" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", "locationName":"iops" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

", "locationName":"encrypted" } }, "documentation":"

Describes a block device for an EBS volume.

" }, "EbsInstanceBlockDevice":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume.

", "locationName":"volumeId" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a parameter used to set up an EBS volume in a block device mapping.

" }, "EbsInstanceBlockDeviceSpecification":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume.

", "locationName":"volumeId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes information used to set up an EBS volume specified in a block device mapping.

" }, "EgressOnlyInternetGateway":{ "type":"structure", "members":{ "EgressOnlyInternetGatewayId":{ "shape":"EgressOnlyInternetGatewayId", "documentation":"

The ID of the egress-only Internet gateway.

", "locationName":"egressOnlyInternetGatewayId" }, "Attachments":{ "shape":"InternetGatewayAttachmentList", "documentation":"

Information about the attachment of the egress-only Internet gateway.

", "locationName":"attachmentSet" } }, "documentation":"

Describes an egress-only Internet gateway.

" }, "EgressOnlyInternetGatewayId":{"type":"string"}, "EgressOnlyInternetGatewayIdList":{ "type":"list", "member":{ "shape":"EgressOnlyInternetGatewayId", "locationName":"item" } }, "EgressOnlyInternetGatewayList":{ "type":"list", "member":{ "shape":"EgressOnlyInternetGateway", "locationName":"item" } }, "EnableVgwRoutePropagationRequest":{ "type":"structure", "required":[ "RouteTableId", "GatewayId" ], "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } }, "documentation":"

Contains the parameters for EnableVgwRoutePropagation.

" }, "EnableVolumeIORequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" } }, "documentation":"

Contains the parameters for EnableVolumeIO.

" }, "EnableVpcClassicLinkDnsSupportRequest":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for EnableVpcClassicLinkDnsSupport.

" }, "EnableVpcClassicLinkDnsSupportResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of EnableVpcClassicLinkDnsSupport.

" }, "EnableVpcClassicLinkRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for EnableVpcClassicLink.

" }, "EnableVpcClassicLinkResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of EnableVpcClassicLink.

" }, "EventCode":{ "type":"string", "enum":[ "instance-reboot", "system-reboot", "system-maintenance", "instance-retirement", "instance-stop" ] }, "EventInformation":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance. This information is available only for instanceChange events.

", "locationName":"instanceId" }, "EventSubType":{ "shape":"String", "documentation":"

The event.

The following are the error events.

  • iamFleetRoleInvalid - The Spot fleet did not have the required permissions either to launch or terminate an instance.

  • launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.

  • spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.

  • spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot instances that you can launch.

The following are the fleetRequestChange events.

  • active - The Spot fleet has been validated and Amazon EC2 is attempting to maintain the target number of running Spot instances.

  • cancelled - The Spot fleet is canceled and has no running Spot instances. The Spot fleet will be deleted two days after its instances were terminated.

  • cancelled_running - The Spot fleet is canceled and will not launch additional Spot instances, but its existing Spot instances continue to run until they are interrupted or terminated.

  • cancelled_terminating - The Spot fleet is canceled and its Spot instances are terminating.

  • expired - The Spot fleet request has expired. A subsequent event indicates that the instances were terminated, if the request was created with TerminateInstancesWithExpiration set.

  • modify_in_progress - A request to modify the Spot fleet request was accepted and is in progress.

  • modify_successful - The Spot fleet request was modified.

  • price_update - The bid price for a launch configuration was adjusted because it was too high. This change is permanent.

  • submitted - The Spot fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of Spot instances.

The following are the instanceChange events.

  • launched - A bid was fulfilled and a new instance was launched.

  • terminated - An instance was terminated by the user.

", "locationName":"eventSubType" }, "EventDescription":{ "shape":"String", "documentation":"

The description of the event.

", "locationName":"eventDescription" } }, "documentation":"

Describes a Spot fleet event.

" }, "EventType":{ "type":"string", "enum":[ "instanceChange", "fleetRequestChange", "error" ] }, "ExcessCapacityTerminationPolicy":{ "type":"string", "enum":[ "noTermination", "default" ] }, "ExecutableByStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ExecutableBy" } }, "ExportEnvironment":{ "type":"string", "enum":[ "citrix", "vmware", "microsoft" ] }, "ExportTask":{ "type":"structure", "members":{ "ExportTaskId":{ "shape":"String", "documentation":"

The ID of the export task.

", "locationName":"exportTaskId" }, "Description":{ "shape":"String", "documentation":"

A description of the resource being exported.

", "locationName":"description" }, "State":{ "shape":"ExportTaskState", "documentation":"

The state of the export task.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message related to the export task.

", "locationName":"statusMessage" }, "InstanceExportDetails":{ "shape":"InstanceExportDetails", "documentation":"

Information about the instance to export.

", "locationName":"instanceExport" }, "ExportToS3Task":{ "shape":"ExportToS3Task", "documentation":"

Information about the export task.

", "locationName":"exportToS3" } }, "documentation":"

Describes an instance export task.

" }, "ExportTaskIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ExportTaskId" } }, "ExportTaskList":{ "type":"list", "member":{ "shape":"ExportTask", "locationName":"item" } }, "ExportTaskState":{ "type":"string", "enum":[ "active", "cancelling", "cancelled", "completed" ] }, "ExportToS3Task":{ "type":"structure", "members":{ "DiskImageFormat":{ "shape":"DiskImageFormat", "documentation":"

The format for the exported image.

", "locationName":"diskImageFormat" }, "ContainerFormat":{ "shape":"ContainerFormat", "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", "locationName":"containerFormat" }, "S3Bucket":{ "shape":"String", "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", "locationName":"s3Bucket" }, "S3Key":{ "shape":"String", "documentation":"

The encryption key for your S3 bucket.

", "locationName":"s3Key" } }, "documentation":"

Describes the format and location for an instance export task.

" }, "ExportToS3TaskSpecification":{ "type":"structure", "members":{ "DiskImageFormat":{ "shape":"DiskImageFormat", "documentation":"

The format for the exported image.

", "locationName":"diskImageFormat" }, "ContainerFormat":{ "shape":"ContainerFormat", "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", "locationName":"containerFormat" }, "S3Bucket":{ "shape":"String", "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", "locationName":"s3Bucket" }, "S3Prefix":{ "shape":"String", "documentation":"

The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

", "locationName":"s3Prefix" } }, "documentation":"

Describes an instance export task.

" }, "Filter":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the filter. Filter names are case-sensitive.

" }, "Values":{ "shape":"ValueStringList", "documentation":"

One or more filter values. Filter values are case-sensitive.

", "locationName":"Value" } }, "documentation":"

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.

" }, "FilterList":{ "type":"list", "member":{ "shape":"Filter", "locationName":"Filter" } }, "FleetType":{ "type":"string", "enum":[ "request", "maintain" ] }, "Float":{"type":"float"}, "FlowLog":{ "type":"structure", "members":{ "CreationTime":{ "shape":"DateTime", "documentation":"

The date and time the flow log was created.

", "locationName":"creationTime" }, "FlowLogId":{ "shape":"String", "documentation":"

The flow log ID.

", "locationName":"flowLogId" }, "FlowLogStatus":{ "shape":"String", "documentation":"

The status of the flow log (ACTIVE).

", "locationName":"flowLogStatus" }, "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource on which the flow log was created.

", "locationName":"resourceId" }, "TrafficType":{ "shape":"TrafficType", "documentation":"

The type of traffic captured for the flow log.

", "locationName":"trafficType" }, "LogGroupName":{ "shape":"String", "documentation":"

The name of the flow log group.

", "locationName":"logGroupName" }, "DeliverLogsStatus":{ "shape":"String", "documentation":"

The status of the logs delivery (SUCCESS | FAILED).

", "locationName":"deliverLogsStatus" }, "DeliverLogsErrorMessage":{ "shape":"String", "documentation":"

Information about the error that occurred. Rate limited indicates that CloudWatch logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of CloudWatch Logs log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.

", "locationName":"deliverLogsErrorMessage" }, "DeliverLogsPermissionArn":{ "shape":"String", "documentation":"

The ARN of the IAM role that posts logs to CloudWatch Logs.

", "locationName":"deliverLogsPermissionArn" } }, "documentation":"

Describes a flow log.

" }, "FlowLogSet":{ "type":"list", "member":{ "shape":"FlowLog", "locationName":"item" } }, "FlowLogsResourceType":{ "type":"string", "enum":[ "VPC", "Subnet", "NetworkInterface" ] }, "GatewayType":{ "type":"string", "enum":["ipsec.1"] }, "GetConsoleOutputRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" } }, "documentation":"

Contains the parameters for GetConsoleOutput.

" }, "GetConsoleOutputResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The time the output was last updated.

", "locationName":"timestamp" }, "Output":{ "shape":"String", "documentation":"

The console output, Base64-encoded. If using a command line tool, the tool decodes the output for you.

", "locationName":"output" } }, "documentation":"

Contains the output of GetConsoleOutput.

" }, "GetConsoleScreenshotRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "WakeUp":{ "shape":"Boolean", "documentation":"

When set to true, acts as keystroke input and wakes up an instance that's in standby or \"sleep\" mode.

" } }, "documentation":"

Contains the parameters for the request.

" }, "GetConsoleScreenshotResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "ImageData":{ "shape":"String", "documentation":"

The data that comprises the image.

", "locationName":"imageData" } }, "documentation":"

Contains the output of the request.

" }, "GetHostReservationPurchasePreviewRequest":{ "type":"structure", "required":[ "OfferingId", "HostIdSet" ], "members":{ "OfferingId":{ "shape":"String", "documentation":"

The offering ID of the reservation.

" }, "HostIdSet":{ "shape":"RequestHostIdSet", "documentation":"

The ID/s of the Dedicated Host/s that the reservation will be associated with.

" } } }, "GetHostReservationPurchasePreviewResult":{ "type":"structure", "members":{ "Purchase":{ "shape":"PurchaseSet", "documentation":"

The purchase information of the Dedicated Host Reservation and the Dedicated Hosts associated with it.

", "locationName":"purchase" }, "TotalUpfrontPrice":{ "shape":"String", "documentation":"

The potential total upfront price. This is billed immediately.

", "locationName":"totalUpfrontPrice" }, "TotalHourlyPrice":{ "shape":"String", "documentation":"

The potential total hourly price of the reservation per hour.

", "locationName":"totalHourlyPrice" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } } }, "GetPasswordDataRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the Windows instance.

" } }, "documentation":"

Contains the parameters for GetPasswordData.

" }, "GetPasswordDataResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the Windows instance.

", "locationName":"instanceId" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The time the data was last updated.

", "locationName":"timestamp" }, "PasswordData":{ "shape":"String", "documentation":"

The password of the instance.

", "locationName":"passwordData" } }, "documentation":"

Contains the output of GetPasswordData.

" }, "GetReservedInstancesExchangeQuoteRequest":{ "type":"structure", "required":["ReservedInstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ReservedInstanceIds":{ "shape":"ReservedInstanceIdSet", "documentation":"

The IDs of the Convertible Reserved Instances to exchange.

", "locationName":"ReservedInstanceId" }, "TargetConfigurations":{ "shape":"TargetConfigurationRequestSet", "documentation":"

The configuration requirements of the Convertible Reserved Instances to exchange for your current Convertible Reserved Instances.

", "locationName":"TargetConfiguration" } }, "documentation":"

Contains the parameters for GetReservedInstanceExchangeQuote.

" }, "GetReservedInstancesExchangeQuoteResult":{ "type":"structure", "members":{ "ReservedInstanceValueSet":{ "shape":"ReservedInstanceReservationValueSet", "documentation":"

The configuration of your Convertible Reserved Instances.

", "locationName":"reservedInstanceValueSet" }, "ReservedInstanceValueRollup":{ "shape":"ReservationValue", "locationName":"reservedInstanceValueRollup" }, "TargetConfigurationValueSet":{ "shape":"TargetReservationValueSet", "documentation":"

The values of the target Convertible Reserved Instances.

", "locationName":"targetConfigurationValueSet" }, "TargetConfigurationValueRollup":{ "shape":"ReservationValue", "locationName":"targetConfigurationValueRollup" }, "PaymentDue":{ "shape":"String", "documentation":"

The total true upfront charge for the exchange.

", "locationName":"paymentDue" }, "CurrencyCode":{ "shape":"String", "documentation":"

The currency of the transaction.

", "locationName":"currencyCode" }, "OutputReservedInstancesWillExpireAt":{ "shape":"DateTime", "documentation":"

The new end date of the reservation term.

", "locationName":"outputReservedInstancesWillExpireAt" }, "IsValidExchange":{ "shape":"Boolean", "documentation":"

If true, the exchange is valid. If false, the exchange cannot be completed.

", "locationName":"isValidExchange" }, "ValidationFailureReason":{ "shape":"String", "documentation":"

Describes the reason why the exchange cannot be completed.

", "locationName":"validationFailureReason" } }, "documentation":"

Contains the output of GetReservedInstancesExchangeQuote.

" }, "GroupIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"groupId" } }, "GroupIdentifier":{ "type":"structure", "members":{ "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } }, "documentation":"

Describes a security group.

" }, "GroupIdentifierList":{ "type":"list", "member":{ "shape":"GroupIdentifier", "locationName":"item" } }, "GroupIds":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "GroupNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"GroupName" } }, "HistoryRecord":{ "type":"structure", "required":[ "Timestamp", "EventType", "EventInformation" ], "members":{ "Timestamp":{ "shape":"DateTime", "documentation":"

The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"timestamp" }, "EventType":{ "shape":"EventType", "documentation":"

The event type.

  • error - Indicates an error with the Spot fleet request.

  • fleetRequestChange - Indicates a change in the status or configuration of the Spot fleet request.

  • instanceChange - Indicates that an instance was launched or terminated.

", "locationName":"eventType" }, "EventInformation":{ "shape":"EventInformation", "documentation":"

Information about the event.

", "locationName":"eventInformation" } }, "documentation":"

Describes an event in the history of the Spot fleet request.

" }, "HistoryRecords":{ "type":"list", "member":{ "shape":"HistoryRecord", "locationName":"item" } }, "Host":{ "type":"structure", "members":{ "HostId":{ "shape":"String", "documentation":"

The ID of the Dedicated Host.

", "locationName":"hostId" }, "AutoPlacement":{ "shape":"AutoPlacement", "documentation":"

Whether auto-placement is on or off.

", "locationName":"autoPlacement" }, "HostReservationId":{ "shape":"String", "documentation":"

The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation.

", "locationName":"hostReservationId" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"clientToken" }, "HostProperties":{ "shape":"HostProperties", "documentation":"

The hardware specifications of the Dedicated Host.

", "locationName":"hostProperties" }, "State":{ "shape":"AllocationState", "documentation":"

The Dedicated Host's state.

", "locationName":"state" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the Dedicated Host.

", "locationName":"availabilityZone" }, "Instances":{ "shape":"HostInstanceList", "documentation":"

The IDs and instance type that are currently running on the Dedicated Host.

", "locationName":"instances" }, "AvailableCapacity":{ "shape":"AvailableCapacity", "documentation":"

The number of new instances that can be launched onto the Dedicated Host.

", "locationName":"availableCapacity" } }, "documentation":"

Describes the properties of the Dedicated Host.

" }, "HostInstance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

the IDs of instances that are running on the Dedicated Host.

", "locationName":"instanceId" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type size (for example, m3.medium) of the running instance.

", "locationName":"instanceType" } }, "documentation":"

Describes an instance running on a Dedicated Host.

" }, "HostInstanceList":{ "type":"list", "member":{ "shape":"HostInstance", "locationName":"item" } }, "HostList":{ "type":"list", "member":{ "shape":"Host", "locationName":"item" } }, "HostOffering":{ "type":"structure", "members":{ "OfferingId":{ "shape":"String", "documentation":"

The ID of the offering.

", "locationName":"offeringId" }, "InstanceFamily":{ "shape":"String", "documentation":"

The instance family of the offering.

", "locationName":"instanceFamily" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"

The available payment option.

", "locationName":"paymentOption" }, "UpfrontPrice":{ "shape":"String", "documentation":"

The upfront price of the offering. Does not apply to No Upfront offerings.

", "locationName":"upfrontPrice" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price of the offering.

", "locationName":"hourlyPrice" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the offering.

", "locationName":"currencyCode" }, "Duration":{ "shape":"Integer", "documentation":"

The duration of the offering (in seconds).

", "locationName":"duration" } }, "documentation":"

Details about the Dedicated Host Reservation offering.

" }, "HostOfferingSet":{ "type":"list", "member":{"shape":"HostOffering"} }, "HostProperties":{ "type":"structure", "members":{ "Sockets":{ "shape":"Integer", "documentation":"

The number of sockets on the Dedicated Host.

", "locationName":"sockets" }, "Cores":{ "shape":"Integer", "documentation":"

The number of cores on the Dedicated Host.

", "locationName":"cores" }, "TotalVCpus":{ "shape":"Integer", "documentation":"

The number of vCPUs on the Dedicated Host.

", "locationName":"totalVCpus" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type size that the Dedicated Host supports (for example, m3.medium).

", "locationName":"instanceType" } }, "documentation":"

Describes properties of a Dedicated Host.

" }, "HostReservation":{ "type":"structure", "members":{ "HostReservationId":{ "shape":"String", "documentation":"

The ID of the reservation that specifies the associated Dedicated Hosts.

", "locationName":"hostReservationId" }, "HostIdSet":{ "shape":"ResponseHostIdSet", "documentation":"

The IDs of the Dedicated Hosts associated with the reservation.

", "locationName":"hostIdSet" }, "OfferingId":{ "shape":"String", "documentation":"

The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.

", "locationName":"offeringId" }, "InstanceFamily":{ "shape":"String", "documentation":"

The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.

", "locationName":"instanceFamily" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"

The payment option selected for this reservation.

", "locationName":"paymentOption" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price of the reservation.

", "locationName":"hourlyPrice" }, "UpfrontPrice":{ "shape":"String", "documentation":"

The upfront price of the reservation.

", "locationName":"upfrontPrice" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "Count":{ "shape":"Integer", "documentation":"

The number of Dedicated Hosts the reservation is associated with.

", "locationName":"count" }, "Duration":{ "shape":"Integer", "documentation":"

The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).

", "locationName":"duration" }, "End":{ "shape":"DateTime", "documentation":"

The date and time that the reservation ends.

", "locationName":"end" }, "Start":{ "shape":"DateTime", "documentation":"

The date and time that the reservation started.

", "locationName":"start" }, "State":{ "shape":"ReservationState", "documentation":"

The state of the reservation.

", "locationName":"state" } }, "documentation":"

Details about the Dedicated Host Reservation and associated Dedicated Hosts.

" }, "HostReservationIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "HostReservationSet":{ "type":"list", "member":{"shape":"HostReservation"} }, "HostTenancy":{ "type":"string", "enum":[ "dedicated", "host" ] }, "HypervisorType":{ "type":"string", "enum":[ "ovm", "xen" ] }, "IamInstanceProfile":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", "locationName":"arn" }, "Id":{ "shape":"String", "documentation":"

The ID of the instance profile.

", "locationName":"id" } }, "documentation":"

Describes an IAM instance profile.

" }, "IamInstanceProfileSpecification":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", "locationName":"arn" }, "Name":{ "shape":"String", "documentation":"

The name of the instance profile.

", "locationName":"name" } }, "documentation":"

Describes an IAM instance profile.

" }, "IcmpTypeCode":{ "type":"structure", "members":{ "Type":{ "shape":"Integer", "documentation":"

The ICMP type. A value of -1 means all types.

", "locationName":"type" }, "Code":{ "shape":"Integer", "documentation":"

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", "locationName":"code" } }, "documentation":"

Describes the ICMP type and code.

" }, "IdFormat":{ "type":"structure", "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource.

", "locationName":"resource" }, "UseLongIds":{ "shape":"Boolean", "documentation":"

Indicates whether longer IDs (17-character IDs) are enabled for the resource.

", "locationName":"useLongIds" }, "Deadline":{ "shape":"DateTime", "documentation":"

The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.

", "locationName":"deadline" } }, "documentation":"

Describes the ID format for a resource.

" }, "IdFormatList":{ "type":"list", "member":{ "shape":"IdFormat", "locationName":"item" } }, "Image":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "ImageLocation":{ "shape":"String", "documentation":"

The location of the AMI.

", "locationName":"imageLocation" }, "State":{ "shape":"ImageState", "documentation":"

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", "locationName":"imageState" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the image owner.

", "locationName":"imageOwnerId" }, "CreationDate":{ "shape":"String", "documentation":"

The date and time the image was created.

", "locationName":"creationDate" }, "Public":{ "shape":"Boolean", "documentation":"

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

", "locationName":"isPublic" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

Any product codes associated with the AMI.

", "locationName":"productCodes" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the image.

", "locationName":"architecture" }, "ImageType":{ "shape":"ImageTypeValues", "documentation":"

The type of image.

", "locationName":"imageType" }, "KernelId":{ "shape":"String", "documentation":"

The kernel associated with the image, if any. Only applicable for machine images.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The RAM disk associated with the image, if any. Only applicable for machine images.

", "locationName":"ramdiskId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The value is Windows for Windows AMIs; otherwise blank.

", "locationName":"platform" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", "locationName":"sriovNetSupport" }, "EnaSupport":{ "shape":"Boolean", "documentation":"

Specifies whether enhanced networking with ENA is enabled.

", "locationName":"enaSupport" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason for the state change.

", "locationName":"stateReason" }, "ImageOwnerAlias":{ "shape":"String", "documentation":"

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

", "locationName":"imageOwnerAlias" }, "Name":{ "shape":"String", "documentation":"

The name of the AMI that was provided during image creation.

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

The description of the AMI that was provided during image creation.

", "locationName":"description" }, "RootDeviceType":{ "shape":"DeviceType", "documentation":"

The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

", "locationName":"rootDeviceType" }, "RootDeviceName":{ "shape":"String", "documentation":"

The device name of the root device (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

Any block device mapping entries.

", "locationName":"blockDeviceMapping" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The type of virtualization of the AMI.

", "locationName":"virtualizationType" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the image.

", "locationName":"tagSet" }, "Hypervisor":{ "shape":"HypervisorType", "documentation":"

The hypervisor type of the image.

", "locationName":"hypervisor" } }, "documentation":"

Describes an image.

" }, "ImageAttribute":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "LaunchPermissions":{ "shape":"LaunchPermissionList", "documentation":"

One or more launch permissions.

", "locationName":"launchPermission" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

One or more product codes.

", "locationName":"productCodes" }, "KernelId":{ "shape":"AttributeValue", "documentation":"

The kernel ID.

", "locationName":"kernel" }, "RamdiskId":{ "shape":"AttributeValue", "documentation":"

The RAM disk ID.

", "locationName":"ramdisk" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the AMI.

", "locationName":"description" }, "SriovNetSupport":{ "shape":"AttributeValue", "documentation":"

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", "locationName":"sriovNetSupport" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" } }, "documentation":"

Describes an image attribute.

" }, "ImageAttributeName":{ "type":"string", "enum":[ "description", "kernel", "ramdisk", "launchPermission", "productCodes", "blockDeviceMapping", "sriovNetSupport" ] }, "ImageDiskContainer":{ "type":"structure", "members":{ "Description":{ "shape":"String", "documentation":"

The description of the disk image.

" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" }, "Url":{ "shape":"String", "documentation":"

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)

" }, "UserBucket":{ "shape":"UserBucket", "documentation":"

The S3 bucket for the disk image.

" }, "DeviceName":{ "shape":"String", "documentation":"

The block device mapping for the disk.

" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot to be used for importing the snapshot.

" } }, "documentation":"

Describes the disk container object for an import image task.

" }, "ImageDiskContainerList":{ "type":"list", "member":{ "shape":"ImageDiskContainer", "locationName":"item" } }, "ImageIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ImageId" } }, "ImageList":{ "type":"list", "member":{ "shape":"Image", "locationName":"item" } }, "ImageState":{ "type":"string", "enum":[ "pending", "available", "invalid", "deregistered", "transient", "failed", "error" ] }, "ImageTypeValues":{ "type":"string", "enum":[ "machine", "kernel", "ramdisk" ] }, "ImportImageRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "Description":{ "shape":"String", "documentation":"

A description string for the import image task.

" }, "DiskContainers":{ "shape":"ImageDiskContainerList", "documentation":"

Information about the disk containers.

", "locationName":"DiskContainer" }, "LicenseType":{ "shape":"String", "documentation":"

The license type to be used for the Amazon Machine Image (AMI) after importing.

Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

Valid values: AWS | BYOL

" }, "Hypervisor":{ "shape":"String", "documentation":"

The target hypervisor platform.

Valid values: xen

" }, "Architecture":{ "shape":"String", "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

" }, "Platform":{ "shape":"String", "documentation":"

The operating system of the virtual machine.

Valid values: Windows | Linux

" }, "ClientData":{ "shape":"ClientData", "documentation":"

The client-specific data.

" }, "ClientToken":{ "shape":"String", "documentation":"

The token to enable idempotency for VM import requests.

" }, "RoleName":{ "shape":"String", "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" } }, "documentation":"

Contains the parameters for ImportImage.

" }, "ImportImageResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The task ID of the import image task.

", "locationName":"importTaskId" }, "Architecture":{ "shape":"String", "documentation":"

The architecture of the virtual machine.

", "locationName":"architecture" }, "LicenseType":{ "shape":"String", "documentation":"

The license type of the virtual machine.

", "locationName":"licenseType" }, "Platform":{ "shape":"String", "documentation":"

The operating system of the virtual machine.

", "locationName":"platform" }, "Hypervisor":{ "shape":"String", "documentation":"

The target hypervisor of the import task.

", "locationName":"hypervisor" }, "Description":{ "shape":"String", "documentation":"

A description of the import task.

", "locationName":"description" }, "SnapshotDetails":{ "shape":"SnapshotDetailList", "documentation":"

Information about the snapshots.

", "locationName":"snapshotDetailSet" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the Amazon Machine Image (AMI) created by the import task.

", "locationName":"imageId" }, "Progress":{ "shape":"String", "documentation":"

The progress of the task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message of the import task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status of the task.

", "locationName":"status" } }, "documentation":"

Contains the output for ImportImage.

" }, "ImportImageTask":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import image task.

", "locationName":"importTaskId" }, "Architecture":{ "shape":"String", "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

", "locationName":"architecture" }, "LicenseType":{ "shape":"String", "documentation":"

The license type of the virtual machine.

", "locationName":"licenseType" }, "Platform":{ "shape":"String", "documentation":"

The description string for the import image task.

", "locationName":"platform" }, "Hypervisor":{ "shape":"String", "documentation":"

The target hypervisor for the import task.

Valid values: xen

", "locationName":"hypervisor" }, "Description":{ "shape":"String", "documentation":"

A description of the import task.

", "locationName":"description" }, "SnapshotDetails":{ "shape":"SnapshotDetailList", "documentation":"

Information about the snapshots.

", "locationName":"snapshotDetailSet" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

", "locationName":"imageId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of progress of the import image task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A descriptive status message for the import image task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status for the import image task.

", "locationName":"status" } }, "documentation":"

Describes an import image task.

" }, "ImportImageTaskList":{ "type":"list", "member":{ "shape":"ImportImageTask", "locationName":"item" } }, "ImportInstanceLaunchSpecification":{ "type":"structure", "members":{ "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the instance.

", "locationName":"architecture" }, "GroupNames":{ "shape":"SecurityGroupStringList", "documentation":"

One or more security group names.

", "locationName":"GroupName" }, "GroupIds":{ "shape":"SecurityGroupIdStringList", "documentation":"

One or more security group IDs.

", "locationName":"GroupId" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "UserData":{ "shape":"UserData", "documentation":"

The user data to make available to the instance. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"userData" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.

", "locationName":"instanceType" }, "Placement":{ "shape":"Placement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "Monitoring":{ "shape":"Boolean", "documentation":"

Indicates whether monitoring is enabled.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] An available IP address from the IP address range of the subnet.

", "locationName":"privateIpAddress" } }, "documentation":"

Describes the launch specification for VM import.

" }, "ImportInstanceRequest":{ "type":"structure", "required":["Platform"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Description":{ "shape":"String", "documentation":"

A description for the instance being imported.

", "locationName":"description" }, "LaunchSpecification":{ "shape":"ImportInstanceLaunchSpecification", "documentation":"

The launch specification.

", "locationName":"launchSpecification" }, "DiskImages":{ "shape":"DiskImageList", "documentation":"

The disk image.

", "locationName":"diskImage" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The instance operating system.

", "locationName":"platform" } }, "documentation":"

Contains the parameters for ImportInstance.

" }, "ImportInstanceResult":{ "type":"structure", "members":{ "ConversionTask":{ "shape":"ConversionTask", "documentation":"

Information about the conversion task.

", "locationName":"conversionTask" } }, "documentation":"

Contains the output for ImportInstance.

" }, "ImportInstanceTaskDetails":{ "type":"structure", "required":["Volumes"], "members":{ "Volumes":{ "shape":"ImportInstanceVolumeDetailSet", "documentation":"

One or more volumes.

", "locationName":"volumes" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The instance operating system.

", "locationName":"platform" }, "Description":{ "shape":"String", "documentation":"

A description of the task.

", "locationName":"description" } }, "documentation":"

Describes an import instance task.

" }, "ImportInstanceVolumeDetailItem":{ "type":"structure", "required":[ "BytesConverted", "AvailabilityZone", "Image", "Volume", "Status" ], "members":{ "BytesConverted":{ "shape":"Long", "documentation":"

The number of bytes converted so far.

", "locationName":"bytesConverted" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the resulting instance will reside.

", "locationName":"availabilityZone" }, "Image":{ "shape":"DiskImageDescription", "documentation":"

The image.

", "locationName":"image" }, "Volume":{ "shape":"DiskImageVolumeDescription", "documentation":"

The volume.

", "locationName":"volume" }, "Status":{ "shape":"String", "documentation":"

The status of the import of this particular disk image.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The status information or errors related to the disk image.

", "locationName":"statusMessage" }, "Description":{ "shape":"String", "documentation":"

A description of the task.

", "locationName":"description" } }, "documentation":"

Describes an import volume task.

" }, "ImportInstanceVolumeDetailSet":{ "type":"list", "member":{ "shape":"ImportInstanceVolumeDetailItem", "locationName":"item" } }, "ImportKeyPairRequest":{ "type":"structure", "required":[ "KeyName", "PublicKeyMaterial" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

A unique name for the key pair.

", "locationName":"keyName" }, "PublicKeyMaterial":{ "shape":"Blob", "documentation":"

The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.

", "locationName":"publicKeyMaterial" } }, "documentation":"

Contains the parameters for ImportKeyPair.

" }, "ImportKeyPairResult":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The key pair name you provided.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", "locationName":"keyFingerprint" } }, "documentation":"

Contains the output of ImportKeyPair.

" }, "ImportSnapshotRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "Description":{ "shape":"String", "documentation":"

The description string for the import snapshot task.

" }, "DiskContainer":{ "shape":"SnapshotDiskContainer", "documentation":"

Information about the disk container.

" }, "ClientData":{ "shape":"ClientData", "documentation":"

The client-specific data.

" }, "ClientToken":{ "shape":"String", "documentation":"

Token to enable idempotency for VM import requests.

" }, "RoleName":{ "shape":"String", "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" } }, "documentation":"

Contains the parameters for ImportSnapshot.

" }, "ImportSnapshotResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import snapshot task.

", "locationName":"importTaskId" }, "SnapshotTaskDetail":{ "shape":"SnapshotTaskDetail", "documentation":"

Information about the import snapshot task.

", "locationName":"snapshotTaskDetail" }, "Description":{ "shape":"String", "documentation":"

A description of the import snapshot task.

", "locationName":"description" } }, "documentation":"

Contains the output for ImportSnapshot.

" }, "ImportSnapshotTask":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import snapshot task.

", "locationName":"importTaskId" }, "SnapshotTaskDetail":{ "shape":"SnapshotTaskDetail", "documentation":"

Describes an import snapshot task.

", "locationName":"snapshotTaskDetail" }, "Description":{ "shape":"String", "documentation":"

A description of the import snapshot task.

", "locationName":"description" } }, "documentation":"

Describes an import snapshot task.

" }, "ImportSnapshotTaskList":{ "type":"list", "member":{ "shape":"ImportSnapshotTask", "locationName":"item" } }, "ImportTaskIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"ImportTaskId" } }, "ImportVolumeRequest":{ "type":"structure", "required":[ "AvailabilityZone", "Image", "Volume" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the resulting EBS volume.

", "locationName":"availabilityZone" }, "Image":{ "shape":"DiskImageDetail", "documentation":"

The disk image.

", "locationName":"image" }, "Description":{ "shape":"String", "documentation":"

A description of the volume.

", "locationName":"description" }, "Volume":{ "shape":"VolumeDetail", "documentation":"

The volume size.

", "locationName":"volume" } }, "documentation":"

Contains the parameters for ImportVolume.

" }, "ImportVolumeResult":{ "type":"structure", "members":{ "ConversionTask":{ "shape":"ConversionTask", "documentation":"

Information about the conversion task.

", "locationName":"conversionTask" } }, "documentation":"

Contains the output for ImportVolume.

" }, "ImportVolumeTaskDetails":{ "type":"structure", "required":[ "BytesConverted", "AvailabilityZone", "Image", "Volume" ], "members":{ "BytesConverted":{ "shape":"Long", "documentation":"

The number of bytes converted so far.

", "locationName":"bytesConverted" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the resulting volume will reside.

", "locationName":"availabilityZone" }, "Description":{ "shape":"String", "documentation":"

The description you provided when starting the import volume task.

", "locationName":"description" }, "Image":{ "shape":"DiskImageDescription", "documentation":"

The image.

", "locationName":"image" }, "Volume":{ "shape":"DiskImageVolumeDescription", "documentation":"

The volume.

", "locationName":"volume" } }, "documentation":"

Describes an import volume task.

" }, "Instance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI used to launch the instance.

", "locationName":"imageId" }, "State":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

", "locationName":"instanceState" }, "PrivateDnsName":{ "shape":"String", "documentation":"

(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

[EC2-VPC] The Amazon-provided DNS server will resolve Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.

", "locationName":"privateDnsName" }, "PublicDnsName":{ "shape":"String", "documentation":"

(IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

", "locationName":"dnsName" }, "StateTransitionReason":{ "shape":"String", "documentation":"

The reason for the most recent state transition. This might be an empty string.

", "locationName":"reason" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair, if this instance was launched with an associated key pair.

", "locationName":"keyName" }, "AmiLaunchIndex":{ "shape":"Integer", "documentation":"

The AMI launch index, which can be used to find this instance in the launch group.

", "locationName":"amiLaunchIndex" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

The product codes attached to this instance, if applicable.

", "locationName":"productCodes" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "LaunchTime":{ "shape":"DateTime", "documentation":"

The time the instance was launched.

", "locationName":"launchTime" }, "Placement":{ "shape":"Placement", "documentation":"

The location where the instance launched, if applicable.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The kernel associated with this instance, if applicable.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The RAM disk associated with this instance, if applicable.

", "locationName":"ramdiskId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The value is Windows for Windows instances; otherwise blank.

", "locationName":"platform" }, "Monitoring":{ "shape":"Monitoring", "documentation":"

The monitoring for the instance.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet in which the instance is running.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC in which the instance is running.

", "locationName":"vpcId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IPv4 address assigned to the instance.

", "locationName":"privateIpAddress" }, "PublicIpAddress":{ "shape":"String", "documentation":"

The public IPv4 address assigned to the instance, if applicable.

", "locationName":"ipAddress" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason for the most recent state transition.

", "locationName":"stateReason" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the image.

", "locationName":"architecture" }, "RootDeviceType":{ "shape":"DeviceType", "documentation":"

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

", "locationName":"rootDeviceType" }, "RootDeviceName":{ "shape":"String", "documentation":"

The root device name (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"

Any block device mapping entries for the instance.

", "locationName":"blockDeviceMapping" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The virtualization type of the instance.

", "locationName":"virtualizationType" }, "InstanceLifecycle":{ "shape":"InstanceLifecycleType", "documentation":"

Indicates whether this is a Spot instance or a Scheduled Instance.

", "locationName":"instanceLifecycle" }, "SpotInstanceRequestId":{ "shape":"String", "documentation":"

If the request is a Spot instance request, the ID of the request.

", "locationName":"spotInstanceRequestId" }, "ClientToken":{ "shape":"String", "documentation":"

The idempotency token you provided when you launched the instance, if applicable.

", "locationName":"clientToken" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the instance.

", "locationName":"tagSet" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups for the instance.

", "locationName":"groupSet" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", "locationName":"sourceDestCheck" }, "Hypervisor":{ "shape":"HypervisorType", "documentation":"

The hypervisor type of the instance.

", "locationName":"hypervisor" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceList", "documentation":"

[EC2-VPC] One or more network interfaces for the instance.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfile", "documentation":"

The IAM instance profile associated with the instance, if applicable.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", "locationName":"sriovNetSupport" }, "EnaSupport":{ "shape":"Boolean", "documentation":"

Specifies whether enhanced networking with ENA is enabled.

", "locationName":"enaSupport" } }, "documentation":"

Describes an instance.

" }, "InstanceAttribute":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "InstanceType":{ "shape":"AttributeValue", "documentation":"

The instance type.

", "locationName":"instanceType" }, "KernelId":{ "shape":"AttributeValue", "documentation":"

The kernel ID.

", "locationName":"kernel" }, "RamdiskId":{ "shape":"AttributeValue", "documentation":"

The RAM disk ID.

", "locationName":"ramdisk" }, "UserData":{ "shape":"AttributeValue", "documentation":"

The user data.

", "locationName":"userData" }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", "documentation":"

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ "shape":"AttributeValue", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "RootDeviceName":{ "shape":"AttributeValue", "documentation":"

The name of the root device (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"

The block device mapping of the instance.

", "locationName":"blockDeviceMapping" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" }, "EbsOptimized":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instance is optimized for EBS I/O.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"AttributeValue", "documentation":"

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", "locationName":"sriovNetSupport" }, "EnaSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether enhanced networking with ENA is enabled.

", "locationName":"enaSupport" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

The security groups associated with the instance.

", "locationName":"groupSet" } }, "documentation":"

Describes an instance attribute.

" }, "InstanceAttributeName":{ "type":"string", "enum":[ "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "rootDeviceName", "blockDeviceMapping", "productCodes", "sourceDestCheck", "groupSet", "ebsOptimized", "sriovNetSupport", "enaSupport" ] }, "InstanceBlockDeviceMapping":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsInstanceBlockDevice", "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", "locationName":"ebs" } }, "documentation":"

Describes a block device mapping.

" }, "InstanceBlockDeviceMappingList":{ "type":"list", "member":{ "shape":"InstanceBlockDeviceMapping", "locationName":"item" } }, "InstanceBlockDeviceMappingSpecification":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsInstanceBlockDeviceSpecification", "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", "locationName":"ebs" }, "VirtualName":{ "shape":"String", "documentation":"

The virtual device name.

", "locationName":"virtualName" }, "NoDevice":{ "shape":"String", "documentation":"

suppress the specified device included in the block device mapping.

", "locationName":"noDevice" } }, "documentation":"

Describes a block device mapping entry.

" }, "InstanceBlockDeviceMappingSpecificationList":{ "type":"list", "member":{ "shape":"InstanceBlockDeviceMappingSpecification", "locationName":"item" } }, "InstanceCapacity":{ "type":"structure", "members":{ "InstanceType":{ "shape":"String", "documentation":"

The instance type size supported by the Dedicated Host.

", "locationName":"instanceType" }, "AvailableCapacity":{ "shape":"Integer", "documentation":"

The number of instances that can still be launched onto the Dedicated Host.

", "locationName":"availableCapacity" }, "TotalCapacity":{ "shape":"Integer", "documentation":"

The total number of instances that can be launched onto the Dedicated Host.

", "locationName":"totalCapacity" } }, "documentation":"

Information about the instance type that the Dedicated Host supports.

" }, "InstanceCount":{ "type":"structure", "members":{ "State":{ "shape":"ListingState", "documentation":"

The states of the listed Reserved Instances.

", "locationName":"state" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of listed Reserved Instances in the state specified by the state.

", "locationName":"instanceCount" } }, "documentation":"

Describes a Reserved Instance listing state.

" }, "InstanceCountList":{ "type":"list", "member":{ "shape":"InstanceCount", "locationName":"item" } }, "InstanceExportDetails":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the resource being exported.

", "locationName":"instanceId" }, "TargetEnvironment":{ "shape":"ExportEnvironment", "documentation":"

The target virtualization environment.

", "locationName":"targetEnvironment" } }, "documentation":"

Describes an instance to export.

" }, "InstanceHealthStatus":{ "type":"string", "enum":[ "healthy", "unhealthy" ] }, "InstanceIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "InstanceIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"InstanceId" } }, "InstanceIpv6Address":{ "type":"structure", "members":{ "Ipv6Address":{ "shape":"String", "documentation":"

The IPv6 address.

", "locationName":"ipv6Address" } }, "documentation":"

Describes an IPv6 address.

" }, "InstanceIpv6AddressList":{ "type":"list", "member":{ "shape":"InstanceIpv6Address", "locationName":"item" } }, "InstanceLifecycleType":{ "type":"string", "enum":[ "spot", "scheduled" ] }, "InstanceList":{ "type":"list", "member":{ "shape":"Instance", "locationName":"item" } }, "InstanceMonitoring":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Monitoring":{ "shape":"Monitoring", "documentation":"

The monitoring for the instance.

", "locationName":"monitoring" } }, "documentation":"

Describes the monitoring of an instance.

" }, "InstanceMonitoringList":{ "type":"list", "member":{ "shape":"InstanceMonitoring", "locationName":"item" } }, "InstanceNetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Description":{ "shape":"String", "documentation":"

The description.

", "locationName":"description" }, "OwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that created the network interface.

", "locationName":"ownerId" }, "Status":{ "shape":"NetworkInterfaceStatus", "documentation":"

The status of the network interface.

", "locationName":"status" }, "MacAddress":{ "shape":"String", "documentation":"

The MAC address.

", "locationName":"macAddress" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IPv4 address of the network interface within the subnet.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Indicates whether to validate network traffic to or from this network interface.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups.

", "locationName":"groupSet" }, "Attachment":{ "shape":"InstanceNetworkInterfaceAttachment", "documentation":"

The network interface attachment.

", "locationName":"attachment" }, "Association":{ "shape":"InstanceNetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IPv4 associated with the network interface.

", "locationName":"association" }, "PrivateIpAddresses":{ "shape":"InstancePrivateIpAddressList", "documentation":"

One or more private IPv4 addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" }, "Ipv6Addresses":{ "shape":"InstanceIpv6AddressList", "documentation":"

One or more IPv6 addresses associated with the network interface.

", "locationName":"ipv6AddressesSet" } }, "documentation":"

Describes a network interface.

" }, "InstanceNetworkInterfaceAssociation":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The public IP address or Elastic IP address bound to the network interface.

", "locationName":"publicIp" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name.

", "locationName":"publicDnsName" }, "IpOwnerId":{ "shape":"String", "documentation":"

The ID of the owner of the Elastic IP address.

", "locationName":"ipOwnerId" } }, "documentation":"

Describes association information for an Elastic IP address (IPv4).

" }, "InstanceNetworkInterfaceAttachment":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device on the instance for the network interface attachment.

", "locationName":"deviceIndex" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a network interface attachment.

" }, "InstanceNetworkInterfaceList":{ "type":"list", "member":{ "shape":"InstanceNetworkInterface", "locationName":"item" } }, "InstanceNetworkInterfaceSpecification":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

", "locationName":"deviceIndex" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

", "locationName":"subnetId" }, "Description":{ "shape":"String", "documentation":"

The description of the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"description" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

", "locationName":"privateIpAddress" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"SecurityGroupId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

", "locationName":"deleteOnTermination" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", "documentation":"

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

", "locationName":"privateIpAddressesSet", "queryName":"PrivateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.

", "locationName":"secondaryPrivateIpAddressCount" }, "AssociatePublicIpAddress":{ "shape":"Boolean", "documentation":"

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

", "locationName":"associatePublicIpAddress" }, "Ipv6Addresses":{ "shape":"InstanceIpv6AddressList", "documentation":"

One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

", "locationName":"ipv6AddressesSet", "queryName":"Ipv6Addresses" }, "Ipv6AddressCount":{ "shape":"Integer", "documentation":"

A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

", "locationName":"ipv6AddressCount" } }, "documentation":"

Describes a network interface.

" }, "InstanceNetworkInterfaceSpecificationList":{ "type":"list", "member":{ "shape":"InstanceNetworkInterfaceSpecification", "locationName":"item" } }, "InstancePrivateIpAddress":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IPv4 address of the network interface.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private IPv4 DNS name.

", "locationName":"privateDnsName" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this IPv4 address is the primary private IP address of the network interface.

", "locationName":"primary" }, "Association":{ "shape":"InstanceNetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address for the network interface.

", "locationName":"association" } }, "documentation":"

Describes a private IPv4 address.

" }, "InstancePrivateIpAddressList":{ "type":"list", "member":{ "shape":"InstancePrivateIpAddress", "locationName":"item" } }, "InstanceState":{ "type":"structure", "members":{ "Code":{ "shape":"Integer", "documentation":"

The low byte represents the state. The high byte is an opaque internal value and should be ignored.

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

", "locationName":"code" }, "Name":{ "shape":"InstanceStateName", "documentation":"

The current state of the instance.

", "locationName":"name" } }, "documentation":"

Describes the current state of an instance.

" }, "InstanceStateChange":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "CurrentState":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

", "locationName":"currentState" }, "PreviousState":{ "shape":"InstanceState", "documentation":"

The previous state of the instance.

", "locationName":"previousState" } }, "documentation":"

Describes an instance state change.

" }, "InstanceStateChangeList":{ "type":"list", "member":{ "shape":"InstanceStateChange", "locationName":"item" } }, "InstanceStateName":{ "type":"string", "enum":[ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ] }, "InstanceStatus":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the instance.

", "locationName":"availabilityZone" }, "Events":{ "shape":"InstanceStatusEventList", "documentation":"

Any scheduled events associated with the instance.

", "locationName":"eventsSet" }, "InstanceState":{ "shape":"InstanceState", "documentation":"

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

", "locationName":"instanceState" }, "SystemStatus":{ "shape":"InstanceStatusSummary", "documentation":"

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

", "locationName":"systemStatus" }, "InstanceStatus":{ "shape":"InstanceStatusSummary", "documentation":"

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

", "locationName":"instanceStatus" } }, "documentation":"

Describes the status of an instance.

" }, "InstanceStatusDetails":{ "type":"structure", "members":{ "Name":{ "shape":"StatusName", "documentation":"

The type of instance status.

", "locationName":"name" }, "Status":{ "shape":"StatusType", "documentation":"

The status.

", "locationName":"status" }, "ImpairedSince":{ "shape":"DateTime", "documentation":"

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

", "locationName":"impairedSince" } }, "documentation":"

Describes the instance status.

" }, "InstanceStatusDetailsList":{ "type":"list", "member":{ "shape":"InstanceStatusDetails", "locationName":"item" } }, "InstanceStatusEvent":{ "type":"structure", "members":{ "Code":{ "shape":"EventCode", "documentation":"

The event code.

", "locationName":"code" }, "Description":{ "shape":"String", "documentation":"

A description of the event.

After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].

", "locationName":"description" }, "NotBefore":{ "shape":"DateTime", "documentation":"

The earliest scheduled start time for the event.

", "locationName":"notBefore" }, "NotAfter":{ "shape":"DateTime", "documentation":"

The latest scheduled end time for the event.

", "locationName":"notAfter" } }, "documentation":"

Describes a scheduled event for an instance.

" }, "InstanceStatusEventList":{ "type":"list", "member":{ "shape":"InstanceStatusEvent", "locationName":"item" } }, "InstanceStatusList":{ "type":"list", "member":{ "shape":"InstanceStatus", "locationName":"item" } }, "InstanceStatusSummary":{ "type":"structure", "members":{ "Status":{ "shape":"SummaryStatus", "documentation":"

The status.

", "locationName":"status" }, "Details":{ "shape":"InstanceStatusDetailsList", "documentation":"

The system instance health or application instance health.

", "locationName":"details" } }, "documentation":"

Describes the status of an instance.

" }, "InstanceType":{ "type":"string", "enum":[ "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "t2.xlarge", "t2.2xlarge", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "x1.16xlarge", "x1.32xlarge", "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", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "g2.8xlarge", "cg1.4xlarge", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge", "f1.2xlarge", "f1.16xlarge" ] }, "InstanceTypeList":{ "type":"list", "member":{"shape":"InstanceType"} }, "Integer":{"type":"integer"}, "InternetGateway":{ "type":"structure", "members":{ "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "Attachments":{ "shape":"InternetGatewayAttachmentList", "documentation":"

Any VPCs attached to the Internet gateway.

", "locationName":"attachmentSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the Internet gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes an Internet gateway.

" }, "InternetGatewayAttachment":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"AttachmentStatus", "documentation":"

The current state of the attachment.

", "locationName":"state" } }, "documentation":"

Describes the attachment of a VPC to an Internet gateway or an egress-only Internet gateway.

" }, "InternetGatewayAttachmentList":{ "type":"list", "member":{ "shape":"InternetGatewayAttachment", "locationName":"item" } }, "InternetGatewayList":{ "type":"list", "member":{ "shape":"InternetGateway", "locationName":"item" } }, "IpPermission":{ "type":"structure", "members":{ "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers).

[EC2-VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or 58 (ICMPv6) allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For 58 (ICMPv6), you can optionally specify a port range; if you don't, traffic for all types and codes is allowed when authorizing rules.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type.

", "locationName":"toPort" }, "UserIdGroupPairs":{ "shape":"UserIdGroupPairList", "documentation":"

One or more security group and AWS account ID pairs.

", "locationName":"groups" }, "IpRanges":{ "shape":"IpRangeList", "documentation":"

One or more IPv4 ranges.

", "locationName":"ipRanges" }, "Ipv6Ranges":{ "shape":"Ipv6RangeList", "documentation":"

[EC2-VPC only] One or more IPv6 ranges.

", "locationName":"ipv6Ranges" }, "PrefixListIds":{ "shape":"PrefixListIdList", "documentation":"

(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

", "locationName":"prefixListIds" } }, "documentation":"

Describes a security group rule.

" }, "IpPermissionList":{ "type":"list", "member":{ "shape":"IpPermission", "locationName":"item" } }, "IpRange":{ "type":"structure", "members":{ "CidrIp":{ "shape":"String", "documentation":"

The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix.

", "locationName":"cidrIp" } }, "documentation":"

Describes an IPv4 range.

" }, "IpRangeList":{ "type":"list", "member":{ "shape":"IpRange", "locationName":"item" } }, "IpRanges":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "Ipv6Address":{"type":"string"}, "Ipv6AddressList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "Ipv6CidrBlock":{ "type":"structure", "members":{ "Ipv6CidrBlock":{ "shape":"String", "documentation":"

The IPv6 CIDR block.

", "locationName":"ipv6CidrBlock" } }, "documentation":"

Describes an IPv6 CIDR block.

" }, "Ipv6CidrBlockSet":{ "type":"list", "member":{ "shape":"Ipv6CidrBlock", "locationName":"item" } }, "Ipv6Range":{ "type":"structure", "members":{ "CidrIpv6":{ "shape":"String", "documentation":"

The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix.

", "locationName":"cidrIpv6" } }, "documentation":"

[EC2-VPC only] Describes an IPv6 range.

" }, "Ipv6RangeList":{ "type":"list", "member":{ "shape":"Ipv6Range", "locationName":"item" } }, "KeyNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"KeyName" } }, "KeyPair":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

The SHA-1 digest of the DER encoded private key.

", "locationName":"keyFingerprint" }, "KeyMaterial":{ "shape":"String", "documentation":"

An unencrypted PEM encoded RSA private key.

", "locationName":"keyMaterial" } }, "documentation":"

Describes a key pair.

" }, "KeyPairInfo":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", "locationName":"keyFingerprint" } }, "documentation":"

Describes a key pair.

" }, "KeyPairList":{ "type":"list", "member":{ "shape":"KeyPairInfo", "locationName":"item" } }, "LaunchPermission":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The AWS account ID.

", "locationName":"userId" }, "Group":{ "shape":"PermissionGroup", "documentation":"

The name of the group.

", "locationName":"group" } }, "documentation":"

Describes a launch permission.

" }, "LaunchPermissionList":{ "type":"list", "member":{ "shape":"LaunchPermission", "locationName":"item" } }, "LaunchPermissionModifications":{ "type":"structure", "members":{ "Add":{ "shape":"LaunchPermissionList", "documentation":"

The AWS account ID to add to the list of launch permissions for the AMI.

" }, "Remove":{ "shape":"LaunchPermissionList", "documentation":"

The AWS account ID to remove from the list of launch permissions for the AMI.

" } }, "documentation":"

Describes a launch permission modification.

" }, "LaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", "locationName":"groupSet" }, "UserData":{ "shape":"String", "documentation":"

The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.

", "locationName":"blockDeviceMapping" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" } }, "documentation":"

Describes the launch specification for an instance.

" }, "LaunchSpecsList":{ "type":"list", "member":{ "shape":"SpotFleetLaunchSpecification", "locationName":"item" }, "min":1 }, "ListingState":{ "type":"string", "enum":[ "available", "sold", "cancelled", "pending" ] }, "ListingStatus":{ "type":"string", "enum":[ "active", "pending", "cancelled", "closed" ] }, "Long":{"type":"long"}, "MaxResults":{ "type":"integer", "max":255, "min":5 }, "ModifyHostsRequest":{ "type":"structure", "required":[ "HostIds", "AutoPlacement" ], "members":{ "HostIds":{ "shape":"RequestHostIdList", "documentation":"

The host IDs of the Dedicated Hosts you want to modify.

", "locationName":"hostId" }, "AutoPlacement":{ "shape":"AutoPlacement", "documentation":"

Specify whether to enable or disable auto-placement.

", "locationName":"autoPlacement" } }, "documentation":"

Contains the parameters for ModifyHosts.

" }, "ModifyHostsResult":{ "type":"structure", "members":{ "Successful":{ "shape":"ResponseHostIdList", "documentation":"

The IDs of the Dedicated Hosts that were successfully modified.

", "locationName":"successful" }, "Unsuccessful":{ "shape":"UnsuccessfulItemList", "documentation":"

The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of ModifyHosts.

" }, "ModifyIdFormatRequest":{ "type":"structure", "required":[ "Resource", "UseLongIds" ], "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource: instance | reservation | snapshot | volume

" }, "UseLongIds":{ "shape":"Boolean", "documentation":"

Indicate whether the resource should use longer IDs (17-character IDs).

" } }, "documentation":"

Contains the parameters of ModifyIdFormat.

" }, "ModifyIdentityIdFormatRequest":{ "type":"structure", "required":[ "Resource", "UseLongIds", "PrincipalArn" ], "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource: instance | reservation | snapshot | volume

", "locationName":"resource" }, "UseLongIds":{ "shape":"Boolean", "documentation":"

Indicates whether the resource should use longer IDs (17-character IDs)

", "locationName":"useLongIds" }, "PrincipalArn":{ "shape":"String", "documentation":"

The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account.

", "locationName":"principalArn" } }, "documentation":"

Contains the parameters of ModifyIdentityIdFormat.

" }, "ModifyImageAttributeRequest":{ "type":"structure", "required":["ImageId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"String", "documentation":"

The name of the attribute to modify.

" }, "OperationType":{ "shape":"OperationType", "documentation":"

The operation type.

" }, "UserIds":{ "shape":"UserIdStringList", "documentation":"

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

", "locationName":"UserId" }, "UserGroups":{ "shape":"UserGroupStringList", "documentation":"

One or more user groups. This is only valid when modifying the launchPermission attribute.

", "locationName":"UserGroup" }, "ProductCodes":{ "shape":"ProductCodeStringList", "documentation":"

One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

", "locationName":"ProductCode" }, "Value":{ "shape":"String", "documentation":"

The value of the attribute being modified. This is only valid when modifying the description attribute.

" }, "LaunchPermission":{ "shape":"LaunchPermissionModifications", "documentation":"

A launch permission modification.

" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the AMI.

" } }, "documentation":"

Contains the parameters for ModifyImageAttribute.

" }, "ModifyInstanceAttributeRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The name of the attribute.

", "locationName":"attribute" }, "Value":{ "shape":"String", "documentation":"

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

", "locationName":"value" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingSpecificationList", "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"blockDeviceMapping" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

" }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", "documentation":"

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this paramater for Spot Instances.

", "locationName":"disableApiTermination" }, "InstanceType":{ "shape":"AttributeValue", "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", "locationName":"instanceType" }, "Kernel":{ "shape":"AttributeValue", "documentation":"

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", "locationName":"kernel" }, "Ramdisk":{ "shape":"AttributeValue", "documentation":"

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", "locationName":"ramdisk" }, "UserData":{ "shape":"BlobAttributeValue", "documentation":"

Changes the instance's user data to the specified value. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"userData" }, "InstanceInitiatedShutdownBehavior":{ "shape":"AttributeValue", "documentation":"

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "Groups":{ "shape":"GroupIdStringList", "documentation":"

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

", "locationName":"GroupId" }, "EbsOptimized":{ "shape":"AttributeBooleanValue", "documentation":"

Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"AttributeValue", "documentation":"

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.

There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", "locationName":"sriovNetSupport" }, "EnaSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Set to true to enable enhanced networking with ENA for the instance.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", "locationName":"enaSupport" } }, "documentation":"

Contains the parameters for ModifyInstanceAttribute.

" }, "ModifyInstancePlacementRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance that you are modifying.

", "locationName":"instanceId" }, "Tenancy":{ "shape":"HostTenancy", "documentation":"

The tenancy of the instance that you are modifying.

", "locationName":"tenancy" }, "Affinity":{ "shape":"Affinity", "documentation":"

The new affinity setting for the instance.

", "locationName":"affinity" }, "HostId":{ "shape":"String", "documentation":"

The ID of the Dedicated Host that the instance will have affinity with.

", "locationName":"hostId" } }, "documentation":"

Contains the parameters for ModifyInstancePlacement.

" }, "ModifyInstancePlacementResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Is true if the request succeeds, and an error otherwise.

", "locationName":"return" } }, "documentation":"

Contains the output of ModifyInstancePlacement.

" }, "ModifyNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the network interface.

", "locationName":"description" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", "locationName":"SecurityGroupId" }, "Attachment":{ "shape":"NetworkInterfaceAttachmentChanges", "documentation":"

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

", "locationName":"attachment" } }, "documentation":"

Contains the parameters for ModifyNetworkInterfaceAttribute.

" }, "ModifyReservedInstancesRequest":{ "type":"structure", "required":[ "ReservedInstancesIds", "TargetConfigurations" ], "members":{ "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" }, "ReservedInstancesIds":{ "shape":"ReservedInstancesIdStringList", "documentation":"

The IDs of the Reserved Instances to modify.

", "locationName":"ReservedInstancesId" }, "TargetConfigurations":{ "shape":"ReservedInstancesConfigurationList", "documentation":"

The configuration settings for the Reserved Instances to modify.

", "locationName":"ReservedInstancesConfigurationSetItemType" } }, "documentation":"

Contains the parameters for ModifyReservedInstances.

" }, "ModifyReservedInstancesResult":{ "type":"structure", "members":{ "ReservedInstancesModificationId":{ "shape":"String", "documentation":"

The ID for the modification.

", "locationName":"reservedInstancesModificationId" } }, "documentation":"

Contains the output of ModifyReservedInstances.

" }, "ModifySnapshotAttributeRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The snapshot attribute to modify.

Only volume creation permissions may be modified at the customer level.

" }, "OperationType":{ "shape":"OperationType", "documentation":"

The type of operation to perform to the attribute.

" }, "UserIds":{ "shape":"UserIdStringList", "documentation":"

The account ID to modify for the snapshot.

", "locationName":"UserId" }, "GroupNames":{ "shape":"GroupNameStringList", "documentation":"

The group to modify for the snapshot.

", "locationName":"UserGroup" }, "CreateVolumePermission":{ "shape":"CreateVolumePermissionModifications", "documentation":"

A JSON representation of the snapshot attribute modification.

" } }, "documentation":"

Contains the parameters for ModifySnapshotAttribute.

" }, "ModifySpotFleetRequestRequest":{ "type":"structure", "required":["SpotFleetRequestId"], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "TargetCapacity":{ "shape":"Integer", "documentation":"

The size of the fleet.

", "locationName":"targetCapacity" }, "ExcessCapacityTerminationPolicy":{ "shape":"ExcessCapacityTerminationPolicy", "documentation":"

Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.

", "locationName":"excessCapacityTerminationPolicy" } }, "documentation":"

Contains the parameters for ModifySpotFleetRequest.

" }, "ModifySpotFleetRequestResponse":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Is true if the request succeeds, and an error otherwise.

", "locationName":"return" } }, "documentation":"

Contains the output of ModifySpotFleetRequest.

" }, "ModifySubnetAttributeRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "MapPublicIpOnLaunch":{ "shape":"AttributeBooleanValue", "documentation":"

Specify true to indicate that network interfaces created in the specified subnet should be assigned a public IPv4 address. This includes a network interface that's created when launching an instance into the subnet (the instance therefore receives a public IPv4 address).

" }, "AssignIpv6AddressOnCreation":{ "shape":"AttributeBooleanValue", "documentation":"

Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. This includes a network interface that's created when launching an instance into the subnet (the instance therefore receives an IPv6 address).

If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an IPv6 address if it's created using version 2016-11-15 or later of the Amazon EC2 API.

" } }, "documentation":"

Contains the parameters for ModifySubnetAttribute.

" }, "ModifyVolumeAttributeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "AutoEnableIO":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the volume should be auto-enabled for I/O operations.

" } }, "documentation":"

Contains the parameters for ModifyVolumeAttribute.

" }, "ModifyVpcAttributeRequest":{ "type":"structure", "required":["VpcId"], "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "EnableDnsSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.

" }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.

" } }, "documentation":"

Contains the parameters for ModifyVpcAttribute.

" }, "ModifyVpcEndpointRequest":{ "type":"structure", "required":["VpcEndpointId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcEndpointId":{ "shape":"String", "documentation":"

The ID of the endpoint.

" }, "ResetPolicy":{ "shape":"Boolean", "documentation":"

Specify true to reset the policy document to the default policy. The default policy allows access to the service.

" }, "PolicyDocument":{ "shape":"String", "documentation":"

A policy document to attach to the endpoint. The policy must be in valid JSON format.

" }, "AddRouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route tables IDs to associate with the endpoint.

", "locationName":"AddRouteTableId" }, "RemoveRouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs to disassociate from the endpoint.

", "locationName":"RemoveRouteTableId" } }, "documentation":"

Contains the parameters for ModifyVpcEndpoint.

" }, "ModifyVpcEndpointResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of ModifyVpcEndpoint.

" }, "ModifyVpcPeeringConnectionOptionsRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

" }, "RequesterPeeringConnectionOptions":{ "shape":"PeeringConnectionOptionsRequest", "documentation":"

The VPC peering connection options for the requester VPC.

" }, "AccepterPeeringConnectionOptions":{ "shape":"PeeringConnectionOptionsRequest", "documentation":"

The VPC peering connection options for the accepter VPC.

" } } }, "ModifyVpcPeeringConnectionOptionsResult":{ "type":"structure", "members":{ "RequesterPeeringConnectionOptions":{ "shape":"PeeringConnectionOptions", "documentation":"

Information about the VPC peering connection options for the requester VPC.

", "locationName":"requesterPeeringConnectionOptions" }, "AccepterPeeringConnectionOptions":{ "shape":"PeeringConnectionOptions", "documentation":"

Information about the VPC peering connection options for the accepter VPC.

", "locationName":"accepterPeeringConnectionOptions" } } }, "MonitorInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } }, "documentation":"

Contains the parameters for MonitorInstances.

" }, "MonitorInstancesResult":{ "type":"structure", "members":{ "InstanceMonitorings":{ "shape":"InstanceMonitoringList", "documentation":"

The monitoring information.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of MonitorInstances.

" }, "Monitoring":{ "type":"structure", "members":{ "State":{ "shape":"MonitoringState", "documentation":"

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

", "locationName":"state" } }, "documentation":"

Describes the monitoring of an instance.

" }, "MonitoringState":{ "type":"string", "enum":[ "disabled", "disabling", "enabled", "pending" ] }, "MoveAddressToVpcRequest":{ "type":"structure", "required":["PublicIp"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" } }, "documentation":"

Contains the parameters for MoveAddressToVpc.

" }, "MoveAddressToVpcResult":{ "type":"structure", "members":{ "AllocationId":{ "shape":"String", "documentation":"

The allocation ID for the Elastic IP address.

", "locationName":"allocationId" }, "Status":{ "shape":"Status", "documentation":"

The status of the move of the IP address.

", "locationName":"status" } }, "documentation":"

Contains the output of MoveAddressToVpc.

" }, "MoveStatus":{ "type":"string", "enum":[ "movingToVpc", "restoringToClassic" ] }, "MovingAddressStatus":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "MoveStatus":{ "shape":"MoveStatus", "documentation":"

The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.

", "locationName":"moveStatus" } }, "documentation":"

Describes the status of a moving Elastic IP address.

" }, "MovingAddressStatusSet":{ "type":"list", "member":{ "shape":"MovingAddressStatus", "locationName":"item" } }, "NatGateway":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC in which the NAT gateway is located.

", "locationName":"vpcId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which the NAT gateway is located.

", "locationName":"subnetId" }, "NatGatewayId":{ "shape":"String", "documentation":"

The ID of the NAT gateway.

", "locationName":"natGatewayId" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The date and time the NAT gateway was created.

", "locationName":"createTime" }, "DeleteTime":{ "shape":"DateTime", "documentation":"

The date and time the NAT gateway was deleted, if applicable.

", "locationName":"deleteTime" }, "NatGatewayAddresses":{ "shape":"NatGatewayAddressList", "documentation":"

Information about the IP addresses and network interface associated with the NAT gateway.

", "locationName":"natGatewayAddressSet" }, "State":{ "shape":"NatGatewayState", "documentation":"

The state of the NAT gateway.

  • pending: The NAT gateway is being created and is not ready to process traffic.

  • failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.

  • available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.

  • deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.

  • deleted: The NAT gateway has been terminated and is no longer processing traffic.

", "locationName":"state" }, "FailureCode":{ "shape":"String", "documentation":"

If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)

", "locationName":"failureCode" }, "FailureMessage":{ "shape":"String", "documentation":"

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

  • For InsufficientFreeAddressesInSubnet: \"Subnet has insufficient free addresses to create this NAT gateway\"

  • For Gateway.NotAttached: \"Network vpc-xxxxxxxx has no Internet gateway attached\"

  • For InvalidAllocationID.NotFound: \"Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway\"

  • For Resource.AlreadyAssociated: \"Elastic IP address eipalloc-xxxxxxxx is already associated\"

  • For InternalError: \"Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again.\"

  • For InvalidSubnetID.NotFound: \"The specified subnet subnet-xxxxxxxx does not exist or could not be found.\"

", "locationName":"failureMessage" }, "ProvisionedBandwidth":{ "shape":"ProvisionedBandwidth", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"provisionedBandwidth" } }, "documentation":"

Describes a NAT gateway.

" }, "NatGatewayAddress":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address associated with the NAT gateway.

", "locationName":"publicIp" }, "AllocationId":{ "shape":"String", "documentation":"

The allocation ID of the Elastic IP address that's associated with the NAT gateway.

", "locationName":"allocationId" }, "PrivateIp":{ "shape":"String", "documentation":"

The private IP address associated with the Elastic IP address.

", "locationName":"privateIp" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface associated with the NAT gateway.

", "locationName":"networkInterfaceId" } }, "documentation":"

Describes the IP addresses and network interface associated with a NAT gateway.

" }, "NatGatewayAddressList":{ "type":"list", "member":{ "shape":"NatGatewayAddress", "locationName":"item" } }, "NatGatewayList":{ "type":"list", "member":{ "shape":"NatGateway", "locationName":"item" } }, "NatGatewayState":{ "type":"string", "enum":[ "pending", "failed", "available", "deleting", "deleted" ] }, "NetworkAcl":{ "type":"structure", "members":{ "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for the network ACL.

", "locationName":"vpcId" }, "IsDefault":{ "shape":"Boolean", "documentation":"

Indicates whether this is the default network ACL for the VPC.

", "locationName":"default" }, "Entries":{ "shape":"NetworkAclEntryList", "documentation":"

One or more entries (rules) in the network ACL.

", "locationName":"entrySet" }, "Associations":{ "shape":"NetworkAclAssociationList", "documentation":"

Any associations between the network ACL and one or more subnets

", "locationName":"associationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the network ACL.

", "locationName":"tagSet" } }, "documentation":"

Describes a network ACL.

" }, "NetworkAclAssociation":{ "type":"structure", "members":{ "NetworkAclAssociationId":{ "shape":"String", "documentation":"

The ID of the association between a network ACL and a subnet.

", "locationName":"networkAclAssociationId" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" } }, "documentation":"

Describes an association between a network ACL and a subnet.

" }, "NetworkAclAssociationList":{ "type":"list", "member":{ "shape":"NetworkAclAssociation", "locationName":"item" } }, "NetworkAclEntry":{ "type":"structure", "members":{ "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The protocol. A value of -1 means all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The IPv4 network range to allow or deny, in CIDR notation.

", "locationName":"cidrBlock" }, "Ipv6CidrBlock":{ "shape":"String", "documentation":"

The IPv6 network range to allow or deny, in CIDR notation.

", "locationName":"ipv6CidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code.

", "locationName":"icmpTypeCode" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", "locationName":"portRange" } }, "documentation":"

Describes an entry in a network ACL.

" }, "NetworkAclEntryList":{ "type":"list", "member":{ "shape":"NetworkAclEntry", "locationName":"item" } }, "NetworkAclList":{ "type":"list", "member":{ "shape":"NetworkAcl", "locationName":"item" } }, "NetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "Description":{ "shape":"String", "documentation":"

A description.

", "locationName":"description" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the network interface.

", "locationName":"ownerId" }, "RequesterId":{ "shape":"String", "documentation":"

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", "locationName":"requesterId" }, "RequesterManaged":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is being managed by AWS.

", "locationName":"requesterManaged" }, "Status":{ "shape":"NetworkInterfaceStatus", "documentation":"

The status of the network interface.

", "locationName":"status" }, "MacAddress":{ "shape":"String", "documentation":"

The MAC address.

", "locationName":"macAddress" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IPv4 address of the network interface within the subnet.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Indicates whether traffic to or from the instance is validated.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

Any security groups for the network interface.

", "locationName":"groupSet" }, "Attachment":{ "shape":"NetworkInterfaceAttachment", "documentation":"

The network interface attachment.

", "locationName":"attachment" }, "Association":{ "shape":"NetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address (IPv4) associated with the network interface.

", "locationName":"association" }, "TagSet":{ "shape":"TagList", "documentation":"

Any tags assigned to the network interface.

", "locationName":"tagSet" }, "PrivateIpAddresses":{ "shape":"NetworkInterfacePrivateIpAddressList", "documentation":"

The private IPv4 addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" }, "Ipv6Addresses":{ "shape":"NetworkInterfaceIpv6AddressesList", "documentation":"

The IPv6 addresses associated with the network interface.

", "locationName":"ipv6AddressesSet" }, "InterfaceType":{ "shape":"NetworkInterfaceType", "documentation":"

The type of interface.

", "locationName":"interfaceType" } }, "documentation":"

Describes a network interface.

" }, "NetworkInterfaceAssociation":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The address of the Elastic IP address bound to the network interface.

", "locationName":"publicIp" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name.

", "locationName":"publicDnsName" }, "IpOwnerId":{ "shape":"String", "documentation":"

The ID of the Elastic IP address owner.

", "locationName":"ipOwnerId" }, "AllocationId":{ "shape":"String", "documentation":"

The allocation ID.

", "locationName":"allocationId" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID.

", "locationName":"associationId" } }, "documentation":"

Describes association information for an Elastic IP address (IPv4 only).

" }, "NetworkInterfaceAttachment":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "InstanceOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the instance.

", "locationName":"instanceOwnerId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The device index of the network interface attachment on the instance.

", "locationName":"deviceIndex" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The timestamp indicating when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a network interface attachment.

" }, "NetworkInterfaceAttachmentChanges":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes an attachment change.

" }, "NetworkInterfaceAttribute":{ "type":"string", "enum":[ "description", "groupSet", "sourceDestCheck", "attachment" ] }, "NetworkInterfaceIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "NetworkInterfaceIpv6Address":{ "type":"structure", "members":{ "Ipv6Address":{ "shape":"String", "documentation":"

The IPv6 address.

", "locationName":"ipv6Address" } }, "documentation":"

Describes an IPv6 address associated with a network interface.

" }, "NetworkInterfaceIpv6AddressesList":{ "type":"list", "member":{ "shape":"NetworkInterfaceIpv6Address", "locationName":"item" } }, "NetworkInterfaceList":{ "type":"list", "member":{ "shape":"NetworkInterface", "locationName":"item" } }, "NetworkInterfacePrivateIpAddress":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IPv4 address.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.

", "locationName":"primary" }, "Association":{ "shape":"NetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address (IPv4) associated with the network interface.

", "locationName":"association" } }, "documentation":"

Describes the private IPv4 address of a network interface.

" }, "NetworkInterfacePrivateIpAddressList":{ "type":"list", "member":{ "shape":"NetworkInterfacePrivateIpAddress", "locationName":"item" } }, "NetworkInterfaceStatus":{ "type":"string", "enum":[ "available", "attaching", "in-use", "detaching" ] }, "NetworkInterfaceType":{ "type":"string", "enum":[ "interface", "natGateway" ] }, "NewDhcpConfiguration":{ "type":"structure", "members":{ "Key":{ "shape":"String", "locationName":"key" }, "Values":{ "shape":"ValueStringList", "locationName":"Value" } } }, "NewDhcpConfigurationList":{ "type":"list", "member":{ "shape":"NewDhcpConfiguration", "locationName":"item" } }, "NextToken":{ "type":"string", "max":1024, "min":1 }, "OccurrenceDayRequestSet":{ "type":"list", "member":{ "shape":"Integer", "locationName":"OccurenceDay" } }, "OccurrenceDaySet":{ "type":"list", "member":{ "shape":"Integer", "locationName":"item" } }, "OfferingClassType":{ "type":"string", "enum":[ "standard", "convertible" ] }, "OfferingTypeValues":{ "type":"string", "enum":[ "Heavy Utilization", "Medium Utilization", "Light Utilization", "No Upfront", "Partial Upfront", "All Upfront" ] }, "OperationType":{ "type":"string", "enum":[ "add", "remove" ] }, "OwnerStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"Owner" } }, "PaymentOption":{ "type":"string", "enum":[ "AllUpfront", "PartialUpfront", "NoUpfront" ] }, "PeeringConnectionOptions":{ "type":"structure", "members":{ "AllowEgressFromLocalClassicLinkToRemoteVpc":{ "shape":"Boolean", "documentation":"

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

", "locationName":"allowEgressFromLocalClassicLinkToRemoteVpc" }, "AllowEgressFromLocalVpcToRemoteClassicLink":{ "shape":"Boolean", "documentation":"

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

", "locationName":"allowEgressFromLocalVpcToRemoteClassicLink" }, "AllowDnsResolutionFromRemoteVpc":{ "shape":"Boolean", "documentation":"

If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

", "locationName":"allowDnsResolutionFromRemoteVpc" } }, "documentation":"

Describes the VPC peering connection options.

" }, "PeeringConnectionOptionsRequest":{ "type":"structure", "members":{ "AllowEgressFromLocalClassicLinkToRemoteVpc":{ "shape":"Boolean", "documentation":"

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

" }, "AllowEgressFromLocalVpcToRemoteClassicLink":{ "shape":"Boolean", "documentation":"

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

" }, "AllowDnsResolutionFromRemoteVpc":{ "shape":"Boolean", "documentation":"

If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

" } }, "documentation":"

The VPC peering connection options.

" }, "PermissionGroup":{ "type":"string", "enum":["all"] }, "Placement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the instance.

", "locationName":"availabilityZone" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group the instance is in (for cluster compute instances).

", "locationName":"groupName" }, "Tenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

", "locationName":"tenancy" }, "HostId":{ "shape":"String", "documentation":"

The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

", "locationName":"hostId" }, "Affinity":{ "shape":"String", "documentation":"

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

", "locationName":"affinity" } }, "documentation":"

Describes the placement of an instance.

" }, "PlacementGroup":{ "type":"structure", "members":{ "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"

The placement strategy.

", "locationName":"strategy" }, "State":{ "shape":"PlacementGroupState", "documentation":"

The state of the placement group.

", "locationName":"state" } }, "documentation":"

Describes a placement group.

" }, "PlacementGroupList":{ "type":"list", "member":{ "shape":"PlacementGroup", "locationName":"item" } }, "PlacementGroupState":{ "type":"string", "enum":[ "pending", "available", "deleting", "deleted" ] }, "PlacementGroupStringList":{ "type":"list", "member":{"shape":"String"} }, "PlacementStrategy":{ "type":"string", "enum":["cluster"] }, "PlatformValues":{ "type":"string", "enum":["Windows"] }, "PortRange":{ "type":"structure", "members":{ "From":{ "shape":"Integer", "documentation":"

The first port in the range.

", "locationName":"from" }, "To":{ "shape":"Integer", "documentation":"

The last port in the range.

", "locationName":"to" } }, "documentation":"

Describes a range of ports.

" }, "PrefixList":{ "type":"structure", "members":{ "PrefixListId":{ "shape":"String", "documentation":"

The ID of the prefix.

", "locationName":"prefixListId" }, "PrefixListName":{ "shape":"String", "documentation":"

The name of the prefix.

", "locationName":"prefixListName" }, "Cidrs":{ "shape":"ValueStringList", "documentation":"

The IP address range of the AWS service.

", "locationName":"cidrSet" } }, "documentation":"

Describes prefixes for AWS services.

" }, "PrefixListId":{ "type":"structure", "members":{ "PrefixListId":{ "shape":"String", "documentation":"

The ID of the prefix.

", "locationName":"prefixListId" } }, "documentation":"

The ID of the prefix.

" }, "PrefixListIdList":{ "type":"list", "member":{ "shape":"PrefixListId", "locationName":"item" } }, "PrefixListIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "PrefixListSet":{ "type":"list", "member":{ "shape":"PrefixList", "locationName":"item" } }, "PriceSchedule":{ "type":"structure", "members":{ "Term":{ "shape":"Long", "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"

The fixed price for the term.

", "locationName":"price" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "Active":{ "shape":"Boolean", "documentation":"

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", "locationName":"active" } }, "documentation":"

Describes the price for a Reserved Instance.

" }, "PriceScheduleList":{ "type":"list", "member":{ "shape":"PriceSchedule", "locationName":"item" } }, "PriceScheduleSpecification":{ "type":"structure", "members":{ "Term":{ "shape":"Long", "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"

The fixed price for the term.

", "locationName":"price" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } }, "documentation":"

Describes the price for a Reserved Instance.

" }, "PriceScheduleSpecificationList":{ "type":"list", "member":{ "shape":"PriceScheduleSpecification", "locationName":"item" } }, "PricingDetail":{ "type":"structure", "members":{ "Price":{ "shape":"Double", "documentation":"

The price per instance.

", "locationName":"price" }, "Count":{ "shape":"Integer", "documentation":"

The number of reservations available for the price.

", "locationName":"count" } }, "documentation":"

Describes a Reserved Instance offering.

" }, "PricingDetailsList":{ "type":"list", "member":{ "shape":"PricingDetail", "locationName":"item" } }, "PrivateIpAddressConfigSet":{ "type":"list", "member":{ "shape":"ScheduledInstancesPrivateIpAddressConfig", "locationName":"PrivateIpAddressConfigSet" } }, "PrivateIpAddressSpecification":{ "type":"structure", "required":["PrivateIpAddress"], "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IPv4 addresses.

", "locationName":"privateIpAddress" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.

", "locationName":"primary" } }, "documentation":"

Describes a secondary private IPv4 address for a network interface.

" }, "PrivateIpAddressSpecificationList":{ "type":"list", "member":{ "shape":"PrivateIpAddressSpecification", "locationName":"item" } }, "PrivateIpAddressStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"PrivateIpAddress" } }, "ProductCode":{ "type":"structure", "members":{ "ProductCodeId":{ "shape":"String", "documentation":"

The product code.

", "locationName":"productCode" }, "ProductCodeType":{ "shape":"ProductCodeValues", "documentation":"

The type of product code.

", "locationName":"type" } }, "documentation":"

Describes a product code.

" }, "ProductCodeList":{ "type":"list", "member":{ "shape":"ProductCode", "locationName":"item" } }, "ProductCodeStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ProductCode" } }, "ProductCodeValues":{ "type":"string", "enum":[ "devpay", "marketplace" ] }, "ProductDescriptionList":{ "type":"list", "member":{"shape":"String"} }, "PropagatingVgw":{ "type":"structure", "members":{ "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway (VGW).

", "locationName":"gatewayId" } }, "documentation":"

Describes a virtual private gateway propagating route.

" }, "PropagatingVgwList":{ "type":"list", "member":{ "shape":"PropagatingVgw", "locationName":"item" } }, "ProvisionedBandwidth":{ "type":"structure", "members":{ "Provisioned":{ "shape":"String", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"provisioned" }, "Requested":{ "shape":"String", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"requested" }, "RequestTime":{ "shape":"DateTime", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"requestTime" }, "ProvisionTime":{ "shape":"DateTime", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"provisionTime" }, "Status":{ "shape":"String", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"status" } }, "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

" }, "PublicIpStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"PublicIp" } }, "Purchase":{ "type":"structure", "members":{ "HostReservationId":{ "shape":"String", "documentation":"

The ID of the reservation.

", "locationName":"hostReservationId" }, "HostIdSet":{ "shape":"ResponseHostIdSet", "documentation":"

The IDs of the Dedicated Hosts associated with the reservation.

", "locationName":"hostIdSet" }, "InstanceFamily":{ "shape":"String", "documentation":"

The instance family on the Dedicated Host that the reservation can be associated with.

", "locationName":"instanceFamily" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"

The payment option for the reservation.

", "locationName":"paymentOption" }, "UpfrontPrice":{ "shape":"String", "documentation":"

The upfront price of the reservation.

", "locationName":"upfrontPrice" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price of the reservation per hour.

", "locationName":"hourlyPrice" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "Duration":{ "shape":"Integer", "documentation":"

The duration of the reservation's term in seconds.

", "locationName":"duration" } }, "documentation":"

Describes the result of the purchase.

" }, "PurchaseHostReservationRequest":{ "type":"structure", "required":[ "OfferingId", "HostIdSet" ], "members":{ "OfferingId":{ "shape":"String", "documentation":"

The ID of the offering.

" }, "HostIdSet":{ "shape":"RequestHostIdSet", "documentation":"

The ID/s of the Dedicated Host/s that the reservation will be associated with.

" }, "LimitPrice":{ "shape":"String", "documentation":"

The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request will fail. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.

" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" } } }, "PurchaseHostReservationResult":{ "type":"structure", "members":{ "Purchase":{ "shape":"PurchaseSet", "documentation":"

Describes the details of the purchase.

", "locationName":"purchase" }, "TotalUpfrontPrice":{ "shape":"String", "documentation":"

The total amount that will be charged to your account when you purchase the reservation.

", "locationName":"totalUpfrontPrice" }, "TotalHourlyPrice":{ "shape":"String", "documentation":"

The total hourly price of the reservation calculated per hour.

", "locationName":"totalHourlyPrice" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide

", "locationName":"clientToken" } } }, "PurchaseRequest":{ "type":"structure", "required":[ "PurchaseToken", "InstanceCount" ], "members":{ "PurchaseToken":{ "shape":"String", "documentation":"

The purchase token.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances.

" } }, "documentation":"

Describes a request to purchase Scheduled Instances.

" }, "PurchaseRequestSet":{ "type":"list", "member":{ "shape":"PurchaseRequest", "locationName":"PurchaseRequest" }, "min":1 }, "PurchaseReservedInstancesOfferingRequest":{ "type":"structure", "required":[ "ReservedInstancesOfferingId", "InstanceCount" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance offering to purchase.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of Reserved Instances to purchase.

" }, "LimitPrice":{ "shape":"ReservedInstanceLimitPrice", "documentation":"

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", "locationName":"limitPrice" } }, "documentation":"

Contains the parameters for PurchaseReservedInstancesOffering.

" }, "PurchaseReservedInstancesOfferingResult":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The IDs of the purchased Reserved Instances.

", "locationName":"reservedInstancesId" } }, "documentation":"

Contains the output of PurchaseReservedInstancesOffering.

" }, "PurchaseScheduledInstancesRequest":{ "type":"structure", "required":["PurchaseRequests"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

", "idempotencyToken":true }, "PurchaseRequests":{ "shape":"PurchaseRequestSet", "documentation":"

One or more purchase requests.

", "locationName":"PurchaseRequest" } }, "documentation":"

Contains the parameters for PurchaseScheduledInstances.

" }, "PurchaseScheduledInstancesResult":{ "type":"structure", "members":{ "ScheduledInstanceSet":{ "shape":"PurchasedScheduledInstanceSet", "documentation":"

Information about the Scheduled Instances.

", "locationName":"scheduledInstanceSet" } }, "documentation":"

Contains the output of PurchaseScheduledInstances.

" }, "PurchaseSet":{ "type":"list", "member":{"shape":"Purchase"} }, "PurchasedScheduledInstanceSet":{ "type":"list", "member":{ "shape":"ScheduledInstance", "locationName":"item" } }, "RIProductDescription":{ "type":"string", "enum":[ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ] }, "ReasonCodesList":{ "type":"list", "member":{ "shape":"ReportInstanceReasonCodes", "locationName":"item" } }, "RebootInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } }, "documentation":"

Contains the parameters for RebootInstances.

" }, "RecurringCharge":{ "type":"structure", "members":{ "Frequency":{ "shape":"RecurringChargeFrequency", "documentation":"

The frequency of the recurring charge.

", "locationName":"frequency" }, "Amount":{ "shape":"Double", "documentation":"

The amount of the recurring charge.

", "locationName":"amount" } }, "documentation":"

Describes a recurring charge.

" }, "RecurringChargeFrequency":{ "type":"string", "enum":["Hourly"] }, "RecurringChargesList":{ "type":"list", "member":{ "shape":"RecurringCharge", "locationName":"item" } }, "Region":{ "type":"structure", "members":{ "RegionName":{ "shape":"String", "documentation":"

The name of the region.

", "locationName":"regionName" }, "Endpoint":{ "shape":"String", "documentation":"

The region service endpoint.

", "locationName":"regionEndpoint" } }, "documentation":"

Describes a region.

" }, "RegionList":{ "type":"list", "member":{ "shape":"Region", "locationName":"item" } }, "RegionNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"RegionName" } }, "RegisterImageRequest":{ "type":"structure", "required":["Name"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageLocation":{ "shape":"String", "documentation":"

The full path to your AMI manifest in Amazon S3 storage.

" }, "Name":{ "shape":"String", "documentation":"

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

A description for your AMI.

", "locationName":"description" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

", "locationName":"architecture" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "RootDeviceName":{ "shape":"String", "documentation":"

The name of the root device (for example, /dev/sda1, or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

One or more block device mapping entries.

", "locationName":"BlockDeviceMapping" }, "VirtualizationType":{ "shape":"String", "documentation":"

The type of virtualization.

Default: paravirtual

", "locationName":"virtualizationType" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", "locationName":"sriovNetSupport" }, "EnaSupport":{ "shape":"Boolean", "documentation":"

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", "locationName":"enaSupport" } }, "documentation":"

Contains the parameters for RegisterImage.

" }, "RegisterImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the newly registered AMI.

", "locationName":"imageId" } }, "documentation":"

Contains the output of RegisterImage.

" }, "RejectVpcPeeringConnectionRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Contains the parameters for RejectVpcPeeringConnection.

" }, "RejectVpcPeeringConnectionResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of RejectVpcPeeringConnection.

" }, "ReleaseAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" } }, "documentation":"

Contains the parameters for ReleaseAddress.

" }, "ReleaseHostsRequest":{ "type":"structure", "required":["HostIds"], "members":{ "HostIds":{ "shape":"RequestHostIdList", "documentation":"

The IDs of the Dedicated Hosts you want to release.

", "locationName":"hostId" } }, "documentation":"

Contains the parameters for ReleaseHosts.

" }, "ReleaseHostsResult":{ "type":"structure", "members":{ "Successful":{ "shape":"ResponseHostIdList", "documentation":"

The IDs of the Dedicated Hosts that were successfully released.

", "locationName":"successful" }, "Unsuccessful":{ "shape":"UnsuccessfulItemList", "documentation":"

The IDs of the Dedicated Hosts that could not be released, including an error message.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of ReleaseHosts.

" }, "ReplaceNetworkAclAssociationRequest":{ "type":"structure", "required":[ "AssociationId", "NetworkAclId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The ID of the current association between the original network ACL and the subnet.

", "locationName":"associationId" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the new network ACL to associate with the subnet.

", "locationName":"networkAclId" } }, "documentation":"

Contains the parameters for ReplaceNetworkAclAssociation.

" }, "ReplaceNetworkAclAssociationResult":{ "type":"structure", "members":{ "NewAssociationId":{ "shape":"String", "documentation":"

The ID of the new association.

", "locationName":"newAssociationId" } }, "documentation":"

Contains the output of ReplaceNetworkAclAssociation.

" }, "ReplaceNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Protocol", "RuleAction", "Egress" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number of the entry to replace.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The IP protocol. You can specify all or -1 to mean all protocols. If you specify all, -1, or a protocol number other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports or ICMP types or codes you specify. If you specify protocol 58 (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol 58 (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", "locationName":"cidrBlock" }, "Ipv6CidrBlock":{ "shape":"String", "documentation":"

The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64).

", "locationName":"ipv6CidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying the ICMP (1) protocol, or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", "locationName":"Icmp" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying TCP (6) or UDP (17) for the protocol.

", "locationName":"portRange" } }, "documentation":"

Contains the parameters for ReplaceNetworkAclEntry.

" }, "ReplaceRouteRequest":{ "type":"structure", "required":["RouteTableId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The IPv4 CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of an Internet gateway or virtual private gateway.

", "locationName":"gatewayId" }, "DestinationIpv6CidrBlock":{ "shape":"String", "documentation":"

The IPv6 CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

", "locationName":"destinationIpv6CidrBlock" }, "EgressOnlyInternetGatewayId":{ "shape":"String", "documentation":"

[IPv6 traffic only] The ID of an egress-only Internet gateway.

", "locationName":"egressOnlyInternetGatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC.

", "locationName":"instanceId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of a network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of a VPC peering connection.

", "locationName":"vpcPeeringConnectionId" }, "NatGatewayId":{ "shape":"String", "documentation":"

[IPv4 traffic only] The ID of a NAT gateway.

", "locationName":"natGatewayId" } }, "documentation":"

Contains the parameters for ReplaceRoute.

" }, "ReplaceRouteTableAssociationRequest":{ "type":"structure", "required":[ "AssociationId", "RouteTableId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID.

", "locationName":"associationId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the new route table to associate with the subnet.

", "locationName":"routeTableId" } }, "documentation":"

Contains the parameters for ReplaceRouteTableAssociation.

" }, "ReplaceRouteTableAssociationResult":{ "type":"structure", "members":{ "NewAssociationId":{ "shape":"String", "documentation":"

The ID of the new association.

", "locationName":"newAssociationId" } }, "documentation":"

Contains the output of ReplaceRouteTableAssociation.

" }, "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" ] }, "ReportInstanceStatusRequest":{ "type":"structure", "required":[ "Instances", "Status", "ReasonCodes" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Instances":{ "shape":"InstanceIdStringList", "documentation":"

One or more instances.

", "locationName":"instanceId" }, "Status":{ "shape":"ReportStatusType", "documentation":"

The status of all instances listed.

", "locationName":"status" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time at which the reported instance health state began.

", "locationName":"startTime" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time at which the reported instance health state ended.

", "locationName":"endTime" }, "ReasonCodes":{ "shape":"ReasonCodesList", "documentation":"

One or more reason codes that describes the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems which I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

", "locationName":"reasonCode" }, "Description":{ "shape":"String", "documentation":"

Descriptive text about the health state of your instance.

", "locationName":"description" } }, "documentation":"

Contains the parameters for ReportInstanceStatus.

" }, "ReportStatusType":{ "type":"string", "enum":[ "ok", "impaired" ] }, "RequestHostIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "RequestHostIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "RequestSpotFleetRequest":{ "type":"structure", "required":["SpotFleetRequestConfig"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestConfig":{ "shape":"SpotFleetRequestConfigData", "documentation":"

The configuration for the Spot fleet request.

", "locationName":"spotFleetRequestConfig" } }, "documentation":"

Contains the parameters for RequestSpotFleet.

" }, "RequestSpotFleetResponse":{ "type":"structure", "required":["SpotFleetRequestId"], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" } }, "documentation":"

Contains the output of RequestSpotFleet.

" }, "RequestSpotInstancesRequest":{ "type":"structure", "required":["SpotPrice"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum hourly price (bid) for any Spot instance launched to fulfill the request.

", "locationName":"spotPrice" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"clientToken" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The maximum number of Spot instances to launch.

Default: 1

", "locationName":"instanceCount" }, "Type":{ "shape":"SpotInstanceType", "documentation":"

The Spot instance request type.

Default: one-time

", "locationName":"type" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

Default: The request is effective indefinitely.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

Default: The request is effective indefinitely.

", "locationName":"validUntil" }, "LaunchGroup":{ "shape":"String", "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

Default: Instances are launched and terminated individually

", "locationName":"launchGroup" }, "AvailabilityZoneGroup":{ "shape":"String", "documentation":"

The user-specified name for a logical grouping of bids.

When you specify an Availability Zone group in a Spot Instance request, all Spot instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", "locationName":"availabilityZoneGroup" }, "BlockDurationMinutes":{ "shape":"Integer", "documentation":"

The required duration for the Spot instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

The duration period starts as soon as your Spot instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.

Note that you can't specify an Availability Zone group or a launch group if you specify a duration.

", "locationName":"blockDurationMinutes" }, "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} }, "documentation":"

Contains the parameters for RequestSpotInstances.

" }, "RequestSpotInstancesResult":{ "type":"structure", "members":{ "SpotInstanceRequests":{ "shape":"SpotInstanceRequestList", "documentation":"

One or more Spot instance requests.

", "locationName":"spotInstanceRequestSet" } }, "documentation":"

Contains the output of RequestSpotInstances.

" }, "RequestSpotLaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"ValueStringList", "locationName":"SecurityGroup" }, "UserData":{ "shape":"String", "documentation":"

The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.

", "locationName":"blockDeviceMapping" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.

", "locationName":"NetworkInterface" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" }, "SecurityGroupIds":{ "shape":"ValueStringList", "locationName":"SecurityGroupId" } }, "documentation":"

Describes the launch specification for an instance.

" }, "Reservation":{ "type":"structure", "members":{ "ReservationId":{ "shape":"String", "documentation":"

The ID of the reservation.

", "locationName":"reservationId" }, "OwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that owns the reservation.

", "locationName":"ownerId" }, "RequesterId":{ "shape":"String", "documentation":"

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

", "locationName":"requesterId" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

[EC2-Classic only] One or more security groups.

", "locationName":"groupSet" }, "Instances":{ "shape":"InstanceList", "documentation":"

One or more instances.

", "locationName":"instancesSet" } }, "documentation":"

Describes a reservation.

" }, "ReservationList":{ "type":"list", "member":{ "shape":"Reservation", "locationName":"item" } }, "ReservationState":{ "type":"string", "enum":[ "payment-pending", "payment-failed", "active", "retired" ] }, "ReservationValue":{ "type":"structure", "members":{ "RemainingTotalValue":{ "shape":"String", "documentation":"

The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).

", "locationName":"remainingTotalValue" }, "RemainingUpfrontValue":{ "shape":"String", "documentation":"

The remaining upfront cost of the reservation.

", "locationName":"remainingUpfrontValue" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly rate of the reservation.

", "locationName":"hourlyPrice" } }, "documentation":"

The cost associated with the Reserved Instance.

" }, "ReservedInstanceIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstanceId" } }, "ReservedInstanceLimitPrice":{ "type":"structure", "members":{ "Amount":{ "shape":"Double", "documentation":"

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", "locationName":"amount" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } }, "documentation":"

Describes the limit price of a Reserved Instance offering.

" }, "ReservedInstanceReservationValue":{ "type":"structure", "members":{ "ReservedInstanceId":{ "shape":"String", "documentation":"

The ID of the Convertible Reserved Instance that you are exchanging.

", "locationName":"reservedInstanceId" }, "ReservationValue":{ "shape":"ReservationValue", "documentation":"

The total value of the Convertible Reserved Instance that you are exchanging.

", "locationName":"reservationValue" } }, "documentation":"

The total value of the Convertible Reserved Instance.

" }, "ReservedInstanceReservationValueSet":{ "type":"list", "member":{ "shape":"ReservedInstanceReservationValue", "locationName":"item" } }, "ReservedInstanceState":{ "type":"string", "enum":[ "payment-pending", "active", "payment-failed", "retired" ] }, "ReservedInstances":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used.

", "locationName":"instanceType" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", "locationName":"availabilityZone" }, "Start":{ "shape":"DateTime", "documentation":"

The date and time the Reserved Instance started.

", "locationName":"start" }, "End":{ "shape":"DateTime", "documentation":"

The time when the Reserved Instance expires.

", "locationName":"end" }, "Duration":{ "shape":"Long", "documentation":"

The duration of the Reserved Instance, in seconds.

", "locationName":"duration" }, "UsagePrice":{ "shape":"Float", "documentation":"

The usage price of the Reserved Instance, per hour.

", "locationName":"usagePrice" }, "FixedPrice":{ "shape":"Float", "documentation":"

The purchase price of the Reserved Instance.

", "locationName":"fixedPrice" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of reservations purchased.

", "locationName":"instanceCount" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance product platform description.

", "locationName":"productDescription" }, "State":{ "shape":"ReservedInstanceState", "documentation":"

The state of the Reserved Instance purchase.

", "locationName":"state" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance.

", "locationName":"instanceTenancy" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type.

", "locationName":"offeringType" }, "RecurringCharges":{ "shape":"RecurringChargesList", "documentation":"

The recurring charge tag assigned to the resource.

", "locationName":"recurringCharges" }, "OfferingClass":{ "shape":"OfferingClassType", "documentation":"

The offering class of the Reserved Instance.

", "locationName":"offeringClass" }, "Scope":{ "shape":"scope", "documentation":"

The scope of the Reserved Instance.

", "locationName":"scope" } }, "documentation":"

Describes a Reserved Instance.

" }, "ReservedInstancesConfiguration":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the modified Reserved Instances.

", "locationName":"availabilityZone" }, "Platform":{ "shape":"String", "documentation":"

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", "locationName":"platform" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of modified Reserved Instances.

", "locationName":"instanceCount" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type for the modified Reserved Instances.

", "locationName":"instanceType" }, "Scope":{ "shape":"scope", "documentation":"

Whether the Reserved Instance is applied to instances in a region or instances in a specific Availability Zone.

", "locationName":"scope" } }, "documentation":"

Describes the configuration settings for the modified Reserved Instances.

" }, "ReservedInstancesConfigurationList":{ "type":"list", "member":{ "shape":"ReservedInstancesConfiguration", "locationName":"item" } }, "ReservedInstancesId":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" } }, "documentation":"

Describes the ID of a Reserved Instance.

" }, "ReservedInstancesIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstancesId" } }, "ReservedInstancesList":{ "type":"list", "member":{ "shape":"ReservedInstances", "locationName":"item" } }, "ReservedInstancesListing":{ "type":"structure", "members":{ "ReservedInstancesListingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance listing.

", "locationName":"reservedInstancesListingId" }, "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The time the listing was created.

", "locationName":"createDate" }, "UpdateDate":{ "shape":"DateTime", "documentation":"

The last modified timestamp of the listing.

", "locationName":"updateDate" }, "Status":{ "shape":"ListingStatus", "documentation":"

The status of the Reserved Instance listing.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The reason for the current status of the Reserved Instance listing. The response can be blank.

", "locationName":"statusMessage" }, "InstanceCounts":{ "shape":"InstanceCountList", "documentation":"

The number of instances in this state.

", "locationName":"instanceCounts" }, "PriceSchedules":{ "shape":"PriceScheduleList", "documentation":"

The price of the Reserved Instance listing.

", "locationName":"priceSchedules" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Describes a Reserved Instance listing.

" }, "ReservedInstancesListingList":{ "type":"list", "member":{ "shape":"ReservedInstancesListing", "locationName":"item" } }, "ReservedInstancesModification":{ "type":"structure", "members":{ "ReservedInstancesModificationId":{ "shape":"String", "documentation":"

A unique ID for the Reserved Instance modification.

", "locationName":"reservedInstancesModificationId" }, "ReservedInstancesIds":{ "shape":"ReservedIntancesIds", "documentation":"

The IDs of one or more Reserved Instances.

", "locationName":"reservedInstancesSet" }, "ModificationResults":{ "shape":"ReservedInstancesModificationResultList", "documentation":"

Contains target configurations along with their corresponding new Reserved Instance IDs.

", "locationName":"modificationResultSet" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The time when the modification request was created.

", "locationName":"createDate" }, "UpdateDate":{ "shape":"DateTime", "documentation":"

The time when the modification request was last updated.

", "locationName":"updateDate" }, "EffectiveDate":{ "shape":"DateTime", "documentation":"

The time for the modification to become effective.

", "locationName":"effectiveDate" }, "Status":{ "shape":"String", "documentation":"

The status of the Reserved Instances modification request.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The reason for the status.

", "locationName":"statusMessage" }, "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Describes a Reserved Instance modification.

" }, "ReservedInstancesModificationIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstancesModificationId" } }, "ReservedInstancesModificationList":{ "type":"list", "member":{ "shape":"ReservedInstancesModification", "locationName":"item" } }, "ReservedInstancesModificationResult":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", "locationName":"reservedInstancesId" }, "TargetConfiguration":{ "shape":"ReservedInstancesConfiguration", "documentation":"

The target Reserved Instances configurations supplied as part of the modification request.

", "locationName":"targetConfiguration" } }, "documentation":"

Describes the modification request/s.

" }, "ReservedInstancesModificationResultList":{ "type":"list", "member":{ "shape":"ReservedInstancesModificationResult", "locationName":"item" } }, "ReservedInstancesOffering":{ "type":"structure", "members":{ "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.

", "locationName":"reservedInstancesOfferingId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used.

", "locationName":"instanceType" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", "locationName":"availabilityZone" }, "Duration":{ "shape":"Long", "documentation":"

The duration of the Reserved Instance, in seconds.

", "locationName":"duration" }, "UsagePrice":{ "shape":"Float", "documentation":"

The usage price of the Reserved Instance, per hour.

", "locationName":"usagePrice" }, "FixedPrice":{ "shape":"Float", "documentation":"

The purchase price of the Reserved Instance.

", "locationName":"fixedPrice" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance product platform description.

", "locationName":"productDescription" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance.

", "locationName":"instanceTenancy" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type.

", "locationName":"offeringType" }, "RecurringCharges":{ "shape":"RecurringChargesList", "documentation":"

The recurring charge tag assigned to the resource.

", "locationName":"recurringCharges" }, "Marketplace":{ "shape":"Boolean", "documentation":"

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

", "locationName":"marketplace" }, "PricingDetails":{ "shape":"PricingDetailsList", "documentation":"

The pricing details of the Reserved Instance offering.

", "locationName":"pricingDetailsSet" }, "OfferingClass":{ "shape":"OfferingClassType", "documentation":"

If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard, it is not possible to perform an exchange.

", "locationName":"offeringClass" }, "Scope":{ "shape":"scope", "documentation":"

Whether the Reserved Instance is applied to instances in a region or an Availability Zone.

", "locationName":"scope" } }, "documentation":"

Describes a Reserved Instance offering.

" }, "ReservedInstancesOfferingIdStringList":{ "type":"list", "member":{"shape":"String"} }, "ReservedInstancesOfferingList":{ "type":"list", "member":{ "shape":"ReservedInstancesOffering", "locationName":"item" } }, "ReservedIntancesIds":{ "type":"list", "member":{ "shape":"ReservedInstancesId", "locationName":"item" } }, "ResetImageAttributeName":{ "type":"string", "enum":["launchPermission"] }, "ResetImageAttributeRequest":{ "type":"structure", "required":[ "ImageId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"ResetImageAttributeName", "documentation":"

The attribute to reset (currently you can only reset the launch permission attribute).

" } }, "documentation":"

Contains the parameters for ResetImageAttribute.

" }, "ResetInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The attribute to reset.

You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.

", "locationName":"attribute" } }, "documentation":"

Contains the parameters for ResetInstanceAttribute.

" }, "ResetNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SourceDestCheck":{ "shape":"String", "documentation":"

The source/destination checking attribute. Resets the value to true.

", "locationName":"sourceDestCheck" } }, "documentation":"

Contains the parameters for ResetNetworkInterfaceAttribute.

" }, "ResetSnapshotAttributeRequest":{ "type":"structure", "required":[ "SnapshotId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.

" } }, "documentation":"

Contains the parameters for ResetSnapshotAttribute.

" }, "ResourceIdList":{ "type":"list", "member":{"shape":"String"} }, "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" ] }, "ResponseHostIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "ResponseHostIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "RestorableByStringList":{ "type":"list", "member":{"shape":"String"} }, "RestoreAddressToClassicRequest":{ "type":"structure", "required":["PublicIp"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" } }, "documentation":"

Contains the parameters for RestoreAddressToClassic.

" }, "RestoreAddressToClassicResult":{ "type":"structure", "members":{ "Status":{ "shape":"Status", "documentation":"

The move status for the IP address.

", "locationName":"status" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" } }, "documentation":"

Contains the output of RestoreAddressToClassic.

" }, "RevokeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

The name of a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account number for a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", "locationName":"toPort" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.

", "locationName":"cidrIp" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"ipPermissions" } }, "documentation":"

Contains the parameters for RevokeSecurityGroupEgress.

" }, "RevokeSecurityGroupIngressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a security group in a nondefault VPC.

" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" } }, "documentation":"

Contains the parameters for RevokeSecurityGroupIngress.

" }, "Route":{ "type":"structure", "members":{ "DestinationCidrBlock":{ "shape":"String", "documentation":"

The IPv4 CIDR block used for the destination match.

", "locationName":"destinationCidrBlock" }, "DestinationPrefixListId":{ "shape":"String", "documentation":"

The prefix of the AWS service.

", "locationName":"destinationPrefixListId" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of a gateway attached to your VPC.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC.

", "locationName":"instanceId" }, "InstanceOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the instance.

", "locationName":"instanceOwnerId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" }, "NatGatewayId":{ "shape":"String", "documentation":"

The ID of a NAT gateway.

", "locationName":"natGatewayId" }, "State":{ "shape":"RouteState", "documentation":"

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

", "locationName":"state" }, "Origin":{ "shape":"RouteOrigin", "documentation":"

Describes how the route was created.

  • CreateRouteTable - The route was automatically created when the route table was created.

  • CreateRoute - The route was manually added to the route table.

  • EnableVgwRoutePropagation - The route was propagated by route propagation.

", "locationName":"origin" }, "DestinationIpv6CidrBlock":{ "shape":"String", "documentation":"

The IPv6 CIDR block used for the destination match.

", "locationName":"destinationIpv6CidrBlock" }, "EgressOnlyInternetGatewayId":{ "shape":"String", "documentation":"

The ID of the egress-only Internet gateway.

", "locationName":"egressOnlyInternetGatewayId" } }, "documentation":"

Describes a route in a route table.

" }, "RouteList":{ "type":"list", "member":{ "shape":"Route", "locationName":"item" } }, "RouteOrigin":{ "type":"string", "enum":[ "CreateRouteTable", "CreateRoute", "EnableVgwRoutePropagation" ] }, "RouteState":{ "type":"string", "enum":[ "active", "blackhole" ] }, "RouteTable":{ "type":"structure", "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Routes":{ "shape":"RouteList", "documentation":"

The routes in the route table.

", "locationName":"routeSet" }, "Associations":{ "shape":"RouteTableAssociationList", "documentation":"

The associations between the route table and one or more subnets.

", "locationName":"associationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the route table.

", "locationName":"tagSet" }, "PropagatingVgws":{ "shape":"PropagatingVgwList", "documentation":"

Any virtual private gateway (VGW) propagating routes.

", "locationName":"propagatingVgwSet" } }, "documentation":"

Describes a route table.

" }, "RouteTableAssociation":{ "type":"structure", "members":{ "RouteTableAssociationId":{ "shape":"String", "documentation":"

The ID of the association between a route table and a subnet.

", "locationName":"routeTableAssociationId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet. A subnet ID is not returned for an implicit association.

", "locationName":"subnetId" }, "Main":{ "shape":"Boolean", "documentation":"

Indicates whether this is the main route table.

", "locationName":"main" } }, "documentation":"

Describes an association between a route table and a subnet.

" }, "RouteTableAssociationList":{ "type":"list", "member":{ "shape":"RouteTableAssociation", "locationName":"item" } }, "RouteTableList":{ "type":"list", "member":{ "shape":"RouteTable", "locationName":"item" } }, "RuleAction":{ "type":"string", "enum":[ "allow", "deny" ] }, "RunInstancesMonitoringEnabled":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

", "locationName":"enabled" } }, "documentation":"

Describes the monitoring of an instance.

" }, "RunInstancesRequest":{ "type":"structure", "required":[ "ImageId", "MinCount", "MaxCount" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI, which you can get by calling DescribeImages.

" }, "MinCount":{ "shape":"Integer", "documentation":"

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" }, "MaxCount":{ "shape":"Integer", "documentation":"

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.

" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

" }, "SecurityGroups":{ "shape":"SecurityGroupStringList", "documentation":"

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

", "locationName":"SecurityGroup" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdStringList", "documentation":"

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

", "locationName":"SecurityGroupId" }, "UserData":{ "shape":"String", "documentation":"

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

" }, "Placement":{ "shape":"Placement", "documentation":"

The placement for the instance.

" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

The block device mapping.

Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.

", "locationName":"BlockDeviceMapping" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "documentation":"

The monitoring for the instance.

" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

" }, "DisableApiTermination":{ "shape":"Boolean", "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute to false after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

", "locationName":"instanceInitiatedShutdownBehavior" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.

Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.

", "locationName":"privateIpAddress" }, "Ipv6Addresses":{ "shape":"InstanceIpv6AddressList", "documentation":"

[EC2-VPC] Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

", "locationName":"Ipv6Address" }, "Ipv6AddressCount":{ "shape":"Integer", "documentation":"

[EC2-VPC] A number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

", "locationName":"clientToken" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterface" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

", "locationName":"ebsOptimized" } }, "documentation":"

Contains the parameters for RunInstances.

" }, "RunScheduledInstancesRequest":{ "type":"structure", "required":[ "ScheduledInstanceId", "LaunchSpecification" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

", "idempotencyToken":true }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances.

Default: 1

" }, "ScheduledInstanceId":{ "shape":"String", "documentation":"

The Scheduled Instance ID.

" }, "LaunchSpecification":{ "shape":"ScheduledInstancesLaunchSpecification", "documentation":"

The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.

" } }, "documentation":"

Contains the parameters for RunScheduledInstances.

" }, "RunScheduledInstancesResult":{ "type":"structure", "members":{ "InstanceIdSet":{ "shape":"InstanceIdSet", "documentation":"

The IDs of the newly launched instances.

", "locationName":"instanceIdSet" } }, "documentation":"

Contains the output of RunScheduledInstances.

" }, "S3Storage":{ "type":"structure", "members":{ "Bucket":{ "shape":"String", "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

The beginning of the file name of the AMI.

", "locationName":"prefix" }, "AWSAccessKeyId":{ "shape":"String", "documentation":"

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

" }, "UploadPolicy":{ "shape":"Blob", "documentation":"

An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", "locationName":"uploadPolicy" }, "UploadPolicySignature":{ "shape":"String", "documentation":"

The signature of the JSON document.

", "locationName":"uploadPolicySignature" } }, "documentation":"

Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI.

" }, "ScheduledInstance":{ "type":"structure", "members":{ "ScheduledInstanceId":{ "shape":"String", "documentation":"

The Scheduled Instance ID.

", "locationName":"scheduledInstanceId" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Platform":{ "shape":"String", "documentation":"

The platform (Linux/UNIX or Windows).

", "locationName":"platform" }, "NetworkPlatform":{ "shape":"String", "documentation":"

The network platform (EC2-Classic or EC2-VPC).

", "locationName":"networkPlatform" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "SlotDurationInHours":{ "shape":"Integer", "documentation":"

The number of hours in the schedule.

", "locationName":"slotDurationInHours" }, "Recurrence":{ "shape":"ScheduledInstanceRecurrence", "documentation":"

The schedule recurrence.

", "locationName":"recurrence" }, "PreviousSlotEndTime":{ "shape":"DateTime", "documentation":"

The time that the previous schedule ended or will end.

", "locationName":"previousSlotEndTime" }, "NextSlotStartTime":{ "shape":"DateTime", "documentation":"

The time for the next schedule to start.

", "locationName":"nextSlotStartTime" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price for a single instance.

", "locationName":"hourlyPrice" }, "TotalScheduledInstanceHours":{ "shape":"Integer", "documentation":"

The total number of hours for a single instance for the entire term.

", "locationName":"totalScheduledInstanceHours" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances.

", "locationName":"instanceCount" }, "TermStartDate":{ "shape":"DateTime", "documentation":"

The start date for the Scheduled Instance.

", "locationName":"termStartDate" }, "TermEndDate":{ "shape":"DateTime", "documentation":"

The end date for the Scheduled Instance.

", "locationName":"termEndDate" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The date when the Scheduled Instance was purchased.

", "locationName":"createDate" } }, "documentation":"

Describes a Scheduled Instance.

" }, "ScheduledInstanceAvailability":{ "type":"structure", "members":{ "InstanceType":{ "shape":"String", "documentation":"

The instance type. You can specify one of the C3, C4, M4, or R3 instance types.

", "locationName":"instanceType" }, "Platform":{ "shape":"String", "documentation":"

The platform (Linux/UNIX or Windows).

", "locationName":"platform" }, "NetworkPlatform":{ "shape":"String", "documentation":"

The network platform (EC2-Classic or EC2-VPC).

", "locationName":"networkPlatform" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "PurchaseToken":{ "shape":"String", "documentation":"

The purchase token. This token expires in two hours.

", "locationName":"purchaseToken" }, "SlotDurationInHours":{ "shape":"Integer", "documentation":"

The number of hours in the schedule.

", "locationName":"slotDurationInHours" }, "Recurrence":{ "shape":"ScheduledInstanceRecurrence", "documentation":"

The schedule recurrence.

", "locationName":"recurrence" }, "FirstSlotStartTime":{ "shape":"DateTime", "documentation":"

The time period for the first schedule to start.

", "locationName":"firstSlotStartTime" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price for a single instance.

", "locationName":"hourlyPrice" }, "TotalScheduledInstanceHours":{ "shape":"Integer", "documentation":"

The total number of hours for a single instance for the entire term.

", "locationName":"totalScheduledInstanceHours" }, "AvailableInstanceCount":{ "shape":"Integer", "documentation":"

The number of available instances.

", "locationName":"availableInstanceCount" }, "MinTermDurationInDays":{ "shape":"Integer", "documentation":"

The minimum term. The only possible value is 365 days.

", "locationName":"minTermDurationInDays" }, "MaxTermDurationInDays":{ "shape":"Integer", "documentation":"

The maximum term. The only possible value is 365 days.

", "locationName":"maxTermDurationInDays" } }, "documentation":"

Describes a schedule that is available for your Scheduled Instances.

" }, "ScheduledInstanceAvailabilitySet":{ "type":"list", "member":{ "shape":"ScheduledInstanceAvailability", "locationName":"item" } }, "ScheduledInstanceIdRequestSet":{ "type":"list", "member":{ "shape":"String", "locationName":"ScheduledInstanceId" } }, "ScheduledInstanceRecurrence":{ "type":"structure", "members":{ "Frequency":{ "shape":"String", "documentation":"

The frequency (Daily, Weekly, or Monthly).

", "locationName":"frequency" }, "Interval":{ "shape":"Integer", "documentation":"

The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months.

", "locationName":"interval" }, "OccurrenceDaySet":{ "shape":"OccurrenceDaySet", "documentation":"

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).

", "locationName":"occurrenceDaySet" }, "OccurrenceRelativeToEnd":{ "shape":"Boolean", "documentation":"

Indicates whether the occurrence is relative to the end of the specified week or month.

", "locationName":"occurrenceRelativeToEnd" }, "OccurrenceUnit":{ "shape":"String", "documentation":"

The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).

", "locationName":"occurrenceUnit" } }, "documentation":"

Describes the recurring schedule for a Scheduled Instance.

" }, "ScheduledInstanceRecurrenceRequest":{ "type":"structure", "members":{ "Frequency":{ "shape":"String", "documentation":"

The frequency (Daily, Weekly, or Monthly).

" }, "Interval":{ "shape":"Integer", "documentation":"

The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.

" }, "OccurrenceDays":{ "shape":"OccurrenceDayRequestSet", "documentation":"

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.

", "locationName":"OccurrenceDay" }, "OccurrenceRelativeToEnd":{ "shape":"Boolean", "documentation":"

Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.

" }, "OccurrenceUnit":{ "shape":"String", "documentation":"

The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.

" } }, "documentation":"

Describes the recurring schedule for a Scheduled Instance.

" }, "ScheduledInstanceSet":{ "type":"list", "member":{ "shape":"ScheduledInstance", "locationName":"item" } }, "ScheduledInstancesBlockDeviceMapping":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

" }, "NoDevice":{ "shape":"String", "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

" }, "VirtualName":{ "shape":"String", "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

" }, "Ebs":{ "shape":"ScheduledInstancesEbs", "documentation":"

Parameters used to set up EBS volumes automatically when the instance is launched.

" } }, "documentation":"

Describes a block device mapping for a Scheduled Instance.

" }, "ScheduledInstancesBlockDeviceMappingSet":{ "type":"list", "member":{ "shape":"ScheduledInstancesBlockDeviceMapping", "locationName":"BlockDeviceMapping" } }, "ScheduledInstancesEbs":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

" }, "VolumeType":{ "shape":"String", "documentation":"

The volume type. gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for Magnetic.

Default: standard

" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about gp2 baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.

" } }, "documentation":"

Describes an EBS volume for a Scheduled Instance.

" }, "ScheduledInstancesIamInstanceProfile":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN).

" }, "Name":{ "shape":"String", "documentation":"

The name.

" } }, "documentation":"

Describes an IAM instance profile for a Scheduled Instance.

" }, "ScheduledInstancesIpv6Address":{ "type":"structure", "members":{ "Ipv6Address":{ "shape":"Ipv6Address", "documentation":"

The IPv6 address.

" } }, "documentation":"

Describes an IPv6 address.

" }, "ScheduledInstancesIpv6AddressList":{ "type":"list", "member":{ "shape":"ScheduledInstancesIpv6Address", "locationName":"Ipv6Address" } }, "ScheduledInstancesLaunchSpecification":{ "type":"structure", "required":["ImageId"], "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the Amazon Machine Image (AMI).

" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

" }, "SecurityGroupIds":{ "shape":"ScheduledInstancesSecurityGroupIdSet", "documentation":"

The IDs of one or more security groups.

", "locationName":"SecurityGroupId" }, "UserData":{ "shape":"String", "documentation":"

The base64-encoded MIME user data.

" }, "Placement":{ "shape":"ScheduledInstancesPlacement", "documentation":"

The placement information.

" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type.

" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

" }, "BlockDeviceMappings":{ "shape":"ScheduledInstancesBlockDeviceMappingSet", "documentation":"

One or more block device mapping entries.

", "locationName":"BlockDeviceMapping" }, "Monitoring":{ "shape":"ScheduledInstancesMonitoring", "documentation":"

Enable or disable monitoring for the instances.

" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instances.

" }, "NetworkInterfaces":{ "shape":"ScheduledInstancesNetworkInterfaceSet", "documentation":"

One or more network interfaces.

", "locationName":"NetworkInterface" }, "IamInstanceProfile":{ "shape":"ScheduledInstancesIamInstanceProfile", "documentation":"

The IAM instance profile.

" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

" } }, "documentation":"

Describes the launch specification for a Scheduled Instance.

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.

" }, "ScheduledInstancesMonitoring":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Indicates whether monitoring is enabled.

" } }, "documentation":"

Describes whether monitoring is enabled for a Scheduled Instance.

" }, "ScheduledInstancesNetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device for the network interface attachment.

" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

" }, "Description":{ "shape":"String", "documentation":"

The description.

" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IPv4 address of the network interface within the subnet.

" }, "PrivateIpAddressConfigs":{ "shape":"PrivateIpAddressConfigSet", "documentation":"

The private IPv4 addresses.

", "locationName":"PrivateIpAddressConfig" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IPv4 addresses.

" }, "AssociatePublicIpAddress":{ "shape":"Boolean", "documentation":"

Indicates whether to assign a public IPv4 address to instances launched in a VPC. The public IPv4 address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

" }, "Groups":{ "shape":"ScheduledInstancesSecurityGroupIdSet", "documentation":"

The IDs of one or more security groups.

", "locationName":"Group" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether to delete the interface when the instance is terminated.

" }, "Ipv6Addresses":{ "shape":"ScheduledInstancesIpv6AddressList", "documentation":"

One or more specific IPv6 addresses from the subnet range.

", "locationName":"Ipv6Address" }, "Ipv6AddressCount":{ "shape":"Integer", "documentation":"

The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.

" } }, "documentation":"

Describes a network interface for a Scheduled Instance.

" }, "ScheduledInstancesNetworkInterfaceSet":{ "type":"list", "member":{ "shape":"ScheduledInstancesNetworkInterface", "locationName":"NetworkInterface" } }, "ScheduledInstancesPlacement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

" } }, "documentation":"

Describes the placement for a Scheduled Instance.

" }, "ScheduledInstancesPrivateIpAddressConfig":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The IPv4 address.

" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this is a primary IPv4 address. Otherwise, this is a secondary IPv4 address.

" } }, "documentation":"

Describes a private IPv4 address for a Scheduled Instance.

" }, "ScheduledInstancesSecurityGroupIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroupId" } }, "SecurityGroup":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the security group.

", "locationName":"ownerId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "Description":{ "shape":"String", "documentation":"

A description of the security group.

", "locationName":"groupDescription" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

One or more inbound rules associated with the security group.

", "locationName":"ipPermissions" }, "IpPermissionsEgress":{ "shape":"IpPermissionList", "documentation":"

[EC2-VPC] One or more outbound rules associated with the security group.

", "locationName":"ipPermissionsEgress" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC for the security group.

", "locationName":"vpcId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the security group.

", "locationName":"tagSet" } }, "documentation":"

Describes a security group

" }, "SecurityGroupIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroupId" } }, "SecurityGroupList":{ "type":"list", "member":{ "shape":"SecurityGroup", "locationName":"item" } }, "SecurityGroupReference":{ "type":"structure", "required":[ "GroupId", "ReferencingVpcId" ], "members":{ "GroupId":{ "shape":"String", "documentation":"

The ID of your security group.

", "locationName":"groupId" }, "ReferencingVpcId":{ "shape":"String", "documentation":"

The ID of the VPC with the referencing security group.

", "locationName":"referencingVpcId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Describes a VPC with a security group that references your security group.

" }, "SecurityGroupReferences":{ "type":"list", "member":{ "shape":"SecurityGroupReference", "locationName":"item" } }, "SecurityGroupStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroup" } }, "ShutdownBehavior":{ "type":"string", "enum":[ "stop", "terminate" ] }, "SlotDateTimeRangeRequest":{ "type":"structure", "required":[ "EarliestTime", "LatestTime" ], "members":{ "EarliestTime":{ "shape":"DateTime", "documentation":"

The earliest date and time, in UTC, for the Scheduled Instance to start.

" }, "LatestTime":{ "shape":"DateTime", "documentation":"

The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.

" } }, "documentation":"

Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.

" }, "SlotStartTimeRangeRequest":{ "type":"structure", "members":{ "EarliestTime":{ "shape":"DateTime", "documentation":"

The earliest date and time, in UTC, for the Scheduled Instance to start.

" }, "LatestTime":{ "shape":"DateTime", "documentation":"

The latest date and time, in UTC, for the Scheduled Instance to start.

" } }, "documentation":"

Describes the time period for a Scheduled Instance to start its first schedule.

" }, "Snapshot":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

", "locationName":"snapshotId" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

", "locationName":"volumeId" }, "State":{ "shape":"SnapshotState", "documentation":"

The snapshot state.

", "locationName":"status" }, "StateMessage":{ "shape":"String", "documentation":"

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

", "locationName":"statusMessage" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time stamp when the snapshot was initiated.

", "locationName":"startTime" }, "Progress":{ "shape":"String", "documentation":"

The progress of the snapshot, as a percentage.

", "locationName":"progress" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the EBS snapshot owner.

", "locationName":"ownerId" }, "Description":{ "shape":"String", "documentation":"

The description for the snapshot.

", "locationName":"description" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

", "locationName":"volumeSize" }, "OwnerAlias":{ "shape":"String", "documentation":"

Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

", "locationName":"ownerAlias" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the snapshot.

", "locationName":"tagSet" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the snapshot is encrypted.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

", "locationName":"kmsKeyId" }, "DataEncryptionKeyId":{ "shape":"String", "documentation":"

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

", "locationName":"dataEncryptionKeyId" } }, "documentation":"

Describes a snapshot.

" }, "SnapshotAttributeName":{ "type":"string", "enum":[ "productCodes", "createVolumePermission" ] }, "SnapshotDetail":{ "type":"structure", "members":{ "DiskImageSize":{ "shape":"Double", "documentation":"

The size of the disk in the snapshot, in GiB.

", "locationName":"diskImageSize" }, "Description":{ "shape":"String", "documentation":"

A description for the snapshot.

", "locationName":"description" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image from which the snapshot is created.

", "locationName":"format" }, "Url":{ "shape":"String", "documentation":"

The URL used to access the disk image.

", "locationName":"url" }, "UserBucket":{ "shape":"UserBucketDetails", "documentation":"

The S3 bucket for the disk image.

", "locationName":"userBucket" }, "DeviceName":{ "shape":"String", "documentation":"

The block device mapping for the snapshot.

", "locationName":"deviceName" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot ID of the disk being imported.

", "locationName":"snapshotId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of progress for the task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message for the snapshot creation.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status of the snapshot creation.

", "locationName":"status" } }, "documentation":"

Describes the snapshot created from the imported disk.

" }, "SnapshotDetailList":{ "type":"list", "member":{ "shape":"SnapshotDetail", "locationName":"item" } }, "SnapshotDiskContainer":{ "type":"structure", "members":{ "Description":{ "shape":"String", "documentation":"

The description of the disk image being imported.

" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" }, "Url":{ "shape":"String", "documentation":"

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).

" }, "UserBucket":{ "shape":"UserBucket", "documentation":"

The S3 bucket for the disk image.

" } }, "documentation":"

The disk container object for the import snapshot request.

" }, "SnapshotIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SnapshotId" } }, "SnapshotList":{ "type":"list", "member":{ "shape":"Snapshot", "locationName":"item" } }, "SnapshotState":{ "type":"string", "enum":[ "pending", "completed", "error" ] }, "SnapshotTaskDetail":{ "type":"structure", "members":{ "DiskImageSize":{ "shape":"Double", "documentation":"

The size of the disk in the snapshot, in GiB.

", "locationName":"diskImageSize" }, "Description":{ "shape":"String", "documentation":"

The description of the snapshot.

", "locationName":"description" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image from which the snapshot is created.

", "locationName":"format" }, "Url":{ "shape":"String", "documentation":"

The URL of the disk image from which the snapshot is created.

", "locationName":"url" }, "UserBucket":{ "shape":"UserBucketDetails", "documentation":"

The S3 bucket for the disk image.

", "locationName":"userBucket" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot ID of the disk being imported.

", "locationName":"snapshotId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of completion for the import snapshot task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message for the import snapshot task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status for the import snapshot task.

", "locationName":"status" } }, "documentation":"

Details about the import snapshot task.

" }, "SpotDatafeedSubscription":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the account.

", "locationName":"ownerId" }, "Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket where the Spot instance data feed is located.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

The prefix that is prepended to data feed files.

", "locationName":"prefix" }, "State":{ "shape":"DatafeedSubscriptionState", "documentation":"

The state of the Spot instance data feed subscription.

", "locationName":"state" }, "Fault":{ "shape":"SpotInstanceStateFault", "documentation":"

The fault codes for the Spot instance request, if any.

", "locationName":"fault" } }, "documentation":"

Describes the data feed for a Spot instance.

" }, "SpotFleetLaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", "locationName":"groupSet" }, "UserData":{ "shape":"String", "documentation":"

The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. Note that T2 and HS1 instance types are not supported.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" }, "Monitoring":{ "shape":"SpotFleetMonitoring", "documentation":"

Enable or disable monitoring for the instances.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, \"subnet-a61dafcf, subnet-65ea5f08\".

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "WeightedCapacity":{ "shape":"Double", "documentation":"

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).

If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.

", "locationName":"weightedCapacity" }, "SpotPrice":{ "shape":"String", "documentation":"

The bid price per unit hour for the specified instance type. If this value is not specified, the default is the Spot bid price specified for the fleet. To determine the bid price per unit hour, divide the Spot bid price by the value of WeightedCapacity.

", "locationName":"spotPrice" } }, "documentation":"

Describes the launch specification for one or more Spot instances.

" }, "SpotFleetMonitoring":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Enables monitoring for the instance.

Default: false

", "locationName":"enabled" } }, "documentation":"

Describes whether monitoring is enabled.

" }, "SpotFleetRequestConfig":{ "type":"structure", "required":[ "SpotFleetRequestId", "SpotFleetRequestState", "SpotFleetRequestConfig", "CreateTime" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "SpotFleetRequestState":{ "shape":"BatchState", "documentation":"

The state of the Spot fleet request.

", "locationName":"spotFleetRequestState" }, "SpotFleetRequestConfig":{ "shape":"SpotFleetRequestConfigData", "documentation":"

Information about the configuration of the Spot fleet request.

", "locationName":"spotFleetRequestConfig" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The creation date and time of the request.

", "locationName":"createTime" }, "ActivityStatus":{ "shape":"ActivityStatus", "documentation":"

The progress of the Spot fleet request. If there is an error, the status is error. After all bids are placed, the status is pending_fulfillment. If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the fleet is decreased, the status is pending_termination while Spot instances are terminating.

", "locationName":"activityStatus" } }, "documentation":"

Describes a Spot fleet request.

" }, "SpotFleetRequestConfigData":{ "type":"structure", "required":[ "SpotPrice", "TargetCapacity", "IamFleetRole", "LaunchSpecifications" ], "members":{ "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" }, "SpotPrice":{ "shape":"String", "documentation":"

The bid price per unit hour.

", "locationName":"spotPrice" }, "TargetCapacity":{ "shape":"Integer", "documentation":"

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O.

", "locationName":"targetCapacity" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot instance requests are placed or enabled to fulfill the request.

", "locationName":"validUntil" }, "TerminateInstancesWithExpiration":{ "shape":"Boolean", "documentation":"

Indicates whether running Spot instances should be terminated when the Spot fleet request expires.

", "locationName":"terminateInstancesWithExpiration" }, "IamFleetRole":{ "shape":"String", "documentation":"

Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration.

", "locationName":"iamFleetRole" }, "LaunchSpecifications":{ "shape":"LaunchSpecsList", "documentation":"

Information about the launch specifications for the Spot fleet request.

", "locationName":"launchSpecifications" }, "ExcessCapacityTerminationPolicy":{ "shape":"ExcessCapacityTerminationPolicy", "documentation":"

Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.

", "locationName":"excessCapacityTerminationPolicy" }, "AllocationStrategy":{ "shape":"AllocationStrategy", "documentation":"

Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is lowestPrice.

", "locationName":"allocationStrategy" }, "FulfilledCapacity":{ "shape":"Double", "documentation":"

The number of units fulfilled by this request compared to the set target capacity.

", "locationName":"fulfilledCapacity" }, "Type":{ "shape":"FleetType", "documentation":"

The type of request. Indicates whether the fleet will only request the target capacity or also attempt to maintain it. When you request a certain target capacity, the fleet will only place the required bids. It will not attempt to replenish Spot instances if capacity is diminished, nor will it submit bids in alternative Spot pools if capacity is not available. When you want to maintain a certain target capacity, fleet will place the required bids to meet this target capacity. It will also automatically replenish any interrupted instances. Default: maintain.

", "locationName":"type" }, "ReplaceUnhealthyInstances":{ "shape":"Boolean", "documentation":"

Indicates whether Spot fleet should replace unhealthy instances.

", "locationName":"replaceUnhealthyInstances" } }, "documentation":"

Describes the configuration of a Spot fleet request.

" }, "SpotFleetRequestConfigSet":{ "type":"list", "member":{ "shape":"SpotFleetRequestConfig", "locationName":"item" } }, "SpotInstanceRequest":{ "type":"structure", "members":{ "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot instance request.

", "locationName":"spotInstanceRequestId" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum hourly price (bid) for the Spot instance launched to fulfill the request.

", "locationName":"spotPrice" }, "Type":{ "shape":"SpotInstanceType", "documentation":"

The Spot instance request type.

", "locationName":"type" }, "State":{ "shape":"SpotInstanceState", "documentation":"

The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"state" }, "Fault":{ "shape":"SpotInstanceStateFault", "documentation":"

The fault codes for the Spot instance request, if any.

", "locationName":"fault" }, "Status":{ "shape":"SpotInstanceStatus", "documentation":"

The status code and status message describing the Spot instance request.

", "locationName":"status" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.

", "locationName":"validUntil" }, "LaunchGroup":{ "shape":"String", "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

", "locationName":"launchGroup" }, "AvailabilityZoneGroup":{ "shape":"String", "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.

", "locationName":"availabilityZoneGroup" }, "LaunchSpecification":{ "shape":"LaunchSpecification", "documentation":"

Additional information for launching instances.

", "locationName":"launchSpecification" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID, if an instance has been launched to fulfill the Spot instance request.

", "locationName":"instanceId" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The date and time when the Spot instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"createTime" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The product description associated with the Spot instance.

", "locationName":"productDescription" }, "BlockDurationMinutes":{ "shape":"Integer", "documentation":"

The duration for the Spot instance, in minutes.

", "locationName":"blockDurationMinutes" }, "ActualBlockHourlyPrice":{ "shape":"String", "documentation":"

If you specified a duration and your Spot instance request was fulfilled, this is the fixed hourly price in effect for the Spot instance while it runs.

", "locationName":"actualBlockHourlyPrice" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "LaunchedAvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the bid is launched.

", "locationName":"launchedAvailabilityZone" } }, "documentation":"

Describes a Spot instance request.

" }, "SpotInstanceRequestIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"SpotInstanceRequestId" } }, "SpotInstanceRequestList":{ "type":"list", "member":{ "shape":"SpotInstanceRequest", "locationName":"item" } }, "SpotInstanceState":{ "type":"string", "enum":[ "open", "active", "closed", "cancelled", "failed" ] }, "SpotInstanceStateFault":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The reason code for the Spot instance state change.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The message for the Spot instance state change.

", "locationName":"message" } }, "documentation":"

Describes a Spot instance state change.

" }, "SpotInstanceStatus":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The status code. For a list of status codes, see Spot Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"code" }, "UpdateTime":{ "shape":"DateTime", "documentation":"

The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"updateTime" }, "Message":{ "shape":"String", "documentation":"

The description for the status code.

", "locationName":"message" } }, "documentation":"

Describes the status of a Spot instance request.

" }, "SpotInstanceType":{ "type":"string", "enum":[ "one-time", "persistent" ] }, "SpotPlacement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

[Spot fleet only] To specify multiple Availability Zones, separate them using commas; for example, \"us-west-2a, us-west-2b\".

", "locationName":"availabilityZone" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group (for cluster instances).

", "locationName":"groupName" }, "Tenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot instances.

", "locationName":"tenancy" } }, "documentation":"

Describes Spot instance placement.

" }, "SpotPrice":{ "type":"structure", "members":{ "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. Note that T2 and HS1 instance types are not supported.

", "locationName":"instanceType" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

A general description of the AMI.

", "locationName":"productDescription" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum price (bid) that you are willing to pay for a Spot instance.

", "locationName":"spotPrice" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"timestamp" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" } }, "documentation":"

Describes the maximum hourly price (bid) for any Spot instance launched to fulfill the request.

" }, "SpotPriceHistoryList":{ "type":"list", "member":{ "shape":"SpotPrice", "locationName":"item" } }, "StaleIpPermission":{ "type":"structure", "members":{ "FromPort":{ "shape":"Integer", "documentation":"

The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", "locationName":"fromPort" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

", "locationName":"ipProtocol" }, "IpRanges":{ "shape":"IpRanges", "documentation":"

One or more IP ranges. Not applicable for stale security group rules.

", "locationName":"ipRanges" }, "PrefixListIds":{ "shape":"PrefixListIdSet", "documentation":"

One or more prefix list IDs for an AWS service. Not applicable for stale security group rules.

", "locationName":"prefixListIds" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", "locationName":"toPort" }, "UserIdGroupPairs":{ "shape":"UserIdGroupPairSet", "documentation":"

One or more security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.

", "locationName":"groups" } }, "documentation":"

Describes a stale rule in a security group.

" }, "StaleIpPermissionSet":{ "type":"list", "member":{ "shape":"StaleIpPermission", "locationName":"item" } }, "StaleSecurityGroup":{ "type":"structure", "required":["GroupId"], "members":{ "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "Description":{ "shape":"String", "documentation":"

The description of the security group.

", "locationName":"description" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for the security group.

", "locationName":"vpcId" }, "StaleIpPermissions":{ "shape":"StaleIpPermissionSet", "documentation":"

Information about the stale inbound rules in the security group.

", "locationName":"staleIpPermissions" }, "StaleIpPermissionsEgress":{ "shape":"StaleIpPermissionSet", "documentation":"

Information about the stale outbound rules in the security group.

", "locationName":"staleIpPermissionsEgress" } }, "documentation":"

Describes a stale security group (a security group that contains stale rules).

" }, "StaleSecurityGroupSet":{ "type":"list", "member":{ "shape":"StaleSecurityGroup", "locationName":"item" } }, "StartInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for StartInstances.

" }, "StartInstancesResult":{ "type":"structure", "members":{ "StartingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more started instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of StartInstances.

" }, "State":{ "type":"string", "enum":[ "Pending", "Available", "Deleting", "Deleted" ] }, "StateReason":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The reason code for the state change.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The message for the state change.

  • Server.SpotInstanceTermination: A Spot instance was terminated due to an increase in the market price.

  • Server.InternalError: An internal error occurred during instance launch, resulting in termination.

  • Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

  • Client.InternalError: A client error caused the instance to terminate on launch.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your limits.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

", "locationName":"message" } }, "documentation":"

Describes a state change.

" }, "Status":{ "type":"string", "enum":[ "MoveInProgress", "InVpc", "InClassic" ] }, "StatusName":{ "type":"string", "enum":["reachability"] }, "StatusType":{ "type":"string", "enum":[ "passed", "failed", "insufficient-data", "initializing" ] }, "StopInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" }, "Force":{ "shape":"Boolean", "documentation":"

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

", "locationName":"force" } }, "documentation":"

Contains the parameters for StopInstances.

" }, "StopInstancesResult":{ "type":"structure", "members":{ "StoppingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more stopped instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of StopInstances.

" }, "Storage":{ "type":"structure", "members":{ "S3":{ "shape":"S3Storage", "documentation":"

An Amazon S3 storage location.

" } }, "documentation":"

Describes the storage location for an instance store-backed AMI.

" }, "String":{"type":"string"}, "Subnet":{ "type":"structure", "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "State":{ "shape":"SubnetState", "documentation":"

The current state of the subnet.

", "locationName":"state" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC the subnet is in.

", "locationName":"vpcId" }, "CidrBlock":{ "shape":"String", "documentation":"

The IPv4 CIDR block assigned to the subnet.

", "locationName":"cidrBlock" }, "Ipv6CidrBlockAssociationSet":{ "shape":"SubnetIpv6CidrBlockAssociationSet", "documentation":"

Information about the IPv6 CIDR blocks associated with the subnet.

", "locationName":"ipv6CidrBlockAssociationSet" }, "AssignIpv6AddressOnCreation":{ "shape":"Boolean", "documentation":"

Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.

", "locationName":"assignIpv6AddressOnCreation" }, "AvailableIpAddressCount":{ "shape":"Integer", "documentation":"

The number of unused private IPv4 addresses in the subnet. Note that the IPv4 addresses for any stopped instances are considered unavailable.

", "locationName":"availableIpAddressCount" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the subnet.

", "locationName":"availabilityZone" }, "DefaultForAz":{ "shape":"Boolean", "documentation":"

Indicates whether this is the default subnet for the Availability Zone.

", "locationName":"defaultForAz" }, "MapPublicIpOnLaunch":{ "shape":"Boolean", "documentation":"

Indicates whether instances launched in this subnet receive a public IPv4 address.

", "locationName":"mapPublicIpOnLaunch" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the subnet.

", "locationName":"tagSet" } }, "documentation":"

Describes a subnet.

" }, "SubnetCidrBlockState":{ "type":"structure", "members":{ "State":{ "shape":"SubnetCidrBlockStateCode", "documentation":"

The state of a CIDR block.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

A message about the status of the CIDR block, if applicable.

", "locationName":"statusMessage" } }, "documentation":"

Describes the state of a CIDR block.

" }, "SubnetCidrBlockStateCode":{ "type":"string", "enum":[ "associating", "associated", "disassociating", "disassociated", "failing", "failed" ] }, "SubnetIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SubnetId" } }, "SubnetIpv6CidrBlockAssociation":{ "type":"structure", "members":{ "Ipv6CidrBlock":{ "shape":"String", "documentation":"

The IPv6 CIDR block.

", "locationName":"ipv6CidrBlock" }, "Ipv6CidrBlockState":{ "shape":"SubnetCidrBlockState", "documentation":"

Information about the state of the CIDR block.

", "locationName":"ipv6CidrBlockState" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID for the CIDR block.

", "locationName":"associationId" } }, "documentation":"

Describes an IPv6 CIDR block associated with a subnet.

" }, "SubnetIpv6CidrBlockAssociationSet":{ "type":"list", "member":{ "shape":"SubnetIpv6CidrBlockAssociation", "locationName":"item" } }, "SubnetList":{ "type":"list", "member":{ "shape":"Subnet", "locationName":"item" } }, "SubnetState":{ "type":"string", "enum":[ "pending", "available" ] }, "SummaryStatus":{ "type":"string", "enum":[ "ok", "impaired", "insufficient-data", "not-applicable", "initializing" ] }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", "locationName":"value" } }, "documentation":"

Describes a tag.

" }, "TagDescription":{ "type":"structure", "members":{ "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource. For example, ami-1a2b3c4d.

", "locationName":"resourceId" }, "ResourceType":{ "shape":"ResourceType", "documentation":"

The resource type.

", "locationName":"resourceType" }, "Key":{ "shape":"String", "documentation":"

The tag key.

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The tag value.

", "locationName":"value" } }, "documentation":"

Describes a tag.

" }, "TagDescriptionList":{ "type":"list", "member":{ "shape":"TagDescription", "locationName":"item" } }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"item" } }, "TargetConfiguration":{ "type":"structure", "members":{ "OfferingId":{ "shape":"String", "documentation":"

The ID of the Convertible Reserved Instance offering.

", "locationName":"offeringId" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request

", "locationName":"instanceCount" } }, "documentation":"

Information about the Convertible Reserved Instance offering.

" }, "TargetConfigurationRequest":{ "type":"structure", "required":["OfferingId"], "members":{ "OfferingId":{ "shape":"String", "documentation":"

The Convertible Reserved Instance offering ID.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances the Covertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request

" } }, "documentation":"

Details about the target configuration.

" }, "TargetConfigurationRequestSet":{ "type":"list", "member":{ "shape":"TargetConfigurationRequest", "locationName":"TargetConfigurationRequest" } }, "TargetReservationValue":{ "type":"structure", "members":{ "TargetConfiguration":{ "shape":"TargetConfiguration", "documentation":"

The configuration of the Convertible Reserved Instances that make up the exchange.

", "locationName":"targetConfiguration" }, "ReservationValue":{ "shape":"ReservationValue", "documentation":"

The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of the list value, remaining upfront price, and additional upfront cost of the exchange.

", "locationName":"reservationValue" } }, "documentation":"

The total value of the new Convertible Reserved Instances.

" }, "TargetReservationValueSet":{ "type":"list", "member":{ "shape":"TargetReservationValue", "locationName":"item" } }, "TelemetryStatus":{ "type":"string", "enum":[ "UP", "DOWN" ] }, "Tenancy":{ "type":"string", "enum":[ "default", "dedicated", "host" ] }, "TerminateInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.

", "locationName":"InstanceId" } }, "documentation":"

Contains the parameters for TerminateInstances.

" }, "TerminateInstancesResult":{ "type":"structure", "members":{ "TerminatingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more terminated instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of TerminateInstances.

" }, "TrafficType":{ "type":"string", "enum":[ "ACCEPT", "REJECT", "ALL" ] }, "UnassignIpv6AddressesRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "Ipv6Addresses" ], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Ipv6Addresses":{ "shape":"Ipv6AddressList", "documentation":"

The IPv6 addresses to unassign from the network interface.

", "locationName":"ipv6Addresses" } } }, "UnassignIpv6AddressesResult":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "UnassignedIpv6Addresses":{ "shape":"Ipv6AddressList", "documentation":"

The IPv6 addresses that have been unassigned from the network interface.

", "locationName":"unassignedIpv6Addresses" } } }, "UnassignPrivateIpAddressesRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "PrivateIpAddresses" ], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", "documentation":"

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

", "locationName":"privateIpAddress" } }, "documentation":"

Contains the parameters for UnassignPrivateIpAddresses.

" }, "UnmonitorInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } }, "documentation":"

Contains the parameters for UnmonitorInstances.

" }, "UnmonitorInstancesResult":{ "type":"structure", "members":{ "InstanceMonitorings":{ "shape":"InstanceMonitoringList", "documentation":"

The monitoring information.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of UnmonitorInstances.

" }, "UnsuccessfulItem":{ "type":"structure", "required":["Error"], "members":{ "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource.

", "locationName":"resourceId" }, "Error":{ "shape":"UnsuccessfulItemError", "documentation":"

Information about the error.

", "locationName":"error" } }, "documentation":"

Information about items that were not successfully processed in a batch call.

" }, "UnsuccessfulItemError":{ "type":"structure", "required":[ "Code", "Message" ], "members":{ "Code":{ "shape":"String", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The error message accompanying the error code.

", "locationName":"message" } }, "documentation":"

Information about the error that occurred. For more information about errors, see Error Codes.

" }, "UnsuccessfulItemList":{ "type":"list", "member":{ "shape":"UnsuccessfulItem", "locationName":"item" } }, "UnsuccessfulItemSet":{ "type":"list", "member":{ "shape":"UnsuccessfulItem", "locationName":"item" } }, "UserBucket":{ "type":"structure", "members":{ "S3Bucket":{ "shape":"String", "documentation":"

The name of the S3 bucket where the disk image is located.

" }, "S3Key":{ "shape":"String", "documentation":"

The file name of the disk image.

" } }, "documentation":"

Describes the S3 bucket for the disk image.

" }, "UserBucketDetails":{ "type":"structure", "members":{ "S3Bucket":{ "shape":"String", "documentation":"

The S3 bucket from which the disk image was created.

", "locationName":"s3Bucket" }, "S3Key":{ "shape":"String", "documentation":"

The file name of the disk image.

", "locationName":"s3Key" } }, "documentation":"

Describes the S3 bucket for the disk image.

" }, "UserData":{ "type":"structure", "members":{ "Data":{ "shape":"String", "documentation":"

The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"data" } }, "documentation":"

Describes the user data for an instance.

" }, "UserGroupStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"UserGroup" } }, "UserIdGroupPair":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The ID of an AWS account. For a referenced security group in another VPC, the account ID of the referenced security group is returned.

[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.

", "locationName":"userId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for the referenced security group, if applicable.

", "locationName":"vpcId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection, if applicable.

", "locationName":"vpcPeeringConnectionId" }, "PeeringStatus":{ "shape":"String", "documentation":"

The status of a VPC peering connection, if applicable.

", "locationName":"peeringStatus" } }, "documentation":"

Describes a security group and AWS account ID pair.

" }, "UserIdGroupPairList":{ "type":"list", "member":{ "shape":"UserIdGroupPair", "locationName":"item" } }, "UserIdGroupPairSet":{ "type":"list", "member":{ "shape":"UserIdGroupPair", "locationName":"item" } }, "UserIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"UserId" } }, "ValueStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "VgwTelemetry":{ "type":"structure", "members":{ "OutsideIpAddress":{ "shape":"String", "documentation":"

The Internet-routable IP address of the virtual private gateway's outside interface.

", "locationName":"outsideIpAddress" }, "Status":{ "shape":"TelemetryStatus", "documentation":"

The status of the VPN tunnel.

", "locationName":"status" }, "LastStatusChange":{ "shape":"DateTime", "documentation":"

The date and time of the last change in status.

", "locationName":"lastStatusChange" }, "StatusMessage":{ "shape":"String", "documentation":"

If an error occurs, a description of the error.

", "locationName":"statusMessage" }, "AcceptedRouteCount":{ "shape":"Integer", "documentation":"

The number of accepted routes.

", "locationName":"acceptedRouteCount" } }, "documentation":"

Describes telemetry for a VPN tunnel.

" }, "VgwTelemetryList":{ "type":"list", "member":{ "shape":"VgwTelemetry", "locationName":"item" } }, "VirtualizationType":{ "type":"string", "enum":[ "hvm", "paravirtual" ] }, "Volume":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "Size":{ "shape":"Integer", "documentation":"

The size of the volume, in GiBs.

", "locationName":"size" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot from which the volume was created, if applicable.

", "locationName":"snapshotId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the volume.

", "locationName":"availabilityZone" }, "State":{ "shape":"VolumeState", "documentation":"

The volume state.

", "locationName":"status" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The time stamp when volume creation was initiated.

", "locationName":"createTime" }, "Attachments":{ "shape":"VolumeAttachmentList", "documentation":"

Information about the volume attachments.

", "locationName":"attachmentSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the volume.

", "locationName":"tagSet" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

", "locationName":"volumeType" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", "locationName":"iops" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the volume will be encrypted.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

", "locationName":"kmsKeyId" } }, "documentation":"

Describes a volume.

" }, "VolumeAttachment":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Device":{ "shape":"String", "documentation":"

The device name.

", "locationName":"device" }, "State":{ "shape":"VolumeAttachmentState", "documentation":"

The attachment state of the volume.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes volume attachment details.

" }, "VolumeAttachmentList":{ "type":"list", "member":{ "shape":"VolumeAttachment", "locationName":"item" } }, "VolumeAttachmentState":{ "type":"string", "enum":[ "attaching", "attached", "detaching", "detached" ] }, "VolumeAttributeName":{ "type":"string", "enum":[ "autoEnableIO", "productCodes" ] }, "VolumeDetail":{ "type":"structure", "required":["Size"], "members":{ "Size":{ "shape":"Long", "documentation":"

The size of the volume, in GiB.

", "locationName":"size" } }, "documentation":"

Describes an EBS volume.

" }, "VolumeIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VolumeId" } }, "VolumeList":{ "type":"list", "member":{ "shape":"Volume", "locationName":"item" } }, "VolumeState":{ "type":"string", "enum":[ "creating", "available", "in-use", "deleting", "deleted", "error" ] }, "VolumeStatusAction":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The code identifying the operation, for example, enable-volume-io.

", "locationName":"code" }, "Description":{ "shape":"String", "documentation":"

A description of the operation.

", "locationName":"description" }, "EventType":{ "shape":"String", "documentation":"

The event type associated with this operation.

", "locationName":"eventType" }, "EventId":{ "shape":"String", "documentation":"

The ID of the event associated with this operation.

", "locationName":"eventId" } }, "documentation":"

Describes a volume status operation code.

" }, "VolumeStatusActionsList":{ "type":"list", "member":{ "shape":"VolumeStatusAction", "locationName":"item" } }, "VolumeStatusDetails":{ "type":"structure", "members":{ "Name":{ "shape":"VolumeStatusName", "documentation":"

The name of the volume status.

", "locationName":"name" }, "Status":{ "shape":"String", "documentation":"

The intended status of the volume status.

", "locationName":"status" } }, "documentation":"

Describes a volume status.

" }, "VolumeStatusDetailsList":{ "type":"list", "member":{ "shape":"VolumeStatusDetails", "locationName":"item" } }, "VolumeStatusEvent":{ "type":"structure", "members":{ "EventType":{ "shape":"String", "documentation":"

The type of this event.

", "locationName":"eventType" }, "Description":{ "shape":"String", "documentation":"

A description of the event.

", "locationName":"description" }, "NotBefore":{ "shape":"DateTime", "documentation":"

The earliest start time of the event.

", "locationName":"notBefore" }, "NotAfter":{ "shape":"DateTime", "documentation":"

The latest end time of the event.

", "locationName":"notAfter" }, "EventId":{ "shape":"String", "documentation":"

The ID of this event.

", "locationName":"eventId" } }, "documentation":"

Describes a volume status event.

" }, "VolumeStatusEventsList":{ "type":"list", "member":{ "shape":"VolumeStatusEvent", "locationName":"item" } }, "VolumeStatusInfo":{ "type":"structure", "members":{ "Status":{ "shape":"VolumeStatusInfoStatus", "documentation":"

The status of the volume.

", "locationName":"status" }, "Details":{ "shape":"VolumeStatusDetailsList", "documentation":"

The details of the volume status.

", "locationName":"details" } }, "documentation":"

Describes the status of a volume.

" }, "VolumeStatusInfoStatus":{ "type":"string", "enum":[ "ok", "impaired", "insufficient-data" ] }, "VolumeStatusItem":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

", "locationName":"volumeId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the volume.

", "locationName":"availabilityZone" }, "VolumeStatus":{ "shape":"VolumeStatusInfo", "documentation":"

The volume status.

", "locationName":"volumeStatus" }, "Events":{ "shape":"VolumeStatusEventsList", "documentation":"

A list of events associated with the volume.

", "locationName":"eventsSet" }, "Actions":{ "shape":"VolumeStatusActionsList", "documentation":"

The details of the operation.

", "locationName":"actionsSet" } }, "documentation":"

Describes the volume status.

" }, "VolumeStatusList":{ "type":"list", "member":{ "shape":"VolumeStatusItem", "locationName":"item" } }, "VolumeStatusName":{ "type":"string", "enum":[ "io-enabled", "io-performance" ] }, "VolumeType":{ "type":"string", "enum":[ "standard", "io1", "gp2", "sc1", "st1" ] }, "Vpc":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"VpcState", "documentation":"

The current state of the VPC.

", "locationName":"state" }, "CidrBlock":{ "shape":"String", "documentation":"

The IPv4 CIDR block for the VPC.

", "locationName":"cidrBlock" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

", "locationName":"dhcpOptionsId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPC.

", "locationName":"tagSet" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The allowed tenancy of instances launched into the VPC.

", "locationName":"instanceTenancy" }, "IsDefault":{ "shape":"Boolean", "documentation":"

Indicates whether the VPC is the default VPC.

", "locationName":"isDefault" }, "Ipv6CidrBlockAssociationSet":{ "shape":"VpcIpv6CidrBlockAssociationSet", "documentation":"

Information about the IPv6 CIDR blocks associated with the VPC.

", "locationName":"ipv6CidrBlockAssociationSet" } }, "documentation":"

Describes a VPC.

" }, "VpcAttachment":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"AttachmentStatus", "documentation":"

The current state of the attachment.

", "locationName":"state" } }, "documentation":"

Describes an attachment between a virtual private gateway and a VPC.

" }, "VpcAttachmentList":{ "type":"list", "member":{ "shape":"VpcAttachment", "locationName":"item" } }, "VpcAttributeName":{ "type":"string", "enum":[ "enableDnsSupport", "enableDnsHostnames" ] }, "VpcCidrBlockState":{ "type":"structure", "members":{ "State":{ "shape":"VpcCidrBlockStateCode", "documentation":"

The state of the CIDR block.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

A message about the status of the CIDR block, if applicable.

", "locationName":"statusMessage" } }, "documentation":"

Describes the state of a CIDR block.

" }, "VpcCidrBlockStateCode":{ "type":"string", "enum":[ "associating", "associated", "disassociating", "disassociated", "failing", "failed" ] }, "VpcClassicLink":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "ClassicLinkEnabled":{ "shape":"Boolean", "documentation":"

Indicates whether the VPC is enabled for ClassicLink.

", "locationName":"classicLinkEnabled" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPC.

", "locationName":"tagSet" } }, "documentation":"

Describes whether a VPC is enabled for ClassicLink.

" }, "VpcClassicLinkIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcId" } }, "VpcClassicLinkList":{ "type":"list", "member":{ "shape":"VpcClassicLink", "locationName":"item" } }, "VpcEndpoint":{ "type":"structure", "members":{ "VpcEndpointId":{ "shape":"String", "documentation":"

The ID of the VPC endpoint.

", "locationName":"vpcEndpointId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC to which the endpoint is associated.

", "locationName":"vpcId" }, "ServiceName":{ "shape":"String", "documentation":"

The name of the AWS service to which the endpoint is associated.

", "locationName":"serviceName" }, "State":{ "shape":"State", "documentation":"

The state of the VPC endpoint.

", "locationName":"state" }, "PolicyDocument":{ "shape":"String", "documentation":"

The policy document associated with the endpoint.

", "locationName":"policyDocument" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route tables associated with the endpoint.

", "locationName":"routeTableIdSet" }, "CreationTimestamp":{ "shape":"DateTime", "documentation":"

The date and time the VPC endpoint was created.

", "locationName":"creationTimestamp" } }, "documentation":"

Describes a VPC endpoint.

" }, "VpcEndpointSet":{ "type":"list", "member":{ "shape":"VpcEndpoint", "locationName":"item" } }, "VpcIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcId" } }, "VpcIpv6CidrBlockAssociation":{ "type":"structure", "members":{ "Ipv6CidrBlock":{ "shape":"String", "documentation":"

The IPv6 CIDR block.

", "locationName":"ipv6CidrBlock" }, "Ipv6CidrBlockState":{ "shape":"VpcCidrBlockState", "documentation":"

Information about the state of the CIDR block.

", "locationName":"ipv6CidrBlockState" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID for the IPv6 CIDR block.

", "locationName":"associationId" } }, "documentation":"

Describes an IPv6 CIDR block associated with a VPC.

" }, "VpcIpv6CidrBlockAssociationSet":{ "type":"list", "member":{ "shape":"VpcIpv6CidrBlockAssociation", "locationName":"item" } }, "VpcList":{ "type":"list", "member":{ "shape":"Vpc", "locationName":"item" } }, "VpcPeeringConnection":{ "type":"structure", "members":{ "AccepterVpcInfo":{ "shape":"VpcPeeringConnectionVpcInfo", "documentation":"

Information about the accepter VPC. CIDR block information is not returned when creating a VPC peering connection, or when describing a VPC peering connection that's in the initiating-request or pending-acceptance state.

", "locationName":"accepterVpcInfo" }, "ExpirationTime":{ "shape":"DateTime", "documentation":"

The time that an unaccepted VPC peering connection will expire.

", "locationName":"expirationTime" }, "RequesterVpcInfo":{ "shape":"VpcPeeringConnectionVpcInfo", "documentation":"

Information about the requester VPC.

", "locationName":"requesterVpcInfo" }, "Status":{ "shape":"VpcPeeringConnectionStateReason", "documentation":"

The status of the VPC peering connection.

", "locationName":"status" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Describes a VPC peering connection.

" }, "VpcPeeringConnectionList":{ "type":"list", "member":{ "shape":"VpcPeeringConnection", "locationName":"item" } }, "VpcPeeringConnectionOptionsDescription":{ "type":"structure", "members":{ "AllowEgressFromLocalClassicLinkToRemoteVpc":{ "shape":"Boolean", "documentation":"

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

", "locationName":"allowEgressFromLocalClassicLinkToRemoteVpc" }, "AllowEgressFromLocalVpcToRemoteClassicLink":{ "shape":"Boolean", "documentation":"

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.

", "locationName":"allowEgressFromLocalVpcToRemoteClassicLink" }, "AllowDnsResolutionFromRemoteVpc":{ "shape":"Boolean", "documentation":"

Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.

", "locationName":"allowDnsResolutionFromRemoteVpc" } }, "documentation":"

Describes the VPC peering connection options.

" }, "VpcPeeringConnectionStateReason":{ "type":"structure", "members":{ "Code":{ "shape":"VpcPeeringConnectionStateReasonCode", "documentation":"

The status of the VPC peering connection.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

A message that provides more information about the status, if applicable.

", "locationName":"message" } }, "documentation":"

Describes the status of a VPC peering connection.

" }, "VpcPeeringConnectionStateReasonCode":{ "type":"string", "enum":[ "initiating-request", "pending-acceptance", "active", "deleted", "rejected", "failed", "expired", "provisioning", "deleting" ] }, "VpcPeeringConnectionVpcInfo":{ "type":"structure", "members":{ "CidrBlock":{ "shape":"String", "documentation":"

The IPv4 CIDR block for the VPC.

", "locationName":"cidrBlock" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the VPC owner.

", "locationName":"ownerId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Ipv6CidrBlockSet":{ "shape":"Ipv6CidrBlockSet", "documentation":"

The IPv6 CIDR block for the VPC.

", "locationName":"ipv6CidrBlockSet" }, "PeeringOptions":{ "shape":"VpcPeeringConnectionOptionsDescription", "documentation":"

Information about the VPC peering connection options for the accepter or requester VPC.

", "locationName":"peeringOptions" } }, "documentation":"

Describes a VPC in a VPC peering connection.

" }, "VpcState":{ "type":"string", "enum":[ "pending", "available" ] }, "VpnConnection":{ "type":"structure", "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

", "locationName":"vpnConnectionId" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the VPN connection.

", "locationName":"state" }, "CustomerGatewayConfiguration":{ "shape":"String", "documentation":"

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

", "locationName":"customerGatewayConfiguration" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection.

", "locationName":"type" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway at your end of the VPN connection.

", "locationName":"customerGatewayId" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

", "locationName":"vpnGatewayId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPN connection.

", "locationName":"tagSet" }, "VgwTelemetry":{ "shape":"VgwTelemetryList", "documentation":"

Information about the VPN tunnel.

", "locationName":"vgwTelemetry" }, "Options":{ "shape":"VpnConnectionOptions", "documentation":"

The VPN connection options.

", "locationName":"options" }, "Routes":{ "shape":"VpnStaticRouteList", "documentation":"

The static routes associated with the VPN connection.

", "locationName":"routes" } }, "documentation":"

Describes a VPN connection.

" }, "VpnConnectionIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpnConnectionId" } }, "VpnConnectionList":{ "type":"list", "member":{ "shape":"VpnConnection", "locationName":"item" } }, "VpnConnectionOptions":{ "type":"structure", "members":{ "StaticRoutesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "locationName":"staticRoutesOnly" } }, "documentation":"

Describes VPN connection options.

" }, "VpnConnectionOptionsSpecification":{ "type":"structure", "members":{ "StaticRoutesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "locationName":"staticRoutesOnly" } }, "documentation":"

Describes VPN connection options.

" }, "VpnGateway":{ "type":"structure", "members":{ "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

", "locationName":"vpnGatewayId" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the virtual private gateway.

", "locationName":"state" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection the virtual private gateway supports.

", "locationName":"type" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

", "locationName":"availabilityZone" }, "VpcAttachments":{ "shape":"VpcAttachmentList", "documentation":"

Any VPCs attached to the virtual private gateway.

", "locationName":"attachments" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the virtual private gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes a virtual private gateway.

" }, "VpnGatewayIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpnGatewayId" } }, "VpnGatewayList":{ "type":"list", "member":{ "shape":"VpnGateway", "locationName":"item" } }, "VpnState":{ "type":"string", "enum":[ "pending", "available", "deleting", "deleted" ] }, "VpnStaticRoute":{ "type":"structure", "members":{ "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer data center.

", "locationName":"destinationCidrBlock" }, "Source":{ "shape":"VpnStaticRouteSource", "documentation":"

Indicates how the routes were provided.

", "locationName":"source" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the static route.

", "locationName":"state" } }, "documentation":"

Describes a static route for a VPN connection.

" }, "VpnStaticRouteList":{ "type":"list", "member":{ "shape":"VpnStaticRoute", "locationName":"item" } }, "VpnStaticRouteSource":{ "type":"string", "enum":["Static"] }, "ZoneNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ZoneName" } }, "scope":{ "type":"string", "enum":[ "Availability Zone", "Region" ] } }, "documentation":"Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.

" } botocore-1.5.7/botocore/data/ec2/2015-10-01/0000777454262600001440000000000013042511307020627 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ec2/2015-10-01/waiters-2.json0000666454262600001440000003474713042511306023355 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "InstanceExists": { "delay": 5, "maxAttempts": 40, "operation": "DescribeInstances", "acceptors": [ { "matcher": "path", "expected": true, "argument": "length(Reservations[]) > `0`", "state": "success" }, { "matcher": "error", "expected": "InvalidInstanceID.NotFound", "state": "retry" } ] }, "BundleTaskComplete": { "delay": 15, "operation": "DescribeBundleTasks", "maxAttempts": 40, "acceptors": [ { "expected": "complete", "matcher": "pathAll", "state": "success", "argument": "BundleTasks[].State" }, { "expected": "failed", "matcher": "pathAny", "state": "failure", "argument": "BundleTasks[].State" } ] }, "ConsoleOutputAvailable": { "operation": "GetConsoleOutput", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "path", "argument": "length(Output || '') > `0`", "expected": true } ] }, "ConversionTaskCancelled": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "cancelled", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" } ] }, "ConversionTaskCompleted": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" }, { "expected": "cancelled", "matcher": "pathAny", "state": "failure", "argument": "ConversionTasks[].State" }, { "expected": "cancelling", "matcher": "pathAny", "state": "failure", "argument": "ConversionTasks[].State" } ] }, "ConversionTaskDeleted": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" } ] }, "CustomerGatewayAvailable": { "delay": 15, "operation": "DescribeCustomerGateways", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "CustomerGateways[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "CustomerGateways[].State" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "CustomerGateways[].State" } ] }, "ExportTaskCancelled": { "delay": 15, "operation": "DescribeExportTasks", "maxAttempts": 40, "acceptors": [ { "expected": "cancelled", "matcher": "pathAll", "state": "success", "argument": "ExportTasks[].State" } ] }, "ExportTaskCompleted": { "delay": 15, "operation": "DescribeExportTasks", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "ExportTasks[].State" } ] }, "ImageExists": { "operation": "DescribeImages", "maxAttempts": 40, "delay": 15, "acceptors": [ { "matcher": "path", "expected": true, "argument": "length(Images[]) > `0`", "state": "success" }, { "matcher": "error", "expected": "InvalidAMIID.NotFound", "state": "retry" } ] }, "ImageAvailable": { "operation": "DescribeImages", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "Images[].State", "expected": "available" }, { "state": "failure", "matcher": "pathAny", "argument": "Images[].State", "expected": "failed" } ] }, "InstanceRunning": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "running", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "shutting-down", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "matcher": "error", "expected": "InvalidInstanceID.NotFound", "state": "retry" } ] }, "InstanceStatusOk": { "operation": "DescribeInstanceStatus", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "InstanceStatuses[].InstanceStatus.Status", "expected": "ok" }, { "matcher": "error", "expected": "InvalidInstanceID.NotFound", "state": "retry" } ] }, "InstanceStopped": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "stopped", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "InstanceTerminated": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "terminated", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "KeyPairExists": { "operation": "DescribeKeyPairs", "delay": 5, "maxAttempts": 6, "acceptors": [ { "expected": true, "matcher": "pathAll", "state": "success", "argument": "length(KeyPairs[].KeyName) > `0`" }, { "expected": "InvalidKeyPair.NotFound", "matcher": "error", "state": "retry" } ] }, "NatGatewayAvailable": { "operation": "DescribeNatGateways", "delay": 15, "maxAttempts": 40, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "NatGateways[].State", "expected": "available" }, { "state": "failure", "matcher": "pathAny", "argument": "NatGateways[].State", "expected": "failed" }, { "state": "failure", "matcher": "pathAny", "argument": "NatGateways[].State", "expected": "deleting" }, { "state": "failure", "matcher": "pathAny", "argument": "NatGateways[].State", "expected": "deleted" }, { "state": "retry", "matcher": "error", "expected": "NatGatewayNotFound" } ] }, "NetworkInterfaceAvailable": { "operation": "DescribeNetworkInterfaces", "delay": 20, "maxAttempts": 10, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "NetworkInterfaces[].Status" }, { "expected": "InvalidNetworkInterfaceID.NotFound", "matcher": "error", "state": "failure" } ] }, "PasswordDataAvailable": { "operation": "GetPasswordData", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "path", "argument": "length(PasswordData) > `0`", "expected": true } ] }, "SnapshotCompleted": { "delay": 15, "operation": "DescribeSnapshots", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "Snapshots[].State" } ] }, "SpotInstanceRequestFulfilled": { "operation": "DescribeSpotInstanceRequests", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "SpotInstanceRequests[].Status.Code", "expected": "fulfilled" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "schedule-expired" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "canceled-before-fulfillment" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "bad-parameters" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "system-error" } ] }, "SubnetAvailable": { "delay": 15, "operation": "DescribeSubnets", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Subnets[].State" } ] }, "SystemStatusOk": { "operation": "DescribeInstanceStatus", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "InstanceStatuses[].SystemStatus.Status", "expected": "ok" } ] }, "VolumeAvailable": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Volumes[].State" } ] }, "VolumeDeleted": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "matcher": "error", "expected": "InvalidVolume.NotFound", "state": "success" } ] }, "VolumeInUse": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "in-use", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Volumes[].State" } ] }, "VpcAvailable": { "delay": 15, "operation": "DescribeVpcs", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Vpcs[].State" } ] }, "VpnConnectionAvailable": { "delay": 60, "operation": "DescribeVpnConnections", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "VpnConnections[].State" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" } ] }, "VpnConnectionDeleted": { "delay": 15, "operation": "DescribeVpnConnections", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "VpnConnections[].State" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" } ] }, "VpcPeeringConnectionExists": { "delay": 15, "operation": "DescribeVpcPeeringConnections", "maxAttempts": 40, "acceptors": [ { "matcher": "status", "expected": 200, "state": "success" }, { "matcher": "error", "expected": "InvalidVpcPeeringConnectionID.NotFound", "state": "retry" } ] } } } botocore-1.5.7/botocore/data/ec2/2015-10-01/paginators-1.json0000666454262600001440000000340113042511306024024 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeInstanceStatus": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "InstanceStatuses" }, "DescribeInstances": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Reservations" }, "DescribeReservedInstancesOfferings": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "ReservedInstancesOfferings" }, "DescribeReservedInstancesModifications": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "ReservedInstancesModifications" }, "DescribeSnapshots": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Snapshots" }, "DescribeSpotFleetRequests": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "SpotFleetRequestConfigs" }, "DescribeSpotPriceHistory": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "SpotPriceHistory" }, "DescribeTags": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Tags" }, "DescribeVolumeStatus": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "VolumeStatuses" }, "DescribeVolumes": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Volumes" } } } botocore-1.5.7/botocore/data/ec2/2015-10-01/service-2.json0000666454262600001440000316632113042511306023334 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-10-01", "endpointPrefix":"ec2", "protocol":"ec2", "serviceAbbreviation":"Amazon EC2", "serviceFullName":"Amazon Elastic Compute Cloud", "signatureVersion":"v4", "xmlNamespace":"http://ec2.amazonaws.com/doc/2015-10-01" }, "operations":{ "AcceptVpcPeeringConnection":{ "name":"AcceptVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, "output":{"shape":"AcceptVpcPeeringConnectionResult"}, "documentation":"

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.

" }, "AllocateAddress":{ "name":"AllocateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AllocateAddressRequest"}, "output":{"shape":"AllocateAddressResult"}, "documentation":"

Acquires an Elastic IP address.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" }, "AllocateHosts":{ "name":"AllocateHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AllocateHostsRequest"}, "output":{"shape":"AllocateHostsResult"}, "documentation":"

Allocates a Dedicated host to your account. At minimum you need to specify the instance size type, Availability Zone, and quantity of hosts you want to allocate.

" }, "AssignPrivateIpAddresses":{ "name":"AssignPrivateIpAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssignPrivateIpAddressesRequest"}, "documentation":"

Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

AssignPrivateIpAddresses is available only in EC2-VPC.

" }, "AssociateAddress":{ "name":"AssociateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateAddressRequest"}, "output":{"shape":"AssociateAddressResult"}, "documentation":"

Associates an Elastic IP address with an instance or a network interface.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" }, "AssociateDhcpOptions":{ "name":"AssociateDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateDhcpOptionsRequest"}, "documentation":"

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "AssociateRouteTable":{ "name":"AssociateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateRouteTableRequest"}, "output":{"shape":"AssociateRouteTableResult"}, "documentation":"

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "AttachClassicLinkVpc":{ "name":"AttachClassicLinkVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachClassicLinkVpcRequest"}, "output":{"shape":"AttachClassicLinkVpcResult"}, "documentation":"

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" }, "AttachInternetGateway":{ "name":"AttachInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachInternetGatewayRequest"}, "documentation":"

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" }, "AttachNetworkInterface":{ "name":"AttachNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachNetworkInterfaceRequest"}, "output":{"shape":"AttachNetworkInterfaceResult"}, "documentation":"

Attaches a network interface to an instance.

" }, "AttachVolume":{ "name":"AttachVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachVolumeRequest"}, "output":{"shape":"VolumeAttachment"}, "documentation":"

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For a list of supported device names, see Attaching an EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.

  • AWS Marketplace product codes are copied from the volume to the instance.

  • You must be subscribed to the product.

  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For an overview of the AWS Marketplace, see Introducing AWS Marketplace.

For more information about EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "AttachVpnGateway":{ "name":"AttachVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachVpnGatewayRequest"}, "output":{"shape":"AttachVpnGatewayResult"}, "documentation":"

Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "AuthorizeSecurityGroupEgress":{ "name":"AuthorizeSecurityGroupEgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, "documentation":"

[EC2-VPC only] Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

You can have up to 50 rules per security group (covering both ingress and egress rules).

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

" }, "AuthorizeSecurityGroupIngress":{ "name":"AuthorizeSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, "documentation":"

Adds one or more ingress rules to a security group.

EC2-Classic: You can have up to 100 rules per group.

EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.

[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.

" }, "BundleInstance":{ "name":"BundleInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BundleInstanceRequest"}, "output":{"shape":"BundleInstanceResult"}, "documentation":"

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

For more information, see Creating an Instance Store-Backed Windows AMI.

" }, "CancelBundleTask":{ "name":"CancelBundleTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelBundleTaskRequest"}, "output":{"shape":"CancelBundleTaskResult"}, "documentation":"

Cancels a bundling operation for an instance store-backed Windows instance.

" }, "CancelConversionTask":{ "name":"CancelConversionTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelConversionRequest"}, "documentation":"

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" }, "CancelExportTask":{ "name":"CancelExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelExportTaskRequest"}, "documentation":"

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" }, "CancelImportTask":{ "name":"CancelImportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelImportTaskRequest"}, "output":{"shape":"CancelImportTaskResult"}, "documentation":"

Cancels an in-process import virtual machine or import snapshot task.

" }, "CancelReservedInstancesListing":{ "name":"CancelReservedInstancesListing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelReservedInstancesListingRequest"}, "output":{"shape":"CancelReservedInstancesListingResult"}, "documentation":"

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "CancelSpotFleetRequests":{ "name":"CancelSpotFleetRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelSpotFleetRequestsRequest"}, "output":{"shape":"CancelSpotFleetRequestsResponse"}, "documentation":"

Cancels the specified Spot fleet requests.

After you cancel a Spot fleet request, the Spot fleet launches no new Spot instances. You must specify whether the Spot fleet should also terminate its Spot instances. If you terminate the instances, the Spot fleet request enters the cancelled_terminating state. Otherwise, the Spot fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.

" }, "CancelSpotInstanceRequests":{ "name":"CancelSpotInstanceRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelSpotInstanceRequestsRequest"}, "output":{"shape":"CancelSpotInstanceRequestsResult"}, "documentation":"

Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

Canceling a Spot instance request does not terminate running Spot instances associated with the request.

" }, "ConfirmProductInstance":{ "name":"ConfirmProductInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmProductInstanceRequest"}, "output":{"shape":"ConfirmProductInstanceResult"}, "documentation":"

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.

" }, "CopyImage":{ "name":"CopyImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyImageRequest"}, "output":{"shape":"CopyImageResult"}, "documentation":"

Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide.

" }, "CopySnapshot":{ "name":"CopySnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopySnapshotRequest"}, "output":{"shape":"CopySnapshotResult"}, "documentation":"

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the KmsKeyId parameter.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateCustomerGateway":{ "name":"CreateCustomerGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCustomerGatewayRequest"}, "output":{"shape":"CreateCustomerGatewayResult"}, "documentation":"

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.

" }, "CreateDhcpOptions":{ "name":"CreateDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDhcpOptionsRequest"}, "output":{"shape":"CreateDhcpOptionsResult"}, "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.

  • domain-name - If you're using AmazonProvidedDNS in \"us-east-1\", specify \"ec2.internal\". If you're using AmazonProvidedDNS in another region, specify \"region.compute.internal\" (for example, \"ap-northeast-1.compute.internal\"). Otherwise, specify a domain name (for example, \"MyCompany.com\"). Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.

  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.

  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.

  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateFlowLogs":{ "name":"CreateFlowLogs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateFlowLogsRequest"}, "output":{"shape":"CreateFlowLogsResult"}, "documentation":"

Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs.

In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs.

" }, "CreateImage":{ "name":"CreateImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateImageRequest"}, "output":{"shape":"CreateImageResult"}, "documentation":"

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateInstanceExportTask":{ "name":"CreateInstanceExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInstanceExportTaskRequest"}, "output":{"shape":"CreateInstanceExportTaskResult"}, "documentation":"

Exports a running or stopped instance to an S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting EC2 Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateInternetGateway":{ "name":"CreateInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInternetGatewayRequest"}, "output":{"shape":"CreateInternetGatewayResult"}, "documentation":"

Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" }, "CreateKeyPair":{ "name":"CreateKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateKeyPairRequest"}, "output":{"shape":"KeyPair"}, "documentation":"

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateNatGateway":{ "name":"CreateNatGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNatGatewayRequest"}, "output":{"shape":"CreateNatGatewayResult"}, "documentation":"

Creates a NAT gateway in the specified subnet. A NAT gateway can be used to enable instances in a private subnet to connect to the Internet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkAcl":{ "name":"CreateNetworkAcl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkAclRequest"}, "output":{"shape":"CreateNetworkAclResult"}, "documentation":"

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkAclEntry":{ "name":"CreateNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkAclEntryRequest"}, "documentation":"

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkInterface":{ "name":"CreateNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkInterfaceRequest"}, "output":{"shape":"CreateNetworkInterfaceResult"}, "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide.

" }, "CreatePlacementGroup":{ "name":"CreatePlacementGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlacementGroupRequest"}, "documentation":"

Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.

For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateReservedInstancesListing":{ "name":"CreateReservedInstancesListing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateReservedInstancesListingRequest"}, "output":{"shape":"CreateReservedInstancesListingResult"}, "documentation":"

Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the DescribeReservedInstances operation.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateRoute":{ "name":"CreateRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRouteRequest"}, "output":{"shape":"CreateRouteResult"}, "documentation":"

Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, or network interface.

When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "CreateRouteTable":{ "name":"CreateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRouteTableRequest"}, "output":{"shape":"CreateRouteTableResult"}, "documentation":"

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "CreateSecurityGroup":{ "name":"CreateSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSecurityGroupRequest"}, "output":{"shape":"CreateSecurityGroupResult"}, "documentation":"

Creates a security group.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

EC2-Classic: You can have up to 500 security groups.

EC2-VPC: You can create up to 500 security groups per VPC.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

" }, "CreateSnapshot":{ "name":"CreateSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSnapshotRequest"}, "output":{"shape":"Snapshot"}, "documentation":"

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateSpotDatafeedSubscription":{ "name":"CreateSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, "documentation":"

Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateSubnet":{ "name":"CreateSubnet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSubnetRequest"}, "output":{"shape":"CreateSubnetResult"}, "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).

AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateTags":{ "name":"CreateTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTagsRequest"}, "documentation":"

Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateVolume":{ "name":"CreateVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVolumeRequest"}, "output":{"shape":"Volume"}, "documentation":"

Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateVpc":{ "name":"CreateVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcRequest"}, "output":{"shape":"CreateVpcResult"}, "documentation":"

Creates a VPC with the specified CIDR block.

The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpcEndpoint":{ "name":"CreateVpcEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcEndpointRequest"}, "output":{"shape":"CreateVpcEndpointResult"}, "documentation":"

Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.

Currently, only endpoints to Amazon S3 are supported.

" }, "CreateVpcPeeringConnection":{ "name":"CreateVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcPeeringConnectionRequest"}, "output":{"shape":"CreateVpcPeeringConnectionResult"}, "documentation":"

Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.

The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.

" }, "CreateVpnConnection":{ "name":"CreateVpnConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnConnectionRequest"}, "output":{"shape":"CreateVpnConnectionResult"}, "documentation":"

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpnConnectionRoute":{ "name":"CreateVpnConnectionRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnConnectionRouteRequest"}, "documentation":"

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpnGateway":{ "name":"CreateVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnGatewayRequest"}, "output":{"shape":"CreateVpnGatewayResult"}, "documentation":"

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DeleteCustomerGateway":{ "name":"DeleteCustomerGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCustomerGatewayRequest"}, "documentation":"

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" }, "DeleteDhcpOptions":{ "name":"DeleteDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDhcpOptionsRequest"}, "documentation":"

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" }, "DeleteFlowLogs":{ "name":"DeleteFlowLogs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteFlowLogsRequest"}, "output":{"shape":"DeleteFlowLogsResult"}, "documentation":"

Deletes one or more flow logs.

" }, "DeleteInternetGateway":{ "name":"DeleteInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteInternetGatewayRequest"}, "documentation":"

Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.

" }, "DeleteKeyPair":{ "name":"DeleteKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteKeyPairRequest"}, "documentation":"

Deletes the specified key pair, by removing the public key from Amazon EC2.

" }, "DeleteNatGateway":{ "name":"DeleteNatGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNatGatewayRequest"}, "output":{"shape":"DeleteNatGatewayResult"}, "documentation":"

Deletes the specified NAT gateway. Deleting a NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.

" }, "DeleteNetworkAcl":{ "name":"DeleteNetworkAcl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkAclRequest"}, "documentation":"

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" }, "DeleteNetworkAclEntry":{ "name":"DeleteNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkAclEntryRequest"}, "documentation":"

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" }, "DeleteNetworkInterface":{ "name":"DeleteNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkInterfaceRequest"}, "documentation":"

Deletes the specified network interface. You must detach the network interface before you can delete it.

" }, "DeletePlacementGroup":{ "name":"DeletePlacementGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePlacementGroupRequest"}, "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteRoute":{ "name":"DeleteRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRouteRequest"}, "documentation":"

Deletes the specified route from the specified route table.

" }, "DeleteRouteTable":{ "name":"DeleteRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRouteTableRequest"}, "documentation":"

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" }, "DeleteSecurityGroup":{ "name":"DeleteSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSecurityGroupRequest"}, "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" }, "DeleteSnapshot":{ "name":"DeleteSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSnapshotRequest"}, "documentation":"

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteSpotDatafeedSubscription":{ "name":"DeleteSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSpotDatafeedSubscriptionRequest"}, "documentation":"

Deletes the data feed for Spot instances.

" }, "DeleteSubnet":{ "name":"DeleteSubnet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSubnetRequest"}, "documentation":"

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsRequest"}, "documentation":"

Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteVolume":{ "name":"DeleteVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVolumeRequest"}, "documentation":"

Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).

The volume may remain in the deleting state for several minutes.

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteVpc":{ "name":"DeleteVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcRequest"}, "documentation":"

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" }, "DeleteVpcEndpoints":{ "name":"DeleteVpcEndpoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcEndpointsRequest"}, "output":{"shape":"DeleteVpcEndpointsResult"}, "documentation":"

Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint.

" }, "DeleteVpcPeeringConnection":{ "name":"DeleteVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, "output":{"shape":"DeleteVpcPeeringConnectionResult"}, "documentation":"

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.

" }, "DeleteVpnConnection":{ "name":"DeleteVpnConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnConnectionRequest"}, "documentation":"

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" }, "DeleteVpnConnectionRoute":{ "name":"DeleteVpnConnectionRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnConnectionRouteRequest"}, "documentation":"

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" }, "DeleteVpnGateway":{ "name":"DeleteVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnGatewayRequest"}, "documentation":"

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" }, "DeregisterImage":{ "name":"DeregisterImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterImageRequest"}, "documentation":"

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

This command does not delete the AMI.

" }, "DescribeAccountAttributes":{ "name":"DescribeAccountAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAccountAttributesRequest"}, "output":{"shape":"DescribeAccountAttributesResult"}, "documentation":"

Describes attributes of your AWS account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: The maximum number of On-Demand instances that you can run.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

" }, "DescribeAddresses":{ "name":"DescribeAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAddressesRequest"}, "output":{"shape":"DescribeAddressesResult"}, "documentation":"

Describes one or more of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeAvailabilityZones":{ "name":"DescribeAvailabilityZones", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAvailabilityZonesRequest"}, "output":{"shape":"DescribeAvailabilityZonesResult"}, "documentation":"

Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeBundleTasks":{ "name":"DescribeBundleTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeBundleTasksRequest"}, "output":{"shape":"DescribeBundleTasksResult"}, "documentation":"

Describes one or more of your bundling tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

" }, "DescribeClassicLinkInstances":{ "name":"DescribeClassicLinkInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClassicLinkInstancesRequest"}, "output":{"shape":"DescribeClassicLinkInstancesResult"}, "documentation":"

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.

" }, "DescribeConversionTasks":{ "name":"DescribeConversionTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConversionTasksRequest"}, "output":{"shape":"DescribeConversionTasksResult"}, "documentation":"

Describes one or more of your conversion tasks. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" }, "DescribeCustomerGateways":{ "name":"DescribeCustomerGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCustomerGatewaysRequest"}, "output":{"shape":"DescribeCustomerGatewaysResult"}, "documentation":"

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeDhcpOptions":{ "name":"DescribeDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDhcpOptionsRequest"}, "output":{"shape":"DescribeDhcpOptionsResult"}, "documentation":"

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeExportTasks":{ "name":"DescribeExportTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeExportTasksRequest"}, "output":{"shape":"DescribeExportTasksResult"}, "documentation":"

Describes one or more of your export tasks.

" }, "DescribeFlowLogs":{ "name":"DescribeFlowLogs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFlowLogsRequest"}, "output":{"shape":"DescribeFlowLogsResult"}, "documentation":"

Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.

" }, "DescribeHosts":{ "name":"DescribeHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHostsRequest"}, "output":{"shape":"DescribeHostsResult"}, "documentation":"

Describes one or more of your Dedicated hosts.

The results describe only the Dedicated hosts in the region you're currently using. All listed instances consume capacity on your Dedicated host. Dedicated hosts that have recently been released will be listed with the state released.

" }, "DescribeIdFormat":{ "name":"DescribeIdFormat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeIdFormatRequest"}, "output":{"shape":"DescribeIdFormatResult"}, "documentation":"

Describes the ID format settings for your resources on a per-region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.

The following resource types support longer IDs: instance | reservation | snapshot | volume.

These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" }, "DescribeImageAttribute":{ "name":"DescribeImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImageAttributeRequest"}, "output":{"shape":"ImageAttribute"}, "documentation":"

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" }, "DescribeImages":{ "name":"DescribeImages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImagesRequest"}, "output":{"shape":"DescribeImagesResult"}, "documentation":"

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

Deregistered images are included in the returned results for an unspecified interval after deregistration.

" }, "DescribeImportImageTasks":{ "name":"DescribeImportImageTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImportImageTasksRequest"}, "output":{"shape":"DescribeImportImageTasksResult"}, "documentation":"

Displays details about an import virtual machine or import snapshot tasks that are already created.

" }, "DescribeImportSnapshotTasks":{ "name":"DescribeImportSnapshotTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImportSnapshotTasksRequest"}, "output":{"shape":"DescribeImportSnapshotTasksResult"}, "documentation":"

Describes your import snapshot tasks.

" }, "DescribeInstanceAttribute":{ "name":"DescribeInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceAttributeRequest"}, "output":{"shape":"InstanceAttribute"}, "documentation":"

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" }, "DescribeInstanceStatus":{ "name":"DescribeInstanceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceStatusRequest"}, "output":{"shape":"DescribeInstanceStatusResult"}, "documentation":"

Describes the status of one or more instances. By default, only running instances are described, unless specified otherwise.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeInstances":{ "name":"DescribeInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancesRequest"}, "output":{"shape":"DescribeInstancesResult"}, "documentation":"

Describes one or more of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

" }, "DescribeInternetGateways":{ "name":"DescribeInternetGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInternetGatewaysRequest"}, "output":{"shape":"DescribeInternetGatewaysResult"}, "documentation":"

Describes one or more of your Internet gateways.

" }, "DescribeKeyPairs":{ "name":"DescribeKeyPairs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeKeyPairsRequest"}, "output":{"shape":"DescribeKeyPairsResult"}, "documentation":"

Describes one or more of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeMovingAddresses":{ "name":"DescribeMovingAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMovingAddressesRequest"}, "output":{"shape":"DescribeMovingAddressesResult"}, "documentation":"

Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

" }, "DescribeNatGateways":{ "name":"DescribeNatGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNatGatewaysRequest"}, "output":{"shape":"DescribeNatGatewaysResult"}, "documentation":"

Describes one or more of the your NAT gateways.

" }, "DescribeNetworkAcls":{ "name":"DescribeNetworkAcls", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkAclsRequest"}, "output":{"shape":"DescribeNetworkAclsResult"}, "documentation":"

Describes one or more of your network ACLs.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeNetworkInterfaceAttribute":{ "name":"DescribeNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, "documentation":"

Describes a network interface attribute. You can specify only one attribute at a time.

" }, "DescribeNetworkInterfaces":{ "name":"DescribeNetworkInterfaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkInterfacesRequest"}, "output":{"shape":"DescribeNetworkInterfacesResult"}, "documentation":"

Describes one or more of your network interfaces.

" }, "DescribePlacementGroups":{ "name":"DescribePlacementGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePlacementGroupsRequest"}, "output":{"shape":"DescribePlacementGroupsResult"}, "documentation":"

Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribePrefixLists":{ "name":"DescribePrefixLists", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePrefixListsRequest"}, "output":{"shape":"DescribePrefixListsResult"}, "documentation":"

Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a VPC endpoint.

" }, "DescribeRegions":{ "name":"DescribeRegions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRegionsRequest"}, "output":{"shape":"DescribeRegionsResult"}, "documentation":"

Describes one or more regions that are currently available to you.

For a list of the regions supported by Amazon EC2, see Regions and Endpoints.

" }, "DescribeReservedInstances":{ "name":"DescribeReservedInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesRequest"}, "output":{"shape":"DescribeReservedInstancesResult"}, "documentation":"

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesListings":{ "name":"DescribeReservedInstancesListings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesListingsRequest"}, "output":{"shape":"DescribeReservedInstancesListingsResult"}, "documentation":"

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesModifications":{ "name":"DescribeReservedInstancesModifications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, "output":{"shape":"DescribeReservedInstancesModificationsResult"}, "documentation":"

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesOfferings":{ "name":"DescribeReservedInstancesOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, "documentation":"

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeRouteTables":{ "name":"DescribeRouteTables", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRouteTablesRequest"}, "output":{"shape":"DescribeRouteTablesResult"}, "documentation":"

Describes one or more of your route tables.

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeScheduledInstanceAvailability":{ "name":"DescribeScheduledInstanceAvailability", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeScheduledInstanceAvailabilityRequest"}, "output":{"shape":"DescribeScheduledInstanceAvailabilityResult"}, "documentation":"

Finds available schedules that meet the specified criteria.

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.

" }, "DescribeScheduledInstances":{ "name":"DescribeScheduledInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeScheduledInstancesRequest"}, "output":{"shape":"DescribeScheduledInstancesResult"}, "documentation":"

Describes one or more of your Scheduled Instances.

" }, "DescribeSecurityGroupReferences":{ "name":"DescribeSecurityGroupReferences", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSecurityGroupReferencesRequest"}, "output":{"shape":"DescribeSecurityGroupReferencesResult"}, "documentation":"

[EC2-VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.

" }, "DescribeSecurityGroups":{ "name":"DescribeSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSecurityGroupsRequest"}, "output":{"shape":"DescribeSecurityGroupsResult"}, "documentation":"

Describes one or more of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeSnapshotAttribute":{ "name":"DescribeSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotAttributeRequest"}, "output":{"shape":"DescribeSnapshotAttributeResult"}, "documentation":"

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSnapshots":{ "name":"DescribeSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotsRequest"}, "output":{"shape":"DescribeSnapshotsResult"}, "documentation":"

Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.

  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.

  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSpotDatafeedSubscription":{ "name":"DescribeSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, "documentation":"

Describes the data feed for Spot instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSpotFleetInstances":{ "name":"DescribeSpotFleetInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotFleetInstancesRequest"}, "output":{"shape":"DescribeSpotFleetInstancesResponse"}, "documentation":"

Describes the running instances for the specified Spot fleet.

" }, "DescribeSpotFleetRequestHistory":{ "name":"DescribeSpotFleetRequestHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotFleetRequestHistoryRequest"}, "output":{"shape":"DescribeSpotFleetRequestHistoryResponse"}, "documentation":"

Describes the events for the specified Spot fleet request during the specified time.

Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event.

" }, "DescribeSpotFleetRequests":{ "name":"DescribeSpotFleetRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotFleetRequestsRequest"}, "output":{"shape":"DescribeSpotFleetRequestsResponse"}, "documentation":"

Describes your Spot fleet requests.

" }, "DescribeSpotInstanceRequests":{ "name":"DescribeSpotInstanceRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, "output":{"shape":"DescribeSpotInstanceRequestsResult"}, "documentation":"

Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

You can use DescribeSpotInstanceRequests to find a running Spot instance by examining the response. If the status of the Spot instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

" }, "DescribeSpotPriceHistory":{ "name":"DescribeSpotPriceHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotPriceHistoryRequest"}, "output":{"shape":"DescribeSpotPriceHistoryResult"}, "documentation":"

Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see Spot Instance Pricing History in the Amazon Elastic Compute Cloud User Guide.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" }, "DescribeStaleSecurityGroups":{ "name":"DescribeStaleSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStaleSecurityGroupsRequest"}, "output":{"shape":"DescribeStaleSecurityGroupsResult"}, "documentation":"

[EC2-VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.

" }, "DescribeSubnets":{ "name":"DescribeSubnets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSubnetsRequest"}, "output":{"shape":"DescribeSubnetsResult"}, "documentation":"

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsRequest"}, "output":{"shape":"DescribeTagsResult"}, "documentation":"

Describes one or more of the tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVolumeAttribute":{ "name":"DescribeVolumeAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumeAttributeRequest"}, "output":{"shape":"DescribeVolumeAttributeResult"}, "documentation":"

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVolumeStatus":{ "name":"DescribeVolumeStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumeStatusRequest"}, "output":{"shape":"DescribeVolumeStatusResult"}, "documentation":"

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

" }, "DescribeVolumes":{ "name":"DescribeVolumes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumesRequest"}, "output":{"shape":"DescribeVolumesResult"}, "documentation":"

Describes the specified EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVpcAttribute":{ "name":"DescribeVpcAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcAttributeRequest"}, "output":{"shape":"DescribeVpcAttributeResult"}, "documentation":"

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" }, "DescribeVpcClassicLink":{ "name":"DescribeVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcClassicLinkRequest"}, "output":{"shape":"DescribeVpcClassicLinkResult"}, "documentation":"

Describes the ClassicLink status of one or more VPCs.

" }, "DescribeVpcClassicLinkDnsSupport":{ "name":"DescribeVpcClassicLinkDnsSupport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcClassicLinkDnsSupportRequest"}, "output":{"shape":"DescribeVpcClassicLinkDnsSupportResult"}, "documentation":"

Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVpcEndpointServices":{ "name":"DescribeVpcEndpointServices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcEndpointServicesRequest"}, "output":{"shape":"DescribeVpcEndpointServicesResult"}, "documentation":"

Describes all supported AWS services that can be specified when creating a VPC endpoint.

" }, "DescribeVpcEndpoints":{ "name":"DescribeVpcEndpoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcEndpointsRequest"}, "output":{"shape":"DescribeVpcEndpointsResult"}, "documentation":"

Describes one or more of your VPC endpoints.

" }, "DescribeVpcPeeringConnections":{ "name":"DescribeVpcPeeringConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, "documentation":"

Describes one or more of your VPC peering connections.

" }, "DescribeVpcs":{ "name":"DescribeVpcs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcsRequest"}, "output":{"shape":"DescribeVpcsResult"}, "documentation":"

Describes one or more of your VPCs.

" }, "DescribeVpnConnections":{ "name":"DescribeVpnConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpnConnectionsRequest"}, "output":{"shape":"DescribeVpnConnectionsResult"}, "documentation":"

Describes one or more of your VPN connections.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeVpnGateways":{ "name":"DescribeVpnGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpnGatewaysRequest"}, "output":{"shape":"DescribeVpnGatewaysResult"}, "documentation":"

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DetachClassicLinkVpc":{ "name":"DetachClassicLinkVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachClassicLinkVpcRequest"}, "output":{"shape":"DetachClassicLinkVpcResult"}, "documentation":"

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" }, "DetachInternetGateway":{ "name":"DetachInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachInternetGatewayRequest"}, "documentation":"

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.

" }, "DetachNetworkInterface":{ "name":"DetachNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachNetworkInterfaceRequest"}, "documentation":"

Detaches a network interface from an instance.

" }, "DetachVolume":{ "name":"DetachVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachVolumeRequest"}, "output":{"shape":"VolumeAttachment"}, "documentation":"

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching.

If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "DetachVpnGateway":{ "name":"DetachVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachVpnGatewayRequest"}, "documentation":"

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" }, "DisableVgwRoutePropagation":{ "name":"DisableVgwRoutePropagation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVgwRoutePropagationRequest"}, "documentation":"

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" }, "DisableVpcClassicLink":{ "name":"DisableVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVpcClassicLinkRequest"}, "output":{"shape":"DisableVpcClassicLinkResult"}, "documentation":"

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

" }, "DisableVpcClassicLinkDnsSupport":{ "name":"DisableVpcClassicLinkDnsSupport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVpcClassicLinkDnsSupportRequest"}, "output":{"shape":"DisableVpcClassicLinkDnsSupportResult"}, "documentation":"

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "DisassociateAddress":{ "name":"DisassociateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateAddressRequest"}, "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" }, "DisassociateRouteTable":{ "name":"DisassociateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateRouteTableRequest"}, "documentation":"

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "EnableVgwRoutePropagation":{ "name":"EnableVgwRoutePropagation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVgwRoutePropagationRequest"}, "documentation":"

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" }, "EnableVolumeIO":{ "name":"EnableVolumeIO", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVolumeIORequest"}, "documentation":"

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" }, "EnableVpcClassicLink":{ "name":"EnableVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVpcClassicLinkRequest"}, "output":{"shape":"EnableVpcClassicLinkResult"}, "documentation":"

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "EnableVpcClassicLinkDnsSupport":{ "name":"EnableVpcClassicLinkDnsSupport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVpcClassicLinkDnsSupportRequest"}, "output":{"shape":"EnableVpcClassicLinkDnsSupportResult"}, "documentation":"

Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "GetConsoleOutput":{ "name":"GetConsoleOutput", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetConsoleOutputRequest"}, "output":{"shape":"GetConsoleOutputResult"}, "documentation":"

Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.

For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output includes output from the EC2Config service.

" }, "GetConsoleScreenshot":{ "name":"GetConsoleScreenshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetConsoleScreenshotRequest"}, "output":{"shape":"GetConsoleScreenshotResult"}, "documentation":"

Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.

The returned content is base64-encoded.

" }, "GetPasswordData":{ "name":"GetPasswordData", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPasswordDataRequest"}, "output":{"shape":"GetPasswordDataResult"}, "documentation":"

Retrieves the encrypted administrator password for an instance running Windows.

The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" }, "ImportImage":{ "name":"ImportImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportImageRequest"}, "output":{"shape":"ImportImageResult"}, "documentation":"

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

" }, "ImportInstance":{ "name":"ImportInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportInstanceRequest"}, "output":{"shape":"ImportInstanceResult"}, "documentation":"

Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. After importing the image, you then upload it using the ec2-import-volume command in the EC2 command line tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" }, "ImportKeyPair":{ "name":"ImportKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportKeyPairRequest"}, "output":{"shape":"ImportKeyPairResult"}, "documentation":"

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "ImportSnapshot":{ "name":"ImportSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportSnapshotRequest"}, "output":{"shape":"ImportSnapshotResult"}, "documentation":"

Imports a disk into an EBS snapshot.

" }, "ImportVolume":{ "name":"ImportVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportVolumeRequest"}, "output":{"shape":"ImportVolumeResult"}, "documentation":"

Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the Amazon EC2 command-line interface (CLI) tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" }, "ModifyHosts":{ "name":"ModifyHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyHostsRequest"}, "output":{"shape":"ModifyHostsResult"}, "documentation":"

Modify the auto-placement setting of a Dedicated host. When auto-placement is enabled, AWS will place instances that you launch with a tenancy of host, but without targeting a specific host ID, onto any available Dedicated host in your account which has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID if you want the instance to launch onto a specific host. If no host ID is provided, the instance will be launched onto a suitable host which has auto-placement enabled.

" }, "ModifyIdFormat":{ "name":"ModifyIdFormat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyIdFormatRequest"}, "documentation":"

Modifies the ID format for the specified resource on a per-region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created. The following resource types support longer IDs: instance | reservation | snapshot | volume.

This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user or as an IAM role that has permission to use this action, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Controlling Access to Longer ID Settings in the Amazon Elastic Compute Cloud User Guide.

Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" }, "ModifyImageAttribute":{ "name":"ModifyImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyImageAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

" }, "ModifyInstanceAttribute":{ "name":"ModifyInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyInstanceAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifyInstancePlacement":{ "name":"ModifyInstancePlacement", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyInstancePlacementRequest"}, "output":{"shape":"ModifyInstancePlacementResult"}, "documentation":"

Set the instance affinity value for a specific stopped instance and modify the instance tenancy setting.

Instance affinity is disabled by default. When instance affinity is host and it is not associated with a specific Dedicated host, the next time it is launched it will automatically be associated with the host it lands on. This relationship will persist if the instance is stopped/started, or rebooted.

You can modify the host ID associated with a stopped instance. If a stopped instance has a new host ID association, the instance will target that host when restarted.

You can modify the tenancy of a stopped instance with a tenancy of host or dedicated.

Affinity, hostID, and tenancy are not required parameters, but at least one of them must be specified in the request. Affinity and tenancy can be modified in the same request, but tenancy can only be modified on instances that are stopped.

" }, "ModifyNetworkInterfaceAttribute":{ "name":"ModifyNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, "documentation":"

Modifies the specified network interface attribute. You can specify only one attribute at a time.

" }, "ModifyReservedInstances":{ "name":"ModifyReservedInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyReservedInstancesRequest"}, "output":{"shape":"ModifyReservedInstancesResult"}, "documentation":"

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifySnapshotAttribute":{ "name":"ModifySnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySnapshotAttributeRequest"}, "documentation":"

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

Snapshots with AWS Marketplace product codes cannot be made public.

" }, "ModifySpotFleetRequest":{ "name":"ModifySpotFleetRequest", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySpotFleetRequestRequest"}, "output":{"shape":"ModifySpotFleetRequestResponse"}, "documentation":"

Modifies the specified Spot fleet request.

While the Spot fleet request is being modified, it is in the modifying state.

To scale up your Spot fleet, increase its target capacity. The Spot fleet launches the additional Spot instances according to the allocation strategy for the Spot fleet request. If the allocation strategy is lowestPrice, the Spot fleet launches instances using the Spot pool with the lowest price. If the allocation strategy is diversified, the Spot fleet distributes the instances across the Spot pools.

To scale down your Spot fleet, decrease its target capacity. First, the Spot fleet cancels any open bids that exceed the new target capacity. You can request that the Spot fleet terminate Spot instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot fleet terminates the instances with the highest price per unit. If the allocation strategy is diversified, the Spot fleet terminates instances across the Spot pools. Alternatively, you can request that the Spot fleet keep the fleet at its current size, but not replace any Spot instances that are interrupted or that you terminate manually.

" }, "ModifySubnetAttribute":{ "name":"ModifySubnetAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySubnetAttributeRequest"}, "documentation":"

Modifies a subnet attribute.

" }, "ModifyVolumeAttribute":{ "name":"ModifyVolumeAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVolumeAttributeRequest"}, "documentation":"

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" }, "ModifyVpcAttribute":{ "name":"ModifyVpcAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified VPC.

" }, "ModifyVpcEndpoint":{ "name":"ModifyVpcEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcEndpointRequest"}, "output":{"shape":"ModifyVpcEndpointResult"}, "documentation":"

Modifies attributes of a specified VPC endpoint. You can modify the policy associated with the endpoint, and you can add and remove route tables associated with the endpoint.

" }, "ModifyVpcPeeringConnectionOptions":{ "name":"ModifyVpcPeeringConnectionOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcPeeringConnectionOptionsRequest"}, "output":{"shape":"ModifyVpcPeeringConnectionOptionsResult"}, "documentation":"

Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:

  • Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.

  • Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.

If the peered VPCs are in different accounts, each owner must initiate a separate request to enable or disable communication in either direction, depending on whether their VPC was the requester or accepter for the VPC peering connection. If the peered VPCs are in the same account, you can modify the requester and accepter options in the same request. To confirm which VPC is the accepter and requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

" }, "MonitorInstances":{ "name":"MonitorInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MonitorInstancesRequest"}, "output":{"shape":"MonitorInstancesResult"}, "documentation":"

Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "MoveAddressToVpc":{ "name":"MoveAddressToVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MoveAddressToVpcRequest"}, "output":{"shape":"MoveAddressToVpcResult"}, "documentation":"

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

" }, "PurchaseReservedInstancesOffering":{ "name":"PurchaseReservedInstancesOffering", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, "documentation":"

Purchases a Reserved Instance for use with your account. With Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time and pay a lower hourly rate compared to On-Demand instance pricing.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "PurchaseScheduledInstances":{ "name":"PurchaseScheduledInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseScheduledInstancesRequest"}, "output":{"shape":"PurchaseScheduledInstancesResult"}, "documentation":"

Purchases one or more Scheduled Instances with the specified schedule.

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.

After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.

" }, "RebootInstances":{ "name":"RebootInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootInstancesRequest"}, "documentation":"

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "RegisterImage":{ "name":"RegisterImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterImageRequest"}, "output":{"shape":"RegisterImageResult"}, "documentation":"

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide.

Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billingProduct code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure.

Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI.

To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see CreateImage.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

" }, "RejectVpcPeeringConnection":{ "name":"RejectVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RejectVpcPeeringConnectionRequest"}, "output":{"shape":"RejectVpcPeeringConnectionResult"}, "documentation":"

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" }, "ReleaseAddress":{ "name":"ReleaseAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReleaseAddressRequest"}, "documentation":"

Releases the specified Elastic IP address.

After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

" }, "ReleaseHosts":{ "name":"ReleaseHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReleaseHostsRequest"}, "output":{"shape":"ReleaseHostsResult"}, "documentation":"

When you no longer want to use a Dedicated host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated hosts that have been released can no longer be specified in another request, e.g., ModifyHosts. You must stop or terminate all instances on a host before it can be released.

When Dedicated hosts are released, it make take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated hosts. Try waiting a few minutes, and then try again.

Released hosts will still appear in a DescribeHosts response.

" }, "ReplaceNetworkAclAssociation":{ "name":"ReplaceNetworkAclAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceNetworkAclAssociationRequest"}, "output":{"shape":"ReplaceNetworkAclAssociationResult"}, "documentation":"

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceNetworkAclEntry":{ "name":"ReplaceNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceNetworkAclEntryRequest"}, "documentation":"

Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceRoute":{ "name":"ReplaceRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceRouteRequest"}, "documentation":"

Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, or network interface.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceRouteTableAssociation":{ "name":"ReplaceRouteTableAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceRouteTableAssociationRequest"}, "output":{"shape":"ReplaceRouteTableAssociationResult"}, "documentation":"

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" }, "ReportInstanceStatus":{ "name":"ReportInstanceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReportInstanceStatusRequest"}, "documentation":"

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" }, "RequestSpotFleet":{ "name":"RequestSpotFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RequestSpotFleetRequest"}, "output":{"shape":"RequestSpotFleetResponse"}, "documentation":"

Creates a Spot fleet request.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet.

For more information, see Spot Fleet Requests in the Amazon Elastic Compute Cloud User Guide.

" }, "RequestSpotInstances":{ "name":"RequestSpotInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RequestSpotInstancesRequest"}, "output":{"shape":"RequestSpotInstancesResult"}, "documentation":"

Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

" }, "ResetImageAttribute":{ "name":"ResetImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetImageAttributeRequest"}, "documentation":"

Resets an attribute of an AMI to its default value.

The productCodes attribute can't be reset.

" }, "ResetInstanceAttribute":{ "name":"ResetInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetInstanceAttributeRequest"}, "documentation":"

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.

The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" }, "ResetNetworkInterfaceAttribute":{ "name":"ResetNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetNetworkInterfaceAttributeRequest"}, "documentation":"

Resets a network interface attribute. You can specify only one attribute at a time.

" }, "ResetSnapshotAttribute":{ "name":"ResetSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetSnapshotAttributeRequest"}, "documentation":"

Resets permission settings for the specified snapshot.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "RestoreAddressToClassic":{ "name":"RestoreAddressToClassic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreAddressToClassicRequest"}, "output":{"shape":"RestoreAddressToClassicResult"}, "documentation":"

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

" }, "RevokeSecurityGroupEgress":{ "name":"RevokeSecurityGroupEgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSecurityGroupEgressRequest"}, "documentation":"

[EC2-VPC only] Removes one or more egress rules from a security group for EC2-VPC. This action doesn't apply to security groups for use in EC2-Classic. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" }, "RevokeSecurityGroupIngress":{ "name":"RevokeSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSecurityGroupIngressRequest"}, "documentation":"

Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" }, "RunInstances":{ "name":"RunInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RunInstancesRequest"}, "output":{"shape":"Reservation"}, "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

When you launch an instance, it enters the pending state. After the instance is ready for you, it enters the running state. To check the state of your instance, call DescribeInstances.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

To tag your instance, ensure that it is running as CreateTags requires a resource ID. For more information about tagging, see Tagging Your Amazon EC2 Resources.

If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide.

[EC2-VPC only accounts] If you don't specify a subnet in the request, we choose a default subnet from your default VPC for you.

[EC2-Classic accounts] If you're launching into EC2-Classic and you don't specify an Availability Zone, we choose one for you.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide.

If any of the AMIs have a product code attached for which the user has not subscribed, RunInstances fails.

Some instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, RunInstances fails. For more information, see Instance Types Available Only in a VPC.

For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "RunScheduledInstances":{ "name":"RunScheduledInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RunScheduledInstancesRequest"}, "output":{"shape":"RunScheduledInstancesResult"}, "documentation":"

Launches the specified Scheduled Instances.

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "StartInstances":{ "name":"StartInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartInstancesRequest"}, "output":{"shape":"StartInstancesResult"}, "documentation":"

Starts an Amazon EBS-backed AMI that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "StopInstances":{ "name":"StopInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopInstancesRequest"}, "output":{"shape":"StopInstancesResult"}, "documentation":"

Stops an Amazon EBS-backed instance.

We don't charge hourly usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

You can't start or stop Spot instances, and you can't stop instance store-backed instances.

When you stop an instance, we shut it down. You can restart your instance at any time. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Stopping an instance is different to rebooting or terminating it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "TerminateInstances":{ "name":"TerminateInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateInstancesRequest"}, "output":{"shape":"TerminateInstancesResult"}, "documentation":"

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "UnassignPrivateIpAddresses":{ "name":"UnassignPrivateIpAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnassignPrivateIpAddressesRequest"}, "documentation":"

Unassigns one or more secondary private IP addresses from a network interface.

" }, "UnmonitorInstances":{ "name":"UnmonitorInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnmonitorInstancesRequest"}, "output":{"shape":"UnmonitorInstancesResult"}, "documentation":"

Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" } }, "shapes":{ "AcceptVpcPeeringConnectionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Contains the parameters for AcceptVpcPeeringConnection.

" }, "AcceptVpcPeeringConnectionResult":{ "type":"structure", "members":{ "VpcPeeringConnection":{ "shape":"VpcPeeringConnection", "documentation":"

Information about the VPC peering connection.

", "locationName":"vpcPeeringConnection" } }, "documentation":"

Contains the output of AcceptVpcPeeringConnection.

" }, "AccountAttribute":{ "type":"structure", "members":{ "AttributeName":{ "shape":"String", "documentation":"

The name of the account attribute.

", "locationName":"attributeName" }, "AttributeValues":{ "shape":"AccountAttributeValueList", "documentation":"

One or more values for the account attribute.

", "locationName":"attributeValueSet" } }, "documentation":"

Describes an account attribute.

" }, "AccountAttributeList":{ "type":"list", "member":{ "shape":"AccountAttribute", "locationName":"item" } }, "AccountAttributeName":{ "type":"string", "enum":[ "supported-platforms", "default-vpc" ] }, "AccountAttributeNameStringList":{ "type":"list", "member":{ "shape":"AccountAttributeName", "locationName":"attributeName" } }, "AccountAttributeValue":{ "type":"structure", "members":{ "AttributeValue":{ "shape":"String", "documentation":"

The value of the attribute.

", "locationName":"attributeValue" } }, "documentation":"

Describes a value of an account attribute.

" }, "AccountAttributeValueList":{ "type":"list", "member":{ "shape":"AccountAttributeValue", "locationName":"item" } }, "ActiveInstance":{ "type":"structure", "members":{ "InstanceType":{ "shape":"String", "documentation":"

The instance type.

", "locationName":"instanceType" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot instance request.

", "locationName":"spotInstanceRequestId" } }, "documentation":"

Describes a running instance in a Spot fleet.

" }, "ActiveInstanceSet":{ "type":"list", "member":{ "shape":"ActiveInstance", "locationName":"item" } }, "Address":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance that the address is associated with (if any).

", "locationName":"instanceId" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "AllocationId":{ "shape":"String", "documentation":"

The ID representing the allocation of the address for use with EC2-VPC.

", "locationName":"allocationId" }, "AssociationId":{ "shape":"String", "documentation":"

The ID representing the association of the address with an instance in a VPC.

", "locationName":"associationId" }, "Domain":{ "shape":"DomainType", "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", "locationName":"domain" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "NetworkInterfaceOwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that owns the network interface.

", "locationName":"networkInterfaceOwnerId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address associated with the Elastic IP address.

", "locationName":"privateIpAddress" } }, "documentation":"

Describes an Elastic IP address.

" }, "AddressList":{ "type":"list", "member":{ "shape":"Address", "locationName":"item" } }, "Affinity":{ "type":"string", "enum":[ "default", "host" ] }, "AllocateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Domain":{ "shape":"DomainType", "documentation":"

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" } }, "documentation":"

Contains the parameters for AllocateAddress.

" }, "AllocateAddressResult":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "Domain":{ "shape":"DomainType", "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", "locationName":"domain" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", "locationName":"allocationId" } }, "documentation":"

Contains the output of AllocateAddress.

" }, "AllocateHostsRequest":{ "type":"structure", "required":[ "InstanceType", "Quantity", "AvailabilityZone" ], "members":{ "AutoPlacement":{ "shape":"AutoPlacement", "documentation":"

This is enabled by default. This property allows instances to be automatically placed onto available Dedicated hosts, when you are launching instances without specifying a host ID.

Default: Enabled

", "locationName":"autoPlacement" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"clientToken" }, "InstanceType":{ "shape":"String", "documentation":"

Specify the instance type that you want your Dedicated hosts to be configured for. When you specify the instance type, that is the only instance type that you can launch onto that host.

", "locationName":"instanceType" }, "Quantity":{ "shape":"Integer", "documentation":"

The number of Dedicated hosts you want to allocate to your account with these parameters.

", "locationName":"quantity" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the Dedicated hosts.

", "locationName":"availabilityZone" } }, "documentation":"

Contains the parameters for AllocateHosts.

" }, "AllocateHostsResult":{ "type":"structure", "members":{ "HostIds":{ "shape":"ResponseHostIdList", "documentation":"

The ID of the allocated Dedicated host. This is used when you want to launch an instance onto a specific host.

", "locationName":"hostIdSet" } }, "documentation":"

Contains the output of AllocateHosts.

" }, "AllocationIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"AllocationId" } }, "AllocationState":{ "type":"string", "enum":[ "available", "under-assessment", "permanent-failure", "released", "released-permanent-failure" ] }, "AllocationStrategy":{ "type":"string", "enum":[ "lowestPrice", "diversified" ] }, "ArchitectureValues":{ "type":"string", "enum":[ "i386", "x86_64" ] }, "AssignPrivateIpAddressesRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", "locationName":"privateIpAddress" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", "locationName":"secondaryPrivateIpAddressCount" }, "AllowReassignment":{ "shape":"Boolean", "documentation":"

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", "locationName":"allowReassignment" } }, "documentation":"

Contains the parameters for AssignPrivateIpAddresses.

" }, "AssociateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address. This is required for EC2-Classic.

" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

", "locationName":"networkInterfaceId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", "locationName":"privateIpAddress" }, "AllowReassociation":{ "shape":"Boolean", "documentation":"

[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

", "locationName":"allowReassociation" } }, "documentation":"

Contains the parameters for AssociateAddress.

" }, "AssociateAddressResult":{ "type":"structure", "members":{ "AssociationId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", "locationName":"associationId" } }, "documentation":"

Contains the output of AssociateAddress.

" }, "AssociateDhcpOptionsRequest":{ "type":"structure", "required":[ "DhcpOptionsId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for AssociateDhcpOptions.

" }, "AssociateRouteTableRequest":{ "type":"structure", "required":[ "SubnetId", "RouteTableId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" } }, "documentation":"

Contains the parameters for AssociateRouteTable.

" }, "AssociateRouteTableResult":{ "type":"structure", "members":{ "AssociationId":{ "shape":"String", "documentation":"

The route table association ID (needed to disassociate the route table).

", "locationName":"associationId" } }, "documentation":"

Contains the output of AssociateRouteTable.

" }, "AttachClassicLinkVpcRequest":{ "type":"structure", "required":[ "InstanceId", "VpcId", "Groups" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of a ClassicLink-enabled VPC.

", "locationName":"vpcId" }, "Groups":{ "shape":"GroupIdStringList", "documentation":"

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", "locationName":"SecurityGroupId" } }, "documentation":"

Contains the parameters for AttachClassicLinkVpc.

" }, "AttachClassicLinkVpcResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of AttachClassicLinkVpc.

" }, "AttachInternetGatewayRequest":{ "type":"structure", "required":[ "InternetGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for AttachInternetGateway.

" }, "AttachNetworkInterfaceRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "InstanceId", "DeviceIndex" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device for the network interface attachment.

", "locationName":"deviceIndex" } }, "documentation":"

Contains the parameters for AttachNetworkInterface.

" }, "AttachNetworkInterfaceResult":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" } }, "documentation":"

Contains the output of AttachNetworkInterface.

" }, "AttachVolumeRequest":{ "type":"structure", "required":[ "VolumeId", "InstanceId", "Device" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "Device":{ "shape":"String", "documentation":"

The device name to expose to the instance (for example, /dev/sdh or xvdh).

" } }, "documentation":"

Contains the parameters for AttachVolume.

" }, "AttachVpnGatewayRequest":{ "type":"structure", "required":[ "VpnGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for AttachVpnGateway.

" }, "AttachVpnGatewayResult":{ "type":"structure", "members":{ "VpcAttachment":{ "shape":"VpcAttachment", "documentation":"

Information about the attachment.

", "locationName":"attachment" } }, "documentation":"

Contains the output of AttachVpnGateway.

" }, "AttachmentStatus":{ "type":"string", "enum":[ "attaching", "attached", "detaching", "detached" ] }, "AttributeBooleanValue":{ "type":"structure", "members":{ "Value":{ "shape":"Boolean", "documentation":"

Valid values are true or false.

", "locationName":"value" } }, "documentation":"

The value to use when a resource attribute accepts a Boolean value.

" }, "AttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"String", "documentation":"

Valid values are case-sensitive and vary by action.

", "locationName":"value" } }, "documentation":"

The value to use for a resource attribute.

" }, "AuthorizeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

The name of a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account number for a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", "locationName":"toPort" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.

", "locationName":"cidrIp" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"ipPermissions" } }, "documentation":"

Contains the parameters for AuthorizeSecurityGroupEgress.

" }, "AuthorizeSecurityGroupIngressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a nondefault VPC.

" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.

" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

[EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.

" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. Can be used to specify multiple rules in a single command.

" } }, "documentation":"

Contains the parameters for AuthorizeSecurityGroupIngress.

" }, "AutoPlacement":{ "type":"string", "enum":[ "on", "off" ] }, "AvailabilityZone":{ "type":"structure", "members":{ "ZoneName":{ "shape":"String", "documentation":"

The name of the Availability Zone.

", "locationName":"zoneName" }, "State":{ "shape":"AvailabilityZoneState", "documentation":"

The state of the Availability Zone.

", "locationName":"zoneState" }, "RegionName":{ "shape":"String", "documentation":"

The name of the region.

", "locationName":"regionName" }, "Messages":{ "shape":"AvailabilityZoneMessageList", "documentation":"

Any messages about the Availability Zone.

", "locationName":"messageSet" } }, "documentation":"

Describes an Availability Zone.

" }, "AvailabilityZoneList":{ "type":"list", "member":{ "shape":"AvailabilityZone", "locationName":"item" } }, "AvailabilityZoneMessage":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

The message about the Availability Zone.

", "locationName":"message" } }, "documentation":"

Describes a message about an Availability Zone.

" }, "AvailabilityZoneMessageList":{ "type":"list", "member":{ "shape":"AvailabilityZoneMessage", "locationName":"item" } }, "AvailabilityZoneState":{ "type":"string", "enum":[ "available", "information", "impaired", "unavailable" ] }, "AvailableCapacity":{ "type":"structure", "members":{ "AvailableInstanceCapacity":{ "shape":"AvailableInstanceCapacityList", "documentation":"

The total number of instances that the Dedicated host supports.

", "locationName":"availableInstanceCapacity" }, "AvailableVCpus":{ "shape":"Integer", "documentation":"

The number of vCPUs available on the Dedicated host.

", "locationName":"availableVCpus" } }, "documentation":"

The capacity information for instances launched onto the Dedicated host.

" }, "AvailableInstanceCapacityList":{ "type":"list", "member":{ "shape":"InstanceCapacity", "locationName":"item" } }, "BatchState":{ "type":"string", "enum":[ "submitted", "active", "cancelled", "failed", "cancelled_running", "cancelled_terminating", "modifying" ] }, "Blob":{"type":"blob"}, "BlobAttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"Blob", "locationName":"value" } } }, "BlockDeviceMapping":{ "type":"structure", "members":{ "VirtualName":{ "shape":"String", "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", "locationName":"virtualName" }, "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsBlockDevice", "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", "locationName":"ebs" }, "NoDevice":{ "shape":"String", "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", "locationName":"noDevice" } }, "documentation":"

Describes a block device mapping.

" }, "BlockDeviceMappingList":{ "type":"list", "member":{ "shape":"BlockDeviceMapping", "locationName":"item" } }, "BlockDeviceMappingRequestList":{ "type":"list", "member":{ "shape":"BlockDeviceMapping", "locationName":"BlockDeviceMapping" } }, "Boolean":{"type":"boolean"}, "BundleIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"BundleId" } }, "BundleInstanceRequest":{ "type":"structure", "required":[ "InstanceId", "Storage" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

" }, "Storage":{ "shape":"Storage", "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" } }, "documentation":"

Contains the parameters for BundleInstance.

" }, "BundleInstanceResult":{ "type":"structure", "members":{ "BundleTask":{ "shape":"BundleTask", "documentation":"

Information about the bundle task.

", "locationName":"bundleInstanceTask" } }, "documentation":"

Contains the output of BundleInstance.

" }, "BundleTask":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance associated with this bundle task.

", "locationName":"instanceId" }, "BundleId":{ "shape":"String", "documentation":"

The ID of the bundle task.

", "locationName":"bundleId" }, "State":{ "shape":"BundleTaskState", "documentation":"

The state of the task.

", "locationName":"state" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time this task started.

", "locationName":"startTime" }, "UpdateTime":{ "shape":"DateTime", "documentation":"

The time of the most recent update for the task.

", "locationName":"updateTime" }, "Storage":{ "shape":"Storage", "documentation":"

The Amazon S3 storage locations.

", "locationName":"storage" }, "Progress":{ "shape":"String", "documentation":"

The level of task completion, as a percent (for example, 20%).

", "locationName":"progress" }, "BundleTaskError":{ "shape":"BundleTaskError", "documentation":"

If the task fails, a description of the error.

", "locationName":"error" } }, "documentation":"

Describes a bundle task.

" }, "BundleTaskError":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The error message.

", "locationName":"message" } }, "documentation":"

Describes an error for BundleInstance.

" }, "BundleTaskList":{ "type":"list", "member":{ "shape":"BundleTask", "locationName":"item" } }, "BundleTaskState":{ "type":"string", "enum":[ "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed" ] }, "CancelBatchErrorCode":{ "type":"string", "enum":[ "fleetRequestIdDoesNotExist", "fleetRequestIdMalformed", "fleetRequestNotInCancellableState", "unexpectedError" ] }, "CancelBundleTaskRequest":{ "type":"structure", "required":["BundleId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "BundleId":{ "shape":"String", "documentation":"

The ID of the bundle task.

" } }, "documentation":"

Contains the parameters for CancelBundleTask.

" }, "CancelBundleTaskResult":{ "type":"structure", "members":{ "BundleTask":{ "shape":"BundleTask", "documentation":"

Information about the bundle task.

", "locationName":"bundleInstanceTask" } }, "documentation":"

Contains the output of CancelBundleTask.

" }, "CancelConversionRequest":{ "type":"structure", "required":["ConversionTaskId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ConversionTaskId":{ "shape":"String", "documentation":"

The ID of the conversion task.

", "locationName":"conversionTaskId" }, "ReasonMessage":{ "shape":"String", "documentation":"

The reason for canceling the conversion task.

", "locationName":"reasonMessage" } }, "documentation":"

Contains the parameters for CancelConversionTask.

" }, "CancelExportTaskRequest":{ "type":"structure", "required":["ExportTaskId"], "members":{ "ExportTaskId":{ "shape":"String", "documentation":"

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", "locationName":"exportTaskId" } }, "documentation":"

Contains the parameters for CancelExportTask.

" }, "CancelImportTaskRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import image or import snapshot task to be canceled.

" }, "CancelReason":{ "shape":"String", "documentation":"

The reason for canceling the task.

" } }, "documentation":"

Contains the parameters for CancelImportTask.

" }, "CancelImportTaskResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the task being canceled.

", "locationName":"importTaskId" }, "State":{ "shape":"String", "documentation":"

The current state of the task being canceled.

", "locationName":"state" }, "PreviousState":{ "shape":"String", "documentation":"

The current state of the task being canceled.

", "locationName":"previousState" } }, "documentation":"

Contains the output for CancelImportTask.

" }, "CancelReservedInstancesListingRequest":{ "type":"structure", "required":["ReservedInstancesListingId"], "members":{ "ReservedInstancesListingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance listing.

", "locationName":"reservedInstancesListingId" } }, "documentation":"

Contains the parameters for CancelReservedInstancesListing.

" }, "CancelReservedInstancesListingResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

The Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } }, "documentation":"

Contains the output of CancelReservedInstancesListing.

" }, "CancelSpotFleetRequestsError":{ "type":"structure", "required":[ "Code", "Message" ], "members":{ "Code":{ "shape":"CancelBatchErrorCode", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The description for the error code.

", "locationName":"message" } }, "documentation":"

Describes a Spot fleet error.

" }, "CancelSpotFleetRequestsErrorItem":{ "type":"structure", "required":[ "SpotFleetRequestId", "Error" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "Error":{ "shape":"CancelSpotFleetRequestsError", "documentation":"

The error.

", "locationName":"error" } }, "documentation":"

Describes a Spot fleet request that was not successfully canceled.

" }, "CancelSpotFleetRequestsErrorSet":{ "type":"list", "member":{ "shape":"CancelSpotFleetRequestsErrorItem", "locationName":"item" } }, "CancelSpotFleetRequestsRequest":{ "type":"structure", "required":[ "SpotFleetRequestIds", "TerminateInstances" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestIds":{ "shape":"ValueStringList", "documentation":"

The IDs of the Spot fleet requests.

", "locationName":"spotFleetRequestId" }, "TerminateInstances":{ "shape":"Boolean", "documentation":"

Indicates whether to terminate instances for a Spot fleet request if it is canceled successfully.

", "locationName":"terminateInstances" } }, "documentation":"

Contains the parameters for CancelSpotFleetRequests.

" }, "CancelSpotFleetRequestsResponse":{ "type":"structure", "members":{ "UnsuccessfulFleetRequests":{ "shape":"CancelSpotFleetRequestsErrorSet", "documentation":"

Information about the Spot fleet requests that are not successfully canceled.

", "locationName":"unsuccessfulFleetRequestSet" }, "SuccessfulFleetRequests":{ "shape":"CancelSpotFleetRequestsSuccessSet", "documentation":"

Information about the Spot fleet requests that are successfully canceled.

", "locationName":"successfulFleetRequestSet" } }, "documentation":"

Contains the output of CancelSpotFleetRequests.

" }, "CancelSpotFleetRequestsSuccessItem":{ "type":"structure", "required":[ "SpotFleetRequestId", "CurrentSpotFleetRequestState", "PreviousSpotFleetRequestState" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "CurrentSpotFleetRequestState":{ "shape":"BatchState", "documentation":"

The current state of the Spot fleet request.

", "locationName":"currentSpotFleetRequestState" }, "PreviousSpotFleetRequestState":{ "shape":"BatchState", "documentation":"

The previous state of the Spot fleet request.

", "locationName":"previousSpotFleetRequestState" } }, "documentation":"

Describes a Spot fleet request that was successfully canceled.

" }, "CancelSpotFleetRequestsSuccessSet":{ "type":"list", "member":{ "shape":"CancelSpotFleetRequestsSuccessItem", "locationName":"item" } }, "CancelSpotInstanceRequestState":{ "type":"string", "enum":[ "active", "open", "closed", "cancelled", "completed" ] }, "CancelSpotInstanceRequestsRequest":{ "type":"structure", "required":["SpotInstanceRequestIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotInstanceRequestIds":{ "shape":"SpotInstanceRequestIdList", "documentation":"

One or more Spot instance request IDs.

", "locationName":"SpotInstanceRequestId" } }, "documentation":"

Contains the parameters for CancelSpotInstanceRequests.

" }, "CancelSpotInstanceRequestsResult":{ "type":"structure", "members":{ "CancelledSpotInstanceRequests":{ "shape":"CancelledSpotInstanceRequestList", "documentation":"

One or more Spot instance requests.

", "locationName":"spotInstanceRequestSet" } }, "documentation":"

Contains the output of CancelSpotInstanceRequests.

" }, "CancelledSpotInstanceRequest":{ "type":"structure", "members":{ "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot instance request.

", "locationName":"spotInstanceRequestId" }, "State":{ "shape":"CancelSpotInstanceRequestState", "documentation":"

The state of the Spot instance request.

", "locationName":"state" } }, "documentation":"

Describes a request to cancel a Spot instance.

" }, "CancelledSpotInstanceRequestList":{ "type":"list", "member":{ "shape":"CancelledSpotInstanceRequest", "locationName":"item" } }, "ClassicLinkDnsSupport":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "ClassicLinkDnsSupported":{ "shape":"Boolean", "documentation":"

Indicates whether ClassicLink DNS support is enabled for the VPC.

", "locationName":"classicLinkDnsSupported" } }, "documentation":"

Describes the ClassicLink DNS support status of a VPC.

" }, "ClassicLinkDnsSupportList":{ "type":"list", "member":{ "shape":"ClassicLinkDnsSupport", "locationName":"item" } }, "ClassicLinkInstance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

A list of security groups.

", "locationName":"groupSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the instance.

", "locationName":"tagSet" } }, "documentation":"

Describes a linked EC2-Classic instance.

" }, "ClassicLinkInstanceList":{ "type":"list", "member":{ "shape":"ClassicLinkInstance", "locationName":"item" } }, "ClientData":{ "type":"structure", "members":{ "UploadStart":{ "shape":"DateTime", "documentation":"

The time that the disk upload starts.

" }, "UploadEnd":{ "shape":"DateTime", "documentation":"

The time that the disk upload ends.

" }, "UploadSize":{ "shape":"Double", "documentation":"

The size of the uploaded disk image, in GiB.

" }, "Comment":{ "shape":"String", "documentation":"

A user-defined comment about the disk upload.

" } }, "documentation":"

Describes the client-specific data.

" }, "ConfirmProductInstanceRequest":{ "type":"structure", "required":[ "ProductCode", "InstanceId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ProductCode":{ "shape":"String", "documentation":"

The product code. This must be a product code that you own.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" } }, "documentation":"

Contains the parameters for ConfirmProductInstance.

" }, "ConfirmProductInstanceResult":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", "locationName":"ownerId" }, "Return":{ "shape":"Boolean", "documentation":"

The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.

", "locationName":"return" } }, "documentation":"

Contains the output of ConfirmProductInstance.

" }, "ContainerFormat":{ "type":"string", "enum":["ova"] }, "ConversionIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "ConversionTask":{ "type":"structure", "required":[ "ConversionTaskId", "State" ], "members":{ "ConversionTaskId":{ "shape":"String", "documentation":"

The ID of the conversion task.

", "locationName":"conversionTaskId" }, "ExpirationTime":{ "shape":"String", "documentation":"

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", "locationName":"expirationTime" }, "ImportInstance":{ "shape":"ImportInstanceTaskDetails", "documentation":"

If the task is for importing an instance, this contains information about the import instance task.

", "locationName":"importInstance" }, "ImportVolume":{ "shape":"ImportVolumeTaskDetails", "documentation":"

If the task is for importing a volume, this contains information about the import volume task.

", "locationName":"importVolume" }, "State":{ "shape":"ConversionTaskState", "documentation":"

The state of the conversion task.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message related to the conversion task.

", "locationName":"statusMessage" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the task.

", "locationName":"tagSet" } }, "documentation":"

Describes a conversion task.

" }, "ConversionTaskState":{ "type":"string", "enum":[ "active", "cancelling", "cancelled", "completed" ] }, "CopyImageRequest":{ "type":"structure", "required":[ "SourceRegion", "SourceImageId", "Name" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SourceRegion":{ "shape":"String", "documentation":"

The name of the region that contains the AMI to copy.

" }, "SourceImageId":{ "shape":"String", "documentation":"

The ID of the AMI to copy.

" }, "Name":{ "shape":"String", "documentation":"

The name of the new AMI in the destination region.

" }, "Description":{ "shape":"String", "documentation":"

A description for the new AMI in the destination region.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

", "locationName":"kmsKeyId" } }, "documentation":"

Contains the parameters for CopyImage.

" }, "CopyImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the new AMI.

", "locationName":"imageId" } }, "documentation":"

Contains the output of CopyImage.

" }, "CopySnapshotRequest":{ "type":"structure", "required":[ "SourceRegion", "SourceSnapshotId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SourceRegion":{ "shape":"String", "documentation":"

The ID of the region that contains the snapshot to be copied.

" }, "SourceSnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot to copy.

" }, "Description":{ "shape":"String", "documentation":"

A description for the EBS snapshot.

" }, "DestinationRegion":{ "shape":"String", "documentation":"

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

", "locationName":"destinationRegion" }, "PresignedUrl":{ "shape":"String", "documentation":"

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", "locationName":"presignedUrl" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

", "locationName":"kmsKeyId" } }, "documentation":"

Contains the parameters for CopySnapshot.

" }, "CopySnapshotResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the new snapshot.

", "locationName":"snapshotId" } }, "documentation":"

Contains the output of CopySnapshot.

" }, "CreateCustomerGatewayRequest":{ "type":"structure", "required":[ "Type", "PublicIp", "BgpAsn" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection that this customer gateway supports (ipsec.1).

" }, "PublicIp":{ "shape":"String", "documentation":"

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", "locationName":"IpAddress" }, "BgpAsn":{ "shape":"Integer", "documentation":"

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" } }, "documentation":"

Contains the parameters for CreateCustomerGateway.

" }, "CreateCustomerGatewayResult":{ "type":"structure", "members":{ "CustomerGateway":{ "shape":"CustomerGateway", "documentation":"

Information about the customer gateway.

", "locationName":"customerGateway" } }, "documentation":"

Contains the output of CreateCustomerGateway.

" }, "CreateDhcpOptionsRequest":{ "type":"structure", "required":["DhcpConfigurations"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpConfigurations":{ "shape":"NewDhcpConfigurationList", "documentation":"

A DHCP configuration option.

", "locationName":"dhcpConfiguration" } }, "documentation":"

Contains the parameters for CreateDhcpOptions.

" }, "CreateDhcpOptionsResult":{ "type":"structure", "members":{ "DhcpOptions":{ "shape":"DhcpOptions", "documentation":"

A set of DHCP options.

", "locationName":"dhcpOptions" } }, "documentation":"

Contains the output of CreateDhcpOptions.

" }, "CreateFlowLogsRequest":{ "type":"structure", "required":[ "ResourceIds", "ResourceType", "TrafficType", "LogGroupName", "DeliverLogsPermissionArn" ], "members":{ "ResourceIds":{ "shape":"ValueStringList", "documentation":"

One or more subnet, network interface, or VPC IDs.

Constraints: Maximum of 1000 resources

", "locationName":"ResourceId" }, "ResourceType":{ "shape":"FlowLogsResourceType", "documentation":"

The type of resource on which to create the flow log.

" }, "TrafficType":{ "shape":"TrafficType", "documentation":"

The type of traffic to log.

" }, "LogGroupName":{ "shape":"String", "documentation":"

The name of the CloudWatch log group.

" }, "DeliverLogsPermissionArn":{ "shape":"String", "documentation":"

The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" } }, "documentation":"

Contains the parameters for CreateFlowLogs.

" }, "CreateFlowLogsResult":{ "type":"structure", "members":{ "FlowLogIds":{ "shape":"ValueStringList", "documentation":"

The IDs of the flow logs.

", "locationName":"flowLogIdSet" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", "locationName":"clientToken" }, "Unsuccessful":{ "shape":"UnsuccessfulItemSet", "documentation":"

Information about the flow logs that could not be created successfully.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of CreateFlowLogs.

" }, "CreateImageRequest":{ "type":"structure", "required":[ "InstanceId", "Name" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Name":{ "shape":"String", "documentation":"

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

A description for the new image.

", "locationName":"description" }, "NoReboot":{ "shape":"Boolean", "documentation":"

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", "locationName":"noReboot" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

Information about one or more block device mappings.

", "locationName":"blockDeviceMapping" } }, "documentation":"

Contains the parameters for CreateImage.

" }, "CreateImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the new AMI.

", "locationName":"imageId" } }, "documentation":"

Contains the output of CreateImage.

" }, "CreateInstanceExportTaskRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "Description":{ "shape":"String", "documentation":"

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", "locationName":"description" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "TargetEnvironment":{ "shape":"ExportEnvironment", "documentation":"

The target virtualization environment.

", "locationName":"targetEnvironment" }, "ExportToS3Task":{ "shape":"ExportToS3TaskSpecification", "documentation":"

The format and location for an instance export task.

", "locationName":"exportToS3" } }, "documentation":"

Contains the parameters for CreateInstanceExportTask.

" }, "CreateInstanceExportTaskResult":{ "type":"structure", "members":{ "ExportTask":{ "shape":"ExportTask", "documentation":"

Information about the instance export task.

", "locationName":"exportTask" } }, "documentation":"

Contains the output for CreateInstanceExportTask.

" }, "CreateInternetGatewayRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for CreateInternetGateway.

" }, "CreateInternetGatewayResult":{ "type":"structure", "members":{ "InternetGateway":{ "shape":"InternetGateway", "documentation":"

Information about the Internet gateway.

", "locationName":"internetGateway" } }, "documentation":"

Contains the output of CreateInternetGateway.

" }, "CreateKeyPairRequest":{ "type":"structure", "required":["KeyName"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" } }, "documentation":"

Contains the parameters for CreateKeyPair.

" }, "CreateNatGatewayRequest":{ "type":"structure", "required":[ "SubnetId", "AllocationId" ], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The subnet in which to create the NAT gateway.

" }, "AllocationId":{ "shape":"String", "documentation":"

The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Constraint: Maximum 64 ASCII characters.

" } }, "documentation":"

Contains the parameters for CreateNatGateway.

" }, "CreateNatGatewayResult":{ "type":"structure", "members":{ "NatGateway":{ "shape":"NatGateway", "documentation":"

Information about the NAT gateway.

", "locationName":"natGateway" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

", "locationName":"clientToken" } }, "documentation":"

Contains the output of CreateNatGateway.

" }, "CreateNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Protocol", "RuleAction", "Egress", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The protocol. A value of -1 means all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.

", "locationName":"Icmp" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", "locationName":"portRange" } }, "documentation":"

Contains the parameters for CreateNetworkAclEntry.

" }, "CreateNetworkAclRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for CreateNetworkAcl.

" }, "CreateNetworkAclResult":{ "type":"structure", "members":{ "NetworkAcl":{ "shape":"NetworkAcl", "documentation":"

Information about the network ACL.

", "locationName":"networkAcl" } }, "documentation":"

Contains the output of CreateNetworkAcl.

" }, "CreateNetworkInterfaceRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet to associate with the network interface.

", "locationName":"subnetId" }, "Description":{ "shape":"String", "documentation":"

A description for the network interface.

", "locationName":"description" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", "locationName":"privateIpAddress" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

The IDs of one or more security groups.

", "locationName":"SecurityGroupId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", "documentation":"

One or more private IP addresses.

", "locationName":"privateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"secondaryPrivateIpAddressCount" }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for CreateNetworkInterface.

" }, "CreateNetworkInterfaceResult":{ "type":"structure", "members":{ "NetworkInterface":{ "shape":"NetworkInterface", "documentation":"

Information about the network interface.

", "locationName":"networkInterface" } }, "documentation":"

Contains the output of CreateNetworkInterface.

" }, "CreatePlacementGroupRequest":{ "type":"structure", "required":[ "GroupName", "Strategy" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

A name for the placement group.

Constraints: Up to 255 ASCII characters

", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"

The placement strategy.

", "locationName":"strategy" } }, "documentation":"

Contains the parameters for CreatePlacementGroup.

" }, "CreateReservedInstancesListingRequest":{ "type":"structure", "required":[ "ReservedInstancesId", "InstanceCount", "PriceSchedules", "ClientToken" ], "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the active Reserved Instance.

", "locationName":"reservedInstancesId" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", "locationName":"instanceCount" }, "PriceSchedules":{ "shape":"PriceScheduleSpecificationList", "documentation":"

A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.

", "locationName":"priceSchedules" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Contains the parameters for CreateReservedInstancesListing.

" }, "CreateReservedInstancesListingResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

Information about the Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } }, "documentation":"

Contains the output of CreateReservedInstancesListing.

" }, "CreateRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table for the route.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of an Internet gateway or virtual private gateway attached to your VPC.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", "locationName":"instanceId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of a network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of a VPC peering connection.

", "locationName":"vpcPeeringConnectionId" }, "NatGatewayId":{ "shape":"String", "documentation":"

The ID of a NAT gateway.

", "locationName":"natGatewayId" } }, "documentation":"

Contains the parameters for CreateRoute.

" }, "CreateRouteResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of CreateRoute.

" }, "CreateRouteTableRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for CreateRouteTable.

" }, "CreateRouteTableResult":{ "type":"structure", "members":{ "RouteTable":{ "shape":"RouteTable", "documentation":"

Information about the route table.

", "locationName":"routeTable" } }, "documentation":"

Contains the output of CreateRouteTable.

" }, "CreateSecurityGroupRequest":{ "type":"structure", "required":[ "GroupName", "Description" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

" }, "Description":{ "shape":"String", "documentation":"

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

", "locationName":"GroupDescription" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" } }, "documentation":"

Contains the parameters for CreateSecurityGroup.

" }, "CreateSecurityGroupResult":{ "type":"structure", "members":{ "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } }, "documentation":"

Contains the output of CreateSecurityGroup.

" }, "CreateSnapshotRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume.

" }, "Description":{ "shape":"String", "documentation":"

A description for the snapshot.

" } }, "documentation":"

Contains the parameters for CreateSnapshot.

" }, "CreateSpotDatafeedSubscriptionRequest":{ "type":"structure", "required":["Bucket"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket in which to store the Spot instance data feed.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

A prefix for the data feed file names.

", "locationName":"prefix" } }, "documentation":"

Contains the parameters for CreateSpotDatafeedSubscription.

" }, "CreateSpotDatafeedSubscriptionResult":{ "type":"structure", "members":{ "SpotDatafeedSubscription":{ "shape":"SpotDatafeedSubscription", "documentation":"

The Spot instance data feed subscription.

", "locationName":"spotDatafeedSubscription" } }, "documentation":"

Contains the output of CreateSpotDatafeedSubscription.

" }, "CreateSubnetRequest":{ "type":"structure", "required":[ "VpcId", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the subnet.

Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.

" } }, "documentation":"

Contains the parameters for CreateSubnet.

" }, "CreateSubnetResult":{ "type":"structure", "members":{ "Subnet":{ "shape":"Subnet", "documentation":"

Information about the subnet.

", "locationName":"subnet" } }, "documentation":"

Contains the output of CreateSubnet.

" }, "CreateTagsRequest":{ "type":"structure", "required":[ "Resources", "Tags" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Resources":{ "shape":"ResourceIdList", "documentation":"

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

", "locationName":"ResourceId" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", "locationName":"Tag" } }, "documentation":"

Contains the parameters for CreateTags.

" }, "CreateVolumePermission":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

", "locationName":"userId" }, "Group":{ "shape":"PermissionGroup", "documentation":"

The specific group that is to be added or removed from a volume's list of create volume permissions.

", "locationName":"group" } }, "documentation":"

Describes the user or group to be added or removed from the permissions for a volume.

" }, "CreateVolumePermissionList":{ "type":"list", "member":{ "shape":"CreateVolumePermission", "locationName":"item" } }, "CreateVolumePermissionModifications":{ "type":"structure", "members":{ "Add":{ "shape":"CreateVolumePermissionList", "documentation":"

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

" }, "Remove":{ "shape":"CreateVolumePermissionList", "documentation":"

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

" } }, "documentation":"

Describes modifications to the permissions for a volume.

" }, "CreateVolumeRequest":{ "type":"structure", "required":["AvailabilityZone"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Size":{ "shape":"Integer", "documentation":"

The size of the volume, in GiBs.

Constraints: 1-16384 for gp2, 4-16384 for io1, 500-16384 for st1, 500-16384 for sc1, and 1-1024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot from which to create the volume.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: standard

" }, "Iops":{ "shape":"Integer", "documentation":"

Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If a KmsKeyId is specified, the Encrypted flag must also be set.

" } }, "documentation":"

Contains the parameters for CreateVolume.

" }, "CreateVpcEndpointRequest":{ "type":"structure", "required":[ "VpcId", "ServiceName" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC in which the endpoint will be used.

" }, "ServiceName":{ "shape":"String", "documentation":"

The AWS service name, in the form com.amazonaws.region.service. To get a list of available services, use the DescribeVpcEndpointServices request.

" }, "PolicyDocument":{ "shape":"String", "documentation":"

A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs.

", "locationName":"RouteTableId" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" } }, "documentation":"

Contains the parameters for CreateVpcEndpoint.

" }, "CreateVpcEndpointResult":{ "type":"structure", "members":{ "VpcEndpoint":{ "shape":"VpcEndpoint", "documentation":"

Information about the endpoint.

", "locationName":"vpcEndpoint" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", "locationName":"clientToken" } }, "documentation":"

Contains the output of CreateVpcEndpoint.

" }, "CreateVpcPeeringConnectionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the requester VPC.

", "locationName":"vpcId" }, "PeerVpcId":{ "shape":"String", "documentation":"

The ID of the VPC with which you are creating the VPC peering connection.

", "locationName":"peerVpcId" }, "PeerOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

", "locationName":"peerOwnerId" } }, "documentation":"

Contains the parameters for CreateVpcPeeringConnection.

" }, "CreateVpcPeeringConnectionResult":{ "type":"structure", "members":{ "VpcPeeringConnection":{ "shape":"VpcPeeringConnection", "documentation":"

Information about the VPC peering connection.

", "locationName":"vpcPeeringConnection" } }, "documentation":"

Contains the output of CreateVpcPeeringConnection.

" }, "CreateVpcRequest":{ "type":"structure", "required":["CidrBlock"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

", "locationName":"instanceTenancy" } }, "documentation":"

Contains the parameters for CreateVpc.

" }, "CreateVpcResult":{ "type":"structure", "members":{ "Vpc":{ "shape":"Vpc", "documentation":"

Information about the VPC.

", "locationName":"vpc" } }, "documentation":"

Contains the output of CreateVpc.

" }, "CreateVpnConnectionRequest":{ "type":"structure", "required":[ "Type", "CustomerGatewayId", "VpnGatewayId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Type":{ "shape":"String", "documentation":"

The type of VPN connection (ipsec.1).

" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "Options":{ "shape":"VpnConnectionOptionsSpecification", "documentation":"

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

", "locationName":"options" } }, "documentation":"

Contains the parameters for CreateVpnConnection.

" }, "CreateVpnConnectionResult":{ "type":"structure", "members":{ "VpnConnection":{ "shape":"VpnConnection", "documentation":"

Information about the VPN connection.

", "locationName":"vpnConnection" } }, "documentation":"

Contains the output of CreateVpnConnection.

" }, "CreateVpnConnectionRouteRequest":{ "type":"structure", "required":[ "VpnConnectionId", "DestinationCidrBlock" ], "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer network.

" } }, "documentation":"

Contains the parameters for CreateVpnConnectionRoute.

" }, "CreateVpnGatewayRequest":{ "type":"structure", "required":["Type"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection this virtual private gateway supports.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the virtual private gateway.

" } }, "documentation":"

Contains the parameters for CreateVpnGateway.

" }, "CreateVpnGatewayResult":{ "type":"structure", "members":{ "VpnGateway":{ "shape":"VpnGateway", "documentation":"

Information about the virtual private gateway.

", "locationName":"vpnGateway" } }, "documentation":"

Contains the output of CreateVpnGateway.

" }, "CurrencyCodeValues":{ "type":"string", "enum":["USD"] }, "CustomerGateway":{ "type":"structure", "members":{ "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

", "locationName":"customerGatewayId" }, "State":{ "shape":"String", "documentation":"

The current state of the customer gateway (pending | available | deleting | deleted).

", "locationName":"state" }, "Type":{ "shape":"String", "documentation":"

The type of VPN connection the customer gateway supports (ipsec.1).

", "locationName":"type" }, "IpAddress":{ "shape":"String", "documentation":"

The Internet-routable IP address of the customer gateway's outside interface.

", "locationName":"ipAddress" }, "BgpAsn":{ "shape":"String", "documentation":"

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", "locationName":"bgpAsn" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the customer gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes a customer gateway.

" }, "CustomerGatewayIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"CustomerGatewayId" } }, "CustomerGatewayList":{ "type":"list", "member":{ "shape":"CustomerGateway", "locationName":"item" } }, "DatafeedSubscriptionState":{ "type":"string", "enum":[ "Active", "Inactive" ] }, "DateTime":{"type":"timestamp"}, "DeleteCustomerGatewayRequest":{ "type":"structure", "required":["CustomerGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

" } }, "documentation":"

Contains the parameters for DeleteCustomerGateway.

" }, "DeleteDhcpOptionsRequest":{ "type":"structure", "required":["DhcpOptionsId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the DHCP options set.

" } }, "documentation":"

Contains the parameters for DeleteDhcpOptions.

" }, "DeleteFlowLogsRequest":{ "type":"structure", "required":["FlowLogIds"], "members":{ "FlowLogIds":{ "shape":"ValueStringList", "documentation":"

One or more flow log IDs.

", "locationName":"FlowLogId" } }, "documentation":"

Contains the parameters for DeleteFlowLogs.

" }, "DeleteFlowLogsResult":{ "type":"structure", "members":{ "Unsuccessful":{ "shape":"UnsuccessfulItemSet", "documentation":"

Information about the flow logs that could not be deleted successfully.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of DeleteFlowLogs.

" }, "DeleteInternetGatewayRequest":{ "type":"structure", "required":["InternetGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" } }, "documentation":"

Contains the parameters for DeleteInternetGateway.

" }, "DeleteKeyPairRequest":{ "type":"structure", "required":["KeyName"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

" } }, "documentation":"

Contains the parameters for DeleteKeyPair.

" }, "DeleteNatGatewayRequest":{ "type":"structure", "required":["NatGatewayId"], "members":{ "NatGatewayId":{ "shape":"String", "documentation":"

The ID of the NAT gateway.

" } }, "documentation":"

Contains the parameters for DeleteNatGateway.

" }, "DeleteNatGatewayResult":{ "type":"structure", "members":{ "NatGatewayId":{ "shape":"String", "documentation":"

The ID of the NAT gateway.

", "locationName":"natGatewayId" } }, "documentation":"

Contains the output of DeleteNatGateway.

" }, "DeleteNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Egress" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number of the entry to delete.

", "locationName":"ruleNumber" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether the rule is an egress rule.

", "locationName":"egress" } }, "documentation":"

Contains the parameters for DeleteNetworkAclEntry.

" }, "DeleteNetworkAclRequest":{ "type":"structure", "required":["NetworkAclId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" } }, "documentation":"

Contains the parameters for DeleteNetworkAcl.

" }, "DeleteNetworkInterfaceRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" } }, "documentation":"

Contains the parameters for DeleteNetworkInterface.

" }, "DeletePlacementGroupRequest":{ "type":"structure", "required":["GroupName"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

", "locationName":"groupName" } }, "documentation":"

Contains the parameters for DeletePlacementGroup.

" }, "DeleteRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", "locationName":"destinationCidrBlock" } }, "documentation":"

Contains the parameters for DeleteRoute.

" }, "DeleteRouteTableRequest":{ "type":"structure", "required":["RouteTableId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" } }, "documentation":"

Contains the parameters for DeleteRouteTable.

" }, "DeleteSecurityGroupRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a nondefault VPC.

" } }, "documentation":"

Contains the parameters for DeleteSecurityGroup.

" }, "DeleteSnapshotRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot.

" } }, "documentation":"

Contains the parameters for DeleteSnapshot.

" }, "DeleteSpotDatafeedSubscriptionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for DeleteSpotDatafeedSubscription.

" }, "DeleteSubnetRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

" } }, "documentation":"

Contains the parameters for DeleteSubnet.

" }, "DeleteTagsRequest":{ "type":"structure", "required":["Resources"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Resources":{ "shape":"ResourceIdList", "documentation":"

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

", "locationName":"resourceId" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

", "locationName":"tag" } }, "documentation":"

Contains the parameters for DeleteTags.

" }, "DeleteVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" } }, "documentation":"

Contains the parameters for DeleteVolume.

" }, "DeleteVpcEndpointsRequest":{ "type":"structure", "required":["VpcEndpointIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcEndpointIds":{ "shape":"ValueStringList", "documentation":"

One or more endpoint IDs.

", "locationName":"VpcEndpointId" } }, "documentation":"

Contains the parameters for DeleteVpcEndpoints.

" }, "DeleteVpcEndpointsResult":{ "type":"structure", "members":{ "Unsuccessful":{ "shape":"UnsuccessfulItemSet", "documentation":"

Information about the endpoints that were not successfully deleted.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of DeleteVpcEndpoints.

" }, "DeleteVpcPeeringConnectionRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Contains the parameters for DeleteVpcPeeringConnection.

" }, "DeleteVpcPeeringConnectionResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of DeleteVpcPeeringConnection.

" }, "DeleteVpcRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for DeleteVpc.

" }, "DeleteVpnConnectionRequest":{ "type":"structure", "required":["VpnConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" } }, "documentation":"

Contains the parameters for DeleteVpnConnection.

" }, "DeleteVpnConnectionRouteRequest":{ "type":"structure", "required":[ "VpnConnectionId", "DestinationCidrBlock" ], "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer network.

" } }, "documentation":"

Contains the parameters for DeleteVpnConnectionRoute.

" }, "DeleteVpnGatewayRequest":{ "type":"structure", "required":["VpnGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } }, "documentation":"

Contains the parameters for DeleteVpnGateway.

" }, "DeregisterImageRequest":{ "type":"structure", "required":["ImageId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" } }, "documentation":"

Contains the parameters for DeregisterImage.

" }, "DescribeAccountAttributesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AttributeNames":{ "shape":"AccountAttributeNameStringList", "documentation":"

One or more account attribute names.

", "locationName":"attributeName" } }, "documentation":"

Contains the parameters for DescribeAccountAttributes.

" }, "DescribeAccountAttributesResult":{ "type":"structure", "members":{ "AccountAttributes":{ "shape":"AccountAttributeList", "documentation":"

Information about one or more account attributes.

", "locationName":"accountAttributeSet" } }, "documentation":"

Contains the output of DescribeAccountAttributes.

" }, "DescribeAddressesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIps":{ "shape":"PublicIpStringList", "documentation":"

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", "locationName":"PublicIp" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

", "locationName":"Filter" }, "AllocationIds":{ "shape":"AllocationIdList", "documentation":"

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

", "locationName":"AllocationId" } }, "documentation":"

Contains the parameters for DescribeAddresses.

" }, "DescribeAddressesResult":{ "type":"structure", "members":{ "Addresses":{ "shape":"AddressList", "documentation":"

Information about one or more Elastic IP addresses.

", "locationName":"addressesSet" } }, "documentation":"

Contains the output of DescribeAddresses.

" }, "DescribeAvailabilityZonesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ZoneNames":{ "shape":"ZoneNameStringList", "documentation":"

The names of one or more Availability Zones.

", "locationName":"ZoneName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | information | impaired | unavailable).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeAvailabilityZones.

" }, "DescribeAvailabilityZonesResult":{ "type":"structure", "members":{ "AvailabilityZones":{ "shape":"AvailabilityZoneList", "documentation":"

Information about one or more Availability Zones.

", "locationName":"availabilityZoneInfo" } }, "documentation":"

Contains the output of DescribeAvailabiltyZones.

" }, "DescribeBundleTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "BundleIds":{ "shape":"BundleIdStringList", "documentation":"

One or more bundle task IDs.

Default: Describes all your bundle tasks.

", "locationName":"BundleId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeBundleTasks.

" }, "DescribeBundleTasksResult":{ "type":"structure", "members":{ "BundleTasks":{ "shape":"BundleTaskList", "documentation":"

Information about one or more bundle tasks.

", "locationName":"bundleInstanceTasksSet" } }, "documentation":"

Contains the output of DescribeBundleTasks.

" }, "DescribeClassicLinkInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC that the instance is linked to.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeClassicLinkInstances.

" }, "DescribeClassicLinkInstancesResult":{ "type":"structure", "members":{ "Instances":{ "shape":"ClassicLinkInstanceList", "documentation":"

Information about one or more linked EC2-Classic instances.

", "locationName":"instancesSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeClassicLinkInstances.

" }, "DescribeConversionTaskList":{ "type":"list", "member":{ "shape":"ConversionTask", "locationName":"item" } }, "DescribeConversionTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

", "locationName":"filter" }, "ConversionTaskIds":{ "shape":"ConversionIdStringList", "documentation":"

One or more conversion task IDs.

", "locationName":"conversionTaskId" } }, "documentation":"

Contains the parameters for DescribeConversionTasks.

" }, "DescribeConversionTasksResult":{ "type":"structure", "members":{ "ConversionTasks":{ "shape":"DescribeConversionTaskList", "documentation":"

Information about the conversion tasks.

", "locationName":"conversionTasks" } }, "documentation":"

Contains the output for DescribeConversionTasks.

" }, "DescribeCustomerGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "CustomerGatewayIds":{ "shape":"CustomerGatewayIdStringList", "documentation":"

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", "locationName":"CustomerGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeCustomerGateways.

" }, "DescribeCustomerGatewaysResult":{ "type":"structure", "members":{ "CustomerGateways":{ "shape":"CustomerGatewayList", "documentation":"

Information about one or more customer gateways.

", "locationName":"customerGatewaySet" } }, "documentation":"

Contains the output of DescribeCustomerGateways.

" }, "DescribeDhcpOptionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpOptionsIds":{ "shape":"DhcpOptionsIdStringList", "documentation":"

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", "locationName":"DhcpOptionsId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • dhcp-options-id - The ID of a set of DHCP options.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeDhcpOptions.

" }, "DescribeDhcpOptionsResult":{ "type":"structure", "members":{ "DhcpOptions":{ "shape":"DhcpOptionsList", "documentation":"

Information about one or more DHCP options sets.

", "locationName":"dhcpOptionsSet" } }, "documentation":"

Contains the output of DescribeDhcpOptions.

" }, "DescribeExportTasksRequest":{ "type":"structure", "members":{ "ExportTaskIds":{ "shape":"ExportTaskIdStringList", "documentation":"

One or more export task IDs.

", "locationName":"exportTaskId" } }, "documentation":"

Contains the parameters for DescribeExportTasks.

" }, "DescribeExportTasksResult":{ "type":"structure", "members":{ "ExportTasks":{ "shape":"ExportTaskList", "documentation":"

Information about the export tasks.

", "locationName":"exportTaskSet" } }, "documentation":"

Contains the output for DescribeExportTasks.

" }, "DescribeFlowLogsRequest":{ "type":"structure", "members":{ "FlowLogIds":{ "shape":"ValueStringList", "documentation":"

One or more flow log IDs.

", "locationName":"FlowLogId" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

  • flow-log-id - The ID of the flow log.

  • log-group-name - The name of the log group.

  • resource-id - The ID of the VPC, subnet, or network interface.

  • traffic-type - The type of traffic (ACCEPT | REJECT | ALL)

" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the flow log IDs parameter in the same request.

" } }, "documentation":"

Contains the parameters for DescribeFlowLogs.

" }, "DescribeFlowLogsResult":{ "type":"structure", "members":{ "FlowLogs":{ "shape":"FlowLogSet", "documentation":"

Information about the flow logs.

", "locationName":"flowLogSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeFlowLogs.

" }, "DescribeHostsRequest":{ "type":"structure", "members":{ "HostIds":{ "shape":"RequestHostIdList", "documentation":"

The IDs of the Dedicated hosts. The IDs are used for targeted instance launches.

", "locationName":"hostId" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error. You cannot specify this parameter and the host IDs parameter in the same request.

", "locationName":"maxResults" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • instance-type - The instance type size that the Dedicated host is configured to support.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • host-reservation-id - The ID of the reservation associated with this host.

  • client-token - The idempotency token you provided when you launched the instance

  • state- The allocation state of the Dedicated host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • availability-zone - The Availability Zone of the host.

", "locationName":"filter" } }, "documentation":"

Contains the parameters for DescribeHosts.

" }, "DescribeHostsResult":{ "type":"structure", "members":{ "Hosts":{ "shape":"HostList", "documentation":"

Information about the Dedicated hosts.

", "locationName":"hostSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeHosts.

" }, "DescribeIdFormatRequest":{ "type":"structure", "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource.

" } }, "documentation":"

Contains the parameters for DescribeIdFormat.

" }, "DescribeIdFormatResult":{ "type":"structure", "members":{ "Statuses":{ "shape":"IdFormatList", "documentation":"

Information about the ID format for the resource.

", "locationName":"statusSet" } }, "documentation":"

Contains the output of DescribeIdFormat.

" }, "DescribeImageAttributeRequest":{ "type":"structure", "required":[ "ImageId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"ImageAttributeName", "documentation":"

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

" } }, "documentation":"

Contains the parameters for DescribeImageAttribute.

" }, "DescribeImagesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageIds":{ "shape":"ImageIdStringList", "documentation":"

One or more image IDs.

Default: Describes all images available to you.

", "locationName":"ImageId" }, "Owners":{ "shape":"OwnerStringList", "documentation":"

Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

", "locationName":"Owner" }, "ExecutableUsers":{ "shape":"ExecutableByStringList", "documentation":"

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", "locationName":"ExecutableBy" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • architecture - The image architecture (i386 | x86_64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

  • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

  • description - The description of the image (provided during image creation).

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - The AWS account alias (for example, amazon).

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeImages.

" }, "DescribeImagesResult":{ "type":"structure", "members":{ "Images":{ "shape":"ImageList", "documentation":"

Information about one or more images.

", "locationName":"imagesSet" } }, "documentation":"

Contains the output of DescribeImages.

" }, "DescribeImportImageTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ImportTaskIds":{ "shape":"ImportTaskIdList", "documentation":"

A list of import image task IDs.

", "locationName":"ImportTaskId" }, "NextToken":{ "shape":"String", "documentation":"

A token that indicates the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" }, "Filters":{ "shape":"FilterList", "documentation":"

Filter tasks using the task-state filter and one of the following values: active, completed, deleting, deleted.

" } }, "documentation":"

Contains the parameters for DescribeImportImageTasks.

" }, "DescribeImportImageTasksResult":{ "type":"structure", "members":{ "ImportImageTasks":{ "shape":"ImportImageTaskList", "documentation":"

A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.

", "locationName":"importImageTaskSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output for DescribeImportImageTasks.

" }, "DescribeImportSnapshotTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ImportTaskIds":{ "shape":"ImportTaskIdList", "documentation":"

A list of import snapshot task IDs.

", "locationName":"ImportTaskId" }, "NextToken":{ "shape":"String", "documentation":"

A token that indicates the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

" } }, "documentation":"

Contains the parameters for DescribeImportSnapshotTasks.

" }, "DescribeImportSnapshotTasksResult":{ "type":"structure", "members":{ "ImportSnapshotTasks":{ "shape":"ImportSnapshotTaskList", "documentation":"

A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.

", "locationName":"importSnapshotTaskSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output for DescribeImportSnapshotTasks.

" }, "DescribeInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The instance attribute.

", "locationName":"attribute" } }, "documentation":"

Contains the parameters for DescribeInstanceAttribute.

" }, "DescribeInstanceStatusRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

" }, "IncludeAllInstances":{ "shape":"Boolean", "documentation":"

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", "locationName":"includeAllInstances" } }, "documentation":"

Contains the parameters for DescribeInstanceStatus.

" }, "DescribeInstanceStatusResult":{ "type":"structure", "members":{ "InstanceStatuses":{ "shape":"InstanceStatusList", "documentation":"

One or more instance status descriptions.

", "locationName":"instanceStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeInstanceStatus.

" }, "DescribeInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Default: Describes all your instances.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • affinity - The affinity setting for an instance running on a Dedicated host (default | host).

  • architecture - The instance architecture (i386 | x86_64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • host-Id - The ID of the Dedicated host on which the instance is running, if applicable.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IP address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - 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 - The time when the instance was launched.

  • monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.

  • private-dns-name - The private DNS name of the instance.

  • private-ip-address - The private IP address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - 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 - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - 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 - The name of the root device for the instance (for example, /dev/sda1 or /dev/xvda).

  • root-device-type - The type of root device that the instance uses (ebs | instance-store).

  • source-dest-check - 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 - The ID of the Spot instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • tenancy - The tenancy of an instance (dedicated | default | host).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

  • network-interface.description - The description of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface.private-dns-name - The private DNS name of the network interface.

  • network-interface.source-dest-check - 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.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.addresses.private-ip-address - The private IP address associated with the network interface.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to request the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter or tag filters in the same call.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeInstances.

" }, "DescribeInstancesResult":{ "type":"structure", "members":{ "Reservations":{ "shape":"ReservationList", "documentation":"

Zero or more reservations.

", "locationName":"reservationSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeInstances.

" }, "DescribeInternetGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayIds":{ "shape":"ValueStringList", "documentation":"

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

", "locationName":"internetGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeInternetGateways.

" }, "DescribeInternetGatewaysResult":{ "type":"structure", "members":{ "InternetGateways":{ "shape":"InternetGatewayList", "documentation":"

Information about one or more Internet gateways.

", "locationName":"internetGatewaySet" } }, "documentation":"

Contains the output of DescribeInternetGateways.

" }, "DescribeKeyPairsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyNames":{ "shape":"KeyNameStringList", "documentation":"

One or more key pair names.

Default: Describes all your key pairs.

", "locationName":"KeyName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeKeyPairs.

" }, "DescribeKeyPairsResult":{ "type":"structure", "members":{ "KeyPairs":{ "shape":"KeyPairList", "documentation":"

Information about one or more key pairs.

", "locationName":"keySet" } }, "documentation":"

Contains the output of DescribeKeyPairs.

" }, "DescribeMovingAddressesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIps":{ "shape":"ValueStringList", "documentation":"

One or more Elastic IP addresses.

", "locationName":"publicIp" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results.

", "locationName":"nextToken" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).

", "locationName":"filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.

Default: If no value is provided, the default is 1000.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeMovingAddresses.

" }, "DescribeMovingAddressesResult":{ "type":"structure", "members":{ "MovingAddressStatuses":{ "shape":"MovingAddressStatusSet", "documentation":"

The status for each Elastic IP address.

", "locationName":"movingAddressStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeMovingAddresses.

" }, "DescribeNatGatewaysRequest":{ "type":"structure", "members":{ "NatGatewayIds":{ "shape":"ValueStringList", "documentation":"

One or more NAT gateway IDs.

", "locationName":"NatGatewayId" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

  • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" } }, "documentation":"

Contains the parameters for DescribeNatGateways.

" }, "DescribeNatGatewaysResult":{ "type":"structure", "members":{ "NatGateways":{ "shape":"NatGatewayList", "documentation":"

Information about the NAT gateways.

", "locationName":"natGatewaySet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeNatGateways.

" }, "DescribeNetworkAclsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclIds":{ "shape":"ValueStringList", "documentation":"

One or more network ACL IDs.

Default: Describes all your network ACLs.

", "locationName":"NetworkAclId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The CIDR range specified in the entry.

  • entry.egress - Indicates whether the entry applies to egress traffic.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.

  • network-acl-id - The ID of the network ACL.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network ACL.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeNetworkAcls.

" }, "DescribeNetworkAclsResult":{ "type":"structure", "members":{ "NetworkAcls":{ "shape":"NetworkAclList", "documentation":"

Information about one or more network ACLs.

", "locationName":"networkAclSet" } }, "documentation":"

Contains the output of DescribeNetworkAcls.

" }, "DescribeNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Attribute":{ "shape":"NetworkInterfaceAttribute", "documentation":"

The attribute of the network interface.

", "locationName":"attribute" } }, "documentation":"

Contains the parameters for DescribeNetworkInterfaceAttribute.

" }, "DescribeNetworkInterfaceAttributeResult":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Description":{ "shape":"AttributeValue", "documentation":"

The description of the network interface.

", "locationName":"description" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

The security groups associated with the network interface.

", "locationName":"groupSet" }, "Attachment":{ "shape":"NetworkInterfaceAttachment", "documentation":"

The attachment (if any) of the network interface.

", "locationName":"attachment" } }, "documentation":"

Contains the output of DescribeNetworkInterfaceAttribute.

" }, "DescribeNetworkInterfacesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceIds":{ "shape":"NetworkInterfaceIdList", "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", "locationName":"NetworkInterfaceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IP addresses associated with the network interface.

  • addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface.

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.attach.time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.nat-gateway-id - The ID of the NAT gateway to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IP address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-desk-check - 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 - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network interface.

", "locationName":"filter" } }, "documentation":"

Contains the parameters for DescribeNetworkInterfaces.

" }, "DescribeNetworkInterfacesResult":{ "type":"structure", "members":{ "NetworkInterfaces":{ "shape":"NetworkInterfaceList", "documentation":"

Information about one or more network interfaces.

", "locationName":"networkInterfaceSet" } }, "documentation":"

Contains the output of DescribeNetworkInterfaces.

" }, "DescribePlacementGroupsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupNames":{ "shape":"PlacementGroupStringList", "documentation":"

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

", "locationName":"groupName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribePlacementGroups.

" }, "DescribePlacementGroupsResult":{ "type":"structure", "members":{ "PlacementGroups":{ "shape":"PlacementGroupList", "documentation":"

One or more placement groups.

", "locationName":"placementGroupSet" } }, "documentation":"

Contains the output of DescribePlacementGroups.

" }, "DescribePrefixListsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "PrefixListIds":{ "shape":"ValueStringList", "documentation":"

One or more prefix list IDs.

", "locationName":"PrefixListId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • prefix-list-id: The ID of a prefix list.

  • prefix-list-name: The name of a prefix list.

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } }, "documentation":"

Contains the parameters for DescribePrefixLists.

" }, "DescribePrefixListsResult":{ "type":"structure", "members":{ "PrefixLists":{ "shape":"PrefixListSet", "documentation":"

All available prefix lists.

", "locationName":"prefixListSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribePrefixLists.

" }, "DescribeRegionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RegionNames":{ "shape":"RegionNameStringList", "documentation":"

The names of one or more regions.

", "locationName":"RegionName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

  • region-name - The name of the region (for example, us-east-1).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeRegions.

" }, "DescribeRegionsResult":{ "type":"structure", "members":{ "Regions":{ "shape":"RegionList", "documentation":"

Information about one or more regions.

", "locationName":"regionInfo" } }, "documentation":"

Contains the output of DescribeRegions.

" }, "DescribeReservedInstancesListingsRequest":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

One or more Reserved Instance IDs.

", "locationName":"reservedInstancesId" }, "ReservedInstancesListingId":{ "shape":"String", "documentation":"

One or more Reserved Instance listing IDs.

", "locationName":"reservedInstancesListingId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", "locationName":"filters" } }, "documentation":"

Contains the parameters for DescribeReservedInstancesListings.

" }, "DescribeReservedInstancesListingsResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

Information about the Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } }, "documentation":"

Contains the output of DescribeReservedInstancesListings.

" }, "DescribeReservedInstancesModificationsRequest":{ "type":"structure", "members":{ "ReservedInstancesModificationIds":{ "shape":"ReservedInstancesModificationIdStringList", "documentation":"

IDs for the submitted modification request.

", "locationName":"ReservedInstancesModificationId" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeReservedInstancesModifications.

" }, "DescribeReservedInstancesModificationsResult":{ "type":"structure", "members":{ "ReservedInstancesModifications":{ "shape":"ReservedInstancesModificationList", "documentation":"

The Reserved Instance modification information.

", "locationName":"reservedInstancesModificationsSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeReservedInstancesModifications.

" }, "DescribeReservedInstancesOfferingsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ReservedInstancesOfferingIds":{ "shape":"ReservedInstancesOfferingIdStringList", "documentation":"

One or more Reserved Instances offering IDs.

", "locationName":"ReservedInstancesOfferingId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", "locationName":"Filter" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

Default: default

", "locationName":"instanceTenancy" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", "locationName":"offeringType" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

", "locationName":"maxResults" }, "IncludeMarketplace":{ "shape":"Boolean", "documentation":"

Include Reserved Instance Marketplace offerings in the response.

" }, "MinDuration":{ "shape":"Long", "documentation":"

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

" }, "MaxDuration":{ "shape":"Long", "documentation":"

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

" }, "MaxInstanceCount":{ "shape":"Integer", "documentation":"

The maximum number of instances to filter when searching for offerings.

Default: 20

" } }, "documentation":"

Contains the parameters for DescribeReservedInstancesOfferings.

" }, "DescribeReservedInstancesOfferingsResult":{ "type":"structure", "members":{ "ReservedInstancesOfferings":{ "shape":"ReservedInstancesOfferingList", "documentation":"

A list of Reserved Instances offerings.

", "locationName":"reservedInstancesOfferingsSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeReservedInstancesOfferings.

" }, "DescribeReservedInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ReservedInstancesIds":{ "shape":"ReservedInstancesIdStringList", "documentation":"

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

", "locationName":"ReservedInstancesId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", "locationName":"Filter" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", "locationName":"offeringType" } }, "documentation":"

Contains the parameters for DescribeReservedInstances.

" }, "DescribeReservedInstancesResult":{ "type":"structure", "members":{ "ReservedInstances":{ "shape":"ReservedInstancesList", "documentation":"

A list of Reserved Instances.

", "locationName":"reservedInstancesSet" } }, "documentation":"

Contains the output for DescribeReservedInstances.

" }, "DescribeRouteTablesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs.

Default: Describes all your route tables.

", "locationName":"RouteTableId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC (true | false).

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The CIDR range specified in a route in the table.

  • route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.nat-gateway-id - The ID of a NAT gateway.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). 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).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the route table.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeRouteTables.

" }, "DescribeRouteTablesResult":{ "type":"structure", "members":{ "RouteTables":{ "shape":"RouteTableList", "documentation":"

Information about one or more route tables.

", "locationName":"routeTableSet" } }, "documentation":"

Contains the output of DescribeRouteTables.

" }, "DescribeScheduledInstanceAvailabilityRequest":{ "type":"structure", "required":[ "Recurrence", "FirstSlotStartTimeRange" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "Recurrence":{ "shape":"ScheduledInstanceRecurrenceRequest", "documentation":"

The schedule recurrence.

" }, "FirstSlotStartTimeRange":{ "shape":"SlotDateTimeRangeRequest", "documentation":"

The time period for the first schedule to start.

" }, "MinSlotDurationInHours":{ "shape":"Integer", "documentation":"

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

" }, "MaxSlotDurationInHours":{ "shape":"Integer", "documentation":"

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned NextToken value.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeScheduledInstanceAvailability.

" }, "DescribeScheduledInstanceAvailabilityResult":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" }, "ScheduledInstanceAvailabilitySet":{ "shape":"ScheduledInstanceAvailabilitySet", "documentation":"

Information about the available Scheduled Instances.

", "locationName":"scheduledInstanceAvailabilitySet" } }, "documentation":"

Contains the output of DescribeScheduledInstanceAvailability.

" }, "DescribeScheduledInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ScheduledInstanceIds":{ "shape":"ScheduledInstanceIdRequestSet", "documentation":"

One or more Scheduled Instance IDs.

", "locationName":"ScheduledInstanceId" }, "SlotStartTimeRange":{ "shape":"SlotStartTimeRangeRequest", "documentation":"

The time period for the first schedule to start.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeScheduledInstances.

" }, "DescribeScheduledInstancesResult":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" }, "ScheduledInstanceSet":{ "shape":"ScheduledInstanceSet", "documentation":"

Information about the Scheduled Instances.

", "locationName":"scheduledInstanceSet" } }, "documentation":"

Contains the output of DescribeScheduledInstances.

" }, "DescribeSecurityGroupReferencesRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "GroupId":{ "shape":"GroupIds", "documentation":"

One or more security group IDs in your account.

" } } }, "DescribeSecurityGroupReferencesResult":{ "type":"structure", "members":{ "SecurityGroupReferenceSet":{ "shape":"SecurityGroupReferences", "documentation":"

Information about the VPCs with the referencing security groups.

", "locationName":"securityGroupReferenceSet" } } }, "DescribeSecurityGroupsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupNames":{ "shape":"GroupNameStringList", "documentation":"

[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

", "locationName":"GroupName" }, "GroupIds":{ "shape":"GroupIdStringList", "documentation":"

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

", "locationName":"GroupId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which the security group allows access.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - A CIDR range that has been granted permission.

  • ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been granted permission.

  • ip-permission.group-name - The name of a security group that has been granted permission.

  • ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been granted permission.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag-key - The key of a tag assigned to the security group.

  • tag-value - The value of a tag assigned to the security group.

  • vpc-id - The ID of the VPC specified when the security group was created.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeSecurityGroups.

" }, "DescribeSecurityGroupsResult":{ "type":"structure", "members":{ "SecurityGroups":{ "shape":"SecurityGroupList", "documentation":"

Information about one or more security groups.

", "locationName":"securityGroupInfo" } }, "documentation":"

Contains the output of DescribeSecurityGroups.

" }, "DescribeSnapshotAttributeRequest":{ "type":"structure", "required":[ "SnapshotId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The snapshot attribute you would like to view.

" } }, "documentation":"

Contains the parameters for DescribeSnapshotAttribute.

" }, "DescribeSnapshotAttributeResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot.

", "locationName":"snapshotId" }, "CreateVolumePermissions":{ "shape":"CreateVolumePermissionList", "documentation":"

A list of permissions for creating volumes from the snapshot.

", "locationName":"createVolumePermission" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" } }, "documentation":"

Contains the output of DescribeSnapshotAttribute.

" }, "DescribeSnapshotsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotIds":{ "shape":"SnapshotIdStringList", "documentation":"

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

", "locationName":"SnapshotId" }, "OwnerIds":{ "shape":"OwnerStringList", "documentation":"

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

", "locationName":"Owner" }, "RestorableByUserIds":{ "shape":"RestorableByStringList", "documentation":"

One or more AWS accounts IDs that can create volumes from the snapshot.

", "locationName":"RestorableBy" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • description - A description of the snapshot.

  • owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

  • owner-id - The ID of the AWS account that owns the snapshot.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

" } }, "documentation":"

Contains the parameters for DescribeSnapshots.

" }, "DescribeSnapshotsResult":{ "type":"structure", "members":{ "Snapshots":{ "shape":"SnapshotList", "documentation":"

Information about the snapshots.

", "locationName":"snapshotSet" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSnapshots.

" }, "DescribeSpotDatafeedSubscriptionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for DescribeSpotDatafeedSubscription.

" }, "DescribeSpotDatafeedSubscriptionResult":{ "type":"structure", "members":{ "SpotDatafeedSubscription":{ "shape":"SpotDatafeedSubscription", "documentation":"

The Spot instance data feed subscription.

", "locationName":"spotDatafeedSubscription" } }, "documentation":"

Contains the output of DescribeSpotDatafeedSubscription.

" }, "DescribeSpotFleetInstancesRequest":{ "type":"structure", "required":["SpotFleetRequestId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeSpotFleetInstances.

" }, "DescribeSpotFleetInstancesResponse":{ "type":"structure", "required":[ "SpotFleetRequestId", "ActiveInstances" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "ActiveInstances":{ "shape":"ActiveInstanceSet", "documentation":"

The running instances. Note that this list is refreshed periodically and might be out of date.

", "locationName":"activeInstanceSet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotFleetInstances.

" }, "DescribeSpotFleetRequestHistoryRequest":{ "type":"structure", "required":[ "SpotFleetRequestId", "StartTime" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "EventType":{ "shape":"EventType", "documentation":"

The type of events to describe. By default, all events are described.

", "locationName":"eventType" }, "StartTime":{ "shape":"DateTime", "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"startTime" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeSpotFleetRequestHistory.

" }, "DescribeSpotFleetRequestHistoryResponse":{ "type":"structure", "required":[ "SpotFleetRequestId", "StartTime", "LastEvaluatedTime", "HistoryRecords" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "StartTime":{ "shape":"DateTime", "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"startTime" }, "LastEvaluatedTime":{ "shape":"DateTime", "documentation":"

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

If nextToken indicates that there are more results, this value is not present.

", "locationName":"lastEvaluatedTime" }, "HistoryRecords":{ "shape":"HistoryRecords", "documentation":"

Information about the events in the history of the Spot fleet request.

", "locationName":"historyRecordSet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotFleetRequestHistory.

" }, "DescribeSpotFleetRequestsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestIds":{ "shape":"ValueStringList", "documentation":"

The IDs of the Spot fleet requests.

", "locationName":"spotFleetRequestId" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeSpotFleetRequests.

" }, "DescribeSpotFleetRequestsResponse":{ "type":"structure", "required":["SpotFleetRequestConfigs"], "members":{ "SpotFleetRequestConfigs":{ "shape":"SpotFleetRequestConfigSet", "documentation":"

Information about the configuration of your Spot fleet.

", "locationName":"spotFleetRequestConfigSet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotFleetRequests.

" }, "DescribeSpotInstanceRequestsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotInstanceRequestIds":{ "shape":"SpotInstanceRequestIdList", "documentation":"

One or more Spot instance request IDs.

", "locationName":"SpotInstanceRequestId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume: gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.

  • launch.group-id - The security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m3.medium).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether monitoring is enabled for the Spot instance.

  • launch.ramdisk-id - The RAM disk ID.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • network-interface.description - A description of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.group-name - The name of the security group associated with the network interface.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot instance request ID.

  • spot-price - The maximum hourly price for any Spot instance launched to fulfill the request.

  • state - The state of the Spot instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

  • status-code - The short code describing the most recent evaluation of your Spot instance request.

  • status-message - The message explaining the status of the Spot instance request.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of Spot instance request (one-time | persistent).

  • launched-availability-zone - The Availability Zone in which the bid is launched.

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeSpotInstanceRequests.

" }, "DescribeSpotInstanceRequestsResult":{ "type":"structure", "members":{ "SpotInstanceRequests":{ "shape":"SpotInstanceRequestList", "documentation":"

One or more Spot instance requests.

", "locationName":"spotInstanceRequestSet" } }, "documentation":"

Contains the output of DescribeSpotInstanceRequests.

" }, "DescribeSpotPriceHistoryRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "StartTime":{ "shape":"DateTime", "documentation":"

The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"startTime" }, "EndTime":{ "shape":"DateTime", "documentation":"

The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"endTime" }, "InstanceTypes":{ "shape":"InstanceTypeList", "documentation":"

Filters the results by the specified instance types.

", "locationName":"InstanceType" }, "ProductDescriptions":{ "shape":"ProductDescriptionList", "documentation":"

Filters the results by the specified basic product descriptions.

", "locationName":"ProductDescription" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m3.medium).

  • product-description - The product description for the Spot price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - The timestamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

", "locationName":"Filter" }, "AvailabilityZone":{ "shape":"String", "documentation":"

Filters the results by the specified Availability Zone.

", "locationName":"availabilityZone" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" } }, "documentation":"

Contains the parameters for DescribeSpotPriceHistory.

" }, "DescribeSpotPriceHistoryResult":{ "type":"structure", "members":{ "SpotPriceHistory":{ "shape":"SpotPriceHistoryList", "documentation":"

The historical Spot prices.

", "locationName":"spotPriceHistorySet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotPriceHistory.

" }, "DescribeStaleSecurityGroupsRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } } }, "DescribeStaleSecurityGroupsResult":{ "type":"structure", "members":{ "StaleSecurityGroupSet":{ "shape":"StaleSecurityGroupSet", "documentation":"

Information about the stale security groups.

", "locationName":"staleSecurityGroupSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } } }, "DescribeSubnetsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SubnetIds":{ "shape":"SubnetIdStringList", "documentation":"

One or more subnet IDs.

Default: Describes all your subnets.

", "locationName":"SubnetId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

  • available-ip-address-count - The number of IP addresses in the subnet that are available.

  • cidrBlock - 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. You can also use cidr or cidr-block as the filter names.

  • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

  • state - The state of the subnet (pending | available).

  • subnet-id - The ID of the subnet.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the subnet.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeSubnets.

" }, "DescribeSubnetsResult":{ "type":"structure", "members":{ "Subnets":{ "shape":"SubnetList", "documentation":"

Information about one or more subnets.

", "locationName":"subnetSet" } }, "documentation":"

Contains the output of DescribeSubnets.

" }, "DescribeTagsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • key - The tag key.

  • resource-id - The resource ID.

  • resource-type - The resource type (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).

  • value - The tag value.

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" } }, "documentation":"

Contains the parameters for DescribeTags.

" }, "DescribeTagsResult":{ "type":"structure", "members":{ "Tags":{ "shape":"TagDescriptionList", "documentation":"

A list of tags.

", "locationName":"tagSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return..

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeTags.

" }, "DescribeVolumeAttributeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "Attribute":{ "shape":"VolumeAttributeName", "documentation":"

The instance attribute.

" } }, "documentation":"

Contains the parameters for DescribeVolumeAttribute.

" }, "DescribeVolumeAttributeResult":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "AutoEnableIO":{ "shape":"AttributeBooleanValue", "documentation":"

The state of autoEnableIO attribute.

", "locationName":"autoEnableIO" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" } }, "documentation":"

Contains the output of DescribeVolumeAttribute.

" }, "DescribeVolumeStatusRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeIds":{ "shape":"VolumeIdStringList", "documentation":"

One or more volume IDs.

Default: Describes all your volumes.

", "locationName":"VolumeId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

" } }, "documentation":"

Contains the parameters for DescribeVolumeStatus.

" }, "DescribeVolumeStatusResult":{ "type":"structure", "members":{ "VolumeStatuses":{ "shape":"VolumeStatusList", "documentation":"

A list of volumes.

", "locationName":"volumeStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVolumeStatus.

" }, "DescribeVolumesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeIds":{ "shape":"VolumeIdStringList", "documentation":"

One or more volume IDs.

", "locationName":"VolumeId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - The encryption status of the volume.

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The status of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeVolumes.

" }, "DescribeVolumesResult":{ "type":"structure", "members":{ "Volumes":{ "shape":"VolumeList", "documentation":"

Information about the volumes.

", "locationName":"volumeSet" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVolumes.

" }, "DescribeVpcAttributeRequest":{ "type":"structure", "required":[ "VpcId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "Attribute":{ "shape":"VpcAttributeName", "documentation":"

The VPC attribute.

" } }, "documentation":"

Contains the parameters for DescribeVpcAttribute.

" }, "DescribeVpcAttributeResult":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "EnableDnsSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

", "locationName":"enableDnsSupport" }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

", "locationName":"enableDnsHostnames" } }, "documentation":"

Contains the output of DescribeVpcAttribute.

" }, "DescribeVpcClassicLinkDnsSupportRequest":{ "type":"structure", "members":{ "VpcIds":{ "shape":"VpcClassicLinkIdList", "documentation":"

One or more VPC IDs.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

", "locationName":"nextToken" } }, "documentation":"

Contains the parameters for DescribeVpcClassicLinkDnsSupport.

" }, "DescribeVpcClassicLinkDnsSupportResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"ClassicLinkDnsSupportList", "documentation":"

Information about the ClassicLink DNS support status of the VPCs.

", "locationName":"vpcs" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVpcClassicLinkDnsSupport.

" }, "DescribeVpcClassicLinkRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcIds":{ "shape":"VpcClassicLinkIdList", "documentation":"

One or more VPCs for which you want to describe the ClassicLink status.

", "locationName":"VpcId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpcClassicLink.

" }, "DescribeVpcClassicLinkResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"VpcClassicLinkList", "documentation":"

The ClassicLink status of one or more VPCs.

", "locationName":"vpcSet" } }, "documentation":"

Contains the output of DescribeVpcClassicLink.

" }, "DescribeVpcEndpointServicesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } }, "documentation":"

Contains the parameters for DescribeVpcEndpointServices.

" }, "DescribeVpcEndpointServicesResult":{ "type":"structure", "members":{ "ServiceNames":{ "shape":"ValueStringList", "documentation":"

A list of supported AWS services.

", "locationName":"serviceNameSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVpcEndpointServices.

" }, "DescribeVpcEndpointsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcEndpointIds":{ "shape":"ValueStringList", "documentation":"

One or more endpoint IDs.

", "locationName":"VpcEndpointId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • service-name: The name of the AWS service.

  • vpc-id: The ID of the VPC in which the endpoint resides.

  • vpc-endpoint-id: The ID of the endpoint.

  • vpc-endpoint-state: The state of the endpoint. (pending | available | deleting | deleted)

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } }, "documentation":"

Contains the parameters for DescribeVpcEndpoints.

" }, "DescribeVpcEndpointsResult":{ "type":"structure", "members":{ "VpcEndpoints":{ "shape":"VpcEndpointSet", "documentation":"

Information about the endpoints.

", "locationName":"vpcEndpointSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVpcEndpoints.

" }, "DescribeVpcPeeringConnectionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionIds":{ "shape":"ValueStringList", "documentation":"

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

", "locationName":"VpcPeeringConnectionId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

  • accepter-vpc-info.vpc-id - The ID of the peer VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpcPeeringConnections.

" }, "DescribeVpcPeeringConnectionsResult":{ "type":"structure", "members":{ "VpcPeeringConnections":{ "shape":"VpcPeeringConnectionList", "documentation":"

Information about the VPC peering connections.

", "locationName":"vpcPeeringConnectionSet" } }, "documentation":"

Contains the output of DescribeVpcPeeringConnections.

" }, "DescribeVpcsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcIds":{ "shape":"VpcIdStringList", "documentation":"

One or more VPC IDs.

Default: Describes all your VPCs.

", "locationName":"VpcId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • cidr - 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. Must contain the slash followed by one or two digits (for example, /28).

  • dhcp-options-id - The ID of a set of DHCP options.

  • isDefault - Indicates whether the VPC is the default VPC.

  • state - The state of the VPC (pending | available).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpcs.

" }, "DescribeVpcsResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"VpcList", "documentation":"

Information about one or more VPCs.

", "locationName":"vpcSet" } }, "documentation":"

Contains the output of DescribeVpcs.

" }, "DescribeVpnConnectionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnConnectionIds":{ "shape":"VpnConnectionIdStringList", "documentation":"

One or more VPN connection IDs.

Default: Describes your VPN connections.

", "locationName":"VpnConnectionId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpnConnections.

" }, "DescribeVpnConnectionsResult":{ "type":"structure", "members":{ "VpnConnections":{ "shape":"VpnConnectionList", "documentation":"

Information about one or more VPN connections.

", "locationName":"vpnConnectionSet" } }, "documentation":"

Contains the output of DescribeVpnConnections.

" }, "DescribeVpnGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayIds":{ "shape":"VpnGatewayIdStringList", "documentation":"

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

", "locationName":"VpnGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway (if applicable).

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpnGateways.

" }, "DescribeVpnGatewaysResult":{ "type":"structure", "members":{ "VpnGateways":{ "shape":"VpnGatewayList", "documentation":"

Information about one or more virtual private gateways.

", "locationName":"vpnGatewaySet" } }, "documentation":"

Contains the output of DescribeVpnGateways.

" }, "DetachClassicLinkVpcRequest":{ "type":"structure", "required":[ "InstanceId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance to unlink from the VPC.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC to which the instance is linked.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for DetachClassicLinkVpc.

" }, "DetachClassicLinkVpcResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of DetachClassicLinkVpc.

" }, "DetachInternetGatewayRequest":{ "type":"structure", "required":[ "InternetGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for DetachInternetGateway.

" }, "DetachNetworkInterfaceRequest":{ "type":"structure", "required":["AttachmentId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AttachmentId":{ "shape":"String", "documentation":"

The ID of the attachment.

", "locationName":"attachmentId" }, "Force":{ "shape":"Boolean", "documentation":"

Specifies whether to force a detachment.

", "locationName":"force" } }, "documentation":"

Contains the parameters for DetachNetworkInterface.

" }, "DetachVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "Device":{ "shape":"String", "documentation":"

The device name.

" }, "Force":{ "shape":"Boolean", "documentation":"

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

" } }, "documentation":"

Contains the parameters for DetachVolume.

" }, "DetachVpnGatewayRequest":{ "type":"structure", "required":[ "VpnGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for DetachVpnGateway.

" }, "DeviceType":{ "type":"string", "enum":[ "ebs", "instance-store" ] }, "DhcpConfiguration":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The name of a DHCP option.

", "locationName":"key" }, "Values":{ "shape":"DhcpConfigurationValueList", "documentation":"

One or more values for the DHCP option.

", "locationName":"valueSet" } }, "documentation":"

Describes a DHCP configuration option.

" }, "DhcpConfigurationList":{ "type":"list", "member":{ "shape":"DhcpConfiguration", "locationName":"item" } }, "DhcpConfigurationValueList":{ "type":"list", "member":{ "shape":"AttributeValue", "locationName":"item" } }, "DhcpOptions":{ "type":"structure", "members":{ "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the set of DHCP options.

", "locationName":"dhcpOptionsId" }, "DhcpConfigurations":{ "shape":"DhcpConfigurationList", "documentation":"

One or more DHCP options in the set.

", "locationName":"dhcpConfigurationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the DHCP options set.

", "locationName":"tagSet" } }, "documentation":"

Describes a set of DHCP options.

" }, "DhcpOptionsIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"DhcpOptionsId" } }, "DhcpOptionsList":{ "type":"list", "member":{ "shape":"DhcpOptions", "locationName":"item" } }, "DisableVgwRoutePropagationRequest":{ "type":"structure", "required":[ "RouteTableId", "GatewayId" ], "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } }, "documentation":"

Contains the parameters for DisableVgwRoutePropagation.

" }, "DisableVpcClassicLinkDnsSupportRequest":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for DisableVpcClassicLinkDnsSupport.

" }, "DisableVpcClassicLinkDnsSupportResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of DisableVpcClassicLinkDnsSupport.

" }, "DisableVpcClassicLinkRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for DisableVpcClassicLink.

" }, "DisableVpcClassicLinkResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of DisableVpcClassicLink.

" }, "DisassociateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" }, "AssociationId":{ "shape":"String", "documentation":"

[EC2-VPC] The association ID. Required for EC2-VPC.

" } }, "documentation":"

Contains the parameters for DisassociateAddress.

" }, "DisassociateRouteTableRequest":{ "type":"structure", "required":["AssociationId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID representing the current association between the route table and subnet.

", "locationName":"associationId" } }, "documentation":"

Contains the parameters for DisassociateRouteTable.

" }, "DiskImage":{ "type":"structure", "members":{ "Image":{ "shape":"DiskImageDetail", "documentation":"

Information about the disk image.

" }, "Description":{ "shape":"String", "documentation":"

A description of the disk image.

" }, "Volume":{ "shape":"VolumeDetail", "documentation":"

Information about the volume.

" } }, "documentation":"

Describes a disk image.

" }, "DiskImageDescription":{ "type":"structure", "required":[ "Format", "Size", "ImportManifestUrl" ], "members":{ "Format":{ "shape":"DiskImageFormat", "documentation":"

The disk image format.

", "locationName":"format" }, "Size":{ "shape":"Long", "documentation":"

The size of the disk image, in GiB.

", "locationName":"size" }, "ImportManifestUrl":{ "shape":"String", "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

", "locationName":"importManifestUrl" }, "Checksum":{ "shape":"String", "documentation":"

The checksum computed for the disk image.

", "locationName":"checksum" } }, "documentation":"

Describes a disk image.

" }, "DiskImageDetail":{ "type":"structure", "required":[ "Format", "Bytes", "ImportManifestUrl" ], "members":{ "Format":{ "shape":"DiskImageFormat", "documentation":"

The disk image format.

", "locationName":"format" }, "Bytes":{ "shape":"Long", "documentation":"

The size of the disk image, in GiB.

", "locationName":"bytes" }, "ImportManifestUrl":{ "shape":"String", "documentation":"

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

", "locationName":"importManifestUrl" } }, "documentation":"

Describes a disk image.

" }, "DiskImageFormat":{ "type":"string", "enum":[ "VMDK", "RAW", "VHD" ] }, "DiskImageList":{ "type":"list", "member":{"shape":"DiskImage"} }, "DiskImageVolumeDescription":{ "type":"structure", "required":["Id"], "members":{ "Size":{ "shape":"Long", "documentation":"

The size of the volume, in GiB.

", "locationName":"size" }, "Id":{ "shape":"String", "documentation":"

The volume identifier.

", "locationName":"id" } }, "documentation":"

Describes a disk image volume.

" }, "DomainType":{ "type":"string", "enum":[ "vpc", "standard" ] }, "Double":{"type":"double"}, "EbsBlockDevice":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

", "locationName":"snapshotId" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

", "locationName":"volumeSize" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", "locationName":"deleteOnTermination" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type: gp2, io1, st1, sc1, or standard.

Default: standard

", "locationName":"volumeType" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", "locationName":"iops" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

", "locationName":"encrypted" } }, "documentation":"

Describes a block device for an EBS volume.

" }, "EbsInstanceBlockDevice":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume.

", "locationName":"volumeId" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a parameter used to set up an EBS volume in a block device mapping.

" }, "EbsInstanceBlockDeviceSpecification":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume.

", "locationName":"volumeId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes information used to set up an EBS volume specified in a block device mapping.

" }, "EnableVgwRoutePropagationRequest":{ "type":"structure", "required":[ "RouteTableId", "GatewayId" ], "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } }, "documentation":"

Contains the parameters for EnableVgwRoutePropagation.

" }, "EnableVolumeIORequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" } }, "documentation":"

Contains the parameters for EnableVolumeIO.

" }, "EnableVpcClassicLinkDnsSupportRequest":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for EnableVpcClassicLinkDnsSupport.

" }, "EnableVpcClassicLinkDnsSupportResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of EnableVpcClassicLinkDnsSupport.

" }, "EnableVpcClassicLinkRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for EnableVpcClassicLink.

" }, "EnableVpcClassicLinkResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of EnableVpcClassicLink.

" }, "EventCode":{ "type":"string", "enum":[ "instance-reboot", "system-reboot", "system-maintenance", "instance-retirement", "instance-stop" ] }, "EventInformation":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance. This information is available only for instanceChange events.

", "locationName":"instanceId" }, "EventSubType":{ "shape":"String", "documentation":"

The event.

The following are the error events.

  • iamFleetRoleInvalid - The Spot fleet did not have the required permissions either to launch or terminate an instance.

  • launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.

  • spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.

  • spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot instances that you can launch.

The following are the fleetRequestChange events.

  • active - The Spot fleet has been validated and Amazon EC2 is attempting to maintain the target number of running Spot instances.

  • cancelled - The Spot fleet is canceled and has no running Spot instances. The Spot fleet will be deleted two days after its instances were terminated.

  • cancelled_running - The Spot fleet is canceled and will not launch additional Spot instances, but its existing Spot instances continue to run until they are interrupted or terminated.

  • cancelled_terminating - The Spot fleet is canceled and its Spot instances are terminating.

  • expired - The Spot fleet request has expired. A subsequent event indicates that the instances were terminated, if the request was created with TerminateInstancesWithExpiration set.

  • modify_in_progress - A request to modify the Spot fleet request was accepted and is in progress.

  • modify_successful - The Spot fleet request was modified.

  • price_update - The bid price for a launch configuration was adjusted because it was too high. This change is permanent.

  • submitted - The Spot fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of Spot instances.

The following are the instanceChange events.

  • launched - A bid was fulfilled and a new instance was launched.

  • terminated - An instance was terminated by the user.

", "locationName":"eventSubType" }, "EventDescription":{ "shape":"String", "documentation":"

The description of the event.

", "locationName":"eventDescription" } }, "documentation":"

Describes a Spot fleet event.

" }, "EventType":{ "type":"string", "enum":[ "instanceChange", "fleetRequestChange", "error" ] }, "ExcessCapacityTerminationPolicy":{ "type":"string", "enum":[ "noTermination", "default" ] }, "ExecutableByStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ExecutableBy" } }, "ExportEnvironment":{ "type":"string", "enum":[ "citrix", "vmware", "microsoft" ] }, "ExportTask":{ "type":"structure", "members":{ "ExportTaskId":{ "shape":"String", "documentation":"

The ID of the export task.

", "locationName":"exportTaskId" }, "Description":{ "shape":"String", "documentation":"

A description of the resource being exported.

", "locationName":"description" }, "State":{ "shape":"ExportTaskState", "documentation":"

The state of the export task.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message related to the export task.

", "locationName":"statusMessage" }, "InstanceExportDetails":{ "shape":"InstanceExportDetails", "documentation":"

Information about the instance to export.

", "locationName":"instanceExport" }, "ExportToS3Task":{ "shape":"ExportToS3Task", "documentation":"

Information about the export task.

", "locationName":"exportToS3" } }, "documentation":"

Describes an instance export task.

" }, "ExportTaskIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ExportTaskId" } }, "ExportTaskList":{ "type":"list", "member":{ "shape":"ExportTask", "locationName":"item" } }, "ExportTaskState":{ "type":"string", "enum":[ "active", "cancelling", "cancelled", "completed" ] }, "ExportToS3Task":{ "type":"structure", "members":{ "DiskImageFormat":{ "shape":"DiskImageFormat", "documentation":"

The format for the exported image.

", "locationName":"diskImageFormat" }, "ContainerFormat":{ "shape":"ContainerFormat", "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", "locationName":"containerFormat" }, "S3Bucket":{ "shape":"String", "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", "locationName":"s3Bucket" }, "S3Key":{ "shape":"String", "documentation":"

The encryption key for your S3 bucket.

", "locationName":"s3Key" } }, "documentation":"

Describes the format and location for an instance export task.

" }, "ExportToS3TaskSpecification":{ "type":"structure", "members":{ "DiskImageFormat":{ "shape":"DiskImageFormat", "documentation":"

The format for the exported image.

", "locationName":"diskImageFormat" }, "ContainerFormat":{ "shape":"ContainerFormat", "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", "locationName":"containerFormat" }, "S3Bucket":{ "shape":"String", "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", "locationName":"s3Bucket" }, "S3Prefix":{ "shape":"String", "documentation":"

The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

", "locationName":"s3Prefix" } }, "documentation":"

Describes an instance export task.

" }, "Filter":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the filter. Filter names are case-sensitive.

" }, "Values":{ "shape":"ValueStringList", "documentation":"

One or more filter values. Filter values are case-sensitive.

", "locationName":"Value" } }, "documentation":"

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.

" }, "FilterList":{ "type":"list", "member":{ "shape":"Filter", "locationName":"Filter" } }, "FleetType":{ "type":"string", "enum":[ "request", "maintain" ] }, "Float":{"type":"float"}, "FlowLog":{ "type":"structure", "members":{ "CreationTime":{ "shape":"DateTime", "documentation":"

The date and time the flow log was created.

", "locationName":"creationTime" }, "FlowLogId":{ "shape":"String", "documentation":"

The flow log ID.

", "locationName":"flowLogId" }, "FlowLogStatus":{ "shape":"String", "documentation":"

The status of the flow log (ACTIVE).

", "locationName":"flowLogStatus" }, "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource on which the flow log was created.

", "locationName":"resourceId" }, "TrafficType":{ "shape":"TrafficType", "documentation":"

The type of traffic captured for the flow log.

", "locationName":"trafficType" }, "LogGroupName":{ "shape":"String", "documentation":"

The name of the flow log group.

", "locationName":"logGroupName" }, "DeliverLogsStatus":{ "shape":"String", "documentation":"

The status of the logs delivery (SUCCESS | FAILED).

", "locationName":"deliverLogsStatus" }, "DeliverLogsErrorMessage":{ "shape":"String", "documentation":"

Information about the error that occurred. Rate limited indicates that CloudWatch logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of CloudWatch Logs log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.

", "locationName":"deliverLogsErrorMessage" }, "DeliverLogsPermissionArn":{ "shape":"String", "documentation":"

The ARN of the IAM role that posts logs to CloudWatch Logs.

", "locationName":"deliverLogsPermissionArn" } }, "documentation":"

Describes a flow log.

" }, "FlowLogSet":{ "type":"list", "member":{ "shape":"FlowLog", "locationName":"item" } }, "FlowLogsResourceType":{ "type":"string", "enum":[ "VPC", "Subnet", "NetworkInterface" ] }, "GatewayType":{ "type":"string", "enum":["ipsec.1"] }, "GetConsoleOutputRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" } }, "documentation":"

Contains the parameters for GetConsoleOutput.

" }, "GetConsoleOutputResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The time the output was last updated.

", "locationName":"timestamp" }, "Output":{ "shape":"String", "documentation":"

The console output, base64-encoded. If using a command line tool, the tools decode the output for you.

", "locationName":"output" } }, "documentation":"

Contains the output of GetConsoleOutput.

" }, "GetConsoleScreenshotRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "WakeUp":{ "shape":"Boolean", "documentation":"

When set to true, acts as keystroke input and wakes up an instance that's in standby or \"sleep\" mode.

" } }, "documentation":"

Contains the parameters for the request.

" }, "GetConsoleScreenshotResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "ImageData":{ "shape":"String", "documentation":"

The data that comprises the image.

", "locationName":"imageData" } }, "documentation":"

Contains the output of the request.

" }, "GetPasswordDataRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the Windows instance.

" } }, "documentation":"

Contains the parameters for GetPasswordData.

" }, "GetPasswordDataResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the Windows instance.

", "locationName":"instanceId" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The time the data was last updated.

", "locationName":"timestamp" }, "PasswordData":{ "shape":"String", "documentation":"

The password of the instance.

", "locationName":"passwordData" } }, "documentation":"

Contains the output of GetPasswordData.

" }, "GroupIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"groupId" } }, "GroupIdentifier":{ "type":"structure", "members":{ "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } }, "documentation":"

Describes a security group.

" }, "GroupIdentifierList":{ "type":"list", "member":{ "shape":"GroupIdentifier", "locationName":"item" } }, "GroupIds":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "GroupNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"GroupName" } }, "HistoryRecord":{ "type":"structure", "required":[ "Timestamp", "EventType", "EventInformation" ], "members":{ "Timestamp":{ "shape":"DateTime", "documentation":"

The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"timestamp" }, "EventType":{ "shape":"EventType", "documentation":"

The event type.

  • error - Indicates an error with the Spot fleet request.

  • fleetRequestChange - Indicates a change in the status or configuration of the Spot fleet request.

  • instanceChange - Indicates that an instance was launched or terminated.

", "locationName":"eventType" }, "EventInformation":{ "shape":"EventInformation", "documentation":"

Information about the event.

", "locationName":"eventInformation" } }, "documentation":"

Describes an event in the history of the Spot fleet request.

" }, "HistoryRecords":{ "type":"list", "member":{ "shape":"HistoryRecord", "locationName":"item" } }, "Host":{ "type":"structure", "members":{ "HostId":{ "shape":"String", "documentation":"

The ID of the Dedicated host.

", "locationName":"hostId" }, "AutoPlacement":{ "shape":"AutoPlacement", "documentation":"

Whether auto-placement is on or off.

", "locationName":"autoPlacement" }, "HostReservationId":{ "shape":"String", "documentation":"

The reservation ID of the Dedicated host. This returns a null response if the Dedicated host doesn't have an associated reservation.

", "locationName":"hostReservationId" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"clientToken" }, "HostProperties":{ "shape":"HostProperties", "documentation":"

The hardware specifications of the Dedicated host.

", "locationName":"hostProperties" }, "State":{ "shape":"AllocationState", "documentation":"

The Dedicated host's state.

", "locationName":"state" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the Dedicated host.

", "locationName":"availabilityZone" }, "Instances":{ "shape":"HostInstanceList", "documentation":"

The IDs and instance type that are currently running on the Dedicated host.

", "locationName":"instances" }, "AvailableCapacity":{ "shape":"AvailableCapacity", "documentation":"

The number of new instances that can be launched onto the Dedicated host.

", "locationName":"availableCapacity" } }, "documentation":"

Describes the properties of the Dedicated host.

" }, "HostInstance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

the IDs of instances that are running on the Dedicated host.

", "locationName":"instanceId" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type size (for example, m3.medium) of the running instance.

", "locationName":"instanceType" } }, "documentation":"

Describes an instance running on a Dedicated host.

" }, "HostInstanceList":{ "type":"list", "member":{ "shape":"HostInstance", "locationName":"item" } }, "HostList":{ "type":"list", "member":{ "shape":"Host", "locationName":"item" } }, "HostProperties":{ "type":"structure", "members":{ "Sockets":{ "shape":"Integer", "documentation":"

The number of sockets on the Dedicated host.

", "locationName":"sockets" }, "Cores":{ "shape":"Integer", "documentation":"

The number of cores on the Dedicated host.

", "locationName":"cores" }, "TotalVCpus":{ "shape":"Integer", "documentation":"

The number of vCPUs on the Dedicated host.

", "locationName":"totalVCpus" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type size that the Dedicated host supports (for example, m3.medium).

", "locationName":"instanceType" } }, "documentation":"

Describes properties of a Dedicated host.

" }, "HostTenancy":{ "type":"string", "enum":[ "dedicated", "host" ] }, "HypervisorType":{ "type":"string", "enum":[ "ovm", "xen" ] }, "IamInstanceProfile":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", "locationName":"arn" }, "Id":{ "shape":"String", "documentation":"

The ID of the instance profile.

", "locationName":"id" } }, "documentation":"

Describes an IAM instance profile.

" }, "IamInstanceProfileSpecification":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", "locationName":"arn" }, "Name":{ "shape":"String", "documentation":"

The name of the instance profile.

", "locationName":"name" } }, "documentation":"

Describes an IAM instance profile.

" }, "IcmpTypeCode":{ "type":"structure", "members":{ "Type":{ "shape":"Integer", "documentation":"

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", "locationName":"type" }, "Code":{ "shape":"Integer", "documentation":"

The ICMP type. A value of -1 means all types.

", "locationName":"code" } }, "documentation":"

Describes the ICMP type and code.

" }, "IdFormat":{ "type":"structure", "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource.

", "locationName":"resource" }, "UseLongIds":{ "shape":"Boolean", "documentation":"

Indicates whether longer IDs (17-character IDs) are enabled for the resource.

", "locationName":"useLongIds" }, "Deadline":{ "shape":"DateTime", "documentation":"

The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.

", "locationName":"deadline" } }, "documentation":"

Describes the ID format for a resource.

" }, "IdFormatList":{ "type":"list", "member":{ "shape":"IdFormat", "locationName":"item" } }, "Image":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "ImageLocation":{ "shape":"String", "documentation":"

The location of the AMI.

", "locationName":"imageLocation" }, "State":{ "shape":"ImageState", "documentation":"

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", "locationName":"imageState" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the image owner.

", "locationName":"imageOwnerId" }, "CreationDate":{ "shape":"String", "documentation":"

The date and time the image was created.

", "locationName":"creationDate" }, "Public":{ "shape":"Boolean", "documentation":"

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

", "locationName":"isPublic" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

Any product codes associated with the AMI.

", "locationName":"productCodes" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the image.

", "locationName":"architecture" }, "ImageType":{ "shape":"ImageTypeValues", "documentation":"

The type of image.

", "locationName":"imageType" }, "KernelId":{ "shape":"String", "documentation":"

The kernel associated with the image, if any. Only applicable for machine images.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The RAM disk associated with the image, if any. Only applicable for machine images.

", "locationName":"ramdiskId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The value is Windows for Windows AMIs; otherwise blank.

", "locationName":"platform" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Specifies whether enhanced networking is enabled.

", "locationName":"sriovNetSupport" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason for the state change.

", "locationName":"stateReason" }, "ImageOwnerAlias":{ "shape":"String", "documentation":"

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

", "locationName":"imageOwnerAlias" }, "Name":{ "shape":"String", "documentation":"

The name of the AMI that was provided during image creation.

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

The description of the AMI that was provided during image creation.

", "locationName":"description" }, "RootDeviceType":{ "shape":"DeviceType", "documentation":"

The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

", "locationName":"rootDeviceType" }, "RootDeviceName":{ "shape":"String", "documentation":"

The device name of the root device (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

Any block device mapping entries.

", "locationName":"blockDeviceMapping" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The type of virtualization of the AMI.

", "locationName":"virtualizationType" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the image.

", "locationName":"tagSet" }, "Hypervisor":{ "shape":"HypervisorType", "documentation":"

The hypervisor type of the image.

", "locationName":"hypervisor" } }, "documentation":"

Describes an image.

" }, "ImageAttribute":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "LaunchPermissions":{ "shape":"LaunchPermissionList", "documentation":"

One or more launch permissions.

", "locationName":"launchPermission" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

One or more product codes.

", "locationName":"productCodes" }, "KernelId":{ "shape":"AttributeValue", "documentation":"

The kernel ID.

", "locationName":"kernel" }, "RamdiskId":{ "shape":"AttributeValue", "documentation":"

The RAM disk ID.

", "locationName":"ramdisk" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the AMI.

", "locationName":"description" }, "SriovNetSupport":{ "shape":"AttributeValue", "locationName":"sriovNetSupport" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" } }, "documentation":"

Describes an image attribute.

" }, "ImageAttributeName":{ "type":"string", "enum":[ "description", "kernel", "ramdisk", "launchPermission", "productCodes", "blockDeviceMapping", "sriovNetSupport" ] }, "ImageDiskContainer":{ "type":"structure", "members":{ "Description":{ "shape":"String", "documentation":"

The description of the disk image.

" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" }, "Url":{ "shape":"String", "documentation":"

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)

" }, "UserBucket":{ "shape":"UserBucket", "documentation":"

The S3 bucket for the disk image.

" }, "DeviceName":{ "shape":"String", "documentation":"

The block device mapping for the disk.

" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot to be used for importing the snapshot.

" } }, "documentation":"

Describes the disk container object for an import image task.

" }, "ImageDiskContainerList":{ "type":"list", "member":{ "shape":"ImageDiskContainer", "locationName":"item" } }, "ImageIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ImageId" } }, "ImageList":{ "type":"list", "member":{ "shape":"Image", "locationName":"item" } }, "ImageState":{ "type":"string", "enum":[ "pending", "available", "invalid", "deregistered", "transient", "failed", "error" ] }, "ImageTypeValues":{ "type":"string", "enum":[ "machine", "kernel", "ramdisk" ] }, "ImportImageRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "Description":{ "shape":"String", "documentation":"

A description string for the import image task.

" }, "DiskContainers":{ "shape":"ImageDiskContainerList", "documentation":"

Information about the disk containers.

", "locationName":"DiskContainer" }, "LicenseType":{ "shape":"String", "documentation":"

The license type to be used for the Amazon Machine Image (AMI) after importing.

Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see VM Import/Export Prerequisites in the Amazon Elastic Compute Cloud User Guide.

Valid values: AWS | BYOL

" }, "Hypervisor":{ "shape":"String", "documentation":"

The target hypervisor platform.

Valid values: xen

" }, "Architecture":{ "shape":"String", "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

" }, "Platform":{ "shape":"String", "documentation":"

The operating system of the virtual machine.

Valid values: Windows | Linux

" }, "ClientData":{ "shape":"ClientData", "documentation":"

The client-specific data.

" }, "ClientToken":{ "shape":"String", "documentation":"

The token to enable idempotency for VM import requests.

" }, "RoleName":{ "shape":"String", "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" } }, "documentation":"

Contains the parameters for ImportImage.

" }, "ImportImageResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The task ID of the import image task.

", "locationName":"importTaskId" }, "Architecture":{ "shape":"String", "documentation":"

The architecture of the virtual machine.

", "locationName":"architecture" }, "LicenseType":{ "shape":"String", "documentation":"

The license type of the virtual machine.

", "locationName":"licenseType" }, "Platform":{ "shape":"String", "documentation":"

The operating system of the virtual machine.

", "locationName":"platform" }, "Hypervisor":{ "shape":"String", "documentation":"

The target hypervisor of the import task.

", "locationName":"hypervisor" }, "Description":{ "shape":"String", "documentation":"

A description of the import task.

", "locationName":"description" }, "SnapshotDetails":{ "shape":"SnapshotDetailList", "documentation":"

Information about the snapshots.

", "locationName":"snapshotDetailSet" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the Amazon Machine Image (AMI) created by the import task.

", "locationName":"imageId" }, "Progress":{ "shape":"String", "documentation":"

The progress of the task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message of the import task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status of the task.

", "locationName":"status" } }, "documentation":"

Contains the output for ImportImage.

" }, "ImportImageTask":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import image task.

", "locationName":"importTaskId" }, "Architecture":{ "shape":"String", "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

", "locationName":"architecture" }, "LicenseType":{ "shape":"String", "documentation":"

The license type of the virtual machine.

", "locationName":"licenseType" }, "Platform":{ "shape":"String", "documentation":"

The description string for the import image task.

", "locationName":"platform" }, "Hypervisor":{ "shape":"String", "documentation":"

The target hypervisor for the import task.

Valid values: xen

", "locationName":"hypervisor" }, "Description":{ "shape":"String", "documentation":"

A description of the import task.

", "locationName":"description" }, "SnapshotDetails":{ "shape":"SnapshotDetailList", "documentation":"

Information about the snapshots.

", "locationName":"snapshotDetailSet" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

", "locationName":"imageId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of progress of the import image task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A descriptive status message for the import image task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status for the import image task.

", "locationName":"status" } }, "documentation":"

Describes an import image task.

" }, "ImportImageTaskList":{ "type":"list", "member":{ "shape":"ImportImageTask", "locationName":"item" } }, "ImportInstanceLaunchSpecification":{ "type":"structure", "members":{ "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the instance.

", "locationName":"architecture" }, "GroupNames":{ "shape":"SecurityGroupStringList", "documentation":"

One or more security group names.

", "locationName":"GroupName" }, "GroupIds":{ "shape":"SecurityGroupIdStringList", "documentation":"

One or more security group IDs.

", "locationName":"GroupId" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "UserData":{ "shape":"UserData", "documentation":"

The Base64-encoded MIME user data to be made available to the instance.

", "locationName":"userData" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. For more information about the instance types that you can import, see Before You Get Started in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"instanceType" }, "Placement":{ "shape":"Placement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "Monitoring":{ "shape":"Boolean", "documentation":"

Indicates whether monitoring is enabled.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] An available IP address from the IP address range of the subnet.

", "locationName":"privateIpAddress" } }, "documentation":"

Describes the launch specification for VM import.

" }, "ImportInstanceRequest":{ "type":"structure", "required":["Platform"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Description":{ "shape":"String", "documentation":"

A description for the instance being imported.

", "locationName":"description" }, "LaunchSpecification":{ "shape":"ImportInstanceLaunchSpecification", "documentation":"

The launch specification.

", "locationName":"launchSpecification" }, "DiskImages":{ "shape":"DiskImageList", "documentation":"

The disk image.

", "locationName":"diskImage" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The instance operating system.

", "locationName":"platform" } }, "documentation":"

Contains the parameters for ImportInstance.

" }, "ImportInstanceResult":{ "type":"structure", "members":{ "ConversionTask":{ "shape":"ConversionTask", "documentation":"

Information about the conversion task.

", "locationName":"conversionTask" } }, "documentation":"

Contains the output for ImportInstance.

" }, "ImportInstanceTaskDetails":{ "type":"structure", "required":["Volumes"], "members":{ "Volumes":{ "shape":"ImportInstanceVolumeDetailSet", "documentation":"

One or more volumes.

", "locationName":"volumes" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The instance operating system.

", "locationName":"platform" }, "Description":{ "shape":"String", "documentation":"

A description of the task.

", "locationName":"description" } }, "documentation":"

Describes an import instance task.

" }, "ImportInstanceVolumeDetailItem":{ "type":"structure", "required":[ "BytesConverted", "AvailabilityZone", "Image", "Volume", "Status" ], "members":{ "BytesConverted":{ "shape":"Long", "documentation":"

The number of bytes converted so far.

", "locationName":"bytesConverted" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the resulting instance will reside.

", "locationName":"availabilityZone" }, "Image":{ "shape":"DiskImageDescription", "documentation":"

The image.

", "locationName":"image" }, "Volume":{ "shape":"DiskImageVolumeDescription", "documentation":"

The volume.

", "locationName":"volume" }, "Status":{ "shape":"String", "documentation":"

The status of the import of this particular disk image.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The status information or errors related to the disk image.

", "locationName":"statusMessage" }, "Description":{ "shape":"String", "documentation":"

A description of the task.

", "locationName":"description" } }, "documentation":"

Describes an import volume task.

" }, "ImportInstanceVolumeDetailSet":{ "type":"list", "member":{ "shape":"ImportInstanceVolumeDetailItem", "locationName":"item" } }, "ImportKeyPairRequest":{ "type":"structure", "required":[ "KeyName", "PublicKeyMaterial" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

A unique name for the key pair.

", "locationName":"keyName" }, "PublicKeyMaterial":{ "shape":"Blob", "documentation":"

The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.

", "locationName":"publicKeyMaterial" } }, "documentation":"

Contains the parameters for ImportKeyPair.

" }, "ImportKeyPairResult":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The key pair name you provided.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", "locationName":"keyFingerprint" } }, "documentation":"

Contains the output of ImportKeyPair.

" }, "ImportSnapshotRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "Description":{ "shape":"String", "documentation":"

The description string for the import snapshot task.

" }, "DiskContainer":{ "shape":"SnapshotDiskContainer", "documentation":"

Information about the disk container.

" }, "ClientData":{ "shape":"ClientData", "documentation":"

The client-specific data.

" }, "ClientToken":{ "shape":"String", "documentation":"

Token to enable idempotency for VM import requests.

" }, "RoleName":{ "shape":"String", "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" } }, "documentation":"

Contains the parameters for ImportSnapshot.

" }, "ImportSnapshotResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import snapshot task.

", "locationName":"importTaskId" }, "SnapshotTaskDetail":{ "shape":"SnapshotTaskDetail", "documentation":"

Information about the import snapshot task.

", "locationName":"snapshotTaskDetail" }, "Description":{ "shape":"String", "documentation":"

A description of the import snapshot task.

", "locationName":"description" } }, "documentation":"

Contains the output for ImportSnapshot.

" }, "ImportSnapshotTask":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import snapshot task.

", "locationName":"importTaskId" }, "SnapshotTaskDetail":{ "shape":"SnapshotTaskDetail", "documentation":"

Describes an import snapshot task.

", "locationName":"snapshotTaskDetail" }, "Description":{ "shape":"String", "documentation":"

A description of the import snapshot task.

", "locationName":"description" } }, "documentation":"

Describes an import snapshot task.

" }, "ImportSnapshotTaskList":{ "type":"list", "member":{ "shape":"ImportSnapshotTask", "locationName":"item" } }, "ImportTaskIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"ImportTaskId" } }, "ImportVolumeRequest":{ "type":"structure", "required":[ "AvailabilityZone", "Image", "Volume" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the resulting EBS volume.

", "locationName":"availabilityZone" }, "Image":{ "shape":"DiskImageDetail", "documentation":"

The disk image.

", "locationName":"image" }, "Description":{ "shape":"String", "documentation":"

A description of the volume.

", "locationName":"description" }, "Volume":{ "shape":"VolumeDetail", "documentation":"

The volume size.

", "locationName":"volume" } }, "documentation":"

Contains the parameters for ImportVolume.

" }, "ImportVolumeResult":{ "type":"structure", "members":{ "ConversionTask":{ "shape":"ConversionTask", "documentation":"

Information about the conversion task.

", "locationName":"conversionTask" } }, "documentation":"

Contains the output for ImportVolume.

" }, "ImportVolumeTaskDetails":{ "type":"structure", "required":[ "BytesConverted", "AvailabilityZone", "Image", "Volume" ], "members":{ "BytesConverted":{ "shape":"Long", "documentation":"

The number of bytes converted so far.

", "locationName":"bytesConverted" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the resulting volume will reside.

", "locationName":"availabilityZone" }, "Description":{ "shape":"String", "documentation":"

The description you provided when starting the import volume task.

", "locationName":"description" }, "Image":{ "shape":"DiskImageDescription", "documentation":"

The image.

", "locationName":"image" }, "Volume":{ "shape":"DiskImageVolumeDescription", "documentation":"

The volume.

", "locationName":"volume" } }, "documentation":"

Describes an import volume task.

" }, "Instance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI used to launch the instance.

", "locationName":"imageId" }, "State":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

", "locationName":"instanceState" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

", "locationName":"privateDnsName" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

", "locationName":"dnsName" }, "StateTransitionReason":{ "shape":"String", "documentation":"

The reason for the most recent state transition. This might be an empty string.

", "locationName":"reason" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair, if this instance was launched with an associated key pair.

", "locationName":"keyName" }, "AmiLaunchIndex":{ "shape":"Integer", "documentation":"

The AMI launch index, which can be used to find this instance in the launch group.

", "locationName":"amiLaunchIndex" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

The product codes attached to this instance, if applicable.

", "locationName":"productCodes" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "LaunchTime":{ "shape":"DateTime", "documentation":"

The time the instance was launched.

", "locationName":"launchTime" }, "Placement":{ "shape":"Placement", "documentation":"

The location where the instance launched, if applicable.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The kernel associated with this instance, if applicable.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The RAM disk associated with this instance, if applicable.

", "locationName":"ramdiskId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The value is Windows for Windows instances; otherwise blank.

", "locationName":"platform" }, "Monitoring":{ "shape":"Monitoring", "documentation":"

The monitoring information for the instance.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet in which the instance is running.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC in which the instance is running.

", "locationName":"vpcId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address assigned to the instance.

", "locationName":"privateIpAddress" }, "PublicIpAddress":{ "shape":"String", "documentation":"

The public IP address assigned to the instance, if applicable.

", "locationName":"ipAddress" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason for the most recent state transition.

", "locationName":"stateReason" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the image.

", "locationName":"architecture" }, "RootDeviceType":{ "shape":"DeviceType", "documentation":"

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

", "locationName":"rootDeviceType" }, "RootDeviceName":{ "shape":"String", "documentation":"

The root device name (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"

Any block device mapping entries for the instance.

", "locationName":"blockDeviceMapping" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The virtualization type of the instance.

", "locationName":"virtualizationType" }, "InstanceLifecycle":{ "shape":"InstanceLifecycleType", "documentation":"

Indicates whether this is a Spot instance or a Scheduled Instance.

", "locationName":"instanceLifecycle" }, "SpotInstanceRequestId":{ "shape":"String", "documentation":"

If the request is a Spot instance request, the ID of the request.

", "locationName":"spotInstanceRequestId" }, "ClientToken":{ "shape":"String", "documentation":"

The idempotency token you provided when you launched the instance, if applicable.

", "locationName":"clientToken" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the instance.

", "locationName":"tagSet" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups for the instance.

", "locationName":"groupSet" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", "locationName":"sourceDestCheck" }, "Hypervisor":{ "shape":"HypervisorType", "documentation":"

The hypervisor type of the instance.

", "locationName":"hypervisor" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceList", "documentation":"

[EC2-VPC] One or more network interfaces for the instance.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfile", "documentation":"

The IAM instance profile associated with the instance, if applicable.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Specifies whether enhanced networking is enabled.

", "locationName":"sriovNetSupport" } }, "documentation":"

Describes an instance.

" }, "InstanceAttribute":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "InstanceType":{ "shape":"AttributeValue", "documentation":"

The instance type.

", "locationName":"instanceType" }, "KernelId":{ "shape":"AttributeValue", "documentation":"

The kernel ID.

", "locationName":"kernel" }, "RamdiskId":{ "shape":"AttributeValue", "documentation":"

The RAM disk ID.

", "locationName":"ramdisk" }, "UserData":{ "shape":"AttributeValue", "documentation":"

The Base64-encoded MIME user data.

", "locationName":"userData" }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", "documentation":"

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ "shape":"AttributeValue", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "RootDeviceName":{ "shape":"AttributeValue", "documentation":"

The name of the root device (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"

The block device mapping of the instance.

", "locationName":"blockDeviceMapping" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" }, "EbsOptimized":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instance is optimized for EBS I/O.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"AttributeValue", "locationName":"sriovNetSupport" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

The security groups associated with the instance.

", "locationName":"groupSet" } }, "documentation":"

Describes an instance attribute.

" }, "InstanceAttributeName":{ "type":"string", "enum":[ "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "rootDeviceName", "blockDeviceMapping", "productCodes", "sourceDestCheck", "groupSet", "ebsOptimized", "sriovNetSupport" ] }, "InstanceBlockDeviceMapping":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsInstanceBlockDevice", "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", "locationName":"ebs" } }, "documentation":"

Describes a block device mapping.

" }, "InstanceBlockDeviceMappingList":{ "type":"list", "member":{ "shape":"InstanceBlockDeviceMapping", "locationName":"item" } }, "InstanceBlockDeviceMappingSpecification":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsInstanceBlockDeviceSpecification", "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", "locationName":"ebs" }, "VirtualName":{ "shape":"String", "documentation":"

The virtual device name.

", "locationName":"virtualName" }, "NoDevice":{ "shape":"String", "documentation":"

suppress the specified device included in the block device mapping.

", "locationName":"noDevice" } }, "documentation":"

Describes a block device mapping entry.

" }, "InstanceBlockDeviceMappingSpecificationList":{ "type":"list", "member":{ "shape":"InstanceBlockDeviceMappingSpecification", "locationName":"item" } }, "InstanceCapacity":{ "type":"structure", "members":{ "InstanceType":{ "shape":"String", "documentation":"

The instance type size supported by the Dedicated host.

", "locationName":"instanceType" }, "AvailableCapacity":{ "shape":"Integer", "documentation":"

The number of instances that can still be launched onto the Dedicated host.

", "locationName":"availableCapacity" }, "TotalCapacity":{ "shape":"Integer", "documentation":"

The total number of instances that can be launched onto the Dedicated host.

", "locationName":"totalCapacity" } }, "documentation":"

Information about the instance type that the Dedicated host supports.

" }, "InstanceCount":{ "type":"structure", "members":{ "State":{ "shape":"ListingState", "documentation":"

The states of the listed Reserved Instances.

", "locationName":"state" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of listed Reserved Instances in the state specified by the state.

", "locationName":"instanceCount" } }, "documentation":"

Describes a Reserved Instance listing state.

" }, "InstanceCountList":{ "type":"list", "member":{ "shape":"InstanceCount", "locationName":"item" } }, "InstanceExportDetails":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the resource being exported.

", "locationName":"instanceId" }, "TargetEnvironment":{ "shape":"ExportEnvironment", "documentation":"

The target virtualization environment.

", "locationName":"targetEnvironment" } }, "documentation":"

Describes an instance to export.

" }, "InstanceIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "InstanceIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"InstanceId" } }, "InstanceLifecycleType":{ "type":"string", "enum":[ "spot", "scheduled" ] }, "InstanceList":{ "type":"list", "member":{ "shape":"Instance", "locationName":"item" } }, "InstanceMonitoring":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Monitoring":{ "shape":"Monitoring", "documentation":"

The monitoring information.

", "locationName":"monitoring" } }, "documentation":"

Describes the monitoring information of the instance.

" }, "InstanceMonitoringList":{ "type":"list", "member":{ "shape":"InstanceMonitoring", "locationName":"item" } }, "InstanceNetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Description":{ "shape":"String", "documentation":"

The description.

", "locationName":"description" }, "OwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that created the network interface.

", "locationName":"ownerId" }, "Status":{ "shape":"NetworkInterfaceStatus", "documentation":"

The status of the network interface.

", "locationName":"status" }, "MacAddress":{ "shape":"String", "documentation":"

The MAC address.

", "locationName":"macAddress" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Indicates whether to validate network traffic to or from this network interface.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups.

", "locationName":"groupSet" }, "Attachment":{ "shape":"InstanceNetworkInterfaceAttachment", "documentation":"

The network interface attachment.

", "locationName":"attachment" }, "Association":{ "shape":"InstanceNetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP associated with the network interface.

", "locationName":"association" }, "PrivateIpAddresses":{ "shape":"InstancePrivateIpAddressList", "documentation":"

The private IP addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" } }, "documentation":"

Describes a network interface.

" }, "InstanceNetworkInterfaceAssociation":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The public IP address or Elastic IP address bound to the network interface.

", "locationName":"publicIp" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name.

", "locationName":"publicDnsName" }, "IpOwnerId":{ "shape":"String", "documentation":"

The ID of the owner of the Elastic IP address.

", "locationName":"ipOwnerId" } }, "documentation":"

Describes association information for an Elastic IP address.

" }, "InstanceNetworkInterfaceAttachment":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device on the instance for the network interface attachment.

", "locationName":"deviceIndex" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a network interface attachment.

" }, "InstanceNetworkInterfaceList":{ "type":"list", "member":{ "shape":"InstanceNetworkInterface", "locationName":"item" } }, "InstanceNetworkInterfaceSpecification":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

", "locationName":"deviceIndex" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

", "locationName":"subnetId" }, "Description":{ "shape":"String", "documentation":"

The description of the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"description" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"privateIpAddress" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"SecurityGroupId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

", "locationName":"deleteOnTermination" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", "documentation":"

One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.

", "locationName":"privateIpAddressesSet", "queryName":"PrivateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.

", "locationName":"secondaryPrivateIpAddressCount" }, "AssociatePublicIpAddress":{ "shape":"Boolean", "documentation":"

Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

", "locationName":"associatePublicIpAddress" } }, "documentation":"

Describes a network interface.

" }, "InstanceNetworkInterfaceSpecificationList":{ "type":"list", "member":{ "shape":"InstanceNetworkInterfaceSpecification", "locationName":"item" } }, "InstancePrivateIpAddress":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the network interface.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", "locationName":"primary" }, "Association":{ "shape":"InstanceNetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address for the network interface.

", "locationName":"association" } }, "documentation":"

Describes a private IP address.

" }, "InstancePrivateIpAddressList":{ "type":"list", "member":{ "shape":"InstancePrivateIpAddress", "locationName":"item" } }, "InstanceState":{ "type":"structure", "members":{ "Code":{ "shape":"Integer", "documentation":"

The low byte represents the state. The high byte is an opaque internal value and should be ignored.

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

", "locationName":"code" }, "Name":{ "shape":"InstanceStateName", "documentation":"

The current state of the instance.

", "locationName":"name" } }, "documentation":"

Describes the current state of the instance.

" }, "InstanceStateChange":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "CurrentState":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

", "locationName":"currentState" }, "PreviousState":{ "shape":"InstanceState", "documentation":"

The previous state of the instance.

", "locationName":"previousState" } }, "documentation":"

Describes an instance state change.

" }, "InstanceStateChangeList":{ "type":"list", "member":{ "shape":"InstanceStateChange", "locationName":"item" } }, "InstanceStateName":{ "type":"string", "enum":[ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ] }, "InstanceStatus":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the instance.

", "locationName":"availabilityZone" }, "Events":{ "shape":"InstanceStatusEventList", "documentation":"

Any scheduled events associated with the instance.

", "locationName":"eventsSet" }, "InstanceState":{ "shape":"InstanceState", "documentation":"

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

", "locationName":"instanceState" }, "SystemStatus":{ "shape":"InstanceStatusSummary", "documentation":"

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

", "locationName":"systemStatus" }, "InstanceStatus":{ "shape":"InstanceStatusSummary", "documentation":"

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

", "locationName":"instanceStatus" } }, "documentation":"

Describes the status of an instance.

" }, "InstanceStatusDetails":{ "type":"structure", "members":{ "Name":{ "shape":"StatusName", "documentation":"

The type of instance status.

", "locationName":"name" }, "Status":{ "shape":"StatusType", "documentation":"

The status.

", "locationName":"status" }, "ImpairedSince":{ "shape":"DateTime", "documentation":"

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

", "locationName":"impairedSince" } }, "documentation":"

Describes the instance status.

" }, "InstanceStatusDetailsList":{ "type":"list", "member":{ "shape":"InstanceStatusDetails", "locationName":"item" } }, "InstanceStatusEvent":{ "type":"structure", "members":{ "Code":{ "shape":"EventCode", "documentation":"

The event code.

", "locationName":"code" }, "Description":{ "shape":"String", "documentation":"

A description of the event.

After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].

", "locationName":"description" }, "NotBefore":{ "shape":"DateTime", "documentation":"

The earliest scheduled start time for the event.

", "locationName":"notBefore" }, "NotAfter":{ "shape":"DateTime", "documentation":"

The latest scheduled end time for the event.

", "locationName":"notAfter" } }, "documentation":"

Describes a scheduled event for an instance.

" }, "InstanceStatusEventList":{ "type":"list", "member":{ "shape":"InstanceStatusEvent", "locationName":"item" } }, "InstanceStatusList":{ "type":"list", "member":{ "shape":"InstanceStatus", "locationName":"item" } }, "InstanceStatusSummary":{ "type":"structure", "members":{ "Status":{ "shape":"SummaryStatus", "documentation":"

The status.

", "locationName":"status" }, "Details":{ "shape":"InstanceStatusDetailsList", "documentation":"

The system instance health or application instance health.

", "locationName":"details" } }, "documentation":"

Describes the status of an instance.

" }, "InstanceType":{ "type":"string", "enum":[ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "x1.4xlarge", "x1.8xlarge", "x1.16xlarge", "x1.32xlarge", "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", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "g2.8xlarge", "cg1.4xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge" ] }, "InstanceTypeList":{ "type":"list", "member":{"shape":"InstanceType"} }, "Integer":{"type":"integer"}, "InternetGateway":{ "type":"structure", "members":{ "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "Attachments":{ "shape":"InternetGatewayAttachmentList", "documentation":"

Any VPCs attached to the Internet gateway.

", "locationName":"attachmentSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the Internet gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes an Internet gateway.

" }, "InternetGatewayAttachment":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"AttachmentStatus", "documentation":"

The current state of the attachment.

", "locationName":"state" } }, "documentation":"

Describes the attachment of a VPC to an Internet gateway.

" }, "InternetGatewayAttachmentList":{ "type":"list", "member":{ "shape":"InternetGatewayAttachment", "locationName":"item" } }, "InternetGatewayList":{ "type":"list", "member":{ "shape":"InternetGateway", "locationName":"item" } }, "IpPermission":{ "type":"structure", "members":{ "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

[EC2-VPC only] When you authorize or revoke security group rules, you can use -1 to specify all.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

", "locationName":"toPort" }, "UserIdGroupPairs":{ "shape":"UserIdGroupPairList", "documentation":"

One or more security group and AWS account ID pairs.

", "locationName":"groups" }, "IpRanges":{ "shape":"IpRangeList", "documentation":"

One or more IP ranges.

", "locationName":"ipRanges" }, "PrefixListIds":{ "shape":"PrefixListIdList", "documentation":"

(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

", "locationName":"prefixListIds" } }, "documentation":"

Describes a security group rule.

" }, "IpPermissionList":{ "type":"list", "member":{ "shape":"IpPermission", "locationName":"item" } }, "IpRange":{ "type":"structure", "members":{ "CidrIp":{ "shape":"String", "documentation":"

The CIDR range. You can either specify a CIDR range or a source security group, not both.

", "locationName":"cidrIp" } }, "documentation":"

Describes an IP range.

" }, "IpRangeList":{ "type":"list", "member":{ "shape":"IpRange", "locationName":"item" } }, "IpRanges":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "KeyNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"KeyName" } }, "KeyPair":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

The SHA-1 digest of the DER encoded private key.

", "locationName":"keyFingerprint" }, "KeyMaterial":{ "shape":"String", "documentation":"

An unencrypted PEM encoded RSA private key.

", "locationName":"keyMaterial" } }, "documentation":"

Describes a key pair.

" }, "KeyPairInfo":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", "locationName":"keyFingerprint" } }, "documentation":"

Describes a key pair.

" }, "KeyPairList":{ "type":"list", "member":{ "shape":"KeyPairInfo", "locationName":"item" } }, "LaunchPermission":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The AWS account ID.

", "locationName":"userId" }, "Group":{ "shape":"PermissionGroup", "documentation":"

The name of the group.

", "locationName":"group" } }, "documentation":"

Describes a launch permission.

" }, "LaunchPermissionList":{ "type":"list", "member":{ "shape":"LaunchPermission", "locationName":"item" } }, "LaunchPermissionModifications":{ "type":"structure", "members":{ "Add":{ "shape":"LaunchPermissionList", "documentation":"

The AWS account ID to add to the list of launch permissions for the AMI.

" }, "Remove":{ "shape":"LaunchPermissionList", "documentation":"

The AWS account ID to remove from the list of launch permissions for the AMI.

" } }, "documentation":"

Describes a launch permission modification.

" }, "LaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", "locationName":"groupSet" }, "UserData":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.

", "locationName":"blockDeviceMapping" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" } }, "documentation":"

Describes the launch specification for an instance.

" }, "LaunchSpecsList":{ "type":"list", "member":{ "shape":"SpotFleetLaunchSpecification", "locationName":"item" }, "min":1 }, "ListingState":{ "type":"string", "enum":[ "available", "sold", "cancelled", "pending" ] }, "ListingStatus":{ "type":"string", "enum":[ "active", "pending", "cancelled", "closed" ] }, "Long":{"type":"long"}, "MaxResults":{ "type":"integer", "max":255, "min":5 }, "ModifyHostsRequest":{ "type":"structure", "required":[ "HostIds", "AutoPlacement" ], "members":{ "HostIds":{ "shape":"RequestHostIdList", "documentation":"

The host IDs of the Dedicated hosts you want to modify.

", "locationName":"hostId" }, "AutoPlacement":{ "shape":"AutoPlacement", "documentation":"

Specify whether to enable or disable auto-placement.

", "locationName":"autoPlacement" } }, "documentation":"

Contains the parameters for ModifyHosts.

" }, "ModifyHostsResult":{ "type":"structure", "members":{ "Successful":{ "shape":"ResponseHostIdList", "documentation":"

The IDs of the Dedicated hosts that were successfully modified.

", "locationName":"successful" }, "Unsuccessful":{ "shape":"UnsuccessfulItemList", "documentation":"

The IDs of the Dedicated hosts that could not be modified. Check whether the setting you requested can be used.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of ModifyHosts.

" }, "ModifyIdFormatRequest":{ "type":"structure", "required":[ "Resource", "UseLongIds" ], "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource.

" }, "UseLongIds":{ "shape":"Boolean", "documentation":"

Indicate whether the resource should use longer IDs (17-character IDs).

" } }, "documentation":"

Contains the parameters of ModifyIdFormat.

" }, "ModifyImageAttributeRequest":{ "type":"structure", "required":["ImageId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"String", "documentation":"

The name of the attribute to modify.

" }, "OperationType":{ "shape":"OperationType", "documentation":"

The operation type.

" }, "UserIds":{ "shape":"UserIdStringList", "documentation":"

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

", "locationName":"UserId" }, "UserGroups":{ "shape":"UserGroupStringList", "documentation":"

One or more user groups. This is only valid when modifying the launchPermission attribute.

", "locationName":"UserGroup" }, "ProductCodes":{ "shape":"ProductCodeStringList", "documentation":"

One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

", "locationName":"ProductCode" }, "Value":{ "shape":"String", "documentation":"

The value of the attribute being modified. This is only valid when modifying the description attribute.

" }, "LaunchPermission":{ "shape":"LaunchPermissionModifications", "documentation":"

A launch permission modification.

" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the AMI.

" } }, "documentation":"

Contains the parameters for ModifyImageAttribute.

" }, "ModifyInstanceAttributeRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The name of the attribute.

", "locationName":"attribute" }, "Value":{ "shape":"String", "documentation":"

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

", "locationName":"value" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingSpecificationList", "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"blockDeviceMapping" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

" }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", "documentation":"

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this paramater for Spot Instances.

", "locationName":"disableApiTermination" }, "InstanceType":{ "shape":"AttributeValue", "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", "locationName":"instanceType" }, "Kernel":{ "shape":"AttributeValue", "documentation":"

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", "locationName":"kernel" }, "Ramdisk":{ "shape":"AttributeValue", "documentation":"

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", "locationName":"ramdisk" }, "UserData":{ "shape":"BlobAttributeValue", "documentation":"

Changes the instance's user data to the specified base64-encoded value. For command line tools, base64 encoding is performed for you.

", "locationName":"userData" }, "InstanceInitiatedShutdownBehavior":{ "shape":"AttributeValue", "documentation":"

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "Groups":{ "shape":"GroupIdStringList", "documentation":"

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

", "locationName":"GroupId" }, "EbsOptimized":{ "shape":"AttributeBooleanValue", "documentation":"

Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"AttributeValue", "documentation":"

Set to simple to enable enhanced networking for the instance.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", "locationName":"sriovNetSupport" } }, "documentation":"

Contains the parameters for ModifyInstanceAttribute.

" }, "ModifyInstancePlacementRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance that you are modifying.

", "locationName":"instanceId" }, "Tenancy":{ "shape":"HostTenancy", "documentation":"

The tenancy of the instance that you are modifying.

", "locationName":"tenancy" }, "Affinity":{ "shape":"Affinity", "documentation":"

The new affinity setting for the instance.

", "locationName":"affinity" }, "HostId":{ "shape":"String", "documentation":"

The ID of the Dedicated host that the instance will have affinity with.

", "locationName":"hostId" } }, "documentation":"

Contains the parameters for ModifyInstancePlacement.

" }, "ModifyInstancePlacementResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Is true if the request succeeds, and an error otherwise.

", "locationName":"return" } }, "documentation":"

Contains the output of ModifyInstancePlacement.

" }, "ModifyNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the network interface.

", "locationName":"description" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", "locationName":"SecurityGroupId" }, "Attachment":{ "shape":"NetworkInterfaceAttachmentChanges", "documentation":"

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

", "locationName":"attachment" } }, "documentation":"

Contains the parameters for ModifyNetworkInterfaceAttribute.

" }, "ModifyReservedInstancesRequest":{ "type":"structure", "required":[ "ReservedInstancesIds", "TargetConfigurations" ], "members":{ "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" }, "ReservedInstancesIds":{ "shape":"ReservedInstancesIdStringList", "documentation":"

The IDs of the Reserved Instances to modify.

", "locationName":"ReservedInstancesId" }, "TargetConfigurations":{ "shape":"ReservedInstancesConfigurationList", "documentation":"

The configuration settings for the Reserved Instances to modify.

", "locationName":"ReservedInstancesConfigurationSetItemType" } }, "documentation":"

Contains the parameters for ModifyReservedInstances.

" }, "ModifyReservedInstancesResult":{ "type":"structure", "members":{ "ReservedInstancesModificationId":{ "shape":"String", "documentation":"

The ID for the modification.

", "locationName":"reservedInstancesModificationId" } }, "documentation":"

Contains the output of ModifyReservedInstances.

" }, "ModifySnapshotAttributeRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The snapshot attribute to modify.

Only volume creation permissions may be modified at the customer level.

" }, "OperationType":{ "shape":"OperationType", "documentation":"

The type of operation to perform to the attribute.

" }, "UserIds":{ "shape":"UserIdStringList", "documentation":"

The account ID to modify for the snapshot.

", "locationName":"UserId" }, "GroupNames":{ "shape":"GroupNameStringList", "documentation":"

The group to modify for the snapshot.

", "locationName":"UserGroup" }, "CreateVolumePermission":{ "shape":"CreateVolumePermissionModifications", "documentation":"

A JSON representation of the snapshot attribute modification.

" } }, "documentation":"

Contains the parameters for ModifySnapshotAttribute.

" }, "ModifySpotFleetRequestRequest":{ "type":"structure", "required":["SpotFleetRequestId"], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "TargetCapacity":{ "shape":"Integer", "documentation":"

The size of the fleet.

", "locationName":"targetCapacity" }, "ExcessCapacityTerminationPolicy":{ "shape":"ExcessCapacityTerminationPolicy", "documentation":"

Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.

", "locationName":"excessCapacityTerminationPolicy" } }, "documentation":"

Contains the parameters for ModifySpotFleetRequest.

" }, "ModifySpotFleetRequestResponse":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Is true if the request succeeds, and an error otherwise.

", "locationName":"return" } }, "documentation":"

Contains the output of ModifySpotFleetRequest.

" }, "ModifySubnetAttributeRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "MapPublicIpOnLaunch":{ "shape":"AttributeBooleanValue", "documentation":"

Specify true to indicate that instances launched into the specified subnet should be assigned public IP address.

" } }, "documentation":"

Contains the parameters for ModifySubnetAttribute.

" }, "ModifyVolumeAttributeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "AutoEnableIO":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the volume should be auto-enabled for I/O operations.

" } }, "documentation":"

Contains the parameters for ModifyVolumeAttribute.

" }, "ModifyVpcAttributeRequest":{ "type":"structure", "required":["VpcId"], "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "EnableDnsSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.

" }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.

" } }, "documentation":"

Contains the parameters for ModifyVpcAttribute.

" }, "ModifyVpcEndpointRequest":{ "type":"structure", "required":["VpcEndpointId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcEndpointId":{ "shape":"String", "documentation":"

The ID of the endpoint.

" }, "ResetPolicy":{ "shape":"Boolean", "documentation":"

Specify true to reset the policy document to the default policy. The default policy allows access to the service.

" }, "PolicyDocument":{ "shape":"String", "documentation":"

A policy document to attach to the endpoint. The policy must be in valid JSON format.

" }, "AddRouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route tables IDs to associate with the endpoint.

", "locationName":"AddRouteTableId" }, "RemoveRouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs to disassociate from the endpoint.

", "locationName":"RemoveRouteTableId" } }, "documentation":"

Contains the parameters for ModifyVpcEndpoint.

" }, "ModifyVpcEndpointResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of ModifyVpcEndpoint.

" }, "ModifyVpcPeeringConnectionOptionsRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

" }, "RequesterPeeringConnectionOptions":{ "shape":"PeeringConnectionOptionsRequest", "documentation":"

The VPC peering connection options for the requester VPC.

" }, "AccepterPeeringConnectionOptions":{ "shape":"PeeringConnectionOptionsRequest", "documentation":"

The VPC peering connection options for the accepter VPC.

" } } }, "ModifyVpcPeeringConnectionOptionsResult":{ "type":"structure", "members":{ "RequesterPeeringConnectionOptions":{ "shape":"PeeringConnectionOptions", "documentation":"

Information about the VPC peering connection options for the requester VPC.

", "locationName":"requesterPeeringConnectionOptions" }, "AccepterPeeringConnectionOptions":{ "shape":"PeeringConnectionOptions", "documentation":"

Information about the VPC peering connection options for the accepter VPC.

", "locationName":"accepterPeeringConnectionOptions" } } }, "MonitorInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } }, "documentation":"

Contains the parameters for MonitorInstances.

" }, "MonitorInstancesResult":{ "type":"structure", "members":{ "InstanceMonitorings":{ "shape":"InstanceMonitoringList", "documentation":"

Monitoring information for one or more instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of MonitorInstances.

" }, "Monitoring":{ "type":"structure", "members":{ "State":{ "shape":"MonitoringState", "documentation":"

Indicates whether monitoring is enabled for the instance.

", "locationName":"state" } }, "documentation":"

Describes the monitoring for the instance.

" }, "MonitoringState":{ "type":"string", "enum":[ "disabled", "disabling", "enabled", "pending" ] }, "MoveAddressToVpcRequest":{ "type":"structure", "required":["PublicIp"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" } }, "documentation":"

Contains the parameters for MoveAddressToVpc.

" }, "MoveAddressToVpcResult":{ "type":"structure", "members":{ "AllocationId":{ "shape":"String", "documentation":"

The allocation ID for the Elastic IP address.

", "locationName":"allocationId" }, "Status":{ "shape":"Status", "documentation":"

The status of the move of the IP address.

", "locationName":"status" } }, "documentation":"

Contains the output of MoveAddressToVpc.

" }, "MoveStatus":{ "type":"string", "enum":[ "movingToVpc", "restoringToClassic" ] }, "MovingAddressStatus":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "MoveStatus":{ "shape":"MoveStatus", "documentation":"

The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.

", "locationName":"moveStatus" } }, "documentation":"

Describes the status of a moving Elastic IP address.

" }, "MovingAddressStatusSet":{ "type":"list", "member":{ "shape":"MovingAddressStatus", "locationName":"item" } }, "NatGateway":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC in which the NAT gateway is located.

", "locationName":"vpcId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which the NAT gateway is located.

", "locationName":"subnetId" }, "NatGatewayId":{ "shape":"String", "documentation":"

The ID of the NAT gateway.

", "locationName":"natGatewayId" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The date and time the NAT gateway was created.

", "locationName":"createTime" }, "DeleteTime":{ "shape":"DateTime", "documentation":"

The date and time the NAT gateway was deleted, if applicable.

", "locationName":"deleteTime" }, "NatGatewayAddresses":{ "shape":"NatGatewayAddressList", "documentation":"

Information about the IP addresses and network interface associated with the NAT gateway.

", "locationName":"natGatewayAddressSet" }, "State":{ "shape":"NatGatewayState", "documentation":"

The state of the NAT gateway.

  • pending: The NAT gateway is being created and is not ready to process traffic.

  • failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.

  • available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.

  • deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.

  • deleted: The NAT gateway has been terminated and is no longer processing traffic.

", "locationName":"state" }, "FailureCode":{ "shape":"String", "documentation":"

If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)

", "locationName":"failureCode" }, "FailureMessage":{ "shape":"String", "documentation":"

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

  • For InsufficientFreeAddressesInSubnet: \"Subnet has insufficient free addresses to create this NAT gateway\"

  • For Gateway.NotAttached: \"Network vpc-xxxxxxxx has no Internet gateway attached\"

  • For InvalidAllocationID.NotFound: \"Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway\"

  • For Resource.AlreadyAssociated: \"Elastic IP address eipalloc-xxxxxxxx is already associated\"

  • For InternalError: \"Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again.\"

  • For InvalidSubnetID.NotFound: \"The specified subnet subnet-xxxxxxxx does not exist or could not be found.\"

", "locationName":"failureMessage" }, "ProvisionedBandwidth":{ "shape":"ProvisionedBandwidth", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"provisionedBandwidth" } }, "documentation":"

Describes a NAT gateway.

" }, "NatGatewayAddress":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address associated with the NAT gateway.

", "locationName":"publicIp" }, "AllocationId":{ "shape":"String", "documentation":"

The allocation ID of the Elastic IP address that's associated with the NAT gateway.

", "locationName":"allocationId" }, "PrivateIp":{ "shape":"String", "documentation":"

The private IP address associated with the Elastic IP address.

", "locationName":"privateIp" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface associated with the NAT gateway.

", "locationName":"networkInterfaceId" } }, "documentation":"

Describes the IP addresses and network interface associated with a NAT gateway.

" }, "NatGatewayAddressList":{ "type":"list", "member":{ "shape":"NatGatewayAddress", "locationName":"item" } }, "NatGatewayList":{ "type":"list", "member":{ "shape":"NatGateway", "locationName":"item" } }, "NatGatewayState":{ "type":"string", "enum":[ "pending", "failed", "available", "deleting", "deleted" ] }, "NetworkAcl":{ "type":"structure", "members":{ "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for the network ACL.

", "locationName":"vpcId" }, "IsDefault":{ "shape":"Boolean", "documentation":"

Indicates whether this is the default network ACL for the VPC.

", "locationName":"default" }, "Entries":{ "shape":"NetworkAclEntryList", "documentation":"

One or more entries (rules) in the network ACL.

", "locationName":"entrySet" }, "Associations":{ "shape":"NetworkAclAssociationList", "documentation":"

Any associations between the network ACL and one or more subnets

", "locationName":"associationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the network ACL.

", "locationName":"tagSet" } }, "documentation":"

Describes a network ACL.

" }, "NetworkAclAssociation":{ "type":"structure", "members":{ "NetworkAclAssociationId":{ "shape":"String", "documentation":"

The ID of the association between a network ACL and a subnet.

", "locationName":"networkAclAssociationId" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" } }, "documentation":"

Describes an association between a network ACL and a subnet.

" }, "NetworkAclAssociationList":{ "type":"list", "member":{ "shape":"NetworkAclAssociation", "locationName":"item" } }, "NetworkAclEntry":{ "type":"structure", "members":{ "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The protocol. A value of -1 means all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation.

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code.

", "locationName":"icmpTypeCode" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", "locationName":"portRange" } }, "documentation":"

Describes an entry in a network ACL.

" }, "NetworkAclEntryList":{ "type":"list", "member":{ "shape":"NetworkAclEntry", "locationName":"item" } }, "NetworkAclList":{ "type":"list", "member":{ "shape":"NetworkAcl", "locationName":"item" } }, "NetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "Description":{ "shape":"String", "documentation":"

A description.

", "locationName":"description" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the network interface.

", "locationName":"ownerId" }, "RequesterId":{ "shape":"String", "documentation":"

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", "locationName":"requesterId" }, "RequesterManaged":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is being managed by AWS.

", "locationName":"requesterManaged" }, "Status":{ "shape":"NetworkInterfaceStatus", "documentation":"

The status of the network interface.

", "locationName":"status" }, "MacAddress":{ "shape":"String", "documentation":"

The MAC address.

", "locationName":"macAddress" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Indicates whether traffic to or from the instance is validated.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

Any security groups for the network interface.

", "locationName":"groupSet" }, "Attachment":{ "shape":"NetworkInterfaceAttachment", "documentation":"

The network interface attachment.

", "locationName":"attachment" }, "Association":{ "shape":"NetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP associated with the network interface.

", "locationName":"association" }, "TagSet":{ "shape":"TagList", "documentation":"

Any tags assigned to the network interface.

", "locationName":"tagSet" }, "PrivateIpAddresses":{ "shape":"NetworkInterfacePrivateIpAddressList", "documentation":"

The private IP addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" }, "InterfaceType":{ "shape":"NetworkInterfaceType", "documentation":"

The type of interface.

", "locationName":"interfaceType" } }, "documentation":"

Describes a network interface.

" }, "NetworkInterfaceAssociation":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The address of the Elastic IP address bound to the network interface.

", "locationName":"publicIp" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name.

", "locationName":"publicDnsName" }, "IpOwnerId":{ "shape":"String", "documentation":"

The ID of the Elastic IP address owner.

", "locationName":"ipOwnerId" }, "AllocationId":{ "shape":"String", "documentation":"

The allocation ID.

", "locationName":"allocationId" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID.

", "locationName":"associationId" } }, "documentation":"

Describes association information for an Elastic IP address.

" }, "NetworkInterfaceAttachment":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "InstanceOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the instance.

", "locationName":"instanceOwnerId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The device index of the network interface attachment on the instance.

", "locationName":"deviceIndex" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The timestamp indicating when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a network interface attachment.

" }, "NetworkInterfaceAttachmentChanges":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes an attachment change.

" }, "NetworkInterfaceAttribute":{ "type":"string", "enum":[ "description", "groupSet", "sourceDestCheck", "attachment" ] }, "NetworkInterfaceIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "NetworkInterfaceList":{ "type":"list", "member":{ "shape":"NetworkInterface", "locationName":"item" } }, "NetworkInterfacePrivateIpAddress":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", "locationName":"primary" }, "Association":{ "shape":"NetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address associated with the network interface.

", "locationName":"association" } }, "documentation":"

Describes the private IP address of a network interface.

" }, "NetworkInterfacePrivateIpAddressList":{ "type":"list", "member":{ "shape":"NetworkInterfacePrivateIpAddress", "locationName":"item" } }, "NetworkInterfaceStatus":{ "type":"string", "enum":[ "available", "attaching", "in-use", "detaching" ] }, "NetworkInterfaceType":{ "type":"string", "enum":[ "interface", "natGateway" ] }, "NewDhcpConfiguration":{ "type":"structure", "members":{ "Key":{ "shape":"String", "locationName":"key" }, "Values":{ "shape":"ValueStringList", "locationName":"Value" } } }, "NewDhcpConfigurationList":{ "type":"list", "member":{ "shape":"NewDhcpConfiguration", "locationName":"item" } }, "NextToken":{ "type":"string", "max":1024, "min":1 }, "OccurrenceDayRequestSet":{ "type":"list", "member":{ "shape":"Integer", "locationName":"OccurenceDay" } }, "OccurrenceDaySet":{ "type":"list", "member":{ "shape":"Integer", "locationName":"item" } }, "OfferingTypeValues":{ "type":"string", "enum":[ "Heavy Utilization", "Medium Utilization", "Light Utilization", "No Upfront", "Partial Upfront", "All Upfront" ] }, "OperationType":{ "type":"string", "enum":[ "add", "remove" ] }, "OwnerStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"Owner" } }, "PeeringConnectionOptions":{ "type":"structure", "members":{ "AllowEgressFromLocalClassicLinkToRemoteVpc":{ "shape":"Boolean", "documentation":"

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

", "locationName":"allowEgressFromLocalClassicLinkToRemoteVpc" }, "AllowEgressFromLocalVpcToRemoteClassicLink":{ "shape":"Boolean", "documentation":"

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

", "locationName":"allowEgressFromLocalVpcToRemoteClassicLink" } }, "documentation":"

Describes the VPC peering connection options.

" }, "PeeringConnectionOptionsRequest":{ "type":"structure", "required":[ "AllowEgressFromLocalClassicLinkToRemoteVpc", "AllowEgressFromLocalVpcToRemoteClassicLink" ], "members":{ "AllowEgressFromLocalClassicLinkToRemoteVpc":{ "shape":"Boolean", "documentation":"

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

" }, "AllowEgressFromLocalVpcToRemoteClassicLink":{ "shape":"Boolean", "documentation":"

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

" } }, "documentation":"

The VPC peering connection options.

" }, "PermissionGroup":{ "type":"string", "enum":["all"] }, "Placement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the instance.

", "locationName":"availabilityZone" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group the instance is in (for cluster compute instances).

", "locationName":"groupName" }, "Tenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

", "locationName":"tenancy" }, "HostId":{ "shape":"String", "documentation":"

The ID of the Dedicted host on which the instance resides. This parameter is not support for the ImportInstance command.

", "locationName":"hostId" }, "Affinity":{ "shape":"String", "documentation":"

The affinity setting for the instance on the Dedicated host. This parameter is not supported for the ImportInstance command.

", "locationName":"affinity" } }, "documentation":"

Describes the placement for the instance.

" }, "PlacementGroup":{ "type":"structure", "members":{ "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"

The placement strategy.

", "locationName":"strategy" }, "State":{ "shape":"PlacementGroupState", "documentation":"

The state of the placement group.

", "locationName":"state" } }, "documentation":"

Describes a placement group.

" }, "PlacementGroupList":{ "type":"list", "member":{ "shape":"PlacementGroup", "locationName":"item" } }, "PlacementGroupState":{ "type":"string", "enum":[ "pending", "available", "deleting", "deleted" ] }, "PlacementGroupStringList":{ "type":"list", "member":{"shape":"String"} }, "PlacementStrategy":{ "type":"string", "enum":["cluster"] }, "PlatformValues":{ "type":"string", "enum":["Windows"] }, "PortRange":{ "type":"structure", "members":{ "From":{ "shape":"Integer", "documentation":"

The first port in the range.

", "locationName":"from" }, "To":{ "shape":"Integer", "documentation":"

The last port in the range.

", "locationName":"to" } }, "documentation":"

Describes a range of ports.

" }, "PrefixList":{ "type":"structure", "members":{ "PrefixListId":{ "shape":"String", "documentation":"

The ID of the prefix.

", "locationName":"prefixListId" }, "PrefixListName":{ "shape":"String", "documentation":"

The name of the prefix.

", "locationName":"prefixListName" }, "Cidrs":{ "shape":"ValueStringList", "documentation":"

The IP address range of the AWS service.

", "locationName":"cidrSet" } }, "documentation":"

Describes prefixes for AWS services.

" }, "PrefixListId":{ "type":"structure", "members":{ "PrefixListId":{ "shape":"String", "documentation":"

The ID of the prefix.

", "locationName":"prefixListId" } }, "documentation":"

The ID of the prefix.

" }, "PrefixListIdList":{ "type":"list", "member":{ "shape":"PrefixListId", "locationName":"item" } }, "PrefixListIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "PrefixListSet":{ "type":"list", "member":{ "shape":"PrefixList", "locationName":"item" } }, "PriceSchedule":{ "type":"structure", "members":{ "Term":{ "shape":"Long", "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"

The fixed price for the term.

", "locationName":"price" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "Active":{ "shape":"Boolean", "documentation":"

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", "locationName":"active" } }, "documentation":"

Describes the price for a Reserved Instance.

" }, "PriceScheduleList":{ "type":"list", "member":{ "shape":"PriceSchedule", "locationName":"item" } }, "PriceScheduleSpecification":{ "type":"structure", "members":{ "Term":{ "shape":"Long", "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"

The fixed price for the term.

", "locationName":"price" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } }, "documentation":"

Describes the price for a Reserved Instance.

" }, "PriceScheduleSpecificationList":{ "type":"list", "member":{ "shape":"PriceScheduleSpecification", "locationName":"item" } }, "PricingDetail":{ "type":"structure", "members":{ "Price":{ "shape":"Double", "documentation":"

The price per instance.

", "locationName":"price" }, "Count":{ "shape":"Integer", "documentation":"

The number of reservations available for the price.

", "locationName":"count" } }, "documentation":"

Describes a Reserved Instance offering.

" }, "PricingDetailsList":{ "type":"list", "member":{ "shape":"PricingDetail", "locationName":"item" } }, "PrivateIpAddressConfigSet":{ "type":"list", "member":{ "shape":"ScheduledInstancesPrivateIpAddressConfig", "locationName":"PrivateIpAddressConfigSet" } }, "PrivateIpAddressSpecification":{ "type":"structure", "required":["PrivateIpAddress"], "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP addresses.

", "locationName":"privateIpAddress" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

", "locationName":"primary" } }, "documentation":"

Describes a secondary private IP address for a network interface.

" }, "PrivateIpAddressSpecificationList":{ "type":"list", "member":{ "shape":"PrivateIpAddressSpecification", "locationName":"item" } }, "PrivateIpAddressStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"PrivateIpAddress" } }, "ProductCode":{ "type":"structure", "members":{ "ProductCodeId":{ "shape":"String", "documentation":"

The product code.

", "locationName":"productCode" }, "ProductCodeType":{ "shape":"ProductCodeValues", "documentation":"

The type of product code.

", "locationName":"type" } }, "documentation":"

Describes a product code.

" }, "ProductCodeList":{ "type":"list", "member":{ "shape":"ProductCode", "locationName":"item" } }, "ProductCodeStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ProductCode" } }, "ProductCodeValues":{ "type":"string", "enum":[ "devpay", "marketplace" ] }, "ProductDescriptionList":{ "type":"list", "member":{"shape":"String"} }, "PropagatingVgw":{ "type":"structure", "members":{ "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway (VGW).

", "locationName":"gatewayId" } }, "documentation":"

Describes a virtual private gateway propagating route.

" }, "PropagatingVgwList":{ "type":"list", "member":{ "shape":"PropagatingVgw", "locationName":"item" } }, "ProvisionedBandwidth":{ "type":"structure", "members":{ "Provisioned":{ "shape":"String", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"provisioned" }, "Requested":{ "shape":"String", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"requested" }, "RequestTime":{ "shape":"DateTime", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"requestTime" }, "ProvisionTime":{ "shape":"DateTime", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"provisionTime" }, "Status":{ "shape":"String", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"status" } }, "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

" }, "PublicIpStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"PublicIp" } }, "PurchaseRequest":{ "type":"structure", "required":[ "PurchaseToken", "InstanceCount" ], "members":{ "PurchaseToken":{ "shape":"String", "documentation":"

The purchase token.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances.

" } }, "documentation":"

Describes a request to purchase Scheduled Instances.

" }, "PurchaseRequestSet":{ "type":"list", "member":{ "shape":"PurchaseRequest", "locationName":"PurchaseRequest" }, "min":1 }, "PurchaseReservedInstancesOfferingRequest":{ "type":"structure", "required":[ "ReservedInstancesOfferingId", "InstanceCount" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance offering to purchase.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of Reserved Instances to purchase.

" }, "LimitPrice":{ "shape":"ReservedInstanceLimitPrice", "documentation":"

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", "locationName":"limitPrice" } }, "documentation":"

Contains the parameters for PurchaseReservedInstancesOffering.

" }, "PurchaseReservedInstancesOfferingResult":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The IDs of the purchased Reserved Instances.

", "locationName":"reservedInstancesId" } }, "documentation":"

Contains the output of PurchaseReservedInstancesOffering.

" }, "PurchaseScheduledInstancesRequest":{ "type":"structure", "required":["PurchaseRequests"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

", "idempotencyToken":true }, "PurchaseRequests":{ "shape":"PurchaseRequestSet", "documentation":"

One or more purchase requests.

", "locationName":"PurchaseRequest" } }, "documentation":"

Contains the parameters for PurchaseScheduledInstances.

" }, "PurchaseScheduledInstancesResult":{ "type":"structure", "members":{ "ScheduledInstanceSet":{ "shape":"PurchasedScheduledInstanceSet", "documentation":"

Information about the Scheduled Instances.

", "locationName":"scheduledInstanceSet" } }, "documentation":"

Contains the output of PurchaseScheduledInstances.

" }, "PurchasedScheduledInstanceSet":{ "type":"list", "member":{ "shape":"ScheduledInstance", "locationName":"item" } }, "RIProductDescription":{ "type":"string", "enum":[ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ] }, "ReasonCodesList":{ "type":"list", "member":{ "shape":"ReportInstanceReasonCodes", "locationName":"item" } }, "RebootInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } }, "documentation":"

Contains the parameters for RebootInstances.

" }, "RecurringCharge":{ "type":"structure", "members":{ "Frequency":{ "shape":"RecurringChargeFrequency", "documentation":"

The frequency of the recurring charge.

", "locationName":"frequency" }, "Amount":{ "shape":"Double", "documentation":"

The amount of the recurring charge.

", "locationName":"amount" } }, "documentation":"

Describes a recurring charge.

" }, "RecurringChargeFrequency":{ "type":"string", "enum":["Hourly"] }, "RecurringChargesList":{ "type":"list", "member":{ "shape":"RecurringCharge", "locationName":"item" } }, "Region":{ "type":"structure", "members":{ "RegionName":{ "shape":"String", "documentation":"

The name of the region.

", "locationName":"regionName" }, "Endpoint":{ "shape":"String", "documentation":"

The region service endpoint.

", "locationName":"regionEndpoint" } }, "documentation":"

Describes a region.

" }, "RegionList":{ "type":"list", "member":{ "shape":"Region", "locationName":"item" } }, "RegionNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"RegionName" } }, "RegisterImageRequest":{ "type":"structure", "required":["Name"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageLocation":{ "shape":"String", "documentation":"

The full path to your AMI manifest in Amazon S3 storage.

" }, "Name":{ "shape":"String", "documentation":"

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

A description for your AMI.

", "locationName":"description" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

", "locationName":"architecture" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "RootDeviceName":{ "shape":"String", "documentation":"

The name of the root device (for example, /dev/sda1, or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

One or more block device mapping entries.

", "locationName":"BlockDeviceMapping" }, "VirtualizationType":{ "shape":"String", "documentation":"

The type of virtualization.

Default: paravirtual

", "locationName":"virtualizationType" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Set to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", "locationName":"sriovNetSupport" } }, "documentation":"

Contains the parameters for RegisterImage.

" }, "RegisterImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the newly registered AMI.

", "locationName":"imageId" } }, "documentation":"

Contains the output of RegisterImage.

" }, "RejectVpcPeeringConnectionRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Contains the parameters for RejectVpcPeeringConnection.

" }, "RejectVpcPeeringConnectionResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of RejectVpcPeeringConnection.

" }, "ReleaseAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" } }, "documentation":"

Contains the parameters for ReleaseAddress.

" }, "ReleaseHostsRequest":{ "type":"structure", "required":["HostIds"], "members":{ "HostIds":{ "shape":"RequestHostIdList", "documentation":"

The IDs of the Dedicated hosts you want to release.

", "locationName":"hostId" } }, "documentation":"

Contains the parameters for ReleaseHosts.

" }, "ReleaseHostsResult":{ "type":"structure", "members":{ "Successful":{ "shape":"ResponseHostIdList", "documentation":"

The IDs of the Dedicated hosts that were successfully released.

", "locationName":"successful" }, "Unsuccessful":{ "shape":"UnsuccessfulItemList", "documentation":"

The IDs of the Dedicated hosts that could not be released, including an error message.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of ReleaseHosts.

" }, "ReplaceNetworkAclAssociationRequest":{ "type":"structure", "required":[ "AssociationId", "NetworkAclId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The ID of the current association between the original network ACL and the subnet.

", "locationName":"associationId" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the new network ACL to associate with the subnet.

", "locationName":"networkAclId" } }, "documentation":"

Contains the parameters for ReplaceNetworkAclAssociation.

" }, "ReplaceNetworkAclAssociationResult":{ "type":"structure", "members":{ "NewAssociationId":{ "shape":"String", "documentation":"

The ID of the new association.

", "locationName":"newAssociationId" } }, "documentation":"

Contains the output of ReplaceNetworkAclAssociation.

" }, "ReplaceNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Protocol", "RuleAction", "Egress", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number of the entry to replace.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The IP protocol. You can specify all or -1 to mean all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation.

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.

", "locationName":"Icmp" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.

", "locationName":"portRange" } }, "documentation":"

Contains the parameters for ReplaceNetworkAclEntry.

" }, "ReplaceRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of an Internet gateway or virtual private gateway.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC.

", "locationName":"instanceId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of a network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of a VPC peering connection.

", "locationName":"vpcPeeringConnectionId" }, "NatGatewayId":{ "shape":"String", "documentation":"

The ID of a NAT gateway.

", "locationName":"natGatewayId" } }, "documentation":"

Contains the parameters for ReplaceRoute.

" }, "ReplaceRouteTableAssociationRequest":{ "type":"structure", "required":[ "AssociationId", "RouteTableId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID.

", "locationName":"associationId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the new route table to associate with the subnet.

", "locationName":"routeTableId" } }, "documentation":"

Contains the parameters for ReplaceRouteTableAssociation.

" }, "ReplaceRouteTableAssociationResult":{ "type":"structure", "members":{ "NewAssociationId":{ "shape":"String", "documentation":"

The ID of the new association.

", "locationName":"newAssociationId" } }, "documentation":"

Contains the output of ReplaceRouteTableAssociation.

" }, "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" ] }, "ReportInstanceStatusRequest":{ "type":"structure", "required":[ "Instances", "Status", "ReasonCodes" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Instances":{ "shape":"InstanceIdStringList", "documentation":"

One or more instances.

", "locationName":"instanceId" }, "Status":{ "shape":"ReportStatusType", "documentation":"

The status of all instances listed.

", "locationName":"status" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time at which the reported instance health state began.

", "locationName":"startTime" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time at which the reported instance health state ended.

", "locationName":"endTime" }, "ReasonCodes":{ "shape":"ReasonCodesList", "documentation":"

One or more reason codes that describes the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems which I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

", "locationName":"reasonCode" }, "Description":{ "shape":"String", "documentation":"

Descriptive text about the health state of your instance.

", "locationName":"description" } }, "documentation":"

Contains the parameters for ReportInstanceStatus.

" }, "ReportStatusType":{ "type":"string", "enum":[ "ok", "impaired" ] }, "RequestHostIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "RequestSpotFleetRequest":{ "type":"structure", "required":["SpotFleetRequestConfig"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestConfig":{ "shape":"SpotFleetRequestConfigData", "documentation":"

The configuration for the Spot fleet request.

", "locationName":"spotFleetRequestConfig" } }, "documentation":"

Contains the parameters for RequestSpotFleet.

" }, "RequestSpotFleetResponse":{ "type":"structure", "required":["SpotFleetRequestId"], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" } }, "documentation":"

Contains the output of RequestSpotFleet.

" }, "RequestSpotInstancesRequest":{ "type":"structure", "required":["SpotPrice"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum hourly price (bid) for any Spot instance launched to fulfill the request.

", "locationName":"spotPrice" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"clientToken" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The maximum number of Spot instances to launch.

Default: 1

", "locationName":"instanceCount" }, "Type":{ "shape":"SpotInstanceType", "documentation":"

The Spot instance request type.

Default: one-time

", "locationName":"type" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

Default: The request is effective indefinitely.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

Default: The request is effective indefinitely.

", "locationName":"validUntil" }, "LaunchGroup":{ "shape":"String", "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

Default: Instances are launched and terminated individually

", "locationName":"launchGroup" }, "AvailabilityZoneGroup":{ "shape":"String", "documentation":"

The user-specified name for a logical grouping of bids.

When you specify an Availability Zone group in a Spot Instance request, all Spot instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", "locationName":"availabilityZoneGroup" }, "BlockDurationMinutes":{ "shape":"Integer", "documentation":"

The required duration for the Spot instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

The duration period starts as soon as your Spot instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.

Note that you can't specify an Availability Zone group or a launch group if you specify a duration.

", "locationName":"blockDurationMinutes" }, "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} }, "documentation":"

Contains the parameters for RequestSpotInstances.

" }, "RequestSpotInstancesResult":{ "type":"structure", "members":{ "SpotInstanceRequests":{ "shape":"SpotInstanceRequestList", "documentation":"

One or more Spot instance requests.

", "locationName":"spotInstanceRequestSet" } }, "documentation":"

Contains the output of RequestSpotInstances.

" }, "RequestSpotLaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"ValueStringList", "locationName":"SecurityGroup" }, "UserData":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.

", "locationName":"blockDeviceMapping" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"NetworkInterface" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" }, "SecurityGroupIds":{ "shape":"ValueStringList", "locationName":"SecurityGroupId" } }, "documentation":"

Describes the launch specification for an instance.

" }, "Reservation":{ "type":"structure", "members":{ "ReservationId":{ "shape":"String", "documentation":"

The ID of the reservation.

", "locationName":"reservationId" }, "OwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that owns the reservation.

", "locationName":"ownerId" }, "RequesterId":{ "shape":"String", "documentation":"

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

", "locationName":"requesterId" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

[EC2-Classic only] One or more security groups.

", "locationName":"groupSet" }, "Instances":{ "shape":"InstanceList", "documentation":"

One or more instances.

", "locationName":"instancesSet" } }, "documentation":"

Describes a reservation.

" }, "ReservationList":{ "type":"list", "member":{ "shape":"Reservation", "locationName":"item" } }, "ReservedInstanceLimitPrice":{ "type":"structure", "members":{ "Amount":{ "shape":"Double", "documentation":"

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", "locationName":"amount" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } }, "documentation":"

Describes the limit price of a Reserved Instance offering.

" }, "ReservedInstanceState":{ "type":"string", "enum":[ "payment-pending", "active", "payment-failed", "retired" ] }, "ReservedInstances":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used.

", "locationName":"instanceType" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", "locationName":"availabilityZone" }, "Start":{ "shape":"DateTime", "documentation":"

The date and time the Reserved Instance started.

", "locationName":"start" }, "End":{ "shape":"DateTime", "documentation":"

The time when the Reserved Instance expires.

", "locationName":"end" }, "Duration":{ "shape":"Long", "documentation":"

The duration of the Reserved Instance, in seconds.

", "locationName":"duration" }, "UsagePrice":{ "shape":"Float", "documentation":"

The usage price of the Reserved Instance, per hour.

", "locationName":"usagePrice" }, "FixedPrice":{ "shape":"Float", "documentation":"

The purchase price of the Reserved Instance.

", "locationName":"fixedPrice" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of reservations purchased.

", "locationName":"instanceCount" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance product platform description.

", "locationName":"productDescription" }, "State":{ "shape":"ReservedInstanceState", "documentation":"

The state of the Reserved Instance purchase.

", "locationName":"state" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance.

", "locationName":"instanceTenancy" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type.

", "locationName":"offeringType" }, "RecurringCharges":{ "shape":"RecurringChargesList", "documentation":"

The recurring charge tag assigned to the resource.

", "locationName":"recurringCharges" } }, "documentation":"

Describes a Reserved Instance.

" }, "ReservedInstancesConfiguration":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the modified Reserved Instances.

", "locationName":"availabilityZone" }, "Platform":{ "shape":"String", "documentation":"

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", "locationName":"platform" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of modified Reserved Instances.

", "locationName":"instanceCount" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type for the modified Reserved Instances.

", "locationName":"instanceType" } }, "documentation":"

Describes the configuration settings for the modified Reserved Instances.

" }, "ReservedInstancesConfigurationList":{ "type":"list", "member":{ "shape":"ReservedInstancesConfiguration", "locationName":"item" } }, "ReservedInstancesId":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" } }, "documentation":"

Describes the ID of a Reserved Instance.

" }, "ReservedInstancesIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstancesId" } }, "ReservedInstancesList":{ "type":"list", "member":{ "shape":"ReservedInstances", "locationName":"item" } }, "ReservedInstancesListing":{ "type":"structure", "members":{ "ReservedInstancesListingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance listing.

", "locationName":"reservedInstancesListingId" }, "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The time the listing was created.

", "locationName":"createDate" }, "UpdateDate":{ "shape":"DateTime", "documentation":"

The last modified timestamp of the listing.

", "locationName":"updateDate" }, "Status":{ "shape":"ListingStatus", "documentation":"

The status of the Reserved Instance listing.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The reason for the current status of the Reserved Instance listing. The response can be blank.

", "locationName":"statusMessage" }, "InstanceCounts":{ "shape":"InstanceCountList", "documentation":"

The number of instances in this state.

", "locationName":"instanceCounts" }, "PriceSchedules":{ "shape":"PriceScheduleList", "documentation":"

The price of the Reserved Instance listing.

", "locationName":"priceSchedules" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Describes a Reserved Instance listing.

" }, "ReservedInstancesListingList":{ "type":"list", "member":{ "shape":"ReservedInstancesListing", "locationName":"item" } }, "ReservedInstancesModification":{ "type":"structure", "members":{ "ReservedInstancesModificationId":{ "shape":"String", "documentation":"

A unique ID for the Reserved Instance modification.

", "locationName":"reservedInstancesModificationId" }, "ReservedInstancesIds":{ "shape":"ReservedIntancesIds", "documentation":"

The IDs of one or more Reserved Instances.

", "locationName":"reservedInstancesSet" }, "ModificationResults":{ "shape":"ReservedInstancesModificationResultList", "documentation":"

Contains target configurations along with their corresponding new Reserved Instance IDs.

", "locationName":"modificationResultSet" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The time when the modification request was created.

", "locationName":"createDate" }, "UpdateDate":{ "shape":"DateTime", "documentation":"

The time when the modification request was last updated.

", "locationName":"updateDate" }, "EffectiveDate":{ "shape":"DateTime", "documentation":"

The time for the modification to become effective.

", "locationName":"effectiveDate" }, "Status":{ "shape":"String", "documentation":"

The status of the Reserved Instances modification request.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The reason for the status.

", "locationName":"statusMessage" }, "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Describes a Reserved Instance modification.

" }, "ReservedInstancesModificationIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstancesModificationId" } }, "ReservedInstancesModificationList":{ "type":"list", "member":{ "shape":"ReservedInstancesModification", "locationName":"item" } }, "ReservedInstancesModificationResult":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", "locationName":"reservedInstancesId" }, "TargetConfiguration":{ "shape":"ReservedInstancesConfiguration", "documentation":"

The target Reserved Instances configurations supplied as part of the modification request.

", "locationName":"targetConfiguration" } }, "documentation":"

Describes the modification request/s.

" }, "ReservedInstancesModificationResultList":{ "type":"list", "member":{ "shape":"ReservedInstancesModificationResult", "locationName":"item" } }, "ReservedInstancesOffering":{ "type":"structure", "members":{ "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance offering.

", "locationName":"reservedInstancesOfferingId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used.

", "locationName":"instanceType" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", "locationName":"availabilityZone" }, "Duration":{ "shape":"Long", "documentation":"

The duration of the Reserved Instance, in seconds.

", "locationName":"duration" }, "UsagePrice":{ "shape":"Float", "documentation":"

The usage price of the Reserved Instance, per hour.

", "locationName":"usagePrice" }, "FixedPrice":{ "shape":"Float", "documentation":"

The purchase price of the Reserved Instance.

", "locationName":"fixedPrice" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance product platform description.

", "locationName":"productDescription" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance.

", "locationName":"instanceTenancy" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type.

", "locationName":"offeringType" }, "RecurringCharges":{ "shape":"RecurringChargesList", "documentation":"

The recurring charge tag assigned to the resource.

", "locationName":"recurringCharges" }, "Marketplace":{ "shape":"Boolean", "documentation":"

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

", "locationName":"marketplace" }, "PricingDetails":{ "shape":"PricingDetailsList", "documentation":"

The pricing details of the Reserved Instance offering.

", "locationName":"pricingDetailsSet" } }, "documentation":"

Describes a Reserved Instance offering.

" }, "ReservedInstancesOfferingIdStringList":{ "type":"list", "member":{"shape":"String"} }, "ReservedInstancesOfferingList":{ "type":"list", "member":{ "shape":"ReservedInstancesOffering", "locationName":"item" } }, "ReservedIntancesIds":{ "type":"list", "member":{ "shape":"ReservedInstancesId", "locationName":"item" } }, "ResetImageAttributeName":{ "type":"string", "enum":["launchPermission"] }, "ResetImageAttributeRequest":{ "type":"structure", "required":[ "ImageId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"ResetImageAttributeName", "documentation":"

The attribute to reset (currently you can only reset the launch permission attribute).

" } }, "documentation":"

Contains the parameters for ResetImageAttribute.

" }, "ResetInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The attribute to reset.

You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.

", "locationName":"attribute" } }, "documentation":"

Contains the parameters for ResetInstanceAttribute.

" }, "ResetNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SourceDestCheck":{ "shape":"String", "documentation":"

The source/destination checking attribute. Resets the value to true.

", "locationName":"sourceDestCheck" } }, "documentation":"

Contains the parameters for ResetNetworkInterfaceAttribute.

" }, "ResetSnapshotAttributeRequest":{ "type":"structure", "required":[ "SnapshotId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.

" } }, "documentation":"

Contains the parameters for ResetSnapshotAttribute.

" }, "ResourceIdList":{ "type":"list", "member":{"shape":"String"} }, "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" ] }, "ResponseHostIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "RestorableByStringList":{ "type":"list", "member":{"shape":"String"} }, "RestoreAddressToClassicRequest":{ "type":"structure", "required":["PublicIp"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" } }, "documentation":"

Contains the parameters for RestoreAddressToClassic.

" }, "RestoreAddressToClassicResult":{ "type":"structure", "members":{ "Status":{ "shape":"Status", "documentation":"

The move status for the IP address.

", "locationName":"status" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" } }, "documentation":"

Contains the output of RestoreAddressToClassic.

" }, "RevokeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

The name of a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account number for a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", "locationName":"toPort" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.

", "locationName":"cidrIp" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"ipPermissions" } }, "documentation":"

Contains the parameters for RevokeSecurityGroupEgress.

" }, "RevokeSecurityGroupIngressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a security group in a nondefault VPC.

" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" } }, "documentation":"

Contains the parameters for RevokeSecurityGroupIngress.

" }, "Route":{ "type":"structure", "members":{ "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block used for the destination match.

", "locationName":"destinationCidrBlock" }, "DestinationPrefixListId":{ "shape":"String", "documentation":"

The prefix of the AWS service.

", "locationName":"destinationPrefixListId" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of a gateway attached to your VPC.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC.

", "locationName":"instanceId" }, "InstanceOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the instance.

", "locationName":"instanceOwnerId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" }, "NatGatewayId":{ "shape":"String", "documentation":"

The ID of a NAT gateway.

", "locationName":"natGatewayId" }, "State":{ "shape":"RouteState", "documentation":"

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

", "locationName":"state" }, "Origin":{ "shape":"RouteOrigin", "documentation":"

Describes how the route was created.

  • CreateRouteTable - The route was automatically created when the route table was created.

  • CreateRoute - The route was manually added to the route table.

  • EnableVgwRoutePropagation - The route was propagated by route propagation.

", "locationName":"origin" } }, "documentation":"

Describes a route in a route table.

" }, "RouteList":{ "type":"list", "member":{ "shape":"Route", "locationName":"item" } }, "RouteOrigin":{ "type":"string", "enum":[ "CreateRouteTable", "CreateRoute", "EnableVgwRoutePropagation" ] }, "RouteState":{ "type":"string", "enum":[ "active", "blackhole" ] }, "RouteTable":{ "type":"structure", "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Routes":{ "shape":"RouteList", "documentation":"

The routes in the route table.

", "locationName":"routeSet" }, "Associations":{ "shape":"RouteTableAssociationList", "documentation":"

The associations between the route table and one or more subnets.

", "locationName":"associationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the route table.

", "locationName":"tagSet" }, "PropagatingVgws":{ "shape":"PropagatingVgwList", "documentation":"

Any virtual private gateway (VGW) propagating routes.

", "locationName":"propagatingVgwSet" } }, "documentation":"

Describes a route table.

" }, "RouteTableAssociation":{ "type":"structure", "members":{ "RouteTableAssociationId":{ "shape":"String", "documentation":"

The ID of the association between a route table and a subnet.

", "locationName":"routeTableAssociationId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet. A subnet ID is not returned for an implicit association.

", "locationName":"subnetId" }, "Main":{ "shape":"Boolean", "documentation":"

Indicates whether this is the main route table.

", "locationName":"main" } }, "documentation":"

Describes an association between a route table and a subnet.

" }, "RouteTableAssociationList":{ "type":"list", "member":{ "shape":"RouteTableAssociation", "locationName":"item" } }, "RouteTableList":{ "type":"list", "member":{ "shape":"RouteTable", "locationName":"item" } }, "RuleAction":{ "type":"string", "enum":[ "allow", "deny" ] }, "RunInstancesMonitoringEnabled":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Indicates whether monitoring is enabled for the instance.

", "locationName":"enabled" } }, "documentation":"

Describes the monitoring for the instance.

" }, "RunInstancesRequest":{ "type":"structure", "required":[ "ImageId", "MinCount", "MaxCount" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI, which you can get by calling DescribeImages.

" }, "MinCount":{ "shape":"Integer", "documentation":"

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" }, "MaxCount":{ "shape":"Integer", "documentation":"

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.

" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

" }, "SecurityGroups":{ "shape":"SecurityGroupStringList", "documentation":"

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

", "locationName":"SecurityGroup" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdStringList", "documentation":"

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

", "locationName":"SecurityGroupId" }, "UserData":{ "shape":"String", "documentation":"

Data to configure the instance, or a script to run during instance launch. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). For API calls, the text must be base64-encoded. For command line tools, the encoding is performed for you, and you can load the text from a file.

" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

" }, "Placement":{ "shape":"Placement", "documentation":"

The placement for the instance.

" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

The block device mapping.

", "locationName":"BlockDeviceMapping" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "documentation":"

The monitoring for the instance.

" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

" }, "DisableApiTermination":{ "shape":"Boolean", "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

", "locationName":"instanceInitiatedShutdownBehavior" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.

Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.

Default: We select an IP address from the IP address range of the subnet.

", "locationName":"privateIpAddress" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

", "locationName":"clientToken" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterface" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

", "locationName":"ebsOptimized" } }, "documentation":"

Contains the parameters for RunInstances.

" }, "RunScheduledInstancesRequest":{ "type":"structure", "required":[ "ScheduledInstanceId", "LaunchSpecification" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

", "idempotencyToken":true }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances.

Default: 1

" }, "ScheduledInstanceId":{ "shape":"String", "documentation":"

The Scheduled Instance ID.

" }, "LaunchSpecification":{ "shape":"ScheduledInstancesLaunchSpecification", "documentation":"

The launch specification.

" } }, "documentation":"

Contains the parameters for RunScheduledInstances.

" }, "RunScheduledInstancesResult":{ "type":"structure", "members":{ "InstanceIdSet":{ "shape":"InstanceIdSet", "documentation":"

The IDs of the newly launched instances.

", "locationName":"instanceIdSet" } }, "documentation":"

Contains the output of RunScheduledInstances.

" }, "S3Storage":{ "type":"structure", "members":{ "Bucket":{ "shape":"String", "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

The beginning of the file name of the AMI.

", "locationName":"prefix" }, "AWSAccessKeyId":{ "shape":"String", "documentation":"

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

" }, "UploadPolicy":{ "shape":"Blob", "documentation":"

A base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf. For command line tools, base64 encoding is performed for you.

", "locationName":"uploadPolicy" }, "UploadPolicySignature":{ "shape":"String", "documentation":"

The signature of the Base64 encoded JSON document.

", "locationName":"uploadPolicySignature" } }, "documentation":"

Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI.

" }, "ScheduledInstance":{ "type":"structure", "members":{ "ScheduledInstanceId":{ "shape":"String", "documentation":"

The Scheduled Instance ID.

", "locationName":"scheduledInstanceId" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Platform":{ "shape":"String", "documentation":"

The platform (Linux/UNIX or Windows).

", "locationName":"platform" }, "NetworkPlatform":{ "shape":"String", "documentation":"

The network platform (EC2-Classic or EC2-VPC).

", "locationName":"networkPlatform" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "SlotDurationInHours":{ "shape":"Integer", "documentation":"

The number of hours in the schedule.

", "locationName":"slotDurationInHours" }, "Recurrence":{ "shape":"ScheduledInstanceRecurrence", "documentation":"

The schedule recurrence.

", "locationName":"recurrence" }, "PreviousSlotEndTime":{ "shape":"DateTime", "documentation":"

The time that the previous schedule ended or will end.

", "locationName":"previousSlotEndTime" }, "NextSlotStartTime":{ "shape":"DateTime", "documentation":"

The time for the next schedule to start.

", "locationName":"nextSlotStartTime" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price for a single instance.

", "locationName":"hourlyPrice" }, "TotalScheduledInstanceHours":{ "shape":"Integer", "documentation":"

The total number of hours for a single instance for the entire term.

", "locationName":"totalScheduledInstanceHours" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances.

", "locationName":"instanceCount" }, "TermStartDate":{ "shape":"DateTime", "documentation":"

The start date for the Scheduled Instance.

", "locationName":"termStartDate" }, "TermEndDate":{ "shape":"DateTime", "documentation":"

The end date for the Scheduled Instance.

", "locationName":"termEndDate" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The date when the Scheduled Instance was purchased.

", "locationName":"createDate" } }, "documentation":"

Describes a Scheduled Instance.

" }, "ScheduledInstanceAvailability":{ "type":"structure", "members":{ "InstanceType":{ "shape":"String", "documentation":"

The instance type. You can specify one of the C3, C4, M4, or R3 instance types.

", "locationName":"instanceType" }, "Platform":{ "shape":"String", "documentation":"

The platform (Linux/UNIX or Windows).

", "locationName":"platform" }, "NetworkPlatform":{ "shape":"String", "documentation":"

The network platform (EC2-Classic or EC2-VPC).

", "locationName":"networkPlatform" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "PurchaseToken":{ "shape":"String", "documentation":"

The purchase token. This token expires in two hours.

", "locationName":"purchaseToken" }, "SlotDurationInHours":{ "shape":"Integer", "documentation":"

The number of hours in the schedule.

", "locationName":"slotDurationInHours" }, "Recurrence":{ "shape":"ScheduledInstanceRecurrence", "documentation":"

The schedule recurrence.

", "locationName":"recurrence" }, "FirstSlotStartTime":{ "shape":"DateTime", "documentation":"

The time period for the first schedule to start.

", "locationName":"firstSlotStartTime" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price for a single instance.

", "locationName":"hourlyPrice" }, "TotalScheduledInstanceHours":{ "shape":"Integer", "documentation":"

The total number of hours for a single instance for the entire term.

", "locationName":"totalScheduledInstanceHours" }, "AvailableInstanceCount":{ "shape":"Integer", "documentation":"

The number of available instances.

", "locationName":"availableInstanceCount" }, "MinTermDurationInDays":{ "shape":"Integer", "documentation":"

The minimum term. The only possible value is 365 days.

", "locationName":"minTermDurationInDays" }, "MaxTermDurationInDays":{ "shape":"Integer", "documentation":"

The maximum term. The only possible value is 365 days.

", "locationName":"maxTermDurationInDays" } }, "documentation":"

Describes a schedule that is available for your Scheduled Instances.

" }, "ScheduledInstanceAvailabilitySet":{ "type":"list", "member":{ "shape":"ScheduledInstanceAvailability", "locationName":"item" } }, "ScheduledInstanceIdRequestSet":{ "type":"list", "member":{ "shape":"String", "locationName":"ScheduledInstanceId" } }, "ScheduledInstanceRecurrence":{ "type":"structure", "members":{ "Frequency":{ "shape":"String", "documentation":"

The frequency (Daily, Weekly, or Monthly).

", "locationName":"frequency" }, "Interval":{ "shape":"Integer", "documentation":"

The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months.

", "locationName":"interval" }, "OccurrenceDaySet":{ "shape":"OccurrenceDaySet", "documentation":"

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).

", "locationName":"occurrenceDaySet" }, "OccurrenceRelativeToEnd":{ "shape":"Boolean", "documentation":"

Indicates whether the occurrence is relative to the end of the specified week or month.

", "locationName":"occurrenceRelativeToEnd" }, "OccurrenceUnit":{ "shape":"String", "documentation":"

The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).

", "locationName":"occurrenceUnit" } }, "documentation":"

Describes the recurring schedule for a Scheduled Instance.

" }, "ScheduledInstanceRecurrenceRequest":{ "type":"structure", "members":{ "Frequency":{ "shape":"String", "documentation":"

The frequency (Daily, Weekly, or Monthly).

" }, "Interval":{ "shape":"Integer", "documentation":"

The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.

" }, "OccurrenceDays":{ "shape":"OccurrenceDayRequestSet", "documentation":"

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.

", "locationName":"OccurrenceDay" }, "OccurrenceRelativeToEnd":{ "shape":"Boolean", "documentation":"

Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.

" }, "OccurrenceUnit":{ "shape":"String", "documentation":"

The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.

" } }, "documentation":"

Describes the recurring schedule for a Scheduled Instance.

" }, "ScheduledInstanceSet":{ "type":"list", "member":{ "shape":"ScheduledInstance", "locationName":"item" } }, "ScheduledInstancesBlockDeviceMapping":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

" }, "NoDevice":{ "shape":"String", "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

" }, "VirtualName":{ "shape":"String", "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

" }, "Ebs":{ "shape":"ScheduledInstancesEbs", "documentation":"

Parameters used to set up EBS volumes automatically when the instance is launched.

" } }, "documentation":"

Describes a block device mapping for a Scheduled Instance.

" }, "ScheduledInstancesBlockDeviceMappingSet":{ "type":"list", "member":{ "shape":"ScheduledInstancesBlockDeviceMapping", "locationName":"BlockDeviceMapping" } }, "ScheduledInstancesEbs":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

" }, "VolumeType":{ "shape":"String", "documentation":"

The volume type. gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for Magnetic.

Default: standard

" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about gp2 baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.

" } }, "documentation":"

Describes an EBS volume for a Scheduled Instance.

" }, "ScheduledInstancesIamInstanceProfile":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN).

" }, "Name":{ "shape":"String", "documentation":"

The name.

" } }, "documentation":"

Describes an IAM instance profile for a Scheduled Instance.

" }, "ScheduledInstancesLaunchSpecification":{ "type":"structure", "required":["ImageId"], "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the Amazon Machine Image (AMI).

" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

" }, "SecurityGroupIds":{ "shape":"ScheduledInstancesSecurityGroupIdSet", "documentation":"

The IDs of one or more security groups.

", "locationName":"SecurityGroupId" }, "UserData":{ "shape":"String", "documentation":"

The base64-encoded MIME user data.

" }, "Placement":{ "shape":"ScheduledInstancesPlacement", "documentation":"

The placement information.

" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type.

" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

" }, "BlockDeviceMappings":{ "shape":"ScheduledInstancesBlockDeviceMappingSet", "documentation":"

One or more block device mapping entries.

", "locationName":"BlockDeviceMapping" }, "Monitoring":{ "shape":"ScheduledInstancesMonitoring", "documentation":"

Enable or disable monitoring for the instances.

" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instances.

" }, "NetworkInterfaces":{ "shape":"ScheduledInstancesNetworkInterfaceSet", "documentation":"

One or more network interfaces.

", "locationName":"NetworkInterface" }, "IamInstanceProfile":{ "shape":"ScheduledInstancesIamInstanceProfile", "documentation":"

The IAM instance profile.

" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

" } }, "documentation":"

Describes the launch specification for a Scheduled Instance.

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.

" }, "ScheduledInstancesMonitoring":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Indicates whether monitoring is enabled.

" } }, "documentation":"

Describes whether monitoring is enabled for a Scheduled Instance.

" }, "ScheduledInstancesNetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device for the network interface attachment.

" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

" }, "Description":{ "shape":"String", "documentation":"

The description.

" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

" }, "PrivateIpAddressConfigs":{ "shape":"PrivateIpAddressConfigSet", "documentation":"

The private IP addresses.

", "locationName":"PrivateIpAddressConfig" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses.

" }, "AssociatePublicIpAddress":{ "shape":"Boolean", "documentation":"

Indicates whether to assign a public IP address to instances launched in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

" }, "Groups":{ "shape":"ScheduledInstancesSecurityGroupIdSet", "documentation":"

The IDs of one or more security groups.

", "locationName":"Group" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether to delete the interface when the instance is terminated.

" } }, "documentation":"

Describes a network interface for a Scheduled Instance.

" }, "ScheduledInstancesNetworkInterfaceSet":{ "type":"list", "member":{ "shape":"ScheduledInstancesNetworkInterface", "locationName":"NetworkInterface" } }, "ScheduledInstancesPlacement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

" } }, "documentation":"

Describes the placement for a Scheduled Instance.

" }, "ScheduledInstancesPrivateIpAddressConfig":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address.

" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this is a primary IP address. Otherwise, this is a secondary IP address.

" } }, "documentation":"

Describes a private IP address for a Scheduled Instance.

" }, "ScheduledInstancesSecurityGroupIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroupId" } }, "SecurityGroup":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the security group.

", "locationName":"ownerId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "Description":{ "shape":"String", "documentation":"

A description of the security group.

", "locationName":"groupDescription" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

One or more inbound rules associated with the security group.

", "locationName":"ipPermissions" }, "IpPermissionsEgress":{ "shape":"IpPermissionList", "documentation":"

[EC2-VPC] One or more outbound rules associated with the security group.

", "locationName":"ipPermissionsEgress" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC for the security group.

", "locationName":"vpcId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the security group.

", "locationName":"tagSet" } }, "documentation":"

Describes a security group

" }, "SecurityGroupIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroupId" } }, "SecurityGroupList":{ "type":"list", "member":{ "shape":"SecurityGroup", "locationName":"item" } }, "SecurityGroupReference":{ "type":"structure", "required":[ "GroupId", "ReferencingVpcId" ], "members":{ "GroupId":{ "shape":"String", "documentation":"

The ID of your security group.

", "locationName":"groupId" }, "ReferencingVpcId":{ "shape":"String", "documentation":"

The ID of the VPC with the referencing security group.

", "locationName":"referencingVpcId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Describes a VPC with a security group that references your security group.

" }, "SecurityGroupReferences":{ "type":"list", "member":{ "shape":"SecurityGroupReference", "locationName":"item" } }, "SecurityGroupStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroup" } }, "ShutdownBehavior":{ "type":"string", "enum":[ "stop", "terminate" ] }, "SlotDateTimeRangeRequest":{ "type":"structure", "required":[ "EarliestTime", "LatestTime" ], "members":{ "EarliestTime":{ "shape":"DateTime", "documentation":"

The earliest date and time, in UTC, for the Scheduled Instance to start.

" }, "LatestTime":{ "shape":"DateTime", "documentation":"

The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.

" } }, "documentation":"

Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.

" }, "SlotStartTimeRangeRequest":{ "type":"structure", "members":{ "EarliestTime":{ "shape":"DateTime", "documentation":"

The earliest date and time, in UTC, for the Scheduled Instance to start.

" }, "LatestTime":{ "shape":"DateTime", "documentation":"

The latest date and time, in UTC, for the Scheduled Instance to start.

" } }, "documentation":"

Describes the time period for a Scheduled Instance to start its first schedule.

" }, "Snapshot":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

", "locationName":"snapshotId" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume that was used to create the snapshot.

", "locationName":"volumeId" }, "State":{ "shape":"SnapshotState", "documentation":"

The snapshot state.

", "locationName":"status" }, "StateMessage":{ "shape":"String", "documentation":"

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

", "locationName":"statusMessage" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time stamp when the snapshot was initiated.

", "locationName":"startTime" }, "Progress":{ "shape":"String", "documentation":"

The progress of the snapshot, as a percentage.

", "locationName":"progress" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the EBS snapshot owner.

", "locationName":"ownerId" }, "Description":{ "shape":"String", "documentation":"

The description for the snapshot.

", "locationName":"description" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

", "locationName":"volumeSize" }, "OwnerAlias":{ "shape":"String", "documentation":"

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

", "locationName":"ownerAlias" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the snapshot.

", "locationName":"tagSet" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the snapshot is encrypted.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

", "locationName":"kmsKeyId" }, "DataEncryptionKeyId":{ "shape":"String", "documentation":"

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

", "locationName":"dataEncryptionKeyId" } }, "documentation":"

Describes a snapshot.

" }, "SnapshotAttributeName":{ "type":"string", "enum":[ "productCodes", "createVolumePermission" ] }, "SnapshotDetail":{ "type":"structure", "members":{ "DiskImageSize":{ "shape":"Double", "documentation":"

The size of the disk in the snapshot, in GiB.

", "locationName":"diskImageSize" }, "Description":{ "shape":"String", "documentation":"

A description for the snapshot.

", "locationName":"description" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image from which the snapshot is created.

", "locationName":"format" }, "Url":{ "shape":"String", "documentation":"

The URL used to access the disk image.

", "locationName":"url" }, "UserBucket":{ "shape":"UserBucketDetails", "documentation":"

The S3 bucket for the disk image.

", "locationName":"userBucket" }, "DeviceName":{ "shape":"String", "documentation":"

The block device mapping for the snapshot.

", "locationName":"deviceName" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot ID of the disk being imported.

", "locationName":"snapshotId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of progress for the task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message for the snapshot creation.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status of the snapshot creation.

", "locationName":"status" } }, "documentation":"

Describes the snapshot created from the imported disk.

" }, "SnapshotDetailList":{ "type":"list", "member":{ "shape":"SnapshotDetail", "locationName":"item" } }, "SnapshotDiskContainer":{ "type":"structure", "members":{ "Description":{ "shape":"String", "documentation":"

The description of the disk image being imported.

" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" }, "Url":{ "shape":"String", "documentation":"

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).

" }, "UserBucket":{ "shape":"UserBucket", "documentation":"

The S3 bucket for the disk image.

" } }, "documentation":"

The disk container object for the import snapshot request.

" }, "SnapshotIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SnapshotId" } }, "SnapshotList":{ "type":"list", "member":{ "shape":"Snapshot", "locationName":"item" } }, "SnapshotState":{ "type":"string", "enum":[ "pending", "completed", "error" ] }, "SnapshotTaskDetail":{ "type":"structure", "members":{ "DiskImageSize":{ "shape":"Double", "documentation":"

The size of the disk in the snapshot, in GiB.

", "locationName":"diskImageSize" }, "Description":{ "shape":"String", "documentation":"

The description of the snapshot.

", "locationName":"description" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image from which the snapshot is created.

", "locationName":"format" }, "Url":{ "shape":"String", "documentation":"

The URL of the disk image from which the snapshot is created.

", "locationName":"url" }, "UserBucket":{ "shape":"UserBucketDetails", "documentation":"

The S3 bucket for the disk image.

", "locationName":"userBucket" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot ID of the disk being imported.

", "locationName":"snapshotId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of completion for the import snapshot task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message for the import snapshot task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status for the import snapshot task.

", "locationName":"status" } }, "documentation":"

Details about the import snapshot task.

" }, "SpotDatafeedSubscription":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the account.

", "locationName":"ownerId" }, "Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket where the Spot instance data feed is located.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

The prefix that is prepended to data feed files.

", "locationName":"prefix" }, "State":{ "shape":"DatafeedSubscriptionState", "documentation":"

The state of the Spot instance data feed subscription.

", "locationName":"state" }, "Fault":{ "shape":"SpotInstanceStateFault", "documentation":"

The fault codes for the Spot instance request, if any.

", "locationName":"fault" } }, "documentation":"

Describes the data feed for a Spot instance.

" }, "SpotFleetLaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", "locationName":"groupSet" }, "UserData":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" }, "Monitoring":{ "shape":"SpotFleetMonitoring", "documentation":"

Enable or disable monitoring for the instances.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, \"subnet-a61dafcf, subnet-65ea5f08\".

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "WeightedCapacity":{ "shape":"Double", "documentation":"

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).

If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.

", "locationName":"weightedCapacity" }, "SpotPrice":{ "shape":"String", "documentation":"

The bid price per unit hour for the specified instance type. If this value is not specified, the default is the Spot bid price specified for the fleet. To determine the bid price per unit hour, divide the Spot bid price by the value of WeightedCapacity.

", "locationName":"spotPrice" } }, "documentation":"

Describes the launch specification for one or more Spot instances.

" }, "SpotFleetMonitoring":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Enables monitoring for the instance.

Default: false

", "locationName":"enabled" } }, "documentation":"

Describes whether monitoring is enabled.

" }, "SpotFleetRequestConfig":{ "type":"structure", "required":[ "SpotFleetRequestId", "SpotFleetRequestState", "SpotFleetRequestConfig", "CreateTime" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "SpotFleetRequestState":{ "shape":"BatchState", "documentation":"

The state of the Spot fleet request.

", "locationName":"spotFleetRequestState" }, "SpotFleetRequestConfig":{ "shape":"SpotFleetRequestConfigData", "documentation":"

Information about the configuration of the Spot fleet request.

", "locationName":"spotFleetRequestConfig" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The creation date and time of the request.

", "locationName":"createTime" } }, "documentation":"

Describes a Spot fleet request.

" }, "SpotFleetRequestConfigData":{ "type":"structure", "required":[ "SpotPrice", "TargetCapacity", "IamFleetRole", "LaunchSpecifications" ], "members":{ "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" }, "SpotPrice":{ "shape":"String", "documentation":"

The bid price per unit hour.

", "locationName":"spotPrice" }, "TargetCapacity":{ "shape":"Integer", "documentation":"

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O.

", "locationName":"targetCapacity" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot instance requests are placed or enabled to fulfill the request.

", "locationName":"validUntil" }, "TerminateInstancesWithExpiration":{ "shape":"Boolean", "documentation":"

Indicates whether running Spot instances should be terminated when the Spot fleet request expires.

", "locationName":"terminateInstancesWithExpiration" }, "IamFleetRole":{ "shape":"String", "documentation":"

Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration.

", "locationName":"iamFleetRole" }, "LaunchSpecifications":{ "shape":"LaunchSpecsList", "documentation":"

Information about the launch specifications for the Spot fleet request.

", "locationName":"launchSpecifications" }, "ExcessCapacityTerminationPolicy":{ "shape":"ExcessCapacityTerminationPolicy", "documentation":"

Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.

", "locationName":"excessCapacityTerminationPolicy" }, "AllocationStrategy":{ "shape":"AllocationStrategy", "documentation":"

Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is lowestPrice.

", "locationName":"allocationStrategy" }, "FulfilledCapacity":{ "shape":"Double", "documentation":"

The number of units fulfilled by this request compared to the set target capacity.

", "locationName":"fulfilledCapacity" }, "Type":{ "shape":"FleetType", "documentation":"

The type of request. Indicates whether the fleet will only request the target capacity or also attempt to maintain it. When you request a certain target capacity, the fleet will only place the required bids. It will not attempt to replenish Spot instances if capacity is diminished, nor will it submit bids in alternative Spot pools if capacity is not available. When you want to maintain a certain target capacity, fleet will place the required bids to meet this target capacity. It will also automatically replenish any interrupted instances. Default: maintain.

", "locationName":"type" } }, "documentation":"

Describes the configuration of a Spot fleet request.

" }, "SpotFleetRequestConfigSet":{ "type":"list", "member":{ "shape":"SpotFleetRequestConfig", "locationName":"item" } }, "SpotInstanceRequest":{ "type":"structure", "members":{ "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot instance request.

", "locationName":"spotInstanceRequestId" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum hourly price (bid) for the Spot instance launched to fulfill the request.

", "locationName":"spotPrice" }, "Type":{ "shape":"SpotInstanceType", "documentation":"

The Spot instance request type.

", "locationName":"type" }, "State":{ "shape":"SpotInstanceState", "documentation":"

The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"state" }, "Fault":{ "shape":"SpotInstanceStateFault", "documentation":"

The fault codes for the Spot instance request, if any.

", "locationName":"fault" }, "Status":{ "shape":"SpotInstanceStatus", "documentation":"

The status code and status message describing the Spot instance request.

", "locationName":"status" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.

", "locationName":"validUntil" }, "LaunchGroup":{ "shape":"String", "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

", "locationName":"launchGroup" }, "AvailabilityZoneGroup":{ "shape":"String", "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.

", "locationName":"availabilityZoneGroup" }, "LaunchSpecification":{ "shape":"LaunchSpecification", "documentation":"

Additional information for launching instances.

", "locationName":"launchSpecification" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID, if an instance has been launched to fulfill the Spot instance request.

", "locationName":"instanceId" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The date and time when the Spot instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"createTime" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The product description associated with the Spot instance.

", "locationName":"productDescription" }, "BlockDurationMinutes":{ "shape":"Integer", "documentation":"

The duration for the Spot instance, in minutes.

", "locationName":"blockDurationMinutes" }, "ActualBlockHourlyPrice":{ "shape":"String", "documentation":"

If you specified a duration and your Spot instance request was fulfilled, this is the fixed hourly price in effect for the Spot instance while it runs.

", "locationName":"actualBlockHourlyPrice" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "LaunchedAvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the bid is launched.

", "locationName":"launchedAvailabilityZone" } }, "documentation":"

Describes a Spot instance request.

" }, "SpotInstanceRequestIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"SpotInstanceRequestId" } }, "SpotInstanceRequestList":{ "type":"list", "member":{ "shape":"SpotInstanceRequest", "locationName":"item" } }, "SpotInstanceState":{ "type":"string", "enum":[ "open", "active", "closed", "cancelled", "failed" ] }, "SpotInstanceStateFault":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The reason code for the Spot instance state change.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The message for the Spot instance state change.

", "locationName":"message" } }, "documentation":"

Describes a Spot instance state change.

" }, "SpotInstanceStatus":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The status code. For a list of status codes, see Spot Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"code" }, "UpdateTime":{ "shape":"DateTime", "documentation":"

The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"updateTime" }, "Message":{ "shape":"String", "documentation":"

The description for the status code.

", "locationName":"message" } }, "documentation":"

Describes the status of a Spot instance request.

" }, "SpotInstanceType":{ "type":"string", "enum":[ "one-time", "persistent" ] }, "SpotPlacement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

[Spot fleet only] To specify multiple Availability Zones, separate them using commas; for example, \"us-west-2a, us-west-2b\".

", "locationName":"availabilityZone" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group (for cluster instances).

", "locationName":"groupName" } }, "documentation":"

Describes Spot instance placement.

" }, "SpotPrice":{ "type":"structure", "members":{ "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

A general description of the AMI.

", "locationName":"productDescription" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum price (bid) that you are willing to pay for a Spot instance.

", "locationName":"spotPrice" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"timestamp" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" } }, "documentation":"

Describes the maximum hourly price (bid) for any Spot instance launched to fulfill the request.

" }, "SpotPriceHistoryList":{ "type":"list", "member":{ "shape":"SpotPrice", "locationName":"item" } }, "StaleIpPermission":{ "type":"structure", "members":{ "FromPort":{ "shape":"Integer", "documentation":"

The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", "locationName":"fromPort" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

", "locationName":"ipProtocol" }, "IpRanges":{ "shape":"IpRanges", "documentation":"

One or more IP ranges. Not applicable for stale security group rules.

", "locationName":"ipRanges" }, "PrefixListIds":{ "shape":"PrefixListIdSet", "documentation":"

One or more prefix list IDs for an AWS service. Not applicable for stale security group rules.

", "locationName":"prefixListIds" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", "locationName":"toPort" }, "UserIdGroupPairs":{ "shape":"UserIdGroupPairSet", "documentation":"

One or more security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.

", "locationName":"groups" } }, "documentation":"

Describes a stale rule in a security group.

" }, "StaleIpPermissionSet":{ "type":"list", "member":{ "shape":"StaleIpPermission", "locationName":"item" } }, "StaleSecurityGroup":{ "type":"structure", "required":["GroupId"], "members":{ "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "Description":{ "shape":"String", "documentation":"

The description of the security group.

", "locationName":"description" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for the security group.

", "locationName":"vpcId" }, "StaleIpPermissions":{ "shape":"StaleIpPermissionSet", "documentation":"

Information about the stale inbound rules in the security group.

", "locationName":"staleIpPermissions" }, "StaleIpPermissionsEgress":{ "shape":"StaleIpPermissionSet", "documentation":"

Information about the stale outbound rules in the security group.

", "locationName":"staleIpPermissionsEgress" } }, "documentation":"

Describes a stale security group (a security group that contains stale rules).

" }, "StaleSecurityGroupSet":{ "type":"list", "member":{ "shape":"StaleSecurityGroup", "locationName":"item" } }, "StartInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for StartInstances.

" }, "StartInstancesResult":{ "type":"structure", "members":{ "StartingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more started instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of StartInstances.

" }, "State":{ "type":"string", "enum":[ "Pending", "Available", "Deleting", "Deleted" ] }, "StateReason":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The reason code for the state change.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The message for the state change.

  • Server.SpotInstanceTermination: A Spot instance was terminated due to an increase in the market price.

  • Server.InternalError: An internal error occurred during instance launch, resulting in termination.

  • Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

  • Client.InternalError: A client error caused the instance to terminate on launch.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your limits.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

", "locationName":"message" } }, "documentation":"

Describes a state change.

" }, "Status":{ "type":"string", "enum":[ "MoveInProgress", "InVpc", "InClassic" ] }, "StatusName":{ "type":"string", "enum":["reachability"] }, "StatusType":{ "type":"string", "enum":[ "passed", "failed", "insufficient-data", "initializing" ] }, "StopInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" }, "Force":{ "shape":"Boolean", "documentation":"

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

", "locationName":"force" } }, "documentation":"

Contains the parameters for StopInstances.

" }, "StopInstancesResult":{ "type":"structure", "members":{ "StoppingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more stopped instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of StopInstances.

" }, "Storage":{ "type":"structure", "members":{ "S3":{ "shape":"S3Storage", "documentation":"

An Amazon S3 storage location.

" } }, "documentation":"

Describes the storage location for an instance store-backed AMI.

" }, "String":{"type":"string"}, "Subnet":{ "type":"structure", "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "State":{ "shape":"SubnetState", "documentation":"

The current state of the subnet.

", "locationName":"state" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC the subnet is in.

", "locationName":"vpcId" }, "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block assigned to the subnet.

", "locationName":"cidrBlock" }, "AvailableIpAddressCount":{ "shape":"Integer", "documentation":"

The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.

", "locationName":"availableIpAddressCount" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the subnet.

", "locationName":"availabilityZone" }, "DefaultForAz":{ "shape":"Boolean", "documentation":"

Indicates whether this is the default subnet for the Availability Zone.

", "locationName":"defaultForAz" }, "MapPublicIpOnLaunch":{ "shape":"Boolean", "documentation":"

Indicates whether instances launched in this subnet receive a public IP address.

", "locationName":"mapPublicIpOnLaunch" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the subnet.

", "locationName":"tagSet" } }, "documentation":"

Describes a subnet.

" }, "SubnetIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SubnetId" } }, "SubnetList":{ "type":"list", "member":{ "shape":"Subnet", "locationName":"item" } }, "SubnetState":{ "type":"string", "enum":[ "pending", "available" ] }, "SummaryStatus":{ "type":"string", "enum":[ "ok", "impaired", "insufficient-data", "not-applicable", "initializing" ] }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", "locationName":"value" } }, "documentation":"

Describes a tag.

" }, "TagDescription":{ "type":"structure", "members":{ "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource. For example, ami-1a2b3c4d.

", "locationName":"resourceId" }, "ResourceType":{ "shape":"ResourceType", "documentation":"

The resource type.

", "locationName":"resourceType" }, "Key":{ "shape":"String", "documentation":"

The tag key.

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The tag value.

", "locationName":"value" } }, "documentation":"

Describes a tag.

" }, "TagDescriptionList":{ "type":"list", "member":{ "shape":"TagDescription", "locationName":"item" } }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"item" } }, "TelemetryStatus":{ "type":"string", "enum":[ "UP", "DOWN" ] }, "Tenancy":{ "type":"string", "enum":[ "default", "dedicated", "host" ] }, "TerminateInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } }, "documentation":"

Contains the parameters for TerminateInstances.

" }, "TerminateInstancesResult":{ "type":"structure", "members":{ "TerminatingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more terminated instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of TerminateInstances.

" }, "TrafficType":{ "type":"string", "enum":[ "ACCEPT", "REJECT", "ALL" ] }, "UnassignPrivateIpAddressesRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "PrivateIpAddresses" ], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", "documentation":"

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

", "locationName":"privateIpAddress" } }, "documentation":"

Contains the parameters for UnassignPrivateIpAddresses.

" }, "UnmonitorInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } }, "documentation":"

Contains the parameters for UnmonitorInstances.

" }, "UnmonitorInstancesResult":{ "type":"structure", "members":{ "InstanceMonitorings":{ "shape":"InstanceMonitoringList", "documentation":"

Monitoring information for one or more instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of UnmonitorInstances.

" }, "UnsuccessfulItem":{ "type":"structure", "required":["Error"], "members":{ "Error":{ "shape":"UnsuccessfulItemError", "documentation":"

Information about the error.

", "locationName":"error" }, "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource.

", "locationName":"resourceId" } }, "documentation":"

Information about items that were not successfully processed in a batch call.

" }, "UnsuccessfulItemError":{ "type":"structure", "required":[ "Code", "Message" ], "members":{ "Code":{ "shape":"String", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The error message accompanying the error code.

", "locationName":"message" } }, "documentation":"

Information about the error that occurred. For more information about errors, see Error Codes.

" }, "UnsuccessfulItemList":{ "type":"list", "member":{ "shape":"UnsuccessfulItem", "locationName":"item" } }, "UnsuccessfulItemSet":{ "type":"list", "member":{ "shape":"UnsuccessfulItem", "locationName":"item" } }, "UserBucket":{ "type":"structure", "members":{ "S3Bucket":{ "shape":"String", "documentation":"

The name of the S3 bucket where the disk image is located.

" }, "S3Key":{ "shape":"String", "documentation":"

The file name of the disk image.

" } }, "documentation":"

Describes the S3 bucket for the disk image.

" }, "UserBucketDetails":{ "type":"structure", "members":{ "S3Bucket":{ "shape":"String", "documentation":"

The S3 bucket from which the disk image was created.

", "locationName":"s3Bucket" }, "S3Key":{ "shape":"String", "documentation":"

The file name of the disk image.

", "locationName":"s3Key" } }, "documentation":"

Describes the S3 bucket for the disk image.

" }, "UserData":{ "type":"structure", "members":{ "Data":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data for the instance.

", "locationName":"data" } }, "documentation":"

Describes the user data to be made available to an instance.

" }, "UserGroupStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"UserGroup" } }, "UserIdGroupPair":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The ID of an AWS account. For a referenced security group in another VPC, the account ID of the referenced security group is returned.

[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.

", "locationName":"userId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for the referenced security group, if applicable.

", "locationName":"vpcId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection, if applicable.

", "locationName":"vpcPeeringConnectionId" }, "PeeringStatus":{ "shape":"String", "documentation":"

The status of a VPC peering connection, if applicable.

", "locationName":"peeringStatus" } }, "documentation":"

Describes a security group and AWS account ID pair.

" }, "UserIdGroupPairList":{ "type":"list", "member":{ "shape":"UserIdGroupPair", "locationName":"item" } }, "UserIdGroupPairSet":{ "type":"list", "member":{ "shape":"UserIdGroupPair", "locationName":"item" } }, "UserIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"UserId" } }, "ValueStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "VgwTelemetry":{ "type":"structure", "members":{ "OutsideIpAddress":{ "shape":"String", "documentation":"

The Internet-routable IP address of the virtual private gateway's outside interface.

", "locationName":"outsideIpAddress" }, "Status":{ "shape":"TelemetryStatus", "documentation":"

The status of the VPN tunnel.

", "locationName":"status" }, "LastStatusChange":{ "shape":"DateTime", "documentation":"

The date and time of the last change in status.

", "locationName":"lastStatusChange" }, "StatusMessage":{ "shape":"String", "documentation":"

If an error occurs, a description of the error.

", "locationName":"statusMessage" }, "AcceptedRouteCount":{ "shape":"Integer", "documentation":"

The number of accepted routes.

", "locationName":"acceptedRouteCount" } }, "documentation":"

Describes telemetry for a VPN tunnel.

" }, "VgwTelemetryList":{ "type":"list", "member":{ "shape":"VgwTelemetry", "locationName":"item" } }, "VirtualizationType":{ "type":"string", "enum":[ "hvm", "paravirtual" ] }, "Volume":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "Size":{ "shape":"Integer", "documentation":"

The size of the volume, in GiBs.

", "locationName":"size" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot from which the volume was created, if applicable.

", "locationName":"snapshotId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the volume.

", "locationName":"availabilityZone" }, "State":{ "shape":"VolumeState", "documentation":"

The volume state.

", "locationName":"status" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The time stamp when volume creation was initiated.

", "locationName":"createTime" }, "Attachments":{ "shape":"VolumeAttachmentList", "documentation":"

Information about the volume attachments.

", "locationName":"attachmentSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the volume.

", "locationName":"tagSet" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

", "locationName":"volumeType" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", "locationName":"iops" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the volume will be encrypted.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

", "locationName":"kmsKeyId" } }, "documentation":"

Describes a volume.

" }, "VolumeAttachment":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Device":{ "shape":"String", "documentation":"

The device name.

", "locationName":"device" }, "State":{ "shape":"VolumeAttachmentState", "documentation":"

The attachment state of the volume.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes volume attachment details.

" }, "VolumeAttachmentList":{ "type":"list", "member":{ "shape":"VolumeAttachment", "locationName":"item" } }, "VolumeAttachmentState":{ "type":"string", "enum":[ "attaching", "attached", "detaching", "detached" ] }, "VolumeAttributeName":{ "type":"string", "enum":[ "autoEnableIO", "productCodes" ] }, "VolumeDetail":{ "type":"structure", "required":["Size"], "members":{ "Size":{ "shape":"Long", "documentation":"

The size of the volume, in GiB.

", "locationName":"size" } }, "documentation":"

Describes an EBS volume.

" }, "VolumeIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VolumeId" } }, "VolumeList":{ "type":"list", "member":{ "shape":"Volume", "locationName":"item" } }, "VolumeState":{ "type":"string", "enum":[ "creating", "available", "in-use", "deleting", "deleted", "error" ] }, "VolumeStatusAction":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The code identifying the operation, for example, enable-volume-io.

", "locationName":"code" }, "Description":{ "shape":"String", "documentation":"

A description of the operation.

", "locationName":"description" }, "EventType":{ "shape":"String", "documentation":"

The event type associated with this operation.

", "locationName":"eventType" }, "EventId":{ "shape":"String", "documentation":"

The ID of the event associated with this operation.

", "locationName":"eventId" } }, "documentation":"

Describes a volume status operation code.

" }, "VolumeStatusActionsList":{ "type":"list", "member":{ "shape":"VolumeStatusAction", "locationName":"item" } }, "VolumeStatusDetails":{ "type":"structure", "members":{ "Name":{ "shape":"VolumeStatusName", "documentation":"

The name of the volume status.

", "locationName":"name" }, "Status":{ "shape":"String", "documentation":"

The intended status of the volume status.

", "locationName":"status" } }, "documentation":"

Describes a volume status.

" }, "VolumeStatusDetailsList":{ "type":"list", "member":{ "shape":"VolumeStatusDetails", "locationName":"item" } }, "VolumeStatusEvent":{ "type":"structure", "members":{ "EventType":{ "shape":"String", "documentation":"

The type of this event.

", "locationName":"eventType" }, "Description":{ "shape":"String", "documentation":"

A description of the event.

", "locationName":"description" }, "NotBefore":{ "shape":"DateTime", "documentation":"

The earliest start time of the event.

", "locationName":"notBefore" }, "NotAfter":{ "shape":"DateTime", "documentation":"

The latest end time of the event.

", "locationName":"notAfter" }, "EventId":{ "shape":"String", "documentation":"

The ID of this event.

", "locationName":"eventId" } }, "documentation":"

Describes a volume status event.

" }, "VolumeStatusEventsList":{ "type":"list", "member":{ "shape":"VolumeStatusEvent", "locationName":"item" } }, "VolumeStatusInfo":{ "type":"structure", "members":{ "Status":{ "shape":"VolumeStatusInfoStatus", "documentation":"

The status of the volume.

", "locationName":"status" }, "Details":{ "shape":"VolumeStatusDetailsList", "documentation":"

The details of the volume status.

", "locationName":"details" } }, "documentation":"

Describes the status of a volume.

" }, "VolumeStatusInfoStatus":{ "type":"string", "enum":[ "ok", "impaired", "insufficient-data" ] }, "VolumeStatusItem":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

", "locationName":"volumeId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the volume.

", "locationName":"availabilityZone" }, "VolumeStatus":{ "shape":"VolumeStatusInfo", "documentation":"

The volume status.

", "locationName":"volumeStatus" }, "Events":{ "shape":"VolumeStatusEventsList", "documentation":"

A list of events associated with the volume.

", "locationName":"eventsSet" }, "Actions":{ "shape":"VolumeStatusActionsList", "documentation":"

The details of the operation.

", "locationName":"actionsSet" } }, "documentation":"

Describes the volume status.

" }, "VolumeStatusList":{ "type":"list", "member":{ "shape":"VolumeStatusItem", "locationName":"item" } }, "VolumeStatusName":{ "type":"string", "enum":[ "io-enabled", "io-performance" ] }, "VolumeType":{ "type":"string", "enum":[ "standard", "io1", "gp2", "sc1", "st1" ] }, "Vpc":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"VpcState", "documentation":"

The current state of the VPC.

", "locationName":"state" }, "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block for the VPC.

", "locationName":"cidrBlock" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

", "locationName":"dhcpOptionsId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPC.

", "locationName":"tagSet" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The allowed tenancy of instances launched into the VPC.

", "locationName":"instanceTenancy" }, "IsDefault":{ "shape":"Boolean", "documentation":"

Indicates whether the VPC is the default VPC.

", "locationName":"isDefault" } }, "documentation":"

Describes a VPC.

" }, "VpcAttachment":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"AttachmentStatus", "documentation":"

The current state of the attachment.

", "locationName":"state" } }, "documentation":"

Describes an attachment between a virtual private gateway and a VPC.

" }, "VpcAttachmentList":{ "type":"list", "member":{ "shape":"VpcAttachment", "locationName":"item" } }, "VpcAttributeName":{ "type":"string", "enum":[ "enableDnsSupport", "enableDnsHostnames" ] }, "VpcClassicLink":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "ClassicLinkEnabled":{ "shape":"Boolean", "documentation":"

Indicates whether the VPC is enabled for ClassicLink.

", "locationName":"classicLinkEnabled" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPC.

", "locationName":"tagSet" } }, "documentation":"

Describes whether a VPC is enabled for ClassicLink.

" }, "VpcClassicLinkIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcId" } }, "VpcClassicLinkList":{ "type":"list", "member":{ "shape":"VpcClassicLink", "locationName":"item" } }, "VpcEndpoint":{ "type":"structure", "members":{ "VpcEndpointId":{ "shape":"String", "documentation":"

The ID of the VPC endpoint.

", "locationName":"vpcEndpointId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC to which the endpoint is associated.

", "locationName":"vpcId" }, "ServiceName":{ "shape":"String", "documentation":"

The name of the AWS service to which the endpoint is associated.

", "locationName":"serviceName" }, "State":{ "shape":"State", "documentation":"

The state of the VPC endpoint.

", "locationName":"state" }, "PolicyDocument":{ "shape":"String", "documentation":"

The policy document associated with the endpoint.

", "locationName":"policyDocument" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route tables associated with the endpoint.

", "locationName":"routeTableIdSet" }, "CreationTimestamp":{ "shape":"DateTime", "documentation":"

The date and time the VPC endpoint was created.

", "locationName":"creationTimestamp" } }, "documentation":"

Describes a VPC endpoint.

" }, "VpcEndpointSet":{ "type":"list", "member":{ "shape":"VpcEndpoint", "locationName":"item" } }, "VpcIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcId" } }, "VpcList":{ "type":"list", "member":{ "shape":"Vpc", "locationName":"item" } }, "VpcPeeringConnection":{ "type":"structure", "members":{ "AccepterVpcInfo":{ "shape":"VpcPeeringConnectionVpcInfo", "documentation":"

Information about the accepter VPC. CIDR block information is not returned when creating a VPC peering connection, or when describing a VPC peering connection that's in the initiating-request or pending-acceptance state.

", "locationName":"accepterVpcInfo" }, "ExpirationTime":{ "shape":"DateTime", "documentation":"

The time that an unaccepted VPC peering connection will expire.

", "locationName":"expirationTime" }, "RequesterVpcInfo":{ "shape":"VpcPeeringConnectionVpcInfo", "documentation":"

Information about the requester VPC.

", "locationName":"requesterVpcInfo" }, "Status":{ "shape":"VpcPeeringConnectionStateReason", "documentation":"

The status of the VPC peering connection.

", "locationName":"status" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Describes a VPC peering connection.

" }, "VpcPeeringConnectionList":{ "type":"list", "member":{ "shape":"VpcPeeringConnection", "locationName":"item" } }, "VpcPeeringConnectionOptionsDescription":{ "type":"structure", "members":{ "AllowEgressFromLocalClassicLinkToRemoteVpc":{ "shape":"Boolean", "documentation":"

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

", "locationName":"allowEgressFromLocalClassicLinkToRemoteVpc" }, "AllowEgressFromLocalVpcToRemoteClassicLink":{ "shape":"Boolean", "documentation":"

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.

", "locationName":"allowEgressFromLocalVpcToRemoteClassicLink" } }, "documentation":"

Describes the VPC peering connection options.

" }, "VpcPeeringConnectionStateReason":{ "type":"structure", "members":{ "Code":{ "shape":"VpcPeeringConnectionStateReasonCode", "documentation":"

The status of the VPC peering connection.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

A message that provides more information about the status, if applicable.

", "locationName":"message" } }, "documentation":"

Describes the status of a VPC peering connection.

" }, "VpcPeeringConnectionStateReasonCode":{ "type":"string", "enum":[ "initiating-request", "pending-acceptance", "active", "deleted", "rejected", "failed", "expired", "provisioning", "deleting" ] }, "VpcPeeringConnectionVpcInfo":{ "type":"structure", "members":{ "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block for the VPC.

", "locationName":"cidrBlock" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the VPC owner.

", "locationName":"ownerId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "PeeringOptions":{ "shape":"VpcPeeringConnectionOptionsDescription", "documentation":"

Information about the VPC peering connection options for the accepter or requester VPC.

", "locationName":"peeringOptions" } }, "documentation":"

Describes a VPC in a VPC peering connection.

" }, "VpcState":{ "type":"string", "enum":[ "pending", "available" ] }, "VpnConnection":{ "type":"structure", "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

", "locationName":"vpnConnectionId" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the VPN connection.

", "locationName":"state" }, "CustomerGatewayConfiguration":{ "shape":"String", "documentation":"

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

", "locationName":"customerGatewayConfiguration" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection.

", "locationName":"type" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway at your end of the VPN connection.

", "locationName":"customerGatewayId" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

", "locationName":"vpnGatewayId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPN connection.

", "locationName":"tagSet" }, "VgwTelemetry":{ "shape":"VgwTelemetryList", "documentation":"

Information about the VPN tunnel.

", "locationName":"vgwTelemetry" }, "Options":{ "shape":"VpnConnectionOptions", "documentation":"

The VPN connection options.

", "locationName":"options" }, "Routes":{ "shape":"VpnStaticRouteList", "documentation":"

The static routes associated with the VPN connection.

", "locationName":"routes" } }, "documentation":"

Describes a VPN connection.

" }, "VpnConnectionIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpnConnectionId" } }, "VpnConnectionList":{ "type":"list", "member":{ "shape":"VpnConnection", "locationName":"item" } }, "VpnConnectionOptions":{ "type":"structure", "members":{ "StaticRoutesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "locationName":"staticRoutesOnly" } }, "documentation":"

Describes VPN connection options.

" }, "VpnConnectionOptionsSpecification":{ "type":"structure", "members":{ "StaticRoutesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "locationName":"staticRoutesOnly" } }, "documentation":"

Describes VPN connection options.

" }, "VpnGateway":{ "type":"structure", "members":{ "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

", "locationName":"vpnGatewayId" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the virtual private gateway.

", "locationName":"state" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection the virtual private gateway supports.

", "locationName":"type" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

", "locationName":"availabilityZone" }, "VpcAttachments":{ "shape":"VpcAttachmentList", "documentation":"

Any VPCs attached to the virtual private gateway.

", "locationName":"attachments" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the virtual private gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes a virtual private gateway.

" }, "VpnGatewayIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpnGatewayId" } }, "VpnGatewayList":{ "type":"list", "member":{ "shape":"VpnGateway", "locationName":"item" } }, "VpnState":{ "type":"string", "enum":[ "pending", "available", "deleting", "deleted" ] }, "VpnStaticRoute":{ "type":"structure", "members":{ "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer data center.

", "locationName":"destinationCidrBlock" }, "Source":{ "shape":"VpnStaticRouteSource", "documentation":"

Indicates how the routes were provided.

", "locationName":"source" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the static route.

", "locationName":"state" } }, "documentation":"

Describes a static route for a VPN connection.

" }, "VpnStaticRouteList":{ "type":"list", "member":{ "shape":"VpnStaticRoute", "locationName":"item" } }, "VpnStaticRouteSource":{ "type":"string", "enum":["Static"] }, "ZoneNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ZoneName" } } }, "documentation":"Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.

" } botocore-1.5.7/botocore/data/ec2/2016-09-15/0000777454262600001440000000000013042511307020645 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ec2/2016-09-15/examples-1.json0000777454262600001440000032713613042511306023532 0ustar pysdk-ciamazon00000000000000{ "version": "1.0", "examples": { "AllocateAddress": [ { "input": { "Domain": "vpc" }, "output": { "AllocationId": "eipalloc-64d5890a", "Domain": "vpc", "PublicIp": "203.0.113.0" }, "comments": { "input": { }, "output": { } }, "description": "This example allocates an Elastic IP address to use with an instance in a VPC.", "id": "ec2-allocate-address-1", "title": "To allocate an Elastic IP address for EC2-VPC" }, { "output": { "Domain": "standard", "PublicIp": "198.51.100.0" }, "comments": { "input": { }, "output": { } }, "description": "This example allocates an Elastic IP address to use with an instance in EC2-Classic.", "id": "ec2-allocate-address-2", "title": "To allocate an Elastic IP address for EC2-Classic" } ], "AssignPrivateIpAddresses": [ { "input": { "NetworkInterfaceId": "eni-e5aa89a3", "PrivateIpAddresses": [ "10.0.0.82" ] }, "comments": { "input": { }, "output": { } }, "description": "This example assigns the specified secondary private IP address to the specified network interface.", "id": "ec2-assign-private-ip-addresses-1", "title": "To assign a specific secondary private IP address to an interface" }, { "input": { "NetworkInterfaceId": "eni-e5aa89a3", "SecondaryPrivateIpAddressCount": 2 }, "comments": { "input": { }, "output": { } }, "description": "This example assigns two secondary private IP addresses to the specified network interface. Amazon EC2 automatically assigns these IP addresses from the available IP addresses in the CIDR block range of the subnet the network interface is associated with.", "id": "ec2-assign-private-ip-addresses-2", "title": "To assign secondary private IP addresses that Amazon EC2 selects to an interface" } ], "AssociateAddress": [ { "input": { "AllocationId": "eipalloc-64d5890a", "InstanceId": "i-0b263919b6498b123" }, "output": { "AssociationId": "eipassoc-2bebb745" }, "comments": { "input": { }, "output": { } }, "description": "This example associates the specified Elastic IP address with the specified instance in a VPC.", "id": "ec2-associate-address-1", "title": "To associate an Elastic IP address in EC2-VPC" }, { "input": { "AllocationId": "eipalloc-64d5890a", "NetworkInterfaceId": "eni-1a2b3c4d" }, "output": { "AssociationId": "eipassoc-2bebb745" }, "comments": { "input": { }, "output": { } }, "description": "This example associates the specified Elastic IP address with the specified network interface.", "id": "ec2-associate-address-2", "title": "To associate an Elastic IP address with a network interface" }, { "input": { "InstanceId": "i-07ffe74c7330ebf53", "PublicIp": "198.51.100.0" }, "comments": { "input": { }, "output": { } }, "description": "This example associates an Elastic IP address with an instance in EC2-Classic.", "id": "ec2-associate-address-3", "title": "To associate an Elastic IP address in EC2-Classic" } ], "AssociateDhcpOptions": [ { "input": { "DhcpOptionsId": "dopt-d9070ebb", "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example associates the specified DHCP options set with the specified VPC.", "id": "ec2-associate-dhcp-options-1", "title": "To associate a DHCP options set with a VPC" }, { "input": { "DhcpOptionsId": "default", "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example associates the default DHCP options set with the specified VPC.", "id": "ec2-associate-dhcp-options-2", "title": "To associate the default DHCP options set with a VPC" } ], "AssociateRouteTable": [ { "input": { "RouteTableId": "rtb-22574640", "SubnetId": "subnet-9d4a7b6" }, "output": { "AssociationId": "rtbassoc-781d0d1a" }, "comments": { "input": { }, "output": { } }, "description": "This example associates the specified route table with the specified subnet.", "id": "ec2-associate-route-table-1", "title": "To associate a route table with a subnet" } ], "AttachInternetGateway": [ { "input": { "InternetGatewayId": "igw-c0a643a9", "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example attaches the specified Internet gateway to the specified VPC.", "id": "ec2-attach-internet-gateway-1", "title": "To attach an Internet gateway to a VPC" } ], "AttachNetworkInterface": [ { "input": { "DeviceIndex": 1, "InstanceId": "i-1234567890abcdef0", "NetworkInterfaceId": "eni-e5aa89a3" }, "output": { "AttachmentId": "eni-attach-66c4350a" }, "comments": { "input": { }, "output": { } }, "description": "This example attaches the specified network interface to the specified instance.", "id": "ec2-attach-network-interface-1", "title": "To attach a network interface to an instance" } ], "AttachVolume": [ { "input": { "Device": "/dev/sdf", "InstanceId": "i-01474ef662b89480", "VolumeId": "vol-1234567890abcdef0" }, "output": { "AttachTime": "2016-08-29T18:52:32.724Z", "Device": "/dev/sdf", "InstanceId": "i-01474ef662b89480", "State": "attaching", "VolumeId": "vol-1234567890abcdef0" }, "comments": { "input": { }, "output": { } }, "description": "This example attaches a volume (``vol-1234567890abcdef0``) to an instance (``i-01474ef662b89480``) as ``/dev/sdf``.", "id": "to-attach-a-volume-to-an-instance-1472499213109", "title": "To attach a volume to an instance" } ], "CancelSpotFleetRequests": [ { "input": { "SpotFleetRequestIds": [ "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" ], "TerminateInstances": true }, "output": { "SuccessfulFleetRequests": [ { "CurrentSpotFleetRequestState": "cancelled_running", "PreviousSpotFleetRequestState": "active", "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example cancels the specified Spot fleet request and terminates its associated Spot Instances.", "id": "ec2-cancel-spot-fleet-requests-1", "title": "To cancel a Spot fleet request" }, { "input": { "SpotFleetRequestIds": [ "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" ], "TerminateInstances": false }, "output": { "SuccessfulFleetRequests": [ { "CurrentSpotFleetRequestState": "cancelled_terminating", "PreviousSpotFleetRequestState": "active", "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example cancels the specified Spot fleet request without terminating its associated Spot Instances.", "id": "ec2-cancel-spot-fleet-requests-2", "title": "To cancel a Spot fleet request without terminating its Spot Instances" } ], "CancelSpotInstanceRequests": [ { "input": { "SpotInstanceRequestIds": [ "sir-08b93456" ] }, "output": { "CancelledSpotInstanceRequests": [ { "SpotInstanceRequestId": "sir-08b93456", "State": "cancelled" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example cancels a Spot Instance request.", "id": "ec2-cancel-spot-instance-requests-1", "title": "To cancel Spot Instance requests" } ], "ConfirmProductInstance": [ { "input": { "InstanceId": "i-1234567890abcdef0", "ProductCode": "774F4FF8" }, "output": { "OwnerId": "123456789012" }, "comments": { "input": { }, "output": { } }, "description": "This example determines whether the specified product code is associated with the specified instance.", "id": "to-confirm-the-product-instance-1472712108494", "title": "To confirm the product instance" } ], "CopySnapshot": [ { "input": { "Description": "This is my copied snapshot.", "DestinationRegion": "us-east-1", "SourceRegion": "us-west-2", "SourceSnapshotId": "snap-066877671789bd71b" }, "output": { "SnapshotId": "snap-066877671789bd71b" }, "comments": { "input": { }, "output": { } }, "description": "This example copies a snapshot with the snapshot ID of ``snap-066877671789bd71b`` from the ``us-west-2`` region to the ``us-east-1`` region and adds a short description to identify the snapshot.", "id": "to-copy-a-snapshot-1472502259774", "title": "To copy a snapshot" } ], "CreateCustomerGateway": [ { "input": { "BgpAsn": 65534, "PublicIp": "12.1.2.3", "Type": "ipsec.1" }, "output": { "CustomerGateway": { "BgpAsn": "65534", "CustomerGatewayId": "cgw-0e11f167", "IpAddress": "12.1.2.3", "State": "available", "Type": "ipsec.1" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a customer gateway with the specified IP address for its outside interface.", "id": "ec2-create-customer-gateway-1", "title": "To create a customer gateway" } ], "CreateDhcpOptions": [ { "input": { "DhcpConfigurations": [ { "Key": "domain-name-servers", "Values": [ "10.2.5.1", "10.2.5.2" ] } ] }, "output": { "DhcpOptions": { "DhcpConfigurations": [ { "Key": "domain-name-servers", "Values": [ { "Value": "10.2.5.2" }, { "Value": "10.2.5.1" } ] } ], "DhcpOptionsId": "dopt-d9070ebb" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a DHCP options set.", "id": "ec2-create-dhcp-options-1", "title": "To create a DHCP options set" } ], "CreateInternetGateway": [ { "output": { "InternetGateway": { "Attachments": [ ], "InternetGatewayId": "igw-c0a643a9", "Tags": [ ] } }, "comments": { "input": { }, "output": { } }, "description": "This example creates an Internet gateway.", "id": "ec2-create-internet-gateway-1", "title": "To create an Internet gateway" } ], "CreateKeyPair": [ { "input": { "KeyName": "my-key-pair" }, "comments": { "input": { }, "output": { } }, "description": "This example creates a key pair named my-key-pair.", "id": "ec2-create-key-pair-1", "title": "To create a key pair" } ], "CreateNatGateway": [ { "input": { "AllocationId": "eipalloc-37fc1a52", "SubnetId": "subnet-1a2b3c4d" }, "output": { "NatGateway": { "CreateTime": "2015-12-17T12:45:26.732Z", "NatGatewayAddresses": [ { "AllocationId": "eipalloc-37fc1a52" } ], "NatGatewayId": "nat-08d48af2a8e83edfd", "State": "pending", "SubnetId": "subnet-1a2b3c4d", "VpcId": "vpc-1122aabb" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a NAT gateway in subnet subnet-1a2b3c4d and associates an Elastic IP address with the allocation ID eipalloc-37fc1a52 with the NAT gateway.", "id": "ec2-create-nat-gateway-1", "title": "To create a NAT gateway" } ], "CreateNetworkAcl": [ { "input": { "VpcId": "vpc-a01106c2" }, "output": { "NetworkAcl": { "Associations": [ ], "Entries": [ { "CidrBlock": "0.0.0.0/0", "Egress": true, "Protocol": "-1", "RuleAction": "deny", "RuleNumber": 32767 }, { "CidrBlock": "0.0.0.0/0", "Egress": false, "Protocol": "-1", "RuleAction": "deny", "RuleNumber": 32767 } ], "IsDefault": false, "NetworkAclId": "acl-5fb85d36", "Tags": [ ], "VpcId": "vpc-a01106c2" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a network ACL for the specified VPC.", "id": "ec2-create-network-acl-1", "title": "To create a network ACL" } ], "CreateNetworkAclEntry": [ { "input": { "CidrBlock": "0.0.0.0/0", "Egress": false, "NetworkAclId": "acl-5fb85d36", "PortRange": { "From": 53, "To": 53 }, "Protocol": "udp", "RuleAction": "allow", "RuleNumber": 100 }, "comments": { "input": { }, "output": { } }, "description": "This example creates an entry for the specified network ACL. The rule allows ingress traffic from anywhere (0.0.0.0/0) on UDP port 53 (DNS) into any associated subnet.", "id": "ec2-create-network-acl-entry-1", "title": "To create a network ACL entry" } ], "CreateNetworkInterface": [ { "input": { "Description": "my network interface", "Groups": [ "sg-903004f8" ], "PrivateIpAddress": "10.0.2.17", "SubnetId": "subnet-9d4a7b6c" }, "output": { "NetworkInterface": { "AvailabilityZone": "us-east-1d", "Description": "my network interface", "Groups": [ { "GroupId": "sg-903004f8", "GroupName": "default" } ], "MacAddress": "02:1a:80:41:52:9c", "NetworkInterfaceId": "eni-e5aa89a3", "OwnerId": "123456789012", "PrivateIpAddress": "10.0.2.17", "PrivateIpAddresses": [ { "Primary": true, "PrivateIpAddress": "10.0.2.17" } ], "RequesterManaged": false, "SourceDestCheck": true, "Status": "pending", "SubnetId": "subnet-9d4a7b6c", "TagSet": [ ], "VpcId": "vpc-a01106c2" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a network interface for the specified subnet.", "id": "ec2-create-network-interface-1", "title": "To create a network interface" } ], "CreatePlacementGroup": [ { "input": { "GroupName": "my-cluster", "Strategy": "cluster" }, "output": { }, "comments": { "input": { }, "output": { } }, "description": "This example creates a placement group with the specified name.", "id": "to-create-a-placement-group-1472712245768", "title": "To create a placement group" } ], "CreateRoute": [ { "input": { "DestinationCidrBlock": "0.0.0.0/0", "GatewayId": "igw-c0a643a9", "RouteTableId": "rtb-22574640" }, "comments": { "input": { }, "output": { } }, "description": "This example creates a route for the specified route table. The route matches all traffic (0.0.0.0/0) and routes it to the specified Internet gateway.", "id": "ec2-create-route-1", "title": "To create a route" } ], "CreateRouteTable": [ { "input": { "VpcId": "vpc-a01106c2" }, "output": { "RouteTable": { "Associations": [ ], "PropagatingVgws": [ ], "RouteTableId": "rtb-22574640", "Routes": [ { "DestinationCidrBlock": "10.0.0.0/16", "GatewayId": "local", "State": "active" } ], "Tags": [ ], "VpcId": "vpc-a01106c2" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a route table for the specified VPC.", "id": "ec2-create-route-table-1", "title": "To create a route table" } ], "CreateSnapshot": [ { "input": { "Description": "This is my root volume snapshot.", "VolumeId": "vol-1234567890abcdef0" }, "output": { "Description": "This is my root volume snapshot.", "OwnerId": "012345678910", "SnapshotId": "snap-066877671789bd71b", "StartTime": "2014-02-28T21:06:01.000Z", "State": "pending", "Tags": [ ], "VolumeId": "vol-1234567890abcdef0", "VolumeSize": 8 }, "comments": { "input": { }, "output": { } }, "description": "This example creates a snapshot of the volume with a volume ID of ``vol-1234567890abcdef0`` and a short description to identify the snapshot.", "id": "to-create-a-snapshot-1472502529790", "title": "To create a snapshot" } ], "CreateSpotDatafeedSubscription": [ { "input": { "Bucket": "my-s3-bucket", "Prefix": "spotdata" }, "output": { "SpotDatafeedSubscription": { "Bucket": "my-s3-bucket", "OwnerId": "123456789012", "Prefix": "spotdata", "State": "Active" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a Spot Instance data feed for your AWS account.", "id": "ec2-create-spot-datafeed-subscription-1", "title": "To create a Spot Instance datafeed" } ], "CreateSubnet": [ { "input": { "CidrBlock": "10.0.1.0/24", "VpcId": "vpc-a01106c2" }, "output": { "Subnet": { "AvailabilityZone": "us-west-2c", "AvailableIpAddressCount": 251, "CidrBlock": "10.0.1.0/24", "State": "pending", "SubnetId": "subnet-9d4a7b6c", "VpcId": "vpc-a01106c2" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a subnet in the specified VPC with the specified CIDR block. We recommend that you let us select an Availability Zone for you.", "id": "ec2-create-subnet-1", "title": "To create a subnet" } ], "CreateTags": [ { "input": { "Resources": [ "ami-78a54011" ], "Tags": [ { "Key": "Stack", "Value": "production" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example adds the tag Stack=production to the specified image, or overwrites an existing tag for the AMI where the tag key is Stack.", "id": "ec2-create-tags-1", "title": "To add a tag to a resource" } ], "CreateVolume": [ { "input": { "AvailabilityZone": "us-east-1a", "Size": 80, "VolumeType": "gp2" }, "output": { "AvailabilityZone": "us-east-1a", "CreateTime": "2016-08-29T18:52:32.724Z", "Encrypted": false, "Iops": 240, "Size": 80, "SnapshotId": "", "State": "creating", "VolumeId": "vol-6b60b7c7", "VolumeType": "gp2" }, "comments": { "input": { }, "output": { } }, "description": "This example creates an 80 GiB General Purpose (SSD) volume in the Availability Zone ``us-east-1a``.", "id": "to-create-a-new-volume-1472496724296", "title": "To create a new volume" }, { "input": { "AvailabilityZone": "us-east-1a", "Iops": 1000, "SnapshotId": "snap-066877671789bd71b", "VolumeType": "io1" }, "output": { "Attachments": [ ], "AvailabilityZone": "us-east-1a", "CreateTime": "2016-08-29T18:52:32.724Z", "Iops": 1000, "Size": 500, "SnapshotId": "snap-066877671789bd71b", "State": "creating", "Tags": [ ], "VolumeId": "vol-1234567890abcdef0", "VolumeType": "io1" }, "comments": { "input": { }, "output": { } }, "description": "This example creates a new Provisioned IOPS (SSD) volume with 1000 provisioned IOPS from a snapshot in the Availability Zone ``us-east-1a``.", "id": "to-create-a-new-provisioned-iops-ssd-volume-from-a-snapshot-1472498975176", "title": "To create a new Provisioned IOPS (SSD) volume from a snapshot" } ], "CreateVpc": [ { "input": { "CidrBlock": "10.0.0.0/16" }, "output": { "Vpc": { "CidrBlock": "10.0.0.0/16", "DhcpOptionsId": "dopt-7a8b9c2d", "InstanceTenancy": "default", "State": "pending", "VpcId": "vpc-a01106c2" } }, "comments": { "input": { }, "output": { } }, "description": "This example creates a VPC with the specified CIDR block.", "id": "ec2-create-vpc-1", "title": "To create a VPC" } ], "DeleteCustomerGateway": [ { "input": { "CustomerGatewayId": "cgw-0e11f167" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified customer gateway.", "id": "ec2-delete-customer-gateway-1", "title": "To delete a customer gateway" } ], "DeleteDhcpOptions": [ { "input": { "DhcpOptionsId": "dopt-d9070ebb" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified DHCP options set.", "id": "ec2-delete-dhcp-options-1", "title": "To delete a DHCP options set" } ], "DeleteInternetGateway": [ { "input": { "InternetGatewayId": "igw-c0a643a9" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified Internet gateway.", "id": "ec2-delete-internet-gateway-1", "title": "To delete an Internet gateway" } ], "DeleteKeyPair": [ { "input": { "KeyName": "my-key-pair" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified key pair.", "id": "ec2-delete-key-pair-1", "title": "To delete a key pair" } ], "DeleteNatGateway": [ { "input": { "NatGatewayId": "nat-04ae55e711cec5680" }, "output": { "NatGatewayId": "nat-04ae55e711cec5680" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified NAT gateway.", "id": "ec2-delete-nat-gateway-1", "title": "To delete a NAT gateway" } ], "DeleteNetworkAcl": [ { "input": { "NetworkAclId": "acl-5fb85d36" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified network ACL.", "id": "ec2-delete-network-acl-1", "title": "To delete a network ACL" } ], "DeleteNetworkAclEntry": [ { "input": { "Egress": true, "NetworkAclId": "acl-5fb85d36", "RuleNumber": 100 }, "comments": { "input": { }, "output": { } }, "description": "This example deletes ingress rule number 100 from the specified network ACL.", "id": "ec2-delete-network-acl-entry-1", "title": "To delete a network ACL entry" } ], "DeleteNetworkInterface": [ { "input": { "NetworkInterfaceId": "eni-e5aa89a3" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified network interface.", "id": "ec2-delete-network-interface-1", "title": "To delete a network interface" } ], "DeletePlacementGroup": [ { "input": { "GroupName": "my-cluster" }, "output": { }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified placement group.\n", "id": "to-delete-a-placement-group-1472712349959", "title": "To delete a placement group" } ], "DeleteRoute": [ { "input": { "DestinationCidrBlock": "0.0.0.0/0", "RouteTableId": "rtb-22574640" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified route from the specified route table.", "id": "ec2-delete-route-1", "title": "To delete a route" } ], "DeleteRouteTable": [ { "input": { "RouteTableId": "rtb-22574640" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified route table.", "id": "ec2-delete-route-table-1", "title": "To delete a route table" } ], "DeleteSnapshot": [ { "input": { "SnapshotId": "snap-1234567890abcdef0" }, "output": { }, "comments": { "input": { }, "output": { } }, "description": "This example deletes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.", "id": "to-delete-a-snapshot-1472503042567", "title": "To delete a snapshot" } ], "DeleteSpotDatafeedSubscription": [ { "comments": { "input": { }, "output": { } }, "description": "This example deletes a Spot data feed subscription for the account.", "id": "ec2-delete-spot-datafeed-subscription-1", "title": "To cancel a Spot Instance data feed subscription" } ], "DeleteSubnet": [ { "input": { "SubnetId": "subnet-9d4a7b6c" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified subnet.", "id": "ec2-delete-subnet-1", "title": "To delete a subnet" } ], "DeleteTags": [ { "input": { "Resources": [ "ami-78a54011" ], "Tags": [ { "Key": "Stack", "Value": "test" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the tag Stack=test from the specified image.", "id": "ec2-delete-tags-1", "title": "To delete a tag from a resource" } ], "DeleteVolume": [ { "input": { "VolumeId": "vol-049df61146c4d7901" }, "output": { }, "comments": { "input": { }, "output": { } }, "description": "This example deletes an available volume with the volume ID of ``vol-049df61146c4d7901``. If the command succeeds, no output is returned.", "id": "to-delete-a-volume-1472503111160", "title": "To delete a volume" } ], "DeleteVpc": [ { "input": { "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example deletes the specified VPC.", "id": "ec2-delete-vpc-1", "title": "To delete a VPC" } ], "DescribeAccountAttributes": [ { "input": { "AttributeNames": [ "supported-platforms" ] }, "output": { "AccountAttributes": [ { "AttributeName": "supported-platforms", "AttributeValues": [ { "AttributeValue": "EC2" }, { "AttributeValue": "VPC" } ] } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the supported-platforms attribute for your AWS account.", "id": "ec2-describe-account-attributes-1", "title": "To describe a single attribute for your AWS account" }, { "output": { "AccountAttributes": [ { "AttributeName": "supported-platforms", "AttributeValues": [ { "AttributeValue": "EC2" }, { "AttributeValue": "VPC" } ] }, { "AttributeName": "vpc-max-security-groups-per-interface", "AttributeValues": [ { "AttributeValue": "5" } ] }, { "AttributeName": "max-elastic-ips", "AttributeValues": [ { "AttributeValue": "5" } ] }, { "AttributeName": "max-instances", "AttributeValues": [ { "AttributeValue": "20" } ] }, { "AttributeName": "vpc-max-elastic-ips", "AttributeValues": [ { "AttributeValue": "5" } ] }, { "AttributeName": "default-vpc", "AttributeValues": [ { "AttributeValue": "none" } ] } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the attributes for your AWS account.", "id": "ec2-describe-account-attributes-2", "title": "To describe all attributes for your AWS account" } ], "DescribeAddresses": [ { "output": { "Addresses": [ { "Domain": "standard", "InstanceId": "i-1234567890abcdef0", "PublicIp": "198.51.100.0" }, { "AllocationId": "eipalloc-12345678", "AssociationId": "eipassoc-12345678", "Domain": "vpc", "InstanceId": "i-1234567890abcdef0", "NetworkInterfaceId": "eni-12345678", "NetworkInterfaceOwnerId": "123456789012", "PrivateIpAddress": "10.0.1.241", "PublicIp": "203.0.113.0" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes your Elastic IP addresses.", "id": "ec2-describe-addresses-1", "title": "To describe your Elastic IP addresses" }, { "input": { "Filters": [ { "Name": "domain", "Values": [ "vpc" ] } ] }, "output": { "Addresses": [ { "AllocationId": "eipalloc-12345678", "AssociationId": "eipassoc-12345678", "Domain": "vpc", "InstanceId": "i-1234567890abcdef0", "NetworkInterfaceId": "eni-12345678", "NetworkInterfaceOwnerId": "123456789012", "PrivateIpAddress": "10.0.1.241", "PublicIp": "203.0.113.0" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes your Elastic IP addresses for use with instances in a VPC.", "id": "ec2-describe-addresses-2", "title": "To describe your Elastic IP addresses for EC2-VPC" }, { "input": { "Filters": [ { "Name": "domain", "Values": [ "standard" ] } ] }, "output": { "Addresses": [ { "Domain": "standard", "InstanceId": "i-1234567890abcdef0", "PublicIp": "198.51.100.0" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes your Elastic IP addresses for use with instances in EC2-Classic.", "id": "ec2-describe-addresses-3", "title": "To describe your Elastic IP addresses for EC2-Classic" } ], "DescribeAvailabilityZones": [ { "output": { "AvailabilityZones": [ { "Messages": [ ], "RegionName": "us-east-1", "State": "available", "ZoneName": "us-east-1b" }, { "Messages": [ ], "RegionName": "us-east-1", "State": "available", "ZoneName": "us-east-1c" }, { "Messages": [ ], "RegionName": "us-east-1", "State": "available", "ZoneName": "us-east-1d" }, { "Messages": [ ], "RegionName": "us-east-1", "State": "available", "ZoneName": "us-east-1e" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the Availability Zones that are available to you. The response includes Availability Zones only for the current region.", "id": "ec2-describe-availability-zones-1", "title": "To describe your Availability Zones" } ], "DescribeCustomerGateways": [ { "input": { "CustomerGatewayIds": [ "cgw-0e11f167" ] }, "output": { "CustomerGateways": [ { "BgpAsn": "65534", "CustomerGatewayId": "cgw-0e11f167", "IpAddress": "12.1.2.3", "State": "available", "Type": "ipsec.1" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the specified customer gateway.", "id": "ec2-describe-customer-gateways-1", "title": "To describe a customer gateway" } ], "DescribeDhcpOptions": [ { "input": { "DhcpOptionsIds": [ "dopt-d9070ebb" ] }, "output": { "DhcpOptions": [ { "DhcpConfigurations": [ { "Key": "domain-name-servers", "Values": [ { "Value": "10.2.5.2" }, { "Value": "10.2.5.1" } ] } ], "DhcpOptionsId": "dopt-d9070ebb" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the specified DHCP options set.", "id": "ec2-describe-dhcp-options-1", "title": "To describe a DHCP options set" } ], "DescribeInstanceAttribute": [ { "input": { "Attribute": "instanceType", "InstanceId": "i-1234567890abcdef0" }, "output": { "InstanceId": "i-1234567890abcdef0", "InstanceType": { "Value": "t1.micro" } }, "comments": { "input": { }, "output": { } }, "description": "This example describes the instance type of the specified instance.\n", "id": "to-describe-the-instance-type-1472712432132", "title": "To describe the instance type" }, { "input": { "Attribute": "disableApiTermination", "InstanceId": "i-1234567890abcdef0" }, "output": { "DisableApiTermination": { "Value": "false" }, "InstanceId": "i-1234567890abcdef0" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the ``disableApiTermination`` attribute of the specified instance.\n", "id": "to-describe-the-disableapitermination-attribute-1472712533466", "title": "To describe the disableApiTermination attribute" }, { "input": { "Attribute": "blockDeviceMapping", "InstanceId": "i-1234567890abcdef0" }, "output": { "BlockDeviceMappings": [ { "DeviceName": "/dev/sda1", "Ebs": { "AttachTime": "2013-05-17T22:42:34.000Z", "DeleteOnTermination": true, "Status": "attached", "VolumeId": "vol-049df61146c4d7901" } }, { "DeviceName": "/dev/sdf", "Ebs": { "AttachTime": "2013-09-10T23:07:00.000Z", "DeleteOnTermination": false, "Status": "attached", "VolumeId": "vol-049df61146c4d7901" } } ], "InstanceId": "i-1234567890abcdef0" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the ``blockDeviceMapping`` attribute of the specified instance.\n", "id": "to-describe-the-block-device-mapping-for-an-instance-1472712645423", "title": "To describe the block device mapping for an instance" } ], "DescribeInternetGateways": [ { "input": { "Filters": [ { "Name": "attachment.vpc-id", "Values": [ "vpc-a01106c2" ] } ] }, "output": { "InternetGateways": [ { "Attachments": [ { "State": "available", "VpcId": "vpc-a01106c2" } ], "InternetGatewayId": "igw-c0a643a9", "Tags": [ ] } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the Internet gateway for the specified VPC.", "id": "ec2-describe-internet-gateways-1", "title": "To describe the Internet gateway for a VPC" } ], "DescribeKeyPairs": [ { "input": { "KeyNames": [ "my-key-pair" ] }, "output": { "KeyPairs": [ { "KeyFingerprint": "1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f", "KeyName": "my-key-pair" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example displays the fingerprint for the specified key.", "id": "ec2-describe-key-pairs-1", "title": "To display a key pair" } ], "DescribeMovingAddresses": [ { "output": { "MovingAddressStatuses": [ { "MoveStatus": "MovingToVpc", "PublicIp": "198.51.100.0" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes all of your moving Elastic IP addresses.", "id": "ec2-describe-moving-addresses-1", "title": "To describe your moving addresses" } ], "DescribeNatGateways": [ { "input": { "Filter": [ { "Name": "vpc-id", "Values": [ "vpc-1a2b3c4d" ] } ] }, "output": { "NatGateways": [ { "CreateTime": "2015-12-01T12:26:55.983Z", "NatGatewayAddresses": [ { "AllocationId": "eipalloc-89c620ec", "NetworkInterfaceId": "eni-9dec76cd", "PrivateIp": "10.0.0.149", "PublicIp": "198.11.222.333" } ], "NatGatewayId": "nat-05dba92075d71c408", "State": "available", "SubnetId": "subnet-847e4dc2", "VpcId": "vpc-1a2b3c4d" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the NAT gateway for the specified VPC.", "id": "ec2-describe-nat-gateways-1", "title": "To describe a NAT gateway" } ], "DescribeNetworkAcls": [ { "input": { "NetworkAclIds": [ "acl-5fb85d36" ] }, "output": { "NetworkAcls": [ { "Associations": [ { "NetworkAclAssociationId": "aclassoc-66ea5f0b", "NetworkAclId": "acl-9aeb5ef7", "SubnetId": "subnet-65ea5f08" } ], "Entries": [ { "CidrBlock": "0.0.0.0/0", "Egress": true, "Protocol": "-1", "RuleAction": "deny", "RuleNumber": 32767 }, { "CidrBlock": "0.0.0.0/0", "Egress": false, "Protocol": "-1", "RuleAction": "deny", "RuleNumber": 32767 } ], "IsDefault": false, "NetworkAclId": "acl-5fb85d36", "Tags": [ ], "VpcId": "vpc-a01106c2" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the specified network ACL.", "id": "ec2-", "title": "To describe a network ACL" } ], "DescribeNetworkInterfaceAttribute": [ { "input": { "Attribute": "attachment", "NetworkInterfaceId": "eni-686ea200" }, "output": { "Attachment": { "AttachTime": "2015-05-21T20:02:20.000Z", "AttachmentId": "eni-attach-43348162", "DeleteOnTermination": true, "DeviceIndex": 0, "InstanceId": "i-1234567890abcdef0", "InstanceOwnerId": "123456789012", "Status": "attached" }, "NetworkInterfaceId": "eni-686ea200" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the attachment attribute of the specified network interface.", "id": "ec2-describe-network-interface-attribute-1", "title": "To describe the attachment attribute of a network interface" }, { "input": { "Attribute": "description", "NetworkInterfaceId": "eni-686ea200" }, "output": { "Description": { "Value": "My description" }, "NetworkInterfaceId": "eni-686ea200" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the description attribute of the specified network interface.", "id": "ec2-describe-network-interface-attribute-2", "title": "To describe the description attribute of a network interface" }, { "input": { "Attribute": "groupSet", "NetworkInterfaceId": "eni-686ea200" }, "output": { "Groups": [ { "GroupId": "sg-903004f8", "GroupName": "my-security-group" } ], "NetworkInterfaceId": "eni-686ea200" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the groupSet attribute of the specified network interface.", "id": "ec2-describe-network-interface-attribute-3", "title": "To describe the groupSet attribute of a network interface" }, { "input": { "Attribute": "sourceDestCheck", "NetworkInterfaceId": "eni-686ea200" }, "output": { "NetworkInterfaceId": "eni-686ea200", "SourceDestCheck": { "Value": true } }, "comments": { "input": { }, "output": { } }, "description": "This example describes the sourceDestCheck attribute of the specified network interface.", "id": "ec2-describe-network-interface-attribute-4", "title": "To describe the sourceDestCheck attribute of a network interface" } ], "DescribeNetworkInterfaces": [ { "input": { "NetworkInterfaceIds": [ "eni-e5aa89a3" ] }, "output": { "NetworkInterfaces": [ { "Association": { "AssociationId": "eipassoc-0fbb766a", "IpOwnerId": "123456789012", "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", "PublicIp": "203.0.113.12" }, "Attachment": { "AttachTime": "2013-11-30T23:36:42.000Z", "AttachmentId": "eni-attach-66c4350a", "DeleteOnTermination": false, "DeviceIndex": 1, "InstanceId": "i-1234567890abcdef0", "InstanceOwnerId": "123456789012", "Status": "attached" }, "AvailabilityZone": "us-east-1d", "Description": "my network interface", "Groups": [ { "GroupId": "sg-8637d3e3", "GroupName": "default" } ], "MacAddress": "02:2f:8f:b0:cf:75", "NetworkInterfaceId": "eni-e5aa89a3", "OwnerId": "123456789012", "PrivateDnsName": "ip-10-0-1-17.ec2.internal", "PrivateIpAddress": "10.0.1.17", "PrivateIpAddresses": [ { "Association": { "AssociationId": "eipassoc-0fbb766a", "IpOwnerId": "123456789012", "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", "PublicIp": "203.0.113.12" }, "Primary": true, "PrivateDnsName": "ip-10-0-1-17.ec2.internal", "PrivateIpAddress": "10.0.1.17" } ], "RequesterManaged": false, "SourceDestCheck": true, "Status": "in-use", "SubnetId": "subnet-b61f49f0", "TagSet": [ ], "VpcId": "vpc-a01106c2" } ] }, "comments": { "input": { }, "output": { } }, "description": "", "id": "ec2-describe-network-interfaces-1", "title": "To describe a network interface" } ], "DescribeRegions": [ { "output": { "Regions": [ { "Endpoint": "ec2.ap-south-1.amazonaws.com", "RegionName": "ap-south-1" }, { "Endpoint": "ec2.eu-west-1.amazonaws.com", "RegionName": "eu-west-1" }, { "Endpoint": "ec2.ap-southeast-1.amazonaws.com", "RegionName": "ap-southeast-1" }, { "Endpoint": "ec2.ap-southeast-2.amazonaws.com", "RegionName": "ap-southeast-2" }, { "Endpoint": "ec2.eu-central-1.amazonaws.com", "RegionName": "eu-central-1" }, { "Endpoint": "ec2.ap-northeast-2.amazonaws.com", "RegionName": "ap-northeast-2" }, { "Endpoint": "ec2.ap-northeast-1.amazonaws.com", "RegionName": "ap-northeast-1" }, { "Endpoint": "ec2.us-east-1.amazonaws.com", "RegionName": "us-east-1" }, { "Endpoint": "ec2.sa-east-1.amazonaws.com", "RegionName": "sa-east-1" }, { "Endpoint": "ec2.us-west-1.amazonaws.com", "RegionName": "us-west-1" }, { "Endpoint": "ec2.us-west-2.amazonaws.com", "RegionName": "us-west-2" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes all the regions that are available to you.", "id": "ec2-describe-regions-1", "title": "To describe your regions" } ], "DescribeRouteTables": [ { "input": { "RouteTableIds": [ "rtb-1f382e7d" ] }, "output": { "RouteTables": [ { "Associations": [ { "Main": true, "RouteTableAssociationId": "rtbassoc-d8ccddba", "RouteTableId": "rtb-1f382e7d" } ], "PropagatingVgws": [ ], "RouteTableId": "rtb-1f382e7d", "Routes": [ { "DestinationCidrBlock": "10.0.0.0/16", "GatewayId": "local", "State": "active" } ], "Tags": [ ], "VpcId": "vpc-a01106c2" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the specified route table.", "id": "ec2-describe-route-tables-1", "title": "To describe a route table" } ], "DescribeScheduledInstanceAvailability": [ { "input": { "FirstSlotStartTimeRange": { "EarliestTime": "2016-01-31T00:00:00Z", "LatestTime": "2016-01-31T04:00:00Z" }, "Recurrence": { "Frequency": "Weekly", "Interval": 1, "OccurrenceDays": [ 1 ] } }, "output": { "ScheduledInstanceAvailabilitySet": [ { "AvailabilityZone": "us-west-2b", "AvailableInstanceCount": 20, "FirstSlotStartTime": "2016-01-31T00:00:00Z", "HourlyPrice": "0.095", "InstanceType": "c4.large", "MaxTermDurationInDays": 366, "MinTermDurationInDays": 366, "NetworkPlatform": "EC2-VPC", "Platform": "Linux/UNIX", "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi...", "Recurrence": { "Frequency": "Weekly", "Interval": 1, "OccurrenceDaySet": [ 1 ], "OccurrenceRelativeToEnd": false }, "SlotDurationInHours": 23, "TotalScheduledInstanceHours": 1219 } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes a schedule that occurs every week on Sunday, starting on the specified date. Note that the output contains a single schedule as an example.", "id": "ec2-describe-scheduled-instance-availability-1", "title": "To describe an available schedule" } ], "DescribeScheduledInstances": [ { "input": { "ScheduledInstanceIds": [ "sci-1234-1234-1234-1234-123456789012" ] }, "output": { "ScheduledInstanceSet": [ { "AvailabilityZone": "us-west-2b", "CreateDate": "2016-01-25T21:43:38.612Z", "HourlyPrice": "0.095", "InstanceCount": 1, "InstanceType": "c4.large", "NetworkPlatform": "EC2-VPC", "NextSlotStartTime": "2016-01-31T09:00:00Z", "Platform": "Linux/UNIX", "Recurrence": { "Frequency": "Weekly", "Interval": 1, "OccurrenceDaySet": [ 1 ], "OccurrenceRelativeToEnd": false, "OccurrenceUnit": "" }, "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012", "SlotDurationInHours": 32, "TermEndDate": "2017-01-31T09:00:00Z", "TermStartDate": "2016-01-31T09:00:00Z", "TotalScheduledInstanceHours": 1696 } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the specified Scheduled Instance.", "id": "ec2-describe-scheduled-instances-1", "title": "To describe your Scheduled Instances" } ], "DescribeSnapshotAttribute": [ { "input": { "Attribute": "createVolumePermission", "SnapshotId": "snap-066877671789bd71b" }, "output": { "CreateVolumePermissions": [ ], "SnapshotId": "snap-066877671789bd71b" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the ``createVolumePermission`` attribute on a snapshot with the snapshot ID of ``snap-066877671789bd71b``.", "id": "to-describe-snapshot-attributes-1472503199736", "title": "To describe snapshot attributes" } ], "DescribeSnapshots": [ { "input": { "SnapshotIds": [ "snap-1234567890abcdef0" ] }, "output": { "NextToken": "", "Snapshots": [ { "Description": "This is my snapshot.", "OwnerId": "012345678910", "Progress": "100%", "SnapshotId": "snap-1234567890abcdef0", "StartTime": "2014-02-28T21:28:32.000Z", "State": "completed", "VolumeId": "vol-049df61146c4d7901", "VolumeSize": 8 } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``.", "id": "to-describe-a-snapshot-1472503807850", "title": "To describe a snapshot" }, { "input": { "Filters": [ { "Name": "status", "Values": [ "pending" ] } ], "OwnerIds": [ "012345678910" ] }, "output": { "NextToken": "", "Snapshots": [ { "Description": "This is my copied snapshot.", "OwnerId": "012345678910", "Progress": "87%", "SnapshotId": "snap-066877671789bd71b", "StartTime": "2014-02-28T21:37:27.000Z", "State": "pending", "VolumeId": "vol-1234567890abcdef0", "VolumeSize": 8 } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes all snapshots owned by the ID 012345678910 that are in the ``pending`` status.", "id": "to-describe-snapshots-using-filters-1472503929793", "title": "To describe snapshots using filters" } ], "DescribeSpotDatafeedSubscription": [ { "output": { "SpotDatafeedSubscription": { "Bucket": "my-s3-bucket", "OwnerId": "123456789012", "Prefix": "spotdata", "State": "Active" } }, "comments": { "input": { }, "output": { } }, "description": "This example describes the Spot Instance datafeed subscription for your AWS account.", "id": "ec2-describe-spot-datafeed-subscription-1", "title": "To describe the datafeed for your AWS account" } ], "DescribeSpotFleetInstances": [ { "input": { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" }, "output": { "ActiveInstances": [ { "InstanceId": "i-1234567890abcdef0", "InstanceType": "m3.medium", "SpotInstanceRequestId": "sir-08b93456" } ], "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" }, "comments": { "input": { }, "output": { } }, "description": "This example lists the Spot Instances associated with the specified Spot fleet.", "id": "ec2-describe-spot-fleet-instances-1", "title": "To describe the Spot Instances associated with a Spot fleet" } ], "DescribeSpotFleetRequestHistory": [ { "input": { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "StartTime": "2015-05-26T00:00:00Z" }, "output": { "HistoryRecords": [ { "EventInformation": { "EventSubType": "submitted" }, "EventType": "fleetRequestChange", "Timestamp": "2015-05-26T23:17:20.697Z" }, { "EventInformation": { "EventSubType": "active" }, "EventType": "fleetRequestChange", "Timestamp": "2015-05-26T23:17:20.873Z" }, { "EventInformation": { "EventSubType": "launched", "InstanceId": "i-1234567890abcdef0" }, "EventType": "instanceChange", "Timestamp": "2015-05-26T23:21:21.712Z" }, { "EventInformation": { "EventSubType": "launched", "InstanceId": "i-1234567890abcdef1" }, "EventType": "instanceChange", "Timestamp": "2015-05-26T23:21:21.816Z" } ], "NextToken": "CpHNsscimcV5oH7bSbub03CI2Qms5+ypNpNm+53MNlR0YcXAkp0xFlfKf91yVxSExmbtma3awYxMFzNA663ZskT0AHtJ6TCb2Z8bQC2EnZgyELbymtWPfpZ1ZbauVg+P+TfGlWxWWB/Vr5dk5d4LfdgA/DRAHUrYgxzrEXAMPLE=", "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "StartTime": "2015-05-26T00:00:00Z" }, "comments": { "input": { }, "output": { } }, "description": "This example returns the history for the specified Spot fleet starting at the specified time.", "id": "ec2-describe-spot-fleet-request-history-1", "title": "To describe Spot fleet history" } ], "DescribeSpotFleetRequests": [ { "input": { "SpotFleetRequestIds": [ "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" ] }, "output": { "SpotFleetRequestConfigs": [ { "SpotFleetRequestConfig": { "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", "LaunchSpecifications": [ { "EbsOptimized": false, "ImageId": "ami-1a2b3c4d", "InstanceType": "cc2.8xlarge", "NetworkInterfaces": [ { "AssociatePublicIpAddress": true, "DeleteOnTermination": false, "DeviceIndex": 0, "SecondaryPrivateIpAddressCount": 0, "SubnetId": "subnet-a61dafcf" } ] }, { "EbsOptimized": false, "ImageId": "ami-1a2b3c4d", "InstanceType": "r3.8xlarge", "NetworkInterfaces": [ { "AssociatePublicIpAddress": true, "DeleteOnTermination": false, "DeviceIndex": 0, "SecondaryPrivateIpAddressCount": 0, "SubnetId": "subnet-a61dafcf" } ] } ], "SpotPrice": "0.05", "TargetCapacity": 20 }, "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "SpotFleetRequestState": "active" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the specified Spot fleet request.", "id": "ec2-describe-spot-fleet-requests-1", "title": "To describe a Spot fleet request" } ], "DescribeSpotInstanceRequests": [ { "input": { "SpotInstanceRequestIds": [ "sir-08b93456" ] }, "output": { "SpotInstanceRequests": [ { "CreateTime": "2014-04-30T18:14:55.000Z", "InstanceId": "i-1234567890abcdef0", "LaunchSpecification": { "BlockDeviceMappings": [ { "DeviceName": "/dev/sda1", "Ebs": { "DeleteOnTermination": true, "VolumeSize": 8, "VolumeType": "standard" } } ], "EbsOptimized": false, "ImageId": "ami-7aba833f", "InstanceType": "m1.small", "KeyName": "my-key-pair", "SecurityGroups": [ { "GroupId": "sg-e38f24a7", "GroupName": "my-security-group" } ] }, "LaunchedAvailabilityZone": "us-west-1b", "ProductDescription": "Linux/UNIX", "SpotInstanceRequestId": "sir-08b93456", "SpotPrice": "0.010000", "State": "active", "Status": { "Code": "fulfilled", "Message": "Your Spot request is fulfilled.", "UpdateTime": "2014-04-30T18:16:21.000Z" }, "Type": "one-time" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the specified Spot Instance request.", "id": "ec2-describe-spot-instance-requests-1", "title": "To describe a Spot Instance request" } ], "DescribeSpotPriceHistory": [ { "input": { "EndTime": "2014-01-06T08:09:10", "InstanceTypes": [ "m1.xlarge" ], "ProductDescriptions": [ "Linux/UNIX (Amazon VPC)" ], "StartTime": "2014-01-06T07:08:09" }, "output": { "SpotPriceHistory": [ { "AvailabilityZone": "us-west-1a", "InstanceType": "m1.xlarge", "ProductDescription": "Linux/UNIX (Amazon VPC)", "SpotPrice": "0.080000", "Timestamp": "2014-01-06T04:32:53.000Z" }, { "AvailabilityZone": "us-west-1c", "InstanceType": "m1.xlarge", "ProductDescription": "Linux/UNIX (Amazon VPC)", "SpotPrice": "0.080000", "Timestamp": "2014-01-05T11:28:26.000Z" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example returns the Spot Price history for m1.xlarge, Linux/UNIX (Amazon VPC) instances for a particular day in January.", "id": "ec2-describe-spot-price-history-1", "title": "To describe Spot price history for Linux/UNIX (Amazon VPC)" } ], "DescribeSubnets": [ { "input": { "Filters": [ { "Name": "vpc-id", "Values": [ "vpc-a01106c2" ] } ] }, "output": { "Subnets": [ { "AvailabilityZone": "us-east-1c", "AvailableIpAddressCount": 251, "CidrBlock": "10.0.1.0/24", "DefaultForAz": false, "MapPublicIpOnLaunch": false, "State": "available", "SubnetId": "subnet-9d4a7b6c", "VpcId": "vpc-a01106c2" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the subnets for the specified VPC.", "id": "ec2-describe-subnets-1", "title": "To describe the subnets for a VPC" } ], "DescribeTags": [ { "input": { "Filters": [ { "Name": "resource-id", "Values": [ "i-1234567890abcdef8" ] } ] }, "output": { "Tags": [ { "Key": "Stack", "ResourceId": "i-1234567890abcdef8", "ResourceType": "instance", "Value": "test" }, { "Key": "Name", "ResourceId": "i-1234567890abcdef8", "ResourceType": "instance", "Value": "Beta Server" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the tags for the specified instance.", "id": "ec2-describe-tags-1", "title": "To describe the tags for a single resource" } ], "DescribeVolumeAttribute": [ { "input": { "Attribute": "autoEnableIO", "VolumeId": "vol-049df61146c4d7901" }, "output": { "AutoEnableIO": { "Value": false }, "VolumeId": "vol-049df61146c4d7901" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the ``autoEnableIo`` attribute of the volume with the ID ``vol-049df61146c4d7901``.", "id": "to-describe-a-volume-attribute-1472505773492", "title": "To describe a volume attribute" } ], "DescribeVolumeStatus": [ { "input": { "VolumeIds": [ "vol-1234567890abcdef0" ] }, "output": { "VolumeStatuses": [ { "Actions": [ ], "AvailabilityZone": "us-east-1a", "Events": [ ], "VolumeId": "vol-1234567890abcdef0", "VolumeStatus": { "Details": [ { "Name": "io-enabled", "Status": "passed" }, { "Name": "io-performance", "Status": "not-applicable" } ], "Status": "ok" } } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the status for the volume ``vol-1234567890abcdef0``.", "id": "to-describe-the-status-of-a-single-volume-1472507016193", "title": "To describe the status of a single volume" }, { "input": { "Filters": [ { "Name": "volume-status.status", "Values": [ "impaired" ] } ] }, "output": { "VolumeStatuses": [ ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the status for all volumes that are impaired. In this example output, there are no impaired volumes.", "id": "to-describe-the-status-of-impaired-volumes-1472507239821", "title": "To describe the status of impaired volumes" } ], "DescribeVolumes": [ { "input": { }, "output": { "NextToken": "", "Volumes": [ { "Attachments": [ { "AttachTime": "2013-12-18T22:35:00.000Z", "DeleteOnTermination": true, "Device": "/dev/sda1", "InstanceId": "i-1234567890abcdef0", "State": "attached", "VolumeId": "vol-049df61146c4d7901" } ], "AvailabilityZone": "us-east-1a", "CreateTime": "2013-12-18T22:35:00.084Z", "Size": 8, "SnapshotId": "snap-1234567890abcdef0", "State": "in-use", "VolumeId": "vol-049df61146c4d7901", "VolumeType": "standard" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes all of your volumes in the default region.", "id": "to-describe-all-volumes-1472506358883", "title": "To describe all volumes" }, { "input": { "Filters": [ { "Name": "attachment.instance-id", "Values": [ "i-1234567890abcdef0" ] }, { "Name": "attachment.delete-on-termination", "Values": [ "true" ] } ] }, "output": { "Volumes": [ { "Attachments": [ { "AttachTime": "2013-12-18T22:35:00.000Z", "DeleteOnTermination": true, "Device": "/dev/sda1", "InstanceId": "i-1234567890abcdef0", "State": "attached", "VolumeId": "vol-049df61146c4d7901" } ], "AvailabilityZone": "us-east-1a", "CreateTime": "2013-12-18T22:35:00.084Z", "Size": 8, "SnapshotId": "snap-1234567890abcdef0", "State": "in-use", "VolumeId": "vol-049df61146c4d7901", "VolumeType": "standard" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes all volumes that are both attached to the instance with the ID i-1234567890abcdef0 and set to delete when the instance terminates.", "id": "to-describe-volumes-that-are-attached-to-a-specific-instance-1472506613578", "title": "To describe volumes that are attached to a specific instance" } ], "DescribeVpcAttribute": [ { "input": { "Attribute": "enableDnsSupport", "VpcId": "vpc-a01106c2" }, "output": { "EnableDnsSupport": { "Value": true }, "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.", "id": "ec2-describe-vpc-attribute-1", "title": "To describe the enableDnsSupport attribute" }, { "input": { "Attribute": "enableDnsHostnames", "VpcId": "vpc-a01106c2" }, "output": { "EnableDnsHostnames": { "Value": true }, "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example describes the enableDnsHostnames attribute. This attribute indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.", "id": "ec2-describe-vpc-attribute-2", "title": "To describe the enableDnsHostnames attribute" } ], "DescribeVpcs": [ { "input": { "VpcIds": [ "vpc-a01106c2" ] }, "output": { "Vpcs": [ { "CidrBlock": "10.0.0.0/16", "DhcpOptionsId": "dopt-7a8b9c2d", "InstanceTenancy": "default", "IsDefault": false, "State": "available", "Tags": [ { "Key": "Name", "Value": "MyVPC" } ], "VpcId": "vpc-a01106c2" } ] }, "comments": { "input": { }, "output": { } }, "description": "This example describes the specified VPC.", "id": "ec2-describe-vpcs-1", "title": "To describe a VPC" } ], "DetachInternetGateway": [ { "input": { "InternetGatewayId": "igw-c0a643a9", "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example detaches the specified Internet gateway from the specified VPC.", "id": "ec2-detach-internet-gateway-1", "title": "To detach an Internet gateway from a VPC" } ], "DetachNetworkInterface": [ { "input": { "AttachmentId": "eni-attach-66c4350a" }, "comments": { "input": { }, "output": { } }, "description": "This example detaches the specified network interface from its attached instance.", "id": "ec2-detach-network-interface-1", "title": "To detach a network interface from an instance" } ], "DetachVolume": [ { "input": { "VolumeId": "vol-1234567890abcdef0" }, "output": { "AttachTime": "2014-02-27T19:23:06.000Z", "Device": "/dev/sdb", "InstanceId": "i-1234567890abcdef0", "State": "detaching", "VolumeId": "vol-049df61146c4d7901" }, "comments": { "input": { }, "output": { } }, "description": "This example detaches the volume (``vol-049df61146c4d7901``) from the instance it is attached to.", "id": "to-detach-a-volume-from-an-instance-1472507977694", "title": "To detach a volume from an instance" } ], "DisableVgwRoutePropagation": [ { "input": { "GatewayId": "vgw-9a4cacf3", "RouteTableId": "rtb-22574640" }, "comments": { "input": { }, "output": { } }, "description": "This example disables the specified virtual private gateway from propagating static routes to the specified route table.", "id": "ec2-disable-vgw-route-propagation-1", "title": "To disable route propagation" } ], "DisassociateAddress": [ { "input": { "AssociationId": "eipassoc-2bebb745" }, "comments": { "input": { }, "output": { } }, "description": "This example disassociates an Elastic IP address from an instance in a VPC.", "id": "ec2-disassociate-address-1", "title": "To disassociate an Elastic IP address in EC2-VPC" }, { "input": { "PublicIp": "198.51.100.0" }, "comments": { "input": { }, "output": { } }, "description": "This example disassociates an Elastic IP address from an instance in EC2-Classic.", "id": "ec2-disassociate-address-2", "title": "To disassociate an Elastic IP addresses in EC2-Classic" } ], "DisassociateRouteTable": [ { "input": { "AssociationId": "rtbassoc-781d0d1a" }, "comments": { "input": { }, "output": { } }, "description": "This example disassociates the specified route table from its associated subnet.", "id": "ec2-disassociate-route-table-1", "title": "To disassociate a route table" } ], "EnableVgwRoutePropagation": [ { "input": { "GatewayId": "vgw-9a4cacf3", "RouteTableId": "rtb-22574640" }, "comments": { "input": { }, "output": { } }, "description": "This example enables the specified virtual private gateway to propagate static routes to the specified route table.", "id": "ec2-enable-vgw-route-propagation-1", "title": "To enable route propagation" } ], "EnableVolumeIO": [ { "input": { "VolumeId": "vol-1234567890abcdef0" }, "comments": { "input": { }, "output": { } }, "description": "This example enables I/O on volume ``vol-1234567890abcdef0``.", "id": "to-enable-io-for-a-volume-1472508114867", "title": "To enable I/O for a volume" } ], "ModifyNetworkInterfaceAttribute": [ { "input": { "Attachment": { "AttachmentId": "eni-attach-43348162", "DeleteOnTermination": false }, "NetworkInterfaceId": "eni-686ea200" }, "comments": { "input": { }, "output": { } }, "description": "This example modifies the attachment attribute of the specified network interface.", "id": "ec2-modify-network-interface-attribute-1", "title": "To modify the attachment attribute of a network interface" }, { "input": { "Description": { "Value": "My description" }, "NetworkInterfaceId": "eni-686ea200" }, "comments": { "input": { }, "output": { } }, "description": "This example modifies the description attribute of the specified network interface.", "id": "ec2-modify-network-interface-attribute-2", "title": "To modify the description attribute of a network interface" }, { "input": { "Groups": [ "sg-903004f8", "sg-1a2b3c4d" ], "NetworkInterfaceId": "eni-686ea200" }, "comments": { "input": { }, "output": { } }, "description": "This example command modifies the groupSet attribute of the specified network interface.", "id": "ec2-modify-network-interface-attribute-3", "title": "To modify the groupSet attribute of a network interface" }, { "input": { "NetworkInterfaceId": "eni-686ea200", "SourceDestCheck": { "Value": false } }, "comments": { "input": { }, "output": { } }, "description": "This example command modifies the sourceDestCheck attribute of the specified network interface.", "id": "ec2-modify-network-interface-attribute-4", "title": "To modify the sourceDestCheck attribute of a network interface" } ], "ModifySnapshotAttribute": [ { "input": { "Attribute": "createVolumePermission", "OperationType": "remove", "SnapshotId": "snap-1234567890abcdef0", "UserIds": [ "123456789012" ] }, "output": { }, "comments": { "input": { }, "output": { } }, "description": "This example modifies snapshot ``snap-1234567890abcdef0`` to remove the create volume permission for a user with the account ID ``123456789012``. If the command succeeds, no output is returned.", "id": "to-modify-a-snapshot-attribute-1472508385907", "title": "To modify a snapshot attribute" }, { "input": { "Attribute": "createVolumePermission", "GroupNames": [ "all" ], "OperationType": "add", "SnapshotId": "snap-1234567890abcdef0" }, "output": { }, "comments": { "input": { }, "output": { } }, "description": "This example makes the snapshot ``snap-1234567890abcdef0`` public.", "id": "to-make-a-snapshot-public-1472508470529", "title": "To make a snapshot public" } ], "ModifySpotFleetRequest": [ { "input": { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "TargetCapacity": 20 }, "output": { "Return": true }, "comments": { "input": { }, "output": { } }, "description": "This example increases the target capacity of the specified Spot fleet request.", "id": "ec2-modify-spot-fleet-request-1", "title": "To increase the target capacity of a Spot fleet request" }, { "input": { "ExcessCapacityTerminationPolicy": "NoTermination ", "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "TargetCapacity": 10 }, "output": { "Return": true }, "comments": { "input": { }, "output": { } }, "description": "This example decreases the target capacity of the specified Spot fleet request without terminating any Spot Instances as a result.", "id": "ec2-modify-spot-fleet-request-2", "title": "To decrease the target capacity of a Spot fleet request" } ], "ModifySubnetAttribute": [ { "input": { "MapPublicIpOnLaunch": { "Value": true }, "SubnetId": "subnet-1a2b3c4d" }, "comments": { "input": { }, "output": { } }, "description": "This example modifies the specified subnet so that all instances launched into this subnet are assigned a public IP address.", "id": "ec2-modify-subnet-attribute-1", "title": "To change a subnet's public IP addressing behavior" } ], "ModifyVolumeAttribute": [ { "input": { "AutoEnableIO": { "Value": true }, "DryRun": true, "VolumeId": "vol-1234567890abcdef0" }, "output": { }, "comments": { "input": { }, "output": { } }, "description": "This example sets the ``autoEnableIo`` attribute of the volume with the ID ``vol-1234567890abcdef0`` to ``true``. If the command succeeds, no output is returned.", "id": "to-modify-a-volume-attribute-1472508596749", "title": "To modify a volume attribute" } ], "ModifyVpcAttribute": [ { "input": { "EnableDnsSupport": { "Value": false }, "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example modifies the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for instances in the VPC to their corresponding IP addresses; otherwise, it does not.", "id": "ec2-modify-vpc-attribute-1", "title": "To modify the enableDnsSupport attribute" }, { "input": { "EnableDnsHostnames": { "Value": false }, "VpcId": "vpc-a01106c2" }, "comments": { "input": { }, "output": { } }, "description": "This example modifies the enableDnsHostnames attribute. This attribute indicates whether instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.", "id": "ec2-modify-vpc-attribute-2", "title": "To modify the enableDnsHostnames attribute" } ], "MoveAddressToVpc": [ { "input": { "PublicIp": "54.123.4.56" }, "output": { "Status": "MoveInProgress" }, "comments": { "input": { }, "output": { } }, "description": "This example moves the specified Elastic IP address to the EC2-VPC platform.", "id": "ec2-move-address-to-vpc-1", "title": "To move an address to EC2-VPC" } ], "PurchaseScheduledInstances": [ { "input": { "PurchaseRequests": [ { "InstanceCount": 1, "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi..." } ] }, "output": { "ScheduledInstanceSet": [ { "AvailabilityZone": "us-west-2b", "CreateDate": "2016-01-25T21:43:38.612Z", "HourlyPrice": "0.095", "InstanceCount": 1, "InstanceType": "c4.large", "NetworkPlatform": "EC2-VPC", "NextSlotStartTime": "2016-01-31T09:00:00Z", "Platform": "Linux/UNIX", "Recurrence": { "Frequency": "Weekly", "Interval": 1, "OccurrenceDaySet": [ 1 ], "OccurrenceRelativeToEnd": false, "OccurrenceUnit": "" }, "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012", "SlotDurationInHours": 32, "TermEndDate": "2017-01-31T09:00:00Z", "TermStartDate": "2016-01-31T09:00:00Z", "TotalScheduledInstanceHours": 1696 } ] }, "comments": { "input": { }, "output": { } }, "description": "This example purchases a Scheduled Instance.", "id": "ec2-purchase-scheduled-instances-1", "title": "To purchase a Scheduled Instance" } ], "ReleaseAddress": [ { "input": { "AllocationId": "eipalloc-64d5890a" }, "comments": { "input": { }, "output": { } }, "description": "This example releases an Elastic IP address for use with instances in a VPC.", "id": "ec2-release-address-1", "title": "To release an Elastic IP address for EC2-VPC" }, { "input": { "PublicIp": "198.51.100.0" }, "comments": { "input": { }, "output": { } }, "description": "This example releases an Elastic IP address for use with instances in EC2-Classic.", "id": "ec2-release-address-2", "title": "To release an Elastic IP addresses for EC2-Classic" } ], "ReplaceNetworkAclAssociation": [ { "input": { "AssociationId": "aclassoc-e5b95c8c", "NetworkAclId": "acl-5fb85d36" }, "output": { "NewAssociationId": "aclassoc-3999875b" }, "comments": { "input": { }, "output": { } }, "description": "This example associates the specified network ACL with the subnet for the specified network ACL association.", "id": "ec2-replace-network-acl-association-1", "title": "To replace the network ACL associated with a subnet" } ], "ReplaceNetworkAclEntry": [ { "input": { "CidrBlock": "203.0.113.12/24", "Egress": false, "NetworkAclId": "acl-5fb85d36", "PortRange": { "From": 53, "To": 53 }, "Protocol": "udp", "RuleAction": "allow", "RuleNumber": 100 }, "comments": { "input": { }, "output": { } }, "description": "This example replaces an entry for the specified network ACL. The new rule 100 allows ingress traffic from 203.0.113.12/24 on UDP port 53 (DNS) into any associated subnet.", "id": "ec2-replace-network-acl-entry-1", "title": "To replace a network ACL entry" } ], "ReplaceRoute": [ { "input": { "DestinationCidrBlock": "10.0.0.0/16", "GatewayId": "vgw-9a4cacf3", "RouteTableId": "rtb-22574640" }, "comments": { "input": { }, "output": { } }, "description": "This example replaces the specified route in the specified table table. The new route matches the specified CIDR and sends the traffic to the specified virtual private gateway.", "id": "ec2-replace-route-1", "title": "To replace a route" } ], "ReplaceRouteTableAssociation": [ { "input": { "AssociationId": "rtbassoc-781d0d1a", "RouteTableId": "rtb-22574640" }, "output": { "NewAssociationId": "rtbassoc-3a1f0f58" }, "comments": { "input": { }, "output": { } }, "description": "This example associates the specified route table with the subnet for the specified route table association.", "id": "ec2-replace-route-table-association-1", "title": "To replace the route table associated with a subnet" } ], "RequestSpotFleet": [ { "input": { "SpotFleetRequestConfig": { "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", "LaunchSpecifications": [ { "IamInstanceProfile": { "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" }, "ImageId": "ami-1a2b3c4d", "InstanceType": "m3.medium", "KeyName": "my-key-pair", "SecurityGroups": [ { "GroupId": "sg-1a2b3c4d" } ], "SubnetId": "subnet-1a2b3c4d, subnet-3c4d5e6f" } ], "SpotPrice": "0.04", "TargetCapacity": 2 } }, "output": { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" }, "comments": { "input": { }, "output": { } }, "description": "This example creates a Spot fleet request with two launch specifications that differ only by subnet. The Spot fleet launches the instances in the specified subnet with the lowest price. If the instances are launched in a default VPC, they receive a public IP address by default. If the instances are launched in a nondefault VPC, they do not receive a public IP address by default. Note that you can't specify different subnets from the same Availability Zone in a Spot fleet request.", "id": "ec2-request-spot-fleet-1", "title": "To request a Spot fleet in the subnet with the lowest price" }, { "input": { "SpotFleetRequestConfig": { "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", "LaunchSpecifications": [ { "IamInstanceProfile": { "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" }, "ImageId": "ami-1a2b3c4d", "InstanceType": "m3.medium", "KeyName": "my-key-pair", "Placement": { "AvailabilityZone": "us-west-2a, us-west-2b" }, "SecurityGroups": [ { "GroupId": "sg-1a2b3c4d" } ] } ], "SpotPrice": "0.04", "TargetCapacity": 2 } }, "output": { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" }, "comments": { "input": { }, "output": { } }, "description": "This example creates a Spot fleet request with two launch specifications that differ only by Availability Zone. The Spot fleet launches the instances in the specified Availability Zone with the lowest price. If your account supports EC2-VPC only, Amazon EC2 launches the Spot instances in the default subnet of the Availability Zone. If your account supports EC2-Classic, Amazon EC2 launches the instances in EC2-Classic in the Availability Zone.", "id": "ec2-request-spot-fleet-2", "title": "To request a Spot fleet in the Availability Zone with the lowest price" }, { "input": { "SpotFleetRequestConfig": { "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", "LaunchSpecifications": [ { "IamInstanceProfile": { "Arn": "arn:aws:iam::880185128111:instance-profile/my-iam-role" }, "ImageId": "ami-1a2b3c4d", "InstanceType": "m3.medium", "KeyName": "my-key-pair", "NetworkInterfaces": [ { "AssociatePublicIpAddress": true, "DeviceIndex": 0, "Groups": [ "sg-1a2b3c4d" ], "SubnetId": "subnet-1a2b3c4d" } ] } ], "SpotPrice": "0.04", "TargetCapacity": 2 } }, "output": { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" }, "comments": { "input": { }, "output": { } }, "description": "This example assigns public addresses to instances launched in a nondefault VPC. Note that when you specify a network interface, you must include the subnet ID and security group ID using the network interface.", "id": "ec2-request-spot-fleet-3", "title": "To launch Spot instances in a subnet and assign them public IP addresses" }, { "input": { "SpotFleetRequestConfig": { "AllocationStrategy": "diversified", "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", "LaunchSpecifications": [ { "ImageId": "ami-1a2b3c4d", "InstanceType": "c4.2xlarge", "SubnetId": "subnet-1a2b3c4d" }, { "ImageId": "ami-1a2b3c4d", "InstanceType": "m3.2xlarge", "SubnetId": "subnet-1a2b3c4d" }, { "ImageId": "ami-1a2b3c4d", "InstanceType": "r3.2xlarge", "SubnetId": "subnet-1a2b3c4d" } ], "SpotPrice": "0.70", "TargetCapacity": 30 } }, "output": { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" }, "comments": { "input": { }, "output": { } }, "description": "This example creates a Spot fleet request that launches 30 instances using the diversified allocation strategy. The launch specifications differ by instance type. The Spot fleet distributes the instances across the launch specifications such that there are 10 instances of each type.", "id": "ec2-request-spot-fleet-4", "title": "To request a Spot fleet using the diversified allocation strategy" } ], "RequestSpotInstances": [ { "input": { "InstanceCount": 5, "LaunchSpecification": { "IamInstanceProfile": { "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" }, "ImageId": "ami-1a2b3c4d", "InstanceType": "m3.medium", "KeyName": "my-key-pair", "Placement": { "AvailabilityZone": "us-west-2a" }, "SecurityGroupIds": [ "sg-1a2b3c4d" ] }, "SpotPrice": "0.03", "Type": "one-time" }, "comments": { "input": { }, "output": { } }, "description": "This example creates a one-time Spot Instance request for five instances in the specified Availability Zone. If your account supports EC2-VPC only, Amazon EC2 launches the instances in the default subnet of the specified Availability Zone. If your account supports EC2-Classic, Amazon EC2 launches the instances in EC2-Classic in the specified Availability Zone.", "id": "ec2-request-spot-instances-1", "title": "To create a one-time Spot Instance request" }, { "input": { "InstanceCount": 5, "LaunchSpecification": { "IamInstanceProfile": { "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" }, "ImageId": "ami-1a2b3c4d", "InstanceType": "m3.medium", "SecurityGroupIds": [ "sg-1a2b3c4d" ], "SubnetId": "subnet-1a2b3c4d" }, "SpotPrice": "0.050", "Type": "one-time" }, "comments": { "input": { }, "output": { } }, "description": "This example command creates a one-time Spot Instance request for five instances in the specified subnet. Amazon EC2 launches the instances in the specified subnet. If the VPC is a nondefault VPC, the instances do not receive a public IP address by default.", "id": "ec2-request-spot-instances-2", "title": "To create a one-time Spot Instance request" } ], "ResetSnapshotAttribute": [ { "input": { "Attribute": "createVolumePermission", "SnapshotId": "snap-1234567890abcdef0" }, "output": { }, "comments": { "input": { }, "output": { } }, "description": "This example resets the create volume permissions for snapshot ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.", "id": "to-reset-a-snapshot-attribute-1472508825735", "title": "To reset a snapshot attribute" } ], "RestoreAddressToClassic": [ { "input": { "PublicIp": "198.51.100.0" }, "output": { "PublicIp": "198.51.100.0", "Status": "MoveInProgress" }, "comments": { "input": { }, "output": { } }, "description": "This example restores the specified Elastic IP address to the EC2-Classic platform.", "id": "ec2-restore-address-to-classic-1", "title": "To restore an address to EC2-Classic" } ], "RunScheduledInstances": [ { "input": { "InstanceCount": 1, "LaunchSpecification": { "IamInstanceProfile": { "Name": "my-iam-role" }, "ImageId": "ami-12345678", "InstanceType": "c4.large", "KeyName": "my-key-pair", "NetworkInterfaces": [ { "AssociatePublicIpAddress": true, "DeviceIndex": 0, "Groups": [ "sg-12345678" ], "SubnetId": "subnet-12345678" } ] }, "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012" }, "output": { "InstanceIdSet": [ "i-1234567890abcdef0" ] }, "comments": { "input": { }, "output": { } }, "description": "This example launches the specified Scheduled Instance in a VPC.", "id": "ec2-run-scheduled-instances-1", "title": "To launch a Scheduled Instance in a VPC" }, { "input": { "InstanceCount": 1, "LaunchSpecification": { "IamInstanceProfile": { "Name": "my-iam-role" }, "ImageId": "ami-12345678", "InstanceType": "c4.large", "KeyName": "my-key-pair", "Placement": { "AvailabilityZone": "us-west-2b" }, "SecurityGroupIds": [ "sg-12345678" ] }, "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012" }, "output": { "InstanceIdSet": [ "i-1234567890abcdef0" ] }, "comments": { "input": { }, "output": { } }, "description": "This example launches the specified Scheduled Instance in EC2-Classic.", "id": "ec2-run-scheduled-instances-2", "title": "To launch a Scheduled Instance in EC2-Classic" } ], "UnassignPrivateIpAddresses": [ { "input": { "NetworkInterfaceId": "eni-e5aa89a3", "PrivateIpAddresses": [ "10.0.0.82" ] }, "comments": { "input": { }, "output": { } }, "description": "This example unassigns the specified private IP address from the specified network interface.", "id": "ec2-unassign-private-ip-addresses-1", "title": "To unassign a secondary private IP address from a network interface" } ] } } botocore-1.5.7/botocore/data/ec2/2016-09-15/waiters-2.json0000777454262600001440000003415413042511306023366 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "InstanceExists": { "delay": 5, "maxAttempts": 40, "operation": "DescribeInstances", "acceptors": [ { "matcher": "path", "expected": true, "argument": "length(Reservations[]) > `0`", "state": "success" }, { "matcher": "error", "expected": "InvalidInstanceID.NotFound", "state": "retry" } ] }, "BundleTaskComplete": { "delay": 15, "operation": "DescribeBundleTasks", "maxAttempts": 40, "acceptors": [ { "expected": "complete", "matcher": "pathAll", "state": "success", "argument": "BundleTasks[].State" }, { "expected": "failed", "matcher": "pathAny", "state": "failure", "argument": "BundleTasks[].State" } ] }, "ConversionTaskCancelled": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "cancelled", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" } ] }, "ConversionTaskCompleted": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" }, { "expected": "cancelled", "matcher": "pathAny", "state": "failure", "argument": "ConversionTasks[].State" }, { "expected": "cancelling", "matcher": "pathAny", "state": "failure", "argument": "ConversionTasks[].State" } ] }, "ConversionTaskDeleted": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" } ] }, "CustomerGatewayAvailable": { "delay": 15, "operation": "DescribeCustomerGateways", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "CustomerGateways[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "CustomerGateways[].State" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "CustomerGateways[].State" } ] }, "ExportTaskCancelled": { "delay": 15, "operation": "DescribeExportTasks", "maxAttempts": 40, "acceptors": [ { "expected": "cancelled", "matcher": "pathAll", "state": "success", "argument": "ExportTasks[].State" } ] }, "ExportTaskCompleted": { "delay": 15, "operation": "DescribeExportTasks", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "ExportTasks[].State" } ] }, "ImageExists": { "operation": "DescribeImages", "maxAttempts": 40, "delay": 15, "acceptors": [ { "matcher": "path", "expected": true, "argument": "length(Images[]) > `0`", "state": "success" }, { "matcher": "error", "expected": "InvalidAMIID.NotFound", "state": "retry" } ] }, "ImageAvailable": { "operation": "DescribeImages", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "Images[].State", "expected": "available" }, { "state": "failure", "matcher": "pathAny", "argument": "Images[].State", "expected": "failed" } ] }, "InstanceRunning": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "running", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "shutting-down", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "matcher": "error", "expected": "InvalidInstanceID.NotFound", "state": "retry" } ] }, "InstanceStatusOk": { "operation": "DescribeInstanceStatus", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "InstanceStatuses[].InstanceStatus.Status", "expected": "ok" }, { "matcher": "error", "expected": "InvalidInstanceID.NotFound", "state": "retry" } ] }, "InstanceStopped": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "stopped", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "InstanceTerminated": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "terminated", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "NatGatewayAvailable": { "operation": "DescribeNatGateways", "delay": 15, "maxAttempts": 40, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "NatGateways[].State", "expected": "available" }, { "state": "failure", "matcher": "pathAny", "argument": "NatGateways[].State", "expected": "failed" }, { "state": "failure", "matcher": "pathAny", "argument": "NatGateways[].State", "expected": "deleting" }, { "state": "failure", "matcher": "pathAny", "argument": "NatGateways[].State", "expected": "deleted" }, { "state": "retry", "matcher": "error", "expected": "NatGatewayNotFound" } ] }, "NetworkInterfaceAvailable": { "operation": "DescribeNetworkInterfaces", "delay": 20, "maxAttempts": 10, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "NetworkInterfaces[].Status" }, { "expected": "InvalidNetworkInterfaceID.NotFound", "matcher": "error", "state": "failure" } ] }, "PasswordDataAvailable": { "operation": "GetPasswordData", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "path", "argument": "length(PasswordData) > `0`", "expected": true } ] }, "SnapshotCompleted": { "delay": 15, "operation": "DescribeSnapshots", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "Snapshots[].State" } ] }, "SpotInstanceRequestFulfilled": { "operation": "DescribeSpotInstanceRequests", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "SpotInstanceRequests[].Status.Code", "expected": "fulfilled" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "schedule-expired" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "canceled-before-fulfillment" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "bad-parameters" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "system-error" } ] }, "SubnetAvailable": { "delay": 15, "operation": "DescribeSubnets", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Subnets[].State" } ] }, "SystemStatusOk": { "operation": "DescribeInstanceStatus", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "InstanceStatuses[].SystemStatus.Status", "expected": "ok" } ] }, "VolumeAvailable": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Volumes[].State" } ] }, "VolumeDeleted": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "matcher": "error", "expected": "InvalidVolume.NotFound", "state": "success" } ] }, "VolumeInUse": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "in-use", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Volumes[].State" } ] }, "VpcAvailable": { "delay": 15, "operation": "DescribeVpcs", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Vpcs[].State" } ] }, "VpcExists": { "operation": "DescribeVpcs", "delay": 1, "maxAttempts": 5, "acceptors": [ { "matcher": "status", "expected": 200, "state": "success" }, { "matcher": "error", "expected": "InvalidVpcID.NotFound", "state": "retry" } ] }, "VpnConnectionAvailable": { "delay": 15, "operation": "DescribeVpnConnections", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "VpnConnections[].State" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" } ] }, "VpnConnectionDeleted": { "delay": 15, "operation": "DescribeVpnConnections", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "VpnConnections[].State" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" } ] }, "VpcPeeringConnectionExists": { "delay": 15, "operation": "DescribeVpcPeeringConnections", "maxAttempts": 40, "acceptors": [ { "matcher": "status", "expected": 200, "state": "success" }, { "matcher": "error", "expected": "InvalidVpcPeeringConnectionID.NotFound", "state": "retry" } ] } } } botocore-1.5.7/botocore/data/ec2/2016-09-15/paginators-1.json0000777454262600001440000000340113042511306024045 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeInstanceStatus": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "InstanceStatuses" }, "DescribeInstances": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Reservations" }, "DescribeReservedInstancesOfferings": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "ReservedInstancesOfferings" }, "DescribeReservedInstancesModifications": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "ReservedInstancesModifications" }, "DescribeSnapshots": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Snapshots" }, "DescribeSpotFleetRequests": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "SpotFleetRequestConfigs" }, "DescribeSpotPriceHistory": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "SpotPriceHistory" }, "DescribeTags": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Tags" }, "DescribeVolumeStatus": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "VolumeStatuses" }, "DescribeVolumes": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Volumes" } } } botocore-1.5.7/botocore/data/ec2/2016-09-15/service-2.json0000777454262600001440000331457113042511306023357 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-09-15", "endpointPrefix":"ec2", "protocol":"ec2", "serviceAbbreviation":"Amazon EC2", "serviceFullName":"Amazon Elastic Compute Cloud", "signatureVersion":"v4", "xmlNamespace":"http://ec2.amazonaws.com/doc/2016-09-15" }, "operations":{ "AcceptReservedInstancesExchangeQuote":{ "name":"AcceptReservedInstancesExchangeQuote", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AcceptReservedInstancesExchangeQuoteRequest"}, "output":{"shape":"AcceptReservedInstancesExchangeQuoteResult"}, "documentation":"

Purchases Convertible Reserved Instance offerings described in the GetReservedInstancesExchangeQuote call.

" }, "AcceptVpcPeeringConnection":{ "name":"AcceptVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, "output":{"shape":"AcceptVpcPeeringConnectionResult"}, "documentation":"

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.

" }, "AllocateAddress":{ "name":"AllocateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AllocateAddressRequest"}, "output":{"shape":"AllocateAddressResult"}, "documentation":"

Acquires an Elastic IP address.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" }, "AllocateHosts":{ "name":"AllocateHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AllocateHostsRequest"}, "output":{"shape":"AllocateHostsResult"}, "documentation":"

Allocates a Dedicated Host to your account. At minimum you need to specify the instance size type, Availability Zone, and quantity of hosts you want to allocate.

" }, "AssignPrivateIpAddresses":{ "name":"AssignPrivateIpAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssignPrivateIpAddressesRequest"}, "documentation":"

Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

AssignPrivateIpAddresses is available only in EC2-VPC.

" }, "AssociateAddress":{ "name":"AssociateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateAddressRequest"}, "output":{"shape":"AssociateAddressResult"}, "documentation":"

Associates an Elastic IP address with an instance or a network interface.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.

" }, "AssociateDhcpOptions":{ "name":"AssociateDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateDhcpOptionsRequest"}, "documentation":"

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "AssociateRouteTable":{ "name":"AssociateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateRouteTableRequest"}, "output":{"shape":"AssociateRouteTableResult"}, "documentation":"

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "AttachClassicLinkVpc":{ "name":"AttachClassicLinkVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachClassicLinkVpcRequest"}, "output":{"shape":"AttachClassicLinkVpcResult"}, "documentation":"

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" }, "AttachInternetGateway":{ "name":"AttachInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachInternetGatewayRequest"}, "documentation":"

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" }, "AttachNetworkInterface":{ "name":"AttachNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachNetworkInterfaceRequest"}, "output":{"shape":"AttachNetworkInterfaceResult"}, "documentation":"

Attaches a network interface to an instance.

" }, "AttachVolume":{ "name":"AttachVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachVolumeRequest"}, "output":{"shape":"VolumeAttachment"}, "documentation":"

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For a list of supported device names, see Attaching an EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.

  • AWS Marketplace product codes are copied from the volume to the instance.

  • You must be subscribed to the product.

  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For an overview of the AWS Marketplace, see Introducing AWS Marketplace.

For more information about EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "AttachVpnGateway":{ "name":"AttachVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachVpnGatewayRequest"}, "output":{"shape":"AttachVpnGatewayResult"}, "documentation":"

Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "AuthorizeSecurityGroupEgress":{ "name":"AuthorizeSecurityGroupEgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, "documentation":"

[EC2-VPC only] Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

You can have up to 50 rules per security group (covering both ingress and egress rules).

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

" }, "AuthorizeSecurityGroupIngress":{ "name":"AuthorizeSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, "documentation":"

Adds one or more ingress rules to a security group.

EC2-Classic: You can have up to 100 rules per group.

EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.

[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.

" }, "BundleInstance":{ "name":"BundleInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BundleInstanceRequest"}, "output":{"shape":"BundleInstanceResult"}, "documentation":"

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

For more information, see Creating an Instance Store-Backed Windows AMI.

" }, "CancelBundleTask":{ "name":"CancelBundleTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelBundleTaskRequest"}, "output":{"shape":"CancelBundleTaskResult"}, "documentation":"

Cancels a bundling operation for an instance store-backed Windows instance.

" }, "CancelConversionTask":{ "name":"CancelConversionTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelConversionRequest"}, "documentation":"

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

" }, "CancelExportTask":{ "name":"CancelExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelExportTaskRequest"}, "documentation":"

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" }, "CancelImportTask":{ "name":"CancelImportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelImportTaskRequest"}, "output":{"shape":"CancelImportTaskResult"}, "documentation":"

Cancels an in-process import virtual machine or import snapshot task.

" }, "CancelReservedInstancesListing":{ "name":"CancelReservedInstancesListing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelReservedInstancesListingRequest"}, "output":{"shape":"CancelReservedInstancesListingResult"}, "documentation":"

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "CancelSpotFleetRequests":{ "name":"CancelSpotFleetRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelSpotFleetRequestsRequest"}, "output":{"shape":"CancelSpotFleetRequestsResponse"}, "documentation":"

Cancels the specified Spot fleet requests.

After you cancel a Spot fleet request, the Spot fleet launches no new Spot instances. You must specify whether the Spot fleet should also terminate its Spot instances. If you terminate the instances, the Spot fleet request enters the cancelled_terminating state. Otherwise, the Spot fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.

" }, "CancelSpotInstanceRequests":{ "name":"CancelSpotInstanceRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelSpotInstanceRequestsRequest"}, "output":{"shape":"CancelSpotInstanceRequestsResult"}, "documentation":"

Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

Canceling a Spot instance request does not terminate running Spot instances associated with the request.

" }, "ConfirmProductInstance":{ "name":"ConfirmProductInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmProductInstanceRequest"}, "output":{"shape":"ConfirmProductInstanceResult"}, "documentation":"

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.

" }, "CopyImage":{ "name":"CopyImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyImageRequest"}, "output":{"shape":"CopyImageResult"}, "documentation":"

Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide.

" }, "CopySnapshot":{ "name":"CopySnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopySnapshotRequest"}, "output":{"shape":"CopySnapshotResult"}, "documentation":"

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the KmsKeyId parameter.

To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.

Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateCustomerGateway":{ "name":"CreateCustomerGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCustomerGatewayRequest"}, "output":{"shape":"CreateCustomerGatewayResult"}, "documentation":"

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.

" }, "CreateDhcpOptions":{ "name":"CreateDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDhcpOptionsRequest"}, "output":{"shape":"CreateDhcpOptionsResult"}, "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. If you want your instance to receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.

  • domain-name - If you're using AmazonProvidedDNS in \"us-east-1\", specify \"ec2.internal\". If you're using AmazonProvidedDNS in another region, specify \"region.compute.internal\" (for example, \"ap-northeast-1.compute.internal\"). Otherwise, specify a domain name (for example, \"MyCompany.com\"). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.

  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.

  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.

  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateFlowLogs":{ "name":"CreateFlowLogs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateFlowLogsRequest"}, "output":{"shape":"CreateFlowLogsResult"}, "documentation":"

Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs.

In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs.

" }, "CreateImage":{ "name":"CreateImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateImageRequest"}, "output":{"shape":"CreateImageResult"}, "documentation":"

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateInstanceExportTask":{ "name":"CreateInstanceExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInstanceExportTaskRequest"}, "output":{"shape":"CreateInstanceExportTaskResult"}, "documentation":"

Exports a running or stopped instance to an S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide.

" }, "CreateInternetGateway":{ "name":"CreateInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInternetGatewayRequest"}, "output":{"shape":"CreateInternetGatewayResult"}, "documentation":"

Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" }, "CreateKeyPair":{ "name":"CreateKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateKeyPairRequest"}, "output":{"shape":"KeyPair"}, "documentation":"

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateNatGateway":{ "name":"CreateNatGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNatGatewayRequest"}, "output":{"shape":"CreateNatGatewayResult"}, "documentation":"

Creates a NAT gateway in the specified subnet. A NAT gateway can be used to enable instances in a private subnet to connect to the Internet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkAcl":{ "name":"CreateNetworkAcl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkAclRequest"}, "output":{"shape":"CreateNetworkAclResult"}, "documentation":"

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkAclEntry":{ "name":"CreateNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkAclEntryRequest"}, "documentation":"

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkInterface":{ "name":"CreateNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkInterfaceRequest"}, "output":{"shape":"CreateNetworkInterfaceResult"}, "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide.

" }, "CreatePlacementGroup":{ "name":"CreatePlacementGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlacementGroupRequest"}, "documentation":"

Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.

For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateReservedInstancesListing":{ "name":"CreateReservedInstancesListing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateReservedInstancesListingRequest"}, "output":{"shape":"CreateReservedInstancesListingResult"}, "documentation":"

Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.

The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateRoute":{ "name":"CreateRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRouteRequest"}, "output":{"shape":"CreateRouteResult"}, "documentation":"

Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, or network interface.

When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "CreateRouteTable":{ "name":"CreateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRouteTableRequest"}, "output":{"shape":"CreateRouteTableResult"}, "documentation":"

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "CreateSecurityGroup":{ "name":"CreateSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSecurityGroupRequest"}, "output":{"shape":"CreateSecurityGroupResult"}, "documentation":"

Creates a security group.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

EC2-Classic: You can have up to 500 security groups.

EC2-VPC: You can create up to 500 security groups per VPC.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

" }, "CreateSnapshot":{ "name":"CreateSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSnapshotRequest"}, "output":{"shape":"Snapshot"}, "documentation":"

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateSpotDatafeedSubscription":{ "name":"CreateSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, "documentation":"

Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateSubnet":{ "name":"CreateSubnet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSubnetRequest"}, "output":{"shape":"CreateSubnetResult"}, "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).

AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateTags":{ "name":"CreateTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTagsRequest"}, "documentation":"

Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateVolume":{ "name":"CreateVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVolumeRequest"}, "output":{"shape":"Volume"}, "documentation":"

Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateVpc":{ "name":"CreateVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcRequest"}, "output":{"shape":"CreateVpcResult"}, "documentation":"

Creates a VPC with the specified CIDR block.

The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpcEndpoint":{ "name":"CreateVpcEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcEndpointRequest"}, "output":{"shape":"CreateVpcEndpointResult"}, "documentation":"

Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.

Currently, only endpoints to Amazon S3 are supported.

" }, "CreateVpcPeeringConnection":{ "name":"CreateVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcPeeringConnectionRequest"}, "output":{"shape":"CreateVpcPeeringConnectionResult"}, "documentation":"

Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.

The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.

" }, "CreateVpnConnection":{ "name":"CreateVpnConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnConnectionRequest"}, "output":{"shape":"CreateVpnConnectionResult"}, "documentation":"

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpnConnectionRoute":{ "name":"CreateVpnConnectionRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnConnectionRouteRequest"}, "documentation":"

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpnGateway":{ "name":"CreateVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnGatewayRequest"}, "output":{"shape":"CreateVpnGatewayResult"}, "documentation":"

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DeleteCustomerGateway":{ "name":"DeleteCustomerGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCustomerGatewayRequest"}, "documentation":"

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" }, "DeleteDhcpOptions":{ "name":"DeleteDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDhcpOptionsRequest"}, "documentation":"

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" }, "DeleteFlowLogs":{ "name":"DeleteFlowLogs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteFlowLogsRequest"}, "output":{"shape":"DeleteFlowLogsResult"}, "documentation":"

Deletes one or more flow logs.

" }, "DeleteInternetGateway":{ "name":"DeleteInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteInternetGatewayRequest"}, "documentation":"

Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.

" }, "DeleteKeyPair":{ "name":"DeleteKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteKeyPairRequest"}, "documentation":"

Deletes the specified key pair, by removing the public key from Amazon EC2.

" }, "DeleteNatGateway":{ "name":"DeleteNatGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNatGatewayRequest"}, "output":{"shape":"DeleteNatGatewayResult"}, "documentation":"

Deletes the specified NAT gateway. Deleting a NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.

" }, "DeleteNetworkAcl":{ "name":"DeleteNetworkAcl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkAclRequest"}, "documentation":"

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" }, "DeleteNetworkAclEntry":{ "name":"DeleteNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkAclEntryRequest"}, "documentation":"

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" }, "DeleteNetworkInterface":{ "name":"DeleteNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkInterfaceRequest"}, "documentation":"

Deletes the specified network interface. You must detach the network interface before you can delete it.

" }, "DeletePlacementGroup":{ "name":"DeletePlacementGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePlacementGroupRequest"}, "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteRoute":{ "name":"DeleteRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRouteRequest"}, "documentation":"

Deletes the specified route from the specified route table.

" }, "DeleteRouteTable":{ "name":"DeleteRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRouteTableRequest"}, "documentation":"

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" }, "DeleteSecurityGroup":{ "name":"DeleteSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSecurityGroupRequest"}, "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" }, "DeleteSnapshot":{ "name":"DeleteSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSnapshotRequest"}, "documentation":"

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteSpotDatafeedSubscription":{ "name":"DeleteSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSpotDatafeedSubscriptionRequest"}, "documentation":"

Deletes the data feed for Spot instances.

" }, "DeleteSubnet":{ "name":"DeleteSubnet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSubnetRequest"}, "documentation":"

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsRequest"}, "documentation":"

Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteVolume":{ "name":"DeleteVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVolumeRequest"}, "documentation":"

Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).

The volume may remain in the deleting state for several minutes.

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteVpc":{ "name":"DeleteVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcRequest"}, "documentation":"

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" }, "DeleteVpcEndpoints":{ "name":"DeleteVpcEndpoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcEndpointsRequest"}, "output":{"shape":"DeleteVpcEndpointsResult"}, "documentation":"

Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint.

" }, "DeleteVpcPeeringConnection":{ "name":"DeleteVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, "output":{"shape":"DeleteVpcPeeringConnectionResult"}, "documentation":"

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.

" }, "DeleteVpnConnection":{ "name":"DeleteVpnConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnConnectionRequest"}, "documentation":"

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" }, "DeleteVpnConnectionRoute":{ "name":"DeleteVpnConnectionRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnConnectionRouteRequest"}, "documentation":"

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" }, "DeleteVpnGateway":{ "name":"DeleteVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnGatewayRequest"}, "documentation":"

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" }, "DeregisterImage":{ "name":"DeregisterImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterImageRequest"}, "documentation":"

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

This command does not delete the AMI.

" }, "DescribeAccountAttributes":{ "name":"DescribeAccountAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAccountAttributesRequest"}, "output":{"shape":"DescribeAccountAttributesResult"}, "documentation":"

Describes attributes of your AWS account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: The maximum number of On-Demand instances that you can run.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

" }, "DescribeAddresses":{ "name":"DescribeAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAddressesRequest"}, "output":{"shape":"DescribeAddressesResult"}, "documentation":"

Describes one or more of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeAvailabilityZones":{ "name":"DescribeAvailabilityZones", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAvailabilityZonesRequest"}, "output":{"shape":"DescribeAvailabilityZonesResult"}, "documentation":"

Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeBundleTasks":{ "name":"DescribeBundleTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeBundleTasksRequest"}, "output":{"shape":"DescribeBundleTasksResult"}, "documentation":"

Describes one or more of your bundling tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

" }, "DescribeClassicLinkInstances":{ "name":"DescribeClassicLinkInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClassicLinkInstancesRequest"}, "output":{"shape":"DescribeClassicLinkInstancesResult"}, "documentation":"

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.

" }, "DescribeConversionTasks":{ "name":"DescribeConversionTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConversionTasksRequest"}, "output":{"shape":"DescribeConversionTasksResult"}, "documentation":"

Describes one or more of your conversion tasks. For more information, see the VM Import/Export User Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" }, "DescribeCustomerGateways":{ "name":"DescribeCustomerGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCustomerGatewaysRequest"}, "output":{"shape":"DescribeCustomerGatewaysResult"}, "documentation":"

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeDhcpOptions":{ "name":"DescribeDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDhcpOptionsRequest"}, "output":{"shape":"DescribeDhcpOptionsResult"}, "documentation":"

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeExportTasks":{ "name":"DescribeExportTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeExportTasksRequest"}, "output":{"shape":"DescribeExportTasksResult"}, "documentation":"

Describes one or more of your export tasks.

" }, "DescribeFlowLogs":{ "name":"DescribeFlowLogs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFlowLogsRequest"}, "output":{"shape":"DescribeFlowLogsResult"}, "documentation":"

Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.

" }, "DescribeHostReservationOfferings":{ "name":"DescribeHostReservationOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHostReservationOfferingsRequest"}, "output":{"shape":"DescribeHostReservationOfferingsResult"}, "documentation":"

Describes the Dedicated Host Reservations that are available to purchase.

The results describe all the Dedicated Host Reservation offerings, including offerings that may not match the instance family and region of your Dedicated Hosts. When purchasing an offering, ensure that the the instance family and region of the offering matches that of the Dedicated Host/s it will be associated with. For an overview of supported instance types, see Dedicated Hosts Overview in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeHostReservations":{ "name":"DescribeHostReservations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHostReservationsRequest"}, "output":{"shape":"DescribeHostReservationsResult"}, "documentation":"

Describes Dedicated Host Reservations which are associated with Dedicated Hosts in your account.

" }, "DescribeHosts":{ "name":"DescribeHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHostsRequest"}, "output":{"shape":"DescribeHostsResult"}, "documentation":"

Describes one or more of your Dedicated Hosts.

The results describe only the Dedicated Hosts in the region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released will be listed with the state released.

" }, "DescribeIdFormat":{ "name":"DescribeIdFormat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeIdFormatRequest"}, "output":{"shape":"DescribeIdFormatResult"}, "documentation":"

Describes the ID format settings for your resources on a per-region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.

The following resource types support longer IDs: instance | reservation | snapshot | volume.

These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" }, "DescribeIdentityIdFormat":{ "name":"DescribeIdentityIdFormat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeIdentityIdFormatRequest"}, "output":{"shape":"DescribeIdentityIdFormatResult"}, "documentation":"

Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

The following resource types support longer IDs: instance | reservation | snapshot | volume.

These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.

" }, "DescribeImageAttribute":{ "name":"DescribeImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImageAttributeRequest"}, "output":{"shape":"ImageAttribute"}, "documentation":"

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" }, "DescribeImages":{ "name":"DescribeImages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImagesRequest"}, "output":{"shape":"DescribeImagesResult"}, "documentation":"

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

Deregistered images are included in the returned results for an unspecified interval after deregistration.

" }, "DescribeImportImageTasks":{ "name":"DescribeImportImageTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImportImageTasksRequest"}, "output":{"shape":"DescribeImportImageTasksResult"}, "documentation":"

Displays details about an import virtual machine or import snapshot tasks that are already created.

" }, "DescribeImportSnapshotTasks":{ "name":"DescribeImportSnapshotTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImportSnapshotTasksRequest"}, "output":{"shape":"DescribeImportSnapshotTasksResult"}, "documentation":"

Describes your import snapshot tasks.

" }, "DescribeInstanceAttribute":{ "name":"DescribeInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceAttributeRequest"}, "output":{"shape":"InstanceAttribute"}, "documentation":"

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" }, "DescribeInstanceStatus":{ "name":"DescribeInstanceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceStatusRequest"}, "output":{"shape":"DescribeInstanceStatusResult"}, "documentation":"

Describes the status of one or more instances. By default, only running instances are described, unless specified otherwise.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeInstances":{ "name":"DescribeInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancesRequest"}, "output":{"shape":"DescribeInstancesResult"}, "documentation":"

Describes one or more of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.

" }, "DescribeInternetGateways":{ "name":"DescribeInternetGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInternetGatewaysRequest"}, "output":{"shape":"DescribeInternetGatewaysResult"}, "documentation":"

Describes one or more of your Internet gateways.

" }, "DescribeKeyPairs":{ "name":"DescribeKeyPairs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeKeyPairsRequest"}, "output":{"shape":"DescribeKeyPairsResult"}, "documentation":"

Describes one or more of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeMovingAddresses":{ "name":"DescribeMovingAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMovingAddressesRequest"}, "output":{"shape":"DescribeMovingAddressesResult"}, "documentation":"

Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

" }, "DescribeNatGateways":{ "name":"DescribeNatGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNatGatewaysRequest"}, "output":{"shape":"DescribeNatGatewaysResult"}, "documentation":"

Describes one or more of the your NAT gateways.

" }, "DescribeNetworkAcls":{ "name":"DescribeNetworkAcls", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkAclsRequest"}, "output":{"shape":"DescribeNetworkAclsResult"}, "documentation":"

Describes one or more of your network ACLs.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeNetworkInterfaceAttribute":{ "name":"DescribeNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, "documentation":"

Describes a network interface attribute. You can specify only one attribute at a time.

" }, "DescribeNetworkInterfaces":{ "name":"DescribeNetworkInterfaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkInterfacesRequest"}, "output":{"shape":"DescribeNetworkInterfacesResult"}, "documentation":"

Describes one or more of your network interfaces.

" }, "DescribePlacementGroups":{ "name":"DescribePlacementGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePlacementGroupsRequest"}, "output":{"shape":"DescribePlacementGroupsResult"}, "documentation":"

Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribePrefixLists":{ "name":"DescribePrefixLists", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePrefixListsRequest"}, "output":{"shape":"DescribePrefixListsResult"}, "documentation":"

Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a VPC endpoint.

" }, "DescribeRegions":{ "name":"DescribeRegions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRegionsRequest"}, "output":{"shape":"DescribeRegionsResult"}, "documentation":"

Describes one or more regions that are currently available to you.

For a list of the regions supported by Amazon EC2, see Regions and Endpoints.

" }, "DescribeReservedInstances":{ "name":"DescribeReservedInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesRequest"}, "output":{"shape":"DescribeReservedInstancesResult"}, "documentation":"

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesListings":{ "name":"DescribeReservedInstancesListings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesListingsRequest"}, "output":{"shape":"DescribeReservedInstancesListingsResult"}, "documentation":"

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesModifications":{ "name":"DescribeReservedInstancesModifications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, "output":{"shape":"DescribeReservedInstancesModificationsResult"}, "documentation":"

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesOfferings":{ "name":"DescribeReservedInstancesOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, "documentation":"

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeRouteTables":{ "name":"DescribeRouteTables", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRouteTablesRequest"}, "output":{"shape":"DescribeRouteTablesResult"}, "documentation":"

Describes one or more of your route tables.

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeScheduledInstanceAvailability":{ "name":"DescribeScheduledInstanceAvailability", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeScheduledInstanceAvailabilityRequest"}, "output":{"shape":"DescribeScheduledInstanceAvailabilityResult"}, "documentation":"

Finds available schedules that meet the specified criteria.

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.

" }, "DescribeScheduledInstances":{ "name":"DescribeScheduledInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeScheduledInstancesRequest"}, "output":{"shape":"DescribeScheduledInstancesResult"}, "documentation":"

Describes one or more of your Scheduled Instances.

" }, "DescribeSecurityGroupReferences":{ "name":"DescribeSecurityGroupReferences", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSecurityGroupReferencesRequest"}, "output":{"shape":"DescribeSecurityGroupReferencesResult"}, "documentation":"

[EC2-VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.

" }, "DescribeSecurityGroups":{ "name":"DescribeSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSecurityGroupsRequest"}, "output":{"shape":"DescribeSecurityGroupsResult"}, "documentation":"

Describes one or more of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeSnapshotAttribute":{ "name":"DescribeSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotAttributeRequest"}, "output":{"shape":"DescribeSnapshotAttributeResult"}, "documentation":"

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSnapshots":{ "name":"DescribeSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotsRequest"}, "output":{"shape":"DescribeSnapshotsResult"}, "documentation":"

Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.

  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.

  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSpotDatafeedSubscription":{ "name":"DescribeSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, "documentation":"

Describes the data feed for Spot instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSpotFleetInstances":{ "name":"DescribeSpotFleetInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotFleetInstancesRequest"}, "output":{"shape":"DescribeSpotFleetInstancesResponse"}, "documentation":"

Describes the running instances for the specified Spot fleet.

" }, "DescribeSpotFleetRequestHistory":{ "name":"DescribeSpotFleetRequestHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotFleetRequestHistoryRequest"}, "output":{"shape":"DescribeSpotFleetRequestHistoryResponse"}, "documentation":"

Describes the events for the specified Spot fleet request during the specified time.

Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event.

" }, "DescribeSpotFleetRequests":{ "name":"DescribeSpotFleetRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotFleetRequestsRequest"}, "output":{"shape":"DescribeSpotFleetRequestsResponse"}, "documentation":"

Describes your Spot fleet requests.

Spot fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

" }, "DescribeSpotInstanceRequests":{ "name":"DescribeSpotInstanceRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, "output":{"shape":"DescribeSpotInstanceRequestsResult"}, "documentation":"

Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

You can use DescribeSpotInstanceRequests to find a running Spot instance by examining the response. If the status of the Spot instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

Spot instance requests are deleted 4 hours after they are canceled and their instances are terminated.

" }, "DescribeSpotPriceHistory":{ "name":"DescribeSpotPriceHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotPriceHistoryRequest"}, "output":{"shape":"DescribeSpotPriceHistoryResult"}, "documentation":"

Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see Spot Instance Pricing History in the Amazon Elastic Compute Cloud User Guide.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" }, "DescribeStaleSecurityGroups":{ "name":"DescribeStaleSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStaleSecurityGroupsRequest"}, "output":{"shape":"DescribeStaleSecurityGroupsResult"}, "documentation":"

[EC2-VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.

" }, "DescribeSubnets":{ "name":"DescribeSubnets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSubnetsRequest"}, "output":{"shape":"DescribeSubnetsResult"}, "documentation":"

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsRequest"}, "output":{"shape":"DescribeTagsResult"}, "documentation":"

Describes one or more of the tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVolumeAttribute":{ "name":"DescribeVolumeAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumeAttributeRequest"}, "output":{"shape":"DescribeVolumeAttributeResult"}, "documentation":"

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVolumeStatus":{ "name":"DescribeVolumeStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumeStatusRequest"}, "output":{"shape":"DescribeVolumeStatusResult"}, "documentation":"

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

" }, "DescribeVolumes":{ "name":"DescribeVolumes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumesRequest"}, "output":{"shape":"DescribeVolumesResult"}, "documentation":"

Describes the specified EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVpcAttribute":{ "name":"DescribeVpcAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcAttributeRequest"}, "output":{"shape":"DescribeVpcAttributeResult"}, "documentation":"

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" }, "DescribeVpcClassicLink":{ "name":"DescribeVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcClassicLinkRequest"}, "output":{"shape":"DescribeVpcClassicLinkResult"}, "documentation":"

Describes the ClassicLink status of one or more VPCs.

" }, "DescribeVpcClassicLinkDnsSupport":{ "name":"DescribeVpcClassicLinkDnsSupport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcClassicLinkDnsSupportRequest"}, "output":{"shape":"DescribeVpcClassicLinkDnsSupportResult"}, "documentation":"

Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVpcEndpointServices":{ "name":"DescribeVpcEndpointServices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcEndpointServicesRequest"}, "output":{"shape":"DescribeVpcEndpointServicesResult"}, "documentation":"

Describes all supported AWS services that can be specified when creating a VPC endpoint.

" }, "DescribeVpcEndpoints":{ "name":"DescribeVpcEndpoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcEndpointsRequest"}, "output":{"shape":"DescribeVpcEndpointsResult"}, "documentation":"

Describes one or more of your VPC endpoints.

" }, "DescribeVpcPeeringConnections":{ "name":"DescribeVpcPeeringConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, "documentation":"

Describes one or more of your VPC peering connections.

" }, "DescribeVpcs":{ "name":"DescribeVpcs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcsRequest"}, "output":{"shape":"DescribeVpcsResult"}, "documentation":"

Describes one or more of your VPCs.

" }, "DescribeVpnConnections":{ "name":"DescribeVpnConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpnConnectionsRequest"}, "output":{"shape":"DescribeVpnConnectionsResult"}, "documentation":"

Describes one or more of your VPN connections.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeVpnGateways":{ "name":"DescribeVpnGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpnGatewaysRequest"}, "output":{"shape":"DescribeVpnGatewaysResult"}, "documentation":"

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DetachClassicLinkVpc":{ "name":"DetachClassicLinkVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachClassicLinkVpcRequest"}, "output":{"shape":"DetachClassicLinkVpcResult"}, "documentation":"

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" }, "DetachInternetGateway":{ "name":"DetachInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachInternetGatewayRequest"}, "documentation":"

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.

" }, "DetachNetworkInterface":{ "name":"DetachNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachNetworkInterfaceRequest"}, "documentation":"

Detaches a network interface from an instance.

" }, "DetachVolume":{ "name":"DetachVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachVolumeRequest"}, "output":{"shape":"VolumeAttachment"}, "documentation":"

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "DetachVpnGateway":{ "name":"DetachVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachVpnGatewayRequest"}, "documentation":"

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" }, "DisableVgwRoutePropagation":{ "name":"DisableVgwRoutePropagation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVgwRoutePropagationRequest"}, "documentation":"

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" }, "DisableVpcClassicLink":{ "name":"DisableVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVpcClassicLinkRequest"}, "output":{"shape":"DisableVpcClassicLinkResult"}, "documentation":"

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

" }, "DisableVpcClassicLinkDnsSupport":{ "name":"DisableVpcClassicLinkDnsSupport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVpcClassicLinkDnsSupportRequest"}, "output":{"shape":"DisableVpcClassicLinkDnsSupportResult"}, "documentation":"

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "DisassociateAddress":{ "name":"DisassociateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateAddressRequest"}, "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" }, "DisassociateRouteTable":{ "name":"DisassociateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateRouteTableRequest"}, "documentation":"

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "EnableVgwRoutePropagation":{ "name":"EnableVgwRoutePropagation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVgwRoutePropagationRequest"}, "documentation":"

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" }, "EnableVolumeIO":{ "name":"EnableVolumeIO", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVolumeIORequest"}, "documentation":"

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" }, "EnableVpcClassicLink":{ "name":"EnableVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVpcClassicLinkRequest"}, "output":{"shape":"EnableVpcClassicLinkResult"}, "documentation":"

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "EnableVpcClassicLinkDnsSupport":{ "name":"EnableVpcClassicLinkDnsSupport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVpcClassicLinkDnsSupportRequest"}, "output":{"shape":"EnableVpcClassicLinkDnsSupportResult"}, "documentation":"

Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "GetConsoleOutput":{ "name":"GetConsoleOutput", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetConsoleOutputRequest"}, "output":{"shape":"GetConsoleOutputResult"}, "documentation":"

Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.

For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output includes output from the EC2Config service.

" }, "GetConsoleScreenshot":{ "name":"GetConsoleScreenshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetConsoleScreenshotRequest"}, "output":{"shape":"GetConsoleScreenshotResult"}, "documentation":"

Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.

The returned content is Base64-encoded.

" }, "GetHostReservationPurchasePreview":{ "name":"GetHostReservationPurchasePreview", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetHostReservationPurchasePreviewRequest"}, "output":{"shape":"GetHostReservationPurchasePreviewResult"}, "documentation":"

Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.

This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.

" }, "GetPasswordData":{ "name":"GetPasswordData", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPasswordDataRequest"}, "output":{"shape":"GetPasswordDataResult"}, "documentation":"

Retrieves the encrypted administrator password for an instance running Windows.

The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" }, "GetReservedInstancesExchangeQuote":{ "name":"GetReservedInstancesExchangeQuote", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetReservedInstancesExchangeQuoteRequest"}, "output":{"shape":"GetReservedInstancesExchangeQuoteResult"}, "documentation":"

Returns details about the values and term of your specified Convertible Reserved Instances. When an offering ID is specified it returns information about whether the exchange is valid and can be performed.

" }, "ImportImage":{ "name":"ImportImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportImageRequest"}, "output":{"shape":"ImportImageResult"}, "documentation":"

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). For more information, see Importing a VM as an Image Using VM Import/Export in the VM Import/Export User Guide.

" }, "ImportInstance":{ "name":"ImportInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportInstanceRequest"}, "output":{"shape":"ImportInstanceResult"}, "documentation":"

Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" }, "ImportKeyPair":{ "name":"ImportKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportKeyPairRequest"}, "output":{"shape":"ImportKeyPairResult"}, "documentation":"

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "ImportSnapshot":{ "name":"ImportSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportSnapshotRequest"}, "output":{"shape":"ImportSnapshotResult"}, "documentation":"

Imports a disk into an EBS snapshot.

" }, "ImportVolume":{ "name":"ImportVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportVolumeRequest"}, "output":{"shape":"ImportVolumeResult"}, "documentation":"

Creates an import volume task using metadata from the specified disk image.For more information, see Importing Disks to Amazon EBS.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" }, "ModifyHosts":{ "name":"ModifyHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyHostsRequest"}, "output":{"shape":"ModifyHostsResult"}, "documentation":"

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, AWS will place instances that you launch with a tenancy of host, but without targeting a specific host ID, onto any available Dedicated Host in your account which has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID if you want the instance to launch onto a specific host. If no host ID is provided, the instance will be launched onto a suitable host which has auto-placement enabled.

" }, "ModifyIdFormat":{ "name":"ModifyIdFormat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyIdFormatRequest"}, "documentation":"

Modifies the ID format for the specified resource on a per-region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created. The following resource types support longer IDs: instance | reservation | snapshot | volume.

This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" }, "ModifyIdentityIdFormat":{ "name":"ModifyIdentityIdFormat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyIdentityIdFormatRequest"}, "documentation":"

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.

The following resource types support longer IDs: instance | reservation | snapshot | volume. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" }, "ModifyImageAttribute":{ "name":"ModifyImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyImageAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

The SriovNetSupport enhanced networking attribute cannot be changed using this command. Instead, enable SriovNetSupport on an instance and create an AMI from the instance. This will result in an image with SriovNetSupport enabled.

" }, "ModifyInstanceAttribute":{ "name":"ModifyInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyInstanceAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifyInstancePlacement":{ "name":"ModifyInstancePlacement", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyInstancePlacementRequest"}, "output":{"shape":"ModifyInstancePlacementResult"}, "documentation":"

Set the instance affinity value for a specific stopped instance and modify the instance tenancy setting.

Instance affinity is disabled by default. When instance affinity is host and it is not associated with a specific Dedicated Host, the next time it is launched it will automatically be associated with the host it lands on. This relationship will persist if the instance is stopped/started, or rebooted.

You can modify the host ID associated with a stopped instance. If a stopped instance has a new host ID association, the instance will target that host when restarted.

You can modify the tenancy of a stopped instance with a tenancy of host or dedicated.

Affinity, hostID, and tenancy are not required parameters, but at least one of them must be specified in the request. Affinity and tenancy can be modified in the same request, but tenancy can only be modified on instances that are stopped.

" }, "ModifyNetworkInterfaceAttribute":{ "name":"ModifyNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, "documentation":"

Modifies the specified network interface attribute. You can specify only one attribute at a time.

" }, "ModifyReservedInstances":{ "name":"ModifyReservedInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyReservedInstancesRequest"}, "output":{"shape":"ModifyReservedInstancesResult"}, "documentation":"

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Standard Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifySnapshotAttribute":{ "name":"ModifySnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySnapshotAttributeRequest"}, "documentation":"

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifySpotFleetRequest":{ "name":"ModifySpotFleetRequest", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySpotFleetRequestRequest"}, "output":{"shape":"ModifySpotFleetRequestResponse"}, "documentation":"

Modifies the specified Spot fleet request.

While the Spot fleet request is being modified, it is in the modifying state.

To scale up your Spot fleet, increase its target capacity. The Spot fleet launches the additional Spot instances according to the allocation strategy for the Spot fleet request. If the allocation strategy is lowestPrice, the Spot fleet launches instances using the Spot pool with the lowest price. If the allocation strategy is diversified, the Spot fleet distributes the instances across the Spot pools.

To scale down your Spot fleet, decrease its target capacity. First, the Spot fleet cancels any open bids that exceed the new target capacity. You can request that the Spot fleet terminate Spot instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot fleet terminates the instances with the highest price per unit. If the allocation strategy is diversified, the Spot fleet terminates instances across the Spot pools. Alternatively, you can request that the Spot fleet keep the fleet at its current size, but not replace any Spot instances that are interrupted or that you terminate manually.

" }, "ModifySubnetAttribute":{ "name":"ModifySubnetAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySubnetAttributeRequest"}, "documentation":"

Modifies a subnet attribute.

" }, "ModifyVolumeAttribute":{ "name":"ModifyVolumeAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVolumeAttributeRequest"}, "documentation":"

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" }, "ModifyVpcAttribute":{ "name":"ModifyVpcAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified VPC.

" }, "ModifyVpcEndpoint":{ "name":"ModifyVpcEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcEndpointRequest"}, "output":{"shape":"ModifyVpcEndpointResult"}, "documentation":"

Modifies attributes of a specified VPC endpoint. You can modify the policy associated with the endpoint, and you can add and remove route tables associated with the endpoint.

" }, "ModifyVpcPeeringConnectionOptions":{ "name":"ModifyVpcPeeringConnectionOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcPeeringConnectionOptionsRequest"}, "output":{"shape":"ModifyVpcPeeringConnectionOptionsResult"}, "documentation":"

Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:

  • Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.

  • Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.

  • Enable/disable a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

If the peered VPCs are in different accounts, each owner must initiate a separate request to modify the peering connection options, depending on whether their VPC was the requester or accepter for the VPC peering connection. If the peered VPCs are in the same account, you can modify the requester and accepter options in the same request. To confirm which VPC is the accepter and requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

" }, "MonitorInstances":{ "name":"MonitorInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MonitorInstancesRequest"}, "output":{"shape":"MonitorInstancesResult"}, "documentation":"

Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "MoveAddressToVpc":{ "name":"MoveAddressToVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MoveAddressToVpcRequest"}, "output":{"shape":"MoveAddressToVpcResult"}, "documentation":"

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

" }, "PurchaseHostReservation":{ "name":"PurchaseHostReservation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseHostReservationRequest"}, "output":{"shape":"PurchaseHostReservationResult"}, "documentation":"

Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.

" }, "PurchaseReservedInstancesOffering":{ "name":"PurchaseReservedInstancesOffering", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, "documentation":"

Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "PurchaseScheduledInstances":{ "name":"PurchaseScheduledInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseScheduledInstancesRequest"}, "output":{"shape":"PurchaseScheduledInstancesResult"}, "documentation":"

Purchases one or more Scheduled Instances with the specified schedule.

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.

After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.

" }, "RebootInstances":{ "name":"RebootInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootInstancesRequest"}, "documentation":"

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "RegisterImage":{ "name":"RegisterImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterImageRequest"}, "output":{"shape":"RegisterImageResult"}, "documentation":"

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide.

Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billingProduct code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure.

Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI.

To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see CreateImage.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

" }, "RejectVpcPeeringConnection":{ "name":"RejectVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RejectVpcPeeringConnectionRequest"}, "output":{"shape":"RejectVpcPeeringConnectionResult"}, "documentation":"

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" }, "ReleaseAddress":{ "name":"ReleaseAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReleaseAddressRequest"}, "documentation":"

Releases the specified Elastic IP address.

After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

" }, "ReleaseHosts":{ "name":"ReleaseHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReleaseHostsRequest"}, "output":{"shape":"ReleaseHostsResult"}, "documentation":"

When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, e.g., ModifyHosts. You must stop or terminate all instances on a host before it can be released.

When Dedicated Hosts are released, it make take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated hosts. Try waiting a few minutes, and then try again.

Released hosts will still appear in a DescribeHosts response.

" }, "ReplaceNetworkAclAssociation":{ "name":"ReplaceNetworkAclAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceNetworkAclAssociationRequest"}, "output":{"shape":"ReplaceNetworkAclAssociationResult"}, "documentation":"

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceNetworkAclEntry":{ "name":"ReplaceNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceNetworkAclEntryRequest"}, "documentation":"

Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceRoute":{ "name":"ReplaceRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceRouteRequest"}, "documentation":"

Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, or network interface.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceRouteTableAssociation":{ "name":"ReplaceRouteTableAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceRouteTableAssociationRequest"}, "output":{"shape":"ReplaceRouteTableAssociationResult"}, "documentation":"

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" }, "ReportInstanceStatus":{ "name":"ReportInstanceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReportInstanceStatusRequest"}, "documentation":"

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" }, "RequestSpotFleet":{ "name":"RequestSpotFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RequestSpotFleetRequest"}, "output":{"shape":"RequestSpotFleetResponse"}, "documentation":"

Creates a Spot fleet request.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet.

For more information, see Spot Fleet Requests in the Amazon Elastic Compute Cloud User Guide.

" }, "RequestSpotInstances":{ "name":"RequestSpotInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RequestSpotInstancesRequest"}, "output":{"shape":"RequestSpotInstancesResult"}, "documentation":"

Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

" }, "ResetImageAttribute":{ "name":"ResetImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetImageAttributeRequest"}, "documentation":"

Resets an attribute of an AMI to its default value.

The productCodes attribute can't be reset.

" }, "ResetInstanceAttribute":{ "name":"ResetInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetInstanceAttributeRequest"}, "documentation":"

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.

The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" }, "ResetNetworkInterfaceAttribute":{ "name":"ResetNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetNetworkInterfaceAttributeRequest"}, "documentation":"

Resets a network interface attribute. You can specify only one attribute at a time.

" }, "ResetSnapshotAttribute":{ "name":"ResetSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetSnapshotAttributeRequest"}, "documentation":"

Resets permission settings for the specified snapshot.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "RestoreAddressToClassic":{ "name":"RestoreAddressToClassic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreAddressToClassicRequest"}, "output":{"shape":"RestoreAddressToClassicResult"}, "documentation":"

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

" }, "RevokeSecurityGroupEgress":{ "name":"RevokeSecurityGroupEgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSecurityGroupEgressRequest"}, "documentation":"

[EC2-VPC only] Removes one or more egress rules from a security group for EC2-VPC. This action doesn't apply to security groups for use in EC2-Classic. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" }, "RevokeSecurityGroupIngress":{ "name":"RevokeSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSecurityGroupIngressRequest"}, "documentation":"

Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" }, "RunInstances":{ "name":"RunInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RunInstancesRequest"}, "output":{"shape":"Reservation"}, "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

When you launch an instance, it enters the pending state. After the instance is ready for you, it enters the running state. To check the state of your instance, call DescribeInstances.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

To tag your instance, ensure that it is running as CreateTags requires a resource ID. For more information about tagging, see Tagging Your Amazon EC2 Resources.

If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide.

[EC2-VPC only accounts] If you don't specify a subnet in the request, we choose a default subnet from your default VPC for you.

[EC2-Classic accounts] If you're launching into EC2-Classic and you don't specify an Availability Zone, we choose one for you.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide.

If any of the AMIs have a product code attached for which the user has not subscribed, RunInstances fails.

Some instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, RunInstances fails. For more information, see Instance Types Available Only in a VPC.

For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "RunScheduledInstances":{ "name":"RunScheduledInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RunScheduledInstancesRequest"}, "output":{"shape":"RunScheduledInstancesResult"}, "documentation":"

Launches the specified Scheduled Instances.

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "StartInstances":{ "name":"StartInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartInstancesRequest"}, "output":{"shape":"StartInstancesResult"}, "documentation":"

Starts an Amazon EBS-backed AMI that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "StopInstances":{ "name":"StopInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopInstancesRequest"}, "output":{"shape":"StopInstancesResult"}, "documentation":"

Stops an Amazon EBS-backed instance.

We don't charge hourly usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

You can't start or stop Spot instances, and you can't stop instance store-backed instances.

When you stop an instance, we shut it down. You can restart your instance at any time. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Stopping an instance is different to rebooting or terminating it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "TerminateInstances":{ "name":"TerminateInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateInstancesRequest"}, "output":{"shape":"TerminateInstancesResult"}, "documentation":"

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "UnassignPrivateIpAddresses":{ "name":"UnassignPrivateIpAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnassignPrivateIpAddressesRequest"}, "documentation":"

Unassigns one or more secondary private IP addresses from a network interface.

" }, "UnmonitorInstances":{ "name":"UnmonitorInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnmonitorInstancesRequest"}, "output":{"shape":"UnmonitorInstancesResult"}, "documentation":"

Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" } }, "shapes":{ "AcceptReservedInstancesExchangeQuoteRequest":{ "type":"structure", "required":["ReservedInstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ReservedInstanceIds":{ "shape":"ReservedInstanceIdSet", "documentation":"

The IDs of the Convertible Reserved Instances that you want to exchange for other Convertible Reserved Instances of the same or higher value.

", "locationName":"ReservedInstanceId" }, "TargetConfigurations":{ "shape":"TargetConfigurationRequestSet", "documentation":"

The configurations of the Convertible Reserved Instance offerings you are purchasing in this exchange.

", "locationName":"TargetConfiguration" } }, "documentation":"

Contains the parameters for accepting the quote.

" }, "AcceptReservedInstancesExchangeQuoteResult":{ "type":"structure", "members":{ "ExchangeId":{ "shape":"String", "documentation":"

The ID of the successful exchange.

", "locationName":"exchangeId" } }, "documentation":"

The result of the exchange and whether it was successful.

" }, "AcceptVpcPeeringConnectionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Contains the parameters for AcceptVpcPeeringConnection.

" }, "AcceptVpcPeeringConnectionResult":{ "type":"structure", "members":{ "VpcPeeringConnection":{ "shape":"VpcPeeringConnection", "documentation":"

Information about the VPC peering connection.

", "locationName":"vpcPeeringConnection" } }, "documentation":"

Contains the output of AcceptVpcPeeringConnection.

" }, "AccountAttribute":{ "type":"structure", "members":{ "AttributeName":{ "shape":"String", "documentation":"

The name of the account attribute.

", "locationName":"attributeName" }, "AttributeValues":{ "shape":"AccountAttributeValueList", "documentation":"

One or more values for the account attribute.

", "locationName":"attributeValueSet" } }, "documentation":"

Describes an account attribute.

" }, "AccountAttributeList":{ "type":"list", "member":{ "shape":"AccountAttribute", "locationName":"item" } }, "AccountAttributeName":{ "type":"string", "enum":[ "supported-platforms", "default-vpc" ] }, "AccountAttributeNameStringList":{ "type":"list", "member":{ "shape":"AccountAttributeName", "locationName":"attributeName" } }, "AccountAttributeValue":{ "type":"structure", "members":{ "AttributeValue":{ "shape":"String", "documentation":"

The value of the attribute.

", "locationName":"attributeValue" } }, "documentation":"

Describes a value of an account attribute.

" }, "AccountAttributeValueList":{ "type":"list", "member":{ "shape":"AccountAttributeValue", "locationName":"item" } }, "ActiveInstance":{ "type":"structure", "members":{ "InstanceType":{ "shape":"String", "documentation":"

The instance type.

", "locationName":"instanceType" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot instance request.

", "locationName":"spotInstanceRequestId" } }, "documentation":"

Describes a running instance in a Spot fleet.

" }, "ActiveInstanceSet":{ "type":"list", "member":{ "shape":"ActiveInstance", "locationName":"item" } }, "ActivityStatus":{ "type":"string", "enum":[ "error", "pending_fulfillment", "pending_termination", "fulfilled" ] }, "Address":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance that the address is associated with (if any).

", "locationName":"instanceId" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "AllocationId":{ "shape":"String", "documentation":"

The ID representing the allocation of the address for use with EC2-VPC.

", "locationName":"allocationId" }, "AssociationId":{ "shape":"String", "documentation":"

The ID representing the association of the address with an instance in a VPC.

", "locationName":"associationId" }, "Domain":{ "shape":"DomainType", "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", "locationName":"domain" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "NetworkInterfaceOwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that owns the network interface.

", "locationName":"networkInterfaceOwnerId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address associated with the Elastic IP address.

", "locationName":"privateIpAddress" } }, "documentation":"

Describes an Elastic IP address.

" }, "AddressList":{ "type":"list", "member":{ "shape":"Address", "locationName":"item" } }, "Affinity":{ "type":"string", "enum":[ "default", "host" ] }, "AllocateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Domain":{ "shape":"DomainType", "documentation":"

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" } }, "documentation":"

Contains the parameters for AllocateAddress.

" }, "AllocateAddressResult":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "Domain":{ "shape":"DomainType", "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", "locationName":"domain" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", "locationName":"allocationId" } }, "documentation":"

Contains the output of AllocateAddress.

" }, "AllocateHostsRequest":{ "type":"structure", "required":[ "InstanceType", "Quantity", "AvailabilityZone" ], "members":{ "AutoPlacement":{ "shape":"AutoPlacement", "documentation":"

This is enabled by default. This property allows instances to be automatically placed onto available Dedicated Hosts, when you are launching instances without specifying a host ID.

Default: Enabled

", "locationName":"autoPlacement" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"clientToken" }, "InstanceType":{ "shape":"String", "documentation":"

Specify the instance type that you want your Dedicated Hosts to be configured for. When you specify the instance type, that is the only instance type that you can launch onto that host.

", "locationName":"instanceType" }, "Quantity":{ "shape":"Integer", "documentation":"

The number of Dedicated Hosts you want to allocate to your account with these parameters.

", "locationName":"quantity" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the Dedicated Hosts.

", "locationName":"availabilityZone" } }, "documentation":"

Contains the parameters for AllocateHosts.

" }, "AllocateHostsResult":{ "type":"structure", "members":{ "HostIds":{ "shape":"ResponseHostIdList", "documentation":"

The ID of the allocated Dedicated Host. This is used when you want to launch an instance onto a specific host.

", "locationName":"hostIdSet" } }, "documentation":"

Contains the output of AllocateHosts.

" }, "AllocationIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"AllocationId" } }, "AllocationState":{ "type":"string", "enum":[ "available", "under-assessment", "permanent-failure", "released", "released-permanent-failure" ] }, "AllocationStrategy":{ "type":"string", "enum":[ "lowestPrice", "diversified" ] }, "ArchitectureValues":{ "type":"string", "enum":[ "i386", "x86_64" ] }, "AssignPrivateIpAddressesRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", "locationName":"privateIpAddress" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", "locationName":"secondaryPrivateIpAddressCount" }, "AllowReassignment":{ "shape":"Boolean", "documentation":"

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", "locationName":"allowReassignment" } }, "documentation":"

Contains the parameters for AssignPrivateIpAddresses.

" }, "AssociateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address. This is required for EC2-Classic.

" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

", "locationName":"networkInterfaceId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", "locationName":"privateIpAddress" }, "AllowReassociation":{ "shape":"Boolean", "documentation":"

[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

", "locationName":"allowReassociation" } }, "documentation":"

Contains the parameters for AssociateAddress.

" }, "AssociateAddressResult":{ "type":"structure", "members":{ "AssociationId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", "locationName":"associationId" } }, "documentation":"

Contains the output of AssociateAddress.

" }, "AssociateDhcpOptionsRequest":{ "type":"structure", "required":[ "DhcpOptionsId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for AssociateDhcpOptions.

" }, "AssociateRouteTableRequest":{ "type":"structure", "required":[ "SubnetId", "RouteTableId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" } }, "documentation":"

Contains the parameters for AssociateRouteTable.

" }, "AssociateRouteTableResult":{ "type":"structure", "members":{ "AssociationId":{ "shape":"String", "documentation":"

The route table association ID (needed to disassociate the route table).

", "locationName":"associationId" } }, "documentation":"

Contains the output of AssociateRouteTable.

" }, "AttachClassicLinkVpcRequest":{ "type":"structure", "required":[ "InstanceId", "VpcId", "Groups" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of a ClassicLink-enabled VPC.

", "locationName":"vpcId" }, "Groups":{ "shape":"GroupIdStringList", "documentation":"

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", "locationName":"SecurityGroupId" } }, "documentation":"

Contains the parameters for AttachClassicLinkVpc.

" }, "AttachClassicLinkVpcResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of AttachClassicLinkVpc.

" }, "AttachInternetGatewayRequest":{ "type":"structure", "required":[ "InternetGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for AttachInternetGateway.

" }, "AttachNetworkInterfaceRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "InstanceId", "DeviceIndex" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device for the network interface attachment.

", "locationName":"deviceIndex" } }, "documentation":"

Contains the parameters for AttachNetworkInterface.

" }, "AttachNetworkInterfaceResult":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" } }, "documentation":"

Contains the output of AttachNetworkInterface.

" }, "AttachVolumeRequest":{ "type":"structure", "required":[ "VolumeId", "InstanceId", "Device" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "Device":{ "shape":"String", "documentation":"

The device name to expose to the instance (for example, /dev/sdh or xvdh).

" } }, "documentation":"

Contains the parameters for AttachVolume.

" }, "AttachVpnGatewayRequest":{ "type":"structure", "required":[ "VpnGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for AttachVpnGateway.

" }, "AttachVpnGatewayResult":{ "type":"structure", "members":{ "VpcAttachment":{ "shape":"VpcAttachment", "documentation":"

Information about the attachment.

", "locationName":"attachment" } }, "documentation":"

Contains the output of AttachVpnGateway.

" }, "AttachmentStatus":{ "type":"string", "enum":[ "attaching", "attached", "detaching", "detached" ] }, "AttributeBooleanValue":{ "type":"structure", "members":{ "Value":{ "shape":"Boolean", "documentation":"

The attribute value. The valid values are true or false.

", "locationName":"value" } }, "documentation":"

Describes a value for a resource attribute that is a Boolean value.

" }, "AttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"String", "documentation":"

The attribute value. Note that the value is case-sensitive.

", "locationName":"value" } }, "documentation":"

Describes a value for a resource attribute that is a String.

" }, "AuthorizeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

The name of a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account number for a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", "locationName":"toPort" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.

", "locationName":"cidrIp" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"ipPermissions" } }, "documentation":"

Contains the parameters for AuthorizeSecurityGroupEgress.

" }, "AuthorizeSecurityGroupIngressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a nondefault VPC.

" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.

" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

[EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all traffic. If you specify -1, traffic on all ports is allowed, regardless of any ports you specify.

" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. Can be used to specify multiple rules in a single command.

" } }, "documentation":"

Contains the parameters for AuthorizeSecurityGroupIngress.

" }, "AutoPlacement":{ "type":"string", "enum":[ "on", "off" ] }, "AvailabilityZone":{ "type":"structure", "members":{ "ZoneName":{ "shape":"String", "documentation":"

The name of the Availability Zone.

", "locationName":"zoneName" }, "State":{ "shape":"AvailabilityZoneState", "documentation":"

The state of the Availability Zone.

", "locationName":"zoneState" }, "RegionName":{ "shape":"String", "documentation":"

The name of the region.

", "locationName":"regionName" }, "Messages":{ "shape":"AvailabilityZoneMessageList", "documentation":"

Any messages about the Availability Zone.

", "locationName":"messageSet" } }, "documentation":"

Describes an Availability Zone.

" }, "AvailabilityZoneList":{ "type":"list", "member":{ "shape":"AvailabilityZone", "locationName":"item" } }, "AvailabilityZoneMessage":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

The message about the Availability Zone.

", "locationName":"message" } }, "documentation":"

Describes a message about an Availability Zone.

" }, "AvailabilityZoneMessageList":{ "type":"list", "member":{ "shape":"AvailabilityZoneMessage", "locationName":"item" } }, "AvailabilityZoneState":{ "type":"string", "enum":[ "available", "information", "impaired", "unavailable" ] }, "AvailableCapacity":{ "type":"structure", "members":{ "AvailableInstanceCapacity":{ "shape":"AvailableInstanceCapacityList", "documentation":"

The total number of instances that the Dedicated Host supports.

", "locationName":"availableInstanceCapacity" }, "AvailableVCpus":{ "shape":"Integer", "documentation":"

The number of vCPUs available on the Dedicated Host.

", "locationName":"availableVCpus" } }, "documentation":"

The capacity information for instances launched onto the Dedicated Host.

" }, "AvailableInstanceCapacityList":{ "type":"list", "member":{ "shape":"InstanceCapacity", "locationName":"item" } }, "BatchState":{ "type":"string", "enum":[ "submitted", "active", "cancelled", "failed", "cancelled_running", "cancelled_terminating", "modifying" ] }, "Blob":{"type":"blob"}, "BlobAttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"Blob", "locationName":"value" } } }, "BlockDeviceMapping":{ "type":"structure", "members":{ "VirtualName":{ "shape":"String", "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", "locationName":"virtualName" }, "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsBlockDevice", "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", "locationName":"ebs" }, "NoDevice":{ "shape":"String", "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", "locationName":"noDevice" } }, "documentation":"

Describes a block device mapping.

" }, "BlockDeviceMappingList":{ "type":"list", "member":{ "shape":"BlockDeviceMapping", "locationName":"item" } }, "BlockDeviceMappingRequestList":{ "type":"list", "member":{ "shape":"BlockDeviceMapping", "locationName":"BlockDeviceMapping" } }, "Boolean":{"type":"boolean"}, "BundleIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"BundleId" } }, "BundleInstanceRequest":{ "type":"structure", "required":[ "InstanceId", "Storage" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

" }, "Storage":{ "shape":"Storage", "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" } }, "documentation":"

Contains the parameters for BundleInstance.

" }, "BundleInstanceResult":{ "type":"structure", "members":{ "BundleTask":{ "shape":"BundleTask", "documentation":"

Information about the bundle task.

", "locationName":"bundleInstanceTask" } }, "documentation":"

Contains the output of BundleInstance.

" }, "BundleTask":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance associated with this bundle task.

", "locationName":"instanceId" }, "BundleId":{ "shape":"String", "documentation":"

The ID of the bundle task.

", "locationName":"bundleId" }, "State":{ "shape":"BundleTaskState", "documentation":"

The state of the task.

", "locationName":"state" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time this task started.

", "locationName":"startTime" }, "UpdateTime":{ "shape":"DateTime", "documentation":"

The time of the most recent update for the task.

", "locationName":"updateTime" }, "Storage":{ "shape":"Storage", "documentation":"

The Amazon S3 storage locations.

", "locationName":"storage" }, "Progress":{ "shape":"String", "documentation":"

The level of task completion, as a percent (for example, 20%).

", "locationName":"progress" }, "BundleTaskError":{ "shape":"BundleTaskError", "documentation":"

If the task fails, a description of the error.

", "locationName":"error" } }, "documentation":"

Describes a bundle task.

" }, "BundleTaskError":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The error message.

", "locationName":"message" } }, "documentation":"

Describes an error for BundleInstance.

" }, "BundleTaskList":{ "type":"list", "member":{ "shape":"BundleTask", "locationName":"item" } }, "BundleTaskState":{ "type":"string", "enum":[ "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed" ] }, "CancelBatchErrorCode":{ "type":"string", "enum":[ "fleetRequestIdDoesNotExist", "fleetRequestIdMalformed", "fleetRequestNotInCancellableState", "unexpectedError" ] }, "CancelBundleTaskRequest":{ "type":"structure", "required":["BundleId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "BundleId":{ "shape":"String", "documentation":"

The ID of the bundle task.

" } }, "documentation":"

Contains the parameters for CancelBundleTask.

" }, "CancelBundleTaskResult":{ "type":"structure", "members":{ "BundleTask":{ "shape":"BundleTask", "documentation":"

Information about the bundle task.

", "locationName":"bundleInstanceTask" } }, "documentation":"

Contains the output of CancelBundleTask.

" }, "CancelConversionRequest":{ "type":"structure", "required":["ConversionTaskId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ConversionTaskId":{ "shape":"String", "documentation":"

The ID of the conversion task.

", "locationName":"conversionTaskId" }, "ReasonMessage":{ "shape":"String", "documentation":"

The reason for canceling the conversion task.

", "locationName":"reasonMessage" } }, "documentation":"

Contains the parameters for CancelConversionTask.

" }, "CancelExportTaskRequest":{ "type":"structure", "required":["ExportTaskId"], "members":{ "ExportTaskId":{ "shape":"String", "documentation":"

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", "locationName":"exportTaskId" } }, "documentation":"

Contains the parameters for CancelExportTask.

" }, "CancelImportTaskRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import image or import snapshot task to be canceled.

" }, "CancelReason":{ "shape":"String", "documentation":"

The reason for canceling the task.

" } }, "documentation":"

Contains the parameters for CancelImportTask.

" }, "CancelImportTaskResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the task being canceled.

", "locationName":"importTaskId" }, "State":{ "shape":"String", "documentation":"

The current state of the task being canceled.

", "locationName":"state" }, "PreviousState":{ "shape":"String", "documentation":"

The current state of the task being canceled.

", "locationName":"previousState" } }, "documentation":"

Contains the output for CancelImportTask.

" }, "CancelReservedInstancesListingRequest":{ "type":"structure", "required":["ReservedInstancesListingId"], "members":{ "ReservedInstancesListingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance listing.

", "locationName":"reservedInstancesListingId" } }, "documentation":"

Contains the parameters for CancelReservedInstancesListing.

" }, "CancelReservedInstancesListingResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

The Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } }, "documentation":"

Contains the output of CancelReservedInstancesListing.

" }, "CancelSpotFleetRequestsError":{ "type":"structure", "required":[ "Code", "Message" ], "members":{ "Code":{ "shape":"CancelBatchErrorCode", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The description for the error code.

", "locationName":"message" } }, "documentation":"

Describes a Spot fleet error.

" }, "CancelSpotFleetRequestsErrorItem":{ "type":"structure", "required":[ "SpotFleetRequestId", "Error" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "Error":{ "shape":"CancelSpotFleetRequestsError", "documentation":"

The error.

", "locationName":"error" } }, "documentation":"

Describes a Spot fleet request that was not successfully canceled.

" }, "CancelSpotFleetRequestsErrorSet":{ "type":"list", "member":{ "shape":"CancelSpotFleetRequestsErrorItem", "locationName":"item" } }, "CancelSpotFleetRequestsRequest":{ "type":"structure", "required":[ "SpotFleetRequestIds", "TerminateInstances" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestIds":{ "shape":"ValueStringList", "documentation":"

The IDs of the Spot fleet requests.

", "locationName":"spotFleetRequestId" }, "TerminateInstances":{ "shape":"Boolean", "documentation":"

Indicates whether to terminate instances for a Spot fleet request if it is canceled successfully.

", "locationName":"terminateInstances" } }, "documentation":"

Contains the parameters for CancelSpotFleetRequests.

" }, "CancelSpotFleetRequestsResponse":{ "type":"structure", "members":{ "UnsuccessfulFleetRequests":{ "shape":"CancelSpotFleetRequestsErrorSet", "documentation":"

Information about the Spot fleet requests that are not successfully canceled.

", "locationName":"unsuccessfulFleetRequestSet" }, "SuccessfulFleetRequests":{ "shape":"CancelSpotFleetRequestsSuccessSet", "documentation":"

Information about the Spot fleet requests that are successfully canceled.

", "locationName":"successfulFleetRequestSet" } }, "documentation":"

Contains the output of CancelSpotFleetRequests.

" }, "CancelSpotFleetRequestsSuccessItem":{ "type":"structure", "required":[ "SpotFleetRequestId", "CurrentSpotFleetRequestState", "PreviousSpotFleetRequestState" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "CurrentSpotFleetRequestState":{ "shape":"BatchState", "documentation":"

The current state of the Spot fleet request.

", "locationName":"currentSpotFleetRequestState" }, "PreviousSpotFleetRequestState":{ "shape":"BatchState", "documentation":"

The previous state of the Spot fleet request.

", "locationName":"previousSpotFleetRequestState" } }, "documentation":"

Describes a Spot fleet request that was successfully canceled.

" }, "CancelSpotFleetRequestsSuccessSet":{ "type":"list", "member":{ "shape":"CancelSpotFleetRequestsSuccessItem", "locationName":"item" } }, "CancelSpotInstanceRequestState":{ "type":"string", "enum":[ "active", "open", "closed", "cancelled", "completed" ] }, "CancelSpotInstanceRequestsRequest":{ "type":"structure", "required":["SpotInstanceRequestIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotInstanceRequestIds":{ "shape":"SpotInstanceRequestIdList", "documentation":"

One or more Spot instance request IDs.

", "locationName":"SpotInstanceRequestId" } }, "documentation":"

Contains the parameters for CancelSpotInstanceRequests.

" }, "CancelSpotInstanceRequestsResult":{ "type":"structure", "members":{ "CancelledSpotInstanceRequests":{ "shape":"CancelledSpotInstanceRequestList", "documentation":"

One or more Spot instance requests.

", "locationName":"spotInstanceRequestSet" } }, "documentation":"

Contains the output of CancelSpotInstanceRequests.

" }, "CancelledSpotInstanceRequest":{ "type":"structure", "members":{ "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot instance request.

", "locationName":"spotInstanceRequestId" }, "State":{ "shape":"CancelSpotInstanceRequestState", "documentation":"

The state of the Spot instance request.

", "locationName":"state" } }, "documentation":"

Describes a request to cancel a Spot instance.

" }, "CancelledSpotInstanceRequestList":{ "type":"list", "member":{ "shape":"CancelledSpotInstanceRequest", "locationName":"item" } }, "ClassicLinkDnsSupport":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "ClassicLinkDnsSupported":{ "shape":"Boolean", "documentation":"

Indicates whether ClassicLink DNS support is enabled for the VPC.

", "locationName":"classicLinkDnsSupported" } }, "documentation":"

Describes the ClassicLink DNS support status of a VPC.

" }, "ClassicLinkDnsSupportList":{ "type":"list", "member":{ "shape":"ClassicLinkDnsSupport", "locationName":"item" } }, "ClassicLinkInstance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

A list of security groups.

", "locationName":"groupSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the instance.

", "locationName":"tagSet" } }, "documentation":"

Describes a linked EC2-Classic instance.

" }, "ClassicLinkInstanceList":{ "type":"list", "member":{ "shape":"ClassicLinkInstance", "locationName":"item" } }, "ClientData":{ "type":"structure", "members":{ "UploadStart":{ "shape":"DateTime", "documentation":"

The time that the disk upload starts.

" }, "UploadEnd":{ "shape":"DateTime", "documentation":"

The time that the disk upload ends.

" }, "UploadSize":{ "shape":"Double", "documentation":"

The size of the uploaded disk image, in GiB.

" }, "Comment":{ "shape":"String", "documentation":"

A user-defined comment about the disk upload.

" } }, "documentation":"

Describes the client-specific data.

" }, "ConfirmProductInstanceRequest":{ "type":"structure", "required":[ "ProductCode", "InstanceId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ProductCode":{ "shape":"String", "documentation":"

The product code. This must be a product code that you own.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" } }, "documentation":"

Contains the parameters for ConfirmProductInstance.

" }, "ConfirmProductInstanceResult":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", "locationName":"ownerId" }, "Return":{ "shape":"Boolean", "documentation":"

The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.

", "locationName":"return" } }, "documentation":"

Contains the output of ConfirmProductInstance.

" }, "ContainerFormat":{ "type":"string", "enum":["ova"] }, "ConversionIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "ConversionTask":{ "type":"structure", "required":[ "ConversionTaskId", "State" ], "members":{ "ConversionTaskId":{ "shape":"String", "documentation":"

The ID of the conversion task.

", "locationName":"conversionTaskId" }, "ExpirationTime":{ "shape":"String", "documentation":"

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", "locationName":"expirationTime" }, "ImportInstance":{ "shape":"ImportInstanceTaskDetails", "documentation":"

If the task is for importing an instance, this contains information about the import instance task.

", "locationName":"importInstance" }, "ImportVolume":{ "shape":"ImportVolumeTaskDetails", "documentation":"

If the task is for importing a volume, this contains information about the import volume task.

", "locationName":"importVolume" }, "State":{ "shape":"ConversionTaskState", "documentation":"

The state of the conversion task.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message related to the conversion task.

", "locationName":"statusMessage" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the task.

", "locationName":"tagSet" } }, "documentation":"

Describes a conversion task.

" }, "ConversionTaskState":{ "type":"string", "enum":[ "active", "cancelling", "cancelled", "completed" ] }, "CopyImageRequest":{ "type":"structure", "required":[ "SourceRegion", "SourceImageId", "Name" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SourceRegion":{ "shape":"String", "documentation":"

The name of the region that contains the AMI to copy.

" }, "SourceImageId":{ "shape":"String", "documentation":"

The ID of the AMI to copy.

" }, "Name":{ "shape":"String", "documentation":"

The name of the new AMI in the destination region.

" }, "Description":{ "shape":"String", "documentation":"

A description for the new AMI in the destination region.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

", "locationName":"kmsKeyId" } }, "documentation":"

Contains the parameters for CopyImage.

" }, "CopyImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the new AMI.

", "locationName":"imageId" } }, "documentation":"

Contains the output of CopyImage.

" }, "CopySnapshotRequest":{ "type":"structure", "required":[ "SourceRegion", "SourceSnapshotId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SourceRegion":{ "shape":"String", "documentation":"

The ID of the region that contains the snapshot to be copied.

" }, "SourceSnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot to copy.

" }, "Description":{ "shape":"String", "documentation":"

A description for the EBS snapshot.

" }, "DestinationRegion":{ "shape":"String", "documentation":"

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

", "locationName":"destinationRegion" }, "PresignedUrl":{ "shape":"String", "documentation":"

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", "locationName":"presignedUrl" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the destination snapshot should be encrypted. You can encrypt a copy of an unencrypted snapshot using this flag, but you cannot use it to create an unencrypted copy from an encrypted snapshot. Your default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

", "locationName":"kmsKeyId" } }, "documentation":"

Contains the parameters for CopySnapshot.

" }, "CopySnapshotResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the new snapshot.

", "locationName":"snapshotId" } }, "documentation":"

Contains the output of CopySnapshot.

" }, "CreateCustomerGatewayRequest":{ "type":"structure", "required":[ "Type", "PublicIp", "BgpAsn" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection that this customer gateway supports (ipsec.1).

" }, "PublicIp":{ "shape":"String", "documentation":"

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", "locationName":"IpAddress" }, "BgpAsn":{ "shape":"Integer", "documentation":"

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" } }, "documentation":"

Contains the parameters for CreateCustomerGateway.

" }, "CreateCustomerGatewayResult":{ "type":"structure", "members":{ "CustomerGateway":{ "shape":"CustomerGateway", "documentation":"

Information about the customer gateway.

", "locationName":"customerGateway" } }, "documentation":"

Contains the output of CreateCustomerGateway.

" }, "CreateDhcpOptionsRequest":{ "type":"structure", "required":["DhcpConfigurations"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpConfigurations":{ "shape":"NewDhcpConfigurationList", "documentation":"

A DHCP configuration option.

", "locationName":"dhcpConfiguration" } }, "documentation":"

Contains the parameters for CreateDhcpOptions.

" }, "CreateDhcpOptionsResult":{ "type":"structure", "members":{ "DhcpOptions":{ "shape":"DhcpOptions", "documentation":"

A set of DHCP options.

", "locationName":"dhcpOptions" } }, "documentation":"

Contains the output of CreateDhcpOptions.

" }, "CreateFlowLogsRequest":{ "type":"structure", "required":[ "ResourceIds", "ResourceType", "TrafficType", "LogGroupName", "DeliverLogsPermissionArn" ], "members":{ "ResourceIds":{ "shape":"ValueStringList", "documentation":"

One or more subnet, network interface, or VPC IDs.

Constraints: Maximum of 1000 resources

", "locationName":"ResourceId" }, "ResourceType":{ "shape":"FlowLogsResourceType", "documentation":"

The type of resource on which to create the flow log.

" }, "TrafficType":{ "shape":"TrafficType", "documentation":"

The type of traffic to log.

" }, "LogGroupName":{ "shape":"String", "documentation":"

The name of the CloudWatch log group.

" }, "DeliverLogsPermissionArn":{ "shape":"String", "documentation":"

The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" } }, "documentation":"

Contains the parameters for CreateFlowLogs.

" }, "CreateFlowLogsResult":{ "type":"structure", "members":{ "FlowLogIds":{ "shape":"ValueStringList", "documentation":"

The IDs of the flow logs.

", "locationName":"flowLogIdSet" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", "locationName":"clientToken" }, "Unsuccessful":{ "shape":"UnsuccessfulItemSet", "documentation":"

Information about the flow logs that could not be created successfully.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of CreateFlowLogs.

" }, "CreateImageRequest":{ "type":"structure", "required":[ "InstanceId", "Name" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Name":{ "shape":"String", "documentation":"

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

A description for the new image.

", "locationName":"description" }, "NoReboot":{ "shape":"Boolean", "documentation":"

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", "locationName":"noReboot" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

Information about one or more block device mappings.

", "locationName":"blockDeviceMapping" } }, "documentation":"

Contains the parameters for CreateImage.

" }, "CreateImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the new AMI.

", "locationName":"imageId" } }, "documentation":"

Contains the output of CreateImage.

" }, "CreateInstanceExportTaskRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "Description":{ "shape":"String", "documentation":"

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", "locationName":"description" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "TargetEnvironment":{ "shape":"ExportEnvironment", "documentation":"

The target virtualization environment.

", "locationName":"targetEnvironment" }, "ExportToS3Task":{ "shape":"ExportToS3TaskSpecification", "documentation":"

The format and location for an instance export task.

", "locationName":"exportToS3" } }, "documentation":"

Contains the parameters for CreateInstanceExportTask.

" }, "CreateInstanceExportTaskResult":{ "type":"structure", "members":{ "ExportTask":{ "shape":"ExportTask", "documentation":"

Information about the instance export task.

", "locationName":"exportTask" } }, "documentation":"

Contains the output for CreateInstanceExportTask.

" }, "CreateInternetGatewayRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for CreateInternetGateway.

" }, "CreateInternetGatewayResult":{ "type":"structure", "members":{ "InternetGateway":{ "shape":"InternetGateway", "documentation":"

Information about the Internet gateway.

", "locationName":"internetGateway" } }, "documentation":"

Contains the output of CreateInternetGateway.

" }, "CreateKeyPairRequest":{ "type":"structure", "required":["KeyName"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" } }, "documentation":"

Contains the parameters for CreateKeyPair.

" }, "CreateNatGatewayRequest":{ "type":"structure", "required":[ "SubnetId", "AllocationId" ], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The subnet in which to create the NAT gateway.

" }, "AllocationId":{ "shape":"String", "documentation":"

The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Constraint: Maximum 64 ASCII characters.

" } }, "documentation":"

Contains the parameters for CreateNatGateway.

" }, "CreateNatGatewayResult":{ "type":"structure", "members":{ "NatGateway":{ "shape":"NatGateway", "documentation":"

Information about the NAT gateway.

", "locationName":"natGateway" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

", "locationName":"clientToken" } }, "documentation":"

Contains the output of CreateNatGateway.

" }, "CreateNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Protocol", "RuleAction", "Egress", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The protocol. A value of -1 means all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.

", "locationName":"Icmp" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", "locationName":"portRange" } }, "documentation":"

Contains the parameters for CreateNetworkAclEntry.

" }, "CreateNetworkAclRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for CreateNetworkAcl.

" }, "CreateNetworkAclResult":{ "type":"structure", "members":{ "NetworkAcl":{ "shape":"NetworkAcl", "documentation":"

Information about the network ACL.

", "locationName":"networkAcl" } }, "documentation":"

Contains the output of CreateNetworkAcl.

" }, "CreateNetworkInterfaceRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet to associate with the network interface.

", "locationName":"subnetId" }, "Description":{ "shape":"String", "documentation":"

A description for the network interface.

", "locationName":"description" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", "locationName":"privateIpAddress" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

The IDs of one or more security groups.

", "locationName":"SecurityGroupId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", "documentation":"

One or more private IP addresses.

", "locationName":"privateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"secondaryPrivateIpAddressCount" }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for CreateNetworkInterface.

" }, "CreateNetworkInterfaceResult":{ "type":"structure", "members":{ "NetworkInterface":{ "shape":"NetworkInterface", "documentation":"

Information about the network interface.

", "locationName":"networkInterface" } }, "documentation":"

Contains the output of CreateNetworkInterface.

" }, "CreatePlacementGroupRequest":{ "type":"structure", "required":[ "GroupName", "Strategy" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

A name for the placement group.

Constraints: Up to 255 ASCII characters

", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"

The placement strategy.

", "locationName":"strategy" } }, "documentation":"

Contains the parameters for CreatePlacementGroup.

" }, "CreateReservedInstancesListingRequest":{ "type":"structure", "required":[ "ReservedInstancesId", "InstanceCount", "PriceSchedules", "ClientToken" ], "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the active Standard Reserved Instance.

", "locationName":"reservedInstancesId" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", "locationName":"instanceCount" }, "PriceSchedules":{ "shape":"PriceScheduleSpecificationList", "documentation":"

A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.

", "locationName":"priceSchedules" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Contains the parameters for CreateReservedInstancesListing.

" }, "CreateReservedInstancesListingResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

Information about the Standard Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } }, "documentation":"

Contains the output of CreateReservedInstancesListing.

" }, "CreateRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table for the route.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of an Internet gateway or virtual private gateway attached to your VPC.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", "locationName":"instanceId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of a network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of a VPC peering connection.

", "locationName":"vpcPeeringConnectionId" }, "NatGatewayId":{ "shape":"String", "documentation":"

The ID of a NAT gateway.

", "locationName":"natGatewayId" } }, "documentation":"

Contains the parameters for CreateRoute.

" }, "CreateRouteResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of CreateRoute.

" }, "CreateRouteTableRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for CreateRouteTable.

" }, "CreateRouteTableResult":{ "type":"structure", "members":{ "RouteTable":{ "shape":"RouteTable", "documentation":"

Information about the route table.

", "locationName":"routeTable" } }, "documentation":"

Contains the output of CreateRouteTable.

" }, "CreateSecurityGroupRequest":{ "type":"structure", "required":[ "GroupName", "Description" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

" }, "Description":{ "shape":"String", "documentation":"

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", "locationName":"GroupDescription" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" } }, "documentation":"

Contains the parameters for CreateSecurityGroup.

" }, "CreateSecurityGroupResult":{ "type":"structure", "members":{ "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } }, "documentation":"

Contains the output of CreateSecurityGroup.

" }, "CreateSnapshotRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume.

" }, "Description":{ "shape":"String", "documentation":"

A description for the snapshot.

" } }, "documentation":"

Contains the parameters for CreateSnapshot.

" }, "CreateSpotDatafeedSubscriptionRequest":{ "type":"structure", "required":["Bucket"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket in which to store the Spot instance data feed.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

A prefix for the data feed file names.

", "locationName":"prefix" } }, "documentation":"

Contains the parameters for CreateSpotDatafeedSubscription.

" }, "CreateSpotDatafeedSubscriptionResult":{ "type":"structure", "members":{ "SpotDatafeedSubscription":{ "shape":"SpotDatafeedSubscription", "documentation":"

The Spot instance data feed subscription.

", "locationName":"spotDatafeedSubscription" } }, "documentation":"

Contains the output of CreateSpotDatafeedSubscription.

" }, "CreateSubnetRequest":{ "type":"structure", "required":[ "VpcId", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the subnet.

Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.

" } }, "documentation":"

Contains the parameters for CreateSubnet.

" }, "CreateSubnetResult":{ "type":"structure", "members":{ "Subnet":{ "shape":"Subnet", "documentation":"

Information about the subnet.

", "locationName":"subnet" } }, "documentation":"

Contains the output of CreateSubnet.

" }, "CreateTagsRequest":{ "type":"structure", "required":[ "Resources", "Tags" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Resources":{ "shape":"ResourceIdList", "documentation":"

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

", "locationName":"ResourceId" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", "locationName":"Tag" } }, "documentation":"

Contains the parameters for CreateTags.

" }, "CreateVolumePermission":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

", "locationName":"userId" }, "Group":{ "shape":"PermissionGroup", "documentation":"

The specific group that is to be added or removed from a volume's list of create volume permissions.

", "locationName":"group" } }, "documentation":"

Describes the user or group to be added or removed from the permissions for a volume.

" }, "CreateVolumePermissionList":{ "type":"list", "member":{ "shape":"CreateVolumePermission", "locationName":"item" } }, "CreateVolumePermissionModifications":{ "type":"structure", "members":{ "Add":{ "shape":"CreateVolumePermissionList", "documentation":"

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

" }, "Remove":{ "shape":"CreateVolumePermissionList", "documentation":"

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

" } }, "documentation":"

Describes modifications to the permissions for a volume.

" }, "CreateVolumeRequest":{ "type":"structure", "required":["AvailabilityZone"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Size":{ "shape":"Integer", "documentation":"

The size of the volume, in GiBs.

Constraints: 1-16384 for gp2, 4-16384 for io1, 500-16384 for st1, 500-16384 for sc1, and 1-1024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot from which to create the volume.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: standard

" }, "Iops":{ "shape":"Integer", "documentation":"

Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If a KmsKeyId is specified, the Encrypted flag must also be set.

" } }, "documentation":"

Contains the parameters for CreateVolume.

" }, "CreateVpcEndpointRequest":{ "type":"structure", "required":[ "VpcId", "ServiceName" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC in which the endpoint will be used.

" }, "ServiceName":{ "shape":"String", "documentation":"

The AWS service name, in the form com.amazonaws.region.service . To get a list of available services, use the DescribeVpcEndpointServices request.

" }, "PolicyDocument":{ "shape":"String", "documentation":"

A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs.

", "locationName":"RouteTableId" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" } }, "documentation":"

Contains the parameters for CreateVpcEndpoint.

" }, "CreateVpcEndpointResult":{ "type":"structure", "members":{ "VpcEndpoint":{ "shape":"VpcEndpoint", "documentation":"

Information about the endpoint.

", "locationName":"vpcEndpoint" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", "locationName":"clientToken" } }, "documentation":"

Contains the output of CreateVpcEndpoint.

" }, "CreateVpcPeeringConnectionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the requester VPC.

", "locationName":"vpcId" }, "PeerVpcId":{ "shape":"String", "documentation":"

The ID of the VPC with which you are creating the VPC peering connection.

", "locationName":"peerVpcId" }, "PeerOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

", "locationName":"peerOwnerId" } }, "documentation":"

Contains the parameters for CreateVpcPeeringConnection.

" }, "CreateVpcPeeringConnectionResult":{ "type":"structure", "members":{ "VpcPeeringConnection":{ "shape":"VpcPeeringConnection", "documentation":"

Information about the VPC peering connection.

", "locationName":"vpcPeeringConnection" } }, "documentation":"

Contains the output of CreateVpcPeeringConnection.

" }, "CreateVpcRequest":{ "type":"structure", "required":["CidrBlock"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

", "locationName":"instanceTenancy" } }, "documentation":"

Contains the parameters for CreateVpc.

" }, "CreateVpcResult":{ "type":"structure", "members":{ "Vpc":{ "shape":"Vpc", "documentation":"

Information about the VPC.

", "locationName":"vpc" } }, "documentation":"

Contains the output of CreateVpc.

" }, "CreateVpnConnectionRequest":{ "type":"structure", "required":[ "Type", "CustomerGatewayId", "VpnGatewayId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Type":{ "shape":"String", "documentation":"

The type of VPN connection (ipsec.1).

" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "Options":{ "shape":"VpnConnectionOptionsSpecification", "documentation":"

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

", "locationName":"options" } }, "documentation":"

Contains the parameters for CreateVpnConnection.

" }, "CreateVpnConnectionResult":{ "type":"structure", "members":{ "VpnConnection":{ "shape":"VpnConnection", "documentation":"

Information about the VPN connection.

", "locationName":"vpnConnection" } }, "documentation":"

Contains the output of CreateVpnConnection.

" }, "CreateVpnConnectionRouteRequest":{ "type":"structure", "required":[ "VpnConnectionId", "DestinationCidrBlock" ], "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer network.

" } }, "documentation":"

Contains the parameters for CreateVpnConnectionRoute.

" }, "CreateVpnGatewayRequest":{ "type":"structure", "required":["Type"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection this virtual private gateway supports.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the virtual private gateway.

" } }, "documentation":"

Contains the parameters for CreateVpnGateway.

" }, "CreateVpnGatewayResult":{ "type":"structure", "members":{ "VpnGateway":{ "shape":"VpnGateway", "documentation":"

Information about the virtual private gateway.

", "locationName":"vpnGateway" } }, "documentation":"

Contains the output of CreateVpnGateway.

" }, "CurrencyCodeValues":{ "type":"string", "enum":["USD"] }, "CustomerGateway":{ "type":"structure", "members":{ "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

", "locationName":"customerGatewayId" }, "State":{ "shape":"String", "documentation":"

The current state of the customer gateway (pending | available | deleting | deleted).

", "locationName":"state" }, "Type":{ "shape":"String", "documentation":"

The type of VPN connection the customer gateway supports (ipsec.1).

", "locationName":"type" }, "IpAddress":{ "shape":"String", "documentation":"

The Internet-routable IP address of the customer gateway's outside interface.

", "locationName":"ipAddress" }, "BgpAsn":{ "shape":"String", "documentation":"

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", "locationName":"bgpAsn" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the customer gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes a customer gateway.

" }, "CustomerGatewayIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"CustomerGatewayId" } }, "CustomerGatewayList":{ "type":"list", "member":{ "shape":"CustomerGateway", "locationName":"item" } }, "DatafeedSubscriptionState":{ "type":"string", "enum":[ "Active", "Inactive" ] }, "DateTime":{"type":"timestamp"}, "DeleteCustomerGatewayRequest":{ "type":"structure", "required":["CustomerGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

" } }, "documentation":"

Contains the parameters for DeleteCustomerGateway.

" }, "DeleteDhcpOptionsRequest":{ "type":"structure", "required":["DhcpOptionsId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the DHCP options set.

" } }, "documentation":"

Contains the parameters for DeleteDhcpOptions.

" }, "DeleteFlowLogsRequest":{ "type":"structure", "required":["FlowLogIds"], "members":{ "FlowLogIds":{ "shape":"ValueStringList", "documentation":"

One or more flow log IDs.

", "locationName":"FlowLogId" } }, "documentation":"

Contains the parameters for DeleteFlowLogs.

" }, "DeleteFlowLogsResult":{ "type":"structure", "members":{ "Unsuccessful":{ "shape":"UnsuccessfulItemSet", "documentation":"

Information about the flow logs that could not be deleted successfully.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of DeleteFlowLogs.

" }, "DeleteInternetGatewayRequest":{ "type":"structure", "required":["InternetGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" } }, "documentation":"

Contains the parameters for DeleteInternetGateway.

" }, "DeleteKeyPairRequest":{ "type":"structure", "required":["KeyName"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

" } }, "documentation":"

Contains the parameters for DeleteKeyPair.

" }, "DeleteNatGatewayRequest":{ "type":"structure", "required":["NatGatewayId"], "members":{ "NatGatewayId":{ "shape":"String", "documentation":"

The ID of the NAT gateway.

" } }, "documentation":"

Contains the parameters for DeleteNatGateway.

" }, "DeleteNatGatewayResult":{ "type":"structure", "members":{ "NatGatewayId":{ "shape":"String", "documentation":"

The ID of the NAT gateway.

", "locationName":"natGatewayId" } }, "documentation":"

Contains the output of DeleteNatGateway.

" }, "DeleteNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Egress" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number of the entry to delete.

", "locationName":"ruleNumber" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether the rule is an egress rule.

", "locationName":"egress" } }, "documentation":"

Contains the parameters for DeleteNetworkAclEntry.

" }, "DeleteNetworkAclRequest":{ "type":"structure", "required":["NetworkAclId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" } }, "documentation":"

Contains the parameters for DeleteNetworkAcl.

" }, "DeleteNetworkInterfaceRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" } }, "documentation":"

Contains the parameters for DeleteNetworkInterface.

" }, "DeletePlacementGroupRequest":{ "type":"structure", "required":["GroupName"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

", "locationName":"groupName" } }, "documentation":"

Contains the parameters for DeletePlacementGroup.

" }, "DeleteRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", "locationName":"destinationCidrBlock" } }, "documentation":"

Contains the parameters for DeleteRoute.

" }, "DeleteRouteTableRequest":{ "type":"structure", "required":["RouteTableId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" } }, "documentation":"

Contains the parameters for DeleteRouteTable.

" }, "DeleteSecurityGroupRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a nondefault VPC.

" } }, "documentation":"

Contains the parameters for DeleteSecurityGroup.

" }, "DeleteSnapshotRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot.

" } }, "documentation":"

Contains the parameters for DeleteSnapshot.

" }, "DeleteSpotDatafeedSubscriptionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for DeleteSpotDatafeedSubscription.

" }, "DeleteSubnetRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

" } }, "documentation":"

Contains the parameters for DeleteSubnet.

" }, "DeleteTagsRequest":{ "type":"structure", "required":["Resources"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Resources":{ "shape":"ResourceIdList", "documentation":"

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

", "locationName":"resourceId" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

", "locationName":"tag" } }, "documentation":"

Contains the parameters for DeleteTags.

" }, "DeleteVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" } }, "documentation":"

Contains the parameters for DeleteVolume.

" }, "DeleteVpcEndpointsRequest":{ "type":"structure", "required":["VpcEndpointIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcEndpointIds":{ "shape":"ValueStringList", "documentation":"

One or more endpoint IDs.

", "locationName":"VpcEndpointId" } }, "documentation":"

Contains the parameters for DeleteVpcEndpoints.

" }, "DeleteVpcEndpointsResult":{ "type":"structure", "members":{ "Unsuccessful":{ "shape":"UnsuccessfulItemSet", "documentation":"

Information about the endpoints that were not successfully deleted.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of DeleteVpcEndpoints.

" }, "DeleteVpcPeeringConnectionRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Contains the parameters for DeleteVpcPeeringConnection.

" }, "DeleteVpcPeeringConnectionResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of DeleteVpcPeeringConnection.

" }, "DeleteVpcRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for DeleteVpc.

" }, "DeleteVpnConnectionRequest":{ "type":"structure", "required":["VpnConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" } }, "documentation":"

Contains the parameters for DeleteVpnConnection.

" }, "DeleteVpnConnectionRouteRequest":{ "type":"structure", "required":[ "VpnConnectionId", "DestinationCidrBlock" ], "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer network.

" } }, "documentation":"

Contains the parameters for DeleteVpnConnectionRoute.

" }, "DeleteVpnGatewayRequest":{ "type":"structure", "required":["VpnGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } }, "documentation":"

Contains the parameters for DeleteVpnGateway.

" }, "DeregisterImageRequest":{ "type":"structure", "required":["ImageId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" } }, "documentation":"

Contains the parameters for DeregisterImage.

" }, "DescribeAccountAttributesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AttributeNames":{ "shape":"AccountAttributeNameStringList", "documentation":"

One or more account attribute names.

", "locationName":"attributeName" } }, "documentation":"

Contains the parameters for DescribeAccountAttributes.

" }, "DescribeAccountAttributesResult":{ "type":"structure", "members":{ "AccountAttributes":{ "shape":"AccountAttributeList", "documentation":"

Information about one or more account attributes.

", "locationName":"accountAttributeSet" } }, "documentation":"

Contains the output of DescribeAccountAttributes.

" }, "DescribeAddressesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIps":{ "shape":"PublicIpStringList", "documentation":"

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", "locationName":"PublicIp" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

", "locationName":"Filter" }, "AllocationIds":{ "shape":"AllocationIdList", "documentation":"

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

", "locationName":"AllocationId" } }, "documentation":"

Contains the parameters for DescribeAddresses.

" }, "DescribeAddressesResult":{ "type":"structure", "members":{ "Addresses":{ "shape":"AddressList", "documentation":"

Information about one or more Elastic IP addresses.

", "locationName":"addressesSet" } }, "documentation":"

Contains the output of DescribeAddresses.

" }, "DescribeAvailabilityZonesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ZoneNames":{ "shape":"ZoneNameStringList", "documentation":"

The names of one or more Availability Zones.

", "locationName":"ZoneName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | information | impaired | unavailable).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeAvailabilityZones.

" }, "DescribeAvailabilityZonesResult":{ "type":"structure", "members":{ "AvailabilityZones":{ "shape":"AvailabilityZoneList", "documentation":"

Information about one or more Availability Zones.

", "locationName":"availabilityZoneInfo" } }, "documentation":"

Contains the output of DescribeAvailabiltyZones.

" }, "DescribeBundleTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "BundleIds":{ "shape":"BundleIdStringList", "documentation":"

One or more bundle task IDs.

Default: Describes all your bundle tasks.

", "locationName":"BundleId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeBundleTasks.

" }, "DescribeBundleTasksResult":{ "type":"structure", "members":{ "BundleTasks":{ "shape":"BundleTaskList", "documentation":"

Information about one or more bundle tasks.

", "locationName":"bundleInstanceTasksSet" } }, "documentation":"

Contains the output of DescribeBundleTasks.

" }, "DescribeClassicLinkInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC that the instance is linked to.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeClassicLinkInstances.

" }, "DescribeClassicLinkInstancesResult":{ "type":"structure", "members":{ "Instances":{ "shape":"ClassicLinkInstanceList", "documentation":"

Information about one or more linked EC2-Classic instances.

", "locationName":"instancesSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeClassicLinkInstances.

" }, "DescribeConversionTaskList":{ "type":"list", "member":{ "shape":"ConversionTask", "locationName":"item" } }, "DescribeConversionTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ConversionTaskIds":{ "shape":"ConversionIdStringList", "documentation":"

One or more conversion task IDs.

", "locationName":"conversionTaskId" } }, "documentation":"

Contains the parameters for DescribeConversionTasks.

" }, "DescribeConversionTasksResult":{ "type":"structure", "members":{ "ConversionTasks":{ "shape":"DescribeConversionTaskList", "documentation":"

Information about the conversion tasks.

", "locationName":"conversionTasks" } }, "documentation":"

Contains the output for DescribeConversionTasks.

" }, "DescribeCustomerGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "CustomerGatewayIds":{ "shape":"CustomerGatewayIdStringList", "documentation":"

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", "locationName":"CustomerGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeCustomerGateways.

" }, "DescribeCustomerGatewaysResult":{ "type":"structure", "members":{ "CustomerGateways":{ "shape":"CustomerGatewayList", "documentation":"

Information about one or more customer gateways.

", "locationName":"customerGatewaySet" } }, "documentation":"

Contains the output of DescribeCustomerGateways.

" }, "DescribeDhcpOptionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpOptionsIds":{ "shape":"DhcpOptionsIdStringList", "documentation":"

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", "locationName":"DhcpOptionsId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • dhcp-options-id - The ID of a set of DHCP options.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeDhcpOptions.

" }, "DescribeDhcpOptionsResult":{ "type":"structure", "members":{ "DhcpOptions":{ "shape":"DhcpOptionsList", "documentation":"

Information about one or more DHCP options sets.

", "locationName":"dhcpOptionsSet" } }, "documentation":"

Contains the output of DescribeDhcpOptions.

" }, "DescribeExportTasksRequest":{ "type":"structure", "members":{ "ExportTaskIds":{ "shape":"ExportTaskIdStringList", "documentation":"

One or more export task IDs.

", "locationName":"exportTaskId" } }, "documentation":"

Contains the parameters for DescribeExportTasks.

" }, "DescribeExportTasksResult":{ "type":"structure", "members":{ "ExportTasks":{ "shape":"ExportTaskList", "documentation":"

Information about the export tasks.

", "locationName":"exportTaskSet" } }, "documentation":"

Contains the output for DescribeExportTasks.

" }, "DescribeFlowLogsRequest":{ "type":"structure", "members":{ "FlowLogIds":{ "shape":"ValueStringList", "documentation":"

One or more flow log IDs.

", "locationName":"FlowLogId" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

  • flow-log-id - The ID of the flow log.

  • log-group-name - The name of the log group.

  • resource-id - The ID of the VPC, subnet, or network interface.

  • traffic-type - The type of traffic (ACCEPT | REJECT | ALL)

" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the flow log IDs parameter in the same request.

" } }, "documentation":"

Contains the parameters for DescribeFlowLogs.

" }, "DescribeFlowLogsResult":{ "type":"structure", "members":{ "FlowLogs":{ "shape":"FlowLogSet", "documentation":"

Information about the flow logs.

", "locationName":"flowLogSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeFlowLogs.

" }, "DescribeHostReservationOfferingsRequest":{ "type":"structure", "members":{ "OfferingId":{ "shape":"String", "documentation":"

The ID of the reservation offering.

" }, "MinDuration":{ "shape":"Integer", "documentation":"

This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.

" }, "MaxDuration":{ "shape":"Integer", "documentation":"

This is the maximum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.

" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • instance-family - The instance family of the offering (e.g., m4).

  • payment-option - The payment option (No Upfront | Partial Upfront | All Upfront).

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error.

" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results.

" } } }, "DescribeHostReservationOfferingsResult":{ "type":"structure", "members":{ "OfferingSet":{ "shape":"HostOfferingSet", "documentation":"

Information about the offerings.

", "locationName":"offeringSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeHostReservationsRequest":{ "type":"structure", "members":{ "HostReservationIdSet":{ "shape":"HostReservationIdSet", "documentation":"

One or more host reservation IDs.

" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • instance-family - The instance family (e.g., m4).

  • payment-option - The payment option (No Upfront | Partial Upfront | All Upfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | retired).

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error.

" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results.

" } } }, "DescribeHostReservationsResult":{ "type":"structure", "members":{ "HostReservationSet":{ "shape":"HostReservationSet", "documentation":"

Details about the reservation's configuration.

", "locationName":"hostReservationSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeHostsRequest":{ "type":"structure", "members":{ "HostIds":{ "shape":"RequestHostIdList", "documentation":"

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

", "locationName":"hostId" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error. You cannot specify this parameter and the host IDs parameter in the same request.

", "locationName":"maxResults" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • host-reservation-id - The ID of the reservation assigned to this host.

  • client-token - The idempotency token you provided when you launched the instance

  • state- The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • availability-zone - The Availability Zone of the host.

", "locationName":"filter" } }, "documentation":"

Contains the parameters for DescribeHosts.

" }, "DescribeHostsResult":{ "type":"structure", "members":{ "Hosts":{ "shape":"HostList", "documentation":"

Information about the Dedicated Hosts.

", "locationName":"hostSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeHosts.

" }, "DescribeIdFormatRequest":{ "type":"structure", "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource: instance | reservation | snapshot | volume

" } }, "documentation":"

Contains the parameters for DescribeIdFormat.

" }, "DescribeIdFormatResult":{ "type":"structure", "members":{ "Statuses":{ "shape":"IdFormatList", "documentation":"

Information about the ID format for the resource.

", "locationName":"statusSet" } }, "documentation":"

Contains the output of DescribeIdFormat.

" }, "DescribeIdentityIdFormatRequest":{ "type":"structure", "required":["PrincipalArn"], "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource: instance | reservation | snapshot | volume

", "locationName":"resource" }, "PrincipalArn":{ "shape":"String", "documentation":"

The ARN of the principal, which can be an IAM role, IAM user, or the root user.

", "locationName":"principalArn" } }, "documentation":"

Contains the parameters for DescribeIdentityIdFormat.

" }, "DescribeIdentityIdFormatResult":{ "type":"structure", "members":{ "Statuses":{ "shape":"IdFormatList", "documentation":"

Information about the ID format for the resources.

", "locationName":"statusSet" } }, "documentation":"

Contains the output of DescribeIdentityIdFormat.

" }, "DescribeImageAttributeRequest":{ "type":"structure", "required":[ "ImageId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"ImageAttributeName", "documentation":"

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

" } }, "documentation":"

Contains the parameters for DescribeImageAttribute.

" }, "DescribeImagesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageIds":{ "shape":"ImageIdStringList", "documentation":"

One or more image IDs.

Default: Describes all images available to you.

", "locationName":"ImageId" }, "Owners":{ "shape":"OwnerStringList", "documentation":"

Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace | microsoft). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

", "locationName":"Owner" }, "ExecutableUsers":{ "shape":"ExecutableByStringList", "documentation":"

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", "locationName":"ExecutableBy" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • architecture - The image architecture (i386 | x86_64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

  • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

  • description - The description of the image (provided during image creation).

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - String value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeImages.

" }, "DescribeImagesResult":{ "type":"structure", "members":{ "Images":{ "shape":"ImageList", "documentation":"

Information about one or more images.

", "locationName":"imagesSet" } }, "documentation":"

Contains the output of DescribeImages.

" }, "DescribeImportImageTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ImportTaskIds":{ "shape":"ImportTaskIdList", "documentation":"

A list of import image task IDs.

", "locationName":"ImportTaskId" }, "NextToken":{ "shape":"String", "documentation":"

A token that indicates the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" }, "Filters":{ "shape":"FilterList", "documentation":"

Filter tasks using the task-state filter and one of the following values: active, completed, deleting, deleted.

" } }, "documentation":"

Contains the parameters for DescribeImportImageTasks.

" }, "DescribeImportImageTasksResult":{ "type":"structure", "members":{ "ImportImageTasks":{ "shape":"ImportImageTaskList", "documentation":"

A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.

", "locationName":"importImageTaskSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output for DescribeImportImageTasks.

" }, "DescribeImportSnapshotTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ImportTaskIds":{ "shape":"ImportTaskIdList", "documentation":"

A list of import snapshot task IDs.

", "locationName":"ImportTaskId" }, "NextToken":{ "shape":"String", "documentation":"

A token that indicates the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

" } }, "documentation":"

Contains the parameters for DescribeImportSnapshotTasks.

" }, "DescribeImportSnapshotTasksResult":{ "type":"structure", "members":{ "ImportSnapshotTasks":{ "shape":"ImportSnapshotTaskList", "documentation":"

A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.

", "locationName":"importSnapshotTaskSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output for DescribeImportSnapshotTasks.

" }, "DescribeInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The instance attribute.

Note: The enaSupport attribute is not supported at this time.

", "locationName":"attribute" } }, "documentation":"

Contains the parameters for DescribeInstanceAttribute.

" }, "DescribeInstanceStatusRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

" }, "IncludeAllInstances":{ "shape":"Boolean", "documentation":"

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", "locationName":"includeAllInstances" } }, "documentation":"

Contains the parameters for DescribeInstanceStatus.

" }, "DescribeInstanceStatusResult":{ "type":"structure", "members":{ "InstanceStatuses":{ "shape":"InstanceStatusList", "documentation":"

One or more instance status descriptions.

", "locationName":"instanceStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeInstanceStatus.

" }, "DescribeInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Default: Describes all your instances.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • affinity - The affinity setting for an instance running on a Dedicated Host (default | host).

  • architecture - The instance architecture (i386 | x86_64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • host-id - The ID of the Dedicated Host on which the instance is running, if applicable.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IP address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - 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 - The time when the instance was launched.

  • monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.

  • private-dns-name - The private DNS name of the instance.

  • private-ip-address - The private IP address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - 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 - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - 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 - The name of the root device for the instance (for example, /dev/sda1 or /dev/xvda).

  • root-device-type - The type of root device that the instance uses (ebs | instance-store).

  • source-dest-check - 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 - The ID of the Spot instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • tenancy - The tenancy of an instance (dedicated | default | host).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

  • network-interface.description - The description of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface.private-dns-name - The private DNS name of the network interface.

  • network-interface.source-dest-check - 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.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.addresses.private-ip-address - The private IP address associated with the network interface.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to request the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter or tag filters in the same call.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeInstances.

" }, "DescribeInstancesResult":{ "type":"structure", "members":{ "Reservations":{ "shape":"ReservationList", "documentation":"

Zero or more reservations.

", "locationName":"reservationSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeInstances.

" }, "DescribeInternetGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayIds":{ "shape":"ValueStringList", "documentation":"

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

", "locationName":"internetGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeInternetGateways.

" }, "DescribeInternetGatewaysResult":{ "type":"structure", "members":{ "InternetGateways":{ "shape":"InternetGatewayList", "documentation":"

Information about one or more Internet gateways.

", "locationName":"internetGatewaySet" } }, "documentation":"

Contains the output of DescribeInternetGateways.

" }, "DescribeKeyPairsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyNames":{ "shape":"KeyNameStringList", "documentation":"

One or more key pair names.

Default: Describes all your key pairs.

", "locationName":"KeyName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeKeyPairs.

" }, "DescribeKeyPairsResult":{ "type":"structure", "members":{ "KeyPairs":{ "shape":"KeyPairList", "documentation":"

Information about one or more key pairs.

", "locationName":"keySet" } }, "documentation":"

Contains the output of DescribeKeyPairs.

" }, "DescribeMovingAddressesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIps":{ "shape":"ValueStringList", "documentation":"

One or more Elastic IP addresses.

", "locationName":"publicIp" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results.

", "locationName":"nextToken" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).

", "locationName":"filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.

Default: If no value is provided, the default is 1000.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeMovingAddresses.

" }, "DescribeMovingAddressesResult":{ "type":"structure", "members":{ "MovingAddressStatuses":{ "shape":"MovingAddressStatusSet", "documentation":"

The status for each Elastic IP address.

", "locationName":"movingAddressStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeMovingAddresses.

" }, "DescribeNatGatewaysRequest":{ "type":"structure", "members":{ "NatGatewayIds":{ "shape":"ValueStringList", "documentation":"

One or more NAT gateway IDs.

", "locationName":"NatGatewayId" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

  • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" } }, "documentation":"

Contains the parameters for DescribeNatGateways.

" }, "DescribeNatGatewaysResult":{ "type":"structure", "members":{ "NatGateways":{ "shape":"NatGatewayList", "documentation":"

Information about the NAT gateways.

", "locationName":"natGatewaySet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeNatGateways.

" }, "DescribeNetworkAclsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclIds":{ "shape":"ValueStringList", "documentation":"

One or more network ACL IDs.

Default: Describes all your network ACLs.

", "locationName":"NetworkAclId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The CIDR range specified in the entry.

  • entry.egress - Indicates whether the entry applies to egress traffic.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.

  • network-acl-id - The ID of the network ACL.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network ACL.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeNetworkAcls.

" }, "DescribeNetworkAclsResult":{ "type":"structure", "members":{ "NetworkAcls":{ "shape":"NetworkAclList", "documentation":"

Information about one or more network ACLs.

", "locationName":"networkAclSet" } }, "documentation":"

Contains the output of DescribeNetworkAcls.

" }, "DescribeNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Attribute":{ "shape":"NetworkInterfaceAttribute", "documentation":"

The attribute of the network interface.

", "locationName":"attribute" } }, "documentation":"

Contains the parameters for DescribeNetworkInterfaceAttribute.

" }, "DescribeNetworkInterfaceAttributeResult":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Description":{ "shape":"AttributeValue", "documentation":"

The description of the network interface.

", "locationName":"description" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

The security groups associated with the network interface.

", "locationName":"groupSet" }, "Attachment":{ "shape":"NetworkInterfaceAttachment", "documentation":"

The attachment (if any) of the network interface.

", "locationName":"attachment" } }, "documentation":"

Contains the output of DescribeNetworkInterfaceAttribute.

" }, "DescribeNetworkInterfacesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceIds":{ "shape":"NetworkInterfaceIdList", "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", "locationName":"NetworkInterfaceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IP addresses associated with the network interface.

  • addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface.

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.attach.time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.nat-gateway-id - The ID of the NAT gateway to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IP address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-desk-check - 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 - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network interface.

", "locationName":"filter" } }, "documentation":"

Contains the parameters for DescribeNetworkInterfaces.

" }, "DescribeNetworkInterfacesResult":{ "type":"structure", "members":{ "NetworkInterfaces":{ "shape":"NetworkInterfaceList", "documentation":"

Information about one or more network interfaces.

", "locationName":"networkInterfaceSet" } }, "documentation":"

Contains the output of DescribeNetworkInterfaces.

" }, "DescribePlacementGroupsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupNames":{ "shape":"PlacementGroupStringList", "documentation":"

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

", "locationName":"groupName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribePlacementGroups.

" }, "DescribePlacementGroupsResult":{ "type":"structure", "members":{ "PlacementGroups":{ "shape":"PlacementGroupList", "documentation":"

One or more placement groups.

", "locationName":"placementGroupSet" } }, "documentation":"

Contains the output of DescribePlacementGroups.

" }, "DescribePrefixListsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "PrefixListIds":{ "shape":"ValueStringList", "documentation":"

One or more prefix list IDs.

", "locationName":"PrefixListId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • prefix-list-id: The ID of a prefix list.

  • prefix-list-name: The name of a prefix list.

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } }, "documentation":"

Contains the parameters for DescribePrefixLists.

" }, "DescribePrefixListsResult":{ "type":"structure", "members":{ "PrefixLists":{ "shape":"PrefixListSet", "documentation":"

All available prefix lists.

", "locationName":"prefixListSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribePrefixLists.

" }, "DescribeRegionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RegionNames":{ "shape":"RegionNameStringList", "documentation":"

The names of one or more regions.

", "locationName":"RegionName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

  • region-name - The name of the region (for example, us-east-1).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeRegions.

" }, "DescribeRegionsResult":{ "type":"structure", "members":{ "Regions":{ "shape":"RegionList", "documentation":"

Information about one or more regions.

", "locationName":"regionInfo" } }, "documentation":"

Contains the output of DescribeRegions.

" }, "DescribeReservedInstancesListingsRequest":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

One or more Reserved Instance IDs.

", "locationName":"reservedInstancesId" }, "ReservedInstancesListingId":{ "shape":"String", "documentation":"

One or more Reserved Instance listing IDs.

", "locationName":"reservedInstancesListingId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeReservedInstancesListings.

" }, "DescribeReservedInstancesListingsResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

Information about the Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } }, "documentation":"

Contains the output of DescribeReservedInstancesListings.

" }, "DescribeReservedInstancesModificationsRequest":{ "type":"structure", "members":{ "ReservedInstancesModificationIds":{ "shape":"ReservedInstancesModificationIdStringList", "documentation":"

IDs for the submitted modification request.

", "locationName":"ReservedInstancesModificationId" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeReservedInstancesModifications.

" }, "DescribeReservedInstancesModificationsResult":{ "type":"structure", "members":{ "ReservedInstancesModifications":{ "shape":"ReservedInstancesModificationList", "documentation":"

The Reserved Instance modification information.

", "locationName":"reservedInstancesModificationsSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeReservedInstancesModifications.

" }, "DescribeReservedInstancesOfferingsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ReservedInstancesOfferingIds":{ "shape":"ReservedInstancesOfferingIdStringList", "documentation":"

One or more Reserved Instances offering IDs.

", "locationName":"ReservedInstancesOfferingId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • scope - The scope of the Reserved Instance (Availability Zone or Region).

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", "locationName":"Filter" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

Default: default

", "locationName":"instanceTenancy" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", "locationName":"offeringType" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

", "locationName":"maxResults" }, "IncludeMarketplace":{ "shape":"Boolean", "documentation":"

Include Reserved Instance Marketplace offerings in the response.

" }, "MinDuration":{ "shape":"Long", "documentation":"

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

" }, "MaxDuration":{ "shape":"Long", "documentation":"

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

" }, "MaxInstanceCount":{ "shape":"Integer", "documentation":"

The maximum number of instances to filter when searching for offerings.

Default: 20

" }, "OfferingClass":{ "shape":"OfferingClassType", "documentation":"

The offering class of the Reserved Instance. Can be standard or convertible.

" } }, "documentation":"

Contains the parameters for DescribeReservedInstancesOfferings.

" }, "DescribeReservedInstancesOfferingsResult":{ "type":"structure", "members":{ "ReservedInstancesOfferings":{ "shape":"ReservedInstancesOfferingList", "documentation":"

A list of Reserved Instances offerings.

", "locationName":"reservedInstancesOfferingsSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeReservedInstancesOfferings.

" }, "DescribeReservedInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ReservedInstancesIds":{ "shape":"ReservedInstancesIdStringList", "documentation":"

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

", "locationName":"ReservedInstancesId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • scope - The scope of the Reserved Instance (Region or Availability Zone).

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", "locationName":"Filter" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", "locationName":"offeringType" }, "OfferingClass":{ "shape":"OfferingClassType", "documentation":"

Describes whether the Reserved Instance is Standard or Convertible.

" } }, "documentation":"

Contains the parameters for DescribeReservedInstances.

" }, "DescribeReservedInstancesResult":{ "type":"structure", "members":{ "ReservedInstances":{ "shape":"ReservedInstancesList", "documentation":"

A list of Reserved Instances.

", "locationName":"reservedInstancesSet" } }, "documentation":"

Contains the output for DescribeReservedInstances.

" }, "DescribeRouteTablesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs.

Default: Describes all your route tables.

", "locationName":"RouteTableId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC (true | false).

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The CIDR range specified in a route in the table.

  • route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.nat-gateway-id - The ID of a NAT gateway.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). 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).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the route table.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeRouteTables.

" }, "DescribeRouteTablesResult":{ "type":"structure", "members":{ "RouteTables":{ "shape":"RouteTableList", "documentation":"

Information about one or more route tables.

", "locationName":"routeTableSet" } }, "documentation":"

Contains the output of DescribeRouteTables.

" }, "DescribeScheduledInstanceAvailabilityRequest":{ "type":"structure", "required":[ "Recurrence", "FirstSlotStartTimeRange" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "Recurrence":{ "shape":"ScheduledInstanceRecurrenceRequest", "documentation":"

The schedule recurrence.

" }, "FirstSlotStartTimeRange":{ "shape":"SlotDateTimeRangeRequest", "documentation":"

The time period for the first schedule to start.

" }, "MinSlotDurationInHours":{ "shape":"Integer", "documentation":"

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

" }, "MaxSlotDurationInHours":{ "shape":"Integer", "documentation":"

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned NextToken value.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeScheduledInstanceAvailability.

" }, "DescribeScheduledInstanceAvailabilityResult":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" }, "ScheduledInstanceAvailabilitySet":{ "shape":"ScheduledInstanceAvailabilitySet", "documentation":"

Information about the available Scheduled Instances.

", "locationName":"scheduledInstanceAvailabilitySet" } }, "documentation":"

Contains the output of DescribeScheduledInstanceAvailability.

" }, "DescribeScheduledInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ScheduledInstanceIds":{ "shape":"ScheduledInstanceIdRequestSet", "documentation":"

One or more Scheduled Instance IDs.

", "locationName":"ScheduledInstanceId" }, "SlotStartTimeRange":{ "shape":"SlotStartTimeRangeRequest", "documentation":"

The time period for the first schedule to start.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeScheduledInstances.

" }, "DescribeScheduledInstancesResult":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" }, "ScheduledInstanceSet":{ "shape":"ScheduledInstanceSet", "documentation":"

Information about the Scheduled Instances.

", "locationName":"scheduledInstanceSet" } }, "documentation":"

Contains the output of DescribeScheduledInstances.

" }, "DescribeSecurityGroupReferencesRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "GroupId":{ "shape":"GroupIds", "documentation":"

One or more security group IDs in your account.

" } } }, "DescribeSecurityGroupReferencesResult":{ "type":"structure", "members":{ "SecurityGroupReferenceSet":{ "shape":"SecurityGroupReferences", "documentation":"

Information about the VPCs with the referencing security groups.

", "locationName":"securityGroupReferenceSet" } } }, "DescribeSecurityGroupsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupNames":{ "shape":"GroupNameStringList", "documentation":"

[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

", "locationName":"GroupName" }, "GroupIds":{ "shape":"GroupIdStringList", "documentation":"

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

", "locationName":"GroupId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which the security group allows access.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - A CIDR range that has been granted permission.

  • ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been granted permission.

  • ip-permission.group-name - The name of a security group that has been granted permission.

  • ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been granted permission.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag-key - The key of a tag assigned to the security group.

  • tag-value - The value of a tag assigned to the security group.

  • vpc-id - The ID of the VPC specified when the security group was created.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeSecurityGroups.

" }, "DescribeSecurityGroupsResult":{ "type":"structure", "members":{ "SecurityGroups":{ "shape":"SecurityGroupList", "documentation":"

Information about one or more security groups.

", "locationName":"securityGroupInfo" } }, "documentation":"

Contains the output of DescribeSecurityGroups.

" }, "DescribeSnapshotAttributeRequest":{ "type":"structure", "required":[ "SnapshotId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The snapshot attribute you would like to view.

" } }, "documentation":"

Contains the parameters for DescribeSnapshotAttribute.

" }, "DescribeSnapshotAttributeResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot.

", "locationName":"snapshotId" }, "CreateVolumePermissions":{ "shape":"CreateVolumePermissionList", "documentation":"

A list of permissions for creating volumes from the snapshot.

", "locationName":"createVolumePermission" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" } }, "documentation":"

Contains the output of DescribeSnapshotAttribute.

" }, "DescribeSnapshotsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotIds":{ "shape":"SnapshotIdStringList", "documentation":"

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

", "locationName":"SnapshotId" }, "OwnerIds":{ "shape":"OwnerStringList", "documentation":"

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

", "locationName":"Owner" }, "RestorableByUserIds":{ "shape":"RestorableByStringList", "documentation":"

One or more AWS accounts IDs that can create volumes from the snapshot.

", "locationName":"RestorableBy" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • description - A description of the snapshot.

  • owner-alias - Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM consolew.

  • owner-id - The ID of the AWS account that owns the snapshot.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

" } }, "documentation":"

Contains the parameters for DescribeSnapshots.

" }, "DescribeSnapshotsResult":{ "type":"structure", "members":{ "Snapshots":{ "shape":"SnapshotList", "documentation":"

Information about the snapshots.

", "locationName":"snapshotSet" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSnapshots.

" }, "DescribeSpotDatafeedSubscriptionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for DescribeSpotDatafeedSubscription.

" }, "DescribeSpotDatafeedSubscriptionResult":{ "type":"structure", "members":{ "SpotDatafeedSubscription":{ "shape":"SpotDatafeedSubscription", "documentation":"

The Spot instance data feed subscription.

", "locationName":"spotDatafeedSubscription" } }, "documentation":"

Contains the output of DescribeSpotDatafeedSubscription.

" }, "DescribeSpotFleetInstancesRequest":{ "type":"structure", "required":["SpotFleetRequestId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeSpotFleetInstances.

" }, "DescribeSpotFleetInstancesResponse":{ "type":"structure", "required":[ "SpotFleetRequestId", "ActiveInstances" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "ActiveInstances":{ "shape":"ActiveInstanceSet", "documentation":"

The running instances. Note that this list is refreshed periodically and might be out of date.

", "locationName":"activeInstanceSet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotFleetInstances.

" }, "DescribeSpotFleetRequestHistoryRequest":{ "type":"structure", "required":[ "SpotFleetRequestId", "StartTime" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "EventType":{ "shape":"EventType", "documentation":"

The type of events to describe. By default, all events are described.

", "locationName":"eventType" }, "StartTime":{ "shape":"DateTime", "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"startTime" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeSpotFleetRequestHistory.

" }, "DescribeSpotFleetRequestHistoryResponse":{ "type":"structure", "required":[ "SpotFleetRequestId", "StartTime", "LastEvaluatedTime", "HistoryRecords" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "StartTime":{ "shape":"DateTime", "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"startTime" }, "LastEvaluatedTime":{ "shape":"DateTime", "documentation":"

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

If nextToken indicates that there are more results, this value is not present.

", "locationName":"lastEvaluatedTime" }, "HistoryRecords":{ "shape":"HistoryRecords", "documentation":"

Information about the events in the history of the Spot fleet request.

", "locationName":"historyRecordSet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotFleetRequestHistory.

" }, "DescribeSpotFleetRequestsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestIds":{ "shape":"ValueStringList", "documentation":"

The IDs of the Spot fleet requests.

", "locationName":"spotFleetRequestId" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeSpotFleetRequests.

" }, "DescribeSpotFleetRequestsResponse":{ "type":"structure", "required":["SpotFleetRequestConfigs"], "members":{ "SpotFleetRequestConfigs":{ "shape":"SpotFleetRequestConfigSet", "documentation":"

Information about the configuration of your Spot fleet.

", "locationName":"spotFleetRequestConfigSet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotFleetRequests.

" }, "DescribeSpotInstanceRequestsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotInstanceRequestIds":{ "shape":"SpotInstanceRequestIdList", "documentation":"

One or more Spot instance request IDs.

", "locationName":"SpotInstanceRequestId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume: gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.

  • launch.group-id - The security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m3.medium).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether monitoring is enabled for the Spot instance.

  • launch.ramdisk-id - The RAM disk ID.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • network-interface.description - A description of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.group-name - The name of the security group associated with the network interface.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot instance request ID.

  • spot-price - The maximum hourly price for any Spot instance launched to fulfill the request.

  • state - The state of the Spot instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

  • status-code - The short code describing the most recent evaluation of your Spot instance request.

  • status-message - The message explaining the status of the Spot instance request.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of Spot instance request (one-time | persistent).

  • launched-availability-zone - The Availability Zone in which the bid is launched.

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeSpotInstanceRequests.

" }, "DescribeSpotInstanceRequestsResult":{ "type":"structure", "members":{ "SpotInstanceRequests":{ "shape":"SpotInstanceRequestList", "documentation":"

One or more Spot instance requests.

", "locationName":"spotInstanceRequestSet" } }, "documentation":"

Contains the output of DescribeSpotInstanceRequests.

" }, "DescribeSpotPriceHistoryRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "StartTime":{ "shape":"DateTime", "documentation":"

The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"startTime" }, "EndTime":{ "shape":"DateTime", "documentation":"

The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"endTime" }, "InstanceTypes":{ "shape":"InstanceTypeList", "documentation":"

Filters the results by the specified instance types.

", "locationName":"InstanceType" }, "ProductDescriptions":{ "shape":"ProductDescriptionList", "documentation":"

Filters the results by the specified basic product descriptions.

", "locationName":"ProductDescription" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m3.medium).

  • product-description - The product description for the Spot price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - The timestamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

", "locationName":"Filter" }, "AvailabilityZone":{ "shape":"String", "documentation":"

Filters the results by the specified Availability Zone.

", "locationName":"availabilityZone" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" } }, "documentation":"

Contains the parameters for DescribeSpotPriceHistory.

" }, "DescribeSpotPriceHistoryResult":{ "type":"structure", "members":{ "SpotPriceHistory":{ "shape":"SpotPriceHistoryList", "documentation":"

The historical Spot prices.

", "locationName":"spotPriceHistorySet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotPriceHistory.

" }, "DescribeStaleSecurityGroupsRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } } }, "DescribeStaleSecurityGroupsResult":{ "type":"structure", "members":{ "StaleSecurityGroupSet":{ "shape":"StaleSecurityGroupSet", "documentation":"

Information about the stale security groups.

", "locationName":"staleSecurityGroupSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } } }, "DescribeSubnetsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SubnetIds":{ "shape":"SubnetIdStringList", "documentation":"

One or more subnet IDs.

Default: Describes all your subnets.

", "locationName":"SubnetId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

  • available-ip-address-count - The number of IP addresses in the subnet that are available.

  • cidrBlock - 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. You can also use cidr or cidr-block as the filter names.

  • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

  • state - The state of the subnet (pending | available).

  • subnet-id - The ID of the subnet.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the subnet.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeSubnets.

" }, "DescribeSubnetsResult":{ "type":"structure", "members":{ "Subnets":{ "shape":"SubnetList", "documentation":"

Information about one or more subnets.

", "locationName":"subnetSet" } }, "documentation":"

Contains the output of DescribeSubnets.

" }, "DescribeTagsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • key - The tag key.

  • resource-id - The resource ID.

  • resource-type - The resource type (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).

  • value - The tag value.

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" } }, "documentation":"

Contains the parameters for DescribeTags.

" }, "DescribeTagsResult":{ "type":"structure", "members":{ "Tags":{ "shape":"TagDescriptionList", "documentation":"

A list of tags.

", "locationName":"tagSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return..

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeTags.

" }, "DescribeVolumeAttributeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "Attribute":{ "shape":"VolumeAttributeName", "documentation":"

The instance attribute.

" } }, "documentation":"

Contains the parameters for DescribeVolumeAttribute.

" }, "DescribeVolumeAttributeResult":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "AutoEnableIO":{ "shape":"AttributeBooleanValue", "documentation":"

The state of autoEnableIO attribute.

", "locationName":"autoEnableIO" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" } }, "documentation":"

Contains the output of DescribeVolumeAttribute.

" }, "DescribeVolumeStatusRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeIds":{ "shape":"VolumeIdStringList", "documentation":"

One or more volume IDs.

Default: Describes all your volumes.

", "locationName":"VolumeId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

" } }, "documentation":"

Contains the parameters for DescribeVolumeStatus.

" }, "DescribeVolumeStatusResult":{ "type":"structure", "members":{ "VolumeStatuses":{ "shape":"VolumeStatusList", "documentation":"

A list of volumes.

", "locationName":"volumeStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVolumeStatus.

" }, "DescribeVolumesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeIds":{ "shape":"VolumeIdStringList", "documentation":"

One or more volume IDs.

", "locationName":"VolumeId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - The encryption status of the volume.

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The status of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeVolumes.

" }, "DescribeVolumesResult":{ "type":"structure", "members":{ "Volumes":{ "shape":"VolumeList", "documentation":"

Information about the volumes.

", "locationName":"volumeSet" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVolumes.

" }, "DescribeVpcAttributeRequest":{ "type":"structure", "required":[ "VpcId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "Attribute":{ "shape":"VpcAttributeName", "documentation":"

The VPC attribute.

" } }, "documentation":"

Contains the parameters for DescribeVpcAttribute.

" }, "DescribeVpcAttributeResult":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "EnableDnsSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

", "locationName":"enableDnsSupport" }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

", "locationName":"enableDnsHostnames" } }, "documentation":"

Contains the output of DescribeVpcAttribute.

" }, "DescribeVpcClassicLinkDnsSupportRequest":{ "type":"structure", "members":{ "VpcIds":{ "shape":"VpcClassicLinkIdList", "documentation":"

One or more VPC IDs.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

", "locationName":"nextToken" } }, "documentation":"

Contains the parameters for DescribeVpcClassicLinkDnsSupport.

" }, "DescribeVpcClassicLinkDnsSupportResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"ClassicLinkDnsSupportList", "documentation":"

Information about the ClassicLink DNS support status of the VPCs.

", "locationName":"vpcs" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVpcClassicLinkDnsSupport.

" }, "DescribeVpcClassicLinkRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcIds":{ "shape":"VpcClassicLinkIdList", "documentation":"

One or more VPCs for which you want to describe the ClassicLink status.

", "locationName":"VpcId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpcClassicLink.

" }, "DescribeVpcClassicLinkResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"VpcClassicLinkList", "documentation":"

The ClassicLink status of one or more VPCs.

", "locationName":"vpcSet" } }, "documentation":"

Contains the output of DescribeVpcClassicLink.

" }, "DescribeVpcEndpointServicesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } }, "documentation":"

Contains the parameters for DescribeVpcEndpointServices.

" }, "DescribeVpcEndpointServicesResult":{ "type":"structure", "members":{ "ServiceNames":{ "shape":"ValueStringList", "documentation":"

A list of supported AWS services.

", "locationName":"serviceNameSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVpcEndpointServices.

" }, "DescribeVpcEndpointsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcEndpointIds":{ "shape":"ValueStringList", "documentation":"

One or more endpoint IDs.

", "locationName":"VpcEndpointId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • service-name: The name of the AWS service.

  • vpc-id: The ID of the VPC in which the endpoint resides.

  • vpc-endpoint-id: The ID of the endpoint.

  • vpc-endpoint-state: The state of the endpoint. (pending | available | deleting | deleted)

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } }, "documentation":"

Contains the parameters for DescribeVpcEndpoints.

" }, "DescribeVpcEndpointsResult":{ "type":"structure", "members":{ "VpcEndpoints":{ "shape":"VpcEndpointSet", "documentation":"

Information about the endpoints.

", "locationName":"vpcEndpointSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVpcEndpoints.

" }, "DescribeVpcPeeringConnectionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionIds":{ "shape":"ValueStringList", "documentation":"

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

", "locationName":"VpcPeeringConnectionId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

  • accepter-vpc-info.vpc-id - The ID of the peer VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpcPeeringConnections.

" }, "DescribeVpcPeeringConnectionsResult":{ "type":"structure", "members":{ "VpcPeeringConnections":{ "shape":"VpcPeeringConnectionList", "documentation":"

Information about the VPC peering connections.

", "locationName":"vpcPeeringConnectionSet" } }, "documentation":"

Contains the output of DescribeVpcPeeringConnections.

" }, "DescribeVpcsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcIds":{ "shape":"VpcIdStringList", "documentation":"

One or more VPC IDs.

Default: Describes all your VPCs.

", "locationName":"VpcId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • cidr - 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. Must contain the slash followed by one or two digits (for example, /28).

  • dhcp-options-id - The ID of a set of DHCP options.

  • isDefault - Indicates whether the VPC is the default VPC.

  • state - The state of the VPC (pending | available).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpcs.

" }, "DescribeVpcsResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"VpcList", "documentation":"

Information about one or more VPCs.

", "locationName":"vpcSet" } }, "documentation":"

Contains the output of DescribeVpcs.

" }, "DescribeVpnConnectionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnConnectionIds":{ "shape":"VpnConnectionIdStringList", "documentation":"

One or more VPN connection IDs.

Default: Describes your VPN connections.

", "locationName":"VpnConnectionId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpnConnections.

" }, "DescribeVpnConnectionsResult":{ "type":"structure", "members":{ "VpnConnections":{ "shape":"VpnConnectionList", "documentation":"

Information about one or more VPN connections.

", "locationName":"vpnConnectionSet" } }, "documentation":"

Contains the output of DescribeVpnConnections.

" }, "DescribeVpnGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayIds":{ "shape":"VpnGatewayIdStringList", "documentation":"

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

", "locationName":"VpnGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway (if applicable).

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpnGateways.

" }, "DescribeVpnGatewaysResult":{ "type":"structure", "members":{ "VpnGateways":{ "shape":"VpnGatewayList", "documentation":"

Information about one or more virtual private gateways.

", "locationName":"vpnGatewaySet" } }, "documentation":"

Contains the output of DescribeVpnGateways.

" }, "DetachClassicLinkVpcRequest":{ "type":"structure", "required":[ "InstanceId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance to unlink from the VPC.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC to which the instance is linked.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for DetachClassicLinkVpc.

" }, "DetachClassicLinkVpcResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of DetachClassicLinkVpc.

" }, "DetachInternetGatewayRequest":{ "type":"structure", "required":[ "InternetGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for DetachInternetGateway.

" }, "DetachNetworkInterfaceRequest":{ "type":"structure", "required":["AttachmentId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AttachmentId":{ "shape":"String", "documentation":"

The ID of the attachment.

", "locationName":"attachmentId" }, "Force":{ "shape":"Boolean", "documentation":"

Specifies whether to force a detachment.

", "locationName":"force" } }, "documentation":"

Contains the parameters for DetachNetworkInterface.

" }, "DetachVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "Device":{ "shape":"String", "documentation":"

The device name.

" }, "Force":{ "shape":"Boolean", "documentation":"

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

" } }, "documentation":"

Contains the parameters for DetachVolume.

" }, "DetachVpnGatewayRequest":{ "type":"structure", "required":[ "VpnGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for DetachVpnGateway.

" }, "DeviceType":{ "type":"string", "enum":[ "ebs", "instance-store" ] }, "DhcpConfiguration":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The name of a DHCP option.

", "locationName":"key" }, "Values":{ "shape":"DhcpConfigurationValueList", "documentation":"

One or more values for the DHCP option.

", "locationName":"valueSet" } }, "documentation":"

Describes a DHCP configuration option.

" }, "DhcpConfigurationList":{ "type":"list", "member":{ "shape":"DhcpConfiguration", "locationName":"item" } }, "DhcpConfigurationValueList":{ "type":"list", "member":{ "shape":"AttributeValue", "locationName":"item" } }, "DhcpOptions":{ "type":"structure", "members":{ "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the set of DHCP options.

", "locationName":"dhcpOptionsId" }, "DhcpConfigurations":{ "shape":"DhcpConfigurationList", "documentation":"

One or more DHCP options in the set.

", "locationName":"dhcpConfigurationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the DHCP options set.

", "locationName":"tagSet" } }, "documentation":"

Describes a set of DHCP options.

" }, "DhcpOptionsIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"DhcpOptionsId" } }, "DhcpOptionsList":{ "type":"list", "member":{ "shape":"DhcpOptions", "locationName":"item" } }, "DisableVgwRoutePropagationRequest":{ "type":"structure", "required":[ "RouteTableId", "GatewayId" ], "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } }, "documentation":"

Contains the parameters for DisableVgwRoutePropagation.

" }, "DisableVpcClassicLinkDnsSupportRequest":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for DisableVpcClassicLinkDnsSupport.

" }, "DisableVpcClassicLinkDnsSupportResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of DisableVpcClassicLinkDnsSupport.

" }, "DisableVpcClassicLinkRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for DisableVpcClassicLink.

" }, "DisableVpcClassicLinkResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of DisableVpcClassicLink.

" }, "DisassociateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" }, "AssociationId":{ "shape":"String", "documentation":"

[EC2-VPC] The association ID. Required for EC2-VPC.

" } }, "documentation":"

Contains the parameters for DisassociateAddress.

" }, "DisassociateRouteTableRequest":{ "type":"structure", "required":["AssociationId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID representing the current association between the route table and subnet.

", "locationName":"associationId" } }, "documentation":"

Contains the parameters for DisassociateRouteTable.

" }, "DiskImage":{ "type":"structure", "members":{ "Image":{ "shape":"DiskImageDetail", "documentation":"

Information about the disk image.

" }, "Description":{ "shape":"String", "documentation":"

A description of the disk image.

" }, "Volume":{ "shape":"VolumeDetail", "documentation":"

Information about the volume.

" } }, "documentation":"

Describes a disk image.

" }, "DiskImageDescription":{ "type":"structure", "required":[ "Format", "Size", "ImportManifestUrl" ], "members":{ "Format":{ "shape":"DiskImageFormat", "documentation":"

The disk image format.

", "locationName":"format" }, "Size":{ "shape":"Long", "documentation":"

The size of the disk image, in GiB.

", "locationName":"size" }, "ImportManifestUrl":{ "shape":"String", "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

", "locationName":"importManifestUrl" }, "Checksum":{ "shape":"String", "documentation":"

The checksum computed for the disk image.

", "locationName":"checksum" } }, "documentation":"

Describes a disk image.

" }, "DiskImageDetail":{ "type":"structure", "required":[ "Format", "Bytes", "ImportManifestUrl" ], "members":{ "Format":{ "shape":"DiskImageFormat", "documentation":"

The disk image format.

", "locationName":"format" }, "Bytes":{ "shape":"Long", "documentation":"

The size of the disk image, in GiB.

", "locationName":"bytes" }, "ImportManifestUrl":{ "shape":"String", "documentation":"

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

", "locationName":"importManifestUrl" } }, "documentation":"

Describes a disk image.

" }, "DiskImageFormat":{ "type":"string", "enum":[ "VMDK", "RAW", "VHD" ] }, "DiskImageList":{ "type":"list", "member":{"shape":"DiskImage"} }, "DiskImageVolumeDescription":{ "type":"structure", "required":["Id"], "members":{ "Size":{ "shape":"Long", "documentation":"

The size of the volume, in GiB.

", "locationName":"size" }, "Id":{ "shape":"String", "documentation":"

The volume identifier.

", "locationName":"id" } }, "documentation":"

Describes a disk image volume.

" }, "DomainType":{ "type":"string", "enum":[ "vpc", "standard" ] }, "Double":{"type":"double"}, "EbsBlockDevice":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

", "locationName":"snapshotId" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

", "locationName":"volumeSize" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", "locationName":"deleteOnTermination" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type: gp2, io1, st1, sc1, or standard.

Default: standard

", "locationName":"volumeType" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", "locationName":"iops" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

", "locationName":"encrypted" } }, "documentation":"

Describes a block device for an EBS volume.

" }, "EbsInstanceBlockDevice":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume.

", "locationName":"volumeId" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a parameter used to set up an EBS volume in a block device mapping.

" }, "EbsInstanceBlockDeviceSpecification":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume.

", "locationName":"volumeId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes information used to set up an EBS volume specified in a block device mapping.

" }, "EnableVgwRoutePropagationRequest":{ "type":"structure", "required":[ "RouteTableId", "GatewayId" ], "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } }, "documentation":"

Contains the parameters for EnableVgwRoutePropagation.

" }, "EnableVolumeIORequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" } }, "documentation":"

Contains the parameters for EnableVolumeIO.

" }, "EnableVpcClassicLinkDnsSupportRequest":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for EnableVpcClassicLinkDnsSupport.

" }, "EnableVpcClassicLinkDnsSupportResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of EnableVpcClassicLinkDnsSupport.

" }, "EnableVpcClassicLinkRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for EnableVpcClassicLink.

" }, "EnableVpcClassicLinkResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of EnableVpcClassicLink.

" }, "EventCode":{ "type":"string", "enum":[ "instance-reboot", "system-reboot", "system-maintenance", "instance-retirement", "instance-stop" ] }, "EventInformation":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance. This information is available only for instanceChange events.

", "locationName":"instanceId" }, "EventSubType":{ "shape":"String", "documentation":"

The event.

The following are the error events.

  • iamFleetRoleInvalid - The Spot fleet did not have the required permissions either to launch or terminate an instance.

  • launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.

  • spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.

  • spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot instances that you can launch.

The following are the fleetRequestChange events.

  • active - The Spot fleet has been validated and Amazon EC2 is attempting to maintain the target number of running Spot instances.

  • cancelled - The Spot fleet is canceled and has no running Spot instances. The Spot fleet will be deleted two days after its instances were terminated.

  • cancelled_running - The Spot fleet is canceled and will not launch additional Spot instances, but its existing Spot instances continue to run until they are interrupted or terminated.

  • cancelled_terminating - The Spot fleet is canceled and its Spot instances are terminating.

  • expired - The Spot fleet request has expired. A subsequent event indicates that the instances were terminated, if the request was created with TerminateInstancesWithExpiration set.

  • modify_in_progress - A request to modify the Spot fleet request was accepted and is in progress.

  • modify_successful - The Spot fleet request was modified.

  • price_update - The bid price for a launch configuration was adjusted because it was too high. This change is permanent.

  • submitted - The Spot fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of Spot instances.

The following are the instanceChange events.

  • launched - A bid was fulfilled and a new instance was launched.

  • terminated - An instance was terminated by the user.

", "locationName":"eventSubType" }, "EventDescription":{ "shape":"String", "documentation":"

The description of the event.

", "locationName":"eventDescription" } }, "documentation":"

Describes a Spot fleet event.

" }, "EventType":{ "type":"string", "enum":[ "instanceChange", "fleetRequestChange", "error" ] }, "ExcessCapacityTerminationPolicy":{ "type":"string", "enum":[ "noTermination", "default" ] }, "ExecutableByStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ExecutableBy" } }, "ExportEnvironment":{ "type":"string", "enum":[ "citrix", "vmware", "microsoft" ] }, "ExportTask":{ "type":"structure", "members":{ "ExportTaskId":{ "shape":"String", "documentation":"

The ID of the export task.

", "locationName":"exportTaskId" }, "Description":{ "shape":"String", "documentation":"

A description of the resource being exported.

", "locationName":"description" }, "State":{ "shape":"ExportTaskState", "documentation":"

The state of the export task.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message related to the export task.

", "locationName":"statusMessage" }, "InstanceExportDetails":{ "shape":"InstanceExportDetails", "documentation":"

Information about the instance to export.

", "locationName":"instanceExport" }, "ExportToS3Task":{ "shape":"ExportToS3Task", "documentation":"

Information about the export task.

", "locationName":"exportToS3" } }, "documentation":"

Describes an instance export task.

" }, "ExportTaskIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ExportTaskId" } }, "ExportTaskList":{ "type":"list", "member":{ "shape":"ExportTask", "locationName":"item" } }, "ExportTaskState":{ "type":"string", "enum":[ "active", "cancelling", "cancelled", "completed" ] }, "ExportToS3Task":{ "type":"structure", "members":{ "DiskImageFormat":{ "shape":"DiskImageFormat", "documentation":"

The format for the exported image.

", "locationName":"diskImageFormat" }, "ContainerFormat":{ "shape":"ContainerFormat", "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", "locationName":"containerFormat" }, "S3Bucket":{ "shape":"String", "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", "locationName":"s3Bucket" }, "S3Key":{ "shape":"String", "documentation":"

The encryption key for your S3 bucket.

", "locationName":"s3Key" } }, "documentation":"

Describes the format and location for an instance export task.

" }, "ExportToS3TaskSpecification":{ "type":"structure", "members":{ "DiskImageFormat":{ "shape":"DiskImageFormat", "documentation":"

The format for the exported image.

", "locationName":"diskImageFormat" }, "ContainerFormat":{ "shape":"ContainerFormat", "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", "locationName":"containerFormat" }, "S3Bucket":{ "shape":"String", "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", "locationName":"s3Bucket" }, "S3Prefix":{ "shape":"String", "documentation":"

The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

", "locationName":"s3Prefix" } }, "documentation":"

Describes an instance export task.

" }, "Filter":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the filter. Filter names are case-sensitive.

" }, "Values":{ "shape":"ValueStringList", "documentation":"

One or more filter values. Filter values are case-sensitive.

", "locationName":"Value" } }, "documentation":"

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.

" }, "FilterList":{ "type":"list", "member":{ "shape":"Filter", "locationName":"Filter" } }, "FleetType":{ "type":"string", "enum":[ "request", "maintain" ] }, "Float":{"type":"float"}, "FlowLog":{ "type":"structure", "members":{ "CreationTime":{ "shape":"DateTime", "documentation":"

The date and time the flow log was created.

", "locationName":"creationTime" }, "FlowLogId":{ "shape":"String", "documentation":"

The flow log ID.

", "locationName":"flowLogId" }, "FlowLogStatus":{ "shape":"String", "documentation":"

The status of the flow log (ACTIVE).

", "locationName":"flowLogStatus" }, "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource on which the flow log was created.

", "locationName":"resourceId" }, "TrafficType":{ "shape":"TrafficType", "documentation":"

The type of traffic captured for the flow log.

", "locationName":"trafficType" }, "LogGroupName":{ "shape":"String", "documentation":"

The name of the flow log group.

", "locationName":"logGroupName" }, "DeliverLogsStatus":{ "shape":"String", "documentation":"

The status of the logs delivery (SUCCESS | FAILED).

", "locationName":"deliverLogsStatus" }, "DeliverLogsErrorMessage":{ "shape":"String", "documentation":"

Information about the error that occurred. Rate limited indicates that CloudWatch logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of CloudWatch Logs log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.

", "locationName":"deliverLogsErrorMessage" }, "DeliverLogsPermissionArn":{ "shape":"String", "documentation":"

The ARN of the IAM role that posts logs to CloudWatch Logs.

", "locationName":"deliverLogsPermissionArn" } }, "documentation":"

Describes a flow log.

" }, "FlowLogSet":{ "type":"list", "member":{ "shape":"FlowLog", "locationName":"item" } }, "FlowLogsResourceType":{ "type":"string", "enum":[ "VPC", "Subnet", "NetworkInterface" ] }, "GatewayType":{ "type":"string", "enum":["ipsec.1"] }, "GetConsoleOutputRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" } }, "documentation":"

Contains the parameters for GetConsoleOutput.

" }, "GetConsoleOutputResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The time the output was last updated.

", "locationName":"timestamp" }, "Output":{ "shape":"String", "documentation":"

The console output, Base64-encoded. If using a command line tool, the tool decodes the output for you.

", "locationName":"output" } }, "documentation":"

Contains the output of GetConsoleOutput.

" }, "GetConsoleScreenshotRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "WakeUp":{ "shape":"Boolean", "documentation":"

When set to true, acts as keystroke input and wakes up an instance that's in standby or \"sleep\" mode.

" } }, "documentation":"

Contains the parameters for the request.

" }, "GetConsoleScreenshotResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "ImageData":{ "shape":"String", "documentation":"

The data that comprises the image.

", "locationName":"imageData" } }, "documentation":"

Contains the output of the request.

" }, "GetHostReservationPurchasePreviewRequest":{ "type":"structure", "required":[ "OfferingId", "HostIdSet" ], "members":{ "OfferingId":{ "shape":"String", "documentation":"

The offering ID of the reservation.

" }, "HostIdSet":{ "shape":"RequestHostIdSet", "documentation":"

The ID/s of the Dedicated Host/s that the reservation will be associated with.

" } } }, "GetHostReservationPurchasePreviewResult":{ "type":"structure", "members":{ "Purchase":{ "shape":"PurchaseSet", "documentation":"

The purchase information of the Dedicated Host Reservation and the Dedicated Hosts associated with it.

", "locationName":"purchase" }, "TotalUpfrontPrice":{ "shape":"String", "documentation":"

The potential total upfront price. This is billed immediately.

", "locationName":"totalUpfrontPrice" }, "TotalHourlyPrice":{ "shape":"String", "documentation":"

The potential total hourly price of the reservation per hour.

", "locationName":"totalHourlyPrice" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } } }, "GetPasswordDataRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the Windows instance.

" } }, "documentation":"

Contains the parameters for GetPasswordData.

" }, "GetPasswordDataResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the Windows instance.

", "locationName":"instanceId" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The time the data was last updated.

", "locationName":"timestamp" }, "PasswordData":{ "shape":"String", "documentation":"

The password of the instance.

", "locationName":"passwordData" } }, "documentation":"

Contains the output of GetPasswordData.

" }, "GetReservedInstancesExchangeQuoteRequest":{ "type":"structure", "required":["ReservedInstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ReservedInstanceIds":{ "shape":"ReservedInstanceIdSet", "documentation":"

The ID/s of the Convertible Reserved Instances you want to exchange.

", "locationName":"ReservedInstanceId" }, "TargetConfigurations":{ "shape":"TargetConfigurationRequestSet", "documentation":"

The configuration requirements of the Convertible Reserved Instances you want in exchange for your current Convertible Reserved Instances.

", "locationName":"TargetConfiguration" } }, "documentation":"

Contains the parameters for GetReservedInstanceExchangeQuote.

" }, "GetReservedInstancesExchangeQuoteResult":{ "type":"structure", "members":{ "ReservedInstanceValueSet":{ "shape":"ReservedInstanceReservationValueSet", "documentation":"

The configuration of your Convertible Reserved Instances.

", "locationName":"reservedInstanceValueSet" }, "ReservedInstanceValueRollup":{ "shape":"ReservationValue", "locationName":"reservedInstanceValueRollup" }, "TargetConfigurationValueSet":{ "shape":"TargetReservationValueSet", "documentation":"

The values of the target Convertible Reserved Instances.

", "locationName":"targetConfigurationValueSet" }, "TargetConfigurationValueRollup":{ "shape":"ReservationValue", "locationName":"targetConfigurationValueRollup" }, "PaymentDue":{ "shape":"String", "documentation":"

The total true upfront charge for the exchange.

", "locationName":"paymentDue" }, "CurrencyCode":{ "shape":"String", "documentation":"

The currency of the transaction.

", "locationName":"currencyCode" }, "OutputReservedInstancesWillExpireAt":{ "shape":"DateTime", "documentation":"

The new end date of the reservation term.

", "locationName":"outputReservedInstancesWillExpireAt" }, "IsValidExchange":{ "shape":"Boolean", "documentation":"

If true, the exchange is valid. If false, the exchange cannot be performed.

", "locationName":"isValidExchange" }, "ValidationFailureReason":{ "shape":"String", "documentation":"

Describes the reason why the exchange can not be completed.

", "locationName":"validationFailureReason" } }, "documentation":"

Contains the output of GetReservedInstancesExchangeQuote.

" }, "GroupIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"groupId" } }, "GroupIdentifier":{ "type":"structure", "members":{ "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } }, "documentation":"

Describes a security group.

" }, "GroupIdentifierList":{ "type":"list", "member":{ "shape":"GroupIdentifier", "locationName":"item" } }, "GroupIds":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "GroupNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"GroupName" } }, "HistoryRecord":{ "type":"structure", "required":[ "Timestamp", "EventType", "EventInformation" ], "members":{ "Timestamp":{ "shape":"DateTime", "documentation":"

The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"timestamp" }, "EventType":{ "shape":"EventType", "documentation":"

The event type.

  • error - Indicates an error with the Spot fleet request.

  • fleetRequestChange - Indicates a change in the status or configuration of the Spot fleet request.

  • instanceChange - Indicates that an instance was launched or terminated.

", "locationName":"eventType" }, "EventInformation":{ "shape":"EventInformation", "documentation":"

Information about the event.

", "locationName":"eventInformation" } }, "documentation":"

Describes an event in the history of the Spot fleet request.

" }, "HistoryRecords":{ "type":"list", "member":{ "shape":"HistoryRecord", "locationName":"item" } }, "Host":{ "type":"structure", "members":{ "HostId":{ "shape":"String", "documentation":"

The ID of the Dedicated Host.

", "locationName":"hostId" }, "AutoPlacement":{ "shape":"AutoPlacement", "documentation":"

Whether auto-placement is on or off.

", "locationName":"autoPlacement" }, "HostReservationId":{ "shape":"String", "documentation":"

The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation.

", "locationName":"hostReservationId" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"clientToken" }, "HostProperties":{ "shape":"HostProperties", "documentation":"

The hardware specifications of the Dedicated Host.

", "locationName":"hostProperties" }, "State":{ "shape":"AllocationState", "documentation":"

The Dedicated Host's state.

", "locationName":"state" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the Dedicated Host.

", "locationName":"availabilityZone" }, "Instances":{ "shape":"HostInstanceList", "documentation":"

The IDs and instance type that are currently running on the Dedicated Host.

", "locationName":"instances" }, "AvailableCapacity":{ "shape":"AvailableCapacity", "documentation":"

The number of new instances that can be launched onto the Dedicated Host.

", "locationName":"availableCapacity" } }, "documentation":"

Describes the properties of the Dedicated Host.

" }, "HostInstance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

the IDs of instances that are running on the Dedicated Host.

", "locationName":"instanceId" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type size (for example, m3.medium) of the running instance.

", "locationName":"instanceType" } }, "documentation":"

Describes an instance running on a Dedicated Host.

" }, "HostInstanceList":{ "type":"list", "member":{ "shape":"HostInstance", "locationName":"item" } }, "HostList":{ "type":"list", "member":{ "shape":"Host", "locationName":"item" } }, "HostOffering":{ "type":"structure", "members":{ "OfferingId":{ "shape":"String", "documentation":"

The ID of the offering.

", "locationName":"offeringId" }, "InstanceFamily":{ "shape":"String", "documentation":"

The instance family of the offering.

", "locationName":"instanceFamily" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"

The available payment option.

", "locationName":"paymentOption" }, "UpfrontPrice":{ "shape":"String", "documentation":"

The upfront price of the offering. Does not apply to No Upfront offerings.

", "locationName":"upfrontPrice" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price of the offering.

", "locationName":"hourlyPrice" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the offering.

", "locationName":"currencyCode" }, "Duration":{ "shape":"Integer", "documentation":"

The duration of the offering (in seconds).

", "locationName":"duration" } }, "documentation":"

Details about the Dedicated Host Reservation offering.

" }, "HostOfferingSet":{ "type":"list", "member":{"shape":"HostOffering"} }, "HostProperties":{ "type":"structure", "members":{ "Sockets":{ "shape":"Integer", "documentation":"

The number of sockets on the Dedicated Host.

", "locationName":"sockets" }, "Cores":{ "shape":"Integer", "documentation":"

The number of cores on the Dedicated Host.

", "locationName":"cores" }, "TotalVCpus":{ "shape":"Integer", "documentation":"

The number of vCPUs on the Dedicated Host.

", "locationName":"totalVCpus" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type size that the Dedicated Host supports (for example, m3.medium).

", "locationName":"instanceType" } }, "documentation":"

Describes properties of a Dedicated Host.

" }, "HostReservation":{ "type":"structure", "members":{ "HostReservationId":{ "shape":"String", "documentation":"

The ID of the reservation that specifies the associated Dedicated Hosts.

", "locationName":"hostReservationId" }, "HostIdSet":{ "shape":"ResponseHostIdSet", "documentation":"

The IDs of the Dedicated Hosts associated with the reservation.

", "locationName":"hostIdSet" }, "OfferingId":{ "shape":"String", "documentation":"

The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.

", "locationName":"offeringId" }, "InstanceFamily":{ "shape":"String", "documentation":"

The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.

", "locationName":"instanceFamily" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"

The payment option selected for this reservation.

", "locationName":"paymentOption" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price of the reservation.

", "locationName":"hourlyPrice" }, "UpfrontPrice":{ "shape":"String", "documentation":"

The upfront price of the reservation.

", "locationName":"upfrontPrice" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "Count":{ "shape":"Integer", "documentation":"

The number of Dedicated Hosts the reservation is associated with.

", "locationName":"count" }, "Duration":{ "shape":"Integer", "documentation":"

The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).

", "locationName":"duration" }, "End":{ "shape":"DateTime", "documentation":"

The date and time that the reservation ends.

", "locationName":"end" }, "Start":{ "shape":"DateTime", "documentation":"

The date and time that the reservation started.

", "locationName":"start" }, "State":{ "shape":"ReservationState", "documentation":"

The state of the reservation.

", "locationName":"state" } }, "documentation":"

Details about the Dedicated Host Reservation and associated Dedicated Hosts.

" }, "HostReservationIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "HostReservationSet":{ "type":"list", "member":{"shape":"HostReservation"} }, "HostTenancy":{ "type":"string", "enum":[ "dedicated", "host" ] }, "HypervisorType":{ "type":"string", "enum":[ "ovm", "xen" ] }, "IamInstanceProfile":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", "locationName":"arn" }, "Id":{ "shape":"String", "documentation":"

The ID of the instance profile.

", "locationName":"id" } }, "documentation":"

Describes an IAM instance profile.

" }, "IamInstanceProfileSpecification":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", "locationName":"arn" }, "Name":{ "shape":"String", "documentation":"

The name of the instance profile.

", "locationName":"name" } }, "documentation":"

Describes an IAM instance profile.

" }, "IcmpTypeCode":{ "type":"structure", "members":{ "Type":{ "shape":"Integer", "documentation":"

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", "locationName":"type" }, "Code":{ "shape":"Integer", "documentation":"

The ICMP type. A value of -1 means all types.

", "locationName":"code" } }, "documentation":"

Describes the ICMP type and code.

" }, "IdFormat":{ "type":"structure", "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource.

", "locationName":"resource" }, "UseLongIds":{ "shape":"Boolean", "documentation":"

Indicates whether longer IDs (17-character IDs) are enabled for the resource.

", "locationName":"useLongIds" }, "Deadline":{ "shape":"DateTime", "documentation":"

The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.

", "locationName":"deadline" } }, "documentation":"

Describes the ID format for a resource.

" }, "IdFormatList":{ "type":"list", "member":{ "shape":"IdFormat", "locationName":"item" } }, "Image":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "ImageLocation":{ "shape":"String", "documentation":"

The location of the AMI.

", "locationName":"imageLocation" }, "State":{ "shape":"ImageState", "documentation":"

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", "locationName":"imageState" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the image owner.

", "locationName":"imageOwnerId" }, "CreationDate":{ "shape":"String", "documentation":"

The date and time the image was created.

", "locationName":"creationDate" }, "Public":{ "shape":"Boolean", "documentation":"

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

", "locationName":"isPublic" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

Any product codes associated with the AMI.

", "locationName":"productCodes" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the image.

", "locationName":"architecture" }, "ImageType":{ "shape":"ImageTypeValues", "documentation":"

The type of image.

", "locationName":"imageType" }, "KernelId":{ "shape":"String", "documentation":"

The kernel associated with the image, if any. Only applicable for machine images.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The RAM disk associated with the image, if any. Only applicable for machine images.

", "locationName":"ramdiskId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The value is Windows for Windows AMIs; otherwise blank.

", "locationName":"platform" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", "locationName":"sriovNetSupport" }, "EnaSupport":{ "shape":"Boolean", "documentation":"

Specifies whether enhanced networking with ENA is enabled.

", "locationName":"enaSupport" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason for the state change.

", "locationName":"stateReason" }, "ImageOwnerAlias":{ "shape":"String", "documentation":"

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

", "locationName":"imageOwnerAlias" }, "Name":{ "shape":"String", "documentation":"

The name of the AMI that was provided during image creation.

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

The description of the AMI that was provided during image creation.

", "locationName":"description" }, "RootDeviceType":{ "shape":"DeviceType", "documentation":"

The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

", "locationName":"rootDeviceType" }, "RootDeviceName":{ "shape":"String", "documentation":"

The device name of the root device (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

Any block device mapping entries.

", "locationName":"blockDeviceMapping" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The type of virtualization of the AMI.

", "locationName":"virtualizationType" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the image.

", "locationName":"tagSet" }, "Hypervisor":{ "shape":"HypervisorType", "documentation":"

The hypervisor type of the image.

", "locationName":"hypervisor" } }, "documentation":"

Describes an image.

" }, "ImageAttribute":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "LaunchPermissions":{ "shape":"LaunchPermissionList", "documentation":"

One or more launch permissions.

", "locationName":"launchPermission" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

One or more product codes.

", "locationName":"productCodes" }, "KernelId":{ "shape":"AttributeValue", "documentation":"

The kernel ID.

", "locationName":"kernel" }, "RamdiskId":{ "shape":"AttributeValue", "documentation":"

The RAM disk ID.

", "locationName":"ramdisk" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the AMI.

", "locationName":"description" }, "SriovNetSupport":{ "shape":"AttributeValue", "documentation":"

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", "locationName":"sriovNetSupport" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" } }, "documentation":"

Describes an image attribute.

" }, "ImageAttributeName":{ "type":"string", "enum":[ "description", "kernel", "ramdisk", "launchPermission", "productCodes", "blockDeviceMapping", "sriovNetSupport" ] }, "ImageDiskContainer":{ "type":"structure", "members":{ "Description":{ "shape":"String", "documentation":"

The description of the disk image.

" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" }, "Url":{ "shape":"String", "documentation":"

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)

" }, "UserBucket":{ "shape":"UserBucket", "documentation":"

The S3 bucket for the disk image.

" }, "DeviceName":{ "shape":"String", "documentation":"

The block device mapping for the disk.

" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot to be used for importing the snapshot.

" } }, "documentation":"

Describes the disk container object for an import image task.

" }, "ImageDiskContainerList":{ "type":"list", "member":{ "shape":"ImageDiskContainer", "locationName":"item" } }, "ImageIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ImageId" } }, "ImageList":{ "type":"list", "member":{ "shape":"Image", "locationName":"item" } }, "ImageState":{ "type":"string", "enum":[ "pending", "available", "invalid", "deregistered", "transient", "failed", "error" ] }, "ImageTypeValues":{ "type":"string", "enum":[ "machine", "kernel", "ramdisk" ] }, "ImportImageRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "Description":{ "shape":"String", "documentation":"

A description string for the import image task.

" }, "DiskContainers":{ "shape":"ImageDiskContainerList", "documentation":"

Information about the disk containers.

", "locationName":"DiskContainer" }, "LicenseType":{ "shape":"String", "documentation":"

The license type to be used for the Amazon Machine Image (AMI) after importing.

Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

Valid values: AWS | BYOL

" }, "Hypervisor":{ "shape":"String", "documentation":"

The target hypervisor platform.

Valid values: xen

" }, "Architecture":{ "shape":"String", "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

" }, "Platform":{ "shape":"String", "documentation":"

The operating system of the virtual machine.

Valid values: Windows | Linux

" }, "ClientData":{ "shape":"ClientData", "documentation":"

The client-specific data.

" }, "ClientToken":{ "shape":"String", "documentation":"

The token to enable idempotency for VM import requests.

" }, "RoleName":{ "shape":"String", "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" } }, "documentation":"

Contains the parameters for ImportImage.

" }, "ImportImageResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The task ID of the import image task.

", "locationName":"importTaskId" }, "Architecture":{ "shape":"String", "documentation":"

The architecture of the virtual machine.

", "locationName":"architecture" }, "LicenseType":{ "shape":"String", "documentation":"

The license type of the virtual machine.

", "locationName":"licenseType" }, "Platform":{ "shape":"String", "documentation":"

The operating system of the virtual machine.

", "locationName":"platform" }, "Hypervisor":{ "shape":"String", "documentation":"

The target hypervisor of the import task.

", "locationName":"hypervisor" }, "Description":{ "shape":"String", "documentation":"

A description of the import task.

", "locationName":"description" }, "SnapshotDetails":{ "shape":"SnapshotDetailList", "documentation":"

Information about the snapshots.

", "locationName":"snapshotDetailSet" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the Amazon Machine Image (AMI) created by the import task.

", "locationName":"imageId" }, "Progress":{ "shape":"String", "documentation":"

The progress of the task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message of the import task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status of the task.

", "locationName":"status" } }, "documentation":"

Contains the output for ImportImage.

" }, "ImportImageTask":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import image task.

", "locationName":"importTaskId" }, "Architecture":{ "shape":"String", "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

", "locationName":"architecture" }, "LicenseType":{ "shape":"String", "documentation":"

The license type of the virtual machine.

", "locationName":"licenseType" }, "Platform":{ "shape":"String", "documentation":"

The description string for the import image task.

", "locationName":"platform" }, "Hypervisor":{ "shape":"String", "documentation":"

The target hypervisor for the import task.

Valid values: xen

", "locationName":"hypervisor" }, "Description":{ "shape":"String", "documentation":"

A description of the import task.

", "locationName":"description" }, "SnapshotDetails":{ "shape":"SnapshotDetailList", "documentation":"

Information about the snapshots.

", "locationName":"snapshotDetailSet" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

", "locationName":"imageId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of progress of the import image task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A descriptive status message for the import image task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status for the import image task.

", "locationName":"status" } }, "documentation":"

Describes an import image task.

" }, "ImportImageTaskList":{ "type":"list", "member":{ "shape":"ImportImageTask", "locationName":"item" } }, "ImportInstanceLaunchSpecification":{ "type":"structure", "members":{ "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the instance.

", "locationName":"architecture" }, "GroupNames":{ "shape":"SecurityGroupStringList", "documentation":"

One or more security group names.

", "locationName":"GroupName" }, "GroupIds":{ "shape":"SecurityGroupIdStringList", "documentation":"

One or more security group IDs.

", "locationName":"GroupId" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "UserData":{ "shape":"UserData", "documentation":"

The user data to make available to the instance. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"userData" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.

", "locationName":"instanceType" }, "Placement":{ "shape":"Placement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "Monitoring":{ "shape":"Boolean", "documentation":"

Indicates whether monitoring is enabled.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] An available IP address from the IP address range of the subnet.

", "locationName":"privateIpAddress" } }, "documentation":"

Describes the launch specification for VM import.

" }, "ImportInstanceRequest":{ "type":"structure", "required":["Platform"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Description":{ "shape":"String", "documentation":"

A description for the instance being imported.

", "locationName":"description" }, "LaunchSpecification":{ "shape":"ImportInstanceLaunchSpecification", "documentation":"

The launch specification.

", "locationName":"launchSpecification" }, "DiskImages":{ "shape":"DiskImageList", "documentation":"

The disk image.

", "locationName":"diskImage" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The instance operating system.

", "locationName":"platform" } }, "documentation":"

Contains the parameters for ImportInstance.

" }, "ImportInstanceResult":{ "type":"structure", "members":{ "ConversionTask":{ "shape":"ConversionTask", "documentation":"

Information about the conversion task.

", "locationName":"conversionTask" } }, "documentation":"

Contains the output for ImportInstance.

" }, "ImportInstanceTaskDetails":{ "type":"structure", "required":["Volumes"], "members":{ "Volumes":{ "shape":"ImportInstanceVolumeDetailSet", "documentation":"

One or more volumes.

", "locationName":"volumes" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The instance operating system.

", "locationName":"platform" }, "Description":{ "shape":"String", "documentation":"

A description of the task.

", "locationName":"description" } }, "documentation":"

Describes an import instance task.

" }, "ImportInstanceVolumeDetailItem":{ "type":"structure", "required":[ "BytesConverted", "AvailabilityZone", "Image", "Volume", "Status" ], "members":{ "BytesConverted":{ "shape":"Long", "documentation":"

The number of bytes converted so far.

", "locationName":"bytesConverted" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the resulting instance will reside.

", "locationName":"availabilityZone" }, "Image":{ "shape":"DiskImageDescription", "documentation":"

The image.

", "locationName":"image" }, "Volume":{ "shape":"DiskImageVolumeDescription", "documentation":"

The volume.

", "locationName":"volume" }, "Status":{ "shape":"String", "documentation":"

The status of the import of this particular disk image.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The status information or errors related to the disk image.

", "locationName":"statusMessage" }, "Description":{ "shape":"String", "documentation":"

A description of the task.

", "locationName":"description" } }, "documentation":"

Describes an import volume task.

" }, "ImportInstanceVolumeDetailSet":{ "type":"list", "member":{ "shape":"ImportInstanceVolumeDetailItem", "locationName":"item" } }, "ImportKeyPairRequest":{ "type":"structure", "required":[ "KeyName", "PublicKeyMaterial" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

A unique name for the key pair.

", "locationName":"keyName" }, "PublicKeyMaterial":{ "shape":"Blob", "documentation":"

The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.

", "locationName":"publicKeyMaterial" } }, "documentation":"

Contains the parameters for ImportKeyPair.

" }, "ImportKeyPairResult":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The key pair name you provided.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", "locationName":"keyFingerprint" } }, "documentation":"

Contains the output of ImportKeyPair.

" }, "ImportSnapshotRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "Description":{ "shape":"String", "documentation":"

The description string for the import snapshot task.

" }, "DiskContainer":{ "shape":"SnapshotDiskContainer", "documentation":"

Information about the disk container.

" }, "ClientData":{ "shape":"ClientData", "documentation":"

The client-specific data.

" }, "ClientToken":{ "shape":"String", "documentation":"

Token to enable idempotency for VM import requests.

" }, "RoleName":{ "shape":"String", "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" } }, "documentation":"

Contains the parameters for ImportSnapshot.

" }, "ImportSnapshotResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import snapshot task.

", "locationName":"importTaskId" }, "SnapshotTaskDetail":{ "shape":"SnapshotTaskDetail", "documentation":"

Information about the import snapshot task.

", "locationName":"snapshotTaskDetail" }, "Description":{ "shape":"String", "documentation":"

A description of the import snapshot task.

", "locationName":"description" } }, "documentation":"

Contains the output for ImportSnapshot.

" }, "ImportSnapshotTask":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import snapshot task.

", "locationName":"importTaskId" }, "SnapshotTaskDetail":{ "shape":"SnapshotTaskDetail", "documentation":"

Describes an import snapshot task.

", "locationName":"snapshotTaskDetail" }, "Description":{ "shape":"String", "documentation":"

A description of the import snapshot task.

", "locationName":"description" } }, "documentation":"

Describes an import snapshot task.

" }, "ImportSnapshotTaskList":{ "type":"list", "member":{ "shape":"ImportSnapshotTask", "locationName":"item" } }, "ImportTaskIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"ImportTaskId" } }, "ImportVolumeRequest":{ "type":"structure", "required":[ "AvailabilityZone", "Image", "Volume" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the resulting EBS volume.

", "locationName":"availabilityZone" }, "Image":{ "shape":"DiskImageDetail", "documentation":"

The disk image.

", "locationName":"image" }, "Description":{ "shape":"String", "documentation":"

A description of the volume.

", "locationName":"description" }, "Volume":{ "shape":"VolumeDetail", "documentation":"

The volume size.

", "locationName":"volume" } }, "documentation":"

Contains the parameters for ImportVolume.

" }, "ImportVolumeResult":{ "type":"structure", "members":{ "ConversionTask":{ "shape":"ConversionTask", "documentation":"

Information about the conversion task.

", "locationName":"conversionTask" } }, "documentation":"

Contains the output for ImportVolume.

" }, "ImportVolumeTaskDetails":{ "type":"structure", "required":[ "BytesConverted", "AvailabilityZone", "Image", "Volume" ], "members":{ "BytesConverted":{ "shape":"Long", "documentation":"

The number of bytes converted so far.

", "locationName":"bytesConverted" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the resulting volume will reside.

", "locationName":"availabilityZone" }, "Description":{ "shape":"String", "documentation":"

The description you provided when starting the import volume task.

", "locationName":"description" }, "Image":{ "shape":"DiskImageDescription", "documentation":"

The image.

", "locationName":"image" }, "Volume":{ "shape":"DiskImageVolumeDescription", "documentation":"

The volume.

", "locationName":"volume" } }, "documentation":"

Describes an import volume task.

" }, "Instance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI used to launch the instance.

", "locationName":"imageId" }, "State":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

", "locationName":"instanceState" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

", "locationName":"privateDnsName" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

", "locationName":"dnsName" }, "StateTransitionReason":{ "shape":"String", "documentation":"

The reason for the most recent state transition. This might be an empty string.

", "locationName":"reason" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair, if this instance was launched with an associated key pair.

", "locationName":"keyName" }, "AmiLaunchIndex":{ "shape":"Integer", "documentation":"

The AMI launch index, which can be used to find this instance in the launch group.

", "locationName":"amiLaunchIndex" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

The product codes attached to this instance, if applicable.

", "locationName":"productCodes" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "LaunchTime":{ "shape":"DateTime", "documentation":"

The time the instance was launched.

", "locationName":"launchTime" }, "Placement":{ "shape":"Placement", "documentation":"

The location where the instance launched, if applicable.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The kernel associated with this instance, if applicable.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The RAM disk associated with this instance, if applicable.

", "locationName":"ramdiskId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The value is Windows for Windows instances; otherwise blank.

", "locationName":"platform" }, "Monitoring":{ "shape":"Monitoring", "documentation":"

The monitoring information for the instance.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet in which the instance is running.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC in which the instance is running.

", "locationName":"vpcId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address assigned to the instance.

", "locationName":"privateIpAddress" }, "PublicIpAddress":{ "shape":"String", "documentation":"

The public IP address assigned to the instance, if applicable.

", "locationName":"ipAddress" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason for the most recent state transition.

", "locationName":"stateReason" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the image.

", "locationName":"architecture" }, "RootDeviceType":{ "shape":"DeviceType", "documentation":"

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

", "locationName":"rootDeviceType" }, "RootDeviceName":{ "shape":"String", "documentation":"

The root device name (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"

Any block device mapping entries for the instance.

", "locationName":"blockDeviceMapping" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The virtualization type of the instance.

", "locationName":"virtualizationType" }, "InstanceLifecycle":{ "shape":"InstanceLifecycleType", "documentation":"

Indicates whether this is a Spot instance or a Scheduled Instance.

", "locationName":"instanceLifecycle" }, "SpotInstanceRequestId":{ "shape":"String", "documentation":"

If the request is a Spot instance request, the ID of the request.

", "locationName":"spotInstanceRequestId" }, "ClientToken":{ "shape":"String", "documentation":"

The idempotency token you provided when you launched the instance, if applicable.

", "locationName":"clientToken" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the instance.

", "locationName":"tagSet" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups for the instance.

", "locationName":"groupSet" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", "locationName":"sourceDestCheck" }, "Hypervisor":{ "shape":"HypervisorType", "documentation":"

The hypervisor type of the instance.

", "locationName":"hypervisor" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceList", "documentation":"

[EC2-VPC] One or more network interfaces for the instance.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfile", "documentation":"

The IAM instance profile associated with the instance, if applicable.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", "locationName":"sriovNetSupport" }, "EnaSupport":{ "shape":"Boolean", "documentation":"

Specifies whether enhanced networking with ENA is enabled.

", "locationName":"enaSupport" } }, "documentation":"

Describes an instance.

" }, "InstanceAttribute":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "InstanceType":{ "shape":"AttributeValue", "documentation":"

The instance type.

", "locationName":"instanceType" }, "KernelId":{ "shape":"AttributeValue", "documentation":"

The kernel ID.

", "locationName":"kernel" }, "RamdiskId":{ "shape":"AttributeValue", "documentation":"

The RAM disk ID.

", "locationName":"ramdisk" }, "UserData":{ "shape":"AttributeValue", "documentation":"

The user data.

", "locationName":"userData" }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", "documentation":"

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ "shape":"AttributeValue", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "RootDeviceName":{ "shape":"AttributeValue", "documentation":"

The name of the root device (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"

The block device mapping of the instance.

", "locationName":"blockDeviceMapping" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" }, "EbsOptimized":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instance is optimized for EBS I/O.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"AttributeValue", "documentation":"

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", "locationName":"sriovNetSupport" }, "EnaSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether enhanced networking with ENA is enabled.

", "locationName":"enaSupport" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

The security groups associated with the instance.

", "locationName":"groupSet" } }, "documentation":"

Describes an instance attribute.

" }, "InstanceAttributeName":{ "type":"string", "enum":[ "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "rootDeviceName", "blockDeviceMapping", "productCodes", "sourceDestCheck", "groupSet", "ebsOptimized", "sriovNetSupport", "enaSupport" ] }, "InstanceBlockDeviceMapping":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsInstanceBlockDevice", "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", "locationName":"ebs" } }, "documentation":"

Describes a block device mapping.

" }, "InstanceBlockDeviceMappingList":{ "type":"list", "member":{ "shape":"InstanceBlockDeviceMapping", "locationName":"item" } }, "InstanceBlockDeviceMappingSpecification":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsInstanceBlockDeviceSpecification", "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", "locationName":"ebs" }, "VirtualName":{ "shape":"String", "documentation":"

The virtual device name.

", "locationName":"virtualName" }, "NoDevice":{ "shape":"String", "documentation":"

suppress the specified device included in the block device mapping.

", "locationName":"noDevice" } }, "documentation":"

Describes a block device mapping entry.

" }, "InstanceBlockDeviceMappingSpecificationList":{ "type":"list", "member":{ "shape":"InstanceBlockDeviceMappingSpecification", "locationName":"item" } }, "InstanceCapacity":{ "type":"structure", "members":{ "InstanceType":{ "shape":"String", "documentation":"

The instance type size supported by the Dedicated Host.

", "locationName":"instanceType" }, "AvailableCapacity":{ "shape":"Integer", "documentation":"

The number of instances that can still be launched onto the Dedicated Host.

", "locationName":"availableCapacity" }, "TotalCapacity":{ "shape":"Integer", "documentation":"

The total number of instances that can be launched onto the Dedicated Host.

", "locationName":"totalCapacity" } }, "documentation":"

Information about the instance type that the Dedicated Host supports.

" }, "InstanceCount":{ "type":"structure", "members":{ "State":{ "shape":"ListingState", "documentation":"

The states of the listed Reserved Instances.

", "locationName":"state" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of listed Reserved Instances in the state specified by the state.

", "locationName":"instanceCount" } }, "documentation":"

Describes a Reserved Instance listing state.

" }, "InstanceCountList":{ "type":"list", "member":{ "shape":"InstanceCount", "locationName":"item" } }, "InstanceExportDetails":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the resource being exported.

", "locationName":"instanceId" }, "TargetEnvironment":{ "shape":"ExportEnvironment", "documentation":"

The target virtualization environment.

", "locationName":"targetEnvironment" } }, "documentation":"

Describes an instance to export.

" }, "InstanceIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "InstanceIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"InstanceId" } }, "InstanceLifecycleType":{ "type":"string", "enum":[ "spot", "scheduled" ] }, "InstanceList":{ "type":"list", "member":{ "shape":"Instance", "locationName":"item" } }, "InstanceMonitoring":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Monitoring":{ "shape":"Monitoring", "documentation":"

The monitoring information.

", "locationName":"monitoring" } }, "documentation":"

Describes the monitoring information of the instance.

" }, "InstanceMonitoringList":{ "type":"list", "member":{ "shape":"InstanceMonitoring", "locationName":"item" } }, "InstanceNetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Description":{ "shape":"String", "documentation":"

The description.

", "locationName":"description" }, "OwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that created the network interface.

", "locationName":"ownerId" }, "Status":{ "shape":"NetworkInterfaceStatus", "documentation":"

The status of the network interface.

", "locationName":"status" }, "MacAddress":{ "shape":"String", "documentation":"

The MAC address.

", "locationName":"macAddress" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Indicates whether to validate network traffic to or from this network interface.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups.

", "locationName":"groupSet" }, "Attachment":{ "shape":"InstanceNetworkInterfaceAttachment", "documentation":"

The network interface attachment.

", "locationName":"attachment" }, "Association":{ "shape":"InstanceNetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP associated with the network interface.

", "locationName":"association" }, "PrivateIpAddresses":{ "shape":"InstancePrivateIpAddressList", "documentation":"

The private IP addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" } }, "documentation":"

Describes a network interface.

" }, "InstanceNetworkInterfaceAssociation":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The public IP address or Elastic IP address bound to the network interface.

", "locationName":"publicIp" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name.

", "locationName":"publicDnsName" }, "IpOwnerId":{ "shape":"String", "documentation":"

The ID of the owner of the Elastic IP address.

", "locationName":"ipOwnerId" } }, "documentation":"

Describes association information for an Elastic IP address.

" }, "InstanceNetworkInterfaceAttachment":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device on the instance for the network interface attachment.

", "locationName":"deviceIndex" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a network interface attachment.

" }, "InstanceNetworkInterfaceList":{ "type":"list", "member":{ "shape":"InstanceNetworkInterface", "locationName":"item" } }, "InstanceNetworkInterfaceSpecification":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

", "locationName":"deviceIndex" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

", "locationName":"subnetId" }, "Description":{ "shape":"String", "documentation":"

The description of the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"description" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

", "locationName":"privateIpAddress" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"SecurityGroupId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

", "locationName":"deleteOnTermination" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", "documentation":"

One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

", "locationName":"privateIpAddressesSet", "queryName":"PrivateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.

", "locationName":"secondaryPrivateIpAddressCount" }, "AssociatePublicIpAddress":{ "shape":"Boolean", "documentation":"

Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

", "locationName":"associatePublicIpAddress" } }, "documentation":"

Describes a network interface.

" }, "InstanceNetworkInterfaceSpecificationList":{ "type":"list", "member":{ "shape":"InstanceNetworkInterfaceSpecification", "locationName":"item" } }, "InstancePrivateIpAddress":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the network interface.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", "locationName":"primary" }, "Association":{ "shape":"InstanceNetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address for the network interface.

", "locationName":"association" } }, "documentation":"

Describes a private IP address.

" }, "InstancePrivateIpAddressList":{ "type":"list", "member":{ "shape":"InstancePrivateIpAddress", "locationName":"item" } }, "InstanceState":{ "type":"structure", "members":{ "Code":{ "shape":"Integer", "documentation":"

The low byte represents the state. The high byte is an opaque internal value and should be ignored.

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

", "locationName":"code" }, "Name":{ "shape":"InstanceStateName", "documentation":"

The current state of the instance.

", "locationName":"name" } }, "documentation":"

Describes the current state of the instance.

" }, "InstanceStateChange":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "CurrentState":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

", "locationName":"currentState" }, "PreviousState":{ "shape":"InstanceState", "documentation":"

The previous state of the instance.

", "locationName":"previousState" } }, "documentation":"

Describes an instance state change.

" }, "InstanceStateChangeList":{ "type":"list", "member":{ "shape":"InstanceStateChange", "locationName":"item" } }, "InstanceStateName":{ "type":"string", "enum":[ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ] }, "InstanceStatus":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the instance.

", "locationName":"availabilityZone" }, "Events":{ "shape":"InstanceStatusEventList", "documentation":"

Any scheduled events associated with the instance.

", "locationName":"eventsSet" }, "InstanceState":{ "shape":"InstanceState", "documentation":"

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

", "locationName":"instanceState" }, "SystemStatus":{ "shape":"InstanceStatusSummary", "documentation":"

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

", "locationName":"systemStatus" }, "InstanceStatus":{ "shape":"InstanceStatusSummary", "documentation":"

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

", "locationName":"instanceStatus" } }, "documentation":"

Describes the status of an instance.

" }, "InstanceStatusDetails":{ "type":"structure", "members":{ "Name":{ "shape":"StatusName", "documentation":"

The type of instance status.

", "locationName":"name" }, "Status":{ "shape":"StatusType", "documentation":"

The status.

", "locationName":"status" }, "ImpairedSince":{ "shape":"DateTime", "documentation":"

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

", "locationName":"impairedSince" } }, "documentation":"

Describes the instance status.

" }, "InstanceStatusDetailsList":{ "type":"list", "member":{ "shape":"InstanceStatusDetails", "locationName":"item" } }, "InstanceStatusEvent":{ "type":"structure", "members":{ "Code":{ "shape":"EventCode", "documentation":"

The event code.

", "locationName":"code" }, "Description":{ "shape":"String", "documentation":"

A description of the event.

After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].

", "locationName":"description" }, "NotBefore":{ "shape":"DateTime", "documentation":"

The earliest scheduled start time for the event.

", "locationName":"notBefore" }, "NotAfter":{ "shape":"DateTime", "documentation":"

The latest scheduled end time for the event.

", "locationName":"notAfter" } }, "documentation":"

Describes a scheduled event for an instance.

" }, "InstanceStatusEventList":{ "type":"list", "member":{ "shape":"InstanceStatusEvent", "locationName":"item" } }, "InstanceStatusList":{ "type":"list", "member":{ "shape":"InstanceStatus", "locationName":"item" } }, "InstanceStatusSummary":{ "type":"structure", "members":{ "Status":{ "shape":"SummaryStatus", "documentation":"

The status.

", "locationName":"status" }, "Details":{ "shape":"InstanceStatusDetailsList", "documentation":"

The system instance health or application instance health.

", "locationName":"details" } }, "documentation":"

Describes the status of an instance.

" }, "InstanceType":{ "type":"string", "enum":[ "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m4.16xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "x1.16xlarge", "x1.32xlarge", "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", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "g2.8xlarge", "cg1.4xlarge", "p2.xlarge", "p2.8xlarge", "p2.16xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge" ] }, "InstanceTypeList":{ "type":"list", "member":{"shape":"InstanceType"} }, "Integer":{"type":"integer"}, "InternetGateway":{ "type":"structure", "members":{ "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "Attachments":{ "shape":"InternetGatewayAttachmentList", "documentation":"

Any VPCs attached to the Internet gateway.

", "locationName":"attachmentSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the Internet gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes an Internet gateway.

" }, "InternetGatewayAttachment":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"AttachmentStatus", "documentation":"

The current state of the attachment.

", "locationName":"state" } }, "documentation":"

Describes the attachment of a VPC to an Internet gateway.

" }, "InternetGatewayAttachmentList":{ "type":"list", "member":{ "shape":"InternetGatewayAttachment", "locationName":"item" } }, "InternetGatewayList":{ "type":"list", "member":{ "shape":"InternetGateway", "locationName":"item" } }, "IpPermission":{ "type":"structure", "members":{ "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

[EC2-VPC only] When you authorize or revoke security group rules, you can use -1 to specify all.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

", "locationName":"toPort" }, "UserIdGroupPairs":{ "shape":"UserIdGroupPairList", "documentation":"

One or more security group and AWS account ID pairs.

", "locationName":"groups" }, "IpRanges":{ "shape":"IpRangeList", "documentation":"

One or more IP ranges.

", "locationName":"ipRanges" }, "PrefixListIds":{ "shape":"PrefixListIdList", "documentation":"

(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

", "locationName":"prefixListIds" } }, "documentation":"

Describes a security group rule.

" }, "IpPermissionList":{ "type":"list", "member":{ "shape":"IpPermission", "locationName":"item" } }, "IpRange":{ "type":"structure", "members":{ "CidrIp":{ "shape":"String", "documentation":"

The CIDR range. You can either specify a CIDR range or a source security group, not both.

", "locationName":"cidrIp" } }, "documentation":"

Describes an IP range.

" }, "IpRangeList":{ "type":"list", "member":{ "shape":"IpRange", "locationName":"item" } }, "IpRanges":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "KeyNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"KeyName" } }, "KeyPair":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

The SHA-1 digest of the DER encoded private key.

", "locationName":"keyFingerprint" }, "KeyMaterial":{ "shape":"String", "documentation":"

An unencrypted PEM encoded RSA private key.

", "locationName":"keyMaterial" } }, "documentation":"

Describes a key pair.

" }, "KeyPairInfo":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", "locationName":"keyFingerprint" } }, "documentation":"

Describes a key pair.

" }, "KeyPairList":{ "type":"list", "member":{ "shape":"KeyPairInfo", "locationName":"item" } }, "LaunchPermission":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The AWS account ID.

", "locationName":"userId" }, "Group":{ "shape":"PermissionGroup", "documentation":"

The name of the group.

", "locationName":"group" } }, "documentation":"

Describes a launch permission.

" }, "LaunchPermissionList":{ "type":"list", "member":{ "shape":"LaunchPermission", "locationName":"item" } }, "LaunchPermissionModifications":{ "type":"structure", "members":{ "Add":{ "shape":"LaunchPermissionList", "documentation":"

The AWS account ID to add to the list of launch permissions for the AMI.

" }, "Remove":{ "shape":"LaunchPermissionList", "documentation":"

The AWS account ID to remove from the list of launch permissions for the AMI.

" } }, "documentation":"

Describes a launch permission modification.

" }, "LaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", "locationName":"groupSet" }, "UserData":{ "shape":"String", "documentation":"

The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.

", "locationName":"blockDeviceMapping" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" } }, "documentation":"

Describes the launch specification for an instance.

" }, "LaunchSpecsList":{ "type":"list", "member":{ "shape":"SpotFleetLaunchSpecification", "locationName":"item" }, "min":1 }, "ListingState":{ "type":"string", "enum":[ "available", "sold", "cancelled", "pending" ] }, "ListingStatus":{ "type":"string", "enum":[ "active", "pending", "cancelled", "closed" ] }, "Long":{"type":"long"}, "MaxResults":{ "type":"integer", "max":255, "min":5 }, "ModifyHostsRequest":{ "type":"structure", "required":[ "HostIds", "AutoPlacement" ], "members":{ "HostIds":{ "shape":"RequestHostIdList", "documentation":"

The host IDs of the Dedicated Hosts you want to modify.

", "locationName":"hostId" }, "AutoPlacement":{ "shape":"AutoPlacement", "documentation":"

Specify whether to enable or disable auto-placement.

", "locationName":"autoPlacement" } }, "documentation":"

Contains the parameters for ModifyHosts.

" }, "ModifyHostsResult":{ "type":"structure", "members":{ "Successful":{ "shape":"ResponseHostIdList", "documentation":"

The IDs of the Dedicated Hosts that were successfully modified.

", "locationName":"successful" }, "Unsuccessful":{ "shape":"UnsuccessfulItemList", "documentation":"

The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of ModifyHosts.

" }, "ModifyIdFormatRequest":{ "type":"structure", "required":[ "Resource", "UseLongIds" ], "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource: instance | reservation | snapshot | volume

" }, "UseLongIds":{ "shape":"Boolean", "documentation":"

Indicate whether the resource should use longer IDs (17-character IDs).

" } }, "documentation":"

Contains the parameters of ModifyIdFormat.

" }, "ModifyIdentityIdFormatRequest":{ "type":"structure", "required":[ "Resource", "UseLongIds", "PrincipalArn" ], "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource: instance | reservation | snapshot | volume

", "locationName":"resource" }, "UseLongIds":{ "shape":"Boolean", "documentation":"

Indicates whether the resource should use longer IDs (17-character IDs)

", "locationName":"useLongIds" }, "PrincipalArn":{ "shape":"String", "documentation":"

The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account.

", "locationName":"principalArn" } }, "documentation":"

Contains the parameters of ModifyIdentityIdFormat.

" }, "ModifyImageAttributeRequest":{ "type":"structure", "required":["ImageId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"String", "documentation":"

The name of the attribute to modify.

" }, "OperationType":{ "shape":"OperationType", "documentation":"

The operation type.

" }, "UserIds":{ "shape":"UserIdStringList", "documentation":"

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

", "locationName":"UserId" }, "UserGroups":{ "shape":"UserGroupStringList", "documentation":"

One or more user groups. This is only valid when modifying the launchPermission attribute.

", "locationName":"UserGroup" }, "ProductCodes":{ "shape":"ProductCodeStringList", "documentation":"

One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

", "locationName":"ProductCode" }, "Value":{ "shape":"String", "documentation":"

The value of the attribute being modified. This is only valid when modifying the description attribute.

" }, "LaunchPermission":{ "shape":"LaunchPermissionModifications", "documentation":"

A launch permission modification.

" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the AMI.

" } }, "documentation":"

Contains the parameters for ModifyImageAttribute.

" }, "ModifyInstanceAttributeRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The name of the attribute.

", "locationName":"attribute" }, "Value":{ "shape":"String", "documentation":"

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

", "locationName":"value" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingSpecificationList", "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"blockDeviceMapping" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

" }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", "documentation":"

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this paramater for Spot Instances.

", "locationName":"disableApiTermination" }, "InstanceType":{ "shape":"AttributeValue", "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", "locationName":"instanceType" }, "Kernel":{ "shape":"AttributeValue", "documentation":"

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", "locationName":"kernel" }, "Ramdisk":{ "shape":"AttributeValue", "documentation":"

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", "locationName":"ramdisk" }, "UserData":{ "shape":"BlobAttributeValue", "documentation":"

Changes the instance's user data to the specified value. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"userData" }, "InstanceInitiatedShutdownBehavior":{ "shape":"AttributeValue", "documentation":"

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "Groups":{ "shape":"GroupIdStringList", "documentation":"

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

", "locationName":"GroupId" }, "EbsOptimized":{ "shape":"AttributeBooleanValue", "documentation":"

Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"AttributeValue", "documentation":"

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.

There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", "locationName":"sriovNetSupport" }, "EnaSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Set to true to enable enhanced networking with ENA for the instance.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", "locationName":"enaSupport" } }, "documentation":"

Contains the parameters for ModifyInstanceAttribute.

" }, "ModifyInstancePlacementRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance that you are modifying.

", "locationName":"instanceId" }, "Tenancy":{ "shape":"HostTenancy", "documentation":"

The tenancy of the instance that you are modifying.

", "locationName":"tenancy" }, "Affinity":{ "shape":"Affinity", "documentation":"

The new affinity setting for the instance.

", "locationName":"affinity" }, "HostId":{ "shape":"String", "documentation":"

The ID of the Dedicated Host that the instance will have affinity with.

", "locationName":"hostId" } }, "documentation":"

Contains the parameters for ModifyInstancePlacement.

" }, "ModifyInstancePlacementResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Is true if the request succeeds, and an error otherwise.

", "locationName":"return" } }, "documentation":"

Contains the output of ModifyInstancePlacement.

" }, "ModifyNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the network interface.

", "locationName":"description" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", "locationName":"SecurityGroupId" }, "Attachment":{ "shape":"NetworkInterfaceAttachmentChanges", "documentation":"

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

", "locationName":"attachment" } }, "documentation":"

Contains the parameters for ModifyNetworkInterfaceAttribute.

" }, "ModifyReservedInstancesRequest":{ "type":"structure", "required":[ "ReservedInstancesIds", "TargetConfigurations" ], "members":{ "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" }, "ReservedInstancesIds":{ "shape":"ReservedInstancesIdStringList", "documentation":"

The IDs of the Reserved Instances to modify.

", "locationName":"ReservedInstancesId" }, "TargetConfigurations":{ "shape":"ReservedInstancesConfigurationList", "documentation":"

The configuration settings for the Reserved Instances to modify.

", "locationName":"ReservedInstancesConfigurationSetItemType" } }, "documentation":"

Contains the parameters for ModifyReservedInstances.

" }, "ModifyReservedInstancesResult":{ "type":"structure", "members":{ "ReservedInstancesModificationId":{ "shape":"String", "documentation":"

The ID for the modification.

", "locationName":"reservedInstancesModificationId" } }, "documentation":"

Contains the output of ModifyReservedInstances.

" }, "ModifySnapshotAttributeRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The snapshot attribute to modify.

Only volume creation permissions may be modified at the customer level.

" }, "OperationType":{ "shape":"OperationType", "documentation":"

The type of operation to perform to the attribute.

" }, "UserIds":{ "shape":"UserIdStringList", "documentation":"

The account ID to modify for the snapshot.

", "locationName":"UserId" }, "GroupNames":{ "shape":"GroupNameStringList", "documentation":"

The group to modify for the snapshot.

", "locationName":"UserGroup" }, "CreateVolumePermission":{ "shape":"CreateVolumePermissionModifications", "documentation":"

A JSON representation of the snapshot attribute modification.

" } }, "documentation":"

Contains the parameters for ModifySnapshotAttribute.

" }, "ModifySpotFleetRequestRequest":{ "type":"structure", "required":["SpotFleetRequestId"], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "TargetCapacity":{ "shape":"Integer", "documentation":"

The size of the fleet.

", "locationName":"targetCapacity" }, "ExcessCapacityTerminationPolicy":{ "shape":"ExcessCapacityTerminationPolicy", "documentation":"

Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.

", "locationName":"excessCapacityTerminationPolicy" } }, "documentation":"

Contains the parameters for ModifySpotFleetRequest.

" }, "ModifySpotFleetRequestResponse":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Is true if the request succeeds, and an error otherwise.

", "locationName":"return" } }, "documentation":"

Contains the output of ModifySpotFleetRequest.

" }, "ModifySubnetAttributeRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "MapPublicIpOnLaunch":{ "shape":"AttributeBooleanValue", "documentation":"

Specify true to indicate that instances launched into the specified subnet should be assigned public IP address.

" } }, "documentation":"

Contains the parameters for ModifySubnetAttribute.

" }, "ModifyVolumeAttributeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "AutoEnableIO":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the volume should be auto-enabled for I/O operations.

" } }, "documentation":"

Contains the parameters for ModifyVolumeAttribute.

" }, "ModifyVpcAttributeRequest":{ "type":"structure", "required":["VpcId"], "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "EnableDnsSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.

" }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.

" } }, "documentation":"

Contains the parameters for ModifyVpcAttribute.

" }, "ModifyVpcEndpointRequest":{ "type":"structure", "required":["VpcEndpointId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcEndpointId":{ "shape":"String", "documentation":"

The ID of the endpoint.

" }, "ResetPolicy":{ "shape":"Boolean", "documentation":"

Specify true to reset the policy document to the default policy. The default policy allows access to the service.

" }, "PolicyDocument":{ "shape":"String", "documentation":"

A policy document to attach to the endpoint. The policy must be in valid JSON format.

" }, "AddRouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route tables IDs to associate with the endpoint.

", "locationName":"AddRouteTableId" }, "RemoveRouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs to disassociate from the endpoint.

", "locationName":"RemoveRouteTableId" } }, "documentation":"

Contains the parameters for ModifyVpcEndpoint.

" }, "ModifyVpcEndpointResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of ModifyVpcEndpoint.

" }, "ModifyVpcPeeringConnectionOptionsRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

" }, "RequesterPeeringConnectionOptions":{ "shape":"PeeringConnectionOptionsRequest", "documentation":"

The VPC peering connection options for the requester VPC.

" }, "AccepterPeeringConnectionOptions":{ "shape":"PeeringConnectionOptionsRequest", "documentation":"

The VPC peering connection options for the accepter VPC.

" } } }, "ModifyVpcPeeringConnectionOptionsResult":{ "type":"structure", "members":{ "RequesterPeeringConnectionOptions":{ "shape":"PeeringConnectionOptions", "documentation":"

Information about the VPC peering connection options for the requester VPC.

", "locationName":"requesterPeeringConnectionOptions" }, "AccepterPeeringConnectionOptions":{ "shape":"PeeringConnectionOptions", "documentation":"

Information about the VPC peering connection options for the accepter VPC.

", "locationName":"accepterPeeringConnectionOptions" } } }, "MonitorInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } }, "documentation":"

Contains the parameters for MonitorInstances.

" }, "MonitorInstancesResult":{ "type":"structure", "members":{ "InstanceMonitorings":{ "shape":"InstanceMonitoringList", "documentation":"

Monitoring information for one or more instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of MonitorInstances.

" }, "Monitoring":{ "type":"structure", "members":{ "State":{ "shape":"MonitoringState", "documentation":"

Indicates whether monitoring is enabled for the instance.

", "locationName":"state" } }, "documentation":"

Describes the monitoring for the instance.

" }, "MonitoringState":{ "type":"string", "enum":[ "disabled", "disabling", "enabled", "pending" ] }, "MoveAddressToVpcRequest":{ "type":"structure", "required":["PublicIp"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" } }, "documentation":"

Contains the parameters for MoveAddressToVpc.

" }, "MoveAddressToVpcResult":{ "type":"structure", "members":{ "AllocationId":{ "shape":"String", "documentation":"

The allocation ID for the Elastic IP address.

", "locationName":"allocationId" }, "Status":{ "shape":"Status", "documentation":"

The status of the move of the IP address.

", "locationName":"status" } }, "documentation":"

Contains the output of MoveAddressToVpc.

" }, "MoveStatus":{ "type":"string", "enum":[ "movingToVpc", "restoringToClassic" ] }, "MovingAddressStatus":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "MoveStatus":{ "shape":"MoveStatus", "documentation":"

The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.

", "locationName":"moveStatus" } }, "documentation":"

Describes the status of a moving Elastic IP address.

" }, "MovingAddressStatusSet":{ "type":"list", "member":{ "shape":"MovingAddressStatus", "locationName":"item" } }, "NatGateway":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC in which the NAT gateway is located.

", "locationName":"vpcId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which the NAT gateway is located.

", "locationName":"subnetId" }, "NatGatewayId":{ "shape":"String", "documentation":"

The ID of the NAT gateway.

", "locationName":"natGatewayId" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The date and time the NAT gateway was created.

", "locationName":"createTime" }, "DeleteTime":{ "shape":"DateTime", "documentation":"

The date and time the NAT gateway was deleted, if applicable.

", "locationName":"deleteTime" }, "NatGatewayAddresses":{ "shape":"NatGatewayAddressList", "documentation":"

Information about the IP addresses and network interface associated with the NAT gateway.

", "locationName":"natGatewayAddressSet" }, "State":{ "shape":"NatGatewayState", "documentation":"

The state of the NAT gateway.

  • pending: The NAT gateway is being created and is not ready to process traffic.

  • failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.

  • available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.

  • deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.

  • deleted: The NAT gateway has been terminated and is no longer processing traffic.

", "locationName":"state" }, "FailureCode":{ "shape":"String", "documentation":"

If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)

", "locationName":"failureCode" }, "FailureMessage":{ "shape":"String", "documentation":"

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

  • For InsufficientFreeAddressesInSubnet: \"Subnet has insufficient free addresses to create this NAT gateway\"

  • For Gateway.NotAttached: \"Network vpc-xxxxxxxx has no Internet gateway attached\"

  • For InvalidAllocationID.NotFound: \"Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway\"

  • For Resource.AlreadyAssociated: \"Elastic IP address eipalloc-xxxxxxxx is already associated\"

  • For InternalError: \"Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again.\"

  • For InvalidSubnetID.NotFound: \"The specified subnet subnet-xxxxxxxx does not exist or could not be found.\"

", "locationName":"failureMessage" }, "ProvisionedBandwidth":{ "shape":"ProvisionedBandwidth", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"provisionedBandwidth" } }, "documentation":"

Describes a NAT gateway.

" }, "NatGatewayAddress":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address associated with the NAT gateway.

", "locationName":"publicIp" }, "AllocationId":{ "shape":"String", "documentation":"

The allocation ID of the Elastic IP address that's associated with the NAT gateway.

", "locationName":"allocationId" }, "PrivateIp":{ "shape":"String", "documentation":"

The private IP address associated with the Elastic IP address.

", "locationName":"privateIp" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface associated with the NAT gateway.

", "locationName":"networkInterfaceId" } }, "documentation":"

Describes the IP addresses and network interface associated with a NAT gateway.

" }, "NatGatewayAddressList":{ "type":"list", "member":{ "shape":"NatGatewayAddress", "locationName":"item" } }, "NatGatewayList":{ "type":"list", "member":{ "shape":"NatGateway", "locationName":"item" } }, "NatGatewayState":{ "type":"string", "enum":[ "pending", "failed", "available", "deleting", "deleted" ] }, "NetworkAcl":{ "type":"structure", "members":{ "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for the network ACL.

", "locationName":"vpcId" }, "IsDefault":{ "shape":"Boolean", "documentation":"

Indicates whether this is the default network ACL for the VPC.

", "locationName":"default" }, "Entries":{ "shape":"NetworkAclEntryList", "documentation":"

One or more entries (rules) in the network ACL.

", "locationName":"entrySet" }, "Associations":{ "shape":"NetworkAclAssociationList", "documentation":"

Any associations between the network ACL and one or more subnets

", "locationName":"associationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the network ACL.

", "locationName":"tagSet" } }, "documentation":"

Describes a network ACL.

" }, "NetworkAclAssociation":{ "type":"structure", "members":{ "NetworkAclAssociationId":{ "shape":"String", "documentation":"

The ID of the association between a network ACL and a subnet.

", "locationName":"networkAclAssociationId" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" } }, "documentation":"

Describes an association between a network ACL and a subnet.

" }, "NetworkAclAssociationList":{ "type":"list", "member":{ "shape":"NetworkAclAssociation", "locationName":"item" } }, "NetworkAclEntry":{ "type":"structure", "members":{ "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The protocol. A value of -1 means all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation.

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code.

", "locationName":"icmpTypeCode" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", "locationName":"portRange" } }, "documentation":"

Describes an entry in a network ACL.

" }, "NetworkAclEntryList":{ "type":"list", "member":{ "shape":"NetworkAclEntry", "locationName":"item" } }, "NetworkAclList":{ "type":"list", "member":{ "shape":"NetworkAcl", "locationName":"item" } }, "NetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "Description":{ "shape":"String", "documentation":"

A description.

", "locationName":"description" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the network interface.

", "locationName":"ownerId" }, "RequesterId":{ "shape":"String", "documentation":"

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", "locationName":"requesterId" }, "RequesterManaged":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is being managed by AWS.

", "locationName":"requesterManaged" }, "Status":{ "shape":"NetworkInterfaceStatus", "documentation":"

The status of the network interface.

", "locationName":"status" }, "MacAddress":{ "shape":"String", "documentation":"

The MAC address.

", "locationName":"macAddress" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Indicates whether traffic to or from the instance is validated.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

Any security groups for the network interface.

", "locationName":"groupSet" }, "Attachment":{ "shape":"NetworkInterfaceAttachment", "documentation":"

The network interface attachment.

", "locationName":"attachment" }, "Association":{ "shape":"NetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP associated with the network interface.

", "locationName":"association" }, "TagSet":{ "shape":"TagList", "documentation":"

Any tags assigned to the network interface.

", "locationName":"tagSet" }, "PrivateIpAddresses":{ "shape":"NetworkInterfacePrivateIpAddressList", "documentation":"

The private IP addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" }, "InterfaceType":{ "shape":"NetworkInterfaceType", "documentation":"

The type of interface.

", "locationName":"interfaceType" } }, "documentation":"

Describes a network interface.

" }, "NetworkInterfaceAssociation":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The address of the Elastic IP address bound to the network interface.

", "locationName":"publicIp" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name.

", "locationName":"publicDnsName" }, "IpOwnerId":{ "shape":"String", "documentation":"

The ID of the Elastic IP address owner.

", "locationName":"ipOwnerId" }, "AllocationId":{ "shape":"String", "documentation":"

The allocation ID.

", "locationName":"allocationId" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID.

", "locationName":"associationId" } }, "documentation":"

Describes association information for an Elastic IP address.

" }, "NetworkInterfaceAttachment":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "InstanceOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the instance.

", "locationName":"instanceOwnerId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The device index of the network interface attachment on the instance.

", "locationName":"deviceIndex" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The timestamp indicating when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a network interface attachment.

" }, "NetworkInterfaceAttachmentChanges":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes an attachment change.

" }, "NetworkInterfaceAttribute":{ "type":"string", "enum":[ "description", "groupSet", "sourceDestCheck", "attachment" ] }, "NetworkInterfaceIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "NetworkInterfaceList":{ "type":"list", "member":{ "shape":"NetworkInterface", "locationName":"item" } }, "NetworkInterfacePrivateIpAddress":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", "locationName":"primary" }, "Association":{ "shape":"NetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address associated with the network interface.

", "locationName":"association" } }, "documentation":"

Describes the private IP address of a network interface.

" }, "NetworkInterfacePrivateIpAddressList":{ "type":"list", "member":{ "shape":"NetworkInterfacePrivateIpAddress", "locationName":"item" } }, "NetworkInterfaceStatus":{ "type":"string", "enum":[ "available", "attaching", "in-use", "detaching" ] }, "NetworkInterfaceType":{ "type":"string", "enum":[ "interface", "natGateway" ] }, "NewDhcpConfiguration":{ "type":"structure", "members":{ "Key":{ "shape":"String", "locationName":"key" }, "Values":{ "shape":"ValueStringList", "locationName":"Value" } } }, "NewDhcpConfigurationList":{ "type":"list", "member":{ "shape":"NewDhcpConfiguration", "locationName":"item" } }, "NextToken":{ "type":"string", "max":1024, "min":1 }, "OccurrenceDayRequestSet":{ "type":"list", "member":{ "shape":"Integer", "locationName":"OccurenceDay" } }, "OccurrenceDaySet":{ "type":"list", "member":{ "shape":"Integer", "locationName":"item" } }, "OfferingClassType":{ "type":"string", "enum":[ "standard", "convertible" ] }, "OfferingTypeValues":{ "type":"string", "enum":[ "Heavy Utilization", "Medium Utilization", "Light Utilization", "No Upfront", "Partial Upfront", "All Upfront" ] }, "OperationType":{ "type":"string", "enum":[ "add", "remove" ] }, "OwnerStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"Owner" } }, "PaymentOption":{ "type":"string", "enum":[ "AllUpfront", "PartialUpfront", "NoUpfront" ] }, "PeeringConnectionOptions":{ "type":"structure", "members":{ "AllowEgressFromLocalClassicLinkToRemoteVpc":{ "shape":"Boolean", "documentation":"

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

", "locationName":"allowEgressFromLocalClassicLinkToRemoteVpc" }, "AllowEgressFromLocalVpcToRemoteClassicLink":{ "shape":"Boolean", "documentation":"

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

", "locationName":"allowEgressFromLocalVpcToRemoteClassicLink" }, "AllowDnsResolutionFromRemoteVpc":{ "shape":"Boolean", "documentation":"

If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

", "locationName":"allowDnsResolutionFromRemoteVpc" } }, "documentation":"

Describes the VPC peering connection options.

" }, "PeeringConnectionOptionsRequest":{ "type":"structure", "members":{ "AllowEgressFromLocalClassicLinkToRemoteVpc":{ "shape":"Boolean", "documentation":"

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

" }, "AllowEgressFromLocalVpcToRemoteClassicLink":{ "shape":"Boolean", "documentation":"

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

" }, "AllowDnsResolutionFromRemoteVpc":{ "shape":"Boolean", "documentation":"

If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

" } }, "documentation":"

The VPC peering connection options.

" }, "PermissionGroup":{ "type":"string", "enum":["all"] }, "Placement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the instance.

", "locationName":"availabilityZone" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group the instance is in (for cluster compute instances).

", "locationName":"groupName" }, "Tenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

", "locationName":"tenancy" }, "HostId":{ "shape":"String", "documentation":"

The ID of the Dedicted host on which the instance resides. This parameter is not support for the ImportInstance command.

", "locationName":"hostId" }, "Affinity":{ "shape":"String", "documentation":"

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

", "locationName":"affinity" } }, "documentation":"

Describes the placement for the instance.

" }, "PlacementGroup":{ "type":"structure", "members":{ "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"

The placement strategy.

", "locationName":"strategy" }, "State":{ "shape":"PlacementGroupState", "documentation":"

The state of the placement group.

", "locationName":"state" } }, "documentation":"

Describes a placement group.

" }, "PlacementGroupList":{ "type":"list", "member":{ "shape":"PlacementGroup", "locationName":"item" } }, "PlacementGroupState":{ "type":"string", "enum":[ "pending", "available", "deleting", "deleted" ] }, "PlacementGroupStringList":{ "type":"list", "member":{"shape":"String"} }, "PlacementStrategy":{ "type":"string", "enum":["cluster"] }, "PlatformValues":{ "type":"string", "enum":["Windows"] }, "PortRange":{ "type":"structure", "members":{ "From":{ "shape":"Integer", "documentation":"

The first port in the range.

", "locationName":"from" }, "To":{ "shape":"Integer", "documentation":"

The last port in the range.

", "locationName":"to" } }, "documentation":"

Describes a range of ports.

" }, "PrefixList":{ "type":"structure", "members":{ "PrefixListId":{ "shape":"String", "documentation":"

The ID of the prefix.

", "locationName":"prefixListId" }, "PrefixListName":{ "shape":"String", "documentation":"

The name of the prefix.

", "locationName":"prefixListName" }, "Cidrs":{ "shape":"ValueStringList", "documentation":"

The IP address range of the AWS service.

", "locationName":"cidrSet" } }, "documentation":"

Describes prefixes for AWS services.

" }, "PrefixListId":{ "type":"structure", "members":{ "PrefixListId":{ "shape":"String", "documentation":"

The ID of the prefix.

", "locationName":"prefixListId" } }, "documentation":"

The ID of the prefix.

" }, "PrefixListIdList":{ "type":"list", "member":{ "shape":"PrefixListId", "locationName":"item" } }, "PrefixListIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "PrefixListSet":{ "type":"list", "member":{ "shape":"PrefixList", "locationName":"item" } }, "PriceSchedule":{ "type":"structure", "members":{ "Term":{ "shape":"Long", "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"

The fixed price for the term.

", "locationName":"price" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "Active":{ "shape":"Boolean", "documentation":"

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", "locationName":"active" } }, "documentation":"

Describes the price for a Reserved Instance.

" }, "PriceScheduleList":{ "type":"list", "member":{ "shape":"PriceSchedule", "locationName":"item" } }, "PriceScheduleSpecification":{ "type":"structure", "members":{ "Term":{ "shape":"Long", "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"

The fixed price for the term.

", "locationName":"price" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } }, "documentation":"

Describes the price for a Reserved Instance.

" }, "PriceScheduleSpecificationList":{ "type":"list", "member":{ "shape":"PriceScheduleSpecification", "locationName":"item" } }, "PricingDetail":{ "type":"structure", "members":{ "Price":{ "shape":"Double", "documentation":"

The price per instance.

", "locationName":"price" }, "Count":{ "shape":"Integer", "documentation":"

The number of reservations available for the price.

", "locationName":"count" } }, "documentation":"

Describes a Reserved Instance offering.

" }, "PricingDetailsList":{ "type":"list", "member":{ "shape":"PricingDetail", "locationName":"item" } }, "PrivateIpAddressConfigSet":{ "type":"list", "member":{ "shape":"ScheduledInstancesPrivateIpAddressConfig", "locationName":"PrivateIpAddressConfigSet" } }, "PrivateIpAddressSpecification":{ "type":"structure", "required":["PrivateIpAddress"], "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP addresses.

", "locationName":"privateIpAddress" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

", "locationName":"primary" } }, "documentation":"

Describes a secondary private IP address for a network interface.

" }, "PrivateIpAddressSpecificationList":{ "type":"list", "member":{ "shape":"PrivateIpAddressSpecification", "locationName":"item" } }, "PrivateIpAddressStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"PrivateIpAddress" } }, "ProductCode":{ "type":"structure", "members":{ "ProductCodeId":{ "shape":"String", "documentation":"

The product code.

", "locationName":"productCode" }, "ProductCodeType":{ "shape":"ProductCodeValues", "documentation":"

The type of product code.

", "locationName":"type" } }, "documentation":"

Describes a product code.

" }, "ProductCodeList":{ "type":"list", "member":{ "shape":"ProductCode", "locationName":"item" } }, "ProductCodeStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ProductCode" } }, "ProductCodeValues":{ "type":"string", "enum":[ "devpay", "marketplace" ] }, "ProductDescriptionList":{ "type":"list", "member":{"shape":"String"} }, "PropagatingVgw":{ "type":"structure", "members":{ "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway (VGW).

", "locationName":"gatewayId" } }, "documentation":"

Describes a virtual private gateway propagating route.

" }, "PropagatingVgwList":{ "type":"list", "member":{ "shape":"PropagatingVgw", "locationName":"item" } }, "ProvisionedBandwidth":{ "type":"structure", "members":{ "Provisioned":{ "shape":"String", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"provisioned" }, "Requested":{ "shape":"String", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"requested" }, "RequestTime":{ "shape":"DateTime", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"requestTime" }, "ProvisionTime":{ "shape":"DateTime", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"provisionTime" }, "Status":{ "shape":"String", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"status" } }, "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

" }, "PublicIpStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"PublicIp" } }, "Purchase":{ "type":"structure", "members":{ "HostReservationId":{ "shape":"String", "documentation":"

The ID of the reservation.

", "locationName":"hostReservationId" }, "HostIdSet":{ "shape":"ResponseHostIdSet", "documentation":"

The IDs of the Dedicated Hosts associated with the reservation.

", "locationName":"hostIdSet" }, "InstanceFamily":{ "shape":"String", "documentation":"

The instance family on the Dedicated Host that the reservation can be associated with.

", "locationName":"instanceFamily" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"

The payment option for the reservation.

", "locationName":"paymentOption" }, "UpfrontPrice":{ "shape":"String", "documentation":"

The upfront price of the reservation.

", "locationName":"upfrontPrice" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price of the reservation per hour.

", "locationName":"hourlyPrice" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "Duration":{ "shape":"Integer", "documentation":"

The duration of the reservation's term in seconds.

", "locationName":"duration" } }, "documentation":"

Describes the result of the purchase.

" }, "PurchaseHostReservationRequest":{ "type":"structure", "required":[ "OfferingId", "HostIdSet" ], "members":{ "OfferingId":{ "shape":"String", "documentation":"

The ID of the offering.

" }, "HostIdSet":{ "shape":"RequestHostIdSet", "documentation":"

The ID/s of the Dedicated Host/s that the reservation will be associated with.

" }, "LimitPrice":{ "shape":"String", "documentation":"

The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request will fail. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.

" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" } } }, "PurchaseHostReservationResult":{ "type":"structure", "members":{ "Purchase":{ "shape":"PurchaseSet", "documentation":"

Describes the details of the purchase.

", "locationName":"purchase" }, "TotalUpfrontPrice":{ "shape":"String", "documentation":"

The total amount that will be charged to your account when you purchase the reservation.

", "locationName":"totalUpfrontPrice" }, "TotalHourlyPrice":{ "shape":"String", "documentation":"

The total hourly price of the reservation calculated per hour.

", "locationName":"totalHourlyPrice" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide

", "locationName":"clientToken" } } }, "PurchaseRequest":{ "type":"structure", "required":[ "PurchaseToken", "InstanceCount" ], "members":{ "PurchaseToken":{ "shape":"String", "documentation":"

The purchase token.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances.

" } }, "documentation":"

Describes a request to purchase Scheduled Instances.

" }, "PurchaseRequestSet":{ "type":"list", "member":{ "shape":"PurchaseRequest", "locationName":"PurchaseRequest" }, "min":1 }, "PurchaseReservedInstancesOfferingRequest":{ "type":"structure", "required":[ "ReservedInstancesOfferingId", "InstanceCount" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance offering to purchase.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of Reserved Instances to purchase.

" }, "LimitPrice":{ "shape":"ReservedInstanceLimitPrice", "documentation":"

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", "locationName":"limitPrice" } }, "documentation":"

Contains the parameters for PurchaseReservedInstancesOffering.

" }, "PurchaseReservedInstancesOfferingResult":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The IDs of the purchased Reserved Instances.

", "locationName":"reservedInstancesId" } }, "documentation":"

Contains the output of PurchaseReservedInstancesOffering.

" }, "PurchaseScheduledInstancesRequest":{ "type":"structure", "required":["PurchaseRequests"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

", "idempotencyToken":true }, "PurchaseRequests":{ "shape":"PurchaseRequestSet", "documentation":"

One or more purchase requests.

", "locationName":"PurchaseRequest" } }, "documentation":"

Contains the parameters for PurchaseScheduledInstances.

" }, "PurchaseScheduledInstancesResult":{ "type":"structure", "members":{ "ScheduledInstanceSet":{ "shape":"PurchasedScheduledInstanceSet", "documentation":"

Information about the Scheduled Instances.

", "locationName":"scheduledInstanceSet" } }, "documentation":"

Contains the output of PurchaseScheduledInstances.

" }, "PurchaseSet":{ "type":"list", "member":{"shape":"Purchase"} }, "PurchasedScheduledInstanceSet":{ "type":"list", "member":{ "shape":"ScheduledInstance", "locationName":"item" } }, "RIProductDescription":{ "type":"string", "enum":[ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ] }, "ReasonCodesList":{ "type":"list", "member":{ "shape":"ReportInstanceReasonCodes", "locationName":"item" } }, "RebootInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } }, "documentation":"

Contains the parameters for RebootInstances.

" }, "RecurringCharge":{ "type":"structure", "members":{ "Frequency":{ "shape":"RecurringChargeFrequency", "documentation":"

The frequency of the recurring charge.

", "locationName":"frequency" }, "Amount":{ "shape":"Double", "documentation":"

The amount of the recurring charge.

", "locationName":"amount" } }, "documentation":"

Describes a recurring charge.

" }, "RecurringChargeFrequency":{ "type":"string", "enum":["Hourly"] }, "RecurringChargesList":{ "type":"list", "member":{ "shape":"RecurringCharge", "locationName":"item" } }, "Region":{ "type":"structure", "members":{ "RegionName":{ "shape":"String", "documentation":"

The name of the region.

", "locationName":"regionName" }, "Endpoint":{ "shape":"String", "documentation":"

The region service endpoint.

", "locationName":"regionEndpoint" } }, "documentation":"

Describes a region.

" }, "RegionList":{ "type":"list", "member":{ "shape":"Region", "locationName":"item" } }, "RegionNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"RegionName" } }, "RegisterImageRequest":{ "type":"structure", "required":["Name"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageLocation":{ "shape":"String", "documentation":"

The full path to your AMI manifest in Amazon S3 storage.

" }, "Name":{ "shape":"String", "documentation":"

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

A description for your AMI.

", "locationName":"description" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

", "locationName":"architecture" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "RootDeviceName":{ "shape":"String", "documentation":"

The name of the root device (for example, /dev/sda1, or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

One or more block device mapping entries.

", "locationName":"BlockDeviceMapping" }, "VirtualizationType":{ "shape":"String", "documentation":"

The type of virtualization.

Default: paravirtual

", "locationName":"virtualizationType" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", "locationName":"sriovNetSupport" }, "EnaSupport":{ "shape":"Boolean", "documentation":"

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", "locationName":"enaSupport" } }, "documentation":"

Contains the parameters for RegisterImage.

" }, "RegisterImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the newly registered AMI.

", "locationName":"imageId" } }, "documentation":"

Contains the output of RegisterImage.

" }, "RejectVpcPeeringConnectionRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Contains the parameters for RejectVpcPeeringConnection.

" }, "RejectVpcPeeringConnectionResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of RejectVpcPeeringConnection.

" }, "ReleaseAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" } }, "documentation":"

Contains the parameters for ReleaseAddress.

" }, "ReleaseHostsRequest":{ "type":"structure", "required":["HostIds"], "members":{ "HostIds":{ "shape":"RequestHostIdList", "documentation":"

The IDs of the Dedicated Hosts you want to release.

", "locationName":"hostId" } }, "documentation":"

Contains the parameters for ReleaseHosts.

" }, "ReleaseHostsResult":{ "type":"structure", "members":{ "Successful":{ "shape":"ResponseHostIdList", "documentation":"

The IDs of the Dedicated Hosts that were successfully released.

", "locationName":"successful" }, "Unsuccessful":{ "shape":"UnsuccessfulItemList", "documentation":"

The IDs of the Dedicated Hosts that could not be released, including an error message.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of ReleaseHosts.

" }, "ReplaceNetworkAclAssociationRequest":{ "type":"structure", "required":[ "AssociationId", "NetworkAclId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The ID of the current association between the original network ACL and the subnet.

", "locationName":"associationId" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the new network ACL to associate with the subnet.

", "locationName":"networkAclId" } }, "documentation":"

Contains the parameters for ReplaceNetworkAclAssociation.

" }, "ReplaceNetworkAclAssociationResult":{ "type":"structure", "members":{ "NewAssociationId":{ "shape":"String", "documentation":"

The ID of the new association.

", "locationName":"newAssociationId" } }, "documentation":"

Contains the output of ReplaceNetworkAclAssociation.

" }, "ReplaceNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Protocol", "RuleAction", "Egress", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number of the entry to replace.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The IP protocol. You can specify all or -1 to mean all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation.

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.

", "locationName":"Icmp" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.

", "locationName":"portRange" } }, "documentation":"

Contains the parameters for ReplaceNetworkAclEntry.

" }, "ReplaceRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of an Internet gateway or virtual private gateway.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC.

", "locationName":"instanceId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of a network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of a VPC peering connection.

", "locationName":"vpcPeeringConnectionId" }, "NatGatewayId":{ "shape":"String", "documentation":"

The ID of a NAT gateway.

", "locationName":"natGatewayId" } }, "documentation":"

Contains the parameters for ReplaceRoute.

" }, "ReplaceRouteTableAssociationRequest":{ "type":"structure", "required":[ "AssociationId", "RouteTableId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID.

", "locationName":"associationId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the new route table to associate with the subnet.

", "locationName":"routeTableId" } }, "documentation":"

Contains the parameters for ReplaceRouteTableAssociation.

" }, "ReplaceRouteTableAssociationResult":{ "type":"structure", "members":{ "NewAssociationId":{ "shape":"String", "documentation":"

The ID of the new association.

", "locationName":"newAssociationId" } }, "documentation":"

Contains the output of ReplaceRouteTableAssociation.

" }, "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" ] }, "ReportInstanceStatusRequest":{ "type":"structure", "required":[ "Instances", "Status", "ReasonCodes" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Instances":{ "shape":"InstanceIdStringList", "documentation":"

One or more instances.

", "locationName":"instanceId" }, "Status":{ "shape":"ReportStatusType", "documentation":"

The status of all instances listed.

", "locationName":"status" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time at which the reported instance health state began.

", "locationName":"startTime" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time at which the reported instance health state ended.

", "locationName":"endTime" }, "ReasonCodes":{ "shape":"ReasonCodesList", "documentation":"

One or more reason codes that describes the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems which I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

", "locationName":"reasonCode" }, "Description":{ "shape":"String", "documentation":"

Descriptive text about the health state of your instance.

", "locationName":"description" } }, "documentation":"

Contains the parameters for ReportInstanceStatus.

" }, "ReportStatusType":{ "type":"string", "enum":[ "ok", "impaired" ] }, "RequestHostIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "RequestHostIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "RequestSpotFleetRequest":{ "type":"structure", "required":["SpotFleetRequestConfig"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestConfig":{ "shape":"SpotFleetRequestConfigData", "documentation":"

The configuration for the Spot fleet request.

", "locationName":"spotFleetRequestConfig" } }, "documentation":"

Contains the parameters for RequestSpotFleet.

" }, "RequestSpotFleetResponse":{ "type":"structure", "required":["SpotFleetRequestId"], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" } }, "documentation":"

Contains the output of RequestSpotFleet.

" }, "RequestSpotInstancesRequest":{ "type":"structure", "required":["SpotPrice"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum hourly price (bid) for any Spot instance launched to fulfill the request.

", "locationName":"spotPrice" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"clientToken" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The maximum number of Spot instances to launch.

Default: 1

", "locationName":"instanceCount" }, "Type":{ "shape":"SpotInstanceType", "documentation":"

The Spot instance request type.

Default: one-time

", "locationName":"type" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

Default: The request is effective indefinitely.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

Default: The request is effective indefinitely.

", "locationName":"validUntil" }, "LaunchGroup":{ "shape":"String", "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

Default: Instances are launched and terminated individually

", "locationName":"launchGroup" }, "AvailabilityZoneGroup":{ "shape":"String", "documentation":"

The user-specified name for a logical grouping of bids.

When you specify an Availability Zone group in a Spot Instance request, all Spot instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", "locationName":"availabilityZoneGroup" }, "BlockDurationMinutes":{ "shape":"Integer", "documentation":"

The required duration for the Spot instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

The duration period starts as soon as your Spot instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.

Note that you can't specify an Availability Zone group or a launch group if you specify a duration.

", "locationName":"blockDurationMinutes" }, "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} }, "documentation":"

Contains the parameters for RequestSpotInstances.

" }, "RequestSpotInstancesResult":{ "type":"structure", "members":{ "SpotInstanceRequests":{ "shape":"SpotInstanceRequestList", "documentation":"

One or more Spot instance requests.

", "locationName":"spotInstanceRequestSet" } }, "documentation":"

Contains the output of RequestSpotInstances.

" }, "RequestSpotLaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"ValueStringList", "locationName":"SecurityGroup" }, "UserData":{ "shape":"String", "documentation":"

The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.

", "locationName":"blockDeviceMapping" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"NetworkInterface" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" }, "SecurityGroupIds":{ "shape":"ValueStringList", "locationName":"SecurityGroupId" } }, "documentation":"

Describes the launch specification for an instance.

" }, "Reservation":{ "type":"structure", "members":{ "ReservationId":{ "shape":"String", "documentation":"

The ID of the reservation.

", "locationName":"reservationId" }, "OwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that owns the reservation.

", "locationName":"ownerId" }, "RequesterId":{ "shape":"String", "documentation":"

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

", "locationName":"requesterId" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

[EC2-Classic only] One or more security groups.

", "locationName":"groupSet" }, "Instances":{ "shape":"InstanceList", "documentation":"

One or more instances.

", "locationName":"instancesSet" } }, "documentation":"

Describes a reservation.

" }, "ReservationList":{ "type":"list", "member":{ "shape":"Reservation", "locationName":"item" } }, "ReservationState":{ "type":"string", "enum":[ "payment-pending", "payment-failed", "active", "retired" ] }, "ReservationValue":{ "type":"structure", "members":{ "RemainingTotalValue":{ "shape":"String", "documentation":"

The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).

", "locationName":"remainingTotalValue" }, "RemainingUpfrontValue":{ "shape":"String", "documentation":"

The remaining upfront cost of the reservation.

", "locationName":"remainingUpfrontValue" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly rate of the reservation.

", "locationName":"hourlyPrice" } }, "documentation":"

The cost associated with the Reserved Instance.

" }, "ReservedInstanceIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstanceId" } }, "ReservedInstanceLimitPrice":{ "type":"structure", "members":{ "Amount":{ "shape":"Double", "documentation":"

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", "locationName":"amount" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } }, "documentation":"

Describes the limit price of a Reserved Instance offering.

" }, "ReservedInstanceReservationValue":{ "type":"structure", "members":{ "ReservedInstanceId":{ "shape":"String", "documentation":"

The ID of the Convertible Reserved Instance that you are exchanging.

", "locationName":"reservedInstanceId" }, "ReservationValue":{ "shape":"ReservationValue", "documentation":"

The total value of the Convertible Reserved Instance that you are exchanging.

", "locationName":"reservationValue" } }, "documentation":"

The total value of the Convertible Reserved Instance.

" }, "ReservedInstanceReservationValueSet":{ "type":"list", "member":{ "shape":"ReservedInstanceReservationValue", "locationName":"item" } }, "ReservedInstanceState":{ "type":"string", "enum":[ "payment-pending", "active", "payment-failed", "retired" ] }, "ReservedInstances":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used.

", "locationName":"instanceType" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", "locationName":"availabilityZone" }, "Start":{ "shape":"DateTime", "documentation":"

The date and time the Reserved Instance started.

", "locationName":"start" }, "End":{ "shape":"DateTime", "documentation":"

The time when the Reserved Instance expires.

", "locationName":"end" }, "Duration":{ "shape":"Long", "documentation":"

The duration of the Reserved Instance, in seconds.

", "locationName":"duration" }, "UsagePrice":{ "shape":"Float", "documentation":"

The usage price of the Reserved Instance, per hour.

", "locationName":"usagePrice" }, "FixedPrice":{ "shape":"Float", "documentation":"

The purchase price of the Reserved Instance.

", "locationName":"fixedPrice" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of reservations purchased.

", "locationName":"instanceCount" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance product platform description.

", "locationName":"productDescription" }, "State":{ "shape":"ReservedInstanceState", "documentation":"

The state of the Reserved Instance purchase.

", "locationName":"state" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance.

", "locationName":"instanceTenancy" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type.

", "locationName":"offeringType" }, "RecurringCharges":{ "shape":"RecurringChargesList", "documentation":"

The recurring charge tag assigned to the resource.

", "locationName":"recurringCharges" }, "OfferingClass":{ "shape":"OfferingClassType", "documentation":"

The offering class of the Reserved Instance.

", "locationName":"offeringClass" }, "Scope":{ "shape":"scope", "documentation":"

The scope of the Reserved Instance.

", "locationName":"scope" } }, "documentation":"

Describes a Reserved Instance.

" }, "ReservedInstancesConfiguration":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the modified Reserved Instances.

", "locationName":"availabilityZone" }, "Platform":{ "shape":"String", "documentation":"

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", "locationName":"platform" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of modified Reserved Instances.

", "locationName":"instanceCount" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type for the modified Reserved Instances.

", "locationName":"instanceType" }, "Scope":{ "shape":"scope", "documentation":"

Whether the Reserved Instance is standard or convertible.

", "locationName":"scope" } }, "documentation":"

Describes the configuration settings for the modified Reserved Instances.

" }, "ReservedInstancesConfigurationList":{ "type":"list", "member":{ "shape":"ReservedInstancesConfiguration", "locationName":"item" } }, "ReservedInstancesId":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" } }, "documentation":"

Describes the ID of a Reserved Instance.

" }, "ReservedInstancesIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstancesId" } }, "ReservedInstancesList":{ "type":"list", "member":{ "shape":"ReservedInstances", "locationName":"item" } }, "ReservedInstancesListing":{ "type":"structure", "members":{ "ReservedInstancesListingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance listing.

", "locationName":"reservedInstancesListingId" }, "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The time the listing was created.

", "locationName":"createDate" }, "UpdateDate":{ "shape":"DateTime", "documentation":"

The last modified timestamp of the listing.

", "locationName":"updateDate" }, "Status":{ "shape":"ListingStatus", "documentation":"

The status of the Reserved Instance listing.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The reason for the current status of the Reserved Instance listing. The response can be blank.

", "locationName":"statusMessage" }, "InstanceCounts":{ "shape":"InstanceCountList", "documentation":"

The number of instances in this state.

", "locationName":"instanceCounts" }, "PriceSchedules":{ "shape":"PriceScheduleList", "documentation":"

The price of the Reserved Instance listing.

", "locationName":"priceSchedules" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Describes a Reserved Instance listing.

" }, "ReservedInstancesListingList":{ "type":"list", "member":{ "shape":"ReservedInstancesListing", "locationName":"item" } }, "ReservedInstancesModification":{ "type":"structure", "members":{ "ReservedInstancesModificationId":{ "shape":"String", "documentation":"

A unique ID for the Reserved Instance modification.

", "locationName":"reservedInstancesModificationId" }, "ReservedInstancesIds":{ "shape":"ReservedIntancesIds", "documentation":"

The IDs of one or more Reserved Instances.

", "locationName":"reservedInstancesSet" }, "ModificationResults":{ "shape":"ReservedInstancesModificationResultList", "documentation":"

Contains target configurations along with their corresponding new Reserved Instance IDs.

", "locationName":"modificationResultSet" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The time when the modification request was created.

", "locationName":"createDate" }, "UpdateDate":{ "shape":"DateTime", "documentation":"

The time when the modification request was last updated.

", "locationName":"updateDate" }, "EffectiveDate":{ "shape":"DateTime", "documentation":"

The time for the modification to become effective.

", "locationName":"effectiveDate" }, "Status":{ "shape":"String", "documentation":"

The status of the Reserved Instances modification request.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The reason for the status.

", "locationName":"statusMessage" }, "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Describes a Reserved Instance modification.

" }, "ReservedInstancesModificationIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstancesModificationId" } }, "ReservedInstancesModificationList":{ "type":"list", "member":{ "shape":"ReservedInstancesModification", "locationName":"item" } }, "ReservedInstancesModificationResult":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", "locationName":"reservedInstancesId" }, "TargetConfiguration":{ "shape":"ReservedInstancesConfiguration", "documentation":"

The target Reserved Instances configurations supplied as part of the modification request.

", "locationName":"targetConfiguration" } }, "documentation":"

Describes the modification request/s.

" }, "ReservedInstancesModificationResultList":{ "type":"list", "member":{ "shape":"ReservedInstancesModificationResult", "locationName":"item" } }, "ReservedInstancesOffering":{ "type":"structure", "members":{ "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.

", "locationName":"reservedInstancesOfferingId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used.

", "locationName":"instanceType" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", "locationName":"availabilityZone" }, "Duration":{ "shape":"Long", "documentation":"

The duration of the Reserved Instance, in seconds.

", "locationName":"duration" }, "UsagePrice":{ "shape":"Float", "documentation":"

The usage price of the Reserved Instance, per hour.

", "locationName":"usagePrice" }, "FixedPrice":{ "shape":"Float", "documentation":"

The purchase price of the Reserved Instance.

", "locationName":"fixedPrice" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance product platform description.

", "locationName":"productDescription" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance.

", "locationName":"instanceTenancy" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type.

", "locationName":"offeringType" }, "RecurringCharges":{ "shape":"RecurringChargesList", "documentation":"

The recurring charge tag assigned to the resource.

", "locationName":"recurringCharges" }, "Marketplace":{ "shape":"Boolean", "documentation":"

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

", "locationName":"marketplace" }, "PricingDetails":{ "shape":"PricingDetailsList", "documentation":"

The pricing details of the Reserved Instance offering.

", "locationName":"pricingDetailsSet" }, "OfferingClass":{ "shape":"OfferingClassType", "documentation":"

If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard, it is not possible to perform an exchange.

", "locationName":"offeringClass" }, "Scope":{ "shape":"scope", "documentation":"

Whether the Reserved Instance is applied to instances in a region or an Availability Zone.

", "locationName":"scope" } }, "documentation":"

Describes a Reserved Instance offering.

" }, "ReservedInstancesOfferingIdStringList":{ "type":"list", "member":{"shape":"String"} }, "ReservedInstancesOfferingList":{ "type":"list", "member":{ "shape":"ReservedInstancesOffering", "locationName":"item" } }, "ReservedIntancesIds":{ "type":"list", "member":{ "shape":"ReservedInstancesId", "locationName":"item" } }, "ResetImageAttributeName":{ "type":"string", "enum":["launchPermission"] }, "ResetImageAttributeRequest":{ "type":"structure", "required":[ "ImageId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"ResetImageAttributeName", "documentation":"

The attribute to reset (currently you can only reset the launch permission attribute).

" } }, "documentation":"

Contains the parameters for ResetImageAttribute.

" }, "ResetInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The attribute to reset.

You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.

", "locationName":"attribute" } }, "documentation":"

Contains the parameters for ResetInstanceAttribute.

" }, "ResetNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SourceDestCheck":{ "shape":"String", "documentation":"

The source/destination checking attribute. Resets the value to true.

", "locationName":"sourceDestCheck" } }, "documentation":"

Contains the parameters for ResetNetworkInterfaceAttribute.

" }, "ResetSnapshotAttributeRequest":{ "type":"structure", "required":[ "SnapshotId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.

" } }, "documentation":"

Contains the parameters for ResetSnapshotAttribute.

" }, "ResourceIdList":{ "type":"list", "member":{"shape":"String"} }, "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" ] }, "ResponseHostIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "ResponseHostIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "RestorableByStringList":{ "type":"list", "member":{"shape":"String"} }, "RestoreAddressToClassicRequest":{ "type":"structure", "required":["PublicIp"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" } }, "documentation":"

Contains the parameters for RestoreAddressToClassic.

" }, "RestoreAddressToClassicResult":{ "type":"structure", "members":{ "Status":{ "shape":"Status", "documentation":"

The move status for the IP address.

", "locationName":"status" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" } }, "documentation":"

Contains the output of RestoreAddressToClassic.

" }, "RevokeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

The name of a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account number for a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", "locationName":"toPort" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.

", "locationName":"cidrIp" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"ipPermissions" } }, "documentation":"

Contains the parameters for RevokeSecurityGroupEgress.

" }, "RevokeSecurityGroupIngressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a security group in a nondefault VPC.

" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" } }, "documentation":"

Contains the parameters for RevokeSecurityGroupIngress.

" }, "Route":{ "type":"structure", "members":{ "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block used for the destination match.

", "locationName":"destinationCidrBlock" }, "DestinationPrefixListId":{ "shape":"String", "documentation":"

The prefix of the AWS service.

", "locationName":"destinationPrefixListId" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of a gateway attached to your VPC.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC.

", "locationName":"instanceId" }, "InstanceOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the instance.

", "locationName":"instanceOwnerId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" }, "NatGatewayId":{ "shape":"String", "documentation":"

The ID of a NAT gateway.

", "locationName":"natGatewayId" }, "State":{ "shape":"RouteState", "documentation":"

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

", "locationName":"state" }, "Origin":{ "shape":"RouteOrigin", "documentation":"

Describes how the route was created.

  • CreateRouteTable - The route was automatically created when the route table was created.

  • CreateRoute - The route was manually added to the route table.

  • EnableVgwRoutePropagation - The route was propagated by route propagation.

", "locationName":"origin" } }, "documentation":"

Describes a route in a route table.

" }, "RouteList":{ "type":"list", "member":{ "shape":"Route", "locationName":"item" } }, "RouteOrigin":{ "type":"string", "enum":[ "CreateRouteTable", "CreateRoute", "EnableVgwRoutePropagation" ] }, "RouteState":{ "type":"string", "enum":[ "active", "blackhole" ] }, "RouteTable":{ "type":"structure", "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Routes":{ "shape":"RouteList", "documentation":"

The routes in the route table.

", "locationName":"routeSet" }, "Associations":{ "shape":"RouteTableAssociationList", "documentation":"

The associations between the route table and one or more subnets.

", "locationName":"associationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the route table.

", "locationName":"tagSet" }, "PropagatingVgws":{ "shape":"PropagatingVgwList", "documentation":"

Any virtual private gateway (VGW) propagating routes.

", "locationName":"propagatingVgwSet" } }, "documentation":"

Describes a route table.

" }, "RouteTableAssociation":{ "type":"structure", "members":{ "RouteTableAssociationId":{ "shape":"String", "documentation":"

The ID of the association between a route table and a subnet.

", "locationName":"routeTableAssociationId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet. A subnet ID is not returned for an implicit association.

", "locationName":"subnetId" }, "Main":{ "shape":"Boolean", "documentation":"

Indicates whether this is the main route table.

", "locationName":"main" } }, "documentation":"

Describes an association between a route table and a subnet.

" }, "RouteTableAssociationList":{ "type":"list", "member":{ "shape":"RouteTableAssociation", "locationName":"item" } }, "RouteTableList":{ "type":"list", "member":{ "shape":"RouteTable", "locationName":"item" } }, "RuleAction":{ "type":"string", "enum":[ "allow", "deny" ] }, "RunInstancesMonitoringEnabled":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Indicates whether monitoring is enabled for the instance.

", "locationName":"enabled" } }, "documentation":"

Describes the monitoring for the instance.

" }, "RunInstancesRequest":{ "type":"structure", "required":[ "ImageId", "MinCount", "MaxCount" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI, which you can get by calling DescribeImages.

" }, "MinCount":{ "shape":"Integer", "documentation":"

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" }, "MaxCount":{ "shape":"Integer", "documentation":"

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.

" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

" }, "SecurityGroups":{ "shape":"SecurityGroupStringList", "documentation":"

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

", "locationName":"SecurityGroup" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdStringList", "documentation":"

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

", "locationName":"SecurityGroupId" }, "UserData":{ "shape":"String", "documentation":"

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

" }, "Placement":{ "shape":"Placement", "documentation":"

The placement for the instance.

" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

The block device mapping.

Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.

", "locationName":"BlockDeviceMapping" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "documentation":"

The monitoring for the instance.

" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

" }, "DisableApiTermination":{ "shape":"Boolean", "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

", "locationName":"instanceInitiatedShutdownBehavior" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.

Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.

You cannot specify this option if you're launching more than one instance in the request.

Default: We select an IP address from the IP address range of the subnet.

", "locationName":"privateIpAddress" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

", "locationName":"clientToken" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterface" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

", "locationName":"ebsOptimized" } }, "documentation":"

Contains the parameters for RunInstances.

" }, "RunScheduledInstancesRequest":{ "type":"structure", "required":[ "ScheduledInstanceId", "LaunchSpecification" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

", "idempotencyToken":true }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances.

Default: 1

" }, "ScheduledInstanceId":{ "shape":"String", "documentation":"

The Scheduled Instance ID.

" }, "LaunchSpecification":{ "shape":"ScheduledInstancesLaunchSpecification", "documentation":"

The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.

" } }, "documentation":"

Contains the parameters for RunScheduledInstances.

" }, "RunScheduledInstancesResult":{ "type":"structure", "members":{ "InstanceIdSet":{ "shape":"InstanceIdSet", "documentation":"

The IDs of the newly launched instances.

", "locationName":"instanceIdSet" } }, "documentation":"

Contains the output of RunScheduledInstances.

" }, "S3Storage":{ "type":"structure", "members":{ "Bucket":{ "shape":"String", "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

The beginning of the file name of the AMI.

", "locationName":"prefix" }, "AWSAccessKeyId":{ "shape":"String", "documentation":"

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

" }, "UploadPolicy":{ "shape":"Blob", "documentation":"

An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", "locationName":"uploadPolicy" }, "UploadPolicySignature":{ "shape":"String", "documentation":"

The signature of the JSON document.

", "locationName":"uploadPolicySignature" } }, "documentation":"

Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI.

" }, "ScheduledInstance":{ "type":"structure", "members":{ "ScheduledInstanceId":{ "shape":"String", "documentation":"

The Scheduled Instance ID.

", "locationName":"scheduledInstanceId" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Platform":{ "shape":"String", "documentation":"

The platform (Linux/UNIX or Windows).

", "locationName":"platform" }, "NetworkPlatform":{ "shape":"String", "documentation":"

The network platform (EC2-Classic or EC2-VPC).

", "locationName":"networkPlatform" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "SlotDurationInHours":{ "shape":"Integer", "documentation":"

The number of hours in the schedule.

", "locationName":"slotDurationInHours" }, "Recurrence":{ "shape":"ScheduledInstanceRecurrence", "documentation":"

The schedule recurrence.

", "locationName":"recurrence" }, "PreviousSlotEndTime":{ "shape":"DateTime", "documentation":"

The time that the previous schedule ended or will end.

", "locationName":"previousSlotEndTime" }, "NextSlotStartTime":{ "shape":"DateTime", "documentation":"

The time for the next schedule to start.

", "locationName":"nextSlotStartTime" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price for a single instance.

", "locationName":"hourlyPrice" }, "TotalScheduledInstanceHours":{ "shape":"Integer", "documentation":"

The total number of hours for a single instance for the entire term.

", "locationName":"totalScheduledInstanceHours" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances.

", "locationName":"instanceCount" }, "TermStartDate":{ "shape":"DateTime", "documentation":"

The start date for the Scheduled Instance.

", "locationName":"termStartDate" }, "TermEndDate":{ "shape":"DateTime", "documentation":"

The end date for the Scheduled Instance.

", "locationName":"termEndDate" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The date when the Scheduled Instance was purchased.

", "locationName":"createDate" } }, "documentation":"

Describes a Scheduled Instance.

" }, "ScheduledInstanceAvailability":{ "type":"structure", "members":{ "InstanceType":{ "shape":"String", "documentation":"

The instance type. You can specify one of the C3, C4, M4, or R3 instance types.

", "locationName":"instanceType" }, "Platform":{ "shape":"String", "documentation":"

The platform (Linux/UNIX or Windows).

", "locationName":"platform" }, "NetworkPlatform":{ "shape":"String", "documentation":"

The network platform (EC2-Classic or EC2-VPC).

", "locationName":"networkPlatform" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "PurchaseToken":{ "shape":"String", "documentation":"

The purchase token. This token expires in two hours.

", "locationName":"purchaseToken" }, "SlotDurationInHours":{ "shape":"Integer", "documentation":"

The number of hours in the schedule.

", "locationName":"slotDurationInHours" }, "Recurrence":{ "shape":"ScheduledInstanceRecurrence", "documentation":"

The schedule recurrence.

", "locationName":"recurrence" }, "FirstSlotStartTime":{ "shape":"DateTime", "documentation":"

The time period for the first schedule to start.

", "locationName":"firstSlotStartTime" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price for a single instance.

", "locationName":"hourlyPrice" }, "TotalScheduledInstanceHours":{ "shape":"Integer", "documentation":"

The total number of hours for a single instance for the entire term.

", "locationName":"totalScheduledInstanceHours" }, "AvailableInstanceCount":{ "shape":"Integer", "documentation":"

The number of available instances.

", "locationName":"availableInstanceCount" }, "MinTermDurationInDays":{ "shape":"Integer", "documentation":"

The minimum term. The only possible value is 365 days.

", "locationName":"minTermDurationInDays" }, "MaxTermDurationInDays":{ "shape":"Integer", "documentation":"

The maximum term. The only possible value is 365 days.

", "locationName":"maxTermDurationInDays" } }, "documentation":"

Describes a schedule that is available for your Scheduled Instances.

" }, "ScheduledInstanceAvailabilitySet":{ "type":"list", "member":{ "shape":"ScheduledInstanceAvailability", "locationName":"item" } }, "ScheduledInstanceIdRequestSet":{ "type":"list", "member":{ "shape":"String", "locationName":"ScheduledInstanceId" } }, "ScheduledInstanceRecurrence":{ "type":"structure", "members":{ "Frequency":{ "shape":"String", "documentation":"

The frequency (Daily, Weekly, or Monthly).

", "locationName":"frequency" }, "Interval":{ "shape":"Integer", "documentation":"

The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months.

", "locationName":"interval" }, "OccurrenceDaySet":{ "shape":"OccurrenceDaySet", "documentation":"

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).

", "locationName":"occurrenceDaySet" }, "OccurrenceRelativeToEnd":{ "shape":"Boolean", "documentation":"

Indicates whether the occurrence is relative to the end of the specified week or month.

", "locationName":"occurrenceRelativeToEnd" }, "OccurrenceUnit":{ "shape":"String", "documentation":"

The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).

", "locationName":"occurrenceUnit" } }, "documentation":"

Describes the recurring schedule for a Scheduled Instance.

" }, "ScheduledInstanceRecurrenceRequest":{ "type":"structure", "members":{ "Frequency":{ "shape":"String", "documentation":"

The frequency (Daily, Weekly, or Monthly).

" }, "Interval":{ "shape":"Integer", "documentation":"

The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.

" }, "OccurrenceDays":{ "shape":"OccurrenceDayRequestSet", "documentation":"

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.

", "locationName":"OccurrenceDay" }, "OccurrenceRelativeToEnd":{ "shape":"Boolean", "documentation":"

Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.

" }, "OccurrenceUnit":{ "shape":"String", "documentation":"

The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.

" } }, "documentation":"

Describes the recurring schedule for a Scheduled Instance.

" }, "ScheduledInstanceSet":{ "type":"list", "member":{ "shape":"ScheduledInstance", "locationName":"item" } }, "ScheduledInstancesBlockDeviceMapping":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

" }, "NoDevice":{ "shape":"String", "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

" }, "VirtualName":{ "shape":"String", "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

" }, "Ebs":{ "shape":"ScheduledInstancesEbs", "documentation":"

Parameters used to set up EBS volumes automatically when the instance is launched.

" } }, "documentation":"

Describes a block device mapping for a Scheduled Instance.

" }, "ScheduledInstancesBlockDeviceMappingSet":{ "type":"list", "member":{ "shape":"ScheduledInstancesBlockDeviceMapping", "locationName":"BlockDeviceMapping" } }, "ScheduledInstancesEbs":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

" }, "VolumeType":{ "shape":"String", "documentation":"

The volume type. gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for Magnetic.

Default: standard

" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about gp2 baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.

" } }, "documentation":"

Describes an EBS volume for a Scheduled Instance.

" }, "ScheduledInstancesIamInstanceProfile":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN).

" }, "Name":{ "shape":"String", "documentation":"

The name.

" } }, "documentation":"

Describes an IAM instance profile for a Scheduled Instance.

" }, "ScheduledInstancesLaunchSpecification":{ "type":"structure", "required":["ImageId"], "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the Amazon Machine Image (AMI).

" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

" }, "SecurityGroupIds":{ "shape":"ScheduledInstancesSecurityGroupIdSet", "documentation":"

The IDs of one or more security groups.

", "locationName":"SecurityGroupId" }, "UserData":{ "shape":"String", "documentation":"

The base64-encoded MIME user data.

" }, "Placement":{ "shape":"ScheduledInstancesPlacement", "documentation":"

The placement information.

" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type.

" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

" }, "BlockDeviceMappings":{ "shape":"ScheduledInstancesBlockDeviceMappingSet", "documentation":"

One or more block device mapping entries.

", "locationName":"BlockDeviceMapping" }, "Monitoring":{ "shape":"ScheduledInstancesMonitoring", "documentation":"

Enable or disable monitoring for the instances.

" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instances.

" }, "NetworkInterfaces":{ "shape":"ScheduledInstancesNetworkInterfaceSet", "documentation":"

One or more network interfaces.

", "locationName":"NetworkInterface" }, "IamInstanceProfile":{ "shape":"ScheduledInstancesIamInstanceProfile", "documentation":"

The IAM instance profile.

" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

" } }, "documentation":"

Describes the launch specification for a Scheduled Instance.

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.

" }, "ScheduledInstancesMonitoring":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Indicates whether monitoring is enabled.

" } }, "documentation":"

Describes whether monitoring is enabled for a Scheduled Instance.

" }, "ScheduledInstancesNetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device for the network interface attachment.

" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

" }, "Description":{ "shape":"String", "documentation":"

The description.

" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

" }, "PrivateIpAddressConfigs":{ "shape":"PrivateIpAddressConfigSet", "documentation":"

The private IP addresses.

", "locationName":"PrivateIpAddressConfig" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses.

" }, "AssociatePublicIpAddress":{ "shape":"Boolean", "documentation":"

Indicates whether to assign a public IP address to instances launched in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

" }, "Groups":{ "shape":"ScheduledInstancesSecurityGroupIdSet", "documentation":"

The IDs of one or more security groups.

", "locationName":"Group" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether to delete the interface when the instance is terminated.

" } }, "documentation":"

Describes a network interface for a Scheduled Instance.

" }, "ScheduledInstancesNetworkInterfaceSet":{ "type":"list", "member":{ "shape":"ScheduledInstancesNetworkInterface", "locationName":"NetworkInterface" } }, "ScheduledInstancesPlacement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

" } }, "documentation":"

Describes the placement for a Scheduled Instance.

" }, "ScheduledInstancesPrivateIpAddressConfig":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address.

" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this is a primary IP address. Otherwise, this is a secondary IP address.

" } }, "documentation":"

Describes a private IP address for a Scheduled Instance.

" }, "ScheduledInstancesSecurityGroupIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroupId" } }, "SecurityGroup":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the security group.

", "locationName":"ownerId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "Description":{ "shape":"String", "documentation":"

A description of the security group.

", "locationName":"groupDescription" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

One or more inbound rules associated with the security group.

", "locationName":"ipPermissions" }, "IpPermissionsEgress":{ "shape":"IpPermissionList", "documentation":"

[EC2-VPC] One or more outbound rules associated with the security group.

", "locationName":"ipPermissionsEgress" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC for the security group.

", "locationName":"vpcId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the security group.

", "locationName":"tagSet" } }, "documentation":"

Describes a security group

" }, "SecurityGroupIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroupId" } }, "SecurityGroupList":{ "type":"list", "member":{ "shape":"SecurityGroup", "locationName":"item" } }, "SecurityGroupReference":{ "type":"structure", "required":[ "GroupId", "ReferencingVpcId" ], "members":{ "GroupId":{ "shape":"String", "documentation":"

The ID of your security group.

", "locationName":"groupId" }, "ReferencingVpcId":{ "shape":"String", "documentation":"

The ID of the VPC with the referencing security group.

", "locationName":"referencingVpcId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Describes a VPC with a security group that references your security group.

" }, "SecurityGroupReferences":{ "type":"list", "member":{ "shape":"SecurityGroupReference", "locationName":"item" } }, "SecurityGroupStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroup" } }, "ShutdownBehavior":{ "type":"string", "enum":[ "stop", "terminate" ] }, "SlotDateTimeRangeRequest":{ "type":"structure", "required":[ "EarliestTime", "LatestTime" ], "members":{ "EarliestTime":{ "shape":"DateTime", "documentation":"

The earliest date and time, in UTC, for the Scheduled Instance to start.

" }, "LatestTime":{ "shape":"DateTime", "documentation":"

The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.

" } }, "documentation":"

Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.

" }, "SlotStartTimeRangeRequest":{ "type":"structure", "members":{ "EarliestTime":{ "shape":"DateTime", "documentation":"

The earliest date and time, in UTC, for the Scheduled Instance to start.

" }, "LatestTime":{ "shape":"DateTime", "documentation":"

The latest date and time, in UTC, for the Scheduled Instance to start.

" } }, "documentation":"

Describes the time period for a Scheduled Instance to start its first schedule.

" }, "Snapshot":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

", "locationName":"snapshotId" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

", "locationName":"volumeId" }, "State":{ "shape":"SnapshotState", "documentation":"

The snapshot state.

", "locationName":"status" }, "StateMessage":{ "shape":"String", "documentation":"

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

", "locationName":"statusMessage" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time stamp when the snapshot was initiated.

", "locationName":"startTime" }, "Progress":{ "shape":"String", "documentation":"

The progress of the snapshot, as a percentage.

", "locationName":"progress" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the EBS snapshot owner.

", "locationName":"ownerId" }, "Description":{ "shape":"String", "documentation":"

The description for the snapshot.

", "locationName":"description" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

", "locationName":"volumeSize" }, "OwnerAlias":{ "shape":"String", "documentation":"

Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

", "locationName":"ownerAlias" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the snapshot.

", "locationName":"tagSet" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the snapshot is encrypted.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

", "locationName":"kmsKeyId" }, "DataEncryptionKeyId":{ "shape":"String", "documentation":"

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

", "locationName":"dataEncryptionKeyId" } }, "documentation":"

Describes a snapshot.

" }, "SnapshotAttributeName":{ "type":"string", "enum":[ "productCodes", "createVolumePermission" ] }, "SnapshotDetail":{ "type":"structure", "members":{ "DiskImageSize":{ "shape":"Double", "documentation":"

The size of the disk in the snapshot, in GiB.

", "locationName":"diskImageSize" }, "Description":{ "shape":"String", "documentation":"

A description for the snapshot.

", "locationName":"description" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image from which the snapshot is created.

", "locationName":"format" }, "Url":{ "shape":"String", "documentation":"

The URL used to access the disk image.

", "locationName":"url" }, "UserBucket":{ "shape":"UserBucketDetails", "documentation":"

The S3 bucket for the disk image.

", "locationName":"userBucket" }, "DeviceName":{ "shape":"String", "documentation":"

The block device mapping for the snapshot.

", "locationName":"deviceName" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot ID of the disk being imported.

", "locationName":"snapshotId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of progress for the task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message for the snapshot creation.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status of the snapshot creation.

", "locationName":"status" } }, "documentation":"

Describes the snapshot created from the imported disk.

" }, "SnapshotDetailList":{ "type":"list", "member":{ "shape":"SnapshotDetail", "locationName":"item" } }, "SnapshotDiskContainer":{ "type":"structure", "members":{ "Description":{ "shape":"String", "documentation":"

The description of the disk image being imported.

" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" }, "Url":{ "shape":"String", "documentation":"

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).

" }, "UserBucket":{ "shape":"UserBucket", "documentation":"

The S3 bucket for the disk image.

" } }, "documentation":"

The disk container object for the import snapshot request.

" }, "SnapshotIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SnapshotId" } }, "SnapshotList":{ "type":"list", "member":{ "shape":"Snapshot", "locationName":"item" } }, "SnapshotState":{ "type":"string", "enum":[ "pending", "completed", "error" ] }, "SnapshotTaskDetail":{ "type":"structure", "members":{ "DiskImageSize":{ "shape":"Double", "documentation":"

The size of the disk in the snapshot, in GiB.

", "locationName":"diskImageSize" }, "Description":{ "shape":"String", "documentation":"

The description of the snapshot.

", "locationName":"description" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image from which the snapshot is created.

", "locationName":"format" }, "Url":{ "shape":"String", "documentation":"

The URL of the disk image from which the snapshot is created.

", "locationName":"url" }, "UserBucket":{ "shape":"UserBucketDetails", "documentation":"

The S3 bucket for the disk image.

", "locationName":"userBucket" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot ID of the disk being imported.

", "locationName":"snapshotId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of completion for the import snapshot task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message for the import snapshot task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status for the import snapshot task.

", "locationName":"status" } }, "documentation":"

Details about the import snapshot task.

" }, "SpotDatafeedSubscription":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the account.

", "locationName":"ownerId" }, "Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket where the Spot instance data feed is located.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

The prefix that is prepended to data feed files.

", "locationName":"prefix" }, "State":{ "shape":"DatafeedSubscriptionState", "documentation":"

The state of the Spot instance data feed subscription.

", "locationName":"state" }, "Fault":{ "shape":"SpotInstanceStateFault", "documentation":"

The fault codes for the Spot instance request, if any.

", "locationName":"fault" } }, "documentation":"

Describes the data feed for a Spot instance.

" }, "SpotFleetLaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", "locationName":"groupSet" }, "UserData":{ "shape":"String", "documentation":"

The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" }, "Monitoring":{ "shape":"SpotFleetMonitoring", "documentation":"

Enable or disable monitoring for the instances.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, \"subnet-a61dafcf, subnet-65ea5f08\".

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "WeightedCapacity":{ "shape":"Double", "documentation":"

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).

If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.

", "locationName":"weightedCapacity" }, "SpotPrice":{ "shape":"String", "documentation":"

The bid price per unit hour for the specified instance type. If this value is not specified, the default is the Spot bid price specified for the fleet. To determine the bid price per unit hour, divide the Spot bid price by the value of WeightedCapacity.

", "locationName":"spotPrice" } }, "documentation":"

Describes the launch specification for one or more Spot instances.

" }, "SpotFleetMonitoring":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Enables monitoring for the instance.

Default: false

", "locationName":"enabled" } }, "documentation":"

Describes whether monitoring is enabled.

" }, "SpotFleetRequestConfig":{ "type":"structure", "required":[ "SpotFleetRequestId", "SpotFleetRequestState", "SpotFleetRequestConfig", "CreateTime" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "SpotFleetRequestState":{ "shape":"BatchState", "documentation":"

The state of the Spot fleet request.

", "locationName":"spotFleetRequestState" }, "SpotFleetRequestConfig":{ "shape":"SpotFleetRequestConfigData", "documentation":"

Information about the configuration of the Spot fleet request.

", "locationName":"spotFleetRequestConfig" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The creation date and time of the request.

", "locationName":"createTime" }, "ActivityStatus":{ "shape":"ActivityStatus", "documentation":"

The progress of the Spot fleet request. If there is an error, the status is error. After all bids are placed, the status is pending_fulfillment. If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the fleet is decreased, the status is pending_termination while Spot instances are terminating.

", "locationName":"activityStatus" } }, "documentation":"

Describes a Spot fleet request.

" }, "SpotFleetRequestConfigData":{ "type":"structure", "required":[ "SpotPrice", "TargetCapacity", "IamFleetRole", "LaunchSpecifications" ], "members":{ "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" }, "SpotPrice":{ "shape":"String", "documentation":"

The bid price per unit hour.

", "locationName":"spotPrice" }, "TargetCapacity":{ "shape":"Integer", "documentation":"

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O.

", "locationName":"targetCapacity" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot instance requests are placed or enabled to fulfill the request.

", "locationName":"validUntil" }, "TerminateInstancesWithExpiration":{ "shape":"Boolean", "documentation":"

Indicates whether running Spot instances should be terminated when the Spot fleet request expires.

", "locationName":"terminateInstancesWithExpiration" }, "IamFleetRole":{ "shape":"String", "documentation":"

Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration.

", "locationName":"iamFleetRole" }, "LaunchSpecifications":{ "shape":"LaunchSpecsList", "documentation":"

Information about the launch specifications for the Spot fleet request.

", "locationName":"launchSpecifications" }, "ExcessCapacityTerminationPolicy":{ "shape":"ExcessCapacityTerminationPolicy", "documentation":"

Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.

", "locationName":"excessCapacityTerminationPolicy" }, "AllocationStrategy":{ "shape":"AllocationStrategy", "documentation":"

Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is lowestPrice.

", "locationName":"allocationStrategy" }, "FulfilledCapacity":{ "shape":"Double", "documentation":"

The number of units fulfilled by this request compared to the set target capacity.

", "locationName":"fulfilledCapacity" }, "Type":{ "shape":"FleetType", "documentation":"

The type of request. Indicates whether the fleet will only request the target capacity or also attempt to maintain it. When you request a certain target capacity, the fleet will only place the required bids. It will not attempt to replenish Spot instances if capacity is diminished, nor will it submit bids in alternative Spot pools if capacity is not available. When you want to maintain a certain target capacity, fleet will place the required bids to meet this target capacity. It will also automatically replenish any interrupted instances. Default: maintain.

", "locationName":"type" } }, "documentation":"

Describes the configuration of a Spot fleet request.

" }, "SpotFleetRequestConfigSet":{ "type":"list", "member":{ "shape":"SpotFleetRequestConfig", "locationName":"item" } }, "SpotInstanceRequest":{ "type":"structure", "members":{ "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot instance request.

", "locationName":"spotInstanceRequestId" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum hourly price (bid) for the Spot instance launched to fulfill the request.

", "locationName":"spotPrice" }, "Type":{ "shape":"SpotInstanceType", "documentation":"

The Spot instance request type.

", "locationName":"type" }, "State":{ "shape":"SpotInstanceState", "documentation":"

The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"state" }, "Fault":{ "shape":"SpotInstanceStateFault", "documentation":"

The fault codes for the Spot instance request, if any.

", "locationName":"fault" }, "Status":{ "shape":"SpotInstanceStatus", "documentation":"

The status code and status message describing the Spot instance request.

", "locationName":"status" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.

", "locationName":"validUntil" }, "LaunchGroup":{ "shape":"String", "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

", "locationName":"launchGroup" }, "AvailabilityZoneGroup":{ "shape":"String", "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.

", "locationName":"availabilityZoneGroup" }, "LaunchSpecification":{ "shape":"LaunchSpecification", "documentation":"

Additional information for launching instances.

", "locationName":"launchSpecification" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID, if an instance has been launched to fulfill the Spot instance request.

", "locationName":"instanceId" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The date and time when the Spot instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"createTime" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The product description associated with the Spot instance.

", "locationName":"productDescription" }, "BlockDurationMinutes":{ "shape":"Integer", "documentation":"

The duration for the Spot instance, in minutes.

", "locationName":"blockDurationMinutes" }, "ActualBlockHourlyPrice":{ "shape":"String", "documentation":"

If you specified a duration and your Spot instance request was fulfilled, this is the fixed hourly price in effect for the Spot instance while it runs.

", "locationName":"actualBlockHourlyPrice" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "LaunchedAvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the bid is launched.

", "locationName":"launchedAvailabilityZone" } }, "documentation":"

Describes a Spot instance request.

" }, "SpotInstanceRequestIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"SpotInstanceRequestId" } }, "SpotInstanceRequestList":{ "type":"list", "member":{ "shape":"SpotInstanceRequest", "locationName":"item" } }, "SpotInstanceState":{ "type":"string", "enum":[ "open", "active", "closed", "cancelled", "failed" ] }, "SpotInstanceStateFault":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The reason code for the Spot instance state change.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The message for the Spot instance state change.

", "locationName":"message" } }, "documentation":"

Describes a Spot instance state change.

" }, "SpotInstanceStatus":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The status code. For a list of status codes, see Spot Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"code" }, "UpdateTime":{ "shape":"DateTime", "documentation":"

The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"updateTime" }, "Message":{ "shape":"String", "documentation":"

The description for the status code.

", "locationName":"message" } }, "documentation":"

Describes the status of a Spot instance request.

" }, "SpotInstanceType":{ "type":"string", "enum":[ "one-time", "persistent" ] }, "SpotPlacement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

[Spot fleet only] To specify multiple Availability Zones, separate them using commas; for example, \"us-west-2a, us-west-2b\".

", "locationName":"availabilityZone" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group (for cluster instances).

", "locationName":"groupName" } }, "documentation":"

Describes Spot instance placement.

" }, "SpotPrice":{ "type":"structure", "members":{ "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

A general description of the AMI.

", "locationName":"productDescription" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum price (bid) that you are willing to pay for a Spot instance.

", "locationName":"spotPrice" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"timestamp" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" } }, "documentation":"

Describes the maximum hourly price (bid) for any Spot instance launched to fulfill the request.

" }, "SpotPriceHistoryList":{ "type":"list", "member":{ "shape":"SpotPrice", "locationName":"item" } }, "StaleIpPermission":{ "type":"structure", "members":{ "FromPort":{ "shape":"Integer", "documentation":"

The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", "locationName":"fromPort" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

", "locationName":"ipProtocol" }, "IpRanges":{ "shape":"IpRanges", "documentation":"

One or more IP ranges. Not applicable for stale security group rules.

", "locationName":"ipRanges" }, "PrefixListIds":{ "shape":"PrefixListIdSet", "documentation":"

One or more prefix list IDs for an AWS service. Not applicable for stale security group rules.

", "locationName":"prefixListIds" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", "locationName":"toPort" }, "UserIdGroupPairs":{ "shape":"UserIdGroupPairSet", "documentation":"

One or more security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.

", "locationName":"groups" } }, "documentation":"

Describes a stale rule in a security group.

" }, "StaleIpPermissionSet":{ "type":"list", "member":{ "shape":"StaleIpPermission", "locationName":"item" } }, "StaleSecurityGroup":{ "type":"structure", "required":["GroupId"], "members":{ "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "Description":{ "shape":"String", "documentation":"

The description of the security group.

", "locationName":"description" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for the security group.

", "locationName":"vpcId" }, "StaleIpPermissions":{ "shape":"StaleIpPermissionSet", "documentation":"

Information about the stale inbound rules in the security group.

", "locationName":"staleIpPermissions" }, "StaleIpPermissionsEgress":{ "shape":"StaleIpPermissionSet", "documentation":"

Information about the stale outbound rules in the security group.

", "locationName":"staleIpPermissionsEgress" } }, "documentation":"

Describes a stale security group (a security group that contains stale rules).

" }, "StaleSecurityGroupSet":{ "type":"list", "member":{ "shape":"StaleSecurityGroup", "locationName":"item" } }, "StartInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for StartInstances.

" }, "StartInstancesResult":{ "type":"structure", "members":{ "StartingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more started instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of StartInstances.

" }, "State":{ "type":"string", "enum":[ "Pending", "Available", "Deleting", "Deleted" ] }, "StateReason":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The reason code for the state change.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The message for the state change.

  • Server.SpotInstanceTermination: A Spot instance was terminated due to an increase in the market price.

  • Server.InternalError: An internal error occurred during instance launch, resulting in termination.

  • Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

  • Client.InternalError: A client error caused the instance to terminate on launch.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your limits.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

", "locationName":"message" } }, "documentation":"

Describes a state change.

" }, "Status":{ "type":"string", "enum":[ "MoveInProgress", "InVpc", "InClassic" ] }, "StatusName":{ "type":"string", "enum":["reachability"] }, "StatusType":{ "type":"string", "enum":[ "passed", "failed", "insufficient-data", "initializing" ] }, "StopInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" }, "Force":{ "shape":"Boolean", "documentation":"

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

", "locationName":"force" } }, "documentation":"

Contains the parameters for StopInstances.

" }, "StopInstancesResult":{ "type":"structure", "members":{ "StoppingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more stopped instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of StopInstances.

" }, "Storage":{ "type":"structure", "members":{ "S3":{ "shape":"S3Storage", "documentation":"

An Amazon S3 storage location.

" } }, "documentation":"

Describes the storage location for an instance store-backed AMI.

" }, "String":{"type":"string"}, "Subnet":{ "type":"structure", "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "State":{ "shape":"SubnetState", "documentation":"

The current state of the subnet.

", "locationName":"state" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC the subnet is in.

", "locationName":"vpcId" }, "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block assigned to the subnet.

", "locationName":"cidrBlock" }, "AvailableIpAddressCount":{ "shape":"Integer", "documentation":"

The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.

", "locationName":"availableIpAddressCount" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the subnet.

", "locationName":"availabilityZone" }, "DefaultForAz":{ "shape":"Boolean", "documentation":"

Indicates whether this is the default subnet for the Availability Zone.

", "locationName":"defaultForAz" }, "MapPublicIpOnLaunch":{ "shape":"Boolean", "documentation":"

Indicates whether instances launched in this subnet receive a public IP address.

", "locationName":"mapPublicIpOnLaunch" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the subnet.

", "locationName":"tagSet" } }, "documentation":"

Describes a subnet.

" }, "SubnetIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SubnetId" } }, "SubnetList":{ "type":"list", "member":{ "shape":"Subnet", "locationName":"item" } }, "SubnetState":{ "type":"string", "enum":[ "pending", "available" ] }, "SummaryStatus":{ "type":"string", "enum":[ "ok", "impaired", "insufficient-data", "not-applicable", "initializing" ] }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", "locationName":"value" } }, "documentation":"

Describes a tag.

" }, "TagDescription":{ "type":"structure", "members":{ "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource. For example, ami-1a2b3c4d.

", "locationName":"resourceId" }, "ResourceType":{ "shape":"ResourceType", "documentation":"

The resource type.

", "locationName":"resourceType" }, "Key":{ "shape":"String", "documentation":"

The tag key.

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The tag value.

", "locationName":"value" } }, "documentation":"

Describes a tag.

" }, "TagDescriptionList":{ "type":"list", "member":{ "shape":"TagDescription", "locationName":"item" } }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"item" } }, "TargetConfiguration":{ "type":"structure", "members":{ "OfferingId":{ "shape":"String", "documentation":"

The ID of the Convertible Reserved Instance offering.

", "locationName":"offeringId" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request

", "locationName":"instanceCount" } }, "documentation":"

Information about the Convertible Reserved Instance offering.

" }, "TargetConfigurationRequest":{ "type":"structure", "required":["OfferingId"], "members":{ "OfferingId":{ "shape":"String", "documentation":"

The Convertible Reserved Instance offering ID. If this isn't included in the request, the response lists your current Convertible Reserved Instance/s and their value/s.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances the Covertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request

" } }, "documentation":"

Details about the target configuration.

" }, "TargetConfigurationRequestSet":{ "type":"list", "member":{ "shape":"TargetConfigurationRequest", "locationName":"TargetConfigurationRequest" } }, "TargetReservationValue":{ "type":"structure", "members":{ "TargetConfiguration":{ "shape":"TargetConfiguration", "documentation":"

The configuration of the Convertible Reserved Instances that make up the exchange.

", "locationName":"targetConfiguration" }, "ReservationValue":{ "shape":"ReservationValue", "documentation":"

The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of the list value, remaining upfront price, and additional upfront cost of the exchange.

", "locationName":"reservationValue" } }, "documentation":"

The total value of the new Convertible Reserved Instances.

" }, "TargetReservationValueSet":{ "type":"list", "member":{ "shape":"TargetReservationValue", "locationName":"item" } }, "TelemetryStatus":{ "type":"string", "enum":[ "UP", "DOWN" ] }, "Tenancy":{ "type":"string", "enum":[ "default", "dedicated", "host" ] }, "TerminateInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.

", "locationName":"InstanceId" } }, "documentation":"

Contains the parameters for TerminateInstances.

" }, "TerminateInstancesResult":{ "type":"structure", "members":{ "TerminatingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more terminated instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of TerminateInstances.

" }, "TrafficType":{ "type":"string", "enum":[ "ACCEPT", "REJECT", "ALL" ] }, "UnassignPrivateIpAddressesRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "PrivateIpAddresses" ], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", "documentation":"

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

", "locationName":"privateIpAddress" } }, "documentation":"

Contains the parameters for UnassignPrivateIpAddresses.

" }, "UnmonitorInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } }, "documentation":"

Contains the parameters for UnmonitorInstances.

" }, "UnmonitorInstancesResult":{ "type":"structure", "members":{ "InstanceMonitorings":{ "shape":"InstanceMonitoringList", "documentation":"

Monitoring information for one or more instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of UnmonitorInstances.

" }, "UnsuccessfulItem":{ "type":"structure", "required":["Error"], "members":{ "Error":{ "shape":"UnsuccessfulItemError", "documentation":"

Information about the error.

", "locationName":"error" }, "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource.

", "locationName":"resourceId" } }, "documentation":"

Information about items that were not successfully processed in a batch call.

" }, "UnsuccessfulItemError":{ "type":"structure", "required":[ "Code", "Message" ], "members":{ "Code":{ "shape":"String", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The error message accompanying the error code.

", "locationName":"message" } }, "documentation":"

Information about the error that occurred. For more information about errors, see Error Codes.

" }, "UnsuccessfulItemList":{ "type":"list", "member":{ "shape":"UnsuccessfulItem", "locationName":"item" } }, "UnsuccessfulItemSet":{ "type":"list", "member":{ "shape":"UnsuccessfulItem", "locationName":"item" } }, "UserBucket":{ "type":"structure", "members":{ "S3Bucket":{ "shape":"String", "documentation":"

The name of the S3 bucket where the disk image is located.

" }, "S3Key":{ "shape":"String", "documentation":"

The file name of the disk image.

" } }, "documentation":"

Describes the S3 bucket for the disk image.

" }, "UserBucketDetails":{ "type":"structure", "members":{ "S3Bucket":{ "shape":"String", "documentation":"

The S3 bucket from which the disk image was created.

", "locationName":"s3Bucket" }, "S3Key":{ "shape":"String", "documentation":"

The file name of the disk image.

", "locationName":"s3Key" } }, "documentation":"

Describes the S3 bucket for the disk image.

" }, "UserData":{ "type":"structure", "members":{ "Data":{ "shape":"String", "documentation":"

The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"data" } }, "documentation":"

Describes the user data for an instance.

" }, "UserGroupStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"UserGroup" } }, "UserIdGroupPair":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The ID of an AWS account. For a referenced security group in another VPC, the account ID of the referenced security group is returned.

[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.

", "locationName":"userId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for the referenced security group, if applicable.

", "locationName":"vpcId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection, if applicable.

", "locationName":"vpcPeeringConnectionId" }, "PeeringStatus":{ "shape":"String", "documentation":"

The status of a VPC peering connection, if applicable.

", "locationName":"peeringStatus" } }, "documentation":"

Describes a security group and AWS account ID pair.

" }, "UserIdGroupPairList":{ "type":"list", "member":{ "shape":"UserIdGroupPair", "locationName":"item" } }, "UserIdGroupPairSet":{ "type":"list", "member":{ "shape":"UserIdGroupPair", "locationName":"item" } }, "UserIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"UserId" } }, "ValueStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "VgwTelemetry":{ "type":"structure", "members":{ "OutsideIpAddress":{ "shape":"String", "documentation":"

The Internet-routable IP address of the virtual private gateway's outside interface.

", "locationName":"outsideIpAddress" }, "Status":{ "shape":"TelemetryStatus", "documentation":"

The status of the VPN tunnel.

", "locationName":"status" }, "LastStatusChange":{ "shape":"DateTime", "documentation":"

The date and time of the last change in status.

", "locationName":"lastStatusChange" }, "StatusMessage":{ "shape":"String", "documentation":"

If an error occurs, a description of the error.

", "locationName":"statusMessage" }, "AcceptedRouteCount":{ "shape":"Integer", "documentation":"

The number of accepted routes.

", "locationName":"acceptedRouteCount" } }, "documentation":"

Describes telemetry for a VPN tunnel.

" }, "VgwTelemetryList":{ "type":"list", "member":{ "shape":"VgwTelemetry", "locationName":"item" } }, "VirtualizationType":{ "type":"string", "enum":[ "hvm", "paravirtual" ] }, "Volume":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "Size":{ "shape":"Integer", "documentation":"

The size of the volume, in GiBs.

", "locationName":"size" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot from which the volume was created, if applicable.

", "locationName":"snapshotId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the volume.

", "locationName":"availabilityZone" }, "State":{ "shape":"VolumeState", "documentation":"

The volume state.

", "locationName":"status" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The time stamp when volume creation was initiated.

", "locationName":"createTime" }, "Attachments":{ "shape":"VolumeAttachmentList", "documentation":"

Information about the volume attachments.

", "locationName":"attachmentSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the volume.

", "locationName":"tagSet" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

", "locationName":"volumeType" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", "locationName":"iops" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the volume will be encrypted.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

", "locationName":"kmsKeyId" } }, "documentation":"

Describes a volume.

" }, "VolumeAttachment":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Device":{ "shape":"String", "documentation":"

The device name.

", "locationName":"device" }, "State":{ "shape":"VolumeAttachmentState", "documentation":"

The attachment state of the volume.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes volume attachment details.

" }, "VolumeAttachmentList":{ "type":"list", "member":{ "shape":"VolumeAttachment", "locationName":"item" } }, "VolumeAttachmentState":{ "type":"string", "enum":[ "attaching", "attached", "detaching", "detached" ] }, "VolumeAttributeName":{ "type":"string", "enum":[ "autoEnableIO", "productCodes" ] }, "VolumeDetail":{ "type":"structure", "required":["Size"], "members":{ "Size":{ "shape":"Long", "documentation":"

The size of the volume, in GiB.

", "locationName":"size" } }, "documentation":"

Describes an EBS volume.

" }, "VolumeIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VolumeId" } }, "VolumeList":{ "type":"list", "member":{ "shape":"Volume", "locationName":"item" } }, "VolumeState":{ "type":"string", "enum":[ "creating", "available", "in-use", "deleting", "deleted", "error" ] }, "VolumeStatusAction":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The code identifying the operation, for example, enable-volume-io.

", "locationName":"code" }, "Description":{ "shape":"String", "documentation":"

A description of the operation.

", "locationName":"description" }, "EventType":{ "shape":"String", "documentation":"

The event type associated with this operation.

", "locationName":"eventType" }, "EventId":{ "shape":"String", "documentation":"

The ID of the event associated with this operation.

", "locationName":"eventId" } }, "documentation":"

Describes a volume status operation code.

" }, "VolumeStatusActionsList":{ "type":"list", "member":{ "shape":"VolumeStatusAction", "locationName":"item" } }, "VolumeStatusDetails":{ "type":"structure", "members":{ "Name":{ "shape":"VolumeStatusName", "documentation":"

The name of the volume status.

", "locationName":"name" }, "Status":{ "shape":"String", "documentation":"

The intended status of the volume status.

", "locationName":"status" } }, "documentation":"

Describes a volume status.

" }, "VolumeStatusDetailsList":{ "type":"list", "member":{ "shape":"VolumeStatusDetails", "locationName":"item" } }, "VolumeStatusEvent":{ "type":"structure", "members":{ "EventType":{ "shape":"String", "documentation":"

The type of this event.

", "locationName":"eventType" }, "Description":{ "shape":"String", "documentation":"

A description of the event.

", "locationName":"description" }, "NotBefore":{ "shape":"DateTime", "documentation":"

The earliest start time of the event.

", "locationName":"notBefore" }, "NotAfter":{ "shape":"DateTime", "documentation":"

The latest end time of the event.

", "locationName":"notAfter" }, "EventId":{ "shape":"String", "documentation":"

The ID of this event.

", "locationName":"eventId" } }, "documentation":"

Describes a volume status event.

" }, "VolumeStatusEventsList":{ "type":"list", "member":{ "shape":"VolumeStatusEvent", "locationName":"item" } }, "VolumeStatusInfo":{ "type":"structure", "members":{ "Status":{ "shape":"VolumeStatusInfoStatus", "documentation":"

The status of the volume.

", "locationName":"status" }, "Details":{ "shape":"VolumeStatusDetailsList", "documentation":"

The details of the volume status.

", "locationName":"details" } }, "documentation":"

Describes the status of a volume.

" }, "VolumeStatusInfoStatus":{ "type":"string", "enum":[ "ok", "impaired", "insufficient-data" ] }, "VolumeStatusItem":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

", "locationName":"volumeId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the volume.

", "locationName":"availabilityZone" }, "VolumeStatus":{ "shape":"VolumeStatusInfo", "documentation":"

The volume status.

", "locationName":"volumeStatus" }, "Events":{ "shape":"VolumeStatusEventsList", "documentation":"

A list of events associated with the volume.

", "locationName":"eventsSet" }, "Actions":{ "shape":"VolumeStatusActionsList", "documentation":"

The details of the operation.

", "locationName":"actionsSet" } }, "documentation":"

Describes the volume status.

" }, "VolumeStatusList":{ "type":"list", "member":{ "shape":"VolumeStatusItem", "locationName":"item" } }, "VolumeStatusName":{ "type":"string", "enum":[ "io-enabled", "io-performance" ] }, "VolumeType":{ "type":"string", "enum":[ "standard", "io1", "gp2", "sc1", "st1" ] }, "Vpc":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"VpcState", "documentation":"

The current state of the VPC.

", "locationName":"state" }, "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block for the VPC.

", "locationName":"cidrBlock" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

", "locationName":"dhcpOptionsId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPC.

", "locationName":"tagSet" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The allowed tenancy of instances launched into the VPC.

", "locationName":"instanceTenancy" }, "IsDefault":{ "shape":"Boolean", "documentation":"

Indicates whether the VPC is the default VPC.

", "locationName":"isDefault" } }, "documentation":"

Describes a VPC.

" }, "VpcAttachment":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"AttachmentStatus", "documentation":"

The current state of the attachment.

", "locationName":"state" } }, "documentation":"

Describes an attachment between a virtual private gateway and a VPC.

" }, "VpcAttachmentList":{ "type":"list", "member":{ "shape":"VpcAttachment", "locationName":"item" } }, "VpcAttributeName":{ "type":"string", "enum":[ "enableDnsSupport", "enableDnsHostnames" ] }, "VpcClassicLink":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "ClassicLinkEnabled":{ "shape":"Boolean", "documentation":"

Indicates whether the VPC is enabled for ClassicLink.

", "locationName":"classicLinkEnabled" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPC.

", "locationName":"tagSet" } }, "documentation":"

Describes whether a VPC is enabled for ClassicLink.

" }, "VpcClassicLinkIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcId" } }, "VpcClassicLinkList":{ "type":"list", "member":{ "shape":"VpcClassicLink", "locationName":"item" } }, "VpcEndpoint":{ "type":"structure", "members":{ "VpcEndpointId":{ "shape":"String", "documentation":"

The ID of the VPC endpoint.

", "locationName":"vpcEndpointId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC to which the endpoint is associated.

", "locationName":"vpcId" }, "ServiceName":{ "shape":"String", "documentation":"

The name of the AWS service to which the endpoint is associated.

", "locationName":"serviceName" }, "State":{ "shape":"State", "documentation":"

The state of the VPC endpoint.

", "locationName":"state" }, "PolicyDocument":{ "shape":"String", "documentation":"

The policy document associated with the endpoint.

", "locationName":"policyDocument" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route tables associated with the endpoint.

", "locationName":"routeTableIdSet" }, "CreationTimestamp":{ "shape":"DateTime", "documentation":"

The date and time the VPC endpoint was created.

", "locationName":"creationTimestamp" } }, "documentation":"

Describes a VPC endpoint.

" }, "VpcEndpointSet":{ "type":"list", "member":{ "shape":"VpcEndpoint", "locationName":"item" } }, "VpcIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcId" } }, "VpcList":{ "type":"list", "member":{ "shape":"Vpc", "locationName":"item" } }, "VpcPeeringConnection":{ "type":"structure", "members":{ "AccepterVpcInfo":{ "shape":"VpcPeeringConnectionVpcInfo", "documentation":"

Information about the accepter VPC. CIDR block information is not returned when creating a VPC peering connection, or when describing a VPC peering connection that's in the initiating-request or pending-acceptance state.

", "locationName":"accepterVpcInfo" }, "ExpirationTime":{ "shape":"DateTime", "documentation":"

The time that an unaccepted VPC peering connection will expire.

", "locationName":"expirationTime" }, "RequesterVpcInfo":{ "shape":"VpcPeeringConnectionVpcInfo", "documentation":"

Information about the requester VPC.

", "locationName":"requesterVpcInfo" }, "Status":{ "shape":"VpcPeeringConnectionStateReason", "documentation":"

The status of the VPC peering connection.

", "locationName":"status" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Describes a VPC peering connection.

" }, "VpcPeeringConnectionList":{ "type":"list", "member":{ "shape":"VpcPeeringConnection", "locationName":"item" } }, "VpcPeeringConnectionOptionsDescription":{ "type":"structure", "members":{ "AllowEgressFromLocalClassicLinkToRemoteVpc":{ "shape":"Boolean", "documentation":"

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

", "locationName":"allowEgressFromLocalClassicLinkToRemoteVpc" }, "AllowEgressFromLocalVpcToRemoteClassicLink":{ "shape":"Boolean", "documentation":"

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.

", "locationName":"allowEgressFromLocalVpcToRemoteClassicLink" }, "AllowDnsResolutionFromRemoteVpc":{ "shape":"Boolean", "documentation":"

Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.

", "locationName":"allowDnsResolutionFromRemoteVpc" } }, "documentation":"

Describes the VPC peering connection options.

" }, "VpcPeeringConnectionStateReason":{ "type":"structure", "members":{ "Code":{ "shape":"VpcPeeringConnectionStateReasonCode", "documentation":"

The status of the VPC peering connection.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

A message that provides more information about the status, if applicable.

", "locationName":"message" } }, "documentation":"

Describes the status of a VPC peering connection.

" }, "VpcPeeringConnectionStateReasonCode":{ "type":"string", "enum":[ "initiating-request", "pending-acceptance", "active", "deleted", "rejected", "failed", "expired", "provisioning", "deleting" ] }, "VpcPeeringConnectionVpcInfo":{ "type":"structure", "members":{ "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block for the VPC.

", "locationName":"cidrBlock" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the VPC owner.

", "locationName":"ownerId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "PeeringOptions":{ "shape":"VpcPeeringConnectionOptionsDescription", "documentation":"

Information about the VPC peering connection options for the accepter or requester VPC.

", "locationName":"peeringOptions" } }, "documentation":"

Describes a VPC in a VPC peering connection.

" }, "VpcState":{ "type":"string", "enum":[ "pending", "available" ] }, "VpnConnection":{ "type":"structure", "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

", "locationName":"vpnConnectionId" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the VPN connection.

", "locationName":"state" }, "CustomerGatewayConfiguration":{ "shape":"String", "documentation":"

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

", "locationName":"customerGatewayConfiguration" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection.

", "locationName":"type" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway at your end of the VPN connection.

", "locationName":"customerGatewayId" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

", "locationName":"vpnGatewayId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPN connection.

", "locationName":"tagSet" }, "VgwTelemetry":{ "shape":"VgwTelemetryList", "documentation":"

Information about the VPN tunnel.

", "locationName":"vgwTelemetry" }, "Options":{ "shape":"VpnConnectionOptions", "documentation":"

The VPN connection options.

", "locationName":"options" }, "Routes":{ "shape":"VpnStaticRouteList", "documentation":"

The static routes associated with the VPN connection.

", "locationName":"routes" } }, "documentation":"

Describes a VPN connection.

" }, "VpnConnectionIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpnConnectionId" } }, "VpnConnectionList":{ "type":"list", "member":{ "shape":"VpnConnection", "locationName":"item" } }, "VpnConnectionOptions":{ "type":"structure", "members":{ "StaticRoutesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "locationName":"staticRoutesOnly" } }, "documentation":"

Describes VPN connection options.

" }, "VpnConnectionOptionsSpecification":{ "type":"structure", "members":{ "StaticRoutesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "locationName":"staticRoutesOnly" } }, "documentation":"

Describes VPN connection options.

" }, "VpnGateway":{ "type":"structure", "members":{ "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

", "locationName":"vpnGatewayId" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the virtual private gateway.

", "locationName":"state" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection the virtual private gateway supports.

", "locationName":"type" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

", "locationName":"availabilityZone" }, "VpcAttachments":{ "shape":"VpcAttachmentList", "documentation":"

Any VPCs attached to the virtual private gateway.

", "locationName":"attachments" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the virtual private gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes a virtual private gateway.

" }, "VpnGatewayIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpnGatewayId" } }, "VpnGatewayList":{ "type":"list", "member":{ "shape":"VpnGateway", "locationName":"item" } }, "VpnState":{ "type":"string", "enum":[ "pending", "available", "deleting", "deleted" ] }, "VpnStaticRoute":{ "type":"structure", "members":{ "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer data center.

", "locationName":"destinationCidrBlock" }, "Source":{ "shape":"VpnStaticRouteSource", "documentation":"

Indicates how the routes were provided.

", "locationName":"source" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the static route.

", "locationName":"state" } }, "documentation":"

Describes a static route for a VPN connection.

" }, "VpnStaticRouteList":{ "type":"list", "member":{ "shape":"VpnStaticRoute", "locationName":"item" } }, "VpnStaticRouteSource":{ "type":"string", "enum":["Static"] }, "ZoneNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ZoneName" } }, "scope":{ "type":"string", "enum":[ "Availability Zone", "Region" ] } }, "documentation":"Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.

" } botocore-1.5.7/botocore/data/ec2/2014-09-01/0000777454262600001440000000000013042511307020636 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ec2/2014-09-01/waiters-2.json0000666454262600001440000002054413042511306023352 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "BundleTaskComplete": { "delay": 15, "operation": "DescribeBundleTasks", "maxAttempts": 40, "acceptors": [ { "expected": "complete", "matcher": "pathAll", "state": "success", "argument": "BundleTasks[].State" }, { "expected": "failed", "matcher": "pathAny", "state": "failure", "argument": "BundleTasks[].State" } ] }, "ConversionTaskCancelled": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "cancelled", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" } ] }, "ConversionTaskCompleted": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" }, { "expected": "cancelled", "matcher": "pathAny", "state": "failure", "argument": "ConversionTasks[].State" }, { "expected": "cancelling", "matcher": "pathAny", "state": "failure", "argument": "ConversionTasks[].State" } ] }, "ConversionTaskDeleted": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" } ] }, "CustomerGatewayAvailable": { "delay": 15, "operation": "DescribeCustomerGateways", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "CustomerGateways[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "CustomerGateways[].State" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "CustomerGateways[].State" } ] }, "ExportTaskCancelled": { "delay": 15, "operation": "DescribeExportTasks", "maxAttempts": 40, "acceptors": [ { "expected": "cancelled", "matcher": "pathAll", "state": "success", "argument": "ExportTasks[].State" } ] }, "ExportTaskCompleted": { "delay": 15, "operation": "DescribeExportTasks", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "ExportTasks[].State" } ] }, "InstanceRunning": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "running", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "shutting-down", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "InstanceStopped": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "stopped", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "InstanceTerminated": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "terminated", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "SnapshotCompleted": { "delay": 15, "operation": "DescribeSnapshots", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "Snapshots[].State" } ] }, "SubnetAvailable": { "delay": 15, "operation": "DescribeSubnets", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Subnets[].State" } ] }, "VolumeAvailable": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Volumes[].State" } ] }, "VolumeDeleted": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" } ] }, "VolumeInUse": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "in-use", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Volumes[].State" } ] }, "VpcAvailable": { "delay": 15, "operation": "DescribeVpcs", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Vpcs[].State" } ] }, "VpnConnectionAvailable": { "delay": 15, "operation": "DescribeVpnConnections", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "VpnConnections[].State" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" } ] }, "VpnConnectionDeleted": { "delay": 15, "operation": "DescribeVpnConnections", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "VpnConnections[].State" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" } ] } } } botocore-1.5.7/botocore/data/ec2/2014-09-01/paginators-1.json0000666454262600001440000000236713042511306024045 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeInstanceStatus": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "InstanceStatuses" }, "DescribeInstances": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Reservations" }, "DescribeReservedInstancesModifications": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "ReservedInstancesModifications" }, "DescribeReservedInstancesOfferings": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "ReservedInstancesOfferings" }, "DescribeSpotPriceHistory": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "SpotPriceHistory" }, "DescribeTags": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Tags" }, "DescribeVolumeStatus": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "VolumeStatuses" } } } botocore-1.5.7/botocore/data/ec2/2014-09-01/service-2.json0000666454262600001440000203637413042511306023346 0ustar pysdk-ciamazon00000000000000{ "metadata":{ "apiVersion":"2014-09-01", "endpointPrefix":"ec2", "serviceAbbreviation":"Amazon EC2", "serviceFullName":"Amazon Elastic Compute Cloud", "signatureVersion":"v4", "xmlNamespace":"http://ec2.amazonaws.com/doc/2014-09-01", "protocol":"ec2" }, "documentation":"Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.

", "operations":{ "AcceptVpcPeeringConnection":{ "name":"AcceptVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, "output":{"shape":"AcceptVpcPeeringConnectionResult"}, "documentation":"

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.

" }, "AllocateAddress":{ "name":"AllocateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AllocateAddressRequest"}, "output":{"shape":"AllocateAddressResult"}, "documentation":"

Acquires an Elastic IP address.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" }, "AssignPrivateIpAddresses":{ "name":"AssignPrivateIpAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssignPrivateIpAddressesRequest"}, "documentation":"

Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

AssignPrivateIpAddresses is available only in EC2-VPC.

" }, "AssociateAddress":{ "name":"AssociateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateAddressRequest"}, "output":{"shape":"AssociateAddressResult"}, "documentation":"

Associates an Elastic IP address with an instance or a network interface.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" }, "AssociateDhcpOptions":{ "name":"AssociateDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateDhcpOptionsRequest"}, "documentation":"

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "AssociateRouteTable":{ "name":"AssociateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateRouteTableRequest"}, "output":{"shape":"AssociateRouteTableResult"}, "documentation":"

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "AttachInternetGateway":{ "name":"AttachInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachInternetGatewayRequest"}, "documentation":"

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" }, "AttachNetworkInterface":{ "name":"AttachNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachNetworkInterfaceRequest"}, "output":{"shape":"AttachNetworkInterfaceResult"}, "documentation":"

Attaches a network interface to an instance.

" }, "AttachVolume":{ "name":"AttachVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachVolumeRequest"}, "output":{ "shape":"VolumeAttachment", "locationName":"attachment" }, "documentation":"

Attaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For a list of supported device names, see Attaching an Amazon EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for Amazon EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.

If a volume has an AWS Marketplace product code:

  • The volume can only be attached as the root device of a stopped instance.
  • You must be subscribed to the AWS Marketplace code that is on the volume.
  • The configuration (instance type, operating system) of the instance must support that specific AWS Marketplace code. For example, you cannot take a volume from a Windows instance and attach it to a Linux instance.
  • AWS Marketplace product codes are copied from the volume to the instance.

For an overview of the AWS Marketplace, see https://aws.amazon.com/marketplace/help/200900000. For more information about how to use the AWS Marketplace, see AWS Marketplace.

For more information about Amazon EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "AttachVpnGateway":{ "name":"AttachVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachVpnGatewayRequest"}, "output":{"shape":"AttachVpnGatewayResult"}, "documentation":"

Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "AuthorizeSecurityGroupEgress":{ "name":"AuthorizeSecurityGroupEgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, "documentation":"

Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC.

You can have up to 50 rules per security group (covering both ingress and egress rules).

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

" }, "AuthorizeSecurityGroupIngress":{ "name":"AuthorizeSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, "documentation":"

Adds one or more ingress rules to a security group.

EC2-Classic: You can have up to 100 rules per group.

EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.

[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.

" }, "BundleInstance":{ "name":"BundleInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BundleInstanceRequest"}, "output":{"shape":"BundleInstanceResult"}, "documentation":"

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

For more information, see Creating an Instance Store-Backed Windows AMI.

" }, "CancelBundleTask":{ "name":"CancelBundleTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelBundleTaskRequest"}, "output":{"shape":"CancelBundleTaskResult"}, "documentation":"

Cancels a bundling operation for an instance store-backed Windows instance.

" }, "CancelConversionTask":{ "name":"CancelConversionTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelConversionRequest"}, "documentation":"

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" }, "CancelExportTask":{ "name":"CancelExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelExportTaskRequest"}, "documentation":"

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" }, "CancelReservedInstancesListing":{ "name":"CancelReservedInstancesListing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelReservedInstancesListingRequest"}, "output":{"shape":"CancelReservedInstancesListingResult"}, "documentation":"

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "CancelSpotInstanceRequests":{ "name":"CancelSpotInstanceRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelSpotInstanceRequestsRequest"}, "output":{"shape":"CancelSpotInstanceRequestsResult"}, "documentation":"

Cancels one or more Spot Instance requests. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information about Spot Instances, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

" }, "ConfirmProductInstance":{ "name":"ConfirmProductInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmProductInstanceRequest"}, "output":{"shape":"ConfirmProductInstanceResult"}, "documentation":"

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.

" }, "CopyImage":{ "name":"CopyImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyImageRequest"}, "output":{"shape":"CopyImageResult"}, "documentation":"

Initiates the copy of an AMI from the specified source region to the region in which the request was made. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted Amazon EBS snapshots cannot be copied with this method.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide.

" }, "CopySnapshot":{ "name":"CopySnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopySnapshotRequest"}, "output":{"shape":"CopySnapshotResult"}, "documentation":"

Copies a point-in-time snapshot of an Amazon EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create Amazon EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted Amazon EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateCustomerGateway":{ "name":"CreateCustomerGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCustomerGatewayRequest"}, "output":{"shape":"CreateCustomerGatewayResult"}, "documentation":"

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateDhcpOptions":{ "name":"CreateDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDhcpOptionsRequest"}, "output":{"shape":"CreateDhcpOptionsResult"}, "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.
  • domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). If specifying more than one domain name, separate them with spaces.
  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateImage":{ "name":"CreateImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateImageRequest"}, "output":{"shape":"CreateImageResult"}, "documentation":"

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateInstanceExportTask":{ "name":"CreateInstanceExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInstanceExportTaskRequest"}, "output":{"shape":"CreateInstanceExportTaskResult"}, "documentation":"

Exports a running or stopped instance to an Amazon S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting EC2 Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateInternetGateway":{ "name":"CreateInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInternetGatewayRequest"}, "output":{"shape":"CreateInternetGatewayResult"}, "documentation":"

Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" }, "CreateKeyPair":{ "name":"CreateKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateKeyPairRequest"}, "output":{ "shape":"KeyPair", "documentation":"

Information about the key pair.

", "locationName":"keyPair" }, "documentation":"

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateNetworkAcl":{ "name":"CreateNetworkAcl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkAclRequest"}, "output":{"shape":"CreateNetworkAclResult"}, "documentation":"

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkAclEntry":{ "name":"CreateNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkAclEntryRequest"}, "documentation":"

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkInterface":{ "name":"CreateNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkInterfaceRequest"}, "output":{"shape":"CreateNetworkInterfaceResult"}, "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide.

" }, "CreatePlacementGroup":{ "name":"CreatePlacementGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlacementGroupRequest"}, "documentation":"

Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.

For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateReservedInstancesListing":{ "name":"CreateReservedInstancesListing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateReservedInstancesListingRequest"}, "output":{"shape":"CreateReservedInstancesListingResult"}, "documentation":"

Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the DescribeReservedInstances operation.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Reserved Instances, you must first register as a Seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateRoute":{ "name":"CreateRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRouteRequest"}, "documentation":"

Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "CreateRouteTable":{ "name":"CreateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRouteTableRequest"}, "output":{"shape":"CreateRouteTableResult"}, "documentation":"

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "CreateSecurityGroup":{ "name":"CreateSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSecurityGroupRequest"}, "output":{"shape":"CreateSecurityGroupResult"}, "documentation":"

Creates a security group.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

EC2-Classic: You can have up to 500 security groups.

EC2-VPC: You can create up to 100 security groups per VPC.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

" }, "CreateSnapshot":{ "name":"CreateSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSnapshotRequest"}, "output":{ "shape":"Snapshot", "locationName":"snapshot" }, "documentation":"

Creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of Amazon EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateSpotDatafeedSubscription":{ "name":"CreateSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, "documentation":"

Creates a datafeed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateSubnet":{ "name":"CreateSubnet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSubnetRequest"}, "output":{"shape":"CreateSubnetResult"}, "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).

AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateTags":{ "name":"CreateTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTagsRequest"}, "documentation":"

Adds or overwrites one or more tags for the specified EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateVolume":{ "name":"CreateVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVolumeRequest"}, "output":{ "shape":"Volume", "locationName":"volume" }, "documentation":"

Creates an Amazon EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the specified region.

You can create a new empty volume or restore a volume from an Amazon EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateVpc":{ "name":"CreateVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcRequest"}, "output":{"shape":"CreateVpcResult"}, "documentation":"

Creates a VPC with the specified CIDR block.

The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpcPeeringConnection":{ "name":"CreateVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcPeeringConnectionRequest"}, "output":{"shape":"CreateVpcPeeringConnectionResult"}, "documentation":"

Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.

The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.

" }, "CreateVpnConnection":{ "name":"CreateVpnConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnConnectionRequest"}, "output":{"shape":"CreateVpnConnectionResult"}, "documentation":"

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpnConnectionRoute":{ "name":"CreateVpnConnectionRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnConnectionRouteRequest"}, "documentation":"

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpnGateway":{ "name":"CreateVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnGatewayRequest"}, "output":{"shape":"CreateVpnGatewayResult"}, "documentation":"

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DeleteCustomerGateway":{ "name":"DeleteCustomerGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCustomerGatewayRequest"}, "documentation":"

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" }, "DeleteDhcpOptions":{ "name":"DeleteDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDhcpOptionsRequest"}, "documentation":"

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" }, "DeleteInternetGateway":{ "name":"DeleteInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteInternetGatewayRequest"}, "documentation":"

Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.

" }, "DeleteKeyPair":{ "name":"DeleteKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteKeyPairRequest"}, "documentation":"

Deletes the specified key pair, by removing the public key from Amazon EC2.

" }, "DeleteNetworkAcl":{ "name":"DeleteNetworkAcl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkAclRequest"}, "documentation":"

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" }, "DeleteNetworkAclEntry":{ "name":"DeleteNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkAclEntryRequest"}, "documentation":"

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" }, "DeleteNetworkInterface":{ "name":"DeleteNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkInterfaceRequest"}, "documentation":"

Deletes the specified network interface. You must detach the network interface before you can delete it.

" }, "DeletePlacementGroup":{ "name":"DeletePlacementGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePlacementGroupRequest"}, "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteRoute":{ "name":"DeleteRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRouteRequest"}, "documentation":"

Deletes the specified route from the specified route table.

" }, "DeleteRouteTable":{ "name":"DeleteRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRouteTableRequest"}, "documentation":"

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" }, "DeleteSecurityGroup":{ "name":"DeleteSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSecurityGroupRequest"}, "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" }, "DeleteSnapshot":{ "name":"DeleteSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSnapshotRequest"}, "documentation":"

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an Amazon EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteSpotDatafeedSubscription":{ "name":"DeleteSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSpotDatafeedSubscriptionRequest"}, "documentation":"

Deletes the datafeed for Spot Instances. For more information, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteSubnet":{ "name":"DeleteSubnet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSubnetRequest"}, "documentation":"

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsRequest"}, "documentation":"

Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteVolume":{ "name":"DeleteVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVolumeRequest"}, "documentation":"

Deletes the specified Amazon EBS volume. The volume must be in the available state (not attached to an instance).

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteVpc":{ "name":"DeleteVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcRequest"}, "documentation":"

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" }, "DeleteVpcPeeringConnection":{ "name":"DeleteVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, "output":{"shape":"DeleteVpcPeeringConnectionResult"}, "documentation":"

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.

" }, "DeleteVpnConnection":{ "name":"DeleteVpnConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnConnectionRequest"}, "documentation":"

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" }, "DeleteVpnConnectionRoute":{ "name":"DeleteVpnConnectionRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnConnectionRouteRequest"}, "documentation":"

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" }, "DeleteVpnGateway":{ "name":"DeleteVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnGatewayRequest"}, "documentation":"

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" }, "DeregisterImage":{ "name":"DeregisterImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterImageRequest"}, "documentation":"

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

This command does not delete the AMI.

" }, "DescribeAccountAttributes":{ "name":"DescribeAccountAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAccountAttributesRequest"}, "output":{"shape":"DescribeAccountAttributesResult"}, "documentation":"

Describes the specified attribute of your AWS account.

" }, "DescribeAddresses":{ "name":"DescribeAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAddressesRequest"}, "output":{"shape":"DescribeAddressesResult"}, "documentation":"

Describes one or more of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeAvailabilityZones":{ "name":"DescribeAvailabilityZones", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAvailabilityZonesRequest"}, "output":{"shape":"DescribeAvailabilityZonesResult"}, "documentation":"

Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeBundleTasks":{ "name":"DescribeBundleTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeBundleTasksRequest"}, "output":{"shape":"DescribeBundleTasksResult"}, "documentation":"

Describes one or more of your bundling tasks.

" }, "DescribeConversionTasks":{ "name":"DescribeConversionTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConversionTasksRequest"}, "output":{"shape":"DescribeConversionTasksResult"}, "documentation":"

Describes one or more of your conversion tasks. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeCustomerGateways":{ "name":"DescribeCustomerGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCustomerGatewaysRequest"}, "output":{"shape":"DescribeCustomerGatewaysResult"}, "documentation":"

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeDhcpOptions":{ "name":"DescribeDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDhcpOptionsRequest"}, "output":{"shape":"DescribeDhcpOptionsResult"}, "documentation":"

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeExportTasks":{ "name":"DescribeExportTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeExportTasksRequest"}, "output":{"shape":"DescribeExportTasksResult"}, "documentation":"

Describes one or more of your export tasks.

" }, "DescribeImageAttribute":{ "name":"DescribeImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImageAttributeRequest"}, "output":{ "shape":"ImageAttribute", "documentation":"

Information about the image attribute.

", "locationName":"imageAttribute" }, "documentation":"

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" }, "DescribeImages":{ "name":"DescribeImages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImagesRequest"}, "output":{"shape":"DescribeImagesResult"}, "documentation":"

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

" }, "DescribeInstanceAttribute":{ "name":"DescribeInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceAttributeRequest"}, "output":{"shape":"InstanceAttribute"}, "documentation":"

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" }, "DescribeInstanceStatus":{ "name":"DescribeInstanceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceStatusRequest"}, "output":{"shape":"DescribeInstanceStatusResult"}, "documentation":"

Describes the status of one or more instances, including any scheduled events.

Instance status has two main components:

  • System Status reports impaired functionality that stems from issues related to the systems that support an instance, such as such as hardware failures and network connectivity problems. This call reports such problems as impaired reachability.

  • Instance Status reports impaired functionality that arises from problems internal to the instance. This call reports such problems as impaired reachability.

Instance status provides information about four types of scheduled events for an instance that may require your attention:

  • Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the instances status returns one of two event codes: system-reboot or instance-reboot. System reboot commonly occurs if certain maintenance or upgrade operations require a reboot of the underlying host that supports an instance. Instance reboot commonly occurs if the instance must be rebooted, rather than the underlying host. Rebooting events include a scheduled start and end time.

  • System Maintenance: When Amazon EC2 determines that an instance requires maintenance that requires power or network impact, the instance status is the event code system-maintenance. System maintenance is either power maintenance or network maintenance. For power maintenance, your instance will be unavailable for a brief period of time and then rebooted. For network maintenance, your instance will experience a brief loss of network connectivity. System maintenance events include a scheduled start and end time. You will also be notified by email if one of your instances is set for system maintenance. The email message indicates when your instance is scheduled for maintenance.

  • Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the instance status is the event code instance-retirement. Retirement commonly occurs when the underlying host is degraded and must be replaced. Retirement events include a scheduled start and end time. You will also be notified by email if one of your instances is set to retiring. The email message indicates when your instance will be permanently retired.

  • Scheduled Stop: When Amazon EC2 determines that an instance must be shut down, the instances status returns an event code called instance-stop. Stop events include a scheduled start and end time. You will also be notified by email if one of your instances is set to stop. The email message indicates when your instance will be stopped.

When your instance is retired, it will either be terminated (if its root device type is the instance-store) or stopped (if its root device type is an EBS volume). Instances stopped due to retirement will not be restarted, but you can do so manually. You can also avoid retirement of EBS-backed instances by manually restarting your instance when its event code is instance-retirement. This ensures that your instance is started on a different underlying host.

For more information about failed status checks, see Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide. For more information about working with scheduled events, see Working with an Instance That Has a Scheduled Event in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeInstances":{ "name":"DescribeInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancesRequest"}, "output":{"shape":"DescribeInstancesResult"}, "documentation":"

Describes one or more of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

" }, "DescribeInternetGateways":{ "name":"DescribeInternetGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInternetGatewaysRequest"}, "output":{"shape":"DescribeInternetGatewaysResult"}, "documentation":"

Describes one or more of your Internet gateways.

" }, "DescribeKeyPairs":{ "name":"DescribeKeyPairs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeKeyPairsRequest"}, "output":{"shape":"DescribeKeyPairsResult"}, "documentation":"

Describes one or more of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeNetworkAcls":{ "name":"DescribeNetworkAcls", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkAclsRequest"}, "output":{"shape":"DescribeNetworkAclsResult"}, "documentation":"

Describes one or more of your network ACLs.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeNetworkInterfaceAttribute":{ "name":"DescribeNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, "documentation":"

Describes a network interface attribute. You can specify only one attribute at a time.

" }, "DescribeNetworkInterfaces":{ "name":"DescribeNetworkInterfaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkInterfacesRequest"}, "output":{"shape":"DescribeNetworkInterfacesResult"}, "documentation":"

Describes one or more of your network interfaces.

" }, "DescribePlacementGroups":{ "name":"DescribePlacementGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePlacementGroupsRequest"}, "output":{"shape":"DescribePlacementGroupsResult"}, "documentation":"

Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeRegions":{ "name":"DescribeRegions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRegionsRequest"}, "output":{"shape":"DescribeRegionsResult"}, "documentation":"

Describes one or more regions that are currently available to you.

For a list of the regions supported by Amazon EC2, see Regions and Endpoints.

" }, "DescribeReservedInstances":{ "name":"DescribeReservedInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesRequest"}, "output":{"shape":"DescribeReservedInstancesResult"}, "documentation":"

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesListings":{ "name":"DescribeReservedInstancesListings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesListingsRequest"}, "output":{"shape":"DescribeReservedInstancesListingsResult"}, "documentation":"

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesModifications":{ "name":"DescribeReservedInstancesModifications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, "output":{"shape":"DescribeReservedInstancesModificationsResult"}, "documentation":"

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesOfferings":{ "name":"DescribeReservedInstancesOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, "documentation":"

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeRouteTables":{ "name":"DescribeRouteTables", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRouteTablesRequest"}, "output":{"shape":"DescribeRouteTablesResult"}, "documentation":"

Describes one or more of your route tables.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeSecurityGroups":{ "name":"DescribeSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSecurityGroupsRequest"}, "output":{"shape":"DescribeSecurityGroupsResult"}, "documentation":"

Describes one or more of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeSnapshotAttribute":{ "name":"DescribeSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotAttributeRequest"}, "output":{"shape":"DescribeSnapshotAttributeResult"}, "documentation":"

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSnapshots":{ "name":"DescribeSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotsRequest"}, "output":{"shape":"DescribeSnapshotsResult"}, "documentation":"

Describes one or more of the Amazon EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.
  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.
  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSpotDatafeedSubscription":{ "name":"DescribeSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, "documentation":"

Describes the datafeed for Spot Instances. For more information, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSpotInstanceRequests":{ "name":"DescribeSpotInstanceRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, "output":{"shape":"DescribeSpotInstanceRequestsResult"}, "documentation":"

Describes the Spot Instance requests that belong to your account. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information about Spot Instances, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.

You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

" }, "DescribeSpotPriceHistory":{ "name":"DescribeSpotPriceHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotPriceHistoryRequest"}, "output":{"shape":"DescribeSpotPriceHistoryResult"}, "documentation":"

Describes the Spot Price history. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information about Spot Instances, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.

When you specify an Availability Zone, this operation describes the price history for the specified Availability Zone with the most recent set of prices listed first. If you don't specify an Availability Zone, you get the prices across all Availability Zones, starting with the most recent set. However, if you're using an API version earlier than 2011-05-15, you get the lowest price across the region for the specified time period. The prices returned are listed in chronological order, from the oldest to the most recent.

When you specify the start and end time options, this operation returns two pieces of data: the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" }, "DescribeSubnets":{ "name":"DescribeSubnets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSubnetsRequest"}, "output":{"shape":"DescribeSubnetsResult"}, "documentation":"

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsRequest"}, "output":{"shape":"DescribeTagsResult"}, "documentation":"

Describes one or more of the tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVolumeAttribute":{ "name":"DescribeVolumeAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumeAttributeRequest"}, "output":{"shape":"DescribeVolumeAttributeResult"}, "documentation":"

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVolumeStatus":{ "name":"DescribeVolumeStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumeStatusRequest"}, "output":{"shape":"DescribeVolumeStatusResult"}, "documentation":"

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

" }, "DescribeVolumes":{ "name":"DescribeVolumes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumesRequest"}, "output":{"shape":"DescribeVolumesResult"}, "documentation":"

Describes the specified Amazon EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVpcAttribute":{ "name":"DescribeVpcAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcAttributeRequest"}, "output":{"shape":"DescribeVpcAttributeResult"}, "documentation":"

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" }, "DescribeVpcPeeringConnections":{ "name":"DescribeVpcPeeringConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, "documentation":"

Describes one or more of your VPC peering connections.

" }, "DescribeVpcs":{ "name":"DescribeVpcs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcsRequest"}, "output":{"shape":"DescribeVpcsResult"}, "documentation":"

Describes one or more of your VPCs.

" }, "DescribeVpnConnections":{ "name":"DescribeVpnConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpnConnectionsRequest"}, "output":{"shape":"DescribeVpnConnectionsResult"}, "documentation":"

Describes one or more of your VPN connections.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeVpnGateways":{ "name":"DescribeVpnGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpnGatewaysRequest"}, "output":{"shape":"DescribeVpnGatewaysResult"}, "documentation":"

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DetachInternetGateway":{ "name":"DetachInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachInternetGatewayRequest"}, "documentation":"

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.

" }, "DetachNetworkInterface":{ "name":"DetachNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachNetworkInterfaceRequest"}, "documentation":"

Detaches a network interface from an instance.

" }, "DetachVolume":{ "name":"DetachVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachVolumeRequest"}, "output":{ "shape":"VolumeAttachment", "locationName":"attachment" }, "documentation":"

Detaches an Amazon EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching.

If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

If the root volume is detached from an instance with an AWS Marketplace product code, then the AWS Marketplace product codes from that volume are no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "DetachVpnGateway":{ "name":"DetachVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachVpnGatewayRequest"}, "documentation":"

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" }, "DisableVgwRoutePropagation":{ "name":"DisableVgwRoutePropagation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVgwRoutePropagationRequest"}, "documentation":"

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" }, "DisassociateAddress":{ "name":"DisassociateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateAddressRequest"}, "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" }, "DisassociateRouteTable":{ "name":"DisassociateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateRouteTableRequest"}, "documentation":"

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "EnableVgwRoutePropagation":{ "name":"EnableVgwRoutePropagation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVgwRoutePropagationRequest"}, "documentation":"

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" }, "EnableVolumeIO":{ "name":"EnableVolumeIO", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVolumeIORequest"}, "documentation":"

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" }, "GetConsoleOutput":{ "name":"GetConsoleOutput", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetConsoleOutputRequest"}, "output":{"shape":"GetConsoleOutputResult"}, "documentation":"

Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.

For Linux/Unix instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a machine. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output displays the last three system event log errors.

" }, "GetPasswordData":{ "name":"GetPasswordData", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPasswordDataRequest"}, "output":{"shape":"GetPasswordDataResult"}, "documentation":"

Retrieves the encrypted administrator password for an instance running Windows.

The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" }, "ImportInstance":{ "name":"ImportInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportInstanceRequest"}, "output":{"shape":"ImportInstanceResult"}, "documentation":"

Creates an import instance task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the EC2 command line tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" }, "ImportKeyPair":{ "name":"ImportKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportKeyPairRequest"}, "output":{"shape":"ImportKeyPairResult"}, "documentation":"

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "ImportVolume":{ "name":"ImportVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportVolumeRequest"}, "output":{"shape":"ImportVolumeResult"}, "documentation":"

Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the Amazon EC2 command-line interface (CLI) tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifyImageAttribute":{ "name":"ModifyImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyImageAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

" }, "ModifyInstanceAttribute":{ "name":"ModifyInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyInstanceAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifyNetworkInterfaceAttribute":{ "name":"ModifyNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, "documentation":"

Modifies the specified network interface attribute. You can specify only one attribute at a time.

" }, "ModifyReservedInstances":{ "name":"ModifyReservedInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyReservedInstancesRequest"}, "output":{"shape":"ModifyReservedInstancesResult"}, "documentation":"

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifySnapshotAttribute":{ "name":"ModifySnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySnapshotAttributeRequest"}, "documentation":"

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifySubnetAttribute":{ "name":"ModifySubnetAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySubnetAttributeRequest"}, "documentation":"

Modifies a subnet attribute.

" }, "ModifyVolumeAttribute":{ "name":"ModifyVolumeAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVolumeAttributeRequest"}, "documentation":"

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" }, "ModifyVpcAttribute":{ "name":"ModifyVpcAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified VPC.

" }, "MonitorInstances":{ "name":"MonitorInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MonitorInstancesRequest"}, "output":{"shape":"MonitorInstancesResult"}, "documentation":"

Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "PurchaseReservedInstancesOffering":{ "name":"PurchaseReservedInstancesOffering", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, "documentation":"

Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time. You pay a lower usage rate than with On-Demand instances for the time that you actually use the capacity reservation.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "RebootInstances":{ "name":"RebootInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootInstancesRequest"}, "documentation":"

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If a Linux/Unix instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "RegisterImage":{ "name":"RegisterImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterImageRequest"}, "output":{"shape":"RegisterImageResult"}, "documentation":"

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.

You can also use RegisterImage to create an Amazon EBS-backed AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

" }, "RejectVpcPeeringConnection":{ "name":"RejectVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RejectVpcPeeringConnectionRequest"}, "output":{"shape":"RejectVpcPeeringConnectionResult"}, "documentation":"

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" }, "ReleaseAddress":{ "name":"ReleaseAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReleaseAddressRequest"}, "documentation":"

Releases the specified Elastic IP address.

After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

" }, "ReplaceNetworkAclAssociation":{ "name":"ReplaceNetworkAclAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceNetworkAclAssociationRequest"}, "output":{"shape":"ReplaceNetworkAclAssociationResult"}, "documentation":"

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceNetworkAclEntry":{ "name":"ReplaceNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceNetworkAclEntryRequest"}, "documentation":"

Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceRoute":{ "name":"ReplaceRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceRouteRequest"}, "documentation":"

Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceRouteTableAssociation":{ "name":"ReplaceRouteTableAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceRouteTableAssociationRequest"}, "output":{"shape":"ReplaceRouteTableAssociationResult"}, "documentation":"

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" }, "ReportInstanceStatus":{ "name":"ReportInstanceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReportInstanceStatusRequest"}, "documentation":"

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" }, "RequestSpotInstances":{ "name":"RequestSpotInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RequestSpotInstancesRequest"}, "output":{"shape":"RequestSpotInstancesResult"}, "documentation":"

Creates a Spot Instance request. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information about Spot Instances, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.

Users must be subscribed to the required product to run an instance with AWS Marketplace product codes.

" }, "ResetImageAttribute":{ "name":"ResetImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetImageAttributeRequest"}, "documentation":"

Resets an attribute of an AMI to its default value.

" }, "ResetInstanceAttribute":{ "name":"ResetInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetInstanceAttributeRequest"}, "documentation":"

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the SourceDestCheck, the instance can be either running or stopped.

The SourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" }, "ResetNetworkInterfaceAttribute":{ "name":"ResetNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetNetworkInterfaceAttributeRequest"}, "documentation":"

Resets a network interface attribute. You can specify only one attribute at a time.

" }, "ResetSnapshotAttribute":{ "name":"ResetSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetSnapshotAttributeRequest"}, "documentation":"

Resets permission settings for the specified snapshot.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "RevokeSecurityGroupEgress":{ "name":"RevokeSecurityGroupEgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSecurityGroupEgressRequest"}, "documentation":"

Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" }, "RevokeSecurityGroupIngress":{ "name":"RevokeSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSecurityGroupIngressRequest"}, "documentation":"

Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" }, "RunInstances":{ "name":"RunInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RunInstancesRequest"}, "output":{ "shape":"Reservation", "documentation":"

One or more reservations.

", "locationName":"reservation" }, "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

When you launch an instance, it enters the pending state. After the instance is ready for you, it enters the running state. To check the state of your instance, call DescribeInstances.

If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide.

If any of the AMIs have a product code attached for which the user has not subscribed, RunInstances fails.

T2 instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, RunInstances fails.

For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "StartInstances":{ "name":"StartInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartInstancesRequest"}, "output":{"shape":"StartInstancesResult"}, "documentation":"

Starts an Amazon EBS-backed AMI that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "StopInstances":{ "name":"StopInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopInstancesRequest"}, "output":{"shape":"StopInstancesResult"}, "documentation":"

Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

You can't start or stop Spot Instances.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "TerminateInstances":{ "name":"TerminateInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateInstancesRequest"}, "output":{"shape":"TerminateInstancesResult"}, "documentation":"

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all Amazon EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "UnassignPrivateIpAddresses":{ "name":"UnassignPrivateIpAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnassignPrivateIpAddressesRequest"}, "documentation":"

Unassigns one or more secondary private IP addresses from a network interface.

" }, "UnmonitorInstances":{ "name":"UnmonitorInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnmonitorInstancesRequest"}, "output":{"shape":"UnmonitorInstancesResult"}, "documentation":"

Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" } }, "shapes":{ "AcceptVpcPeeringConnectionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "AcceptVpcPeeringConnectionResult":{ "type":"structure", "members":{ "VpcPeeringConnection":{ "shape":"VpcPeeringConnection", "documentation":"

Information about the VPC peering connection.

", "locationName":"vpcPeeringConnection" } } }, "AccountAttribute":{ "type":"structure", "members":{ "AttributeName":{ "shape":"String", "documentation":"

The name of the account attribute.

", "locationName":"attributeName" }, "AttributeValues":{ "shape":"AccountAttributeValueList", "documentation":"

One or more values for the account attribute.

", "locationName":"attributeValueSet" } }, "documentation":"

Describes an account attribute.

" }, "AccountAttributeList":{ "type":"list", "member":{ "shape":"AccountAttribute", "locationName":"item" } }, "AccountAttributeName":{ "type":"string", "enum":[ "supported-platforms", "default-vpc" ] }, "AccountAttributeNameStringList":{ "type":"list", "member":{ "shape":"AccountAttributeName", "locationName":"attributeName" } }, "AccountAttributeValue":{ "type":"structure", "members":{ "AttributeValue":{ "shape":"String", "documentation":"

The value of the attribute.

", "locationName":"attributeValue" } }, "documentation":"

Describes a value of an account attribute.

" }, "AccountAttributeValueList":{ "type":"list", "member":{ "shape":"AccountAttributeValue", "locationName":"item" } }, "Address":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance the address is associated with (if any).

", "locationName":"instanceId" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "AllocationId":{ "shape":"String", "documentation":"

The ID representing the allocation of the address for use with EC2-VPC.

", "locationName":"allocationId" }, "AssociationId":{ "shape":"String", "documentation":"

The ID representing the association of the address with an instance in a VPC.

", "locationName":"associationId" }, "Domain":{ "shape":"DomainType", "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", "locationName":"domain" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "NetworkInterfaceOwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that owns the network interface.

", "locationName":"networkInterfaceOwnerId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address associated with the Elastic IP address.

", "locationName":"privateIpAddress" } }, "documentation":"

Describes an Elastic IP address.

" }, "AddressList":{ "type":"list", "member":{ "shape":"Address", "locationName":"item" } }, "AllocateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Domain":{ "shape":"DomainType", "documentation":"

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" } } }, "AllocateAddressResult":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "Domain":{ "shape":"DomainType", "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", "locationName":"domain" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", "locationName":"allocationId" } } }, "AllocationIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"AllocationId" } }, "ArchitectureValues":{ "type":"string", "enum":[ "i386", "x86_64" ] }, "AssignPrivateIpAddressesRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", "locationName":"privateIpAddress" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", "locationName":"secondaryPrivateIpAddressCount" }, "AllowReassignment":{ "shape":"Boolean", "documentation":"

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", "locationName":"allowReassignment" } } }, "AssociateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address. This is required for EC2-Classic.

" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

", "locationName":"networkInterfaceId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", "locationName":"privateIpAddress" }, "AllowReassociation":{ "shape":"Boolean", "documentation":"

[EC2-VPC] Allows an Elastic IP address that is already associated with an instance or network interface to be re-associated with the specified instance or network interface. Otherwise, the operation fails.

Default: false

", "locationName":"allowReassociation" } } }, "AssociateAddressResult":{ "type":"structure", "members":{ "AssociationId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", "locationName":"associationId" } } }, "AssociateDhcpOptionsRequest":{ "type":"structure", "required":[ "DhcpOptionsId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } } }, "AssociateRouteTableRequest":{ "type":"structure", "required":[ "SubnetId", "RouteTableId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" } } }, "AssociateRouteTableResult":{ "type":"structure", "members":{ "AssociationId":{ "shape":"String", "documentation":"

The route table association ID (needed to disassociate the route table).

", "locationName":"associationId" } } }, "AttachInternetGatewayRequest":{ "type":"structure", "required":[ "InternetGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "AttachNetworkInterfaceRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "InstanceId", "DeviceIndex" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device for the network interface attachment.

", "locationName":"deviceIndex" } } }, "AttachNetworkInterfaceResult":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" } } }, "AttachVolumeRequest":{ "type":"structure", "required":[ "VolumeId", "InstanceId", "Device" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "Device":{ "shape":"String", "documentation":"

The device name to expose to the instance (for example, /dev/sdh or xvdh).

" } } }, "AttachVpnGatewayRequest":{ "type":"structure", "required":[ "VpnGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } } }, "AttachVpnGatewayResult":{ "type":"structure", "members":{ "VpcAttachment":{ "shape":"VpcAttachment", "documentation":"

Information about the attachment.

", "locationName":"attachment" } } }, "AttachmentStatus":{ "type":"string", "enum":[ "attaching", "attached", "detaching", "detached" ] }, "AttributeBooleanValue":{ "type":"structure", "members":{ "Value":{ "shape":"Boolean", "locationName":"value" } } }, "AttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"String", "locationName":"value" } } }, "AuthorizeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

", "locationName":"toPort" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

", "locationName":"cidrIp" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"ipPermissions" } } }, "AuthorizeSecurityGroupIngressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" } } }, "AvailabilityZone":{ "type":"structure", "members":{ "ZoneName":{ "shape":"String", "documentation":"

The name of the Availability Zone.

", "locationName":"zoneName" }, "State":{ "shape":"AvailabilityZoneState", "documentation":"

The state of the Availability Zone (available | impaired | unavailable).

", "locationName":"zoneState" }, "RegionName":{ "shape":"String", "documentation":"

The name of the region.

", "locationName":"regionName" }, "Messages":{ "shape":"AvailabilityZoneMessageList", "documentation":"

Any messages about the Availability Zone.

", "locationName":"messageSet" } }, "documentation":"

Describes an Availability Zone.

" }, "AvailabilityZoneList":{ "type":"list", "member":{ "shape":"AvailabilityZone", "locationName":"item" } }, "AvailabilityZoneMessage":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

The message about the Availability Zone.

", "locationName":"message" } }, "documentation":"

Describes a message about an Availability Zone.

" }, "AvailabilityZoneMessageList":{ "type":"list", "member":{ "shape":"AvailabilityZoneMessage", "locationName":"item" } }, "AvailabilityZoneState":{ "type":"string", "enum":["available"] }, "BlockDeviceMapping":{ "type":"structure", "members":{ "VirtualName":{ "shape":"String", "documentation":"

The virtual device name (ephemeral[0..3]). The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", "locationName":"virtualName" }, "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsBlockDevice", "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", "locationName":"ebs" }, "NoDevice":{ "shape":"String", "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", "locationName":"noDevice" } }, "documentation":"

Describes a block device mapping.

" }, "BlockDeviceMappingList":{ "type":"list", "member":{ "shape":"BlockDeviceMapping", "locationName":"item" } }, "BlockDeviceMappingRequestList":{ "type":"list", "member":{ "shape":"BlockDeviceMapping", "locationName":"BlockDeviceMapping" } }, "Boolean":{"type":"boolean"}, "BundleIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"BundleId" } }, "BundleInstanceRequest":{ "type":"structure", "required":[ "InstanceId", "Storage" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance to bundle.

" }, "Storage":{ "shape":"Storage", "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" } } }, "BundleInstanceResult":{ "type":"structure", "members":{ "BundleTask":{ "shape":"BundleTask", "documentation":"

Information about the bundle task.

", "locationName":"bundleInstanceTask" } } }, "BundleTask":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance associated with this bundle task.

", "locationName":"instanceId" }, "BundleId":{ "shape":"String", "documentation":"

The ID for this bundle task.

", "locationName":"bundleId" }, "State":{ "shape":"BundleTaskState", "documentation":"

The state of the task.

", "locationName":"state" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time this task started.

", "locationName":"startTime" }, "UpdateTime":{ "shape":"DateTime", "documentation":"

The time of the most recent update for the task.

", "locationName":"updateTime" }, "Storage":{ "shape":"Storage", "documentation":"

The Amazon S3 storage locations.

", "locationName":"storage" }, "Progress":{ "shape":"String", "documentation":"

The level of task completion, as a percent (for example, 20%).

", "locationName":"progress" }, "BundleTaskError":{ "shape":"BundleTaskError", "documentation":"

If the task fails, a description of the error.

", "locationName":"error" } }, "documentation":"

Describes a bundle task.

" }, "BundleTaskError":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The error message.

", "locationName":"message" } }, "documentation":"

Describes an error for BundleInstance.

" }, "BundleTaskList":{ "type":"list", "member":{ "shape":"BundleTask", "locationName":"item" } }, "BundleTaskState":{ "type":"string", "enum":[ "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed" ] }, "CancelBundleTaskRequest":{ "type":"structure", "required":["BundleId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "BundleId":{ "shape":"String", "documentation":"

The ID of the bundle task.

" } } }, "CancelBundleTaskResult":{ "type":"structure", "members":{ "BundleTask":{ "shape":"BundleTask", "documentation":"

The bundle task.

", "locationName":"bundleInstanceTask" } } }, "CancelConversionRequest":{ "type":"structure", "required":["ConversionTaskId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ConversionTaskId":{ "shape":"String", "documentation":"

The ID of the conversion task.

", "locationName":"conversionTaskId" }, "ReasonMessage":{ "shape":"String", "locationName":"reasonMessage" } } }, "CancelExportTaskRequest":{ "type":"structure", "required":["ExportTaskId"], "members":{ "ExportTaskId":{ "shape":"String", "documentation":"

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", "locationName":"exportTaskId" } } }, "CancelReservedInstancesListingRequest":{ "type":"structure", "required":["ReservedInstancesListingId"], "members":{ "ReservedInstancesListingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance listing.

", "locationName":"reservedInstancesListingId" } } }, "CancelReservedInstancesListingResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

The Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } } }, "CancelSpotInstanceRequestState":{ "type":"string", "enum":[ "active", "open", "closed", "cancelled", "completed" ] }, "CancelSpotInstanceRequestsRequest":{ "type":"structure", "required":["SpotInstanceRequestIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SpotInstanceRequestIds":{ "shape":"SpotInstanceRequestIdList", "documentation":"

One or more Spot Instance request IDs.

", "locationName":"SpotInstanceRequestId" } } }, "CancelSpotInstanceRequestsResult":{ "type":"structure", "members":{ "CancelledSpotInstanceRequests":{ "shape":"CancelledSpotInstanceRequestList", "documentation":"

One or more Spot Instance requests.

", "locationName":"spotInstanceRequestSet" } } }, "CancelledSpotInstanceRequest":{ "type":"structure", "members":{ "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot Instance request.

", "locationName":"spotInstanceRequestId" }, "State":{ "shape":"CancelSpotInstanceRequestState", "documentation":"

The state of the Spot Instance request.

", "locationName":"state" } }, "documentation":"

Describes a request to cancel a Spot Instance.

" }, "CancelledSpotInstanceRequestList":{ "type":"list", "member":{ "shape":"CancelledSpotInstanceRequest", "locationName":"item" } }, "ConfirmProductInstanceRequest":{ "type":"structure", "required":[ "ProductCode", "InstanceId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ProductCode":{ "shape":"String", "documentation":"

The product code. This must be a product code that you own.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" } } }, "ConfirmProductInstanceResult":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", "locationName":"ownerId" } } }, "ContainerFormat":{ "type":"string", "enum":["ova"] }, "ConversionIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "ConversionTask":{ "type":"structure", "required":[ "ConversionTaskId", "State" ], "members":{ "ConversionTaskId":{ "shape":"String", "documentation":"

The ID of the conversion task.

", "locationName":"conversionTaskId" }, "ExpirationTime":{ "shape":"String", "documentation":"

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", "locationName":"expirationTime" }, "ImportInstance":{ "shape":"ImportInstanceTaskDetails", "documentation":"

If the task is for importing an instance, this contains information about the import instance task.

", "locationName":"importInstance" }, "ImportVolume":{ "shape":"ImportVolumeTaskDetails", "documentation":"

If the task is for importing a volume, this contains information about the import volume task.

", "locationName":"importVolume" }, "State":{ "shape":"ConversionTaskState", "documentation":"

The state of the conversion task.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message related to the conversion task.

", "locationName":"statusMessage" }, "Tags":{ "shape":"TagList", "locationName":"tagSet" } }, "documentation":"

Describes a conversion task.

" }, "ConversionTaskState":{ "type":"string", "enum":[ "active", "cancelling", "cancelled", "completed" ] }, "CopyImageRequest":{ "type":"structure", "required":[ "SourceRegion", "SourceImageId", "Name" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SourceRegion":{ "shape":"String", "documentation":"

The name of the region that contains the AMI to copy.

" }, "SourceImageId":{ "shape":"String", "documentation":"

The ID of the AMI to copy.

" }, "Name":{ "shape":"String", "documentation":"

The name of the new AMI in the destination region.

" }, "Description":{ "shape":"String", "documentation":"

A description for the new AMI in the destination region.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" } } }, "CopyImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the new AMI.

", "locationName":"imageId" } } }, "CopySnapshotRequest":{ "type":"structure", "required":[ "SourceRegion", "SourceSnapshotId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SourceRegion":{ "shape":"String", "documentation":"

The ID of the region that contains the snapshot to be copied.

" }, "SourceSnapshotId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS snapshot to copy.

" }, "Description":{ "shape":"String", "documentation":"

A description for the new Amazon EBS snapshot.

" }, "DestinationRegion":{ "shape":"String", "documentation":"

The destination region of the snapshot copy operation. This parameter is required in the PresignedUrl.

", "locationName":"destinationRegion" }, "PresignedUrl":{ "shape":"String", "documentation":"

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because Amazon EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", "locationName":"presignedUrl" } } }, "CopySnapshotResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the new snapshot.

", "locationName":"snapshotId" } } }, "CreateCustomerGatewayRequest":{ "type":"structure", "required":[ "Type", "PublicIp", "BgpAsn" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection that this customer gateway supports (ipsec.1).

" }, "PublicIp":{ "shape":"String", "documentation":"

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", "locationName":"IpAddress" }, "BgpAsn":{ "shape":"Integer", "documentation":"

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" } } }, "CreateCustomerGatewayResult":{ "type":"structure", "members":{ "CustomerGateway":{ "shape":"CustomerGateway", "documentation":"

Information about the customer gateway.

", "locationName":"customerGateway" } } }, "CreateDhcpOptionsRequest":{ "type":"structure", "required":["DhcpConfigurations"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "DhcpConfigurations":{ "shape":"NewDhcpConfigurationList", "documentation":"

A DHCP configuration option.

", "locationName":"dhcpConfiguration" } } }, "CreateDhcpOptionsResult":{ "type":"structure", "members":{ "DhcpOptions":{ "shape":"DhcpOptions", "documentation":"

A set of DHCP options.

", "locationName":"dhcpOptions" } } }, "CreateImageRequest":{ "type":"structure", "required":[ "InstanceId", "Name" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Name":{ "shape":"String", "documentation":"

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

A description for the new image.

", "locationName":"description" }, "NoReboot":{ "shape":"Boolean", "documentation":"

By default, this parameter is set to false, which means Amazon EC2 attempts to shut down the instance cleanly before image creation and then reboots the instance. When the parameter is set to true, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", "locationName":"noReboot" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

Information about one or more block device mappings.

", "locationName":"blockDeviceMapping" } } }, "CreateImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the new AMI.

", "locationName":"imageId" } } }, "CreateInstanceExportTaskRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "Description":{ "shape":"String", "documentation":"

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", "locationName":"description" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "TargetEnvironment":{ "shape":"ExportEnvironment", "documentation":"

The target virtualization environment.

", "locationName":"targetEnvironment" }, "ExportToS3Task":{ "shape":"ExportToS3TaskSpecification", "locationName":"exportToS3" } } }, "CreateInstanceExportTaskResult":{ "type":"structure", "members":{ "ExportTask":{ "shape":"ExportTask", "locationName":"exportTask" } } }, "CreateInternetGatewayRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" } } }, "CreateInternetGatewayResult":{ "type":"structure", "members":{ "InternetGateway":{ "shape":"InternetGateway", "documentation":"

Information about the Internet gateway.

", "locationName":"internetGateway" } } }, "CreateKeyPairRequest":{ "type":"structure", "required":["KeyName"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" } } }, "CreateNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Protocol", "RuleAction", "Egress", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The protocol. A value of -1 means all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.

", "locationName":"Icmp" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", "locationName":"portRange" } } }, "CreateNetworkAclRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "CreateNetworkAclResult":{ "type":"structure", "members":{ "NetworkAcl":{ "shape":"NetworkAcl", "documentation":"

Information about the network ACL.

", "locationName":"networkAcl" } } }, "CreateNetworkInterfaceRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet to associate with the network interface.

", "locationName":"subnetId" }, "Description":{ "shape":"String", "documentation":"

A description for the network interface.

", "locationName":"description" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", "locationName":"privateIpAddress" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

The IDs of one or more security groups.

", "locationName":"SecurityGroupId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", "documentation":"

One or more private IP addresses.

", "locationName":"privateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"secondaryPrivateIpAddressCount" }, "DryRun":{ "shape":"Boolean", "locationName":"dryRun" } } }, "CreateNetworkInterfaceResult":{ "type":"structure", "members":{ "NetworkInterface":{ "shape":"NetworkInterface", "documentation":"

Information about the network interface.

", "locationName":"networkInterface" } } }, "CreatePlacementGroupRequest":{ "type":"structure", "required":[ "GroupName", "Strategy" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

A name for the placement group.

Constraints: Up to 255 ASCII characters

", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"

The placement strategy.

", "locationName":"strategy" } } }, "CreateReservedInstancesListingRequest":{ "type":"structure", "required":[ "ReservedInstancesId", "InstanceCount", "PriceSchedules", "ClientToken" ], "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the active Reserved Instance.

", "locationName":"reservedInstancesId" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", "locationName":"instanceCount" }, "PriceSchedules":{ "shape":"PriceScheduleSpecificationList", "documentation":"

A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.

", "locationName":"priceSchedules" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"clientToken" } } }, "CreateReservedInstancesListingResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

Information about the Reserved Instances listing.

", "locationName":"reservedInstancesListingsSet" } } }, "CreateRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table for the route.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of an Internet gateway or virtual private gateway attached to your VPC.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", "locationName":"instanceId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of a network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of a VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "CreateRouteTableRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "CreateRouteTableResult":{ "type":"structure", "members":{ "RouteTable":{ "shape":"RouteTable", "documentation":"

Information about the route table.

", "locationName":"routeTable" } } }, "CreateSecurityGroupRequest":{ "type":"structure", "required":[ "GroupName", "Description" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

" }, "Description":{ "shape":"String", "documentation":"

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", "locationName":"GroupDescription" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" } } }, "CreateSecurityGroupResult":{ "type":"structure", "members":{ "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } } }, "CreateSnapshotRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS volume.

" }, "Description":{ "shape":"String", "documentation":"

A description for the snapshot.

" } } }, "CreateSpotDatafeedSubscriptionRequest":{ "type":"structure", "required":["Bucket"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket in which to store the Spot Instance datafeed.

Constraints: Must be a valid bucket associated with your AWS account.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

A prefix for the datafeed file names.

", "locationName":"prefix" } } }, "CreateSpotDatafeedSubscriptionResult":{ "type":"structure", "members":{ "SpotDatafeedSubscription":{ "shape":"SpotDatafeedSubscription", "documentation":"

The Spot Instance datafeed subscription.

", "locationName":"spotDatafeedSubscription" } } }, "CreateSubnetRequest":{ "type":"structure", "required":[ "VpcId", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the subnet.

Default: Amazon EC2 selects one for you (recommended).

" } } }, "CreateSubnetResult":{ "type":"structure", "members":{ "Subnet":{ "shape":"Subnet", "documentation":"

Information about the subnet.

", "locationName":"subnet" } } }, "CreateTagsRequest":{ "type":"structure", "required":[ "Resources", "Tags" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Resources":{ "shape":"ResourceIdList", "documentation":"

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

", "locationName":"ResourceId" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", "locationName":"Tag" } } }, "CreateVolumePermission":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

", "locationName":"userId" }, "Group":{ "shape":"PermissionGroup", "documentation":"

The specific group that is to be added or removed from a volume's list of create volume permissions.

", "locationName":"group" } } }, "CreateVolumePermissionList":{ "type":"list", "member":{ "shape":"CreateVolumePermission", "locationName":"item" } }, "CreateVolumePermissionModifications":{ "type":"structure", "members":{ "Add":{ "shape":"CreateVolumePermissionList", "documentation":"

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

" }, "Remove":{ "shape":"CreateVolumePermissionList", "documentation":"

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

" } } }, "CreateVolumeRequest":{ "type":"structure", "required":["AvailabilityZone"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Size":{ "shape":"Integer", "documentation":"

The size of the volume, in GiBs.

Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot from which to create the volume.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

Default: standard

" }, "Iops":{ "shape":"Integer", "documentation":"

Only valid for Provisioned IOPS (SSD) volumes. The number of I/O operations per second (IOPS) to provision for the volume.

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the volume should be encrypted.

", "locationName":"encrypted" } } }, "CreateVpcPeeringConnectionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the requester VPC.

", "locationName":"vpcId" }, "PeerVpcId":{ "shape":"String", "documentation":"

The ID of the VPC with which you are creating the VPC peering connection.

", "locationName":"peerVpcId" }, "PeerOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

", "locationName":"peerOwnerId" } } }, "CreateVpcPeeringConnectionResult":{ "type":"structure", "members":{ "VpcPeeringConnection":{ "shape":"VpcPeeringConnection", "documentation":"

Information about the VPC peering connection.

", "locationName":"vpcPeeringConnection" } } }, "CreateVpcRequest":{ "type":"structure", "required":["CidrBlock"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The supported tenancy options for instances launched into the VPC. A value of default means that instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC are launched as dedicated tenancy instances regardless of the tenancy assigned to the instance at launch. Dedicated tenancy instances run on single-tenant hardware.

Default: default

", "locationName":"instanceTenancy" } } }, "CreateVpcResult":{ "type":"structure", "members":{ "Vpc":{ "shape":"Vpc", "documentation":"

Information about the VPC.

", "locationName":"vpc" } } }, "CreateVpnConnectionRequest":{ "type":"structure", "required":[ "Type", "CustomerGatewayId", "VpnGatewayId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Type":{ "shape":"String", "documentation":"

The type of VPN connection (ipsec.1).

" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "Options":{ "shape":"VpnConnectionOptionsSpecification", "documentation":"

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

", "locationName":"options" } } }, "CreateVpnConnectionResult":{ "type":"structure", "members":{ "VpnConnection":{ "shape":"VpnConnection", "documentation":"

Information about the VPN connection.

", "locationName":"vpnConnection" } } }, "CreateVpnConnectionRouteRequest":{ "type":"structure", "required":[ "VpnConnectionId", "DestinationCidrBlock" ], "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer network.

" } } }, "CreateVpnGatewayRequest":{ "type":"structure", "required":["Type"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection this virtual private gateway supports.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the virtual private gateway.

" } } }, "CreateVpnGatewayResult":{ "type":"structure", "members":{ "VpnGateway":{ "shape":"VpnGateway", "documentation":"

Information about the virtual private gateway.

", "locationName":"vpnGateway" } } }, "CurrencyCodeValues":{ "type":"string", "enum":["USD"] }, "CustomerGateway":{ "type":"structure", "members":{ "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

", "locationName":"customerGatewayId" }, "State":{ "shape":"String", "documentation":"

The current state of the customer gateway (pending | available | deleting | deleted).

", "locationName":"state" }, "Type":{ "shape":"String", "documentation":"

The type of VPN connection the customer gateway supports (ipsec.1).

", "locationName":"type" }, "IpAddress":{ "shape":"String", "documentation":"

The Internet-routable IP address of the customer gateway's outside interface.

", "locationName":"ipAddress" }, "BgpAsn":{ "shape":"String", "documentation":"

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", "locationName":"bgpAsn" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the customer gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes a customer gateway.

" }, "CustomerGatewayIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"CustomerGatewayId" } }, "CustomerGatewayList":{ "type":"list", "member":{ "shape":"CustomerGateway", "locationName":"item" } }, "DatafeedSubscriptionState":{ "type":"string", "enum":[ "Active", "Inactive" ] }, "DateTime":{"type":"timestamp"}, "DeleteCustomerGatewayRequest":{ "type":"structure", "required":["CustomerGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

" } } }, "DeleteDhcpOptionsRequest":{ "type":"structure", "required":["DhcpOptionsId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the DHCP options set.

" } } }, "DeleteInternetGatewayRequest":{ "type":"structure", "required":["InternetGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" } } }, "DeleteKeyPairRequest":{ "type":"structure", "required":["KeyName"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

" } } }, "DeleteNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Egress" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number of the entry to delete.

", "locationName":"ruleNumber" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether the rule is an egress rule.

", "locationName":"egress" } } }, "DeleteNetworkAclRequest":{ "type":"structure", "required":["NetworkAclId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" } } }, "DeleteNetworkInterfaceRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" } } }, "DeletePlacementGroupRequest":{ "type":"structure", "required":["GroupName"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

", "locationName":"groupName" } } }, "DeleteRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", "locationName":"destinationCidrBlock" } } }, "DeleteRouteTableRequest":{ "type":"structure", "required":["RouteTableId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" } } }, "DeleteSecurityGroupRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a nondefault VPC.

" } } }, "DeleteSnapshotRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS snapshot.

" } } }, "DeleteSpotDatafeedSubscriptionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" } } }, "DeleteSubnetRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

" } } }, "DeleteTagsRequest":{ "type":"structure", "required":["Resources"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Resources":{ "shape":"ResourceIdList", "documentation":"

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

", "locationName":"resourceId" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

", "locationName":"tag" } } }, "DeleteVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" } } }, "DeleteVpcPeeringConnectionRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "DeleteVpcPeeringConnectionResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "DeleteVpcRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } } }, "DeleteVpnConnectionRequest":{ "type":"structure", "required":["VpnConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" } } }, "DeleteVpnConnectionRouteRequest":{ "type":"structure", "required":[ "VpnConnectionId", "DestinationCidrBlock" ], "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer network.

" } } }, "DeleteVpnGatewayRequest":{ "type":"structure", "required":["VpnGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } } }, "DeregisterImageRequest":{ "type":"structure", "required":["ImageId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" } } }, "DescribeAccountAttributesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AttributeNames":{ "shape":"AccountAttributeNameStringList", "documentation":"

One or more account attribute names.

", "locationName":"attributeName" } } }, "DescribeAccountAttributesResult":{ "type":"structure", "members":{ "AccountAttributes":{ "shape":"AccountAttributeList", "documentation":"

Information about one or more account attributes.

", "locationName":"accountAttributeSet" } } }, "DescribeAddressesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "PublicIps":{ "shape":"PublicIpStringList", "documentation":"

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", "locationName":"PublicIp" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

", "locationName":"Filter" }, "AllocationIds":{ "shape":"AllocationIdList", "documentation":"

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

", "locationName":"AllocationId" } } }, "DescribeAddressesResult":{ "type":"structure", "members":{ "Addresses":{ "shape":"AddressList", "documentation":"

Information about one or more Elastic IP addresses.

", "locationName":"addressesSet" } } }, "DescribeAvailabilityZonesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ZoneNames":{ "shape":"ZoneNameStringList", "documentation":"

The names of one or more Availability Zones.

", "locationName":"ZoneName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | impaired | unavailable).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", "locationName":"Filter" } } }, "DescribeAvailabilityZonesResult":{ "type":"structure", "members":{ "AvailabilityZones":{ "shape":"AvailabilityZoneList", "documentation":"

Information about one or more Availability Zones.

", "locationName":"availabilityZoneInfo" } } }, "DescribeBundleTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "BundleIds":{ "shape":"BundleIdStringList", "documentation":"

One or more bundle task IDs.

Default: Describes all your bundle tasks.

", "locationName":"BundleId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", "locationName":"Filter" } } }, "DescribeBundleTasksResult":{ "type":"structure", "members":{ "BundleTasks":{ "shape":"BundleTaskList", "documentation":"

Information about one or more bundle tasks.

", "locationName":"bundleInstanceTasksSet" } } }, "DescribeConversionTaskList":{ "type":"list", "member":{ "shape":"ConversionTask", "locationName":"item" } }, "DescribeConversionTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Filters":{ "shape":"FilterList", "locationName":"filter" }, "ConversionTaskIds":{ "shape":"ConversionIdStringList", "documentation":"

One or more conversion task IDs.

", "locationName":"conversionTaskId" } } }, "DescribeConversionTasksResult":{ "type":"structure", "members":{ "ConversionTasks":{ "shape":"DescribeConversionTaskList", "locationName":"conversionTasks" } } }, "DescribeCustomerGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "CustomerGatewayIds":{ "shape":"CustomerGatewayIdStringList", "documentation":"

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", "locationName":"CustomerGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } } }, "DescribeCustomerGatewaysResult":{ "type":"structure", "members":{ "CustomerGateways":{ "shape":"CustomerGatewayList", "documentation":"

Information about one or more customer gateways.

", "locationName":"customerGatewaySet" } } }, "DescribeDhcpOptionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "DhcpOptionsIds":{ "shape":"DhcpOptionsIdStringList", "documentation":"

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", "locationName":"DhcpOptionsId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • dhcp-options-id - The ID of a set of DHCP options.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } } }, "DescribeDhcpOptionsResult":{ "type":"structure", "members":{ "DhcpOptions":{ "shape":"DhcpOptionsList", "documentation":"

Information about one or more DHCP options sets.

", "locationName":"dhcpOptionsSet" } } }, "DescribeExportTasksRequest":{ "type":"structure", "members":{ "ExportTaskIds":{ "shape":"ExportTaskIdStringList", "documentation":"

One or more export task IDs.

", "locationName":"exportTaskId" } } }, "DescribeExportTasksResult":{ "type":"structure", "members":{ "ExportTasks":{ "shape":"ExportTaskList", "locationName":"exportTaskSet" } } }, "DescribeImageAttributeRequest":{ "type":"structure", "required":[ "ImageId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"ImageAttributeName", "documentation":"

The AMI attribute.

" } } }, "DescribeImagesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageIds":{ "shape":"ImageIdStringList", "documentation":"

One or more image IDs.

Default: Describes all images available to you.

", "locationName":"ImageId" }, "Owners":{ "shape":"OwnerStringList", "documentation":"

Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request), or all (all owners).

", "locationName":"Owner" }, "ExecutableUsers":{ "shape":"ExecutableByStringList", "documentation":"

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", "locationName":"ExecutableBy" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • architecture - The image architecture (i386 | x86_64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the Amazon EBS volume (gp2 | standard | io1).

  • description - The description of the image (provided during image creation).

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - The AWS account alias (for example, amazon).

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", "locationName":"Filter" } } }, "DescribeImagesResult":{ "type":"structure", "members":{ "Images":{ "shape":"ImageList", "documentation":"

Information about one or more images.

", "locationName":"imagesSet" } } }, "DescribeInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The instance attribute.

", "locationName":"attribute" } } }, "DescribeInstanceStatusRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code identifying the type of event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.not-after - The latest end time for the scheduled event, for example: 2010-09-15T17:15:20.000Z.

  • event.not-before - The earliest start time for the scheduled event, for example: 2010-09-15T17:15:20.000Z.

  • instance-state-code - A code representing the state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The next paginated set of results to return. (You received this token from a prior call.)

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of paginated instance items per response. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.

Default: 1000

" }, "IncludeAllInstances":{ "shape":"Boolean", "documentation":"

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", "locationName":"includeAllInstances" } } }, "DescribeInstanceStatusResult":{ "type":"structure", "members":{ "InstanceStatuses":{ "shape":"InstanceStatusList", "documentation":"

One or more instance status descriptions.

", "locationName":"instanceStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The next paginated set of results to return.

", "locationName":"nextToken" } } }, "DescribeInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Default: Describes all your instances.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • architecture - The instance architecture (i386 | x86_64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - 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 - A Boolean that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • block-device-mapping.status - The status for the Amazon EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the Amazon EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. If the instance is in EC2-Classic or a default VPC, you can use group-name instead.

  • group-name - The name of the security group for the instance. If the instance is in a nondefault VPC, you must use group-id instead.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance (spot).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, m1.small).

  • instance.group-id - The ID of the security group for the instance. If the instance is in EC2-Classic or a default VPC, you can use instance.group-name instead.

  • instance.group-name - The name of the security group for the instance. If the instance is in a nondefault VPC, you must use instance.group-id instead.

  • ip-address - The public IP address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - 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 - The time when the instance was launched.

  • monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.

  • private-dns-name - The private DNS name of the instance.

  • private-ip-address - The private IP address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - 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 - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - 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 - The name of the root device for the instance (for example, /dev/sda1).

  • root-device-type - The type of root device that the instance uses (ebs | instance-store).

  • source-dest-check - 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 - The ID of the Spot Instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • tenancy - The tenancy of an instance (dedicated | default).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

  • network-interface.description - The description of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • network-interface.network-interface.id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface-private-dns-name - The private DNS name of the network interface.

  • network-interface.source-destination-check - 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.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.addresses.private-ip-address - The private IP address associated with the network interface.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.

", "locationName":"maxResults" } } }, "DescribeInstancesResult":{ "type":"structure", "members":{ "Reservations":{ "shape":"ReservationList", "documentation":"

One or more reservations.

", "locationName":"reservationSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } } }, "DescribeInternetGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InternetGatewayIds":{ "shape":"ValueStringList", "documentation":"

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

", "locationName":"internetGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } } }, "DescribeInternetGatewaysResult":{ "type":"structure", "members":{ "InternetGateways":{ "shape":"InternetGatewayList", "documentation":"

Information about one or more Internet gateways.

", "locationName":"internetGatewaySet" } } }, "DescribeKeyPairsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "KeyNames":{ "shape":"KeyNameStringList", "documentation":"

One or more key pair names.

Default: Describes all your key pairs.

", "locationName":"KeyName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", "locationName":"Filter" } } }, "DescribeKeyPairsResult":{ "type":"structure", "members":{ "KeyPairs":{ "shape":"KeyPairList", "documentation":"

Information about one or more key pairs.

", "locationName":"keySet" } } }, "DescribeNetworkAclsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkAclIds":{ "shape":"ValueStringList", "documentation":"

One or more network ACL IDs.

Default: Describes all your network ACLs.

", "locationName":"NetworkAclId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The CIDR range specified in the entry.

  • entry.egress - Indicates whether the entry applies to egress traffic.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.

  • network-acl-id - The ID of the network ACL.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network ACL.

", "locationName":"Filter" } } }, "DescribeNetworkAclsResult":{ "type":"structure", "members":{ "NetworkAcls":{ "shape":"NetworkAclList", "documentation":"

Information about one or more network ACLs.

", "locationName":"networkAclSet" } } }, "DescribeNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Attribute":{ "shape":"NetworkInterfaceAttribute", "documentation":"

The attribute of the network interface.

", "locationName":"attribute" } } }, "DescribeNetworkInterfaceAttributeResult":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Description":{ "shape":"AttributeValue", "documentation":"

The description of the network interface.

", "locationName":"description" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

The security groups associated with the network interface.

", "locationName":"groupSet" }, "Attachment":{ "shape":"NetworkInterfaceAttachment", "documentation":"

The attachment (if any) of the network interface.

", "locationName":"attachment" } } }, "DescribeNetworkInterfacesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceIds":{ "shape":"NetworkInterfaceIdList", "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", "locationName":"NetworkInterfaceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IP addresses associated with the network interface.

  • addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface.

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • attachment.attach.time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IP address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-desk-check - 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 - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network interface.

", "locationName":"filter" } } }, "DescribeNetworkInterfacesResult":{ "type":"structure", "members":{ "NetworkInterfaces":{ "shape":"NetworkInterfaceList", "documentation":"

Information about one or more network interfaces.

", "locationName":"networkInterfaceSet" } } }, "DescribePlacementGroupsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupNames":{ "shape":"PlacementGroupStringList", "documentation":"

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

", "locationName":"groupName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster).

", "locationName":"Filter" } } }, "DescribePlacementGroupsResult":{ "type":"structure", "members":{ "PlacementGroups":{ "shape":"PlacementGroupList", "documentation":"

One or more placement groups.

", "locationName":"placementGroupSet" } } }, "DescribeRegionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RegionNames":{ "shape":"RegionNameStringList", "documentation":"

The names of one or more regions.

", "locationName":"RegionName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

  • region-name - The name of the region (for example, us-east-1).

", "locationName":"Filter" } } }, "DescribeRegionsResult":{ "type":"structure", "members":{ "Regions":{ "shape":"RegionList", "documentation":"

Information about one or more regions.

", "locationName":"regionInfo" } } }, "DescribeReservedInstancesListingsRequest":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

One or more Reserved Instance IDs.

", "locationName":"reservedInstancesId" }, "ReservedInstancesListingId":{ "shape":"String", "documentation":"

One or more Reserved Instance Listing IDs.

", "locationName":"reservedInstancesListingId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", "locationName":"filters" } } }, "DescribeReservedInstancesListingsResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

Information about the Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } } }, "DescribeReservedInstancesModificationsRequest":{ "type":"structure", "members":{ "ReservedInstancesModificationIds":{ "shape":"ReservedInstancesModificationIdStringList", "documentation":"

IDs for the submitted modification request.

", "locationName":"ReservedInstancesModificationId" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next page of data.

", "locationName":"nextToken" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

", "locationName":"Filter" } } }, "DescribeReservedInstancesModificationsResult":{ "type":"structure", "members":{ "ReservedInstancesModifications":{ "shape":"ReservedInstancesModificationList", "documentation":"

The Reserved Instance modification information.

", "locationName":"reservedInstancesModificationsSet" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next page of data.

", "locationName":"nextToken" } } }, "DescribeReservedInstancesOfferingsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ReservedInstancesOfferingIds":{ "shape":"ReservedInstancesOfferingIdStringList", "documentation":"

One or more Reserved Instances offering IDs.

", "locationName":"ReservedInstancesOfferingId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type on which the Reserved Instance can be used.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from AWS and Reserved Instance Marketplace are listed.

  • product-description - The description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)).

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", "locationName":"Filter" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the Reserved Instance offering. A Reserved Instance with dedicated tenancy runs on single-tenant hardware and can only be launched within a VPC.

Default: default

", "locationName":"instanceTenancy" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", "locationName":"offeringType" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next paginated set of offerings.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of offerings to return. The maximum is 100.

Default: 100

", "locationName":"maxResults" }, "IncludeMarketplace":{ "shape":"Boolean", "documentation":"

Include Marketplace offerings in the response.

" }, "MinDuration":{ "shape":"Long", "documentation":"

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

" }, "MaxDuration":{ "shape":"Long", "documentation":"

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

" }, "MaxInstanceCount":{ "shape":"Integer", "documentation":"

The maximum number of instances to filter when searching for offerings.

Default: 20

" } } }, "DescribeReservedInstancesOfferingsResult":{ "type":"structure", "members":{ "ReservedInstancesOfferings":{ "shape":"ReservedInstancesOfferingList", "documentation":"

A list of Reserved Instances offerings.

", "locationName":"reservedInstancesOfferingsSet" }, "NextToken":{ "shape":"String", "documentation":"

The next paginated set of results to return.

", "locationName":"nextToken" } } }, "DescribeReservedInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ReservedInstancesIds":{ "shape":"ReservedInstancesIdStringList", "documentation":"

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

", "locationName":"ReservedInstancesId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2014-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type on which the Reserved Instance can be used.

  • product-description - The product description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (pending-payment | active | payment-failed | retired).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", "locationName":"Filter" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", "locationName":"offeringType" } } }, "DescribeReservedInstancesResult":{ "type":"structure", "members":{ "ReservedInstances":{ "shape":"ReservedInstancesList", "documentation":"

A list of Reserved Instances.

", "locationName":"reservedInstancesSet" } } }, "DescribeRouteTablesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs.

Default: Describes all your route tables.

", "locationName":"RouteTableId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC.

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The CIDR range specified in a route in the table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). 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).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the route table.

", "locationName":"Filter" } } }, "DescribeRouteTablesResult":{ "type":"structure", "members":{ "RouteTables":{ "shape":"RouteTableList", "documentation":"

Information about one or more route tables.

", "locationName":"routeTableSet" } } }, "DescribeSecurityGroupsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupNames":{ "shape":"GroupNameStringList", "documentation":"

[EC2-Classic, default VPC] One or more security group names. You can specify either the security group name or the security group ID.

Default: Describes all your security groups.

", "locationName":"GroupName" }, "GroupIds":{ "shape":"GroupIdStringList", "documentation":"

One or more security group IDs. Required for nondefault VPCs.

Default: Describes all your security groups.

", "locationName":"GroupId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • description - The description of the security group.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - A CIDR range that has been granted permission.

  • ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been granted permission.

  • ip-permission.group-name - The name of a security group that has been granted permission.

  • ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been granted permission.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag-key - The key of a tag assigned to the security group.

  • tag-value - The value of a tag assigned to the security group.

  • vpc-id - The ID of the VPC specified when the security group was created.

", "locationName":"Filter" } } }, "DescribeSecurityGroupsResult":{ "type":"structure", "members":{ "SecurityGroups":{ "shape":"SecurityGroupList", "documentation":"

Information about one or more security groups.

", "locationName":"securityGroupInfo" } } }, "DescribeSnapshotAttributeRequest":{ "type":"structure", "required":[ "SnapshotId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The snapshot attribute you would like to view.

" } } }, "DescribeSnapshotAttributeResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS snapshot.

", "locationName":"snapshotId" }, "CreateVolumePermissions":{ "shape":"CreateVolumePermissionList", "documentation":"

A list of permissions for creating volumes from the snapshot.

", "locationName":"createVolumePermission" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" } } }, "DescribeSnapshotsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SnapshotIds":{ "shape":"SnapshotIdStringList", "documentation":"

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

", "locationName":"SnapshotId" }, "OwnerIds":{ "shape":"OwnerStringList", "documentation":"

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

", "locationName":"Owner" }, "RestorableByUserIds":{ "shape":"RestorableByStringList", "documentation":"

One or more AWS accounts IDs that can create volumes from the snapshot.

", "locationName":"RestorableBy" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • description - A description of the snapshot.

  • owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

  • owner-id - The ID of the AWS account that owns the snapshot.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

", "locationName":"Filter" } } }, "DescribeSnapshotsResult":{ "type":"structure", "members":{ "Snapshots":{ "shape":"SnapshotList", "locationName":"snapshotSet" } } }, "DescribeSpotDatafeedSubscriptionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" } } }, "DescribeSpotDatafeedSubscriptionResult":{ "type":"structure", "members":{ "SpotDatafeedSubscription":{ "shape":"SpotDatafeedSubscription", "documentation":"

The Spot Instance datafeed subscription.

", "locationName":"spotDatafeedSubscription" } } }, "DescribeSpotInstanceRequestsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SpotInstanceRequestIds":{ "shape":"SpotInstanceRequestIdList", "documentation":"

One or more Spot Instance request IDs.

", "locationName":"SpotInstanceRequestId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot Instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot Instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume (gp2 | standard | io1).

  • launch.group-id - The security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m1.small).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether monitoring is enabled for the Spot Instance.

  • launch.ramdisk-id - The RAM disk ID.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • network-interface.description - A description of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.group-name - The name of the security group associated with the network interface.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot Instance request ID.

  • spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.

  • state - The state of the Spot Instance request (open | active | closed | cancelled | failed). 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 - The short code describing the most recent evaluation of your Spot Instance request.

  • status-message - The message explaining the status of the Spot Instance request.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of Spot Instance request (one-time | persistent).

  • launched-availability-zone - The Availability Zone in which the bid is launched.

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", "locationName":"Filter" } } }, "DescribeSpotInstanceRequestsResult":{ "type":"structure", "members":{ "SpotInstanceRequests":{ "shape":"SpotInstanceRequestList", "documentation":"

One or more Spot Instance requests.

", "locationName":"spotInstanceRequestSet" } } }, "DescribeSpotPriceHistoryRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "StartTime":{ "shape":"DateTime", "documentation":"

The start date and time of the Spot Price history data.

", "locationName":"startTime" }, "EndTime":{ "shape":"DateTime", "documentation":"

The end date and time of the Spot Price history data.

", "locationName":"endTime" }, "InstanceTypes":{ "shape":"InstanceTypeList", "documentation":"

One or more instance types.

", "locationName":"InstanceType" }, "ProductDescriptions":{ "shape":"ProductDescriptionList", "documentation":"

One or more basic product descriptions.

", "locationName":"ProductDescription" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m1.small).

  • product-description - The product description for the Spot Price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot Price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - 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.

", "locationName":"Filter" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "MaxResults":{ "shape":"Integer", "documentation":"

The number of rows to return.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

The next set of rows to return.

", "locationName":"nextToken" } } }, "DescribeSpotPriceHistoryResult":{ "type":"structure", "members":{ "SpotPriceHistory":{ "shape":"SpotPriceHistoryList", "documentation":"

The historical Spot Prices.

", "locationName":"spotPriceHistorySet" }, "NextToken":{ "shape":"String", "documentation":"

The string marking the next set of results. This is empty if there are no more results.

", "locationName":"nextToken" } } }, "DescribeSubnetsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SubnetIds":{ "shape":"SubnetIdStringList", "documentation":"

One or more subnet IDs.

Default: Describes all your subnets.

", "locationName":"SubnetId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

  • available-ip-address-count - The number of IP addresses in the subnet that are available.

  • cidrBlock - 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. You can also use cidr or cidr-block as the filter names.

  • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

  • state - The state of the subnet (pending | available).

  • subnet-id - The ID of the subnet.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the subnet.

", "locationName":"Filter" } } }, "DescribeSubnetsResult":{ "type":"structure", "members":{ "Subnets":{ "shape":"SubnetList", "documentation":"

Information about one or more subnets.

", "locationName":"subnetSet" } } }, "DescribeTagsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • key - The tag key.

  • resource-id - The resource ID.

  • resource-type - The resource type (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).

  • value - The tag value.

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

", "locationName":"nextToken" } } }, "DescribeTagsResult":{ "type":"structure", "members":{ "Tags":{ "shape":"TagDescriptionList", "documentation":"

A list of tags.

", "locationName":"tagSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } } }, "DescribeVolumeAttributeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "Attribute":{ "shape":"VolumeAttributeName", "documentation":"

The instance attribute.

" } } }, "DescribeVolumeAttributeResult":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "AutoEnableIO":{ "shape":"AttributeBooleanValue", "documentation":"

The state of autoEnableIO attribute.

", "locationName":"autoEnableIO" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" } } }, "DescribeVolumeStatusRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeIds":{ "shape":"VolumeIdStringList", "documentation":"

One or more volume IDs.

Default: Describes all your volumes.

", "locationName":"VolumeId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The next paginated set of results to return using the pagination token returned by a previous call.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of paginated volume items per response.

" } } }, "DescribeVolumeStatusResult":{ "type":"structure", "members":{ "VolumeStatuses":{ "shape":"VolumeStatusList", "documentation":"

A list of volumes.

", "locationName":"volumeStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The next paginated set of results to return.

", "locationName":"nextToken" } } }, "DescribeVolumesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeIds":{ "shape":"VolumeIdStringList", "documentation":"

One or more volume IDs.

", "locationName":"VolumeId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - The encryption status of the volume.

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The status of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results.

", "locationName":"maxResults" } } }, "DescribeVolumesResult":{ "type":"structure", "members":{ "Volumes":{ "shape":"VolumeList", "locationName":"volumeSet" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeVpcAttributeRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "Attribute":{ "shape":"VpcAttributeName", "documentation":"

The VPC attribute.

" } } }, "DescribeVpcAttributeResult":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "EnableDnsSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

", "locationName":"enableDnsSupport" }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

", "locationName":"enableDnsHostnames" } } }, "DescribeVpcPeeringConnectionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcPeeringConnectionIds":{ "shape":"ValueStringList", "documentation":"

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

", "locationName":"VpcPeeringConnectionId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

  • accepter-vpc-info.vpc-id - The ID of the peer VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

", "locationName":"Filter" } } }, "DescribeVpcPeeringConnectionsResult":{ "type":"structure", "members":{ "VpcPeeringConnections":{ "shape":"VpcPeeringConnectionList", "documentation":"

Information about the VPC peering connections.

", "locationName":"vpcPeeringConnectionSet" } } }, "DescribeVpcsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcIds":{ "shape":"VpcIdStringList", "documentation":"

One or more VPC IDs.

Default: Describes all your VPCs.

", "locationName":"VpcId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • cidr - 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. Must contain the slash followed by one or two digits (for example, /28).

  • dhcp-options-id - The ID of a set of DHCP options.

  • isDefault - Indicates whether the VPC is the default VPC.

  • state - The state of the VPC (pending | available).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC.

", "locationName":"Filter" } } }, "DescribeVpcsResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"VpcList", "documentation":"

Information about one or more VPCs.

", "locationName":"vpcSet" } } }, "DescribeVpnConnectionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnConnectionIds":{ "shape":"VpnConnectionIdStringList", "documentation":"

One or more VPN connection IDs.

Default: Describes your VPN connections.

", "locationName":"VpnConnectionId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

", "locationName":"Filter" } } }, "DescribeVpnConnectionsResult":{ "type":"structure", "members":{ "VpnConnections":{ "shape":"VpnConnectionList", "documentation":"

Information about one or more VPN connections.

", "locationName":"vpnConnectionSet" } } }, "DescribeVpnGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnGatewayIds":{ "shape":"VpnGatewayIdStringList", "documentation":"

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

", "locationName":"VpnGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway.

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

", "locationName":"Filter" } } }, "DescribeVpnGatewaysResult":{ "type":"structure", "members":{ "VpnGateways":{ "shape":"VpnGatewayList", "documentation":"

Information about one or more virtual private gateways.

", "locationName":"vpnGatewaySet" } } }, "DetachInternetGatewayRequest":{ "type":"structure", "required":[ "InternetGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "DetachNetworkInterfaceRequest":{ "type":"structure", "required":["AttachmentId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AttachmentId":{ "shape":"String", "documentation":"

The ID of the attachment.

", "locationName":"attachmentId" }, "Force":{ "shape":"Boolean", "documentation":"

Specifies whether to force a detachment.

", "locationName":"force" } } }, "DetachVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "Device":{ "shape":"String", "documentation":"

The device name.

" }, "Force":{ "shape":"Boolean", "documentation":"

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

" } } }, "DetachVpnGatewayRequest":{ "type":"structure", "required":[ "VpnGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } } }, "DeviceType":{ "type":"string", "enum":[ "ebs", "instance-store" ] }, "DhcpConfiguration":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The name of a DHCP option.

", "locationName":"key" }, "Values":{ "shape":"DhcpConfigurationValueList", "documentation":"

One or more values for the DHCP option.

", "locationName":"valueSet" } }, "documentation":"

Describes a DHCP configuration option.

" }, "DhcpConfigurationList":{ "type":"list", "member":{ "shape":"DhcpConfiguration", "locationName":"item" } }, "DhcpOptions":{ "type":"structure", "members":{ "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the set of DHCP options.

", "locationName":"dhcpOptionsId" }, "DhcpConfigurations":{ "shape":"DhcpConfigurationList", "documentation":"

One or more DHCP options in the set.

", "locationName":"dhcpConfigurationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the DHCP options set.

", "locationName":"tagSet" } }, "documentation":"

Describes a set of DHCP options.

" }, "DhcpOptionsIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"DhcpOptionsId" } }, "DhcpOptionsList":{ "type":"list", "member":{ "shape":"DhcpOptions", "locationName":"item" } }, "DisableVgwRoutePropagationRequest":{ "type":"structure", "required":[ "RouteTableId", "GatewayId" ], "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } } }, "DisassociateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" }, "AssociationId":{ "shape":"String", "documentation":"

[EC2-VPC] The association ID. Required for EC2-VPC.

" } } }, "DisassociateRouteTableRequest":{ "type":"structure", "required":["AssociationId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID representing the current association between the route table and subnet.

", "locationName":"associationId" } } }, "DiskImage":{ "type":"structure", "members":{ "Image":{"shape":"DiskImageDetail"}, "Description":{"shape":"String"}, "Volume":{"shape":"VolumeDetail"} }, "documentation":"

Describes a disk image.

" }, "DiskImageDescription":{ "type":"structure", "required":[ "Format", "Size", "ImportManifestUrl" ], "members":{ "Format":{ "shape":"DiskImageFormat", "documentation":"

The disk image format.

", "locationName":"format" }, "Size":{ "shape":"Long", "documentation":"

The size of the disk image.

", "locationName":"size" }, "ImportManifestUrl":{ "shape":"String", "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

", "locationName":"importManifestUrl" }, "Checksum":{ "shape":"String", "documentation":"

The checksum computed for the disk image.

", "locationName":"checksum" } } }, "DiskImageDetail":{ "type":"structure", "required":[ "Format", "Bytes", "ImportManifestUrl" ], "members":{ "Format":{ "shape":"DiskImageFormat", "documentation":"

The disk image format.

", "locationName":"format" }, "Bytes":{ "shape":"Long", "locationName":"bytes" }, "ImportManifestUrl":{ "shape":"String", "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

", "locationName":"importManifestUrl" } } }, "DiskImageFormat":{ "type":"string", "enum":[ "VMDK", "RAW", "VHD" ] }, "DiskImageList":{ "type":"list", "member":{"shape":"DiskImage"} }, "DiskImageVolumeDescription":{ "type":"structure", "required":["Id"], "members":{ "Size":{ "shape":"Long", "documentation":"

The size of the volume.

", "locationName":"size" }, "Id":{ "shape":"String", "documentation":"

The volume identifier.

", "locationName":"id" } } }, "DomainType":{ "type":"string", "enum":[ "vpc", "standard" ] }, "Double":{"type":"double"}, "EbsBlockDevice":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

", "locationName":"snapshotId" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB; otherwise, the minimum size is 1 GiB. The maximum volume size is 1024 GiB. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

", "locationName":"volumeSize" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the Amazon EBS volume is deleted on instance termination.

", "locationName":"deleteOnTermination" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

", "locationName":"volumeType" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

", "locationName":"iops" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

", "locationName":"encrypted" } }, "documentation":"

Describes an Amazon EBS block device.

" }, "EbsInstanceBlockDevice":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS volume.

", "locationName":"volumeId" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a parameter used to set up an Amazon EBS volume in a block device mapping.

" }, "EbsInstanceBlockDeviceSpecification":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS volume.

", "locationName":"volumeId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } } }, "EnableVgwRoutePropagationRequest":{ "type":"structure", "required":[ "RouteTableId", "GatewayId" ], "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } } }, "EnableVolumeIORequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" } } }, "EventCode":{ "type":"string", "enum":[ "instance-reboot", "system-reboot", "system-maintenance", "instance-retirement", "instance-stop" ] }, "ExecutableByStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ExecutableBy" } }, "ExportEnvironment":{ "type":"string", "enum":[ "citrix", "vmware", "microsoft" ] }, "ExportTask":{ "type":"structure", "members":{ "ExportTaskId":{ "shape":"String", "documentation":"

The ID of the export task.

", "locationName":"exportTaskId" }, "Description":{ "shape":"String", "documentation":"

A description of the resource being exported.

", "locationName":"description" }, "State":{ "shape":"ExportTaskState", "documentation":"

The state of the conversion task.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message related to the export task.

", "locationName":"statusMessage" }, "InstanceExportDetails":{ "shape":"InstanceExportDetails", "documentation":"

The instance being exported.

", "locationName":"instanceExport" }, "ExportToS3Task":{ "shape":"ExportToS3Task", "locationName":"exportToS3" } }, "documentation":"

Describes an export task.

" }, "ExportTaskIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ExportTaskId" } }, "ExportTaskList":{ "type":"list", "member":{ "shape":"ExportTask", "locationName":"item" } }, "ExportTaskState":{ "type":"string", "enum":[ "active", "cancelling", "cancelled", "completed" ] }, "ExportToS3Task":{ "type":"structure", "members":{ "DiskImageFormat":{ "shape":"DiskImageFormat", "documentation":"

The format for the exported image.

", "locationName":"diskImageFormat" }, "ContainerFormat":{ "shape":"ContainerFormat", "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", "locationName":"containerFormat" }, "S3Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACL permissions to the AWS account vm-import-export@amazon.com.

", "locationName":"s3Bucket" }, "S3Key":{ "shape":"String", "locationName":"s3Key" } } }, "ExportToS3TaskSpecification":{ "type":"structure", "members":{ "DiskImageFormat":{ "shape":"DiskImageFormat", "locationName":"diskImageFormat" }, "ContainerFormat":{ "shape":"ContainerFormat", "locationName":"containerFormat" }, "S3Bucket":{ "shape":"String", "locationName":"s3Bucket" }, "S3Prefix":{ "shape":"String", "documentation":"

The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

", "locationName":"s3Prefix" } } }, "Filter":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the filter.

" }, "Values":{ "shape":"ValueStringList", "documentation":"

One or more filter values.

", "locationName":"Value" } } }, "FilterList":{ "type":"list", "member":{ "shape":"Filter", "locationName":"Filter" } }, "Float":{"type":"float"}, "GatewayType":{ "type":"string", "enum":["ipsec.1"] }, "GetConsoleOutputRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" } } }, "GetConsoleOutputResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The time the output was last updated.

", "locationName":"timestamp" }, "Output":{ "shape":"String", "documentation":"

The console output, Base64 encoded.

", "locationName":"output" } } }, "GetPasswordDataRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the Windows instance.

" } } }, "GetPasswordDataResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the Windows instance.

", "locationName":"instanceId" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The time the data was last updated.

", "locationName":"timestamp" }, "PasswordData":{ "shape":"String", "documentation":"

The password of the instance.

", "locationName":"passwordData" } } }, "GroupIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"groupId" } }, "GroupIdentifier":{ "type":"structure", "members":{ "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } }, "documentation":"

Describes a security group.

" }, "GroupIdentifierList":{ "type":"list", "member":{ "shape":"GroupIdentifier", "locationName":"item" } }, "GroupNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"GroupName" } }, "HypervisorType":{ "type":"string", "enum":[ "ovm", "xen" ] }, "IamInstanceProfile":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", "locationName":"arn" }, "Id":{ "shape":"String", "documentation":"

The ID of the instance profile.

", "locationName":"id" } }, "documentation":"

Describes an IAM instance profile.

" }, "IamInstanceProfileSpecification":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", "locationName":"arn" }, "Name":{ "shape":"String", "documentation":"

The name of the instance profile.

", "locationName":"name" } }, "documentation":"

Describes an IAM instance profile.

" }, "IcmpTypeCode":{ "type":"structure", "members":{ "Type":{ "shape":"Integer", "documentation":"

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", "locationName":"type" }, "Code":{ "shape":"Integer", "documentation":"

The ICMP type. A value of -1 means all types.

", "locationName":"code" } }, "documentation":"

Describes the ICMP type and code.

" }, "Image":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "ImageLocation":{ "shape":"String", "documentation":"

The location of the AMI.

", "locationName":"imageLocation" }, "State":{ "shape":"ImageState", "documentation":"

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", "locationName":"imageState" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the image owner.

", "locationName":"imageOwnerId" }, "Public":{ "shape":"Boolean", "documentation":"

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

", "locationName":"isPublic" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

Any product codes associated with the AMI.

", "locationName":"productCodes" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the image.

", "locationName":"architecture" }, "ImageType":{ "shape":"ImageTypeValues", "documentation":"

The type of image.

", "locationName":"imageType" }, "KernelId":{ "shape":"String", "documentation":"

The kernel associated with the image, if any. Only applicable for machine images.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The RAM disk associated with the image, if any. Only applicable for machine images.

", "locationName":"ramdiskId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The value is Windows for Windows AMIs; otherwise blank.

", "locationName":"platform" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Specifies whether enhanced networking is enabled.

", "locationName":"sriovNetSupport" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason for the state change.

", "locationName":"stateReason" }, "ImageOwnerAlias":{ "shape":"String", "documentation":"

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

", "locationName":"imageOwnerAlias" }, "Name":{ "shape":"String", "documentation":"

The name of the AMI that was provided during image creation.

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

The description of the AMI that was provided during image creation.

", "locationName":"description" }, "RootDeviceType":{ "shape":"DeviceType", "documentation":"

The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

", "locationName":"rootDeviceType" }, "RootDeviceName":{ "shape":"String", "documentation":"

The device name of the root device (for example, /dev/sda1 or xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

Any block device mapping entries.

", "locationName":"blockDeviceMapping" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The type of virtualization of the AMI.

", "locationName":"virtualizationType" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the image.

", "locationName":"tagSet" }, "Hypervisor":{ "shape":"HypervisorType", "documentation":"

The hypervisor type of the image.

", "locationName":"hypervisor" } }, "documentation":"

Describes an image.

" }, "ImageAttribute":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "LaunchPermissions":{ "shape":"LaunchPermissionList", "documentation":"

One or more launch permissions.

", "locationName":"launchPermission" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

One or more product codes.

", "locationName":"productCodes" }, "KernelId":{ "shape":"AttributeValue", "documentation":"

The kernel ID.

", "locationName":"kernel" }, "RamdiskId":{ "shape":"AttributeValue", "documentation":"

The RAM disk ID.

", "locationName":"ramdisk" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the AMI.

", "locationName":"description" }, "SriovNetSupport":{ "shape":"AttributeValue", "locationName":"sriovNetSupport" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" } }, "documentation":"

Describes an image attribute.

" }, "ImageAttributeName":{ "type":"string", "enum":[ "description", "kernel", "ramdisk", "launchPermission", "productCodes", "blockDeviceMapping" ] }, "ImageIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ImageId" } }, "ImageList":{ "type":"list", "member":{ "shape":"Image", "locationName":"item" } }, "ImageState":{ "type":"string", "enum":[ "available", "deregistered" ] }, "ImageTypeValues":{ "type":"string", "enum":[ "machine", "kernel", "ramdisk" ] }, "ImportInstanceLaunchSpecification":{ "type":"structure", "members":{ "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the instance.

", "locationName":"architecture" }, "GroupNames":{ "shape":"SecurityGroupStringList", "documentation":"

One or more security group names.

", "locationName":"GroupName" }, "GroupIds":{ "shape":"SecurityGroupIdStringList", "locationName":"GroupId" }, "AdditionalInfo":{ "shape":"String", "locationName":"additionalInfo" }, "UserData":{ "shape":"String", "documentation":"

User data to be made available to the instance.

", "locationName":"userData" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"instanceType" }, "Placement":{ "shape":"Placement", "locationName":"placement" }, "Monitoring":{ "shape":"Boolean", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

", "locationName":"subnetId" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] Optionally, you can use this parameter to assign the instance a specific available IP address from the IP address range of the subnet.

", "locationName":"privateIpAddress" } } }, "ImportInstanceRequest":{ "type":"structure", "required":["Platform"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Description":{ "shape":"String", "documentation":"

A description for the instance being imported.

", "locationName":"description" }, "LaunchSpecification":{ "shape":"ImportInstanceLaunchSpecification", "documentation":"

", "locationName":"launchSpecification" }, "DiskImages":{ "shape":"DiskImageList", "locationName":"diskImage" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The instance operating system.

", "locationName":"platform" } } }, "ImportInstanceResult":{ "type":"structure", "members":{ "ConversionTask":{ "shape":"ConversionTask", "locationName":"conversionTask" } } }, "ImportInstanceTaskDetails":{ "type":"structure", "required":["Volumes"], "members":{ "Volumes":{ "shape":"ImportInstanceVolumeDetailSet", "locationName":"volumes" }, "InstanceId":{ "shape":"String", "locationName":"instanceId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The instance operating system.

", "locationName":"platform" }, "Description":{ "shape":"String", "locationName":"description" } } }, "ImportInstanceVolumeDetailItem":{ "type":"structure", "required":[ "BytesConverted", "AvailabilityZone", "Image", "Volume", "Status" ], "members":{ "BytesConverted":{ "shape":"Long", "documentation":"

The number of bytes converted so far.

", "locationName":"bytesConverted" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the resulting instance will reside.

", "locationName":"availabilityZone" }, "Image":{ "shape":"DiskImageDescription", "documentation":"

The image.

", "locationName":"image" }, "Volume":{ "shape":"DiskImageVolumeDescription", "documentation":"

The volume.

", "locationName":"volume" }, "Status":{ "shape":"String", "documentation":"

The status of the import of this particular disk image.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The status information or errors related to the disk image.

", "locationName":"statusMessage" }, "Description":{ "shape":"String", "locationName":"description" } }, "documentation":"

Describes an import volume task.

" }, "ImportInstanceVolumeDetailSet":{ "type":"list", "member":{ "shape":"ImportInstanceVolumeDetailItem", "locationName":"item" } }, "ImportKeyPairRequest":{ "type":"structure", "required":[ "KeyName", "PublicKeyMaterial" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

A unique name for the key pair.

", "locationName":"keyName" }, "PublicKeyMaterial":{ "shape":"Blob", "documentation":"

The public key. You must base64 encode the public key material before sending it to AWS.

", "locationName":"publicKeyMaterial" } } }, "ImportKeyPairResult":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The key pair name you provided.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", "locationName":"keyFingerprint" } } }, "ImportVolumeRequest":{ "type":"structure", "required":[ "AvailabilityZone", "Image", "Volume" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the resulting Amazon EBS volume.

", "locationName":"availabilityZone" }, "Image":{ "shape":"DiskImageDetail", "locationName":"image" }, "Description":{ "shape":"String", "documentation":"

An optional description for the volume being imported.

", "locationName":"description" }, "Volume":{ "shape":"VolumeDetail", "locationName":"volume" } } }, "ImportVolumeResult":{ "type":"structure", "members":{ "ConversionTask":{ "shape":"ConversionTask", "locationName":"conversionTask" } } }, "ImportVolumeTaskDetails":{ "type":"structure", "required":[ "BytesConverted", "AvailabilityZone", "Image", "Volume" ], "members":{ "BytesConverted":{ "shape":"Long", "documentation":"

The number of bytes converted so far.

", "locationName":"bytesConverted" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the resulting volume will reside.

", "locationName":"availabilityZone" }, "Description":{ "shape":"String", "documentation":"

The description you provided when starting the import volume task.

", "locationName":"description" }, "Image":{ "shape":"DiskImageDescription", "documentation":"

The image.

", "locationName":"image" }, "Volume":{ "shape":"DiskImageVolumeDescription", "documentation":"

The volume.

", "locationName":"volume" } }, "documentation":"

Describes an import volume task.

" }, "Instance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI used to launch the instance.

", "locationName":"imageId" }, "State":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

", "locationName":"instanceState" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

", "locationName":"privateDnsName" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name assigned to the instance. This name is not available until the instance enters the running state.

", "locationName":"dnsName" }, "StateTransitionReason":{ "shape":"String", "documentation":"

The reason for the most recent state transition. This might be an empty string.

", "locationName":"reason" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair, if this instance was launched with an associated key pair.

", "locationName":"keyName" }, "AmiLaunchIndex":{ "shape":"Integer", "documentation":"

The AMI launch index, which can be used to find this instance in the launch group.

", "locationName":"amiLaunchIndex" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

The product codes attached to this instance.

", "locationName":"productCodes" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "LaunchTime":{ "shape":"DateTime", "documentation":"

The time the instance was launched.

", "locationName":"launchTime" }, "Placement":{ "shape":"Placement", "documentation":"

The location where the instance launched.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The kernel associated with this instance.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The RAM disk associated with this instance.

", "locationName":"ramdiskId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The value is Windows for Windows instances; otherwise blank.

", "locationName":"platform" }, "Monitoring":{ "shape":"Monitoring", "documentation":"

The monitoring information for the instance.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which the instance is running.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC in which the instance is running.

", "locationName":"vpcId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address assigned to the instance.

", "locationName":"privateIpAddress" }, "PublicIpAddress":{ "shape":"String", "documentation":"

The public IP address assigned to the instance.

", "locationName":"ipAddress" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason for the most recent state transition.

", "locationName":"stateReason" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the image.

", "locationName":"architecture" }, "RootDeviceType":{ "shape":"DeviceType", "documentation":"

The root device type used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

", "locationName":"rootDeviceType" }, "RootDeviceName":{ "shape":"String", "documentation":"

The root device name (for example, /dev/sda1).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"

Any block device mapping entries for the instance.

", "locationName":"blockDeviceMapping" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The virtualization type of the instance.

", "locationName":"virtualizationType" }, "InstanceLifecycle":{ "shape":"InstanceLifecycleType", "documentation":"

Indicates whether this is a Spot Instance.

", "locationName":"instanceLifecycle" }, "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot Instance request.

", "locationName":"spotInstanceRequestId" }, "ClientToken":{ "shape":"String", "documentation":"

The idempotency token you provided when you launched the instance.

", "locationName":"clientToken" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the instance.

", "locationName":"tagSet" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups for the instance.

", "locationName":"groupSet" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", "locationName":"sourceDestCheck" }, "Hypervisor":{ "shape":"HypervisorType", "documentation":"

The hypervisor type of the instance.

", "locationName":"hypervisor" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceList", "documentation":"

[EC2-VPC] One or more network interfaces for the instance.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfile", "documentation":"

The IAM instance profile associated with the instance.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Specifies whether enhanced networking is enabled.

", "locationName":"sriovNetSupport" } }, "documentation":"

Describes an instance.

" }, "InstanceAttribute":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "InstanceType":{ "shape":"AttributeValue", "documentation":"

The instance type.

", "locationName":"instanceType" }, "KernelId":{ "shape":"AttributeValue", "documentation":"

The kernel ID.

", "locationName":"kernel" }, "RamdiskId":{ "shape":"AttributeValue", "documentation":"

The RAM disk ID.

", "locationName":"ramdisk" }, "UserData":{ "shape":"AttributeValue", "documentation":"

The Base64-encoded MIME user data.

", "locationName":"userData" }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", "documentation":"

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ "shape":"AttributeValue", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "RootDeviceName":{ "shape":"AttributeValue", "documentation":"

The name of the root device (for example, /dev/sda1).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"

The block device mapping of the instance.

", "locationName":"blockDeviceMapping" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" }, "EbsOptimized":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instance is optimized for EBS I/O.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"AttributeValue", "locationName":"sriovNetSupport" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

The security groups associated with the instance.

", "locationName":"groupSet" } }, "documentation":"

Describes an instance attribute.

" }, "InstanceAttributeName":{ "type":"string", "enum":[ "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "rootDeviceName", "blockDeviceMapping", "productCodes", "sourceDestCheck", "groupSet", "ebsOptimized", "sriovNetSupport" ] }, "InstanceBlockDeviceMapping":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsInstanceBlockDevice", "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", "locationName":"ebs" } }, "documentation":"

Describes a block device mapping.

" }, "InstanceBlockDeviceMappingList":{ "type":"list", "member":{ "shape":"InstanceBlockDeviceMapping", "locationName":"item" } }, "InstanceBlockDeviceMappingSpecification":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsInstanceBlockDeviceSpecification", "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", "locationName":"ebs" }, "VirtualName":{ "shape":"String", "documentation":"

The virtual device name.

", "locationName":"virtualName" }, "NoDevice":{ "shape":"String", "documentation":"

suppress the specified device included in the block device mapping.

", "locationName":"noDevice" } }, "documentation":"

Describes a block device mapping entry.

" }, "InstanceBlockDeviceMappingSpecificationList":{ "type":"list", "member":{ "shape":"InstanceBlockDeviceMappingSpecification", "locationName":"item" } }, "InstanceCount":{ "type":"structure", "members":{ "State":{ "shape":"ListingState", "documentation":"

The states of the listed Reserved Instances.

", "locationName":"state" }, "InstanceCount":{ "shape":"Integer", "documentation":"

he number of listed Reserved Instances in the state specified by the state.

", "locationName":"instanceCount" } }, "documentation":"

Describes a Reserved Instance listing state.

" }, "InstanceCountList":{ "type":"list", "member":{ "shape":"InstanceCount", "locationName":"item" } }, "InstanceExportDetails":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the resource being exported.

", "locationName":"instanceId" }, "TargetEnvironment":{ "shape":"ExportEnvironment", "documentation":"

The target virtualization environment.

", "locationName":"targetEnvironment" } }, "documentation":"

Describes an instance export task.

" }, "InstanceIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"InstanceId" } }, "InstanceLifecycleType":{ "type":"string", "enum":["spot"] }, "InstanceList":{ "type":"list", "member":{ "shape":"Instance", "locationName":"item" } }, "InstanceMonitoring":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Monitoring":{ "shape":"Monitoring", "documentation":"

The monitoring information.

", "locationName":"monitoring" } }, "documentation":"

Describes the monitoring information of the instance.

" }, "InstanceMonitoringList":{ "type":"list", "member":{ "shape":"InstanceMonitoring", "locationName":"item" } }, "InstanceNetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Description":{ "shape":"String", "documentation":"

The description.

", "locationName":"description" }, "OwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that created the network interface.

", "locationName":"ownerId" }, "Status":{ "shape":"NetworkInterfaceStatus", "documentation":"

The status of the network interface.

", "locationName":"status" }, "MacAddress":{ "shape":"String", "documentation":"

The MAC address.

", "locationName":"macAddress" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Indicates whether to validate network traffic to or from this network interface.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups.

", "locationName":"groupSet" }, "Attachment":{ "shape":"InstanceNetworkInterfaceAttachment", "documentation":"

The network interface attachment.

", "locationName":"attachment" }, "Association":{ "shape":"InstanceNetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP associated with the network interface.

", "locationName":"association" }, "PrivateIpAddresses":{ "shape":"InstancePrivateIpAddressList", "documentation":"

The private IP addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" } }, "documentation":"

Describes a network interface.

" }, "InstanceNetworkInterfaceAssociation":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The public IP address or Elastic IP address bound to the network interface.

", "locationName":"publicIp" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name.

", "locationName":"publicDnsName" }, "IpOwnerId":{ "shape":"String", "documentation":"

The ID of the owner of the Elastic IP address.

", "locationName":"ipOwnerId" } }, "documentation":"

Describes association information for an Elastic IP address.

" }, "InstanceNetworkInterfaceAttachment":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device on the instance for the network interface attachment.

", "locationName":"deviceIndex" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a network interface attachment.

" }, "InstanceNetworkInterfaceList":{ "type":"list", "member":{ "shape":"InstanceNetworkInterface", "locationName":"item" } }, "InstanceNetworkInterfaceSpecification":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

", "locationName":"deviceIndex" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

", "locationName":"subnetId" }, "Description":{ "shape":"String", "documentation":"

The description of the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"description" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"privateIpAddress" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"SecurityGroupId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

", "locationName":"deleteOnTermination" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", "documentation":"

One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.

", "locationName":"privateIpAddressesSet", "queryName":"PrivateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.

", "locationName":"secondaryPrivateIpAddressCount" }, "AssociatePublicIpAddress":{ "shape":"Boolean", "documentation":"

Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If luanching into a default subnet, the default value is true.

", "locationName":"associatePublicIpAddress" } }, "documentation":"

Describes a network interface.

" }, "InstanceNetworkInterfaceSpecificationList":{ "type":"list", "member":{ "shape":"InstanceNetworkInterfaceSpecification", "locationName":"item" } }, "InstancePrivateIpAddress":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the network interface.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", "locationName":"primary" }, "Association":{ "shape":"InstanceNetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address for the network interface.

", "locationName":"association" } }, "documentation":"

Describes a private IP address.

" }, "InstancePrivateIpAddressList":{ "type":"list", "member":{ "shape":"InstancePrivateIpAddress", "locationName":"item" } }, "InstanceState":{ "type":"structure", "members":{ "Code":{ "shape":"Integer", "documentation":"

The low byte represents the state. The high byte is an opaque internal value and should be ignored.

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

", "locationName":"code" }, "Name":{ "shape":"InstanceStateName", "documentation":"

The current state of the instance.

", "locationName":"name" } }, "documentation":"

Describes the current state of the instance.

" }, "InstanceStateChange":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "CurrentState":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

", "locationName":"currentState" }, "PreviousState":{ "shape":"InstanceState", "documentation":"

The previous state of the instance.

", "locationName":"previousState" } }, "documentation":"

Describes an instance state change.

" }, "InstanceStateChangeList":{ "type":"list", "member":{ "shape":"InstanceStateChange", "locationName":"item" } }, "InstanceStateName":{ "type":"string", "enum":[ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ] }, "InstanceStatus":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the instance.

", "locationName":"availabilityZone" }, "Events":{ "shape":"InstanceStatusEventList", "documentation":"

Extra information regarding events associated with the instance.

", "locationName":"eventsSet" }, "InstanceState":{ "shape":"InstanceState", "documentation":"

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

", "locationName":"instanceState" }, "SystemStatus":{ "shape":"InstanceStatusSummary", "documentation":"

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

", "locationName":"systemStatus" }, "InstanceStatus":{ "shape":"InstanceStatusSummary", "documentation":"

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

", "locationName":"instanceStatus" } }, "documentation":"

Describes the status of an instance.

" }, "InstanceStatusDetails":{ "type":"structure", "members":{ "Name":{ "shape":"StatusName", "documentation":"

The type of instance status.

", "locationName":"name" }, "Status":{ "shape":"StatusType", "documentation":"

The status.

", "locationName":"status" }, "ImpairedSince":{ "shape":"DateTime", "documentation":"

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

", "locationName":"impairedSince" } }, "documentation":"

Describes the instance status.

" }, "InstanceStatusDetailsList":{ "type":"list", "member":{ "shape":"InstanceStatusDetails", "locationName":"item" } }, "InstanceStatusEvent":{ "type":"structure", "members":{ "Code":{ "shape":"EventCode", "documentation":"

The associated code of the event.

", "locationName":"code" }, "Description":{ "shape":"String", "documentation":"

A description of the event.

", "locationName":"description" }, "NotBefore":{ "shape":"DateTime", "documentation":"

The earliest scheduled start time for the event.

", "locationName":"notBefore" }, "NotAfter":{ "shape":"DateTime", "documentation":"

The latest scheduled end time for the event.

", "locationName":"notAfter" } }, "documentation":"

Describes an instance event.

" }, "InstanceStatusEventList":{ "type":"list", "member":{ "shape":"InstanceStatusEvent", "locationName":"item" } }, "InstanceStatusList":{ "type":"list", "member":{ "shape":"InstanceStatus", "locationName":"item" } }, "InstanceStatusSummary":{ "type":"structure", "members":{ "Status":{ "shape":"SummaryStatus", "documentation":"

The status.

", "locationName":"status" }, "Details":{ "shape":"InstanceStatusDetailsList", "documentation":"

The system instance health or application instance health.

", "locationName":"details" } }, "documentation":"

Describes the status of an instance.

" }, "InstanceType":{ "type":"string", "enum":[ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "t2.micro", "t2.small", "t2.medium", "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", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge" ] }, "InstanceTypeList":{ "type":"list", "member":{"shape":"InstanceType"} }, "Integer":{"type":"integer"}, "InternetGateway":{ "type":"structure", "members":{ "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "Attachments":{ "shape":"InternetGatewayAttachmentList", "documentation":"

Any VPCs attached to the Internet gateway.

", "locationName":"attachmentSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the Internet gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes an Internet gateway.

" }, "InternetGatewayAttachment":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"AttachmentStatus", "documentation":"

The current state of the attachment.

", "locationName":"state" } }, "documentation":"

Describes the attachment of a VPC to an Internet gateway.

" }, "InternetGatewayAttachmentList":{ "type":"list", "member":{ "shape":"InternetGatewayAttachment", "locationName":"item" } }, "InternetGatewayList":{ "type":"list", "member":{ "shape":"InternetGateway", "locationName":"item" } }, "IpPermission":{ "type":"structure", "members":{ "IpProtocol":{ "shape":"String", "documentation":"

The protocol.

When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

", "locationName":"toPort" }, "UserIdGroupPairs":{ "shape":"UserIdGroupPairList", "documentation":"

One or more security group and AWS account ID pairs.

", "locationName":"groups" }, "IpRanges":{ "shape":"IpRangeList", "documentation":"

One or more IP ranges.

", "locationName":"ipRanges" } }, "documentation":"

Describes a security group rule.

" }, "IpPermissionList":{ "type":"list", "member":{ "shape":"IpPermission", "locationName":"item" } }, "IpRange":{ "type":"structure", "members":{ "CidrIp":{ "shape":"String", "documentation":"

The CIDR range. You can either specify a CIDR range or a source security group, not both.

", "locationName":"cidrIp" } }, "documentation":"

Describes an IP range.

" }, "IpRangeList":{ "type":"list", "member":{ "shape":"IpRange", "locationName":"item" } }, "KeyNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"KeyName" } }, "KeyPair":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

The SHA-1 digest of the DER encoded private key.

", "locationName":"keyFingerprint" }, "KeyMaterial":{ "shape":"String", "documentation":"

An unencrypted PEM encoded RSA private key.

", "locationName":"keyMaterial" } }, "documentation":"

Describes a key pair.

" }, "KeyPairInfo":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", "locationName":"keyFingerprint" } }, "documentation":"

Describes a key pair.

" }, "KeyPairList":{ "type":"list", "member":{ "shape":"KeyPairInfo", "locationName":"item" } }, "LaunchPermission":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The AWS account ID.

", "locationName":"userId" }, "Group":{ "shape":"PermissionGroup", "documentation":"

The name of the group.

", "locationName":"group" } }, "documentation":"

Describes a launch permission.

" }, "LaunchPermissionList":{ "type":"list", "member":{ "shape":"LaunchPermission", "locationName":"item" } }, "LaunchPermissionModifications":{ "type":"structure", "members":{ "Add":{ "shape":"LaunchPermissionList", "documentation":"

The AWS account ID to add to the list of launch permissions for the AMI.

" }, "Remove":{ "shape":"LaunchPermissionList", "documentation":"

The AWS account ID to remove from the list of launch permissions for the AMI.

" } }, "documentation":"

Describes a launch permission modification.

" }, "LaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups. If requesting a Spot Instance in a nondefault VPC, you must specify the security group ID. If requesting a Spot Instance in EC2-Classic or a default VPC, you can specify either the security group name or ID.

", "locationName":"groupSet" }, "UserData":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

Default: m1.small

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the Spot Instance.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" } }, "documentation":"

Describes the launch specification of a Spot Instance.

" }, "ListingState":{ "type":"string", "enum":[ "available", "sold", "cancelled", "pending" ] }, "ListingStatus":{ "type":"string", "enum":[ "active", "pending", "cancelled", "closed" ] }, "Long":{"type":"long"}, "ModifyImageAttributeRequest":{ "type":"structure", "required":["ImageId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"String", "documentation":"

The name of the attribute to modify.

" }, "OperationType":{ "shape":"String", "documentation":"

The operation type.

" }, "UserIds":{ "shape":"UserIdStringList", "documentation":"

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

", "locationName":"UserId" }, "UserGroups":{ "shape":"UserGroupStringList", "documentation":"

One or more user groups. This is only valid when modifying the launchPermission attribute.

", "locationName":"UserGroup" }, "ProductCodes":{ "shape":"ProductCodeStringList", "documentation":"

One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

", "locationName":"ProductCode" }, "Value":{ "shape":"String", "documentation":"

The value of the attribute being modified. This is only valid when modifying the description attribute.

" }, "LaunchPermission":{ "shape":"LaunchPermissionModifications", "documentation":"

" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the AMI.

" } } }, "ModifyInstanceAttributeRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The name of the attribute.

", "locationName":"attribute" }, "Value":{ "shape":"String", "documentation":"

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or intanceInitiateShutdownBehavior attribute.

", "locationName":"value" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingSpecificationList", "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"blockDeviceMapping" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

" }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", "documentation":"

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.

", "locationName":"disableApiTermination" }, "InstanceType":{ "shape":"AttributeValue", "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", "locationName":"instanceType" }, "Kernel":{ "shape":"AttributeValue", "documentation":"

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", "locationName":"kernel" }, "Ramdisk":{ "shape":"AttributeValue", "documentation":"

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", "locationName":"ramdisk" }, "UserData":{ "shape":"BlobAttributeValue", "documentation":"

Changes the instance's user data to the specified value.

", "locationName":"userData" }, "InstanceInitiatedShutdownBehavior":{ "shape":"AttributeValue", "documentation":"

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "Groups":{ "shape":"GroupIdStringList", "documentation":"

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

For example, if you want the instance to be in sg-1a1a1a1a and sg-9b9b9b9b, specify GroupId.1=sg-1a1a1a1a and GroupId.2=sg-9b9b9b9b.

", "locationName":"GroupId" }, "EbsOptimized":{ "shape":"AttributeBooleanValue", "documentation":"

Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"AttributeValue", "documentation":"

Set to simple to enable enhanced networking for the instance.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", "locationName":"sriovNetSupport" } } }, "ModifyNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the network interface.

", "locationName":"description" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", "locationName":"SecurityGroupId" }, "Attachment":{ "shape":"NetworkInterfaceAttachmentChanges", "documentation":"

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

", "locationName":"attachment" } } }, "ModifyReservedInstancesRequest":{ "type":"structure", "required":[ "ReservedInstancesIds", "TargetConfigurations" ], "members":{ "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive token you provide to ensure idempotency of your modification request.

", "locationName":"clientToken" }, "ReservedInstancesIds":{ "shape":"ReservedInstancesIdStringList", "documentation":"

The IDs of the Reserved Instances to modify.

", "locationName":"ReservedInstancesId" }, "TargetConfigurations":{ "shape":"ReservedInstancesConfigurationList", "documentation":"

The configuration settings for the Reserved Instances to modify.

", "locationName":"ReservedInstancesConfigurationSetItemType" } } }, "ModifyReservedInstancesResult":{ "type":"structure", "members":{ "ReservedInstancesModificationId":{ "shape":"String", "documentation":"

The ID for the modification.

", "locationName":"reservedInstancesModificationId" } } }, "ModifySnapshotAttributeRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The snapshot attribute to modify.

" }, "OperationType":{ "shape":"String", "documentation":"

The type of operation to perform to the attribute.

" }, "UserIds":{ "shape":"UserIdStringList", "documentation":"

The account ID to modify for the snapshot.

", "locationName":"UserId" }, "GroupNames":{ "shape":"GroupNameStringList", "documentation":"

The group to modify for the snapshot.

", "locationName":"UserGroup" }, "CreateVolumePermission":{ "shape":"CreateVolumePermissionModifications", "documentation":"

A JSON representation of the snapshot attribute modification.

" } } }, "ModifySubnetAttributeRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "MapPublicIpOnLaunch":{"shape":"AttributeBooleanValue"} } }, "ModifyVolumeAttributeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "AutoEnableIO":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the volume should be auto-enabled for I/O operations.

" } } }, "ModifyVpcAttributeRequest":{ "type":"structure", "required":["VpcId"], "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "EnableDnsSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

" }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You can only enable DNS hostnames if you also enable DNS support.

" } } }, "MonitorInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } } }, "MonitorInstancesResult":{ "type":"structure", "members":{ "InstanceMonitorings":{ "shape":"InstanceMonitoringList", "documentation":"

Monitoring information for one or more instances.

", "locationName":"instancesSet" } } }, "Monitoring":{ "type":"structure", "members":{ "State":{ "shape":"MonitoringState", "documentation":"

Indicates whether monitoring is enabled for the instance.

", "locationName":"state" } }, "documentation":"

Describes the monitoring for the instance.

" }, "MonitoringState":{ "type":"string", "enum":[ "disabled", "enabled", "pending" ] }, "NetworkAcl":{ "type":"structure", "members":{ "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for the network ACL.

", "locationName":"vpcId" }, "IsDefault":{ "shape":"Boolean", "documentation":"

Indicates whether this is the default network ACL for the VPC.

", "locationName":"default" }, "Entries":{ "shape":"NetworkAclEntryList", "documentation":"

One or more entries (rules) in the network ACL.

", "locationName":"entrySet" }, "Associations":{ "shape":"NetworkAclAssociationList", "documentation":"

Any associations between the network ACL and one or more subnets

", "locationName":"associationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the network ACL.

", "locationName":"tagSet" } }, "documentation":"

Describes a network ACL.

" }, "NetworkAclAssociation":{ "type":"structure", "members":{ "NetworkAclAssociationId":{ "shape":"String", "documentation":"

The ID of the association between a network ACL and a subnet.

", "locationName":"networkAclAssociationId" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" } }, "documentation":"

Describes an association between a network ACL and a subnet.

" }, "NetworkAclAssociationList":{ "type":"list", "member":{ "shape":"NetworkAclAssociation", "locationName":"item" } }, "NetworkAclEntry":{ "type":"structure", "members":{ "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The protocol. A value of -1 means all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation.

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code.

", "locationName":"icmpTypeCode" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", "locationName":"portRange" } }, "documentation":"

Describes an entry in a network ACL.

" }, "NetworkAclEntryList":{ "type":"list", "member":{ "shape":"NetworkAclEntry", "locationName":"item" } }, "NetworkAclList":{ "type":"list", "member":{ "shape":"NetworkAcl", "locationName":"item" } }, "NetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "Description":{ "shape":"String", "documentation":"

A description.

", "locationName":"description" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the network interface.

", "locationName":"ownerId" }, "RequesterId":{ "shape":"String", "documentation":"

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", "locationName":"requesterId" }, "RequesterManaged":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is being managed by AWS.

", "locationName":"requesterManaged" }, "Status":{ "shape":"NetworkInterfaceStatus", "documentation":"

The status of the network interface.

", "locationName":"status" }, "MacAddress":{ "shape":"String", "documentation":"

The MAC address.

", "locationName":"macAddress" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Indicates whether traffic to or from the instance is validated.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

Any security groups for the network interface.

", "locationName":"groupSet" }, "Attachment":{ "shape":"NetworkInterfaceAttachment", "documentation":"

The network interface attachment.

", "locationName":"attachment" }, "Association":{ "shape":"NetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP associated with the network interface.

", "locationName":"association" }, "TagSet":{ "shape":"TagList", "documentation":"

Any tags assigned to the network interface.

", "locationName":"tagSet" }, "PrivateIpAddresses":{ "shape":"NetworkInterfacePrivateIpAddressList", "documentation":"

The private IP addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" } }, "documentation":"

Describes a network interface.

" }, "NetworkInterfaceAssociation":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The address of the Elastic IP address bound to the network interface.

", "locationName":"publicIp" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name.

", "locationName":"publicDnsName" }, "IpOwnerId":{ "shape":"String", "documentation":"

The ID of the Elastic IP address owner.

", "locationName":"ipOwnerId" }, "AllocationId":{ "shape":"String", "documentation":"

The allocation ID.

", "locationName":"allocationId" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID.

", "locationName":"associationId" } }, "documentation":"

Describes association information for an Elastic IP address.

" }, "NetworkInterfaceAttachment":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "InstanceOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the instance.

", "locationName":"instanceOwnerId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The device index of the network interface attachment on the instance.

", "locationName":"deviceIndex" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The timestamp indicating when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a network interface attachment.

" }, "NetworkInterfaceAttachmentChanges":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes an attachment change.

" }, "NetworkInterfaceAttribute":{ "type":"string", "enum":[ "description", "groupSet", "sourceDestCheck", "attachment" ] }, "NetworkInterfaceIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "NetworkInterfaceList":{ "type":"list", "member":{ "shape":"NetworkInterface", "locationName":"item" } }, "NetworkInterfacePrivateIpAddress":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", "locationName":"primary" }, "Association":{ "shape":"NetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address associated with the network interface.

", "locationName":"association" } }, "documentation":"

Describes the private IP address of a network interface.

" }, "NetworkInterfacePrivateIpAddressList":{ "type":"list", "member":{ "shape":"NetworkInterfacePrivateIpAddress", "locationName":"item" } }, "NetworkInterfaceStatus":{ "type":"string", "enum":[ "available", "attaching", "in-use", "detaching" ] }, "OfferingTypeValues":{ "type":"string", "enum":[ "Heavy Utilization", "Medium Utilization", "Light Utilization" ] }, "OwnerStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"Owner" } }, "PermissionGroup":{ "type":"string", "enum":["all"] }, "Placement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the instance.

", "locationName":"availabilityZone" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group the instance is in (for cluster compute instances).

", "locationName":"groupName" }, "Tenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

", "locationName":"tenancy" } }, "documentation":"

Describes the placement for the instance.

" }, "PlacementGroup":{ "type":"structure", "members":{ "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"

The placement strategy.

", "locationName":"strategy" }, "State":{ "shape":"PlacementGroupState", "documentation":"

The state of the placement group.

", "locationName":"state" } }, "documentation":"

Describes a placement group.

" }, "PlacementGroupList":{ "type":"list", "member":{ "shape":"PlacementGroup", "locationName":"item" } }, "PlacementGroupState":{ "type":"string", "enum":[ "pending", "available", "deleting", "deleted" ] }, "PlacementGroupStringList":{ "type":"list", "member":{"shape":"String"} }, "PlacementStrategy":{ "type":"string", "enum":["cluster"] }, "PlatformValues":{ "type":"string", "enum":["Windows"] }, "PortRange":{ "type":"structure", "members":{ "From":{ "shape":"Integer", "documentation":"

The first port in the range.

", "locationName":"from" }, "To":{ "shape":"Integer", "documentation":"

The last port in the range.

", "locationName":"to" } }, "documentation":"

Describes a range of ports.

" }, "PriceSchedule":{ "type":"structure", "members":{ "Term":{ "shape":"Long", "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"

The fixed price for the term.

", "locationName":"price" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "Active":{ "shape":"Boolean", "documentation":"

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", "locationName":"active" } }, "documentation":"

Describes the price for a Reserved Instance.

" }, "PriceScheduleList":{ "type":"list", "member":{ "shape":"PriceSchedule", "locationName":"item" } }, "PriceScheduleSpecification":{ "type":"structure", "members":{ "Term":{ "shape":"Long", "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"

The fixed price for the term.

", "locationName":"price" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } }, "documentation":"

Describes the price for a Reserved Instance.

" }, "PriceScheduleSpecificationList":{ "type":"list", "member":{ "shape":"PriceScheduleSpecification", "locationName":"item" } }, "PricingDetail":{ "type":"structure", "members":{ "Price":{ "shape":"Double", "documentation":"

The price per instance.

", "locationName":"price" }, "Count":{ "shape":"Integer", "documentation":"

The number of instances available for the price.

", "locationName":"count" } }, "documentation":"

Describes a Reserved Instance offering.

" }, "PricingDetailsList":{ "type":"list", "member":{ "shape":"PricingDetail", "locationName":"item" } }, "PrivateIpAddressSpecification":{ "type":"structure", "required":["PrivateIpAddress"], "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP addresses.

", "locationName":"privateIpAddress" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

", "locationName":"primary" } }, "documentation":"

Describes a secondary private IP address for a network interface.

" }, "PrivateIpAddressSpecificationList":{ "type":"list", "member":{ "shape":"PrivateIpAddressSpecification", "locationName":"item" } }, "PrivateIpAddressStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"PrivateIpAddress" } }, "ProductCode":{ "type":"structure", "members":{ "ProductCodeId":{ "shape":"String", "documentation":"

The product code.

", "locationName":"productCode" }, "ProductCodeType":{ "shape":"ProductCodeValues", "documentation":"

The type of product code.

", "locationName":"type" } }, "documentation":"

Describes a product code.

" }, "ProductCodeList":{ "type":"list", "member":{ "shape":"ProductCode", "locationName":"item" } }, "ProductCodeStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ProductCode" } }, "ProductCodeValues":{ "type":"string", "enum":[ "devpay", "marketplace" ] }, "ProductDescriptionList":{ "type":"list", "member":{"shape":"String"} }, "PropagatingVgw":{ "type":"structure", "members":{ "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway (VGW).

", "locationName":"gatewayId" } }, "documentation":"

Describes a virtual private gateway propagating route.

" }, "PropagatingVgwList":{ "type":"list", "member":{ "shape":"PropagatingVgw", "locationName":"item" } }, "PublicIpStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"PublicIp" } }, "PurchaseReservedInstancesOfferingRequest":{ "type":"structure", "required":[ "ReservedInstancesOfferingId", "InstanceCount" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance offering to purchase.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of Reserved Instances to purchase.

" }, "LimitPrice":{ "shape":"ReservedInstanceLimitPrice", "documentation":"

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", "locationName":"limitPrice" } } }, "PurchaseReservedInstancesOfferingResult":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The IDs of the purchased Reserved Instances.

", "locationName":"reservedInstancesId" } } }, "RIProductDescription":{ "type":"string", "enum":[ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ] }, "ReasonCodesList":{ "type":"list", "member":{ "shape":"ReportInstanceReasonCodes", "locationName":"item" } }, "RebootInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } } }, "RecurringCharge":{ "type":"structure", "members":{ "Frequency":{ "shape":"RecurringChargeFrequency", "documentation":"

The frequency of the recurring charge.

", "locationName":"frequency" }, "Amount":{ "shape":"Double", "documentation":"

The amount of the recurring charge.

", "locationName":"amount" } }, "documentation":"

Describes a recurring charge.

" }, "RecurringChargeFrequency":{ "type":"string", "enum":["Hourly"] }, "RecurringChargesList":{ "type":"list", "member":{ "shape":"RecurringCharge", "locationName":"item" } }, "Region":{ "type":"structure", "members":{ "RegionName":{ "shape":"String", "documentation":"

The name of the region.

", "locationName":"regionName" }, "Endpoint":{ "shape":"String", "documentation":"

The region service endpoint.

", "locationName":"regionEndpoint" } }, "documentation":"

Describes a region.

" }, "RegionList":{ "type":"list", "member":{ "shape":"Region", "locationName":"item" } }, "RegionNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"RegionName" } }, "RegisterImageRequest":{ "type":"structure", "required":["Name"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageLocation":{ "shape":"String", "documentation":"

The full path to your AMI manifest in Amazon S3 storage.

" }, "Name":{ "shape":"String", "documentation":"

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

A description for your AMI.

", "locationName":"description" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

", "locationName":"architecture" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "RootDeviceName":{ "shape":"String", "documentation":"

The name of the root device (for example, /dev/sda1, or xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

One or more block device mapping entries.

", "locationName":"BlockDeviceMapping" }, "VirtualizationType":{ "shape":"String", "documentation":"

The type of virtualization.

Default: paravirtual

", "locationName":"virtualizationType" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Set to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", "locationName":"sriovNetSupport" } } }, "RegisterImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the newly registered AMI.

", "locationName":"imageId" } } }, "RejectVpcPeeringConnectionRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "RejectVpcPeeringConnectionResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "ReleaseAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" } } }, "ReplaceNetworkAclAssociationRequest":{ "type":"structure", "required":[ "AssociationId", "NetworkAclId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The ID of the current association between the original network ACL and the subnet.

", "locationName":"associationId" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the new network ACL to associate with the subnet.

", "locationName":"networkAclId" } } }, "ReplaceNetworkAclAssociationResult":{ "type":"structure", "members":{ "NewAssociationId":{ "shape":"String", "documentation":"

The ID of the new association.

", "locationName":"newAssociationId" } } }, "ReplaceNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Protocol", "RuleAction", "Egress", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number of the entry to replace.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The IP protocol. You can specify all or -1 to mean all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation.

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.

", "locationName":"Icmp" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.

", "locationName":"portRange" } } }, "ReplaceRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of an Internet gateway or virtual private gateway.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC.

", "locationName":"instanceId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of a network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of a VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "ReplaceRouteTableAssociationRequest":{ "type":"structure", "required":[ "AssociationId", "RouteTableId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID.

", "locationName":"associationId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the new route table to associate with the subnet.

", "locationName":"routeTableId" } } }, "ReplaceRouteTableAssociationResult":{ "type":"structure", "members":{ "NewAssociationId":{ "shape":"String", "documentation":"

The ID of the new association.

", "locationName":"newAssociationId" } } }, "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" ] }, "ReportInstanceStatusRequest":{ "type":"structure", "required":[ "Instances", "Status", "ReasonCodes" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Instances":{ "shape":"InstanceIdStringList", "documentation":"

One or more instances.

", "locationName":"instanceId" }, "Status":{ "shape":"ReportStatusType", "documentation":"

The status of all instances listed.

", "locationName":"status" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time at which the reported instance health state began.

", "locationName":"startTime" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time at which the reported instance health state ended.

", "locationName":"endTime" }, "ReasonCodes":{ "shape":"ReasonCodesList", "documentation":"

One or more reason codes that describes the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems which I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

", "locationName":"reasonCode" }, "Description":{ "shape":"String", "documentation":"

Descriptive text about the health state of your instance.

", "locationName":"description" } } }, "ReportStatusType":{ "type":"string", "enum":[ "ok", "impaired" ] }, "RequestSpotInstancesRequest":{ "type":"structure", "required":["SpotPrice"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum hourly price for any Spot Instance launched to fulfill the request.

", "locationName":"spotPrice" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The maximum number of Spot Instances to launch.

Default: 1

", "locationName":"instanceCount" }, "Type":{ "shape":"SpotInstanceType", "documentation":"

The Spot Instance request type.

Default: one-time

", "locationName":"type" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

Default: The request is effective indefinitely.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

Default: The request is effective indefinitely.

", "locationName":"validUntil" }, "LaunchGroup":{ "shape":"String", "documentation":"

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

", "locationName":"launchGroup" }, "AvailabilityZoneGroup":{ "shape":"String", "documentation":"

The user-specified name for a logical grouping of bids.

When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", "locationName":"availabilityZoneGroup" }, "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} } }, "RequestSpotInstancesResult":{ "type":"structure", "members":{ "SpotInstanceRequests":{ "shape":"SpotInstanceRequestList", "documentation":"

Information about the Spot Instance request.

", "locationName":"spotInstanceRequestSet" } } }, "Reservation":{ "type":"structure", "members":{ "ReservationId":{ "shape":"String", "documentation":"

The ID of the reservation.

", "locationName":"reservationId" }, "OwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that owns the reservation.

", "locationName":"ownerId" }, "RequesterId":{ "shape":"String", "documentation":"

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

", "locationName":"requesterId" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups.

", "locationName":"groupSet" }, "Instances":{ "shape":"InstanceList", "documentation":"

One or more instances.

", "locationName":"instancesSet" } }, "documentation":"

Describes a reservation.

" }, "ReservationList":{ "type":"list", "member":{ "shape":"Reservation", "locationName":"item" } }, "ReservedInstanceLimitPrice":{ "type":"structure", "members":{ "Amount":{ "shape":"Double", "documentation":"

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", "locationName":"amount" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } }, "documentation":"

Describes the limit price of a Reserved Instance offering.

" }, "ReservedInstanceState":{ "type":"string", "enum":[ "payment-pending", "active", "payment-failed", "retired" ] }, "ReservedInstances":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used.

", "locationName":"instanceType" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", "locationName":"availabilityZone" }, "Start":{ "shape":"DateTime", "documentation":"

The date and time the Reserved Instance started.

", "locationName":"start" }, "End":{ "shape":"DateTime", "documentation":"

The time when the Reserved Instance expires.

", "locationName":"end" }, "Duration":{ "shape":"Long", "documentation":"

The duration of the Reserved Instance, in seconds.

", "locationName":"duration" }, "UsagePrice":{ "shape":"Float", "documentation":"

The usage price of the Reserved Instance, per hour.

", "locationName":"usagePrice" }, "FixedPrice":{ "shape":"Float", "documentation":"

The purchase price of the Reserved Instance.

", "locationName":"fixedPrice" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of Reserved Instances purchased.

", "locationName":"instanceCount" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance description.

", "locationName":"productDescription" }, "State":{ "shape":"ReservedInstanceState", "documentation":"

The state of the Reserved Instance purchase.

", "locationName":"state" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the reserved instance.

", "locationName":"instanceTenancy" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type.

", "locationName":"offeringType" }, "RecurringCharges":{ "shape":"RecurringChargesList", "documentation":"

The recurring charge tag assigned to the resource.

", "locationName":"recurringCharges" } }, "documentation":"

Describes a Reserved Instance.

" }, "ReservedInstancesConfiguration":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the modified Reserved Instances.

", "locationName":"availabilityZone" }, "Platform":{ "shape":"String", "documentation":"

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", "locationName":"platform" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of modified Reserved Instances.

", "locationName":"instanceCount" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type for the modified Reserved Instances.

", "locationName":"instanceType" } }, "documentation":"

Describes the configuration settings for the modified Reserved Instances.

" }, "ReservedInstancesConfigurationList":{ "type":"list", "member":{ "shape":"ReservedInstancesConfiguration", "locationName":"item" } }, "ReservedInstancesId":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" } }, "documentation":"

Describes the ID of a Reserved Instance.

" }, "ReservedInstancesIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstancesId" } }, "ReservedInstancesList":{ "type":"list", "member":{ "shape":"ReservedInstances", "locationName":"item" } }, "ReservedInstancesListing":{ "type":"structure", "members":{ "ReservedInstancesListingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance listing.

", "locationName":"reservedInstancesListingId" }, "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The time the listing was created.

", "locationName":"createDate" }, "UpdateDate":{ "shape":"DateTime", "documentation":"

The last modified timestamp of the listing.

", "locationName":"updateDate" }, "Status":{ "shape":"ListingStatus", "documentation":"

The status of the Reserved Instance listing.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The reason for the current status of the Reserved Instance listing. The response can be blank.

", "locationName":"statusMessage" }, "InstanceCounts":{ "shape":"InstanceCountList", "documentation":"

The number of instances in this state.

", "locationName":"instanceCounts" }, "PriceSchedules":{ "shape":"PriceScheduleList", "documentation":"

The price of the Reserved Instance listing.

", "locationName":"priceSchedules" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "ClientToken":{ "shape":"String", "documentation":"

The idempotency token you provided when you created the listing.

", "locationName":"clientToken" } }, "documentation":"

Describes a Reserved Instance listing.

" }, "ReservedInstancesListingList":{ "type":"list", "member":{ "shape":"ReservedInstancesListing", "locationName":"item" } }, "ReservedInstancesModification":{ "type":"structure", "members":{ "ReservedInstancesModificationId":{ "shape":"String", "documentation":"

A unique ID for the Reserved Instance modification.

", "locationName":"reservedInstancesModificationId" }, "ReservedInstancesIds":{ "shape":"ReservedIntancesIds", "documentation":"

The IDs of one or more Reserved Instances.

", "locationName":"reservedInstancesSet" }, "ModificationResults":{ "shape":"ReservedInstancesModificationResultList", "documentation":"

Contains target configurations along with their corresponding new Reserved Instance IDs.

", "locationName":"modificationResultSet" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The time when the modification request was created.

", "locationName":"createDate" }, "UpdateDate":{ "shape":"DateTime", "documentation":"

The time when the modification request was last updated.

", "locationName":"updateDate" }, "EffectiveDate":{ "shape":"DateTime", "documentation":"

The time for the modification to become effective.

", "locationName":"effectiveDate" }, "Status":{ "shape":"String", "documentation":"

The status of the Reserved Instances modification request.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The reason for the status.

", "locationName":"statusMessage" }, "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the modification request is idempotent.

", "locationName":"clientToken" } }, "documentation":"

Describes a Reserved Instance modification.

" }, "ReservedInstancesModificationIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstancesModificationId" } }, "ReservedInstancesModificationList":{ "type":"list", "member":{ "shape":"ReservedInstancesModification", "locationName":"item" } }, "ReservedInstancesModificationResult":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", "locationName":"reservedInstancesId" }, "TargetConfiguration":{ "shape":"ReservedInstancesConfiguration", "documentation":"

The target Reserved Instances configurations supplied as part of the modification request.

", "locationName":"targetConfiguration" } } }, "ReservedInstancesModificationResultList":{ "type":"list", "member":{ "shape":"ReservedInstancesModificationResult", "locationName":"item" } }, "ReservedInstancesOffering":{ "type":"structure", "members":{ "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance offering.

", "locationName":"reservedInstancesOfferingId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used.

", "locationName":"instanceType" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", "locationName":"availabilityZone" }, "Duration":{ "shape":"Long", "documentation":"

The duration of the Reserved Instance, in seconds.

", "locationName":"duration" }, "UsagePrice":{ "shape":"Float", "documentation":"

The usage price of the Reserved Instance, per hour.

", "locationName":"usagePrice" }, "FixedPrice":{ "shape":"Float", "documentation":"

The purchase price of the Reserved Instance.

", "locationName":"fixedPrice" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance description.

", "locationName":"productDescription" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the reserved instance.

", "locationName":"instanceTenancy" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type.

", "locationName":"offeringType" }, "RecurringCharges":{ "shape":"RecurringChargesList", "documentation":"

The recurring charge tag assigned to the resource.

", "locationName":"recurringCharges" }, "Marketplace":{ "shape":"Boolean", "documentation":"

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

", "locationName":"marketplace" }, "PricingDetails":{ "shape":"PricingDetailsList", "documentation":"

The pricing details of the Reserved Instance offering.

", "locationName":"pricingDetailsSet" } }, "documentation":"

Describes a Reserved Instance offering.

" }, "ReservedInstancesOfferingIdStringList":{ "type":"list", "member":{"shape":"String"} }, "ReservedInstancesOfferingList":{ "type":"list", "member":{ "shape":"ReservedInstancesOffering", "locationName":"item" } }, "ReservedIntancesIds":{ "type":"list", "member":{ "shape":"ReservedInstancesId", "locationName":"item" } }, "ResetImageAttributeName":{ "type":"string", "enum":["launchPermission"] }, "ResetImageAttributeRequest":{ "type":"structure", "required":[ "ImageId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"ResetImageAttributeName", "documentation":"

The attribute to reset (currently you can only reset the launch permission attribute).

" } } }, "ResetInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The attribute to reset.

", "locationName":"attribute" } } }, "ResetNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SourceDestCheck":{ "shape":"String", "documentation":"

The source/destination checking attribute. Resets the value to true.

", "locationName":"sourceDestCheck" } } }, "ResetSnapshotAttributeRequest":{ "type":"structure", "required":[ "SnapshotId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The attribute to reset (currently only the attribute for permission to create volumes can be reset).

" } } }, "ResourceIdList":{ "type":"list", "member":{"shape":"String"} }, "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" ] }, "RestorableByStringList":{ "type":"list", "member":{"shape":"String"} }, "RevokeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

", "locationName":"toPort" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

", "locationName":"cidrIp" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"ipPermissions" } } }, "RevokeSecurityGroupIngressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" } } }, "Route":{ "type":"structure", "members":{ "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block used for the destination match.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of a gateway attached to your VPC.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC.

", "locationName":"instanceId" }, "InstanceOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the instance.

", "locationName":"instanceOwnerId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" }, "State":{ "shape":"RouteState", "documentation":"

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

", "locationName":"state" }, "Origin":{ "shape":"RouteOrigin", "documentation":"

Describes how the route was created.

  • CreateRouteTable indicates that route was automatically created when the route table was created.
  • CreateRoute indicates that the route was manually added to the route table.
  • EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
", "locationName":"origin" } }, "documentation":"

Describes a route in a route table.

" }, "RouteList":{ "type":"list", "member":{ "shape":"Route", "locationName":"item" } }, "RouteOrigin":{ "type":"string", "enum":[ "CreateRouteTable", "CreateRoute", "EnableVgwRoutePropagation" ] }, "RouteState":{ "type":"string", "enum":[ "active", "blackhole" ] }, "RouteTable":{ "type":"structure", "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Routes":{ "shape":"RouteList", "documentation":"

The routes in the route table.

", "locationName":"routeSet" }, "Associations":{ "shape":"RouteTableAssociationList", "documentation":"

The associations between the route table and one or more subnets.

", "locationName":"associationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the route table.

", "locationName":"tagSet" }, "PropagatingVgws":{ "shape":"PropagatingVgwList", "documentation":"

Any virtual private gateway (VGW) propagating routes.

", "locationName":"propagatingVgwSet" } }, "documentation":"

Describes a route table.

" }, "RouteTableAssociation":{ "type":"structure", "members":{ "RouteTableAssociationId":{ "shape":"String", "documentation":"

The ID of the association between a route table and a subnet.

", "locationName":"routeTableAssociationId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "Main":{ "shape":"Boolean", "documentation":"

Indicates whether this is the main route table.

", "locationName":"main" } }, "documentation":"

Describes an association between a route table and a subnet.

" }, "RouteTableAssociationList":{ "type":"list", "member":{ "shape":"RouteTableAssociation", "locationName":"item" } }, "RouteTableList":{ "type":"list", "member":{ "shape":"RouteTable", "locationName":"item" } }, "RuleAction":{ "type":"string", "enum":[ "allow", "deny" ] }, "RunInstancesMonitoringEnabled":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Indicates whether monitoring is enabled for the instance.

", "locationName":"enabled" } }, "documentation":"

Describes the monitoring for the instance.

" }, "RunInstancesRequest":{ "type":"structure", "required":[ "ImageId", "MinCount", "MaxCount" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI, which you can get by calling DescribeImages.

" }, "MinCount":{ "shape":"Integer", "documentation":"

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" }, "MaxCount":{ "shape":"Integer", "documentation":"

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you launch an instance without specifying a key pair, you can't connect to the instance.

" }, "SecurityGroups":{ "shape":"SecurityGroupStringList", "documentation":"

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

", "locationName":"SecurityGroup" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdStringList", "documentation":"

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

", "locationName":"SecurityGroupId" }, "UserData":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data for the instances.

" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

" }, "Placement":{ "shape":"Placement", "documentation":"

The placement for the instance.

" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

The block device mapping.

", "locationName":"BlockDeviceMapping" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "documentation":"

The monitoring for the instance.

" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

" }, "DisableApiTermination":{ "shape":"Boolean", "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

", "locationName":"instanceInitiatedShutdownBehavior" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.

Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.

Default: We select an IP address from the IP address range of the subnet.

", "locationName":"privateIpAddress" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Constraints: Maximum 64 ASCII characters

", "locationName":"clientToken" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterface" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

", "locationName":"ebsOptimized" } } }, "S3Storage":{ "type":"structure", "members":{ "Bucket":{ "shape":"String", "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

The beginning of the file name of the AMI.

", "locationName":"prefix" }, "AWSAccessKeyId":{ "shape":"String", "documentation":"

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

" }, "UploadPolicy":{ "shape":"Blob", "documentation":"

A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", "locationName":"uploadPolicy" }, "UploadPolicySignature":{ "shape":"String", "documentation":"

The signature of the Base64 encoded JSON document.

", "locationName":"uploadPolicySignature" } }, "documentation":"

Describes the S3 bucket for an instance store-backed AMI.

" }, "SecurityGroup":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the security group.

", "locationName":"ownerId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "Description":{ "shape":"String", "documentation":"

A description of the security group.

", "locationName":"groupDescription" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

One or more inbound rules associated with the security group.

", "locationName":"ipPermissions" }, "IpPermissionsEgress":{ "shape":"IpPermissionList", "documentation":"

[EC2-VPC] One or more outbound rules associated with the security group.

", "locationName":"ipPermissionsEgress" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC for the security group.

", "locationName":"vpcId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the security group.

", "locationName":"tagSet" } }, "documentation":"

Describes a security group

" }, "SecurityGroupIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroupId" } }, "SecurityGroupList":{ "type":"list", "member":{ "shape":"SecurityGroup", "locationName":"item" } }, "SecurityGroupStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroup" } }, "ShutdownBehavior":{ "type":"string", "enum":[ "stop", "terminate" ] }, "Snapshot":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

", "locationName":"snapshotId" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "State":{ "shape":"SnapshotState", "documentation":"

The snapshot state.

", "locationName":"status" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time stamp when the snapshot was initiated.

", "locationName":"startTime" }, "Progress":{ "shape":"String", "documentation":"

The progress of the snapshot, as a percentage.

", "locationName":"progress" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the Amazon EBS snapshot owner.

", "locationName":"ownerId" }, "Description":{ "shape":"String", "documentation":"

The description for the snapshot.

", "locationName":"description" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

", "locationName":"volumeSize" }, "OwnerAlias":{ "shape":"String", "documentation":"

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

", "locationName":"ownerAlias" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the snapshot.

", "locationName":"tagSet" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the snapshot is encrypted.

", "locationName":"encrypted" } }, "documentation":"

Describes a snapshot.

" }, "SnapshotAttributeName":{ "type":"string", "enum":[ "productCodes", "createVolumePermission" ] }, "SnapshotIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SnapshotId" } }, "SnapshotList":{ "type":"list", "member":{ "shape":"Snapshot", "locationName":"item" } }, "SnapshotState":{ "type":"string", "enum":[ "pending", "completed", "error" ] }, "SpotDatafeedSubscription":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the account.

", "locationName":"ownerId" }, "Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket where the Spot Instance datafeed is located.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

The prefix that is prepended to datafeed files.

", "locationName":"prefix" }, "State":{ "shape":"DatafeedSubscriptionState", "documentation":"

The state of the Spot Instance datafeed subscription.

", "locationName":"state" }, "Fault":{ "shape":"SpotInstanceStateFault", "documentation":"

The fault codes for the Spot Instance request, if any.

", "locationName":"fault" } }, "documentation":"

Describes the datafeed for a Spot Instance.

" }, "SpotInstanceRequest":{ "type":"structure", "members":{ "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot Instance request.

", "locationName":"spotInstanceRequestId" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum hourly price for any Spot Instance launched to fulfill the request.

", "locationName":"spotPrice" }, "Type":{ "shape":"SpotInstanceType", "documentation":"

The Spot Instance request type.

", "locationName":"type" }, "State":{ "shape":"SpotInstanceState", "documentation":"

The state of the Spot Instance request. Spot bid status information can help you track your Spot Instance requests. For information, see Tracking Spot Requests with Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"state" }, "Fault":{ "shape":"SpotInstanceStateFault", "documentation":"

The fault codes for the Spot Instance request, if any.

", "locationName":"fault" }, "Status":{ "shape":"SpotInstanceStatus", "documentation":"

The status code and status message describing the Spot Instance request.

", "locationName":"status" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.

", "locationName":"validUntil" }, "LaunchGroup":{ "shape":"String", "documentation":"

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

", "locationName":"launchGroup" }, "AvailabilityZoneGroup":{ "shape":"String", "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.

", "locationName":"availabilityZoneGroup" }, "LaunchSpecification":{ "shape":"LaunchSpecification", "documentation":"

Additional information for launching instances.

", "locationName":"launchSpecification" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID, if an instance has been launched to fulfill the Spot Instance request.

", "locationName":"instanceId" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The time stamp when the Spot Instance request was created.

", "locationName":"createTime" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The product description associated with the Spot Instance.

", "locationName":"productDescription" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "LaunchedAvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the bid is launched.

", "locationName":"launchedAvailabilityZone" } }, "documentation":"

Describe a Spot Instance request.

" }, "SpotInstanceRequestIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"SpotInstanceRequestId" } }, "SpotInstanceRequestList":{ "type":"list", "member":{ "shape":"SpotInstanceRequest", "locationName":"item" } }, "SpotInstanceState":{ "type":"string", "enum":[ "open", "active", "closed", "cancelled", "failed" ] }, "SpotInstanceStateFault":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The reason code for the Spot Instance state change.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The message for the Spot Instance state change.

", "locationName":"message" } }, "documentation":"

Describes a Spot Instance state change.

" }, "SpotInstanceStatus":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The status code of the request.

", "locationName":"code" }, "UpdateTime":{ "shape":"DateTime", "documentation":"

The time of the most recent status update.

", "locationName":"updateTime" }, "Message":{ "shape":"String", "documentation":"

The description for the status code for the Spot request.

", "locationName":"message" } }, "documentation":"

Describes a Spot Instance request.

" }, "SpotInstanceType":{ "type":"string", "enum":[ "one-time", "persistent" ] }, "SpotPlacement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group (for cluster instances).

", "locationName":"groupName" } }, "documentation":"

Describes Spot Instance placement.

" }, "SpotPrice":{ "type":"structure", "members":{ "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

A general description of the AMI.

", "locationName":"productDescription" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum price you will pay to launch one or more Spot Instances.

", "locationName":"spotPrice" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The date and time the request was created.

", "locationName":"timestamp" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" } }, "documentation":"

Describes the Spot Price.

" }, "SpotPriceHistoryList":{ "type":"list", "member":{ "shape":"SpotPrice", "locationName":"item" } }, "StartInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "DryRun":{ "shape":"Boolean", "locationName":"dryRun" } } }, "StartInstancesResult":{ "type":"structure", "members":{ "StartingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more started instances.

", "locationName":"instancesSet" } } }, "StateReason":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The reason code for the state change.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The message for the state change.

  • Server.SpotInstanceTermination: A Spot Instance was terminated due to an increase in the market price.

  • Server.InternalError: An internal error occurred during instance launch, resulting in termination.

  • Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

  • Client.InternalError: A client error caused the instance to terminate on launch.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The volume limit was exceeded.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

", "locationName":"message" } }, "documentation":"

Describes a state change.

" }, "StatusName":{ "type":"string", "enum":["reachability"] }, "StatusType":{ "type":"string", "enum":[ "passed", "failed", "insufficient-data" ] }, "StopInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" }, "Force":{ "shape":"Boolean", "documentation":"

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

", "locationName":"force" } } }, "StopInstancesResult":{ "type":"structure", "members":{ "StoppingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more stopped instances.

", "locationName":"instancesSet" } } }, "Storage":{ "type":"structure", "members":{ "S3":{ "shape":"S3Storage", "documentation":"

An Amazon S3 storage location.

" } }, "documentation":"

Describes the storage location for an instance store-backed AMI.

" }, "String":{"type":"string"}, "Subnet":{ "type":"structure", "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "State":{ "shape":"SubnetState", "documentation":"

The current state of the subnet.

", "locationName":"state" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC the subnet is in.

", "locationName":"vpcId" }, "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block assigned to the subnet.

", "locationName":"cidrBlock" }, "AvailableIpAddressCount":{ "shape":"Integer", "documentation":"

The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.

", "locationName":"availableIpAddressCount" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the subnet.

", "locationName":"availabilityZone" }, "DefaultForAz":{ "shape":"Boolean", "documentation":"

Indicates whether this is the default subnet for the Availability Zone.

", "locationName":"defaultForAz" }, "MapPublicIpOnLaunch":{ "shape":"Boolean", "documentation":"

Indicates whether instances launched in this subnet receive a public IP address.

", "locationName":"mapPublicIpOnLaunch" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the subnet.

", "locationName":"tagSet" } }, "documentation":"

Describes a subnet.

" }, "SubnetIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SubnetId" } }, "SubnetList":{ "type":"list", "member":{ "shape":"Subnet", "locationName":"item" } }, "SubnetState":{ "type":"string", "enum":[ "pending", "available" ] }, "SummaryStatus":{ "type":"string", "enum":[ "ok", "impaired", "insufficient-data", "not-applicable" ] }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", "locationName":"value" } }, "documentation":"

Describes a tag.

" }, "TagDescription":{ "type":"structure", "members":{ "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource. For example, ami-1a2b3c4d.

", "locationName":"resourceId" }, "ResourceType":{ "shape":"ResourceType", "documentation":"

The type of resource.

", "locationName":"resourceType" }, "Key":{ "shape":"String", "documentation":"

The key of the tag.

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The value of the tag.

", "locationName":"value" } }, "documentation":"

Describes a tag.

" }, "TagDescriptionList":{ "type":"list", "member":{ "shape":"TagDescription", "locationName":"item" } }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"item" } }, "TelemetryStatus":{ "type":"string", "enum":[ "UP", "DOWN" ] }, "Tenancy":{ "type":"string", "enum":[ "default", "dedicated" ] }, "TerminateInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } } }, "TerminateInstancesResult":{ "type":"structure", "members":{ "TerminatingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more terminated instances.

", "locationName":"instancesSet" } } }, "UnassignPrivateIpAddressesRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "PrivateIpAddresses" ], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", "documentation":"

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

", "locationName":"privateIpAddress" } } }, "UnmonitorInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } } }, "UnmonitorInstancesResult":{ "type":"structure", "members":{ "InstanceMonitorings":{ "shape":"InstanceMonitoringList", "documentation":"

Monitoring information for one or more instances.

", "locationName":"instancesSet" } } }, "UserGroupStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"UserGroup" } }, "UserIdGroupPair":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The ID of an AWS account.

", "locationName":"userId" }, "GroupName":{ "shape":"String", "documentation":"

The ID of the security group owned by the specified AWS account.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The name of the security group in the specified AWS account.

", "locationName":"groupId" } }, "documentation":"

Describes a security group and AWS account ID pair for EC2-Classic.

" }, "UserIdGroupPairList":{ "type":"list", "member":{ "shape":"UserIdGroupPair", "locationName":"item" } }, "UserIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"UserId" } }, "ValueStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "VgwTelemetry":{ "type":"structure", "members":{ "OutsideIpAddress":{ "shape":"String", "documentation":"

The Internet-routable IP address of the virtual private gateway's outside interface.

", "locationName":"outsideIpAddress" }, "Status":{ "shape":"TelemetryStatus", "documentation":"

The status of the VPN tunnel.

", "locationName":"status" }, "LastStatusChange":{ "shape":"DateTime", "documentation":"

The date and time of the last change in status.

", "locationName":"lastStatusChange" }, "StatusMessage":{ "shape":"String", "documentation":"

If an error occurs, a description of the error.

", "locationName":"statusMessage" }, "AcceptedRouteCount":{ "shape":"Integer", "documentation":"

The number of accepted routes.

", "locationName":"acceptedRouteCount" } }, "documentation":"

Describes telemetry for a VPN tunnel.

" }, "VgwTelemetryList":{ "type":"list", "member":{ "shape":"VgwTelemetry", "locationName":"item" } }, "VirtualizationType":{ "type":"string", "enum":[ "hvm", "paravirtual" ] }, "Volume":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "Size":{ "shape":"Integer", "documentation":"

The size of the volume, in GiBs.

", "locationName":"size" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot from which the volume was created, if applicable.

", "locationName":"snapshotId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the volume.

", "locationName":"availabilityZone" }, "State":{ "shape":"VolumeState", "documentation":"

The volume state.

", "locationName":"status" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The time stamp when volume creation was initiated.

", "locationName":"createTime" }, "Attachments":{ "shape":"VolumeAttachmentList", "locationName":"attachmentSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the volume.

", "locationName":"tagSet" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

", "locationName":"volumeType" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

", "locationName":"iops" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is encrypted.

", "locationName":"encrypted" } }, "documentation":"

Describes a volume.

" }, "VolumeAttachment":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Device":{ "shape":"String", "documentation":"

The device name.

", "locationName":"device" }, "State":{ "shape":"VolumeAttachmentState", "documentation":"

The attachment state of the volume.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the Amazon EBS volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes volume attachment details.

" }, "VolumeAttachmentList":{ "type":"list", "member":{ "shape":"VolumeAttachment", "locationName":"item" } }, "VolumeAttachmentState":{ "type":"string", "enum":[ "attaching", "attached", "detaching", "detached" ] }, "VolumeAttributeName":{ "type":"string", "enum":[ "autoEnableIO", "productCodes" ] }, "VolumeDetail":{ "type":"structure", "required":["Size"], "members":{ "Size":{ "shape":"Long", "documentation":"

The size of the volume, in GiB.

", "locationName":"size" } }, "documentation":"

Describes an Amazon EBS volume.

" }, "VolumeIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VolumeId" } }, "VolumeList":{ "type":"list", "member":{ "shape":"Volume", "locationName":"item" } }, "VolumeState":{ "type":"string", "enum":[ "creating", "available", "in-use", "deleting", "deleted", "error" ] }, "VolumeStatusAction":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The code identifying the operation, for example, enable-volume-io.

", "locationName":"code" }, "Description":{ "shape":"String", "documentation":"

A description of the operation.

", "locationName":"description" }, "EventType":{ "shape":"String", "documentation":"

The event type associated with this operation.

", "locationName":"eventType" }, "EventId":{ "shape":"String", "documentation":"

The ID of the event associated with this operation.

", "locationName":"eventId" } }, "documentation":"

Describes a volume status operation code.

" }, "VolumeStatusActionsList":{ "type":"list", "member":{ "shape":"VolumeStatusAction", "locationName":"item" } }, "VolumeStatusDetails":{ "type":"structure", "members":{ "Name":{ "shape":"VolumeStatusName", "documentation":"

The name of the volume status.

", "locationName":"name" }, "Status":{ "shape":"String", "documentation":"

The intended status of the volume status.

", "locationName":"status" } }, "documentation":"

Describes a volume status.

" }, "VolumeStatusDetailsList":{ "type":"list", "member":{ "shape":"VolumeStatusDetails", "locationName":"item" } }, "VolumeStatusEvent":{ "type":"structure", "members":{ "EventType":{ "shape":"String", "documentation":"

The type of this event.

", "locationName":"eventType" }, "Description":{ "shape":"String", "documentation":"

A description of the event.

", "locationName":"description" }, "NotBefore":{ "shape":"DateTime", "documentation":"

The earliest start time of the event.

", "locationName":"notBefore" }, "NotAfter":{ "shape":"DateTime", "documentation":"

The latest end time of the event.

", "locationName":"notAfter" }, "EventId":{ "shape":"String", "documentation":"

The ID of this event.

", "locationName":"eventId" } }, "documentation":"

Describes a volume status event.

" }, "VolumeStatusEventsList":{ "type":"list", "member":{ "shape":"VolumeStatusEvent", "locationName":"item" } }, "VolumeStatusInfo":{ "type":"structure", "members":{ "Status":{ "shape":"VolumeStatusInfoStatus", "documentation":"

The status of the volume.

", "locationName":"status" }, "Details":{ "shape":"VolumeStatusDetailsList", "documentation":"

The details of the volume status.

", "locationName":"details" } }, "documentation":"

Describes the status of a volume.

" }, "VolumeStatusInfoStatus":{ "type":"string", "enum":[ "ok", "impaired", "insufficient-data" ] }, "VolumeStatusItem":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

", "locationName":"volumeId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the volume.

", "locationName":"availabilityZone" }, "VolumeStatus":{ "shape":"VolumeStatusInfo", "documentation":"

The volume status.

", "locationName":"volumeStatus" }, "Events":{ "shape":"VolumeStatusEventsList", "documentation":"

A list of events associated with the volume.

", "locationName":"eventsSet" }, "Actions":{ "shape":"VolumeStatusActionsList", "documentation":"

The details of the operation.

", "locationName":"actionsSet" } }, "documentation":"

Describes the volume status.

" }, "VolumeStatusList":{ "type":"list", "member":{ "shape":"VolumeStatusItem", "locationName":"item" } }, "VolumeStatusName":{ "type":"string", "enum":[ "io-enabled", "io-performance" ] }, "VolumeType":{ "type":"string", "enum":[ "standard", "io1", "gp2" ] }, "Vpc":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"VpcState", "documentation":"

The current state of the VPC.

", "locationName":"state" }, "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block for the VPC.

", "locationName":"cidrBlock" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

", "locationName":"dhcpOptionsId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPC.

", "locationName":"tagSet" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The allowed tenancy of instances launched into the VPC.

", "locationName":"instanceTenancy" }, "IsDefault":{ "shape":"Boolean", "documentation":"

Indicates whether the VPC is the default VPC.

", "locationName":"isDefault" } }, "documentation":"

Describes a VPC.

" }, "VpcAttachment":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"AttachmentStatus", "documentation":"

The current state of the attachment.

", "locationName":"state" } }, "documentation":"

Describes an attachment between a virtual private gateway and a VPC.

" }, "VpcAttachmentList":{ "type":"list", "member":{ "shape":"VpcAttachment", "locationName":"item" } }, "VpcAttributeName":{ "type":"string", "enum":[ "enableDnsSupport", "enableDnsHostnames" ] }, "VpcIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcId" } }, "VpcList":{ "type":"list", "member":{ "shape":"Vpc", "locationName":"item" } }, "VpcPeeringConnection":{ "type":"structure", "members":{ "AccepterVpcInfo":{ "shape":"VpcPeeringConnectionVpcInfo", "documentation":"

The information of the peer VPC.

", "locationName":"accepterVpcInfo" }, "ExpirationTime":{ "shape":"DateTime", "documentation":"

The time that an unaccepted VPC peering connection will expire.

", "locationName":"expirationTime" }, "RequesterVpcInfo":{ "shape":"VpcPeeringConnectionVpcInfo", "documentation":"

The information of the requester VPC.

", "locationName":"requesterVpcInfo" }, "Status":{ "shape":"VpcPeeringConnectionStateReason", "documentation":"

The status of the VPC peering connection.

", "locationName":"status" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Describes a VPC peering connection.

" }, "VpcPeeringConnectionList":{ "type":"list", "member":{ "shape":"VpcPeeringConnection", "locationName":"item" } }, "VpcPeeringConnectionStateReason":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The status of the VPC peering connection.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

A message that provides more information about the status, if applicable.

", "locationName":"message" } }, "documentation":"

Describes the status of a VPC peering connection.

" }, "VpcPeeringConnectionVpcInfo":{ "type":"structure", "members":{ "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block for the VPC.

", "locationName":"cidrBlock" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the VPC owner.

", "locationName":"ownerId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Describes a VPC in a VPC peering connection.

" }, "VpcState":{ "type":"string", "enum":[ "pending", "available" ] }, "VpnConnection":{ "type":"structure", "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

", "locationName":"vpnConnectionId" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the VPN connection.

", "locationName":"state" }, "CustomerGatewayConfiguration":{ "shape":"String", "documentation":"

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

", "locationName":"customerGatewayConfiguration" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection.

", "locationName":"type" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway at your end of the VPN connection.

", "locationName":"customerGatewayId" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

", "locationName":"vpnGatewayId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPN connection.

", "locationName":"tagSet" }, "VgwTelemetry":{ "shape":"VgwTelemetryList", "documentation":"

Information about the VPN tunnel.

", "locationName":"vgwTelemetry" }, "Options":{ "shape":"VpnConnectionOptions", "documentation":"

The VPN connection options.

", "locationName":"options" }, "Routes":{ "shape":"VpnStaticRouteList", "documentation":"

The static routes associated with the VPN connection.

", "locationName":"routes" } }, "documentation":"

Describes a VPN connection.

" }, "VpnConnectionIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpnConnectionId" } }, "VpnConnectionList":{ "type":"list", "member":{ "shape":"VpnConnection", "locationName":"item" } }, "VpnConnectionOptions":{ "type":"structure", "members":{ "StaticRoutesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "locationName":"staticRoutesOnly" } }, "documentation":"

Describes VPN connection options.

" }, "VpnConnectionOptionsSpecification":{ "type":"structure", "members":{ "StaticRoutesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "locationName":"staticRoutesOnly" } }, "documentation":"

Describes VPN connection options.

" }, "VpnGateway":{ "type":"structure", "members":{ "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

", "locationName":"vpnGatewayId" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the virtual private gateway.

", "locationName":"state" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection the virtual private gateway supports.

", "locationName":"type" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the virtual private gateway was created.

", "locationName":"availabilityZone" }, "VpcAttachments":{ "shape":"VpcAttachmentList", "documentation":"

Any VPCs attached to the virtual private gateway.

", "locationName":"attachments" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the virtual private gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes a virtual private gateway.

" }, "VpnGatewayIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpnGatewayId" } }, "VpnGatewayList":{ "type":"list", "member":{ "shape":"VpnGateway", "locationName":"item" } }, "VpnState":{ "type":"string", "enum":[ "pending", "available", "deleting", "deleted" ] }, "VpnStaticRoute":{ "type":"structure", "members":{ "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer data center.

", "locationName":"destinationCidrBlock" }, "Source":{ "shape":"VpnStaticRouteSource", "documentation":"

Indicates how the routes were provided.

", "locationName":"source" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the static route.

", "locationName":"state" } }, "documentation":"

Describes a static route for a VPN connection.

" }, "VpnStaticRouteList":{ "type":"list", "member":{ "shape":"VpnStaticRoute", "locationName":"item" } }, "VpnStaticRouteSource":{ "type":"string", "enum":["Static"] }, "ZoneNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ZoneName" } }, "NewDhcpConfigurationList":{ "type":"list", "member":{ "shape":"NewDhcpConfiguration", "locationName":"item" } }, "NewDhcpConfiguration":{ "type":"structure", "members":{ "Key":{ "shape":"String", "locationName":"key" }, "Values":{ "shape":"ValueStringList", "locationName":"Value" } } }, "DhcpConfigurationValueList":{ "type":"list", "member":{ "shape":"AttributeValue", "locationName":"item" } }, "Blob":{"type":"blob"}, "BlobAttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"Blob", "locationName":"value" } } }, "RequestSpotLaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"ValueStringList", "locationName":"SecurityGroup" }, "UserData":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

Default: m1.small

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the Spot Instance.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"NetworkInterface" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" }, "SecurityGroupIds":{ "shape":"ValueStringList", "locationName":"SecurityGroupId" } }, "documentation":"

Describes the launch specification of a Spot Instance.

" } } } botocore-1.5.7/botocore/data/ec2/2016-04-01/0000777454262600001440000000000013042511307020633 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ec2/2016-04-01/waiters-2.json0000666454262600001440000003563313042511306023354 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "InstanceExists": { "delay": 5, "maxAttempts": 40, "operation": "DescribeInstances", "acceptors": [ { "matcher": "path", "expected": true, "argument": "length(Reservations[]) > `0`", "state": "success" }, { "matcher": "error", "expected": "InvalidInstanceID.NotFound", "state": "retry" } ] }, "BundleTaskComplete": { "delay": 15, "operation": "DescribeBundleTasks", "maxAttempts": 40, "acceptors": [ { "expected": "complete", "matcher": "pathAll", "state": "success", "argument": "BundleTasks[].State" }, { "expected": "failed", "matcher": "pathAny", "state": "failure", "argument": "BundleTasks[].State" } ] }, "ConsoleOutputAvailable": { "operation": "GetConsoleOutput", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "path", "argument": "length(Output || '') > `0`", "expected": true } ] }, "ConversionTaskCancelled": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "cancelled", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" } ] }, "ConversionTaskCompleted": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" }, { "expected": "cancelled", "matcher": "pathAny", "state": "failure", "argument": "ConversionTasks[].State" }, { "expected": "cancelling", "matcher": "pathAny", "state": "failure", "argument": "ConversionTasks[].State" } ] }, "ConversionTaskDeleted": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" } ] }, "CustomerGatewayAvailable": { "delay": 15, "operation": "DescribeCustomerGateways", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "CustomerGateways[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "CustomerGateways[].State" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "CustomerGateways[].State" } ] }, "ExportTaskCancelled": { "delay": 15, "operation": "DescribeExportTasks", "maxAttempts": 40, "acceptors": [ { "expected": "cancelled", "matcher": "pathAll", "state": "success", "argument": "ExportTasks[].State" } ] }, "ExportTaskCompleted": { "delay": 15, "operation": "DescribeExportTasks", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "ExportTasks[].State" } ] }, "ImageExists": { "operation": "DescribeImages", "maxAttempts": 40, "delay": 15, "acceptors": [ { "matcher": "path", "expected": true, "argument": "length(Images[]) > `0`", "state": "success" }, { "matcher": "error", "expected": "InvalidAMIID.NotFound", "state": "retry" } ] }, "ImageAvailable": { "operation": "DescribeImages", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "Images[].State", "expected": "available" }, { "state": "failure", "matcher": "pathAny", "argument": "Images[].State", "expected": "failed" } ] }, "InstanceRunning": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "running", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "shutting-down", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "matcher": "error", "expected": "InvalidInstanceID.NotFound", "state": "retry" } ] }, "InstanceStatusOk": { "operation": "DescribeInstanceStatus", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "InstanceStatuses[].InstanceStatus.Status", "expected": "ok" }, { "matcher": "error", "expected": "InvalidInstanceID.NotFound", "state": "retry" } ] }, "InstanceStopped": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "stopped", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "InstanceTerminated": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "terminated", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "KeyPairExists": { "operation": "DescribeKeyPairs", "delay": 5, "maxAttempts": 6, "acceptors": [ { "expected": true, "matcher": "path", "state": "success", "argument": "length(KeyPairs[].KeyName) > `0`" }, { "expected": "InvalidKeyPair.NotFound", "matcher": "error", "state": "retry" } ] }, "NatGatewayAvailable": { "operation": "DescribeNatGateways", "delay": 15, "maxAttempts": 40, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "NatGateways[].State", "expected": "available" }, { "state": "failure", "matcher": "pathAny", "argument": "NatGateways[].State", "expected": "failed" }, { "state": "failure", "matcher": "pathAny", "argument": "NatGateways[].State", "expected": "deleting" }, { "state": "failure", "matcher": "pathAny", "argument": "NatGateways[].State", "expected": "deleted" }, { "state": "retry", "matcher": "error", "expected": "NatGatewayNotFound" } ] }, "NetworkAclExists": { "operation": "DescribeNetworkAcls", "delay": 20, "maxAttempts": 10, "acceptors": [ { "matcher": "path", "expected": true, "argument": "length(NetworkAcls[]) > `0`", "state": "success" }, { "expected": "InvalidNetworkAclID.NotFound", "matcher": "error", "state": "retry" } ] }, "NetworkInterfaceAvailable": { "operation": "DescribeNetworkInterfaces", "delay": 20, "maxAttempts": 10, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "NetworkInterfaces[].Status" }, { "expected": "InvalidNetworkInterfaceID.NotFound", "matcher": "error", "state": "failure" } ] }, "PasswordDataAvailable": { "operation": "GetPasswordData", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "path", "argument": "length(PasswordData) > `0`", "expected": true } ] }, "SnapshotCompleted": { "delay": 15, "operation": "DescribeSnapshots", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "Snapshots[].State" } ] }, "SpotInstanceRequestFulfilled": { "operation": "DescribeSpotInstanceRequests", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "SpotInstanceRequests[].Status.Code", "expected": "fulfilled" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "schedule-expired" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "canceled-before-fulfillment" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "bad-parameters" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "system-error" } ] }, "SubnetAvailable": { "delay": 15, "operation": "DescribeSubnets", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Subnets[].State" } ] }, "SystemStatusOk": { "operation": "DescribeInstanceStatus", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "InstanceStatuses[].SystemStatus.Status", "expected": "ok" } ] }, "VolumeAvailable": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Volumes[].State" } ] }, "VolumeDeleted": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "matcher": "error", "expected": "InvalidVolume.NotFound", "state": "success" } ] }, "VolumeInUse": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "in-use", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Volumes[].State" } ] }, "VpcAvailable": { "delay": 15, "operation": "DescribeVpcs", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Vpcs[].State" } ] }, "VpnConnectionAvailable": { "delay": 60, "operation": "DescribeVpnConnections", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "VpnConnections[].State" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" } ] }, "VpnConnectionDeleted": { "delay": 15, "operation": "DescribeVpnConnections", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "VpnConnections[].State" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" } ] }, "VpcPeeringConnectionExists": { "delay": 15, "operation": "DescribeVpcPeeringConnections", "maxAttempts": 40, "acceptors": [ { "matcher": "status", "expected": 200, "state": "success" }, { "matcher": "error", "expected": "InvalidVpcPeeringConnectionID.NotFound", "state": "retry" } ] } } } botocore-1.5.7/botocore/data/ec2/2016-04-01/paginators-1.json0000666454262600001440000000340113042511306024030 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeInstanceStatus": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "InstanceStatuses" }, "DescribeInstances": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Reservations" }, "DescribeReservedInstancesOfferings": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "ReservedInstancesOfferings" }, "DescribeReservedInstancesModifications": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "ReservedInstancesModifications" }, "DescribeSnapshots": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Snapshots" }, "DescribeSpotFleetRequests": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "SpotFleetRequestConfigs" }, "DescribeSpotPriceHistory": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "SpotPriceHistory" }, "DescribeTags": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Tags" }, "DescribeVolumeStatus": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "VolumeStatuses" }, "DescribeVolumes": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Volumes" } } } botocore-1.5.7/botocore/data/ec2/2016-04-01/service-2.json0000666454262600001440000326322313042511306023337 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-04-01", "endpointPrefix":"ec2", "protocol":"ec2", "serviceAbbreviation":"Amazon EC2", "serviceFullName":"Amazon Elastic Compute Cloud", "signatureVersion":"v4", "xmlNamespace":"http://ec2.amazonaws.com/doc/2016-04-01" }, "operations":{ "AcceptVpcPeeringConnection":{ "name":"AcceptVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, "output":{"shape":"AcceptVpcPeeringConnectionResult"}, "documentation":"

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.

" }, "AllocateAddress":{ "name":"AllocateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AllocateAddressRequest"}, "output":{"shape":"AllocateAddressResult"}, "documentation":"

Acquires an Elastic IP address.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" }, "AllocateHosts":{ "name":"AllocateHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AllocateHostsRequest"}, "output":{"shape":"AllocateHostsResult"}, "documentation":"

Allocates a Dedicated Host to your account. At minimum you need to specify the instance size type, Availability Zone, and quantity of hosts you want to allocate.

" }, "AssignPrivateIpAddresses":{ "name":"AssignPrivateIpAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssignPrivateIpAddressesRequest"}, "documentation":"

Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

AssignPrivateIpAddresses is available only in EC2-VPC.

" }, "AssociateAddress":{ "name":"AssociateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateAddressRequest"}, "output":{"shape":"AssociateAddressResult"}, "documentation":"

Associates an Elastic IP address with an instance or a network interface.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.

" }, "AssociateDhcpOptions":{ "name":"AssociateDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateDhcpOptionsRequest"}, "documentation":"

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "AssociateRouteTable":{ "name":"AssociateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateRouteTableRequest"}, "output":{"shape":"AssociateRouteTableResult"}, "documentation":"

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "AttachClassicLinkVpc":{ "name":"AttachClassicLinkVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachClassicLinkVpcRequest"}, "output":{"shape":"AttachClassicLinkVpcResult"}, "documentation":"

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" }, "AttachInternetGateway":{ "name":"AttachInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachInternetGatewayRequest"}, "documentation":"

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" }, "AttachNetworkInterface":{ "name":"AttachNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachNetworkInterfaceRequest"}, "output":{"shape":"AttachNetworkInterfaceResult"}, "documentation":"

Attaches a network interface to an instance.

" }, "AttachVolume":{ "name":"AttachVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachVolumeRequest"}, "output":{"shape":"VolumeAttachment"}, "documentation":"

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For a list of supported device names, see Attaching an EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.

  • AWS Marketplace product codes are copied from the volume to the instance.

  • You must be subscribed to the product.

  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For an overview of the AWS Marketplace, see Introducing AWS Marketplace.

For more information about EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "AttachVpnGateway":{ "name":"AttachVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachVpnGatewayRequest"}, "output":{"shape":"AttachVpnGatewayResult"}, "documentation":"

Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "AuthorizeSecurityGroupEgress":{ "name":"AuthorizeSecurityGroupEgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, "documentation":"

[EC2-VPC only] Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

You can have up to 50 rules per security group (covering both ingress and egress rules).

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

" }, "AuthorizeSecurityGroupIngress":{ "name":"AuthorizeSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, "documentation":"

Adds one or more ingress rules to a security group.

EC2-Classic: You can have up to 100 rules per group.

EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.

[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.

" }, "BundleInstance":{ "name":"BundleInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BundleInstanceRequest"}, "output":{"shape":"BundleInstanceResult"}, "documentation":"

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

For more information, see Creating an Instance Store-Backed Windows AMI.

" }, "CancelBundleTask":{ "name":"CancelBundleTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelBundleTaskRequest"}, "output":{"shape":"CancelBundleTaskResult"}, "documentation":"

Cancels a bundling operation for an instance store-backed Windows instance.

" }, "CancelConversionTask":{ "name":"CancelConversionTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelConversionRequest"}, "documentation":"

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

" }, "CancelExportTask":{ "name":"CancelExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelExportTaskRequest"}, "documentation":"

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" }, "CancelImportTask":{ "name":"CancelImportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelImportTaskRequest"}, "output":{"shape":"CancelImportTaskResult"}, "documentation":"

Cancels an in-process import virtual machine or import snapshot task.

" }, "CancelReservedInstancesListing":{ "name":"CancelReservedInstancesListing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelReservedInstancesListingRequest"}, "output":{"shape":"CancelReservedInstancesListingResult"}, "documentation":"

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "CancelSpotFleetRequests":{ "name":"CancelSpotFleetRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelSpotFleetRequestsRequest"}, "output":{"shape":"CancelSpotFleetRequestsResponse"}, "documentation":"

Cancels the specified Spot fleet requests.

After you cancel a Spot fleet request, the Spot fleet launches no new Spot instances. You must specify whether the Spot fleet should also terminate its Spot instances. If you terminate the instances, the Spot fleet request enters the cancelled_terminating state. Otherwise, the Spot fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.

" }, "CancelSpotInstanceRequests":{ "name":"CancelSpotInstanceRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelSpotInstanceRequestsRequest"}, "output":{"shape":"CancelSpotInstanceRequestsResult"}, "documentation":"

Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

Canceling a Spot instance request does not terminate running Spot instances associated with the request.

" }, "ConfirmProductInstance":{ "name":"ConfirmProductInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmProductInstanceRequest"}, "output":{"shape":"ConfirmProductInstanceResult"}, "documentation":"

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.

" }, "CopyImage":{ "name":"CopyImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyImageRequest"}, "output":{"shape":"CopyImageResult"}, "documentation":"

Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide.

" }, "CopySnapshot":{ "name":"CopySnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopySnapshotRequest"}, "output":{"shape":"CopySnapshotResult"}, "documentation":"

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the KmsKeyId parameter.

To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.

Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateCustomerGateway":{ "name":"CreateCustomerGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCustomerGatewayRequest"}, "output":{"shape":"CreateCustomerGatewayResult"}, "documentation":"

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.

" }, "CreateDhcpOptions":{ "name":"CreateDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDhcpOptionsRequest"}, "output":{"shape":"CreateDhcpOptionsResult"}, "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. If you want your instance to receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.

  • domain-name - If you're using AmazonProvidedDNS in \"us-east-1\", specify \"ec2.internal\". If you're using AmazonProvidedDNS in another region, specify \"region.compute.internal\" (for example, \"ap-northeast-1.compute.internal\"). Otherwise, specify a domain name (for example, \"MyCompany.com\"). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.

  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.

  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.

  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateFlowLogs":{ "name":"CreateFlowLogs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateFlowLogsRequest"}, "output":{"shape":"CreateFlowLogsResult"}, "documentation":"

Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs.

In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs.

" }, "CreateImage":{ "name":"CreateImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateImageRequest"}, "output":{"shape":"CreateImageResult"}, "documentation":"

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateInstanceExportTask":{ "name":"CreateInstanceExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInstanceExportTaskRequest"}, "output":{"shape":"CreateInstanceExportTaskResult"}, "documentation":"

Exports a running or stopped instance to an S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide.

" }, "CreateInternetGateway":{ "name":"CreateInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInternetGatewayRequest"}, "output":{"shape":"CreateInternetGatewayResult"}, "documentation":"

Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" }, "CreateKeyPair":{ "name":"CreateKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateKeyPairRequest"}, "output":{"shape":"KeyPair"}, "documentation":"

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateNatGateway":{ "name":"CreateNatGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNatGatewayRequest"}, "output":{"shape":"CreateNatGatewayResult"}, "documentation":"

Creates a NAT gateway in the specified subnet. A NAT gateway can be used to enable instances in a private subnet to connect to the Internet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkAcl":{ "name":"CreateNetworkAcl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkAclRequest"}, "output":{"shape":"CreateNetworkAclResult"}, "documentation":"

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkAclEntry":{ "name":"CreateNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkAclEntryRequest"}, "documentation":"

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkInterface":{ "name":"CreateNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkInterfaceRequest"}, "output":{"shape":"CreateNetworkInterfaceResult"}, "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide.

" }, "CreatePlacementGroup":{ "name":"CreatePlacementGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlacementGroupRequest"}, "documentation":"

Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.

For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateReservedInstancesListing":{ "name":"CreateReservedInstancesListing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateReservedInstancesListingRequest"}, "output":{"shape":"CreateReservedInstancesListingResult"}, "documentation":"

Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the DescribeReservedInstances operation.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateRoute":{ "name":"CreateRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRouteRequest"}, "output":{"shape":"CreateRouteResult"}, "documentation":"

Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, or network interface.

When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "CreateRouteTable":{ "name":"CreateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRouteTableRequest"}, "output":{"shape":"CreateRouteTableResult"}, "documentation":"

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "CreateSecurityGroup":{ "name":"CreateSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSecurityGroupRequest"}, "output":{"shape":"CreateSecurityGroupResult"}, "documentation":"

Creates a security group.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

EC2-Classic: You can have up to 500 security groups.

EC2-VPC: You can create up to 500 security groups per VPC.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

" }, "CreateSnapshot":{ "name":"CreateSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSnapshotRequest"}, "output":{"shape":"Snapshot"}, "documentation":"

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateSpotDatafeedSubscription":{ "name":"CreateSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, "documentation":"

Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateSubnet":{ "name":"CreateSubnet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSubnetRequest"}, "output":{"shape":"CreateSubnetResult"}, "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).

AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateTags":{ "name":"CreateTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTagsRequest"}, "documentation":"

Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateVolume":{ "name":"CreateVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVolumeRequest"}, "output":{"shape":"Volume"}, "documentation":"

Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateVpc":{ "name":"CreateVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcRequest"}, "output":{"shape":"CreateVpcResult"}, "documentation":"

Creates a VPC with the specified CIDR block.

The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpcEndpoint":{ "name":"CreateVpcEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcEndpointRequest"}, "output":{"shape":"CreateVpcEndpointResult"}, "documentation":"

Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.

Currently, only endpoints to Amazon S3 are supported.

" }, "CreateVpcPeeringConnection":{ "name":"CreateVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcPeeringConnectionRequest"}, "output":{"shape":"CreateVpcPeeringConnectionResult"}, "documentation":"

Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.

The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.

" }, "CreateVpnConnection":{ "name":"CreateVpnConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnConnectionRequest"}, "output":{"shape":"CreateVpnConnectionResult"}, "documentation":"

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpnConnectionRoute":{ "name":"CreateVpnConnectionRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnConnectionRouteRequest"}, "documentation":"

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpnGateway":{ "name":"CreateVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnGatewayRequest"}, "output":{"shape":"CreateVpnGatewayResult"}, "documentation":"

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DeleteCustomerGateway":{ "name":"DeleteCustomerGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCustomerGatewayRequest"}, "documentation":"

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" }, "DeleteDhcpOptions":{ "name":"DeleteDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDhcpOptionsRequest"}, "documentation":"

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" }, "DeleteFlowLogs":{ "name":"DeleteFlowLogs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteFlowLogsRequest"}, "output":{"shape":"DeleteFlowLogsResult"}, "documentation":"

Deletes one or more flow logs.

" }, "DeleteInternetGateway":{ "name":"DeleteInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteInternetGatewayRequest"}, "documentation":"

Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.

" }, "DeleteKeyPair":{ "name":"DeleteKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteKeyPairRequest"}, "documentation":"

Deletes the specified key pair, by removing the public key from Amazon EC2.

" }, "DeleteNatGateway":{ "name":"DeleteNatGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNatGatewayRequest"}, "output":{"shape":"DeleteNatGatewayResult"}, "documentation":"

Deletes the specified NAT gateway. Deleting a NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.

" }, "DeleteNetworkAcl":{ "name":"DeleteNetworkAcl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkAclRequest"}, "documentation":"

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" }, "DeleteNetworkAclEntry":{ "name":"DeleteNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkAclEntryRequest"}, "documentation":"

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" }, "DeleteNetworkInterface":{ "name":"DeleteNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkInterfaceRequest"}, "documentation":"

Deletes the specified network interface. You must detach the network interface before you can delete it.

" }, "DeletePlacementGroup":{ "name":"DeletePlacementGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePlacementGroupRequest"}, "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteRoute":{ "name":"DeleteRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRouteRequest"}, "documentation":"

Deletes the specified route from the specified route table.

" }, "DeleteRouteTable":{ "name":"DeleteRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRouteTableRequest"}, "documentation":"

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" }, "DeleteSecurityGroup":{ "name":"DeleteSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSecurityGroupRequest"}, "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" }, "DeleteSnapshot":{ "name":"DeleteSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSnapshotRequest"}, "documentation":"

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteSpotDatafeedSubscription":{ "name":"DeleteSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSpotDatafeedSubscriptionRequest"}, "documentation":"

Deletes the data feed for Spot instances.

" }, "DeleteSubnet":{ "name":"DeleteSubnet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSubnetRequest"}, "documentation":"

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsRequest"}, "documentation":"

Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteVolume":{ "name":"DeleteVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVolumeRequest"}, "documentation":"

Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).

The volume may remain in the deleting state for several minutes.

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteVpc":{ "name":"DeleteVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcRequest"}, "documentation":"

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" }, "DeleteVpcEndpoints":{ "name":"DeleteVpcEndpoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcEndpointsRequest"}, "output":{"shape":"DeleteVpcEndpointsResult"}, "documentation":"

Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint.

" }, "DeleteVpcPeeringConnection":{ "name":"DeleteVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, "output":{"shape":"DeleteVpcPeeringConnectionResult"}, "documentation":"

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.

" }, "DeleteVpnConnection":{ "name":"DeleteVpnConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnConnectionRequest"}, "documentation":"

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" }, "DeleteVpnConnectionRoute":{ "name":"DeleteVpnConnectionRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnConnectionRouteRequest"}, "documentation":"

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" }, "DeleteVpnGateway":{ "name":"DeleteVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnGatewayRequest"}, "documentation":"

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" }, "DeregisterImage":{ "name":"DeregisterImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterImageRequest"}, "documentation":"

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

This command does not delete the AMI.

" }, "DescribeAccountAttributes":{ "name":"DescribeAccountAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAccountAttributesRequest"}, "output":{"shape":"DescribeAccountAttributesResult"}, "documentation":"

Describes attributes of your AWS account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: The maximum number of On-Demand instances that you can run.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

" }, "DescribeAddresses":{ "name":"DescribeAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAddressesRequest"}, "output":{"shape":"DescribeAddressesResult"}, "documentation":"

Describes one or more of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeAvailabilityZones":{ "name":"DescribeAvailabilityZones", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAvailabilityZonesRequest"}, "output":{"shape":"DescribeAvailabilityZonesResult"}, "documentation":"

Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeBundleTasks":{ "name":"DescribeBundleTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeBundleTasksRequest"}, "output":{"shape":"DescribeBundleTasksResult"}, "documentation":"

Describes one or more of your bundling tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

" }, "DescribeClassicLinkInstances":{ "name":"DescribeClassicLinkInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClassicLinkInstancesRequest"}, "output":{"shape":"DescribeClassicLinkInstancesResult"}, "documentation":"

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.

" }, "DescribeConversionTasks":{ "name":"DescribeConversionTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConversionTasksRequest"}, "output":{"shape":"DescribeConversionTasksResult"}, "documentation":"

Describes one or more of your conversion tasks. For more information, see the VM Import/Export User Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" }, "DescribeCustomerGateways":{ "name":"DescribeCustomerGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCustomerGatewaysRequest"}, "output":{"shape":"DescribeCustomerGatewaysResult"}, "documentation":"

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeDhcpOptions":{ "name":"DescribeDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDhcpOptionsRequest"}, "output":{"shape":"DescribeDhcpOptionsResult"}, "documentation":"

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeExportTasks":{ "name":"DescribeExportTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeExportTasksRequest"}, "output":{"shape":"DescribeExportTasksResult"}, "documentation":"

Describes one or more of your export tasks.

" }, "DescribeFlowLogs":{ "name":"DescribeFlowLogs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFlowLogsRequest"}, "output":{"shape":"DescribeFlowLogsResult"}, "documentation":"

Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.

" }, "DescribeHostReservationOfferings":{ "name":"DescribeHostReservationOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHostReservationOfferingsRequest"}, "output":{"shape":"DescribeHostReservationOfferingsResult"}, "documentation":"

Describes the Dedicated Host Reservations that are available to purchase.

The results describe all the Dedicated Host Reservation offerings, including offerings that may not match the instance family and region of your Dedicated Hosts. When purchasing an offering, ensure that the the instance family and region of the offering matches that of the Dedicated Host/s it will be associated with. For an overview of supported instance types, see Dedicated Hosts Overview in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeHostReservations":{ "name":"DescribeHostReservations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHostReservationsRequest"}, "output":{"shape":"DescribeHostReservationsResult"}, "documentation":"

Describes Dedicated Host Reservations which are associated with Dedicated Hosts in your account.

" }, "DescribeHosts":{ "name":"DescribeHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHostsRequest"}, "output":{"shape":"DescribeHostsResult"}, "documentation":"

Describes one or more of your Dedicated Hosts.

The results describe only the Dedicated Hosts in the region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released will be listed with the state released.

" }, "DescribeIdFormat":{ "name":"DescribeIdFormat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeIdFormatRequest"}, "output":{"shape":"DescribeIdFormatResult"}, "documentation":"

Describes the ID format settings for your resources on a per-region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.

The following resource types support longer IDs: instance | reservation | snapshot | volume.

These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" }, "DescribeIdentityIdFormat":{ "name":"DescribeIdentityIdFormat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeIdentityIdFormatRequest"}, "output":{"shape":"DescribeIdentityIdFormatResult"}, "documentation":"

Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

The following resource types support longer IDs: instance | reservation | snapshot | volume.

These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.

" }, "DescribeImageAttribute":{ "name":"DescribeImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImageAttributeRequest"}, "output":{"shape":"ImageAttribute"}, "documentation":"

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" }, "DescribeImages":{ "name":"DescribeImages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImagesRequest"}, "output":{"shape":"DescribeImagesResult"}, "documentation":"

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

Deregistered images are included in the returned results for an unspecified interval after deregistration.

" }, "DescribeImportImageTasks":{ "name":"DescribeImportImageTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImportImageTasksRequest"}, "output":{"shape":"DescribeImportImageTasksResult"}, "documentation":"

Displays details about an import virtual machine or import snapshot tasks that are already created.

" }, "DescribeImportSnapshotTasks":{ "name":"DescribeImportSnapshotTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImportSnapshotTasksRequest"}, "output":{"shape":"DescribeImportSnapshotTasksResult"}, "documentation":"

Describes your import snapshot tasks.

" }, "DescribeInstanceAttribute":{ "name":"DescribeInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceAttributeRequest"}, "output":{"shape":"InstanceAttribute"}, "documentation":"

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" }, "DescribeInstanceStatus":{ "name":"DescribeInstanceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceStatusRequest"}, "output":{"shape":"DescribeInstanceStatusResult"}, "documentation":"

Describes the status of one or more instances. By default, only running instances are described, unless specified otherwise.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeInstances":{ "name":"DescribeInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancesRequest"}, "output":{"shape":"DescribeInstancesResult"}, "documentation":"

Describes one or more of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.

" }, "DescribeInternetGateways":{ "name":"DescribeInternetGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInternetGatewaysRequest"}, "output":{"shape":"DescribeInternetGatewaysResult"}, "documentation":"

Describes one or more of your Internet gateways.

" }, "DescribeKeyPairs":{ "name":"DescribeKeyPairs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeKeyPairsRequest"}, "output":{"shape":"DescribeKeyPairsResult"}, "documentation":"

Describes one or more of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeMovingAddresses":{ "name":"DescribeMovingAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMovingAddressesRequest"}, "output":{"shape":"DescribeMovingAddressesResult"}, "documentation":"

Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

" }, "DescribeNatGateways":{ "name":"DescribeNatGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNatGatewaysRequest"}, "output":{"shape":"DescribeNatGatewaysResult"}, "documentation":"

Describes one or more of the your NAT gateways.

" }, "DescribeNetworkAcls":{ "name":"DescribeNetworkAcls", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkAclsRequest"}, "output":{"shape":"DescribeNetworkAclsResult"}, "documentation":"

Describes one or more of your network ACLs.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeNetworkInterfaceAttribute":{ "name":"DescribeNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, "documentation":"

Describes a network interface attribute. You can specify only one attribute at a time.

" }, "DescribeNetworkInterfaces":{ "name":"DescribeNetworkInterfaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkInterfacesRequest"}, "output":{"shape":"DescribeNetworkInterfacesResult"}, "documentation":"

Describes one or more of your network interfaces.

" }, "DescribePlacementGroups":{ "name":"DescribePlacementGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePlacementGroupsRequest"}, "output":{"shape":"DescribePlacementGroupsResult"}, "documentation":"

Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribePrefixLists":{ "name":"DescribePrefixLists", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePrefixListsRequest"}, "output":{"shape":"DescribePrefixListsResult"}, "documentation":"

Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a VPC endpoint.

" }, "DescribeRegions":{ "name":"DescribeRegions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRegionsRequest"}, "output":{"shape":"DescribeRegionsResult"}, "documentation":"

Describes one or more regions that are currently available to you.

For a list of the regions supported by Amazon EC2, see Regions and Endpoints.

" }, "DescribeReservedInstances":{ "name":"DescribeReservedInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesRequest"}, "output":{"shape":"DescribeReservedInstancesResult"}, "documentation":"

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesListings":{ "name":"DescribeReservedInstancesListings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesListingsRequest"}, "output":{"shape":"DescribeReservedInstancesListingsResult"}, "documentation":"

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesModifications":{ "name":"DescribeReservedInstancesModifications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, "output":{"shape":"DescribeReservedInstancesModificationsResult"}, "documentation":"

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesOfferings":{ "name":"DescribeReservedInstancesOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, "documentation":"

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeRouteTables":{ "name":"DescribeRouteTables", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRouteTablesRequest"}, "output":{"shape":"DescribeRouteTablesResult"}, "documentation":"

Describes one or more of your route tables.

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeScheduledInstanceAvailability":{ "name":"DescribeScheduledInstanceAvailability", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeScheduledInstanceAvailabilityRequest"}, "output":{"shape":"DescribeScheduledInstanceAvailabilityResult"}, "documentation":"

Finds available schedules that meet the specified criteria.

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.

" }, "DescribeScheduledInstances":{ "name":"DescribeScheduledInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeScheduledInstancesRequest"}, "output":{"shape":"DescribeScheduledInstancesResult"}, "documentation":"

Describes one or more of your Scheduled Instances.

" }, "DescribeSecurityGroupReferences":{ "name":"DescribeSecurityGroupReferences", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSecurityGroupReferencesRequest"}, "output":{"shape":"DescribeSecurityGroupReferencesResult"}, "documentation":"

[EC2-VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.

" }, "DescribeSecurityGroups":{ "name":"DescribeSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSecurityGroupsRequest"}, "output":{"shape":"DescribeSecurityGroupsResult"}, "documentation":"

Describes one or more of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeSnapshotAttribute":{ "name":"DescribeSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotAttributeRequest"}, "output":{"shape":"DescribeSnapshotAttributeResult"}, "documentation":"

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSnapshots":{ "name":"DescribeSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotsRequest"}, "output":{"shape":"DescribeSnapshotsResult"}, "documentation":"

Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.

  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.

  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSpotDatafeedSubscription":{ "name":"DescribeSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, "documentation":"

Describes the data feed for Spot instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSpotFleetInstances":{ "name":"DescribeSpotFleetInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotFleetInstancesRequest"}, "output":{"shape":"DescribeSpotFleetInstancesResponse"}, "documentation":"

Describes the running instances for the specified Spot fleet.

" }, "DescribeSpotFleetRequestHistory":{ "name":"DescribeSpotFleetRequestHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotFleetRequestHistoryRequest"}, "output":{"shape":"DescribeSpotFleetRequestHistoryResponse"}, "documentation":"

Describes the events for the specified Spot fleet request during the specified time.

Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event.

" }, "DescribeSpotFleetRequests":{ "name":"DescribeSpotFleetRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotFleetRequestsRequest"}, "output":{"shape":"DescribeSpotFleetRequestsResponse"}, "documentation":"

Describes your Spot fleet requests.

" }, "DescribeSpotInstanceRequests":{ "name":"DescribeSpotInstanceRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, "output":{"shape":"DescribeSpotInstanceRequestsResult"}, "documentation":"

Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

You can use DescribeSpotInstanceRequests to find a running Spot instance by examining the response. If the status of the Spot instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

" }, "DescribeSpotPriceHistory":{ "name":"DescribeSpotPriceHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotPriceHistoryRequest"}, "output":{"shape":"DescribeSpotPriceHistoryResult"}, "documentation":"

Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see Spot Instance Pricing History in the Amazon Elastic Compute Cloud User Guide.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" }, "DescribeStaleSecurityGroups":{ "name":"DescribeStaleSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStaleSecurityGroupsRequest"}, "output":{"shape":"DescribeStaleSecurityGroupsResult"}, "documentation":"

[EC2-VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.

" }, "DescribeSubnets":{ "name":"DescribeSubnets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSubnetsRequest"}, "output":{"shape":"DescribeSubnetsResult"}, "documentation":"

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsRequest"}, "output":{"shape":"DescribeTagsResult"}, "documentation":"

Describes one or more of the tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVolumeAttribute":{ "name":"DescribeVolumeAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumeAttributeRequest"}, "output":{"shape":"DescribeVolumeAttributeResult"}, "documentation":"

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVolumeStatus":{ "name":"DescribeVolumeStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumeStatusRequest"}, "output":{"shape":"DescribeVolumeStatusResult"}, "documentation":"

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

" }, "DescribeVolumes":{ "name":"DescribeVolumes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumesRequest"}, "output":{"shape":"DescribeVolumesResult"}, "documentation":"

Describes the specified EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVpcAttribute":{ "name":"DescribeVpcAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcAttributeRequest"}, "output":{"shape":"DescribeVpcAttributeResult"}, "documentation":"

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" }, "DescribeVpcClassicLink":{ "name":"DescribeVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcClassicLinkRequest"}, "output":{"shape":"DescribeVpcClassicLinkResult"}, "documentation":"

Describes the ClassicLink status of one or more VPCs.

" }, "DescribeVpcClassicLinkDnsSupport":{ "name":"DescribeVpcClassicLinkDnsSupport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcClassicLinkDnsSupportRequest"}, "output":{"shape":"DescribeVpcClassicLinkDnsSupportResult"}, "documentation":"

Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVpcEndpointServices":{ "name":"DescribeVpcEndpointServices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcEndpointServicesRequest"}, "output":{"shape":"DescribeVpcEndpointServicesResult"}, "documentation":"

Describes all supported AWS services that can be specified when creating a VPC endpoint.

" }, "DescribeVpcEndpoints":{ "name":"DescribeVpcEndpoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcEndpointsRequest"}, "output":{"shape":"DescribeVpcEndpointsResult"}, "documentation":"

Describes one or more of your VPC endpoints.

" }, "DescribeVpcPeeringConnections":{ "name":"DescribeVpcPeeringConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, "documentation":"

Describes one or more of your VPC peering connections.

" }, "DescribeVpcs":{ "name":"DescribeVpcs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcsRequest"}, "output":{"shape":"DescribeVpcsResult"}, "documentation":"

Describes one or more of your VPCs.

" }, "DescribeVpnConnections":{ "name":"DescribeVpnConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpnConnectionsRequest"}, "output":{"shape":"DescribeVpnConnectionsResult"}, "documentation":"

Describes one or more of your VPN connections.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeVpnGateways":{ "name":"DescribeVpnGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpnGatewaysRequest"}, "output":{"shape":"DescribeVpnGatewaysResult"}, "documentation":"

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DetachClassicLinkVpc":{ "name":"DetachClassicLinkVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachClassicLinkVpcRequest"}, "output":{"shape":"DetachClassicLinkVpcResult"}, "documentation":"

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" }, "DetachInternetGateway":{ "name":"DetachInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachInternetGatewayRequest"}, "documentation":"

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.

" }, "DetachNetworkInterface":{ "name":"DetachNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachNetworkInterfaceRequest"}, "documentation":"

Detaches a network interface from an instance.

" }, "DetachVolume":{ "name":"DetachVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachVolumeRequest"}, "output":{"shape":"VolumeAttachment"}, "documentation":"

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "DetachVpnGateway":{ "name":"DetachVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachVpnGatewayRequest"}, "documentation":"

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" }, "DisableVgwRoutePropagation":{ "name":"DisableVgwRoutePropagation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVgwRoutePropagationRequest"}, "documentation":"

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" }, "DisableVpcClassicLink":{ "name":"DisableVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVpcClassicLinkRequest"}, "output":{"shape":"DisableVpcClassicLinkResult"}, "documentation":"

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

" }, "DisableVpcClassicLinkDnsSupport":{ "name":"DisableVpcClassicLinkDnsSupport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVpcClassicLinkDnsSupportRequest"}, "output":{"shape":"DisableVpcClassicLinkDnsSupportResult"}, "documentation":"

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "DisassociateAddress":{ "name":"DisassociateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateAddressRequest"}, "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" }, "DisassociateRouteTable":{ "name":"DisassociateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateRouteTableRequest"}, "documentation":"

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "EnableVgwRoutePropagation":{ "name":"EnableVgwRoutePropagation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVgwRoutePropagationRequest"}, "documentation":"

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" }, "EnableVolumeIO":{ "name":"EnableVolumeIO", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVolumeIORequest"}, "documentation":"

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" }, "EnableVpcClassicLink":{ "name":"EnableVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVpcClassicLinkRequest"}, "output":{"shape":"EnableVpcClassicLinkResult"}, "documentation":"

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "EnableVpcClassicLinkDnsSupport":{ "name":"EnableVpcClassicLinkDnsSupport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVpcClassicLinkDnsSupportRequest"}, "output":{"shape":"EnableVpcClassicLinkDnsSupportResult"}, "documentation":"

Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "GetConsoleOutput":{ "name":"GetConsoleOutput", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetConsoleOutputRequest"}, "output":{"shape":"GetConsoleOutputResult"}, "documentation":"

Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.

For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output includes output from the EC2Config service.

" }, "GetConsoleScreenshot":{ "name":"GetConsoleScreenshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetConsoleScreenshotRequest"}, "output":{"shape":"GetConsoleScreenshotResult"}, "documentation":"

Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.

The returned content is Base64-encoded.

" }, "GetHostReservationPurchasePreview":{ "name":"GetHostReservationPurchasePreview", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetHostReservationPurchasePreviewRequest"}, "output":{"shape":"GetHostReservationPurchasePreviewResult"}, "documentation":"

Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.

This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.

" }, "GetPasswordData":{ "name":"GetPasswordData", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPasswordDataRequest"}, "output":{"shape":"GetPasswordDataResult"}, "documentation":"

Retrieves the encrypted administrator password for an instance running Windows.

The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" }, "ImportImage":{ "name":"ImportImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportImageRequest"}, "output":{"shape":"ImportImageResult"}, "documentation":"

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). For more information, see Importing a VM as an Image Using VM Import/Export in the VM Import/Export User Guide.

" }, "ImportInstance":{ "name":"ImportInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportInstanceRequest"}, "output":{"shape":"ImportInstanceResult"}, "documentation":"

Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" }, "ImportKeyPair":{ "name":"ImportKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportKeyPairRequest"}, "output":{"shape":"ImportKeyPairResult"}, "documentation":"

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "ImportSnapshot":{ "name":"ImportSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportSnapshotRequest"}, "output":{"shape":"ImportSnapshotResult"}, "documentation":"

Imports a disk into an EBS snapshot.

" }, "ImportVolume":{ "name":"ImportVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportVolumeRequest"}, "output":{"shape":"ImportVolumeResult"}, "documentation":"

Creates an import volume task using metadata from the specified disk image.For more information, see Importing Disks to Amazon EBS.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" }, "ModifyHosts":{ "name":"ModifyHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyHostsRequest"}, "output":{"shape":"ModifyHostsResult"}, "documentation":"

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, AWS will place instances that you launch with a tenancy of host, but without targeting a specific host ID, onto any available Dedicated Host in your account which has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID if you want the instance to launch onto a specific host. If no host ID is provided, the instance will be launched onto a suitable host which has auto-placement enabled.

" }, "ModifyIdFormat":{ "name":"ModifyIdFormat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyIdFormatRequest"}, "documentation":"

Modifies the ID format for the specified resource on a per-region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created. The following resource types support longer IDs: instance | reservation | snapshot | volume.

This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" }, "ModifyIdentityIdFormat":{ "name":"ModifyIdentityIdFormat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyIdentityIdFormatRequest"}, "documentation":"

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.

The following resource types support longer IDs: instance | reservation | snapshot | volume. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" }, "ModifyImageAttribute":{ "name":"ModifyImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyImageAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

The SriovNetSupport enhanced networking attribute cannot be changed using this command. Instead, enable SriovNetSupport on an instance and create an AMI from the instance. This will result in an image with SriovNetSupport enabled.

" }, "ModifyInstanceAttribute":{ "name":"ModifyInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyInstanceAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifyInstancePlacement":{ "name":"ModifyInstancePlacement", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyInstancePlacementRequest"}, "output":{"shape":"ModifyInstancePlacementResult"}, "documentation":"

Set the instance affinity value for a specific stopped instance and modify the instance tenancy setting.

Instance affinity is disabled by default. When instance affinity is host and it is not associated with a specific Dedicated Host, the next time it is launched it will automatically be associated with the host it lands on. This relationship will persist if the instance is stopped/started, or rebooted.

You can modify the host ID associated with a stopped instance. If a stopped instance has a new host ID association, the instance will target that host when restarted.

You can modify the tenancy of a stopped instance with a tenancy of host or dedicated.

Affinity, hostID, and tenancy are not required parameters, but at least one of them must be specified in the request. Affinity and tenancy can be modified in the same request, but tenancy can only be modified on instances that are stopped.

" }, "ModifyNetworkInterfaceAttribute":{ "name":"ModifyNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, "documentation":"

Modifies the specified network interface attribute. You can specify only one attribute at a time.

" }, "ModifyReservedInstances":{ "name":"ModifyReservedInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyReservedInstancesRequest"}, "output":{"shape":"ModifyReservedInstancesResult"}, "documentation":"

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifySnapshotAttribute":{ "name":"ModifySnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySnapshotAttributeRequest"}, "documentation":"

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifySpotFleetRequest":{ "name":"ModifySpotFleetRequest", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySpotFleetRequestRequest"}, "output":{"shape":"ModifySpotFleetRequestResponse"}, "documentation":"

Modifies the specified Spot fleet request.

While the Spot fleet request is being modified, it is in the modifying state.

To scale up your Spot fleet, increase its target capacity. The Spot fleet launches the additional Spot instances according to the allocation strategy for the Spot fleet request. If the allocation strategy is lowestPrice, the Spot fleet launches instances using the Spot pool with the lowest price. If the allocation strategy is diversified, the Spot fleet distributes the instances across the Spot pools.

To scale down your Spot fleet, decrease its target capacity. First, the Spot fleet cancels any open bids that exceed the new target capacity. You can request that the Spot fleet terminate Spot instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot fleet terminates the instances with the highest price per unit. If the allocation strategy is diversified, the Spot fleet terminates instances across the Spot pools. Alternatively, you can request that the Spot fleet keep the fleet at its current size, but not replace any Spot instances that are interrupted or that you terminate manually.

" }, "ModifySubnetAttribute":{ "name":"ModifySubnetAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySubnetAttributeRequest"}, "documentation":"

Modifies a subnet attribute.

" }, "ModifyVolumeAttribute":{ "name":"ModifyVolumeAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVolumeAttributeRequest"}, "documentation":"

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" }, "ModifyVpcAttribute":{ "name":"ModifyVpcAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified VPC.

" }, "ModifyVpcEndpoint":{ "name":"ModifyVpcEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcEndpointRequest"}, "output":{"shape":"ModifyVpcEndpointResult"}, "documentation":"

Modifies attributes of a specified VPC endpoint. You can modify the policy associated with the endpoint, and you can add and remove route tables associated with the endpoint.

" }, "ModifyVpcPeeringConnectionOptions":{ "name":"ModifyVpcPeeringConnectionOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcPeeringConnectionOptionsRequest"}, "output":{"shape":"ModifyVpcPeeringConnectionOptionsResult"}, "documentation":"

Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:

  • Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.

  • Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.

  • Enable/disable a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

If the peered VPCs are in different accounts, each owner must initiate a separate request to modify the peering connection options, depending on whether their VPC was the requester or accepter for the VPC peering connection. If the peered VPCs are in the same account, you can modify the requester and accepter options in the same request. To confirm which VPC is the accepter and requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

" }, "MonitorInstances":{ "name":"MonitorInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MonitorInstancesRequest"}, "output":{"shape":"MonitorInstancesResult"}, "documentation":"

Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "MoveAddressToVpc":{ "name":"MoveAddressToVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MoveAddressToVpcRequest"}, "output":{"shape":"MoveAddressToVpcResult"}, "documentation":"

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

" }, "PurchaseHostReservation":{ "name":"PurchaseHostReservation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseHostReservationRequest"}, "output":{"shape":"PurchaseHostReservationResult"}, "documentation":"

Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.

" }, "PurchaseReservedInstancesOffering":{ "name":"PurchaseReservedInstancesOffering", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, "documentation":"

Purchases a Reserved Instance for use with your account. With Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time and pay a lower hourly rate compared to On-Demand instance pricing.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "PurchaseScheduledInstances":{ "name":"PurchaseScheduledInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseScheduledInstancesRequest"}, "output":{"shape":"PurchaseScheduledInstancesResult"}, "documentation":"

Purchases one or more Scheduled Instances with the specified schedule.

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.

After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.

" }, "RebootInstances":{ "name":"RebootInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootInstancesRequest"}, "documentation":"

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "RegisterImage":{ "name":"RegisterImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterImageRequest"}, "output":{"shape":"RegisterImageResult"}, "documentation":"

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide.

Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billingProduct code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure.

Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI.

To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see CreateImage.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

" }, "RejectVpcPeeringConnection":{ "name":"RejectVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RejectVpcPeeringConnectionRequest"}, "output":{"shape":"RejectVpcPeeringConnectionResult"}, "documentation":"

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" }, "ReleaseAddress":{ "name":"ReleaseAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReleaseAddressRequest"}, "documentation":"

Releases the specified Elastic IP address.

After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

" }, "ReleaseHosts":{ "name":"ReleaseHosts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReleaseHostsRequest"}, "output":{"shape":"ReleaseHostsResult"}, "documentation":"

When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, e.g., ModifyHosts. You must stop or terminate all instances on a host before it can be released.

When Dedicated Hosts are released, it make take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated hosts. Try waiting a few minutes, and then try again.

Released hosts will still appear in a DescribeHosts response.

" }, "ReplaceNetworkAclAssociation":{ "name":"ReplaceNetworkAclAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceNetworkAclAssociationRequest"}, "output":{"shape":"ReplaceNetworkAclAssociationResult"}, "documentation":"

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceNetworkAclEntry":{ "name":"ReplaceNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceNetworkAclEntryRequest"}, "documentation":"

Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceRoute":{ "name":"ReplaceRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceRouteRequest"}, "documentation":"

Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, or network interface.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceRouteTableAssociation":{ "name":"ReplaceRouteTableAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceRouteTableAssociationRequest"}, "output":{"shape":"ReplaceRouteTableAssociationResult"}, "documentation":"

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" }, "ReportInstanceStatus":{ "name":"ReportInstanceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReportInstanceStatusRequest"}, "documentation":"

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" }, "RequestSpotFleet":{ "name":"RequestSpotFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RequestSpotFleetRequest"}, "output":{"shape":"RequestSpotFleetResponse"}, "documentation":"

Creates a Spot fleet request.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet.

For more information, see Spot Fleet Requests in the Amazon Elastic Compute Cloud User Guide.

" }, "RequestSpotInstances":{ "name":"RequestSpotInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RequestSpotInstancesRequest"}, "output":{"shape":"RequestSpotInstancesResult"}, "documentation":"

Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

" }, "ResetImageAttribute":{ "name":"ResetImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetImageAttributeRequest"}, "documentation":"

Resets an attribute of an AMI to its default value.

The productCodes attribute can't be reset.

" }, "ResetInstanceAttribute":{ "name":"ResetInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetInstanceAttributeRequest"}, "documentation":"

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.

The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" }, "ResetNetworkInterfaceAttribute":{ "name":"ResetNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetNetworkInterfaceAttributeRequest"}, "documentation":"

Resets a network interface attribute. You can specify only one attribute at a time.

" }, "ResetSnapshotAttribute":{ "name":"ResetSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetSnapshotAttributeRequest"}, "documentation":"

Resets permission settings for the specified snapshot.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "RestoreAddressToClassic":{ "name":"RestoreAddressToClassic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreAddressToClassicRequest"}, "output":{"shape":"RestoreAddressToClassicResult"}, "documentation":"

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

" }, "RevokeSecurityGroupEgress":{ "name":"RevokeSecurityGroupEgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSecurityGroupEgressRequest"}, "documentation":"

[EC2-VPC only] Removes one or more egress rules from a security group for EC2-VPC. This action doesn't apply to security groups for use in EC2-Classic. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" }, "RevokeSecurityGroupIngress":{ "name":"RevokeSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSecurityGroupIngressRequest"}, "documentation":"

Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" }, "RunInstances":{ "name":"RunInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RunInstancesRequest"}, "output":{"shape":"Reservation"}, "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

When you launch an instance, it enters the pending state. After the instance is ready for you, it enters the running state. To check the state of your instance, call DescribeInstances.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

To tag your instance, ensure that it is running as CreateTags requires a resource ID. For more information about tagging, see Tagging Your Amazon EC2 Resources.

If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide.

[EC2-VPC only accounts] If you don't specify a subnet in the request, we choose a default subnet from your default VPC for you.

[EC2-Classic accounts] If you're launching into EC2-Classic and you don't specify an Availability Zone, we choose one for you.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide.

If any of the AMIs have a product code attached for which the user has not subscribed, RunInstances fails.

Some instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, RunInstances fails. For more information, see Instance Types Available Only in a VPC.

For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "RunScheduledInstances":{ "name":"RunScheduledInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RunScheduledInstancesRequest"}, "output":{"shape":"RunScheduledInstancesResult"}, "documentation":"

Launches the specified Scheduled Instances.

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "StartInstances":{ "name":"StartInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartInstancesRequest"}, "output":{"shape":"StartInstancesResult"}, "documentation":"

Starts an Amazon EBS-backed AMI that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "StopInstances":{ "name":"StopInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopInstancesRequest"}, "output":{"shape":"StopInstancesResult"}, "documentation":"

Stops an Amazon EBS-backed instance.

We don't charge hourly usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

You can't start or stop Spot instances, and you can't stop instance store-backed instances.

When you stop an instance, we shut it down. You can restart your instance at any time. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Stopping an instance is different to rebooting or terminating it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "TerminateInstances":{ "name":"TerminateInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateInstancesRequest"}, "output":{"shape":"TerminateInstancesResult"}, "documentation":"

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "UnassignPrivateIpAddresses":{ "name":"UnassignPrivateIpAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnassignPrivateIpAddressesRequest"}, "documentation":"

Unassigns one or more secondary private IP addresses from a network interface.

" }, "UnmonitorInstances":{ "name":"UnmonitorInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnmonitorInstancesRequest"}, "output":{"shape":"UnmonitorInstancesResult"}, "documentation":"

Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" } }, "shapes":{ "AcceptVpcPeeringConnectionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Contains the parameters for AcceptVpcPeeringConnection.

" }, "AcceptVpcPeeringConnectionResult":{ "type":"structure", "members":{ "VpcPeeringConnection":{ "shape":"VpcPeeringConnection", "documentation":"

Information about the VPC peering connection.

", "locationName":"vpcPeeringConnection" } }, "documentation":"

Contains the output of AcceptVpcPeeringConnection.

" }, "AccountAttribute":{ "type":"structure", "members":{ "AttributeName":{ "shape":"String", "documentation":"

The name of the account attribute.

", "locationName":"attributeName" }, "AttributeValues":{ "shape":"AccountAttributeValueList", "documentation":"

One or more values for the account attribute.

", "locationName":"attributeValueSet" } }, "documentation":"

Describes an account attribute.

" }, "AccountAttributeList":{ "type":"list", "member":{ "shape":"AccountAttribute", "locationName":"item" } }, "AccountAttributeName":{ "type":"string", "enum":[ "supported-platforms", "default-vpc" ] }, "AccountAttributeNameStringList":{ "type":"list", "member":{ "shape":"AccountAttributeName", "locationName":"attributeName" } }, "AccountAttributeValue":{ "type":"structure", "members":{ "AttributeValue":{ "shape":"String", "documentation":"

The value of the attribute.

", "locationName":"attributeValue" } }, "documentation":"

Describes a value of an account attribute.

" }, "AccountAttributeValueList":{ "type":"list", "member":{ "shape":"AccountAttributeValue", "locationName":"item" } }, "ActiveInstance":{ "type":"structure", "members":{ "InstanceType":{ "shape":"String", "documentation":"

The instance type.

", "locationName":"instanceType" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot instance request.

", "locationName":"spotInstanceRequestId" } }, "documentation":"

Describes a running instance in a Spot fleet.

" }, "ActiveInstanceSet":{ "type":"list", "member":{ "shape":"ActiveInstance", "locationName":"item" } }, "ActivityStatus":{ "type":"string", "enum":[ "error", "pending_fulfillment", "pending_termination", "fulfilled" ] }, "Address":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance that the address is associated with (if any).

", "locationName":"instanceId" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "AllocationId":{ "shape":"String", "documentation":"

The ID representing the allocation of the address for use with EC2-VPC.

", "locationName":"allocationId" }, "AssociationId":{ "shape":"String", "documentation":"

The ID representing the association of the address with an instance in a VPC.

", "locationName":"associationId" }, "Domain":{ "shape":"DomainType", "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", "locationName":"domain" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "NetworkInterfaceOwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that owns the network interface.

", "locationName":"networkInterfaceOwnerId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address associated with the Elastic IP address.

", "locationName":"privateIpAddress" } }, "documentation":"

Describes an Elastic IP address.

" }, "AddressList":{ "type":"list", "member":{ "shape":"Address", "locationName":"item" } }, "Affinity":{ "type":"string", "enum":[ "default", "host" ] }, "AllocateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Domain":{ "shape":"DomainType", "documentation":"

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" } }, "documentation":"

Contains the parameters for AllocateAddress.

" }, "AllocateAddressResult":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "Domain":{ "shape":"DomainType", "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", "locationName":"domain" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", "locationName":"allocationId" } }, "documentation":"

Contains the output of AllocateAddress.

" }, "AllocateHostsRequest":{ "type":"structure", "required":[ "InstanceType", "Quantity", "AvailabilityZone" ], "members":{ "AutoPlacement":{ "shape":"AutoPlacement", "documentation":"

This is enabled by default. This property allows instances to be automatically placed onto available Dedicated Hosts, when you are launching instances without specifying a host ID.

Default: Enabled

", "locationName":"autoPlacement" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"clientToken" }, "InstanceType":{ "shape":"String", "documentation":"

Specify the instance type that you want your Dedicated Hosts to be configured for. When you specify the instance type, that is the only instance type that you can launch onto that host.

", "locationName":"instanceType" }, "Quantity":{ "shape":"Integer", "documentation":"

The number of Dedicated Hosts you want to allocate to your account with these parameters.

", "locationName":"quantity" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the Dedicated Hosts.

", "locationName":"availabilityZone" } }, "documentation":"

Contains the parameters for AllocateHosts.

" }, "AllocateHostsResult":{ "type":"structure", "members":{ "HostIds":{ "shape":"ResponseHostIdList", "documentation":"

The ID of the allocated Dedicated Host. This is used when you want to launch an instance onto a specific host.

", "locationName":"hostIdSet" } }, "documentation":"

Contains the output of AllocateHosts.

" }, "AllocationIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"AllocationId" } }, "AllocationState":{ "type":"string", "enum":[ "available", "under-assessment", "permanent-failure", "released", "released-permanent-failure" ] }, "AllocationStrategy":{ "type":"string", "enum":[ "lowestPrice", "diversified" ] }, "ArchitectureValues":{ "type":"string", "enum":[ "i386", "x86_64" ] }, "AssignPrivateIpAddressesRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", "locationName":"privateIpAddress" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", "locationName":"secondaryPrivateIpAddressCount" }, "AllowReassignment":{ "shape":"Boolean", "documentation":"

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", "locationName":"allowReassignment" } }, "documentation":"

Contains the parameters for AssignPrivateIpAddresses.

" }, "AssociateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address. This is required for EC2-Classic.

" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

", "locationName":"networkInterfaceId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", "locationName":"privateIpAddress" }, "AllowReassociation":{ "shape":"Boolean", "documentation":"

[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

", "locationName":"allowReassociation" } }, "documentation":"

Contains the parameters for AssociateAddress.

" }, "AssociateAddressResult":{ "type":"structure", "members":{ "AssociationId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", "locationName":"associationId" } }, "documentation":"

Contains the output of AssociateAddress.

" }, "AssociateDhcpOptionsRequest":{ "type":"structure", "required":[ "DhcpOptionsId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for AssociateDhcpOptions.

" }, "AssociateRouteTableRequest":{ "type":"structure", "required":[ "SubnetId", "RouteTableId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" } }, "documentation":"

Contains the parameters for AssociateRouteTable.

" }, "AssociateRouteTableResult":{ "type":"structure", "members":{ "AssociationId":{ "shape":"String", "documentation":"

The route table association ID (needed to disassociate the route table).

", "locationName":"associationId" } }, "documentation":"

Contains the output of AssociateRouteTable.

" }, "AttachClassicLinkVpcRequest":{ "type":"structure", "required":[ "InstanceId", "VpcId", "Groups" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of a ClassicLink-enabled VPC.

", "locationName":"vpcId" }, "Groups":{ "shape":"GroupIdStringList", "documentation":"

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", "locationName":"SecurityGroupId" } }, "documentation":"

Contains the parameters for AttachClassicLinkVpc.

" }, "AttachClassicLinkVpcResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of AttachClassicLinkVpc.

" }, "AttachInternetGatewayRequest":{ "type":"structure", "required":[ "InternetGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for AttachInternetGateway.

" }, "AttachNetworkInterfaceRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "InstanceId", "DeviceIndex" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device for the network interface attachment.

", "locationName":"deviceIndex" } }, "documentation":"

Contains the parameters for AttachNetworkInterface.

" }, "AttachNetworkInterfaceResult":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" } }, "documentation":"

Contains the output of AttachNetworkInterface.

" }, "AttachVolumeRequest":{ "type":"structure", "required":[ "VolumeId", "InstanceId", "Device" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "Device":{ "shape":"String", "documentation":"

The device name to expose to the instance (for example, /dev/sdh or xvdh).

" } }, "documentation":"

Contains the parameters for AttachVolume.

" }, "AttachVpnGatewayRequest":{ "type":"structure", "required":[ "VpnGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for AttachVpnGateway.

" }, "AttachVpnGatewayResult":{ "type":"structure", "members":{ "VpcAttachment":{ "shape":"VpcAttachment", "documentation":"

Information about the attachment.

", "locationName":"attachment" } }, "documentation":"

Contains the output of AttachVpnGateway.

" }, "AttachmentStatus":{ "type":"string", "enum":[ "attaching", "attached", "detaching", "detached" ] }, "AttributeBooleanValue":{ "type":"structure", "members":{ "Value":{ "shape":"Boolean", "documentation":"

The attribute value. The valid values are true or false.

", "locationName":"value" } }, "documentation":"

Describes a value for a resource attribute that is a Boolean value.

" }, "AttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"String", "documentation":"

The attribute value. Note that the value is case-sensitive.

", "locationName":"value" } }, "documentation":"

Describes a value for a resource attribute that is a String.

" }, "AuthorizeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

The name of a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account number for a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", "locationName":"toPort" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.

", "locationName":"cidrIp" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"ipPermissions" } }, "documentation":"

Contains the parameters for AuthorizeSecurityGroupEgress.

" }, "AuthorizeSecurityGroupIngressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a nondefault VPC.

" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.

" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

[EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all traffic. If you specify -1, traffic on all ports is allowed, regardless of any ports you specify.

" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. Can be used to specify multiple rules in a single command.

" } }, "documentation":"

Contains the parameters for AuthorizeSecurityGroupIngress.

" }, "AutoPlacement":{ "type":"string", "enum":[ "on", "off" ] }, "AvailabilityZone":{ "type":"structure", "members":{ "ZoneName":{ "shape":"String", "documentation":"

The name of the Availability Zone.

", "locationName":"zoneName" }, "State":{ "shape":"AvailabilityZoneState", "documentation":"

The state of the Availability Zone.

", "locationName":"zoneState" }, "RegionName":{ "shape":"String", "documentation":"

The name of the region.

", "locationName":"regionName" }, "Messages":{ "shape":"AvailabilityZoneMessageList", "documentation":"

Any messages about the Availability Zone.

", "locationName":"messageSet" } }, "documentation":"

Describes an Availability Zone.

" }, "AvailabilityZoneList":{ "type":"list", "member":{ "shape":"AvailabilityZone", "locationName":"item" } }, "AvailabilityZoneMessage":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

The message about the Availability Zone.

", "locationName":"message" } }, "documentation":"

Describes a message about an Availability Zone.

" }, "AvailabilityZoneMessageList":{ "type":"list", "member":{ "shape":"AvailabilityZoneMessage", "locationName":"item" } }, "AvailabilityZoneState":{ "type":"string", "enum":[ "available", "information", "impaired", "unavailable" ] }, "AvailableCapacity":{ "type":"structure", "members":{ "AvailableInstanceCapacity":{ "shape":"AvailableInstanceCapacityList", "documentation":"

The total number of instances that the Dedicated Host supports.

", "locationName":"availableInstanceCapacity" }, "AvailableVCpus":{ "shape":"Integer", "documentation":"

The number of vCPUs available on the Dedicated Host.

", "locationName":"availableVCpus" } }, "documentation":"

The capacity information for instances launched onto the Dedicated Host.

" }, "AvailableInstanceCapacityList":{ "type":"list", "member":{ "shape":"InstanceCapacity", "locationName":"item" } }, "BatchState":{ "type":"string", "enum":[ "submitted", "active", "cancelled", "failed", "cancelled_running", "cancelled_terminating", "modifying" ] }, "Blob":{"type":"blob"}, "BlobAttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"Blob", "locationName":"value" } } }, "BlockDeviceMapping":{ "type":"structure", "members":{ "VirtualName":{ "shape":"String", "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", "locationName":"virtualName" }, "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsBlockDevice", "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", "locationName":"ebs" }, "NoDevice":{ "shape":"String", "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", "locationName":"noDevice" } }, "documentation":"

Describes a block device mapping.

" }, "BlockDeviceMappingList":{ "type":"list", "member":{ "shape":"BlockDeviceMapping", "locationName":"item" } }, "BlockDeviceMappingRequestList":{ "type":"list", "member":{ "shape":"BlockDeviceMapping", "locationName":"BlockDeviceMapping" } }, "Boolean":{"type":"boolean"}, "BundleIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"BundleId" } }, "BundleInstanceRequest":{ "type":"structure", "required":[ "InstanceId", "Storage" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

" }, "Storage":{ "shape":"Storage", "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" } }, "documentation":"

Contains the parameters for BundleInstance.

" }, "BundleInstanceResult":{ "type":"structure", "members":{ "BundleTask":{ "shape":"BundleTask", "documentation":"

Information about the bundle task.

", "locationName":"bundleInstanceTask" } }, "documentation":"

Contains the output of BundleInstance.

" }, "BundleTask":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance associated with this bundle task.

", "locationName":"instanceId" }, "BundleId":{ "shape":"String", "documentation":"

The ID of the bundle task.

", "locationName":"bundleId" }, "State":{ "shape":"BundleTaskState", "documentation":"

The state of the task.

", "locationName":"state" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time this task started.

", "locationName":"startTime" }, "UpdateTime":{ "shape":"DateTime", "documentation":"

The time of the most recent update for the task.

", "locationName":"updateTime" }, "Storage":{ "shape":"Storage", "documentation":"

The Amazon S3 storage locations.

", "locationName":"storage" }, "Progress":{ "shape":"String", "documentation":"

The level of task completion, as a percent (for example, 20%).

", "locationName":"progress" }, "BundleTaskError":{ "shape":"BundleTaskError", "documentation":"

If the task fails, a description of the error.

", "locationName":"error" } }, "documentation":"

Describes a bundle task.

" }, "BundleTaskError":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The error message.

", "locationName":"message" } }, "documentation":"

Describes an error for BundleInstance.

" }, "BundleTaskList":{ "type":"list", "member":{ "shape":"BundleTask", "locationName":"item" } }, "BundleTaskState":{ "type":"string", "enum":[ "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed" ] }, "CancelBatchErrorCode":{ "type":"string", "enum":[ "fleetRequestIdDoesNotExist", "fleetRequestIdMalformed", "fleetRequestNotInCancellableState", "unexpectedError" ] }, "CancelBundleTaskRequest":{ "type":"structure", "required":["BundleId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "BundleId":{ "shape":"String", "documentation":"

The ID of the bundle task.

" } }, "documentation":"

Contains the parameters for CancelBundleTask.

" }, "CancelBundleTaskResult":{ "type":"structure", "members":{ "BundleTask":{ "shape":"BundleTask", "documentation":"

Information about the bundle task.

", "locationName":"bundleInstanceTask" } }, "documentation":"

Contains the output of CancelBundleTask.

" }, "CancelConversionRequest":{ "type":"structure", "required":["ConversionTaskId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ConversionTaskId":{ "shape":"String", "documentation":"

The ID of the conversion task.

", "locationName":"conversionTaskId" }, "ReasonMessage":{ "shape":"String", "documentation":"

The reason for canceling the conversion task.

", "locationName":"reasonMessage" } }, "documentation":"

Contains the parameters for CancelConversionTask.

" }, "CancelExportTaskRequest":{ "type":"structure", "required":["ExportTaskId"], "members":{ "ExportTaskId":{ "shape":"String", "documentation":"

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", "locationName":"exportTaskId" } }, "documentation":"

Contains the parameters for CancelExportTask.

" }, "CancelImportTaskRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import image or import snapshot task to be canceled.

" }, "CancelReason":{ "shape":"String", "documentation":"

The reason for canceling the task.

" } }, "documentation":"

Contains the parameters for CancelImportTask.

" }, "CancelImportTaskResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the task being canceled.

", "locationName":"importTaskId" }, "State":{ "shape":"String", "documentation":"

The current state of the task being canceled.

", "locationName":"state" }, "PreviousState":{ "shape":"String", "documentation":"

The current state of the task being canceled.

", "locationName":"previousState" } }, "documentation":"

Contains the output for CancelImportTask.

" }, "CancelReservedInstancesListingRequest":{ "type":"structure", "required":["ReservedInstancesListingId"], "members":{ "ReservedInstancesListingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance listing.

", "locationName":"reservedInstancesListingId" } }, "documentation":"

Contains the parameters for CancelReservedInstancesListing.

" }, "CancelReservedInstancesListingResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

The Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } }, "documentation":"

Contains the output of CancelReservedInstancesListing.

" }, "CancelSpotFleetRequestsError":{ "type":"structure", "required":[ "Code", "Message" ], "members":{ "Code":{ "shape":"CancelBatchErrorCode", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The description for the error code.

", "locationName":"message" } }, "documentation":"

Describes a Spot fleet error.

" }, "CancelSpotFleetRequestsErrorItem":{ "type":"structure", "required":[ "SpotFleetRequestId", "Error" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "Error":{ "shape":"CancelSpotFleetRequestsError", "documentation":"

The error.

", "locationName":"error" } }, "documentation":"

Describes a Spot fleet request that was not successfully canceled.

" }, "CancelSpotFleetRequestsErrorSet":{ "type":"list", "member":{ "shape":"CancelSpotFleetRequestsErrorItem", "locationName":"item" } }, "CancelSpotFleetRequestsRequest":{ "type":"structure", "required":[ "SpotFleetRequestIds", "TerminateInstances" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestIds":{ "shape":"ValueStringList", "documentation":"

The IDs of the Spot fleet requests.

", "locationName":"spotFleetRequestId" }, "TerminateInstances":{ "shape":"Boolean", "documentation":"

Indicates whether to terminate instances for a Spot fleet request if it is canceled successfully.

", "locationName":"terminateInstances" } }, "documentation":"

Contains the parameters for CancelSpotFleetRequests.

" }, "CancelSpotFleetRequestsResponse":{ "type":"structure", "members":{ "UnsuccessfulFleetRequests":{ "shape":"CancelSpotFleetRequestsErrorSet", "documentation":"

Information about the Spot fleet requests that are not successfully canceled.

", "locationName":"unsuccessfulFleetRequestSet" }, "SuccessfulFleetRequests":{ "shape":"CancelSpotFleetRequestsSuccessSet", "documentation":"

Information about the Spot fleet requests that are successfully canceled.

", "locationName":"successfulFleetRequestSet" } }, "documentation":"

Contains the output of CancelSpotFleetRequests.

" }, "CancelSpotFleetRequestsSuccessItem":{ "type":"structure", "required":[ "SpotFleetRequestId", "CurrentSpotFleetRequestState", "PreviousSpotFleetRequestState" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "CurrentSpotFleetRequestState":{ "shape":"BatchState", "documentation":"

The current state of the Spot fleet request.

", "locationName":"currentSpotFleetRequestState" }, "PreviousSpotFleetRequestState":{ "shape":"BatchState", "documentation":"

The previous state of the Spot fleet request.

", "locationName":"previousSpotFleetRequestState" } }, "documentation":"

Describes a Spot fleet request that was successfully canceled.

" }, "CancelSpotFleetRequestsSuccessSet":{ "type":"list", "member":{ "shape":"CancelSpotFleetRequestsSuccessItem", "locationName":"item" } }, "CancelSpotInstanceRequestState":{ "type":"string", "enum":[ "active", "open", "closed", "cancelled", "completed" ] }, "CancelSpotInstanceRequestsRequest":{ "type":"structure", "required":["SpotInstanceRequestIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotInstanceRequestIds":{ "shape":"SpotInstanceRequestIdList", "documentation":"

One or more Spot instance request IDs.

", "locationName":"SpotInstanceRequestId" } }, "documentation":"

Contains the parameters for CancelSpotInstanceRequests.

" }, "CancelSpotInstanceRequestsResult":{ "type":"structure", "members":{ "CancelledSpotInstanceRequests":{ "shape":"CancelledSpotInstanceRequestList", "documentation":"

One or more Spot instance requests.

", "locationName":"spotInstanceRequestSet" } }, "documentation":"

Contains the output of CancelSpotInstanceRequests.

" }, "CancelledSpotInstanceRequest":{ "type":"structure", "members":{ "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot instance request.

", "locationName":"spotInstanceRequestId" }, "State":{ "shape":"CancelSpotInstanceRequestState", "documentation":"

The state of the Spot instance request.

", "locationName":"state" } }, "documentation":"

Describes a request to cancel a Spot instance.

" }, "CancelledSpotInstanceRequestList":{ "type":"list", "member":{ "shape":"CancelledSpotInstanceRequest", "locationName":"item" } }, "ClassicLinkDnsSupport":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "ClassicLinkDnsSupported":{ "shape":"Boolean", "documentation":"

Indicates whether ClassicLink DNS support is enabled for the VPC.

", "locationName":"classicLinkDnsSupported" } }, "documentation":"

Describes the ClassicLink DNS support status of a VPC.

" }, "ClassicLinkDnsSupportList":{ "type":"list", "member":{ "shape":"ClassicLinkDnsSupport", "locationName":"item" } }, "ClassicLinkInstance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

A list of security groups.

", "locationName":"groupSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the instance.

", "locationName":"tagSet" } }, "documentation":"

Describes a linked EC2-Classic instance.

" }, "ClassicLinkInstanceList":{ "type":"list", "member":{ "shape":"ClassicLinkInstance", "locationName":"item" } }, "ClientData":{ "type":"structure", "members":{ "UploadStart":{ "shape":"DateTime", "documentation":"

The time that the disk upload starts.

" }, "UploadEnd":{ "shape":"DateTime", "documentation":"

The time that the disk upload ends.

" }, "UploadSize":{ "shape":"Double", "documentation":"

The size of the uploaded disk image, in GiB.

" }, "Comment":{ "shape":"String", "documentation":"

A user-defined comment about the disk upload.

" } }, "documentation":"

Describes the client-specific data.

" }, "ConfirmProductInstanceRequest":{ "type":"structure", "required":[ "ProductCode", "InstanceId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ProductCode":{ "shape":"String", "documentation":"

The product code. This must be a product code that you own.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" } }, "documentation":"

Contains the parameters for ConfirmProductInstance.

" }, "ConfirmProductInstanceResult":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", "locationName":"ownerId" }, "Return":{ "shape":"Boolean", "documentation":"

The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.

", "locationName":"return" } }, "documentation":"

Contains the output of ConfirmProductInstance.

" }, "ContainerFormat":{ "type":"string", "enum":["ova"] }, "ConversionIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "ConversionTask":{ "type":"structure", "required":[ "ConversionTaskId", "State" ], "members":{ "ConversionTaskId":{ "shape":"String", "documentation":"

The ID of the conversion task.

", "locationName":"conversionTaskId" }, "ExpirationTime":{ "shape":"String", "documentation":"

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", "locationName":"expirationTime" }, "ImportInstance":{ "shape":"ImportInstanceTaskDetails", "documentation":"

If the task is for importing an instance, this contains information about the import instance task.

", "locationName":"importInstance" }, "ImportVolume":{ "shape":"ImportVolumeTaskDetails", "documentation":"

If the task is for importing a volume, this contains information about the import volume task.

", "locationName":"importVolume" }, "State":{ "shape":"ConversionTaskState", "documentation":"

The state of the conversion task.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message related to the conversion task.

", "locationName":"statusMessage" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the task.

", "locationName":"tagSet" } }, "documentation":"

Describes a conversion task.

" }, "ConversionTaskState":{ "type":"string", "enum":[ "active", "cancelling", "cancelled", "completed" ] }, "CopyImageRequest":{ "type":"structure", "required":[ "SourceRegion", "SourceImageId", "Name" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SourceRegion":{ "shape":"String", "documentation":"

The name of the region that contains the AMI to copy.

" }, "SourceImageId":{ "shape":"String", "documentation":"

The ID of the AMI to copy.

" }, "Name":{ "shape":"String", "documentation":"

The name of the new AMI in the destination region.

" }, "Description":{ "shape":"String", "documentation":"

A description for the new AMI in the destination region.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

", "locationName":"kmsKeyId" } }, "documentation":"

Contains the parameters for CopyImage.

" }, "CopyImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the new AMI.

", "locationName":"imageId" } }, "documentation":"

Contains the output of CopyImage.

" }, "CopySnapshotRequest":{ "type":"structure", "required":[ "SourceRegion", "SourceSnapshotId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SourceRegion":{ "shape":"String", "documentation":"

The ID of the region that contains the snapshot to be copied.

" }, "SourceSnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot to copy.

" }, "Description":{ "shape":"String", "documentation":"

A description for the EBS snapshot.

" }, "DestinationRegion":{ "shape":"String", "documentation":"

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

", "locationName":"destinationRegion" }, "PresignedUrl":{ "shape":"String", "documentation":"

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", "locationName":"presignedUrl" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the destination snapshot should be encrypted. You can encrypt a copy of an unencrypted snapshot using this flag, but you cannot use it to create an unencrypted copy from an encrypted snapshot. Your default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

", "locationName":"kmsKeyId" } }, "documentation":"

Contains the parameters for CopySnapshot.

" }, "CopySnapshotResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the new snapshot.

", "locationName":"snapshotId" } }, "documentation":"

Contains the output of CopySnapshot.

" }, "CreateCustomerGatewayRequest":{ "type":"structure", "required":[ "Type", "PublicIp", "BgpAsn" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection that this customer gateway supports (ipsec.1).

" }, "PublicIp":{ "shape":"String", "documentation":"

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", "locationName":"IpAddress" }, "BgpAsn":{ "shape":"Integer", "documentation":"

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" } }, "documentation":"

Contains the parameters for CreateCustomerGateway.

" }, "CreateCustomerGatewayResult":{ "type":"structure", "members":{ "CustomerGateway":{ "shape":"CustomerGateway", "documentation":"

Information about the customer gateway.

", "locationName":"customerGateway" } }, "documentation":"

Contains the output of CreateCustomerGateway.

" }, "CreateDhcpOptionsRequest":{ "type":"structure", "required":["DhcpConfigurations"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpConfigurations":{ "shape":"NewDhcpConfigurationList", "documentation":"

A DHCP configuration option.

", "locationName":"dhcpConfiguration" } }, "documentation":"

Contains the parameters for CreateDhcpOptions.

" }, "CreateDhcpOptionsResult":{ "type":"structure", "members":{ "DhcpOptions":{ "shape":"DhcpOptions", "documentation":"

A set of DHCP options.

", "locationName":"dhcpOptions" } }, "documentation":"

Contains the output of CreateDhcpOptions.

" }, "CreateFlowLogsRequest":{ "type":"structure", "required":[ "ResourceIds", "ResourceType", "TrafficType", "LogGroupName", "DeliverLogsPermissionArn" ], "members":{ "ResourceIds":{ "shape":"ValueStringList", "documentation":"

One or more subnet, network interface, or VPC IDs.

Constraints: Maximum of 1000 resources

", "locationName":"ResourceId" }, "ResourceType":{ "shape":"FlowLogsResourceType", "documentation":"

The type of resource on which to create the flow log.

" }, "TrafficType":{ "shape":"TrafficType", "documentation":"

The type of traffic to log.

" }, "LogGroupName":{ "shape":"String", "documentation":"

The name of the CloudWatch log group.

" }, "DeliverLogsPermissionArn":{ "shape":"String", "documentation":"

The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" } }, "documentation":"

Contains the parameters for CreateFlowLogs.

" }, "CreateFlowLogsResult":{ "type":"structure", "members":{ "FlowLogIds":{ "shape":"ValueStringList", "documentation":"

The IDs of the flow logs.

", "locationName":"flowLogIdSet" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", "locationName":"clientToken" }, "Unsuccessful":{ "shape":"UnsuccessfulItemSet", "documentation":"

Information about the flow logs that could not be created successfully.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of CreateFlowLogs.

" }, "CreateImageRequest":{ "type":"structure", "required":[ "InstanceId", "Name" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Name":{ "shape":"String", "documentation":"

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

A description for the new image.

", "locationName":"description" }, "NoReboot":{ "shape":"Boolean", "documentation":"

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", "locationName":"noReboot" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

Information about one or more block device mappings.

", "locationName":"blockDeviceMapping" } }, "documentation":"

Contains the parameters for CreateImage.

" }, "CreateImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the new AMI.

", "locationName":"imageId" } }, "documentation":"

Contains the output of CreateImage.

" }, "CreateInstanceExportTaskRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "Description":{ "shape":"String", "documentation":"

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", "locationName":"description" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "TargetEnvironment":{ "shape":"ExportEnvironment", "documentation":"

The target virtualization environment.

", "locationName":"targetEnvironment" }, "ExportToS3Task":{ "shape":"ExportToS3TaskSpecification", "documentation":"

The format and location for an instance export task.

", "locationName":"exportToS3" } }, "documentation":"

Contains the parameters for CreateInstanceExportTask.

" }, "CreateInstanceExportTaskResult":{ "type":"structure", "members":{ "ExportTask":{ "shape":"ExportTask", "documentation":"

Information about the instance export task.

", "locationName":"exportTask" } }, "documentation":"

Contains the output for CreateInstanceExportTask.

" }, "CreateInternetGatewayRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for CreateInternetGateway.

" }, "CreateInternetGatewayResult":{ "type":"structure", "members":{ "InternetGateway":{ "shape":"InternetGateway", "documentation":"

Information about the Internet gateway.

", "locationName":"internetGateway" } }, "documentation":"

Contains the output of CreateInternetGateway.

" }, "CreateKeyPairRequest":{ "type":"structure", "required":["KeyName"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" } }, "documentation":"

Contains the parameters for CreateKeyPair.

" }, "CreateNatGatewayRequest":{ "type":"structure", "required":[ "SubnetId", "AllocationId" ], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The subnet in which to create the NAT gateway.

" }, "AllocationId":{ "shape":"String", "documentation":"

The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Constraint: Maximum 64 ASCII characters.

" } }, "documentation":"

Contains the parameters for CreateNatGateway.

" }, "CreateNatGatewayResult":{ "type":"structure", "members":{ "NatGateway":{ "shape":"NatGateway", "documentation":"

Information about the NAT gateway.

", "locationName":"natGateway" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

", "locationName":"clientToken" } }, "documentation":"

Contains the output of CreateNatGateway.

" }, "CreateNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Protocol", "RuleAction", "Egress", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The protocol. A value of -1 means all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.

", "locationName":"Icmp" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", "locationName":"portRange" } }, "documentation":"

Contains the parameters for CreateNetworkAclEntry.

" }, "CreateNetworkAclRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for CreateNetworkAcl.

" }, "CreateNetworkAclResult":{ "type":"structure", "members":{ "NetworkAcl":{ "shape":"NetworkAcl", "documentation":"

Information about the network ACL.

", "locationName":"networkAcl" } }, "documentation":"

Contains the output of CreateNetworkAcl.

" }, "CreateNetworkInterfaceRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet to associate with the network interface.

", "locationName":"subnetId" }, "Description":{ "shape":"String", "documentation":"

A description for the network interface.

", "locationName":"description" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", "locationName":"privateIpAddress" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

The IDs of one or more security groups.

", "locationName":"SecurityGroupId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", "documentation":"

One or more private IP addresses.

", "locationName":"privateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"secondaryPrivateIpAddressCount" }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for CreateNetworkInterface.

" }, "CreateNetworkInterfaceResult":{ "type":"structure", "members":{ "NetworkInterface":{ "shape":"NetworkInterface", "documentation":"

Information about the network interface.

", "locationName":"networkInterface" } }, "documentation":"

Contains the output of CreateNetworkInterface.

" }, "CreatePlacementGroupRequest":{ "type":"structure", "required":[ "GroupName", "Strategy" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

A name for the placement group.

Constraints: Up to 255 ASCII characters

", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"

The placement strategy.

", "locationName":"strategy" } }, "documentation":"

Contains the parameters for CreatePlacementGroup.

" }, "CreateReservedInstancesListingRequest":{ "type":"structure", "required":[ "ReservedInstancesId", "InstanceCount", "PriceSchedules", "ClientToken" ], "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the active Reserved Instance.

", "locationName":"reservedInstancesId" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", "locationName":"instanceCount" }, "PriceSchedules":{ "shape":"PriceScheduleSpecificationList", "documentation":"

A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.

", "locationName":"priceSchedules" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Contains the parameters for CreateReservedInstancesListing.

" }, "CreateReservedInstancesListingResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

Information about the Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } }, "documentation":"

Contains the output of CreateReservedInstancesListing.

" }, "CreateRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table for the route.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of an Internet gateway or virtual private gateway attached to your VPC.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", "locationName":"instanceId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of a network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of a VPC peering connection.

", "locationName":"vpcPeeringConnectionId" }, "NatGatewayId":{ "shape":"String", "documentation":"

The ID of a NAT gateway.

", "locationName":"natGatewayId" } }, "documentation":"

Contains the parameters for CreateRoute.

" }, "CreateRouteResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of CreateRoute.

" }, "CreateRouteTableRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for CreateRouteTable.

" }, "CreateRouteTableResult":{ "type":"structure", "members":{ "RouteTable":{ "shape":"RouteTable", "documentation":"

Information about the route table.

", "locationName":"routeTable" } }, "documentation":"

Contains the output of CreateRouteTable.

" }, "CreateSecurityGroupRequest":{ "type":"structure", "required":[ "GroupName", "Description" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

" }, "Description":{ "shape":"String", "documentation":"

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", "locationName":"GroupDescription" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" } }, "documentation":"

Contains the parameters for CreateSecurityGroup.

" }, "CreateSecurityGroupResult":{ "type":"structure", "members":{ "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } }, "documentation":"

Contains the output of CreateSecurityGroup.

" }, "CreateSnapshotRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume.

" }, "Description":{ "shape":"String", "documentation":"

A description for the snapshot.

" } }, "documentation":"

Contains the parameters for CreateSnapshot.

" }, "CreateSpotDatafeedSubscriptionRequest":{ "type":"structure", "required":["Bucket"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket in which to store the Spot instance data feed.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

A prefix for the data feed file names.

", "locationName":"prefix" } }, "documentation":"

Contains the parameters for CreateSpotDatafeedSubscription.

" }, "CreateSpotDatafeedSubscriptionResult":{ "type":"structure", "members":{ "SpotDatafeedSubscription":{ "shape":"SpotDatafeedSubscription", "documentation":"

The Spot instance data feed subscription.

", "locationName":"spotDatafeedSubscription" } }, "documentation":"

Contains the output of CreateSpotDatafeedSubscription.

" }, "CreateSubnetRequest":{ "type":"structure", "required":[ "VpcId", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the subnet.

Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.

" } }, "documentation":"

Contains the parameters for CreateSubnet.

" }, "CreateSubnetResult":{ "type":"structure", "members":{ "Subnet":{ "shape":"Subnet", "documentation":"

Information about the subnet.

", "locationName":"subnet" } }, "documentation":"

Contains the output of CreateSubnet.

" }, "CreateTagsRequest":{ "type":"structure", "required":[ "Resources", "Tags" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Resources":{ "shape":"ResourceIdList", "documentation":"

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

", "locationName":"ResourceId" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", "locationName":"Tag" } }, "documentation":"

Contains the parameters for CreateTags.

" }, "CreateVolumePermission":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

", "locationName":"userId" }, "Group":{ "shape":"PermissionGroup", "documentation":"

The specific group that is to be added or removed from a volume's list of create volume permissions.

", "locationName":"group" } }, "documentation":"

Describes the user or group to be added or removed from the permissions for a volume.

" }, "CreateVolumePermissionList":{ "type":"list", "member":{ "shape":"CreateVolumePermission", "locationName":"item" } }, "CreateVolumePermissionModifications":{ "type":"structure", "members":{ "Add":{ "shape":"CreateVolumePermissionList", "documentation":"

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

" }, "Remove":{ "shape":"CreateVolumePermissionList", "documentation":"

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

" } }, "documentation":"

Describes modifications to the permissions for a volume.

" }, "CreateVolumeRequest":{ "type":"structure", "required":["AvailabilityZone"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Size":{ "shape":"Integer", "documentation":"

The size of the volume, in GiBs.

Constraints: 1-16384 for gp2, 4-16384 for io1, 500-16384 for st1, 500-16384 for sc1, and 1-1024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot from which to create the volume.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: standard

" }, "Iops":{ "shape":"Integer", "documentation":"

Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If a KmsKeyId is specified, the Encrypted flag must also be set.

" } }, "documentation":"

Contains the parameters for CreateVolume.

" }, "CreateVpcEndpointRequest":{ "type":"structure", "required":[ "VpcId", "ServiceName" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC in which the endpoint will be used.

" }, "ServiceName":{ "shape":"String", "documentation":"

The AWS service name, in the form com.amazonaws.region.service . To get a list of available services, use the DescribeVpcEndpointServices request.

" }, "PolicyDocument":{ "shape":"String", "documentation":"

A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs.

", "locationName":"RouteTableId" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" } }, "documentation":"

Contains the parameters for CreateVpcEndpoint.

" }, "CreateVpcEndpointResult":{ "type":"structure", "members":{ "VpcEndpoint":{ "shape":"VpcEndpoint", "documentation":"

Information about the endpoint.

", "locationName":"vpcEndpoint" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", "locationName":"clientToken" } }, "documentation":"

Contains the output of CreateVpcEndpoint.

" }, "CreateVpcPeeringConnectionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the requester VPC.

", "locationName":"vpcId" }, "PeerVpcId":{ "shape":"String", "documentation":"

The ID of the VPC with which you are creating the VPC peering connection.

", "locationName":"peerVpcId" }, "PeerOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

", "locationName":"peerOwnerId" } }, "documentation":"

Contains the parameters for CreateVpcPeeringConnection.

" }, "CreateVpcPeeringConnectionResult":{ "type":"structure", "members":{ "VpcPeeringConnection":{ "shape":"VpcPeeringConnection", "documentation":"

Information about the VPC peering connection.

", "locationName":"vpcPeeringConnection" } }, "documentation":"

Contains the output of CreateVpcPeeringConnection.

" }, "CreateVpcRequest":{ "type":"structure", "required":["CidrBlock"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

", "locationName":"instanceTenancy" } }, "documentation":"

Contains the parameters for CreateVpc.

" }, "CreateVpcResult":{ "type":"structure", "members":{ "Vpc":{ "shape":"Vpc", "documentation":"

Information about the VPC.

", "locationName":"vpc" } }, "documentation":"

Contains the output of CreateVpc.

" }, "CreateVpnConnectionRequest":{ "type":"structure", "required":[ "Type", "CustomerGatewayId", "VpnGatewayId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Type":{ "shape":"String", "documentation":"

The type of VPN connection (ipsec.1).

" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "Options":{ "shape":"VpnConnectionOptionsSpecification", "documentation":"

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

", "locationName":"options" } }, "documentation":"

Contains the parameters for CreateVpnConnection.

" }, "CreateVpnConnectionResult":{ "type":"structure", "members":{ "VpnConnection":{ "shape":"VpnConnection", "documentation":"

Information about the VPN connection.

", "locationName":"vpnConnection" } }, "documentation":"

Contains the output of CreateVpnConnection.

" }, "CreateVpnConnectionRouteRequest":{ "type":"structure", "required":[ "VpnConnectionId", "DestinationCidrBlock" ], "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer network.

" } }, "documentation":"

Contains the parameters for CreateVpnConnectionRoute.

" }, "CreateVpnGatewayRequest":{ "type":"structure", "required":["Type"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection this virtual private gateway supports.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the virtual private gateway.

" } }, "documentation":"

Contains the parameters for CreateVpnGateway.

" }, "CreateVpnGatewayResult":{ "type":"structure", "members":{ "VpnGateway":{ "shape":"VpnGateway", "documentation":"

Information about the virtual private gateway.

", "locationName":"vpnGateway" } }, "documentation":"

Contains the output of CreateVpnGateway.

" }, "CurrencyCodeValues":{ "type":"string", "enum":["USD"] }, "CustomerGateway":{ "type":"structure", "members":{ "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

", "locationName":"customerGatewayId" }, "State":{ "shape":"String", "documentation":"

The current state of the customer gateway (pending | available | deleting | deleted).

", "locationName":"state" }, "Type":{ "shape":"String", "documentation":"

The type of VPN connection the customer gateway supports (ipsec.1).

", "locationName":"type" }, "IpAddress":{ "shape":"String", "documentation":"

The Internet-routable IP address of the customer gateway's outside interface.

", "locationName":"ipAddress" }, "BgpAsn":{ "shape":"String", "documentation":"

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", "locationName":"bgpAsn" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the customer gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes a customer gateway.

" }, "CustomerGatewayIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"CustomerGatewayId" } }, "CustomerGatewayList":{ "type":"list", "member":{ "shape":"CustomerGateway", "locationName":"item" } }, "DatafeedSubscriptionState":{ "type":"string", "enum":[ "Active", "Inactive" ] }, "DateTime":{"type":"timestamp"}, "DeleteCustomerGatewayRequest":{ "type":"structure", "required":["CustomerGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

" } }, "documentation":"

Contains the parameters for DeleteCustomerGateway.

" }, "DeleteDhcpOptionsRequest":{ "type":"structure", "required":["DhcpOptionsId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the DHCP options set.

" } }, "documentation":"

Contains the parameters for DeleteDhcpOptions.

" }, "DeleteFlowLogsRequest":{ "type":"structure", "required":["FlowLogIds"], "members":{ "FlowLogIds":{ "shape":"ValueStringList", "documentation":"

One or more flow log IDs.

", "locationName":"FlowLogId" } }, "documentation":"

Contains the parameters for DeleteFlowLogs.

" }, "DeleteFlowLogsResult":{ "type":"structure", "members":{ "Unsuccessful":{ "shape":"UnsuccessfulItemSet", "documentation":"

Information about the flow logs that could not be deleted successfully.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of DeleteFlowLogs.

" }, "DeleteInternetGatewayRequest":{ "type":"structure", "required":["InternetGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" } }, "documentation":"

Contains the parameters for DeleteInternetGateway.

" }, "DeleteKeyPairRequest":{ "type":"structure", "required":["KeyName"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

" } }, "documentation":"

Contains the parameters for DeleteKeyPair.

" }, "DeleteNatGatewayRequest":{ "type":"structure", "required":["NatGatewayId"], "members":{ "NatGatewayId":{ "shape":"String", "documentation":"

The ID of the NAT gateway.

" } }, "documentation":"

Contains the parameters for DeleteNatGateway.

" }, "DeleteNatGatewayResult":{ "type":"structure", "members":{ "NatGatewayId":{ "shape":"String", "documentation":"

The ID of the NAT gateway.

", "locationName":"natGatewayId" } }, "documentation":"

Contains the output of DeleteNatGateway.

" }, "DeleteNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Egress" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number of the entry to delete.

", "locationName":"ruleNumber" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether the rule is an egress rule.

", "locationName":"egress" } }, "documentation":"

Contains the parameters for DeleteNetworkAclEntry.

" }, "DeleteNetworkAclRequest":{ "type":"structure", "required":["NetworkAclId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" } }, "documentation":"

Contains the parameters for DeleteNetworkAcl.

" }, "DeleteNetworkInterfaceRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" } }, "documentation":"

Contains the parameters for DeleteNetworkInterface.

" }, "DeletePlacementGroupRequest":{ "type":"structure", "required":["GroupName"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

", "locationName":"groupName" } }, "documentation":"

Contains the parameters for DeletePlacementGroup.

" }, "DeleteRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", "locationName":"destinationCidrBlock" } }, "documentation":"

Contains the parameters for DeleteRoute.

" }, "DeleteRouteTableRequest":{ "type":"structure", "required":["RouteTableId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" } }, "documentation":"

Contains the parameters for DeleteRouteTable.

" }, "DeleteSecurityGroupRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a nondefault VPC.

" } }, "documentation":"

Contains the parameters for DeleteSecurityGroup.

" }, "DeleteSnapshotRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot.

" } }, "documentation":"

Contains the parameters for DeleteSnapshot.

" }, "DeleteSpotDatafeedSubscriptionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for DeleteSpotDatafeedSubscription.

" }, "DeleteSubnetRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

" } }, "documentation":"

Contains the parameters for DeleteSubnet.

" }, "DeleteTagsRequest":{ "type":"structure", "required":["Resources"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Resources":{ "shape":"ResourceIdList", "documentation":"

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

", "locationName":"resourceId" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

", "locationName":"tag" } }, "documentation":"

Contains the parameters for DeleteTags.

" }, "DeleteVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" } }, "documentation":"

Contains the parameters for DeleteVolume.

" }, "DeleteVpcEndpointsRequest":{ "type":"structure", "required":["VpcEndpointIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcEndpointIds":{ "shape":"ValueStringList", "documentation":"

One or more endpoint IDs.

", "locationName":"VpcEndpointId" } }, "documentation":"

Contains the parameters for DeleteVpcEndpoints.

" }, "DeleteVpcEndpointsResult":{ "type":"structure", "members":{ "Unsuccessful":{ "shape":"UnsuccessfulItemSet", "documentation":"

Information about the endpoints that were not successfully deleted.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of DeleteVpcEndpoints.

" }, "DeleteVpcPeeringConnectionRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Contains the parameters for DeleteVpcPeeringConnection.

" }, "DeleteVpcPeeringConnectionResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of DeleteVpcPeeringConnection.

" }, "DeleteVpcRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for DeleteVpc.

" }, "DeleteVpnConnectionRequest":{ "type":"structure", "required":["VpnConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" } }, "documentation":"

Contains the parameters for DeleteVpnConnection.

" }, "DeleteVpnConnectionRouteRequest":{ "type":"structure", "required":[ "VpnConnectionId", "DestinationCidrBlock" ], "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer network.

" } }, "documentation":"

Contains the parameters for DeleteVpnConnectionRoute.

" }, "DeleteVpnGatewayRequest":{ "type":"structure", "required":["VpnGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } }, "documentation":"

Contains the parameters for DeleteVpnGateway.

" }, "DeregisterImageRequest":{ "type":"structure", "required":["ImageId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" } }, "documentation":"

Contains the parameters for DeregisterImage.

" }, "DescribeAccountAttributesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AttributeNames":{ "shape":"AccountAttributeNameStringList", "documentation":"

One or more account attribute names.

", "locationName":"attributeName" } }, "documentation":"

Contains the parameters for DescribeAccountAttributes.

" }, "DescribeAccountAttributesResult":{ "type":"structure", "members":{ "AccountAttributes":{ "shape":"AccountAttributeList", "documentation":"

Information about one or more account attributes.

", "locationName":"accountAttributeSet" } }, "documentation":"

Contains the output of DescribeAccountAttributes.

" }, "DescribeAddressesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIps":{ "shape":"PublicIpStringList", "documentation":"

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", "locationName":"PublicIp" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

", "locationName":"Filter" }, "AllocationIds":{ "shape":"AllocationIdList", "documentation":"

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

", "locationName":"AllocationId" } }, "documentation":"

Contains the parameters for DescribeAddresses.

" }, "DescribeAddressesResult":{ "type":"structure", "members":{ "Addresses":{ "shape":"AddressList", "documentation":"

Information about one or more Elastic IP addresses.

", "locationName":"addressesSet" } }, "documentation":"

Contains the output of DescribeAddresses.

" }, "DescribeAvailabilityZonesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ZoneNames":{ "shape":"ZoneNameStringList", "documentation":"

The names of one or more Availability Zones.

", "locationName":"ZoneName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | information | impaired | unavailable).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeAvailabilityZones.

" }, "DescribeAvailabilityZonesResult":{ "type":"structure", "members":{ "AvailabilityZones":{ "shape":"AvailabilityZoneList", "documentation":"

Information about one or more Availability Zones.

", "locationName":"availabilityZoneInfo" } }, "documentation":"

Contains the output of DescribeAvailabiltyZones.

" }, "DescribeBundleTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "BundleIds":{ "shape":"BundleIdStringList", "documentation":"

One or more bundle task IDs.

Default: Describes all your bundle tasks.

", "locationName":"BundleId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeBundleTasks.

" }, "DescribeBundleTasksResult":{ "type":"structure", "members":{ "BundleTasks":{ "shape":"BundleTaskList", "documentation":"

Information about one or more bundle tasks.

", "locationName":"bundleInstanceTasksSet" } }, "documentation":"

Contains the output of DescribeBundleTasks.

" }, "DescribeClassicLinkInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC that the instance is linked to.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeClassicLinkInstances.

" }, "DescribeClassicLinkInstancesResult":{ "type":"structure", "members":{ "Instances":{ "shape":"ClassicLinkInstanceList", "documentation":"

Information about one or more linked EC2-Classic instances.

", "locationName":"instancesSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeClassicLinkInstances.

" }, "DescribeConversionTaskList":{ "type":"list", "member":{ "shape":"ConversionTask", "locationName":"item" } }, "DescribeConversionTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

", "locationName":"filter" }, "ConversionTaskIds":{ "shape":"ConversionIdStringList", "documentation":"

One or more conversion task IDs.

", "locationName":"conversionTaskId" } }, "documentation":"

Contains the parameters for DescribeConversionTasks.

" }, "DescribeConversionTasksResult":{ "type":"structure", "members":{ "ConversionTasks":{ "shape":"DescribeConversionTaskList", "documentation":"

Information about the conversion tasks.

", "locationName":"conversionTasks" } }, "documentation":"

Contains the output for DescribeConversionTasks.

" }, "DescribeCustomerGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "CustomerGatewayIds":{ "shape":"CustomerGatewayIdStringList", "documentation":"

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", "locationName":"CustomerGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeCustomerGateways.

" }, "DescribeCustomerGatewaysResult":{ "type":"structure", "members":{ "CustomerGateways":{ "shape":"CustomerGatewayList", "documentation":"

Information about one or more customer gateways.

", "locationName":"customerGatewaySet" } }, "documentation":"

Contains the output of DescribeCustomerGateways.

" }, "DescribeDhcpOptionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpOptionsIds":{ "shape":"DhcpOptionsIdStringList", "documentation":"

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", "locationName":"DhcpOptionsId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • dhcp-options-id - The ID of a set of DHCP options.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeDhcpOptions.

" }, "DescribeDhcpOptionsResult":{ "type":"structure", "members":{ "DhcpOptions":{ "shape":"DhcpOptionsList", "documentation":"

Information about one or more DHCP options sets.

", "locationName":"dhcpOptionsSet" } }, "documentation":"

Contains the output of DescribeDhcpOptions.

" }, "DescribeExportTasksRequest":{ "type":"structure", "members":{ "ExportTaskIds":{ "shape":"ExportTaskIdStringList", "documentation":"

One or more export task IDs.

", "locationName":"exportTaskId" } }, "documentation":"

Contains the parameters for DescribeExportTasks.

" }, "DescribeExportTasksResult":{ "type":"structure", "members":{ "ExportTasks":{ "shape":"ExportTaskList", "documentation":"

Information about the export tasks.

", "locationName":"exportTaskSet" } }, "documentation":"

Contains the output for DescribeExportTasks.

" }, "DescribeFlowLogsRequest":{ "type":"structure", "members":{ "FlowLogIds":{ "shape":"ValueStringList", "documentation":"

One or more flow log IDs.

", "locationName":"FlowLogId" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

  • flow-log-id - The ID of the flow log.

  • log-group-name - The name of the log group.

  • resource-id - The ID of the VPC, subnet, or network interface.

  • traffic-type - The type of traffic (ACCEPT | REJECT | ALL)

" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the flow log IDs parameter in the same request.

" } }, "documentation":"

Contains the parameters for DescribeFlowLogs.

" }, "DescribeFlowLogsResult":{ "type":"structure", "members":{ "FlowLogs":{ "shape":"FlowLogSet", "documentation":"

Information about the flow logs.

", "locationName":"flowLogSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeFlowLogs.

" }, "DescribeHostReservationOfferingsRequest":{ "type":"structure", "members":{ "OfferingId":{ "shape":"String", "documentation":"

The ID of the reservation offering.

" }, "MinDuration":{ "shape":"Integer", "documentation":"

This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.

" }, "MaxDuration":{ "shape":"Integer", "documentation":"

This is the maximum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.

" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • instance-family - The instance family of the offering (e.g., m4).

  • payment-option - The payment option (No Upfront | Partial Upfront | All Upfront).

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error.

" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results.

" } } }, "DescribeHostReservationOfferingsResult":{ "type":"structure", "members":{ "OfferingSet":{ "shape":"HostOfferingSet", "documentation":"

Information about the offerings.

", "locationName":"offeringSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeHostReservationsRequest":{ "type":"structure", "members":{ "HostReservationIdSet":{ "shape":"HostReservationIdSet", "documentation":"

One or more host reservation IDs.

" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • instance-family - The instance family (e.g., m4).

  • payment-option - The payment option (No Upfront | Partial Upfront | All Upfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | retired).

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error.

" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results.

" } } }, "DescribeHostReservationsResult":{ "type":"structure", "members":{ "HostReservationSet":{ "shape":"HostReservationSet", "documentation":"

Details about the reservation's configuration.

", "locationName":"hostReservationSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeHostsRequest":{ "type":"structure", "members":{ "HostIds":{ "shape":"RequestHostIdList", "documentation":"

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

", "locationName":"hostId" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error. You cannot specify this parameter and the host IDs parameter in the same request.

", "locationName":"maxResults" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • host-reservation-id - The ID of the reservation assigned to this host.

  • client-token - The idempotency token you provided when you launched the instance

  • state- The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • availability-zone - The Availability Zone of the host.

", "locationName":"filter" } }, "documentation":"

Contains the parameters for DescribeHosts.

" }, "DescribeHostsResult":{ "type":"structure", "members":{ "Hosts":{ "shape":"HostList", "documentation":"

Information about the Dedicated Hosts.

", "locationName":"hostSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeHosts.

" }, "DescribeIdFormatRequest":{ "type":"structure", "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource: instance | reservation | snapshot | volume

" } }, "documentation":"

Contains the parameters for DescribeIdFormat.

" }, "DescribeIdFormatResult":{ "type":"structure", "members":{ "Statuses":{ "shape":"IdFormatList", "documentation":"

Information about the ID format for the resource.

", "locationName":"statusSet" } }, "documentation":"

Contains the output of DescribeIdFormat.

" }, "DescribeIdentityIdFormatRequest":{ "type":"structure", "required":["PrincipalArn"], "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource: instance | reservation | snapshot | volume

", "locationName":"resource" }, "PrincipalArn":{ "shape":"String", "documentation":"

The ARN of the principal, which can be an IAM role, IAM user, or the root user.

", "locationName":"principalArn" } }, "documentation":"

Contains the parameters for DescribeIdentityIdFormat.

" }, "DescribeIdentityIdFormatResult":{ "type":"structure", "members":{ "Statuses":{ "shape":"IdFormatList", "documentation":"

Information about the ID format for the resources.

", "locationName":"statusSet" } }, "documentation":"

Contains the output of DescribeIdentityIdFormat.

" }, "DescribeImageAttributeRequest":{ "type":"structure", "required":[ "ImageId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"ImageAttributeName", "documentation":"

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

" } }, "documentation":"

Contains the parameters for DescribeImageAttribute.

" }, "DescribeImagesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageIds":{ "shape":"ImageIdStringList", "documentation":"

One or more image IDs.

Default: Describes all images available to you.

", "locationName":"ImageId" }, "Owners":{ "shape":"OwnerStringList", "documentation":"

Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace | microsoft). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

", "locationName":"Owner" }, "ExecutableUsers":{ "shape":"ExecutableByStringList", "documentation":"

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", "locationName":"ExecutableBy" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • architecture - The image architecture (i386 | x86_64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

  • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

  • description - The description of the image (provided during image creation).

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - String value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeImages.

" }, "DescribeImagesResult":{ "type":"structure", "members":{ "Images":{ "shape":"ImageList", "documentation":"

Information about one or more images.

", "locationName":"imagesSet" } }, "documentation":"

Contains the output of DescribeImages.

" }, "DescribeImportImageTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ImportTaskIds":{ "shape":"ImportTaskIdList", "documentation":"

A list of import image task IDs.

", "locationName":"ImportTaskId" }, "NextToken":{ "shape":"String", "documentation":"

A token that indicates the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" }, "Filters":{ "shape":"FilterList", "documentation":"

Filter tasks using the task-state filter and one of the following values: active, completed, deleting, deleted.

" } }, "documentation":"

Contains the parameters for DescribeImportImageTasks.

" }, "DescribeImportImageTasksResult":{ "type":"structure", "members":{ "ImportImageTasks":{ "shape":"ImportImageTaskList", "documentation":"

A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.

", "locationName":"importImageTaskSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output for DescribeImportImageTasks.

" }, "DescribeImportSnapshotTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ImportTaskIds":{ "shape":"ImportTaskIdList", "documentation":"

A list of import snapshot task IDs.

", "locationName":"ImportTaskId" }, "NextToken":{ "shape":"String", "documentation":"

A token that indicates the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

" } }, "documentation":"

Contains the parameters for DescribeImportSnapshotTasks.

" }, "DescribeImportSnapshotTasksResult":{ "type":"structure", "members":{ "ImportSnapshotTasks":{ "shape":"ImportSnapshotTaskList", "documentation":"

A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.

", "locationName":"importSnapshotTaskSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output for DescribeImportSnapshotTasks.

" }, "DescribeInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The instance attribute.

Note: The enaSupport attribute is not supported at this time.

", "locationName":"attribute" } }, "documentation":"

Contains the parameters for DescribeInstanceAttribute.

" }, "DescribeInstanceStatusRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

" }, "IncludeAllInstances":{ "shape":"Boolean", "documentation":"

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", "locationName":"includeAllInstances" } }, "documentation":"

Contains the parameters for DescribeInstanceStatus.

" }, "DescribeInstanceStatusResult":{ "type":"structure", "members":{ "InstanceStatuses":{ "shape":"InstanceStatusList", "documentation":"

One or more instance status descriptions.

", "locationName":"instanceStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeInstanceStatus.

" }, "DescribeInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Default: Describes all your instances.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • affinity - The affinity setting for an instance running on a Dedicated Host (default | host).

  • architecture - The instance architecture (i386 | x86_64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • host-id - The ID of the Dedicated Host on which the instance is running, if applicable.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IP address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - 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 - The time when the instance was launched.

  • monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.

  • private-dns-name - The private DNS name of the instance.

  • private-ip-address - The private IP address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - 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 - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - 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 - The name of the root device for the instance (for example, /dev/sda1 or /dev/xvda).

  • root-device-type - The type of root device that the instance uses (ebs | instance-store).

  • source-dest-check - 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 - The ID of the Spot instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • tenancy - The tenancy of an instance (dedicated | default | host).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

  • network-interface.description - The description of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface.private-dns-name - The private DNS name of the network interface.

  • network-interface.source-dest-check - 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.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.addresses.private-ip-address - The private IP address associated with the network interface.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to request the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter or tag filters in the same call.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeInstances.

" }, "DescribeInstancesResult":{ "type":"structure", "members":{ "Reservations":{ "shape":"ReservationList", "documentation":"

Zero or more reservations.

", "locationName":"reservationSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeInstances.

" }, "DescribeInternetGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayIds":{ "shape":"ValueStringList", "documentation":"

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

", "locationName":"internetGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeInternetGateways.

" }, "DescribeInternetGatewaysResult":{ "type":"structure", "members":{ "InternetGateways":{ "shape":"InternetGatewayList", "documentation":"

Information about one or more Internet gateways.

", "locationName":"internetGatewaySet" } }, "documentation":"

Contains the output of DescribeInternetGateways.

" }, "DescribeKeyPairsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyNames":{ "shape":"KeyNameStringList", "documentation":"

One or more key pair names.

Default: Describes all your key pairs.

", "locationName":"KeyName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeKeyPairs.

" }, "DescribeKeyPairsResult":{ "type":"structure", "members":{ "KeyPairs":{ "shape":"KeyPairList", "documentation":"

Information about one or more key pairs.

", "locationName":"keySet" } }, "documentation":"

Contains the output of DescribeKeyPairs.

" }, "DescribeMovingAddressesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIps":{ "shape":"ValueStringList", "documentation":"

One or more Elastic IP addresses.

", "locationName":"publicIp" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results.

", "locationName":"nextToken" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).

", "locationName":"filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.

Default: If no value is provided, the default is 1000.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeMovingAddresses.

" }, "DescribeMovingAddressesResult":{ "type":"structure", "members":{ "MovingAddressStatuses":{ "shape":"MovingAddressStatusSet", "documentation":"

The status for each Elastic IP address.

", "locationName":"movingAddressStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeMovingAddresses.

" }, "DescribeNatGatewaysRequest":{ "type":"structure", "members":{ "NatGatewayIds":{ "shape":"ValueStringList", "documentation":"

One or more NAT gateway IDs.

", "locationName":"NatGatewayId" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

  • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" } }, "documentation":"

Contains the parameters for DescribeNatGateways.

" }, "DescribeNatGatewaysResult":{ "type":"structure", "members":{ "NatGateways":{ "shape":"NatGatewayList", "documentation":"

Information about the NAT gateways.

", "locationName":"natGatewaySet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeNatGateways.

" }, "DescribeNetworkAclsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclIds":{ "shape":"ValueStringList", "documentation":"

One or more network ACL IDs.

Default: Describes all your network ACLs.

", "locationName":"NetworkAclId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The CIDR range specified in the entry.

  • entry.egress - Indicates whether the entry applies to egress traffic.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.

  • network-acl-id - The ID of the network ACL.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network ACL.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeNetworkAcls.

" }, "DescribeNetworkAclsResult":{ "type":"structure", "members":{ "NetworkAcls":{ "shape":"NetworkAclList", "documentation":"

Information about one or more network ACLs.

", "locationName":"networkAclSet" } }, "documentation":"

Contains the output of DescribeNetworkAcls.

" }, "DescribeNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Attribute":{ "shape":"NetworkInterfaceAttribute", "documentation":"

The attribute of the network interface.

", "locationName":"attribute" } }, "documentation":"

Contains the parameters for DescribeNetworkInterfaceAttribute.

" }, "DescribeNetworkInterfaceAttributeResult":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Description":{ "shape":"AttributeValue", "documentation":"

The description of the network interface.

", "locationName":"description" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

The security groups associated with the network interface.

", "locationName":"groupSet" }, "Attachment":{ "shape":"NetworkInterfaceAttachment", "documentation":"

The attachment (if any) of the network interface.

", "locationName":"attachment" } }, "documentation":"

Contains the output of DescribeNetworkInterfaceAttribute.

" }, "DescribeNetworkInterfacesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceIds":{ "shape":"NetworkInterfaceIdList", "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", "locationName":"NetworkInterfaceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IP addresses associated with the network interface.

  • addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface.

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.attach.time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.nat-gateway-id - The ID of the NAT gateway to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IP address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-desk-check - 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 - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network interface.

", "locationName":"filter" } }, "documentation":"

Contains the parameters for DescribeNetworkInterfaces.

" }, "DescribeNetworkInterfacesResult":{ "type":"structure", "members":{ "NetworkInterfaces":{ "shape":"NetworkInterfaceList", "documentation":"

Information about one or more network interfaces.

", "locationName":"networkInterfaceSet" } }, "documentation":"

Contains the output of DescribeNetworkInterfaces.

" }, "DescribePlacementGroupsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupNames":{ "shape":"PlacementGroupStringList", "documentation":"

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

", "locationName":"groupName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribePlacementGroups.

" }, "DescribePlacementGroupsResult":{ "type":"structure", "members":{ "PlacementGroups":{ "shape":"PlacementGroupList", "documentation":"

One or more placement groups.

", "locationName":"placementGroupSet" } }, "documentation":"

Contains the output of DescribePlacementGroups.

" }, "DescribePrefixListsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "PrefixListIds":{ "shape":"ValueStringList", "documentation":"

One or more prefix list IDs.

", "locationName":"PrefixListId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • prefix-list-id: The ID of a prefix list.

  • prefix-list-name: The name of a prefix list.

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } }, "documentation":"

Contains the parameters for DescribePrefixLists.

" }, "DescribePrefixListsResult":{ "type":"structure", "members":{ "PrefixLists":{ "shape":"PrefixListSet", "documentation":"

All available prefix lists.

", "locationName":"prefixListSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribePrefixLists.

" }, "DescribeRegionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RegionNames":{ "shape":"RegionNameStringList", "documentation":"

The names of one or more regions.

", "locationName":"RegionName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

  • region-name - The name of the region (for example, us-east-1).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeRegions.

" }, "DescribeRegionsResult":{ "type":"structure", "members":{ "Regions":{ "shape":"RegionList", "documentation":"

Information about one or more regions.

", "locationName":"regionInfo" } }, "documentation":"

Contains the output of DescribeRegions.

" }, "DescribeReservedInstancesListingsRequest":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

One or more Reserved Instance IDs.

", "locationName":"reservedInstancesId" }, "ReservedInstancesListingId":{ "shape":"String", "documentation":"

One or more Reserved Instance listing IDs.

", "locationName":"reservedInstancesListingId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", "locationName":"filters" } }, "documentation":"

Contains the parameters for DescribeReservedInstancesListings.

" }, "DescribeReservedInstancesListingsResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

Information about the Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } }, "documentation":"

Contains the output of DescribeReservedInstancesListings.

" }, "DescribeReservedInstancesModificationsRequest":{ "type":"structure", "members":{ "ReservedInstancesModificationIds":{ "shape":"ReservedInstancesModificationIdStringList", "documentation":"

IDs for the submitted modification request.

", "locationName":"ReservedInstancesModificationId" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeReservedInstancesModifications.

" }, "DescribeReservedInstancesModificationsResult":{ "type":"structure", "members":{ "ReservedInstancesModifications":{ "shape":"ReservedInstancesModificationList", "documentation":"

The Reserved Instance modification information.

", "locationName":"reservedInstancesModificationsSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeReservedInstancesModifications.

" }, "DescribeReservedInstancesOfferingsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ReservedInstancesOfferingIds":{ "shape":"ReservedInstancesOfferingIdStringList", "documentation":"

One or more Reserved Instances offering IDs.

", "locationName":"ReservedInstancesOfferingId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", "locationName":"Filter" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

Default: default

", "locationName":"instanceTenancy" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", "locationName":"offeringType" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

", "locationName":"maxResults" }, "IncludeMarketplace":{ "shape":"Boolean", "documentation":"

Include Reserved Instance Marketplace offerings in the response.

" }, "MinDuration":{ "shape":"Long", "documentation":"

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

" }, "MaxDuration":{ "shape":"Long", "documentation":"

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

" }, "MaxInstanceCount":{ "shape":"Integer", "documentation":"

The maximum number of instances to filter when searching for offerings.

Default: 20

" } }, "documentation":"

Contains the parameters for DescribeReservedInstancesOfferings.

" }, "DescribeReservedInstancesOfferingsResult":{ "type":"structure", "members":{ "ReservedInstancesOfferings":{ "shape":"ReservedInstancesOfferingList", "documentation":"

A list of Reserved Instances offerings.

", "locationName":"reservedInstancesOfferingsSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeReservedInstancesOfferings.

" }, "DescribeReservedInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ReservedInstancesIds":{ "shape":"ReservedInstancesIdStringList", "documentation":"

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

", "locationName":"ReservedInstancesId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", "locationName":"Filter" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", "locationName":"offeringType" } }, "documentation":"

Contains the parameters for DescribeReservedInstances.

" }, "DescribeReservedInstancesResult":{ "type":"structure", "members":{ "ReservedInstances":{ "shape":"ReservedInstancesList", "documentation":"

A list of Reserved Instances.

", "locationName":"reservedInstancesSet" } }, "documentation":"

Contains the output for DescribeReservedInstances.

" }, "DescribeRouteTablesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs.

Default: Describes all your route tables.

", "locationName":"RouteTableId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC (true | false).

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The CIDR range specified in a route in the table.

  • route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.nat-gateway-id - The ID of a NAT gateway.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). 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).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the route table.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeRouteTables.

" }, "DescribeRouteTablesResult":{ "type":"structure", "members":{ "RouteTables":{ "shape":"RouteTableList", "documentation":"

Information about one or more route tables.

", "locationName":"routeTableSet" } }, "documentation":"

Contains the output of DescribeRouteTables.

" }, "DescribeScheduledInstanceAvailabilityRequest":{ "type":"structure", "required":[ "Recurrence", "FirstSlotStartTimeRange" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "Recurrence":{ "shape":"ScheduledInstanceRecurrenceRequest", "documentation":"

The schedule recurrence.

" }, "FirstSlotStartTimeRange":{ "shape":"SlotDateTimeRangeRequest", "documentation":"

The time period for the first schedule to start.

" }, "MinSlotDurationInHours":{ "shape":"Integer", "documentation":"

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

" }, "MaxSlotDurationInHours":{ "shape":"Integer", "documentation":"

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned NextToken value.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeScheduledInstanceAvailability.

" }, "DescribeScheduledInstanceAvailabilityResult":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" }, "ScheduledInstanceAvailabilitySet":{ "shape":"ScheduledInstanceAvailabilitySet", "documentation":"

Information about the available Scheduled Instances.

", "locationName":"scheduledInstanceAvailabilitySet" } }, "documentation":"

Contains the output of DescribeScheduledInstanceAvailability.

" }, "DescribeScheduledInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ScheduledInstanceIds":{ "shape":"ScheduledInstanceIdRequestSet", "documentation":"

One or more Scheduled Instance IDs.

", "locationName":"ScheduledInstanceId" }, "SlotStartTimeRange":{ "shape":"SlotStartTimeRangeRequest", "documentation":"

The time period for the first schedule to start.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeScheduledInstances.

" }, "DescribeScheduledInstancesResult":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" }, "ScheduledInstanceSet":{ "shape":"ScheduledInstanceSet", "documentation":"

Information about the Scheduled Instances.

", "locationName":"scheduledInstanceSet" } }, "documentation":"

Contains the output of DescribeScheduledInstances.

" }, "DescribeSecurityGroupReferencesRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "GroupId":{ "shape":"GroupIds", "documentation":"

One or more security group IDs in your account.

" } } }, "DescribeSecurityGroupReferencesResult":{ "type":"structure", "members":{ "SecurityGroupReferenceSet":{ "shape":"SecurityGroupReferences", "documentation":"

Information about the VPCs with the referencing security groups.

", "locationName":"securityGroupReferenceSet" } } }, "DescribeSecurityGroupsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupNames":{ "shape":"GroupNameStringList", "documentation":"

[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

", "locationName":"GroupName" }, "GroupIds":{ "shape":"GroupIdStringList", "documentation":"

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

", "locationName":"GroupId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which the security group allows access.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - A CIDR range that has been granted permission.

  • ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been granted permission.

  • ip-permission.group-name - The name of a security group that has been granted permission.

  • ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been granted permission.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag-key - The key of a tag assigned to the security group.

  • tag-value - The value of a tag assigned to the security group.

  • vpc-id - The ID of the VPC specified when the security group was created.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeSecurityGroups.

" }, "DescribeSecurityGroupsResult":{ "type":"structure", "members":{ "SecurityGroups":{ "shape":"SecurityGroupList", "documentation":"

Information about one or more security groups.

", "locationName":"securityGroupInfo" } }, "documentation":"

Contains the output of DescribeSecurityGroups.

" }, "DescribeSnapshotAttributeRequest":{ "type":"structure", "required":[ "SnapshotId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The snapshot attribute you would like to view.

" } }, "documentation":"

Contains the parameters for DescribeSnapshotAttribute.

" }, "DescribeSnapshotAttributeResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot.

", "locationName":"snapshotId" }, "CreateVolumePermissions":{ "shape":"CreateVolumePermissionList", "documentation":"

A list of permissions for creating volumes from the snapshot.

", "locationName":"createVolumePermission" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" } }, "documentation":"

Contains the output of DescribeSnapshotAttribute.

" }, "DescribeSnapshotsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotIds":{ "shape":"SnapshotIdStringList", "documentation":"

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

", "locationName":"SnapshotId" }, "OwnerIds":{ "shape":"OwnerStringList", "documentation":"

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

", "locationName":"Owner" }, "RestorableByUserIds":{ "shape":"RestorableByStringList", "documentation":"

One or more AWS accounts IDs that can create volumes from the snapshot.

", "locationName":"RestorableBy" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • description - A description of the snapshot.

  • owner-alias - Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM consolew.

  • owner-id - The ID of the AWS account that owns the snapshot.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

" } }, "documentation":"

Contains the parameters for DescribeSnapshots.

" }, "DescribeSnapshotsResult":{ "type":"structure", "members":{ "Snapshots":{ "shape":"SnapshotList", "documentation":"

Information about the snapshots.

", "locationName":"snapshotSet" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSnapshots.

" }, "DescribeSpotDatafeedSubscriptionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for DescribeSpotDatafeedSubscription.

" }, "DescribeSpotDatafeedSubscriptionResult":{ "type":"structure", "members":{ "SpotDatafeedSubscription":{ "shape":"SpotDatafeedSubscription", "documentation":"

The Spot instance data feed subscription.

", "locationName":"spotDatafeedSubscription" } }, "documentation":"

Contains the output of DescribeSpotDatafeedSubscription.

" }, "DescribeSpotFleetInstancesRequest":{ "type":"structure", "required":["SpotFleetRequestId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeSpotFleetInstances.

" }, "DescribeSpotFleetInstancesResponse":{ "type":"structure", "required":[ "SpotFleetRequestId", "ActiveInstances" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "ActiveInstances":{ "shape":"ActiveInstanceSet", "documentation":"

The running instances. Note that this list is refreshed periodically and might be out of date.

", "locationName":"activeInstanceSet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotFleetInstances.

" }, "DescribeSpotFleetRequestHistoryRequest":{ "type":"structure", "required":[ "SpotFleetRequestId", "StartTime" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "EventType":{ "shape":"EventType", "documentation":"

The type of events to describe. By default, all events are described.

", "locationName":"eventType" }, "StartTime":{ "shape":"DateTime", "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"startTime" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeSpotFleetRequestHistory.

" }, "DescribeSpotFleetRequestHistoryResponse":{ "type":"structure", "required":[ "SpotFleetRequestId", "StartTime", "LastEvaluatedTime", "HistoryRecords" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "StartTime":{ "shape":"DateTime", "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"startTime" }, "LastEvaluatedTime":{ "shape":"DateTime", "documentation":"

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

If nextToken indicates that there are more results, this value is not present.

", "locationName":"lastEvaluatedTime" }, "HistoryRecords":{ "shape":"HistoryRecords", "documentation":"

Information about the events in the history of the Spot fleet request.

", "locationName":"historyRecordSet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotFleetRequestHistory.

" }, "DescribeSpotFleetRequestsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestIds":{ "shape":"ValueStringList", "documentation":"

The IDs of the Spot fleet requests.

", "locationName":"spotFleetRequestId" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeSpotFleetRequests.

" }, "DescribeSpotFleetRequestsResponse":{ "type":"structure", "required":["SpotFleetRequestConfigs"], "members":{ "SpotFleetRequestConfigs":{ "shape":"SpotFleetRequestConfigSet", "documentation":"

Information about the configuration of your Spot fleet.

", "locationName":"spotFleetRequestConfigSet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotFleetRequests.

" }, "DescribeSpotInstanceRequestsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotInstanceRequestIds":{ "shape":"SpotInstanceRequestIdList", "documentation":"

One or more Spot instance request IDs.

", "locationName":"SpotInstanceRequestId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume: gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.

  • launch.group-id - The security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m3.medium).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether monitoring is enabled for the Spot instance.

  • launch.ramdisk-id - The RAM disk ID.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • network-interface.description - A description of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.group-name - The name of the security group associated with the network interface.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot instance request ID.

  • spot-price - The maximum hourly price for any Spot instance launched to fulfill the request.

  • state - The state of the Spot instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

  • status-code - The short code describing the most recent evaluation of your Spot instance request.

  • status-message - The message explaining the status of the Spot instance request.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of Spot instance request (one-time | persistent).

  • launched-availability-zone - The Availability Zone in which the bid is launched.

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeSpotInstanceRequests.

" }, "DescribeSpotInstanceRequestsResult":{ "type":"structure", "members":{ "SpotInstanceRequests":{ "shape":"SpotInstanceRequestList", "documentation":"

One or more Spot instance requests.

", "locationName":"spotInstanceRequestSet" } }, "documentation":"

Contains the output of DescribeSpotInstanceRequests.

" }, "DescribeSpotPriceHistoryRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "StartTime":{ "shape":"DateTime", "documentation":"

The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"startTime" }, "EndTime":{ "shape":"DateTime", "documentation":"

The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"endTime" }, "InstanceTypes":{ "shape":"InstanceTypeList", "documentation":"

Filters the results by the specified instance types.

", "locationName":"InstanceType" }, "ProductDescriptions":{ "shape":"ProductDescriptionList", "documentation":"

Filters the results by the specified basic product descriptions.

", "locationName":"ProductDescription" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m3.medium).

  • product-description - The product description for the Spot price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - The timestamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

", "locationName":"Filter" }, "AvailabilityZone":{ "shape":"String", "documentation":"

Filters the results by the specified Availability Zone.

", "locationName":"availabilityZone" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" } }, "documentation":"

Contains the parameters for DescribeSpotPriceHistory.

" }, "DescribeSpotPriceHistoryResult":{ "type":"structure", "members":{ "SpotPriceHistory":{ "shape":"SpotPriceHistoryList", "documentation":"

The historical Spot prices.

", "locationName":"spotPriceHistorySet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotPriceHistory.

" }, "DescribeStaleSecurityGroupsRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } } }, "DescribeStaleSecurityGroupsResult":{ "type":"structure", "members":{ "StaleSecurityGroupSet":{ "shape":"StaleSecurityGroupSet", "documentation":"

Information about the stale security groups.

", "locationName":"staleSecurityGroupSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } } }, "DescribeSubnetsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SubnetIds":{ "shape":"SubnetIdStringList", "documentation":"

One or more subnet IDs.

Default: Describes all your subnets.

", "locationName":"SubnetId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

  • available-ip-address-count - The number of IP addresses in the subnet that are available.

  • cidrBlock - 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. You can also use cidr or cidr-block as the filter names.

  • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

  • state - The state of the subnet (pending | available).

  • subnet-id - The ID of the subnet.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the subnet.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeSubnets.

" }, "DescribeSubnetsResult":{ "type":"structure", "members":{ "Subnets":{ "shape":"SubnetList", "documentation":"

Information about one or more subnets.

", "locationName":"subnetSet" } }, "documentation":"

Contains the output of DescribeSubnets.

" }, "DescribeTagsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • key - The tag key.

  • resource-id - The resource ID.

  • resource-type - The resource type (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).

  • value - The tag value.

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" } }, "documentation":"

Contains the parameters for DescribeTags.

" }, "DescribeTagsResult":{ "type":"structure", "members":{ "Tags":{ "shape":"TagDescriptionList", "documentation":"

A list of tags.

", "locationName":"tagSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return..

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeTags.

" }, "DescribeVolumeAttributeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "Attribute":{ "shape":"VolumeAttributeName", "documentation":"

The instance attribute.

" } }, "documentation":"

Contains the parameters for DescribeVolumeAttribute.

" }, "DescribeVolumeAttributeResult":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "AutoEnableIO":{ "shape":"AttributeBooleanValue", "documentation":"

The state of autoEnableIO attribute.

", "locationName":"autoEnableIO" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" } }, "documentation":"

Contains the output of DescribeVolumeAttribute.

" }, "DescribeVolumeStatusRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeIds":{ "shape":"VolumeIdStringList", "documentation":"

One or more volume IDs.

Default: Describes all your volumes.

", "locationName":"VolumeId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

" } }, "documentation":"

Contains the parameters for DescribeVolumeStatus.

" }, "DescribeVolumeStatusResult":{ "type":"structure", "members":{ "VolumeStatuses":{ "shape":"VolumeStatusList", "documentation":"

A list of volumes.

", "locationName":"volumeStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVolumeStatus.

" }, "DescribeVolumesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeIds":{ "shape":"VolumeIdStringList", "documentation":"

One or more volume IDs.

", "locationName":"VolumeId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - The encryption status of the volume.

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The status of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeVolumes.

" }, "DescribeVolumesResult":{ "type":"structure", "members":{ "Volumes":{ "shape":"VolumeList", "documentation":"

Information about the volumes.

", "locationName":"volumeSet" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVolumes.

" }, "DescribeVpcAttributeRequest":{ "type":"structure", "required":[ "VpcId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "Attribute":{ "shape":"VpcAttributeName", "documentation":"

The VPC attribute.

" } }, "documentation":"

Contains the parameters for DescribeVpcAttribute.

" }, "DescribeVpcAttributeResult":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "EnableDnsSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

", "locationName":"enableDnsSupport" }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

", "locationName":"enableDnsHostnames" } }, "documentation":"

Contains the output of DescribeVpcAttribute.

" }, "DescribeVpcClassicLinkDnsSupportRequest":{ "type":"structure", "members":{ "VpcIds":{ "shape":"VpcClassicLinkIdList", "documentation":"

One or more VPC IDs.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

", "locationName":"maxResults" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

", "locationName":"nextToken" } }, "documentation":"

Contains the parameters for DescribeVpcClassicLinkDnsSupport.

" }, "DescribeVpcClassicLinkDnsSupportResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"ClassicLinkDnsSupportList", "documentation":"

Information about the ClassicLink DNS support status of the VPCs.

", "locationName":"vpcs" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVpcClassicLinkDnsSupport.

" }, "DescribeVpcClassicLinkRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcIds":{ "shape":"VpcClassicLinkIdList", "documentation":"

One or more VPCs for which you want to describe the ClassicLink status.

", "locationName":"VpcId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpcClassicLink.

" }, "DescribeVpcClassicLinkResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"VpcClassicLinkList", "documentation":"

The ClassicLink status of one or more VPCs.

", "locationName":"vpcSet" } }, "documentation":"

Contains the output of DescribeVpcClassicLink.

" }, "DescribeVpcEndpointServicesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } }, "documentation":"

Contains the parameters for DescribeVpcEndpointServices.

" }, "DescribeVpcEndpointServicesResult":{ "type":"structure", "members":{ "ServiceNames":{ "shape":"ValueStringList", "documentation":"

A list of supported AWS services.

", "locationName":"serviceNameSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVpcEndpointServices.

" }, "DescribeVpcEndpointsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcEndpointIds":{ "shape":"ValueStringList", "documentation":"

One or more endpoint IDs.

", "locationName":"VpcEndpointId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • service-name: The name of the AWS service.

  • vpc-id: The ID of the VPC in which the endpoint resides.

  • vpc-endpoint-id: The ID of the endpoint.

  • vpc-endpoint-state: The state of the endpoint. (pending | available | deleting | deleted)

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } }, "documentation":"

Contains the parameters for DescribeVpcEndpoints.

" }, "DescribeVpcEndpointsResult":{ "type":"structure", "members":{ "VpcEndpoints":{ "shape":"VpcEndpointSet", "documentation":"

Information about the endpoints.

", "locationName":"vpcEndpointSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeVpcEndpoints.

" }, "DescribeVpcPeeringConnectionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionIds":{ "shape":"ValueStringList", "documentation":"

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

", "locationName":"VpcPeeringConnectionId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

  • accepter-vpc-info.vpc-id - The ID of the peer VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpcPeeringConnections.

" }, "DescribeVpcPeeringConnectionsResult":{ "type":"structure", "members":{ "VpcPeeringConnections":{ "shape":"VpcPeeringConnectionList", "documentation":"

Information about the VPC peering connections.

", "locationName":"vpcPeeringConnectionSet" } }, "documentation":"

Contains the output of DescribeVpcPeeringConnections.

" }, "DescribeVpcsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcIds":{ "shape":"VpcIdStringList", "documentation":"

One or more VPC IDs.

Default: Describes all your VPCs.

", "locationName":"VpcId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • cidr - 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. Must contain the slash followed by one or two digits (for example, /28).

  • dhcp-options-id - The ID of a set of DHCP options.

  • isDefault - Indicates whether the VPC is the default VPC.

  • state - The state of the VPC (pending | available).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpcs.

" }, "DescribeVpcsResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"VpcList", "documentation":"

Information about one or more VPCs.

", "locationName":"vpcSet" } }, "documentation":"

Contains the output of DescribeVpcs.

" }, "DescribeVpnConnectionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnConnectionIds":{ "shape":"VpnConnectionIdStringList", "documentation":"

One or more VPN connection IDs.

Default: Describes your VPN connections.

", "locationName":"VpnConnectionId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpnConnections.

" }, "DescribeVpnConnectionsResult":{ "type":"structure", "members":{ "VpnConnections":{ "shape":"VpnConnectionList", "documentation":"

Information about one or more VPN connections.

", "locationName":"vpnConnectionSet" } }, "documentation":"

Contains the output of DescribeVpnConnections.

" }, "DescribeVpnGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayIds":{ "shape":"VpnGatewayIdStringList", "documentation":"

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

", "locationName":"VpnGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway (if applicable).

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeVpnGateways.

" }, "DescribeVpnGatewaysResult":{ "type":"structure", "members":{ "VpnGateways":{ "shape":"VpnGatewayList", "documentation":"

Information about one or more virtual private gateways.

", "locationName":"vpnGatewaySet" } }, "documentation":"

Contains the output of DescribeVpnGateways.

" }, "DetachClassicLinkVpcRequest":{ "type":"structure", "required":[ "InstanceId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance to unlink from the VPC.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC to which the instance is linked.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for DetachClassicLinkVpc.

" }, "DetachClassicLinkVpcResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of DetachClassicLinkVpc.

" }, "DetachInternetGatewayRequest":{ "type":"structure", "required":[ "InternetGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for DetachInternetGateway.

" }, "DetachNetworkInterfaceRequest":{ "type":"structure", "required":["AttachmentId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AttachmentId":{ "shape":"String", "documentation":"

The ID of the attachment.

", "locationName":"attachmentId" }, "Force":{ "shape":"Boolean", "documentation":"

Specifies whether to force a detachment.

", "locationName":"force" } }, "documentation":"

Contains the parameters for DetachNetworkInterface.

" }, "DetachVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "Device":{ "shape":"String", "documentation":"

The device name.

" }, "Force":{ "shape":"Boolean", "documentation":"

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

" } }, "documentation":"

Contains the parameters for DetachVolume.

" }, "DetachVpnGatewayRequest":{ "type":"structure", "required":[ "VpnGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for DetachVpnGateway.

" }, "DeviceType":{ "type":"string", "enum":[ "ebs", "instance-store" ] }, "DhcpConfiguration":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The name of a DHCP option.

", "locationName":"key" }, "Values":{ "shape":"DhcpConfigurationValueList", "documentation":"

One or more values for the DHCP option.

", "locationName":"valueSet" } }, "documentation":"

Describes a DHCP configuration option.

" }, "DhcpConfigurationList":{ "type":"list", "member":{ "shape":"DhcpConfiguration", "locationName":"item" } }, "DhcpConfigurationValueList":{ "type":"list", "member":{ "shape":"AttributeValue", "locationName":"item" } }, "DhcpOptions":{ "type":"structure", "members":{ "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the set of DHCP options.

", "locationName":"dhcpOptionsId" }, "DhcpConfigurations":{ "shape":"DhcpConfigurationList", "documentation":"

One or more DHCP options in the set.

", "locationName":"dhcpConfigurationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the DHCP options set.

", "locationName":"tagSet" } }, "documentation":"

Describes a set of DHCP options.

" }, "DhcpOptionsIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"DhcpOptionsId" } }, "DhcpOptionsList":{ "type":"list", "member":{ "shape":"DhcpOptions", "locationName":"item" } }, "DisableVgwRoutePropagationRequest":{ "type":"structure", "required":[ "RouteTableId", "GatewayId" ], "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } }, "documentation":"

Contains the parameters for DisableVgwRoutePropagation.

" }, "DisableVpcClassicLinkDnsSupportRequest":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for DisableVpcClassicLinkDnsSupport.

" }, "DisableVpcClassicLinkDnsSupportResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of DisableVpcClassicLinkDnsSupport.

" }, "DisableVpcClassicLinkRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for DisableVpcClassicLink.

" }, "DisableVpcClassicLinkResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of DisableVpcClassicLink.

" }, "DisassociateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" }, "AssociationId":{ "shape":"String", "documentation":"

[EC2-VPC] The association ID. Required for EC2-VPC.

" } }, "documentation":"

Contains the parameters for DisassociateAddress.

" }, "DisassociateRouteTableRequest":{ "type":"structure", "required":["AssociationId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID representing the current association between the route table and subnet.

", "locationName":"associationId" } }, "documentation":"

Contains the parameters for DisassociateRouteTable.

" }, "DiskImage":{ "type":"structure", "members":{ "Image":{ "shape":"DiskImageDetail", "documentation":"

Information about the disk image.

" }, "Description":{ "shape":"String", "documentation":"

A description of the disk image.

" }, "Volume":{ "shape":"VolumeDetail", "documentation":"

Information about the volume.

" } }, "documentation":"

Describes a disk image.

" }, "DiskImageDescription":{ "type":"structure", "required":[ "Format", "Size", "ImportManifestUrl" ], "members":{ "Format":{ "shape":"DiskImageFormat", "documentation":"

The disk image format.

", "locationName":"format" }, "Size":{ "shape":"Long", "documentation":"

The size of the disk image, in GiB.

", "locationName":"size" }, "ImportManifestUrl":{ "shape":"String", "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

", "locationName":"importManifestUrl" }, "Checksum":{ "shape":"String", "documentation":"

The checksum computed for the disk image.

", "locationName":"checksum" } }, "documentation":"

Describes a disk image.

" }, "DiskImageDetail":{ "type":"structure", "required":[ "Format", "Bytes", "ImportManifestUrl" ], "members":{ "Format":{ "shape":"DiskImageFormat", "documentation":"

The disk image format.

", "locationName":"format" }, "Bytes":{ "shape":"Long", "documentation":"

The size of the disk image, in GiB.

", "locationName":"bytes" }, "ImportManifestUrl":{ "shape":"String", "documentation":"

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

", "locationName":"importManifestUrl" } }, "documentation":"

Describes a disk image.

" }, "DiskImageFormat":{ "type":"string", "enum":[ "VMDK", "RAW", "VHD" ] }, "DiskImageList":{ "type":"list", "member":{"shape":"DiskImage"} }, "DiskImageVolumeDescription":{ "type":"structure", "required":["Id"], "members":{ "Size":{ "shape":"Long", "documentation":"

The size of the volume, in GiB.

", "locationName":"size" }, "Id":{ "shape":"String", "documentation":"

The volume identifier.

", "locationName":"id" } }, "documentation":"

Describes a disk image volume.

" }, "DomainType":{ "type":"string", "enum":[ "vpc", "standard" ] }, "Double":{"type":"double"}, "EbsBlockDevice":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

", "locationName":"snapshotId" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

", "locationName":"volumeSize" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", "locationName":"deleteOnTermination" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type: gp2, io1, st1, sc1, or standard.

Default: standard

", "locationName":"volumeType" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", "locationName":"iops" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

", "locationName":"encrypted" } }, "documentation":"

Describes a block device for an EBS volume.

" }, "EbsInstanceBlockDevice":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume.

", "locationName":"volumeId" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a parameter used to set up an EBS volume in a block device mapping.

" }, "EbsInstanceBlockDeviceSpecification":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume.

", "locationName":"volumeId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes information used to set up an EBS volume specified in a block device mapping.

" }, "EnableVgwRoutePropagationRequest":{ "type":"structure", "required":[ "RouteTableId", "GatewayId" ], "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } }, "documentation":"

Contains the parameters for EnableVgwRoutePropagation.

" }, "EnableVolumeIORequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" } }, "documentation":"

Contains the parameters for EnableVolumeIO.

" }, "EnableVpcClassicLinkDnsSupportRequest":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } }, "documentation":"

Contains the parameters for EnableVpcClassicLinkDnsSupport.

" }, "EnableVpcClassicLinkDnsSupportResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of EnableVpcClassicLinkDnsSupport.

" }, "EnableVpcClassicLinkRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Contains the parameters for EnableVpcClassicLink.

" }, "EnableVpcClassicLinkResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of EnableVpcClassicLink.

" }, "EventCode":{ "type":"string", "enum":[ "instance-reboot", "system-reboot", "system-maintenance", "instance-retirement", "instance-stop" ] }, "EventInformation":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance. This information is available only for instanceChange events.

", "locationName":"instanceId" }, "EventSubType":{ "shape":"String", "documentation":"

The event.

The following are the error events.

  • iamFleetRoleInvalid - The Spot fleet did not have the required permissions either to launch or terminate an instance.

  • launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.

  • spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.

  • spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot instances that you can launch.

The following are the fleetRequestChange events.

  • active - The Spot fleet has been validated and Amazon EC2 is attempting to maintain the target number of running Spot instances.

  • cancelled - The Spot fleet is canceled and has no running Spot instances. The Spot fleet will be deleted two days after its instances were terminated.

  • cancelled_running - The Spot fleet is canceled and will not launch additional Spot instances, but its existing Spot instances continue to run until they are interrupted or terminated.

  • cancelled_terminating - The Spot fleet is canceled and its Spot instances are terminating.

  • expired - The Spot fleet request has expired. A subsequent event indicates that the instances were terminated, if the request was created with TerminateInstancesWithExpiration set.

  • modify_in_progress - A request to modify the Spot fleet request was accepted and is in progress.

  • modify_successful - The Spot fleet request was modified.

  • price_update - The bid price for a launch configuration was adjusted because it was too high. This change is permanent.

  • submitted - The Spot fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of Spot instances.

The following are the instanceChange events.

  • launched - A bid was fulfilled and a new instance was launched.

  • terminated - An instance was terminated by the user.

", "locationName":"eventSubType" }, "EventDescription":{ "shape":"String", "documentation":"

The description of the event.

", "locationName":"eventDescription" } }, "documentation":"

Describes a Spot fleet event.

" }, "EventType":{ "type":"string", "enum":[ "instanceChange", "fleetRequestChange", "error" ] }, "ExcessCapacityTerminationPolicy":{ "type":"string", "enum":[ "noTermination", "default" ] }, "ExecutableByStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ExecutableBy" } }, "ExportEnvironment":{ "type":"string", "enum":[ "citrix", "vmware", "microsoft" ] }, "ExportTask":{ "type":"structure", "members":{ "ExportTaskId":{ "shape":"String", "documentation":"

The ID of the export task.

", "locationName":"exportTaskId" }, "Description":{ "shape":"String", "documentation":"

A description of the resource being exported.

", "locationName":"description" }, "State":{ "shape":"ExportTaskState", "documentation":"

The state of the export task.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message related to the export task.

", "locationName":"statusMessage" }, "InstanceExportDetails":{ "shape":"InstanceExportDetails", "documentation":"

Information about the instance to export.

", "locationName":"instanceExport" }, "ExportToS3Task":{ "shape":"ExportToS3Task", "documentation":"

Information about the export task.

", "locationName":"exportToS3" } }, "documentation":"

Describes an instance export task.

" }, "ExportTaskIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ExportTaskId" } }, "ExportTaskList":{ "type":"list", "member":{ "shape":"ExportTask", "locationName":"item" } }, "ExportTaskState":{ "type":"string", "enum":[ "active", "cancelling", "cancelled", "completed" ] }, "ExportToS3Task":{ "type":"structure", "members":{ "DiskImageFormat":{ "shape":"DiskImageFormat", "documentation":"

The format for the exported image.

", "locationName":"diskImageFormat" }, "ContainerFormat":{ "shape":"ContainerFormat", "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", "locationName":"containerFormat" }, "S3Bucket":{ "shape":"String", "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", "locationName":"s3Bucket" }, "S3Key":{ "shape":"String", "documentation":"

The encryption key for your S3 bucket.

", "locationName":"s3Key" } }, "documentation":"

Describes the format and location for an instance export task.

" }, "ExportToS3TaskSpecification":{ "type":"structure", "members":{ "DiskImageFormat":{ "shape":"DiskImageFormat", "documentation":"

The format for the exported image.

", "locationName":"diskImageFormat" }, "ContainerFormat":{ "shape":"ContainerFormat", "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", "locationName":"containerFormat" }, "S3Bucket":{ "shape":"String", "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", "locationName":"s3Bucket" }, "S3Prefix":{ "shape":"String", "documentation":"

The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

", "locationName":"s3Prefix" } }, "documentation":"

Describes an instance export task.

" }, "Filter":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the filter. Filter names are case-sensitive.

" }, "Values":{ "shape":"ValueStringList", "documentation":"

One or more filter values. Filter values are case-sensitive.

", "locationName":"Value" } }, "documentation":"

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.

" }, "FilterList":{ "type":"list", "member":{ "shape":"Filter", "locationName":"Filter" } }, "FleetType":{ "type":"string", "enum":[ "request", "maintain" ] }, "Float":{"type":"float"}, "FlowLog":{ "type":"structure", "members":{ "CreationTime":{ "shape":"DateTime", "documentation":"

The date and time the flow log was created.

", "locationName":"creationTime" }, "FlowLogId":{ "shape":"String", "documentation":"

The flow log ID.

", "locationName":"flowLogId" }, "FlowLogStatus":{ "shape":"String", "documentation":"

The status of the flow log (ACTIVE).

", "locationName":"flowLogStatus" }, "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource on which the flow log was created.

", "locationName":"resourceId" }, "TrafficType":{ "shape":"TrafficType", "documentation":"

The type of traffic captured for the flow log.

", "locationName":"trafficType" }, "LogGroupName":{ "shape":"String", "documentation":"

The name of the flow log group.

", "locationName":"logGroupName" }, "DeliverLogsStatus":{ "shape":"String", "documentation":"

The status of the logs delivery (SUCCESS | FAILED).

", "locationName":"deliverLogsStatus" }, "DeliverLogsErrorMessage":{ "shape":"String", "documentation":"

Information about the error that occurred. Rate limited indicates that CloudWatch logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of CloudWatch Logs log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.

", "locationName":"deliverLogsErrorMessage" }, "DeliverLogsPermissionArn":{ "shape":"String", "documentation":"

The ARN of the IAM role that posts logs to CloudWatch Logs.

", "locationName":"deliverLogsPermissionArn" } }, "documentation":"

Describes a flow log.

" }, "FlowLogSet":{ "type":"list", "member":{ "shape":"FlowLog", "locationName":"item" } }, "FlowLogsResourceType":{ "type":"string", "enum":[ "VPC", "Subnet", "NetworkInterface" ] }, "GatewayType":{ "type":"string", "enum":["ipsec.1"] }, "GetConsoleOutputRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" } }, "documentation":"

Contains the parameters for GetConsoleOutput.

" }, "GetConsoleOutputResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The time the output was last updated.

", "locationName":"timestamp" }, "Output":{ "shape":"String", "documentation":"

The console output, Base64-encoded. If using a command line tool, the tool decodes the output for you.

", "locationName":"output" } }, "documentation":"

Contains the output of GetConsoleOutput.

" }, "GetConsoleScreenshotRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "WakeUp":{ "shape":"Boolean", "documentation":"

When set to true, acts as keystroke input and wakes up an instance that's in standby or \"sleep\" mode.

" } }, "documentation":"

Contains the parameters for the request.

" }, "GetConsoleScreenshotResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "ImageData":{ "shape":"String", "documentation":"

The data that comprises the image.

", "locationName":"imageData" } }, "documentation":"

Contains the output of the request.

" }, "GetHostReservationPurchasePreviewRequest":{ "type":"structure", "required":[ "OfferingId", "HostIdSet" ], "members":{ "OfferingId":{ "shape":"String", "documentation":"

The offering ID of the reservation.

" }, "HostIdSet":{ "shape":"RequestHostIdSet", "documentation":"

The ID/s of the Dedicated Host/s that the reservation will be associated with.

" } } }, "GetHostReservationPurchasePreviewResult":{ "type":"structure", "members":{ "Purchase":{ "shape":"PurchaseSet", "documentation":"

The purchase information of the Dedicated Host Reservation and the Dedicated Hosts associated with it.

", "locationName":"purchase" }, "TotalUpfrontPrice":{ "shape":"String", "documentation":"

The potential total upfront price. This is billed immediately.

", "locationName":"totalUpfrontPrice" }, "TotalHourlyPrice":{ "shape":"String", "documentation":"

The potential total hourly price of the reservation per hour.

", "locationName":"totalHourlyPrice" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } } }, "GetPasswordDataRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the Windows instance.

" } }, "documentation":"

Contains the parameters for GetPasswordData.

" }, "GetPasswordDataResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the Windows instance.

", "locationName":"instanceId" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The time the data was last updated.

", "locationName":"timestamp" }, "PasswordData":{ "shape":"String", "documentation":"

The password of the instance.

", "locationName":"passwordData" } }, "documentation":"

Contains the output of GetPasswordData.

" }, "GroupIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"groupId" } }, "GroupIdentifier":{ "type":"structure", "members":{ "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } }, "documentation":"

Describes a security group.

" }, "GroupIdentifierList":{ "type":"list", "member":{ "shape":"GroupIdentifier", "locationName":"item" } }, "GroupIds":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "GroupNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"GroupName" } }, "HistoryRecord":{ "type":"structure", "required":[ "Timestamp", "EventType", "EventInformation" ], "members":{ "Timestamp":{ "shape":"DateTime", "documentation":"

The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"timestamp" }, "EventType":{ "shape":"EventType", "documentation":"

The event type.

  • error - Indicates an error with the Spot fleet request.

  • fleetRequestChange - Indicates a change in the status or configuration of the Spot fleet request.

  • instanceChange - Indicates that an instance was launched or terminated.

", "locationName":"eventType" }, "EventInformation":{ "shape":"EventInformation", "documentation":"

Information about the event.

", "locationName":"eventInformation" } }, "documentation":"

Describes an event in the history of the Spot fleet request.

" }, "HistoryRecords":{ "type":"list", "member":{ "shape":"HistoryRecord", "locationName":"item" } }, "Host":{ "type":"structure", "members":{ "HostId":{ "shape":"String", "documentation":"

The ID of the Dedicated Host.

", "locationName":"hostId" }, "AutoPlacement":{ "shape":"AutoPlacement", "documentation":"

Whether auto-placement is on or off.

", "locationName":"autoPlacement" }, "HostReservationId":{ "shape":"String", "documentation":"

The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation.

", "locationName":"hostReservationId" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"clientToken" }, "HostProperties":{ "shape":"HostProperties", "documentation":"

The hardware specifications of the Dedicated Host.

", "locationName":"hostProperties" }, "State":{ "shape":"AllocationState", "documentation":"

The Dedicated Host's state.

", "locationName":"state" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the Dedicated Host.

", "locationName":"availabilityZone" }, "Instances":{ "shape":"HostInstanceList", "documentation":"

The IDs and instance type that are currently running on the Dedicated Host.

", "locationName":"instances" }, "AvailableCapacity":{ "shape":"AvailableCapacity", "documentation":"

The number of new instances that can be launched onto the Dedicated Host.

", "locationName":"availableCapacity" } }, "documentation":"

Describes the properties of the Dedicated Host.

" }, "HostInstance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

the IDs of instances that are running on the Dedicated Host.

", "locationName":"instanceId" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type size (for example, m3.medium) of the running instance.

", "locationName":"instanceType" } }, "documentation":"

Describes an instance running on a Dedicated Host.

" }, "HostInstanceList":{ "type":"list", "member":{ "shape":"HostInstance", "locationName":"item" } }, "HostList":{ "type":"list", "member":{ "shape":"Host", "locationName":"item" } }, "HostOffering":{ "type":"structure", "members":{ "OfferingId":{ "shape":"String", "documentation":"

The ID of the offering.

", "locationName":"offeringId" }, "InstanceFamily":{ "shape":"String", "documentation":"

The instance family of the offering.

", "locationName":"instanceFamily" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"

The available payment option.

", "locationName":"paymentOption" }, "UpfrontPrice":{ "shape":"String", "documentation":"

The upfront price of the offering. Does not apply to No Upfront offerings.

", "locationName":"upfrontPrice" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price of the offering.

", "locationName":"hourlyPrice" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the offering.

", "locationName":"currencyCode" }, "Duration":{ "shape":"Integer", "documentation":"

The duration of the offering (in seconds).

", "locationName":"duration" } }, "documentation":"

Details about the Dedicated Host Reservation offering.

" }, "HostOfferingSet":{ "type":"list", "member":{"shape":"HostOffering"} }, "HostProperties":{ "type":"structure", "members":{ "Sockets":{ "shape":"Integer", "documentation":"

The number of sockets on the Dedicated Host.

", "locationName":"sockets" }, "Cores":{ "shape":"Integer", "documentation":"

The number of cores on the Dedicated Host.

", "locationName":"cores" }, "TotalVCpus":{ "shape":"Integer", "documentation":"

The number of vCPUs on the Dedicated Host.

", "locationName":"totalVCpus" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type size that the Dedicated Host supports (for example, m3.medium).

", "locationName":"instanceType" } }, "documentation":"

Describes properties of a Dedicated Host.

" }, "HostReservation":{ "type":"structure", "members":{ "HostReservationId":{ "shape":"String", "documentation":"

The ID of the reservation that specifies the associated Dedicated Hosts.

", "locationName":"hostReservationId" }, "HostIdSet":{ "shape":"ResponseHostIdSet", "documentation":"

The IDs of the Dedicated Hosts associated with the reservation.

", "locationName":"hostIdSet" }, "OfferingId":{ "shape":"String", "documentation":"

The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.

", "locationName":"offeringId" }, "InstanceFamily":{ "shape":"String", "documentation":"

The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.

", "locationName":"instanceFamily" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"

The payment option selected for this reservation.

", "locationName":"paymentOption" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price of the reservation.

", "locationName":"hourlyPrice" }, "UpfrontPrice":{ "shape":"String", "documentation":"

The upfront price of the reservation.

", "locationName":"upfrontPrice" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "Count":{ "shape":"Integer", "documentation":"

The number of Dedicated Hosts the reservation is associated with.

", "locationName":"count" }, "Duration":{ "shape":"Integer", "documentation":"

The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).

", "locationName":"duration" }, "End":{ "shape":"DateTime", "documentation":"

The date and time that the reservation ends.

", "locationName":"end" }, "Start":{ "shape":"DateTime", "documentation":"

The date and time that the reservation started.

", "locationName":"start" }, "State":{ "shape":"ReservationState", "documentation":"

The state of the reservation.

", "locationName":"state" } }, "documentation":"

Details about the Dedicated Host Reservation and associated Dedicated Hosts.

" }, "HostReservationIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "HostReservationSet":{ "type":"list", "member":{"shape":"HostReservation"} }, "HostTenancy":{ "type":"string", "enum":[ "dedicated", "host" ] }, "HypervisorType":{ "type":"string", "enum":[ "ovm", "xen" ] }, "IamInstanceProfile":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", "locationName":"arn" }, "Id":{ "shape":"String", "documentation":"

The ID of the instance profile.

", "locationName":"id" } }, "documentation":"

Describes an IAM instance profile.

" }, "IamInstanceProfileSpecification":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", "locationName":"arn" }, "Name":{ "shape":"String", "documentation":"

The name of the instance profile.

", "locationName":"name" } }, "documentation":"

Describes an IAM instance profile.

" }, "IcmpTypeCode":{ "type":"structure", "members":{ "Type":{ "shape":"Integer", "documentation":"

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", "locationName":"type" }, "Code":{ "shape":"Integer", "documentation":"

The ICMP type. A value of -1 means all types.

", "locationName":"code" } }, "documentation":"

Describes the ICMP type and code.

" }, "IdFormat":{ "type":"structure", "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource.

", "locationName":"resource" }, "UseLongIds":{ "shape":"Boolean", "documentation":"

Indicates whether longer IDs (17-character IDs) are enabled for the resource.

", "locationName":"useLongIds" }, "Deadline":{ "shape":"DateTime", "documentation":"

The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.

", "locationName":"deadline" } }, "documentation":"

Describes the ID format for a resource.

" }, "IdFormatList":{ "type":"list", "member":{ "shape":"IdFormat", "locationName":"item" } }, "Image":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "ImageLocation":{ "shape":"String", "documentation":"

The location of the AMI.

", "locationName":"imageLocation" }, "State":{ "shape":"ImageState", "documentation":"

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", "locationName":"imageState" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the image owner.

", "locationName":"imageOwnerId" }, "CreationDate":{ "shape":"String", "documentation":"

The date and time the image was created.

", "locationName":"creationDate" }, "Public":{ "shape":"Boolean", "documentation":"

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

", "locationName":"isPublic" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

Any product codes associated with the AMI.

", "locationName":"productCodes" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the image.

", "locationName":"architecture" }, "ImageType":{ "shape":"ImageTypeValues", "documentation":"

The type of image.

", "locationName":"imageType" }, "KernelId":{ "shape":"String", "documentation":"

The kernel associated with the image, if any. Only applicable for machine images.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The RAM disk associated with the image, if any. Only applicable for machine images.

", "locationName":"ramdiskId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The value is Windows for Windows AMIs; otherwise blank.

", "locationName":"platform" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", "locationName":"sriovNetSupport" }, "EnaSupport":{ "shape":"Boolean", "documentation":"

Specifies whether enhanced networking with ENA is enabled.

", "locationName":"enaSupport" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason for the state change.

", "locationName":"stateReason" }, "ImageOwnerAlias":{ "shape":"String", "documentation":"

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

", "locationName":"imageOwnerAlias" }, "Name":{ "shape":"String", "documentation":"

The name of the AMI that was provided during image creation.

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

The description of the AMI that was provided during image creation.

", "locationName":"description" }, "RootDeviceType":{ "shape":"DeviceType", "documentation":"

The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

", "locationName":"rootDeviceType" }, "RootDeviceName":{ "shape":"String", "documentation":"

The device name of the root device (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

Any block device mapping entries.

", "locationName":"blockDeviceMapping" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The type of virtualization of the AMI.

", "locationName":"virtualizationType" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the image.

", "locationName":"tagSet" }, "Hypervisor":{ "shape":"HypervisorType", "documentation":"

The hypervisor type of the image.

", "locationName":"hypervisor" } }, "documentation":"

Describes an image.

" }, "ImageAttribute":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "LaunchPermissions":{ "shape":"LaunchPermissionList", "documentation":"

One or more launch permissions.

", "locationName":"launchPermission" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

One or more product codes.

", "locationName":"productCodes" }, "KernelId":{ "shape":"AttributeValue", "documentation":"

The kernel ID.

", "locationName":"kernel" }, "RamdiskId":{ "shape":"AttributeValue", "documentation":"

The RAM disk ID.

", "locationName":"ramdisk" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the AMI.

", "locationName":"description" }, "SriovNetSupport":{ "shape":"AttributeValue", "documentation":"

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", "locationName":"sriovNetSupport" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" } }, "documentation":"

Describes an image attribute.

" }, "ImageAttributeName":{ "type":"string", "enum":[ "description", "kernel", "ramdisk", "launchPermission", "productCodes", "blockDeviceMapping", "sriovNetSupport" ] }, "ImageDiskContainer":{ "type":"structure", "members":{ "Description":{ "shape":"String", "documentation":"

The description of the disk image.

" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" }, "Url":{ "shape":"String", "documentation":"

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)

" }, "UserBucket":{ "shape":"UserBucket", "documentation":"

The S3 bucket for the disk image.

" }, "DeviceName":{ "shape":"String", "documentation":"

The block device mapping for the disk.

" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot to be used for importing the snapshot.

" } }, "documentation":"

Describes the disk container object for an import image task.

" }, "ImageDiskContainerList":{ "type":"list", "member":{ "shape":"ImageDiskContainer", "locationName":"item" } }, "ImageIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ImageId" } }, "ImageList":{ "type":"list", "member":{ "shape":"Image", "locationName":"item" } }, "ImageState":{ "type":"string", "enum":[ "pending", "available", "invalid", "deregistered", "transient", "failed", "error" ] }, "ImageTypeValues":{ "type":"string", "enum":[ "machine", "kernel", "ramdisk" ] }, "ImportImageRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "Description":{ "shape":"String", "documentation":"

A description string for the import image task.

" }, "DiskContainers":{ "shape":"ImageDiskContainerList", "documentation":"

Information about the disk containers.

", "locationName":"DiskContainer" }, "LicenseType":{ "shape":"String", "documentation":"

The license type to be used for the Amazon Machine Image (AMI) after importing.

Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

Valid values: AWS | BYOL

" }, "Hypervisor":{ "shape":"String", "documentation":"

The target hypervisor platform.

Valid values: xen

" }, "Architecture":{ "shape":"String", "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

" }, "Platform":{ "shape":"String", "documentation":"

The operating system of the virtual machine.

Valid values: Windows | Linux

" }, "ClientData":{ "shape":"ClientData", "documentation":"

The client-specific data.

" }, "ClientToken":{ "shape":"String", "documentation":"

The token to enable idempotency for VM import requests.

" }, "RoleName":{ "shape":"String", "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" } }, "documentation":"

Contains the parameters for ImportImage.

" }, "ImportImageResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The task ID of the import image task.

", "locationName":"importTaskId" }, "Architecture":{ "shape":"String", "documentation":"

The architecture of the virtual machine.

", "locationName":"architecture" }, "LicenseType":{ "shape":"String", "documentation":"

The license type of the virtual machine.

", "locationName":"licenseType" }, "Platform":{ "shape":"String", "documentation":"

The operating system of the virtual machine.

", "locationName":"platform" }, "Hypervisor":{ "shape":"String", "documentation":"

The target hypervisor of the import task.

", "locationName":"hypervisor" }, "Description":{ "shape":"String", "documentation":"

A description of the import task.

", "locationName":"description" }, "SnapshotDetails":{ "shape":"SnapshotDetailList", "documentation":"

Information about the snapshots.

", "locationName":"snapshotDetailSet" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the Amazon Machine Image (AMI) created by the import task.

", "locationName":"imageId" }, "Progress":{ "shape":"String", "documentation":"

The progress of the task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message of the import task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status of the task.

", "locationName":"status" } }, "documentation":"

Contains the output for ImportImage.

" }, "ImportImageTask":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import image task.

", "locationName":"importTaskId" }, "Architecture":{ "shape":"String", "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

", "locationName":"architecture" }, "LicenseType":{ "shape":"String", "documentation":"

The license type of the virtual machine.

", "locationName":"licenseType" }, "Platform":{ "shape":"String", "documentation":"

The description string for the import image task.

", "locationName":"platform" }, "Hypervisor":{ "shape":"String", "documentation":"

The target hypervisor for the import task.

Valid values: xen

", "locationName":"hypervisor" }, "Description":{ "shape":"String", "documentation":"

A description of the import task.

", "locationName":"description" }, "SnapshotDetails":{ "shape":"SnapshotDetailList", "documentation":"

Information about the snapshots.

", "locationName":"snapshotDetailSet" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

", "locationName":"imageId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of progress of the import image task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A descriptive status message for the import image task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status for the import image task.

", "locationName":"status" } }, "documentation":"

Describes an import image task.

" }, "ImportImageTaskList":{ "type":"list", "member":{ "shape":"ImportImageTask", "locationName":"item" } }, "ImportInstanceLaunchSpecification":{ "type":"structure", "members":{ "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the instance.

", "locationName":"architecture" }, "GroupNames":{ "shape":"SecurityGroupStringList", "documentation":"

One or more security group names.

", "locationName":"GroupName" }, "GroupIds":{ "shape":"SecurityGroupIdStringList", "documentation":"

One or more security group IDs.

", "locationName":"GroupId" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "UserData":{ "shape":"UserData", "documentation":"

The user data to make available to the instance. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"userData" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.

", "locationName":"instanceType" }, "Placement":{ "shape":"Placement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "Monitoring":{ "shape":"Boolean", "documentation":"

Indicates whether monitoring is enabled.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] An available IP address from the IP address range of the subnet.

", "locationName":"privateIpAddress" } }, "documentation":"

Describes the launch specification for VM import.

" }, "ImportInstanceRequest":{ "type":"structure", "required":["Platform"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Description":{ "shape":"String", "documentation":"

A description for the instance being imported.

", "locationName":"description" }, "LaunchSpecification":{ "shape":"ImportInstanceLaunchSpecification", "documentation":"

The launch specification.

", "locationName":"launchSpecification" }, "DiskImages":{ "shape":"DiskImageList", "documentation":"

The disk image.

", "locationName":"diskImage" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The instance operating system.

", "locationName":"platform" } }, "documentation":"

Contains the parameters for ImportInstance.

" }, "ImportInstanceResult":{ "type":"structure", "members":{ "ConversionTask":{ "shape":"ConversionTask", "documentation":"

Information about the conversion task.

", "locationName":"conversionTask" } }, "documentation":"

Contains the output for ImportInstance.

" }, "ImportInstanceTaskDetails":{ "type":"structure", "required":["Volumes"], "members":{ "Volumes":{ "shape":"ImportInstanceVolumeDetailSet", "documentation":"

One or more volumes.

", "locationName":"volumes" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The instance operating system.

", "locationName":"platform" }, "Description":{ "shape":"String", "documentation":"

A description of the task.

", "locationName":"description" } }, "documentation":"

Describes an import instance task.

" }, "ImportInstanceVolumeDetailItem":{ "type":"structure", "required":[ "BytesConverted", "AvailabilityZone", "Image", "Volume", "Status" ], "members":{ "BytesConverted":{ "shape":"Long", "documentation":"

The number of bytes converted so far.

", "locationName":"bytesConverted" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the resulting instance will reside.

", "locationName":"availabilityZone" }, "Image":{ "shape":"DiskImageDescription", "documentation":"

The image.

", "locationName":"image" }, "Volume":{ "shape":"DiskImageVolumeDescription", "documentation":"

The volume.

", "locationName":"volume" }, "Status":{ "shape":"String", "documentation":"

The status of the import of this particular disk image.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The status information or errors related to the disk image.

", "locationName":"statusMessage" }, "Description":{ "shape":"String", "documentation":"

A description of the task.

", "locationName":"description" } }, "documentation":"

Describes an import volume task.

" }, "ImportInstanceVolumeDetailSet":{ "type":"list", "member":{ "shape":"ImportInstanceVolumeDetailItem", "locationName":"item" } }, "ImportKeyPairRequest":{ "type":"structure", "required":[ "KeyName", "PublicKeyMaterial" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

A unique name for the key pair.

", "locationName":"keyName" }, "PublicKeyMaterial":{ "shape":"Blob", "documentation":"

The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.

", "locationName":"publicKeyMaterial" } }, "documentation":"

Contains the parameters for ImportKeyPair.

" }, "ImportKeyPairResult":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The key pair name you provided.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", "locationName":"keyFingerprint" } }, "documentation":"

Contains the output of ImportKeyPair.

" }, "ImportSnapshotRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "Description":{ "shape":"String", "documentation":"

The description string for the import snapshot task.

" }, "DiskContainer":{ "shape":"SnapshotDiskContainer", "documentation":"

Information about the disk container.

" }, "ClientData":{ "shape":"ClientData", "documentation":"

The client-specific data.

" }, "ClientToken":{ "shape":"String", "documentation":"

Token to enable idempotency for VM import requests.

" }, "RoleName":{ "shape":"String", "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" } }, "documentation":"

Contains the parameters for ImportSnapshot.

" }, "ImportSnapshotResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import snapshot task.

", "locationName":"importTaskId" }, "SnapshotTaskDetail":{ "shape":"SnapshotTaskDetail", "documentation":"

Information about the import snapshot task.

", "locationName":"snapshotTaskDetail" }, "Description":{ "shape":"String", "documentation":"

A description of the import snapshot task.

", "locationName":"description" } }, "documentation":"

Contains the output for ImportSnapshot.

" }, "ImportSnapshotTask":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import snapshot task.

", "locationName":"importTaskId" }, "SnapshotTaskDetail":{ "shape":"SnapshotTaskDetail", "documentation":"

Describes an import snapshot task.

", "locationName":"snapshotTaskDetail" }, "Description":{ "shape":"String", "documentation":"

A description of the import snapshot task.

", "locationName":"description" } }, "documentation":"

Describes an import snapshot task.

" }, "ImportSnapshotTaskList":{ "type":"list", "member":{ "shape":"ImportSnapshotTask", "locationName":"item" } }, "ImportTaskIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"ImportTaskId" } }, "ImportVolumeRequest":{ "type":"structure", "required":[ "AvailabilityZone", "Image", "Volume" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the resulting EBS volume.

", "locationName":"availabilityZone" }, "Image":{ "shape":"DiskImageDetail", "documentation":"

The disk image.

", "locationName":"image" }, "Description":{ "shape":"String", "documentation":"

A description of the volume.

", "locationName":"description" }, "Volume":{ "shape":"VolumeDetail", "documentation":"

The volume size.

", "locationName":"volume" } }, "documentation":"

Contains the parameters for ImportVolume.

" }, "ImportVolumeResult":{ "type":"structure", "members":{ "ConversionTask":{ "shape":"ConversionTask", "documentation":"

Information about the conversion task.

", "locationName":"conversionTask" } }, "documentation":"

Contains the output for ImportVolume.

" }, "ImportVolumeTaskDetails":{ "type":"structure", "required":[ "BytesConverted", "AvailabilityZone", "Image", "Volume" ], "members":{ "BytesConverted":{ "shape":"Long", "documentation":"

The number of bytes converted so far.

", "locationName":"bytesConverted" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the resulting volume will reside.

", "locationName":"availabilityZone" }, "Description":{ "shape":"String", "documentation":"

The description you provided when starting the import volume task.

", "locationName":"description" }, "Image":{ "shape":"DiskImageDescription", "documentation":"

The image.

", "locationName":"image" }, "Volume":{ "shape":"DiskImageVolumeDescription", "documentation":"

The volume.

", "locationName":"volume" } }, "documentation":"

Describes an import volume task.

" }, "Instance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI used to launch the instance.

", "locationName":"imageId" }, "State":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

", "locationName":"instanceState" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

", "locationName":"privateDnsName" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

", "locationName":"dnsName" }, "StateTransitionReason":{ "shape":"String", "documentation":"

The reason for the most recent state transition. This might be an empty string.

", "locationName":"reason" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair, if this instance was launched with an associated key pair.

", "locationName":"keyName" }, "AmiLaunchIndex":{ "shape":"Integer", "documentation":"

The AMI launch index, which can be used to find this instance in the launch group.

", "locationName":"amiLaunchIndex" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

The product codes attached to this instance, if applicable.

", "locationName":"productCodes" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "LaunchTime":{ "shape":"DateTime", "documentation":"

The time the instance was launched.

", "locationName":"launchTime" }, "Placement":{ "shape":"Placement", "documentation":"

The location where the instance launched, if applicable.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The kernel associated with this instance, if applicable.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The RAM disk associated with this instance, if applicable.

", "locationName":"ramdiskId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The value is Windows for Windows instances; otherwise blank.

", "locationName":"platform" }, "Monitoring":{ "shape":"Monitoring", "documentation":"

The monitoring information for the instance.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet in which the instance is running.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC in which the instance is running.

", "locationName":"vpcId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address assigned to the instance.

", "locationName":"privateIpAddress" }, "PublicIpAddress":{ "shape":"String", "documentation":"

The public IP address assigned to the instance, if applicable.

", "locationName":"ipAddress" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason for the most recent state transition.

", "locationName":"stateReason" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the image.

", "locationName":"architecture" }, "RootDeviceType":{ "shape":"DeviceType", "documentation":"

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

", "locationName":"rootDeviceType" }, "RootDeviceName":{ "shape":"String", "documentation":"

The root device name (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"

Any block device mapping entries for the instance.

", "locationName":"blockDeviceMapping" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The virtualization type of the instance.

", "locationName":"virtualizationType" }, "InstanceLifecycle":{ "shape":"InstanceLifecycleType", "documentation":"

Indicates whether this is a Spot instance or a Scheduled Instance.

", "locationName":"instanceLifecycle" }, "SpotInstanceRequestId":{ "shape":"String", "documentation":"

If the request is a Spot instance request, the ID of the request.

", "locationName":"spotInstanceRequestId" }, "ClientToken":{ "shape":"String", "documentation":"

The idempotency token you provided when you launched the instance, if applicable.

", "locationName":"clientToken" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the instance.

", "locationName":"tagSet" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups for the instance.

", "locationName":"groupSet" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", "locationName":"sourceDestCheck" }, "Hypervisor":{ "shape":"HypervisorType", "documentation":"

The hypervisor type of the instance.

", "locationName":"hypervisor" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceList", "documentation":"

[EC2-VPC] One or more network interfaces for the instance.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfile", "documentation":"

The IAM instance profile associated with the instance, if applicable.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", "locationName":"sriovNetSupport" }, "EnaSupport":{ "shape":"Boolean", "documentation":"

Specifies whether enhanced networking with ENA is enabled.

", "locationName":"enaSupport" } }, "documentation":"

Describes an instance.

" }, "InstanceAttribute":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "InstanceType":{ "shape":"AttributeValue", "documentation":"

The instance type.

", "locationName":"instanceType" }, "KernelId":{ "shape":"AttributeValue", "documentation":"

The kernel ID.

", "locationName":"kernel" }, "RamdiskId":{ "shape":"AttributeValue", "documentation":"

The RAM disk ID.

", "locationName":"ramdisk" }, "UserData":{ "shape":"AttributeValue", "documentation":"

The user data.

", "locationName":"userData" }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", "documentation":"

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ "shape":"AttributeValue", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "RootDeviceName":{ "shape":"AttributeValue", "documentation":"

The name of the root device (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"

The block device mapping of the instance.

", "locationName":"blockDeviceMapping" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" }, "EbsOptimized":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instance is optimized for EBS I/O.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"AttributeValue", "documentation":"

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", "locationName":"sriovNetSupport" }, "EnaSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether enhanced networking with ENA is enabled.

", "locationName":"enaSupport" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

The security groups associated with the instance.

", "locationName":"groupSet" } }, "documentation":"

Describes an instance attribute.

" }, "InstanceAttributeName":{ "type":"string", "enum":[ "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "rootDeviceName", "blockDeviceMapping", "productCodes", "sourceDestCheck", "groupSet", "ebsOptimized", "sriovNetSupport", "enaSupport" ] }, "InstanceBlockDeviceMapping":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsInstanceBlockDevice", "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", "locationName":"ebs" } }, "documentation":"

Describes a block device mapping.

" }, "InstanceBlockDeviceMappingList":{ "type":"list", "member":{ "shape":"InstanceBlockDeviceMapping", "locationName":"item" } }, "InstanceBlockDeviceMappingSpecification":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsInstanceBlockDeviceSpecification", "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", "locationName":"ebs" }, "VirtualName":{ "shape":"String", "documentation":"

The virtual device name.

", "locationName":"virtualName" }, "NoDevice":{ "shape":"String", "documentation":"

suppress the specified device included in the block device mapping.

", "locationName":"noDevice" } }, "documentation":"

Describes a block device mapping entry.

" }, "InstanceBlockDeviceMappingSpecificationList":{ "type":"list", "member":{ "shape":"InstanceBlockDeviceMappingSpecification", "locationName":"item" } }, "InstanceCapacity":{ "type":"structure", "members":{ "InstanceType":{ "shape":"String", "documentation":"

The instance type size supported by the Dedicated Host.

", "locationName":"instanceType" }, "AvailableCapacity":{ "shape":"Integer", "documentation":"

The number of instances that can still be launched onto the Dedicated Host.

", "locationName":"availableCapacity" }, "TotalCapacity":{ "shape":"Integer", "documentation":"

The total number of instances that can be launched onto the Dedicated Host.

", "locationName":"totalCapacity" } }, "documentation":"

Information about the instance type that the Dedicated Host supports.

" }, "InstanceCount":{ "type":"structure", "members":{ "State":{ "shape":"ListingState", "documentation":"

The states of the listed Reserved Instances.

", "locationName":"state" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of listed Reserved Instances in the state specified by the state.

", "locationName":"instanceCount" } }, "documentation":"

Describes a Reserved Instance listing state.

" }, "InstanceCountList":{ "type":"list", "member":{ "shape":"InstanceCount", "locationName":"item" } }, "InstanceExportDetails":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the resource being exported.

", "locationName":"instanceId" }, "TargetEnvironment":{ "shape":"ExportEnvironment", "documentation":"

The target virtualization environment.

", "locationName":"targetEnvironment" } }, "documentation":"

Describes an instance to export.

" }, "InstanceIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "InstanceIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"InstanceId" } }, "InstanceLifecycleType":{ "type":"string", "enum":[ "spot", "scheduled" ] }, "InstanceList":{ "type":"list", "member":{ "shape":"Instance", "locationName":"item" } }, "InstanceMonitoring":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Monitoring":{ "shape":"Monitoring", "documentation":"

The monitoring information.

", "locationName":"monitoring" } }, "documentation":"

Describes the monitoring information of the instance.

" }, "InstanceMonitoringList":{ "type":"list", "member":{ "shape":"InstanceMonitoring", "locationName":"item" } }, "InstanceNetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Description":{ "shape":"String", "documentation":"

The description.

", "locationName":"description" }, "OwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that created the network interface.

", "locationName":"ownerId" }, "Status":{ "shape":"NetworkInterfaceStatus", "documentation":"

The status of the network interface.

", "locationName":"status" }, "MacAddress":{ "shape":"String", "documentation":"

The MAC address.

", "locationName":"macAddress" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Indicates whether to validate network traffic to or from this network interface.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups.

", "locationName":"groupSet" }, "Attachment":{ "shape":"InstanceNetworkInterfaceAttachment", "documentation":"

The network interface attachment.

", "locationName":"attachment" }, "Association":{ "shape":"InstanceNetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP associated with the network interface.

", "locationName":"association" }, "PrivateIpAddresses":{ "shape":"InstancePrivateIpAddressList", "documentation":"

The private IP addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" } }, "documentation":"

Describes a network interface.

" }, "InstanceNetworkInterfaceAssociation":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The public IP address or Elastic IP address bound to the network interface.

", "locationName":"publicIp" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name.

", "locationName":"publicDnsName" }, "IpOwnerId":{ "shape":"String", "documentation":"

The ID of the owner of the Elastic IP address.

", "locationName":"ipOwnerId" } }, "documentation":"

Describes association information for an Elastic IP address.

" }, "InstanceNetworkInterfaceAttachment":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device on the instance for the network interface attachment.

", "locationName":"deviceIndex" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a network interface attachment.

" }, "InstanceNetworkInterfaceList":{ "type":"list", "member":{ "shape":"InstanceNetworkInterface", "locationName":"item" } }, "InstanceNetworkInterfaceSpecification":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

", "locationName":"deviceIndex" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

", "locationName":"subnetId" }, "Description":{ "shape":"String", "documentation":"

The description of the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"description" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"privateIpAddress" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"SecurityGroupId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

", "locationName":"deleteOnTermination" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", "documentation":"

One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.

", "locationName":"privateIpAddressesSet", "queryName":"PrivateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.

", "locationName":"secondaryPrivateIpAddressCount" }, "AssociatePublicIpAddress":{ "shape":"Boolean", "documentation":"

Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

", "locationName":"associatePublicIpAddress" } }, "documentation":"

Describes a network interface.

" }, "InstanceNetworkInterfaceSpecificationList":{ "type":"list", "member":{ "shape":"InstanceNetworkInterfaceSpecification", "locationName":"item" } }, "InstancePrivateIpAddress":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the network interface.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", "locationName":"primary" }, "Association":{ "shape":"InstanceNetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address for the network interface.

", "locationName":"association" } }, "documentation":"

Describes a private IP address.

" }, "InstancePrivateIpAddressList":{ "type":"list", "member":{ "shape":"InstancePrivateIpAddress", "locationName":"item" } }, "InstanceState":{ "type":"structure", "members":{ "Code":{ "shape":"Integer", "documentation":"

The low byte represents the state. The high byte is an opaque internal value and should be ignored.

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

", "locationName":"code" }, "Name":{ "shape":"InstanceStateName", "documentation":"

The current state of the instance.

", "locationName":"name" } }, "documentation":"

Describes the current state of the instance.

" }, "InstanceStateChange":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "CurrentState":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

", "locationName":"currentState" }, "PreviousState":{ "shape":"InstanceState", "documentation":"

The previous state of the instance.

", "locationName":"previousState" } }, "documentation":"

Describes an instance state change.

" }, "InstanceStateChangeList":{ "type":"list", "member":{ "shape":"InstanceStateChange", "locationName":"item" } }, "InstanceStateName":{ "type":"string", "enum":[ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ] }, "InstanceStatus":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the instance.

", "locationName":"availabilityZone" }, "Events":{ "shape":"InstanceStatusEventList", "documentation":"

Any scheduled events associated with the instance.

", "locationName":"eventsSet" }, "InstanceState":{ "shape":"InstanceState", "documentation":"

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

", "locationName":"instanceState" }, "SystemStatus":{ "shape":"InstanceStatusSummary", "documentation":"

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

", "locationName":"systemStatus" }, "InstanceStatus":{ "shape":"InstanceStatusSummary", "documentation":"

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

", "locationName":"instanceStatus" } }, "documentation":"

Describes the status of an instance.

" }, "InstanceStatusDetails":{ "type":"structure", "members":{ "Name":{ "shape":"StatusName", "documentation":"

The type of instance status.

", "locationName":"name" }, "Status":{ "shape":"StatusType", "documentation":"

The status.

", "locationName":"status" }, "ImpairedSince":{ "shape":"DateTime", "documentation":"

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

", "locationName":"impairedSince" } }, "documentation":"

Describes the instance status.

" }, "InstanceStatusDetailsList":{ "type":"list", "member":{ "shape":"InstanceStatusDetails", "locationName":"item" } }, "InstanceStatusEvent":{ "type":"structure", "members":{ "Code":{ "shape":"EventCode", "documentation":"

The event code.

", "locationName":"code" }, "Description":{ "shape":"String", "documentation":"

A description of the event.

After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].

", "locationName":"description" }, "NotBefore":{ "shape":"DateTime", "documentation":"

The earliest scheduled start time for the event.

", "locationName":"notBefore" }, "NotAfter":{ "shape":"DateTime", "documentation":"

The latest scheduled end time for the event.

", "locationName":"notAfter" } }, "documentation":"

Describes a scheduled event for an instance.

" }, "InstanceStatusEventList":{ "type":"list", "member":{ "shape":"InstanceStatusEvent", "locationName":"item" } }, "InstanceStatusList":{ "type":"list", "member":{ "shape":"InstanceStatus", "locationName":"item" } }, "InstanceStatusSummary":{ "type":"structure", "members":{ "Status":{ "shape":"SummaryStatus", "documentation":"

The status.

", "locationName":"status" }, "Details":{ "shape":"InstanceStatusDetailsList", "documentation":"

The system instance health or application instance health.

", "locationName":"details" } }, "documentation":"

Describes the status of an instance.

" }, "InstanceType":{ "type":"string", "enum":[ "t1.micro", "t2.nano", "t2.micro", "t2.small", "t2.medium", "t2.large", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m2.xlarge", "m2.2xlarge", "m2.4xlarge", "cr1.8xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "x1.4xlarge", "x1.8xlarge", "x1.16xlarge", "x1.32xlarge", "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", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "g2.8xlarge", "cg1.4xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge" ] }, "InstanceTypeList":{ "type":"list", "member":{"shape":"InstanceType"} }, "Integer":{"type":"integer"}, "InternetGateway":{ "type":"structure", "members":{ "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "Attachments":{ "shape":"InternetGatewayAttachmentList", "documentation":"

Any VPCs attached to the Internet gateway.

", "locationName":"attachmentSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the Internet gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes an Internet gateway.

" }, "InternetGatewayAttachment":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"AttachmentStatus", "documentation":"

The current state of the attachment.

", "locationName":"state" } }, "documentation":"

Describes the attachment of a VPC to an Internet gateway.

" }, "InternetGatewayAttachmentList":{ "type":"list", "member":{ "shape":"InternetGatewayAttachment", "locationName":"item" } }, "InternetGatewayList":{ "type":"list", "member":{ "shape":"InternetGateway", "locationName":"item" } }, "IpPermission":{ "type":"structure", "members":{ "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

[EC2-VPC only] When you authorize or revoke security group rules, you can use -1 to specify all.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

", "locationName":"toPort" }, "UserIdGroupPairs":{ "shape":"UserIdGroupPairList", "documentation":"

One or more security group and AWS account ID pairs.

", "locationName":"groups" }, "IpRanges":{ "shape":"IpRangeList", "documentation":"

One or more IP ranges.

", "locationName":"ipRanges" }, "PrefixListIds":{ "shape":"PrefixListIdList", "documentation":"

(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

", "locationName":"prefixListIds" } }, "documentation":"

Describes a security group rule.

" }, "IpPermissionList":{ "type":"list", "member":{ "shape":"IpPermission", "locationName":"item" } }, "IpRange":{ "type":"structure", "members":{ "CidrIp":{ "shape":"String", "documentation":"

The CIDR range. You can either specify a CIDR range or a source security group, not both.

", "locationName":"cidrIp" } }, "documentation":"

Describes an IP range.

" }, "IpRangeList":{ "type":"list", "member":{ "shape":"IpRange", "locationName":"item" } }, "IpRanges":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "KeyNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"KeyName" } }, "KeyPair":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

The SHA-1 digest of the DER encoded private key.

", "locationName":"keyFingerprint" }, "KeyMaterial":{ "shape":"String", "documentation":"

An unencrypted PEM encoded RSA private key.

", "locationName":"keyMaterial" } }, "documentation":"

Describes a key pair.

" }, "KeyPairInfo":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", "locationName":"keyFingerprint" } }, "documentation":"

Describes a key pair.

" }, "KeyPairList":{ "type":"list", "member":{ "shape":"KeyPairInfo", "locationName":"item" } }, "LaunchPermission":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The AWS account ID.

", "locationName":"userId" }, "Group":{ "shape":"PermissionGroup", "documentation":"

The name of the group.

", "locationName":"group" } }, "documentation":"

Describes a launch permission.

" }, "LaunchPermissionList":{ "type":"list", "member":{ "shape":"LaunchPermission", "locationName":"item" } }, "LaunchPermissionModifications":{ "type":"structure", "members":{ "Add":{ "shape":"LaunchPermissionList", "documentation":"

The AWS account ID to add to the list of launch permissions for the AMI.

" }, "Remove":{ "shape":"LaunchPermissionList", "documentation":"

The AWS account ID to remove from the list of launch permissions for the AMI.

" } }, "documentation":"

Describes a launch permission modification.

" }, "LaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", "locationName":"groupSet" }, "UserData":{ "shape":"String", "documentation":"

The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.

", "locationName":"blockDeviceMapping" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" } }, "documentation":"

Describes the launch specification for an instance.

" }, "LaunchSpecsList":{ "type":"list", "member":{ "shape":"SpotFleetLaunchSpecification", "locationName":"item" }, "min":1 }, "ListingState":{ "type":"string", "enum":[ "available", "sold", "cancelled", "pending" ] }, "ListingStatus":{ "type":"string", "enum":[ "active", "pending", "cancelled", "closed" ] }, "Long":{"type":"long"}, "MaxResults":{ "type":"integer", "max":255, "min":5 }, "ModifyHostsRequest":{ "type":"structure", "required":[ "HostIds", "AutoPlacement" ], "members":{ "HostIds":{ "shape":"RequestHostIdList", "documentation":"

The host IDs of the Dedicated Hosts you want to modify.

", "locationName":"hostId" }, "AutoPlacement":{ "shape":"AutoPlacement", "documentation":"

Specify whether to enable or disable auto-placement.

", "locationName":"autoPlacement" } }, "documentation":"

Contains the parameters for ModifyHosts.

" }, "ModifyHostsResult":{ "type":"structure", "members":{ "Successful":{ "shape":"ResponseHostIdList", "documentation":"

The IDs of the Dedicated Hosts that were successfully modified.

", "locationName":"successful" }, "Unsuccessful":{ "shape":"UnsuccessfulItemList", "documentation":"

The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of ModifyHosts.

" }, "ModifyIdFormatRequest":{ "type":"structure", "required":[ "Resource", "UseLongIds" ], "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource: instance | reservation | snapshot | volume

" }, "UseLongIds":{ "shape":"Boolean", "documentation":"

Indicate whether the resource should use longer IDs (17-character IDs).

" } }, "documentation":"

Contains the parameters of ModifyIdFormat.

" }, "ModifyIdentityIdFormatRequest":{ "type":"structure", "required":[ "Resource", "UseLongIds", "PrincipalArn" ], "members":{ "Resource":{ "shape":"String", "documentation":"

The type of resource: instance | reservation | snapshot | volume

", "locationName":"resource" }, "UseLongIds":{ "shape":"Boolean", "documentation":"

Indicates whether the resource should use longer IDs (17-character IDs)

", "locationName":"useLongIds" }, "PrincipalArn":{ "shape":"String", "documentation":"

The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account.

", "locationName":"principalArn" } }, "documentation":"

Contains the parameters of ModifyIdentityIdFormat.

" }, "ModifyImageAttributeRequest":{ "type":"structure", "required":["ImageId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"String", "documentation":"

The name of the attribute to modify.

" }, "OperationType":{ "shape":"OperationType", "documentation":"

The operation type.

" }, "UserIds":{ "shape":"UserIdStringList", "documentation":"

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

", "locationName":"UserId" }, "UserGroups":{ "shape":"UserGroupStringList", "documentation":"

One or more user groups. This is only valid when modifying the launchPermission attribute.

", "locationName":"UserGroup" }, "ProductCodes":{ "shape":"ProductCodeStringList", "documentation":"

One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

", "locationName":"ProductCode" }, "Value":{ "shape":"String", "documentation":"

The value of the attribute being modified. This is only valid when modifying the description attribute.

" }, "LaunchPermission":{ "shape":"LaunchPermissionModifications", "documentation":"

A launch permission modification.

" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the AMI.

" } }, "documentation":"

Contains the parameters for ModifyImageAttribute.

" }, "ModifyInstanceAttributeRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The name of the attribute.

", "locationName":"attribute" }, "Value":{ "shape":"String", "documentation":"

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

", "locationName":"value" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingSpecificationList", "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"blockDeviceMapping" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

" }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", "documentation":"

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this paramater for Spot Instances.

", "locationName":"disableApiTermination" }, "InstanceType":{ "shape":"AttributeValue", "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", "locationName":"instanceType" }, "Kernel":{ "shape":"AttributeValue", "documentation":"

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", "locationName":"kernel" }, "Ramdisk":{ "shape":"AttributeValue", "documentation":"

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", "locationName":"ramdisk" }, "UserData":{ "shape":"BlobAttributeValue", "documentation":"

Changes the instance's user data to the specified value. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"userData" }, "InstanceInitiatedShutdownBehavior":{ "shape":"AttributeValue", "documentation":"

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "Groups":{ "shape":"GroupIdStringList", "documentation":"

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

", "locationName":"GroupId" }, "EbsOptimized":{ "shape":"AttributeBooleanValue", "documentation":"

Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"AttributeValue", "documentation":"

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.

There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", "locationName":"sriovNetSupport" }, "EnaSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Set to true to enable enhanced networking with ENA for the instance.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", "locationName":"enaSupport" } }, "documentation":"

Contains the parameters for ModifyInstanceAttribute.

" }, "ModifyInstancePlacementRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance that you are modifying.

", "locationName":"instanceId" }, "Tenancy":{ "shape":"HostTenancy", "documentation":"

The tenancy of the instance that you are modifying.

", "locationName":"tenancy" }, "Affinity":{ "shape":"Affinity", "documentation":"

The new affinity setting for the instance.

", "locationName":"affinity" }, "HostId":{ "shape":"String", "documentation":"

The ID of the Dedicated Host that the instance will have affinity with.

", "locationName":"hostId" } }, "documentation":"

Contains the parameters for ModifyInstancePlacement.

" }, "ModifyInstancePlacementResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Is true if the request succeeds, and an error otherwise.

", "locationName":"return" } }, "documentation":"

Contains the output of ModifyInstancePlacement.

" }, "ModifyNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the network interface.

", "locationName":"description" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", "locationName":"SecurityGroupId" }, "Attachment":{ "shape":"NetworkInterfaceAttachmentChanges", "documentation":"

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

", "locationName":"attachment" } }, "documentation":"

Contains the parameters for ModifyNetworkInterfaceAttribute.

" }, "ModifyReservedInstancesRequest":{ "type":"structure", "required":[ "ReservedInstancesIds", "TargetConfigurations" ], "members":{ "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" }, "ReservedInstancesIds":{ "shape":"ReservedInstancesIdStringList", "documentation":"

The IDs of the Reserved Instances to modify.

", "locationName":"ReservedInstancesId" }, "TargetConfigurations":{ "shape":"ReservedInstancesConfigurationList", "documentation":"

The configuration settings for the Reserved Instances to modify.

", "locationName":"ReservedInstancesConfigurationSetItemType" } }, "documentation":"

Contains the parameters for ModifyReservedInstances.

" }, "ModifyReservedInstancesResult":{ "type":"structure", "members":{ "ReservedInstancesModificationId":{ "shape":"String", "documentation":"

The ID for the modification.

", "locationName":"reservedInstancesModificationId" } }, "documentation":"

Contains the output of ModifyReservedInstances.

" }, "ModifySnapshotAttributeRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The snapshot attribute to modify.

Only volume creation permissions may be modified at the customer level.

" }, "OperationType":{ "shape":"OperationType", "documentation":"

The type of operation to perform to the attribute.

" }, "UserIds":{ "shape":"UserIdStringList", "documentation":"

The account ID to modify for the snapshot.

", "locationName":"UserId" }, "GroupNames":{ "shape":"GroupNameStringList", "documentation":"

The group to modify for the snapshot.

", "locationName":"UserGroup" }, "CreateVolumePermission":{ "shape":"CreateVolumePermissionModifications", "documentation":"

A JSON representation of the snapshot attribute modification.

" } }, "documentation":"

Contains the parameters for ModifySnapshotAttribute.

" }, "ModifySpotFleetRequestRequest":{ "type":"structure", "required":["SpotFleetRequestId"], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "TargetCapacity":{ "shape":"Integer", "documentation":"

The size of the fleet.

", "locationName":"targetCapacity" }, "ExcessCapacityTerminationPolicy":{ "shape":"ExcessCapacityTerminationPolicy", "documentation":"

Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.

", "locationName":"excessCapacityTerminationPolicy" } }, "documentation":"

Contains the parameters for ModifySpotFleetRequest.

" }, "ModifySpotFleetRequestResponse":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Is true if the request succeeds, and an error otherwise.

", "locationName":"return" } }, "documentation":"

Contains the output of ModifySpotFleetRequest.

" }, "ModifySubnetAttributeRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "MapPublicIpOnLaunch":{ "shape":"AttributeBooleanValue", "documentation":"

Specify true to indicate that instances launched into the specified subnet should be assigned public IP address.

" } }, "documentation":"

Contains the parameters for ModifySubnetAttribute.

" }, "ModifyVolumeAttributeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "AutoEnableIO":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the volume should be auto-enabled for I/O operations.

" } }, "documentation":"

Contains the parameters for ModifyVolumeAttribute.

" }, "ModifyVpcAttributeRequest":{ "type":"structure", "required":["VpcId"], "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "EnableDnsSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.

" }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.

" } }, "documentation":"

Contains the parameters for ModifyVpcAttribute.

" }, "ModifyVpcEndpointRequest":{ "type":"structure", "required":["VpcEndpointId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcEndpointId":{ "shape":"String", "documentation":"

The ID of the endpoint.

" }, "ResetPolicy":{ "shape":"Boolean", "documentation":"

Specify true to reset the policy document to the default policy. The default policy allows access to the service.

" }, "PolicyDocument":{ "shape":"String", "documentation":"

A policy document to attach to the endpoint. The policy must be in valid JSON format.

" }, "AddRouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route tables IDs to associate with the endpoint.

", "locationName":"AddRouteTableId" }, "RemoveRouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs to disassociate from the endpoint.

", "locationName":"RemoveRouteTableId" } }, "documentation":"

Contains the parameters for ModifyVpcEndpoint.

" }, "ModifyVpcEndpointResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of ModifyVpcEndpoint.

" }, "ModifyVpcPeeringConnectionOptionsRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

" }, "RequesterPeeringConnectionOptions":{ "shape":"PeeringConnectionOptionsRequest", "documentation":"

The VPC peering connection options for the requester VPC.

" }, "AccepterPeeringConnectionOptions":{ "shape":"PeeringConnectionOptionsRequest", "documentation":"

The VPC peering connection options for the accepter VPC.

" } } }, "ModifyVpcPeeringConnectionOptionsResult":{ "type":"structure", "members":{ "RequesterPeeringConnectionOptions":{ "shape":"PeeringConnectionOptions", "documentation":"

Information about the VPC peering connection options for the requester VPC.

", "locationName":"requesterPeeringConnectionOptions" }, "AccepterPeeringConnectionOptions":{ "shape":"PeeringConnectionOptions", "documentation":"

Information about the VPC peering connection options for the accepter VPC.

", "locationName":"accepterPeeringConnectionOptions" } } }, "MonitorInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } }, "documentation":"

Contains the parameters for MonitorInstances.

" }, "MonitorInstancesResult":{ "type":"structure", "members":{ "InstanceMonitorings":{ "shape":"InstanceMonitoringList", "documentation":"

Monitoring information for one or more instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of MonitorInstances.

" }, "Monitoring":{ "type":"structure", "members":{ "State":{ "shape":"MonitoringState", "documentation":"

Indicates whether monitoring is enabled for the instance.

", "locationName":"state" } }, "documentation":"

Describes the monitoring for the instance.

" }, "MonitoringState":{ "type":"string", "enum":[ "disabled", "disabling", "enabled", "pending" ] }, "MoveAddressToVpcRequest":{ "type":"structure", "required":["PublicIp"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" } }, "documentation":"

Contains the parameters for MoveAddressToVpc.

" }, "MoveAddressToVpcResult":{ "type":"structure", "members":{ "AllocationId":{ "shape":"String", "documentation":"

The allocation ID for the Elastic IP address.

", "locationName":"allocationId" }, "Status":{ "shape":"Status", "documentation":"

The status of the move of the IP address.

", "locationName":"status" } }, "documentation":"

Contains the output of MoveAddressToVpc.

" }, "MoveStatus":{ "type":"string", "enum":[ "movingToVpc", "restoringToClassic" ] }, "MovingAddressStatus":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "MoveStatus":{ "shape":"MoveStatus", "documentation":"

The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.

", "locationName":"moveStatus" } }, "documentation":"

Describes the status of a moving Elastic IP address.

" }, "MovingAddressStatusSet":{ "type":"list", "member":{ "shape":"MovingAddressStatus", "locationName":"item" } }, "NatGateway":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC in which the NAT gateway is located.

", "locationName":"vpcId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which the NAT gateway is located.

", "locationName":"subnetId" }, "NatGatewayId":{ "shape":"String", "documentation":"

The ID of the NAT gateway.

", "locationName":"natGatewayId" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The date and time the NAT gateway was created.

", "locationName":"createTime" }, "DeleteTime":{ "shape":"DateTime", "documentation":"

The date and time the NAT gateway was deleted, if applicable.

", "locationName":"deleteTime" }, "NatGatewayAddresses":{ "shape":"NatGatewayAddressList", "documentation":"

Information about the IP addresses and network interface associated with the NAT gateway.

", "locationName":"natGatewayAddressSet" }, "State":{ "shape":"NatGatewayState", "documentation":"

The state of the NAT gateway.

  • pending: The NAT gateway is being created and is not ready to process traffic.

  • failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.

  • available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.

  • deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.

  • deleted: The NAT gateway has been terminated and is no longer processing traffic.

", "locationName":"state" }, "FailureCode":{ "shape":"String", "documentation":"

If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)

", "locationName":"failureCode" }, "FailureMessage":{ "shape":"String", "documentation":"

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

  • For InsufficientFreeAddressesInSubnet: \"Subnet has insufficient free addresses to create this NAT gateway\"

  • For Gateway.NotAttached: \"Network vpc-xxxxxxxx has no Internet gateway attached\"

  • For InvalidAllocationID.NotFound: \"Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway\"

  • For Resource.AlreadyAssociated: \"Elastic IP address eipalloc-xxxxxxxx is already associated\"

  • For InternalError: \"Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again.\"

  • For InvalidSubnetID.NotFound: \"The specified subnet subnet-xxxxxxxx does not exist or could not be found.\"

", "locationName":"failureMessage" }, "ProvisionedBandwidth":{ "shape":"ProvisionedBandwidth", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"provisionedBandwidth" } }, "documentation":"

Describes a NAT gateway.

" }, "NatGatewayAddress":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address associated with the NAT gateway.

", "locationName":"publicIp" }, "AllocationId":{ "shape":"String", "documentation":"

The allocation ID of the Elastic IP address that's associated with the NAT gateway.

", "locationName":"allocationId" }, "PrivateIp":{ "shape":"String", "documentation":"

The private IP address associated with the Elastic IP address.

", "locationName":"privateIp" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface associated with the NAT gateway.

", "locationName":"networkInterfaceId" } }, "documentation":"

Describes the IP addresses and network interface associated with a NAT gateway.

" }, "NatGatewayAddressList":{ "type":"list", "member":{ "shape":"NatGatewayAddress", "locationName":"item" } }, "NatGatewayList":{ "type":"list", "member":{ "shape":"NatGateway", "locationName":"item" } }, "NatGatewayState":{ "type":"string", "enum":[ "pending", "failed", "available", "deleting", "deleted" ] }, "NetworkAcl":{ "type":"structure", "members":{ "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for the network ACL.

", "locationName":"vpcId" }, "IsDefault":{ "shape":"Boolean", "documentation":"

Indicates whether this is the default network ACL for the VPC.

", "locationName":"default" }, "Entries":{ "shape":"NetworkAclEntryList", "documentation":"

One or more entries (rules) in the network ACL.

", "locationName":"entrySet" }, "Associations":{ "shape":"NetworkAclAssociationList", "documentation":"

Any associations between the network ACL and one or more subnets

", "locationName":"associationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the network ACL.

", "locationName":"tagSet" } }, "documentation":"

Describes a network ACL.

" }, "NetworkAclAssociation":{ "type":"structure", "members":{ "NetworkAclAssociationId":{ "shape":"String", "documentation":"

The ID of the association between a network ACL and a subnet.

", "locationName":"networkAclAssociationId" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" } }, "documentation":"

Describes an association between a network ACL and a subnet.

" }, "NetworkAclAssociationList":{ "type":"list", "member":{ "shape":"NetworkAclAssociation", "locationName":"item" } }, "NetworkAclEntry":{ "type":"structure", "members":{ "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The protocol. A value of -1 means all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation.

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code.

", "locationName":"icmpTypeCode" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", "locationName":"portRange" } }, "documentation":"

Describes an entry in a network ACL.

" }, "NetworkAclEntryList":{ "type":"list", "member":{ "shape":"NetworkAclEntry", "locationName":"item" } }, "NetworkAclList":{ "type":"list", "member":{ "shape":"NetworkAcl", "locationName":"item" } }, "NetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "Description":{ "shape":"String", "documentation":"

A description.

", "locationName":"description" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the network interface.

", "locationName":"ownerId" }, "RequesterId":{ "shape":"String", "documentation":"

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", "locationName":"requesterId" }, "RequesterManaged":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is being managed by AWS.

", "locationName":"requesterManaged" }, "Status":{ "shape":"NetworkInterfaceStatus", "documentation":"

The status of the network interface.

", "locationName":"status" }, "MacAddress":{ "shape":"String", "documentation":"

The MAC address.

", "locationName":"macAddress" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Indicates whether traffic to or from the instance is validated.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

Any security groups for the network interface.

", "locationName":"groupSet" }, "Attachment":{ "shape":"NetworkInterfaceAttachment", "documentation":"

The network interface attachment.

", "locationName":"attachment" }, "Association":{ "shape":"NetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP associated with the network interface.

", "locationName":"association" }, "TagSet":{ "shape":"TagList", "documentation":"

Any tags assigned to the network interface.

", "locationName":"tagSet" }, "PrivateIpAddresses":{ "shape":"NetworkInterfacePrivateIpAddressList", "documentation":"

The private IP addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" }, "InterfaceType":{ "shape":"NetworkInterfaceType", "documentation":"

The type of interface.

", "locationName":"interfaceType" } }, "documentation":"

Describes a network interface.

" }, "NetworkInterfaceAssociation":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The address of the Elastic IP address bound to the network interface.

", "locationName":"publicIp" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name.

", "locationName":"publicDnsName" }, "IpOwnerId":{ "shape":"String", "documentation":"

The ID of the Elastic IP address owner.

", "locationName":"ipOwnerId" }, "AllocationId":{ "shape":"String", "documentation":"

The allocation ID.

", "locationName":"allocationId" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID.

", "locationName":"associationId" } }, "documentation":"

Describes association information for an Elastic IP address.

" }, "NetworkInterfaceAttachment":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "InstanceOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the instance.

", "locationName":"instanceOwnerId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The device index of the network interface attachment on the instance.

", "locationName":"deviceIndex" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The timestamp indicating when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a network interface attachment.

" }, "NetworkInterfaceAttachmentChanges":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes an attachment change.

" }, "NetworkInterfaceAttribute":{ "type":"string", "enum":[ "description", "groupSet", "sourceDestCheck", "attachment" ] }, "NetworkInterfaceIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "NetworkInterfaceList":{ "type":"list", "member":{ "shape":"NetworkInterface", "locationName":"item" } }, "NetworkInterfacePrivateIpAddress":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", "locationName":"primary" }, "Association":{ "shape":"NetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address associated with the network interface.

", "locationName":"association" } }, "documentation":"

Describes the private IP address of a network interface.

" }, "NetworkInterfacePrivateIpAddressList":{ "type":"list", "member":{ "shape":"NetworkInterfacePrivateIpAddress", "locationName":"item" } }, "NetworkInterfaceStatus":{ "type":"string", "enum":[ "available", "attaching", "in-use", "detaching" ] }, "NetworkInterfaceType":{ "type":"string", "enum":[ "interface", "natGateway" ] }, "NewDhcpConfiguration":{ "type":"structure", "members":{ "Key":{ "shape":"String", "locationName":"key" }, "Values":{ "shape":"ValueStringList", "locationName":"Value" } } }, "NewDhcpConfigurationList":{ "type":"list", "member":{ "shape":"NewDhcpConfiguration", "locationName":"item" } }, "NextToken":{ "type":"string", "max":1024, "min":1 }, "OccurrenceDayRequestSet":{ "type":"list", "member":{ "shape":"Integer", "locationName":"OccurenceDay" } }, "OccurrenceDaySet":{ "type":"list", "member":{ "shape":"Integer", "locationName":"item" } }, "OfferingTypeValues":{ "type":"string", "enum":[ "Heavy Utilization", "Medium Utilization", "Light Utilization", "No Upfront", "Partial Upfront", "All Upfront" ] }, "OperationType":{ "type":"string", "enum":[ "add", "remove" ] }, "OwnerStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"Owner" } }, "PaymentOption":{ "type":"string", "enum":[ "AllUpfront", "PartialUpfront", "NoUpfront" ] }, "PeeringConnectionOptions":{ "type":"structure", "members":{ "AllowEgressFromLocalClassicLinkToRemoteVpc":{ "shape":"Boolean", "documentation":"

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

", "locationName":"allowEgressFromLocalClassicLinkToRemoteVpc" }, "AllowEgressFromLocalVpcToRemoteClassicLink":{ "shape":"Boolean", "documentation":"

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

", "locationName":"allowEgressFromLocalVpcToRemoteClassicLink" }, "AllowDnsResolutionFromRemoteVpc":{ "shape":"Boolean", "documentation":"

If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

", "locationName":"allowDnsResolutionFromRemoteVpc" } }, "documentation":"

Describes the VPC peering connection options.

" }, "PeeringConnectionOptionsRequest":{ "type":"structure", "members":{ "AllowEgressFromLocalClassicLinkToRemoteVpc":{ "shape":"Boolean", "documentation":"

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

" }, "AllowEgressFromLocalVpcToRemoteClassicLink":{ "shape":"Boolean", "documentation":"

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

" }, "AllowDnsResolutionFromRemoteVpc":{ "shape":"Boolean", "documentation":"

If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

" } }, "documentation":"

The VPC peering connection options.

" }, "PermissionGroup":{ "type":"string", "enum":["all"] }, "Placement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the instance.

", "locationName":"availabilityZone" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group the instance is in (for cluster compute instances).

", "locationName":"groupName" }, "Tenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

", "locationName":"tenancy" }, "HostId":{ "shape":"String", "documentation":"

The ID of the Dedicted host on which the instance resides. This parameter is not support for the ImportInstance command.

", "locationName":"hostId" }, "Affinity":{ "shape":"String", "documentation":"

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

", "locationName":"affinity" } }, "documentation":"

Describes the placement for the instance.

" }, "PlacementGroup":{ "type":"structure", "members":{ "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"

The placement strategy.

", "locationName":"strategy" }, "State":{ "shape":"PlacementGroupState", "documentation":"

The state of the placement group.

", "locationName":"state" } }, "documentation":"

Describes a placement group.

" }, "PlacementGroupList":{ "type":"list", "member":{ "shape":"PlacementGroup", "locationName":"item" } }, "PlacementGroupState":{ "type":"string", "enum":[ "pending", "available", "deleting", "deleted" ] }, "PlacementGroupStringList":{ "type":"list", "member":{"shape":"String"} }, "PlacementStrategy":{ "type":"string", "enum":["cluster"] }, "PlatformValues":{ "type":"string", "enum":["Windows"] }, "PortRange":{ "type":"structure", "members":{ "From":{ "shape":"Integer", "documentation":"

The first port in the range.

", "locationName":"from" }, "To":{ "shape":"Integer", "documentation":"

The last port in the range.

", "locationName":"to" } }, "documentation":"

Describes a range of ports.

" }, "PrefixList":{ "type":"structure", "members":{ "PrefixListId":{ "shape":"String", "documentation":"

The ID of the prefix.

", "locationName":"prefixListId" }, "PrefixListName":{ "shape":"String", "documentation":"

The name of the prefix.

", "locationName":"prefixListName" }, "Cidrs":{ "shape":"ValueStringList", "documentation":"

The IP address range of the AWS service.

", "locationName":"cidrSet" } }, "documentation":"

Describes prefixes for AWS services.

" }, "PrefixListId":{ "type":"structure", "members":{ "PrefixListId":{ "shape":"String", "documentation":"

The ID of the prefix.

", "locationName":"prefixListId" } }, "documentation":"

The ID of the prefix.

" }, "PrefixListIdList":{ "type":"list", "member":{ "shape":"PrefixListId", "locationName":"item" } }, "PrefixListIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "PrefixListSet":{ "type":"list", "member":{ "shape":"PrefixList", "locationName":"item" } }, "PriceSchedule":{ "type":"structure", "members":{ "Term":{ "shape":"Long", "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"

The fixed price for the term.

", "locationName":"price" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "Active":{ "shape":"Boolean", "documentation":"

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", "locationName":"active" } }, "documentation":"

Describes the price for a Reserved Instance.

" }, "PriceScheduleList":{ "type":"list", "member":{ "shape":"PriceSchedule", "locationName":"item" } }, "PriceScheduleSpecification":{ "type":"structure", "members":{ "Term":{ "shape":"Long", "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"

The fixed price for the term.

", "locationName":"price" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } }, "documentation":"

Describes the price for a Reserved Instance.

" }, "PriceScheduleSpecificationList":{ "type":"list", "member":{ "shape":"PriceScheduleSpecification", "locationName":"item" } }, "PricingDetail":{ "type":"structure", "members":{ "Price":{ "shape":"Double", "documentation":"

The price per instance.

", "locationName":"price" }, "Count":{ "shape":"Integer", "documentation":"

The number of reservations available for the price.

", "locationName":"count" } }, "documentation":"

Describes a Reserved Instance offering.

" }, "PricingDetailsList":{ "type":"list", "member":{ "shape":"PricingDetail", "locationName":"item" } }, "PrivateIpAddressConfigSet":{ "type":"list", "member":{ "shape":"ScheduledInstancesPrivateIpAddressConfig", "locationName":"PrivateIpAddressConfigSet" } }, "PrivateIpAddressSpecification":{ "type":"structure", "required":["PrivateIpAddress"], "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP addresses.

", "locationName":"privateIpAddress" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

", "locationName":"primary" } }, "documentation":"

Describes a secondary private IP address for a network interface.

" }, "PrivateIpAddressSpecificationList":{ "type":"list", "member":{ "shape":"PrivateIpAddressSpecification", "locationName":"item" } }, "PrivateIpAddressStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"PrivateIpAddress" } }, "ProductCode":{ "type":"structure", "members":{ "ProductCodeId":{ "shape":"String", "documentation":"

The product code.

", "locationName":"productCode" }, "ProductCodeType":{ "shape":"ProductCodeValues", "documentation":"

The type of product code.

", "locationName":"type" } }, "documentation":"

Describes a product code.

" }, "ProductCodeList":{ "type":"list", "member":{ "shape":"ProductCode", "locationName":"item" } }, "ProductCodeStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ProductCode" } }, "ProductCodeValues":{ "type":"string", "enum":[ "devpay", "marketplace" ] }, "ProductDescriptionList":{ "type":"list", "member":{"shape":"String"} }, "PropagatingVgw":{ "type":"structure", "members":{ "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway (VGW).

", "locationName":"gatewayId" } }, "documentation":"

Describes a virtual private gateway propagating route.

" }, "PropagatingVgwList":{ "type":"list", "member":{ "shape":"PropagatingVgw", "locationName":"item" } }, "ProvisionedBandwidth":{ "type":"structure", "members":{ "Provisioned":{ "shape":"String", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"provisioned" }, "Requested":{ "shape":"String", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"requested" }, "RequestTime":{ "shape":"DateTime", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"requestTime" }, "ProvisionTime":{ "shape":"DateTime", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"provisionTime" }, "Status":{ "shape":"String", "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", "locationName":"status" } }, "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

" }, "PublicIpStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"PublicIp" } }, "Purchase":{ "type":"structure", "members":{ "HostReservationId":{ "shape":"String", "documentation":"

The ID of the reservation.

", "locationName":"hostReservationId" }, "HostIdSet":{ "shape":"ResponseHostIdSet", "documentation":"

The IDs of the Dedicated Hosts associated with the reservation.

", "locationName":"hostIdSet" }, "InstanceFamily":{ "shape":"String", "documentation":"

The instance family on the Dedicated Host that the reservation can be associated with.

", "locationName":"instanceFamily" }, "PaymentOption":{ "shape":"PaymentOption", "documentation":"

The payment option for the reservation.

", "locationName":"paymentOption" }, "UpfrontPrice":{ "shape":"String", "documentation":"

The upfront price of the reservation.

", "locationName":"upfrontPrice" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price of the reservation per hour.

", "locationName":"hourlyPrice" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "Duration":{ "shape":"Integer", "documentation":"

The duration of the reservation's term in seconds.

", "locationName":"duration" } }, "documentation":"

Describes the result of the purchase.

" }, "PurchaseHostReservationRequest":{ "type":"structure", "required":[ "OfferingId", "HostIdSet" ], "members":{ "OfferingId":{ "shape":"String", "documentation":"

The ID of the offering.

" }, "HostIdSet":{ "shape":"RequestHostIdSet", "documentation":"

The ID/s of the Dedicated Host/s that the reservation will be associated with.

" }, "LimitPrice":{ "shape":"String", "documentation":"

The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request will fail. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.

" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" } } }, "PurchaseHostReservationResult":{ "type":"structure", "members":{ "Purchase":{ "shape":"PurchaseSet", "documentation":"

Describes the details of the purchase.

", "locationName":"purchase" }, "TotalUpfrontPrice":{ "shape":"String", "documentation":"

The total amount that will be charged to your account when you purchase the reservation.

", "locationName":"totalUpfrontPrice" }, "TotalHourlyPrice":{ "shape":"String", "documentation":"

The total hourly price of the reservation calculated per hour.

", "locationName":"totalHourlyPrice" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide

", "locationName":"clientToken" } } }, "PurchaseRequest":{ "type":"structure", "required":[ "PurchaseToken", "InstanceCount" ], "members":{ "PurchaseToken":{ "shape":"String", "documentation":"

The purchase token.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances.

" } }, "documentation":"

Describes a request to purchase Scheduled Instances.

" }, "PurchaseRequestSet":{ "type":"list", "member":{ "shape":"PurchaseRequest", "locationName":"PurchaseRequest" }, "min":1 }, "PurchaseReservedInstancesOfferingRequest":{ "type":"structure", "required":[ "ReservedInstancesOfferingId", "InstanceCount" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance offering to purchase.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of Reserved Instances to purchase.

" }, "LimitPrice":{ "shape":"ReservedInstanceLimitPrice", "documentation":"

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", "locationName":"limitPrice" } }, "documentation":"

Contains the parameters for PurchaseReservedInstancesOffering.

" }, "PurchaseReservedInstancesOfferingResult":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The IDs of the purchased Reserved Instances.

", "locationName":"reservedInstancesId" } }, "documentation":"

Contains the output of PurchaseReservedInstancesOffering.

" }, "PurchaseScheduledInstancesRequest":{ "type":"structure", "required":["PurchaseRequests"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

", "idempotencyToken":true }, "PurchaseRequests":{ "shape":"PurchaseRequestSet", "documentation":"

One or more purchase requests.

", "locationName":"PurchaseRequest" } }, "documentation":"

Contains the parameters for PurchaseScheduledInstances.

" }, "PurchaseScheduledInstancesResult":{ "type":"structure", "members":{ "ScheduledInstanceSet":{ "shape":"PurchasedScheduledInstanceSet", "documentation":"

Information about the Scheduled Instances.

", "locationName":"scheduledInstanceSet" } }, "documentation":"

Contains the output of PurchaseScheduledInstances.

" }, "PurchaseSet":{ "type":"list", "member":{"shape":"Purchase"} }, "PurchasedScheduledInstanceSet":{ "type":"list", "member":{ "shape":"ScheduledInstance", "locationName":"item" } }, "RIProductDescription":{ "type":"string", "enum":[ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ] }, "ReasonCodesList":{ "type":"list", "member":{ "shape":"ReportInstanceReasonCodes", "locationName":"item" } }, "RebootInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } }, "documentation":"

Contains the parameters for RebootInstances.

" }, "RecurringCharge":{ "type":"structure", "members":{ "Frequency":{ "shape":"RecurringChargeFrequency", "documentation":"

The frequency of the recurring charge.

", "locationName":"frequency" }, "Amount":{ "shape":"Double", "documentation":"

The amount of the recurring charge.

", "locationName":"amount" } }, "documentation":"

Describes a recurring charge.

" }, "RecurringChargeFrequency":{ "type":"string", "enum":["Hourly"] }, "RecurringChargesList":{ "type":"list", "member":{ "shape":"RecurringCharge", "locationName":"item" } }, "Region":{ "type":"structure", "members":{ "RegionName":{ "shape":"String", "documentation":"

The name of the region.

", "locationName":"regionName" }, "Endpoint":{ "shape":"String", "documentation":"

The region service endpoint.

", "locationName":"regionEndpoint" } }, "documentation":"

Describes a region.

" }, "RegionList":{ "type":"list", "member":{ "shape":"Region", "locationName":"item" } }, "RegionNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"RegionName" } }, "RegisterImageRequest":{ "type":"structure", "required":["Name"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageLocation":{ "shape":"String", "documentation":"

The full path to your AMI manifest in Amazon S3 storage.

" }, "Name":{ "shape":"String", "documentation":"

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

A description for your AMI.

", "locationName":"description" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

", "locationName":"architecture" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "RootDeviceName":{ "shape":"String", "documentation":"

The name of the root device (for example, /dev/sda1, or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

One or more block device mapping entries.

", "locationName":"BlockDeviceMapping" }, "VirtualizationType":{ "shape":"String", "documentation":"

The type of virtualization.

Default: paravirtual

", "locationName":"virtualizationType" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", "locationName":"sriovNetSupport" }, "EnaSupport":{ "shape":"Boolean", "documentation":"

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", "locationName":"enaSupport" } }, "documentation":"

Contains the parameters for RegisterImage.

" }, "RegisterImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the newly registered AMI.

", "locationName":"imageId" } }, "documentation":"

Contains the output of RegisterImage.

" }, "RejectVpcPeeringConnectionRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Contains the parameters for RejectVpcPeeringConnection.

" }, "RejectVpcPeeringConnectionResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } }, "documentation":"

Contains the output of RejectVpcPeeringConnection.

" }, "ReleaseAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" } }, "documentation":"

Contains the parameters for ReleaseAddress.

" }, "ReleaseHostsRequest":{ "type":"structure", "required":["HostIds"], "members":{ "HostIds":{ "shape":"RequestHostIdList", "documentation":"

The IDs of the Dedicated Hosts you want to release.

", "locationName":"hostId" } }, "documentation":"

Contains the parameters for ReleaseHosts.

" }, "ReleaseHostsResult":{ "type":"structure", "members":{ "Successful":{ "shape":"ResponseHostIdList", "documentation":"

The IDs of the Dedicated Hosts that were successfully released.

", "locationName":"successful" }, "Unsuccessful":{ "shape":"UnsuccessfulItemList", "documentation":"

The IDs of the Dedicated Hosts that could not be released, including an error message.

", "locationName":"unsuccessful" } }, "documentation":"

Contains the output of ReleaseHosts.

" }, "ReplaceNetworkAclAssociationRequest":{ "type":"structure", "required":[ "AssociationId", "NetworkAclId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The ID of the current association between the original network ACL and the subnet.

", "locationName":"associationId" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the new network ACL to associate with the subnet.

", "locationName":"networkAclId" } }, "documentation":"

Contains the parameters for ReplaceNetworkAclAssociation.

" }, "ReplaceNetworkAclAssociationResult":{ "type":"structure", "members":{ "NewAssociationId":{ "shape":"String", "documentation":"

The ID of the new association.

", "locationName":"newAssociationId" } }, "documentation":"

Contains the output of ReplaceNetworkAclAssociation.

" }, "ReplaceNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Protocol", "RuleAction", "Egress", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number of the entry to replace.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The IP protocol. You can specify all or -1 to mean all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation.

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.

", "locationName":"Icmp" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.

", "locationName":"portRange" } }, "documentation":"

Contains the parameters for ReplaceNetworkAclEntry.

" }, "ReplaceRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of an Internet gateway or virtual private gateway.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC.

", "locationName":"instanceId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of a network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of a VPC peering connection.

", "locationName":"vpcPeeringConnectionId" }, "NatGatewayId":{ "shape":"String", "documentation":"

The ID of a NAT gateway.

", "locationName":"natGatewayId" } }, "documentation":"

Contains the parameters for ReplaceRoute.

" }, "ReplaceRouteTableAssociationRequest":{ "type":"structure", "required":[ "AssociationId", "RouteTableId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID.

", "locationName":"associationId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the new route table to associate with the subnet.

", "locationName":"routeTableId" } }, "documentation":"

Contains the parameters for ReplaceRouteTableAssociation.

" }, "ReplaceRouteTableAssociationResult":{ "type":"structure", "members":{ "NewAssociationId":{ "shape":"String", "documentation":"

The ID of the new association.

", "locationName":"newAssociationId" } }, "documentation":"

Contains the output of ReplaceRouteTableAssociation.

" }, "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" ] }, "ReportInstanceStatusRequest":{ "type":"structure", "required":[ "Instances", "Status", "ReasonCodes" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Instances":{ "shape":"InstanceIdStringList", "documentation":"

One or more instances.

", "locationName":"instanceId" }, "Status":{ "shape":"ReportStatusType", "documentation":"

The status of all instances listed.

", "locationName":"status" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time at which the reported instance health state began.

", "locationName":"startTime" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time at which the reported instance health state ended.

", "locationName":"endTime" }, "ReasonCodes":{ "shape":"ReasonCodesList", "documentation":"

One or more reason codes that describes the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems which I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

", "locationName":"reasonCode" }, "Description":{ "shape":"String", "documentation":"

Descriptive text about the health state of your instance.

", "locationName":"description" } }, "documentation":"

Contains the parameters for ReportInstanceStatus.

" }, "ReportStatusType":{ "type":"string", "enum":[ "ok", "impaired" ] }, "RequestHostIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "RequestHostIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "RequestSpotFleetRequest":{ "type":"structure", "required":["SpotFleetRequestConfig"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestConfig":{ "shape":"SpotFleetRequestConfigData", "documentation":"

The configuration for the Spot fleet request.

", "locationName":"spotFleetRequestConfig" } }, "documentation":"

Contains the parameters for RequestSpotFleet.

" }, "RequestSpotFleetResponse":{ "type":"structure", "required":["SpotFleetRequestId"], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" } }, "documentation":"

Contains the output of RequestSpotFleet.

" }, "RequestSpotInstancesRequest":{ "type":"structure", "required":["SpotPrice"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum hourly price (bid) for any Spot instance launched to fulfill the request.

", "locationName":"spotPrice" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"clientToken" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The maximum number of Spot instances to launch.

Default: 1

", "locationName":"instanceCount" }, "Type":{ "shape":"SpotInstanceType", "documentation":"

The Spot instance request type.

Default: one-time

", "locationName":"type" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

Default: The request is effective indefinitely.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

Default: The request is effective indefinitely.

", "locationName":"validUntil" }, "LaunchGroup":{ "shape":"String", "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

Default: Instances are launched and terminated individually

", "locationName":"launchGroup" }, "AvailabilityZoneGroup":{ "shape":"String", "documentation":"

The user-specified name for a logical grouping of bids.

When you specify an Availability Zone group in a Spot Instance request, all Spot instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", "locationName":"availabilityZoneGroup" }, "BlockDurationMinutes":{ "shape":"Integer", "documentation":"

The required duration for the Spot instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

The duration period starts as soon as your Spot instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.

Note that you can't specify an Availability Zone group or a launch group if you specify a duration.

", "locationName":"blockDurationMinutes" }, "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} }, "documentation":"

Contains the parameters for RequestSpotInstances.

" }, "RequestSpotInstancesResult":{ "type":"structure", "members":{ "SpotInstanceRequests":{ "shape":"SpotInstanceRequestList", "documentation":"

One or more Spot instance requests.

", "locationName":"spotInstanceRequestSet" } }, "documentation":"

Contains the output of RequestSpotInstances.

" }, "RequestSpotLaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"ValueStringList", "locationName":"SecurityGroup" }, "UserData":{ "shape":"String", "documentation":"

The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.

", "locationName":"blockDeviceMapping" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"NetworkInterface" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" }, "SecurityGroupIds":{ "shape":"ValueStringList", "locationName":"SecurityGroupId" } }, "documentation":"

Describes the launch specification for an instance.

" }, "Reservation":{ "type":"structure", "members":{ "ReservationId":{ "shape":"String", "documentation":"

The ID of the reservation.

", "locationName":"reservationId" }, "OwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that owns the reservation.

", "locationName":"ownerId" }, "RequesterId":{ "shape":"String", "documentation":"

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

", "locationName":"requesterId" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

[EC2-Classic only] One or more security groups.

", "locationName":"groupSet" }, "Instances":{ "shape":"InstanceList", "documentation":"

One or more instances.

", "locationName":"instancesSet" } }, "documentation":"

Describes a reservation.

" }, "ReservationList":{ "type":"list", "member":{ "shape":"Reservation", "locationName":"item" } }, "ReservationState":{ "type":"string", "enum":[ "payment-pending", "payment-failed", "active", "retired" ] }, "ReservedInstanceLimitPrice":{ "type":"structure", "members":{ "Amount":{ "shape":"Double", "documentation":"

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", "locationName":"amount" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } }, "documentation":"

Describes the limit price of a Reserved Instance offering.

" }, "ReservedInstanceState":{ "type":"string", "enum":[ "payment-pending", "active", "payment-failed", "retired" ] }, "ReservedInstances":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used.

", "locationName":"instanceType" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", "locationName":"availabilityZone" }, "Start":{ "shape":"DateTime", "documentation":"

The date and time the Reserved Instance started.

", "locationName":"start" }, "End":{ "shape":"DateTime", "documentation":"

The time when the Reserved Instance expires.

", "locationName":"end" }, "Duration":{ "shape":"Long", "documentation":"

The duration of the Reserved Instance, in seconds.

", "locationName":"duration" }, "UsagePrice":{ "shape":"Float", "documentation":"

The usage price of the Reserved Instance, per hour.

", "locationName":"usagePrice" }, "FixedPrice":{ "shape":"Float", "documentation":"

The purchase price of the Reserved Instance.

", "locationName":"fixedPrice" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of reservations purchased.

", "locationName":"instanceCount" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance product platform description.

", "locationName":"productDescription" }, "State":{ "shape":"ReservedInstanceState", "documentation":"

The state of the Reserved Instance purchase.

", "locationName":"state" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance.

", "locationName":"instanceTenancy" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type.

", "locationName":"offeringType" }, "RecurringCharges":{ "shape":"RecurringChargesList", "documentation":"

The recurring charge tag assigned to the resource.

", "locationName":"recurringCharges" } }, "documentation":"

Describes a Reserved Instance.

" }, "ReservedInstancesConfiguration":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the modified Reserved Instances.

", "locationName":"availabilityZone" }, "Platform":{ "shape":"String", "documentation":"

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", "locationName":"platform" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of modified Reserved Instances.

", "locationName":"instanceCount" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type for the modified Reserved Instances.

", "locationName":"instanceType" } }, "documentation":"

Describes the configuration settings for the modified Reserved Instances.

" }, "ReservedInstancesConfigurationList":{ "type":"list", "member":{ "shape":"ReservedInstancesConfiguration", "locationName":"item" } }, "ReservedInstancesId":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" } }, "documentation":"

Describes the ID of a Reserved Instance.

" }, "ReservedInstancesIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstancesId" } }, "ReservedInstancesList":{ "type":"list", "member":{ "shape":"ReservedInstances", "locationName":"item" } }, "ReservedInstancesListing":{ "type":"structure", "members":{ "ReservedInstancesListingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance listing.

", "locationName":"reservedInstancesListingId" }, "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The time the listing was created.

", "locationName":"createDate" }, "UpdateDate":{ "shape":"DateTime", "documentation":"

The last modified timestamp of the listing.

", "locationName":"updateDate" }, "Status":{ "shape":"ListingStatus", "documentation":"

The status of the Reserved Instance listing.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The reason for the current status of the Reserved Instance listing. The response can be blank.

", "locationName":"statusMessage" }, "InstanceCounts":{ "shape":"InstanceCountList", "documentation":"

The number of instances in this state.

", "locationName":"instanceCounts" }, "PriceSchedules":{ "shape":"PriceScheduleList", "documentation":"

The price of the Reserved Instance listing.

", "locationName":"priceSchedules" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Describes a Reserved Instance listing.

" }, "ReservedInstancesListingList":{ "type":"list", "member":{ "shape":"ReservedInstancesListing", "locationName":"item" } }, "ReservedInstancesModification":{ "type":"structure", "members":{ "ReservedInstancesModificationId":{ "shape":"String", "documentation":"

A unique ID for the Reserved Instance modification.

", "locationName":"reservedInstancesModificationId" }, "ReservedInstancesIds":{ "shape":"ReservedIntancesIds", "documentation":"

The IDs of one or more Reserved Instances.

", "locationName":"reservedInstancesSet" }, "ModificationResults":{ "shape":"ReservedInstancesModificationResultList", "documentation":"

Contains target configurations along with their corresponding new Reserved Instance IDs.

", "locationName":"modificationResultSet" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The time when the modification request was created.

", "locationName":"createDate" }, "UpdateDate":{ "shape":"DateTime", "documentation":"

The time when the modification request was last updated.

", "locationName":"updateDate" }, "EffectiveDate":{ "shape":"DateTime", "documentation":"

The time for the modification to become effective.

", "locationName":"effectiveDate" }, "Status":{ "shape":"String", "documentation":"

The status of the Reserved Instances modification request.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The reason for the status.

", "locationName":"statusMessage" }, "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Describes a Reserved Instance modification.

" }, "ReservedInstancesModificationIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstancesModificationId" } }, "ReservedInstancesModificationList":{ "type":"list", "member":{ "shape":"ReservedInstancesModification", "locationName":"item" } }, "ReservedInstancesModificationResult":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", "locationName":"reservedInstancesId" }, "TargetConfiguration":{ "shape":"ReservedInstancesConfiguration", "documentation":"

The target Reserved Instances configurations supplied as part of the modification request.

", "locationName":"targetConfiguration" } }, "documentation":"

Describes the modification request/s.

" }, "ReservedInstancesModificationResultList":{ "type":"list", "member":{ "shape":"ReservedInstancesModificationResult", "locationName":"item" } }, "ReservedInstancesOffering":{ "type":"structure", "members":{ "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance offering.

", "locationName":"reservedInstancesOfferingId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used.

", "locationName":"instanceType" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", "locationName":"availabilityZone" }, "Duration":{ "shape":"Long", "documentation":"

The duration of the Reserved Instance, in seconds.

", "locationName":"duration" }, "UsagePrice":{ "shape":"Float", "documentation":"

The usage price of the Reserved Instance, per hour.

", "locationName":"usagePrice" }, "FixedPrice":{ "shape":"Float", "documentation":"

The purchase price of the Reserved Instance.

", "locationName":"fixedPrice" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance product platform description.

", "locationName":"productDescription" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance.

", "locationName":"instanceTenancy" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type.

", "locationName":"offeringType" }, "RecurringCharges":{ "shape":"RecurringChargesList", "documentation":"

The recurring charge tag assigned to the resource.

", "locationName":"recurringCharges" }, "Marketplace":{ "shape":"Boolean", "documentation":"

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

", "locationName":"marketplace" }, "PricingDetails":{ "shape":"PricingDetailsList", "documentation":"

The pricing details of the Reserved Instance offering.

", "locationName":"pricingDetailsSet" } }, "documentation":"

Describes a Reserved Instance offering.

" }, "ReservedInstancesOfferingIdStringList":{ "type":"list", "member":{"shape":"String"} }, "ReservedInstancesOfferingList":{ "type":"list", "member":{ "shape":"ReservedInstancesOffering", "locationName":"item" } }, "ReservedIntancesIds":{ "type":"list", "member":{ "shape":"ReservedInstancesId", "locationName":"item" } }, "ResetImageAttributeName":{ "type":"string", "enum":["launchPermission"] }, "ResetImageAttributeRequest":{ "type":"structure", "required":[ "ImageId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"ResetImageAttributeName", "documentation":"

The attribute to reset (currently you can only reset the launch permission attribute).

" } }, "documentation":"

Contains the parameters for ResetImageAttribute.

" }, "ResetInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The attribute to reset.

You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.

", "locationName":"attribute" } }, "documentation":"

Contains the parameters for ResetInstanceAttribute.

" }, "ResetNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SourceDestCheck":{ "shape":"String", "documentation":"

The source/destination checking attribute. Resets the value to true.

", "locationName":"sourceDestCheck" } }, "documentation":"

Contains the parameters for ResetNetworkInterfaceAttribute.

" }, "ResetSnapshotAttributeRequest":{ "type":"structure", "required":[ "SnapshotId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.

" } }, "documentation":"

Contains the parameters for ResetSnapshotAttribute.

" }, "ResourceIdList":{ "type":"list", "member":{"shape":"String"} }, "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" ] }, "ResponseHostIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "ResponseHostIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "RestorableByStringList":{ "type":"list", "member":{"shape":"String"} }, "RestoreAddressToClassicRequest":{ "type":"structure", "required":["PublicIp"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" } }, "documentation":"

Contains the parameters for RestoreAddressToClassic.

" }, "RestoreAddressToClassicResult":{ "type":"structure", "members":{ "Status":{ "shape":"Status", "documentation":"

The move status for the IP address.

", "locationName":"status" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" } }, "documentation":"

Contains the output of RestoreAddressToClassic.

" }, "RevokeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

The name of a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account number for a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", "locationName":"toPort" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.

", "locationName":"cidrIp" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"ipPermissions" } }, "documentation":"

Contains the parameters for RevokeSecurityGroupEgress.

" }, "RevokeSecurityGroupIngressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a security group in a nondefault VPC.

" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" } }, "documentation":"

Contains the parameters for RevokeSecurityGroupIngress.

" }, "Route":{ "type":"structure", "members":{ "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block used for the destination match.

", "locationName":"destinationCidrBlock" }, "DestinationPrefixListId":{ "shape":"String", "documentation":"

The prefix of the AWS service.

", "locationName":"destinationPrefixListId" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of a gateway attached to your VPC.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC.

", "locationName":"instanceId" }, "InstanceOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the instance.

", "locationName":"instanceOwnerId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" }, "NatGatewayId":{ "shape":"String", "documentation":"

The ID of a NAT gateway.

", "locationName":"natGatewayId" }, "State":{ "shape":"RouteState", "documentation":"

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

", "locationName":"state" }, "Origin":{ "shape":"RouteOrigin", "documentation":"

Describes how the route was created.

  • CreateRouteTable - The route was automatically created when the route table was created.

  • CreateRoute - The route was manually added to the route table.

  • EnableVgwRoutePropagation - The route was propagated by route propagation.

", "locationName":"origin" } }, "documentation":"

Describes a route in a route table.

" }, "RouteList":{ "type":"list", "member":{ "shape":"Route", "locationName":"item" } }, "RouteOrigin":{ "type":"string", "enum":[ "CreateRouteTable", "CreateRoute", "EnableVgwRoutePropagation" ] }, "RouteState":{ "type":"string", "enum":[ "active", "blackhole" ] }, "RouteTable":{ "type":"structure", "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Routes":{ "shape":"RouteList", "documentation":"

The routes in the route table.

", "locationName":"routeSet" }, "Associations":{ "shape":"RouteTableAssociationList", "documentation":"

The associations between the route table and one or more subnets.

", "locationName":"associationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the route table.

", "locationName":"tagSet" }, "PropagatingVgws":{ "shape":"PropagatingVgwList", "documentation":"

Any virtual private gateway (VGW) propagating routes.

", "locationName":"propagatingVgwSet" } }, "documentation":"

Describes a route table.

" }, "RouteTableAssociation":{ "type":"structure", "members":{ "RouteTableAssociationId":{ "shape":"String", "documentation":"

The ID of the association between a route table and a subnet.

", "locationName":"routeTableAssociationId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet. A subnet ID is not returned for an implicit association.

", "locationName":"subnetId" }, "Main":{ "shape":"Boolean", "documentation":"

Indicates whether this is the main route table.

", "locationName":"main" } }, "documentation":"

Describes an association between a route table and a subnet.

" }, "RouteTableAssociationList":{ "type":"list", "member":{ "shape":"RouteTableAssociation", "locationName":"item" } }, "RouteTableList":{ "type":"list", "member":{ "shape":"RouteTable", "locationName":"item" } }, "RuleAction":{ "type":"string", "enum":[ "allow", "deny" ] }, "RunInstancesMonitoringEnabled":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Indicates whether monitoring is enabled for the instance.

", "locationName":"enabled" } }, "documentation":"

Describes the monitoring for the instance.

" }, "RunInstancesRequest":{ "type":"structure", "required":[ "ImageId", "MinCount", "MaxCount" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI, which you can get by calling DescribeImages.

" }, "MinCount":{ "shape":"Integer", "documentation":"

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" }, "MaxCount":{ "shape":"Integer", "documentation":"

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.

" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

" }, "SecurityGroups":{ "shape":"SecurityGroupStringList", "documentation":"

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

", "locationName":"SecurityGroup" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdStringList", "documentation":"

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

", "locationName":"SecurityGroupId" }, "UserData":{ "shape":"String", "documentation":"

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

" }, "Placement":{ "shape":"Placement", "documentation":"

The placement for the instance.

" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

The block device mapping.

Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.

", "locationName":"BlockDeviceMapping" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "documentation":"

The monitoring for the instance.

" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

" }, "DisableApiTermination":{ "shape":"Boolean", "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

", "locationName":"instanceInitiatedShutdownBehavior" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.

Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.

Default: We select an IP address from the IP address range of the subnet.

", "locationName":"privateIpAddress" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

", "locationName":"clientToken" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterface" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

", "locationName":"ebsOptimized" } }, "documentation":"

Contains the parameters for RunInstances.

" }, "RunScheduledInstancesRequest":{ "type":"structure", "required":[ "ScheduledInstanceId", "LaunchSpecification" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

", "idempotencyToken":true }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances.

Default: 1

" }, "ScheduledInstanceId":{ "shape":"String", "documentation":"

The Scheduled Instance ID.

" }, "LaunchSpecification":{ "shape":"ScheduledInstancesLaunchSpecification", "documentation":"

The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.

" } }, "documentation":"

Contains the parameters for RunScheduledInstances.

" }, "RunScheduledInstancesResult":{ "type":"structure", "members":{ "InstanceIdSet":{ "shape":"InstanceIdSet", "documentation":"

The IDs of the newly launched instances.

", "locationName":"instanceIdSet" } }, "documentation":"

Contains the output of RunScheduledInstances.

" }, "S3Storage":{ "type":"structure", "members":{ "Bucket":{ "shape":"String", "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

The beginning of the file name of the AMI.

", "locationName":"prefix" }, "AWSAccessKeyId":{ "shape":"String", "documentation":"

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

" }, "UploadPolicy":{ "shape":"Blob", "documentation":"

An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", "locationName":"uploadPolicy" }, "UploadPolicySignature":{ "shape":"String", "documentation":"

The signature of the JSON document.

", "locationName":"uploadPolicySignature" } }, "documentation":"

Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI.

" }, "ScheduledInstance":{ "type":"structure", "members":{ "ScheduledInstanceId":{ "shape":"String", "documentation":"

The Scheduled Instance ID.

", "locationName":"scheduledInstanceId" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Platform":{ "shape":"String", "documentation":"

The platform (Linux/UNIX or Windows).

", "locationName":"platform" }, "NetworkPlatform":{ "shape":"String", "documentation":"

The network platform (EC2-Classic or EC2-VPC).

", "locationName":"networkPlatform" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "SlotDurationInHours":{ "shape":"Integer", "documentation":"

The number of hours in the schedule.

", "locationName":"slotDurationInHours" }, "Recurrence":{ "shape":"ScheduledInstanceRecurrence", "documentation":"

The schedule recurrence.

", "locationName":"recurrence" }, "PreviousSlotEndTime":{ "shape":"DateTime", "documentation":"

The time that the previous schedule ended or will end.

", "locationName":"previousSlotEndTime" }, "NextSlotStartTime":{ "shape":"DateTime", "documentation":"

The time for the next schedule to start.

", "locationName":"nextSlotStartTime" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price for a single instance.

", "locationName":"hourlyPrice" }, "TotalScheduledInstanceHours":{ "shape":"Integer", "documentation":"

The total number of hours for a single instance for the entire term.

", "locationName":"totalScheduledInstanceHours" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances.

", "locationName":"instanceCount" }, "TermStartDate":{ "shape":"DateTime", "documentation":"

The start date for the Scheduled Instance.

", "locationName":"termStartDate" }, "TermEndDate":{ "shape":"DateTime", "documentation":"

The end date for the Scheduled Instance.

", "locationName":"termEndDate" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The date when the Scheduled Instance was purchased.

", "locationName":"createDate" } }, "documentation":"

Describes a Scheduled Instance.

" }, "ScheduledInstanceAvailability":{ "type":"structure", "members":{ "InstanceType":{ "shape":"String", "documentation":"

The instance type. You can specify one of the C3, C4, M4, or R3 instance types.

", "locationName":"instanceType" }, "Platform":{ "shape":"String", "documentation":"

The platform (Linux/UNIX or Windows).

", "locationName":"platform" }, "NetworkPlatform":{ "shape":"String", "documentation":"

The network platform (EC2-Classic or EC2-VPC).

", "locationName":"networkPlatform" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "PurchaseToken":{ "shape":"String", "documentation":"

The purchase token. This token expires in two hours.

", "locationName":"purchaseToken" }, "SlotDurationInHours":{ "shape":"Integer", "documentation":"

The number of hours in the schedule.

", "locationName":"slotDurationInHours" }, "Recurrence":{ "shape":"ScheduledInstanceRecurrence", "documentation":"

The schedule recurrence.

", "locationName":"recurrence" }, "FirstSlotStartTime":{ "shape":"DateTime", "documentation":"

The time period for the first schedule to start.

", "locationName":"firstSlotStartTime" }, "HourlyPrice":{ "shape":"String", "documentation":"

The hourly price for a single instance.

", "locationName":"hourlyPrice" }, "TotalScheduledInstanceHours":{ "shape":"Integer", "documentation":"

The total number of hours for a single instance for the entire term.

", "locationName":"totalScheduledInstanceHours" }, "AvailableInstanceCount":{ "shape":"Integer", "documentation":"

The number of available instances.

", "locationName":"availableInstanceCount" }, "MinTermDurationInDays":{ "shape":"Integer", "documentation":"

The minimum term. The only possible value is 365 days.

", "locationName":"minTermDurationInDays" }, "MaxTermDurationInDays":{ "shape":"Integer", "documentation":"

The maximum term. The only possible value is 365 days.

", "locationName":"maxTermDurationInDays" } }, "documentation":"

Describes a schedule that is available for your Scheduled Instances.

" }, "ScheduledInstanceAvailabilitySet":{ "type":"list", "member":{ "shape":"ScheduledInstanceAvailability", "locationName":"item" } }, "ScheduledInstanceIdRequestSet":{ "type":"list", "member":{ "shape":"String", "locationName":"ScheduledInstanceId" } }, "ScheduledInstanceRecurrence":{ "type":"structure", "members":{ "Frequency":{ "shape":"String", "documentation":"

The frequency (Daily, Weekly, or Monthly).

", "locationName":"frequency" }, "Interval":{ "shape":"Integer", "documentation":"

The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months.

", "locationName":"interval" }, "OccurrenceDaySet":{ "shape":"OccurrenceDaySet", "documentation":"

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).

", "locationName":"occurrenceDaySet" }, "OccurrenceRelativeToEnd":{ "shape":"Boolean", "documentation":"

Indicates whether the occurrence is relative to the end of the specified week or month.

", "locationName":"occurrenceRelativeToEnd" }, "OccurrenceUnit":{ "shape":"String", "documentation":"

The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).

", "locationName":"occurrenceUnit" } }, "documentation":"

Describes the recurring schedule for a Scheduled Instance.

" }, "ScheduledInstanceRecurrenceRequest":{ "type":"structure", "members":{ "Frequency":{ "shape":"String", "documentation":"

The frequency (Daily, Weekly, or Monthly).

" }, "Interval":{ "shape":"Integer", "documentation":"

The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.

" }, "OccurrenceDays":{ "shape":"OccurrenceDayRequestSet", "documentation":"

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.

", "locationName":"OccurrenceDay" }, "OccurrenceRelativeToEnd":{ "shape":"Boolean", "documentation":"

Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.

" }, "OccurrenceUnit":{ "shape":"String", "documentation":"

The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.

" } }, "documentation":"

Describes the recurring schedule for a Scheduled Instance.

" }, "ScheduledInstanceSet":{ "type":"list", "member":{ "shape":"ScheduledInstance", "locationName":"item" } }, "ScheduledInstancesBlockDeviceMapping":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

" }, "NoDevice":{ "shape":"String", "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

" }, "VirtualName":{ "shape":"String", "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

" }, "Ebs":{ "shape":"ScheduledInstancesEbs", "documentation":"

Parameters used to set up EBS volumes automatically when the instance is launched.

" } }, "documentation":"

Describes a block device mapping for a Scheduled Instance.

" }, "ScheduledInstancesBlockDeviceMappingSet":{ "type":"list", "member":{ "shape":"ScheduledInstancesBlockDeviceMapping", "locationName":"BlockDeviceMapping" } }, "ScheduledInstancesEbs":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

" }, "VolumeType":{ "shape":"String", "documentation":"

The volume type. gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for Magnetic.

Default: standard

" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about gp2 baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.

" } }, "documentation":"

Describes an EBS volume for a Scheduled Instance.

" }, "ScheduledInstancesIamInstanceProfile":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN).

" }, "Name":{ "shape":"String", "documentation":"

The name.

" } }, "documentation":"

Describes an IAM instance profile for a Scheduled Instance.

" }, "ScheduledInstancesLaunchSpecification":{ "type":"structure", "required":["ImageId"], "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the Amazon Machine Image (AMI).

" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

" }, "SecurityGroupIds":{ "shape":"ScheduledInstancesSecurityGroupIdSet", "documentation":"

The IDs of one or more security groups.

", "locationName":"SecurityGroupId" }, "UserData":{ "shape":"String", "documentation":"

The base64-encoded MIME user data.

" }, "Placement":{ "shape":"ScheduledInstancesPlacement", "documentation":"

The placement information.

" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type.

" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

" }, "BlockDeviceMappings":{ "shape":"ScheduledInstancesBlockDeviceMappingSet", "documentation":"

One or more block device mapping entries.

", "locationName":"BlockDeviceMapping" }, "Monitoring":{ "shape":"ScheduledInstancesMonitoring", "documentation":"

Enable or disable monitoring for the instances.

" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instances.

" }, "NetworkInterfaces":{ "shape":"ScheduledInstancesNetworkInterfaceSet", "documentation":"

One or more network interfaces.

", "locationName":"NetworkInterface" }, "IamInstanceProfile":{ "shape":"ScheduledInstancesIamInstanceProfile", "documentation":"

The IAM instance profile.

" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

" } }, "documentation":"

Describes the launch specification for a Scheduled Instance.

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.

" }, "ScheduledInstancesMonitoring":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Indicates whether monitoring is enabled.

" } }, "documentation":"

Describes whether monitoring is enabled for a Scheduled Instance.

" }, "ScheduledInstancesNetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device for the network interface attachment.

" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

" }, "Description":{ "shape":"String", "documentation":"

The description.

" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

" }, "PrivateIpAddressConfigs":{ "shape":"PrivateIpAddressConfigSet", "documentation":"

The private IP addresses.

", "locationName":"PrivateIpAddressConfig" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses.

" }, "AssociatePublicIpAddress":{ "shape":"Boolean", "documentation":"

Indicates whether to assign a public IP address to instances launched in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

" }, "Groups":{ "shape":"ScheduledInstancesSecurityGroupIdSet", "documentation":"

The IDs of one or more security groups.

", "locationName":"Group" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether to delete the interface when the instance is terminated.

" } }, "documentation":"

Describes a network interface for a Scheduled Instance.

" }, "ScheduledInstancesNetworkInterfaceSet":{ "type":"list", "member":{ "shape":"ScheduledInstancesNetworkInterface", "locationName":"NetworkInterface" } }, "ScheduledInstancesPlacement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

" } }, "documentation":"

Describes the placement for a Scheduled Instance.

" }, "ScheduledInstancesPrivateIpAddressConfig":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address.

" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this is a primary IP address. Otherwise, this is a secondary IP address.

" } }, "documentation":"

Describes a private IP address for a Scheduled Instance.

" }, "ScheduledInstancesSecurityGroupIdSet":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroupId" } }, "SecurityGroup":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the security group.

", "locationName":"ownerId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "Description":{ "shape":"String", "documentation":"

A description of the security group.

", "locationName":"groupDescription" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

One or more inbound rules associated with the security group.

", "locationName":"ipPermissions" }, "IpPermissionsEgress":{ "shape":"IpPermissionList", "documentation":"

[EC2-VPC] One or more outbound rules associated with the security group.

", "locationName":"ipPermissionsEgress" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC for the security group.

", "locationName":"vpcId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the security group.

", "locationName":"tagSet" } }, "documentation":"

Describes a security group

" }, "SecurityGroupIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroupId" } }, "SecurityGroupList":{ "type":"list", "member":{ "shape":"SecurityGroup", "locationName":"item" } }, "SecurityGroupReference":{ "type":"structure", "required":[ "GroupId", "ReferencingVpcId" ], "members":{ "GroupId":{ "shape":"String", "documentation":"

The ID of your security group.

", "locationName":"groupId" }, "ReferencingVpcId":{ "shape":"String", "documentation":"

The ID of the VPC with the referencing security group.

", "locationName":"referencingVpcId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Describes a VPC with a security group that references your security group.

" }, "SecurityGroupReferences":{ "type":"list", "member":{ "shape":"SecurityGroupReference", "locationName":"item" } }, "SecurityGroupStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroup" } }, "ShutdownBehavior":{ "type":"string", "enum":[ "stop", "terminate" ] }, "SlotDateTimeRangeRequest":{ "type":"structure", "required":[ "EarliestTime", "LatestTime" ], "members":{ "EarliestTime":{ "shape":"DateTime", "documentation":"

The earliest date and time, in UTC, for the Scheduled Instance to start.

" }, "LatestTime":{ "shape":"DateTime", "documentation":"

The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.

" } }, "documentation":"

Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.

" }, "SlotStartTimeRangeRequest":{ "type":"structure", "members":{ "EarliestTime":{ "shape":"DateTime", "documentation":"

The earliest date and time, in UTC, for the Scheduled Instance to start.

" }, "LatestTime":{ "shape":"DateTime", "documentation":"

The latest date and time, in UTC, for the Scheduled Instance to start.

" } }, "documentation":"

Describes the time period for a Scheduled Instance to start its first schedule.

" }, "Snapshot":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

", "locationName":"snapshotId" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

", "locationName":"volumeId" }, "State":{ "shape":"SnapshotState", "documentation":"

The snapshot state.

", "locationName":"status" }, "StateMessage":{ "shape":"String", "documentation":"

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

", "locationName":"statusMessage" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time stamp when the snapshot was initiated.

", "locationName":"startTime" }, "Progress":{ "shape":"String", "documentation":"

The progress of the snapshot, as a percentage.

", "locationName":"progress" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the EBS snapshot owner.

", "locationName":"ownerId" }, "Description":{ "shape":"String", "documentation":"

The description for the snapshot.

", "locationName":"description" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

", "locationName":"volumeSize" }, "OwnerAlias":{ "shape":"String", "documentation":"

Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

", "locationName":"ownerAlias" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the snapshot.

", "locationName":"tagSet" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the snapshot is encrypted.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

", "locationName":"kmsKeyId" }, "DataEncryptionKeyId":{ "shape":"String", "documentation":"

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

", "locationName":"dataEncryptionKeyId" } }, "documentation":"

Describes a snapshot.

" }, "SnapshotAttributeName":{ "type":"string", "enum":[ "productCodes", "createVolumePermission" ] }, "SnapshotDetail":{ "type":"structure", "members":{ "DiskImageSize":{ "shape":"Double", "documentation":"

The size of the disk in the snapshot, in GiB.

", "locationName":"diskImageSize" }, "Description":{ "shape":"String", "documentation":"

A description for the snapshot.

", "locationName":"description" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image from which the snapshot is created.

", "locationName":"format" }, "Url":{ "shape":"String", "documentation":"

The URL used to access the disk image.

", "locationName":"url" }, "UserBucket":{ "shape":"UserBucketDetails", "documentation":"

The S3 bucket for the disk image.

", "locationName":"userBucket" }, "DeviceName":{ "shape":"String", "documentation":"

The block device mapping for the snapshot.

", "locationName":"deviceName" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot ID of the disk being imported.

", "locationName":"snapshotId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of progress for the task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message for the snapshot creation.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status of the snapshot creation.

", "locationName":"status" } }, "documentation":"

Describes the snapshot created from the imported disk.

" }, "SnapshotDetailList":{ "type":"list", "member":{ "shape":"SnapshotDetail", "locationName":"item" } }, "SnapshotDiskContainer":{ "type":"structure", "members":{ "Description":{ "shape":"String", "documentation":"

The description of the disk image being imported.

" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" }, "Url":{ "shape":"String", "documentation":"

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).

" }, "UserBucket":{ "shape":"UserBucket", "documentation":"

The S3 bucket for the disk image.

" } }, "documentation":"

The disk container object for the import snapshot request.

" }, "SnapshotIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SnapshotId" } }, "SnapshotList":{ "type":"list", "member":{ "shape":"Snapshot", "locationName":"item" } }, "SnapshotState":{ "type":"string", "enum":[ "pending", "completed", "error" ] }, "SnapshotTaskDetail":{ "type":"structure", "members":{ "DiskImageSize":{ "shape":"Double", "documentation":"

The size of the disk in the snapshot, in GiB.

", "locationName":"diskImageSize" }, "Description":{ "shape":"String", "documentation":"

The description of the snapshot.

", "locationName":"description" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image from which the snapshot is created.

", "locationName":"format" }, "Url":{ "shape":"String", "documentation":"

The URL of the disk image from which the snapshot is created.

", "locationName":"url" }, "UserBucket":{ "shape":"UserBucketDetails", "documentation":"

The S3 bucket for the disk image.

", "locationName":"userBucket" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot ID of the disk being imported.

", "locationName":"snapshotId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of completion for the import snapshot task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message for the import snapshot task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status for the import snapshot task.

", "locationName":"status" } }, "documentation":"

Details about the import snapshot task.

" }, "SpotDatafeedSubscription":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the account.

", "locationName":"ownerId" }, "Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket where the Spot instance data feed is located.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

The prefix that is prepended to data feed files.

", "locationName":"prefix" }, "State":{ "shape":"DatafeedSubscriptionState", "documentation":"

The state of the Spot instance data feed subscription.

", "locationName":"state" }, "Fault":{ "shape":"SpotInstanceStateFault", "documentation":"

The fault codes for the Spot instance request, if any.

", "locationName":"fault" } }, "documentation":"

Describes the data feed for a Spot instance.

" }, "SpotFleetLaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", "locationName":"groupSet" }, "UserData":{ "shape":"String", "documentation":"

The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" }, "Monitoring":{ "shape":"SpotFleetMonitoring", "documentation":"

Enable or disable monitoring for the instances.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, \"subnet-a61dafcf, subnet-65ea5f08\".

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "WeightedCapacity":{ "shape":"Double", "documentation":"

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).

If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.

", "locationName":"weightedCapacity" }, "SpotPrice":{ "shape":"String", "documentation":"

The bid price per unit hour for the specified instance type. If this value is not specified, the default is the Spot bid price specified for the fleet. To determine the bid price per unit hour, divide the Spot bid price by the value of WeightedCapacity.

", "locationName":"spotPrice" } }, "documentation":"

Describes the launch specification for one or more Spot instances.

" }, "SpotFleetMonitoring":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Enables monitoring for the instance.

Default: false

", "locationName":"enabled" } }, "documentation":"

Describes whether monitoring is enabled.

" }, "SpotFleetRequestConfig":{ "type":"structure", "required":[ "SpotFleetRequestId", "SpotFleetRequestState", "SpotFleetRequestConfig", "CreateTime" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "SpotFleetRequestState":{ "shape":"BatchState", "documentation":"

The state of the Spot fleet request.

", "locationName":"spotFleetRequestState" }, "SpotFleetRequestConfig":{ "shape":"SpotFleetRequestConfigData", "documentation":"

Information about the configuration of the Spot fleet request.

", "locationName":"spotFleetRequestConfig" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The creation date and time of the request.

", "locationName":"createTime" }, "ActivityStatus":{ "shape":"ActivityStatus", "documentation":"

The progress of the Spot fleet request. If there is an error, the status is error. After all bids are placed, the status is pending_fulfillment. If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the fleet is decreased, the status is pending_termination while Spot instances are terminating.

", "locationName":"activityStatus" } }, "documentation":"

Describes a Spot fleet request.

" }, "SpotFleetRequestConfigData":{ "type":"structure", "required":[ "SpotPrice", "TargetCapacity", "IamFleetRole", "LaunchSpecifications" ], "members":{ "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" }, "SpotPrice":{ "shape":"String", "documentation":"

The bid price per unit hour.

", "locationName":"spotPrice" }, "TargetCapacity":{ "shape":"Integer", "documentation":"

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O.

", "locationName":"targetCapacity" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot instance requests are placed or enabled to fulfill the request.

", "locationName":"validUntil" }, "TerminateInstancesWithExpiration":{ "shape":"Boolean", "documentation":"

Indicates whether running Spot instances should be terminated when the Spot fleet request expires.

", "locationName":"terminateInstancesWithExpiration" }, "IamFleetRole":{ "shape":"String", "documentation":"

Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration.

", "locationName":"iamFleetRole" }, "LaunchSpecifications":{ "shape":"LaunchSpecsList", "documentation":"

Information about the launch specifications for the Spot fleet request.

", "locationName":"launchSpecifications" }, "ExcessCapacityTerminationPolicy":{ "shape":"ExcessCapacityTerminationPolicy", "documentation":"

Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.

", "locationName":"excessCapacityTerminationPolicy" }, "AllocationStrategy":{ "shape":"AllocationStrategy", "documentation":"

Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is lowestPrice.

", "locationName":"allocationStrategy" }, "FulfilledCapacity":{ "shape":"Double", "documentation":"

The number of units fulfilled by this request compared to the set target capacity.

", "locationName":"fulfilledCapacity" }, "Type":{ "shape":"FleetType", "documentation":"

The type of request. Indicates whether the fleet will only request the target capacity or also attempt to maintain it. When you request a certain target capacity, the fleet will only place the required bids. It will not attempt to replenish Spot instances if capacity is diminished, nor will it submit bids in alternative Spot pools if capacity is not available. When you want to maintain a certain target capacity, fleet will place the required bids to meet this target capacity. It will also automatically replenish any interrupted instances. Default: maintain.

", "locationName":"type" } }, "documentation":"

Describes the configuration of a Spot fleet request.

" }, "SpotFleetRequestConfigSet":{ "type":"list", "member":{ "shape":"SpotFleetRequestConfig", "locationName":"item" } }, "SpotInstanceRequest":{ "type":"structure", "members":{ "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot instance request.

", "locationName":"spotInstanceRequestId" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum hourly price (bid) for the Spot instance launched to fulfill the request.

", "locationName":"spotPrice" }, "Type":{ "shape":"SpotInstanceType", "documentation":"

The Spot instance request type.

", "locationName":"type" }, "State":{ "shape":"SpotInstanceState", "documentation":"

The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"state" }, "Fault":{ "shape":"SpotInstanceStateFault", "documentation":"

The fault codes for the Spot instance request, if any.

", "locationName":"fault" }, "Status":{ "shape":"SpotInstanceStatus", "documentation":"

The status code and status message describing the Spot instance request.

", "locationName":"status" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.

", "locationName":"validUntil" }, "LaunchGroup":{ "shape":"String", "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

", "locationName":"launchGroup" }, "AvailabilityZoneGroup":{ "shape":"String", "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.

", "locationName":"availabilityZoneGroup" }, "LaunchSpecification":{ "shape":"LaunchSpecification", "documentation":"

Additional information for launching instances.

", "locationName":"launchSpecification" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID, if an instance has been launched to fulfill the Spot instance request.

", "locationName":"instanceId" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The date and time when the Spot instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"createTime" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The product description associated with the Spot instance.

", "locationName":"productDescription" }, "BlockDurationMinutes":{ "shape":"Integer", "documentation":"

The duration for the Spot instance, in minutes.

", "locationName":"blockDurationMinutes" }, "ActualBlockHourlyPrice":{ "shape":"String", "documentation":"

If you specified a duration and your Spot instance request was fulfilled, this is the fixed hourly price in effect for the Spot instance while it runs.

", "locationName":"actualBlockHourlyPrice" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "LaunchedAvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the bid is launched.

", "locationName":"launchedAvailabilityZone" } }, "documentation":"

Describes a Spot instance request.

" }, "SpotInstanceRequestIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"SpotInstanceRequestId" } }, "SpotInstanceRequestList":{ "type":"list", "member":{ "shape":"SpotInstanceRequest", "locationName":"item" } }, "SpotInstanceState":{ "type":"string", "enum":[ "open", "active", "closed", "cancelled", "failed" ] }, "SpotInstanceStateFault":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The reason code for the Spot instance state change.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The message for the Spot instance state change.

", "locationName":"message" } }, "documentation":"

Describes a Spot instance state change.

" }, "SpotInstanceStatus":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The status code. For a list of status codes, see Spot Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"code" }, "UpdateTime":{ "shape":"DateTime", "documentation":"

The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"updateTime" }, "Message":{ "shape":"String", "documentation":"

The description for the status code.

", "locationName":"message" } }, "documentation":"

Describes the status of a Spot instance request.

" }, "SpotInstanceType":{ "type":"string", "enum":[ "one-time", "persistent" ] }, "SpotPlacement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

[Spot fleet only] To specify multiple Availability Zones, separate them using commas; for example, \"us-west-2a, us-west-2b\".

", "locationName":"availabilityZone" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group (for cluster instances).

", "locationName":"groupName" } }, "documentation":"

Describes Spot instance placement.

" }, "SpotPrice":{ "type":"structure", "members":{ "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

A general description of the AMI.

", "locationName":"productDescription" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum price (bid) that you are willing to pay for a Spot instance.

", "locationName":"spotPrice" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"timestamp" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" } }, "documentation":"

Describes the maximum hourly price (bid) for any Spot instance launched to fulfill the request.

" }, "SpotPriceHistoryList":{ "type":"list", "member":{ "shape":"SpotPrice", "locationName":"item" } }, "StaleIpPermission":{ "type":"structure", "members":{ "FromPort":{ "shape":"Integer", "documentation":"

The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", "locationName":"fromPort" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

", "locationName":"ipProtocol" }, "IpRanges":{ "shape":"IpRanges", "documentation":"

One or more IP ranges. Not applicable for stale security group rules.

", "locationName":"ipRanges" }, "PrefixListIds":{ "shape":"PrefixListIdSet", "documentation":"

One or more prefix list IDs for an AWS service. Not applicable for stale security group rules.

", "locationName":"prefixListIds" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", "locationName":"toPort" }, "UserIdGroupPairs":{ "shape":"UserIdGroupPairSet", "documentation":"

One or more security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.

", "locationName":"groups" } }, "documentation":"

Describes a stale rule in a security group.

" }, "StaleIpPermissionSet":{ "type":"list", "member":{ "shape":"StaleIpPermission", "locationName":"item" } }, "StaleSecurityGroup":{ "type":"structure", "required":["GroupId"], "members":{ "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "Description":{ "shape":"String", "documentation":"

The description of the security group.

", "locationName":"description" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for the security group.

", "locationName":"vpcId" }, "StaleIpPermissions":{ "shape":"StaleIpPermissionSet", "documentation":"

Information about the stale inbound rules in the security group.

", "locationName":"staleIpPermissions" }, "StaleIpPermissionsEgress":{ "shape":"StaleIpPermissionSet", "documentation":"

Information about the stale outbound rules in the security group.

", "locationName":"staleIpPermissionsEgress" } }, "documentation":"

Describes a stale security group (a security group that contains stale rules).

" }, "StaleSecurityGroupSet":{ "type":"list", "member":{ "shape":"StaleSecurityGroup", "locationName":"item" } }, "StartInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for StartInstances.

" }, "StartInstancesResult":{ "type":"structure", "members":{ "StartingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more started instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of StartInstances.

" }, "State":{ "type":"string", "enum":[ "Pending", "Available", "Deleting", "Deleted" ] }, "StateReason":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The reason code for the state change.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The message for the state change.

  • Server.SpotInstanceTermination: A Spot instance was terminated due to an increase in the market price.

  • Server.InternalError: An internal error occurred during instance launch, resulting in termination.

  • Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

  • Client.InternalError: A client error caused the instance to terminate on launch.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your limits.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

", "locationName":"message" } }, "documentation":"

Describes a state change.

" }, "Status":{ "type":"string", "enum":[ "MoveInProgress", "InVpc", "InClassic" ] }, "StatusName":{ "type":"string", "enum":["reachability"] }, "StatusType":{ "type":"string", "enum":[ "passed", "failed", "insufficient-data", "initializing" ] }, "StopInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" }, "Force":{ "shape":"Boolean", "documentation":"

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

", "locationName":"force" } }, "documentation":"

Contains the parameters for StopInstances.

" }, "StopInstancesResult":{ "type":"structure", "members":{ "StoppingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more stopped instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of StopInstances.

" }, "Storage":{ "type":"structure", "members":{ "S3":{ "shape":"S3Storage", "documentation":"

An Amazon S3 storage location.

" } }, "documentation":"

Describes the storage location for an instance store-backed AMI.

" }, "String":{"type":"string"}, "Subnet":{ "type":"structure", "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "State":{ "shape":"SubnetState", "documentation":"

The current state of the subnet.

", "locationName":"state" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC the subnet is in.

", "locationName":"vpcId" }, "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block assigned to the subnet.

", "locationName":"cidrBlock" }, "AvailableIpAddressCount":{ "shape":"Integer", "documentation":"

The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.

", "locationName":"availableIpAddressCount" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the subnet.

", "locationName":"availabilityZone" }, "DefaultForAz":{ "shape":"Boolean", "documentation":"

Indicates whether this is the default subnet for the Availability Zone.

", "locationName":"defaultForAz" }, "MapPublicIpOnLaunch":{ "shape":"Boolean", "documentation":"

Indicates whether instances launched in this subnet receive a public IP address.

", "locationName":"mapPublicIpOnLaunch" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the subnet.

", "locationName":"tagSet" } }, "documentation":"

Describes a subnet.

" }, "SubnetIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SubnetId" } }, "SubnetList":{ "type":"list", "member":{ "shape":"Subnet", "locationName":"item" } }, "SubnetState":{ "type":"string", "enum":[ "pending", "available" ] }, "SummaryStatus":{ "type":"string", "enum":[ "ok", "impaired", "insufficient-data", "not-applicable", "initializing" ] }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", "locationName":"value" } }, "documentation":"

Describes a tag.

" }, "TagDescription":{ "type":"structure", "members":{ "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource. For example, ami-1a2b3c4d.

", "locationName":"resourceId" }, "ResourceType":{ "shape":"ResourceType", "documentation":"

The resource type.

", "locationName":"resourceType" }, "Key":{ "shape":"String", "documentation":"

The tag key.

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The tag value.

", "locationName":"value" } }, "documentation":"

Describes a tag.

" }, "TagDescriptionList":{ "type":"list", "member":{ "shape":"TagDescription", "locationName":"item" } }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"item" } }, "TelemetryStatus":{ "type":"string", "enum":[ "UP", "DOWN" ] }, "Tenancy":{ "type":"string", "enum":[ "default", "dedicated", "host" ] }, "TerminateInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } }, "documentation":"

Contains the parameters for TerminateInstances.

" }, "TerminateInstancesResult":{ "type":"structure", "members":{ "TerminatingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more terminated instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of TerminateInstances.

" }, "TrafficType":{ "type":"string", "enum":[ "ACCEPT", "REJECT", "ALL" ] }, "UnassignPrivateIpAddressesRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "PrivateIpAddresses" ], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", "documentation":"

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

", "locationName":"privateIpAddress" } }, "documentation":"

Contains the parameters for UnassignPrivateIpAddresses.

" }, "UnmonitorInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } }, "documentation":"

Contains the parameters for UnmonitorInstances.

" }, "UnmonitorInstancesResult":{ "type":"structure", "members":{ "InstanceMonitorings":{ "shape":"InstanceMonitoringList", "documentation":"

Monitoring information for one or more instances.

", "locationName":"instancesSet" } }, "documentation":"

Contains the output of UnmonitorInstances.

" }, "UnsuccessfulItem":{ "type":"structure", "required":["Error"], "members":{ "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource.

", "locationName":"resourceId" }, "Error":{ "shape":"UnsuccessfulItemError", "documentation":"

Information about the error.

", "locationName":"error" } }, "documentation":"

Information about items that were not successfully processed in a batch call.

" }, "UnsuccessfulItemError":{ "type":"structure", "required":[ "Code", "Message" ], "members":{ "Code":{ "shape":"String", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The error message accompanying the error code.

", "locationName":"message" } }, "documentation":"

Information about the error that occurred. For more information about errors, see Error Codes.

" }, "UnsuccessfulItemList":{ "type":"list", "member":{ "shape":"UnsuccessfulItem", "locationName":"item" } }, "UnsuccessfulItemSet":{ "type":"list", "member":{ "shape":"UnsuccessfulItem", "locationName":"item" } }, "UserBucket":{ "type":"structure", "members":{ "S3Bucket":{ "shape":"String", "documentation":"

The name of the S3 bucket where the disk image is located.

" }, "S3Key":{ "shape":"String", "documentation":"

The file name of the disk image.

" } }, "documentation":"

Describes the S3 bucket for the disk image.

" }, "UserBucketDetails":{ "type":"structure", "members":{ "S3Bucket":{ "shape":"String", "documentation":"

The S3 bucket from which the disk image was created.

", "locationName":"s3Bucket" }, "S3Key":{ "shape":"String", "documentation":"

The file name of the disk image.

", "locationName":"s3Key" } }, "documentation":"

Describes the S3 bucket for the disk image.

" }, "UserData":{ "type":"structure", "members":{ "Data":{ "shape":"String", "documentation":"

The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", "locationName":"data" } }, "documentation":"

Describes the user data for an instance.

" }, "UserGroupStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"UserGroup" } }, "UserIdGroupPair":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The ID of an AWS account. For a referenced security group in another VPC, the account ID of the referenced security group is returned.

[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.

", "locationName":"userId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for the referenced security group, if applicable.

", "locationName":"vpcId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection, if applicable.

", "locationName":"vpcPeeringConnectionId" }, "PeeringStatus":{ "shape":"String", "documentation":"

The status of a VPC peering connection, if applicable.

", "locationName":"peeringStatus" } }, "documentation":"

Describes a security group and AWS account ID pair.

" }, "UserIdGroupPairList":{ "type":"list", "member":{ "shape":"UserIdGroupPair", "locationName":"item" } }, "UserIdGroupPairSet":{ "type":"list", "member":{ "shape":"UserIdGroupPair", "locationName":"item" } }, "UserIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"UserId" } }, "ValueStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "VgwTelemetry":{ "type":"structure", "members":{ "OutsideIpAddress":{ "shape":"String", "documentation":"

The Internet-routable IP address of the virtual private gateway's outside interface.

", "locationName":"outsideIpAddress" }, "Status":{ "shape":"TelemetryStatus", "documentation":"

The status of the VPN tunnel.

", "locationName":"status" }, "LastStatusChange":{ "shape":"DateTime", "documentation":"

The date and time of the last change in status.

", "locationName":"lastStatusChange" }, "StatusMessage":{ "shape":"String", "documentation":"

If an error occurs, a description of the error.

", "locationName":"statusMessage" }, "AcceptedRouteCount":{ "shape":"Integer", "documentation":"

The number of accepted routes.

", "locationName":"acceptedRouteCount" } }, "documentation":"

Describes telemetry for a VPN tunnel.

" }, "VgwTelemetryList":{ "type":"list", "member":{ "shape":"VgwTelemetry", "locationName":"item" } }, "VirtualizationType":{ "type":"string", "enum":[ "hvm", "paravirtual" ] }, "Volume":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "Size":{ "shape":"Integer", "documentation":"

The size of the volume, in GiBs.

", "locationName":"size" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot from which the volume was created, if applicable.

", "locationName":"snapshotId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the volume.

", "locationName":"availabilityZone" }, "State":{ "shape":"VolumeState", "documentation":"

The volume state.

", "locationName":"status" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The time stamp when volume creation was initiated.

", "locationName":"createTime" }, "Attachments":{ "shape":"VolumeAttachmentList", "documentation":"

Information about the volume attachments.

", "locationName":"attachmentSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the volume.

", "locationName":"tagSet" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

", "locationName":"volumeType" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", "locationName":"iops" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the volume will be encrypted.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

", "locationName":"kmsKeyId" } }, "documentation":"

Describes a volume.

" }, "VolumeAttachment":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Device":{ "shape":"String", "documentation":"

The device name.

", "locationName":"device" }, "State":{ "shape":"VolumeAttachmentState", "documentation":"

The attachment state of the volume.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes volume attachment details.

" }, "VolumeAttachmentList":{ "type":"list", "member":{ "shape":"VolumeAttachment", "locationName":"item" } }, "VolumeAttachmentState":{ "type":"string", "enum":[ "attaching", "attached", "detaching", "detached" ] }, "VolumeAttributeName":{ "type":"string", "enum":[ "autoEnableIO", "productCodes" ] }, "VolumeDetail":{ "type":"structure", "required":["Size"], "members":{ "Size":{ "shape":"Long", "documentation":"

The size of the volume, in GiB.

", "locationName":"size" } }, "documentation":"

Describes an EBS volume.

" }, "VolumeIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VolumeId" } }, "VolumeList":{ "type":"list", "member":{ "shape":"Volume", "locationName":"item" } }, "VolumeState":{ "type":"string", "enum":[ "creating", "available", "in-use", "deleting", "deleted", "error" ] }, "VolumeStatusAction":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The code identifying the operation, for example, enable-volume-io.

", "locationName":"code" }, "Description":{ "shape":"String", "documentation":"

A description of the operation.

", "locationName":"description" }, "EventType":{ "shape":"String", "documentation":"

The event type associated with this operation.

", "locationName":"eventType" }, "EventId":{ "shape":"String", "documentation":"

The ID of the event associated with this operation.

", "locationName":"eventId" } }, "documentation":"

Describes a volume status operation code.

" }, "VolumeStatusActionsList":{ "type":"list", "member":{ "shape":"VolumeStatusAction", "locationName":"item" } }, "VolumeStatusDetails":{ "type":"structure", "members":{ "Name":{ "shape":"VolumeStatusName", "documentation":"

The name of the volume status.

", "locationName":"name" }, "Status":{ "shape":"String", "documentation":"

The intended status of the volume status.

", "locationName":"status" } }, "documentation":"

Describes a volume status.

" }, "VolumeStatusDetailsList":{ "type":"list", "member":{ "shape":"VolumeStatusDetails", "locationName":"item" } }, "VolumeStatusEvent":{ "type":"structure", "members":{ "EventType":{ "shape":"String", "documentation":"

The type of this event.

", "locationName":"eventType" }, "Description":{ "shape":"String", "documentation":"

A description of the event.

", "locationName":"description" }, "NotBefore":{ "shape":"DateTime", "documentation":"

The earliest start time of the event.

", "locationName":"notBefore" }, "NotAfter":{ "shape":"DateTime", "documentation":"

The latest end time of the event.

", "locationName":"notAfter" }, "EventId":{ "shape":"String", "documentation":"

The ID of this event.

", "locationName":"eventId" } }, "documentation":"

Describes a volume status event.

" }, "VolumeStatusEventsList":{ "type":"list", "member":{ "shape":"VolumeStatusEvent", "locationName":"item" } }, "VolumeStatusInfo":{ "type":"structure", "members":{ "Status":{ "shape":"VolumeStatusInfoStatus", "documentation":"

The status of the volume.

", "locationName":"status" }, "Details":{ "shape":"VolumeStatusDetailsList", "documentation":"

The details of the volume status.

", "locationName":"details" } }, "documentation":"

Describes the status of a volume.

" }, "VolumeStatusInfoStatus":{ "type":"string", "enum":[ "ok", "impaired", "insufficient-data" ] }, "VolumeStatusItem":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

", "locationName":"volumeId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the volume.

", "locationName":"availabilityZone" }, "VolumeStatus":{ "shape":"VolumeStatusInfo", "documentation":"

The volume status.

", "locationName":"volumeStatus" }, "Events":{ "shape":"VolumeStatusEventsList", "documentation":"

A list of events associated with the volume.

", "locationName":"eventsSet" }, "Actions":{ "shape":"VolumeStatusActionsList", "documentation":"

The details of the operation.

", "locationName":"actionsSet" } }, "documentation":"

Describes the volume status.

" }, "VolumeStatusList":{ "type":"list", "member":{ "shape":"VolumeStatusItem", "locationName":"item" } }, "VolumeStatusName":{ "type":"string", "enum":[ "io-enabled", "io-performance" ] }, "VolumeType":{ "type":"string", "enum":[ "standard", "io1", "gp2", "sc1", "st1" ] }, "Vpc":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"VpcState", "documentation":"

The current state of the VPC.

", "locationName":"state" }, "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block for the VPC.

", "locationName":"cidrBlock" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

", "locationName":"dhcpOptionsId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPC.

", "locationName":"tagSet" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The allowed tenancy of instances launched into the VPC.

", "locationName":"instanceTenancy" }, "IsDefault":{ "shape":"Boolean", "documentation":"

Indicates whether the VPC is the default VPC.

", "locationName":"isDefault" } }, "documentation":"

Describes a VPC.

" }, "VpcAttachment":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"AttachmentStatus", "documentation":"

The current state of the attachment.

", "locationName":"state" } }, "documentation":"

Describes an attachment between a virtual private gateway and a VPC.

" }, "VpcAttachmentList":{ "type":"list", "member":{ "shape":"VpcAttachment", "locationName":"item" } }, "VpcAttributeName":{ "type":"string", "enum":[ "enableDnsSupport", "enableDnsHostnames" ] }, "VpcClassicLink":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "ClassicLinkEnabled":{ "shape":"Boolean", "documentation":"

Indicates whether the VPC is enabled for ClassicLink.

", "locationName":"classicLinkEnabled" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPC.

", "locationName":"tagSet" } }, "documentation":"

Describes whether a VPC is enabled for ClassicLink.

" }, "VpcClassicLinkIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcId" } }, "VpcClassicLinkList":{ "type":"list", "member":{ "shape":"VpcClassicLink", "locationName":"item" } }, "VpcEndpoint":{ "type":"structure", "members":{ "VpcEndpointId":{ "shape":"String", "documentation":"

The ID of the VPC endpoint.

", "locationName":"vpcEndpointId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC to which the endpoint is associated.

", "locationName":"vpcId" }, "ServiceName":{ "shape":"String", "documentation":"

The name of the AWS service to which the endpoint is associated.

", "locationName":"serviceName" }, "State":{ "shape":"State", "documentation":"

The state of the VPC endpoint.

", "locationName":"state" }, "PolicyDocument":{ "shape":"String", "documentation":"

The policy document associated with the endpoint.

", "locationName":"policyDocument" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route tables associated with the endpoint.

", "locationName":"routeTableIdSet" }, "CreationTimestamp":{ "shape":"DateTime", "documentation":"

The date and time the VPC endpoint was created.

", "locationName":"creationTimestamp" } }, "documentation":"

Describes a VPC endpoint.

" }, "VpcEndpointSet":{ "type":"list", "member":{ "shape":"VpcEndpoint", "locationName":"item" } }, "VpcIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcId" } }, "VpcList":{ "type":"list", "member":{ "shape":"Vpc", "locationName":"item" } }, "VpcPeeringConnection":{ "type":"structure", "members":{ "AccepterVpcInfo":{ "shape":"VpcPeeringConnectionVpcInfo", "documentation":"

Information about the accepter VPC. CIDR block information is not returned when creating a VPC peering connection, or when describing a VPC peering connection that's in the initiating-request or pending-acceptance state.

", "locationName":"accepterVpcInfo" }, "ExpirationTime":{ "shape":"DateTime", "documentation":"

The time that an unaccepted VPC peering connection will expire.

", "locationName":"expirationTime" }, "RequesterVpcInfo":{ "shape":"VpcPeeringConnectionVpcInfo", "documentation":"

Information about the requester VPC.

", "locationName":"requesterVpcInfo" }, "Status":{ "shape":"VpcPeeringConnectionStateReason", "documentation":"

The status of the VPC peering connection.

", "locationName":"status" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Describes a VPC peering connection.

" }, "VpcPeeringConnectionList":{ "type":"list", "member":{ "shape":"VpcPeeringConnection", "locationName":"item" } }, "VpcPeeringConnectionOptionsDescription":{ "type":"structure", "members":{ "AllowEgressFromLocalClassicLinkToRemoteVpc":{ "shape":"Boolean", "documentation":"

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

", "locationName":"allowEgressFromLocalClassicLinkToRemoteVpc" }, "AllowEgressFromLocalVpcToRemoteClassicLink":{ "shape":"Boolean", "documentation":"

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.

", "locationName":"allowEgressFromLocalVpcToRemoteClassicLink" }, "AllowDnsResolutionFromRemoteVpc":{ "shape":"Boolean", "documentation":"

Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.

", "locationName":"allowDnsResolutionFromRemoteVpc" } }, "documentation":"

Describes the VPC peering connection options.

" }, "VpcPeeringConnectionStateReason":{ "type":"structure", "members":{ "Code":{ "shape":"VpcPeeringConnectionStateReasonCode", "documentation":"

The status of the VPC peering connection.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

A message that provides more information about the status, if applicable.

", "locationName":"message" } }, "documentation":"

Describes the status of a VPC peering connection.

" }, "VpcPeeringConnectionStateReasonCode":{ "type":"string", "enum":[ "initiating-request", "pending-acceptance", "active", "deleted", "rejected", "failed", "expired", "provisioning", "deleting" ] }, "VpcPeeringConnectionVpcInfo":{ "type":"structure", "members":{ "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block for the VPC.

", "locationName":"cidrBlock" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the VPC owner.

", "locationName":"ownerId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "PeeringOptions":{ "shape":"VpcPeeringConnectionOptionsDescription", "documentation":"

Information about the VPC peering connection options for the accepter or requester VPC.

", "locationName":"peeringOptions" } }, "documentation":"

Describes a VPC in a VPC peering connection.

" }, "VpcState":{ "type":"string", "enum":[ "pending", "available" ] }, "VpnConnection":{ "type":"structure", "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

", "locationName":"vpnConnectionId" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the VPN connection.

", "locationName":"state" }, "CustomerGatewayConfiguration":{ "shape":"String", "documentation":"

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

", "locationName":"customerGatewayConfiguration" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection.

", "locationName":"type" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway at your end of the VPN connection.

", "locationName":"customerGatewayId" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

", "locationName":"vpnGatewayId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPN connection.

", "locationName":"tagSet" }, "VgwTelemetry":{ "shape":"VgwTelemetryList", "documentation":"

Information about the VPN tunnel.

", "locationName":"vgwTelemetry" }, "Options":{ "shape":"VpnConnectionOptions", "documentation":"

The VPN connection options.

", "locationName":"options" }, "Routes":{ "shape":"VpnStaticRouteList", "documentation":"

The static routes associated with the VPN connection.

", "locationName":"routes" } }, "documentation":"

Describes a VPN connection.

" }, "VpnConnectionIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpnConnectionId" } }, "VpnConnectionList":{ "type":"list", "member":{ "shape":"VpnConnection", "locationName":"item" } }, "VpnConnectionOptions":{ "type":"structure", "members":{ "StaticRoutesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "locationName":"staticRoutesOnly" } }, "documentation":"

Describes VPN connection options.

" }, "VpnConnectionOptionsSpecification":{ "type":"structure", "members":{ "StaticRoutesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "locationName":"staticRoutesOnly" } }, "documentation":"

Describes VPN connection options.

" }, "VpnGateway":{ "type":"structure", "members":{ "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

", "locationName":"vpnGatewayId" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the virtual private gateway.

", "locationName":"state" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection the virtual private gateway supports.

", "locationName":"type" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

", "locationName":"availabilityZone" }, "VpcAttachments":{ "shape":"VpcAttachmentList", "documentation":"

Any VPCs attached to the virtual private gateway.

", "locationName":"attachments" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the virtual private gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes a virtual private gateway.

" }, "VpnGatewayIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpnGatewayId" } }, "VpnGatewayList":{ "type":"list", "member":{ "shape":"VpnGateway", "locationName":"item" } }, "VpnState":{ "type":"string", "enum":[ "pending", "available", "deleting", "deleted" ] }, "VpnStaticRoute":{ "type":"structure", "members":{ "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer data center.

", "locationName":"destinationCidrBlock" }, "Source":{ "shape":"VpnStaticRouteSource", "documentation":"

Indicates how the routes were provided.

", "locationName":"source" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the static route.

", "locationName":"state" } }, "documentation":"

Describes a static route for a VPN connection.

" }, "VpnStaticRouteList":{ "type":"list", "member":{ "shape":"VpnStaticRoute", "locationName":"item" } }, "VpnStaticRouteSource":{ "type":"string", "enum":["Static"] }, "ZoneNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ZoneName" } } }, "documentation":"Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.

" } botocore-1.5.7/botocore/data/ec2/2015-04-15/0000777454262600001440000000000013042511307020637 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ec2/2015-04-15/waiters-2.json0000666454262600001440000002643213042511306023355 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "InstanceExists": { "delay": 5, "maxAttempts": 40, "operation": "DescribeInstances", "acceptors": [ { "matcher": "status", "expected": 200, "state": "success" }, { "matcher": "error", "expected": "InvalidInstanceIDNotFound", "state": "retry" } ] }, "BundleTaskComplete": { "delay": 15, "operation": "DescribeBundleTasks", "maxAttempts": 40, "acceptors": [ { "expected": "complete", "matcher": "pathAll", "state": "success", "argument": "BundleTasks[].State" }, { "expected": "failed", "matcher": "pathAny", "state": "failure", "argument": "BundleTasks[].State" } ] }, "ConversionTaskCancelled": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "cancelled", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" } ] }, "ConversionTaskCompleted": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" }, { "expected": "cancelled", "matcher": "pathAny", "state": "failure", "argument": "ConversionTasks[].State" }, { "expected": "cancelling", "matcher": "pathAny", "state": "failure", "argument": "ConversionTasks[].State" } ] }, "ConversionTaskDeleted": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" } ] }, "CustomerGatewayAvailable": { "delay": 15, "operation": "DescribeCustomerGateways", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "CustomerGateways[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "CustomerGateways[].State" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "CustomerGateways[].State" } ] }, "ExportTaskCancelled": { "delay": 15, "operation": "DescribeExportTasks", "maxAttempts": 40, "acceptors": [ { "expected": "cancelled", "matcher": "pathAll", "state": "success", "argument": "ExportTasks[].State" } ] }, "ExportTaskCompleted": { "delay": 15, "operation": "DescribeExportTasks", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "ExportTasks[].State" } ] }, "ImageAvailable": { "operation": "DescribeImages", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "Images[].State", "expected": "available" }, { "state": "failure", "matcher": "pathAny", "argument": "Images[].State", "expected": "failed" } ] }, "InstanceRunning": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "running", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "shutting-down", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "InstanceStatusOk": { "operation": "DescribeInstanceStatus", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "InstanceStatuses[].InstanceStatus.Status", "expected": "ok" } ] }, "InstanceStopped": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "stopped", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "InstanceTerminated": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "terminated", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "PasswordDataAvailable": { "operation": "GetPasswordData", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "path", "argument": "length(PasswordData) > `0`", "expected": true } ] }, "SnapshotCompleted": { "delay": 15, "operation": "DescribeSnapshots", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "Snapshots[].State" } ] }, "SpotInstanceRequestFulfilled": { "operation": "DescribeSpotInstanceRequests", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "SpotInstanceRequests[].Status.Code", "expected": "fulfilled" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "schedule-expired" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "canceled-before-fulfillment" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "bad-parameters" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "system-error" } ] }, "SubnetAvailable": { "delay": 15, "operation": "DescribeSubnets", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Subnets[].State" } ] }, "SystemStatusOk": { "operation": "DescribeInstanceStatus", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "InstanceStatuses[].SystemStatus.Status", "expected": "ok" } ] }, "VolumeAvailable": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Volumes[].State" } ] }, "VolumeDeleted": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "matcher": "error", "expected": "InvalidVolumeNotFound", "state": "success" } ] }, "VolumeInUse": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "in-use", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Volumes[].State" } ] }, "VpcAvailable": { "delay": 15, "operation": "DescribeVpcs", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Vpcs[].State" } ] }, "VpnConnectionAvailable": { "delay": 15, "operation": "DescribeVpnConnections", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "VpnConnections[].State" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" } ] }, "VpnConnectionDeleted": { "delay": 15, "operation": "DescribeVpnConnections", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "VpnConnections[].State" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" } ] } } } botocore-1.5.7/botocore/data/ec2/2015-04-15/paginators-1.json0000666454262600001440000000263713042511306024046 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeInstanceStatus": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "InstanceStatuses" }, "DescribeInstances": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Reservations" }, "DescribeReservedInstancesModifications": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "ReservedInstancesModifications" }, "DescribeReservedInstancesOfferings": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "ReservedInstancesOfferings" }, "DescribeSpotPriceHistory": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "SpotPriceHistory" }, "DescribeTags": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Tags" }, "DescribeVolumeStatus": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "VolumeStatuses" }, "DescribeSnapshots": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Snapshots" } } } botocore-1.5.7/botocore/data/ec2/2015-04-15/service-2.json0000666454262600001440000256504513042511306023351 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-04-15", "endpointPrefix":"ec2", "serviceAbbreviation":"Amazon EC2", "serviceFullName":"Amazon Elastic Compute Cloud", "signatureVersion":"v4", "xmlNamespace":"http://ec2.amazonaws.com/doc/2015-04-15", "protocol":"ec2" }, "documentation":"Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.

", "operations":{ "AcceptVpcPeeringConnection":{ "name":"AcceptVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, "output":{"shape":"AcceptVpcPeeringConnectionResult"}, "documentation":"

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.

" }, "AllocateAddress":{ "name":"AllocateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AllocateAddressRequest"}, "output":{"shape":"AllocateAddressResult"}, "documentation":"

Acquires an Elastic IP address.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" }, "AssignPrivateIpAddresses":{ "name":"AssignPrivateIpAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssignPrivateIpAddressesRequest"}, "documentation":"

Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

AssignPrivateIpAddresses is available only in EC2-VPC.

" }, "AssociateAddress":{ "name":"AssociateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateAddressRequest"}, "output":{"shape":"AssociateAddressResult"}, "documentation":"

Associates an Elastic IP address with an instance or a network interface.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" }, "AssociateDhcpOptions":{ "name":"AssociateDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateDhcpOptionsRequest"}, "documentation":"

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "AssociateRouteTable":{ "name":"AssociateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateRouteTableRequest"}, "output":{"shape":"AssociateRouteTableResult"}, "documentation":"

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "AttachClassicLinkVpc":{ "name":"AttachClassicLinkVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachClassicLinkVpcRequest"}, "output":{"shape":"AttachClassicLinkVpcResult"}, "documentation":"

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" }, "AttachInternetGateway":{ "name":"AttachInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachInternetGatewayRequest"}, "documentation":"

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" }, "AttachNetworkInterface":{ "name":"AttachNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachNetworkInterfaceRequest"}, "output":{"shape":"AttachNetworkInterfaceResult"}, "documentation":"

Attaches a network interface to an instance.

" }, "AttachVolume":{ "name":"AttachVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachVolumeRequest"}, "output":{ "shape":"VolumeAttachment", "documentation":"

Information about the volume attachment.

", "locationName":"attachment" }, "documentation":"

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For a list of supported device names, see Attaching an EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.
  • AWS Marketplace product codes are copied from the volume to the instance.
  • You must be subscribed to the product.
  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For an overview of the AWS Marketplace, see Introducing AWS Marketplace.

For more information about EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "AttachVpnGateway":{ "name":"AttachVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachVpnGatewayRequest"}, "output":{"shape":"AttachVpnGatewayResult"}, "documentation":"

Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "AuthorizeSecurityGroupEgress":{ "name":"AuthorizeSecurityGroupEgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, "documentation":"

Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC.

You can have up to 50 rules per security group (covering both ingress and egress rules).

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

" }, "AuthorizeSecurityGroupIngress":{ "name":"AuthorizeSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, "documentation":"

Adds one or more ingress rules to a security group.

EC2-Classic: You can have up to 100 rules per group.

EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.

[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.

" }, "BundleInstance":{ "name":"BundleInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BundleInstanceRequest"}, "output":{"shape":"BundleInstanceResult"}, "documentation":"

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

For more information, see Creating an Instance Store-Backed Windows AMI.

" }, "CancelBundleTask":{ "name":"CancelBundleTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelBundleTaskRequest"}, "output":{"shape":"CancelBundleTaskResult"}, "documentation":"

Cancels a bundling operation for an instance store-backed Windows instance.

" }, "CancelConversionTask":{ "name":"CancelConversionTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelConversionRequest"}, "documentation":"

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" }, "CancelExportTask":{ "name":"CancelExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelExportTaskRequest"}, "documentation":"

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" }, "CancelImportTask":{ "name":"CancelImportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelImportTaskRequest"}, "output":{"shape":"CancelImportTaskResult"}, "documentation":"

Cancels an in-process import virtual machine or import snapshot task.

" }, "CancelReservedInstancesListing":{ "name":"CancelReservedInstancesListing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelReservedInstancesListingRequest"}, "output":{"shape":"CancelReservedInstancesListingResult"}, "documentation":"

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "CancelSpotFleetRequests":{ "name":"CancelSpotFleetRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CancelSpotFleetRequestsRequest", "documentation":"

Contains the parameters for CancelSpotFleetRequests.

" }, "output":{ "shape":"CancelSpotFleetRequestsResponse", "documentation":"

Contains the output of CancelSpotFleetRequests.

" }, "documentation":"

Cancels the specified Spot fleet requests.

" }, "CancelSpotInstanceRequests":{ "name":"CancelSpotInstanceRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CancelSpotInstanceRequestsRequest", "documentation":"

Contains the parameters for CancelSpotInstanceRequests.

" }, "output":{ "shape":"CancelSpotInstanceRequestsResult", "documentation":"

Contains the output of CancelSpotInstanceRequests.

" }, "documentation":"

Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

Canceling a Spot instance request does not terminate running Spot instances associated with the request.

" }, "ConfirmProductInstance":{ "name":"ConfirmProductInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmProductInstanceRequest"}, "output":{"shape":"ConfirmProductInstanceResult"}, "documentation":"

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.

" }, "CopyImage":{ "name":"CopyImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyImageRequest"}, "output":{"shape":"CopyImageResult"}, "documentation":"

Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted EBS snapshots cannot be copied with this method.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide.

" }, "CopySnapshot":{ "name":"CopySnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopySnapshotRequest"}, "output":{"shape":"CopySnapshotResult"}, "documentation":"

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the KmsKeyId parameter.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateCustomerGateway":{ "name":"CreateCustomerGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCustomerGatewayRequest"}, "output":{"shape":"CreateCustomerGatewayResult"}, "documentation":"

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.

" }, "CreateDhcpOptions":{ "name":"CreateDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDhcpOptionsRequest"}, "output":{"shape":"CreateDhcpOptionsResult"}, "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.
  • domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.
  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateFlowLogs":{ "name":"CreateFlowLogs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateFlowLogsRequest"}, "output":{"shape":"CreateFlowLogsResult"}, "documentation":"

Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs.

In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs.

" }, "CreateImage":{ "name":"CreateImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateImageRequest"}, "output":{"shape":"CreateImageResult"}, "documentation":"

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateInstanceExportTask":{ "name":"CreateInstanceExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInstanceExportTaskRequest"}, "output":{"shape":"CreateInstanceExportTaskResult"}, "documentation":"

Exports a running or stopped instance to an S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting EC2 Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateInternetGateway":{ "name":"CreateInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInternetGatewayRequest"}, "output":{"shape":"CreateInternetGatewayResult"}, "documentation":"

Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" }, "CreateKeyPair":{ "name":"CreateKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateKeyPairRequest"}, "output":{ "shape":"KeyPair", "documentation":"

Information about the key pair.

", "locationName":"keyPair" }, "documentation":"

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateNetworkAcl":{ "name":"CreateNetworkAcl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkAclRequest"}, "output":{"shape":"CreateNetworkAclResult"}, "documentation":"

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkAclEntry":{ "name":"CreateNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkAclEntryRequest"}, "documentation":"

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkInterface":{ "name":"CreateNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkInterfaceRequest"}, "output":{"shape":"CreateNetworkInterfaceResult"}, "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide.

" }, "CreatePlacementGroup":{ "name":"CreatePlacementGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlacementGroupRequest"}, "documentation":"

Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.

For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateReservedInstancesListing":{ "name":"CreateReservedInstancesListing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateReservedInstancesListingRequest"}, "output":{"shape":"CreateReservedInstancesListingResult"}, "documentation":"

Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the DescribeReservedInstances operation.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateRoute":{ "name":"CreateRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRouteRequest"}, "output":{"shape":"CreateRouteResult"}, "documentation":"

Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "CreateRouteTable":{ "name":"CreateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRouteTableRequest"}, "output":{"shape":"CreateRouteTableResult"}, "documentation":"

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "CreateSecurityGroup":{ "name":"CreateSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSecurityGroupRequest"}, "output":{"shape":"CreateSecurityGroupResult"}, "documentation":"

Creates a security group.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

EC2-Classic: You can have up to 500 security groups.

EC2-VPC: You can create up to 100 security groups per VPC.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

" }, "CreateSnapshot":{ "name":"CreateSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSnapshotRequest"}, "output":{ "shape":"Snapshot", "documentation":"

Information about the snapshot.

", "locationName":"snapshot" }, "documentation":"

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateSpotDatafeedSubscription":{ "name":"CreateSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateSpotDatafeedSubscriptionRequest", "documentation":"

Contains the parameters for CreateSpotDatafeedSubscription.

" }, "output":{ "shape":"CreateSpotDatafeedSubscriptionResult", "documentation":"

Contains the output of CreateSpotDatafeedSubscription.

" }, "documentation":"

Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateSubnet":{ "name":"CreateSubnet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSubnetRequest"}, "output":{"shape":"CreateSubnetResult"}, "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).

AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateTags":{ "name":"CreateTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTagsRequest"}, "documentation":"

Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateVolume":{ "name":"CreateVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVolumeRequest"}, "output":{ "shape":"Volume", "documentation":"

Information about the volume.

", "locationName":"volume" }, "documentation":"

Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateVpc":{ "name":"CreateVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcRequest"}, "output":{"shape":"CreateVpcResult"}, "documentation":"

Creates a VPC with the specified CIDR block.

The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpcEndpoint":{ "name":"CreateVpcEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcEndpointRequest"}, "output":{"shape":"CreateVpcEndpointResult"}, "documentation":"

Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.

Currently, only endpoints to Amazon S3 are supported.

" }, "CreateVpcPeeringConnection":{ "name":"CreateVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcPeeringConnectionRequest"}, "output":{"shape":"CreateVpcPeeringConnectionResult"}, "documentation":"

Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.

The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.

" }, "CreateVpnConnection":{ "name":"CreateVpnConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnConnectionRequest"}, "output":{"shape":"CreateVpnConnectionResult"}, "documentation":"

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpnConnectionRoute":{ "name":"CreateVpnConnectionRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnConnectionRouteRequest"}, "documentation":"

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpnGateway":{ "name":"CreateVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnGatewayRequest"}, "output":{"shape":"CreateVpnGatewayResult"}, "documentation":"

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DeleteCustomerGateway":{ "name":"DeleteCustomerGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCustomerGatewayRequest"}, "documentation":"

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" }, "DeleteDhcpOptions":{ "name":"DeleteDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDhcpOptionsRequest"}, "documentation":"

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" }, "DeleteFlowLogs":{ "name":"DeleteFlowLogs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteFlowLogsRequest"}, "output":{"shape":"DeleteFlowLogsResult"}, "documentation":"

Deletes one or more flow logs.

" }, "DeleteInternetGateway":{ "name":"DeleteInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteInternetGatewayRequest"}, "documentation":"

Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.

" }, "DeleteKeyPair":{ "name":"DeleteKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteKeyPairRequest"}, "documentation":"

Deletes the specified key pair, by removing the public key from Amazon EC2.

" }, "DeleteNetworkAcl":{ "name":"DeleteNetworkAcl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkAclRequest"}, "documentation":"

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" }, "DeleteNetworkAclEntry":{ "name":"DeleteNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkAclEntryRequest"}, "documentation":"

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" }, "DeleteNetworkInterface":{ "name":"DeleteNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkInterfaceRequest"}, "documentation":"

Deletes the specified network interface. You must detach the network interface before you can delete it.

" }, "DeletePlacementGroup":{ "name":"DeletePlacementGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePlacementGroupRequest"}, "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteRoute":{ "name":"DeleteRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRouteRequest"}, "documentation":"

Deletes the specified route from the specified route table.

" }, "DeleteRouteTable":{ "name":"DeleteRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRouteTableRequest"}, "documentation":"

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" }, "DeleteSecurityGroup":{ "name":"DeleteSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSecurityGroupRequest"}, "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" }, "DeleteSnapshot":{ "name":"DeleteSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSnapshotRequest"}, "documentation":"

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteSpotDatafeedSubscription":{ "name":"DeleteSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteSpotDatafeedSubscriptionRequest", "documentation":"

Contains the parameters for DeleteSpotDatafeedSubscription.

" }, "documentation":"

Deletes the data feed for Spot instances.

" }, "DeleteSubnet":{ "name":"DeleteSubnet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSubnetRequest"}, "documentation":"

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsRequest"}, "documentation":"

Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteVolume":{ "name":"DeleteVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVolumeRequest"}, "documentation":"

Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).

The volume may remain in the deleting state for several minutes.

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteVpc":{ "name":"DeleteVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcRequest"}, "documentation":"

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" }, "DeleteVpcEndpoints":{ "name":"DeleteVpcEndpoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcEndpointsRequest"}, "output":{"shape":"DeleteVpcEndpointsResult"}, "documentation":"

Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint.

" }, "DeleteVpcPeeringConnection":{ "name":"DeleteVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, "output":{"shape":"DeleteVpcPeeringConnectionResult"}, "documentation":"

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.

" }, "DeleteVpnConnection":{ "name":"DeleteVpnConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnConnectionRequest"}, "documentation":"

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" }, "DeleteVpnConnectionRoute":{ "name":"DeleteVpnConnectionRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnConnectionRouteRequest"}, "documentation":"

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" }, "DeleteVpnGateway":{ "name":"DeleteVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnGatewayRequest"}, "documentation":"

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" }, "DeregisterImage":{ "name":"DeregisterImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterImageRequest"}, "documentation":"

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

This command does not delete the AMI.

" }, "DescribeAccountAttributes":{ "name":"DescribeAccountAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAccountAttributesRequest"}, "output":{"shape":"DescribeAccountAttributesResult"}, "documentation":"

Describes attributes of your AWS account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: The maximum number of On-Demand instances that you can run.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

" }, "DescribeAddresses":{ "name":"DescribeAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAddressesRequest"}, "output":{"shape":"DescribeAddressesResult"}, "documentation":"

Describes one or more of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeAvailabilityZones":{ "name":"DescribeAvailabilityZones", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAvailabilityZonesRequest"}, "output":{"shape":"DescribeAvailabilityZonesResult"}, "documentation":"

Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeBundleTasks":{ "name":"DescribeBundleTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeBundleTasksRequest"}, "output":{"shape":"DescribeBundleTasksResult"}, "documentation":"

Describes one or more of your bundling tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

" }, "DescribeClassicLinkInstances":{ "name":"DescribeClassicLinkInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClassicLinkInstancesRequest"}, "output":{"shape":"DescribeClassicLinkInstancesResult"}, "documentation":"

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.

" }, "DescribeConversionTasks":{ "name":"DescribeConversionTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConversionTasksRequest"}, "output":{"shape":"DescribeConversionTasksResult"}, "documentation":"

Describes one or more of your conversion tasks. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeCustomerGateways":{ "name":"DescribeCustomerGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCustomerGatewaysRequest"}, "output":{"shape":"DescribeCustomerGatewaysResult"}, "documentation":"

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeDhcpOptions":{ "name":"DescribeDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDhcpOptionsRequest"}, "output":{"shape":"DescribeDhcpOptionsResult"}, "documentation":"

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeExportTasks":{ "name":"DescribeExportTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeExportTasksRequest"}, "output":{"shape":"DescribeExportTasksResult"}, "documentation":"

Describes one or more of your export tasks.

" }, "DescribeFlowLogs":{ "name":"DescribeFlowLogs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFlowLogsRequest"}, "output":{"shape":"DescribeFlowLogsResult"}, "documentation":"

Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.

" }, "DescribeImageAttribute":{ "name":"DescribeImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImageAttributeRequest"}, "output":{ "shape":"ImageAttribute", "documentation":"

Information about the image attribute.

", "locationName":"imageAttribute" }, "documentation":"

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" }, "DescribeImages":{ "name":"DescribeImages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImagesRequest"}, "output":{"shape":"DescribeImagesResult"}, "documentation":"

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

Deregistered images are included in the returned results for an unspecified interval after deregistration.

" }, "DescribeImportImageTasks":{ "name":"DescribeImportImageTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImportImageTasksRequest"}, "output":{"shape":"DescribeImportImageTasksResult"}, "documentation":"

Displays details about an import virtual machine or import snapshot tasks that are already created.

" }, "DescribeImportSnapshotTasks":{ "name":"DescribeImportSnapshotTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImportSnapshotTasksRequest"}, "output":{"shape":"DescribeImportSnapshotTasksResult"}, "documentation":"

Describes your import snapshot tasks.

" }, "DescribeInstanceAttribute":{ "name":"DescribeInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceAttributeRequest"}, "output":{ "shape":"InstanceAttribute", "documentation":"

Information about the instance attribute.

" }, "documentation":"

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" }, "DescribeInstanceStatus":{ "name":"DescribeInstanceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceStatusRequest"}, "output":{"shape":"DescribeInstanceStatusResult"}, "documentation":"

Describes the status of one or more instances.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeInstances":{ "name":"DescribeInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancesRequest"}, "output":{"shape":"DescribeInstancesResult"}, "documentation":"

Describes one or more of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

" }, "DescribeInternetGateways":{ "name":"DescribeInternetGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInternetGatewaysRequest"}, "output":{"shape":"DescribeInternetGatewaysResult"}, "documentation":"

Describes one or more of your Internet gateways.

" }, "DescribeKeyPairs":{ "name":"DescribeKeyPairs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeKeyPairsRequest"}, "output":{"shape":"DescribeKeyPairsResult"}, "documentation":"

Describes one or more of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeMovingAddresses":{ "name":"DescribeMovingAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMovingAddressesRequest"}, "output":{"shape":"DescribeMovingAddressesResult"}, "documentation":"

Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

" }, "DescribeNetworkAcls":{ "name":"DescribeNetworkAcls", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkAclsRequest"}, "output":{"shape":"DescribeNetworkAclsResult"}, "documentation":"

Describes one or more of your network ACLs.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeNetworkInterfaceAttribute":{ "name":"DescribeNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, "documentation":"

Describes a network interface attribute. You can specify only one attribute at a time.

" }, "DescribeNetworkInterfaces":{ "name":"DescribeNetworkInterfaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkInterfacesRequest"}, "output":{"shape":"DescribeNetworkInterfacesResult"}, "documentation":"

Describes one or more of your network interfaces.

" }, "DescribePlacementGroups":{ "name":"DescribePlacementGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePlacementGroupsRequest"}, "output":{"shape":"DescribePlacementGroupsResult"}, "documentation":"

Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribePrefixLists":{ "name":"DescribePrefixLists", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePrefixListsRequest"}, "output":{"shape":"DescribePrefixListsResult"}, "documentation":"

Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a VPC endpoint.

" }, "DescribeRegions":{ "name":"DescribeRegions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRegionsRequest"}, "output":{"shape":"DescribeRegionsResult"}, "documentation":"

Describes one or more regions that are currently available to you.

For a list of the regions supported by Amazon EC2, see Regions and Endpoints.

" }, "DescribeReservedInstances":{ "name":"DescribeReservedInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesRequest"}, "output":{"shape":"DescribeReservedInstancesResult"}, "documentation":"

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesListings":{ "name":"DescribeReservedInstancesListings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesListingsRequest"}, "output":{"shape":"DescribeReservedInstancesListingsResult"}, "documentation":"

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesModifications":{ "name":"DescribeReservedInstancesModifications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, "output":{"shape":"DescribeReservedInstancesModificationsResult"}, "documentation":"

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeReservedInstancesOfferings":{ "name":"DescribeReservedInstancesOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, "documentation":"

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeRouteTables":{ "name":"DescribeRouteTables", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRouteTablesRequest"}, "output":{"shape":"DescribeRouteTablesResult"}, "documentation":"

Describes one or more of your route tables.

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeSecurityGroups":{ "name":"DescribeSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSecurityGroupsRequest"}, "output":{"shape":"DescribeSecurityGroupsResult"}, "documentation":"

Describes one or more of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeSnapshotAttribute":{ "name":"DescribeSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotAttributeRequest"}, "output":{"shape":"DescribeSnapshotAttributeResult"}, "documentation":"

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSnapshots":{ "name":"DescribeSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotsRequest"}, "output":{"shape":"DescribeSnapshotsResult"}, "documentation":"

Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.
  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.
  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSpotDatafeedSubscription":{ "name":"DescribeSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeSpotDatafeedSubscriptionRequest", "documentation":"

Contains the parameters for DescribeSpotDatafeedSubscription.

" }, "output":{ "shape":"DescribeSpotDatafeedSubscriptionResult", "documentation":"

Contains the output of DescribeSpotDatafeedSubscription.

" }, "documentation":"

Describes the data feed for Spot instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSpotFleetInstances":{ "name":"DescribeSpotFleetInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeSpotFleetInstancesRequest", "documentation":"

Contains the parameters for DescribeSpotFleetInstances.

" }, "output":{ "shape":"DescribeSpotFleetInstancesResponse", "documentation":"

Contains the output of DescribeSpotFleetInstances.

" }, "documentation":"

Describes the running instances for the specified Spot fleet.

" }, "DescribeSpotFleetRequestHistory":{ "name":"DescribeSpotFleetRequestHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeSpotFleetRequestHistoryRequest", "documentation":"

Contains the parameters for DescribeSpotFleetRequestHistory.

" }, "output":{ "shape":"DescribeSpotFleetRequestHistoryResponse", "documentation":"

Contains the output of DescribeSpotFleetRequestHistory.

" }, "documentation":"

Describes the events for the specified Spot fleet request during the specified time.

Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event.

" }, "DescribeSpotFleetRequests":{ "name":"DescribeSpotFleetRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeSpotFleetRequestsRequest", "documentation":"

Contains the parameters for DescribeSpotFleetRequests.

" }, "output":{ "shape":"DescribeSpotFleetRequestsResponse", "documentation":"

Contains the output of DescribeSpotFleetRequests.

" }, "documentation":"

Describes your Spot fleet requests.

" }, "DescribeSpotInstanceRequests":{ "name":"DescribeSpotInstanceRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeSpotInstanceRequestsRequest", "documentation":"

Contains the parameters for DescribeSpotInstanceRequests.

" }, "output":{ "shape":"DescribeSpotInstanceRequestsResult", "documentation":"

Contains the output of DescribeSpotInstanceRequests.

" }, "documentation":"

Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

You can use DescribeSpotInstanceRequests to find a running Spot instance by examining the response. If the status of the Spot instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

" }, "DescribeSpotPriceHistory":{ "name":"DescribeSpotPriceHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeSpotPriceHistoryRequest", "documentation":"

Contains the parameters for DescribeSpotPriceHistory.

" }, "output":{ "shape":"DescribeSpotPriceHistoryResult", "documentation":"

Contains the output of DescribeSpotPriceHistory.

" }, "documentation":"

Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see Spot Instance Pricing History in the Amazon Elastic Compute Cloud User Guide.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" }, "DescribeSubnets":{ "name":"DescribeSubnets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSubnetsRequest"}, "output":{"shape":"DescribeSubnetsResult"}, "documentation":"

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsRequest"}, "output":{"shape":"DescribeTagsResult"}, "documentation":"

Describes one or more of the tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVolumeAttribute":{ "name":"DescribeVolumeAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumeAttributeRequest"}, "output":{"shape":"DescribeVolumeAttributeResult"}, "documentation":"

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVolumeStatus":{ "name":"DescribeVolumeStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumeStatusRequest"}, "output":{"shape":"DescribeVolumeStatusResult"}, "documentation":"

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

" }, "DescribeVolumes":{ "name":"DescribeVolumes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumesRequest"}, "output":{"shape":"DescribeVolumesResult"}, "documentation":"

Describes the specified EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeVpcAttribute":{ "name":"DescribeVpcAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcAttributeRequest"}, "output":{"shape":"DescribeVpcAttributeResult"}, "documentation":"

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" }, "DescribeVpcClassicLink":{ "name":"DescribeVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcClassicLinkRequest"}, "output":{"shape":"DescribeVpcClassicLinkResult"}, "documentation":"

Describes the ClassicLink status of one or more VPCs.

" }, "DescribeVpcEndpointServices":{ "name":"DescribeVpcEndpointServices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcEndpointServicesRequest"}, "output":{"shape":"DescribeVpcEndpointServicesResult"}, "documentation":"

Describes all supported AWS services that can be specified when creating a VPC endpoint.

" }, "DescribeVpcEndpoints":{ "name":"DescribeVpcEndpoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcEndpointsRequest"}, "output":{"shape":"DescribeVpcEndpointsResult"}, "documentation":"

Describes one or more of your VPC endpoints.

" }, "DescribeVpcPeeringConnections":{ "name":"DescribeVpcPeeringConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, "documentation":"

Describes one or more of your VPC peering connections.

" }, "DescribeVpcs":{ "name":"DescribeVpcs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcsRequest"}, "output":{"shape":"DescribeVpcsResult"}, "documentation":"

Describes one or more of your VPCs.

" }, "DescribeVpnConnections":{ "name":"DescribeVpnConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpnConnectionsRequest"}, "output":{"shape":"DescribeVpnConnectionsResult"}, "documentation":"

Describes one or more of your VPN connections.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeVpnGateways":{ "name":"DescribeVpnGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpnGatewaysRequest"}, "output":{"shape":"DescribeVpnGatewaysResult"}, "documentation":"

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DetachClassicLinkVpc":{ "name":"DetachClassicLinkVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachClassicLinkVpcRequest"}, "output":{"shape":"DetachClassicLinkVpcResult"}, "documentation":"

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" }, "DetachInternetGateway":{ "name":"DetachInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachInternetGatewayRequest"}, "documentation":"

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.

" }, "DetachNetworkInterface":{ "name":"DetachNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachNetworkInterfaceRequest"}, "documentation":"

Detaches a network interface from an instance.

" }, "DetachVolume":{ "name":"DetachVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachVolumeRequest"}, "output":{ "shape":"VolumeAttachment", "documentation":"

Information about the volume attachment.

", "locationName":"attachment" }, "documentation":"

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching.

If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" }, "DetachVpnGateway":{ "name":"DetachVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachVpnGatewayRequest"}, "documentation":"

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" }, "DisableVgwRoutePropagation":{ "name":"DisableVgwRoutePropagation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVgwRoutePropagationRequest"}, "documentation":"

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" }, "DisableVpcClassicLink":{ "name":"DisableVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVpcClassicLinkRequest"}, "output":{"shape":"DisableVpcClassicLinkResult"}, "documentation":"

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

" }, "DisassociateAddress":{ "name":"DisassociateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateAddressRequest"}, "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" }, "DisassociateRouteTable":{ "name":"DisassociateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateRouteTableRequest"}, "documentation":"

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "EnableVgwRoutePropagation":{ "name":"EnableVgwRoutePropagation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVgwRoutePropagationRequest"}, "documentation":"

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" }, "EnableVolumeIO":{ "name":"EnableVolumeIO", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVolumeIORequest"}, "documentation":"

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" }, "EnableVpcClassicLink":{ "name":"EnableVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVpcClassicLinkRequest"}, "output":{"shape":"EnableVpcClassicLinkResult"}, "documentation":"

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "GetConsoleOutput":{ "name":"GetConsoleOutput", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetConsoleOutputRequest"}, "output":{"shape":"GetConsoleOutputResult"}, "documentation":"

Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.

For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output includes output from the EC2Config service.

" }, "GetPasswordData":{ "name":"GetPasswordData", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPasswordDataRequest"}, "output":{"shape":"GetPasswordDataResult"}, "documentation":"

Retrieves the encrypted administrator password for an instance running Windows.

The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" }, "ImportImage":{ "name":"ImportImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportImageRequest"}, "output":{"shape":"ImportImageResult"}, "documentation":"

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

" }, "ImportInstance":{ "name":"ImportInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportInstanceRequest"}, "output":{"shape":"ImportInstanceResult"}, "documentation":"

Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. After importing the image, you then upload it using the ec2-import-volume command in the EC2 command line tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" }, "ImportKeyPair":{ "name":"ImportKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportKeyPairRequest"}, "output":{"shape":"ImportKeyPairResult"}, "documentation":"

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "ImportSnapshot":{ "name":"ImportSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportSnapshotRequest"}, "output":{"shape":"ImportSnapshotResult"}, "documentation":"

Imports a disk into an EBS snapshot.

" }, "ImportVolume":{ "name":"ImportVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportVolumeRequest"}, "output":{"shape":"ImportVolumeResult"}, "documentation":"

Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the Amazon EC2 command-line interface (CLI) tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifyImageAttribute":{ "name":"ModifyImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyImageAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

" }, "ModifyInstanceAttribute":{ "name":"ModifyInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyInstanceAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifyNetworkInterfaceAttribute":{ "name":"ModifyNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, "documentation":"

Modifies the specified network interface attribute. You can specify only one attribute at a time.

" }, "ModifyReservedInstances":{ "name":"ModifyReservedInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyReservedInstancesRequest"}, "output":{"shape":"ModifyReservedInstancesResult"}, "documentation":"

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifySnapshotAttribute":{ "name":"ModifySnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySnapshotAttributeRequest"}, "documentation":"

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

Snapshots with AWS Marketplace product codes cannot be made public.

" }, "ModifySubnetAttribute":{ "name":"ModifySubnetAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySubnetAttributeRequest"}, "documentation":"

Modifies a subnet attribute.

" }, "ModifyVolumeAttribute":{ "name":"ModifyVolumeAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVolumeAttributeRequest"}, "documentation":"

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" }, "ModifyVpcAttribute":{ "name":"ModifyVpcAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified VPC.

" }, "ModifyVpcEndpoint":{ "name":"ModifyVpcEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcEndpointRequest"}, "output":{"shape":"ModifyVpcEndpointResult"}, "documentation":"

Modifies attributes of a specified VPC endpoint. You can modify the policy associated with the endpoint, and you can add and remove route tables associated with the endpoint.

" }, "MonitorInstances":{ "name":"MonitorInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MonitorInstancesRequest"}, "output":{"shape":"MonitorInstancesResult"}, "documentation":"

Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "MoveAddressToVpc":{ "name":"MoveAddressToVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MoveAddressToVpcRequest"}, "output":{"shape":"MoveAddressToVpcResult"}, "documentation":"

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that's allocated for use in the EC2-VPC platform to the EC2-Classic platform.

" }, "PurchaseReservedInstancesOffering":{ "name":"PurchaseReservedInstancesOffering", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, "documentation":"

Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time and pay a lower hourly rate compared to on-Demand Instance pricing.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" }, "RebootInstances":{ "name":"RebootInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootInstancesRequest"}, "documentation":"

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If a Linux/Unix instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "RegisterImage":{ "name":"RegisterImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterImageRequest"}, "output":{"shape":"RegisterImageResult"}, "documentation":"

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide.

Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billingProduct code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure.

Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI.

To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see CreateImage.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

" }, "RejectVpcPeeringConnection":{ "name":"RejectVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RejectVpcPeeringConnectionRequest"}, "output":{"shape":"RejectVpcPeeringConnectionResult"}, "documentation":"

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" }, "ReleaseAddress":{ "name":"ReleaseAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReleaseAddressRequest"}, "documentation":"

Releases the specified Elastic IP address.

After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

" }, "ReplaceNetworkAclAssociation":{ "name":"ReplaceNetworkAclAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceNetworkAclAssociationRequest"}, "output":{"shape":"ReplaceNetworkAclAssociationResult"}, "documentation":"

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceNetworkAclEntry":{ "name":"ReplaceNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceNetworkAclEntryRequest"}, "documentation":"

Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceRoute":{ "name":"ReplaceRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceRouteRequest"}, "documentation":"

Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceRouteTableAssociation":{ "name":"ReplaceRouteTableAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceRouteTableAssociationRequest"}, "output":{"shape":"ReplaceRouteTableAssociationResult"}, "documentation":"

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" }, "ReportInstanceStatus":{ "name":"ReportInstanceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReportInstanceStatusRequest"}, "documentation":"

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" }, "RequestSpotFleet":{ "name":"RequestSpotFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"RequestSpotFleetRequest", "documentation":"

Contains the parameters for RequestSpotFleet.

" }, "output":{ "shape":"RequestSpotFleetResponse", "documentation":"

Contains the output of RequestSpotFleet.

" }, "documentation":"

Creates a Spot fleet request.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet.

For more information, see Spot Fleet Requests in the Amazon Elastic Compute Cloud User Guide.

" }, "RequestSpotInstances":{ "name":"RequestSpotInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"RequestSpotInstancesRequest", "documentation":"

Contains the parameters for RequestSpotInstances.

" }, "output":{ "shape":"RequestSpotInstancesResult", "documentation":"

Contains the output of RequestSpotInstances.

" }, "documentation":"

Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

" }, "ResetImageAttribute":{ "name":"ResetImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetImageAttributeRequest"}, "documentation":"

Resets an attribute of an AMI to its default value.

The productCodes attribute can't be reset.

" }, "ResetInstanceAttribute":{ "name":"ResetInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetInstanceAttributeRequest"}, "documentation":"

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the SourceDestCheck, the instance can be either running or stopped.

The SourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" }, "ResetNetworkInterfaceAttribute":{ "name":"ResetNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetNetworkInterfaceAttributeRequest"}, "documentation":"

Resets a network interface attribute. You can specify only one attribute at a time.

" }, "ResetSnapshotAttribute":{ "name":"ResetSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetSnapshotAttributeRequest"}, "documentation":"

Resets permission settings for the specified snapshot.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" }, "RestoreAddressToClassic":{ "name":"RestoreAddressToClassic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreAddressToClassicRequest"}, "output":{"shape":"RestoreAddressToClassicResult"}, "documentation":"

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

" }, "RevokeSecurityGroupEgress":{ "name":"RevokeSecurityGroupEgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSecurityGroupEgressRequest"}, "documentation":"

Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" }, "RevokeSecurityGroupIngress":{ "name":"RevokeSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSecurityGroupIngressRequest"}, "documentation":"

Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" }, "RunInstances":{ "name":"RunInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RunInstancesRequest"}, "output":{ "shape":"Reservation", "documentation":"

One or more reservations.

", "locationName":"reservation" }, "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

When you launch an instance, it enters the pending state. After the instance is ready for you, it enters the running state. To check the state of your instance, call DescribeInstances.

If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide.

[EC2-VPC only accounts] If you don't specify a subnet in the request, we choose a default subnet from your default VPC for you.

[EC2-Classic accounts] If you're launching into EC2-Classic and you don't specify an Availability Zone, we choose one for you.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide.

If any of the AMIs have a product code attached for which the user has not subscribed, RunInstances fails.

T2 instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, RunInstances fails.

For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "StartInstances":{ "name":"StartInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartInstancesRequest"}, "output":{"shape":"StartInstancesResult"}, "documentation":"

Starts an Amazon EBS-backed AMI that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "StopInstances":{ "name":"StopInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopInstancesRequest"}, "output":{"shape":"StopInstancesResult"}, "documentation":"

Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

You can't start or stop Spot Instances.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "TerminateInstances":{ "name":"TerminateInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateInstancesRequest"}, "output":{"shape":"TerminateInstancesResult"}, "documentation":"

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.

" }, "UnassignPrivateIpAddresses":{ "name":"UnassignPrivateIpAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnassignPrivateIpAddressesRequest"}, "documentation":"

Unassigns one or more secondary private IP addresses from a network interface.

" }, "UnmonitorInstances":{ "name":"UnmonitorInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnmonitorInstancesRequest"}, "output":{"shape":"UnmonitorInstancesResult"}, "documentation":"

Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" } }, "shapes":{ "AcceptVpcPeeringConnectionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "AcceptVpcPeeringConnectionResult":{ "type":"structure", "members":{ "VpcPeeringConnection":{ "shape":"VpcPeeringConnection", "documentation":"

Information about the VPC peering connection.

", "locationName":"vpcPeeringConnection" } } }, "AccountAttribute":{ "type":"structure", "members":{ "AttributeName":{ "shape":"String", "documentation":"

The name of the account attribute.

", "locationName":"attributeName" }, "AttributeValues":{ "shape":"AccountAttributeValueList", "documentation":"

One or more values for the account attribute.

", "locationName":"attributeValueSet" } }, "documentation":"

Describes an account attribute.

" }, "AccountAttributeList":{ "type":"list", "member":{ "shape":"AccountAttribute", "locationName":"item" } }, "AccountAttributeName":{ "type":"string", "enum":[ "supported-platforms", "default-vpc" ] }, "AccountAttributeNameStringList":{ "type":"list", "member":{ "shape":"AccountAttributeName", "locationName":"attributeName" } }, "AccountAttributeValue":{ "type":"structure", "members":{ "AttributeValue":{ "shape":"String", "documentation":"

The value of the attribute.

", "locationName":"attributeValue" } }, "documentation":"

Describes a value of an account attribute.

" }, "AccountAttributeValueList":{ "type":"list", "member":{ "shape":"AccountAttributeValue", "locationName":"item" } }, "ActiveInstance":{ "type":"structure", "members":{ "InstanceType":{ "shape":"String", "documentation":"

The instance type.

", "locationName":"instanceType" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot instance request.

", "locationName":"spotInstanceRequestId" } }, "documentation":"

Describes a running instance in a Spot fleet.

" }, "ActiveInstanceSet":{ "type":"list", "member":{ "shape":"ActiveInstance", "locationName":"item" } }, "Address":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance that the address is associated with (if any).

", "locationName":"instanceId" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "AllocationId":{ "shape":"String", "documentation":"

The ID representing the allocation of the address for use with EC2-VPC.

", "locationName":"allocationId" }, "AssociationId":{ "shape":"String", "documentation":"

The ID representing the association of the address with an instance in a VPC.

", "locationName":"associationId" }, "Domain":{ "shape":"DomainType", "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", "locationName":"domain" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "NetworkInterfaceOwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that owns the network interface.

", "locationName":"networkInterfaceOwnerId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address associated with the Elastic IP address.

", "locationName":"privateIpAddress" } }, "documentation":"

Describes an Elastic IP address.

" }, "AddressList":{ "type":"list", "member":{ "shape":"Address", "locationName":"item" } }, "AllocateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Domain":{ "shape":"DomainType", "documentation":"

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" } } }, "AllocateAddressResult":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "Domain":{ "shape":"DomainType", "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", "locationName":"domain" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", "locationName":"allocationId" } } }, "AllocationIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"AllocationId" } }, "AllocationStrategy":{ "type":"string", "enum":[ "lowestPrice", "diversified" ] }, "ArchitectureValues":{ "type":"string", "enum":[ "i386", "x86_64" ] }, "AssignPrivateIpAddressesRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", "locationName":"privateIpAddress" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", "locationName":"secondaryPrivateIpAddressCount" }, "AllowReassignment":{ "shape":"Boolean", "documentation":"

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", "locationName":"allowReassignment" } } }, "AssociateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address. This is required for EC2-Classic.

" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

", "locationName":"networkInterfaceId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", "locationName":"privateIpAddress" }, "AllowReassociation":{ "shape":"Boolean", "documentation":"

[EC2-VPC] Allows an Elastic IP address that is already associated with an instance or network interface to be re-associated with the specified instance or network interface. Otherwise, the operation fails.

Default: false

", "locationName":"allowReassociation" } } }, "AssociateAddressResult":{ "type":"structure", "members":{ "AssociationId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", "locationName":"associationId" } } }, "AssociateDhcpOptionsRequest":{ "type":"structure", "required":[ "DhcpOptionsId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } } }, "AssociateRouteTableRequest":{ "type":"structure", "required":[ "SubnetId", "RouteTableId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" } } }, "AssociateRouteTableResult":{ "type":"structure", "members":{ "AssociationId":{ "shape":"String", "documentation":"

The route table association ID (needed to disassociate the route table).

", "locationName":"associationId" } } }, "AttachClassicLinkVpcRequest":{ "type":"structure", "required":[ "InstanceId", "VpcId", "Groups" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of a ClassicLink-enabled VPC.

", "locationName":"vpcId" }, "Groups":{ "shape":"GroupIdStringList", "documentation":"

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", "locationName":"SecurityGroupId" } } }, "AttachClassicLinkVpcResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "AttachInternetGatewayRequest":{ "type":"structure", "required":[ "InternetGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "AttachNetworkInterfaceRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "InstanceId", "DeviceIndex" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device for the network interface attachment.

", "locationName":"deviceIndex" } } }, "AttachNetworkInterfaceResult":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" } } }, "AttachVolumeRequest":{ "type":"structure", "required":[ "VolumeId", "InstanceId", "Device" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "Device":{ "shape":"String", "documentation":"

The device name to expose to the instance (for example, /dev/sdh or xvdh).

" } } }, "AttachVpnGatewayRequest":{ "type":"structure", "required":[ "VpnGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } } }, "AttachVpnGatewayResult":{ "type":"structure", "members":{ "VpcAttachment":{ "shape":"VpcAttachment", "documentation":"

Information about the attachment.

", "locationName":"attachment" } } }, "AttachmentStatus":{ "type":"string", "enum":[ "attaching", "attached", "detaching", "detached" ] }, "AttributeBooleanValue":{ "type":"structure", "members":{ "Value":{ "shape":"Boolean", "documentation":"

Valid values are true or false.

", "locationName":"value" } }, "documentation":"

The value to use when a resource attribute accepts a Boolean value.

" }, "AttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"String", "documentation":"

Valid values are case-sensitive and vary by action.

", "locationName":"value" } }, "documentation":"

The value to use for a resource attribute.

" }, "AuthorizeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

The name of a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account number for a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

", "locationName":"toPort" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

", "locationName":"cidrIp" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"ipPermissions" } } }, "AuthorizeSecurityGroupIngressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a nondefault VPC.

" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC.

" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The AWS account number for the source security group. For EC2-VPC, the source security group must be in the same VPC. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.

" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. Can be used to specify multiple rules in a single command.

" } } }, "AvailabilityZone":{ "type":"structure", "members":{ "ZoneName":{ "shape":"String", "documentation":"

The name of the Availability Zone.

", "locationName":"zoneName" }, "State":{ "shape":"AvailabilityZoneState", "documentation":"

The state of the Availability Zone (available | impaired | unavailable).

", "locationName":"zoneState" }, "RegionName":{ "shape":"String", "documentation":"

The name of the region.

", "locationName":"regionName" }, "Messages":{ "shape":"AvailabilityZoneMessageList", "documentation":"

Any messages about the Availability Zone.

", "locationName":"messageSet" } }, "documentation":"

Describes an Availability Zone.

" }, "AvailabilityZoneList":{ "type":"list", "member":{ "shape":"AvailabilityZone", "locationName":"item" } }, "AvailabilityZoneMessage":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

The message about the Availability Zone.

", "locationName":"message" } }, "documentation":"

Describes a message about an Availability Zone.

" }, "AvailabilityZoneMessageList":{ "type":"list", "member":{ "shape":"AvailabilityZoneMessage", "locationName":"item" } }, "AvailabilityZoneState":{ "type":"string", "enum":["available"] }, "BatchState":{ "type":"string", "enum":[ "submitted", "active", "cancelled", "failed", "cancelled_running", "cancelled_terminating" ] }, "BlockDeviceMapping":{ "type":"structure", "members":{ "VirtualName":{ "shape":"String", "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", "locationName":"virtualName" }, "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsBlockDevice", "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", "locationName":"ebs" }, "NoDevice":{ "shape":"String", "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", "locationName":"noDevice" } }, "documentation":"

Describes a block device mapping.

" }, "BlockDeviceMappingList":{ "type":"list", "member":{ "shape":"BlockDeviceMapping", "locationName":"item" } }, "BlockDeviceMappingRequestList":{ "type":"list", "member":{ "shape":"BlockDeviceMapping", "locationName":"BlockDeviceMapping" } }, "Boolean":{"type":"boolean"}, "BundleIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"BundleId" } }, "BundleInstanceRequest":{ "type":"structure", "required":[ "InstanceId", "Storage" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

" }, "Storage":{ "shape":"Storage", "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" } } }, "BundleInstanceResult":{ "type":"structure", "members":{ "BundleTask":{ "shape":"BundleTask", "documentation":"

Information about the bundle task.

", "locationName":"bundleInstanceTask" } } }, "BundleTask":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance associated with this bundle task.

", "locationName":"instanceId" }, "BundleId":{ "shape":"String", "documentation":"

The ID of the bundle task.

", "locationName":"bundleId" }, "State":{ "shape":"BundleTaskState", "documentation":"

The state of the task.

", "locationName":"state" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time this task started.

", "locationName":"startTime" }, "UpdateTime":{ "shape":"DateTime", "documentation":"

The time of the most recent update for the task.

", "locationName":"updateTime" }, "Storage":{ "shape":"Storage", "documentation":"

The Amazon S3 storage locations.

", "locationName":"storage" }, "Progress":{ "shape":"String", "documentation":"

The level of task completion, as a percent (for example, 20%).

", "locationName":"progress" }, "BundleTaskError":{ "shape":"BundleTaskError", "documentation":"

If the task fails, a description of the error.

", "locationName":"error" } }, "documentation":"

Describes a bundle task.

" }, "BundleTaskError":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The error message.

", "locationName":"message" } }, "documentation":"

Describes an error for BundleInstance.

" }, "BundleTaskList":{ "type":"list", "member":{ "shape":"BundleTask", "locationName":"item" } }, "BundleTaskState":{ "type":"string", "enum":[ "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed" ] }, "CancelBatchErrorCode":{ "type":"string", "enum":[ "fleetRequestIdDoesNotExist", "fleetRequestIdMalformed", "fleetRequestNotInCancellableState", "unexpectedError" ] }, "CancelBundleTaskRequest":{ "type":"structure", "required":["BundleId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "BundleId":{ "shape":"String", "documentation":"

The ID of the bundle task.

" } } }, "CancelBundleTaskResult":{ "type":"structure", "members":{ "BundleTask":{ "shape":"BundleTask", "documentation":"

Information about the bundle task.

", "locationName":"bundleInstanceTask" } } }, "CancelConversionRequest":{ "type":"structure", "required":["ConversionTaskId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ConversionTaskId":{ "shape":"String", "documentation":"

The ID of the conversion task.

", "locationName":"conversionTaskId" }, "ReasonMessage":{ "shape":"String", "documentation":"

The reason for canceling the conversion task.

", "locationName":"reasonMessage" } } }, "CancelExportTaskRequest":{ "type":"structure", "required":["ExportTaskId"], "members":{ "ExportTaskId":{ "shape":"String", "documentation":"

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", "locationName":"exportTaskId" } } }, "CancelImportTaskRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import image or import snapshot task to be canceled.

" }, "CancelReason":{ "shape":"String", "documentation":"

The reason for canceling the task.

" } } }, "CancelImportTaskResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the task being canceled.

", "locationName":"importTaskId" }, "State":{ "shape":"String", "documentation":"

The current state of the task being canceled.

", "locationName":"state" }, "PreviousState":{ "shape":"String", "documentation":"

The current state of the task being canceled.

", "locationName":"previousState" } } }, "CancelReservedInstancesListingRequest":{ "type":"structure", "required":["ReservedInstancesListingId"], "members":{ "ReservedInstancesListingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance listing.

", "locationName":"reservedInstancesListingId" } } }, "CancelReservedInstancesListingResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

The Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } } }, "CancelSpotFleetRequestsError":{ "type":"structure", "required":[ "Code", "Message" ], "members":{ "Code":{ "shape":"CancelBatchErrorCode", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The description for the error code.

", "locationName":"message" } }, "documentation":"

Describes a Spot fleet error.

" }, "CancelSpotFleetRequestsErrorItem":{ "type":"structure", "required":[ "SpotFleetRequestId", "Error" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "Error":{ "shape":"CancelSpotFleetRequestsError", "documentation":"

The error.

", "locationName":"error" } }, "documentation":"

Describes a Spot fleet request that was not successfully canceled.

" }, "CancelSpotFleetRequestsErrorSet":{ "type":"list", "member":{ "shape":"CancelSpotFleetRequestsErrorItem", "locationName":"item" } }, "CancelSpotFleetRequestsRequest":{ "type":"structure", "required":[ "SpotFleetRequestIds", "TerminateInstances" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestIds":{ "shape":"ValueStringList", "documentation":"

The IDs of the Spot fleet requests.

", "locationName":"spotFleetRequestId" }, "TerminateInstances":{ "shape":"Boolean", "documentation":"

Indicates whether to terminate instances for a Spot fleet request if it is canceled successfully.

", "locationName":"terminateInstances" } }, "documentation":"

Contains the parameters for CancelSpotFleetRequests.

" }, "CancelSpotFleetRequestsResponse":{ "type":"structure", "members":{ "UnsuccessfulFleetRequests":{ "shape":"CancelSpotFleetRequestsErrorSet", "documentation":"

Information about the Spot fleet requests that are not successfully canceled.

", "locationName":"unsuccessfulFleetRequestSet" }, "SuccessfulFleetRequests":{ "shape":"CancelSpotFleetRequestsSuccessSet", "documentation":"

Information about the Spot fleet requests that are successfully canceled.

", "locationName":"successfulFleetRequestSet" } }, "documentation":"

Contains the output of CancelSpotFleetRequests.

" }, "CancelSpotFleetRequestsSuccessItem":{ "type":"structure", "required":[ "SpotFleetRequestId", "CurrentSpotFleetRequestState", "PreviousSpotFleetRequestState" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "CurrentSpotFleetRequestState":{ "shape":"BatchState", "documentation":"

The current state of the Spot fleet request.

", "locationName":"currentSpotFleetRequestState" }, "PreviousSpotFleetRequestState":{ "shape":"BatchState", "documentation":"

The previous state of the Spot fleet request.

", "locationName":"previousSpotFleetRequestState" } }, "documentation":"

Describes a Spot fleet request that was successfully canceled.

" }, "CancelSpotFleetRequestsSuccessSet":{ "type":"list", "member":{ "shape":"CancelSpotFleetRequestsSuccessItem", "locationName":"item" } }, "CancelSpotInstanceRequestState":{ "type":"string", "enum":[ "active", "open", "closed", "cancelled", "completed" ] }, "CancelSpotInstanceRequestsRequest":{ "type":"structure", "required":["SpotInstanceRequestIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotInstanceRequestIds":{ "shape":"SpotInstanceRequestIdList", "documentation":"

One or more Spot instance request IDs.

", "locationName":"SpotInstanceRequestId" } }, "documentation":"

Contains the parameters for CancelSpotInstanceRequests.

" }, "CancelSpotInstanceRequestsResult":{ "type":"structure", "members":{ "CancelledSpotInstanceRequests":{ "shape":"CancelledSpotInstanceRequestList", "documentation":"

One or more Spot instance requests.

", "locationName":"spotInstanceRequestSet" } }, "documentation":"

Contains the output of CancelSpotInstanceRequests.

" }, "CancelledSpotInstanceRequest":{ "type":"structure", "members":{ "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot instance request.

", "locationName":"spotInstanceRequestId" }, "State":{ "shape":"CancelSpotInstanceRequestState", "documentation":"

The state of the Spot instance request.

", "locationName":"state" } }, "documentation":"

Describes a request to cancel a Spot instance.

" }, "CancelledSpotInstanceRequestList":{ "type":"list", "member":{ "shape":"CancelledSpotInstanceRequest", "locationName":"item" } }, "ClassicLinkInstance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

A list of security groups.

", "locationName":"groupSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the instance.

", "locationName":"tagSet" } }, "documentation":"

Describes a linked EC2-Classic instance.

" }, "ClassicLinkInstanceList":{ "type":"list", "member":{ "shape":"ClassicLinkInstance", "locationName":"item" } }, "ClientData":{ "type":"structure", "members":{ "UploadStart":{ "shape":"DateTime", "documentation":"

The time that the disk upload starts.

" }, "UploadEnd":{ "shape":"DateTime", "documentation":"

The time that the disk upload ends.

" }, "UploadSize":{ "shape":"Double", "documentation":"

The size of the uploaded disk image, in GiB.

" }, "Comment":{ "shape":"String", "documentation":"

A user-defined comment about the disk upload.

" } }, "documentation":"

Describes the client-specific data.

" }, "ConfirmProductInstanceRequest":{ "type":"structure", "required":[ "ProductCode", "InstanceId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ProductCode":{ "shape":"String", "documentation":"

The product code. This must be a product code that you own.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" } } }, "ConfirmProductInstanceResult":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", "locationName":"ownerId" }, "Return":{ "shape":"Boolean", "documentation":"

The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.

", "locationName":"return" } } }, "ContainerFormat":{ "type":"string", "enum":["ova"] }, "ConversionIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "ConversionTask":{ "type":"structure", "required":[ "ConversionTaskId", "State" ], "members":{ "ConversionTaskId":{ "shape":"String", "documentation":"

The ID of the conversion task.

", "locationName":"conversionTaskId" }, "ExpirationTime":{ "shape":"String", "documentation":"

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", "locationName":"expirationTime" }, "ImportInstance":{ "shape":"ImportInstanceTaskDetails", "documentation":"

If the task is for importing an instance, this contains information about the import instance task.

", "locationName":"importInstance" }, "ImportVolume":{ "shape":"ImportVolumeTaskDetails", "documentation":"

If the task is for importing a volume, this contains information about the import volume task.

", "locationName":"importVolume" }, "State":{ "shape":"ConversionTaskState", "documentation":"

The state of the conversion task.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message related to the conversion task.

", "locationName":"statusMessage" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the task.

", "locationName":"tagSet" } }, "documentation":"

Describes a conversion task.

" }, "ConversionTaskState":{ "type":"string", "enum":[ "active", "cancelling", "cancelled", "completed" ] }, "CopyImageRequest":{ "type":"structure", "required":[ "SourceRegion", "SourceImageId", "Name" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SourceRegion":{ "shape":"String", "documentation":"

The name of the region that contains the AMI to copy.

" }, "SourceImageId":{ "shape":"String", "documentation":"

The ID of the AMI to copy.

" }, "Name":{ "shape":"String", "documentation":"

The name of the new AMI in the destination region.

" }, "Description":{ "shape":"String", "documentation":"

A description for the new AMI in the destination region.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" } } }, "CopyImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the new AMI.

", "locationName":"imageId" } } }, "CopySnapshotRequest":{ "type":"structure", "required":[ "SourceRegion", "SourceSnapshotId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SourceRegion":{ "shape":"String", "documentation":"

The ID of the region that contains the snapshot to be copied.

" }, "SourceSnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot to copy.

" }, "Description":{ "shape":"String", "documentation":"

A description for the EBS snapshot.

" }, "DestinationRegion":{ "shape":"String", "documentation":"

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

", "locationName":"destinationRegion" }, "PresignedUrl":{ "shape":"String", "documentation":"

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", "locationName":"presignedUrl" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

", "locationName":"kmsKeyId" } } }, "CopySnapshotResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the new snapshot.

", "locationName":"snapshotId" } } }, "CreateCustomerGatewayRequest":{ "type":"structure", "required":[ "Type", "PublicIp", "BgpAsn" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection that this customer gateway supports (ipsec.1).

" }, "PublicIp":{ "shape":"String", "documentation":"

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", "locationName":"IpAddress" }, "BgpAsn":{ "shape":"Integer", "documentation":"

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" } } }, "CreateCustomerGatewayResult":{ "type":"structure", "members":{ "CustomerGateway":{ "shape":"CustomerGateway", "documentation":"

Information about the customer gateway.

", "locationName":"customerGateway" } } }, "CreateDhcpOptionsRequest":{ "type":"structure", "required":["DhcpConfigurations"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpConfigurations":{ "shape":"NewDhcpConfigurationList", "documentation":"

A DHCP configuration option.

", "locationName":"dhcpConfiguration" } } }, "CreateDhcpOptionsResult":{ "type":"structure", "members":{ "DhcpOptions":{ "shape":"DhcpOptions", "documentation":"

A set of DHCP options.

", "locationName":"dhcpOptions" } } }, "CreateFlowLogsRequest":{ "type":"structure", "required":[ "ResourceIds", "ResourceType", "TrafficType", "LogGroupName", "DeliverLogsPermissionArn" ], "members":{ "ResourceIds":{ "shape":"ValueStringList", "documentation":"

One or more subnet, network interface, or VPC IDs.

", "locationName":"ResourceId" }, "ResourceType":{ "shape":"FlowLogsResourceType", "documentation":"

The type of resource on which to create the flow log.

" }, "TrafficType":{ "shape":"TrafficType", "documentation":"

The type of traffic to log.

" }, "LogGroupName":{ "shape":"String", "documentation":"

The name of the CloudWatch log group.

" }, "DeliverLogsPermissionArn":{ "shape":"String", "documentation":"

The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" } } }, "CreateFlowLogsResult":{ "type":"structure", "members":{ "FlowLogIds":{ "shape":"ValueStringList", "documentation":"

The IDs of the flow logs.

", "locationName":"flowLogIdSet" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", "locationName":"clientToken" }, "Unsuccessful":{ "shape":"UnsuccessfulItemSet", "documentation":"

Information about the flow logs that could not be created successfully.

", "locationName":"unsuccessful" } } }, "CreateImageRequest":{ "type":"structure", "required":[ "InstanceId", "Name" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Name":{ "shape":"String", "documentation":"

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

A description for the new image.

", "locationName":"description" }, "NoReboot":{ "shape":"Boolean", "documentation":"

By default, this parameter is set to false, which means Amazon EC2 attempts to shut down the instance cleanly before image creation and then reboots the instance. When the parameter is set to true, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", "locationName":"noReboot" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

Information about one or more block device mappings.

", "locationName":"blockDeviceMapping" } } }, "CreateImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the new AMI.

", "locationName":"imageId" } } }, "CreateInstanceExportTaskRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "Description":{ "shape":"String", "documentation":"

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", "locationName":"description" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "TargetEnvironment":{ "shape":"ExportEnvironment", "documentation":"

The target virtualization environment.

", "locationName":"targetEnvironment" }, "ExportToS3Task":{ "shape":"ExportToS3TaskSpecification", "documentation":"

The format and location for an instance export task.

", "locationName":"exportToS3" } } }, "CreateInstanceExportTaskResult":{ "type":"structure", "members":{ "ExportTask":{ "shape":"ExportTask", "documentation":"

Information about the instance export task.

", "locationName":"exportTask" } } }, "CreateInternetGatewayRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } } }, "CreateInternetGatewayResult":{ "type":"structure", "members":{ "InternetGateway":{ "shape":"InternetGateway", "documentation":"

Information about the Internet gateway.

", "locationName":"internetGateway" } } }, "CreateKeyPairRequest":{ "type":"structure", "required":["KeyName"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" } } }, "CreateNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Protocol", "RuleAction", "Egress", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The protocol. A value of -1 means all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.

", "locationName":"Icmp" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", "locationName":"portRange" } } }, "CreateNetworkAclRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "CreateNetworkAclResult":{ "type":"structure", "members":{ "NetworkAcl":{ "shape":"NetworkAcl", "documentation":"

Information about the network ACL.

", "locationName":"networkAcl" } } }, "CreateNetworkInterfaceRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet to associate with the network interface.

", "locationName":"subnetId" }, "Description":{ "shape":"String", "documentation":"

A description for the network interface.

", "locationName":"description" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", "locationName":"privateIpAddress" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

The IDs of one or more security groups.

", "locationName":"SecurityGroupId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", "documentation":"

One or more private IP addresses.

", "locationName":"privateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"secondaryPrivateIpAddressCount" }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } } }, "CreateNetworkInterfaceResult":{ "type":"structure", "members":{ "NetworkInterface":{ "shape":"NetworkInterface", "documentation":"

Information about the network interface.

", "locationName":"networkInterface" } } }, "CreatePlacementGroupRequest":{ "type":"structure", "required":[ "GroupName", "Strategy" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

A name for the placement group.

Constraints: Up to 255 ASCII characters

", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"

The placement strategy.

", "locationName":"strategy" } } }, "CreateReservedInstancesListingRequest":{ "type":"structure", "required":[ "ReservedInstancesId", "InstanceCount", "PriceSchedules", "ClientToken" ], "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the active Reserved Instance.

", "locationName":"reservedInstancesId" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", "locationName":"instanceCount" }, "PriceSchedules":{ "shape":"PriceScheduleSpecificationList", "documentation":"

A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.

", "locationName":"priceSchedules" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } } }, "CreateReservedInstancesListingResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

Information about the Reserved Instances listing.

", "locationName":"reservedInstancesListingsSet" } } }, "CreateRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table for the route.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of an Internet gateway or virtual private gateway attached to your VPC.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", "locationName":"instanceId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of a network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of a VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "CreateRouteResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "CreateRouteTableRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "CreateRouteTableResult":{ "type":"structure", "members":{ "RouteTable":{ "shape":"RouteTable", "documentation":"

Information about the route table.

", "locationName":"routeTable" } } }, "CreateSecurityGroupRequest":{ "type":"structure", "required":[ "GroupName", "Description" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

" }, "Description":{ "shape":"String", "documentation":"

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", "locationName":"GroupDescription" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" } } }, "CreateSecurityGroupResult":{ "type":"structure", "members":{ "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } } }, "CreateSnapshotRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume.

" }, "Description":{ "shape":"String", "documentation":"

A description for the snapshot.

" } } }, "CreateSpotDatafeedSubscriptionRequest":{ "type":"structure", "required":["Bucket"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket in which to store the Spot instance data feed.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

A prefix for the data feed file names.

", "locationName":"prefix" } }, "documentation":"

Contains the parameters for CreateSpotDatafeedSubscription.

" }, "CreateSpotDatafeedSubscriptionResult":{ "type":"structure", "members":{ "SpotDatafeedSubscription":{ "shape":"SpotDatafeedSubscription", "documentation":"

The Spot instance data feed subscription.

", "locationName":"spotDatafeedSubscription" } }, "documentation":"

Contains the output of CreateSpotDatafeedSubscription.

" }, "CreateSubnetRequest":{ "type":"structure", "required":[ "VpcId", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the subnet.

Default: Amazon EC2 selects one for you (recommended).

" } } }, "CreateSubnetResult":{ "type":"structure", "members":{ "Subnet":{ "shape":"Subnet", "documentation":"

Information about the subnet.

", "locationName":"subnet" } } }, "CreateTagsRequest":{ "type":"structure", "required":[ "Resources", "Tags" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Resources":{ "shape":"ResourceIdList", "documentation":"

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

", "locationName":"ResourceId" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", "locationName":"Tag" } } }, "CreateVolumePermission":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

", "locationName":"userId" }, "Group":{ "shape":"PermissionGroup", "documentation":"

The specific group that is to be added or removed from a volume's list of create volume permissions.

", "locationName":"group" } }, "documentation":"

Describes the user or group to be added or removed from the permissions for a volume.

" }, "CreateVolumePermissionList":{ "type":"list", "member":{ "shape":"CreateVolumePermission", "locationName":"item" } }, "CreateVolumePermissionModifications":{ "type":"structure", "members":{ "Add":{ "shape":"CreateVolumePermissionList", "documentation":"

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

" }, "Remove":{ "shape":"CreateVolumePermissionList", "documentation":"

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

" } }, "documentation":"

Describes modifications to the permissions for a volume.

" }, "CreateVolumeRequest":{ "type":"structure", "required":["AvailabilityZone"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Size":{ "shape":"Integer", "documentation":"

The size of the volume, in GiBs.

Constraints: 1-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot from which to create the volume.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

Default: standard

" }, "Iops":{ "shape":"Integer", "documentation":"

Only valid for Provisioned IOPS (SSD) volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If a KmsKeyId is specified, the Encrypted flag must also be set.

" } } }, "CreateVpcEndpointRequest":{ "type":"structure", "required":[ "VpcId", "ServiceName" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC in which the endpoint will be used.

" }, "ServiceName":{ "shape":"String", "documentation":"

The AWS service name, in the form com.amazonaws.region.service. To get a list of available services, use the DescribeVpcEndpointServices request.

" }, "PolicyDocument":{ "shape":"String", "documentation":"

A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs.

", "locationName":"RouteTableId" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" } } }, "CreateVpcEndpointResult":{ "type":"structure", "members":{ "VpcEndpoint":{ "shape":"VpcEndpoint", "documentation":"

Information about the endpoint.

", "locationName":"vpcEndpoint" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", "locationName":"clientToken" } } }, "CreateVpcPeeringConnectionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the requester VPC.

", "locationName":"vpcId" }, "PeerVpcId":{ "shape":"String", "documentation":"

The ID of the VPC with which you are creating the VPC peering connection.

", "locationName":"peerVpcId" }, "PeerOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

", "locationName":"peerOwnerId" } } }, "CreateVpcPeeringConnectionResult":{ "type":"structure", "members":{ "VpcPeeringConnection":{ "shape":"VpcPeeringConnection", "documentation":"

Information about the VPC peering connection.

", "locationName":"vpcPeeringConnection" } } }, "CreateVpcRequest":{ "type":"structure", "required":["CidrBlock"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The supported tenancy options for instances launched into the VPC. A value of default means that instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC are launched as dedicated tenancy instances regardless of the tenancy assigned to the instance at launch. Dedicated tenancy instances run on single-tenant hardware.

Default: default

", "locationName":"instanceTenancy" } } }, "CreateVpcResult":{ "type":"structure", "members":{ "Vpc":{ "shape":"Vpc", "documentation":"

Information about the VPC.

", "locationName":"vpc" } } }, "CreateVpnConnectionRequest":{ "type":"structure", "required":[ "Type", "CustomerGatewayId", "VpnGatewayId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Type":{ "shape":"String", "documentation":"

The type of VPN connection (ipsec.1).

" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "Options":{ "shape":"VpnConnectionOptionsSpecification", "documentation":"

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

", "locationName":"options" } } }, "CreateVpnConnectionResult":{ "type":"structure", "members":{ "VpnConnection":{ "shape":"VpnConnection", "documentation":"

Information about the VPN connection.

", "locationName":"vpnConnection" } } }, "CreateVpnConnectionRouteRequest":{ "type":"structure", "required":[ "VpnConnectionId", "DestinationCidrBlock" ], "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer network.

" } } }, "CreateVpnGatewayRequest":{ "type":"structure", "required":["Type"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection this virtual private gateway supports.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the virtual private gateway.

" } } }, "CreateVpnGatewayResult":{ "type":"structure", "members":{ "VpnGateway":{ "shape":"VpnGateway", "documentation":"

Information about the virtual private gateway.

", "locationName":"vpnGateway" } } }, "CurrencyCodeValues":{ "type":"string", "enum":["USD"] }, "CustomerGateway":{ "type":"structure", "members":{ "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

", "locationName":"customerGatewayId" }, "State":{ "shape":"String", "documentation":"

The current state of the customer gateway (pending | available | deleting | deleted).

", "locationName":"state" }, "Type":{ "shape":"String", "documentation":"

The type of VPN connection the customer gateway supports (ipsec.1).

", "locationName":"type" }, "IpAddress":{ "shape":"String", "documentation":"

The Internet-routable IP address of the customer gateway's outside interface.

", "locationName":"ipAddress" }, "BgpAsn":{ "shape":"String", "documentation":"

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", "locationName":"bgpAsn" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the customer gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes a customer gateway.

" }, "CustomerGatewayIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"CustomerGatewayId" } }, "CustomerGatewayList":{ "type":"list", "member":{ "shape":"CustomerGateway", "locationName":"item" } }, "DatafeedSubscriptionState":{ "type":"string", "enum":[ "Active", "Inactive" ] }, "DateTime":{"type":"timestamp"}, "DeleteCustomerGatewayRequest":{ "type":"structure", "required":["CustomerGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

" } } }, "DeleteDhcpOptionsRequest":{ "type":"structure", "required":["DhcpOptionsId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the DHCP options set.

" } } }, "DeleteFlowLogsRequest":{ "type":"structure", "required":["FlowLogIds"], "members":{ "FlowLogIds":{ "shape":"ValueStringList", "documentation":"

One or more flow log IDs.

", "locationName":"FlowLogId" } } }, "DeleteFlowLogsResult":{ "type":"structure", "members":{ "Unsuccessful":{ "shape":"UnsuccessfulItemSet", "documentation":"

Information about the flow logs that could not be deleted successfully.

", "locationName":"unsuccessful" } } }, "DeleteInternetGatewayRequest":{ "type":"structure", "required":["InternetGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" } } }, "DeleteKeyPairRequest":{ "type":"structure", "required":["KeyName"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

" } } }, "DeleteNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Egress" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number of the entry to delete.

", "locationName":"ruleNumber" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether the rule is an egress rule.

", "locationName":"egress" } } }, "DeleteNetworkAclRequest":{ "type":"structure", "required":["NetworkAclId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" } } }, "DeleteNetworkInterfaceRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" } } }, "DeletePlacementGroupRequest":{ "type":"structure", "required":["GroupName"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

", "locationName":"groupName" } } }, "DeleteRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", "locationName":"destinationCidrBlock" } } }, "DeleteRouteTableRequest":{ "type":"structure", "required":["RouteTableId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" } } }, "DeleteSecurityGroupRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a nondefault VPC.

" } } }, "DeleteSnapshotRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot.

" } } }, "DeleteSpotDatafeedSubscriptionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for DeleteSpotDatafeedSubscription.

" }, "DeleteSubnetRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

" } } }, "DeleteTagsRequest":{ "type":"structure", "required":["Resources"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Resources":{ "shape":"ResourceIdList", "documentation":"

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

", "locationName":"resourceId" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

", "locationName":"tag" } } }, "DeleteVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" } } }, "DeleteVpcEndpointsRequest":{ "type":"structure", "required":["VpcEndpointIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcEndpointIds":{ "shape":"ValueStringList", "documentation":"

One or more endpoint IDs.

", "locationName":"VpcEndpointId" } } }, "DeleteVpcEndpointsResult":{ "type":"structure", "members":{ "Unsuccessful":{ "shape":"UnsuccessfulItemSet", "documentation":"

Information about the endpoints that were not successfully deleted.

", "locationName":"unsuccessful" } } }, "DeleteVpcPeeringConnectionRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "DeleteVpcPeeringConnectionResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "DeleteVpcRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } } }, "DeleteVpnConnectionRequest":{ "type":"structure", "required":["VpnConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" } } }, "DeleteVpnConnectionRouteRequest":{ "type":"structure", "required":[ "VpnConnectionId", "DestinationCidrBlock" ], "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer network.

" } } }, "DeleteVpnGatewayRequest":{ "type":"structure", "required":["VpnGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } } }, "DeregisterImageRequest":{ "type":"structure", "required":["ImageId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" } } }, "DescribeAccountAttributesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AttributeNames":{ "shape":"AccountAttributeNameStringList", "documentation":"

One or more account attribute names.

", "locationName":"attributeName" } } }, "DescribeAccountAttributesResult":{ "type":"structure", "members":{ "AccountAttributes":{ "shape":"AccountAttributeList", "documentation":"

Information about one or more account attributes.

", "locationName":"accountAttributeSet" } } }, "DescribeAddressesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIps":{ "shape":"PublicIpStringList", "documentation":"

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", "locationName":"PublicIp" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

", "locationName":"Filter" }, "AllocationIds":{ "shape":"AllocationIdList", "documentation":"

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

", "locationName":"AllocationId" } } }, "DescribeAddressesResult":{ "type":"structure", "members":{ "Addresses":{ "shape":"AddressList", "documentation":"

Information about one or more Elastic IP addresses.

", "locationName":"addressesSet" } } }, "DescribeAvailabilityZonesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ZoneNames":{ "shape":"ZoneNameStringList", "documentation":"

The names of one or more Availability Zones.

", "locationName":"ZoneName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | impaired | unavailable).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", "locationName":"Filter" } } }, "DescribeAvailabilityZonesResult":{ "type":"structure", "members":{ "AvailabilityZones":{ "shape":"AvailabilityZoneList", "documentation":"

Information about one or more Availability Zones.

", "locationName":"availabilityZoneInfo" } } }, "DescribeBundleTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "BundleIds":{ "shape":"BundleIdStringList", "documentation":"

One or more bundle task IDs.

Default: Describes all your bundle tasks.

", "locationName":"BundleId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", "locationName":"Filter" } } }, "DescribeBundleTasksResult":{ "type":"structure", "members":{ "BundleTasks":{ "shape":"BundleTaskList", "documentation":"

Information about one or more bundle tasks.

", "locationName":"bundleInstanceTasksSet" } } }, "DescribeClassicLinkInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC that the instance is linked to.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

", "locationName":"maxResults" } } }, "DescribeClassicLinkInstancesResult":{ "type":"structure", "members":{ "Instances":{ "shape":"ClassicLinkInstanceList", "documentation":"

Information about one or more linked EC2-Classic instances.

", "locationName":"instancesSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeConversionTaskList":{ "type":"list", "member":{ "shape":"ConversionTask", "locationName":"item" } }, "DescribeConversionTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

", "locationName":"filter" }, "ConversionTaskIds":{ "shape":"ConversionIdStringList", "documentation":"

One or more conversion task IDs.

", "locationName":"conversionTaskId" } } }, "DescribeConversionTasksResult":{ "type":"structure", "members":{ "ConversionTasks":{ "shape":"DescribeConversionTaskList", "documentation":"

Information about the conversion tasks.

", "locationName":"conversionTasks" } } }, "DescribeCustomerGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "CustomerGatewayIds":{ "shape":"CustomerGatewayIdStringList", "documentation":"

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", "locationName":"CustomerGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } } }, "DescribeCustomerGatewaysResult":{ "type":"structure", "members":{ "CustomerGateways":{ "shape":"CustomerGatewayList", "documentation":"

Information about one or more customer gateways.

", "locationName":"customerGatewaySet" } } }, "DescribeDhcpOptionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "DhcpOptionsIds":{ "shape":"DhcpOptionsIdStringList", "documentation":"

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", "locationName":"DhcpOptionsId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • dhcp-options-id - The ID of a set of DHCP options.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } } }, "DescribeDhcpOptionsResult":{ "type":"structure", "members":{ "DhcpOptions":{ "shape":"DhcpOptionsList", "documentation":"

Information about one or more DHCP options sets.

", "locationName":"dhcpOptionsSet" } } }, "DescribeExportTasksRequest":{ "type":"structure", "members":{ "ExportTaskIds":{ "shape":"ExportTaskIdStringList", "documentation":"

One or more export task IDs.

", "locationName":"exportTaskId" } } }, "DescribeExportTasksResult":{ "type":"structure", "members":{ "ExportTasks":{ "shape":"ExportTaskList", "documentation":"

Information about the export tasks.

", "locationName":"exportTaskSet" } } }, "DescribeFlowLogsRequest":{ "type":"structure", "members":{ "FlowLogIds":{ "shape":"ValueStringList", "documentation":"

One or more flow log IDs.

", "locationName":"FlowLogId" }, "Filter":{ "shape":"FilterList", "documentation":"

One or more filters.

  • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

  • flow-log-id - The ID of the flow log.

  • log-group-name - The name of the log group.

  • resource-id - The ID of the VPC, subnet, or network interface.

  • traffic-type - The type of traffic (ACCEPT | REJECT | ALL)

" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the flow log IDs parameter in the same request.

" } } }, "DescribeFlowLogsResult":{ "type":"structure", "members":{ "FlowLogs":{ "shape":"FlowLogSet", "documentation":"

Information about the flow logs.

", "locationName":"flowLogSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeImageAttributeRequest":{ "type":"structure", "required":[ "ImageId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"ImageAttributeName", "documentation":"

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

" } } }, "DescribeImagesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageIds":{ "shape":"ImageIdStringList", "documentation":"

One or more image IDs.

Default: Describes all images available to you.

", "locationName":"ImageId" }, "Owners":{ "shape":"OwnerStringList", "documentation":"

Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

", "locationName":"Owner" }, "ExecutableUsers":{ "shape":"ExecutableByStringList", "documentation":"

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", "locationName":"ExecutableBy" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • architecture - The image architecture (i386 | x86_64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

  • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | standard | io1).

  • description - The description of the image (provided during image creation).

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - The AWS account alias (for example, amazon).

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", "locationName":"Filter" } } }, "DescribeImagesResult":{ "type":"structure", "members":{ "Images":{ "shape":"ImageList", "documentation":"

Information about one or more images.

", "locationName":"imagesSet" } } }, "DescribeImportImageTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ImportTaskIds":{ "shape":"ImportTaskIdList", "documentation":"

A list of import image task IDs.

", "locationName":"ImportTaskId" }, "NextToken":{ "shape":"String", "documentation":"

A token that indicates the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single request.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

" } } }, "DescribeImportImageTasksResult":{ "type":"structure", "members":{ "ImportImageTasks":{ "shape":"ImportImageTaskList", "documentation":"

A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.

", "locationName":"importImageTaskSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeImportSnapshotTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "ImportTaskIds":{ "shape":"ImportTaskIdList", "documentation":"

A list of import snapshot task IDs.

", "locationName":"ImportTaskId" }, "NextToken":{ "shape":"String", "documentation":"

A token that indicates the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single request.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

" } } }, "DescribeImportSnapshotTasksResult":{ "type":"structure", "members":{ "ImportSnapshotTasks":{ "shape":"ImportSnapshotTaskList", "documentation":"

A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.

", "locationName":"importSnapshotTaskSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The instance attribute.

", "locationName":"attribute" } } }, "DescribeInstanceStatusRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

" }, "IncludeAllInstances":{ "shape":"Boolean", "documentation":"

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", "locationName":"includeAllInstances" } } }, "DescribeInstanceStatusResult":{ "type":"structure", "members":{ "InstanceStatuses":{ "shape":"InstanceStatusList", "documentation":"

One or more instance status descriptions.

", "locationName":"instanceStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Default: Describes all your instances.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • architecture - The instance architecture (i386 | x86_64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance (spot).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IP address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - 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 - The time when the instance was launched.

  • monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.

  • private-dns-name - The private DNS name of the instance.

  • private-ip-address - The private IP address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - 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 - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - 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 - The name of the root device for the instance (for example, /dev/sda1 or /dev/xvda).

  • root-device-type - The type of root device that the instance uses (ebs | instance-store).

  • source-dest-check - 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 - The ID of the Spot Instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • tenancy - The tenancy of an instance (dedicated | default).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

  • network-interface.description - The description of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • network-interface.network-interface.id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface-private-dns-name - The private DNS name of the network interface.

  • network-interface.source-dest-check - 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.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.addresses.private-ip-address - The private IP address associated with the network interface.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to request the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

", "locationName":"maxResults" } } }, "DescribeInstancesResult":{ "type":"structure", "members":{ "Reservations":{ "shape":"ReservationList", "documentation":"

One or more reservations.

", "locationName":"reservationSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeInternetGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayIds":{ "shape":"ValueStringList", "documentation":"

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

", "locationName":"internetGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } } }, "DescribeInternetGatewaysResult":{ "type":"structure", "members":{ "InternetGateways":{ "shape":"InternetGatewayList", "documentation":"

Information about one or more Internet gateways.

", "locationName":"internetGatewaySet" } } }, "DescribeKeyPairsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyNames":{ "shape":"KeyNameStringList", "documentation":"

One or more key pair names.

Default: Describes all your key pairs.

", "locationName":"KeyName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", "locationName":"Filter" } } }, "DescribeKeyPairsResult":{ "type":"structure", "members":{ "KeyPairs":{ "shape":"KeyPairList", "documentation":"

Information about one or more key pairs.

", "locationName":"keySet" } } }, "DescribeMovingAddressesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIps":{ "shape":"ValueStringList", "documentation":"

One or more Elastic IP addresses.

", "locationName":"publicIp" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results.

", "locationName":"nextToken" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).

", "locationName":"filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.

Default: If no value is provided, the default is 1000.

", "locationName":"maxResults" } } }, "DescribeMovingAddressesResult":{ "type":"structure", "members":{ "MovingAddressStatuses":{ "shape":"MovingAddressStatusSet", "documentation":"

The status for each Elastic IP address.

", "locationName":"movingAddressStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeNetworkAclsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclIds":{ "shape":"ValueStringList", "documentation":"

One or more network ACL IDs.

Default: Describes all your network ACLs.

", "locationName":"NetworkAclId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The CIDR range specified in the entry.

  • entry.egress - Indicates whether the entry applies to egress traffic.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.

  • network-acl-id - The ID of the network ACL.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network ACL.

", "locationName":"Filter" } } }, "DescribeNetworkAclsResult":{ "type":"structure", "members":{ "NetworkAcls":{ "shape":"NetworkAclList", "documentation":"

Information about one or more network ACLs.

", "locationName":"networkAclSet" } } }, "DescribeNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Attribute":{ "shape":"NetworkInterfaceAttribute", "documentation":"

The attribute of the network interface.

", "locationName":"attribute" } } }, "DescribeNetworkInterfaceAttributeResult":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Description":{ "shape":"AttributeValue", "documentation":"

The description of the network interface.

", "locationName":"description" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

The security groups associated with the network interface.

", "locationName":"groupSet" }, "Attachment":{ "shape":"NetworkInterfaceAttachment", "documentation":"

The attachment (if any) of the network interface.

", "locationName":"attachment" } } }, "DescribeNetworkInterfacesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceIds":{ "shape":"NetworkInterfaceIdList", "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", "locationName":"NetworkInterfaceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IP addresses associated with the network interface.

  • addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface.

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • attachment.attach.time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IP address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-desk-check - 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 - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network interface.

", "locationName":"filter" } } }, "DescribeNetworkInterfacesResult":{ "type":"structure", "members":{ "NetworkInterfaces":{ "shape":"NetworkInterfaceList", "documentation":"

Information about one or more network interfaces.

", "locationName":"networkInterfaceSet" } } }, "DescribePlacementGroupsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupNames":{ "shape":"PlacementGroupStringList", "documentation":"

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

", "locationName":"groupName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster).

", "locationName":"Filter" } } }, "DescribePlacementGroupsResult":{ "type":"structure", "members":{ "PlacementGroups":{ "shape":"PlacementGroupList", "documentation":"

One or more placement groups.

", "locationName":"placementGroupSet" } } }, "DescribePrefixListsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "PrefixListIds":{ "shape":"ValueStringList", "documentation":"

One or more prefix list IDs.

", "locationName":"PrefixListId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • prefix-list-id: The ID of a prefix list.

  • prefix-list-name: The name of a prefix list.

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } } }, "DescribePrefixListsResult":{ "type":"structure", "members":{ "PrefixLists":{ "shape":"PrefixListSet", "documentation":"

All available prefix lists.

", "locationName":"prefixListSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } } }, "DescribeRegionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RegionNames":{ "shape":"RegionNameStringList", "documentation":"

The names of one or more regions.

", "locationName":"RegionName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

  • region-name - The name of the region (for example, us-east-1).

", "locationName":"Filter" } } }, "DescribeRegionsResult":{ "type":"structure", "members":{ "Regions":{ "shape":"RegionList", "documentation":"

Information about one or more regions.

", "locationName":"regionInfo" } } }, "DescribeReservedInstancesListingsRequest":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

One or more Reserved Instance IDs.

", "locationName":"reservedInstancesId" }, "ReservedInstancesListingId":{ "shape":"String", "documentation":"

One or more Reserved Instance Listing IDs.

", "locationName":"reservedInstancesListingId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", "locationName":"filters" } } }, "DescribeReservedInstancesListingsResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

Information about the Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } } }, "DescribeReservedInstancesModificationsRequest":{ "type":"structure", "members":{ "ReservedInstancesModificationIds":{ "shape":"ReservedInstancesModificationIdStringList", "documentation":"

IDs for the submitted modification request.

", "locationName":"ReservedInstancesModificationId" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

", "locationName":"Filter" } } }, "DescribeReservedInstancesModificationsResult":{ "type":"structure", "members":{ "ReservedInstancesModifications":{ "shape":"ReservedInstancesModificationList", "documentation":"

The Reserved Instance modification information.

", "locationName":"reservedInstancesModificationsSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeReservedInstancesOfferingsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ReservedInstancesOfferingIds":{ "shape":"ReservedInstancesOfferingIdStringList", "documentation":"

One or more Reserved Instances offering IDs.

", "locationName":"ReservedInstancesOfferingId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type on which the Reserved Instance can be used.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from AWS and Reserved Instance Marketplace are listed.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", "locationName":"Filter" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the Reserved Instance offering. A Reserved Instance with dedicated tenancy runs on single-tenant hardware and can only be launched within a VPC.

Default: default

", "locationName":"instanceTenancy" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", "locationName":"offeringType" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

", "locationName":"maxResults" }, "IncludeMarketplace":{ "shape":"Boolean", "documentation":"

Include Marketplace offerings in the response.

" }, "MinDuration":{ "shape":"Long", "documentation":"

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

" }, "MaxDuration":{ "shape":"Long", "documentation":"

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

" }, "MaxInstanceCount":{ "shape":"Integer", "documentation":"

The maximum number of instances to filter when searching for offerings.

Default: 20

" } } }, "DescribeReservedInstancesOfferingsResult":{ "type":"structure", "members":{ "ReservedInstancesOfferings":{ "shape":"ReservedInstancesOfferingList", "documentation":"

A list of Reserved Instances offerings.

", "locationName":"reservedInstancesOfferingsSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeReservedInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ReservedInstancesIds":{ "shape":"ReservedInstancesIdStringList", "documentation":"

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

", "locationName":"ReservedInstancesId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type on which the Reserved Instance can be used.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", "locationName":"Filter" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", "locationName":"offeringType" } } }, "DescribeReservedInstancesResult":{ "type":"structure", "members":{ "ReservedInstances":{ "shape":"ReservedInstancesList", "documentation":"

A list of Reserved Instances.

", "locationName":"reservedInstancesSet" } } }, "DescribeRouteTablesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs.

Default: Describes all your route tables.

", "locationName":"RouteTableId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC.

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The CIDR range specified in a route in the table.

  • route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). 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).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the route table.

", "locationName":"Filter" } } }, "DescribeRouteTablesResult":{ "type":"structure", "members":{ "RouteTables":{ "shape":"RouteTableList", "documentation":"

Information about one or more route tables.

", "locationName":"routeTableSet" } } }, "DescribeSecurityGroupsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupNames":{ "shape":"GroupNameStringList", "documentation":"

[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

", "locationName":"GroupName" }, "GroupIds":{ "shape":"GroupIdStringList", "documentation":"

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

", "locationName":"GroupId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which the security group allows access.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - A CIDR range that has been granted permission.

  • ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been granted permission.

  • ip-permission.group-name - The name of a security group that has been granted permission.

  • ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been granted permission.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag-key - The key of a tag assigned to the security group.

  • tag-value - The value of a tag assigned to the security group.

  • vpc-id - The ID of the VPC specified when the security group was created.

", "locationName":"Filter" } } }, "DescribeSecurityGroupsResult":{ "type":"structure", "members":{ "SecurityGroups":{ "shape":"SecurityGroupList", "documentation":"

Information about one or more security groups.

", "locationName":"securityGroupInfo" } } }, "DescribeSnapshotAttributeRequest":{ "type":"structure", "required":[ "SnapshotId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The snapshot attribute you would like to view.

" } } }, "DescribeSnapshotAttributeResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot.

", "locationName":"snapshotId" }, "CreateVolumePermissions":{ "shape":"CreateVolumePermissionList", "documentation":"

A list of permissions for creating volumes from the snapshot.

", "locationName":"createVolumePermission" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" } } }, "DescribeSnapshotsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotIds":{ "shape":"SnapshotIdStringList", "documentation":"

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

", "locationName":"SnapshotId" }, "OwnerIds":{ "shape":"OwnerStringList", "documentation":"

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

", "locationName":"Owner" }, "RestorableByUserIds":{ "shape":"RestorableByStringList", "documentation":"

One or more AWS accounts IDs that can create volumes from the snapshot.

", "locationName":"RestorableBy" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • description - A description of the snapshot.

  • owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

  • owner-id - The ID of the AWS account that owns the snapshot.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

" } } }, "DescribeSnapshotsResult":{ "type":"structure", "members":{ "Snapshots":{ "shape":"SnapshotList", "documentation":"

Information about the snapshots.

", "locationName":"snapshotSet" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeSpotDatafeedSubscriptionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } }, "documentation":"

Contains the parameters for DescribeSpotDatafeedSubscription.

" }, "DescribeSpotDatafeedSubscriptionResult":{ "type":"structure", "members":{ "SpotDatafeedSubscription":{ "shape":"SpotDatafeedSubscription", "documentation":"

The Spot instance data feed subscription.

", "locationName":"spotDatafeedSubscription" } }, "documentation":"

Contains the output of DescribeSpotDatafeedSubscription.

" }, "DescribeSpotFleetInstancesRequest":{ "type":"structure", "required":["SpotFleetRequestId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeSpotFleetInstances.

" }, "DescribeSpotFleetInstancesResponse":{ "type":"structure", "required":[ "SpotFleetRequestId", "ActiveInstances" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "ActiveInstances":{ "shape":"ActiveInstanceSet", "documentation":"

The running instances. Note that this list is refreshed periodically and might be out of date.

", "locationName":"activeInstanceSet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotFleetInstances.

" }, "DescribeSpotFleetRequestHistoryRequest":{ "type":"structure", "required":[ "SpotFleetRequestId", "StartTime" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "EventType":{ "shape":"EventType", "documentation":"

The type of events to describe. By default, all events are described.

", "locationName":"eventType" }, "StartTime":{ "shape":"DateTime", "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"startTime" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeSpotFleetRequestHistory.

" }, "DescribeSpotFleetRequestHistoryResponse":{ "type":"structure", "required":[ "SpotFleetRequestId", "StartTime", "LastEvaluatedTime", "HistoryRecords" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "StartTime":{ "shape":"DateTime", "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"startTime" }, "LastEvaluatedTime":{ "shape":"DateTime", "documentation":"

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

If nextToken indicates that there are more results, this value is not present.

", "locationName":"lastEvaluatedTime" }, "HistoryRecords":{ "shape":"HistoryRecords", "documentation":"

Information about the events in the history of the Spot fleet request.

", "locationName":"historyRecordSet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotFleetRequestHistory.

" }, "DescribeSpotFleetRequestsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestIds":{ "shape":"ValueStringList", "documentation":"

The IDs of the Spot fleet requests.

", "locationName":"spotFleetRequestId" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" } }, "documentation":"

Contains the parameters for DescribeSpotFleetRequests.

" }, "DescribeSpotFleetRequestsResponse":{ "type":"structure", "required":["SpotFleetRequestConfigs"], "members":{ "SpotFleetRequestConfigs":{ "shape":"SpotFleetRequestConfigSet", "documentation":"

Information about the configuration of your Spot fleet.

", "locationName":"spotFleetRequestConfigSet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotFleetRequests.

" }, "DescribeSpotInstanceRequestsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotInstanceRequestIds":{ "shape":"SpotInstanceRequestIdList", "documentation":"

One or more Spot instance request IDs.

", "locationName":"SpotInstanceRequestId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume (gp2 | standard | io1).

  • launch.group-id - The security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m1.small).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether monitoring is enabled for the Spot instance.

  • launch.ramdisk-id - The RAM disk ID.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • network-interface.description - A description of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.group-name - The name of the security group associated with the network interface.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot instance request ID.

  • spot-price - The maximum hourly price for any Spot instance launched to fulfill the request.

  • state - The state of the Spot instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

  • status-code - The short code describing the most recent evaluation of your Spot instance request.

  • status-message - The message explaining the status of the Spot instance request.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of Spot instance request (one-time | persistent).

  • launched-availability-zone - The Availability Zone in which the bid is launched.

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", "locationName":"Filter" } }, "documentation":"

Contains the parameters for DescribeSpotInstanceRequests.

" }, "DescribeSpotInstanceRequestsResult":{ "type":"structure", "members":{ "SpotInstanceRequests":{ "shape":"SpotInstanceRequestList", "documentation":"

One or more Spot instance requests.

", "locationName":"spotInstanceRequestSet" } }, "documentation":"

Contains the output of DescribeSpotInstanceRequests.

" }, "DescribeSpotPriceHistoryRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "StartTime":{ "shape":"DateTime", "documentation":"

The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"startTime" }, "EndTime":{ "shape":"DateTime", "documentation":"

The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"endTime" }, "InstanceTypes":{ "shape":"InstanceTypeList", "documentation":"

Filters the results by the specified instance types.

", "locationName":"InstanceType" }, "ProductDescriptions":{ "shape":"ProductDescriptionList", "documentation":"

Filters the results by the specified basic product descriptions.

", "locationName":"ProductDescription" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m1.small).

  • product-description - The product description for the Spot price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - The timestamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

", "locationName":"Filter" }, "AvailabilityZone":{ "shape":"String", "documentation":"

Filters the results by the specified Availability Zone.

", "locationName":"availabilityZone" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of results.

", "locationName":"nextToken" } }, "documentation":"

Contains the parameters for DescribeSpotPriceHistory.

" }, "DescribeSpotPriceHistoryResult":{ "type":"structure", "members":{ "SpotPriceHistory":{ "shape":"SpotPriceHistoryList", "documentation":"

The historical Spot prices.

", "locationName":"spotPriceHistorySet" }, "NextToken":{ "shape":"String", "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } }, "documentation":"

Contains the output of DescribeSpotPriceHistory.

" }, "DescribeSubnetsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SubnetIds":{ "shape":"SubnetIdStringList", "documentation":"

One or more subnet IDs.

Default: Describes all your subnets.

", "locationName":"SubnetId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

  • available-ip-address-count - The number of IP addresses in the subnet that are available.

  • cidrBlock - 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. You can also use cidr or cidr-block as the filter names.

  • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

  • state - The state of the subnet (pending | available).

  • subnet-id - The ID of the subnet.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the subnet.

", "locationName":"Filter" } } }, "DescribeSubnetsResult":{ "type":"structure", "members":{ "Subnets":{ "shape":"SubnetList", "documentation":"

Information about one or more subnets.

", "locationName":"subnetSet" } } }, "DescribeTagsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • key - The tag key.

  • resource-id - The resource ID.

  • resource-type - The resource type (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).

  • value - The tag value.

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" } } }, "DescribeTagsResult":{ "type":"structure", "members":{ "Tags":{ "shape":"TagDescriptionList", "documentation":"

A list of tags.

", "locationName":"tagSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return..

", "locationName":"nextToken" } } }, "DescribeVolumeAttributeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "Attribute":{ "shape":"VolumeAttributeName", "documentation":"

The instance attribute.

" } } }, "DescribeVolumeAttributeResult":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "AutoEnableIO":{ "shape":"AttributeBooleanValue", "documentation":"

The state of autoEnableIO attribute.

", "locationName":"autoEnableIO" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" } } }, "DescribeVolumeStatusRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeIds":{ "shape":"VolumeIdStringList", "documentation":"

One or more volume IDs.

Default: Describes all your volumes.

", "locationName":"VolumeId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

" } } }, "DescribeVolumeStatusResult":{ "type":"structure", "members":{ "VolumeStatuses":{ "shape":"VolumeStatusList", "documentation":"

A list of volumes.

", "locationName":"volumeStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeVolumesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeIds":{ "shape":"VolumeIdStringList", "documentation":"

One or more volume IDs.

", "locationName":"VolumeId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - The encryption status of the volume.

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The status of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

", "locationName":"maxResults" } } }, "DescribeVolumesResult":{ "type":"structure", "members":{ "Volumes":{ "shape":"VolumeList", "documentation":"

Information about the volumes.

", "locationName":"volumeSet" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeVpcAttributeRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "Attribute":{ "shape":"VpcAttributeName", "documentation":"

The VPC attribute.

" } } }, "DescribeVpcAttributeResult":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "EnableDnsSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

", "locationName":"enableDnsSupport" }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

", "locationName":"enableDnsHostnames" } } }, "DescribeVpcClassicLinkRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcIds":{ "shape":"VpcClassicLinkIdList", "documentation":"

One or more VPCs for which you want to describe the ClassicLink status.

", "locationName":"VpcId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } } }, "DescribeVpcClassicLinkResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"VpcClassicLinkList", "documentation":"

The ClassicLink status of one or more VPCs.

", "locationName":"vpcSet" } } }, "DescribeVpcEndpointServicesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } } }, "DescribeVpcEndpointServicesResult":{ "type":"structure", "members":{ "ServiceNames":{ "shape":"ValueStringList", "documentation":"

A list of supported AWS services.

", "locationName":"serviceNameSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } } }, "DescribeVpcEndpointsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcEndpointIds":{ "shape":"ValueStringList", "documentation":"

One or more endpoint IDs.

", "locationName":"VpcEndpointId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • service-name: The name of the AWS service.

  • vpc-id: The ID of the VPC in which the endpoint resides.

  • vpc-endpoint-id: The ID of the endpoint.

  • vpc-endpoint-state: The state of the endpoint. (pending | available | deleting | deleted)

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" }, "NextToken":{ "shape":"String", "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" } } }, "DescribeVpcEndpointsResult":{ "type":"structure", "members":{ "VpcEndpoints":{ "shape":"VpcEndpointSet", "documentation":"

Information about the endpoints.

", "locationName":"vpcEndpointSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", "locationName":"nextToken" } } }, "DescribeVpcPeeringConnectionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionIds":{ "shape":"ValueStringList", "documentation":"

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

", "locationName":"VpcPeeringConnectionId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

  • accepter-vpc-info.vpc-id - The ID of the peer VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

", "locationName":"Filter" } } }, "DescribeVpcPeeringConnectionsResult":{ "type":"structure", "members":{ "VpcPeeringConnections":{ "shape":"VpcPeeringConnectionList", "documentation":"

Information about the VPC peering connections.

", "locationName":"vpcPeeringConnectionSet" } } }, "DescribeVpcsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcIds":{ "shape":"VpcIdStringList", "documentation":"

One or more VPC IDs.

Default: Describes all your VPCs.

", "locationName":"VpcId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • cidr - 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. Must contain the slash followed by one or two digits (for example, /28).

  • dhcp-options-id - The ID of a set of DHCP options.

  • isDefault - Indicates whether the VPC is the default VPC.

  • state - The state of the VPC (pending | available).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC.

", "locationName":"Filter" } } }, "DescribeVpcsResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"VpcList", "documentation":"

Information about one or more VPCs.

", "locationName":"vpcSet" } } }, "DescribeVpnConnectionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnConnectionIds":{ "shape":"VpnConnectionIdStringList", "documentation":"

One or more VPN connection IDs.

Default: Describes your VPN connections.

", "locationName":"VpnConnectionId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

", "locationName":"Filter" } } }, "DescribeVpnConnectionsResult":{ "type":"structure", "members":{ "VpnConnections":{ "shape":"VpnConnectionList", "documentation":"

Information about one or more VPN connections.

", "locationName":"vpnConnectionSet" } } }, "DescribeVpnGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayIds":{ "shape":"VpnGatewayIdStringList", "documentation":"

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

", "locationName":"VpnGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway.

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

", "locationName":"Filter" } } }, "DescribeVpnGatewaysResult":{ "type":"structure", "members":{ "VpnGateways":{ "shape":"VpnGatewayList", "documentation":"

Information about one or more virtual private gateways.

", "locationName":"vpnGatewaySet" } } }, "DetachClassicLinkVpcRequest":{ "type":"structure", "required":[ "InstanceId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance to unlink from the VPC.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC to which the instance is linked.

", "locationName":"vpcId" } } }, "DetachClassicLinkVpcResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "DetachInternetGatewayRequest":{ "type":"structure", "required":[ "InternetGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "DetachNetworkInterfaceRequest":{ "type":"structure", "required":["AttachmentId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AttachmentId":{ "shape":"String", "documentation":"

The ID of the attachment.

", "locationName":"attachmentId" }, "Force":{ "shape":"Boolean", "documentation":"

Specifies whether to force a detachment.

", "locationName":"force" } } }, "DetachVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "Device":{ "shape":"String", "documentation":"

The device name.

" }, "Force":{ "shape":"Boolean", "documentation":"

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

" } } }, "DetachVpnGatewayRequest":{ "type":"structure", "required":[ "VpnGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } } }, "DeviceType":{ "type":"string", "enum":[ "ebs", "instance-store" ] }, "DhcpConfiguration":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The name of a DHCP option.

", "locationName":"key" }, "Values":{ "shape":"DhcpConfigurationValueList", "documentation":"

One or more values for the DHCP option.

", "locationName":"valueSet" } }, "documentation":"

Describes a DHCP configuration option.

" }, "DhcpConfigurationList":{ "type":"list", "member":{ "shape":"DhcpConfiguration", "locationName":"item" } }, "DhcpOptions":{ "type":"structure", "members":{ "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the set of DHCP options.

", "locationName":"dhcpOptionsId" }, "DhcpConfigurations":{ "shape":"DhcpConfigurationList", "documentation":"

One or more DHCP options in the set.

", "locationName":"dhcpConfigurationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the DHCP options set.

", "locationName":"tagSet" } }, "documentation":"

Describes a set of DHCP options.

" }, "DhcpOptionsIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"DhcpOptionsId" } }, "DhcpOptionsList":{ "type":"list", "member":{ "shape":"DhcpOptions", "locationName":"item" } }, "DisableVgwRoutePropagationRequest":{ "type":"structure", "required":[ "RouteTableId", "GatewayId" ], "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } } }, "DisableVpcClassicLinkRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "DisableVpcClassicLinkResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "DisassociateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" }, "AssociationId":{ "shape":"String", "documentation":"

[EC2-VPC] The association ID. Required for EC2-VPC.

" } } }, "DisassociateRouteTableRequest":{ "type":"structure", "required":["AssociationId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID representing the current association between the route table and subnet.

", "locationName":"associationId" } } }, "DiskImage":{ "type":"structure", "members":{ "Image":{ "shape":"DiskImageDetail", "documentation":"

Information about the disk image.

" }, "Description":{ "shape":"String", "documentation":"

A description of the disk image.

" }, "Volume":{ "shape":"VolumeDetail", "documentation":"

Information about the volume.

" } }, "documentation":"

Describes a disk image.

" }, "DiskImageDescription":{ "type":"structure", "required":[ "Format", "Size", "ImportManifestUrl" ], "members":{ "Format":{ "shape":"DiskImageFormat", "documentation":"

The disk image format.

", "locationName":"format" }, "Size":{ "shape":"Long", "documentation":"

The size of the disk image, in GiB.

", "locationName":"size" }, "ImportManifestUrl":{ "shape":"String", "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

", "locationName":"importManifestUrl" }, "Checksum":{ "shape":"String", "documentation":"

The checksum computed for the disk image.

", "locationName":"checksum" } }, "documentation":"

Describes a disk image.

" }, "DiskImageDetail":{ "type":"structure", "required":[ "Format", "Bytes", "ImportManifestUrl" ], "members":{ "Format":{ "shape":"DiskImageFormat", "documentation":"

The disk image format.

", "locationName":"format" }, "Bytes":{ "shape":"Long", "documentation":"

The size of the disk image, in GiB.

", "locationName":"bytes" }, "ImportManifestUrl":{ "shape":"String", "documentation":"

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

", "locationName":"importManifestUrl" } }, "documentation":"

Describes a disk image.

" }, "DiskImageFormat":{ "type":"string", "enum":[ "VMDK", "RAW", "VHD" ] }, "DiskImageList":{ "type":"list", "member":{"shape":"DiskImage"} }, "DiskImageVolumeDescription":{ "type":"structure", "required":["Id"], "members":{ "Size":{ "shape":"Long", "documentation":"

The size of the volume, in GiB.

", "locationName":"size" }, "Id":{ "shape":"String", "documentation":"

The volume identifier.

", "locationName":"id" } }, "documentation":"

Describes a disk image volume.

" }, "DomainType":{ "type":"string", "enum":[ "vpc", "standard" ] }, "Double":{"type":"double"}, "EbsBlockDevice":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

", "locationName":"snapshotId" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

Constraints: 1-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

", "locationName":"volumeSize" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", "locationName":"deleteOnTermination" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

", "locationName":"volumeType" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

", "locationName":"iops" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

", "locationName":"encrypted" } }, "documentation":"

Describes a block device for an EBS volume.

" }, "EbsInstanceBlockDevice":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume.

", "locationName":"volumeId" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a parameter used to set up an EBS volume in a block device mapping.

" }, "EbsInstanceBlockDeviceSpecification":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the EBS volume.

", "locationName":"volumeId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } } }, "EnableVgwRoutePropagationRequest":{ "type":"structure", "required":[ "RouteTableId", "GatewayId" ], "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } } }, "EnableVolumeIORequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" } } }, "EnableVpcClassicLinkRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "EnableVpcClassicLinkResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "EventCode":{ "type":"string", "enum":[ "instance-reboot", "system-reboot", "system-maintenance", "instance-retirement", "instance-stop" ] }, "EventInformation":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance. This information is available only for instanceChange events.

", "locationName":"instanceId" }, "EventSubType":{ "shape":"String", "documentation":"

The event.

The following are the error events.

  • iamFleetRoleInvalid - Spot fleet did not have the required permissions either to launch or terminate an instance.

  • spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description.

  • spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot instances that you can launch.

The following are the fleetRequestChange events.

  • active - The Spot fleet has been validated and Amazon EC2 is attempting to maintain the target number of running Spot instances.

  • cancelled - The Spot fleet is canceled and has no running Spot instances. The Spot fleet will be deleted two days after its instances were terminated.

  • cancelled_running - The Spot fleet is canceled and will not launch additional Spot instances, but its existing Spot instances continue to run until they are interrupted or terminated.

  • cancelled_terminating - The Spot fleet is canceled and its Spot instances are terminating.

  • expired - The Spot fleet request has expired. A subsequent event indicates that the instances were terminated, if the request was created with TerminateInstancesWithExpiration set.

  • price_update - The bid price for a launch configuration was adjusted because it was too high. This change is permanent.

  • submitted - The Spot fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of Spot instances.

The following are the instanceChange events.

  • launched - A bid was fulfilled and a new instance was launched.

  • terminated - An instance was terminated by the user.

", "locationName":"eventSubType" }, "EventDescription":{ "shape":"String", "documentation":"

The description of the event.

", "locationName":"eventDescription" } }, "documentation":"

Describes a Spot fleet event.

" }, "EventType":{ "type":"string", "enum":[ "instanceChange", "fleetRequestChange", "error" ] }, "ExecutableByStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ExecutableBy" } }, "ExportEnvironment":{ "type":"string", "enum":[ "citrix", "vmware", "microsoft" ] }, "ExportTask":{ "type":"structure", "members":{ "ExportTaskId":{ "shape":"String", "documentation":"

The ID of the export task.

", "locationName":"exportTaskId" }, "Description":{ "shape":"String", "documentation":"

A description of the resource being exported.

", "locationName":"description" }, "State":{ "shape":"ExportTaskState", "documentation":"

The state of the export task.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message related to the export task.

", "locationName":"statusMessage" }, "InstanceExportDetails":{ "shape":"InstanceExportDetails", "documentation":"

Information about the instance to export.

", "locationName":"instanceExport" }, "ExportToS3Task":{ "shape":"ExportToS3Task", "documentation":"

Information about the export task.

", "locationName":"exportToS3" } }, "documentation":"

Describes an instance export task.

" }, "ExportTaskIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ExportTaskId" } }, "ExportTaskList":{ "type":"list", "member":{ "shape":"ExportTask", "locationName":"item" } }, "ExportTaskState":{ "type":"string", "enum":[ "active", "cancelling", "cancelled", "completed" ] }, "ExportToS3Task":{ "type":"structure", "members":{ "DiskImageFormat":{ "shape":"DiskImageFormat", "documentation":"

The format for the exported image.

", "locationName":"diskImageFormat" }, "ContainerFormat":{ "shape":"ContainerFormat", "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", "locationName":"containerFormat" }, "S3Bucket":{ "shape":"String", "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", "locationName":"s3Bucket" }, "S3Key":{ "shape":"String", "documentation":"

The encryption key for your S3 bucket.

", "locationName":"s3Key" } }, "documentation":"

Describes the format and location for an instance export task.

" }, "ExportToS3TaskSpecification":{ "type":"structure", "members":{ "DiskImageFormat":{ "shape":"DiskImageFormat", "documentation":"

The format for the exported image.

", "locationName":"diskImageFormat" }, "ContainerFormat":{ "shape":"ContainerFormat", "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", "locationName":"containerFormat" }, "S3Bucket":{ "shape":"String", "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", "locationName":"s3Bucket" }, "S3Prefix":{ "shape":"String", "documentation":"

The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

", "locationName":"s3Prefix" } }, "documentation":"

Describes an instance export task.

" }, "Filter":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the filter. Filter names are case-sensitive.

" }, "Values":{ "shape":"ValueStringList", "documentation":"

One or more filter values. Filter values are case-sensitive.

", "locationName":"Value" } }, "documentation":"

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.

" }, "FilterList":{ "type":"list", "member":{ "shape":"Filter", "locationName":"Filter" } }, "Float":{"type":"float"}, "FlowLog":{ "type":"structure", "members":{ "CreationTime":{ "shape":"DateTime", "documentation":"

The date and time the flow log was created.

", "locationName":"creationTime" }, "FlowLogId":{ "shape":"String", "documentation":"

The flow log ID.

", "locationName":"flowLogId" }, "FlowLogStatus":{ "shape":"String", "documentation":"

The status of the flow log (ACTIVE).

", "locationName":"flowLogStatus" }, "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource on which the flow log was created.

", "locationName":"resourceId" }, "TrafficType":{ "shape":"TrafficType", "documentation":"

The type of traffic captured for the flow log.

", "locationName":"trafficType" }, "LogGroupName":{ "shape":"String", "documentation":"

The name of the flow log group.

", "locationName":"logGroupName" }, "DeliverLogsStatus":{ "shape":"String", "documentation":"

The status of the logs delivery (SUCCESS | FAILED).

", "locationName":"deliverLogsStatus" }, "DeliverLogsErrorMessage":{ "shape":"String", "documentation":"

Information about the error that occurred. Rate limited indicates that CloudWatch logs throttling has been applied for one or more network interfaces. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.

", "locationName":"deliverLogsErrorMessage" }, "DeliverLogsPermissionArn":{ "shape":"String", "documentation":"

The ARN of the IAM role that posts logs to CloudWatch Logs.

", "locationName":"deliverLogsPermissionArn" } }, "documentation":"

Describes a flow log.

" }, "FlowLogSet":{ "type":"list", "member":{ "shape":"FlowLog", "locationName":"item" } }, "FlowLogsResourceType":{ "type":"string", "enum":[ "VPC", "Subnet", "NetworkInterface" ] }, "GatewayType":{ "type":"string", "enum":["ipsec.1"] }, "GetConsoleOutputRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" } } }, "GetConsoleOutputResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The time the output was last updated.

", "locationName":"timestamp" }, "Output":{ "shape":"String", "documentation":"

The console output, Base64 encoded.

", "locationName":"output" } } }, "GetPasswordDataRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the Windows instance.

" } } }, "GetPasswordDataResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the Windows instance.

", "locationName":"instanceId" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The time the data was last updated.

", "locationName":"timestamp" }, "PasswordData":{ "shape":"String", "documentation":"

The password of the instance.

", "locationName":"passwordData" } } }, "GroupIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"groupId" } }, "GroupIdentifier":{ "type":"structure", "members":{ "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } }, "documentation":"

Describes a security group.

" }, "GroupIdentifierList":{ "type":"list", "member":{ "shape":"GroupIdentifier", "locationName":"item" } }, "GroupNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"GroupName" } }, "HistoryRecord":{ "type":"structure", "required":[ "Timestamp", "EventType", "EventInformation" ], "members":{ "Timestamp":{ "shape":"DateTime", "documentation":"

The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"timestamp" }, "EventType":{ "shape":"EventType", "documentation":"

The event type.

  • error - Indicates an error with the Spot fleet request.

  • fleetRequestChange - Indicates a change in the status or configuration of the Spot fleet request.

  • instanceChange - Indicates that an instance was launched or terminated.

", "locationName":"eventType" }, "EventInformation":{ "shape":"EventInformation", "documentation":"

Information about the event.

", "locationName":"eventInformation" } }, "documentation":"

Describes an event in the history of the Spot fleet request.

" }, "HistoryRecords":{ "type":"list", "member":{ "shape":"HistoryRecord", "locationName":"item" } }, "HypervisorType":{ "type":"string", "enum":[ "ovm", "xen" ] }, "IamInstanceProfile":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", "locationName":"arn" }, "Id":{ "shape":"String", "documentation":"

The ID of the instance profile.

", "locationName":"id" } }, "documentation":"

Describes an IAM instance profile.

" }, "IamInstanceProfileSpecification":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", "locationName":"arn" }, "Name":{ "shape":"String", "documentation":"

The name of the instance profile.

", "locationName":"name" } }, "documentation":"

Describes an IAM instance profile.

" }, "IcmpTypeCode":{ "type":"structure", "members":{ "Type":{ "shape":"Integer", "documentation":"

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", "locationName":"type" }, "Code":{ "shape":"Integer", "documentation":"

The ICMP type. A value of -1 means all types.

", "locationName":"code" } }, "documentation":"

Describes the ICMP type and code.

" }, "Image":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "ImageLocation":{ "shape":"String", "documentation":"

The location of the AMI.

", "locationName":"imageLocation" }, "State":{ "shape":"ImageState", "documentation":"

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", "locationName":"imageState" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the image owner.

", "locationName":"imageOwnerId" }, "CreationDate":{ "shape":"String", "documentation":"

The date and time the image was created.

", "locationName":"creationDate" }, "Public":{ "shape":"Boolean", "documentation":"

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

", "locationName":"isPublic" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

Any product codes associated with the AMI.

", "locationName":"productCodes" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the image.

", "locationName":"architecture" }, "ImageType":{ "shape":"ImageTypeValues", "documentation":"

The type of image.

", "locationName":"imageType" }, "KernelId":{ "shape":"String", "documentation":"

The kernel associated with the image, if any. Only applicable for machine images.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The RAM disk associated with the image, if any. Only applicable for machine images.

", "locationName":"ramdiskId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The value is Windows for Windows AMIs; otherwise blank.

", "locationName":"platform" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Specifies whether enhanced networking is enabled.

", "locationName":"sriovNetSupport" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason for the state change.

", "locationName":"stateReason" }, "ImageOwnerAlias":{ "shape":"String", "documentation":"

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

", "locationName":"imageOwnerAlias" }, "Name":{ "shape":"String", "documentation":"

The name of the AMI that was provided during image creation.

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

The description of the AMI that was provided during image creation.

", "locationName":"description" }, "RootDeviceType":{ "shape":"DeviceType", "documentation":"

The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

", "locationName":"rootDeviceType" }, "RootDeviceName":{ "shape":"String", "documentation":"

The device name of the root device (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

Any block device mapping entries.

", "locationName":"blockDeviceMapping" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The type of virtualization of the AMI.

", "locationName":"virtualizationType" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the image.

", "locationName":"tagSet" }, "Hypervisor":{ "shape":"HypervisorType", "documentation":"

The hypervisor type of the image.

", "locationName":"hypervisor" } }, "documentation":"

Describes an image.

" }, "ImageAttribute":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "LaunchPermissions":{ "shape":"LaunchPermissionList", "documentation":"

One or more launch permissions.

", "locationName":"launchPermission" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

One or more product codes.

", "locationName":"productCodes" }, "KernelId":{ "shape":"AttributeValue", "documentation":"

The kernel ID.

", "locationName":"kernel" }, "RamdiskId":{ "shape":"AttributeValue", "documentation":"

The RAM disk ID.

", "locationName":"ramdisk" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the AMI.

", "locationName":"description" }, "SriovNetSupport":{ "shape":"AttributeValue", "locationName":"sriovNetSupport" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" } }, "documentation":"

Describes an image attribute.

" }, "ImageAttributeName":{ "type":"string", "enum":[ "description", "kernel", "ramdisk", "launchPermission", "productCodes", "blockDeviceMapping", "sriovNetSupport" ] }, "ImageDiskContainer":{ "type":"structure", "members":{ "Description":{ "shape":"String", "documentation":"

The description of the disk image.

" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" }, "Url":{ "shape":"String", "documentation":"

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)

" }, "UserBucket":{ "shape":"UserBucket", "documentation":"

The S3 bucket for the disk image.

" }, "DeviceName":{ "shape":"String", "documentation":"

The block device mapping for the disk.

" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the EBS snapshot to be used for importing the snapshot.

" } }, "documentation":"

Describes the disk container object for an import image task.

" }, "ImageDiskContainerList":{ "type":"list", "member":{ "shape":"ImageDiskContainer", "locationName":"item" } }, "ImageIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ImageId" } }, "ImageList":{ "type":"list", "member":{ "shape":"Image", "locationName":"item" } }, "ImageState":{ "type":"string", "enum":[ "pending", "available", "invalid", "deregistered", "transient", "failed", "error" ] }, "ImageTypeValues":{ "type":"string", "enum":[ "machine", "kernel", "ramdisk" ] }, "ImportImageRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "Description":{ "shape":"String", "documentation":"

A description string for the import image task.

" }, "DiskContainers":{ "shape":"ImageDiskContainerList", "documentation":"

Information about the disk containers.

", "locationName":"DiskContainer" }, "LicenseType":{ "shape":"String", "documentation":"

The license type to be used for the Amazon Machine Image (AMI) after importing.

Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see VM Import/Export Prerequisites in the Amazon Elastic Compute Cloud User Guide.

Valid values: AWS | BYOL

" }, "Hypervisor":{ "shape":"String", "documentation":"

The target hypervisor platform.

Valid values: xen

" }, "Architecture":{ "shape":"String", "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

" }, "Platform":{ "shape":"String", "documentation":"

The operating system of the virtual machine.

Valid values: Windows | Linux

" }, "ClientData":{ "shape":"ClientData", "documentation":"

The client-specific data.

" }, "ClientToken":{ "shape":"String", "documentation":"

The token to enable idempotency for VM import requests.

" }, "RoleName":{ "shape":"String", "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" } } }, "ImportImageResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The task ID of the import image task.

", "locationName":"importTaskId" }, "Architecture":{ "shape":"String", "documentation":"

The architecture of the virtual machine.

", "locationName":"architecture" }, "LicenseType":{ "shape":"String", "documentation":"

The license type of the virtual machine.

", "locationName":"licenseType" }, "Platform":{ "shape":"String", "documentation":"

The operating system of the virtual machine.

", "locationName":"platform" }, "Hypervisor":{ "shape":"String", "documentation":"

The target hypervisor of the import task.

", "locationName":"hypervisor" }, "Description":{ "shape":"String", "documentation":"

A description of the import task.

", "locationName":"description" }, "SnapshotDetails":{ "shape":"SnapshotDetailList", "documentation":"

Information about the snapshots.

", "locationName":"snapshotDetailSet" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the Amazon Machine Image (AMI) created by the import task.

", "locationName":"imageId" }, "Progress":{ "shape":"String", "documentation":"

The progress of the task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message of the import task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status of the task.

", "locationName":"status" } } }, "ImportImageTask":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import image task.

", "locationName":"importTaskId" }, "Architecture":{ "shape":"String", "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

", "locationName":"architecture" }, "LicenseType":{ "shape":"String", "documentation":"

The license type of the virtual machine.

", "locationName":"licenseType" }, "Platform":{ "shape":"String", "documentation":"

The description string for the import image task.

", "locationName":"platform" }, "Hypervisor":{ "shape":"String", "documentation":"

The target hypervisor for the import task.

Valid values: xen

", "locationName":"hypervisor" }, "Description":{ "shape":"String", "documentation":"

A description of the import task.

", "locationName":"description" }, "SnapshotDetails":{ "shape":"SnapshotDetailList", "documentation":"

Information about the snapshots.

", "locationName":"snapshotDetailSet" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

", "locationName":"imageId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of progress of the import image task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A descriptive status message for the import image task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status for the import image task.

", "locationName":"status" } }, "documentation":"

Describes an import image task.

" }, "ImportImageTaskList":{ "type":"list", "member":{ "shape":"ImportImageTask", "locationName":"item" } }, "ImportInstanceLaunchSpecification":{ "type":"structure", "members":{ "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the instance.

", "locationName":"architecture" }, "GroupNames":{ "shape":"SecurityGroupStringList", "documentation":"

One or more security group names.

", "locationName":"GroupName" }, "GroupIds":{ "shape":"SecurityGroupIdStringList", "documentation":"

One or more security group IDs.

", "locationName":"GroupId" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "UserData":{ "shape":"UserData", "documentation":"

The Base64-encoded MIME user data to be made available to the instance.

", "locationName":"userData" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. For more information about the instance types that you can import, see Before You Get Started in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"instanceType" }, "Placement":{ "shape":"Placement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "Monitoring":{ "shape":"Boolean", "documentation":"

Indicates whether monitoring is enabled.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] An available IP address from the IP address range of the subnet.

", "locationName":"privateIpAddress" } }, "documentation":"

Describes the launch specification for VM import.

" }, "ImportInstanceRequest":{ "type":"structure", "required":["Platform"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Description":{ "shape":"String", "documentation":"

A description for the instance being imported.

", "locationName":"description" }, "LaunchSpecification":{ "shape":"ImportInstanceLaunchSpecification", "documentation":"

The launch specification.

", "locationName":"launchSpecification" }, "DiskImages":{ "shape":"DiskImageList", "documentation":"

The disk image.

", "locationName":"diskImage" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The instance operating system.

", "locationName":"platform" } } }, "ImportInstanceResult":{ "type":"structure", "members":{ "ConversionTask":{ "shape":"ConversionTask", "documentation":"

Information about the conversion task.

", "locationName":"conversionTask" } } }, "ImportInstanceTaskDetails":{ "type":"structure", "required":["Volumes"], "members":{ "Volumes":{ "shape":"ImportInstanceVolumeDetailSet", "documentation":"

One or more volumes.

", "locationName":"volumes" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The instance operating system.

", "locationName":"platform" }, "Description":{ "shape":"String", "documentation":"

A description of the task.

", "locationName":"description" } }, "documentation":"

Describes an import instance task.

" }, "ImportInstanceVolumeDetailItem":{ "type":"structure", "required":[ "BytesConverted", "AvailabilityZone", "Image", "Volume", "Status" ], "members":{ "BytesConverted":{ "shape":"Long", "documentation":"

The number of bytes converted so far.

", "locationName":"bytesConverted" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the resulting instance will reside.

", "locationName":"availabilityZone" }, "Image":{ "shape":"DiskImageDescription", "documentation":"

The image.

", "locationName":"image" }, "Volume":{ "shape":"DiskImageVolumeDescription", "documentation":"

The volume.

", "locationName":"volume" }, "Status":{ "shape":"String", "documentation":"

The status of the import of this particular disk image.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The status information or errors related to the disk image.

", "locationName":"statusMessage" }, "Description":{ "shape":"String", "documentation":"

A description of the task.

", "locationName":"description" } }, "documentation":"

Describes an import volume task.

" }, "ImportInstanceVolumeDetailSet":{ "type":"list", "member":{ "shape":"ImportInstanceVolumeDetailItem", "locationName":"item" } }, "ImportKeyPairRequest":{ "type":"structure", "required":[ "KeyName", "PublicKeyMaterial" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

A unique name for the key pair.

", "locationName":"keyName" }, "PublicKeyMaterial":{ "shape":"Blob", "documentation":"

The public key. You must base64 encode the public key material before sending it to AWS.

", "locationName":"publicKeyMaterial" } } }, "ImportKeyPairResult":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The key pair name you provided.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", "locationName":"keyFingerprint" } } }, "ImportSnapshotRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "Description":{ "shape":"String", "documentation":"

The description string for the import snapshot task.

" }, "DiskContainer":{ "shape":"SnapshotDiskContainer", "documentation":"

Information about the disk container.

" }, "ClientData":{ "shape":"ClientData", "documentation":"

The client-specific data.

" }, "ClientToken":{ "shape":"String", "documentation":"

Token to enable idempotency for VM import requests.

" }, "RoleName":{ "shape":"String", "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" } } }, "ImportSnapshotResult":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import snapshot task.

", "locationName":"importTaskId" }, "SnapshotTaskDetail":{ "shape":"SnapshotTaskDetail", "documentation":"

Information about the import snapshot task.

", "locationName":"snapshotTaskDetail" }, "Description":{ "shape":"String", "documentation":"

A description of the import snapshot task.

", "locationName":"description" } } }, "ImportSnapshotTask":{ "type":"structure", "members":{ "ImportTaskId":{ "shape":"String", "documentation":"

The ID of the import snapshot task.

", "locationName":"importTaskId" }, "SnapshotTaskDetail":{ "shape":"SnapshotTaskDetail", "documentation":"

Describes an import snapshot task.

", "locationName":"snapshotTaskDetail" }, "Description":{ "shape":"String", "documentation":"

A description of the import snapshot task.

", "locationName":"description" } }, "documentation":"

Describes an import snapshot task.

" }, "ImportSnapshotTaskList":{ "type":"list", "member":{ "shape":"ImportSnapshotTask", "locationName":"item" } }, "ImportTaskIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"ImportTaskId" } }, "ImportVolumeRequest":{ "type":"structure", "required":[ "AvailabilityZone", "Image", "Volume" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the resulting EBS volume.

", "locationName":"availabilityZone" }, "Image":{ "shape":"DiskImageDetail", "documentation":"

The disk image.

", "locationName":"image" }, "Description":{ "shape":"String", "documentation":"

A description of the volume.

", "locationName":"description" }, "Volume":{ "shape":"VolumeDetail", "documentation":"

The volume size.

", "locationName":"volume" } } }, "ImportVolumeResult":{ "type":"structure", "members":{ "ConversionTask":{ "shape":"ConversionTask", "documentation":"

Information about the conversion task.

", "locationName":"conversionTask" } } }, "ImportVolumeTaskDetails":{ "type":"structure", "required":[ "BytesConverted", "AvailabilityZone", "Image", "Volume" ], "members":{ "BytesConverted":{ "shape":"Long", "documentation":"

The number of bytes converted so far.

", "locationName":"bytesConverted" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the resulting volume will reside.

", "locationName":"availabilityZone" }, "Description":{ "shape":"String", "documentation":"

The description you provided when starting the import volume task.

", "locationName":"description" }, "Image":{ "shape":"DiskImageDescription", "documentation":"

The image.

", "locationName":"image" }, "Volume":{ "shape":"DiskImageVolumeDescription", "documentation":"

The volume.

", "locationName":"volume" } }, "documentation":"

Describes an import volume task.

" }, "Instance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI used to launch the instance.

", "locationName":"imageId" }, "State":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

", "locationName":"instanceState" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

", "locationName":"privateDnsName" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name assigned to the instance. This name is not available until the instance enters the running state.

", "locationName":"dnsName" }, "StateTransitionReason":{ "shape":"String", "documentation":"

The reason for the most recent state transition. This might be an empty string.

", "locationName":"reason" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair, if this instance was launched with an associated key pair.

", "locationName":"keyName" }, "AmiLaunchIndex":{ "shape":"Integer", "documentation":"

The AMI launch index, which can be used to find this instance in the launch group.

", "locationName":"amiLaunchIndex" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

The product codes attached to this instance.

", "locationName":"productCodes" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "LaunchTime":{ "shape":"DateTime", "documentation":"

The time the instance was launched.

", "locationName":"launchTime" }, "Placement":{ "shape":"Placement", "documentation":"

The location where the instance launched.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The kernel associated with this instance.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The RAM disk associated with this instance.

", "locationName":"ramdiskId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The value is Windows for Windows instances; otherwise blank.

", "locationName":"platform" }, "Monitoring":{ "shape":"Monitoring", "documentation":"

The monitoring information for the instance.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which the instance is running.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC in which the instance is running.

", "locationName":"vpcId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address assigned to the instance.

", "locationName":"privateIpAddress" }, "PublicIpAddress":{ "shape":"String", "documentation":"

The public IP address assigned to the instance.

", "locationName":"ipAddress" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason for the most recent state transition.

", "locationName":"stateReason" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the image.

", "locationName":"architecture" }, "RootDeviceType":{ "shape":"DeviceType", "documentation":"

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

", "locationName":"rootDeviceType" }, "RootDeviceName":{ "shape":"String", "documentation":"

The root device name (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"

Any block device mapping entries for the instance.

", "locationName":"blockDeviceMapping" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The virtualization type of the instance.

", "locationName":"virtualizationType" }, "InstanceLifecycle":{ "shape":"InstanceLifecycleType", "documentation":"

Indicates whether this is a Spot Instance.

", "locationName":"instanceLifecycle" }, "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot Instance request.

", "locationName":"spotInstanceRequestId" }, "ClientToken":{ "shape":"String", "documentation":"

The idempotency token you provided when you launched the instance.

", "locationName":"clientToken" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the instance.

", "locationName":"tagSet" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups for the instance.

", "locationName":"groupSet" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", "locationName":"sourceDestCheck" }, "Hypervisor":{ "shape":"HypervisorType", "documentation":"

The hypervisor type of the instance.

", "locationName":"hypervisor" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceList", "documentation":"

[EC2-VPC] One or more network interfaces for the instance.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfile", "documentation":"

The IAM instance profile associated with the instance.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Specifies whether enhanced networking is enabled.

", "locationName":"sriovNetSupport" } }, "documentation":"

Describes an instance.

" }, "InstanceAttribute":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "InstanceType":{ "shape":"AttributeValue", "documentation":"

The instance type.

", "locationName":"instanceType" }, "KernelId":{ "shape":"AttributeValue", "documentation":"

The kernel ID.

", "locationName":"kernel" }, "RamdiskId":{ "shape":"AttributeValue", "documentation":"

The RAM disk ID.

", "locationName":"ramdisk" }, "UserData":{ "shape":"AttributeValue", "documentation":"

The Base64-encoded MIME user data.

", "locationName":"userData" }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", "documentation":"

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ "shape":"AttributeValue", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "RootDeviceName":{ "shape":"AttributeValue", "documentation":"

The name of the root device (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"

The block device mapping of the instance.

", "locationName":"blockDeviceMapping" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" }, "EbsOptimized":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instance is optimized for EBS I/O.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"AttributeValue", "locationName":"sriovNetSupport" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

The security groups associated with the instance.

", "locationName":"groupSet" } }, "documentation":"

Describes an instance attribute.

" }, "InstanceAttributeName":{ "type":"string", "enum":[ "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "rootDeviceName", "blockDeviceMapping", "productCodes", "sourceDestCheck", "groupSet", "ebsOptimized", "sriovNetSupport" ] }, "InstanceBlockDeviceMapping":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsInstanceBlockDevice", "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", "locationName":"ebs" } }, "documentation":"

Describes a block device mapping.

" }, "InstanceBlockDeviceMappingList":{ "type":"list", "member":{ "shape":"InstanceBlockDeviceMapping", "locationName":"item" } }, "InstanceBlockDeviceMappingSpecification":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsInstanceBlockDeviceSpecification", "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", "locationName":"ebs" }, "VirtualName":{ "shape":"String", "documentation":"

The virtual device name.

", "locationName":"virtualName" }, "NoDevice":{ "shape":"String", "documentation":"

suppress the specified device included in the block device mapping.

", "locationName":"noDevice" } }, "documentation":"

Describes a block device mapping entry.

" }, "InstanceBlockDeviceMappingSpecificationList":{ "type":"list", "member":{ "shape":"InstanceBlockDeviceMappingSpecification", "locationName":"item" } }, "InstanceCount":{ "type":"structure", "members":{ "State":{ "shape":"ListingState", "documentation":"

The states of the listed Reserved Instances.

", "locationName":"state" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of listed Reserved Instances in the state specified by the state.

", "locationName":"instanceCount" } }, "documentation":"

Describes a Reserved Instance listing state.

" }, "InstanceCountList":{ "type":"list", "member":{ "shape":"InstanceCount", "locationName":"item" } }, "InstanceExportDetails":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the resource being exported.

", "locationName":"instanceId" }, "TargetEnvironment":{ "shape":"ExportEnvironment", "documentation":"

The target virtualization environment.

", "locationName":"targetEnvironment" } }, "documentation":"

Describes an instance to export.

" }, "InstanceIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"InstanceId" } }, "InstanceLifecycleType":{ "type":"string", "enum":["spot"] }, "InstanceList":{ "type":"list", "member":{ "shape":"Instance", "locationName":"item" } }, "InstanceMonitoring":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Monitoring":{ "shape":"Monitoring", "documentation":"

The monitoring information.

", "locationName":"monitoring" } }, "documentation":"

Describes the monitoring information of the instance.

" }, "InstanceMonitoringList":{ "type":"list", "member":{ "shape":"InstanceMonitoring", "locationName":"item" } }, "InstanceNetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Description":{ "shape":"String", "documentation":"

The description.

", "locationName":"description" }, "OwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that created the network interface.

", "locationName":"ownerId" }, "Status":{ "shape":"NetworkInterfaceStatus", "documentation":"

The status of the network interface.

", "locationName":"status" }, "MacAddress":{ "shape":"String", "documentation":"

The MAC address.

", "locationName":"macAddress" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Indicates whether to validate network traffic to or from this network interface.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups.

", "locationName":"groupSet" }, "Attachment":{ "shape":"InstanceNetworkInterfaceAttachment", "documentation":"

The network interface attachment.

", "locationName":"attachment" }, "Association":{ "shape":"InstanceNetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP associated with the network interface.

", "locationName":"association" }, "PrivateIpAddresses":{ "shape":"InstancePrivateIpAddressList", "documentation":"

The private IP addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" } }, "documentation":"

Describes a network interface.

" }, "InstanceNetworkInterfaceAssociation":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The public IP address or Elastic IP address bound to the network interface.

", "locationName":"publicIp" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name.

", "locationName":"publicDnsName" }, "IpOwnerId":{ "shape":"String", "documentation":"

The ID of the owner of the Elastic IP address.

", "locationName":"ipOwnerId" } }, "documentation":"

Describes association information for an Elastic IP address.

" }, "InstanceNetworkInterfaceAttachment":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device on the instance for the network interface attachment.

", "locationName":"deviceIndex" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a network interface attachment.

" }, "InstanceNetworkInterfaceList":{ "type":"list", "member":{ "shape":"InstanceNetworkInterface", "locationName":"item" } }, "InstanceNetworkInterfaceSpecification":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

", "locationName":"deviceIndex" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

", "locationName":"subnetId" }, "Description":{ "shape":"String", "documentation":"

The description of the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"description" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"privateIpAddress" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"SecurityGroupId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

", "locationName":"deleteOnTermination" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", "documentation":"

One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.

", "locationName":"privateIpAddressesSet", "queryName":"PrivateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.

", "locationName":"secondaryPrivateIpAddressCount" }, "AssociatePublicIpAddress":{ "shape":"Boolean", "documentation":"

Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

", "locationName":"associatePublicIpAddress" } }, "documentation":"

Describes a network interface.

" }, "InstanceNetworkInterfaceSpecificationList":{ "type":"list", "member":{ "shape":"InstanceNetworkInterfaceSpecification", "locationName":"item" } }, "InstancePrivateIpAddress":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the network interface.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", "locationName":"primary" }, "Association":{ "shape":"InstanceNetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address for the network interface.

", "locationName":"association" } }, "documentation":"

Describes a private IP address.

" }, "InstancePrivateIpAddressList":{ "type":"list", "member":{ "shape":"InstancePrivateIpAddress", "locationName":"item" } }, "InstanceState":{ "type":"structure", "members":{ "Code":{ "shape":"Integer", "documentation":"

The low byte represents the state. The high byte is an opaque internal value and should be ignored.

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

", "locationName":"code" }, "Name":{ "shape":"InstanceStateName", "documentation":"

The current state of the instance.

", "locationName":"name" } }, "documentation":"

Describes the current state of the instance.

" }, "InstanceStateChange":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "CurrentState":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

", "locationName":"currentState" }, "PreviousState":{ "shape":"InstanceState", "documentation":"

The previous state of the instance.

", "locationName":"previousState" } }, "documentation":"

Describes an instance state change.

" }, "InstanceStateChangeList":{ "type":"list", "member":{ "shape":"InstanceStateChange", "locationName":"item" } }, "InstanceStateName":{ "type":"string", "enum":[ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ] }, "InstanceStatus":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the instance.

", "locationName":"availabilityZone" }, "Events":{ "shape":"InstanceStatusEventList", "documentation":"

Any scheduled events associated with the instance.

", "locationName":"eventsSet" }, "InstanceState":{ "shape":"InstanceState", "documentation":"

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

", "locationName":"instanceState" }, "SystemStatus":{ "shape":"InstanceStatusSummary", "documentation":"

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

", "locationName":"systemStatus" }, "InstanceStatus":{ "shape":"InstanceStatusSummary", "documentation":"

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

", "locationName":"instanceStatus" } }, "documentation":"

Describes the status of an instance.

" }, "InstanceStatusDetails":{ "type":"structure", "members":{ "Name":{ "shape":"StatusName", "documentation":"

The type of instance status.

", "locationName":"name" }, "Status":{ "shape":"StatusType", "documentation":"

The status.

", "locationName":"status" }, "ImpairedSince":{ "shape":"DateTime", "documentation":"

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

", "locationName":"impairedSince" } }, "documentation":"

Describes the instance status.

" }, "InstanceStatusDetailsList":{ "type":"list", "member":{ "shape":"InstanceStatusDetails", "locationName":"item" } }, "InstanceStatusEvent":{ "type":"structure", "members":{ "Code":{ "shape":"EventCode", "documentation":"

The event code.

", "locationName":"code" }, "Description":{ "shape":"String", "documentation":"

A description of the event.

After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].

", "locationName":"description" }, "NotBefore":{ "shape":"DateTime", "documentation":"

The earliest scheduled start time for the event.

", "locationName":"notBefore" }, "NotAfter":{ "shape":"DateTime", "documentation":"

The latest scheduled end time for the event.

", "locationName":"notAfter" } }, "documentation":"

Describes a scheduled event for an instance.

" }, "InstanceStatusEventList":{ "type":"list", "member":{ "shape":"InstanceStatusEvent", "locationName":"item" } }, "InstanceStatusList":{ "type":"list", "member":{ "shape":"InstanceStatus", "locationName":"item" } }, "InstanceStatusSummary":{ "type":"structure", "members":{ "Status":{ "shape":"SummaryStatus", "documentation":"

The status.

", "locationName":"status" }, "Details":{ "shape":"InstanceStatusDetailsList", "documentation":"

The system instance health or application instance health.

", "locationName":"details" } }, "documentation":"

Describes the status of an instance.

" }, "InstanceType":{ "type":"string", "enum":[ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "t2.micro", "t2.small", "t2.medium", "t2.large", "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", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge" ] }, "InstanceTypeList":{ "type":"list", "member":{"shape":"InstanceType"} }, "Integer":{"type":"integer"}, "InternetGateway":{ "type":"structure", "members":{ "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "Attachments":{ "shape":"InternetGatewayAttachmentList", "documentation":"

Any VPCs attached to the Internet gateway.

", "locationName":"attachmentSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the Internet gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes an Internet gateway.

" }, "InternetGatewayAttachment":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"AttachmentStatus", "documentation":"

The current state of the attachment.

", "locationName":"state" } }, "documentation":"

Describes the attachment of a VPC to an Internet gateway.

" }, "InternetGatewayAttachmentList":{ "type":"list", "member":{ "shape":"InternetGatewayAttachment", "locationName":"item" } }, "InternetGatewayList":{ "type":"list", "member":{ "shape":"InternetGateway", "locationName":"item" } }, "IpPermission":{ "type":"structure", "members":{ "IpProtocol":{ "shape":"String", "documentation":"

The protocol.

When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers. (VPC only) When you call AuthorizeSecurityGroupIngress, you can use -1 to specify all.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

", "locationName":"toPort" }, "UserIdGroupPairs":{ "shape":"UserIdGroupPairList", "documentation":"

One or more security group and AWS account ID pairs.

", "locationName":"groups" }, "IpRanges":{ "shape":"IpRangeList", "documentation":"

One or more IP ranges.

", "locationName":"ipRanges" }, "PrefixListIds":{ "shape":"PrefixListIdList", "documentation":"

(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

", "locationName":"prefixListIds" } }, "documentation":"

Describes a security group rule.

" }, "IpPermissionList":{ "type":"list", "member":{ "shape":"IpPermission", "locationName":"item" } }, "IpRange":{ "type":"structure", "members":{ "CidrIp":{ "shape":"String", "documentation":"

The CIDR range. You can either specify a CIDR range or a source security group, not both.

", "locationName":"cidrIp" } }, "documentation":"

Describes an IP range.

" }, "IpRangeList":{ "type":"list", "member":{ "shape":"IpRange", "locationName":"item" } }, "KeyNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"KeyName" } }, "KeyPair":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

The SHA-1 digest of the DER encoded private key.

", "locationName":"keyFingerprint" }, "KeyMaterial":{ "shape":"String", "documentation":"

An unencrypted PEM encoded RSA private key.

", "locationName":"keyMaterial" } }, "documentation":"

Describes a key pair.

" }, "KeyPairInfo":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", "locationName":"keyFingerprint" } }, "documentation":"

Describes a key pair.

" }, "KeyPairList":{ "type":"list", "member":{ "shape":"KeyPairInfo", "locationName":"item" } }, "LaunchPermission":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The AWS account ID.

", "locationName":"userId" }, "Group":{ "shape":"PermissionGroup", "documentation":"

The name of the group.

", "locationName":"group" } }, "documentation":"

Describes a launch permission.

" }, "LaunchPermissionList":{ "type":"list", "member":{ "shape":"LaunchPermission", "locationName":"item" } }, "LaunchPermissionModifications":{ "type":"structure", "members":{ "Add":{ "shape":"LaunchPermissionList", "documentation":"

The AWS account ID to add to the list of launch permissions for the AMI.

" }, "Remove":{ "shape":"LaunchPermissionList", "documentation":"

The AWS account ID to remove from the list of launch permissions for the AMI.

" } }, "documentation":"

Describes a launch permission modification.

" }, "LaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups. To request an instance in a nondefault VPC, you must specify the ID of the security group. To request an instance in EC2-Classic or a default VPC, you can specify the name or the ID of the security group.

", "locationName":"groupSet" }, "UserData":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" } }, "documentation":"

Describes the launch specification for an instance.

" }, "LaunchSpecsList":{ "type":"list", "member":{ "shape":"SpotFleetLaunchSpecification", "locationName":"item" }, "min":1 }, "ListingState":{ "type":"string", "enum":[ "available", "sold", "cancelled", "pending" ] }, "ListingStatus":{ "type":"string", "enum":[ "active", "pending", "cancelled", "closed" ] }, "Long":{"type":"long"}, "ModifyImageAttributeRequest":{ "type":"structure", "required":["ImageId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"String", "documentation":"

The name of the attribute to modify.

" }, "OperationType":{ "shape":"OperationType", "documentation":"

The operation type.

" }, "UserIds":{ "shape":"UserIdStringList", "documentation":"

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

", "locationName":"UserId" }, "UserGroups":{ "shape":"UserGroupStringList", "documentation":"

One or more user groups. This is only valid when modifying the launchPermission attribute.

", "locationName":"UserGroup" }, "ProductCodes":{ "shape":"ProductCodeStringList", "documentation":"

One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

", "locationName":"ProductCode" }, "Value":{ "shape":"String", "documentation":"

The value of the attribute being modified. This is only valid when modifying the description attribute.

" }, "LaunchPermission":{ "shape":"LaunchPermissionModifications", "documentation":"

A launch permission modification.

" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the AMI.

" } } }, "ModifyInstanceAttributeRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The name of the attribute.

", "locationName":"attribute" }, "Value":{ "shape":"String", "documentation":"

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

", "locationName":"value" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingSpecificationList", "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"blockDeviceMapping" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

" }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", "documentation":"

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this paramater for Spot Instances.

", "locationName":"disableApiTermination" }, "InstanceType":{ "shape":"AttributeValue", "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", "locationName":"instanceType" }, "Kernel":{ "shape":"AttributeValue", "documentation":"

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", "locationName":"kernel" }, "Ramdisk":{ "shape":"AttributeValue", "documentation":"

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", "locationName":"ramdisk" }, "UserData":{ "shape":"BlobAttributeValue", "documentation":"

Changes the instance's user data to the specified value.

", "locationName":"userData" }, "InstanceInitiatedShutdownBehavior":{ "shape":"AttributeValue", "documentation":"

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "Groups":{ "shape":"GroupIdStringList", "documentation":"

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

", "locationName":"GroupId" }, "EbsOptimized":{ "shape":"AttributeBooleanValue", "documentation":"

Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"AttributeValue", "documentation":"

Set to simple to enable enhanced networking for the instance.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", "locationName":"sriovNetSupport" } } }, "ModifyNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the network interface.

", "locationName":"description" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", "locationName":"SecurityGroupId" }, "Attachment":{ "shape":"NetworkInterfaceAttachmentChanges", "documentation":"

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

", "locationName":"attachment" } } }, "ModifyReservedInstancesRequest":{ "type":"structure", "required":[ "ReservedInstancesIds", "TargetConfigurations" ], "members":{ "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" }, "ReservedInstancesIds":{ "shape":"ReservedInstancesIdStringList", "documentation":"

The IDs of the Reserved Instances to modify.

", "locationName":"ReservedInstancesId" }, "TargetConfigurations":{ "shape":"ReservedInstancesConfigurationList", "documentation":"

The configuration settings for the Reserved Instances to modify.

", "locationName":"ReservedInstancesConfigurationSetItemType" } } }, "ModifyReservedInstancesResult":{ "type":"structure", "members":{ "ReservedInstancesModificationId":{ "shape":"String", "documentation":"

The ID for the modification.

", "locationName":"reservedInstancesModificationId" } } }, "ModifySnapshotAttributeRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The snapshot attribute to modify.

Only volume creation permissions may be modified at the customer level.

" }, "OperationType":{ "shape":"OperationType", "documentation":"

The type of operation to perform to the attribute.

" }, "UserIds":{ "shape":"UserIdStringList", "documentation":"

The account ID to modify for the snapshot.

", "locationName":"UserId" }, "GroupNames":{ "shape":"GroupNameStringList", "documentation":"

The group to modify for the snapshot.

", "locationName":"UserGroup" }, "CreateVolumePermission":{ "shape":"CreateVolumePermissionModifications", "documentation":"

A JSON representation of the snapshot attribute modification.

" } } }, "ModifySubnetAttributeRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "MapPublicIpOnLaunch":{ "shape":"AttributeBooleanValue", "documentation":"

Specify true to indicate that instances launched into the specified subnet should be assigned public IP address.

" } } }, "ModifyVolumeAttributeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "AutoEnableIO":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the volume should be auto-enabled for I/O operations.

" } } }, "ModifyVpcAttributeRequest":{ "type":"structure", "required":["VpcId"], "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "EnableDnsSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

" }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You can only enable DNS hostnames if you also enable DNS support.

" } } }, "ModifyVpcEndpointRequest":{ "type":"structure", "required":["VpcEndpointId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" }, "VpcEndpointId":{ "shape":"String", "documentation":"

The ID of the endpoint.

" }, "ResetPolicy":{ "shape":"Boolean", "documentation":"

Specify true to reset the policy document to the default policy. The default policy allows access to the service.

" }, "PolicyDocument":{ "shape":"String", "documentation":"

A policy document to attach to the endpoint. The policy must be in valid JSON format.

" }, "AddRouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route tables IDs to associate with the endpoint.

", "locationName":"AddRouteTableId" }, "RemoveRouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs to disassociate from the endpoint.

", "locationName":"RemoveRouteTableId" } } }, "ModifyVpcEndpointResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "MonitorInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } } }, "MonitorInstancesResult":{ "type":"structure", "members":{ "InstanceMonitorings":{ "shape":"InstanceMonitoringList", "documentation":"

Monitoring information for one or more instances.

", "locationName":"instancesSet" } } }, "Monitoring":{ "type":"structure", "members":{ "State":{ "shape":"MonitoringState", "documentation":"

Indicates whether monitoring is enabled for the instance.

", "locationName":"state" } }, "documentation":"

Describes the monitoring for the instance.

" }, "MonitoringState":{ "type":"string", "enum":[ "disabled", "disabling", "enabled", "pending" ] }, "MoveAddressToVpcRequest":{ "type":"structure", "required":["PublicIp"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" } } }, "MoveAddressToVpcResult":{ "type":"structure", "members":{ "AllocationId":{ "shape":"String", "documentation":"

The allocation ID for the Elastic IP address.

", "locationName":"allocationId" }, "Status":{ "shape":"Status", "documentation":"

The status of the move of the IP address.

", "locationName":"status" } } }, "MoveStatus":{ "type":"string", "enum":[ "movingToVpc", "restoringToClassic" ] }, "MovingAddressStatus":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "MoveStatus":{ "shape":"MoveStatus", "documentation":"

The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.

", "locationName":"moveStatus" } }, "documentation":"

Describes the status of a moving Elastic IP address.

" }, "MovingAddressStatusSet":{ "type":"list", "member":{ "shape":"MovingAddressStatus", "locationName":"item" } }, "NetworkAcl":{ "type":"structure", "members":{ "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for the network ACL.

", "locationName":"vpcId" }, "IsDefault":{ "shape":"Boolean", "documentation":"

Indicates whether this is the default network ACL for the VPC.

", "locationName":"default" }, "Entries":{ "shape":"NetworkAclEntryList", "documentation":"

One or more entries (rules) in the network ACL.

", "locationName":"entrySet" }, "Associations":{ "shape":"NetworkAclAssociationList", "documentation":"

Any associations between the network ACL and one or more subnets

", "locationName":"associationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the network ACL.

", "locationName":"tagSet" } }, "documentation":"

Describes a network ACL.

" }, "NetworkAclAssociation":{ "type":"structure", "members":{ "NetworkAclAssociationId":{ "shape":"String", "documentation":"

The ID of the association between a network ACL and a subnet.

", "locationName":"networkAclAssociationId" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" } }, "documentation":"

Describes an association between a network ACL and a subnet.

" }, "NetworkAclAssociationList":{ "type":"list", "member":{ "shape":"NetworkAclAssociation", "locationName":"item" } }, "NetworkAclEntry":{ "type":"structure", "members":{ "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The protocol. A value of -1 means all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation.

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code.

", "locationName":"icmpTypeCode" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", "locationName":"portRange" } }, "documentation":"

Describes an entry in a network ACL.

" }, "NetworkAclEntryList":{ "type":"list", "member":{ "shape":"NetworkAclEntry", "locationName":"item" } }, "NetworkAclList":{ "type":"list", "member":{ "shape":"NetworkAcl", "locationName":"item" } }, "NetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "Description":{ "shape":"String", "documentation":"

A description.

", "locationName":"description" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the network interface.

", "locationName":"ownerId" }, "RequesterId":{ "shape":"String", "documentation":"

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", "locationName":"requesterId" }, "RequesterManaged":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is being managed by AWS.

", "locationName":"requesterManaged" }, "Status":{ "shape":"NetworkInterfaceStatus", "documentation":"

The status of the network interface.

", "locationName":"status" }, "MacAddress":{ "shape":"String", "documentation":"

The MAC address.

", "locationName":"macAddress" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Indicates whether traffic to or from the instance is validated.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

Any security groups for the network interface.

", "locationName":"groupSet" }, "Attachment":{ "shape":"NetworkInterfaceAttachment", "documentation":"

The network interface attachment.

", "locationName":"attachment" }, "Association":{ "shape":"NetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP associated with the network interface.

", "locationName":"association" }, "TagSet":{ "shape":"TagList", "documentation":"

Any tags assigned to the network interface.

", "locationName":"tagSet" }, "PrivateIpAddresses":{ "shape":"NetworkInterfacePrivateIpAddressList", "documentation":"

The private IP addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" } }, "documentation":"

Describes a network interface.

" }, "NetworkInterfaceAssociation":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The address of the Elastic IP address bound to the network interface.

", "locationName":"publicIp" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name.

", "locationName":"publicDnsName" }, "IpOwnerId":{ "shape":"String", "documentation":"

The ID of the Elastic IP address owner.

", "locationName":"ipOwnerId" }, "AllocationId":{ "shape":"String", "documentation":"

The allocation ID.

", "locationName":"allocationId" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID.

", "locationName":"associationId" } }, "documentation":"

Describes association information for an Elastic IP address.

" }, "NetworkInterfaceAttachment":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "InstanceOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the instance.

", "locationName":"instanceOwnerId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The device index of the network interface attachment on the instance.

", "locationName":"deviceIndex" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The timestamp indicating when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a network interface attachment.

" }, "NetworkInterfaceAttachmentChanges":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes an attachment change.

" }, "NetworkInterfaceAttribute":{ "type":"string", "enum":[ "description", "groupSet", "sourceDestCheck", "attachment" ] }, "NetworkInterfaceIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "NetworkInterfaceList":{ "type":"list", "member":{ "shape":"NetworkInterface", "locationName":"item" } }, "NetworkInterfacePrivateIpAddress":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", "locationName":"primary" }, "Association":{ "shape":"NetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address associated with the network interface.

", "locationName":"association" } }, "documentation":"

Describes the private IP address of a network interface.

" }, "NetworkInterfacePrivateIpAddressList":{ "type":"list", "member":{ "shape":"NetworkInterfacePrivateIpAddress", "locationName":"item" } }, "NetworkInterfaceStatus":{ "type":"string", "enum":[ "available", "attaching", "in-use", "detaching" ] }, "OfferingTypeValues":{ "type":"string", "enum":[ "Heavy Utilization", "Medium Utilization", "Light Utilization", "No Upfront", "Partial Upfront", "All Upfront" ] }, "OperationType":{ "type":"string", "enum":[ "add", "remove" ] }, "OwnerStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"Owner" } }, "PermissionGroup":{ "type":"string", "enum":["all"] }, "Placement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the instance.

", "locationName":"availabilityZone" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group the instance is in (for cluster compute instances).

", "locationName":"groupName" }, "Tenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

", "locationName":"tenancy" } }, "documentation":"

Describes the placement for the instance.

" }, "PlacementGroup":{ "type":"structure", "members":{ "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"

The placement strategy.

", "locationName":"strategy" }, "State":{ "shape":"PlacementGroupState", "documentation":"

The state of the placement group.

", "locationName":"state" } }, "documentation":"

Describes a placement group.

" }, "PlacementGroupList":{ "type":"list", "member":{ "shape":"PlacementGroup", "locationName":"item" } }, "PlacementGroupState":{ "type":"string", "enum":[ "pending", "available", "deleting", "deleted" ] }, "PlacementGroupStringList":{ "type":"list", "member":{"shape":"String"} }, "PlacementStrategy":{ "type":"string", "enum":["cluster"] }, "PlatformValues":{ "type":"string", "enum":["Windows"] }, "PortRange":{ "type":"structure", "members":{ "From":{ "shape":"Integer", "documentation":"

The first port in the range.

", "locationName":"from" }, "To":{ "shape":"Integer", "documentation":"

The last port in the range.

", "locationName":"to" } }, "documentation":"

Describes a range of ports.

" }, "PrefixList":{ "type":"structure", "members":{ "PrefixListId":{ "shape":"String", "documentation":"

The ID of the prefix.

", "locationName":"prefixListId" }, "PrefixListName":{ "shape":"String", "documentation":"

The name of the prefix.

", "locationName":"prefixListName" }, "Cidrs":{ "shape":"ValueStringList", "documentation":"

The IP address range of the AWS service.

", "locationName":"cidrSet" } }, "documentation":"

Describes prefixes for AWS services.

" }, "PrefixListId":{ "type":"structure", "members":{ "PrefixListId":{ "shape":"String", "documentation":"

The ID of the prefix.

", "locationName":"prefixListId" } }, "documentation":"

The ID of the prefix.

" }, "PrefixListIdList":{ "type":"list", "member":{ "shape":"PrefixListId", "locationName":"item" } }, "PrefixListSet":{ "type":"list", "member":{ "shape":"PrefixList", "locationName":"item" } }, "PriceSchedule":{ "type":"structure", "members":{ "Term":{ "shape":"Long", "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"

The fixed price for the term.

", "locationName":"price" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "Active":{ "shape":"Boolean", "documentation":"

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", "locationName":"active" } }, "documentation":"

Describes the price for a Reserved Instance.

" }, "PriceScheduleList":{ "type":"list", "member":{ "shape":"PriceSchedule", "locationName":"item" } }, "PriceScheduleSpecification":{ "type":"structure", "members":{ "Term":{ "shape":"Long", "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"

The fixed price for the term.

", "locationName":"price" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } }, "documentation":"

Describes the price for a Reserved Instance.

" }, "PriceScheduleSpecificationList":{ "type":"list", "member":{ "shape":"PriceScheduleSpecification", "locationName":"item" } }, "PricingDetail":{ "type":"structure", "members":{ "Price":{ "shape":"Double", "documentation":"

The price per instance.

", "locationName":"price" }, "Count":{ "shape":"Integer", "documentation":"

The number of instances available for the price.

", "locationName":"count" } }, "documentation":"

Describes a Reserved Instance offering.

" }, "PricingDetailsList":{ "type":"list", "member":{ "shape":"PricingDetail", "locationName":"item" } }, "PrivateIpAddressSpecification":{ "type":"structure", "required":["PrivateIpAddress"], "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP addresses.

", "locationName":"privateIpAddress" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

", "locationName":"primary" } }, "documentation":"

Describes a secondary private IP address for a network interface.

" }, "PrivateIpAddressSpecificationList":{ "type":"list", "member":{ "shape":"PrivateIpAddressSpecification", "locationName":"item" } }, "PrivateIpAddressStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"PrivateIpAddress" } }, "ProductCode":{ "type":"structure", "members":{ "ProductCodeId":{ "shape":"String", "documentation":"

The product code.

", "locationName":"productCode" }, "ProductCodeType":{ "shape":"ProductCodeValues", "documentation":"

The type of product code.

", "locationName":"type" } }, "documentation":"

Describes a product code.

" }, "ProductCodeList":{ "type":"list", "member":{ "shape":"ProductCode", "locationName":"item" } }, "ProductCodeStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ProductCode" } }, "ProductCodeValues":{ "type":"string", "enum":[ "devpay", "marketplace" ] }, "ProductDescriptionList":{ "type":"list", "member":{"shape":"String"} }, "PropagatingVgw":{ "type":"structure", "members":{ "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway (VGW).

", "locationName":"gatewayId" } }, "documentation":"

Describes a virtual private gateway propagating route.

" }, "PropagatingVgwList":{ "type":"list", "member":{ "shape":"PropagatingVgw", "locationName":"item" } }, "PublicIpStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"PublicIp" } }, "PurchaseReservedInstancesOfferingRequest":{ "type":"structure", "required":[ "ReservedInstancesOfferingId", "InstanceCount" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance offering to purchase.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of Reserved Instances to purchase.

" }, "LimitPrice":{ "shape":"ReservedInstanceLimitPrice", "documentation":"

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", "locationName":"limitPrice" } } }, "PurchaseReservedInstancesOfferingResult":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The IDs of the purchased Reserved Instances.

", "locationName":"reservedInstancesId" } } }, "RIProductDescription":{ "type":"string", "enum":[ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ] }, "ReasonCodesList":{ "type":"list", "member":{ "shape":"ReportInstanceReasonCodes", "locationName":"item" } }, "RebootInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } } }, "RecurringCharge":{ "type":"structure", "members":{ "Frequency":{ "shape":"RecurringChargeFrequency", "documentation":"

The frequency of the recurring charge.

", "locationName":"frequency" }, "Amount":{ "shape":"Double", "documentation":"

The amount of the recurring charge.

", "locationName":"amount" } }, "documentation":"

Describes a recurring charge.

" }, "RecurringChargeFrequency":{ "type":"string", "enum":["Hourly"] }, "RecurringChargesList":{ "type":"list", "member":{ "shape":"RecurringCharge", "locationName":"item" } }, "Region":{ "type":"structure", "members":{ "RegionName":{ "shape":"String", "documentation":"

The name of the region.

", "locationName":"regionName" }, "Endpoint":{ "shape":"String", "documentation":"

The region service endpoint.

", "locationName":"regionEndpoint" } }, "documentation":"

Describes a region.

" }, "RegionList":{ "type":"list", "member":{ "shape":"Region", "locationName":"item" } }, "RegionNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"RegionName" } }, "RegisterImageRequest":{ "type":"structure", "required":["Name"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageLocation":{ "shape":"String", "documentation":"

The full path to your AMI manifest in Amazon S3 storage.

" }, "Name":{ "shape":"String", "documentation":"

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

A description for your AMI.

", "locationName":"description" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

", "locationName":"architecture" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "RootDeviceName":{ "shape":"String", "documentation":"

The name of the root device (for example, /dev/sda1, or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

One or more block device mapping entries.

", "locationName":"BlockDeviceMapping" }, "VirtualizationType":{ "shape":"String", "documentation":"

The type of virtualization.

Default: paravirtual

", "locationName":"virtualizationType" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Set to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", "locationName":"sriovNetSupport" } } }, "RegisterImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the newly registered AMI.

", "locationName":"imageId" } } }, "RejectVpcPeeringConnectionRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "RejectVpcPeeringConnectionResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "ReleaseAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" } } }, "ReplaceNetworkAclAssociationRequest":{ "type":"structure", "required":[ "AssociationId", "NetworkAclId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The ID of the current association between the original network ACL and the subnet.

", "locationName":"associationId" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the new network ACL to associate with the subnet.

", "locationName":"networkAclId" } } }, "ReplaceNetworkAclAssociationResult":{ "type":"structure", "members":{ "NewAssociationId":{ "shape":"String", "documentation":"

The ID of the new association.

", "locationName":"newAssociationId" } } }, "ReplaceNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Protocol", "RuleAction", "Egress", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number of the entry to replace.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The IP protocol. You can specify all or -1 to mean all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation.

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.

", "locationName":"Icmp" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.

", "locationName":"portRange" } } }, "ReplaceRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of an Internet gateway or virtual private gateway.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC.

", "locationName":"instanceId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of a network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of a VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "ReplaceRouteTableAssociationRequest":{ "type":"structure", "required":[ "AssociationId", "RouteTableId" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID.

", "locationName":"associationId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the new route table to associate with the subnet.

", "locationName":"routeTableId" } } }, "ReplaceRouteTableAssociationResult":{ "type":"structure", "members":{ "NewAssociationId":{ "shape":"String", "documentation":"

The ID of the new association.

", "locationName":"newAssociationId" } } }, "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" ] }, "ReportInstanceStatusRequest":{ "type":"structure", "required":[ "Instances", "Status", "ReasonCodes" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "Instances":{ "shape":"InstanceIdStringList", "documentation":"

One or more instances.

", "locationName":"instanceId" }, "Status":{ "shape":"ReportStatusType", "documentation":"

The status of all instances listed.

", "locationName":"status" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time at which the reported instance health state began.

", "locationName":"startTime" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time at which the reported instance health state ended.

", "locationName":"endTime" }, "ReasonCodes":{ "shape":"ReasonCodesList", "documentation":"

One or more reason codes that describes the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems which I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

", "locationName":"reasonCode" }, "Description":{ "shape":"String", "documentation":"

Descriptive text about the health state of your instance.

", "locationName":"description" } } }, "ReportStatusType":{ "type":"string", "enum":[ "ok", "impaired" ] }, "RequestSpotFleetRequest":{ "type":"structure", "required":["SpotFleetRequestConfig"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotFleetRequestConfig":{ "shape":"SpotFleetRequestConfigData", "documentation":"

The configuration for the Spot fleet request.

", "locationName":"spotFleetRequestConfig" } }, "documentation":"

Contains the parameters for RequestSpotFleet.

" }, "RequestSpotFleetResponse":{ "type":"structure", "required":["SpotFleetRequestId"], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" } }, "documentation":"

Contains the output of RequestSpotFleet.

" }, "RequestSpotInstancesRequest":{ "type":"structure", "required":["SpotPrice"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum hourly price (bid) for any Spot instance launched to fulfill the request.

", "locationName":"spotPrice" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"clientToken" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The maximum number of Spot instances to launch.

Default: 1

", "locationName":"instanceCount" }, "Type":{ "shape":"SpotInstanceType", "documentation":"

The Spot instance request type.

Default: one-time

", "locationName":"type" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

Default: The request is effective indefinitely.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

Default: The request is effective indefinitely.

", "locationName":"validUntil" }, "LaunchGroup":{ "shape":"String", "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

Default: Instances are launched and terminated individually

", "locationName":"launchGroup" }, "AvailabilityZoneGroup":{ "shape":"String", "documentation":"

The user-specified name for a logical grouping of bids.

When you specify an Availability Zone group in a Spot Instance request, all Spot instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", "locationName":"availabilityZoneGroup" }, "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} }, "documentation":"

Contains the parameters for RequestSpotInstances.

" }, "RequestSpotInstancesResult":{ "type":"structure", "members":{ "SpotInstanceRequests":{ "shape":"SpotInstanceRequestList", "documentation":"

One or more Spot instance requests.

", "locationName":"spotInstanceRequestSet" } }, "documentation":"

Contains the output of RequestSpotInstances.

" }, "Reservation":{ "type":"structure", "members":{ "ReservationId":{ "shape":"String", "documentation":"

The ID of the reservation.

", "locationName":"reservationId" }, "OwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that owns the reservation.

", "locationName":"ownerId" }, "RequesterId":{ "shape":"String", "documentation":"

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

", "locationName":"requesterId" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups.

", "locationName":"groupSet" }, "Instances":{ "shape":"InstanceList", "documentation":"

One or more instances.

", "locationName":"instancesSet" } }, "documentation":"

Describes a reservation.

" }, "ReservationList":{ "type":"list", "member":{ "shape":"Reservation", "locationName":"item" } }, "ReservedInstanceLimitPrice":{ "type":"structure", "members":{ "Amount":{ "shape":"Double", "documentation":"

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", "locationName":"amount" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } }, "documentation":"

Describes the limit price of a Reserved Instance offering.

" }, "ReservedInstanceState":{ "type":"string", "enum":[ "payment-pending", "active", "payment-failed", "retired" ] }, "ReservedInstances":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used.

", "locationName":"instanceType" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", "locationName":"availabilityZone" }, "Start":{ "shape":"DateTime", "documentation":"

The date and time the Reserved Instance started.

", "locationName":"start" }, "End":{ "shape":"DateTime", "documentation":"

The time when the Reserved Instance expires.

", "locationName":"end" }, "Duration":{ "shape":"Long", "documentation":"

The duration of the Reserved Instance, in seconds.

", "locationName":"duration" }, "UsagePrice":{ "shape":"Float", "documentation":"

The usage price of the Reserved Instance, per hour.

", "locationName":"usagePrice" }, "FixedPrice":{ "shape":"Float", "documentation":"

The purchase price of the Reserved Instance.

", "locationName":"fixedPrice" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of Reserved Instances purchased.

", "locationName":"instanceCount" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance product platform description.

", "locationName":"productDescription" }, "State":{ "shape":"ReservedInstanceState", "documentation":"

The state of the Reserved Instance purchase.

", "locationName":"state" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the reserved instance.

", "locationName":"instanceTenancy" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type.

", "locationName":"offeringType" }, "RecurringCharges":{ "shape":"RecurringChargesList", "documentation":"

The recurring charge tag assigned to the resource.

", "locationName":"recurringCharges" } }, "documentation":"

Describes a Reserved Instance.

" }, "ReservedInstancesConfiguration":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the modified Reserved Instances.

", "locationName":"availabilityZone" }, "Platform":{ "shape":"String", "documentation":"

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", "locationName":"platform" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of modified Reserved Instances.

", "locationName":"instanceCount" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type for the modified Reserved Instances.

", "locationName":"instanceType" } }, "documentation":"

Describes the configuration settings for the modified Reserved Instances.

" }, "ReservedInstancesConfigurationList":{ "type":"list", "member":{ "shape":"ReservedInstancesConfiguration", "locationName":"item" } }, "ReservedInstancesId":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" } }, "documentation":"

Describes the ID of a Reserved Instance.

" }, "ReservedInstancesIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstancesId" } }, "ReservedInstancesList":{ "type":"list", "member":{ "shape":"ReservedInstances", "locationName":"item" } }, "ReservedInstancesListing":{ "type":"structure", "members":{ "ReservedInstancesListingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance listing.

", "locationName":"reservedInstancesListingId" }, "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The time the listing was created.

", "locationName":"createDate" }, "UpdateDate":{ "shape":"DateTime", "documentation":"

The last modified timestamp of the listing.

", "locationName":"updateDate" }, "Status":{ "shape":"ListingStatus", "documentation":"

The status of the Reserved Instance listing.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The reason for the current status of the Reserved Instance listing. The response can be blank.

", "locationName":"statusMessage" }, "InstanceCounts":{ "shape":"InstanceCountList", "documentation":"

The number of instances in this state.

", "locationName":"instanceCounts" }, "PriceSchedules":{ "shape":"PriceScheduleList", "documentation":"

The price of the Reserved Instance listing.

", "locationName":"priceSchedules" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Describes a Reserved Instance listing.

" }, "ReservedInstancesListingList":{ "type":"list", "member":{ "shape":"ReservedInstancesListing", "locationName":"item" } }, "ReservedInstancesModification":{ "type":"structure", "members":{ "ReservedInstancesModificationId":{ "shape":"String", "documentation":"

A unique ID for the Reserved Instance modification.

", "locationName":"reservedInstancesModificationId" }, "ReservedInstancesIds":{ "shape":"ReservedIntancesIds", "documentation":"

The IDs of one or more Reserved Instances.

", "locationName":"reservedInstancesSet" }, "ModificationResults":{ "shape":"ReservedInstancesModificationResultList", "documentation":"

Contains target configurations along with their corresponding new Reserved Instance IDs.

", "locationName":"modificationResultSet" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The time when the modification request was created.

", "locationName":"createDate" }, "UpdateDate":{ "shape":"DateTime", "documentation":"

The time when the modification request was last updated.

", "locationName":"updateDate" }, "EffectiveDate":{ "shape":"DateTime", "documentation":"

The time for the modification to become effective.

", "locationName":"effectiveDate" }, "Status":{ "shape":"String", "documentation":"

The status of the Reserved Instances modification request.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The reason for the status.

", "locationName":"statusMessage" }, "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Describes a Reserved Instance modification.

" }, "ReservedInstancesModificationIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstancesModificationId" } }, "ReservedInstancesModificationList":{ "type":"list", "member":{ "shape":"ReservedInstancesModification", "locationName":"item" } }, "ReservedInstancesModificationResult":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", "locationName":"reservedInstancesId" }, "TargetConfiguration":{ "shape":"ReservedInstancesConfiguration", "documentation":"

The target Reserved Instances configurations supplied as part of the modification request.

", "locationName":"targetConfiguration" } } }, "ReservedInstancesModificationResultList":{ "type":"list", "member":{ "shape":"ReservedInstancesModificationResult", "locationName":"item" } }, "ReservedInstancesOffering":{ "type":"structure", "members":{ "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance offering.

", "locationName":"reservedInstancesOfferingId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used.

", "locationName":"instanceType" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", "locationName":"availabilityZone" }, "Duration":{ "shape":"Long", "documentation":"

The duration of the Reserved Instance, in seconds.

", "locationName":"duration" }, "UsagePrice":{ "shape":"Float", "documentation":"

The usage price of the Reserved Instance, per hour.

", "locationName":"usagePrice" }, "FixedPrice":{ "shape":"Float", "documentation":"

The purchase price of the Reserved Instance.

", "locationName":"fixedPrice" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance product platform description.

", "locationName":"productDescription" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the reserved instance.

", "locationName":"instanceTenancy" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type.

", "locationName":"offeringType" }, "RecurringCharges":{ "shape":"RecurringChargesList", "documentation":"

The recurring charge tag assigned to the resource.

", "locationName":"recurringCharges" }, "Marketplace":{ "shape":"Boolean", "documentation":"

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

", "locationName":"marketplace" }, "PricingDetails":{ "shape":"PricingDetailsList", "documentation":"

The pricing details of the Reserved Instance offering.

", "locationName":"pricingDetailsSet" } }, "documentation":"

Describes a Reserved Instance offering.

" }, "ReservedInstancesOfferingIdStringList":{ "type":"list", "member":{"shape":"String"} }, "ReservedInstancesOfferingList":{ "type":"list", "member":{ "shape":"ReservedInstancesOffering", "locationName":"item" } }, "ReservedIntancesIds":{ "type":"list", "member":{ "shape":"ReservedInstancesId", "locationName":"item" } }, "ResetImageAttributeName":{ "type":"string", "enum":["launchPermission"] }, "ResetImageAttributeRequest":{ "type":"structure", "required":[ "ImageId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"ResetImageAttributeName", "documentation":"

The attribute to reset (currently you can only reset the launch permission attribute).

" } } }, "ResetInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The attribute to reset.

", "locationName":"attribute" } } }, "ResetNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SourceDestCheck":{ "shape":"String", "documentation":"

The source/destination checking attribute. Resets the value to true.

", "locationName":"sourceDestCheck" } } }, "ResetSnapshotAttributeRequest":{ "type":"structure", "required":[ "SnapshotId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.

" } } }, "ResourceIdList":{ "type":"list", "member":{"shape":"String"} }, "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" ] }, "RestorableByStringList":{ "type":"list", "member":{"shape":"String"} }, "RestoreAddressToClassicRequest":{ "type":"structure", "required":["PublicIp"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" } } }, "RestoreAddressToClassicResult":{ "type":"structure", "members":{ "Status":{ "shape":"Status", "documentation":"

The move status for the IP address.

", "locationName":"status" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" } } }, "RevokeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

The name of a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account number for a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

", "locationName":"toPort" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

", "locationName":"cidrIp" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"ipPermissions" } } }, "RevokeSecurityGroupIngressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a security group in a nondefault VPC.

" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC.

" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The AWS account ID of the source security group. For EC2-VPC, the source security group must be in the same VPC. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" } } }, "Route":{ "type":"structure", "members":{ "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block used for the destination match.

", "locationName":"destinationCidrBlock" }, "DestinationPrefixListId":{ "shape":"String", "documentation":"

The prefix of the AWS service.

", "locationName":"destinationPrefixListId" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of a gateway attached to your VPC.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC.

", "locationName":"instanceId" }, "InstanceOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the instance.

", "locationName":"instanceOwnerId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" }, "State":{ "shape":"RouteState", "documentation":"

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

", "locationName":"state" }, "Origin":{ "shape":"RouteOrigin", "documentation":"

Describes how the route was created.

  • CreateRouteTable indicates that route was automatically created when the route table was created.
  • CreateRoute indicates that the route was manually added to the route table.
  • EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
", "locationName":"origin" } }, "documentation":"

Describes a route in a route table.

" }, "RouteList":{ "type":"list", "member":{ "shape":"Route", "locationName":"item" } }, "RouteOrigin":{ "type":"string", "enum":[ "CreateRouteTable", "CreateRoute", "EnableVgwRoutePropagation" ] }, "RouteState":{ "type":"string", "enum":[ "active", "blackhole" ] }, "RouteTable":{ "type":"structure", "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Routes":{ "shape":"RouteList", "documentation":"

The routes in the route table.

", "locationName":"routeSet" }, "Associations":{ "shape":"RouteTableAssociationList", "documentation":"

The associations between the route table and one or more subnets.

", "locationName":"associationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the route table.

", "locationName":"tagSet" }, "PropagatingVgws":{ "shape":"PropagatingVgwList", "documentation":"

Any virtual private gateway (VGW) propagating routes.

", "locationName":"propagatingVgwSet" } }, "documentation":"

Describes a route table.

" }, "RouteTableAssociation":{ "type":"structure", "members":{ "RouteTableAssociationId":{ "shape":"String", "documentation":"

The ID of the association between a route table and a subnet.

", "locationName":"routeTableAssociationId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet. A subnet ID is not returned for an implicit association.

", "locationName":"subnetId" }, "Main":{ "shape":"Boolean", "documentation":"

Indicates whether this is the main route table.

", "locationName":"main" } }, "documentation":"

Describes an association between a route table and a subnet.

" }, "RouteTableAssociationList":{ "type":"list", "member":{ "shape":"RouteTableAssociation", "locationName":"item" } }, "RouteTableList":{ "type":"list", "member":{ "shape":"RouteTable", "locationName":"item" } }, "RuleAction":{ "type":"string", "enum":[ "allow", "deny" ] }, "RunInstancesMonitoringEnabled":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Indicates whether monitoring is enabled for the instance.

", "locationName":"enabled" } }, "documentation":"

Describes the monitoring for the instance.

" }, "RunInstancesRequest":{ "type":"structure", "required":[ "ImageId", "MinCount", "MaxCount" ], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI, which you can get by calling DescribeImages.

" }, "MinCount":{ "shape":"Integer", "documentation":"

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" }, "MaxCount":{ "shape":"Integer", "documentation":"

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

" }, "SecurityGroups":{ "shape":"SecurityGroupStringList", "documentation":"

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

", "locationName":"SecurityGroup" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdStringList", "documentation":"

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

", "locationName":"SecurityGroupId" }, "UserData":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data for the instances.

" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

" }, "Placement":{ "shape":"Placement", "documentation":"

The placement for the instance.

" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

The block device mapping.

", "locationName":"BlockDeviceMapping" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "documentation":"

The monitoring for the instance.

" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

" }, "DisableApiTermination":{ "shape":"Boolean", "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

", "locationName":"instanceInitiatedShutdownBehavior" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.

Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.

Default: We select an IP address from the IP address range of the subnet.

", "locationName":"privateIpAddress" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

", "locationName":"clientToken" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterface" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

", "locationName":"ebsOptimized" } } }, "S3Storage":{ "type":"structure", "members":{ "Bucket":{ "shape":"String", "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

The beginning of the file name of the AMI.

", "locationName":"prefix" }, "AWSAccessKeyId":{ "shape":"String", "documentation":"

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

" }, "UploadPolicy":{ "shape":"Blob", "documentation":"

A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", "locationName":"uploadPolicy" }, "UploadPolicySignature":{ "shape":"String", "documentation":"

The signature of the Base64 encoded JSON document.

", "locationName":"uploadPolicySignature" } }, "documentation":"

Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI.

" }, "SecurityGroup":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the security group.

", "locationName":"ownerId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "Description":{ "shape":"String", "documentation":"

A description of the security group.

", "locationName":"groupDescription" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

One or more inbound rules associated with the security group.

", "locationName":"ipPermissions" }, "IpPermissionsEgress":{ "shape":"IpPermissionList", "documentation":"

[EC2-VPC] One or more outbound rules associated with the security group.

", "locationName":"ipPermissionsEgress" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC for the security group.

", "locationName":"vpcId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the security group.

", "locationName":"tagSet" } }, "documentation":"

Describes a security group

" }, "SecurityGroupIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroupId" } }, "SecurityGroupList":{ "type":"list", "member":{ "shape":"SecurityGroup", "locationName":"item" } }, "SecurityGroupStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroup" } }, "ShutdownBehavior":{ "type":"string", "enum":[ "stop", "terminate" ] }, "Snapshot":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

", "locationName":"snapshotId" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume that was used to create the snapshot.

", "locationName":"volumeId" }, "State":{ "shape":"SnapshotState", "documentation":"

The snapshot state.

", "locationName":"status" }, "StateMessage":{ "shape":"String", "documentation":"

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

", "locationName":"statusMessage" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time stamp when the snapshot was initiated.

", "locationName":"startTime" }, "Progress":{ "shape":"String", "documentation":"

The progress of the snapshot, as a percentage.

", "locationName":"progress" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the EBS snapshot owner.

", "locationName":"ownerId" }, "Description":{ "shape":"String", "documentation":"

The description for the snapshot.

", "locationName":"description" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

", "locationName":"volumeSize" }, "OwnerAlias":{ "shape":"String", "documentation":"

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

", "locationName":"ownerAlias" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the snapshot.

", "locationName":"tagSet" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the snapshot is encrypted.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

", "locationName":"kmsKeyId" }, "DataEncryptionKeyId":{ "shape":"String", "documentation":"

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

", "locationName":"dataEncryptionKeyId" } }, "documentation":"

Describes a snapshot.

" }, "SnapshotAttributeName":{ "type":"string", "enum":[ "productCodes", "createVolumePermission" ] }, "SnapshotDetail":{ "type":"structure", "members":{ "DiskImageSize":{ "shape":"Double", "documentation":"

The size of the disk in the snapshot, in GiB.

", "locationName":"diskImageSize" }, "Description":{ "shape":"String", "documentation":"

A description for the snapshot.

", "locationName":"description" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image from which the snapshot is created.

", "locationName":"format" }, "Url":{ "shape":"String", "documentation":"

The URL used to access the disk image.

", "locationName":"url" }, "UserBucket":{ "shape":"UserBucketDetails", "locationName":"userBucket" }, "DeviceName":{ "shape":"String", "documentation":"

The block device mapping for the snapshot.

", "locationName":"deviceName" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot ID of the disk being imported.

", "locationName":"snapshotId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of progress for the task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message for the snapshot creation.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status of the snapshot creation.

", "locationName":"status" } }, "documentation":"

Describes the snapshot created from the imported disk.

" }, "SnapshotDetailList":{ "type":"list", "member":{ "shape":"SnapshotDetail", "locationName":"item" } }, "SnapshotDiskContainer":{ "type":"structure", "members":{ "Description":{ "shape":"String", "documentation":"

The description of the disk image being imported.

" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" }, "Url":{ "shape":"String", "documentation":"

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).

" }, "UserBucket":{"shape":"UserBucket"} }, "documentation":"

The disk container object for the import snapshot request.

" }, "SnapshotIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SnapshotId" } }, "SnapshotList":{ "type":"list", "member":{ "shape":"Snapshot", "locationName":"item" } }, "SnapshotState":{ "type":"string", "enum":[ "pending", "completed", "error" ] }, "SnapshotTaskDetail":{ "type":"structure", "members":{ "DiskImageSize":{ "shape":"Double", "documentation":"

The size of the disk in the snapshot, in GiB.

", "locationName":"diskImageSize" }, "Description":{ "shape":"String", "documentation":"

The description of the snapshot.

", "locationName":"description" }, "Format":{ "shape":"String", "documentation":"

The format of the disk image from which the snapshot is created.

", "locationName":"format" }, "Url":{ "shape":"String", "documentation":"

The URL of the disk image from which the snapshot is created.

", "locationName":"url" }, "UserBucket":{ "shape":"UserBucketDetails", "documentation":"

The S3 bucket for the disk image.

", "locationName":"userBucket" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot ID of the disk being imported.

", "locationName":"snapshotId" }, "Progress":{ "shape":"String", "documentation":"

The percentage of completion for the import snapshot task.

", "locationName":"progress" }, "StatusMessage":{ "shape":"String", "documentation":"

A detailed status message for the import snapshot task.

", "locationName":"statusMessage" }, "Status":{ "shape":"String", "documentation":"

A brief status for the import snapshot task.

", "locationName":"status" } }, "documentation":"

Details about the import snapshot task.

" }, "SpotDatafeedSubscription":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the account.

", "locationName":"ownerId" }, "Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket where the Spot instance data feed is located.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

The prefix that is prepended to data feed files.

", "locationName":"prefix" }, "State":{ "shape":"DatafeedSubscriptionState", "documentation":"

The state of the Spot instance data feed subscription.

", "locationName":"state" }, "Fault":{ "shape":"SpotInstanceStateFault", "documentation":"

The fault codes for the Spot instance request, if any.

", "locationName":"fault" } }, "documentation":"

Describes the data feed for a Spot instance.

" }, "SpotFleetLaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups. To request an instance in a nondefault VPC, you must specify the ID of the security group. To request an instance in EC2-Classic or a default VPC, you can specify the name or the ID of the security group.

", "locationName":"groupSet" }, "UserData":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" }, "Monitoring":{ "shape":"SpotFleetMonitoring", "documentation":"

Enable or disable monitoring for the instances.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instances.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "WeightedCapacity":{ "shape":"Double", "documentation":"

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).

If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.

", "locationName":"weightedCapacity" }, "SpotPrice":{ "shape":"String", "documentation":"

The bid price per unit hour for the specified instance type. If this value is not specified, the default is the Spot bid price specified for the fleet. To determine the bid price per unit hour, divide the Spot bid price by the value of WeightedCapacity.

", "locationName":"spotPrice" } }, "documentation":"

Describes the launch specification for one or more Spot instances.

" }, "SpotFleetMonitoring":{ "type":"structure", "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Enables monitoring for the instance.

Default: false

", "locationName":"enabled" } }, "documentation":"

Describes whether monitoring is enabled.

" }, "SpotFleetRequestConfig":{ "type":"structure", "required":[ "SpotFleetRequestId", "SpotFleetRequestState", "SpotFleetRequestConfig" ], "members":{ "SpotFleetRequestId":{ "shape":"String", "documentation":"

The ID of the Spot fleet request.

", "locationName":"spotFleetRequestId" }, "SpotFleetRequestState":{ "shape":"BatchState", "documentation":"

The state of the Spot fleet request.

", "locationName":"spotFleetRequestState" }, "SpotFleetRequestConfig":{ "shape":"SpotFleetRequestConfigData", "documentation":"

Information about the configuration of the Spot fleet request.

", "locationName":"spotFleetRequestConfig" } }, "documentation":"

Describes a Spot fleet request.

" }, "SpotFleetRequestConfigData":{ "type":"structure", "required":[ "SpotPrice", "TargetCapacity", "IamFleetRole", "LaunchSpecifications" ], "members":{ "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" }, "SpotPrice":{ "shape":"String", "documentation":"

The bid price per unit hour.

", "locationName":"spotPrice" }, "TargetCapacity":{ "shape":"Integer", "documentation":"

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O.

", "locationName":"targetCapacity" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot instance requests are placed or enabled to fulfill the request.

", "locationName":"validUntil" }, "TerminateInstancesWithExpiration":{ "shape":"Boolean", "documentation":"

Indicates whether running Spot instances should be terminated when the Spot fleet request expires.

", "locationName":"terminateInstancesWithExpiration" }, "IamFleetRole":{ "shape":"String", "documentation":"

Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration.

", "locationName":"iamFleetRole" }, "LaunchSpecifications":{ "shape":"LaunchSpecsList", "documentation":"

Information about the launch specifications for the Spot fleet request.

", "locationName":"launchSpecifications" }, "AllocationStrategy":{ "shape":"AllocationStrategy", "documentation":"

Determines how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is lowestPrice.

", "locationName":"allocationStrategy" } }, "documentation":"

Describes the configuration of a Spot fleet request.

" }, "SpotFleetRequestConfigSet":{ "type":"list", "member":{ "shape":"SpotFleetRequestConfig", "locationName":"item" } }, "SpotInstanceRequest":{ "type":"structure", "members":{ "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot instance request.

", "locationName":"spotInstanceRequestId" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum hourly price (bid) for any Spot instance launched to fulfill the request.

", "locationName":"spotPrice" }, "Type":{ "shape":"SpotInstanceType", "documentation":"

The Spot instance request type.

", "locationName":"type" }, "State":{ "shape":"SpotInstanceState", "documentation":"

The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"state" }, "Fault":{ "shape":"SpotInstanceStateFault", "documentation":"

The fault codes for the Spot instance request, if any.

", "locationName":"fault" }, "Status":{ "shape":"SpotInstanceStatus", "documentation":"

The status code and status message describing the Spot instance request.

", "locationName":"status" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.

", "locationName":"validUntil" }, "LaunchGroup":{ "shape":"String", "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

", "locationName":"launchGroup" }, "AvailabilityZoneGroup":{ "shape":"String", "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.

", "locationName":"availabilityZoneGroup" }, "LaunchSpecification":{ "shape":"LaunchSpecification", "documentation":"

Additional information for launching instances.

", "locationName":"launchSpecification" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID, if an instance has been launched to fulfill the Spot instance request.

", "locationName":"instanceId" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The date and time when the Spot instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"createTime" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The product description associated with the Spot instance.

", "locationName":"productDescription" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "LaunchedAvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the bid is launched.

", "locationName":"launchedAvailabilityZone" } }, "documentation":"

Describe a Spot instance request.

" }, "SpotInstanceRequestIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"SpotInstanceRequestId" } }, "SpotInstanceRequestList":{ "type":"list", "member":{ "shape":"SpotInstanceRequest", "locationName":"item" } }, "SpotInstanceState":{ "type":"string", "enum":[ "open", "active", "closed", "cancelled", "failed" ] }, "SpotInstanceStateFault":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The reason code for the Spot instance state change.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The message for the Spot instance state change.

", "locationName":"message" } }, "documentation":"

Describes a Spot instance state change.

" }, "SpotInstanceStatus":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The status code.

", "locationName":"code" }, "UpdateTime":{ "shape":"DateTime", "documentation":"

The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"updateTime" }, "Message":{ "shape":"String", "documentation":"

The description for the status code.

", "locationName":"message" } }, "documentation":"

Describes the status of a Spot instance request.

" }, "SpotInstanceType":{ "type":"string", "enum":[ "one-time", "persistent" ] }, "SpotPlacement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group (for cluster instances).

", "locationName":"groupName" } }, "documentation":"

Describes Spot instance placement.

" }, "SpotPrice":{ "type":"structure", "members":{ "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

A general description of the AMI.

", "locationName":"productDescription" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum price (bid) that you are willing to pay for a Spot instance.

", "locationName":"spotPrice" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", "locationName":"timestamp" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" } }, "documentation":"

Describes the maximum hourly price (bid) for any Spot instance launched to fulfill the request.

" }, "SpotPriceHistoryList":{ "type":"list", "member":{ "shape":"SpotPrice", "locationName":"item" } }, "StartInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" } } }, "StartInstancesResult":{ "type":"structure", "members":{ "StartingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more started instances.

", "locationName":"instancesSet" } } }, "State":{ "type":"string", "enum":[ "Pending", "Available", "Deleting", "Deleted" ] }, "StateReason":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The reason code for the state change.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The message for the state change.

  • Server.SpotInstanceTermination: A Spot Instance was terminated due to an increase in the market price.

  • Server.InternalError: An internal error occurred during instance launch, resulting in termination.

  • Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

  • Client.InternalError: A client error caused the instance to terminate on launch.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The volume limit was exceeded.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

", "locationName":"message" } }, "documentation":"

Describes a state change.

" }, "Status":{ "type":"string", "enum":[ "MoveInProgress", "InVpc", "InClassic" ] }, "StatusName":{ "type":"string", "enum":["reachability"] }, "StatusType":{ "type":"string", "enum":[ "passed", "failed", "insufficient-data", "initializing" ] }, "StopInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" }, "Force":{ "shape":"Boolean", "documentation":"

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

", "locationName":"force" } } }, "StopInstancesResult":{ "type":"structure", "members":{ "StoppingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more stopped instances.

", "locationName":"instancesSet" } } }, "Storage":{ "type":"structure", "members":{ "S3":{ "shape":"S3Storage", "documentation":"

An Amazon S3 storage location.

" } }, "documentation":"

Describes the storage location for an instance store-backed AMI.

" }, "String":{"type":"string"}, "Subnet":{ "type":"structure", "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "State":{ "shape":"SubnetState", "documentation":"

The current state of the subnet.

", "locationName":"state" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC the subnet is in.

", "locationName":"vpcId" }, "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block assigned to the subnet.

", "locationName":"cidrBlock" }, "AvailableIpAddressCount":{ "shape":"Integer", "documentation":"

The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.

", "locationName":"availableIpAddressCount" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the subnet.

", "locationName":"availabilityZone" }, "DefaultForAz":{ "shape":"Boolean", "documentation":"

Indicates whether this is the default subnet for the Availability Zone.

", "locationName":"defaultForAz" }, "MapPublicIpOnLaunch":{ "shape":"Boolean", "documentation":"

Indicates whether instances launched in this subnet receive a public IP address.

", "locationName":"mapPublicIpOnLaunch" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the subnet.

", "locationName":"tagSet" } }, "documentation":"

Describes a subnet.

" }, "SubnetIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SubnetId" } }, "SubnetList":{ "type":"list", "member":{ "shape":"Subnet", "locationName":"item" } }, "SubnetState":{ "type":"string", "enum":[ "pending", "available" ] }, "SummaryStatus":{ "type":"string", "enum":[ "ok", "impaired", "insufficient-data", "not-applicable", "initializing" ] }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", "locationName":"value" } }, "documentation":"

Describes a tag.

" }, "TagDescription":{ "type":"structure", "members":{ "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource. For example, ami-1a2b3c4d.

", "locationName":"resourceId" }, "ResourceType":{ "shape":"ResourceType", "documentation":"

The resource type.

", "locationName":"resourceType" }, "Key":{ "shape":"String", "documentation":"

The tag key.

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The tag value.

", "locationName":"value" } }, "documentation":"

Describes a tag.

" }, "TagDescriptionList":{ "type":"list", "member":{ "shape":"TagDescription", "locationName":"item" } }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"item" } }, "TelemetryStatus":{ "type":"string", "enum":[ "UP", "DOWN" ] }, "Tenancy":{ "type":"string", "enum":[ "default", "dedicated" ] }, "TerminateInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } } }, "TerminateInstancesResult":{ "type":"structure", "members":{ "TerminatingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more terminated instances.

", "locationName":"instancesSet" } } }, "TrafficType":{ "type":"string", "enum":[ "ACCEPT", "REJECT", "ALL" ] }, "UnassignPrivateIpAddressesRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "PrivateIpAddresses" ], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", "documentation":"

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

", "locationName":"privateIpAddress" } } }, "UnmonitorInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } } }, "UnmonitorInstancesResult":{ "type":"structure", "members":{ "InstanceMonitorings":{ "shape":"InstanceMonitoringList", "documentation":"

Monitoring information for one or more instances.

", "locationName":"instancesSet" } } }, "UnsuccessfulItem":{ "type":"structure", "required":["Error"], "members":{ "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource.

", "locationName":"resourceId" }, "Error":{ "shape":"UnsuccessfulItemError", "documentation":"

Information about the error.

", "locationName":"error" } }, "documentation":"

Information about items that were not successfully processed in a batch call.

" }, "UnsuccessfulItemError":{ "type":"structure", "required":[ "Code", "Message" ], "members":{ "Code":{ "shape":"String", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The error message accompanying the error code.

", "locationName":"message" } }, "documentation":"

Information about the error that occurred. For more information about errors, see Error Codes.

" }, "UnsuccessfulItemSet":{ "type":"list", "member":{ "shape":"UnsuccessfulItem", "locationName":"item" } }, "UserBucket":{ "type":"structure", "members":{ "S3Bucket":{ "shape":"String", "documentation":"

The name of the S3 bucket where the disk image is located.

" }, "S3Key":{ "shape":"String", "documentation":"

The key for the disk image.

" } }, "documentation":"

Describes the S3 bucket for the disk image.

" }, "UserBucketDetails":{ "type":"structure", "members":{ "S3Bucket":{ "shape":"String", "documentation":"

The S3 bucket from which the disk image was created.

", "locationName":"s3Bucket" }, "S3Key":{ "shape":"String", "documentation":"

The key from which the disk image was created.

", "locationName":"s3Key" } }, "documentation":"

Describes the S3 bucket for the disk image.

" }, "UserData":{ "type":"structure", "members":{ "Data":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data for the instance.

", "locationName":"data" } }, "documentation":"

Describes the user data to be made available to an instance.

" }, "UserGroupStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"UserGroup" } }, "UserIdGroupPair":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The ID of an AWS account. EC2-Classic only.

", "locationName":"userId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use GroupId.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } }, "documentation":"

Describes a security group and AWS account ID pair.

" }, "UserIdGroupPairList":{ "type":"list", "member":{ "shape":"UserIdGroupPair", "locationName":"item" } }, "UserIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"UserId" } }, "ValueStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "VgwTelemetry":{ "type":"structure", "members":{ "OutsideIpAddress":{ "shape":"String", "documentation":"

The Internet-routable IP address of the virtual private gateway's outside interface.

", "locationName":"outsideIpAddress" }, "Status":{ "shape":"TelemetryStatus", "documentation":"

The status of the VPN tunnel.

", "locationName":"status" }, "LastStatusChange":{ "shape":"DateTime", "documentation":"

The date and time of the last change in status.

", "locationName":"lastStatusChange" }, "StatusMessage":{ "shape":"String", "documentation":"

If an error occurs, a description of the error.

", "locationName":"statusMessage" }, "AcceptedRouteCount":{ "shape":"Integer", "documentation":"

The number of accepted routes.

", "locationName":"acceptedRouteCount" } }, "documentation":"

Describes telemetry for a VPN tunnel.

" }, "VgwTelemetryList":{ "type":"list", "member":{ "shape":"VgwTelemetry", "locationName":"item" } }, "VirtualizationType":{ "type":"string", "enum":[ "hvm", "paravirtual" ] }, "Volume":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "Size":{ "shape":"Integer", "documentation":"

The size of the volume, in GiBs.

", "locationName":"size" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot from which the volume was created, if applicable.

", "locationName":"snapshotId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the volume.

", "locationName":"availabilityZone" }, "State":{ "shape":"VolumeState", "documentation":"

The volume state.

", "locationName":"status" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The time stamp when volume creation was initiated.

", "locationName":"createTime" }, "Attachments":{ "shape":"VolumeAttachmentList", "documentation":"

Information about the volume attachments.

", "locationName":"attachmentSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the volume.

", "locationName":"tagSet" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

", "locationName":"volumeType" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

", "locationName":"iops" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the volume will be encrypted.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

", "locationName":"kmsKeyId" } }, "documentation":"

Describes a volume.

" }, "VolumeAttachment":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Device":{ "shape":"String", "documentation":"

The device name.

", "locationName":"device" }, "State":{ "shape":"VolumeAttachmentState", "documentation":"

The attachment state of the volume.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes volume attachment details.

" }, "VolumeAttachmentList":{ "type":"list", "member":{ "shape":"VolumeAttachment", "locationName":"item" } }, "VolumeAttachmentState":{ "type":"string", "enum":[ "attaching", "attached", "detaching", "detached" ] }, "VolumeAttributeName":{ "type":"string", "enum":[ "autoEnableIO", "productCodes" ] }, "VolumeDetail":{ "type":"structure", "required":["Size"], "members":{ "Size":{ "shape":"Long", "documentation":"

The size of the volume, in GiB.

", "locationName":"size" } }, "documentation":"

Describes an EBS volume.

" }, "VolumeIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VolumeId" } }, "VolumeList":{ "type":"list", "member":{ "shape":"Volume", "locationName":"item" } }, "VolumeState":{ "type":"string", "enum":[ "creating", "available", "in-use", "deleting", "deleted", "error" ] }, "VolumeStatusAction":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The code identifying the operation, for example, enable-volume-io.

", "locationName":"code" }, "Description":{ "shape":"String", "documentation":"

A description of the operation.

", "locationName":"description" }, "EventType":{ "shape":"String", "documentation":"

The event type associated with this operation.

", "locationName":"eventType" }, "EventId":{ "shape":"String", "documentation":"

The ID of the event associated with this operation.

", "locationName":"eventId" } }, "documentation":"

Describes a volume status operation code.

" }, "VolumeStatusActionsList":{ "type":"list", "member":{ "shape":"VolumeStatusAction", "locationName":"item" } }, "VolumeStatusDetails":{ "type":"structure", "members":{ "Name":{ "shape":"VolumeStatusName", "documentation":"

The name of the volume status.

", "locationName":"name" }, "Status":{ "shape":"String", "documentation":"

The intended status of the volume status.

", "locationName":"status" } }, "documentation":"

Describes a volume status.

" }, "VolumeStatusDetailsList":{ "type":"list", "member":{ "shape":"VolumeStatusDetails", "locationName":"item" } }, "VolumeStatusEvent":{ "type":"structure", "members":{ "EventType":{ "shape":"String", "documentation":"

The type of this event.

", "locationName":"eventType" }, "Description":{ "shape":"String", "documentation":"

A description of the event.

", "locationName":"description" }, "NotBefore":{ "shape":"DateTime", "documentation":"

The earliest start time of the event.

", "locationName":"notBefore" }, "NotAfter":{ "shape":"DateTime", "documentation":"

The latest end time of the event.

", "locationName":"notAfter" }, "EventId":{ "shape":"String", "documentation":"

The ID of this event.

", "locationName":"eventId" } }, "documentation":"

Describes a volume status event.

" }, "VolumeStatusEventsList":{ "type":"list", "member":{ "shape":"VolumeStatusEvent", "locationName":"item" } }, "VolumeStatusInfo":{ "type":"structure", "members":{ "Status":{ "shape":"VolumeStatusInfoStatus", "documentation":"

The status of the volume.

", "locationName":"status" }, "Details":{ "shape":"VolumeStatusDetailsList", "documentation":"

The details of the volume status.

", "locationName":"details" } }, "documentation":"

Describes the status of a volume.

" }, "VolumeStatusInfoStatus":{ "type":"string", "enum":[ "ok", "impaired", "insufficient-data" ] }, "VolumeStatusItem":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

", "locationName":"volumeId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the volume.

", "locationName":"availabilityZone" }, "VolumeStatus":{ "shape":"VolumeStatusInfo", "documentation":"

The volume status.

", "locationName":"volumeStatus" }, "Events":{ "shape":"VolumeStatusEventsList", "documentation":"

A list of events associated with the volume.

", "locationName":"eventsSet" }, "Actions":{ "shape":"VolumeStatusActionsList", "documentation":"

The details of the operation.

", "locationName":"actionsSet" } }, "documentation":"

Describes the volume status.

" }, "VolumeStatusList":{ "type":"list", "member":{ "shape":"VolumeStatusItem", "locationName":"item" } }, "VolumeStatusName":{ "type":"string", "enum":[ "io-enabled", "io-performance" ] }, "VolumeType":{ "type":"string", "enum":[ "standard", "io1", "gp2" ] }, "Vpc":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"VpcState", "documentation":"

The current state of the VPC.

", "locationName":"state" }, "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block for the VPC.

", "locationName":"cidrBlock" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

", "locationName":"dhcpOptionsId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPC.

", "locationName":"tagSet" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The allowed tenancy of instances launched into the VPC.

", "locationName":"instanceTenancy" }, "IsDefault":{ "shape":"Boolean", "documentation":"

Indicates whether the VPC is the default VPC.

", "locationName":"isDefault" } }, "documentation":"

Describes a VPC.

" }, "VpcAttachment":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"AttachmentStatus", "documentation":"

The current state of the attachment.

", "locationName":"state" } }, "documentation":"

Describes an attachment between a virtual private gateway and a VPC.

" }, "VpcAttachmentList":{ "type":"list", "member":{ "shape":"VpcAttachment", "locationName":"item" } }, "VpcAttributeName":{ "type":"string", "enum":[ "enableDnsSupport", "enableDnsHostnames" ] }, "VpcClassicLink":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "ClassicLinkEnabled":{ "shape":"Boolean", "documentation":"

Indicates whether the VPC is enabled for ClassicLink.

", "locationName":"classicLinkEnabled" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPC.

", "locationName":"tagSet" } }, "documentation":"

Describes whether a VPC is enabled for ClassicLink.

" }, "VpcClassicLinkIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcId" } }, "VpcClassicLinkList":{ "type":"list", "member":{ "shape":"VpcClassicLink", "locationName":"item" } }, "VpcEndpoint":{ "type":"structure", "members":{ "VpcEndpointId":{ "shape":"String", "documentation":"

The ID of the VPC endpoint.

", "locationName":"vpcEndpointId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC to which the endpoint is associated.

", "locationName":"vpcId" }, "ServiceName":{ "shape":"String", "documentation":"

The name of the AWS service to which the endpoint is associated.

", "locationName":"serviceName" }, "State":{ "shape":"State", "documentation":"

The state of the VPC endpoint.

", "locationName":"state" }, "PolicyDocument":{ "shape":"String", "documentation":"

The policy document associated with the endpoint.

", "locationName":"policyDocument" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route tables associated with the endpoint.

", "locationName":"routeTableIdSet" }, "CreationTimestamp":{ "shape":"DateTime", "documentation":"

The date and time the VPC endpoint was created.

", "locationName":"creationTimestamp" } }, "documentation":"

Describes a VPC endpoint.

" }, "VpcEndpointSet":{ "type":"list", "member":{ "shape":"VpcEndpoint", "locationName":"item" } }, "VpcIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcId" } }, "VpcList":{ "type":"list", "member":{ "shape":"Vpc", "locationName":"item" } }, "VpcPeeringConnection":{ "type":"structure", "members":{ "AccepterVpcInfo":{ "shape":"VpcPeeringConnectionVpcInfo", "documentation":"

The information of the peer VPC.

", "locationName":"accepterVpcInfo" }, "ExpirationTime":{ "shape":"DateTime", "documentation":"

The time that an unaccepted VPC peering connection will expire.

", "locationName":"expirationTime" }, "RequesterVpcInfo":{ "shape":"VpcPeeringConnectionVpcInfo", "documentation":"

The information of the requester VPC.

", "locationName":"requesterVpcInfo" }, "Status":{ "shape":"VpcPeeringConnectionStateReason", "documentation":"

The status of the VPC peering connection.

", "locationName":"status" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Describes a VPC peering connection.

" }, "VpcPeeringConnectionList":{ "type":"list", "member":{ "shape":"VpcPeeringConnection", "locationName":"item" } }, "VpcPeeringConnectionStateReason":{ "type":"structure", "members":{ "Code":{ "shape":"VpcPeeringConnectionStateReasonCode", "documentation":"

The status of the VPC peering connection.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

A message that provides more information about the status, if applicable.

", "locationName":"message" } }, "documentation":"

Describes the status of a VPC peering connection.

" }, "VpcPeeringConnectionStateReasonCode":{ "type":"string", "enum":[ "initiating-request", "pending-acceptance", "active", "deleted", "rejected", "failed", "expired", "provisioning", "deleting" ] }, "VpcPeeringConnectionVpcInfo":{ "type":"structure", "members":{ "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block for the VPC.

", "locationName":"cidrBlock" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the VPC owner.

", "locationName":"ownerId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Describes a VPC in a VPC peering connection.

" }, "VpcState":{ "type":"string", "enum":[ "pending", "available" ] }, "VpnConnection":{ "type":"structure", "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

", "locationName":"vpnConnectionId" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the VPN connection.

", "locationName":"state" }, "CustomerGatewayConfiguration":{ "shape":"String", "documentation":"

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

", "locationName":"customerGatewayConfiguration" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection.

", "locationName":"type" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway at your end of the VPN connection.

", "locationName":"customerGatewayId" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

", "locationName":"vpnGatewayId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPN connection.

", "locationName":"tagSet" }, "VgwTelemetry":{ "shape":"VgwTelemetryList", "documentation":"

Information about the VPN tunnel.

", "locationName":"vgwTelemetry" }, "Options":{ "shape":"VpnConnectionOptions", "documentation":"

The VPN connection options.

", "locationName":"options" }, "Routes":{ "shape":"VpnStaticRouteList", "documentation":"

The static routes associated with the VPN connection.

", "locationName":"routes" } }, "documentation":"

Describes a VPN connection.

" }, "VpnConnectionIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpnConnectionId" } }, "VpnConnectionList":{ "type":"list", "member":{ "shape":"VpnConnection", "locationName":"item" } }, "VpnConnectionOptions":{ "type":"structure", "members":{ "StaticRoutesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "locationName":"staticRoutesOnly" } }, "documentation":"

Describes VPN connection options.

" }, "VpnConnectionOptionsSpecification":{ "type":"structure", "members":{ "StaticRoutesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "locationName":"staticRoutesOnly" } }, "documentation":"

Describes VPN connection options.

" }, "VpnGateway":{ "type":"structure", "members":{ "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

", "locationName":"vpnGatewayId" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the virtual private gateway.

", "locationName":"state" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection the virtual private gateway supports.

", "locationName":"type" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the virtual private gateway was created.

", "locationName":"availabilityZone" }, "VpcAttachments":{ "shape":"VpcAttachmentList", "documentation":"

Any VPCs attached to the virtual private gateway.

", "locationName":"attachments" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the virtual private gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes a virtual private gateway.

" }, "VpnGatewayIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpnGatewayId" } }, "VpnGatewayList":{ "type":"list", "member":{ "shape":"VpnGateway", "locationName":"item" } }, "VpnState":{ "type":"string", "enum":[ "pending", "available", "deleting", "deleted" ] }, "VpnStaticRoute":{ "type":"structure", "members":{ "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer data center.

", "locationName":"destinationCidrBlock" }, "Source":{ "shape":"VpnStaticRouteSource", "documentation":"

Indicates how the routes were provided.

", "locationName":"source" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the static route.

", "locationName":"state" } }, "documentation":"

Describes a static route for a VPN connection.

" }, "VpnStaticRouteList":{ "type":"list", "member":{ "shape":"VpnStaticRoute", "locationName":"item" } }, "VpnStaticRouteSource":{ "type":"string", "enum":["Static"] }, "ZoneNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ZoneName" } }, "NewDhcpConfigurationList":{ "type":"list", "member":{ "shape":"NewDhcpConfiguration", "locationName":"item" } }, "NewDhcpConfiguration":{ "type":"structure", "members":{ "Key":{ "shape":"String", "locationName":"key" }, "Values":{ "shape":"ValueStringList", "locationName":"Value" } } }, "DhcpConfigurationValueList":{ "type":"list", "member":{ "shape":"AttributeValue", "locationName":"item" } }, "Blob":{"type":"blob"}, "BlobAttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"Blob", "locationName":"value" } } }, "RequestSpotLaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"ValueStringList", "locationName":"SecurityGroup" }, "UserData":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"NetworkInterface" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" }, "SecurityGroupIds":{ "shape":"ValueStringList", "locationName":"SecurityGroupId" } }, "documentation":"

Describes the launch specification for an instance.

" } }, "examples":{ } } botocore-1.5.7/botocore/data/ec2/2014-10-01/0000777454262600001440000000000013042511307020626 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ec2/2014-10-01/waiters-2.json0000666454262600001440000002544013042511306023342 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "BundleTaskComplete": { "delay": 15, "operation": "DescribeBundleTasks", "maxAttempts": 40, "acceptors": [ { "expected": "complete", "matcher": "pathAll", "state": "success", "argument": "BundleTasks[].State" }, { "expected": "failed", "matcher": "pathAny", "state": "failure", "argument": "BundleTasks[].State" } ] }, "ConversionTaskCancelled": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "cancelled", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" } ] }, "ConversionTaskCompleted": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" }, { "expected": "cancelled", "matcher": "pathAny", "state": "failure", "argument": "ConversionTasks[].State" }, { "expected": "cancelling", "matcher": "pathAny", "state": "failure", "argument": "ConversionTasks[].State" } ] }, "ConversionTaskDeleted": { "delay": 15, "operation": "DescribeConversionTasks", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "ConversionTasks[].State" } ] }, "CustomerGatewayAvailable": { "delay": 15, "operation": "DescribeCustomerGateways", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "CustomerGateways[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "CustomerGateways[].State" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "CustomerGateways[].State" } ] }, "ExportTaskCancelled": { "delay": 15, "operation": "DescribeExportTasks", "maxAttempts": 40, "acceptors": [ { "expected": "cancelled", "matcher": "pathAll", "state": "success", "argument": "ExportTasks[].State" } ] }, "ExportTaskCompleted": { "delay": 15, "operation": "DescribeExportTasks", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "ExportTasks[].State" } ] }, "ImageAvailable": { "operation": "DescribeImages", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "Images[].State", "expected": "available" }, { "state": "failure", "matcher": "pathAny", "argument": "Images[].State", "expected": "failed" } ] }, "InstanceRunning": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "running", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "shutting-down", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "InstanceStatusOk": { "operation": "DescribeInstanceStatus", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "InstanceStatuses[].InstanceStatus.Status", "expected": "ok" } ] }, "InstanceStopped": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "stopped", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "InstanceTerminated": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "acceptors": [ { "expected": "terminated", "matcher": "pathAll", "state": "success", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Reservations[].Instances[].State.Name" } ] }, "PasswordDataAvailable": { "operation": "GetPasswordData", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "path", "argument": "length(PasswordData) > `0`", "expected": true } ] }, "SnapshotCompleted": { "delay": 15, "operation": "DescribeSnapshots", "maxAttempts": 40, "acceptors": [ { "expected": "completed", "matcher": "pathAll", "state": "success", "argument": "Snapshots[].State" } ] }, "SpotInstanceRequestFulfilled": { "operation": "DescribeSpotInstanceRequests", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "SpotInstanceRequests[].Status.Code", "expected": "fulfilled" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "schedule-expired" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "canceled-before-fulfillment" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "bad-parameters" }, { "state": "failure", "matcher": "pathAny", "argument": "SpotInstanceRequests[].Status.Code", "expected": "system-error" } ] }, "SubnetAvailable": { "delay": 15, "operation": "DescribeSubnets", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Subnets[].State" } ] }, "SystemStatusOk": { "operation": "DescribeInstanceStatus", "maxAttempts": 40, "delay": 15, "acceptors": [ { "state": "success", "matcher": "pathAll", "argument": "InstanceStatuses[].SystemStatus.Status", "expected": "ok" } ] }, "VolumeAvailable": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Volumes[].State" } ] }, "VolumeDeleted": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" } ] }, "VolumeInUse": { "delay": 15, "operation": "DescribeVolumes", "maxAttempts": 40, "acceptors": [ { "expected": "in-use", "matcher": "pathAll", "state": "success", "argument": "Volumes[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Volumes[].State" } ] }, "VpcAvailable": { "delay": 15, "operation": "DescribeVpcs", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Vpcs[].State" } ] }, "VpnConnectionAvailable": { "delay": 15, "operation": "DescribeVpnConnections", "maxAttempts": 40, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "VpnConnections[].State" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" } ] }, "VpnConnectionDeleted": { "delay": 15, "operation": "DescribeVpnConnections", "maxAttempts": 40, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "VpnConnections[].State" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "VpnConnections[].State" } ] } } } botocore-1.5.7/botocore/data/ec2/2014-10-01/paginators-1.json0000666454262600001440000000263713042511306024035 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeInstanceStatus": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "InstanceStatuses" }, "DescribeInstances": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Reservations" }, "DescribeReservedInstancesModifications": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "ReservedInstancesModifications" }, "DescribeReservedInstancesOfferings": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "ReservedInstancesOfferings" }, "DescribeSpotPriceHistory": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "SpotPriceHistory" }, "DescribeTags": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Tags" }, "DescribeVolumeStatus": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "VolumeStatuses" }, "DescribeSnapshots": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Snapshots" } } } botocore-1.5.7/botocore/data/ec2/2014-10-01/service-2.json0000666454262600001440000212231413042511306023324 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2014-10-01", "endpointPrefix":"ec2", "serviceAbbreviation":"Amazon EC2", "serviceFullName":"Amazon Elastic Compute Cloud", "signatureVersion":"v4", "xmlNamespace":"http://ec2.amazonaws.com/doc/2014-10-01", "protocol":"ec2" }, "documentation":"Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.

", "operations":{ "AcceptVpcPeeringConnection":{ "name":"AcceptVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, "output":{"shape":"AcceptVpcPeeringConnectionResult"}, "documentation":"

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.

" }, "AllocateAddress":{ "name":"AllocateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AllocateAddressRequest"}, "output":{"shape":"AllocateAddressResult"}, "documentation":"

Acquires an Elastic IP address.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "AssignPrivateIpAddresses":{ "name":"AssignPrivateIpAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssignPrivateIpAddressesRequest"}, "documentation":"

Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

AssignPrivateIpAddresses is available only in EC2-VPC.

" }, "AssociateAddress":{ "name":"AssociateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateAddressRequest"}, "output":{"shape":"AssociateAddressResult"}, "documentation":"

Associates an Elastic IP address with an instance or a network interface.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" }, "AssociateDhcpOptions":{ "name":"AssociateDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateDhcpOptionsRequest"}, "documentation":"

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "AssociateRouteTable":{ "name":"AssociateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateRouteTableRequest"}, "output":{"shape":"AssociateRouteTableResult"}, "documentation":"

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "AttachClassicLinkVpc":{ "name":"AttachClassicLinkVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachClassicLinkVpcRequest"}, "output":{"shape":"AttachClassicLinkVpcResult"}, "documentation":"

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" }, "AttachInternetGateway":{ "name":"AttachInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachInternetGatewayRequest"}, "documentation":"

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" }, "AttachNetworkInterface":{ "name":"AttachNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachNetworkInterfaceRequest"}, "output":{"shape":"AttachNetworkInterfaceResult"}, "documentation":"

Attaches a network interface to an instance.

" }, "AttachVolume":{ "name":"AttachVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachVolumeRequest"}, "output":{ "shape":"VolumeAttachment", "locationName":"attachment" }, "documentation":"

Attaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.

For a list of supported device names, see Attaching an Amazon EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for Amazon EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide for Linux.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.
  • AWS Marketplace product codes are copied from the volume to the instance.
  • You must be subscribed to the product.
  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For an overview of the AWS Marketplace, see Introducing AWS Marketplace.

For more information about Amazon EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "AttachVpnGateway":{ "name":"AttachVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachVpnGatewayRequest"}, "output":{"shape":"AttachVpnGatewayResult"}, "documentation":"

Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "AuthorizeSecurityGroupEgress":{ "name":"AuthorizeSecurityGroupEgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, "documentation":"

Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC.

You can have up to 50 rules per security group (covering both ingress and egress rules).

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

" }, "AuthorizeSecurityGroupIngress":{ "name":"AuthorizeSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, "documentation":"

Adds one or more ingress rules to a security group.

EC2-Classic: You can have up to 100 rules per group.

EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.

[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.

" }, "BundleInstance":{ "name":"BundleInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BundleInstanceRequest"}, "output":{"shape":"BundleInstanceResult"}, "documentation":"

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

For more information, see Creating an Instance Store-Backed Windows AMI.

" }, "CancelBundleTask":{ "name":"CancelBundleTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelBundleTaskRequest"}, "output":{"shape":"CancelBundleTaskResult"}, "documentation":"

Cancels a bundling operation for an instance store-backed Windows instance.

" }, "CancelConversionTask":{ "name":"CancelConversionTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelConversionRequest"}, "documentation":"

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CancelExportTask":{ "name":"CancelExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelExportTaskRequest"}, "documentation":"

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" }, "CancelReservedInstancesListing":{ "name":"CancelReservedInstancesListing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelReservedInstancesListingRequest"}, "output":{"shape":"CancelReservedInstancesListingResult"}, "documentation":"

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CancelSpotInstanceRequests":{ "name":"CancelSpotInstanceRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelSpotInstanceRequestsRequest"}, "output":{"shape":"CancelSpotInstanceRequestsResult"}, "documentation":"

Cancels one or more Spot Instance requests. Spot Instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide for Linux.

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

" }, "ConfirmProductInstance":{ "name":"ConfirmProductInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmProductInstanceRequest"}, "output":{"shape":"ConfirmProductInstanceResult"}, "documentation":"

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.

" }, "CopyImage":{ "name":"CopyImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyImageRequest"}, "output":{"shape":"CopyImageResult"}, "documentation":"

Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted Amazon EBS snapshots cannot be copied with this method.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CopySnapshot":{ "name":"CopySnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopySnapshotRequest"}, "output":{"shape":"CopySnapshotResult"}, "documentation":"

Copies a point-in-time snapshot of an Amazon EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create Amazon EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted Amazon EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted.

Copying snapshots that were encrypted with non-default AWS Key Management Service (KMS) master keys is not supported at this time.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateCustomerGateway":{ "name":"CreateCustomerGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCustomerGatewayRequest"}, "output":{"shape":"CreateCustomerGatewayResult"}, "documentation":"

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateDhcpOptions":{ "name":"CreateDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDhcpOptionsRequest"}, "output":{"shape":"CreateDhcpOptionsResult"}, "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.
  • domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.
  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateImage":{ "name":"CreateImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateImageRequest"}, "output":{"shape":"CreateImageResult"}, "documentation":"

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateInstanceExportTask":{ "name":"CreateInstanceExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInstanceExportTaskRequest"}, "output":{"shape":"CreateInstanceExportTaskResult"}, "documentation":"

Exports a running or stopped instance to an Amazon S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting EC2 Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateInternetGateway":{ "name":"CreateInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInternetGatewayRequest"}, "output":{"shape":"CreateInternetGatewayResult"}, "documentation":"

Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" }, "CreateKeyPair":{ "name":"CreateKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateKeyPairRequest"}, "output":{ "shape":"KeyPair", "documentation":"

Information about the key pair.

", "locationName":"keyPair" }, "documentation":"

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateNetworkAcl":{ "name":"CreateNetworkAcl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkAclRequest"}, "output":{"shape":"CreateNetworkAclResult"}, "documentation":"

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkAclEntry":{ "name":"CreateNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkAclEntryRequest"}, "documentation":"

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "CreateNetworkInterface":{ "name":"CreateNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNetworkInterfaceRequest"}, "output":{"shape":"CreateNetworkInterfaceResult"}, "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreatePlacementGroup":{ "name":"CreatePlacementGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlacementGroupRequest"}, "documentation":"

Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.

For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateReservedInstancesListing":{ "name":"CreateReservedInstancesListing", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateReservedInstancesListingRequest"}, "output":{"shape":"CreateReservedInstancesListingResult"}, "documentation":"

Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the DescribeReservedInstances operation.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Reserved Instances, you must first register as a Seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateRoute":{ "name":"CreateRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRouteRequest"}, "documentation":"

Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "CreateRouteTable":{ "name":"CreateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRouteTableRequest"}, "output":{"shape":"CreateRouteTableResult"}, "documentation":"

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "CreateSecurityGroup":{ "name":"CreateSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSecurityGroupRequest"}, "output":{"shape":"CreateSecurityGroupResult"}, "documentation":"

Creates a security group.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide for Linux and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

EC2-Classic: You can have up to 500 security groups.

EC2-VPC: You can create up to 100 security groups per VPC.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

" }, "CreateSnapshot":{ "name":"CreateSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSnapshotRequest"}, "output":{ "shape":"Snapshot", "locationName":"snapshot" }, "documentation":"

Creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of Amazon EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateSpotDatafeedSubscription":{ "name":"CreateSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, "documentation":"

Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateSubnet":{ "name":"CreateSubnet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSubnetRequest"}, "output":{"shape":"CreateSubnetResult"}, "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).

AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateTags":{ "name":"CreateTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTagsRequest"}, "documentation":"

Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateVolume":{ "name":"CreateVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVolumeRequest"}, "output":{ "shape":"Volume", "locationName":"volume" }, "documentation":"

Creates an Amazon EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an Amazon EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "CreateVpc":{ "name":"CreateVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcRequest"}, "output":{"shape":"CreateVpcResult"}, "documentation":"

Creates a VPC with the specified CIDR block.

The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpcPeeringConnection":{ "name":"CreateVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpcPeeringConnectionRequest"}, "output":{"shape":"CreateVpcPeeringConnectionResult"}, "documentation":"

Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.

The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.

" }, "CreateVpnConnection":{ "name":"CreateVpnConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnConnectionRequest"}, "output":{"shape":"CreateVpnConnectionResult"}, "documentation":"

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpnConnectionRoute":{ "name":"CreateVpnConnectionRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnConnectionRouteRequest"}, "documentation":"

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "CreateVpnGateway":{ "name":"CreateVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVpnGatewayRequest"}, "output":{"shape":"CreateVpnGatewayResult"}, "documentation":"

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DeleteCustomerGateway":{ "name":"DeleteCustomerGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCustomerGatewayRequest"}, "documentation":"

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" }, "DeleteDhcpOptions":{ "name":"DeleteDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDhcpOptionsRequest"}, "documentation":"

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" }, "DeleteInternetGateway":{ "name":"DeleteInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteInternetGatewayRequest"}, "documentation":"

Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.

" }, "DeleteKeyPair":{ "name":"DeleteKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteKeyPairRequest"}, "documentation":"

Deletes the specified key pair, by removing the public key from Amazon EC2.

" }, "DeleteNetworkAcl":{ "name":"DeleteNetworkAcl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkAclRequest"}, "documentation":"

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" }, "DeleteNetworkAclEntry":{ "name":"DeleteNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkAclEntryRequest"}, "documentation":"

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" }, "DeleteNetworkInterface":{ "name":"DeleteNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNetworkInterfaceRequest"}, "documentation":"

Deletes the specified network interface. You must detach the network interface before you can delete it.

" }, "DeletePlacementGroup":{ "name":"DeletePlacementGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePlacementGroupRequest"}, "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DeleteRoute":{ "name":"DeleteRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRouteRequest"}, "documentation":"

Deletes the specified route from the specified route table.

" }, "DeleteRouteTable":{ "name":"DeleteRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRouteTableRequest"}, "documentation":"

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" }, "DeleteSecurityGroup":{ "name":"DeleteSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSecurityGroupRequest"}, "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" }, "DeleteSnapshot":{ "name":"DeleteSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSnapshotRequest"}, "documentation":"

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an Amazon EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DeleteSpotDatafeedSubscription":{ "name":"DeleteSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSpotDatafeedSubscriptionRequest"}, "documentation":"

Deletes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DeleteSubnet":{ "name":"DeleteSubnet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSubnetRequest"}, "documentation":"

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsRequest"}, "documentation":"

Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DeleteVolume":{ "name":"DeleteVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVolumeRequest"}, "documentation":"

Deletes the specified Amazon EBS volume. The volume must be in the available state (not attached to an instance).

The volume may remain in the deleting state for several minutes.

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DeleteVpc":{ "name":"DeleteVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcRequest"}, "documentation":"

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" }, "DeleteVpcPeeringConnection":{ "name":"DeleteVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, "output":{"shape":"DeleteVpcPeeringConnectionResult"}, "documentation":"

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.

" }, "DeleteVpnConnection":{ "name":"DeleteVpnConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnConnectionRequest"}, "documentation":"

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" }, "DeleteVpnConnectionRoute":{ "name":"DeleteVpnConnectionRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnConnectionRouteRequest"}, "documentation":"

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" }, "DeleteVpnGateway":{ "name":"DeleteVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVpnGatewayRequest"}, "documentation":"

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" }, "DeregisterImage":{ "name":"DeregisterImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterImageRequest"}, "documentation":"

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

This command does not delete the AMI.

" }, "DescribeAccountAttributes":{ "name":"DescribeAccountAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAccountAttributesRequest"}, "output":{"shape":"DescribeAccountAttributesResult"}, "documentation":"

Describes attributes of your AWS account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: The maximum number of On-Demand instances that you can run.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

" }, "DescribeAddresses":{ "name":"DescribeAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAddressesRequest"}, "output":{"shape":"DescribeAddressesResult"}, "documentation":"

Describes one or more of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeAvailabilityZones":{ "name":"DescribeAvailabilityZones", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAvailabilityZonesRequest"}, "output":{"shape":"DescribeAvailabilityZonesResult"}, "documentation":"

Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeBundleTasks":{ "name":"DescribeBundleTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeBundleTasksRequest"}, "output":{"shape":"DescribeBundleTasksResult"}, "documentation":"

Describes one or more of your bundling tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

" }, "DescribeClassicLinkInstances":{ "name":"DescribeClassicLinkInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClassicLinkInstancesRequest"}, "output":{"shape":"DescribeClassicLinkInstancesResult"}, "documentation":"

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.

" }, "DescribeConversionTasks":{ "name":"DescribeConversionTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConversionTasksRequest"}, "output":{"shape":"DescribeConversionTasksResult"}, "documentation":"

Describes one or more of your conversion tasks. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeCustomerGateways":{ "name":"DescribeCustomerGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCustomerGatewaysRequest"}, "output":{"shape":"DescribeCustomerGatewaysResult"}, "documentation":"

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeDhcpOptions":{ "name":"DescribeDhcpOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDhcpOptionsRequest"}, "output":{"shape":"DescribeDhcpOptionsResult"}, "documentation":"

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeExportTasks":{ "name":"DescribeExportTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeExportTasksRequest"}, "output":{"shape":"DescribeExportTasksResult"}, "documentation":"

Describes one or more of your export tasks.

" }, "DescribeImageAttribute":{ "name":"DescribeImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImageAttributeRequest"}, "output":{ "shape":"ImageAttribute", "documentation":"

Information about the image attribute.

", "locationName":"imageAttribute" }, "documentation":"

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" }, "DescribeImages":{ "name":"DescribeImages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImagesRequest"}, "output":{"shape":"DescribeImagesResult"}, "documentation":"

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

Deregistered images are included in the returned results for an unspecified interval after deregistration.

" }, "DescribeInstanceAttribute":{ "name":"DescribeInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceAttributeRequest"}, "output":{"shape":"InstanceAttribute"}, "documentation":"

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" }, "DescribeInstanceStatus":{ "name":"DescribeInstanceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceStatusRequest"}, "output":{"shape":"DescribeInstanceStatusResult"}, "documentation":"

Describes the status of one or more instances, including any scheduled events.

Instance status has two main components:

  • System Status reports impaired functionality that stems from issues related to the systems that support an instance, such as such as hardware failures and network connectivity problems. This call reports such problems as impaired reachability.

  • Instance Status reports impaired functionality that arises from problems internal to the instance. This call reports such problems as impaired reachability.

Instance status provides information about four types of scheduled events for an instance that may require your attention:

  • Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the instances status returns one of two event codes: system-reboot or instance-reboot. System reboot commonly occurs if certain maintenance or upgrade operations require a reboot of the underlying host that supports an instance. Instance reboot commonly occurs if the instance must be rebooted, rather than the underlying host. Rebooting events include a scheduled start and end time.

  • System Maintenance: When Amazon EC2 determines that an instance requires maintenance that requires power or network impact, the instance status is the event code system-maintenance. System maintenance is either power maintenance or network maintenance. For power maintenance, your instance will be unavailable for a brief period of time and then rebooted. For network maintenance, your instance will experience a brief loss of network connectivity. System maintenance events include a scheduled start and end time. You will also be notified by email if one of your instances is set for system maintenance. The email message indicates when your instance is scheduled for maintenance.

  • Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the instance status is the event code instance-retirement. Retirement commonly occurs when the underlying host is degraded and must be replaced. Retirement events include a scheduled start and end time. You will also be notified by email if one of your instances is set to retiring. The email message indicates when your instance will be permanently retired.

  • Scheduled Stop: When Amazon EC2 determines that an instance must be shut down, the instances status returns an event code called instance-stop. Stop events include a scheduled start and end time. You will also be notified by email if one of your instances is set to stop. The email message indicates when your instance will be stopped.

When your instance is retired, it will either be terminated (if its root device type is the instance-store) or stopped (if its root device type is an EBS volume). Instances stopped due to retirement will not be restarted, but you can do so manually. You can also avoid retirement of EBS-backed instances by manually restarting your instance when its event code is instance-retirement. This ensures that your instance is started on a different underlying host.

For more information about failed status checks, see Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide for Linux. For more information about working with scheduled events, see Working with an Instance That Has a Scheduled Event in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeInstances":{ "name":"DescribeInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancesRequest"}, "output":{"shape":"DescribeInstancesResult"}, "documentation":"

Describes one or more of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

" }, "DescribeInternetGateways":{ "name":"DescribeInternetGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInternetGatewaysRequest"}, "output":{"shape":"DescribeInternetGatewaysResult"}, "documentation":"

Describes one or more of your Internet gateways.

" }, "DescribeKeyPairs":{ "name":"DescribeKeyPairs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeKeyPairsRequest"}, "output":{"shape":"DescribeKeyPairsResult"}, "documentation":"

Describes one or more of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeNetworkAcls":{ "name":"DescribeNetworkAcls", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkAclsRequest"}, "output":{"shape":"DescribeNetworkAclsResult"}, "documentation":"

Describes one or more of your network ACLs.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeNetworkInterfaceAttribute":{ "name":"DescribeNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, "documentation":"

Describes a network interface attribute. You can specify only one attribute at a time.

" }, "DescribeNetworkInterfaces":{ "name":"DescribeNetworkInterfaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNetworkInterfacesRequest"}, "output":{"shape":"DescribeNetworkInterfacesResult"}, "documentation":"

Describes one or more of your network interfaces.

" }, "DescribePlacementGroups":{ "name":"DescribePlacementGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePlacementGroupsRequest"}, "output":{"shape":"DescribePlacementGroupsResult"}, "documentation":"

Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeRegions":{ "name":"DescribeRegions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRegionsRequest"}, "output":{"shape":"DescribeRegionsResult"}, "documentation":"

Describes one or more regions that are currently available to you.

For a list of the regions supported by Amazon EC2, see Regions and Endpoints.

" }, "DescribeReservedInstances":{ "name":"DescribeReservedInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesRequest"}, "output":{"shape":"DescribeReservedInstancesResult"}, "documentation":"

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeReservedInstancesListings":{ "name":"DescribeReservedInstancesListings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesListingsRequest"}, "output":{"shape":"DescribeReservedInstancesListingsResult"}, "documentation":"

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeReservedInstancesModifications":{ "name":"DescribeReservedInstancesModifications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, "output":{"shape":"DescribeReservedInstancesModificationsResult"}, "documentation":"

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeReservedInstancesOfferings":{ "name":"DescribeReservedInstancesOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, "documentation":"

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeRouteTables":{ "name":"DescribeRouteTables", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRouteTablesRequest"}, "output":{"shape":"DescribeRouteTablesResult"}, "documentation":"

Describes one or more of your route tables.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeSecurityGroups":{ "name":"DescribeSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSecurityGroupsRequest"}, "output":{"shape":"DescribeSecurityGroupsResult"}, "documentation":"

Describes one or more of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide for Linux and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeSnapshotAttribute":{ "name":"DescribeSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotAttributeRequest"}, "output":{"shape":"DescribeSnapshotAttributeResult"}, "documentation":"

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeSnapshots":{ "name":"DescribeSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotsRequest"}, "output":{"shape":"DescribeSnapshotsResult"}, "documentation":"

Describes one or more of the Amazon EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.
  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.
  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeSpotDatafeedSubscription":{ "name":"DescribeSpotDatafeedSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, "documentation":"

Describes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeSpotInstanceRequests":{ "name":"DescribeSpotInstanceRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, "output":{"shape":"DescribeSpotInstanceRequestsResult"}, "documentation":"

Describes the Spot Instance requests that belong to your account. Spot Instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide for Linux.

You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

" }, "DescribeSpotPriceHistory":{ "name":"DescribeSpotPriceHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSpotPriceHistoryRequest"}, "output":{"shape":"DescribeSpotPriceHistoryResult"}, "documentation":"

Describes the Spot Price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see Spot Instance Pricing History in the Amazon Elastic Compute Cloud User Guide for Linux.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" }, "DescribeSubnets":{ "name":"DescribeSubnets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSubnetsRequest"}, "output":{"shape":"DescribeSubnetsResult"}, "documentation":"

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsRequest"}, "output":{"shape":"DescribeTagsResult"}, "documentation":"

Describes one or more of the tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeVolumeAttribute":{ "name":"DescribeVolumeAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumeAttributeRequest"}, "output":{"shape":"DescribeVolumeAttributeResult"}, "documentation":"

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeVolumeStatus":{ "name":"DescribeVolumeStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumeStatusRequest"}, "output":{"shape":"DescribeVolumeStatusResult"}, "documentation":"

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

" }, "DescribeVolumes":{ "name":"DescribeVolumes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumesRequest"}, "output":{"shape":"DescribeVolumesResult"}, "documentation":"

Describes the specified Amazon EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DescribeVpcAttribute":{ "name":"DescribeVpcAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcAttributeRequest"}, "output":{"shape":"DescribeVpcAttributeResult"}, "documentation":"

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" }, "DescribeVpcClassicLink":{ "name":"DescribeVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcClassicLinkRequest"}, "output":{"shape":"DescribeVpcClassicLinkResult"}, "documentation":"

Describes the ClassicLink status of one or more VPCs.

" }, "DescribeVpcPeeringConnections":{ "name":"DescribeVpcPeeringConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, "documentation":"

Describes one or more of your VPC peering connections.

" }, "DescribeVpcs":{ "name":"DescribeVpcs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpcsRequest"}, "output":{"shape":"DescribeVpcsResult"}, "documentation":"

Describes one or more of your VPCs.

" }, "DescribeVpnConnections":{ "name":"DescribeVpnConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpnConnectionsRequest"}, "output":{"shape":"DescribeVpnConnectionsResult"}, "documentation":"

Describes one or more of your VPN connections.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DescribeVpnGateways":{ "name":"DescribeVpnGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVpnGatewaysRequest"}, "output":{"shape":"DescribeVpnGatewaysResult"}, "documentation":"

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "DetachClassicLinkVpc":{ "name":"DetachClassicLinkVpc", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachClassicLinkVpcRequest"}, "output":{"shape":"DetachClassicLinkVpcResult"}, "documentation":"

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" }, "DetachInternetGateway":{ "name":"DetachInternetGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachInternetGatewayRequest"}, "documentation":"

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.

" }, "DetachNetworkInterface":{ "name":"DetachNetworkInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachNetworkInterfaceRequest"}, "documentation":"

Detaches a network interface from an instance.

" }, "DetachVolume":{ "name":"DetachVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachVolumeRequest"}, "output":{ "shape":"VolumeAttachment", "locationName":"attachment" }, "documentation":"

Detaches an Amazon EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching.

If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "DetachVpnGateway":{ "name":"DetachVpnGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachVpnGatewayRequest"}, "documentation":"

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" }, "DisableVgwRoutePropagation":{ "name":"DisableVgwRoutePropagation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVgwRoutePropagationRequest"}, "documentation":"

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" }, "DisableVpcClassicLink":{ "name":"DisableVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableVpcClassicLinkRequest"}, "output":{"shape":"DisableVpcClassicLinkResult"}, "documentation":"

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

" }, "DisassociateAddress":{ "name":"DisassociateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateAddressRequest"}, "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" }, "DisassociateRouteTable":{ "name":"DisassociateRouteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateRouteTableRequest"}, "documentation":"

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "EnableVgwRoutePropagation":{ "name":"EnableVgwRoutePropagation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVgwRoutePropagationRequest"}, "documentation":"

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" }, "EnableVolumeIO":{ "name":"EnableVolumeIO", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVolumeIORequest"}, "documentation":"

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" }, "EnableVpcClassicLink":{ "name":"EnableVpcClassicLink", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableVpcClassicLinkRequest"}, "output":{"shape":"EnableVpcClassicLinkResult"}, "documentation":"

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "GetConsoleOutput":{ "name":"GetConsoleOutput", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetConsoleOutputRequest"}, "output":{"shape":"GetConsoleOutputResult"}, "documentation":"

Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.

For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output includes output from the EC2Config service.

" }, "GetPasswordData":{ "name":"GetPasswordData", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPasswordDataRequest"}, "output":{"shape":"GetPasswordDataResult"}, "documentation":"

Retrieves the encrypted administrator password for an instance running Windows.

The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" }, "ImportInstance":{ "name":"ImportInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportInstanceRequest"}, "output":{"shape":"ImportInstanceResult"}, "documentation":"

Creates an import instance task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the EC2 command line tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "ImportKeyPair":{ "name":"ImportKeyPair", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportKeyPairRequest"}, "output":{"shape":"ImportKeyPairResult"}, "documentation":"

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "ImportVolume":{ "name":"ImportVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportVolumeRequest"}, "output":{"shape":"ImportVolumeResult"}, "documentation":"

Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the Amazon EC2 command-line interface (CLI) tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "ModifyImageAttribute":{ "name":"ModifyImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyImageAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

" }, "ModifyInstanceAttribute":{ "name":"ModifyInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyInstanceAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "ModifyNetworkInterfaceAttribute":{ "name":"ModifyNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, "documentation":"

Modifies the specified network interface attribute. You can specify only one attribute at a time.

" }, "ModifyReservedInstances":{ "name":"ModifyReservedInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyReservedInstancesRequest"}, "output":{"shape":"ModifyReservedInstancesResult"}, "documentation":"

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "ModifySnapshotAttribute":{ "name":"ModifySnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySnapshotAttributeRequest"}, "documentation":"

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.

Snapshots with AWS Marketplace product codes cannot be made public.

" }, "ModifySubnetAttribute":{ "name":"ModifySubnetAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySubnetAttributeRequest"}, "documentation":"

Modifies a subnet attribute.

" }, "ModifyVolumeAttribute":{ "name":"ModifyVolumeAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVolumeAttributeRequest"}, "documentation":"

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" }, "ModifyVpcAttribute":{ "name":"ModifyVpcAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyVpcAttributeRequest"}, "documentation":"

Modifies the specified attribute of the specified VPC.

" }, "MonitorInstances":{ "name":"MonitorInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MonitorInstancesRequest"}, "output":{"shape":"MonitorInstancesResult"}, "documentation":"

Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "PurchaseReservedInstancesOffering":{ "name":"PurchaseReservedInstancesOffering", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, "documentation":"

Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time. You pay a lower usage rate than with On-Demand instances for the time that you actually use the capacity reservation.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "RebootInstances":{ "name":"RebootInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootInstancesRequest"}, "documentation":"

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If a Linux/Unix instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "RegisterImage":{ "name":"RegisterImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterImageRequest"}, "output":{"shape":"RegisterImageResult"}, "documentation":"

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide for Linux.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide for Linux.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

" }, "RejectVpcPeeringConnection":{ "name":"RejectVpcPeeringConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RejectVpcPeeringConnectionRequest"}, "output":{"shape":"RejectVpcPeeringConnectionResult"}, "documentation":"

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" }, "ReleaseAddress":{ "name":"ReleaseAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReleaseAddressRequest"}, "documentation":"

Releases the specified Elastic IP address.

After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

" }, "ReplaceNetworkAclAssociation":{ "name":"ReplaceNetworkAclAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceNetworkAclAssociationRequest"}, "output":{"shape":"ReplaceNetworkAclAssociationResult"}, "documentation":"

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceNetworkAclEntry":{ "name":"ReplaceNetworkAclEntry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceNetworkAclEntryRequest"}, "documentation":"

Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceRoute":{ "name":"ReplaceRoute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceRouteRequest"}, "documentation":"

Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" }, "ReplaceRouteTableAssociation":{ "name":"ReplaceRouteTableAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReplaceRouteTableAssociationRequest"}, "output":{"shape":"ReplaceRouteTableAssociationResult"}, "documentation":"

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" }, "ReportInstanceStatus":{ "name":"ReportInstanceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReportInstanceStatusRequest"}, "documentation":"

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" }, "RequestSpotInstances":{ "name":"RequestSpotInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RequestSpotInstancesRequest"}, "output":{"shape":"RequestSpotInstancesResult"}, "documentation":"

Creates a Spot Instance request. Spot Instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "ResetImageAttribute":{ "name":"ResetImageAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetImageAttributeRequest"}, "documentation":"

Resets an attribute of an AMI to its default value.

The productCodes attribute can't be reset.

" }, "ResetInstanceAttribute":{ "name":"ResetInstanceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetInstanceAttributeRequest"}, "documentation":"

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the SourceDestCheck, the instance can be either running or stopped.

The SourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" }, "ResetNetworkInterfaceAttribute":{ "name":"ResetNetworkInterfaceAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetNetworkInterfaceAttributeRequest"}, "documentation":"

Resets a network interface attribute. You can specify only one attribute at a time.

" }, "ResetSnapshotAttribute":{ "name":"ResetSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetSnapshotAttributeRequest"}, "documentation":"

Resets permission settings for the specified snapshot.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "RevokeSecurityGroupEgress":{ "name":"RevokeSecurityGroupEgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSecurityGroupEgressRequest"}, "documentation":"

Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" }, "RevokeSecurityGroupIngress":{ "name":"RevokeSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSecurityGroupIngressRequest"}, "documentation":"

Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" }, "RunInstances":{ "name":"RunInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RunInstancesRequest"}, "output":{ "shape":"Reservation", "documentation":"

One or more reservations.

", "locationName":"reservation" }, "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

When you launch an instance, it enters the pending state. After the instance is ready for you, it enters the running state. To check the state of your instance, call DescribeInstances.

If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide for Linux.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.

You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide for Linux.

If any of the AMIs have a product code attached for which the user has not subscribed, RunInstances fails.

T2 instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, RunInstances fails.

For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "StartInstances":{ "name":"StartInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartInstancesRequest"}, "output":{"shape":"StartInstancesResult"}, "documentation":"

Starts an Amazon EBS-backed AMI that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "StopInstances":{ "name":"StopInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopInstancesRequest"}, "output":{"shape":"StopInstancesResult"}, "documentation":"

Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

You can't start or stop Spot Instances.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide for Linux.

For more information about troubleshooting, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "TerminateInstances":{ "name":"TerminateInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateInstancesRequest"}, "output":{"shape":"TerminateInstancesResult"}, "documentation":"

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all Amazon EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide for Linux.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "UnassignPrivateIpAddresses":{ "name":"UnassignPrivateIpAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnassignPrivateIpAddressesRequest"}, "documentation":"

Unassigns one or more secondary private IP addresses from a network interface.

" }, "UnmonitorInstances":{ "name":"UnmonitorInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnmonitorInstancesRequest"}, "output":{"shape":"UnmonitorInstancesResult"}, "documentation":"

Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" } }, "shapes":{ "AcceptVpcPeeringConnectionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "AcceptVpcPeeringConnectionResult":{ "type":"structure", "members":{ "VpcPeeringConnection":{ "shape":"VpcPeeringConnection", "documentation":"

Information about the VPC peering connection.

", "locationName":"vpcPeeringConnection" } } }, "AccountAttribute":{ "type":"structure", "members":{ "AttributeName":{ "shape":"String", "documentation":"

The name of the account attribute.

", "locationName":"attributeName" }, "AttributeValues":{ "shape":"AccountAttributeValueList", "documentation":"

One or more values for the account attribute.

", "locationName":"attributeValueSet" } }, "documentation":"

Describes an account attribute.

" }, "AccountAttributeList":{ "type":"list", "member":{ "shape":"AccountAttribute", "locationName":"item" } }, "AccountAttributeName":{ "type":"string", "enum":[ "supported-platforms", "default-vpc" ] }, "AccountAttributeNameStringList":{ "type":"list", "member":{ "shape":"AccountAttributeName", "locationName":"attributeName" } }, "AccountAttributeValue":{ "type":"structure", "members":{ "AttributeValue":{ "shape":"String", "documentation":"

The value of the attribute.

", "locationName":"attributeValue" } }, "documentation":"

Describes a value of an account attribute.

" }, "AccountAttributeValueList":{ "type":"list", "member":{ "shape":"AccountAttributeValue", "locationName":"item" } }, "Address":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance the address is associated with (if any).

", "locationName":"instanceId" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "AllocationId":{ "shape":"String", "documentation":"

The ID representing the allocation of the address for use with EC2-VPC.

", "locationName":"allocationId" }, "AssociationId":{ "shape":"String", "documentation":"

The ID representing the association of the address with an instance in a VPC.

", "locationName":"associationId" }, "Domain":{ "shape":"DomainType", "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", "locationName":"domain" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "NetworkInterfaceOwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that owns the network interface.

", "locationName":"networkInterfaceOwnerId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address associated with the Elastic IP address.

", "locationName":"privateIpAddress" } }, "documentation":"

Describes an Elastic IP address.

" }, "AddressList":{ "type":"list", "member":{ "shape":"Address", "locationName":"item" } }, "AllocateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Domain":{ "shape":"DomainType", "documentation":"

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" } } }, "AllocateAddressResult":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address.

", "locationName":"publicIp" }, "Domain":{ "shape":"DomainType", "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", "locationName":"domain" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", "locationName":"allocationId" } } }, "AllocationIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"AllocationId" } }, "ArchitectureValues":{ "type":"string", "enum":[ "i386", "x86_64" ] }, "AssignPrivateIpAddressesRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", "locationName":"privateIpAddress" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", "locationName":"secondaryPrivateIpAddressCount" }, "AllowReassignment":{ "shape":"Boolean", "documentation":"

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", "locationName":"allowReassignment" } } }, "AssociateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" }, "PublicIp":{ "shape":"String", "documentation":"

The Elastic IP address. This is required for EC2-Classic.

" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

", "locationName":"networkInterfaceId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", "locationName":"privateIpAddress" }, "AllowReassociation":{ "shape":"Boolean", "documentation":"

[EC2-VPC] Allows an Elastic IP address that is already associated with an instance or network interface to be re-associated with the specified instance or network interface. Otherwise, the operation fails.

Default: false

", "locationName":"allowReassociation" } } }, "AssociateAddressResult":{ "type":"structure", "members":{ "AssociationId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", "locationName":"associationId" } } }, "AssociateDhcpOptionsRequest":{ "type":"structure", "required":[ "DhcpOptionsId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } } }, "AssociateRouteTableRequest":{ "type":"structure", "required":[ "SubnetId", "RouteTableId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" } } }, "AssociateRouteTableResult":{ "type":"structure", "members":{ "AssociationId":{ "shape":"String", "documentation":"

The route table association ID (needed to disassociate the route table).

", "locationName":"associationId" } } }, "AttachClassicLinkVpcRequest":{ "type":"structure", "required":[ "InstanceId", "VpcId", "Groups" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of a ClassicLink-enabled VPC.

", "locationName":"vpcId" }, "Groups":{ "shape":"GroupIdStringList", "documentation":"

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", "locationName":"SecurityGroupId" } } }, "AttachClassicLinkVpcResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "AttachInternetGatewayRequest":{ "type":"structure", "required":[ "InternetGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "AttachNetworkInterfaceRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "InstanceId", "DeviceIndex" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device for the network interface attachment.

", "locationName":"deviceIndex" } } }, "AttachNetworkInterfaceResult":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" } } }, "AttachVolumeRequest":{ "type":"structure", "required":[ "VolumeId", "InstanceId", "Device" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "Device":{ "shape":"String", "documentation":"

The device name to expose to the instance (for example, /dev/sdh or xvdh).

" } } }, "AttachVpnGatewayRequest":{ "type":"structure", "required":[ "VpnGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } } }, "AttachVpnGatewayResult":{ "type":"structure", "members":{ "VpcAttachment":{ "shape":"VpcAttachment", "documentation":"

Information about the attachment.

", "locationName":"attachment" } } }, "AttachmentStatus":{ "type":"string", "enum":[ "attaching", "attached", "detaching", "detached" ] }, "AttributeBooleanValue":{ "type":"structure", "members":{ "Value":{ "shape":"Boolean", "documentation":"

Valid values are true or false.

", "locationName":"value" } }, "documentation":"

The value to use when a resource attribute accepts a Boolean value.

" }, "AttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"String", "documentation":"

Valid values are case-sensitive and vary by action.

", "locationName":"value" } }, "documentation":"

The value to use for a resource attribute.

" }, "AuthorizeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

", "locationName":"toPort" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

", "locationName":"cidrIp" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"ipPermissions" } } }, "AuthorizeSecurityGroupIngressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a nondefault VPC.

" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.

" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. Can be used to specify multiple rules in a single command.

" } } }, "AvailabilityZone":{ "type":"structure", "members":{ "ZoneName":{ "shape":"String", "documentation":"

The name of the Availability Zone.

", "locationName":"zoneName" }, "State":{ "shape":"AvailabilityZoneState", "documentation":"

The state of the Availability Zone (available | impaired | unavailable).

", "locationName":"zoneState" }, "RegionName":{ "shape":"String", "documentation":"

The name of the region.

", "locationName":"regionName" }, "Messages":{ "shape":"AvailabilityZoneMessageList", "documentation":"

Any messages about the Availability Zone.

", "locationName":"messageSet" } }, "documentation":"

Describes an Availability Zone.

" }, "AvailabilityZoneList":{ "type":"list", "member":{ "shape":"AvailabilityZone", "locationName":"item" } }, "AvailabilityZoneMessage":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

The message about the Availability Zone.

", "locationName":"message" } }, "documentation":"

Describes a message about an Availability Zone.

" }, "AvailabilityZoneMessageList":{ "type":"list", "member":{ "shape":"AvailabilityZoneMessage", "locationName":"item" } }, "AvailabilityZoneState":{ "type":"string", "enum":["available"] }, "BlockDeviceMapping":{ "type":"structure", "members":{ "VirtualName":{ "shape":"String", "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", "locationName":"virtualName" }, "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsBlockDevice", "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", "locationName":"ebs" }, "NoDevice":{ "shape":"String", "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", "locationName":"noDevice" } }, "documentation":"

Describes a block device mapping.

" }, "BlockDeviceMappingList":{ "type":"list", "member":{ "shape":"BlockDeviceMapping", "locationName":"item" } }, "BlockDeviceMappingRequestList":{ "type":"list", "member":{ "shape":"BlockDeviceMapping", "locationName":"BlockDeviceMapping" } }, "Boolean":{"type":"boolean"}, "BundleIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"BundleId" } }, "BundleInstanceRequest":{ "type":"structure", "required":[ "InstanceId", "Storage" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

" }, "Storage":{ "shape":"Storage", "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" } } }, "BundleInstanceResult":{ "type":"structure", "members":{ "BundleTask":{ "shape":"BundleTask", "documentation":"

Information about the bundle task.

", "locationName":"bundleInstanceTask" } } }, "BundleTask":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance associated with this bundle task.

", "locationName":"instanceId" }, "BundleId":{ "shape":"String", "documentation":"

The ID of the bundle task.

", "locationName":"bundleId" }, "State":{ "shape":"BundleTaskState", "documentation":"

The state of the task.

", "locationName":"state" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time this task started.

", "locationName":"startTime" }, "UpdateTime":{ "shape":"DateTime", "documentation":"

The time of the most recent update for the task.

", "locationName":"updateTime" }, "Storage":{ "shape":"Storage", "documentation":"

The Amazon S3 storage locations.

", "locationName":"storage" }, "Progress":{ "shape":"String", "documentation":"

The level of task completion, as a percent (for example, 20%).

", "locationName":"progress" }, "BundleTaskError":{ "shape":"BundleTaskError", "documentation":"

If the task fails, a description of the error.

", "locationName":"error" } }, "documentation":"

Describes a bundle task.

" }, "BundleTaskError":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The error code.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The error message.

", "locationName":"message" } }, "documentation":"

Describes an error for BundleInstance.

" }, "BundleTaskList":{ "type":"list", "member":{ "shape":"BundleTask", "locationName":"item" } }, "BundleTaskState":{ "type":"string", "enum":[ "pending", "waiting-for-shutdown", "bundling", "storing", "cancelling", "complete", "failed" ] }, "CancelBundleTaskRequest":{ "type":"structure", "required":["BundleId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "BundleId":{ "shape":"String", "documentation":"

The ID of the bundle task.

" } } }, "CancelBundleTaskResult":{ "type":"structure", "members":{ "BundleTask":{ "shape":"BundleTask", "documentation":"

The bundle task.

", "locationName":"bundleInstanceTask" } } }, "CancelConversionRequest":{ "type":"structure", "required":["ConversionTaskId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ConversionTaskId":{ "shape":"String", "documentation":"

The ID of the conversion task.

", "locationName":"conversionTaskId" }, "ReasonMessage":{ "shape":"String", "locationName":"reasonMessage" } } }, "CancelExportTaskRequest":{ "type":"structure", "required":["ExportTaskId"], "members":{ "ExportTaskId":{ "shape":"String", "documentation":"

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", "locationName":"exportTaskId" } } }, "CancelReservedInstancesListingRequest":{ "type":"structure", "required":["ReservedInstancesListingId"], "members":{ "ReservedInstancesListingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance listing.

", "locationName":"reservedInstancesListingId" } } }, "CancelReservedInstancesListingResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

The Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } } }, "CancelSpotInstanceRequestState":{ "type":"string", "enum":[ "active", "open", "closed", "cancelled", "completed" ] }, "CancelSpotInstanceRequestsRequest":{ "type":"structure", "required":["SpotInstanceRequestIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SpotInstanceRequestIds":{ "shape":"SpotInstanceRequestIdList", "documentation":"

One or more Spot Instance request IDs.

", "locationName":"SpotInstanceRequestId" } } }, "CancelSpotInstanceRequestsResult":{ "type":"structure", "members":{ "CancelledSpotInstanceRequests":{ "shape":"CancelledSpotInstanceRequestList", "documentation":"

One or more Spot Instance requests.

", "locationName":"spotInstanceRequestSet" } } }, "CancelledSpotInstanceRequest":{ "type":"structure", "members":{ "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot Instance request.

", "locationName":"spotInstanceRequestId" }, "State":{ "shape":"CancelSpotInstanceRequestState", "documentation":"

The state of the Spot Instance request.

", "locationName":"state" } }, "documentation":"

Describes a request to cancel a Spot Instance.

" }, "CancelledSpotInstanceRequestList":{ "type":"list", "member":{ "shape":"CancelledSpotInstanceRequest", "locationName":"item" } }, "ClassicLinkInstance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

A list of security groups.

", "locationName":"groupSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the instance.

", "locationName":"tagSet" } }, "documentation":"

Describes a linked EC2-Classic instance.

" }, "ClassicLinkInstanceList":{ "type":"list", "member":{ "shape":"ClassicLinkInstance", "locationName":"item" } }, "ConfirmProductInstanceRequest":{ "type":"structure", "required":[ "ProductCode", "InstanceId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ProductCode":{ "shape":"String", "documentation":"

The product code. This must be a product code that you own.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" } } }, "ConfirmProductInstanceResult":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", "locationName":"ownerId" } } }, "ContainerFormat":{ "type":"string", "enum":["ova"] }, "ConversionIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "ConversionTask":{ "type":"structure", "required":[ "ConversionTaskId", "State" ], "members":{ "ConversionTaskId":{ "shape":"String", "documentation":"

The ID of the conversion task.

", "locationName":"conversionTaskId" }, "ExpirationTime":{ "shape":"String", "documentation":"

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", "locationName":"expirationTime" }, "ImportInstance":{ "shape":"ImportInstanceTaskDetails", "documentation":"

If the task is for importing an instance, this contains information about the import instance task.

", "locationName":"importInstance" }, "ImportVolume":{ "shape":"ImportVolumeTaskDetails", "documentation":"

If the task is for importing a volume, this contains information about the import volume task.

", "locationName":"importVolume" }, "State":{ "shape":"ConversionTaskState", "documentation":"

The state of the conversion task.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message related to the conversion task.

", "locationName":"statusMessage" }, "Tags":{ "shape":"TagList", "locationName":"tagSet" } }, "documentation":"

Describes a conversion task.

" }, "ConversionTaskState":{ "type":"string", "enum":[ "active", "cancelling", "cancelled", "completed" ] }, "CopyImageRequest":{ "type":"structure", "required":[ "SourceRegion", "SourceImageId", "Name" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SourceRegion":{ "shape":"String", "documentation":"

The name of the region that contains the AMI to copy.

" }, "SourceImageId":{ "shape":"String", "documentation":"

The ID of the AMI to copy.

" }, "Name":{ "shape":"String", "documentation":"

The name of the new AMI in the destination region.

" }, "Description":{ "shape":"String", "documentation":"

A description for the new AMI in the destination region.

" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide for Linux.

" } } }, "CopyImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the new AMI.

", "locationName":"imageId" } } }, "CopySnapshotRequest":{ "type":"structure", "required":[ "SourceRegion", "SourceSnapshotId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SourceRegion":{ "shape":"String", "documentation":"

The ID of the region that contains the snapshot to be copied.

" }, "SourceSnapshotId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS snapshot to copy.

" }, "Description":{ "shape":"String", "documentation":"

A description for the new Amazon EBS snapshot.

" }, "DestinationRegion":{ "shape":"String", "documentation":"

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

", "locationName":"destinationRegion" }, "PresignedUrl":{ "shape":"String", "documentation":"

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because Amazon EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", "locationName":"presignedUrl" } } }, "CopySnapshotResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the new snapshot.

", "locationName":"snapshotId" } } }, "CreateCustomerGatewayRequest":{ "type":"structure", "required":[ "Type", "PublicIp", "BgpAsn" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection that this customer gateway supports (ipsec.1).

" }, "PublicIp":{ "shape":"String", "documentation":"

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", "locationName":"IpAddress" }, "BgpAsn":{ "shape":"Integer", "documentation":"

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" } } }, "CreateCustomerGatewayResult":{ "type":"structure", "members":{ "CustomerGateway":{ "shape":"CustomerGateway", "documentation":"

Information about the customer gateway.

", "locationName":"customerGateway" } } }, "CreateDhcpOptionsRequest":{ "type":"structure", "required":["DhcpConfigurations"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "DhcpConfigurations":{ "shape":"NewDhcpConfigurationList", "documentation":"

A DHCP configuration option.

", "locationName":"dhcpConfiguration" } } }, "CreateDhcpOptionsResult":{ "type":"structure", "members":{ "DhcpOptions":{ "shape":"DhcpOptions", "documentation":"

A set of DHCP options.

", "locationName":"dhcpOptions" } } }, "CreateImageRequest":{ "type":"structure", "required":[ "InstanceId", "Name" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Name":{ "shape":"String", "documentation":"

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

A description for the new image.

", "locationName":"description" }, "NoReboot":{ "shape":"Boolean", "documentation":"

By default, this parameter is set to false, which means Amazon EC2 attempts to shut down the instance cleanly before image creation and then reboots the instance. When the parameter is set to true, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", "locationName":"noReboot" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

Information about one or more block device mappings.

", "locationName":"blockDeviceMapping" } } }, "CreateImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the new AMI.

", "locationName":"imageId" } } }, "CreateInstanceExportTaskRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "Description":{ "shape":"String", "documentation":"

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", "locationName":"description" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "TargetEnvironment":{ "shape":"ExportEnvironment", "documentation":"

The target virtualization environment.

", "locationName":"targetEnvironment" }, "ExportToS3Task":{ "shape":"ExportToS3TaskSpecification", "locationName":"exportToS3" } } }, "CreateInstanceExportTaskResult":{ "type":"structure", "members":{ "ExportTask":{ "shape":"ExportTask", "locationName":"exportTask" } } }, "CreateInternetGatewayRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" } } }, "CreateInternetGatewayResult":{ "type":"structure", "members":{ "InternetGateway":{ "shape":"InternetGateway", "documentation":"

Information about the Internet gateway.

", "locationName":"internetGateway" } } }, "CreateKeyPairRequest":{ "type":"structure", "required":["KeyName"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" } } }, "CreateNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Protocol", "RuleAction", "Egress", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The protocol. A value of -1 means all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.

", "locationName":"Icmp" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", "locationName":"portRange" } } }, "CreateNetworkAclRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "CreateNetworkAclResult":{ "type":"structure", "members":{ "NetworkAcl":{ "shape":"NetworkAcl", "documentation":"

Information about the network ACL.

", "locationName":"networkAcl" } } }, "CreateNetworkInterfaceRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet to associate with the network interface.

", "locationName":"subnetId" }, "Description":{ "shape":"String", "documentation":"

A description for the network interface.

", "locationName":"description" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", "locationName":"privateIpAddress" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

The IDs of one or more security groups.

", "locationName":"SecurityGroupId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", "documentation":"

One or more private IP addresses.

", "locationName":"privateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide for Linux.

", "locationName":"secondaryPrivateIpAddressCount" }, "DryRun":{ "shape":"Boolean", "locationName":"dryRun" } } }, "CreateNetworkInterfaceResult":{ "type":"structure", "members":{ "NetworkInterface":{ "shape":"NetworkInterface", "documentation":"

Information about the network interface.

", "locationName":"networkInterface" } } }, "CreatePlacementGroupRequest":{ "type":"structure", "required":[ "GroupName", "Strategy" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

A name for the placement group.

Constraints: Up to 255 ASCII characters

", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"

The placement strategy.

", "locationName":"strategy" } } }, "CreateReservedInstancesListingRequest":{ "type":"structure", "required":[ "ReservedInstancesId", "InstanceCount", "PriceSchedules", "ClientToken" ], "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the active Reserved Instance.

", "locationName":"reservedInstancesId" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", "locationName":"instanceCount" }, "PriceSchedules":{ "shape":"PriceScheduleSpecificationList", "documentation":"

A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.

", "locationName":"priceSchedules" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } } }, "CreateReservedInstancesListingResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

Information about the Reserved Instances listing.

", "locationName":"reservedInstancesListingsSet" } } }, "CreateRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table for the route.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of an Internet gateway or virtual private gateway attached to your VPC.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", "locationName":"instanceId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of a network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of a VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "CreateRouteTableRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "CreateRouteTableResult":{ "type":"structure", "members":{ "RouteTable":{ "shape":"RouteTable", "documentation":"

Information about the route table.

", "locationName":"routeTable" } } }, "CreateSecurityGroupRequest":{ "type":"structure", "required":[ "GroupName", "Description" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

" }, "Description":{ "shape":"String", "documentation":"

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", "locationName":"GroupDescription" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" } } }, "CreateSecurityGroupResult":{ "type":"structure", "members":{ "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } } }, "CreateSnapshotRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS volume.

" }, "Description":{ "shape":"String", "documentation":"

A description for the snapshot.

" } } }, "CreateSpotDatafeedSubscriptionRequest":{ "type":"structure", "required":["Bucket"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket in which to store the Spot Instance data feed.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

A prefix for the data feed file names.

", "locationName":"prefix" } } }, "CreateSpotDatafeedSubscriptionResult":{ "type":"structure", "members":{ "SpotDatafeedSubscription":{ "shape":"SpotDatafeedSubscription", "documentation":"

The Spot Instance data feed subscription.

", "locationName":"spotDatafeedSubscription" } } }, "CreateSubnetRequest":{ "type":"structure", "required":[ "VpcId", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the subnet.

Default: Amazon EC2 selects one for you (recommended).

" } } }, "CreateSubnetResult":{ "type":"structure", "members":{ "Subnet":{ "shape":"Subnet", "documentation":"

Information about the subnet.

", "locationName":"subnet" } } }, "CreateTagsRequest":{ "type":"structure", "required":[ "Resources", "Tags" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Resources":{ "shape":"ResourceIdList", "documentation":"

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

", "locationName":"ResourceId" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", "locationName":"Tag" } } }, "CreateVolumePermission":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

", "locationName":"userId" }, "Group":{ "shape":"PermissionGroup", "documentation":"

The specific group that is to be added or removed from a volume's list of create volume permissions.

", "locationName":"group" } } }, "CreateVolumePermissionList":{ "type":"list", "member":{ "shape":"CreateVolumePermission", "locationName":"item" } }, "CreateVolumePermissionModifications":{ "type":"structure", "members":{ "Add":{ "shape":"CreateVolumePermissionList", "documentation":"

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

" }, "Remove":{ "shape":"CreateVolumePermissionList", "documentation":"

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

" } } }, "CreateVolumeRequest":{ "type":"structure", "required":["AvailabilityZone"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Size":{ "shape":"Integer", "documentation":"

The size of the volume, in GiBs.

Constraints: 1-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot from which to create the volume.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

Default: standard

" }, "Iops":{ "shape":"Integer", "documentation":"

Only valid for Provisioned IOPS (SSD) volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (KMS) master key to use when creating the encrypted volume. This parameter is only required if you want to use a non-default master key; if this parameter is not specified, the default master key is used. The ARN contains the arn:aws:kms namespace, followed by the region of the master key, the AWS account ID of the master key owner, the key namespace, and then the master key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

" } } }, "CreateVpcPeeringConnectionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the requester VPC.

", "locationName":"vpcId" }, "PeerVpcId":{ "shape":"String", "documentation":"

The ID of the VPC with which you are creating the VPC peering connection.

", "locationName":"peerVpcId" }, "PeerOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

", "locationName":"peerOwnerId" } } }, "CreateVpcPeeringConnectionResult":{ "type":"structure", "members":{ "VpcPeeringConnection":{ "shape":"VpcPeeringConnection", "documentation":"

Information about the VPC peering connection.

", "locationName":"vpcPeeringConnection" } } }, "CreateVpcRequest":{ "type":"structure", "required":["CidrBlock"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The supported tenancy options for instances launched into the VPC. A value of default means that instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC are launched as dedicated tenancy instances regardless of the tenancy assigned to the instance at launch. Dedicated tenancy instances run on single-tenant hardware.

Default: default

", "locationName":"instanceTenancy" } } }, "CreateVpcResult":{ "type":"structure", "members":{ "Vpc":{ "shape":"Vpc", "documentation":"

Information about the VPC.

", "locationName":"vpc" } } }, "CreateVpnConnectionRequest":{ "type":"structure", "required":[ "Type", "CustomerGatewayId", "VpnGatewayId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Type":{ "shape":"String", "documentation":"

The type of VPN connection (ipsec.1).

" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "Options":{ "shape":"VpnConnectionOptionsSpecification", "documentation":"

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

", "locationName":"options" } } }, "CreateVpnConnectionResult":{ "type":"structure", "members":{ "VpnConnection":{ "shape":"VpnConnection", "documentation":"

Information about the VPN connection.

", "locationName":"vpnConnection" } } }, "CreateVpnConnectionRouteRequest":{ "type":"structure", "required":[ "VpnConnectionId", "DestinationCidrBlock" ], "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer network.

" } } }, "CreateVpnGatewayRequest":{ "type":"structure", "required":["Type"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection this virtual private gateway supports.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the virtual private gateway.

" } } }, "CreateVpnGatewayResult":{ "type":"structure", "members":{ "VpnGateway":{ "shape":"VpnGateway", "documentation":"

Information about the virtual private gateway.

", "locationName":"vpnGateway" } } }, "CurrencyCodeValues":{ "type":"string", "enum":["USD"] }, "CustomerGateway":{ "type":"structure", "members":{ "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

", "locationName":"customerGatewayId" }, "State":{ "shape":"String", "documentation":"

The current state of the customer gateway (pending | available | deleting | deleted).

", "locationName":"state" }, "Type":{ "shape":"String", "documentation":"

The type of VPN connection the customer gateway supports (ipsec.1).

", "locationName":"type" }, "IpAddress":{ "shape":"String", "documentation":"

The Internet-routable IP address of the customer gateway's outside interface.

", "locationName":"ipAddress" }, "BgpAsn":{ "shape":"String", "documentation":"

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", "locationName":"bgpAsn" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the customer gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes a customer gateway.

" }, "CustomerGatewayIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"CustomerGatewayId" } }, "CustomerGatewayList":{ "type":"list", "member":{ "shape":"CustomerGateway", "locationName":"item" } }, "DatafeedSubscriptionState":{ "type":"string", "enum":[ "Active", "Inactive" ] }, "DateTime":{"type":"timestamp"}, "DeleteCustomerGatewayRequest":{ "type":"structure", "required":["CustomerGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway.

" } } }, "DeleteDhcpOptionsRequest":{ "type":"structure", "required":["DhcpOptionsId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the DHCP options set.

" } } }, "DeleteInternetGatewayRequest":{ "type":"structure", "required":["InternetGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" } } }, "DeleteKeyPairRequest":{ "type":"structure", "required":["KeyName"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

" } } }, "DeleteNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Egress" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number of the entry to delete.

", "locationName":"ruleNumber" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether the rule is an egress rule.

", "locationName":"egress" } } }, "DeleteNetworkAclRequest":{ "type":"structure", "required":["NetworkAclId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" } } }, "DeleteNetworkInterfaceRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" } } }, "DeletePlacementGroupRequest":{ "type":"structure", "required":["GroupName"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

", "locationName":"groupName" } } }, "DeleteRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", "locationName":"destinationCidrBlock" } } }, "DeleteRouteTableRequest":{ "type":"structure", "required":["RouteTableId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" } } }, "DeleteSecurityGroupRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group. Required for a nondefault VPC.

" } } }, "DeleteSnapshotRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS snapshot.

" } } }, "DeleteSpotDatafeedSubscriptionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" } } }, "DeleteSubnetRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

" } } }, "DeleteTagsRequest":{ "type":"structure", "required":["Resources"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Resources":{ "shape":"ResourceIdList", "documentation":"

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

", "locationName":"resourceId" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

", "locationName":"tag" } } }, "DeleteVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" } } }, "DeleteVpcPeeringConnectionRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "DeleteVpcPeeringConnectionResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "DeleteVpcRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } } }, "DeleteVpnConnectionRequest":{ "type":"structure", "required":["VpnConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" } } }, "DeleteVpnConnectionRouteRequest":{ "type":"structure", "required":[ "VpnConnectionId", "DestinationCidrBlock" ], "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer network.

" } } }, "DeleteVpnGatewayRequest":{ "type":"structure", "required":["VpnGatewayId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } } }, "DeregisterImageRequest":{ "type":"structure", "required":["ImageId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" } } }, "DescribeAccountAttributesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AttributeNames":{ "shape":"AccountAttributeNameStringList", "documentation":"

One or more account attribute names.

", "locationName":"attributeName" } } }, "DescribeAccountAttributesResult":{ "type":"structure", "members":{ "AccountAttributes":{ "shape":"AccountAttributeList", "documentation":"

Information about one or more account attributes.

", "locationName":"accountAttributeSet" } } }, "DescribeAddressesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "PublicIps":{ "shape":"PublicIpStringList", "documentation":"

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", "locationName":"PublicIp" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

", "locationName":"Filter" }, "AllocationIds":{ "shape":"AllocationIdList", "documentation":"

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

", "locationName":"AllocationId" } } }, "DescribeAddressesResult":{ "type":"structure", "members":{ "Addresses":{ "shape":"AddressList", "documentation":"

Information about one or more Elastic IP addresses.

", "locationName":"addressesSet" } } }, "DescribeAvailabilityZonesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ZoneNames":{ "shape":"ZoneNameStringList", "documentation":"

The names of one or more Availability Zones.

", "locationName":"ZoneName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | impaired | unavailable).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", "locationName":"Filter" } } }, "DescribeAvailabilityZonesResult":{ "type":"structure", "members":{ "AvailabilityZones":{ "shape":"AvailabilityZoneList", "documentation":"

Information about one or more Availability Zones.

", "locationName":"availabilityZoneInfo" } } }, "DescribeBundleTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "BundleIds":{ "shape":"BundleIdStringList", "documentation":"

One or more bundle task IDs.

Default: Describes all your bundle tasks.

", "locationName":"BundleId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", "locationName":"Filter" } } }, "DescribeBundleTasksResult":{ "type":"structure", "members":{ "BundleTasks":{ "shape":"BundleTaskList", "documentation":"

Information about one or more bundle tasks.

", "locationName":"bundleInstanceTasksSet" } } }, "DescribeClassicLinkInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC that the instance is linked to.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

", "locationName":"maxResults" } } }, "DescribeClassicLinkInstancesResult":{ "type":"structure", "members":{ "Instances":{ "shape":"ClassicLinkInstanceList", "documentation":"

Information about one or more linked EC2-Classic instances.

", "locationName":"instancesSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeConversionTaskList":{ "type":"list", "member":{ "shape":"ConversionTask", "locationName":"item" } }, "DescribeConversionTasksRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Filters":{ "shape":"FilterList", "locationName":"filter" }, "ConversionTaskIds":{ "shape":"ConversionIdStringList", "documentation":"

One or more conversion task IDs.

", "locationName":"conversionTaskId" } } }, "DescribeConversionTasksResult":{ "type":"structure", "members":{ "ConversionTasks":{ "shape":"DescribeConversionTaskList", "locationName":"conversionTasks" } } }, "DescribeCustomerGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "CustomerGatewayIds":{ "shape":"CustomerGatewayIdStringList", "documentation":"

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", "locationName":"CustomerGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } } }, "DescribeCustomerGatewaysResult":{ "type":"structure", "members":{ "CustomerGateways":{ "shape":"CustomerGatewayList", "documentation":"

Information about one or more customer gateways.

", "locationName":"customerGatewaySet" } } }, "DescribeDhcpOptionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "DhcpOptionsIds":{ "shape":"DhcpOptionsIdStringList", "documentation":"

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", "locationName":"DhcpOptionsId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • dhcp-options-id - The ID of a set of DHCP options.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } } }, "DescribeDhcpOptionsResult":{ "type":"structure", "members":{ "DhcpOptions":{ "shape":"DhcpOptionsList", "documentation":"

Information about one or more DHCP options sets.

", "locationName":"dhcpOptionsSet" } } }, "DescribeExportTasksRequest":{ "type":"structure", "members":{ "ExportTaskIds":{ "shape":"ExportTaskIdStringList", "documentation":"

One or more export task IDs.

", "locationName":"exportTaskId" } } }, "DescribeExportTasksResult":{ "type":"structure", "members":{ "ExportTasks":{ "shape":"ExportTaskList", "locationName":"exportTaskSet" } } }, "DescribeImageAttributeRequest":{ "type":"structure", "required":[ "ImageId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"ImageAttributeName", "documentation":"

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

" } } }, "DescribeImagesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageIds":{ "shape":"ImageIdStringList", "documentation":"

One or more image IDs.

Default: Describes all images available to you.

", "locationName":"ImageId" }, "Owners":{ "shape":"OwnerStringList", "documentation":"

Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

", "locationName":"Owner" }, "ExecutableUsers":{ "shape":"ExecutableByStringList", "documentation":"

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", "locationName":"ExecutableBy" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • architecture - The image architecture (i386 | x86_64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the Amazon EBS volume (gp2 | standard | io1).

  • description - The description of the image (provided during image creation).

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - The AWS account alias (for example, amazon).

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", "locationName":"Filter" } } }, "DescribeImagesResult":{ "type":"structure", "members":{ "Images":{ "shape":"ImageList", "documentation":"

Information about one or more images.

", "locationName":"imagesSet" } } }, "DescribeInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The instance attribute.

", "locationName":"attribute" } } }, "DescribeInstanceStatusRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code identifying the type of event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.not-after - The latest end time for the scheduled event, for example: 2010-09-15T17:15:20.000Z.

  • event.not-before - The earliest start time for the scheduled event, for example: 2010-09-15T17:15:20.000Z.

  • instance-state-code - A code representing the state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

" }, "IncludeAllInstances":{ "shape":"Boolean", "documentation":"

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", "locationName":"includeAllInstances" } } }, "DescribeInstanceStatusResult":{ "type":"structure", "members":{ "InstanceStatuses":{ "shape":"InstanceStatusList", "documentation":"

One or more instance status descriptions.

", "locationName":"instanceStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

Default: Describes all your instances.

", "locationName":"InstanceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • architecture - The instance architecture (i386 | x86_64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - 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 - A Boolean that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the Amazon EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the Amazon EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance (spot).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IP address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - 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 - The time when the instance was launched.

  • monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.

  • private-dns-name - The private DNS name of the instance.

  • private-ip-address - The private IP address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - 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 - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - 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 - The name of the root device for the instance (for example, /dev/sda1 or /dev/xvda).

  • root-device-type - The type of root device that the instance uses (ebs | instance-store).

  • source-dest-check - 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 - The ID of the Spot Instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • tenancy - The tenancy of an instance (dedicated | default).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

  • network-interface.description - The description of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • network-interface.network-interface.id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface-private-dns-name - The private DNS name of the network interface.

  • network-interface.source-dest-check - 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.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.addresses.private-ip-address - The private IP address associated with the network interface.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The token to request the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

", "locationName":"maxResults" } } }, "DescribeInstancesResult":{ "type":"structure", "members":{ "Reservations":{ "shape":"ReservationList", "documentation":"

One or more reservations.

", "locationName":"reservationSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeInternetGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InternetGatewayIds":{ "shape":"ValueStringList", "documentation":"

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

", "locationName":"internetGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } } }, "DescribeInternetGatewaysResult":{ "type":"structure", "members":{ "InternetGateways":{ "shape":"InternetGatewayList", "documentation":"

Information about one or more Internet gateways.

", "locationName":"internetGatewaySet" } } }, "DescribeKeyPairsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "KeyNames":{ "shape":"KeyNameStringList", "documentation":"

One or more key pair names.

Default: Describes all your key pairs.

", "locationName":"KeyName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", "locationName":"Filter" } } }, "DescribeKeyPairsResult":{ "type":"structure", "members":{ "KeyPairs":{ "shape":"KeyPairList", "documentation":"

Information about one or more key pairs.

", "locationName":"keySet" } } }, "DescribeNetworkAclsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkAclIds":{ "shape":"ValueStringList", "documentation":"

One or more network ACL IDs.

Default: Describes all your network ACLs.

", "locationName":"NetworkAclId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The CIDR range specified in the entry.

  • entry.egress - Indicates whether the entry applies to egress traffic.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.

  • network-acl-id - The ID of the network ACL.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network ACL.

", "locationName":"Filter" } } }, "DescribeNetworkAclsResult":{ "type":"structure", "members":{ "NetworkAcls":{ "shape":"NetworkAclList", "documentation":"

Information about one or more network ACLs.

", "locationName":"networkAclSet" } } }, "DescribeNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Attribute":{ "shape":"NetworkInterfaceAttribute", "documentation":"

The attribute of the network interface.

", "locationName":"attribute" } } }, "DescribeNetworkInterfaceAttributeResult":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Description":{ "shape":"AttributeValue", "documentation":"

The description of the network interface.

", "locationName":"description" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

The security groups associated with the network interface.

", "locationName":"groupSet" }, "Attachment":{ "shape":"NetworkInterfaceAttachment", "documentation":"

The attachment (if any) of the network interface.

", "locationName":"attachment" } } }, "DescribeNetworkInterfacesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceIds":{ "shape":"NetworkInterfaceIdList", "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", "locationName":"NetworkInterfaceId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IP addresses associated with the network interface.

  • addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface.

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • attachment.attach.time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IP address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-desk-check - 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 - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network interface.

", "locationName":"filter" } } }, "DescribeNetworkInterfacesResult":{ "type":"structure", "members":{ "NetworkInterfaces":{ "shape":"NetworkInterfaceList", "documentation":"

Information about one or more network interfaces.

", "locationName":"networkInterfaceSet" } } }, "DescribePlacementGroupsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupNames":{ "shape":"PlacementGroupStringList", "documentation":"

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

", "locationName":"groupName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster).

", "locationName":"Filter" } } }, "DescribePlacementGroupsResult":{ "type":"structure", "members":{ "PlacementGroups":{ "shape":"PlacementGroupList", "documentation":"

One or more placement groups.

", "locationName":"placementGroupSet" } } }, "DescribeRegionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RegionNames":{ "shape":"RegionNameStringList", "documentation":"

The names of one or more regions.

", "locationName":"RegionName" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

  • region-name - The name of the region (for example, us-east-1).

", "locationName":"Filter" } } }, "DescribeRegionsResult":{ "type":"structure", "members":{ "Regions":{ "shape":"RegionList", "documentation":"

Information about one or more regions.

", "locationName":"regionInfo" } } }, "DescribeReservedInstancesListingsRequest":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

One or more Reserved Instance IDs.

", "locationName":"reservedInstancesId" }, "ReservedInstancesListingId":{ "shape":"String", "documentation":"

One or more Reserved Instance Listing IDs.

", "locationName":"reservedInstancesListingId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", "locationName":"filters" } } }, "DescribeReservedInstancesListingsResult":{ "type":"structure", "members":{ "ReservedInstancesListings":{ "shape":"ReservedInstancesListingList", "documentation":"

Information about the Reserved Instance listing.

", "locationName":"reservedInstancesListingsSet" } } }, "DescribeReservedInstancesModificationsRequest":{ "type":"structure", "members":{ "ReservedInstancesModificationIds":{ "shape":"ReservedInstancesModificationIdStringList", "documentation":"

IDs for the submitted modification request.

", "locationName":"ReservedInstancesModificationId" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

", "locationName":"Filter" } } }, "DescribeReservedInstancesModificationsResult":{ "type":"structure", "members":{ "ReservedInstancesModifications":{ "shape":"ReservedInstancesModificationList", "documentation":"

The Reserved Instance modification information.

", "locationName":"reservedInstancesModificationsSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeReservedInstancesOfferingsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ReservedInstancesOfferingIds":{ "shape":"ReservedInstancesOfferingIdStringList", "documentation":"

One or more Reserved Instances offering IDs.

", "locationName":"ReservedInstancesOfferingId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type on which the Reserved Instance can be used.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from AWS and Reserved Instance Marketplace are listed.

  • product-description - The description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)).

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", "locationName":"Filter" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the Reserved Instance offering. A Reserved Instance with dedicated tenancy runs on single-tenant hardware and can only be launched within a VPC.

Default: default

", "locationName":"instanceTenancy" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", "locationName":"offeringType" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

", "locationName":"maxResults" }, "IncludeMarketplace":{ "shape":"Boolean", "documentation":"

Include Marketplace offerings in the response.

" }, "MinDuration":{ "shape":"Long", "documentation":"

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

" }, "MaxDuration":{ "shape":"Long", "documentation":"

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

" }, "MaxInstanceCount":{ "shape":"Integer", "documentation":"

The maximum number of instances to filter when searching for offerings.

Default: 20

" } } }, "DescribeReservedInstancesOfferingsResult":{ "type":"structure", "members":{ "ReservedInstancesOfferings":{ "shape":"ReservedInstancesOfferingList", "documentation":"

A list of Reserved Instances offerings.

", "locationName":"reservedInstancesOfferingsSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeReservedInstancesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ReservedInstancesIds":{ "shape":"ReservedInstancesIdStringList", "documentation":"

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

", "locationName":"ReservedInstancesId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2014-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type on which the Reserved Instance can be used.

  • product-description - The product description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (pending-payment | active | payment-failed | retired).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", "locationName":"Filter" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", "locationName":"offeringType" } } }, "DescribeReservedInstancesResult":{ "type":"structure", "members":{ "ReservedInstances":{ "shape":"ReservedInstancesList", "documentation":"

A list of Reserved Instances.

", "locationName":"reservedInstancesSet" } } }, "DescribeRouteTablesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RouteTableIds":{ "shape":"ValueStringList", "documentation":"

One or more route table IDs.

Default: Describes all your route tables.

", "locationName":"RouteTableId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC.

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The CIDR range specified in a route in the table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). 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).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the route table.

", "locationName":"Filter" } } }, "DescribeRouteTablesResult":{ "type":"structure", "members":{ "RouteTables":{ "shape":"RouteTableList", "documentation":"

Information about one or more route tables.

", "locationName":"routeTableSet" } } }, "DescribeSecurityGroupsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupNames":{ "shape":"GroupNameStringList", "documentation":"

[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

", "locationName":"GroupName" }, "GroupIds":{ "shape":"GroupIdStringList", "documentation":"

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

", "locationName":"GroupId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • description - The description of the security group.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - A CIDR range that has been granted permission.

  • ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been granted permission.

  • ip-permission.group-name - The name of a security group that has been granted permission.

  • ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been granted permission.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag-key - The key of a tag assigned to the security group.

  • tag-value - The value of a tag assigned to the security group.

  • vpc-id - The ID of the VPC specified when the security group was created.

", "locationName":"Filter" } } }, "DescribeSecurityGroupsResult":{ "type":"structure", "members":{ "SecurityGroups":{ "shape":"SecurityGroupList", "documentation":"

Information about one or more security groups.

", "locationName":"securityGroupInfo" } } }, "DescribeSnapshotAttributeRequest":{ "type":"structure", "required":[ "SnapshotId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The snapshot attribute you would like to view.

" } } }, "DescribeSnapshotAttributeResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS snapshot.

", "locationName":"snapshotId" }, "CreateVolumePermissions":{ "shape":"CreateVolumePermissionList", "documentation":"

A list of permissions for creating volumes from the snapshot.

", "locationName":"createVolumePermission" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" } } }, "DescribeSnapshotsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SnapshotIds":{ "shape":"SnapshotIdStringList", "documentation":"

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

", "locationName":"SnapshotId" }, "OwnerIds":{ "shape":"OwnerStringList", "documentation":"

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

", "locationName":"Owner" }, "RestorableByUserIds":{ "shape":"RestorableByStringList", "documentation":"

One or more AWS accounts IDs that can create volumes from the snapshot.

", "locationName":"RestorableBy" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • description - A description of the snapshot.

  • owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

  • owner-id - The ID of the AWS account that owns the snapshot.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

" } } }, "DescribeSnapshotsResult":{ "type":"structure", "members":{ "Snapshots":{ "shape":"SnapshotList", "locationName":"snapshotSet" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeSpotDatafeedSubscriptionRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" } } }, "DescribeSpotDatafeedSubscriptionResult":{ "type":"structure", "members":{ "SpotDatafeedSubscription":{ "shape":"SpotDatafeedSubscription", "documentation":"

The Spot Instance data feed subscription.

", "locationName":"spotDatafeedSubscription" } } }, "DescribeSpotInstanceRequestsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SpotInstanceRequestIds":{ "shape":"SpotInstanceRequestIdList", "documentation":"

One or more Spot Instance request IDs.

", "locationName":"SpotInstanceRequestId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot Instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot Instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume (gp2 | standard | io1).

  • launch.group-id - The security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m1.small).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether monitoring is enabled for the Spot Instance.

  • launch.ramdisk-id - The RAM disk ID.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • network-interface.description - A description of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.group-name - The name of the security group associated with the network interface.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot Instance request ID.

  • spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.

  • state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide for Linux.

  • status-code - The short code describing the most recent evaluation of your Spot Instance request.

  • status-message - The message explaining the status of the Spot Instance request.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of Spot Instance request (one-time | persistent).

  • launched-availability-zone - The Availability Zone in which the bid is launched.

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", "locationName":"Filter" } } }, "DescribeSpotInstanceRequestsResult":{ "type":"structure", "members":{ "SpotInstanceRequests":{ "shape":"SpotInstanceRequestList", "documentation":"

One or more Spot Instance requests.

", "locationName":"spotInstanceRequestSet" } } }, "DescribeSpotPriceHistoryRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "StartTime":{ "shape":"DateTime", "documentation":"

The date and time, up to the past 90 days, from which to start retrieving the price history data.

", "locationName":"startTime" }, "EndTime":{ "shape":"DateTime", "documentation":"

The date and time, up to the current date, from which to stop retrieving the price history data.

", "locationName":"endTime" }, "InstanceTypes":{ "shape":"InstanceTypeList", "documentation":"

Filters the results by the specified instance types.

", "locationName":"InstanceType" }, "ProductDescriptions":{ "shape":"ProductDescriptionList", "documentation":"

Filters the results by the specified basic product descriptions.

", "locationName":"ProductDescription" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m1.small).

  • product-description - The product description for the Spot Price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot Price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - 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.

", "locationName":"Filter" }, "AvailabilityZone":{ "shape":"String", "documentation":"

Filters the results by the specified Availability Zone.

", "locationName":"availabilityZone" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" } } }, "DescribeSpotPriceHistoryResult":{ "type":"structure", "members":{ "SpotPriceHistory":{ "shape":"SpotPriceHistoryList", "documentation":"

The historical Spot Prices.

", "locationName":"spotPriceHistorySet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeSubnetsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SubnetIds":{ "shape":"SubnetIdStringList", "documentation":"

One or more subnet IDs.

Default: Describes all your subnets.

", "locationName":"SubnetId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

  • available-ip-address-count - The number of IP addresses in the subnet that are available.

  • cidrBlock - 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. You can also use cidr or cidr-block as the filter names.

  • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

  • state - The state of the subnet (pending | available).

  • subnet-id - The ID of the subnet.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the subnet.

", "locationName":"Filter" } } }, "DescribeSubnetsResult":{ "type":"structure", "members":{ "Subnets":{ "shape":"SubnetList", "documentation":"

Information about one or more subnets.

", "locationName":"subnetSet" } } }, "DescribeTagsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • key - The tag key.

  • resource-id - The resource ID.

  • resource-type - The resource type (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).

  • value - The tag value.

", "locationName":"Filter" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.

", "locationName":"maxResults" }, "NextToken":{ "shape":"String", "documentation":"

The token to retrieve the next page of results.

", "locationName":"nextToken" } } }, "DescribeTagsResult":{ "type":"structure", "members":{ "Tags":{ "shape":"TagDescriptionList", "documentation":"

A list of tags.

", "locationName":"tagSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return..

", "locationName":"nextToken" } } }, "DescribeVolumeAttributeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "Attribute":{ "shape":"VolumeAttributeName", "documentation":"

The instance attribute.

" } } }, "DescribeVolumeAttributeResult":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "AutoEnableIO":{ "shape":"AttributeBooleanValue", "documentation":"

The state of autoEnableIO attribute.

", "locationName":"autoEnableIO" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" } } }, "DescribeVolumeStatusRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeIds":{ "shape":"VolumeIdStringList", "documentation":"

One or more volume IDs.

Default: Describes all your volumes.

", "locationName":"VolumeId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

" } } }, "DescribeVolumeStatusResult":{ "type":"structure", "members":{ "VolumeStatuses":{ "shape":"VolumeStatusList", "documentation":"

A list of volumes.

", "locationName":"volumeStatusSet" }, "NextToken":{ "shape":"String", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeVolumesRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeIds":{ "shape":"VolumeIdStringList", "documentation":"

One or more volume IDs.

", "locationName":"VolumeId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - The encryption status of the volume.

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The status of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

", "locationName":"Filter" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", "locationName":"nextToken" }, "MaxResults":{ "shape":"Integer", "documentation":"

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

", "locationName":"maxResults" } } }, "DescribeVolumesResult":{ "type":"structure", "members":{ "Volumes":{ "shape":"VolumeList", "locationName":"volumeSet" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"nextToken" } } }, "DescribeVpcAttributeRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "Attribute":{ "shape":"VpcAttributeName", "documentation":"

The VPC attribute.

" } } }, "DescribeVpcAttributeResult":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "EnableDnsSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

", "locationName":"enableDnsSupport" }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

", "locationName":"enableDnsHostnames" } } }, "DescribeVpcClassicLinkRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcIds":{ "shape":"VpcClassicLinkIdList", "documentation":"

One or more VPCs for which you want to describe the ClassicLink status.

", "locationName":"VpcId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", "locationName":"Filter" } } }, "DescribeVpcClassicLinkResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"VpcClassicLinkList", "documentation":"

The ClassicLink status of one or more VPCs.

", "locationName":"vpcSet" } } }, "DescribeVpcPeeringConnectionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcPeeringConnectionIds":{ "shape":"ValueStringList", "documentation":"

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

", "locationName":"VpcPeeringConnectionId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

  • accepter-vpc-info.vpc-id - The ID of the peer VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

", "locationName":"Filter" } } }, "DescribeVpcPeeringConnectionsResult":{ "type":"structure", "members":{ "VpcPeeringConnections":{ "shape":"VpcPeeringConnectionList", "documentation":"

Information about the VPC peering connections.

", "locationName":"vpcPeeringConnectionSet" } } }, "DescribeVpcsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcIds":{ "shape":"VpcIdStringList", "documentation":"

One or more VPC IDs.

Default: Describes all your VPCs.

", "locationName":"VpcId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • cidr - 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. Must contain the slash followed by one or two digits (for example, /28).

  • dhcp-options-id - The ID of a set of DHCP options.

  • isDefault - Indicates whether the VPC is the default VPC.

  • state - The state of the VPC (pending | available).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC.

", "locationName":"Filter" } } }, "DescribeVpcsResult":{ "type":"structure", "members":{ "Vpcs":{ "shape":"VpcList", "documentation":"

Information about one or more VPCs.

", "locationName":"vpcSet" } } }, "DescribeVpnConnectionsRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnConnectionIds":{ "shape":"VpnConnectionIdStringList", "documentation":"

One or more VPN connection IDs.

Default: Describes your VPN connections.

", "locationName":"VpnConnectionId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

", "locationName":"Filter" } } }, "DescribeVpnConnectionsResult":{ "type":"structure", "members":{ "VpnConnections":{ "shape":"VpnConnectionList", "documentation":"

Information about one or more VPN connections.

", "locationName":"vpnConnectionSet" } } }, "DescribeVpnGatewaysRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnGatewayIds":{ "shape":"VpnGatewayIdStringList", "documentation":"

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

", "locationName":"VpnGatewayId" }, "Filters":{ "shape":"FilterList", "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway.

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - 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 tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

", "locationName":"Filter" } } }, "DescribeVpnGatewaysResult":{ "type":"structure", "members":{ "VpnGateways":{ "shape":"VpnGatewayList", "documentation":"

Information about one or more virtual private gateways.

", "locationName":"vpnGatewaySet" } } }, "DetachClassicLinkVpcRequest":{ "type":"structure", "required":[ "InstanceId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance to unlink from the VPC.

", "locationName":"instanceId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC to which the instance is linked.

", "locationName":"vpcId" } } }, "DetachClassicLinkVpcResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "DetachInternetGatewayRequest":{ "type":"structure", "required":[ "InternetGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "DetachNetworkInterfaceRequest":{ "type":"structure", "required":["AttachmentId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AttachmentId":{ "shape":"String", "documentation":"

The ID of the attachment.

", "locationName":"attachmentId" }, "Force":{ "shape":"Boolean", "documentation":"

Specifies whether to force a detachment.

", "locationName":"force" } } }, "DetachVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" }, "Device":{ "shape":"String", "documentation":"

The device name.

" }, "Force":{ "shape":"Boolean", "documentation":"

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

" } } }, "DetachVpnGatewayRequest":{ "type":"structure", "required":[ "VpnGatewayId", "VpcId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" } } }, "DeviceType":{ "type":"string", "enum":[ "ebs", "instance-store" ] }, "DhcpConfiguration":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The name of a DHCP option.

", "locationName":"key" }, "Values":{ "shape":"DhcpConfigurationValueList", "documentation":"

One or more values for the DHCP option.

", "locationName":"valueSet" } }, "documentation":"

Describes a DHCP configuration option.

" }, "DhcpConfigurationList":{ "type":"list", "member":{ "shape":"DhcpConfiguration", "locationName":"item" } }, "DhcpOptions":{ "type":"structure", "members":{ "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the set of DHCP options.

", "locationName":"dhcpOptionsId" }, "DhcpConfigurations":{ "shape":"DhcpConfigurationList", "documentation":"

One or more DHCP options in the set.

", "locationName":"dhcpConfigurationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the DHCP options set.

", "locationName":"tagSet" } }, "documentation":"

Describes a set of DHCP options.

" }, "DhcpOptionsIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"DhcpOptionsId" } }, "DhcpOptionsList":{ "type":"list", "member":{ "shape":"DhcpOptions", "locationName":"item" } }, "DisableVgwRoutePropagationRequest":{ "type":"structure", "required":[ "RouteTableId", "GatewayId" ], "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } } }, "DisableVpcClassicLinkRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "DisableVpcClassicLinkResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "DisassociateAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" }, "AssociationId":{ "shape":"String", "documentation":"

[EC2-VPC] The association ID. Required for EC2-VPC.

" } } }, "DisassociateRouteTableRequest":{ "type":"structure", "required":["AssociationId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID representing the current association between the route table and subnet.

", "locationName":"associationId" } } }, "DiskImage":{ "type":"structure", "members":{ "Image":{"shape":"DiskImageDetail"}, "Description":{"shape":"String"}, "Volume":{"shape":"VolumeDetail"} }, "documentation":"

Describes a disk image.

" }, "DiskImageDescription":{ "type":"structure", "required":[ "Format", "Size", "ImportManifestUrl" ], "members":{ "Format":{ "shape":"DiskImageFormat", "documentation":"

The disk image format.

", "locationName":"format" }, "Size":{ "shape":"Long", "documentation":"

The size of the disk image.

", "locationName":"size" }, "ImportManifestUrl":{ "shape":"String", "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

", "locationName":"importManifestUrl" }, "Checksum":{ "shape":"String", "documentation":"

The checksum computed for the disk image.

", "locationName":"checksum" } } }, "DiskImageDetail":{ "type":"structure", "required":[ "Format", "Bytes", "ImportManifestUrl" ], "members":{ "Format":{ "shape":"DiskImageFormat", "documentation":"

The disk image format.

", "locationName":"format" }, "Bytes":{ "shape":"Long", "locationName":"bytes" }, "ImportManifestUrl":{ "shape":"String", "documentation":"

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

", "locationName":"importManifestUrl" } } }, "DiskImageFormat":{ "type":"string", "enum":[ "VMDK", "RAW", "VHD" ] }, "DiskImageList":{ "type":"list", "member":{"shape":"DiskImage"} }, "DiskImageVolumeDescription":{ "type":"structure", "required":["Id"], "members":{ "Size":{ "shape":"Long", "documentation":"

The size of the volume.

", "locationName":"size" }, "Id":{ "shape":"String", "documentation":"

The volume identifier.

", "locationName":"id" } } }, "DomainType":{ "type":"string", "enum":[ "vpc", "standard" ] }, "Double":{"type":"double"}, "EbsBlockDevice":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

", "locationName":"snapshotId" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

Constraints: 1-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

", "locationName":"volumeSize" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the Amazon EBS volume is deleted on instance termination.

", "locationName":"deleteOnTermination" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

", "locationName":"volumeType" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide for Linux.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

", "locationName":"iops" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

", "locationName":"encrypted" } }, "documentation":"

Describes an Amazon EBS block device.

" }, "EbsInstanceBlockDevice":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS volume.

", "locationName":"volumeId" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a parameter used to set up an Amazon EBS volume in a block device mapping.

" }, "EbsInstanceBlockDeviceSpecification":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the Amazon EBS volume.

", "locationName":"volumeId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } } }, "EnableVgwRoutePropagationRequest":{ "type":"structure", "required":[ "RouteTableId", "GatewayId" ], "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

" } } }, "EnableVolumeIORequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" } } }, "EnableVpcClassicLinkRequest":{ "type":"structure", "required":["VpcId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } } }, "EnableVpcClassicLinkResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "EventCode":{ "type":"string", "enum":[ "instance-reboot", "system-reboot", "system-maintenance", "instance-retirement", "instance-stop" ] }, "ExecutableByStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ExecutableBy" } }, "ExportEnvironment":{ "type":"string", "enum":[ "citrix", "vmware", "microsoft" ] }, "ExportTask":{ "type":"structure", "members":{ "ExportTaskId":{ "shape":"String", "documentation":"

The ID of the export task.

", "locationName":"exportTaskId" }, "Description":{ "shape":"String", "documentation":"

A description of the resource being exported.

", "locationName":"description" }, "State":{ "shape":"ExportTaskState", "documentation":"

The state of the conversion task.

", "locationName":"state" }, "StatusMessage":{ "shape":"String", "documentation":"

The status message related to the export task.

", "locationName":"statusMessage" }, "InstanceExportDetails":{ "shape":"InstanceExportDetails", "documentation":"

The instance being exported.

", "locationName":"instanceExport" }, "ExportToS3Task":{ "shape":"ExportToS3Task", "locationName":"exportToS3" } }, "documentation":"

Describes an export task.

" }, "ExportTaskIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ExportTaskId" } }, "ExportTaskList":{ "type":"list", "member":{ "shape":"ExportTask", "locationName":"item" } }, "ExportTaskState":{ "type":"string", "enum":[ "active", "cancelling", "cancelled", "completed" ] }, "ExportToS3Task":{ "type":"structure", "members":{ "DiskImageFormat":{ "shape":"DiskImageFormat", "documentation":"

The format for the exported image.

", "locationName":"diskImageFormat" }, "ContainerFormat":{ "shape":"ContainerFormat", "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", "locationName":"containerFormat" }, "S3Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", "locationName":"s3Bucket" }, "S3Key":{ "shape":"String", "locationName":"s3Key" } } }, "ExportToS3TaskSpecification":{ "type":"structure", "members":{ "DiskImageFormat":{ "shape":"DiskImageFormat", "locationName":"diskImageFormat" }, "ContainerFormat":{ "shape":"ContainerFormat", "locationName":"containerFormat" }, "S3Bucket":{ "shape":"String", "locationName":"s3Bucket" }, "S3Prefix":{ "shape":"String", "documentation":"

The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

", "locationName":"s3Prefix" } } }, "Filter":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the filter. Filter names are case-sensitive.

" }, "Values":{ "shape":"ValueStringList", "documentation":"

One or more filter values. Filter values are case-sensitive.

", "locationName":"Value" } }, "documentation":"

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.

" }, "FilterList":{ "type":"list", "member":{ "shape":"Filter", "locationName":"Filter" } }, "Float":{"type":"float"}, "GatewayType":{ "type":"string", "enum":["ipsec.1"] }, "GetConsoleOutputRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

" } } }, "GetConsoleOutputResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The time the output was last updated.

", "locationName":"timestamp" }, "Output":{ "shape":"String", "documentation":"

The console output, Base64 encoded.

", "locationName":"output" } } }, "GetPasswordDataRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the Windows instance.

" } } }, "GetPasswordDataResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the Windows instance.

", "locationName":"instanceId" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The time the data was last updated.

", "locationName":"timestamp" }, "PasswordData":{ "shape":"String", "documentation":"

The password of the instance.

", "locationName":"passwordData" } } }, "GroupIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"groupId" } }, "GroupIdentifier":{ "type":"structure", "members":{ "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } }, "documentation":"

Describes a security group.

" }, "GroupIdentifierList":{ "type":"list", "member":{ "shape":"GroupIdentifier", "locationName":"item" } }, "GroupNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"GroupName" } }, "HypervisorType":{ "type":"string", "enum":[ "ovm", "xen" ] }, "IamInstanceProfile":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", "locationName":"arn" }, "Id":{ "shape":"String", "documentation":"

The ID of the instance profile.

", "locationName":"id" } }, "documentation":"

Describes an IAM instance profile.

" }, "IamInstanceProfileSpecification":{ "type":"structure", "members":{ "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", "locationName":"arn" }, "Name":{ "shape":"String", "documentation":"

The name of the instance profile.

", "locationName":"name" } }, "documentation":"

Describes an IAM instance profile.

" }, "IcmpTypeCode":{ "type":"structure", "members":{ "Type":{ "shape":"Integer", "documentation":"

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", "locationName":"type" }, "Code":{ "shape":"Integer", "documentation":"

The ICMP type. A value of -1 means all types.

", "locationName":"code" } }, "documentation":"

Describes the ICMP type and code.

" }, "Image":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "ImageLocation":{ "shape":"String", "documentation":"

The location of the AMI.

", "locationName":"imageLocation" }, "State":{ "shape":"ImageState", "documentation":"

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", "locationName":"imageState" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the image owner.

", "locationName":"imageOwnerId" }, "CreationDate":{ "shape":"String", "documentation":"

The date and time the image was created.

", "locationName":"creationDate" }, "Public":{ "shape":"Boolean", "documentation":"

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

", "locationName":"isPublic" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

Any product codes associated with the AMI.

", "locationName":"productCodes" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the image.

", "locationName":"architecture" }, "ImageType":{ "shape":"ImageTypeValues", "documentation":"

The type of image.

", "locationName":"imageType" }, "KernelId":{ "shape":"String", "documentation":"

The kernel associated with the image, if any. Only applicable for machine images.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The RAM disk associated with the image, if any. Only applicable for machine images.

", "locationName":"ramdiskId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The value is Windows for Windows AMIs; otherwise blank.

", "locationName":"platform" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Specifies whether enhanced networking is enabled.

", "locationName":"sriovNetSupport" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason for the state change.

", "locationName":"stateReason" }, "ImageOwnerAlias":{ "shape":"String", "documentation":"

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

", "locationName":"imageOwnerAlias" }, "Name":{ "shape":"String", "documentation":"

The name of the AMI that was provided during image creation.

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

The description of the AMI that was provided during image creation.

", "locationName":"description" }, "RootDeviceType":{ "shape":"DeviceType", "documentation":"

The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

", "locationName":"rootDeviceType" }, "RootDeviceName":{ "shape":"String", "documentation":"

The device name of the root device (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

Any block device mapping entries.

", "locationName":"blockDeviceMapping" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The type of virtualization of the AMI.

", "locationName":"virtualizationType" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the image.

", "locationName":"tagSet" }, "Hypervisor":{ "shape":"HypervisorType", "documentation":"

The hypervisor type of the image.

", "locationName":"hypervisor" } }, "documentation":"

Describes an image.

" }, "ImageAttribute":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "LaunchPermissions":{ "shape":"LaunchPermissionList", "documentation":"

One or more launch permissions.

", "locationName":"launchPermission" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

One or more product codes.

", "locationName":"productCodes" }, "KernelId":{ "shape":"AttributeValue", "documentation":"

The kernel ID.

", "locationName":"kernel" }, "RamdiskId":{ "shape":"AttributeValue", "documentation":"

The RAM disk ID.

", "locationName":"ramdisk" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the AMI.

", "locationName":"description" }, "SriovNetSupport":{ "shape":"AttributeValue", "locationName":"sriovNetSupport" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" } }, "documentation":"

Describes an image attribute.

" }, "ImageAttributeName":{ "type":"string", "enum":[ "description", "kernel", "ramdisk", "launchPermission", "productCodes", "blockDeviceMapping" ] }, "ImageIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ImageId" } }, "ImageList":{ "type":"list", "member":{ "shape":"Image", "locationName":"item" } }, "ImageState":{ "type":"string", "enum":[ "available", "deregistered" ] }, "ImageTypeValues":{ "type":"string", "enum":[ "machine", "kernel", "ramdisk" ] }, "ImportInstanceLaunchSpecification":{ "type":"structure", "members":{ "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the instance.

", "locationName":"architecture" }, "GroupNames":{ "shape":"SecurityGroupStringList", "documentation":"

One or more security group names.

", "locationName":"GroupName" }, "GroupIds":{ "shape":"SecurityGroupIdStringList", "documentation":"

One or more security group IDs.

", "locationName":"GroupId" }, "AdditionalInfo":{ "shape":"String", "locationName":"additionalInfo" }, "UserData":{ "shape":"UserData", "documentation":"

User data to be made available to the instance.

", "locationName":"userData" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. This is not supported for VMs imported into a VPC, which are assigned the default security group. After a VM is imported into a VPC, you can specify another security group using the AWS Management Console. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux. For more information about the Linux instance types you can import, see Before You Get Started in the Amazon Elastic Compute Cloud User Guide for Linux.

", "locationName":"instanceType" }, "Placement":{ "shape":"Placement", "locationName":"placement" }, "Monitoring":{ "shape":"Boolean", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

", "locationName":"subnetId" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] Optionally, you can use this parameter to assign the instance a specific available IP address from the IP address range of the subnet.

", "locationName":"privateIpAddress" } } }, "ImportInstanceRequest":{ "type":"structure", "required":["Platform"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Description":{ "shape":"String", "documentation":"

A description for the instance being imported.

", "locationName":"description" }, "LaunchSpecification":{ "shape":"ImportInstanceLaunchSpecification", "documentation":"

", "locationName":"launchSpecification" }, "DiskImages":{ "shape":"DiskImageList", "locationName":"diskImage" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The instance operating system.

", "locationName":"platform" } } }, "ImportInstanceResult":{ "type":"structure", "members":{ "ConversionTask":{ "shape":"ConversionTask", "locationName":"conversionTask" } } }, "ImportInstanceTaskDetails":{ "type":"structure", "required":["Volumes"], "members":{ "Volumes":{ "shape":"ImportInstanceVolumeDetailSet", "locationName":"volumes" }, "InstanceId":{ "shape":"String", "locationName":"instanceId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The instance operating system.

", "locationName":"platform" }, "Description":{ "shape":"String", "locationName":"description" } } }, "ImportInstanceVolumeDetailItem":{ "type":"structure", "required":[ "BytesConverted", "AvailabilityZone", "Image", "Volume", "Status" ], "members":{ "BytesConverted":{ "shape":"Long", "documentation":"

The number of bytes converted so far.

", "locationName":"bytesConverted" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the resulting instance will reside.

", "locationName":"availabilityZone" }, "Image":{ "shape":"DiskImageDescription", "documentation":"

The image.

", "locationName":"image" }, "Volume":{ "shape":"DiskImageVolumeDescription", "documentation":"

The volume.

", "locationName":"volume" }, "Status":{ "shape":"String", "documentation":"

The status of the import of this particular disk image.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The status information or errors related to the disk image.

", "locationName":"statusMessage" }, "Description":{ "shape":"String", "locationName":"description" } }, "documentation":"

Describes an import volume task.

" }, "ImportInstanceVolumeDetailSet":{ "type":"list", "member":{ "shape":"ImportInstanceVolumeDetailItem", "locationName":"item" } }, "ImportKeyPairRequest":{ "type":"structure", "required":[ "KeyName", "PublicKeyMaterial" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "KeyName":{ "shape":"String", "documentation":"

A unique name for the key pair.

", "locationName":"keyName" }, "PublicKeyMaterial":{ "shape":"Blob", "documentation":"

The public key. You must base64 encode the public key material before sending it to AWS.

", "locationName":"publicKeyMaterial" } } }, "ImportKeyPairResult":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The key pair name you provided.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", "locationName":"keyFingerprint" } } }, "ImportVolumeRequest":{ "type":"structure", "required":[ "AvailabilityZone", "Image", "Volume" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the resulting Amazon EBS volume.

", "locationName":"availabilityZone" }, "Image":{ "shape":"DiskImageDetail", "locationName":"image" }, "Description":{ "shape":"String", "documentation":"

An optional description for the volume being imported.

", "locationName":"description" }, "Volume":{ "shape":"VolumeDetail", "locationName":"volume" } } }, "ImportVolumeResult":{ "type":"structure", "members":{ "ConversionTask":{ "shape":"ConversionTask", "locationName":"conversionTask" } } }, "ImportVolumeTaskDetails":{ "type":"structure", "required":[ "BytesConverted", "AvailabilityZone", "Image", "Volume" ], "members":{ "BytesConverted":{ "shape":"Long", "documentation":"

The number of bytes converted so far.

", "locationName":"bytesConverted" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the resulting volume will reside.

", "locationName":"availabilityZone" }, "Description":{ "shape":"String", "documentation":"

The description you provided when starting the import volume task.

", "locationName":"description" }, "Image":{ "shape":"DiskImageDescription", "documentation":"

The image.

", "locationName":"image" }, "Volume":{ "shape":"DiskImageVolumeDescription", "documentation":"

The volume.

", "locationName":"volume" } }, "documentation":"

Describes an import volume task.

" }, "Instance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI used to launch the instance.

", "locationName":"imageId" }, "State":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

", "locationName":"instanceState" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

", "locationName":"privateDnsName" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name assigned to the instance. This name is not available until the instance enters the running state.

", "locationName":"dnsName" }, "StateTransitionReason":{ "shape":"String", "documentation":"

The reason for the most recent state transition. This might be an empty string.

", "locationName":"reason" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair, if this instance was launched with an associated key pair.

", "locationName":"keyName" }, "AmiLaunchIndex":{ "shape":"Integer", "documentation":"

The AMI launch index, which can be used to find this instance in the launch group.

", "locationName":"amiLaunchIndex" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

The product codes attached to this instance.

", "locationName":"productCodes" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "LaunchTime":{ "shape":"DateTime", "documentation":"

The time the instance was launched.

", "locationName":"launchTime" }, "Placement":{ "shape":"Placement", "documentation":"

The location where the instance launched.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The kernel associated with this instance.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The RAM disk associated with this instance.

", "locationName":"ramdiskId" }, "Platform":{ "shape":"PlatformValues", "documentation":"

The value is Windows for Windows instances; otherwise blank.

", "locationName":"platform" }, "Monitoring":{ "shape":"Monitoring", "documentation":"

The monitoring information for the instance.

", "locationName":"monitoring" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which the instance is running.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC in which the instance is running.

", "locationName":"vpcId" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address assigned to the instance.

", "locationName":"privateIpAddress" }, "PublicIpAddress":{ "shape":"String", "documentation":"

The public IP address assigned to the instance.

", "locationName":"ipAddress" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason for the most recent state transition.

", "locationName":"stateReason" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the image.

", "locationName":"architecture" }, "RootDeviceType":{ "shape":"DeviceType", "documentation":"

The root device type used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

", "locationName":"rootDeviceType" }, "RootDeviceName":{ "shape":"String", "documentation":"

The root device name (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"

Any block device mapping entries for the instance.

", "locationName":"blockDeviceMapping" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The virtualization type of the instance.

", "locationName":"virtualizationType" }, "InstanceLifecycle":{ "shape":"InstanceLifecycleType", "documentation":"

Indicates whether this is a Spot Instance.

", "locationName":"instanceLifecycle" }, "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot Instance request.

", "locationName":"spotInstanceRequestId" }, "ClientToken":{ "shape":"String", "documentation":"

The idempotency token you provided when you launched the instance.

", "locationName":"clientToken" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the instance.

", "locationName":"tagSet" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups for the instance.

", "locationName":"groupSet" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", "locationName":"sourceDestCheck" }, "Hypervisor":{ "shape":"HypervisorType", "documentation":"

The hypervisor type of the instance.

", "locationName":"hypervisor" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceList", "documentation":"

[EC2-VPC] One or more network interfaces for the instance.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfile", "documentation":"

The IAM instance profile associated with the instance.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Specifies whether enhanced networking is enabled.

", "locationName":"sriovNetSupport" } }, "documentation":"

Describes an instance.

" }, "InstanceAttribute":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "InstanceType":{ "shape":"AttributeValue", "documentation":"

The instance type.

", "locationName":"instanceType" }, "KernelId":{ "shape":"AttributeValue", "documentation":"

The kernel ID.

", "locationName":"kernel" }, "RamdiskId":{ "shape":"AttributeValue", "documentation":"

The RAM disk ID.

", "locationName":"ramdisk" }, "UserData":{ "shape":"AttributeValue", "documentation":"

The Base64-encoded MIME user data.

", "locationName":"userData" }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", "documentation":"

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ "shape":"AttributeValue", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "RootDeviceName":{ "shape":"AttributeValue", "documentation":"

The name of the root device (for example, /dev/sda1 or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingList", "documentation":"

The block device mapping of the instance.

", "locationName":"blockDeviceMapping" }, "ProductCodes":{ "shape":"ProductCodeList", "documentation":"

A list of product codes.

", "locationName":"productCodes" }, "EbsOptimized":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instance is optimized for EBS I/O.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"AttributeValue", "locationName":"sriovNetSupport" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

The security groups associated with the instance.

", "locationName":"groupSet" } }, "documentation":"

Describes an instance attribute.

" }, "InstanceAttributeName":{ "type":"string", "enum":[ "instanceType", "kernel", "ramdisk", "userData", "disableApiTermination", "instanceInitiatedShutdownBehavior", "rootDeviceName", "blockDeviceMapping", "productCodes", "sourceDestCheck", "groupSet", "ebsOptimized", "sriovNetSupport" ] }, "InstanceBlockDeviceMapping":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsInstanceBlockDevice", "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", "locationName":"ebs" } }, "documentation":"

Describes a block device mapping.

" }, "InstanceBlockDeviceMappingList":{ "type":"list", "member":{ "shape":"InstanceBlockDeviceMapping", "locationName":"item" } }, "InstanceBlockDeviceMappingSpecification":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", "locationName":"deviceName" }, "Ebs":{ "shape":"EbsInstanceBlockDeviceSpecification", "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", "locationName":"ebs" }, "VirtualName":{ "shape":"String", "documentation":"

The virtual device name.

", "locationName":"virtualName" }, "NoDevice":{ "shape":"String", "documentation":"

suppress the specified device included in the block device mapping.

", "locationName":"noDevice" } }, "documentation":"

Describes a block device mapping entry.

" }, "InstanceBlockDeviceMappingSpecificationList":{ "type":"list", "member":{ "shape":"InstanceBlockDeviceMappingSpecification", "locationName":"item" } }, "InstanceCount":{ "type":"structure", "members":{ "State":{ "shape":"ListingState", "documentation":"

The states of the listed Reserved Instances.

", "locationName":"state" }, "InstanceCount":{ "shape":"Integer", "documentation":"

he number of listed Reserved Instances in the state specified by the state.

", "locationName":"instanceCount" } }, "documentation":"

Describes a Reserved Instance listing state.

" }, "InstanceCountList":{ "type":"list", "member":{ "shape":"InstanceCount", "locationName":"item" } }, "InstanceExportDetails":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the resource being exported.

", "locationName":"instanceId" }, "TargetEnvironment":{ "shape":"ExportEnvironment", "documentation":"

The target virtualization environment.

", "locationName":"targetEnvironment" } }, "documentation":"

Describes an instance export task.

" }, "InstanceIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"InstanceId" } }, "InstanceLifecycleType":{ "type":"string", "enum":["spot"] }, "InstanceList":{ "type":"list", "member":{ "shape":"Instance", "locationName":"item" } }, "InstanceMonitoring":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Monitoring":{ "shape":"Monitoring", "documentation":"

The monitoring information.

", "locationName":"monitoring" } }, "documentation":"

Describes the monitoring information of the instance.

" }, "InstanceMonitoringList":{ "type":"list", "member":{ "shape":"InstanceMonitoring", "locationName":"item" } }, "InstanceNetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Description":{ "shape":"String", "documentation":"

The description.

", "locationName":"description" }, "OwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that created the network interface.

", "locationName":"ownerId" }, "Status":{ "shape":"NetworkInterfaceStatus", "documentation":"

The status of the network interface.

", "locationName":"status" }, "MacAddress":{ "shape":"String", "documentation":"

The MAC address.

", "locationName":"macAddress" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Indicates whether to validate network traffic to or from this network interface.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups.

", "locationName":"groupSet" }, "Attachment":{ "shape":"InstanceNetworkInterfaceAttachment", "documentation":"

The network interface attachment.

", "locationName":"attachment" }, "Association":{ "shape":"InstanceNetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP associated with the network interface.

", "locationName":"association" }, "PrivateIpAddresses":{ "shape":"InstancePrivateIpAddressList", "documentation":"

The private IP addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" } }, "documentation":"

Describes a network interface.

" }, "InstanceNetworkInterfaceAssociation":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The public IP address or Elastic IP address bound to the network interface.

", "locationName":"publicIp" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name.

", "locationName":"publicDnsName" }, "IpOwnerId":{ "shape":"String", "documentation":"

The ID of the owner of the Elastic IP address.

", "locationName":"ipOwnerId" } }, "documentation":"

Describes association information for an Elastic IP address.

" }, "InstanceNetworkInterfaceAttachment":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device on the instance for the network interface attachment.

", "locationName":"deviceIndex" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a network interface attachment.

" }, "InstanceNetworkInterfaceList":{ "type":"list", "member":{ "shape":"InstanceNetworkInterface", "locationName":"item" } }, "InstanceNetworkInterfaceSpecification":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

", "locationName":"deviceIndex" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

", "locationName":"subnetId" }, "Description":{ "shape":"String", "documentation":"

The description of the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"description" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"privateIpAddress" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", "locationName":"SecurityGroupId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

", "locationName":"deleteOnTermination" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", "documentation":"

One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.

", "locationName":"privateIpAddressesSet", "queryName":"PrivateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", "documentation":"

The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.

", "locationName":"secondaryPrivateIpAddressCount" }, "AssociatePublicIpAddress":{ "shape":"Boolean", "documentation":"

Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

", "locationName":"associatePublicIpAddress" } }, "documentation":"

Describes a network interface.

" }, "InstanceNetworkInterfaceSpecificationList":{ "type":"list", "member":{ "shape":"InstanceNetworkInterfaceSpecification", "locationName":"item" } }, "InstancePrivateIpAddress":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the network interface.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", "locationName":"primary" }, "Association":{ "shape":"InstanceNetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address for the network interface.

", "locationName":"association" } }, "documentation":"

Describes a private IP address.

" }, "InstancePrivateIpAddressList":{ "type":"list", "member":{ "shape":"InstancePrivateIpAddress", "locationName":"item" } }, "InstanceState":{ "type":"structure", "members":{ "Code":{ "shape":"Integer", "documentation":"

The low byte represents the state. The high byte is an opaque internal value and should be ignored.

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

", "locationName":"code" }, "Name":{ "shape":"InstanceStateName", "documentation":"

The current state of the instance.

", "locationName":"name" } }, "documentation":"

Describes the current state of the instance.

" }, "InstanceStateChange":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "CurrentState":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

", "locationName":"currentState" }, "PreviousState":{ "shape":"InstanceState", "documentation":"

The previous state of the instance.

", "locationName":"previousState" } }, "documentation":"

Describes an instance state change.

" }, "InstanceStateChangeList":{ "type":"list", "member":{ "shape":"InstanceStateChange", "locationName":"item" } }, "InstanceStateName":{ "type":"string", "enum":[ "pending", "running", "shutting-down", "terminated", "stopping", "stopped" ] }, "InstanceStatus":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the instance.

", "locationName":"availabilityZone" }, "Events":{ "shape":"InstanceStatusEventList", "documentation":"

Extra information regarding events associated with the instance.

", "locationName":"eventsSet" }, "InstanceState":{ "shape":"InstanceState", "documentation":"

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

", "locationName":"instanceState" }, "SystemStatus":{ "shape":"InstanceStatusSummary", "documentation":"

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

", "locationName":"systemStatus" }, "InstanceStatus":{ "shape":"InstanceStatusSummary", "documentation":"

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

", "locationName":"instanceStatus" } }, "documentation":"

Describes the status of an instance.

" }, "InstanceStatusDetails":{ "type":"structure", "members":{ "Name":{ "shape":"StatusName", "documentation":"

The type of instance status.

", "locationName":"name" }, "Status":{ "shape":"StatusType", "documentation":"

The status.

", "locationName":"status" }, "ImpairedSince":{ "shape":"DateTime", "documentation":"

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

", "locationName":"impairedSince" } }, "documentation":"

Describes the instance status.

" }, "InstanceStatusDetailsList":{ "type":"list", "member":{ "shape":"InstanceStatusDetails", "locationName":"item" } }, "InstanceStatusEvent":{ "type":"structure", "members":{ "Code":{ "shape":"EventCode", "documentation":"

The associated code of the event.

", "locationName":"code" }, "Description":{ "shape":"String", "documentation":"

A description of the event.

", "locationName":"description" }, "NotBefore":{ "shape":"DateTime", "documentation":"

The earliest scheduled start time for the event.

", "locationName":"notBefore" }, "NotAfter":{ "shape":"DateTime", "documentation":"

The latest scheduled end time for the event.

", "locationName":"notAfter" } }, "documentation":"

Describes an instance event.

" }, "InstanceStatusEventList":{ "type":"list", "member":{ "shape":"InstanceStatusEvent", "locationName":"item" } }, "InstanceStatusList":{ "type":"list", "member":{ "shape":"InstanceStatus", "locationName":"item" } }, "InstanceStatusSummary":{ "type":"structure", "members":{ "Status":{ "shape":"SummaryStatus", "documentation":"

The status.

", "locationName":"status" }, "Details":{ "shape":"InstanceStatusDetailsList", "documentation":"

The system instance health or application instance health.

", "locationName":"details" } }, "documentation":"

Describes the status of an instance.

" }, "InstanceType":{ "type":"string", "enum":[ "t1.micro", "m1.small", "m1.medium", "m1.large", "m1.xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "t2.micro", "t2.small", "t2.medium", "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", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "cc1.4xlarge", "cc2.8xlarge", "g2.2xlarge", "cg1.4xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "d2.xlarge", "d2.2xlarge", "d2.4xlarge", "d2.8xlarge" ] }, "InstanceTypeList":{ "type":"list", "member":{"shape":"InstanceType"} }, "Integer":{"type":"integer"}, "InternetGateway":{ "type":"structure", "members":{ "InternetGatewayId":{ "shape":"String", "documentation":"

The ID of the Internet gateway.

", "locationName":"internetGatewayId" }, "Attachments":{ "shape":"InternetGatewayAttachmentList", "documentation":"

Any VPCs attached to the Internet gateway.

", "locationName":"attachmentSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the Internet gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes an Internet gateway.

" }, "InternetGatewayAttachment":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"AttachmentStatus", "documentation":"

The current state of the attachment.

", "locationName":"state" } }, "documentation":"

Describes the attachment of a VPC to an Internet gateway.

" }, "InternetGatewayAttachmentList":{ "type":"list", "member":{ "shape":"InternetGatewayAttachment", "locationName":"item" } }, "InternetGatewayList":{ "type":"list", "member":{ "shape":"InternetGateway", "locationName":"item" } }, "IpPermission":{ "type":"structure", "members":{ "IpProtocol":{ "shape":"String", "documentation":"

The protocol.

When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers. (VPC only) When you call AuthorizeSecurityGroupIngress, you can use -1 to specify all.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

", "locationName":"toPort" }, "UserIdGroupPairs":{ "shape":"UserIdGroupPairList", "documentation":"

One or more security group and AWS account ID pairs.

", "locationName":"groups" }, "IpRanges":{ "shape":"IpRangeList", "documentation":"

One or more IP ranges.

", "locationName":"ipRanges" } }, "documentation":"

Describes a security group rule.

" }, "IpPermissionList":{ "type":"list", "member":{ "shape":"IpPermission", "locationName":"item" } }, "IpRange":{ "type":"structure", "members":{ "CidrIp":{ "shape":"String", "documentation":"

The CIDR range. You can either specify a CIDR range or a source security group, not both.

", "locationName":"cidrIp" } }, "documentation":"

Describes an IP range.

" }, "IpRangeList":{ "type":"list", "member":{ "shape":"IpRange", "locationName":"item" } }, "KeyNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"KeyName" } }, "KeyPair":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

The SHA-1 digest of the DER encoded private key.

", "locationName":"keyFingerprint" }, "KeyMaterial":{ "shape":"String", "documentation":"

An unencrypted PEM encoded RSA private key.

", "locationName":"keyMaterial" } }, "documentation":"

Describes a key pair.

" }, "KeyPairInfo":{ "type":"structure", "members":{ "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "KeyFingerprint":{ "shape":"String", "documentation":"

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", "locationName":"keyFingerprint" } }, "documentation":"

Describes a key pair.

" }, "KeyPairList":{ "type":"list", "member":{ "shape":"KeyPairInfo", "locationName":"item" } }, "LaunchPermission":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The AWS account ID.

", "locationName":"userId" }, "Group":{ "shape":"PermissionGroup", "documentation":"

The name of the group.

", "locationName":"group" } }, "documentation":"

Describes a launch permission.

" }, "LaunchPermissionList":{ "type":"list", "member":{ "shape":"LaunchPermission", "locationName":"item" } }, "LaunchPermissionModifications":{ "type":"structure", "members":{ "Add":{ "shape":"LaunchPermissionList", "documentation":"

The AWS account ID to add to the list of launch permissions for the AMI.

" }, "Remove":{ "shape":"LaunchPermissionList", "documentation":"

The AWS account ID to remove from the list of launch permissions for the AMI.

" } }, "documentation":"

Describes a launch permission modification.

" }, "LaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups. To request an instance in a nondefault VPC, you must specify the ID of the security group. To request an instance in EC2-Classic or a default VPC, you can specify the name or the ID of the security group.

", "locationName":"groupSet" }, "UserData":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterfaceSet" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" } }, "documentation":"

Describes the launch specification for an instance.

" }, "ListingState":{ "type":"string", "enum":[ "available", "sold", "cancelled", "pending" ] }, "ListingStatus":{ "type":"string", "enum":[ "active", "pending", "cancelled", "closed" ] }, "Long":{"type":"long"}, "ModifyImageAttributeRequest":{ "type":"structure", "required":["ImageId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"String", "documentation":"

The name of the attribute to modify.

" }, "OperationType":{ "shape":"String", "documentation":"

The operation type.

" }, "UserIds":{ "shape":"UserIdStringList", "documentation":"

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

", "locationName":"UserId" }, "UserGroups":{ "shape":"UserGroupStringList", "documentation":"

One or more user groups. This is only valid when modifying the launchPermission attribute.

", "locationName":"UserGroup" }, "ProductCodes":{ "shape":"ProductCodeStringList", "documentation":"

One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

", "locationName":"ProductCode" }, "Value":{ "shape":"String", "documentation":"

The value of the attribute being modified. This is only valid when modifying the description attribute.

" }, "LaunchPermission":{ "shape":"LaunchPermissionModifications", "documentation":"

A launch permission modification.

" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the AMI.

" } } }, "ModifyInstanceAttributeRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The name of the attribute.

", "locationName":"attribute" }, "Value":{ "shape":"String", "documentation":"

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or intanceInitiateShutdownBehavior attribute.

", "locationName":"value" }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingSpecificationList", "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

", "locationName":"blockDeviceMapping" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

" }, "DisableApiTermination":{ "shape":"AttributeBooleanValue", "documentation":"

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.

", "locationName":"disableApiTermination" }, "InstanceType":{ "shape":"AttributeValue", "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", "locationName":"instanceType" }, "Kernel":{ "shape":"AttributeValue", "documentation":"

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", "locationName":"kernel" }, "Ramdisk":{ "shape":"AttributeValue", "documentation":"

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", "locationName":"ramdisk" }, "UserData":{ "shape":"BlobAttributeValue", "documentation":"

Changes the instance's user data to the specified value.

", "locationName":"userData" }, "InstanceInitiatedShutdownBehavior":{ "shape":"AttributeValue", "documentation":"

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", "locationName":"instanceInitiatedShutdownBehavior" }, "Groups":{ "shape":"GroupIdStringList", "documentation":"

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

", "locationName":"GroupId" }, "EbsOptimized":{ "shape":"AttributeBooleanValue", "documentation":"

Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", "locationName":"ebsOptimized" }, "SriovNetSupport":{ "shape":"AttributeValue", "documentation":"

Set to simple to enable enhanced networking for the instance.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", "locationName":"sriovNetSupport" } } }, "ModifyNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "Description":{ "shape":"AttributeValue", "documentation":"

A description for the network interface.

", "locationName":"description" }, "SourceDestCheck":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"SecurityGroupIdStringList", "documentation":"

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", "locationName":"SecurityGroupId" }, "Attachment":{ "shape":"NetworkInterfaceAttachmentChanges", "documentation":"

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

", "locationName":"attachment" } } }, "ModifyReservedInstancesRequest":{ "type":"structure", "required":[ "ReservedInstancesIds", "TargetConfigurations" ], "members":{ "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" }, "ReservedInstancesIds":{ "shape":"ReservedInstancesIdStringList", "documentation":"

The IDs of the Reserved Instances to modify.

", "locationName":"ReservedInstancesId" }, "TargetConfigurations":{ "shape":"ReservedInstancesConfigurationList", "documentation":"

The configuration settings for the Reserved Instances to modify.

", "locationName":"ReservedInstancesConfigurationSetItemType" } } }, "ModifyReservedInstancesResult":{ "type":"structure", "members":{ "ReservedInstancesModificationId":{ "shape":"String", "documentation":"

The ID for the modification.

", "locationName":"reservedInstancesModificationId" } } }, "ModifySnapshotAttributeRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The snapshot attribute to modify.

" }, "OperationType":{ "shape":"String", "documentation":"

The type of operation to perform to the attribute.

" }, "UserIds":{ "shape":"UserIdStringList", "documentation":"

The account ID to modify for the snapshot.

", "locationName":"UserId" }, "GroupNames":{ "shape":"GroupNameStringList", "documentation":"

The group to modify for the snapshot.

", "locationName":"UserGroup" }, "CreateVolumePermission":{ "shape":"CreateVolumePermissionModifications", "documentation":"

A JSON representation of the snapshot attribute modification.

" } } }, "ModifySubnetAttributeRequest":{ "type":"structure", "required":["SubnetId"], "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "MapPublicIpOnLaunch":{ "shape":"AttributeBooleanValue", "documentation":"

Specify true to indicate that instances launched into the specified subnet should be assigned public IP address.

" } } }, "ModifyVolumeAttributeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

" }, "AutoEnableIO":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the volume should be auto-enabled for I/O operations.

" } } }, "ModifyVpcAttributeRequest":{ "type":"structure", "required":["VpcId"], "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "EnableDnsSupport":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

" }, "EnableDnsHostnames":{ "shape":"AttributeBooleanValue", "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You can only enable DNS hostnames if you also enable DNS support.

" } } }, "MonitorInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } } }, "MonitorInstancesResult":{ "type":"structure", "members":{ "InstanceMonitorings":{ "shape":"InstanceMonitoringList", "documentation":"

Monitoring information for one or more instances.

", "locationName":"instancesSet" } } }, "Monitoring":{ "type":"structure", "members":{ "State":{ "shape":"MonitoringState", "documentation":"

Indicates whether monitoring is enabled for the instance.

", "locationName":"state" } }, "documentation":"

Describes the monitoring for the instance.

" }, "MonitoringState":{ "type":"string", "enum":[ "disabled", "enabled", "pending" ] }, "NetworkAcl":{ "type":"structure", "members":{ "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC for the network ACL.

", "locationName":"vpcId" }, "IsDefault":{ "shape":"Boolean", "documentation":"

Indicates whether this is the default network ACL for the VPC.

", "locationName":"default" }, "Entries":{ "shape":"NetworkAclEntryList", "documentation":"

One or more entries (rules) in the network ACL.

", "locationName":"entrySet" }, "Associations":{ "shape":"NetworkAclAssociationList", "documentation":"

Any associations between the network ACL and one or more subnets

", "locationName":"associationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the network ACL.

", "locationName":"tagSet" } }, "documentation":"

Describes a network ACL.

" }, "NetworkAclAssociation":{ "type":"structure", "members":{ "NetworkAclAssociationId":{ "shape":"String", "documentation":"

The ID of the association between a network ACL and a subnet.

", "locationName":"networkAclAssociationId" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the network ACL.

", "locationName":"networkAclId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" } }, "documentation":"

Describes an association between a network ACL and a subnet.

" }, "NetworkAclAssociationList":{ "type":"list", "member":{ "shape":"NetworkAclAssociation", "locationName":"item" } }, "NetworkAclEntry":{ "type":"structure", "members":{ "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The protocol. A value of -1 means all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation.

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code.

", "locationName":"icmpTypeCode" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", "locationName":"portRange" } }, "documentation":"

Describes an entry in a network ACL.

" }, "NetworkAclEntryList":{ "type":"list", "member":{ "shape":"NetworkAclEntry", "locationName":"item" } }, "NetworkAclList":{ "type":"list", "member":{ "shape":"NetworkAcl", "locationName":"item" } }, "NetworkInterface":{ "type":"structure", "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "Description":{ "shape":"String", "documentation":"

A description.

", "locationName":"description" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the network interface.

", "locationName":"ownerId" }, "RequesterId":{ "shape":"String", "documentation":"

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", "locationName":"requesterId" }, "RequesterManaged":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is being managed by AWS.

", "locationName":"requesterManaged" }, "Status":{ "shape":"NetworkInterfaceStatus", "documentation":"

The status of the network interface.

", "locationName":"status" }, "MacAddress":{ "shape":"String", "documentation":"

The MAC address.

", "locationName":"macAddress" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The IP address of the network interface within the subnet.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "SourceDestCheck":{ "shape":"Boolean", "documentation":"

Indicates whether traffic to or from the instance is validated.

", "locationName":"sourceDestCheck" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

Any security groups for the network interface.

", "locationName":"groupSet" }, "Attachment":{ "shape":"NetworkInterfaceAttachment", "documentation":"

The network interface attachment.

", "locationName":"attachment" }, "Association":{ "shape":"NetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP associated with the network interface.

", "locationName":"association" }, "TagSet":{ "shape":"TagList", "documentation":"

Any tags assigned to the network interface.

", "locationName":"tagSet" }, "PrivateIpAddresses":{ "shape":"NetworkInterfacePrivateIpAddressList", "documentation":"

The private IP addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" } }, "documentation":"

Describes a network interface.

" }, "NetworkInterfaceAssociation":{ "type":"structure", "members":{ "PublicIp":{ "shape":"String", "documentation":"

The address of the Elastic IP address bound to the network interface.

", "locationName":"publicIp" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name.

", "locationName":"publicDnsName" }, "IpOwnerId":{ "shape":"String", "documentation":"

The ID of the Elastic IP address owner.

", "locationName":"ipOwnerId" }, "AllocationId":{ "shape":"String", "documentation":"

The allocation ID.

", "locationName":"allocationId" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID.

", "locationName":"associationId" } }, "documentation":"

Describes association information for an Elastic IP address.

" }, "NetworkInterfaceAttachment":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "InstanceOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the instance.

", "locationName":"instanceOwnerId" }, "DeviceIndex":{ "shape":"Integer", "documentation":"

The device index of the network interface attachment on the instance.

", "locationName":"deviceIndex" }, "Status":{ "shape":"AttachmentStatus", "documentation":"

The attachment state.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The timestamp indicating when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes a network interface attachment.

" }, "NetworkInterfaceAttachmentChanges":{ "type":"structure", "members":{ "AttachmentId":{ "shape":"String", "documentation":"

The ID of the network interface attachment.

", "locationName":"attachmentId" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes an attachment change.

" }, "NetworkInterfaceAttribute":{ "type":"string", "enum":[ "description", "groupSet", "sourceDestCheck", "attachment" ] }, "NetworkInterfaceIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "NetworkInterfaceList":{ "type":"list", "member":{ "shape":"NetworkInterface", "locationName":"item" } }, "NetworkInterfacePrivateIpAddress":{ "type":"structure", "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address.

", "locationName":"privateIpAddress" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name.

", "locationName":"privateDnsName" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", "locationName":"primary" }, "Association":{ "shape":"NetworkInterfaceAssociation", "documentation":"

The association information for an Elastic IP address associated with the network interface.

", "locationName":"association" } }, "documentation":"

Describes the private IP address of a network interface.

" }, "NetworkInterfacePrivateIpAddressList":{ "type":"list", "member":{ "shape":"NetworkInterfacePrivateIpAddress", "locationName":"item" } }, "NetworkInterfaceStatus":{ "type":"string", "enum":[ "available", "attaching", "in-use", "detaching" ] }, "OfferingTypeValues":{ "type":"string", "enum":[ "Heavy Utilization", "Medium Utilization", "Light Utilization", "No Upfront", "Partial Upfront", "All Upfront" ] }, "OwnerStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"Owner" } }, "PermissionGroup":{ "type":"string", "enum":["all"] }, "Placement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the instance.

", "locationName":"availabilityZone" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group the instance is in (for cluster compute instances).

", "locationName":"groupName" }, "Tenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

", "locationName":"tenancy" } }, "documentation":"

Describes the placement for the instance.

" }, "PlacementGroup":{ "type":"structure", "members":{ "GroupName":{ "shape":"String", "documentation":"

The name of the placement group.

", "locationName":"groupName" }, "Strategy":{ "shape":"PlacementStrategy", "documentation":"

The placement strategy.

", "locationName":"strategy" }, "State":{ "shape":"PlacementGroupState", "documentation":"

The state of the placement group.

", "locationName":"state" } }, "documentation":"

Describes a placement group.

" }, "PlacementGroupList":{ "type":"list", "member":{ "shape":"PlacementGroup", "locationName":"item" } }, "PlacementGroupState":{ "type":"string", "enum":[ "pending", "available", "deleting", "deleted" ] }, "PlacementGroupStringList":{ "type":"list", "member":{"shape":"String"} }, "PlacementStrategy":{ "type":"string", "enum":["cluster"] }, "PlatformValues":{ "type":"string", "enum":["Windows"] }, "PortRange":{ "type":"structure", "members":{ "From":{ "shape":"Integer", "documentation":"

The first port in the range.

", "locationName":"from" }, "To":{ "shape":"Integer", "documentation":"

The last port in the range.

", "locationName":"to" } }, "documentation":"

Describes a range of ports.

" }, "PriceSchedule":{ "type":"structure", "members":{ "Term":{ "shape":"Long", "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"

The fixed price for the term.

", "locationName":"price" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "Active":{ "shape":"Boolean", "documentation":"

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", "locationName":"active" } }, "documentation":"

Describes the price for a Reserved Instance.

" }, "PriceScheduleList":{ "type":"list", "member":{ "shape":"PriceSchedule", "locationName":"item" } }, "PriceScheduleSpecification":{ "type":"structure", "members":{ "Term":{ "shape":"Long", "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", "locationName":"term" }, "Price":{ "shape":"Double", "documentation":"

The fixed price for the term.

", "locationName":"price" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } }, "documentation":"

Describes the price for a Reserved Instance.

" }, "PriceScheduleSpecificationList":{ "type":"list", "member":{ "shape":"PriceScheduleSpecification", "locationName":"item" } }, "PricingDetail":{ "type":"structure", "members":{ "Price":{ "shape":"Double", "documentation":"

The price per instance.

", "locationName":"price" }, "Count":{ "shape":"Integer", "documentation":"

The number of instances available for the price.

", "locationName":"count" } }, "documentation":"

Describes a Reserved Instance offering.

" }, "PricingDetailsList":{ "type":"list", "member":{ "shape":"PricingDetail", "locationName":"item" } }, "PrivateIpAddressSpecification":{ "type":"structure", "required":["PrivateIpAddress"], "members":{ "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP addresses.

", "locationName":"privateIpAddress" }, "Primary":{ "shape":"Boolean", "documentation":"

Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

", "locationName":"primary" } }, "documentation":"

Describes a secondary private IP address for a network interface.

" }, "PrivateIpAddressSpecificationList":{ "type":"list", "member":{ "shape":"PrivateIpAddressSpecification", "locationName":"item" } }, "PrivateIpAddressStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"PrivateIpAddress" } }, "ProductCode":{ "type":"structure", "members":{ "ProductCodeId":{ "shape":"String", "documentation":"

The product code.

", "locationName":"productCode" }, "ProductCodeType":{ "shape":"ProductCodeValues", "documentation":"

The type of product code.

", "locationName":"type" } }, "documentation":"

Describes a product code.

" }, "ProductCodeList":{ "type":"list", "member":{ "shape":"ProductCode", "locationName":"item" } }, "ProductCodeStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ProductCode" } }, "ProductCodeValues":{ "type":"string", "enum":[ "devpay", "marketplace" ] }, "ProductDescriptionList":{ "type":"list", "member":{"shape":"String"} }, "PropagatingVgw":{ "type":"structure", "members":{ "GatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway (VGW).

", "locationName":"gatewayId" } }, "documentation":"

Describes a virtual private gateway propagating route.

" }, "PropagatingVgwList":{ "type":"list", "member":{ "shape":"PropagatingVgw", "locationName":"item" } }, "PublicIpStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"PublicIp" } }, "PurchaseReservedInstancesOfferingRequest":{ "type":"structure", "required":[ "ReservedInstancesOfferingId", "InstanceCount" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance offering to purchase.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of Reserved Instances to purchase.

" }, "LimitPrice":{ "shape":"ReservedInstanceLimitPrice", "documentation":"

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", "locationName":"limitPrice" } } }, "PurchaseReservedInstancesOfferingResult":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The IDs of the purchased Reserved Instances.

", "locationName":"reservedInstancesId" } } }, "RIProductDescription":{ "type":"string", "enum":[ "Linux/UNIX", "Linux/UNIX (Amazon VPC)", "Windows", "Windows (Amazon VPC)" ] }, "ReasonCodesList":{ "type":"list", "member":{ "shape":"ReportInstanceReasonCodes", "locationName":"item" } }, "RebootInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } } }, "RecurringCharge":{ "type":"structure", "members":{ "Frequency":{ "shape":"RecurringChargeFrequency", "documentation":"

The frequency of the recurring charge.

", "locationName":"frequency" }, "Amount":{ "shape":"Double", "documentation":"

The amount of the recurring charge.

", "locationName":"amount" } }, "documentation":"

Describes a recurring charge.

" }, "RecurringChargeFrequency":{ "type":"string", "enum":["Hourly"] }, "RecurringChargesList":{ "type":"list", "member":{ "shape":"RecurringCharge", "locationName":"item" } }, "Region":{ "type":"structure", "members":{ "RegionName":{ "shape":"String", "documentation":"

The name of the region.

", "locationName":"regionName" }, "Endpoint":{ "shape":"String", "documentation":"

The region service endpoint.

", "locationName":"regionEndpoint" } }, "documentation":"

Describes a region.

" }, "RegionList":{ "type":"list", "member":{ "shape":"Region", "locationName":"item" } }, "RegionNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"RegionName" } }, "RegisterImageRequest":{ "type":"structure", "required":["Name"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageLocation":{ "shape":"String", "documentation":"

The full path to your AMI manifest in Amazon S3 storage.

" }, "Name":{ "shape":"String", "documentation":"

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", "locationName":"name" }, "Description":{ "shape":"String", "documentation":"

A description for your AMI.

", "locationName":"description" }, "Architecture":{ "shape":"ArchitectureValues", "documentation":"

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

", "locationName":"architecture" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "RootDeviceName":{ "shape":"String", "documentation":"

The name of the root device (for example, /dev/sda1, or /dev/xvda).

", "locationName":"rootDeviceName" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

One or more block device mapping entries.

", "locationName":"BlockDeviceMapping" }, "VirtualizationType":{ "shape":"String", "documentation":"

The type of virtualization.

Default: paravirtual

", "locationName":"virtualizationType" }, "SriovNetSupport":{ "shape":"String", "documentation":"

Set to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", "locationName":"sriovNetSupport" } } }, "RegisterImageResult":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the newly registered AMI.

", "locationName":"imageId" } } }, "RejectVpcPeeringConnectionRequest":{ "type":"structure", "required":["VpcPeeringConnectionId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "RejectVpcPeeringConnectionResult":{ "type":"structure", "members":{ "Return":{ "shape":"Boolean", "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", "locationName":"return" } } }, "ReleaseAddressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "PublicIp":{ "shape":"String", "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" }, "AllocationId":{ "shape":"String", "documentation":"

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" } } }, "ReplaceNetworkAclAssociationRequest":{ "type":"structure", "required":[ "AssociationId", "NetworkAclId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The ID of the current association between the original network ACL and the subnet.

", "locationName":"associationId" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the new network ACL to associate with the subnet.

", "locationName":"networkAclId" } } }, "ReplaceNetworkAclAssociationResult":{ "type":"structure", "members":{ "NewAssociationId":{ "shape":"String", "documentation":"

The ID of the new association.

", "locationName":"newAssociationId" } } }, "ReplaceNetworkAclEntryRequest":{ "type":"structure", "required":[ "NetworkAclId", "RuleNumber", "Protocol", "RuleAction", "Egress", "CidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkAclId":{ "shape":"String", "documentation":"

The ID of the ACL.

", "locationName":"networkAclId" }, "RuleNumber":{ "shape":"Integer", "documentation":"

The rule number of the entry to replace.

", "locationName":"ruleNumber" }, "Protocol":{ "shape":"String", "documentation":"

The IP protocol. You can specify all or -1 to mean all protocols.

", "locationName":"protocol" }, "RuleAction":{ "shape":"RuleAction", "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", "locationName":"ruleAction" }, "Egress":{ "shape":"Boolean", "documentation":"

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", "locationName":"egress" }, "CidrBlock":{ "shape":"String", "documentation":"

The network range to allow or deny, in CIDR notation.

", "locationName":"cidrBlock" }, "IcmpTypeCode":{ "shape":"IcmpTypeCode", "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.

", "locationName":"Icmp" }, "PortRange":{ "shape":"PortRange", "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.

", "locationName":"portRange" } } }, "ReplaceRouteRequest":{ "type":"structure", "required":[ "RouteTableId", "DestinationCidrBlock" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of an Internet gateway or virtual private gateway.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC.

", "locationName":"instanceId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of a network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of a VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } } }, "ReplaceRouteTableAssociationRequest":{ "type":"structure", "required":[ "AssociationId", "RouteTableId" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "AssociationId":{ "shape":"String", "documentation":"

The association ID.

", "locationName":"associationId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the new route table to associate with the subnet.

", "locationName":"routeTableId" } } }, "ReplaceRouteTableAssociationResult":{ "type":"structure", "members":{ "NewAssociationId":{ "shape":"String", "documentation":"

The ID of the new association.

", "locationName":"newAssociationId" } } }, "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" ] }, "ReportInstanceStatusRequest":{ "type":"structure", "required":[ "Instances", "Status", "ReasonCodes" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "Instances":{ "shape":"InstanceIdStringList", "documentation":"

One or more instances.

", "locationName":"instanceId" }, "Status":{ "shape":"ReportStatusType", "documentation":"

The status of all instances listed.

", "locationName":"status" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time at which the reported instance health state began.

", "locationName":"startTime" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time at which the reported instance health state ended.

", "locationName":"endTime" }, "ReasonCodes":{ "shape":"ReasonCodesList", "documentation":"

One or more reason codes that describes the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems which I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

", "locationName":"reasonCode" }, "Description":{ "shape":"String", "documentation":"

Descriptive text about the health state of your instance.

", "locationName":"description" } } }, "ReportStatusType":{ "type":"string", "enum":[ "ok", "impaired" ] }, "RequestSpotInstancesRequest":{ "type":"structure", "required":["SpotPrice"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

", "locationName":"spotPrice" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The maximum number of Spot Instances to launch.

Default: 1

", "locationName":"instanceCount" }, "Type":{ "shape":"SpotInstanceType", "documentation":"

The Spot Instance request type.

Default: one-time

", "locationName":"type" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

Default: The request is effective indefinitely.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

Default: The request is effective indefinitely.

", "locationName":"validUntil" }, "LaunchGroup":{ "shape":"String", "documentation":"

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

", "locationName":"launchGroup" }, "AvailabilityZoneGroup":{ "shape":"String", "documentation":"

The user-specified name for a logical grouping of bids.

When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", "locationName":"availabilityZoneGroup" }, "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} } }, "RequestSpotInstancesResult":{ "type":"structure", "members":{ "SpotInstanceRequests":{ "shape":"SpotInstanceRequestList", "documentation":"

One or more Spot Instance requests.

", "locationName":"spotInstanceRequestSet" } } }, "Reservation":{ "type":"structure", "members":{ "ReservationId":{ "shape":"String", "documentation":"

The ID of the reservation.

", "locationName":"reservationId" }, "OwnerId":{ "shape":"String", "documentation":"

The ID of the AWS account that owns the reservation.

", "locationName":"ownerId" }, "RequesterId":{ "shape":"String", "documentation":"

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

", "locationName":"requesterId" }, "Groups":{ "shape":"GroupIdentifierList", "documentation":"

One or more security groups.

", "locationName":"groupSet" }, "Instances":{ "shape":"InstanceList", "documentation":"

One or more instances.

", "locationName":"instancesSet" } }, "documentation":"

Describes a reservation.

" }, "ReservationList":{ "type":"list", "member":{ "shape":"Reservation", "locationName":"item" } }, "ReservedInstanceLimitPrice":{ "type":"structure", "members":{ "Amount":{ "shape":"Double", "documentation":"

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", "locationName":"amount" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

", "locationName":"currencyCode" } }, "documentation":"

Describes the limit price of a Reserved Instance offering.

" }, "ReservedInstanceState":{ "type":"string", "enum":[ "payment-pending", "active", "payment-failed", "retired" ] }, "ReservedInstances":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used.

", "locationName":"instanceType" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", "locationName":"availabilityZone" }, "Start":{ "shape":"DateTime", "documentation":"

The date and time the Reserved Instance started.

", "locationName":"start" }, "End":{ "shape":"DateTime", "documentation":"

The time when the Reserved Instance expires.

", "locationName":"end" }, "Duration":{ "shape":"Long", "documentation":"

The duration of the Reserved Instance, in seconds.

", "locationName":"duration" }, "UsagePrice":{ "shape":"Float", "documentation":"

The usage price of the Reserved Instance, per hour.

", "locationName":"usagePrice" }, "FixedPrice":{ "shape":"Float", "documentation":"

The purchase price of the Reserved Instance.

", "locationName":"fixedPrice" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of Reserved Instances purchased.

", "locationName":"instanceCount" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance description.

", "locationName":"productDescription" }, "State":{ "shape":"ReservedInstanceState", "documentation":"

The state of the Reserved Instance purchase.

", "locationName":"state" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the reserved instance.

", "locationName":"instanceTenancy" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type.

", "locationName":"offeringType" }, "RecurringCharges":{ "shape":"RecurringChargesList", "documentation":"

The recurring charge tag assigned to the resource.

", "locationName":"recurringCharges" } }, "documentation":"

Describes a Reserved Instance.

" }, "ReservedInstancesConfiguration":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the modified Reserved Instances.

", "locationName":"availabilityZone" }, "Platform":{ "shape":"String", "documentation":"

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", "locationName":"platform" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of modified Reserved Instances.

", "locationName":"instanceCount" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type for the modified Reserved Instances.

", "locationName":"instanceType" } }, "documentation":"

Describes the configuration settings for the modified Reserved Instances.

" }, "ReservedInstancesConfigurationList":{ "type":"list", "member":{ "shape":"ReservedInstancesConfiguration", "locationName":"item" } }, "ReservedInstancesId":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" } }, "documentation":"

Describes the ID of a Reserved Instance.

" }, "ReservedInstancesIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstancesId" } }, "ReservedInstancesList":{ "type":"list", "member":{ "shape":"ReservedInstances", "locationName":"item" } }, "ReservedInstancesListing":{ "type":"structure", "members":{ "ReservedInstancesListingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance listing.

", "locationName":"reservedInstancesListingId" }, "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance.

", "locationName":"reservedInstancesId" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The time the listing was created.

", "locationName":"createDate" }, "UpdateDate":{ "shape":"DateTime", "documentation":"

The last modified timestamp of the listing.

", "locationName":"updateDate" }, "Status":{ "shape":"ListingStatus", "documentation":"

The status of the Reserved Instance listing.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The reason for the current status of the Reserved Instance listing. The response can be blank.

", "locationName":"statusMessage" }, "InstanceCounts":{ "shape":"InstanceCountList", "documentation":"

The number of instances in this state.

", "locationName":"instanceCounts" }, "PriceSchedules":{ "shape":"PriceScheduleList", "documentation":"

The price of the Reserved Instance listing.

", "locationName":"priceSchedules" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Describes a Reserved Instance listing.

" }, "ReservedInstancesListingList":{ "type":"list", "member":{ "shape":"ReservedInstancesListing", "locationName":"item" } }, "ReservedInstancesModification":{ "type":"structure", "members":{ "ReservedInstancesModificationId":{ "shape":"String", "documentation":"

A unique ID for the Reserved Instance modification.

", "locationName":"reservedInstancesModificationId" }, "ReservedInstancesIds":{ "shape":"ReservedIntancesIds", "documentation":"

The IDs of one or more Reserved Instances.

", "locationName":"reservedInstancesSet" }, "ModificationResults":{ "shape":"ReservedInstancesModificationResultList", "documentation":"

Contains target configurations along with their corresponding new Reserved Instance IDs.

", "locationName":"modificationResultSet" }, "CreateDate":{ "shape":"DateTime", "documentation":"

The time when the modification request was created.

", "locationName":"createDate" }, "UpdateDate":{ "shape":"DateTime", "documentation":"

The time when the modification request was last updated.

", "locationName":"updateDate" }, "EffectiveDate":{ "shape":"DateTime", "documentation":"

The time for the modification to become effective.

", "locationName":"effectiveDate" }, "Status":{ "shape":"String", "documentation":"

The status of the Reserved Instances modification request.

", "locationName":"status" }, "StatusMessage":{ "shape":"String", "documentation":"

The reason for the status.

", "locationName":"statusMessage" }, "ClientToken":{ "shape":"String", "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", "locationName":"clientToken" } }, "documentation":"

Describes a Reserved Instance modification.

" }, "ReservedInstancesModificationIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReservedInstancesModificationId" } }, "ReservedInstancesModificationList":{ "type":"list", "member":{ "shape":"ReservedInstancesModification", "locationName":"item" } }, "ReservedInstancesModificationResult":{ "type":"structure", "members":{ "ReservedInstancesId":{ "shape":"String", "documentation":"

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", "locationName":"reservedInstancesId" }, "TargetConfiguration":{ "shape":"ReservedInstancesConfiguration", "documentation":"

The target Reserved Instances configurations supplied as part of the modification request.

", "locationName":"targetConfiguration" } } }, "ReservedInstancesModificationResultList":{ "type":"list", "member":{ "shape":"ReservedInstancesModificationResult", "locationName":"item" } }, "ReservedInstancesOffering":{ "type":"structure", "members":{ "ReservedInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved Instance offering.

", "locationName":"reservedInstancesOfferingId" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type on which the Reserved Instance can be used.

", "locationName":"instanceType" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", "locationName":"availabilityZone" }, "Duration":{ "shape":"Long", "documentation":"

The duration of the Reserved Instance, in seconds.

", "locationName":"duration" }, "UsagePrice":{ "shape":"Float", "documentation":"

The usage price of the Reserved Instance, per hour.

", "locationName":"usagePrice" }, "FixedPrice":{ "shape":"Float", "documentation":"

The purchase price of the Reserved Instance.

", "locationName":"fixedPrice" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The Reserved Instance description.

", "locationName":"productDescription" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The tenancy of the reserved instance.

", "locationName":"instanceTenancy" }, "CurrencyCode":{ "shape":"CurrencyCodeValues", "documentation":"

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", "locationName":"currencyCode" }, "OfferingType":{ "shape":"OfferingTypeValues", "documentation":"

The Reserved Instance offering type.

", "locationName":"offeringType" }, "RecurringCharges":{ "shape":"RecurringChargesList", "documentation":"

The recurring charge tag assigned to the resource.

", "locationName":"recurringCharges" }, "Marketplace":{ "shape":"Boolean", "documentation":"

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

", "locationName":"marketplace" }, "PricingDetails":{ "shape":"PricingDetailsList", "documentation":"

The pricing details of the Reserved Instance offering.

", "locationName":"pricingDetailsSet" } }, "documentation":"

Describes a Reserved Instance offering.

" }, "ReservedInstancesOfferingIdStringList":{ "type":"list", "member":{"shape":"String"} }, "ReservedInstancesOfferingList":{ "type":"list", "member":{ "shape":"ReservedInstancesOffering", "locationName":"item" } }, "ReservedIntancesIds":{ "type":"list", "member":{ "shape":"ReservedInstancesId", "locationName":"item" } }, "ResetImageAttributeName":{ "type":"string", "enum":["launchPermission"] }, "ResetImageAttributeRequest":{ "type":"structure", "required":[ "ImageId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

" }, "Attribute":{ "shape":"ResetImageAttributeName", "documentation":"

The attribute to reset (currently you can only reset the launch permission attribute).

" } } }, "ResetInstanceAttributeRequest":{ "type":"structure", "required":[ "InstanceId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Attribute":{ "shape":"InstanceAttributeName", "documentation":"

The attribute to reset.

", "locationName":"attribute" } } }, "ResetNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "SourceDestCheck":{ "shape":"String", "documentation":"

The source/destination checking attribute. Resets the value to true.

", "locationName":"sourceDestCheck" } } }, "ResetSnapshotAttributeRequest":{ "type":"structure", "required":[ "SnapshotId", "Attribute" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

" }, "Attribute":{ "shape":"SnapshotAttributeName", "documentation":"

The attribute to reset (currently only the attribute for permission to create volumes can be reset).

" } } }, "ResourceIdList":{ "type":"list", "member":{"shape":"String"} }, "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" ] }, "RestorableByStringList":{ "type":"list", "member":{"shape":"String"} }, "RevokeSecurityGroupEgressRequest":{ "type":"structure", "required":["GroupId"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"sourceSecurityGroupName" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"sourceSecurityGroupOwnerId" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

", "locationName":"ipProtocol" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

", "locationName":"fromPort" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

", "locationName":"toPort" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

", "locationName":"cidrIp" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", "locationName":"ipPermissions" } } }, "RevokeSecurityGroupIngressRequest":{ "type":"structure", "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "GroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

" }, "SourceSecurityGroupName":{ "shape":"String", "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

" }, "SourceSecurityGroupOwnerId":{ "shape":"String", "documentation":"

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

" }, "IpProtocol":{ "shape":"String", "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" }, "FromPort":{ "shape":"Integer", "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" }, "ToPort":{ "shape":"Integer", "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" }, "CidrIp":{ "shape":"String", "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" } } }, "Route":{ "type":"structure", "members":{ "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block used for the destination match.

", "locationName":"destinationCidrBlock" }, "GatewayId":{ "shape":"String", "documentation":"

The ID of a gateway attached to your VPC.

", "locationName":"gatewayId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of a NAT instance in your VPC.

", "locationName":"instanceId" }, "InstanceOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the instance.

", "locationName":"instanceOwnerId" }, "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" }, "State":{ "shape":"RouteState", "documentation":"

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

", "locationName":"state" }, "Origin":{ "shape":"RouteOrigin", "documentation":"

Describes how the route was created.

  • CreateRouteTable indicates that route was automatically created when the route table was created.
  • CreateRoute indicates that the route was manually added to the route table.
  • EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
", "locationName":"origin" } }, "documentation":"

Describes a route in a route table.

" }, "RouteList":{ "type":"list", "member":{ "shape":"Route", "locationName":"item" } }, "RouteOrigin":{ "type":"string", "enum":[ "CreateRouteTable", "CreateRoute", "EnableVgwRoutePropagation" ] }, "RouteState":{ "type":"string", "enum":[ "active", "blackhole" ] }, "RouteTable":{ "type":"structure", "members":{ "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "Routes":{ "shape":"RouteList", "documentation":"

The routes in the route table.

", "locationName":"routeSet" }, "Associations":{ "shape":"RouteTableAssociationList", "documentation":"

The associations between the route table and one or more subnets.

", "locationName":"associationSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the route table.

", "locationName":"tagSet" }, "PropagatingVgws":{ "shape":"PropagatingVgwList", "documentation":"

Any virtual private gateway (VGW) propagating routes.

", "locationName":"propagatingVgwSet" } }, "documentation":"

Describes a route table.

" }, "RouteTableAssociation":{ "type":"structure", "members":{ "RouteTableAssociationId":{ "shape":"String", "documentation":"

The ID of the association between a route table and a subnet.

", "locationName":"routeTableAssociationId" }, "RouteTableId":{ "shape":"String", "documentation":"

The ID of the route table.

", "locationName":"routeTableId" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "Main":{ "shape":"Boolean", "documentation":"

Indicates whether this is the main route table.

", "locationName":"main" } }, "documentation":"

Describes an association between a route table and a subnet.

" }, "RouteTableAssociationList":{ "type":"list", "member":{ "shape":"RouteTableAssociation", "locationName":"item" } }, "RouteTableList":{ "type":"list", "member":{ "shape":"RouteTable", "locationName":"item" } }, "RuleAction":{ "type":"string", "enum":[ "allow", "deny" ] }, "RunInstancesMonitoringEnabled":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"Boolean", "documentation":"

Indicates whether monitoring is enabled for the instance.

", "locationName":"enabled" } }, "documentation":"

Describes the monitoring for the instance.

" }, "RunInstancesRequest":{ "type":"structure", "required":[ "ImageId", "MinCount", "MaxCount" ], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI, which you can get by calling DescribeImages.

" }, "MinCount":{ "shape":"Integer", "documentation":"

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" }, "MaxCount":{ "shape":"Integer", "documentation":"

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you launch an instance without specifying a key pair, you can't connect to the instance.

" }, "SecurityGroups":{ "shape":"SecurityGroupStringList", "documentation":"

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

", "locationName":"SecurityGroup" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdStringList", "documentation":"

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

", "locationName":"SecurityGroupId" }, "UserData":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data for the instances.

" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux.

Default: m1.small

" }, "Placement":{ "shape":"Placement", "documentation":"

The placement for the instance.

" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide for Linux.

" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingRequestList", "documentation":"

The block device mapping.

", "locationName":"BlockDeviceMapping" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "documentation":"

The monitoring for the instance.

" }, "SubnetId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

" }, "DisableApiTermination":{ "shape":"Boolean", "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

", "locationName":"disableApiTermination" }, "InstanceInitiatedShutdownBehavior":{ "shape":"ShutdownBehavior", "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

", "locationName":"instanceInitiatedShutdownBehavior" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.

Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.

Default: We select an IP address from the IP address range of the subnet.

", "locationName":"privateIpAddress" }, "ClientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

", "locationName":"clientToken" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"networkInterface" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

", "locationName":"ebsOptimized" } } }, "S3Storage":{ "type":"structure", "members":{ "Bucket":{ "shape":"String", "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

The beginning of the file name of the AMI.

", "locationName":"prefix" }, "AWSAccessKeyId":{ "shape":"String", "documentation":"

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

" }, "UploadPolicy":{ "shape":"Blob", "documentation":"

A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", "locationName":"uploadPolicy" }, "UploadPolicySignature":{ "shape":"String", "documentation":"

The signature of the Base64 encoded JSON document.

", "locationName":"uploadPolicySignature" } }, "documentation":"

Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI.

" }, "SecurityGroup":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the owner of the security group.

", "locationName":"ownerId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" }, "Description":{ "shape":"String", "documentation":"

A description of the security group.

", "locationName":"groupDescription" }, "IpPermissions":{ "shape":"IpPermissionList", "documentation":"

One or more inbound rules associated with the security group.

", "locationName":"ipPermissions" }, "IpPermissionsEgress":{ "shape":"IpPermissionList", "documentation":"

[EC2-VPC] One or more outbound rules associated with the security group.

", "locationName":"ipPermissionsEgress" }, "VpcId":{ "shape":"String", "documentation":"

[EC2-VPC] The ID of the VPC for the security group.

", "locationName":"vpcId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the security group.

", "locationName":"tagSet" } }, "documentation":"

Describes a security group

" }, "SecurityGroupIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroupId" } }, "SecurityGroupList":{ "type":"list", "member":{ "shape":"SecurityGroup", "locationName":"item" } }, "SecurityGroupStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroup" } }, "ShutdownBehavior":{ "type":"string", "enum":[ "stop", "terminate" ] }, "Snapshot":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot.

", "locationName":"snapshotId" }, "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "State":{ "shape":"SnapshotState", "documentation":"

The snapshot state.

", "locationName":"status" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time stamp when the snapshot was initiated.

", "locationName":"startTime" }, "Progress":{ "shape":"String", "documentation":"

The progress of the snapshot, as a percentage.

", "locationName":"progress" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the Amazon EBS snapshot owner.

", "locationName":"ownerId" }, "Description":{ "shape":"String", "documentation":"

The description for the snapshot.

", "locationName":"description" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The size of the volume, in GiB.

", "locationName":"volumeSize" }, "OwnerAlias":{ "shape":"String", "documentation":"

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

", "locationName":"ownerAlias" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the snapshot.

", "locationName":"tagSet" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the snapshot is encrypted.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the parent volume.

", "locationName":"kmsKeyId" } }, "documentation":"

Describes a snapshot.

" }, "SnapshotAttributeName":{ "type":"string", "enum":[ "productCodes", "createVolumePermission" ] }, "SnapshotIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SnapshotId" } }, "SnapshotList":{ "type":"list", "member":{ "shape":"Snapshot", "locationName":"item" } }, "SnapshotState":{ "type":"string", "enum":[ "pending", "completed", "error" ] }, "SpotDatafeedSubscription":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the account.

", "locationName":"ownerId" }, "Bucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket where the Spot Instance data feed is located.

", "locationName":"bucket" }, "Prefix":{ "shape":"String", "documentation":"

The prefix that is prepended to data feed files.

", "locationName":"prefix" }, "State":{ "shape":"DatafeedSubscriptionState", "documentation":"

The state of the Spot Instance data feed subscription.

", "locationName":"state" }, "Fault":{ "shape":"SpotInstanceStateFault", "documentation":"

The fault codes for the Spot Instance request, if any.

", "locationName":"fault" } }, "documentation":"

Describes the data feed for a Spot Instance.

" }, "SpotInstanceRequest":{ "type":"structure", "members":{ "SpotInstanceRequestId":{ "shape":"String", "documentation":"

The ID of the Spot Instance request.

", "locationName":"spotInstanceRequestId" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

", "locationName":"spotPrice" }, "Type":{ "shape":"SpotInstanceType", "documentation":"

The Spot Instance request type.

", "locationName":"type" }, "State":{ "shape":"SpotInstanceState", "documentation":"

The state of the Spot Instance request. Spot bid status information can help you track your Spot Instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide for Linux.

", "locationName":"state" }, "Fault":{ "shape":"SpotInstanceStateFault", "documentation":"

The fault codes for the Spot Instance request, if any.

", "locationName":"fault" }, "Status":{ "shape":"SpotInstanceStatus", "documentation":"

The status code and status message describing the Spot Instance request.

", "locationName":"status" }, "ValidFrom":{ "shape":"DateTime", "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.

", "locationName":"validUntil" }, "LaunchGroup":{ "shape":"String", "documentation":"

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

", "locationName":"launchGroup" }, "AvailabilityZoneGroup":{ "shape":"String", "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.

", "locationName":"availabilityZoneGroup" }, "LaunchSpecification":{ "shape":"LaunchSpecification", "documentation":"

Additional information for launching instances.

", "locationName":"launchSpecification" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID, if an instance has been launched to fulfill the Spot Instance request.

", "locationName":"instanceId" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The time stamp when the Spot Instance request was created.

", "locationName":"createTime" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

The product description associated with the Spot Instance.

", "locationName":"productDescription" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "LaunchedAvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the bid is launched.

", "locationName":"launchedAvailabilityZone" } }, "documentation":"

Describe a Spot Instance request.

" }, "SpotInstanceRequestIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"SpotInstanceRequestId" } }, "SpotInstanceRequestList":{ "type":"list", "member":{ "shape":"SpotInstanceRequest", "locationName":"item" } }, "SpotInstanceState":{ "type":"string", "enum":[ "open", "active", "closed", "cancelled", "failed" ] }, "SpotInstanceStateFault":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The reason code for the Spot Instance state change.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The message for the Spot Instance state change.

", "locationName":"message" } }, "documentation":"

Describes a Spot Instance state change.

" }, "SpotInstanceStatus":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The status code.

", "locationName":"code" }, "UpdateTime":{ "shape":"DateTime", "documentation":"

The time of the most recent status update.

", "locationName":"updateTime" }, "Message":{ "shape":"String", "documentation":"

The description for the status code.

", "locationName":"message" } }, "documentation":"

Describes the status of a Spot Instance request.

" }, "SpotInstanceType":{ "type":"string", "enum":[ "one-time", "persistent" ] }, "SpotPlacement":{ "type":"structure", "members":{ "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" }, "GroupName":{ "shape":"String", "documentation":"

The name of the placement group (for cluster instances).

", "locationName":"groupName" } }, "documentation":"

Describes Spot Instance placement.

" }, "SpotPrice":{ "type":"structure", "members":{ "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "ProductDescription":{ "shape":"RIProductDescription", "documentation":"

A general description of the AMI.

", "locationName":"productDescription" }, "SpotPrice":{ "shape":"String", "documentation":"

The maximum price (bid) that you are willing to pay for a Spot Instance.

", "locationName":"spotPrice" }, "Timestamp":{ "shape":"DateTime", "documentation":"

The date and time the request was created.

", "locationName":"timestamp" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone.

", "locationName":"availabilityZone" } }, "documentation":"

Describes the maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

" }, "SpotPriceHistoryList":{ "type":"list", "member":{ "shape":"SpotPrice", "locationName":"item" } }, "StartInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

", "locationName":"additionalInfo" }, "DryRun":{ "shape":"Boolean", "locationName":"dryRun" } } }, "StartInstancesResult":{ "type":"structure", "members":{ "StartingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more started instances.

", "locationName":"instancesSet" } } }, "StateReason":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The reason code for the state change.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

The message for the state change.

  • Server.SpotInstanceTermination: A Spot Instance was terminated due to an increase in the market price.

  • Server.InternalError: An internal error occurred during instance launch, resulting in termination.

  • Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

  • Client.InternalError: A client error caused the instance to terminate on launch.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The volume limit was exceeded.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

", "locationName":"message" } }, "documentation":"

Describes a state change.

" }, "StatusName":{ "type":"string", "enum":["reachability"] }, "StatusType":{ "type":"string", "enum":[ "passed", "failed", "insufficient-data" ] }, "StopInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" }, "Force":{ "shape":"Boolean", "documentation":"

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

", "locationName":"force" } } }, "StopInstancesResult":{ "type":"structure", "members":{ "StoppingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more stopped instances.

", "locationName":"instancesSet" } } }, "Storage":{ "type":"structure", "members":{ "S3":{ "shape":"S3Storage", "documentation":"

An Amazon S3 storage location.

" } }, "documentation":"

Describes the storage location for an instance store-backed AMI.

" }, "String":{"type":"string"}, "Subnet":{ "type":"structure", "members":{ "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet.

", "locationName":"subnetId" }, "State":{ "shape":"SubnetState", "documentation":"

The current state of the subnet.

", "locationName":"state" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC the subnet is in.

", "locationName":"vpcId" }, "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block assigned to the subnet.

", "locationName":"cidrBlock" }, "AvailableIpAddressCount":{ "shape":"Integer", "documentation":"

The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.

", "locationName":"availableIpAddressCount" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the subnet.

", "locationName":"availabilityZone" }, "DefaultForAz":{ "shape":"Boolean", "documentation":"

Indicates whether this is the default subnet for the Availability Zone.

", "locationName":"defaultForAz" }, "MapPublicIpOnLaunch":{ "shape":"Boolean", "documentation":"

Indicates whether instances launched in this subnet receive a public IP address.

", "locationName":"mapPublicIpOnLaunch" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the subnet.

", "locationName":"tagSet" } }, "documentation":"

Describes a subnet.

" }, "SubnetIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"SubnetId" } }, "SubnetList":{ "type":"list", "member":{ "shape":"Subnet", "locationName":"item" } }, "SubnetState":{ "type":"string", "enum":[ "pending", "available" ] }, "SummaryStatus":{ "type":"string", "enum":[ "ok", "impaired", "insufficient-data", "not-applicable" ] }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", "locationName":"value" } }, "documentation":"

Describes a tag.

" }, "TagDescription":{ "type":"structure", "members":{ "ResourceId":{ "shape":"String", "documentation":"

The ID of the resource. For example, ami-1a2b3c4d.

", "locationName":"resourceId" }, "ResourceType":{ "shape":"ResourceType", "documentation":"

The resource type.

", "locationName":"resourceType" }, "Key":{ "shape":"String", "documentation":"

The tag key.

", "locationName":"key" }, "Value":{ "shape":"String", "documentation":"

The tag value.

", "locationName":"value" } }, "documentation":"

Describes a tag.

" }, "TagDescriptionList":{ "type":"list", "member":{ "shape":"TagDescription", "locationName":"item" } }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"item" } }, "TelemetryStatus":{ "type":"string", "enum":[ "UP", "DOWN" ] }, "Tenancy":{ "type":"string", "enum":[ "default", "dedicated" ] }, "TerminateInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } } }, "TerminateInstancesResult":{ "type":"structure", "members":{ "TerminatingInstances":{ "shape":"InstanceStateChangeList", "documentation":"

Information about one or more terminated instances.

", "locationName":"instancesSet" } } }, "UnassignPrivateIpAddressesRequest":{ "type":"structure", "required":[ "NetworkInterfaceId", "PrivateIpAddresses" ], "members":{ "NetworkInterfaceId":{ "shape":"String", "documentation":"

The ID of the network interface.

", "locationName":"networkInterfaceId" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", "documentation":"

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

", "locationName":"privateIpAddress" } } }, "UnmonitorInstancesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "DryRun":{ "shape":"Boolean", "locationName":"dryRun" }, "InstanceIds":{ "shape":"InstanceIdStringList", "documentation":"

One or more instance IDs.

", "locationName":"InstanceId" } } }, "UnmonitorInstancesResult":{ "type":"structure", "members":{ "InstanceMonitorings":{ "shape":"InstanceMonitoringList", "documentation":"

Monitoring information for one or more instances.

", "locationName":"instancesSet" } } }, "UserData":{ "type":"structure", "members":{ "Data":{ "shape":"String", "locationName":"data" } } }, "UserGroupStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"UserGroup" } }, "UserIdGroupPair":{ "type":"structure", "members":{ "UserId":{ "shape":"String", "documentation":"

The ID of an AWS account. EC2-Classic only.

", "locationName":"userId" }, "GroupName":{ "shape":"String", "documentation":"

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use GroupId.

", "locationName":"groupName" }, "GroupId":{ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" } }, "documentation":"

Describes a security group and AWS account ID pair.

" }, "UserIdGroupPairList":{ "type":"list", "member":{ "shape":"UserIdGroupPair", "locationName":"item" } }, "UserIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"UserId" } }, "ValueStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"item" } }, "VgwTelemetry":{ "type":"structure", "members":{ "OutsideIpAddress":{ "shape":"String", "documentation":"

The Internet-routable IP address of the virtual private gateway's outside interface.

", "locationName":"outsideIpAddress" }, "Status":{ "shape":"TelemetryStatus", "documentation":"

The status of the VPN tunnel.

", "locationName":"status" }, "LastStatusChange":{ "shape":"DateTime", "documentation":"

The date and time of the last change in status.

", "locationName":"lastStatusChange" }, "StatusMessage":{ "shape":"String", "documentation":"

If an error occurs, a description of the error.

", "locationName":"statusMessage" }, "AcceptedRouteCount":{ "shape":"Integer", "documentation":"

The number of accepted routes.

", "locationName":"acceptedRouteCount" } }, "documentation":"

Describes telemetry for a VPN tunnel.

" }, "VgwTelemetryList":{ "type":"list", "member":{ "shape":"VgwTelemetry", "locationName":"item" } }, "VirtualizationType":{ "type":"string", "enum":[ "hvm", "paravirtual" ] }, "Volume":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "Size":{ "shape":"Integer", "documentation":"

The size of the volume, in GiBs.

", "locationName":"size" }, "SnapshotId":{ "shape":"String", "documentation":"

The snapshot from which the volume was created, if applicable.

", "locationName":"snapshotId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the volume.

", "locationName":"availabilityZone" }, "State":{ "shape":"VolumeState", "documentation":"

The volume state.

", "locationName":"status" }, "CreateTime":{ "shape":"DateTime", "documentation":"

The time stamp when volume creation was initiated.

", "locationName":"createTime" }, "Attachments":{ "shape":"VolumeAttachmentList", "locationName":"attachmentSet" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the volume.

", "locationName":"tagSet" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

", "locationName":"volumeType" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide for Linux.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

", "locationName":"iops" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Indicates whether the volume will be encrypted.

", "locationName":"encrypted" }, "KmsKeyId":{ "shape":"String", "documentation":"

The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the volume.

", "locationName":"kmsKeyId" } }, "documentation":"

Describes a volume.

" }, "VolumeAttachment":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The ID of the volume.

", "locationName":"volumeId" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance.

", "locationName":"instanceId" }, "Device":{ "shape":"String", "documentation":"

The device name.

", "locationName":"device" }, "State":{ "shape":"VolumeAttachmentState", "documentation":"

The attachment state of the volume.

", "locationName":"status" }, "AttachTime":{ "shape":"DateTime", "documentation":"

The time stamp when the attachment initiated.

", "locationName":"attachTime" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Indicates whether the Amazon EBS volume is deleted on instance termination.

", "locationName":"deleteOnTermination" } }, "documentation":"

Describes volume attachment details.

" }, "VolumeAttachmentList":{ "type":"list", "member":{ "shape":"VolumeAttachment", "locationName":"item" } }, "VolumeAttachmentState":{ "type":"string", "enum":[ "attaching", "attached", "detaching", "detached" ] }, "VolumeAttributeName":{ "type":"string", "enum":[ "autoEnableIO", "productCodes" ] }, "VolumeDetail":{ "type":"structure", "required":["Size"], "members":{ "Size":{ "shape":"Long", "documentation":"

The size of the volume, in GiB.

", "locationName":"size" } }, "documentation":"

Describes an Amazon EBS volume.

" }, "VolumeIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VolumeId" } }, "VolumeList":{ "type":"list", "member":{ "shape":"Volume", "locationName":"item" } }, "VolumeState":{ "type":"string", "enum":[ "creating", "available", "in-use", "deleting", "deleted", "error" ] }, "VolumeStatusAction":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The code identifying the operation, for example, enable-volume-io.

", "locationName":"code" }, "Description":{ "shape":"String", "documentation":"

A description of the operation.

", "locationName":"description" }, "EventType":{ "shape":"String", "documentation":"

The event type associated with this operation.

", "locationName":"eventType" }, "EventId":{ "shape":"String", "documentation":"

The ID of the event associated with this operation.

", "locationName":"eventId" } }, "documentation":"

Describes a volume status operation code.

" }, "VolumeStatusActionsList":{ "type":"list", "member":{ "shape":"VolumeStatusAction", "locationName":"item" } }, "VolumeStatusDetails":{ "type":"structure", "members":{ "Name":{ "shape":"VolumeStatusName", "documentation":"

The name of the volume status.

", "locationName":"name" }, "Status":{ "shape":"String", "documentation":"

The intended status of the volume status.

", "locationName":"status" } }, "documentation":"

Describes a volume status.

" }, "VolumeStatusDetailsList":{ "type":"list", "member":{ "shape":"VolumeStatusDetails", "locationName":"item" } }, "VolumeStatusEvent":{ "type":"structure", "members":{ "EventType":{ "shape":"String", "documentation":"

The type of this event.

", "locationName":"eventType" }, "Description":{ "shape":"String", "documentation":"

A description of the event.

", "locationName":"description" }, "NotBefore":{ "shape":"DateTime", "documentation":"

The earliest start time of the event.

", "locationName":"notBefore" }, "NotAfter":{ "shape":"DateTime", "documentation":"

The latest end time of the event.

", "locationName":"notAfter" }, "EventId":{ "shape":"String", "documentation":"

The ID of this event.

", "locationName":"eventId" } }, "documentation":"

Describes a volume status event.

" }, "VolumeStatusEventsList":{ "type":"list", "member":{ "shape":"VolumeStatusEvent", "locationName":"item" } }, "VolumeStatusInfo":{ "type":"structure", "members":{ "Status":{ "shape":"VolumeStatusInfoStatus", "documentation":"

The status of the volume.

", "locationName":"status" }, "Details":{ "shape":"VolumeStatusDetailsList", "documentation":"

The details of the volume status.

", "locationName":"details" } }, "documentation":"

Describes the status of a volume.

" }, "VolumeStatusInfoStatus":{ "type":"string", "enum":[ "ok", "impaired", "insufficient-data" ] }, "VolumeStatusItem":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

", "locationName":"volumeId" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone of the volume.

", "locationName":"availabilityZone" }, "VolumeStatus":{ "shape":"VolumeStatusInfo", "documentation":"

The volume status.

", "locationName":"volumeStatus" }, "Events":{ "shape":"VolumeStatusEventsList", "documentation":"

A list of events associated with the volume.

", "locationName":"eventsSet" }, "Actions":{ "shape":"VolumeStatusActionsList", "documentation":"

The details of the operation.

", "locationName":"actionsSet" } }, "documentation":"

Describes the volume status.

" }, "VolumeStatusList":{ "type":"list", "member":{ "shape":"VolumeStatusItem", "locationName":"item" } }, "VolumeStatusName":{ "type":"string", "enum":[ "io-enabled", "io-performance" ] }, "VolumeType":{ "type":"string", "enum":[ "standard", "io1", "gp2" ] }, "Vpc":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"VpcState", "documentation":"

The current state of the VPC.

", "locationName":"state" }, "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block for the VPC.

", "locationName":"cidrBlock" }, "DhcpOptionsId":{ "shape":"String", "documentation":"

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

", "locationName":"dhcpOptionsId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPC.

", "locationName":"tagSet" }, "InstanceTenancy":{ "shape":"Tenancy", "documentation":"

The allowed tenancy of instances launched into the VPC.

", "locationName":"instanceTenancy" }, "IsDefault":{ "shape":"Boolean", "documentation":"

Indicates whether the VPC is the default VPC.

", "locationName":"isDefault" } }, "documentation":"

Describes a VPC.

" }, "VpcAttachment":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "State":{ "shape":"AttachmentStatus", "documentation":"

The current state of the attachment.

", "locationName":"state" } }, "documentation":"

Describes an attachment between a virtual private gateway and a VPC.

" }, "VpcAttachmentList":{ "type":"list", "member":{ "shape":"VpcAttachment", "locationName":"item" } }, "VpcAttributeName":{ "type":"string", "enum":[ "enableDnsSupport", "enableDnsHostnames" ] }, "VpcClassicLink":{ "type":"structure", "members":{ "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" }, "ClassicLinkEnabled":{ "shape":"Boolean", "documentation":"

Indicates whether the VPC is enabled for ClassicLink.

", "locationName":"classicLinkEnabled" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPC.

", "locationName":"tagSet" } }, "documentation":"

Describes whether a VPC is enabled for ClassicLink.

" }, "VpcClassicLinkIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcId" } }, "VpcClassicLinkList":{ "type":"list", "member":{ "shape":"VpcClassicLink", "locationName":"item" } }, "VpcIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcId" } }, "VpcList":{ "type":"list", "member":{ "shape":"Vpc", "locationName":"item" } }, "VpcPeeringConnection":{ "type":"structure", "members":{ "AccepterVpcInfo":{ "shape":"VpcPeeringConnectionVpcInfo", "documentation":"

The information of the peer VPC.

", "locationName":"accepterVpcInfo" }, "ExpirationTime":{ "shape":"DateTime", "documentation":"

The time that an unaccepted VPC peering connection will expire.

", "locationName":"expirationTime" }, "RequesterVpcInfo":{ "shape":"VpcPeeringConnectionVpcInfo", "documentation":"

The information of the requester VPC.

", "locationName":"requesterVpcInfo" }, "Status":{ "shape":"VpcPeeringConnectionStateReason", "documentation":"

The status of the VPC peering connection.

", "locationName":"status" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the resource.

", "locationName":"tagSet" }, "VpcPeeringConnectionId":{ "shape":"String", "documentation":"

The ID of the VPC peering connection.

", "locationName":"vpcPeeringConnectionId" } }, "documentation":"

Describes a VPC peering connection.

" }, "VpcPeeringConnectionList":{ "type":"list", "member":{ "shape":"VpcPeeringConnection", "locationName":"item" } }, "VpcPeeringConnectionStateReason":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The status of the VPC peering connection.

", "locationName":"code" }, "Message":{ "shape":"String", "documentation":"

A message that provides more information about the status, if applicable.

", "locationName":"message" } }, "documentation":"

Describes the status of a VPC peering connection.

" }, "VpcPeeringConnectionVpcInfo":{ "type":"structure", "members":{ "CidrBlock":{ "shape":"String", "documentation":"

The CIDR block for the VPC.

", "locationName":"cidrBlock" }, "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the VPC owner.

", "locationName":"ownerId" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" } }, "documentation":"

Describes a VPC in a VPC peering connection.

" }, "VpcState":{ "type":"string", "enum":[ "pending", "available" ] }, "VpnConnection":{ "type":"structure", "members":{ "VpnConnectionId":{ "shape":"String", "documentation":"

The ID of the VPN connection.

", "locationName":"vpnConnectionId" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the VPN connection.

", "locationName":"state" }, "CustomerGatewayConfiguration":{ "shape":"String", "documentation":"

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

", "locationName":"customerGatewayConfiguration" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection.

", "locationName":"type" }, "CustomerGatewayId":{ "shape":"String", "documentation":"

The ID of the customer gateway at your end of the VPN connection.

", "locationName":"customerGatewayId" }, "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

", "locationName":"vpnGatewayId" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the VPN connection.

", "locationName":"tagSet" }, "VgwTelemetry":{ "shape":"VgwTelemetryList", "documentation":"

Information about the VPN tunnel.

", "locationName":"vgwTelemetry" }, "Options":{ "shape":"VpnConnectionOptions", "documentation":"

The VPN connection options.

", "locationName":"options" }, "Routes":{ "shape":"VpnStaticRouteList", "documentation":"

The static routes associated with the VPN connection.

", "locationName":"routes" } }, "documentation":"

Describes a VPN connection.

" }, "VpnConnectionIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpnConnectionId" } }, "VpnConnectionList":{ "type":"list", "member":{ "shape":"VpnConnection", "locationName":"item" } }, "VpnConnectionOptions":{ "type":"structure", "members":{ "StaticRoutesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "locationName":"staticRoutesOnly" } }, "documentation":"

Describes VPN connection options.

" }, "VpnConnectionOptionsSpecification":{ "type":"structure", "members":{ "StaticRoutesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", "locationName":"staticRoutesOnly" } }, "documentation":"

Describes VPN connection options.

" }, "VpnGateway":{ "type":"structure", "members":{ "VpnGatewayId":{ "shape":"String", "documentation":"

The ID of the virtual private gateway.

", "locationName":"vpnGatewayId" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the virtual private gateway.

", "locationName":"state" }, "Type":{ "shape":"GatewayType", "documentation":"

The type of VPN connection the virtual private gateway supports.

", "locationName":"type" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the virtual private gateway was created.

", "locationName":"availabilityZone" }, "VpcAttachments":{ "shape":"VpcAttachmentList", "documentation":"

Any VPCs attached to the virtual private gateway.

", "locationName":"attachments" }, "Tags":{ "shape":"TagList", "documentation":"

Any tags assigned to the virtual private gateway.

", "locationName":"tagSet" } }, "documentation":"

Describes a virtual private gateway.

" }, "VpnGatewayIdStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpnGatewayId" } }, "VpnGatewayList":{ "type":"list", "member":{ "shape":"VpnGateway", "locationName":"item" } }, "VpnState":{ "type":"string", "enum":[ "pending", "available", "deleting", "deleted" ] }, "VpnStaticRoute":{ "type":"structure", "members":{ "DestinationCidrBlock":{ "shape":"String", "documentation":"

The CIDR block associated with the local subnet of the customer data center.

", "locationName":"destinationCidrBlock" }, "Source":{ "shape":"VpnStaticRouteSource", "documentation":"

Indicates how the routes were provided.

", "locationName":"source" }, "State":{ "shape":"VpnState", "documentation":"

The current state of the static route.

", "locationName":"state" } }, "documentation":"

Describes a static route for a VPN connection.

" }, "VpnStaticRouteList":{ "type":"list", "member":{ "shape":"VpnStaticRoute", "locationName":"item" } }, "VpnStaticRouteSource":{ "type":"string", "enum":["Static"] }, "ZoneNameStringList":{ "type":"list", "member":{ "shape":"String", "locationName":"ZoneName" } }, "NewDhcpConfigurationList":{ "type":"list", "member":{ "shape":"NewDhcpConfiguration", "locationName":"item" } }, "NewDhcpConfiguration":{ "type":"structure", "members":{ "Key":{ "shape":"String", "locationName":"key" }, "Values":{ "shape":"ValueStringList", "locationName":"Value" } } }, "DhcpConfigurationValueList":{ "type":"list", "member":{ "shape":"AttributeValue", "locationName":"item" } }, "Blob":{"type":"blob"}, "BlobAttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"Blob", "locationName":"value" } } }, "RequestSpotLaunchSpecification":{ "type":"structure", "members":{ "ImageId":{ "shape":"String", "documentation":"

The ID of the AMI.

", "locationName":"imageId" }, "KeyName":{ "shape":"String", "documentation":"

The name of the key pair.

", "locationName":"keyName" }, "SecurityGroups":{ "shape":"ValueStringList", "locationName":"SecurityGroup" }, "UserData":{ "shape":"String", "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", "locationName":"userData" }, "AddressingType":{ "shape":"String", "documentation":"

Deprecated.

", "locationName":"addressingType" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The instance type.

", "locationName":"instanceType" }, "Placement":{ "shape":"SpotPlacement", "documentation":"

The placement information for the instance.

", "locationName":"placement" }, "KernelId":{ "shape":"String", "documentation":"

The ID of the kernel.

", "locationName":"kernelId" }, "RamdiskId":{ "shape":"String", "documentation":"

The ID of the RAM disk.

", "locationName":"ramdiskId" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappingList", "documentation":"

One or more block device mapping entries.

", "locationName":"blockDeviceMapping" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the subnet in which to launch the instance.

", "locationName":"subnetId" }, "NetworkInterfaces":{ "shape":"InstanceNetworkInterfaceSpecificationList", "documentation":"

One or more network interfaces.

", "locationName":"NetworkInterface" }, "IamInstanceProfile":{ "shape":"IamInstanceProfileSpecification", "documentation":"

The IAM instance profile.

", "locationName":"iamInstanceProfile" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", "locationName":"ebsOptimized" }, "Monitoring":{ "shape":"RunInstancesMonitoringEnabled", "locationName":"monitoring" }, "SecurityGroupIds":{ "shape":"ValueStringList", "locationName":"SecurityGroupId" } }, "documentation":"

Describes the launch specification for an instance.

" } } } botocore-1.5.7/botocore/data/cloudhsm/0000777454262600001440000000000013042511307020751 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudhsm/2014-05-30/0000777454262600001440000000000013042511307022001 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudhsm/2014-05-30/service-2.json0000666454262600001440000011443413042511306024501 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2014-05-30", "endpointPrefix":"cloudhsm", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"CloudHSM", "serviceFullName":"Amazon CloudHSM", "signatureVersion":"v4", "targetPrefix":"CloudHsmFrontendService", "uid":"cloudhsm-2014-05-30" }, "operations":{ "AddTagsToResource":{ "name":"AddTagsToResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsToResourceRequest"}, "output":{"shape":"AddTagsToResourceResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Adds or overwrites one or more tags for the specified AWS CloudHSM resource.

Each tag consists of a key and a value. Tag keys must be unique to each resource.

" }, "CreateHapg":{ "name":"CreateHapg", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateHapgRequest"}, "output":{"shape":"CreateHapgResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

" }, "CreateHsm":{ "name":"CreateHsm", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateHsmRequest"}, "output":{"shape":"CreateHsmResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Creates an uninitialized HSM instance.

There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support.

It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.

" }, "CreateLunaClient":{ "name":"CreateLunaClient", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateLunaClientRequest"}, "output":{"shape":"CreateLunaClientResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Creates an HSM client.

" }, "DeleteHapg":{ "name":"DeleteHapg", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteHapgRequest"}, "output":{"shape":"DeleteHapgResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Deletes a high-availability partition group.

" }, "DeleteHsm":{ "name":"DeleteHsm", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteHsmRequest"}, "output":{"shape":"DeleteHsmResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

" }, "DeleteLunaClient":{ "name":"DeleteLunaClient", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteLunaClientRequest"}, "output":{"shape":"DeleteLunaClientResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Deletes a client.

" }, "DescribeHapg":{ "name":"DescribeHapg", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHapgRequest"}, "output":{"shape":"DescribeHapgResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Retrieves information about a high-availability partition group.

" }, "DescribeHsm":{ "name":"DescribeHsm", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHsmRequest"}, "output":{"shape":"DescribeHsmResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

" }, "DescribeLunaClient":{ "name":"DescribeLunaClient", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLunaClientRequest"}, "output":{"shape":"DescribeLunaClientResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Retrieves information about an HSM client.

" }, "GetConfig":{ "name":"GetConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetConfigRequest"}, "output":{"shape":"GetConfigResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.

" }, "ListAvailableZones":{ "name":"ListAvailableZones", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAvailableZonesRequest"}, "output":{"shape":"ListAvailableZonesResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Lists the Availability Zones that have available AWS CloudHSM capacity.

" }, "ListHapgs":{ "name":"ListHapgs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListHapgsRequest"}, "output":{"shape":"ListHapgsResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Lists the high-availability partition groups for the account.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.

" }, "ListHsms":{ "name":"ListHsms", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListHsmsRequest"}, "output":{"shape":"ListHsmsResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Retrieves the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

" }, "ListLunaClients":{ "name":"ListLunaClients", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListLunaClientsRequest"}, "output":{"shape":"ListLunaClientsResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Lists all of the clients.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Returns a list of all tags for the specified AWS CloudHSM resource.

" }, "ModifyHapg":{ "name":"ModifyHapg", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyHapgRequest"}, "output":{"shape":"ModifyHapgResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Modifies an existing high-availability partition group.

" }, "ModifyHsm":{ "name":"ModifyHsm", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyHsmRequest"}, "output":{"shape":"ModifyHsmResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Modifies an HSM.

This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.

" }, "ModifyLunaClient":{ "name":"ModifyLunaClient", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyLunaClientRequest"}, "output":{"shape":"ModifyLunaClientResponse"}, "errors":[ {"shape":"CloudHsmServiceException"} ], "documentation":"

Modifies the certificate used by the client.

This action can potentially start a workflow to install the new certificate on the client's HSMs.

" }, "RemoveTagsFromResource":{ "name":"RemoveTagsFromResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTagsFromResourceRequest"}, "output":{"shape":"RemoveTagsFromResourceResponse"}, "errors":[ {"shape":"CloudHsmServiceException"}, {"shape":"CloudHsmInternalException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Removes one or more tags from the specified AWS CloudHSM resource.

To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.

" } }, "shapes":{ "AZ":{ "type":"string", "pattern":"[a-zA-Z0-9\\-]*" }, "AZList":{ "type":"list", "member":{"shape":"AZ"} }, "AddTagsToResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagList" ], "members":{ "ResourceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.

" }, "TagList":{ "shape":"TagList", "documentation":"

One or more tags.

" } } }, "AddTagsToResourceResponse":{ "type":"structure", "required":["Status"], "members":{ "Status":{ "shape":"String", "documentation":"

The status of the operation.

" } } }, "Boolean":{"type":"boolean"}, "Certificate":{ "type":"string", "max":2400, "min":600, "pattern":"[\\w :+=./\\n-]*" }, "CertificateFingerprint":{ "type":"string", "pattern":"([0-9a-fA-F][0-9a-fA-F]:){15}[0-9a-fA-F][0-9a-fA-F]" }, "ClientArn":{ "type":"string", "pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:client-[0-9a-f]{8}" }, "ClientLabel":{ "type":"string", "pattern":"[a-zA-Z0-9_.-]{2,64}" }, "ClientList":{ "type":"list", "member":{"shape":"ClientArn"} }, "ClientToken":{ "type":"string", "pattern":"[a-zA-Z0-9]{1,64}" }, "ClientVersion":{ "type":"string", "enum":[ "5.1", "5.3" ] }, "CloudHsmInternalException":{ "type":"structure", "members":{ }, "documentation":"

Indicates that an internal error occurred.

", "exception":true, "fault":true }, "CloudHsmObjectState":{ "type":"string", "enum":[ "READY", "UPDATING", "DEGRADED" ] }, "CloudHsmServiceException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

Additional information about the error.

" }, "retryable":{ "shape":"Boolean", "documentation":"

Indicates if the action can be retried.

" } }, "documentation":"

Indicates that an exception occurred in the AWS CloudHSM service.

", "exception":true }, "CreateHapgRequest":{ "type":"structure", "required":["Label"], "members":{ "Label":{ "shape":"Label", "documentation":"

The label of the new high-availability partition group.

" } }, "documentation":"

Contains the inputs for the CreateHapgRequest action.

" }, "CreateHapgResponse":{ "type":"structure", "members":{ "HapgArn":{ "shape":"HapgArn", "documentation":"

The ARN of the high-availability partition group.

" } }, "documentation":"

Contains the output of the CreateHAPartitionGroup action.

" }, "CreateHsmRequest":{ "type":"structure", "required":[ "SubnetId", "SshKey", "IamRoleArn", "SubscriptionType" ], "members":{ "SubnetId":{ "shape":"SubnetId", "documentation":"

The identifier of the subnet in your VPC in which to place the HSM.

", "locationName":"SubnetId" }, "SshKey":{ "shape":"SshKey", "documentation":"

The SSH public key to install on the HSM.

", "locationName":"SshKey" }, "EniIp":{ "shape":"IpAddress", "documentation":"

The IP address to assign to the HSM's ENI.

If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.

", "locationName":"EniIp" }, "IamRoleArn":{ "shape":"IamRoleArn", "documentation":"

The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

", "locationName":"IamRoleArn" }, "ExternalId":{ "shape":"ExternalId", "documentation":"

The external ID from IamRoleArn, if present.

", "locationName":"ExternalId" }, "SubscriptionType":{ "shape":"SubscriptionType", "locationName":"SubscriptionType" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.

", "locationName":"ClientToken" }, "SyslogIp":{ "shape":"IpAddress", "documentation":"

The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

", "locationName":"SyslogIp" } }, "documentation":"

Contains the inputs for the CreateHsm operation.

", "locationName":"CreateHsmRequest" }, "CreateHsmResponse":{ "type":"structure", "members":{ "HsmArn":{ "shape":"HsmArn", "documentation":"

The ARN of the HSM.

" } }, "documentation":"

Contains the output of the CreateHsm operation.

" }, "CreateLunaClientRequest":{ "type":"structure", "required":["Certificate"], "members":{ "Label":{ "shape":"ClientLabel", "documentation":"

The label for the client.

" }, "Certificate":{ "shape":"Certificate", "documentation":"

The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.

" } }, "documentation":"

Contains the inputs for the CreateLunaClient action.

" }, "CreateLunaClientResponse":{ "type":"structure", "members":{ "ClientArn":{ "shape":"ClientArn", "documentation":"

The ARN of the client.

" } }, "documentation":"

Contains the output of the CreateLunaClient action.

" }, "DeleteHapgRequest":{ "type":"structure", "required":["HapgArn"], "members":{ "HapgArn":{ "shape":"HapgArn", "documentation":"

The ARN of the high-availability partition group to delete.

" } }, "documentation":"

Contains the inputs for the DeleteHapg action.

" }, "DeleteHapgResponse":{ "type":"structure", "required":["Status"], "members":{ "Status":{ "shape":"String", "documentation":"

The status of the action.

" } }, "documentation":"

Contains the output of the DeleteHapg action.

" }, "DeleteHsmRequest":{ "type":"structure", "required":["HsmArn"], "members":{ "HsmArn":{ "shape":"HsmArn", "documentation":"

The ARN of the HSM to delete.

", "locationName":"HsmArn" } }, "documentation":"

Contains the inputs for the DeleteHsm operation.

", "locationName":"DeleteHsmRequest" }, "DeleteHsmResponse":{ "type":"structure", "required":["Status"], "members":{ "Status":{ "shape":"String", "documentation":"

The status of the operation.

" } }, "documentation":"

Contains the output of the DeleteHsm operation.

" }, "DeleteLunaClientRequest":{ "type":"structure", "required":["ClientArn"], "members":{ "ClientArn":{ "shape":"ClientArn", "documentation":"

The ARN of the client to delete.

" } } }, "DeleteLunaClientResponse":{ "type":"structure", "required":["Status"], "members":{ "Status":{ "shape":"String", "documentation":"

The status of the action.

" } } }, "DescribeHapgRequest":{ "type":"structure", "required":["HapgArn"], "members":{ "HapgArn":{ "shape":"HapgArn", "documentation":"

The ARN of the high-availability partition group to describe.

" } }, "documentation":"

Contains the inputs for the DescribeHapg action.

" }, "DescribeHapgResponse":{ "type":"structure", "members":{ "HapgArn":{ "shape":"HapgArn", "documentation":"

The ARN of the high-availability partition group.

" }, "HapgSerial":{ "shape":"String", "documentation":"

The serial number of the high-availability partition group.

" }, "HsmsLastActionFailed":{"shape":"HsmList"}, "HsmsPendingDeletion":{"shape":"HsmList"}, "HsmsPendingRegistration":{"shape":"HsmList"}, "Label":{ "shape":"Label", "documentation":"

The label for the high-availability partition group.

" }, "LastModifiedTimestamp":{ "shape":"Timestamp", "documentation":"

The date and time the high-availability partition group was last modified.

" }, "PartitionSerialList":{ "shape":"PartitionSerialList", "documentation":"

The list of partition serial numbers that belong to the high-availability partition group.

" }, "State":{ "shape":"CloudHsmObjectState", "documentation":"

The state of the high-availability partition group.

" } }, "documentation":"

Contains the output of the DescribeHapg action.

" }, "DescribeHsmRequest":{ "type":"structure", "members":{ "HsmArn":{ "shape":"HsmArn", "documentation":"

The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.

" }, "HsmSerialNumber":{ "shape":"HsmSerialNumber", "documentation":"

The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.

" } }, "documentation":"

Contains the inputs for the DescribeHsm operation.

" }, "DescribeHsmResponse":{ "type":"structure", "members":{ "HsmArn":{ "shape":"HsmArn", "documentation":"

The ARN of the HSM.

" }, "Status":{ "shape":"HsmStatus", "documentation":"

The status of the HSM.

" }, "StatusDetails":{ "shape":"String", "documentation":"

Contains additional information about the status of the HSM.

" }, "AvailabilityZone":{ "shape":"AZ", "documentation":"

The Availability Zone that the HSM is in.

" }, "EniId":{ "shape":"EniId", "documentation":"

The identifier of the elastic network interface (ENI) attached to the HSM.

" }, "EniIp":{ "shape":"IpAddress", "documentation":"

The IP address assigned to the HSM's ENI.

" }, "SubscriptionType":{"shape":"SubscriptionType"}, "SubscriptionStartDate":{ "shape":"Timestamp", "documentation":"

The subscription start date.

" }, "SubscriptionEndDate":{ "shape":"Timestamp", "documentation":"

The subscription end date.

" }, "VpcId":{ "shape":"VpcId", "documentation":"

The identifier of the VPC that the HSM is in.

" }, "SubnetId":{ "shape":"SubnetId", "documentation":"

The identifier of the subnet that the HSM is in.

" }, "IamRoleArn":{ "shape":"IamRoleArn", "documentation":"

The ARN of the IAM role assigned to the HSM.

" }, "SerialNumber":{ "shape":"HsmSerialNumber", "documentation":"

The serial number of the HSM.

" }, "VendorName":{ "shape":"String", "documentation":"

The name of the HSM vendor.

" }, "HsmType":{ "shape":"String", "documentation":"

The HSM model type.

" }, "SoftwareVersion":{ "shape":"String", "documentation":"

The HSM software version.

" }, "SshPublicKey":{ "shape":"SshKey", "documentation":"

The public SSH key.

" }, "SshKeyLastUpdated":{ "shape":"Timestamp", "documentation":"

The date and time that the SSH key was last updated.

" }, "ServerCertUri":{ "shape":"String", "documentation":"

The URI of the certificate server.

" }, "ServerCertLastUpdated":{ "shape":"Timestamp", "documentation":"

The date and time that the server certificate was last updated.

" }, "Partitions":{ "shape":"PartitionList", "documentation":"

The list of partitions on the HSM.

" } }, "documentation":"

Contains the output of the DescribeHsm operation.

" }, "DescribeLunaClientRequest":{ "type":"structure", "members":{ "ClientArn":{ "shape":"ClientArn", "documentation":"

The ARN of the client.

" }, "CertificateFingerprint":{ "shape":"CertificateFingerprint", "documentation":"

The certificate fingerprint.

" } } }, "DescribeLunaClientResponse":{ "type":"structure", "members":{ "ClientArn":{ "shape":"ClientArn", "documentation":"

The ARN of the client.

" }, "Certificate":{ "shape":"Certificate", "documentation":"

The certificate installed on the HSMs used by this client.

" }, "CertificateFingerprint":{ "shape":"CertificateFingerprint", "documentation":"

The certificate fingerprint.

" }, "LastModifiedTimestamp":{ "shape":"Timestamp", "documentation":"

The date and time the client was last modified.

" }, "Label":{ "shape":"Label", "documentation":"

The label of the client.

" } } }, "EniId":{ "type":"string", "pattern":"eni-[0-9a-f]{8}" }, "ExternalId":{ "type":"string", "pattern":"[\\w :+=./-]*" }, "GetConfigRequest":{ "type":"structure", "required":[ "ClientArn", "ClientVersion", "HapgList" ], "members":{ "ClientArn":{ "shape":"ClientArn", "documentation":"

The ARN of the client.

" }, "ClientVersion":{ "shape":"ClientVersion", "documentation":"

The client version.

" }, "HapgList":{ "shape":"HapgList", "documentation":"

A list of ARNs that identify the high-availability partition groups that are associated with the client.

" } } }, "GetConfigResponse":{ "type":"structure", "members":{ "ConfigType":{ "shape":"String", "documentation":"

The type of credentials.

" }, "ConfigFile":{ "shape":"String", "documentation":"

The chrystoki.conf configuration file.

" }, "ConfigCred":{ "shape":"String", "documentation":"

The certificate file containing the server.pem files of the HSMs.

" } } }, "HapgArn":{ "type":"string", "pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hapg-[0-9a-f]{8}" }, "HapgList":{ "type":"list", "member":{"shape":"HapgArn"} }, "HsmArn":{ "type":"string", "documentation":"

An ARN that identifies an HSM.

", "pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hsm-[0-9a-f]{8}" }, "HsmList":{ "type":"list", "member":{"shape":"HsmArn"}, "documentation":"

Contains a list of ARNs that identify the HSMs.

" }, "HsmSerialNumber":{ "type":"string", "pattern":"\\d{1,16}" }, "HsmStatus":{ "type":"string", "enum":[ "PENDING", "RUNNING", "UPDATING", "SUSPENDED", "TERMINATING", "TERMINATED", "DEGRADED" ] }, "IamRoleArn":{ "type":"string", "pattern":"arn:aws(-iso)?:iam::[0-9]{12}:role/[a-zA-Z0-9_\\+=,\\.\\-@]{1,64}" }, "InvalidRequestException":{ "type":"structure", "members":{ }, "documentation":"

Indicates that one or more of the request parameters are not valid.

", "exception":true }, "IpAddress":{ "type":"string", "pattern":"\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}" }, "Label":{ "type":"string", "pattern":"[a-zA-Z0-9_.-]{1,64}" }, "ListAvailableZonesRequest":{ "type":"structure", "members":{ }, "documentation":"

Contains the inputs for the ListAvailableZones action.

" }, "ListAvailableZonesResponse":{ "type":"structure", "members":{ "AZList":{ "shape":"AZList", "documentation":"

The list of Availability Zones that have available AWS CloudHSM capacity.

" } } }, "ListHapgsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"PaginationToken", "documentation":"

The NextToken value from a previous call to ListHapgs. Pass null if this is the first call.

" } } }, "ListHapgsResponse":{ "type":"structure", "required":["HapgList"], "members":{ "HapgList":{ "shape":"HapgList", "documentation":"

The list of high-availability partition groups.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

If not null, more results are available. Pass this value to ListHapgs to retrieve the next set of items.

" } } }, "ListHsmsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"PaginationToken", "documentation":"

The NextToken value from a previous call to ListHsms. Pass null if this is the first call.

" } } }, "ListHsmsResponse":{ "type":"structure", "members":{ "HsmList":{ "shape":"HsmList", "documentation":"

The list of ARNs that identify the HSMs.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

If not null, more results are available. Pass this value to ListHsms to retrieve the next set of items.

" } }, "documentation":"

Contains the output of the ListHsms operation.

" }, "ListLunaClientsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"PaginationToken", "documentation":"

The NextToken value from a previous call to ListLunaClients. Pass null if this is the first call.

" } } }, "ListLunaClientsResponse":{ "type":"structure", "required":["ClientList"], "members":{ "ClientList":{ "shape":"ClientList", "documentation":"

The list of clients.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

If not null, more results are available. Pass this to ListLunaClients to retrieve the next set of items.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the AWS CloudHSM resource.

" } } }, "ListTagsForResourceResponse":{ "type":"structure", "required":["TagList"], "members":{ "TagList":{ "shape":"TagList", "documentation":"

One or more tags.

" } } }, "ModifyHapgRequest":{ "type":"structure", "required":["HapgArn"], "members":{ "HapgArn":{ "shape":"HapgArn", "documentation":"

The ARN of the high-availability partition group to modify.

" }, "Label":{ "shape":"Label", "documentation":"

The new label for the high-availability partition group.

" }, "PartitionSerialList":{ "shape":"PartitionSerialList", "documentation":"

The list of partition serial numbers to make members of the high-availability partition group.

" } } }, "ModifyHapgResponse":{ "type":"structure", "members":{ "HapgArn":{ "shape":"HapgArn", "documentation":"

The ARN of the high-availability partition group.

" } } }, "ModifyHsmRequest":{ "type":"structure", "required":["HsmArn"], "members":{ "HsmArn":{ "shape":"HsmArn", "documentation":"

The ARN of the HSM to modify.

", "locationName":"HsmArn" }, "SubnetId":{ "shape":"SubnetId", "documentation":"

The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.

", "locationName":"SubnetId" }, "EniIp":{ "shape":"IpAddress", "documentation":"

The new IP address for the elastic network interface (ENI) attached to the HSM.

If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.

", "locationName":"EniIp" }, "IamRoleArn":{ "shape":"IamRoleArn", "documentation":"

The new IAM role ARN.

", "locationName":"IamRoleArn" }, "ExternalId":{ "shape":"ExternalId", "documentation":"

The new external ID.

", "locationName":"ExternalId" }, "SyslogIp":{ "shape":"IpAddress", "documentation":"

The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

", "locationName":"SyslogIp" } }, "documentation":"

Contains the inputs for the ModifyHsm operation.

", "locationName":"ModifyHsmRequest" }, "ModifyHsmResponse":{ "type":"structure", "members":{ "HsmArn":{ "shape":"HsmArn", "documentation":"

The ARN of the HSM.

" } }, "documentation":"

Contains the output of the ModifyHsm operation.

" }, "ModifyLunaClientRequest":{ "type":"structure", "required":[ "ClientArn", "Certificate" ], "members":{ "ClientArn":{ "shape":"ClientArn", "documentation":"

The ARN of the client.

" }, "Certificate":{ "shape":"Certificate", "documentation":"

The new certificate for the client.

" } } }, "ModifyLunaClientResponse":{ "type":"structure", "members":{ "ClientArn":{ "shape":"ClientArn", "documentation":"

The ARN of the client.

" } } }, "PaginationToken":{ "type":"string", "pattern":"[a-zA-Z0-9+/]*" }, "PartitionArn":{ "type":"string", "pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hsm-[0-9a-f]{8}/partition-[0-9]{6,12}" }, "PartitionList":{ "type":"list", "member":{"shape":"PartitionArn"} }, "PartitionSerial":{ "type":"string", "pattern":"\\d{6,12}" }, "PartitionSerialList":{ "type":"list", "member":{"shape":"PartitionSerial"} }, "RemoveTagsFromResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagKeyList" ], "members":{ "ResourceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the AWS CloudHSM resource.

" }, "TagKeyList":{ "shape":"TagKeyList", "documentation":"

The tag key or keys to remove.

Specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.

" } } }, "RemoveTagsFromResourceResponse":{ "type":"structure", "required":["Status"], "members":{ "Status":{ "shape":"String", "documentation":"

The status of the operation.

" } } }, "SshKey":{ "type":"string", "pattern":"[a-zA-Z0-9+/= ._:\\\\@-]*" }, "String":{ "type":"string", "pattern":"[\\w :+=./\\\\-]*" }, "SubnetId":{ "type":"string", "pattern":"subnet-[0-9a-f]{8}" }, "SubscriptionType":{ "type":"string", "documentation":"

Specifies the type of subscription for the HSM.

  • PRODUCTION - The HSM is being used in a production environment.
  • TRIAL - The HSM is being used in a product trial.
", "enum":["PRODUCTION"] }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

The key of the tag.

" }, "Value":{ "shape":"TagValue", "documentation":"

The value of the tag.

" } }, "documentation":"

A key-value pair that identifies or specifies metadata about an AWS CloudHSM resource.

" }, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"} }, "TagList":{ "type":"list", "member":{"shape":"Tag"} }, "TagValue":{ "type":"string", "max":256, "min":0 }, "Timestamp":{ "type":"string", "pattern":"\\d*" }, "VpcId":{ "type":"string", "pattern":"vpc-[0-9a-f]{8}" } }, "documentation":"AWS CloudHSM Service" } botocore-1.5.7/botocore/data/iot-data/0000777454262600001440000000000013042511307020635 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/iot-data/2015-05-28/0000777454262600001440000000000013042511307021675 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/iot-data/2015-05-28/service-2.json0000666454262600001440000002613313042511306024373 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"iot-data-2015-05-28", "apiVersion":"2015-05-28", "endpointPrefix":"data.iot", "protocol":"rest-json", "serviceFullName":"AWS IoT Data Plane", "signatureVersion":"v4", "signingName":"iotdata" }, "operations":{ "DeleteThingShadow":{ "name":"DeleteThingShadow", "http":{ "method":"DELETE", "requestUri":"/things/{thingName}/shadow" }, "input":{"shape":"DeleteThingShadowRequest"}, "output":{"shape":"DeleteThingShadowResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"}, {"shape":"UnauthorizedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"InternalFailureException"}, {"shape":"MethodNotAllowedException"}, {"shape":"UnsupportedDocumentEncodingException"} ], "documentation":"

Deletes the thing shadow for the specified thing.

For more information, see DeleteThingShadow in the AWS IoT Developer Guide.

" }, "GetThingShadow":{ "name":"GetThingShadow", "http":{ "method":"GET", "requestUri":"/things/{thingName}/shadow" }, "input":{"shape":"GetThingShadowRequest"}, "output":{"shape":"GetThingShadowResponse"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"UnauthorizedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"InternalFailureException"}, {"shape":"MethodNotAllowedException"}, {"shape":"UnsupportedDocumentEncodingException"} ], "documentation":"

Gets the thing shadow for the specified thing.

For more information, see GetThingShadow in the AWS IoT Developer Guide.

" }, "Publish":{ "name":"Publish", "http":{ "method":"POST", "requestUri":"/topics/{topic}" }, "input":{"shape":"PublishRequest"}, "errors":[ {"shape":"InternalFailureException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"MethodNotAllowedException"} ], "documentation":"

Publishes state information.

For more information, see HTTP Protocol in the AWS IoT Developer Guide.

" }, "UpdateThingShadow":{ "name":"UpdateThingShadow", "http":{ "method":"POST", "requestUri":"/things/{thingName}/shadow" }, "input":{"shape":"UpdateThingShadowRequest"}, "output":{"shape":"UpdateThingShadowResponse"}, "errors":[ {"shape":"ConflictException"}, {"shape":"RequestEntityTooLargeException"}, {"shape":"InvalidRequestException"}, {"shape":"ThrottlingException"}, {"shape":"UnauthorizedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"InternalFailureException"}, {"shape":"MethodNotAllowedException"}, {"shape":"UnsupportedDocumentEncodingException"} ], "documentation":"

Updates the thing shadow for the specified thing.

For more information, see UpdateThingShadow in the AWS IoT Developer Guide.

" } }, "shapes":{ "ConflictException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The message for the exception.

" } }, "documentation":"

The specified version does not match the version of the document.

", "error":{"httpStatusCode":409}, "exception":true }, "DeleteThingShadowRequest":{ "type":"structure", "required":["thingName"], "members":{ "thingName":{ "shape":"ThingName", "documentation":"

The name of the thing.

", "location":"uri", "locationName":"thingName" } }, "documentation":"

The input for the DeleteThingShadow operation.

" }, "DeleteThingShadowResponse":{ "type":"structure", "required":["payload"], "members":{ "payload":{ "shape":"JsonDocument", "documentation":"

The state information, in JSON format.

" } }, "documentation":"

The output from the DeleteThingShadow operation.

", "payload":"payload" }, "ErrorMessage":{"type":"string"}, "GetThingShadowRequest":{ "type":"structure", "required":["thingName"], "members":{ "thingName":{ "shape":"ThingName", "documentation":"

The name of the thing.

", "location":"uri", "locationName":"thingName" } }, "documentation":"

The input for the GetThingShadow operation.

" }, "GetThingShadowResponse":{ "type":"structure", "members":{ "payload":{ "shape":"JsonDocument", "documentation":"

The state information, in JSON format.

" } }, "documentation":"

The output from the GetThingShadow operation.

", "payload":"payload" }, "InternalFailureException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "documentation":"

An unexpected error has occurred.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "InvalidRequestException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "documentation":"

The request is not valid.

", "error":{"httpStatusCode":400}, "exception":true }, "JsonDocument":{"type":"blob"}, "MethodNotAllowedException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The message for the exception.

" } }, "documentation":"

The specified combination of HTTP verb and URI is not supported.

", "error":{"httpStatusCode":405}, "exception":true }, "Payload":{"type":"blob"}, "PublishRequest":{ "type":"structure", "required":["topic"], "members":{ "topic":{ "shape":"Topic", "documentation":"

The name of the MQTT topic.

", "location":"uri", "locationName":"topic" }, "qos":{ "shape":"Qos", "documentation":"

The Quality of Service (QoS) level.

", "location":"querystring", "locationName":"qos" }, "payload":{ "shape":"Payload", "documentation":"

The state information, in JSON format.

" } }, "documentation":"

The input for the Publish operation.

", "payload":"payload" }, "Qos":{ "type":"integer", "max":1, "min":0 }, "RequestEntityTooLargeException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The message for the exception.

" } }, "documentation":"

The payload exceeds the maximum size allowed.

", "error":{"httpStatusCode":413}, "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "documentation":"

The specified resource does not exist.

", "error":{"httpStatusCode":404}, "exception":true }, "ServiceUnavailableException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "documentation":"

The service is temporarily unavailable.

", "error":{"httpStatusCode":503}, "exception":true, "fault":true }, "ThingName":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "ThrottlingException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "documentation":"

The rate exceeds the limit.

", "error":{"httpStatusCode":429}, "exception":true }, "Topic":{"type":"string"}, "UnauthorizedException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "documentation":"

You are not authorized to perform this operation.

", "error":{"httpStatusCode":401}, "exception":true }, "UnsupportedDocumentEncodingException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "documentation":"

The document encoding is not supported.

", "error":{"httpStatusCode":415}, "exception":true }, "UpdateThingShadowRequest":{ "type":"structure", "required":[ "thingName", "payload" ], "members":{ "thingName":{ "shape":"ThingName", "documentation":"

The name of the thing.

", "location":"uri", "locationName":"thingName" }, "payload":{ "shape":"JsonDocument", "documentation":"

The state information, in JSON format.

" } }, "documentation":"

The input for the UpdateThingShadow operation.

", "payload":"payload" }, "UpdateThingShadowResponse":{ "type":"structure", "members":{ "payload":{ "shape":"JsonDocument", "documentation":"

The state information, in JSON format.

" } }, "documentation":"

The output from the UpdateThingShadow operation.

", "payload":"payload" }, "errorMessage":{"type":"string"} }, "documentation":"AWS IoT

AWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete thing shadows. A thing shadow is a persistent representation of your things and their state in the AWS cloud.

" } botocore-1.5.7/botocore/data/codepipeline/0000777454262600001440000000000013042511307021573 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/codepipeline/2015-07-09/0000777454262600001440000000000013042511307022634 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/codepipeline/2015-07-09/service-2.json0000666454262600001440000027732013042511306025340 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-07-09", "endpointPrefix":"codepipeline", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"CodePipeline", "serviceFullName":"AWS CodePipeline", "signatureVersion":"v4", "targetPrefix":"CodePipeline_20150709", "uid":"codepipeline-2015-07-09" }, "operations":{ "AcknowledgeJob":{ "name":"AcknowledgeJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AcknowledgeJobInput"}, "output":{"shape":"AcknowledgeJobOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InvalidNonceException"}, {"shape":"JobNotFoundException"} ], "documentation":"

Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.

" }, "AcknowledgeThirdPartyJob":{ "name":"AcknowledgeThirdPartyJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AcknowledgeThirdPartyJobInput"}, "output":{"shape":"AcknowledgeThirdPartyJobOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InvalidNonceException"}, {"shape":"JobNotFoundException"}, {"shape":"InvalidClientTokenException"} ], "documentation":"

Confirms a job worker has received the specified job. Only used for partner actions.

" }, "CreateCustomActionType":{ "name":"CreateCustomActionType", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCustomActionTypeInput"}, "output":{"shape":"CreateCustomActionTypeOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.

" }, "CreatePipeline":{ "name":"CreatePipeline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePipelineInput"}, "output":{"shape":"CreatePipelineOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"PipelineNameInUseException"}, {"shape":"InvalidStageDeclarationException"}, {"shape":"InvalidActionDeclarationException"}, {"shape":"InvalidBlockerDeclarationException"}, {"shape":"InvalidStructureException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a pipeline.

" }, "DeleteCustomActionType":{ "name":"DeleteCustomActionType", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCustomActionTypeInput"}, "errors":[ {"shape":"ValidationException"} ], "documentation":"

Marks a custom action as deleted. PollForJobs for the custom action will fail after the action is marked for deletion. Only used for custom actions.

You cannot recreate a custom action after it has been deleted unless you increase the version number of the action.

" }, "DeletePipeline":{ "name":"DeletePipeline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePipelineInput"}, "errors":[ {"shape":"ValidationException"} ], "documentation":"

Deletes the specified pipeline.

" }, "DisableStageTransition":{ "name":"DisableStageTransition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableStageTransitionInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"PipelineNotFoundException"}, {"shape":"StageNotFoundException"} ], "documentation":"

Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.

" }, "EnableStageTransition":{ "name":"EnableStageTransition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableStageTransitionInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"PipelineNotFoundException"}, {"shape":"StageNotFoundException"} ], "documentation":"

Enables artifacts in a pipeline to transition to a stage in a pipeline.

" }, "GetJobDetails":{ "name":"GetJobDetails", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetJobDetailsInput"}, "output":{"shape":"GetJobDetailsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"JobNotFoundException"} ], "documentation":"

Returns information about a job. Only used for custom actions.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.

" }, "GetPipeline":{ "name":"GetPipeline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPipelineInput"}, "output":{"shape":"GetPipelineOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"PipelineNotFoundException"}, {"shape":"PipelineVersionNotFoundException"} ], "documentation":"

Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.

" }, "GetPipelineExecution":{ "name":"GetPipelineExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPipelineExecutionInput"}, "output":{"shape":"GetPipelineExecutionOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"PipelineNotFoundException"}, {"shape":"PipelineExecutionNotFoundException"} ], "documentation":"

Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.

" }, "GetPipelineState":{ "name":"GetPipelineState", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPipelineStateInput"}, "output":{"shape":"GetPipelineStateOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"PipelineNotFoundException"} ], "documentation":"

Returns information about the state of a pipeline, including the stages and actions.

" }, "GetThirdPartyJobDetails":{ "name":"GetThirdPartyJobDetails", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetThirdPartyJobDetailsInput"}, "output":{"shape":"GetThirdPartyJobDetailsOutput"}, "errors":[ {"shape":"JobNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InvalidClientTokenException"}, {"shape":"InvalidJobException"} ], "documentation":"

Requests the details of a job for a third party action. Only used for partner actions.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.

" }, "ListActionTypes":{ "name":"ListActionTypes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListActionTypesInput"}, "output":{"shape":"ListActionTypesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Gets a summary of all AWS CodePipeline action types associated with your account.

" }, "ListPipelines":{ "name":"ListPipelines", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPipelinesInput"}, "output":{"shape":"ListPipelinesOutput"}, "errors":[ {"shape":"InvalidNextTokenException"} ], "documentation":"

Gets a summary of all of the pipelines associated with your account.

" }, "PollForJobs":{ "name":"PollForJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PollForJobsInput"}, "output":{"shape":"PollForJobsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ActionTypeNotFoundException"} ], "documentation":"

Returns information about any jobs for AWS CodePipeline to act upon.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. Additionally, this API returns any secret values defined for the action.

" }, "PollForThirdPartyJobs":{ "name":"PollForThirdPartyJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PollForThirdPartyJobsInput"}, "output":{"shape":"PollForThirdPartyJobsOutput"}, "errors":[ {"shape":"ActionTypeNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Determines whether there are any third party jobs for a job worker to act on. Only used for partner actions.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.

" }, "PutActionRevision":{ "name":"PutActionRevision", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutActionRevisionInput"}, "output":{"shape":"PutActionRevisionOutput"}, "errors":[ {"shape":"PipelineNotFoundException"}, {"shape":"StageNotFoundException"}, {"shape":"ActionNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Provides information to AWS CodePipeline about new revisions to a source.

" }, "PutApprovalResult":{ "name":"PutApprovalResult", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutApprovalResultInput"}, "output":{"shape":"PutApprovalResultOutput"}, "errors":[ {"shape":"InvalidApprovalTokenException"}, {"shape":"ApprovalAlreadyCompletedException"}, {"shape":"PipelineNotFoundException"}, {"shape":"StageNotFoundException"}, {"shape":"ActionNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.

" }, "PutJobFailureResult":{ "name":"PutJobFailureResult", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutJobFailureResultInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"JobNotFoundException"}, {"shape":"InvalidJobStateException"} ], "documentation":"

Represents the failure of a job as returned to the pipeline by a job worker. Only used for custom actions.

" }, "PutJobSuccessResult":{ "name":"PutJobSuccessResult", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutJobSuccessResultInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"JobNotFoundException"}, {"shape":"InvalidJobStateException"} ], "documentation":"

Represents the success of a job as returned to the pipeline by a job worker. Only used for custom actions.

" }, "PutThirdPartyJobFailureResult":{ "name":"PutThirdPartyJobFailureResult", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutThirdPartyJobFailureResultInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"JobNotFoundException"}, {"shape":"InvalidJobStateException"}, {"shape":"InvalidClientTokenException"} ], "documentation":"

Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.

" }, "PutThirdPartyJobSuccessResult":{ "name":"PutThirdPartyJobSuccessResult", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutThirdPartyJobSuccessResultInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"JobNotFoundException"}, {"shape":"InvalidJobStateException"}, {"shape":"InvalidClientTokenException"} ], "documentation":"

Represents the success of a third party job as returned to the pipeline by a job worker. Only used for partner actions.

" }, "RetryStageExecution":{ "name":"RetryStageExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RetryStageExecutionInput"}, "output":{"shape":"RetryStageExecutionOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"PipelineNotFoundException"}, {"shape":"StageNotFoundException"}, {"shape":"StageNotRetryableException"}, {"shape":"NotLatestPipelineExecutionException"} ], "documentation":"

Resumes the pipeline execution by retrying the last failed actions in a stage.

" }, "StartPipelineExecution":{ "name":"StartPipelineExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartPipelineExecutionInput"}, "output":{"shape":"StartPipelineExecutionOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"PipelineNotFoundException"} ], "documentation":"

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

" }, "UpdatePipeline":{ "name":"UpdatePipeline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdatePipelineInput"}, "output":{"shape":"UpdatePipelineOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InvalidStageDeclarationException"}, {"shape":"InvalidActionDeclarationException"}, {"shape":"InvalidBlockerDeclarationException"}, {"shape":"InvalidStructureException"} ], "documentation":"

Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.

" } }, "shapes":{ "AWSSessionCredentials":{ "type":"structure", "required":[ "accessKeyId", "secretAccessKey", "sessionToken" ], "members":{ "accessKeyId":{ "shape":"AccessKeyId", "documentation":"

The access key for the session.

" }, "secretAccessKey":{ "shape":"SecretAccessKey", "documentation":"

The secret access key for the session.

" }, "sessionToken":{ "shape":"SessionToken", "documentation":"

The token for the session.

" } }, "documentation":"

Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline.

", "sensitive":true }, "AccessKeyId":{"type":"string"}, "AccountId":{ "type":"string", "pattern":"[0-9]{12}" }, "AcknowledgeJobInput":{ "type":"structure", "required":[ "jobId", "nonce" ], "members":{ "jobId":{ "shape":"JobId", "documentation":"

The unique system-generated ID of the job for which you want to confirm receipt.

" }, "nonce":{ "shape":"Nonce", "documentation":"

A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job.

" } }, "documentation":"

Represents the input of an acknowledge job action.

" }, "AcknowledgeJobOutput":{ "type":"structure", "members":{ "status":{ "shape":"JobStatus", "documentation":"

Whether the job worker has received the specified job.

" } }, "documentation":"

Represents the output of an acknowledge job action.

" }, "AcknowledgeThirdPartyJobInput":{ "type":"structure", "required":[ "jobId", "nonce", "clientToken" ], "members":{ "jobId":{ "shape":"ThirdPartyJobId", "documentation":"

The unique system-generated ID of the job.

" }, "nonce":{ "shape":"Nonce", "documentation":"

A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a GetThirdPartyJobDetails request.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

" } }, "documentation":"

Represents the input of an acknowledge third party job action.

" }, "AcknowledgeThirdPartyJobOutput":{ "type":"structure", "members":{ "status":{ "shape":"JobStatus", "documentation":"

The status information for the third party job, if any.

" } }, "documentation":"

Represents the output of an acknowledge third party job action.

" }, "ActionCategory":{ "type":"string", "enum":[ "Source", "Build", "Deploy", "Test", "Invoke", "Approval" ] }, "ActionConfiguration":{ "type":"structure", "members":{ "configuration":{ "shape":"ActionConfigurationMap", "documentation":"

The configuration data for the action.

" } }, "documentation":"

Represents information about an action configuration.

" }, "ActionConfigurationKey":{ "type":"string", "max":50, "min":1 }, "ActionConfigurationMap":{ "type":"map", "key":{"shape":"ActionConfigurationKey"}, "value":{"shape":"ActionConfigurationValue"} }, "ActionConfigurationProperty":{ "type":"structure", "required":[ "name", "required", "key", "secret" ], "members":{ "name":{ "shape":"ActionConfigurationKey", "documentation":"

The name of the action configuration property.

" }, "required":{ "shape":"Boolean", "documentation":"

Whether the configuration property is a required value.

" }, "key":{ "shape":"Boolean", "documentation":"

Whether the configuration property is a key.

" }, "secret":{ "shape":"Boolean", "documentation":"

Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.

When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.

" }, "queryable":{ "shape":"Boolean", "documentation":"

Indicates that the proprety will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.

If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

" }, "description":{ "shape":"Description", "documentation":"

The description of the action configuration property that will be displayed to users.

" }, "type":{ "shape":"ActionConfigurationPropertyType", "documentation":"

The type of the configuration property.

" } }, "documentation":"

Represents information about an action configuration property.

" }, "ActionConfigurationPropertyList":{ "type":"list", "member":{"shape":"ActionConfigurationProperty"}, "max":10 }, "ActionConfigurationPropertyType":{ "type":"string", "enum":[ "String", "Number", "Boolean" ] }, "ActionConfigurationQueryableValue":{ "type":"string", "max":20, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "ActionConfigurationValue":{ "type":"string", "max":1000, "min":1 }, "ActionContext":{ "type":"structure", "members":{ "name":{ "shape":"ActionName", "documentation":"

The name of the action within the context of a job.

" } }, "documentation":"

Represents the context of an action within the stage of a pipeline to a job worker.

" }, "ActionDeclaration":{ "type":"structure", "required":[ "name", "actionTypeId" ], "members":{ "name":{ "shape":"ActionName", "documentation":"

The action declaration's name.

" }, "actionTypeId":{ "shape":"ActionTypeId", "documentation":"

The configuration information for the action type.

" }, "runOrder":{ "shape":"ActionRunOrder", "documentation":"

The order in which actions are run.

" }, "configuration":{ "shape":"ActionConfigurationMap", "documentation":"

The action declaration's configuration.

" }, "outputArtifacts":{ "shape":"OutputArtifactList", "documentation":"

The name or ID of the result of the action declaration, such as a test or build artifact.

" }, "inputArtifacts":{ "shape":"InputArtifactList", "documentation":"

The name or ID of the artifact consumed by the action, such as a test or build artifact.

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.

" } }, "documentation":"

Represents information about an action declaration.

" }, "ActionExecution":{ "type":"structure", "members":{ "status":{ "shape":"ActionExecutionStatus", "documentation":"

The status of the action, or for a completed action, the last status of the action.

" }, "summary":{ "shape":"ExecutionSummary", "documentation":"

A summary of the run of the action.

" }, "lastStatusChange":{ "shape":"Timestamp", "documentation":"

The last status change of the action.

" }, "token":{ "shape":"ActionExecutionToken", "documentation":"

The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState command and is used to validate that the approval request corresponding to this token is still valid.

" }, "lastUpdatedBy":{ "shape":"LastUpdatedBy", "documentation":"

The ARN of the user who last changed the pipeline.

" }, "externalExecutionId":{ "shape":"ExecutionId", "documentation":"

The external ID of the run of the action.

" }, "externalExecutionUrl":{ "shape":"Url", "documentation":"

The URL of a resource external to AWS that will be used when running the action, for example an external repository URL.

" }, "percentComplete":{ "shape":"Percentage", "documentation":"

A percentage of completeness of the action as it runs.

" }, "errorDetails":{ "shape":"ErrorDetails", "documentation":"

The details of an error returned by a URL external to AWS.

" } }, "documentation":"

Represents information about the run of an action.

" }, "ActionExecutionStatus":{ "type":"string", "enum":[ "InProgress", "Succeeded", "Failed" ] }, "ActionExecutionToken":{"type":"string"}, "ActionName":{ "type":"string", "max":100, "min":1, "pattern":"[A-Za-z0-9.@\\-_]+" }, "ActionNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified action cannot be found.

", "exception":true }, "ActionOwner":{ "type":"string", "enum":[ "AWS", "ThirdParty", "Custom" ] }, "ActionProvider":{ "type":"string", "max":25, "min":1, "pattern":"[0-9A-Za-z_-]+" }, "ActionRevision":{ "type":"structure", "required":[ "revisionId", "revisionChangeId", "created" ], "members":{ "revisionId":{ "shape":"Revision", "documentation":"

The system-generated unique ID that identifies the revision number of the action.

" }, "revisionChangeId":{ "shape":"RevisionChangeIdentifier", "documentation":"

The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp.

" }, "created":{ "shape":"Timestamp", "documentation":"

The date and time when the most recent version of the action was created, in timestamp format.

" } }, "documentation":"

Represents information about the version (or revision) of an action.

" }, "ActionRunOrder":{ "type":"integer", "max":999, "min":1 }, "ActionState":{ "type":"structure", "members":{ "actionName":{ "shape":"ActionName", "documentation":"

The name of the action.

" }, "currentRevision":{"shape":"ActionRevision"}, "latestExecution":{"shape":"ActionExecution"}, "entityUrl":{ "shape":"Url", "documentation":"

A URL link for more information about the state of the action, such as a deployment group details page.

" }, "revisionUrl":{ "shape":"Url", "documentation":"

A URL link for more information about the revision, such as a commit details page.

" } }, "documentation":"

Represents information about the state of an action.

" }, "ActionStateList":{ "type":"list", "member":{"shape":"ActionState"} }, "ActionType":{ "type":"structure", "required":[ "id", "inputArtifactDetails", "outputArtifactDetails" ], "members":{ "id":{"shape":"ActionTypeId"}, "settings":{ "shape":"ActionTypeSettings", "documentation":"

The settings for the action type.

" }, "actionConfigurationProperties":{ "shape":"ActionConfigurationPropertyList", "documentation":"

The configuration properties for the action type.

" }, "inputArtifactDetails":{ "shape":"ArtifactDetails", "documentation":"

The details of the input artifact for the action, such as its commit ID.

" }, "outputArtifactDetails":{ "shape":"ArtifactDetails", "documentation":"

The details of the output artifact of the action, such as its commit ID.

" } }, "documentation":"

Returns information about the details of an action type.

" }, "ActionTypeId":{ "type":"structure", "required":[ "category", "owner", "provider", "version" ], "members":{ "category":{ "shape":"ActionCategory", "documentation":"

A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the values below.

" }, "owner":{ "shape":"ActionOwner", "documentation":"

The creator of the action being called.

" }, "provider":{ "shape":"ActionProvider", "documentation":"

The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy.

" }, "version":{ "shape":"Version", "documentation":"

A string that identifies the action type.

" } }, "documentation":"

Represents information about an action type.

" }, "ActionTypeList":{ "type":"list", "member":{"shape":"ActionType"} }, "ActionTypeNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified action type cannot be found.

", "exception":true }, "ActionTypeSettings":{ "type":"structure", "members":{ "thirdPartyConfigurationUrl":{ "shape":"Url", "documentation":"

The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.

" }, "entityUrlTemplate":{ "shape":"UrlTemplate", "documentation":"

The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display within the pipeline.

" }, "executionUrlTemplate":{ "shape":"UrlTemplate", "documentation":"

The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.

" }, "revisionUrlTemplate":{ "shape":"UrlTemplate", "documentation":"

The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.

" } }, "documentation":"

Returns information about the settings for an action type.

" }, "ApprovalAlreadyCompletedException":{ "type":"structure", "members":{ }, "documentation":"

The approval action has already been approved or rejected.

", "exception":true }, "ApprovalResult":{ "type":"structure", "required":[ "summary", "status" ], "members":{ "summary":{ "shape":"ApprovalSummary", "documentation":"

The summary of the current status of the approval request.

" }, "status":{ "shape":"ApprovalStatus", "documentation":"

The response submitted by a reviewer assigned to an approval action request.

" } }, "documentation":"

Represents information about the result of an approval request.

" }, "ApprovalStatus":{ "type":"string", "enum":[ "Approved", "Rejected" ] }, "ApprovalSummary":{ "type":"string", "max":512, "min":0 }, "ApprovalToken":{ "type":"string", "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, "Artifact":{ "type":"structure", "members":{ "name":{ "shape":"ArtifactName", "documentation":"

The artifact's name.

" }, "revision":{ "shape":"Revision", "documentation":"

The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).

" }, "location":{ "shape":"ArtifactLocation", "documentation":"

The location of an artifact.

" } }, "documentation":"

Represents information about an artifact that will be worked upon by actions in the pipeline.

" }, "ArtifactDetails":{ "type":"structure", "required":[ "minimumCount", "maximumCount" ], "members":{ "minimumCount":{ "shape":"MinimumArtifactCount", "documentation":"

The minimum number of artifacts allowed for the action type.

" }, "maximumCount":{ "shape":"MaximumArtifactCount", "documentation":"

The maximum number of artifacts allowed for the action type.

" } }, "documentation":"

Returns information about the details of an artifact.

" }, "ArtifactList":{ "type":"list", "member":{"shape":"Artifact"} }, "ArtifactLocation":{ "type":"structure", "members":{ "type":{ "shape":"ArtifactLocationType", "documentation":"

The type of artifact in the location.

" }, "s3Location":{ "shape":"S3ArtifactLocation", "documentation":"

The Amazon S3 bucket that contains the artifact.

" } }, "documentation":"

Represents information about the location of an artifact.

" }, "ArtifactLocationType":{ "type":"string", "enum":["S3"] }, "ArtifactName":{ "type":"string", "max":100, "min":1, "pattern":"[a-zA-Z0-9_\\-]+" }, "ArtifactRevision":{ "type":"structure", "members":{ "name":{ "shape":"ArtifactName", "documentation":"

The name of an artifact. This name might be system-generated, such as \"MyApp\", or might be defined by the user when an action is created.

" }, "revisionId":{ "shape":"Revision", "documentation":"

The revision ID of the artifact.

" }, "revisionChangeIdentifier":{ "shape":"RevisionChangeIdentifier", "documentation":"

An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.

" }, "revisionSummary":{ "shape":"RevisionSummary", "documentation":"

Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.

" }, "created":{ "shape":"Timestamp", "documentation":"

The date and time when the most recent revision of the artifact was created, in timestamp format.

" }, "revisionUrl":{ "shape":"Url", "documentation":"

The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.

" } }, "documentation":"

Represents revision details of an artifact.

" }, "ArtifactRevisionList":{ "type":"list", "member":{"shape":"ArtifactRevision"} }, "ArtifactStore":{ "type":"structure", "required":[ "type", "location" ], "members":{ "type":{ "shape":"ArtifactStoreType", "documentation":"

The type of the artifact store, such as S3.

" }, "location":{ "shape":"ArtifactStoreLocation", "documentation":"

The location for storing the artifacts for a pipeline, such as an S3 bucket or folder.

" }, "encryptionKey":{ "shape":"EncryptionKey", "documentation":"

The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.

" } }, "documentation":"

The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the Concepts.

" }, "ArtifactStoreLocation":{ "type":"string", "max":63, "min":3, "pattern":"[a-zA-Z0-9\\-\\.]+" }, "ArtifactStoreType":{ "type":"string", "enum":["S3"] }, "BlockerDeclaration":{ "type":"structure", "required":[ "name", "type" ], "members":{ "name":{ "shape":"BlockerName", "documentation":"

Reserved for future use.

" }, "type":{ "shape":"BlockerType", "documentation":"

Reserved for future use.

" } }, "documentation":"

Reserved for future use.

" }, "BlockerName":{ "type":"string", "max":100, "min":1 }, "BlockerType":{ "type":"string", "enum":["Schedule"] }, "Boolean":{"type":"boolean"}, "ClientId":{ "type":"string", "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, "ClientToken":{"type":"string"}, "Code":{"type":"string"}, "ContinuationToken":{"type":"string"}, "CreateCustomActionTypeInput":{ "type":"structure", "required":[ "category", "provider", "version", "inputArtifactDetails", "outputArtifactDetails" ], "members":{ "category":{ "shape":"ActionCategory", "documentation":"

The category of the custom action, such as a build action or a test action.

Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use.

" }, "provider":{ "shape":"ActionProvider", "documentation":"

The provider of the service used in the custom action, such as AWS CodeDeploy.

" }, "version":{ "shape":"Version", "documentation":"

The version identifier of the custom action.

" }, "settings":{"shape":"ActionTypeSettings"}, "configurationProperties":{ "shape":"ActionConfigurationPropertyList", "documentation":"

The configuration properties for the custom action.

You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.

" }, "inputArtifactDetails":{"shape":"ArtifactDetails"}, "outputArtifactDetails":{"shape":"ArtifactDetails"} }, "documentation":"

Represents the input of a create custom action operation.

" }, "CreateCustomActionTypeOutput":{ "type":"structure", "required":["actionType"], "members":{ "actionType":{"shape":"ActionType"} }, "documentation":"

Represents the output of a create custom action operation.

" }, "CreatePipelineInput":{ "type":"structure", "required":["pipeline"], "members":{ "pipeline":{"shape":"PipelineDeclaration"} }, "documentation":"

Represents the input of a create pipeline action.

" }, "CreatePipelineOutput":{ "type":"structure", "members":{ "pipeline":{"shape":"PipelineDeclaration"} }, "documentation":"

Represents the output of a create pipeline action.

" }, "CurrentRevision":{ "type":"structure", "required":[ "revision", "changeIdentifier" ], "members":{ "revision":{ "shape":"Revision", "documentation":"

The revision ID of the current version of an artifact.

" }, "changeIdentifier":{ "shape":"RevisionChangeIdentifier", "documentation":"

The change identifier for the current revision.

" }, "created":{ "shape":"Time", "documentation":"

The date and time when the most recent revision of the artifact was created, in timestamp format.

" }, "revisionSummary":{ "shape":"RevisionSummary", "documentation":"

The summary of the most recent revision of the artifact.

" } }, "documentation":"

Represents information about a current revision.

" }, "DeleteCustomActionTypeInput":{ "type":"structure", "required":[ "category", "provider", "version" ], "members":{ "category":{ "shape":"ActionCategory", "documentation":"

The category of the custom action that you want to delete, such as source or deploy.

" }, "provider":{ "shape":"ActionProvider", "documentation":"

The provider of the service used in the custom action, such as AWS CodeDeploy.

" }, "version":{ "shape":"Version", "documentation":"

The version of the custom action to delete.

" } }, "documentation":"

Represents the input of a delete custom action operation. The custom action will be marked as deleted.

" }, "DeletePipelineInput":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"PipelineName", "documentation":"

The name of the pipeline to be deleted.

" } }, "documentation":"

Represents the input of a delete pipeline action.

" }, "Description":{ "type":"string", "max":2048, "min":1 }, "DisableStageTransitionInput":{ "type":"structure", "required":[ "pipelineName", "stageName", "transitionType", "reason" ], "members":{ "pipelineName":{ "shape":"PipelineName", "documentation":"

The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.

" }, "stageName":{ "shape":"StageName", "documentation":"

The name of the stage where you want to disable the inbound or outbound transition of artifacts.

" }, "transitionType":{ "shape":"StageTransitionType", "documentation":"

Specifies whether artifacts will be prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).

" }, "reason":{ "shape":"DisabledReason", "documentation":"

The reason given to the user why a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.

" } }, "documentation":"

Represents the input of a disable stage transition input action.

" }, "DisabledReason":{ "type":"string", "max":300, "min":1, "pattern":"[a-zA-Z0-9!@ \\(\\)\\.\\*\\?\\-]+" }, "EnableStageTransitionInput":{ "type":"structure", "required":[ "pipelineName", "stageName", "transitionType" ], "members":{ "pipelineName":{ "shape":"PipelineName", "documentation":"

The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.

" }, "stageName":{ "shape":"StageName", "documentation":"

The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound).

" }, "transitionType":{ "shape":"StageTransitionType", "documentation":"

Specifies whether artifacts will be allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already-processed artifacts will be allowed to transition to the next stage (outbound).

" } }, "documentation":"

Represents the input of an enable stage transition action.

" }, "Enabled":{"type":"boolean"}, "EncryptionKey":{ "type":"structure", "required":[ "id", "type" ], "members":{ "id":{ "shape":"EncryptionKeyId", "documentation":"

The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN.

" }, "type":{ "shape":"EncryptionKeyType", "documentation":"

The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.

" } }, "documentation":"

Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.

" }, "EncryptionKeyId":{ "type":"string", "max":100, "min":1 }, "EncryptionKeyType":{ "type":"string", "enum":["KMS"] }, "ErrorDetails":{ "type":"structure", "members":{ "code":{ "shape":"Code", "documentation":"

The system ID or error number code of the error.

" }, "message":{ "shape":"Message", "documentation":"

The text of the error message.

" } }, "documentation":"

Represents information about an error in AWS CodePipeline.

" }, "ExecutionDetails":{ "type":"structure", "members":{ "summary":{ "shape":"ExecutionSummary", "documentation":"

The summary of the current status of the actions.

" }, "externalExecutionId":{ "shape":"ExecutionId", "documentation":"

The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.

" }, "percentComplete":{ "shape":"Percentage", "documentation":"

The percentage of work completed on the action, represented on a scale of zero to one hundred percent.

" } }, "documentation":"

The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.

" }, "ExecutionId":{ "type":"string", "max":1500, "min":1 }, "ExecutionSummary":{"type":"string"}, "FailureDetails":{ "type":"structure", "required":[ "type", "message" ], "members":{ "type":{ "shape":"FailureType", "documentation":"

The type of the failure.

" }, "message":{ "shape":"Message", "documentation":"

The message about the failure.

" }, "externalExecutionId":{ "shape":"ExecutionId", "documentation":"

The external ID of the run of the action that failed.

" } }, "documentation":"

Represents information about failure details.

" }, "FailureType":{ "type":"string", "enum":[ "JobFailed", "ConfigurationError", "PermissionError", "RevisionOutOfSync", "RevisionUnavailable", "SystemUnavailable" ] }, "GetJobDetailsInput":{ "type":"structure", "required":["jobId"], "members":{ "jobId":{ "shape":"JobId", "documentation":"

The unique system-generated ID for the job.

" } }, "documentation":"

Represents the input of a get job details action.

" }, "GetJobDetailsOutput":{ "type":"structure", "members":{ "jobDetails":{ "shape":"JobDetails", "documentation":"

The details of the job.

If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.

" } }, "documentation":"

Represents the output of a get job details action.

" }, "GetPipelineExecutionInput":{ "type":"structure", "required":[ "pipelineName", "pipelineExecutionId" ], "members":{ "pipelineName":{ "shape":"PipelineName", "documentation":"

The name of the pipeline about which you want to get execution details.

" }, "pipelineExecutionId":{ "shape":"PipelineExecutionId", "documentation":"

The ID of the pipeline execution about which you want to get execution details.

" } }, "documentation":"

Represents the input of a get pipeline execution action.

" }, "GetPipelineExecutionOutput":{ "type":"structure", "members":{ "pipelineExecution":{ "shape":"PipelineExecution", "documentation":"

Represents information about the execution of a pipeline.

" } }, "documentation":"

Represents the output of a get pipeline execution action.

" }, "GetPipelineInput":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"PipelineName", "documentation":"

The name of the pipeline for which you want to get information. Pipeline names must be unique under an Amazon Web Services (AWS) user account.

" }, "version":{ "shape":"PipelineVersion", "documentation":"

The version number of the pipeline. If you do not specify a version, defaults to the most current version.

" } }, "documentation":"

Represents the input of a get pipeline action.

" }, "GetPipelineOutput":{ "type":"structure", "members":{ "pipeline":{"shape":"PipelineDeclaration"} }, "documentation":"

Represents the output of a get pipeline action.

" }, "GetPipelineStateInput":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"PipelineName", "documentation":"

The name of the pipeline about which you want to get information.

" } }, "documentation":"

Represents the input of a get pipeline state action.

" }, "GetPipelineStateOutput":{ "type":"structure", "members":{ "pipelineName":{ "shape":"PipelineName", "documentation":"

The name of the pipeline for which you want to get the state.

" }, "pipelineVersion":{ "shape":"PipelineVersion", "documentation":"

The version number of the pipeline.

A newly-created pipeline is always assigned a version number of 1.

" }, "stageStates":{ "shape":"StageStateList", "documentation":"

A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.

" }, "created":{ "shape":"Timestamp", "documentation":"

The date and time the pipeline was created, in timestamp format.

" }, "updated":{ "shape":"Timestamp", "documentation":"

The date and time the pipeline was last updated, in timestamp format.

" } }, "documentation":"

Represents the output of a get pipeline state action.

" }, "GetThirdPartyJobDetailsInput":{ "type":"structure", "required":[ "jobId", "clientToken" ], "members":{ "jobId":{ "shape":"ThirdPartyJobId", "documentation":"

The unique system-generated ID used for identifying the job.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

" } }, "documentation":"

Represents the input of a get third party job details action.

" }, "GetThirdPartyJobDetailsOutput":{ "type":"structure", "members":{ "jobDetails":{ "shape":"ThirdPartyJobDetails", "documentation":"

The details of the job, including any protected values defined for the job.

" } }, "documentation":"

Represents the output of a get third party job details action.

" }, "InputArtifact":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"ArtifactName", "documentation":"

The name of the artifact to be worked on, for example, \"My App\".

The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

" } }, "documentation":"

Represents information about an artifact to be worked on, such as a test or build artifact.

" }, "InputArtifactList":{ "type":"list", "member":{"shape":"InputArtifact"} }, "InvalidActionDeclarationException":{ "type":"structure", "members":{ }, "documentation":"

The specified action declaration was specified in an invalid format.

", "exception":true }, "InvalidApprovalTokenException":{ "type":"structure", "members":{ }, "documentation":"

The approval request already received a response or has expired.

", "exception":true }, "InvalidBlockerDeclarationException":{ "type":"structure", "members":{ }, "documentation":"

Reserved for future use.

", "exception":true }, "InvalidClientTokenException":{ "type":"structure", "members":{ }, "documentation":"

The client token was specified in an invalid format

", "exception":true }, "InvalidJobException":{ "type":"structure", "members":{ }, "documentation":"

The specified job was specified in an invalid format or cannot be found.

", "exception":true }, "InvalidJobStateException":{ "type":"structure", "members":{ }, "documentation":"

The specified job state was specified in an invalid format.

", "exception":true }, "InvalidNextTokenException":{ "type":"structure", "members":{ }, "documentation":"

The next token was specified in an invalid format. Make sure that the next token you provided is the token returned by a previous call.

", "exception":true }, "InvalidNonceException":{ "type":"structure", "members":{ }, "documentation":"

The specified nonce was specified in an invalid format.

", "exception":true }, "InvalidStageDeclarationException":{ "type":"structure", "members":{ }, "documentation":"

The specified stage declaration was specified in an invalid format.

", "exception":true }, "InvalidStructureException":{ "type":"structure", "members":{ }, "documentation":"

The specified structure was specified in an invalid format.

", "exception":true }, "Job":{ "type":"structure", "members":{ "id":{ "shape":"JobId", "documentation":"

The unique system-generated ID of the job.

" }, "data":{ "shape":"JobData", "documentation":"

Additional data about a job.

" }, "nonce":{ "shape":"Nonce", "documentation":"

A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeJob request.

" }, "accountId":{ "shape":"AccountId", "documentation":"

The ID of the AWS account to use when performing the job.

" } }, "documentation":"

Represents information about a job.

" }, "JobData":{ "type":"structure", "members":{ "actionTypeId":{"shape":"ActionTypeId"}, "actionConfiguration":{"shape":"ActionConfiguration"}, "pipelineContext":{"shape":"PipelineContext"}, "inputArtifacts":{ "shape":"ArtifactList", "documentation":"

The artifact supplied to the job.

" }, "outputArtifacts":{ "shape":"ArtifactList", "documentation":"

The output of the job.

" }, "artifactCredentials":{"shape":"AWSSessionCredentials"}, "continuationToken":{ "shape":"ContinuationToken", "documentation":"

A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.

" }, "encryptionKey":{"shape":"EncryptionKey"} }, "documentation":"

Represents additional information about a job required for a job worker to complete the job.

" }, "JobDetails":{ "type":"structure", "members":{ "id":{ "shape":"JobId", "documentation":"

The unique system-generated ID of the job.

" }, "data":{"shape":"JobData"}, "accountId":{ "shape":"AccountId", "documentation":"

The AWS account ID associated with the job.

" } }, "documentation":"

Represents information about the details of a job.

" }, "JobId":{ "type":"string", "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, "JobList":{ "type":"list", "member":{"shape":"Job"} }, "JobNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified job was specified in an invalid format or cannot be found.

", "exception":true }, "JobStatus":{ "type":"string", "enum":[ "Created", "Queued", "Dispatched", "InProgress", "TimedOut", "Succeeded", "Failed" ] }, "LastChangedAt":{"type":"timestamp"}, "LastChangedBy":{"type":"string"}, "LastUpdatedBy":{"type":"string"}, "LimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.

", "exception":true }, "ListActionTypesInput":{ "type":"structure", "members":{ "actionOwnerFilter":{ "shape":"ActionOwner", "documentation":"

Filters the list of action types to those created by a specified entity.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.

" } }, "documentation":"

Represents the input of a list action types action.

" }, "ListActionTypesOutput":{ "type":"structure", "required":["actionTypes"], "members":{ "actionTypes":{ "shape":"ActionTypeList", "documentation":"

Provides details of the action types.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

If the amount of returned information is significantly large, an identifier is also returned which can be used in a subsequent list action types call to return the next set of action types in the list.

" } }, "documentation":"

Represents the output of a list action types action.

" }, "ListPipelinesInput":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

An identifier that was returned from the previous list pipelines call, which can be used to return the next set of pipelines in the list.

" } }, "documentation":"

Represents the input of a list pipelines action.

" }, "ListPipelinesOutput":{ "type":"structure", "members":{ "pipelines":{ "shape":"PipelineList", "documentation":"

The list of pipelines.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

If the amount of returned information is significantly large, an identifier is also returned which can be used in a subsequent list pipelines call to return the next set of pipelines in the list.

" } }, "documentation":"

Represents the output of a list pipelines action.

" }, "MaxBatchSize":{ "type":"integer", "min":1 }, "MaximumArtifactCount":{ "type":"integer", "max":5, "min":0 }, "Message":{"type":"string"}, "MinimumArtifactCount":{ "type":"integer", "max":5, "min":0 }, "NextToken":{"type":"string"}, "Nonce":{"type":"string"}, "NotLatestPipelineExecutionException":{ "type":"structure", "members":{ }, "documentation":"

The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.

", "exception":true }, "OutputArtifact":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"ArtifactName", "documentation":"

The name of the output of an artifact, such as \"My App\".

The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

Output artifact names must be unique within a pipeline.

" } }, "documentation":"

Represents information about the output of an action.

" }, "OutputArtifactList":{ "type":"list", "member":{"shape":"OutputArtifact"} }, "Percentage":{ "type":"integer", "max":100, "min":0 }, "PipelineContext":{ "type":"structure", "members":{ "pipelineName":{ "shape":"PipelineName", "documentation":"

The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.

" }, "stage":{ "shape":"StageContext", "documentation":"

The stage of the pipeline.

" }, "action":{"shape":"ActionContext"} }, "documentation":"

Represents information about a pipeline to a job worker.

" }, "PipelineDeclaration":{ "type":"structure", "required":[ "name", "roleArn", "artifactStore", "stages" ], "members":{ "name":{ "shape":"PipelineName", "documentation":"

The name of the action to be performed.

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.

" }, "artifactStore":{"shape":"ArtifactStore"}, "stages":{ "shape":"PipelineStageDeclarationList", "documentation":"

The stage in which to perform the action.

" }, "version":{ "shape":"PipelineVersion", "documentation":"

The version number of the pipeline. A new pipeline always has a version number of 1. This number is automatically incremented when a pipeline is updated.

" } }, "documentation":"

Represents the structure of actions and stages to be performed in the pipeline.

" }, "PipelineExecution":{ "type":"structure", "members":{ "pipelineName":{ "shape":"PipelineName", "documentation":"

The name of the pipeline that was executed.

" }, "pipelineVersion":{ "shape":"PipelineVersion", "documentation":"

The version number of the pipeline that was executed.

" }, "pipelineExecutionId":{ "shape":"PipelineExecutionId", "documentation":"

The ID of the pipeline execution.

" }, "status":{ "shape":"PipelineExecutionStatus", "documentation":"

The status of the pipeline execution.

  • InProgress: The pipeline execution is currently running.

  • Succeeded: The pipeline execution completed successfully.

  • Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution caught up and continued through the pipeline instead.

  • Failed: The pipeline did not complete successfully.

" }, "artifactRevisions":{ "shape":"ArtifactRevisionList", "documentation":"

A list of ArtifactRevision objects included in a pipeline execution.

" } }, "documentation":"

Represents information about an execution of a pipeline.

" }, "PipelineExecutionId":{ "type":"string", "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, "PipelineExecutionNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.

", "exception":true }, "PipelineExecutionStatus":{ "type":"string", "enum":[ "InProgress", "Succeeded", "Superseded", "Failed" ] }, "PipelineList":{ "type":"list", "member":{"shape":"PipelineSummary"} }, "PipelineName":{ "type":"string", "max":100, "min":1, "pattern":"[A-Za-z0-9.@\\-_]+" }, "PipelineNameInUseException":{ "type":"structure", "members":{ }, "documentation":"

The specified pipeline name is already in use.

", "exception":true }, "PipelineNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified pipeline was specified in an invalid format or cannot be found.

", "exception":true }, "PipelineStageDeclarationList":{ "type":"list", "member":{"shape":"StageDeclaration"} }, "PipelineSummary":{ "type":"structure", "members":{ "name":{ "shape":"PipelineName", "documentation":"

The name of the pipeline.

" }, "version":{ "shape":"PipelineVersion", "documentation":"

The version number of the pipeline.

" }, "created":{ "shape":"Timestamp", "documentation":"

The date and time the pipeline was created, in timestamp format.

" }, "updated":{ "shape":"Timestamp", "documentation":"

The date and time of the last update to the pipeline, in timestamp format.

" } }, "documentation":"

Returns a summary of a pipeline.

" }, "PipelineVersion":{ "type":"integer", "min":1 }, "PipelineVersionNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified pipeline version was specified in an invalid format or cannot be found.

", "exception":true }, "PollForJobsInput":{ "type":"structure", "required":["actionTypeId"], "members":{ "actionTypeId":{"shape":"ActionTypeId"}, "maxBatchSize":{ "shape":"MaxBatchSize", "documentation":"

The maximum number of jobs to return in a poll for jobs call.

" }, "queryParam":{ "shape":"QueryParamMap", "documentation":"

A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value will be returned.

" } }, "documentation":"

Represents the input of a poll for jobs action.

" }, "PollForJobsOutput":{ "type":"structure", "members":{ "jobs":{ "shape":"JobList", "documentation":"

Information about the jobs to take action on.

" } }, "documentation":"

Represents the output of a poll for jobs action.

" }, "PollForThirdPartyJobsInput":{ "type":"structure", "required":["actionTypeId"], "members":{ "actionTypeId":{"shape":"ActionTypeId"}, "maxBatchSize":{ "shape":"MaxBatchSize", "documentation":"

The maximum number of jobs to return in a poll for jobs call.

" } }, "documentation":"

Represents the input of a poll for third party jobs action.

" }, "PollForThirdPartyJobsOutput":{ "type":"structure", "members":{ "jobs":{ "shape":"ThirdPartyJobList", "documentation":"

Information about the jobs to take action on.

" } }, "documentation":"

Represents the output of a poll for third party jobs action.

" }, "PutActionRevisionInput":{ "type":"structure", "required":[ "pipelineName", "stageName", "actionName", "actionRevision" ], "members":{ "pipelineName":{ "shape":"PipelineName", "documentation":"

The name of the pipeline that will start processing the revision to the source.

" }, "stageName":{ "shape":"StageName", "documentation":"

The name of the stage that contains the action that will act upon the revision.

" }, "actionName":{ "shape":"ActionName", "documentation":"

The name of the action that will process the revision.

" }, "actionRevision":{"shape":"ActionRevision"} }, "documentation":"

Represents the input of a put action revision action.

" }, "PutActionRevisionOutput":{ "type":"structure", "members":{ "newRevision":{ "shape":"Boolean", "documentation":"

Indicates whether the artifact revision was previously used in an execution of the specified pipeline.

" }, "pipelineExecutionId":{ "shape":"PipelineExecutionId", "documentation":"

The ID of the current workflow state of the pipeline.

" } }, "documentation":"

Represents the output of a put action revision action.

" }, "PutApprovalResultInput":{ "type":"structure", "required":[ "pipelineName", "stageName", "actionName", "result", "token" ], "members":{ "pipelineName":{ "shape":"PipelineName", "documentation":"

The name of the pipeline that contains the action.

" }, "stageName":{ "shape":"StageName", "documentation":"

The name of the stage that contains the action.

" }, "actionName":{ "shape":"ActionName", "documentation":"

The name of the action for which approval is requested.

" }, "result":{ "shape":"ApprovalResult", "documentation":"

Represents information about the result of the approval request.

" }, "token":{ "shape":"ApprovalToken", "documentation":"

The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action and is used to validate that the approval request corresponding to this token is still valid.

" } }, "documentation":"

Represents the input of a put approval result action.

" }, "PutApprovalResultOutput":{ "type":"structure", "members":{ "approvedAt":{ "shape":"Timestamp", "documentation":"

The timestamp showing when the approval or rejection was submitted.

" } }, "documentation":"

Represents the output of a put approval result action.

" }, "PutJobFailureResultInput":{ "type":"structure", "required":[ "jobId", "failureDetails" ], "members":{ "jobId":{ "shape":"JobId", "documentation":"

The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.

" }, "failureDetails":{ "shape":"FailureDetails", "documentation":"

The details about the failure of a job.

" } }, "documentation":"

Represents the input of a put job failure result action.

" }, "PutJobSuccessResultInput":{ "type":"structure", "required":["jobId"], "members":{ "jobId":{ "shape":"JobId", "documentation":"

The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

" }, "currentRevision":{ "shape":"CurrentRevision", "documentation":"

The ID of the current revision of the artifact successfully worked upon by the job.

" }, "continuationToken":{ "shape":"ContinuationToken", "documentation":"

A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the custom action. When the action is complete, no continuation token should be supplied.

" }, "executionDetails":{ "shape":"ExecutionDetails", "documentation":"

The execution details of the successful job, such as the actions taken by the job worker.

" } }, "documentation":"

Represents the input of a put job success result action.

" }, "PutThirdPartyJobFailureResultInput":{ "type":"structure", "required":[ "jobId", "clientToken", "failureDetails" ], "members":{ "jobId":{ "shape":"ThirdPartyJobId", "documentation":"

The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

" }, "failureDetails":{"shape":"FailureDetails"} }, "documentation":"

Represents the input of a third party job failure result action.

" }, "PutThirdPartyJobSuccessResultInput":{ "type":"structure", "required":[ "jobId", "clientToken" ], "members":{ "jobId":{ "shape":"ThirdPartyJobId", "documentation":"

The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

" }, "currentRevision":{"shape":"CurrentRevision"}, "continuationToken":{ "shape":"ContinuationToken", "documentation":"

A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the partner action. When the action is complete, no continuation token should be supplied.

" }, "executionDetails":{"shape":"ExecutionDetails"} }, "documentation":"

Represents the input of a put third party job success result action.

" }, "QueryParamMap":{ "type":"map", "key":{"shape":"ActionConfigurationKey"}, "value":{"shape":"ActionConfigurationQueryableValue"}, "max":1, "min":0 }, "RetryStageExecutionInput":{ "type":"structure", "required":[ "pipelineName", "stageName", "pipelineExecutionId", "retryMode" ], "members":{ "pipelineName":{ "shape":"PipelineName", "documentation":"

The name of the pipeline that contains the failed stage.

" }, "stageName":{ "shape":"StageName", "documentation":"

The name of the failed stage to be retried.

" }, "pipelineExecutionId":{ "shape":"PipelineExecutionId", "documentation":"

The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the failed stage

" }, "retryMode":{ "shape":"StageRetryMode", "documentation":"

The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.

" } }, "documentation":"

Represents the input of a retry stage execution action.

" }, "RetryStageExecutionOutput":{ "type":"structure", "members":{ "pipelineExecutionId":{ "shape":"PipelineExecutionId", "documentation":"

The ID of the current workflow execution in the failed stage.

" } }, "documentation":"

Represents the output of a retry stage execution action.

" }, "Revision":{ "type":"string", "max":1500, "min":1 }, "RevisionChangeIdentifier":{ "type":"string", "max":100, "min":1 }, "RevisionSummary":{ "type":"string", "max":2048, "min":1 }, "RoleArn":{ "type":"string", "max":1024, "pattern":"arn:aws(-[\\w]+)*:iam::[0-9]{12}:role/.*" }, "S3ArtifactLocation":{ "type":"structure", "required":[ "bucketName", "objectKey" ], "members":{ "bucketName":{ "shape":"S3BucketName", "documentation":"

The name of the Amazon S3 bucket.

" }, "objectKey":{ "shape":"S3ObjectKey", "documentation":"

The key of the object in the Amazon S3 bucket, which uniquely identifies the object in the bucket.

" } }, "documentation":"

The location of the Amazon S3 bucket that contains a revision.

" }, "S3BucketName":{"type":"string"}, "S3ObjectKey":{"type":"string"}, "SecretAccessKey":{"type":"string"}, "SessionToken":{"type":"string"}, "StageActionDeclarationList":{ "type":"list", "member":{"shape":"ActionDeclaration"} }, "StageBlockerDeclarationList":{ "type":"list", "member":{"shape":"BlockerDeclaration"} }, "StageContext":{ "type":"structure", "members":{ "name":{ "shape":"StageName", "documentation":"

The name of the stage.

" } }, "documentation":"

Represents information about a stage to a job worker.

" }, "StageDeclaration":{ "type":"structure", "required":[ "name", "actions" ], "members":{ "name":{ "shape":"StageName", "documentation":"

The name of the stage.

" }, "blockers":{ "shape":"StageBlockerDeclarationList", "documentation":"

Reserved for future use.

" }, "actions":{ "shape":"StageActionDeclarationList", "documentation":"

The actions included in a stage.

" } }, "documentation":"

Represents information about a stage and its definition.

" }, "StageExecution":{ "type":"structure", "required":[ "pipelineExecutionId", "status" ], "members":{ "pipelineExecutionId":{ "shape":"PipelineExecutionId", "documentation":"

The ID of the pipeline execution associated with the stage.

" }, "status":{ "shape":"StageExecutionStatus", "documentation":"

The status of the stage, or for a completed stage, the last status of the stage.

" } }, "documentation":"

Represents information about the run of a stage.

" }, "StageExecutionStatus":{ "type":"string", "enum":[ "InProgress", "Failed", "Succeeded" ] }, "StageName":{ "type":"string", "max":100, "min":1, "pattern":"[A-Za-z0-9.@\\-_]+" }, "StageNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified stage was specified in an invalid format or cannot be found.

", "exception":true }, "StageNotRetryableException":{ "type":"structure", "members":{ }, "documentation":"

The specified stage can't be retried because the pipeline structure or stage state changed after the stage was not completed; the stage contains no failed actions; one or more actions are still in progress; or another retry attempt is already in progress.

", "exception":true }, "StageRetryMode":{ "type":"string", "enum":["FAILED_ACTIONS"] }, "StageState":{ "type":"structure", "members":{ "stageName":{ "shape":"StageName", "documentation":"

The name of the stage.

" }, "inboundTransitionState":{ "shape":"TransitionState", "documentation":"

The state of the inbound transition, which is either enabled or disabled.

" }, "actionStates":{ "shape":"ActionStateList", "documentation":"

The state of the stage.

" }, "latestExecution":{ "shape":"StageExecution", "documentation":"

Information about the latest execution in the stage, including its ID and status.

" } }, "documentation":"

Represents information about the state of the stage.

" }, "StageStateList":{ "type":"list", "member":{"shape":"StageState"} }, "StageTransitionType":{ "type":"string", "enum":[ "Inbound", "Outbound" ] }, "StartPipelineExecutionInput":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"PipelineName", "documentation":"

The name of the pipeline to start.

" } }, "documentation":"

Represents the input of a start pipeline execution action.

" }, "StartPipelineExecutionOutput":{ "type":"structure", "members":{ "pipelineExecutionId":{ "shape":"PipelineExecutionId", "documentation":"

The unique system-generated ID of the pipeline execution that was started.

" } }, "documentation":"

Represents the output of a start pipeline execution action.

" }, "ThirdPartyJob":{ "type":"structure", "members":{ "clientId":{ "shape":"ClientId", "documentation":"

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

" }, "jobId":{ "shape":"JobId", "documentation":"

The identifier used to identify the job in AWS CodePipeline.

" } }, "documentation":"

A response to a PollForThirdPartyJobs request returned by AWS CodePipeline when there is a job to be worked upon by a partner action.

" }, "ThirdPartyJobData":{ "type":"structure", "members":{ "actionTypeId":{"shape":"ActionTypeId"}, "actionConfiguration":{"shape":"ActionConfiguration"}, "pipelineContext":{"shape":"PipelineContext"}, "inputArtifacts":{ "shape":"ArtifactList", "documentation":"

The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as \"MyApp\", or might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.

" }, "outputArtifacts":{ "shape":"ArtifactList", "documentation":"

The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as \"MyBuiltApp\", or might be defined by the user when the action is created.

" }, "artifactCredentials":{"shape":"AWSSessionCredentials"}, "continuationToken":{ "shape":"ContinuationToken", "documentation":"

A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.

" }, "encryptionKey":{ "shape":"EncryptionKey", "documentation":"

The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.

" } }, "documentation":"

Represents information about the job data for a partner action.

" }, "ThirdPartyJobDetails":{ "type":"structure", "members":{ "id":{ "shape":"ThirdPartyJobId", "documentation":"

The identifier used to identify the job details in AWS CodePipeline.

" }, "data":{ "shape":"ThirdPartyJobData", "documentation":"

The data to be returned by the third party job worker.

" }, "nonce":{ "shape":"Nonce", "documentation":"

A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeThirdPartyJob request.

" } }, "documentation":"

The details of a job sent in response to a GetThirdPartyJobDetails request.

" }, "ThirdPartyJobId":{ "type":"string", "max":512, "min":1 }, "ThirdPartyJobList":{ "type":"list", "member":{"shape":"ThirdPartyJob"} }, "Time":{"type":"timestamp"}, "Timestamp":{"type":"timestamp"}, "TransitionState":{ "type":"structure", "members":{ "enabled":{ "shape":"Enabled", "documentation":"

Whether the transition between stages is enabled (true) or disabled (false).

" }, "lastChangedBy":{ "shape":"LastChangedBy", "documentation":"

The ID of the user who last changed the transition state.

" }, "lastChangedAt":{ "shape":"LastChangedAt", "documentation":"

The timestamp when the transition state was last changed.

" }, "disabledReason":{ "shape":"DisabledReason", "documentation":"

The user-specified reason why the transition between two stages of a pipeline was disabled.

" } }, "documentation":"

Represents information about the state of transitions between one stage and another stage.

" }, "UpdatePipelineInput":{ "type":"structure", "required":["pipeline"], "members":{ "pipeline":{ "shape":"PipelineDeclaration", "documentation":"

The name of the pipeline to be updated.

" } }, "documentation":"

Represents the input of an update pipeline action.

" }, "UpdatePipelineOutput":{ "type":"structure", "members":{ "pipeline":{ "shape":"PipelineDeclaration", "documentation":"

The structure of the updated pipeline.

" } }, "documentation":"

Represents the output of an update pipeline action.

" }, "Url":{ "type":"string", "max":2048, "min":1 }, "UrlTemplate":{ "type":"string", "max":2048, "min":1 }, "ValidationException":{ "type":"structure", "members":{ }, "documentation":"

The validation was specified in an invalid format.

", "exception":true }, "Version":{ "type":"string", "max":9, "min":1, "pattern":"[0-9A-Za-z_-]+" } }, "documentation":"AWS CodePipeline

Overview

This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline is only configurable through the API. For additional information, see the AWS CodePipeline User Guide.

You can use the AWS CodePipeline API to work with pipelines, stages, actions, gates, and transitions, as described below.

Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of actions, gates, and stages.

You can work with pipelines by calling:

  • CreatePipeline, which creates a uniquely-named pipeline.

  • DeletePipeline, which deletes the specified pipeline.

  • GetPipeline, which returns information about a pipeline structure.

  • GetPipelineExecution, which returns information about a specific execution of a pipeline.

  • GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.

  • ListPipelines, which gets a summary of all of the pipelines associated with your account.

  • StartPipelineExecution, which runs the the most recent revision of an artifact through the pipeline.

  • UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.

Pipelines include stages, which are logical groupings of gates and actions. Each stage contains one or more actions that must complete before the next stage begins. A stage will result in success or failure. If a stage fails, then the pipeline stops at that stage and will remain stopped until either a new version of an artifact appears in the source location, or a user takes action to re-run the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, also refer to the AWS CodePipeline Pipeline Structure Reference.

Pipeline stages include actions, which are categorized into categories such as source or build actions performed within a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState.

Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.

You can work with transitions by calling:

Using the API to integrate with AWS CodePipeline

For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. In order to integrate with AWS CodePipeline, developers will need to work with the following items:

Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.

You can work with jobs by calling:

Third party jobs, which are instances of an action created by a partner action and integrated into AWS CodePipeline. Partner actions are created by members of the AWS Partner Network.

You can work with third party jobs by calling:

" } botocore-1.5.7/botocore/data/elb/0000777454262600001440000000000013042511307017675 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/elb/2012-06-01/0000777454262600001440000000000013042511307020722 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/elb/2012-06-01/paginators-1.json0000666454262600001440000000032013042511306024114 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeLoadBalancers": { "input_token": "Marker", "output_token": "NextMarker", "result_key": "LoadBalancerDescriptions", "limit_key": "PageSize" } } } botocore-1.5.7/botocore/data/elb/2012-06-01/service-2.json0000666454262600001440000027030513042511306023422 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"elasticloadbalancing-2012-06-01", "apiVersion":"2012-06-01", "endpointPrefix":"elasticloadbalancing", "protocol":"query", "serviceFullName":"Elastic Load Balancing", "signatureVersion":"v4", "xmlNamespace":"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/" }, "operations":{ "AddTags":{ "name":"AddTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsInput"}, "output":{ "shape":"AddTagsOutput", "resultWrapper":"AddTagsResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"TooManyTagsException"}, {"shape":"DuplicateTagKeysException"} ], "documentation":"

Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, AddTags updates its value.

For more information, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide.

" }, "ApplySecurityGroupsToLoadBalancer":{ "name":"ApplySecurityGroupsToLoadBalancer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ApplySecurityGroupsToLoadBalancerInput"}, "output":{ "shape":"ApplySecurityGroupsToLoadBalancerOutput", "resultWrapper":"ApplySecurityGroupsToLoadBalancerResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"InvalidConfigurationRequestException"}, {"shape":"InvalidSecurityGroupException"} ], "documentation":"

Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups.

For more information, see Security Groups for Load Balancers in a VPC in the Classic Load Balancers Guide.

" }, "AttachLoadBalancerToSubnets":{ "name":"AttachLoadBalancerToSubnets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachLoadBalancerToSubnetsInput"}, "output":{ "shape":"AttachLoadBalancerToSubnetsOutput", "resultWrapper":"AttachLoadBalancerToSubnetsResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"InvalidConfigurationRequestException"}, {"shape":"SubnetNotFoundException"}, {"shape":"InvalidSubnetException"} ], "documentation":"

Adds one or more subnets to the set of configured subnets for the specified load balancer.

The load balancer evenly distributes requests across all registered subnets. For more information, see Add or Remove Subnets for Your Load Balancer in a VPC in the Classic Load Balancers Guide.

" }, "ConfigureHealthCheck":{ "name":"ConfigureHealthCheck", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfigureHealthCheckInput"}, "output":{ "shape":"ConfigureHealthCheckOutput", "resultWrapper":"ConfigureHealthCheckResult" }, "errors":[ {"shape":"AccessPointNotFoundException"} ], "documentation":"

Specifies the health check settings to use when evaluating the health state of your EC2 instances.

For more information, see Configure Health Checks for Your Load Balancer in the Classic Load Balancers Guide.

" }, "CreateAppCookieStickinessPolicy":{ "name":"CreateAppCookieStickinessPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAppCookieStickinessPolicyInput"}, "output":{ "shape":"CreateAppCookieStickinessPolicyOutput", "resultWrapper":"CreateAppCookieStickinessPolicyResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"DuplicatePolicyNameException"}, {"shape":"TooManyPoliciesException"}, {"shape":"InvalidConfigurationRequestException"} ], "documentation":"

Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.

This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie, AWSELB, follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie.

If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.

For more information, see Application-Controlled Session Stickiness in the Classic Load Balancers Guide.

" }, "CreateLBCookieStickinessPolicy":{ "name":"CreateLBCookieStickinessPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateLBCookieStickinessPolicyInput"}, "output":{ "shape":"CreateLBCookieStickinessPolicyOutput", "resultWrapper":"CreateLBCookieStickinessPolicyResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"DuplicatePolicyNameException"}, {"shape":"TooManyPoliciesException"}, {"shape":"InvalidConfigurationRequestException"} ], "documentation":"

Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.

When a load balancer implements this policy, the load balancer uses a special cookie to track the instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm.

A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.

For more information, see Duration-Based Session Stickiness in the Classic Load Balancers Guide.

" }, "CreateLoadBalancer":{ "name":"CreateLoadBalancer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAccessPointInput"}, "output":{ "shape":"CreateAccessPointOutput", "resultWrapper":"CreateLoadBalancerResult" }, "errors":[ {"shape":"DuplicateAccessPointNameException"}, {"shape":"TooManyAccessPointsException"}, {"shape":"CertificateNotFoundException"}, {"shape":"InvalidConfigurationRequestException"}, {"shape":"SubnetNotFoundException"}, {"shape":"InvalidSubnetException"}, {"shape":"InvalidSecurityGroupException"}, {"shape":"InvalidSchemeException"}, {"shape":"TooManyTagsException"}, {"shape":"DuplicateTagKeysException"}, {"shape":"UnsupportedProtocolException"} ], "documentation":"

Creates a Classic load balancer.

You can add listeners, security groups, subnets, and tags when you create your load balancer, or you can add them later using CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer, AttachLoadBalancerToSubnets, and AddTags.

To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.

You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide.

" }, "CreateLoadBalancerListeners":{ "name":"CreateLoadBalancerListeners", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateLoadBalancerListenerInput"}, "output":{ "shape":"CreateLoadBalancerListenerOutput", "resultWrapper":"CreateLoadBalancerListenersResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"DuplicateListenerException"}, {"shape":"CertificateNotFoundException"}, {"shape":"InvalidConfigurationRequestException"}, {"shape":"UnsupportedProtocolException"} ], "documentation":"

Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener.

For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.

" }, "CreateLoadBalancerPolicy":{ "name":"CreateLoadBalancerPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateLoadBalancerPolicyInput"}, "output":{ "shape":"CreateLoadBalancerPolicyOutput", "resultWrapper":"CreateLoadBalancerPolicyResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"PolicyTypeNotFoundException"}, {"shape":"DuplicatePolicyNameException"}, {"shape":"TooManyPoliciesException"}, {"shape":"InvalidConfigurationRequestException"} ], "documentation":"

Creates a policy with the specified attributes for the specified load balancer.

Policies are settings that are saved for your load balancer and that can be applied to the listener or the application server, depending on the policy type.

" }, "DeleteLoadBalancer":{ "name":"DeleteLoadBalancer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAccessPointInput"}, "output":{ "shape":"DeleteAccessPointOutput", "resultWrapper":"DeleteLoadBalancerResult" }, "documentation":"

Deletes the specified load balancer.

If you are attempting to recreate a load balancer, you must reconfigure all settings. The DNS name associated with a deleted load balancer are no longer usable. The name and associated DNS record of the deleted load balancer no longer exist and traffic sent to any of its IP addresses is no longer delivered to your instances.

If the load balancer does not exist or has already been deleted, the call to DeleteLoadBalancer still succeeds.

" }, "DeleteLoadBalancerListeners":{ "name":"DeleteLoadBalancerListeners", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteLoadBalancerListenerInput"}, "output":{ "shape":"DeleteLoadBalancerListenerOutput", "resultWrapper":"DeleteLoadBalancerListenersResult" }, "errors":[ {"shape":"AccessPointNotFoundException"} ], "documentation":"

Deletes the specified listeners from the specified load balancer.

" }, "DeleteLoadBalancerPolicy":{ "name":"DeleteLoadBalancerPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteLoadBalancerPolicyInput"}, "output":{ "shape":"DeleteLoadBalancerPolicyOutput", "resultWrapper":"DeleteLoadBalancerPolicyResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"InvalidConfigurationRequestException"} ], "documentation":"

Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.

" }, "DeregisterInstancesFromLoadBalancer":{ "name":"DeregisterInstancesFromLoadBalancer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterEndPointsInput"}, "output":{ "shape":"DeregisterEndPointsOutput", "resultWrapper":"DeregisterInstancesFromLoadBalancerResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"InvalidEndPointException"} ], "documentation":"

Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.

You can use DescribeLoadBalancers to verify that the instance is deregistered from the load balancer.

For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide.

" }, "DescribeInstanceHealth":{ "name":"DescribeInstanceHealth", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEndPointStateInput"}, "output":{ "shape":"DescribeEndPointStateOutput", "resultWrapper":"DescribeInstanceHealthResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"InvalidEndPointException"} ], "documentation":"

Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned.

" }, "DescribeLoadBalancerAttributes":{ "name":"DescribeLoadBalancerAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLoadBalancerAttributesInput"}, "output":{ "shape":"DescribeLoadBalancerAttributesOutput", "resultWrapper":"DescribeLoadBalancerAttributesResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"LoadBalancerAttributeNotFoundException"} ], "documentation":"

Describes the attributes for the specified load balancer.

" }, "DescribeLoadBalancerPolicies":{ "name":"DescribeLoadBalancerPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLoadBalancerPoliciesInput"}, "output":{ "shape":"DescribeLoadBalancerPoliciesOutput", "resultWrapper":"DescribeLoadBalancerPoliciesResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"PolicyNotFoundException"} ], "documentation":"

Describes the specified policies.

If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. The names of the sample policies have the ELBSample- prefix.

" }, "DescribeLoadBalancerPolicyTypes":{ "name":"DescribeLoadBalancerPolicyTypes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLoadBalancerPolicyTypesInput"}, "output":{ "shape":"DescribeLoadBalancerPolicyTypesOutput", "resultWrapper":"DescribeLoadBalancerPolicyTypesResult" }, "errors":[ {"shape":"PolicyTypeNotFoundException"} ], "documentation":"

Describes the specified load balancer policy types or all load balancer policy types.

The description of each type indicates how it can be used. For example, some policies can be used only with layer 7 listeners, some policies can be used only with layer 4 listeners, and some policies can be used only with your EC2 instances.

You can use CreateLoadBalancerPolicy to create a policy configuration for any of these policy types. Then, depending on the policy type, use either SetLoadBalancerPoliciesOfListener or SetLoadBalancerPoliciesForBackendServer to set the policy.

" }, "DescribeLoadBalancers":{ "name":"DescribeLoadBalancers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAccessPointsInput"}, "output":{ "shape":"DescribeAccessPointsOutput", "resultWrapper":"DescribeLoadBalancersResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"DependencyThrottleException"} ], "documentation":"

Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsInput"}, "output":{ "shape":"DescribeTagsOutput", "resultWrapper":"DescribeTagsResult" }, "errors":[ {"shape":"AccessPointNotFoundException"} ], "documentation":"

Describes the tags associated with the specified load balancers.

" }, "DetachLoadBalancerFromSubnets":{ "name":"DetachLoadBalancerFromSubnets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachLoadBalancerFromSubnetsInput"}, "output":{ "shape":"DetachLoadBalancerFromSubnetsOutput", "resultWrapper":"DetachLoadBalancerFromSubnetsResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"InvalidConfigurationRequestException"} ], "documentation":"

Removes the specified subnets from the set of configured subnets for the load balancer.

After a subnet is removed, all EC2 instances registered with the load balancer in the removed subnet go into the OutOfService state. Then, the load balancer balances the traffic among the remaining routable subnets.

" }, "DisableAvailabilityZonesForLoadBalancer":{ "name":"DisableAvailabilityZonesForLoadBalancer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveAvailabilityZonesInput"}, "output":{ "shape":"RemoveAvailabilityZonesOutput", "resultWrapper":"DisableAvailabilityZonesForLoadBalancerResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"InvalidConfigurationRequestException"} ], "documentation":"

Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer.

There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones.

For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide.

" }, "EnableAvailabilityZonesForLoadBalancer":{ "name":"EnableAvailabilityZonesForLoadBalancer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddAvailabilityZonesInput"}, "output":{ "shape":"AddAvailabilityZonesOutput", "resultWrapper":"EnableAvailabilityZonesForLoadBalancerResult" }, "errors":[ {"shape":"AccessPointNotFoundException"} ], "documentation":"

Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer.

The load balancer evenly distributes requests across all its registered Availability Zones that contain instances.

For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide.

" }, "ModifyLoadBalancerAttributes":{ "name":"ModifyLoadBalancerAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyLoadBalancerAttributesInput"}, "output":{ "shape":"ModifyLoadBalancerAttributesOutput", "resultWrapper":"ModifyLoadBalancerAttributesResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"LoadBalancerAttributeNotFoundException"}, {"shape":"InvalidConfigurationRequestException"} ], "documentation":"

Modifies the attributes of the specified load balancer.

You can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute ConnectionSettings by specifying an idle connection timeout value for your load balancer.

For more information, see the following in the Classic Load Balancers Guide:

" }, "RegisterInstancesWithLoadBalancer":{ "name":"RegisterInstancesWithLoadBalancer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterEndPointsInput"}, "output":{ "shape":"RegisterEndPointsOutput", "resultWrapper":"RegisterInstancesWithLoadBalancerResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"InvalidEndPointException"} ], "documentation":"

Adds the specified instances to the specified load balancer.

The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC.

Note that RegisterInstanceWithLoadBalancer completes when the request has been registered. Instance registration takes a little time to complete. To check the state of the registered instances, use DescribeLoadBalancers or DescribeInstanceHealth.

After the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in one of the Availability Zones registered for the load balancer is moved to the OutOfService state. If an Availability Zone is added to the load balancer later, any instances registered with the load balancer move to the InService state.

To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.

For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide.

" }, "RemoveTags":{ "name":"RemoveTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTagsInput"}, "output":{ "shape":"RemoveTagsOutput", "resultWrapper":"RemoveTagsResult" }, "errors":[ {"shape":"AccessPointNotFoundException"} ], "documentation":"

Removes one or more tags from the specified load balancer.

" }, "SetLoadBalancerListenerSSLCertificate":{ "name":"SetLoadBalancerListenerSSLCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetLoadBalancerListenerSSLCertificateInput"}, "output":{ "shape":"SetLoadBalancerListenerSSLCertificateOutput", "resultWrapper":"SetLoadBalancerListenerSSLCertificateResult" }, "errors":[ {"shape":"CertificateNotFoundException"}, {"shape":"AccessPointNotFoundException"}, {"shape":"ListenerNotFoundException"}, {"shape":"InvalidConfigurationRequestException"}, {"shape":"UnsupportedProtocolException"} ], "documentation":"

Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port.

For more information about updating your SSL certificate, see Replace the SSL Certificate for Your Load Balancer in the Classic Load Balancers Guide.

" }, "SetLoadBalancerPoliciesForBackendServer":{ "name":"SetLoadBalancerPoliciesForBackendServer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetLoadBalancerPoliciesForBackendServerInput"}, "output":{ "shape":"SetLoadBalancerPoliciesForBackendServerOutput", "resultWrapper":"SetLoadBalancerPoliciesForBackendServerResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"PolicyNotFoundException"}, {"shape":"InvalidConfigurationRequestException"} ], "documentation":"

Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the instance ports; this policy type is composed of multiple public key policies.

Each time you use SetLoadBalancerPoliciesForBackendServer to enable the policies, use the PolicyNames parameter to list the policies that you want to enable.

You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to verify that the policy is associated with the EC2 instance.

For more information about enabling back-end instance authentication, see Configure Back-end Instance Authentication in the Classic Load Balancers Guide. For more information about Proxy Protocol, see Configure Proxy Protocol Support in the Classic Load Balancers Guide.

" }, "SetLoadBalancerPoliciesOfListener":{ "name":"SetLoadBalancerPoliciesOfListener", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetLoadBalancerPoliciesOfListenerInput"}, "output":{ "shape":"SetLoadBalancerPoliciesOfListenerOutput", "resultWrapper":"SetLoadBalancerPoliciesOfListenerResult" }, "errors":[ {"shape":"AccessPointNotFoundException"}, {"shape":"PolicyNotFoundException"}, {"shape":"ListenerNotFoundException"}, {"shape":"InvalidConfigurationRequestException"} ], "documentation":"

Replaces the current set of policies for the specified load balancer port with the specified set of policies.

To enable back-end server authentication, use SetLoadBalancerPoliciesForBackendServer.

For more information about setting policies, see Update the SSL Negotiation Configuration, Duration-Based Session Stickiness, and Application-Controlled Session Stickiness in the Classic Load Balancers Guide.

" } }, "shapes":{ "AccessLog":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"AccessLogEnabled", "documentation":"

Specifies whether access logs are enabled for the load balancer.

" }, "S3BucketName":{ "shape":"S3BucketName", "documentation":"

The name of the Amazon S3 bucket where the access logs are stored.

" }, "EmitInterval":{ "shape":"AccessLogInterval", "documentation":"

The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.

Default: 60 minutes

" }, "S3BucketPrefix":{ "shape":"AccessLogPrefix", "documentation":"

The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket.

" } }, "documentation":"

Information about the AccessLog attribute.

" }, "AccessLogEnabled":{"type":"boolean"}, "AccessLogInterval":{"type":"integer"}, "AccessLogPrefix":{"type":"string"}, "AccessPointName":{"type":"string"}, "AccessPointNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified load balancer does not exist.

", "error":{ "code":"LoadBalancerNotFound", "httpStatusCode":400, "senderFault":true }, "exception":true }, "AccessPointPort":{"type":"integer"}, "AddAvailabilityZonesInput":{ "type":"structure", "required":[ "LoadBalancerName", "AvailabilityZones" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

The Availability Zones. These must be in the same region as the load balancer.

" } }, "documentation":"

Contains the parameters for EnableAvailabilityZonesForLoadBalancer.

" }, "AddAvailabilityZonesOutput":{ "type":"structure", "members":{ "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

The updated list of Availability Zones for the load balancer.

" } }, "documentation":"

Contains the output of EnableAvailabilityZonesForLoadBalancer.

" }, "AddTagsInput":{ "type":"structure", "required":[ "LoadBalancerNames", "Tags" ], "members":{ "LoadBalancerNames":{ "shape":"LoadBalancerNames", "documentation":"

The name of the load balancer. You can specify one load balancer only.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags.

" } }, "documentation":"

Contains the parameters for AddTags.

" }, "AddTagsOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of AddTags.

" }, "AdditionalAttribute":{ "type":"structure", "members":{ "Key":{ "shape":"AdditionalAttributeKey", "documentation":"

This parameter is reserved.

" }, "Value":{ "shape":"AdditionalAttributeValue", "documentation":"

This parameter is reserved.

" } }, "documentation":"

This data type is reserved.

" }, "AdditionalAttributeKey":{ "type":"string", "max":256, "pattern":"^[a-zA-Z0-9.]+$" }, "AdditionalAttributeValue":{ "type":"string", "max":256, "pattern":"^[a-zA-Z0-9.]+$" }, "AdditionalAttributes":{ "type":"list", "member":{"shape":"AdditionalAttribute"}, "max":10 }, "AppCookieStickinessPolicies":{ "type":"list", "member":{"shape":"AppCookieStickinessPolicy"} }, "AppCookieStickinessPolicy":{ "type":"structure", "members":{ "PolicyName":{ "shape":"PolicyName", "documentation":"

The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.

" }, "CookieName":{ "shape":"CookieName", "documentation":"

The name of the application cookie used for stickiness.

" } }, "documentation":"

Information about a policy for application-controlled session stickiness.

" }, "ApplySecurityGroupsToLoadBalancerInput":{ "type":"structure", "required":[ "LoadBalancerName", "SecurityGroups" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

The IDs of the security groups to associate with the load balancer. Note that you cannot specify the name of the security group.

" } }, "documentation":"

Contains the parameters for ApplySecurityGroupsToLoadBalancer.

" }, "ApplySecurityGroupsToLoadBalancerOutput":{ "type":"structure", "members":{ "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

The IDs of the security groups associated with the load balancer.

" } }, "documentation":"

Contains the output of ApplySecurityGroupsToLoadBalancer.

" }, "AttachLoadBalancerToSubnetsInput":{ "type":"structure", "required":[ "LoadBalancerName", "Subnets" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "Subnets":{ "shape":"Subnets", "documentation":"

The IDs of the subnets to add. You can add only one subnet per Availability Zone.

" } }, "documentation":"

Contains the parameters for AttachLoaBalancerToSubnets.

" }, "AttachLoadBalancerToSubnetsOutput":{ "type":"structure", "members":{ "Subnets":{ "shape":"Subnets", "documentation":"

The IDs of the subnets attached to the load balancer.

" } }, "documentation":"

Contains the output of AttachLoadBalancerToSubnets.

" }, "AttributeName":{"type":"string"}, "AttributeType":{"type":"string"}, "AttributeValue":{"type":"string"}, "AvailabilityZone":{"type":"string"}, "AvailabilityZones":{ "type":"list", "member":{"shape":"AvailabilityZone"} }, "BackendServerDescription":{ "type":"structure", "members":{ "InstancePort":{ "shape":"InstancePort", "documentation":"

The port on which the EC2 instance is listening.

" }, "PolicyNames":{ "shape":"PolicyNames", "documentation":"

The names of the policies enabled for the EC2 instance.

" } }, "documentation":"

Information about the configuration of an EC2 instance.

" }, "BackendServerDescriptions":{ "type":"list", "member":{"shape":"BackendServerDescription"} }, "Cardinality":{"type":"string"}, "CertificateNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified ARN does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM) or AWS Certificate Manager (ACM). Note that if you recently uploaded the certificate to IAM, this error might indicate that the certificate is not fully available yet.

", "error":{ "code":"CertificateNotFound", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ConfigureHealthCheckInput":{ "type":"structure", "required":[ "LoadBalancerName", "HealthCheck" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "HealthCheck":{ "shape":"HealthCheck", "documentation":"

The configuration information.

" } }, "documentation":"

Contains the parameters for ConfigureHealthCheck.

" }, "ConfigureHealthCheckOutput":{ "type":"structure", "members":{ "HealthCheck":{ "shape":"HealthCheck", "documentation":"

The updated health check.

" } }, "documentation":"

Contains the output of ConfigureHealthCheck.

" }, "ConnectionDraining":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"ConnectionDrainingEnabled", "documentation":"

Specifies whether connection draining is enabled for the load balancer.

" }, "Timeout":{ "shape":"ConnectionDrainingTimeout", "documentation":"

The maximum time, in seconds, to keep the existing connections open before deregistering the instances.

" } }, "documentation":"

Information about the ConnectionDraining attribute.

" }, "ConnectionDrainingEnabled":{"type":"boolean"}, "ConnectionDrainingTimeout":{"type":"integer"}, "ConnectionSettings":{ "type":"structure", "required":["IdleTimeout"], "members":{ "IdleTimeout":{ "shape":"IdleTimeout", "documentation":"

The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.

" } }, "documentation":"

Information about the ConnectionSettings attribute.

" }, "CookieExpirationPeriod":{"type":"long"}, "CookieName":{"type":"string"}, "CreateAccessPointInput":{ "type":"structure", "required":[ "LoadBalancerName", "Listeners" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

This name must be unique within your set of load balancers for the region, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen.

" }, "Listeners":{ "shape":"Listeners", "documentation":"

The listeners.

For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.

" }, "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

One or more Availability Zones from the same region as the load balancer.

You must specify at least one Availability Zone.

You can add more Availability Zones after you create the load balancer using EnableAvailabilityZonesForLoadBalancer.

" }, "Subnets":{ "shape":"Subnets", "documentation":"

The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones.

" }, "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

The IDs of the security groups to assign to the load balancer.

" }, "Scheme":{ "shape":"LoadBalancerScheme", "documentation":"

The type of a load balancer. Valid only for load balancers in a VPC.

By default, Elastic Load Balancing creates an Internet-facing load balancer with a DNS name that resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Load Balancer Scheme in the Elastic Load Balancing User Guide.

Specify internal to create a load balancer with a DNS name that resolves to private IP addresses.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of tags to assign to the load balancer.

For more information about tagging your load balancer, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide.

" } }, "documentation":"

Contains the parameters for CreateLoadBalancer.

" }, "CreateAccessPointOutput":{ "type":"structure", "members":{ "DNSName":{ "shape":"DNSName", "documentation":"

The DNS name of the load balancer.

" } }, "documentation":"

Contains the output for CreateLoadBalancer.

" }, "CreateAppCookieStickinessPolicyInput":{ "type":"structure", "required":[ "LoadBalancerName", "PolicyName", "CookieName" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "PolicyName":{ "shape":"PolicyName", "documentation":"

The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.

" }, "CookieName":{ "shape":"CookieName", "documentation":"

The name of the application cookie used for stickiness.

" } }, "documentation":"

Contains the parameters for CreateAppCookieStickinessPolicy.

" }, "CreateAppCookieStickinessPolicyOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the output for CreateAppCookieStickinessPolicy.

" }, "CreateLBCookieStickinessPolicyInput":{ "type":"structure", "required":[ "LoadBalancerName", "PolicyName" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "PolicyName":{ "shape":"PolicyName", "documentation":"

The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.

" }, "CookieExpirationPeriod":{ "shape":"CookieExpirationPeriod", "documentation":"

The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.

" } }, "documentation":"

Contains the parameters for CreateLBCookieStickinessPolicy.

" }, "CreateLBCookieStickinessPolicyOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the output for CreateLBCookieStickinessPolicy.

" }, "CreateLoadBalancerListenerInput":{ "type":"structure", "required":[ "LoadBalancerName", "Listeners" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "Listeners":{ "shape":"Listeners", "documentation":"

The listeners.

" } }, "documentation":"

Contains the parameters for CreateLoadBalancerListeners.

" }, "CreateLoadBalancerListenerOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the parameters for CreateLoadBalancerListener.

" }, "CreateLoadBalancerPolicyInput":{ "type":"structure", "required":[ "LoadBalancerName", "PolicyName", "PolicyTypeName" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "PolicyName":{ "shape":"PolicyName", "documentation":"

The name of the load balancer policy to be created. This name must be unique within the set of policies for this load balancer.

" }, "PolicyTypeName":{ "shape":"PolicyTypeName", "documentation":"

The name of the base policy type. To get the list of policy types, use DescribeLoadBalancerPolicyTypes.

" }, "PolicyAttributes":{ "shape":"PolicyAttributes", "documentation":"

The policy attributes.

" } }, "documentation":"

Contains the parameters for CreateLoadBalancerPolicy.

" }, "CreateLoadBalancerPolicyOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of CreateLoadBalancerPolicy.

" }, "CreatedTime":{"type":"timestamp"}, "CrossZoneLoadBalancing":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"CrossZoneLoadBalancingEnabled", "documentation":"

Specifies whether cross-zone load balancing is enabled for the load balancer.

" } }, "documentation":"

Information about the CrossZoneLoadBalancing attribute.

" }, "CrossZoneLoadBalancingEnabled":{"type":"boolean"}, "DNSName":{"type":"string"}, "DefaultValue":{"type":"string"}, "DeleteAccessPointInput":{ "type":"structure", "required":["LoadBalancerName"], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" } }, "documentation":"

Contains the parameters for DeleteLoadBalancer.

" }, "DeleteAccessPointOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of DeleteLoadBalancer.

" }, "DeleteLoadBalancerListenerInput":{ "type":"structure", "required":[ "LoadBalancerName", "LoadBalancerPorts" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "LoadBalancerPorts":{ "shape":"Ports", "documentation":"

The client port numbers of the listeners.

" } }, "documentation":"

Contains the parameters for DeleteLoadBalancerListeners.

" }, "DeleteLoadBalancerListenerOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of DeleteLoadBalancerListeners.

" }, "DeleteLoadBalancerPolicyInput":{ "type":"structure", "required":[ "LoadBalancerName", "PolicyName" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "PolicyName":{ "shape":"PolicyName", "documentation":"

The name of the policy.

" } }, "documentation":"

Contains the parameters for DeleteLoadBalancerPolicy.

" }, "DeleteLoadBalancerPolicyOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of DeleteLoadBalancerPolicy.

" }, "DependencyThrottleException":{ "type":"structure", "members":{ }, "error":{ "code":"DependencyThrottle", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DeregisterEndPointsInput":{ "type":"structure", "required":[ "LoadBalancerName", "Instances" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "Instances":{ "shape":"Instances", "documentation":"

The IDs of the instances.

" } }, "documentation":"

Contains the parameters for DeregisterInstancesFromLoadBalancer.

" }, "DeregisterEndPointsOutput":{ "type":"structure", "members":{ "Instances":{ "shape":"Instances", "documentation":"

The remaining instances registered with the load balancer.

" } }, "documentation":"

Contains the output of DeregisterInstancesFromLoadBalancer.

" }, "DescribeAccessPointsInput":{ "type":"structure", "members":{ "LoadBalancerNames":{ "shape":"LoadBalancerNames", "documentation":"

The names of the load balancers.

" }, "Marker":{ "shape":"Marker", "documentation":"

The marker for the next set of results. (You received this marker from a previous call.)

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of results to return with this call (a number from 1 to 400). The default is 400.

" } }, "documentation":"

Contains the parameters for DescribeLoadBalancers.

" }, "DescribeAccessPointsOutput":{ "type":"structure", "members":{ "LoadBalancerDescriptions":{ "shape":"LoadBalancerDescriptions", "documentation":"

Information about the load balancers.

" }, "NextMarker":{ "shape":"Marker", "documentation":"

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

" } }, "documentation":"

Contains the parameters for DescribeLoadBalancers.

" }, "DescribeEndPointStateInput":{ "type":"structure", "required":["LoadBalancerName"], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "Instances":{ "shape":"Instances", "documentation":"

The IDs of the instances.

" } }, "documentation":"

Contains the parameters for DescribeInstanceHealth.

" }, "DescribeEndPointStateOutput":{ "type":"structure", "members":{ "InstanceStates":{ "shape":"InstanceStates", "documentation":"

Information about the health of the instances.

" } }, "documentation":"

Contains the output for DescribeInstanceHealth.

" }, "DescribeLoadBalancerAttributesInput":{ "type":"structure", "required":["LoadBalancerName"], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" } }, "documentation":"

Contains the parameters for DescribeLoadBalancerAttributes.

" }, "DescribeLoadBalancerAttributesOutput":{ "type":"structure", "members":{ "LoadBalancerAttributes":{ "shape":"LoadBalancerAttributes", "documentation":"

Information about the load balancer attributes.

" } }, "documentation":"

Contains the output of DescribeLoadBalancerAttributes.

" }, "DescribeLoadBalancerPoliciesInput":{ "type":"structure", "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "PolicyNames":{ "shape":"PolicyNames", "documentation":"

The names of the policies.

" } }, "documentation":"

Contains the parameters for DescribeLoadBalancerPolicies.

" }, "DescribeLoadBalancerPoliciesOutput":{ "type":"structure", "members":{ "PolicyDescriptions":{ "shape":"PolicyDescriptions", "documentation":"

Information about the policies.

" } }, "documentation":"

Contains the output of DescribeLoadBalancerPolicies.

" }, "DescribeLoadBalancerPolicyTypesInput":{ "type":"structure", "members":{ "PolicyTypeNames":{ "shape":"PolicyTypeNames", "documentation":"

The names of the policy types. If no names are specified, describes all policy types defined by Elastic Load Balancing.

" } }, "documentation":"

Contains the parameters for DescribeLoadBalancerPolicyTypes.

" }, "DescribeLoadBalancerPolicyTypesOutput":{ "type":"structure", "members":{ "PolicyTypeDescriptions":{ "shape":"PolicyTypeDescriptions", "documentation":"

Information about the policy types.

" } }, "documentation":"

Contains the output of DescribeLoadBalancerPolicyTypes.

" }, "DescribeTagsInput":{ "type":"structure", "required":["LoadBalancerNames"], "members":{ "LoadBalancerNames":{ "shape":"LoadBalancerNamesMax20", "documentation":"

The names of the load balancers.

" } }, "documentation":"

Contains the parameters for DescribeTags.

" }, "DescribeTagsOutput":{ "type":"structure", "members":{ "TagDescriptions":{ "shape":"TagDescriptions", "documentation":"

Information about the tags.

" } }, "documentation":"

Contains the output for DescribeTags.

" }, "Description":{"type":"string"}, "DetachLoadBalancerFromSubnetsInput":{ "type":"structure", "required":[ "LoadBalancerName", "Subnets" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "Subnets":{ "shape":"Subnets", "documentation":"

The IDs of the subnets.

" } }, "documentation":"

Contains the parameters for DetachLoadBalancerFromSubnets.

" }, "DetachLoadBalancerFromSubnetsOutput":{ "type":"structure", "members":{ "Subnets":{ "shape":"Subnets", "documentation":"

The IDs of the remaining subnets for the load balancer.

" } }, "documentation":"

Contains the output of DetachLoadBalancerFromSubnets.

" }, "DuplicateAccessPointNameException":{ "type":"structure", "members":{ }, "documentation":"

The specified load balancer name already exists for this account.

", "error":{ "code":"DuplicateLoadBalancerName", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DuplicateListenerException":{ "type":"structure", "members":{ }, "documentation":"

A listener already exists for the specified load balancer name and port, but with a different instance port, protocol, or SSL certificate.

", "error":{ "code":"DuplicateListener", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DuplicatePolicyNameException":{ "type":"structure", "members":{ }, "documentation":"

A policy with the specified name already exists for this load balancer.

", "error":{ "code":"DuplicatePolicyName", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DuplicateTagKeysException":{ "type":"structure", "members":{ }, "documentation":"

A tag key was specified more than once.

", "error":{ "code":"DuplicateTagKeys", "httpStatusCode":400, "senderFault":true }, "exception":true }, "EndPointPort":{"type":"integer"}, "HealthCheck":{ "type":"structure", "required":[ "Target", "Interval", "Timeout", "UnhealthyThreshold", "HealthyThreshold" ], "members":{ "Target":{ "shape":"HealthCheckTarget", "documentation":"

The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

TCP is the default, specified as a TCP: port pair, for example \"TCP:5000\". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

SSL is also specified as SSL: port pair, for example, SSL:5000.

For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example \"HTTP:80/weather/us/wa/seattle\". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than \"200 OK\" within the timeout period is considered unhealthy.

The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

" }, "Interval":{ "shape":"HealthCheckInterval", "documentation":"

The approximate interval, in seconds, between health checks of an individual instance.

" }, "Timeout":{ "shape":"HealthCheckTimeout", "documentation":"

The amount of time, in seconds, during which no response means a failed health check.

This value must be less than the Interval value.

" }, "UnhealthyThreshold":{ "shape":"UnhealthyThreshold", "documentation":"

The number of consecutive health check failures required before moving the instance to the Unhealthy state.

" }, "HealthyThreshold":{ "shape":"HealthyThreshold", "documentation":"

The number of consecutive health checks successes required before moving the instance to the Healthy state.

" } }, "documentation":"

Information about a health check.

" }, "HealthCheckInterval":{ "type":"integer", "max":300, "min":5 }, "HealthCheckTarget":{"type":"string"}, "HealthCheckTimeout":{ "type":"integer", "max":60, "min":2 }, "HealthyThreshold":{ "type":"integer", "max":10, "min":2 }, "IdleTimeout":{ "type":"integer", "max":3600, "min":1 }, "Instance":{ "type":"structure", "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The instance ID.

" } }, "documentation":"

The ID of an EC2 instance.

" }, "InstanceId":{"type":"string"}, "InstancePort":{ "type":"integer", "max":65535, "min":1 }, "InstanceState":{ "type":"structure", "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The ID of the instance.

" }, "State":{ "shape":"State", "documentation":"

The current state of the instance.

Valid values: InService | OutOfService | Unknown

" }, "ReasonCode":{ "shape":"ReasonCode", "documentation":"

Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

Valid values: ELB | Instance | N/A

" }, "Description":{ "shape":"Description", "documentation":"

A description of the instance state. This string can contain one or more of the following messages.

  • N/A

  • A transient error occurred. Please try again later.

  • Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

  • Instance has not passed the configured HealthyThreshold number of health checks consecutively.

  • Instance registration is still in progress.

  • Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

  • Instance is not currently registered with the LoadBalancer.

  • Instance deregistration currently in progress.

  • Disable Availability Zone is currently in progress.

  • Instance is in pending state.

  • Instance is in stopped state.

  • Instance is in terminated state.

" } }, "documentation":"

Information about the state of an EC2 instance.

" }, "InstanceStates":{ "type":"list", "member":{"shape":"InstanceState"} }, "Instances":{ "type":"list", "member":{"shape":"Instance"} }, "InvalidConfigurationRequestException":{ "type":"structure", "members":{ }, "documentation":"

The requested configuration change is not valid.

", "error":{ "code":"InvalidConfigurationRequest", "httpStatusCode":409, "senderFault":true }, "exception":true }, "InvalidEndPointException":{ "type":"structure", "members":{ }, "documentation":"

The specified endpoint is not valid.

", "error":{ "code":"InvalidInstance", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidSchemeException":{ "type":"structure", "members":{ }, "documentation":"

The specified value for the schema is not valid. You can only specify a scheme for load balancers in a VPC.

", "error":{ "code":"InvalidScheme", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidSecurityGroupException":{ "type":"structure", "members":{ }, "documentation":"

One or more of the specified security groups do not exist.

", "error":{ "code":"InvalidSecurityGroup", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidSubnetException":{ "type":"structure", "members":{ }, "documentation":"

The specified VPC has no associated Internet gateway.

", "error":{ "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true }, "LBCookieStickinessPolicies":{ "type":"list", "member":{"shape":"LBCookieStickinessPolicy"} }, "LBCookieStickinessPolicy":{ "type":"structure", "members":{ "PolicyName":{ "shape":"PolicyName", "documentation":"

The name of the policy. This name must be unique within the set of policies for this load balancer.

" }, "CookieExpirationPeriod":{ "shape":"CookieExpirationPeriod", "documentation":"

The time period, in seconds, after which the cookie should be considered stale. If this parameter is not specified, the stickiness session lasts for the duration of the browser session.

" } }, "documentation":"

Information about a policy for duration-based session stickiness.

" }, "Listener":{ "type":"structure", "required":[ "Protocol", "LoadBalancerPort", "InstancePort" ], "members":{ "Protocol":{ "shape":"Protocol", "documentation":"

The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.

" }, "LoadBalancerPort":{ "shape":"AccessPointPort", "documentation":"

The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.

" }, "InstanceProtocol":{ "shape":"Protocol", "documentation":"

The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.

If the front-end protocol is HTTP, HTTPS, TCP, or SSL, InstanceProtocol must be at the same protocol.

If there is another listener with the same InstancePort whose InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure.

If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP.

" }, "InstancePort":{ "shape":"InstancePort", "documentation":"

The port on which the instance is listening.

" }, "SSLCertificateId":{ "shape":"SSLCertificateId", "documentation":"

The Amazon Resource Name (ARN) of the server certificate.

" } }, "documentation":"

Information about a listener.

For information about the protocols and the ports supported by Elastic Load Balancing, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.

" }, "ListenerDescription":{ "type":"structure", "members":{ "Listener":{"shape":"Listener"}, "PolicyNames":{ "shape":"PolicyNames", "documentation":"

The policies. If there are no policies enabled, the list is empty.

" } }, "documentation":"

The policies enabled for a listener.

" }, "ListenerDescriptions":{ "type":"list", "member":{"shape":"ListenerDescription"} }, "ListenerNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The load balancer does not have a listener configured at the specified port.

", "error":{ "code":"ListenerNotFound", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Listeners":{ "type":"list", "member":{"shape":"Listener"} }, "LoadBalancerAttributeNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified load balancer attribute does not exist.

", "error":{ "code":"LoadBalancerAttributeNotFound", "httpStatusCode":400, "senderFault":true }, "exception":true }, "LoadBalancerAttributes":{ "type":"structure", "members":{ "CrossZoneLoadBalancing":{ "shape":"CrossZoneLoadBalancing", "documentation":"

If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.

For more information, see Configure Cross-Zone Load Balancing in the Classic Load Balancers Guide.

" }, "AccessLog":{ "shape":"AccessLog", "documentation":"

If enabled, the load balancer captures detailed information of all requests and delivers the information to the Amazon S3 bucket that you specify.

For more information, see Enable Access Logs in the Classic Load Balancers Guide.

" }, "ConnectionDraining":{ "shape":"ConnectionDraining", "documentation":"

If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.

For more information, see Configure Connection Draining in the Classic Load Balancers Guide.

" }, "ConnectionSettings":{ "shape":"ConnectionSettings", "documentation":"

If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.

By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure Idle Connection Timeout in the Classic Load Balancers Guide.

" }, "AdditionalAttributes":{ "shape":"AdditionalAttributes", "documentation":"

This parameter is reserved.

" } }, "documentation":"

The attributes for a load balancer.

" }, "LoadBalancerDescription":{ "type":"structure", "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "DNSName":{ "shape":"DNSName", "documentation":"

The DNS name of the load balancer.

" }, "CanonicalHostedZoneName":{ "shape":"DNSName", "documentation":"

The DNS name of the load balancer.

For more information, see Configure a Custom Domain Name in the Classic Load Balancers Guide.

" }, "CanonicalHostedZoneNameID":{ "shape":"DNSName", "documentation":"

The ID of the Amazon Route 53 hosted zone for the load balancer.

" }, "ListenerDescriptions":{ "shape":"ListenerDescriptions", "documentation":"

The listeners for the load balancer.

" }, "Policies":{ "shape":"Policies", "documentation":"

The policies defined for the load balancer.

" }, "BackendServerDescriptions":{ "shape":"BackendServerDescriptions", "documentation":"

Information about your EC2 instances.

" }, "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

The Availability Zones for the load balancer.

" }, "Subnets":{ "shape":"Subnets", "documentation":"

The IDs of the subnets for the load balancer.

" }, "VPCId":{ "shape":"VPCId", "documentation":"

The ID of the VPC for the load balancer.

" }, "Instances":{ "shape":"Instances", "documentation":"

The IDs of the instances for the load balancer.

" }, "HealthCheck":{ "shape":"HealthCheck", "documentation":"

Information about the health checks conducted on the load balancer.

" }, "SourceSecurityGroup":{ "shape":"SourceSecurityGroup", "documentation":"

The security group for the load balancer, which you can use as part of your inbound rules for your registered instances. To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.

" }, "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

The security groups for the load balancer. Valid only for load balancers in a VPC.

" }, "CreatedTime":{ "shape":"CreatedTime", "documentation":"

The date and time the load balancer was created.

" }, "Scheme":{ "shape":"LoadBalancerScheme", "documentation":"

The type of load balancer. Valid only for load balancers in a VPC.

If Scheme is internet-facing, the load balancer has a public DNS name that resolves to a public IP address.

If Scheme is internal, the load balancer has a public DNS name that resolves to a private IP address.

" } }, "documentation":"

Information about a load balancer.

" }, "LoadBalancerDescriptions":{ "type":"list", "member":{"shape":"LoadBalancerDescription"} }, "LoadBalancerNames":{ "type":"list", "member":{"shape":"AccessPointName"} }, "LoadBalancerNamesMax20":{ "type":"list", "member":{"shape":"AccessPointName"}, "max":20, "min":1 }, "LoadBalancerScheme":{"type":"string"}, "Marker":{"type":"string"}, "ModifyLoadBalancerAttributesInput":{ "type":"structure", "required":[ "LoadBalancerName", "LoadBalancerAttributes" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "LoadBalancerAttributes":{ "shape":"LoadBalancerAttributes", "documentation":"

The attributes of the load balancer.

" } }, "documentation":"

Contains the parameters for ModifyLoadBalancerAttributes.

" }, "ModifyLoadBalancerAttributesOutput":{ "type":"structure", "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "LoadBalancerAttributes":{"shape":"LoadBalancerAttributes"} }, "documentation":"

Contains the output of ModifyLoadBalancerAttributes.

" }, "PageSize":{ "type":"integer", "max":400, "min":1 }, "Policies":{ "type":"structure", "members":{ "AppCookieStickinessPolicies":{ "shape":"AppCookieStickinessPolicies", "documentation":"

The stickiness policies created using CreateAppCookieStickinessPolicy.

" }, "LBCookieStickinessPolicies":{ "shape":"LBCookieStickinessPolicies", "documentation":"

The stickiness policies created using CreateLBCookieStickinessPolicy.

" }, "OtherPolicies":{ "shape":"PolicyNames", "documentation":"

The policies other than the stickiness policies.

" } }, "documentation":"

The policies for a load balancer.

" }, "PolicyAttribute":{ "type":"structure", "members":{ "AttributeName":{ "shape":"AttributeName", "documentation":"

The name of the attribute.

" }, "AttributeValue":{ "shape":"AttributeValue", "documentation":"

The value of the attribute.

" } }, "documentation":"

Information about a policy attribute.

" }, "PolicyAttributeDescription":{ "type":"structure", "members":{ "AttributeName":{ "shape":"AttributeName", "documentation":"

The name of the attribute.

" }, "AttributeValue":{ "shape":"AttributeValue", "documentation":"

The value of the attribute.

" } }, "documentation":"

Information about a policy attribute.

" }, "PolicyAttributeDescriptions":{ "type":"list", "member":{"shape":"PolicyAttributeDescription"} }, "PolicyAttributeTypeDescription":{ "type":"structure", "members":{ "AttributeName":{ "shape":"AttributeName", "documentation":"

The name of the attribute.

" }, "AttributeType":{ "shape":"AttributeType", "documentation":"

The type of the attribute. For example, Boolean or Integer.

" }, "Description":{ "shape":"Description", "documentation":"

A description of the attribute.

" }, "DefaultValue":{ "shape":"DefaultValue", "documentation":"

The default value of the attribute, if applicable.

" }, "Cardinality":{ "shape":"Cardinality", "documentation":"

The cardinality of the attribute.

Valid values:

  • ONE(1) : Single value required

  • ZERO_OR_ONE(0..1) : Up to one value is allowed

  • ZERO_OR_MORE(0..*) : Optional. Multiple values are allowed

  • ONE_OR_MORE(1..*0) : Required. Multiple values are allowed

" } }, "documentation":"

Information about a policy attribute type.

" }, "PolicyAttributeTypeDescriptions":{ "type":"list", "member":{"shape":"PolicyAttributeTypeDescription"} }, "PolicyAttributes":{ "type":"list", "member":{"shape":"PolicyAttribute"} }, "PolicyDescription":{ "type":"structure", "members":{ "PolicyName":{ "shape":"PolicyName", "documentation":"

The name of the policy.

" }, "PolicyTypeName":{ "shape":"PolicyTypeName", "documentation":"

The name of the policy type.

" }, "PolicyAttributeDescriptions":{ "shape":"PolicyAttributeDescriptions", "documentation":"

The policy attributes.

" } }, "documentation":"

Information about a policy.

" }, "PolicyDescriptions":{ "type":"list", "member":{"shape":"PolicyDescription"} }, "PolicyName":{"type":"string"}, "PolicyNames":{ "type":"list", "member":{"shape":"PolicyName"} }, "PolicyNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

One or more of the specified policies do not exist.

", "error":{ "code":"PolicyNotFound", "httpStatusCode":400, "senderFault":true }, "exception":true }, "PolicyTypeDescription":{ "type":"structure", "members":{ "PolicyTypeName":{ "shape":"PolicyTypeName", "documentation":"

The name of the policy type.

" }, "Description":{ "shape":"Description", "documentation":"

A description of the policy type.

" }, "PolicyAttributeTypeDescriptions":{ "shape":"PolicyAttributeTypeDescriptions", "documentation":"

The description of the policy attributes associated with the policies defined by Elastic Load Balancing.

" } }, "documentation":"

Information about a policy type.

" }, "PolicyTypeDescriptions":{ "type":"list", "member":{"shape":"PolicyTypeDescription"} }, "PolicyTypeName":{"type":"string"}, "PolicyTypeNames":{ "type":"list", "member":{"shape":"PolicyTypeName"} }, "PolicyTypeNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

One or more of the specified policy types do not exist.

", "error":{ "code":"PolicyTypeNotFound", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Ports":{ "type":"list", "member":{"shape":"AccessPointPort"} }, "Protocol":{"type":"string"}, "ReasonCode":{"type":"string"}, "RegisterEndPointsInput":{ "type":"structure", "required":[ "LoadBalancerName", "Instances" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "Instances":{ "shape":"Instances", "documentation":"

The IDs of the instances.

" } }, "documentation":"

Contains the parameters for RegisterInstancesWithLoadBalancer.

" }, "RegisterEndPointsOutput":{ "type":"structure", "members":{ "Instances":{ "shape":"Instances", "documentation":"

The updated list of instances for the load balancer.

" } }, "documentation":"

Contains the output of RegisterInstancesWithLoadBalancer.

" }, "RemoveAvailabilityZonesInput":{ "type":"structure", "required":[ "LoadBalancerName", "AvailabilityZones" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

The Availability Zones.

" } }, "documentation":"

Contains the parameters for DisableAvailabilityZonesForLoadBalancer.

" }, "RemoveAvailabilityZonesOutput":{ "type":"structure", "members":{ "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

The remaining Availability Zones for the load balancer.

" } }, "documentation":"

Contains the output for DisableAvailabilityZonesForLoadBalancer.

" }, "RemoveTagsInput":{ "type":"structure", "required":[ "LoadBalancerNames", "Tags" ], "members":{ "LoadBalancerNames":{ "shape":"LoadBalancerNames", "documentation":"

The name of the load balancer. You can specify a maximum of one load balancer name.

" }, "Tags":{ "shape":"TagKeyList", "documentation":"

The list of tag keys to remove.

" } }, "documentation":"

Contains the parameters for RemoveTags.

" }, "RemoveTagsOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of RemoveTags.

" }, "S3BucketName":{"type":"string"}, "SSLCertificateId":{"type":"string"}, "SecurityGroupId":{"type":"string"}, "SecurityGroupName":{"type":"string"}, "SecurityGroupOwnerAlias":{"type":"string"}, "SecurityGroups":{ "type":"list", "member":{"shape":"SecurityGroupId"} }, "SetLoadBalancerListenerSSLCertificateInput":{ "type":"structure", "required":[ "LoadBalancerName", "LoadBalancerPort", "SSLCertificateId" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "LoadBalancerPort":{ "shape":"AccessPointPort", "documentation":"

The port that uses the specified SSL certificate.

" }, "SSLCertificateId":{ "shape":"SSLCertificateId", "documentation":"

The Amazon Resource Name (ARN) of the SSL certificate.

" } }, "documentation":"

Contains the parameters for SetLoadBalancerListenerSSLCertificate.

" }, "SetLoadBalancerListenerSSLCertificateOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of SetLoadBalancerListenerSSLCertificate.

" }, "SetLoadBalancerPoliciesForBackendServerInput":{ "type":"structure", "required":[ "LoadBalancerName", "InstancePort", "PolicyNames" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "InstancePort":{ "shape":"EndPointPort", "documentation":"

The port number associated with the EC2 instance.

" }, "PolicyNames":{ "shape":"PolicyNames", "documentation":"

The names of the policies. If the list is empty, then all current polices are removed from the EC2 instance.

" } }, "documentation":"

Contains the parameters for SetLoadBalancerPoliciesForBackendServer.

" }, "SetLoadBalancerPoliciesForBackendServerOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of SetLoadBalancerPoliciesForBackendServer.

" }, "SetLoadBalancerPoliciesOfListenerInput":{ "type":"structure", "required":[ "LoadBalancerName", "LoadBalancerPort", "PolicyNames" ], "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "LoadBalancerPort":{ "shape":"AccessPointPort", "documentation":"

The external port of the load balancer.

" }, "PolicyNames":{ "shape":"PolicyNames", "documentation":"

The names of the policies. This list must include all policies to be enabled. If you omit a policy that is currently enabled, it is disabled. If the list is empty, all current policies are disabled.

" } }, "documentation":"

Contains the parameters for SetLoadBalancePoliciesOfListener.

" }, "SetLoadBalancerPoliciesOfListenerOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of SetLoadBalancePoliciesOfListener.

" }, "SourceSecurityGroup":{ "type":"structure", "members":{ "OwnerAlias":{ "shape":"SecurityGroupOwnerAlias", "documentation":"

The owner of the security group.

" }, "GroupName":{ "shape":"SecurityGroupName", "documentation":"

The name of the security group.

" } }, "documentation":"

Information about a source security group.

" }, "State":{"type":"string"}, "SubnetId":{"type":"string"}, "SubnetNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

One or more of the specified subnets do not exist.

", "error":{ "code":"SubnetNotFound", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Subnets":{ "type":"list", "member":{"shape":"SubnetId"} }, "Tag":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"TagKey", "documentation":"

The key of the tag.

" }, "Value":{ "shape":"TagValue", "documentation":"

The value of the tag.

" } }, "documentation":"

Information about a tag.

" }, "TagDescription":{ "type":"structure", "members":{ "LoadBalancerName":{ "shape":"AccessPointName", "documentation":"

The name of the load balancer.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags.

" } }, "documentation":"

The tags associated with a load balancer.

" }, "TagDescriptions":{ "type":"list", "member":{"shape":"TagDescription"} }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKeyOnly"}, "min":1 }, "TagKeyOnly":{ "type":"structure", "members":{ "Key":{ "shape":"TagKey", "documentation":"

The name of the key.

" } }, "documentation":"

The key of a tag.

" }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "min":1 }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TooManyAccessPointsException":{ "type":"structure", "members":{ }, "documentation":"

The quota for the number of load balancers has been reached.

", "error":{ "code":"TooManyLoadBalancers", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TooManyPoliciesException":{ "type":"structure", "members":{ }, "documentation":"

The quota for the number of policies for this load balancer has been reached.

", "error":{ "code":"TooManyPolicies", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TooManyTagsException":{ "type":"structure", "members":{ }, "documentation":"

The quota for the number of tags that can be assigned to a load balancer has been reached.

", "error":{ "code":"TooManyTags", "httpStatusCode":400, "senderFault":true }, "exception":true }, "UnhealthyThreshold":{ "type":"integer", "max":10, "min":2 }, "UnsupportedProtocolException":{ "type":"structure", "members":{ }, "error":{ "code":"UnsupportedProtocol", "httpStatusCode":400, "senderFault":true }, "exception":true }, "VPCId":{"type":"string"} }, "documentation":"Elastic Load Balancing

A load balancer distributes incoming traffic across your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered instances and ensures that it routes traffic only to healthy instances. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer and a protocol and port number for connections from the load balancer to the instances.

Elastic Load Balancing supports two types of load balancers: Classic load balancers and Application load balancers (new). A Classic load balancer makes routing and load balancing decisions either at the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS), and supports either EC2-Classic or a VPC. An Application load balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS), supports path-based routing, and can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC). For more information, see the .

This reference covers the 2012-06-01 API, which supports Classic load balancers. The 2015-12-01 API supports Application load balancers.

To get started, create a load balancer with one or more listeners using CreateLoadBalancer. Register your instances with the load balancer using RegisterInstancesWithLoadBalancer.

All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds with a 200 OK response code.

" } botocore-1.5.7/botocore/data/datapipeline/0000777454262600001440000000000013042511307021572 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/datapipeline/2012-10-29/0000777454262600001440000000000013042511307022624 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/datapipeline/2012-10-29/paginators-1.json0000666454262600001440000000105213042511306026021 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListPipelines": { "input_token": "marker", "output_token": "marker", "more_results": "hasMoreResults", "result_key": "pipelineIdList" }, "DescribeObjects": { "input_token": "marker", "output_token": "marker", "more_results": "hasMoreResults", "result_key": "pipelineObjects" }, "QueryObjects": { "input_token": "marker", "output_token": "marker", "more_results": "hasMoreResults", "limit_key": "limit", "result_key": "ids" } } } botocore-1.5.7/botocore/data/datapipeline/2012-10-29/service-2.json0000666454262600001440000022552413042511306025327 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2012-10-29", "endpointPrefix":"datapipeline", "jsonVersion":"1.1", "serviceFullName":"AWS Data Pipeline", "signatureVersion":"v4", "targetPrefix":"DataPipeline", "protocol":"json", "uid":"datapipeline-2012-10-29" }, "documentation":"

AWS Data Pipeline 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 that your application can focus on processing the data.

AWS Data Pipeline provides a JAR 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.

AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data. Use the second set in your task runner application 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.

", "operations":{ "ActivatePipeline":{ "name":"ActivatePipeline", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ActivatePipelineInput", "documentation":"

Contains the parameters for ActivatePipeline.

" }, "output":{ "shape":"ActivatePipelineOutput", "documentation":"

Contains the output of ActivatePipeline.

" }, "errors":[ { "shape":"PipelineNotFoundException", "exception":true, "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" }, { "shape":"PipelineDeletedException", "exception":true, "documentation":"

The specified pipeline has been deleted.

" }, { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" } ], "documentation":"

Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.

If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline.

To activate a finished pipeline, modify the end date for the pipeline and then activate it.

" }, "AddTags":{ "name":"AddTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"AddTagsInput", "documentation":"

Contains the parameters for AddTags.

" }, "output":{ "shape":"AddTagsOutput", "documentation":"

Contains the output of AddTags.

" }, "errors":[ { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" }, { "shape":"PipelineNotFoundException", "exception":true, "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" }, { "shape":"PipelineDeletedException", "exception":true, "documentation":"

The specified pipeline has been deleted.

" } ], "documentation":"

Adds or modifies tags for the specified pipeline.

" }, "CreatePipeline":{ "name":"CreatePipeline", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreatePipelineInput", "documentation":"

Contains the parameters for CreatePipeline.

" }, "output":{ "shape":"CreatePipelineOutput", "documentation":"

Contains the output of CreatePipeline.

" }, "errors":[ { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" } ], "documentation":"

Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.

" }, "DeactivatePipeline":{ "name":"DeactivatePipeline", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeactivatePipelineInput", "documentation":"

Contains the parameters for DeactivatePipeline.

" }, "output":{ "shape":"DeactivatePipelineOutput", "documentation":"

Contains the output of DeactivatePipeline.

" }, "errors":[ { "shape":"PipelineNotFoundException", "exception":true, "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" }, { "shape":"PipelineDeletedException", "exception":true, "documentation":"

The specified pipeline has been deleted.

" }, { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" } ], "documentation":"

Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.

To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.

" }, "DeletePipeline":{ "name":"DeletePipeline", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeletePipelineInput", "documentation":"

Contains the parameters for DeletePipeline.

" }, "errors":[ { "shape":"PipelineNotFoundException", "exception":true, "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" }, { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" } ], "documentation":"

Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners.

Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. 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.

" }, "DescribeObjects":{ "name":"DescribeObjects", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeObjectsInput", "documentation":"

Contains the parameters for DescribeObjects.

" }, "output":{ "shape":"DescribeObjectsOutput", "documentation":"

Contains the output of DescribeObjects.

" }, "errors":[ { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" }, { "shape":"PipelineNotFoundException", "exception":true, "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" }, { "shape":"PipelineDeletedException", "exception":true, "documentation":"

The specified pipeline has been deleted.

" } ], "documentation":"

Gets 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.

" }, "DescribePipelines":{ "name":"DescribePipelines", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribePipelinesInput", "documentation":"

Contains the parameters for DescribePipelines.

" }, "output":{ "shape":"DescribePipelinesOutput", "documentation":"

Contains the output of DescribePipelines.

" }, "errors":[ { "shape":"PipelineNotFoundException", "exception":true, "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" }, { "shape":"PipelineDeletedException", "exception":true, "documentation":"

The specified pipeline has been deleted.

" }, { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" } ], "documentation":"

Retrieves 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 for which you have read permissions.

To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition.

" }, "EvaluateExpression":{ "name":"EvaluateExpression", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"EvaluateExpressionInput", "documentation":"

Contains the parameters for EvaluateExpression.

" }, "output":{ "shape":"EvaluateExpressionOutput", "documentation":"

Contains the output of EvaluateExpression.

" }, "errors":[ { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"TaskNotFoundException", "exception":true, "documentation":"

The specified task was not found.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" }, { "shape":"PipelineNotFoundException", "exception":true, "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" }, { "shape":"PipelineDeletedException", "exception":true, "documentation":"

The specified pipeline has been deleted.

" } ], "documentation":"

Task runners call EvaluateExpression to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3.

" }, "GetPipelineDefinition":{ "name":"GetPipelineDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"GetPipelineDefinitionInput", "documentation":"

Contains the parameters for GetPipelineDefinition.

" }, "output":{ "shape":"GetPipelineDefinitionOutput", "documentation":"

Contains the output of GetPipelineDefinition.

" }, "errors":[ { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" }, { "shape":"PipelineNotFoundException", "exception":true, "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" }, { "shape":"PipelineDeletedException", "exception":true, "documentation":"

The specified pipeline has been deleted.

" } ], "documentation":"

Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition.

" }, "ListPipelines":{ "name":"ListPipelines", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ListPipelinesInput", "documentation":"

Contains the parameters for ListPipelines.

" }, "output":{ "shape":"ListPipelinesOutput", "documentation":"

Contains the output of ListPipelines.

" }, "errors":[ { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" } ], "documentation":"

Lists the pipeline identifiers for all active pipelines that you have permission to access.

" }, "PollForTask":{ "name":"PollForTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"PollForTaskInput", "documentation":"

Contains the parameters for PollForTask.

" }, "output":{ "shape":"PollForTaskOutput", "documentation":"

Contains the output of PollForTask.

" }, "errors":[ { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" }, { "shape":"TaskNotFoundException", "exception":true, "documentation":"

The specified task was not found.

" } ], "documentation":"

Task runners call PollForTask 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. The task returned can 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.

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 can take up to 90 seconds.

" }, "PutPipelineDefinition":{ "name":"PutPipelineDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"PutPipelineDefinitionInput", "documentation":"

Contains the parameters for PutPipelineDefinition.

" }, "output":{ "shape":"PutPipelineDefinitionOutput", "documentation":"

Contains the output of PutPipelineDefinition.

" }, "errors":[ { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" }, { "shape":"PipelineNotFoundException", "exception":true, "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" }, { "shape":"PipelineDeletedException", "exception":true, "documentation":"

The specified pipeline has been deleted.

" } ], "documentation":"

Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline.

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.

  1. An object is missing a name or identifier field.
  2. A string or reference field is empty.
  3. The number of objects in the pipeline exceeds the maximum allowed objects.
  4. The pipeline is in a FINISHED state.

Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.

" }, "QueryObjects":{ "name":"QueryObjects", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"QueryObjectsInput", "documentation":"

Contains the parameters for QueryObjects.

" }, "output":{ "shape":"QueryObjectsOutput", "documentation":"

Contains the output of QueryObjects.

" }, "errors":[ { "shape":"PipelineNotFoundException", "exception":true, "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" }, { "shape":"PipelineDeletedException", "exception":true, "documentation":"

The specified pipeline has been deleted.

" }, { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" } ], "documentation":"

Queries the specified pipeline for the names of objects that match the specified set of conditions.

" }, "RemoveTags":{ "name":"RemoveTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"RemoveTagsInput", "documentation":"

Contains the parameters for RemoveTags.

" }, "output":{ "shape":"RemoveTagsOutput", "documentation":"

Contains the output of RemoveTags.

" }, "errors":[ { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" }, { "shape":"PipelineNotFoundException", "exception":true, "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" }, { "shape":"PipelineDeletedException", "exception":true, "documentation":"

The specified pipeline has been deleted.

" } ], "documentation":"

Removes existing tags from the specified pipeline.

" }, "ReportTaskProgress":{ "name":"ReportTaskProgress", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ReportTaskProgressInput", "documentation":"

Contains the parameters for ReportTaskProgress.

" }, "output":{ "shape":"ReportTaskProgressOutput", "documentation":"

Contains the output of ReportTaskProgress.

" }, "errors":[ { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" }, { "shape":"TaskNotFoundException", "exception":true, "documentation":"

The specified task was not found.

" }, { "shape":"PipelineNotFoundException", "exception":true, "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" }, { "shape":"PipelineDeletedException", "exception":true, "documentation":"

The specified pipeline has been deleted.

" } ], "documentation":"

Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns 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.

If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners should call ReportTaskProgress every 60 seconds.

" }, "ReportTaskRunnerHeartbeat":{ "name":"ReportTaskRunnerHeartbeat", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ReportTaskRunnerHeartbeatInput", "documentation":"

Contains the parameters for ReportTaskRunnerHeartbeat.

" }, "output":{ "shape":"ReportTaskRunnerHeartbeatOutput", "documentation":"

Contains the output of ReportTaskRunnerHeartbeat.

" }, "errors":[ { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" } ], "documentation":"

Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is 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.

" }, "SetStatus":{ "name":"SetStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"SetStatusInput", "documentation":"

Contains the parameters for SetStatus.

" }, "errors":[ { "shape":"PipelineNotFoundException", "exception":true, "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" }, { "shape":"PipelineDeletedException", "exception":true, "documentation":"

The specified pipeline has been deleted.

" }, { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" } ], "documentation":"

Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException.

" }, "SetTaskStatus":{ "name":"SetTaskStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"SetTaskStatusInput", "documentation":"

Contains the parameters for SetTaskStatus.

" }, "output":{ "shape":"SetTaskStatusOutput", "documentation":"

Contains the output of SetTaskStatus.

" }, "errors":[ { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"TaskNotFoundException", "exception":true, "documentation":"

The specified task was not found.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" }, { "shape":"PipelineNotFoundException", "exception":true, "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" }, { "shape":"PipelineDeletedException", "exception":true, "documentation":"

The specified pipeline has been deleted.

" } ], "documentation":"

Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.

" }, "ValidatePipelineDefinition":{ "name":"ValidatePipelineDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ValidatePipelineDefinitionInput", "documentation":"

Contains the parameters for ValidatePipelineDefinition.

" }, "output":{ "shape":"ValidatePipelineDefinitionOutput", "documentation":"

Contains the output of ValidatePipelineDefinition.

" }, "errors":[ { "shape":"InternalServiceError", "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"

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.

" }, { "shape":"PipelineNotFoundException", "exception":true, "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" }, { "shape":"PipelineDeletedException", "exception":true, "documentation":"

The specified pipeline has been deleted.

" } ], "documentation":"

Validates the specified pipeline definition to ensure that it is well formed and can be run without error.

" } }, "shapes":{ "ActivatePipelineInput":{ "type":"structure", "required":["pipelineId"], "members":{ "pipelineId":{ "shape":"id", "documentation":"

The ID of the pipeline.

" }, "parameterValues":{ "shape":"ParameterValueList", "documentation":"

A list of parameter values to pass to the pipeline at activation.

" }, "startTimestamp":{ "shape":"timestamp", "documentation":"

The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

" } }, "documentation":"

Contains the parameters for ActivatePipeline.

" }, "ActivatePipelineOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of ActivatePipeline.

" }, "AddTagsInput":{ "type":"structure", "required":[ "pipelineId", "tags" ], "members":{ "pipelineId":{ "shape":"id", "documentation":"

The ID of the pipeline.

" }, "tags":{ "shape":"tagList", "documentation":"

The tags to add, as key/value pairs.

" } }, "documentation":"

Contains the parameters for AddTags.

" }, "AddTagsOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of AddTags.

" }, "CreatePipelineInput":{ "type":"structure", "required":[ "name", "uniqueId" ], "members":{ "name":{ "shape":"id", "documentation":"

The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.

" }, "uniqueId":{ "shape":"id", "documentation":"

A unique identifier. 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 succeed, 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 is not 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.

" }, "description":{ "shape":"string", "documentation":"

The description for the pipeline.

" }, "tags":{ "shape":"tagList", "documentation":"

A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

" } }, "documentation":"

Contains the parameters for CreatePipeline.

" }, "CreatePipelineOutput":{ "type":"structure", "required":["pipelineId"], "members":{ "pipelineId":{ "shape":"id", "documentation":"

The ID that AWS Data Pipeline assigns the newly created pipeline. For example, df-06372391ZG65EXAMPLE.

" } }, "documentation":"

Contains the output of CreatePipeline.

" }, "DeactivatePipelineInput":{ "type":"structure", "required":["pipelineId"], "members":{ "pipelineId":{ "shape":"id", "documentation":"

The ID of the pipeline.

" }, "cancelActive":{ "shape":"cancelActive", "documentation":"

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

" } }, "documentation":"

Contains the parameters for DeactivatePipeline.

" }, "DeactivatePipelineOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of DeactivatePipeline.

" }, "DeletePipelineInput":{ "type":"structure", "required":["pipelineId"], "members":{ "pipelineId":{ "shape":"id", "documentation":"

The ID of the pipeline.

" } }, "documentation":"

Contains the parameters for DeletePipeline.

" }, "DescribeObjectsInput":{ "type":"structure", "required":[ "pipelineId", "objectIds" ], "members":{ "pipelineId":{ "shape":"id", "documentation":"

The ID of the pipeline that contains the object definitions.

" }, "objectIds":{ "shape":"idList", "documentation":"

The IDs 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.

" }, "evaluateExpressions":{ "shape":"boolean", "documentation":"

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

" }, "marker":{ "shape":"string", "documentation":"

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call DescribeObjects with the marker value from the previous call to retrieve the next set of results.

" } }, "documentation":"

Contains the parameters for DescribeObjects.

" }, "DescribeObjectsOutput":{ "type":"structure", "required":["pipelineObjects"], "members":{ "pipelineObjects":{ "shape":"PipelineObjectList", "documentation":"

An array of object definitions.

" }, "marker":{ "shape":"string", "documentation":"

The starting point for the next page of results. To view the next page of results, call DescribeObjects again with this marker value. If the value is null, there are no more results.

" }, "hasMoreResults":{ "shape":"boolean", "documentation":"

Indicates whether there are more results to return.

" } }, "documentation":"

Contains the output of DescribeObjects.

" }, "DescribePipelinesInput":{ "type":"structure", "required":["pipelineIds"], "members":{ "pipelineIds":{ "shape":"idList", "documentation":"

The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines.

" } }, "documentation":"

Contains the parameters for DescribePipelines.

" }, "DescribePipelinesOutput":{ "type":"structure", "required":["pipelineDescriptionList"], "members":{ "pipelineDescriptionList":{ "shape":"PipelineDescriptionList", "documentation":"

An array of descriptions for the specified pipelines.

" } }, "documentation":"

Contains the output of DescribePipelines.

" }, "EvaluateExpressionInput":{ "type":"structure", "required":[ "pipelineId", "objectId", "expression" ], "members":{ "pipelineId":{ "shape":"id", "documentation":"

The ID of the pipeline.

" }, "objectId":{ "shape":"id", "documentation":"

The ID of the object.

" }, "expression":{ "shape":"longString", "documentation":"

The expression to evaluate.

" } }, "documentation":"

Contains the parameters for EvaluateExpression.

" }, "EvaluateExpressionOutput":{ "type":"structure", "required":["evaluatedExpression"], "members":{ "evaluatedExpression":{ "shape":"longString", "documentation":"

The evaluated expression.

" } }, "documentation":"

Contains the output of EvaluateExpression.

" }, "Field":{ "type":"structure", "required":["key"], "members":{ "key":{ "shape":"fieldNameString", "documentation":"

The field identifier.

" }, "stringValue":{ "shape":"fieldStringValue", "documentation":"

The field value, expressed as a String.

" }, "refValue":{ "shape":"fieldNameString", "documentation":"

The field value, expressed as the identifier of another object.

" } }, "documentation":"

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.

" }, "GetPipelineDefinitionInput":{ "type":"structure", "required":["pipelineId"], "members":{ "pipelineId":{ "shape":"id", "documentation":"

The ID of the pipeline.

" }, "version":{ "shape":"string", "documentation":"

The version of the pipeline definition to retrieve. Set this parameter to latest (default) to use the last definition saved to the pipeline or active to use the last definition that was activated.

" } }, "documentation":"

Contains the parameters for GetPipelineDefinition.

" }, "GetPipelineDefinitionOutput":{ "type":"structure", "members":{ "pipelineObjects":{ "shape":"PipelineObjectList", "documentation":"

The objects defined in the pipeline.

" }, "parameterObjects":{ "shape":"ParameterObjectList", "documentation":"

The parameter objects used in the pipeline definition.

" }, "parameterValues":{ "shape":"ParameterValueList", "documentation":"

The parameter values used in the pipeline definition.

" } }, "documentation":"

Contains the output of GetPipelineDefinition.

" }, "InstanceIdentity":{ "type":"structure", "members":{ "document":{ "shape":"string", "documentation":"

A description of an 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.

" }, "signature":{ "shape":"string", "documentation":"

A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.

" } }, "documentation":"

Identity information for the EC2 instance that is hosting the task runner. You can get this value by calling a metadata URI from the EC2 instance. For more information, see 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.

" }, "InternalServiceError":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

Description of the error message.

" } }, "exception":true, "fault":true, "documentation":"

An internal service error occurred.

" }, "InvalidRequestException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

Description of the error message.

" } }, "exception":true, "documentation":"

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.

" }, "ListPipelinesInput":{ "type":"structure", "members":{ "marker":{ "shape":"string", "documentation":"

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call ListPipelines with the marker value from the previous call to retrieve the next set of results.

" } }, "documentation":"

Contains the parameters for ListPipelines.

" }, "ListPipelinesOutput":{ "type":"structure", "required":["pipelineIdList"], "members":{ "pipelineIdList":{ "shape":"pipelineList", "documentation":"

The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.

" }, "marker":{ "shape":"string", "documentation":"

The starting point for the next page of results. To view the next page of results, call ListPipelinesOutput again with this marker value. If the value is null, there are no more results.

" }, "hasMoreResults":{ "shape":"boolean", "documentation":"

Indicates whether there are more results that can be obtained by a subsequent call.

" } }, "documentation":"

Contains the output of ListPipelines.

" }, "Operator":{ "type":"structure", "members":{ "type":{ "shape":"OperatorType", "documentation":"

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.

The comparison operators EQ and REF_EQ act on the following fields:

  • name
  • @sphere
  • parent
  • @componentParent
  • @instanceParent
  • @status
  • @scheduledStartTime
  • @scheduledEndTime
  • @actualStartTime
  • @actualEndTime

The comparison operators GE, LE, and BETWEEN act on the following fields:

  • @scheduledStartTime
  • @scheduledEndTime
  • @actualStartTime
  • @actualEndTime

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\".

" }, "values":{ "shape":"stringList", "documentation":"

The value that the actual field value will be compared with.

" } }, "documentation":"

Contains a logical operation for comparing the value of a field with a specified value.

" }, "OperatorType":{ "type":"string", "enum":[ "EQ", "REF_EQ", "LE", "GE", "BETWEEN" ] }, "ParameterAttribute":{ "type":"structure", "required":[ "key", "stringValue" ], "members":{ "key":{ "shape":"attributeNameString", "documentation":"

The field identifier.

" }, "stringValue":{ "shape":"attributeValueString", "documentation":"

The field value, expressed as a String.

" } }, "documentation":"

The attributes allowed or specified with a parameter object.

" }, "ParameterAttributeList":{ "type":"list", "member":{"shape":"ParameterAttribute"} }, "ParameterObject":{ "type":"structure", "required":[ "id", "attributes" ], "members":{ "id":{ "shape":"fieldNameString", "documentation":"

The ID of the parameter object.

" }, "attributes":{ "shape":"ParameterAttributeList", "documentation":"

The attributes of the parameter object.

" } }, "documentation":"

Contains information about a parameter object.

" }, "ParameterObjectList":{ "type":"list", "member":{"shape":"ParameterObject"} }, "ParameterValue":{ "type":"structure", "required":[ "id", "stringValue" ], "members":{ "id":{ "shape":"fieldNameString", "documentation":"

The ID of the parameter value.

" }, "stringValue":{ "shape":"fieldStringValue", "documentation":"

The field value, expressed as a String.

" } }, "documentation":"

A value or list of parameter values.

" }, "ParameterValueList":{ "type":"list", "member":{"shape":"ParameterValue"} }, "PipelineDeletedException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

Description of the error message.

" } }, "exception":true, "documentation":"

The specified pipeline has been deleted.

" }, "PipelineDescription":{ "type":"structure", "required":[ "pipelineId", "name", "fields" ], "members":{ "pipelineId":{ "shape":"id", "documentation":"

The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

" }, "name":{ "shape":"id", "documentation":"

The name of the pipeline.

" }, "fields":{ "shape":"fieldList", "documentation":"

A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.

" }, "description":{ "shape":"string", "documentation":"

Description of the pipeline.

" }, "tags":{ "shape":"tagList", "documentation":"

A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

" } }, "documentation":"

Contains pipeline metadata.

" }, "PipelineDescriptionList":{ "type":"list", "member":{"shape":"PipelineDescription"} }, "PipelineIdName":{ "type":"structure", "members":{ "id":{ "shape":"id", "documentation":"

The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

" }, "name":{ "shape":"id", "documentation":"

The name of the pipeline.

" } }, "documentation":"

Contains the name and identifier of a pipeline.

" }, "PipelineNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

Description of the error message.

" } }, "exception":true, "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" }, "PipelineObject":{ "type":"structure", "required":[ "id", "name", "fields" ], "members":{ "id":{ "shape":"id", "documentation":"

The ID of the object.

" }, "name":{ "shape":"id", "documentation":"

The name of the object.

" }, "fields":{ "shape":"fieldList", "documentation":"

Key-value pairs that define the properties of the object.

" } }, "documentation":"

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.

" }, "PipelineObjectList":{ "type":"list", "member":{"shape":"PipelineObject"} }, "PipelineObjectMap":{ "type":"map", "key":{"shape":"id"}, "value":{"shape":"PipelineObject"} }, "PollForTaskInput":{ "type":"structure", "required":["workerGroup"], "members":{ "workerGroup":{ "shape":"string", "documentation":"

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.

" }, "hostname":{ "shape":"id", "documentation":"

The public DNS name of the calling task runner.

" }, "instanceIdentity":{ "shape":"InstanceIdentity", "documentation":"

Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using http://169.254.169.254/latest/meta-data/instance-id. For more information, see 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.

" } }, "documentation":"

Contains the parameters for PollForTask.

" }, "PollForTaskOutput":{ "type":"structure", "members":{ "taskObject":{ "shape":"TaskObject", "documentation":"

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.

" } }, "documentation":"

Contains the output of PollForTask.

" }, "PutPipelineDefinitionInput":{ "type":"structure", "required":[ "pipelineId", "pipelineObjects" ], "members":{ "pipelineId":{ "shape":"id", "documentation":"

The ID of the pipeline.

" }, "pipelineObjects":{ "shape":"PipelineObjectList", "documentation":"

The objects that define the pipeline. These objects overwrite the existing pipeline definition.

" }, "parameterObjects":{ "shape":"ParameterObjectList", "documentation":"

The parameter objects used with the pipeline.

" }, "parameterValues":{ "shape":"ParameterValueList", "documentation":"

The parameter values used with the pipeline.

" } }, "documentation":"

Contains the parameters for PutPipelineDefinition.

" }, "PutPipelineDefinitionOutput":{ "type":"structure", "required":["errored"], "members":{ "validationErrors":{ "shape":"ValidationErrors", "documentation":"

The validation errors that are associated with the objects defined in pipelineObjects.

" }, "validationWarnings":{ "shape":"ValidationWarnings", "documentation":"

The validation warnings that are associated with the objects defined in pipelineObjects.

" }, "errored":{ "shape":"boolean", "documentation":"

Indicates whether there were validation errors, and the pipeline definition is stored but cannot be activated until you correct the pipeline and call PutPipelineDefinition to commit the corrected pipeline.

" } }, "documentation":"

Contains the output of PutPipelineDefinition.

" }, "Query":{ "type":"structure", "members":{ "selectors":{ "shape":"SelectorList", "documentation":"

List of selectors that define the query. An object must satisfy all of the selectors to match the query.

" } }, "documentation":"

Defines the query to run against an object.

" }, "QueryObjectsInput":{ "type":"structure", "required":[ "pipelineId", "sphere" ], "members":{ "pipelineId":{ "shape":"id", "documentation":"

The ID of the pipeline.

" }, "query":{ "shape":"Query", "documentation":"

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

" }, "sphere":{ "shape":"string", "documentation":"

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

" }, "marker":{ "shape":"string", "documentation":"

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

" }, "limit":{ "shape":"int", "documentation":"

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

" } }, "documentation":"

Contains the parameters for QueryObjects.

" }, "QueryObjectsOutput":{ "type":"structure", "members":{ "ids":{ "shape":"idList", "documentation":"

The identifiers that match the query selectors.

" }, "marker":{ "shape":"string", "documentation":"

The starting point for the next page of results. To view the next page of results, call QueryObjects again with this marker value. If the value is null, there are no more results.

" }, "hasMoreResults":{ "shape":"boolean", "documentation":"

Indicates whether there are more results that can be obtained by a subsequent call.

" } }, "documentation":"

Contains the output of QueryObjects.

" }, "RemoveTagsInput":{ "type":"structure", "required":[ "pipelineId", "tagKeys" ], "members":{ "pipelineId":{ "shape":"id", "documentation":"

The ID of the pipeline.

" }, "tagKeys":{ "shape":"stringList", "documentation":"

The keys of the tags to remove.

" } }, "documentation":"

Contains the parameters for RemoveTags.

" }, "RemoveTagsOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of RemoveTags.

" }, "ReportTaskProgressInput":{ "type":"structure", "required":["taskId"], "members":{ "taskId":{ "shape":"taskId", "documentation":"

The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

" }, "fields":{ "shape":"fieldList", "documentation":"

Key-value pairs that define the properties of the ReportTaskProgressInput object.

" } }, "documentation":"

Contains the parameters for ReportTaskProgress.

" }, "ReportTaskProgressOutput":{ "type":"structure", "required":["canceled"], "members":{ "canceled":{ "shape":"boolean", "documentation":"

If true, the calling task runner should cancel processing of the task. The task runner does not need to call SetTaskStatus for canceled tasks.

" } }, "documentation":"

Contains the output of ReportTaskProgress.

" }, "ReportTaskRunnerHeartbeatInput":{ "type":"structure", "required":["taskrunnerId"], "members":{ "taskrunnerId":{ "shape":"id", "documentation":"

The ID 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.

" }, "workerGroup":{ "shape":"string", "documentation":"

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. There are no wildcard values permitted in workerGroup; the string must be an exact, case-sensitive, match.

" }, "hostname":{ "shape":"id", "documentation":"

The public DNS name of the task runner.

" } }, "documentation":"

Contains the parameters for ReportTaskRunnerHeartbeat.

" }, "ReportTaskRunnerHeartbeatOutput":{ "type":"structure", "required":["terminate"], "members":{ "terminate":{ "shape":"boolean", "documentation":"

Indicates whether the calling task runner should terminate.

" } }, "documentation":"

Contains the output of ReportTaskRunnerHeartbeat.

" }, "Selector":{ "type":"structure", "members":{ "fieldName":{ "shape":"string", "documentation":"

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.

" }, "operator":{"shape":"Operator"} }, "documentation":"

A comparision that is used to determine whether a query should return this object.

" }, "SelectorList":{ "type":"list", "member":{"shape":"Selector"}, "documentation":"

The list of Selectors that define queries on individual fields.

" }, "SetStatusInput":{ "type":"structure", "required":[ "pipelineId", "objectIds", "status" ], "members":{ "pipelineId":{ "shape":"id", "documentation":"

The ID of the pipeline that contains the objects.

" }, "objectIds":{ "shape":"idList", "documentation":"

The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

" }, "status":{ "shape":"string", "documentation":"

The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

" } }, "documentation":"

Contains the parameters for SetStatus.

" }, "SetTaskStatusInput":{ "type":"structure", "required":[ "taskId", "taskStatus" ], "members":{ "taskId":{ "shape":"taskId", "documentation":"

The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

" }, "taskStatus":{ "shape":"TaskStatus", "documentation":"

If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

" }, "errorId":{ "shape":"string", "documentation":"

If an error occurred during the task, this value specifies the error code. 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.

" }, "errorMessage":{ "shape":"errorMessage", "documentation":"

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.

" }, "errorStackTrace":{ "shape":"string", "documentation":"

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.

" } }, "documentation":"

Contains the parameters for SetTaskStatus.

" }, "SetTaskStatusOutput":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of SetTaskStatus.

" }, "Tag":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"tagKey", "documentation":"

The key name of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

" }, "value":{ "shape":"tagValue", "documentation":"

The optional value portion of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

" } }, "documentation":"

Tags are key/value pairs defined by a user and associated with a pipeline to control access. AWS Data Pipeline allows you to associate ten tags per pipeline. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

" }, "TaskNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

Description of the error message.

" } }, "exception":true, "documentation":"

The specified task was not found.

" }, "TaskObject":{ "type":"structure", "members":{ "taskId":{ "shape":"taskId", "documentation":"

An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.

" }, "pipelineId":{ "shape":"id", "documentation":"

The ID of the pipeline that provided the task.

" }, "attemptId":{ "shape":"id", "documentation":"

The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.

" }, "objects":{ "shape":"PipelineObjectMap", "documentation":"

Connection information for the location where the task runner will publish the output of the task.

" } }, "documentation":"

Contains information about a pipeline task that is assigned to a task runner.

" }, "TaskStatus":{ "type":"string", "enum":[ "FINISHED", "FAILED", "FALSE" ] }, "ValidatePipelineDefinitionInput":{ "type":"structure", "required":[ "pipelineId", "pipelineObjects" ], "members":{ "pipelineId":{ "shape":"id", "documentation":"

The ID of the pipeline.

" }, "pipelineObjects":{ "shape":"PipelineObjectList", "documentation":"

The objects that define the pipeline changes to validate against the pipeline.

" }, "parameterObjects":{ "shape":"ParameterObjectList", "documentation":"

The parameter objects used with the pipeline.

" }, "parameterValues":{ "shape":"ParameterValueList", "documentation":"

The parameter values used with the pipeline.

" } }, "documentation":"

Contains the parameters for ValidatePipelineDefinition.

" }, "ValidatePipelineDefinitionOutput":{ "type":"structure", "required":["errored"], "members":{ "validationErrors":{ "shape":"ValidationErrors", "documentation":"

Any validation errors that were found.

" }, "validationWarnings":{ "shape":"ValidationWarnings", "documentation":"

Any validation warnings that were found.

" }, "errored":{ "shape":"boolean", "documentation":"

Indicates whether there were validation errors.

" } }, "documentation":"

Contains the output of ValidatePipelineDefinition.

" }, "ValidationError":{ "type":"structure", "members":{ "id":{ "shape":"id", "documentation":"

The identifier of the object that contains the validation error.

" }, "errors":{ "shape":"validationMessages", "documentation":"

A description of the validation error.

" } }, "documentation":"

Defines a validation error. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.

" }, "ValidationErrors":{ "type":"list", "member":{"shape":"ValidationError"} }, "ValidationWarning":{ "type":"structure", "members":{ "id":{ "shape":"id", "documentation":"

The identifier of the object that contains the validation warning.

" }, "warnings":{ "shape":"validationMessages", "documentation":"

A description of the validation warning.

" } }, "documentation":"

Defines a validation warning. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.

" }, "ValidationWarnings":{ "type":"list", "member":{"shape":"ValidationWarning"} }, "attributeNameString":{ "type":"string", "min":1, "max":256, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "attributeValueString":{ "type":"string", "min":0, "max":10240, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "boolean":{"type":"boolean"}, "cancelActive":{"type":"boolean"}, "errorMessage":{"type":"string"}, "fieldList":{ "type":"list", "member":{"shape":"Field"} }, "fieldNameString":{ "type":"string", "min":1, "max":256, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "fieldStringValue":{ "type":"string", "min":0, "max":10240, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "id":{ "type":"string", "min":1, "max":1024, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "idList":{ "type":"list", "member":{"shape":"id"} }, "int":{"type":"integer"}, "longString":{ "type":"string", "min":0, "max":20971520, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "pipelineList":{ "type":"list", "member":{"shape":"PipelineIdName"} }, "string":{ "type":"string", "min":0, "max":1024, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "stringList":{ "type":"list", "member":{"shape":"string"} }, "tagKey":{ "type":"string", "min":1, "max":128 }, "tagList":{ "type":"list", "member":{"shape":"Tag"}, "min":0, "max":10 }, "tagValue":{ "type":"string", "min":0, "max":256 }, "taskId":{ "type":"string", "min":1, "max":2048, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "timestamp":{"type":"timestamp"}, "validationMessage":{ "type":"string", "min":0, "max":10000, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "validationMessages":{ "type":"list", "member":{"shape":"validationMessage"} } } } botocore-1.5.7/botocore/data/devicefarm/0000777454262600001440000000000013042511307021240 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/devicefarm/2015-06-23/0000777454262600001440000000000013042511307022274 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/devicefarm/2015-06-23/paginators-1.json0000666454262600001440000000263013042511306025474 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListArtifacts": { "input_token": "nextToken", "output_token": "nextToken", "result_key": "artifacts" }, "ListDevicePools": { "input_token": "nextToken", "output_token": "nextToken", "result_key": "devicePools" }, "ListDevices": { "input_token": "nextToken", "output_token": "nextToken", "result_key": "devices" }, "ListJobs": { "input_token": "nextToken", "output_token": "nextToken", "result_key": "jobs" }, "ListProjects": { "input_token": "nextToken", "output_token": "nextToken", "result_key": "projects" }, "ListRuns": { "input_token": "nextToken", "output_token": "nextToken", "result_key": "runs" }, "ListSamples": { "input_token": "nextToken", "output_token": "nextToken", "result_key": "samples" }, "ListSuites": { "input_token": "nextToken", "output_token": "nextToken", "result_key": "suites" }, "ListTests": { "input_token": "nextToken", "output_token": "nextToken", "result_key": "tests" }, "ListUniqueProblems": { "input_token": "nextToken", "output_token": "nextToken", "result_key": "uniqueProblems" }, "ListUploads": { "input_token": "nextToken", "output_token": "nextToken", "result_key": "uploads" } } } botocore-1.5.7/botocore/data/devicefarm/2015-06-23/service-2.json0000666454262600001440000036130213042511306024772 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-06-23", "endpointPrefix":"devicefarm", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"AWS Device Farm", "signatureVersion":"v4", "targetPrefix":"DeviceFarm_20150623", "uid":"devicefarm-2015-06-23" }, "operations":{ "CreateDevicePool":{ "name":"CreateDevicePool", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDevicePoolRequest"}, "output":{"shape":"CreateDevicePoolResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Creates a device pool.

" }, "CreateProject":{ "name":"CreateProject", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateProjectRequest"}, "output":{"shape":"CreateProjectResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Creates a new project.

" }, "CreateRemoteAccessSession":{ "name":"CreateRemoteAccessSession", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRemoteAccessSessionRequest"}, "output":{"shape":"CreateRemoteAccessSessionResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Specifies and starts a remote access session.

" }, "CreateUpload":{ "name":"CreateUpload", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateUploadRequest"}, "output":{"shape":"CreateUploadResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Uploads an app or test scripts.

" }, "DeleteDevicePool":{ "name":"DeleteDevicePool", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDevicePoolRequest"}, "output":{"shape":"DeleteDevicePoolResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.

" }, "DeleteProject":{ "name":"DeleteProject", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteProjectRequest"}, "output":{"shape":"DeleteProjectResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Deletes an AWS Device Farm project, given the project ARN.

Note Deleting this resource does not stop an in-progress run.

" }, "DeleteRemoteAccessSession":{ "name":"DeleteRemoteAccessSession", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRemoteAccessSessionRequest"}, "output":{"shape":"DeleteRemoteAccessSessionResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Deletes a completed remote access session and its results.

" }, "DeleteRun":{ "name":"DeleteRun", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRunRequest"}, "output":{"shape":"DeleteRunResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Deletes the run, given the run ARN.

Note Deleting this resource does not stop an in-progress run.

" }, "DeleteUpload":{ "name":"DeleteUpload", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteUploadRequest"}, "output":{"shape":"DeleteUploadResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Deletes an upload given the upload ARN.

" }, "GetAccountSettings":{ "name":"GetAccountSettings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAccountSettingsRequest"}, "output":{"shape":"GetAccountSettingsResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.

" }, "GetDevice":{ "name":"GetDevice", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDeviceRequest"}, "output":{"shape":"GetDeviceResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about a unique device type.

" }, "GetDevicePool":{ "name":"GetDevicePool", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDevicePoolRequest"}, "output":{"shape":"GetDevicePoolResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about a device pool.

" }, "GetDevicePoolCompatibility":{ "name":"GetDevicePoolCompatibility", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDevicePoolCompatibilityRequest"}, "output":{"shape":"GetDevicePoolCompatibilityResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about compatibility with a device pool.

" }, "GetJob":{ "name":"GetJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetJobRequest"}, "output":{"shape":"GetJobResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about a job.

" }, "GetOfferingStatus":{ "name":"GetOfferingStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetOfferingStatusRequest"}, "output":{"shape":"GetOfferingStatusResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"NotEligibleException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

" }, "GetProject":{ "name":"GetProject", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetProjectRequest"}, "output":{"shape":"GetProjectResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about a project.

" }, "GetRemoteAccessSession":{ "name":"GetRemoteAccessSession", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRemoteAccessSessionRequest"}, "output":{"shape":"GetRemoteAccessSessionResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Returns a link to a currently running remote access session.

" }, "GetRun":{ "name":"GetRun", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRunRequest"}, "output":{"shape":"GetRunResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about a run.

" }, "GetSuite":{ "name":"GetSuite", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSuiteRequest"}, "output":{"shape":"GetSuiteResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about a suite.

" }, "GetTest":{ "name":"GetTest", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetTestRequest"}, "output":{"shape":"GetTestResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about a test.

" }, "GetUpload":{ "name":"GetUpload", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetUploadRequest"}, "output":{"shape":"GetUploadResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about an upload.

" }, "InstallToRemoteAccessSession":{ "name":"InstallToRemoteAccessSession", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"InstallToRemoteAccessSessionRequest"}, "output":{"shape":"InstallToRemoteAccessSessionResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.

" }, "ListArtifacts":{ "name":"ListArtifacts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListArtifactsRequest"}, "output":{"shape":"ListArtifactsResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about artifacts.

" }, "ListDevicePools":{ "name":"ListDevicePools", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDevicePoolsRequest"}, "output":{"shape":"ListDevicePoolsResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about device pools.

" }, "ListDevices":{ "name":"ListDevices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDevicesRequest"}, "output":{"shape":"ListDevicesResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about unique device types.

" }, "ListJobs":{ "name":"ListJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListJobsRequest"}, "output":{"shape":"ListJobsResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about jobs.

" }, "ListOfferingTransactions":{ "name":"ListOfferingTransactions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListOfferingTransactionsRequest"}, "output":{"shape":"ListOfferingTransactionsResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"NotEligibleException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

" }, "ListOfferings":{ "name":"ListOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListOfferingsRequest"}, "output":{"shape":"ListOfferingsResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"NotEligibleException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

" }, "ListProjects":{ "name":"ListProjects", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListProjectsRequest"}, "output":{"shape":"ListProjectsResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about projects.

" }, "ListRemoteAccessSessions":{ "name":"ListRemoteAccessSessions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRemoteAccessSessionsRequest"}, "output":{"shape":"ListRemoteAccessSessionsResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Returns a list of all currently running remote access sessions.

" }, "ListRuns":{ "name":"ListRuns", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRunsRequest"}, "output":{"shape":"ListRunsResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about runs, given an AWS Device Farm project ARN.

" }, "ListSamples":{ "name":"ListSamples", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSamplesRequest"}, "output":{"shape":"ListSamplesResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about samples, given an AWS Device Farm project ARN

" }, "ListSuites":{ "name":"ListSuites", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSuitesRequest"}, "output":{"shape":"ListSuitesResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about suites.

" }, "ListTests":{ "name":"ListTests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTestsRequest"}, "output":{"shape":"ListTestsResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about tests.

" }, "ListUniqueProblems":{ "name":"ListUniqueProblems", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListUniqueProblemsRequest"}, "output":{"shape":"ListUniqueProblemsResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about unique problems.

" }, "ListUploads":{ "name":"ListUploads", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListUploadsRequest"}, "output":{"shape":"ListUploadsResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Gets information about uploads, given an AWS Device Farm project ARN.

" }, "PurchaseOffering":{ "name":"PurchaseOffering", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseOfferingRequest"}, "output":{"shape":"PurchaseOfferingResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"NotEligibleException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

" }, "RenewOffering":{ "name":"RenewOffering", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RenewOfferingRequest"}, "output":{"shape":"RenewOfferingResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"NotEligibleException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

" }, "ScheduleRun":{ "name":"ScheduleRun", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ScheduleRunRequest"}, "output":{"shape":"ScheduleRunResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"IdempotencyException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Schedules a run.

" }, "StopRemoteAccessSession":{ "name":"StopRemoteAccessSession", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopRemoteAccessSessionRequest"}, "output":{"shape":"StopRemoteAccessSessionResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Ends a specified remote access session.

" }, "StopRun":{ "name":"StopRun", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopRunRequest"}, "output":{"shape":"StopRunResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.

" }, "UpdateDevicePool":{ "name":"UpdateDevicePool", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDevicePoolRequest"}, "output":{"shape":"UpdateDevicePoolResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).

" }, "UpdateProject":{ "name":"UpdateProject", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateProjectRequest"}, "output":{"shape":"UpdateProjectResult"}, "errors":[ {"shape":"ArgumentException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceAccountException"} ], "documentation":"

Modifies the specified project name, given the project ARN and a new name.

" } }, "shapes":{ "AWSAccountNumber":{ "type":"string", "max":16, "min":2 }, "AccountSettings":{ "type":"structure", "members":{ "awsAccountNumber":{ "shape":"AWSAccountNumber", "documentation":"

The AWS account number specified in the AccountSettings container.

" }, "unmeteredDevices":{ "shape":"PurchasedDevicesMap", "documentation":"

Returns the unmetered devices you have purchased or want to purchase.

" }, "unmeteredRemoteAccessDevices":{ "shape":"PurchasedDevicesMap", "documentation":"

Returns the unmetered remote access devices you have purchased or want to purchase.

" } }, "documentation":"

A container for account-level settings within AWS Device Farm.

" }, "AmazonResourceName":{ "type":"string", "min":32 }, "AmazonResourceNames":{ "type":"list", "member":{"shape":"AmazonResourceName"} }, "ArgumentException":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Any additional information about the exception.

" } }, "documentation":"

An invalid argument was specified.

", "exception":true }, "Artifact":{ "type":"structure", "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The artifact's ARN.

" }, "name":{ "shape":"Name", "documentation":"

The artifact's name.

" }, "type":{ "shape":"ArtifactType", "documentation":"

The artifact's type.

Allowed values include the following:

  • UNKNOWN: An unknown type.

  • SCREENSHOT: The screenshot type.

  • DEVICE_LOG: The device log type.

  • MESSAGE_LOG: The message log type.

  • RESULT_LOG: The result log type.

  • SERVICE_LOG: The service log type.

  • WEBKIT_LOG: The web kit log type.

  • INSTRUMENTATION_OUTPUT: The instrumentation type.

  • EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.

  • CALABASH_JSON_OUTPUT: The Calabash JSON output type.

  • CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.

  • CALABASH_STANDARD_OUTPUT: The Calabash standard output type.

  • CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.

  • AUTOMATION_OUTPUT: The automation output type.

  • APPIUM_SERVER_OUTPUT: The Appium server output type.

  • APPIUM_JAVA_OUTPUT: The Appium Java output type.

  • APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.

  • APPIUM_PYTHON_OUTPUT: The Appium Python output type.

  • APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type.

  • EXPLORER_EVENT_LOG: The Explorer event log output type.

  • EXPLORER_SUMMARY_LOG: The Explorer summary log output type.

  • APPLICATION_CRASH_REPORT: The application crash report output type.

  • XCTEST_LOG: The XCode test output type.

" }, "extension":{ "shape":"String", "documentation":"

The artifact's file extension.

" }, "url":{ "shape":"URL", "documentation":"

The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the artifact's file.

" } }, "documentation":"

Represents the output of a test. Examples of artifacts include logs and screenshots.

" }, "ArtifactCategory":{ "type":"string", "enum":[ "SCREENSHOT", "FILE", "LOG" ] }, "ArtifactType":{ "type":"string", "enum":[ "UNKNOWN", "SCREENSHOT", "DEVICE_LOG", "MESSAGE_LOG", "VIDEO_LOG", "RESULT_LOG", "SERVICE_LOG", "WEBKIT_LOG", "INSTRUMENTATION_OUTPUT", "EXERCISER_MONKEY_OUTPUT", "CALABASH_JSON_OUTPUT", "CALABASH_PRETTY_OUTPUT", "CALABASH_STANDARD_OUTPUT", "CALABASH_JAVA_XML_OUTPUT", "AUTOMATION_OUTPUT", "APPIUM_SERVER_OUTPUT", "APPIUM_JAVA_OUTPUT", "APPIUM_JAVA_XML_OUTPUT", "APPIUM_PYTHON_OUTPUT", "APPIUM_PYTHON_XML_OUTPUT", "EXPLORER_EVENT_LOG", "EXPLORER_SUMMARY_LOG", "APPLICATION_CRASH_REPORT", "XCTEST_LOG", "VIDEO" ] }, "Artifacts":{ "type":"list", "member":{"shape":"Artifact"} }, "BillingMethod":{ "type":"string", "enum":[ "METERED", "UNMETERED" ] }, "Boolean":{"type":"boolean"}, "CPU":{ "type":"structure", "members":{ "frequency":{ "shape":"String", "documentation":"

The CPU's frequency.

" }, "architecture":{ "shape":"String", "documentation":"

The CPU's architecture, for example x86 or ARM.

" }, "clock":{ "shape":"Double", "documentation":"

The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.

" } }, "documentation":"

Represents the amount of CPU that an app is using on a physical device.

Note that this does not represent system-wide CPU usage.

" }, "ContentType":{ "type":"string", "max":64, "min":0 }, "Counters":{ "type":"structure", "members":{ "total":{ "shape":"Integer", "documentation":"

The total number of entities.

" }, "passed":{ "shape":"Integer", "documentation":"

The number of passed entities.

" }, "failed":{ "shape":"Integer", "documentation":"

The number of failed entities.

" }, "warned":{ "shape":"Integer", "documentation":"

The number of warned entities.

" }, "errored":{ "shape":"Integer", "documentation":"

The number of errored entities.

" }, "stopped":{ "shape":"Integer", "documentation":"

The number of stopped entities.

" }, "skipped":{ "shape":"Integer", "documentation":"

The number of skipped entities.

" } }, "documentation":"

Represents entity counters.

" }, "CreateDevicePoolRequest":{ "type":"structure", "required":[ "projectArn", "name", "rules" ], "members":{ "projectArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the project for the device pool.

" }, "name":{ "shape":"Name", "documentation":"

The device pool's name.

" }, "description":{ "shape":"Message", "documentation":"

The device pool's description.

" }, "rules":{ "shape":"Rules", "documentation":"

The device pool's rules.

" } }, "documentation":"

Represents a request to the create device pool operation.

" }, "CreateDevicePoolResult":{ "type":"structure", "members":{ "devicePool":{ "shape":"DevicePool", "documentation":"

The newly created device pool.

" } }, "documentation":"

Represents the result of a create device pool request.

" }, "CreateProjectRequest":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"Name", "documentation":"

The project's name.

" } }, "documentation":"

Represents a request to the create project operation.

" }, "CreateProjectResult":{ "type":"structure", "members":{ "project":{ "shape":"Project", "documentation":"

The newly created project.

" } }, "documentation":"

Represents the result of a create project request.

" }, "CreateRemoteAccessSessionConfiguration":{ "type":"structure", "members":{ "billingMethod":{ "shape":"BillingMethod", "documentation":"

Returns the billing method for purposes of configuring a remote access session.

" } }, "documentation":"

Creates the configuration settings for a remote access session, including the device model and type.

" }, "CreateRemoteAccessSessionRequest":{ "type":"structure", "required":[ "projectArn", "deviceArn" ], "members":{ "projectArn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.

" }, "deviceArn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.

" }, "name":{ "shape":"Name", "documentation":"

The name of the remote access session that you wish to create.

" }, "configuration":{ "shape":"CreateRemoteAccessSessionConfiguration", "documentation":"

The configuration information for the remote access session request.

" } }, "documentation":"

Creates and submits a request to start a remote access session.

" }, "CreateRemoteAccessSessionResult":{ "type":"structure", "members":{ "remoteAccessSession":{ "shape":"RemoteAccessSession", "documentation":"

A container that describes the remote access session when the request to create a remote access session is sent.

" } }, "documentation":"

Represents the server response from a request to create a remote access session.

" }, "CreateUploadRequest":{ "type":"structure", "required":[ "projectArn", "name", "type" ], "members":{ "projectArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the project for the upload.

" }, "name":{ "shape":"Name", "documentation":"

The upload's file name. The name should not contain the '/' character. If uploading an iOS app, the file name needs to end with the .ipa extension. If uploading an Android app, the file name needs to end with the .apk extension. For all others, the file name must end with the .zip file extension.

" }, "type":{ "shape":"UploadType", "documentation":"

The upload's upload type.

Must be one of the following values:

  • ANDROID_APP: An Android upload.

  • IOS_APP: An iOS upload.

  • WEB_APP: A web appliction upload.

  • EXTERNAL_DATA: An external data upload.

  • APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.

  • APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.

  • APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.

  • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.

  • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.

  • APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.

  • CALABASH_TEST_PACKAGE: A Calabash test package upload.

  • INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.

  • UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.

  • UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.

  • XCTEST_TEST_PACKAGE: An XCode test package upload.

  • XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.

Note If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.

" }, "contentType":{ "shape":"ContentType", "documentation":"

The upload's content type (for example, \"application/octet-stream\").

" } }, "documentation":"

Represents a request to the create upload operation.

" }, "CreateUploadResult":{ "type":"structure", "members":{ "upload":{ "shape":"Upload", "documentation":"

The newly created upload.

" } }, "documentation":"

Represents the result of a create upload request.

" }, "CurrencyCode":{ "type":"string", "enum":["USD"] }, "DateTime":{"type":"timestamp"}, "DeleteDevicePoolRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

Represents the Amazon Resource Name (ARN) of the Device Farm device pool you wish to delete.

" } }, "documentation":"

Represents a request to the delete device pool operation.

" }, "DeleteDevicePoolResult":{ "type":"structure", "members":{ }, "documentation":"

Represents the result of a delete device pool request.

" }, "DeleteProjectRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

Represents the Amazon Resource Name (ARN) of the Device Farm project you wish to delete.

" } }, "documentation":"

Represents a request to the delete project operation.

" }, "DeleteProjectResult":{ "type":"structure", "members":{ }, "documentation":"

Represents the result of a delete project request.

" }, "DeleteRemoteAccessSessionRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the sesssion for which you want to delete remote access.

" } }, "documentation":"

Represents the request to delete the specified remote access session.

" }, "DeleteRemoteAccessSessionResult":{ "type":"structure", "members":{ }, "documentation":"

The response from the server when a request is made to delete the remote access session.

" }, "DeleteRunRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) for the run you wish to delete.

" } }, "documentation":"

Represents a request to the delete run operation.

" }, "DeleteRunResult":{ "type":"structure", "members":{ }, "documentation":"

Represents the result of a delete run request.

" }, "DeleteUploadRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

Represents the Amazon Resource Name (ARN) of the Device Farm upload you wish to delete.

" } }, "documentation":"

Represents a request to the delete upload operation.

" }, "DeleteUploadResult":{ "type":"structure", "members":{ }, "documentation":"

Represents the result of a delete upload request.

" }, "Device":{ "type":"structure", "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The device's ARN.

" }, "name":{ "shape":"Name", "documentation":"

The device's display name.

" }, "manufacturer":{ "shape":"String", "documentation":"

The device's manufacturer name.

" }, "model":{ "shape":"String", "documentation":"

The device's model name.

" }, "formFactor":{ "shape":"DeviceFormFactor", "documentation":"

The device's form factor.

Allowed values include:

  • PHONE: The phone form factor.

  • TABLET: The tablet form factor.

" }, "platform":{ "shape":"DevicePlatform", "documentation":"

The device's platform.

Allowed values include:

  • ANDROID: The Android platform.

  • IOS: The iOS platform.

" }, "os":{ "shape":"String", "documentation":"

The device's operating system type.

" }, "cpu":{ "shape":"CPU", "documentation":"

Information about the device's CPU.

" }, "resolution":{"shape":"Resolution"}, "heapSize":{ "shape":"Long", "documentation":"

The device's heap size, expressed in bytes.

" }, "memory":{ "shape":"Long", "documentation":"

The device's total memory size, expressed in bytes.

" }, "image":{ "shape":"String", "documentation":"

The device's image name.

" }, "carrier":{ "shape":"String", "documentation":"

The device's carrier.

" }, "radio":{ "shape":"String", "documentation":"

The device's radio.

" }, "remoteAccessEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether remote access has been enabled for the specified device.

" }, "fleetType":{ "shape":"String", "documentation":"

The type of fleet to which this device belongs. Possible values for fleet type are PRIVATE and PUBLIC.

" }, "fleetName":{ "shape":"String", "documentation":"

The name of the fleet to which this device belongs.

" } }, "documentation":"

Represents a device type that an app is tested against.

" }, "DeviceAttribute":{ "type":"string", "enum":[ "ARN", "PLATFORM", "FORM_FACTOR", "MANUFACTURER", "REMOTE_ACCESS_ENABLED" ] }, "DeviceFormFactor":{ "type":"string", "enum":[ "PHONE", "TABLET" ] }, "DeviceMinutes":{ "type":"structure", "members":{ "total":{ "shape":"Double", "documentation":"

When specified, represents the total minutes used by the resource to run tests.

" }, "metered":{ "shape":"Double", "documentation":"

When specified, represents only the sum of metered minutes used by the resource to run tests.

" }, "unmetered":{ "shape":"Double", "documentation":"

When specified, represents only the sum of unmetered minutes used by the resource to run tests.

" } }, "documentation":"

Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.

" }, "DevicePlatform":{ "type":"string", "enum":[ "ANDROID", "IOS" ] }, "DevicePool":{ "type":"structure", "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The device pool's ARN.

" }, "name":{ "shape":"Name", "documentation":"

The device pool's name.

" }, "description":{ "shape":"Message", "documentation":"

The device pool's description.

" }, "type":{ "shape":"DevicePoolType", "documentation":"

The device pool's type.

Allowed values include:

  • CURATED: A device pool that is created and managed by AWS Device Farm.

  • PRIVATE: A device pool that is created and managed by the device pool developer.

" }, "rules":{ "shape":"Rules", "documentation":"

Information about the device pool's rules.

" } }, "documentation":"

Represents a collection of device types.

" }, "DevicePoolCompatibilityResult":{ "type":"structure", "members":{ "device":{"shape":"Device"}, "compatible":{ "shape":"Boolean", "documentation":"

Whether the result was compatible with the device pool.

" }, "incompatibilityMessages":{ "shape":"IncompatibilityMessages", "documentation":"

Information about the compatibility.

" } }, "documentation":"

Represents a device pool compatibility result.

" }, "DevicePoolCompatibilityResults":{ "type":"list", "member":{"shape":"DevicePoolCompatibilityResult"} }, "DevicePoolType":{ "type":"string", "enum":[ "CURATED", "PRIVATE" ] }, "DevicePools":{ "type":"list", "member":{"shape":"DevicePool"} }, "Devices":{ "type":"list", "member":{"shape":"Device"} }, "Double":{"type":"double"}, "ExecutionResult":{ "type":"string", "enum":[ "PENDING", "PASSED", "WARNED", "FAILED", "SKIPPED", "ERRORED", "STOPPED" ] }, "ExecutionStatus":{ "type":"string", "enum":[ "PENDING", "PENDING_CONCURRENCY", "PENDING_DEVICE", "PROCESSING", "SCHEDULING", "PREPARING", "RUNNING", "COMPLETED", "STOPPING" ] }, "Filter":{ "type":"string", "max":8192, "min":0 }, "GetAccountSettingsRequest":{ "type":"structure", "members":{ }, "documentation":"

Represents the request sent to retrieve the account settings.

" }, "GetAccountSettingsResult":{ "type":"structure", "members":{ "accountSettings":{"shape":"AccountSettings"} }, "documentation":"

Represents the account settings return values from the GetAccountSettings request.

" }, "GetDevicePoolCompatibilityRequest":{ "type":"structure", "required":["devicePoolArn"], "members":{ "devicePoolArn":{ "shape":"AmazonResourceName", "documentation":"

The device pool's ARN.

" }, "appArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the app that is associated with the specified device pool.

" }, "testType":{ "shape":"TestType", "documentation":"

The test type for the specified device pool.

Allowed values include the following:

  • BUILTIN_FUZZ: The built-in fuzz type.

  • BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

  • APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

  • APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

  • APPIUM_PYTHON: The Appium Python type.

  • APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

  • APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

  • APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

  • CALABASH: The Calabash type.

  • INSTRUMENTATION: The Instrumentation type.

  • UIAUTOMATION: The uiautomation type.

  • UIAUTOMATOR: The uiautomator type.

  • XCTEST: The XCode test type.

  • XCTEST_UI: The XCode UI test type.

" } }, "documentation":"

Represents a request to the get device pool compatibility operation.

" }, "GetDevicePoolCompatibilityResult":{ "type":"structure", "members":{ "compatibleDevices":{ "shape":"DevicePoolCompatibilityResults", "documentation":"

Information about compatible devices.

" }, "incompatibleDevices":{ "shape":"DevicePoolCompatibilityResults", "documentation":"

Information about incompatible devices.

" } }, "documentation":"

Represents the result of describe device pool compatibility request.

" }, "GetDevicePoolRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The device pool's ARN.

" } }, "documentation":"

Represents a request to the get device pool operation.

" }, "GetDevicePoolResult":{ "type":"structure", "members":{ "devicePool":{"shape":"DevicePool"} }, "documentation":"

Represents the result of a get device pool request.

" }, "GetDeviceRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The device type's ARN.

" } }, "documentation":"

Represents a request to the get device request.

" }, "GetDeviceResult":{ "type":"structure", "members":{ "device":{"shape":"Device"} }, "documentation":"

Represents the result of a get device request.

" }, "GetJobRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The job's ARN.

" } }, "documentation":"

Represents a request to the get job operation.

" }, "GetJobResult":{ "type":"structure", "members":{ "job":{"shape":"Job"} }, "documentation":"

Represents the result of a get job request.

" }, "GetOfferingStatusRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents the request to retrieve the offering status for the specified customer or account.

" }, "GetOfferingStatusResult":{ "type":"structure", "members":{ "current":{ "shape":"OfferingStatusMap", "documentation":"

When specified, gets the offering status for the current period.

" }, "nextPeriod":{ "shape":"OfferingStatusMap", "documentation":"

When specified, gets the offering status for the next period.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Returns the status result for a device offering.

" }, "GetProjectRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The project's ARN.

" } }, "documentation":"

Represents a request to the get project operation.

" }, "GetProjectResult":{ "type":"structure", "members":{ "project":{"shape":"Project"} }, "documentation":"

Represents the result of a get project request.

" }, "GetRemoteAccessSessionRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.

" } }, "documentation":"

Represents the request to get information about the specified remote access session.

" }, "GetRemoteAccessSessionResult":{ "type":"structure", "members":{ "remoteAccessSession":{ "shape":"RemoteAccessSession", "documentation":"

A container that lists detailed information about the remote access session.

" } }, "documentation":"

Represents the response from the server that lists detailed information about the remote access session.

" }, "GetRunRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The run's ARN.

" } }, "documentation":"

Represents a request to the get run operation.

" }, "GetRunResult":{ "type":"structure", "members":{ "run":{"shape":"Run"} }, "documentation":"

Represents the result of a get run request.

" }, "GetSuiteRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The suite's ARN.

" } }, "documentation":"

Represents a request to the get suite operation.

" }, "GetSuiteResult":{ "type":"structure", "members":{ "suite":{"shape":"Suite"} }, "documentation":"

Represents the result of a get suite request.

" }, "GetTestRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The test's ARN.

" } }, "documentation":"

Represents a request to the get test operation.

" }, "GetTestResult":{ "type":"structure", "members":{ "test":{"shape":"Test"} }, "documentation":"

Represents the result of a get test request.

" }, "GetUploadRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The upload's ARN.

" } }, "documentation":"

Represents a request to the get upload operation.

" }, "GetUploadResult":{ "type":"structure", "members":{ "upload":{"shape":"Upload"} }, "documentation":"

Represents the result of a get upload request.

" }, "IdempotencyException":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Any additional information about the exception.

" } }, "documentation":"

An entity with the same name already exists.

", "exception":true }, "IncompatibilityMessage":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

A message about the incompatibility.

" }, "type":{ "shape":"DeviceAttribute", "documentation":"

The type of incompatibility.

Allowed values include:

  • ARN: The ARN.

  • FORM_FACTOR: The form factor (for example, phone or tablet).

  • MANUFACTURER: The manufacturer.

  • PLATFORM: The platform (for example, Android or iOS).

" } }, "documentation":"

Represents information about incompatibility.

" }, "IncompatibilityMessages":{ "type":"list", "member":{"shape":"IncompatibilityMessage"} }, "InstallToRemoteAccessSessionRequest":{ "type":"structure", "required":[ "remoteAccessSessionArn", "appArn" ], "members":{ "remoteAccessSessionArn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.

" }, "appArn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the app about which you are requesting information.

" } }, "documentation":"

Represents the request to install an Android application (in .apk format) or an iOS application (in .ipa format) as part of a remote access session.

" }, "InstallToRemoteAccessSessionResult":{ "type":"structure", "members":{ "appUpload":{"shape":"Upload"} }, "documentation":"

Represents the response from the server after AWS Device Farm makes a request to install to a remote access session.

" }, "Integer":{"type":"integer"}, "Job":{ "type":"structure", "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The job's ARN.

" }, "name":{ "shape":"Name", "documentation":"

The job's name.

" }, "type":{ "shape":"TestType", "documentation":"

The job's type.

Allowed values include the following:

  • BUILTIN_FUZZ: The built-in fuzz type.

  • BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

  • APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

  • APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

  • APPIUM_PYTHON: The Appium Python type.

  • APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

  • APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

  • APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

  • CALABASH: The Calabash type.

  • INSTRUMENTATION: The Instrumentation type.

  • UIAUTOMATION: The uiautomation type.

  • UIAUTOMATOR: The uiautomator type.

  • XCTEST: The XCode test type.

  • XCTEST_UI: The XCode UI test type.

" }, "created":{ "shape":"DateTime", "documentation":"

When the job was created.

" }, "status":{ "shape":"ExecutionStatus", "documentation":"

The job's status.

Allowed values include:

  • PENDING: A pending status.

  • PENDING_CONCURRENCY: A pending concurrency status.

  • PENDING_DEVICE: A pending device status.

  • PROCESSING: A processing status.

  • SCHEDULING: A scheduling status.

  • PREPARING: A preparing status.

  • RUNNING: A running status.

  • COMPLETED: A completed status.

  • STOPPING: A stopping status.

" }, "result":{ "shape":"ExecutionResult", "documentation":"

The job's result.

Allowed values include:

  • PENDING: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

" }, "started":{ "shape":"DateTime", "documentation":"

The job's start time.

" }, "stopped":{ "shape":"DateTime", "documentation":"

The job's stop time.

" }, "counters":{ "shape":"Counters", "documentation":"

The job's result counters.

" }, "message":{ "shape":"Message", "documentation":"

A message about the job's result.

" }, "device":{"shape":"Device"}, "deviceMinutes":{ "shape":"DeviceMinutes", "documentation":"

Represents the total (metered or unmetered) minutes used by the job.

" } }, "documentation":"

Represents a device.

" }, "Jobs":{ "type":"list", "member":{"shape":"Job"} }, "LimitExceededException":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Any additional information about the exception.

" } }, "documentation":"

A limit was exceeded.

", "exception":true }, "ListArtifactsRequest":{ "type":"structure", "required":[ "arn", "type" ], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The Run, Job, Suite, or Test ARN.

" }, "type":{ "shape":"ArtifactCategory", "documentation":"

The artifacts' type.

Allowed values include:

  • FILE: The artifacts are files.

  • LOG: The artifacts are logs.

  • SCREENSHOT: The artifacts are screenshots.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents a request to the list artifacts operation.

" }, "ListArtifactsResult":{ "type":"structure", "members":{ "artifacts":{ "shape":"Artifacts", "documentation":"

Information about the artifacts.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation":"

Represents the result of a list artifacts operation.

" }, "ListDevicePoolsRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The project ARN.

" }, "type":{ "shape":"DevicePoolType", "documentation":"

The device pools' type.

Allowed values include:

  • CURATED: A device pool that is created and managed by AWS Device Farm.

  • PRIVATE: A device pool that is created and managed by the device pool developer.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents the result of a list device pools request.

" }, "ListDevicePoolsResult":{ "type":"structure", "members":{ "devicePools":{ "shape":"DevicePools", "documentation":"

Information about the device pools.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation":"

Represents the result of a list device pools request.

" }, "ListDevicesRequest":{ "type":"structure", "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the project.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents the result of a list devices request.

" }, "ListDevicesResult":{ "type":"structure", "members":{ "devices":{ "shape":"Devices", "documentation":"

Information about the devices.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation":"

Represents the result of a list devices operation.

" }, "ListJobsRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The jobs' ARNs.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents a request to the list jobs operation.

" }, "ListJobsResult":{ "type":"structure", "members":{ "jobs":{ "shape":"Jobs", "documentation":"

Information about the jobs.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation":"

Represents the result of a list jobs request.

" }, "ListOfferingTransactionsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents the request to list the offering transaction history.

" }, "ListOfferingTransactionsResult":{ "type":"structure", "members":{ "offeringTransactions":{ "shape":"OfferingTransactions", "documentation":"

The audit log of subscriptions you have purchased and modified through AWS Device Farm.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Returns the transaction log of the specified offerings.

" }, "ListOfferingsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents the request to list all offerings.

" }, "ListOfferingsResult":{ "type":"structure", "members":{ "offerings":{ "shape":"Offerings", "documentation":"

A value representing the list offering results.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents the return values of the list of offerings.

" }, "ListProjectsRequest":{ "type":"structure", "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents a request to the list projects operation.

" }, "ListProjectsResult":{ "type":"structure", "members":{ "projects":{ "shape":"Projects", "documentation":"

Information about the projects.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation":"

Represents the result of a list projects request.

" }, "ListRemoteAccessSessionsRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents the request to return information about the remote access session.

" }, "ListRemoteAccessSessionsResult":{ "type":"structure", "members":{ "remoteAccessSessions":{ "shape":"RemoteAccessSessions", "documentation":"

A container representing the metadata from the service about each remote access session you are requesting.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents the response from the server after AWS Device Farm makes a request to return information about the remote access session.

" }, "ListRunsRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the project for which you want to list runs.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents a request to the list runs operation.

" }, "ListRunsResult":{ "type":"structure", "members":{ "runs":{ "shape":"Runs", "documentation":"

Information about the runs.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation":"

Represents the result of a list runs request.

" }, "ListSamplesRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the project for which you want to list samples.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents a request to the list samples operation.

" }, "ListSamplesResult":{ "type":"structure", "members":{ "samples":{ "shape":"Samples", "documentation":"

Information about the samples.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation":"

Represents the result of a list samples request.

" }, "ListSuitesRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The suites' ARNs.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents a request to the list suites operation.

" }, "ListSuitesResult":{ "type":"structure", "members":{ "suites":{ "shape":"Suites", "documentation":"

Information about the suites.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation":"

Represents the result of a list suites request.

" }, "ListTestsRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The tests' ARNs.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents a request to the list tests operation.

" }, "ListTestsResult":{ "type":"structure", "members":{ "tests":{ "shape":"Tests", "documentation":"

Information about the tests.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation":"

Represents the result of a list tests request.

" }, "ListUniqueProblemsRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The unique problems' ARNs.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents a request to the list unique problems operation.

" }, "ListUniqueProblemsResult":{ "type":"structure", "members":{ "uniqueProblems":{ "shape":"UniqueProblemsByExecutionResultMap", "documentation":"

Information about the unique problems.

Allowed values include:

  • PENDING: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation":"

Represents the result of a list unique problems request.

" }, "ListUploadsRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the project for which you want to list uploads.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents a request to the list uploads operation.

" }, "ListUploadsResult":{ "type":"structure", "members":{ "uploads":{ "shape":"Uploads", "documentation":"

Information about the uploads.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" } }, "documentation":"

Represents the result of a list uploads request.

" }, "Location":{ "type":"structure", "required":[ "latitude", "longitude" ], "members":{ "latitude":{ "shape":"Double", "documentation":"

The latitude.

" }, "longitude":{ "shape":"Double", "documentation":"

The longitude.

" } }, "documentation":"

Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example 47.6204, -122.3491).

Elevation is currently not supported.

" }, "Long":{"type":"long"}, "Message":{ "type":"string", "max":16384, "min":0 }, "Metadata":{ "type":"string", "max":8192, "min":0 }, "MonetaryAmount":{ "type":"structure", "members":{ "amount":{ "shape":"Double", "documentation":"

The numerical amount of an offering or transaction.

" }, "currencyCode":{ "shape":"CurrencyCode", "documentation":"

The currency code of a monetary amount. For example, USD means \"U.S. dollars.\"

" } }, "documentation":"

A number representing the monetary amount for an offering or transaction.

" }, "Name":{ "type":"string", "max":256, "min":0 }, "NotEligibleException":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

The HTTP response code of a Not Eligible exception.

" } }, "documentation":"

Exception gets thrown when a user is not eligible to perform the specified transaction.

", "exception":true }, "NotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Any additional information about the exception.

" } }, "documentation":"

The specified entity was not found.

", "exception":true }, "Offering":{ "type":"structure", "members":{ "id":{ "shape":"OfferingIdentifier", "documentation":"

The ID that corresponds to a device offering.

" }, "description":{ "shape":"Message", "documentation":"

A string describing the offering.

" }, "type":{ "shape":"OfferingType", "documentation":"

The type of offering (e.g., \"RECURRING\") for a device.

" }, "platform":{ "shape":"DevicePlatform", "documentation":"

The platform of the device (e.g., ANDROID or IOS).

" }, "recurringCharges":{ "shape":"RecurringCharges", "documentation":"

Specifies whether there are recurring charges for the offering.

" } }, "documentation":"

Represents the metadata of a device offering.

" }, "OfferingIdentifier":{ "type":"string", "min":32 }, "OfferingStatus":{ "type":"structure", "members":{ "type":{ "shape":"OfferingTransactionType", "documentation":"

The type specified for the offering status.

" }, "offering":{ "shape":"Offering", "documentation":"

Represents the metadata of an offering status.

" }, "quantity":{ "shape":"Integer", "documentation":"

The number of available devices in the offering.

" }, "effectiveOn":{ "shape":"DateTime", "documentation":"

The date on which the offering is effective.

" } }, "documentation":"

The status of the offering.

" }, "OfferingStatusMap":{ "type":"map", "key":{"shape":"OfferingIdentifier"}, "value":{"shape":"OfferingStatus"} }, "OfferingTransaction":{ "type":"structure", "members":{ "offeringStatus":{ "shape":"OfferingStatus", "documentation":"

The status of an offering transaction.

" }, "transactionId":{ "shape":"TransactionIdentifier", "documentation":"

The transaction ID of the offering transaction.

" }, "createdOn":{ "shape":"DateTime", "documentation":"

The date on which an offering transaction was created.

" }, "cost":{ "shape":"MonetaryAmount", "documentation":"

The cost of an offering transaction.

" } }, "documentation":"

Represents the metadata of an offering transaction.

" }, "OfferingTransactionType":{ "type":"string", "enum":[ "PURCHASE", "RENEW", "SYSTEM" ] }, "OfferingTransactions":{ "type":"list", "member":{"shape":"OfferingTransaction"} }, "OfferingType":{ "type":"string", "enum":["RECURRING"] }, "Offerings":{ "type":"list", "member":{"shape":"Offering"} }, "PaginationToken":{ "type":"string", "max":1024, "min":4 }, "Problem":{ "type":"structure", "members":{ "run":{ "shape":"ProblemDetail", "documentation":"

Information about the associated run.

" }, "job":{ "shape":"ProblemDetail", "documentation":"

Information about the associated job.

" }, "suite":{ "shape":"ProblemDetail", "documentation":"

Information about the associated suite.

" }, "test":{ "shape":"ProblemDetail", "documentation":"

Information about the associated test.

" }, "device":{ "shape":"Device", "documentation":"

Information about the associated device.

" }, "result":{ "shape":"ExecutionResult", "documentation":"

The problem's result.

Allowed values include:

  • PENDING: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

" }, "message":{ "shape":"Message", "documentation":"

A message about the problem's result.

" } }, "documentation":"

Represents a specific warning or failure.

" }, "ProblemDetail":{ "type":"structure", "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The problem detail's ARN.

" }, "name":{ "shape":"Name", "documentation":"

The problem detail's name.

" } }, "documentation":"

Information about a problem detail.

" }, "Problems":{ "type":"list", "member":{"shape":"Problem"} }, "Project":{ "type":"structure", "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The project's ARN.

" }, "name":{ "shape":"Name", "documentation":"

The project's name.

" }, "created":{ "shape":"DateTime", "documentation":"

When the project was created.

" } }, "documentation":"

Represents an operating-system neutral workspace for running and managing tests.

" }, "Projects":{ "type":"list", "member":{"shape":"Project"} }, "PurchaseOfferingRequest":{ "type":"structure", "members":{ "offeringId":{ "shape":"OfferingIdentifier", "documentation":"

The ID of the offering.

" }, "quantity":{ "shape":"Integer", "documentation":"

The number of device slots you wish to purchase in an offering request.

" } }, "documentation":"

Represents a request for a purchase offering.

" }, "PurchaseOfferingResult":{ "type":"structure", "members":{ "offeringTransaction":{ "shape":"OfferingTransaction", "documentation":"

Represents the offering transaction for the purchase result.

" } }, "documentation":"

The result of the purchase offering (e.g., success or failure).

" }, "PurchasedDevicesMap":{ "type":"map", "key":{"shape":"DevicePlatform"}, "value":{"shape":"Integer"} }, "Radios":{ "type":"structure", "members":{ "wifi":{ "shape":"Boolean", "documentation":"

True if Wi-Fi is enabled at the beginning of the test; otherwise, false.

" }, "bluetooth":{ "shape":"Boolean", "documentation":"

True if Bluetooth is enabled at the beginning of the test; otherwise, false.

" }, "nfc":{ "shape":"Boolean", "documentation":"

True if NFC is enabled at the beginning of the test; otherwise, false.

" }, "gps":{ "shape":"Boolean", "documentation":"

True if GPS is enabled at the beginning of the test; otherwise, false.

" } }, "documentation":"

Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC.

" }, "RecurringCharge":{ "type":"structure", "members":{ "cost":{ "shape":"MonetaryAmount", "documentation":"

The cost of the recurring charge.

" }, "frequency":{ "shape":"RecurringChargeFrequency", "documentation":"

The frequency in which charges will recur.

" } }, "documentation":"

Specifies whether charges for devices will be recurring.

" }, "RecurringChargeFrequency":{ "type":"string", "enum":["MONTHLY"] }, "RecurringCharges":{ "type":"list", "member":{"shape":"RecurringCharge"} }, "RemoteAccessSession":{ "type":"structure", "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the remote access session.

" }, "name":{ "shape":"Name", "documentation":"

The name of the remote access session.

" }, "created":{ "shape":"DateTime", "documentation":"

The date and time the remote access session was created.

" }, "status":{ "shape":"ExecutionStatus", "documentation":"

The status of the remote access session. Can be any of the following:

  • PENDING: A pending status.

  • PENDING_CONCURRENCY: A pending concurrency status.

  • PENDING_DEVICE: A pending device status.

  • PROCESSING: A processing status.

  • SCHEDULING: A scheduling status.

  • PREPARING: A preparing status.

  • RUNNING: A running status.

  • COMPLETED: A completed status.

  • STOPPING: A stopping status.

" }, "result":{ "shape":"ExecutionResult", "documentation":"

The result of the remote access session. Can be any of the following:

  • PENDING: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

" }, "message":{ "shape":"Message", "documentation":"

A message about the remote access session.

" }, "started":{ "shape":"DateTime", "documentation":"

The date and time the remote access session was started.

" }, "stopped":{ "shape":"DateTime", "documentation":"

The date and time the remote access session was stopped.

" }, "device":{"shape":"Device"}, "billingMethod":{ "shape":"BillingMethod", "documentation":"

The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology.\"

" }, "deviceMinutes":{"shape":"DeviceMinutes"}, "endpoint":{ "shape":"String", "documentation":"

The endpoint for the remote access sesssion.

" } }, "documentation":"

Represents information about the remote access session.

" }, "RemoteAccessSessions":{ "type":"list", "member":{"shape":"RemoteAccessSession"} }, "RenewOfferingRequest":{ "type":"structure", "members":{ "offeringId":{ "shape":"OfferingIdentifier", "documentation":"

The ID of a request to renew an offering.

" }, "quantity":{ "shape":"Integer", "documentation":"

The quantity requested in an offering renewal.

" } }, "documentation":"

A request representing an offering renewal.

" }, "RenewOfferingResult":{ "type":"structure", "members":{ "offeringTransaction":{ "shape":"OfferingTransaction", "documentation":"

Represents the status of the offering transaction for the renewal.

" } }, "documentation":"

The result of a renewal offering.

" }, "Resolution":{ "type":"structure", "members":{ "width":{ "shape":"Integer", "documentation":"

The screen resolution's width, expressed in pixels.

" }, "height":{ "shape":"Integer", "documentation":"

The screen resolution's height, expressed in pixels.

" } }, "documentation":"

Represents the screen resolution of a device in height and width, expressed in pixels.

" }, "Rule":{ "type":"structure", "members":{ "attribute":{ "shape":"DeviceAttribute", "documentation":"

The rule's stringified attribute. For example, specify the value as \"\\\"abc\\\"\".

Allowed values include:

  • ARN: The ARN.

  • FORM_FACTOR: The form factor (for example, phone or tablet).

  • MANUFACTURER: The manufacturer.

  • PLATFORM: The platform (for example, Android or iOS).

" }, "operator":{ "shape":"RuleOperator", "documentation":"

The rule's operator.

  • EQUALS: The equals operator.

  • GREATER_THAN: The greater-than operator.

  • IN: The in operator.

  • LESS_THAN: The less-than operator.

  • NOT_IN: The not-in operator.

" }, "value":{ "shape":"String", "documentation":"

The rule's value.

" } }, "documentation":"

Represents a condition for a device pool.

" }, "RuleOperator":{ "type":"string", "enum":[ "EQUALS", "LESS_THAN", "GREATER_THAN", "IN", "NOT_IN" ] }, "Rules":{ "type":"list", "member":{"shape":"Rule"} }, "Run":{ "type":"structure", "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The run's ARN.

" }, "name":{ "shape":"Name", "documentation":"

The run's name.

" }, "type":{ "shape":"TestType", "documentation":"

The run's type.

Must be one of the following values:

  • BUILTIN_FUZZ: The built-in fuzz type.

  • BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

  • APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

  • APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

  • APPIUM_PYTHON: The Appium Python type.

  • APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

  • APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

  • APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

  • CALABASH: The Calabash type.

  • INSTRUMENTATION: The Instrumentation type.

  • UIAUTOMATION: The uiautomation type.

  • UIAUTOMATOR: The uiautomator type.

  • XCTEST: The XCode test type.

  • XCTEST_UI: The XCode UI test type.

" }, "platform":{ "shape":"DevicePlatform", "documentation":"

The run's platform.

Allowed values include:

  • ANDROID: The Android platform.

  • IOS: The iOS platform.

" }, "created":{ "shape":"DateTime", "documentation":"

When the run was created.

" }, "status":{ "shape":"ExecutionStatus", "documentation":"

The run's status.

Allowed values include:

  • PENDING: A pending status.

  • PENDING_CONCURRENCY: A pending concurrency status.

  • PENDING_DEVICE: A pending device status.

  • PROCESSING: A processing status.

  • SCHEDULING: A scheduling status.

  • PREPARING: A preparing status.

  • RUNNING: A running status.

  • COMPLETED: A completed status.

  • STOPPING: A stopping status.

" }, "result":{ "shape":"ExecutionResult", "documentation":"

The run's result.

Allowed values include:

  • PENDING: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

" }, "started":{ "shape":"DateTime", "documentation":"

The run's start time.

" }, "stopped":{ "shape":"DateTime", "documentation":"

The run's stop time.

" }, "counters":{ "shape":"Counters", "documentation":"

The run's result counters.

" }, "message":{ "shape":"Message", "documentation":"

A message about the run's result.

" }, "totalJobs":{ "shape":"Integer", "documentation":"

The total number of jobs for the run.

" }, "completedJobs":{ "shape":"Integer", "documentation":"

The total number of completed jobs.

" }, "billingMethod":{ "shape":"BillingMethod", "documentation":"

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

" }, "deviceMinutes":{ "shape":"DeviceMinutes", "documentation":"

Represents the total (metered or unmetered) minutes used by the test run.

" } }, "documentation":"

Represents an app on a set of devices with a specific test and configuration.

" }, "Runs":{ "type":"list", "member":{"shape":"Run"} }, "Sample":{ "type":"structure", "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The sample's ARN.

" }, "type":{ "shape":"SampleType", "documentation":"

The sample's type.

Must be one of the following values:

  • CPU: A CPU sample type. This is expressed as the app processing CPU time (including child processes) as reported by process, as a percentage.

  • MEMORY: A memory usage sample type. This is expressed as the total proportional set size of an app process, in kilobytes.

  • NATIVE_AVG_DRAWTIME

  • NATIVE_FPS

  • NATIVE_FRAMES

  • NATIVE_MAX_DRAWTIME

  • NATIVE_MIN_DRAWTIME

  • OPENGL_AVG_DRAWTIME

  • OPENGL_FPS

  • OPENGL_FRAMES

  • OPENGL_MAX_DRAWTIME

  • OPENGL_MIN_DRAWTIME

  • RX

  • RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, by app process.

  • THREADS: A threads sample type. This is expressed as the total number of threads per app process.

  • TX

  • TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process.

" }, "url":{ "shape":"URL", "documentation":"

The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the sample's file.

" } }, "documentation":"

Represents a sample of performance data.

" }, "SampleType":{ "type":"string", "enum":[ "CPU", "MEMORY", "THREADS", "RX_RATE", "TX_RATE", "RX", "TX", "NATIVE_FRAMES", "NATIVE_FPS", "NATIVE_MIN_DRAWTIME", "NATIVE_AVG_DRAWTIME", "NATIVE_MAX_DRAWTIME", "OPENGL_FRAMES", "OPENGL_FPS", "OPENGL_MIN_DRAWTIME", "OPENGL_AVG_DRAWTIME", "OPENGL_MAX_DRAWTIME" ] }, "Samples":{ "type":"list", "member":{"shape":"Sample"} }, "ScheduleRunConfiguration":{ "type":"structure", "members":{ "extraDataPackageArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app's sandbox for iOS.

" }, "networkProfileArn":{ "shape":"AmazonResourceName", "documentation":"

Reserved for internal use.

" }, "locale":{ "shape":"String", "documentation":"

Information about the locale that is used for the run.

" }, "location":{ "shape":"Location", "documentation":"

Information about the location that is used for the run.

" }, "radios":{ "shape":"Radios", "documentation":"

Information about the radio states for the run.

" }, "auxiliaryApps":{ "shape":"AmazonResourceNames", "documentation":"

A list of auxiliary apps for the run.

" }, "billingMethod":{ "shape":"BillingMethod", "documentation":"

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

" } }, "documentation":"

Represents the settings for a run. Includes things like location, radio states, auxiliary apps, and network profiles.

" }, "ScheduleRunRequest":{ "type":"structure", "required":[ "projectArn", "devicePoolArn", "test" ], "members":{ "projectArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the project for the run to be scheduled.

" }, "appArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the app to schedule a run.

" }, "devicePoolArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the device pool for the run to be scheduled.

" }, "name":{ "shape":"Name", "documentation":"

The name for the run to be scheduled.

" }, "test":{ "shape":"ScheduleRunTest", "documentation":"

Information about the test for the run to be scheduled.

" }, "configuration":{ "shape":"ScheduleRunConfiguration", "documentation":"

Information about the settings for the run to be scheduled.

" } }, "documentation":"

Represents a request to the schedule run operation.

" }, "ScheduleRunResult":{ "type":"structure", "members":{ "run":{ "shape":"Run", "documentation":"

Information about the scheduled run.

" } }, "documentation":"

Represents the result of a schedule run request.

" }, "ScheduleRunTest":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"TestType", "documentation":"

The test's type.

Must be one of the following values:

  • BUILTIN_FUZZ: The built-in fuzz type.

  • BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

  • APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

  • APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

  • APPIUM_PYTHON: The Appium Python type.

  • APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

  • APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

  • APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

  • CALABASH: The Calabash type.

  • INSTRUMENTATION: The Instrumentation type.

  • UIAUTOMATION: The uiautomation type.

  • UIAUTOMATOR: The uiautomator type.

  • XCTEST: The XCode test type.

  • XCTEST_UI: The XCode UI test type.

" }, "testPackageArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the uploaded test that will be run.

" }, "filter":{ "shape":"Filter", "documentation":"

The test's filter.

" }, "parameters":{ "shape":"TestParameters", "documentation":"

The test's parameters, such as test framework parameters and fixture settings.

" } }, "documentation":"

Represents additional test settings.

" }, "ServiceAccountException":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Any additional information about the exception.

" } }, "documentation":"

There was a problem with the service account.

", "exception":true }, "StopRemoteAccessSessionRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the remote access session you wish to stop.

" } }, "documentation":"

Represents the request to stop the remote access session.

" }, "StopRemoteAccessSessionResult":{ "type":"structure", "members":{ "remoteAccessSession":{ "shape":"RemoteAccessSession", "documentation":"

A container representing the metadata from the service about the remote access session you are stopping.

" } }, "documentation":"

Represents the response from the server that describes the remote access session when AWS Device Farm stops the session.

" }, "StopRunRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

Represents the Amazon Resource Name (ARN) of the Device Farm run you wish to stop.

" } }, "documentation":"

Represents the request to stop a specific run.

" }, "StopRunResult":{ "type":"structure", "members":{ "run":{"shape":"Run"} }, "documentation":"

Represents the results of your stop run attempt.

" }, "String":{"type":"string"}, "Suite":{ "type":"structure", "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The suite's ARN.

" }, "name":{ "shape":"Name", "documentation":"

The suite's name.

" }, "type":{ "shape":"TestType", "documentation":"

The suite's type.

Must be one of the following values:

  • BUILTIN_FUZZ: The built-in fuzz type.

  • BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

  • APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

  • APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

  • APPIUM_PYTHON: The Appium Python type.

  • APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

  • APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

  • APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

  • CALABASH: The Calabash type.

  • INSTRUMENTATION: The Instrumentation type.

  • UIAUTOMATION: The uiautomation type.

  • UIAUTOMATOR: The uiautomator type.

  • XCTEST: The XCode test type.

  • XCTEST_UI: The XCode UI test type.

" }, "created":{ "shape":"DateTime", "documentation":"

When the suite was created.

" }, "status":{ "shape":"ExecutionStatus", "documentation":"

The suite's status.

Allowed values include:

  • PENDING: A pending status.

  • PENDING_CONCURRENCY: A pending concurrency status.

  • PENDING_DEVICE: A pending device status.

  • PROCESSING: A processing status.

  • SCHEDULING: A scheduling status.

  • PREPARING: A preparing status.

  • RUNNING: A running status.

  • COMPLETED: A completed status.

  • STOPPING: A stopping status.

" }, "result":{ "shape":"ExecutionResult", "documentation":"

The suite's result.

Allowed values include:

  • PENDING: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

" }, "started":{ "shape":"DateTime", "documentation":"

The suite's start time.

" }, "stopped":{ "shape":"DateTime", "documentation":"

The suite's stop time.

" }, "counters":{ "shape":"Counters", "documentation":"

The suite's result counters.

" }, "message":{ "shape":"Message", "documentation":"

A message about the suite's result.

" }, "deviceMinutes":{ "shape":"DeviceMinutes", "documentation":"

Represents the total (metered or unmetered) minutes used by the test suite.

" } }, "documentation":"

Represents a collection of one or more tests.

" }, "Suites":{ "type":"list", "member":{"shape":"Suite"} }, "Test":{ "type":"structure", "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The test's ARN.

" }, "name":{ "shape":"Name", "documentation":"

The test's name.

" }, "type":{ "shape":"TestType", "documentation":"

The test's type.

Must be one of the following values:

  • BUILTIN_FUZZ: The built-in fuzz type.

  • BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

  • APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

  • APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

  • APPIUM_PYTHON: The Appium Python type.

  • APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

  • APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

  • APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

  • CALABASH: The Calabash type.

  • INSTRUMENTATION: The Instrumentation type.

  • UIAUTOMATION: The uiautomation type.

  • UIAUTOMATOR: The uiautomator type.

  • XCTEST: The XCode test type.

  • XCTEST_UI: The XCode UI test type.

" }, "created":{ "shape":"DateTime", "documentation":"

When the test was created.

" }, "status":{ "shape":"ExecutionStatus", "documentation":"

The test's status.

Allowed values include:

  • PENDING: A pending status.

  • PENDING_CONCURRENCY: A pending concurrency status.

  • PENDING_DEVICE: A pending device status.

  • PROCESSING: A processing status.

  • SCHEDULING: A scheduling status.

  • PREPARING: A preparing status.

  • RUNNING: A running status.

  • COMPLETED: A completed status.

  • STOPPING: A stopping status.

" }, "result":{ "shape":"ExecutionResult", "documentation":"

The test's result.

Allowed values include:

  • PENDING: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

" }, "started":{ "shape":"DateTime", "documentation":"

The test's start time.

" }, "stopped":{ "shape":"DateTime", "documentation":"

The test's stop time.

" }, "counters":{ "shape":"Counters", "documentation":"

The test's result counters.

" }, "message":{ "shape":"Message", "documentation":"

A message about the test's result.

" }, "deviceMinutes":{ "shape":"DeviceMinutes", "documentation":"

Represents the total (metered or unmetered) minutes used by the test.

" } }, "documentation":"

Represents a condition that is evaluated.

" }, "TestParameters":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "TestType":{ "type":"string", "enum":[ "BUILTIN_FUZZ", "BUILTIN_EXPLORER", "APPIUM_JAVA_JUNIT", "APPIUM_JAVA_TESTNG", "APPIUM_PYTHON", "APPIUM_WEB_JAVA_JUNIT", "APPIUM_WEB_JAVA_TESTNG", "APPIUM_WEB_PYTHON", "CALABASH", "INSTRUMENTATION", "UIAUTOMATION", "UIAUTOMATOR", "XCTEST", "XCTEST_UI" ] }, "Tests":{ "type":"list", "member":{"shape":"Test"} }, "TransactionIdentifier":{ "type":"string", "min":32 }, "URL":{ "type":"string", "max":2048, "min":0 }, "UniqueProblem":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

A message about the unique problems' result.

" }, "problems":{ "shape":"Problems", "documentation":"

Information about the problems.

" } }, "documentation":"

A collection of one or more problems, grouped by their result.

" }, "UniqueProblems":{ "type":"list", "member":{"shape":"UniqueProblem"} }, "UniqueProblemsByExecutionResultMap":{ "type":"map", "key":{"shape":"ExecutionResult"}, "value":{"shape":"UniqueProblems"} }, "UpdateDevicePoolRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.

" }, "name":{ "shape":"Name", "documentation":"

A string representing the name of the device pool you wish to update.

" }, "description":{ "shape":"Message", "documentation":"

A description of the device pool you wish to update.

" }, "rules":{ "shape":"Rules", "documentation":"

Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.

" } }, "documentation":"

Represents a request to the update device pool operation.

" }, "UpdateDevicePoolResult":{ "type":"structure", "members":{ "devicePool":{"shape":"DevicePool"} }, "documentation":"

Represents the result of an update device pool request.

" }, "UpdateProjectRequest":{ "type":"structure", "required":["arn"], "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the project whose name you wish to update.

" }, "name":{ "shape":"Name", "documentation":"

A string representing the new name of the project that you are updating.

" } }, "documentation":"

Represents a request to the update project operation.

" }, "UpdateProjectResult":{ "type":"structure", "members":{ "project":{"shape":"Project"} }, "documentation":"

Represents the result of an update project request.

" }, "Upload":{ "type":"structure", "members":{ "arn":{ "shape":"AmazonResourceName", "documentation":"

The upload's ARN.

" }, "name":{ "shape":"Name", "documentation":"

The upload's file name.

" }, "created":{ "shape":"DateTime", "documentation":"

When the upload was created.

" }, "type":{ "shape":"UploadType", "documentation":"

The upload's type.

Must be one of the following values:

  • ANDROID_APP: An Android upload.

  • IOS_APP: An iOS upload.

  • WEB_APP: A web appliction upload.

  • EXTERNAL_DATA: An external data upload.

  • APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.

  • APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.

  • APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.

  • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.

  • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.

  • APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.

  • CALABASH_TEST_PACKAGE: A Calabash test package upload.

  • INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.

  • UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.

  • UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.

  • XCTEST_TEST_PACKAGE: An XCode test package upload.

  • XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.

" }, "status":{ "shape":"UploadStatus", "documentation":"

The upload's status.

Must be one of the following values:

  • FAILED: A failed status.

  • INITIALIZED: An initialized status.

  • PROCESSING: A processing status.

  • SUCCEEDED: A succeeded status.

" }, "url":{ "shape":"URL", "documentation":"

The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request.

" }, "metadata":{ "shape":"Metadata", "documentation":"

The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.

" }, "contentType":{ "shape":"ContentType", "documentation":"

The upload's content type (for example, \"application/octet-stream\").

" }, "message":{ "shape":"Message", "documentation":"

A message about the upload's result.

" } }, "documentation":"

An app or a set of one or more tests to upload or that have been uploaded.

" }, "UploadStatus":{ "type":"string", "enum":[ "INITIALIZED", "PROCESSING", "SUCCEEDED", "FAILED" ] }, "UploadType":{ "type":"string", "enum":[ "ANDROID_APP", "IOS_APP", "WEB_APP", "EXTERNAL_DATA", "APPIUM_JAVA_JUNIT_TEST_PACKAGE", "APPIUM_JAVA_TESTNG_TEST_PACKAGE", "APPIUM_PYTHON_TEST_PACKAGE", "APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE", "APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE", "APPIUM_WEB_PYTHON_TEST_PACKAGE", "CALABASH_TEST_PACKAGE", "INSTRUMENTATION_TEST_PACKAGE", "UIAUTOMATION_TEST_PACKAGE", "UIAUTOMATOR_TEST_PACKAGE", "XCTEST_TEST_PACKAGE", "XCTEST_UI_TEST_PACKAGE" ] }, "Uploads":{ "type":"list", "member":{"shape":"Upload"} } }, "documentation":"

AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud.

" } botocore-1.5.7/botocore/data/machinelearning/0000777454262600001440000000000013042511307022257 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/machinelearning/2014-12-12/0000777454262600001440000000000013042511307023305 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/machinelearning/2014-12-12/waiters-2.json0000666454262600001440000000355613042511306026025 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DataSourceAvailable": { "delay": 30, "operation": "DescribeDataSources", "maxAttempts": 60, "acceptors": [ { "expected": "COMPLETED", "matcher": "pathAll", "state": "success", "argument": "Results[].Status" }, { "expected": "FAILED", "matcher": "pathAny", "state": "failure", "argument": "Results[].Status" } ] }, "MLModelAvailable": { "delay": 30, "operation": "DescribeMLModels", "maxAttempts": 60, "acceptors": [ { "expected": "COMPLETED", "matcher": "pathAll", "state": "success", "argument": "Results[].Status" }, { "expected": "FAILED", "matcher": "pathAny", "state": "failure", "argument": "Results[].Status" } ] }, "EvaluationAvailable": { "delay": 30, "operation": "DescribeEvaluations", "maxAttempts": 60, "acceptors": [ { "expected": "COMPLETED", "matcher": "pathAll", "state": "success", "argument": "Results[].Status" }, { "expected": "FAILED", "matcher": "pathAny", "state": "failure", "argument": "Results[].Status" } ] }, "BatchPredictionAvailable": { "delay": 30, "operation": "DescribeBatchPredictions", "maxAttempts": 60, "acceptors": [ { "expected": "COMPLETED", "matcher": "pathAll", "state": "success", "argument": "Results[].Status" }, { "expected": "FAILED", "matcher": "pathAny", "state": "failure", "argument": "Results[].Status" } ] } } } botocore-1.5.7/botocore/data/machinelearning/2014-12-12/paginators-1.json0000666454262600001440000000124713042511306026510 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeBatchPredictions": { "limit_key": "Limit", "output_token": "NextToken", "input_token": "NextToken", "result_key": "Results" }, "DescribeDataSources": { "limit_key": "Limit", "output_token": "NextToken", "input_token": "NextToken", "result_key": "Results" }, "DescribeEvaluations": { "limit_key": "Limit", "output_token": "NextToken", "input_token": "NextToken", "result_key": "Results" }, "DescribeMLModels": { "limit_key": "Limit", "output_token": "NextToken", "input_token": "NextToken", "result_key": "Results" } } } botocore-1.5.7/botocore/data/machinelearning/2014-12-12/service-2.json0000666454262600001440000060147613042511306026014 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"machinelearning-2014-12-12", "apiVersion":"2014-12-12", "endpointPrefix":"machinelearning", "jsonVersion":"1.1", "serviceFullName":"Amazon Machine Learning", "signatureVersion":"v4", "targetPrefix":"AmazonML_20141212", "protocol":"json" }, "documentation":"Definition of the public APIs exposed by Amazon Machine Learning", "operations":{ "AddTags":{ "name":"AddTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsInput"}, "output":{ "shape":"AddTagsOutput", "documentation":"

Amazon ML returns the following elements.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"InvalidTagException", "exception":true }, { "shape":"TagLimitExceededException", "exception":true }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Adds one or more tags to an object, up to a limit of 10. Each tag consists of a key and an optional value. If you add a tag using a key that is already associated with the ML object, AddTags updates the tag's value.

" }, "CreateBatchPrediction":{ "name":"CreateBatchPrediction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateBatchPredictionInput"}, "output":{ "shape":"CreateBatchPredictionOutput", "documentation":"

Represents the output of a CreateBatchPrediction operation, and is an acknowledgement that Amazon ML received the request.

The CreateBatchPrediction operation is asynchronous. You can poll for status updates by using the >GetBatchPrediction operation and checking the Status parameter of the result.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" }, { "shape":"IdempotentParameterMismatchException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.

" } ], "documentation":"

Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a DataSource. This operation creates a new BatchPrediction, and uses an MLModel and the data files referenced by the DataSource as information sources.

CreateBatchPrediction is an asynchronous operation. In response to CreateBatchPrediction, Amazon Machine Learning (Amazon ML) immediately returns and sets the BatchPrediction status to PENDING. After the BatchPrediction completes, Amazon ML sets the status to COMPLETED.

You can poll for status updates by using the GetBatchPrediction operation and checking the Status parameter of the result. After the COMPLETED status appears, the results are available in the location specified by the OutputUri parameter.

" }, "CreateDataSourceFromRDS":{ "name":"CreateDataSourceFromRDS", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDataSourceFromRDSInput"}, "output":{ "shape":"CreateDataSourceFromRDSOutput", "documentation":"

Represents the output of a CreateDataSourceFromRDS operation, and is an acknowledgement that Amazon ML received the request.

The CreateDataSourceFromRDS> operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter. You can inspect the Message when Status shows up as FAILED. You can also check the progress of the copy operation by going to the DataPipeline console and looking up the pipeline using the pipelineId from the describe call.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" }, { "shape":"IdempotentParameterMismatchException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.

" } ], "documentation":"

Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS). A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

CreateDataSourceFromRDS is an asynchronous operation. In response to CreateDataSourceFromRDS, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used only to perform >CreateMLModel>, CreateEvaluation, or CreateBatchPrediction operations.

If Amazon ML cannot accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.

" }, "CreateDataSourceFromRedshift":{ "name":"CreateDataSourceFromRedshift", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDataSourceFromRedshiftInput"}, "output":{ "shape":"CreateDataSourceFromRedshiftOutput", "documentation":"

Represents the output of a CreateDataSourceFromRedshift operation, and is an acknowledgement that Amazon ML received the request.

The CreateDataSourceFromRedshift operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" }, { "shape":"IdempotentParameterMismatchException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.

" } ], "documentation":"

Creates a DataSource from a database hosted on an Amazon Redshift cluster. A DataSource references data that can be used to perform either CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

CreateDataSourceFromRedshift is an asynchronous operation. In response to CreateDataSourceFromRedshift, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in COMPLETED or PENDING states can be used to perform only CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.

The observations should be contained in the database hosted on an Amazon Redshift cluster and should be specified by a SelectSqlQuery query. Amazon ML executes an Unload command in Amazon Redshift to transfer the result set of the SelectSqlQuery query to S3StagingLocation.

After the DataSource has been created, it's ready for use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also requires a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions.

You can't change an existing datasource, but you can copy and modify the settings from an existing Amazon Redshift datasource to create a new datasource. To do so, call GetDataSource for an existing datasource and copy the values to a CreateDataSource call. Change the settings that you want to change and make sure that all required fields have the appropriate values.

" }, "CreateDataSourceFromS3":{ "name":"CreateDataSourceFromS3", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDataSourceFromS3Input"}, "output":{ "shape":"CreateDataSourceFromS3Output", "documentation":"

Represents the output of a CreateDataSourceFromS3 operation, and is an acknowledgement that Amazon ML received the request.

The CreateDataSourceFromS3 operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" }, { "shape":"IdempotentParameterMismatchException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.

" } ], "documentation":"

Creates a DataSource object. A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

CreateDataSourceFromS3 is an asynchronous operation. In response to CreateDataSourceFromS3, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource has been created and is ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used to perform only CreateMLModel, CreateEvaluation or CreateBatchPrediction operations.

If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.

The observation data used in a DataSource should be ready to use; that is, it should have a consistent structure, and missing data values should be kept to a minimum. The observation data must reside in one or more .csv files in an Amazon Simple Storage Service (Amazon S3) location, along with a schema that describes the data items by name and type. The same schema must be used for all of the data files referenced by the DataSource.

After the DataSource has been created, it's ready to use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also needs a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions.

" }, "CreateEvaluation":{ "name":"CreateEvaluation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateEvaluationInput"}, "output":{ "shape":"CreateEvaluationOutput", "documentation":"

Represents the output of a CreateEvaluation operation, and is an acknowledgement that Amazon ML received the request.

CreateEvaluation operation is asynchronous. You can poll for status updates by using the GetEvcaluation operation and checking the Status parameter.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" }, { "shape":"IdempotentParameterMismatchException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.

" } ], "documentation":"

Creates a new Evaluation of an MLModel. An MLModel is evaluated on a set of observations associated to a DataSource. Like a DataSource for an MLModel, the DataSource for an Evaluation contains values for the Target Variable. The Evaluation compares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective the MLModel functions on the test data. Evaluation generates a relevant performance metric, such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the corresponding MLModelType: BINARY, REGRESSION or MULTICLASS.

CreateEvaluation is an asynchronous operation. In response to CreateEvaluation, Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status to PENDING. After the Evaluation is created and ready for use, Amazon ML sets the status to COMPLETED.

You can use the GetEvaluation operation to check progress of the evaluation during the creation operation.

" }, "CreateMLModel":{ "name":"CreateMLModel", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateMLModelInput"}, "output":{ "shape":"CreateMLModelOutput", "documentation":"

Represents the output of a CreateMLModel operation, and is an acknowledgement that Amazon ML received the request.

The CreateMLModel operation is asynchronous. You can poll for status updates by using the GetMLModel operation and checking the Status parameter.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" }, { "shape":"IdempotentParameterMismatchException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.

" } ], "documentation":"

Creates a new MLModel using the DataSource and the recipe as information sources.

An MLModel is nearly immutable. Users can update only the MLModelName and the ScoreThreshold in an MLModel without creating a new MLModel.

CreateMLModel is an asynchronous operation. In response to CreateMLModel, Amazon Machine Learning (Amazon ML) immediately returns and sets the MLModel status to PENDING. After the MLModel has been created and ready is for use, Amazon ML sets the status to COMPLETED.

You can use the GetMLModel operation to check the progress of the MLModel during the creation operation.

CreateMLModel requires a DataSource with computed statistics, which can be created by setting ComputeStatistics to true in CreateDataSourceFromRDS, CreateDataSourceFromS3, or CreateDataSourceFromRedshift operations.

" }, "CreateRealtimeEndpoint":{ "name":"CreateRealtimeEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRealtimeEndpointInput"}, "output":{ "shape":"CreateRealtimeEndpointOutput", "documentation":"

Represents the output of an CreateRealtimeEndpoint operation.

The result contains the MLModelId and the endpoint information for the MLModel.

The endpoint information includes the URI of the MLModel; that is, the location to send online prediction requests for the specified MLModel.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Creates a real-time endpoint for the MLModel. The endpoint contains the URI of the MLModel; that is, the location to send real-time prediction requests for the specified MLModel.

" }, "DeleteBatchPrediction":{ "name":"DeleteBatchPrediction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteBatchPredictionInput"}, "output":{ "shape":"DeleteBatchPredictionOutput", "documentation":"

Represents the output of a DeleteBatchPrediction operation.

You can use the GetBatchPrediction operation and check the value of the Status parameter to see whether a BatchPrediction is marked as DELETED.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Assigns the DELETED status to a BatchPrediction, rendering it unusable.

After using the DeleteBatchPrediction operation, you can use the GetBatchPrediction operation to verify that the status of the BatchPrediction changed to DELETED.

Caution: The result of the DeleteBatchPrediction operation is irreversible.

" }, "DeleteDataSource":{ "name":"DeleteDataSource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDataSourceInput"}, "output":{ "shape":"DeleteDataSourceOutput", "documentation":"

Represents the output of a DeleteDataSource operation.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Assigns the DELETED status to a DataSource, rendering it unusable.

After using the DeleteDataSource operation, you can use the GetDataSource operation to verify that the status of the DataSource changed to DELETED.

Caution: The results of the DeleteDataSource operation are irreversible.

" }, "DeleteEvaluation":{ "name":"DeleteEvaluation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteEvaluationInput"}, "output":{ "shape":"DeleteEvaluationOutput", "documentation":"

Represents the output of a DeleteEvaluation operation. The output indicates that Amazon Machine Learning (Amazon ML) received the request.

You can use the GetEvaluation operation and check the value of the Status parameter to see whether an Evaluation is marked as DELETED.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Assigns the DELETED status to an Evaluation, rendering it unusable.

After invoking the DeleteEvaluation operation, you can use the GetEvaluation operation to verify that the status of the Evaluation changed to DELETED.

Caution

The results of the DeleteEvaluation operation are irreversible.

" }, "DeleteMLModel":{ "name":"DeleteMLModel", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteMLModelInput"}, "output":{ "shape":"DeleteMLModelOutput", "documentation":"

Represents the output of a DeleteMLModel operation.

You can use the GetMLModel operation and check the value of the Status parameter to see whether an MLModel is marked as DELETED.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Assigns the DELETED status to an MLModel, rendering it unusable.

After using the DeleteMLModel operation, you can use the GetMLModel operation to verify that the status of the MLModel changed to DELETED.

Caution: The result of the DeleteMLModel operation is irreversible.

" }, "DeleteRealtimeEndpoint":{ "name":"DeleteRealtimeEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRealtimeEndpointInput"}, "output":{ "shape":"DeleteRealtimeEndpointOutput", "documentation":"

Represents the output of an DeleteRealtimeEndpoint operation.

The result contains the MLModelId and the endpoint information for the MLModel.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Deletes a real time endpoint of an MLModel.

" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsInput"}, "output":{ "shape":"DeleteTagsOutput", "documentation":"

Amazon ML returns the following elements.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"InvalidTagException", "exception":true }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Deletes the specified tags associated with an ML object. After this operation is complete, you can't recover deleted tags.

If you specify a tag that doesn't exist, Amazon ML ignores it.

" }, "DescribeBatchPredictions":{ "name":"DescribeBatchPredictions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeBatchPredictionsInput"}, "output":{ "shape":"DescribeBatchPredictionsOutput", "documentation":"

Represents the output of a DescribeBatchPredictions operation. The content is essentially a list of BatchPredictions.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Returns a list of BatchPrediction operations that match the search criteria in the request.

" }, "DescribeDataSources":{ "name":"DescribeDataSources", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDataSourcesInput"}, "output":{ "shape":"DescribeDataSourcesOutput", "documentation":"

Represents the query results from a DescribeDataSources operation. The content is essentially a list of DataSource.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Returns a list of DataSource that match the search criteria in the request.

" }, "DescribeEvaluations":{ "name":"DescribeEvaluations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEvaluationsInput"}, "output":{ "shape":"DescribeEvaluationsOutput", "documentation":"

Represents the query results from a DescribeEvaluations operation. The content is essentially a list of Evaluation.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Returns a list of DescribeEvaluations that match the search criteria in the request.

" }, "DescribeMLModels":{ "name":"DescribeMLModels", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMLModelsInput"}, "output":{ "shape":"DescribeMLModelsOutput", "documentation":"

Represents the output of a DescribeMLModels operation. The content is essentially a list of MLModel.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Returns a list of MLModel that match the search criteria in the request.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsInput"}, "output":{ "shape":"DescribeTagsOutput", "documentation":"

Amazon ML returns the following elements.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Describes one or more of the tags for your Amazon ML object.

" }, "GetBatchPrediction":{ "name":"GetBatchPrediction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetBatchPredictionInput"}, "output":{ "shape":"GetBatchPredictionOutput", "documentation":"

Represents the output of a GetBatchPrediction operation and describes a BatchPrediction.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Returns a BatchPrediction that includes detailed metadata, status, and data file information for a Batch Prediction request.

" }, "GetDataSource":{ "name":"GetDataSource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDataSourceInput"}, "output":{ "shape":"GetDataSourceOutput", "documentation":"

Represents the output of a GetDataSource operation and describes a DataSource.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Returns a DataSource that includes metadata and data file information, as well as the current status of the DataSource.

GetDataSource provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format.

" }, "GetEvaluation":{ "name":"GetEvaluation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetEvaluationInput"}, "output":{ "shape":"GetEvaluationOutput", "documentation":"

Represents the output of a GetEvaluation operation and describes an Evaluation.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Returns an Evaluation that includes metadata as well as the current status of the Evaluation.

" }, "GetMLModel":{ "name":"GetMLModel", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetMLModelInput"}, "output":{ "shape":"GetMLModelOutput", "documentation":"

Represents the output of a GetMLModel operation, and provides detailed information about a MLModel.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Returns an MLModel that includes detailed metadata, data source information, and the current status of the MLModel.

GetMLModel provides results in normal or verbose format.

" }, "Predict":{ "name":"Predict", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PredictInput"}, "output":{"shape":"PredictOutput"}, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"LimitExceededException", "error":{"httpStatusCode":417}, "exception":true, "documentation":"

The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as DataSource.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" }, { "shape":"PredictorNotMountedException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The exception is thrown when a predict request is made to an unmounted MLModel.

" } ], "documentation":"

Generates a prediction for the observation using the specified ML Model.

Note

Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested.

" }, "UpdateBatchPrediction":{ "name":"UpdateBatchPrediction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateBatchPredictionInput"}, "output":{ "shape":"UpdateBatchPredictionOutput", "documentation":"

Represents the output of an UpdateBatchPrediction operation.

You can see the updated content by using the GetBatchPrediction operation.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Updates the BatchPredictionName of a BatchPrediction.

You can use the GetBatchPrediction operation to view the contents of the updated data element.

" }, "UpdateDataSource":{ "name":"UpdateDataSource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDataSourceInput"}, "output":{ "shape":"UpdateDataSourceOutput", "documentation":"

Represents the output of an UpdateDataSource operation.

You can see the updated content by using the GetBatchPrediction operation.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Updates the DataSourceName of a DataSource.

You can use the GetDataSource operation to view the contents of the updated data element.

" }, "UpdateEvaluation":{ "name":"UpdateEvaluation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateEvaluationInput"}, "output":{ "shape":"UpdateEvaluationOutput", "documentation":"

Represents the output of an UpdateEvaluation operation.

You can see the updated content by using the GetEvaluation operation.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Updates the EvaluationName of an Evaluation.

You can use the GetEvaluation operation to view the contents of the updated data element.

" }, "UpdateMLModel":{ "name":"UpdateMLModel", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateMLModelInput"}, "output":{ "shape":"UpdateMLModelOutput", "documentation":"

Represents the output of an UpdateMLModel operation.

You can see the updated content by using the GetMLModel operation.

" }, "errors":[ { "shape":"InvalidInputException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, { "shape":"InternalServerException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" } ], "documentation":"

Updates the MLModelName and the ScoreThreshold of an MLModel.

You can use the GetMLModel operation to view the contents of the updated data element.

" } }, "shapes":{ "AddTagsInput":{ "type":"structure", "required":[ "Tags", "ResourceId", "ResourceType" ], "members":{ "Tags":{ "shape":"TagList", "documentation":"

The key-value pairs to use to create tags. If you specify a key without specifying a value, Amazon ML creates a tag with the specified key and a value of null.

" }, "ResourceId":{ "shape":"EntityId", "documentation":"

The ID of the ML object to tag. For example, exampleModelId.

" }, "ResourceType":{ "shape":"TaggableResourceType", "documentation":"

The type of the ML object to tag.

" } } }, "AddTagsOutput":{ "type":"structure", "members":{ "ResourceId":{ "shape":"EntityId", "documentation":"

The ID of the ML object that was tagged.

" }, "ResourceType":{ "shape":"TaggableResourceType", "documentation":"

The type of the ML object that was tagged.

" } }, "documentation":"

Amazon ML returns the following elements.

" }, "Algorithm":{ "type":"string", "enum":["sgd"], "documentation":"

The function used to train an MLModel. Training choices supported by Amazon ML include the following:

  • SGD - Stochastic Gradient Descent.
  • RandomForest - Random forest of decision trees.
" }, "AwsUserArn":{ "type":"string", "pattern":"arn:aws:iam::[0-9]+:((user/.+)|(root))", "documentation":"

An Amazon Web Service (AWS) user account identifier. The account identifier can be an AWS root account or an AWS Identity and Access Management (IAM) user.

" }, "BatchPrediction":{ "type":"structure", "members":{ "BatchPredictionId":{ "shape":"EntityId", "documentation":"

The ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.

" }, "MLModelId":{ "shape":"EntityId", "documentation":"

The ID of the MLModel that generated predictions for the BatchPrediction request.

" }, "BatchPredictionDataSourceId":{ "shape":"EntityId", "documentation":"

The ID of the DataSource that points to the group of observations to predict.

" }, "InputDataLocationS3":{ "shape":"S3Url", "documentation":"

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" }, "CreatedByIamUser":{ "shape":"AwsUserArn", "documentation":"

The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" }, "CreatedAt":{ "shape":"EpochTime", "documentation":"

The time that the BatchPrediction was created. The time is expressed in epoch time.

" }, "LastUpdatedAt":{ "shape":"EpochTime", "documentation":"

The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.

" }, "Name":{ "shape":"EntityName", "documentation":"

A user-supplied name or description of the BatchPrediction.

" }, "Status":{ "shape":"EntityStatus", "documentation":"

The status of the BatchPrediction. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations.
  • INPROGRESS - The process is underway.
  • FAILED - The request to perform a batch prediction did not run to completion. It is not usable.
  • COMPLETED - The batch prediction process completed successfully.
  • DELETED - The BatchPrediction is marked as deleted. It is not usable.
" }, "OutputUri":{ "shape":"S3Url", "documentation":"

The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

" }, "Message":{ "shape":"Message", "documentation":"

A description of the most recent details about processing the batch prediction request.

" }, "ComputeTime":{"shape":"LongType"}, "FinishedAt":{"shape":"EpochTime"}, "StartedAt":{"shape":"EpochTime"}, "TotalRecordCount":{"shape":"LongType"}, "InvalidRecordCount":{"shape":"LongType"} }, "documentation":"

Represents the output of a GetBatchPrediction operation.

The content consists of the detailed metadata, the status, and the data file information of a Batch Prediction.

" }, "BatchPredictionFilterVariable":{ "type":"string", "enum":[ "CreatedAt", "LastUpdatedAt", "Status", "Name", "IAMUser", "MLModelId", "DataSourceId", "DataURI" ], "documentation":"

A list of the variables to use in searching or filtering BatchPrediction.

  • CreatedAt - Sets the search criteria to BatchPrediction creation date.
  • Status - Sets the search criteria to BatchPrediction status.
  • Name - Sets the search criteria to the contents of BatchPrediction Name.
  • IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
  • MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
  • DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
  • DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
" }, "BatchPredictions":{ "type":"list", "member":{"shape":"BatchPrediction"} }, "ComparatorValue":{ "type":"string", "max":1024, "pattern":".*\\S.*|^$", "documentation":"

The value specified in a filtering condition. The ComparatorValue becomes the reference value when matching or evaluating data values in filtering and searching functions.

" }, "ComputeStatistics":{"type":"boolean"}, "CreateBatchPredictionInput":{ "type":"structure", "required":[ "BatchPredictionId", "MLModelId", "BatchPredictionDataSourceId", "OutputUri" ], "members":{ "BatchPredictionId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the BatchPrediction.

" }, "BatchPredictionName":{ "shape":"EntityName", "documentation":"

A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.

" }, "MLModelId":{ "shape":"EntityId", "documentation":"

The ID of the MLModel that will generate predictions for the group of observations.

" }, "BatchPredictionDataSourceId":{ "shape":"EntityId", "documentation":"

The ID of the DataSource that points to the group of observations to predict.

" }, "OutputUri":{ "shape":"S3Url", "documentation":"

The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.

" } } }, "CreateBatchPredictionOutput":{ "type":"structure", "members":{ "BatchPredictionId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the BatchPrediction. This value is identical to the value of the BatchPredictionId in the request.

" } }, "documentation":"

Represents the output of a CreateBatchPrediction operation, and is an acknowledgement that Amazon ML received the request.

The CreateBatchPrediction operation is asynchronous. You can poll for status updates by using the >GetBatchPrediction operation and checking the Status parameter of the result.

" }, "CreateDataSourceFromRDSInput":{ "type":"structure", "required":[ "DataSourceId", "RDSData", "RoleARN" ], "members":{ "DataSourceId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the DataSource. Typically, an Amazon Resource Number (ARN) becomes the ID for a DataSource.

" }, "DataSourceName":{ "shape":"EntityName", "documentation":"

A user-supplied name or description of the DataSource.

" }, "RDSData":{ "shape":"RDSDataSpec", "documentation":"

The data specification of an Amazon RDS DataSource:

  • DatabaseInformation -

    • DatabaseName - The name of the Amazon RDS database.
    • InstanceIdentifier - A unique identifier for the Amazon RDS database instance.

  • DatabaseCredentials - AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon RDS database.

  • ResourceRole - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the copy task from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more information, see Role templates for data pipelines.

  • ServiceRole - A role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

  • SecurityInfo - The security information to use to access an RDS DB instance. You need to set up appropriate ingress rules for the security entity IDs provided to allow access to the Amazon RDS instance. Specify a [SubnetId, SecurityGroupIds] pair for a VPC-based RDS DB instance.

  • SelectSqlQuery - A query that is used to retrieve the observation data for the Datasource.

  • S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

  • DataSchemaUri - The Amazon S3 location of the DataSchema.

  • DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.

  • DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource.


    Sample - \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

The role that Amazon ML assumes on behalf of the user to create and activate a data pipeline in the user's account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3.

" }, "ComputeStatistics":{ "shape":"ComputeStatistics", "documentation":"

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

" } } }, "CreateDataSourceFromRDSOutput":{ "type":"structure", "members":{ "DataSourceId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the DataSourceID in the request.

" } }, "documentation":"

Represents the output of a CreateDataSourceFromRDS operation, and is an acknowledgement that Amazon ML received the request.

The CreateDataSourceFromRDS> operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter. You can inspect the Message when Status shows up as FAILED. You can also check the progress of the copy operation by going to the DataPipeline console and looking up the pipeline using the pipelineId from the describe call.

" }, "CreateDataSourceFromRedshiftInput":{ "type":"structure", "required":[ "DataSourceId", "DataSpec", "RoleARN" ], "members":{ "DataSourceId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the DataSource.

" }, "DataSourceName":{ "shape":"EntityName", "documentation":"

A user-supplied name or description of the DataSource.

" }, "DataSpec":{ "shape":"RedshiftDataSpec", "documentation":"

The data specification of an Amazon Redshift DataSource:

  • DatabaseInformation -

    • DatabaseName - The name of the Amazon Redshift database.
    • ClusterIdentifier - The unique ID for the Amazon Redshift cluster.

  • DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.

  • SelectSqlQuery - The query that is used to retrieve the observation data for the Datasource.

  • S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the SelectSqlQuery query is stored in this location.

  • DataSchemaUri - The Amazon S3 location of the DataSchema.

  • DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.

  • DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the DataSource.

    Sample - \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

  • A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster

  • An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation

" }, "ComputeStatistics":{ "shape":"ComputeStatistics", "documentation":"

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

" } } }, "CreateDataSourceFromRedshiftOutput":{ "type":"structure", "members":{ "DataSourceId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the DataSourceID in the request.

" } }, "documentation":"

Represents the output of a CreateDataSourceFromRedshift operation, and is an acknowledgement that Amazon ML received the request.

The CreateDataSourceFromRedshift operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter.

" }, "CreateDataSourceFromS3Input":{ "type":"structure", "required":[ "DataSourceId", "DataSpec" ], "members":{ "DataSourceId":{ "shape":"EntityId", "documentation":"

A user-supplied identifier that uniquely identifies the DataSource.

" }, "DataSourceName":{ "shape":"EntityName", "documentation":"

A user-supplied name or description of the DataSource.

" }, "DataSpec":{ "shape":"S3DataSpec", "documentation":"

The data specification of a DataSource:

  • DataLocationS3 - The Amazon S3 location of the observation data.

  • DataSchemaLocationS3 - The Amazon S3 location of the DataSchema.

  • DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.

  • DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource.

    Sample - \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"

" }, "ComputeStatistics":{ "shape":"ComputeStatistics", "documentation":"

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

" } } }, "CreateDataSourceFromS3Output":{ "type":"structure", "members":{ "DataSourceId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the DataSource. This value should be identical to the value of the DataSourceID in the request.

" } }, "documentation":"

Represents the output of a CreateDataSourceFromS3 operation, and is an acknowledgement that Amazon ML received the request.

The CreateDataSourceFromS3 operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter.

" }, "CreateEvaluationInput":{ "type":"structure", "required":[ "EvaluationId", "MLModelId", "EvaluationDataSourceId" ], "members":{ "EvaluationId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the Evaluation.

" }, "EvaluationName":{ "shape":"EntityName", "documentation":"

A user-supplied name or description of the Evaluation.

" }, "MLModelId":{ "shape":"EntityId", "documentation":"

The ID of the MLModel to evaluate.

The schema used in creating the MLModel must match the schema of the DataSource used in the Evaluation.

" }, "EvaluationDataSourceId":{ "shape":"EntityId", "documentation":"

The ID of the DataSource for the evaluation. The schema of the DataSource must match the schema used to create the MLModel.

" } } }, "CreateEvaluationOutput":{ "type":"structure", "members":{ "EvaluationId":{ "shape":"EntityId", "documentation":"

The user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the value of the EvaluationId in the request.

" } }, "documentation":"

Represents the output of a CreateEvaluation operation, and is an acknowledgement that Amazon ML received the request.

CreateEvaluation operation is asynchronous. You can poll for status updates by using the GetEvcaluation operation and checking the Status parameter.

" }, "CreateMLModelInput":{ "type":"structure", "required":[ "MLModelId", "MLModelType", "TrainingDataSourceId" ], "members":{ "MLModelId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the MLModel.

" }, "MLModelName":{ "shape":"EntityName", "documentation":"

A user-supplied name or description of the MLModel.

" }, "MLModelType":{ "shape":"MLModelType", "documentation":"

The category of supervised learning that this MLModel will address. Choose from the following types:

  • Choose REGRESSION if the MLModel will be used to predict a numeric value.
  • Choose BINARY if the MLModel result has two possible values.
  • Choose MULTICLASS if the MLModel result has a limited number of values.

For more information, see the Amazon Machine Learning Developer Guide.

" }, "Parameters":{ "shape":"TrainingParameters", "documentation":"

A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.

The following is the current set of training parameters:

  • sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.

    The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.

  • sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.

  • sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none. We strongly recommend that you shuffle your data.

  • sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.

  • sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.

" }, "TrainingDataSourceId":{ "shape":"EntityId", "documentation":"

The DataSource that points to the training data.

" }, "Recipe":{ "shape":"Recipe", "documentation":"

The data recipe for creating the MLModel. You must specify either the recipe or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.

" }, "RecipeUri":{ "shape":"S3Url", "documentation":"

The Amazon Simple Storage Service (Amazon S3) location and file name that contains the MLModel recipe. You must specify either the recipe or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.

" } } }, "CreateMLModelOutput":{ "type":"structure", "members":{ "MLModelId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelId in the request.

" } }, "documentation":"

Represents the output of a CreateMLModel operation, and is an acknowledgement that Amazon ML received the request.

The CreateMLModel operation is asynchronous. You can poll for status updates by using the GetMLModel operation and checking the Status parameter.

" }, "CreateRealtimeEndpointInput":{ "type":"structure", "required":["MLModelId"], "members":{ "MLModelId":{ "shape":"EntityId", "documentation":"

The ID assigned to the MLModel during creation.

" } } }, "CreateRealtimeEndpointOutput":{ "type":"structure", "members":{ "MLModelId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelId in the request.

" }, "RealtimeEndpointInfo":{ "shape":"RealtimeEndpointInfo", "documentation":"

The endpoint information of the MLModel

" } }, "documentation":"

Represents the output of an CreateRealtimeEndpoint operation.

The result contains the MLModelId and the endpoint information for the MLModel.

The endpoint information includes the URI of the MLModel; that is, the location to send online prediction requests for the specified MLModel.

" }, "DataRearrangement":{"type":"string"}, "DataSchema":{ "type":"string", "max":131071, "documentation":"

The schema of a DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource. The DataSource schema is expressed in JSON format.

DataSchema is not required if you specify a DataSchemaUri

{ \"version\": \"1.0\", \"recordAnnotationFieldName\": \"F1\", \"recordWeightFieldName\": \"F2\", \"targetFieldName\": \"F3\", \"dataFormat\": \"CSV\", \"dataFileContainsHeader\": true, \"variables\": [ { \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ], \"excludedVariableNames\": [ \"F6\" ] }

" }, "DataSource":{ "type":"structure", "members":{ "DataSourceId":{ "shape":"EntityId", "documentation":"

The ID that is assigned to the DataSource during creation.

" }, "DataLocationS3":{ "shape":"S3Url", "documentation":"

The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by a DataSource.

" }, "DataRearrangement":{ "shape":"DataRearrangement", "documentation":"

A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created.

" }, "CreatedByIamUser":{ "shape":"AwsUserArn", "documentation":"

The AWS user account from which the DataSource was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" }, "CreatedAt":{ "shape":"EpochTime", "documentation":"

The time that the DataSource was created. The time is expressed in epoch time.

" }, "LastUpdatedAt":{ "shape":"EpochTime", "documentation":"

The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.

" }, "DataSizeInBytes":{ "shape":"LongType", "documentation":"

The total number of observations contained in the data files that the DataSource references.

" }, "NumberOfFiles":{ "shape":"LongType", "documentation":"

The number of data files referenced by the DataSource.

" }, "Name":{ "shape":"EntityName", "documentation":"

A user-supplied name or description of the DataSource.

" }, "Status":{ "shape":"EntityStatus", "documentation":"

The current status of the DataSource. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create a DataSource.
  • INPROGRESS - The creation process is underway.
  • FAILED - The request to create a DataSource did not run to completion. It is not usable.
  • COMPLETED - The creation process completed successfully.
  • DELETED - The DataSource is marked as deleted. It is not usable.
" }, "Message":{ "shape":"Message", "documentation":"

A description of the most recent details about creating the DataSource.

" }, "RedshiftMetadata":{"shape":"RedshiftMetadata"}, "RDSMetadata":{"shape":"RDSMetadata"}, "RoleARN":{"shape":"RoleARN"}, "ComputeStatistics":{ "shape":"ComputeStatistics", "documentation":"

The parameter is true if statistics need to be generated from the observation data.

" }, "ComputeTime":{"shape":"LongType"}, "FinishedAt":{"shape":"EpochTime"}, "StartedAt":{"shape":"EpochTime"} }, "documentation":"

Represents the output of the GetDataSource operation.

The content consists of the detailed metadata and data file information and the current status of the DataSource.

" }, "DataSourceFilterVariable":{ "type":"string", "enum":[ "CreatedAt", "LastUpdatedAt", "Status", "Name", "DataLocationS3", "IAMUser" ], "documentation":"

A list of the variables to use in searching or filtering DataSource.

  • CreatedAt - Sets the search criteria to DataSource creation date.
  • Status - Sets the search criteria to DataSource status.
  • Name - Sets the search criteria to the contents of DataSource Name.
  • DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
  • IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.
Note

The variable names should match the variable names in the DataSource.

" }, "DataSources":{ "type":"list", "member":{"shape":"DataSource"} }, "DeleteBatchPredictionInput":{ "type":"structure", "required":["BatchPredictionId"], "members":{ "BatchPredictionId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the BatchPrediction.

" } } }, "DeleteBatchPredictionOutput":{ "type":"structure", "members":{ "BatchPredictionId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the BatchPrediction. This value should be identical to the value of the BatchPredictionID in the request.

" } }, "documentation":"

Represents the output of a DeleteBatchPrediction operation.

You can use the GetBatchPrediction operation and check the value of the Status parameter to see whether a BatchPrediction is marked as DELETED.

" }, "DeleteDataSourceInput":{ "type":"structure", "required":["DataSourceId"], "members":{ "DataSourceId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the DataSource.

" } } }, "DeleteDataSourceOutput":{ "type":"structure", "members":{ "DataSourceId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the DataSource. This value should be identical to the value of the DataSourceID in the request.

" } }, "documentation":"

Represents the output of a DeleteDataSource operation.

" }, "DeleteEvaluationInput":{ "type":"structure", "required":["EvaluationId"], "members":{ "EvaluationId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the Evaluation to delete.

" } } }, "DeleteEvaluationOutput":{ "type":"structure", "members":{ "EvaluationId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the value of the EvaluationId in the request.

" } }, "documentation":"

Represents the output of a DeleteEvaluation operation. The output indicates that Amazon Machine Learning (Amazon ML) received the request.

You can use the GetEvaluation operation and check the value of the Status parameter to see whether an Evaluation is marked as DELETED.

" }, "DeleteMLModelInput":{ "type":"structure", "required":["MLModelId"], "members":{ "MLModelId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the MLModel.

" } } }, "DeleteMLModelOutput":{ "type":"structure", "members":{ "MLModelId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelID in the request.

" } }, "documentation":"

Represents the output of a DeleteMLModel operation.

You can use the GetMLModel operation and check the value of the Status parameter to see whether an MLModel is marked as DELETED.

" }, "DeleteRealtimeEndpointInput":{ "type":"structure", "required":["MLModelId"], "members":{ "MLModelId":{ "shape":"EntityId", "documentation":"

The ID assigned to the MLModel during creation.

" } } }, "DeleteRealtimeEndpointOutput":{ "type":"structure", "members":{ "MLModelId":{ "shape":"EntityId", "documentation":"

A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelId in the request.

" }, "RealtimeEndpointInfo":{ "shape":"RealtimeEndpointInfo", "documentation":"

The endpoint information of the MLModel

" } }, "documentation":"

Represents the output of an DeleteRealtimeEndpoint operation.

The result contains the MLModelId and the endpoint information for the MLModel.

" }, "DeleteTagsInput":{ "type":"structure", "required":[ "TagKeys", "ResourceId", "ResourceType" ], "members":{ "TagKeys":{ "shape":"TagKeyList", "documentation":"

One or more tags to delete.

" }, "ResourceId":{ "shape":"EntityId", "documentation":"

The ID of the tagged ML object. For example, exampleModelId.

" }, "ResourceType":{ "shape":"TaggableResourceType", "documentation":"

The type of the tagged ML object.

" } } }, "DeleteTagsOutput":{ "type":"structure", "members":{ "ResourceId":{ "shape":"EntityId", "documentation":"

The ID of the ML object from which tags were deleted.

" }, "ResourceType":{ "shape":"TaggableResourceType", "documentation":"

The type of the ML object from which tags were deleted.

" } }, "documentation":"

Amazon ML returns the following elements.

" }, "DescribeBatchPredictionsInput":{ "type":"structure", "members":{ "FilterVariable":{ "shape":"BatchPredictionFilterVariable", "documentation":"

Use one of the following variables to filter a list of BatchPrediction:

  • CreatedAt - Sets the search criteria to the BatchPrediction creation date.
  • Status - Sets the search criteria to the BatchPrediction status.
  • Name - Sets the search criteria to the contents of the BatchPrediction Name.
  • IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
  • MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
  • DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
  • DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
" }, "EQ":{ "shape":"ComparatorValue", "documentation":"

The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ.

" }, "GT":{ "shape":"ComparatorValue", "documentation":"

The greater than operator. The BatchPrediction results will have FilterVariable values that are greater than the value specified with GT.

" }, "LT":{ "shape":"ComparatorValue", "documentation":"

The less than operator. The BatchPrediction results will have FilterVariable values that are less than the value specified with LT.

" }, "GE":{ "shape":"ComparatorValue", "documentation":"

The greater than or equal to operator. The BatchPrediction results will have FilterVariable values that are greater than or equal to the value specified with GE.

" }, "LE":{ "shape":"ComparatorValue", "documentation":"

The less than or equal to operator. The BatchPrediction results will have FilterVariable values that are less than or equal to the value specified with LE.

" }, "NE":{ "shape":"ComparatorValue", "documentation":"

The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.

" }, "Prefix":{ "shape":"ComparatorValue", "documentation":"

A string that is found at the beginning of a variable, such as Name or Id.

For example, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select Name for the FilterVariable and any of the following strings for the Prefix:

  • 2014-09

  • 2014-09-09

  • 2014-09-09-Holiday

" }, "SortOrder":{ "shape":"SortOrder", "documentation":"

A two-value parameter that determines the sequence of the resulting list of MLModels.

  • asc - Arranges the list in ascending order (A-Z, 0-9).
  • dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

" }, "NextToken":{ "shape":"StringType", "documentation":"

An ID of the page in the paginated results.

" }, "Limit":{ "shape":"PageLimit", "documentation":"

The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

" } } }, "DescribeBatchPredictionsOutput":{ "type":"structure", "members":{ "Results":{ "shape":"BatchPredictions", "documentation":"

A list of BatchPrediction objects that meet the search criteria.

" }, "NextToken":{ "shape":"StringType", "documentation":"

The ID of the next page in the paginated results that indicates at least one more page follows.

" } }, "documentation":"

Represents the output of a DescribeBatchPredictions operation. The content is essentially a list of BatchPredictions.

" }, "DescribeDataSourcesInput":{ "type":"structure", "members":{ "FilterVariable":{ "shape":"DataSourceFilterVariable", "documentation":"

Use one of the following variables to filter a list of DataSource:

  • CreatedAt - Sets the search criteria to DataSource creation dates.
  • Status - Sets the search criteria to DataSource statuses.
  • Name - Sets the search criteria to the contents of DataSource Name.
  • DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
  • IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.
" }, "EQ":{ "shape":"ComparatorValue", "documentation":"

The equal to operator. The DataSource results will have FilterVariable values that exactly match the value specified with EQ.

" }, "GT":{ "shape":"ComparatorValue", "documentation":"

The greater than operator. The DataSource results will have FilterVariable values that are greater than the value specified with GT.

" }, "LT":{ "shape":"ComparatorValue", "documentation":"

The less than operator. The DataSource results will have FilterVariable values that are less than the value specified with LT.

" }, "GE":{ "shape":"ComparatorValue", "documentation":"

The greater than or equal to operator. The DataSource results will have FilterVariable values that are greater than or equal to the value specified with GE.

" }, "LE":{ "shape":"ComparatorValue", "documentation":"

The less than or equal to operator. The DataSource results will have FilterVariable values that are less than or equal to the value specified with LE.

" }, "NE":{ "shape":"ComparatorValue", "documentation":"

The not equal to operator. The DataSource results will have FilterVariable values not equal to the value specified with NE.

" }, "Prefix":{ "shape":"ComparatorValue", "documentation":"

A string that is found at the beginning of a variable, such as Name or Id.

For example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer. To search for this DataSource, select Name for the FilterVariable and any of the following strings for the Prefix:

  • 2014-09

  • 2014-09-09

  • 2014-09-09-Holiday

" }, "SortOrder":{ "shape":"SortOrder", "documentation":"

A two-value parameter that determines the sequence of the resulting list of DataSource.

  • asc - Arranges the list in ascending order (A-Z, 0-9).
  • dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

" }, "NextToken":{ "shape":"StringType", "documentation":"

The ID of the page in the paginated results.

" }, "Limit":{ "shape":"PageLimit", "documentation":"

The maximum number of DataSource to include in the result.

" } } }, "DescribeDataSourcesOutput":{ "type":"structure", "members":{ "Results":{ "shape":"DataSources", "documentation":"

A list of DataSource that meet the search criteria.

" }, "NextToken":{ "shape":"StringType", "documentation":"

An ID of the next page in the paginated results that indicates at least one more page follows.

" } }, "documentation":"

Represents the query results from a DescribeDataSources operation. The content is essentially a list of DataSource.

" }, "DescribeEvaluationsInput":{ "type":"structure", "members":{ "FilterVariable":{ "shape":"EvaluationFilterVariable", "documentation":"

Use one of the following variable to filter a list of Evaluation objects:

  • CreatedAt - Sets the search criteria to the Evaluation creation date.
  • Status - Sets the search criteria to the Evaluation status.
  • Name - Sets the search criteria to the contents of Evaluation Name.
  • IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
  • MLModelId - Sets the search criteria to the MLModel that was evaluated.
  • DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
  • DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
" }, "EQ":{ "shape":"ComparatorValue", "documentation":"

The equal to operator. The Evaluation results will have FilterVariable values that exactly match the value specified with EQ.

" }, "GT":{ "shape":"ComparatorValue", "documentation":"

The greater than operator. The Evaluation results will have FilterVariable values that are greater than the value specified with GT.

" }, "LT":{ "shape":"ComparatorValue", "documentation":"

The less than operator. The Evaluation results will have FilterVariable values that are less than the value specified with LT.

" }, "GE":{ "shape":"ComparatorValue", "documentation":"

The greater than or equal to operator. The Evaluation results will have FilterVariable values that are greater than or equal to the value specified with GE.

" }, "LE":{ "shape":"ComparatorValue", "documentation":"

The less than or equal to operator. The Evaluation results will have FilterVariable values that are less than or equal to the value specified with LE.

" }, "NE":{ "shape":"ComparatorValue", "documentation":"

The not equal to operator. The Evaluation results will have FilterVariable values not equal to the value specified with NE.

" }, "Prefix":{ "shape":"ComparatorValue", "documentation":"

A string that is found at the beginning of a variable, such as Name or Id.

For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name for the FilterVariable and any of the following strings for the Prefix:

  • 2014-09

  • 2014-09-09

  • 2014-09-09-Holiday

" }, "SortOrder":{ "shape":"SortOrder", "documentation":"

A two-value parameter that determines the sequence of the resulting list of Evaluation.

  • asc - Arranges the list in ascending order (A-Z, 0-9).
  • dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

" }, "NextToken":{ "shape":"StringType", "documentation":"

The ID of the page in the paginated results.

" }, "Limit":{ "shape":"PageLimit", "documentation":"

The maximum number of Evaluation to include in the result.

" } } }, "DescribeEvaluationsOutput":{ "type":"structure", "members":{ "Results":{ "shape":"Evaluations", "documentation":"

A list of Evaluation that meet the search criteria.

" }, "NextToken":{ "shape":"StringType", "documentation":"

The ID of the next page in the paginated results that indicates at least one more page follows.

" } }, "documentation":"

Represents the query results from a DescribeEvaluations operation. The content is essentially a list of Evaluation.

" }, "DescribeMLModelsInput":{ "type":"structure", "members":{ "FilterVariable":{ "shape":"MLModelFilterVariable", "documentation":"

Use one of the following variables to filter a list of MLModel:

  • CreatedAt - Sets the search criteria to MLModel creation date.
  • Status - Sets the search criteria to MLModel status.
  • Name - Sets the search criteria to the contents of MLModel Name.
  • IAMUser - Sets the search criteria to the user account that invoked the MLModel creation.
  • TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel.
  • RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status.
  • MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class.
  • Algorithm - Sets the search criteria to the algorithm that the MLModel uses.
  • TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
" }, "EQ":{ "shape":"ComparatorValue", "documentation":"

The equal to operator. The MLModel results will have FilterVariable values that exactly match the value specified with EQ.

" }, "GT":{ "shape":"ComparatorValue", "documentation":"

The greater than operator. The MLModel results will have FilterVariable values that are greater than the value specified with GT.

" }, "LT":{ "shape":"ComparatorValue", "documentation":"

The less than operator. The MLModel results will have FilterVariable values that are less than the value specified with LT.

" }, "GE":{ "shape":"ComparatorValue", "documentation":"

The greater than or equal to operator. The MLModel results will have FilterVariable values that are greater than or equal to the value specified with GE.

" }, "LE":{ "shape":"ComparatorValue", "documentation":"

The less than or equal to operator. The MLModel results will have FilterVariable values that are less than or equal to the value specified with LE.

" }, "NE":{ "shape":"ComparatorValue", "documentation":"

The not equal to operator. The MLModel results will have FilterVariable values not equal to the value specified with NE.

" }, "Prefix":{ "shape":"ComparatorValue", "documentation":"

A string that is found at the beginning of a variable, such as Name or Id.

For example, an MLModel could have the Name 2014-09-09-HolidayGiftMailer. To search for this MLModel, select Name for the FilterVariable and any of the following strings for the Prefix:

  • 2014-09

  • 2014-09-09

  • 2014-09-09-Holiday

" }, "SortOrder":{ "shape":"SortOrder", "documentation":"

A two-value parameter that determines the sequence of the resulting list of MLModel.

  • asc - Arranges the list in ascending order (A-Z, 0-9).
  • dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

" }, "NextToken":{ "shape":"StringType", "documentation":"

The ID of the page in the paginated results.

" }, "Limit":{ "shape":"PageLimit", "documentation":"

The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

" } } }, "DescribeMLModelsOutput":{ "type":"structure", "members":{ "Results":{ "shape":"MLModels", "documentation":"

A list of MLModel that meet the search criteria.

" }, "NextToken":{ "shape":"StringType", "documentation":"

The ID of the next page in the paginated results that indicates at least one more page follows.

" } }, "documentation":"

Represents the output of a DescribeMLModels operation. The content is essentially a list of MLModel.

" }, "DescribeTagsInput":{ "type":"structure", "required":[ "ResourceId", "ResourceType" ], "members":{ "ResourceId":{ "shape":"EntityId", "documentation":"

The ID of the ML object. For example, exampleModelId.

" }, "ResourceType":{ "shape":"TaggableResourceType", "documentation":"

The type of the ML object.

" } } }, "DescribeTagsOutput":{ "type":"structure", "members":{ "ResourceId":{ "shape":"EntityId", "documentation":"

The ID of the tagged ML object.

" }, "ResourceType":{ "shape":"TaggableResourceType", "documentation":"

The type of the tagged ML object.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of tags associated with the ML object.

" } }, "documentation":"

Amazon ML returns the following elements.

" }, "DetailsAttributes":{ "type":"string", "enum":[ "PredictiveModelType", "Algorithm" ], "documentation":"Contains the key values of DetailsMap: PredictiveModelType - Indicates the type of the MLModel. Algorithm - Indicates the algorithm that was used for the MLModel." }, "DetailsMap":{ "type":"map", "key":{"shape":"DetailsAttributes"}, "value":{"shape":"DetailsValue"}, "documentation":"Provides any additional details regarding the prediction." }, "DetailsValue":{ "type":"string", "min":1 }, "EDPPipelineId":{ "type":"string", "min":1, "max":1024 }, "EDPResourceRole":{ "type":"string", "min":1, "max":64 }, "EDPSecurityGroupId":{ "type":"string", "min":1, "max":255 }, "EDPSecurityGroupIds":{ "type":"list", "member":{"shape":"EDPSecurityGroupId"} }, "EDPServiceRole":{ "type":"string", "min":1, "max":64 }, "EDPSubnetId":{ "type":"string", "min":1, "max":255 }, "EntityId":{ "type":"string", "min":1, "max":64, "pattern":"[a-zA-Z0-9_.-]+" }, "EntityName":{ "type":"string", "max":1024, "pattern":".*\\S.*|^$", "documentation":"

A user-supplied name or description of the Amazon ML resource.

" }, "EntityStatus":{ "type":"string", "enum":[ "PENDING", "INPROGRESS", "FAILED", "COMPLETED", "DELETED" ], "documentation":"

Object status with the following possible values:

  • PENDING
  • INPROGRESS
  • FAILED
  • COMPLETED
  • DELETED
" }, "EpochTime":{ "type":"timestamp", "documentation":"

A timestamp represented in epoch time.

" }, "ErrorCode":{"type":"integer"}, "ErrorMessage":{ "type":"string", "max":2048 }, "Evaluation":{ "type":"structure", "members":{ "EvaluationId":{ "shape":"EntityId", "documentation":"

The ID that is assigned to the Evaluation at creation.

" }, "MLModelId":{ "shape":"EntityId", "documentation":"

The ID of the MLModel that is the focus of the evaluation.

" }, "EvaluationDataSourceId":{ "shape":"EntityId", "documentation":"

The ID of the DataSource that is used to evaluate the MLModel.

" }, "InputDataLocationS3":{ "shape":"S3Url", "documentation":"

The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

" }, "CreatedByIamUser":{ "shape":"AwsUserArn", "documentation":"

The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" }, "CreatedAt":{ "shape":"EpochTime", "documentation":"

The time that the Evaluation was created. The time is expressed in epoch time.

" }, "LastUpdatedAt":{ "shape":"EpochTime", "documentation":"

The time of the most recent edit to the Evaluation. The time is expressed in epoch time.

" }, "Name":{ "shape":"EntityName", "documentation":"

A user-supplied name or description of the Evaluation.

" }, "Status":{ "shape":"EntityStatus", "documentation":"

The status of the evaluation. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to evaluate an MLModel.
  • INPROGRESS - The evaluation is underway.
  • FAILED - The request to evaluate an MLModel did not run to completion. It is not usable.
  • COMPLETED - The evaluation process completed successfully.
  • DELETED - The Evaluation is marked as deleted. It is not usable.
" }, "PerformanceMetrics":{ "shape":"PerformanceMetrics", "documentation":"

Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics is returned, based on the type of the MLModel:

  • BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.

  • RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.

  • MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance.

For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.

" }, "Message":{ "shape":"Message", "documentation":"

A description of the most recent details about evaluating the MLModel.

" }, "ComputeTime":{"shape":"LongType"}, "FinishedAt":{"shape":"EpochTime"}, "StartedAt":{"shape":"EpochTime"} }, "documentation":"

Represents the output of GetEvaluation operation.

The content consists of the detailed metadata and data file information and the current status of the Evaluation.

" }, "EvaluationFilterVariable":{ "type":"string", "enum":[ "CreatedAt", "LastUpdatedAt", "Status", "Name", "IAMUser", "MLModelId", "DataSourceId", "DataURI" ], "documentation":"

A list of the variables to use in searching or filtering Evaluation.

  • CreatedAt - Sets the search criteria to Evaluation creation date.
  • Status - Sets the search criteria to Evaluation status.
  • Name - Sets the search criteria to the contents of Evaluation Name.
  • IAMUser - Sets the search criteria to the user account that invoked an evaluation.
  • MLModelId - Sets the search criteria to the Predictor that was evaluated.
  • DataSourceId - Sets the search criteria to the DataSource used in evaluation.
  • DataUri - Sets the search criteria to the data file(s) used in evaluation. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
" }, "Evaluations":{ "type":"list", "member":{"shape":"Evaluation"} }, "GetBatchPredictionInput":{ "type":"structure", "required":["BatchPredictionId"], "members":{ "BatchPredictionId":{ "shape":"EntityId", "documentation":"

An ID assigned to the BatchPrediction at creation.

" } } }, "GetBatchPredictionOutput":{ "type":"structure", "members":{ "BatchPredictionId":{ "shape":"EntityId", "documentation":"

An ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.

" }, "MLModelId":{ "shape":"EntityId", "documentation":"

The ID of the MLModel that generated predictions for the BatchPrediction request.

" }, "BatchPredictionDataSourceId":{ "shape":"EntityId", "documentation":"

The ID of the DataSource that was used to create the BatchPrediction.

" }, "InputDataLocationS3":{ "shape":"S3Url", "documentation":"

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" }, "CreatedByIamUser":{ "shape":"AwsUserArn", "documentation":"

The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" }, "CreatedAt":{ "shape":"EpochTime", "documentation":"

The time when the BatchPrediction was created. The time is expressed in epoch time.

" }, "LastUpdatedAt":{ "shape":"EpochTime", "documentation":"

The time of the most recent edit to BatchPrediction. The time is expressed in epoch time.

" }, "Name":{ "shape":"EntityName", "documentation":"

A user-supplied name or description of the BatchPrediction.

" }, "Status":{ "shape":"EntityStatus", "documentation":"

The status of the BatchPrediction, which can be one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.
  • INPROGRESS - The batch predictions are in progress.
  • FAILED - The request to perform a batch prediction did not run to completion. It is not usable.
  • COMPLETED - The batch prediction process completed successfully.
  • DELETED - The BatchPrediction is marked as deleted. It is not usable.
" }, "OutputUri":{ "shape":"S3Url", "documentation":"

The location of an Amazon S3 bucket or directory to receive the operation results.

" }, "LogUri":{ "shape":"PresignedS3Url", "documentation":"

A link to the file that contains logs of the CreateBatchPrediction operation.

" }, "Message":{ "shape":"Message", "documentation":"

A description of the most recent details about processing the batch prediction request.

" }, "ComputeTime":{ "shape":"LongType", "documentation":"

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the BatchPrediction, normalized and scaled on computation resources. ComputeTime is only available if the BatchPrediction is in the COMPLETED state.

" }, "FinishedAt":{ "shape":"EpochTime", "documentation":"

The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or FAILED. FinishedAt is only available when the BatchPrediction is in the COMPLETED or FAILED state.

" }, "StartedAt":{ "shape":"EpochTime", "documentation":"

The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING state.

" }, "TotalRecordCount":{ "shape":"LongType", "documentation":"

The number of total records that Amazon Machine Learning saw while processing the BatchPrediction.

" }, "InvalidRecordCount":{ "shape":"LongType", "documentation":"

The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction.

" } }, "documentation":"

Represents the output of a GetBatchPrediction operation and describes a BatchPrediction.

" }, "GetDataSourceInput":{ "type":"structure", "required":["DataSourceId"], "members":{ "DataSourceId":{ "shape":"EntityId", "documentation":"

The ID assigned to the DataSource at creation.

" }, "Verbose":{ "shape":"Verbose", "documentation":"

Specifies whether the GetDataSource operation should return DataSourceSchema.

If true, DataSourceSchema is returned.

If false, DataSourceSchema is not returned.

" } } }, "GetDataSourceOutput":{ "type":"structure", "members":{ "DataSourceId":{ "shape":"EntityId", "documentation":"

The ID assigned to the DataSource at creation. This value should be identical to the value of the DataSourceId in the request.

" }, "DataLocationS3":{ "shape":"S3Url", "documentation":"

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" }, "DataRearrangement":{ "shape":"DataRearrangement", "documentation":"

A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created.

" }, "CreatedByIamUser":{ "shape":"AwsUserArn", "documentation":"

The AWS user account from which the DataSource was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" }, "CreatedAt":{ "shape":"EpochTime", "documentation":"

The time that the DataSource was created. The time is expressed in epoch time.

" }, "LastUpdatedAt":{ "shape":"EpochTime", "documentation":"

The time of the most recent edit to the DataSource. The time is expressed in epoch time.

" }, "DataSizeInBytes":{ "shape":"LongType", "documentation":"

The total size of observations in the data files.

" }, "NumberOfFiles":{ "shape":"LongType", "documentation":"

The number of data files referenced by the DataSource.

" }, "Name":{ "shape":"EntityName", "documentation":"

A user-supplied name or description of the DataSource.

" }, "Status":{ "shape":"EntityStatus", "documentation":"

The current status of the DataSource. This element can have one of the following values:

  • PENDING - Amazon ML submitted a request to create a DataSource.
  • INPROGRESS - The creation process is underway.
  • FAILED - The request to create a DataSource did not run to completion. It is not usable.
  • COMPLETED - The creation process completed successfully.
  • DELETED - The DataSource is marked as deleted. It is not usable.
" }, "LogUri":{ "shape":"PresignedS3Url", "documentation":"

A link to the file containing logs of CreateDataSourceFrom* operations.

" }, "Message":{ "shape":"Message", "documentation":"

The user-supplied description of the most recent details about creating the DataSource.

" }, "RedshiftMetadata":{"shape":"RedshiftMetadata"}, "RDSMetadata":{"shape":"RDSMetadata"}, "RoleARN":{"shape":"RoleARN"}, "ComputeStatistics":{ "shape":"ComputeStatistics", "documentation":"

The parameter is true if statistics need to be generated from the observation data.

" }, "ComputeTime":{ "shape":"LongType", "documentation":"

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the DataSource, normalized and scaled on computation resources. ComputeTime is only available if the DataSource is in the COMPLETED state and the ComputeStatistics is set to true.

" }, "FinishedAt":{ "shape":"EpochTime", "documentation":"

The epoch time when Amazon Machine Learning marked the DataSource as COMPLETED or FAILED. FinishedAt is only available when the DataSource is in the COMPLETED or FAILED state.

" }, "StartedAt":{ "shape":"EpochTime", "documentation":"

The epoch time when Amazon Machine Learning marked the DataSource as INPROGRESS. StartedAt isn't available if the DataSource is in the PENDING state.

" }, "DataSourceSchema":{ "shape":"DataSchema", "documentation":"

The schema used by all of the data files of this DataSource.

Note

This parameter is provided as part of the verbose format.

" } }, "documentation":"

Represents the output of a GetDataSource operation and describes a DataSource.

" }, "GetEvaluationInput":{ "type":"structure", "required":["EvaluationId"], "members":{ "EvaluationId":{ "shape":"EntityId", "documentation":"

The ID of the Evaluation to retrieve. The evaluation of each MLModel is recorded and cataloged. The ID provides the means to access the information.

" } } }, "GetEvaluationOutput":{ "type":"structure", "members":{ "EvaluationId":{ "shape":"EntityId", "documentation":"

The evaluation ID which is same as the EvaluationId in the request.

" }, "MLModelId":{ "shape":"EntityId", "documentation":"

The ID of the MLModel that was the focus of the evaluation.

" }, "EvaluationDataSourceId":{ "shape":"EntityId", "documentation":"

The DataSource used for this evaluation.

" }, "InputDataLocationS3":{ "shape":"S3Url", "documentation":"

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" }, "CreatedByIamUser":{ "shape":"AwsUserArn", "documentation":"

The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" }, "CreatedAt":{ "shape":"EpochTime", "documentation":"

The time that the Evaluation was created. The time is expressed in epoch time.

" }, "LastUpdatedAt":{ "shape":"EpochTime", "documentation":"

The time of the most recent edit to the Evaluation. The time is expressed in epoch time.

" }, "Name":{ "shape":"EntityName", "documentation":"

A user-supplied name or description of the Evaluation.

" }, "Status":{ "shape":"EntityStatus", "documentation":"

The status of the evaluation. This element can have one of the following values:

  • PENDING - Amazon Machine Language (Amazon ML) submitted a request to evaluate an MLModel.
  • INPROGRESS - The evaluation is underway.
  • FAILED - The request to evaluate an MLModel did not run to completion. It is not usable.
  • COMPLETED - The evaluation process completed successfully.
  • DELETED - The Evaluation is marked as deleted. It is not usable.
" }, "PerformanceMetrics":{ "shape":"PerformanceMetrics", "documentation":"

Measurements of how well the MLModel performed using observations referenced by the DataSource. One of the following metric is returned based on the type of the MLModel:

  • BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.

  • RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.

  • MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance.

For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.

" }, "LogUri":{ "shape":"PresignedS3Url", "documentation":"

A link to the file that contains logs of the CreateEvaluation operation.

" }, "Message":{ "shape":"Message", "documentation":"

A description of the most recent details about evaluating the MLModel.

" }, "ComputeTime":{ "shape":"LongType", "documentation":"

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the Evaluation, normalized and scaled on computation resources. ComputeTime is only available if the Evaluation is in the COMPLETED state.

" }, "FinishedAt":{ "shape":"EpochTime", "documentation":"

The epoch time when Amazon Machine Learning marked the Evaluation as COMPLETED or FAILED. FinishedAt is only available when the Evaluation is in the COMPLETED or FAILED state.

" }, "StartedAt":{ "shape":"EpochTime", "documentation":"

The epoch time when Amazon Machine Learning marked the Evaluation as INPROGRESS. StartedAt isn't available if the Evaluation is in the PENDING state.

" } }, "documentation":"

Represents the output of a GetEvaluation operation and describes an Evaluation.

" }, "GetMLModelInput":{ "type":"structure", "required":["MLModelId"], "members":{ "MLModelId":{ "shape":"EntityId", "documentation":"

The ID assigned to the MLModel at creation.

" }, "Verbose":{ "shape":"Verbose", "documentation":"

Specifies whether the GetMLModel operation should return Recipe.

If true, Recipe is returned.

If false, Recipe is not returned.

" } } }, "GetMLModelOutput":{ "type":"structure", "members":{ "MLModelId":{ "shape":"EntityId", "documentation":"

The MLModel ID, which is same as the MLModelId in the request.

" }, "TrainingDataSourceId":{ "shape":"EntityId", "documentation":"

The ID of the training DataSource.

" }, "CreatedByIamUser":{ "shape":"AwsUserArn", "documentation":"

The AWS user account from which the MLModel was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" }, "CreatedAt":{ "shape":"EpochTime", "documentation":"

The time that the MLModel was created. The time is expressed in epoch time.

" }, "LastUpdatedAt":{ "shape":"EpochTime", "documentation":"

The time of the most recent edit to the MLModel. The time is expressed in epoch time.

" }, "Name":{ "shape":"MLModelName", "documentation":"

A user-supplied name or description of the MLModel.

" }, "Status":{ "shape":"EntityStatus", "documentation":"

The current status of the MLModel. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to describe a MLModel.
  • INPROGRESS - The request is processing.
  • FAILED - The request did not run to completion. The ML model isn't usable.
  • COMPLETED - The request completed successfully.
  • DELETED - The MLModel is marked as deleted. It isn't usable.
" }, "SizeInBytes":{"shape":"LongType"}, "EndpointInfo":{ "shape":"RealtimeEndpointInfo", "documentation":"

The current endpoint of the MLModel

" }, "TrainingParameters":{ "shape":"TrainingParameters", "documentation":"

A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.

The following is the current set of training parameters:

  • sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.

    The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.

  • sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.

  • sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none. We strongly recommend that you shuffle your data.

  • sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.

  • sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.

" }, "InputDataLocationS3":{ "shape":"S3Url", "documentation":"

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" }, "MLModelType":{ "shape":"MLModelType", "documentation":"

Identifies the MLModel category. The following are the available types:

  • REGRESSION -- Produces a numeric result. For example, \"What price should a house be listed at?\"
  • BINARY -- Produces one of two possible results. For example, \"Is this an e-commerce website?\"
  • MULTICLASS -- Produces one of several possible results. For example, \"Is this a HIGH, LOW or MEDIUM risk trade?\"
" }, "ScoreThreshold":{ "shape":"ScoreThreshold", "documentation":"

The scoring threshold is used in binary classification MLModel models. It marks the boundary between a positive prediction and a negative prediction.

Output values greater than or equal to the threshold receive a positive result from the MLModel, such as true. Output values less than the threshold receive a negative response from the MLModel, such as false.

" }, "ScoreThresholdLastUpdatedAt":{ "shape":"EpochTime", "documentation":"

The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time.

" }, "LogUri":{ "shape":"PresignedS3Url", "documentation":"

A link to the file that contains logs of the CreateMLModel operation.

" }, "Message":{ "shape":"Message", "documentation":"

A description of the most recent details about accessing the MLModel.

" }, "ComputeTime":{ "shape":"LongType", "documentation":"

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the MLModel, normalized and scaled on computation resources. ComputeTime is only available if the MLModel is in the COMPLETED state.

" }, "FinishedAt":{ "shape":"EpochTime", "documentation":"

The epoch time when Amazon Machine Learning marked the MLModel as COMPLETED or FAILED. FinishedAt is only available when the MLModel is in the COMPLETED or FAILED state.

" }, "StartedAt":{ "shape":"EpochTime", "documentation":"

The epoch time when Amazon Machine Learning marked the MLModel as INPROGRESS. StartedAt isn't available if the MLModel is in the PENDING state.

" }, "Recipe":{ "shape":"Recipe", "documentation":"

The recipe to use when training the MLModel. The Recipe provides detailed information about the observation data to use during training, and manipulations to perform on the observation data during training.

Note

This parameter is provided as part of the verbose format.

" }, "Schema":{ "shape":"DataSchema", "documentation":"

The schema used by all of the data files referenced by the DataSource.

Note

This parameter is provided as part of the verbose format.

" } }, "documentation":"

Represents the output of a GetMLModel operation, and provides detailed information about a MLModel.

" }, "IdempotentParameterMismatchException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"}, "code":{"shape":"ErrorCode"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"

A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.

" }, "IntegerType":{ "type":"integer", "documentation":"

Integer type that is a 32-bit signed number.

" }, "InternalServerException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"}, "code":{"shape":"ErrorCode"} }, "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An error on the server occurred when trying to process a request.

" }, "InvalidInputException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"}, "code":{"shape":"ErrorCode"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" }, "InvalidTagException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true }, "Label":{ "type":"string", "min":1 }, "LimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"}, "code":{"shape":"ErrorCode"} }, "error":{"httpStatusCode":417}, "exception":true, "documentation":"

The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as DataSource.

" }, "LongType":{ "type":"long", "documentation":"

Long integer type that is a 64-bit signed number.

" }, "MLModel":{ "type":"structure", "members":{ "MLModelId":{ "shape":"EntityId", "documentation":"

The ID assigned to the MLModel at creation.

" }, "TrainingDataSourceId":{ "shape":"EntityId", "documentation":"

The ID of the training DataSource. The CreateMLModel operation uses the TrainingDataSourceId.

" }, "CreatedByIamUser":{ "shape":"AwsUserArn", "documentation":"

The AWS user account from which the MLModel was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" }, "CreatedAt":{ "shape":"EpochTime", "documentation":"

The time that the MLModel was created. The time is expressed in epoch time.

" }, "LastUpdatedAt":{ "shape":"EpochTime", "documentation":"

The time of the most recent edit to the MLModel. The time is expressed in epoch time.

" }, "Name":{ "shape":"MLModelName", "documentation":"

A user-supplied name or description of the MLModel.

" }, "Status":{ "shape":"EntityStatus", "documentation":"

The current status of an MLModel. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create an MLModel.
  • INPROGRESS - The creation process is underway.
  • FAILED - The request to create an MLModel didn't run to completion. The model isn't usable.
  • COMPLETED - The creation process completed successfully.
  • DELETED - The MLModel is marked as deleted. It isn't usable.
" }, "SizeInBytes":{"shape":"LongType"}, "EndpointInfo":{ "shape":"RealtimeEndpointInfo", "documentation":"

The current endpoint of the MLModel.

" }, "TrainingParameters":{ "shape":"TrainingParameters", "documentation":"

A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.

The following is the current set of training parameters:

  • sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.

    The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.

  • sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.

  • sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none.

  • sgd.l1RegularizationAmount - The coefficient regularization L1 norm, which controls overfitting the data by penalizing large coefficients. This parameter tends to drive coefficients to zero, resulting in sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.

  • sgd.l2RegularizationAmount - The coefficient regularization L2 norm, which controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.

" }, "InputDataLocationS3":{ "shape":"S3Url", "documentation":"

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" }, "Algorithm":{ "shape":"Algorithm", "documentation":"

The algorithm used to train the MLModel. The following algorithm is supported:

  • SGD -- Stochastic gradient descent. The goal of SGD is to minimize the gradient of the loss function.
" }, "MLModelType":{ "shape":"MLModelType", "documentation":"

Identifies the MLModel category. The following are the available types:

  • REGRESSION - Produces a numeric result. For example, \"What price should a house be listed at?\"
  • BINARY - Produces one of two possible results. For example, \"Is this a child-friendly web site?\".
  • MULTICLASS - Produces one of several possible results. For example, \"Is this a HIGH-, LOW-, or MEDIUM-risk trade?\".
" }, "ScoreThreshold":{"shape":"ScoreThreshold"}, "ScoreThresholdLastUpdatedAt":{ "shape":"EpochTime", "documentation":"

The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time.

" }, "Message":{ "shape":"Message", "documentation":"

A description of the most recent details about accessing the MLModel.

" }, "ComputeTime":{"shape":"LongType"}, "FinishedAt":{"shape":"EpochTime"}, "StartedAt":{"shape":"EpochTime"} }, "documentation":"

Represents the output of a GetMLModel operation.

The content consists of the detailed metadata and the current status of the MLModel.

" }, "MLModelFilterVariable":{ "type":"string", "enum":[ "CreatedAt", "LastUpdatedAt", "Status", "Name", "IAMUser", "TrainingDataSourceId", "RealtimeEndpointStatus", "MLModelType", "Algorithm", "TrainingDataURI" ] }, "MLModelName":{ "type":"string", "max":1024 }, "MLModelType":{ "type":"string", "enum":[ "REGRESSION", "BINARY", "MULTICLASS" ] }, "MLModels":{ "type":"list", "member":{"shape":"MLModel"} }, "Message":{ "type":"string", "max":10240, "documentation":"

Description of the most recent details about an object.

" }, "PageLimit":{ "type":"integer", "min":1, "max":100 }, "PerformanceMetrics":{ "type":"structure", "members":{ "Properties":{"shape":"PerformanceMetricsProperties"} }, "documentation":"

Measurements of how well the MLModel performed on known observations. One of the following metrics is returned, based on the type of the MLModel:

  • BinaryAUC: The binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.

  • RegressionRMSE: The regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.

  • MulticlassAvgFScore: The multiclass MLModel uses the F1 score technique to measure performance.

For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.

" }, "PerformanceMetricsProperties":{ "type":"map", "key":{"shape":"PerformanceMetricsPropertyKey"}, "value":{"shape":"PerformanceMetricsPropertyValue"} }, "PerformanceMetricsPropertyKey":{"type":"string"}, "PerformanceMetricsPropertyValue":{"type":"string"}, "PredictInput":{ "type":"structure", "required":[ "MLModelId", "Record", "PredictEndpoint" ], "members":{ "MLModelId":{ "shape":"EntityId", "documentation":"

A unique identifier of the MLModel.

" }, "Record":{"shape":"Record"}, "PredictEndpoint":{"shape":"VipURL"} } }, "PredictOutput":{ "type":"structure", "members":{ "Prediction":{"shape":"Prediction"} } }, "Prediction":{ "type":"structure", "members":{ "predictedLabel":{ "shape":"Label", "documentation":"

The prediction label for either a BINARY or MULTICLASS MLModel.

" }, "predictedValue":{ "shape":"floatLabel", "documentation":"The prediction value for REGRESSION MLModel." }, "predictedScores":{"shape":"ScoreValuePerLabelMap"}, "details":{"shape":"DetailsMap"} }, "documentation":"

The output from a Predict operation:

  • Details - Contains the following attributes: DetailsAttributes.PREDICTIVE_MODEL_TYPE - REGRESSION | BINARY | MULTICLASS DetailsAttributes.ALGORITHM - SGD

  • PredictedLabel - Present for either a BINARY or MULTICLASS MLModel request.

  • PredictedScores - Contains the raw classification score corresponding to each label.

  • PredictedValue - Present for a REGRESSION MLModel request.

" }, "PredictorNotMountedException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The exception is thrown when a predict request is made to an unmounted MLModel.

" }, "PresignedS3Url":{"type":"string"}, "RDSDataSpec":{ "type":"structure", "required":[ "DatabaseInformation", "SelectSqlQuery", "DatabaseCredentials", "S3StagingLocation", "ResourceRole", "ServiceRole", "SubnetId", "SecurityGroupIds" ], "members":{ "DatabaseInformation":{ "shape":"RDSDatabase", "documentation":"

Describes the DatabaseName and InstanceIdentifier of an Amazon RDS database.

" }, "SelectSqlQuery":{ "shape":"RDSSelectSqlQuery", "documentation":"

The query that is used to retrieve the observation data for the DataSource.

" }, "DatabaseCredentials":{ "shape":"RDSDatabaseCredentials", "documentation":"

The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.

" }, "S3StagingLocation":{ "shape":"S3Url", "documentation":"

The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

" }, "DataRearrangement":{ "shape":"DataRearrangement", "documentation":"

A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.

There are multiple parameters that control what data is used to create a datasource:

  • percentBegin

    Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • percentEnd

    Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • complement

    The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.

    For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25}}

    Datasource for training: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25, \"complement\":\"true\"}}

  • strategy

    To change how Amazon ML splits the data for a datasource, use the strategy parameter.

    The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.

    The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\"}}

    Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\", \"complement\":\"true\"}}

    To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.

    The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\"}}

    Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\", \"complement\":\"true\"}}

" }, "DataSchema":{ "shape":"DataSchema", "documentation":"

A JSON string that represents the schema for an Amazon RDS DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.

A DataSchema is not required if you specify a DataSchemaUri

Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.

{ \"version\": \"1.0\",

\"recordAnnotationFieldName\": \"F1\",

\"recordWeightFieldName\": \"F2\",

\"targetFieldName\": \"F3\",

\"dataFormat\": \"CSV\",

\"dataFileContainsHeader\": true,

\"attributes\": [

{ \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],

\"excludedVariableNames\": [ \"F6\" ] }

" }, "DataSchemaUri":{ "shape":"S3Url", "documentation":"

The Amazon S3 location of the DataSchema.

" }, "ResourceRole":{ "shape":"EDPResourceRole", "documentation":"

The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.

" }, "ServiceRole":{ "shape":"EDPServiceRole", "documentation":"

The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

" }, "SubnetId":{ "shape":"EDPSubnetId", "documentation":"

The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.

" }, "SecurityGroupIds":{ "shape":"EDPSecurityGroupIds", "documentation":"

The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.

" } }, "documentation":"

The data specification of an Amazon Relational Database Service (Amazon RDS) DataSource.

" }, "RDSDatabase":{ "type":"structure", "required":[ "InstanceIdentifier", "DatabaseName" ], "members":{ "InstanceIdentifier":{ "shape":"RDSInstanceIdentifier", "documentation":"

The ID of an RDS DB instance.

" }, "DatabaseName":{"shape":"RDSDatabaseName"} }, "documentation":"

The database details of an Amazon RDS database.

" }, "RDSDatabaseCredentials":{ "type":"structure", "required":[ "Username", "Password" ], "members":{ "Username":{"shape":"RDSDatabaseUsername"}, "Password":{"shape":"RDSDatabasePassword"} }, "documentation":"

The database credentials to connect to a database on an RDS DB instance.

" }, "RDSDatabaseName":{ "type":"string", "min":1, "max":64, "documentation":"

The name of a database hosted on an RDS DB instance.

" }, "RDSDatabasePassword":{ "type":"string", "min":8, "max":128, "documentation":"

The password to be used by Amazon ML to connect to a database on an RDS DB instance. The password should have sufficient permissions to execute the RDSSelectQuery query.

" }, "RDSDatabaseUsername":{ "type":"string", "min":1, "max":128, "documentation":"

The username to be used by Amazon ML to connect to database on an Amazon RDS instance. The username should have sufficient permissions to execute an RDSSelectSqlQuery query.

" }, "RDSInstanceIdentifier":{ "type":"string", "min":1, "max":63, "pattern":"[a-z0-9-]+", "documentation":"Identifier of RDS DB Instances." }, "RDSMetadata":{ "type":"structure", "members":{ "Database":{ "shape":"RDSDatabase", "documentation":"

The database details required to connect to an Amazon RDS.

" }, "DatabaseUserName":{"shape":"RDSDatabaseUsername"}, "SelectSqlQuery":{ "shape":"RDSSelectSqlQuery", "documentation":"

The SQL query that is supplied during CreateDataSourceFromRDS. Returns only if Verbose is true in GetDataSourceInput.

" }, "ResourceRole":{ "shape":"EDPResourceRole", "documentation":"

The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

" }, "ServiceRole":{ "shape":"EDPServiceRole", "documentation":"

The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

" }, "DataPipelineId":{ "shape":"EDPPipelineId", "documentation":"

The ID of the Data Pipeline instance that is used to carry to copy data from Amazon RDS to Amazon S3. You can use the ID to find details about the instance in the Data Pipeline console.

" } }, "documentation":"

The datasource details that are specific to Amazon RDS.

" }, "RDSSelectSqlQuery":{ "type":"string", "min":1, "max":16777216, "documentation":"

The SQL query to be executed against the Amazon RDS database. The SQL query should be valid for the Amazon RDS type being used.

" }, "RealtimeEndpointInfo":{ "type":"structure", "members":{ "PeakRequestsPerSecond":{ "shape":"IntegerType", "documentation":"

The maximum processing rate for the real-time endpoint for MLModel, measured in incoming requests per second.

" }, "CreatedAt":{ "shape":"EpochTime", "documentation":"

The time that the request to create the real-time endpoint for the MLModel was received. The time is expressed in epoch time.

" }, "EndpointUrl":{ "shape":"VipURL", "documentation":"

The URI that specifies where to send real-time prediction requests for the MLModel.

Note

The application must wait until the real-time endpoint is ready before using this URI.

" }, "EndpointStatus":{ "shape":"RealtimeEndpointStatus", "documentation":"

The current status of the real-time endpoint for the MLModel. This element can have one of the following values:

  • NONE - Endpoint does not exist or was previously deleted.
  • READY - Endpoint is ready to be used for real-time predictions.
  • UPDATING - Updating/creating the endpoint.
" } }, "documentation":"

Describes the real-time endpoint information for an MLModel.

" }, "RealtimeEndpointStatus":{ "type":"string", "enum":[ "NONE", "READY", "UPDATING", "FAILED" ] }, "Recipe":{ "type":"string", "max":131071 }, "Record":{ "type":"map", "key":{"shape":"VariableName"}, "value":{"shape":"VariableValue"}, "documentation":"

A map of variable name-value pairs that represent an observation.

" }, "RedshiftClusterIdentifier":{ "type":"string", "min":1, "max":63, "pattern":"[a-z0-9-]+", "documentation":"

The ID of an Amazon Redshift cluster.

" }, "RedshiftDataSpec":{ "type":"structure", "required":[ "DatabaseInformation", "SelectSqlQuery", "DatabaseCredentials", "S3StagingLocation" ], "members":{ "DatabaseInformation":{ "shape":"RedshiftDatabase", "documentation":"

Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift DataSource.

" }, "SelectSqlQuery":{ "shape":"RedshiftSelectSqlQuery", "documentation":"

Describes the SQL Query to execute on an Amazon Redshift database for an Amazon Redshift DataSource.

" }, "DatabaseCredentials":{ "shape":"RedshiftDatabaseCredentials", "documentation":"

Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift database.

" }, "S3StagingLocation":{ "shape":"S3Url", "documentation":"

Describes an Amazon S3 location to store the result set of the SelectSqlQuery query.

" }, "DataRearrangement":{ "shape":"DataRearrangement", "documentation":"

A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.

There are multiple parameters that control what data is used to create a datasource:

  • percentBegin

    Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • percentEnd

    Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • complement

    The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.

    For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25}}

    Datasource for training: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25, \"complement\":\"true\"}}

  • strategy

    To change how Amazon ML splits the data for a datasource, use the strategy parameter.

    The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.

    The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\"}}

    Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\", \"complement\":\"true\"}}

    To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.

    The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\"}}

    Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\", \"complement\":\"true\"}}

" }, "DataSchema":{ "shape":"DataSchema", "documentation":"

A JSON string that represents the schema for an Amazon Redshift DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.

A DataSchema is not required if you specify a DataSchemaUri.

Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.

{ \"version\": \"1.0\",

\"recordAnnotationFieldName\": \"F1\",

\"recordWeightFieldName\": \"F2\",

\"targetFieldName\": \"F3\",

\"dataFormat\": \"CSV\",

\"dataFileContainsHeader\": true,

\"attributes\": [

{ \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],

\"excludedVariableNames\": [ \"F6\" ] }

" }, "DataSchemaUri":{ "shape":"S3Url", "documentation":"

Describes the schema location for an Amazon Redshift DataSource.

" } }, "documentation":"

Describes the data specification of an Amazon Redshift DataSource.

" }, "RedshiftDatabase":{ "type":"structure", "required":[ "DatabaseName", "ClusterIdentifier" ], "members":{ "DatabaseName":{"shape":"RedshiftDatabaseName"}, "ClusterIdentifier":{"shape":"RedshiftClusterIdentifier"} }, "documentation":"

Describes the database details required to connect to an Amazon Redshift database.

" }, "RedshiftDatabaseCredentials":{ "type":"structure", "required":[ "Username", "Password" ], "members":{ "Username":{"shape":"RedshiftDatabaseUsername"}, "Password":{"shape":"RedshiftDatabasePassword"} }, "documentation":"

Describes the database credentials for connecting to a database on an Amazon Redshift cluster.

" }, "RedshiftDatabaseName":{ "type":"string", "min":1, "max":64, "pattern":"[a-z0-9]+", "documentation":"

The name of a database hosted on an Amazon Redshift cluster.

" }, "RedshiftDatabasePassword":{ "type":"string", "min":8, "max":64, "documentation":"

A password to be used by Amazon ML to connect to a database on an Amazon Redshift cluster. The password should have sufficient permissions to execute a RedshiftSelectSqlQuery query. The password should be valid for an Amazon Redshift USER.

" }, "RedshiftDatabaseUsername":{ "type":"string", "min":1, "max":128, "documentation":"

A username to be used by Amazon Machine Learning (Amazon ML)to connect to a database on an Amazon Redshift cluster. The username should have sufficient permissions to execute the RedshiftSelectSqlQuery query. The username should be valid for an Amazon Redshift USER.

" }, "RedshiftMetadata":{ "type":"structure", "members":{ "RedshiftDatabase":{"shape":"RedshiftDatabase"}, "DatabaseUserName":{"shape":"RedshiftDatabaseUsername"}, "SelectSqlQuery":{ "shape":"RedshiftSelectSqlQuery", "documentation":"

The SQL query that is specified during CreateDataSourceFromRedshift. Returns only if Verbose is true in GetDataSourceInput.

" } }, "documentation":"

Describes the DataSource details specific to Amazon Redshift.

" }, "RedshiftSelectSqlQuery":{ "type":"string", "min":1, "max":16777216, "documentation":"

Describes the SQL query to execute on the Amazon Redshift database. The SQL query should be valid for an Amazon Redshift SELECT.

" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"}, "code":{"shape":"ErrorCode"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"

A specified resource cannot be located.

" }, "RoleARN":{ "type":"string", "min":1, "max":110, "documentation":"

The Amazon Resource Name (ARN) of an AWS IAM Role, such as the following: arn:aws:iam::account:role/rolename.

" }, "S3DataSpec":{ "type":"structure", "required":["DataLocationS3"], "members":{ "DataLocationS3":{ "shape":"S3Url", "documentation":"

The location of the data file(s) used by a DataSource. The URI specifies a data file or an Amazon Simple Storage Service (Amazon S3) directory or bucket containing data files.

" }, "DataRearrangement":{ "shape":"DataRearrangement", "documentation":"

A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.

There are multiple parameters that control what data is used to create a datasource:

  • percentBegin

    Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • percentEnd

    Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • complement

    The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.

    For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25}}

    Datasource for training: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25, \"complement\":\"true\"}}

  • strategy

    To change how Amazon ML splits the data for a datasource, use the strategy parameter.

    The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.

    The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\"}}

    Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\", \"complement\":\"true\"}}

    To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.

    The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\"}}

    Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\", \"complement\":\"true\"}}

" }, "DataSchema":{ "shape":"DataSchema", "documentation":"

A JSON string that represents the schema for an Amazon S3 DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.

You must provide either the DataSchema or the DataSchemaLocationS3.

Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.

{ \"version\": \"1.0\",

\"recordAnnotationFieldName\": \"F1\",

\"recordWeightFieldName\": \"F2\",

\"targetFieldName\": \"F3\",

\"dataFormat\": \"CSV\",

\"dataFileContainsHeader\": true,

\"attributes\": [

{ \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],

\"excludedVariableNames\": [ \"F6\" ] }

" }, "DataSchemaLocationS3":{ "shape":"S3Url", "documentation":"

Describes the schema location in Amazon S3. You must provide either the DataSchema or the DataSchemaLocationS3.

" } }, "documentation":"

Describes the data specification of a DataSource.

" }, "S3Url":{ "type":"string", "max":2048, "pattern":"s3://([^/]+)(/.*)?", "documentation":"

A reference to a file or bucket on Amazon Simple Storage Service (Amazon S3).

" }, "ScoreThreshold":{"type":"float"}, "ScoreValue":{"type":"float"}, "ScoreValuePerLabelMap":{ "type":"map", "key":{"shape":"Label"}, "value":{"shape":"ScoreValue"}, "documentation":"Provides the raw classification score corresponding to each label." }, "SortOrder":{ "type":"string", "enum":[ "asc", "dsc" ], "documentation":"

The sort order specified in a listing condition. Possible values include the following:

  • asc - Present the information in ascending order (from A-Z).
  • dsc - Present the information in descending order (from Z-A).
" }, "StringType":{ "type":"string", "documentation":"

String type.

" }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"TagKey", "documentation":"

A unique identifier for the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.

" }, "Value":{ "shape":"TagValue", "documentation":"

An optional string, typically used to describe or define the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.

" } }, "documentation":"

A custom key-value pair associated with an ML object, such as an ML model.

" }, "TagKey":{ "type":"string", "min":1, "max":128, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":100 }, "TagLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":100 }, "TagValue":{ "type":"string", "min":0, "max":256, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TaggableResourceType":{ "type":"string", "enum":[ "BatchPrediction", "DataSource", "Evaluation", "MLModel" ] }, "TrainingParameters":{ "type":"map", "key":{"shape":"StringType"}, "value":{"shape":"StringType"} }, "UpdateBatchPredictionInput":{ "type":"structure", "required":[ "BatchPredictionId", "BatchPredictionName" ], "members":{ "BatchPredictionId":{ "shape":"EntityId", "documentation":"

The ID assigned to the BatchPrediction during creation.

" }, "BatchPredictionName":{ "shape":"EntityName", "documentation":"

A new user-supplied name or description of the BatchPrediction.

" } } }, "UpdateBatchPredictionOutput":{ "type":"structure", "members":{ "BatchPredictionId":{ "shape":"EntityId", "documentation":"

The ID assigned to the BatchPrediction during creation. This value should be identical to the value of the BatchPredictionId in the request.

" } }, "documentation":"

Represents the output of an UpdateBatchPrediction operation.

You can see the updated content by using the GetBatchPrediction operation.

" }, "UpdateDataSourceInput":{ "type":"structure", "required":[ "DataSourceId", "DataSourceName" ], "members":{ "DataSourceId":{ "shape":"EntityId", "documentation":"

The ID assigned to the DataSource during creation.

" }, "DataSourceName":{ "shape":"EntityName", "documentation":"

A new user-supplied name or description of the DataSource that will replace the current description.

" } } }, "UpdateDataSourceOutput":{ "type":"structure", "members":{ "DataSourceId":{ "shape":"EntityId", "documentation":"

The ID assigned to the DataSource during creation. This value should be identical to the value of the DataSourceID in the request.

" } }, "documentation":"

Represents the output of an UpdateDataSource operation.

You can see the updated content by using the GetBatchPrediction operation.

" }, "UpdateEvaluationInput":{ "type":"structure", "required":[ "EvaluationId", "EvaluationName" ], "members":{ "EvaluationId":{ "shape":"EntityId", "documentation":"

The ID assigned to the Evaluation during creation.

" }, "EvaluationName":{ "shape":"EntityName", "documentation":"

A new user-supplied name or description of the Evaluation that will replace the current content.

" } } }, "UpdateEvaluationOutput":{ "type":"structure", "members":{ "EvaluationId":{ "shape":"EntityId", "documentation":"

The ID assigned to the Evaluation during creation. This value should be identical to the value of the Evaluation in the request.

" } }, "documentation":"

Represents the output of an UpdateEvaluation operation.

You can see the updated content by using the GetEvaluation operation.

" }, "UpdateMLModelInput":{ "type":"structure", "required":["MLModelId"], "members":{ "MLModelId":{ "shape":"EntityId", "documentation":"

The ID assigned to the MLModel during creation.

" }, "MLModelName":{ "shape":"EntityName", "documentation":"

A user-supplied name or description of the MLModel.

" }, "ScoreThreshold":{ "shape":"ScoreThreshold", "documentation":"

The ScoreThreshold used in binary classification MLModel that marks the boundary between a positive prediction and a negative prediction.

Output values greater than or equal to the ScoreThreshold receive a positive result from the MLModel, such as true. Output values less than the ScoreThreshold receive a negative response from the MLModel, such as false.

" } } }, "UpdateMLModelOutput":{ "type":"structure", "members":{ "MLModelId":{ "shape":"EntityId", "documentation":"

The ID assigned to the MLModel during creation. This value should be identical to the value of the MLModelID in the request.

" } }, "documentation":"

Represents the output of an UpdateMLModel operation.

You can see the updated content by using the GetMLModel operation.

" }, "VariableName":{ "type":"string", "documentation":"

The name of a variable. Currently it's used to specify the name of the target value, label, weight, and tags.

" }, "VariableValue":{ "type":"string", "documentation":"

The value of a variable. Currently it's used to specify values of the target value, weights, and tag variables and for filtering variable values.

" }, "Verbose":{ "type":"boolean", "documentation":"

Specifies whether a describe operation should return exhaustive or abbreviated information.

" }, "VipURL":{ "type":"string", "max":2048, "pattern":"https://[a-zA-Z0-9-.]*\\.amazon(aws)?\\.com[/]?" }, "floatLabel":{"type":"float"} }, "examples":{ } } botocore-1.5.7/botocore/data/ssm/0000777454262600001440000000000013042511307017735 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ssm/2014-11-06/0000777454262600001440000000000013042511307020765 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ssm/2014-11-06/paginators-1.json0000666454262600001440000000131113042511306024160 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListAssociations": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Associations" }, "ListCommandInvocations": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "CommandInvocations" }, "ListCommands": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "Commands" }, "ListDocuments": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "DocumentIdentifiers" } } } botocore-1.5.7/botocore/data/ssm/2014-11-06/service-2.json0000666454262600001440000110215213042511306023460 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2014-11-06", "endpointPrefix":"ssm", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"Amazon SSM", "serviceFullName":"Amazon Simple Systems Manager (SSM)", "signatureVersion":"v4", "targetPrefix":"AmazonSSM", "uid":"ssm-2014-11-06" }, "operations":{ "AddTagsToResource":{ "name":"AddTagsToResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsToResourceRequest"}, "output":{"shape":"AddTagsToResourceResult"}, "errors":[ {"shape":"InvalidResourceType"}, {"shape":"InvalidResourceId"}, {"shape":"InternalServerError"}, {"shape":"TooManyTagsError"} ], "documentation":"

Adds or overwrites one or more tags for the specified resource. Tags are metadata that you assign to your managed instances. Tags enable you to categorize your managed instances in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test. Each resource can have a maximum of 10 tags.

We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters.

For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

" }, "CancelCommand":{ "name":"CancelCommand", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelCommandRequest"}, "output":{"shape":"CancelCommandResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidCommandId"}, {"shape":"InvalidInstanceId"}, {"shape":"DuplicateInstanceId"} ], "documentation":"

Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.

" }, "CreateActivation":{ "name":"CreateActivation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateActivationRequest"}, "output":{"shape":"CreateActivationResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Managed Instances (Linux) or Setting Up Managed Instances (Windows) in the Amazon EC2 User Guide.

" }, "CreateAssociation":{ "name":"CreateAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAssociationRequest"}, "output":{"shape":"CreateAssociationResult"}, "errors":[ {"shape":"AssociationAlreadyExists"}, {"shape":"AssociationLimitExceeded"}, {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentVersion"}, {"shape":"InvalidInstanceId"}, {"shape":"UnsupportedPlatformType"}, {"shape":"InvalidOutputLocation"}, {"shape":"InvalidParameters"}, {"shape":"InvalidTarget"}, {"shape":"InvalidSchedule"} ], "documentation":"

Associates the specified SSM document with the specified instances or targets.

When you associate an SSM document with one or more instances using instance IDs or tags, the SSM agent running on the instance processes the document and configures the instance as specified.

If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.

" }, "CreateAssociationBatch":{ "name":"CreateAssociationBatch", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAssociationBatchRequest"}, "output":{"shape":"CreateAssociationBatchResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentVersion"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidParameters"}, {"shape":"DuplicateInstanceId"}, {"shape":"AssociationLimitExceeded"}, {"shape":"UnsupportedPlatformType"}, {"shape":"InvalidOutputLocation"}, {"shape":"InvalidTarget"}, {"shape":"InvalidSchedule"} ], "documentation":"

Associates the specified SSM document with the specified instances or targets.

When you associate an SSM document with one or more instances using instance IDs or tags, the SSM agent running on the instance processes the document and configures the instance as specified.

If you associate a document with an instance that already has an associated document, the system throws the AssociationAlreadyExists exception.

" }, "CreateDocument":{ "name":"CreateDocument", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDocumentRequest"}, "output":{"shape":"CreateDocumentResult"}, "errors":[ {"shape":"DocumentAlreadyExists"}, {"shape":"MaxDocumentSizeExceeded"}, {"shape":"InternalServerError"}, {"shape":"InvalidDocumentContent"}, {"shape":"DocumentLimitExceeded"}, {"shape":"InvalidDocumentSchemaVersion"} ], "documentation":"

Creates an SSM document.

After you create an SSM document, you can use CreateAssociation to associate it with one or more running instances.

" }, "CreateMaintenanceWindow":{ "name":"CreateMaintenanceWindow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateMaintenanceWindowRequest"}, "output":{"shape":"CreateMaintenanceWindowResult"}, "errors":[ {"shape":"IdempotentParameterMismatch"}, {"shape":"ResourceLimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

Creates a new Maintenance Window.

" }, "CreatePatchBaseline":{ "name":"CreatePatchBaseline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePatchBaselineRequest"}, "output":{"shape":"CreatePatchBaselineResult"}, "errors":[ {"shape":"IdempotentParameterMismatch"}, {"shape":"ResourceLimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

Creates a patch baseline.

" }, "DeleteActivation":{ "name":"DeleteActivation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteActivationRequest"}, "output":{"shape":"DeleteActivationResult"}, "errors":[ {"shape":"InvalidActivationId"}, {"shape":"InvalidActivation"}, {"shape":"InternalServerError"} ], "documentation":"

Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.

" }, "DeleteAssociation":{ "name":"DeleteAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAssociationRequest"}, "output":{"shape":"DeleteAssociationResult"}, "errors":[ {"shape":"AssociationDoesNotExist"}, {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidInstanceId"}, {"shape":"TooManyUpdates"} ], "documentation":"

Disassociates the specified SSM document from the specified instance.

When you disassociate an SSM document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.

" }, "DeleteDocument":{ "name":"DeleteDocument", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDocumentRequest"}, "output":{"shape":"DeleteDocumentResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentOperation"}, {"shape":"AssociatedInstances"} ], "documentation":"

Deletes the SSM document and all instance associations to the document.

Before you delete the SSM document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.

" }, "DeleteMaintenanceWindow":{ "name":"DeleteMaintenanceWindow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteMaintenanceWindowRequest"}, "output":{"shape":"DeleteMaintenanceWindowResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Deletes a Maintenance Window.

" }, "DeleteParameter":{ "name":"DeleteParameter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteParameterRequest"}, "output":{"shape":"DeleteParameterResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ParameterNotFound"} ], "documentation":"

Delete a parameter from the system.

" }, "DeletePatchBaseline":{ "name":"DeletePatchBaseline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePatchBaselineRequest"}, "output":{"shape":"DeletePatchBaselineResult"}, "errors":[ {"shape":"ResourceInUseException"}, {"shape":"InternalServerError"} ], "documentation":"

Deletes a patch baseline.

" }, "DeregisterManagedInstance":{ "name":"DeregisterManagedInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterManagedInstanceRequest"}, "output":{"shape":"DeregisterManagedInstanceResult"}, "errors":[ {"shape":"InvalidInstanceId"}, {"shape":"InternalServerError"} ], "documentation":"

Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don’t plan to use Run Command on the server, we suggest uninstalling the SSM agent first.

" }, "DeregisterPatchBaselineForPatchGroup":{ "name":"DeregisterPatchBaselineForPatchGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterPatchBaselineForPatchGroupRequest"}, "output":{"shape":"DeregisterPatchBaselineForPatchGroupResult"}, "errors":[ {"shape":"InvalidResourceId"}, {"shape":"InternalServerError"} ], "documentation":"

Removes a patch group from a patch baseline.

" }, "DeregisterTargetFromMaintenanceWindow":{ "name":"DeregisterTargetFromMaintenanceWindow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterTargetFromMaintenanceWindowRequest"}, "output":{"shape":"DeregisterTargetFromMaintenanceWindowResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Removes a target from a Maintenance Window.

" }, "DeregisterTaskFromMaintenanceWindow":{ "name":"DeregisterTaskFromMaintenanceWindow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterTaskFromMaintenanceWindowRequest"}, "output":{"shape":"DeregisterTaskFromMaintenanceWindowResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Removes a task from a Maintenance Window.

" }, "DescribeActivations":{ "name":"DescribeActivations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeActivationsRequest"}, "output":{"shape":"DescribeActivationsResult"}, "errors":[ {"shape":"InvalidFilter"}, {"shape":"InvalidNextToken"}, {"shape":"InternalServerError"} ], "documentation":"

Details about the activation, including: the date and time the activation was created, the expiration date, the IAM role assigned to the instances in the activation, and the number of instances activated by this registration.

" }, "DescribeAssociation":{ "name":"DescribeAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAssociationRequest"}, "output":{"shape":"DescribeAssociationResult"}, "errors":[ {"shape":"AssociationDoesNotExist"}, {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidInstanceId"} ], "documentation":"

Describes the associations for the specified SSM document or instance.

" }, "DescribeAutomationExecutions":{ "name":"DescribeAutomationExecutions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAutomationExecutionsRequest"}, "output":{"shape":"DescribeAutomationExecutionsResult"}, "errors":[ {"shape":"InvalidNextToken"}, {"shape":"InternalServerError"} ], "documentation":"

Provides details about all active and terminated Automation executions.

" }, "DescribeAvailablePatches":{ "name":"DescribeAvailablePatches", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAvailablePatchesRequest"}, "output":{"shape":"DescribeAvailablePatchesResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Lists all patches that could possibly be included in a patch baseline.

" }, "DescribeDocument":{ "name":"DescribeDocument", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDocumentRequest"}, "output":{"shape":"DescribeDocumentResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentVersion"} ], "documentation":"

Describes the specified SSM document.

" }, "DescribeDocumentPermission":{ "name":"DescribeDocumentPermission", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDocumentPermissionRequest"}, "output":{"shape":"DescribeDocumentPermissionResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidPermissionType"} ], "documentation":"

Describes the permissions for an SSM document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user’s AWS account ID) or publicly (All).

" }, "DescribeEffectiveInstanceAssociations":{ "name":"DescribeEffectiveInstanceAssociations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEffectiveInstanceAssociationsRequest"}, "output":{"shape":"DescribeEffectiveInstanceAssociationsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidNextToken"} ], "documentation":"

All associations for the instance(s).

" }, "DescribeEffectivePatchesForPatchBaseline":{ "name":"DescribeEffectivePatchesForPatchBaseline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEffectivePatchesForPatchBaselineRequest"}, "output":{"shape":"DescribeEffectivePatchesForPatchBaselineResult"}, "errors":[ {"shape":"InvalidResourceId"}, {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline.

" }, "DescribeInstanceAssociationsStatus":{ "name":"DescribeInstanceAssociationsStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceAssociationsStatusRequest"}, "output":{"shape":"DescribeInstanceAssociationsStatusResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidNextToken"} ], "documentation":"

The status of the associations for the instance(s).

" }, "DescribeInstanceInformation":{ "name":"DescribeInstanceInformation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstanceInformationRequest"}, "output":{"shape":"DescribeInstanceInformationResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidNextToken"}, {"shape":"InvalidInstanceInformationFilterValue"}, {"shape":"InvalidFilterKey"} ], "documentation":"

Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.

" }, "DescribeInstancePatchStates":{ "name":"DescribeInstancePatchStates", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancePatchStatesRequest"}, "output":{"shape":"DescribeInstancePatchStatesResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidNextToken"} ], "documentation":"

Retrieves the high-level patch state of one or more instances.

" }, "DescribeInstancePatchStatesForPatchGroup":{ "name":"DescribeInstancePatchStatesForPatchGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancePatchStatesForPatchGroupRequest"}, "output":{"shape":"DescribeInstancePatchStatesForPatchGroupResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidFilter"}, {"shape":"InvalidNextToken"} ], "documentation":"

Retrieves the high-level patch state for the instances in the specified patch group.

" }, "DescribeInstancePatches":{ "name":"DescribeInstancePatches", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancePatchesRequest"}, "output":{"shape":"DescribeInstancePatchesResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidFilter"}, {"shape":"InvalidNextToken"} ], "documentation":"

Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.

" }, "DescribeMaintenanceWindowExecutionTaskInvocations":{ "name":"DescribeMaintenanceWindowExecutionTaskInvocations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMaintenanceWindowExecutionTaskInvocationsRequest"}, "output":{"shape":"DescribeMaintenanceWindowExecutionTaskInvocationsResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Retrieves the individual task executions (one per target) for a particular task executed as part of a Maintenance Window execution.

" }, "DescribeMaintenanceWindowExecutionTasks":{ "name":"DescribeMaintenanceWindowExecutionTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMaintenanceWindowExecutionTasksRequest"}, "output":{"shape":"DescribeMaintenanceWindowExecutionTasksResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

For a given Maintenance Window execution, lists the tasks that were executed.

" }, "DescribeMaintenanceWindowExecutions":{ "name":"DescribeMaintenanceWindowExecutions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMaintenanceWindowExecutionsRequest"}, "output":{"shape":"DescribeMaintenanceWindowExecutionsResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Lists the executions of a Maintenance Window (meaning, information about when the Maintenance Window was scheduled to be active and information about tasks registered and run with the Maintenance Window).

" }, "DescribeMaintenanceWindowTargets":{ "name":"DescribeMaintenanceWindowTargets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMaintenanceWindowTargetsRequest"}, "output":{"shape":"DescribeMaintenanceWindowTargetsResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Lists the targets registered with the Maintenance Window.

" }, "DescribeMaintenanceWindowTasks":{ "name":"DescribeMaintenanceWindowTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMaintenanceWindowTasksRequest"}, "output":{"shape":"DescribeMaintenanceWindowTasksResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Lists the tasks in a Maintenance Window.

" }, "DescribeMaintenanceWindows":{ "name":"DescribeMaintenanceWindows", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMaintenanceWindowsRequest"}, "output":{"shape":"DescribeMaintenanceWindowsResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Retrieves the Maintenance Windows in an AWS account.

" }, "DescribeParameters":{ "name":"DescribeParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeParametersRequest"}, "output":{"shape":"DescribeParametersResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidFilterValue"}, {"shape":"InvalidNextToken"} ], "documentation":"

Get information about a parameter.

" }, "DescribePatchBaselines":{ "name":"DescribePatchBaselines", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePatchBaselinesRequest"}, "output":{"shape":"DescribePatchBaselinesResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Lists the patch baselines in your AWS account.

" }, "DescribePatchGroupState":{ "name":"DescribePatchGroupState", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePatchGroupStateRequest"}, "output":{"shape":"DescribePatchGroupStateResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidNextToken"} ], "documentation":"

Returns high-level aggregated patch compliance state for a patch group.

" }, "DescribePatchGroups":{ "name":"DescribePatchGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePatchGroupsRequest"}, "output":{"shape":"DescribePatchGroupsResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Lists all patch groups that have been registered with patch baselines.

" }, "GetAutomationExecution":{ "name":"GetAutomationExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAutomationExecutionRequest"}, "output":{"shape":"GetAutomationExecutionResult"}, "errors":[ {"shape":"AutomationExecutionNotFoundException"}, {"shape":"InternalServerError"} ], "documentation":"

Get detailed information about a particular Automation execution.

" }, "GetCommandInvocation":{ "name":"GetCommandInvocation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCommandInvocationRequest"}, "output":{"shape":"GetCommandInvocationResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidCommandId"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidPluginName"}, {"shape":"InvocationDoesNotExist"} ], "documentation":"

Returns detailed information about command execution for an invocation or plugin.

" }, "GetDefaultPatchBaseline":{ "name":"GetDefaultPatchBaseline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDefaultPatchBaselineRequest"}, "output":{"shape":"GetDefaultPatchBaselineResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Retrieves the default patch baseline.

" }, "GetDeployablePatchSnapshotForInstance":{ "name":"GetDeployablePatchSnapshotForInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDeployablePatchSnapshotForInstanceRequest"}, "output":{"shape":"GetDeployablePatchSnapshotForInstanceResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-ApplyPatchBaseline Systems Manager document.

" }, "GetDocument":{ "name":"GetDocument", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDocumentRequest"}, "output":{"shape":"GetDocumentResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentVersion"} ], "documentation":"

Gets the contents of the specified SSM document.

" }, "GetInventory":{ "name":"GetInventory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInventoryRequest"}, "output":{"shape":"GetInventoryResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidFilter"}, {"shape":"InvalidNextToken"}, {"shape":"InvalidTypeNameException"}, {"shape":"InvalidResultAttributeException"} ], "documentation":"

Query inventory information.

" }, "GetInventorySchema":{ "name":"GetInventorySchema", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInventorySchemaRequest"}, "output":{"shape":"GetInventorySchemaResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidTypeNameException"}, {"shape":"InvalidNextToken"} ], "documentation":"

Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

" }, "GetMaintenanceWindow":{ "name":"GetMaintenanceWindow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetMaintenanceWindowRequest"}, "output":{"shape":"GetMaintenanceWindowResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Retrieves a Maintenance Window.

" }, "GetMaintenanceWindowExecution":{ "name":"GetMaintenanceWindowExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetMaintenanceWindowExecutionRequest"}, "output":{"shape":"GetMaintenanceWindowExecutionResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Retrieves details about a specific task executed as part of a Maintenance Window execution.

" }, "GetMaintenanceWindowExecutionTask":{ "name":"GetMaintenanceWindowExecutionTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetMaintenanceWindowExecutionTaskRequest"}, "output":{"shape":"GetMaintenanceWindowExecutionTaskResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Retrieves the details about a specific task executed as part of a Maintenance Window execution.

" }, "GetParameterHistory":{ "name":"GetParameterHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetParameterHistoryRequest"}, "output":{"shape":"GetParameterHistoryResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"ParameterNotFound"}, {"shape":"InvalidNextToken"} ], "documentation":"

Query a list of all parameters used by the AWS account.

" }, "GetParameters":{ "name":"GetParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetParametersRequest"}, "output":{"shape":"GetParametersResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Get a list of parameters used by the AWS account.>

" }, "GetPatchBaseline":{ "name":"GetPatchBaseline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPatchBaselineRequest"}, "output":{"shape":"GetPatchBaselineResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InvalidResourceId"}, {"shape":"InternalServerError"} ], "documentation":"

Retrieves information about a patch baseline.

" }, "GetPatchBaselineForPatchGroup":{ "name":"GetPatchBaselineForPatchGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPatchBaselineForPatchGroupRequest"}, "output":{"shape":"GetPatchBaselineForPatchGroupResult"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Retrieves the patch baseline that should be used for the specified patch group.

" }, "ListAssociations":{ "name":"ListAssociations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAssociationsRequest"}, "output":{"shape":"ListAssociationsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidNextToken"} ], "documentation":"

Lists the associations for the specified SSM document or instance.

" }, "ListCommandInvocations":{ "name":"ListCommandInvocations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCommandInvocationsRequest"}, "output":{"shape":"ListCommandInvocationsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidCommandId"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidFilterKey"}, {"shape":"InvalidNextToken"} ], "documentation":"

An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.

" }, "ListCommands":{ "name":"ListCommands", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCommandsRequest"}, "output":{"shape":"ListCommandsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidCommandId"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidFilterKey"}, {"shape":"InvalidNextToken"} ], "documentation":"

Lists the commands requested by users of the AWS account.

" }, "ListDocumentVersions":{ "name":"ListDocumentVersions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDocumentVersionsRequest"}, "output":{"shape":"ListDocumentVersionsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidNextToken"}, {"shape":"InvalidDocument"} ], "documentation":"

List all versions for a document.

" }, "ListDocuments":{ "name":"ListDocuments", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDocumentsRequest"}, "output":{"shape":"ListDocumentsResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidNextToken"}, {"shape":"InvalidFilterKey"} ], "documentation":"

Describes one or more of your SSM documents.

" }, "ListInventoryEntries":{ "name":"ListInventoryEntries", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListInventoryEntriesRequest"}, "output":{"shape":"ListInventoryEntriesResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidTypeNameException"}, {"shape":"InvalidFilter"}, {"shape":"InvalidNextToken"} ], "documentation":"

A list of inventory items returned by the request.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResult"}, "errors":[ {"shape":"InvalidResourceType"}, {"shape":"InvalidResourceId"}, {"shape":"InternalServerError"} ], "documentation":"

Returns a list of the tags assigned to the specified resource.

" }, "ModifyDocumentPermission":{ "name":"ModifyDocumentPermission", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDocumentPermissionRequest"}, "output":{"shape":"ModifyDocumentPermissionResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidPermissionType"}, {"shape":"DocumentPermissionLimit"}, {"shape":"DocumentLimitExceeded"} ], "documentation":"

Share a document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

" }, "PutInventory":{ "name":"PutInventory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutInventoryRequest"}, "output":{"shape":"PutInventoryResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidTypeNameException"}, {"shape":"InvalidItemContentException"}, {"shape":"TotalSizeLimitExceededException"}, {"shape":"ItemSizeLimitExceededException"}, {"shape":"ItemContentMismatchException"}, {"shape":"CustomSchemaCountLimitExceededException"}, {"shape":"UnsupportedInventorySchemaVersionException"} ], "documentation":"

Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.

" }, "PutParameter":{ "name":"PutParameter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutParameterRequest"}, "output":{"shape":"PutParameterResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidKeyId"}, {"shape":"ParameterLimitExceeded"}, {"shape":"TooManyUpdates"}, {"shape":"ParameterAlreadyExists"}, {"shape":"UnsupportedParameterType"} ], "documentation":"

Add one or more paramaters to the system.

" }, "RegisterDefaultPatchBaseline":{ "name":"RegisterDefaultPatchBaseline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterDefaultPatchBaselineRequest"}, "output":{"shape":"RegisterDefaultPatchBaselineResult"}, "errors":[ {"shape":"InvalidResourceId"}, {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Defines the default patch baseline.

" }, "RegisterPatchBaselineForPatchGroup":{ "name":"RegisterPatchBaselineForPatchGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterPatchBaselineForPatchGroupRequest"}, "output":{"shape":"RegisterPatchBaselineForPatchGroupResult"}, "errors":[ {"shape":"AlreadyExistsException"}, {"shape":"DoesNotExistException"}, {"shape":"InvalidResourceId"}, {"shape":"ResourceLimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

Registers a patch baseline for a patch group.

" }, "RegisterTargetWithMaintenanceWindow":{ "name":"RegisterTargetWithMaintenanceWindow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterTargetWithMaintenanceWindowRequest"}, "output":{"shape":"RegisterTargetWithMaintenanceWindowResult"}, "errors":[ {"shape":"IdempotentParameterMismatch"}, {"shape":"DoesNotExistException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

Registers a target with a Maintenance Window.

" }, "RegisterTaskWithMaintenanceWindow":{ "name":"RegisterTaskWithMaintenanceWindow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterTaskWithMaintenanceWindowRequest"}, "output":{"shape":"RegisterTaskWithMaintenanceWindowResult"}, "errors":[ {"shape":"IdempotentParameterMismatch"}, {"shape":"DoesNotExistException"}, {"shape":"ResourceLimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

Adds a new task to a Maintenance Window.

" }, "RemoveTagsFromResource":{ "name":"RemoveTagsFromResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTagsFromResourceRequest"}, "output":{"shape":"RemoveTagsFromResourceResult"}, "errors":[ {"shape":"InvalidResourceType"}, {"shape":"InvalidResourceId"}, {"shape":"InternalServerError"} ], "documentation":"

Removes all tags from the specified resource.

" }, "SendCommand":{ "name":"SendCommand", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SendCommandRequest"}, "output":{"shape":"SendCommandResult"}, "errors":[ {"shape":"DuplicateInstanceId"}, {"shape":"InternalServerError"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidDocument"}, {"shape":"InvalidOutputFolder"}, {"shape":"InvalidParameters"}, {"shape":"UnsupportedPlatformType"}, {"shape":"MaxDocumentSizeExceeded"}, {"shape":"InvalidRole"}, {"shape":"InvalidNotificationConfig"} ], "documentation":"

Executes commands on one or more remote instances.

" }, "StartAutomationExecution":{ "name":"StartAutomationExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartAutomationExecutionRequest"}, "output":{"shape":"StartAutomationExecutionResult"}, "errors":[ {"shape":"AutomationDefinitionNotFoundException"}, {"shape":"InvalidAutomationExecutionParametersException"}, {"shape":"AutomationExecutionLimitExceededException"}, {"shape":"AutomationDefinitionVersionNotFoundException"}, {"shape":"InternalServerError"} ], "documentation":"

Initiates execution of an Automation document.

" }, "StopAutomationExecution":{ "name":"StopAutomationExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopAutomationExecutionRequest"}, "output":{"shape":"StopAutomationExecutionResult"}, "errors":[ {"shape":"AutomationExecutionNotFoundException"}, {"shape":"InternalServerError"} ], "documentation":"

Stop an Automation that is currently executing.

" }, "UpdateAssociation":{ "name":"UpdateAssociation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAssociationRequest"}, "output":{"shape":"UpdateAssociationResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidSchedule"}, {"shape":"InvalidParameters"}, {"shape":"InvalidOutputLocation"}, {"shape":"InvalidDocumentVersion"}, {"shape":"AssociationDoesNotExist"}, {"shape":"InvalidUpdate"}, {"shape":"TooManyUpdates"} ], "documentation":"

Updates an association. You can only update the document version, schedule, parameters, and Amazon S3 output of an association.

" }, "UpdateAssociationStatus":{ "name":"UpdateAssociationStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAssociationStatusRequest"}, "output":{"shape":"UpdateAssociationStatusResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidInstanceId"}, {"shape":"InvalidDocument"}, {"shape":"AssociationDoesNotExist"}, {"shape":"StatusUnchanged"}, {"shape":"TooManyUpdates"} ], "documentation":"

Updates the status of the SSM document associated with the specified instance.

" }, "UpdateDocument":{ "name":"UpdateDocument", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDocumentRequest"}, "output":{"shape":"UpdateDocumentResult"}, "errors":[ {"shape":"MaxDocumentSizeExceeded"}, {"shape":"DocumentVersionLimitExceeded"}, {"shape":"InternalServerError"}, {"shape":"DuplicateDocumentContent"}, {"shape":"InvalidDocumentContent"}, {"shape":"InvalidDocumentVersion"}, {"shape":"InvalidDocumentSchemaVersion"}, {"shape":"InvalidDocument"} ], "documentation":"

The document you want to update.

" }, "UpdateDocumentDefaultVersion":{ "name":"UpdateDocumentDefaultVersion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDocumentDefaultVersionRequest"}, "output":{"shape":"UpdateDocumentDefaultVersionResult"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidDocument"}, {"shape":"InvalidDocumentVersion"}, {"shape":"InvalidDocumentSchemaVersion"} ], "documentation":"

Set the default version of a document.

" }, "UpdateMaintenanceWindow":{ "name":"UpdateMaintenanceWindow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateMaintenanceWindowRequest"}, "output":{"shape":"UpdateMaintenanceWindowResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Updates an existing Maintenance Window. Only specified parameters are modified.

" }, "UpdateManagedInstanceRole":{ "name":"UpdateManagedInstanceRole", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateManagedInstanceRoleRequest"}, "output":{"shape":"UpdateManagedInstanceRoleResult"}, "errors":[ {"shape":"InvalidInstanceId"}, {"shape":"InternalServerError"} ], "documentation":"

Assigns or changes an Amazon Identity and Access Management (IAM) role to the managed instance.

" }, "UpdatePatchBaseline":{ "name":"UpdatePatchBaseline", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdatePatchBaselineRequest"}, "output":{"shape":"UpdatePatchBaselineResult"}, "errors":[ {"shape":"DoesNotExistException"}, {"shape":"InternalServerError"} ], "documentation":"

Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

" } }, "shapes":{ "AccountId":{ "type":"string", "pattern":"(?i)all|[0-9]{12}" }, "AccountIdList":{ "type":"list", "member":{ "shape":"AccountId", "locationName":"AccountId" }, "max":20 }, "Activation":{ "type":"structure", "members":{ "ActivationId":{ "shape":"ActivationId", "documentation":"

The ID created by Systems Manager when you submitted the activation.

" }, "Description":{ "shape":"ActivationDescription", "documentation":"

A user defined description of the activation.

" }, "DefaultInstanceName":{ "shape":"DefaultInstanceName", "documentation":"

A name for the managed instance when it is created.

" }, "IamRole":{ "shape":"IamRole", "documentation":"

The Amazon Identity and Access Management (IAM) role to assign to the managed instance.

" }, "RegistrationLimit":{ "shape":"RegistrationLimit", "documentation":"

The maximum number of managed instances that can be registered using this activation.

" }, "RegistrationsCount":{ "shape":"RegistrationsCount", "documentation":"

The number of managed instances already registered with this activation.

" }, "ExpirationDate":{ "shape":"ExpirationDate", "documentation":"

The date when this activation can no longer be used to register managed instances.

" }, "Expired":{ "shape":"Boolean", "documentation":"

Whether or not the activation is expired.

" }, "CreatedDate":{ "shape":"CreatedDate", "documentation":"

The date the activation was created.

" } }, "documentation":"

An activation registers one or more on-premises servers or virtual machines (VMs) with AWS so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with AWS is called a managed instance.

" }, "ActivationCode":{ "type":"string", "max":250, "min":20 }, "ActivationDescription":{ "type":"string", "max":256, "min":0 }, "ActivationId":{ "type":"string", "pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "ActivationList":{ "type":"list", "member":{"shape":"Activation"} }, "AddTagsToResourceRequest":{ "type":"structure", "required":[ "ResourceType", "ResourceId", "Tags" ], "members":{ "ResourceType":{ "shape":"ResourceTypeForTagging", "documentation":"

Specifies the type of resource you are tagging.

" }, "ResourceId":{ "shape":"ResourceId", "documentation":"

The resource ID you want to tag.

" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

" } } }, "AddTagsToResourceResult":{ "type":"structure", "members":{ } }, "AgentErrorCode":{ "type":"string", "max":10 }, "AlreadyExistsException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

Error returned if an attempt is made to register a patch group with a patch baseline that is already registered with a different patch baseline.

", "exception":true }, "ApproveAfterDays":{ "type":"integer", "max":100, "min":0 }, "AssociatedInstances":{ "type":"structure", "members":{ }, "documentation":"

You must disassociate an SSM document from all instances before you can delete it.

", "exception":true }, "Association":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the SSM document.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The ID of the instance.

" }, "AssociationId":{ "shape":"AssociationId", "documentation":"

The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The version of the document used in the association.

" }, "Targets":{ "shape":"Targets", "documentation":"

The instances targeted by the request to create an association.

" }, "LastExecutionDate":{ "shape":"DateTime", "documentation":"

The date on which the association was last run.

" }, "Overview":{ "shape":"AssociationOverview", "documentation":"

Information about the association.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

A cron expression that specifies a schedule when the association runs.

" } }, "documentation":"

Describes an association of an SSM document and an instance.

" }, "AssociationAlreadyExists":{ "type":"structure", "members":{ }, "documentation":"

The specified association already exists.

", "exception":true }, "AssociationDescription":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the SSM document.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The ID of the instance.

" }, "Date":{ "shape":"DateTime", "documentation":"

The date when the association was made.

" }, "LastUpdateAssociationDate":{ "shape":"DateTime", "documentation":"

The date when the association was last updated.

" }, "Status":{ "shape":"AssociationStatus", "documentation":"

The association status.

" }, "Overview":{ "shape":"AssociationOverview", "documentation":"

Information about the association.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

A description of the parameters for a document.

" }, "AssociationId":{ "shape":"AssociationId", "documentation":"

The association ID.

" }, "Targets":{ "shape":"Targets", "documentation":"

The instances targeted by the request.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

A cron expression that specifies a schedule when the association runs.

" }, "OutputLocation":{ "shape":"InstanceAssociationOutputLocation", "documentation":"

An Amazon S3 bucket where you want to store the output details of the request.

" }, "LastExecutionDate":{ "shape":"DateTime", "documentation":"

The date on which the association was last run.

" }, "LastSuccessfulExecutionDate":{ "shape":"DateTime", "documentation":"

The last date on which the association was successfully run.

" } }, "documentation":"

Describes the parameters for a document.

" }, "AssociationDescriptionList":{ "type":"list", "member":{ "shape":"AssociationDescription", "locationName":"AssociationDescription" } }, "AssociationDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified association does not exist.

", "exception":true }, "AssociationFilter":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"AssociationFilterKey", "documentation":"

The name of the filter.

" }, "value":{ "shape":"AssociationFilterValue", "documentation":"

The filter value.

" } }, "documentation":"

Describes a filter.

" }, "AssociationFilterKey":{ "type":"string", "enum":[ "InstanceId", "Name", "AssociationId", "AssociationStatusName", "LastExecutedBefore", "LastExecutedAfter" ] }, "AssociationFilterList":{ "type":"list", "member":{ "shape":"AssociationFilter", "locationName":"AssociationFilter" }, "min":1 }, "AssociationFilterValue":{ "type":"string", "min":1 }, "AssociationId":{ "type":"string", "pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" }, "AssociationLimitExceeded":{ "type":"structure", "members":{ }, "documentation":"

You can have at most 2,000 active associations.

", "exception":true }, "AssociationList":{ "type":"list", "member":{ "shape":"Association", "locationName":"Association" } }, "AssociationOverview":{ "type":"structure", "members":{ "Status":{ "shape":"StatusName", "documentation":"

The status of the association. Status can be: Pending, Success, or Failed.

" }, "DetailedStatus":{ "shape":"StatusName", "documentation":"

A detailed status of the association.

" }, "AssociationStatusAggregatedCount":{ "shape":"AssociationStatusAggregatedCount", "documentation":"

Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status.

" } }, "documentation":"

Information about the association.

" }, "AssociationStatus":{ "type":"structure", "required":[ "Date", "Name", "Message" ], "members":{ "Date":{ "shape":"DateTime", "documentation":"

The date when the status changed.

" }, "Name":{ "shape":"AssociationStatusName", "documentation":"

The status.

" }, "Message":{ "shape":"StatusMessage", "documentation":"

The reason for the status.

" }, "AdditionalInfo":{ "shape":"StatusAdditionalInfo", "documentation":"

A user-defined string.

" } }, "documentation":"

Describes an association status.

" }, "AssociationStatusAggregatedCount":{ "type":"map", "key":{"shape":"StatusName"}, "value":{"shape":"InstanceCount"} }, "AssociationStatusName":{ "type":"string", "enum":[ "Pending", "Success", "Failed" ] }, "AttributeName":{ "type":"string", "max":64, "min":1 }, "AttributeValue":{ "type":"string", "max":1024, "min":0 }, "AutomationActionName":{ "type":"string", "pattern":"^aws:[a-zA-Z]{3,25}$" }, "AutomationDefinitionNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

An Automation document with the specified name could not be found.

", "exception":true }, "AutomationDefinitionVersionNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

An Automation document with the specified name and version could not be found.

", "exception":true }, "AutomationExecution":{ "type":"structure", "members":{ "AutomationExecutionId":{ "shape":"AutomationExecutionId", "documentation":"

The execution ID.

" }, "DocumentName":{ "shape":"DocumentName", "documentation":"

The name of the Automation document used during the execution.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The version of the document to use during execution.

" }, "ExecutionStartTime":{ "shape":"DateTime", "documentation":"

The time the execution started.

" }, "ExecutionEndTime":{ "shape":"DateTime", "documentation":"

The time the execution finished.

" }, "AutomationExecutionStatus":{ "shape":"AutomationExecutionStatus", "documentation":"

The execution status of the Automation.

" }, "StepExecutions":{ "shape":"StepExecutionList", "documentation":"

A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are executed in order.

" }, "Parameters":{ "shape":"AutomationParameterMap", "documentation":"

The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

" }, "Outputs":{ "shape":"AutomationParameterMap", "documentation":"

The list of execution outputs as defined in the automation document.

" }, "FailureMessage":{ "shape":"String", "documentation":"

A message describing why an execution has failed, if the status is set to Failed.

" } }, "documentation":"

Detailed information about the current state of an individual Automation execution.

" }, "AutomationExecutionFilter":{ "type":"structure", "required":[ "Key", "Values" ], "members":{ "Key":{ "shape":"AutomationExecutionFilterKey", "documentation":"

The aspect of the Automation execution information that should be limited.

" }, "Values":{ "shape":"AutomationExecutionFilterValueList", "documentation":"

The values used to limit the execution information associated with the filter's key.

" } }, "documentation":"

A filter used to match specific automation executions. This is used to limit the scope of Automation execution information returned.

" }, "AutomationExecutionFilterKey":{ "type":"string", "enum":[ "DocumentNamePrefix", "ExecutionStatus" ] }, "AutomationExecutionFilterList":{ "type":"list", "member":{"shape":"AutomationExecutionFilter"}, "max":10, "min":1 }, "AutomationExecutionFilterValue":{ "type":"string", "max":150, "min":1 }, "AutomationExecutionFilterValueList":{ "type":"list", "member":{"shape":"AutomationExecutionFilterValue"}, "max":10, "min":1 }, "AutomationExecutionId":{ "type":"string", "max":36, "min":36 }, "AutomationExecutionLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The number of simultaneously running Automation executions exceeded the allowable limit.

", "exception":true }, "AutomationExecutionMetadata":{ "type":"structure", "members":{ "AutomationExecutionId":{ "shape":"AutomationExecutionId", "documentation":"

The execution ID.

" }, "DocumentName":{ "shape":"DocumentName", "documentation":"

The name of the Automation document used during execution.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version used during the execution.

" }, "AutomationExecutionStatus":{ "shape":"AutomationExecutionStatus", "documentation":"

The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.

" }, "ExecutionStartTime":{ "shape":"DateTime", "documentation":"

The time the execution started.>

" }, "ExecutionEndTime":{ "shape":"DateTime", "documentation":"

The time the execution finished. This is not populated if the execution is still in progress.

" }, "ExecutedBy":{ "shape":"String", "documentation":"

The IAM role ARN of the user who executed the Automation.

" }, "LogFile":{ "shape":"String", "documentation":"

An Amazon S3 bucket where execution information is stored.

" }, "Outputs":{ "shape":"AutomationParameterMap", "documentation":"

The list of execution outputs as defined in the Automation document.

" } }, "documentation":"

Details about a specific Automation execution.

" }, "AutomationExecutionMetadataList":{ "type":"list", "member":{"shape":"AutomationExecutionMetadata"}, "max":50, "min":0 }, "AutomationExecutionNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

There is no automation execution information for the requested automation execution ID.

", "exception":true }, "AutomationExecutionStatus":{ "type":"string", "enum":[ "Pending", "InProgress", "Success", "TimedOut", "Cancelled", "Failed" ] }, "AutomationParameterKey":{ "type":"string", "max":30, "min":1 }, "AutomationParameterMap":{ "type":"map", "key":{"shape":"AutomationParameterKey"}, "value":{"shape":"AutomationParameterValueList"}, "max":200, "min":1 }, "AutomationParameterValue":{ "type":"string", "max":512, "min":1 }, "AutomationParameterValueList":{ "type":"list", "member":{"shape":"AutomationParameterValue"}, "max":10, "min":0 }, "BaselineDescription":{ "type":"string", "max":1024, "min":1 }, "BaselineId":{ "type":"string", "max":128, "min":20, "pattern":"^[a-zA-Z0-9_\\-:/]{20,128}$" }, "BaselineName":{ "type":"string", "max":128, "min":3, "pattern":"^[a-zA-Z0-9_\\-.]{3,128}$" }, "BatchErrorMessage":{"type":"string"}, "Boolean":{"type":"boolean"}, "CancelCommandRequest":{ "type":"structure", "required":["CommandId"], "members":{ "CommandId":{ "shape":"CommandId", "documentation":"

The ID of the command you want to cancel.

" }, "InstanceIds":{ "shape":"InstanceIdList", "documentation":"

(Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.

" } }, "documentation":"

" }, "CancelCommandResult":{ "type":"structure", "members":{ }, "documentation":"

Whether or not the command was successfully canceled. There is no guarantee that a request can be canceled.

" }, "ClientToken":{ "type":"string", "max":64, "min":1 }, "Command":{ "type":"structure", "members":{ "CommandId":{ "shape":"CommandId", "documentation":"

A unique identifier for this command.

" }, "DocumentName":{ "shape":"DocumentName", "documentation":"

The name of the SSM document requested for execution.

" }, "Comment":{ "shape":"Comment", "documentation":"

User-specified information about the command, such as a brief description of what the command should do.

" }, "ExpiresAfter":{ "shape":"DateTime", "documentation":"

If this time is reached and the command has not already started executing, it will not execute. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

The parameter values to be inserted in the SSM document when executing the command.

" }, "InstanceIds":{ "shape":"InstanceIdList", "documentation":"

The instance IDs against which this command was requested.

" }, "Targets":{ "shape":"Targets", "documentation":"

An array of search criteria that targets instances using a Key;Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.

" }, "RequestedDateTime":{ "shape":"DateTime", "documentation":"

The date and time the command was requested.

" }, "Status":{ "shape":"CommandStatus", "documentation":"

The status of the command.

" }, "StatusDetails":{ "shape":"StatusDetails", "documentation":"

A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Monitor Commands (Linux) or Monitor Commands (Windows). StatusDetails can be one of the following values:

  • Pending – The command has not been sent to any instances.

  • In Progress – The command has been sent to at least one instance but has not reached a final state on all instances.

  • Success – The command successfully executed on all invocations. This is a terminal state.

  • Delivery Timed Out – The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

  • Execution Timed Out – The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

  • Failed – The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

  • Incomplete – The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

  • Canceled – The command was terminated before it was completed. This is a terminal state.

  • Rate Exceeded – The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before executing it on any instance. This is a terminal state.

" }, "OutputS3Region":{ "shape":"S3Region", "documentation":"

The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located. The default value is the region where Run Command is being called.

" }, "OutputS3BucketName":{ "shape":"S3BucketName", "documentation":"

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

" }, "OutputS3KeyPrefix":{ "shape":"S3KeyPrefix", "documentation":"

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

" }, "MaxConcurrency":{ "shape":"VelocityConstraint", "documentation":"

The maximum number of instances that are allowed to execute the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).

" }, "MaxErrors":{ "shape":"VelocityConstraint", "documentation":"

The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 50. For more information about how to use MaxErrors, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).

" }, "TargetCount":{ "shape":"TargetCount", "documentation":"

The number of targets for the command.

" }, "CompletedCount":{ "shape":"CompletedCount", "documentation":"

The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.

" }, "ErrorCount":{ "shape":"ErrorCount", "documentation":"

The number of targets for which the status is Failed or Execution Timed Out.

" }, "ServiceRole":{ "shape":"ServiceRole", "documentation":"

The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.

" }, "NotificationConfig":{ "shape":"NotificationConfig", "documentation":"

Configurations for sending notifications about command status changes.

" } }, "documentation":"

Describes a command request.

" }, "CommandFilter":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"CommandFilterKey", "documentation":"

The name of the filter. For example, requested date and time.

" }, "value":{ "shape":"CommandFilterValue", "documentation":"

The filter value. For example: June 30, 2015.

" } }, "documentation":"

Describes a command filter.

" }, "CommandFilterKey":{ "type":"string", "enum":[ "InvokedAfter", "InvokedBefore", "Status" ] }, "CommandFilterList":{ "type":"list", "member":{"shape":"CommandFilter"}, "max":3, "min":1 }, "CommandFilterValue":{ "type":"string", "min":1 }, "CommandId":{ "type":"string", "max":36, "min":36 }, "CommandInvocation":{ "type":"structure", "members":{ "CommandId":{ "shape":"CommandId", "documentation":"

The command against which this invocation was requested.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The instance ID in which this invocation was requested.

" }, "InstanceName":{ "shape":"InstanceTagName", "documentation":"

The name of the invocation target. For Amazon EC2 instances this is the value for the aws:Name tag. For on-premises instances, this is the name of the instance.

" }, "Comment":{ "shape":"Comment", "documentation":"

User-specified information about the command, such as a brief description of what the command should do.

" }, "DocumentName":{ "shape":"DocumentName", "documentation":"

The document name that was requested for execution.

" }, "RequestedDateTime":{ "shape":"DateTime", "documentation":"

The time and date the request was sent to this instance.

" }, "Status":{ "shape":"CommandInvocationStatus", "documentation":"

Whether or not the invocation succeeded, failed, or is pending.

" }, "StatusDetails":{ "shape":"StatusDetails", "documentation":"

A detailed status of the command execution for each invocation (each instance targeted by the command). StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Monitor Commands (Linux) or Monitor Commands (Windows). StatusDetails can be one of the following values:

  • Pending – The command has not been sent to the instance.

  • In Progress – The command has been sent to the instance but has not reached a terminal state.

  • Success – The execution of the command or plugin was successfully completed. This is a terminal state.

  • Delivery Timed Out – The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command’s MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

  • Execution Timed Out – Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

  • Failed – The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

  • Canceled – The command was terminated before it was completed. This is a terminal state.

  • Undeliverable – The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command’s MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

  • Terminated – The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

" }, "TraceOutput":{ "shape":"InvocationTraceOutput", "documentation":"

Gets the trace output sent by the agent.

" }, "StandardOutputUrl":{ "shape":"Url", "documentation":"

The URL to the plugin’s StdOut file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.

" }, "StandardErrorUrl":{ "shape":"Url", "documentation":"

The URL to the plugin’s StdErr file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.

" }, "CommandPlugins":{"shape":"CommandPluginList"}, "ServiceRole":{ "shape":"ServiceRole", "documentation":"

The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes on a per instance basis.

" }, "NotificationConfig":{ "shape":"NotificationConfig", "documentation":"

Configurations for sending notifications about command status changes on a per instance basis.

" } }, "documentation":"

An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user executes SendCommand against three instances, then a command invocation is created for each requested instance ID. A command invocation returns status and detail information about a command you executed.

" }, "CommandInvocationList":{ "type":"list", "member":{"shape":"CommandInvocation"} }, "CommandInvocationStatus":{ "type":"string", "enum":[ "Pending", "InProgress", "Delayed", "Success", "Cancelled", "TimedOut", "Failed", "Cancelling" ] }, "CommandList":{ "type":"list", "member":{"shape":"Command"} }, "CommandMaxResults":{ "type":"integer", "max":50, "min":1 }, "CommandPlugin":{ "type":"structure", "members":{ "Name":{ "shape":"CommandPluginName", "documentation":"

The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.

" }, "Status":{ "shape":"CommandPluginStatus", "documentation":"

The status of this plugin. You can execute a document with multiple plugins.

" }, "StatusDetails":{ "shape":"StatusDetails", "documentation":"

A detailed status of the plugin execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Monitor Commands (Linux) or Monitor Commands (Windows). StatusDetails can be one of the following values:

  • Pending – The command has not been sent to the instance.

  • In Progress – The command has been sent to the instance but has not reached a terminal state.

  • Success – The execution of the command or plugin was successfully completed. This is a terminal state.

  • Delivery Timed Out – The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command’s MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

  • Execution Timed Out – Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

  • Failed – The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

  • Canceled – The command was terminated before it was completed. This is a terminal state.

  • Undeliverable – The command can't be delivered to the instance. The instance might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command’s MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

  • Terminated – The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

" }, "ResponseCode":{ "shape":"ResponseCode", "documentation":"

A numeric response code generated after executing the plugin.

" }, "ResponseStartDateTime":{ "shape":"DateTime", "documentation":"

The time the plugin started executing.

" }, "ResponseFinishDateTime":{ "shape":"DateTime", "documentation":"

The time the plugin stopped executing. Could stop prematurely if, for example, a cancel command was sent.

" }, "Output":{ "shape":"CommandPluginOutput", "documentation":"

Output of the plugin execution.

" }, "StandardOutputUrl":{ "shape":"Url", "documentation":"

The URL for the complete text written by the plugin to stdout in Amazon S3. If the Amazon S3 bucket for the command was not specified, then this string is empty.

" }, "StandardErrorUrl":{ "shape":"Url", "documentation":"

The URL for the complete text written by the plugin to stderr. If execution is not yet complete, then this string is empty.

" }, "OutputS3Region":{ "shape":"S3Region", "documentation":"

The name of the region where the output is stored in Amazon S3.

" }, "OutputS3BucketName":{ "shape":"S3BucketName", "documentation":"

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:

test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript

test_folder is the name of the Amazon S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-1234567876543 is the instance ID;

awsrunShellScript is the name of the plugin.

" }, "OutputS3KeyPrefix":{ "shape":"S3KeyPrefix", "documentation":"

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:

test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript

test_folder is the name of the Amazon S3 bucket;

ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

i-1234567876543 is the instance ID;

awsrunShellScript is the name of the plugin.

" } }, "documentation":"

Describes plugin details.

" }, "CommandPluginList":{ "type":"list", "member":{"shape":"CommandPlugin"} }, "CommandPluginName":{ "type":"string", "min":4 }, "CommandPluginOutput":{ "type":"string", "max":2500 }, "CommandPluginStatus":{ "type":"string", "enum":[ "Pending", "InProgress", "Success", "TimedOut", "Cancelled", "Failed" ] }, "CommandStatus":{ "type":"string", "enum":[ "Pending", "InProgress", "Success", "Cancelled", "Failed", "TimedOut", "Cancelling" ] }, "Comment":{ "type":"string", "max":100 }, "CompletedCount":{"type":"integer"}, "ComputerName":{ "type":"string", "max":255, "min":1 }, "CreateActivationRequest":{ "type":"structure", "required":["IamRole"], "members":{ "Description":{ "shape":"ActivationDescription", "documentation":"

A user-defined description of the resource that you want to register with Amazon EC2.

" }, "DefaultInstanceName":{ "shape":"DefaultInstanceName", "documentation":"

The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources.

" }, "IamRole":{ "shape":"IamRole", "documentation":"

The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance.

" }, "RegistrationLimit":{ "shape":"RegistrationLimit", "documentation":"

Specify the maximum number of managed instances you want to register. The default value is 1 instance.

", "box":true }, "ExpirationDate":{ "shape":"ExpirationDate", "documentation":"

The date by which this activation request should expire. The default value is 24 hours.

" } } }, "CreateActivationResult":{ "type":"structure", "members":{ "ActivationId":{ "shape":"ActivationId", "documentation":"

The ID number generated by the system when it processed the activation. The activation ID functions like a user name.

" }, "ActivationCode":{ "shape":"ActivationCode", "documentation":"

The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.

" } } }, "CreateAssociationBatchRequest":{ "type":"structure", "required":["Entries"], "members":{ "Entries":{ "shape":"CreateAssociationBatchRequestEntries", "documentation":"

One or more associations.

" } } }, "CreateAssociationBatchRequestEntries":{ "type":"list", "member":{ "shape":"CreateAssociationBatchRequestEntry", "locationName":"entries" }, "min":1 }, "CreateAssociationBatchRequestEntry":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the configuration document.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The ID of the instance.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

A description of the parameters for a document.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version.

" }, "Targets":{ "shape":"Targets", "documentation":"

The instances targeted by the request.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

A cron expression that specifies a schedule when the association runs.

" }, "OutputLocation":{ "shape":"InstanceAssociationOutputLocation", "documentation":"

An Amazon S3 bucket where you want to store the results of this request.

" } }, "documentation":"

Describes the association of an SSM document and an instance.

" }, "CreateAssociationBatchResult":{ "type":"structure", "members":{ "Successful":{ "shape":"AssociationDescriptionList", "documentation":"

Information about the associations that succeeded.

" }, "Failed":{ "shape":"FailedCreateAssociationList", "documentation":"

Information about the associations that failed.

" } } }, "CreateAssociationRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the SSM document.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version you want to associate with the target(s). Can be a specific version or the default version.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The instance ID.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

The parameters for the documents runtime configuration.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets (either instances or tags) for the association. Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

A cron expression when the association will be applied to the target(s). Supported expressions are every half, 1, 2, 4, 8 or 12 hour(s); every specified day and time of the week. For example: cron(0 0/30 * 1/1 * ? *) to run every thirty minutes; cron(0 0 0/4 1/1 * ? *) to run every four hours; and cron(0 0 10 ? * SUN *) to run every Sunday at 10 a.m.

" }, "OutputLocation":{ "shape":"InstanceAssociationOutputLocation", "documentation":"

An Amazon S3 bucket where you want to store the output details of the request. For example:

\"{ \\\"S3Location\\\": { \\\"OutputS3Region\\\": \\\"<region>\\\", \\\"OutputS3BucketName\\\": \\\"bucket name\\\", \\\"OutputS3KeyPrefix\\\": \\\"folder name\\\" } }\"

" } } }, "CreateAssociationResult":{ "type":"structure", "members":{ "AssociationDescription":{ "shape":"AssociationDescription", "documentation":"

Information about the association.

" } } }, "CreateDocumentRequest":{ "type":"structure", "required":[ "Content", "Name" ], "members":{ "Content":{ "shape":"DocumentContent", "documentation":"

A valid JSON string.

" }, "Name":{ "shape":"DocumentName", "documentation":"

A name for the SSM document.

" }, "DocumentType":{ "shape":"DocumentType", "documentation":"

The type of document to create. Valid document types include: Policy, Automation, and Command.

" } } }, "CreateDocumentResult":{ "type":"structure", "members":{ "DocumentDescription":{ "shape":"DocumentDescription", "documentation":"

Information about the SSM document.

" } } }, "CreateMaintenanceWindowRequest":{ "type":"structure", "required":[ "Name", "Schedule", "Duration", "Cutoff", "AllowUnassociatedTargets" ], "members":{ "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The name of the Maintenance Window.

" }, "Schedule":{ "shape":"MaintenanceWindowSchedule", "documentation":"

The schedule of the Maintenance Window in the form of a cron or rate expression.

" }, "Duration":{ "shape":"MaintenanceWindowDurationHours", "documentation":"

The duration of the Maintenance Window in hours.

" }, "Cutoff":{ "shape":"MaintenanceWindowCutoff", "documentation":"

The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

" }, "AllowUnassociatedTargets":{ "shape":"MaintenanceWindowAllowUnassociatedTargets", "documentation":"

Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

User-provided idempotency token.

", "idempotencyToken":true } } }, "CreateMaintenanceWindowResult":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the created Maintenance Window.

" } } }, "CreatePatchBaselineRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"BaselineName", "documentation":"

The name of the patch baseline.

" }, "GlobalFilters":{ "shape":"PatchFilterGroup", "documentation":"

A set of global filters used to exclude patches from the baseline.

" }, "ApprovalRules":{ "shape":"PatchRuleGroup", "documentation":"

A set of rules used to include patches in the baseline.

" }, "ApprovedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly approved patches for the baseline.

" }, "RejectedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly rejected patches for the baseline.

" }, "Description":{ "shape":"BaselineDescription", "documentation":"

A description of the patch baseline.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

Caller-provided idempotency token.

", "idempotencyToken":true } } }, "CreatePatchBaselineResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the created patch baseline.

" } } }, "CreatedDate":{"type":"timestamp"}, "CustomSchemaCountLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.

", "exception":true }, "DateTime":{"type":"timestamp"}, "DefaultBaseline":{"type":"boolean"}, "DefaultInstanceName":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "DeleteActivationRequest":{ "type":"structure", "required":["ActivationId"], "members":{ "ActivationId":{ "shape":"ActivationId", "documentation":"

The ID of the activation that you want to delete.

" } } }, "DeleteActivationResult":{ "type":"structure", "members":{ } }, "DeleteAssociationRequest":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the SSM document.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The ID of the instance.

" }, "AssociationId":{ "shape":"AssociationId", "documentation":"

The association ID that you want to delete.

" } } }, "DeleteAssociationResult":{ "type":"structure", "members":{ } }, "DeleteDocumentRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the SSM document.

" } } }, "DeleteDocumentResult":{ "type":"structure", "members":{ } }, "DeleteMaintenanceWindowRequest":{ "type":"structure", "required":["WindowId"], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the Maintenance Window to delete.

" } } }, "DeleteMaintenanceWindowResult":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the deleted Maintenance Window.

" } } }, "DeleteParameterRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"PSParameterName", "documentation":"

The name of the parameter to delete.

" } } }, "DeleteParameterResult":{ "type":"structure", "members":{ } }, "DeletePatchBaselineRequest":{ "type":"structure", "required":["BaselineId"], "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline to delete.

" } } }, "DeletePatchBaselineResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the deleted patch baseline.

" } } }, "DeregisterManagedInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"ManagedInstanceId", "documentation":"

The ID assigned to the managed instance when you registered it using the activation process.

" } } }, "DeregisterManagedInstanceResult":{ "type":"structure", "members":{ } }, "DeregisterPatchBaselineForPatchGroupRequest":{ "type":"structure", "required":[ "BaselineId", "PatchGroup" ], "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline to deregister the patch group from.

" }, "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group that should be deregistered from the patch baseline.

" } } }, "DeregisterPatchBaselineForPatchGroupResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline the patch group was deregistered from.

" }, "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group deregistered from the patch baseline.

" } } }, "DeregisterTargetFromMaintenanceWindowRequest":{ "type":"structure", "required":[ "WindowId", "WindowTargetId" ], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the Maintenance Window the target should be removed from.

" }, "WindowTargetId":{ "shape":"MaintenanceWindowTargetId", "documentation":"

The ID of the target definition to remove.

" } } }, "DeregisterTargetFromMaintenanceWindowResult":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the Maintenance Window the target was removed from.

" }, "WindowTargetId":{ "shape":"MaintenanceWindowTargetId", "documentation":"

The ID of the removed target definition.

" } } }, "DeregisterTaskFromMaintenanceWindowRequest":{ "type":"structure", "required":[ "WindowId", "WindowTaskId" ], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the Maintenance Window the task should be removed from.

" }, "WindowTaskId":{ "shape":"MaintenanceWindowTaskId", "documentation":"

The ID of the task to remove from the Maintenance Window.

" } } }, "DeregisterTaskFromMaintenanceWindowResult":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the Maintenance Window the task was removed from.

" }, "WindowTaskId":{ "shape":"MaintenanceWindowTaskId", "documentation":"

The ID of the task removed from the Maintenance Window.

" } } }, "DescribeActivationsFilter":{ "type":"structure", "members":{ "FilterKey":{ "shape":"DescribeActivationsFilterKeys", "documentation":"

The name of the filter.

" }, "FilterValues":{ "shape":"StringList", "documentation":"

The filter values.

" } }, "documentation":"

Filter for the DescribeActivation API.

" }, "DescribeActivationsFilterKeys":{ "type":"string", "enum":[ "ActivationIds", "DefaultInstanceName", "IamRole" ] }, "DescribeActivationsFilterList":{ "type":"list", "member":{"shape":"DescribeActivationsFilter"} }, "DescribeActivationsRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"DescribeActivationsFilterList", "documentation":"

A filter to view information about your activations.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

A token to start the list. Use this token to get the next set of results.

" } } }, "DescribeActivationsResult":{ "type":"structure", "members":{ "ActivationList":{ "shape":"ActivationList", "documentation":"

A list of activations for your AWS account.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. Use this token to get the next set of results.

" } } }, "DescribeAssociationRequest":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the SSM document.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The instance ID.

" }, "AssociationId":{ "shape":"AssociationId", "documentation":"

The association ID for which you want information.

" } } }, "DescribeAssociationResult":{ "type":"structure", "members":{ "AssociationDescription":{ "shape":"AssociationDescription", "documentation":"

Information about the association.

" } } }, "DescribeAutomationExecutionsRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"AutomationExecutionFilterList", "documentation":"

Filters used to limit the scope of executions that are requested.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeAutomationExecutionsResult":{ "type":"structure", "members":{ "AutomationExecutionMetadataList":{ "shape":"AutomationExecutionMetadataList", "documentation":"

The list of details about each automation execution which has occurred which matches the filter specification, if any.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeAvailablePatchesRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"PatchOrchestratorFilterList", "documentation":"

Filters used to scope down the returned patches.

" }, "MaxResults":{ "shape":"PatchBaselineMaxResults", "documentation":"

The maximum number of patches to return (per page).

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeAvailablePatchesResult":{ "type":"structure", "members":{ "Patches":{ "shape":"PatchList", "documentation":"

An array of patches. Each entry in the array is a patch structure.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeDocumentPermissionRequest":{ "type":"structure", "required":[ "Name", "PermissionType" ], "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the document for which you are the owner.

" }, "PermissionType":{ "shape":"DocumentPermissionType", "documentation":"

The permission type for the document. The permission type can be Share.

" } } }, "DescribeDocumentPermissionResponse":{ "type":"structure", "members":{ "AccountIds":{ "shape":"AccountIdList", "documentation":"

The account IDs that have permission to use this document. The ID can be either an AWS account or All.

" } } }, "DescribeDocumentRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version for which you want information. Can be a specific version or the default version.

" } } }, "DescribeDocumentResult":{ "type":"structure", "members":{ "Document":{ "shape":"DocumentDescription", "documentation":"

Information about the SSM document.

" } } }, "DescribeEffectiveInstanceAssociationsRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The instance ID for which you want to view all associations.

" }, "MaxResults":{ "shape":"EffectiveInstanceAssociationMaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeEffectiveInstanceAssociationsResult":{ "type":"structure", "members":{ "Associations":{ "shape":"InstanceAssociationList", "documentation":"

The associations for the requested instance.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeEffectivePatchesForPatchBaselineRequest":{ "type":"structure", "required":["BaselineId"], "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline to retrieve the effective patches for.

" }, "MaxResults":{ "shape":"PatchBaselineMaxResults", "documentation":"

The maximum number of patches to return (per page).

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeEffectivePatchesForPatchBaselineResult":{ "type":"structure", "members":{ "EffectivePatches":{ "shape":"EffectivePatchList", "documentation":"

An array of patches and patch status.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeInstanceAssociationsStatusRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The instance IDs for which you want association status information.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeInstanceAssociationsStatusResult":{ "type":"structure", "members":{ "InstanceAssociationStatusInfos":{ "shape":"InstanceAssociationStatusInfos", "documentation":"

Status information about the association.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeInstanceInformationRequest":{ "type":"structure", "members":{ "InstanceInformationFilterList":{ "shape":"InstanceInformationFilterList", "documentation":"

One or more filters. Use a filter to return a more specific list of instances.

" }, "Filters":{ "shape":"InstanceInformationStringFilterList", "documentation":"

One or more filters. Use a filter to return a more specific list of instances.

" }, "MaxResults":{ "shape":"MaxResultsEC2Compatible", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeInstanceInformationResult":{ "type":"structure", "members":{ "InstanceInformationList":{ "shape":"InstanceInformationList", "documentation":"

The instance information list.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeInstancePatchStatesForPatchGroupRequest":{ "type":"structure", "required":["PatchGroup"], "members":{ "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group for which the patch state information should be retrieved.

" }, "Filters":{ "shape":"InstancePatchStateFilterList", "documentation":"

Each entry in the array is a structure containing:

Key (string 1 ≤ length ≤ 200)

Values (array containing a single string)

Type (string “Equal”, “NotEqual”, “LessThan”, “GreaterThan”)

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxResults":{ "shape":"PatchComplianceMaxResults", "documentation":"

The maximum number of patches to return (per page).

", "box":true } } }, "DescribeInstancePatchStatesForPatchGroupResult":{ "type":"structure", "members":{ "InstancePatchStates":{ "shape":"InstancePatchStatesList", "documentation":"

The high-level patch state for the requested instances.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeInstancePatchStatesRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "InstanceIds":{ "shape":"InstanceIdList", "documentation":"

The ID of the instance whose patch state information should be retrieved.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxResults":{ "shape":"PatchComplianceMaxResults", "documentation":"

The maximum number of instances to return (per page).

", "box":true } } }, "DescribeInstancePatchStatesResult":{ "type":"structure", "members":{ "InstancePatchStates":{ "shape":"InstancePatchStateList", "documentation":"

The high-level patch state for the requested instances.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeInstancePatchesRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The ID of the instance whose patch state information should be retrieved.

" }, "Filters":{ "shape":"PatchOrchestratorFilterList", "documentation":"

Each entry in the array is a structure containing:

Key (string, 1 ≤ length ≤ 128)

Values (array of strings 1 ≤ length ≤ 256)

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxResults":{ "shape":"PatchComplianceMaxResults", "documentation":"

The maximum number of patches to return (per page).

", "box":true } } }, "DescribeInstancePatchesResult":{ "type":"structure", "members":{ "Patches":{ "shape":"PatchComplianceDataList", "documentation":"

Each entry in the array is a structure containing:

Title (string)

KBId (string)

Classification (string)

Severity (string)

State (string – “INSTALLED”, “INSTALLED_OTHER”, “MISSING”, “NOT_APPLICABLE”, “FAILED”)

InstalledTime (DateTime)

InstalledBy (string)

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeMaintenanceWindowExecutionTaskInvocationsRequest":{ "type":"structure", "required":[ "WindowExecutionId", "TaskId" ], "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the Maintenance Window execution the task is part of.

" }, "TaskId":{ "shape":"MaintenanceWindowExecutionTaskId", "documentation":"

The ID of the specific task in the Maintenance Window task that should be retrieved.

" }, "Filters":{ "shape":"MaintenanceWindowFilterList", "documentation":"

Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.

" }, "MaxResults":{ "shape":"MaintenanceWindowMaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeMaintenanceWindowExecutionTaskInvocationsResult":{ "type":"structure", "members":{ "WindowExecutionTaskInvocationIdentities":{ "shape":"MaintenanceWindowExecutionTaskInvocationIdentityList", "documentation":"

Information about the task invocation results per invocation.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeMaintenanceWindowExecutionTasksRequest":{ "type":"structure", "required":["WindowExecutionId"], "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the Maintenance Window execution whose task executions should be retrieved.

" }, "Filters":{ "shape":"MaintenanceWindowFilterList", "documentation":"

Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.

" }, "MaxResults":{ "shape":"MaintenanceWindowMaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeMaintenanceWindowExecutionTasksResult":{ "type":"structure", "members":{ "WindowExecutionTaskIdentities":{ "shape":"MaintenanceWindowExecutionTaskIdentityList", "documentation":"

Information about the task executions.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeMaintenanceWindowExecutionsRequest":{ "type":"structure", "required":["WindowId"], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the Maintenance Window whose executions should be retrieved.

" }, "Filters":{ "shape":"MaintenanceWindowFilterList", "documentation":"

Each entry in the array is a structure containing:

Key (string, 1 ≤ length ≤ 128)

Values (array of strings 1 ≤ length ≤ 256)

The supported Keys are ExecutedBefore and ExecutedAfter with the value being a date/time string such as 2016-11-04T05:00:00Z.

" }, "MaxResults":{ "shape":"MaintenanceWindowMaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeMaintenanceWindowExecutionsResult":{ "type":"structure", "members":{ "WindowExecutions":{ "shape":"MaintenanceWindowExecutionList", "documentation":"

Information about the Maintenance Windows execution.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeMaintenanceWindowTargetsRequest":{ "type":"structure", "required":["WindowId"], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the Maintenance Window whose targets should be retrieved.

" }, "Filters":{ "shape":"MaintenanceWindowFilterList", "documentation":"

Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are Type, WindowTargetId and OwnerInformation.

" }, "MaxResults":{ "shape":"MaintenanceWindowMaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeMaintenanceWindowTargetsResult":{ "type":"structure", "members":{ "Targets":{ "shape":"MaintenanceWindowTargetList", "documentation":"

Information about the targets in the Maintenance Window.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeMaintenanceWindowTasksRequest":{ "type":"structure", "required":["WindowId"], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the Maintenance Window whose tasks should be retrieved.

" }, "Filters":{ "shape":"MaintenanceWindowFilterList", "documentation":"

Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.

" }, "MaxResults":{ "shape":"MaintenanceWindowMaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeMaintenanceWindowTasksResult":{ "type":"structure", "members":{ "Tasks":{ "shape":"MaintenanceWindowTaskList", "documentation":"

Information about the tasks in the Maintenance Window.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeMaintenanceWindowsRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"MaintenanceWindowFilterList", "documentation":"

Optional filters used to narrow down the scope of the returned Maintenance Windows. Supported filter keys are Name and Enabled.

" }, "MaxResults":{ "shape":"MaintenanceWindowMaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeMaintenanceWindowsResult":{ "type":"structure", "members":{ "WindowIdentities":{ "shape":"MaintenanceWindowIdentityList", "documentation":"

Information about the Maintenance Windows.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribeParametersRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"ParametersFilterList", "documentation":"

One or more filters. Use a filter to return a more specific list of results.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribeParametersResult":{ "type":"structure", "members":{ "Parameters":{ "shape":"ParameterMetadataList", "documentation":"

Parameters returned by the request.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribePatchBaselinesRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"PatchOrchestratorFilterList", "documentation":"

Each element in the array is a structure containing:

Key: (string, “NAME_PREFIX” or “OWNER”)

Value: (array of strings, exactly 1 entry, 1 ≤ length ≤ 255)

" }, "MaxResults":{ "shape":"PatchBaselineMaxResults", "documentation":"

The maximum number of patch baselines to return (per page).

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribePatchBaselinesResult":{ "type":"structure", "members":{ "BaselineIdentities":{ "shape":"PatchBaselineIdentityList", "documentation":"

An array of PatchBaselineIdentity elements.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescribePatchGroupStateRequest":{ "type":"structure", "required":["PatchGroup"], "members":{ "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group whose patch snapshot should be retrieved.

" } } }, "DescribePatchGroupStateResult":{ "type":"structure", "members":{ "Instances":{ "shape":"Integer", "documentation":"

The number of instances in the patch group.

" }, "InstancesWithInstalledPatches":{ "shape":"Integer", "documentation":"

The number of instances with installed patches.

" }, "InstancesWithInstalledOtherPatches":{ "shape":"Integer", "documentation":"

The number of instances with patches installed that aren’t defined in the patch baseline.

" }, "InstancesWithMissingPatches":{ "shape":"Integer", "documentation":"

The number of instances with missing patches from the patch baseline.

" }, "InstancesWithFailedPatches":{ "shape":"Integer", "documentation":"

The number of instances with patches from the patch baseline that failed to install.

" }, "InstancesWithNotApplicablePatches":{ "shape":"Integer", "documentation":"

The number of instances with patches that aren’t applicable.

" } } }, "DescribePatchGroupsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"PatchBaselineMaxResults", "documentation":"

The maximum number of patch groups to return (per page).

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "DescribePatchGroupsResult":{ "type":"structure", "members":{ "Mappings":{ "shape":"PatchGroupPatchBaselineMappingList", "documentation":"

Each entry in the array contains:

PatchGroup: string (1 ≤ length ≤ 256, Regex: ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$)

PatchBaselineIdentity: A PatchBaselineIdentity element.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "DescriptionInDocument":{"type":"string"}, "DocumentARN":{ "type":"string", "pattern":"^[a-zA-Z0-9_\\-.:/]{3,128}$" }, "DocumentAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified SSM document already exists.

", "exception":true }, "DocumentContent":{ "type":"string", "min":1 }, "DocumentDefaultVersionDescription":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the document.

" }, "DefaultVersion":{ "shape":"DocumentVersion", "documentation":"

The default version of the document.

" } }, "documentation":"

A default version of a document.

" }, "DocumentDescription":{ "type":"structure", "members":{ "Sha1":{ "shape":"DocumentSha1", "documentation":"

The SHA1 hash of the document, which you can use for verification purposes.

" }, "Hash":{ "shape":"DocumentHash", "documentation":"

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

" }, "HashType":{ "shape":"DocumentHashType", "documentation":"

Sha256 or Sha1.

Sha1 hashes have been deprecated.

" }, "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document.

" }, "Owner":{ "shape":"DocumentOwner", "documentation":"

The AWS user account of the person who created the document.

" }, "CreatedDate":{ "shape":"DateTime", "documentation":"

The date when the SSM document was created.

" }, "Status":{ "shape":"DocumentStatus", "documentation":"

The status of the SSM document.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version.

" }, "Description":{ "shape":"DescriptionInDocument", "documentation":"

A description of the document.

" }, "Parameters":{ "shape":"DocumentParameterList", "documentation":"

A description of the parameters for a document.

" }, "PlatformTypes":{ "shape":"PlatformTypeList", "documentation":"

The list of OS platforms compatible with this SSM document.

" }, "DocumentType":{ "shape":"DocumentType", "documentation":"

The type of document.

" }, "SchemaVersion":{ "shape":"DocumentSchemaVersion", "documentation":"

The schema version.

" }, "LatestVersion":{ "shape":"DocumentVersion", "documentation":"

The latest version of the document.

" }, "DefaultVersion":{ "shape":"DocumentVersion", "documentation":"

The default version.

" } }, "documentation":"

Describes an SSM document.

" }, "DocumentFilter":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"DocumentFilterKey", "documentation":"

The name of the filter.

" }, "value":{ "shape":"DocumentFilterValue", "documentation":"

The value of the filter.

" } }, "documentation":"

Describes a filter.

" }, "DocumentFilterKey":{ "type":"string", "enum":[ "Name", "Owner", "PlatformTypes", "DocumentType" ] }, "DocumentFilterList":{ "type":"list", "member":{ "shape":"DocumentFilter", "locationName":"DocumentFilter" }, "min":1 }, "DocumentFilterValue":{ "type":"string", "min":1 }, "DocumentHash":{ "type":"string", "max":256 }, "DocumentHashType":{ "type":"string", "enum":[ "Sha256", "Sha1" ] }, "DocumentIdentifier":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document.

" }, "Owner":{ "shape":"DocumentOwner", "documentation":"

The AWS user account of the person who created the document.

" }, "PlatformTypes":{ "shape":"PlatformTypeList", "documentation":"

The operating system platform.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version.

" }, "DocumentType":{ "shape":"DocumentType", "documentation":"

The document type.

" }, "SchemaVersion":{ "shape":"DocumentSchemaVersion", "documentation":"

The schema version.

" } }, "documentation":"

Describes the name of an SSM document.

" }, "DocumentIdentifierList":{ "type":"list", "member":{ "shape":"DocumentIdentifier", "locationName":"DocumentIdentifier" } }, "DocumentLimitExceeded":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

You can have at most 200 active SSM documents.

", "exception":true }, "DocumentName":{ "type":"string", "pattern":"^[a-zA-Z0-9_\\-.]{3,128}$" }, "DocumentOwner":{"type":"string"}, "DocumentParameter":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentParameterName", "documentation":"

The name of the parameter.

" }, "Type":{ "shape":"DocumentParameterType", "documentation":"

The type of parameter. The type can be either “String” or “StringList”.

" }, "Description":{ "shape":"DocumentParameterDescrption", "documentation":"

A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

" }, "DefaultValue":{ "shape":"DocumentParameterDefaultValue", "documentation":"

If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

" } }, "documentation":"

Parameters specified in the SSM document that execute on the server when the command is run.

" }, "DocumentParameterDefaultValue":{"type":"string"}, "DocumentParameterDescrption":{"type":"string"}, "DocumentParameterList":{ "type":"list", "member":{ "shape":"DocumentParameter", "locationName":"DocumentParameter" } }, "DocumentParameterName":{"type":"string"}, "DocumentParameterType":{ "type":"string", "enum":[ "String", "StringList" ] }, "DocumentPermissionLimit":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The document cannot be shared with more AWS user accounts. You can share a document with a maximum of 20 accounts. You can publicly share up to five documents. If you need to increase this limit, contact AWS Support.

", "exception":true }, "DocumentPermissionType":{ "type":"string", "enum":["Share"] }, "DocumentSchemaVersion":{ "type":"string", "pattern":"([0-9]+)\\.([0-9]+)" }, "DocumentSha1":{"type":"string"}, "DocumentStatus":{ "type":"string", "enum":[ "Creating", "Active", "Updating", "Deleting" ] }, "DocumentType":{ "type":"string", "enum":[ "Command", "Policy", "Automation" ] }, "DocumentVersion":{ "type":"string", "pattern":"([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)" }, "DocumentVersionInfo":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The document name.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version.

" }, "CreatedDate":{ "shape":"DateTime", "documentation":"

The date the document was created.

" }, "IsDefaultVersion":{ "shape":"Boolean", "documentation":"

An identifier for the default version of the document.

" } }, "documentation":"

Version information about the document.

" }, "DocumentVersionLimitExceeded":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The document has too many versions. Delete one or more document versions and try again.

", "exception":true }, "DocumentVersionList":{ "type":"list", "member":{"shape":"DocumentVersionInfo"}, "min":1 }, "DocumentVersionNumber":{ "type":"string", "pattern":"(^[1-9][0-9]*$)" }, "DoesNotExistException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

Error returned when the ID specified for a resource (e.g. a Maintenance Window) doesn’t exist.

", "exception":true }, "DuplicateDocumentContent":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The content of the association document matches another document. Change the content of the document and try again.

", "exception":true }, "DuplicateInstanceId":{ "type":"structure", "members":{ }, "documentation":"

You cannot specify an instance ID in more than one association.

", "exception":true }, "EffectiveInstanceAssociationMaxResults":{ "type":"integer", "max":5, "min":1 }, "EffectivePatch":{ "type":"structure", "members":{ "Patch":{ "shape":"Patch", "documentation":"

Provides metadata for a patch, including information such as the KB ID, severity, classification and a URL for where more information can be obtained about the patch.

" }, "PatchStatus":{ "shape":"PatchStatus", "documentation":"

The status of the patch in a patch baseline. This includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved.

" } }, "documentation":"

The EffectivePatch structure defines metadata about a patch along with the approval state of the patch in a particular patch baseline. The approval state includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved.

" }, "EffectivePatchList":{ "type":"list", "member":{"shape":"EffectivePatch"} }, "ErrorCount":{"type":"integer"}, "ExpirationDate":{"type":"timestamp"}, "FailedCreateAssociation":{ "type":"structure", "members":{ "Entry":{ "shape":"CreateAssociationBatchRequestEntry", "documentation":"

The association.

" }, "Message":{ "shape":"BatchErrorMessage", "documentation":"

A description of the failure.

" }, "Fault":{ "shape":"Fault", "documentation":"

The source of the failure.

" } }, "documentation":"

Describes a failed association.

" }, "FailedCreateAssociationList":{ "type":"list", "member":{ "shape":"FailedCreateAssociation", "locationName":"FailedCreateAssociationEntry" } }, "Fault":{ "type":"string", "enum":[ "Client", "Server", "Unknown" ] }, "GetAutomationExecutionRequest":{ "type":"structure", "required":["AutomationExecutionId"], "members":{ "AutomationExecutionId":{ "shape":"AutomationExecutionId", "documentation":"

The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation document is initiated.

" } } }, "GetAutomationExecutionResult":{ "type":"structure", "members":{ "AutomationExecution":{ "shape":"AutomationExecution", "documentation":"

Detailed information about the current state of an automation execution.

" } } }, "GetCommandInvocationRequest":{ "type":"structure", "required":[ "CommandId", "InstanceId" ], "members":{ "CommandId":{ "shape":"CommandId", "documentation":"

(Required) The parent command ID of the invocation plugin.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.

" }, "PluginName":{ "shape":"CommandPluginName", "documentation":"

(Optional) The name of the plugin for which you want detailed results. If the SSM document contains only one plugin, the name can be omitted and the details will be returned.

" } } }, "GetCommandInvocationResult":{ "type":"structure", "members":{ "CommandId":{ "shape":"CommandId", "documentation":"

The parent command ID of the invocation plugin.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.

" }, "Comment":{ "shape":"Comment", "documentation":"

The comment text for the command.

" }, "DocumentName":{ "shape":"DocumentName", "documentation":"

The name of the SSM document that was executed. For example, AWS-RunShellScript is an SSM document.

" }, "PluginName":{ "shape":"CommandPluginName", "documentation":"

The name of the plugin for which you want detailed results. For example, aws:RunShellScript is a plugin.

" }, "ResponseCode":{ "shape":"ResponseCode", "documentation":"

The error level response code for the plugin script. If the response code is -1, then the command has not started executing on the instance, or it was not received by the instance.

" }, "ExecutionStartDateTime":{ "shape":"StringDateTime", "documentation":"

The date and time the plugin started executing. Date and time are written in ISO 8601 format. For example, August 28, 2016 is represented as 2016-08-28. If the plugin has not started to execute, the string is empty.

" }, "ExecutionElapsedTime":{ "shape":"StringDateTime", "documentation":"

Duration since ExecutionStartDateTime.

" }, "ExecutionEndDateTime":{ "shape":"StringDateTime", "documentation":"

The date and time the plugin was finished executing. Date and time are written in ISO 8601 format. For example, August 28, 2016 is represented as 2016-08-28. If the plugin has not started to execute, the string is empty.

" }, "Status":{ "shape":"CommandInvocationStatus", "documentation":"

The status of the parent command for this invocation. This status can be different than StatusDetails.

" }, "StatusDetails":{ "shape":"StatusDetails", "documentation":"

A detailed status of the command execution for an invocation. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Monitor Commands (Linux) or Monitor Commands (Windows). StatusDetails can be one of the following values:

  • Pending – The command has not been sent to the instance.

  • In Progress – The command has been sent to the instance but has not reached a terminal state.

  • Delayed – The system attempted to send the command to the target, but the target was not available. The instance might not be available because of network issues, the instance was stopped, etc. The system will try to deliver the command again.

  • Success – The command or plugin was executed successfully. This is a terminal state.

  • Delivery Timed Out – The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command’s MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

  • Execution Timed Out – The command started to execute on the instance, but the execution was not complete before the timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

  • Failed – The command wasn't executed successfully on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

  • Canceled – The command was terminated before it was completed. This is a terminal state.

  • Undeliverable – The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command’s MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

  • Terminated – The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

" }, "StandardOutputContent":{ "shape":"StandardOutputContent", "documentation":"

The first 24,000 characters written by the plugin to stdout. If the command has not finished executing, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.

" }, "StandardOutputUrl":{ "shape":"Url", "documentation":"

The URL for the complete text written by the plugin to stdout in Amazon S3. If an Amazon S3 bucket was not specified, then this string is empty.

" }, "StandardErrorContent":{ "shape":"StandardErrorContent", "documentation":"

The first 8,000 characters written by the plugin to stderr. If the command has not finished executing, then this string is empty.

" }, "StandardErrorUrl":{ "shape":"Url", "documentation":"

The URL for the complete text written by the plugin to stderr. If the command has not finished executing, then this string is empty.

" } } }, "GetDefaultPatchBaselineRequest":{ "type":"structure", "members":{ } }, "GetDefaultPatchBaselineResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the default patch baseline.

" } } }, "GetDeployablePatchSnapshotForInstanceRequest":{ "type":"structure", "required":[ "InstanceId", "SnapshotId" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The ID of the instance for which the appropriate patch snapshot should be retrieved.

" }, "SnapshotId":{ "shape":"SnapshotId", "documentation":"

The user-defined snapshot ID.

" } } }, "GetDeployablePatchSnapshotForInstanceResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The ID of the instance.

" }, "SnapshotId":{ "shape":"SnapshotId", "documentation":"

The user-defined snapshot ID.

" }, "SnapshotDownloadUrl":{ "shape":"SnapshotDownloadUrl", "documentation":"

A pre-signed Amazon S3 URL that can be used to download the patch snapshot.

" } } }, "GetDocumentRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version for which you want information.

" } } }, "GetDocumentResult":{ "type":"structure", "members":{ "Name":{ "shape":"DocumentARN", "documentation":"

The name of the SSM document.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version.

" }, "Content":{ "shape":"DocumentContent", "documentation":"

The contents of the SSM document.

" }, "DocumentType":{ "shape":"DocumentType", "documentation":"

The document type.

" } } }, "GetInventoryRequest":{ "type":"structure", "members":{ "Filters":{ "shape":"InventoryFilterList", "documentation":"

One or more filters. Use a filter to return a more specific list of results.

" }, "ResultAttributes":{ "shape":"ResultAttributeList", "documentation":"

The list of inventory item types to return.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true } } }, "GetInventoryResult":{ "type":"structure", "members":{ "Entities":{ "shape":"InventoryResultEntityList", "documentation":"

Collection of inventory entities such as a collection of instance inventory.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "GetInventorySchemaMaxResults":{ "type":"integer", "max":200, "min":50 }, "GetInventorySchemaRequest":{ "type":"structure", "members":{ "TypeName":{ "shape":"InventoryItemTypeNameFilter", "documentation":"

The type of inventory item to return.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxResults":{ "shape":"GetInventorySchemaMaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true } } }, "GetInventorySchemaResult":{ "type":"structure", "members":{ "Schemas":{ "shape":"InventoryItemSchemaResultList", "documentation":"

Inventory schemas returned by the request.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "GetMaintenanceWindowExecutionRequest":{ "type":"structure", "required":["WindowExecutionId"], "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the Maintenance Window execution that includes the task.

" } } }, "GetMaintenanceWindowExecutionResult":{ "type":"structure", "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the Maintenance Window execution.

" }, "TaskIds":{ "shape":"MaintenanceWindowExecutionTaskIdList", "documentation":"

The ID of the task executions from the Maintenance Window execution.

" }, "Status":{ "shape":"MaintenanceWindowExecutionStatus", "documentation":"

The status of the Maintenance Window execution.

" }, "StatusDetails":{ "shape":"MaintenanceWindowExecutionStatusDetails", "documentation":"

The details explaining the Status. Only available for certain status values.

" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time the Maintenance Window started executing.

" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time the Maintenance Window finished executing.

" } } }, "GetMaintenanceWindowExecutionTaskRequest":{ "type":"structure", "required":[ "WindowExecutionId", "TaskId" ], "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the Maintenance Window execution that includes the task.

" }, "TaskId":{ "shape":"MaintenanceWindowExecutionTaskId", "documentation":"

The ID of the specific task execution in the Maintenance Window task that should be retrieved.

" } } }, "GetMaintenanceWindowExecutionTaskResult":{ "type":"structure", "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the Maintenance Window execution that includes the task.

" }, "TaskExecutionId":{ "shape":"MaintenanceWindowExecutionTaskId", "documentation":"

The ID of the specific task execution in the Maintenance Window task that was retrieved.

" }, "TaskArn":{ "shape":"MaintenanceWindowTaskArn", "documentation":"

The ARN of the executed task.

" }, "ServiceRole":{ "shape":"ServiceRole", "documentation":"

The role that was assumed when executing the task.

" }, "Type":{ "shape":"MaintenanceWindowTaskType", "documentation":"

The type of task executed.

" }, "TaskParameters":{ "shape":"MaintenanceWindowTaskParametersList", "documentation":"

The parameters passed to the task when it was executed. The map has the following format:

Key: string, 1 ≤ length ≤ 255

Value: an array of strings where each string 1 ≤ length ≤ 255

" }, "Priority":{ "shape":"MaintenanceWindowTaskPriority", "documentation":"

The priority of the task.

" }, "MaxConcurrency":{ "shape":"VelocityConstraint", "documentation":"

The defined maximum number of task executions that could be run in parallel.

" }, "MaxErrors":{ "shape":"VelocityConstraint", "documentation":"

The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

" }, "Status":{ "shape":"MaintenanceWindowExecutionStatus", "documentation":"

The status of the task.

" }, "StatusDetails":{ "shape":"MaintenanceWindowExecutionStatusDetails", "documentation":"

The details explaining the Status. Only available for certain status values.

" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time the task execution started.

" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time the task execution completed.

" } } }, "GetMaintenanceWindowRequest":{ "type":"structure", "required":["WindowId"], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the desired Maintenance Window.

" } } }, "GetMaintenanceWindowResult":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the created Maintenance Window.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The name of the Maintenance Window.

" }, "Schedule":{ "shape":"MaintenanceWindowSchedule", "documentation":"

The schedule of the Maintenance Window in the form of a cron or rate expression.

" }, "Duration":{ "shape":"MaintenanceWindowDurationHours", "documentation":"

The duration of the Maintenance Window in hours.

" }, "Cutoff":{ "shape":"MaintenanceWindowCutoff", "documentation":"

The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

" }, "AllowUnassociatedTargets":{ "shape":"MaintenanceWindowAllowUnassociatedTargets", "documentation":"

Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.

" }, "Enabled":{ "shape":"MaintenanceWindowEnabled", "documentation":"

Whether the Maintenance Windows is enabled.

" }, "CreatedDate":{ "shape":"DateTime", "documentation":"

The date the Maintenance Window was created.

" }, "ModifiedDate":{ "shape":"DateTime", "documentation":"

The date the Maintenance Window was last modified.

" } } }, "GetParameterHistoryRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"PSParameterName", "documentation":"

The name of a parameter you want to query.

" }, "WithDecryption":{ "shape":"Boolean", "documentation":"

Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

", "box":true }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "GetParameterHistoryResult":{ "type":"structure", "members":{ "Parameters":{ "shape":"ParameterHistoryList", "documentation":"

A list of parameters returned by the request.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "GetParametersRequest":{ "type":"structure", "required":["Names"], "members":{ "Names":{ "shape":"ParameterNameList", "documentation":"

Names of the parameters for which you want to query information.

" }, "WithDecryption":{ "shape":"Boolean", "documentation":"

Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

", "box":true } } }, "GetParametersResult":{ "type":"structure", "members":{ "Parameters":{ "shape":"ParameterList", "documentation":"

A list of parameters used by the AWS account.

" }, "InvalidParameters":{ "shape":"ParameterNameList", "documentation":"

A list of parameters that are not formatted correctly or do not run when executed.

" } } }, "GetPatchBaselineForPatchGroupRequest":{ "type":"structure", "required":["PatchGroup"], "members":{ "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group whose patch baseline should be retrieved.

" } } }, "GetPatchBaselineForPatchGroupResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline that should be used for the patch group.

" }, "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group.

" } } }, "GetPatchBaselineRequest":{ "type":"structure", "required":["BaselineId"], "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline to retrieve.

" } } }, "GetPatchBaselineResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the retrieved patch baseline.

" }, "Name":{ "shape":"BaselineName", "documentation":"

The name of the patch baseline.

" }, "GlobalFilters":{ "shape":"PatchFilterGroup", "documentation":"

A set of global filters used to exclude patches from the baseline.

" }, "ApprovalRules":{ "shape":"PatchRuleGroup", "documentation":"

A set of rules used to include patches in the baseline.

" }, "ApprovedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly approved patches for the baseline.

" }, "RejectedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly rejected patches for the baseline.

" }, "PatchGroups":{ "shape":"PatchGroupList", "documentation":"

Patch groups included in the patch baseline.

" }, "CreatedDate":{ "shape":"DateTime", "documentation":"

The date the patch baseline was created.

" }, "ModifiedDate":{ "shape":"DateTime", "documentation":"

The date the patch baseline was last modified.

" }, "Description":{ "shape":"BaselineDescription", "documentation":"

A description of the patch baseline.

" } } }, "IPAddress":{ "type":"string", "max":46, "min":1 }, "IamRole":{ "type":"string", "max":64 }, "IdempotentParameterMismatch":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

Error returned when an idempotent operation is retried and the parameters don’t match the original call to the API with the same idempotency token.

", "exception":true }, "InstanceAggregatedAssociationOverview":{ "type":"structure", "members":{ "DetailedStatus":{ "shape":"StatusName", "documentation":"

Detailed status information about the aggregated associations.

" }, "InstanceAssociationStatusAggregatedCount":{ "shape":"InstanceAssociationStatusAggregatedCount", "documentation":"

The number of associations for the instance(s).

" } }, "documentation":"

Status information about the aggregated associations.

" }, "InstanceAssociation":{ "type":"structure", "members":{ "AssociationId":{ "shape":"AssociationId", "documentation":"

The association ID.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The instance ID.

" }, "Content":{ "shape":"DocumentContent", "documentation":"

The content of the association document for the instance(s).

" } }, "documentation":"

One or more association documents on the instance.

" }, "InstanceAssociationExecutionSummary":{ "type":"string", "max":512, "min":1 }, "InstanceAssociationList":{ "type":"list", "member":{"shape":"InstanceAssociation"} }, "InstanceAssociationOutputLocation":{ "type":"structure", "members":{ "S3Location":{ "shape":"S3OutputLocation", "documentation":"

An Amazon S3 bucket where you want to store the results of this request.

" } }, "documentation":"

An Amazon S3 bucket where you want to store the results of this request.

" }, "InstanceAssociationOutputUrl":{ "type":"structure", "members":{ "S3OutputUrl":{ "shape":"S3OutputUrl", "documentation":"

The URL of Amazon S3 bucket where you want to store the results of this request.

" } }, "documentation":"

The URL of Amazon S3 bucket where you want to store the results of this request.

" }, "InstanceAssociationStatusAggregatedCount":{ "type":"map", "key":{"shape":"StatusName"}, "value":{"shape":"InstanceCount"} }, "InstanceAssociationStatusInfo":{ "type":"structure", "members":{ "AssociationId":{ "shape":"AssociationId", "documentation":"

The association ID.

" }, "Name":{ "shape":"DocumentName", "documentation":"

The name of the association.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The association document verions.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The instance ID where the association was created.

" }, "ExecutionDate":{ "shape":"DateTime", "documentation":"

The date the instance association executed.

" }, "Status":{ "shape":"StatusName", "documentation":"

Status information about the instance association.

" }, "DetailedStatus":{ "shape":"StatusName", "documentation":"

Detailed status information about the instance association.

" }, "ExecutionSummary":{ "shape":"InstanceAssociationExecutionSummary", "documentation":"

Summary information about association execution.

" }, "ErrorCode":{ "shape":"AgentErrorCode", "documentation":"

An error code returned by the request to create the association.

" }, "OutputUrl":{ "shape":"InstanceAssociationOutputUrl", "documentation":"

A URL for an Amazon S3 bucket where you want to store the results of this request.

" } }, "documentation":"

Status information about the instance association.

" }, "InstanceAssociationStatusInfos":{ "type":"list", "member":{"shape":"InstanceAssociationStatusInfo"} }, "InstanceCount":{"type":"integer"}, "InstanceId":{ "type":"string", "pattern":"(^i-(\\w{8}|\\w{17})$)|(^mi-\\w{17}$)" }, "InstanceIdList":{ "type":"list", "member":{"shape":"InstanceId"}, "max":50, "min":0 }, "InstanceInformation":{ "type":"structure", "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The instance ID.

" }, "PingStatus":{ "shape":"PingStatus", "documentation":"

Connection status of the SSM agent.

" }, "LastPingDateTime":{ "shape":"DateTime", "documentation":"

The date and time when agent last pinged Systems Manager service.

", "box":true }, "AgentVersion":{ "shape":"Version", "documentation":"

The version of the SSM agent running on your Linux instance.

" }, "IsLatestVersion":{ "shape":"Boolean", "documentation":"

Indicates whether latest version of the SSM agent is running on your instance.

", "box":true }, "PlatformType":{ "shape":"PlatformType", "documentation":"

The operating system platform type.

" }, "PlatformName":{ "shape":"String", "documentation":"

The name of the operating system platform running on your instance.

" }, "PlatformVersion":{ "shape":"String", "documentation":"

The version of the OS platform running on your instance.

" }, "ActivationId":{ "shape":"ActivationId", "documentation":"

The activation ID created by Systems Manager when the server or VM was registered.

" }, "IamRole":{ "shape":"IamRole", "documentation":"

The Amazon Identity and Access Management (IAM) role assigned to EC2 instances or managed instances.

" }, "RegistrationDate":{ "shape":"DateTime", "documentation":"

The date the server or VM was registered with AWS as a managed instance.

", "box":true }, "ResourceType":{ "shape":"ResourceType", "documentation":"

The type of instance. Instances are either EC2 instances or managed instances.

" }, "Name":{ "shape":"String", "documentation":"

The name of the managed instance.

" }, "IPAddress":{ "shape":"IPAddress", "documentation":"

The IP address of the managed instance.

" }, "ComputerName":{ "shape":"ComputerName", "documentation":"

The fully qualified host name of the managed instance.

" }, "AssociationStatus":{ "shape":"StatusName", "documentation":"

The status of the association.

" }, "LastAssociationExecutionDate":{ "shape":"DateTime", "documentation":"

The date the association was last executed.

" }, "LastSuccessfulAssociationExecutionDate":{ "shape":"DateTime", "documentation":"

The last date the association was successfully run.

" }, "AssociationOverview":{ "shape":"InstanceAggregatedAssociationOverview", "documentation":"

Information about the association.

" } }, "documentation":"

Describes a filter for a specific list of instances.

" }, "InstanceInformationFilter":{ "type":"structure", "required":[ "key", "valueSet" ], "members":{ "key":{ "shape":"InstanceInformationFilterKey", "documentation":"

The name of the filter.

" }, "valueSet":{ "shape":"InstanceInformationFilterValueSet", "documentation":"

The filter values.

" } }, "documentation":"

Describes a filter for a specific list of instances.

" }, "InstanceInformationFilterKey":{ "type":"string", "enum":[ "InstanceIds", "AgentVersion", "PingStatus", "PlatformTypes", "ActivationIds", "IamRole", "ResourceType", "AssociationStatus" ] }, "InstanceInformationFilterList":{ "type":"list", "member":{ "shape":"InstanceInformationFilter", "locationName":"InstanceInformationFilter" }, "min":0 }, "InstanceInformationFilterValue":{ "type":"string", "min":1 }, "InstanceInformationFilterValueSet":{ "type":"list", "member":{ "shape":"InstanceInformationFilterValue", "locationName":"InstanceInformationFilterValue" }, "max":100, "min":1 }, "InstanceInformationList":{ "type":"list", "member":{ "shape":"InstanceInformation", "locationName":"InstanceInformation" } }, "InstanceInformationStringFilter":{ "type":"structure", "required":[ "Key", "Values" ], "members":{ "Key":{ "shape":"InstanceInformationStringFilterKey", "documentation":"

The filter key name to describe your instances. For example:

\"InstanceIds\"|\"AgentVersion\"|\"PingStatus\"|\"PlatformTypes\"|\"ActivationIds\"|\"IamRole\"|\"ResourceType\"|”AssociationStatus”|”Tag Key”

" }, "Values":{ "shape":"InstanceInformationFilterValueSet", "documentation":"

The filter values.

" } }, "documentation":"

The filters to describe or get information about your managed instances.

" }, "InstanceInformationStringFilterKey":{ "type":"string", "min":1 }, "InstanceInformationStringFilterList":{ "type":"list", "member":{ "shape":"InstanceInformationStringFilter", "locationName":"InstanceInformationStringFilter" }, "min":0 }, "InstancePatchState":{ "type":"structure", "required":[ "InstanceId", "PatchGroup", "BaselineId", "OperationStartTime", "OperationEndTime", "Operation" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The ID of the managed instance the high-level patch compliance information was collected for.

" }, "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group the managed instance belongs to.

" }, "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline used to patch the instance.

" }, "SnapshotId":{ "shape":"SnapshotId", "documentation":"

The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.

" }, "OwnerInformation":{ "shape":"OwnerInformation", "documentation":"

Placeholder information, this field will always be empty in the current release of the service.

" }, "InstalledCount":{ "shape":"PatchInstalledCount", "documentation":"

The number of patches from the patch baseline that are installed on the instance.

" }, "InstalledOtherCount":{ "shape":"PatchInstalledOtherCount", "documentation":"

The number of patches not specified in the patch baseline that are installed on the instance.

" }, "MissingCount":{ "shape":"PatchMissingCount", "documentation":"

The number of patches from the patch baseline that are applicable for the instance but aren’t currently installed.

" }, "FailedCount":{ "shape":"PatchFailedCount", "documentation":"

The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.

" }, "NotApplicableCount":{ "shape":"PatchNotApplicableCount", "documentation":"

The number of patches from the patch baseline that aren’t applicable for the instance and hence aren’t installed on the instance.

" }, "OperationStartTime":{ "shape":"PatchOperationStartTime", "documentation":"

The time the most recent patching operation was started on the instance.

" }, "OperationEndTime":{ "shape":"PatchOperationEndTime", "documentation":"

The time the most recent patching operation completed on the instance.

" }, "Operation":{ "shape":"PatchOperationType", "documentation":"

The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).

" } }, "documentation":"

Defines the high-level patch compliance state for a managed instance, providing information about the number of installed, missing, not applicable, and failed patches along with metadata about the operation when this information was gathered for the instance.

" }, "InstancePatchStateFilter":{ "type":"structure", "required":[ "Key", "Values", "Type" ], "members":{ "Key":{ "shape":"InstancePatchStateFilterKey", "documentation":"

The key for the filter. Supported values are FailedCount, InstalledCount, InstalledOtherCount, MissingCount and NotApplicableCount.

" }, "Values":{ "shape":"InstancePatchStateFilterValues", "documentation":"

The value for the filter, must be an integer greater than or equal to 0.

" }, "Type":{ "shape":"InstancePatchStateOperatorType", "documentation":"

The type of comparison that should be performed for the value: Equal, NotEqual, LessThan or GreaterThan.

" } }, "documentation":"

Defines a filter used in DescribeInstancePatchStatesForPatchGroup used to scope down the information returned by the API.

" }, "InstancePatchStateFilterKey":{ "type":"string", "max":200, "min":1 }, "InstancePatchStateFilterList":{ "type":"list", "member":{"shape":"InstancePatchStateFilter"}, "max":4, "min":0 }, "InstancePatchStateFilterValue":{"type":"string"}, "InstancePatchStateFilterValues":{ "type":"list", "member":{"shape":"InstancePatchStateFilterValue"}, "max":1, "min":1 }, "InstancePatchStateList":{ "type":"list", "member":{"shape":"InstancePatchState"} }, "InstancePatchStateOperatorType":{ "type":"string", "enum":[ "Equal", "NotEqual", "LessThan", "GreaterThan" ] }, "InstancePatchStatesList":{ "type":"list", "member":{"shape":"InstancePatchState"}, "max":5, "min":1 }, "InstanceTagName":{ "type":"string", "max":255 }, "Integer":{"type":"integer"}, "InternalServerError":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

An error occurred on the server side.

", "exception":true }, "InvalidActivation":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The activation is not valid. The activation might have been deleted, or the ActivationId and the ActivationCode do not match.

", "exception":true }, "InvalidActivationId":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The activation ID is not valid. Verify the you entered the correct ActivationId or ActivationCode and try again.

", "exception":true }, "InvalidAutomationExecutionParametersException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The supplied parameters for invoking the specified Automation document are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.

", "exception":true }, "InvalidCommandId":{ "type":"structure", "members":{ }, "exception":true }, "InvalidDocument":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

The SSM document does not exist or the document is not available to the user. This exception can be issued by CreateAssociation, CreateAssociationBatch, DeleteAssociation, DeleteDocument, DescribeAssociation, DescribeDocument, GetDocument, SendCommand, or UpdateAssociationStatus.

" } }, "documentation":"

The specified document does not exist.

", "exception":true }, "InvalidDocumentContent":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

A description of the validation error.

" } }, "documentation":"

The content for the SSM document is not valid.

", "exception":true }, "InvalidDocumentOperation":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.

", "exception":true }, "InvalidDocumentSchemaVersion":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The version of the document schema is not supported.

", "exception":true }, "InvalidDocumentVersion":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The document version is not valid or does not exist.

", "exception":true }, "InvalidFilter":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The filter name is not valid. Verify the you entered the correct name and try again.

", "exception":true }, "InvalidFilterKey":{ "type":"structure", "members":{ }, "documentation":"

The specified key is not valid.

", "exception":true }, "InvalidFilterValue":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The filter value is not valid. Verify the value and try again.

", "exception":true }, "InvalidInstanceId":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The following problems can cause this exception:

You do not have permission to access the instance.

The SSM agent is not running. On managed instances and Linux instances, verify that the SSM agent is running. On EC2 Windows instances, verify that the EC2Config service is running.

The SSM agent or EC2Config service is not registered to the SSM endpoint. Try reinstalling the SSM agent or EC2Config service.

The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

", "exception":true }, "InvalidInstanceInformationFilterValue":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The specified filter value is not valid.

", "exception":true }, "InvalidItemContentException":{ "type":"structure", "members":{ "TypeName":{"shape":"InventoryItemTypeName"}, "Message":{"shape":"String"} }, "documentation":"

One or more content items is not valid.

", "exception":true }, "InvalidKeyId":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The query key ID is not valid.

", "exception":true }, "InvalidNextToken":{ "type":"structure", "members":{ }, "documentation":"

The specified token is not valid.

", "exception":true }, "InvalidNotificationConfig":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon SNS topic.

", "exception":true }, "InvalidOutputFolder":{ "type":"structure", "members":{ }, "documentation":"

The S3 bucket does not exist.

", "exception":true }, "InvalidOutputLocation":{ "type":"structure", "members":{ }, "documentation":"

The output location is not valid or does not exist.

", "exception":true }, "InvalidParameters":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

You must specify values for all required parameters in the SSM document. You can only supply values to parameters defined in the SSM document.

", "exception":true }, "InvalidPermissionType":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The permission type is not supported. Share is the only supported permission type.

", "exception":true }, "InvalidPluginName":{ "type":"structure", "members":{ }, "documentation":"

The plugin name is not valid.

", "exception":true }, "InvalidResourceId":{ "type":"structure", "members":{ }, "documentation":"

The resource ID is not valid. Verify that you entered the correct ID and try again.

", "exception":true }, "InvalidResourceType":{ "type":"structure", "members":{ }, "documentation":"

The resource type is not valid. If you are attempting to tag an instance, the instance must be a registered, managed instance.

", "exception":true }, "InvalidResultAttributeException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified inventory item result attribute is not valid.

", "exception":true }, "InvalidRole":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for Run Command notifications, see Getting Amazon SNS Notifications When a Command Changes Status in the Amazon Elastic Compute Cloud User Guide .

", "exception":true }, "InvalidSchedule":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The schedule is invalid. Verify your cron or rate expression and try again.

", "exception":true }, "InvalidTarget":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The target is not valid or does not exist. It might not be configured for EC2 Systems Manager or you might not have permission to perform the operation.

", "exception":true }, "InvalidTypeNameException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The parameter type name is not valid.

", "exception":true }, "InvalidUpdate":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The update is not valid.

", "exception":true }, "InventoryAttributeDataType":{ "type":"string", "enum":[ "string", "number" ] }, "InventoryFilter":{ "type":"structure", "required":[ "Key", "Values" ], "members":{ "Key":{ "shape":"InventoryFilterKey", "documentation":"

The name of the filter key.

" }, "Values":{ "shape":"InventoryFilterValueList", "documentation":"

Inventory filter values. Example: inventory filter where instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal

" }, "Type":{ "shape":"InventoryQueryOperatorType", "documentation":"

The type of filter. Valid values include the following: \"Equal\"|\"NotEqual\"|\"BeginWith\"|\"LessThan\"|\"GreaterThan\"

" } }, "documentation":"

One or more filters. Use a filter to return a more specific list of results.

" }, "InventoryFilterKey":{ "type":"string", "max":200, "min":1 }, "InventoryFilterList":{ "type":"list", "member":{ "shape":"InventoryFilter", "locationName":"InventoryFilter" }, "max":5, "min":1 }, "InventoryFilterValue":{"type":"string"}, "InventoryFilterValueList":{ "type":"list", "member":{ "shape":"InventoryFilterValue", "locationName":"FilterValue" }, "max":20, "min":1 }, "InventoryItem":{ "type":"structure", "required":[ "TypeName", "SchemaVersion", "CaptureTime" ], "members":{ "TypeName":{ "shape":"InventoryItemTypeName", "documentation":"

The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.

" }, "SchemaVersion":{ "shape":"InventoryItemSchemaVersion", "documentation":"

The schema version for the inventory item.

" }, "CaptureTime":{ "shape":"InventoryItemCaptureTime", "documentation":"

The time the inventory information was collected.

" }, "ContentHash":{ "shape":"InventoryItemContentHash", "documentation":"

MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API does not update the inventory item type contents if the MD5 hash has not changed since last update.

" }, "Content":{ "shape":"InventoryItemEntryList", "documentation":"

The inventory data of the inventory type.

" } }, "documentation":"

Information collected from managed instances based on your inventory policy document

" }, "InventoryItemAttribute":{ "type":"structure", "required":[ "Name", "DataType" ], "members":{ "Name":{ "shape":"InventoryItemAttributeName", "documentation":"

Name of the inventory item attribute.

" }, "DataType":{ "shape":"InventoryAttributeDataType", "documentation":"

The data type of the inventory item attribute.

" } }, "documentation":"

Attributes are the entries within the inventory item content. It contains name and value.

" }, "InventoryItemAttributeList":{ "type":"list", "member":{ "shape":"InventoryItemAttribute", "locationName":"Attribute" }, "max":50, "min":1 }, "InventoryItemAttributeName":{"type":"string"}, "InventoryItemCaptureTime":{ "type":"string", "pattern":"^(20)[0-9][0-9]-(0[1-9]|1[012])-([12][0-9]|3[01]|0[1-9])(T)(2[0-3]|[0-1][0-9])(:[0-5][0-9])(:[0-5][0-9])(Z)$" }, "InventoryItemContentHash":{ "type":"string", "max":256 }, "InventoryItemEntry":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValue"}, "max":50, "min":0 }, "InventoryItemEntryList":{ "type":"list", "member":{"shape":"InventoryItemEntry"}, "max":10000, "min":0 }, "InventoryItemList":{ "type":"list", "member":{ "shape":"InventoryItem", "locationName":"Item" }, "max":30, "min":1 }, "InventoryItemSchema":{ "type":"structure", "required":[ "TypeName", "Attributes" ], "members":{ "TypeName":{ "shape":"InventoryItemTypeName", "documentation":"

The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.

" }, "Version":{ "shape":"InventoryItemSchemaVersion", "documentation":"

The schema version for the inventory item.

" }, "Attributes":{ "shape":"InventoryItemAttributeList", "documentation":"

The schema attributes for inventory. This contains data type and attribute name.

" } }, "documentation":"

The inventory item schema definition. Users can use this to compose inventory query filters.

" }, "InventoryItemSchemaResultList":{ "type":"list", "member":{"shape":"InventoryItemSchema"} }, "InventoryItemSchemaVersion":{ "type":"string", "pattern":"^([0-9]{1,6})(\\.[0-9]{1,6})$" }, "InventoryItemTypeName":{ "type":"string", "max":100, "min":1, "pattern":"^(AWS|Custom):.*$" }, "InventoryItemTypeNameFilter":{ "type":"string", "max":100, "min":0 }, "InventoryQueryOperatorType":{ "type":"string", "enum":[ "Equal", "NotEqual", "BeginWith", "LessThan", "GreaterThan" ] }, "InventoryResultEntity":{ "type":"structure", "members":{ "Id":{ "shape":"InventoryResultEntityId", "documentation":"

ID of the inventory result entity. For example, for managed instance inventory the result will be the managed instance ID. For EC2 instance inventory, the result will be the instance ID.

" }, "Data":{ "shape":"InventoryResultItemMap", "documentation":"

The data section in the inventory result entity json.

" } }, "documentation":"

Inventory query results.

" }, "InventoryResultEntityId":{"type":"string"}, "InventoryResultEntityList":{ "type":"list", "member":{ "shape":"InventoryResultEntity", "locationName":"Entity" } }, "InventoryResultItem":{ "type":"structure", "required":[ "TypeName", "SchemaVersion", "Content" ], "members":{ "TypeName":{ "shape":"InventoryItemTypeName", "documentation":"

The name of the inventory result item type.

" }, "SchemaVersion":{ "shape":"InventoryItemSchemaVersion", "documentation":"

The schema version for the inventory result item/

" }, "CaptureTime":{ "shape":"InventoryItemCaptureTime", "documentation":"

The time inventory item data was captured.

" }, "ContentHash":{ "shape":"InventoryItemContentHash", "documentation":"

MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API does not update the inventory item type contents if the MD5 hash has not changed since last update.

" }, "Content":{ "shape":"InventoryItemEntryList", "documentation":"

Contains all the inventory data of the item type. Results include attribute names and values.

" } }, "documentation":"

The inventory result item.

" }, "InventoryResultItemKey":{"type":"string"}, "InventoryResultItemMap":{ "type":"map", "key":{"shape":"InventoryResultItemKey"}, "value":{"shape":"InventoryResultItem"} }, "InvocationDoesNotExist":{ "type":"structure", "members":{ }, "documentation":"

The command ID and instance ID you specified did not match any invocations. Verify the command ID adn the instance ID and try again.

", "exception":true }, "InvocationTraceOutput":{ "type":"string", "max":2500 }, "ItemContentMismatchException":{ "type":"structure", "members":{ "TypeName":{"shape":"InventoryItemTypeName"}, "Message":{"shape":"String"} }, "documentation":"

The inventory item has invalid content.

", "exception":true }, "ItemSizeLimitExceededException":{ "type":"structure", "members":{ "TypeName":{"shape":"InventoryItemTypeName"}, "Message":{"shape":"String"} }, "documentation":"

The inventory item size has exceeded the size limit.

", "exception":true }, "KeyList":{ "type":"list", "member":{"shape":"TagKey"} }, "ListAssociationsRequest":{ "type":"structure", "members":{ "AssociationFilterList":{ "shape":"AssociationFilterList", "documentation":"

One or more filters. Use a filter to return a more specific list of results.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "ListAssociationsResult":{ "type":"structure", "members":{ "Associations":{ "shape":"AssociationList", "documentation":"

The associations.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "ListCommandInvocationsRequest":{ "type":"structure", "members":{ "CommandId":{ "shape":"CommandId", "documentation":"

(Optional) The invocations for a specific command ID.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

(Optional) The command execution details for a specific instance ID.

" }, "MaxResults":{ "shape":"CommandMaxResults", "documentation":"

(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

" }, "Filters":{ "shape":"CommandFilterList", "documentation":"

(Optional) One or more filters. Use a filter to return a more specific list of results.

" }, "Details":{ "shape":"Boolean", "documentation":"

(Optional) If set this returns the response of the command executions and any command output. By default this is set to False.

" } } }, "ListCommandInvocationsResult":{ "type":"structure", "members":{ "CommandInvocations":{ "shape":"CommandInvocationList", "documentation":"

(Optional) A list of all invocations.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "ListCommandsRequest":{ "type":"structure", "members":{ "CommandId":{ "shape":"CommandId", "documentation":"

(Optional) If provided, lists only the specified command.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

(Optional) Lists commands issued against this instance ID.

" }, "MaxResults":{ "shape":"CommandMaxResults", "documentation":"

(Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

" }, "Filters":{ "shape":"CommandFilterList", "documentation":"

(Optional) One or more filters. Use a filter to return a more specific list of results.

" } } }, "ListCommandsResult":{ "type":"structure", "members":{ "Commands":{ "shape":"CommandList", "documentation":"

(Optional) The list of commands requested by the user.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "ListDocumentVersionsRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the document about which you want version information.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "ListDocumentVersionsResult":{ "type":"structure", "members":{ "DocumentVersions":{ "shape":"DocumentVersionList", "documentation":"

The document versions.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "ListDocumentsRequest":{ "type":"structure", "members":{ "DocumentFilterList":{ "shape":"DocumentFilterList", "documentation":"

One or more filters. Use a filter to return a more specific list of results.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } } }, "ListDocumentsResult":{ "type":"structure", "members":{ "DocumentIdentifiers":{ "shape":"DocumentIdentifierList", "documentation":"

The names of the SSM documents.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "ListInventoryEntriesRequest":{ "type":"structure", "required":[ "InstanceId", "TypeName" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The instance ID for which you want inventory information.

" }, "TypeName":{ "shape":"InventoryItemTypeName", "documentation":"

The type of inventory item for which you want information.

" }, "Filters":{ "shape":"InventoryFilterList", "documentation":"

One or more filters. Use a filter to return a more specific list of results.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

", "box":true } } }, "ListInventoryEntriesResult":{ "type":"structure", "members":{ "TypeName":{ "shape":"InventoryItemTypeName", "documentation":"

The type of inventory item returned by the request.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The instance ID targeted by the request to query inventory information.

" }, "SchemaVersion":{ "shape":"InventoryItemSchemaVersion", "documentation":"

The inventory schema version used by the instance(s).

" }, "CaptureTime":{ "shape":"InventoryItemCaptureTime", "documentation":"

The time that inventory information was collected for the instance(s).

" }, "Entries":{ "shape":"InventoryItemEntryList", "documentation":"

A list of inventory items on the instance(s).

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":[ "ResourceType", "ResourceId" ], "members":{ "ResourceType":{ "shape":"ResourceTypeForTagging", "documentation":"

Returns a list of tags for a specific resource type.

" }, "ResourceId":{ "shape":"ResourceId", "documentation":"

The resource ID for which you want to see a list of tags.

" } } }, "ListTagsForResourceResult":{ "type":"structure", "members":{ "TagList":{ "shape":"TagList", "documentation":"

A list of tags.

" } } }, "LoggingInfo":{ "type":"structure", "required":[ "S3BucketName", "S3Region" ], "members":{ "S3BucketName":{ "shape":"S3BucketName", "documentation":"

The name of an Amazon S3 bucket where execution logs are stored .

" }, "S3KeyPrefix":{ "shape":"S3KeyPrefix", "documentation":"

(Optional) The Amazon S3 bucket subfolder.

" }, "S3Region":{ "shape":"S3Region", "documentation":"

The region where the Amazon S3 bucket is located.

" } }, "documentation":"

Information about an Amazon S3 bucket to write instance-level logs to.

" }, "MaintenanceWindowAllowUnassociatedTargets":{"type":"boolean"}, "MaintenanceWindowCutoff":{ "type":"integer", "max":23, "min":0 }, "MaintenanceWindowDurationHours":{ "type":"integer", "max":24, "min":1 }, "MaintenanceWindowEnabled":{"type":"boolean"}, "MaintenanceWindowExecution":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the Maintenance Window.

" }, "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the Maintenance Window execution.

" }, "Status":{ "shape":"MaintenanceWindowExecutionStatus", "documentation":"

The status of the execution.

" }, "StatusDetails":{ "shape":"MaintenanceWindowExecutionStatusDetails", "documentation":"

The details explaining the Status. Only available for certain status values.

" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time the execution started.

" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time the execution finished.

" } }, "documentation":"

Describes the information about an execution of a Maintenance Window.

" }, "MaintenanceWindowExecutionId":{ "type":"string", "max":36, "min":36, "pattern":"^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "MaintenanceWindowExecutionList":{ "type":"list", "member":{"shape":"MaintenanceWindowExecution"} }, "MaintenanceWindowExecutionStatus":{ "type":"string", "enum":[ "PENDING", "IN_PROGRESS", "SUCCESS", "FAILED", "TIMED_OUT", "CANCELLING", "CANCELLED", "SKIPPED_OVERLAPPING" ] }, "MaintenanceWindowExecutionStatusDetails":{ "type":"string", "max":250, "min":0 }, "MaintenanceWindowExecutionTaskExecutionId":{"type":"string"}, "MaintenanceWindowExecutionTaskId":{ "type":"string", "max":36, "min":36, "pattern":"^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "MaintenanceWindowExecutionTaskIdList":{ "type":"list", "member":{"shape":"MaintenanceWindowExecutionTaskId"} }, "MaintenanceWindowExecutionTaskIdentity":{ "type":"structure", "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the Maintenance Window execution that ran the task.

" }, "TaskExecutionId":{ "shape":"MaintenanceWindowExecutionTaskId", "documentation":"

The ID of the specific task execution in the Maintenance Window execution.

" }, "Status":{ "shape":"MaintenanceWindowExecutionStatus", "documentation":"

The status of the task execution.

" }, "StatusDetails":{ "shape":"MaintenanceWindowExecutionStatusDetails", "documentation":"

The details explaining the status of the task execution. Only available for certain status values.

" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time the task execution started.

" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time the task execution finished.

" }, "TaskArn":{ "shape":"MaintenanceWindowTaskArn", "documentation":"

The ARN of the executed task.

" }, "TaskType":{ "shape":"MaintenanceWindowTaskType", "documentation":"

The type of executed task.

" } }, "documentation":"

Information about a task execution performed as part of a Maintenance Window execution.

" }, "MaintenanceWindowExecutionTaskIdentityList":{ "type":"list", "member":{"shape":"MaintenanceWindowExecutionTaskIdentity"} }, "MaintenanceWindowExecutionTaskInvocationId":{ "type":"string", "max":36, "min":36, "pattern":"^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "MaintenanceWindowExecutionTaskInvocationIdentity":{ "type":"structure", "members":{ "WindowExecutionId":{ "shape":"MaintenanceWindowExecutionId", "documentation":"

The ID of the Maintenance Window execution that ran the task.

" }, "TaskExecutionId":{ "shape":"MaintenanceWindowExecutionTaskId", "documentation":"

The ID of the specific task execution in the Maintenance Window execution.

" }, "InvocationId":{ "shape":"MaintenanceWindowExecutionTaskInvocationId", "documentation":"

The ID of the task invocation.

" }, "ExecutionId":{ "shape":"MaintenanceWindowExecutionTaskExecutionId", "documentation":"

The ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND, this value is the command ID.

" }, "Parameters":{ "shape":"MaintenanceWindowExecutionTaskInvocationParameters", "documentation":"

The parameters that were provided for the invocation when it was executed.

" }, "Status":{ "shape":"MaintenanceWindowExecutionStatus", "documentation":"

The status of the task invocation.

" }, "StatusDetails":{ "shape":"MaintenanceWindowExecutionStatusDetails", "documentation":"

The details explaining the status of the task invocation. Only available for certain Status values.

" }, "StartTime":{ "shape":"DateTime", "documentation":"

The time the invocation started.

" }, "EndTime":{ "shape":"DateTime", "documentation":"

The time the invocation finished.

" }, "OwnerInformation":{ "shape":"OwnerInformation", "documentation":"

User-provided value that was specified when the target was registered with the Maintenance Window. This was also included in any CloudWatch events raised during the task invocation.

" }, "WindowTargetId":{ "shape":"MaintenanceWindowTaskTargetId", "documentation":"

The ID of the target definition in this Maintenance Window the invocation was performed for.

" } }, "documentation":"

Describes the information about a task invocation for a particular target as part of a task execution performed as part of a Maintenance Window execution.

" }, "MaintenanceWindowExecutionTaskInvocationIdentityList":{ "type":"list", "member":{"shape":"MaintenanceWindowExecutionTaskInvocationIdentity"} }, "MaintenanceWindowExecutionTaskInvocationParameters":{ "type":"string", "sensitive":true }, "MaintenanceWindowFilter":{ "type":"structure", "members":{ "Key":{ "shape":"MaintenanceWindowFilterKey", "documentation":"

The name of the filter.

" }, "Values":{ "shape":"MaintenanceWindowFilterValues", "documentation":"

The filter values.

" } }, "documentation":"

Filter used in the request.

" }, "MaintenanceWindowFilterKey":{ "type":"string", "max":128, "min":1 }, "MaintenanceWindowFilterList":{ "type":"list", "member":{"shape":"MaintenanceWindowFilter"}, "max":5, "min":0 }, "MaintenanceWindowFilterValue":{ "type":"string", "max":256, "min":1 }, "MaintenanceWindowFilterValues":{ "type":"list", "member":{"shape":"MaintenanceWindowFilterValue"} }, "MaintenanceWindowId":{ "type":"string", "max":20, "min":20, "pattern":"^mw-[0-9a-f]{17}$" }, "MaintenanceWindowIdentity":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the Maintenance Window.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The name of the Maintenance Window.

" }, "Enabled":{ "shape":"MaintenanceWindowEnabled", "documentation":"

Whether the Maintenance Window is enabled.

" }, "Duration":{ "shape":"MaintenanceWindowDurationHours", "documentation":"

The duration of the Maintenance Window in hours.

" }, "Cutoff":{ "shape":"MaintenanceWindowCutoff", "documentation":"

The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

" } }, "documentation":"

Information about the Maintenance Window.

" }, "MaintenanceWindowIdentityList":{ "type":"list", "member":{"shape":"MaintenanceWindowIdentity"} }, "MaintenanceWindowMaxResults":{ "type":"integer", "max":100, "min":10 }, "MaintenanceWindowName":{ "type":"string", "max":128, "min":3, "pattern":"^[a-zA-Z0-9_\\-.]{3,128}$" }, "MaintenanceWindowResourceType":{ "type":"string", "enum":["INSTANCE"] }, "MaintenanceWindowSchedule":{ "type":"string", "max":256, "min":1 }, "MaintenanceWindowTarget":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The Maintenance Window ID where the target is registered.

" }, "WindowTargetId":{ "shape":"MaintenanceWindowTargetId", "documentation":"

The ID of the target.

" }, "ResourceType":{ "shape":"MaintenanceWindowResourceType", "documentation":"

The type of target.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

" }, "OwnerInformation":{ "shape":"OwnerInformation", "documentation":"

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.

" } }, "documentation":"

The target registered with the Maintenance Window.

" }, "MaintenanceWindowTargetId":{ "type":"string", "max":36, "min":36, "pattern":"^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "MaintenanceWindowTargetList":{ "type":"list", "member":{"shape":"MaintenanceWindowTarget"} }, "MaintenanceWindowTask":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The Maintenance Window ID where the task is registered.

" }, "WindowTaskId":{ "shape":"MaintenanceWindowTaskId", "documentation":"

The task ID.

" }, "TaskArn":{ "shape":"MaintenanceWindowTaskArn", "documentation":"

The ARN of the task to execute.

" }, "Type":{ "shape":"MaintenanceWindowTaskType", "documentation":"

The type of task.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

" }, "TaskParameters":{ "shape":"MaintenanceWindowTaskParameters", "documentation":"

The parameters that should be passed to the task when it is executed.

" }, "Priority":{ "shape":"MaintenanceWindowTaskPriority", "documentation":"

The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

" }, "LoggingInfo":{ "shape":"LoggingInfo", "documentation":"

Information about an Amazon S3 bucket to write task-level logs to.

" }, "ServiceRoleArn":{ "shape":"ServiceRole", "documentation":"

The role that should be assumed when executing the task

" }, "MaxConcurrency":{ "shape":"VelocityConstraint", "documentation":"

The maximum number of targets this task can be run for in parallel.

" }, "MaxErrors":{ "shape":"VelocityConstraint", "documentation":"

The maximum number of errors allowed before this task stops being scheduled.

" } }, "documentation":"

Information about a task defined for a Maintenance Window.

" }, "MaintenanceWindowTaskArn":{ "type":"string", "max":1600, "min":1 }, "MaintenanceWindowTaskId":{ "type":"string", "max":36, "min":36, "pattern":"^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "MaintenanceWindowTaskList":{ "type":"list", "member":{"shape":"MaintenanceWindowTask"} }, "MaintenanceWindowTaskParameterName":{ "type":"string", "max":255, "min":1 }, "MaintenanceWindowTaskParameterValue":{ "type":"string", "max":255, "min":1, "sensitive":true }, "MaintenanceWindowTaskParameterValueExpression":{ "type":"structure", "members":{ "Values":{ "shape":"MaintenanceWindowTaskParameterValueList", "documentation":"

This field contains an array of 0 or more strings, each 1 to 255 characters in length.

" } }, "documentation":"

Defines the values for a task parameter.

", "sensitive":true }, "MaintenanceWindowTaskParameterValueList":{ "type":"list", "member":{"shape":"MaintenanceWindowTaskParameterValue"}, "sensitive":true }, "MaintenanceWindowTaskParameters":{ "type":"map", "key":{"shape":"MaintenanceWindowTaskParameterName"}, "value":{"shape":"MaintenanceWindowTaskParameterValueExpression"}, "sensitive":true }, "MaintenanceWindowTaskParametersList":{ "type":"list", "member":{"shape":"MaintenanceWindowTaskParameters"}, "sensitive":true }, "MaintenanceWindowTaskPriority":{ "type":"integer", "min":0 }, "MaintenanceWindowTaskTargetId":{ "type":"string", "max":36 }, "MaintenanceWindowTaskType":{ "type":"string", "enum":["RUN_COMMAND"] }, "ManagedInstanceId":{ "type":"string", "pattern":"^mi-[0-9a-f]{17}$" }, "MaxDocumentSizeExceeded":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The size limit of an SSM document is 64 KB.

", "exception":true }, "MaxResults":{ "type":"integer", "max":50, "min":1 }, "MaxResultsEC2Compatible":{ "type":"integer", "max":50, "min":5 }, "ModifyDocumentPermissionRequest":{ "type":"structure", "required":[ "Name", "PermissionType" ], "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the document that you want to share.

" }, "PermissionType":{ "shape":"DocumentPermissionType", "documentation":"

The permission type for the document. The permission type can be Share.

" }, "AccountIdsToAdd":{ "shape":"AccountIdList", "documentation":"

The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.

" }, "AccountIdsToRemove":{ "shape":"AccountIdList", "documentation":"

The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.

" } } }, "ModifyDocumentPermissionResponse":{ "type":"structure", "members":{ } }, "NextToken":{"type":"string"}, "NormalStringMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "NotificationArn":{"type":"string"}, "NotificationConfig":{ "type":"structure", "members":{ "NotificationArn":{ "shape":"NotificationArn", "documentation":"

An Amazon Resource Name (ARN) for a Simple Notification Service (SNS) topic. Run Command pushes notifications about command status changes to this topic.

" }, "NotificationEvents":{ "shape":"NotificationEventList", "documentation":"

The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Monitoring Commands in the Amazon Elastic Compute Cloud User Guide .

" }, "NotificationType":{ "shape":"NotificationType", "documentation":"

Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.

" } }, "documentation":"

Configurations for sending notifications.

" }, "NotificationEvent":{ "type":"string", "enum":[ "All", "InProgress", "Success", "TimedOut", "Cancelled", "Failed" ] }, "NotificationEventList":{ "type":"list", "member":{"shape":"NotificationEvent"} }, "NotificationType":{ "type":"string", "enum":[ "Command", "Invocation" ] }, "OwnerInformation":{ "type":"string", "max":128, "min":1, "sensitive":true }, "PSParameterName":{ "type":"string", "max":1024, "min":1, "pattern":"^(?!^([aA][wW][sS]|[sS][sS][mM]))(?=^[a-zA-Z0-9_.-]*$).*$" }, "PSParameterValue":{ "type":"string", "max":1024, "min":1, "pattern":"^(?:(?!(\\{\\{.*\\}\\})).)*$" }, "Parameter":{ "type":"structure", "members":{ "Name":{ "shape":"PSParameterName", "documentation":"

The name of the parameter.

" }, "Type":{ "shape":"ParameterType", "documentation":"

The type of parameter. Valid values include the following: String, String list, Secure string.

" }, "Value":{ "shape":"PSParameterValue", "documentation":"

The parameter value.

" } }, "documentation":"

An Amazon EC2 Systems Manager parameter in Parameter Store.

" }, "ParameterAlreadyExists":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The parameter already exists. You can't create duplicate parameters.

", "exception":true }, "ParameterDescription":{ "type":"string", "max":1024, "min":1 }, "ParameterHistory":{ "type":"structure", "members":{ "Name":{ "shape":"PSParameterName", "documentation":"

The name of the parameter.

" }, "Type":{ "shape":"ParameterType", "documentation":"

The type of parameter used.

" }, "KeyId":{ "shape":"ParameterKeyId", "documentation":"

The ID of the query key used for this parameter.

" }, "LastModifiedDate":{ "shape":"DateTime", "documentation":"

Date the parameter was last changed or updated.

" }, "LastModifiedUser":{ "shape":"String", "documentation":"

Amazon Resource Name (ARN) of the AWS user who last changed the parameter.

" }, "Description":{ "shape":"ParameterDescription", "documentation":"

Information about the parameter.

" }, "Value":{ "shape":"PSParameterValue", "documentation":"

The parameter value.

" } }, "documentation":"

Information about parameter usage.

" }, "ParameterHistoryList":{ "type":"list", "member":{"shape":"ParameterHistory"} }, "ParameterKeyId":{ "type":"string", "max":256, "min":1, "pattern":"^([a-zA-Z0-9:/_-]+)$" }, "ParameterLimitExceeded":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

You have exceeded the number of parameters for this AWS account. Delete one or more parameters and try again.

", "exception":true }, "ParameterList":{ "type":"list", "member":{"shape":"Parameter"} }, "ParameterMetadata":{ "type":"structure", "members":{ "Name":{ "shape":"PSParameterName", "documentation":"

The parameter name.

" }, "Type":{ "shape":"ParameterType", "documentation":"

The type of parameter. Valid parameter types include the following: String, String list, Secure string.

" }, "KeyId":{ "shape":"ParameterKeyId", "documentation":"

The ID of the query key used for this parameter.

" }, "LastModifiedDate":{ "shape":"DateTime", "documentation":"

Date the parameter was last changed or updated.

" }, "LastModifiedUser":{ "shape":"String", "documentation":"

Amazon Resource Name (ARN) of the AWS user who last changed the parameter.

" }, "Description":{ "shape":"ParameterDescription", "documentation":"

Description of the parameter actions.

" } }, "documentation":"

Metada includes information like the ARN of the last user and the date/time the parameter was last used.

" }, "ParameterMetadataList":{ "type":"list", "member":{"shape":"ParameterMetadata"} }, "ParameterName":{"type":"string"}, "ParameterNameList":{ "type":"list", "member":{"shape":"PSParameterName"}, "max":10, "min":1 }, "ParameterNotFound":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The parameter could not be found. Verify the name and try again.

", "exception":true }, "ParameterType":{ "type":"string", "enum":[ "String", "StringList", "SecureString" ] }, "ParameterValue":{"type":"string"}, "ParameterValueList":{ "type":"list", "member":{"shape":"ParameterValue"} }, "Parameters":{ "type":"map", "key":{"shape":"ParameterName"}, "value":{"shape":"ParameterValueList"} }, "ParametersFilter":{ "type":"structure", "required":["Values"], "members":{ "Key":{ "shape":"ParametersFilterKey", "documentation":"

The name of the filter.

" }, "Values":{ "shape":"ParametersFilterValueList", "documentation":"

The filter values.

" } }, "documentation":"

One or more filters. Use a filter to return a more specific list of results.

" }, "ParametersFilterKey":{ "type":"string", "enum":[ "Name", "Type", "KeyId" ] }, "ParametersFilterList":{ "type":"list", "member":{"shape":"ParametersFilter"} }, "ParametersFilterValue":{ "type":"string", "max":100, "min":1 }, "ParametersFilterValueList":{ "type":"list", "member":{"shape":"ParametersFilterValue"}, "max":50, "min":1 }, "Patch":{ "type":"structure", "members":{ "Id":{ "shape":"PatchId", "documentation":"

The ID of the patch (this is different than the Microsoft Knowledge Base ID).

" }, "ReleaseDate":{ "shape":"DateTime", "documentation":"

The date the patch was released.

" }, "Title":{ "shape":"PatchTitle", "documentation":"

The title of the patch.

" }, "Description":{ "shape":"PatchDescription", "documentation":"

The description of the patch.

" }, "ContentUrl":{ "shape":"PatchContentUrl", "documentation":"

The URL where more information can be obtained about the patch.

" }, "Vendor":{ "shape":"PatchVendor", "documentation":"

The name of the vendor providing the patch.

" }, "ProductFamily":{ "shape":"PatchProductFamily", "documentation":"

The product family the patch is applicable for (for example, Windows).

" }, "Product":{ "shape":"PatchProduct", "documentation":"

The specific product the patch is applicable for (for example, WindowsServer2016).

" }, "Classification":{ "shape":"PatchClassification", "documentation":"

The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).

" }, "MsrcSeverity":{ "shape":"PatchMsrcSeverity", "documentation":"

The severity of the patch (for example Critical, Important, Moderate).

" }, "KbNumber":{ "shape":"PatchKbNumber", "documentation":"

The Microsoft Knowledge Base ID of the patch.

" }, "MsrcNumber":{ "shape":"PatchMsrcNumber", "documentation":"

The ID of the MSRC bulletin the patch is related to.

" }, "Language":{ "shape":"PatchLanguage", "documentation":"

The language of the patch if it’s language-specific.

" } }, "documentation":"

Represents metadata about a patch.

" }, "PatchBaselineIdentity":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline.

" }, "BaselineName":{ "shape":"BaselineName", "documentation":"

The name of the patch baseline.

" }, "BaselineDescription":{ "shape":"BaselineDescription", "documentation":"

The description of the patch baseline.

" }, "DefaultBaseline":{ "shape":"DefaultBaseline", "documentation":"

Whether this is the default baseline.

" } }, "documentation":"

Defines the basic information about a patch baseline.

" }, "PatchBaselineIdentityList":{ "type":"list", "member":{"shape":"PatchBaselineIdentity"} }, "PatchBaselineMaxResults":{ "type":"integer", "max":100, "min":1 }, "PatchClassification":{"type":"string"}, "PatchComplianceData":{ "type":"structure", "required":[ "Title", "KBId", "Classification", "Severity", "State", "InstalledTime" ], "members":{ "Title":{ "shape":"PatchTitle", "documentation":"

The title of the patch.

" }, "KBId":{ "shape":"PatchKbNumber", "documentation":"

The Microsoft Knowledge Base ID of the patch.

" }, "Classification":{ "shape":"PatchClassification", "documentation":"

The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).

" }, "Severity":{ "shape":"PatchSeverity", "documentation":"

The severity of the patch (for example, Critical, Important, Moderate).

" }, "State":{ "shape":"PatchComplianceDataState", "documentation":"

The state of the patch on the instance (INSTALLED, INSTALLED_OTHER, MISSING, NOT_APPLICABLE or FAILED).

" }, "InstalledTime":{ "shape":"PatchInstalledTime", "documentation":"

The date/time the patch was installed on the instance.

" } }, "documentation":"

Information about the state of a patch on a particular instance as it relates to the patch baseline used to patch the instance.

" }, "PatchComplianceDataList":{ "type":"list", "member":{"shape":"PatchComplianceData"} }, "PatchComplianceDataState":{ "type":"string", "enum":[ "INSTALLED", "INSTALLED_OTHER", "MISSING", "NOT_APPLICABLE", "FAILED" ] }, "PatchComplianceMaxResults":{ "type":"integer", "max":100, "min":10 }, "PatchContentUrl":{"type":"string"}, "PatchDeploymentStatus":{ "type":"string", "enum":[ "APPROVED", "PENDING_APPROVAL", "EXPLICIT_APPROVED", "EXPLICIT_REJECTED" ] }, "PatchDescription":{"type":"string"}, "PatchFailedCount":{"type":"integer"}, "PatchFilter":{ "type":"structure", "required":[ "Key", "Values" ], "members":{ "Key":{ "shape":"PatchFilterKey", "documentation":"

The key for the filter (PRODUCT, CLASSIFICATION, MSRC_SEVERITY, PATCH_ID)

" }, "Values":{ "shape":"PatchFilterValueList", "documentation":"

The value for the filter key.

" } }, "documentation":"

Defines a patch filter.

" }, "PatchFilterGroup":{ "type":"structure", "required":["PatchFilters"], "members":{ "PatchFilters":{ "shape":"PatchFilterList", "documentation":"

The set of patch filters that make up the group.

" } }, "documentation":"

A set of patch filters, typically used for approval rules.

" }, "PatchFilterKey":{ "type":"string", "enum":[ "PRODUCT", "CLASSIFICATION", "MSRC_SEVERITY", "PATCH_ID" ] }, "PatchFilterList":{ "type":"list", "member":{"shape":"PatchFilter"}, "max":4, "min":0 }, "PatchFilterValue":{ "type":"string", "max":64, "min":1 }, "PatchFilterValueList":{ "type":"list", "member":{"shape":"PatchFilterValue"}, "max":20, "min":1 }, "PatchGroup":{ "type":"string", "max":256, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "PatchGroupList":{ "type":"list", "member":{"shape":"PatchGroup"} }, "PatchGroupPatchBaselineMapping":{ "type":"structure", "members":{ "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group registered with the patch baseline.

" }, "BaselineIdentity":{ "shape":"PatchBaselineIdentity", "documentation":"

The patch baseline the patch group is registered with.

" } }, "documentation":"

The mapping between a patch group and the patch baseline the patch group is registered with.

" }, "PatchGroupPatchBaselineMappingList":{ "type":"list", "member":{"shape":"PatchGroupPatchBaselineMapping"} }, "PatchId":{ "type":"string", "pattern":"(^KB[0-9]{1,7}$)|(^MS[0-9]{2}\\-[0-9]{3}$)" }, "PatchIdList":{ "type":"list", "member":{"shape":"PatchId"}, "max":50, "min":0 }, "PatchInstalledCount":{"type":"integer"}, "PatchInstalledOtherCount":{"type":"integer"}, "PatchInstalledTime":{"type":"timestamp"}, "PatchKbNumber":{"type":"string"}, "PatchLanguage":{"type":"string"}, "PatchList":{ "type":"list", "member":{"shape":"Patch"} }, "PatchMissingCount":{"type":"integer"}, "PatchMsrcNumber":{"type":"string"}, "PatchMsrcSeverity":{"type":"string"}, "PatchNotApplicableCount":{"type":"integer"}, "PatchOperationEndTime":{"type":"timestamp"}, "PatchOperationStartTime":{"type":"timestamp"}, "PatchOperationType":{ "type":"string", "enum":[ "Scan", "Install" ] }, "PatchOrchestratorFilter":{ "type":"structure", "members":{ "Key":{ "shape":"PatchOrchestratorFilterKey", "documentation":"

The key for the filter.

" }, "Values":{ "shape":"PatchOrchestratorFilterValues", "documentation":"

The value for the filter.

" } }, "documentation":"

Defines a filter used in Patch Manager APIs.

" }, "PatchOrchestratorFilterKey":{ "type":"string", "max":128, "min":1 }, "PatchOrchestratorFilterList":{ "type":"list", "member":{"shape":"PatchOrchestratorFilter"}, "max":5, "min":0 }, "PatchOrchestratorFilterValue":{ "type":"string", "max":256, "min":1 }, "PatchOrchestratorFilterValues":{ "type":"list", "member":{"shape":"PatchOrchestratorFilterValue"} }, "PatchProduct":{"type":"string"}, "PatchProductFamily":{"type":"string"}, "PatchRule":{ "type":"structure", "required":[ "PatchFilterGroup", "ApproveAfterDays" ], "members":{ "PatchFilterGroup":{ "shape":"PatchFilterGroup", "documentation":"

The patch filter group that defines the criteria for the rule.

" }, "ApproveAfterDays":{ "shape":"ApproveAfterDays", "documentation":"

The number of days after the release date of each patch matched by the rule the patch is marked as approved in the patch baseline.

", "box":true } }, "documentation":"

Defines an approval rule for a patch baseline.

" }, "PatchRuleGroup":{ "type":"structure", "required":["PatchRules"], "members":{ "PatchRules":{ "shape":"PatchRuleList", "documentation":"

The rules that make up the rule group.

" } }, "documentation":"

A set of rules defining the approval rules for a patch baseline.

" }, "PatchRuleList":{ "type":"list", "member":{"shape":"PatchRule"}, "max":10, "min":0 }, "PatchSeverity":{"type":"string"}, "PatchStatus":{ "type":"structure", "members":{ "DeploymentStatus":{ "shape":"PatchDeploymentStatus", "documentation":"

The approval status of a patch (APPROVED, PENDING_APPROVAL, EXPLICIT_APPROVED, EXPLICIT_REJECTED).

" }, "ApprovalDate":{ "shape":"DateTime", "documentation":"

The date the patch was approved (or will be approved if the status is PENDING_APPROVAL).

" } }, "documentation":"

Information about the approval status of a patch.

" }, "PatchTitle":{"type":"string"}, "PatchVendor":{"type":"string"}, "PingStatus":{ "type":"string", "enum":[ "Online", "ConnectionLost", "Inactive" ] }, "PlatformType":{ "type":"string", "enum":[ "Windows", "Linux" ] }, "PlatformTypeList":{ "type":"list", "member":{ "shape":"PlatformType", "locationName":"PlatformType" } }, "PutInventoryRequest":{ "type":"structure", "required":[ "InstanceId", "Items" ], "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

One or more instance IDs where you want to add or update inventory items.

" }, "Items":{ "shape":"InventoryItemList", "documentation":"

The inventory items that you want to add or update on instances.

" } } }, "PutInventoryResult":{ "type":"structure", "members":{ } }, "PutParameterRequest":{ "type":"structure", "required":[ "Name", "Value", "Type" ], "members":{ "Name":{ "shape":"PSParameterName", "documentation":"

The name of the parameter that you want to add to the system.

" }, "Description":{ "shape":"ParameterDescription", "documentation":"

Information about the parameter that you want to add to the system

" }, "Value":{ "shape":"PSParameterValue", "documentation":"

The parameter value that you want to add to the system.

" }, "Type":{ "shape":"ParameterType", "documentation":"

The type of parameter that you want to add to the system.

" }, "KeyId":{ "shape":"ParameterKeyId", "documentation":"

The parameter key ID that you want to add to the system.

" }, "Overwrite":{ "shape":"Boolean", "documentation":"

Overwrite an existing parameter.

", "box":true } } }, "PutParameterResult":{ "type":"structure", "members":{ } }, "RegisterDefaultPatchBaselineRequest":{ "type":"structure", "required":["BaselineId"], "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline that should be the default patch baseline.

" } } }, "RegisterDefaultPatchBaselineResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the default patch baseline.

" } } }, "RegisterPatchBaselineForPatchGroupRequest":{ "type":"structure", "required":[ "BaselineId", "PatchGroup" ], "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline to register the patch group with.

" }, "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group that should be registered with the patch baseline.

" } } }, "RegisterPatchBaselineForPatchGroupResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline the patch group was registered with.

" }, "PatchGroup":{ "shape":"PatchGroup", "documentation":"

The name of the patch group registered with the patch baseline.

" } } }, "RegisterTargetWithMaintenanceWindowRequest":{ "type":"structure", "required":[ "WindowId", "ResourceType", "Targets" ], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the Maintenance Window the target should be registered with.

" }, "ResourceType":{ "shape":"MaintenanceWindowResourceType", "documentation":"

The type of target being registered with the Maintenance Window.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

" }, "OwnerInformation":{ "shape":"OwnerInformation", "documentation":"

User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this Maintenance Window.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

User-provided idempotency token.

", "idempotencyToken":true } } }, "RegisterTargetWithMaintenanceWindowResult":{ "type":"structure", "members":{ "WindowTargetId":{ "shape":"MaintenanceWindowTargetId", "documentation":"

The ID of the target definition in this Maintenance Window.

" } } }, "RegisterTaskWithMaintenanceWindowRequest":{ "type":"structure", "required":[ "WindowId", "Targets", "TaskArn", "ServiceRoleArn", "TaskType", "MaxConcurrency", "MaxErrors" ], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The id of the Maintenance Window the task should be added to.

" }, "Targets":{ "shape":"Targets", "documentation":"

The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

" }, "TaskArn":{ "shape":"MaintenanceWindowTaskArn", "documentation":"

The ARN of the task to execute

" }, "ServiceRoleArn":{ "shape":"ServiceRole", "documentation":"

The role that should be assumed when executing the task.

" }, "TaskType":{ "shape":"MaintenanceWindowTaskType", "documentation":"

The type of task being registered.

" }, "TaskParameters":{ "shape":"MaintenanceWindowTaskParameters", "documentation":"

The parameters that should be passed to the task when it is executed.

" }, "Priority":{ "shape":"MaintenanceWindowTaskPriority", "documentation":"

The priority of the task in the Maintenance Window, the lower the number the higher the priority. Tasks in a Maintenance Window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

", "box":true }, "MaxConcurrency":{ "shape":"VelocityConstraint", "documentation":"

The maximum number of targets this task can be run for in parallel.

" }, "MaxErrors":{ "shape":"VelocityConstraint", "documentation":"

The maximum number of errors allowed before this task stops being scheduled.

" }, "LoggingInfo":{ "shape":"LoggingInfo", "documentation":"

A structure containing information about an Amazon S3 bucket to write instance-level logs to.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

User-provided idempotency token.

", "idempotencyToken":true } } }, "RegisterTaskWithMaintenanceWindowResult":{ "type":"structure", "members":{ "WindowTaskId":{ "shape":"MaintenanceWindowTaskId", "documentation":"

The id of the task in the Maintenance Window.

" } } }, "RegistrationLimit":{ "type":"integer", "max":1000, "min":1 }, "RegistrationsCount":{ "type":"integer", "max":1000, "min":1 }, "RemoveTagsFromResourceRequest":{ "type":"structure", "required":[ "ResourceType", "ResourceId", "TagKeys" ], "members":{ "ResourceType":{ "shape":"ResourceTypeForTagging", "documentation":"

The type of resource of which you want to remove a tag.

" }, "ResourceId":{ "shape":"ResourceId", "documentation":"

The resource ID for which you want to remove tags.

" }, "TagKeys":{ "shape":"KeyList", "documentation":"

Tag keys that you want to remove from the specified resource.

" } } }, "RemoveTagsFromResourceResult":{ "type":"structure", "members":{ } }, "ResourceId":{"type":"string"}, "ResourceInUseException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

Error returned if an attempt is made to delete a patch baseline that is registered for a patch group.

", "exception":true }, "ResourceLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

Error returned when the caller has exceeded the default resource limits (e.g. too many Maintenance Windows have been created).

", "exception":true }, "ResourceType":{ "type":"string", "enum":[ "ManagedInstance", "Document", "EC2Instance" ] }, "ResourceTypeForTagging":{ "type":"string", "enum":[ "ManagedInstance", "MaintenanceWindow", "Parameter" ] }, "ResponseCode":{"type":"integer"}, "ResultAttribute":{ "type":"structure", "required":["TypeName"], "members":{ "TypeName":{ "shape":"InventoryItemTypeName", "documentation":"

Name of the inventory item type. Valid value: “AWS:InstanceInformation”. Default Value: “AWS:InstanceInformation”.

" } }, "documentation":"

The inventory item result attribute.

" }, "ResultAttributeList":{ "type":"list", "member":{ "shape":"ResultAttribute", "locationName":"ResultAttribute" }, "max":1, "min":1 }, "S3BucketName":{ "type":"string", "max":63, "min":3 }, "S3KeyPrefix":{ "type":"string", "max":500 }, "S3OutputLocation":{ "type":"structure", "members":{ "OutputS3Region":{ "shape":"S3Region", "documentation":"

The Amazon S3 region where the association information is stored.

" }, "OutputS3BucketName":{ "shape":"S3BucketName", "documentation":"

The name of the Amazon S3 bucket.

" }, "OutputS3KeyPrefix":{ "shape":"S3KeyPrefix", "documentation":"

The Amazon S3 bucket subfolder.

" } }, "documentation":"

An Amazon S3 bucket where you want to store the results of this request.

" }, "S3OutputUrl":{ "type":"structure", "members":{ "OutputUrl":{ "shape":"Url", "documentation":"

A URL for an Amazon S3 bucket where you want to store the results of this request.

" } }, "documentation":"

A URL for the Amazon S3 bucket where you want to store the results of this request.

" }, "S3Region":{ "type":"string", "max":20, "min":3 }, "ScheduleExpression":{ "type":"string", "max":256, "min":1 }, "SendCommandRequest":{ "type":"structure", "required":["DocumentName"], "members":{ "InstanceIds":{ "shape":"InstanceIdList", "documentation":"

Required. The instance IDs where the command should execute. You can specify a maximum of 50 IDs.

" }, "Targets":{ "shape":"Targets", "documentation":"

(Optional) An array of search criteria that targets instances using a Key;Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use Targets, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).

" }, "DocumentName":{ "shape":"DocumentARN", "documentation":"

Required. The name of the SSM document to execute. This can be an SSM public document or a custom document.

" }, "DocumentHash":{ "shape":"DocumentHash", "documentation":"

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

" }, "DocumentHashType":{ "shape":"DocumentHashType", "documentation":"

Sha256 or Sha1.

Sha1 hashes have been deprecated.

" }, "TimeoutSeconds":{ "shape":"TimeoutSeconds", "documentation":"

If this time is reached and the command has not already started executing, it will not execute.

", "box":true }, "Comment":{ "shape":"Comment", "documentation":"

User-specified information about the command, such as a brief description of what the command should do.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

The required and optional parameters specified in the SSM document being executed.

" }, "OutputS3Region":{ "shape":"S3Region", "documentation":"

(Optional) The region where the Amazon Simple Storage Service (Amazon S3) output bucket is located. The default value is the region where Run Command is being called.

" }, "OutputS3BucketName":{ "shape":"S3BucketName", "documentation":"

The name of the S3 bucket where command execution responses should be stored.

" }, "OutputS3KeyPrefix":{ "shape":"S3KeyPrefix", "documentation":"

The directory structure within the S3 bucket where the responses should be stored.

" }, "MaxConcurrency":{ "shape":"VelocityConstraint", "documentation":"

(Optional) The maximum number of instances that are allowed to execute the command at the same time. You can specify a number such as “10” or a percentage such as “10%”. The default value is 50. For more information about how to use MaxConcurrency, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).

" }, "MaxErrors":{ "shape":"VelocityConstraint", "documentation":"

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like “10” or a percentage like “10%”. The default value is 50. For more information about how to use MaxErrors, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).

" }, "ServiceRoleArn":{ "shape":"ServiceRole", "documentation":"

The IAM role that Systems Manager uses to send notifications.

" }, "NotificationConfig":{ "shape":"NotificationConfig", "documentation":"

Configurations for sending notifications.

" } } }, "SendCommandResult":{ "type":"structure", "members":{ "Command":{ "shape":"Command", "documentation":"

The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.

" } } }, "ServiceRole":{"type":"string"}, "SnapshotDownloadUrl":{"type":"string"}, "SnapshotId":{ "type":"string", "max":36, "min":36, "pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "StandardErrorContent":{ "type":"string", "max":8000 }, "StandardOutputContent":{ "type":"string", "max":24000 }, "StartAutomationExecutionRequest":{ "type":"structure", "required":["DocumentName"], "members":{ "DocumentName":{ "shape":"DocumentARN", "documentation":"

The name of the Automation document to use for this execution.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The version of the Automation document to use for this execution.

", "box":true }, "Parameters":{ "shape":"AutomationParameterMap", "documentation":"

A key-value map of execution parameters, which match the declared parameters in the Automation document.

" } } }, "StartAutomationExecutionResult":{ "type":"structure", "members":{ "AutomationExecutionId":{ "shape":"AutomationExecutionId", "documentation":"

The unique ID of a newly scheduled automation execution.

" } } }, "StatusAdditionalInfo":{ "type":"string", "max":1024 }, "StatusDetails":{ "type":"string", "max":100, "min":0 }, "StatusMessage":{ "type":"string", "max":1024, "min":1 }, "StatusName":{"type":"string"}, "StatusUnchanged":{ "type":"structure", "members":{ }, "documentation":"

The updated status is the same as the current status.

", "exception":true }, "StepExecution":{ "type":"structure", "members":{ "StepName":{ "shape":"String", "documentation":"

The name of this execution step.

" }, "Action":{ "shape":"AutomationActionName", "documentation":"

The action this step performs. The action determines the behavior of the step.

" }, "ExecutionStartTime":{ "shape":"DateTime", "documentation":"

If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field is not populated.

" }, "ExecutionEndTime":{ "shape":"DateTime", "documentation":"

If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.

" }, "StepStatus":{ "shape":"AutomationExecutionStatus", "documentation":"

The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.

" }, "ResponseCode":{ "shape":"String", "documentation":"

The response code returned by the execution of the step.

" }, "Inputs":{ "shape":"NormalStringMap", "documentation":"

Fully-resolved values passed into the step before execution.

" }, "Outputs":{ "shape":"AutomationParameterMap", "documentation":"

Returned values from the execution of the step.

" }, "Response":{ "shape":"String", "documentation":"

A message associated with the response code for an execution.

" }, "FailureMessage":{ "shape":"String", "documentation":"

If a step failed, this message explains why the execution failed.

" } }, "documentation":"

Detailed information about an the execution state of an Automation step.

" }, "StepExecutionList":{ "type":"list", "member":{"shape":"StepExecution"}, "max":100, "min":0 }, "StopAutomationExecutionRequest":{ "type":"structure", "required":["AutomationExecutionId"], "members":{ "AutomationExecutionId":{ "shape":"AutomationExecutionId", "documentation":"

The execution ID of the Automation to stop.

" } } }, "StopAutomationExecutionResult":{ "type":"structure", "members":{ } }, "String":{"type":"string"}, "StringDateTime":{ "type":"string", "pattern":"^([\\-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d(?!:))?)?(\\17[0-5]\\d([\\.,]\\d)?)?([zZ]|([\\-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$" }, "StringList":{ "type":"list", "member":{"shape":"String"} }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

The name of the tag.

" }, "Value":{ "shape":"TagValue", "documentation":"

The value of the tag.

" } }, "documentation":"

Metadata that you assign to your managed instances. Tags enable you to categorize your managed instances in different ways, for example, by purpose, owner, or environment.

" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^(?!^(?i)aws:)(?=^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$).*$" }, "TagList":{ "type":"list", "member":{"shape":"Tag"} }, "TagValue":{ "type":"string", "max":256, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Target":{ "type":"structure", "members":{ "Key":{ "shape":"TargetKey", "documentation":"

User-defined criteria for sending commands that target instances that meet the criteria. Key can be tag:<Amazon EC2 tag> or name:<Amazon EC2 instance ID>. For example, tag:ServerRole or name:0123456789012345. For more information about how to send commands that target instances using Key;Value parameters, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).

" }, "Values":{ "shape":"TargetValues", "documentation":"

User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to execute a command on instances that include Amazon EC2 tags of ServerRole;WebServer. For more information about how to send commands that target instances using Key;Value parameters, see Executing a Command Using Amazon EC2 Run Command (Linux) or Executing a Command Using Amazon EC2 Run Command (Windows).

" } }, "documentation":"

An array of search criteria that targets instances using a Key;Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.

" }, "TargetCount":{"type":"integer"}, "TargetKey":{ "type":"string", "max":128, "min":1, "pattern":"^[\\p{L}\\p{Z}\\p{N}_.:/=\\-@]*$" }, "TargetValue":{"type":"string"}, "TargetValues":{ "type":"list", "member":{"shape":"TargetValue"}, "max":50, "min":0 }, "Targets":{ "type":"list", "member":{"shape":"Target"}, "max":5, "min":0 }, "TimeoutSeconds":{ "type":"integer", "max":2592000, "min":30 }, "TooManyTagsError":{ "type":"structure", "members":{ }, "documentation":"

The Targets parameter includes too many tags. Remove one or more tags and try the command again.

", "exception":true }, "TooManyUpdates":{ "type":"structure", "members":{ }, "documentation":"

There are concurrent updates for a resource that supports one update at a time.

", "exception":true }, "TotalSizeLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The size of inventory data has exceeded the total size limit for the resource.

", "exception":true }, "UnsupportedInventorySchemaVersionException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

Inventory item type schema version has to match supported versions in the service. Check output of GetInventorySchema to see the available schema version for each type.

", "exception":true }, "UnsupportedParameterType":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The parameter type is not supported.

", "exception":true }, "UnsupportedPlatformType":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The document does not support the platform type of the given instance ID(s). For example, you sent an SSM document for a Windows instance to a Linux instance.

", "exception":true }, "UpdateAssociationRequest":{ "type":"structure", "required":["AssociationId"], "members":{ "AssociationId":{ "shape":"AssociationId", "documentation":"

The ID of the association you want to update.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The document version you want update for the association.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

The cron expression used to schedule the association that you want to update. Supported expressions are every half, 1, 2, 4, 8 or 12 hour(s); every specified day and time of the week. For example: cron(0 0/30 * 1/1 * ? *) to run every thirty minutes; cron(0 0 0/4 1/1 * ? *) to run every four hours; and cron(0 0 10 ? * SUN *) to run every Sunday at 10 a.m.

" }, "OutputLocation":{ "shape":"InstanceAssociationOutputLocation", "documentation":"

An Amazon S3 bucket where you want to store the results of this request.

\"{ \\\"S3Location\\\": { \\\"OutputS3Region\\\": \\\"<region>\\\", \\\"OutputS3BucketName\\\": \\\"bucket name\\\", \\\"OutputS3KeyPrefix\\\": \\\"folder name\\\" } }\"

" } } }, "UpdateAssociationResult":{ "type":"structure", "members":{ "AssociationDescription":{ "shape":"AssociationDescription", "documentation":"

The description of the association that was updated.

" } } }, "UpdateAssociationStatusRequest":{ "type":"structure", "required":[ "Name", "InstanceId", "AssociationStatus" ], "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of the SSM document.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

The ID of the instance.

" }, "AssociationStatus":{ "shape":"AssociationStatus", "documentation":"

The association status.

" } } }, "UpdateAssociationStatusResult":{ "type":"structure", "members":{ "AssociationDescription":{ "shape":"AssociationDescription", "documentation":"

Information about the association.

" } } }, "UpdateDocumentDefaultVersionRequest":{ "type":"structure", "required":[ "Name", "DocumentVersion" ], "members":{ "Name":{ "shape":"DocumentName", "documentation":"

The name of a custom document that you want to set as the default version.

" }, "DocumentVersion":{ "shape":"DocumentVersionNumber", "documentation":"

The version of a custom document that you want to set as the default version.

" } } }, "UpdateDocumentDefaultVersionResult":{ "type":"structure", "members":{ "Description":{ "shape":"DocumentDefaultVersionDescription", "documentation":"

The description of a custom document that you want to set as the default version.

" } } }, "UpdateDocumentRequest":{ "type":"structure", "required":[ "Content", "Name" ], "members":{ "Content":{ "shape":"DocumentContent", "documentation":"

The content in a document that you want to update.

" }, "Name":{ "shape":"DocumentName", "documentation":"

The name of the document that you want to update.

" }, "DocumentVersion":{ "shape":"DocumentVersion", "documentation":"

The version of the document that you want to update.

" } } }, "UpdateDocumentResult":{ "type":"structure", "members":{ "DocumentDescription":{ "shape":"DocumentDescription", "documentation":"

A description of the document that was updated.

" } } }, "UpdateMaintenanceWindowRequest":{ "type":"structure", "required":["WindowId"], "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the Maintenance Window to update.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The name of the Maintenance Window.

" }, "Schedule":{ "shape":"MaintenanceWindowSchedule", "documentation":"

The schedule of the Maintenance Window in the form of a cron or rate expression.

" }, "Duration":{ "shape":"MaintenanceWindowDurationHours", "documentation":"

The duration of the Maintenance Window in hours.

", "box":true }, "Cutoff":{ "shape":"MaintenanceWindowCutoff", "documentation":"

The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

", "box":true }, "AllowUnassociatedTargets":{ "shape":"MaintenanceWindowAllowUnassociatedTargets", "documentation":"

Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.

", "box":true }, "Enabled":{ "shape":"MaintenanceWindowEnabled", "documentation":"

Whether the Maintenance Window is enabled.

", "box":true } } }, "UpdateMaintenanceWindowResult":{ "type":"structure", "members":{ "WindowId":{ "shape":"MaintenanceWindowId", "documentation":"

The ID of the created Maintenance Window.

" }, "Name":{ "shape":"MaintenanceWindowName", "documentation":"

The name of the Maintenance Window.

" }, "Schedule":{ "shape":"MaintenanceWindowSchedule", "documentation":"

The schedule of the Maintenance Window in the form of a cron or rate expression.

" }, "Duration":{ "shape":"MaintenanceWindowDurationHours", "documentation":"

The duration of the Maintenance Window in hours.

" }, "Cutoff":{ "shape":"MaintenanceWindowCutoff", "documentation":"

The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution.

" }, "AllowUnassociatedTargets":{ "shape":"MaintenanceWindowAllowUnassociatedTargets", "documentation":"

Whether targets must be registered with the Maintenance Window before tasks can be defined for those targets.

" }, "Enabled":{ "shape":"MaintenanceWindowEnabled", "documentation":"

Whether the Maintenance Window is enabled.

" } } }, "UpdateManagedInstanceRoleRequest":{ "type":"structure", "required":[ "InstanceId", "IamRole" ], "members":{ "InstanceId":{ "shape":"ManagedInstanceId", "documentation":"

The ID of the managed instance where you want to update the role.

" }, "IamRole":{ "shape":"IamRole", "documentation":"

The IAM role you want to assign or change.

" } } }, "UpdateManagedInstanceRoleResult":{ "type":"structure", "members":{ } }, "UpdatePatchBaselineRequest":{ "type":"structure", "required":["BaselineId"], "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the patch baseline to update.

" }, "Name":{ "shape":"BaselineName", "documentation":"

The name of the patch baseline.

" }, "GlobalFilters":{ "shape":"PatchFilterGroup", "documentation":"

A set of global filters used to exclude patches from the baseline.

" }, "ApprovalRules":{ "shape":"PatchRuleGroup", "documentation":"

A set of rules used to include patches in the baseline.

" }, "ApprovedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly approved patches for the baseline.

" }, "RejectedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly rejected patches for the baseline.

" }, "Description":{ "shape":"BaselineDescription", "documentation":"

A description of the patch baseline.

" } } }, "UpdatePatchBaselineResult":{ "type":"structure", "members":{ "BaselineId":{ "shape":"BaselineId", "documentation":"

The ID of the deleted patch baseline.

" }, "Name":{ "shape":"BaselineName", "documentation":"

The name of the patch baseline.

" }, "GlobalFilters":{ "shape":"PatchFilterGroup", "documentation":"

A set of global filters used to exclude patches from the baseline.

" }, "ApprovalRules":{ "shape":"PatchRuleGroup", "documentation":"

A set of rules used to include patches in the baseline.

" }, "ApprovedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly approved patches for the baseline.

" }, "RejectedPatches":{ "shape":"PatchIdList", "documentation":"

A list of explicitly rejected patches for the baseline.

" }, "CreatedDate":{ "shape":"DateTime", "documentation":"

The date when the patch baseline was created.

" }, "ModifiedDate":{ "shape":"DateTime", "documentation":"

The date when the patch baseline was last modified.

" }, "Description":{ "shape":"BaselineDescription", "documentation":"

A description of the Patch Baseline.

" } } }, "Url":{"type":"string"}, "VelocityConstraint":{ "type":"string", "max":7, "min":1, "pattern":"^[1-9]\\d*$|[0-9][%]|[1-9][0-9][%]|[1][0][0][%]|[0-9]?" }, "Version":{ "type":"string", "pattern":"^[0-9]{1,6}(\\.[0-9]{1,6}){2,3}$" } }, "documentation":"

Amazon EC2 Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager works with managed instances: Amazon EC2 instances and servers or virtual machines (VMs) in your on-premises environment that are configured for Systems Manager.

This references is intended to be used with the EC2 Systems Manager User Guide (Linux) (Windows).

To get started, verify prerequisites and configure managed instances (Linux) (Windows).

" } botocore-1.5.7/botocore/data/rekognition/0000777454262600001440000000000013042511307021463 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/rekognition/2016-06-27/0000777454262600001440000000000013042511307022524 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/rekognition/2016-06-27/service-2.json0000666454262600001440000015225413042511306025226 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-06-27", "endpointPrefix":"rekognition", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Amazon Rekognition", "signatureVersion":"v4", "targetPrefix":"RekognitionService", "uid":"rekognition-2016-06-27" }, "operations":{ "CompareFaces":{ "name":"CompareFaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CompareFacesRequest"}, "output":{"shape":"CompareFacesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InvalidS3ObjectException"}, {"shape":"ImageTooLargeException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerError"}, {"shape":"ThrottlingException"}, {"shape":"ProvisionedThroughputExceededException"}, {"shape":"InvalidImageFormatException"} ], "documentation":"

Compares a face in the source input image with each face detected in the target input image.

If the source image contains multiple faces, the service detects the largest face and uses it to compare with each face detected in the target image.

In response, the operation returns an array of face matches ordered by similarity score with the highest similarity scores first. For each face match, the response provides a bounding box of the face and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match.

By default, only faces with the similarity score of greater than or equal to 80% are returned in the response. You can change this value.

In addition to the face matches, the response returns information about the face in the source image, including the bounding box of the face and confidence value.

This is a stateless API operation. That is, the operation does not persist any data.

For an example, see get-started-exercise-compare-faces

This operation requires permissions to perform the rekognition:CompareFaces action.

" }, "CreateCollection":{ "name":"CreateCollection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCollectionRequest"}, "output":{"shape":"CreateCollectionResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerError"}, {"shape":"ThrottlingException"}, {"shape":"ProvisionedThroughputExceededException"}, {"shape":"ResourceAlreadyExistsException"} ], "documentation":"

Creates a collection in an AWS Region. You can add faces to the collection using the operation.

For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container.

For an example, see example1.

This operation requires permissions to perform the rekognition:CreateCollection action.

" }, "DeleteCollection":{ "name":"DeleteCollection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCollectionRequest"}, "output":{"shape":"DeleteCollectionResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerError"}, {"shape":"ThrottlingException"}, {"shape":"ProvisionedThroughputExceededException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see example1.

This operation requires permissions to perform the rekognition:DeleteCollection action.

" }, "DeleteFaces":{ "name":"DeleteFaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteFacesRequest"}, "output":{"shape":"DeleteFacesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerError"}, {"shape":"ThrottlingException"}, {"shape":"ProvisionedThroughputExceededException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.

This operation requires permissions to perform the rekognition:DeleteFaces action.

" }, "DetectFaces":{ "name":"DetectFaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetectFacesRequest"}, "output":{"shape":"DetectFacesResponse"}, "errors":[ {"shape":"InvalidS3ObjectException"}, {"shape":"InvalidParameterException"}, {"shape":"ImageTooLargeException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerError"}, {"shape":"ThrottlingException"}, {"shape":"ProvisionedThroughputExceededException"}, {"shape":"InvalidImageFormatException"} ], "documentation":"

Detects faces within an image (JPEG or PNG) that is provided as input.

For each face detected, the operation returns face details including a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), gender, presence of beard, sunglasses, etc.

The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm may not detect the faces or might detect faces with lower confidence.

This is a stateless API operation. That is, the operation does not persist any data.

For an example, see get-started-exercise-detect-faces.

This operation requires permissions to perform the rekognition:DetectFaces action.

" }, "DetectLabels":{ "name":"DetectLabels", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetectLabelsRequest"}, "output":{"shape":"DetectLabelsResponse"}, "errors":[ {"shape":"InvalidS3ObjectException"}, {"shape":"InvalidParameterException"}, {"shape":"ImageTooLargeException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerError"}, {"shape":"ThrottlingException"}, {"shape":"ProvisionedThroughputExceededException"}, {"shape":"InvalidImageFormatException"} ], "documentation":"

Detects instances of real-world labels within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature. For an example, see get-started-exercise-detect-labels.

For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response will include all three labels, one for each object.

{Name: lighthouse, Confidence: 98.4629}

{Name: rock,Confidence: 79.2097}

{Name: sea,Confidence: 75.061}

In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.

{Name: flower,Confidence: 99.0562}

{Name: plant,Confidence: 99.0562}

{Name: tulip,Confidence: 99.0562}

In this example, the detection algorithm more precisely identifies the flower as a tulip.

You can provide the input image as an S3 object or as base64-encoded bytes. In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 50%. You can also add the MaxLabels parameter to limit the number of labels returned.

If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides.

This is a stateless API operation. That is, the operation does not persist any data.

This operation requires permissions to perform the rekognition:DetectLabels action.

" }, "IndexFaces":{ "name":"IndexFaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"IndexFacesRequest"}, "output":{"shape":"IndexFacesResponse"}, "errors":[ {"shape":"InvalidS3ObjectException"}, {"shape":"InvalidParameterException"}, {"shape":"ImageTooLargeException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerError"}, {"shape":"ThrottlingException"}, {"shape":"ProvisionedThroughputExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidImageFormatException"} ], "documentation":"

Detects faces in the input image and adds them to the specified collection.

Amazon Rekognition does not save the actual faces detected. Instead, the underlying detection algorithm first detects the faces in the input image, and for each face extracts facial features into a feature vector, and stores it in the back-end database. Amazon Rekognition uses feature vectors when performing face match and search operations using the and operations.

If you provide the optional externalImageID for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.

In response, the operation returns an array of metadata for all detected faces. This includes, the bounding box of the detected face, confidence value (indicating the bounding box contains a face), a face ID assigned by the service for each face that is detected and stored, and an image ID assigned by the service for the input image If you request all facial attributes (using the detectionAttributes parameter, Amazon Rekognition returns detailed facial attributes such as facial landmarks (for example, location of eye and mount) and other facial attributes such gender. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

For an example, see example2.

This operation requires permissions to perform the rekognition:IndexFaces action.

" }, "ListCollections":{ "name":"ListCollections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCollectionsRequest"}, "output":{"shape":"ListCollectionsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerError"}, {"shape":"ThrottlingException"}, {"shape":"ProvisionedThroughputExceededException"}, {"shape":"InvalidPaginationTokenException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

For an example, see example1.

This operation requires permissions to perform the rekognition:ListCollections action.

" }, "ListFaces":{ "name":"ListFaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListFacesRequest"}, "output":{"shape":"ListFacesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerError"}, {"shape":"ThrottlingException"}, {"shape":"ProvisionedThroughputExceededException"}, {"shape":"InvalidPaginationTokenException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see example3.

This operation requires permissions to perform the rekognition:ListFaces action.

" }, "SearchFaces":{ "name":"SearchFaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SearchFacesRequest"}, "output":{"shape":"SearchFacesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerError"}, {"shape":"ThrottlingException"}, {"shape":"ProvisionedThroughputExceededException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.

You can also search faces without indexing faces by using the SearchFacesByImage operation.

The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face.

For an example, see example3.

This operation requires permissions to perform the rekognition:SearchFaces action.

" }, "SearchFacesByImage":{ "name":"SearchFacesByImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SearchFacesByImageRequest"}, "output":{"shape":"SearchFacesByImageResponse"}, "errors":[ {"shape":"InvalidS3ObjectException"}, {"shape":"InvalidParameterException"}, {"shape":"ImageTooLargeException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServerError"}, {"shape":"ThrottlingException"}, {"shape":"ProvisionedThroughputExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidImageFormatException"} ], "documentation":"

For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.

To search for all faces in an input image, you might first call the operation, and then use the face IDs returned in subsequent calls to the operation.

You can also call the DetectFaces operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage operation.

The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image.

For an example, see example3.

This operation requires permissions to perform the rekognition:SearchFacesByImage action.

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ }, "documentation":"

You are not authorized to perform the action.

", "exception":true }, "Attribute":{ "type":"string", "enum":[ "DEFAULT", "ALL" ] }, "Attributes":{ "type":"list", "member":{"shape":"Attribute"} }, "Beard":{ "type":"structure", "members":{ "Value":{ "shape":"Boolean", "documentation":"

Boolean value that indicates whether the face has beard or not.

" }, "Confidence":{ "shape":"Percent", "documentation":"

Level of confidence in the determination.

" } }, "documentation":"

Indicates whether or not the face has a beard, and the confidence level in the determination.

" }, "Boolean":{"type":"boolean"}, "BoundingBox":{ "type":"structure", "members":{ "Width":{ "shape":"Float", "documentation":"

Width of the bounding box as a ratio of the overall image width.

" }, "Height":{ "shape":"Float", "documentation":"

Height of the bounding box as a ratio of the overall image height.

" }, "Left":{ "shape":"Float", "documentation":"

Left coordinate of the bounding box as a ratio of overall image width.

" }, "Top":{ "shape":"Float", "documentation":"

Top coordinate of the bounding box as a ratio of overall image height.

" } }, "documentation":"

Identifies the bounding box around the object or face. The left (x-coordinate) and top (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

The top and left values returned are ratios of the overall image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of the bounding box is 350x50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200).

The width and height values represent the dimensions of the bounding box as a ratio of the overall image dimension. For example, if the input image is 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

The bounding box coordinates can have negative values. For example, if Amazon Rekognition is able to detect a face that is at the image edge and is only partially visible, the service can return coordinates that are outside the image bounds and, depending on the image edge, you might get negative values or values greater than 1 for the left or top values.

" }, "CollectionId":{ "type":"string", "max":255, "min":1, "pattern":"[a-zA-Z0-9_.\\-]+" }, "CollectionIdList":{ "type":"list", "member":{"shape":"CollectionId"} }, "CompareFacesMatch":{ "type":"structure", "members":{ "Similarity":{ "shape":"Percent", "documentation":"

Level of confidence that the faces match.

" }, "Face":{ "shape":"ComparedFace", "documentation":"

Provides face metadata (bounding box and confidence that the bounding box actually contains a face).

" } }, "documentation":"

For the provided the bounding box, confidence level that the bounding box actually contains a face, and the similarity between the face in the bounding box and the face in the source image.

" }, "CompareFacesMatchList":{ "type":"list", "member":{"shape":"CompareFacesMatch"} }, "CompareFacesRequest":{ "type":"structure", "required":[ "SourceImage", "TargetImage" ], "members":{ "SourceImage":{ "shape":"Image", "documentation":"

Source image either as bytes or an S3 object

" }, "TargetImage":{ "shape":"Image", "documentation":"

Target image either as bytes or an S3 object

" }, "SimilarityThreshold":{ "shape":"Percent", "documentation":"

The minimum level of confidence in the match you want included in the result.

" } } }, "CompareFacesResponse":{ "type":"structure", "members":{ "SourceImageFace":{ "shape":"ComparedSourceImageFace", "documentation":"

The face from the source image that was used for comparison.

" }, "FaceMatches":{ "shape":"CompareFacesMatchList", "documentation":"

Provides an array of CompareFacesMatch objects. Each object provides the bounding box, confidence that the bounding box contains a face, and the similarity between the face in the bounding box and the face in the source image.

" } } }, "ComparedFace":{ "type":"structure", "members":{ "BoundingBox":{"shape":"BoundingBox"}, "Confidence":{ "shape":"Percent", "documentation":"

Level of confidence that what the bounding box contains is a face.

" } }, "documentation":"

Provides face metadata (bounding box and confidence that the bounding box actually contains a face).

" }, "ComparedSourceImageFace":{ "type":"structure", "members":{ "BoundingBox":{"shape":"BoundingBox"}, "Confidence":{ "shape":"Percent", "documentation":"

Confidence level that the selected bounding box contains a face.

" } }, "documentation":"

Type that describes the face Amazon Rekognition chose to compare with the faces in the target. This contains a bounding box for the selected face and confidence level that the bounding box contains a face. Note that Amazon Rekognition selects the largest face in the source image for this comparison.

" }, "CreateCollectionRequest":{ "type":"structure", "required":["CollectionId"], "members":{ "CollectionId":{ "shape":"CollectionId", "documentation":"

ID for the collection that you are creating.

" } } }, "CreateCollectionResponse":{ "type":"structure", "members":{ "StatusCode":{ "shape":"UInteger", "documentation":"

HTTP status code indicating the result of the operation.

" }, "CollectionArn":{ "shape":"String", "documentation":"

Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.

" } } }, "Degree":{ "type":"float", "max":180, "min":-180 }, "DeleteCollectionRequest":{ "type":"structure", "required":["CollectionId"], "members":{ "CollectionId":{ "shape":"CollectionId", "documentation":"

ID of the collection to delete.

" } } }, "DeleteCollectionResponse":{ "type":"structure", "members":{ "StatusCode":{ "shape":"UInteger", "documentation":"

HTTP status code that indicates the result of the operation.

" } } }, "DeleteFacesRequest":{ "type":"structure", "required":[ "CollectionId", "FaceIds" ], "members":{ "CollectionId":{ "shape":"CollectionId", "documentation":"

Collection from which to remove the specific faces.

" }, "FaceIds":{ "shape":"FaceIdList", "documentation":"

An array of face IDs to delete.

" } } }, "DeleteFacesResponse":{ "type":"structure", "members":{ "DeletedFaces":{ "shape":"FaceIdList", "documentation":"

An array of strings (face IDs) of the faces that were deleted.

" } } }, "DetectFacesRequest":{ "type":"structure", "required":["Image"], "members":{ "Image":{ "shape":"Image", "documentation":"

The image in which you want to detect faces. You can specify a blob or an S3 object.

" }, "Attributes":{ "shape":"Attributes", "documentation":"

A list of facial attributes you would like to be returned. By default, the API returns subset of facial attributes.

For example, you can specify the value as, [\"ALL\"] or [\"DEFAULT\"]. If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a logical AND operator to determine which attributes to return (in this case, it is all attributes). If you specify all attributes, Amazon Rekognition performs additional detection.

" } } }, "DetectFacesResponse":{ "type":"structure", "members":{ "FaceDetails":{ "shape":"FaceDetailList", "documentation":"

Details of each face found in the image.

" }, "OrientationCorrection":{ "shape":"OrientationCorrection", "documentation":"

The algorithm detects the image orientation. If it detects that the image was rotated, it returns the degrees of rotation. If your application is displaying the image, you can use this value to adjust the orientation.

For example, if the service detects that the input image was rotated by 90 degrees, it corrects orientation, performs face detection, and then returns the faces. That is, the bounding box coordinates in the response are based on the corrected orientation.

If the source image Exif metadata populates the orientation field, Amazon Rekognition does not perform orientation correction and the value of OrientationCorrection will be nil.

" } } }, "DetectLabelsRequest":{ "type":"structure", "required":["Image"], "members":{ "Image":{ "shape":"Image", "documentation":"

The input image. You can provide a blob of image bytes or an S3 object.

" }, "MaxLabels":{ "shape":"UInteger", "documentation":"

Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.

" }, "MinConfidence":{ "shape":"Percent", "documentation":"

Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.

If minConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 50 percent.

" } } }, "DetectLabelsResponse":{ "type":"structure", "members":{ "Labels":{ "shape":"Labels", "documentation":"

An array of labels for the real-world objects detected.

" }, "OrientationCorrection":{ "shape":"OrientationCorrection", "documentation":"

Amazon Rekognition returns the orientation of the input image that was detected (clockwise direction). If your application displays the image, you can use this value to correct the orientation. If Amazon Rekognition detects that the input image was rotated (for example, by 90 degrees), it first corrects the orientation before detecting the labels.

If the source image Exif metadata populates the orientation field, Amazon Rekognition does not perform orientation correction and the value of OrientationCorrection will be nil.

" } } }, "Emotion":{ "type":"structure", "members":{ "Type":{ "shape":"EmotionName", "documentation":"

Type of emotion detected.

" }, "Confidence":{ "shape":"Percent", "documentation":"

Level of confidence in the determination.

" } }, "documentation":"

The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.

" }, "EmotionName":{ "type":"string", "enum":[ "HAPPY", "SAD", "ANGRY", "CONFUSED", "DISGUSTED", "SURPRISED", "CALM", "UNKNOWN" ] }, "Emotions":{ "type":"list", "member":{"shape":"Emotion"} }, "ExternalImageId":{ "type":"string", "max":255, "min":1, "pattern":"[a-zA-Z0-9_.\\-:]+" }, "EyeOpen":{ "type":"structure", "members":{ "Value":{ "shape":"Boolean", "documentation":"

Boolean value that indicates whether the eyes on the face are open.

" }, "Confidence":{ "shape":"Percent", "documentation":"

Level of confidence in the determination.

" } }, "documentation":"

Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

" }, "Eyeglasses":{ "type":"structure", "members":{ "Value":{ "shape":"Boolean", "documentation":"

Boolean value that indicates whether the face is wearing eye glasses or not.

" }, "Confidence":{ "shape":"Percent", "documentation":"

Level of confidence in the determination.

" } }, "documentation":"

Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

" }, "Face":{ "type":"structure", "members":{ "FaceId":{ "shape":"FaceId", "documentation":"

Unique identifier that Amazon Rekognition assigns to the face.

" }, "BoundingBox":{"shape":"BoundingBox"}, "ImageId":{ "shape":"ImageId", "documentation":"

Unique identifier that Amazon Rekognition assigns to the source image.

" }, "ExternalImageId":{ "shape":"ExternalImageId", "documentation":"

Identifier that you assign to all the faces in the input image.

" }, "Confidence":{ "shape":"Percent", "documentation":"

Confidence level that the bounding box contains a face (and not a different object such as a tree).

" } }, "documentation":"

Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.

" }, "FaceDetail":{ "type":"structure", "members":{ "BoundingBox":{ "shape":"BoundingBox", "documentation":"

Bounding box of the face.

" }, "Smile":{ "shape":"Smile", "documentation":"

Indicates whether or not the face is smiling, and the confidence level in the determination.

" }, "Eyeglasses":{ "shape":"Eyeglasses", "documentation":"

Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

" }, "Sunglasses":{ "shape":"Sunglasses", "documentation":"

Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

" }, "Gender":{ "shape":"Gender", "documentation":"

Gender of the face and the confidence level in the determination.

" }, "Beard":{ "shape":"Beard", "documentation":"

Indicates whether or not the face has a beard, and the confidence level in the determination.

" }, "Mustache":{ "shape":"Mustache", "documentation":"

Indicates whether or not the face has a mustache, and the confidence level in the determination.

" }, "EyesOpen":{ "shape":"EyeOpen", "documentation":"

Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

" }, "MouthOpen":{ "shape":"MouthOpen", "documentation":"

Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

" }, "Emotions":{ "shape":"Emotions", "documentation":"

The emotions detected on the face, and the confidence level in the determination. For example, HAPPY, SAD, and ANGRY.

" }, "Landmarks":{ "shape":"Landmarks", "documentation":"

Indicates the location of the landmark on the face.

" }, "Pose":{ "shape":"Pose", "documentation":"

Indicates the pose of the face as determined by pitch, roll, and the yaw.

" }, "Quality":{ "shape":"ImageQuality", "documentation":"

Identifies image brightness and sharpness.

" }, "Confidence":{ "shape":"Percent", "documentation":"

Confidence level that the bounding box contains a face (and not a different object such as a tree).

" } }, "documentation":"

Structure containing attributes of the face that the algorithm detected.

" }, "FaceDetailList":{ "type":"list", "member":{"shape":"FaceDetail"} }, "FaceId":{ "type":"string", "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, "FaceIdList":{ "type":"list", "member":{"shape":"FaceId"}, "max":4096, "min":1 }, "FaceList":{ "type":"list", "member":{"shape":"Face"} }, "FaceMatch":{ "type":"structure", "members":{ "Similarity":{ "shape":"Percent", "documentation":"

Confidence in the match of this face with the input face.

" }, "Face":{"shape":"Face"} }, "documentation":"

Provides face metadata. In addition, it also provides the confidence in the match of this face with the input face.

" }, "FaceMatchList":{ "type":"list", "member":{"shape":"FaceMatch"} }, "FaceRecord":{ "type":"structure", "members":{ "Face":{"shape":"Face"}, "FaceDetail":{"shape":"FaceDetail"} }, "documentation":"

Object containing both the face metadata (stored in the back-end database) and facial attributes that are detected but aren't stored in the database.

" }, "FaceRecordList":{ "type":"list", "member":{"shape":"FaceRecord"} }, "Float":{"type":"float"}, "Gender":{ "type":"structure", "members":{ "Value":{ "shape":"GenderType", "documentation":"

Gender of the face.

" }, "Confidence":{ "shape":"Percent", "documentation":"

Level of confidence in the determination.

" } }, "documentation":"

Gender of the face and the confidence level in the determination.

" }, "GenderType":{ "type":"string", "enum":[ "MALE", "FEMALE" ] }, "Image":{ "type":"structure", "members":{ "Bytes":{ "shape":"ImageBlob", "documentation":"

Blob of image bytes up to 5 MBs.

" }, "S3Object":{ "shape":"S3Object", "documentation":"

Identifies an S3 object as the image source.

" } }, "documentation":"

Provides the source image either as bytes or an S3 object.

The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

You may need to Base64-encode the image bytes depending on the language you are using and whether or not you are using the AWS SDK. For more information, see example4.

If you use the Amazon CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see manage-access-resource-policies.

" }, "ImageBlob":{ "type":"blob", "max":5242880, "min":1 }, "ImageId":{ "type":"string", "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, "ImageQuality":{ "type":"structure", "members":{ "Brightness":{ "shape":"Float", "documentation":"

Value representing brightness of the face. The service returns a value between 0 and 1 (inclusive).

" }, "Sharpness":{ "shape":"Float", "documentation":"

Value representing sharpness of the face.

" } }, "documentation":"

Identifies image brightness and sharpness.

" }, "ImageTooLargeException":{ "type":"structure", "members":{ }, "documentation":"

The input image size exceeds the allowed limit. For more information, see limits.

", "exception":true }, "IndexFacesRequest":{ "type":"structure", "required":[ "CollectionId", "Image" ], "members":{ "CollectionId":{ "shape":"CollectionId", "documentation":"

ID of an existing collection to which you want to add the faces that are detected in the input images.

" }, "Image":{"shape":"Image"}, "ExternalImageId":{ "shape":"ExternalImageId", "documentation":"

ID you want to assign to all the faces detected in the image.

" }, "DetectionAttributes":{ "shape":"Attributes", "documentation":"

(Optional) Returns detailed attributes of indexed faces. By default, the operation returns a subset of the facial attributes.

For example, you can specify the value as, [\"ALL\"] or [\"DEFAULT\"]. If you provide both, [\"ALL\", \"DEFAULT\"], Amazon Rekognition uses the logical AND operator to determine which attributes to return (in this case, it is all attributes). If you specify all attributes, the service performs additional detection, in addition to the default.

" } } }, "IndexFacesResponse":{ "type":"structure", "members":{ "FaceRecords":{ "shape":"FaceRecordList", "documentation":"

An array of faces detected and added to the collection. For more information, see howitworks-index-faces.

" }, "OrientationCorrection":{ "shape":"OrientationCorrection", "documentation":"

The algorithm detects the image orientation. If it detects that the image was rotated, it returns the degree of rotation. You can use this value to correct the orientation and also appropriately analyze the bounding box coordinates that are returned.

If the source image Exif metadata populates the orientation field, Amazon Rekognition does not perform orientation correction and the value of OrientationCorrection will be nil.

" } } }, "InternalServerError":{ "type":"structure", "members":{ }, "documentation":"

Amazon Rekognition experienced a service issue. Try your call again.

", "exception":true, "fault":true }, "InvalidImageFormatException":{ "type":"structure", "members":{ }, "documentation":"

The provided image format is not supported.

", "exception":true }, "InvalidPaginationTokenException":{ "type":"structure", "members":{ }, "documentation":"

Pagination token in the request is not valid.

", "exception":true }, "InvalidParameterException":{ "type":"structure", "members":{ }, "documentation":"

Input parameter violated a constraint. Validate your parameter before calling the API operation again.

", "exception":true }, "InvalidS3ObjectException":{ "type":"structure", "members":{ }, "documentation":"

Amazon Rekognition is unable to access the S3 object specified in the request.

", "exception":true }, "Label":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name (label) of the object.

" }, "Confidence":{ "shape":"Percent", "documentation":"

Level of confidence.

" } }, "documentation":"

Structure containing details about the detected label, including name, and level of confidence.

" }, "Labels":{ "type":"list", "member":{"shape":"Label"} }, "Landmark":{ "type":"structure", "members":{ "Type":{ "shape":"LandmarkType", "documentation":"

Type of the landmark.

" }, "X":{ "shape":"Float", "documentation":"

x-coordinate from the top left of the landmark expressed as the ration of the width of the image. For example, if the images is 700x200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

" }, "Y":{ "shape":"Float", "documentation":"

y-coordinate from the top left of the landmark expressed as the ration of the height of the image. For example, if the images is 700x200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

" } }, "documentation":"

Indicates the location of the landmark on the face.

" }, "LandmarkType":{ "type":"string", "enum":[ "EYE_LEFT", "EYE_RIGHT", "NOSE", "MOUTH_LEFT", "MOUTH_RIGHT", "LEFT_EYEBROW_LEFT", "LEFT_EYEBROW_RIGHT", "LEFT_EYEBROW_UP", "RIGHT_EYEBROW_LEFT", "RIGHT_EYEBROW_RIGHT", "RIGHT_EYEBROW_UP", "LEFT_EYE_LEFT", "LEFT_EYE_RIGHT", "LEFT_EYE_UP", "LEFT_EYE_DOWN", "RIGHT_EYE_LEFT", "RIGHT_EYE_RIGHT", "RIGHT_EYE_UP", "RIGHT_EYE_DOWN", "NOSE_LEFT", "NOSE_RIGHT", "MOUTH_UP", "MOUTH_DOWN", "LEFT_PUPIL", "RIGHT_PUPIL" ] }, "Landmarks":{ "type":"list", "member":{"shape":"Landmark"} }, "ListCollectionsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"PaginationToken", "documentation":"

Pagination token from the previous response.

" }, "MaxResults":{ "shape":"PageSize", "documentation":"

Maximum number of collection IDs to return.

" } } }, "ListCollectionsResponse":{ "type":"structure", "members":{ "CollectionIds":{ "shape":"CollectionIdList", "documentation":"

An array of collection IDs.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

If the result is truncated, the response provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

" } } }, "ListFacesRequest":{ "type":"structure", "required":["CollectionId"], "members":{ "CollectionId":{ "shape":"CollectionId", "documentation":"

ID of the collection from which to list the faces.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

" }, "MaxResults":{ "shape":"PageSize", "documentation":"

Maximum number of faces to return.

" } } }, "ListFacesResponse":{ "type":"structure", "members":{ "Faces":{ "shape":"FaceList", "documentation":"

An array of Face objects.

" }, "NextToken":{ "shape":"String", "documentation":"

If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.

" } } }, "MaxFaces":{ "type":"integer", "max":4096, "min":1 }, "MouthOpen":{ "type":"structure", "members":{ "Value":{ "shape":"Boolean", "documentation":"

Boolean value that indicates whether the mouth on the face is open or not.

" }, "Confidence":{ "shape":"Percent", "documentation":"

Level of confidence in the determination.

" } }, "documentation":"

Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

" }, "Mustache":{ "type":"structure", "members":{ "Value":{ "shape":"Boolean", "documentation":"

Boolean value that indicates whether the face has mustache or not.

" }, "Confidence":{ "shape":"Percent", "documentation":"

Level of confidence in the determination.

" } }, "documentation":"

Indicates whether or not the face has a mustache, and the confidence level in the determination.

" }, "OrientationCorrection":{ "type":"string", "enum":[ "ROTATE_0", "ROTATE_90", "ROTATE_180", "ROTATE_270" ] }, "PageSize":{ "type":"integer", "max":4096, "min":0 }, "PaginationToken":{ "type":"string", "max":255 }, "Percent":{ "type":"float", "max":100, "min":0 }, "Pose":{ "type":"structure", "members":{ "Roll":{ "shape":"Degree", "documentation":"

Value representing the face rotation on the roll axis.

" }, "Yaw":{ "shape":"Degree", "documentation":"

Value representing the face rotation on the yaw axis.

" }, "Pitch":{ "shape":"Degree", "documentation":"

Value representing the face rotation on the pitch axis.

" } }, "documentation":"

Indicates the pose of the face as determined by pitch, roll, and the yaw.

" }, "ProvisionedThroughputExceededException":{ "type":"structure", "members":{ }, "documentation":"

The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

", "exception":true }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ }, "documentation":"

A collection with the specified ID already exists.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

Collection specified in the request is not found.

", "exception":true }, "S3Bucket":{ "type":"string", "max":255, "min":3, "pattern":"[0-9A-Za-z\\.\\-_]*" }, "S3Object":{ "type":"structure", "members":{ "Bucket":{ "shape":"S3Bucket", "documentation":"

Name of the S3 bucket.

" }, "Name":{ "shape":"S3ObjectName", "documentation":"

S3 object key name.

" }, "Version":{ "shape":"S3ObjectVersion", "documentation":"

If the bucket is versioning enabled, you can specify the object version.

" } }, "documentation":"

Provides the S3 bucket name and object name.

The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see manage-access-resource-policies.

" }, "S3ObjectName":{ "type":"string", "max":1024, "min":1 }, "S3ObjectVersion":{ "type":"string", "max":1024, "min":1 }, "SearchFacesByImageRequest":{ "type":"structure", "required":[ "CollectionId", "Image" ], "members":{ "CollectionId":{ "shape":"CollectionId", "documentation":"

ID of the collection to search.

" }, "Image":{"shape":"Image"}, "MaxFaces":{ "shape":"MaxFaces", "documentation":"

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

" }, "FaceMatchThreshold":{ "shape":"Percent", "documentation":"

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

" } } }, "SearchFacesByImageResponse":{ "type":"structure", "members":{ "SearchedFaceBoundingBox":{ "shape":"BoundingBox", "documentation":"

The bounding box around the face in the input image that Amazon Rekognition used for the search.

" }, "SearchedFaceConfidence":{ "shape":"Percent", "documentation":"

The level of confidence that the searchedFaceBoundingBox, contains a face.

" }, "FaceMatches":{ "shape":"FaceMatchList", "documentation":"

An array of faces that match the input face, along with the confidence in the match.

" } } }, "SearchFacesRequest":{ "type":"structure", "required":[ "CollectionId", "FaceId" ], "members":{ "CollectionId":{ "shape":"CollectionId", "documentation":"

ID of the collection the face belongs to.

" }, "FaceId":{ "shape":"FaceId", "documentation":"

ID of a face to find matches for in the collection.

" }, "MaxFaces":{ "shape":"MaxFaces", "documentation":"

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

" }, "FaceMatchThreshold":{ "shape":"Percent", "documentation":"

Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%.

" } } }, "SearchFacesResponse":{ "type":"structure", "members":{ "SearchedFaceId":{ "shape":"FaceId", "documentation":"

ID of the face that was searched for matches in a collection.

" }, "FaceMatches":{ "shape":"FaceMatchList", "documentation":"

An array of faces that matched the input face, along with the confidence in the match.

" } } }, "Smile":{ "type":"structure", "members":{ "Value":{ "shape":"Boolean", "documentation":"

Boolean value that indicates whether the face is smiling or not.

" }, "Confidence":{ "shape":"Percent", "documentation":"

Level of confidence in the determination.

" } }, "documentation":"

Indicates whether or not the face is smiling, and the confidence level in the determination.

" }, "String":{"type":"string"}, "Sunglasses":{ "type":"structure", "members":{ "Value":{ "shape":"Boolean", "documentation":"

Boolean value that indicates whether the face is wearing sunglasses or not.

" }, "Confidence":{ "shape":"Percent", "documentation":"

Level of confidence in the determination.

" } }, "documentation":"

Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

" }, "ThrottlingException":{ "type":"structure", "members":{ }, "documentation":"

Amazon Rekognition is temporarily unable to process the request. Try your call again.

", "exception":true, "fault":true }, "UInteger":{ "type":"integer", "min":0 } }, "documentation":"

This is the Amazon Rekognition API reference.

" } botocore-1.5.7/botocore/data/cloudformation/0000777454262600001440000000000013042511307022160 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudformation/2010-05-15/0000777454262600001440000000000013042511307023207 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudformation/2010-05-15/waiters-2.json0000666454262600001440000001125413042511306025721 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "StackExists": { "delay": 5, "operation": "DescribeStacks", "maxAttempts": 20, "acceptors": [ { "matcher": "status", "expected": 200, "state": "success" }, { "matcher": "error", "expected": "ValidationError", "state": "retry" } ] }, "StackCreateComplete": { "delay": 30, "operation": "DescribeStacks", "maxAttempts": 120, "description": "Wait until stack status is CREATE_COMPLETE.", "acceptors": [ { "argument": "Stacks[].StackStatus", "expected": "CREATE_COMPLETE", "matcher": "pathAll", "state": "success" }, { "argument": "Stacks[].StackStatus", "expected": "CREATE_FAILED", "matcher": "pathAny", "state": "failure" }, { "argument": "Stacks[].StackStatus", "expected": "DELETE_COMPLETE", "matcher": "pathAny", "state": "failure" }, { "argument": "Stacks[].StackStatus", "expected": "DELETE_FAILED", "matcher": "pathAny", "state": "failure" }, { "argument": "Stacks[].StackStatus", "expected": "ROLLBACK_FAILED", "matcher": "pathAny", "state": "failure" }, { "argument": "Stacks[].StackStatus", "expected": "ROLLBACK_COMPLETE", "matcher": "pathAny", "state": "failure" }, { "expected": "ValidationError", "matcher": "error", "state": "failure" } ] }, "StackDeleteComplete": { "delay": 30, "operation": "DescribeStacks", "maxAttempts": 120, "description": "Wait until stack status is DELETE_COMPLETE.", "acceptors": [ { "argument": "Stacks[].StackStatus", "expected": "DELETE_COMPLETE", "matcher": "pathAll", "state": "success" }, { "expected": "ValidationError", "matcher": "error", "state": "success" }, { "argument": "Stacks[].StackStatus", "expected": "DELETE_FAILED", "matcher": "pathAny", "state": "failure" }, { "argument": "Stacks[].StackStatus", "expected": "CREATE_FAILED", "matcher": "pathAny", "state": "failure" }, { "argument": "Stacks[].StackStatus", "expected": "ROLLBACK_FAILED", "matcher": "pathAny", "state": "failure" }, { "argument": "Stacks[].StackStatus", "expected": "UPDATE_ROLLBACK_FAILED", "matcher": "pathAny", "state": "failure" }, { "argument": "Stacks[].StackStatus", "expected": "UPDATE_ROLLBACK_IN_PROGRESS", "matcher": "pathAny", "state": "failure" } ] }, "StackUpdateComplete": { "delay": 30, "maxAttempts": 120, "operation": "DescribeStacks", "description": "Wait until stack status is UPDATE_COMPLETE.", "acceptors": [ { "argument": "Stacks[].StackStatus", "expected": "UPDATE_COMPLETE", "matcher": "pathAll", "state": "success" }, { "expected": "UPDATE_FAILED", "matcher": "pathAny", "state": "failure", "argument": "Stacks[].StackStatus" }, { "argument": "Stacks[].StackStatus", "expected": "UPDATE_ROLLBACK_FAILED", "matcher": "pathAny", "state": "failure" }, { "expected": "UPDATE_ROLLBACK_COMPLETE", "matcher": "pathAny", "state": "failure", "argument": "Stacks[].StackStatus" }, { "expected": "ValidationError", "matcher": "error", "state": "failure" } ] }, "ChangeSetCreateComplete": { "delay": 30, "operation": "DescribeChangeSet", "maxAttempts": 120, "description": "Wait until change set status is CREATE_COMPLETE.", "acceptors": [ { "argument": "Status", "expected": "CREATE_COMPLETE", "matcher": "path", "state": "success" }, { "argument": "Status", "expected": "FAILED", "matcher": "path", "state": "failure" }, { "expected": "ValidationError", "matcher": "error", "state": "failure" } ] } } } botocore-1.5.7/botocore/data/cloudformation/2010-05-15/paginators-1.json0000666454262600001440000000107713042511306026413 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeStackEvents": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "StackEvents" }, "DescribeStacks": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Stacks" }, "ListStackResources": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "StackResourceSummaries" }, "ListStacks": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "StackSummaries" } } } botocore-1.5.7/botocore/data/cloudformation/2010-05-15/service-2.json0000666454262600001440000036601013042511306025706 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2010-05-15", "endpointPrefix":"cloudformation", "protocol":"query", "serviceFullName":"AWS CloudFormation", "signatureVersion":"v4", "uid":"cloudformation-2010-05-15", "xmlNamespace":"http://cloudformation.amazonaws.com/doc/2010-05-15/" }, "operations":{ "CancelUpdateStack":{ "name":"CancelUpdateStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelUpdateStackInput"}, "documentation":"

Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.

You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.

" }, "ContinueUpdateRollback":{ "name":"ContinueUpdateRollback", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ContinueUpdateRollbackInput"}, "output":{ "shape":"ContinueUpdateRollbackOutput", "resultWrapper":"ContinueUpdateRollbackResult" }, "documentation":"

For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.

A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.

" }, "CreateChangeSet":{ "name":"CreateChangeSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateChangeSetInput"}, "output":{ "shape":"CreateChangeSetOutput", "resultWrapper":"CreateChangeSetResult" }, "errors":[ {"shape":"AlreadyExistsException"}, {"shape":"InsufficientCapabilitiesException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a list of changes for a stack. AWS CloudFormation generates the change set by comparing the template's information with the information that you submit. A change set can help you understand which resources AWS CloudFormation will change, and how it will change them, before you update your stack. Change sets allow you to check before making a change to avoid deleting or replacing critical resources.

AWS CloudFormation doesn't make any changes to the stack when you create a change set. To make the specified changes, you must execute the change set by using the ExecuteChangeSet action.

After the call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set, use the DescribeChangeSet action.

" }, "CreateStack":{ "name":"CreateStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateStackInput"}, "output":{ "shape":"CreateStackOutput", "resultWrapper":"CreateStackResult" }, "errors":[ {"shape":"LimitExceededException"}, {"shape":"AlreadyExistsException"}, {"shape":"InsufficientCapabilitiesException"} ], "documentation":"

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

" }, "DeleteChangeSet":{ "name":"DeleteChangeSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteChangeSetInput"}, "output":{ "shape":"DeleteChangeSetOutput", "resultWrapper":"DeleteChangeSetResult" }, "errors":[ {"shape":"InvalidChangeSetStatusException"} ], "documentation":"

Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.

If the call successfully completes, AWS CloudFormation successfully deleted the change set.

" }, "DeleteStack":{ "name":"DeleteStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteStackInput"}, "documentation":"

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

" }, "DescribeAccountLimits":{ "name":"DescribeAccountLimits", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAccountLimitsInput"}, "output":{ "shape":"DescribeAccountLimitsOutput", "resultWrapper":"DescribeAccountLimitsResult" }, "documentation":"

Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.

" }, "DescribeChangeSet":{ "name":"DescribeChangeSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeChangeSetInput"}, "output":{ "shape":"DescribeChangeSetOutput", "resultWrapper":"DescribeChangeSetResult" }, "errors":[ {"shape":"ChangeSetNotFoundException"} ], "documentation":"

Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide.

" }, "DescribeStackEvents":{ "name":"DescribeStackEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStackEventsInput"}, "output":{ "shape":"DescribeStackEventsOutput", "resultWrapper":"DescribeStackEventsResult" }, "documentation":"

Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.

You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).

" }, "DescribeStackResource":{ "name":"DescribeStackResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStackResourceInput"}, "output":{ "shape":"DescribeStackResourceOutput", "resultWrapper":"DescribeStackResourceResult" }, "documentation":"

Returns a description of the specified resource in the specified stack.

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.

" }, "DescribeStackResources":{ "name":"DescribeStackResources", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStackResourcesInput"}, "output":{ "shape":"DescribeStackResourcesOutput", "resultWrapper":"DescribeStackResourcesResult" }, "documentation":"

Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.

Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.

For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.

You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide.

A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.

" }, "DescribeStacks":{ "name":"DescribeStacks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStacksInput"}, "output":{ "shape":"DescribeStacksOutput", "resultWrapper":"DescribeStacksResult" }, "documentation":"

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

If the stack does not exist, an AmazonCloudFormationException is returned.

" }, "EstimateTemplateCost":{ "name":"EstimateTemplateCost", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EstimateTemplateCostInput"}, "output":{ "shape":"EstimateTemplateCostOutput", "resultWrapper":"EstimateTemplateCostResult" }, "documentation":"

Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

" }, "ExecuteChangeSet":{ "name":"ExecuteChangeSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ExecuteChangeSetInput"}, "output":{ "shape":"ExecuteChangeSetOutput", "resultWrapper":"ExecuteChangeSetResult" }, "errors":[ {"shape":"InvalidChangeSetStatusException"}, {"shape":"ChangeSetNotFoundException"}, {"shape":"InsufficientCapabilitiesException"} ], "documentation":"

Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.

When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.

If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.

" }, "GetStackPolicy":{ "name":"GetStackPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetStackPolicyInput"}, "output":{ "shape":"GetStackPolicyOutput", "resultWrapper":"GetStackPolicyResult" }, "documentation":"

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.

" }, "GetTemplate":{ "name":"GetTemplate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetTemplateInput"}, "output":{ "shape":"GetTemplateOutput", "resultWrapper":"GetTemplateResult" }, "errors":[ {"shape":"ChangeSetNotFoundException"} ], "documentation":"

Returns the template body for a specified stack. You can get the template for running or deleted stacks.

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

If the template does not exist, a ValidationError is returned.

" }, "GetTemplateSummary":{ "name":"GetTemplateSummary", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetTemplateSummaryInput"}, "output":{ "shape":"GetTemplateSummaryOutput", "resultWrapper":"GetTemplateSummaryResult" }, "documentation":"

Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a running or deleted stack.

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.

" }, "ListChangeSets":{ "name":"ListChangeSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListChangeSetsInput"}, "output":{ "shape":"ListChangeSetsOutput", "resultWrapper":"ListChangeSetsResult" }, "documentation":"

Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.

" }, "ListExports":{ "name":"ListExports", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListExportsInput"}, "output":{ "shape":"ListExportsOutput", "resultWrapper":"ListExportsResult" }, "documentation":"

Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function.

For more information, see AWS CloudFormation Export Stack Output Values.

" }, "ListImports":{ "name":"ListImports", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListImportsInput"}, "output":{ "shape":"ListImportsOutput", "resultWrapper":"ListImportsResult" }, "documentation":"

Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.

For more information about importing an exported output value, see the Fn::ImportValue function.

" }, "ListStackResources":{ "name":"ListStackResources", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListStackResourcesInput"}, "output":{ "shape":"ListStackResourcesOutput", "resultWrapper":"ListStackResourcesResult" }, "documentation":"

Returns descriptions of all resources of the specified stack.

For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.

" }, "ListStacks":{ "name":"ListStacks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListStacksInput"}, "output":{ "shape":"ListStacksOutput", "resultWrapper":"ListStacksResult" }, "documentation":"

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).

" }, "SetStackPolicy":{ "name":"SetStackPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetStackPolicyInput"}, "documentation":"

Sets a stack policy for a specified stack.

" }, "SignalResource":{ "name":"SignalResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SignalResourceInput"}, "documentation":"

Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.

" }, "UpdateStack":{ "name":"UpdateStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateStackInput"}, "output":{ "shape":"UpdateStackOutput", "resultWrapper":"UpdateStackResult" }, "errors":[ {"shape":"InsufficientCapabilitiesException"} ], "documentation":"

Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.

To get a copy of the template for an existing stack, you can use the GetTemplate action.

For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.

" }, "ValidateTemplate":{ "name":"ValidateTemplate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ValidateTemplateInput"}, "output":{ "shape":"ValidateTemplateOutput", "resultWrapper":"ValidateTemplateResult" }, "documentation":"

Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.

" } }, "shapes":{ "AccountLimit":{ "type":"structure", "members":{ "Name":{ "shape":"LimitName", "documentation":"

The name of the account limit. Currently, the only account limit is StackLimit.

" }, "Value":{ "shape":"LimitValue", "documentation":"

The value that is associated with the account limit name.

" } }, "documentation":"

The AccountLimit data type.

" }, "AccountLimitList":{ "type":"list", "member":{"shape":"AccountLimit"} }, "AllowedValue":{"type":"string"}, "AllowedValues":{ "type":"list", "member":{"shape":"AllowedValue"} }, "AlreadyExistsException":{ "type":"structure", "members":{ }, "documentation":"

Resource with the name requested already exists.

", "error":{ "code":"AlreadyExistsException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "CancelUpdateStackInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackName", "documentation":"

The name or the unique stack ID that is associated with the stack.

" } }, "documentation":"

The input for the CancelUpdateStack action.

" }, "Capabilities":{ "type":"list", "member":{"shape":"Capability"} }, "CapabilitiesReason":{"type":"string"}, "Capability":{ "type":"string", "enum":[ "CAPABILITY_IAM", "CAPABILITY_NAMED_IAM" ] }, "CausingEntity":{"type":"string"}, "Change":{ "type":"structure", "members":{ "Type":{ "shape":"ChangeType", "documentation":"

The type of entity that AWS CloudFormation changes. Currently, the only entity type is Resource.

" }, "ResourceChange":{ "shape":"ResourceChange", "documentation":"

A ResourceChange structure that describes the resource and action that AWS CloudFormation will perform.

" } }, "documentation":"

The Change structure describes the changes AWS CloudFormation will perform if you execute the change set.

" }, "ChangeAction":{ "type":"string", "enum":[ "Add", "Modify", "Remove" ] }, "ChangeSetId":{ "type":"string", "min":1, "pattern":"arn:[-a-zA-Z0-9:/]*" }, "ChangeSetName":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z][-a-zA-Z0-9]*" }, "ChangeSetNameOrId":{ "type":"string", "max":1600, "min":1, "pattern":"[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*" }, "ChangeSetNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets action.

", "error":{ "code":"ChangeSetNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ChangeSetStatus":{ "type":"string", "enum":[ "CREATE_PENDING", "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_COMPLETE", "FAILED" ] }, "ChangeSetStatusReason":{"type":"string"}, "ChangeSetSummaries":{ "type":"list", "member":{"shape":"ChangeSetSummary"} }, "ChangeSetSummary":{ "type":"structure", "members":{ "StackId":{ "shape":"StackId", "documentation":"

The ID of the stack with which the change set is associated.

" }, "StackName":{ "shape":"StackName", "documentation":"

The name of the stack with which the change set is associated.

" }, "ChangeSetId":{ "shape":"ChangeSetId", "documentation":"

The ID of the change set.

" }, "ChangeSetName":{ "shape":"ChangeSetName", "documentation":"

The name of the change set.

" }, "ExecutionStatus":{ "shape":"ExecutionStatus", "documentation":"

If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

" }, "Status":{ "shape":"ChangeSetStatus", "documentation":"

The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

" }, "StatusReason":{ "shape":"ChangeSetStatusReason", "documentation":"

A description of the change set's status. For example, if your change set is in the FAILED state, AWS CloudFormation shows the error message.

" }, "CreationTime":{ "shape":"CreationTime", "documentation":"

The start time when the change set was created, in UTC.

" }, "Description":{ "shape":"Description", "documentation":"

Descriptive information about the change set.

" } }, "documentation":"

The ChangeSetSummary structure describes a change set, its status, and the stack with which it's associated.

" }, "ChangeSetType":{ "type":"string", "enum":[ "CREATE", "UPDATE" ] }, "ChangeSource":{ "type":"string", "enum":[ "ResourceReference", "ParameterReference", "ResourceAttribute", "DirectModification", "Automatic" ] }, "ChangeType":{ "type":"string", "enum":["Resource"] }, "Changes":{ "type":"list", "member":{"shape":"Change"} }, "ClientToken":{ "type":"string", "max":128, "min":1 }, "ContinueUpdateRollbackInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackNameOrId", "documentation":"

The name or the unique ID of the stack that you want to continue rolling back.

Don't specify the name of a nested stack (a stack that was created by using the AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that contains the AWS::CloudFormation::Stack resource).

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

" }, "ResourcesToSkip":{ "shape":"ResourcesToSkip", "documentation":"

A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason.

Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable.

Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources.

To specify resources in a nested stack, use the following format: NestedStackName.ResourceLogicalID. You can specify a nested stack resource (the logical ID of an AWS::CloudFormation::Stack resource) only if it's in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED.

" } }, "documentation":"

The input for the ContinueUpdateRollback action.

" }, "ContinueUpdateRollbackOutput":{ "type":"structure", "members":{ }, "documentation":"

The output for a ContinueUpdateRollback action.

" }, "CreateChangeSetInput":{ "type":"structure", "required":[ "StackName", "ChangeSetName" ], "members":{ "StackName":{ "shape":"StackNameOrId", "documentation":"

The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

" }, "TemplateBody":{ "shape":"TemplateBody", "documentation":"

A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

" }, "TemplateURL":{ "shape":"TemplateURL", "documentation":"

The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

" }, "UsePreviousTemplate":{ "shape":"UsePreviousTemplate", "documentation":"

Whether to reuse the template that is associated with the stack to create the change set.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.

" }, "Capabilities":{ "shape":"Capabilities", "documentation":"

A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

" }, "ResourceTypes":{ "shape":"ResourceTypes", "documentation":"

The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

" }, "NotificationARNs":{ "shape":"NotificationARNs", "documentation":"

The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

" }, "Tags":{ "shape":"Tags", "documentation":"

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags.

" }, "ChangeSetName":{ "shape":"ChangeSetName", "documentation":"

The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retry CreateChangeSet requests to ensure that AWS CloudFormation successfully received them.

" }, "Description":{ "shape":"Description", "documentation":"

A description to help you identify this change set.

" }, "ChangeSetType":{ "shape":"ChangeSetType", "documentation":"

The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE.

If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.

By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

" } }, "documentation":"

The input for the CreateChangeSet action.

" }, "CreateChangeSetOutput":{ "type":"structure", "members":{ "Id":{ "shape":"ChangeSetId", "documentation":"

The Amazon Resource Name (ARN) of the change set.

" }, "StackId":{ "shape":"StackId", "documentation":"

The unique ID of the stack.

" } }, "documentation":"

The output for the CreateChangeSet action.

" }, "CreateStackInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackName", "documentation":"

The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.

A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.

" }, "TemplateBody":{ "shape":"TemplateBody", "documentation":"

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

" }, "TemplateURL":{ "shape":"TemplateURL", "documentation":"

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

" }, "DisableRollback":{ "shape":"DisableRollback", "documentation":"

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

Default: false

" }, "TimeoutInMinutes":{ "shape":"TimeoutMinutes", "documentation":"

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

" }, "NotificationARNs":{ "shape":"NotificationARNs", "documentation":"

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

" }, "Capabilities":{ "shape":"Capabilities", "documentation":"

A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

" }, "ResourceTypes":{ "shape":"ResourceTypes", "documentation":"

The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the following syntax to describe template resource types: AWS::* (for all AWS resource), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for all resources of a particular AWS service), and AWS::service_name::resource_logical_ID (for a specific AWS resource).

If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

" }, "OnFailure":{ "shape":"OnFailure", "documentation":"

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

Default: ROLLBACK

" }, "StackPolicyBody":{ "shape":"StackPolicyBody", "documentation":"

Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

" }, "StackPolicyURL":{ "shape":"StackPolicyURL", "documentation":"

Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

" }, "Tags":{ "shape":"Tags", "documentation":"

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 10 tags can be specified.

" } }, "documentation":"

The input for CreateStack action.

" }, "CreateStackOutput":{ "type":"structure", "members":{ "StackId":{ "shape":"StackId", "documentation":"

Unique identifier of the stack.

" } }, "documentation":"

The output for a CreateStack action.

" }, "CreationTime":{"type":"timestamp"}, "DeleteChangeSetInput":{ "type":"structure", "required":["ChangeSetName"], "members":{ "ChangeSetName":{ "shape":"ChangeSetNameOrId", "documentation":"

The name or Amazon Resource Name (ARN) of the change set that you want to delete.

" }, "StackName":{ "shape":"StackNameOrId", "documentation":"

If you specified the name of a change set to delete, specify the stack name or ID (ARN) that is associated with it.

" } }, "documentation":"

The input for the DeleteChangeSet action.

" }, "DeleteChangeSetOutput":{ "type":"structure", "members":{ }, "documentation":"

The output for the DeleteChangeSet action.

" }, "DeleteStackInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackName", "documentation":"

The name or the unique stack ID that is associated with the stack.

" }, "RetainResources":{ "shape":"RetainResources", "documentation":"

For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, AWS CloudFormation deletes the stack but does not delete the retained resources.

Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

" } }, "documentation":"

The input for DeleteStack action.

" }, "DeletionTime":{"type":"timestamp"}, "DescribeAccountLimitsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

A string that identifies the next page of limits that you want to retrieve.

" } }, "documentation":"

The input for the DescribeAccountLimits action.

" }, "DescribeAccountLimitsOutput":{ "type":"structure", "members":{ "AccountLimits":{ "shape":"AccountLimitList", "documentation":"

An account limit structure that contain a list of AWS CloudFormation account limits and their values.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page exists, this value is null.

" } }, "documentation":"

The output for the DescribeAccountLimits action.

" }, "DescribeChangeSetInput":{ "type":"structure", "required":["ChangeSetName"], "members":{ "ChangeSetName":{ "shape":"ChangeSetNameOrId", "documentation":"

The name or Amazon Resource Name (ARN) of the change set that you want to describe.

" }, "StackName":{ "shape":"StackNameOrId", "documentation":"

If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.

" } }, "documentation":"

The input for the DescribeChangeSet action.

" }, "DescribeChangeSetOutput":{ "type":"structure", "members":{ "ChangeSetName":{ "shape":"ChangeSetName", "documentation":"

The name of the change set.

" }, "ChangeSetId":{ "shape":"ChangeSetId", "documentation":"

The ARN of the change set.

" }, "StackId":{ "shape":"StackId", "documentation":"

The ARN of the stack that is associated with the change set.

" }, "StackName":{ "shape":"StackName", "documentation":"

The name of the stack that is associated with the change set.

" }, "Description":{ "shape":"Description", "documentation":"

Information about the change set.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

" }, "CreationTime":{ "shape":"CreationTime", "documentation":"

The start time when the change set was created, in UTC.

" }, "ExecutionStatus":{ "shape":"ExecutionStatus", "documentation":"

If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

" }, "Status":{ "shape":"ChangeSetStatus", "documentation":"

The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

" }, "StatusReason":{ "shape":"ChangeSetStatusReason", "documentation":"

A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.

" }, "NotificationARNs":{ "shape":"NotificationARNs", "documentation":"

The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

" }, "Capabilities":{ "shape":"Capabilities", "documentation":"

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

" }, "Tags":{ "shape":"Tags", "documentation":"

If you execute the change set, the tags that will be associated with the stack.

" }, "Changes":{ "shape":"Changes", "documentation":"

A list of Change structures that describes the resources AWS CloudFormation changes if you execute the change set.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.

" } }, "documentation":"

The output for the DescribeChangeSet action.

" }, "DescribeStackEventsInput":{ "type":"structure", "members":{ "StackName":{ "shape":"StackName", "documentation":"

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

A string that identifies the next page of events that you want to retrieve.

" } }, "documentation":"

The input for DescribeStackEvents action.

" }, "DescribeStackEventsOutput":{ "type":"structure", "members":{ "StackEvents":{ "shape":"StackEvents", "documentation":"

A list of StackEvents structures.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.

" } }, "documentation":"

The output for a DescribeStackEvents action.

" }, "DescribeStackResourceInput":{ "type":"structure", "required":[ "StackName", "LogicalResourceId" ], "members":{ "StackName":{ "shape":"StackName", "documentation":"

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

" }, "LogicalResourceId":{ "shape":"LogicalResourceId", "documentation":"

The logical name of the resource as specified in the template.

Default: There is no default value.

" } }, "documentation":"

The input for DescribeStackResource action.

" }, "DescribeStackResourceOutput":{ "type":"structure", "members":{ "StackResourceDetail":{ "shape":"StackResourceDetail", "documentation":"

A StackResourceDetail structure containing the description of the specified resource in the specified stack.

" } }, "documentation":"

The output for a DescribeStackResource action.

" }, "DescribeStackResourcesInput":{ "type":"structure", "members":{ "StackName":{ "shape":"StackName", "documentation":"

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

" }, "LogicalResourceId":{ "shape":"LogicalResourceId", "documentation":"

The logical name of the resource as specified in the template.

Default: There is no default value.

" }, "PhysicalResourceId":{ "shape":"PhysicalResourceId", "documentation":"

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

" } }, "documentation":"

The input for DescribeStackResources action.

" }, "DescribeStackResourcesOutput":{ "type":"structure", "members":{ "StackResources":{ "shape":"StackResources", "documentation":"

A list of StackResource structures.

" } }, "documentation":"

The output for a DescribeStackResources action.

" }, "DescribeStacksInput":{ "type":"structure", "members":{ "StackName":{ "shape":"StackName", "documentation":"

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

A string that identifies the next page of stacks that you want to retrieve.

" } }, "documentation":"

The input for DescribeStacks action.

" }, "DescribeStacksOutput":{ "type":"structure", "members":{ "Stacks":{ "shape":"Stacks", "documentation":"

A list of stack structures.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

" } }, "documentation":"

The output for a DescribeStacks action.

" }, "Description":{ "type":"string", "max":1024, "min":1 }, "DisableRollback":{"type":"boolean"}, "EstimateTemplateCostInput":{ "type":"structure", "members":{ "TemplateBody":{ "shape":"TemplateBody", "documentation":"

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

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

" }, "TemplateURL":{ "shape":"TemplateURL", "documentation":"

Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

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

" }, "Parameters":{ "shape":"Parameters", "documentation":"

A list of Parameter structures that specify input parameters.

" } }, "documentation":"

The input for an EstimateTemplateCost action.

" }, "EstimateTemplateCostOutput":{ "type":"structure", "members":{ "Url":{ "shape":"Url", "documentation":"

An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

" } }, "documentation":"

The output for a EstimateTemplateCost action.

" }, "EvaluationType":{ "type":"string", "enum":[ "Static", "Dynamic" ] }, "EventId":{"type":"string"}, "ExecuteChangeSetInput":{ "type":"structure", "required":["ChangeSetName"], "members":{ "ChangeSetName":{ "shape":"ChangeSetNameOrId", "documentation":"

The name or ARN of the change set that you want use to update the specified stack.

" }, "StackName":{ "shape":"StackNameOrId", "documentation":"

If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute.

" } }, "documentation":"

The input for the ExecuteChangeSet action.

" }, "ExecuteChangeSetOutput":{ "type":"structure", "members":{ }, "documentation":"

The output for the ExecuteChangeSet action.

" }, "ExecutionStatus":{ "type":"string", "enum":[ "UNAVAILABLE", "AVAILABLE", "EXECUTE_IN_PROGRESS", "EXECUTE_COMPLETE", "EXECUTE_FAILED", "OBSOLETE" ] }, "Export":{ "type":"structure", "members":{ "ExportingStackId":{ "shape":"StackId", "documentation":"

The stack that contains the exported output name and value.

" }, "Name":{ "shape":"ExportName", "documentation":"

The name of exported output value. Use this name and the Fn::ImportValue function to import the associated value into other stacks. The name is defined in the Export field in the associated stack's Outputs section.

" }, "Value":{ "shape":"ExportValue", "documentation":"

The value of the exported output, such as a resource physical ID. This value is defined in the Export field in the associated stack's Outputs section.

" } }, "documentation":"

The Export structure describes the exported output values for a stack.

" }, "ExportName":{"type":"string"}, "ExportValue":{"type":"string"}, "Exports":{ "type":"list", "member":{"shape":"Export"} }, "GetStackPolicyInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackName", "documentation":"

The name or unique stack ID that is associated with the stack whose policy you want to get.

" } }, "documentation":"

The input for the GetStackPolicy action.

" }, "GetStackPolicyOutput":{ "type":"structure", "members":{ "StackPolicyBody":{ "shape":"StackPolicyBody", "documentation":"

Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.)

" } }, "documentation":"

The output for the GetStackPolicy action.

" }, "GetTemplateInput":{ "type":"structure", "members":{ "StackName":{ "shape":"StackName", "documentation":"

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

" }, "ChangeSetName":{ "shape":"ChangeSetNameOrId", "documentation":"

The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

" }, "TemplateStage":{ "shape":"TemplateStage", "documentation":"

For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original. To get the template after AWS CloudFormation has processed all transforms, specify Processed.

If the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original.

" } }, "documentation":"

The input for a GetTemplate action.

" }, "GetTemplateOutput":{ "type":"structure", "members":{ "TemplateBody":{ "shape":"TemplateBody", "documentation":"

Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

AWS CloudFormation returns the same template that was used when the stack was created.

" }, "StagesAvailable":{ "shape":"StageList", "documentation":"

The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After AWS CloudFormation finishes creating the change set, the Processed template becomes available.

" } }, "documentation":"

The output for GetTemplate action.

" }, "GetTemplateSummaryInput":{ "type":"structure", "members":{ "TemplateBody":{ "shape":"TemplateBody", "documentation":"

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, TemplateBody, or TemplateURL.

" }, "TemplateURL":{ "shape":"TemplateURL", "documentation":"

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, TemplateBody, or TemplateURL.

" }, "StackName":{ "shape":"StackNameOrId", "documentation":"

The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

Conditional: You must specify only one of the following parameters: StackName, TemplateBody, or TemplateURL.

" } }, "documentation":"

The input for the GetTemplateSummary action.

" }, "GetTemplateSummaryOutput":{ "type":"structure", "members":{ "Parameters":{ "shape":"ParameterDeclarations", "documentation":"

A list of parameter declarations that describe various properties for each parameter.

" }, "Description":{ "shape":"Description", "documentation":"

The value that is defined in the Description property of the template.

" }, "Capabilities":{ "shape":"Capabilities", "documentation":"

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

" }, "CapabilitiesReason":{ "shape":"CapabilitiesReason", "documentation":"

The list of resources that generated the values in the Capabilities response element.

" }, "ResourceTypes":{ "shape":"ResourceTypes", "documentation":"

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

" }, "Version":{ "shape":"Version", "documentation":"

The AWS template format version, which identifies the capabilities of the template.

" }, "Metadata":{ "shape":"Metadata", "documentation":"

The value that is defined for the Metadata property of the template.

" }, "DeclaredTransforms":{ "shape":"TransformsList", "documentation":"

A list of the transforms that are declared in the template.

" } }, "documentation":"

The output for the GetTemplateSummary action.

" }, "Imports":{ "type":"list", "member":{"shape":"StackName"} }, "InsufficientCapabilitiesException":{ "type":"structure", "members":{ }, "documentation":"

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

", "error":{ "code":"InsufficientCapabilitiesException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidChangeSetStatusException":{ "type":"structure", "members":{ }, "documentation":"

The specified change set cannot be used to update the stack. For example, the change set status might be CREATE_IN_PROGRESS or the stack status might be UPDATE_IN_PROGRESS.

", "error":{ "code":"InvalidChangeSetStatus", "httpStatusCode":400, "senderFault":true }, "exception":true }, "LastUpdatedTime":{"type":"timestamp"}, "LimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

Quota for the resource has already been reached.

", "error":{ "code":"LimitExceededException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "LimitName":{"type":"string"}, "LimitValue":{"type":"integer"}, "ListChangeSetsInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackNameOrId", "documentation":"

The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve.

" } }, "documentation":"

The input for the ListChangeSets action.

" }, "ListChangeSetsOutput":{ "type":"structure", "members":{ "Summaries":{ "shape":"ChangeSetSummaries", "documentation":"

A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional page, this value is null.

" } }, "documentation":"

The output for the ListChangeSets action.

" }, "ListExportsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

A string (provided by the ListExports response output) that identifies the next page of exported output values that you asked to retrieve.

" } } }, "ListExportsOutput":{ "type":"structure", "members":{ "Exports":{ "shape":"Exports", "documentation":"

The output for the ListExports action.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null.

" } } }, "ListImportsInput":{ "type":"structure", "required":["ExportName"], "members":{ "ExportName":{ "shape":"ExportName", "documentation":"

The name of the exported output value. AWS CloudFormation returns the stack names that are importing this value.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value.

" } } }, "ListImportsOutput":{ "type":"structure", "members":{ "Imports":{ "shape":"Imports", "documentation":"

A list of stack names that are importing the specified exported output value.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

A string that identifies the next page of exports. If there is no additional page, this value is null.

" } } }, "ListStackResourcesInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackName", "documentation":"

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

A string that identifies the next page of stack resources that you want to retrieve.

" } }, "documentation":"

The input for the ListStackResource action.

" }, "ListStackResourcesOutput":{ "type":"structure", "members":{ "StackResourceSummaries":{ "shape":"StackResourceSummaries", "documentation":"

A list of StackResourceSummary structures.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null.

" } }, "documentation":"

The output for a ListStackResources action.

" }, "ListStacksInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

A string that identifies the next page of stacks that you want to retrieve.

" }, "StackStatusFilter":{ "shape":"StackStatusFilter", "documentation":"

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

" } }, "documentation":"

The input for ListStacks action.

" }, "ListStacksOutput":{ "type":"structure", "members":{ "StackSummaries":{ "shape":"StackSummaries", "documentation":"

A list of StackSummary structures containing information about the specified stacks.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

" } }, "documentation":"

The output for ListStacks action.

" }, "LogicalResourceId":{"type":"string"}, "Metadata":{"type":"string"}, "NextToken":{ "type":"string", "max":1024, "min":1 }, "NoEcho":{"type":"boolean"}, "NotificationARN":{"type":"string"}, "NotificationARNs":{ "type":"list", "member":{"shape":"NotificationARN"}, "max":5 }, "OnFailure":{ "type":"string", "enum":[ "DO_NOTHING", "ROLLBACK", "DELETE" ] }, "Output":{ "type":"structure", "members":{ "OutputKey":{ "shape":"OutputKey", "documentation":"

The key associated with the output.

" }, "OutputValue":{ "shape":"OutputValue", "documentation":"

The value associated with the output.

" }, "Description":{ "shape":"Description", "documentation":"

User defined description associated with the output.

" } }, "documentation":"

The Output data type.

" }, "OutputKey":{"type":"string"}, "OutputValue":{"type":"string"}, "Outputs":{ "type":"list", "member":{"shape":"Output"} }, "Parameter":{ "type":"structure", "members":{ "ParameterKey":{ "shape":"ParameterKey", "documentation":"

The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

" }, "ParameterValue":{ "shape":"ParameterValue", "documentation":"

The value associated with the parameter.

" }, "UsePreviousValue":{ "shape":"UsePreviousValue", "documentation":"

During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

" } }, "documentation":"

The Parameter data type.

" }, "ParameterConstraints":{ "type":"structure", "members":{ "AllowedValues":{ "shape":"AllowedValues", "documentation":"

A list of values that are permitted for a parameter.

" } }, "documentation":"

A set of criteria that AWS CloudFormation uses to validate parameter values. Although other constraints might be defined in the stack template, AWS CloudFormation returns only the AllowedValues property.

" }, "ParameterDeclaration":{ "type":"structure", "members":{ "ParameterKey":{ "shape":"ParameterKey", "documentation":"

The name that is associated with the parameter.

" }, "DefaultValue":{ "shape":"ParameterValue", "documentation":"

The default value of the parameter.

" }, "ParameterType":{ "shape":"ParameterType", "documentation":"

The type of parameter.

" }, "NoEcho":{ "shape":"NoEcho", "documentation":"

Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.

" }, "Description":{ "shape":"Description", "documentation":"

The description that is associate with the parameter.

" }, "ParameterConstraints":{ "shape":"ParameterConstraints", "documentation":"

The criteria that AWS CloudFormation uses to validate parameter values.

" } }, "documentation":"

The ParameterDeclaration data type.

" }, "ParameterDeclarations":{ "type":"list", "member":{"shape":"ParameterDeclaration"} }, "ParameterKey":{"type":"string"}, "ParameterType":{"type":"string"}, "ParameterValue":{"type":"string"}, "Parameters":{ "type":"list", "member":{"shape":"Parameter"} }, "PhysicalResourceId":{"type":"string"}, "PropertyName":{"type":"string"}, "Replacement":{ "type":"string", "enum":[ "True", "False", "Conditional" ] }, "RequiresRecreation":{ "type":"string", "enum":[ "Never", "Conditionally", "Always" ] }, "ResourceAttribute":{ "type":"string", "enum":[ "Properties", "Metadata", "CreationPolicy", "UpdatePolicy", "DeletionPolicy", "Tags" ] }, "ResourceChange":{ "type":"structure", "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), or Remove (deletes a resource).

" }, "LogicalResourceId":{ "shape":"LogicalResourceId", "documentation":"

The resource's logical ID, which is defined in the stack's template.

" }, "PhysicalResourceId":{ "shape":"PhysicalResourceId", "documentation":"

The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.

" }, "ResourceType":{ "shape":"ResourceType", "documentation":"

The type of AWS CloudFormation resource, such as AWS::S3::Bucket.

" }, "Replacement":{ "shape":"Replacement", "documentation":"

For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditionally.

If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally, and then Never.

" }, "Scope":{ "shape":"Scope", "documentation":"

For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

" }, "Details":{ "shape":"ResourceChangeDetails", "documentation":"

For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.

" } }, "documentation":"

The ResourceChange structure describes the resource and the action that AWS CloudFormation will perform on it if you execute this change set.

" }, "ResourceChangeDetail":{ "type":"structure", "members":{ "Target":{ "shape":"ResourceTargetDefinition", "documentation":"

A ResourceTargetDefinition structure that describes the field that AWS CloudFormation will change and whether the resource will be recreated.

" }, "Evaluation":{ "shape":"EvaluationType", "documentation":"

Indicates whether AWS CloudFormation can determine the target value, and whether the target value will change before you execute a change set.

For Static evaluations, AWS CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the InstanceType property of an EC2 instance, AWS CloudFormation knows that this property value will change, and its value, so this is a Static evaluation.

For Dynamic evaluations, cannot determine the target value because it depends on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that is conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.

" }, "ChangeSource":{ "shape":"ChangeSource", "documentation":"

The group to which the CausingEntity value belongs. There are five entity groups:

  • ResourceReference entities are Ref intrinsic functions that refer to resources in the template, such as { \"Ref\" : \"MyEC2InstanceResource\" }.

  • ParameterReference entities are Ref intrinsic functions that get template parameter values, such as { \"Ref\" : \"MyPasswordParameter\" }.

  • ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute values, such as { \"Fn::GetAtt\" : [ \"MyEC2InstanceResource\", \"PublicDnsName\" ] }.

  • DirectModification entities are changes that are made directly to the template.

  • Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, AWS CloudFormation sets the ChangeSource to Automatic because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to AWS CloudFormation until you run an update on the parent stack.

" }, "CausingEntity":{ "shape":"CausingEntity", "documentation":"

The identity of the entity that triggered this change. This entity is a member of the group that is specified by the ChangeSource field. For example, if you modified the value of the KeyPairName parameter, the CausingEntity is the name of the parameter (KeyPairName).

If the ChangeSource value is DirectModification, no value is given for CausingEntity.

" } }, "documentation":"

For a resource with Modify as the action, the ResourceChange structure describes the changes AWS CloudFormation will make to that resource.

" }, "ResourceChangeDetails":{ "type":"list", "member":{"shape":"ResourceChangeDetail"} }, "ResourceProperties":{"type":"string"}, "ResourceSignalStatus":{ "type":"string", "enum":[ "SUCCESS", "FAILURE" ] }, "ResourceSignalUniqueId":{ "type":"string", "max":64, "min":1 }, "ResourceStatus":{ "type":"string", "enum":[ "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATE_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "DELETE_SKIPPED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED", "UPDATE_COMPLETE" ] }, "ResourceStatusReason":{"type":"string"}, "ResourceTargetDefinition":{ "type":"structure", "members":{ "Attribute":{ "shape":"ResourceAttribute", "documentation":"

Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

" }, "Name":{ "shape":"PropertyName", "documentation":"

If the Attribute value is Properties, the name of the property. For all other attributes, the value is null.

" }, "RequiresRecreation":{ "shape":"RequiresRecreation", "documentation":"

If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the AWS CloudFormation User Guide.

" } }, "documentation":"

The field that AWS CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.

" }, "ResourceToSkip":{ "type":"string", "pattern":"[a-zA-Z0-9]+|[a-zA-Z][-a-zA-Z0-9]*\\.[a-zA-Z0-9]+" }, "ResourceType":{ "type":"string", "max":256, "min":1 }, "ResourceTypes":{ "type":"list", "member":{"shape":"ResourceType"} }, "ResourcesToSkip":{ "type":"list", "member":{"shape":"ResourceToSkip"} }, "RetainResources":{ "type":"list", "member":{"shape":"LogicalResourceId"} }, "RoleARN":{ "type":"string", "max":2048, "min":20 }, "Scope":{ "type":"list", "member":{"shape":"ResourceAttribute"} }, "SetStackPolicyInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackName", "documentation":"

The name or unique stack ID that you want to associate a policy with.

" }, "StackPolicyBody":{ "shape":"StackPolicyBody", "documentation":"

Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

" }, "StackPolicyURL":{ "shape":"StackPolicyURL", "documentation":"

Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

" } }, "documentation":"

The input for the SetStackPolicy action.

" }, "SignalResourceInput":{ "type":"structure", "required":[ "StackName", "LogicalResourceId", "UniqueId", "Status" ], "members":{ "StackName":{ "shape":"StackNameOrId", "documentation":"

The stack name or unique stack ID that includes the resource that you want to signal.

" }, "LogicalResourceId":{ "shape":"LogicalResourceId", "documentation":"

The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

" }, "UniqueId":{ "shape":"ResourceSignalUniqueId", "documentation":"

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

" }, "Status":{ "shape":"ResourceSignalStatus", "documentation":"

The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.

" } }, "documentation":"

The input for the SignalResource action.

" }, "Stack":{ "type":"structure", "required":[ "StackName", "CreationTime", "StackStatus" ], "members":{ "StackId":{ "shape":"StackId", "documentation":"

Unique identifier of the stack.

" }, "StackName":{ "shape":"StackName", "documentation":"

The name associated with the stack.

" }, "ChangeSetId":{ "shape":"ChangeSetId", "documentation":"

The unique ID of the change set.

" }, "Description":{ "shape":"Description", "documentation":"

A user-defined description associated with the stack.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

A list of Parameter structures.

" }, "CreationTime":{ "shape":"CreationTime", "documentation":"

The time at which the stack was created.

" }, "LastUpdatedTime":{ "shape":"LastUpdatedTime", "documentation":"

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

" }, "StackStatus":{ "shape":"StackStatus", "documentation":"

Current status of the stack.

" }, "StackStatusReason":{ "shape":"StackStatusReason", "documentation":"

Success/failure message associated with the stack status.

" }, "DisableRollback":{ "shape":"DisableRollback", "documentation":"

Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback

  • false: enable rollback

" }, "NotificationARNs":{ "shape":"NotificationARNs", "documentation":"

SNS topic ARNs to which stack related events are published.

" }, "TimeoutInMinutes":{ "shape":"TimeoutMinutes", "documentation":"

The amount of time within which stack creation should complete.

" }, "Capabilities":{ "shape":"Capabilities", "documentation":"

The capabilities allowed in the stack.

" }, "Outputs":{ "shape":"Outputs", "documentation":"

A list of output structures.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.

" }, "Tags":{ "shape":"Tags", "documentation":"

A list of Tags that specify information about the stack.

" } }, "documentation":"

The Stack data type.

" }, "StackEvent":{ "type":"structure", "required":[ "StackId", "EventId", "StackName", "Timestamp" ], "members":{ "StackId":{ "shape":"StackId", "documentation":"

The unique ID name of the instance of the stack.

" }, "EventId":{ "shape":"EventId", "documentation":"

The unique ID of this event.

" }, "StackName":{ "shape":"StackName", "documentation":"

The name associated with a stack.

" }, "LogicalResourceId":{ "shape":"LogicalResourceId", "documentation":"

The logical name of the resource specified in the template.

" }, "PhysicalResourceId":{ "shape":"PhysicalResourceId", "documentation":"

The name or unique identifier associated with the physical instance of the resource.

" }, "ResourceType":{ "shape":"ResourceType", "documentation":"

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

" }, "Timestamp":{ "shape":"Timestamp", "documentation":"

Time the status was updated.

" }, "ResourceStatus":{ "shape":"ResourceStatus", "documentation":"

Current status of the resource.

" }, "ResourceStatusReason":{ "shape":"ResourceStatusReason", "documentation":"

Success/failure message associated with the resource.

" }, "ResourceProperties":{ "shape":"ResourceProperties", "documentation":"

BLOB of the properties used to create the resource.

" } }, "documentation":"

The StackEvent data type.

" }, "StackEvents":{ "type":"list", "member":{"shape":"StackEvent"} }, "StackId":{"type":"string"}, "StackName":{"type":"string"}, "StackNameOrId":{ "type":"string", "min":1, "pattern":"([a-zA-Z][-a-zA-Z0-9]*)|(arn:\\b(aws|aws-us-gov|aws-cn)\\b:[-a-zA-Z0-9:/._+]*)" }, "StackPolicyBody":{ "type":"string", "max":16384, "min":1 }, "StackPolicyDuringUpdateBody":{ "type":"string", "max":16384, "min":1 }, "StackPolicyDuringUpdateURL":{ "type":"string", "max":1350, "min":1 }, "StackPolicyURL":{ "type":"string", "max":1350, "min":1 }, "StackResource":{ "type":"structure", "required":[ "LogicalResourceId", "ResourceType", "Timestamp", "ResourceStatus" ], "members":{ "StackName":{ "shape":"StackName", "documentation":"

The name associated with the stack.

" }, "StackId":{ "shape":"StackId", "documentation":"

Unique identifier of the stack.

" }, "LogicalResourceId":{ "shape":"LogicalResourceId", "documentation":"

The logical name of the resource specified in the template.

" }, "PhysicalResourceId":{ "shape":"PhysicalResourceId", "documentation":"

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

" }, "ResourceType":{ "shape":"ResourceType", "documentation":"

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

" }, "Timestamp":{ "shape":"Timestamp", "documentation":"

Time the status was updated.

" }, "ResourceStatus":{ "shape":"ResourceStatus", "documentation":"

Current status of the resource.

" }, "ResourceStatusReason":{ "shape":"ResourceStatusReason", "documentation":"

Success/failure message associated with the resource.

" }, "Description":{ "shape":"Description", "documentation":"

User defined description associated with the resource.

" } }, "documentation":"

The StackResource data type.

" }, "StackResourceDetail":{ "type":"structure", "required":[ "LogicalResourceId", "ResourceType", "LastUpdatedTimestamp", "ResourceStatus" ], "members":{ "StackName":{ "shape":"StackName", "documentation":"

The name associated with the stack.

" }, "StackId":{ "shape":"StackId", "documentation":"

Unique identifier of the stack.

" }, "LogicalResourceId":{ "shape":"LogicalResourceId", "documentation":"

The logical name of the resource specified in the template.

" }, "PhysicalResourceId":{ "shape":"PhysicalResourceId", "documentation":"

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

" }, "ResourceType":{ "shape":"ResourceType", "documentation":"

Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

" }, "LastUpdatedTimestamp":{ "shape":"Timestamp", "documentation":"

Time the status was updated.

" }, "ResourceStatus":{ "shape":"ResourceStatus", "documentation":"

Current status of the resource.

" }, "ResourceStatusReason":{ "shape":"ResourceStatusReason", "documentation":"

Success/failure message associated with the resource.

" }, "Description":{ "shape":"Description", "documentation":"

User defined description associated with the resource.

" }, "Metadata":{ "shape":"Metadata", "documentation":"

The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.

" } }, "documentation":"

Contains detailed information about the specified stack resource.

" }, "StackResourceSummaries":{ "type":"list", "member":{"shape":"StackResourceSummary"} }, "StackResourceSummary":{ "type":"structure", "required":[ "LogicalResourceId", "ResourceType", "LastUpdatedTimestamp", "ResourceStatus" ], "members":{ "LogicalResourceId":{ "shape":"LogicalResourceId", "documentation":"

The logical name of the resource specified in the template.

" }, "PhysicalResourceId":{ "shape":"PhysicalResourceId", "documentation":"

The name or unique identifier that corresponds to a physical instance ID of the resource.

" }, "ResourceType":{ "shape":"ResourceType", "documentation":"

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

" }, "LastUpdatedTimestamp":{ "shape":"Timestamp", "documentation":"

Time the status was updated.

" }, "ResourceStatus":{ "shape":"ResourceStatus", "documentation":"

Current status of the resource.

" }, "ResourceStatusReason":{ "shape":"ResourceStatusReason", "documentation":"

Success/failure message associated with the resource.

" } }, "documentation":"

Contains high-level information about the specified stack resource.

" }, "StackResources":{ "type":"list", "member":{"shape":"StackResource"} }, "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", "REVIEW_IN_PROGRESS" ] }, "StackStatusFilter":{ "type":"list", "member":{"shape":"StackStatus"} }, "StackStatusReason":{"type":"string"}, "StackSummaries":{ "type":"list", "member":{"shape":"StackSummary"} }, "StackSummary":{ "type":"structure", "required":[ "StackName", "CreationTime", "StackStatus" ], "members":{ "StackId":{ "shape":"StackId", "documentation":"

Unique stack identifier.

" }, "StackName":{ "shape":"StackName", "documentation":"

The name associated with the stack.

" }, "TemplateDescription":{ "shape":"TemplateDescription", "documentation":"

The template description of the template used to create the stack.

" }, "CreationTime":{ "shape":"CreationTime", "documentation":"

The time the stack was created.

" }, "LastUpdatedTime":{ "shape":"LastUpdatedTime", "documentation":"

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

" }, "DeletionTime":{ "shape":"DeletionTime", "documentation":"

The time the stack was deleted.

" }, "StackStatus":{ "shape":"StackStatus", "documentation":"

The current status of the stack.

" }, "StackStatusReason":{ "shape":"StackStatusReason", "documentation":"

Success/Failure message associated with the stack status.

" } }, "documentation":"

The StackSummary Data Type

" }, "Stacks":{ "type":"list", "member":{"shape":"Stack"} }, "StageList":{ "type":"list", "member":{"shape":"TemplateStage"} }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"TagKey", "documentation":"

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

" }, "Value":{ "shape":"TagValue", "documentation":"

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

" } }, "documentation":"

The Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation stack.

" }, "TagKey":{"type":"string"}, "TagValue":{"type":"string"}, "Tags":{ "type":"list", "member":{"shape":"Tag"} }, "TemplateBody":{ "type":"string", "min":1 }, "TemplateDescription":{"type":"string"}, "TemplateParameter":{ "type":"structure", "members":{ "ParameterKey":{ "shape":"ParameterKey", "documentation":"

The name associated with the parameter.

" }, "DefaultValue":{ "shape":"ParameterValue", "documentation":"

The default value associated with the parameter.

" }, "NoEcho":{ "shape":"NoEcho", "documentation":"

Flag indicating whether the parameter should be displayed as plain text in logs and UIs.

" }, "Description":{ "shape":"Description", "documentation":"

User defined description associated with the parameter.

" } }, "documentation":"

The TemplateParameter data type.

" }, "TemplateParameters":{ "type":"list", "member":{"shape":"TemplateParameter"} }, "TemplateStage":{ "type":"string", "enum":[ "Original", "Processed" ] }, "TemplateURL":{ "type":"string", "max":1024, "min":1 }, "TimeoutMinutes":{ "type":"integer", "min":1 }, "Timestamp":{"type":"timestamp"}, "TransformName":{"type":"string"}, "TransformsList":{ "type":"list", "member":{"shape":"TransformName"} }, "UpdateStackInput":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"StackName", "documentation":"

The name or unique stack ID of the stack to update.

" }, "TemplateBody":{ "shape":"TemplateBody", "documentation":"

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

" }, "TemplateURL":{ "shape":"TemplateURL", "documentation":"

Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

" }, "UsePreviousTemplate":{ "shape":"UsePreviousTemplate", "documentation":"

Reuse the existing template that is associated with the stack that you are updating.

" }, "StackPolicyDuringUpdateBody":{ "shape":"StackPolicyDuringUpdateBody", "documentation":"

Structure containing the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.

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.

" }, "StackPolicyDuringUpdateURL":{ "shape":"StackPolicyDuringUpdateURL", "documentation":"

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. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.

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.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

" }, "Capabilities":{ "shape":"Capabilities", "documentation":"

A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.

The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

" }, "ResourceTypes":{ "shape":"ResourceTypes", "documentation":"

The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

" }, "StackPolicyBody":{ "shape":"StackPolicyBody", "documentation":"

Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

" }, "StackPolicyURL":{ "shape":"StackPolicyURL", "documentation":"

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. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

" }, "NotificationARNs":{ "shape":"NotificationARNs", "documentation":"

Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.

" }, "Tags":{ "shape":"Tags", "documentation":"

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 10 tags.

If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.

" } }, "documentation":"

The input for an UpdateStack action.

" }, "UpdateStackOutput":{ "type":"structure", "members":{ "StackId":{ "shape":"StackId", "documentation":"

Unique identifier of the stack.

" } }, "documentation":"

The output for an UpdateStack action.

" }, "Url":{"type":"string"}, "UsePreviousTemplate":{"type":"boolean"}, "UsePreviousValue":{"type":"boolean"}, "ValidateTemplateInput":{ "type":"structure", "members":{ "TemplateBody":{ "shape":"TemplateBody", "documentation":"

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

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

" }, "TemplateURL":{ "shape":"TemplateURL", "documentation":"

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

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

" } }, "documentation":"

The input for ValidateTemplate action.

" }, "ValidateTemplateOutput":{ "type":"structure", "members":{ "Parameters":{ "shape":"TemplateParameters", "documentation":"

A list of TemplateParameter structures.

" }, "Description":{ "shape":"Description", "documentation":"

The description found within the template.

" }, "Capabilities":{ "shape":"Capabilities", "documentation":"

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

" }, "CapabilitiesReason":{ "shape":"CapabilitiesReason", "documentation":"

The list of resources that generated the values in the Capabilities response element.

" }, "DeclaredTransforms":{ "shape":"TransformsList", "documentation":"

A list of the transforms that are declared in the template.

" } }, "documentation":"

The output for ValidateTemplate action.

" }, "Version":{"type":"string"} }, "documentation":"AWS CloudFormation

AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure.

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

For more information about AWS CloudFormation, see the AWS CloudFormation Product Page.

Amazon CloudFormation makes use of other AWS products. For additional technical information about a specific AWS product, see its technical documentation.

" } botocore-1.5.7/botocore/data/snowball/0000777454262600001440000000000013042511307020754 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/snowball/2016-06-30/0000777454262600001440000000000013042511307022007 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/snowball/2016-06-30/service-2.json0000666454262600001440000017351513042511306024514 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-06-30", "endpointPrefix":"snowball", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"Amazon Snowball", "serviceFullName":"Amazon Import/Export Snowball", "signatureVersion":"v4", "targetPrefix":"AWSIESnowballJobManagementService", "uid":"snowball-2016-06-30" }, "operations":{ "CancelCluster":{ "name":"CancelCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelClusterRequest"}, "output":{"shape":"CancelClusterResult"}, "errors":[ {"shape":"KMSRequestFailedException"}, {"shape":"InvalidJobStateException"}, {"shape":"InvalidResourceException"} ], "documentation":"

Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it.

" }, "CancelJob":{ "name":"CancelJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelJobRequest"}, "output":{"shape":"CancelJobResult"}, "errors":[ {"shape":"InvalidResourceException"}, {"shape":"InvalidJobStateException"}, {"shape":"KMSRequestFailedException"} ], "documentation":"

Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action will return a job's JobState as part of the response element data returned.

" }, "CreateAddress":{ "name":"CreateAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAddressRequest"}, "output":{"shape":"CreateAddressResult"}, "errors":[ {"shape":"InvalidAddressException"}, {"shape":"UnsupportedAddressException"} ], "documentation":"

Creates an address for a Snowball to be shipped to.

Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.

" }, "CreateCluster":{ "name":"CreateCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateClusterRequest"}, "output":{"shape":"CreateClusterResult"}, "errors":[ {"shape":"InvalidResourceException"}, {"shape":"KMSRequestFailedException"}, {"shape":"InvalidInputCombinationException"} ], "documentation":"

Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.

" }, "CreateJob":{ "name":"CreateJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateJobRequest"}, "output":{"shape":"CreateJobResult"}, "errors":[ {"shape":"InvalidResourceException"}, {"shape":"KMSRequestFailedException"}, {"shape":"InvalidInputCombinationException"}, {"shape":"ClusterLimitExceededException"} ], "documentation":"

Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster. .

" }, "DescribeAddress":{ "name":"DescribeAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAddressRequest"}, "output":{"shape":"DescribeAddressResult"}, "errors":[ {"shape":"InvalidResourceException"} ], "documentation":"

Takes an AddressId and returns specific details about that address in the form of an Address object.

" }, "DescribeAddresses":{ "name":"DescribeAddresses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAddressesRequest"}, "output":{"shape":"DescribeAddressesResult"}, "errors":[ {"shape":"InvalidResourceException"} ], "documentation":"

Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

" }, "DescribeCluster":{ "name":"DescribeCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClusterRequest"}, "output":{"shape":"DescribeClusterResult"}, "errors":[ {"shape":"InvalidResourceException"} ], "documentation":"

Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

" }, "DescribeJob":{ "name":"DescribeJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeJobRequest"}, "output":{"shape":"DescribeJobResult"}, "errors":[ {"shape":"InvalidResourceException"} ], "documentation":"

Returns information about a specific job including shipping information, job status, and other important metadata. .

" }, "GetJobManifest":{ "name":"GetJobManifest", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetJobManifestRequest"}, "output":{"shape":"GetJobManifestResult"}, "errors":[ {"shape":"InvalidResourceException"}, {"shape":"InvalidJobStateException"} ], "documentation":"

Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.

The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time.

As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.

The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.

" }, "GetJobUnlockCode":{ "name":"GetJobUnlockCode", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetJobUnlockCodeRequest"}, "output":{"shape":"GetJobUnlockCodeResult"}, "errors":[ {"shape":"InvalidResourceException"}, {"shape":"InvalidJobStateException"} ], "documentation":"

Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created.

The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time.

As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.

" }, "GetSnowballUsage":{ "name":"GetSnowballUsage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSnowballUsageRequest"}, "output":{"shape":"GetSnowballUsageResult"}, "documentation":"

Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.

The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.

" }, "ListClusterJobs":{ "name":"ListClusterJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListClusterJobsRequest"}, "output":{"shape":"ListClusterJobsResult"}, "errors":[ {"shape":"InvalidResourceException"} ], "documentation":"

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.

" }, "ListClusters":{ "name":"ListClusters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListClustersRequest"}, "output":{"shape":"ListClustersResult"}, "documentation":"

Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

" }, "ListJobs":{ "name":"ListJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListJobsRequest"}, "output":{"shape":"ListJobsResult"}, "documentation":"

Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.

" }, "UpdateCluster":{ "name":"UpdateCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateClusterRequest"}, "output":{"shape":"UpdateClusterResult"}, "errors":[ {"shape":"InvalidResourceException"}, {"shape":"InvalidJobStateException"}, {"shape":"KMSRequestFailedException"}, {"shape":"InvalidInputCombinationException"} ], "documentation":"

While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available.

" }, "UpdateJob":{ "name":"UpdateJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateJobRequest"}, "output":{"shape":"UpdateJobResult"}, "errors":[ {"shape":"InvalidResourceException"}, {"shape":"InvalidJobStateException"}, {"shape":"KMSRequestFailedException"}, {"shape":"InvalidInputCombinationException"}, {"shape":"ClusterLimitExceededException"} ], "documentation":"

While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.

" } }, "shapes":{ "Address":{ "type":"structure", "members":{ "AddressId":{ "shape":"AddressId", "documentation":"

The unique ID for an address.

" }, "Name":{ "shape":"String", "documentation":"

The name of a person to receive a Snowball at an address.

" }, "Company":{ "shape":"String", "documentation":"

The name of the company to receive a Snowball at an address.

" }, "Street1":{ "shape":"String", "documentation":"

The first line in a street address that a Snowball is to be delivered to.

" }, "Street2":{ "shape":"String", "documentation":"

The second line in a street address that a Snowball is to be delivered to.

" }, "Street3":{ "shape":"String", "documentation":"

The third line in a street address that a Snowball is to be delivered to.

" }, "City":{ "shape":"String", "documentation":"

The city in an address that a Snowball is to be delivered to.

" }, "StateOrProvince":{ "shape":"String", "documentation":"

The state or province in an address that a Snowball is to be delivered to.

" }, "PrefectureOrDistrict":{ "shape":"String", "documentation":"

The prefecture or district that the appliance will be shipped to.

" }, "Landmark":{ "shape":"String", "documentation":"

The landmark identifying the address that the appliance will be shipped to.

" }, "Country":{ "shape":"String", "documentation":"

The country in an address that a Snowball is to be delivered to.

" }, "PostalCode":{ "shape":"String", "documentation":"

The postal code in an address that a Snowball is to be delivered to.

" }, "PhoneNumber":{ "shape":"String", "documentation":"

The phone number associated with an address that a Snowball is to be delivered to.

" } }, "documentation":"

The address that you want the Snowball or Snowballs associated with a specific job to be shipped to. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. Although no individual elements of the Address are required, if the address is invalid or unsupported, then an exception is thrown.

" }, "AddressId":{ "type":"string", "max":40, "min":40, "pattern":"ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, "AddressList":{ "type":"list", "member":{"shape":"Address"} }, "Boolean":{"type":"boolean"}, "CancelClusterRequest":{ "type":"structure", "required":["ClusterId"], "members":{ "ClusterId":{ "shape":"ClusterId", "documentation":"

The 39-character ID for the cluster that you want to cancel, for example CID123e4567-e89b-12d3-a456-426655440000.

" } } }, "CancelClusterResult":{ "type":"structure", "members":{ } }, "CancelJobRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The 39-character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000.

" } } }, "CancelJobResult":{ "type":"structure", "members":{ } }, "ClusterId":{ "type":"string", "max":39, "min":39, "pattern":"CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, "ClusterLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

Job creation failed. Currently, clusters support five nodes. If you have less than five nodes for your cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster has exactly five notes.

", "exception":true }, "ClusterListEntry":{ "type":"structure", "members":{ "ClusterId":{ "shape":"String", "documentation":"

The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000.

" }, "ClusterState":{ "shape":"ClusterState", "documentation":"

The current state of this cluster. For information about the state of a specific node, see JobListEntry$JobState.

" }, "CreationDate":{ "shape":"Timestamp", "documentation":"

The creation date for this cluster.

" }, "Description":{ "shape":"String", "documentation":"

Defines an optional description of the cluster, for example Environmental Data Cluster-01.

" } }, "documentation":"

Contains a cluster's state, a cluster's ID, and other important information.

" }, "ClusterListEntryList":{ "type":"list", "member":{"shape":"ClusterListEntry"} }, "ClusterMetadata":{ "type":"structure", "members":{ "ClusterId":{ "shape":"String", "documentation":"

The automatically generated ID for a cluster.

" }, "Description":{ "shape":"String", "documentation":"

The optional description of the cluster.

" }, "KmsKeyARN":{ "shape":"KmsKeyARN", "documentation":"

The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in AWS Key Management Service (AWS KMS).

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

" }, "ClusterState":{ "shape":"ClusterState", "documentation":"

The current status of the cluster.

" }, "JobType":{ "shape":"JobType", "documentation":"

The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

" }, "SnowballType":{ "shape":"SnowballType", "documentation":"

The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is EDGE.

" }, "CreationDate":{ "shape":"Timestamp", "documentation":"

The creation date for this cluster.

" }, "Resources":{ "shape":"JobResource", "documentation":"

The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

" }, "AddressId":{ "shape":"AddressId", "documentation":"

The automatically generated ID for a specific address.

" }, "ShippingOption":{ "shape":"ShippingOption", "documentation":"

The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows:

  • In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snowball Edges shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

  • In India, Snowball Edges are delivered in one to seven days.

  • In the US, you have access to one-day shipping and two-day shipping.

" }, "Notification":{ "shape":"Notification", "documentation":"

The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

" } }, "documentation":"

Contains metadata about a specific cluster.

" }, "ClusterState":{ "type":"string", "enum":[ "AwaitingQuorum", "Pending", "InUse", "Complete", "Cancelled" ] }, "CreateAddressRequest":{ "type":"structure", "required":["Address"], "members":{ "Address":{ "shape":"Address", "documentation":"

The address that you want the Snowball shipped to.

" } } }, "CreateAddressResult":{ "type":"structure", "members":{ "AddressId":{ "shape":"String", "documentation":"

The automatically generated ID for a specific address. You'll use this ID when you create a job to specify which address you want the Snowball for that job shipped to.

" } } }, "CreateClusterRequest":{ "type":"structure", "required":[ "JobType", "Resources", "AddressId", "RoleARN", "ShippingOption" ], "members":{ "JobType":{ "shape":"JobType", "documentation":"

The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

" }, "Resources":{ "shape":"JobResource", "documentation":"

The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS Lambda functions written in the Python language.

" }, "Description":{ "shape":"String", "documentation":"

An optional description of this specific cluster, for example Environmental Data Cluster-01.

" }, "AddressId":{ "shape":"AddressId", "documentation":"

The ID for the address that you want the cluster shipped to.>

" }, "KmsKeyARN":{ "shape":"KmsKeyARN", "documentation":"

The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).

" }, "SnowballType":{ "shape":"SnowballType", "documentation":"

The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is EDGE.

" }, "ShippingOption":{ "shape":"ShippingOption", "documentation":"

The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows:

  • In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snowball Edges shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

  • In India, Snowball Edges are delivered in one to seven days.

  • In the US, you have access to one-day shipping and two-day shipping.

" }, "Notification":{ "shape":"Notification", "documentation":"

The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

" } } }, "CreateClusterResult":{ "type":"structure", "members":{ "ClusterId":{ "shape":"ClusterId", "documentation":"

The automatically generated ID for a cluster.

" } } }, "CreateJobRequest":{ "type":"structure", "members":{ "JobType":{ "shape":"JobType", "documentation":"

Defines the type of job that you're creating.

" }, "Resources":{ "shape":"JobResource", "documentation":"

Defines the Amazon S3 buckets associated with this job.

With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into.

With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.

" }, "Description":{ "shape":"String", "documentation":"

Defines an optional description of this specific job, for example Important Photos 2016-08-11.

" }, "AddressId":{ "shape":"AddressId", "documentation":"

The ID for the address that you want the Snowball shipped to.

" }, "KmsKeyARN":{ "shape":"KmsKeyARN", "documentation":"

The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.

" }, "SnowballCapacityPreference":{ "shape":"SnowballCapacity", "documentation":"

If your job is being created in one of the US regions, you have the option of specifying what size Snowball you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

" }, "ShippingOption":{ "shape":"ShippingOption", "documentation":"

The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snowball, rather it represents how quickly the Snowball moves to its destination while in transit. Regional shipping speeds are as follows:

  • In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

  • In India, Snowballs are delivered in one to seven days.

  • In the US, you have access to one-day shipping and two-day shipping.

" }, "Notification":{ "shape":"Notification", "documentation":"

Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

" }, "ClusterId":{ "shape":"ClusterId", "documentation":"

The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.

" }, "SnowballType":{ "shape":"SnowballType", "documentation":"

The type of AWS Snowball appliance to use for this job. Currently, the only supported appliance type for cluster jobs is EDGE.

" } } }, "CreateJobResult":{ "type":"structure", "members":{ "JobId":{ "shape":"JobId", "documentation":"

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

" } } }, "DataTransfer":{ "type":"structure", "members":{ "BytesTransferred":{ "shape":"Long", "documentation":"

The number of bytes transferred between a Snowball and Amazon S3.

" }, "ObjectsTransferred":{ "shape":"Long", "documentation":"

The number of objects transferred between a Snowball and Amazon S3.

" }, "TotalBytes":{ "shape":"Long", "documentation":"

The total bytes of data for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.

" }, "TotalObjects":{ "shape":"Long", "documentation":"

The total number of objects for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.

" } }, "documentation":"

Defines the real-time status of a Snowball's data transfer while the appliance is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

" }, "DescribeAddressRequest":{ "type":"structure", "required":["AddressId"], "members":{ "AddressId":{ "shape":"AddressId", "documentation":"

The automatically generated ID for a specific address.

" } } }, "DescribeAddressResult":{ "type":"structure", "members":{ "Address":{ "shape":"Address", "documentation":"

The address that you want the Snowball or Snowballs associated with a specific job to be shipped to.

" } } }, "DescribeAddressesRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"ListLimit", "documentation":"

The number of ADDRESS objects to return.

" }, "NextToken":{ "shape":"String", "documentation":"

HTTP requests are stateless. To identify what object comes \"next\" in the list of ADDRESS objects, you have the option of specifying a value for NextToken as the starting point for your list of returned addresses.

" } } }, "DescribeAddressesResult":{ "type":"structure", "members":{ "Addresses":{ "shape":"AddressList", "documentation":"

The Snowball shipping addresses that were created for this account.

" }, "NextToken":{ "shape":"String", "documentation":"

HTTP requests are stateless. If you use the automatically generated NextToken value in your next DescribeAddresses call, your list of returned addresses will start from this point in the array.

" } } }, "DescribeClusterRequest":{ "type":"structure", "required":["ClusterId"], "members":{ "ClusterId":{ "shape":"ClusterId", "documentation":"

The automatically generated ID for a cluster.

" } } }, "DescribeClusterResult":{ "type":"structure", "members":{ "ClusterMetadata":{ "shape":"ClusterMetadata", "documentation":"

Information about a specific cluster, including shipping information, cluster status, and other important metadata.

" } } }, "DescribeJobRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

" } } }, "DescribeJobResult":{ "type":"structure", "members":{ "JobMetadata":{ "shape":"JobMetadata", "documentation":"

Information about a specific job, including shipping information, job status, and other important metadata.

" }, "SubJobMetadata":{ "shape":"JobMetadataList", "documentation":"

Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.

" } } }, "EventTriggerDefinition":{ "type":"structure", "members":{ "EventResourceARN":{ "shape":"ResourceARN", "documentation":"

The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an AWS Lambda function's event trigger associated with this job.

" } }, "documentation":"

The container for the EventTriggerDefinition$EventResourceARN.

" }, "EventTriggerDefinitionList":{ "type":"list", "member":{"shape":"EventTriggerDefinition"} }, "GetJobManifestRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The ID for a job that you want to get the manifest file for, for example JID123e4567-e89b-12d3-a456-426655440000.

" } } }, "GetJobManifestResult":{ "type":"structure", "members":{ "ManifestURI":{ "shape":"String", "documentation":"

The Amazon S3 presigned URL for the manifest file associated with the specified JobId value.

" } } }, "GetJobUnlockCodeRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The ID for the job that you want to get the UnlockCode value for, for example JID123e4567-e89b-12d3-a456-426655440000.

" } } }, "GetJobUnlockCodeResult":{ "type":"structure", "members":{ "UnlockCode":{ "shape":"String", "documentation":"

The UnlockCode value for the specified job. The UnlockCode value can be accessed for up to 90 days after the job has been created.

" } } }, "GetSnowballUsageRequest":{ "type":"structure", "members":{ } }, "GetSnowballUsageResult":{ "type":"structure", "members":{ "SnowballLimit":{ "shape":"Integer", "documentation":"

The service limit for number of Snowballs this account can have at once. The default service limit is 1 (one).

" }, "SnowballsInUse":{ "shape":"Integer", "documentation":"

The number of Snowballs that this account is currently using.

" } } }, "Integer":{"type":"integer"}, "InvalidAddressException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The address provided was invalid. Check the address with your region's carrier, and try again.

", "exception":true }, "InvalidInputCombinationException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

Job or cluster creation failed. One ore more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.

", "exception":true }, "InvalidJobStateException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The action can't be performed because the job's current state doesn't allow that action to be performed.

", "exception":true }, "InvalidResourceException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The specified resource can't be found. Check the information you provided in your last request, and try again.

", "exception":true }, "JobId":{ "type":"string", "max":39, "min":39, "pattern":"(M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" }, "JobListEntry":{ "type":"structure", "members":{ "JobId":{ "shape":"String", "documentation":"

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

" }, "JobState":{ "shape":"JobState", "documentation":"

The current state of this job.

" }, "IsMaster":{ "shape":"Boolean", "documentation":"

A value that indicates that this job is a master job. A master job represents a successful request to create an export job. Master jobs aren't associated with any Snowballs. Instead, each master job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular master job are listed, because they are created after the master job is created.

" }, "JobType":{ "shape":"JobType", "documentation":"

The type of job.

" }, "SnowballType":{ "shape":"SnowballType", "documentation":"

The type of appliance used with this job.

" }, "CreationDate":{ "shape":"Timestamp", "documentation":"

The creation date for this job.

" }, "Description":{ "shape":"String", "documentation":"

The optional description of this specific job, for example Important Photos 2016-08-11.

" } }, "documentation":"

Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of an export job.

" }, "JobListEntryList":{ "type":"list", "member":{"shape":"JobListEntry"} }, "JobLogs":{ "type":"structure", "members":{ "JobCompletionReportURI":{ "shape":"String", "documentation":"

A link to an Amazon S3 presigned URL where the job completion report is located.

" }, "JobSuccessLogURI":{ "shape":"String", "documentation":"

A link to an Amazon S3 presigned URL where the job success log is located.

" }, "JobFailureLogURI":{ "shape":"String", "documentation":"

A link to an Amazon S3 presigned URL where the job failure log is located.

" } }, "documentation":"

Contains job logs. Whenever Snowball is used to import data into or export data out of Amazon S3, you'll have the option of downloading a PDF job report. Job logs are returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type. The job logs can be accessed for up to 60 minutes after this request has been made. To access any of the job logs after 60 minutes have passed, you'll have to make another call to the DescribeJob action.

For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snowball for your job part is being delivered to you.

The job report provides you insight into the state of your Amazon S3 data transfer. The report includes details about your job or job part for your records.

For deeper visibility into the status of your transferred objects, you can look at the two associated logs: a success log and a failure log. The logs are saved in comma-separated value (CSV) format, and the name of each log includes the ID of the job or job part that the log describes.

" }, "JobMetadata":{ "type":"structure", "members":{ "JobId":{ "shape":"String", "documentation":"

The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

" }, "JobState":{ "shape":"JobState", "documentation":"

The current status of the jobs.

" }, "JobType":{ "shape":"JobType", "documentation":"

The type of job.

" }, "SnowballType":{ "shape":"SnowballType", "documentation":"

The type of appliance used with this job.

" }, "CreationDate":{ "shape":"Timestamp", "documentation":"

The creation date for this job.

" }, "Resources":{ "shape":"JobResource", "documentation":"

An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.

" }, "Description":{ "shape":"String", "documentation":"

The description of the job, provided at job creation.

" }, "KmsKeyARN":{ "shape":"KmsKeyARN", "documentation":"

The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

" }, "AddressId":{ "shape":"AddressId", "documentation":"

The ID for the address that you want the Snowball shipped to.

" }, "ShippingDetails":{ "shape":"ShippingDetails", "documentation":"

A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

" }, "SnowballCapacityPreference":{ "shape":"SnowballCapacity", "documentation":"

The Snowball capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.

" }, "Notification":{ "shape":"Notification", "documentation":"

The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

" }, "DataTransferProgress":{ "shape":"DataTransfer", "documentation":"

A value that defines the real-time status of a Snowball's data transfer while the appliance is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

" }, "JobLogInfo":{ "shape":"JobLogs", "documentation":"

Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snowball for your job part is being delivered to you.

" }, "ClusterId":{ "shape":"String", "documentation":"

The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

" } }, "documentation":"

Contains information about a specific job including shipping information, job status, and other important metadata. This information is returned as a part of the response syntax of the DescribeJob action.

" }, "JobMetadataList":{ "type":"list", "member":{"shape":"JobMetadata"} }, "JobResource":{ "type":"structure", "members":{ "S3Resources":{ "shape":"S3ResourceList", "documentation":"

An array of S3Resource objects.

" }, "LambdaResources":{ "shape":"LambdaResourceList", "documentation":"

The Python-language Lambda functions for this job.

" } }, "documentation":"

Contains an array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.

" }, "JobState":{ "type":"string", "enum":[ "New", "PreparingAppliance", "PreparingShipment", "InTransitToCustomer", "WithCustomer", "InTransitToAWS", "WithAWS", "InProgress", "Complete", "Cancelled", "Listing", "Pending" ] }, "JobStateList":{ "type":"list", "member":{"shape":"JobState"} }, "JobType":{ "type":"string", "enum":[ "IMPORT", "EXPORT", "LOCAL_USE" ] }, "KMSRequestFailedException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

", "exception":true }, "KeyRange":{ "type":"structure", "members":{ "BeginMarker":{ "shape":"String", "documentation":"

The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

" }, "EndMarker":{ "shape":"String", "documentation":"

The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

" } }, "documentation":"

Contains a key range. For export jobs, a S3Resource object can have an optional KeyRange value. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.

" }, "KmsKeyARN":{ "type":"string", "max":255, "pattern":"arn:(aws|aws-us-gov):kms:.*:[0-9]{12}:key/.*" }, "LambdaResource":{ "type":"structure", "members":{ "LambdaArn":{ "shape":"ResourceARN", "documentation":"

An Amazon Resource Name (ARN) that represents an AWS Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.

" }, "EventTriggers":{ "shape":"EventTriggerDefinitionList", "documentation":"

The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.

" } }, "documentation":"

Identifies

" }, "LambdaResourceList":{ "type":"list", "member":{"shape":"LambdaResource"} }, "ListClusterJobsRequest":{ "type":"structure", "required":["ClusterId"], "members":{ "ClusterId":{ "shape":"ClusterId", "documentation":"

The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000.

" }, "MaxResults":{ "shape":"ListLimit", "documentation":"

The number of JobListEntry objects to return.

" }, "NextToken":{ "shape":"String", "documentation":"

HTTP requests are stateless. To identify what object comes \"next\" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

" } } }, "ListClusterJobsResult":{ "type":"structure", "members":{ "JobListEntries":{ "shape":"JobListEntryList", "documentation":"

Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs.

" }, "NextToken":{ "shape":"String", "documentation":"

HTTP requests are stateless. If you use the automatically generated NextToken value in your next ListClusterJobsResult call, your list of returned jobs will start from this point in the array.

" } } }, "ListClustersRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"ListLimit", "documentation":"

The number of ClusterListEntry objects to return.

" }, "NextToken":{ "shape":"String", "documentation":"

HTTP requests are stateless. To identify what object comes \"next\" in the list of ClusterListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

" } } }, "ListClustersResult":{ "type":"structure", "members":{ "ClusterListEntries":{ "shape":"ClusterListEntryList", "documentation":"

Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

" }, "NextToken":{ "shape":"String", "documentation":"

HTTP requests are stateless. If you use the automatically generated NextToken value in your next ClusterListEntry call, your list of returned clusters will start from this point in the array.

" } } }, "ListJobsRequest":{ "type":"structure", "members":{ "MaxResults":{ "shape":"ListLimit", "documentation":"

The number of JobListEntry objects to return.

" }, "NextToken":{ "shape":"String", "documentation":"

HTTP requests are stateless. To identify what object comes \"next\" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

" } } }, "ListJobsResult":{ "type":"structure", "members":{ "JobListEntries":{ "shape":"JobListEntryList", "documentation":"

Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs.

" }, "NextToken":{ "shape":"String", "documentation":"

HTTP requests are stateless. If you use this automatically generated NextToken value in your next ListJobs call, your returned JobListEntry objects will start from this point in the array.

" } } }, "ListLimit":{ "type":"integer", "max":100, "min":0 }, "Long":{"type":"long"}, "Notification":{ "type":"structure", "members":{ "SnsTopicARN":{ "shape":"SnsTopicARN", "documentation":"

The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.

You can subscribe email addresses to an Amazon SNS topic through the AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.

" }, "JobStatesToNotify":{ "shape":"JobStateList", "documentation":"

The list of job states that will trigger a notification for this job.

" }, "NotifyAll":{ "shape":"Boolean", "documentation":"

Any change in job state will trigger a notification for this job.

" } }, "documentation":"

The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

When the notification settings are defined during job creation, you can choose to notify based on a specific set of job states using the JobStatesToNotify array of strings, or you can specify that you want to have Amazon SNS notifications sent out for all job states with NotifyAll set to true.

" }, "ResourceARN":{ "type":"string", "max":255 }, "RoleARN":{ "type":"string", "max":255, "pattern":"arn:(aws|aws-us-gov):iam::[0-9]{12}:role/.*" }, "S3Resource":{ "type":"structure", "members":{ "BucketArn":{ "shape":"ResourceARN", "documentation":"

The Amazon Resource Name (ARN) of an Amazon S3 bucket.

" }, "KeyRange":{ "shape":"KeyRange", "documentation":"

For export jobs, you can provide an optional KeyRange within a specific Amazon S3 bucket. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.

" } }, "documentation":"

Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into. For export jobs, this object can have an optional KeyRange value. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.

" }, "S3ResourceList":{ "type":"list", "member":{"shape":"S3Resource"} }, "Shipment":{ "type":"structure", "members":{ "Status":{ "shape":"String", "documentation":"

Status information for a shipment. Valid statuses include NEW, IN_TRANSIT, and DELIVERED.

" }, "TrackingNumber":{ "shape":"String", "documentation":"

The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snowball as the carrier transports it.

For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.

" } }, "documentation":"

The Status and TrackingNumber information for an inbound or outbound shipment.

" }, "ShippingDetails":{ "type":"structure", "members":{ "ShippingOption":{ "shape":"ShippingOption", "documentation":"

The shipping speed for a particular job. This speed doesn't dictate how soon you'll get the Snowball from the job's creation date. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:

  • In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

  • In India, Snowballs are delivered in one to seven days.

  • In the United States of America (US), you have access to one-day shipping and two-day shipping.

" }, "InboundShipment":{ "shape":"Shipment", "documentation":"

The Status and TrackingNumber values for a Snowball being delivered to the address that you specified for a particular job.

" }, "OutboundShipment":{ "shape":"Shipment", "documentation":"

The Status and TrackingNumber values for a Snowball being returned to AWS for a particular job.

" } }, "documentation":"

A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

" }, "ShippingOption":{ "type":"string", "enum":[ "SECOND_DAY", "NEXT_DAY", "EXPRESS", "STANDARD" ] }, "SnowballCapacity":{ "type":"string", "enum":[ "T50", "T80", "T100", "NoPreference" ] }, "SnowballType":{ "type":"string", "enum":[ "STANDARD", "EDGE" ] }, "SnsTopicARN":{ "type":"string", "max":255, "pattern":"arn:(aws|aws-us-gov):sns:.*:[0-9]{12}:.*" }, "String":{ "type":"string", "max":255, "min":1 }, "Timestamp":{"type":"timestamp"}, "UnsupportedAddressException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"

The address is either outside the serviceable area for your region, or an error occurred. Check the address with your region's carrier and try again. If the issue persists, contact AWS Support.

", "exception":true }, "UpdateClusterRequest":{ "type":"structure", "required":["ClusterId"], "members":{ "ClusterId":{ "shape":"ClusterId", "documentation":"

The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the CreateRole API action in AWS Identity and Access Management (IAM).

" }, "Description":{ "shape":"String", "documentation":"

The updated description of this cluster.

" }, "Resources":{ "shape":"JobResource", "documentation":"

The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

" }, "AddressId":{ "shape":"AddressId", "documentation":"

The ID of the updated Address object.

" }, "ShippingOption":{ "shape":"ShippingOption", "documentation":"

The updated shipping option value of this cluster's ShippingDetails object.

" }, "Notification":{ "shape":"Notification", "documentation":"

The new or updated Notification object.

" } } }, "UpdateClusterResult":{ "type":"structure", "members":{ } }, "UpdateJobRequest":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{ "shape":"JobId", "documentation":"

The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRole AWS Identity and Access Management (IAM) API action.

" }, "Notification":{ "shape":"Notification", "documentation":"

The new or updated Notification object.

" }, "Resources":{ "shape":"JobResource", "documentation":"

The updated S3Resource object (for a single Amazon S3 bucket or key range), or the updated JobResource object (for multiple buckets or key ranges).

" }, "AddressId":{ "shape":"AddressId", "documentation":"

The ID of the updated Address object.

" }, "ShippingOption":{ "shape":"ShippingOption", "documentation":"

The updated shipping option value of this job's ShippingDetails object.

" }, "Description":{ "shape":"String", "documentation":"

The updated description of this job's JobMetadata object.

" }, "SnowballCapacityPreference":{ "shape":"SnowballCapacity", "documentation":"

The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions.

" } } }, "UpdateJobResult":{ "type":"structure", "members":{ } } }, "documentation":"

AWS Snowball is a petabyte-scale data transport solution that uses secure appliances to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snowball commands described here provide access to the same functionality that is available in the AWS Snowball Management Console, which enables you to create and manage jobs for Snowball. To transfer data locally with a Snowball appliance, you'll need to use the Snowball client or the Amazon S3 API adapter for Snowball. For more information, see the User Guide.

" } botocore-1.5.7/botocore/data/marketplacecommerceanalytics/0000777454262600001440000000000013042511307025046 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/marketplacecommerceanalytics/2015-07-01/0000777454262600001440000000000013042511307026077 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/marketplacecommerceanalytics/2015-07-01/service-2.json0000666454262600001440000003344613042511306030602 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-07-01", "endpointPrefix":"marketplacecommerceanalytics", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"AWS Marketplace Commerce Analytics", "signatureVersion":"v4", "signingName":"marketplacecommerceanalytics", "targetPrefix":"MarketplaceCommerceAnalytics20150701", "uid":"marketplacecommerceanalytics-2015-07-01" }, "operations":{ "GenerateDataSet":{ "name":"GenerateDataSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GenerateDataSetRequest"}, "output":{"shape":"GenerateDataSetResult"}, "errors":[ {"shape":"MarketplaceCommerceAnalyticsException"} ], "documentation":"Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy." }, "StartSupportDataExport":{ "name":"StartSupportDataExport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartSupportDataExportRequest"}, "output":{"shape":"StartSupportDataExportResult"}, "errors":[ {"shape":"MarketplaceCommerceAnalyticsException"} ], "documentation":"Given a data set type and a from date, asynchronously publishes the requested customer support data to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy." } }, "shapes":{ "CustomerDefinedValues":{ "type":"map", "key":{"shape":"OptionalKey"}, "value":{"shape":"OptionalValue"}, "max":5, "min":1 }, "DataSetPublicationDate":{"type":"timestamp"}, "DataSetRequestId":{"type":"string"}, "DataSetType":{ "type":"string", "enum":[ "customer_subscriber_hourly_monthly_subscriptions", "customer_subscriber_annual_subscriptions", "daily_business_usage_by_instance_type", "daily_business_fees", "daily_business_free_trial_conversions", "daily_business_new_instances", "daily_business_new_product_subscribers", "daily_business_canceled_product_subscribers", "monthly_revenue_billing_and_revenue_data", "monthly_revenue_annual_subscriptions", "disbursed_amount_by_product", "disbursed_amount_by_product_with_uncollected_funds", "disbursed_amount_by_instance_hours", "disbursed_amount_by_customer_geo", "disbursed_amount_by_age_of_uncollected_funds", "disbursed_amount_by_age_of_disbursed_funds", "customer_profile_by_industry", "customer_profile_by_revenue", "customer_profile_by_geography", "sales_compensation_billed_revenue" ], "max":255, "min":1 }, "DestinationS3BucketName":{ "type":"string", "min":1 }, "DestinationS3Prefix":{"type":"string"}, "ExceptionMessage":{"type":"string"}, "FromDate":{"type":"timestamp"}, "GenerateDataSetRequest":{ "type":"structure", "required":[ "dataSetType", "dataSetPublicationDate", "roleNameArn", "destinationS3BucketName", "snsTopicArn" ], "members":{ "dataSetType":{ "shape":"DataSetType", "documentation":"

The desired data set type.

  • customer_subscriber_hourly_monthly_subscriptions - Available daily by 5:00 PM Pacific Time since 2014-07-21.
  • customer_subscriber_annual_subscriptions - Available daily by 5:00 PM Pacific Time since 2014-07-21.
  • daily_business_usage_by_instance_type - Available daily by 5:00 PM Pacific Time since 2015-01-26.
  • daily_business_fees - Available daily by 5:00 PM Pacific Time since 2015-01-26.
  • daily_business_free_trial_conversions - Available daily by 5:00 PM Pacific Time since 2015-01-26.
  • daily_business_new_instances - Available daily by 5:00 PM Pacific Time since 2015-01-26.
  • daily_business_new_product_subscribers - Available daily by 5:00 PM Pacific Time since 2015-01-26.
  • daily_business_canceled_product_subscribers - Available daily by 5:00 PM Pacific Time since 2015-01-26.
  • monthly_revenue_billing_and_revenue_data - Available monthly on the 4th day of the month by 5:00 PM Pacific Time since 2015-02.
  • monthly_revenue_annual_subscriptions - Available monthly on the 4th day of the month by 5:00 PM Pacific Time since 2015-02.
  • disbursed_amount_by_product - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26.
  • disbursed_amount_by_product_with_uncollected_funds -This data set is only available from 2012-04-19 until 2015-01-25. After 2015-01-25, this data set was split into three data sets: disbursed_amount_by_product, disbursed_amount_by_age_of_uncollected_funds, and disbursed_amount_by_age_of_disbursed_funds.
  • disbursed_amount_by_instance_hours - Available every 30 days by 5:00 PM Pacific Time since 2012-09-04.
  • disbursed_amount_by_customer_geo - Available every 30 days by 5:00 PM Pacific Time since 2012-04-19.
  • disbursed_amount_by_age_of_uncollected_funds - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26.
  • disbursed_amount_by_age_of_disbursed_funds - Available every 30 days by 5:00 PM Pacific Time since 2015-01-26.
  • customer_profile_by_industry - Available daily by 5:00 PM Pacific Time since 2015-10-01.
  • customer_profile_by_revenue - Available daily by 5:00 PM Pacific Time since 2015-10-01.
  • customer_profile_by_geography - Available daily by 5:00 PM Pacific Time since 2015-10-01.
  • sales_compensation_billed_revenue - Available monthly on the 4th day of the month by 5:00 PM Pacific Time since 2016-12.

" }, "dataSetPublicationDate":{ "shape":"DataSetPublicationDate", "documentation":"The date a data set was published. For daily data sets, provide a date with day-level granularity for the desired day. For weekly data sets, provide a date with day-level granularity within the desired week (the day value will be ignored). For monthly data sets, provide a date with month-level granularity for the desired month (the day value will be ignored)." }, "roleNameArn":{ "shape":"RoleNameArn", "documentation":"The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services." }, "destinationS3BucketName":{ "shape":"DestinationS3BucketName", "documentation":"The name (friendly name, not ARN) of the destination S3 bucket." }, "destinationS3Prefix":{ "shape":"DestinationS3Prefix", "documentation":"(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name \"mybucket\" and the prefix \"myprefix/mydatasets\", the output file \"outputfile\" would be published to \"s3://mybucket/myprefix/mydatasets/outputfile\". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root." }, "snsTopicArn":{ "shape":"SnsTopicArn", "documentation":"Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred." }, "customerDefinedValues":{ "shape":"CustomerDefinedValues", "documentation":"(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file. These key-value pairs can be used to correlated responses with tracking information from other systems." } }, "documentation":"Container for the parameters to the GenerateDataSet operation." }, "GenerateDataSetResult":{ "type":"structure", "members":{ "dataSetRequestId":{ "shape":"DataSetRequestId", "documentation":"A unique identifier representing a specific request to the GenerateDataSet operation. This identifier can be used to correlate a request with notifications from the SNS topic." } }, "documentation":"Container for the result of the GenerateDataSet operation." }, "MarketplaceCommerceAnalyticsException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"This exception is thrown when an internal service error occurs.", "exception":true, "fault":true }, "OptionalKey":{ "type":"string", "max":255, "min":1 }, "OptionalValue":{ "type":"string", "max":255, "min":1 }, "RoleNameArn":{ "type":"string", "min":1 }, "SnsTopicArn":{ "type":"string", "min":1 }, "StartSupportDataExportRequest":{ "type":"structure", "required":[ "dataSetType", "fromDate", "roleNameArn", "destinationS3BucketName", "snsTopicArn" ], "members":{ "dataSetType":{ "shape":"SupportDataSetType", "documentation":"

Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.

  • customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
  • test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data

" }, "fromDate":{ "shape":"FromDate", "documentation":"The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type." }, "roleNameArn":{ "shape":"RoleNameArn", "documentation":"The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services." }, "destinationS3BucketName":{ "shape":"DestinationS3BucketName", "documentation":"The name (friendly name, not ARN) of the destination S3 bucket." }, "destinationS3Prefix":{ "shape":"DestinationS3Prefix", "documentation":"(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name \"mybucket\" and the prefix \"myprefix/mydatasets\", the output file \"outputfile\" would be published to \"s3://mybucket/myprefix/mydatasets/outputfile\". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root." }, "snsTopicArn":{ "shape":"SnsTopicArn", "documentation":"Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred." }, "customerDefinedValues":{ "shape":"CustomerDefinedValues", "documentation":"(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file." } }, "documentation":"Container for the parameters to the StartSupportDataExport operation." }, "StartSupportDataExportResult":{ "type":"structure", "members":{ "dataSetRequestId":{ "shape":"DataSetRequestId", "documentation":"A unique identifier representing a specific request to the StartSupportDataExport operation. This identifier can be used to correlate a request with notifications from the SNS topic." } }, "documentation":"Container for the result of the StartSupportDataExport operation." }, "SupportDataSetType":{ "type":"string", "enum":[ "customer_support_contacts_data", "test_customer_support_contacts_data" ], "max":255, "min":1 } }, "documentation":"Provides AWS Marketplace business intelligence data on-demand." } botocore-1.5.7/botocore/data/cognito-idp/0000777454262600001440000000000013042511307021347 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cognito-idp/2016-04-18/0000777454262600001440000000000013042511307022406 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cognito-idp/2016-04-18/service-2.json0000777454262600001440000054160213042511306025112 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-04-18", "endpointPrefix":"cognito-idp", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Amazon Cognito Identity Provider", "signatureVersion":"v4", "targetPrefix":"AWSCognitoIdentityProviderService", "uid":"cognito-idp-2016-04-18" }, "operations":{ "AddCustomAttributes":{ "name":"AddCustomAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddCustomAttributesRequest"}, "output":{"shape":"AddCustomAttributesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserImportInProgressException"}, {"shape":"InternalErrorException"} ], "documentation":"

Adds additional user attributes to the user pool schema.

" }, "AdminAddUserToGroup":{ "name":"AdminAddUserToGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminAddUserToGroupRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Adds the specified user to the specified group.

Requires developer credentials.

" }, "AdminConfirmSignUp":{ "name":"AdminConfirmSignUp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminConfirmSignUpRequest"}, "output":{"shape":"AdminConfirmSignUpResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"UnexpectedLambdaException"}, {"shape":"UserLambdaValidationException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyFailedAttemptsException"}, {"shape":"InvalidLambdaResponseException"}, {"shape":"TooManyRequestsException"}, {"shape":"LimitExceededException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Confirms user registration as an admin without using a confirmation code. Works on any user.

Requires developer credentials.

" }, "AdminCreateUser":{ "name":"AdminCreateUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminCreateUserRequest"}, "output":{"shape":"AdminCreateUserResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"UserNotFoundException"}, {"shape":"UsernameExistsException"}, {"shape":"InvalidPasswordException"}, {"shape":"CodeDeliveryFailureException"}, {"shape":"UnexpectedLambdaException"}, {"shape":"UserLambdaValidationException"}, {"shape":"InvalidLambdaResponseException"}, {"shape":"PreconditionNotMetException"}, {"shape":"InvalidSmsRoleAccessPolicyException"}, {"shape":"InvalidSmsRoleTrustRelationshipException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UnsupportedUserStateException"}, {"shape":"InternalErrorException"} ], "documentation":"

Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.

Requires developer credentials.

" }, "AdminDeleteUser":{ "name":"AdminDeleteUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminDeleteUserRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Deletes a user as an administrator. Works on any user.

Requires developer credentials.

" }, "AdminDeleteUserAttributes":{ "name":"AdminDeleteUserAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminDeleteUserAttributesRequest"}, "output":{"shape":"AdminDeleteUserAttributesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Deletes the user attributes in a user pool as an administrator. Works on any user.

Requires developer credentials.

" }, "AdminDisableUser":{ "name":"AdminDisableUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminDisableUserRequest"}, "output":{"shape":"AdminDisableUserResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Disables the specified user as an administrator. Works on any user.

Requires developer credentials.

" }, "AdminEnableUser":{ "name":"AdminEnableUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminEnableUserRequest"}, "output":{"shape":"AdminEnableUserResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Enables the specified user as an administrator. Works on any user.

Requires developer credentials.

" }, "AdminForgetDevice":{ "name":"AdminForgetDevice", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminForgetDeviceRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidUserPoolConfigurationException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Forgets the device, as an administrator.

Requires developer credentials.

" }, "AdminGetDevice":{ "name":"AdminGetDevice", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminGetDeviceRequest"}, "output":{"shape":"AdminGetDeviceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidUserPoolConfigurationException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"}, {"shape":"NotAuthorizedException"} ], "documentation":"

Gets the device, as an administrator.

Requires developer credentials.

" }, "AdminGetUser":{ "name":"AdminGetUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminGetUserRequest"}, "output":{"shape":"AdminGetUserResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Gets the specified user by user name in a user pool as an administrator. Works on any user.

Requires developer credentials.

" }, "AdminInitiateAuth":{ "name":"AdminInitiateAuth", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminInitiateAuthRequest"}, "output":{"shape":"AdminInitiateAuthResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"}, {"shape":"UnexpectedLambdaException"}, {"shape":"InvalidUserPoolConfigurationException"}, {"shape":"UserLambdaValidationException"}, {"shape":"InvalidLambdaResponseException"}, {"shape":"MFAMethodNotFoundException"}, {"shape":"InvalidSmsRoleAccessPolicyException"}, {"shape":"InvalidSmsRoleTrustRelationshipException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"} ], "documentation":"

Initiates the authentication flow, as an administrator.

Requires developer credentials.

" }, "AdminListDevices":{ "name":"AdminListDevices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminListDevicesRequest"}, "output":{"shape":"AdminListDevicesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidUserPoolConfigurationException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"}, {"shape":"NotAuthorizedException"} ], "documentation":"

Lists devices, as an administrator.

Requires developer credentials.

" }, "AdminListGroupsForUser":{ "name":"AdminListGroupsForUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminListGroupsForUserRequest"}, "output":{"shape":"AdminListGroupsForUserResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Lists the groups that the user belongs to.

Requires developer credentials.

" }, "AdminRemoveUserFromGroup":{ "name":"AdminRemoveUserFromGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminRemoveUserFromGroupRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Removes the specified user from the specified group.

Requires developer credentials.

" }, "AdminResetUserPassword":{ "name":"AdminResetUserPassword", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminResetUserPasswordRequest"}, "output":{"shape":"AdminResetUserPasswordResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"UnexpectedLambdaException"}, {"shape":"UserLambdaValidationException"}, {"shape":"NotAuthorizedException"}, {"shape":"InvalidLambdaResponseException"}, {"shape":"TooManyRequestsException"}, {"shape":"LimitExceededException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Resets the specified user's password in a user pool as an administrator. Works on any user.

When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.

Requires developer credentials.

" }, "AdminRespondToAuthChallenge":{ "name":"AdminRespondToAuthChallenge", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminRespondToAuthChallengeRequest"}, "output":{"shape":"AdminRespondToAuthChallengeResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"NotAuthorizedException"}, {"shape":"CodeMismatchException"}, {"shape":"ExpiredCodeException"}, {"shape":"UnexpectedLambdaException"}, {"shape":"InvalidPasswordException"}, {"shape":"UserLambdaValidationException"}, {"shape":"InvalidLambdaResponseException"}, {"shape":"TooManyRequestsException"}, {"shape":"InvalidUserPoolConfigurationException"}, {"shape":"InternalErrorException"}, {"shape":"MFAMethodNotFoundException"}, {"shape":"InvalidSmsRoleAccessPolicyException"}, {"shape":"InvalidSmsRoleTrustRelationshipException"}, {"shape":"AliasExistsException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"} ], "documentation":"

Responds to an authentication challenge, as an administrator.

Requires developer credentials.

" }, "AdminSetUserSettings":{ "name":"AdminSetUserSettings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminSetUserSettingsRequest"}, "output":{"shape":"AdminSetUserSettingsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Sets all the user settings for a specified user name. Works on any user.

Requires developer credentials.

" }, "AdminUpdateDeviceStatus":{ "name":"AdminUpdateDeviceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminUpdateDeviceStatusRequest"}, "output":{"shape":"AdminUpdateDeviceStatusResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidUserPoolConfigurationException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Updates the device status as an administrator.

Requires developer credentials.

" }, "AdminUpdateUserAttributes":{ "name":"AdminUpdateUserAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminUpdateUserAttributesRequest"}, "output":{"shape":"AdminUpdateUserAttributesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"UnexpectedLambdaException"}, {"shape":"UserLambdaValidationException"}, {"shape":"InvalidLambdaResponseException"}, {"shape":"AliasExistsException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.

Requires developer credentials.

" }, "AdminUserGlobalSignOut":{ "name":"AdminUserGlobalSignOut", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AdminUserGlobalSignOutRequest"}, "output":{"shape":"AdminUserGlobalSignOutResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Signs out users from all devices, as an administrator.

Requires developer credentials.

" }, "ChangePassword":{ "name":"ChangePassword", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ChangePasswordRequest"}, "output":{"shape":"ChangePasswordResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidPasswordException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"LimitExceededException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Changes the password for a specified user in a user pool.

", "authtype":"none" }, "ConfirmDevice":{ "name":"ConfirmDevice", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmDeviceRequest"}, "output":{"shape":"ConfirmDeviceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"NotAuthorizedException"}, {"shape":"InvalidPasswordException"}, {"shape":"InvalidLambdaResponseException"}, {"shape":"UsernameExistsException"}, {"shape":"InvalidUserPoolConfigurationException"}, {"shape":"TooManyRequestsException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Confirms tracking of the device. This API call is the call that beings device tracking.

" }, "ConfirmForgotPassword":{ "name":"ConfirmForgotPassword", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmForgotPasswordRequest"}, "output":{"shape":"ConfirmForgotPasswordResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"UnexpectedLambdaException"}, {"shape":"UserLambdaValidationException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidPasswordException"}, {"shape":"NotAuthorizedException"}, {"shape":"CodeMismatchException"}, {"shape":"ExpiredCodeException"}, {"shape":"TooManyFailedAttemptsException"}, {"shape":"InvalidLambdaResponseException"}, {"shape":"TooManyRequestsException"}, {"shape":"LimitExceededException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Allows a user to enter a code provided when they reset their password to update their password.

", "authtype":"none" }, "ConfirmSignUp":{ "name":"ConfirmSignUp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmSignUpRequest"}, "output":{"shape":"ConfirmSignUpResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"UnexpectedLambdaException"}, {"shape":"UserLambdaValidationException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyFailedAttemptsException"}, {"shape":"CodeMismatchException"}, {"shape":"ExpiredCodeException"}, {"shape":"InvalidLambdaResponseException"}, {"shape":"AliasExistsException"}, {"shape":"TooManyRequestsException"}, {"shape":"LimitExceededException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Confirms registration of a user and handles the existing alias from a previous user.

", "authtype":"none" }, "CreateGroup":{ "name":"CreateGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateGroupRequest"}, "output":{"shape":"CreateGroupResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"GroupExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"LimitExceededException"}, {"shape":"NotAuthorizedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Creates a new group in the specified user pool.

Requires developer credentials.

" }, "CreateUserImportJob":{ "name":"CreateUserImportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateUserImportJobRequest"}, "output":{"shape":"CreateUserImportJobResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"PreconditionNotMetException"}, {"shape":"NotAuthorizedException"}, {"shape":"LimitExceededException"}, {"shape":"InternalErrorException"} ], "documentation":"

Creates the user import job.

" }, "CreateUserPool":{ "name":"CreateUserPool", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateUserPoolRequest"}, "output":{"shape":"CreateUserPoolResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidSmsRoleAccessPolicyException"}, {"shape":"InvalidSmsRoleTrustRelationshipException"}, {"shape":"InvalidEmailRoleAccessPolicyException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserPoolTaggingException"}, {"shape":"InternalErrorException"} ], "documentation":"

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

" }, "CreateUserPoolClient":{ "name":"CreateUserPoolClient", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateUserPoolClientRequest"}, "output":{"shape":"CreateUserPoolClientResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"LimitExceededException"}, {"shape":"NotAuthorizedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Creates the user pool client.

" }, "DeleteGroup":{ "name":"DeleteGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteGroupRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Deletes a group. Currently only groups with no members can be deleted.

Requires developer credentials.

" }, "DeleteUser":{ "name":"DeleteUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteUserRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Allows a user to delete one's self.

", "authtype":"none" }, "DeleteUserAttributes":{ "name":"DeleteUserAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteUserAttributesRequest"}, "output":{"shape":"DeleteUserAttributesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Deletes the attributes for a user.

", "authtype":"none" }, "DeleteUserPool":{ "name":"DeleteUserPool", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteUserPoolRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserImportInProgressException"}, {"shape":"InternalErrorException"} ], "documentation":"

Deletes the specified Amazon Cognito user pool.

" }, "DeleteUserPoolClient":{ "name":"DeleteUserPoolClient", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteUserPoolClientRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Allows the developer to delete the user pool client.

" }, "DescribeUserImportJob":{ "name":"DescribeUserImportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeUserImportJobRequest"}, "output":{"shape":"DescribeUserImportJobResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Describes the user import job.

" }, "DescribeUserPool":{ "name":"DescribeUserPool", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeUserPoolRequest"}, "output":{"shape":"DescribeUserPoolResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserPoolTaggingException"}, {"shape":"InternalErrorException"} ], "documentation":"

Returns the configuration information and metadata of the specified user pool.

" }, "DescribeUserPoolClient":{ "name":"DescribeUserPoolClient", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeUserPoolClientRequest"}, "output":{"shape":"DescribeUserPoolClientResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Client method for returning the configuration information and metadata of the specified user pool client.

" }, "ForgetDevice":{ "name":"ForgetDevice", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ForgetDeviceRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"InvalidUserPoolConfigurationException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Forgets the specified device.

" }, "ForgotPassword":{ "name":"ForgotPassword", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ForgotPasswordRequest"}, "output":{"shape":"ForgotPasswordResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"UnexpectedLambdaException"}, {"shape":"UserLambdaValidationException"}, {"shape":"NotAuthorizedException"}, {"shape":"InvalidLambdaResponseException"}, {"shape":"TooManyRequestsException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidSmsRoleAccessPolicyException"}, {"shape":"InvalidSmsRoleTrustRelationshipException"}, {"shape":"InvalidEmailRoleAccessPolicyException"}, {"shape":"CodeDeliveryFailureException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Retrieves the password for the specified client ID or username.

", "authtype":"none" }, "GetCSVHeader":{ "name":"GetCSVHeader", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCSVHeaderRequest"}, "output":{"shape":"GetCSVHeaderResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Gets the header information for the .csv file to be used as input for the user import job.

" }, "GetDevice":{ "name":"GetDevice", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDeviceRequest"}, "output":{"shape":"GetDeviceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidUserPoolConfigurationException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Gets the device.

" }, "GetGroup":{ "name":"GetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetGroupRequest"}, "output":{"shape":"GetGroupResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Gets a group.

Requires developer credentials.

" }, "GetUser":{ "name":"GetUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetUserRequest"}, "output":{"shape":"GetUserResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Gets the user attributes and metadata for a user.

", "authtype":"none" }, "GetUserAttributeVerificationCode":{ "name":"GetUserAttributeVerificationCode", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetUserAttributeVerificationCodeRequest"}, "output":{"shape":"GetUserAttributeVerificationCodeResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UnexpectedLambdaException"}, {"shape":"UserLambdaValidationException"}, {"shape":"InvalidLambdaResponseException"}, {"shape":"InvalidSmsRoleAccessPolicyException"}, {"shape":"InvalidSmsRoleTrustRelationshipException"}, {"shape":"InvalidEmailRoleAccessPolicyException"}, {"shape":"CodeDeliveryFailureException"}, {"shape":"LimitExceededException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Gets the user attribute verification code for the specified attribute name.

", "authtype":"none" }, "GlobalSignOut":{ "name":"GlobalSignOut", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GlobalSignOutRequest"}, "output":{"shape":"GlobalSignOutResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Signs out users from all devices.

" }, "InitiateAuth":{ "name":"InitiateAuth", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"InitiateAuthRequest"}, "output":{"shape":"InitiateAuthResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"UnexpectedLambdaException"}, {"shape":"InvalidUserPoolConfigurationException"}, {"shape":"UserLambdaValidationException"}, {"shape":"InvalidLambdaResponseException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Initiates the authentication flow.

" }, "ListDevices":{ "name":"ListDevices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDevicesRequest"}, "output":{"shape":"ListDevicesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"InvalidUserPoolConfigurationException"}, {"shape":"TooManyRequestsException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Lists the devices.

" }, "ListGroups":{ "name":"ListGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListGroupsRequest"}, "output":{"shape":"ListGroupsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Lists the groups associated with a user pool.

Requires developer credentials.

" }, "ListUserImportJobs":{ "name":"ListUserImportJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListUserImportJobsRequest"}, "output":{"shape":"ListUserImportJobsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Lists the user import jobs.

" }, "ListUserPoolClients":{ "name":"ListUserPoolClients", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListUserPoolClientsRequest"}, "output":{"shape":"ListUserPoolClientsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Lists the clients that have been created for the specified user pool.

" }, "ListUserPools":{ "name":"ListUserPools", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListUserPoolsRequest"}, "output":{"shape":"ListUserPoolsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Lists the user pools associated with an AWS account.

" }, "ListUsers":{ "name":"ListUsers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListUsersRequest"}, "output":{"shape":"ListUsersResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Lists the users in the Amazon Cognito user pool.

" }, "ListUsersInGroup":{ "name":"ListUsersInGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListUsersInGroupRequest"}, "output":{"shape":"ListUsersInGroupResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Lists the users in the specified group.

Requires developer credentials.

" }, "ResendConfirmationCode":{ "name":"ResendConfirmationCode", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResendConfirmationCodeRequest"}, "output":{"shape":"ResendConfirmationCodeResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"UnexpectedLambdaException"}, {"shape":"UserLambdaValidationException"}, {"shape":"NotAuthorizedException"}, {"shape":"InvalidLambdaResponseException"}, {"shape":"TooManyRequestsException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidSmsRoleAccessPolicyException"}, {"shape":"InvalidSmsRoleTrustRelationshipException"}, {"shape":"InvalidEmailRoleAccessPolicyException"}, {"shape":"CodeDeliveryFailureException"}, {"shape":"UserNotFoundException"}, {"shape":"InternalErrorException"} ], "documentation":"

Resends the confirmation (for confirmation of registration) to a specific user in the user pool.

", "authtype":"none" }, "RespondToAuthChallenge":{ "name":"RespondToAuthChallenge", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RespondToAuthChallengeRequest"}, "output":{"shape":"RespondToAuthChallengeResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"NotAuthorizedException"}, {"shape":"CodeMismatchException"}, {"shape":"ExpiredCodeException"}, {"shape":"UnexpectedLambdaException"}, {"shape":"UserLambdaValidationException"}, {"shape":"InvalidPasswordException"}, {"shape":"InvalidLambdaResponseException"}, {"shape":"TooManyRequestsException"}, {"shape":"InvalidUserPoolConfigurationException"}, {"shape":"MFAMethodNotFoundException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InvalidSmsRoleAccessPolicyException"}, {"shape":"InvalidSmsRoleTrustRelationshipException"}, {"shape":"AliasExistsException"}, {"shape":"InternalErrorException"} ], "documentation":"

Responds to the authentication challenge.

" }, "SetUserSettings":{ "name":"SetUserSettings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetUserSettingsRequest"}, "output":{"shape":"SetUserSettingsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"NotAuthorizedException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Sets the user settings like multi-factor authentication (MFA). If MFA is to be removed for a particular attribute pass the attribute with code delivery as null. If null list is passed, all MFA options are removed.

", "authtype":"none" }, "SignUp":{ "name":"SignUp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SignUpRequest"}, "output":{"shape":"SignUpResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"UnexpectedLambdaException"}, {"shape":"UserLambdaValidationException"}, {"shape":"NotAuthorizedException"}, {"shape":"InvalidPasswordException"}, {"shape":"InvalidLambdaResponseException"}, {"shape":"UsernameExistsException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"}, {"shape":"InvalidSmsRoleAccessPolicyException"}, {"shape":"InvalidSmsRoleTrustRelationshipException"}, {"shape":"InvalidEmailRoleAccessPolicyException"}, {"shape":"CodeDeliveryFailureException"} ], "documentation":"

Registers the user in the specified user pool and creates a user name, password, and user attributes.

", "authtype":"none" }, "StartUserImportJob":{ "name":"StartUserImportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartUserImportJobRequest"}, "output":{"shape":"StartUserImportJobResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"}, {"shape":"PreconditionNotMetException"}, {"shape":"NotAuthorizedException"} ], "documentation":"

Starts the user import.

" }, "StopUserImportJob":{ "name":"StopUserImportJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopUserImportJobRequest"}, "output":{"shape":"StopUserImportJobResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"}, {"shape":"PreconditionNotMetException"}, {"shape":"NotAuthorizedException"} ], "documentation":"

Stops the user import job.

" }, "UpdateDeviceStatus":{ "name":"UpdateDeviceStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDeviceStatusRequest"}, "output":{"shape":"UpdateDeviceStatusResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"InvalidUserPoolConfigurationException"}, {"shape":"TooManyRequestsException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Updates the device status.

" }, "UpdateGroup":{ "name":"UpdateGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateGroupRequest"}, "output":{"shape":"UpdateGroupResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Updates the specified group with the specified attributes.

Requires developer credentials.

" }, "UpdateUserAttributes":{ "name":"UpdateUserAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateUserAttributesRequest"}, "output":{"shape":"UpdateUserAttributesResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"CodeMismatchException"}, {"shape":"ExpiredCodeException"}, {"shape":"NotAuthorizedException"}, {"shape":"UnexpectedLambdaException"}, {"shape":"UserLambdaValidationException"}, {"shape":"InvalidLambdaResponseException"}, {"shape":"TooManyRequestsException"}, {"shape":"AliasExistsException"}, {"shape":"InvalidSmsRoleAccessPolicyException"}, {"shape":"InvalidSmsRoleTrustRelationshipException"}, {"shape":"InvalidEmailRoleAccessPolicyException"}, {"shape":"CodeDeliveryFailureException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Allows a user to update a specific attribute (one at a time).

", "authtype":"none" }, "UpdateUserPool":{ "name":"UpdateUserPool", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateUserPoolRequest"}, "output":{"shape":"UpdateUserPoolResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"ConcurrentModificationException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"UserImportInProgressException"}, {"shape":"InternalErrorException"}, {"shape":"InvalidSmsRoleAccessPolicyException"}, {"shape":"InvalidSmsRoleTrustRelationshipException"}, {"shape":"UserPoolTaggingException"}, {"shape":"InvalidEmailRoleAccessPolicyException"} ], "documentation":"

Updates the specified user pool with the specified attributes.

" }, "UpdateUserPoolClient":{ "name":"UpdateUserPoolClient", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateUserPoolClientRequest"}, "output":{"shape":"UpdateUserPoolClientResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"NotAuthorizedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Allows the developer to update the specified user pool client and password policy.

" }, "VerifyUserAttribute":{ "name":"VerifyUserAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"VerifyUserAttributeRequest"}, "output":{"shape":"VerifyUserAttributeResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"CodeMismatchException"}, {"shape":"ExpiredCodeException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"LimitExceededException"}, {"shape":"PasswordResetRequiredException"}, {"shape":"UserNotFoundException"}, {"shape":"UserNotConfirmedException"}, {"shape":"InternalErrorException"} ], "documentation":"

Verifies the specified user attributes in the user pool.

", "authtype":"none" } }, "shapes":{ "AddCustomAttributesRequest":{ "type":"structure", "required":[ "UserPoolId", "CustomAttributes" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool where you want to add custom attributes.

" }, "CustomAttributes":{ "shape":"CustomAttributesListType", "documentation":"

An array of custom attributes, such as Mutable and Name.

" } }, "documentation":"

Represents the request to add custom attributes.

" }, "AddCustomAttributesResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the response from the server for the request to add custom attributes.

" }, "AdminAddUserToGroupRequest":{ "type":"structure", "required":[ "UserPoolId", "Username", "GroupName" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The username for the user.

" }, "GroupName":{ "shape":"GroupNameType", "documentation":"

The group name.

" } } }, "AdminConfirmSignUpRequest":{ "type":"structure", "required":[ "UserPoolId", "Username" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for which you want to confirm user registration.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name for which you want to confirm user registration.

" } }, "documentation":"

Represents the request to confirm user registration.

" }, "AdminConfirmSignUpResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the response from the server for the request to confirm registration.

" }, "AdminCreateUserConfigType":{ "type":"structure", "members":{ "AllowAdminCreateUserOnly":{ "shape":"BooleanType", "documentation":"

Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.

" }, "UnusedAccountValidityDays":{ "shape":"AdminCreateUserUnusedAccountValidityDaysType", "documentation":"

The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter. The default value for this paameter is 7.

" }, "InviteMessageTemplate":{ "shape":"MessageTemplateType", "documentation":"

The message template to be used for the welcome message to new users.

" } }, "documentation":"

The type of configuration for creating a new user profile.

" }, "AdminCreateUserRequest":{ "type":"structure", "required":[ "UserPoolId", "Username" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool where the user will be created.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.

" }, "UserAttributes":{ "shape":"AttributeListType", "documentation":"

An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).

To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.

In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)

  • email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.

  • phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.

" }, "ValidationData":{ "shape":"AttributeListType", "documentation":"

The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.

To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.

The user's validation data is not persisted.

" }, "TemporaryPassword":{ "shape":"PasswordType", "documentation":"

The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.

The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.

This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.

The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.

" }, "ForceAliasCreation":{ "shape":"ForceAliasCreation", "documentation":"

This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.

If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.

If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.

" }, "MessageAction":{ "shape":"MessageActionType", "documentation":"

Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.

" }, "DesiredDeliveryMediums":{ "shape":"DeliveryMediumListType", "documentation":"

Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.

" } }, "documentation":"

Represents the request to create a user in the specified user pool.

" }, "AdminCreateUserResponse":{ "type":"structure", "members":{ "User":{ "shape":"UserType", "documentation":"

The user returned in the request to create a new user.

" } }, "documentation":"

Represents the response from the server to the request to create the user.

" }, "AdminCreateUserUnusedAccountValidityDaysType":{ "type":"integer", "max":90, "min":0 }, "AdminDeleteUserAttributesRequest":{ "type":"structure", "required":[ "UserPoolId", "Username", "UserAttributeNames" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool where you want to delete user attributes.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user from which you would like to delete attributes.

" }, "UserAttributeNames":{ "shape":"AttributeNameListType", "documentation":"

An array of strings representing the user attribute names you wish to delete.

" } }, "documentation":"

Represents the request to delete user attributes as an administrator.

" }, "AdminDeleteUserAttributesResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the response received from the server for a request to delete user attributes.

" }, "AdminDeleteUserRequest":{ "type":"structure", "required":[ "UserPoolId", "Username" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool where you want to delete the user.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user you wish to delete.

" } }, "documentation":"

Represents the request to delete a user as an administrator.

" }, "AdminDisableUserRequest":{ "type":"structure", "required":[ "UserPoolId", "Username" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool where you want to disable the user.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user you wish to disable.

" } }, "documentation":"

Represents the request to disable any user as an administrator.

" }, "AdminDisableUserResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the response received from the server to disable the user as an administrator.

" }, "AdminEnableUserRequest":{ "type":"structure", "required":[ "UserPoolId", "Username" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool where you want to enable the user.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user you wish to ebable.

" } }, "documentation":"

Represents the request that enables the user as an administrator.

" }, "AdminEnableUserResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the response from the server for the request to enable a user as an administrator.

" }, "AdminForgetDeviceRequest":{ "type":"structure", "required":[ "UserPoolId", "Username", "DeviceKey" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name.

" }, "DeviceKey":{ "shape":"DeviceKeyType", "documentation":"

The device key.

" } }, "documentation":"

Sends the forgot device request, as an administrator.

" }, "AdminGetDeviceRequest":{ "type":"structure", "required":[ "DeviceKey", "UserPoolId", "Username" ], "members":{ "DeviceKey":{ "shape":"DeviceKeyType", "documentation":"

The device key.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name.

" } }, "documentation":"

Represents the request to get the device, as an administrator.

" }, "AdminGetDeviceResponse":{ "type":"structure", "required":["Device"], "members":{ "Device":{ "shape":"DeviceType", "documentation":"

The device.

" } }, "documentation":"

Gets the device response, as an administrator.

" }, "AdminGetUserRequest":{ "type":"structure", "required":[ "UserPoolId", "Username" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool where you want to get information about the user.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user you wish to retrieve.

" } }, "documentation":"

Represents the request to get the specified user as an administrator.

" }, "AdminGetUserResponse":{ "type":"structure", "required":["Username"], "members":{ "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user about whom you are receiving information.

" }, "UserAttributes":{ "shape":"AttributeListType", "documentation":"

An array of name-value pairs representing user attributes.

" }, "UserCreateDate":{ "shape":"DateType", "documentation":"

The date the user was created.

" }, "UserLastModifiedDate":{ "shape":"DateType", "documentation":"

The date the user was last modified.

" }, "Enabled":{ "shape":"BooleanType", "documentation":"

Indicates that the status is enabled.

" }, "UserStatus":{ "shape":"UserStatusType", "documentation":"

The user status. Can be one of the following:

  • UNCONFIRMED - User has been created but not confirmed.

  • CONFIRMED - User has been confirmed.

  • ARCHIVED - User is no longer active.

  • COMPROMISED - User is disabled due to a potential security threat.

  • UNKNOWN - User status is not known.

" }, "MFAOptions":{ "shape":"MFAOptionListType", "documentation":"

Specifies the options for MFA (e.g., email or phone number).

" } }, "documentation":"

Represents the response from the server from the request to get the specified user as an administrator.

" }, "AdminInitiateAuthRequest":{ "type":"structure", "required":[ "UserPoolId", "ClientId", "AuthFlow" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The ID of the Amazon Cognito user pool.

" }, "ClientId":{ "shape":"ClientIdType", "documentation":"

The client app ID.

" }, "AuthFlow":{ "shape":"AuthFlowType", "documentation":"

The authentication flow.

" }, "AuthParameters":{ "shape":"AuthParametersType", "documentation":"

The authentication parameters.

" }, "ClientMetadata":{ "shape":"ClientMetadataType", "documentation":"

The client app metadata.

" } }, "documentation":"

Initiates the authorization request, as an administrator.

" }, "AdminInitiateAuthResponse":{ "type":"structure", "members":{ "ChallengeName":{ "shape":"ChallengeNameType", "documentation":"

The name of the challenge.

" }, "Session":{ "shape":"SessionType", "documentation":"

The session.

" }, "ChallengeParameters":{ "shape":"ChallengeParametersType", "documentation":"

The challenge parameters.

" }, "AuthenticationResult":{ "shape":"AuthenticationResultType", "documentation":"

The result of the authentication response.

" } }, "documentation":"

Initiates the authentication response, as an administrator.

" }, "AdminListDevicesRequest":{ "type":"structure", "required":[ "UserPoolId", "Username" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name.

" }, "Limit":{ "shape":"QueryLimitType", "documentation":"

The limit of the devices request.

" }, "PaginationToken":{ "shape":"SearchPaginationTokenType", "documentation":"

The pagination token.

" } }, "documentation":"

Represents the request to list devices, as an administrator.

" }, "AdminListDevicesResponse":{ "type":"structure", "members":{ "Devices":{ "shape":"DeviceListType", "documentation":"

The devices in the list of devices response.

" }, "PaginationToken":{ "shape":"SearchPaginationTokenType", "documentation":"

The pagination token.

" } }, "documentation":"

Lists the device's response, as an administrator.

" }, "AdminListGroupsForUserRequest":{ "type":"structure", "required":[ "Username", "UserPoolId" ], "members":{ "Username":{ "shape":"UsernameType", "documentation":"

The username for the user.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "Limit":{ "shape":"QueryLimitType", "documentation":"

The limit of the request to list groups.

" }, "NextToken":{ "shape":"PaginationKey", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } } }, "AdminListGroupsForUserResponse":{ "type":"structure", "members":{ "Groups":{ "shape":"GroupListType", "documentation":"

The groups that the user belongs to.

" }, "NextToken":{ "shape":"PaginationKey", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } } }, "AdminRemoveUserFromGroupRequest":{ "type":"structure", "required":[ "UserPoolId", "Username", "GroupName" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The username for the user.

" }, "GroupName":{ "shape":"GroupNameType", "documentation":"

The group name.

" } } }, "AdminResetUserPasswordRequest":{ "type":"structure", "required":[ "UserPoolId", "Username" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool where you want to reset the user's password.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user whose password you wish to reset.

" } }, "documentation":"

Represents the request to reset a user's password as an administrator.

" }, "AdminResetUserPasswordResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the response from the server to reset a user password as an administrator.

" }, "AdminRespondToAuthChallengeRequest":{ "type":"structure", "required":[ "UserPoolId", "ClientId", "ChallengeName" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The ID of the Amazon Cognito user pool.

" }, "ClientId":{ "shape":"ClientIdType", "documentation":"

The client ID.

" }, "ChallengeName":{ "shape":"ChallengeNameType", "documentation":"

The name of the challenge.

" }, "ChallengeResponses":{ "shape":"ChallengeResponsesType", "documentation":"

The challenge response.

" }, "Session":{ "shape":"SessionType", "documentation":"

The session.

" } }, "documentation":"

The request to respond to the authentication challenge, as an administrator.

" }, "AdminRespondToAuthChallengeResponse":{ "type":"structure", "members":{ "ChallengeName":{ "shape":"ChallengeNameType", "documentation":"

The name of the challenge.

" }, "Session":{ "shape":"SessionType", "documentation":"

The session.

" }, "ChallengeParameters":{ "shape":"ChallengeParametersType", "documentation":"

The challenge parameters.

" }, "AuthenticationResult":{ "shape":"AuthenticationResultType", "documentation":"

The result returned by the server in response to the authentication request.

" } }, "documentation":"

Responds to the authentication challenge, as an administrator.

" }, "AdminSetUserSettingsRequest":{ "type":"structure", "required":[ "UserPoolId", "Username", "MFAOptions" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool where you want to set the user's settings, such as MFA options.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user for whom you wish to set user settings.

" }, "MFAOptions":{ "shape":"MFAOptionListType", "documentation":"

Specifies the options for MFA (e.g., email or phone number).

" } }, "documentation":"

Represents the request to set user settings as an administrator.

" }, "AdminSetUserSettingsResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the response from the server to set user settings as an administrator.

" }, "AdminUpdateDeviceStatusRequest":{ "type":"structure", "required":[ "UserPoolId", "Username", "DeviceKey" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID>

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name.

" }, "DeviceKey":{ "shape":"DeviceKeyType", "documentation":"

The device key.

" }, "DeviceRememberedStatus":{ "shape":"DeviceRememberedStatusType", "documentation":"

The status indicating whether a device has been remembered or not.

" } }, "documentation":"

The request to update the device status, as an administrator.

" }, "AdminUpdateDeviceStatusResponse":{ "type":"structure", "members":{ }, "documentation":"

The status response from the request to update the device, as an administrator.

" }, "AdminUpdateUserAttributesRequest":{ "type":"structure", "required":[ "UserPoolId", "Username", "UserAttributes" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool where you want to update user attributes.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user for whom you want to update user attributes.

" }, "UserAttributes":{ "shape":"AttributeListType", "documentation":"

An array of name-value pairs representing user attributes.

" } }, "documentation":"

Represents the request to update the user's attributes as an administrator.

" }, "AdminUpdateUserAttributesResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the response from the server for the request to update user attributes as an administrator.

" }, "AdminUserGlobalSignOutRequest":{ "type":"structure", "required":[ "UserPoolId", "Username" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name.

" } }, "documentation":"

The request to sign out of all devices, as an administrator.

" }, "AdminUserGlobalSignOutResponse":{ "type":"structure", "members":{ }, "documentation":"

The global sign-out response, as an administrator.

" }, "AliasAttributeType":{ "type":"string", "enum":[ "phone_number", "email", "preferred_username" ] }, "AliasAttributesListType":{ "type":"list", "member":{"shape":"AliasAttributeType"} }, "AliasExistsException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message sent to the user when an alias exists.

" } }, "documentation":"

This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.

", "exception":true }, "ArnType":{ "type":"string", "max":2048, "min":20, "pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?" }, "AttributeDataType":{ "type":"string", "enum":[ "String", "Number", "DateTime", "Boolean" ] }, "AttributeListType":{ "type":"list", "member":{"shape":"AttributeType"} }, "AttributeNameListType":{ "type":"list", "member":{"shape":"AttributeNameType"} }, "AttributeNameType":{ "type":"string", "max":32, "min":1, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" }, "AttributeType":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"AttributeNameType", "documentation":"

The name of the attribute.

" }, "Value":{ "shape":"AttributeValueType", "documentation":"

The value of the attribute.

" } }, "documentation":"

Specifies whether the attribute is standard or custom.

" }, "AttributeValueType":{ "type":"string", "max":2048, "sensitive":true }, "AuthFlowType":{ "type":"string", "enum":[ "USER_SRP_AUTH", "REFRESH_TOKEN_AUTH", "REFRESH_TOKEN", "CUSTOM_AUTH", "ADMIN_NO_SRP_AUTH" ] }, "AuthParametersType":{ "type":"map", "key":{"shape":"StringType"}, "value":{"shape":"StringType"} }, "AuthenticationResultType":{ "type":"structure", "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

The access token of the authentication result.

" }, "ExpiresIn":{ "shape":"IntegerType", "documentation":"

The expiration period of the authentication result.

" }, "TokenType":{ "shape":"StringType", "documentation":"

The token type of the authentication result.

" }, "RefreshToken":{ "shape":"TokenModelType", "documentation":"

The refresh token of the authentication result.

" }, "IdToken":{ "shape":"TokenModelType", "documentation":"

The ID token of the authentication result.

" }, "NewDeviceMetadata":{ "shape":"NewDeviceMetadataType", "documentation":"

The new device metadata from an authentication result.

" } }, "documentation":"

The result type of the authentication result.

" }, "BooleanType":{"type":"boolean"}, "ChallengeNameType":{ "type":"string", "enum":[ "SMS_MFA", "PASSWORD_VERIFIER", "CUSTOM_CHALLENGE", "DEVICE_SRP_AUTH", "DEVICE_PASSWORD_VERIFIER", "ADMIN_NO_SRP_AUTH", "NEW_PASSWORD_REQUIRED" ] }, "ChallengeParametersType":{ "type":"map", "key":{"shape":"StringType"}, "value":{"shape":"StringType"} }, "ChallengeResponsesType":{ "type":"map", "key":{"shape":"StringType"}, "value":{"shape":"StringType"} }, "ChangePasswordRequest":{ "type":"structure", "required":[ "PreviousPassword", "ProposedPassword" ], "members":{ "PreviousPassword":{ "shape":"PasswordType", "documentation":"

The old password in the change password request.

" }, "ProposedPassword":{ "shape":"PasswordType", "documentation":"

The new password in the change password request.

" }, "AccessToken":{ "shape":"TokenModelType", "documentation":"

The access token in the change password request.

" } }, "documentation":"

Represents the request to change a user password.

" }, "ChangePasswordResponse":{ "type":"structure", "members":{ }, "documentation":"

The response from the server to the change password request.

" }, "ClientIdType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w+]+", "sensitive":true }, "ClientMetadataType":{ "type":"map", "key":{"shape":"StringType"}, "value":{"shape":"StringType"} }, "ClientNameType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w\\s+=,.@-]+" }, "ClientPermissionListType":{ "type":"list", "member":{"shape":"ClientPermissionType"} }, "ClientPermissionType":{ "type":"string", "max":2048, "min":1 }, "ClientSecretType":{ "type":"string", "max":64, "min":1, "pattern":"[\\w+]+", "sensitive":true }, "CodeDeliveryDetailsListType":{ "type":"list", "member":{"shape":"CodeDeliveryDetailsType"} }, "CodeDeliveryDetailsType":{ "type":"structure", "members":{ "Destination":{ "shape":"StringType", "documentation":"

The destination for the code delivery details.

" }, "DeliveryMedium":{ "shape":"DeliveryMediumType", "documentation":"

The delivery medium (email message or phone number).

" }, "AttributeName":{ "shape":"AttributeNameType", "documentation":"

The name of the attribute in the code delivery details type.

" } }, "documentation":"

The type of code delivery details being returned from the server.

" }, "CodeDeliveryFailureException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message sent when a verification code fails to deliver successfully.

" } }, "documentation":"

This exception is thrown when a verification code fails to deliver successfully.

", "exception":true }, "CodeMismatchException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message provided when the code mismatch exception is thrown.

" } }, "documentation":"

This exception is thrown if the provided code does not match what the server was expecting.

", "exception":true }, "CompletionMessageType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w]+" }, "ConcurrentModificationException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message provided when the concurrent exception is thrown.

" } }, "documentation":"

This exception is thrown if two or more modifications are happening concurrently.

", "exception":true }, "ConfirmDeviceRequest":{ "type":"structure", "required":[ "AccessToken", "DeviceKey" ], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

The access token.

" }, "DeviceKey":{ "shape":"DeviceKeyType", "documentation":"

The device key.

" }, "DeviceSecretVerifierConfig":{ "shape":"DeviceSecretVerifierConfigType", "documentation":"

The configuration of the device secret verifier.

" }, "DeviceName":{ "shape":"DeviceNameType", "documentation":"

The device name.

" } }, "documentation":"

Confirms the device request.

" }, "ConfirmDeviceResponse":{ "type":"structure", "members":{ "UserConfirmationNecessary":{ "shape":"BooleanType", "documentation":"

Indicates whether the user confirmation is necessary to confirm the device response.

" } }, "documentation":"

Confirms the device response.

" }, "ConfirmForgotPasswordRequest":{ "type":"structure", "required":[ "ClientId", "Username", "ConfirmationCode", "Password" ], "members":{ "ClientId":{ "shape":"ClientIdType", "documentation":"

The ID of the client associated with the user pool.

" }, "SecretHash":{ "shape":"SecretHashType", "documentation":"

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user for whom you want to enter a code to retrieve a forgotten password.

" }, "ConfirmationCode":{ "shape":"ConfirmationCodeType", "documentation":"

The confirmation code sent by a user's request to retrieve a forgotten password.

" }, "Password":{ "shape":"PasswordType", "documentation":"

The password sent by sent by a user's request to retrieve a forgotten password.

" } }, "documentation":"

The request representing the confirmation for a password reset.

" }, "ConfirmForgotPasswordResponse":{ "type":"structure", "members":{ }, "documentation":"

The response from the server that results from a user's request to retrieve a forgotten password.

" }, "ConfirmSignUpRequest":{ "type":"structure", "required":[ "ClientId", "Username", "ConfirmationCode" ], "members":{ "ClientId":{ "shape":"ClientIdType", "documentation":"

The ID of the client associated with the user pool.

" }, "SecretHash":{ "shape":"SecretHashType", "documentation":"

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user whose registration you wish to confirm.

" }, "ConfirmationCode":{ "shape":"ConfirmationCodeType", "documentation":"

The confirmation code sent by a user's request to confirm registration.

" }, "ForceAliasCreation":{ "shape":"ForceAliasCreation", "documentation":"

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

" } }, "documentation":"

Represents the request to confirm registration of a user.

" }, "ConfirmSignUpResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the response from the server for the registration confirmation.

" }, "ConfirmationCodeType":{ "type":"string", "max":2048, "min":1, "pattern":"[\\S]+" }, "CreateGroupRequest":{ "type":"structure", "required":[ "GroupName", "UserPoolId" ], "members":{ "GroupName":{ "shape":"GroupNameType", "documentation":"

The name of the group. Must be unique.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "Description":{ "shape":"DescriptionType", "documentation":"

A string containing the description of the group.

" }, "RoleArn":{ "shape":"ArnType", "documentation":"

The role ARN for the group.

" }, "Precedence":{ "shape":"PrecedenceType", "documentation":"

A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens.

The default Precedence value is null.

" } } }, "CreateGroupResponse":{ "type":"structure", "members":{ "Group":{ "shape":"GroupType", "documentation":"

The group object for the group.

" } } }, "CreateUserImportJobRequest":{ "type":"structure", "required":[ "JobName", "UserPoolId", "CloudWatchLogsRoleArn" ], "members":{ "JobName":{ "shape":"UserImportJobNameType", "documentation":"

The job name for the user import job.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that the users are being imported into.

" }, "CloudWatchLogsRoleArn":{ "shape":"ArnType", "documentation":"

The role ARN for the Amazon CloudWatch Logging role for the user import job.

" } }, "documentation":"

Represents the request to create the user import job.

" }, "CreateUserImportJobResponse":{ "type":"structure", "members":{ "UserImportJob":{ "shape":"UserImportJobType", "documentation":"

The job object that represents the user import job.

" } }, "documentation":"

Represents the response from the server to the request to create the user import job.

" }, "CreateUserPoolClientRequest":{ "type":"structure", "required":[ "UserPoolId", "ClientName" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool where you want to create a user pool client.

" }, "ClientName":{ "shape":"ClientNameType", "documentation":"

The client name for the user pool client you would like to create.

" }, "GenerateSecret":{ "shape":"GenerateSecret", "documentation":"

Boolean to specify whether you want to generate a secret for the user pool client being created.

" }, "RefreshTokenValidity":{ "shape":"RefreshTokenValidityType", "documentation":"

The validity of the refresh token, in days.

" }, "ReadAttributes":{ "shape":"ClientPermissionListType", "documentation":"

The read attributes.

" }, "WriteAttributes":{ "shape":"ClientPermissionListType", "documentation":"

The write attributes.

" }, "ExplicitAuthFlows":{ "shape":"ExplicitAuthFlowsListType", "documentation":"

The explicit authentication flows.

" } }, "documentation":"

Represents the request to create a user pool client.

" }, "CreateUserPoolClientResponse":{ "type":"structure", "members":{ "UserPoolClient":{ "shape":"UserPoolClientType", "documentation":"

The user pool client that was just created.

" } }, "documentation":"

Represents the response from the server to create a user pool client.

" }, "CreateUserPoolRequest":{ "type":"structure", "required":["PoolName"], "members":{ "PoolName":{ "shape":"UserPoolNameType", "documentation":"

A string used to name the user pool.

" }, "Policies":{ "shape":"UserPoolPolicyType", "documentation":"

The policies associated with the new user pool.

" }, "LambdaConfig":{ "shape":"LambdaConfigType", "documentation":"

The Lambda trigger configuration information for the new user pool.

" }, "AutoVerifiedAttributes":{ "shape":"VerifiedAttributesListType", "documentation":"

The attributes to be auto-verified. Possible values: email, phone_number.

" }, "AliasAttributes":{ "shape":"AliasAttributesListType", "documentation":"

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

" }, "SmsVerificationMessage":{ "shape":"SmsVerificationMessageType", "documentation":"

A string representing the SMS verification message.

" }, "EmailVerificationMessage":{ "shape":"EmailVerificationMessageType", "documentation":"

A string representing the email verification message.

" }, "EmailVerificationSubject":{ "shape":"EmailVerificationSubjectType", "documentation":"

A string representing the email verification subject.

" }, "SmsAuthenticationMessage":{ "shape":"SmsVerificationMessageType", "documentation":"

A string representing the SMS authentication message.

" }, "MfaConfiguration":{ "shape":"UserPoolMfaType", "documentation":"

Specifies MFA configuration details.

" }, "DeviceConfiguration":{ "shape":"DeviceConfigurationType", "documentation":"

The device configuration.

" }, "EmailConfiguration":{ "shape":"EmailConfigurationType", "documentation":"

The email configuration.

" }, "SmsConfiguration":{ "shape":"SmsConfigurationType", "documentation":"

The SMS configuration.

" }, "UserPoolTags":{ "shape":"UserPoolTagsType", "documentation":"

The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool

" }, "AdminCreateUserConfig":{ "shape":"AdminCreateUserConfigType", "documentation":"

The configuration for AdminCreateUser requests.

" }, "Schema":{ "shape":"SchemaAttributesListType", "documentation":"

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

" } }, "documentation":"

Represents the request to create a user pool.

" }, "CreateUserPoolResponse":{ "type":"structure", "members":{ "UserPool":{ "shape":"UserPoolType", "documentation":"

A container for the user pool details.

" } }, "documentation":"

Represents the response from the server for the request to create a user pool.

" }, "CustomAttributeNameType":{ "type":"string", "max":20, "min":1, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" }, "CustomAttributesListType":{ "type":"list", "member":{"shape":"SchemaAttributeType"}, "max":25, "min":1 }, "DateType":{"type":"timestamp"}, "DeleteGroupRequest":{ "type":"structure", "required":[ "GroupName", "UserPoolId" ], "members":{ "GroupName":{ "shape":"GroupNameType", "documentation":"

The name of the group.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" } } }, "DeleteUserAttributesRequest":{ "type":"structure", "required":["UserAttributeNames"], "members":{ "UserAttributeNames":{ "shape":"AttributeNameListType", "documentation":"

An array of strings representing the user attribute names you wish to delete.

" }, "AccessToken":{ "shape":"TokenModelType", "documentation":"

The access token used in the request to delete user attributes.

" } }, "documentation":"

Represents the request to delete user attributes.

" }, "DeleteUserAttributesResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the response from the server to delete user attributes.

" }, "DeleteUserPoolClientRequest":{ "type":"structure", "required":[ "UserPoolId", "ClientId" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool where you want to delete the client.

" }, "ClientId":{ "shape":"ClientIdType", "documentation":"

The ID of the client associated with the user pool.

" } }, "documentation":"

Represents the request to delete a user pool client.

" }, "DeleteUserPoolRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool you want to delete.

" } }, "documentation":"

Represents the request to delete a user pool.

" }, "DeleteUserRequest":{ "type":"structure", "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

The access token from a request to delete a user.

" } }, "documentation":"

Represents the request to delete a user.

" }, "DeliveryMediumListType":{ "type":"list", "member":{"shape":"DeliveryMediumType"} }, "DeliveryMediumType":{ "type":"string", "enum":[ "SMS", "EMAIL" ] }, "DescribeUserImportJobRequest":{ "type":"structure", "required":[ "UserPoolId", "JobId" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that the users are being imported into.

" }, "JobId":{ "shape":"UserImportJobIdType", "documentation":"

The job ID for the user import job.

" } }, "documentation":"

Represents the request to describe the user import job.

" }, "DescribeUserImportJobResponse":{ "type":"structure", "members":{ "UserImportJob":{ "shape":"UserImportJobType", "documentation":"

The job object that represents the user import job.

" } }, "documentation":"

Represents the response from the server to the request to describe the user import job.

" }, "DescribeUserPoolClientRequest":{ "type":"structure", "required":[ "UserPoolId", "ClientId" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool you want to describe.

" }, "ClientId":{ "shape":"ClientIdType", "documentation":"

The ID of the client associated with the user pool.

" } }, "documentation":"

Represents the request to describe a user pool client.

" }, "DescribeUserPoolClientResponse":{ "type":"structure", "members":{ "UserPoolClient":{ "shape":"UserPoolClientType", "documentation":"

The user pool client from a server response to describe the user pool client.

" } }, "documentation":"

Represents the response from the server from a request to describe the user pool client.

" }, "DescribeUserPoolRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool you want to describe.

" } }, "documentation":"

Represents the request to describe the user pool.

" }, "DescribeUserPoolResponse":{ "type":"structure", "members":{ "UserPool":{ "shape":"UserPoolType", "documentation":"

The container of metadata returned by the server to describe the pool.

" } }, "documentation":"

Represents the response to describe the user pool.

" }, "DescriptionType":{ "type":"string", "max":2048 }, "DeviceConfigurationType":{ "type":"structure", "members":{ "ChallengeRequiredOnNewDevice":{ "shape":"BooleanType", "documentation":"

Indicates whether a challenge is required on a new device. Only applicable to a new device.

" }, "DeviceOnlyRememberedOnUserPrompt":{ "shape":"BooleanType", "documentation":"

If true, a device is only remembered on user prompt.

" } }, "documentation":"

The type of configuration for the user pool's device tracking.

" }, "DeviceKeyType":{ "type":"string", "max":55, "min":1, "pattern":"[\\w-]+_[0-9a-f-]+" }, "DeviceListType":{ "type":"list", "member":{"shape":"DeviceType"} }, "DeviceNameType":{ "type":"string", "max":1024, "min":1 }, "DeviceRememberedStatusType":{ "type":"string", "enum":[ "remembered", "not_remembered" ] }, "DeviceSecretVerifierConfigType":{ "type":"structure", "members":{ "PasswordVerifier":{ "shape":"StringType", "documentation":"

The password verifier.

" }, "Salt":{ "shape":"StringType", "documentation":"

The salt.

" } }, "documentation":"

The device verifier against which it will be authenticated.

" }, "DeviceType":{ "type":"structure", "members":{ "DeviceKey":{ "shape":"DeviceKeyType", "documentation":"

The device key.

" }, "DeviceAttributes":{ "shape":"AttributeListType", "documentation":"

The device attributes.

" }, "DeviceCreateDate":{ "shape":"DateType", "documentation":"

The creation date of the device.

" }, "DeviceLastModifiedDate":{ "shape":"DateType", "documentation":"

The last modified date of the device.

" }, "DeviceLastAuthenticatedDate":{ "shape":"DateType", "documentation":"

The date in which the device was last authenticated.

" } }, "documentation":"

The device type.

" }, "EmailAddressType":{ "type":"string", "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+@[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" }, "EmailConfigurationType":{ "type":"structure", "members":{ "SourceArn":{ "shape":"ArnType", "documentation":"

The Amazon Resource Name (ARN) of the email source.

" }, "ReplyToEmailAddress":{ "shape":"EmailAddressType", "documentation":"

The REPLY-TO email address.

" } }, "documentation":"

The email configuration type.

" }, "EmailVerificationMessageType":{ "type":"string", "max":2048, "min":6, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*" }, "EmailVerificationSubjectType":{ "type":"string", "max":140, "min":1, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+" }, "ExpiredCodeException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the expired code exception is thrown.

" } }, "documentation":"

This exception is thrown if a code has expired.

", "exception":true }, "ExplicitAuthFlowsListType":{ "type":"list", "member":{"shape":"ExplicitAuthFlowsType"} }, "ExplicitAuthFlowsType":{ "type":"string", "enum":[ "ADMIN_NO_SRP_AUTH", "CUSTOM_AUTH_FLOW_ONLY" ] }, "ForceAliasCreation":{"type":"boolean"}, "ForgetDeviceRequest":{ "type":"structure", "required":["DeviceKey"], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

The access token for the forgotten device request.

" }, "DeviceKey":{ "shape":"DeviceKeyType", "documentation":"

The device key.

" } }, "documentation":"

Represents the request to forget the device.

" }, "ForgotPasswordRequest":{ "type":"structure", "required":[ "ClientId", "Username" ], "members":{ "ClientId":{ "shape":"ClientIdType", "documentation":"

The ID of the client associated with the user pool.

" }, "SecretHash":{ "shape":"SecretHashType", "documentation":"

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user for whom you want to enter a code to reset a forgotten password.

" } }, "documentation":"

Represents the request to reset a user's password.

" }, "ForgotPasswordResponse":{ "type":"structure", "members":{ "CodeDeliveryDetails":{ "shape":"CodeDeliveryDetailsType", "documentation":"

The code delivery details returned by the server in response to the request to reset a password.

" } }, "documentation":"

Respresents the response from the server regarding the request to reset a password.

" }, "GenerateSecret":{"type":"boolean"}, "GetCSVHeaderRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that the users are to be imported into.

" } }, "documentation":"

Represents the request to get the header information for the .csv file for the user import job.

" }, "GetCSVHeaderResponse":{ "type":"structure", "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that the users are to be imported into.

" }, "CSVHeader":{ "shape":"ListOfStringTypes", "documentation":"

The header information for the .csv file for the user import job.

" } }, "documentation":"

Represents the response from the server to the request to get the header information for the .csv file for the user import job.

" }, "GetDeviceRequest":{ "type":"structure", "required":["DeviceKey"], "members":{ "DeviceKey":{ "shape":"DeviceKeyType", "documentation":"

The device key.

" }, "AccessToken":{ "shape":"TokenModelType", "documentation":"

The access token.

" } }, "documentation":"

Represents the request to get the device.

" }, "GetDeviceResponse":{ "type":"structure", "required":["Device"], "members":{ "Device":{ "shape":"DeviceType", "documentation":"

The device.

" } }, "documentation":"

Gets the device response.

" }, "GetGroupRequest":{ "type":"structure", "required":[ "GroupName", "UserPoolId" ], "members":{ "GroupName":{ "shape":"GroupNameType", "documentation":"

The name of the group.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" } } }, "GetGroupResponse":{ "type":"structure", "members":{ "Group":{ "shape":"GroupType", "documentation":"

The group object for the group.

" } } }, "GetUserAttributeVerificationCodeRequest":{ "type":"structure", "required":["AttributeName"], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

The access token returned by the server response to get the user attribute verification code.

" }, "AttributeName":{ "shape":"AttributeNameType", "documentation":"

The attribute name returned by the server response to get the user attribute verification code.

" } }, "documentation":"

Represents the request to get user attribute verification.

" }, "GetUserAttributeVerificationCodeResponse":{ "type":"structure", "members":{ "CodeDeliveryDetails":{ "shape":"CodeDeliveryDetailsType", "documentation":"

The code delivery details returned by the server in response to the request to get the user attribute verification code.

" } }, "documentation":"

The verification code response returned by the server response to get the user attribute verification code.

" }, "GetUserRequest":{ "type":"structure", "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

The access token returned by the server response to get information about the user.

" } }, "documentation":"

Represents the request to get information about the user.

" }, "GetUserResponse":{ "type":"structure", "required":[ "Username", "UserAttributes" ], "members":{ "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user you wish to retrieve from the get user request.

" }, "UserAttributes":{ "shape":"AttributeListType", "documentation":"

An array of name-value pairs representing user attributes.

" }, "MFAOptions":{ "shape":"MFAOptionListType", "documentation":"

Specifies the options for MFA (e.g., email or phone number).

" } }, "documentation":"

Represents the response from the server from the request to get information about the user.

" }, "GlobalSignOutRequest":{ "type":"structure", "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

The access token.

" } }, "documentation":"

Represents the request to sign out all devices.

" }, "GlobalSignOutResponse":{ "type":"structure", "members":{ }, "documentation":"

The response to the request to sign out all devices.

" }, "GroupExistsException":{ "type":"structure", "members":{ "message":{"shape":"MessageType"} }, "documentation":"

This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.

", "exception":true }, "GroupListType":{ "type":"list", "member":{"shape":"GroupType"} }, "GroupNameType":{ "type":"string", "max":128, "min":1, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" }, "GroupType":{ "type":"structure", "members":{ "GroupName":{ "shape":"GroupNameType", "documentation":"

The name of the group.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "Description":{ "shape":"DescriptionType", "documentation":"

A string containing the description of the group.

" }, "RoleArn":{ "shape":"ArnType", "documentation":"

The role ARN for the group.

" }, "Precedence":{ "shape":"PrecedenceType", "documentation":"

A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Groups with higher Precedence values take precedence over groups with lower Precedence values or with null Precedence values.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens.

The default Precedence value is null.

" }, "LastModifiedDate":{ "shape":"DateType", "documentation":"

The date the group was last modified.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

The date the group was created.

" } }, "documentation":"

The group type.

" }, "InitiateAuthRequest":{ "type":"structure", "required":[ "AuthFlow", "ClientId" ], "members":{ "AuthFlow":{ "shape":"AuthFlowType", "documentation":"

The authentication flow.

" }, "AuthParameters":{ "shape":"AuthParametersType", "documentation":"

The authentication parameters.

" }, "ClientMetadata":{ "shape":"ClientMetadataType", "documentation":"

The client app's metadata.

" }, "ClientId":{ "shape":"ClientIdType", "documentation":"

The client ID.

" } }, "documentation":"

Initiates the authentication request.

" }, "InitiateAuthResponse":{ "type":"structure", "members":{ "ChallengeName":{ "shape":"ChallengeNameType", "documentation":"

The name of the challenge.

" }, "Session":{ "shape":"SessionType", "documentation":"

The session.

" }, "ChallengeParameters":{ "shape":"ChallengeParametersType", "documentation":"

The challenge parameters.

" }, "AuthenticationResult":{ "shape":"AuthenticationResultType", "documentation":"

The result returned by the server in response to the request to initiate authentication.

" } }, "documentation":"

Initiates the authentication response.

" }, "IntegerType":{"type":"integer"}, "InternalErrorException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when Amazon Cognito throws an internal error exception.

" } }, "documentation":"

This exception is thrown when Amazon Cognito encounters an internal error.

", "exception":true, "fault":true }, "InvalidEmailRoleAccessPolicyException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when you have an unverified email address or the identity policy is not set on an email address that Amazon Cognito can access.

" } }, "documentation":"

This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400.

", "exception":true }, "InvalidLambdaResponseException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the Amazon Cognito service throws an invalid AWS Lambda response exception.

" } }, "documentation":"

This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.

", "exception":true }, "InvalidParameterException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the Amazon Cognito service throws an invalid parameter exception.

" } }, "documentation":"

This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

", "exception":true }, "InvalidPasswordException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the Amazon Cognito service throws an invalid user password exception.

" } }, "documentation":"

This exception is thrown when the Amazon Cognito service encounters an invalid password.

", "exception":true }, "InvalidSmsRoleAccessPolicyException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message retuned when the invalid SMS role access policy exception is thrown.

" } }, "documentation":"

This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.

", "exception":true }, "InvalidSmsRoleTrustRelationshipException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the role trust relationship for the SMS message is invalid.

" } }, "documentation":"

This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.

", "exception":true }, "InvalidUserPoolConfigurationException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the user pool configuration is invalid.

" } }, "documentation":"

This exception is thrown when the user pool configuration is invalid.

", "exception":true }, "LambdaConfigType":{ "type":"structure", "members":{ "PreSignUp":{ "shape":"ArnType", "documentation":"

A pre-registration AWS Lambda trigger.

" }, "CustomMessage":{ "shape":"ArnType", "documentation":"

A custom Message AWS Lambda trigger.

" }, "PostConfirmation":{ "shape":"ArnType", "documentation":"

A post-confirmation AWS Lambda trigger.

" }, "PreAuthentication":{ "shape":"ArnType", "documentation":"

A pre-authentication AWS Lambda trigger.

" }, "PostAuthentication":{ "shape":"ArnType", "documentation":"

A post-authentication AWS Lambda trigger.

" }, "DefineAuthChallenge":{ "shape":"ArnType", "documentation":"

Defines the authentication challenge.

" }, "CreateAuthChallenge":{ "shape":"ArnType", "documentation":"

Creates an authentication challenge.

" }, "VerifyAuthChallengeResponse":{ "shape":"ArnType", "documentation":"

Verifies the authentication challenge response.

" } }, "documentation":"

Specifies the type of configuration for AWS Lambda triggers.

" }, "LimitExceededException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when Amazon Cognito throws a limit exceeded exception.

" } }, "documentation":"

This exception is thrown when a user exceeds the limit for a requested AWS resource.

", "exception":true }, "ListDevicesRequest":{ "type":"structure", "required":["AccessToken"], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

The access tokens for the request to list devices.

" }, "Limit":{ "shape":"QueryLimitType", "documentation":"

The limit of the device request.

" }, "PaginationToken":{ "shape":"SearchPaginationTokenType", "documentation":"

The pagination token for the list request.

" } }, "documentation":"

Represents the request to list the devices.

" }, "ListDevicesResponse":{ "type":"structure", "members":{ "Devices":{ "shape":"DeviceListType", "documentation":"

The devices returned in the list devices response.

" }, "PaginationToken":{ "shape":"SearchPaginationTokenType", "documentation":"

The pagination token for the list device response.

" } }, "documentation":"

Represents the response to list devices.

" }, "ListGroupsRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "Limit":{ "shape":"QueryLimitType", "documentation":"

The limit of the request to list groups.

" }, "NextToken":{ "shape":"PaginationKey", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } } }, "ListGroupsResponse":{ "type":"structure", "members":{ "Groups":{ "shape":"GroupListType", "documentation":"

The group objects for the groups.

" }, "NextToken":{ "shape":"PaginationKey", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } } }, "ListOfStringTypes":{ "type":"list", "member":{"shape":"StringType"} }, "ListUserImportJobsRequest":{ "type":"structure", "required":[ "UserPoolId", "MaxResults" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that the users are being imported into.

" }, "MaxResults":{ "shape":"PoolQueryLimitType", "documentation":"

The maximum number of import jobs you want the request to return.

" }, "PaginationToken":{ "shape":"PaginationKeyType", "documentation":"

An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list.

" } }, "documentation":"

Represents the request to list the user import jobs.

" }, "ListUserImportJobsResponse":{ "type":"structure", "members":{ "UserImportJobs":{ "shape":"UserImportJobsListType", "documentation":"

The user import jobs.

" }, "PaginationToken":{ "shape":"PaginationKeyType", "documentation":"

An identifier that can be used to return the next set of user import jobs in the list.

" } }, "documentation":"

Represents the response from the server to the request to list the user import jobs.

" }, "ListUserPoolClientsRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool where you want to list user pool clients.

" }, "MaxResults":{ "shape":"QueryLimit", "documentation":"

The maximum number of results you want the request to return when listing the user pool clients.

" }, "NextToken":{ "shape":"PaginationKey", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents the request to list the user pool clients.

" }, "ListUserPoolClientsResponse":{ "type":"structure", "members":{ "UserPoolClients":{ "shape":"UserPoolClientListType", "documentation":"

The user pool clients in the response that lists user pool clients.

" }, "NextToken":{ "shape":"PaginationKey", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents the response from the server that lists user pool clients.

" }, "ListUserPoolsRequest":{ "type":"structure", "required":["MaxResults"], "members":{ "NextToken":{ "shape":"PaginationKeyType", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" }, "MaxResults":{ "shape":"PoolQueryLimitType", "documentation":"

The maximum number of results you want the request to return when listing the user pools.

" } }, "documentation":"

Represents the request to list user pools.

" }, "ListUserPoolsResponse":{ "type":"structure", "members":{ "UserPools":{ "shape":"UserPoolListType", "documentation":"

The user pools from the response to list users.

" }, "NextToken":{ "shape":"PaginationKeyType", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

Represents the response to list user pools.

" }, "ListUsersInGroupRequest":{ "type":"structure", "required":[ "UserPoolId", "GroupName" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "GroupName":{ "shape":"GroupNameType", "documentation":"

The name of the group.

" }, "Limit":{ "shape":"QueryLimitType", "documentation":"

The limit of the request to list users.

" }, "NextToken":{ "shape":"PaginationKey", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } } }, "ListUsersInGroupResponse":{ "type":"structure", "members":{ "Users":{ "shape":"UsersListType", "documentation":"

The users returned in the request to list users.

" }, "NextToken":{ "shape":"PaginationKey", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } } }, "ListUsersRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for which you want to list users.

" }, "AttributesToGet":{ "shape":"SearchedAttributeNamesListType", "documentation":"

The attributes to get from the request to list users.

" }, "Limit":{ "shape":"QueryLimitType", "documentation":"

The limit of the request to list users.

" }, "PaginationToken":{ "shape":"SearchPaginationTokenType", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" }, "Filter":{ "shape":"UserFilterType", "documentation":"

The filter for the list users request.

" } }, "documentation":"

Represents the request to list users.

" }, "ListUsersResponse":{ "type":"structure", "members":{ "Users":{ "shape":"UsersListType", "documentation":"

The users returned in the request to list users.

" }, "PaginationToken":{ "shape":"SearchPaginationTokenType", "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" } }, "documentation":"

The response from the request to list users.

" }, "LongType":{"type":"long"}, "MFAMethodNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when Amazon Cognito throws an MFA method not found exception.

" } }, "documentation":"

This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.

", "exception":true }, "MFAOptionListType":{ "type":"list", "member":{"shape":"MFAOptionType"} }, "MFAOptionType":{ "type":"structure", "members":{ "DeliveryMedium":{ "shape":"DeliveryMediumType", "documentation":"

The delivery medium (email message or SMS message) to send the MFA code.

" }, "AttributeName":{ "shape":"AttributeNameType", "documentation":"

The attribute name of the MFA option type.

" } }, "documentation":"

Specifies the different settings for multi-factor authentication (MFA).

" }, "MessageActionType":{ "type":"string", "enum":[ "RESEND", "SUPPRESS" ] }, "MessageTemplateType":{ "type":"structure", "members":{ "SMSMessage":{ "shape":"SmsVerificationMessageType", "documentation":"

The message template for SMS messages.

" }, "EmailMessage":{ "shape":"EmailVerificationMessageType", "documentation":"

The message template for email messages.

" }, "EmailSubject":{ "shape":"EmailVerificationSubjectType", "documentation":"

The subject line for email messages.

" } }, "documentation":"

The message template structure.

" }, "MessageType":{"type":"string"}, "NewDeviceMetadataType":{ "type":"structure", "members":{ "DeviceKey":{ "shape":"DeviceKeyType", "documentation":"

The device key.

" }, "DeviceGroupKey":{ "shape":"StringType", "documentation":"

The device group key.

" } }, "documentation":"

The new device metadata type.

" }, "NotAuthorizedException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the Amazon Cognito service returns a not authorized exception.

" } }, "documentation":"

This exception gets thrown when a user is not authorized.

", "exception":true }, "NumberAttributeConstraintsType":{ "type":"structure", "members":{ "MinValue":{ "shape":"StringType", "documentation":"

The minimum value of an attribute that is of the number data type.

" }, "MaxValue":{ "shape":"StringType", "documentation":"

The maximum value of an attribute that is of the number data type.

" } }, "documentation":"

The minimum and maximum value of an attribute that is of the number data type.

" }, "PaginationKey":{ "type":"string", "min":1, "pattern":"[\\S]+" }, "PaginationKeyType":{ "type":"string", "min":1, "pattern":"[\\S]+" }, "PasswordPolicyMinLengthType":{ "type":"integer", "max":99, "min":6 }, "PasswordPolicyType":{ "type":"structure", "members":{ "MinimumLength":{ "shape":"PasswordPolicyMinLengthType", "documentation":"

The minimum length of the password policy that you have set. Cannot be less than 6.

" }, "RequireUppercase":{ "shape":"BooleanType", "documentation":"

In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.

" }, "RequireLowercase":{ "shape":"BooleanType", "documentation":"

In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.

" }, "RequireNumbers":{ "shape":"BooleanType", "documentation":"

In the password policy that you have set, refers to whether you have required users to use at least one number in their password.

" }, "RequireSymbols":{ "shape":"BooleanType", "documentation":"

In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.

" } }, "documentation":"

The password policy type.

" }, "PasswordResetRequiredException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when a password reset is required.

" } }, "documentation":"

This exception is thrown when a password reset is required.

", "exception":true }, "PasswordType":{ "type":"string", "max":256, "min":6, "pattern":"[\\S]+", "sensitive":true }, "PoolQueryLimitType":{ "type":"integer", "max":60, "min":1 }, "PreSignedUrlType":{ "type":"string", "max":2048, "min":0 }, "PrecedenceType":{ "type":"integer", "min":0 }, "PreconditionNotMetException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when a precondition is not met.

" } }, "documentation":"

This exception is thrown when a precondition is not met.

", "exception":true }, "QueryLimit":{ "type":"integer", "max":60, "min":1 }, "QueryLimitType":{ "type":"integer", "max":60, "min":0 }, "RefreshTokenValidityType":{ "type":"integer", "max":3650, "min":0 }, "ResendConfirmationCodeRequest":{ "type":"structure", "required":[ "ClientId", "Username" ], "members":{ "ClientId":{ "shape":"ClientIdType", "documentation":"

The ID of the client associated with the user pool.

" }, "SecretHash":{ "shape":"SecretHashType", "documentation":"

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user to whom you wish to resend a confirmation code.

" } }, "documentation":"

Represents the request to resend the confirmation code.

" }, "ResendConfirmationCodeResponse":{ "type":"structure", "members":{ "CodeDeliveryDetails":{ "shape":"CodeDeliveryDetailsType", "documentation":"

The code delivery details returned by the server in response to the request to resend the confirmation code.

" } }, "documentation":"

The response from the server when the Amazon Cognito Your User Pools service makes the request to resend a confirmation code.

" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the Amazon Cognito service returns a resource not found exception.

" } }, "documentation":"

This exception is thrown when the Amazon Cognito service cannot find the requested resource.

", "exception":true }, "RespondToAuthChallengeRequest":{ "type":"structure", "required":[ "ClientId", "ChallengeName" ], "members":{ "ClientId":{ "shape":"ClientIdType", "documentation":"

The client ID.

" }, "ChallengeName":{ "shape":"ChallengeNameType", "documentation":"

The name of the challenge.

" }, "Session":{ "shape":"SessionType", "documentation":"

The session.

" }, "ChallengeResponses":{ "shape":"ChallengeResponsesType", "documentation":"

The responses to the authentication challenge.

" } }, "documentation":"

The request to respond to an authentication challenge.

" }, "RespondToAuthChallengeResponse":{ "type":"structure", "members":{ "ChallengeName":{ "shape":"ChallengeNameType", "documentation":"

The challenge name.

" }, "Session":{ "shape":"SessionType", "documentation":"

The session.

" }, "ChallengeParameters":{ "shape":"ChallengeParametersType", "documentation":"

The challenge parameters.

" }, "AuthenticationResult":{ "shape":"AuthenticationResultType", "documentation":"

The result returned by the server in response to the request to respond to the authentication challenge.

" } }, "documentation":"

The response to respond to the authentication challenge.

" }, "SchemaAttributeType":{ "type":"structure", "members":{ "Name":{ "shape":"CustomAttributeNameType", "documentation":"

A schema attribute of the name type.

" }, "AttributeDataType":{ "shape":"AttributeDataType", "documentation":"

The attribute data type.

" }, "DeveloperOnlyAttribute":{ "shape":"BooleanType", "documentation":"

Specifies whether the attribute type is developer only.

", "box":true }, "Mutable":{ "shape":"BooleanType", "documentation":"

Specifies whether the attribute can be changed once it has been created.

", "box":true }, "Required":{ "shape":"BooleanType", "documentation":"

Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.

", "box":true }, "NumberAttributeConstraints":{ "shape":"NumberAttributeConstraintsType", "documentation":"

Specifies the constraints for an attribute of the number type.

" }, "StringAttributeConstraints":{ "shape":"StringAttributeConstraintsType", "documentation":"

Specifies the constraints for an attribute of the string type.

" } }, "documentation":"

Contains information about the schema attribute.

" }, "SchemaAttributesListType":{ "type":"list", "member":{"shape":"SchemaAttributeType"}, "max":50, "min":1 }, "SearchPaginationTokenType":{ "type":"string", "min":1, "pattern":"[\\S]+" }, "SearchedAttributeNamesListType":{ "type":"list", "member":{"shape":"AttributeNameType"} }, "SecretHashType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w+=/]+", "sensitive":true }, "SessionType":{ "type":"string", "max":2048, "min":20 }, "SetUserSettingsRequest":{ "type":"structure", "required":[ "AccessToken", "MFAOptions" ], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

The access token for the set user settings request.

" }, "MFAOptions":{ "shape":"MFAOptionListType", "documentation":"

Specifies the options for MFA (e.g., email or phone number).

" } }, "documentation":"

Represents the request to set user settings.

" }, "SetUserSettingsResponse":{ "type":"structure", "members":{ }, "documentation":"

The response from the server for a set user settings request.

" }, "SignUpRequest":{ "type":"structure", "required":[ "ClientId", "Username", "Password" ], "members":{ "ClientId":{ "shape":"ClientIdType", "documentation":"

The ID of the client associated with the user pool.

" }, "SecretHash":{ "shape":"SecretHashType", "documentation":"

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

" }, "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user you wish to register.

" }, "Password":{ "shape":"PasswordType", "documentation":"

The password of the user you wish to register.

" }, "UserAttributes":{ "shape":"AttributeListType", "documentation":"

An array of name-value pairs representing user attributes.

" }, "ValidationData":{ "shape":"AttributeListType", "documentation":"

The validation data in the request to register a user.

" } }, "documentation":"

Represents the request to register a user.

" }, "SignUpResponse":{ "type":"structure", "members":{ "UserConfirmed":{ "shape":"BooleanType", "documentation":"

A response from the server indicating that a user registration has been confirmed.

" }, "CodeDeliveryDetails":{ "shape":"CodeDeliveryDetailsType", "documentation":"

The code delivery details returned by the server response to the user registration request.

" } }, "documentation":"

The response from the server for a registration request.

" }, "SmsConfigurationType":{ "type":"structure", "required":["SnsCallerArn"], "members":{ "SnsCallerArn":{ "shape":"ArnType", "documentation":"

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

" }, "ExternalId":{ "shape":"StringType", "documentation":"

The external ID.

" } }, "documentation":"

The SMS configuratoin type.

" }, "SmsVerificationMessageType":{ "type":"string", "max":140, "min":6, "pattern":".*\\{####\\}.*" }, "StartUserImportJobRequest":{ "type":"structure", "required":[ "UserPoolId", "JobId" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that the users are being imported into.

" }, "JobId":{ "shape":"UserImportJobIdType", "documentation":"

The job ID for the user import job.

" } }, "documentation":"

Represents the request to start the user import job.

" }, "StartUserImportJobResponse":{ "type":"structure", "members":{ "UserImportJob":{ "shape":"UserImportJobType", "documentation":"

The job object that represents the user import job.

" } }, "documentation":"

Represents the response from the server to the request to start the user import job.

" }, "StatusType":{ "type":"string", "enum":[ "Enabled", "Disabled" ] }, "StopUserImportJobRequest":{ "type":"structure", "required":[ "UserPoolId", "JobId" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that the users are being imported into.

" }, "JobId":{ "shape":"UserImportJobIdType", "documentation":"

The job ID for the user import job.

" } }, "documentation":"

Represents the request to stop the user import job.

" }, "StopUserImportJobResponse":{ "type":"structure", "members":{ "UserImportJob":{ "shape":"UserImportJobType", "documentation":"

The job object that represents the user import job.

" } }, "documentation":"

Represents the response from the server to the request to stop the user import job.

" }, "StringAttributeConstraintsType":{ "type":"structure", "members":{ "MinLength":{ "shape":"StringType", "documentation":"

The minimum length of an attribute value of the string type.

" }, "MaxLength":{ "shape":"StringType", "documentation":"

The maximum length of an attribute value of the string type.

" } }, "documentation":"

The type of constraints associated with an attribute of the string type.

" }, "StringType":{"type":"string"}, "TokenModelType":{ "type":"string", "pattern":"[A-Za-z0-9-_=.]+", "sensitive":true }, "TooManyFailedAttemptsException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the Amazon Cognito service returns a too many failed attempts exception.

" } }, "documentation":"

This exception gets thrown when the user has made too many failed attempts for a given action (e.g., sign in).

", "exception":true }, "TooManyRequestsException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the Amazon Cognito service returns a too many requests exception.

" } }, "documentation":"

This exception gets thrown when the user has made too many requests for a given operation.

", "exception":true }, "UnexpectedLambdaException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the Amazon Cognito service returns an unexpected AWS Lambda exception.

" } }, "documentation":"

This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

", "exception":true }, "UnsupportedUserStateException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the user is in an unsupported state.

" } }, "documentation":"

The request failed because the user is in an unsupported state.

", "exception":true }, "UpdateDeviceStatusRequest":{ "type":"structure", "required":[ "AccessToken", "DeviceKey" ], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

The access token.

" }, "DeviceKey":{ "shape":"DeviceKeyType", "documentation":"

The device key.

" }, "DeviceRememberedStatus":{ "shape":"DeviceRememberedStatusType", "documentation":"

The status of whether a device is remembered.

" } }, "documentation":"

Represents the request to update the device status.

" }, "UpdateDeviceStatusResponse":{ "type":"structure", "members":{ }, "documentation":"

The response to the request to update the device status.

" }, "UpdateGroupRequest":{ "type":"structure", "required":[ "GroupName", "UserPoolId" ], "members":{ "GroupName":{ "shape":"GroupNameType", "documentation":"

The name of the group.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool.

" }, "Description":{ "shape":"DescriptionType", "documentation":"

A string containing the new description of the group.

" }, "RoleArn":{ "shape":"ArnType", "documentation":"

The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

" }, "Precedence":{ "shape":"PrecedenceType", "documentation":"

The new precedence value for the group. For more information about this parameter, see CreateGroupRequest.

" } } }, "UpdateGroupResponse":{ "type":"structure", "members":{ "Group":{ "shape":"GroupType", "documentation":"

The group object for the group.

" } } }, "UpdateUserAttributesRequest":{ "type":"structure", "required":["UserAttributes"], "members":{ "UserAttributes":{ "shape":"AttributeListType", "documentation":"

An array of name-value pairs representing user attributes.

" }, "AccessToken":{ "shape":"TokenModelType", "documentation":"

The access token for the request to update user attributes.

" } }, "documentation":"

Represents the request to update user attributes.

" }, "UpdateUserAttributesResponse":{ "type":"structure", "members":{ "CodeDeliveryDetailsList":{ "shape":"CodeDeliveryDetailsListType", "documentation":"

The code delivery details list from the server for the request to update user attributes.

" } }, "documentation":"

Represents the response from the server for the request to update user attributes.

" }, "UpdateUserPoolClientRequest":{ "type":"structure", "required":[ "UserPoolId", "ClientId" ], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool where you want to update the user pool client.

" }, "ClientId":{ "shape":"ClientIdType", "documentation":"

The ID of the client associated with the user pool.

" }, "ClientName":{ "shape":"ClientNameType", "documentation":"

The client name from the update user pool client request.

" }, "RefreshTokenValidity":{ "shape":"RefreshTokenValidityType", "documentation":"

The validity of the refresh token, in days.

" }, "ReadAttributes":{ "shape":"ClientPermissionListType", "documentation":"

The read-only attributes of the user pool.

" }, "WriteAttributes":{ "shape":"ClientPermissionListType", "documentation":"

The writeable attributes of the user pool.

" }, "ExplicitAuthFlows":{ "shape":"ExplicitAuthFlowsListType", "documentation":"

Explicit authentication flows.

" } }, "documentation":"

Represents the request to update the user pool client.

" }, "UpdateUserPoolClientResponse":{ "type":"structure", "members":{ "UserPoolClient":{ "shape":"UserPoolClientType", "documentation":"

The user pool client value from the response from the server when an update user pool client request is made.

" } }, "documentation":"

Represents the response from the server to the request to update the user pool client.

" }, "UpdateUserPoolRequest":{ "type":"structure", "required":["UserPoolId"], "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool you want to update.

" }, "Policies":{ "shape":"UserPoolPolicyType", "documentation":"

A container with the policies you wish to update in a user pool.

" }, "LambdaConfig":{ "shape":"LambdaConfigType", "documentation":"

The AWS Lambda configuration information from the request to update the user pool.

" }, "AutoVerifiedAttributes":{ "shape":"VerifiedAttributesListType", "documentation":"

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

" }, "SmsVerificationMessage":{ "shape":"SmsVerificationMessageType", "documentation":"

A container with information about the SMS verification message.

" }, "EmailVerificationMessage":{ "shape":"EmailVerificationMessageType", "documentation":"

The contents of the email verification message.

" }, "EmailVerificationSubject":{ "shape":"EmailVerificationSubjectType", "documentation":"

The subject of the email verfication message.

" }, "SmsAuthenticationMessage":{ "shape":"SmsVerificationMessageType", "documentation":"

The contents of the SMS authentication message.

" }, "MfaConfiguration":{ "shape":"UserPoolMfaType", "documentation":"

Can be one of the following values:

  • OFF - MFA tokens are not required and cannot be specified during user registration.

  • ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.

  • OPTIONAL - Users have the option when registering to create an MFA token.

" }, "DeviceConfiguration":{ "shape":"DeviceConfigurationType", "documentation":"

Device configuration.

" }, "EmailConfiguration":{ "shape":"EmailConfigurationType", "documentation":"

Email configuration.

" }, "SmsConfiguration":{ "shape":"SmsConfigurationType", "documentation":"

SMS configuration.

" }, "UserPoolTags":{ "shape":"UserPoolTagsType", "documentation":"

The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool

" }, "AdminCreateUserConfig":{ "shape":"AdminCreateUserConfigType", "documentation":"

The configuration for AdminCreateUser requests.

" } }, "documentation":"

Represents the request to update the user pool.

" }, "UpdateUserPoolResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the response from the server when you make a request to update the user pool.

" }, "UserFilterType":{ "type":"string", "max":256 }, "UserImportInProgressException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the user pool has an import job running.

" } }, "documentation":"

This exception is thrown when you are trying to modify a user pool while a user import job is in progress for that pool.

", "exception":true }, "UserImportJobIdType":{ "type":"string", "max":55, "min":1, "pattern":"import-[0-9a-zA-Z-]+" }, "UserImportJobNameType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w\\s+=,.@-]+" }, "UserImportJobStatusType":{ "type":"string", "enum":[ "Created", "Pending", "InProgress", "Stopping", "Expired", "Stopped", "Failed", "Succeeded" ] }, "UserImportJobType":{ "type":"structure", "members":{ "JobName":{ "shape":"UserImportJobNameType", "documentation":"

The job name for the user import job.

" }, "JobId":{ "shape":"UserImportJobIdType", "documentation":"

The job ID for the user import job.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool that the users are being imported into.

" }, "PreSignedUrl":{ "shape":"PreSignedUrlType", "documentation":"

The pre-signed URL to be used to upload the .csv file.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

The date when the user import job was created.

" }, "StartDate":{ "shape":"DateType", "documentation":"

The date when the user import job was started.

" }, "CompletionDate":{ "shape":"DateType", "documentation":"

The date when the user imoprt job was completed.

" }, "Status":{ "shape":"UserImportJobStatusType", "documentation":"

The status of the user import job. One of the following:

  • Created - The job was created but not started.

  • Pending - A transition state. You have started the job, but it has not begun importing users yet.

  • InProgress - The job has started, and users are being imported.

  • Stopping - You have stopped the job, but the job has not stopped importing users yet.

  • Stopped - You have stopped the job, and the job has stopped importing users.

  • Succeeded - The job has completed successfully.

  • Failed - The job has stopped due to an error.

  • Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job cannot be started.

" }, "CloudWatchLogsRoleArn":{ "shape":"ArnType", "documentation":"

The role ARN for the Amazon CloudWatch Logging role for the user import job. For more information, see \"Creating the CloudWatch Logs IAM Role\" in the Amazon Cognito Developer Guide.

" }, "ImportedUsers":{ "shape":"LongType", "documentation":"

The number of users that were successfully imported.

" }, "SkippedUsers":{ "shape":"LongType", "documentation":"

The number of users that were skipped.

" }, "FailedUsers":{ "shape":"LongType", "documentation":"

The number of users that could not be imported.

" }, "CompletionMessage":{ "shape":"CompletionMessageType", "documentation":"

The message returned when the user import job is completed.

" } }, "documentation":"

The user import job type.

" }, "UserImportJobsListType":{ "type":"list", "member":{"shape":"UserImportJobType"}, "max":50, "min":1 }, "UserLambdaValidationException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when the Amazon Cognito service returns a user validation exception with the AWS Lambda service.

" } }, "documentation":"

This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

", "exception":true }, "UserNotConfirmedException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when a user is not confirmed successfully.

" } }, "documentation":"

This exception is thrown when a user is not confirmed successfully.

", "exception":true }, "UserNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when a user is not found.

" } }, "documentation":"

This exception is thrown when a user is not found.

", "exception":true }, "UserPoolClientDescription":{ "type":"structure", "members":{ "ClientId":{ "shape":"ClientIdType", "documentation":"

The ID of the client associated with the user pool.

" }, "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool where you want to describe the user pool client.

" }, "ClientName":{ "shape":"ClientNameType", "documentation":"

The client name from the user pool client description.

" } }, "documentation":"

The description of the user pool client.

" }, "UserPoolClientListType":{ "type":"list", "member":{"shape":"UserPoolClientDescription"} }, "UserPoolClientType":{ "type":"structure", "members":{ "UserPoolId":{ "shape":"UserPoolIdType", "documentation":"

The user pool ID for the user pool client.

" }, "ClientName":{ "shape":"ClientNameType", "documentation":"

The client name from the user pool request of the client type.

" }, "ClientId":{ "shape":"ClientIdType", "documentation":"

The ID of the client associated with the user pool.

" }, "ClientSecret":{ "shape":"ClientSecretType", "documentation":"

The client secret from the user pool request of the client type.

" }, "LastModifiedDate":{ "shape":"DateType", "documentation":"

The last modified date from the user pool request of the client type.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

The creation date from the user pool request of the client type.

" }, "RefreshTokenValidity":{ "shape":"RefreshTokenValidityType", "documentation":"

The validity of the refresh token, in days.

" }, "ReadAttributes":{ "shape":"ClientPermissionListType", "documentation":"

The Read-only attributes.

" }, "WriteAttributes":{ "shape":"ClientPermissionListType", "documentation":"

The writeable attributes.

" }, "ExplicitAuthFlows":{ "shape":"ExplicitAuthFlowsListType", "documentation":"

The explicit authentication flows.

" } }, "documentation":"

A user pool of the client type.

" }, "UserPoolDescriptionType":{ "type":"structure", "members":{ "Id":{ "shape":"UserPoolIdType", "documentation":"

The ID in a user pool description.

" }, "Name":{ "shape":"UserPoolNameType", "documentation":"

The name in a user pool description.

" }, "LambdaConfig":{ "shape":"LambdaConfigType", "documentation":"

The AWS Lambda configuration information in a user pool description.

" }, "Status":{ "shape":"StatusType", "documentation":"

The user pool status in a user pool description.

" }, "LastModifiedDate":{ "shape":"DateType", "documentation":"

The last modified date in a user pool description.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

The creation date in a user pool description.

" } }, "documentation":"

A user pool description.

" }, "UserPoolIdType":{ "type":"string", "max":55, "min":1, "pattern":"[\\w-]+_[0-9a-zA-Z]+" }, "UserPoolListType":{ "type":"list", "member":{"shape":"UserPoolDescriptionType"} }, "UserPoolMfaType":{ "type":"string", "enum":[ "OFF", "ON", "OPTIONAL" ] }, "UserPoolNameType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w\\s+=,.@-]+" }, "UserPoolPolicyType":{ "type":"structure", "members":{ "PasswordPolicy":{ "shape":"PasswordPolicyType", "documentation":"

A container with information about the user pool password policy.

" } }, "documentation":"

The type of policy in a user pool.

" }, "UserPoolTaggingException":{ "type":"structure", "members":{ "message":{"shape":"MessageType"} }, "documentation":"

This exception gets thrown when a user pool tag cannot be set or updated.

", "exception":true }, "UserPoolTagsType":{ "type":"map", "key":{"shape":"StringType"}, "value":{"shape":"StringType"} }, "UserPoolType":{ "type":"structure", "members":{ "Id":{ "shape":"UserPoolIdType", "documentation":"

The ID of the user pool.

" }, "Name":{ "shape":"UserPoolNameType", "documentation":"

The name of the user pool.

" }, "Policies":{ "shape":"UserPoolPolicyType", "documentation":"

A container describing the policies associated with a user pool.

" }, "LambdaConfig":{ "shape":"LambdaConfigType", "documentation":"

A container describing the AWS Lambda triggers associated with a user pool.

" }, "Status":{ "shape":"StatusType", "documentation":"

The status of a user pool.

" }, "LastModifiedDate":{ "shape":"DateType", "documentation":"

The last modified date of a user pool.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

The creation date of a user pool.

" }, "SchemaAttributes":{ "shape":"SchemaAttributesListType", "documentation":"

A container with the schema attributes of a user pool.

" }, "AutoVerifiedAttributes":{ "shape":"VerifiedAttributesListType", "documentation":"

Specifies the attributes that are auto-verified in a user pool.

" }, "AliasAttributes":{ "shape":"AliasAttributesListType", "documentation":"

Specifies the attributes that are aliased in a user pool.

" }, "SmsVerificationMessage":{ "shape":"SmsVerificationMessageType", "documentation":"

The contents of the SMS verification message.

" }, "EmailVerificationMessage":{ "shape":"EmailVerificationMessageType", "documentation":"

The contents of the email verification message.

" }, "EmailVerificationSubject":{ "shape":"EmailVerificationSubjectType", "documentation":"

The subject of the email verification message.

" }, "SmsAuthenticationMessage":{ "shape":"SmsVerificationMessageType", "documentation":"

The contents of the SMS authentication message.

" }, "MfaConfiguration":{ "shape":"UserPoolMfaType", "documentation":"

Can be one of the following values:

  • OFF - MFA tokens are not required and cannot be specified during user registration.

  • ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.

  • OPTIONAL - Users have the option when registering to create an MFA token.

" }, "DeviceConfiguration":{ "shape":"DeviceConfigurationType", "documentation":"

The device configuration.

" }, "EstimatedNumberOfUsers":{ "shape":"IntegerType", "documentation":"

A number estimating the size of the user pool.

" }, "EmailConfiguration":{ "shape":"EmailConfigurationType", "documentation":"

The email configuration.

" }, "SmsConfiguration":{ "shape":"SmsConfigurationType", "documentation":"

The SMS configuration.

" }, "UserPoolTags":{ "shape":"UserPoolTagsType", "documentation":"

The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool

" }, "SmsConfigurationFailure":{ "shape":"StringType", "documentation":"

The reason why the SMS configuration cannot send the message(s) to your users.

" }, "EmailConfigurationFailure":{ "shape":"StringType", "documentation":"

The reason why the email configuration cannot send the messages to your users.

" }, "AdminCreateUserConfig":{ "shape":"AdminCreateUserConfigType", "documentation":"

The configuration for AdminCreateUser requests.

" } }, "documentation":"

A container with information about the user pool type.

" }, "UserStatusType":{ "type":"string", "enum":[ "UNCONFIRMED", "CONFIRMED", "ARCHIVED", "COMPROMISED", "UNKNOWN", "RESET_REQUIRED", "FORCE_CHANGE_PASSWORD" ] }, "UserType":{ "type":"structure", "members":{ "Username":{ "shape":"UsernameType", "documentation":"

The user name of the user you wish to describe.

" }, "Attributes":{ "shape":"AttributeListType", "documentation":"

A container with information about the user type attributes.

" }, "UserCreateDate":{ "shape":"DateType", "documentation":"

The creation date of the user.

" }, "UserLastModifiedDate":{ "shape":"DateType", "documentation":"

The last modified date of the user.

" }, "Enabled":{ "shape":"BooleanType", "documentation":"

Specifies whether the user is enabled.

" }, "UserStatus":{ "shape":"UserStatusType", "documentation":"

The user status. Can be one of the following:

  • UNCONFIRMED - User has been created but not confirmed.

  • CONFIRMED - User has been confirmed.

  • ARCHIVED - User is no longer active.

  • COMPROMISED - User is disabled due to a potential security threat.

  • UNKNOWN - User status is not known.

" }, "MFAOptions":{ "shape":"MFAOptionListType", "documentation":"

The MFA options for the user.

" } }, "documentation":"

The user type.

" }, "UsernameExistsException":{ "type":"structure", "members":{ "message":{ "shape":"MessageType", "documentation":"

The message returned when Amazon Cognito throws a user name exists exception.

" } }, "documentation":"

This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.

", "exception":true }, "UsernameType":{ "type":"string", "max":128, "min":1, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+", "sensitive":true }, "UsersListType":{ "type":"list", "member":{"shape":"UserType"} }, "VerifiedAttributeType":{ "type":"string", "enum":[ "phone_number", "email" ] }, "VerifiedAttributesListType":{ "type":"list", "member":{"shape":"VerifiedAttributeType"} }, "VerifyUserAttributeRequest":{ "type":"structure", "required":[ "AttributeName", "Code" ], "members":{ "AccessToken":{ "shape":"TokenModelType", "documentation":"

Represents the access token of the request to verify user attributes.

" }, "AttributeName":{ "shape":"AttributeNameType", "documentation":"

The attribute name in the request to verify user attributes.

" }, "Code":{ "shape":"ConfirmationCodeType", "documentation":"

The verification code in the request to verify user attributes.

" } }, "documentation":"

Represents the request to verify user attributes.

" }, "VerifyUserAttributeResponse":{ "type":"structure", "members":{ }, "documentation":"

A container representing the response from the server from the request to verify user attributes.

" } }, "documentation":"

Using the Amazon Cognito Your User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.

This API reference provides information about user pools in Amazon Cognito Your User Pools.

For more information, see the Amazon Cognito Documentation.

" } botocore-1.5.7/botocore/data/application-autoscaling/0000777454262600001440000000000013042511307023745 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/application-autoscaling/2016-02-06/0000777454262600001440000000000013042511307024777 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/application-autoscaling/2016-02-06/paginators-1.json0000666454262600001440000000107113042511306030175 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeScalableTargets": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "ScalableTargets" }, "DescribeScalingActivities": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "ScalingActivities" }, "DescribeScalingPolicies": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxResults", "result_key": "ScalingPolicies" } } } botocore-1.5.7/botocore/data/application-autoscaling/2016-02-06/service-2.json0000666454262600001440000014247013042511306027500 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-02-06", "endpointPrefix":"autoscaling", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Application Auto Scaling", "signatureVersion":"v4", "signingName":"application-autoscaling", "targetPrefix":"AnyScaleFrontendService", "uid":"application-autoscaling-2016-02-06" }, "operations":{ "DeleteScalingPolicy":{ "name":"DeleteScalingPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteScalingPolicyRequest"}, "output":{"shape":"DeleteScalingPolicyResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ObjectNotFoundException"}, {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], "documentation":"

Deletes the specified Application Auto Scaling scaling policy.

Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.

To create a scaling policy or update an existing one, see PutScalingPolicy.

" }, "DeregisterScalableTarget":{ "name":"DeregisterScalableTarget", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterScalableTargetRequest"}, "output":{"shape":"DeregisterScalableTargetResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ObjectNotFoundException"}, {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], "documentation":"

Deregisters a scalable target.

Deregistering a scalable target deletes the scaling policies that are associated with it.

To create a scalable target or update an existing one, see RegisterScalableTarget.

" }, "DescribeScalableTargets":{ "name":"DescribeScalableTargets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeScalableTargetsRequest"}, "output":{"shape":"DescribeScalableTargetsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], "documentation":"

Provides descriptive information about the scalable targets in the specified namespace.

You can filter the results using the ResourceIds and ScalableDimension parameters.

To create a scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget.

" }, "DescribeScalingActivities":{ "name":"DescribeScalingActivities", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeScalingActivitiesRequest"}, "output":{"shape":"DescribeScalingActivitiesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], "documentation":"

Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.

You can filter the results using the ResourceId and ScalableDimension parameters.

Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see DescribeScalingPolicies. To create a scaling policy or update an existing one, see PutScalingPolicy.

" }, "DescribeScalingPolicies":{ "name":"DescribeScalingPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeScalingPoliciesRequest"}, "output":{"shape":"DescribeScalingPoliciesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"FailedResourceAccessException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], "documentation":"

Provides descriptive information about the scaling policies in the specified namespace.

You can filter the results using the ResourceId, ScalableDimension, and PolicyNames parameters.

To create a scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.

" }, "PutScalingPolicy":{ "name":"PutScalingPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutScalingPolicyRequest"}, "output":{"shape":"PutScalingPolicyResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"ObjectNotFoundException"}, {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], "documentation":"

Creates or updates a policy for an Application Auto Scaling scalable target.

Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy without first registering a scalable target using RegisterScalableTarget.

To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.

You can view the scaling policies for a service namespace using DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.

" }, "RegisterScalableTarget":{ "name":"RegisterScalableTarget", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterScalableTargetRequest"}, "output":{"shape":"RegisterScalableTargetResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"ConcurrentUpdateException"}, {"shape":"InternalServiceException"} ], "documentation":"

Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out or scale in. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for your scalable dimension.

After you register a scalable target, you can create and apply scaling policies using PutScalingPolicy. You can view the scaling policies for a service namespace using DescribeScalableTargets. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget.

" } }, "shapes":{ "AdjustmentType":{ "type":"string", "enum":[ "ChangeInCapacity", "PercentChangeInCapacity", "ExactCapacity" ] }, "Alarm":{ "type":"structure", "required":[ "AlarmName", "AlarmARN" ], "members":{ "AlarmName":{ "shape":"ResourceId", "documentation":"

The name of the alarm.

" }, "AlarmARN":{ "shape":"ResourceId", "documentation":"

The Amazon Resource Name (ARN) of the alarm.

" } }, "documentation":"

Represents a CloudWatch alarm associated with a scaling policy.

" }, "Alarms":{ "type":"list", "member":{"shape":"Alarm"} }, "ConcurrentUpdateException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.

", "exception":true }, "Cooldown":{"type":"integer"}, "DeleteScalingPolicyRequest":{ "type":"structure", "required":[ "PolicyName", "ServiceNamespace", "ResourceId", "ScalableDimension" ], "members":{ "PolicyName":{ "shape":"ResourceIdMaxLen1600", "documentation":"

The name of the scaling policy.

" }, "ServiceNamespace":{ "shape":"ServiceNamespace", "documentation":"

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", "documentation":"

The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

" }, "ScalableDimension":{ "shape":"ScalableDimension", "documentation":"

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

" } } }, "DeleteScalingPolicyResponse":{ "type":"structure", "members":{ } }, "DeregisterScalableTargetRequest":{ "type":"structure", "required":[ "ServiceNamespace", "ResourceId", "ScalableDimension" ], "members":{ "ServiceNamespace":{ "shape":"ServiceNamespace", "documentation":"

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", "documentation":"

The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

" }, "ScalableDimension":{ "shape":"ScalableDimension", "documentation":"

The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

" } } }, "DeregisterScalableTargetResponse":{ "type":"structure", "members":{ } }, "DescribeScalableTargetsRequest":{ "type":"structure", "required":["ServiceNamespace"], "members":{ "ServiceNamespace":{ "shape":"ServiceNamespace", "documentation":"

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" }, "ResourceIds":{ "shape":"ResourceIdsMaxLen1600", "documentation":"

The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

" }, "ScalableDimension":{ "shape":"ScalableDimension", "documentation":"

The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of scalable target results. This value can be between 1 and 50. The default value is 50.

If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token for the next set of results.

" } } }, "DescribeScalableTargetsResponse":{ "type":"structure", "members":{ "ScalableTargets":{ "shape":"ScalableTargets", "documentation":"

The list of scalable targets that matches the request parameters.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token required to get the next set of results. This value is null if there are no more results to return.

" } } }, "DescribeScalingActivitiesRequest":{ "type":"structure", "required":["ServiceNamespace"], "members":{ "ServiceNamespace":{ "shape":"ServiceNamespace", "documentation":"

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", "documentation":"

The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

" }, "ScalableDimension":{ "shape":"ScalableDimension", "documentation":"

The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of scalable target results. This value can be between 1 and 50. The default value is 50.

If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token for the next set of results.

" } } }, "DescribeScalingActivitiesResponse":{ "type":"structure", "members":{ "ScalingActivities":{ "shape":"ScalingActivities", "documentation":"

A list of scaling activity objects.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token required to get the next set of results. This value is null if there are no more results to return.

" } } }, "DescribeScalingPoliciesRequest":{ "type":"structure", "required":["ServiceNamespace"], "members":{ "PolicyNames":{ "shape":"ResourceIdsMaxLen1600", "documentation":"

The names of the scaling policies to describe.

" }, "ServiceNamespace":{ "shape":"ServiceNamespace", "documentation":"

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", "documentation":"

The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

" }, "ScalableDimension":{ "shape":"ScalableDimension", "documentation":"

The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of scalable target results. This value can be between 1 and 50. The default value is 50.

If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token for the next set of results.

" } } }, "DescribeScalingPoliciesResponse":{ "type":"structure", "members":{ "ScalingPolicies":{ "shape":"ScalingPolicies", "documentation":"

A list of scaling policy objects.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token required to get the next set of results. This value is null if there are no more results to return.

" } } }, "ErrorMessage":{"type":"string"}, "FailedResourceAccessException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

Failed access to resources caused an exception. This exception currently only applies to DescribeScalingPolicies. It is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have the proper permissions to call the CloudWatch DescribeAlarms API operation on behalf of your account.

", "exception":true }, "InternalServiceException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The service encountered an internal error.

", "exception":true }, "InvalidNextTokenException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The next token supplied was invalid.

", "exception":true }, "LimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded. For more information, see Application Auto Scaling Limits.

", "exception":true }, "MaxResults":{"type":"integer"}, "MetricAggregationType":{ "type":"string", "enum":[ "Average", "Minimum", "Maximum" ] }, "MetricScale":{"type":"double"}, "MinAdjustmentMagnitude":{"type":"integer"}, "ObjectNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The specified object could not be found. For any Put or Register API operation, which depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any Delete or Deregister API operation, this exception is thrown if the resource that is to be deleted or deregistered cannot be found.

", "exception":true }, "PolicyName":{ "type":"string", "max":256, "min":1, "pattern":"\\p{Print}+" }, "PolicyType":{ "type":"string", "enum":["StepScaling"] }, "PutScalingPolicyRequest":{ "type":"structure", "required":[ "PolicyName", "ServiceNamespace", "ResourceId", "ScalableDimension" ], "members":{ "PolicyName":{ "shape":"PolicyName", "documentation":"

The name of the scaling policy.

" }, "ServiceNamespace":{ "shape":"ServiceNamespace", "documentation":"

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", "documentation":"

The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

" }, "ScalableDimension":{ "shape":"ScalableDimension", "documentation":"

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

" }, "PolicyType":{ "shape":"PolicyType", "documentation":"

The policy type. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required.

" }, "StepScalingPolicyConfiguration":{ "shape":"StepScalingPolicyConfiguration", "documentation":"

The configuration for the step scaling policy. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required. For more information, see StepScalingPolicyConfiguration and StepAdjustment.

" } } }, "PutScalingPolicyResponse":{ "type":"structure", "required":["PolicyARN"], "members":{ "PolicyARN":{ "shape":"ResourceIdMaxLen1600", "documentation":"

The Amazon Resource Name (ARN) of the resulting scaling policy.

" } } }, "RegisterScalableTargetRequest":{ "type":"structure", "required":[ "ServiceNamespace", "ResourceId", "ScalableDimension" ], "members":{ "ServiceNamespace":{ "shape":"ServiceNamespace", "documentation":"

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", "documentation":"

The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

" }, "ScalableDimension":{ "shape":"ScalableDimension", "documentation":"

The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

" }, "MinCapacity":{ "shape":"ResourceCapacity", "documentation":"

The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target and optional if you are updating one.

" }, "MaxCapacity":{ "shape":"ResourceCapacity", "documentation":"

The maximum value to scale to in response to a scale out event. This parameter is required if you are registering a scalable target and optional if you are updating one.

" }, "RoleARN":{ "shape":"ResourceIdMaxLen1600", "documentation":"

The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. This parameter is required when you register a scalable target and optional when you update one.

" } } }, "RegisterScalableTargetResponse":{ "type":"structure", "members":{ } }, "ResourceCapacity":{"type":"integer"}, "ResourceId":{ "type":"string", "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "ResourceIdMaxLen1600":{ "type":"string", "max":1600, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "ResourceIdsMaxLen1600":{ "type":"list", "member":{"shape":"ResourceIdMaxLen1600"} }, "ScalableDimension":{ "type":"string", "enum":[ "ecs:service:DesiredCount", "ec2:spot-fleet-request:TargetCapacity", "elasticmapreduce:instancegroup:InstanceCount" ] }, "ScalableTarget":{ "type":"structure", "required":[ "ServiceNamespace", "ResourceId", "ScalableDimension", "MinCapacity", "MaxCapacity", "RoleARN", "CreationTime" ], "members":{ "ServiceNamespace":{ "shape":"ServiceNamespace", "documentation":"

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", "documentation":"

The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

" }, "ScalableDimension":{ "shape":"ScalableDimension", "documentation":"

The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

" }, "MinCapacity":{ "shape":"ResourceCapacity", "documentation":"

The minimum value to scale to in response to a scale in event.

" }, "MaxCapacity":{ "shape":"ResourceCapacity", "documentation":"

The maximum value to scale to in response to a scale out event.

" }, "RoleARN":{ "shape":"ResourceIdMaxLen1600", "documentation":"

The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.

" }, "CreationTime":{ "shape":"TimestampType", "documentation":"

The Unix timestamp for when the scalable target was created.

" } }, "documentation":"

Represents a scalable target.

" }, "ScalableTargets":{ "type":"list", "member":{"shape":"ScalableTarget"} }, "ScalingActivities":{ "type":"list", "member":{"shape":"ScalingActivity"} }, "ScalingActivity":{ "type":"structure", "required":[ "ActivityId", "ServiceNamespace", "ResourceId", "ScalableDimension", "Description", "Cause", "StartTime", "StatusCode" ], "members":{ "ActivityId":{ "shape":"ResourceId", "documentation":"

The unique identifier of the scaling activity.

" }, "ServiceNamespace":{ "shape":"ServiceNamespace", "documentation":"

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", "documentation":"

The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

" }, "ScalableDimension":{ "shape":"ScalableDimension", "documentation":"

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

" }, "Description":{ "shape":"XmlString", "documentation":"

A simple description of what action the scaling activity intends to accomplish.

" }, "Cause":{ "shape":"XmlString", "documentation":"

A simple description of what caused the scaling activity to happen.

" }, "StartTime":{ "shape":"TimestampType", "documentation":"

The Unix timestamp for when the scaling activity began.

" }, "EndTime":{ "shape":"TimestampType", "documentation":"

The Unix timestamp for when the scaling activity ended.

" }, "StatusCode":{ "shape":"ScalingActivityStatusCode", "documentation":"

Indicates the status of the scaling activity.

" }, "StatusMessage":{ "shape":"XmlString", "documentation":"

A simple message about the current status of the scaling activity.

" }, "Details":{ "shape":"XmlString", "documentation":"

The details about the scaling activity.

" } }, "documentation":"

Represents a scaling activity.

" }, "ScalingActivityStatusCode":{ "type":"string", "enum":[ "Pending", "InProgress", "Successful", "Overridden", "Unfulfilled", "Failed" ] }, "ScalingAdjustment":{"type":"integer"}, "ScalingPolicies":{ "type":"list", "member":{"shape":"ScalingPolicy"} }, "ScalingPolicy":{ "type":"structure", "required":[ "PolicyARN", "PolicyName", "ServiceNamespace", "ResourceId", "ScalableDimension", "PolicyType", "CreationTime" ], "members":{ "PolicyARN":{ "shape":"ResourceIdMaxLen1600", "documentation":"

The Amazon Resource Name (ARN) of the scaling policy.

" }, "PolicyName":{ "shape":"PolicyName", "documentation":"

The name of the scaling policy.

" }, "ServiceNamespace":{ "shape":"ServiceNamespace", "documentation":"

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" }, "ResourceId":{ "shape":"ResourceIdMaxLen1600", "documentation":"

The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

" }, "ScalableDimension":{ "shape":"ScalableDimension", "documentation":"

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

" }, "PolicyType":{ "shape":"PolicyType", "documentation":"

The scaling policy type.

" }, "StepScalingPolicyConfiguration":{ "shape":"StepScalingPolicyConfiguration", "documentation":"

The configuration for the step scaling policy.

" }, "Alarms":{ "shape":"Alarms", "documentation":"

The CloudWatch alarms associated with the scaling policy.

" }, "CreationTime":{ "shape":"TimestampType", "documentation":"

The Unix timestamp for when the scaling policy was created.

" } }, "documentation":"

Represents a scaling policy.

" }, "ServiceNamespace":{ "type":"string", "enum":[ "ecs", "elasticmapreduce", "ec2" ] }, "StepAdjustment":{ "type":"structure", "required":["ScalingAdjustment"], "members":{ "MetricIntervalLowerBound":{ "shape":"MetricScale", "documentation":"

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.

" }, "MetricIntervalUpperBound":{ "shape":"MetricScale", "documentation":"

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.

The upper bound must be greater than the lower bound.

" }, "ScalingAdjustment":{ "shape":"ScalingAdjustment", "documentation":"

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.

" } }, "documentation":"

Represents a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.

For the following examples, suppose that you have an alarm with a breach threshold of 50:

  • To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.

  • To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.

There are a few rules for the step adjustments for your step policy:

  • The ranges of your step adjustments can't overlap or have a gap.

  • At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.

  • At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.

  • The upper and lower bound can't be null in the same step adjustment.

" }, "StepAdjustments":{ "type":"list", "member":{"shape":"StepAdjustment"} }, "StepScalingPolicyConfiguration":{ "type":"structure", "members":{ "AdjustmentType":{ "shape":"AdjustmentType", "documentation":"

The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.

" }, "StepAdjustments":{ "shape":"StepAdjustments", "documentation":"

A set of adjustments that enable you to scale based on the size of the alarm breach.

" }, "MinAdjustmentMagnitude":{ "shape":"MinAdjustmentMagnitude", "documentation":"

The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.

" }, "Cooldown":{ "shape":"Cooldown", "documentation":"

The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.

For scale out policies, while Cooldown is in effect, the capacity that has been added by the previous scale out event that initiated the Cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a Cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.

For scale in policies, the Cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the Cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

" }, "MetricAggregationType":{ "shape":"MetricAggregationType", "documentation":"

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average.

" } }, "documentation":"

Represents a step scaling policy configuration.

" }, "TimestampType":{"type":"timestamp"}, "ValidationException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

An exception was thrown for a validation issue. Review the available parameters for the API request.

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

With Application Auto Scaling, you can automatically scale your AWS resources. The experience similar to that of Auto Scaling. You can use Application Auto Scaling to accomplish the following tasks:

  • Define scaling policies to automatically scale your AWS resources

  • Scale your resources in response to CloudWatch alarms

  • View the history of your scaling events

Application Auto Scaling can scale the following AWS resources:

For a list of supported regions, see AWS Regions and Endpoints: Application Auto Scaling in the AWS General Reference.

" } botocore-1.5.7/botocore/data/stepfunctions/0000777454262600001440000000000013042511307022037 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/stepfunctions/2016-11-23/0000777454262600001440000000000013042511307023070 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/stepfunctions/2016-11-23/service-2.json0000666454262600001440000013743013042511306025571 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-11-23", "endpointPrefix":"states", "jsonVersion":"1.0", "protocol":"json", "serviceAbbreviation":"AWS SFN", "serviceFullName":"AWS Step Functions", "signatureVersion":"v4", "targetPrefix":"AWSStepFunctions", "uid":"states-2016-11-23" }, "operations":{ "CreateActivity":{ "name":"CreateActivity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateActivityInput"}, "output":{"shape":"CreateActivityOutput"}, "errors":[ {"shape":"ActivityLimitExceeded"}, {"shape":"InvalidName"} ], "documentation":"

Creates an activity.

", "idempotent":true }, "CreateStateMachine":{ "name":"CreateStateMachine", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateStateMachineInput"}, "output":{"shape":"CreateStateMachineOutput"}, "errors":[ {"shape":"InvalidArn"}, {"shape":"InvalidDefinition"}, {"shape":"InvalidName"}, {"shape":"StateMachineAlreadyExists"}, {"shape":"StateMachineDeleting"}, {"shape":"StateMachineLimitExceeded"} ], "documentation":"

Creates a state machine.

", "idempotent":true }, "DeleteActivity":{ "name":"DeleteActivity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteActivityInput"}, "output":{"shape":"DeleteActivityOutput"}, "errors":[ {"shape":"InvalidArn"} ], "documentation":"

Deletes an activity.

" }, "DeleteStateMachine":{ "name":"DeleteStateMachine", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteStateMachineInput"}, "output":{"shape":"DeleteStateMachineOutput"}, "errors":[ {"shape":"InvalidArn"} ], "documentation":"

Deletes a state machine. This is an asynchronous operation-- it sets the state machine's status to \"DELETING\" and begins the delete process.

" }, "DescribeActivity":{ "name":"DescribeActivity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeActivityInput"}, "output":{"shape":"DescribeActivityOutput"}, "errors":[ {"shape":"ActivityDoesNotExist"}, {"shape":"InvalidArn"} ], "documentation":"

Describes an activity.

" }, "DescribeExecution":{ "name":"DescribeExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeExecutionInput"}, "output":{"shape":"DescribeExecutionOutput"}, "errors":[ {"shape":"ExecutionDoesNotExist"}, {"shape":"InvalidArn"} ], "documentation":"

Describes an execution.

" }, "DescribeStateMachine":{ "name":"DescribeStateMachine", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStateMachineInput"}, "output":{"shape":"DescribeStateMachineOutput"}, "errors":[ {"shape":"InvalidArn"}, {"shape":"StateMachineDoesNotExist"} ], "documentation":"

Describes a state machine.

" }, "GetActivityTask":{ "name":"GetActivityTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetActivityTaskInput"}, "output":{"shape":"GetActivityTaskOutput"}, "errors":[ {"shape":"ActivityDoesNotExist"}, {"shape":"ActivityWorkerLimitExceeded"}, {"shape":"InvalidArn"} ], "documentation":"

Used by workers to retrieve a task (with the specified activity ARN) scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result, that is, the taskToken returned is an empty string.

Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).

" }, "GetExecutionHistory":{ "name":"GetExecutionHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetExecutionHistoryInput"}, "output":{"shape":"GetExecutionHistoryOutput"}, "errors":[ {"shape":"ExecutionDoesNotExist"}, {"shape":"InvalidArn"}, {"shape":"InvalidToken"} ], "documentation":"

Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

" }, "ListActivities":{ "name":"ListActivities", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListActivitiesInput"}, "output":{"shape":"ListActivitiesOutput"}, "errors":[ {"shape":"InvalidToken"} ], "documentation":"

Lists the existing activities. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

" }, "ListExecutions":{ "name":"ListExecutions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListExecutionsInput"}, "output":{"shape":"ListExecutionsOutput"}, "errors":[ {"shape":"InvalidArn"}, {"shape":"InvalidToken"}, {"shape":"StateMachineDoesNotExist"} ], "documentation":"

Lists the executions of a state machine that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

" }, "ListStateMachines":{ "name":"ListStateMachines", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListStateMachinesInput"}, "output":{"shape":"ListStateMachinesOutput"}, "errors":[ {"shape":"InvalidToken"} ], "documentation":"

Lists the existing state machines. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextToken returned by the previous call.

" }, "SendTaskFailure":{ "name":"SendTaskFailure", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SendTaskFailureInput"}, "output":{"shape":"SendTaskFailureOutput"}, "errors":[ {"shape":"TaskDoesNotExist"}, {"shape":"InvalidToken"}, {"shape":"TaskTimedOut"} ], "documentation":"

Used by workers to report that the task identified by the taskToken failed.

" }, "SendTaskHeartbeat":{ "name":"SendTaskHeartbeat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SendTaskHeartbeatInput"}, "output":{"shape":"SendTaskHeartbeatOutput"}, "errors":[ {"shape":"TaskDoesNotExist"}, {"shape":"InvalidToken"}, {"shape":"TaskTimedOut"} ], "documentation":"

Used by workers to report to the service that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition. This action does not in itself create an event in the execution history. However, if the task times out, the execution history will contain an ActivityTimedOut event.

The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received.

This operation is only useful for long-lived tasks to report the liveliness of the task.

" }, "SendTaskSuccess":{ "name":"SendTaskSuccess", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SendTaskSuccessInput"}, "output":{"shape":"SendTaskSuccessOutput"}, "errors":[ {"shape":"TaskDoesNotExist"}, {"shape":"InvalidOutput"}, {"shape":"InvalidToken"}, {"shape":"TaskTimedOut"} ], "documentation":"

Used by workers to report that the task identified by the taskToken completed successfully.

" }, "StartExecution":{ "name":"StartExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartExecutionInput"}, "output":{"shape":"StartExecutionOutput"}, "errors":[ {"shape":"ExecutionLimitExceeded"}, {"shape":"ExecutionAlreadyExists"}, {"shape":"InvalidArn"}, {"shape":"InvalidExecutionInput"}, {"shape":"InvalidName"}, {"shape":"StateMachineDoesNotExist"}, {"shape":"StateMachineDeleting"} ], "documentation":"

Starts a state machine execution.

", "idempotent":true }, "StopExecution":{ "name":"StopExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopExecutionInput"}, "output":{"shape":"StopExecutionOutput"}, "errors":[ {"shape":"ExecutionDoesNotExist"}, {"shape":"InvalidArn"} ], "documentation":"

Stops an execution.

" } }, "shapes":{ "ActivityDoesNotExist":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The specified activity does not exist.

", "exception":true }, "ActivityFailedEventDetails":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"

The error code of the failure.

" }, "cause":{ "shape":"Cause", "documentation":"

A more detailed explanation of the cause of the failure.

" } } }, "ActivityLimitExceeded":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.

", "exception":true }, "ActivityList":{ "type":"list", "member":{"shape":"ActivityListItem"} }, "ActivityListItem":{ "type":"structure", "required":[ "activityArn", "name", "creationDate" ], "members":{ "activityArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that identifies the activity.

" }, "name":{ "shape":"Name", "documentation":"

The name of the activity.

" }, "creationDate":{ "shape":"Timestamp", "documentation":"

The date the activity was created.

" } } }, "ActivityScheduleFailedEventDetails":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"

The error code of the failure.

" }, "cause":{ "shape":"Cause", "documentation":"

A more detailed explanation of the cause of the failure.

" } } }, "ActivityScheduledEventDetails":{ "type":"structure", "required":["resource"], "members":{ "resource":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the scheduled activity.

" }, "input":{ "shape":"Data", "documentation":"

The JSON data input to the activity task.

" }, "timeoutInSeconds":{ "shape":"TimeoutInSeconds", "documentation":"

The maximum allowed duration of the activity task.

", "box":true }, "heartbeatInSeconds":{ "shape":"TimeoutInSeconds", "documentation":"

The maximum allowed duration between two heartbeats for the activity task.

", "box":true } } }, "ActivityStartedEventDetails":{ "type":"structure", "members":{ "workerName":{ "shape":"Identity", "documentation":"

The name of the worker that the task was assigned to. These names are provided by the workers when calling GetActivityTask.

" } } }, "ActivitySucceededEventDetails":{ "type":"structure", "members":{ "output":{ "shape":"Data", "documentation":"

The JSON data output by the activity task.

" } } }, "ActivityTimedOutEventDetails":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"

The error code of the failure.

" }, "cause":{ "shape":"Cause", "documentation":"

A more detailed explanation of the cause of the timeout.

" } } }, "ActivityWorkerLimitExceeded":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The maximum number of workers concurrently polling for activity tasks has been reached.

", "exception":true }, "Arn":{ "type":"string", "max":256, "min":1 }, "Cause":{ "type":"string", "max":32768, "min":0 }, "CreateActivityInput":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"Name", "documentation":"

The name of the activity to create. This name must be unique for your AWS account and region.

" } } }, "CreateActivityOutput":{ "type":"structure", "required":[ "activityArn", "creationDate" ], "members":{ "activityArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that identifies the created activity.

" }, "creationDate":{ "shape":"Timestamp", "documentation":"

The date the activity was created.

" } } }, "CreateStateMachineInput":{ "type":"structure", "required":[ "name", "definition", "roleArn" ], "members":{ "name":{ "shape":"Name", "documentation":"

The name of the state machine. This name must be unique for your AWS account and region.

" }, "definition":{ "shape":"Definition", "documentation":"

The Amazon States Language definition of the state machine.

" }, "roleArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

" } } }, "CreateStateMachineOutput":{ "type":"structure", "required":[ "stateMachineArn", "creationDate" ], "members":{ "stateMachineArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that identifies the created state machine.

" }, "creationDate":{ "shape":"Timestamp", "documentation":"

The date the state machine was created.

" } } }, "Data":{ "type":"string", "max":32768 }, "Definition":{ "type":"string", "max":1048576, "min":1 }, "DeleteActivityInput":{ "type":"structure", "required":["activityArn"], "members":{ "activityArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the activity to delete.

" } } }, "DeleteActivityOutput":{ "type":"structure", "members":{ } }, "DeleteStateMachineInput":{ "type":"structure", "required":["stateMachineArn"], "members":{ "stateMachineArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the state machine to delete.

" } } }, "DeleteStateMachineOutput":{ "type":"structure", "members":{ } }, "DescribeActivityInput":{ "type":"structure", "required":["activityArn"], "members":{ "activityArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the activity to describe.

" } } }, "DescribeActivityOutput":{ "type":"structure", "required":[ "activityArn", "name", "creationDate" ], "members":{ "activityArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that identifies the activity.

" }, "name":{ "shape":"Name", "documentation":"

The name of the activity.

" }, "creationDate":{ "shape":"Timestamp", "documentation":"

The date the activity was created.

" } } }, "DescribeExecutionInput":{ "type":"structure", "required":["executionArn"], "members":{ "executionArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the execution to describe.

" } } }, "DescribeExecutionOutput":{ "type":"structure", "required":[ "executionArn", "stateMachineArn", "status", "startDate", "input" ], "members":{ "executionArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that identifies the execution.

" }, "stateMachineArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the executed stated machine.

" }, "name":{ "shape":"Name", "documentation":"

The name of the execution.

" }, "status":{ "shape":"ExecutionStatus", "documentation":"

The current status of the execution.

" }, "startDate":{ "shape":"Timestamp", "documentation":"

The date the execution was started.

" }, "stopDate":{ "shape":"Timestamp", "documentation":"

If the execution has already ended, the date the execution stopped.

" }, "input":{ "shape":"Data", "documentation":"

The JSON input data of the execution.

" }, "output":{ "shape":"Data", "documentation":"

The JSON output data of the execution.

" } } }, "DescribeStateMachineInput":{ "type":"structure", "required":["stateMachineArn"], "members":{ "stateMachineArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the state machine to describe.

" } } }, "DescribeStateMachineOutput":{ "type":"structure", "required":[ "stateMachineArn", "name", "definition", "roleArn", "creationDate" ], "members":{ "stateMachineArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that identifies the state machine.

" }, "name":{ "shape":"Name", "documentation":"

The name of the state machine.

" }, "status":{ "shape":"StateMachineStatus", "documentation":"

The current status of the state machine.

" }, "definition":{ "shape":"Definition", "documentation":"

The Amazon States Language definition of the state machine.

" }, "roleArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role used for executing this state machine.

" }, "creationDate":{ "shape":"Timestamp", "documentation":"

The date the state machine was created.

" } } }, "Error":{ "type":"string", "max":256, "min":0 }, "ErrorMessage":{"type":"string"}, "EventId":{"type":"long"}, "ExecutionAbortedEventDetails":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"

The error code of the failure.

" }, "cause":{ "shape":"Cause", "documentation":"

A more detailed explanation of the cause of the failure.

" } } }, "ExecutionAlreadyExists":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

An execution with the same name already exists.

", "exception":true }, "ExecutionDoesNotExist":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The specified execution does not exist.

", "exception":true }, "ExecutionFailedEventDetails":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"

The error code of the failure.

" }, "cause":{ "shape":"Cause", "documentation":"

A more detailed explanation of the cause of the failure.

" } } }, "ExecutionLimitExceeded":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.

", "exception":true }, "ExecutionList":{ "type":"list", "member":{"shape":"ExecutionListItem"} }, "ExecutionListItem":{ "type":"structure", "required":[ "executionArn", "stateMachineArn", "name", "status", "startDate" ], "members":{ "executionArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that identifies the execution.

" }, "stateMachineArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the executed state machine.

" }, "name":{ "shape":"Name", "documentation":"

The name of the execution.

" }, "status":{ "shape":"ExecutionStatus", "documentation":"

The current status of the execution.

" }, "startDate":{ "shape":"Timestamp", "documentation":"

The date the execution started.

" }, "stopDate":{ "shape":"Timestamp", "documentation":"

If the execution already ended, the date the execution stopped.

" } } }, "ExecutionStartedEventDetails":{ "type":"structure", "members":{ "input":{ "shape":"Data", "documentation":"

The JSON data input to the execution.

" }, "roleArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks.

" } } }, "ExecutionStatus":{ "type":"string", "enum":[ "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "ABORTED" ] }, "ExecutionSucceededEventDetails":{ "type":"structure", "members":{ "output":{ "shape":"Data", "documentation":"

The JSON data output by the execution.

" } } }, "ExecutionTimedOutEventDetails":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"

The error code of the failure.

" }, "cause":{ "shape":"Cause", "documentation":"

A more detailed explanation of the cause of the timeout.

" } } }, "GetActivityTaskInput":{ "type":"structure", "required":["activityArn"], "members":{ "activityArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the activity to retrieve tasks from.

" }, "workerName":{ "shape":"Name", "documentation":"

An arbitrary name may be provided in order to identify the worker that the task is assigned to. This name will be used when it is logged in the execution history.

" } } }, "GetActivityTaskOutput":{ "type":"structure", "members":{ "taskToken":{ "shape":"TaskToken", "documentation":"

A token that identifies the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task.

" }, "input":{ "shape":"Data", "documentation":"

The JSON input data for the task.

" } } }, "GetExecutionHistoryInput":{ "type":"structure", "required":["executionArn"], "members":{ "executionArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the execution.

" }, "maxResults":{ "shape":"PageSize", "documentation":"

The maximum number of results that will be returned per call. nextToken can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

" }, "reverseOrder":{ "shape":"ReverseOrder", "documentation":"

Lists events in descending order of their timeStamp.

" }, "nextToken":{ "shape":"PageToken", "documentation":"

If a nextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

The configured maxResults determines how many results can be returned in a single call.

" } } }, "GetExecutionHistoryOutput":{ "type":"structure", "required":["events"], "members":{ "events":{ "shape":"HistoryEventList", "documentation":"

The list of events that occurred in the execution.

" }, "nextToken":{ "shape":"PageToken", "documentation":"

If a nextToken is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

The configured maxResults determines how many results can be returned in a single call.

" } } }, "HistoryEvent":{ "type":"structure", "required":[ "timestamp", "type", "id" ], "members":{ "timestamp":{ "shape":"Timestamp", "documentation":"

The date the event occured.

" }, "type":{ "shape":"HistoryEventType", "documentation":"

The type of the event.

" }, "id":{ "shape":"EventId", "documentation":"

The id of the event. Events are numbered sequentially, starting at one.

" }, "previousEventId":{ "shape":"EventId", "documentation":"

The id of the previous event.

" }, "activityFailedEventDetails":{"shape":"ActivityFailedEventDetails"}, "activityScheduleFailedEventDetails":{"shape":"ActivityScheduleFailedEventDetails"}, "activityScheduledEventDetails":{"shape":"ActivityScheduledEventDetails"}, "activityStartedEventDetails":{"shape":"ActivityStartedEventDetails"}, "activitySucceededEventDetails":{"shape":"ActivitySucceededEventDetails"}, "activityTimedOutEventDetails":{"shape":"ActivityTimedOutEventDetails"}, "executionFailedEventDetails":{"shape":"ExecutionFailedEventDetails"}, "executionStartedEventDetails":{"shape":"ExecutionStartedEventDetails"}, "executionSucceededEventDetails":{"shape":"ExecutionSucceededEventDetails"}, "executionAbortedEventDetails":{"shape":"ExecutionAbortedEventDetails"}, "executionTimedOutEventDetails":{"shape":"ExecutionTimedOutEventDetails"}, "lambdaFunctionFailedEventDetails":{"shape":"LambdaFunctionFailedEventDetails"}, "lambdaFunctionScheduleFailedEventDetails":{"shape":"LambdaFunctionScheduleFailedEventDetails"}, "lambdaFunctionScheduledEventDetails":{"shape":"LambdaFunctionScheduledEventDetails"}, "lambdaFunctionStartFailedEventDetails":{"shape":"LambdaFunctionStartFailedEventDetails"}, "lambdaFunctionSucceededEventDetails":{"shape":"LambdaFunctionSucceededEventDetails"}, "lambdaFunctionTimedOutEventDetails":{"shape":"LambdaFunctionTimedOutEventDetails"}, "stateEnteredEventDetails":{"shape":"StateEnteredEventDetails"}, "stateExitedEventDetails":{"shape":"StateExitedEventDetails"} } }, "HistoryEventList":{ "type":"list", "member":{"shape":"HistoryEvent"} }, "HistoryEventType":{ "type":"string", "enum":[ "ActivityFailed", "ActivityScheduleFailed", "ActivityScheduled", "ActivityStarted", "ActivitySucceeded", "ActivityTimedOut", "ChoiceStateEntered", "ChoiceStateExited", "ExecutionFailed", "ExecutionStarted", "ExecutionSucceeded", "ExecutionAborted", "ExecutionTimedOut", "FailStateEntered", "LambdaFunctionFailed", "LambdaFunctionScheduleFailed", "LambdaFunctionScheduled", "LambdaFunctionStartFailed", "LambdaFunctionStarted", "LambdaFunctionSucceeded", "LambdaFunctionTimedOut", "SucceedStateEntered", "SucceedStateExited", "TaskStateEntered", "TaskStateExited", "PassStateEntered", "PassStateExited", "ParallelStateEntered", "ParallelStateExited", "WaitStateEntered", "WaitStateExited" ] }, "Identity":{ "type":"string", "max":256 }, "InvalidArn":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The provided Amazon Resource Name (ARN) is invalid.

", "exception":true }, "InvalidDefinition":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The provided Amazon States Language definition is invalid.

", "exception":true }, "InvalidExecutionInput":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The provided JSON input data is invalid.

", "exception":true }, "InvalidName":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The provided name is invalid.

", "exception":true }, "InvalidOutput":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The provided JSON output data is invalid.

", "exception":true }, "InvalidToken":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The provided token is invalid.

", "exception":true }, "LambdaFunctionFailedEventDetails":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"

The error code of the failure.

" }, "cause":{ "shape":"Cause", "documentation":"

A more detailed explanation of the cause of the failure.

" } } }, "LambdaFunctionScheduleFailedEventDetails":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"

The error code of the failure.

" }, "cause":{ "shape":"Cause", "documentation":"

A more detailed explanation of the cause of the failure.

" } } }, "LambdaFunctionScheduledEventDetails":{ "type":"structure", "required":["resource"], "members":{ "resource":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the scheduled lambda function.

" }, "input":{ "shape":"Data", "documentation":"

The JSON data input to the lambda function.

" }, "timeoutInSeconds":{ "shape":"TimeoutInSeconds", "documentation":"

The maximum allowed duration of the lambda function.

", "box":true } } }, "LambdaFunctionStartFailedEventDetails":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"

The error code of the failure.

" }, "cause":{ "shape":"Cause", "documentation":"

A more detailed explanation of the cause of the failure.

" } } }, "LambdaFunctionSucceededEventDetails":{ "type":"structure", "members":{ "output":{ "shape":"Data", "documentation":"

The JSON data output by the lambda function.

" } } }, "LambdaFunctionTimedOutEventDetails":{ "type":"structure", "members":{ "error":{ "shape":"Error", "documentation":"

The error code of the failure.

" }, "cause":{ "shape":"Cause", "documentation":"

A more detailed explanation of the cause of the timeout.

" } } }, "ListActivitiesInput":{ "type":"structure", "members":{ "maxResults":{ "shape":"PageSize", "documentation":"

The maximum number of results that will be returned per call. nextToken can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

" }, "nextToken":{ "shape":"PageToken", "documentation":"

If a nextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

The configured maxResults determines how many results can be returned in a single call.

" } } }, "ListActivitiesOutput":{ "type":"structure", "required":["activities"], "members":{ "activities":{ "shape":"ActivityList", "documentation":"

The list of activities.

" }, "nextToken":{ "shape":"PageToken", "documentation":"

If a nextToken is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

The configured maxResults determines how many results can be returned in a single call.

" } } }, "ListExecutionsInput":{ "type":"structure", "required":["stateMachineArn"], "members":{ "stateMachineArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the state machine whose executions will be listed.

" }, "statusFilter":{ "shape":"ExecutionStatus", "documentation":"

If specified, only list the executions whose current execution status matches the given filter.

" }, "maxResults":{ "shape":"PageSize", "documentation":"

The maximum number of results that will be returned per call. nextToken can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

" }, "nextToken":{ "shape":"PageToken", "documentation":"

If a nextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

The configured maxResults determines how many results can be returned in a single call.

" } } }, "ListExecutionsOutput":{ "type":"structure", "required":["executions"], "members":{ "executions":{ "shape":"ExecutionList", "documentation":"

The list of matching executions.

" }, "nextToken":{ "shape":"PageToken", "documentation":"

If a nextToken is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

The configured maxResults determines how many results can be returned in a single call.

" } } }, "ListStateMachinesInput":{ "type":"structure", "members":{ "maxResults":{ "shape":"PageSize", "documentation":"

The maximum number of results that will be returned per call. nextToken can be used to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

" }, "nextToken":{ "shape":"PageToken", "documentation":"

If a nextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

The configured maxResults determines how many results can be returned in a single call.

" } } }, "ListStateMachinesOutput":{ "type":"structure", "required":["stateMachines"], "members":{ "stateMachines":{"shape":"StateMachineList"}, "nextToken":{ "shape":"PageToken", "documentation":"

If a nextToken is returned, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

The configured maxResults determines how many results can be returned in a single call.

" } } }, "Name":{ "type":"string", "max":80, "min":1 }, "PageSize":{ "type":"integer", "max":1000, "min":0 }, "PageToken":{ "type":"string", "max":1024, "min":1 }, "ReverseOrder":{"type":"boolean"}, "SendTaskFailureInput":{ "type":"structure", "required":["taskToken"], "members":{ "taskToken":{ "shape":"TaskToken", "documentation":"

The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).

" }, "error":{ "shape":"Error", "documentation":"

An arbitrary error code that identifies the cause of the failure.

" }, "cause":{ "shape":"Cause", "documentation":"

A more detailed explanation of the cause of the failure.

" } } }, "SendTaskFailureOutput":{ "type":"structure", "members":{ } }, "SendTaskHeartbeatInput":{ "type":"structure", "required":["taskToken"], "members":{ "taskToken":{ "shape":"TaskToken", "documentation":"

The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).

" } } }, "SendTaskHeartbeatOutput":{ "type":"structure", "members":{ } }, "SendTaskSuccessInput":{ "type":"structure", "required":[ "taskToken", "output" ], "members":{ "taskToken":{ "shape":"TaskToken", "documentation":"

The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).

" }, "output":{ "shape":"Data", "documentation":"

The JSON output of the task.

" } } }, "SendTaskSuccessOutput":{ "type":"structure", "members":{ } }, "StartExecutionInput":{ "type":"structure", "required":["stateMachineArn"], "members":{ "stateMachineArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the state machine to execute.

" }, "name":{ "shape":"Name", "documentation":"

The name of the execution. This name must be unique for your AWS account and region.

" }, "input":{ "shape":"Data", "documentation":"

The JSON input data for the execution.

" } } }, "StartExecutionOutput":{ "type":"structure", "required":[ "executionArn", "startDate" ], "members":{ "executionArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that identifies the execution.

" }, "startDate":{ "shape":"Timestamp", "documentation":"

The date the execution was started.

" } } }, "StateEnteredEventDetails":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"Name", "documentation":"

The name of the state.

" }, "input":{ "shape":"Data", "documentation":"

The JSON input data to the state.

" } } }, "StateExitedEventDetails":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"Name", "documentation":"

The name of the state.

" }, "output":{ "shape":"Data", "documentation":"

The JSON output data of the state.

" } } }, "StateMachineAlreadyExists":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

A state machine with the same name but a different definition or role ARN already exists.

", "exception":true }, "StateMachineDeleting":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The specified state machine is being deleted.

", "exception":true }, "StateMachineDoesNotExist":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The specified state machine does not exist.

", "exception":true }, "StateMachineLimitExceeded":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.

", "exception":true }, "StateMachineList":{ "type":"list", "member":{"shape":"StateMachineListItem"} }, "StateMachineListItem":{ "type":"structure", "required":[ "stateMachineArn", "name", "creationDate" ], "members":{ "stateMachineArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that identifies the state machine.

" }, "name":{ "shape":"Name", "documentation":"

The name of the state machine.

" }, "creationDate":{ "shape":"Timestamp", "documentation":"

The date the state machine was created.

" } } }, "StateMachineStatus":{ "type":"string", "enum":[ "ACTIVE", "DELETING" ] }, "StopExecutionInput":{ "type":"structure", "required":["executionArn"], "members":{ "executionArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the execution to stop.

" }, "error":{ "shape":"Error", "documentation":"

An arbitrary error code that identifies the cause of the termination.

" }, "cause":{ "shape":"Cause", "documentation":"

A more detailed explanation of the cause of the termination.

" } } }, "StopExecutionOutput":{ "type":"structure", "required":["stopDate"], "members":{ "stopDate":{ "shape":"Timestamp", "documentation":"

The date the execution was stopped.

" } } }, "TaskDoesNotExist":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true }, "TaskTimedOut":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true }, "TaskToken":{ "type":"string", "max":1024, "min":1 }, "TimeoutInSeconds":{"type":"long"}, "Timestamp":{"type":"timestamp"} }, "documentation":"AWS Step Functions

AWS Step Functions is a web service that enables you to coordinate the components of distributed applications and microservices using visual workflows. You build applications from individual components that each perform a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a graphical console to visualize the components of your application as a series of steps. It automatically triggers and tracks each step, and retries when there are errors, so your application executes in order and as expected, every time. Step Functions logs the state of each step, so when things do go wrong, you can diagnose and debug problems quickly.

Step Functions manages the operations and underlying infrastructure for you to ensure your application is available at any scale. You can run tasks on the AWS cloud, on your own servers, or an any system that has access to AWS. Step Functions can be accessed and used with the Step Functions console, the AWS SDKs (included with your Beta release invitation email), or an HTTP API (the subject of this document).

" } botocore-1.5.7/botocore/data/es/0000777454262600001440000000000013042511307017542 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/es/2015-01-01/0000777454262600001440000000000013042511307020565 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/es/2015-01-01/service-2.json0000666454262600001440000012401013042511306023254 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"es-2015-01-01", "apiVersion":"2015-01-01", "endpointPrefix":"es", "protocol":"rest-json", "serviceFullName":"Amazon Elasticsearch Service", "signatureVersion":"v4" }, "operations":{ "AddTags":{ "name":"AddTags", "http":{ "method":"POST", "requestUri":"/2015-01-01/tags" }, "input":{"shape":"AddTagsRequest"}, "errors":[ {"shape":"BaseException"}, {"shape":"LimitExceededException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"

Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.

" }, "CreateElasticsearchDomain":{ "name":"CreateElasticsearchDomain", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/domain" }, "input":{"shape":"CreateElasticsearchDomainRequest"}, "output":{"shape":"CreateElasticsearchDomainResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"DisabledOperationException"}, {"shape":"InternalException"}, {"shape":"InvalidTypeException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ValidationException"} ], "documentation":"

Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

" }, "DeleteElasticsearchDomain":{ "name":"DeleteElasticsearchDomain", "http":{ "method":"DELETE", "requestUri":"/2015-01-01/es/domain/{DomainName}" }, "input":{"shape":"DeleteElasticsearchDomainRequest"}, "output":{"shape":"DeleteElasticsearchDomainResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

" }, "DescribeElasticsearchDomain":{ "name":"DescribeElasticsearchDomain", "http":{ "method":"GET", "requestUri":"/2015-01-01/es/domain/{DomainName}" }, "input":{"shape":"DescribeElasticsearchDomainRequest"}, "output":{"shape":"DescribeElasticsearchDomainResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

" }, "DescribeElasticsearchDomainConfig":{ "name":"DescribeElasticsearchDomainConfig", "http":{ "method":"GET", "requestUri":"/2015-01-01/es/domain/{DomainName}/config" }, "input":{"shape":"DescribeElasticsearchDomainConfigRequest"}, "output":{"shape":"DescribeElasticsearchDomainConfigResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

" }, "DescribeElasticsearchDomains":{ "name":"DescribeElasticsearchDomains", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/domain-info" }, "input":{"shape":"DescribeElasticsearchDomainsRequest"}, "output":{"shape":"DescribeElasticsearchDomainsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"ValidationException"} ], "documentation":"

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

" }, "ListDomainNames":{ "name":"ListDomainNames", "http":{ "method":"GET", "requestUri":"/2015-01-01/domain" }, "output":{"shape":"ListDomainNamesResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"ValidationException"} ], "documentation":"

Returns the name of all Elasticsearch domains owned by the current user's account.

" }, "ListTags":{ "name":"ListTags", "http":{ "method":"GET", "requestUri":"/2015-01-01/tags/" }, "input":{"shape":"ListTagsRequest"}, "output":{"shape":"ListTagsResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"

Returns all tags for the given Elasticsearch domain.

" }, "RemoveTags":{ "name":"RemoveTags", "http":{ "method":"POST", "requestUri":"/2015-01-01/tags-removal" }, "input":{"shape":"RemoveTagsRequest"}, "errors":[ {"shape":"BaseException"}, {"shape":"ValidationException"}, {"shape":"InternalException"} ], "documentation":"

Removes the specified set of tags from the specified Elasticsearch domain.

" }, "UpdateElasticsearchDomainConfig":{ "name":"UpdateElasticsearchDomainConfig", "http":{ "method":"POST", "requestUri":"/2015-01-01/es/domain/{DomainName}/config" }, "input":{"shape":"UpdateElasticsearchDomainConfigRequest"}, "output":{"shape":"UpdateElasticsearchDomainConfigResponse"}, "errors":[ {"shape":"BaseException"}, {"shape":"InternalException"}, {"shape":"InvalidTypeException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

" } }, "shapes":{ "ARN":{ "type":"string", "documentation":"

The Amazon Resource Name (ARN) of the Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

" }, "AccessPoliciesStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"PolicyDocument", "documentation":"

The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policiesfor more information.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that's included.

" } }, "documentation":"

The configured access rules for the domain's document and search endpoints, and the current status of those rules.

" }, "AddTagsRequest":{ "type":"structure", "required":[ "ARN", "TagList" ], "members":{ "ARN":{ "shape":"ARN", "documentation":"

Specify the ARN for which you want to add the tags.

" }, "TagList":{ "shape":"TagList", "documentation":"

List of Tag that need to be added for the Elasticsearch domain.

" } }, "documentation":"

Container for the parameters to the AddTags operation. Specify the tags that you want to attach to the Elasticsearch domain.

" }, "AdvancedOptions":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"}, "documentation":"

Exposes select native Elasticsearch configuration values from elasticsearch.yml. Currently, the following advanced options are available:

  • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
  • Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.

For more information, see Configuring Advanced Options.

" }, "AdvancedOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"AdvancedOptions", "documentation":"

Specifies the status of advanced options for the specified Elasticsearch domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.

" } }, "documentation":"

Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:

  • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
  • Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.

For more information, see Configuring Advanced Options.

" }, "BaseException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A description of the error.

" } }, "documentation":"

An error occurred while processing the request.

", "exception":true }, "Boolean":{"type":"boolean"}, "CreateElasticsearchDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the Elasticsearch domain that you are creating. Domain names are 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).

" }, "ElasticsearchVersion":{ "shape":"ElasticsearchVersionString", "documentation":"

String of format X.Y to specify version for the Elasticsearch domain eg. \"1.5\" or \"2.3\". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

" }, "ElasticsearchClusterConfig":{ "shape":"ElasticsearchClusterConfig", "documentation":"

Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

" }, "EBSOptions":{ "shape":"EBSOptions", "documentation":"

Options to enable, disable and specify the type and size of EBS storage volumes.

" }, "AccessPolicies":{ "shape":"PolicyDocument", "documentation":"

IAM access policy as a JSON-formatted string.

" }, "SnapshotOptions":{ "shape":"SnapshotOptions", "documentation":"

Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

" }, "AdvancedOptions":{ "shape":"AdvancedOptions", "documentation":"

Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

" } } }, "CreateElasticsearchDomainResponse":{ "type":"structure", "members":{ "DomainStatus":{ "shape":"ElasticsearchDomainStatus", "documentation":"

The status of the newly created Elasticsearch domain.

" } }, "documentation":"

The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain.

" }, "DeleteElasticsearchDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the Elasticsearch domain that you want to permanently delete.

", "location":"uri", "locationName":"DomainName" } }, "documentation":"

Container for the parameters to the DeleteElasticsearchDomain operation. Specifies the name of the Elasticsearch domain that you want to delete.

" }, "DeleteElasticsearchDomainResponse":{ "type":"structure", "members":{ "DomainStatus":{ "shape":"ElasticsearchDomainStatus", "documentation":"

The status of the Elasticsearch domain being deleted.

" } }, "documentation":"

The result of a DeleteElasticsearchDomain request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.

" }, "DescribeElasticsearchDomainConfigRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The Elasticsearch domain that you want to get information about.

", "location":"uri", "locationName":"DomainName" } }, "documentation":"

Container for the parameters to the DescribeElasticsearchDomainConfig operation. Specifies the domain name for which you want configuration information.

" }, "DescribeElasticsearchDomainConfigResponse":{ "type":"structure", "required":["DomainConfig"], "members":{ "DomainConfig":{ "shape":"ElasticsearchDomainConfig", "documentation":"

The configuration information of the domain requested in the DescribeElasticsearchDomainConfig request.

" } }, "documentation":"

The result of a DescribeElasticsearchDomainConfig request. Contains the configuration information of the requested domain.

" }, "DescribeElasticsearchDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the Elasticsearch domain for which you want information.

", "location":"uri", "locationName":"DomainName" } }, "documentation":"

Container for the parameters to the DescribeElasticsearchDomain operation.

" }, "DescribeElasticsearchDomainResponse":{ "type":"structure", "required":["DomainStatus"], "members":{ "DomainStatus":{ "shape":"ElasticsearchDomainStatus", "documentation":"

The current status of the Elasticsearch domain.

" } }, "documentation":"

The result of a DescribeElasticsearchDomain request. Contains the status of the domain specified in the request.

" }, "DescribeElasticsearchDomainsRequest":{ "type":"structure", "required":["DomainNames"], "members":{ "DomainNames":{ "shape":"DomainNameList", "documentation":"

The Elasticsearch domains for which you want information.

" } }, "documentation":"

Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the status of all Elasticsearch domains.

" }, "DescribeElasticsearchDomainsResponse":{ "type":"structure", "required":["DomainStatusList"], "members":{ "DomainStatusList":{ "shape":"ElasticsearchDomainStatusList", "documentation":"

The status of the domains requested in the DescribeElasticsearchDomains request.

" } }, "documentation":"

The result of a DescribeElasticsearchDomains request. Contains the status of the specified domains or all domains owned by the account.

" }, "DisabledOperationException":{ "type":"structure", "members":{ }, "documentation":"

An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

", "error":{"httpStatusCode":409}, "exception":true }, "DomainId":{ "type":"string", "documentation":"

Unique identifier for an Elasticsearch domain.

", "max":64, "min":1 }, "DomainInfo":{ "type":"structure", "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

Specifies the DomainName.

" } } }, "DomainInfoList":{ "type":"list", "member":{"shape":"DomainInfo"}, "documentation":"

Contains the list of Elasticsearch domain information.

" }, "DomainName":{ "type":"string", "documentation":"

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

", "max":28, "min":3, "pattern":"[a-z][a-z0-9\\-]+" }, "DomainNameList":{ "type":"list", "member":{"shape":"DomainName"}, "documentation":"

A list of Elasticsearch domain names.

" }, "EBSOptions":{ "type":"structure", "members":{ "EBSEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether EBS-based storage is enabled.

" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

Specifies the volume type for EBS-based storage.

" }, "VolumeSize":{ "shape":"IntegerClass", "documentation":"

Integer to specify the size of an EBS volume.

" }, "Iops":{ "shape":"IntegerClass", "documentation":"

Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).

" } }, "documentation":"

Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.

" }, "EBSOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"EBSOptions", "documentation":"

Specifies the EBS options for the specified Elasticsearch domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

Specifies the status of the EBS options for the specified Elasticsearch domain.

" } }, "documentation":"

Status of the EBS options for the specified Elasticsearch domain.

" }, "ESPartitionInstanceType":{ "type":"string", "enum":[ "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch" ] }, "ElasticsearchClusterConfig":{ "type":"structure", "members":{ "InstanceType":{ "shape":"ESPartitionInstanceType", "documentation":"

The instance type for an Elasticsearch cluster.

" }, "InstanceCount":{ "shape":"IntegerClass", "documentation":"

The number of instances in the specified domain cluster.

" }, "DedicatedMasterEnabled":{ "shape":"Boolean", "documentation":"

A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

" }, "ZoneAwarenessEnabled":{ "shape":"Boolean", "documentation":"

A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

" }, "DedicatedMasterType":{ "shape":"ESPartitionInstanceType", "documentation":"

The instance type for a dedicated master node.

" }, "DedicatedMasterCount":{ "shape":"IntegerClass", "documentation":"

Total number of dedicated master nodes, active and on standby, for the cluster.

" } }, "documentation":"

Specifies the configuration for the domain cluster, such as the type and number of instances.

" }, "ElasticsearchClusterConfigStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"ElasticsearchClusterConfig", "documentation":"

Specifies the cluster configuration for the specified Elasticsearch domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

Specifies the status of the configuration for the specified Elasticsearch domain.

" } }, "documentation":"

Specifies the configuration status for the specified Elasticsearch domain.

" }, "ElasticsearchDomainConfig":{ "type":"structure", "members":{ "ElasticsearchVersion":{ "shape":"ElasticsearchVersionStatus", "documentation":"

String of format X.Y to specify version for the Elasticsearch domain.

" }, "ElasticsearchClusterConfig":{ "shape":"ElasticsearchClusterConfigStatus", "documentation":"

Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

" }, "EBSOptions":{ "shape":"EBSOptionsStatus", "documentation":"

Specifies the EBSOptions for the Elasticsearch domain.

" }, "AccessPolicies":{ "shape":"AccessPoliciesStatus", "documentation":"

IAM access policy as a JSON-formatted string.

" }, "SnapshotOptions":{ "shape":"SnapshotOptionsStatus", "documentation":"

Specifies the SnapshotOptions for the Elasticsearch domain.

" }, "AdvancedOptions":{ "shape":"AdvancedOptionsStatus", "documentation":"

Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.

" } }, "documentation":"

The configuration of an Elasticsearch domain.

" }, "ElasticsearchDomainStatus":{ "type":"structure", "required":[ "DomainId", "DomainName", "ARN", "ElasticsearchClusterConfig" ], "members":{ "DomainId":{ "shape":"DomainId", "documentation":"

The unique identifier for the specified Elasticsearch domain.

" }, "DomainName":{ "shape":"DomainName", "documentation":"

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

" }, "ARN":{ "shape":"ARN", "documentation":"

The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

" }, "Created":{ "shape":"Boolean", "documentation":"

The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.

" }, "Deleted":{ "shape":"Boolean", "documentation":"

The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

" }, "Endpoint":{ "shape":"ServiceUrl", "documentation":"

The Elasticsearch domain endpoint that you use to submit index and search requests.

" }, "Processing":{ "shape":"Boolean", "documentation":"

The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

" }, "ElasticsearchVersion":{"shape":"ElasticsearchVersionString"}, "ElasticsearchClusterConfig":{ "shape":"ElasticsearchClusterConfig", "documentation":"

The type and number of instances in the domain cluster.

" }, "EBSOptions":{ "shape":"EBSOptions", "documentation":"

The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

" }, "AccessPolicies":{ "shape":"PolicyDocument", "documentation":"

IAM access policy as a JSON-formatted string.

" }, "SnapshotOptions":{ "shape":"SnapshotOptions", "documentation":"

Specifies the status of the SnapshotOptions

" }, "AdvancedOptions":{ "shape":"AdvancedOptions", "documentation":"

Specifies the status of the AdvancedOptions

" } }, "documentation":"

The current status of an Elasticsearch domain.

" }, "ElasticsearchDomainStatusList":{ "type":"list", "member":{"shape":"ElasticsearchDomainStatus"}, "documentation":"

A list that contains the status of each requested Elasticsearch domain.

" }, "ElasticsearchVersionStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"ElasticsearchVersionString", "documentation":"

Specifies the Elasticsearch version for the specified Elasticsearch domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.

" } }, "documentation":"

Status of the Elasticsearch version options for the specified Elasticsearch domain.

" }, "ElasticsearchVersionString":{"type":"string"}, "ErrorMessage":{"type":"string"}, "IntegerClass":{"type":"integer"}, "InternalException":{ "type":"structure", "members":{ }, "documentation":"

The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

", "error":{"httpStatusCode":500}, "exception":true }, "InvalidTypeException":{ "type":"structure", "members":{ }, "documentation":"

An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

", "error":{"httpStatusCode":409}, "exception":true }, "LimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

", "error":{"httpStatusCode":409}, "exception":true }, "ListDomainNamesResponse":{ "type":"structure", "members":{ "DomainNames":{ "shape":"DomainInfoList", "documentation":"

List of Elasticsearch domain names.

" } }, "documentation":"

The result of a ListDomainNames operation. Contains the names of all Elasticsearch domains owned by this account.

" }, "ListTagsRequest":{ "type":"structure", "required":["ARN"], "members":{ "ARN":{ "shape":"ARN", "documentation":"

Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.

", "location":"querystring", "locationName":"arn" } }, "documentation":"

Container for the parameters to the ListTags operation. Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view are attached.

" }, "ListTagsResponse":{ "type":"structure", "members":{ "TagList":{ "shape":"TagList", "documentation":"

List of Tag for the requested Elasticsearch domain.

" } }, "documentation":"

The result of a ListTags operation. Contains tags for all requested Elasticsearch domains.

" }, "OptionState":{ "type":"string", "documentation":"

The state of a requested change. One of the following:

  • Processing: The request change is still in-process.
  • Active: The request change is processed and deployed to the Elasticsearch domain.
", "enum":[ "RequiresIndexDocuments", "Processing", "Active" ] }, "OptionStatus":{ "type":"structure", "required":[ "CreationDate", "UpdateDate", "State" ], "members":{ "CreationDate":{ "shape":"UpdateTimestamp", "documentation":"

Timestamp which tells the creation date for the entity.

" }, "UpdateDate":{ "shape":"UpdateTimestamp", "documentation":"

Timestamp which tells the last updated time for the entity.

" }, "UpdateVersion":{ "shape":"UIntValue", "documentation":"

Specifies the latest version for the entity.

" }, "State":{ "shape":"OptionState", "documentation":"

Provides the OptionState for the Elasticsearch domain.

" }, "PendingDeletion":{ "shape":"Boolean", "documentation":"

Indicates whether the Elasticsearch domain is being deleted.

" } }, "documentation":"

Provides the current status of the entity.

" }, "PolicyDocument":{ "type":"string", "documentation":"

Access policy rules for an Elasticsearch domain service endpoints. For more information, see Configuring Access Policies in the Amazon Elasticsearch Service Developer Guide. The maximum size of a policy document is 100 KB.

" }, "RemoveTagsRequest":{ "type":"structure", "required":[ "ARN", "TagKeys" ], "members":{ "ARN":{ "shape":"ARN", "documentation":"

Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags.

" }, "TagKeys":{ "shape":"StringList", "documentation":"

Specifies the TagKey list which you want to remove from the Elasticsearch domain.

" } }, "documentation":"

Container for the parameters to the RemoveTags operation. Specify the ARN for the Elasticsearch domain from which you want to remove the specified TagKey.

" }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ }, "documentation":"

An exception for creating a resource that already exists. Gives http status code of 400.

", "error":{"httpStatusCode":409}, "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

", "error":{"httpStatusCode":409}, "exception":true }, "ServiceUrl":{ "type":"string", "documentation":"

The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com.

" }, "SnapshotOptions":{ "type":"structure", "members":{ "AutomatedSnapshotStartHour":{ "shape":"IntegerClass", "documentation":"

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

" } }, "documentation":"

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

" }, "SnapshotOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"SnapshotOptions", "documentation":"

Specifies the daily snapshot options specified for the Elasticsearch domain.

" }, "Status":{ "shape":"OptionStatus", "documentation":"

Specifies the status of a daily automated snapshot.

" } }, "documentation":"

Status of a daily automated snapshot.

" }, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"String"} }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

" }, "Value":{ "shape":"TagValue", "documentation":"

Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

" } }, "documentation":"

Specifies a key value pair for a resource tag.

" }, "TagKey":{ "type":"string", "documentation":"

A string of length from 1 to 128 characters that specifies the key for a Tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

", "max":128, "min":1 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "documentation":"

A list of Tag

" }, "TagValue":{ "type":"string", "documentation":"

A string of length from 0 to 256 characters that specifies the value for a Tag. Tag values can be null and do not have to be unique in a tag set.

", "max":256, "min":0 }, "UIntValue":{ "type":"integer", "min":0 }, "UpdateElasticsearchDomainConfigRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the Elasticsearch domain that you are updating.

", "location":"uri", "locationName":"DomainName" }, "ElasticsearchClusterConfig":{ "shape":"ElasticsearchClusterConfig", "documentation":"

The type and number of instances to instantiate for the domain cluster.

" }, "EBSOptions":{ "shape":"EBSOptions", "documentation":"

Specify the type and size of the EBS volume that you want to use.

" }, "SnapshotOptions":{ "shape":"SnapshotOptions", "documentation":"

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

" }, "AdvancedOptions":{ "shape":"AdvancedOptions", "documentation":"

Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

" }, "AccessPolicies":{ "shape":"PolicyDocument", "documentation":"

IAM access policy as a JSON-formatted string.

" } }, "documentation":"

Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number of instances in the domain cluster.

" }, "UpdateElasticsearchDomainConfigResponse":{ "type":"structure", "required":["DomainConfig"], "members":{ "DomainConfig":{ "shape":"ElasticsearchDomainConfig", "documentation":"

The status of the updated Elasticsearch domain.

" } }, "documentation":"

The result of an UpdateElasticsearchDomain request. Contains the status of the Elasticsearch domain being updated.

" }, "UpdateTimestamp":{"type":"timestamp"}, "ValidationException":{ "type":"structure", "members":{ }, "documentation":"

An exception for missing / invalid input fields. Gives http status code of 400.

", "error":{"httpStatusCode":400}, "exception":true }, "VolumeType":{ "type":"string", "documentation":"

The type of EBS volume, standard, gp2, or io1. See Configuring EBS-based Storagefor more information.

", "enum":[ "standard", "gp2", "io1" ] } }, "documentation":"Amazon Elasticsearch Configuration Service

Use the Amazon Elasticsearch configuration API to create, configure, and manage Elasticsearch domains.

The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

" } botocore-1.5.7/botocore/data/importexport/0000777454262600001440000000000013042511307021707 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/importexport/2010-06-01/0000777454262600001440000000000013042511307022732 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/importexport/2010-06-01/paginators-1.json0000666454262600001440000000032713042511306026133 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListJobs": { "input_token": "Marker", "output_token": "Jobs[-1].JobId", "more_results": "IsTruncated", "limit_key": "MaxJobs", "result_key": "Jobs" } } } botocore-1.5.7/botocore/data/importexport/2010-06-01/service-2.json0000666454262600001440000010141613042511306025426 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"importexport-2010-06-01", "apiVersion":"2010-06-01", "endpointPrefix":"importexport", "globalEndpoint":"importexport.amazonaws.com", "serviceFullName":"AWS Import/Export", "signatureVersion":"v2", "xmlNamespace":"http://importexport.amazonaws.com/doc/2010-06-01/", "protocol":"query" }, "documentation":"AWS Import/Export Service AWS Import/Export accelerates transferring large amounts of data between the AWS cloud and portable storage devices that you mail to us. AWS Import/Export transfers data directly onto and off of your storage devices using Amazon's high-speed internal network and bypassing the Internet. For large data sets, AWS Import/Export is often faster than Internet transfer and more cost effective than upgrading your connectivity.", "operations":{ "CancelJob":{ "name":"CancelJob", "http":{ "method":"POST", "requestUri":"/?Operation=CancelJob" }, "input":{ "shape":"CancelJobInput", "documentation":"Input structure for the CancelJob operation." }, "output":{ "shape":"CancelJobOutput", "documentation":"Output structure for the CancelJob operation.", "resultWrapper":"CancelJobResult" }, "errors":[ { "shape":"InvalidJobIdException", "exception":true, "documentation":"The JOBID was missing, not found, or not associated with the AWS account." }, { "shape":"ExpiredJobIdException", "exception":true, "documentation":"Indicates that the specified job has expired out of the system." }, { "shape":"CanceledJobIdException", "exception":true, "documentation":"The specified job ID has been canceled and is no longer valid." }, { "shape":"UnableToCancelJobIdException", "exception":true, "documentation":"AWS Import/Export cannot cancel the job" }, { "shape":"InvalidAccessKeyIdException", "exception":true, "documentation":"The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID." }, { "shape":"InvalidVersionException", "exception":true, "documentation":"The client tool version is invalid." } ], "documentation":"This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete." }, "CreateJob":{ "name":"CreateJob", "http":{ "method":"POST", "requestUri":"/?Operation=CreateJob" }, "input":{ "shape":"CreateJobInput", "documentation":"Input structure for the CreateJob operation." }, "output":{ "shape":"CreateJobOutput", "documentation":"Output structure for the CreateJob operation.", "resultWrapper":"CreateJobResult" }, "errors":[ { "shape":"MissingParameterException", "exception":true, "documentation":"One or more required parameters was missing from the request." }, { "shape":"InvalidParameterException", "exception":true, "documentation":"One or more parameters had an invalid value." }, { "shape":"InvalidAccessKeyIdException", "exception":true, "documentation":"The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID." }, { "shape":"InvalidAddressException", "exception":true, "documentation":"The address specified in the manifest is invalid." }, { "shape":"InvalidManifestFieldException", "exception":true, "documentation":"One or more manifest fields was invalid. Please correct and resubmit." }, { "shape":"MissingManifestFieldException", "exception":true, "documentation":"One or more required fields were missing from the manifest file. Please correct and resubmit." }, { "shape":"NoSuchBucketException", "exception":true, "documentation":"The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to." }, { "shape":"MissingCustomsException", "exception":true, "documentation":"One or more required customs parameters was missing from the manifest." }, { "shape":"InvalidCustomsException", "exception":true, "documentation":"One or more customs parameters was invalid. Please correct and resubmit." }, { "shape":"InvalidFileSystemException", "exception":true, "documentation":"File system specified in export manifest is invalid." }, { "shape":"MultipleRegionsException", "exception":true, "documentation":"Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit." }, { "shape":"BucketPermissionException", "exception":true, "documentation":"The account specified does not have the appropriate bucket permissions." }, { "shape":"MalformedManifestException", "exception":true, "documentation":"Your manifest is not well-formed." }, { "shape":"CreateJobQuotaExceededException", "exception":true, "documentation":"Each account can create only a certain number of jobs per day. If you need to create more than this, please contact awsimportexport@amazon.com to explain your particular use case." }, { "shape":"InvalidJobIdException", "exception":true, "documentation":"The JOBID was missing, not found, or not associated with the AWS account." }, { "shape":"InvalidVersionException", "exception":true, "documentation":"The client tool version is invalid." } ], "documentation":"This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device." }, "GetShippingLabel":{ "name":"GetShippingLabel", "http":{ "method":"POST", "requestUri":"/?Operation=GetShippingLabel" }, "input":{"shape":"GetShippingLabelInput"}, "output":{ "shape":"GetShippingLabelOutput", "resultWrapper":"GetShippingLabelResult" }, "errors":[ { "shape":"InvalidJobIdException", "exception":true, "documentation":"The JOBID was missing, not found, or not associated with the AWS account." }, { "shape":"ExpiredJobIdException", "exception":true, "documentation":"Indicates that the specified job has expired out of the system." }, { "shape":"CanceledJobIdException", "exception":true, "documentation":"The specified job ID has been canceled and is no longer valid." }, { "shape":"InvalidAccessKeyIdException", "exception":true, "documentation":"The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID." }, { "shape":"InvalidAddressException", "exception":true, "documentation":"The address specified in the manifest is invalid." }, { "shape":"InvalidVersionException", "exception":true, "documentation":"The client tool version is invalid." }, { "shape":"InvalidParameterException", "exception":true, "documentation":"One or more parameters had an invalid value." } ], "documentation":"This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing." }, "GetStatus":{ "name":"GetStatus", "http":{ "method":"POST", "requestUri":"/?Operation=GetStatus" }, "input":{ "shape":"GetStatusInput", "documentation":"Input structure for the GetStatus operation." }, "output":{ "shape":"GetStatusOutput", "documentation":"Output structure for the GetStatus operation.", "resultWrapper":"GetStatusResult" }, "errors":[ { "shape":"InvalidJobIdException", "exception":true, "documentation":"The JOBID was missing, not found, or not associated with the AWS account." }, { "shape":"ExpiredJobIdException", "exception":true, "documentation":"Indicates that the specified job has expired out of the system." }, { "shape":"CanceledJobIdException", "exception":true, "documentation":"The specified job ID has been canceled and is no longer valid." }, { "shape":"InvalidAccessKeyIdException", "exception":true, "documentation":"The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID." }, { "shape":"InvalidVersionException", "exception":true, "documentation":"The client tool version is invalid." } ], "documentation":"This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own." }, "ListJobs":{ "name":"ListJobs", "http":{ "method":"POST", "requestUri":"/?Operation=ListJobs" }, "input":{ "shape":"ListJobsInput", "documentation":"Input structure for the ListJobs operation." }, "output":{ "shape":"ListJobsOutput", "documentation":"Output structure for the ListJobs operation.", "resultWrapper":"ListJobsResult" }, "errors":[ { "shape":"InvalidParameterException", "exception":true, "documentation":"One or more parameters had an invalid value." }, { "shape":"InvalidAccessKeyIdException", "exception":true, "documentation":"The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID." }, { "shape":"InvalidVersionException", "exception":true, "documentation":"The client tool version is invalid." } ], "documentation":"This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1." }, "UpdateJob":{ "name":"UpdateJob", "http":{ "method":"POST", "requestUri":"/?Operation=UpdateJob" }, "input":{ "shape":"UpdateJobInput", "documentation":"Input structure for the UpateJob operation." }, "output":{ "shape":"UpdateJobOutput", "documentation":"Output structure for the UpateJob operation.", "resultWrapper":"UpdateJobResult" }, "errors":[ { "shape":"MissingParameterException", "exception":true, "documentation":"One or more required parameters was missing from the request." }, { "shape":"InvalidParameterException", "exception":true, "documentation":"One or more parameters had an invalid value." }, { "shape":"InvalidAccessKeyIdException", "exception":true, "documentation":"The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID." }, { "shape":"InvalidAddressException", "exception":true, "documentation":"The address specified in the manifest is invalid." }, { "shape":"InvalidManifestFieldException", "exception":true, "documentation":"One or more manifest fields was invalid. Please correct and resubmit." }, { "shape":"InvalidJobIdException", "exception":true, "documentation":"The JOBID was missing, not found, or not associated with the AWS account." }, { "shape":"MissingManifestFieldException", "exception":true, "documentation":"One or more required fields were missing from the manifest file. Please correct and resubmit." }, { "shape":"NoSuchBucketException", "exception":true, "documentation":"The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to." }, { "shape":"ExpiredJobIdException", "exception":true, "documentation":"Indicates that the specified job has expired out of the system." }, { "shape":"CanceledJobIdException", "exception":true, "documentation":"The specified job ID has been canceled and is no longer valid." }, { "shape":"MissingCustomsException", "exception":true, "documentation":"One or more required customs parameters was missing from the manifest." }, { "shape":"InvalidCustomsException", "exception":true, "documentation":"One or more customs parameters was invalid. Please correct and resubmit." }, { "shape":"InvalidFileSystemException", "exception":true, "documentation":"File system specified in export manifest is invalid." }, { "shape":"MultipleRegionsException", "exception":true, "documentation":"Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit." }, { "shape":"BucketPermissionException", "exception":true, "documentation":"The account specified does not have the appropriate bucket permissions." }, { "shape":"MalformedManifestException", "exception":true, "documentation":"Your manifest is not well-formed." }, { "shape":"UnableToUpdateJobIdException", "exception":true, "documentation":"AWS Import/Export cannot update the job" }, { "shape":"InvalidVersionException", "exception":true, "documentation":"The client tool version is invalid." } ], "documentation":"You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own." } }, "shapes":{ "APIVersion":{ "type":"string", "documentation":"Specifies the version of the client tool." }, "Artifact":{ "type":"structure", "members":{ "Description":{"shape":"Description"}, "URL":{"shape":"URL"} }, "documentation":"A discrete item that contains the description and URL of an artifact (such as a PDF)." }, "ArtifactList":{ "type":"list", "member":{"shape":"Artifact"}, "documentation":"A collection of artifacts." }, "BucketPermissionException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"The account specified does not have the appropriate bucket permissions." }, "CancelJobInput":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{"shape":"JobId"}, "APIVersion":{"shape":"APIVersion"} }, "documentation":"Input structure for the CancelJob operation." }, "CancelJobOutput":{ "type":"structure", "members":{ "Success":{"shape":"Success"} }, "documentation":"Output structure for the CancelJob operation." }, "CanceledJobIdException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"The specified job ID has been canceled and is no longer valid." }, "Carrier":{ "type":"string", "documentation":"Name of the shipping company. This value is included when the LocationCode is \"Returned\"." }, "CreateJobInput":{ "type":"structure", "required":[ "JobType", "Manifest", "ValidateOnly" ], "members":{ "JobType":{"shape":"JobType"}, "Manifest":{"shape":"Manifest"}, "ManifestAddendum":{"shape":"ManifestAddendum"}, "ValidateOnly":{"shape":"ValidateOnly"}, "APIVersion":{"shape":"APIVersion"} }, "documentation":"Input structure for the CreateJob operation." }, "CreateJobOutput":{ "type":"structure", "members":{ "JobId":{"shape":"JobId"}, "JobType":{"shape":"JobType"}, "Signature":{"shape":"Signature"}, "SignatureFileContents":{"shape":"SignatureFileContents"}, "WarningMessage":{"shape":"WarningMessage"}, "ArtifactList":{"shape":"ArtifactList"} }, "documentation":"Output structure for the CreateJob operation." }, "CreateJobQuotaExceededException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"Each account can create only a certain number of jobs per day. If you need to create more than this, please contact awsimportexport@amazon.com to explain your particular use case." }, "CreationDate":{ "type":"timestamp", "documentation":"Timestamp of the CreateJob request in ISO8601 date format. For example \"2010-03-28T20:27:35Z\"." }, "CurrentManifest":{ "type":"string", "documentation":"The last manifest submitted, which will be used to process the job." }, "Description":{ "type":"string", "documentation":"The associated description for this object." }, "ErrorCount":{ "type":"integer", "documentation":"Number of errors. We return this value when the ProgressCode is Success or SuccessWithErrors." }, "ErrorMessage":{ "type":"string", "documentation":"The human-readable description of a particular error." }, "ExpiredJobIdException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"Indicates that the specified job has expired out of the system." }, "GenericString":{"type":"string"}, "GetShippingLabelInput":{ "type":"structure", "required":["jobIds"], "members":{ "jobIds":{"shape":"JobIdList"}, "name":{"shape":"name"}, "company":{"shape":"company"}, "phoneNumber":{"shape":"phoneNumber"}, "country":{"shape":"country"}, "stateOrProvince":{"shape":"stateOrProvince"}, "city":{"shape":"city"}, "postalCode":{"shape":"postalCode"}, "street1":{"shape":"street1"}, "street2":{"shape":"street2"}, "street3":{"shape":"street3"}, "APIVersion":{"shape":"APIVersion"} } }, "GetShippingLabelOutput":{ "type":"structure", "members":{ "ShippingLabelURL":{"shape":"GenericString"}, "Warning":{"shape":"GenericString"} } }, "GetStatusInput":{ "type":"structure", "required":["JobId"], "members":{ "JobId":{"shape":"JobId"}, "APIVersion":{"shape":"APIVersion"} }, "documentation":"Input structure for the GetStatus operation." }, "GetStatusOutput":{ "type":"structure", "members":{ "JobId":{"shape":"JobId"}, "JobType":{"shape":"JobType"}, "LocationCode":{"shape":"LocationCode"}, "LocationMessage":{"shape":"LocationMessage"}, "ProgressCode":{"shape":"ProgressCode"}, "ProgressMessage":{"shape":"ProgressMessage"}, "Carrier":{"shape":"Carrier"}, "TrackingNumber":{"shape":"TrackingNumber"}, "LogBucket":{"shape":"LogBucket"}, "LogKey":{"shape":"LogKey"}, "ErrorCount":{"shape":"ErrorCount"}, "Signature":{"shape":"Signature"}, "SignatureFileContents":{"shape":"Signature"}, "CurrentManifest":{"shape":"CurrentManifest"}, "CreationDate":{"shape":"CreationDate"}, "ArtifactList":{"shape":"ArtifactList"} }, "documentation":"Output structure for the GetStatus operation." }, "InvalidAccessKeyIdException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID." }, "InvalidAddressException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"The address specified in the manifest is invalid." }, "InvalidCustomsException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"One or more customs parameters was invalid. Please correct and resubmit." }, "InvalidFileSystemException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"File system specified in export manifest is invalid." }, "InvalidJobIdException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"The JOBID was missing, not found, or not associated with the AWS account." }, "InvalidManifestFieldException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"One or more manifest fields was invalid. Please correct and resubmit." }, "InvalidParameterException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"One or more parameters had an invalid value." }, "InvalidVersionException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"The client tool version is invalid." }, "IsCanceled":{ "type":"boolean", "documentation":"Indicates whether the job was canceled." }, "IsTruncated":{ "type":"boolean", "documentation":"Indicates whether the list of jobs was truncated. If true, then call ListJobs again using the last JobId element as the marker." }, "Job":{ "type":"structure", "members":{ "JobId":{"shape":"JobId"}, "CreationDate":{"shape":"CreationDate"}, "IsCanceled":{"shape":"IsCanceled"}, "JobType":{"shape":"JobType"} }, "documentation":"Representation of a job returned by the ListJobs operation." }, "JobId":{ "type":"string", "documentation":"A unique identifier which refers to a particular job." }, "JobIdList":{ "type":"list", "member":{"shape":"GenericString"} }, "JobType":{ "type":"string", "enum":[ "Import", "Export" ], "documentation":"Specifies whether the job to initiate is an import or export job." }, "JobsList":{ "type":"list", "member":{"shape":"Job"}, "documentation":"A list container for Jobs returned by the ListJobs operation." }, "ListJobsInput":{ "type":"structure", "members":{ "MaxJobs":{"shape":"MaxJobs"}, "Marker":{"shape":"Marker"}, "APIVersion":{"shape":"APIVersion"} }, "documentation":"Input structure for the ListJobs operation." }, "ListJobsOutput":{ "type":"structure", "members":{ "Jobs":{"shape":"JobsList"}, "IsTruncated":{"shape":"IsTruncated"} }, "documentation":"Output structure for the ListJobs operation." }, "LocationCode":{ "type":"string", "documentation":"A token representing the location of the storage device, such as \"AtAWS\"." }, "LocationMessage":{ "type":"string", "documentation":"A more human readable form of the physical location of the storage device." }, "LogBucket":{ "type":"string", "documentation":"Amazon S3 bucket for user logs." }, "LogKey":{ "type":"string", "documentation":"The key where the user logs were stored." }, "MalformedManifestException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"Your manifest is not well-formed." }, "Manifest":{ "type":"string", "documentation":"The UTF-8 encoded text of the manifest file." }, "ManifestAddendum":{ "type":"string", "documentation":"For internal use only." }, "Marker":{ "type":"string", "documentation":"Specifies the JOBID to start after when listing the jobs created with your account. AWS Import/Export lists your jobs in reverse chronological order. See MaxJobs." }, "MaxJobs":{ "type":"integer", "documentation":"Sets the maximum number of jobs returned in the response. If there are additional jobs that were not returned because MaxJobs was exceeded, the response contains <IsTruncated>true</IsTruncated>. To return the additional jobs, see Marker." }, "MissingCustomsException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"One or more required customs parameters was missing from the manifest." }, "MissingManifestFieldException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"One or more required fields were missing from the manifest file. Please correct and resubmit." }, "MissingParameterException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"One or more required parameters was missing from the request." }, "MultipleRegionsException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit." }, "NoSuchBucketException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to." }, "ProgressCode":{ "type":"string", "documentation":"A token representing the state of the job, such as \"Started\"." }, "ProgressMessage":{ "type":"string", "documentation":"A more human readable form of the job status." }, "Signature":{ "type":"string", "documentation":"An encrypted code used to authenticate the request and response, for example, \"DV+TpDfx1/TdSE9ktyK9k/bDTVI=\". Only use this value is you want to create the signature file yourself. Generally you should use the SignatureFileContents value." }, "SignatureFileContents":{ "type":"string", "documentation":"The actual text of the SIGNATURE file to be written to disk." }, "Success":{ "type":"boolean", "documentation":"Specifies whether (true) or not (false) AWS Import/Export updated your job." }, "TrackingNumber":{ "type":"string", "documentation":"The shipping tracking number assigned by AWS Import/Export to the storage device when it's returned to you. We return this value when the LocationCode is \"Returned\"." }, "URL":{ "type":"string", "documentation":"The URL for a given Artifact." }, "UnableToCancelJobIdException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"AWS Import/Export cannot cancel the job" }, "UnableToUpdateJobIdException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"AWS Import/Export cannot update the job" }, "UpdateJobInput":{ "type":"structure", "required":[ "JobId", "Manifest", "JobType", "ValidateOnly" ], "members":{ "JobId":{"shape":"JobId"}, "Manifest":{"shape":"Manifest"}, "JobType":{"shape":"JobType"}, "ValidateOnly":{"shape":"ValidateOnly"}, "APIVersion":{"shape":"APIVersion"} }, "documentation":"Input structure for the UpateJob operation." }, "UpdateJobOutput":{ "type":"structure", "members":{ "Success":{"shape":"Success"}, "WarningMessage":{"shape":"WarningMessage"}, "ArtifactList":{"shape":"ArtifactList"} }, "documentation":"Output structure for the UpateJob operation." }, "ValidateOnly":{ "type":"boolean", "documentation":"Validate the manifest and parameter values in the request but do not actually create a job." }, "WarningMessage":{ "type":"string", "documentation":"An optional message notifying you of non-fatal issues with the job, such as use of an incompatible Amazon S3 bucket name." }, "city":{ "type":"string", "documentation":"Specifies the name of your city for the return address." }, "company":{ "type":"string", "documentation":"Specifies the name of the company that will ship this package." }, "country":{ "type":"string", "documentation":"Specifies the name of your country for the return address." }, "name":{ "type":"string", "documentation":"Specifies the name of the person responsible for shipping this package." }, "phoneNumber":{ "type":"string", "documentation":"Specifies the phone number of the person responsible for shipping this package." }, "postalCode":{ "type":"string", "documentation":"Specifies the postal code for the return address." }, "stateOrProvince":{ "type":"string", "documentation":"Specifies the name of your state or your province for the return address." }, "street1":{ "type":"string", "documentation":"Specifies the first part of the street address for the return address, for example 1234 Main Street." }, "street2":{ "type":"string", "documentation":"Specifies the optional second part of the street address for the return address, for example Suite 100." }, "street3":{ "type":"string", "documentation":"Specifies the optional third part of the street address for the return address, for example c/o Jane Doe." } }, "examples":{ } } botocore-1.5.7/botocore/data/ds/0000777454262600001440000000000013042511307017541 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ds/2015-04-16/0000777454262600001440000000000013042511307020575 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ds/2015-04-16/service-2.json0000666454262600001440000032655213042511306023303 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-04-16", "endpointPrefix":"ds", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"Directory Service", "serviceFullName":"AWS Directory Service", "signatureVersion":"v4", "targetPrefix":"DirectoryService_20150416", "uid":"ds-2015-04-16" }, "operations":{ "AddIpRoutes":{ "name":"AddIpRoutes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddIpRoutesRequest"}, "output":{"shape":"AddIpRoutesResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"EntityAlreadyExistsException"}, {"shape":"InvalidParameterException"}, {"shape":"DirectoryUnavailableException"}, {"shape":"IpRouteLimitExceededException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC.

Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

" }, "AddTagsToResource":{ "name":"AddTagsToResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsToResourceRequest"}, "output":{"shape":"AddTagsToResourceResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"TagLimitExceededException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.

" }, "CancelSchemaExtension":{ "name":"CancelSchemaExtension", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelSchemaExtensionRequest"}, "output":{"shape":"CancelSchemaExtensionResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema.

" }, "ConnectDirectory":{ "name":"ConnectDirectory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConnectDirectoryRequest"}, "output":{"shape":"ConnectDirectoryResult"}, "errors":[ {"shape":"DirectoryLimitExceededException"}, {"shape":"InvalidParameterException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Creates an AD Connector to connect to an on-premises directory.

Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

" }, "CreateAlias":{ "name":"CreateAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAliasRequest"}, "output":{"shape":"CreateAliasResult"}, "errors":[ {"shape":"EntityAlreadyExistsException"}, {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://<alias>.awsapps.com.

After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

" }, "CreateComputer":{ "name":"CreateComputer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateComputerRequest"}, "output":{"shape":"CreateComputerResult"}, "errors":[ {"shape":"AuthenticationFailedException"}, {"shape":"DirectoryUnavailableException"}, {"shape":"EntityAlreadyExistsException"}, {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"UnsupportedOperationException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Creates a computer account in the specified directory, and joins the computer to the directory.

" }, "CreateConditionalForwarder":{ "name":"CreateConditionalForwarder", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateConditionalForwarderRequest"}, "output":{"shape":"CreateConditionalForwarderResult"}, "errors":[ {"shape":"EntityAlreadyExistsException"}, {"shape":"EntityDoesNotExistException"}, {"shape":"DirectoryUnavailableException"}, {"shape":"InvalidParameterException"}, {"shape":"UnsupportedOperationException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.

" }, "CreateDirectory":{ "name":"CreateDirectory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDirectoryRequest"}, "output":{"shape":"CreateDirectoryResult"}, "errors":[ {"shape":"DirectoryLimitExceededException"}, {"shape":"InvalidParameterException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Creates a Simple AD directory.

Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

" }, "CreateMicrosoftAD":{ "name":"CreateMicrosoftAD", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateMicrosoftADRequest"}, "output":{"shape":"CreateMicrosoftADResult"}, "errors":[ {"shape":"DirectoryLimitExceededException"}, {"shape":"InvalidParameterException"}, {"shape":"ClientException"}, {"shape":"ServiceException"}, {"shape":"UnsupportedOperationException"} ], "documentation":"

Creates a Microsoft AD in the AWS cloud.

Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

" }, "CreateSnapshot":{ "name":"CreateSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSnapshotRequest"}, "output":{"shape":"CreateSnapshotResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"SnapshotLimitExceededException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.

You cannot take snapshots of AD Connector directories.

" }, "CreateTrust":{ "name":"CreateTrust", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTrustRequest"}, "output":{"shape":"CreateTrustResult"}, "errors":[ {"shape":"EntityAlreadyExistsException"}, {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"ClientException"}, {"shape":"ServiceException"}, {"shape":"UnsupportedOperationException"} ], "documentation":"

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.

" }, "DeleteConditionalForwarder":{ "name":"DeleteConditionalForwarder", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteConditionalForwarderRequest"}, "output":{"shape":"DeleteConditionalForwarderResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"DirectoryUnavailableException"}, {"shape":"InvalidParameterException"}, {"shape":"UnsupportedOperationException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Deletes a conditional forwarder that has been set up for your AWS directory.

" }, "DeleteDirectory":{ "name":"DeleteDirectory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDirectoryRequest"}, "output":{"shape":"DeleteDirectoryResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Deletes an AWS Directory Service directory.

Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

" }, "DeleteSnapshot":{ "name":"DeleteSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSnapshotRequest"}, "output":{"shape":"DeleteSnapshotResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Deletes a directory snapshot.

" }, "DeleteTrust":{ "name":"DeleteTrust", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTrustRequest"}, "output":{"shape":"DeleteTrustResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"ClientException"}, {"shape":"ServiceException"}, {"shape":"UnsupportedOperationException"} ], "documentation":"

Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.

" }, "DeregisterEventTopic":{ "name":"DeregisterEventTopic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterEventTopicRequest"}, "output":{"shape":"DeregisterEventTopicResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Removes the specified directory as a publisher to the specified SNS topic.

" }, "DescribeConditionalForwarders":{ "name":"DescribeConditionalForwarders", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConditionalForwardersRequest"}, "output":{"shape":"DescribeConditionalForwardersResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"DirectoryUnavailableException"}, {"shape":"InvalidParameterException"}, {"shape":"UnsupportedOperationException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Obtains information about the conditional forwarders for this account.

If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.

" }, "DescribeDirectories":{ "name":"DescribeDirectories", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDirectoriesRequest"}, "output":{"shape":"DescribeDirectoriesResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Obtains information about the directories that belong to this account.

You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

" }, "DescribeEventTopics":{ "name":"DescribeEventTopics", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventTopicsRequest"}, "output":{"shape":"DescribeEventTopicsResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Obtains information about which SNS topics receive status messages from the specified directory.

If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.

" }, "DescribeSnapshots":{ "name":"DescribeSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotsRequest"}, "output":{"shape":"DescribeSnapshotsResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Obtains information about the directory snapshots that belong to this account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

" }, "DescribeTrusts":{ "name":"DescribeTrusts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTrustsRequest"}, "output":{"shape":"DescribeTrustsResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidNextTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"ClientException"}, {"shape":"ServiceException"}, {"shape":"UnsupportedOperationException"} ], "documentation":"

Obtains information about the trust relationships for this account.

If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.

" }, "DisableRadius":{ "name":"DisableRadius", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableRadiusRequest"}, "output":{"shape":"DisableRadiusResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.

" }, "DisableSso":{ "name":"DisableSso", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableSsoRequest"}, "output":{"shape":"DisableSsoResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InsufficientPermissionsException"}, {"shape":"AuthenticationFailedException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Disables single-sign on for a directory.

" }, "EnableRadius":{ "name":"EnableRadius", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableRadiusRequest"}, "output":{"shape":"EnableRadiusResult"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"EntityAlreadyExistsException"}, {"shape":"EntityDoesNotExistException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.

" }, "EnableSso":{ "name":"EnableSso", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableSsoRequest"}, "output":{"shape":"EnableSsoResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InsufficientPermissionsException"}, {"shape":"AuthenticationFailedException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Enables single sign-on for a directory.

" }, "GetDirectoryLimits":{ "name":"GetDirectoryLimits", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDirectoryLimitsRequest"}, "output":{"shape":"GetDirectoryLimitsResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Obtains directory limit information for the current region.

" }, "GetSnapshotLimits":{ "name":"GetSnapshotLimits", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSnapshotLimitsRequest"}, "output":{"shape":"GetSnapshotLimitsResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Obtains the manual snapshot limits for a directory.

" }, "ListIpRoutes":{ "name":"ListIpRoutes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListIpRoutesRequest"}, "output":{"shape":"ListIpRoutesResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidNextTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Lists the address blocks that you have added to a directory.

" }, "ListSchemaExtensions":{ "name":"ListSchemaExtensions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSchemaExtensionsRequest"}, "output":{"shape":"ListSchemaExtensionsResult"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"EntityDoesNotExistException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Lists all schema extensions applied to a Microsoft AD Directory.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidNextTokenException"}, {"shape":"InvalidParameterException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Lists all tags on a directory.

" }, "RegisterEventTopic":{ "name":"RegisterEventTopic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterEventTopicRequest"}, "output":{"shape":"RegisterEventTopicResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.

" }, "RemoveIpRoutes":{ "name":"RemoveIpRoutes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveIpRoutesRequest"}, "output":{"shape":"RemoveIpRoutesResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"DirectoryUnavailableException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Removes IP address blocks from a directory.

" }, "RemoveTagsFromResource":{ "name":"RemoveTagsFromResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTagsFromResourceRequest"}, "output":{"shape":"RemoveTagsFromResourceResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Removes tags from a directory.

" }, "RestoreFromSnapshot":{ "name":"RestoreFromSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreFromSnapshotRequest"}, "output":{"shape":"RestoreFromSnapshotResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Restores a directory using an existing directory snapshot.

When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.

This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to Active, the restore operation is complete.

" }, "StartSchemaExtension":{ "name":"StartSchemaExtension", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartSchemaExtensionRequest"}, "output":{"shape":"StartSchemaExtensionResult"}, "errors":[ {"shape":"DirectoryUnavailableException"}, {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"SnapshotLimitExceededException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Applies a schema extension to a Microsoft AD directory.

" }, "UpdateConditionalForwarder":{ "name":"UpdateConditionalForwarder", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateConditionalForwarderRequest"}, "output":{"shape":"UpdateConditionalForwarderResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"DirectoryUnavailableException"}, {"shape":"InvalidParameterException"}, {"shape":"UnsupportedOperationException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Updates a conditional forwarder that has been set up for your AWS directory.

" }, "UpdateRadius":{ "name":"UpdateRadius", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateRadiusRequest"}, "output":{"shape":"UpdateRadiusResult"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"EntityDoesNotExistException"}, {"shape":"ClientException"}, {"shape":"ServiceException"} ], "documentation":"

Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.

" }, "VerifyTrust":{ "name":"VerifyTrust", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"VerifyTrustRequest"}, "output":{"shape":"VerifyTrustResult"}, "errors":[ {"shape":"EntityDoesNotExistException"}, {"shape":"InvalidParameterException"}, {"shape":"ClientException"}, {"shape":"ServiceException"}, {"shape":"UnsupportedOperationException"} ], "documentation":"

AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.

This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain.

" } }, "shapes":{ "AccessUrl":{ "type":"string", "max":128, "min":1 }, "AddIpRoutesRequest":{ "type":"structure", "required":[ "DirectoryId", "IpRoutes" ], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

Identifier (ID) of the directory to which to add the address block.

" }, "IpRoutes":{ "shape":"IpRoutes", "documentation":"

IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your on-premises domain.

" }, "UpdateSecurityGroupForDirectoryControllers":{ "shape":"UpdateSecurityGroupForDirectoryControllers", "documentation":"

If set to true, updates the inbound and outbound rules of the security group that has the description: \"AWS created security group for directory ID directory controllers.\" Following are the new rules:

Inbound:

  • Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0

  • Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0

  • Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0

  • Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0

  • Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0

  • Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0

  • Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0

  • Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0

  • Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0

  • Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0

  • Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0

  • Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0

  • Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0

  • Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0

  • Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0

  • Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0

  • Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0

Outbound:

  • Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0

These security rules impact an internal network interface that is not exposed publicly.

" } } }, "AddIpRoutesResult":{ "type":"structure", "members":{ } }, "AddTagsToResourceRequest":{ "type":"structure", "required":[ "ResourceId", "Tags" ], "members":{ "ResourceId":{ "shape":"ResourceId", "documentation":"

Identifier (ID) for the directory to which to add the tag.

" }, "Tags":{ "shape":"Tags", "documentation":"

The tags to be assigned to the directory.

" } } }, "AddTagsToResourceResult":{ "type":"structure", "members":{ } }, "AddedDateTime":{"type":"timestamp"}, "AliasName":{ "type":"string", "max":62, "min":1, "pattern":"^(?!d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*" }, "Attribute":{ "type":"structure", "members":{ "Name":{ "shape":"AttributeName", "documentation":"

The name of the attribute.

" }, "Value":{ "shape":"AttributeValue", "documentation":"

The value of the attribute.

" } }, "documentation":"

Represents a named directory attribute.

" }, "AttributeName":{ "type":"string", "min":1 }, "AttributeValue":{"type":"string"}, "Attributes":{ "type":"list", "member":{"shape":"Attribute"} }, "AuthenticationFailedException":{ "type":"structure", "members":{ "Message":{ "shape":"ExceptionMessage", "documentation":"

The textual message for the exception.

" }, "RequestId":{ "shape":"RequestId", "documentation":"

The identifier of the request that caused the exception.

" } }, "documentation":"

An authentication error occurred.

", "exception":true }, "AvailabilityZone":{"type":"string"}, "AvailabilityZones":{ "type":"list", "member":{"shape":"AvailabilityZone"} }, "CancelSchemaExtensionRequest":{ "type":"structure", "required":[ "DirectoryId", "SchemaExtensionId" ], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory whose schema extension will be canceled.

" }, "SchemaExtensionId":{ "shape":"SchemaExtensionId", "documentation":"

The identifier of the schema extension that will be canceled.

" } } }, "CancelSchemaExtensionResult":{ "type":"structure", "members":{ } }, "CidrIp":{ "type":"string", "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])(\\/([1-9]|[1-2][0-9]|3[0-2]))$" }, "CidrIps":{ "type":"list", "member":{"shape":"CidrIp"} }, "ClientException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{"shape":"RequestId"} }, "documentation":"

A client exception has occurred.

", "exception":true }, "CloudOnlyDirectoriesLimitReached":{"type":"boolean"}, "Computer":{ "type":"structure", "members":{ "ComputerId":{ "shape":"SID", "documentation":"

The identifier of the computer.

" }, "ComputerName":{ "shape":"ComputerName", "documentation":"

The computer name.

" }, "ComputerAttributes":{ "shape":"Attributes", "documentation":"

An array of Attribute objects containing the LDAP attributes that belong to the computer account.

" } }, "documentation":"

Contains information about a computer account in a directory.

" }, "ComputerName":{ "type":"string", "max":15, "min":1 }, "ComputerPassword":{ "type":"string", "max":64, "min":8, "pattern":"[\\u0020-\\u00FF]+", "sensitive":true }, "ConditionalForwarder":{ "type":"structure", "members":{ "RemoteDomainName":{ "shape":"RemoteDomainName", "documentation":"

The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.

" }, "DnsIpAddrs":{ "shape":"DnsIpAddrs", "documentation":"

The IP addresses of the remote DNS server associated with RemoteDomainName. This is the IP address of the DNS server that your conditional forwarder points to.

" }, "ReplicationScope":{ "shape":"ReplicationScope", "documentation":"

The replication scope of the conditional forwarder. The only allowed value is Domain, which will replicate the conditional forwarder to all of the domain controllers for your AWS directory.

" } }, "documentation":"

Points to a remote domain with which you are setting up a trust relationship. Conditional forwarders are required in order to set up a trust relationship with another domain.

" }, "ConditionalForwarders":{ "type":"list", "member":{"shape":"ConditionalForwarder"} }, "ConnectDirectoryRequest":{ "type":"structure", "required":[ "Name", "Password", "Size", "ConnectSettings" ], "members":{ "Name":{ "shape":"DirectoryName", "documentation":"

The fully-qualified name of the on-premises directory, such as corp.example.com.

" }, "ShortName":{ "shape":"DirectoryShortName", "documentation":"

The NetBIOS name of the on-premises directory, such as CORP.

" }, "Password":{ "shape":"ConnectPassword", "documentation":"

The password for the on-premises user account.

" }, "Description":{ "shape":"Description", "documentation":"

A textual description for the directory.

" }, "Size":{ "shape":"DirectorySize", "documentation":"

The size of the directory.

" }, "ConnectSettings":{ "shape":"DirectoryConnectSettings", "documentation":"

A DirectoryConnectSettings object that contains additional information for the operation.

" } }, "documentation":"

Contains the inputs for the ConnectDirectory operation.

" }, "ConnectDirectoryResult":{ "type":"structure", "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the new directory.

" } }, "documentation":"

Contains the results of the ConnectDirectory operation.

" }, "ConnectPassword":{ "type":"string", "max":128, "min":1, "sensitive":true }, "ConnectedDirectoriesLimitReached":{"type":"boolean"}, "CreateAliasRequest":{ "type":"structure", "required":[ "DirectoryId", "Alias" ], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory for which to create the alias.

" }, "Alias":{ "shape":"AliasName", "documentation":"

The requested alias.

The alias must be unique amongst all aliases in AWS. This operation throws an EntityAlreadyExistsException error if the alias already exists.

" } }, "documentation":"

Contains the inputs for the CreateAlias operation.

" }, "CreateAliasResult":{ "type":"structure", "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory.

" }, "Alias":{ "shape":"AliasName", "documentation":"

The alias for the directory.

" } }, "documentation":"

Contains the results of the CreateAlias operation.

" }, "CreateComputerRequest":{ "type":"structure", "required":[ "DirectoryId", "ComputerName", "Password" ], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory in which to create the computer account.

" }, "ComputerName":{ "shape":"ComputerName", "documentation":"

The name of the computer account.

" }, "Password":{ "shape":"ComputerPassword", "documentation":"

A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.

" }, "OrganizationalUnitDistinguishedName":{ "shape":"OrganizationalUnitDN", "documentation":"

The fully-qualified distinguished name of the organizational unit to place the computer account in.

" }, "ComputerAttributes":{ "shape":"Attributes", "documentation":"

An array of Attribute objects that contain any LDAP attributes to apply to the computer account.

" } }, "documentation":"

Contains the inputs for the CreateComputer operation.

" }, "CreateComputerResult":{ "type":"structure", "members":{ "Computer":{ "shape":"Computer", "documentation":"

A Computer object that represents the computer account.

" } }, "documentation":"

Contains the results for the CreateComputer operation.

" }, "CreateConditionalForwarderRequest":{ "type":"structure", "required":[ "DirectoryId", "RemoteDomainName", "DnsIpAddrs" ], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The directory ID of the AWS directory for which you are creating the conditional forwarder.

" }, "RemoteDomainName":{ "shape":"RemoteDomainName", "documentation":"

The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

" }, "DnsIpAddrs":{ "shape":"DnsIpAddrs", "documentation":"

The IP addresses of the remote DNS server associated with RemoteDomainName.

" } }, "documentation":"

Initiates the creation of a conditional forwarder for your AWS Directory Service for Microsoft Active Directory. Conditional forwarders are required in order to set up a trust relationship with another domain.

" }, "CreateConditionalForwarderResult":{ "type":"structure", "members":{ }, "documentation":"

The result of a CreateConditinalForwarder request.

" }, "CreateDirectoryRequest":{ "type":"structure", "required":[ "Name", "Password", "Size" ], "members":{ "Name":{ "shape":"DirectoryName", "documentation":"

The fully qualified name for the directory, such as corp.example.com.

" }, "ShortName":{ "shape":"DirectoryShortName", "documentation":"

The short name of the directory, such as CORP.

" }, "Password":{ "shape":"Password", "documentation":"

The password for the directory administrator. The directory creation process creates a directory administrator account with the username Administrator and this password.

" }, "Description":{ "shape":"Description", "documentation":"

A textual description for the directory.

" }, "Size":{ "shape":"DirectorySize", "documentation":"

The size of the directory.

" }, "VpcSettings":{ "shape":"DirectoryVpcSettings", "documentation":"

A DirectoryVpcSettings object that contains additional information for the operation.

" } }, "documentation":"

Contains the inputs for the CreateDirectory operation.

" }, "CreateDirectoryResult":{ "type":"structure", "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory that was created.

" } }, "documentation":"

Contains the results of the CreateDirectory operation.

" }, "CreateMicrosoftADRequest":{ "type":"structure", "required":[ "Name", "Password", "VpcSettings" ], "members":{ "Name":{ "shape":"DirectoryName", "documentation":"

The fully qualified domain name for the directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable.

" }, "ShortName":{ "shape":"DirectoryShortName", "documentation":"

The NetBIOS name for your domain. A short identifier for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.

" }, "Password":{ "shape":"Password", "documentation":"

The password for the default administrative user named Admin.

" }, "Description":{ "shape":"Description", "documentation":"

A textual description for the directory. This label will appear on the AWS console Directory Details page after the directory is created.

" }, "VpcSettings":{"shape":"DirectoryVpcSettings"} }, "documentation":"

Creates a Microsoft AD in the AWS cloud.

" }, "CreateMicrosoftADResult":{ "type":"structure", "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory that was created.

" } }, "documentation":"

Result of a CreateMicrosoftAD request.

" }, "CreateSnapshotBeforeSchemaExtension":{"type":"boolean"}, "CreateSnapshotRequest":{ "type":"structure", "required":["DirectoryId"], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory of which to take a snapshot.

" }, "Name":{ "shape":"SnapshotName", "documentation":"

The descriptive name to apply to the snapshot.

" } }, "documentation":"

Contains the inputs for the CreateSnapshot operation.

" }, "CreateSnapshotResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"SnapshotId", "documentation":"

The identifier of the snapshot that was created.

" } }, "documentation":"

Contains the results of the CreateSnapshot operation.

" }, "CreateTrustRequest":{ "type":"structure", "required":[ "DirectoryId", "RemoteDomainName", "TrustPassword", "TrustDirection" ], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The Directory ID of the Microsoft AD in the AWS cloud for which to establish the trust relationship.

" }, "RemoteDomainName":{ "shape":"RemoteDomainName", "documentation":"

The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.

" }, "TrustPassword":{ "shape":"TrustPassword", "documentation":"

The trust password. The must be the same password that was used when creating the trust relationship on the external domain.

" }, "TrustDirection":{ "shape":"TrustDirection", "documentation":"

The direction of the trust relationship.

" }, "TrustType":{ "shape":"TrustType", "documentation":"

The trust relationship type.

" }, "ConditionalForwarderIpAddrs":{ "shape":"DnsIpAddrs", "documentation":"

The IP addresses of the remote DNS server associated with RemoteDomainName.

" } }, "documentation":"

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.

" }, "CreateTrustResult":{ "type":"structure", "members":{ "TrustId":{ "shape":"TrustId", "documentation":"

A unique identifier for the trust relationship that was created.

" } }, "documentation":"

The result of a CreateTrust request.

" }, "CreatedDateTime":{"type":"timestamp"}, "DeleteAssociatedConditionalForwarder":{"type":"boolean"}, "DeleteConditionalForwarderRequest":{ "type":"structure", "required":[ "DirectoryId", "RemoteDomainName" ], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The directory ID for which you are deleting the conditional forwarder.

" }, "RemoteDomainName":{ "shape":"RemoteDomainName", "documentation":"

The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.

" } }, "documentation":"

Deletes a conditional forwarder.

" }, "DeleteConditionalForwarderResult":{ "type":"structure", "members":{ }, "documentation":"

The result of a DeleteConditionalForwarder request.

" }, "DeleteDirectoryRequest":{ "type":"structure", "required":["DirectoryId"], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory to delete.

" } }, "documentation":"

Contains the inputs for the DeleteDirectory operation.

" }, "DeleteDirectoryResult":{ "type":"structure", "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The directory identifier.

" } }, "documentation":"

Contains the results of the DeleteDirectory operation.

" }, "DeleteSnapshotRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "SnapshotId":{ "shape":"SnapshotId", "documentation":"

The identifier of the directory snapshot to be deleted.

" } }, "documentation":"

Contains the inputs for the DeleteSnapshot operation.

" }, "DeleteSnapshotResult":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"SnapshotId", "documentation":"

The identifier of the directory snapshot that was deleted.

" } }, "documentation":"

Contains the results of the DeleteSnapshot operation.

" }, "DeleteTrustRequest":{ "type":"structure", "required":["TrustId"], "members":{ "TrustId":{ "shape":"TrustId", "documentation":"

The Trust ID of the trust relationship to be deleted.

" }, "DeleteAssociatedConditionalForwarder":{ "shape":"DeleteAssociatedConditionalForwarder", "documentation":"

Delete a conditional forwarder as part of a DeleteTrustRequest.

" } }, "documentation":"

Deletes the local side of an existing trust relationship between the Microsoft AD in the AWS cloud and the external domain.

" }, "DeleteTrustResult":{ "type":"structure", "members":{ "TrustId":{ "shape":"TrustId", "documentation":"

The Trust ID of the trust relationship that was deleted.

" } }, "documentation":"

The result of a DeleteTrust request.

" }, "DeregisterEventTopicRequest":{ "type":"structure", "required":[ "DirectoryId", "TopicName" ], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The Directory ID to remove as a publisher. This directory will no longer send messages to the specified SNS topic.

" }, "TopicName":{ "shape":"TopicName", "documentation":"

The name of the SNS topic from which to remove the directory as a publisher.

" } }, "documentation":"

Removes the specified directory as a publisher to the specified SNS topic.

" }, "DeregisterEventTopicResult":{ "type":"structure", "members":{ }, "documentation":"

The result of a DeregisterEventTopic request.

" }, "DescribeConditionalForwardersRequest":{ "type":"structure", "required":["DirectoryId"], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The directory ID for which to get the list of associated conditional forwarders.

" }, "RemoteDomainNames":{ "shape":"RemoteDomainNames", "documentation":"

The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned.

" } }, "documentation":"

Describes a conditional forwarder.

" }, "DescribeConditionalForwardersResult":{ "type":"structure", "members":{ "ConditionalForwarders":{ "shape":"ConditionalForwarders", "documentation":"

The list of conditional forwarders that have been created.

" } }, "documentation":"

The result of a DescribeConditionalForwarder request.

" }, "DescribeDirectoriesRequest":{ "type":"structure", "members":{ "DirectoryIds":{ "shape":"DirectoryIds", "documentation":"

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.

" }, "Limit":{ "shape":"Limit", "documentation":"

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

" } }, "documentation":"

Contains the inputs for the DescribeDirectories operation.

" }, "DescribeDirectoriesResult":{ "type":"structure", "members":{ "DirectoryDescriptions":{ "shape":"DirectoryDescriptions", "documentation":"

The list of DirectoryDescription objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDirectories to retrieve the next set of items.

" } }, "documentation":"

Contains the results of the DescribeDirectories operation.

" }, "DescribeEventTopicsRequest":{ "type":"structure", "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all Directory IDs are returned.

" }, "TopicNames":{ "shape":"TopicNames", "documentation":"

A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned.

An empty list results in an InvalidParameterException being thrown.

" } }, "documentation":"

Describes event topics.

" }, "DescribeEventTopicsResult":{ "type":"structure", "members":{ "EventTopics":{ "shape":"EventTopics", "documentation":"

A list of SNS topic names that receive status messages from the specified Directory ID.

" } }, "documentation":"

The result of a DescribeEventTopic request.

" }, "DescribeSnapshotsRequest":{ "type":"structure", "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory for which to retrieve snapshot information.

" }, "SnapshotIds":{ "shape":"SnapshotIds", "documentation":"

A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

" }, "Limit":{ "shape":"Limit", "documentation":"

The maximum number of objects to return.

" } }, "documentation":"

Contains the inputs for the DescribeSnapshots operation.

" }, "DescribeSnapshotsResult":{ "type":"structure", "members":{ "Snapshots":{ "shape":"Snapshots", "documentation":"

The list of Snapshot objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots.

" } }, "documentation":"

Contains the results of the DescribeSnapshots operation.

" }, "DescribeTrustsRequest":{ "type":"structure", "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The Directory ID of the AWS directory that is a part of the requested trust relationship.

" }, "TrustIds":{ "shape":"TrustIds", "documentation":"

A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if this is the first call.

" }, "Limit":{ "shape":"Limit", "documentation":"

The maximum number of objects to return.

" } }, "documentation":"

Describes the trust relationships for a particular Microsoft AD in the AWS cloud. If no input parameters are are provided, such as directory ID or trust ID, this request describes all the trust relationships.

" }, "DescribeTrustsResult":{ "type":"structure", "members":{ "Trusts":{ "shape":"Trusts", "documentation":"

The list of Trust objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeTrusts to retrieve the next set of items.

" } }, "documentation":"

The result of a DescribeTrust request.

" }, "Description":{ "type":"string", "max":128, "min":0, "pattern":"^([a-zA-Z0-9_])[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$" }, "DirectoryConnectSettings":{ "type":"structure", "required":[ "VpcId", "SubnetIds", "CustomerDnsIps", "CustomerUserName" ], "members":{ "VpcId":{ "shape":"VpcId", "documentation":"

The identifier of the VPC in which the AD Connector is created.

" }, "SubnetIds":{ "shape":"SubnetIds", "documentation":"

A list of subnet identifiers in the VPC in which the AD Connector is created.

" }, "CustomerDnsIps":{ "shape":"DnsIpAddrs", "documentation":"

A list of one or more IP addresses of DNS servers or domain controllers in the on-premises directory.

" }, "CustomerUserName":{ "shape":"UserName", "documentation":"

The username of an account in the on-premises directory that is used to connect to the directory. This account must have the following privileges:

  • Read users and groups

  • Create computer objects

  • Join computers to the domain

" } }, "documentation":"

Contains information for the ConnectDirectory operation when an AD Connector directory is being created.

" }, "DirectoryConnectSettingsDescription":{ "type":"structure", "members":{ "VpcId":{ "shape":"VpcId", "documentation":"

The identifier of the VPC that the AD Connector is in.

" }, "SubnetIds":{ "shape":"SubnetIds", "documentation":"

A list of subnet identifiers in the VPC that the AD connector is in.

" }, "CustomerUserName":{ "shape":"UserName", "documentation":"

The username of the service account in the on-premises directory.

" }, "SecurityGroupId":{ "shape":"SecurityGroupId", "documentation":"

The security group identifier for the AD Connector directory.

" }, "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

A list of the Availability Zones that the directory is in.

" }, "ConnectIps":{ "shape":"IpAddrs", "documentation":"

The IP addresses of the AD Connector servers.

" } }, "documentation":"

Contains information about an AD Connector directory.

" }, "DirectoryDescription":{ "type":"structure", "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The directory identifier.

" }, "Name":{ "shape":"DirectoryName", "documentation":"

The fully-qualified name of the directory.

" }, "ShortName":{ "shape":"DirectoryShortName", "documentation":"

The short name of the directory.

" }, "Size":{ "shape":"DirectorySize", "documentation":"

The directory size.

" }, "Alias":{ "shape":"AliasName", "documentation":"

The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.

" }, "AccessUrl":{ "shape":"AccessUrl", "documentation":"

The access URL for the directory, such as http://<alias>.awsapps.com. If no alias has been created for the directory, <alias> is the directory identifier, such as d-XXXXXXXXXX.

" }, "Description":{ "shape":"Description", "documentation":"

The textual description for the directory.

" }, "DnsIpAddrs":{ "shape":"DnsIpAddrs", "documentation":"

The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected.

" }, "Stage":{ "shape":"DirectoryStage", "documentation":"

The current stage of the directory.

" }, "LaunchTime":{ "shape":"LaunchTime", "documentation":"

Specifies when the directory was created.

" }, "StageLastUpdatedDateTime":{ "shape":"LastUpdatedDateTime", "documentation":"

The date and time that the stage was last updated.

" }, "Type":{ "shape":"DirectoryType", "documentation":"

The directory size.

" }, "VpcSettings":{ "shape":"DirectoryVpcSettingsDescription", "documentation":"

A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed AD directory.

" }, "ConnectSettings":{ "shape":"DirectoryConnectSettingsDescription", "documentation":"

A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory.

" }, "RadiusSettings":{ "shape":"RadiusSettings", "documentation":"

A RadiusSettings object that contains information about the RADIUS server configured for this directory.

" }, "RadiusStatus":{ "shape":"RadiusStatus", "documentation":"

The status of the RADIUS MFA server connection.

" }, "StageReason":{ "shape":"StageReason", "documentation":"

Additional information about the directory stage.

" }, "SsoEnabled":{ "shape":"SsoEnabled", "documentation":"

Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.

" } }, "documentation":"

Contains information about an AWS Directory Service directory.

" }, "DirectoryDescriptions":{ "type":"list", "member":{"shape":"DirectoryDescription"}, "documentation":"

A list of directory descriptions.

" }, "DirectoryId":{ "type":"string", "pattern":"^d-[0-9a-f]{10}$" }, "DirectoryIds":{ "type":"list", "member":{"shape":"DirectoryId"}, "documentation":"

A list of directory identifiers.

" }, "DirectoryLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{"shape":"RequestId"} }, "documentation":"

The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.

", "exception":true }, "DirectoryLimits":{ "type":"structure", "members":{ "CloudOnlyDirectoriesLimit":{ "shape":"Limit", "documentation":"

The maximum number of cloud directories allowed in the region.

" }, "CloudOnlyDirectoriesCurrentCount":{ "shape":"Limit", "documentation":"

The current number of cloud directories in the region.

" }, "CloudOnlyDirectoriesLimitReached":{ "shape":"CloudOnlyDirectoriesLimitReached", "documentation":"

Indicates if the cloud directory limit has been reached.

" }, "CloudOnlyMicrosoftADLimit":{ "shape":"Limit", "documentation":"

The maximum number of Microsoft AD directories allowed in the region.

" }, "CloudOnlyMicrosoftADCurrentCount":{ "shape":"Limit", "documentation":"

The current number of Microsoft AD directories in the region.

" }, "CloudOnlyMicrosoftADLimitReached":{ "shape":"CloudOnlyDirectoriesLimitReached", "documentation":"

Indicates if the Microsoft AD directory limit has been reached.

" }, "ConnectedDirectoriesLimit":{ "shape":"Limit", "documentation":"

The maximum number of connected directories allowed in the region.

" }, "ConnectedDirectoriesCurrentCount":{ "shape":"Limit", "documentation":"

The current number of connected directories in the region.

" }, "ConnectedDirectoriesLimitReached":{ "shape":"ConnectedDirectoriesLimitReached", "documentation":"

Indicates if the connected directory limit has been reached.

" } }, "documentation":"

Contains directory limit information for a region.

" }, "DirectoryName":{ "type":"string", "pattern":"^([a-zA-Z0-9]+[\\\\.-])+([a-zA-Z0-9])+$" }, "DirectoryShortName":{ "type":"string", "pattern":"^[^\\\\/:*?\\\"\\<\\>|.]+[^\\\\/:*?\\\"<>|]*$" }, "DirectorySize":{ "type":"string", "enum":[ "Small", "Large" ] }, "DirectoryStage":{ "type":"string", "enum":[ "Requested", "Creating", "Created", "Active", "Inoperable", "Impaired", "Restoring", "RestoreFailed", "Deleting", "Deleted", "Failed" ] }, "DirectoryType":{ "type":"string", "enum":[ "SimpleAD", "ADConnector", "MicrosoftAD" ] }, "DirectoryUnavailableException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{"shape":"RequestId"} }, "documentation":"

The specified directory is unavailable or could not be found.

", "exception":true }, "DirectoryVpcSettings":{ "type":"structure", "required":[ "VpcId", "SubnetIds" ], "members":{ "VpcId":{ "shape":"VpcId", "documentation":"

The identifier of the VPC in which to create the directory.

" }, "SubnetIds":{ "shape":"SubnetIds", "documentation":"

The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service creates a directory server and a DNS server in each of these subnets.

" } }, "documentation":"

Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

" }, "DirectoryVpcSettingsDescription":{ "type":"structure", "members":{ "VpcId":{ "shape":"VpcId", "documentation":"

The identifier of the VPC that the directory is in.

" }, "SubnetIds":{ "shape":"SubnetIds", "documentation":"

The identifiers of the subnets for the directory servers.

" }, "SecurityGroupId":{ "shape":"SecurityGroupId", "documentation":"

The security group identifier for the directory. If the directory was created before 8/1/2014, this is the identifier of the directory members security group that was created when the directory was created. If the directory was created after this date, this value is null.

" }, "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

The list of Availability Zones that the directory is in.

" } }, "documentation":"

Contains information about the directory.

" }, "DisableRadiusRequest":{ "type":"structure", "required":["DirectoryId"], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory for which to disable MFA.

" } }, "documentation":"

Contains the inputs for the DisableRadius operation.

" }, "DisableRadiusResult":{ "type":"structure", "members":{ }, "documentation":"

Contains the results of the DisableRadius operation.

" }, "DisableSsoRequest":{ "type":"structure", "required":["DirectoryId"], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory for which to disable single-sign on.

" }, "UserName":{ "shape":"UserName", "documentation":"

The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name.

If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed.

" }, "Password":{ "shape":"ConnectPassword", "documentation":"

The password of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.

" } }, "documentation":"

Contains the inputs for the DisableSso operation.

" }, "DisableSsoResult":{ "type":"structure", "members":{ }, "documentation":"

Contains the results of the DisableSso operation.

" }, "DnsIpAddrs":{ "type":"list", "member":{"shape":"IpAddr"} }, "EnableRadiusRequest":{ "type":"structure", "required":[ "DirectoryId", "RadiusSettings" ], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory for which to enable MFA.

" }, "RadiusSettings":{ "shape":"RadiusSettings", "documentation":"

A RadiusSettings object that contains information about the RADIUS server.

" } }, "documentation":"

Contains the inputs for the EnableRadius operation.

" }, "EnableRadiusResult":{ "type":"structure", "members":{ }, "documentation":"

Contains the results of the EnableRadius operation.

" }, "EnableSsoRequest":{ "type":"structure", "required":["DirectoryId"], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory for which to enable single-sign on.

" }, "UserName":{ "shape":"UserName", "documentation":"

The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.

If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.

" }, "Password":{ "shape":"ConnectPassword", "documentation":"

The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.

" } }, "documentation":"

Contains the inputs for the EnableSso operation.

" }, "EnableSsoResult":{ "type":"structure", "members":{ }, "documentation":"

Contains the results of the EnableSso operation.

" }, "EndDateTime":{"type":"timestamp"}, "EntityAlreadyExistsException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{"shape":"RequestId"} }, "documentation":"

The specified entity already exists.

", "exception":true }, "EntityDoesNotExistException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{"shape":"RequestId"} }, "documentation":"

The specified entity could not be found.

", "exception":true }, "EventTopic":{ "type":"structure", "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic.

" }, "TopicName":{ "shape":"TopicName", "documentation":"

The name of an AWS SNS topic the receives status messages from the directory.

" }, "TopicArn":{ "shape":"TopicArn", "documentation":"

The SNS topic ARN (Amazon Resource Name).

" }, "CreatedDateTime":{ "shape":"CreatedDateTime", "documentation":"

The date and time of when you associated your directory with the SNS topic.

" }, "Status":{ "shape":"TopicStatus", "documentation":"

The topic registration status.

" } }, "documentation":"

Information about SNS topic and AWS Directory Service directory associations.

" }, "EventTopics":{ "type":"list", "member":{"shape":"EventTopic"} }, "ExceptionMessage":{ "type":"string", "documentation":"

The descriptive message for the exception.

" }, "GetDirectoryLimitsRequest":{ "type":"structure", "members":{ }, "documentation":"

Contains the inputs for the GetDirectoryLimits operation.

" }, "GetDirectoryLimitsResult":{ "type":"structure", "members":{ "DirectoryLimits":{ "shape":"DirectoryLimits", "documentation":"

A DirectoryLimits object that contains the directory limits for the current region.

" } }, "documentation":"

Contains the results of the GetDirectoryLimits operation.

" }, "GetSnapshotLimitsRequest":{ "type":"structure", "required":["DirectoryId"], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

Contains the identifier of the directory to obtain the limits for.

" } }, "documentation":"

Contains the inputs for the GetSnapshotLimits operation.

" }, "GetSnapshotLimitsResult":{ "type":"structure", "members":{ "SnapshotLimits":{ "shape":"SnapshotLimits", "documentation":"

A SnapshotLimits object that contains the manual snapshot limits for the specified directory.

" } }, "documentation":"

Contains the results of the GetSnapshotLimits operation.

" }, "InsufficientPermissionsException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{"shape":"RequestId"} }, "documentation":"

The account does not have sufficient permission to perform the operation.

", "exception":true }, "InvalidNextTokenException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{"shape":"RequestId"} }, "documentation":"

The NextToken value is not valid.

", "exception":true }, "InvalidParameterException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{"shape":"RequestId"} }, "documentation":"

One or more parameters are not valid.

", "exception":true }, "IpAddr":{ "type":"string", "pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$" }, "IpAddrs":{ "type":"list", "member":{"shape":"IpAddr"} }, "IpRoute":{ "type":"structure", "members":{ "CidrIp":{ "shape":"CidrIp", "documentation":"

IP address block using CIDR format, for example 10.0.0.0/24. This is often the address block of the DNS server used for your on-premises domain. For a single IP address use a CIDR address block with /32. For example 10.0.0.0/32.

" }, "Description":{ "shape":"Description", "documentation":"

Description of the address block.

" } }, "documentation":"

IP address block. This is often the address block of the DNS server used for your on-premises domain.

" }, "IpRouteInfo":{ "type":"structure", "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

Identifier (ID) of the directory associated with the IP addresses.

" }, "CidrIp":{ "shape":"CidrIp", "documentation":"

IP address block in the IpRoute.

" }, "IpRouteStatusMsg":{ "shape":"IpRouteStatusMsg", "documentation":"

The status of the IP address block.

" }, "AddedDateTime":{ "shape":"AddedDateTime", "documentation":"

The date and time the address block was added to the directory.

" }, "IpRouteStatusReason":{ "shape":"IpRouteStatusReason", "documentation":"

The reason for the IpRouteStatusMsg.

" }, "Description":{ "shape":"Description", "documentation":"

Description of the IpRouteInfo.

" } }, "documentation":"

Information about one or more IP address blocks.

" }, "IpRouteLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{"shape":"RequestId"} }, "documentation":"

The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.

", "exception":true }, "IpRouteStatusMsg":{ "type":"string", "enum":[ "Adding", "Added", "Removing", "Removed", "AddFailed", "RemoveFailed" ] }, "IpRouteStatusReason":{"type":"string"}, "IpRoutes":{ "type":"list", "member":{"shape":"IpRoute"} }, "IpRoutesInfo":{ "type":"list", "member":{"shape":"IpRouteInfo"} }, "LastUpdatedDateTime":{"type":"timestamp"}, "LaunchTime":{"type":"timestamp"}, "LdifContent":{ "type":"string", "max":500000, "min":1 }, "Limit":{ "type":"integer", "min":0 }, "ListIpRoutesRequest":{ "type":"structure", "required":["DirectoryId"], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

Identifier (ID) of the directory for which you want to retrieve the IP addresses.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call.

" }, "Limit":{ "shape":"Limit", "documentation":"

Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

" } } }, "ListIpRoutesResult":{ "type":"structure", "members":{ "IpRoutesInfo":{ "shape":"IpRoutesInfo", "documentation":"

A list of IpRoutes.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListIpRoutes to retrieve the next set of items.

" } } }, "ListSchemaExtensionsRequest":{ "type":"structure", "required":["DirectoryId"], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory from which to retrieve the schema extension information.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions. Pass null if this is the first call.

" }, "Limit":{ "shape":"Limit", "documentation":"

The maximum number of items to return.

" } } }, "ListSchemaExtensionsResult":{ "type":"structure", "members":{ "SchemaExtensionsInfo":{ "shape":"SchemaExtensionsInfo", "documentation":"

Information about the schema extensions applied to the directory.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListSchemaExtensions to retrieve the next set of items.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceId"], "members":{ "ResourceId":{ "shape":"ResourceId", "documentation":"

Identifier (ID) of the directory for which you want to retrieve tags.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Reserved for future use.

" }, "Limit":{ "shape":"Limit", "documentation":"

Reserved for future use.

" } } }, "ListTagsForResourceResult":{ "type":"structure", "members":{ "Tags":{ "shape":"Tags", "documentation":"

List of tags returned by the ListTagsForResource operation.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Reserved for future use.

" } } }, "ManualSnapshotsLimitReached":{"type":"boolean"}, "NextToken":{"type":"string"}, "OrganizationalUnitDN":{ "type":"string", "max":2000, "min":1 }, "Password":{ "type":"string", "pattern":"(?=^.{8,64}$)((?=.*\\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[^A-Za-z0-9\\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\\s]))^.*", "sensitive":true }, "PortNumber":{ "type":"integer", "max":65535, "min":1025 }, "RadiusAuthenticationProtocol":{ "type":"string", "enum":[ "PAP", "CHAP", "MS-CHAPv1", "MS-CHAPv2" ] }, "RadiusDisplayLabel":{ "type":"string", "max":64, "min":1 }, "RadiusRetries":{ "type":"integer", "max":10, "min":0 }, "RadiusSettings":{ "type":"structure", "members":{ "RadiusServers":{ "shape":"Servers", "documentation":"

An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.

" }, "RadiusPort":{ "shape":"PortNumber", "documentation":"

The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers.

" }, "RadiusTimeout":{ "shape":"RadiusTimeout", "documentation":"

The amount of time, in seconds, to wait for the RADIUS server to respond.

" }, "RadiusRetries":{ "shape":"RadiusRetries", "documentation":"

The maximum number of times that communication with the RADIUS server is attempted.

" }, "SharedSecret":{ "shape":"RadiusSharedSecret", "documentation":"

Not currently used.

" }, "AuthenticationProtocol":{ "shape":"RadiusAuthenticationProtocol", "documentation":"

The protocol specified for your RADIUS endpoints.

" }, "DisplayLabel":{ "shape":"RadiusDisplayLabel", "documentation":"

Not currently used.

" }, "UseSameUsername":{ "shape":"UseSameUsername", "documentation":"

Not currently used.

" } }, "documentation":"

Contains information about a Remote Authentication Dial In User Service (RADIUS) server.

" }, "RadiusSharedSecret":{ "type":"string", "max":512, "min":8, "sensitive":true }, "RadiusStatus":{ "type":"string", "enum":[ "Creating", "Completed", "Failed" ] }, "RadiusTimeout":{ "type":"integer", "max":20, "min":1 }, "RegisterEventTopicRequest":{ "type":"structure", "required":[ "DirectoryId", "TopicName" ], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The Directory ID that will publish status messages to the SNS topic.

" }, "TopicName":{ "shape":"TopicName", "documentation":"

The SNS topic name to which the directory will publish status messages. This SNS topic must be in the same region as the specified Directory ID.

" } }, "documentation":"

Registers a new event topic.

" }, "RegisterEventTopicResult":{ "type":"structure", "members":{ }, "documentation":"

The result of a RegisterEventTopic request.

" }, "RemoteDomainName":{ "type":"string", "pattern":"^([a-zA-Z0-9]+[\\\\.-])+([a-zA-Z0-9])+[.]?$" }, "RemoteDomainNames":{ "type":"list", "member":{"shape":"RemoteDomainName"} }, "RemoveIpRoutesRequest":{ "type":"structure", "required":[ "DirectoryId", "CidrIps" ], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

Identifier (ID) of the directory from which you want to remove the IP addresses.

" }, "CidrIps":{ "shape":"CidrIps", "documentation":"

IP address blocks that you want to remove.

" } } }, "RemoveIpRoutesResult":{ "type":"structure", "members":{ } }, "RemoveTagsFromResourceRequest":{ "type":"structure", "required":[ "ResourceId", "TagKeys" ], "members":{ "ResourceId":{ "shape":"ResourceId", "documentation":"

Identifier (ID) of the directory from which to remove the tag.

" }, "TagKeys":{ "shape":"TagKeys", "documentation":"

The tag key (name) of the tag to be removed.

" } } }, "RemoveTagsFromResourceResult":{ "type":"structure", "members":{ } }, "ReplicationScope":{ "type":"string", "enum":["Domain"] }, "RequestId":{ "type":"string", "documentation":"

The AWS request identifier.

", "pattern":"^([A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12})$" }, "ResourceId":{ "type":"string", "pattern":"^[d]-[0-9a-f]{10}$" }, "RestoreFromSnapshotRequest":{ "type":"structure", "required":["SnapshotId"], "members":{ "SnapshotId":{ "shape":"SnapshotId", "documentation":"

The identifier of the snapshot to restore from.

" } }, "documentation":"

An object representing the inputs for the RestoreFromSnapshot operation.

" }, "RestoreFromSnapshotResult":{ "type":"structure", "members":{ }, "documentation":"

Contains the results of the RestoreFromSnapshot operation.

" }, "SID":{ "type":"string", "max":256, "min":1, "pattern":"[&\\w+-.@]+" }, "SchemaExtensionId":{ "type":"string", "pattern":"^e-[0-9a-f]{10}$" }, "SchemaExtensionInfo":{ "type":"structure", "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory to which the schema extension is applied.

" }, "SchemaExtensionId":{ "shape":"SchemaExtensionId", "documentation":"

The identifier of the schema extension.

" }, "Description":{ "shape":"Description", "documentation":"

A description of the schema extension.

" }, "SchemaExtensionStatus":{ "shape":"SchemaExtensionStatus", "documentation":"

The current status of the schema extension.

" }, "SchemaExtensionStatusReason":{ "shape":"SchemaExtensionStatusReason", "documentation":"

The reason for the SchemaExtensionStatus.

" }, "StartDateTime":{ "shape":"StartDateTime", "documentation":"

The date and time that the schema extension started being applied to the directory.

" }, "EndDateTime":{ "shape":"EndDateTime", "documentation":"

The date and time that the schema extension was completed.

" } }, "documentation":"

Information about a schema extension.

" }, "SchemaExtensionStatus":{ "type":"string", "enum":[ "Initializing", "CreatingSnapshot", "UpdatingSchema", "Replicating", "CancelInProgress", "RollbackInProgress", "Cancelled", "Failed", "Completed" ] }, "SchemaExtensionStatusReason":{"type":"string"}, "SchemaExtensionsInfo":{ "type":"list", "member":{"shape":"SchemaExtensionInfo"} }, "SecurityGroupId":{ "type":"string", "pattern":"^(sg-[0-9a-f]{8})$" }, "Server":{ "type":"string", "max":256, "min":1 }, "Servers":{ "type":"list", "member":{"shape":"Server"} }, "ServiceException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{"shape":"RequestId"} }, "documentation":"

An exception has occurred in AWS Directory Service.

", "exception":true, "fault":true }, "Snapshot":{ "type":"structure", "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The directory identifier.

" }, "SnapshotId":{ "shape":"SnapshotId", "documentation":"

The snapshot identifier.

" }, "Type":{ "shape":"SnapshotType", "documentation":"

The snapshot type.

" }, "Name":{ "shape":"SnapshotName", "documentation":"

The descriptive name of the snapshot.

" }, "Status":{ "shape":"SnapshotStatus", "documentation":"

The snapshot status.

" }, "StartTime":{ "shape":"StartTime", "documentation":"

The date and time that the snapshot was taken.

" } }, "documentation":"

Describes a directory snapshot.

" }, "SnapshotId":{ "type":"string", "pattern":"^s-[0-9a-f]{10}$" }, "SnapshotIds":{ "type":"list", "member":{"shape":"SnapshotId"}, "documentation":"

A list of directory snapshot identifiers.

" }, "SnapshotLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{"shape":"RequestId"} }, "documentation":"

The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.

", "exception":true }, "SnapshotLimits":{ "type":"structure", "members":{ "ManualSnapshotsLimit":{ "shape":"Limit", "documentation":"

The maximum number of manual snapshots allowed.

" }, "ManualSnapshotsCurrentCount":{ "shape":"Limit", "documentation":"

The current number of manual snapshots of the directory.

" }, "ManualSnapshotsLimitReached":{ "shape":"ManualSnapshotsLimitReached", "documentation":"

Indicates if the manual snapshot limit has been reached.

" } }, "documentation":"

Contains manual snapshot limit information for a directory.

" }, "SnapshotName":{ "type":"string", "max":128, "min":0, "pattern":"^([a-zA-Z0-9_])[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$" }, "SnapshotStatus":{ "type":"string", "enum":[ "Creating", "Completed", "Failed" ] }, "SnapshotType":{ "type":"string", "enum":[ "Auto", "Manual" ] }, "Snapshots":{ "type":"list", "member":{"shape":"Snapshot"}, "documentation":"

A list of descriptions of directory snapshots.

" }, "SsoEnabled":{"type":"boolean"}, "StageReason":{"type":"string"}, "StartDateTime":{"type":"timestamp"}, "StartSchemaExtensionRequest":{ "type":"structure", "required":[ "DirectoryId", "CreateSnapshotBeforeSchemaExtension", "LdifContent", "Description" ], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory for which the schema extension will be applied to.

" }, "CreateSnapshotBeforeSchemaExtension":{ "shape":"CreateSnapshotBeforeSchemaExtension", "documentation":"

If true, creates a snapshot of the directory before applying the schema extension.

" }, "LdifContent":{ "shape":"LdifContent", "documentation":"

The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \\n. See the example request below for more details. The file size can be no larger than 1MB.

" }, "Description":{ "shape":"Description", "documentation":"

A description of the schema extension.

" } } }, "StartSchemaExtensionResult":{ "type":"structure", "members":{ "SchemaExtensionId":{ "shape":"SchemaExtensionId", "documentation":"

The identifier of the schema extension that will be applied.

" } } }, "StartTime":{"type":"timestamp"}, "StateLastUpdatedDateTime":{"type":"timestamp"}, "SubnetId":{ "type":"string", "pattern":"^(subnet-[0-9a-f]{8})$" }, "SubnetIds":{ "type":"list", "member":{"shape":"SubnetId"} }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

Required name of the tag. The string value can be Unicode characters and cannot be prefixed with \"aws:\". The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" }, "Value":{ "shape":"TagValue", "documentation":"

The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" } }, "documentation":"

Metadata assigned to a directory consisting of a key-value pair.

" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"} }, "TagLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{"shape":"RequestId"} }, "documentation":"

The maximum allowed number of tags was exceeded.

", "exception":true }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Tags":{ "type":"list", "member":{"shape":"Tag"} }, "TopicArn":{"type":"string"}, "TopicName":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z0-9_-]+" }, "TopicNames":{ "type":"list", "member":{"shape":"TopicName"} }, "TopicStatus":{ "type":"string", "enum":[ "Registered", "Topic not found", "Failed", "Deleted" ] }, "Trust":{ "type":"structure", "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The Directory ID of the AWS directory involved in the trust relationship.

" }, "TrustId":{ "shape":"TrustId", "documentation":"

The unique ID of the trust relationship.

" }, "RemoteDomainName":{ "shape":"RemoteDomainName", "documentation":"

The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship.

" }, "TrustType":{ "shape":"TrustType", "documentation":"

The trust relationship type.

" }, "TrustDirection":{ "shape":"TrustDirection", "documentation":"

The trust relationship direction.

" }, "TrustState":{ "shape":"TrustState", "documentation":"

The trust relationship state.

" }, "CreatedDateTime":{ "shape":"CreatedDateTime", "documentation":"

The date and time that the trust relationship was created.

" }, "LastUpdatedDateTime":{ "shape":"LastUpdatedDateTime", "documentation":"

The date and time that the trust relationship was last updated.

" }, "StateLastUpdatedDateTime":{ "shape":"StateLastUpdatedDateTime", "documentation":"

The date and time that the TrustState was last updated.

" }, "TrustStateReason":{ "shape":"TrustStateReason", "documentation":"

The reason for the TrustState.

" } }, "documentation":"

Describes a trust relationship between an Microsoft AD in the AWS cloud and an external domain.

" }, "TrustDirection":{ "type":"string", "enum":[ "One-Way: Outgoing", "One-Way: Incoming", "Two-Way" ] }, "TrustId":{ "type":"string", "pattern":"^t-[0-9a-f]{10}$" }, "TrustIds":{ "type":"list", "member":{"shape":"TrustId"} }, "TrustPassword":{ "type":"string", "max":128, "min":1, "sensitive":true }, "TrustState":{ "type":"string", "enum":[ "Creating", "Created", "Verifying", "VerifyFailed", "Verified", "Deleting", "Deleted", "Failed" ] }, "TrustStateReason":{"type":"string"}, "TrustType":{ "type":"string", "enum":["Forest"] }, "Trusts":{ "type":"list", "member":{"shape":"Trust"} }, "UnsupportedOperationException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"}, "RequestId":{"shape":"RequestId"} }, "documentation":"

The operation is not supported.

", "exception":true }, "UpdateConditionalForwarderRequest":{ "type":"structure", "required":[ "DirectoryId", "RemoteDomainName", "DnsIpAddrs" ], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The directory ID of the AWS directory for which to update the conditional forwarder.

" }, "RemoteDomainName":{ "shape":"RemoteDomainName", "documentation":"

The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

" }, "DnsIpAddrs":{ "shape":"DnsIpAddrs", "documentation":"

The updated IP addresses of the remote DNS server associated with the conditional forwarder.

" } }, "documentation":"

Updates a conditional forwarder.

" }, "UpdateConditionalForwarderResult":{ "type":"structure", "members":{ }, "documentation":"

The result of an UpdateConditionalForwarder request.

" }, "UpdateRadiusRequest":{ "type":"structure", "required":[ "DirectoryId", "RadiusSettings" ], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the directory for which to update the RADIUS server information.

" }, "RadiusSettings":{ "shape":"RadiusSettings", "documentation":"

A RadiusSettings object that contains information about the RADIUS server.

" } }, "documentation":"

Contains the inputs for the UpdateRadius operation.

" }, "UpdateRadiusResult":{ "type":"structure", "members":{ }, "documentation":"

Contains the results of the UpdateRadius operation.

" }, "UpdateSecurityGroupForDirectoryControllers":{"type":"boolean"}, "UseSameUsername":{"type":"boolean"}, "UserName":{ "type":"string", "min":1, "pattern":"[a-zA-Z0-9._-]+" }, "VerifyTrustRequest":{ "type":"structure", "required":["TrustId"], "members":{ "TrustId":{ "shape":"TrustId", "documentation":"

The unique Trust ID of the trust relationship to verify.

" } }, "documentation":"

Initiates the verification of an existing trust relationship between a Microsoft AD in the AWS cloud and an external domain.

" }, "VerifyTrustResult":{ "type":"structure", "members":{ "TrustId":{ "shape":"TrustId", "documentation":"

The unique Trust ID of the trust relationship that was verified.

" } }, "documentation":"

Result of a VerifyTrust request.

" }, "VpcId":{ "type":"string", "pattern":"^(vpc-[0-9a-f]{8})$" } }, "documentation":"AWS Directory Service

AWS Directory Service is a web service that makes it easy for you to setup and run directories in the AWS cloud, or connect your AWS resources with an existing on-premises Microsoft Active Directory. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS Directory Service and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

" } botocore-1.5.7/botocore/data/rds/0000777454262600001440000000000013042511307017723 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/rds/2014-09-01/0000777454262600001440000000000013042511307020755 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/rds/2014-09-01/waiters-2.json0000666454262600001440000000512513042511306023467 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DBInstanceAvailable": { "delay": 30, "operation": "DescribeDBInstances", "maxAttempts": 60, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "failed", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "incompatible-restore", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "incompatible-parameters", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "incompatible-parameters", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "incompatible-restore", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" } ] }, "DBInstanceDeleted": { "delay": 30, "operation": "DescribeDBInstances", "maxAttempts": 60, "acceptors": [ { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "creating", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "modifying", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "rebooting", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "resetting-master-credentials", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" } ] } } } botocore-1.5.7/botocore/data/rds/2014-09-01/paginators-1.json0000666454262600001440000000602713042511306024161 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeDBEngineVersions": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "DBEngineVersions" }, "DescribeDBInstances": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "DBInstances" }, "DescribeDBLogFiles": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "DescribeDBLogFiles" }, "DescribeDBParameterGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "DBParameterGroups" }, "DescribeDBParameters": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Parameters" }, "DescribeDBSecurityGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "DBSecurityGroups" }, "DescribeDBSnapshots": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "DBSnapshots" }, "DescribeDBSubnetGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "DBSubnetGroups" }, "DescribeEngineDefaultParameters": { "input_token": "Marker", "output_token": "EngineDefaults.Marker", "limit_key": "MaxRecords", "result_key": "EngineDefaults.Parameters" }, "DescribeEventSubscriptions": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "EventSubscriptionsList" }, "DescribeEvents": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Events" }, "DescribeOptionGroupOptions": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "OptionGroupOptions" }, "DescribeOptionGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "OptionGroupsList" }, "DescribeOrderableDBInstanceOptions": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "OrderableDBInstanceOptions" }, "DescribeReservedDBInstances": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReservedDBInstances" }, "DescribeReservedDBInstancesOfferings": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReservedDBInstancesOfferings" }, "DownloadDBLogFilePortion": { "input_token": "Marker", "output_token": "Marker", "limit_key": "NumberOfLines", "more_results": "AdditionalDataPending", "result_key": "LogFileData" } } } botocore-1.5.7/botocore/data/rds/2014-09-01/service-2.json0000666454262600001440000117463413042511306023466 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2014-09-01", "endpointPrefix":"rds", "serviceAbbreviation":"Amazon RDS", "serviceFullName":"Amazon Relational Database Service", "signatureVersion":"v4", "xmlNamespace":"http://rds.amazonaws.com/doc/2014-09-01/", "protocol":"query" }, "documentation":"Amazon Relational Database Service

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a MySQL, PostgreSQL, Microsoft SQL Server, or Oracle database server. This means the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This is an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces may require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. For a summary of the Amazon RDS interfaces, go to Available RDS Interfaces.

", "operations":{ "AddSourceIdentifierToSubscription":{ "name":"AddSourceIdentifierToSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"AddSourceIdentifierToSubscriptionMessage", "documentation":"

" }, "output":{ "shape":"AddSourceIdentifierToSubscriptionResult", "wrapper":true, "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", "resultWrapper":"AddSourceIdentifierToSubscriptionResult" }, "errors":[ { "shape":"SubscriptionNotFoundFault", "error":{ "code":"SubscriptionNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The subscription name does not exist.

" }, { "shape":"SourceNotFoundFault", "error":{ "code":"SourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested source could not be found.

" } ], "documentation":"

Adds a source identifier to an existing RDS event notification subscription.

" }, "AddTagsToResource":{ "name":"AddTagsToResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"AddTagsToResourceMessage", "documentation":"

" }, "errors":[ { "shape":"DBInstanceNotFoundFault", "error":{ "code":"DBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" }, { "shape":"DBSnapshotNotFoundFault", "error":{ "code":"DBSnapshotNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" } ], "documentation":"

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in Condition statement in IAM policy for Amazon RDS.

For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.

" }, "AuthorizeDBSecurityGroupIngress":{ "name":"AuthorizeDBSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"AuthorizeDBSecurityGroupIngressMessage", "documentation":"

" }, "output":{ "shape":"AuthorizeDBSecurityGroupIngressResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

", "resultWrapper":"AuthorizeDBSecurityGroupIngressResult" }, "errors":[ { "shape":"DBSecurityGroupNotFoundFault", "error":{ "code":"DBSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" }, { "shape":"InvalidDBSecurityGroupStateFault", "error":{ "code":"InvalidDBSecurityGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The state of the DB security group does not allow deletion.

" }, { "shape":"AuthorizationAlreadyExistsFault", "error":{ "code":"AuthorizationAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.

" }, { "shape":"AuthorizationQuotaExceededFault", "error":{ "code":"AuthorizationQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

DB security group authorization quota has been reached.

" } ], "documentation":"

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

You cannot authorize ingress from an EC2 security group in one Region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

" }, "CopyDBParameterGroup":{ "name":"CopyDBParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CopyDBParameterGroupMessage", "documentation":"

" }, "output":{ "shape":"CopyDBParameterGroupResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the CreateDBParameterGroup action.

This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

", "resultWrapper":"CopyDBParameterGroupResult" }, "errors":[ { "shape":"DBParameterGroupNotFoundFault", "error":{ "code":"DBParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" }, { "shape":"DBParameterGroupAlreadyExistsFault", "error":{ "code":"DBParameterGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

A DB parameter group with the same name exists.

" }, { "shape":"DBParameterGroupQuotaExceededFault", "error":{ "code":"DBParameterGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of DB parameter groups.

" } ], "documentation":"

Copies the specified DB parameter group.

" }, "CopyDBSnapshot":{ "name":"CopyDBSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CopyDBSnapshotMessage", "documentation":"

" }, "output":{ "shape":"CopyDBSnapshotResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

", "resultWrapper":"CopyDBSnapshotResult" }, "errors":[ { "shape":"DBSnapshotAlreadyExistsFault", "error":{ "code":"DBSnapshotAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

" }, { "shape":"DBSnapshotNotFoundFault", "error":{ "code":"DBSnapshotNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" }, { "shape":"InvalidDBSnapshotStateFault", "error":{ "code":"InvalidDBSnapshotState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The state of the DB snapshot does not allow deletion.

" }, { "shape":"SnapshotQuotaExceededFault", "error":{ "code":"SnapshotQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

" } ], "documentation":"

Copies the specified DBSnapshot. The source DBSnapshot must be in the \"available\" state.

" }, "CopyOptionGroup":{ "name":"CopyOptionGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CopyOptionGroupMessage", "documentation":"

" }, "output":{ "shape":"CopyOptionGroupResult", "wrapper":true, "documentation":"

", "resultWrapper":"CopyOptionGroupResult" }, "errors":[ { "shape":"OptionGroupAlreadyExistsFault", "error":{ "code":"OptionGroupAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The option group you are trying to create already exists.

" }, { "shape":"OptionGroupNotFoundFault", "error":{ "code":"OptionGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified option group could not be found.

" }, { "shape":"OptionGroupQuotaExceededFault", "error":{ "code":"OptionGroupQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The quota of 20 option groups was exceeded for this AWS account.

" } ], "documentation":"

Copies the specified option group.

" }, "CreateDBInstance":{ "name":"CreateDBInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateDBInstanceMessage", "documentation":"

" }, "output":{ "shape":"CreateDBInstanceResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", "resultWrapper":"CreateDBInstanceResult" }, "errors":[ { "shape":"DBInstanceAlreadyExistsFault", "error":{ "code":"DBInstanceAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

User already has a DB instance with the given identifier.

" }, { "shape":"InsufficientDBInstanceCapacityFault", "error":{ "code":"InsufficientDBInstanceCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" }, { "shape":"DBParameterGroupNotFoundFault", "error":{ "code":"DBParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" }, { "shape":"DBSecurityGroupNotFoundFault", "error":{ "code":"DBSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" }, { "shape":"InstanceQuotaExceededFault", "error":{ "code":"InstanceQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" }, { "shape":"StorageQuotaExceededFault", "error":{ "code":"StorageQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" }, { "shape":"DBSubnetGroupNotFoundFault", "error":{ "code":"DBSubnetGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" }, { "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", "error":{ "code":"DBSubnetGroupDoesNotCoverEnoughAZs", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

" }, { "shape":"InvalidSubnet", "error":{ "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" }, { "shape":"InvalidVPCNetworkStateFault", "error":{ "code":"InvalidVPCNetworkStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" }, { "shape":"ProvisionedIopsNotAvailableInAZFault", "error":{ "code":"ProvisionedIopsNotAvailableInAZFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" }, { "shape":"OptionGroupNotFoundFault", "error":{ "code":"OptionGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified option group could not be found.

" }, { "shape":"StorageTypeNotSupportedFault", "error":{ "code":"StorageTypeNotSupported", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

StorageType specified cannot be associated with the DB Instance.

" }, { "shape":"AuthorizationNotFoundFault", "error":{ "code":"AuthorizationNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

RDS may not also be authorized via IAM to perform necessary actions on your behalf.

" } ], "documentation":"

Creates a new DB instance.

" }, "CreateDBInstanceReadReplica":{ "name":"CreateDBInstanceReadReplica", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBInstanceReadReplicaMessage"}, "output":{ "shape":"CreateDBInstanceReadReplicaResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", "resultWrapper":"CreateDBInstanceReadReplicaResult" }, "errors":[ { "shape":"DBInstanceAlreadyExistsFault", "error":{ "code":"DBInstanceAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

User already has a DB instance with the given identifier.

" }, { "shape":"InsufficientDBInstanceCapacityFault", "error":{ "code":"InsufficientDBInstanceCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" }, { "shape":"DBParameterGroupNotFoundFault", "error":{ "code":"DBParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" }, { "shape":"DBSecurityGroupNotFoundFault", "error":{ "code":"DBSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" }, { "shape":"InstanceQuotaExceededFault", "error":{ "code":"InstanceQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" }, { "shape":"StorageQuotaExceededFault", "error":{ "code":"StorageQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" }, { "shape":"DBInstanceNotFoundFault", "error":{ "code":"DBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" }, { "shape":"InvalidDBInstanceStateFault", "error":{ "code":"InvalidDBInstanceState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified DB instance is not in the available state.

" }, { "shape":"DBSubnetGroupNotFoundFault", "error":{ "code":"DBSubnetGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" }, { "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", "error":{ "code":"DBSubnetGroupDoesNotCoverEnoughAZs", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

" }, { "shape":"InvalidSubnet", "error":{ "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" }, { "shape":"InvalidVPCNetworkStateFault", "error":{ "code":"InvalidVPCNetworkStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" }, { "shape":"ProvisionedIopsNotAvailableInAZFault", "error":{ "code":"ProvisionedIopsNotAvailableInAZFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" }, { "shape":"OptionGroupNotFoundFault", "error":{ "code":"OptionGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified option group could not be found.

" }, { "shape":"DBSubnetGroupNotAllowedFault", "error":{ "code":"DBSubnetGroupNotAllowedFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.

" }, { "shape":"InvalidDBSubnetGroupFault", "error":{ "code":"InvalidDBSubnetGroupFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.

" }, { "shape":"StorageTypeNotSupportedFault", "error":{ "code":"StorageTypeNotSupported", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

StorageType specified cannot be associated with the DB Instance.

" } ], "documentation":"

Creates a DB instance that acts as a Read Replica of a source DB instance.

All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.

The source DB instance must have backup retention enabled.

" }, "CreateDBParameterGroup":{ "name":"CreateDBParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateDBParameterGroupMessage", "documentation":"

" }, "output":{ "shape":"CreateDBParameterGroupResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the CreateDBParameterGroup action.

This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

", "resultWrapper":"CreateDBParameterGroupResult" }, "errors":[ { "shape":"DBParameterGroupQuotaExceededFault", "error":{ "code":"DBParameterGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of DB parameter groups.

" }, { "shape":"DBParameterGroupAlreadyExistsFault", "error":{ "code":"DBParameterGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

A DB parameter group with the same name exists.

" } ], "documentation":"

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

" }, "CreateDBSecurityGroup":{ "name":"CreateDBSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateDBSecurityGroupMessage", "documentation":"

" }, "output":{ "shape":"CreateDBSecurityGroupResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

", "resultWrapper":"CreateDBSecurityGroupResult" }, "errors":[ { "shape":"DBSecurityGroupAlreadyExistsFault", "error":{ "code":"DBSecurityGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

A DB security group with the name specified in DBSecurityGroupName already exists.

" }, { "shape":"DBSecurityGroupQuotaExceededFault", "error":{ "code":"QuotaExceeded.DBSecurityGroup", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of DB security groups.

" }, { "shape":"DBSecurityGroupNotSupportedFault", "error":{ "code":"DBSecurityGroupNotSupported", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

A DB security group is not allowed for this action.

" } ], "documentation":"

Creates a new DB security group. DB security groups control access to a DB instance.

" }, "CreateDBSnapshot":{ "name":"CreateDBSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateDBSnapshotMessage", "documentation":"

" }, "output":{ "shape":"CreateDBSnapshotResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

", "resultWrapper":"CreateDBSnapshotResult" }, "errors":[ { "shape":"DBSnapshotAlreadyExistsFault", "error":{ "code":"DBSnapshotAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

" }, { "shape":"InvalidDBInstanceStateFault", "error":{ "code":"InvalidDBInstanceState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified DB instance is not in the available state.

" }, { "shape":"DBInstanceNotFoundFault", "error":{ "code":"DBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" }, { "shape":"SnapshotQuotaExceededFault", "error":{ "code":"SnapshotQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

" } ], "documentation":"

Creates a DBSnapshot. The source DBInstance must be in \"available\" state.

" }, "CreateDBSubnetGroup":{ "name":"CreateDBSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateDBSubnetGroupMessage", "documentation":"

" }, "output":{ "shape":"CreateDBSubnetGroupResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSubnetGroups action.

", "resultWrapper":"CreateDBSubnetGroupResult" }, "errors":[ { "shape":"DBSubnetGroupAlreadyExistsFault", "error":{ "code":"DBSubnetGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

DBSubnetGroupName is already used by an existing DB subnet group.

" }, { "shape":"DBSubnetGroupQuotaExceededFault", "error":{ "code":"DBSubnetGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of DB subnet groups.

" }, { "shape":"DBSubnetQuotaExceededFault", "error":{ "code":"DBSubnetQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

" }, { "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", "error":{ "code":"DBSubnetGroupDoesNotCoverEnoughAZs", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

" }, { "shape":"InvalidSubnet", "error":{ "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" } ], "documentation":"

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

" }, "CreateEventSubscription":{ "name":"CreateEventSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateEventSubscriptionMessage", "documentation":"

" }, "output":{ "shape":"CreateEventSubscriptionResult", "wrapper":true, "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", "resultWrapper":"CreateEventSubscriptionResult" }, "errors":[ { "shape":"EventSubscriptionQuotaExceededFault", "error":{ "code":"EventSubscriptionQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You have reached the maximum number of event subscriptions.

" }, { "shape":"SubscriptionAlreadyExistFault", "error":{ "code":"SubscriptionAlreadyExist", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The supplied subscription name already exists.

" }, { "shape":"SNSInvalidTopicFault", "error":{ "code":"SNSInvalidTopic", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

SNS has responded that there is a problem with the SND topic specified.

" }, { "shape":"SNSNoAuthorizationFault", "error":{ "code":"SNSNoAuthorization", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You do not have permission to publish to the SNS topic ARN.

" }, { "shape":"SNSTopicArnNotFoundFault", "error":{ "code":"SNSTopicArnNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The SNS topic ARN does not exist.

" }, { "shape":"SubscriptionCategoryNotFoundFault", "error":{ "code":"SubscriptionCategoryNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The supplied category does not exist.

" }, { "shape":"SourceNotFoundFault", "error":{ "code":"SourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested source could not be found.

" } ], "documentation":"

Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.

" }, "CreateOptionGroup":{ "name":"CreateOptionGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateOptionGroupMessage", "documentation":"

" }, "output":{ "shape":"CreateOptionGroupResult", "wrapper":true, "documentation":"

", "resultWrapper":"CreateOptionGroupResult" }, "errors":[ { "shape":"OptionGroupAlreadyExistsFault", "error":{ "code":"OptionGroupAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The option group you are trying to create already exists.

" }, { "shape":"OptionGroupQuotaExceededFault", "error":{ "code":"OptionGroupQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The quota of 20 option groups was exceeded for this AWS account.

" } ], "documentation":"

Creates a new option group. You can create up to 20 option groups.

" }, "DeleteDBInstance":{ "name":"DeleteDBInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteDBInstanceMessage", "documentation":"

" }, "output":{ "shape":"DeleteDBInstanceResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", "resultWrapper":"DeleteDBInstanceResult" }, "errors":[ { "shape":"DBInstanceNotFoundFault", "error":{ "code":"DBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" }, { "shape":"InvalidDBInstanceStateFault", "error":{ "code":"InvalidDBInstanceState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified DB instance is not in the available state.

" }, { "shape":"DBSnapshotAlreadyExistsFault", "error":{ "code":"DBSnapshotAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

" }, { "shape":"SnapshotQuotaExceededFault", "error":{ "code":"SnapshotQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

" } ], "documentation":"

The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.

If a final DB snapshot is requested the status of the RDS instance will be \"deleting\" until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.

" }, "DeleteDBParameterGroup":{ "name":"DeleteDBParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteDBParameterGroupMessage", "documentation":"

" }, "errors":[ { "shape":"InvalidDBParameterGroupStateFault", "error":{ "code":"InvalidDBParameterGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The DB parameter group cannot be deleted because it is in use.

" }, { "shape":"DBParameterGroupNotFoundFault", "error":{ "code":"DBParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" } ], "documentation":"

Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.

The specified DB parameter group cannot be associated with any DB instances. " }, "DeleteDBSecurityGroup":{ "name":"DeleteDBSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteDBSecurityGroupMessage", "documentation":"

" }, "errors":[ { "shape":"InvalidDBSecurityGroupStateFault", "error":{ "code":"InvalidDBSecurityGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The state of the DB security group does not allow deletion.

" }, { "shape":"DBSecurityGroupNotFoundFault", "error":{ "code":"DBSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" } ], "documentation":"

Deletes a DB security group.

The specified DB security group must not be associated with any DB instances." }, "DeleteDBSnapshot":{ "name":"DeleteDBSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteDBSnapshotMessage", "documentation":"

" }, "output":{ "shape":"DeleteDBSnapshotResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

", "resultWrapper":"DeleteDBSnapshotResult" }, "errors":[ { "shape":"InvalidDBSnapshotStateFault", "error":{ "code":"InvalidDBSnapshotState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The state of the DB snapshot does not allow deletion.

" }, { "shape":"DBSnapshotNotFoundFault", "error":{ "code":"DBSnapshotNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" } ], "documentation":"

Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.

The DBSnapshot must be in the available state to be deleted." }, "DeleteDBSubnetGroup":{ "name":"DeleteDBSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteDBSubnetGroupMessage", "documentation":"

" }, "errors":[ { "shape":"InvalidDBSubnetGroupStateFault", "error":{ "code":"InvalidDBSubnetGroupStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The DB subnet group cannot be deleted because it is in use.

" }, { "shape":"InvalidDBSubnetStateFault", "error":{ "code":"InvalidDBSubnetStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The DB subnet is not in the available state.

" }, { "shape":"DBSubnetGroupNotFoundFault", "error":{ "code":"DBSubnetGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" } ], "documentation":"

Deletes a DB subnet group.

The specified database subnet group must not be associated with any DB instances." }, "DeleteEventSubscription":{ "name":"DeleteEventSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteEventSubscriptionMessage", "documentation":"

" }, "output":{ "shape":"DeleteEventSubscriptionResult", "wrapper":true, "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", "resultWrapper":"DeleteEventSubscriptionResult" }, "errors":[ { "shape":"SubscriptionNotFoundFault", "error":{ "code":"SubscriptionNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The subscription name does not exist.

" }, { "shape":"InvalidEventSubscriptionStateFault", "error":{ "code":"InvalidEventSubscriptionState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

This error can occur if someone else is modifying a subscription. You should retry the action.

" } ], "documentation":"

Deletes an RDS event notification subscription.

" }, "DeleteOptionGroup":{ "name":"DeleteOptionGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteOptionGroupMessage", "documentation":"

" }, "errors":[ { "shape":"OptionGroupNotFoundFault", "error":{ "code":"OptionGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified option group could not be found.

" }, { "shape":"InvalidOptionGroupStateFault", "error":{ "code":"InvalidOptionGroupStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The option group is not in the available state.

" } ], "documentation":"

Deletes an existing option group.

" }, "DescribeDBEngineVersions":{ "name":"DescribeDBEngineVersions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBEngineVersionsMessage"}, "output":{ "shape":"DBEngineVersionMessage", "documentation":"

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

", "resultWrapper":"DescribeDBEngineVersionsResult" }, "documentation":"

Returns a list of the available DB engines.

" }, "DescribeDBInstances":{ "name":"DescribeDBInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeDBInstancesMessage", "documentation":"

" }, "output":{ "shape":"DBInstanceMessage", "documentation":"

Contains the result of a successful invocation of the DescribeDBInstances action.

", "resultWrapper":"DescribeDBInstancesResult" }, "errors":[ { "shape":"DBInstanceNotFoundFault", "error":{ "code":"DBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" } ], "documentation":"

Returns information about provisioned RDS instances. This API supports pagination.

" }, "DescribeDBLogFiles":{ "name":"DescribeDBLogFiles", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeDBLogFilesMessage", "documentation":"

" }, "output":{ "shape":"DescribeDBLogFilesResponse", "documentation":"

The response from a call to DescribeDBLogFiles.

", "resultWrapper":"DescribeDBLogFilesResult" }, "errors":[ { "shape":"DBInstanceNotFoundFault", "error":{ "code":"DBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" } ], "documentation":"

Returns a list of DB log files for the DB instance.

" }, "DescribeDBParameterGroups":{ "name":"DescribeDBParameterGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeDBParameterGroupsMessage", "documentation":"

" }, "output":{ "shape":"DBParameterGroupsMessage", "documentation":"

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

", "resultWrapper":"DescribeDBParameterGroupsResult" }, "errors":[ { "shape":"DBParameterGroupNotFoundFault", "error":{ "code":"DBParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" } ], "documentation":"

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

" }, "DescribeDBParameters":{ "name":"DescribeDBParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBParametersMessage"}, "output":{ "shape":"DBParameterGroupDetails", "documentation":"

Contains the result of a successful invocation of the DescribeDBParameters action.

", "resultWrapper":"DescribeDBParametersResult" }, "errors":[ { "shape":"DBParameterGroupNotFoundFault", "error":{ "code":"DBParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" } ], "documentation":"

Returns the detailed parameter list for a particular DB parameter group.

" }, "DescribeDBSecurityGroups":{ "name":"DescribeDBSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeDBSecurityGroupsMessage", "documentation":"

" }, "output":{ "shape":"DBSecurityGroupMessage", "documentation":"

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

", "resultWrapper":"DescribeDBSecurityGroupsResult" }, "errors":[ { "shape":"DBSecurityGroupNotFoundFault", "error":{ "code":"DBSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" } ], "documentation":"

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

" }, "DescribeDBSnapshots":{ "name":"DescribeDBSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeDBSnapshotsMessage", "documentation":"

" }, "output":{ "shape":"DBSnapshotMessage", "documentation":"

Contains the result of a successful invocation of the DescribeDBSnapshots action.

", "resultWrapper":"DescribeDBSnapshotsResult" }, "errors":[ { "shape":"DBSnapshotNotFoundFault", "error":{ "code":"DBSnapshotNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" } ], "documentation":"

Returns information about DB snapshots. This API supports pagination.

" }, "DescribeDBSubnetGroups":{ "name":"DescribeDBSubnetGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeDBSubnetGroupsMessage", "documentation":"

" }, "output":{ "shape":"DBSubnetGroupMessage", "documentation":"

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

", "resultWrapper":"DescribeDBSubnetGroupsResult" }, "errors":[ { "shape":"DBSubnetGroupNotFoundFault", "error":{ "code":"DBSubnetGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" } ], "documentation":"

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

" }, "DescribeEngineDefaultParameters":{ "name":"DescribeEngineDefaultParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeEngineDefaultParametersMessage", "documentation":"

" }, "output":{ "shape":"DescribeEngineDefaultParametersResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

", "resultWrapper":"DescribeEngineDefaultParametersResult" }, "documentation":"

Returns the default engine and system parameter information for the specified database engine.

" }, "DescribeEventCategories":{ "name":"DescribeEventCategories", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeEventCategoriesMessage", "documentation":"

" }, "output":{ "shape":"EventCategoriesMessage", "documentation":"

Data returned from the DescribeEventCategories action.

", "resultWrapper":"DescribeEventCategoriesResult" }, "documentation":"

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.

" }, "DescribeEventSubscriptions":{ "name":"DescribeEventSubscriptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeEventSubscriptionsMessage", "documentation":"

" }, "output":{ "shape":"EventSubscriptionsMessage", "documentation":"

Data returned by the DescribeEventSubscriptions action.

", "resultWrapper":"DescribeEventSubscriptionsResult" }, "errors":[ { "shape":"SubscriptionNotFoundFault", "error":{ "code":"SubscriptionNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The subscription name does not exist.

" } ], "documentation":"

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

" }, "DescribeEvents":{ "name":"DescribeEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeEventsMessage", "documentation":"

" }, "output":{ "shape":"EventsMessage", "documentation":"

Contains the result of a successful invocation of the DescribeEvents action.

", "resultWrapper":"DescribeEventsResult" }, "documentation":"

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

" }, "DescribeOptionGroupOptions":{ "name":"DescribeOptionGroupOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeOptionGroupOptionsMessage", "documentation":"

" }, "output":{ "shape":"OptionGroupOptionsMessage", "documentation":"

", "resultWrapper":"DescribeOptionGroupOptionsResult" }, "documentation":"

Describes all available options.

" }, "DescribeOptionGroups":{ "name":"DescribeOptionGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeOptionGroupsMessage", "documentation":"

" }, "output":{ "shape":"OptionGroups", "documentation":"

List of option groups.

", "resultWrapper":"DescribeOptionGroupsResult" }, "errors":[ { "shape":"OptionGroupNotFoundFault", "error":{ "code":"OptionGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified option group could not be found.

" } ], "documentation":"

Describes the available option groups.

" }, "DescribeOrderableDBInstanceOptions":{ "name":"DescribeOrderableDBInstanceOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeOrderableDBInstanceOptionsMessage", "documentation":"

" }, "output":{ "shape":"OrderableDBInstanceOptionsMessage", "documentation":"

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

", "resultWrapper":"DescribeOrderableDBInstanceOptionsResult" }, "documentation":"

Returns a list of orderable DB instance options for the specified engine.

" }, "DescribeReservedDBInstances":{ "name":"DescribeReservedDBInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeReservedDBInstancesMessage", "documentation":"

" }, "output":{ "shape":"ReservedDBInstanceMessage", "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

", "resultWrapper":"DescribeReservedDBInstancesResult" }, "errors":[ { "shape":"ReservedDBInstanceNotFoundFault", "error":{ "code":"ReservedDBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified reserved DB Instance not found.

" } ], "documentation":"

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

" }, "DescribeReservedDBInstancesOfferings":{ "name":"DescribeReservedDBInstancesOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeReservedDBInstancesOfferingsMessage", "documentation":"

" }, "output":{ "shape":"ReservedDBInstancesOfferingMessage", "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

", "resultWrapper":"DescribeReservedDBInstancesOfferingsResult" }, "errors":[ { "shape":"ReservedDBInstancesOfferingNotFoundFault", "error":{ "code":"ReservedDBInstancesOfferingNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

Specified offering does not exist.

" } ], "documentation":"

Lists available reserved DB instance offerings.

" }, "DownloadDBLogFilePortion":{ "name":"DownloadDBLogFilePortion", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DownloadDBLogFilePortionMessage", "documentation":"

" }, "output":{ "shape":"DownloadDBLogFilePortionDetails", "documentation":"

This data type is used as a response element to DownloadDBLogFilePortion.

", "resultWrapper":"DownloadDBLogFilePortionResult" }, "errors":[ { "shape":"DBInstanceNotFoundFault", "error":{ "code":"DBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" } ], "documentation":"

Downloads all or a portion of the specified log file.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ListTagsForResourceMessage", "documentation":"

" }, "output":{ "shape":"TagListMessage", "documentation":"

", "resultWrapper":"ListTagsForResourceResult" }, "errors":[ { "shape":"DBInstanceNotFoundFault", "error":{ "code":"DBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" }, { "shape":"DBSnapshotNotFoundFault", "error":{ "code":"DBSnapshotNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" } ], "documentation":"

Lists all tags on an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.

" }, "ModifyDBInstance":{ "name":"ModifyDBInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ModifyDBInstanceMessage", "documentation":"

" }, "output":{ "shape":"ModifyDBInstanceResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", "resultWrapper":"ModifyDBInstanceResult" }, "errors":[ { "shape":"InvalidDBInstanceStateFault", "error":{ "code":"InvalidDBInstanceState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified DB instance is not in the available state.

" }, { "shape":"InvalidDBSecurityGroupStateFault", "error":{ "code":"InvalidDBSecurityGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The state of the DB security group does not allow deletion.

" }, { "shape":"DBInstanceAlreadyExistsFault", "error":{ "code":"DBInstanceAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

User already has a DB instance with the given identifier.

" }, { "shape":"DBInstanceNotFoundFault", "error":{ "code":"DBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" }, { "shape":"DBSecurityGroupNotFoundFault", "error":{ "code":"DBSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" }, { "shape":"DBParameterGroupNotFoundFault", "error":{ "code":"DBParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" }, { "shape":"InsufficientDBInstanceCapacityFault", "error":{ "code":"InsufficientDBInstanceCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" }, { "shape":"StorageQuotaExceededFault", "error":{ "code":"StorageQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" }, { "shape":"InvalidVPCNetworkStateFault", "error":{ "code":"InvalidVPCNetworkStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" }, { "shape":"ProvisionedIopsNotAvailableInAZFault", "error":{ "code":"ProvisionedIopsNotAvailableInAZFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" }, { "shape":"OptionGroupNotFoundFault", "error":{ "code":"OptionGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified option group could not be found.

" }, { "shape":"DBUpgradeDependencyFailureFault", "error":{ "code":"DBUpgradeDependencyFailure", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The DB upgrade failed because a resource the DB depends on could not be modified.

" }, { "shape":"StorageTypeNotSupportedFault", "error":{ "code":"StorageTypeNotSupported", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

StorageType specified cannot be associated with the DB Instance.

" }, { "shape":"AuthorizationNotFoundFault", "error":{ "code":"AuthorizationNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

RDS may not also be authorized via IAM to perform necessary actions on your behalf.

" } ], "documentation":"

Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

" }, "ModifyDBParameterGroup":{ "name":"ModifyDBParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ModifyDBParameterGroupMessage", "documentation":"

" }, "output":{ "shape":"DBParameterGroupNameMessage", "documentation":"

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

", "resultWrapper":"ModifyDBParameterGroupResult" }, "errors":[ { "shape":"DBParameterGroupNotFoundFault", "error":{ "code":"DBParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" }, { "shape":"InvalidDBParameterGroupStateFault", "error":{ "code":"InvalidDBParameterGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The DB parameter group cannot be deleted because it is in use.

" } ], "documentation":"

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

" }, "ModifyDBSubnetGroup":{ "name":"ModifyDBSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ModifyDBSubnetGroupMessage", "documentation":"

" }, "output":{ "shape":"ModifyDBSubnetGroupResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSubnetGroups action.

", "resultWrapper":"ModifyDBSubnetGroupResult" }, "errors":[ { "shape":"DBSubnetGroupNotFoundFault", "error":{ "code":"DBSubnetGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" }, { "shape":"DBSubnetQuotaExceededFault", "error":{ "code":"DBSubnetQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

" }, { "shape":"SubnetAlreadyInUse", "error":{ "code":"SubnetAlreadyInUse", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The DB subnet is already in use in the Availability Zone.

" }, { "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", "error":{ "code":"DBSubnetGroupDoesNotCoverEnoughAZs", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

" }, { "shape":"InvalidSubnet", "error":{ "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" } ], "documentation":"

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

" }, "ModifyEventSubscription":{ "name":"ModifyEventSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ModifyEventSubscriptionMessage", "documentation":"

" }, "output":{ "shape":"ModifyEventSubscriptionResult", "wrapper":true, "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", "resultWrapper":"ModifyEventSubscriptionResult" }, "errors":[ { "shape":"EventSubscriptionQuotaExceededFault", "error":{ "code":"EventSubscriptionQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You have reached the maximum number of event subscriptions.

" }, { "shape":"SubscriptionNotFoundFault", "error":{ "code":"SubscriptionNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The subscription name does not exist.

" }, { "shape":"SNSInvalidTopicFault", "error":{ "code":"SNSInvalidTopic", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

SNS has responded that there is a problem with the SND topic specified.

" }, { "shape":"SNSNoAuthorizationFault", "error":{ "code":"SNSNoAuthorization", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You do not have permission to publish to the SNS topic ARN.

" }, { "shape":"SNSTopicArnNotFoundFault", "error":{ "code":"SNSTopicArnNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The SNS topic ARN does not exist.

" }, { "shape":"SubscriptionCategoryNotFoundFault", "error":{ "code":"SubscriptionCategoryNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The supplied category does not exist.

" } ], "documentation":"

Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" }, "ModifyOptionGroup":{ "name":"ModifyOptionGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ModifyOptionGroupMessage", "documentation":"

" }, "output":{ "shape":"ModifyOptionGroupResult", "wrapper":true, "documentation":"

", "resultWrapper":"ModifyOptionGroupResult" }, "errors":[ { "shape":"InvalidOptionGroupStateFault", "error":{ "code":"InvalidOptionGroupStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The option group is not in the available state.

" }, { "shape":"OptionGroupNotFoundFault", "error":{ "code":"OptionGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified option group could not be found.

" } ], "documentation":"

Modifies an existing option group.

" }, "PromoteReadReplica":{ "name":"PromoteReadReplica", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"PromoteReadReplicaMessage", "documentation":"

" }, "output":{ "shape":"PromoteReadReplicaResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", "resultWrapper":"PromoteReadReplicaResult" }, "errors":[ { "shape":"InvalidDBInstanceStateFault", "error":{ "code":"InvalidDBInstanceState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified DB instance is not in the available state.

" }, { "shape":"DBInstanceNotFoundFault", "error":{ "code":"DBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" } ], "documentation":"

Promotes a Read Replica DB instance to a standalone DB instance.

We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.

" }, "PurchaseReservedDBInstancesOffering":{ "name":"PurchaseReservedDBInstancesOffering", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"PurchaseReservedDBInstancesOfferingMessage", "documentation":"

" }, "output":{ "shape":"PurchaseReservedDBInstancesOfferingResult", "wrapper":true, "documentation":"

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

", "resultWrapper":"PurchaseReservedDBInstancesOfferingResult" }, "errors":[ { "shape":"ReservedDBInstancesOfferingNotFoundFault", "error":{ "code":"ReservedDBInstancesOfferingNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

Specified offering does not exist.

" }, { "shape":"ReservedDBInstanceAlreadyExistsFault", "error":{ "code":"ReservedDBInstanceAlreadyExists", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

User already has a reservation with the given identifier.

" }, { "shape":"ReservedDBInstanceQuotaExceededFault", "error":{ "code":"ReservedDBInstanceQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would exceed the user's DB Instance quota.

" } ], "documentation":"

Purchases a reserved DB instance offering.

" }, "RebootDBInstance":{ "name":"RebootDBInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"RebootDBInstanceMessage", "documentation":"

" }, "output":{ "shape":"RebootDBInstanceResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", "resultWrapper":"RebootDBInstanceResult" }, "errors":[ { "shape":"InvalidDBInstanceStateFault", "error":{ "code":"InvalidDBInstanceState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified DB instance is not in the available state.

" }, { "shape":"DBInstanceNotFoundFault", "error":{ "code":"DBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" } ], "documentation":"

Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.

If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.

The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.

" }, "RemoveSourceIdentifierFromSubscription":{ "name":"RemoveSourceIdentifierFromSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"RemoveSourceIdentifierFromSubscriptionMessage", "documentation":"

" }, "output":{ "shape":"RemoveSourceIdentifierFromSubscriptionResult", "wrapper":true, "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", "resultWrapper":"RemoveSourceIdentifierFromSubscriptionResult" }, "errors":[ { "shape":"SubscriptionNotFoundFault", "error":{ "code":"SubscriptionNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The subscription name does not exist.

" }, { "shape":"SourceNotFoundFault", "error":{ "code":"SourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested source could not be found.

" } ], "documentation":"

Removes a source identifier from an existing RDS event notification subscription.

" }, "RemoveTagsFromResource":{ "name":"RemoveTagsFromResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"RemoveTagsFromResourceMessage", "documentation":"

" }, "errors":[ { "shape":"DBInstanceNotFoundFault", "error":{ "code":"DBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" }, { "shape":"DBSnapshotNotFoundFault", "error":{ "code":"DBSnapshotNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" } ], "documentation":"

Removes metadata tags from an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.

" }, "ResetDBParameterGroup":{ "name":"ResetDBParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ResetDBParameterGroupMessage", "documentation":"

" }, "output":{ "shape":"DBParameterGroupNameMessage", "documentation":"

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

", "resultWrapper":"ResetDBParameterGroupResult" }, "errors":[ { "shape":"InvalidDBParameterGroupStateFault", "error":{ "code":"InvalidDBParameterGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The DB parameter group cannot be deleted because it is in use.

" }, { "shape":"DBParameterGroupNotFoundFault", "error":{ "code":"DBParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" } ], "documentation":"

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

" }, "RestoreDBInstanceFromDBSnapshot":{ "name":"RestoreDBInstanceFromDBSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"RestoreDBInstanceFromDBSnapshotMessage", "documentation":"

" }, "output":{ "shape":"RestoreDBInstanceFromDBSnapshotResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", "resultWrapper":"RestoreDBInstanceFromDBSnapshotResult" }, "errors":[ { "shape":"DBInstanceAlreadyExistsFault", "error":{ "code":"DBInstanceAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

User already has a DB instance with the given identifier.

" }, { "shape":"DBSnapshotNotFoundFault", "error":{ "code":"DBSnapshotNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" }, { "shape":"InstanceQuotaExceededFault", "error":{ "code":"InstanceQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" }, { "shape":"InsufficientDBInstanceCapacityFault", "error":{ "code":"InsufficientDBInstanceCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" }, { "shape":"InvalidDBSnapshotStateFault", "error":{ "code":"InvalidDBSnapshotState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The state of the DB snapshot does not allow deletion.

" }, { "shape":"StorageQuotaExceededFault", "error":{ "code":"StorageQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" }, { "shape":"InvalidVPCNetworkStateFault", "error":{ "code":"InvalidVPCNetworkStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" }, { "shape":"InvalidRestoreFault", "error":{ "code":"InvalidRestoreFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Cannot restore from vpc backup to non-vpc DB instance.

" }, { "shape":"DBSubnetGroupNotFoundFault", "error":{ "code":"DBSubnetGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" }, { "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", "error":{ "code":"DBSubnetGroupDoesNotCoverEnoughAZs", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

" }, { "shape":"InvalidSubnet", "error":{ "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" }, { "shape":"ProvisionedIopsNotAvailableInAZFault", "error":{ "code":"ProvisionedIopsNotAvailableInAZFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" }, { "shape":"OptionGroupNotFoundFault", "error":{ "code":"OptionGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified option group could not be found.

" }, { "shape":"StorageTypeNotSupportedFault", "error":{ "code":"StorageTypeNotSupported", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

StorageType specified cannot be associated with the DB Instance.

" }, { "shape":"AuthorizationNotFoundFault", "error":{ "code":"AuthorizationNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

RDS may not also be authorized via IAM to perform necessary actions on your behalf.

" } ], "documentation":"

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group.

If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.

" }, "RestoreDBInstanceToPointInTime":{ "name":"RestoreDBInstanceToPointInTime", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"RestoreDBInstanceToPointInTimeMessage", "documentation":"

" }, "output":{ "shape":"RestoreDBInstanceToPointInTimeResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", "resultWrapper":"RestoreDBInstanceToPointInTimeResult" }, "errors":[ { "shape":"DBInstanceAlreadyExistsFault", "error":{ "code":"DBInstanceAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

User already has a DB instance with the given identifier.

" }, { "shape":"DBInstanceNotFoundFault", "error":{ "code":"DBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" }, { "shape":"InstanceQuotaExceededFault", "error":{ "code":"InstanceQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" }, { "shape":"InsufficientDBInstanceCapacityFault", "error":{ "code":"InsufficientDBInstanceCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" }, { "shape":"InvalidDBInstanceStateFault", "error":{ "code":"InvalidDBInstanceState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified DB instance is not in the available state.

" }, { "shape":"PointInTimeRestoreNotEnabledFault", "error":{ "code":"PointInTimeRestoreNotEnabled", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

" }, { "shape":"StorageQuotaExceededFault", "error":{ "code":"StorageQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" }, { "shape":"InvalidVPCNetworkStateFault", "error":{ "code":"InvalidVPCNetworkStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" }, { "shape":"InvalidRestoreFault", "error":{ "code":"InvalidRestoreFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Cannot restore from vpc backup to non-vpc DB instance.

" }, { "shape":"DBSubnetGroupNotFoundFault", "error":{ "code":"DBSubnetGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" }, { "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", "error":{ "code":"DBSubnetGroupDoesNotCoverEnoughAZs", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

" }, { "shape":"InvalidSubnet", "error":{ "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" }, { "shape":"ProvisionedIopsNotAvailableInAZFault", "error":{ "code":"ProvisionedIopsNotAvailableInAZFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" }, { "shape":"OptionGroupNotFoundFault", "error":{ "code":"OptionGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified option group could not be found.

" }, { "shape":"StorageTypeNotSupportedFault", "error":{ "code":"StorageTypeNotSupported", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

StorageType specified cannot be associated with the DB Instance.

" }, { "shape":"AuthorizationNotFoundFault", "error":{ "code":"AuthorizationNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

RDS may not also be authorized via IAM to perform necessary actions on your behalf.

" } ], "documentation":"

Restores a DB instance to an arbitrary point-in-time. Users can restore to any point in time before the LatestRestorableTime for up to BackupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.

" }, "RevokeDBSecurityGroupIngress":{ "name":"RevokeDBSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"RevokeDBSecurityGroupIngressMessage", "documentation":"

" }, "output":{ "shape":"RevokeDBSecurityGroupIngressResult", "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

", "resultWrapper":"RevokeDBSecurityGroupIngressResult" }, "errors":[ { "shape":"DBSecurityGroupNotFoundFault", "error":{ "code":"DBSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" }, { "shape":"AuthorizationNotFoundFault", "error":{ "code":"AuthorizationNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

RDS may not also be authorized via IAM to perform necessary actions on your behalf.

" }, { "shape":"InvalidDBSecurityGroupStateFault", "error":{ "code":"InvalidDBSecurityGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The state of the DB security group does not allow deletion.

" } ], "documentation":"

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

" } }, "shapes":{ "AddSourceIdentifierToSubscriptionMessage":{ "type":"structure", "required":[ "SubscriptionName", "SourceIdentifier" ], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the RDS event notification subscription you want to add a source identifier to.

" }, "SourceIdentifier":{ "shape":"String", "documentation":"

The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
  • If the source type is a DB security group, a DBSecurityGroupName must be supplied.
  • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
  • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
" } }, "documentation":"

" }, "AddTagsToResourceMessage":{ "type":"structure", "required":[ "ResourceName", "Tags" ], "members":{ "ResourceName":{ "shape":"String", "documentation":"

The Amazon RDS resource the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be assigned to the Amazon RDS resource.

" } }, "documentation":"

" }, "ApplyMethod":{ "type":"string", "enum":[ "immediate", "pending-reboot" ] }, "AuthorizationAlreadyExistsFault":{ "type":"structure", "members":{ }, "error":{ "code":"AuthorizationAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.

" }, "AuthorizationNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"AuthorizationNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

RDS may not also be authorized via IAM to perform necessary actions on your behalf.

" }, "AuthorizationQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"AuthorizationQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

DB security group authorization quota has been reached.

" }, "AuthorizeDBSecurityGroupIngressMessage":{ "type":"structure", "required":["DBSecurityGroupName"], "members":{ "DBSecurityGroupName":{ "shape":"String", "documentation":"

The name of the DB security group to add authorization to.

" }, "CIDRIP":{ "shape":"String", "documentation":"

The IP range to authorize.

" }, "EC2SecurityGroupName":{ "shape":"String", "documentation":"

Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" }, "EC2SecurityGroupId":{ "shape":"String", "documentation":"

Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" }, "EC2SecurityGroupOwnerId":{ "shape":"String", "documentation":"

AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" } }, "documentation":"

" }, "AvailabilityZone":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the availability zone.

" } }, "wrapper":true, "documentation":"

Contains Availability Zone information.

This data type is used as an element in the following data type:

" }, "AvailabilityZoneList":{ "type":"list", "member":{ "shape":"AvailabilityZone", "locationName":"AvailabilityZone" } }, "Boolean":{"type":"boolean"}, "BooleanOptional":{"type":"boolean"}, "CharacterSet":{ "type":"structure", "members":{ "CharacterSetName":{ "shape":"String", "documentation":"

The name of the character set.

" }, "CharacterSetDescription":{ "shape":"String", "documentation":"

The description of the character set.

" } }, "documentation":"

This data type is used as a response element in the action DescribeDBEngineVersions.

" }, "CopyDBParameterGroupMessage":{ "type":"structure", "required":[ "SourceDBParameterGroupIdentifier", "TargetDBParameterGroupIdentifier", "TargetDBParameterGroupDescription" ], "members":{ "SourceDBParameterGroupIdentifier":{ "shape":"String", "documentation":"

The identifier or ARN for the source DB parameter group.

Constraints:

  • Must specify a valid DB parameter group.
  • If the source DB parameter group is in the same region as the copy, specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.
  • If the source DB parameter group is in a different region than the copy, specify a valid DB parameter group ARN, for example arn:aws:rds:us-west-2:123456789012:pg:special-parameters.
" }, "TargetDBParameterGroupIdentifier":{ "shape":"String", "documentation":"

The identifier for the copied DB parameter group.

Constraints:

  • Cannot be null, empty, or blank
  • Must contain from 1 to 255 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-db-parameter-group

" }, "TargetDBParameterGroupDescription":{ "shape":"String", "documentation":"

A description for the copied DB parameter group.

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CopyDBSnapshotMessage":{ "type":"structure", "required":[ "SourceDBSnapshotIdentifier", "TargetDBSnapshotIdentifier" ], "members":{ "SourceDBSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier for the source DB snapshot.

Constraints:

  • Must specify a valid system snapshot in the \"available\" state.
  • If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier.
  • If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot.

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805

" }, "TargetDBSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier for the copied snapshot.

Constraints:

  • Cannot be null, empty, or blank
  • Must contain from 1 to 255 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CopyOptionGroupMessage":{ "type":"structure", "required":[ "SourceOptionGroupIdentifier", "TargetOptionGroupIdentifier", "TargetOptionGroupDescription" ], "members":{ "SourceOptionGroupIdentifier":{ "shape":"String", "documentation":"

The identifier or ARN for the source option group.

Constraints:

  • Must specify a valid option group.
  • If the source option group is in the same region as the copy, specify a valid option group identifier, for example my-option-group, or a valid ARN.
  • If the source option group is in a different region than the copy, specify a valid option group ARN, for example arn:aws:rds:us-west-2:123456789012:og:special-options.
" }, "TargetOptionGroupIdentifier":{ "shape":"String", "documentation":"

The identifier for the copied option group.

Constraints:

  • Cannot be null, empty, or blank
  • Must contain from 1 to 255 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-option-group

" }, "TargetOptionGroupDescription":{ "shape":"String", "documentation":"

The description for the copied option group.

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CreateDBInstanceMessage":{ "type":"structure", "required":[ "DBInstanceIdentifier", "AllocatedStorage", "DBInstanceClass", "Engine", "MasterUsername", "MasterUserPassword" ], "members":{ "DBName":{ "shape":"String", "documentation":"

The meaning of this parameter differs according to the database engine you use.

Type: String

MySQL

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 alphanumeric characters
  • Cannot be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 63 alphanumeric characters
  • Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
  • Cannot be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance.

Default: ORCL

Constraints:

  • Cannot be longer than 8 characters

SQL Server

Not applicable. Must be null.

" }, "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).
  • First character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

" }, "AllocatedStorage":{ "shape":"IntegerOptional", "documentation":"

The amount of storage (in gigabytes) to be initially allocated for the database instance.

Type: Integer

MySQL

Constraints: Must be an integer from 5 to 3072.

PostgreSQL

Constraints: Must be an integer from 5 to 3072.

Oracle

Constraints: Must be an integer from 10 to 3072.

SQL Server

Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 20 to 1024 (Express Edition and Web Edition)

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The compute and memory capacity of the DB instance.

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 | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

" }, "Engine":{ "shape":"String", "documentation":"

The name of the database engine to be used for this instance.

Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres

Not every database engine is available for every AWS region.

" }, "MasterUsername":{ "shape":"String", "documentation":"

The name of master user for the client DB instance.

MySQL

Constraints:

  • Must be 1 to 16 alphanumeric characters.
  • First character must be a letter.
  • Cannot be a reserved word for the chosen database engine.

Type: String

Oracle

Constraints:

  • Must be 1 to 30 alphanumeric characters.
  • First character must be a letter.
  • Cannot be a reserved word for the chosen database engine.

SQL Server

Constraints:

  • Must be 1 to 128 alphanumeric characters.
  • First character must be a letter.
  • Cannot be a reserved word for the chosen database engine.
" }, "MasterUserPassword":{ "shape":"String", "documentation":"

The password for the master database user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".

Type: String

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

SQL Server

Constraints: Must contain from 8 to 128 characters.

" }, "DBSecurityGroups":{ "shape":"DBSecurityGroupNameList", "documentation":"

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see Regions and Availability Zones.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range (in UTC) during which system maintenance can occur. For more information, see DB Instance Maintenance.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

" }, "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.

Constraints:

  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

  • Must be a value from 0 to 35
  • Cannot be set to 0 if the DB instance is a source to Read Replicas
" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see DB Instance Backups.

Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

PostgreSQL

Default: 5432

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the database engine to use.

The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.

MySQL

  • Version 5.1: 5.1.45 | 5.1.49 | 5.1.50 | 5.1.57 | 5.1.61 | 5.1.62 | 5.1.63 | 5.1.69 | 5.1.71 | 5.1.73
  • Version 5.5: 5.5.12 | 5.5.20 | 5.5.23 | 5.5.25a | 5.5.27 | 5.5.31 | 5.5.33 | 5.5.37 | 5.5.38 | 5.5.8
  • Version 5.6: 5.6.12 | 5.6.13 | 5.6.17 | 5.6.19 | 5.6.21

Oracle Database Enterprise Edition (oracle-ee)

  • Version 11.2: 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7 | 11.2.0.3.v1 | 11.2.0.4.v1

Oracle Database Standard Edition (oracle-se)

  • Version 11.2: 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7 | 11.2.0.3.v1 | 11.2.0.4.v1

Oracle Database Standard Edition One (oracle-se1)

  • Version 11.2: 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7 | 11.2.0.3.v1 | 11.2.0.4.v1

PostgreSQL

  • Version 9.3: 9.3.1 | 9.3.2 | 9.3.3

Microsoft SQL Server Enterprise Edition (sqlserver-ee)

  • Version 10.5: 10.50.2789.0.v1
  • Version 11.0: 11.00.2100.60.v1

Microsoft SQL Server Express Edition (sqlserver-ex)

  • Version 10.5: 10.50.2789.0.v1
  • Version 11.0: 11.00.2100.60.v1

Microsoft SQL Server Standard Edition (sqlserver-se)

  • Version 10.5: 10.50.2789.0.v1
  • Version 11.0: 11.00.2100.60.v1

Microsoft SQL Server Web Edition (sqlserver-web)

  • Version 10.5: 10.50.2789.0.v1
  • Version 11.0: 11.00.2100.60.v1
" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.

Default: true

" }, "LicenseModel":{ "shape":"String", "documentation":"

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Constraints: To use PIOPS, this value must be an integer greater than 1000.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, 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

" }, "CharacterSetName":{ "shape":"String", "documentation":"

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

" }, "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

  • Default VPC:true
  • VPC:false

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. 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.

" }, "Tags":{"shape":"TagList"}, "StorageType":{ "shape":"String", "documentation":"

Specifies storage type to be associated with the DB Instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

" }, "TdeCredentialArn":{ "shape":"String", "documentation":"

The ARN from the Key Store with which to associate the instance for TDE encryption.

" }, "TdeCredentialPassword":{ "shape":"String", "documentation":"

The password for the given ARN from the Key Store in order to access the device.

" } }, "documentation":"

" }, "CreateDBInstanceReadReplicaMessage":{ "type":"structure", "required":[ "DBInstanceIdentifier", "SourceDBInstanceIdentifier" ], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier of the Read Replica. This is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

" }, "SourceDBInstanceIdentifier":{ "shape":"String", "documentation":"

The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.

Constraints:

  • Must be the identifier of an existing DB instance.
  • Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.
  • Can specify a DB instance that is a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5.
  • The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
  • If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.
  • If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The compute and memory capacity of the Read Replica.

Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

Default: Inherits from the source DB instance.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Amazon EC2 Availability Zone that the Read Replica will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB instance

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.

" }, "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

  • Default VPC:true
  • VPC:false

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. 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.

" }, "Tags":{"shape":"TagList"}, "DBSubnetGroupName":{ "shape":"String", "documentation":"

Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.

Constraints:

  • Can only be specified if the source DB instance identifier specifies a DB instance in another region.
  • The specified DB subnet group must be in the same region in which the operation is running.
  • All Read Replicas in one region that are created from the same source DB instance must either:
    • Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.
    • Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.
" }, "StorageType":{ "shape":"String", "documentation":"

Specifies storage type to be associated with the DB Instance Read Replica.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

" } } }, "CreateDBParameterGroupMessage":{ "type":"structure", "required":[ "DBParameterGroupName", "DBParameterGroupFamily", "Description" ], "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB parameter group.

Constraints:

  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
This value is stored as a lower-case string." }, "DBParameterGroupFamily":{ "shape":"String", "documentation":"

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

" }, "Description":{ "shape":"String", "documentation":"

The description for the DB parameter group.

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CreateDBSecurityGroupMessage":{ "type":"structure", "required":[ "DBSecurityGroupName", "DBSecurityGroupDescription" ], "members":{ "DBSecurityGroupName":{ "shape":"String", "documentation":"

The name for the DB security group. This value is stored as a lowercase string.

Constraints:

  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
  • Must not be \"Default\"
  • May not contain spaces

Example: mysecuritygroup

" }, "DBSecurityGroupDescription":{ "shape":"String", "documentation":"

The description for the DB security group.

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CreateDBSnapshotMessage":{ "type":"structure", "required":[ "DBSnapshotIdentifier", "DBInstanceIdentifier" ], "members":{ "DBSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier for the DB snapshot.

Constraints:

  • Cannot be null, empty, or blank
  • Must contain from 1 to 255 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

" }, "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier. This is the unique key that identifies a DB instance.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CreateDBSubnetGroupMessage":{ "type":"structure", "required":[ "DBSubnetGroupName", "DBSubnetGroupDescription", "SubnetIds" ], "members":{ "DBSubnetGroupName":{ "shape":"String", "documentation":"

The name for the DB subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".

Example: mySubnetgroup

" }, "DBSubnetGroupDescription":{ "shape":"String", "documentation":"

The description for the DB subnet group.

" }, "SubnetIds":{ "shape":"SubnetIdentifierList", "documentation":"

The EC2 Subnet IDs for the DB subnet group.

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CreateEventSubscriptionMessage":{ "type":"structure", "required":[ "SubscriptionName", "SnsTopicArn" ], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the subscription.

Constraints: The name must be less than 255 characters.

" }, "SnsTopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" }, "SourceType":{ "shape":"String", "documentation":"

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, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

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 in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" }, "SourceIds":{ "shape":"SourceIdsList", "documentation":"

The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If SourceIds are supplied, SourceType must also be provided.
  • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
  • If the source type is a DB security group, a DBSecurityGroupName must be supplied.
  • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
  • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
" }, "Enabled":{ "shape":"BooleanOptional", "documentation":"

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CreateOptionGroupMessage":{ "type":"structure", "required":[ "OptionGroupName", "EngineName", "MajorEngineVersion", "OptionGroupDescription" ], "members":{ "OptionGroupName":{ "shape":"String", "documentation":"

Specifies the name of the option group to be created.

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens

Example: myoptiongroup

" }, "EngineName":{ "shape":"String", "documentation":"

Specifies the name of the engine that this option group should be associated with.

" }, "MajorEngineVersion":{ "shape":"String", "documentation":"

Specifies the major version of the engine that this option group should be associated with.

" }, "OptionGroupDescription":{ "shape":"String", "documentation":"

The description of the option group.

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "DBEngineVersion":{ "type":"structure", "members":{ "Engine":{ "shape":"String", "documentation":"

The name of the database engine.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the database engine.

" }, "DBParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the DB parameter group family for the database engine.

" }, "DBEngineDescription":{ "shape":"String", "documentation":"

The description of the database engine.

" }, "DBEngineVersionDescription":{ "shape":"String", "documentation":"

The description of the database engine version.

" }, "DefaultCharacterSet":{ "shape":"CharacterSet", "documentation":"

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.

" }, "SupportedCharacterSets":{ "shape":"SupportedCharacterSetsList", "documentation":"

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.

" } }, "documentation":"

This data type is used as a response element in the action DescribeDBEngineVersions.

" }, "DBEngineVersionList":{ "type":"list", "member":{ "shape":"DBEngineVersion", "locationName":"DBEngineVersion" } }, "DBEngineVersionMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "DBEngineVersions":{ "shape":"DBEngineVersionList", "documentation":"

A list of DBEngineVersion elements.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

" }, "DBInstance":{ "type":"structure", "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

Contains a user-supplied database identifier. This is the unique key that identifies a DB instance.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

Contains the name of the compute and memory capacity class of the DB instance.

" }, "Engine":{ "shape":"String", "documentation":"

Provides the name of the database engine to be used for this DB instance.

" }, "DBInstanceStatus":{ "shape":"String", "documentation":"

Specifies the current state of this database.

" }, "MasterUsername":{ "shape":"String", "documentation":"

Contains the master username for the DB instance.

" }, "DBName":{ "shape":"String", "documentation":"

The meaning of this parameter differs according to the database engine you use. For example, this value returns either MySQL or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for MySQL and PostgreSQL.

MySQL, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

" }, "Endpoint":{ "shape":"Endpoint", "documentation":"

Specifies the connection endpoint.

" }, "AllocatedStorage":{ "shape":"Integer", "documentation":"

Specifies the allocated storage size specified in gigabytes.

" }, "InstanceCreateTime":{ "shape":"TStamp", "documentation":"

Provides the date and time the DB instance was created.

" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

" }, "BackupRetentionPeriod":{ "shape":"Integer", "documentation":"

Specifies the number of days for which automatic DB snapshots are retained.

" }, "DBSecurityGroups":{ "shape":"DBSecurityGroupMembershipList", "documentation":"

Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

" }, "VpcSecurityGroups":{ "shape":"VpcSecurityGroupMembershipList", "documentation":"

Provides List of VPC security group elements that the DB instance belongs to.

" }, "DBParameterGroups":{ "shape":"DBParameterGroupStatusList", "documentation":"

Provides the list of DB parameter groups applied to this DB instance.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

Specifies the name of the Availability Zone the DB instance is located in.

" }, "DBSubnetGroup":{ "shape":"DBSubnetGroup", "documentation":"

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

Specifies the weekly time range (in UTC) during which system maintenance can occur.

" }, "PendingModifiedValues":{ "shape":"PendingModifiedValues", "documentation":"

Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

" }, "LatestRestorableTime":{ "shape":"TStamp", "documentation":"

Specifies the latest time to which a database can be restored with point-in-time restore.

" }, "MultiAZ":{ "shape":"Boolean", "documentation":"

Specifies if the DB instance is a Multi-AZ deployment.

" }, "EngineVersion":{ "shape":"String", "documentation":"

Indicates the database engine version.

" }, "AutoMinorVersionUpgrade":{ "shape":"Boolean", "documentation":"

Indicates that minor version patches are applied automatically.

" }, "ReadReplicaSourceDBInstanceIdentifier":{ "shape":"String", "documentation":"

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

" }, "ReadReplicaDBInstanceIdentifiers":{ "shape":"ReadReplicaDBInstanceIdentifierList", "documentation":"

Contains one or more identifiers of the Read Replicas associated with this DB instance.

" }, "LicenseModel":{ "shape":"String", "documentation":"

License model information for this DB instance.

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

Specifies the Provisioned IOPS (I/O operations per second) value.

" }, "OptionGroupMemberships":{ "shape":"OptionGroupMembershipList", "documentation":"

Provides the list of option group memberships for this DB instance.

" }, "CharacterSetName":{ "shape":"String", "documentation":"

If present, specifies the name of the character set that this instance is associated with.

" }, "SecondaryAvailabilityZone":{ "shape":"String", "documentation":"

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

" }, "PubliclyAccessible":{ "shape":"Boolean", "documentation":"

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

  • Default VPC:true
  • VPC:false

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. 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.

" }, "StatusInfos":{ "shape":"DBInstanceStatusInfoList", "documentation":"

The status of a Read Replica. If the instance is not a Read Replica, this will be blank.

" }, "StorageType":{ "shape":"String", "documentation":"

Specifies storage type associated with DB Instance.

" }, "TdeCredentialArn":{ "shape":"String", "documentation":"

The ARN from the Key Store with which the instance is associated for TDE encryption.

" } }, "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

" }, "DBInstanceAlreadyExistsFault":{ "type":"structure", "members":{ }, "error":{ "code":"DBInstanceAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

User already has a DB instance with the given identifier.

" }, "DBInstanceList":{ "type":"list", "member":{ "shape":"DBInstance", "locationName":"DBInstance" } }, "DBInstanceMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" }, "DBInstances":{ "shape":"DBInstanceList", "documentation":"

A list of DBInstance instances.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeDBInstances action.

" }, "DBInstanceNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"DBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

" }, "DBInstanceStatusInfo":{ "type":"structure", "members":{ "StatusType":{ "shape":"String", "documentation":"

This value is currently \"read replication.\"

" }, "Normal":{ "shape":"Boolean", "documentation":"

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

" }, "Status":{ "shape":"String", "documentation":"

Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

" }, "Message":{ "shape":"String", "documentation":"

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.

" } }, "documentation":"

Provides a list of status information for a DB instance.

" }, "DBInstanceStatusInfoList":{ "type":"list", "member":{ "shape":"DBInstanceStatusInfo", "locationName":"DBInstanceStatusInfo" } }, "DBParameterGroup":{ "type":"structure", "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

Provides the name of the DB parameter group.

" }, "DBParameterGroupFamily":{ "shape":"String", "documentation":"

Provides the name of the DB parameter group family that this DB parameter group is compatible with.

" }, "Description":{ "shape":"String", "documentation":"

Provides the customer-specified description for this DB parameter group.

" } }, "wrapper":true, "documentation":"

Contains the result of a successful invocation of the CreateDBParameterGroup action.

This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

" }, "DBParameterGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "error":{ "code":"DBParameterGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

A DB parameter group with the same name exists.

" }, "DBParameterGroupDetails":{ "type":"structure", "members":{ "Parameters":{ "shape":"ParametersList", "documentation":"

A list of Parameter values.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeDBParameters action.

" }, "DBParameterGroupList":{ "type":"list", "member":{ "shape":"DBParameterGroup", "locationName":"DBParameterGroup" } }, "DBParameterGroupNameMessage":{ "type":"structure", "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB parameter group.

" } }, "documentation":"

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

" }, "DBParameterGroupNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"DBParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

" }, "DBParameterGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"DBParameterGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of DB parameter groups.

" }, "DBParameterGroupStatus":{ "type":"structure", "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DP parameter group.

" }, "ParameterApplyStatus":{ "shape":"String", "documentation":"

The status of parameter updates.

" } }, "documentation":"

The status of the DB parameter group.

This data type is used as a response element in the following actions:

" }, "DBParameterGroupStatusList":{ "type":"list", "member":{ "shape":"DBParameterGroupStatus", "locationName":"DBParameterGroup" } }, "DBParameterGroupsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "DBParameterGroups":{ "shape":"DBParameterGroupList", "documentation":"

A list of DBParameterGroup instances.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

" }, "DBSecurityGroup":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

Provides the AWS ID of the owner of a specific DB security group.

" }, "DBSecurityGroupName":{ "shape":"String", "documentation":"

Specifies the name of the DB security group.

" }, "DBSecurityGroupDescription":{ "shape":"String", "documentation":"

Provides the description of the DB security group.

" }, "VpcId":{ "shape":"String", "documentation":"

Provides the VpcId of the DB security group.

" }, "EC2SecurityGroups":{ "shape":"EC2SecurityGroupList", "documentation":"

Contains a list of EC2SecurityGroup elements.

" }, "IPRanges":{ "shape":"IPRangeList", "documentation":"

Contains a list of IPRange elements.

" } }, "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

" }, "DBSecurityGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "error":{ "code":"DBSecurityGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

A DB security group with the name specified in DBSecurityGroupName already exists.

" }, "DBSecurityGroupMembership":{ "type":"structure", "members":{ "DBSecurityGroupName":{ "shape":"String", "documentation":"

The name of the DB security group.

" }, "Status":{ "shape":"String", "documentation":"

The status of the DB security group.

" } }, "documentation":"

This data type is used as a response element in the following actions:

" }, "DBSecurityGroupMembershipList":{ "type":"list", "member":{ "shape":"DBSecurityGroupMembership", "locationName":"DBSecurityGroup" } }, "DBSecurityGroupMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "DBSecurityGroups":{ "shape":"DBSecurityGroups", "documentation":"

A list of DBSecurityGroup instances.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

" }, "DBSecurityGroupNameList":{ "type":"list", "member":{ "shape":"String", "locationName":"DBSecurityGroupName" } }, "DBSecurityGroupNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"DBSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

" }, "DBSecurityGroupNotSupportedFault":{ "type":"structure", "members":{ }, "error":{ "code":"DBSecurityGroupNotSupported", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

A DB security group is not allowed for this action.

" }, "DBSecurityGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"QuotaExceeded.DBSecurityGroup", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of DB security groups.

" }, "DBSecurityGroups":{ "type":"list", "member":{ "shape":"DBSecurityGroup", "locationName":"DBSecurityGroup" } }, "DBSnapshot":{ "type":"structure", "members":{ "DBSnapshotIdentifier":{ "shape":"String", "documentation":"

Specifies the identifier for the DB snapshot.

" }, "DBInstanceIdentifier":{ "shape":"String", "documentation":"

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

" }, "SnapshotCreateTime":{ "shape":"TStamp", "documentation":"

Provides the time (UTC) when the snapshot was taken.

" }, "Engine":{ "shape":"String", "documentation":"

Specifies the name of the database engine.

" }, "AllocatedStorage":{ "shape":"Integer", "documentation":"

Specifies the allocated storage size in gigabytes (GB).

" }, "Status":{ "shape":"String", "documentation":"

Specifies the status of this DB snapshot.

" }, "Port":{ "shape":"Integer", "documentation":"

Specifies the port that the database engine was listening on at the time of the snapshot.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

" }, "VpcId":{ "shape":"String", "documentation":"

Provides the Vpc Id associated with the DB snapshot.

" }, "InstanceCreateTime":{ "shape":"TStamp", "documentation":"

Specifies the time (UTC) when the snapshot was taken.

" }, "MasterUsername":{ "shape":"String", "documentation":"

Provides the master username for the DB snapshot.

" }, "EngineVersion":{ "shape":"String", "documentation":"

Specifies the version of the database engine.

" }, "LicenseModel":{ "shape":"String", "documentation":"

License model information for the restored DB instance.

" }, "SnapshotType":{ "shape":"String", "documentation":"

Provides the type of the DB snapshot.

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

Provides the option group name for the DB snapshot.

" }, "PercentProgress":{ "shape":"Integer", "documentation":"

The percentage of the estimated data that has been transferred.

" }, "SourceRegion":{ "shape":"String", "documentation":"

The region that the DB snapshot was created in or copied from.

" }, "StorageType":{ "shape":"String", "documentation":"

Specifies storage type associated with DB Snapshot.

" }, "TdeCredentialArn":{ "shape":"String", "documentation":"

The ARN from the Key Store with which to associate the instance for TDE encryption.

" } }, "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

" }, "DBSnapshotAlreadyExistsFault":{ "type":"structure", "members":{ }, "error":{ "code":"DBSnapshotAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

" }, "DBSnapshotList":{ "type":"list", "member":{ "shape":"DBSnapshot", "locationName":"DBSnapshot" } }, "DBSnapshotMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "DBSnapshots":{ "shape":"DBSnapshotList", "documentation":"

A list of DBSnapshot instances.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeDBSnapshots action.

" }, "DBSnapshotNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"DBSnapshotNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

" }, "DBSubnetGroup":{ "type":"structure", "members":{ "DBSubnetGroupName":{ "shape":"String", "documentation":"

Specifies the name of the DB subnet group.

" }, "DBSubnetGroupDescription":{ "shape":"String", "documentation":"

Provides the description of the DB subnet group.

" }, "VpcId":{ "shape":"String", "documentation":"

Provides the VpcId of the DB subnet group.

" }, "SubnetGroupStatus":{ "shape":"String", "documentation":"

Provides the status of the DB subnet group.

" }, "Subnets":{ "shape":"SubnetList", "documentation":"

Contains a list of Subnet elements.

" } }, "wrapper":true, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSubnetGroups action.

" }, "DBSubnetGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "error":{ "code":"DBSubnetGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

DBSubnetGroupName is already used by an existing DB subnet group.

" }, "DBSubnetGroupDoesNotCoverEnoughAZs":{ "type":"structure", "members":{ }, "error":{ "code":"DBSubnetGroupDoesNotCoverEnoughAZs", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

" }, "DBSubnetGroupMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "DBSubnetGroups":{ "shape":"DBSubnetGroups", "documentation":"

A list of DBSubnetGroup instances.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

" }, "DBSubnetGroupNotAllowedFault":{ "type":"structure", "members":{ }, "error":{ "code":"DBSubnetGroupNotAllowedFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.

" }, "DBSubnetGroupNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"DBSubnetGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

" }, "DBSubnetGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"DBSubnetGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of DB subnet groups.

" }, "DBSubnetGroups":{ "type":"list", "member":{ "shape":"DBSubnetGroup", "locationName":"DBSubnetGroup" } }, "DBSubnetQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"DBSubnetQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

" }, "DBUpgradeDependencyFailureFault":{ "type":"structure", "members":{ }, "error":{ "code":"DBUpgradeDependencyFailure", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The DB upgrade failed because a resource the DB depends on could not be modified.

" }, "DeleteDBInstanceMessage":{ "type":"structure", "required":["DBInstanceIdentifier"], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "SkipFinalSnapshot":{ "shape":"Boolean", "documentation":"

Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

" }, "FinalDBSnapshotIdentifier":{ "shape":"String", "documentation":"

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
  • Cannot be specified when deleting a Read Replica.
" } }, "documentation":"

" }, "DeleteDBParameterGroupMessage":{ "type":"structure", "required":["DBParameterGroupName"], "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB parameter group.

Constraints:

  • Must be the name of an existing DB parameter group
  • You cannot delete a default DB parameter group
  • Cannot be associated with any DB instances
" } }, "documentation":"

" }, "DeleteDBSecurityGroupMessage":{ "type":"structure", "required":["DBSecurityGroupName"], "members":{ "DBSecurityGroupName":{ "shape":"String", "documentation":"

The name of the DB security group to delete.

You cannot delete the default DB security group.

Constraints:

  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
  • Must not be \"Default\"
  • May not contain spaces
" } }, "documentation":"

" }, "DeleteDBSnapshotMessage":{ "type":"structure", "required":["DBSnapshotIdentifier"], "members":{ "DBSnapshotIdentifier":{ "shape":"String", "documentation":"

The DBSnapshot identifier.

Constraints: Must be the name of an existing DB snapshot in the available state.

" } }, "documentation":"

" }, "DeleteDBSubnetGroupMessage":{ "type":"structure", "required":["DBSubnetGroupName"], "members":{ "DBSubnetGroupName":{ "shape":"String", "documentation":"

The name of the database subnet group to delete.

You cannot delete the default subnet group.

Constraints:

  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" } }, "documentation":"

" }, "DeleteEventSubscriptionMessage":{ "type":"structure", "required":["SubscriptionName"], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the RDS event notification subscription you want to delete.

" } }, "documentation":"

" }, "DeleteOptionGroupMessage":{ "type":"structure", "required":["OptionGroupName"], "members":{ "OptionGroupName":{ "shape":"String", "documentation":"

The name of the option group to be deleted.

You cannot delete default option groups." } }, "documentation":"

" }, "DescribeDBEngineVersionsMessage":{ "type":"structure", "members":{ "Engine":{ "shape":"String", "documentation":"

The database engine to return.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The database engine version to return.

Example: 5.1.49

" }, "DBParameterGroupFamily":{ "shape":"String", "documentation":"

The name of a specific DB parameter group family to return details for.

Constraints:

  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "Filters":{ "shape":"FilterList", "documentation":"

Not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "DefaultOnly":{ "shape":"Boolean", "documentation":"

Indicates that only the default version of the specified engine or engine and major version combination is returned.

" }, "ListSupportedCharacterSets":{ "shape":"BooleanOptional", "documentation":"

If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

" } } }, "DescribeDBInstancesMessage":{ "type":"structure", "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" } }, "documentation":"

" }, "DescribeDBLogFilesDetails":{ "type":"structure", "members":{ "LogFileName":{ "shape":"String", "documentation":"

The name of the log file for the specified DB instance.

" }, "LastWritten":{ "shape":"Long", "documentation":"

A POSIX timestamp when the last log entry was written.

" }, "Size":{ "shape":"Long", "documentation":"

The size, in bytes, of the log file for the specified DB instance.

" } }, "documentation":"

This data type is used as a response element to DescribeDBLogFiles.

" }, "DescribeDBLogFilesList":{ "type":"list", "member":{ "shape":"DescribeDBLogFilesDetails", "locationName":"DescribeDBLogFilesDetails" } }, "DescribeDBLogFilesMessage":{ "type":"structure", "required":["DBInstanceIdentifier"], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "FilenameContains":{ "shape":"String", "documentation":"

Filters the available log files for log file names that contain the specified string.

" }, "FileLastWritten":{ "shape":"Long", "documentation":"

Filters the available log files for files written since the specified date, in POSIX timestamp format.

" }, "FileSize":{ "shape":"Long", "documentation":"

Filters the available log files for files larger than the specified size.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

" }, "Marker":{ "shape":"String", "documentation":"

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

" } }, "documentation":"

" }, "DescribeDBLogFilesResponse":{ "type":"structure", "members":{ "DescribeDBLogFiles":{ "shape":"DescribeDBLogFilesList", "documentation":"

The DB log files returned.

" }, "Marker":{ "shape":"String", "documentation":"

A pagination token that can be used in a subsequent DescribeDBLogFiles request.

" } }, "documentation":"

The response from a call to DescribeDBLogFiles.

" }, "DescribeDBParameterGroupsMessage":{ "type":"structure", "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of a specific DB parameter group to return details for.

Constraints:

  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeDBParametersMessage":{ "type":"structure", "required":["DBParameterGroupName"], "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of a specific DB parameter group to return details for.

Constraints:

  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "Source":{ "shape":"String", "documentation":"

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } } }, "DescribeDBSecurityGroupsMessage":{ "type":"structure", "members":{ "DBSecurityGroupName":{ "shape":"String", "documentation":"

The name of the DB security group to return details for.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeDBSnapshotsMessage":{ "type":"structure", "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

A DB instance identifier to retrieve the list of DB snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "DBSnapshotIdentifier":{ "shape":"String", "documentation":"

A specific DB snapshot identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
  • If this is the identifier of an automated snapshot, the SnapshotType parameter must also be specified.
" }, "SnapshotType":{ "shape":"String", "documentation":"

The type of snapshots that will be returned. Values can be \"automated\" or \"manual.\" If not specified, the returned results will include all snapshots types.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeDBSubnetGroupsMessage":{ "type":"structure", "members":{ "DBSubnetGroupName":{ "shape":"String", "documentation":"

The name of the DB subnet group to return details for.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeEngineDefaultParametersMessage":{ "type":"structure", "required":["DBParameterGroupFamily"], "members":{ "DBParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the DB parameter group family.

" }, "Filters":{ "shape":"FilterList", "documentation":"

Not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeEventCategoriesMessage":{ "type":"structure", "members":{ "SourceType":{ "shape":"String", "documentation":"

The type of source that will be generating the events.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" } }, "documentation":"

" }, "DescribeEventSubscriptionsMessage":{ "type":"structure", "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the RDS event notification subscription you want to describe.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" } }, "documentation":"

" }, "DescribeEventsMessage":{ "type":"structure", "members":{ "SourceIdentifier":{ "shape":"String", "documentation":"

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is supplied, SourceType must also be provided.
  • If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.
  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.
  • If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.
  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.
  • Cannot end with a hyphen or contain two consecutive hyphens.
" }, "SourceType":{ "shape":"SourceType", "documentation":"

The event source to retrieve events for. If no value is specified, all events are returned.

" }, "StartTime":{ "shape":"TStamp", "documentation":"

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

" }, "EndTime":{ "shape":"TStamp", "documentation":"

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

" }, "Duration":{ "shape":"IntegerOptional", "documentation":"

The number of minutes to retrieve events for.

Default: 60

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

A list of event categories that trigger notifications for a event notification subscription.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeOptionGroupOptionsMessage":{ "type":"structure", "required":["EngineName"], "members":{ "EngineName":{ "shape":"String", "documentation":"

A required parameter. Options available for the given Engine name will be described.

" }, "MajorEngineVersion":{ "shape":"String", "documentation":"

If specified, filters the results to include only options for the specified major engine version.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeOptionGroupsMessage":{ "type":"structure", "members":{ "OptionGroupName":{ "shape":"String", "documentation":"

The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" }, "EngineName":{ "shape":"String", "documentation":"

Filters the list of option groups to only include groups associated with a specific database engine.

" }, "MajorEngineVersion":{ "shape":"String", "documentation":"

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.

" } }, "documentation":"

" }, "DescribeOrderableDBInstanceOptionsMessage":{ "type":"structure", "required":["Engine"], "members":{ "Engine":{ "shape":"String", "documentation":"

The name of the engine to retrieve DB instance options for.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" }, "LicenseModel":{ "shape":"String", "documentation":"

The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

" }, "Vpc":{ "shape":"BooleanOptional", "documentation":"

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" } }, "documentation":"

" }, "DescribeReservedDBInstancesMessage":{ "type":"structure", "members":{ "ReservedDBInstanceId":{ "shape":"String", "documentation":"

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

" }, "ReservedDBInstancesOfferingId":{ "shape":"String", "documentation":"

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

" }, "Duration":{ "shape":"String", "documentation":"

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" }, "ProductDescription":{ "shape":"String", "documentation":"

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

" }, "OfferingType":{ "shape":"String", "documentation":"

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeReservedDBInstancesOfferingsMessage":{ "type":"structure", "members":{ "ReservedDBInstancesOfferingId":{ "shape":"String", "documentation":"

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" }, "Duration":{ "shape":"String", "documentation":"

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" }, "ProductDescription":{ "shape":"String", "documentation":"

Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.

" }, "OfferingType":{ "shape":"String", "documentation":"

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: minimum 20, maximum 100

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "Double":{"type":"double"}, "DownloadDBLogFilePortionDetails":{ "type":"structure", "members":{ "LogFileData":{ "shape":"String", "documentation":"

Entries from the specified log file.

" }, "Marker":{ "shape":"String", "documentation":"

A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.

" }, "AdditionalDataPending":{ "shape":"Boolean", "documentation":"

Boolean value that if true, indicates there is more data to be downloaded.

" } }, "documentation":"

This data type is used as a response element to DownloadDBLogFilePortion.

" }, "DownloadDBLogFilePortionMessage":{ "type":"structure", "required":[ "DBInstanceIdentifier", "LogFileName" ], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "LogFileName":{ "shape":"String", "documentation":"

The name of the log file to be downloaded.

" }, "Marker":{ "shape":"String", "documentation":"

The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

" }, "NumberOfLines":{ "shape":"Integer", "documentation":"

The number of lines to download.

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

  • If neither Marker or NumberOfLines are specified, the entire log file is returned.

  • If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.

  • If Marker is specified as \"0\", then the specified number of lines from the beginning of the log file are returned.

  • You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.

" } }, "documentation":"

" }, "EC2SecurityGroup":{ "type":"structure", "members":{ "Status":{ "shape":"String", "documentation":"

Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" }, "EC2SecurityGroupName":{ "shape":"String", "documentation":"

Specifies the name of the EC2 security group.

" }, "EC2SecurityGroupId":{ "shape":"String", "documentation":"

Specifies the id of the EC2 security group.

" }, "EC2SecurityGroupOwnerId":{ "shape":"String", "documentation":"

Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

" } }, "documentation":"

This data type is used as a response element in the following actions:

" }, "EC2SecurityGroupList":{ "type":"list", "member":{ "shape":"EC2SecurityGroup", "locationName":"EC2SecurityGroup" } }, "Endpoint":{ "type":"structure", "members":{ "Address":{ "shape":"String", "documentation":"

Specifies the DNS address of the DB instance.

" }, "Port":{ "shape":"Integer", "documentation":"

Specifies the port that the database engine is listening on.

" } }, "documentation":"

This data type is used as a response element in the following actions:

" }, "EngineDefaults":{ "type":"structure", "members":{ "DBParameterGroupFamily":{ "shape":"String", "documentation":"

Specifies the name of the DB parameter group family which the engine default parameters apply to.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

Contains a list of engine default parameters.

" } }, "wrapper":true, "documentation":"

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

" }, "Event":{ "type":"structure", "members":{ "SourceIdentifier":{ "shape":"String", "documentation":"

Provides the identifier for the source of the event.

" }, "SourceType":{ "shape":"SourceType", "documentation":"

Specifies the source type for this event.

" }, "Message":{ "shape":"String", "documentation":"

Provides the text of this event.

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

Specifies the category for the event.

" }, "Date":{ "shape":"TStamp", "documentation":"

Specifies the date and time of the event.

" } }, "documentation":"

This data type is used as a response element in the DescribeEvents action.

" }, "EventCategoriesList":{ "type":"list", "member":{ "shape":"String", "locationName":"EventCategory" } }, "EventCategoriesMap":{ "type":"structure", "members":{ "SourceType":{ "shape":"String", "documentation":"

The source type that the returned categories belong to

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

The event categories for the specified source type

" } }, "wrapper":true, "documentation":"

Contains the results of a successful invocation of the DescribeEventCategories action.

" }, "EventCategoriesMapList":{ "type":"list", "member":{ "shape":"EventCategoriesMap", "locationName":"EventCategoriesMap" } }, "EventCategoriesMessage":{ "type":"structure", "members":{ "EventCategoriesMapList":{ "shape":"EventCategoriesMapList", "documentation":"

A list of EventCategoriesMap data types.

" } }, "documentation":"

Data returned from the DescribeEventCategories action.

" }, "EventList":{ "type":"list", "member":{ "shape":"Event", "locationName":"Event" } }, "EventSubscription":{ "type":"structure", "members":{ "CustomerAwsId":{ "shape":"String", "documentation":"

The AWS customer account associated with the RDS event notification subscription.

" }, "CustSubscriptionId":{ "shape":"String", "documentation":"

The RDS event notification subscription Id.

" }, "SnsTopicArn":{ "shape":"String", "documentation":"

The topic ARN of the RDS event notification subscription.

" }, "Status":{ "shape":"String", "documentation":"

The status of the RDS event notification subscription.

Constraints:

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

" }, "SubscriptionCreationTime":{ "shape":"String", "documentation":"

The time the RDS event notification subscription was created.

" }, "SourceType":{ "shape":"String", "documentation":"

The source type for the RDS event notification subscription.

" }, "SourceIdsList":{ "shape":"SourceIdsList", "documentation":"

A list of source IDs for the RDS event notification subscription.

" }, "EventCategoriesList":{ "shape":"EventCategoriesList", "documentation":"

A list of event categories for the RDS event notification subscription.

" }, "Enabled":{ "shape":"Boolean", "documentation":"

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

" } }, "wrapper":true, "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

" }, "EventSubscriptionQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"EventSubscriptionQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You have reached the maximum number of event subscriptions.

" }, "EventSubscriptionsList":{ "type":"list", "member":{ "shape":"EventSubscription", "locationName":"EventSubscription" } }, "EventSubscriptionsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "EventSubscriptionsList":{ "shape":"EventSubscriptionsList", "documentation":"

A list of EventSubscriptions data types.

" } }, "documentation":"

Data returned by the DescribeEventSubscriptions action.

" }, "EventsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" }, "Events":{ "shape":"EventList", "documentation":"

A list of Event instances.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeEvents action.

" }, "Filter":{ "type":"structure", "required":[ "Name", "Values" ], "members":{ "Name":{ "shape":"String", "documentation":"

This parameter is not currently supported.

" }, "Values":{ "shape":"FilterValueList", "documentation":"

This parameter is not currently supported.

" } } }, "FilterList":{ "type":"list", "member":{ "shape":"Filter", "locationName":"Filter" } }, "FilterValueList":{ "type":"list", "member":{ "shape":"String", "locationName":"Value" } }, "IPRange":{ "type":"structure", "members":{ "Status":{ "shape":"String", "documentation":"

Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" }, "CIDRIP":{ "shape":"String", "documentation":"

Specifies the IP range.

" } }, "documentation":"

This data type is used as a response element in the DescribeDBSecurityGroups action.

" }, "IPRangeList":{ "type":"list", "member":{ "shape":"IPRange", "locationName":"IPRange" } }, "InstanceQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"InstanceQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of DB instances.

" }, "InsufficientDBInstanceCapacityFault":{ "type":"structure", "members":{ }, "error":{ "code":"InsufficientDBInstanceCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

" }, "Integer":{"type":"integer"}, "IntegerOptional":{"type":"integer"}, "InvalidDBInstanceStateFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidDBInstanceState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified DB instance is not in the available state.

" }, "InvalidDBParameterGroupStateFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidDBParameterGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The DB parameter group cannot be deleted because it is in use.

" }, "InvalidDBSecurityGroupStateFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidDBSecurityGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The state of the DB security group does not allow deletion.

" }, "InvalidDBSnapshotStateFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidDBSnapshotState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The state of the DB snapshot does not allow deletion.

" }, "InvalidDBSubnetGroupFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidDBSubnetGroupFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.

" }, "InvalidDBSubnetGroupStateFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidDBSubnetGroupStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The DB subnet group cannot be deleted because it is in use.

" }, "InvalidDBSubnetStateFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidDBSubnetStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The DB subnet is not in the available state.

" }, "InvalidEventSubscriptionStateFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidEventSubscriptionState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

This error can occur if someone else is modifying a subscription. You should retry the action.

" }, "InvalidOptionGroupStateFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidOptionGroupStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The option group is not in the available state.

" }, "InvalidRestoreFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidRestoreFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Cannot restore from vpc backup to non-vpc DB instance.

" }, "InvalidSubnet":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

" }, "InvalidVPCNetworkStateFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidVPCNetworkStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

" }, "KeyList":{ "type":"list", "member":{"shape":"String"} }, "ListTagsForResourceMessage":{ "type":"structure", "required":["ResourceName"], "members":{ "ResourceName":{ "shape":"String", "documentation":"

The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" } }, "documentation":"

" }, "Long":{"type":"long"}, "ModifyDBInstanceMessage":{ "type":"structure", "required":["DBInstanceIdentifier"], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must be the identifier for an existing DB instance
  • Must contain from 1 to 63 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "AllocatedStorage":{ "shape":"IntegerOptional", "documentation":"

The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.

MySQL

Default: Uses existing setting

Valid Values: 5-3072

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

PostgreSQL

Default: Uses existing setting

Valid Values: 5-3072

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

Oracle

Default: Uses existing setting

Valid Values: 10-3072

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

SQL Server

Cannot be modified.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting

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 | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

" }, "DBSecurityGroups":{ "shape":"DBSecurityGroupNameList", "documentation":"

A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Constraints:

  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "ApplyImmediately":{ "shape":"Boolean", "documentation":"

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.

Default: false

" }, "MasterUserPassword":{ "shape":"String", "documentation":"

The new password for the DB instance master user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".

Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Default: Uses existing setting

Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

Amazon RDS API actions never return the password, so this action provides a way to regain access to a master instance user if the password is lost. This includes restoring privileges that may have been accidentally revoked. " }, "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

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. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Default: Uses existing setting

Constraints:

  • Must be a value from 0 to 35
  • Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
  • Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
  • Cannot be set to 0 if the DB instance is a source to Read Replicas
" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

  • Must be in the format hh24:mi-hh24:mi
  • Times should be Universal Time Coordinated (UTC)
  • Must not conflict with the preferred maintenance window
  • Must be at least 30 minutes
" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Constraints: Cannot be specified if the DB instance is a Read Replica.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

For a list of valid engine versions, see CreateDBInstance.

" }, "AllowMajorVersionUpgrade":{ "shape":"Boolean", "documentation":"

Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Default: Uses existing setting

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

Type: Integer

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, 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

" }, "NewDBInstanceIdentifier":{ "shape":"String", "documentation":"

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "StorageType":{ "shape":"String", "documentation":"

Specifies storage type to be associated with the DB Instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

" }, "TdeCredentialArn":{ "shape":"String", "documentation":"

The ARN from the Key Store with which to associate the instance for TDE encryption.

" }, "TdeCredentialPassword":{ "shape":"String", "documentation":"

The password for the given ARN from the Key Store in order to access the device.

" } }, "documentation":"

" }, "ModifyDBParameterGroupMessage":{ "type":"structure", "required":[ "DBParameterGroupName", "Parameters" ], "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB parameter group.

Constraints:

  • Must be the name of an existing DB parameter group
  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "Parameters":{ "shape":"ParametersList", "documentation":"

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

Valid Values (for the application method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover. " } }, "documentation":"

" }, "ModifyDBSubnetGroupMessage":{ "type":"structure", "required":[ "DBSubnetGroupName", "SubnetIds" ], "members":{ "DBSubnetGroupName":{ "shape":"String", "documentation":"

The name for the DB subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".

Example: mySubnetgroup

" }, "DBSubnetGroupDescription":{ "shape":"String", "documentation":"

The description for the DB subnet group.

" }, "SubnetIds":{ "shape":"SubnetIdentifierList", "documentation":"

The EC2 subnet IDs for the DB subnet group.

" } }, "documentation":"

" }, "ModifyEventSubscriptionMessage":{ "type":"structure", "required":["SubscriptionName"], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the RDS event notification subscription.

" }, "SnsTopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" }, "SourceType":{ "shape":"String", "documentation":"

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, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

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 in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" }, "Enabled":{ "shape":"BooleanOptional", "documentation":"

A Boolean value; set to true to activate the subscription.

" } }, "documentation":"

" }, "ModifyOptionGroupMessage":{ "type":"structure", "required":["OptionGroupName"], "members":{ "OptionGroupName":{ "shape":"String", "documentation":"

The name of the option group to be modified.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, 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

" }, "OptionsToInclude":{ "shape":"OptionConfigurationList", "documentation":"

Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

" }, "OptionsToRemove":{ "shape":"OptionNamesList", "documentation":"

Options in this list are removed from the option group.

" }, "ApplyImmediately":{ "shape":"Boolean", "documentation":"

Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.

" } }, "documentation":"

" }, "Option":{ "type":"structure", "members":{ "OptionName":{ "shape":"String", "documentation":"

The name of the option.

" }, "OptionDescription":{ "shape":"String", "documentation":"

The description of the option.

" }, "Persistent":{ "shape":"Boolean", "documentation":"

Indicate if this option is persistent.

" }, "Permanent":{ "shape":"Boolean", "documentation":"

Indicate if this option is permanent.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

If required, the port configured for this option to use.

" }, "OptionSettings":{ "shape":"OptionSettingConfigurationList", "documentation":"

The option settings for this option.

" }, "DBSecurityGroupMemberships":{ "shape":"DBSecurityGroupMembershipList", "documentation":"

If the option requires access to a port, then this DB security group allows access to the port.

" }, "VpcSecurityGroupMemberships":{ "shape":"VpcSecurityGroupMembershipList", "documentation":"

If the option requires access to a port, then this VPC security group allows access to the port.

" } }, "documentation":"

Option details.

" }, "OptionConfiguration":{ "type":"structure", "required":["OptionName"], "members":{ "OptionName":{ "shape":"String", "documentation":"

The configuration of options to include in a group.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The optional port for the option.

" }, "DBSecurityGroupMemberships":{ "shape":"DBSecurityGroupNameList", "documentation":"

A list of DBSecurityGroupMemebrship name strings used for this option.

" }, "VpcSecurityGroupMemberships":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A list of VpcSecurityGroupMemebrship name strings used for this option.

" }, "OptionSettings":{ "shape":"OptionSettingsList", "documentation":"

The option settings to include in an option group.

" } }, "documentation":"

A list of all available options

" }, "OptionConfigurationList":{ "type":"list", "member":{ "shape":"OptionConfiguration", "locationName":"OptionConfiguration" } }, "OptionGroup":{ "type":"structure", "members":{ "OptionGroupName":{ "shape":"String", "documentation":"

Specifies the name of the option group.

" }, "OptionGroupDescription":{ "shape":"String", "documentation":"

Provides a description of the option group.

" }, "EngineName":{ "shape":"String", "documentation":"

Engine name that this option group can be applied to.

" }, "MajorEngineVersion":{ "shape":"String", "documentation":"

Indicates the major engine version associated with this option group.

" }, "Options":{ "shape":"OptionsList", "documentation":"

Indicates what options are available in the option group.

" }, "AllowsVpcAndNonVpcInstanceMemberships":{ "shape":"Boolean", "documentation":"

Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

" }, "VpcId":{ "shape":"String", "documentation":"

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

" } }, "wrapper":true, "documentation":"

" }, "OptionGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "error":{ "code":"OptionGroupAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The option group you are trying to create already exists.

" }, "OptionGroupMembership":{ "type":"structure", "members":{ "OptionGroupName":{ "shape":"String", "documentation":"

The name of the option group that the instance belongs to.

" }, "Status":{ "shape":"String", "documentation":"

The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).

" } }, "documentation":"

Provides information on the option groups the DB instance is a member of.

" }, "OptionGroupMembershipList":{ "type":"list", "member":{ "shape":"OptionGroupMembership", "locationName":"OptionGroupMembership" } }, "OptionGroupNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"OptionGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified option group could not be found.

" }, "OptionGroupOption":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the option.

" }, "Description":{ "shape":"String", "documentation":"

The description of the option.

" }, "EngineName":{ "shape":"String", "documentation":"

The name of the engine that this option can be applied to.

" }, "MajorEngineVersion":{ "shape":"String", "documentation":"

Indicates the major engine version that the option is available for.

" }, "MinimumRequiredMinorEngineVersion":{ "shape":"String", "documentation":"

The minimum required engine version for the option to be applied.

" }, "PortRequired":{ "shape":"Boolean", "documentation":"

Specifies whether the option requires a port.

" }, "DefaultPort":{ "shape":"IntegerOptional", "documentation":"

If the option requires a port, specifies the default port for the option.

" }, "OptionsDependedOn":{ "shape":"OptionsDependedOn", "documentation":"

List of all options that are prerequisites for this option.

" }, "Persistent":{ "shape":"Boolean", "documentation":"

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.

" }, "Permanent":{ "shape":"Boolean", "documentation":"

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.

" }, "OptionGroupOptionSettings":{ "shape":"OptionGroupOptionSettingsList", "documentation":"

Specifies the option settings that are available (and the default value) for each option in an option group.

" } }, "documentation":"

Available option.

" }, "OptionGroupOptionSetting":{ "type":"structure", "members":{ "SettingName":{ "shape":"String", "documentation":"

The name of the option group option.

" }, "SettingDescription":{ "shape":"String", "documentation":"

The description of the option group option.

" }, "DefaultValue":{ "shape":"String", "documentation":"

The default value for the option group option.

" }, "ApplyType":{ "shape":"String", "documentation":"

The DB engine specific parameter type for the option group option.

" }, "AllowedValues":{ "shape":"String", "documentation":"

Indicates the acceptable values for the option group option.

" }, "IsModifiable":{ "shape":"Boolean", "documentation":"

Boolean value where true indicates that this option group option can be changed from the default value.

" } }, "documentation":"

Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

" }, "OptionGroupOptionSettingsList":{ "type":"list", "member":{ "shape":"OptionGroupOptionSetting", "locationName":"OptionGroupOptionSetting" } }, "OptionGroupOptionsList":{ "type":"list", "member":{ "shape":"OptionGroupOption", "locationName":"OptionGroupOption" }, "documentation":"

List of available option group options.

" }, "OptionGroupOptionsMessage":{ "type":"structure", "members":{ "OptionGroupOptions":{"shape":"OptionGroupOptionsList"}, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "OptionGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"OptionGroupQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The quota of 20 option groups was exceeded for this AWS account.

" }, "OptionGroups":{ "type":"structure", "members":{ "OptionGroupsList":{ "shape":"OptionGroupsList", "documentation":"

List of option groups.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

List of option groups.

" }, "OptionGroupsList":{ "type":"list", "member":{ "shape":"OptionGroup", "locationName":"OptionGroup" } }, "OptionNamesList":{ "type":"list", "member":{"shape":"String"} }, "OptionSetting":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the option that has settings that you can set.

" }, "Value":{ "shape":"String", "documentation":"

The current value of the option setting.

" }, "DefaultValue":{ "shape":"String", "documentation":"

The default value of the option setting.

" }, "Description":{ "shape":"String", "documentation":"

The description of the option setting.

" }, "ApplyType":{ "shape":"String", "documentation":"

The DB engine specific parameter type.

" }, "DataType":{ "shape":"String", "documentation":"

The data type of the option setting.

" }, "AllowedValues":{ "shape":"String", "documentation":"

The allowed values of the option setting.

" }, "IsModifiable":{ "shape":"Boolean", "documentation":"

A Boolean value that, when true, indicates the option setting can be modified from the default.

" }, "IsCollection":{ "shape":"Boolean", "documentation":"

Indicates if the option setting is part of a collection.

" } }, "documentation":"

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

" }, "OptionSettingConfigurationList":{ "type":"list", "member":{ "shape":"OptionSetting", "locationName":"OptionSetting" } }, "OptionSettingsList":{ "type":"list", "member":{ "shape":"OptionSetting", "locationName":"OptionSetting" } }, "OptionsDependedOn":{ "type":"list", "member":{ "shape":"String", "locationName":"OptionName" } }, "OptionsList":{ "type":"list", "member":{ "shape":"Option", "locationName":"Option" } }, "OrderableDBInstanceOption":{ "type":"structure", "members":{ "Engine":{ "shape":"String", "documentation":"

The engine type of the orderable DB instance.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The engine version of the orderable DB instance.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The DB instance Class for the orderable DB instance

" }, "LicenseModel":{ "shape":"String", "documentation":"

The license model for the orderable DB instance.

" }, "AvailabilityZones":{ "shape":"AvailabilityZoneList", "documentation":"

A list of availability zones for the orderable DB instance.

" }, "MultiAZCapable":{ "shape":"Boolean", "documentation":"

Indicates whether this orderable DB instance is multi-AZ capable.

" }, "ReadReplicaCapable":{ "shape":"Boolean", "documentation":"

Indicates whether this orderable DB instance can have a Read Replica.

" }, "Vpc":{ "shape":"Boolean", "documentation":"

Indicates whether this is a VPC orderable DB instance.

" }, "StorageType":{ "shape":"String", "documentation":"

The storage type for this orderable DB instance.

" }, "SupportsIops":{ "shape":"Boolean", "documentation":"

Indicates whether this orderable DB instance supports provisioned IOPS.

" } }, "wrapper":true, "documentation":"

Contains a list of available options for a DB instance

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

" }, "OrderableDBInstanceOptionsList":{ "type":"list", "member":{ "shape":"OrderableDBInstanceOption", "locationName":"OrderableDBInstanceOption" } }, "OrderableDBInstanceOptionsMessage":{ "type":"structure", "members":{ "OrderableDBInstanceOptions":{ "shape":"OrderableDBInstanceOptionsList", "documentation":"

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

" }, "Parameter":{ "type":"structure", "members":{ "ParameterName":{ "shape":"String", "documentation":"

Specifies the name of the parameter.

" }, "ParameterValue":{ "shape":"String", "documentation":"

Specifies the value of the parameter.

" }, "Description":{ "shape":"String", "documentation":"

Provides a description of the parameter.

" }, "Source":{ "shape":"String", "documentation":"

Indicates the source of the parameter value.

" }, "ApplyType":{ "shape":"String", "documentation":"

Specifies the engine specific parameters type.

" }, "DataType":{ "shape":"String", "documentation":"

Specifies the valid data type for the parameter.

" }, "AllowedValues":{ "shape":"String", "documentation":"

Specifies the valid range of values for the parameter.

" }, "IsModifiable":{ "shape":"Boolean", "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" }, "MinimumEngineVersion":{ "shape":"String", "documentation":"

The earliest engine version to which the parameter can apply.

" }, "ApplyMethod":{ "shape":"ApplyMethod", "documentation":"

Indicates when to apply parameter updates.

" } }, "documentation":"

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

" }, "ParametersList":{ "type":"list", "member":{ "shape":"Parameter", "locationName":"Parameter" } }, "PendingModifiedValues":{ "type":"structure", "members":{ "DBInstanceClass":{ "shape":"String", "documentation":"

Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

" }, "AllocatedStorage":{ "shape":"IntegerOptional", "documentation":"

Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

" }, "MasterUserPassword":{ "shape":"String", "documentation":"

Contains the pending or in-progress change of the master credentials for the DB instance.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

Specifies the pending port for the DB instance.

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

Specifies the pending number of days for which automated backups are retained.

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

" }, "EngineVersion":{ "shape":"String", "documentation":"

Indicates the database engine version.

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.

" }, "DBInstanceIdentifier":{ "shape":"String", "documentation":"

Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

" }, "StorageType":{ "shape":"String", "documentation":"

Specifies storage type to be associated with the DB instance.

" } }, "documentation":"

This data type is used as a response element in the ModifyDBInstance action.

" }, "PointInTimeRestoreNotEnabledFault":{ "type":"structure", "members":{ }, "error":{ "code":"PointInTimeRestoreNotEnabled", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

" }, "PromoteReadReplicaMessage":{ "type":"structure", "required":["DBInstanceIdentifier"], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must be the identifier for an existing Read Replica DB instance
  • Must contain from 1 to 63 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens

Example: mydbinstance

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

  • Must be a value from 0 to 8
" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.

Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

" } }, "documentation":"

" }, "ProvisionedIopsNotAvailableInAZFault":{ "type":"structure", "members":{ }, "error":{ "code":"ProvisionedIopsNotAvailableInAZFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

" }, "PurchaseReservedDBInstancesOfferingMessage":{ "type":"structure", "required":["ReservedDBInstancesOfferingId"], "members":{ "ReservedDBInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved DB instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" }, "ReservedDBInstanceId":{ "shape":"String", "documentation":"

Customer-specified identifier to track this reservation.

Example: myreservationID

" }, "DBInstanceCount":{ "shape":"IntegerOptional", "documentation":"

The number of instances to reserve.

Default: 1

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "ReadReplicaDBInstanceIdentifierList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReadReplicaDBInstanceIdentifier" } }, "RebootDBInstanceMessage":{ "type":"structure", "required":["DBInstanceIdentifier"], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "ForceFailover":{ "shape":"BooleanOptional", "documentation":"

When true, the reboot will be conducted through a MultiAZ failover.

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

" } }, "documentation":"

" }, "RecurringCharge":{ "type":"structure", "members":{ "RecurringChargeAmount":{ "shape":"Double", "documentation":"

The amount of the recurring charge.

" }, "RecurringChargeFrequency":{ "shape":"String", "documentation":"

The frequency of the recurring charge.

" } }, "wrapper":true, "documentation":"

This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

" }, "RecurringChargeList":{ "type":"list", "member":{ "shape":"RecurringCharge", "locationName":"RecurringCharge" } }, "RemoveSourceIdentifierFromSubscriptionMessage":{ "type":"structure", "required":[ "SubscriptionName", "SourceIdentifier" ], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the RDS event notification subscription you want to remove a source identifier from.

" }, "SourceIdentifier":{ "shape":"String", "documentation":"

The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

" } }, "documentation":"

" }, "RemoveTagsFromResourceMessage":{ "type":"structure", "required":[ "ResourceName", "TagKeys" ], "members":{ "ResourceName":{ "shape":"String", "documentation":"

The Amazon RDS resource the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

" }, "TagKeys":{ "shape":"KeyList", "documentation":"

The tag key (name) of the tag to be removed.

" } }, "documentation":"

" }, "ReservedDBInstance":{ "type":"structure", "members":{ "ReservedDBInstanceId":{ "shape":"String", "documentation":"

The unique identifier for the reservation.

" }, "ReservedDBInstancesOfferingId":{ "shape":"String", "documentation":"

The offering identifier.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The DB instance class for the reserved DB instance.

" }, "StartTime":{ "shape":"TStamp", "documentation":"

The time the reservation started.

" }, "Duration":{ "shape":"Integer", "documentation":"

The duration of the reservation in seconds.

" }, "FixedPrice":{ "shape":"Double", "documentation":"

The fixed price charged for this reserved DB instance.

" }, "UsagePrice":{ "shape":"Double", "documentation":"

The hourly price charged for this reserved DB instance.

" }, "CurrencyCode":{ "shape":"String", "documentation":"

The currency code for the reserved DB instance.

" }, "DBInstanceCount":{ "shape":"Integer", "documentation":"

The number of reserved DB instances.

" }, "ProductDescription":{ "shape":"String", "documentation":"

The description of the reserved DB instance.

" }, "OfferingType":{ "shape":"String", "documentation":"

The offering type of this reserved DB instance.

" }, "MultiAZ":{ "shape":"Boolean", "documentation":"

Indicates if the reservation applies to Multi-AZ deployments.

" }, "State":{ "shape":"String", "documentation":"

The state of the reserved DB instance.

" }, "RecurringCharges":{ "shape":"RecurringChargeList", "documentation":"

The recurring price charged to run this reserved DB instance.

" } }, "wrapper":true, "documentation":"

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

" }, "ReservedDBInstanceAlreadyExistsFault":{ "type":"structure", "members":{ }, "error":{ "code":"ReservedDBInstanceAlreadyExists", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

User already has a reservation with the given identifier.

" }, "ReservedDBInstanceList":{ "type":"list", "member":{ "shape":"ReservedDBInstance", "locationName":"ReservedDBInstance" } }, "ReservedDBInstanceMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "ReservedDBInstances":{ "shape":"ReservedDBInstanceList", "documentation":"

A list of reserved DB instances.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

" }, "ReservedDBInstanceNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"ReservedDBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified reserved DB Instance not found.

" }, "ReservedDBInstanceQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"ReservedDBInstanceQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would exceed the user's DB Instance quota.

" }, "ReservedDBInstancesOffering":{ "type":"structure", "members":{ "ReservedDBInstancesOfferingId":{ "shape":"String", "documentation":"

The offering identifier.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The DB instance class for the reserved DB instance.

" }, "Duration":{ "shape":"Integer", "documentation":"

The duration of the offering in seconds.

" }, "FixedPrice":{ "shape":"Double", "documentation":"

The fixed price charged for this offering.

" }, "UsagePrice":{ "shape":"Double", "documentation":"

The hourly price charged for this offering.

" }, "CurrencyCode":{ "shape":"String", "documentation":"

The currency code for the reserved DB instance offering.

" }, "ProductDescription":{ "shape":"String", "documentation":"

The database engine used by the offering.

" }, "OfferingType":{ "shape":"String", "documentation":"

The offering type.

" }, "MultiAZ":{ "shape":"Boolean", "documentation":"

Indicates if the offering applies to Multi-AZ deployments.

" }, "RecurringCharges":{ "shape":"RecurringChargeList", "documentation":"

The recurring price charged to run this reserved DB instance.

" } }, "wrapper":true, "documentation":"

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

" }, "ReservedDBInstancesOfferingList":{ "type":"list", "member":{ "shape":"ReservedDBInstancesOffering", "locationName":"ReservedDBInstancesOffering" } }, "ReservedDBInstancesOfferingMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "ReservedDBInstancesOfferings":{ "shape":"ReservedDBInstancesOfferingList", "documentation":"

A list of reserved DB instance offerings.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

" }, "ReservedDBInstancesOfferingNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"ReservedDBInstancesOfferingNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

Specified offering does not exist.

" }, "ResetDBParameterGroupMessage":{ "type":"structure", "required":["DBParameterGroupName"], "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB parameter group.

Constraints:

  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "ResetAllParameters":{ "shape":"Boolean", "documentation":"

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

" } }, "documentation":"

" }, "RestoreDBInstanceFromDBSnapshotMessage":{ "type":"structure", "required":[ "DBInstanceIdentifier", "DBSnapshotIdentifier" ], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

Name of the DB instance to create from the DB snapshot. This parameter isn't case sensitive.

Constraints:

  • Must contain from 1 to 255 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

" }, "DBSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier for the DB snapshot to restore from.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The compute and memory capacity of the Amazon RDS DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which the database accepts connections.

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

The DB subnet group name to use for the new instance.

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

" }, "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

  • Default VPC:true
  • VPC:false

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. 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.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

" }, "LicenseModel":{ "shape":"String", "documentation":"

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

" }, "DBName":{ "shape":"String", "documentation":"

The database name for the restored DB instance.

This parameter doesn't apply to the MySQL engine.

" }, "Engine":{ "shape":"String", "documentation":"

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.

Constraints: Must be an integer greater than 1000.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

The name of the option group to be used for the restored DB instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, 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

" }, "Tags":{"shape":"TagList"}, "StorageType":{ "shape":"String", "documentation":"

Specifies storage type to be associated with the DB Instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

" }, "TdeCredentialArn":{ "shape":"String", "documentation":"

The ARN from the Key Store with which to associate the instance for TDE encryption.

" }, "TdeCredentialPassword":{ "shape":"String", "documentation":"

The password for the given ARN from the Key Store in order to access the device.

" } }, "documentation":"

" }, "RestoreDBInstanceToPointInTimeMessage":{ "type":"structure", "required":[ "SourceDBInstanceIdentifier", "TargetDBInstanceIdentifier" ], "members":{ "SourceDBInstanceIdentifier":{ "shape":"String", "documentation":"

The identifier of the source DB instance from which to restore.

Constraints:

  • Must be the identifier of an existing database instance
  • Must contain from 1 to 63 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "TargetDBInstanceIdentifier":{ "shape":"String", "documentation":"

The name of the new database instance to be created.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "RestoreTime":{ "shape":"TStamp", "documentation":"

The date and time to restore from.

Valid Values: Value must be a UTC time

Constraints:

  • Must be before the latest restorable time for the DB instance
  • Cannot be specified if UseLatestRestorableTime parameter is true

Example: 2009-09-07T23:45:00Z

" }, "UseLatestRestorableTime":{ "shape":"Boolean", "documentation":"

Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.

Default: false

Constraints: Cannot be specified if RestoreTime parameter is provided.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The compute and memory capacity of the Amazon RDS DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

Default: The same DBInstanceClass as the original DB instance.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which the database accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB instance.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

The DB subnet group name to use for the new instance.

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

" }, "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

  • Default VPC:true
  • VPC:false

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. 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.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

" }, "LicenseModel":{ "shape":"String", "documentation":"

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

" }, "DBName":{ "shape":"String", "documentation":"

The database name for the restored DB instance.

This parameter is not used for the MySQL engine.

" }, "Engine":{ "shape":"String", "documentation":"

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Constraints: Must be an integer greater than 1000.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

The name of the option group to be used for the restored DB instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, 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

" }, "Tags":{"shape":"TagList"}, "StorageType":{ "shape":"String", "documentation":"

Specifies storage type to be associated with the DB Instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

" }, "TdeCredentialArn":{ "shape":"String", "documentation":"

The ARN from the Key Store with which to associate the instance for TDE encryption.

" }, "TdeCredentialPassword":{ "shape":"String", "documentation":"

The password for the given ARN from the Key Store in order to access the device.

" } }, "documentation":"

" }, "RevokeDBSecurityGroupIngressMessage":{ "type":"structure", "required":["DBSecurityGroupName"], "members":{ "DBSecurityGroupName":{ "shape":"String", "documentation":"

The name of the DB security group to revoke ingress from.

" }, "CIDRIP":{ "shape":"String", "documentation":"

The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided.

" }, "EC2SecurityGroupName":{ "shape":"String", "documentation":"

The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" }, "EC2SecurityGroupId":{ "shape":"String", "documentation":"

The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" }, "EC2SecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" } }, "documentation":"

" }, "SNSInvalidTopicFault":{ "type":"structure", "members":{ }, "error":{ "code":"SNSInvalidTopic", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

SNS has responded that there is a problem with the SND topic specified.

" }, "SNSNoAuthorizationFault":{ "type":"structure", "members":{ }, "error":{ "code":"SNSNoAuthorization", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You do not have permission to publish to the SNS topic ARN.

" }, "SNSTopicArnNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"SNSTopicArnNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The SNS topic ARN does not exist.

" }, "SnapshotQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"SnapshotQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

" }, "SourceIdsList":{ "type":"list", "member":{ "shape":"String", "locationName":"SourceId" } }, "SourceNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"SourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested source could not be found.

" }, "SourceType":{ "type":"string", "enum":[ "db-instance", "db-parameter-group", "db-security-group", "db-snapshot" ] }, "StorageQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"StorageQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

" }, "StorageTypeNotSupportedFault":{ "type":"structure", "members":{ }, "error":{ "code":"StorageTypeNotSupported", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

StorageType specified cannot be associated with the DB Instance.

" }, "String":{"type":"string"}, "Subnet":{ "type":"structure", "members":{ "SubnetIdentifier":{ "shape":"String", "documentation":"

Specifies the identifier of the subnet.

" }, "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, "SubnetStatus":{ "shape":"String", "documentation":"

Specifies the status of the subnet.

" } }, "documentation":"

This data type is used as a response element in the DescribeDBSubnetGroups action.

" }, "SubnetAlreadyInUse":{ "type":"structure", "members":{ }, "error":{ "code":"SubnetAlreadyInUse", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The DB subnet is already in use in the Availability Zone.

" }, "SubnetIdentifierList":{ "type":"list", "member":{ "shape":"String", "locationName":"SubnetIdentifier" } }, "SubnetList":{ "type":"list", "member":{ "shape":"Subnet", "locationName":"Subnet" } }, "SubscriptionAlreadyExistFault":{ "type":"structure", "members":{ }, "error":{ "code":"SubscriptionAlreadyExist", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The supplied subscription name already exists.

" }, "SubscriptionCategoryNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"SubscriptionCategoryNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The supplied category does not exist.

" }, "SubscriptionNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"SubscriptionNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The subscription name does not exist.

" }, "SupportedCharacterSetsList":{ "type":"list", "member":{ "shape":"CharacterSet", "locationName":"CharacterSet" } }, "TStamp":{"type":"timestamp"}, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" }, "Value":{ "shape":"String", "documentation":"

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" } }, "documentation":"

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

" }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"Tag" }, "documentation":"

A list of tags.

" }, "TagListMessage":{ "type":"structure", "members":{ "TagList":{ "shape":"TagList", "documentation":"

List of tags returned by the ListTagsForResource operation.

" } }, "documentation":"

" }, "VpcSecurityGroupIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcSecurityGroupId" } }, "VpcSecurityGroupMembership":{ "type":"structure", "members":{ "VpcSecurityGroupId":{ "shape":"String", "documentation":"

The name of the VPC security group.

" }, "Status":{ "shape":"String", "documentation":"

The status of the VPC security group.

" } }, "documentation":"

This data type is used as a response element for queries on VPC security group membership.

" }, "VpcSecurityGroupMembershipList":{ "type":"list", "member":{ "shape":"VpcSecurityGroupMembership", "locationName":"VpcSecurityGroupMembership" } }, "AddSourceIdentifierToSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "AuthorizeDBSecurityGroupIngressResult":{ "type":"structure", "members":{ "DBSecurityGroup":{"shape":"DBSecurityGroup"} } }, "CopyDBParameterGroupResult":{ "type":"structure", "members":{ "DBParameterGroup":{"shape":"DBParameterGroup"} } }, "CopyDBSnapshotResult":{ "type":"structure", "members":{ "DBSnapshot":{"shape":"DBSnapshot"} } }, "CopyOptionGroupResult":{ "type":"structure", "members":{ "OptionGroup":{"shape":"OptionGroup"} } }, "CreateDBInstanceResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "CreateDBInstanceReadReplicaResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "CreateDBParameterGroupResult":{ "type":"structure", "members":{ "DBParameterGroup":{"shape":"DBParameterGroup"} } }, "CreateDBSecurityGroupResult":{ "type":"structure", "members":{ "DBSecurityGroup":{"shape":"DBSecurityGroup"} } }, "CreateDBSnapshotResult":{ "type":"structure", "members":{ "DBSnapshot":{"shape":"DBSnapshot"} } }, "CreateDBSubnetGroupResult":{ "type":"structure", "members":{ "DBSubnetGroup":{"shape":"DBSubnetGroup"} } }, "CreateEventSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "CreateOptionGroupResult":{ "type":"structure", "members":{ "OptionGroup":{"shape":"OptionGroup"} } }, "DeleteDBInstanceResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "DeleteDBSnapshotResult":{ "type":"structure", "members":{ "DBSnapshot":{"shape":"DBSnapshot"} } }, "DeleteEventSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "DescribeEngineDefaultParametersResult":{ "type":"structure", "members":{ "EngineDefaults":{"shape":"EngineDefaults"} } }, "ModifyDBInstanceResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "ModifyDBSubnetGroupResult":{ "type":"structure", "members":{ "DBSubnetGroup":{"shape":"DBSubnetGroup"} } }, "ModifyEventSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "ModifyOptionGroupResult":{ "type":"structure", "members":{ "OptionGroup":{"shape":"OptionGroup"} } }, "PromoteReadReplicaResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "PurchaseReservedDBInstancesOfferingResult":{ "type":"structure", "members":{ "ReservedDBInstance":{"shape":"ReservedDBInstance"} } }, "RebootDBInstanceResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "RemoveSourceIdentifierFromSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "RestoreDBInstanceFromDBSnapshotResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "RestoreDBInstanceToPointInTimeResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "RevokeDBSecurityGroupIngressResult":{ "type":"structure", "members":{ "DBSecurityGroup":{"shape":"DBSecurityGroup"} } } } } botocore-1.5.7/botocore/data/rds/2014-10-31/0000777454262600001440000000000013042511307020750 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/rds/2014-10-31/service-2.sdk-extras.json0000666454262600001440000000107013042511306025523 0ustar pysdk-ciamazon00000000000000 { "version": 1.0, "merge": { "shapes": { "CopyDBSnapshotMessage": { "members": { "SourceRegion": { "shape": "String", "documentation": "

The ID of the region that contains the snapshot to be copied.

" } } }, "CreateDBInstanceReadReplicaMessage": { "members": { "SourceRegion": { "shape": "String", "documentation": "

The ID of the region that contains the source for the read replica.

" } } } } } } botocore-1.5.7/botocore/data/rds/2014-10-31/waiters-2.json0000666454262600001440000000620613042511306023463 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DBInstanceAvailable": { "delay": 30, "operation": "DescribeDBInstances", "maxAttempts": 60, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "failed", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "incompatible-restore", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "incompatible-parameters", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "incompatible-parameters", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "incompatible-restore", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" } ] }, "DBInstanceDeleted": { "delay": 30, "operation": "DescribeDBInstances", "maxAttempts": 60, "acceptors": [ { "expected": "DBInstanceNotFound", "matcher": "error", "state": "success" }, { "expected": "deleted", "matcher": "pathAll", "state": "success", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "creating", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "modifying", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "rebooting", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" }, { "expected": "resetting-master-credentials", "matcher": "pathAny", "state": "failure", "argument": "DBInstances[].DBInstanceStatus" } ] }, "DBSnapshotCompleted": { "delay": 15, "operation": "DescribeDBSnapshots", "maxAttempts": 40, "acceptors": [ { "expected": "DBSnapshotNotFound", "matcher": "error", "state": "success" }, { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "DBSnapshots[].Status" } ] } } } botocore-1.5.7/botocore/data/rds/2014-10-31/paginators-1.json0000666454262600001440000000631313042511306024152 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeDBClusterSnapshots": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "DBClusterSnapshots" }, "DescribeDBEngineVersions": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "DBEngineVersions" }, "DescribeDBInstances": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "DBInstances" }, "DescribeDBLogFiles": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "DescribeDBLogFiles" }, "DescribeDBParameterGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "DBParameterGroups" }, "DescribeDBParameters": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Parameters" }, "DescribeDBSecurityGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "DBSecurityGroups" }, "DescribeDBSnapshots": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "DBSnapshots" }, "DescribeDBSubnetGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "DBSubnetGroups" }, "DescribeEngineDefaultParameters": { "input_token": "Marker", "output_token": "EngineDefaults.Marker", "limit_key": "MaxRecords", "result_key": "EngineDefaults.Parameters" }, "DescribeEventSubscriptions": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "EventSubscriptionsList" }, "DescribeEvents": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Events" }, "DescribeOptionGroupOptions": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "OptionGroupOptions" }, "DescribeOptionGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "OptionGroupsList" }, "DescribeOrderableDBInstanceOptions": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "OrderableDBInstanceOptions" }, "DescribeReservedDBInstances": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReservedDBInstances" }, "DescribeReservedDBInstancesOfferings": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReservedDBInstancesOfferings" }, "DownloadDBLogFilePortion": { "input_token": "Marker", "output_token": "Marker", "limit_key": "NumberOfLines", "more_results": "AdditionalDataPending", "result_key": "LogFileData" } } } botocore-1.5.7/botocore/data/rds/2014-10-31/service-2.json0000777454262600001440000161767113042511307023470 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2014-10-31", "endpointPrefix":"rds", "protocol":"query", "serviceAbbreviation":"Amazon RDS", "serviceFullName":"Amazon Relational Database Service", "signatureVersion":"v4", "uid":"rds-2014-10-31", "xmlNamespace":"http://rds.amazonaws.com/doc/2014-10-31/" }, "operations":{ "AddRoleToDBCluster":{ "name":"AddRoleToDBCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddRoleToDBClusterMessage"}, "errors":[ {"shape":"DBClusterNotFoundFault"}, {"shape":"DBClusterRoleAlreadyExistsFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"DBClusterRoleQuotaExceededFault"} ], "documentation":"

Associates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.

" }, "AddSourceIdentifierToSubscription":{ "name":"AddSourceIdentifierToSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddSourceIdentifierToSubscriptionMessage"}, "output":{ "shape":"AddSourceIdentifierToSubscriptionResult", "resultWrapper":"AddSourceIdentifierToSubscriptionResult" }, "errors":[ {"shape":"SubscriptionNotFoundFault"}, {"shape":"SourceNotFoundFault"} ], "documentation":"

Adds a source identifier to an existing RDS event notification subscription.

" }, "AddTagsToResource":{ "name":"AddTagsToResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsToResourceMessage"}, "errors":[ {"shape":"DBInstanceNotFoundFault"}, {"shape":"DBSnapshotNotFoundFault"}, {"shape":"DBClusterNotFoundFault"} ], "documentation":"

Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.

" }, "ApplyPendingMaintenanceAction":{ "name":"ApplyPendingMaintenanceAction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ApplyPendingMaintenanceActionMessage"}, "output":{ "shape":"ApplyPendingMaintenanceActionResult", "resultWrapper":"ApplyPendingMaintenanceActionResult" }, "errors":[ {"shape":"ResourceNotFoundFault"} ], "documentation":"

Applies a pending maintenance action to a resource (for example, to a DB instance).

" }, "AuthorizeDBSecurityGroupIngress":{ "name":"AuthorizeDBSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeDBSecurityGroupIngressMessage"}, "output":{ "shape":"AuthorizeDBSecurityGroupIngressResult", "resultWrapper":"AuthorizeDBSecurityGroupIngressResult" }, "errors":[ {"shape":"DBSecurityGroupNotFoundFault"}, {"shape":"InvalidDBSecurityGroupStateFault"}, {"shape":"AuthorizationAlreadyExistsFault"}, {"shape":"AuthorizationQuotaExceededFault"} ], "documentation":"

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

You cannot authorize ingress from an EC2 security group in one region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

" }, "CopyDBClusterParameterGroup":{ "name":"CopyDBClusterParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyDBClusterParameterGroupMessage"}, "output":{ "shape":"CopyDBClusterParameterGroupResult", "resultWrapper":"CopyDBClusterParameterGroupResult" }, "errors":[ {"shape":"DBParameterGroupNotFoundFault"}, {"shape":"DBParameterGroupQuotaExceededFault"}, {"shape":"DBParameterGroupAlreadyExistsFault"} ], "documentation":"

Copies the specified DB cluster parameter group.

" }, "CopyDBClusterSnapshot":{ "name":"CopyDBClusterSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyDBClusterSnapshotMessage"}, "output":{ "shape":"CopyDBClusterSnapshotResult", "resultWrapper":"CopyDBClusterSnapshotResult" }, "errors":[ {"shape":"DBClusterSnapshotAlreadyExistsFault"}, {"shape":"DBClusterSnapshotNotFoundFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"InvalidDBClusterSnapshotStateFault"}, {"shape":"SnapshotQuotaExceededFault"}, {"shape":"KMSKeyNotAccessibleFault"} ], "documentation":"

Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "CopyDBParameterGroup":{ "name":"CopyDBParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyDBParameterGroupMessage"}, "output":{ "shape":"CopyDBParameterGroupResult", "resultWrapper":"CopyDBParameterGroupResult" }, "errors":[ {"shape":"DBParameterGroupNotFoundFault"}, {"shape":"DBParameterGroupAlreadyExistsFault"}, {"shape":"DBParameterGroupQuotaExceededFault"} ], "documentation":"

Copies the specified DB parameter group.

" }, "CopyDBSnapshot":{ "name":"CopyDBSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyDBSnapshotMessage"}, "output":{ "shape":"CopyDBSnapshotResult", "resultWrapper":"CopyDBSnapshotResult" }, "errors":[ {"shape":"DBSnapshotAlreadyExistsFault"}, {"shape":"DBSnapshotNotFoundFault"}, {"shape":"InvalidDBSnapshotStateFault"}, {"shape":"SnapshotQuotaExceededFault"}, {"shape":"KMSKeyNotAccessibleFault"} ], "documentation":"

Copies the specified DB snapshot. The source DB snapshot must be in the \"available\" state.

To copy a DB snapshot from a shared manual DB snapshot, SourceDBSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB snapshot.

You can copy an encrypted DB snapshot from another AWS Region. In that case, the region where you call the CopyDBSnapshot action is the destination region for the encrypted DB snapshot to be copied to. To copy an encrypted DB snapshot from another region, you must provide the following values:

  • KmsKeyId - The AWS Key Management System (KMS) key identifier for the key to use to encrypt the copy of the DB snapshot in the destination region.

  • PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBSnapshot action to be called in the source region where the DB snapshot will be copied from. The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source region that contains the encrypted DB snapshot to be copied.

    The presigned URL request must contain the following parameter values:

    • DestinationRegion - The AWS Region that the encrypted DB snapshot will be copied to. This region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

      For example, if you copy an encrypted DB snapshot from the us-west-2 region to the us-east-1 region, then you will call the CopyDBSnapshot action in the us-east-1 region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 region.

    • KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination region. This identifier is the same for both the CopyDBSnapshot action that is called in the destination region, and the action contained in the presigned URL.

    • SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source region. For example, if you copy an encrypted DB snapshot from the us-west-2 region, then your SourceDBSnapshotIdentifier looks like this example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

  • TargetDBSnapshotIdentifier - The identifier for the new copy of the DB snapshot in the destination region.

  • SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the ARN format for the source region and is the same value as the SourceDBSnapshotIdentifier in the presigned URL.

For more information on copying encrypted snapshots from one region to another, see Copying an Encrypted DB Snapshot to Another Region in the Amazon RDS User Guide.

" }, "CopyOptionGroup":{ "name":"CopyOptionGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyOptionGroupMessage"}, "output":{ "shape":"CopyOptionGroupResult", "resultWrapper":"CopyOptionGroupResult" }, "errors":[ {"shape":"OptionGroupAlreadyExistsFault"}, {"shape":"OptionGroupNotFoundFault"}, {"shape":"OptionGroupQuotaExceededFault"} ], "documentation":"

Copies the specified option group.

" }, "CreateDBCluster":{ "name":"CreateDBCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBClusterMessage"}, "output":{ "shape":"CreateDBClusterResult", "resultWrapper":"CreateDBClusterResult" }, "errors":[ {"shape":"DBClusterAlreadyExistsFault"}, {"shape":"InsufficientStorageClusterCapacityFault"}, {"shape":"DBClusterQuotaExceededFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"InvalidDBSubnetGroupStateFault"}, {"shape":"InvalidSubnet"}, {"shape":"InvalidDBInstanceStateFault"}, {"shape":"DBClusterParameterGroupNotFoundFault"}, {"shape":"KMSKeyNotAccessibleFault"}, {"shape":"DBClusterNotFoundFault"}, {"shape":"DBInstanceNotFoundFault"}, {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"} ], "documentation":"

Creates a new Amazon Aurora DB cluster.

You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL DB instance.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "CreateDBClusterParameterGroup":{ "name":"CreateDBClusterParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBClusterParameterGroupMessage"}, "output":{ "shape":"CreateDBClusterParameterGroupResult", "resultWrapper":"CreateDBClusterParameterGroupResult" }, "errors":[ {"shape":"DBParameterGroupQuotaExceededFault"}, {"shape":"DBParameterGroupAlreadyExistsFault"} ], "documentation":"

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "CreateDBClusterSnapshot":{ "name":"CreateDBClusterSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBClusterSnapshotMessage"}, "output":{ "shape":"CreateDBClusterSnapshotResult", "resultWrapper":"CreateDBClusterSnapshotResult" }, "errors":[ {"shape":"DBClusterSnapshotAlreadyExistsFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"DBClusterNotFoundFault"}, {"shape":"SnapshotQuotaExceededFault"}, {"shape":"InvalidDBClusterSnapshotStateFault"} ], "documentation":"

Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "CreateDBInstance":{ "name":"CreateDBInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBInstanceMessage"}, "output":{ "shape":"CreateDBInstanceResult", "resultWrapper":"CreateDBInstanceResult" }, "errors":[ {"shape":"DBInstanceAlreadyExistsFault"}, {"shape":"InsufficientDBInstanceCapacityFault"}, {"shape":"DBParameterGroupNotFoundFault"}, {"shape":"DBSecurityGroupNotFoundFault"}, {"shape":"InstanceQuotaExceededFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"InvalidSubnet"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"ProvisionedIopsNotAvailableInAZFault"}, {"shape":"OptionGroupNotFoundFault"}, {"shape":"DBClusterNotFoundFault"}, {"shape":"StorageTypeNotSupportedFault"}, {"shape":"AuthorizationNotFoundFault"}, {"shape":"KMSKeyNotAccessibleFault"}, {"shape":"DomainNotFoundFault"} ], "documentation":"

Creates a new DB instance.

" }, "CreateDBInstanceReadReplica":{ "name":"CreateDBInstanceReadReplica", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBInstanceReadReplicaMessage"}, "output":{ "shape":"CreateDBInstanceReadReplicaResult", "resultWrapper":"CreateDBInstanceReadReplicaResult" }, "errors":[ {"shape":"DBInstanceAlreadyExistsFault"}, {"shape":"InsufficientDBInstanceCapacityFault"}, {"shape":"DBParameterGroupNotFoundFault"}, {"shape":"DBSecurityGroupNotFoundFault"}, {"shape":"InstanceQuotaExceededFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"DBInstanceNotFoundFault"}, {"shape":"InvalidDBInstanceStateFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, {"shape":"InvalidSubnet"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"ProvisionedIopsNotAvailableInAZFault"}, {"shape":"OptionGroupNotFoundFault"}, {"shape":"DBSubnetGroupNotAllowedFault"}, {"shape":"InvalidDBSubnetGroupFault"}, {"shape":"StorageTypeNotSupportedFault"}, {"shape":"KMSKeyNotAccessibleFault"} ], "documentation":"

Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL that acts as a Read Replica of a source DB instance.

All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.

The source DB instance must have backup retention enabled.

You can create an encrypted Read Replica in a different AWS Region than the source DB instance. In that case, the region where you call the CreateDBInstanceReadReplica action is the destination region of the encrypted Read Replica. The source DB instance must be encrypted.

To create an encrypted Read Replica in another AWS Region, you must provide the following values:

  • KmsKeyId - The AWS Key Management System (KMS) key identifier for the key to use to encrypt the Read Replica in the destination region.

  • PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the AWS region that contains the source DB instance. The PreSignedUrl parameter must be used when encrypting a Read Replica from another AWS region.

    The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source region that contains the encrypted DB instance. The presigned URL request must contain the following parameter values:

    • DestinationRegion - The AWS Region that the Read Replica is created in. This region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

      For example, if you create an encrypted Read Replica in the us-east-1 region, and the source DB instance is in the west-2 region, then you call the CreateDBInstanceReadReplica action in the us-east-1 region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 region.

    • KmsKeyId - The KMS key identifier for the key to use to encrypt the Read Replica in the destination region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination region, and the action contained in the presigned URL.

    • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted Read Replica to be created. This identifier must be in the Amazon Resource Name (ARN) format for the source region. For example, if you create an encrypted Read Replica from a DB instance in the us-west-2 region, then your SourceDBInstanceIdentifier would look like this example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-instance-20161115.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

  • DBInstanceIdentifier - The identifier for the encrypted Read Replica in the destination region.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted Read Replica. This identifier must be in the ARN format for the source region and is the same value as the SourceDBInstanceIdentifier in the presigned URL.

" }, "CreateDBParameterGroup":{ "name":"CreateDBParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBParameterGroupMessage"}, "output":{ "shape":"CreateDBParameterGroupResult", "resultWrapper":"CreateDBParameterGroupResult" }, "errors":[ {"shape":"DBParameterGroupQuotaExceededFault"}, {"shape":"DBParameterGroupAlreadyExistsFault"} ], "documentation":"

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

" }, "CreateDBSecurityGroup":{ "name":"CreateDBSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBSecurityGroupMessage"}, "output":{ "shape":"CreateDBSecurityGroupResult", "resultWrapper":"CreateDBSecurityGroupResult" }, "errors":[ {"shape":"DBSecurityGroupAlreadyExistsFault"}, {"shape":"DBSecurityGroupQuotaExceededFault"}, {"shape":"DBSecurityGroupNotSupportedFault"} ], "documentation":"

Creates a new DB security group. DB security groups control access to a DB instance.

" }, "CreateDBSnapshot":{ "name":"CreateDBSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBSnapshotMessage"}, "output":{ "shape":"CreateDBSnapshotResult", "resultWrapper":"CreateDBSnapshotResult" }, "errors":[ {"shape":"DBSnapshotAlreadyExistsFault"}, {"shape":"InvalidDBInstanceStateFault"}, {"shape":"DBInstanceNotFoundFault"}, {"shape":"SnapshotQuotaExceededFault"} ], "documentation":"

Creates a DBSnapshot. The source DBInstance must be in \"available\" state.

" }, "CreateDBSubnetGroup":{ "name":"CreateDBSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDBSubnetGroupMessage"}, "output":{ "shape":"CreateDBSubnetGroupResult", "resultWrapper":"CreateDBSubnetGroupResult" }, "errors":[ {"shape":"DBSubnetGroupAlreadyExistsFault"}, {"shape":"DBSubnetGroupQuotaExceededFault"}, {"shape":"DBSubnetQuotaExceededFault"}, {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, {"shape":"InvalidSubnet"} ], "documentation":"

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

" }, "CreateEventSubscription":{ "name":"CreateEventSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateEventSubscriptionMessage"}, "output":{ "shape":"CreateEventSubscriptionResult", "resultWrapper":"CreateEventSubscriptionResult" }, "errors":[ {"shape":"EventSubscriptionQuotaExceededFault"}, {"shape":"SubscriptionAlreadyExistFault"}, {"shape":"SNSInvalidTopicFault"}, {"shape":"SNSNoAuthorizationFault"}, {"shape":"SNSTopicArnNotFoundFault"}, {"shape":"SubscriptionCategoryNotFoundFault"}, {"shape":"SourceNotFoundFault"} ], "documentation":"

Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.

" }, "CreateOptionGroup":{ "name":"CreateOptionGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateOptionGroupMessage"}, "output":{ "shape":"CreateOptionGroupResult", "resultWrapper":"CreateOptionGroupResult" }, "errors":[ {"shape":"OptionGroupAlreadyExistsFault"}, {"shape":"OptionGroupQuotaExceededFault"} ], "documentation":"

Creates a new option group. You can create up to 20 option groups.

" }, "DeleteDBCluster":{ "name":"DeleteDBCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDBClusterMessage"}, "output":{ "shape":"DeleteDBClusterResult", "resultWrapper":"DeleteDBClusterResult" }, "errors":[ {"shape":"DBClusterNotFoundFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"DBClusterSnapshotAlreadyExistsFault"}, {"shape":"SnapshotQuotaExceededFault"}, {"shape":"InvalidDBClusterSnapshotStateFault"} ], "documentation":"

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "DeleteDBClusterParameterGroup":{ "name":"DeleteDBClusterParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDBClusterParameterGroupMessage"}, "errors":[ {"shape":"InvalidDBParameterGroupStateFault"}, {"shape":"DBParameterGroupNotFoundFault"} ], "documentation":"

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "DeleteDBClusterSnapshot":{ "name":"DeleteDBClusterSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDBClusterSnapshotMessage"}, "output":{ "shape":"DeleteDBClusterSnapshotResult", "resultWrapper":"DeleteDBClusterSnapshotResult" }, "errors":[ {"shape":"InvalidDBClusterSnapshotStateFault"}, {"shape":"DBClusterSnapshotNotFoundFault"} ], "documentation":"

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB cluster snapshot must be in the available state to be deleted.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "DeleteDBInstance":{ "name":"DeleteDBInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDBInstanceMessage"}, "output":{ "shape":"DeleteDBInstanceResult", "resultWrapper":"DeleteDBInstanceResult" }, "errors":[ {"shape":"DBInstanceNotFoundFault"}, {"shape":"InvalidDBInstanceStateFault"}, {"shape":"DBSnapshotAlreadyExistsFault"}, {"shape":"SnapshotQuotaExceededFault"}, {"shape":"InvalidDBClusterStateFault"} ], "documentation":"

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.

Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

If the specified DB instance is part of an Amazon Aurora DB cluster, you cannot delete the DB instance if the following are true:

  • The DB cluster is a Read Replica of another Amazon Aurora DB cluster.

  • The DB instance is the only instance in the DB cluster.

To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.

" }, "DeleteDBParameterGroup":{ "name":"DeleteDBParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDBParameterGroupMessage"}, "errors":[ {"shape":"InvalidDBParameterGroupStateFault"}, {"shape":"DBParameterGroupNotFoundFault"} ], "documentation":"

Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.

" }, "DeleteDBSecurityGroup":{ "name":"DeleteDBSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDBSecurityGroupMessage"}, "errors":[ {"shape":"InvalidDBSecurityGroupStateFault"}, {"shape":"DBSecurityGroupNotFoundFault"} ], "documentation":"

Deletes a DB security group.

The specified DB security group must not be associated with any DB instances.

" }, "DeleteDBSnapshot":{ "name":"DeleteDBSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDBSnapshotMessage"}, "output":{ "shape":"DeleteDBSnapshotResult", "resultWrapper":"DeleteDBSnapshotResult" }, "errors":[ {"shape":"InvalidDBSnapshotStateFault"}, {"shape":"DBSnapshotNotFoundFault"} ], "documentation":"

Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.

The DBSnapshot must be in the available state to be deleted.

" }, "DeleteDBSubnetGroup":{ "name":"DeleteDBSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDBSubnetGroupMessage"}, "errors":[ {"shape":"InvalidDBSubnetGroupStateFault"}, {"shape":"InvalidDBSubnetStateFault"}, {"shape":"DBSubnetGroupNotFoundFault"} ], "documentation":"

Deletes a DB subnet group.

The specified database subnet group must not be associated with any DB instances.

" }, "DeleteEventSubscription":{ "name":"DeleteEventSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteEventSubscriptionMessage"}, "output":{ "shape":"DeleteEventSubscriptionResult", "resultWrapper":"DeleteEventSubscriptionResult" }, "errors":[ {"shape":"SubscriptionNotFoundFault"}, {"shape":"InvalidEventSubscriptionStateFault"} ], "documentation":"

Deletes an RDS event notification subscription.

" }, "DeleteOptionGroup":{ "name":"DeleteOptionGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteOptionGroupMessage"}, "errors":[ {"shape":"OptionGroupNotFoundFault"}, {"shape":"InvalidOptionGroupStateFault"} ], "documentation":"

Deletes an existing option group.

" }, "DescribeAccountAttributes":{ "name":"DescribeAccountAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAccountAttributesMessage"}, "output":{ "shape":"AccountAttributesMessage", "resultWrapper":"DescribeAccountAttributesResult" }, "documentation":"

Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

This command does not take any parameters.

" }, "DescribeCertificates":{ "name":"DescribeCertificates", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCertificatesMessage"}, "output":{ "shape":"CertificateMessage", "resultWrapper":"DescribeCertificatesResult" }, "errors":[ {"shape":"CertificateNotFoundFault"} ], "documentation":"

Lists the set of CA certificates provided by Amazon RDS for this AWS account.

" }, "DescribeDBClusterParameterGroups":{ "name":"DescribeDBClusterParameterGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBClusterParameterGroupsMessage"}, "output":{ "shape":"DBClusterParameterGroupsMessage", "resultWrapper":"DescribeDBClusterParameterGroupsResult" }, "errors":[ {"shape":"DBParameterGroupNotFoundFault"} ], "documentation":"

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "DescribeDBClusterParameters":{ "name":"DescribeDBClusterParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBClusterParametersMessage"}, "output":{ "shape":"DBClusterParameterGroupDetails", "resultWrapper":"DescribeDBClusterParametersResult" }, "errors":[ {"shape":"DBParameterGroupNotFoundFault"} ], "documentation":"

Returns the detailed parameter list for a particular DB cluster parameter group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "DescribeDBClusterSnapshotAttributes":{ "name":"DescribeDBClusterSnapshotAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBClusterSnapshotAttributesMessage"}, "output":{ "shape":"DescribeDBClusterSnapshotAttributesResult", "resultWrapper":"DescribeDBClusterSnapshotAttributesResult" }, "errors":[ {"shape":"DBClusterSnapshotNotFoundFault"} ], "documentation":"

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.

To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

" }, "DescribeDBClusterSnapshots":{ "name":"DescribeDBClusterSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBClusterSnapshotsMessage"}, "output":{ "shape":"DBClusterSnapshotMessage", "resultWrapper":"DescribeDBClusterSnapshotsResult" }, "errors":[ {"shape":"DBClusterSnapshotNotFoundFault"} ], "documentation":"

Returns information about DB cluster snapshots. This API action supports pagination.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "DescribeDBClusters":{ "name":"DescribeDBClusters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBClustersMessage"}, "output":{ "shape":"DBClusterMessage", "resultWrapper":"DescribeDBClustersResult" }, "errors":[ {"shape":"DBClusterNotFoundFault"} ], "documentation":"

Returns information about provisioned Aurora DB clusters. This API supports pagination.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "DescribeDBEngineVersions":{ "name":"DescribeDBEngineVersions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBEngineVersionsMessage"}, "output":{ "shape":"DBEngineVersionMessage", "resultWrapper":"DescribeDBEngineVersionsResult" }, "documentation":"

Returns a list of the available DB engines.

" }, "DescribeDBInstances":{ "name":"DescribeDBInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBInstancesMessage"}, "output":{ "shape":"DBInstanceMessage", "resultWrapper":"DescribeDBInstancesResult" }, "errors":[ {"shape":"DBInstanceNotFoundFault"} ], "documentation":"

Returns information about provisioned RDS instances. This API supports pagination.

" }, "DescribeDBLogFiles":{ "name":"DescribeDBLogFiles", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBLogFilesMessage"}, "output":{ "shape":"DescribeDBLogFilesResponse", "resultWrapper":"DescribeDBLogFilesResult" }, "errors":[ {"shape":"DBInstanceNotFoundFault"} ], "documentation":"

Returns a list of DB log files for the DB instance.

" }, "DescribeDBParameterGroups":{ "name":"DescribeDBParameterGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBParameterGroupsMessage"}, "output":{ "shape":"DBParameterGroupsMessage", "resultWrapper":"DescribeDBParameterGroupsResult" }, "errors":[ {"shape":"DBParameterGroupNotFoundFault"} ], "documentation":"

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

" }, "DescribeDBParameters":{ "name":"DescribeDBParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBParametersMessage"}, "output":{ "shape":"DBParameterGroupDetails", "resultWrapper":"DescribeDBParametersResult" }, "errors":[ {"shape":"DBParameterGroupNotFoundFault"} ], "documentation":"

Returns the detailed parameter list for a particular DB parameter group.

" }, "DescribeDBSecurityGroups":{ "name":"DescribeDBSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBSecurityGroupsMessage"}, "output":{ "shape":"DBSecurityGroupMessage", "resultWrapper":"DescribeDBSecurityGroupsResult" }, "errors":[ {"shape":"DBSecurityGroupNotFoundFault"} ], "documentation":"

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

" }, "DescribeDBSnapshotAttributes":{ "name":"DescribeDBSnapshotAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBSnapshotAttributesMessage"}, "output":{ "shape":"DescribeDBSnapshotAttributesResult", "resultWrapper":"DescribeDBSnapshotAttributesResult" }, "errors":[ {"shape":"DBSnapshotNotFoundFault"} ], "documentation":"

Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts.

To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

" }, "DescribeDBSnapshots":{ "name":"DescribeDBSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBSnapshotsMessage"}, "output":{ "shape":"DBSnapshotMessage", "resultWrapper":"DescribeDBSnapshotsResult" }, "errors":[ {"shape":"DBSnapshotNotFoundFault"} ], "documentation":"

Returns information about DB snapshots. This API action supports pagination.

" }, "DescribeDBSubnetGroups":{ "name":"DescribeDBSubnetGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDBSubnetGroupsMessage"}, "output":{ "shape":"DBSubnetGroupMessage", "resultWrapper":"DescribeDBSubnetGroupsResult" }, "errors":[ {"shape":"DBSubnetGroupNotFoundFault"} ], "documentation":"

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

" }, "DescribeEngineDefaultClusterParameters":{ "name":"DescribeEngineDefaultClusterParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEngineDefaultClusterParametersMessage"}, "output":{ "shape":"DescribeEngineDefaultClusterParametersResult", "resultWrapper":"DescribeEngineDefaultClusterParametersResult" }, "documentation":"

Returns the default engine and system parameter information for the cluster database engine.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "DescribeEngineDefaultParameters":{ "name":"DescribeEngineDefaultParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEngineDefaultParametersMessage"}, "output":{ "shape":"DescribeEngineDefaultParametersResult", "resultWrapper":"DescribeEngineDefaultParametersResult" }, "documentation":"

Returns the default engine and system parameter information for the specified database engine.

" }, "DescribeEventCategories":{ "name":"DescribeEventCategories", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventCategoriesMessage"}, "output":{ "shape":"EventCategoriesMessage", "resultWrapper":"DescribeEventCategoriesResult" }, "documentation":"

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.

" }, "DescribeEventSubscriptions":{ "name":"DescribeEventSubscriptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventSubscriptionsMessage"}, "output":{ "shape":"EventSubscriptionsMessage", "resultWrapper":"DescribeEventSubscriptionsResult" }, "errors":[ {"shape":"SubscriptionNotFoundFault"} ], "documentation":"

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

" }, "DescribeEvents":{ "name":"DescribeEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventsMessage"}, "output":{ "shape":"EventsMessage", "resultWrapper":"DescribeEventsResult" }, "documentation":"

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

" }, "DescribeOptionGroupOptions":{ "name":"DescribeOptionGroupOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeOptionGroupOptionsMessage"}, "output":{ "shape":"OptionGroupOptionsMessage", "resultWrapper":"DescribeOptionGroupOptionsResult" }, "documentation":"

Describes all available options.

" }, "DescribeOptionGroups":{ "name":"DescribeOptionGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeOptionGroupsMessage"}, "output":{ "shape":"OptionGroups", "resultWrapper":"DescribeOptionGroupsResult" }, "errors":[ {"shape":"OptionGroupNotFoundFault"} ], "documentation":"

Describes the available option groups.

" }, "DescribeOrderableDBInstanceOptions":{ "name":"DescribeOrderableDBInstanceOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeOrderableDBInstanceOptionsMessage"}, "output":{ "shape":"OrderableDBInstanceOptionsMessage", "resultWrapper":"DescribeOrderableDBInstanceOptionsResult" }, "documentation":"

Returns a list of orderable DB instance options for the specified engine.

" }, "DescribePendingMaintenanceActions":{ "name":"DescribePendingMaintenanceActions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePendingMaintenanceActionsMessage"}, "output":{ "shape":"PendingMaintenanceActionsMessage", "resultWrapper":"DescribePendingMaintenanceActionsResult" }, "errors":[ {"shape":"ResourceNotFoundFault"} ], "documentation":"

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

" }, "DescribeReservedDBInstances":{ "name":"DescribeReservedDBInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedDBInstancesMessage"}, "output":{ "shape":"ReservedDBInstanceMessage", "resultWrapper":"DescribeReservedDBInstancesResult" }, "errors":[ {"shape":"ReservedDBInstanceNotFoundFault"} ], "documentation":"

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

" }, "DescribeReservedDBInstancesOfferings":{ "name":"DescribeReservedDBInstancesOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedDBInstancesOfferingsMessage"}, "output":{ "shape":"ReservedDBInstancesOfferingMessage", "resultWrapper":"DescribeReservedDBInstancesOfferingsResult" }, "errors":[ {"shape":"ReservedDBInstancesOfferingNotFoundFault"} ], "documentation":"

Lists available reserved DB instance offerings.

" }, "DescribeSourceRegions":{ "name":"DescribeSourceRegions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSourceRegionsMessage"}, "output":{ "shape":"SourceRegionMessage", "resultWrapper":"DescribeSourceRegionsResult" }, "documentation":"

Returns a list of the source AWS regions where the current AWS region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.

" }, "DownloadDBLogFilePortion":{ "name":"DownloadDBLogFilePortion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DownloadDBLogFilePortionMessage"}, "output":{ "shape":"DownloadDBLogFilePortionDetails", "resultWrapper":"DownloadDBLogFilePortionResult" }, "errors":[ {"shape":"DBInstanceNotFoundFault"}, {"shape":"DBLogFileNotFoundFault"} ], "documentation":"

Downloads all or a portion of the specified log file, up to 1 MB in size.

" }, "FailoverDBCluster":{ "name":"FailoverDBCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"FailoverDBClusterMessage"}, "output":{ "shape":"FailoverDBClusterResult", "resultWrapper":"FailoverDBClusterResult" }, "errors":[ {"shape":"DBClusterNotFoundFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"InvalidDBInstanceStateFault"} ], "documentation":"

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceMessage"}, "output":{ "shape":"TagListMessage", "resultWrapper":"ListTagsForResourceResult" }, "errors":[ {"shape":"DBInstanceNotFoundFault"}, {"shape":"DBSnapshotNotFoundFault"}, {"shape":"DBClusterNotFoundFault"} ], "documentation":"

Lists all tags on an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.

" }, "ModifyDBCluster":{ "name":"ModifyDBCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDBClusterMessage"}, "output":{ "shape":"ModifyDBClusterResult", "resultWrapper":"ModifyDBClusterResult" }, "errors":[ {"shape":"DBClusterNotFoundFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"InvalidDBSubnetGroupStateFault"}, {"shape":"InvalidSubnet"}, {"shape":"DBClusterParameterGroupNotFoundFault"}, {"shape":"InvalidDBSecurityGroupStateFault"}, {"shape":"InvalidDBInstanceStateFault"}, {"shape":"DBClusterAlreadyExistsFault"} ], "documentation":"

Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "ModifyDBClusterParameterGroup":{ "name":"ModifyDBClusterParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDBClusterParameterGroupMessage"}, "output":{ "shape":"DBClusterParameterGroupNameMessage", "resultWrapper":"ModifyDBClusterParameterGroupResult" }, "errors":[ {"shape":"DBParameterGroupNotFoundFault"}, {"shape":"InvalidDBParameterGroupStateFault"} ], "documentation":"

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

" }, "ModifyDBClusterSnapshotAttribute":{ "name":"ModifyDBClusterSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDBClusterSnapshotAttributeMessage"}, "output":{ "shape":"ModifyDBClusterSnapshotAttributeResult", "resultWrapper":"ModifyDBClusterSnapshotAttributeResult" }, "errors":[ {"shape":"DBClusterSnapshotNotFoundFault"}, {"shape":"InvalidDBClusterSnapshotStateFault"}, {"shape":"SharedSnapshotQuotaExceededFault"} ], "documentation":"

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts.

To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.

If a manual DB cluster snapshot is encrypted, it cannot be shared.

" }, "ModifyDBInstance":{ "name":"ModifyDBInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDBInstanceMessage"}, "output":{ "shape":"ModifyDBInstanceResult", "resultWrapper":"ModifyDBInstanceResult" }, "errors":[ {"shape":"InvalidDBInstanceStateFault"}, {"shape":"InvalidDBSecurityGroupStateFault"}, {"shape":"DBInstanceAlreadyExistsFault"}, {"shape":"DBInstanceNotFoundFault"}, {"shape":"DBSecurityGroupNotFoundFault"}, {"shape":"DBParameterGroupNotFoundFault"}, {"shape":"InsufficientDBInstanceCapacityFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"ProvisionedIopsNotAvailableInAZFault"}, {"shape":"OptionGroupNotFoundFault"}, {"shape":"DBUpgradeDependencyFailureFault"}, {"shape":"StorageTypeNotSupportedFault"}, {"shape":"AuthorizationNotFoundFault"}, {"shape":"CertificateNotFoundFault"}, {"shape":"DomainNotFoundFault"} ], "documentation":"

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

" }, "ModifyDBParameterGroup":{ "name":"ModifyDBParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDBParameterGroupMessage"}, "output":{ "shape":"DBParameterGroupNameMessage", "resultWrapper":"ModifyDBParameterGroupResult" }, "errors":[ {"shape":"DBParameterGroupNotFoundFault"}, {"shape":"InvalidDBParameterGroupStateFault"} ], "documentation":"

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

" }, "ModifyDBSnapshot":{ "name":"ModifyDBSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDBSnapshotMessage"}, "output":{ "shape":"ModifyDBSnapshotResult", "resultWrapper":"ModifyDBSnapshotResult" }, "errors":[ {"shape":"DBSnapshotNotFoundFault"} ], "documentation":"

Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version. You can update the engine version to either a new major or minor engine version.

Amazon RDS supports upgrading a MySQL DB snapshot from MySQL 5.1 to MySQL 5.5.

" }, "ModifyDBSnapshotAttribute":{ "name":"ModifyDBSnapshotAttribute", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDBSnapshotAttributeMessage"}, "output":{ "shape":"ModifyDBSnapshotAttributeResult", "resultWrapper":"ModifyDBSnapshotAttributeResult" }, "errors":[ {"shape":"DBSnapshotNotFoundFault"}, {"shape":"InvalidDBSnapshotStateFault"}, {"shape":"SharedSnapshotQuotaExceededFault"} ], "documentation":"

Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts.

To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action.

If the manual DB snapshot is encrypted, it cannot be shared.

" }, "ModifyDBSubnetGroup":{ "name":"ModifyDBSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyDBSubnetGroupMessage"}, "output":{ "shape":"ModifyDBSubnetGroupResult", "resultWrapper":"ModifyDBSubnetGroupResult" }, "errors":[ {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"DBSubnetQuotaExceededFault"}, {"shape":"SubnetAlreadyInUse"}, {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, {"shape":"InvalidSubnet"} ], "documentation":"

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

" }, "ModifyEventSubscription":{ "name":"ModifyEventSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyEventSubscriptionMessage"}, "output":{ "shape":"ModifyEventSubscriptionResult", "resultWrapper":"ModifyEventSubscriptionResult" }, "errors":[ {"shape":"EventSubscriptionQuotaExceededFault"}, {"shape":"SubscriptionNotFoundFault"}, {"shape":"SNSInvalidTopicFault"}, {"shape":"SNSNoAuthorizationFault"}, {"shape":"SNSTopicArnNotFoundFault"}, {"shape":"SubscriptionCategoryNotFoundFault"} ], "documentation":"

Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" }, "ModifyOptionGroup":{ "name":"ModifyOptionGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyOptionGroupMessage"}, "output":{ "shape":"ModifyOptionGroupResult", "resultWrapper":"ModifyOptionGroupResult" }, "errors":[ {"shape":"InvalidOptionGroupStateFault"}, {"shape":"OptionGroupNotFoundFault"} ], "documentation":"

Modifies an existing option group.

" }, "PromoteReadReplica":{ "name":"PromoteReadReplica", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PromoteReadReplicaMessage"}, "output":{ "shape":"PromoteReadReplicaResult", "resultWrapper":"PromoteReadReplicaResult" }, "errors":[ {"shape":"InvalidDBInstanceStateFault"}, {"shape":"DBInstanceNotFoundFault"} ], "documentation":"

Promotes a Read Replica DB instance to a standalone DB instance.

We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.

" }, "PromoteReadReplicaDBCluster":{ "name":"PromoteReadReplicaDBCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PromoteReadReplicaDBClusterMessage"}, "output":{ "shape":"PromoteReadReplicaDBClusterResult", "resultWrapper":"PromoteReadReplicaDBClusterResult" }, "errors":[ {"shape":"DBClusterNotFoundFault"}, {"shape":"InvalidDBClusterStateFault"} ], "documentation":"

Promotes a Read Replica DB cluster to a standalone DB cluster.

" }, "PurchaseReservedDBInstancesOffering":{ "name":"PurchaseReservedDBInstancesOffering", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseReservedDBInstancesOfferingMessage"}, "output":{ "shape":"PurchaseReservedDBInstancesOfferingResult", "resultWrapper":"PurchaseReservedDBInstancesOfferingResult" }, "errors":[ {"shape":"ReservedDBInstancesOfferingNotFoundFault"}, {"shape":"ReservedDBInstanceAlreadyExistsFault"}, {"shape":"ReservedDBInstanceQuotaExceededFault"} ], "documentation":"

Purchases a reserved DB instance offering.

" }, "RebootDBInstance":{ "name":"RebootDBInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootDBInstanceMessage"}, "output":{ "shape":"RebootDBInstanceResult", "resultWrapper":"RebootDBInstanceResult" }, "errors":[ {"shape":"InvalidDBInstanceStateFault"}, {"shape":"DBInstanceNotFoundFault"} ], "documentation":"

Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.

If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.

The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.

" }, "RemoveRoleFromDBCluster":{ "name":"RemoveRoleFromDBCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveRoleFromDBClusterMessage"}, "errors":[ {"shape":"DBClusterNotFoundFault"}, {"shape":"DBClusterRoleNotFoundFault"}, {"shape":"InvalidDBClusterStateFault"} ], "documentation":"

Disassociates an Identity and Access Management (IAM) role from an Aurora DB cluster. For more information, see Authorizing Amazon Aurora to Access Other AWS Services On Your Behalf.

" }, "RemoveSourceIdentifierFromSubscription":{ "name":"RemoveSourceIdentifierFromSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveSourceIdentifierFromSubscriptionMessage"}, "output":{ "shape":"RemoveSourceIdentifierFromSubscriptionResult", "resultWrapper":"RemoveSourceIdentifierFromSubscriptionResult" }, "errors":[ {"shape":"SubscriptionNotFoundFault"}, {"shape":"SourceNotFoundFault"} ], "documentation":"

Removes a source identifier from an existing RDS event notification subscription.

" }, "RemoveTagsFromResource":{ "name":"RemoveTagsFromResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTagsFromResourceMessage"}, "errors":[ {"shape":"DBInstanceNotFoundFault"}, {"shape":"DBSnapshotNotFoundFault"}, {"shape":"DBClusterNotFoundFault"} ], "documentation":"

Removes metadata tags from an Amazon RDS resource.

For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.

" }, "ResetDBClusterParameterGroup":{ "name":"ResetDBClusterParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetDBClusterParameterGroupMessage"}, "output":{ "shape":"DBClusterParameterGroupNameMessage", "resultWrapper":"ResetDBClusterParameterGroupResult" }, "errors":[ {"shape":"InvalidDBParameterGroupStateFault"}, {"shape":"DBParameterGroupNotFoundFault"} ], "documentation":"

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "ResetDBParameterGroup":{ "name":"ResetDBParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetDBParameterGroupMessage"}, "output":{ "shape":"DBParameterGroupNameMessage", "resultWrapper":"ResetDBParameterGroupResult" }, "errors":[ {"shape":"InvalidDBParameterGroupStateFault"}, {"shape":"DBParameterGroupNotFoundFault"} ], "documentation":"

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

" }, "RestoreDBClusterFromS3":{ "name":"RestoreDBClusterFromS3", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreDBClusterFromS3Message"}, "output":{ "shape":"RestoreDBClusterFromS3Result", "resultWrapper":"RestoreDBClusterFromS3Result" }, "errors":[ {"shape":"DBClusterAlreadyExistsFault"}, {"shape":"DBClusterQuotaExceededFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"InvalidDBClusterStateFault"}, {"shape":"InvalidDBSubnetGroupStateFault"}, {"shape":"InvalidSubnet"}, {"shape":"InvalidS3BucketFault"}, {"shape":"DBClusterParameterGroupNotFoundFault"}, {"shape":"KMSKeyNotAccessibleFault"}, {"shape":"DBClusterNotFoundFault"}, {"shape":"InsufficientStorageClusterCapacityFault"} ], "documentation":"

Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data from MySQL by Using an Amazon S3 Bucket.

" }, "RestoreDBClusterFromSnapshot":{ "name":"RestoreDBClusterFromSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreDBClusterFromSnapshotMessage"}, "output":{ "shape":"RestoreDBClusterFromSnapshotResult", "resultWrapper":"RestoreDBClusterFromSnapshotResult" }, "errors":[ {"shape":"DBClusterAlreadyExistsFault"}, {"shape":"DBClusterQuotaExceededFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"DBSnapshotNotFoundFault"}, {"shape":"DBClusterSnapshotNotFoundFault"}, {"shape":"InsufficientDBClusterCapacityFault"}, {"shape":"InsufficientStorageClusterCapacityFault"}, {"shape":"InvalidDBSnapshotStateFault"}, {"shape":"InvalidDBClusterSnapshotStateFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"InvalidRestoreFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"InvalidSubnet"}, {"shape":"OptionGroupNotFoundFault"}, {"shape":"KMSKeyNotAccessibleFault"} ], "documentation":"

Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "RestoreDBClusterToPointInTime":{ "name":"RestoreDBClusterToPointInTime", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreDBClusterToPointInTimeMessage"}, "output":{ "shape":"RestoreDBClusterToPointInTimeResult", "resultWrapper":"RestoreDBClusterToPointInTimeResult" }, "errors":[ {"shape":"DBClusterAlreadyExistsFault"}, {"shape":"DBClusterQuotaExceededFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"DBClusterNotFoundFault"}, {"shape":"DBClusterSnapshotNotFoundFault"}, {"shape":"InsufficientDBClusterCapacityFault"}, {"shape":"InsufficientStorageClusterCapacityFault"}, {"shape":"InvalidDBSnapshotStateFault"}, {"shape":"InvalidDBClusterSnapshotStateFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"InvalidRestoreFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"InvalidSubnet"}, {"shape":"OptionGroupNotFoundFault"}, {"shape":"KMSKeyNotAccessibleFault"} ], "documentation":"

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

" }, "RestoreDBInstanceFromDBSnapshot":{ "name":"RestoreDBInstanceFromDBSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreDBInstanceFromDBSnapshotMessage"}, "output":{ "shape":"RestoreDBInstanceFromDBSnapshotResult", "resultWrapper":"RestoreDBInstanceFromDBSnapshotResult" }, "errors":[ {"shape":"DBInstanceAlreadyExistsFault"}, {"shape":"DBSnapshotNotFoundFault"}, {"shape":"InstanceQuotaExceededFault"}, {"shape":"InsufficientDBInstanceCapacityFault"}, {"shape":"InvalidDBSnapshotStateFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"InvalidRestoreFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, {"shape":"InvalidSubnet"}, {"shape":"ProvisionedIopsNotAvailableInAZFault"}, {"shape":"OptionGroupNotFoundFault"}, {"shape":"StorageTypeNotSupportedFault"}, {"shape":"AuthorizationNotFoundFault"}, {"shape":"KMSKeyNotAccessibleFault"}, {"shape":"DBSecurityGroupNotFoundFault"}, {"shape":"DomainNotFoundFault"} ], "documentation":"

Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.

If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

" }, "RestoreDBInstanceToPointInTime":{ "name":"RestoreDBInstanceToPointInTime", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreDBInstanceToPointInTimeMessage"}, "output":{ "shape":"RestoreDBInstanceToPointInTimeResult", "resultWrapper":"RestoreDBInstanceToPointInTimeResult" }, "errors":[ {"shape":"DBInstanceAlreadyExistsFault"}, {"shape":"DBInstanceNotFoundFault"}, {"shape":"InstanceQuotaExceededFault"}, {"shape":"InsufficientDBInstanceCapacityFault"}, {"shape":"InvalidDBInstanceStateFault"}, {"shape":"PointInTimeRestoreNotEnabledFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"InvalidRestoreFault"}, {"shape":"DBSubnetGroupNotFoundFault"}, {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, {"shape":"InvalidSubnet"}, {"shape":"ProvisionedIopsNotAvailableInAZFault"}, {"shape":"OptionGroupNotFoundFault"}, {"shape":"StorageTypeNotSupportedFault"}, {"shape":"AuthorizationNotFoundFault"}, {"shape":"KMSKeyNotAccessibleFault"}, {"shape":"DBSecurityGroupNotFoundFault"}, {"shape":"DomainNotFoundFault"} ], "documentation":"

Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

The target database is created with most of the original configuration, but in a system-selected availability zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.

" }, "RevokeDBSecurityGroupIngress":{ "name":"RevokeDBSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeDBSecurityGroupIngressMessage"}, "output":{ "shape":"RevokeDBSecurityGroupIngressResult", "resultWrapper":"RevokeDBSecurityGroupIngressResult" }, "errors":[ {"shape":"DBSecurityGroupNotFoundFault"}, {"shape":"AuthorizationNotFoundFault"}, {"shape":"InvalidDBSecurityGroupStateFault"} ], "documentation":"

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

" } }, "shapes":{ "AccountAttributesMessage":{ "type":"structure", "members":{ "AccountQuotas":{ "shape":"AccountQuotaList", "documentation":"

A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.

" } }, "documentation":"

Data returned by the DescribeAccountAttributes action.

" }, "AccountQuota":{ "type":"structure", "members":{ "AccountQuotaName":{ "shape":"String", "documentation":"

The name of the Amazon RDS quota for this AWS account.

" }, "Used":{ "shape":"Long", "documentation":"

The amount currently used toward the quota maximum.

" }, "Max":{ "shape":"Long", "documentation":"

The maximum allowed value for the quota.

" } }, "documentation":"

Describes a quota for an AWS account, for example, the number of DB instances allowed.

", "wrapper":true }, "AccountQuotaList":{ "type":"list", "member":{ "shape":"AccountQuota", "locationName":"AccountQuota" } }, "AddRoleToDBClusterMessage":{ "type":"structure", "required":[ "DBClusterIdentifier", "RoleArn" ], "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

The name of the DB cluster to associate the IAM role with.

" }, "RoleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

" } } }, "AddSourceIdentifierToSubscriptionMessage":{ "type":"structure", "required":[ "SubscriptionName", "SourceIdentifier" ], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the RDS event notification subscription you want to add a source identifier to.

" }, "SourceIdentifier":{ "shape":"String", "documentation":"

The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

" } }, "documentation":"

" }, "AddSourceIdentifierToSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "AddTagsToResourceMessage":{ "type":"structure", "required":[ "ResourceName", "Tags" ], "members":{ "ResourceName":{ "shape":"String", "documentation":"

The Amazon RDS resource the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be assigned to the Amazon RDS resource.

" } }, "documentation":"

" }, "ApplyMethod":{ "type":"string", "enum":[ "immediate", "pending-reboot" ] }, "ApplyPendingMaintenanceActionMessage":{ "type":"structure", "required":[ "ResourceIdentifier", "ApplyAction", "OptInType" ], "members":{ "ResourceIdentifier":{ "shape":"String", "documentation":"

The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

" }, "ApplyAction":{ "shape":"String", "documentation":"

The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

" }, "OptInType":{ "shape":"String", "documentation":"

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate cannot be undone.

Valid values:

  • immediate - Apply the maintenance action immediately.

  • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

  • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

" } }, "documentation":"

" }, "ApplyPendingMaintenanceActionResult":{ "type":"structure", "members":{ "ResourcePendingMaintenanceActions":{"shape":"ResourcePendingMaintenanceActions"} } }, "AttributeValueList":{ "type":"list", "member":{ "shape":"String", "locationName":"AttributeValue" } }, "AuthorizationAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.

", "error":{ "code":"AuthorizationAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "AuthorizationNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

RDS may not also be authorized via IAM to perform necessary actions on your behalf.

", "error":{ "code":"AuthorizationNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "AuthorizationQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

DB security group authorization quota has been reached.

", "error":{ "code":"AuthorizationQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "AuthorizeDBSecurityGroupIngressMessage":{ "type":"structure", "required":["DBSecurityGroupName"], "members":{ "DBSecurityGroupName":{ "shape":"String", "documentation":"

The name of the DB security group to add authorization to.

" }, "CIDRIP":{ "shape":"String", "documentation":"

The IP range to authorize.

" }, "EC2SecurityGroupName":{ "shape":"String", "documentation":"

Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" }, "EC2SecurityGroupId":{ "shape":"String", "documentation":"

Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" }, "EC2SecurityGroupOwnerId":{ "shape":"String", "documentation":"

AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" } }, "documentation":"

" }, "AuthorizeDBSecurityGroupIngressResult":{ "type":"structure", "members":{ "DBSecurityGroup":{"shape":"DBSecurityGroup"} } }, "AvailabilityZone":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the availability zone.

" } }, "documentation":"

Contains Availability Zone information.

This data type is used as an element in the following data type:

", "wrapper":true }, "AvailabilityZoneList":{ "type":"list", "member":{ "shape":"AvailabilityZone", "locationName":"AvailabilityZone" } }, "AvailabilityZones":{ "type":"list", "member":{ "shape":"String", "locationName":"AvailabilityZone" } }, "Boolean":{"type":"boolean"}, "BooleanOptional":{"type":"boolean"}, "Certificate":{ "type":"structure", "members":{ "CertificateIdentifier":{ "shape":"String", "documentation":"

The unique key that identifies a certificate.

" }, "CertificateType":{ "shape":"String", "documentation":"

The type of the certificate.

" }, "Thumbprint":{ "shape":"String", "documentation":"

The thumbprint of the certificate.

" }, "ValidFrom":{ "shape":"TStamp", "documentation":"

The starting date from which the certificate is valid.

" }, "ValidTill":{ "shape":"TStamp", "documentation":"

The final date that the certificate continues to be valid.

" }, "CertificateArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the certificate.

" } }, "documentation":"

A CA certificate for an AWS account.

", "wrapper":true }, "CertificateList":{ "type":"list", "member":{ "shape":"Certificate", "locationName":"Certificate" } }, "CertificateMessage":{ "type":"structure", "members":{ "Certificates":{ "shape":"CertificateList", "documentation":"

The list of Certificate objects for the AWS account.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" } }, "documentation":"

Data returned by the DescribeCertificates action.

" }, "CertificateNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

CertificateIdentifier does not refer to an existing certificate.

", "error":{ "code":"CertificateNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "CharacterSet":{ "type":"structure", "members":{ "CharacterSetName":{ "shape":"String", "documentation":"

The name of the character set.

" }, "CharacterSetDescription":{ "shape":"String", "documentation":"

The description of the character set.

" } }, "documentation":"

This data type is used as a response element in the action DescribeDBEngineVersions.

" }, "CopyDBClusterParameterGroupMessage":{ "type":"structure", "required":[ "SourceDBClusterParameterGroupIdentifier", "TargetDBClusterParameterGroupIdentifier", "TargetDBClusterParameterGroupDescription" ], "members":{ "SourceDBClusterParameterGroupIdentifier":{ "shape":"String", "documentation":"

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

Constraints:

  • Must specify a valid DB cluster parameter group.

  • If the source DB cluster parameter group is in the same region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN.

  • If the source DB parameter group is in a different region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

" }, "TargetDBClusterParameterGroupIdentifier":{ "shape":"String", "documentation":"

The identifier for the copied DB cluster parameter group.

Constraints:

  • Cannot be null, empty, or blank

  • Must contain from 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-cluster-param-group1

" }, "TargetDBClusterParameterGroupDescription":{ "shape":"String", "documentation":"

A description for the copied DB cluster parameter group.

" }, "Tags":{"shape":"TagList"} } }, "CopyDBClusterParameterGroupResult":{ "type":"structure", "members":{ "DBClusterParameterGroup":{"shape":"DBClusterParameterGroup"} } }, "CopyDBClusterSnapshotMessage":{ "type":"structure", "required":[ "SourceDBClusterSnapshotIdentifier", "TargetDBClusterSnapshotIdentifier" ], "members":{ "SourceDBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot1

" }, "TargetDBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CopyDBClusterSnapshotResult":{ "type":"structure", "members":{ "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} } }, "CopyDBParameterGroupMessage":{ "type":"structure", "required":[ "SourceDBParameterGroupIdentifier", "TargetDBParameterGroupIdentifier", "TargetDBParameterGroupDescription" ], "members":{ "SourceDBParameterGroupIdentifier":{ "shape":"String", "documentation":"

The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

Constraints:

  • Must specify a valid DB parameter group.

  • Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.

" }, "TargetDBParameterGroupIdentifier":{ "shape":"String", "documentation":"

The identifier for the copied DB parameter group.

Constraints:

  • Cannot be null, empty, or blank

  • Must contain from 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-db-parameter-group

" }, "TargetDBParameterGroupDescription":{ "shape":"String", "documentation":"

A description for the copied DB parameter group.

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CopyDBParameterGroupResult":{ "type":"structure", "members":{ "DBParameterGroup":{"shape":"DBParameterGroup"} } }, "CopyDBSnapshotMessage":{ "type":"structure", "required":[ "SourceDBSnapshotIdentifier", "TargetDBSnapshotIdentifier" ], "members":{ "SourceDBSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier for the source DB snapshot.

If you are copying from a shared manual DB snapshot, this must be the ARN of the shared DB snapshot.

You cannot copy an encrypted, shared DB snapshot from one AWS region to another.

Constraints:

  • Must specify a valid system snapshot in the \"available\" state.

  • If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier.

  • If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot.

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

" }, "TargetDBSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier for the copied snapshot.

Constraints:

  • Cannot be null, empty, or blank

  • Must contain from 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

" }, "KmsKeyId":{ "shape":"String", "documentation":"

The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an unencrypted DB snapshot and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target DB snapshot using the specified KMS encryption key.

If you copy an encrypted DB snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

If you copy an encrypted snapshot to a different AWS region, then you must specify a KMS key for the destination AWS region.

If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

To copy an encrypted DB snapshot to another region, you must set KmsKeyId to the KMS key ID used to encrypt the copy of the DB snapshot in the destination region. KMS encryption keys are specific to the region that they are created in, and you cannot use encryption keys from one region in another region.

" }, "Tags":{"shape":"TagList"}, "CopyTags":{ "shape":"BooleanOptional", "documentation":"

True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.

" }, "PreSignedUrl":{ "shape":"String", "documentation":"

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the AWS region that contains the source DB snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB snapshot from another AWS region.

The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The AWS Region that the encrypted DB snapshot will be copied to. This region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

    For example, if you copy an encrypted DB snapshot from the us-west-2 region to the us-east-1 region, then you will call the CopyDBSnapshot action in the us-east-1 region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 region.

  • KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination region, and the action contained in the presigned URL.

  • SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source region. For example, if you are copying an encrypted DB snapshot from the us-west-2 region, then your SourceDBSnapshotIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

" } }, "documentation":"

" }, "CopyDBSnapshotResult":{ "type":"structure", "members":{ "DBSnapshot":{"shape":"DBSnapshot"} } }, "CopyOptionGroupMessage":{ "type":"structure", "required":[ "SourceOptionGroupIdentifier", "TargetOptionGroupIdentifier", "TargetOptionGroupDescription" ], "members":{ "SourceOptionGroupIdentifier":{ "shape":"String", "documentation":"

The identifier or ARN for the source option group. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

Constraints:

  • Must specify a valid option group.

  • If the source option group is in the same region as the copy, specify a valid option group identifier, for example my-option-group, or a valid ARN.

  • If the source option group is in a different region than the copy, specify a valid option group ARN, for example arn:aws:rds:us-west-2:123456789012:og:special-options.

" }, "TargetOptionGroupIdentifier":{ "shape":"String", "documentation":"

The identifier for the copied option group.

Constraints:

  • Cannot be null, empty, or blank

  • Must contain from 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-option-group

" }, "TargetOptionGroupDescription":{ "shape":"String", "documentation":"

The description for the copied option group.

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CopyOptionGroupResult":{ "type":"structure", "members":{ "OptionGroup":{"shape":"OptionGroup"} } }, "CreateDBClusterMessage":{ "type":"structure", "required":[ "DBClusterIdentifier", "Engine" ], "members":{ "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

A list of EC2 Availability Zones that instances in the DB cluster can be created in. For information on regions and Availability Zones, see Regions and Availability Zones.

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

" }, "CharacterSetName":{ "shape":"String", "documentation":"

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

" }, "DatabaseName":{ "shape":"String", "documentation":"

The name for your database of up to 8 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

The DB cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

" }, "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, default.aurora5.6 will be used.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A list of EC2 VPC security groups to associate with this DB cluster.

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

A DB subnet group to associate with this DB cluster.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

" }, "Engine":{ "shape":"String", "documentation":"

The name of the database engine to be used for this DB cluster.

Valid Values: aurora

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the database engine to use.

Aurora

Example: 5.6.10a

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which the instances in the DB cluster accept connections.

Default: 3306

" }, "MasterUsername":{ "shape":"String", "documentation":"

The name of the master user for the DB cluster.

Constraints:

  • Must be 1 to 16 alphanumeric characters.

  • First character must be a letter.

  • Cannot be a reserved word for the chosen database engine.

" }, "MasterUserPassword":{ "shape":"String", "documentation":"

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain from 8 to 41 characters.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

A value that indicates that the DB cluster should be associated with the specified option group.

Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.

" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Times should be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

" }, "ReplicationSourceIdentifier":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

" }, "Tags":{"shape":"TagList"}, "StorageEncrypted":{ "shape":"BooleanOptional", "documentation":"

Specifies whether the DB cluster is encrypted.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

The KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

" } }, "documentation":"

" }, "CreateDBClusterParameterGroupMessage":{ "type":"structure", "required":[ "DBClusterParameterGroupName", "DBParameterGroupFamily", "Description" ], "members":{ "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB cluster parameter group.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

" }, "DBParameterGroupFamily":{ "shape":"String", "documentation":"

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

" }, "Description":{ "shape":"String", "documentation":"

The description for the DB cluster parameter group.

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CreateDBClusterParameterGroupResult":{ "type":"structure", "members":{ "DBClusterParameterGroup":{"shape":"DBClusterParameterGroup"} } }, "CreateDBClusterResult":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "CreateDBClusterSnapshotMessage":{ "type":"structure", "required":[ "DBClusterSnapshotIdentifier", "DBClusterIdentifier" ], "members":{ "DBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1-snapshot1

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be assigned to the DB cluster snapshot.

" } }, "documentation":"

" }, "CreateDBClusterSnapshotResult":{ "type":"structure", "members":{ "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} } }, "CreateDBInstanceMessage":{ "type":"structure", "required":[ "DBInstanceIdentifier", "DBInstanceClass", "Engine" ], "members":{ "DBName":{ "shape":"String", "documentation":"

The meaning of this parameter differs according to the database engine you use.

Type: String

MySQL

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 alphanumeric characters

  • Cannot be a word reserved by the specified database engine

MariaDB

The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 alphanumeric characters

  • Cannot be a word reserved by the specified database engine

PostgreSQL

The name of the database to create when the DB instance is created. If this parameter is not specified, the default \"postgres\" database is created in the DB instance.

Constraints:

  • Must contain 1 to 63 alphanumeric characters

  • Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).

  • Cannot be a word reserved by the specified database engine

Oracle

The Oracle System ID (SID) of the created DB instance.

Default: ORCL

Constraints:

  • Cannot be longer than 8 characters

SQL Server

Not applicable. Must be null.

Amazon Aurora

The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance.

Constraints:

  • Must contain 1 to 64 alphanumeric characters

  • Cannot be a word reserved by the specified database engine

" }, "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

" }, "AllocatedStorage":{ "shape":"IntegerOptional", "documentation":"

The amount of storage (in gigabytes) to be initially allocated for the database instance.

Type: Integer

MySQL

Constraints: Must be an integer from 5 to 6144.

MariaDB

Constraints: Must be an integer from 5 to 6144.

PostgreSQL

Constraints: Must be an integer from 5 to 6144.

Oracle

Constraints: Must be an integer from 10 to 6144.

SQL Server

Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition)

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The compute and memory capacity of the DB instance. Note that not all instance classes are available in all regions for all DB engines.

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 | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

" }, "Engine":{ "shape":"String", "documentation":"

The name of the database engine to be used for this instance.

Valid Values: mysql | mariadb | oracle-se1 | oracle-se2 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres | aurora

Not every database engine is available for every AWS region.

" }, "MasterUsername":{ "shape":"String", "documentation":"

The name of master user for the client DB instance.

MySQL

Constraints:

  • Must be 1 to 16 alphanumeric characters.

  • First character must be a letter.

  • Cannot be a reserved word for the chosen database engine.

MariaDB

Constraints:

  • Must be 1 to 16 alphanumeric characters.

  • Cannot be a reserved word for the chosen database engine.

Type: String

Oracle

Constraints:

  • Must be 1 to 30 alphanumeric characters.

  • First character must be a letter.

  • Cannot be a reserved word for the chosen database engine.

SQL Server

Constraints:

  • Must be 1 to 128 alphanumeric characters.

  • First character must be a letter.

  • Cannot be a reserved word for the chosen database engine.

PostgreSQL

Constraints:

  • Must be 1 to 63 alphanumeric characters.

  • First character must be a letter.

  • Cannot be a reserved word for the chosen database engine.

" }, "MasterUserPassword":{ "shape":"String", "documentation":"

The password for the master database user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".

Type: String

MySQL

Constraints: Must contain from 8 to 41 characters.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

SQL Server

Constraints: Must contain from 8 to 128 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Amazon Aurora

Constraints: Must contain from 8 to 41 characters.

" }, "DBSecurityGroups":{ "shape":"DBSecurityGroupNameList", "documentation":"

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A list of EC2 VPC security groups to associate with this DB instance.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see Regions and Availability Zones.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see DB Instance Maintenance.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

" }, "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

  • Must be a value from 0 to 35

  • Cannot be set to 0 if the DB instance is a source to Read Replicas

" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see DB Instance Backups.

Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Times should be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

MariaDB

Default: 3306

Valid Values: 1150-65535

Type: Integer

PostgreSQL

Default: 5432

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

Amazon Aurora

Default: 3306

Valid Values: 1150-65535

Type: Integer

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the database engine to use.

The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.

Amazon Aurora

  • Version 5.6 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-2, eu-west-1, us-east-1, us-east-2, us-west-2): 5.6.10a

MariaDB

  • Version 10.1 (available in these AWS regions: us-east-2): 10.1.16

  • Version 10.1 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 10.1.14

  • Version 10.0 (available in all AWS regions): 10.0.24

  • Version 10.0 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 10.0.17

Microsoft SQL Server 2016

  • 13.00.2164.0.v1 (supported for all editions, and all AWS regions except sa-east-1)

Microsoft SQL Server 2014

  • 12.00.5000.0.v1 (supported for all editions, and all AWS regions)

  • 12.00.4422.0.v1 (supported for all editions except Enterprise Edition, and all AWS regions except us-east-2)

Microsoft SQL Server 2012

  • 11.00.6020.0.v1 (supported for all editions, and all AWS regions)

  • 11.00.5058.0.v1 (supported for all editions, and all AWS regions except us-east-2)

  • 11.00.2100.60.v1 (supported for all editions, and all AWS regions except us-east-2)

Microsoft SQL Server 2008 R2

  • 10.50.6529.0.v1 (supported for all editions, and all AWS regions except us-east-2)

  • 10.50.6000.34.v1 (supported for all editions, and all AWS regions except us-east-2)

  • 10.50.2789.0.v1 (supported for all editions, and all AWS regions except us-east-2)

MySQL

  • Version 5.7 (available in all AWS regions): 5.7.11

  • Version 5.7 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.7.10

  • Version 5.6 (available in all AWS regions): 5.6.29

  • Version 5.6 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.6.27

  • Version 5.6 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.6.23

  • Version 5.6 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.6.19a | 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22

  • Version 5.5 (available in all AWS regions): 5.5.46

  • Version 5.1 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 5.1.73a | 5.1.73b

Oracle Database Enterprise Edition (oracle-ee)

  • Version 12.1 (available in all AWS regions except ap-south-1, ap-northeast-2): 12.1.0.1.v1 | 12.1.0.1.v2

  • Version 12.1 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 12.1.0.1.v3 | 12.1.0.1.v4 | 12.1.0.1.v5

  • Version 12.1 (available in all AWS regions): 12.1.0.2.v1

  • Version 12.1 (available in all AWS regions except us-gov-west-1): 12.1.0.2.v2 | 12.1.0.2.v3 | 12.1.0.2.v4

  • Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7

  • Version 11.2 (available in all AWS regions except ap-south-1, ap-northeast-2): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3

  • Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 11.2.0.3.v4

  • Version 11.2 (available in all AWS regions): 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4

  • Version 11.2 (available in all AWS regions except us-gov-west-1): 11.2.0.4.v5 | 11.2.0.4.v6 | 11.2.0.4.v7 | 11.2.0.4.v8

Oracle Database Standard Edition (oracle-se)

  • Version 12.1 (available in all AWS regions except ap-south-1, ap-northeast-2): 12.1.0.1.v1 | 12.1.0.1.v2

  • Version 12.1 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 12.1.0.1.v3 | 12.1.0.1.v4 | 12.1.0.1.v5

  • Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7

  • Version 11.2 (available in all AWS regions except ap-south-1, ap-northeast-2): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3

  • Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 11.2.0.3.v4

  • Version 11.2 (available in all AWS regions): 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4

  • Version 11.2 (available in all AWS regions except us-gov-west-1): 11.2.0.4.v5 | 11.2.0.4.v6 | 11.2.0.4.v7 | 11.2.0.4.v8

Oracle Database Standard Edition One (oracle-se1)

  • Version 12.1 (available in all AWS regions except ap-south-1, ap-northeast-2): 12.1.0.1.v1 | 12.1.0.1.v2

  • Version 12.1 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 12.1.0.1.v3 | 12.1.0.1.v4 | 12.1.0.1.v5

  • Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7

  • Version 11.2 (available in all AWS regions except ap-south-1, ap-northeast-2): 11.2.0.3.v1 | 11.2.0.3.v2 | 11.2.0.3.v3

  • Version 11.2 (only available in AWS regions ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 11.2.0.3.v4

  • Version 11.2 (available in all AWS regions): 11.2.0.4.v1 | 11.2.0.4.v3 | 11.2.0.4.v4

  • Version 11.2 (available in all AWS regions except us-gov-west-1): 11.2.0.4.v5 | 11.2.0.4.v6 | 11.2.0.4.v7 | 11.2.0.4.v8

Oracle Database Standard Edition Two (oracle-se2)

  • Version 12.1 (available in all AWS regions except us-gov-west-1): 12.1.0.2.v2 | 12.1.0.2.v3 | 12.1.0.2.v4

PostgreSQL

  • Version 9.6: 9.6.1

  • Version 9.5: 9.5.4 | 9.5.2

  • Version 9.4: 9.4.9 | 9.4.7 | 9.4.5 | 9.4.4 | 9.4.1

  • Version 9.3: 9.3.14 | 9.3.12 | 9.3.10 | 9.3.9 | 9.3.6 | 9.3.5 | 9.3.3 | 9.3.2 | 9.3.1

Oracle 12c

  • 12.1.0.2.v6 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)

  • 12.1.0.2.v5 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)

  • 12.1.0.2.v4 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)

  • 12.1.0.2.v3 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)

  • 12.1.0.2.v2 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)

  • 12.1.0.2.v1 (supported for EE in all AWS regions, and SE2 in all AWS regions except us-gov-west-1)

  • 12.1.0.1.v6 (supported for EE, SE1, and SE, in all AWS regions except ap-south-1, ap-northeast-2)

  • 12.1.0.1.v5 (supported for EE, SE1, and SE, in all AWS regions except ap-south-1, ap-northeast-2)

  • 12.1.0.1.v4 (supported for EE, SE1, and SE, in all AWS regions except ap-south-1, ap-northeast-2)

  • 12.1.0.1.v3 (supported for EE, SE1, and SE, in all AWS regions except ap-south-1, ap-northeast-2)

  • 12.1.0.1.v2 (supported for EE, SE1, and SE, in all AWS regions except ap-south-1, ap-northeast-2)

  • 12.1.0.1.v1 (supported for EE, SE1, and SE, in all AWS regions except ap-south-1, ap-northeast-2)

Oracle 11g

  • 11.2.0.4.v10 (supported for EE, SE1, and SE, in all AWS regions)

  • 11.2.0.4.v9 (supported for EE, SE1, and SE, in all AWS regions)

  • 11.2.0.4.v8 (supported for EE, SE1, and SE, in all AWS regions)

  • 11.2.0.4.v7 (supported for EE, SE1, and SE, in all AWS regions)

  • 11.2.0.4.v6 (supported for EE, SE1, and SE, in all AWS regions)

  • 11.2.0.4.v5 (supported for EE, SE1, and SE, in all AWS regions)

  • 11.2.0.4.v4 (supported for EE, SE1, and SE, in all AWS regions)

  • 11.2.0.4.v3 (supported for EE, SE1, and SE, in all AWS regions)

  • 11.2.0.4.v1 (supported for EE, SE1, and SE, in all AWS regions)

PostgreSQL

  • Version 9.5 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 9.5.4

  • Version 9.5 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2): 9.5.2

  • Version 9.4 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 9.4.9

  • Version 9.4 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2): 9.4.7

  • Version 9.4 (available in all AWS regions): 9.4.5

  • Version 9.4 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 9.4.4

  • Version 9.4 (available in these AWS regions: ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-east-2, us-gov-west-1, us-west-1, us-west-2): 9.4.1

  • Version 9.3 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 9.3.10 | 9.3.3 | 9.3.5 | 9.3.6 | 9.3.9

  • Version 9.3 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-east-1, us-gov-west-1, us-west-1, us-west-2): 9.3.1 | 9.3.2

  • Version 9.3 (available in these AWS regions: ap-northeast-1, ap-southeast-1, ap-southeast-2, eu-central-1, eu-west-1, sa-east-1, us-east-1, us-west-1, us-west-2): 9.3.12 | 9.3.14

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.

Default: true

" }, "LicenseModel":{ "shape":"String", "documentation":"

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Constraints: Must be a multiple between 3 and 10 of the storage amount for the DB instance. Must also be an integer multiple of 1000. For example, if the size of your DB instance is 500 GB, then your Iops value can be 2000, 3000, 4000, or 5000.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, 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

" }, "CharacterSetName":{ "shape":"String", "documentation":"

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

" }, "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

  • Default VPC: true

  • VPC: false

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. 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.

" }, "Tags":{"shape":"TagList"}, "DBClusterIdentifier":{ "shape":"String", "documentation":"

The identifier of the DB cluster that the instance will belong to.

For information on creating a DB cluster, see CreateDBCluster.

Type: String

" }, "StorageType":{ "shape":"String", "documentation":"

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

" }, "TdeCredentialArn":{ "shape":"String", "documentation":"

The ARN from the Key Store with which to associate the instance for TDE encryption.

" }, "TdeCredentialPassword":{ "shape":"String", "documentation":"

The password for the given ARN from the Key Store in order to access the device.

" }, "StorageEncrypted":{ "shape":"BooleanOptional", "documentation":"

Specifies whether the DB instance is encrypted.

Default: false

" }, "KmsKeyId":{ "shape":"String", "documentation":"

The KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

" }, "Domain":{ "shape":"String", "documentation":"

Specify the Active Directory Domain to create the instance in.

" }, "CopyTagsToSnapshot":{ "shape":"BooleanOptional", "documentation":"

True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.

" }, "MonitoringInterval":{ "shape":"IntegerOptional", "documentation":"

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

" }, "MonitoringRoleArn":{ "shape":"String", "documentation":"

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

" }, "DomainIAMRoleName":{ "shape":"String", "documentation":"

Specify the name of the IAM role to be used when making API calls to the Directory Service.

" }, "PromotionTier":{ "shape":"IntegerOptional", "documentation":"

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.

Default: 1

Valid Values: 0 - 15

" }, "Timezone":{ "shape":"String", "documentation":"

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

" } }, "documentation":"

" }, "CreateDBInstanceReadReplicaMessage":{ "type":"structure", "required":[ "DBInstanceIdentifier", "SourceDBInstanceIdentifier" ], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

" }, "SourceDBInstanceIdentifier":{ "shape":"String", "documentation":"

The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.

Constraints:

  • Must be the identifier of an existing MySQL, MariaDB, or PostgreSQL DB instance.

  • Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.

  • Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later.

  • The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.

  • If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.

  • If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The compute and memory capacity of the Read Replica. Note that not all instance classes are available in all regions for all DB engines.

Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

Default: Inherits from the source DB instance.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Amazon EC2 Availability Zone that the Read Replica will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB instance

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.

" }, "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

  • Default VPC:true

  • VPC:false

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. 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.

" }, "Tags":{"shape":"TagList"}, "DBSubnetGroupName":{ "shape":"String", "documentation":"

Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.

Constraints:

  • Can only be specified if the source DB instance identifier specifies a DB instance in another region.

  • The specified DB subnet group must be in the same region in which the operation is running.

  • All Read Replicas in one region that are created from the same source DB instance must either:>

    • Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.

    • Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

" }, "StorageType":{ "shape":"String", "documentation":"

Specifies the storage type to be associated with the Read Replica.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

" }, "CopyTagsToSnapshot":{ "shape":"BooleanOptional", "documentation":"

True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.

" }, "MonitoringInterval":{ "shape":"IntegerOptional", "documentation":"

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

" }, "MonitoringRoleArn":{ "shape":"String", "documentation":"

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you create an unencrypted Read Replica and specify a value for the KmsKeyId parameter, Amazon RDS encrypts the target Read Replica using the specified KMS encryption key.

If you create an encrypted Read Replica from your AWS account, you can specify a value for KmsKeyId to encrypt the Read Replica with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the Read Replica is encrypted with the same KMS key as the source DB instance.

If you create an encrypted Read Replica in a different AWS region, then you must specify a KMS key for the destination AWS region. KMS encryption keys are specific to the region that they are created in, and you cannot use encryption keys from one region in another region.

" }, "PreSignedUrl":{ "shape":"String", "documentation":"

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the AWS region that contains the source DB instance. The PreSignedUrl parameter must be used when encrypting a Read Replica from another AWS region.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source region that contains the encrypted DB instance. The presigned URL request must contain the following parameter values:

  • DestinationRegion - The AWS Region that the Read Replica is created in. This region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

    For example, if you create an encrypted Read Replica in the us-east-1 region, and the source DB instance is in the west-2 region, then you call the CreateDBInstanceReadReplica action in the us-east-1 region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 region.

  • KmsKeyId - The KMS key identifier for the key to use to encrypt the Read Replica in the destination region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination region, and the action contained in the presigned URL.

  • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted Read Replica to be created. This identifier must be in the Amazon Resource Name (ARN) format for the source region. For example, if you create an encrypted Read Replica from a DB instance in the us-west-2 region, then your SourceDBInstanceIdentifier would look like this example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-instance-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

" } } }, "CreateDBInstanceReadReplicaResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "CreateDBInstanceResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "CreateDBParameterGroupMessage":{ "type":"structure", "required":[ "DBParameterGroupName", "DBParameterGroupFamily", "Description" ], "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB parameter group.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

" }, "DBParameterGroupFamily":{ "shape":"String", "documentation":"

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

" }, "Description":{ "shape":"String", "documentation":"

The description for the DB parameter group.

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CreateDBParameterGroupResult":{ "type":"structure", "members":{ "DBParameterGroup":{"shape":"DBParameterGroup"} } }, "CreateDBSecurityGroupMessage":{ "type":"structure", "required":[ "DBSecurityGroupName", "DBSecurityGroupDescription" ], "members":{ "DBSecurityGroupName":{ "shape":"String", "documentation":"

The name for the DB security group. This value is stored as a lowercase string.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

  • Must not be \"Default\"

Example: mysecuritygroup

" }, "DBSecurityGroupDescription":{ "shape":"String", "documentation":"

The description for the DB security group.

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CreateDBSecurityGroupResult":{ "type":"structure", "members":{ "DBSecurityGroup":{"shape":"DBSecurityGroup"} } }, "CreateDBSnapshotMessage":{ "type":"structure", "required":[ "DBSnapshotIdentifier", "DBInstanceIdentifier" ], "members":{ "DBSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier for the DB snapshot.

Constraints:

  • Cannot be null, empty, or blank

  • Must contain from 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

" }, "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier. This is the unique key that identifies a DB instance.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CreateDBSnapshotResult":{ "type":"structure", "members":{ "DBSnapshot":{"shape":"DBSnapshot"} } }, "CreateDBSubnetGroupMessage":{ "type":"structure", "required":[ "DBSubnetGroupName", "DBSubnetGroupDescription", "SubnetIds" ], "members":{ "DBSubnetGroupName":{ "shape":"String", "documentation":"

The name for the DB subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

" }, "DBSubnetGroupDescription":{ "shape":"String", "documentation":"

The description for the DB subnet group.

" }, "SubnetIds":{ "shape":"SubnetIdentifierList", "documentation":"

The EC2 Subnet IDs for the DB subnet group.

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CreateDBSubnetGroupResult":{ "type":"structure", "members":{ "DBSubnetGroup":{"shape":"DBSubnetGroup"} } }, "CreateEventSubscriptionMessage":{ "type":"structure", "required":[ "SubscriptionName", "SnsTopicArn" ], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the subscription.

Constraints: The name must be less than 255 characters.

" }, "SnsTopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" }, "SourceType":{ "shape":"String", "documentation":"

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, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

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 in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" }, "SourceIds":{ "shape":"SourceIdsList", "documentation":"

The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If SourceIds are supplied, SourceType must also be provided.

  • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

" }, "Enabled":{ "shape":"BooleanOptional", "documentation":"

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CreateEventSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "CreateOptionGroupMessage":{ "type":"structure", "required":[ "OptionGroupName", "EngineName", "MajorEngineVersion", "OptionGroupDescription" ], "members":{ "OptionGroupName":{ "shape":"String", "documentation":"

Specifies the name of the option group to be created.

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: myoptiongroup

" }, "EngineName":{ "shape":"String", "documentation":"

Specifies the name of the engine that this option group should be associated with.

" }, "MajorEngineVersion":{ "shape":"String", "documentation":"

Specifies the major version of the engine that this option group should be associated with.

" }, "OptionGroupDescription":{ "shape":"String", "documentation":"

The description of the option group.

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "CreateOptionGroupResult":{ "type":"structure", "members":{ "OptionGroup":{"shape":"OptionGroup"} } }, "DBCluster":{ "type":"structure", "members":{ "AllocatedStorage":{ "shape":"IntegerOptional", "documentation":"

Specifies the allocated storage size in gigabytes (GB).

" }, "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

Specifies the number of days for which automatic DB snapshots are retained.

" }, "CharacterSetName":{ "shape":"String", "documentation":"

If present, specifies the name of the character set that this cluster is associated with.

" }, "DatabaseName":{ "shape":"String", "documentation":"

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

" }, "DBClusterParameterGroup":{ "shape":"String", "documentation":"

Specifies the name of the DB cluster parameter group for the DB cluster.

" }, "DBSubnetGroup":{ "shape":"String", "documentation":"

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

" }, "Status":{ "shape":"String", "documentation":"

Specifies the current state of this DB cluster.

" }, "PercentProgress":{ "shape":"String", "documentation":"

Specifies the progress of the operation as a percentage.

" }, "EarliestRestorableTime":{ "shape":"TStamp", "documentation":"

Specifies the earliest time to which a database can be restored with point-in-time restore.

" }, "Endpoint":{ "shape":"String", "documentation":"

Specifies the connection endpoint for the primary instance of the DB cluster.

" }, "ReaderEndpoint":{ "shape":"String", "documentation":"

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection will be dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then recoonect to the reader endpoint.

" }, "MultiAZ":{ "shape":"Boolean", "documentation":"

Specifies whether the DB cluster has instances in multiple Availability Zones.

" }, "Engine":{ "shape":"String", "documentation":"

Provides the name of the database engine to be used for this DB cluster.

" }, "EngineVersion":{ "shape":"String", "documentation":"

Indicates the database engine version.

" }, "LatestRestorableTime":{ "shape":"TStamp", "documentation":"

Specifies the latest time to which a database can be restored with point-in-time restore.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

Specifies the port that the database engine is listening on.

" }, "MasterUsername":{ "shape":"String", "documentation":"

Contains the master username for the DB cluster.

" }, "DBClusterOptionGroupMemberships":{ "shape":"DBClusterOptionGroupMemberships", "documentation":"

Provides the list of option group memberships for this DB cluster.

" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" }, "ReplicationSourceIdentifier":{ "shape":"String", "documentation":"

Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.

" }, "ReadReplicaIdentifiers":{ "shape":"ReadReplicaIdentifierList", "documentation":"

Contains one or more identifiers of the Read Replicas associated with this DB cluster.

" }, "DBClusterMembers":{ "shape":"DBClusterMemberList", "documentation":"

Provides the list of instances that make up the DB cluster.

" }, "VpcSecurityGroups":{ "shape":"VpcSecurityGroupMembershipList", "documentation":"

Provides a list of VPC security groups that the DB cluster belongs to.

" }, "HostedZoneId":{ "shape":"String", "documentation":"

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" }, "StorageEncrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the DB cluster is encrypted.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.

" }, "DbClusterResourceId":{ "shape":"String", "documentation":"

The region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

" }, "DBClusterArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the DB cluster.

" }, "AssociatedRoles":{ "shape":"DBClusterRoles", "documentation":"

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

" }, "ClusterCreateTime":{ "shape":"TStamp", "documentation":"

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

" } }, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBClusters action.

", "wrapper":true }, "DBClusterAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

User already has a DB cluster with the given identifier.

", "error":{ "code":"DBClusterAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBClusterList":{ "type":"list", "member":{ "shape":"DBCluster", "locationName":"DBCluster" } }, "DBClusterMember":{ "type":"structure", "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

Specifies the instance identifier for this member of the DB cluster.

" }, "IsClusterWriter":{ "shape":"Boolean", "documentation":"

Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

" }, "DBClusterParameterGroupStatus":{ "shape":"String", "documentation":"

Specifies the status of the DB cluster parameter group for this member of the DB cluster.

" }, "PromotionTier":{ "shape":"IntegerOptional", "documentation":"

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.

" } }, "documentation":"

Contains information about an instance that is part of a DB cluster.

", "wrapper":true }, "DBClusterMemberList":{ "type":"list", "member":{ "shape":"DBClusterMember", "locationName":"DBClusterMember" } }, "DBClusterMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

A pagination token that can be used in a subsequent DescribeDBClusters request.

" }, "DBClusters":{ "shape":"DBClusterList", "documentation":"

Contains a list of DB clusters for the user.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeDBClusters action.

" }, "DBClusterNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

DBClusterIdentifier does not refer to an existing DB cluster.

", "error":{ "code":"DBClusterNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBClusterOptionGroupMemberships":{ "type":"list", "member":{ "shape":"DBClusterOptionGroupStatus", "locationName":"DBClusterOptionGroup" } }, "DBClusterOptionGroupStatus":{ "type":"structure", "members":{ "DBClusterOptionGroupName":{ "shape":"String", "documentation":"

Specifies the name of the DB cluster option group.

" }, "Status":{ "shape":"String", "documentation":"

Specifies the status of the DB cluster option group.

" } }, "documentation":"

Contains status information for a DB cluster option group.

" }, "DBClusterParameterGroup":{ "type":"structure", "members":{ "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

Provides the name of the DB cluster parameter group.

" }, "DBParameterGroupFamily":{ "shape":"String", "documentation":"

Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.

" }, "Description":{ "shape":"String", "documentation":"

Provides the customer-specified description for this DB cluster parameter group.

" }, "DBClusterParameterGroupArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the DB cluster parameter group.

" } }, "documentation":"

Contains the result of a successful invocation of the CreateDBClusterParameterGroup or CopyDBClusterParameterGroup action.

This data type is used as a request parameter in the DeleteDBClusterParameterGroup action, and as a response element in the DescribeDBClusterParameterGroups action.

", "wrapper":true }, "DBClusterParameterGroupDetails":{ "type":"structure", "members":{ "Parameters":{ "shape":"ParametersList", "documentation":"

Provides a list of parameters for the DB cluster parameter group.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" } }, "documentation":"

Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

" }, "DBClusterParameterGroupList":{ "type":"list", "member":{ "shape":"DBClusterParameterGroup", "locationName":"DBClusterParameterGroup" } }, "DBClusterParameterGroupNameMessage":{ "type":"structure", "members":{ "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB cluster parameter group.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

" } }, "documentation":"

" }, "DBClusterParameterGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.

", "error":{ "code":"DBClusterParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBClusterParameterGroupsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "DBClusterParameterGroups":{ "shape":"DBClusterParameterGroupList", "documentation":"

A list of DB cluster parameter groups.

" } }, "documentation":"

" }, "DBClusterQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

", "error":{ "code":"DBClusterQuotaExceededFault", "httpStatusCode":403, "senderFault":true }, "exception":true }, "DBClusterRole":{ "type":"structure", "members":{ "RoleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

" }, "Status":{ "shape":"String", "documentation":"

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

  • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.

  • PENDING - the IAM role ARN is being associated with the DB cluster.

  • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.

" } }, "documentation":"

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.

" }, "DBClusterRoleAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

", "error":{ "code":"DBClusterRoleAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBClusterRoleNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The specified IAM role Amazon Resource Name (ARN) is not associated with the specified DB cluster.

", "error":{ "code":"DBClusterRoleNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBClusterRoleQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

", "error":{ "code":"DBClusterRoleQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBClusterRoles":{ "type":"list", "member":{ "shape":"DBClusterRole", "locationName":"DBClusterRole" } }, "DBClusterSnapshot":{ "type":"structure", "members":{ "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

" }, "DBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

Specifies the identifier for the DB cluster snapshot.

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

" }, "SnapshotCreateTime":{ "shape":"TStamp", "documentation":"

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

" }, "Engine":{ "shape":"String", "documentation":"

Specifies the name of the database engine.

" }, "AllocatedStorage":{ "shape":"Integer", "documentation":"

Specifies the allocated storage size in gigabytes (GB).

" }, "Status":{ "shape":"String", "documentation":"

Specifies the status of this DB cluster snapshot.

" }, "Port":{ "shape":"Integer", "documentation":"

Specifies the port that the DB cluster was listening on at the time of the snapshot.

" }, "VpcId":{ "shape":"String", "documentation":"

Provides the VPC ID associated with the DB cluster snapshot.

" }, "ClusterCreateTime":{ "shape":"TStamp", "documentation":"

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

" }, "MasterUsername":{ "shape":"String", "documentation":"

Provides the master username for the DB cluster snapshot.

" }, "EngineVersion":{ "shape":"String", "documentation":"

Provides the version of the database engine for this DB cluster snapshot.

" }, "LicenseModel":{ "shape":"String", "documentation":"

Provides the license model information for this DB cluster snapshot.

" }, "SnapshotType":{ "shape":"String", "documentation":"

Provides the type of the DB cluster snapshot.

" }, "PercentProgress":{ "shape":"Integer", "documentation":"

Specifies the percentage of the estimated data that has been transferred.

" }, "StorageEncrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the DB cluster snapshot is encrypted.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster snapshot.

" }, "DBClusterSnapshotArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the DB cluster snapshot.

" } }, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBClusterSnapshots action.

", "wrapper":true }, "DBClusterSnapshotAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

User already has a DB cluster snapshot with the given identifier.

", "error":{ "code":"DBClusterSnapshotAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBClusterSnapshotAttribute":{ "type":"structure", "members":{ "AttributeName":{ "shape":"String", "documentation":"

The name of the manual DB cluster snapshot attribute.

The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

" }, "AttributeValues":{ "shape":"AttributeValueList", "documentation":"

The value(s) for the manual DB cluster snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any AWS account to copy or restore.

" } }, "documentation":"

Contains the name and values of a manual DB cluster snapshot attribute.

Manual DB cluster snapshot attributes are used to authorize other AWS accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

" }, "DBClusterSnapshotAttributeList":{ "type":"list", "member":{ "shape":"DBClusterSnapshotAttribute", "locationName":"DBClusterSnapshotAttribute" } }, "DBClusterSnapshotAttributesResult":{ "type":"structure", "members":{ "DBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier of the manual DB cluster snapshot that the attributes apply to.

" }, "DBClusterSnapshotAttributes":{ "shape":"DBClusterSnapshotAttributeList", "documentation":"

The list of attributes and values for the manual DB cluster snapshot.

" } }, "documentation":"

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

Manual DB cluster snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

", "wrapper":true }, "DBClusterSnapshotList":{ "type":"list", "member":{ "shape":"DBClusterSnapshot", "locationName":"DBClusterSnapshot" } }, "DBClusterSnapshotMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "DBClusterSnapshots":{ "shape":"DBClusterSnapshotList", "documentation":"

Provides a list of DB cluster snapshots for the user.

" } }, "documentation":"

Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

" }, "DBClusterSnapshotNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.

", "error":{ "code":"DBClusterSnapshotNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBEngineVersion":{ "type":"structure", "members":{ "Engine":{ "shape":"String", "documentation":"

The name of the database engine.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the database engine.

" }, "DBParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the DB parameter group family for the database engine.

" }, "DBEngineDescription":{ "shape":"String", "documentation":"

The description of the database engine.

" }, "DBEngineVersionDescription":{ "shape":"String", "documentation":"

The description of the database engine version.

" }, "DefaultCharacterSet":{ "shape":"CharacterSet", "documentation":"

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.

" }, "SupportedCharacterSets":{ "shape":"SupportedCharacterSetsList", "documentation":"

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance action.

" }, "ValidUpgradeTarget":{ "shape":"ValidUpgradeTargetList", "documentation":"

A list of engine versions that this database engine version can be upgraded to.

" }, "SupportedTimezones":{ "shape":"SupportedTimezonesList", "documentation":"

A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

" } }, "documentation":"

This data type is used as a response element in the action DescribeDBEngineVersions.

" }, "DBEngineVersionList":{ "type":"list", "member":{ "shape":"DBEngineVersion", "locationName":"DBEngineVersion" } }, "DBEngineVersionMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "DBEngineVersions":{ "shape":"DBEngineVersionList", "documentation":"

A list of DBEngineVersion elements.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeDBEngineVersions action.

" }, "DBInstance":{ "type":"structure", "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

Contains the name of the compute and memory capacity class of the DB instance.

" }, "Engine":{ "shape":"String", "documentation":"

Provides the name of the database engine to be used for this DB instance.

" }, "DBInstanceStatus":{ "shape":"String", "documentation":"

Specifies the current state of this database.

" }, "MasterUsername":{ "shape":"String", "documentation":"

Contains the master username for the DB instance.

" }, "DBName":{ "shape":"String", "documentation":"

The meaning of this parameter differs according to the database engine you use. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.

MySQL, MariaDB, SQL Server, PostgreSQL, Amazon Aurora

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

" }, "Endpoint":{ "shape":"Endpoint", "documentation":"

Specifies the connection endpoint.

" }, "AllocatedStorage":{ "shape":"Integer", "documentation":"

Specifies the allocated storage size specified in gigabytes.

" }, "InstanceCreateTime":{ "shape":"TStamp", "documentation":"

Provides the date and time the DB instance was created.

" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

" }, "BackupRetentionPeriod":{ "shape":"Integer", "documentation":"

Specifies the number of days for which automatic DB snapshots are retained.

" }, "DBSecurityGroups":{ "shape":"DBSecurityGroupMembershipList", "documentation":"

Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

" }, "VpcSecurityGroups":{ "shape":"VpcSecurityGroupMembershipList", "documentation":"

Provides a list of VPC security group elements that the DB instance belongs to.

" }, "DBParameterGroups":{ "shape":"DBParameterGroupStatusList", "documentation":"

Provides the list of DB parameter groups applied to this DB instance.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

Specifies the name of the Availability Zone the DB instance is located in.

" }, "DBSubnetGroup":{ "shape":"DBSubnetGroup", "documentation":"

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" }, "PendingModifiedValues":{ "shape":"PendingModifiedValues", "documentation":"

Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

" }, "LatestRestorableTime":{ "shape":"TStamp", "documentation":"

Specifies the latest time to which a database can be restored with point-in-time restore.

" }, "MultiAZ":{ "shape":"Boolean", "documentation":"

Specifies if the DB instance is a Multi-AZ deployment.

" }, "EngineVersion":{ "shape":"String", "documentation":"

Indicates the database engine version.

" }, "AutoMinorVersionUpgrade":{ "shape":"Boolean", "documentation":"

Indicates that minor version patches are applied automatically.

" }, "ReadReplicaSourceDBInstanceIdentifier":{ "shape":"String", "documentation":"

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

" }, "ReadReplicaDBInstanceIdentifiers":{ "shape":"ReadReplicaDBInstanceIdentifierList", "documentation":"

Contains one or more identifiers of the Read Replicas associated with this DB instance.

" }, "ReadReplicaDBClusterIdentifiers":{ "shape":"ReadReplicaDBClusterIdentifierList", "documentation":"

Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.

" }, "LicenseModel":{ "shape":"String", "documentation":"

License model information for this DB instance.

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

Specifies the Provisioned IOPS (I/O operations per second) value.

" }, "OptionGroupMemberships":{ "shape":"OptionGroupMembershipList", "documentation":"

Provides the list of option group memberships for this DB instance.

" }, "CharacterSetName":{ "shape":"String", "documentation":"

If present, specifies the name of the character set that this instance is associated with.

" }, "SecondaryAvailabilityZone":{ "shape":"String", "documentation":"

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

" }, "PubliclyAccessible":{ "shape":"Boolean", "documentation":"

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

  • Default VPC:true

  • VPC:false

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. 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.

" }, "StatusInfos":{ "shape":"DBInstanceStatusInfoList", "documentation":"

The status of a Read Replica. If the instance is not a Read Replica, this will be blank.

" }, "StorageType":{ "shape":"String", "documentation":"

Specifies the storage type associated with DB instance.

" }, "TdeCredentialArn":{ "shape":"String", "documentation":"

The ARN from the key store with which the instance is associated for TDE encryption.

" }, "DbInstancePort":{ "shape":"Integer", "documentation":"

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

" }, "StorageEncrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the DB instance is encrypted.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.

" }, "DbiResourceId":{ "shape":"String", "documentation":"

The region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB instance is accessed.

" }, "CACertificateIdentifier":{ "shape":"String", "documentation":"

The identifier of the CA certificate for this DB instance.

" }, "DomainMemberships":{ "shape":"DomainMembershipList", "documentation":"

The Active Directory Domain membership records associated with the DB instance.

" }, "CopyTagsToSnapshot":{ "shape":"Boolean", "documentation":"

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

" }, "MonitoringInterval":{ "shape":"IntegerOptional", "documentation":"

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

" }, "EnhancedMonitoringResourceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

" }, "MonitoringRoleArn":{ "shape":"String", "documentation":"

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.

" }, "PromotionTier":{ "shape":"IntegerOptional", "documentation":"

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.

" }, "DBInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the DB instance.

" }, "Timezone":{ "shape":"String", "documentation":"

The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

" } }, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBInstances action.

", "wrapper":true }, "DBInstanceAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

User already has a DB instance with the given identifier.

", "error":{ "code":"DBInstanceAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBInstanceList":{ "type":"list", "member":{ "shape":"DBInstance", "locationName":"DBInstance" } }, "DBInstanceMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" }, "DBInstances":{ "shape":"DBInstanceList", "documentation":"

A list of DBInstance instances.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeDBInstances action.

" }, "DBInstanceNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

", "error":{ "code":"DBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBInstanceStatusInfo":{ "type":"structure", "members":{ "StatusType":{ "shape":"String", "documentation":"

This value is currently \"read replication.\"

" }, "Normal":{ "shape":"Boolean", "documentation":"

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

" }, "Status":{ "shape":"String", "documentation":"

Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

" }, "Message":{ "shape":"String", "documentation":"

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.

" } }, "documentation":"

Provides a list of status information for a DB instance.

" }, "DBInstanceStatusInfoList":{ "type":"list", "member":{ "shape":"DBInstanceStatusInfo", "locationName":"DBInstanceStatusInfo" } }, "DBLogFileNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

LogFileName does not refer to an existing DB log file.

", "error":{ "code":"DBLogFileNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBParameterGroup":{ "type":"structure", "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

Provides the name of the DB parameter group.

" }, "DBParameterGroupFamily":{ "shape":"String", "documentation":"

Provides the name of the DB parameter group family that this DB parameter group is compatible with.

" }, "Description":{ "shape":"String", "documentation":"

Provides the customer-specified description for this DB parameter group.

" }, "DBParameterGroupArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the DB parameter group.

" } }, "documentation":"

Contains the result of a successful invocation of the CreateDBParameterGroup action.

This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

", "wrapper":true }, "DBParameterGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

A DB parameter group with the same name exists.

", "error":{ "code":"DBParameterGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBParameterGroupDetails":{ "type":"structure", "members":{ "Parameters":{ "shape":"ParametersList", "documentation":"

A list of Parameter values.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeDBParameters action.

" }, "DBParameterGroupList":{ "type":"list", "member":{ "shape":"DBParameterGroup", "locationName":"DBParameterGroup" } }, "DBParameterGroupNameMessage":{ "type":"structure", "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

Provides the name of the DB parameter group.

" } }, "documentation":"

Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

" }, "DBParameterGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

", "error":{ "code":"DBParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBParameterGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

Request would result in user exceeding the allowed number of DB parameter groups.

", "error":{ "code":"DBParameterGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBParameterGroupStatus":{ "type":"structure", "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DP parameter group.

" }, "ParameterApplyStatus":{ "shape":"String", "documentation":"

The status of parameter updates.

" } }, "documentation":"

The status of the DB parameter group.

This data type is used as a response element in the following actions:

" }, "DBParameterGroupStatusList":{ "type":"list", "member":{ "shape":"DBParameterGroupStatus", "locationName":"DBParameterGroup" } }, "DBParameterGroupsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "DBParameterGroups":{ "shape":"DBParameterGroupList", "documentation":"

A list of DBParameterGroup instances.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeDBParameterGroups action.

" }, "DBSecurityGroup":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

Provides the AWS ID of the owner of a specific DB security group.

" }, "DBSecurityGroupName":{ "shape":"String", "documentation":"

Specifies the name of the DB security group.

" }, "DBSecurityGroupDescription":{ "shape":"String", "documentation":"

Provides the description of the DB security group.

" }, "VpcId":{ "shape":"String", "documentation":"

Provides the VpcId of the DB security group.

" }, "EC2SecurityGroups":{ "shape":"EC2SecurityGroupList", "documentation":"

Contains a list of EC2SecurityGroup elements.

" }, "IPRanges":{ "shape":"IPRangeList", "documentation":"

Contains a list of IPRange elements.

" }, "DBSecurityGroupArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the DB security group.

" } }, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSecurityGroups action.

", "wrapper":true }, "DBSecurityGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

A DB security group with the name specified in DBSecurityGroupName already exists.

", "error":{ "code":"DBSecurityGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBSecurityGroupMembership":{ "type":"structure", "members":{ "DBSecurityGroupName":{ "shape":"String", "documentation":"

The name of the DB security group.

" }, "Status":{ "shape":"String", "documentation":"

The status of the DB security group.

" } }, "documentation":"

This data type is used as a response element in the following actions:

" }, "DBSecurityGroupMembershipList":{ "type":"list", "member":{ "shape":"DBSecurityGroupMembership", "locationName":"DBSecurityGroup" } }, "DBSecurityGroupMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "DBSecurityGroups":{ "shape":"DBSecurityGroups", "documentation":"

A list of DBSecurityGroup instances.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

" }, "DBSecurityGroupNameList":{ "type":"list", "member":{ "shape":"String", "locationName":"DBSecurityGroupName" } }, "DBSecurityGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

", "error":{ "code":"DBSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBSecurityGroupNotSupportedFault":{ "type":"structure", "members":{ }, "documentation":"

A DB security group is not allowed for this action.

", "error":{ "code":"DBSecurityGroupNotSupported", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBSecurityGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

Request would result in user exceeding the allowed number of DB security groups.

", "error":{ "code":"QuotaExceeded.DBSecurityGroup", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBSecurityGroups":{ "type":"list", "member":{ "shape":"DBSecurityGroup", "locationName":"DBSecurityGroup" } }, "DBSnapshot":{ "type":"structure", "members":{ "DBSnapshotIdentifier":{ "shape":"String", "documentation":"

Specifies the identifier for the DB snapshot.

" }, "DBInstanceIdentifier":{ "shape":"String", "documentation":"

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

" }, "SnapshotCreateTime":{ "shape":"TStamp", "documentation":"

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

" }, "Engine":{ "shape":"String", "documentation":"

Specifies the name of the database engine.

" }, "AllocatedStorage":{ "shape":"Integer", "documentation":"

Specifies the allocated storage size in gigabytes (GB).

" }, "Status":{ "shape":"String", "documentation":"

Specifies the status of this DB snapshot.

" }, "Port":{ "shape":"Integer", "documentation":"

Specifies the port that the database engine was listening on at the time of the snapshot.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

" }, "VpcId":{ "shape":"String", "documentation":"

Provides the VPC ID associated with the DB snapshot.

" }, "InstanceCreateTime":{ "shape":"TStamp", "documentation":"

Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).

" }, "MasterUsername":{ "shape":"String", "documentation":"

Provides the master username for the DB snapshot.

" }, "EngineVersion":{ "shape":"String", "documentation":"

Specifies the version of the database engine.

" }, "LicenseModel":{ "shape":"String", "documentation":"

License model information for the restored DB instance.

" }, "SnapshotType":{ "shape":"String", "documentation":"

Provides the type of the DB snapshot.

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

Provides the option group name for the DB snapshot.

" }, "PercentProgress":{ "shape":"Integer", "documentation":"

The percentage of the estimated data that has been transferred.

" }, "SourceRegion":{ "shape":"String", "documentation":"

The region that the DB snapshot was created in or copied from.

" }, "SourceDBSnapshotIdentifier":{ "shape":"String", "documentation":"

The DB snapshot Arn that the DB snapshot was copied from. It only has value in case of cross customer or cross region copy.

" }, "StorageType":{ "shape":"String", "documentation":"

Specifies the storage type associated with DB snapshot.

" }, "TdeCredentialArn":{ "shape":"String", "documentation":"

The ARN from the key store with which to associate the instance for TDE encryption.

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the DB snapshot is encrypted.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.

" }, "DBSnapshotArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the DB snapshot.

" }, "Timezone":{ "shape":"String", "documentation":"

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

" } }, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSnapshots action.

", "wrapper":true }, "DBSnapshotAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

", "error":{ "code":"DBSnapshotAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBSnapshotAttribute":{ "type":"structure", "members":{ "AttributeName":{ "shape":"String", "documentation":"

The name of the manual DB snapshot attribute.

The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

" }, "AttributeValues":{ "shape":"AttributeValueList", "documentation":"

The value or values for the manual DB snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any AWS account to copy or restore.

" } }, "documentation":"

Contains the name and values of a manual DB snapshot attribute

Manual DB snapshot attributes are used to authorize other AWS accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.

", "wrapper":true }, "DBSnapshotAttributeList":{ "type":"list", "member":{ "shape":"DBSnapshotAttribute", "locationName":"DBSnapshotAttribute" } }, "DBSnapshotAttributesResult":{ "type":"structure", "members":{ "DBSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier of the manual DB snapshot that the attributes apply to.

" }, "DBSnapshotAttributes":{ "shape":"DBSnapshotAttributeList", "documentation":"

The list of attributes and values for the manual DB snapshot.

" } }, "documentation":"

Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.

Manual DB snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

", "wrapper":true }, "DBSnapshotList":{ "type":"list", "member":{ "shape":"DBSnapshot", "locationName":"DBSnapshot" } }, "DBSnapshotMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "DBSnapshots":{ "shape":"DBSnapshotList", "documentation":"

A list of DBSnapshot instances.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeDBSnapshots action.

" }, "DBSnapshotNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

", "error":{ "code":"DBSnapshotNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBSubnetGroup":{ "type":"structure", "members":{ "DBSubnetGroupName":{ "shape":"String", "documentation":"

The name of the DB subnet group.

" }, "DBSubnetGroupDescription":{ "shape":"String", "documentation":"

Provides the description of the DB subnet group.

" }, "VpcId":{ "shape":"String", "documentation":"

Provides the VpcId of the DB subnet group.

" }, "SubnetGroupStatus":{ "shape":"String", "documentation":"

Provides the status of the DB subnet group.

" }, "Subnets":{ "shape":"SubnetList", "documentation":"

Contains a list of Subnet elements.

" }, "DBSubnetGroupArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the DB subnet group.

" } }, "documentation":"

Contains the result of a successful invocation of the following actions:

This data type is used as a response element in the DescribeDBSubnetGroups action.

", "wrapper":true }, "DBSubnetGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

DBSubnetGroupName is already used by an existing DB subnet group.

", "error":{ "code":"DBSubnetGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBSubnetGroupDoesNotCoverEnoughAZs":{ "type":"structure", "members":{ }, "documentation":"

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

", "error":{ "code":"DBSubnetGroupDoesNotCoverEnoughAZs", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBSubnetGroupMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "DBSubnetGroups":{ "shape":"DBSubnetGroups", "documentation":"

A list of DBSubnetGroup instances.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

" }, "DBSubnetGroupNotAllowedFault":{ "type":"structure", "members":{ }, "documentation":"

Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.

", "error":{ "code":"DBSubnetGroupNotAllowedFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBSubnetGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

", "error":{ "code":"DBSubnetGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DBSubnetGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

Request would result in user exceeding the allowed number of DB subnet groups.

", "error":{ "code":"DBSubnetGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBSubnetGroups":{ "type":"list", "member":{ "shape":"DBSubnetGroup", "locationName":"DBSubnetGroup" } }, "DBSubnetQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

", "error":{ "code":"DBSubnetQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DBUpgradeDependencyFailureFault":{ "type":"structure", "members":{ }, "documentation":"

The DB upgrade failed because a resource the DB depends on could not be modified.

", "error":{ "code":"DBUpgradeDependencyFailure", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DeleteDBClusterMessage":{ "type":"structure", "required":["DBClusterIdentifier"], "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "SkipFinalSnapshot":{ "shape":"Boolean", "documentation":"

Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted.

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false.

Default: false

" }, "FinalDBSnapshotIdentifier":{ "shape":"String", "documentation":"

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" } }, "documentation":"

" }, "DeleteDBClusterParameterGroupMessage":{ "type":"structure", "required":["DBClusterParameterGroupName"], "members":{ "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB cluster parameter group.

Constraints:

  • Must be the name of an existing DB cluster parameter group.

  • You cannot delete a default DB cluster parameter group.

  • Cannot be associated with any DB clusters.

" } }, "documentation":"

" }, "DeleteDBClusterResult":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "DeleteDBClusterSnapshotMessage":{ "type":"structure", "required":["DBClusterSnapshotIdentifier"], "members":{ "DBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier of the DB cluster snapshot to delete.

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

" } }, "documentation":"

" }, "DeleteDBClusterSnapshotResult":{ "type":"structure", "members":{ "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} } }, "DeleteDBInstanceMessage":{ "type":"structure", "required":["DBInstanceIdentifier"], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "SkipFinalSnapshot":{ "shape":"Boolean", "documentation":"

Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to \"true\".

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

" }, "FinalDBSnapshotIdentifier":{ "shape":"String", "documentation":"

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

  • Cannot be specified when deleting a Read Replica.

" } }, "documentation":"

" }, "DeleteDBInstanceResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "DeleteDBParameterGroupMessage":{ "type":"structure", "required":["DBParameterGroupName"], "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB parameter group.

Constraints:

  • Must be the name of an existing DB parameter group

  • You cannot delete a default DB parameter group

  • Cannot be associated with any DB instances

" } }, "documentation":"

" }, "DeleteDBSecurityGroupMessage":{ "type":"structure", "required":["DBSecurityGroupName"], "members":{ "DBSecurityGroupName":{ "shape":"String", "documentation":"

The name of the DB security group to delete.

You cannot delete the default DB security group.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

  • Must not be \"Default\"

" } }, "documentation":"

" }, "DeleteDBSnapshotMessage":{ "type":"structure", "required":["DBSnapshotIdentifier"], "members":{ "DBSnapshotIdentifier":{ "shape":"String", "documentation":"

The DBSnapshot identifier.

Constraints: Must be the name of an existing DB snapshot in the available state.

" } }, "documentation":"

" }, "DeleteDBSnapshotResult":{ "type":"structure", "members":{ "DBSnapshot":{"shape":"DBSnapshot"} } }, "DeleteDBSubnetGroupMessage":{ "type":"structure", "required":["DBSubnetGroupName"], "members":{ "DBSubnetGroupName":{ "shape":"String", "documentation":"

The name of the database subnet group to delete.

You cannot delete the default subnet group.

Constraints:

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

" } }, "documentation":"

" }, "DeleteEventSubscriptionMessage":{ "type":"structure", "required":["SubscriptionName"], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the RDS event notification subscription you want to delete.

" } }, "documentation":"

" }, "DeleteEventSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "DeleteOptionGroupMessage":{ "type":"structure", "required":["OptionGroupName"], "members":{ "OptionGroupName":{ "shape":"String", "documentation":"

The name of the option group to be deleted.

You cannot delete default option groups.

" } }, "documentation":"

" }, "DescribeAccountAttributesMessage":{ "type":"structure", "members":{ }, "documentation":"

" }, "DescribeCertificatesMessage":{ "type":"structure", "members":{ "CertificateIdentifier":{ "shape":"String", "documentation":"

The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeDBClusterParameterGroupsMessage":{ "type":"structure", "members":{ "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

The name of a specific DB cluster parameter group to return details for.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeDBClusterParametersMessage":{ "type":"structure", "required":["DBClusterParameterGroupName"], "members":{ "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

The name of a specific DB cluster parameter group to return parameter details for.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "Source":{ "shape":"String", "documentation":"

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeDBClusterSnapshotAttributesMessage":{ "type":"structure", "required":["DBClusterSnapshotIdentifier"], "members":{ "DBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier for the DB cluster snapshot to describe the attributes for.

" } }, "documentation":"

" }, "DescribeDBClusterSnapshotAttributesResult":{ "type":"structure", "members":{ "DBClusterSnapshotAttributesResult":{"shape":"DBClusterSnapshotAttributesResult"} } }, "DescribeDBClusterSnapshotsMessage":{ "type":"structure", "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "DBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

" }, "SnapshotType":{ "shape":"String", "documentation":"

The type of DB cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.

  • manual - Return all DB cluster snapshots that have been taken by my AWS account.

  • shared - Return all manual DB cluster snapshots that have been shared to my AWS account.

  • public - Return all DB cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "IncludeShared":{ "shape":"Boolean", "documentation":"

Set this value to true to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false. The default is false.

You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.

" }, "IncludePublic":{ "shape":"Boolean", "documentation":"

Set this value to true to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false. The default is false. The default is false.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

" } }, "documentation":"

" }, "DescribeDBClustersMessage":{ "type":"structure", "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "Filters":{ "shape":"FilterList", "documentation":"

A filter that specifies one or more DB clusters to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeDBEngineVersionsMessage":{ "type":"structure", "members":{ "Engine":{ "shape":"String", "documentation":"

The database engine to return.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The database engine version to return.

Example: 5.1.49

" }, "DBParameterGroupFamily":{ "shape":"String", "documentation":"

The name of a specific DB parameter group family to return details for.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "Filters":{ "shape":"FilterList", "documentation":"

Not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "DefaultOnly":{ "shape":"Boolean", "documentation":"

Indicates that only the default version of the specified engine or engine and major version combination is returned.

" }, "ListSupportedCharacterSets":{ "shape":"BooleanOptional", "documentation":"

If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

" }, "ListSupportedTimezones":{ "shape":"BooleanOptional", "documentation":"

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

" } } }, "DescribeDBInstancesMessage":{ "type":"structure", "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "Filters":{ "shape":"FilterList", "documentation":"

A filter that specifies one or more DB instances to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB Clusters identified by these ARNs.

  • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeDBLogFilesDetails":{ "type":"structure", "members":{ "LogFileName":{ "shape":"String", "documentation":"

The name of the log file for the specified DB instance.

" }, "LastWritten":{ "shape":"Long", "documentation":"

A POSIX timestamp when the last log entry was written.

" }, "Size":{ "shape":"Long", "documentation":"

The size, in bytes, of the log file for the specified DB instance.

" } }, "documentation":"

This data type is used as a response element to DescribeDBLogFiles.

" }, "DescribeDBLogFilesList":{ "type":"list", "member":{ "shape":"DescribeDBLogFilesDetails", "locationName":"DescribeDBLogFilesDetails" } }, "DescribeDBLogFilesMessage":{ "type":"structure", "required":["DBInstanceIdentifier"], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "FilenameContains":{ "shape":"String", "documentation":"

Filters the available log files for log file names that contain the specified string.

" }, "FileLastWritten":{ "shape":"Long", "documentation":"

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

" }, "FileSize":{ "shape":"Long", "documentation":"

Filters the available log files for files larger than the specified size.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

" }, "Marker":{ "shape":"String", "documentation":"

The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

" } }, "documentation":"

" }, "DescribeDBLogFilesResponse":{ "type":"structure", "members":{ "DescribeDBLogFiles":{ "shape":"DescribeDBLogFilesList", "documentation":"

The DB log files returned.

" }, "Marker":{ "shape":"String", "documentation":"

A pagination token that can be used in a subsequent DescribeDBLogFiles request.

" } }, "documentation":"

The response from a call to DescribeDBLogFiles.

" }, "DescribeDBParameterGroupsMessage":{ "type":"structure", "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of a specific DB parameter group to return details for.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeDBParametersMessage":{ "type":"structure", "required":["DBParameterGroupName"], "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of a specific DB parameter group to return details for.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "Source":{ "shape":"String", "documentation":"

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } } }, "DescribeDBSecurityGroupsMessage":{ "type":"structure", "members":{ "DBSecurityGroupName":{ "shape":"String", "documentation":"

The name of the DB security group to return details for.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeDBSnapshotAttributesMessage":{ "type":"structure", "required":["DBSnapshotIdentifier"], "members":{ "DBSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier for the DB snapshot to describe the attributes for.

" } }, "documentation":"

" }, "DescribeDBSnapshotAttributesResult":{ "type":"structure", "members":{ "DBSnapshotAttributesResult":{"shape":"DBSnapshotAttributesResult"} } }, "DescribeDBSnapshotsMessage":{ "type":"structure", "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "DBSnapshotIdentifier":{ "shape":"String", "documentation":"

A specific DB snapshot identifier to describe. This parameter cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

  • Must be 1 to 255 alphanumeric characters.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

" }, "SnapshotType":{ "shape":"String", "documentation":"

The type of snapshots to be returned. You can specify one of the following values:

  • automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.

  • manual - Return all DB snapshots that have been taken by my AWS account.

  • shared - Return all manual DB snapshots that have been shared to my AWS account.

  • public - Return all DB snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by setting the IncludeShared parameter to true. You can include public snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "IncludeShared":{ "shape":"Boolean", "documentation":"

Set this value to true to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false. The default is false.

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

" }, "IncludePublic":{ "shape":"Boolean", "documentation":"

Set this value to true to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to false. The default is false.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

" } }, "documentation":"

" }, "DescribeDBSubnetGroupsMessage":{ "type":"structure", "members":{ "DBSubnetGroupName":{ "shape":"String", "documentation":"

The name of the DB subnet group to return details for.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeEngineDefaultClusterParametersMessage":{ "type":"structure", "required":["DBParameterGroupFamily"], "members":{ "DBParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the DB cluster parameter group family to return engine parameter information for.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeEngineDefaultClusterParametersResult":{ "type":"structure", "members":{ "EngineDefaults":{"shape":"EngineDefaults"} } }, "DescribeEngineDefaultParametersMessage":{ "type":"structure", "required":["DBParameterGroupFamily"], "members":{ "DBParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the DB parameter group family.

" }, "Filters":{ "shape":"FilterList", "documentation":"

Not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeEngineDefaultParametersResult":{ "type":"structure", "members":{ "EngineDefaults":{"shape":"EngineDefaults"} } }, "DescribeEventCategoriesMessage":{ "type":"structure", "members":{ "SourceType":{ "shape":"String", "documentation":"

The type of source that will be generating the events.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" } }, "documentation":"

" }, "DescribeEventSubscriptionsMessage":{ "type":"structure", "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the RDS event notification subscription you want to describe.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" } }, "documentation":"

" }, "DescribeEventsMessage":{ "type":"structure", "members":{ "SourceIdentifier":{ "shape":"String", "documentation":"

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is supplied, SourceType must also be provided.

  • If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" }, "SourceType":{ "shape":"SourceType", "documentation":"

The event source to retrieve events for. If no value is specified, all events are returned.

" }, "StartTime":{ "shape":"TStamp", "documentation":"

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

" }, "EndTime":{ "shape":"TStamp", "documentation":"

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

" }, "Duration":{ "shape":"IntegerOptional", "documentation":"

The number of minutes to retrieve events for.

Default: 60

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

A list of event categories that trigger notifications for a event notification subscription.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeOptionGroupOptionsMessage":{ "type":"structure", "required":["EngineName"], "members":{ "EngineName":{ "shape":"String", "documentation":"

A required parameter. Options available for the given engine name will be described.

" }, "MajorEngineVersion":{ "shape":"String", "documentation":"

If specified, filters the results to include only options for the specified major engine version.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeOptionGroupsMessage":{ "type":"structure", "members":{ "OptionGroupName":{ "shape":"String", "documentation":"

The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "EngineName":{ "shape":"String", "documentation":"

Filters the list of option groups to only include groups associated with a specific database engine.

" }, "MajorEngineVersion":{ "shape":"String", "documentation":"

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.

" } }, "documentation":"

" }, "DescribeOrderableDBInstanceOptionsMessage":{ "type":"structure", "required":["Engine"], "members":{ "Engine":{ "shape":"String", "documentation":"

The name of the engine to retrieve DB instance options for.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" }, "LicenseModel":{ "shape":"String", "documentation":"

The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

" }, "Vpc":{ "shape":"BooleanOptional", "documentation":"

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" } }, "documentation":"

" }, "DescribePendingMaintenanceActionsMessage":{ "type":"structure", "members":{ "ResourceIdentifier":{ "shape":"String", "documentation":"

The ARN of a resource to return pending maintenance actions for.

" }, "Filters":{ "shape":"FilterList", "documentation":"

A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs.

  • db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" } }, "documentation":"

" }, "DescribeReservedDBInstancesMessage":{ "type":"structure", "members":{ "ReservedDBInstanceId":{ "shape":"String", "documentation":"

The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

" }, "ReservedDBInstancesOfferingId":{ "shape":"String", "documentation":"

The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

" }, "Duration":{ "shape":"String", "documentation":"

The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" }, "ProductDescription":{ "shape":"String", "documentation":"

The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

" }, "OfferingType":{ "shape":"String", "documentation":"

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\"

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeReservedDBInstancesOfferingsMessage":{ "type":"structure", "members":{ "ReservedDBInstancesOfferingId":{ "shape":"String", "documentation":"

The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" }, "Duration":{ "shape":"String", "documentation":"

Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" }, "ProductDescription":{ "shape":"String", "documentation":"

Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.

" }, "OfferingType":{ "shape":"String", "documentation":"

The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\"

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeSourceRegionsMessage":{ "type":"structure", "members":{ "RegionName":{ "shape":"String", "documentation":"

The source region name. For example, us-east-1.

Constraints:

  • Must specify a valid AWS Region name.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" } }, "documentation":"

" }, "DomainMembership":{ "type":"structure", "members":{ "Domain":{ "shape":"String", "documentation":"

The identifier of the Active Directory Domain.

" }, "Status":{ "shape":"String", "documentation":"

The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

" }, "FQDN":{ "shape":"String", "documentation":"

The fully qualified domain name of the Active Directory Domain.

" }, "IAMRoleName":{ "shape":"String", "documentation":"

The name of the IAM role to be used when making API calls to the Directory Service.

" } }, "documentation":"

An Active Directory Domain membership record associated with the DB instance.

" }, "DomainMembershipList":{ "type":"list", "member":{ "shape":"DomainMembership", "locationName":"DomainMembership" }, "documentation":"

List of Active Directory Domain membership records associated with a DB instance.

" }, "DomainNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

Domain does not refer to an existing Active Directory Domain.

", "error":{ "code":"DomainNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "Double":{"type":"double"}, "DownloadDBLogFilePortionDetails":{ "type":"structure", "members":{ "LogFileData":{ "shape":"String", "documentation":"

Entries from the specified log file.

" }, "Marker":{ "shape":"String", "documentation":"

A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.

" }, "AdditionalDataPending":{ "shape":"Boolean", "documentation":"

Boolean value that if true, indicates there is more data to be downloaded.

" } }, "documentation":"

This data type is used as a response element to DownloadDBLogFilePortion.

" }, "DownloadDBLogFilePortionMessage":{ "type":"structure", "required":[ "DBInstanceIdentifier", "LogFileName" ], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The customer-assigned name of the DB instance that contains the log files you want to list.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "LogFileName":{ "shape":"String", "documentation":"

The name of the log file to be downloaded.

" }, "Marker":{ "shape":"String", "documentation":"

The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

" }, "NumberOfLines":{ "shape":"Integer", "documentation":"

The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file will be truncated at 1 MB in size.

If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

  • If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.

  • If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.

  • If Marker is specified as \"0\", then the specified number of lines from the beginning of the log file are returned.

  • You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.

" } }, "documentation":"

" }, "EC2SecurityGroup":{ "type":"structure", "members":{ "Status":{ "shape":"String", "documentation":"

Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" }, "EC2SecurityGroupName":{ "shape":"String", "documentation":"

Specifies the name of the EC2 security group.

" }, "EC2SecurityGroupId":{ "shape":"String", "documentation":"

Specifies the id of the EC2 security group.

" }, "EC2SecurityGroupOwnerId":{ "shape":"String", "documentation":"

Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

" } }, "documentation":"

This data type is used as a response element in the following actions:

" }, "EC2SecurityGroupList":{ "type":"list", "member":{ "shape":"EC2SecurityGroup", "locationName":"EC2SecurityGroup" } }, "Endpoint":{ "type":"structure", "members":{ "Address":{ "shape":"String", "documentation":"

Specifies the DNS address of the DB instance.

" }, "Port":{ "shape":"Integer", "documentation":"

Specifies the port that the database engine is listening on.

" }, "HostedZoneId":{ "shape":"String", "documentation":"

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" } }, "documentation":"

This data type is used as a response element in the following actions:

" }, "EngineDefaults":{ "type":"structure", "members":{ "DBParameterGroupFamily":{ "shape":"String", "documentation":"

Specifies the name of the DB parameter group family that the engine default parameters apply to.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

Contains a list of engine default parameters.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

", "wrapper":true }, "Event":{ "type":"structure", "members":{ "SourceIdentifier":{ "shape":"String", "documentation":"

Provides the identifier for the source of the event.

" }, "SourceType":{ "shape":"SourceType", "documentation":"

Specifies the source type for this event.

" }, "Message":{ "shape":"String", "documentation":"

Provides the text of this event.

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

Specifies the category for the event.

" }, "Date":{ "shape":"TStamp", "documentation":"

Specifies the date and time of the event.

" }, "SourceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the event.

" } }, "documentation":"

This data type is used as a response element in the DescribeEvents action.

" }, "EventCategoriesList":{ "type":"list", "member":{ "shape":"String", "locationName":"EventCategory" } }, "EventCategoriesMap":{ "type":"structure", "members":{ "SourceType":{ "shape":"String", "documentation":"

The source type that the returned categories belong to

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

The event categories for the specified source type

" } }, "documentation":"

Contains the results of a successful invocation of the DescribeEventCategories action.

", "wrapper":true }, "EventCategoriesMapList":{ "type":"list", "member":{ "shape":"EventCategoriesMap", "locationName":"EventCategoriesMap" } }, "EventCategoriesMessage":{ "type":"structure", "members":{ "EventCategoriesMapList":{ "shape":"EventCategoriesMapList", "documentation":"

A list of EventCategoriesMap data types.

" } }, "documentation":"

Data returned from the DescribeEventCategories action.

" }, "EventList":{ "type":"list", "member":{ "shape":"Event", "locationName":"Event" } }, "EventSubscription":{ "type":"structure", "members":{ "CustomerAwsId":{ "shape":"String", "documentation":"

The AWS customer account associated with the RDS event notification subscription.

" }, "CustSubscriptionId":{ "shape":"String", "documentation":"

The RDS event notification subscription Id.

" }, "SnsTopicArn":{ "shape":"String", "documentation":"

The topic ARN of the RDS event notification subscription.

" }, "Status":{ "shape":"String", "documentation":"

The status of the RDS event notification subscription.

Constraints:

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

" }, "SubscriptionCreationTime":{ "shape":"String", "documentation":"

The time the RDS event notification subscription was created.

" }, "SourceType":{ "shape":"String", "documentation":"

The source type for the RDS event notification subscription.

" }, "SourceIdsList":{ "shape":"SourceIdsList", "documentation":"

A list of source IDs for the RDS event notification subscription.

" }, "EventCategoriesList":{ "shape":"EventCategoriesList", "documentation":"

A list of event categories for the RDS event notification subscription.

" }, "Enabled":{ "shape":"Boolean", "documentation":"

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

" }, "EventSubscriptionArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the event subscription.

" } }, "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", "wrapper":true }, "EventSubscriptionQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

You have reached the maximum number of event subscriptions.

", "error":{ "code":"EventSubscriptionQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "EventSubscriptionsList":{ "type":"list", "member":{ "shape":"EventSubscription", "locationName":"EventSubscription" } }, "EventSubscriptionsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "EventSubscriptionsList":{ "shape":"EventSubscriptionsList", "documentation":"

A list of EventSubscriptions data types.

" } }, "documentation":"

Data returned by the DescribeEventSubscriptions action.

" }, "EventsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" }, "Events":{ "shape":"EventList", "documentation":"

A list of Event instances.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeEvents action.

" }, "FailoverDBClusterMessage":{ "type":"structure", "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "TargetDBInstanceIdentifier":{ "shape":"String", "documentation":"

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Aurora Replica in the DB cluster. For example, mydbcluster-replica1.

" } }, "documentation":"

" }, "FailoverDBClusterResult":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "Filter":{ "type":"structure", "required":[ "Name", "Values" ], "members":{ "Name":{ "shape":"String", "documentation":"

This parameter is not currently supported.

" }, "Values":{ "shape":"FilterValueList", "documentation":"

This parameter is not currently supported.

" } }, "documentation":"

This type is not currently supported.

" }, "FilterList":{ "type":"list", "member":{ "shape":"Filter", "locationName":"Filter" } }, "FilterValueList":{ "type":"list", "member":{ "shape":"String", "locationName":"Value" } }, "IPRange":{ "type":"structure", "members":{ "Status":{ "shape":"String", "documentation":"

Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

" }, "CIDRIP":{ "shape":"String", "documentation":"

Specifies the IP range.

" } }, "documentation":"

This data type is used as a response element in the DescribeDBSecurityGroups action.

" }, "IPRangeList":{ "type":"list", "member":{ "shape":"IPRange", "locationName":"IPRange" } }, "InstanceQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

Request would result in user exceeding the allowed number of DB instances.

", "error":{ "code":"InstanceQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InsufficientDBClusterCapacityFault":{ "type":"structure", "members":{ }, "documentation":"

The DB cluster does not have enough capacity for the current operation.

", "error":{ "code":"InsufficientDBClusterCapacityFault", "httpStatusCode":403, "senderFault":true }, "exception":true }, "InsufficientDBInstanceCapacityFault":{ "type":"structure", "members":{ }, "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

", "error":{ "code":"InsufficientDBInstanceCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InsufficientStorageClusterCapacityFault":{ "type":"structure", "members":{ }, "documentation":"

There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

", "error":{ "code":"InsufficientStorageClusterCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Integer":{"type":"integer"}, "IntegerOptional":{"type":"integer"}, "InvalidDBClusterSnapshotStateFault":{ "type":"structure", "members":{ }, "documentation":"

The supplied value is not a valid DB cluster snapshot state.

", "error":{ "code":"InvalidDBClusterSnapshotStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidDBClusterStateFault":{ "type":"structure", "members":{ }, "documentation":"

The DB cluster is not in a valid state.

", "error":{ "code":"InvalidDBClusterStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidDBInstanceStateFault":{ "type":"structure", "members":{ }, "documentation":"

The specified DB instance is not in the available state.

", "error":{ "code":"InvalidDBInstanceState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidDBParameterGroupStateFault":{ "type":"structure", "members":{ }, "documentation":"

The DB parameter group cannot be deleted because it is in use.

", "error":{ "code":"InvalidDBParameterGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidDBSecurityGroupStateFault":{ "type":"structure", "members":{ }, "documentation":"

The state of the DB security group does not allow deletion.

", "error":{ "code":"InvalidDBSecurityGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidDBSnapshotStateFault":{ "type":"structure", "members":{ }, "documentation":"

The state of the DB snapshot does not allow deletion.

", "error":{ "code":"InvalidDBSnapshotState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidDBSubnetGroupFault":{ "type":"structure", "members":{ }, "documentation":"

Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.

", "error":{ "code":"InvalidDBSubnetGroupFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidDBSubnetGroupStateFault":{ "type":"structure", "members":{ }, "documentation":"

The DB subnet group cannot be deleted because it is in use.

", "error":{ "code":"InvalidDBSubnetGroupStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidDBSubnetStateFault":{ "type":"structure", "members":{ }, "documentation":"

The DB subnet is not in the available state.

", "error":{ "code":"InvalidDBSubnetStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidEventSubscriptionStateFault":{ "type":"structure", "members":{ }, "documentation":"

This error can occur if someone else is modifying a subscription. You should retry the action.

", "error":{ "code":"InvalidEventSubscriptionState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidOptionGroupStateFault":{ "type":"structure", "members":{ }, "documentation":"

The option group is not in the available state.

", "error":{ "code":"InvalidOptionGroupStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidRestoreFault":{ "type":"structure", "members":{ }, "documentation":"

Cannot restore from vpc backup to non-vpc DB instance.

", "error":{ "code":"InvalidRestoreFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidS3BucketFault":{ "type":"structure", "members":{ }, "documentation":"

The specified Amazon S3 bucket name could not be found or Amazon RDS is not authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

", "error":{ "code":"InvalidS3BucketFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidSubnet":{ "type":"structure", "members":{ }, "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

", "error":{ "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidVPCNetworkStateFault":{ "type":"structure", "members":{ }, "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

", "error":{ "code":"InvalidVPCNetworkStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "KMSKeyNotAccessibleFault":{ "type":"structure", "members":{ }, "documentation":"

Error accessing KMS key.

", "error":{ "code":"KMSKeyNotAccessibleFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "KeyList":{ "type":"list", "member":{"shape":"String"} }, "ListTagsForResourceMessage":{ "type":"structure", "required":["ResourceName"], "members":{ "ResourceName":{ "shape":"String", "documentation":"

The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

" }, "Filters":{ "shape":"FilterList", "documentation":"

This parameter is not currently supported.

" } }, "documentation":"

" }, "Long":{"type":"long"}, "ModifyDBClusterMessage":{ "type":"structure", "required":["DBClusterIdentifier"], "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

  • Must be the identifier for an existing DB cluster.

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" }, "NewDBClusterIdentifier":{ "shape":"String", "documentation":"

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

" }, "ApplyImmediately":{ "shape":"Boolean", "documentation":"

A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the NewDBClusterIdentifier and MasterUserPassword values. If you set the ApplyImmediately parameter value to false, then changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

" }, "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB cluster parameter group to use for the DB cluster.

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A lst of VPC security groups that the DB cluster will belong to.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

" }, "MasterUserPassword":{ "shape":"String", "documentation":"

The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain from 8 to 41 characters.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options cannot be removed from an option group. The option group cannot be removed from a DB cluster once it is associated with a DB cluster.

" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Times should be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

" } }, "documentation":"

" }, "ModifyDBClusterParameterGroupMessage":{ "type":"structure", "required":[ "DBClusterParameterGroupName", "Parameters" ], "members":{ "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB cluster parameter group to modify.

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

A list of parameters in the DB cluster parameter group to modify.

" } }, "documentation":"

" }, "ModifyDBClusterResult":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "ModifyDBClusterSnapshotAttributeMessage":{ "type":"structure", "required":[ "DBClusterSnapshotIdentifier", "AttributeName" ], "members":{ "DBClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier for the DB cluster snapshot to modify the attributes for.

" }, "AttributeName":{ "shape":"String", "documentation":"

The name of the DB cluster snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore.

" }, "ValuesToAdd":{ "shape":"AttributeValueList", "documentation":"

A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB cluster snapshot restorable by any AWS account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts.

" }, "ValuesToRemove":{ "shape":"AttributeValueList", "documentation":"

A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.

" } }, "documentation":"

" }, "ModifyDBClusterSnapshotAttributeResult":{ "type":"structure", "members":{ "DBClusterSnapshotAttributesResult":{"shape":"DBClusterSnapshotAttributesResult"} } }, "ModifyDBInstanceMessage":{ "type":"structure", "required":["DBInstanceIdentifier"], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must be the identifier for an existing DB instance

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "AllocatedStorage":{ "shape":"IntegerOptional", "documentation":"

The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.

MySQL

Default: Uses existing setting

Valid Values: 5-6144

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

MariaDB

Default: Uses existing setting

Valid Values: 5-6144

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

PostgreSQL

Default: Uses existing setting

Valid Values: 5-6144

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Type: Integer

Oracle

Default: Uses existing setting

Valid Values: 10-6144

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

SQL Server

Cannot be modified.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action. Note that not all instance classes are available in all regions for all DB engines.

Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting

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 | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens.

Example: mySubnetGroup

" }, "DBSecurityGroups":{ "shape":"DBSecurityGroupNameList", "documentation":"

A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "ApplyImmediately":{ "shape":"Boolean", "documentation":"

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.

Default: false

" }, "MasterUserPassword":{ "shape":"String", "documentation":"

The new password for the DB instance master user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".

Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Default: Uses existing setting

Constraints: Must be 8 to 41 alphanumeric characters (MySQL, MariaDB, and Amazon Aurora), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

" }, "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

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. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Default: Uses existing setting

Constraints:

  • Must be a value from 0 to 35

  • Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6

  • Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5

  • Cannot be set to 0 if the DB instance is a source to Read Replicas

" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

  • Must be in the format hh24:mi-hh24:mi

  • Times should be in Universal Time Coordinated (UTC)

  • Must not conflict with the preferred maintenance window

  • Must be at least 30 minutes

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Constraints: Cannot be specified if the DB instance is a Read Replica.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

For a list of valid engine versions, see CreateDBInstance.

" }, "AllowMajorVersionUpgrade":{ "shape":"Boolean", "documentation":"

Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

" }, "LicenseModel":{ "shape":"String", "documentation":"

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Default: Uses existing setting

Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

Type: Integer

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, 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

" }, "NewDBInstanceIdentifier":{ "shape":"String", "documentation":"

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "StorageType":{ "shape":"String", "documentation":"

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

" }, "TdeCredentialArn":{ "shape":"String", "documentation":"

The ARN from the Key Store with which to associate the instance for TDE encryption.

" }, "TdeCredentialPassword":{ "shape":"String", "documentation":"

The password for the given ARN from the Key Store in order to access the device.

" }, "CACertificateIdentifier":{ "shape":"String", "documentation":"

Indicates the certificate that needs to be associated with the instance.

" }, "Domain":{ "shape":"String", "documentation":"

The Active Directory Domain to move the instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently only a Microsoft SQL Server instance can be created in a Active Directory Domain.

" }, "CopyTagsToSnapshot":{ "shape":"BooleanOptional", "documentation":"

True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.

" }, "MonitoringInterval":{ "shape":"IntegerOptional", "documentation":"

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

" }, "DBPortNumber":{ "shape":"IntegerOptional", "documentation":"

The port number on which the database accepts connections.

The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

MySQL

Default: 3306

Valid Values: 1150-65535

MariaDB

Default: 3306

Valid Values: 1150-65535

PostgreSQL

Default: 5432

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

Amazon Aurora

Default: 3306

Valid Values: 1150-65535

" }, "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"

Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address.

PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible.

Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

Default: false

" }, "MonitoringRoleArn":{ "shape":"String", "documentation":"

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

" }, "DomainIAMRoleName":{ "shape":"String", "documentation":"

The name of the IAM role to use when making API calls to the Directory Service.

" }, "PromotionTier":{ "shape":"IntegerOptional", "documentation":"

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.

Default: 1

Valid Values: 0 - 15

" } }, "documentation":"

" }, "ModifyDBInstanceResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "ModifyDBParameterGroupMessage":{ "type":"structure", "required":[ "DBParameterGroupName", "Parameters" ], "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB parameter group.

Constraints:

  • Must be the name of an existing DB parameter group

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.

Valid Values (for the application method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.

" } }, "documentation":"

" }, "ModifyDBSnapshotAttributeMessage":{ "type":"structure", "required":[ "DBSnapshotIdentifier", "AttributeName" ], "members":{ "DBSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier for the DB snapshot to modify the attributes for.

" }, "AttributeName":{ "shape":"String", "documentation":"

The name of the DB snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, set this value to restore.

" }, "ValuesToAdd":{ "shape":"AttributeValueList", "documentation":"

A list of DB snapshot attributes to add to the attribute specified by AttributeName.

To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts.

" }, "ValuesToRemove":{ "shape":"AttributeValueList", "documentation":"

A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.

" } }, "documentation":"

" }, "ModifyDBSnapshotAttributeResult":{ "type":"structure", "members":{ "DBSnapshotAttributesResult":{"shape":"DBSnapshotAttributesResult"} } }, "ModifyDBSnapshotMessage":{ "type":"structure", "required":["DBSnapshotIdentifier"], "members":{ "DBSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier of the DB snapshot to modify.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The engine version to update the DB snapshot to.

" } } }, "ModifyDBSnapshotResult":{ "type":"structure", "members":{ "DBSnapshot":{"shape":"DBSnapshot"} } }, "ModifyDBSubnetGroupMessage":{ "type":"structure", "required":[ "DBSubnetGroupName", "SubnetIds" ], "members":{ "DBSubnetGroupName":{ "shape":"String", "documentation":"

The name for the DB subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

" }, "DBSubnetGroupDescription":{ "shape":"String", "documentation":"

The description for the DB subnet group.

" }, "SubnetIds":{ "shape":"SubnetIdentifierList", "documentation":"

The EC2 subnet IDs for the DB subnet group.

" } }, "documentation":"

" }, "ModifyDBSubnetGroupResult":{ "type":"structure", "members":{ "DBSubnetGroup":{"shape":"DBSubnetGroup"} } }, "ModifyEventSubscriptionMessage":{ "type":"structure", "required":["SubscriptionName"], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the RDS event notification subscription.

" }, "SnsTopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" }, "SourceType":{ "shape":"String", "documentation":"

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, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

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 in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

" }, "Enabled":{ "shape":"BooleanOptional", "documentation":"

A Boolean value; set to true to activate the subscription.

" } }, "documentation":"

" }, "ModifyEventSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "ModifyOptionGroupMessage":{ "type":"structure", "required":["OptionGroupName"], "members":{ "OptionGroupName":{ "shape":"String", "documentation":"

The name of the option group to be modified.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, 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

" }, "OptionsToInclude":{ "shape":"OptionConfigurationList", "documentation":"

Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

" }, "OptionsToRemove":{ "shape":"OptionNamesList", "documentation":"

Options in this list are removed from the option group.

" }, "ApplyImmediately":{ "shape":"Boolean", "documentation":"

Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.

" } }, "documentation":"

" }, "ModifyOptionGroupResult":{ "type":"structure", "members":{ "OptionGroup":{"shape":"OptionGroup"} } }, "Option":{ "type":"structure", "members":{ "OptionName":{ "shape":"String", "documentation":"

The name of the option.

" }, "OptionDescription":{ "shape":"String", "documentation":"

The description of the option.

" }, "Persistent":{ "shape":"Boolean", "documentation":"

Indicate if this option is persistent.

" }, "Permanent":{ "shape":"Boolean", "documentation":"

Indicate if this option is permanent.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

If required, the port configured for this option to use.

" }, "OptionVersion":{ "shape":"String", "documentation":"

The version of the option.

" }, "OptionSettings":{ "shape":"OptionSettingConfigurationList", "documentation":"

The option settings for this option.

" }, "DBSecurityGroupMemberships":{ "shape":"DBSecurityGroupMembershipList", "documentation":"

If the option requires access to a port, then this DB security group allows access to the port.

" }, "VpcSecurityGroupMemberships":{ "shape":"VpcSecurityGroupMembershipList", "documentation":"

If the option requires access to a port, then this VPC security group allows access to the port.

" } }, "documentation":"

Option details.

" }, "OptionConfiguration":{ "type":"structure", "required":["OptionName"], "members":{ "OptionName":{ "shape":"String", "documentation":"

The configuration of options to include in a group.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The optional port for the option.

" }, "OptionVersion":{ "shape":"String", "documentation":"

The version for the option.

" }, "DBSecurityGroupMemberships":{ "shape":"DBSecurityGroupNameList", "documentation":"

A list of DBSecurityGroupMemebrship name strings used for this option.

" }, "VpcSecurityGroupMemberships":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A list of VpcSecurityGroupMemebrship name strings used for this option.

" }, "OptionSettings":{ "shape":"OptionSettingsList", "documentation":"

The option settings to include in an option group.

" } }, "documentation":"

A list of all available options

" }, "OptionConfigurationList":{ "type":"list", "member":{ "shape":"OptionConfiguration", "locationName":"OptionConfiguration" } }, "OptionGroup":{ "type":"structure", "members":{ "OptionGroupName":{ "shape":"String", "documentation":"

Specifies the name of the option group.

" }, "OptionGroupDescription":{ "shape":"String", "documentation":"

Provides a description of the option group.

" }, "EngineName":{ "shape":"String", "documentation":"

Indicates the name of the engine that this option group can be applied to.

" }, "MajorEngineVersion":{ "shape":"String", "documentation":"

Indicates the major engine version associated with this option group.

" }, "Options":{ "shape":"OptionsList", "documentation":"

Indicates what options are available in the option group.

" }, "AllowsVpcAndNonVpcInstanceMemberships":{ "shape":"Boolean", "documentation":"

Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

" }, "VpcId":{ "shape":"String", "documentation":"

If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

" }, "OptionGroupArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the option group.

" } }, "documentation":"

", "wrapper":true }, "OptionGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

The option group you are trying to create already exists.

", "error":{ "code":"OptionGroupAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "OptionGroupMembership":{ "type":"structure", "members":{ "OptionGroupName":{ "shape":"String", "documentation":"

The name of the option group that the instance belongs to.

" }, "Status":{ "shape":"String", "documentation":"

The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

" } }, "documentation":"

Provides information on the option groups the DB instance is a member of.

" }, "OptionGroupMembershipList":{ "type":"list", "member":{ "shape":"OptionGroupMembership", "locationName":"OptionGroupMembership" } }, "OptionGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The specified option group could not be found.

", "error":{ "code":"OptionGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "OptionGroupOption":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the option.

" }, "Description":{ "shape":"String", "documentation":"

The description of the option.

" }, "EngineName":{ "shape":"String", "documentation":"

The name of the engine that this option can be applied to.

" }, "MajorEngineVersion":{ "shape":"String", "documentation":"

Indicates the major engine version that the option is available for.

" }, "MinimumRequiredMinorEngineVersion":{ "shape":"String", "documentation":"

The minimum required engine version for the option to be applied.

" }, "PortRequired":{ "shape":"Boolean", "documentation":"

Specifies whether the option requires a port.

" }, "DefaultPort":{ "shape":"IntegerOptional", "documentation":"

If the option requires a port, specifies the default port for the option.

" }, "OptionsDependedOn":{ "shape":"OptionsDependedOn", "documentation":"

The options that are prerequisites for this option.

" }, "OptionsConflictsWith":{ "shape":"OptionsConflictsWith", "documentation":"

The options that conflict with this option.

" }, "Persistent":{ "shape":"Boolean", "documentation":"

Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

" }, "Permanent":{ "shape":"Boolean", "documentation":"

Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.

" }, "OptionGroupOptionSettings":{ "shape":"OptionGroupOptionSettingsList", "documentation":"

The option settings that are available (and the default value) for each option in an option group.

" }, "OptionGroupOptionVersions":{ "shape":"OptionGroupOptionVersionsList", "documentation":"

The versions that are available for the option.

" } }, "documentation":"

Available option.

" }, "OptionGroupOptionSetting":{ "type":"structure", "members":{ "SettingName":{ "shape":"String", "documentation":"

The name of the option group option.

" }, "SettingDescription":{ "shape":"String", "documentation":"

The description of the option group option.

" }, "DefaultValue":{ "shape":"String", "documentation":"

The default value for the option group option.

" }, "ApplyType":{ "shape":"String", "documentation":"

The DB engine specific parameter type for the option group option.

" }, "AllowedValues":{ "shape":"String", "documentation":"

Indicates the acceptable values for the option group option.

" }, "IsModifiable":{ "shape":"Boolean", "documentation":"

Boolean value where true indicates that this option group option can be changed from the default value.

" } }, "documentation":"

Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

" }, "OptionGroupOptionSettingsList":{ "type":"list", "member":{ "shape":"OptionGroupOptionSetting", "locationName":"OptionGroupOptionSetting" } }, "OptionGroupOptionVersionsList":{ "type":"list", "member":{ "shape":"OptionVersion", "locationName":"OptionVersion" } }, "OptionGroupOptionsList":{ "type":"list", "member":{ "shape":"OptionGroupOption", "locationName":"OptionGroupOption" }, "documentation":"

List of available option group options.

" }, "OptionGroupOptionsMessage":{ "type":"structure", "members":{ "OptionGroupOptions":{"shape":"OptionGroupOptionsList"}, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "OptionGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The quota of 20 option groups was exceeded for this AWS account.

", "error":{ "code":"OptionGroupQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "OptionGroups":{ "type":"structure", "members":{ "OptionGroupsList":{ "shape":"OptionGroupsList", "documentation":"

List of option groups.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

List of option groups.

" }, "OptionGroupsList":{ "type":"list", "member":{ "shape":"OptionGroup", "locationName":"OptionGroup" } }, "OptionNamesList":{ "type":"list", "member":{"shape":"String"} }, "OptionSetting":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the option that has settings that you can set.

" }, "Value":{ "shape":"String", "documentation":"

The current value of the option setting.

" }, "DefaultValue":{ "shape":"String", "documentation":"

The default value of the option setting.

" }, "Description":{ "shape":"String", "documentation":"

The description of the option setting.

" }, "ApplyType":{ "shape":"String", "documentation":"

The DB engine specific parameter type.

" }, "DataType":{ "shape":"String", "documentation":"

The data type of the option setting.

" }, "AllowedValues":{ "shape":"String", "documentation":"

The allowed values of the option setting.

" }, "IsModifiable":{ "shape":"Boolean", "documentation":"

A Boolean value that, when true, indicates the option setting can be modified from the default.

" }, "IsCollection":{ "shape":"Boolean", "documentation":"

Indicates if the option setting is part of a collection.

" } }, "documentation":"

Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

" }, "OptionSettingConfigurationList":{ "type":"list", "member":{ "shape":"OptionSetting", "locationName":"OptionSetting" } }, "OptionSettingsList":{ "type":"list", "member":{ "shape":"OptionSetting", "locationName":"OptionSetting" } }, "OptionVersion":{ "type":"structure", "members":{ "Version":{ "shape":"String", "documentation":"

The version of the option.

" }, "IsDefault":{ "shape":"Boolean", "documentation":"

True if the version is the default version of the option; otherwise, false.

" } }, "documentation":"

The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.

" }, "OptionsConflictsWith":{ "type":"list", "member":{ "shape":"String", "locationName":"OptionConflictName" } }, "OptionsDependedOn":{ "type":"list", "member":{ "shape":"String", "locationName":"OptionName" } }, "OptionsList":{ "type":"list", "member":{ "shape":"Option", "locationName":"Option" } }, "OrderableDBInstanceOption":{ "type":"structure", "members":{ "Engine":{ "shape":"String", "documentation":"

The engine type of the orderable DB instance.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The engine version of the orderable DB instance.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The DB instance class for the orderable DB instance.

" }, "LicenseModel":{ "shape":"String", "documentation":"

The license model for the orderable DB instance.

" }, "AvailabilityZones":{ "shape":"AvailabilityZoneList", "documentation":"

A list of Availability Zones for the orderable DB instance.

" }, "MultiAZCapable":{ "shape":"Boolean", "documentation":"

Indicates whether this orderable DB instance is multi-AZ capable.

" }, "ReadReplicaCapable":{ "shape":"Boolean", "documentation":"

Indicates whether this orderable DB instance can have a Read Replica.

" }, "Vpc":{ "shape":"Boolean", "documentation":"

Indicates whether this is a VPC orderable DB instance.

" }, "SupportsStorageEncryption":{ "shape":"Boolean", "documentation":"

Indicates whether this orderable DB instance supports encrypted storage.

" }, "StorageType":{ "shape":"String", "documentation":"

Indicates the storage type for this orderable DB instance.

" }, "SupportsIops":{ "shape":"Boolean", "documentation":"

Indicates whether this orderable DB instance supports provisioned IOPS.

" }, "SupportsEnhancedMonitoring":{ "shape":"Boolean", "documentation":"

Indicates whether the DB instance supports enhanced monitoring at intervals from 1 to 60 seconds.

" } }, "documentation":"

Contains a list of available options for a DB instance

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

", "wrapper":true }, "OrderableDBInstanceOptionsList":{ "type":"list", "member":{ "shape":"OrderableDBInstanceOption", "locationName":"OrderableDBInstanceOption" } }, "OrderableDBInstanceOptionsMessage":{ "type":"structure", "members":{ "OrderableDBInstanceOptions":{ "shape":"OrderableDBInstanceOptionsList", "documentation":"

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

" }, "Parameter":{ "type":"structure", "members":{ "ParameterName":{ "shape":"String", "documentation":"

Specifies the name of the parameter.

" }, "ParameterValue":{ "shape":"String", "documentation":"

Specifies the value of the parameter.

" }, "Description":{ "shape":"String", "documentation":"

Provides a description of the parameter.

" }, "Source":{ "shape":"String", "documentation":"

Indicates the source of the parameter value.

" }, "ApplyType":{ "shape":"String", "documentation":"

Specifies the engine specific parameters type.

" }, "DataType":{ "shape":"String", "documentation":"

Specifies the valid data type for the parameter.

" }, "AllowedValues":{ "shape":"String", "documentation":"

Specifies the valid range of values for the parameter.

" }, "IsModifiable":{ "shape":"Boolean", "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" }, "MinimumEngineVersion":{ "shape":"String", "documentation":"

The earliest engine version to which the parameter can apply.

" }, "ApplyMethod":{ "shape":"ApplyMethod", "documentation":"

Indicates when to apply parameter updates.

" } }, "documentation":"

This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

" }, "ParametersList":{ "type":"list", "member":{ "shape":"Parameter", "locationName":"Parameter" } }, "PendingMaintenanceAction":{ "type":"structure", "members":{ "Action":{ "shape":"String", "documentation":"

The type of pending maintenance action that is available for the resource.

" }, "AutoAppliedAfterDate":{ "shape":"TStamp", "documentation":"

The date of the maintenance window when the action will be applied. The maintenance action will be applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

" }, "ForcedApplyDate":{ "shape":"TStamp", "documentation":"

The date when the maintenance action will be automatically applied. The maintenance action will be applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

" }, "OptInStatus":{ "shape":"String", "documentation":"

Indicates the type of opt-in request that has been received for the resource.

" }, "CurrentApplyDate":{ "shape":"TStamp", "documentation":"

The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

" }, "Description":{ "shape":"String", "documentation":"

A description providing more detail about the maintenance action.

" } }, "documentation":"

Provides information about a pending maintenance action for a resource.

" }, "PendingMaintenanceActionDetails":{ "type":"list", "member":{ "shape":"PendingMaintenanceAction", "locationName":"PendingMaintenanceAction" } }, "PendingMaintenanceActions":{ "type":"list", "member":{ "shape":"ResourcePendingMaintenanceActions", "locationName":"ResourcePendingMaintenanceActions" } }, "PendingMaintenanceActionsMessage":{ "type":"structure", "members":{ "PendingMaintenanceActions":{ "shape":"PendingMaintenanceActions", "documentation":"

A list of the pending maintenance actions for the resource.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

" } }, "documentation":"

Data returned from the DescribePendingMaintenanceActions action.

" }, "PendingModifiedValues":{ "type":"structure", "members":{ "DBInstanceClass":{ "shape":"String", "documentation":"

Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

" }, "AllocatedStorage":{ "shape":"IntegerOptional", "documentation":"

Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

" }, "MasterUserPassword":{ "shape":"String", "documentation":"

Contains the pending or in-progress change of the master credentials for the DB instance.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

Specifies the pending port for the DB instance.

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

Specifies the pending number of days for which automated backups are retained.

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

" }, "EngineVersion":{ "shape":"String", "documentation":"

Indicates the database engine version.

" }, "LicenseModel":{ "shape":"String", "documentation":"

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.

" }, "DBInstanceIdentifier":{ "shape":"String", "documentation":"

Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

" }, "StorageType":{ "shape":"String", "documentation":"

Specifies the storage type to be associated with the DB instance.

" }, "CACertificateIdentifier":{ "shape":"String", "documentation":"

Specifies the identifier of the CA certificate for the DB instance.

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

The new DB subnet group for the DB instance.

" } }, "documentation":"

This data type is used as a response element in the ModifyDBInstance action.

" }, "PointInTimeRestoreNotEnabledFault":{ "type":"structure", "members":{ }, "documentation":"

SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

", "error":{ "code":"PointInTimeRestoreNotEnabled", "httpStatusCode":400, "senderFault":true }, "exception":true }, "PromoteReadReplicaDBClusterMessage":{ "type":"structure", "required":["DBClusterIdentifier"], "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

The identifier of the DB cluster Read Replica to promote. This parameter is not case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-replica1

" } }, "documentation":"

" }, "PromoteReadReplicaDBClusterResult":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "PromoteReadReplicaMessage":{ "type":"structure", "required":["DBInstanceIdentifier"], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must be the identifier for an existing Read Replica DB instance

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: mydbinstance

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Default: 1

Constraints:

  • Must be a value from 0 to 8

" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Times should be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

" } }, "documentation":"

" }, "PromoteReadReplicaResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "ProvisionedIopsNotAvailableInAZFault":{ "type":"structure", "members":{ }, "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

", "error":{ "code":"ProvisionedIopsNotAvailableInAZFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "PurchaseReservedDBInstancesOfferingMessage":{ "type":"structure", "required":["ReservedDBInstancesOfferingId"], "members":{ "ReservedDBInstancesOfferingId":{ "shape":"String", "documentation":"

The ID of the Reserved DB instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" }, "ReservedDBInstanceId":{ "shape":"String", "documentation":"

Customer-specified identifier to track this reservation.

Example: myreservationID

" }, "DBInstanceCount":{ "shape":"IntegerOptional", "documentation":"

The number of instances to reserve.

Default: 1

" }, "Tags":{"shape":"TagList"} }, "documentation":"

" }, "PurchaseReservedDBInstancesOfferingResult":{ "type":"structure", "members":{ "ReservedDBInstance":{"shape":"ReservedDBInstance"} } }, "ReadReplicaDBClusterIdentifierList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReadReplicaDBClusterIdentifier" } }, "ReadReplicaDBInstanceIdentifierList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReadReplicaDBInstanceIdentifier" } }, "ReadReplicaIdentifierList":{ "type":"list", "member":{ "shape":"String", "locationName":"ReadReplicaIdentifier" } }, "RebootDBInstanceMessage":{ "type":"structure", "required":["DBInstanceIdentifier"], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "ForceFailover":{ "shape":"BooleanOptional", "documentation":"

When true, the reboot will be conducted through a MultiAZ failover.

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

" } }, "documentation":"

" }, "RebootDBInstanceResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "RecurringCharge":{ "type":"structure", "members":{ "RecurringChargeAmount":{ "shape":"Double", "documentation":"

The amount of the recurring charge.

" }, "RecurringChargeFrequency":{ "shape":"String", "documentation":"

The frequency of the recurring charge.

" } }, "documentation":"

This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

", "wrapper":true }, "RecurringChargeList":{ "type":"list", "member":{ "shape":"RecurringCharge", "locationName":"RecurringCharge" } }, "RemoveRoleFromDBClusterMessage":{ "type":"structure", "required":[ "DBClusterIdentifier", "RoleArn" ], "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

The name of the DB cluster to disassociate the IAM role rom.

" }, "RoleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

" } } }, "RemoveSourceIdentifierFromSubscriptionMessage":{ "type":"structure", "required":[ "SubscriptionName", "SourceIdentifier" ], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the RDS event notification subscription you want to remove a source identifier from.

" }, "SourceIdentifier":{ "shape":"String", "documentation":"

The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

" } }, "documentation":"

" }, "RemoveSourceIdentifierFromSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "RemoveTagsFromResourceMessage":{ "type":"structure", "required":[ "ResourceName", "TagKeys" ], "members":{ "ResourceName":{ "shape":"String", "documentation":"

The Amazon RDS resource the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

" }, "TagKeys":{ "shape":"KeyList", "documentation":"

The tag key (name) of the tag to be removed.

" } }, "documentation":"

" }, "ReservedDBInstance":{ "type":"structure", "members":{ "ReservedDBInstanceId":{ "shape":"String", "documentation":"

The unique identifier for the reservation.

" }, "ReservedDBInstancesOfferingId":{ "shape":"String", "documentation":"

The offering identifier.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The DB instance class for the reserved DB instance.

" }, "StartTime":{ "shape":"TStamp", "documentation":"

The time the reservation started.

" }, "Duration":{ "shape":"Integer", "documentation":"

The duration of the reservation in seconds.

" }, "FixedPrice":{ "shape":"Double", "documentation":"

The fixed price charged for this reserved DB instance.

" }, "UsagePrice":{ "shape":"Double", "documentation":"

The hourly price charged for this reserved DB instance.

" }, "CurrencyCode":{ "shape":"String", "documentation":"

The currency code for the reserved DB instance.

" }, "DBInstanceCount":{ "shape":"Integer", "documentation":"

The number of reserved DB instances.

" }, "ProductDescription":{ "shape":"String", "documentation":"

The description of the reserved DB instance.

" }, "OfferingType":{ "shape":"String", "documentation":"

The offering type of this reserved DB instance.

" }, "MultiAZ":{ "shape":"Boolean", "documentation":"

Indicates if the reservation applies to Multi-AZ deployments.

" }, "State":{ "shape":"String", "documentation":"

The state of the reserved DB instance.

" }, "RecurringCharges":{ "shape":"RecurringChargeList", "documentation":"

The recurring price charged to run this reserved DB instance.

" }, "ReservedDBInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the reserved DB instance.

" } }, "documentation":"

This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

", "wrapper":true }, "ReservedDBInstanceAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

User already has a reservation with the given identifier.

", "error":{ "code":"ReservedDBInstanceAlreadyExists", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ReservedDBInstanceList":{ "type":"list", "member":{ "shape":"ReservedDBInstance", "locationName":"ReservedDBInstance" } }, "ReservedDBInstanceMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "ReservedDBInstances":{ "shape":"ReservedDBInstanceList", "documentation":"

A list of reserved DB instances.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstances action.

" }, "ReservedDBInstanceNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The specified reserved DB Instance not found.

", "error":{ "code":"ReservedDBInstanceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ReservedDBInstanceQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

Request would exceed the user's DB Instance quota.

", "error":{ "code":"ReservedDBInstanceQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ReservedDBInstancesOffering":{ "type":"structure", "members":{ "ReservedDBInstancesOfferingId":{ "shape":"String", "documentation":"

The offering identifier.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The DB instance class for the reserved DB instance.

" }, "Duration":{ "shape":"Integer", "documentation":"

The duration of the offering in seconds.

" }, "FixedPrice":{ "shape":"Double", "documentation":"

The fixed price charged for this offering.

" }, "UsagePrice":{ "shape":"Double", "documentation":"

The hourly price charged for this offering.

" }, "CurrencyCode":{ "shape":"String", "documentation":"

The currency code for the reserved DB instance offering.

" }, "ProductDescription":{ "shape":"String", "documentation":"

The database engine used by the offering.

" }, "OfferingType":{ "shape":"String", "documentation":"

The offering type.

" }, "MultiAZ":{ "shape":"Boolean", "documentation":"

Indicates if the offering applies to Multi-AZ deployments.

" }, "RecurringCharges":{ "shape":"RecurringChargeList", "documentation":"

The recurring price charged to run this reserved DB instance.

" } }, "documentation":"

This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

", "wrapper":true }, "ReservedDBInstancesOfferingList":{ "type":"list", "member":{ "shape":"ReservedDBInstancesOffering", "locationName":"ReservedDBInstancesOffering" } }, "ReservedDBInstancesOfferingMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "ReservedDBInstancesOfferings":{ "shape":"ReservedDBInstancesOfferingList", "documentation":"

A list of reserved DB instance offerings.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

" }, "ReservedDBInstancesOfferingNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

Specified offering does not exist.

", "error":{ "code":"ReservedDBInstancesOfferingNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResetDBClusterParameterGroupMessage":{ "type":"structure", "required":["DBClusterParameterGroupName"], "members":{ "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB cluster parameter group to reset.

" }, "ResetAllParameters":{ "shape":"Boolean", "documentation":"

A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You cannot use this parameter if there is a list of parameter names specified for the Parameters parameter.

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

A list of parameter names in the DB cluster parameter group to reset to the default values. You cannot use this parameter if the ResetAllParameters parameter is set to true.

" } }, "documentation":"

" }, "ResetDBParameterGroupMessage":{ "type":"structure", "required":["DBParameterGroupName"], "members":{ "DBParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB parameter group.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "ResetAllParameters":{ "shape":"Boolean", "documentation":"

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

MariaDB

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

" } }, "documentation":"

" }, "ResourceNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The specified resource ID was not found.

", "error":{ "code":"ResourceNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResourcePendingMaintenanceActions":{ "type":"structure", "members":{ "ResourceIdentifier":{ "shape":"String", "documentation":"

The ARN of the resource that has pending maintenance actions.

" }, "PendingMaintenanceActionDetails":{ "shape":"PendingMaintenanceActionDetails", "documentation":"

A list that provides details about the pending maintenance actions for the resource.

" } }, "documentation":"

Describes the pending maintenance actions for a resource.

", "wrapper":true }, "RestoreDBClusterFromS3Message":{ "type":"structure", "required":[ "DBClusterIdentifier", "Engine", "MasterUsername", "MasterUserPassword", "SourceEngine", "SourceEngineVersion", "S3BucketName", "S3IngestionRoleArn" ], "members":{ "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

A list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

" }, "BackupRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

" }, "CharacterSetName":{ "shape":"String", "documentation":"

A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

" }, "DatabaseName":{ "shape":"String", "documentation":"

The database name for the restored DB cluster.

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

The name of the DB cluster to create from the source data in the S3 bucket. This parameter is isn't case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

" }, "DBClusterParameterGroupName":{ "shape":"String", "documentation":"

The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 will be used.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A list of EC2 VPC security groups to associate with the restored DB cluster.

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

A DB subnet group to associate with the restored DB cluster.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

" }, "Engine":{ "shape":"String", "documentation":"

The name of the database engine to be used for the restored DB cluster.

Valid Values: aurora

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the database engine to use.

Aurora

Example: 5.6.10a

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which the instances in the restored DB cluster accept connections.

Default: 3306

" }, "MasterUsername":{ "shape":"String", "documentation":"

The name of the master user for the restored DB cluster.

Constraints:

  • Must be 1 to 16 alphanumeric characters.

  • First character must be a letter.

  • Cannot be a reserved word for the chosen database engine.

" }, "MasterUserPassword":{ "shape":"String", "documentation":"

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain from 8 to 41 characters.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options cannot be removed from an option group. An option group cannot be removed from a DB cluster once it is associated with a DB cluster.

" }, "PreferredBackupWindow":{ "shape":"String", "documentation":"

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Times should be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

" }, "Tags":{"shape":"TagList"}, "StorageEncrypted":{ "shape":"BooleanOptional", "documentation":"

Specifies whether the restored DB cluster is encrypted.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

The KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

" }, "SourceEngine":{ "shape":"String", "documentation":"

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

" }, "SourceEngineVersion":{ "shape":"String", "documentation":"

The version of the database that the backup files were created from.

MySQL version 5.5 and 5.6 are supported.

Example: 5.6.22

" }, "S3BucketName":{ "shape":"String", "documentation":"

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

" }, "S3Prefix":{ "shape":"String", "documentation":"

The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

" }, "S3IngestionRoleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

" } } }, "RestoreDBClusterFromS3Result":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "RestoreDBClusterFromSnapshotMessage":{ "type":"structure", "required":[ "DBClusterIdentifier", "SnapshotIdentifier", "Engine" ], "members":{ "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

" }, "DBClusterIdentifier":{ "shape":"String", "documentation":"

The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

  • Must contain from 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

" }, "SnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier for the DB cluster snapshot to restore from.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "Engine":{ "shape":"String", "documentation":"

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version of the database engine to use for the new DB cluster.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which the new DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

The name of the DB subnet group to use for the new DB cluster.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

" }, "DatabaseName":{ "shape":"String", "documentation":"

The database name for the restored DB cluster.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

The name of the option group to use for the restored DB cluster.

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A list of VPC security groups that the new DB cluster will belong to.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be assigned to the restored DB cluster.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

The KMS key identifier to use when restoring an encrypted DB cluster from a DB cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

  • If the DB cluster snapshot is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB cluster snapshot.

  • If the DB cluster snapshot is not encrypted, then the restored DB cluster is encrypted using the specified encryption key.

" } }, "documentation":"

" }, "RestoreDBClusterFromSnapshotResult":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "RestoreDBClusterToPointInTimeMessage":{ "type":"structure", "required":[ "DBClusterIdentifier", "SourceDBClusterIdentifier" ], "members":{ "DBClusterIdentifier":{ "shape":"String", "documentation":"

The name of the new DB cluster to be created.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "SourceDBClusterIdentifier":{ "shape":"String", "documentation":"

The identifier of the source DB cluster from which to restore.

Constraints:

  • Must be the identifier of an existing database instance

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "RestoreToTime":{ "shape":"TStamp", "documentation":"

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

  • Must be before the latest restorable time for the DB instance

  • Cannot be specified if UseLatestRestorableTime parameter is true

Example: 2015-03-07T23:45:00Z

" }, "UseLatestRestorableTime":{ "shape":"Boolean", "documentation":"

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if RestoreToTime parameter is provided.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which the new DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

The DB subnet group name to use for the new DB cluster.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

" }, "OptionGroupName":{ "shape":"String", "documentation":"

The name of the option group for the new DB cluster.

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A lst of VPC security groups that the new DB cluster belongs to.

" }, "Tags":{"shape":"TagList"}, "KmsKeyId":{ "shape":"String", "documentation":"

The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster will be encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

  • If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

  • If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.

If DBClusterIdentifier refers to a DB cluster that is note encrypted, then the restore request is rejected.

" } }, "documentation":"

" }, "RestoreDBClusterToPointInTimeResult":{ "type":"structure", "members":{ "DBCluster":{"shape":"DBCluster"} } }, "RestoreDBInstanceFromDBSnapshotMessage":{ "type":"structure", "required":[ "DBInstanceIdentifier", "DBSnapshotIdentifier" ], "members":{ "DBInstanceIdentifier":{ "shape":"String", "documentation":"

Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server)

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

" }, "DBSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier for the DB snapshot to restore from.

Constraints:

  • Must contain from 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The compute and memory capacity of the Amazon RDS DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which the database accepts connections.

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

The DB subnet group name to use for the new instance.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

" }, "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

  • Default VPC: true

  • VPC: false

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. 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.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

" }, "LicenseModel":{ "shape":"String", "documentation":"

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

" }, "DBName":{ "shape":"String", "documentation":"

The database name for the restored DB instance.

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.

" }, "Engine":{ "shape":"String", "documentation":"

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source. You can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values: MySQL | mariadb | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres | aurora

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.

Constraints: Must be an integer greater than 1000.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

The name of the option group to be used for the restored DB instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, 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

" }, "Tags":{"shape":"TagList"}, "StorageType":{ "shape":"String", "documentation":"

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

" }, "TdeCredentialArn":{ "shape":"String", "documentation":"

The ARN from the Key Store with which to associate the instance for TDE encryption.

" }, "TdeCredentialPassword":{ "shape":"String", "documentation":"

The password for the given ARN from the Key Store in order to access the device.

" }, "Domain":{ "shape":"String", "documentation":"

Specify the Active Directory Domain to restore the instance in.

" }, "CopyTagsToSnapshot":{ "shape":"BooleanOptional", "documentation":"

True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.

" }, "DomainIAMRoleName":{ "shape":"String", "documentation":"

Specify the name of the IAM role to be used when making API calls to the Directory Service.

" } }, "documentation":"

" }, "RestoreDBInstanceFromDBSnapshotResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "RestoreDBInstanceToPointInTimeMessage":{ "type":"structure", "required":[ "SourceDBInstanceIdentifier", "TargetDBInstanceIdentifier" ], "members":{ "SourceDBInstanceIdentifier":{ "shape":"String", "documentation":"

The identifier of the source DB instance from which to restore.

Constraints:

  • Must be the identifier of an existing database instance

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "TargetDBInstanceIdentifier":{ "shape":"String", "documentation":"

The name of the new database instance to be created.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "RestoreTime":{ "shape":"TStamp", "documentation":"

The date and time to restore from.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

  • Must be before the latest restorable time for the DB instance

  • Cannot be specified if UseLatestRestorableTime parameter is true

Example: 2009-09-07T23:45:00Z

" }, "UseLatestRestorableTime":{ "shape":"Boolean", "documentation":"

Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.

Default: false

Constraints: Cannot be specified if RestoreTime parameter is provided.

" }, "DBInstanceClass":{ "shape":"String", "documentation":"

The compute and memory capacity of the Amazon RDS DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

Default: The same DBInstanceClass as the original DB instance.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which the database accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB instance.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

" }, "DBSubnetGroupName":{ "shape":"String", "documentation":"

The DB subnet group name to use for the new instance.

Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

" }, "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

  • Default VPC:true

  • VPC:false

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. 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.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

" }, "LicenseModel":{ "shape":"String", "documentation":"

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

" }, "DBName":{ "shape":"String", "documentation":"

The database name for the restored DB instance.

This parameter is not used for the MySQL or MariaDB engines.

" }, "Engine":{ "shape":"String", "documentation":"

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Valid Values: MySQL | mariadb | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres | aurora

" }, "Iops":{ "shape":"IntegerOptional", "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Constraints: Must be an integer greater than 1000.

SQL Server

Setting the IOPS value for the SQL Server database engine is not supported.

" }, "OptionGroupName":{ "shape":"String", "documentation":"

The name of the option group to be used for the restored DB instance.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, 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

" }, "CopyTagsToSnapshot":{ "shape":"BooleanOptional", "documentation":"

True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.

" }, "Tags":{"shape":"TagList"}, "StorageType":{ "shape":"String", "documentation":"

Specifies the storage type to be associated with the DB instance.

Valid values: standard | gp2 | io1

If you specify io1, you must also include a value for the Iops parameter.

Default: io1 if the Iops parameter is specified; otherwise standard

" }, "TdeCredentialArn":{ "shape":"String", "documentation":"

The ARN from the Key Store with which to associate the instance for TDE encryption.

" }, "TdeCredentialPassword":{ "shape":"String", "documentation":"

The password for the given ARN from the Key Store in order to access the device.

" }, "Domain":{ "shape":"String", "documentation":"

Specify the Active Directory Domain to restore the instance in.

" }, "DomainIAMRoleName":{ "shape":"String", "documentation":"

Specify the name of the IAM role to be used when making API calls to the Directory Service.

" } }, "documentation":"

" }, "RestoreDBInstanceToPointInTimeResult":{ "type":"structure", "members":{ "DBInstance":{"shape":"DBInstance"} } }, "RevokeDBSecurityGroupIngressMessage":{ "type":"structure", "required":["DBSecurityGroupName"], "members":{ "DBSecurityGroupName":{ "shape":"String", "documentation":"

The name of the DB security group to revoke ingress from.

" }, "CIDRIP":{ "shape":"String", "documentation":"

The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided.

" }, "EC2SecurityGroupName":{ "shape":"String", "documentation":"

The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" }, "EC2SecurityGroupId":{ "shape":"String", "documentation":"

The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" }, "EC2SecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

" } }, "documentation":"

" }, "RevokeDBSecurityGroupIngressResult":{ "type":"structure", "members":{ "DBSecurityGroup":{"shape":"DBSecurityGroup"} } }, "SNSInvalidTopicFault":{ "type":"structure", "members":{ }, "documentation":"

SNS has responded that there is a problem with the SND topic specified.

", "error":{ "code":"SNSInvalidTopic", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SNSNoAuthorizationFault":{ "type":"structure", "members":{ }, "documentation":"

You do not have permission to publish to the SNS topic ARN.

", "error":{ "code":"SNSNoAuthorization", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SNSTopicArnNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The SNS topic ARN does not exist.

", "error":{ "code":"SNSTopicArnNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "SharedSnapshotQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

", "error":{ "code":"SharedSnapshotQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SnapshotQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

", "error":{ "code":"SnapshotQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SourceIdsList":{ "type":"list", "member":{ "shape":"String", "locationName":"SourceId" } }, "SourceNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The requested source could not be found.

", "error":{ "code":"SourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "SourceRegion":{ "type":"structure", "members":{ "RegionName":{ "shape":"String", "documentation":"

The source region name.

" }, "Endpoint":{ "shape":"String", "documentation":"

The source region endpoint.

" }, "Status":{ "shape":"String", "documentation":"

The status of the source region.

" } }, "documentation":"

Contains an AWS Region name as the result of a successful call to the DescribeSourceRegions action.

" }, "SourceRegionList":{ "type":"list", "member":{ "shape":"SourceRegion", "locationName":"SourceRegion" } }, "SourceRegionMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "SourceRegions":{ "shape":"SourceRegionList", "documentation":"

A list of SourceRegion instances that contains each source AWS Region that the current region can get a Read Replica or a DB snapshot from.

" } }, "documentation":"

Contains the result of a successful invocation of the DescribeSourceRegions action.

" }, "SourceType":{ "type":"string", "enum":[ "db-instance", "db-parameter-group", "db-security-group", "db-snapshot", "db-cluster", "db-cluster-snapshot" ] }, "StorageQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

", "error":{ "code":"StorageQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "StorageTypeNotSupportedFault":{ "type":"structure", "members":{ }, "documentation":"

StorageType specified cannot be associated with the DB Instance.

", "error":{ "code":"StorageTypeNotSupported", "httpStatusCode":400, "senderFault":true }, "exception":true }, "String":{"type":"string"}, "Subnet":{ "type":"structure", "members":{ "SubnetIdentifier":{ "shape":"String", "documentation":"

Specifies the identifier of the subnet.

" }, "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, "SubnetStatus":{ "shape":"String", "documentation":"

Specifies the status of the subnet.

" } }, "documentation":"

This data type is used as a response element in the DescribeDBSubnetGroups action.

" }, "SubnetAlreadyInUse":{ "type":"structure", "members":{ }, "documentation":"

The DB subnet is already in use in the Availability Zone.

", "error":{ "code":"SubnetAlreadyInUse", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SubnetIdentifierList":{ "type":"list", "member":{ "shape":"String", "locationName":"SubnetIdentifier" } }, "SubnetList":{ "type":"list", "member":{ "shape":"Subnet", "locationName":"Subnet" } }, "SubscriptionAlreadyExistFault":{ "type":"structure", "members":{ }, "documentation":"

The supplied subscription name already exists.

", "error":{ "code":"SubscriptionAlreadyExist", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SubscriptionCategoryNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The supplied category does not exist.

", "error":{ "code":"SubscriptionCategoryNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "SubscriptionNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The subscription name does not exist.

", "error":{ "code":"SubscriptionNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "SupportedCharacterSetsList":{ "type":"list", "member":{ "shape":"CharacterSet", "locationName":"CharacterSet" } }, "SupportedTimezonesList":{ "type":"list", "member":{ "shape":"Timezone", "locationName":"Timezone" } }, "TStamp":{"type":"timestamp"}, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" }, "Value":{ "shape":"String", "documentation":"

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" } }, "documentation":"

Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

" }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"Tag" }, "documentation":"

A list of tags.

" }, "TagListMessage":{ "type":"structure", "members":{ "TagList":{ "shape":"TagList", "documentation":"

List of tags returned by the ListTagsForResource operation.

" } }, "documentation":"

" }, "Timezone":{ "type":"structure", "members":{ "TimezoneName":{ "shape":"String", "documentation":"

The name of the time zone.

" } }, "documentation":"

A time zone associated with a DBInstance or a DBSnapshot. This data type is an element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and the DescribeDBEngineVersions actions.

" }, "UpgradeTarget":{ "type":"structure", "members":{ "Engine":{ "shape":"String", "documentation":"

The name of the upgrade target database engine.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the upgrade target database engine.

" }, "Description":{ "shape":"String", "documentation":"

The version of the database engine that a DB instance can be upgraded to.

" }, "AutoUpgrade":{ "shape":"Boolean", "documentation":"

A value that indicates whether the target version will be applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

" }, "IsMajorVersionUpgrade":{ "shape":"Boolean", "documentation":"

A value that indicates whether a database engine will be upgraded to a major version.

" } }, "documentation":"

The version of the database engine that a DB instance can be upgraded to.

" }, "ValidUpgradeTargetList":{ "type":"list", "member":{ "shape":"UpgradeTarget", "locationName":"UpgradeTarget" } }, "VpcSecurityGroupIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcSecurityGroupId" } }, "VpcSecurityGroupMembership":{ "type":"structure", "members":{ "VpcSecurityGroupId":{ "shape":"String", "documentation":"

The name of the VPC security group.

" }, "Status":{ "shape":"String", "documentation":"

The status of the VPC security group.

" } }, "documentation":"

This data type is used as a response element for queries on VPC security group membership.

" }, "VpcSecurityGroupMembershipList":{ "type":"list", "member":{ "shape":"VpcSecurityGroupMembership", "locationName":"VpcSecurityGroupMembership" } } }, "documentation":"Amazon Relational Database Service

Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

Amazon RDS API Reference

Amazon RDS User Guide

" } botocore-1.5.7/botocore/data/appstream/0000777454262600001440000000000013042511307021127 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/appstream/2016-12-01/0000777454262600001440000000000013042511307022155 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/appstream/2016-12-01/service-2.json0000666454262600001440000011417513042511306024657 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-12-01", "endpointPrefix":"appstream2", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Amazon AppStream", "signatureVersion":"v4", "signingName":"appstream", "targetPrefix":"PhotonAdminProxyService", "uid":"appstream-2016-12-01" }, "operations":{ "AssociateFleet":{ "name":"AssociateFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateFleetRequest"}, "output":{"shape":"AssociateFleetResult"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Associate a fleet to a stack.

" }, "CreateFleet":{ "name":"CreateFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateFleetRequest"}, "output":{"shape":"CreateFleetResult"}, "errors":[ {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotAvailableException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidRoleException"} ], "documentation":"

Creates a new fleet.

" }, "CreateStack":{ "name":"CreateStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateStackRequest"}, "output":{"shape":"CreateStackResult"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"ResourceAlreadyExistsException"} ], "documentation":"

Create a new stack.

" }, "CreateStreamingURL":{ "name":"CreateStreamingURL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateStreamingURLRequest"}, "output":{"shape":"CreateStreamingURLResult"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceNotAvailableException"}, {"shape":"OperationNotPermittedException"} ], "documentation":"

Creates a URL to start an AppStream 2.0 streaming session for a user. By default, the URL is valid only for 1 minute from the time that it is generated.

" }, "DeleteFleet":{ "name":"DeleteFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteFleetRequest"}, "output":{"shape":"DeleteFleetResult"}, "errors":[ {"shape":"ResourceInUseException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes a fleet.

" }, "DeleteStack":{ "name":"DeleteStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteStackRequest"}, "output":{"shape":"DeleteStackResult"}, "errors":[ {"shape":"ResourceInUseException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes the stack. After this operation completes, the environment can no longer be activated, and any reservations made for the stack are released.

" }, "DescribeFleets":{ "name":"DescribeFleets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFleetsRequest"}, "output":{"shape":"DescribeFleetsResult"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

If fleet names are provided, this operation describes the specified fleets; otherwise, all the fleets in the account are described.

" }, "DescribeImages":{ "name":"DescribeImages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImagesRequest"}, "output":{"shape":"DescribeImagesResult"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes the images. If a list of names is not provided, all images in your account are returned. This operation does not return a paginated result.

" }, "DescribeSessions":{ "name":"DescribeSessions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSessionsRequest"}, "output":{"shape":"DescribeSessionsResult"}, "documentation":"

Describes the streaming sessions for a stack and a fleet. If a user ID is provided, this operation returns streaming sessions for only that user. Pass this value for the nextToken parameter in a subsequent call to this operation to retrieve the next set of items.

" }, "DescribeStacks":{ "name":"DescribeStacks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStacksRequest"}, "output":{"shape":"DescribeStacksResult"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described. Pass the nextToken value in a subsequent call to this operation to retrieve the next set of items.

" }, "DisassociateFleet":{ "name":"DisassociateFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateFleetRequest"}, "output":{"shape":"DisassociateFleetResult"}, "errors":[ {"shape":"ResourceInUseException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Disassociates a fleet from a stack.

" }, "ExpireSession":{ "name":"ExpireSession", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ExpireSessionRequest"}, "output":{"shape":"ExpireSessionResult"}, "documentation":"

This operation immediately stops a streaming session.

" }, "ListAssociatedFleets":{ "name":"ListAssociatedFleets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAssociatedFleetsRequest"}, "output":{"shape":"ListAssociatedFleetsResult"}, "documentation":"

Lists all fleets associated with the stack.

" }, "ListAssociatedStacks":{ "name":"ListAssociatedStacks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAssociatedStacksRequest"}, "output":{"shape":"ListAssociatedStacksResult"}, "documentation":"

Lists all stacks to which the specified fleet is associated.

" }, "StartFleet":{ "name":"StartFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartFleetRequest"}, "output":{"shape":"StartFleetResult"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

Starts a fleet.

" }, "StopFleet":{ "name":"StopFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopFleetRequest"}, "output":{"shape":"StopFleetResult"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Stops a fleet.

" }, "UpdateFleet":{ "name":"UpdateFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateFleetRequest"}, "output":{"shape":"UpdateFleetResult"}, "errors":[ {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidRoleException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates an existing fleet. All the attributes except the fleet name can be updated in the STOPPED state. Only ComputeCapacity and ImageName can be updated in any other state.

" }, "UpdateStack":{ "name":"UpdateStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateStackRequest"}, "output":{"shape":"UpdateStackResult"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

Updates the specified fields in the stack with the specified name.

" } }, "shapes":{ "Application":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The unique identifier for the application.

" }, "DisplayName":{ "shape":"String", "documentation":"

The name of the application shown to the end users.

" }, "IconURL":{ "shape":"String", "documentation":"

The URL for the application icon. This URL may be time-limited.

" }, "LaunchPath":{ "shape":"String", "documentation":"

The path to the application executable in the instance.

" }, "LaunchParameters":{ "shape":"String", "documentation":"

A list of arguments that are passed to the application at launch.

" }, "Enabled":{ "shape":"Boolean", "documentation":"

An application can be disabled after image creation if there is a problem.

" }, "Metadata":{ "shape":"Metadata", "documentation":"

Additional attributes that describes the application.

" } }, "documentation":"

An entry for a single application in the application catalog.

" }, "Applications":{ "type":"list", "member":{"shape":"Application"} }, "Arn":{ "type":"string", "pattern":"^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" }, "AssociateFleetRequest":{ "type":"structure", "required":[ "FleetName", "StackName" ], "members":{ "FleetName":{ "shape":"String", "documentation":"

The name of the fleet to associate.

" }, "StackName":{ "shape":"String", "documentation":"

The name of the stack to which the fleet is associated.

" } } }, "AssociateFleetResult":{ "type":"structure", "members":{ } }, "Boolean":{"type":"boolean"}, "ComputeCapacity":{ "type":"structure", "required":["DesiredInstances"], "members":{ "DesiredInstances":{ "shape":"Integer", "documentation":"

The desired number of streaming instances.

" } }, "documentation":"

The capacity configuration for the fleet.

" }, "ComputeCapacityStatus":{ "type":"structure", "required":["Desired"], "members":{ "Desired":{ "shape":"Integer", "documentation":"

The desired number of streaming instances.

" }, "Running":{ "shape":"Integer", "documentation":"

The total number of simultaneous streaming instances that are running.

" }, "InUse":{ "shape":"Integer", "documentation":"

The number of instances that are being used for streaming.

" }, "Available":{ "shape":"Integer", "documentation":"

The number of currently available instances that can be used to stream sessions.

" } }, "documentation":"

The capacity information for the fleet.

" }, "CreateFleetRequest":{ "type":"structure", "required":[ "Name", "ImageName", "InstanceType", "ComputeCapacity" ], "members":{ "Name":{ "shape":"Name", "documentation":"

A unique identifier for the fleet.

" }, "ImageName":{ "shape":"String", "documentation":"

Unique name of the image used by the fleet.

" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type of compute resources for the fleet. Fleet instances are launched from this instance type.

" }, "ComputeCapacity":{ "shape":"ComputeCapacity", "documentation":"

The parameters for the capacity allocated to the fleet.

" }, "VpcConfig":{ "shape":"VpcConfig", "documentation":"

The VPC configuration for the fleet.

" }, "MaxUserDurationInSeconds":{ "shape":"Integer", "documentation":"

The maximum time up to which a streaming session can run.

" }, "DisconnectTimeoutInSeconds":{ "shape":"Integer", "documentation":"

The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to his/her previous session.

" }, "Description":{ "shape":"Description", "documentation":"

The description of the fleet.

" }, "DisplayName":{ "shape":"DisplayName", "documentation":"

The display name of the fleet.

" } }, "documentation":"

Contains the parameters for the new fleet to create.

" }, "CreateFleetResult":{ "type":"structure", "members":{ "Fleet":{ "shape":"Fleet", "documentation":"

The details for the created fleet.

" } } }, "CreateStackRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"String", "documentation":"

The unique identifier for this stack.

" }, "Description":{ "shape":"Description", "documentation":"

The description displayed to end users on the AppStream 2.0 portal.

" }, "DisplayName":{ "shape":"DisplayName", "documentation":"

The name displayed to end users on the AppStream 2.0 portal.

" } } }, "CreateStackResult":{ "type":"structure", "members":{ "Stack":{ "shape":"Stack", "documentation":"

The details for the created stack.

" } } }, "CreateStreamingURLRequest":{ "type":"structure", "required":[ "StackName", "FleetName", "UserId" ], "members":{ "StackName":{ "shape":"String", "documentation":"

The stack for which the URL is generated.

" }, "FleetName":{ "shape":"String", "documentation":"

The fleet for which the URL is generated.

" }, "UserId":{ "shape":"UserId", "documentation":"

A unique user ID for whom the URL is generated.

" }, "ApplicationId":{ "shape":"String", "documentation":"

The ID of the application that must be launched after the session starts.

" }, "Validity":{ "shape":"Long", "documentation":"

The validity duration of the URL in seconds. After this duration, the URL returned by this operation becomes invalid.

" }, "SessionContext":{ "shape":"String", "documentation":"

The sessionContext of the streaming URL.

" } } }, "CreateStreamingURLResult":{ "type":"structure", "members":{ "StreamingURL":{ "shape":"String", "documentation":"

The URL to start the AppStream 2.0 streaming session.

" }, "Expires":{ "shape":"Timestamp", "documentation":"

Elapsed seconds after the Unix epoch, at which time this URL expires.

" } } }, "DeleteFleetRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"String", "documentation":"

The name of the fleet to be deleted.

" } } }, "DeleteFleetResult":{ "type":"structure", "members":{ } }, "DeleteStackRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"String", "documentation":"

The name of the stack to delete.

" } } }, "DeleteStackResult":{ "type":"structure", "members":{ } }, "DescribeFleetsRequest":{ "type":"structure", "members":{ "Names":{ "shape":"StringList", "documentation":"

The fleet names to describe. Use null to describe all the fleets for the AWS account.

" }, "NextToken":{ "shape":"String", "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" } } }, "DescribeFleetsResult":{ "type":"structure", "members":{ "Fleets":{ "shape":"FleetList", "documentation":"

The list of fleet details.

" }, "NextToken":{ "shape":"String", "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } } }, "DescribeImagesRequest":{ "type":"structure", "members":{ "Names":{ "shape":"StringList", "documentation":"

A specific list of images to describe.

" } } }, "DescribeImagesResult":{ "type":"structure", "members":{ "Images":{ "shape":"ImageList", "documentation":"

The list of images.

" } } }, "DescribeSessionsRequest":{ "type":"structure", "required":[ "StackName", "FleetName" ], "members":{ "StackName":{ "shape":"String", "documentation":"

The name of the stack for which to list sessions.

" }, "FleetName":{ "shape":"String", "documentation":"

The name of the fleet for which to list sessions.

" }, "UserId":{ "shape":"UserId", "documentation":"

The user for whom to list sessions. Use null to describe all the sessions for the stack and fleet.

" }, "NextToken":{ "shape":"String", "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" }, "Limit":{ "shape":"Integer", "documentation":"

The size of each page of results. The default value is 20 and the maximum supported value is 50.

" } } }, "DescribeSessionsResult":{ "type":"structure", "members":{ "Sessions":{ "shape":"SessionList", "documentation":"

The list of streaming sessions.

" }, "NextToken":{ "shape":"String", "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } } }, "DescribeStacksRequest":{ "type":"structure", "members":{ "Names":{ "shape":"StringList", "documentation":"

The stack names to describe. Use null to describe all the stacks for the AWS account.

" }, "NextToken":{ "shape":"String", "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" } } }, "DescribeStacksResult":{ "type":"structure", "members":{ "Stacks":{ "shape":"StackList", "documentation":"

The list of stack details.

" }, "NextToken":{ "shape":"String", "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } } }, "Description":{ "type":"string", "max":256 }, "DisassociateFleetRequest":{ "type":"structure", "required":[ "FleetName", "StackName" ], "members":{ "FleetName":{ "shape":"String", "documentation":"

The name of the fleet to disassociate.

" }, "StackName":{ "shape":"String", "documentation":"

The name of the stack with which the fleet is associated.

" } } }, "DisassociateFleetResult":{ "type":"structure", "members":{ } }, "DisplayName":{ "type":"string", "max":100 }, "ErrorMessage":{"type":"string"}, "ExpireSessionRequest":{ "type":"structure", "required":["SessionId"], "members":{ "SessionId":{ "shape":"String", "documentation":"

The unique identifier of the streaming session to be stopped.

" } } }, "ExpireSessionResult":{ "type":"structure", "members":{ } }, "Fleet":{ "type":"structure", "required":[ "Arn", "Name", "ImageName", "InstanceType", "ComputeCapacityStatus", "State" ], "members":{ "Arn":{ "shape":"Arn", "documentation":"

The ARN for the fleet.

" }, "Name":{ "shape":"String", "documentation":"

The name of the fleet.

" }, "DisplayName":{ "shape":"String", "documentation":"

The name displayed to end users on the AppStream 2.0 portal.

" }, "Description":{ "shape":"String", "documentation":"

The description displayed to end users on the AppStream 2.0 portal.

" }, "ImageName":{ "shape":"String", "documentation":"

The image used by the fleet.

" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type of compute resources for the fleet. The fleet instances are launched from this instance type.

" }, "ComputeCapacityStatus":{ "shape":"ComputeCapacityStatus", "documentation":"

The capacity information for the fleet.

" }, "MaxUserDurationInSeconds":{ "shape":"Integer", "documentation":"

The maximum time during which a streaming session can run.

" }, "DisconnectTimeoutInSeconds":{ "shape":"Integer", "documentation":"

The time after disconnection when a session is considered to have ended. When a user reconnects after a disconnection, the user is connected to the same session and instance within this time interval.

" }, "State":{ "shape":"FleetState", "documentation":"

The current state for the fleet.

" }, "VpcConfig":{ "shape":"VpcConfig", "documentation":"

The VPC configuration for the fleet.

" }, "CreatedTime":{ "shape":"Timestamp", "documentation":"

The time at which the fleet was created.

" }, "FleetErrors":{ "shape":"FleetErrors", "documentation":"

The list of fleet errors is appended to this list.

" } }, "documentation":"

Contains the parameters for a fleet.

" }, "FleetError":{ "type":"structure", "members":{ "ErrorCode":{ "shape":"FleetErrorCode", "documentation":"

The error code for the fleet error.

" }, "ErrorMessage":{ "shape":"String", "documentation":"

The error message generated when the fleet has errors.

" } }, "documentation":"

The details of the fleet error.

" }, "FleetErrorCode":{ "type":"string", "enum":[ "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION", "NETWORK_INTERFACE_LIMIT_EXCEEDED", "INTERNAL_SERVICE_ERROR", "IAM_SERVICE_ROLE_IS_MISSING", "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION", "SUBNET_NOT_FOUND", "IMAGE_NOT_FOUND", "INVALID_SUBNET_CONFIGURATION" ] }, "FleetErrors":{ "type":"list", "member":{"shape":"FleetError"} }, "FleetList":{ "type":"list", "member":{"shape":"Fleet"}, "documentation":"

A list of fleets.

" }, "FleetState":{ "type":"string", "enum":[ "STARTING", "RUNNING", "STOPPING", "STOPPED" ] }, "Image":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"String", "documentation":"

The unique identifier for the image.

" }, "Arn":{ "shape":"Arn", "documentation":"

The ARN for the image.

" }, "BaseImageArn":{ "shape":"Arn", "documentation":"

The source image ARN from which this image was created.

" }, "DisplayName":{ "shape":"String", "documentation":"

The display name for the image.

" }, "State":{ "shape":"ImageState", "documentation":"

The image starts in the PENDING state, and then moves to AVAILABLE if image creation succeeds and FAILED if image creation has failed.

" }, "Visibility":{ "shape":"VisibilityType", "documentation":"

The visibility of an image to the user; images can be public or private.

" }, "Platform":{ "shape":"PlatformType", "documentation":"

The operating system platform of the image.

" }, "Description":{ "shape":"String", "documentation":"

A meaningful description for the image.

" }, "StateChangeReason":{ "shape":"ImageStateChangeReason", "documentation":"

The reason why the last state change occurred.

" }, "Applications":{ "shape":"Applications", "documentation":"

The applications associated with an image.

" }, "CreatedTime":{ "shape":"Timestamp", "documentation":"

The timestamp when the image was created.

" } }, "documentation":"

New streaming instances are booted from images. The image stores the application catalog and is connected to fleets.

" }, "ImageList":{ "type":"list", "member":{"shape":"Image"} }, "ImageState":{ "type":"string", "enum":[ "PENDING", "AVAILABLE", "FAILED", "DELETING" ] }, "ImageStateChangeReason":{ "type":"structure", "members":{ "Code":{ "shape":"ImageStateChangeReasonCode", "documentation":"

The state change reason code of the image.

" }, "Message":{ "shape":"String", "documentation":"

The state change reason message to the end user.

" } }, "documentation":"

The reason why the last state change occurred.

" }, "ImageStateChangeReasonCode":{ "type":"string", "enum":[ "INTERNAL_ERROR", "IMAGE_BUILDER_NOT_AVAILABLE" ] }, "Integer":{"type":"integer"}, "InvalidRoleException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The specified role is invalid.

", "exception":true }, "LimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The requested limit exceeds the permitted limit for an account.

", "exception":true }, "ListAssociatedFleetsRequest":{ "type":"structure", "required":["StackName"], "members":{ "StackName":{ "shape":"String", "documentation":"

The name of the stack whose associated fleets are listed.

" }, "NextToken":{ "shape":"String", "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" } } }, "ListAssociatedFleetsResult":{ "type":"structure", "members":{ "Names":{ "shape":"StringList", "documentation":"

The names of associated fleets.

" }, "NextToken":{ "shape":"String", "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } }, "documentation":"

The response from a successful operation.

" }, "ListAssociatedStacksRequest":{ "type":"structure", "required":["FleetName"], "members":{ "FleetName":{ "shape":"String", "documentation":"

The name of the fleet whose associated stacks are listed.

" }, "NextToken":{ "shape":"String", "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" } } }, "ListAssociatedStacksResult":{ "type":"structure", "members":{ "Names":{ "shape":"StringList", "documentation":"

The names of associated stacks.

" }, "NextToken":{ "shape":"String", "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } }, "documentation":"

The response from a successful operation.

" }, "Long":{"type":"long"}, "Metadata":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "Name":{ "type":"string", "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$" }, "OperationNotPermittedException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The attempted operation is not permitted.

", "exception":true }, "PlatformType":{ "type":"string", "enum":["WINDOWS"] }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The specified resource already exists.

", "exception":true }, "ResourceInUseException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The specified resource is in use.

", "exception":true }, "ResourceNotAvailableException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The specified resource exists and is not in use, but isn't available.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"

The specified resource was not found.

", "exception":true }, "Session":{ "type":"structure", "required":[ "Id", "UserId", "StackName", "FleetName", "State" ], "members":{ "Id":{ "shape":"String", "documentation":"

The unique ID for a streaming session.

" }, "UserId":{ "shape":"UserId", "documentation":"

The identifier of the user for whom the session was created.

" }, "StackName":{ "shape":"String", "documentation":"

The name of the stack for which the streaming session was created.

" }, "FleetName":{ "shape":"String", "documentation":"

The name of the fleet for which the streaming session was created.

" }, "State":{ "shape":"SessionState", "documentation":"

The current state of the streaming session.

" } }, "documentation":"

Contains the parameters for a streaming session.

" }, "SessionList":{ "type":"list", "member":{"shape":"Session"}, "documentation":"

List of sessions.

" }, "SessionState":{ "type":"string", "documentation":"

Possible values for the state of a streaming session.

", "enum":[ "ACTIVE", "PENDING", "EXPIRED" ] }, "Stack":{ "type":"structure", "required":["Name"], "members":{ "Arn":{ "shape":"Arn", "documentation":"

The ARN of the stack.

" }, "Name":{ "shape":"String", "documentation":"

The unique identifier of the stack.

" }, "Description":{ "shape":"String", "documentation":"

A meaningful description for the stack.

" }, "DisplayName":{ "shape":"String", "documentation":"

A display name for the stack.

" }, "CreatedTime":{ "shape":"Timestamp", "documentation":"

The timestamp when the stack was created.

" } }, "documentation":"

Details about a stack.

" }, "StackList":{ "type":"list", "member":{"shape":"Stack"}, "documentation":"

A list of stacks.

" }, "StartFleetRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"String", "documentation":"

The name of the fleet to start.

" } } }, "StartFleetResult":{ "type":"structure", "members":{ } }, "StopFleetRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"String", "documentation":"

The name of the fleet to stop.

" } } }, "StopFleetResult":{ "type":"structure", "members":{ } }, "String":{ "type":"string", "min":1 }, "StringList":{ "type":"list", "member":{"shape":"String"} }, "SubnetIdList":{ "type":"list", "member":{"shape":"String"}, "documentation":"

A list of subnet IDs.

", "min":1 }, "Timestamp":{"type":"timestamp"}, "UpdateFleetRequest":{ "type":"structure", "required":["Name"], "members":{ "ImageName":{ "shape":"String", "documentation":"

The image name from which a fleet is created.

" }, "Name":{ "shape":"String", "documentation":"

The name of the fleet.

" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type of compute resources for the fleet. Fleet instances are launched from this instance type.

" }, "ComputeCapacity":{ "shape":"ComputeCapacity", "documentation":"

The parameters for the capacity allocated to the fleet.

" }, "VpcConfig":{ "shape":"VpcConfig", "documentation":"

The VPC configuration for the fleet.

" }, "MaxUserDurationInSeconds":{ "shape":"Integer", "documentation":"

The maximum time during which a streaming session can run.

" }, "DisconnectTimeoutInSeconds":{ "shape":"Integer", "documentation":"

The time after disconnection when a session is considered to have ended. When the user reconnects after a disconnection, the user is connected to the same instance within this time interval.

" }, "DeleteVpcConfig":{ "shape":"Boolean", "documentation":"

Delete the VPC association for the specified fleet.

" }, "Description":{ "shape":"Description", "documentation":"

The description displayed to end users on the AppStream 2.0 portal.

" }, "DisplayName":{ "shape":"DisplayName", "documentation":"

The name displayed to end users on the AppStream 2.0 portal.

" } } }, "UpdateFleetResult":{ "type":"structure", "members":{ "Fleet":{ "shape":"Fleet", "documentation":"

A list of fleet details.

" } } }, "UpdateStackRequest":{ "type":"structure", "required":["Name"], "members":{ "DisplayName":{ "shape":"DisplayName", "documentation":"

The name displayed to end users on the AppStream 2.0 portal.

" }, "Description":{ "shape":"Description", "documentation":"

The description displayed to end users on the AppStream 2.0 portal.

" }, "Name":{ "shape":"String", "documentation":"

The name of the stack to update.

" } } }, "UpdateStackResult":{ "type":"structure", "members":{ "Stack":{ "shape":"Stack", "documentation":"

A list of stack details.

" } } }, "UserId":{ "type":"string", "max":32, "min":2 }, "VisibilityType":{ "type":"string", "enum":[ "PUBLIC", "PRIVATE" ] }, "VpcConfig":{ "type":"structure", "required":["SubnetIds"], "members":{ "SubnetIds":{ "shape":"SubnetIdList", "documentation":"

The list of subnets to which a network interface is established from the fleet instance.

" } }, "documentation":"

The VPC in which the fleet is launched.

" } }, "documentation":"Amazon AppStream 2.0

API documentation for Amazon AppStream 2.0.

" } botocore-1.5.7/botocore/data/inspector/0000777454262600001440000000000013042511307021141 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/inspector/2016-02-16/0000777454262600001440000000000013042511307022174 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/inspector/2016-02-16/service-2.json0000666454262600001440000030562313042511306024676 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-02-16", "endpointPrefix":"inspector", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Amazon Inspector", "signatureVersion":"v4", "targetPrefix":"InspectorService", "uid":"inspector-2016-02-16" }, "operations":{ "AddAttributesToFindings":{ "name":"AddAttributesToFindings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddAttributesToFindingsRequest"}, "output":{"shape":"AddAttributesToFindingsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.

" }, "CreateAssessmentTarget":{ "name":"CreateAssessmentTarget", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAssessmentTargetRequest"}, "output":{"shape":"CreateAssessmentTargetResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Amazon Inspector Assessment Targets.

" }, "CreateAssessmentTemplate":{ "name":"CreateAssessmentTemplate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAssessmentTemplateRequest"}, "output":{"shape":"CreateAssessmentTemplateResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.

" }, "CreateResourceGroup":{ "name":"CreateResourceGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateResourceGroupRequest"}, "output":{"shape":"CreateResourceGroupResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see CreateAssessmentTarget.

" }, "DeleteAssessmentRun":{ "name":"DeleteAssessmentRun", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAssessmentRunRequest"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AssessmentRunInProgressException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Deletes the assessment run that is specified by the ARN of the assessment run.

" }, "DeleteAssessmentTarget":{ "name":"DeleteAssessmentTarget", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAssessmentTargetRequest"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AssessmentRunInProgressException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Deletes the assessment target that is specified by the ARN of the assessment target.

" }, "DeleteAssessmentTemplate":{ "name":"DeleteAssessmentTemplate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAssessmentTemplateRequest"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AssessmentRunInProgressException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Deletes the assessment template that is specified by the ARN of the assessment template.

" }, "DescribeAssessmentRuns":{ "name":"DescribeAssessmentRuns", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAssessmentRunsRequest"}, "output":{"shape":"DescribeAssessmentRunsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"} ], "documentation":"

Describes the assessment runs that are specified by the ARNs of the assessment runs.

" }, "DescribeAssessmentTargets":{ "name":"DescribeAssessmentTargets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAssessmentTargetsRequest"}, "output":{"shape":"DescribeAssessmentTargetsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"} ], "documentation":"

Describes the assessment targets that are specified by the ARNs of the assessment targets.

" }, "DescribeAssessmentTemplates":{ "name":"DescribeAssessmentTemplates", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAssessmentTemplatesRequest"}, "output":{"shape":"DescribeAssessmentTemplatesResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"} ], "documentation":"

Describes the assessment templates that are specified by the ARNs of the assessment templates.

" }, "DescribeCrossAccountAccessRole":{ "name":"DescribeCrossAccountAccessRole", "http":{ "method":"POST", "requestUri":"/" }, "output":{"shape":"DescribeCrossAccountAccessRoleResponse"}, "errors":[ {"shape":"InternalException"} ], "documentation":"

Describes the IAM role that enables Amazon Inspector to access your AWS account.

" }, "DescribeFindings":{ "name":"DescribeFindings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFindingsRequest"}, "output":{"shape":"DescribeFindingsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"} ], "documentation":"

Describes the findings that are specified by the ARNs of the findings.

" }, "DescribeResourceGroups":{ "name":"DescribeResourceGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeResourceGroupsRequest"}, "output":{"shape":"DescribeResourceGroupsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"} ], "documentation":"

Describes the resource groups that are specified by the ARNs of the resource groups.

" }, "DescribeRulesPackages":{ "name":"DescribeRulesPackages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRulesPackagesRequest"}, "output":{"shape":"DescribeRulesPackagesResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"} ], "documentation":"

Describes the rules packages that are specified by the ARNs of the rules packages.

" }, "GetTelemetryMetadata":{ "name":"GetTelemetryMetadata", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetTelemetryMetadataRequest"}, "output":{"shape":"GetTelemetryMetadataResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Information about the data that is collected for the specified assessment run.

" }, "ListAssessmentRunAgents":{ "name":"ListAssessmentRunAgents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAssessmentRunAgentsRequest"}, "output":{"shape":"ListAssessmentRunAgentsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.

" }, "ListAssessmentRuns":{ "name":"ListAssessmentRuns", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAssessmentRunsRequest"}, "output":{"shape":"ListAssessmentRunsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.

" }, "ListAssessmentTargets":{ "name":"ListAssessmentTargets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAssessmentTargetsRequest"}, "output":{"shape":"ListAssessmentTargetsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.

" }, "ListAssessmentTemplates":{ "name":"ListAssessmentTemplates", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAssessmentTemplatesRequest"}, "output":{"shape":"ListAssessmentTemplatesResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.

" }, "ListEventSubscriptions":{ "name":"ListEventSubscriptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListEventSubscriptionsRequest"}, "output":{"shape":"ListEventSubscriptionsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see SubscribeToEvent and UnsubscribeFromEvent.

" }, "ListFindings":{ "name":"ListFindings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListFindingsRequest"}, "output":{"shape":"ListFindingsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.

" }, "ListRulesPackages":{ "name":"ListRulesPackages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRulesPackagesRequest"}, "output":{"shape":"ListRulesPackagesResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists all available Amazon Inspector rules packages.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Lists all tags associated with an assessment template.

" }, "PreviewAgents":{ "name":"PreviewAgents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PreviewAgentsRequest"}, "output":{"shape":"PreviewAgentsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"}, {"shape":"InvalidCrossAccountRoleException"} ], "documentation":"

Previews the agents installed on the EC2 instances that are part of the specified assessment target.

" }, "RegisterCrossAccountAccessRole":{ "name":"RegisterCrossAccountAccessRole", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterCrossAccountAccessRoleRequest"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidCrossAccountRoleException"} ], "documentation":"

Registers the IAM role that Amazon Inspector uses to list your EC2 instances at the start of the assessment run or when you call the PreviewAgents action.

" }, "RemoveAttributesFromFindings":{ "name":"RemoveAttributesFromFindings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveAttributesFromFindingsRequest"}, "output":{"shape":"RemoveAttributesFromFindingsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.

" }, "SetTagsForResource":{ "name":"SetTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetTagsForResourceRequest"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.

" }, "StartAssessmentRun":{ "name":"StartAssessmentRun", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartAssessmentRunRequest"}, "output":{"shape":"StartAssessmentRunResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"}, {"shape":"InvalidCrossAccountRoleException"}, {"shape":"AgentsAlreadyRunningAssessmentException"} ], "documentation":"

Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.

" }, "StopAssessmentRun":{ "name":"StopAssessmentRun", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopAssessmentRunRequest"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Stops the assessment run that is specified by the ARN of the assessment run.

" }, "SubscribeToEvent":{ "name":"SubscribeToEvent", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SubscribeToEventRequest"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

" }, "UnsubscribeFromEvent":{ "name":"UnsubscribeFromEvent", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnsubscribeFromEventRequest"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

" }, "UpdateAssessmentTarget":{ "name":"UpdateAssessmentTarget", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAssessmentTargetRequest"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Updates the assessment target that is specified by the ARN of the assessment target.

" } }, "shapes":{ "AccessDeniedErrorCode":{ "type":"string", "enum":[ "ACCESS_DENIED_TO_ASSESSMENT_TARGET", "ACCESS_DENIED_TO_ASSESSMENT_TEMPLATE", "ACCESS_DENIED_TO_ASSESSMENT_RUN", "ACCESS_DENIED_TO_FINDING", "ACCESS_DENIED_TO_RESOURCE_GROUP", "ACCESS_DENIED_TO_RULES_PACKAGE", "ACCESS_DENIED_TO_SNS_TOPIC", "ACCESS_DENIED_TO_IAM_ROLE" ] }, "AccessDeniedException":{ "type":"structure", "required":[ "message", "errorCode", "canRetry" ], "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Details of the exception error.

" }, "errorCode":{ "shape":"AccessDeniedErrorCode", "documentation":"

Code that indicates the type of error that is generated.

" }, "canRetry":{ "shape":"Bool", "documentation":"

You can immediately retry your request.

" } }, "documentation":"

You do not have required permissions to access the requested resource.

", "exception":true }, "AddAttributesToFindingsRequest":{ "type":"structure", "required":[ "findingArns", "attributes" ], "members":{ "findingArns":{ "shape":"AddRemoveAttributesFindingArnList", "documentation":"

The ARNs that specify the findings that you want to assign attributes to.

" }, "attributes":{ "shape":"UserAttributeList", "documentation":"

The array of attributes that you want to assign to specified findings.

" } } }, "AddAttributesToFindingsResponse":{ "type":"structure", "required":["failedItems"], "members":{ "failedItems":{ "shape":"FailedItems", "documentation":"

Attribute details that cannot be described. An error code is provided for each failed item.

" } } }, "AddRemoveAttributesFindingArnList":{ "type":"list", "member":{"shape":"Arn"}, "max":10, "min":1 }, "AgentAlreadyRunningAssessment":{ "type":"structure", "required":[ "agentId", "assessmentRunArn" ], "members":{ "agentId":{ "shape":"AgentId", "documentation":"

ID of the agent that is running on an EC2 instance that is already participating in another started assessment run.

" }, "assessmentRunArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment run that has already been started.

" } }, "documentation":"

Used in the exception error that is thrown if you start an assessment run for an assessment target that includes an EC2 instance that is already participating in another started assessment run.

" }, "AgentAlreadyRunningAssessmentList":{ "type":"list", "member":{"shape":"AgentAlreadyRunningAssessment"}, "max":10, "min":1 }, "AgentFilter":{ "type":"structure", "required":[ "agentHealths", "agentHealthCodes" ], "members":{ "agentHealths":{ "shape":"AgentHealthList", "documentation":"

The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.

" }, "agentHealthCodes":{ "shape":"AgentHealthCodeList", "documentation":"

The detailed health state of the agent. Values can be set to IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, and UNKNOWN.

" } }, "documentation":"

Contains information about an Amazon Inspector agent. This data type is used as a request parameter in the ListAssessmentRunAgents action.

" }, "AgentHealth":{ "type":"string", "enum":[ "HEALTHY", "UNHEALTHY" ] }, "AgentHealthCode":{ "type":"string", "enum":[ "IDLE", "RUNNING", "SHUTDOWN", "UNHEALTHY", "THROTTLED", "UNKNOWN" ] }, "AgentHealthCodeList":{ "type":"list", "member":{"shape":"AgentHealthCode"}, "max":10, "min":0 }, "AgentHealthList":{ "type":"list", "member":{"shape":"AgentHealth"}, "max":10, "min":0 }, "AgentId":{ "type":"string", "max":128, "min":1 }, "AgentIdList":{ "type":"list", "member":{"shape":"AgentId"}, "max":500, "min":0 }, "AgentPreview":{ "type":"structure", "required":["agentId"], "members":{ "agentId":{ "shape":"AgentId", "documentation":"

The ID of the EC2 instance where the agent is installed.

" }, "autoScalingGroup":{ "shape":"AutoScalingGroup", "documentation":"

The Auto Scaling group for the EC2 instance where the agent is installed.

" } }, "documentation":"

Used as a response element in the PreviewAgents action.

" }, "AgentPreviewList":{ "type":"list", "member":{"shape":"AgentPreview"}, "max":100, "min":0 }, "AgentsAlreadyRunningAssessmentException":{ "type":"structure", "required":[ "message", "agents", "agentsTruncated", "canRetry" ], "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Details of the exception error.

" }, "agents":{ "shape":"AgentAlreadyRunningAssessmentList", "documentation":"

" }, "agentsTruncated":{ "shape":"Bool", "documentation":"

" }, "canRetry":{ "shape":"Bool", "documentation":"

You can immediately retry your request.

" } }, "documentation":"

You started an assessment run, but one of the instances is already participating in another assessment run.

", "exception":true }, "AmiId":{ "type":"string", "max":256, "min":0 }, "Arn":{ "type":"string", "max":300, "min":1 }, "AssessmentRulesPackageArnList":{ "type":"list", "member":{"shape":"Arn"}, "max":50, "min":1 }, "AssessmentRun":{ "type":"structure", "required":[ "arn", "name", "assessmentTemplateArn", "state", "durationInSeconds", "rulesPackageArns", "userAttributesForFindings", "createdAt", "stateChangedAt", "dataCollected", "stateChanges", "notifications" ], "members":{ "arn":{ "shape":"Arn", "documentation":"

The ARN of the assessment run.

" }, "name":{ "shape":"AssessmentRunName", "documentation":"

The auto-generated name for the assessment run.

" }, "assessmentTemplateArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment template that is associated with the assessment run.

" }, "state":{ "shape":"AssessmentRunState", "documentation":"

The state of the assessment run.

" }, "durationInSeconds":{ "shape":"AssessmentRunDuration", "documentation":"

The duration of the assessment run.

" }, "rulesPackageArns":{ "shape":"AssessmentRulesPackageArnList", "documentation":"

The rules packages selected for the assessment run.

" }, "userAttributesForFindings":{ "shape":"UserAttributeList", "documentation":"

The user-defined attributes that are assigned to every generated finding.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The time when StartAssessmentRun was called.

" }, "startedAt":{ "shape":"Timestamp", "documentation":"

The time when StartAssessmentRun was called.

" }, "completedAt":{ "shape":"Timestamp", "documentation":"

The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.

" }, "stateChangedAt":{ "shape":"Timestamp", "documentation":"

The last time when the assessment run's state changed.

" }, "dataCollected":{ "shape":"Bool", "documentation":"

A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.

" }, "stateChanges":{ "shape":"AssessmentRunStateChangeList", "documentation":"

A list of the assessment run state changes.

" }, "notifications":{ "shape":"AssessmentRunNotificationList", "documentation":"

A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.

" } }, "documentation":"

A snapshot of an Amazon Inspector assessment run that contains the findings of the assessment run .

Used as the response element in the DescribeAssessmentRuns action.

" }, "AssessmentRunAgent":{ "type":"structure", "required":[ "agentId", "assessmentRunArn", "agentHealth", "agentHealthCode", "telemetryMetadata" ], "members":{ "agentId":{ "shape":"AgentId", "documentation":"

The AWS account of the EC2 instance where the agent is installed.

" }, "assessmentRunArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment run that is associated with the agent.

" }, "agentHealth":{ "shape":"AgentHealth", "documentation":"

The current health state of the agent.

" }, "agentHealthCode":{ "shape":"AgentHealthCode", "documentation":"

The detailed health state of the agent.

" }, "agentHealthDetails":{ "shape":"Message", "documentation":"

The description for the agent health code.

" }, "autoScalingGroup":{ "shape":"AutoScalingGroup", "documentation":"

The Auto Scaling group of the EC2 instance that is specified by the agent ID.

" }, "telemetryMetadata":{ "shape":"TelemetryMetadataList", "documentation":"

The Amazon Inspector application data metrics that are collected by the agent.

" } }, "documentation":"

Contains information about an Amazon Inspector agent. This data type is used as a response element in the ListAssessmentRunAgents action.

" }, "AssessmentRunAgentList":{ "type":"list", "member":{"shape":"AssessmentRunAgent"}, "max":500, "min":0 }, "AssessmentRunDuration":{ "type":"integer", "max":86400, "min":180 }, "AssessmentRunFilter":{ "type":"structure", "members":{ "namePattern":{ "shape":"NamePattern", "documentation":"

For a record to match a filter, an explicit value or a string containing a wildcard that is specified for this data type property must match the value of the assessmentRunName property of the AssessmentRun data type.

" }, "states":{ "shape":"AssessmentRunStateList", "documentation":"

For a record to match a filter, one of the values specified for this data type property must be the exact match of the value of the assessmentRunState property of the AssessmentRun data type.

" }, "durationRange":{ "shape":"DurationRange", "documentation":"

For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the AssessmentRun data type.

" }, "rulesPackageArns":{ "shape":"FilterRulesPackageArnList", "documentation":"

For a record to match a filter, the value that is specified for this data type property must be contained in the list of values of the rulesPackages property of the AssessmentRun data type.

" }, "startTimeRange":{ "shape":"TimestampRange", "documentation":"

For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the startTime property of the AssessmentRun data type.

" }, "completionTimeRange":{ "shape":"TimestampRange", "documentation":"

For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the completedAt property of the AssessmentRun data type.

" }, "stateChangeTimeRange":{ "shape":"TimestampRange", "documentation":"

For a record to match a filter, the value that is specified for this data type property must match the stateChangedAt property of the AssessmentRun data type.

" } }, "documentation":"

Used as the request parameter in the ListAssessmentRuns action.

" }, "AssessmentRunInProgressArnList":{ "type":"list", "member":{"shape":"Arn"}, "max":10, "min":1 }, "AssessmentRunInProgressException":{ "type":"structure", "required":[ "message", "assessmentRunArns", "assessmentRunArnsTruncated", "canRetry" ], "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Details of the exception error.

" }, "assessmentRunArns":{ "shape":"AssessmentRunInProgressArnList", "documentation":"

The ARNs of the assessment runs that are currently in progress.

" }, "assessmentRunArnsTruncated":{ "shape":"Bool", "documentation":"

Boolean value that indicates whether the ARN list of the assessment runs is truncated.

" }, "canRetry":{ "shape":"Bool", "documentation":"

You can immediately retry your request.

" } }, "documentation":"

You cannot perform a specified action if an assessment run is currently in progress.

", "exception":true }, "AssessmentRunList":{ "type":"list", "member":{"shape":"AssessmentRun"}, "max":10, "min":0 }, "AssessmentRunName":{ "type":"string", "max":140, "min":1 }, "AssessmentRunNotification":{ "type":"structure", "required":[ "date", "event", "error" ], "members":{ "date":{ "shape":"Timestamp", "documentation":"

The date of the notification.

" }, "event":{ "shape":"InspectorEvent", "documentation":"

The event for which a notification is sent.

" }, "message":{"shape":"Message"}, "error":{ "shape":"Bool", "documentation":"

The Boolean value that specifies whether the notification represents an error.

" }, "snsTopicArn":{ "shape":"Arn", "documentation":"

The SNS topic to which the SNS notification is sent.

" }, "snsPublishStatusCode":{ "shape":"AssessmentRunNotificationSnsStatusCode", "documentation":"

The status code of the SNS notification.

" } }, "documentation":"

Used as one of the elements of the AssessmentRun data type.

" }, "AssessmentRunNotificationList":{ "type":"list", "member":{"shape":"AssessmentRunNotification"}, "max":50, "min":0 }, "AssessmentRunNotificationSnsStatusCode":{ "type":"string", "enum":[ "SUCCESS", "TOPIC_DOES_NOT_EXIST", "ACCESS_DENIED", "INTERNAL_ERROR" ] }, "AssessmentRunState":{ "type":"string", "enum":[ "CREATED", "START_DATA_COLLECTION_PENDING", "START_DATA_COLLECTION_IN_PROGRESS", "COLLECTING_DATA", "STOP_DATA_COLLECTION_PENDING", "DATA_COLLECTED", "EVALUATING_RULES", "FAILED", "COMPLETED", "COMPLETED_WITH_ERRORS" ] }, "AssessmentRunStateChange":{ "type":"structure", "required":[ "stateChangedAt", "state" ], "members":{ "stateChangedAt":{ "shape":"Timestamp", "documentation":"

The last time the assessment run state changed.

" }, "state":{ "shape":"AssessmentRunState", "documentation":"

The assessment run state.

" } }, "documentation":"

Used as one of the elements of the AssessmentRun data type.

" }, "AssessmentRunStateChangeList":{ "type":"list", "member":{"shape":"AssessmentRunStateChange"}, "max":50, "min":0 }, "AssessmentRunStateList":{ "type":"list", "member":{"shape":"AssessmentRunState"}, "max":50, "min":0 }, "AssessmentTarget":{ "type":"structure", "required":[ "arn", "name", "resourceGroupArn", "createdAt", "updatedAt" ], "members":{ "arn":{ "shape":"Arn", "documentation":"

The ARN that specifies the Amazon Inspector assessment target.

" }, "name":{ "shape":"AssessmentTargetName", "documentation":"

The name of the Amazon Inspector assessment target.

" }, "resourceGroupArn":{ "shape":"Arn", "documentation":"

The ARN that specifies the resource group that is associated with the assessment target.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The time at which the assessment target is created.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The time at which UpdateAssessmentTarget is called.

" } }, "documentation":"

Contains information about an Amazon Inspector application. This data type is used as the response element in the DescribeAssessmentTargets action.

" }, "AssessmentTargetFilter":{ "type":"structure", "members":{ "assessmentTargetNamePattern":{ "shape":"NamePattern", "documentation":"

For a record to match a filter, an explicit value or a string that contains a wildcard that is specified for this data type property must match the value of the assessmentTargetName property of the AssessmentTarget data type.

" } }, "documentation":"

Used as the request parameter in the ListAssessmentTargets action.

" }, "AssessmentTargetList":{ "type":"list", "member":{"shape":"AssessmentTarget"}, "max":10, "min":0 }, "AssessmentTargetName":{ "type":"string", "max":140, "min":1 }, "AssessmentTemplate":{ "type":"structure", "required":[ "arn", "name", "assessmentTargetArn", "durationInSeconds", "rulesPackageArns", "userAttributesForFindings", "createdAt" ], "members":{ "arn":{ "shape":"Arn", "documentation":"

The ARN of the assessment template.

" }, "name":{ "shape":"AssessmentTemplateName", "documentation":"

The name of the assessment template.

" }, "assessmentTargetArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment target that corresponds to this assessment template.

" }, "durationInSeconds":{ "shape":"AssessmentRunDuration", "documentation":"

The duration in seconds specified for this assessment tempate. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).

" }, "rulesPackageArns":{ "shape":"AssessmentTemplateRulesPackageArnList", "documentation":"

The rules packages that are specified for this assessment template.

" }, "userAttributesForFindings":{ "shape":"UserAttributeList", "documentation":"

The user-defined attributes that are assigned to every generated finding from the assessment run that uses this assessment template.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The time at which the assessment template is created.

" } }, "documentation":"

Contains information about an Amazon Inspector assessment template. This data type is used as the response element in the DescribeAssessmentTemplates action.

" }, "AssessmentTemplateFilter":{ "type":"structure", "members":{ "namePattern":{ "shape":"NamePattern", "documentation":"

For a record to match a filter, an explicit value or a string that contains a wildcard that is specified for this data type property must match the value of the assessmentTemplateName property of the AssessmentTemplate data type.

" }, "durationRange":{ "shape":"DurationRange", "documentation":"

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the AssessmentTemplate data type.

" }, "rulesPackageArns":{ "shape":"FilterRulesPackageArnList", "documentation":"

For a record to match a filter, the values that are specified for this data type property must be contained in the list of values of the rulesPackageArns property of the AssessmentTemplate data type.

" } }, "documentation":"

Used as the request parameter in the ListAssessmentTemplates action.

" }, "AssessmentTemplateList":{ "type":"list", "member":{"shape":"AssessmentTemplate"}, "max":10, "min":0 }, "AssessmentTemplateName":{ "type":"string", "max":140, "min":1 }, "AssessmentTemplateRulesPackageArnList":{ "type":"list", "member":{"shape":"Arn"}, "max":50, "min":0 }, "AssetAttributes":{ "type":"structure", "required":["schemaVersion"], "members":{ "schemaVersion":{ "shape":"NumericVersion", "documentation":"

The schema version of this data type.

" }, "agentId":{ "shape":"AgentId", "documentation":"

The ID of the agent that is installed on the EC2 instance where the finding is generated.

" }, "autoScalingGroup":{ "shape":"AutoScalingGroup", "documentation":"

The Auto Scaling group of the EC2 instance where the finding is generated.

" }, "amiId":{ "shape":"AmiId", "documentation":"

The ID of the Amazon Machine Image (AMI) that is installed on the EC2 instance where the finding is generated.

" }, "hostname":{ "shape":"Hostname", "documentation":"

The hostname of the EC2 instance where the finding is generated.

" }, "ipv4Addresses":{ "shape":"Ipv4AddressList", "documentation":"

The list of IP v4 addresses of the EC2 instance where the finding is generated.

" } }, "documentation":"

A collection of attributes of the host from which the finding is generated.

" }, "AssetType":{ "type":"string", "enum":["ec2-instance"] }, "Attribute":{ "type":"structure", "required":["key"], "members":{ "key":{ "shape":"AttributeKey", "documentation":"

The attribute key.

" }, "value":{ "shape":"AttributeValue", "documentation":"

The value assigned to the attribute key.

" } }, "documentation":"

This data type is used as a request parameter in the AddAttributesToFindings and CreateAssessmentTemplate actions.

" }, "AttributeKey":{ "type":"string", "max":128, "min":1 }, "AttributeList":{ "type":"list", "member":{"shape":"Attribute"}, "max":50, "min":0 }, "AttributeValue":{ "type":"string", "max":256, "min":1 }, "AutoScalingGroup":{ "type":"string", "max":256, "min":1 }, "AutoScalingGroupList":{ "type":"list", "member":{"shape":"AutoScalingGroup"}, "max":20, "min":0 }, "BatchDescribeArnList":{ "type":"list", "member":{"shape":"Arn"}, "max":10, "min":1 }, "Bool":{"type":"boolean"}, "CreateAssessmentTargetRequest":{ "type":"structure", "required":[ "assessmentTargetName", "resourceGroupArn" ], "members":{ "assessmentTargetName":{ "shape":"AssessmentTargetName", "documentation":"

The user-defined name that identifies the assessment target that you want to create. The name must be unique within the AWS account.

" }, "resourceGroupArn":{ "shape":"Arn", "documentation":"

The ARN that specifies the resource group that is used to create the assessment target.

" } } }, "CreateAssessmentTargetResponse":{ "type":"structure", "required":["assessmentTargetArn"], "members":{ "assessmentTargetArn":{ "shape":"Arn", "documentation":"

The ARN that specifies the assessment target that is created.

" } } }, "CreateAssessmentTemplateRequest":{ "type":"structure", "required":[ "assessmentTargetArn", "assessmentTemplateName", "durationInSeconds", "rulesPackageArns" ], "members":{ "assessmentTargetArn":{ "shape":"Arn", "documentation":"

The ARN that specifies the assessment target for which you want to create the assessment template.

" }, "assessmentTemplateName":{ "shape":"AssessmentTemplateName", "documentation":"

The user-defined name that identifies the assessment template that you want to create. You can create several assessment templates for an assessment target. The names of the assessment templates that correspond to a particular assessment target must be unique.

" }, "durationInSeconds":{ "shape":"AssessmentRunDuration", "documentation":"

The duration of the assessment run in seconds. The default value is 3600 seconds (one hour).

" }, "rulesPackageArns":{ "shape":"AssessmentTemplateRulesPackageArnList", "documentation":"

The ARNs that specify the rules packages that you want to attach to the assessment template.

" }, "userAttributesForFindings":{ "shape":"UserAttributeList", "documentation":"

The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template.

" } } }, "CreateAssessmentTemplateResponse":{ "type":"structure", "required":["assessmentTemplateArn"], "members":{ "assessmentTemplateArn":{ "shape":"Arn", "documentation":"

The ARN that specifies the assessment template that is created.

" } } }, "CreateResourceGroupRequest":{ "type":"structure", "required":["resourceGroupTags"], "members":{ "resourceGroupTags":{ "shape":"ResourceGroupTags", "documentation":"

A collection of keys and an array of possible values, '[{\"key\":\"key1\",\"values\":[\"Value1\",\"Value2\"]},{\"key\":\"Key2\",\"values\":[\"Value3\"]}]'.

For example,'[{\"key\":\"Name\",\"values\":[\"TestEC2Instance\"]}]'.

" } } }, "CreateResourceGroupResponse":{ "type":"structure", "required":["resourceGroupArn"], "members":{ "resourceGroupArn":{ "shape":"Arn", "documentation":"

The ARN that specifies the resource group that is created.

" } } }, "DeleteAssessmentRunRequest":{ "type":"structure", "required":["assessmentRunArn"], "members":{ "assessmentRunArn":{ "shape":"Arn", "documentation":"

The ARN that specifies the assessment run that you want to delete.

" } } }, "DeleteAssessmentTargetRequest":{ "type":"structure", "required":["assessmentTargetArn"], "members":{ "assessmentTargetArn":{ "shape":"Arn", "documentation":"

The ARN that specifies the assessment target that you want to delete.

" } } }, "DeleteAssessmentTemplateRequest":{ "type":"structure", "required":["assessmentTemplateArn"], "members":{ "assessmentTemplateArn":{ "shape":"Arn", "documentation":"

The ARN that specifies the assessment template that you want to delete.

" } } }, "DescribeAssessmentRunsRequest":{ "type":"structure", "required":["assessmentRunArns"], "members":{ "assessmentRunArns":{ "shape":"BatchDescribeArnList", "documentation":"

The ARN that specifies the assessment run that you want to describe.

" } } }, "DescribeAssessmentRunsResponse":{ "type":"structure", "required":[ "assessmentRuns", "failedItems" ], "members":{ "assessmentRuns":{ "shape":"AssessmentRunList", "documentation":"

Information about the assessment run.

" }, "failedItems":{ "shape":"FailedItems", "documentation":"

Assessment run details that cannot be described. An error code is provided for each failed item.

" } } }, "DescribeAssessmentTargetsRequest":{ "type":"structure", "required":["assessmentTargetArns"], "members":{ "assessmentTargetArns":{ "shape":"BatchDescribeArnList", "documentation":"

The ARNs that specifies the assessment targets that you want to describe.

" } } }, "DescribeAssessmentTargetsResponse":{ "type":"structure", "required":[ "assessmentTargets", "failedItems" ], "members":{ "assessmentTargets":{ "shape":"AssessmentTargetList", "documentation":"

Information about the assessment targets.

" }, "failedItems":{ "shape":"FailedItems", "documentation":"

Assessment target details that cannot be described. An error code is provided for each failed item.

" } } }, "DescribeAssessmentTemplatesRequest":{ "type":"structure", "required":["assessmentTemplateArns"], "members":{ "assessmentTemplateArns":{"shape":"BatchDescribeArnList"} } }, "DescribeAssessmentTemplatesResponse":{ "type":"structure", "required":[ "assessmentTemplates", "failedItems" ], "members":{ "assessmentTemplates":{ "shape":"AssessmentTemplateList", "documentation":"

Information about the assessment templates.

" }, "failedItems":{ "shape":"FailedItems", "documentation":"

Assessment template details that cannot be described. An error code is provided for each failed item.

" } } }, "DescribeCrossAccountAccessRoleResponse":{ "type":"structure", "required":[ "roleArn", "valid", "registeredAt" ], "members":{ "roleArn":{ "shape":"Arn", "documentation":"

The ARN that specifies the IAM role that Amazon Inspector uses to access your AWS account.

" }, "valid":{ "shape":"Bool", "documentation":"

A Boolean value that specifies whether the IAM role has the necessary policies attached to enable Amazon Inspector to access your AWS account.

" }, "registeredAt":{ "shape":"Timestamp", "documentation":"

The date when the cross-account access role was registered.

" } } }, "DescribeFindingsRequest":{ "type":"structure", "required":["findingArns"], "members":{ "findingArns":{ "shape":"BatchDescribeArnList", "documentation":"

The ARN that specifies the finding that you want to describe.

" }, "locale":{ "shape":"Locale", "documentation":"

The locale into which you want to translate a finding description, recommendation, and the short description that identifies the finding.

" } } }, "DescribeFindingsResponse":{ "type":"structure", "required":[ "findings", "failedItems" ], "members":{ "findings":{ "shape":"FindingList", "documentation":"

Information about the finding.

" }, "failedItems":{ "shape":"FailedItems", "documentation":"

Finding details that cannot be described. An error code is provided for each failed item.

" } } }, "DescribeResourceGroupsRequest":{ "type":"structure", "required":["resourceGroupArns"], "members":{ "resourceGroupArns":{ "shape":"BatchDescribeArnList", "documentation":"

The ARN that specifies the resource group that you want to describe.

" } } }, "DescribeResourceGroupsResponse":{ "type":"structure", "required":[ "resourceGroups", "failedItems" ], "members":{ "resourceGroups":{ "shape":"ResourceGroupList", "documentation":"

Information about a resource group.

" }, "failedItems":{ "shape":"FailedItems", "documentation":"

Resource group details that cannot be described. An error code is provided for each failed item.

" } } }, "DescribeRulesPackagesRequest":{ "type":"structure", "required":["rulesPackageArns"], "members":{ "rulesPackageArns":{ "shape":"BatchDescribeArnList", "documentation":"

The ARN that specifies the rules package that you want to describe.

" }, "locale":{ "shape":"Locale", "documentation":"

The locale that you want to translate a rules package description into.

" } } }, "DescribeRulesPackagesResponse":{ "type":"structure", "required":[ "rulesPackages", "failedItems" ], "members":{ "rulesPackages":{ "shape":"RulesPackageList", "documentation":"

Information about the rules package.

" }, "failedItems":{ "shape":"FailedItems", "documentation":"

Rules package details that cannot be described. An error code is provided for each failed item.

" } } }, "DurationRange":{ "type":"structure", "members":{ "minSeconds":{ "shape":"AssessmentRunDuration", "documentation":"

The minimum value of the duration range. Must be greater than zero.

" }, "maxSeconds":{ "shape":"AssessmentRunDuration", "documentation":"

The maximum value of the duration range. Must be less than or equal to 604800 seconds (1 week).

" } }, "documentation":"

This data type is used in the AssessmentTemplateFilter data type.

" }, "ErrorMessage":{ "type":"string", "max":1000, "min":0 }, "EventSubscription":{ "type":"structure", "required":[ "event", "subscribedAt" ], "members":{ "event":{ "shape":"InspectorEvent", "documentation":"

The event for which Amazon Simple Notification Service (SNS) notifications are sent.

" }, "subscribedAt":{ "shape":"Timestamp", "documentation":"

The time at which SubscribeToEvent is called.

" } }, "documentation":"

This data type is used in the Subscription data type.

" }, "EventSubscriptionList":{ "type":"list", "member":{"shape":"EventSubscription"}, "max":50, "min":1 }, "FailedItemDetails":{ "type":"structure", "required":[ "failureCode", "retryable" ], "members":{ "failureCode":{ "shape":"FailedItemErrorCode", "documentation":"

The status code of a failed item.

" }, "retryable":{ "shape":"Bool", "documentation":"

Indicates whether you can immediately retry a request for this item for a specified resource.

" } }, "documentation":"

Includes details about the failed items.

" }, "FailedItemErrorCode":{ "type":"string", "enum":[ "INVALID_ARN", "DUPLICATE_ARN", "ITEM_DOES_NOT_EXIST", "ACCESS_DENIED", "LIMIT_EXCEEDED", "INTERNAL_ERROR" ] }, "FailedItems":{ "type":"map", "key":{"shape":"Arn"}, "value":{"shape":"FailedItemDetails"} }, "FilterRulesPackageArnList":{ "type":"list", "member":{"shape":"Arn"}, "max":50, "min":0 }, "Finding":{ "type":"structure", "required":[ "arn", "attributes", "userAttributes", "createdAt", "updatedAt" ], "members":{ "arn":{ "shape":"Arn", "documentation":"

The ARN that specifies the finding.

" }, "schemaVersion":{ "shape":"NumericVersion", "documentation":"

The schema version of this data type.

" }, "service":{ "shape":"ServiceName", "documentation":"

The data element is set to \"Inspector\".

" }, "serviceAttributes":{"shape":"InspectorServiceAttributes"}, "assetType":{ "shape":"AssetType", "documentation":"

The type of the host from which the finding is generated.

" }, "assetAttributes":{ "shape":"AssetAttributes", "documentation":"

A collection of attributes of the host from which the finding is generated.

" }, "id":{ "shape":"FindingId", "documentation":"

The ID of the finding.

" }, "title":{ "shape":"Text", "documentation":"

The name of the finding.

" }, "description":{ "shape":"Text", "documentation":"

The description of the finding.

" }, "recommendation":{ "shape":"Text", "documentation":"

The recommendation for the finding.

" }, "severity":{ "shape":"Severity", "documentation":"

The finding severity. Values can be set to High, Medium, Low, and Informational.

" }, "numericSeverity":{ "shape":"NumericSeverity", "documentation":"

The numeric value of the finding severity.

" }, "confidence":{ "shape":"IocConfidence", "documentation":"

This data element is currently not used.

" }, "indicatorOfCompromise":{ "shape":"Bool", "documentation":"

This data element is currently not used.

" }, "attributes":{ "shape":"AttributeList", "documentation":"

The system-defined attributes for the finding.

" }, "userAttributes":{ "shape":"UserAttributeList", "documentation":"

The user-defined attributes that are assigned to the finding.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The time when the finding was generated.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The time when AddAttributesToFindings is called.

" } }, "documentation":"

Contains information about an Amazon Inspector finding. This data type is used as the response element in the DescribeFindings action.

" }, "FindingFilter":{ "type":"structure", "members":{ "agentIds":{ "shape":"AgentIdList", "documentation":"

For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the agentId property of the Finding data type.

" }, "autoScalingGroups":{ "shape":"AutoScalingGroupList", "documentation":"

For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the autoScalingGroup property of the Finding data type.

" }, "ruleNames":{ "shape":"RuleNameList", "documentation":"

For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the ruleName property of the Finding data type.

" }, "severities":{ "shape":"SeverityList", "documentation":"

For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the severity property of the Finding data type.

" }, "rulesPackageArns":{ "shape":"FilterRulesPackageArnList", "documentation":"

For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the rulesPackageArn property of the Finding data type.

" }, "attributes":{ "shape":"AttributeList", "documentation":"

For a record to match a filter, the list of values that are specified for this data type property must be contained in the list of values of the attributes property of the Finding data type.

" }, "userAttributes":{ "shape":"AttributeList", "documentation":"

For a record to match a filter, the value that is specified for this data type property must be contained in the list of values of the userAttributes property of the Finding data type.

" }, "creationTimeRange":{ "shape":"TimestampRange", "documentation":"

The time range during which the finding is generated.

" } }, "documentation":"

This data type is used as a request parameter in the ListFindings action.

" }, "FindingId":{ "type":"string", "max":128, "min":0 }, "FindingList":{ "type":"list", "member":{"shape":"Finding"}, "max":10, "min":0 }, "GetTelemetryMetadataRequest":{ "type":"structure", "required":["assessmentRunArn"], "members":{ "assessmentRunArn":{ "shape":"Arn", "documentation":"

The ARN that specifies the assessment run that has the telemetry data that you want to obtain.

" } } }, "GetTelemetryMetadataResponse":{ "type":"structure", "required":["telemetryMetadata"], "members":{ "telemetryMetadata":{ "shape":"TelemetryMetadataList", "documentation":"

Telemetry details.

" } } }, "Hostname":{ "type":"string", "max":256, "min":0 }, "InspectorEvent":{ "type":"string", "enum":[ "ASSESSMENT_RUN_STARTED", "ASSESSMENT_RUN_COMPLETED", "ASSESSMENT_RUN_STATE_CHANGED", "FINDING_REPORTED", "OTHER" ] }, "InspectorServiceAttributes":{ "type":"structure", "required":["schemaVersion"], "members":{ "schemaVersion":{ "shape":"NumericVersion", "documentation":"

The schema version of this data type.

" }, "assessmentRunArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment run during which the finding is generated.

" }, "rulesPackageArn":{ "shape":"Arn", "documentation":"

The ARN of the rules package that is used to generate the finding.

" } }, "documentation":"

This data type is used in the Finding data type.

" }, "InternalException":{ "type":"structure", "required":[ "message", "canRetry" ], "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Details of the exception error.

" }, "canRetry":{ "shape":"Bool", "documentation":"

You can immediately retry your request.

" } }, "documentation":"

Internal server error.

", "exception":true, "fault":true }, "InvalidCrossAccountRoleErrorCode":{ "type":"string", "enum":[ "ROLE_DOES_NOT_EXIST_OR_INVALID_TRUST_RELATIONSHIP", "ROLE_DOES_NOT_HAVE_CORRECT_POLICY" ] }, "InvalidCrossAccountRoleException":{ "type":"structure", "required":[ "message", "errorCode", "canRetry" ], "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Details of the exception error.

" }, "errorCode":{ "shape":"InvalidCrossAccountRoleErrorCode", "documentation":"

Code that indicates the type of error that is generated.

" }, "canRetry":{ "shape":"Bool", "documentation":"

You can immediately retry your request.

" } }, "documentation":"

Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the assessment run.

", "exception":true }, "InvalidInputErrorCode":{ "type":"string", "enum":[ "INVALID_ASSESSMENT_TARGET_ARN", "INVALID_ASSESSMENT_TEMPLATE_ARN", "INVALID_ASSESSMENT_RUN_ARN", "INVALID_FINDING_ARN", "INVALID_RESOURCE_GROUP_ARN", "INVALID_RULES_PACKAGE_ARN", "INVALID_RESOURCE_ARN", "INVALID_SNS_TOPIC_ARN", "INVALID_IAM_ROLE_ARN", "INVALID_ASSESSMENT_TARGET_NAME", "INVALID_ASSESSMENT_TARGET_NAME_PATTERN", "INVALID_ASSESSMENT_TEMPLATE_NAME", "INVALID_ASSESSMENT_TEMPLATE_NAME_PATTERN", "INVALID_ASSESSMENT_TEMPLATE_DURATION", "INVALID_ASSESSMENT_TEMPLATE_DURATION_RANGE", "INVALID_ASSESSMENT_RUN_DURATION_RANGE", "INVALID_ASSESSMENT_RUN_START_TIME_RANGE", "INVALID_ASSESSMENT_RUN_COMPLETION_TIME_RANGE", "INVALID_ASSESSMENT_RUN_STATE_CHANGE_TIME_RANGE", "INVALID_ASSESSMENT_RUN_STATE", "INVALID_TAG", "INVALID_TAG_KEY", "INVALID_TAG_VALUE", "INVALID_RESOURCE_GROUP_TAG_KEY", "INVALID_RESOURCE_GROUP_TAG_VALUE", "INVALID_ATTRIBUTE", "INVALID_USER_ATTRIBUTE", "INVALID_USER_ATTRIBUTE_KEY", "INVALID_USER_ATTRIBUTE_VALUE", "INVALID_PAGINATION_TOKEN", "INVALID_MAX_RESULTS", "INVALID_AGENT_ID", "INVALID_AUTO_SCALING_GROUP", "INVALID_RULE_NAME", "INVALID_SEVERITY", "INVALID_LOCALE", "INVALID_EVENT", "ASSESSMENT_TARGET_NAME_ALREADY_TAKEN", "ASSESSMENT_TEMPLATE_NAME_ALREADY_TAKEN", "INVALID_NUMBER_OF_ASSESSMENT_TARGET_ARNS", "INVALID_NUMBER_OF_ASSESSMENT_TEMPLATE_ARNS", "INVALID_NUMBER_OF_ASSESSMENT_RUN_ARNS", "INVALID_NUMBER_OF_FINDING_ARNS", "INVALID_NUMBER_OF_RESOURCE_GROUP_ARNS", "INVALID_NUMBER_OF_RULES_PACKAGE_ARNS", "INVALID_NUMBER_OF_ASSESSMENT_RUN_STATES", "INVALID_NUMBER_OF_TAGS", "INVALID_NUMBER_OF_RESOURCE_GROUP_TAGS", "INVALID_NUMBER_OF_ATTRIBUTES", "INVALID_NUMBER_OF_USER_ATTRIBUTES", "INVALID_NUMBER_OF_AGENT_IDS", "INVALID_NUMBER_OF_AUTO_SCALING_GROUPS", "INVALID_NUMBER_OF_RULE_NAMES", "INVALID_NUMBER_OF_SEVERITIES" ] }, "InvalidInputException":{ "type":"structure", "required":[ "message", "errorCode", "canRetry" ], "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Details of the exception error.

" }, "errorCode":{ "shape":"InvalidInputErrorCode", "documentation":"

Code that indicates the type of error that is generated.

" }, "canRetry":{ "shape":"Bool", "documentation":"

You can immediately retry your request.

" } }, "documentation":"

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

", "exception":true }, "IocConfidence":{ "type":"integer", "max":10, "min":0 }, "Ipv4Address":{ "type":"string", "max":15, "min":7 }, "Ipv4AddressList":{ "type":"list", "member":{"shape":"Ipv4Address"}, "max":50, "min":0 }, "LimitExceededErrorCode":{ "type":"string", "enum":[ "ASSESSMENT_TARGET_LIMIT_EXCEEDED", "ASSESSMENT_TEMPLATE_LIMIT_EXCEEDED", "ASSESSMENT_RUN_LIMIT_EXCEEDED", "RESOURCE_GROUP_LIMIT_EXCEEDED", "EVENT_SUBSCRIPTION_LIMIT_EXCEEDED" ] }, "LimitExceededException":{ "type":"structure", "required":[ "message", "errorCode", "canRetry" ], "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Details of the exception error.

" }, "errorCode":{ "shape":"LimitExceededErrorCode", "documentation":"

Code that indicates the type of error that is generated.

" }, "canRetry":{ "shape":"Bool", "documentation":"

You can immediately retry your request.

" } }, "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

", "exception":true }, "ListAssessmentRunAgentsRequest":{ "type":"structure", "required":["assessmentRunArn"], "members":{ "assessmentRunArn":{ "shape":"Arn", "documentation":"

The ARN that specifies the assessment run whose agents you want to list.

" }, "filter":{ "shape":"AgentFilter", "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRunAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

" }, "maxResults":{ "shape":"ListMaxResults", "documentation":"

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500.

" } } }, "ListAssessmentRunAgentsResponse":{ "type":"structure", "required":["assessmentRunAgents"], "members":{ "assessmentRunAgents":{ "shape":"AssessmentRunAgentList", "documentation":"

A list of ARNs that specifies the agents returned by the action.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" } } }, "ListAssessmentRunsRequest":{ "type":"structure", "members":{ "assessmentTemplateArns":{ "shape":"ListParentArnList", "documentation":"

The ARNs that specify the assessment templates whose assessment runs you want to list.

" }, "filter":{ "shape":"AssessmentRunFilter", "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRuns action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

" }, "maxResults":{ "shape":"ListMaxResults", "documentation":"

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500.

" } } }, "ListAssessmentRunsResponse":{ "type":"structure", "required":["assessmentRunArns"], "members":{ "assessmentRunArns":{ "shape":"ListReturnedArnList", "documentation":"

A list of ARNs that specifies the assessment runs that are returned by the action.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" } } }, "ListAssessmentTargetsRequest":{ "type":"structure", "members":{ "filter":{ "shape":"AssessmentTargetFilter", "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentTargets action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

" }, "maxResults":{ "shape":"ListMaxResults", "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" } } }, "ListAssessmentTargetsResponse":{ "type":"structure", "required":["assessmentTargetArns"], "members":{ "assessmentTargetArns":{ "shape":"ListReturnedArnList", "documentation":"

A list of ARNs that specifies the assessment targets that are returned by the action.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" } } }, "ListAssessmentTemplatesRequest":{ "type":"structure", "members":{ "assessmentTargetArns":{ "shape":"ListParentArnList", "documentation":"

A list of ARNs that specifies the assessment targets whose assessment templates you want to list.

" }, "filter":{ "shape":"AssessmentTemplateFilter", "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentTemplates action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

" }, "maxResults":{ "shape":"ListMaxResults", "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" } } }, "ListAssessmentTemplatesResponse":{ "type":"structure", "required":["assessmentTemplateArns"], "members":{ "assessmentTemplateArns":{ "shape":"ListReturnedArnList", "documentation":"

A list of ARNs that specifies the assessment templates returned by the action.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" } } }, "ListEventSubscriptionsMaxResults":{"type":"integer"}, "ListEventSubscriptionsRequest":{ "type":"structure", "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment template for which you want to list the existing event subscriptions.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListEventSubscriptions action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

" }, "maxResults":{ "shape":"ListEventSubscriptionsMaxResults", "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" } } }, "ListEventSubscriptionsResponse":{ "type":"structure", "required":["subscriptions"], "members":{ "subscriptions":{ "shape":"SubscriptionList", "documentation":"

Details of the returned event subscriptions.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" } } }, "ListFindingsRequest":{ "type":"structure", "members":{ "assessmentRunArns":{ "shape":"ListParentArnList", "documentation":"

The ARNs of the assessment runs that generate the findings that you want to list.

" }, "filter":{ "shape":"FindingFilter", "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListFindings action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

" }, "maxResults":{ "shape":"ListMaxResults", "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" } } }, "ListFindingsResponse":{ "type":"structure", "required":["findingArns"], "members":{ "findingArns":{ "shape":"ListReturnedArnList", "documentation":"

A list of ARNs that specifies the findings returned by the action.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" } } }, "ListMaxResults":{"type":"integer"}, "ListParentArnList":{ "type":"list", "member":{"shape":"Arn"}, "max":50, "min":0 }, "ListReturnedArnList":{ "type":"list", "member":{"shape":"Arn"}, "max":100, "min":0 }, "ListRulesPackagesRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListRulesPackages action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

" }, "maxResults":{ "shape":"ListMaxResults", "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" } } }, "ListRulesPackagesResponse":{ "type":"structure", "required":["rulesPackageArns"], "members":{ "rulesPackageArns":{ "shape":"ListReturnedArnList", "documentation":"

The list of ARNs that specifies the rules packages returned by the action.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

The ARN that specifies the assessment template whose tags you want to list.

" } } }, "ListTagsForResourceResponse":{ "type":"structure", "required":["tags"], "members":{ "tags":{ "shape":"TagList", "documentation":"

A collection of key and value pairs.

" } } }, "Locale":{ "type":"string", "enum":["EN_US"] }, "Long":{"type":"long"}, "Message":{ "type":"string", "max":1000, "min":0 }, "MessageType":{ "type":"string", "max":300, "min":1 }, "NamePattern":{ "type":"string", "max":140, "min":1 }, "NoSuchEntityErrorCode":{ "type":"string", "enum":[ "ASSESSMENT_TARGET_DOES_NOT_EXIST", "ASSESSMENT_TEMPLATE_DOES_NOT_EXIST", "ASSESSMENT_RUN_DOES_NOT_EXIST", "FINDING_DOES_NOT_EXIST", "RESOURCE_GROUP_DOES_NOT_EXIST", "RULES_PACKAGE_DOES_NOT_EXIST", "SNS_TOPIC_DOES_NOT_EXIST", "IAM_ROLE_DOES_NOT_EXIST" ] }, "NoSuchEntityException":{ "type":"structure", "required":[ "message", "errorCode", "canRetry" ], "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Details of the exception error.

" }, "errorCode":{ "shape":"NoSuchEntityErrorCode", "documentation":"

Code that indicates the type of error that is generated.

" }, "canRetry":{ "shape":"Bool", "documentation":"

You can immediately retry your request.

" } }, "documentation":"

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

", "exception":true }, "NumericSeverity":{ "type":"double", "max":10.0, "min":0.0 }, "NumericVersion":{ "type":"integer", "min":0 }, "PaginationToken":{ "type":"string", "max":300, "min":1 }, "PreviewAgentsMaxResults":{"type":"integer"}, "PreviewAgentsRequest":{ "type":"structure", "required":["previewAgentsArn"], "members":{ "previewAgentsArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment target whose agents you want to preview.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the PreviewAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

" }, "maxResults":{ "shape":"PreviewAgentsMaxResults", "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" } } }, "PreviewAgentsResponse":{ "type":"structure", "required":["agentPreviews"], "members":{ "agentPreviews":{ "shape":"AgentPreviewList", "documentation":"

The resulting list of agents.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" } } }, "ProviderName":{ "type":"string", "max":1000, "min":0 }, "RegisterCrossAccountAccessRoleRequest":{ "type":"structure", "required":["roleArn"], "members":{ "roleArn":{ "shape":"Arn", "documentation":"

The ARN of the IAM role that Amazon Inspector uses to list your EC2 instances during the assessment run or when you call the PreviewAgents action.

" } } }, "RemoveAttributesFromFindingsRequest":{ "type":"structure", "required":[ "findingArns", "attributeKeys" ], "members":{ "findingArns":{ "shape":"AddRemoveAttributesFindingArnList", "documentation":"

The ARNs that specify the findings that you want to remove attributes from.

" }, "attributeKeys":{ "shape":"UserAttributeKeyList", "documentation":"

The array of attribute keys that you want to remove from specified findings.

" } } }, "RemoveAttributesFromFindingsResponse":{ "type":"structure", "required":["failedItems"], "members":{ "failedItems":{ "shape":"FailedItems", "documentation":"

Attributes details that cannot be described. An error code is provided for each failed item.

" } } }, "ResourceGroup":{ "type":"structure", "required":[ "arn", "tags", "createdAt" ], "members":{ "arn":{ "shape":"Arn", "documentation":"

The ARN of the resource group.

" }, "tags":{ "shape":"ResourceGroupTags", "documentation":"

The tags (key and value pairs) of the resource group. This data type property is used in the CreateResourceGroup action.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The time at which resource group is created.

" } }, "documentation":"

Contains information about a resource group. The resource group defines a set of tags that, when queried, identify the AWS resources that make up the assessment target. This data type is used as the response element in the DescribeResourceGroups action.

" }, "ResourceGroupList":{ "type":"list", "member":{"shape":"ResourceGroup"}, "max":10, "min":0 }, "ResourceGroupTag":{ "type":"structure", "required":["key"], "members":{ "key":{ "shape":"TagKey", "documentation":"

A tag key.

" }, "value":{ "shape":"TagValue", "documentation":"

The value assigned to a tag key.

" } }, "documentation":"

This data type is used as one of the elements of the ResourceGroup data type.

" }, "ResourceGroupTags":{ "type":"list", "member":{"shape":"ResourceGroupTag"}, "max":10, "min":1 }, "RuleName":{ "type":"string", "max":1000 }, "RuleNameList":{ "type":"list", "member":{"shape":"RuleName"}, "max":50, "min":0 }, "RulesPackage":{ "type":"structure", "required":[ "arn", "name", "version", "provider" ], "members":{ "arn":{ "shape":"Arn", "documentation":"

The ARN of the rules package.

" }, "name":{ "shape":"RulesPackageName", "documentation":"

The name of the rules package.

" }, "version":{ "shape":"Version", "documentation":"

The version ID of the rules package.

" }, "provider":{ "shape":"ProviderName", "documentation":"

The provider of the rules package.

" }, "description":{ "shape":"Text", "documentation":"

The description of the rules package.

" } }, "documentation":"

Contains information about an Amazon Inspector rules package. This data type is used as the response element in the DescribeRulesPackages action.

" }, "RulesPackageList":{ "type":"list", "member":{"shape":"RulesPackage"}, "max":10, "min":0 }, "RulesPackageName":{ "type":"string", "max":1000, "min":0 }, "ServiceName":{ "type":"string", "max":128, "min":0 }, "SetTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment template that you want to set tags to.

" }, "tags":{ "shape":"TagList", "documentation":"

A collection of key and value pairs that you want to set to the assessment template.

" } } }, "Severity":{ "type":"string", "enum":[ "Low", "Medium", "High", "Informational", "Undefined" ] }, "SeverityList":{ "type":"list", "member":{"shape":"Severity"}, "max":50, "min":0 }, "StartAssessmentRunRequest":{ "type":"structure", "required":["assessmentTemplateArn"], "members":{ "assessmentTemplateArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment template of the assessment run that you want to start.

" }, "assessmentRunName":{ "shape":"AssessmentRunName", "documentation":"

You can specify the name for the assessment run. The name must be unique for the assessment template whose ARN is used to start the assessment run.

" } } }, "StartAssessmentRunResponse":{ "type":"structure", "required":["assessmentRunArn"], "members":{ "assessmentRunArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment run that has been started.

" } } }, "StopAssessmentRunRequest":{ "type":"structure", "required":["assessmentRunArn"], "members":{ "assessmentRunArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment run that you want to stop.

" } } }, "SubscribeToEventRequest":{ "type":"structure", "required":[ "resourceArn", "event", "topicArn" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment template that is used during the event for which you want to receive SNS notifications.

" }, "event":{ "shape":"InspectorEvent", "documentation":"

The event for which you want to receive SNS notifications.

" }, "topicArn":{ "shape":"Arn", "documentation":"

The ARN of the SNS topic to which the SNS notifications are sent.

" } } }, "Subscription":{ "type":"structure", "required":[ "resourceArn", "topicArn", "eventSubscriptions" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment template that is used during the event for which the SNS notification is sent.

" }, "topicArn":{ "shape":"Arn", "documentation":"

The ARN of the Amazon Simple Notification Service (SNS) topic to which the SNS notifications are sent.

" }, "eventSubscriptions":{ "shape":"EventSubscriptionList", "documentation":"

The list of existing event subscriptions.

" } }, "documentation":"

This data type is used as a response element in the ListEventSubscriptions action.

" }, "SubscriptionList":{ "type":"list", "member":{"shape":"Subscription"}, "max":50, "min":0 }, "Tag":{ "type":"structure", "required":["key"], "members":{ "key":{ "shape":"TagKey", "documentation":"

A tag key.

" }, "value":{ "shape":"TagValue", "documentation":"

A value assigned to a tag key.

" } }, "documentation":"

A key and value pair. This data type is used as a request parameter in the SetTagsForResource action and a response element in the ListTagsForResource action.

" }, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":10, "min":0 }, "TagValue":{ "type":"string", "max":256, "min":1 }, "TelemetryMetadata":{ "type":"structure", "required":[ "messageType", "count" ], "members":{ "messageType":{ "shape":"MessageType", "documentation":"

A specific type of behavioral data that is collected by the agent.

" }, "count":{ "shape":"Long", "documentation":"

The count of messages that the agent sends to the Amazon Inspector service.

" }, "dataSize":{ "shape":"Long", "documentation":"

The data size of messages that the agent sends to the Amazon Inspector service.

" } }, "documentation":"

The metadata about the Amazon Inspector application data metrics collected by the agent. This data type is used as the response element in the GetTelemetryMetadata action.

" }, "TelemetryMetadataList":{ "type":"list", "member":{"shape":"TelemetryMetadata"}, "max":5000, "min":0 }, "Text":{ "type":"string", "max":20000, "min":0 }, "Timestamp":{"type":"timestamp"}, "TimestampRange":{ "type":"structure", "members":{ "beginDate":{ "shape":"Timestamp", "documentation":"

The minimum value of the timestamp range.

" }, "endDate":{ "shape":"Timestamp", "documentation":"

The maximum value of the timestamp range.

" } }, "documentation":"

This data type is used in the AssessmentRunFilter data type.

" }, "UnsubscribeFromEventRequest":{ "type":"structure", "required":[ "resourceArn", "event", "topicArn" ], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment template that is used during the event for which you want to stop receiving SNS notifications.

" }, "event":{ "shape":"InspectorEvent", "documentation":"

The event for which you want to stop receiving SNS notifications.

" }, "topicArn":{ "shape":"Arn", "documentation":"

The ARN of the SNS topic to which SNS notifications are sent.

" } } }, "UpdateAssessmentTargetRequest":{ "type":"structure", "required":[ "assessmentTargetArn", "assessmentTargetName", "resourceGroupArn" ], "members":{ "assessmentTargetArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment target that you want to update.

" }, "assessmentTargetName":{ "shape":"AssessmentTargetName", "documentation":"

The name of the assessment target that you want to update.

" }, "resourceGroupArn":{ "shape":"Arn", "documentation":"

The ARN of the resource group that is used to specify the new resource group to associate with the assessment target.

" } } }, "UserAttributeKeyList":{ "type":"list", "member":{"shape":"AttributeKey"}, "max":10, "min":0 }, "UserAttributeList":{ "type":"list", "member":{"shape":"Attribute"}, "max":10, "min":0 }, "Version":{ "type":"string", "max":1000, "min":0 } }, "documentation":"Amazon Inspector

Amazon Inspector enables you to analyze the behavior of your AWS resources and to identify potential security issues. For more information, see Amazon Inspector User Guide.

" } botocore-1.5.7/botocore/data/inspector/2015-08-18/0000777454262600001440000000000013042511307022203 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/inspector/2015-08-18/service-2.json0000666454262600001440000023614013042511306024702 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-08-18", "endpointPrefix":"inspector", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Amazon Inspector", "signatureVersion":"v4", "targetPrefix":"InspectorService" }, "operations":{ "AddAttributesToFindings":{ "name":"AddAttributesToFindings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddAttributesToFindingsRequest"}, "output":{"shape":"AddAttributesToFindingsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Assigns attributes (key and value pair) to the findings specified by the findings' ARNs.

" }, "AttachAssessmentAndRulesPackage":{ "name":"AttachAssessmentAndRulesPackage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachAssessmentAndRulesPackageRequest"}, "output":{"shape":"AttachAssessmentAndRulesPackageResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Attaches the rules package specified by the rules package ARN to the assessment specified by the assessment ARN.

" }, "CreateApplication":{ "name":"CreateApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateApplicationRequest"}, "output":{"shape":"CreateApplicationResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Creates a new application using the resource group ARN generated by CreateResourceGroup. You can create up to 50 applications per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Inspector Applications.

" }, "CreateAssessment":{ "name":"CreateAssessment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAssessmentRequest"}, "output":{"shape":"CreateAssessmentResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Creates an assessment for the application specified by the application ARN. You can create up to 500 assessments per AWS account.

" }, "CreateResourceGroup":{ "name":"CreateResourceGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateResourceGroupRequest"}, "output":{"shape":"CreateResourceGroupResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Inspector application. The created resource group is then used to create an Inspector application.

" }, "DeleteApplication":{ "name":"DeleteApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteApplicationRequest"}, "output":{"shape":"DeleteApplicationResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"OperationInProgressException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Deletes the application specified by the application ARN.

" }, "DeleteAssessment":{ "name":"DeleteAssessment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAssessmentRequest"}, "output":{"shape":"DeleteAssessmentResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"OperationInProgressException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Deletes the assessment specified by the assessment ARN.

" }, "DeleteRun":{ "name":"DeleteRun", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRunRequest"}, "output":{"shape":"DeleteRunResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Deletes the assessment run specified by the run ARN.

" }, "DescribeApplication":{ "name":"DescribeApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeApplicationRequest"}, "output":{"shape":"DescribeApplicationResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Describes the application specified by the application ARN.

" }, "DescribeAssessment":{ "name":"DescribeAssessment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAssessmentRequest"}, "output":{"shape":"DescribeAssessmentResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Describes the assessment specified by the assessment ARN.

" }, "DescribeCrossAccountAccessRole":{ "name":"DescribeCrossAccountAccessRole", "http":{ "method":"POST", "requestUri":"/" }, "output":{"shape":"DescribeCrossAccountAccessRoleResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Describes the IAM role that enables Inspector to access your AWS account.

" }, "DescribeFinding":{ "name":"DescribeFinding", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFindingRequest"}, "output":{"shape":"DescribeFindingResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Describes the finding specified by the finding ARN.

" }, "DescribeResourceGroup":{ "name":"DescribeResourceGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeResourceGroupRequest"}, "output":{"shape":"DescribeResourceGroupResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Describes the resource group specified by the resource group ARN.

" }, "DescribeRulesPackage":{ "name":"DescribeRulesPackage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRulesPackageRequest"}, "output":{"shape":"DescribeRulesPackageResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Describes the rules package specified by the rules package ARN.

" }, "DescribeRun":{ "name":"DescribeRun", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRunRequest"}, "output":{"shape":"DescribeRunResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Describes the assessment run specified by the run ARN.

" }, "DetachAssessmentAndRulesPackage":{ "name":"DetachAssessmentAndRulesPackage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachAssessmentAndRulesPackageRequest"}, "output":{"shape":"DetachAssessmentAndRulesPackageResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Detaches the rules package specified by the rules package ARN from the assessment specified by the assessment ARN.

" }, "GetAssessmentTelemetry":{ "name":"GetAssessmentTelemetry", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAssessmentTelemetryRequest"}, "output":{"shape":"GetAssessmentTelemetryResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Returns the metadata about the telemetry (application behavioral data) for the assessment specified by the assessment ARN.

" }, "ListApplications":{ "name":"ListApplications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListApplicationsRequest"}, "output":{"shape":"ListApplicationsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists the ARNs of the applications within this AWS account. For more information about applications, see Inspector Applications.

" }, "ListAssessmentAgents":{ "name":"ListAssessmentAgents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAssessmentAgentsRequest"}, "output":{"shape":"ListAssessmentAgentsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Lists the agents of the assessment specified by the assessment ARN.

" }, "ListAssessments":{ "name":"ListAssessments", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAssessmentsRequest"}, "output":{"shape":"ListAssessmentsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Lists the assessments corresponding to applications specified by the applications' ARNs.

" }, "ListAttachedAssessments":{ "name":"ListAttachedAssessments", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAttachedAssessmentsRequest"}, "output":{"shape":"ListAttachedAssessmentsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Lists the assessments attached to the rules package specified by the rules package ARN.

" }, "ListAttachedRulesPackages":{ "name":"ListAttachedRulesPackages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAttachedRulesPackagesRequest"}, "output":{"shape":"ListAttachedRulesPackagesResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Lists the rules packages attached to the assessment specified by the assessment ARN.

" }, "ListFindings":{ "name":"ListFindings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListFindingsRequest"}, "output":{"shape":"ListFindingsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Lists findings generated by the assessment run specified by the run ARNs.

" }, "ListRulesPackages":{ "name":"ListRulesPackages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRulesPackagesRequest"}, "output":{"shape":"ListRulesPackagesResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists all available Inspector rules packages.

" }, "ListRuns":{ "name":"ListRuns", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRunsRequest"}, "output":{"shape":"ListRunsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Lists the assessment runs associated with the assessments specified by the assessment ARNs.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Lists all tags associated with a resource.

" }, "LocalizeText":{ "name":"LocalizeText", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"LocalizeTextRequest"}, "output":{"shape":"LocalizeTextResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Translates a textual identifier into a user-readable text in a specified locale.

" }, "PreviewAgentsForResourceGroup":{ "name":"PreviewAgentsForResourceGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PreviewAgentsForResourceGroupRequest"}, "output":{"shape":"PreviewAgentsForResourceGroupResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"}, {"shape":"InvalidCrossAccountRoleException"} ], "documentation":"

Previews the agents installed on the EC2 instances that are included in the application created with the specified resource group.

" }, "RegisterCrossAccountAccessRole":{ "name":"RegisterCrossAccountAccessRole", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterCrossAccountAccessRoleRequest"}, "output":{"shape":"RegisterCrossAccountAccessRoleResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidCrossAccountRoleException"} ], "documentation":"

Register the role that Inspector uses to list your EC2 instances during the assessment.

" }, "RemoveAttributesFromFindings":{ "name":"RemoveAttributesFromFindings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveAttributesFromFindingsRequest"}, "output":{"shape":"RemoveAttributesFromFindingsResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Removes the entire attribute (key and value pair) from the findings specified by the finding ARNs where an attribute with the specified key exists.

" }, "RunAssessment":{ "name":"RunAssessment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RunAssessmentRequest"}, "output":{"shape":"RunAssessmentResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Starts the analysis of the application’s behavior against selected rule packages for the assessment specified by the assessment ARN.

" }, "SetTagsForResource":{ "name":"SetTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetTagsForResourceRequest"}, "output":{"shape":"SetTagsForResourceResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Sets tags (key and value pairs) to the assessment specified by the assessment ARN.

" }, "StartDataCollection":{ "name":"StartDataCollection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartDataCollectionRequest"}, "output":{"shape":"StartDataCollectionResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"}, {"shape":"InvalidCrossAccountRoleException"} ], "documentation":"

Starts data collection for the assessment specified by the assessment ARN. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.

" }, "StopDataCollection":{ "name":"StopDataCollection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopDataCollectionRequest"}, "output":{"shape":"StopDataCollectionResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Stop data collection for the assessment specified by the assessment ARN.

" }, "UpdateApplication":{ "name":"UpdateApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateApplicationRequest"}, "output":{"shape":"UpdateApplicationResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Updates application specified by the application ARN.

" }, "UpdateAssessment":{ "name":"UpdateAssessment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAssessmentRequest"}, "output":{"shape":"UpdateAssessmentResponse"}, "errors":[ {"shape":"InternalException"}, {"shape":"InvalidInputException"}, {"shape":"AccessDeniedException"}, {"shape":"NoSuchEntityException"} ], "documentation":"

Updates the assessment specified by the assessment ARN.

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ }, "exception":true }, "AddAttributesToFindingsRequest":{ "type":"structure", "required":[ "findingArns", "attributes" ], "members":{ "findingArns":{ "shape":"ArnList", "documentation":"

The ARNs specifying the findings that you want to assign attributes to.

" }, "attributes":{ "shape":"AttributeList", "documentation":"

The array of attributes that you want to assign to specified findings.

" } } }, "AddAttributesToFindingsResponse":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Confirmation details of the action performed.

" } } }, "Agent":{ "type":"structure", "members":{ "agentId":{ "shape":"AgentId", "documentation":"

The EC2 instance ID where the agent is installed.

" }, "assessmentArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment that is associated with the agent.

" }, "agentHealth":{ "shape":"AgentHealth", "documentation":"

The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.

" }, "agentHealthCode":{ "shape":"AgentHealthCode", "documentation":"

The detailed health state of the agent. Values can be set to RUNNING, HEALTHY, UNHEALTHY, UNKNOWN, BLACKLISTED, SHUTDOWN, THROTTLED.

" }, "agentHealthDetails":{ "shape":"AgentHealthDetails", "documentation":"

The description for the agent health code.

" }, "autoScalingGroup":{ "shape":"AutoScalingGroup", "documentation":"

This data type property is currently not used.

" }, "accountId":{ "shape":"AwsAccount", "documentation":"

AWS account of the EC2 instance where the agent is installed.

" }, "telemetry":{ "shape":"TelemetryList", "documentation":"

The Inspector application data metrics collected by the agent.

" } }, "documentation":"

Contains information about an Inspector agent. This data type is used as a response element in the ListAssessmentAgents action.

" }, "AgentHealth":{"type":"string"}, "AgentHealthCode":{"type":"string"}, "AgentHealthDetails":{"type":"string"}, "AgentHealthList":{ "type":"list", "member":{"shape":"AgentHealth"} }, "AgentId":{"type":"string"}, "AgentList":{ "type":"list", "member":{"shape":"Agent"} }, "AgentPreview":{ "type":"structure", "members":{ "agentId":{ "shape":"AgentId", "documentation":"

The id of the EC2 instance where the agent is intalled.

" }, "autoScalingGroup":{ "shape":"AutoScalingGroup", "documentation":"

The autoscaling group for the EC2 instance where the agent is installed.

" } }, "documentation":"

This data type is used as a response element in the PreviewAgentsForResourceGroup action.

" }, "AgentPreviewList":{ "type":"list", "member":{"shape":"AgentPreview"} }, "AgentsFilter":{ "type":"structure", "members":{ "agentHealthList":{ "shape":"AgentHealthList", "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the agentHealth property of the Agent data type.

" } }, "documentation":"

This data type is used as a response element in the ListAssessmentAgents action.

" }, "Application":{ "type":"structure", "members":{ "applicationArn":{ "shape":"Arn", "documentation":"

The ARN specifying the Inspector application.

" }, "applicationName":{ "shape":"Name", "documentation":"

The name of the Inspector application.

" }, "resourceGroupArn":{ "shape":"Arn", "documentation":"

The ARN specifying the resource group that is associated with the application.

" } }, "documentation":"

Contains information about an Inspector application.

This data type is used as the response element in the DescribeApplication action.

" }, "ApplicationsFilter":{ "type":"structure", "members":{ "applicationNamePatterns":{ "shape":"NamePatternList", "documentation":"

For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the applicationName property of the Application data type.

" } }, "documentation":"

This data type is used as the request parameter in the ListApplications action.

" }, "Arn":{"type":"string"}, "ArnList":{ "type":"list", "member":{"shape":"Arn"} }, "Assessment":{ "type":"structure", "members":{ "assessmentArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment.

" }, "assessmentName":{ "shape":"Name", "documentation":"

The name of the assessment.

" }, "applicationArn":{ "shape":"Arn", "documentation":"

The ARN of the application that corresponds to this assessment.

" }, "assessmentState":{ "shape":"AssessmentState", "documentation":"

The state of the assessment. Values can be set to Created, Collecting Data, Stopping, and Completed.

" }, "failureMessage":{ "shape":"FailureMessage", "documentation":"

This data type property is not currently used.

" }, "dataCollected":{ "shape":"Bool", "documentation":"

Boolean value (true or false) specifying whether the data collection process is completed.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

The assessment start time.

" }, "endTime":{ "shape":"Timestamp", "documentation":"

The assessment end time.

" }, "durationInSeconds":{ "shape":"Duration", "documentation":"

The assessment duration in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).

" }, "userAttributesForFindings":{ "shape":"AttributeList", "documentation":"

The user-defined attributes that are assigned to every generated finding.

" } }, "documentation":"

Contains information about an Inspector assessment.

This data type is used as the response element in the DescribeAssessment action.

" }, "AssessmentState":{"type":"string"}, "AssessmentStateList":{ "type":"list", "member":{"shape":"AssessmentState"} }, "AssessmentsFilter":{ "type":"structure", "members":{ "assessmentNamePatterns":{ "shape":"NamePatternList", "documentation":"

For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the assessmentName property of the Assessment data type.

" }, "assessmentStates":{ "shape":"AssessmentStateList", "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the assessmentState property of the Assessment data type.

" }, "dataCollected":{ "shape":"Bool", "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the dataCollected property of the Assessment data type.

" }, "startTimeRange":{ "shape":"TimestampRange", "documentation":"

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the startTime property of the Assessment data type.

" }, "endTimeRange":{ "shape":"TimestampRange", "documentation":"

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the endTime property of the Assessment data type.

" }, "durationRange":{ "shape":"DurationRange", "documentation":"

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the Assessment data type.

" } }, "documentation":"

This data type is used as the request parameter in the ListAssessments and ListAttachedAssessments actions.

" }, "AttachAssessmentAndRulesPackageRequest":{ "type":"structure", "required":[ "assessmentArn", "rulesPackageArn" ], "members":{ "assessmentArn":{ "shape":"Arn", "documentation":"

The ARN specifying the assessment to which you want to attach a rules package.

" }, "rulesPackageArn":{ "shape":"Arn", "documentation":"

The ARN specifying the rules package that you want to attach to the assessment.

" } } }, "AttachAssessmentAndRulesPackageResponse":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Confirmation details of the action performed.

" } } }, "Attribute":{ "type":"structure", "members":{ "key":{ "shape":"AttributeKey", "documentation":"

The attribute key.

" }, "value":{ "shape":"AttributeValue", "documentation":"

The value assigned to the attribute key.

" } }, "documentation":"

This data type is used as a response element in the AddAttributesToFindings action and a request parameter in the CreateAssessment action.

" }, "AttributeKey":{"type":"string"}, "AttributeKeyList":{ "type":"list", "member":{"shape":"AttributeKey"} }, "AttributeList":{ "type":"list", "member":{"shape":"Attribute"} }, "AttributeValue":{"type":"string"}, "AutoScalingGroup":{"type":"string"}, "AwsAccount":{"type":"string"}, "Bool":{"type":"boolean"}, "CreateApplicationRequest":{ "type":"structure", "required":[ "applicationName", "resourceGroupArn" ], "members":{ "applicationName":{ "shape":"Name", "documentation":"

The user-defined name identifying the application that you want to create. The name must be unique within the AWS account.

" }, "resourceGroupArn":{ "shape":"Arn", "documentation":"

The ARN specifying the resource group that is used to create the application.

" } } }, "CreateApplicationResponse":{ "type":"structure", "members":{ "applicationArn":{ "shape":"Arn", "documentation":"

The ARN specifying the application that is created.

" } } }, "CreateAssessmentRequest":{ "type":"structure", "required":[ "applicationArn", "assessmentName", "durationInSeconds" ], "members":{ "applicationArn":{ "shape":"Arn", "documentation":"

The ARN specifying the application for which you want to create an assessment.

" }, "assessmentName":{ "shape":"Name", "documentation":"

The user-defined name identifying the assessment that you want to create. You can create several assessments for an application. The names of the assessments corresponding to a particular application must be unique.

" }, "durationInSeconds":{ "shape":"Duration", "documentation":"

The duration of the assessment in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).

" }, "userAttributesForFindings":{ "shape":"AttributeList", "documentation":"

The user-defined attributes that are assigned to every finding generated by running this assessment.

" } } }, "CreateAssessmentResponse":{ "type":"structure", "members":{ "assessmentArn":{ "shape":"Arn", "documentation":"

The ARN specifying the assessment that is created.

" } } }, "CreateResourceGroupRequest":{ "type":"structure", "required":["resourceGroupTags"], "members":{ "resourceGroupTags":{ "shape":"ResourceGroupTags", "documentation":"

A collection of keys and an array of possible values in JSON format.

For example, [{ \"key1\" : [\"Value1\",\"Value2\"]},{\"Key2\": [\"Value3\"]}]

" } } }, "CreateResourceGroupResponse":{ "type":"structure", "members":{ "resourceGroupArn":{ "shape":"Arn", "documentation":"

The ARN specifying the resource group that is created.

" } } }, "DeleteApplicationRequest":{ "type":"structure", "required":["applicationArn"], "members":{ "applicationArn":{ "shape":"Arn", "documentation":"

The ARN specifying the application that you want to delete.

" } } }, "DeleteApplicationResponse":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Confirmation details of the action performed.

" } } }, "DeleteAssessmentRequest":{ "type":"structure", "required":["assessmentArn"], "members":{ "assessmentArn":{ "shape":"Arn", "documentation":"

The ARN specifying the assessment that you want to delete.

" } } }, "DeleteAssessmentResponse":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Confirmation details of the action performed.

" } } }, "DeleteRunRequest":{ "type":"structure", "required":["runArn"], "members":{ "runArn":{ "shape":"Arn", "documentation":"

The ARN specifying the assessment run that you want to delete.

" } } }, "DeleteRunResponse":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Confirmation details of the action performed.

" } } }, "DescribeApplicationRequest":{ "type":"structure", "required":["applicationArn"], "members":{ "applicationArn":{ "shape":"Arn", "documentation":"

The ARN specifying the application that you want to describe.

" } } }, "DescribeApplicationResponse":{ "type":"structure", "members":{ "application":{ "shape":"Application", "documentation":"

Information about the application.

" } } }, "DescribeAssessmentRequest":{ "type":"structure", "required":["assessmentArn"], "members":{ "assessmentArn":{ "shape":"Arn", "documentation":"

The ARN specifying the assessment that you want to describe.

" } } }, "DescribeAssessmentResponse":{ "type":"structure", "members":{ "assessment":{ "shape":"Assessment", "documentation":"

Information about the assessment.

" } } }, "DescribeCrossAccountAccessRoleResponse":{ "type":"structure", "members":{ "roleArn":{ "shape":"Arn", "documentation":"

The ARN specifying the IAM role that Inspector uses to access your AWS account.

" }, "valid":{ "shape":"Bool", "documentation":"

A Boolean value that specifies whether the IAM role has the necessary policies attached to enable Inspector to access your AWS account.

" } } }, "DescribeFindingRequest":{ "type":"structure", "required":["findingArn"], "members":{ "findingArn":{ "shape":"Arn", "documentation":"

The ARN specifying the finding that you want to describe.

" } } }, "DescribeFindingResponse":{ "type":"structure", "members":{ "finding":{ "shape":"Finding", "documentation":"

Information about the finding.

" } } }, "DescribeResourceGroupRequest":{ "type":"structure", "required":["resourceGroupArn"], "members":{ "resourceGroupArn":{ "shape":"Arn", "documentation":"

The ARN specifying the resource group that you want to describe.

" } } }, "DescribeResourceGroupResponse":{ "type":"structure", "members":{ "resourceGroup":{ "shape":"ResourceGroup", "documentation":"

Information about the resource group.

" } } }, "DescribeRulesPackageRequest":{ "type":"structure", "required":["rulesPackageArn"], "members":{ "rulesPackageArn":{ "shape":"Arn", "documentation":"

The ARN specifying the rules package that you want to describe.

" } } }, "DescribeRulesPackageResponse":{ "type":"structure", "members":{ "rulesPackage":{ "shape":"RulesPackage", "documentation":"

Information about the rules package.

" } } }, "DescribeRunRequest":{ "type":"structure", "required":["runArn"], "members":{ "runArn":{ "shape":"Arn", "documentation":"

The ARN specifying the assessment run that you want to describe.

" } } }, "DescribeRunResponse":{ "type":"structure", "members":{ "run":{ "shape":"Run", "documentation":"

Information about the assessment run.

" } } }, "DetachAssessmentAndRulesPackageRequest":{ "type":"structure", "required":[ "assessmentArn", "rulesPackageArn" ], "members":{ "assessmentArn":{ "shape":"Arn", "documentation":"

The ARN specifying the assessment from which you want to detach a rules package.

" }, "rulesPackageArn":{ "shape":"Arn", "documentation":"

The ARN specifying the rules package that you want to detach from the assessment.

" } } }, "DetachAssessmentAndRulesPackageResponse":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Confirmation details of the action performed.

" } } }, "Duration":{"type":"integer"}, "DurationRange":{ "type":"structure", "members":{ "minimum":{ "shape":"Duration", "documentation":"

The minimum value of the duration range. Must be greater than zero.

" }, "maximum":{ "shape":"Duration", "documentation":"

The maximum value of the duration range. Must be less than or equal to 604800 seconds (1 week).

" } }, "documentation":"

This data type is used in the AssessmentsFilter data type.

" }, "FailureMessage":{"type":"string"}, "Finding":{ "type":"structure", "members":{ "findingArn":{ "shape":"Arn", "documentation":"

The ARN specifying the finding.

" }, "runArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment run that generated the finding.

" }, "rulesPackageArn":{ "shape":"Arn", "documentation":"

The ARN of the rules package that is used to generate the finding.

" }, "ruleName":{ "shape":"Name", "documentation":"

The rule name that is used to generate the finding.

" }, "agentId":{ "shape":"AgentId", "documentation":"

The EC2 instance ID where the agent is installed that is used during the assessment that generates the finding.

" }, "autoScalingGroup":{ "shape":"AutoScalingGroup", "documentation":"

The autoscaling group of the EC2 instance where the agent is installed that is used during the assessment that generates the finding.

" }, "severity":{ "shape":"Severity", "documentation":"

The finding severity. Values can be set to High, Medium, Low, and Informational.

" }, "finding":{ "shape":"LocalizedText", "documentation":"

A short description that identifies the finding.

" }, "description":{ "shape":"LocalizedText", "documentation":"

The description of the finding.

" }, "recommendation":{ "shape":"LocalizedText", "documentation":"

The recommendation for the finding.

" }, "attributes":{ "shape":"AttributeList", "documentation":"

The system-defined attributes for the finding.

" }, "userAttributes":{ "shape":"AttributeList", "documentation":"

The user-defined attributes that are assigned to the finding.

" } }, "documentation":"

Contains information about an Inspector finding.

This data type is used as the response element in the DescribeFinding action.

" }, "FindingsFilter":{ "type":"structure", "members":{ "rulesPackageArns":{ "shape":"ArnList", "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the rulesPackageArn property of the Finding data type.

" }, "ruleNames":{ "shape":"NameList", "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the ruleName property of the Finding data type.

" }, "severities":{ "shape":"SeverityList", "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the severity property of the Finding data type.

" }, "attributes":{ "shape":"AttributeList", "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the attributes property of the Finding data type.

" }, "userAttributes":{ "shape":"AttributeList", "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the userAttributes property of the Finding data type.

" } }, "documentation":"

This data type is used as a request parameter in the ListFindings action.

" }, "GetAssessmentTelemetryRequest":{ "type":"structure", "required":["assessmentArn"], "members":{ "assessmentArn":{ "shape":"Arn", "documentation":"

The ARN specifying the assessment the telemetry of which you want to obtain.

" } } }, "GetAssessmentTelemetryResponse":{ "type":"structure", "members":{ "telemetry":{ "shape":"TelemetryList", "documentation":"

Telemetry details.

" } } }, "Integer":{"type":"integer"}, "InternalException":{ "type":"structure", "members":{ }, "exception":true, "fault":true }, "InvalidCrossAccountRoleException":{ "type":"structure", "members":{ }, "exception":true }, "InvalidInputException":{ "type":"structure", "members":{ }, "exception":true }, "ListApplicationsRequest":{ "type":"structure", "members":{ "filter":{ "shape":"ApplicationsFilter", "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListApplications action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" }, "maxResults":{ "shape":"Integer", "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" } } }, "ListApplicationsResponse":{ "type":"structure", "members":{ "applicationArnList":{ "shape":"ArnList", "documentation":"

A list of ARNs specifying the applications returned by the action.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" } } }, "ListAssessmentAgentsRequest":{ "type":"structure", "required":["assessmentArn"], "members":{ "assessmentArn":{ "shape":"Arn", "documentation":"

The ARN specifying the assessment whose agents you want to list.

" }, "filter":{ "shape":"AgentsFilter", "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListAssessmentAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" }, "maxResults":{ "shape":"Integer", "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" } } }, "ListAssessmentAgentsResponse":{ "type":"structure", "members":{ "agentList":{ "shape":"AgentList", "documentation":"

A list of ARNs specifying the agents returned by the action.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" } } }, "ListAssessmentsRequest":{ "type":"structure", "members":{ "applicationArns":{ "shape":"ArnList", "documentation":"

A list of ARNs specifying the applications the assessments of which you want to list.

" }, "filter":{ "shape":"AssessmentsFilter", "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListAssessments action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" }, "maxResults":{ "shape":"Integer", "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" } } }, "ListAssessmentsResponse":{ "type":"structure", "members":{ "assessmentArnList":{ "shape":"ArnList", "documentation":"

A list of ARNs specifying the assessments returned by the action.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" } } }, "ListAttachedAssessmentsRequest":{ "type":"structure", "required":["rulesPackageArn"], "members":{ "rulesPackageArn":{ "shape":"Arn", "documentation":"

The ARN specifying the rules package whose assessments you want to list.

" }, "filter":{ "shape":"AssessmentsFilter", "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListAttachedAssessments action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" }, "maxResults":{ "shape":"Integer", "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" } } }, "ListAttachedAssessmentsResponse":{ "type":"structure", "members":{ "assessmentArnList":{ "shape":"ArnList", "documentation":"

A list of ARNs specifying the assessments returned by the action.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" } } }, "ListAttachedRulesPackagesRequest":{ "type":"structure", "required":["assessmentArn"], "members":{ "assessmentArn":{ "shape":"Arn", "documentation":"

The ARN specifying the assessment whose rules packages you want to list.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListAttachedRulesPackages action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" }, "maxResults":{ "shape":"Integer", "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" } } }, "ListAttachedRulesPackagesResponse":{ "type":"structure", "members":{ "rulesPackageArnList":{ "shape":"ArnList", "documentation":"

A list of ARNs specifying the rules packages returned by the action.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" } } }, "ListFindingsRequest":{ "type":"structure", "members":{ "runArns":{ "shape":"ArnList", "documentation":"

The ARNs of the assessment runs that generate the findings that you want to list.

" }, "filter":{ "shape":"FindingsFilter", "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListFindings action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" }, "maxResults":{ "shape":"Integer", "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" } } }, "ListFindingsResponse":{ "type":"structure", "members":{ "findingArnList":{ "shape":"ArnList", "documentation":"

A list of ARNs specifying the findings returned by the action.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" } } }, "ListRulesPackagesRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListRulesPackages action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" }, "maxResults":{ "shape":"Integer", "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" } } }, "ListRulesPackagesResponse":{ "type":"structure", "members":{ "rulesPackageArnList":{ "shape":"ArnList", "documentation":"

The list of ARNs specifying the rules packages returned by the action.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" } } }, "ListRunsRequest":{ "type":"structure", "members":{ "assessmentArns":{ "shape":"ArnList", "documentation":"

The ARNs specifying the assessments whose runs you want to list.

" }, "filter":{ "shape":"RunsFilter", "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListRuns action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" }, "maxResults":{ "shape":"Integer", "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" } } }, "ListRunsResponse":{ "type":"structure", "members":{ "runArnList":{ "shape":"ArnList", "documentation":"

A list of ARNs specifying the assessment runs returned by the action.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

The ARN specifying the resource whose tags you want to list.

" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tagList":{ "shape":"TagList", "documentation":"

A collection of key and value pairs.

" } } }, "Locale":{"type":"string"}, "LocalizeTextRequest":{ "type":"structure", "required":[ "localizedTexts", "locale" ], "members":{ "localizedTexts":{ "shape":"LocalizedTextList", "documentation":"

A list of textual identifiers.

" }, "locale":{ "shape":"Locale", "documentation":"

The locale that you want to translate a textual identifier into.

" } } }, "LocalizeTextResponse":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Confirmation details of the action performed.

" }, "results":{ "shape":"TextList", "documentation":"

The resulting list of user-readable texts.

" } } }, "LocalizedFacility":{"type":"string"}, "LocalizedText":{ "type":"structure", "members":{ "key":{ "shape":"LocalizedTextKey", "documentation":"

The facility and id properties of the LocalizedTextKey data type.

" }, "parameters":{ "shape":"ParameterList", "documentation":"

Values for the dynamic elements of the string specified by the textual identifier.

" } }, "documentation":"

The textual identifier. This data type is used as the request parameter in the LocalizeText action.

" }, "LocalizedTextId":{"type":"string"}, "LocalizedTextKey":{ "type":"structure", "members":{ "facility":{ "shape":"LocalizedFacility", "documentation":"

The module response source of the text.

" }, "id":{ "shape":"LocalizedTextId", "documentation":"

Part of the module response source of the text.

" } }, "documentation":"

This data type is used in the LocalizedText data type.

" }, "LocalizedTextList":{ "type":"list", "member":{"shape":"LocalizedText"} }, "Long":{"type":"long"}, "Message":{"type":"string"}, "MessageType":{"type":"string"}, "MessageTypeTelemetry":{ "type":"structure", "members":{ "messageType":{ "shape":"MessageType", "documentation":"

A specific type of behavioral data that is collected by the agent.

" }, "count":{ "shape":"Long", "documentation":"

The number of times that the behavioral data is collected by the agent during an assessment.

" }, "dataSize":{ "shape":"Long", "documentation":"

The total size of the behavioral data that is collected by the agent during an assessment.

" } }, "documentation":"

This data type is used in the Telemetry data type.

This is metadata about the behavioral data collected by the Inspector agent on your EC2 instances during an assessment and passed to the Inspector service for analysis.

" }, "MessageTypeTelemetryList":{ "type":"list", "member":{"shape":"MessageTypeTelemetry"} }, "Name":{"type":"string"}, "NameList":{ "type":"list", "member":{"shape":"Name"} }, "NamePattern":{"type":"string"}, "NamePatternList":{ "type":"list", "member":{"shape":"NamePattern"} }, "NoSuchEntityException":{ "type":"structure", "members":{ }, "exception":true }, "OperationInProgressException":{ "type":"structure", "members":{ }, "exception":true }, "PaginationToken":{"type":"string"}, "Parameter":{ "type":"structure", "members":{ "name":{ "shape":"ParameterName", "documentation":"

The name of the variable that is being replaced.

" }, "value":{ "shape":"ParameterValue", "documentation":"

The value assigned to the variable that is being replaced.

" } }, "documentation":"

This data type is used in the LocalizedText data type.

" }, "ParameterList":{ "type":"list", "member":{"shape":"Parameter"} }, "ParameterName":{"type":"string"}, "ParameterValue":{"type":"string"}, "PreviewAgentsForResourceGroupRequest":{ "type":"structure", "required":["resourceGroupArn"], "members":{ "resourceGroupArn":{ "shape":"Arn", "documentation":"

The ARN of the resource group that is used to create an application.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the PreviewAgentsForResourceGroup action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" }, "maxResults":{ "shape":"Integer", "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" } } }, "PreviewAgentsForResourceGroupResponse":{ "type":"structure", "members":{ "agentPreviewList":{ "shape":"AgentPreviewList", "documentation":"

The resulting list of agents.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" } } }, "RegisterCrossAccountAccessRoleRequest":{ "type":"structure", "required":["roleArn"], "members":{ "roleArn":{ "shape":"Arn", "documentation":"The ARN of the IAM role that Inspector uses to list your EC2 instances during the assessment." } } }, "RegisterCrossAccountAccessRoleResponse":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Confirmation details of the action performed.

" } } }, "RemoveAttributesFromFindingsRequest":{ "type":"structure", "required":[ "findingArns", "attributeKeys" ], "members":{ "findingArns":{ "shape":"ArnList", "documentation":"

The ARNs specifying the findings that you want to remove attributes from.

" }, "attributeKeys":{ "shape":"AttributeKeyList", "documentation":"

The array of attribute keys that you want to remove from specified findings.

" } } }, "RemoveAttributesFromFindingsResponse":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Confirmation details of the action performed.

" } } }, "ResourceGroup":{ "type":"structure", "members":{ "resourceGroupArn":{ "shape":"Arn", "documentation":"

The ARN of the resource group.

" }, "resourceGroupTags":{ "shape":"ResourceGroupTags", "documentation":"

The tags (key and value pairs) of the resource group.

This data type property is used in the CreateResourceGroup action.

A collection of keys and an array of possible values in JSON format.

For example, [{ \"key1\" : [\"Value1\",\"Value2\"]},{\"Key2\": [\"Value3\"]}]

" } }, "documentation":"

Contains information about a resource group. The resource group defines a set of tags that, when queried, identify the AWS resources that comprise the application.

This data type is used as the response element in the DescribeResourceGroup action.

" }, "ResourceGroupTags":{"type":"string"}, "RulesPackage":{ "type":"structure", "members":{ "rulesPackageArn":{ "shape":"Arn", "documentation":"

The ARN of the rules package.

" }, "rulesPackageName":{ "shape":"Name", "documentation":"

The name of the rules package.

" }, "version":{ "shape":"Version", "documentation":"

The version id of the rules package.

" }, "provider":{ "shape":"Name", "documentation":"

The provider of the rules package.

" }, "description":{ "shape":"LocalizedText", "documentation":"

The description of the rules package.

" } }, "documentation":"

Contains information about an Inspector rules package.

This data type is used as the response element in the DescribeRulesPackage action.

" }, "Run":{ "type":"structure", "members":{ "runArn":{ "shape":"Arn", "documentation":"

The ARN of the run.

" }, "runName":{ "shape":"Name", "documentation":"

The auto-generated name for the run.

" }, "assessmentArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment that is associated with the run.

" }, "runState":{ "shape":"RunState", "documentation":"

The state of the run. Values can be set to DataCollectionComplete, EvaluatingPolicies, EvaluatingPoliciesErrorCanRetry, Completed, Failed, TombStoned.

" }, "rulesPackages":{ "shape":"ArnList", "documentation":"

Rules packages selected for the run of the assessment.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

Run creation time that corresponds to the data collection completion time or failure.

" }, "completionTime":{ "shape":"Timestamp", "documentation":"

Run completion time that corresponds to the rules packages evaluation completion time or failure.

" } }, "documentation":"

A snapshot of an Inspector assessment that contains the assessment's findings.

This data type is used as the response element in the DescribeRun action.

" }, "RunAssessmentRequest":{ "type":"structure", "required":[ "assessmentArn", "runName" ], "members":{ "assessmentArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment that you want to run.

" }, "runName":{ "shape":"Name", "documentation":"

A name specifying the run of the assessment.

" } } }, "RunAssessmentResponse":{ "type":"structure", "members":{ "runArn":{ "shape":"Arn", "documentation":"

The ARN specifying the run of the assessment.

" } } }, "RunState":{"type":"string"}, "RunStateList":{ "type":"list", "member":{"shape":"RunState"} }, "RunsFilter":{ "type":"structure", "members":{ "runNamePatterns":{ "shape":"NamePatternList", "documentation":"

For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the runName property of the Run data type.

" }, "runStates":{ "shape":"RunStateList", "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the runState property of the Run data type.

" }, "rulesPackages":{ "shape":"ArnList", "documentation":"

For a record to match a filter, the value specified for this data type property must match a list of values of the rulesPackages property of the Run data type.

" }, "creationTime":{ "shape":"TimestampRange", "documentation":"

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the creationTime property of the Run data type.

" }, "completionTime":{ "shape":"TimestampRange", "documentation":"

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the completionTime property of the Run data type.

" } }, "documentation":"

This data type is used as the request parameter in the ListRuns action.

" }, "SetTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], "members":{ "resourceArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment that you want to set tags to.

" }, "tags":{ "shape":"TagList", "documentation":"

A collection of key and value pairs that you want to set to an assessment.

" } } }, "SetTagsForResourceResponse":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Confirmation details of the action performed.

" } } }, "Severity":{"type":"string"}, "SeverityList":{ "type":"list", "member":{"shape":"Severity"} }, "StartDataCollectionRequest":{ "type":"structure", "required":["assessmentArn"], "members":{ "assessmentArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment for which you want to start the data collection process.

" } } }, "StartDataCollectionResponse":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Confirmation details of the action performed.

" } } }, "StopDataCollectionRequest":{ "type":"structure", "required":["assessmentArn"], "members":{ "assessmentArn":{ "shape":"Arn", "documentation":"

The ARN of the assessment for which you want to stop the data collection process.

" } } }, "StopDataCollectionResponse":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Confirmation details of the action performed.

" } } }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"TagKey", "documentation":"

The tag key.

" }, "Value":{ "shape":"TagValue", "documentation":"

The value assigned to a tag key.

" } }, "documentation":"

A key and value pair.

This data type is used as a request parameter in the SetTagsForResource action and a response element in the ListTagsForResource action.

" }, "TagKey":{"type":"string"}, "TagList":{ "type":"list", "member":{"shape":"Tag"} }, "TagValue":{"type":"string"}, "Telemetry":{ "type":"structure", "members":{ "status":{ "shape":"TelemetryStatus", "documentation":"

The category of the individual metrics that together constitute the telemetry that Inspector received from the agent.

" }, "messageTypeTelemetries":{ "shape":"MessageTypeTelemetryList", "documentation":"

Counts of individual metrics received by Inspector from the agent.

" } }, "documentation":"

The metadata about the Inspector application data metrics collected by the agent.

This data type is used as the response element in the GetAssessmentTelemetry action.

" }, "TelemetryList":{ "type":"list", "member":{"shape":"Telemetry"} }, "TelemetryStatus":{"type":"string"}, "Text":{"type":"string"}, "TextList":{ "type":"list", "member":{"shape":"Text"} }, "Timestamp":{"type":"timestamp"}, "TimestampRange":{ "type":"structure", "members":{ "minimum":{ "shape":"Timestamp", "documentation":"

The minimum value of the timestamp range.

" }, "maximum":{ "shape":"Timestamp", "documentation":"

The maximum value of the timestamp range.

" } }, "documentation":"

This data type is used in the AssessmentsFilter and RunsFilter data types.

" }, "UpdateApplicationRequest":{ "type":"structure", "required":[ "applicationArn", "applicationName", "resourceGroupArn" ], "members":{ "applicationArn":{ "shape":"Arn", "documentation":"

Application ARN that you want to update.

" }, "applicationName":{ "shape":"Name", "documentation":"

Application name that you want to update.

" }, "resourceGroupArn":{ "shape":"Arn", "documentation":"

The resource group ARN that you want to update.

" } } }, "UpdateApplicationResponse":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Confirmation details of the action performed.

" } } }, "UpdateAssessmentRequest":{ "type":"structure", "required":[ "assessmentArn", "assessmentName", "durationInSeconds" ], "members":{ "assessmentArn":{ "shape":"Arn", "documentation":"

Asessment ARN that you want to update.

" }, "assessmentName":{ "shape":"Name", "documentation":"

Assessment name that you want to update.

" }, "durationInSeconds":{ "shape":"Duration", "documentation":"

Assessment duration in seconds that you want to update. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).

" } } }, "UpdateAssessmentResponse":{ "type":"structure", "members":{ "message":{ "shape":"Message", "documentation":"

Confirmation details of the action performed.

" } } }, "Version":{"type":"string"} }, "documentation":"Amazon Inspector

Amazon Inspector enables you to analyze the behavior of the applications you run in AWS and to identify potential security issues. For more information, see Amazon Inspector User Guide.

" } botocore-1.5.7/botocore/data/health/0000777454262600001440000000000013042511307020400 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/health/2016-08-04/0000777454262600001440000000000013042511307021436 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/health/2016-08-04/paginators-1.json0000666454262600001440000000130713042511306024636 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeAffectedEntities": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", "result_key": "entities" }, "DescribeEventAggregates": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", "result_key": "eventAggregates" }, "DescribeEvents": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", "result_key": "events" }, "DescribeEventTypes": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", "result_key": "eventTypes" } } } botocore-1.5.7/botocore/data/health/2016-08-04/service-2.json0000666454262600001440000010422013042511306024126 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-08-04", "endpointPrefix":"health", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"AWSHealth", "serviceFullName":"AWS Health APIs and Notifications", "signatureVersion":"v4", "targetPrefix":"AWSHealth_20160804", "uid":"health-2016-08-04" }, "operations":{ "DescribeAffectedEntities":{ "name":"DescribeAffectedEntities", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAffectedEntitiesRequest"}, "output":{"shape":"DescribeAffectedEntitiesResponse"}, "errors":[ {"shape":"InvalidPaginationToken"}, {"shape":"UnsupportedLocale"} ], "documentation":"

Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.

At least one event ARN is required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.

", "idempotent":true }, "DescribeEntityAggregates":{ "name":"DescribeEntityAggregates", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEntityAggregatesRequest"}, "output":{"shape":"DescribeEntityAggregatesResponse"}, "documentation":"

Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned.

", "idempotent":true }, "DescribeEventAggregates":{ "name":"DescribeEventAggregates", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventAggregatesRequest"}, "output":{"shape":"DescribeEventAggregatesResponse"}, "errors":[ {"shape":"InvalidPaginationToken"} ], "documentation":"

Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.

", "idempotent":true }, "DescribeEventDetails":{ "name":"DescribeEventDetails", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventDetailsRequest"}, "output":{"shape":"DescribeEventDetailsResponse"}, "errors":[ {"shape":"UnsupportedLocale"} ], "documentation":"

Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntities operation.

If a specified event cannot be retrieved, an error message is returned for that event.

", "idempotent":true }, "DescribeEventTypes":{ "name":"DescribeEventTypes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventTypesRequest"}, "output":{"shape":"DescribeEventTypesResponse"}, "errors":[ {"shape":"InvalidPaginationToken"}, {"shape":"UnsupportedLocale"} ], "documentation":"

Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.

", "idempotent":true }, "DescribeEvents":{ "name":"DescribeEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventsRequest"}, "output":{"shape":"DescribeEventsResponse"}, "errors":[ {"shape":"InvalidPaginationToken"}, {"shape":"UnsupportedLocale"} ], "documentation":"

Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.

If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent.

", "idempotent":true } }, "shapes":{ "AffectedEntity":{ "type":"structure", "members":{ "entityArn":{ "shape":"entityArn", "documentation":"

The unique identifier for the entity. Format: arn:aws:health:entity-region:aws-account:entity/entity-id . Example: arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K

" }, "eventArn":{ "shape":"eventArn", "documentation":"

The unique identifier for the event. Format: arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID . Example: arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331

" }, "entityValue":{ "shape":"entityValue", "documentation":"

The ID of the affected entity.

" }, "awsAccountId":{ "shape":"accountId", "documentation":"

The 12-digit AWS account number that contains the affected entity.

" }, "lastUpdatedTime":{ "shape":"timestamp", "documentation":"

The most recent time that the entity was updated.

" }, "statusCode":{ "shape":"entityStatusCode", "documentation":"

The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, and UNKNOWN.

" }, "tags":{ "shape":"tagSet", "documentation":"

A map of entity tags attached to the affected entity.

" } }, "documentation":"

Information about an entity that is affected by a Health event.

" }, "DateTimeRange":{ "type":"structure", "members":{ "from":{ "shape":"timestamp", "documentation":"

The starting date and time of a time range.

" }, "to":{ "shape":"timestamp", "documentation":"

The ending date and time of a time range.

" } }, "documentation":"

A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from. If from is not set and to is set: match items where the timestamp value is equal to or before to.

" }, "DescribeAffectedEntitiesRequest":{ "type":"structure", "required":["filter"], "members":{ "filter":{ "shape":"EntityFilter", "documentation":"

Values to narrow the results returned. At least one event ARN is required.

" }, "locale":{ "shape":"locale", "documentation":"

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

" }, "nextToken":{ "shape":"nextToken", "documentation":"

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" }, "maxResults":{ "shape":"maxResults", "documentation":"

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" } } }, "DescribeAffectedEntitiesResponse":{ "type":"structure", "members":{ "entities":{ "shape":"EntityList", "documentation":"

The entities that match the filter criteria.

" }, "nextToken":{ "shape":"nextToken", "documentation":"

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" } } }, "DescribeEntityAggregatesRequest":{ "type":"structure", "members":{ "eventArns":{ "shape":"EventArnsList", "documentation":"

A list of event ARNs (unique identifiers). For example: \"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331\", \"arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz\"

" } } }, "DescribeEntityAggregatesResponse":{ "type":"structure", "members":{ "entityAggregates":{ "shape":"EntityAggregateList", "documentation":"

The number of entities that are affected by each of the specified events.

" } } }, "DescribeEventAggregatesRequest":{ "type":"structure", "required":["aggregateField"], "members":{ "filter":{ "shape":"EventFilter", "documentation":"

Values to narrow the results returned.

" }, "aggregateField":{ "shape":"eventAggregateField", "documentation":"

The only currently supported value is eventTypeCategory.

" }, "maxResults":{ "shape":"maxResults", "documentation":"

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" }, "nextToken":{ "shape":"nextToken", "documentation":"

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" } } }, "DescribeEventAggregatesResponse":{ "type":"structure", "members":{ "eventAggregates":{ "shape":"EventAggregateList", "documentation":"

The number of events in each category that meet the optional filter criteria.

" }, "nextToken":{ "shape":"nextToken", "documentation":"

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" } } }, "DescribeEventDetailsFailedSet":{ "type":"list", "member":{"shape":"EventDetailsErrorItem"} }, "DescribeEventDetailsRequest":{ "type":"structure", "required":["eventArns"], "members":{ "eventArns":{ "shape":"eventArnList", "documentation":"

A list of event ARNs (unique identifiers). For example: \"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331\", \"arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz\"

" }, "locale":{ "shape":"locale", "documentation":"

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

" } } }, "DescribeEventDetailsResponse":{ "type":"structure", "members":{ "successfulSet":{ "shape":"DescribeEventDetailsSuccessfulSet", "documentation":"

Information about the events that could be retrieved.

" }, "failedSet":{ "shape":"DescribeEventDetailsFailedSet", "documentation":"

Error messages for any events that could not be retrieved.

" } } }, "DescribeEventDetailsSuccessfulSet":{ "type":"list", "member":{"shape":"EventDetails"} }, "DescribeEventTypesRequest":{ "type":"structure", "members":{ "filter":{ "shape":"EventTypeFilter", "documentation":"

Values to narrow the results returned.

" }, "locale":{ "shape":"locale", "documentation":"

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

" }, "nextToken":{ "shape":"nextToken", "documentation":"

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" }, "maxResults":{ "shape":"maxResults", "documentation":"

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" } } }, "DescribeEventTypesResponse":{ "type":"structure", "members":{ "eventTypes":{ "shape":"EventTypeList", "documentation":"

A list of event types that match the filter criteria. Event types have a category (issue, accountNotification, or scheduledChange), a service (for example, EC2, RDS, DATAPIPELINE, BILLING), and a code (in the format AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT).

" }, "nextToken":{ "shape":"nextToken", "documentation":"

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" } } }, "DescribeEventsRequest":{ "type":"structure", "members":{ "filter":{ "shape":"EventFilter", "documentation":"

Values to narrow the results returned.

" }, "nextToken":{ "shape":"nextToken", "documentation":"

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" }, "maxResults":{ "shape":"maxResults", "documentation":"

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" }, "locale":{ "shape":"locale", "documentation":"

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

" } } }, "DescribeEventsResponse":{ "type":"structure", "members":{ "events":{ "shape":"EventList", "documentation":"

The events that match the specified filter criteria.

" }, "nextToken":{ "shape":"nextToken", "documentation":"

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" } } }, "EntityAggregate":{ "type":"structure", "members":{ "eventArn":{ "shape":"eventArn", "documentation":"

The unique identifier for the event. Format: arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID . Example: arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331

" }, "count":{ "shape":"count", "documentation":"

The number entities that match the criteria for the specified events.

" } }, "documentation":"

The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.

" }, "EntityAggregateList":{ "type":"list", "member":{"shape":"EntityAggregate"} }, "EntityFilter":{ "type":"structure", "required":["eventArns"], "members":{ "eventArns":{ "shape":"eventArnList", "documentation":"

A list of event ARNs (unique identifiers). For example: \"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331\", \"arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz\"

" }, "entityArns":{ "shape":"entityArnList", "documentation":"

A list of entity ARNs (unique identifiers).

" }, "entityValues":{ "shape":"entityValueList", "documentation":"

A list of IDs for affected entities.

" }, "lastUpdatedTimes":{ "shape":"dateTimeRangeList", "documentation":"

A list of the most recent dates and times that the entity was updated.

" }, "tags":{ "shape":"tagFilter", "documentation":"

A map of entity tags attached to the affected entity.

" }, "statusCodes":{ "shape":"entityStatusCodeList", "documentation":"

A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN).

" } }, "documentation":"

The values to use to filter results from the DescribeAffectedEntities operation.

" }, "EntityList":{ "type":"list", "member":{"shape":"AffectedEntity"} }, "Event":{ "type":"structure", "members":{ "arn":{ "shape":"eventArn", "documentation":"

The unique identifier for the event. Format: arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID . Example: arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331

" }, "service":{ "shape":"service", "documentation":"

The AWS service that is affected by the event. For example, EC2, RDS.

" }, "eventTypeCode":{ "shape":"eventTypeCode", "documentation":"

The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

" }, "eventTypeCategory":{ "shape":"eventTypeCategory", "documentation":"

The

" }, "region":{ "shape":"region", "documentation":"

The AWS region name of the event.

" }, "availabilityZone":{ "shape":"availabilityZone", "documentation":"

The AWS Availability Zone of the event. For example, us-east-1a.

" }, "startTime":{ "shape":"timestamp", "documentation":"

The date and time that the event began.

" }, "endTime":{ "shape":"timestamp", "documentation":"

The date and time that the event ended.

" }, "lastUpdatedTime":{ "shape":"timestamp", "documentation":"

The most recent date and time that the event was updated.

" }, "statusCode":{ "shape":"eventStatusCode", "documentation":"

The most recent status of the event. Possible values are open, closed, and upcoming.

" } }, "documentation":"

Summary information about an event, returned by the DescribeEvents operation. The DescribeEventDetails operation also returns this information, as well as the EventDescription and additional event metadata.

" }, "EventAggregate":{ "type":"structure", "members":{ "aggregateValue":{ "shape":"aggregateValue", "documentation":"

The issue type for the associated count.

" }, "count":{ "shape":"count", "documentation":"

The number of events of the associated issue type.

" } }, "documentation":"

The number of events of each issue type. Returned by the DescribeEventAggregates operation.

" }, "EventAggregateList":{ "type":"list", "member":{"shape":"EventAggregate"} }, "EventArnsList":{ "type":"list", "member":{"shape":"eventArn"}, "max":50, "min":1 }, "EventDescription":{ "type":"structure", "members":{ "latestDescription":{ "shape":"eventDescription", "documentation":"

The most recent description of the event.

" } }, "documentation":"

The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.

" }, "EventDetails":{ "type":"structure", "members":{ "event":{ "shape":"Event", "documentation":"

Summary information about the event.

" }, "eventDescription":{ "shape":"EventDescription", "documentation":"

The most recent description of the event.

" }, "eventMetadata":{ "shape":"eventMetadata", "documentation":"

Additional metadata about the event.

" } }, "documentation":"

Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetails operation.

" }, "EventDetailsErrorItem":{ "type":"structure", "members":{ "eventArn":{ "shape":"eventArn", "documentation":"

The unique identifier for the event. Format: arn:aws:health:event-region::event/EVENT_TYPE_PLUS_ID . Example: arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331

" }, "errorName":{ "shape":"string", "documentation":"

The name of the error.

" }, "errorMessage":{ "shape":"string", "documentation":"

A message that describes the error.

" } }, "documentation":"

Error information returned when a DescribeEventDetails operation cannot find a specified event.

" }, "EventFilter":{ "type":"structure", "members":{ "eventArns":{ "shape":"eventArnList", "documentation":"

A list of event ARNs (unique identifiers). For example: \"arn:aws:health:us-east-1::event/AWS_EC2_MAINTENANCE_5331\", \"arn:aws:health:us-west-1::event/AWS_EBS_LOST_VOLUME_xyz\"

" }, "eventTypeCodes":{ "shape":"eventTypeList", "documentation":"

A list of unique identifiers for event types. For example, \"AWS_EC2_SYSTEM_MAINTENANCE_EVENT\",\"AWS_RDS_MAINTENANCE_SCHEDULED\"

" }, "services":{ "shape":"serviceList", "documentation":"

The AWS services associated with the event. For example, EC2, RDS.

" }, "regions":{ "shape":"regionList", "documentation":"

A list of AWS regions.

" }, "availabilityZones":{ "shape":"availabilityZones", "documentation":"

A list of AWS availability zones.

" }, "startTimes":{ "shape":"dateTimeRangeList", "documentation":"

A list of dates and times that the event began.

" }, "endTimes":{ "shape":"dateTimeRangeList", "documentation":"

A list of dates and times that the event ended.

" }, "lastUpdatedTimes":{ "shape":"dateTimeRangeList", "documentation":"

A list of dates and times that the event was last updated.

" }, "entityArns":{ "shape":"entityArnList", "documentation":"

A list of entity ARNs (unique identifiers).

" }, "entityValues":{ "shape":"entityValueList", "documentation":"

A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).

" }, "eventTypeCategories":{ "shape":"eventTypeCategoryList", "documentation":"

A list of event type category codes (issue, scheduledChange, or accountNotification).

" }, "tags":{ "shape":"tagFilter", "documentation":"

A map of entity tags attached to the affected entity.

" }, "eventStatusCodes":{ "shape":"eventStatusCodeList", "documentation":"

A list of event status codes.

" } }, "documentation":"

The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations.

" }, "EventList":{ "type":"list", "member":{"shape":"Event"} }, "EventType":{ "type":"structure", "members":{ "service":{ "shape":"service", "documentation":"

The AWS service that is affected by the event. For example, EC2, RDS.

" }, "code":{ "shape":"eventTypeCode", "documentation":"

The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

" }, "category":{ "shape":"eventTypeCategory", "documentation":"

A list of event type category codes (issue, scheduledChange, or accountNotification).

" } }, "documentation":"

Metadata about a type of event that is reported by AWS Health. Data consists of the category (for example, issue), the service (for example, EC2), and the event type code (for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT).

" }, "EventTypeCategoryList":{ "type":"list", "member":{"shape":"eventTypeCategory"}, "max":10, "min":1 }, "EventTypeCodeList":{ "type":"list", "member":{"shape":"eventTypeCode"}, "max":10, "min":1 }, "EventTypeFilter":{ "type":"structure", "members":{ "eventTypeCodes":{ "shape":"EventTypeCodeList", "documentation":"

A list of event type codes.

" }, "services":{ "shape":"serviceList", "documentation":"

The AWS services associated with the event. For example, EC2, RDS.

" }, "eventTypeCategories":{ "shape":"EventTypeCategoryList", "documentation":"

A list of event type category codes (issue, scheduledChange, or accountNotification).

" } }, "documentation":"

The values to use to filter results from the DescribeEventTypes operation.

" }, "EventTypeList":{ "type":"list", "member":{"shape":"EventType"} }, "InvalidPaginationToken":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

The specified pagination token (nextToken) is not valid.

", "exception":true }, "UnsupportedLocale":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

The specified locale is not supported.

", "exception":true }, "accountId":{ "type":"string", "pattern":"[0-9]{12}" }, "aggregateValue":{"type":"string"}, "availabilityZone":{ "type":"string", "pattern":"[a-z]{2}\\-[0-9a-z\\-]{4,16}" }, "availabilityZones":{ "type":"list", "member":{"shape":"availabilityZone"} }, "count":{"type":"integer"}, "dateTimeRangeList":{ "type":"list", "member":{"shape":"DateTimeRange"}, "max":10, "min":1 }, "entityArn":{ "type":"string", "max":1600 }, "entityArnList":{ "type":"list", "member":{"shape":"entityArn"}, "max":100, "min":1 }, "entityStatusCode":{ "type":"string", "enum":[ "IMPAIRED", "UNIMPAIRED", "UNKNOWN" ] }, "entityStatusCodeList":{ "type":"list", "member":{"shape":"entityStatusCode"}, "max":3, "min":1 }, "entityValue":{ "type":"string", "max":256 }, "entityValueList":{ "type":"list", "member":{"shape":"entityValue"}, "max":100, "min":1 }, "eventAggregateField":{ "type":"string", "enum":["eventTypeCategory"] }, "eventArn":{ "type":"string", "max":1600, "pattern":"arn:aws:health:[^:]*:[^:]*:event/[\\w-]+" }, "eventArnList":{ "type":"list", "member":{"shape":"eventArn"}, "max":10, "min":1 }, "eventDescription":{"type":"string"}, "eventMetadata":{ "type":"map", "key":{"shape":"metadataKey"}, "value":{"shape":"metadataValue"} }, "eventStatusCode":{ "type":"string", "enum":[ "open", "closed", "upcoming" ] }, "eventStatusCodeList":{ "type":"list", "member":{"shape":"eventStatusCode"}, "max":6, "min":1 }, "eventType":{ "type":"string", "max":100, "min":3 }, "eventTypeCategory":{ "type":"string", "enum":[ "issue", "accountNotification", "scheduledChange" ], "max":255, "min":3 }, "eventTypeCategoryList":{ "type":"list", "member":{"shape":"eventTypeCategory"}, "max":10, "min":1 }, "eventTypeCode":{ "type":"string", "max":100, "min":3 }, "eventTypeList":{ "type":"list", "member":{"shape":"eventType"}, "max":10, "min":1 }, "locale":{ "type":"string", "max":256, "min":2 }, "maxResults":{ "type":"integer", "max":100, "min":10 }, "metadataKey":{"type":"string"}, "metadataValue":{ "type":"string", "max":10240 }, "nextToken":{ "type":"string", "pattern":"[a-zA-Z0-9=/+_.-]{4,512}" }, "region":{ "type":"string", "pattern":"[^:/]{2,25}" }, "regionList":{ "type":"list", "member":{"shape":"region"}, "max":10, "min":1 }, "service":{ "type":"string", "max":30, "min":2 }, "serviceList":{ "type":"list", "member":{"shape":"service"}, "max":10, "min":1 }, "string":{"type":"string"}, "tagFilter":{ "type":"list", "member":{"shape":"tagSet"}, "max":50 }, "tagKey":{ "type":"string", "max":127 }, "tagSet":{ "type":"map", "key":{"shape":"tagKey"}, "value":{"shape":"tagValue"}, "max":50 }, "tagValue":{ "type":"string", "max":255 }, "timestamp":{"type":"timestamp"} }, "documentation":"AWS Health

The AWS Health API provides programmatic access to the AWS Health information that is presented in the AWS Personal Health Dashboard. You can get information about events that affect your AWS resources:

In addition, these operations provide information about event types and summary counts of events or affected entities:

The Health API requires a Business or Enterprise support plan from AWS Support. Calling the Health API from an account that does not have a Business or Enterprise support plan causes a SubscriptionRequiredException.

For authentication of requests, AWS Health uses the Signature Version 4 Signing Process.

See the AWS Health User Guide for information about how to use the API.

Service Endpoint

The HTTP endpoint for the AWS Health API is:

  • https://health.us-east-1.amazonaws.com

" } botocore-1.5.7/botocore/data/cognito-identity/0000777454262600001440000000000013042511307022424 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cognito-identity/2014-06-30/0000777454262600001440000000000013042511307023455 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cognito-identity/2014-06-30/service-2.json0000666454262600001440000015661513042511306026164 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2014-06-30", "endpointPrefix":"cognito-identity", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Amazon Cognito Identity", "signatureVersion":"v4", "targetPrefix":"AWSCognitoIdentityService", "uid":"cognito-identity-2014-06-30" }, "operations":{ "CreateIdentityPool":{ "name":"CreateIdentityPool", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateIdentityPoolInput"}, "output":{"shape":"IdentityPool"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"NotAuthorizedException"}, {"shape":"ResourceConflictException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for SupportedLoginProviders are as follows:

  • Facebook: graph.facebook.com

  • Google: accounts.google.com

  • Amazon: www.amazon.com

  • Twitter: api.twitter.com

  • Digits: www.digits.com

You must use AWS Developer credentials to call this API.

" }, "DeleteIdentities":{ "name":"DeleteIdentities", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteIdentitiesInput"}, "output":{"shape":"DeleteIdentitiesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"} ], "documentation":"

Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.

You must use AWS Developer credentials to call this API.

" }, "DeleteIdentityPool":{ "name":"DeleteIdentityPool", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteIdentityPoolInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"} ], "documentation":"

Deletes a user pool. Once a pool is deleted, users will not be able to authenticate with the pool.

You must use AWS Developer credentials to call this API.

" }, "DescribeIdentity":{ "name":"DescribeIdentity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeIdentityInput"}, "output":{"shape":"IdentityDescription"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"} ], "documentation":"

Returns metadata related to the given identity, including when the identity was created and any associated linked logins.

You must use AWS Developer credentials to call this API.

" }, "DescribeIdentityPool":{ "name":"DescribeIdentityPool", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeIdentityPoolInput"}, "output":{"shape":"IdentityPool"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"} ], "documentation":"

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

You must use AWS Developer credentials to call this API.

" }, "GetCredentialsForIdentity":{ "name":"GetCredentialsForIdentity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCredentialsForIdentityInput"}, "output":{"shape":"GetCredentialsForIdentityResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"ResourceConflictException"}, {"shape":"TooManyRequestsException"}, {"shape":"InvalidIdentityPoolConfigurationException"}, {"shape":"InternalErrorException"}, {"shape":"ExternalServiceException"} ], "documentation":"

Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.

This is a public API. You do not need any credentials to call this API.

" }, "GetId":{ "name":"GetId", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetIdInput"}, "output":{"shape":"GetIdResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"ResourceConflictException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"}, {"shape":"LimitExceededException"}, {"shape":"ExternalServiceException"} ], "documentation":"

Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.

This is a public API. You do not need any credentials to call this API.

" }, "GetIdentityPoolRoles":{ "name":"GetIdentityPoolRoles", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetIdentityPoolRolesInput"}, "output":{"shape":"GetIdentityPoolRolesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"ResourceConflictException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"} ], "documentation":"

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

" }, "GetOpenIdToken":{ "name":"GetOpenIdToken", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetOpenIdTokenInput"}, "output":{"shape":"GetOpenIdTokenResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"ResourceConflictException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"}, {"shape":"ExternalServiceException"} ], "documentation":"

Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.

The OpenId token is valid for 15 minutes.

This is a public API. You do not need any credentials to call this API.

" }, "GetOpenIdTokenForDeveloperIdentity":{ "name":"GetOpenIdTokenForDeveloperIdentity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetOpenIdTokenForDeveloperIdentityInput"}, "output":{"shape":"GetOpenIdTokenForDeveloperIdentityResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"ResourceConflictException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"}, {"shape":"DeveloperUserAlreadyRegisteredException"} ], "documentation":"

Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the \"domain\" by which Cognito will refer to your users.

You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId. This API will create the identity in the specified IdentityPoolId.

You must use AWS Developer credentials to call this API.

" }, "ListIdentities":{ "name":"ListIdentities", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListIdentitiesInput"}, "output":{"shape":"ListIdentitiesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"} ], "documentation":"

Lists the identities in a pool.

You must use AWS Developer credentials to call this API.

" }, "ListIdentityPools":{ "name":"ListIdentityPools", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListIdentityPoolsInput"}, "output":{"shape":"ListIdentityPoolsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"NotAuthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"} ], "documentation":"

Lists all of the Cognito identity pools registered for your account.

You must use AWS Developer credentials to call this API.

" }, "LookupDeveloperIdentity":{ "name":"LookupDeveloperIdentity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"LookupDeveloperIdentityInput"}, "output":{"shape":"LookupDeveloperIdentityResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"ResourceConflictException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"} ], "documentation":"

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifiers associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown.

You must use AWS Developer credentials to call this API.

" }, "MergeDeveloperIdentities":{ "name":"MergeDeveloperIdentities", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MergeDeveloperIdentitiesInput"}, "output":{"shape":"MergeDeveloperIdentitiesResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"ResourceConflictException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"} ], "documentation":"

Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.

You must use AWS Developer credentials to call this API.

" }, "SetIdentityPoolRoles":{ "name":"SetIdentityPoolRoles", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetIdentityPoolRolesInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"ResourceConflictException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"}, {"shape":"ConcurrentModificationException"} ], "documentation":"

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

You must use AWS Developer credentials to call this API.

" }, "UnlinkDeveloperIdentity":{ "name":"UnlinkDeveloperIdentity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnlinkDeveloperIdentityInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"ResourceConflictException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"} ], "documentation":"

Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.

You must use AWS Developer credentials to call this API.

" }, "UnlinkIdentity":{ "name":"UnlinkIdentity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnlinkIdentityInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"ResourceConflictException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"}, {"shape":"ExternalServiceException"} ], "documentation":"

Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

This is a public API. You do not need any credentials to call this API.

" }, "UpdateIdentityPool":{ "name":"UpdateIdentityPool", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"IdentityPool"}, "output":{"shape":"IdentityPool"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotAuthorizedException"}, {"shape":"ResourceConflictException"}, {"shape":"TooManyRequestsException"}, {"shape":"InternalErrorException"}, {"shape":"ConcurrentModificationException"}, {"shape":"LimitExceededException"} ], "documentation":"

Updates a user pool.

You must use AWS Developer credentials to call this API.

" } }, "shapes":{ "ARNString":{ "type":"string", "max":2048, "min":20 }, "AccessKeyString":{"type":"string"}, "AccountId":{ "type":"string", "max":15, "min":1, "pattern":"\\d+" }, "AmbiguousRoleResolutionType":{ "type":"string", "enum":[ "AuthenticatedRole", "Deny" ] }, "ClaimName":{ "type":"string", "max":64, "min":1, "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" }, "ClaimValue":{ "type":"string", "max":128, "min":1 }, "CognitoIdentityProvider":{ "type":"structure", "members":{ "ProviderName":{ "shape":"CognitoIdentityProviderName", "documentation":"

The provider name for an Amazon Cognito Identity User Pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

" }, "ClientId":{ "shape":"CognitoIdentityProviderClientId", "documentation":"

The client ID for the Amazon Cognito Identity User Pool.

" } }, "documentation":"

A provider representing an Amazon Cognito Identity User Pool and its client ID.

" }, "CognitoIdentityProviderClientId":{ "type":"string", "max":128, "min":1, "pattern":"[\\w_]+" }, "CognitoIdentityProviderList":{ "type":"list", "member":{"shape":"CognitoIdentityProvider"} }, "CognitoIdentityProviderName":{ "type":"string", "max":128, "min":1, "pattern":"[\\w._:/-]+" }, "ConcurrentModificationException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The message returned by a ConcurrentModificationException.

" } }, "documentation":"

Thrown if there are parallel requests to modify a resource.

", "exception":true }, "CreateIdentityPoolInput":{ "type":"structure", "required":[ "IdentityPoolName", "AllowUnauthenticatedIdentities" ], "members":{ "IdentityPoolName":{ "shape":"IdentityPoolName", "documentation":"

A string that you provide.

" }, "AllowUnauthenticatedIdentities":{ "shape":"IdentityPoolUnauthenticated", "documentation":"

TRUE if the identity pool supports unauthenticated logins.

" }, "SupportedLoginProviders":{ "shape":"IdentityProviders", "documentation":"

Optional key:value pairs mapping provider names to provider app IDs.

" }, "DeveloperProviderName":{ "shape":"DeveloperProviderName", "documentation":"

The \"domain\" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.

" }, "OpenIdConnectProviderARNs":{ "shape":"OIDCProviderList", "documentation":"

A list of OpendID Connect provider ARNs.

" }, "CognitoIdentityProviders":{ "shape":"CognitoIdentityProviderList", "documentation":"

An array of Amazon Cognito Identity user pools and their client IDs.

" }, "SamlProviderARNs":{ "shape":"SAMLProviderList", "documentation":"

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

" } }, "documentation":"

Input to the CreateIdentityPool action.

" }, "Credentials":{ "type":"structure", "members":{ "AccessKeyId":{ "shape":"AccessKeyString", "documentation":"

The Access Key portion of the credentials.

" }, "SecretKey":{ "shape":"SecretKeyString", "documentation":"

The Secret Access Key portion of the credentials

" }, "SessionToken":{ "shape":"SessionTokenString", "documentation":"

The Session Token portion of the credentials

" }, "Expiration":{ "shape":"DateType", "documentation":"

The date at which these credentials will expire.

" } }, "documentation":"

Credentials for the provided identity ID.

" }, "DateType":{"type":"timestamp"}, "DeleteIdentitiesInput":{ "type":"structure", "required":["IdentityIdsToDelete"], "members":{ "IdentityIdsToDelete":{ "shape":"IdentityIdList", "documentation":"

A list of 1-60 identities that you want to delete.

" } }, "documentation":"

Input to the DeleteIdentities action.

" }, "DeleteIdentitiesResponse":{ "type":"structure", "members":{ "UnprocessedIdentityIds":{ "shape":"UnprocessedIdentityIdList", "documentation":"

An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.

" } }, "documentation":"

Returned in response to a successful DeleteIdentities operation.

" }, "DeleteIdentityPoolInput":{ "type":"structure", "required":["IdentityPoolId"], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

An identity pool ID in the format REGION:GUID.

" } }, "documentation":"

Input to the DeleteIdentityPool action.

" }, "DescribeIdentityInput":{ "type":"structure", "required":["IdentityId"], "members":{ "IdentityId":{ "shape":"IdentityId", "documentation":"

A unique identifier in the format REGION:GUID.

" } }, "documentation":"

Input to the DescribeIdentity action.

" }, "DescribeIdentityPoolInput":{ "type":"structure", "required":["IdentityPoolId"], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

An identity pool ID in the format REGION:GUID.

" } }, "documentation":"

Input to the DescribeIdentityPool action.

" }, "DeveloperProviderName":{ "type":"string", "max":128, "min":1, "pattern":"[\\w._-]+" }, "DeveloperUserAlreadyRegisteredException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

This developer user identifier is already registered with Cognito.

" } }, "documentation":"

The provided developer user identifier is already registered with Cognito under a different identity ID.

", "exception":true }, "DeveloperUserIdentifier":{ "type":"string", "max":1024, "min":1 }, "DeveloperUserIdentifierList":{ "type":"list", "member":{"shape":"DeveloperUserIdentifier"} }, "ErrorCode":{ "type":"string", "enum":[ "AccessDenied", "InternalServerError" ] }, "ExternalServiceException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The message returned by an ExternalServiceException

" } }, "documentation":"

An exception thrown when a dependent service such as Facebook or Twitter is not responding

", "exception":true }, "GetCredentialsForIdentityInput":{ "type":"structure", "required":["IdentityId"], "members":{ "IdentityId":{ "shape":"IdentityId", "documentation":"

A unique identifier in the format REGION:GUID.

" }, "Logins":{ "shape":"LoginsMap", "documentation":"

A set of optional name-value pairs that map provider names to provider tokens.

" }, "CustomRoleArn":{ "shape":"ARNString", "documentation":"

The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

" } }, "documentation":"

Input to the GetCredentialsForIdentity action.

" }, "GetCredentialsForIdentityResponse":{ "type":"structure", "members":{ "IdentityId":{ "shape":"IdentityId", "documentation":"

A unique identifier in the format REGION:GUID.

" }, "Credentials":{ "shape":"Credentials", "documentation":"

Credentials for the provided identity ID.

" } }, "documentation":"

Returned in response to a successful GetCredentialsForIdentity operation.

" }, "GetIdInput":{ "type":"structure", "required":["IdentityPoolId"], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"

A standard AWS account ID (9+ digits).

" }, "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

An identity pool ID in the format REGION:GUID.

" }, "Logins":{ "shape":"LoginsMap", "documentation":"

A set of optional name-value pairs that map provider names to provider tokens. The available provider names for Logins are as follows:

  • Facebook: graph.facebook.com

  • Amazon Cognito Identity Provider: cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789

  • Google: accounts.google.com

  • Amazon: www.amazon.com

  • Twitter: api.twitter.com

  • Digits: www.digits.com

" } }, "documentation":"

Input to the GetId action.

" }, "GetIdResponse":{ "type":"structure", "members":{ "IdentityId":{ "shape":"IdentityId", "documentation":"

A unique identifier in the format REGION:GUID.

" } }, "documentation":"

Returned in response to a GetId request.

" }, "GetIdentityPoolRolesInput":{ "type":"structure", "required":["IdentityPoolId"], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

An identity pool ID in the format REGION:GUID.

" } }, "documentation":"

Input to the GetIdentityPoolRoles action.

" }, "GetIdentityPoolRolesResponse":{ "type":"structure", "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

An identity pool ID in the format REGION:GUID.

" }, "Roles":{ "shape":"RolesMap", "documentation":"

The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.

" }, "RoleMappings":{ "shape":"RoleMappingMap", "documentation":"

How users for a specific identity provider are to mapped to roles. This is a String-to-RoleMapping object map. The string identifies the identity provider, for example, \"graph.facebook.com\" or \"cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id\".

" } }, "documentation":"

Returned in response to a successful GetIdentityPoolRoles operation.

" }, "GetOpenIdTokenForDeveloperIdentityInput":{ "type":"structure", "required":[ "IdentityPoolId", "Logins" ], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

An identity pool ID in the format REGION:GUID.

" }, "IdentityId":{ "shape":"IdentityId", "documentation":"

A unique identifier in the format REGION:GUID.

" }, "Logins":{ "shape":"LoginsMap", "documentation":"

A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax \"developer_provider_name\": \"developer_user_identifier\". The developer provider is the \"domain\" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.

" }, "TokenDuration":{ "shape":"TokenDuration", "documentation":"

The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.

" } }, "documentation":"

Input to the GetOpenIdTokenForDeveloperIdentity action.

" }, "GetOpenIdTokenForDeveloperIdentityResponse":{ "type":"structure", "members":{ "IdentityId":{ "shape":"IdentityId", "documentation":"

A unique identifier in the format REGION:GUID.

" }, "Token":{ "shape":"OIDCToken", "documentation":"

An OpenID token.

" } }, "documentation":"

Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request.

" }, "GetOpenIdTokenInput":{ "type":"structure", "required":["IdentityId"], "members":{ "IdentityId":{ "shape":"IdentityId", "documentation":"

A unique identifier in the format REGION:GUID.

" }, "Logins":{ "shape":"LoginsMap", "documentation":"

A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com, an Amazon Cognito Identity Provider, or any other OpenId Connect provider, always include the id_token.

" } }, "documentation":"

Input to the GetOpenIdToken action.

" }, "GetOpenIdTokenResponse":{ "type":"structure", "members":{ "IdentityId":{ "shape":"IdentityId", "documentation":"

A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.

" }, "Token":{ "shape":"OIDCToken", "documentation":"

An OpenID token, valid for 15 minutes.

" } }, "documentation":"

Returned in response to a successful GetOpenIdToken request.

" }, "HideDisabled":{"type":"boolean"}, "IdentitiesList":{ "type":"list", "member":{"shape":"IdentityDescription"} }, "IdentityDescription":{ "type":"structure", "members":{ "IdentityId":{ "shape":"IdentityId", "documentation":"

A unique identifier in the format REGION:GUID.

" }, "Logins":{ "shape":"LoginsList", "documentation":"

A set of optional name-value pairs that map provider names to provider tokens.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

Date on which the identity was created.

" }, "LastModifiedDate":{ "shape":"DateType", "documentation":"

Date on which the identity was last modified.

" } }, "documentation":"

A description of the identity.

" }, "IdentityId":{ "type":"string", "max":55, "min":1, "pattern":"[\\w-]+:[0-9a-f-]+" }, "IdentityIdList":{ "type":"list", "member":{"shape":"IdentityId"}, "max":60, "min":1 }, "IdentityPool":{ "type":"structure", "required":[ "IdentityPoolId", "IdentityPoolName", "AllowUnauthenticatedIdentities" ], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

An identity pool ID in the format REGION:GUID.

" }, "IdentityPoolName":{ "shape":"IdentityPoolName", "documentation":"

A string that you provide.

" }, "AllowUnauthenticatedIdentities":{ "shape":"IdentityPoolUnauthenticated", "documentation":"

TRUE if the identity pool supports unauthenticated logins.

" }, "SupportedLoginProviders":{ "shape":"IdentityProviders", "documentation":"

Optional key:value pairs mapping provider names to provider app IDs.

" }, "DeveloperProviderName":{ "shape":"DeveloperProviderName", "documentation":"

The \"domain\" by which Cognito will refer to your users.

" }, "OpenIdConnectProviderARNs":{ "shape":"OIDCProviderList", "documentation":"

A list of OpendID Connect provider ARNs.

" }, "CognitoIdentityProviders":{ "shape":"CognitoIdentityProviderList", "documentation":"

A list representing an Amazon Cognito Identity User Pool and its client ID.

" }, "SamlProviderARNs":{ "shape":"SAMLProviderList", "documentation":"

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

" } }, "documentation":"

An object representing an Amazon Cognito identity pool.

" }, "IdentityPoolId":{ "type":"string", "max":55, "min":1, "pattern":"[\\w-]+:[0-9a-f-]+" }, "IdentityPoolName":{ "type":"string", "max":128, "min":1, "pattern":"[\\w ]+" }, "IdentityPoolShortDescription":{ "type":"structure", "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

An identity pool ID in the format REGION:GUID.

" }, "IdentityPoolName":{ "shape":"IdentityPoolName", "documentation":"

A string that you provide.

" } }, "documentation":"

A description of the identity pool.

" }, "IdentityPoolUnauthenticated":{"type":"boolean"}, "IdentityPoolsList":{ "type":"list", "member":{"shape":"IdentityPoolShortDescription"} }, "IdentityProviderId":{ "type":"string", "max":128, "min":1, "pattern":"[\\w.;_/-]+" }, "IdentityProviderName":{ "type":"string", "max":128, "min":1 }, "IdentityProviderToken":{ "type":"string", "max":50000, "min":1 }, "IdentityProviders":{ "type":"map", "key":{"shape":"IdentityProviderName"}, "value":{"shape":"IdentityProviderId"}, "max":10 }, "InternalErrorException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The message returned by an InternalErrorException.

" } }, "documentation":"

Thrown when the service encounters an error during processing the request.

", "exception":true, "fault":true }, "InvalidIdentityPoolConfigurationException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The message returned for an InvalidIdentityPoolConfigurationException

" } }, "documentation":"

Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.

", "exception":true }, "InvalidParameterException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The message returned by an InvalidParameterException.

" } }, "documentation":"

Thrown for missing or bad input parameter(s).

", "exception":true }, "LimitExceededException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The message returned by a LimitExceededException.

" } }, "documentation":"

Thrown when the total number of user pools has exceeded a preset limit.

", "exception":true }, "ListIdentitiesInput":{ "type":"structure", "required":[ "IdentityPoolId", "MaxResults" ], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

An identity pool ID in the format REGION:GUID.

" }, "MaxResults":{ "shape":"QueryLimit", "documentation":"

The maximum number of identities to return.

" }, "NextToken":{ "shape":"PaginationKey", "documentation":"

A pagination token.

" }, "HideDisabled":{ "shape":"HideDisabled", "documentation":"

An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

" } }, "documentation":"

Input to the ListIdentities action.

" }, "ListIdentitiesResponse":{ "type":"structure", "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

An identity pool ID in the format REGION:GUID.

" }, "Identities":{ "shape":"IdentitiesList", "documentation":"

An object containing a set of identities and associated mappings.

" }, "NextToken":{ "shape":"PaginationKey", "documentation":"

A pagination token.

" } }, "documentation":"

The response to a ListIdentities request.

" }, "ListIdentityPoolsInput":{ "type":"structure", "required":["MaxResults"], "members":{ "MaxResults":{ "shape":"QueryLimit", "documentation":"

The maximum number of identities to return.

" }, "NextToken":{ "shape":"PaginationKey", "documentation":"

A pagination token.

" } }, "documentation":"

Input to the ListIdentityPools action.

" }, "ListIdentityPoolsResponse":{ "type":"structure", "members":{ "IdentityPools":{ "shape":"IdentityPoolsList", "documentation":"

The identity pools returned by the ListIdentityPools action.

" }, "NextToken":{ "shape":"PaginationKey", "documentation":"

A pagination token.

" } }, "documentation":"

The result of a successful ListIdentityPools action.

" }, "LoginsList":{ "type":"list", "member":{"shape":"IdentityProviderName"} }, "LoginsMap":{ "type":"map", "key":{"shape":"IdentityProviderName"}, "value":{"shape":"IdentityProviderToken"}, "max":10 }, "LookupDeveloperIdentityInput":{ "type":"structure", "required":["IdentityPoolId"], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

An identity pool ID in the format REGION:GUID.

" }, "IdentityId":{ "shape":"IdentityId", "documentation":"

A unique identifier in the format REGION:GUID.

" }, "DeveloperUserIdentifier":{ "shape":"DeveloperUserIdentifier", "documentation":"

A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.

" }, "MaxResults":{ "shape":"QueryLimit", "documentation":"

The maximum number of identities to return.

" }, "NextToken":{ "shape":"PaginationKey", "documentation":"

A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.

" } }, "documentation":"

Input to the LookupDeveloperIdentityInput action.

" }, "LookupDeveloperIdentityResponse":{ "type":"structure", "members":{ "IdentityId":{ "shape":"IdentityId", "documentation":"

A unique identifier in the format REGION:GUID.

" }, "DeveloperUserIdentifierList":{ "shape":"DeveloperUserIdentifierList", "documentation":"

This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.

" }, "NextToken":{ "shape":"PaginationKey", "documentation":"

A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.

" } }, "documentation":"

Returned in response to a successful LookupDeveloperIdentity action.

" }, "MappingRule":{ "type":"structure", "required":[ "Claim", "MatchType", "Value", "RoleARN" ], "members":{ "Claim":{ "shape":"ClaimName", "documentation":"

The claim name that must be present in the token, for example, \"isAdmin\" or \"paid\".

" }, "MatchType":{ "shape":"MappingRuleMatchType", "documentation":"

The match condition that specifies how closely the claim value in the IdP token must match Value.

" }, "Value":{ "shape":"ClaimValue", "documentation":"

A brief string that the claim must match, for example, \"paid\" or \"yes\".

" }, "RoleARN":{ "shape":"ARNString", "documentation":"

The role ARN.

" } }, "documentation":"

A rule that maps a claim name, a claim value, and a match type to a role ARN.

" }, "MappingRuleMatchType":{ "type":"string", "enum":[ "Equals", "Contains", "StartsWith", "NotEqual" ] }, "MappingRulesList":{ "type":"list", "member":{"shape":"MappingRule"}, "max":25, "min":1 }, "MergeDeveloperIdentitiesInput":{ "type":"structure", "required":[ "SourceUserIdentifier", "DestinationUserIdentifier", "DeveloperProviderName", "IdentityPoolId" ], "members":{ "SourceUserIdentifier":{ "shape":"DeveloperUserIdentifier", "documentation":"

User identifier for the source user. The value should be a DeveloperUserIdentifier.

" }, "DestinationUserIdentifier":{ "shape":"DeveloperUserIdentifier", "documentation":"

User identifier for the destination user. The value should be a DeveloperUserIdentifier.

" }, "DeveloperProviderName":{ "shape":"DeveloperProviderName", "documentation":"

The \"domain\" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

" }, "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

An identity pool ID in the format REGION:GUID.

" } }, "documentation":"

Input to the MergeDeveloperIdentities action.

" }, "MergeDeveloperIdentitiesResponse":{ "type":"structure", "members":{ "IdentityId":{ "shape":"IdentityId", "documentation":"

A unique identifier in the format REGION:GUID.

" } }, "documentation":"

Returned in response to a successful MergeDeveloperIdentities action.

" }, "NotAuthorizedException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The message returned by a NotAuthorizedException

" } }, "documentation":"

Thrown when a user is not authorized to access the requested resource.

", "exception":true }, "OIDCProviderList":{ "type":"list", "member":{"shape":"ARNString"} }, "OIDCToken":{"type":"string"}, "PaginationKey":{ "type":"string", "min":1, "pattern":"[\\S]+" }, "QueryLimit":{ "type":"integer", "max":60, "min":1 }, "ResourceConflictException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The message returned by a ResourceConflictException.

" } }, "documentation":"

Thrown when a user tries to use a login which is already linked to another account.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The message returned by a ResourceNotFoundException.

" } }, "documentation":"

Thrown when the requested resource (for example, a dataset or record) does not exist.

", "exception":true }, "RoleMapping":{ "type":"structure", "required":["Type"], "members":{ "Type":{ "shape":"RoleMappingType", "documentation":"

The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

" }, "AmbiguousRoleResolution":{ "shape":"AmbiguousRoleResolutionType", "documentation":"

If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

" }, "RulesConfiguration":{ "shape":"RulesConfigurationType", "documentation":"

The rules to be used for mapping users to roles.

If you specify Rules as the role mapping type, RulesConfiguration is required.

" } }, "documentation":"

A role mapping.

" }, "RoleMappingMap":{ "type":"map", "key":{"shape":"IdentityProviderName"}, "value":{"shape":"RoleMapping"}, "max":10 }, "RoleMappingType":{ "type":"string", "enum":[ "Token", "Rules" ] }, "RoleType":{ "type":"string", "pattern":"(un)?authenticated" }, "RolesMap":{ "type":"map", "key":{"shape":"RoleType"}, "value":{"shape":"ARNString"}, "max":2 }, "RulesConfigurationType":{ "type":"structure", "required":["Rules"], "members":{ "Rules":{ "shape":"MappingRulesList", "documentation":"

An array of rules. You can specify up to 25 rules per identity provider.

Rules are evaluated in order. The first one to match specifies the role.

" } }, "documentation":"

A container for rules.

" }, "SAMLProviderList":{ "type":"list", "member":{"shape":"ARNString"} }, "SecretKeyString":{"type":"string"}, "SessionTokenString":{"type":"string"}, "SetIdentityPoolRolesInput":{ "type":"structure", "required":[ "IdentityPoolId", "Roles" ], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

An identity pool ID in the format REGION:GUID.

" }, "Roles":{ "shape":"RolesMap", "documentation":"

The map of roles associated with this pool. For a given role, the key will be either \"authenticated\" or \"unauthenticated\" and the value will be the Role ARN.

" }, "RoleMappings":{ "shape":"RoleMappingMap", "documentation":"

How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, \"graph.facebook.com\" or \"cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id\".

Up to 25 rules can be specified per identity provider.

" } }, "documentation":"

Input to the SetIdentityPoolRoles action.

" }, "String":{"type":"string"}, "TokenDuration":{ "type":"long", "max":86400, "min":1 }, "TooManyRequestsException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

Message returned by a TooManyRequestsException

" } }, "documentation":"

Thrown when a request is throttled.

", "exception":true }, "UnlinkDeveloperIdentityInput":{ "type":"structure", "required":[ "IdentityId", "IdentityPoolId", "DeveloperProviderName", "DeveloperUserIdentifier" ], "members":{ "IdentityId":{ "shape":"IdentityId", "documentation":"

A unique identifier in the format REGION:GUID.

" }, "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

An identity pool ID in the format REGION:GUID.

" }, "DeveloperProviderName":{ "shape":"DeveloperProviderName", "documentation":"

The \"domain\" by which Cognito will refer to your users.

" }, "DeveloperUserIdentifier":{ "shape":"DeveloperUserIdentifier", "documentation":"

A unique ID used by your backend authentication process to identify a user.

" } }, "documentation":"

Input to the UnlinkDeveloperIdentity action.

" }, "UnlinkIdentityInput":{ "type":"structure", "required":[ "IdentityId", "Logins", "LoginsToRemove" ], "members":{ "IdentityId":{ "shape":"IdentityId", "documentation":"

A unique identifier in the format REGION:GUID.

" }, "Logins":{ "shape":"LoginsMap", "documentation":"

A set of optional name-value pairs that map provider names to provider tokens.

" }, "LoginsToRemove":{ "shape":"LoginsList", "documentation":"

Provider names to unlink from this identity.

" } }, "documentation":"

Input to the UnlinkIdentity action.

" }, "UnprocessedIdentityId":{ "type":"structure", "members":{ "IdentityId":{ "shape":"IdentityId", "documentation":"

A unique identifier in the format REGION:GUID.

" }, "ErrorCode":{ "shape":"ErrorCode", "documentation":"

The error code indicating the type of error that occurred.

" } }, "documentation":"

An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.

" }, "UnprocessedIdentityIdList":{ "type":"list", "member":{"shape":"UnprocessedIdentityId"}, "max":60 } }, "documentation":"Amazon Cognito

Amazon Cognito is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. Amazon Cognito uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.

Using Amazon Cognito, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon), and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.

To provide end-user credentials, first make an unsigned call to GetId. If the end user is authenticated with one of the supported identity providers, set the Logins map with the identity provider token. GetId returns a unique identifier for the user.

Next, make an unsigned call to GetCredentialsForIdentity. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. Assuming your identity pool has been configured via the SetIdentityPoolRoles operation, GetCredentialsForIdentity will return AWS credentials for your use. If your pool has not been configured with SetIdentityPoolRoles, or if you want to follow legacy flow, make an unsigned call to GetOpenIdToken, which returns the OpenID token necessary to call STS and retrieve AWS credentials. This call expects the same Logins map as the GetId call, as well as the IdentityID originally returned by GetId. The token returned by GetOpenIdToken can be passed to the STS operation AssumeRoleWithWebIdentity to retrieve AWS credentials.

If you want to use Amazon Cognito in an Android, iOS, or Unity application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the AWS Mobile SDK Developer Guide.

" } botocore-1.5.7/botocore/data/budgets/0000777454262600001440000000000013042511307020570 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/budgets/2016-10-20/0000777454262600001440000000000013042511307021615 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/budgets/2016-10-20/service-2.json0000777454262600001440000005474313042511306024326 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-10-20", "endpointPrefix":"budgets", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"AWSBudgets", "serviceFullName":"AWS Budgets", "signatureVersion":"v4", "targetPrefix":"AWSBudgetServiceGateway", "uid":"budgets-2016-10-20" }, "operations":{ "CreateBudget":{ "name":"CreateBudget", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateBudgetRequest"}, "output":{"shape":"CreateBudgetResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"CreationLimitExceededException"}, {"shape":"DuplicateRecordException"} ], "documentation":"Create a new budget" }, "CreateNotification":{ "name":"CreateNotification", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNotificationRequest"}, "output":{"shape":"CreateNotificationResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"NotFoundException"}, {"shape":"CreationLimitExceededException"}, {"shape":"DuplicateRecordException"} ], "documentation":"Create a new Notification with subscribers for a budget" }, "CreateSubscriber":{ "name":"CreateSubscriber", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSubscriberRequest"}, "output":{"shape":"CreateSubscriberResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"CreationLimitExceededException"}, {"shape":"DuplicateRecordException"} ], "documentation":"Create a new Subscriber for a notification" }, "DeleteBudget":{ "name":"DeleteBudget", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteBudgetRequest"}, "output":{"shape":"DeleteBudgetResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"NotFoundException"} ], "documentation":"Delete a budget and related notifications" }, "DeleteNotification":{ "name":"DeleteNotification", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNotificationRequest"}, "output":{"shape":"DeleteNotificationResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"} ], "documentation":"Delete a notification and related subscribers" }, "DeleteSubscriber":{ "name":"DeleteSubscriber", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSubscriberRequest"}, "output":{"shape":"DeleteSubscriberResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"NotFoundException"} ], "documentation":"Delete a Subscriber for a notification" }, "DescribeBudget":{ "name":"DescribeBudget", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeBudgetRequest"}, "output":{"shape":"DescribeBudgetResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"NotFoundException"} ], "documentation":"Get a single budget" }, "DescribeBudgets":{ "name":"DescribeBudgets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeBudgetsRequest"}, "output":{"shape":"DescribeBudgetsResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"NotFoundException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ExpiredNextTokenException"} ], "documentation":"Get all budgets for an account" }, "DescribeNotificationsForBudget":{ "name":"DescribeNotificationsForBudget", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNotificationsForBudgetRequest"}, "output":{"shape":"DescribeNotificationsForBudgetResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"NotFoundException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ExpiredNextTokenException"} ], "documentation":"Get notifications of a budget" }, "DescribeSubscribersForNotification":{ "name":"DescribeSubscribersForNotification", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSubscribersForNotificationRequest"}, "output":{"shape":"DescribeSubscribersForNotificationResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ExpiredNextTokenException"} ], "documentation":"Get subscribers of a notification" }, "UpdateBudget":{ "name":"UpdateBudget", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateBudgetRequest"}, "output":{"shape":"UpdateBudgetResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"NotFoundException"} ], "documentation":"Update the information of a budget already created" }, "UpdateNotification":{ "name":"UpdateNotification", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateNotificationRequest"}, "output":{"shape":"UpdateNotificationResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"NotFoundException"} ], "documentation":"Update the information about a notification already created" }, "UpdateSubscriber":{ "name":"UpdateSubscriber", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateSubscriberRequest"}, "output":{"shape":"UpdateSubscriberResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"NotFoundException"} ], "documentation":"Update a subscriber" } }, "shapes":{ "AccountId":{ "type":"string", "documentation":"Account Id of the customer. It should be a 12 digit number.", "max":12, "min":12 }, "Budget":{ "type":"structure", "required":[ "BudgetName", "BudgetLimit", "CostTypes", "TimeUnit", "TimePeriod", "BudgetType" ], "members":{ "BudgetName":{"shape":"BudgetName"}, "BudgetLimit":{"shape":"Spend"}, "CostFilters":{"shape":"CostFilters"}, "CostTypes":{"shape":"CostTypes"}, "TimeUnit":{"shape":"TimeUnit"}, "TimePeriod":{"shape":"TimePeriod"}, "CalculatedSpend":{"shape":"CalculatedSpend"}, "BudgetType":{"shape":"BudgetType"} }, "documentation":"AWS Budget model" }, "BudgetName":{ "type":"string", "documentation":"A string represents the budget name. No \":\" character is allowed.", "max":100, "pattern":"[^:]+" }, "BudgetType":{ "type":"string", "documentation":"The type of a budget. Can be COST or USAGE.", "enum":[ "USAGE", "COST" ] }, "Budgets":{ "type":"list", "member":{"shape":"Budget"}, "documentation":"A list of budgets" }, "CalculatedSpend":{ "type":"structure", "required":["ActualSpend"], "members":{ "ActualSpend":{"shape":"Spend"}, "ForecastedSpend":{"shape":"Spend"} }, "documentation":"A structure holds the actual and forecasted spend for a budget." }, "ComparisonOperator":{ "type":"string", "documentation":"The comparison operator of a notification. Currently we support less than, equal to and greater than.", "enum":[ "GREATER_THAN", "LESS_THAN", "EQUAL_TO" ] }, "CostFilters":{ "type":"map", "key":{"shape":"GenericString"}, "value":{"shape":"DimensionValues"}, "documentation":"A map represents the cost filters applied to the budget." }, "CostTypes":{ "type":"structure", "required":[ "IncludeTax", "IncludeSubscription", "UseBlended" ], "members":{ "IncludeTax":{"shape":"GenericBoolean"}, "IncludeSubscription":{"shape":"GenericBoolean"}, "UseBlended":{"shape":"GenericBoolean"} }, "documentation":"This includes the options for getting the cost of a budget." }, "CreateBudgetRequest":{ "type":"structure", "required":[ "AccountId", "Budget" ], "members":{ "AccountId":{"shape":"AccountId"}, "Budget":{"shape":"Budget"}, "NotificationsWithSubscribers":{"shape":"NotificationWithSubscribersList"} }, "documentation":"Request of CreateBudget" }, "CreateBudgetResponse":{ "type":"structure", "members":{ }, "documentation":"Response of CreateBudget" }, "CreateNotificationRequest":{ "type":"structure", "required":[ "AccountId", "BudgetName", "Notification", "Subscribers" ], "members":{ "AccountId":{"shape":"AccountId"}, "BudgetName":{"shape":"BudgetName"}, "Notification":{"shape":"Notification"}, "Subscribers":{"shape":"Subscribers"} }, "documentation":"Request of CreateNotification" }, "CreateNotificationResponse":{ "type":"structure", "members":{ }, "documentation":"Response of CreateNotification" }, "CreateSubscriberRequest":{ "type":"structure", "required":[ "AccountId", "BudgetName", "Notification", "Subscriber" ], "members":{ "AccountId":{"shape":"AccountId"}, "BudgetName":{"shape":"BudgetName"}, "Notification":{"shape":"Notification"}, "Subscriber":{"shape":"Subscriber"} }, "documentation":"Request of CreateSubscriber" }, "CreateSubscriberResponse":{ "type":"structure", "members":{ }, "documentation":"Response of CreateSubscriber" }, "CreationLimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"errorMessage"} }, "documentation":"The exception is thrown when customer tries to create a record (e.g. budget), but the number this record already exceeds the limitation.", "exception":true }, "DeleteBudgetRequest":{ "type":"structure", "required":[ "AccountId", "BudgetName" ], "members":{ "AccountId":{"shape":"AccountId"}, "BudgetName":{"shape":"BudgetName"} }, "documentation":"Request of DeleteBudget" }, "DeleteBudgetResponse":{ "type":"structure", "members":{ }, "documentation":"Response of DeleteBudget" }, "DeleteNotificationRequest":{ "type":"structure", "required":[ "AccountId", "BudgetName", "Notification" ], "members":{ "AccountId":{"shape":"AccountId"}, "BudgetName":{"shape":"BudgetName"}, "Notification":{"shape":"Notification"} }, "documentation":"Request of DeleteNotification" }, "DeleteNotificationResponse":{ "type":"structure", "members":{ }, "documentation":"Response of DeleteNotification" }, "DeleteSubscriberRequest":{ "type":"structure", "required":[ "AccountId", "BudgetName", "Notification", "Subscriber" ], "members":{ "AccountId":{"shape":"AccountId"}, "BudgetName":{"shape":"BudgetName"}, "Notification":{"shape":"Notification"}, "Subscriber":{"shape":"Subscriber"} }, "documentation":"Request of DeleteSubscriber" }, "DeleteSubscriberResponse":{ "type":"structure", "members":{ }, "documentation":"Response of DeleteSubscriber" }, "DescribeBudgetRequest":{ "type":"structure", "required":[ "AccountId", "BudgetName" ], "members":{ "AccountId":{"shape":"AccountId"}, "BudgetName":{"shape":"BudgetName"} }, "documentation":"Request of DescribeBudget" }, "DescribeBudgetResponse":{ "type":"structure", "members":{ "Budget":{"shape":"Budget"} }, "documentation":"Response of DescribeBudget" }, "DescribeBudgetsRequest":{ "type":"structure", "required":["AccountId"], "members":{ "AccountId":{"shape":"AccountId"}, "MaxResults":{"shape":"MaxResults"}, "NextToken":{"shape":"GenericString"} }, "documentation":"Request of DescribeBudgets" }, "DescribeBudgetsResponse":{ "type":"structure", "members":{ "Budgets":{"shape":"Budgets"}, "NextToken":{"shape":"GenericString"} }, "documentation":"Response of DescribeBudgets" }, "DescribeNotificationsForBudgetRequest":{ "type":"structure", "required":[ "AccountId", "BudgetName" ], "members":{ "AccountId":{"shape":"AccountId"}, "BudgetName":{"shape":"BudgetName"}, "MaxResults":{"shape":"MaxResults"}, "NextToken":{"shape":"GenericString"} }, "documentation":"Request of DescribeNotificationsForBudget" }, "DescribeNotificationsForBudgetResponse":{ "type":"structure", "members":{ "Notifications":{"shape":"Notifications"}, "NextToken":{"shape":"GenericString"} }, "documentation":"Response of GetNotificationsForBudget" }, "DescribeSubscribersForNotificationRequest":{ "type":"structure", "required":[ "AccountId", "BudgetName", "Notification" ], "members":{ "AccountId":{"shape":"AccountId"}, "BudgetName":{"shape":"BudgetName"}, "Notification":{"shape":"Notification"}, "MaxResults":{"shape":"MaxResults"}, "NextToken":{"shape":"GenericString"} }, "documentation":"Request of DescribeSubscribersForNotification" }, "DescribeSubscribersForNotificationResponse":{ "type":"structure", "members":{ "Subscribers":{"shape":"Subscribers"}, "NextToken":{"shape":"GenericString"} }, "documentation":"Response of DescribeSubscribersForNotification" }, "DimensionValues":{ "type":"list", "member":{"shape":"GenericString"} }, "DuplicateRecordException":{ "type":"structure", "members":{ "Message":{"shape":"errorMessage"} }, "documentation":"The exception is thrown when customer tries to create a record (e.g. budget) that already exists.", "exception":true }, "ExpiredNextTokenException":{ "type":"structure", "members":{ "Message":{"shape":"errorMessage"} }, "documentation":"This exception is thrown if the paging token is expired - past its TTL", "exception":true }, "GenericBoolean":{ "type":"boolean", "documentation":"A generic boolean value." }, "GenericString":{ "type":"string", "documentation":"A generic String." }, "GenericTimestamp":{ "type":"timestamp", "documentation":"A generic timestamp. In Java it is transformed to a Date object." }, "InternalErrorException":{ "type":"structure", "members":{ "Message":{"shape":"errorMessage"} }, "documentation":"This exception is thrown on an unknown internal failure.", "exception":true }, "InvalidNextTokenException":{ "type":"structure", "members":{ "Message":{"shape":"errorMessage"} }, "documentation":"This exception is thrown if paging token signature didn't match the token, or the paging token isn't for this request", "exception":true }, "InvalidParameterException":{ "type":"structure", "members":{ "Message":{"shape":"errorMessage"} }, "documentation":"This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.", "exception":true }, "MaxResults":{ "type":"integer", "documentation":"An integer to represent how many entries should a pagianted response contains. Maxium is set to 100.", "box":true, "max":100, "min":1 }, "NotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"errorMessage"} }, "documentation":"This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.", "exception":true }, "Notification":{ "type":"structure", "required":[ "NotificationType", "ComparisonOperator", "Threshold" ], "members":{ "NotificationType":{"shape":"NotificationType"}, "ComparisonOperator":{"shape":"ComparisonOperator"}, "Threshold":{"shape":"NotificationThreshold"} }, "documentation":"Notification model. Each budget may contain multiple notifications with different settings." }, "NotificationThreshold":{ "type":"double", "documentation":"The threshold of the a notification. It should be a number between 0 and 100.", "max":100, "min":0.1 }, "NotificationType":{ "type":"string", "documentation":"The type of a notification. It should be ACTUAL or FORECASTED.", "enum":[ "ACTUAL", "FORECASTED" ] }, "NotificationWithSubscribers":{ "type":"structure", "required":[ "Notification", "Subscribers" ], "members":{ "Notification":{"shape":"Notification"}, "Subscribers":{"shape":"Subscribers"} }, "documentation":"A structure to relate notification and a list of subscribers who belong to the notification." }, "NotificationWithSubscribersList":{ "type":"list", "member":{"shape":"NotificationWithSubscribers"}, "documentation":"A list of Notifications, each with a list of subscribers.", "max":5 }, "Notifications":{ "type":"list", "member":{"shape":"Notification"}, "documentation":"A list of notifications." }, "NumericValue":{ "type":"string", "documentation":"A string to represent NumericValue.", "pattern":"[0-9]+(\\.)?[0-9]*" }, "Spend":{ "type":"structure", "required":[ "Amount", "Unit" ], "members":{ "Amount":{"shape":"NumericValue"}, "Unit":{"shape":"GenericString"} }, "documentation":"A structure represent either a cost spend or usage spend. Contains an amount and a unit." }, "Subscriber":{ "type":"structure", "required":[ "SubscriptionType", "Address" ], "members":{ "SubscriptionType":{"shape":"SubscriptionType"}, "Address":{"shape":"GenericString"} }, "documentation":"Subscriber model. Each notification may contain multiple subscribers with different addresses." }, "Subscribers":{ "type":"list", "member":{"shape":"Subscriber"}, "documentation":"A list of subscribers.", "max":11, "min":1 }, "SubscriptionType":{ "type":"string", "documentation":"The subscription type of the subscriber. It can be SMS or EMAIL.", "enum":[ "SNS", "EMAIL" ] }, "TimePeriod":{ "type":"structure", "required":[ "Start", "End" ], "members":{ "Start":{"shape":"GenericTimestamp"}, "End":{"shape":"GenericTimestamp"} }, "documentation":"A time period indicated the start date and end date of a budget." }, "TimeUnit":{ "type":"string", "documentation":"The time unit of the budget. e.g. weekly, monthly, etc.", "enum":[ "MONTHLY", "QUARTERLY", "ANNUALLY" ] }, "UpdateBudgetRequest":{ "type":"structure", "required":[ "AccountId", "NewBudget" ], "members":{ "AccountId":{"shape":"AccountId"}, "NewBudget":{"shape":"Budget"} }, "documentation":"Request of UpdateBudget" }, "UpdateBudgetResponse":{ "type":"structure", "members":{ }, "documentation":"Response of UpdateBudget" }, "UpdateNotificationRequest":{ "type":"structure", "required":[ "AccountId", "BudgetName", "OldNotification", "NewNotification" ], "members":{ "AccountId":{"shape":"AccountId"}, "BudgetName":{"shape":"BudgetName"}, "OldNotification":{"shape":"Notification"}, "NewNotification":{"shape":"Notification"} }, "documentation":"Request of UpdateNotification" }, "UpdateNotificationResponse":{ "type":"structure", "members":{ }, "documentation":"Response of UpdateNotification" }, "UpdateSubscriberRequest":{ "type":"structure", "required":[ "AccountId", "BudgetName", "Notification", "OldSubscriber", "NewSubscriber" ], "members":{ "AccountId":{"shape":"AccountId"}, "BudgetName":{"shape":"BudgetName"}, "Notification":{"shape":"Notification"}, "OldSubscriber":{"shape":"Subscriber"}, "NewSubscriber":{"shape":"Subscriber"} }, "documentation":"Request of UpdateSubscriber" }, "UpdateSubscriberResponse":{ "type":"structure", "members":{ }, "documentation":"Response of UpdateSubscriber" }, "errorMessage":{ "type":"string", "documentation":"The error message the exception carries." } }, "documentation":"All public APIs for AWS Budgets" } botocore-1.5.7/botocore/data/elasticache/0000777454262600001440000000000013042511307021400 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/elasticache/2015-02-02/0000777454262600001440000000000013042511307022425 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/elasticache/2015-02-02/waiters-2.json0000666454262600001440000000720713042511306025142 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "CacheClusterAvailable": { "delay": 30, "operation": "DescribeCacheClusters", "maxAttempts": 60, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "CacheClusters[].CacheClusterStatus" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "CacheClusters[].CacheClusterStatus" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "CacheClusters[].CacheClusterStatus" }, { "expected": "incompatible-network", "matcher": "pathAny", "state": "failure", "argument": "CacheClusters[].CacheClusterStatus" }, { "expected": "restore-failed", "matcher": "pathAny", "state": "failure", "argument": "CacheClusters[].CacheClusterStatus" } ] }, "CacheClusterDeleted": { "delay": 30, "operation": "DescribeCacheClusters", "maxAttempts": 60, "acceptors": [ { "expected": "CacheClusterNotFound", "matcher": "error", "state": "success" }, { "expected": "creating", "matcher": "pathAny", "state": "failure", "argument": "CacheClusters[].CacheClusterStatus" }, { "expected": "modifying", "matcher": "pathAny", "state": "failure", "argument": "CacheClusters[].CacheClusterStatus" }, { "expected": "rebooting", "matcher": "pathAny", "state": "failure", "argument": "CacheClusters[].CacheClusterStatus" } ] }, "ReplicationGroupAvailable": { "delay": 30, "operation": "DescribeReplicationGroups", "maxAttempts": 60, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "ReplicationGroups[].Status" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "ReplicationGroups[].Status" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "ReplicationGroups[].Status" }, { "expected": "incompatible-network", "matcher": "pathAny", "state": "failure", "argument": "ReplicationGroups[].Status" }, { "expected": "restore-failed", "matcher": "pathAny", "state": "failure", "argument": "ReplicationGroups[].Status" } ] }, "ReplicationGroupDeleted": { "delay": 30, "operation": "DescribeReplicationGroups", "maxAttempts": 60, "acceptors": [ { "expected": "ReplicationGroupNotFoundFault", "matcher": "error", "state": "success" }, { "expected": "creating", "matcher": "pathAny", "state": "failure", "argument": "ReplicationGroups[].Status" }, { "expected": "modifying", "matcher": "pathAny", "state": "failure", "argument": "ReplicationGroups[].Status" }, { "expected": "rebooting", "matcher": "pathAny", "state": "failure", "argument": "ReplicationGroups[].Status" } ] } } } botocore-1.5.7/botocore/data/elasticache/2015-02-02/paginators-1.json0000666454262600001440000000417313042511306025631 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeCacheClusters": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheClusters" }, "DescribeCacheEngineVersions": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheEngineVersions" }, "DescribeCacheParameterGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheParameterGroups" }, "DescribeCacheParameters": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Parameters" }, "DescribeCacheSecurityGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheSecurityGroups" }, "DescribeCacheSubnetGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheSubnetGroups" }, "DescribeEngineDefaultParameters": { "input_token": "Marker", "output_token": "EngineDefaults.Marker", "limit_key": "MaxRecords", "result_key": "EngineDefaults.Parameters" }, "DescribeEvents": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Events" }, "DescribeReservedCacheNodes": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReservedCacheNodes" }, "DescribeReservedCacheNodesOfferings": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReservedCacheNodesOfferings" }, "DescribeReplicationGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReplicationGroups" }, "DescribeSnapshots": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Snapshots" } } } botocore-1.5.7/botocore/data/elasticache/2015-02-02/service-2.json0000666454262600001440000064733113042511306025134 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-02-02", "endpointPrefix":"elasticache", "protocol":"query", "serviceFullName":"Amazon ElastiCache", "signatureVersion":"v4", "uid":"elasticache-2015-02-02", "xmlNamespace":"http://elasticache.amazonaws.com/doc/2015-02-02/" }, "operations":{ "AddTagsToResource":{ "name":"AddTagsToResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsToResourceMessage"}, "output":{ "shape":"TagListMessage", "resultWrapper":"AddTagsToResourceResult" }, "errors":[ {"shape":"CacheClusterNotFoundFault"}, {"shape":"SnapshotNotFoundFault"}, {"shape":"TagQuotaPerResourceExceeded"}, {"shape":"InvalidARNFault"} ], "documentation":"

Adds up to 10 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs.

When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.

" }, "AuthorizeCacheSecurityGroupIngress":{ "name":"AuthorizeCacheSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeCacheSecurityGroupIngressMessage"}, "output":{ "shape":"AuthorizeCacheSecurityGroupIngressResult", "resultWrapper":"AuthorizeCacheSecurityGroupIngressResult" }, "errors":[ {"shape":"CacheSecurityGroupNotFoundFault"}, {"shape":"InvalidCacheSecurityGroupStateFault"}, {"shape":"AuthorizationAlreadyExistsFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.

" }, "CopySnapshot":{ "name":"CopySnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopySnapshotMessage"}, "output":{ "shape":"CopySnapshotResult", "resultWrapper":"CopySnapshotResult" }, "errors":[ {"shape":"SnapshotAlreadyExistsFault"}, {"shape":"SnapshotNotFoundFault"}, {"shape":"SnapshotQuotaExceededFault"}, {"shape":"InvalidSnapshotStateFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Makes a copy of an existing snapshot.

This operation is valid for Redis only.

Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.

You could receive the following error messages.

Error Messages

  • Error Message: The S3 bucket %s is outside of the region.

    Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

  • Error Message: The S3 bucket %s does not exist.

    Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

  • Error Message: The S3 bucket %s is not owned by the authenticated user.

    Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

  • Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.

    Solution: Contact your system administrator to get the needed permissions.

  • Error Message: The S3 bucket %s already contains an object with key %s.

    Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.

  • Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.

    Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

  • Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

    Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

  • Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

    Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

" }, "CreateCacheCluster":{ "name":"CreateCacheCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCacheClusterMessage"}, "output":{ "shape":"CreateCacheClusterResult", "resultWrapper":"CreateCacheClusterResult" }, "errors":[ {"shape":"ReplicationGroupNotFoundFault"}, {"shape":"InvalidReplicationGroupStateFault"}, {"shape":"CacheClusterAlreadyExistsFault"}, {"shape":"InsufficientCacheClusterCapacityFault"}, {"shape":"CacheSecurityGroupNotFoundFault"}, {"shape":"CacheSubnetGroupNotFoundFault"}, {"shape":"ClusterQuotaForCustomerExceededFault"}, {"shape":"NodeQuotaForClusterExceededFault"}, {"shape":"NodeQuotaForCustomerExceededFault"}, {"shape":"CacheParameterGroupNotFoundFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"TagQuotaPerResourceExceeded"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis.

Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.

" }, "CreateCacheParameterGroup":{ "name":"CreateCacheParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCacheParameterGroupMessage"}, "output":{ "shape":"CreateCacheParameterGroupResult", "resultWrapper":"CreateCacheParameterGroupResult" }, "errors":[ {"shape":"CacheParameterGroupQuotaExceededFault"}, {"shape":"CacheParameterGroupAlreadyExistsFault"}, {"shape":"InvalidCacheParameterGroupStateFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

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.

" }, "CreateCacheSecurityGroup":{ "name":"CreateCacheSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCacheSecurityGroupMessage"}, "output":{ "shape":"CreateCacheSecurityGroupResult", "resultWrapper":"CreateCacheSecurityGroupResult" }, "errors":[ {"shape":"CacheSecurityGroupAlreadyExistsFault"}, {"shape":"CacheSecurityGroupQuotaExceededFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Creates a new cache security group. Use a cache security group to control access to one or more cache clusters.

Cache security groups are only used when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cache cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.

" }, "CreateCacheSubnetGroup":{ "name":"CreateCacheSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCacheSubnetGroupMessage"}, "output":{ "shape":"CreateCacheSubnetGroupResult", "resultWrapper":"CreateCacheSubnetGroupResult" }, "errors":[ {"shape":"CacheSubnetGroupAlreadyExistsFault"}, {"shape":"CacheSubnetGroupQuotaExceededFault"}, {"shape":"CacheSubnetQuotaExceededFault"}, {"shape":"InvalidSubnet"} ], "documentation":"

Creates a new cache subnet group.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

" }, "CreateReplicationGroup":{ "name":"CreateReplicationGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateReplicationGroupMessage"}, "output":{ "shape":"CreateReplicationGroupResult", "resultWrapper":"CreateReplicationGroupResult" }, "errors":[ {"shape":"CacheClusterNotFoundFault"}, {"shape":"InvalidCacheClusterStateFault"}, {"shape":"ReplicationGroupAlreadyExistsFault"}, {"shape":"InsufficientCacheClusterCapacityFault"}, {"shape":"CacheSecurityGroupNotFoundFault"}, {"shape":"CacheSubnetGroupNotFoundFault"}, {"shape":"ClusterQuotaForCustomerExceededFault"}, {"shape":"NodeQuotaForClusterExceededFault"}, {"shape":"NodeQuotaForCustomerExceededFault"}, {"shape":"CacheParameterGroupNotFoundFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"TagQuotaPerResourceExceeded"}, {"shape":"NodeGroupsPerReplicationGroupQuotaExceededFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

A Redis (cluster mode disabled) replication group is a collection of cache clusters, where one of the cache clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

A Redis (cluster mode enabled) replication group is a collection of 1 to 15 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).

When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created.

This operation is valid for Redis only.

" }, "CreateSnapshot":{ "name":"CreateSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSnapshotMessage"}, "output":{ "shape":"CreateSnapshotResult", "resultWrapper":"CreateSnapshotResult" }, "errors":[ {"shape":"SnapshotAlreadyExistsFault"}, {"shape":"CacheClusterNotFoundFault"}, {"shape":"ReplicationGroupNotFoundFault"}, {"shape":"InvalidCacheClusterStateFault"}, {"shape":"InvalidReplicationGroupStateFault"}, {"shape":"SnapshotQuotaExceededFault"}, {"shape":"SnapshotFeatureNotSupportedFault"}, {"shape":"InvalidParameterCombinationException"}, {"shape":"InvalidParameterValueException"} ], "documentation":"

Creates a copy of an entire cache cluster or replication group at a specific moment in time.

This operation is valid for Redis only.

" }, "DeleteCacheCluster":{ "name":"DeleteCacheCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCacheClusterMessage"}, "output":{ "shape":"DeleteCacheClusterResult", "resultWrapper":"DeleteCacheClusterResult" }, "errors":[ {"shape":"CacheClusterNotFoundFault"}, {"shape":"InvalidCacheClusterStateFault"}, {"shape":"SnapshotAlreadyExistsFault"}, {"shape":"SnapshotFeatureNotSupportedFault"}, {"shape":"SnapshotQuotaExceededFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Deletes a previously provisioned cache cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this operation.

This operation cannot be used to delete a cache cluster that is the last read replica of a replication group or node group (shard) that has Multi-AZ mode enabled or a cache cluster from a Redis (cluster mode enabled) replication group.

Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.

" }, "DeleteCacheParameterGroup":{ "name":"DeleteCacheParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCacheParameterGroupMessage"}, "errors":[ {"shape":"InvalidCacheParameterGroupStateFault"}, {"shape":"CacheParameterGroupNotFoundFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.

" }, "DeleteCacheSecurityGroup":{ "name":"DeleteCacheSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCacheSecurityGroupMessage"}, "errors":[ {"shape":"InvalidCacheSecurityGroupStateFault"}, {"shape":"CacheSecurityGroupNotFoundFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Deletes a cache security group.

You cannot delete a cache security group if it is associated with any cache clusters.

" }, "DeleteCacheSubnetGroup":{ "name":"DeleteCacheSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCacheSubnetGroupMessage"}, "errors":[ {"shape":"CacheSubnetGroupInUse"}, {"shape":"CacheSubnetGroupNotFoundFault"} ], "documentation":"

Deletes a cache subnet group.

You cannot delete a cache subnet group if it is associated with any cache clusters.

" }, "DeleteReplicationGroup":{ "name":"DeleteReplicationGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteReplicationGroupMessage"}, "output":{ "shape":"DeleteReplicationGroupResult", "resultWrapper":"DeleteReplicationGroupResult" }, "errors":[ {"shape":"ReplicationGroupNotFoundFault"}, {"shape":"InvalidReplicationGroupStateFault"}, {"shape":"SnapshotAlreadyExistsFault"}, {"shape":"SnapshotFeatureNotSupportedFault"}, {"shape":"SnapshotQuotaExceededFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

This operation is valid for Redis only.

" }, "DeleteSnapshot":{ "name":"DeleteSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSnapshotMessage"}, "output":{ "shape":"DeleteSnapshotResult", "resultWrapper":"DeleteSnapshotResult" }, "errors":[ {"shape":"SnapshotNotFoundFault"}, {"shape":"InvalidSnapshotStateFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.

This operation is valid for Redis only.

" }, "DescribeCacheClusters":{ "name":"DescribeCacheClusters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCacheClustersMessage"}, "output":{ "shape":"CacheClusterMessage", "resultWrapper":"DescribeCacheClustersResult" }, "errors":[ {"shape":"CacheClusterNotFoundFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.

By default, abbreviated information about the cache clusters are returned. You can use the optional ShowDetails flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the CREATING state, only cluster-level information is displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster-level information is displayed.

If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cache cluster state is available, the cluster is ready for use.

If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.

" }, "DescribeCacheEngineVersions":{ "name":"DescribeCacheEngineVersions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCacheEngineVersionsMessage"}, "output":{ "shape":"CacheEngineVersionMessage", "resultWrapper":"DescribeCacheEngineVersionsResult" }, "documentation":"

Returns a list of the available cache engines and their versions.

" }, "DescribeCacheParameterGroups":{ "name":"DescribeCacheParameterGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCacheParameterGroupsMessage"}, "output":{ "shape":"CacheParameterGroupsMessage", "resultWrapper":"DescribeCacheParameterGroupsResult" }, "errors":[ {"shape":"CacheParameterGroupNotFoundFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.

" }, "DescribeCacheParameters":{ "name":"DescribeCacheParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCacheParametersMessage"}, "output":{ "shape":"CacheParameterGroupDetails", "resultWrapper":"DescribeCacheParametersResult" }, "errors":[ {"shape":"CacheParameterGroupNotFoundFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Returns the detailed parameter list for a particular cache parameter group.

" }, "DescribeCacheSecurityGroups":{ "name":"DescribeCacheSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCacheSecurityGroupsMessage"}, "output":{ "shape":"CacheSecurityGroupMessage", "resultWrapper":"DescribeCacheSecurityGroupsResult" }, "errors":[ {"shape":"CacheSecurityGroupNotFoundFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group.

" }, "DescribeCacheSubnetGroups":{ "name":"DescribeCacheSubnetGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCacheSubnetGroupsMessage"}, "output":{ "shape":"CacheSubnetGroupMessage", "resultWrapper":"DescribeCacheSubnetGroupsResult" }, "errors":[ {"shape":"CacheSubnetGroupNotFoundFault"} ], "documentation":"

Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.

" }, "DescribeEngineDefaultParameters":{ "name":"DescribeEngineDefaultParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEngineDefaultParametersMessage"}, "output":{ "shape":"DescribeEngineDefaultParametersResult", "resultWrapper":"DescribeEngineDefaultParametersResult" }, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Returns the default engine and system parameter information for the specified cache engine.

" }, "DescribeEvents":{ "name":"DescribeEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventsMessage"}, "output":{ "shape":"EventsMessage", "resultWrapper":"DescribeEventsResult" }, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter.

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

" }, "DescribeReplicationGroups":{ "name":"DescribeReplicationGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReplicationGroupsMessage"}, "output":{ "shape":"ReplicationGroupMessage", "resultWrapper":"DescribeReplicationGroupsResult" }, "errors":[ {"shape":"ReplicationGroupNotFoundFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

This operation is valid for Redis only.

" }, "DescribeReservedCacheNodes":{ "name":"DescribeReservedCacheNodes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedCacheNodesMessage"}, "output":{ "shape":"ReservedCacheNodeMessage", "resultWrapper":"DescribeReservedCacheNodesResult" }, "errors":[ {"shape":"ReservedCacheNodeNotFoundFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Returns information about reserved cache nodes for this account, or about a specified reserved cache node.

" }, "DescribeReservedCacheNodesOfferings":{ "name":"DescribeReservedCacheNodesOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedCacheNodesOfferingsMessage"}, "output":{ "shape":"ReservedCacheNodesOfferingMessage", "resultWrapper":"DescribeReservedCacheNodesOfferingsResult" }, "errors":[ {"shape":"ReservedCacheNodesOfferingNotFoundFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Lists available reserved cache node offerings.

" }, "DescribeSnapshots":{ "name":"DescribeSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotsMessage"}, "output":{ "shape":"DescribeSnapshotsListMessage", "resultWrapper":"DescribeSnapshotsResult" }, "errors":[ {"shape":"CacheClusterNotFoundFault"}, {"shape":"SnapshotNotFoundFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Returns information about cache cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

This operation is valid for Redis only.

" }, "ListAllowedNodeTypeModifications":{ "name":"ListAllowedNodeTypeModifications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAllowedNodeTypeModificationsMessage"}, "output":{ "shape":"AllowedNodeTypeModificationsMessage", "resultWrapper":"ListAllowedNodeTypeModificationsResult" }, "errors":[ {"shape":"CacheClusterNotFoundFault"}, {"shape":"ReplicationGroupNotFoundFault"}, {"shape":"InvalidParameterCombinationException"}, {"shape":"InvalidParameterValueException"} ], "documentation":"

Lists all available node types that you can scale your Redis cluster's or replication group's current node type up to.

When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale up your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceMessage"}, "output":{ "shape":"TagListMessage", "resultWrapper":"ListTagsForResourceResult" }, "errors":[ {"shape":"CacheClusterNotFoundFault"}, {"shape":"SnapshotNotFoundFault"}, {"shape":"InvalidARNFault"} ], "documentation":"

Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs.

You can have a maximum of 10 cost allocation tags on an ElastiCache resource. For more information, see Using Cost Allocation Tags in Amazon ElastiCache.

" }, "ModifyCacheCluster":{ "name":"ModifyCacheCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyCacheClusterMessage"}, "output":{ "shape":"ModifyCacheClusterResult", "resultWrapper":"ModifyCacheClusterResult" }, "errors":[ {"shape":"InvalidCacheClusterStateFault"}, {"shape":"InvalidCacheSecurityGroupStateFault"}, {"shape":"InsufficientCacheClusterCapacityFault"}, {"shape":"CacheClusterNotFoundFault"}, {"shape":"NodeQuotaForClusterExceededFault"}, {"shape":"NodeQuotaForCustomerExceededFault"}, {"shape":"CacheSecurityGroupNotFoundFault"}, {"shape":"CacheParameterGroupNotFoundFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.

" }, "ModifyCacheParameterGroup":{ "name":"ModifyCacheParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyCacheParameterGroupMessage"}, "output":{ "shape":"CacheParameterGroupNameMessage", "resultWrapper":"ModifyCacheParameterGroupResult" }, "errors":[ {"shape":"CacheParameterGroupNotFoundFault"}, {"shape":"InvalidCacheParameterGroupStateFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

" }, "ModifyCacheSubnetGroup":{ "name":"ModifyCacheSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyCacheSubnetGroupMessage"}, "output":{ "shape":"ModifyCacheSubnetGroupResult", "resultWrapper":"ModifyCacheSubnetGroupResult" }, "errors":[ {"shape":"CacheSubnetGroupNotFoundFault"}, {"shape":"CacheSubnetQuotaExceededFault"}, {"shape":"SubnetInUse"}, {"shape":"InvalidSubnet"} ], "documentation":"

Modifies an existing cache subnet group.

" }, "ModifyReplicationGroup":{ "name":"ModifyReplicationGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyReplicationGroupMessage"}, "output":{ "shape":"ModifyReplicationGroupResult", "resultWrapper":"ModifyReplicationGroupResult" }, "errors":[ {"shape":"ReplicationGroupNotFoundFault"}, {"shape":"InvalidReplicationGroupStateFault"}, {"shape":"InvalidCacheClusterStateFault"}, {"shape":"InvalidCacheSecurityGroupStateFault"}, {"shape":"InsufficientCacheClusterCapacityFault"}, {"shape":"CacheClusterNotFoundFault"}, {"shape":"NodeQuotaForClusterExceededFault"}, {"shape":"NodeQuotaForCustomerExceededFault"}, {"shape":"CacheSecurityGroupNotFoundFault"}, {"shape":"CacheParameterGroupNotFoundFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Modifies the settings for a replication group.

Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.

This operation is valid for Redis only.

" }, "PurchaseReservedCacheNodesOffering":{ "name":"PurchaseReservedCacheNodesOffering", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseReservedCacheNodesOfferingMessage"}, "output":{ "shape":"PurchaseReservedCacheNodesOfferingResult", "resultWrapper":"PurchaseReservedCacheNodesOfferingResult" }, "errors":[ {"shape":"ReservedCacheNodesOfferingNotFoundFault"}, {"shape":"ReservedCacheNodeAlreadyExistsFault"}, {"shape":"ReservedCacheNodeQuotaExceededFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Allows you to purchase a reserved cache node offering.

" }, "RebootCacheCluster":{ "name":"RebootCacheCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootCacheClusterMessage"}, "output":{ "shape":"RebootCacheClusterResult", "resultWrapper":"RebootCacheClusterResult" }, "errors":[ {"shape":"InvalidCacheClusterStateFault"}, {"shape":"CacheClusterNotFoundFault"} ], "documentation":"

Reboots some, or all, of the cache nodes within a provisioned cache cluster. This operation applies any modified cache parameter groups to the cache cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cache cluster. During the reboot, the cache cluster status is set to REBOOTING.

The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

When the reboot is complete, a cache cluster event is created.

" }, "RemoveTagsFromResource":{ "name":"RemoveTagsFromResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTagsFromResourceMessage"}, "output":{ "shape":"TagListMessage", "resultWrapper":"RemoveTagsFromResourceResult" }, "errors":[ {"shape":"CacheClusterNotFoundFault"}, {"shape":"SnapshotNotFoundFault"}, {"shape":"InvalidARNFault"}, {"shape":"TagNotFoundFault"} ], "documentation":"

Removes the tags identified by the TagKeys list from the named resource.

" }, "ResetCacheParameterGroup":{ "name":"ResetCacheParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetCacheParameterGroupMessage"}, "output":{ "shape":"CacheParameterGroupNameMessage", "resultWrapper":"ResetCacheParameterGroupResult" }, "errors":[ {"shape":"InvalidCacheParameterGroupStateFault"}, {"shape":"CacheParameterGroupNotFoundFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.

" }, "RevokeCacheSecurityGroupIngress":{ "name":"RevokeCacheSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeCacheSecurityGroupIngressMessage"}, "output":{ "shape":"RevokeCacheSecurityGroupIngressResult", "resultWrapper":"RevokeCacheSecurityGroupIngressResult" }, "errors":[ {"shape":"CacheSecurityGroupNotFoundFault"}, {"shape":"AuthorizationNotFoundFault"}, {"shape":"InvalidCacheSecurityGroupStateFault"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], "documentation":"

Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.

" } }, "shapes":{ "AZMode":{ "type":"string", "enum":[ "single-az", "cross-az" ] }, "AddTagsToResourceMessage":{ "type":"structure", "required":[ "ResourceName", "Tags" ], "members":{ "ResourceName":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

" } }, "documentation":"

Represents the input of an AddTagsToResource operation.

" }, "AllowedNodeTypeModificationsMessage":{ "type":"structure", "members":{ "ScaleUpModifications":{"shape":"NodeTypeList"} } }, "AuthorizationAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

The specified Amazon EC2 security group is already authorized for the specified cache security group.

", "error":{ "code":"AuthorizationAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "AuthorizationNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The specified Amazon EC2 security group is not authorized for the specified cache security group.

", "error":{ "code":"AuthorizationNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "AuthorizeCacheSecurityGroupIngressMessage":{ "type":"structure", "required":[ "CacheSecurityGroupName", "EC2SecurityGroupName", "EC2SecurityGroupOwnerId" ], "members":{ "CacheSecurityGroupName":{ "shape":"String", "documentation":"

The cache security group that allows network ingress.

" }, "EC2SecurityGroupName":{ "shape":"String", "documentation":"

The Amazon EC2 security group to be authorized for ingress to the cache security group.

" }, "EC2SecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.

" } }, "documentation":"

Represents the input of an AuthorizeCacheSecurityGroupIngress operation.

" }, "AuthorizeCacheSecurityGroupIngressResult":{ "type":"structure", "members":{ "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} } }, "AutomaticFailoverStatus":{ "type":"string", "enum":[ "enabled", "disabled", "enabling", "disabling" ] }, "AvailabilityZone":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the Availability Zone.

" } }, "documentation":"

Describes an Availability Zone in which the cache cluster is launched.

", "wrapper":true }, "AvailabilityZonesList":{ "type":"list", "member":{ "shape":"String", "locationName":"AvailabilityZone" } }, "AwsQueryErrorMessage":{"type":"string"}, "Boolean":{"type":"boolean"}, "BooleanOptional":{"type":"boolean"}, "CacheCluster":{ "type":"structure", "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.

" }, "ConfigurationEndpoint":{"shape":"Endpoint"}, "ClientDownloadLandingPage":{ "shape":"String", "documentation":"

The URL of the web page where you can download the latest ElastiCache client library.

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The name of the compute and memory capacity node type for the cache cluster.

Valid node types are as follows:

  • General purpose:

    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

  • Compute optimized: cache.c1.xlarge

  • Memory optimized:

    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

" }, "Engine":{ "shape":"String", "documentation":"

The name of the cache engine (memcached or redis) to be used for this cache cluster.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version of the cache engine that is used in this cache cluster.

" }, "CacheClusterStatus":{ "shape":"String", "documentation":"

The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.

" }, "NumCacheNodes":{ "shape":"IntegerOptional", "documentation":"

The number of cache nodes in the cache cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

" }, "PreferredAvailabilityZone":{ "shape":"String", "documentation":"

The name of the Availability Zone in which the cache cluster is located or \"Multiple\" if the cache nodes are located in different Availability Zones.

" }, "CacheClusterCreateTime":{ "shape":"TStamp", "documentation":"

The date and time when the cache cluster was created.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

" }, "PendingModifiedValues":{"shape":"PendingModifiedValues"}, "NotificationConfiguration":{"shape":"NotificationConfiguration"}, "CacheSecurityGroups":{ "shape":"CacheSecurityGroupMembershipList", "documentation":"

A list of cache security group elements, composed of name and status sub-elements.

" }, "CacheParameterGroup":{"shape":"CacheParameterGroupStatus"}, "CacheSubnetGroupName":{ "shape":"String", "documentation":"

The name of the cache subnet group associated with the cache cluster.

" }, "CacheNodes":{ "shape":"CacheNodeList", "documentation":"

A list of cache nodes that are members of the cache cluster.

" }, "AutoMinorVersionUpgrade":{ "shape":"Boolean", "documentation":"

This parameter is currently disabled.

" }, "SecurityGroups":{ "shape":"SecurityGroupMembershipList", "documentation":"

A list of VPC Security Groups associated with the cache cluster.

" }, "ReplicationGroupId":{ "shape":"String", "documentation":"

The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.

" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", "documentation":"

The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" }, "SnapshotWindow":{ "shape":"String", "documentation":"

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cache cluster.

Example: 05:00-09:00

" } }, "documentation":"

Contains all of the attributes of a specific cache cluster.

", "wrapper":true }, "CacheClusterAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

You already have a cache cluster with the given identifier.

", "error":{ "code":"CacheClusterAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "CacheClusterList":{ "type":"list", "member":{ "shape":"CacheCluster", "locationName":"CacheCluster" } }, "CacheClusterMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "CacheClusters":{ "shape":"CacheClusterList", "documentation":"

A list of cache clusters. Each item in the list contains detailed information about one cache cluster.

" } }, "documentation":"

Represents the output of a DescribeCacheClusters operation.

" }, "CacheClusterNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

", "error":{ "code":"CacheClusterNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "CacheEngineVersion":{ "type":"structure", "members":{ "Engine":{ "shape":"String", "documentation":"

The name of the cache engine.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the cache engine.

" }, "CacheParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the cache parameter group family associated with this cache engine.

Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2

" }, "CacheEngineDescription":{ "shape":"String", "documentation":"

The description of the cache engine.

" }, "CacheEngineVersionDescription":{ "shape":"String", "documentation":"

The description of the cache engine version.

" } }, "documentation":"

Provides all of the details about a particular cache engine version.

" }, "CacheEngineVersionList":{ "type":"list", "member":{ "shape":"CacheEngineVersion", "locationName":"CacheEngineVersion" } }, "CacheEngineVersionMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "CacheEngineVersions":{ "shape":"CacheEngineVersionList", "documentation":"

A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.

" } }, "documentation":"

Represents the output of a DescribeCacheEngineVersions operation.

" }, "CacheNode":{ "type":"structure", "members":{ "CacheNodeId":{ "shape":"String", "documentation":"

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

" }, "CacheNodeStatus":{ "shape":"String", "documentation":"

The current state of this cache node.

" }, "CacheNodeCreateTime":{ "shape":"TStamp", "documentation":"

The date and time when the cache node was created.

" }, "Endpoint":{ "shape":"Endpoint", "documentation":"

The hostname for connecting to this cache node.

" }, "ParameterGroupStatus":{ "shape":"String", "documentation":"

The status of the parameter group applied to this cache node.

" }, "SourceCacheNodeId":{ "shape":"String", "documentation":"

The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cache cluster.

" }, "CustomerAvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where this node was created and now resides.

" } }, "documentation":"

Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.

Valid node types are as follows:

  • General purpose:

    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

  • Compute optimized: cache.c1.xlarge

  • Memory optimized:

    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

" }, "CacheNodeIdsList":{ "type":"list", "member":{ "shape":"String", "locationName":"CacheNodeId" } }, "CacheNodeList":{ "type":"list", "member":{ "shape":"CacheNode", "locationName":"CacheNode" } }, "CacheNodeTypeSpecificParameter":{ "type":"structure", "members":{ "ParameterName":{ "shape":"String", "documentation":"

The name of the parameter.

" }, "Description":{ "shape":"String", "documentation":"

A description of the parameter.

" }, "Source":{ "shape":"String", "documentation":"

The source of the parameter value.

" }, "DataType":{ "shape":"String", "documentation":"

The valid data type for the parameter.

" }, "AllowedValues":{ "shape":"String", "documentation":"

The valid range of values for the parameter.

" }, "IsModifiable":{ "shape":"Boolean", "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" }, "MinimumEngineVersion":{ "shape":"String", "documentation":"

The earliest cache engine version to which the parameter can apply.

" }, "CacheNodeTypeSpecificValues":{ "shape":"CacheNodeTypeSpecificValueList", "documentation":"

A list of cache node types and their corresponding values for this parameter.

" }, "ChangeType":{ "shape":"ChangeType", "documentation":"

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

" } }, "documentation":"

A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.

" }, "CacheNodeTypeSpecificParametersList":{ "type":"list", "member":{ "shape":"CacheNodeTypeSpecificParameter", "locationName":"CacheNodeTypeSpecificParameter" } }, "CacheNodeTypeSpecificValue":{ "type":"structure", "members":{ "CacheNodeType":{ "shape":"String", "documentation":"

The cache node type for which this value applies.

" }, "Value":{ "shape":"String", "documentation":"

The value for the cache node type.

" } }, "documentation":"

A value that applies only to a certain cache node type.

" }, "CacheNodeTypeSpecificValueList":{ "type":"list", "member":{ "shape":"CacheNodeTypeSpecificValue", "locationName":"CacheNodeTypeSpecificValue" } }, "CacheParameterGroup":{ "type":"structure", "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the cache parameter group.

" }, "CacheParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the cache parameter group family that this cache parameter group is compatible with.

Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2

" }, "Description":{ "shape":"String", "documentation":"

The description for this cache parameter group.

" } }, "documentation":"

Represents the output of a CreateCacheParameterGroup operation.

", "wrapper":true }, "CacheParameterGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

A cache parameter group with the requested name already exists.

", "error":{ "code":"CacheParameterGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "CacheParameterGroupDetails":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

A list of Parameter instances.

" }, "CacheNodeTypeSpecificParameters":{ "shape":"CacheNodeTypeSpecificParametersList", "documentation":"

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

" } }, "documentation":"

Represents the output of a DescribeCacheParameters operation.

" }, "CacheParameterGroupList":{ "type":"list", "member":{ "shape":"CacheParameterGroup", "locationName":"CacheParameterGroup" } }, "CacheParameterGroupNameMessage":{ "type":"structure", "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the cache parameter group.

" } }, "documentation":"

Represents the output of one of the following operations:

  • ModifyCacheParameterGroup

  • ResetCacheParameterGroup

" }, "CacheParameterGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

", "error":{ "code":"CacheParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "CacheParameterGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request cannot be processed because it would exceed the maximum number of cache security groups.

", "error":{ "code":"CacheParameterGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "CacheParameterGroupStatus":{ "type":"structure", "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the cache parameter group.

" }, "ParameterApplyStatus":{ "shape":"String", "documentation":"

The status of parameter updates.

" }, "CacheNodeIdsToReboot":{ "shape":"CacheNodeIdsList", "documentation":"

A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

" } }, "documentation":"

Status of the cache parameter group.

" }, "CacheParameterGroupsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "CacheParameterGroups":{ "shape":"CacheParameterGroupList", "documentation":"

A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.

" } }, "documentation":"

Represents the output of a DescribeCacheParameterGroups operation.

" }, "CacheSecurityGroup":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the cache security group owner.

" }, "CacheSecurityGroupName":{ "shape":"String", "documentation":"

The name of the cache security group.

" }, "Description":{ "shape":"String", "documentation":"

The description of the cache security group.

" }, "EC2SecurityGroups":{ "shape":"EC2SecurityGroupList", "documentation":"

A list of Amazon EC2 security groups that are associated with this cache security group.

" } }, "documentation":"

Represents the output of one of the following operations:

  • AuthorizeCacheSecurityGroupIngress

  • CreateCacheSecurityGroup

  • RevokeCacheSecurityGroupIngress

", "wrapper":true }, "CacheSecurityGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

A cache security group with the specified name already exists.

", "error":{ "code":"CacheSecurityGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "CacheSecurityGroupMembership":{ "type":"structure", "members":{ "CacheSecurityGroupName":{ "shape":"String", "documentation":"

The name of the cache security group.

" }, "Status":{ "shape":"String", "documentation":"

The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

" } }, "documentation":"

Represents a cache cluster's status within a particular cache security group.

" }, "CacheSecurityGroupMembershipList":{ "type":"list", "member":{ "shape":"CacheSecurityGroupMembership", "locationName":"CacheSecurityGroup" } }, "CacheSecurityGroupMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "CacheSecurityGroups":{ "shape":"CacheSecurityGroups", "documentation":"

A list of cache security groups. Each element in the list contains detailed information about one group.

" } }, "documentation":"

Represents the output of a DescribeCacheSecurityGroups operation.

" }, "CacheSecurityGroupNameList":{ "type":"list", "member":{ "shape":"String", "locationName":"CacheSecurityGroupName" } }, "CacheSecurityGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The requested cache security group name does not refer to an existing cache security group.

", "error":{ "code":"CacheSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "CacheSecurityGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache security groups.

", "error":{ "code":"QuotaExceeded.CacheSecurityGroup", "httpStatusCode":400, "senderFault":true }, "exception":true }, "CacheSecurityGroups":{ "type":"list", "member":{ "shape":"CacheSecurityGroup", "locationName":"CacheSecurityGroup" } }, "CacheSubnetGroup":{ "type":"structure", "members":{ "CacheSubnetGroupName":{ "shape":"String", "documentation":"

The name of the cache subnet group.

" }, "CacheSubnetGroupDescription":{ "shape":"String", "documentation":"

The description of the cache subnet group.

" }, "VpcId":{ "shape":"String", "documentation":"

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

" }, "Subnets":{ "shape":"SubnetList", "documentation":"

A list of subnets associated with the cache subnet group.

" } }, "documentation":"

Represents the output of one of the following operations:

  • CreateCacheSubnetGroup

  • ModifyCacheSubnetGroup

", "wrapper":true }, "CacheSubnetGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

The requested cache subnet group name is already in use by an existing cache subnet group.

", "error":{ "code":"CacheSubnetGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "CacheSubnetGroupInUse":{ "type":"structure", "members":{ }, "documentation":"

The requested cache subnet group is currently in use.

", "error":{ "code":"CacheSubnetGroupInUse", "httpStatusCode":400, "senderFault":true }, "exception":true }, "CacheSubnetGroupMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "CacheSubnetGroups":{ "shape":"CacheSubnetGroups", "documentation":"

A list of cache subnet groups. Each element in the list contains detailed information about one group.

" } }, "documentation":"

Represents the output of a DescribeCacheSubnetGroups operation.

" }, "CacheSubnetGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

", "error":{ "code":"CacheSubnetGroupNotFoundFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "CacheSubnetGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache subnet groups.

", "error":{ "code":"CacheSubnetGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "CacheSubnetGroups":{ "type":"list", "member":{ "shape":"CacheSubnetGroup", "locationName":"CacheSubnetGroup" } }, "CacheSubnetQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

", "error":{ "code":"CacheSubnetQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ChangeType":{ "type":"string", "enum":[ "immediate", "requires-reboot" ] }, "ClusterIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"ClusterId" } }, "ClusterQuotaForCustomerExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache clusters per customer.

", "error":{ "code":"ClusterQuotaForCustomerExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "CopySnapshotMessage":{ "type":"structure", "required":[ "SourceSnapshotName", "TargetSnapshotName" ], "members":{ "SourceSnapshotName":{ "shape":"String", "documentation":"

The name of an existing snapshot from which to make a copy.

" }, "TargetSnapshotName":{ "shape":"String", "documentation":"

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

" }, "TargetBucket":{ "shape":"String", "documentation":"

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

" } }, "documentation":"

Represents the input of a CopySnapshotMessage operation.

" }, "CopySnapshotResult":{ "type":"structure", "members":{ "Snapshot":{"shape":"Snapshot"} } }, "CreateCacheClusterMessage":{ "type":"structure", "required":["CacheClusterId"], "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

The node group (shard) identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

" }, "ReplicationGroupId":{ "shape":"String", "documentation":"

Due to current limitations on Redis (cluster mode disabled), this operation or parameter is not supported on Redis (cluster mode enabled) replication groups.

The ID of the replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster is added to the specified replication group as a read replica; otherwise, the cache cluster is a standalone primary that is not part of any replication group.

If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cache cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

This parameter is only valid if the Engine parameter is redis.

" }, "AZMode":{ "shape":"AZMode", "documentation":"

Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

This parameter is only supported for Memcached cache clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

" }, "PreferredAvailabilityZone":{ "shape":"String", "documentation":"

The EC2 Availability Zone in which the cache cluster is created.

All nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

" }, "PreferredAvailabilityZones":{ "shape":"PreferredAvailabilityZoneList", "documentation":"

A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

This option is only supported on Memcached.

If you are creating your cache cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheNodes.

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

" }, "NumCacheNodes":{ "shape":"IntegerOptional", "documentation":"

The initial number of cache nodes that the cache cluster has.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The compute and memory capacity of the nodes in the node group (shard).

Valid node types are as follows:

  • General purpose:

    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

  • Compute optimized: cache.c1.xlarge

  • Memory optimized:

    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

" }, "Engine":{ "shape":"String", "documentation":"

The name of the cache engine to be used for this cache cluster.

Valid values for this parameter are: memcached | redis

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the cache engine to be used for this cache cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cache cluster or replication group and create it anew with the earlier engine version.

" }, "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the parameter group to associate with this cache cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

" }, "CacheSubnetGroupName":{ "shape":"String", "documentation":"

The name of the subnet group to be used for the cache cluster.

Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (Amazon VPC).

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

" }, "CacheSecurityGroupNames":{ "shape":"CacheSecurityGroupNameList", "documentation":"

A list of security group names to associate with this cache cluster.

Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdsList", "documentation":"

One or more VPC security groups associated with the cache cluster.

Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (Amazon VPC).

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

" }, "SnapshotArns":{ "shape":"SnapshotArnsList", "documentation":"

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

" }, "SnapshotName":{ "shape":"String", "documentation":"

The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

This parameter is only valid if the Engine parameter is redis.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which each of the cache nodes accepts connections.

" }, "NotificationTopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cache cluster owner.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

This parameter is currently disabled.

" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", "documentation":"

The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted.

This parameter is only valid if the Engine parameter is redis.

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

" }, "SnapshotWindow":{ "shape":"String", "documentation":"

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Note: This parameter is only valid if the Engine parameter is redis.

" }, "AuthToken":{ "shape":"String", "documentation":"

Reserved parameter. The password used to access a password protected server.

Password constraints:

  • Must be only printable ASCII characters.

  • Must be at least 16 characters and no more than 128 characters in length.

  • Cannot contain any of the following characters: '/', '\"', or \"@\".

For more information, see AUTH password at Redis.

" } }, "documentation":"

Represents the input of a CreateCacheCluster operation.

" }, "CreateCacheClusterResult":{ "type":"structure", "members":{ "CacheCluster":{"shape":"CacheCluster"} } }, "CreateCacheParameterGroupMessage":{ "type":"structure", "required":[ "CacheParameterGroupName", "CacheParameterGroupFamily", "Description" ], "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

A user-specified name for the cache parameter group.

" }, "CacheParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the cache parameter group family that the cache parameter group can be used with.

Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2

" }, "Description":{ "shape":"String", "documentation":"

A user-specified description for the cache parameter group.

" } }, "documentation":"

Represents the input of a CreateCacheParameterGroup operation.

" }, "CreateCacheParameterGroupResult":{ "type":"structure", "members":{ "CacheParameterGroup":{"shape":"CacheParameterGroup"} } }, "CreateCacheSecurityGroupMessage":{ "type":"structure", "required":[ "CacheSecurityGroupName", "Description" ], "members":{ "CacheSecurityGroupName":{ "shape":"String", "documentation":"

A name for the cache security group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word \"Default\".

Example: mysecuritygroup

" }, "Description":{ "shape":"String", "documentation":"

A description for the cache security group.

" } }, "documentation":"

Represents the input of a CreateCacheSecurityGroup operation.

" }, "CreateCacheSecurityGroupResult":{ "type":"structure", "members":{ "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} } }, "CreateCacheSubnetGroupMessage":{ "type":"structure", "required":[ "CacheSubnetGroupName", "CacheSubnetGroupDescription", "SubnetIds" ], "members":{ "CacheSubnetGroupName":{ "shape":"String", "documentation":"

A name for the cache subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

" }, "CacheSubnetGroupDescription":{ "shape":"String", "documentation":"

A description for the cache subnet group.

" }, "SubnetIds":{ "shape":"SubnetIdentifierList", "documentation":"

A list of VPC subnet IDs for the cache subnet group.

" } }, "documentation":"

Represents the input of a CreateCacheSubnetGroup operation.

" }, "CreateCacheSubnetGroupResult":{ "type":"structure", "members":{ "CacheSubnetGroup":{"shape":"CacheSubnetGroup"} } }, "CreateReplicationGroupMessage":{ "type":"structure", "required":[ "ReplicationGroupId", "ReplicationGroupDescription" ], "members":{ "ReplicationGroupId":{ "shape":"String", "documentation":"

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

" }, "ReplicationGroupDescription":{ "shape":"String", "documentation":"

A user-created description for the replication group.

" }, "PrimaryClusterId":{ "shape":"String", "documentation":"

The identifier of the cache cluster that serves as the primary for this replication group. This cache cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

" }, "AutomaticFailoverEnabled":{ "shape":"BooleanOptional", "documentation":"

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Default: false

ElastiCache Multi-AZ replication groups is not supported on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled): T1 and T2 node types.

    Redis (cluster mode enabled): T2 node types.

" }, "NumCacheClusters":{ "shape":"IntegerOptional", "documentation":"

The number of clusters this replication group initially has.

This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.

If Multi-AZ is enabled, the value of this parameter must be at least 2.

The maximum permitted value for NumCacheClusters is 6 (primary plus 5 replicas).

" }, "PreferredCacheClusterAZs":{ "shape":"AvailabilityZonesList", "documentation":"

A list of EC2 Availability Zones in which the replication group's cache clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate cache clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheClusters.

Default: system chosen Availability Zones.

" }, "NumNodeGroups":{ "shape":"IntegerOptional", "documentation":"

An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.

Default: 1

" }, "ReplicasPerNodeGroup":{ "shape":"IntegerOptional", "documentation":"

An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

" }, "NodeGroupConfiguration":{ "shape":"NodeGroupConfigurationList", "documentation":"

A list of node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.

If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to configure one node group (shard) or you can omit this parameter.

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The compute and memory capacity of the nodes in the node group (shard).

Valid node types are as follows:

  • General purpose:

    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

  • Compute optimized: cache.c1.xlarge

  • Memory optimized:

    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

" }, "Engine":{ "shape":"String", "documentation":"

The name of the cache engine to be used for the cache clusters in this replication group.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the cache engine to be used for the cache clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cache cluster or replication group and create it anew with the earlier engine version.

" }, "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

  • To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.

  • To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

" }, "CacheSubnetGroupName":{ "shape":"String", "documentation":"

The name of the cache subnet group to be used for the replication group.

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

" }, "CacheSecurityGroupNames":{ "shape":"CacheSecurityGroupNameList", "documentation":"

A list of cache security group names to associate with this replication group.

" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdsList", "documentation":"

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

" }, "SnapshotArns":{ "shape":"SnapshotArnsList", "documentation":"

A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the replication group. The Amazon S3 object name in the ARN cannot contain any commas. The list must match the number of node groups (shards) in the replication group, which means you cannot repartition.

This parameter is only valid if the Engine parameter is redis.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

" }, "SnapshotName":{ "shape":"String", "documentation":"

The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

This parameter is only valid if the Engine parameter is redis.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

Specifies the weekly time range during which maintenance on the cache cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which each member of the replication group accepts connections.

" }, "NotificationTopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cache cluster owner.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

This parameter is currently disabled.

" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", "documentation":"

The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

This parameter is only valid if the Engine parameter is redis.

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

" }, "SnapshotWindow":{ "shape":"String", "documentation":"

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

This parameter is only valid if the Engine parameter is redis.

" }, "AuthToken":{ "shape":"String", "documentation":"

Reserved parameter. The password used to access a password protected server.

Password constraints:

  • Must be only printable ASCII characters.

  • Must be at least 16 characters and no more than 128 characters in length.

  • Cannot contain any of the following characters: '/', '\"', or \"@\".

For more information, see AUTH password at Redis.

" } }, "documentation":"

Represents the input of a CreateReplicationGroup operation.

" }, "CreateReplicationGroupResult":{ "type":"structure", "members":{ "ReplicationGroup":{"shape":"ReplicationGroup"} } }, "CreateSnapshotMessage":{ "type":"structure", "required":["SnapshotName"], "members":{ "ReplicationGroupId":{ "shape":"String", "documentation":"

The identifier of an existing replication group. The snapshot is created from this replication group.

" }, "CacheClusterId":{ "shape":"String", "documentation":"

The identifier of an existing cache cluster. The snapshot is created from this cache cluster.

" }, "SnapshotName":{ "shape":"String", "documentation":"

A name for the snapshot being created.

" } }, "documentation":"

Represents the input of a CreateSnapshot operation.

" }, "CreateSnapshotResult":{ "type":"structure", "members":{ "Snapshot":{"shape":"Snapshot"} } }, "DeleteCacheClusterMessage":{ "type":"structure", "required":["CacheClusterId"], "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

" }, "FinalSnapshotIdentifier":{ "shape":"String", "documentation":"

The user-supplied name of a final cache cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward.

" } }, "documentation":"

Represents the input of a DeleteCacheCluster operation.

" }, "DeleteCacheClusterResult":{ "type":"structure", "members":{ "CacheCluster":{"shape":"CacheCluster"} } }, "DeleteCacheParameterGroupMessage":{ "type":"structure", "required":["CacheParameterGroupName"], "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the cache parameter group to delete.

The specified cache security group must not be associated with any cache clusters.

" } }, "documentation":"

Represents the input of a DeleteCacheParameterGroup operation.

" }, "DeleteCacheSecurityGroupMessage":{ "type":"structure", "required":["CacheSecurityGroupName"], "members":{ "CacheSecurityGroupName":{ "shape":"String", "documentation":"

The name of the cache security group to delete.

You cannot delete the default security group.

" } }, "documentation":"

Represents the input of a DeleteCacheSecurityGroup operation.

" }, "DeleteCacheSubnetGroupMessage":{ "type":"structure", "required":["CacheSubnetGroupName"], "members":{ "CacheSubnetGroupName":{ "shape":"String", "documentation":"

The name of the cache subnet group to delete.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

" } }, "documentation":"

Represents the input of a DeleteCacheSubnetGroup operation.

" }, "DeleteReplicationGroupMessage":{ "type":"structure", "required":["ReplicationGroupId"], "members":{ "ReplicationGroupId":{ "shape":"String", "documentation":"

The identifier for the cluster to be deleted. This parameter is not case sensitive.

" }, "RetainPrimaryCluster":{ "shape":"BooleanOptional", "documentation":"

If set to true, all of the read replicas are deleted, but the primary node is retained.

" }, "FinalSnapshotIdentifier":{ "shape":"String", "documentation":"

The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.

" } }, "documentation":"

Represents the input of a DeleteReplicationGroup operation.

" }, "DeleteReplicationGroupResult":{ "type":"structure", "members":{ "ReplicationGroup":{"shape":"ReplicationGroup"} } }, "DeleteSnapshotMessage":{ "type":"structure", "required":["SnapshotName"], "members":{ "SnapshotName":{ "shape":"String", "documentation":"

The name of the snapshot to be deleted.

" } }, "documentation":"

Represents the input of a DeleteSnapshot operation.

" }, "DeleteSnapshotResult":{ "type":"structure", "members":{ "Snapshot":{"shape":"Snapshot"} } }, "DescribeCacheClustersMessage":{ "type":"structure", "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "ShowCacheNodeInfo":{ "shape":"BooleanOptional", "documentation":"

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

" } }, "documentation":"

Represents the input of a DescribeCacheClusters operation.

" }, "DescribeCacheEngineVersionsMessage":{ "type":"structure", "members":{ "Engine":{ "shape":"String", "documentation":"

The cache engine to return. Valid values: memcached | redis

" }, "EngineVersion":{ "shape":"String", "documentation":"

The cache engine version to return.

Example: 1.4.14

" }, "CacheParameterGroupFamily":{ "shape":"String", "documentation":"

The name of a specific cache parameter group family to return details for.

Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "DefaultOnly":{ "shape":"Boolean", "documentation":"

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

" } }, "documentation":"

Represents the input of a DescribeCacheEngineVersions operation.

" }, "DescribeCacheParameterGroupsMessage":{ "type":"structure", "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of a specific cache parameter group to return details for.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeCacheParameterGroups operation.

" }, "DescribeCacheParametersMessage":{ "type":"structure", "required":["CacheParameterGroupName"], "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of a specific cache parameter group to return details for.

" }, "Source":{ "shape":"String", "documentation":"

The parameter types to return.

Valid values: user | system | engine-default

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeCacheParameters operation.

" }, "DescribeCacheSecurityGroupsMessage":{ "type":"structure", "members":{ "CacheSecurityGroupName":{ "shape":"String", "documentation":"

The name of the cache security group to return details for.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeCacheSecurityGroups operation.

" }, "DescribeCacheSubnetGroupsMessage":{ "type":"structure", "members":{ "CacheSubnetGroupName":{ "shape":"String", "documentation":"

The name of the cache subnet group to return details for.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeCacheSubnetGroups operation.

" }, "DescribeEngineDefaultParametersMessage":{ "type":"structure", "required":["CacheParameterGroupFamily"], "members":{ "CacheParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the cache parameter group family.

Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeEngineDefaultParameters operation.

" }, "DescribeEngineDefaultParametersResult":{ "type":"structure", "members":{ "EngineDefaults":{"shape":"EngineDefaults"} } }, "DescribeEventsMessage":{ "type":"structure", "members":{ "SourceIdentifier":{ "shape":"String", "documentation":"

The identifier of the event source for which events are returned. If not specified, all sources are included in the response.

" }, "SourceType":{ "shape":"SourceType", "documentation":"

The event source to retrieve events for. If no value is specified, all events are returned.

" }, "StartTime":{ "shape":"TStamp", "documentation":"

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

" }, "EndTime":{ "shape":"TStamp", "documentation":"

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

" }, "Duration":{ "shape":"IntegerOptional", "documentation":"

The number of minutes' worth of events to retrieve.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeEvents operation.

" }, "DescribeReplicationGroupsMessage":{ "type":"structure", "members":{ "ReplicationGroupId":{ "shape":"String", "documentation":"

The identifier for the replication group to be described. This parameter is not case sensitive.

If you do not specify this parameter, information about all replication groups is returned.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeReplicationGroups operation.

" }, "DescribeReservedCacheNodesMessage":{ "type":"structure", "members":{ "ReservedCacheNodeId":{ "shape":"String", "documentation":"

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

" }, "ReservedCacheNodesOfferingId":{ "shape":"String", "documentation":"

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

Valid node types are as follows:

  • General purpose:

    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

  • Compute optimized: cache.c1.xlarge

  • Memory optimized:

    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

" }, "Duration":{ "shape":"String", "documentation":"

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" }, "ProductDescription":{ "shape":"String", "documentation":"

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

" }, "OfferingType":{ "shape":"String", "documentation":"

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeReservedCacheNodes operation.

" }, "DescribeReservedCacheNodesOfferingsMessage":{ "type":"structure", "members":{ "ReservedCacheNodesOfferingId":{ "shape":"String", "documentation":"

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.

Valid node types are as follows:

  • General purpose:

    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

  • Compute optimized: cache.c1.xlarge

  • Memory optimized:

    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

" }, "Duration":{ "shape":"String", "documentation":"

Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" }, "ProductDescription":{ "shape":"String", "documentation":"

The product description filter value. Use this parameter to show only the available offerings matching the specified product description.

" }, "OfferingType":{ "shape":"String", "documentation":"

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeReservedCacheNodesOfferings operation.

" }, "DescribeSnapshotsListMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "Snapshots":{ "shape":"SnapshotList", "documentation":"

A list of snapshots. Each item in the list contains detailed information about one snapshot.

" } }, "documentation":"

Represents the output of a DescribeSnapshots operation.

" }, "DescribeSnapshotsMessage":{ "type":"structure", "members":{ "ReplicationGroupId":{ "shape":"String", "documentation":"

A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

" }, "CacheClusterId":{ "shape":"String", "documentation":"

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster are described.

" }, "SnapshotName":{ "shape":"String", "documentation":"

A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.

" }, "SnapshotSource":{ "shape":"String", "documentation":"

If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 50

Constraints: minimum 20; maximum 50.

" }, "ShowNodeGroupConfig":{ "shape":"BooleanOptional", "documentation":"

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

" } }, "documentation":"

Represents the input of a DescribeSnapshotsMessage operation.

" }, "Double":{"type":"double"}, "EC2SecurityGroup":{ "type":"structure", "members":{ "Status":{ "shape":"String", "documentation":"

The status of the Amazon EC2 security group.

" }, "EC2SecurityGroupName":{ "shape":"String", "documentation":"

The name of the Amazon EC2 security group.

" }, "EC2SecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the Amazon EC2 security group owner.

" } }, "documentation":"

Provides ownership and status information for an Amazon EC2 security group.

" }, "EC2SecurityGroupList":{ "type":"list", "member":{ "shape":"EC2SecurityGroup", "locationName":"EC2SecurityGroup" } }, "Endpoint":{ "type":"structure", "members":{ "Address":{ "shape":"String", "documentation":"

The DNS hostname of the cache node.

" }, "Port":{ "shape":"Integer", "documentation":"

The port number that the cache engine is listening on.

" } }, "documentation":"

Represents the information required for client programs to connect to a cache node.

" }, "EngineDefaults":{ "type":"structure", "members":{ "CacheParameterGroupFamily":{ "shape":"String", "documentation":"

Specifies the name of the cache parameter group family to which the engine default parameters apply.

Valid values are: memcached1.4 | redis2.6 | redis2.8 | redis3.2

" }, "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

Contains a list of engine default parameters.

" }, "CacheNodeTypeSpecificParameters":{ "shape":"CacheNodeTypeSpecificParametersList", "documentation":"

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

" } }, "documentation":"

Represents the output of a DescribeEngineDefaultParameters operation.

", "wrapper":true }, "Event":{ "type":"structure", "members":{ "SourceIdentifier":{ "shape":"String", "documentation":"

The identifier for the source of the event. For example, if the event occurred at the cache cluster level, the identifier would be the name of the cache cluster.

" }, "SourceType":{ "shape":"SourceType", "documentation":"

Specifies the origin of this event - a cache cluster, a parameter group, a security group, etc.

" }, "Message":{ "shape":"String", "documentation":"

The text of the event.

" }, "Date":{ "shape":"TStamp", "documentation":"

The date and time when the event occurred.

" } }, "documentation":"

Represents a single occurrence of something interesting within the system. Some examples of events are creating a cache cluster, adding or removing a cache node, or rebooting a node.

" }, "EventList":{ "type":"list", "member":{ "shape":"Event", "locationName":"Event" } }, "EventsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "Events":{ "shape":"EventList", "documentation":"

A list of events. Each element in the list contains detailed information about one event.

" } }, "documentation":"

Represents the output of a DescribeEvents operation.

" }, "InsufficientCacheClusterCapacityFault":{ "type":"structure", "members":{ }, "documentation":"

The requested cache node type is not available in the specified Availability Zone.

", "error":{ "code":"InsufficientCacheClusterCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Integer":{"type":"integer"}, "IntegerOptional":{"type":"integer"}, "InvalidARNFault":{ "type":"structure", "members":{ }, "documentation":"

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

", "error":{ "code":"InvalidARN", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidCacheClusterStateFault":{ "type":"structure", "members":{ }, "documentation":"

The requested cache cluster is not in the available state.

", "error":{ "code":"InvalidCacheClusterState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidCacheParameterGroupStateFault":{ "type":"structure", "members":{ }, "documentation":"

The current state of the cache parameter group does not allow the requested operation to occur.

", "error":{ "code":"InvalidCacheParameterGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidCacheSecurityGroupStateFault":{ "type":"structure", "members":{ }, "documentation":"

The current state of the cache security group does not allow deletion.

", "error":{ "code":"InvalidCacheSecurityGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidParameterCombinationException":{ "type":"structure", "members":{ "message":{ "shape":"AwsQueryErrorMessage", "documentation":"

Two or more parameters that must not be used together were used together.

" } }, "documentation":"

Two or more incompatible parameters were specified.

", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidParameterValueException":{ "type":"structure", "members":{ "message":{ "shape":"AwsQueryErrorMessage", "documentation":"

A parameter value is invalid.

" } }, "documentation":"

The value for a parameter is invalid.

", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidReplicationGroupStateFault":{ "type":"structure", "members":{ }, "documentation":"

The requested replication group is not in the available state.

", "error":{ "code":"InvalidReplicationGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidSnapshotStateFault":{ "type":"structure", "members":{ }, "documentation":"

The current state of the snapshot does not allow the requested operation to occur.

", "error":{ "code":"InvalidSnapshotState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidSubnet":{ "type":"structure", "members":{ }, "documentation":"

An invalid subnet identifier was specified.

", "error":{ "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidVPCNetworkStateFault":{ "type":"structure", "members":{ }, "documentation":"

The VPC network is in an invalid state.

", "error":{ "code":"InvalidVPCNetworkStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "KeyList":{ "type":"list", "member":{"shape":"String"} }, "ListAllowedNodeTypeModificationsMessage":{ "type":"structure", "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

The name of the cache cluster you want to scale up to a larger node instanced type. ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.

You must provide a value for either the CacheClusterId or the ReplicationGroupId.

" }, "ReplicationGroupId":{ "shape":"String", "documentation":"

The name of the replication group want to scale up to a larger node type. ElastiCache uses the replication group id to identify the current node type being used by this replication group, and from that to create a list of node types you can scale up to.

You must provide a value for either the CacheClusterId or the ReplicationGroupId.

" } }, "documentation":"

The input parameters for the ListAllowedNodeTypeModifications operation.

" }, "ListTagsForResourceMessage":{ "type":"structure", "required":["ResourceName"], "members":{ "ResourceName":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" } }, "documentation":"

The input parameters for the ListTagsForResource operation.

" }, "ModifyCacheClusterMessage":{ "type":"structure", "required":["CacheClusterId"], "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

The cache cluster identifier. This value is stored as a lowercase string.

" }, "NumCacheNodes":{ "shape":"IntegerOptional", "documentation":"

The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.

If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).

A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cache cluster.

" }, "CacheNodeIdsToRemove":{ "shape":"CacheNodeIdsList", "documentation":"

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 is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.

" }, "AZMode":{ "shape":"AZMode", "documentation":"

Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.

Valid values: single-az | cross-az.

This option is only supported for Memcached cache clusters.

You cannot specify single-az if the Memcached cache cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

Only newly created nodes are located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

" }, "NewAvailabilityZones":{ "shape":"PreferredAvailabilityZoneList", "documentation":"

The list of Availability Zones where the new Memcached cache nodes are created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

This option is only supported on Memcached clusters.

Scenarios:

  • Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.

  • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.

  • Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

Impact of new add/remove requests upon pending requests

  • Scenario-1

    • Pending Action: Delete

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending delete.

  • Scenario-2

    • Pending Action: Delete

    • New Request: Create

    • Result: The new create, pending or immediate, replaces the pending delete.

  • Scenario-3

    • Pending Action: Create

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending create.

  • Scenario-4

    • Pending Action: Create

    • New Request: Create

    • Result: The new create is added to the pending create.

      Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
" }, "CacheSecurityGroupNames":{ "shape":"CacheSecurityGroupNameList", "documentation":"

A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.

You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".

" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdsList", "documentation":"

Specifies the VPC Security Groups associated with the cache cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

" }, "NotificationTopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

The Amazon SNS topic owner must be same as the cache cluster owner.

" }, "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

" }, "NotificationTopicStatus":{ "shape":"String", "documentation":"

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

" }, "ApplyImmediately":{ "shape":"Boolean", "documentation":"

If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.

If false, changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

Valid values: true | false

Default: false

" }, "EngineVersion":{ "shape":"String", "documentation":"

The upgraded version of the cache engine to be run on the cache nodes.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cache cluster and create it anew with the earlier engine version.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

This parameter is currently disabled.

" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", "documentation":"

The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" }, "SnapshotWindow":{ "shape":"String", "documentation":"

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cache cluster.

" }, "CacheNodeType":{ "shape":"String", "documentation":"

A valid cache node type that you want to scale this cache cluster up to.

" } }, "documentation":"

Represents the input of a ModifyCacheCluster operation.

" }, "ModifyCacheClusterResult":{ "type":"structure", "members":{ "CacheCluster":{"shape":"CacheCluster"} } }, "ModifyCacheParameterGroupMessage":{ "type":"structure", "required":[ "CacheParameterGroupName", "ParameterNameValues" ], "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the cache parameter group to modify.

" }, "ParameterNameValues":{ "shape":"ParameterNameValueList", "documentation":"

An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.

" } }, "documentation":"

Represents the input of a ModifyCacheParameterGroup operation.

" }, "ModifyCacheSubnetGroupMessage":{ "type":"structure", "required":["CacheSubnetGroupName"], "members":{ "CacheSubnetGroupName":{ "shape":"String", "documentation":"

The name for the cache subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

" }, "CacheSubnetGroupDescription":{ "shape":"String", "documentation":"

A description of the cache subnet group.

" }, "SubnetIds":{ "shape":"SubnetIdentifierList", "documentation":"

The EC2 subnet IDs for the cache subnet group.

" } }, "documentation":"

Represents the input of a ModifyCacheSubnetGroup operation.

" }, "ModifyCacheSubnetGroupResult":{ "type":"structure", "members":{ "CacheSubnetGroup":{"shape":"CacheSubnetGroup"} } }, "ModifyReplicationGroupMessage":{ "type":"structure", "required":["ReplicationGroupId"], "members":{ "ReplicationGroupId":{ "shape":"String", "documentation":"

The identifier of the replication group to modify.

" }, "ReplicationGroupDescription":{ "shape":"String", "documentation":"

A description for the replication group. Maximum length is 255 characters.

" }, "PrimaryClusterId":{ "shape":"String", "documentation":"

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

" }, "SnapshottingClusterId":{ "shape":"String", "documentation":"

The cache cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

" }, "AutomaticFailoverEnabled":{ "shape":"BooleanOptional", "documentation":"

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

ElastiCache Multi-AZ replication groups are not supported on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled):T1 and T2 cache node types.

    Redis (cluster mode enabled): T1 node types.

" }, "CacheSecurityGroupNames":{ "shape":"CacheSecurityGroupNameList", "documentation":"

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.

" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdsList", "documentation":"

Specifies the VPC Security Groups associated with the cache clusters in the replication group.

This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

" }, "NotificationTopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

The Amazon SNS topic owner must be same as the replication group owner.

" }, "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

" }, "NotificationTopicStatus":{ "shape":"String", "documentation":"

The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.

Valid values: active | inactive

" }, "ApplyImmediately":{ "shape":"Boolean", "documentation":"

If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

Valid values: true | false

Default: false

" }, "EngineVersion":{ "shape":"String", "documentation":"

The upgraded version of the cache engine to be run on the cache clusters in the replication group.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

This parameter is currently disabled.

" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", "documentation":"

The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" }, "SnapshotWindow":{ "shape":"String", "documentation":"

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

" }, "CacheNodeType":{ "shape":"String", "documentation":"

A valid cache node type that you want to scale this replication group to.

" } }, "documentation":"

Represents the input of a ModifyReplicationGroups operation.

" }, "ModifyReplicationGroupResult":{ "type":"structure", "members":{ "ReplicationGroup":{"shape":"ReplicationGroup"} } }, "NodeGroup":{ "type":"structure", "members":{ "NodeGroupId":{ "shape":"String", "documentation":"

The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 15 node groups numbered 0001 to 0015.

" }, "Status":{ "shape":"String", "documentation":"

The current state of this replication group - creating, available, etc.

" }, "PrimaryEndpoint":{ "shape":"Endpoint", "documentation":"

The endpoint of the primary node in this node group (shard).

" }, "Slots":{ "shape":"String", "documentation":"

The keyspace for this node group (shard).

" }, "NodeGroupMembers":{ "shape":"NodeGroupMemberList", "documentation":"

A list containing information about individual nodes within the node group (shard).

" } }, "documentation":"

Represents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.

" }, "NodeGroupConfiguration":{ "type":"structure", "members":{ "Slots":{ "shape":"String", "documentation":"

A string that specifies the keyspaces as a series of comma separated values. Keyspaces are 0 to 16,383. The string is in the format startkey-endkey.

Example: \"0-3999\"

" }, "ReplicaCount":{ "shape":"IntegerOptional", "documentation":"

The number of read replica nodes in this node group (shard).

" }, "PrimaryAvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where the primary node of this node group (shard) is launched.

" }, "ReplicaAvailabilityZones":{ "shape":"AvailabilityZonesList", "documentation":"

A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.

" } }, "documentation":"

node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.

" }, "NodeGroupConfigurationList":{ "type":"list", "member":{ "shape":"NodeGroupConfiguration", "locationName":"NodeGroupConfiguration" } }, "NodeGroupList":{ "type":"list", "member":{ "shape":"NodeGroup", "locationName":"NodeGroup" } }, "NodeGroupMember":{ "type":"structure", "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

The ID of the cache cluster to which the node belongs.

" }, "CacheNodeId":{ "shape":"String", "documentation":"

The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

" }, "ReadEndpoint":{"shape":"Endpoint"}, "PreferredAvailabilityZone":{ "shape":"String", "documentation":"

The name of the Availability Zone in which the node is located.

" }, "CurrentRole":{ "shape":"String", "documentation":"

The role that is currently assigned to the node - primary or replica.

" } }, "documentation":"

Represents a single node within a node group (shard).

" }, "NodeGroupMemberList":{ "type":"list", "member":{ "shape":"NodeGroupMember", "locationName":"NodeGroupMember" } }, "NodeGroupsPerReplicationGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request cannot be processed because it would exceed the maximum of 15 node groups (shards) in a single replication group.

", "error":{ "code":"NodeGroupsPerReplicationGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "NodeQuotaForClusterExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

", "error":{ "code":"NodeQuotaForClusterExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "NodeQuotaForCustomerExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

", "error":{ "code":"NodeQuotaForCustomerExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "NodeSnapshot":{ "type":"structure", "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

A unique identifier for the source cache cluster.

" }, "NodeGroupId":{ "shape":"String", "documentation":"

A unique identifier for the source node group (shard).

" }, "CacheNodeId":{ "shape":"String", "documentation":"

The cache node identifier for the node in the source cache cluster.

" }, "NodeGroupConfiguration":{ "shape":"NodeGroupConfiguration", "documentation":"

The configuration for the source node group (shard).

" }, "CacheSize":{ "shape":"String", "documentation":"

The size of the cache on the source cache node.

" }, "CacheNodeCreateTime":{ "shape":"TStamp", "documentation":"

The date and time when the cache node was created in the source cache cluster.

" }, "SnapshotCreateTime":{ "shape":"TStamp", "documentation":"

The date and time when the source node's metadata and cache data set was obtained for the snapshot.

" } }, "documentation":"

Represents an individual cache node in a snapshot of a cache cluster.

", "wrapper":true }, "NodeSnapshotList":{ "type":"list", "member":{ "shape":"NodeSnapshot", "locationName":"NodeSnapshot" } }, "NodeTypeList":{ "type":"list", "member":{"shape":"String"} }, "NotificationConfiguration":{ "type":"structure", "members":{ "TopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that identifies the topic.

" }, "TopicStatus":{ "shape":"String", "documentation":"

The current state of the topic.

" } }, "documentation":"

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

" }, "Parameter":{ "type":"structure", "members":{ "ParameterName":{ "shape":"String", "documentation":"

The name of the parameter.

" }, "ParameterValue":{ "shape":"String", "documentation":"

The value of the parameter.

" }, "Description":{ "shape":"String", "documentation":"

A description of the parameter.

" }, "Source":{ "shape":"String", "documentation":"

The source of the parameter.

" }, "DataType":{ "shape":"String", "documentation":"

The valid data type for the parameter.

" }, "AllowedValues":{ "shape":"String", "documentation":"

The valid range of values for the parameter.

" }, "IsModifiable":{ "shape":"Boolean", "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" }, "MinimumEngineVersion":{ "shape":"String", "documentation":"

The earliest cache engine version to which the parameter can apply.

" }, "ChangeType":{ "shape":"ChangeType", "documentation":"

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

" } }, "documentation":"

Describes an individual setting that controls some aspect of ElastiCache behavior.

" }, "ParameterNameValue":{ "type":"structure", "members":{ "ParameterName":{ "shape":"String", "documentation":"

The name of the parameter.

" }, "ParameterValue":{ "shape":"String", "documentation":"

The value of the parameter.

" } }, "documentation":"

Describes a name-value pair that is used to update the value of a parameter.

" }, "ParameterNameValueList":{ "type":"list", "member":{ "shape":"ParameterNameValue", "locationName":"ParameterNameValue" } }, "ParametersList":{ "type":"list", "member":{ "shape":"Parameter", "locationName":"Parameter" } }, "PendingAutomaticFailoverStatus":{ "type":"string", "enum":[ "enabled", "disabled" ] }, "PendingModifiedValues":{ "type":"structure", "members":{ "NumCacheNodes":{ "shape":"IntegerOptional", "documentation":"

The new number of cache nodes for the cache cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

" }, "CacheNodeIdsToRemove":{ "shape":"CacheNodeIdsList", "documentation":"

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.).

" }, "EngineVersion":{ "shape":"String", "documentation":"

The new cache engine version that the cache cluster runs.

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The cache node type that this cache cluster or replication group is scaled to.

" } }, "documentation":"

A group of settings that are applied to the cache cluster in the future, or that are currently being applied.

" }, "PreferredAvailabilityZoneList":{ "type":"list", "member":{ "shape":"String", "locationName":"PreferredAvailabilityZone" } }, "PurchaseReservedCacheNodesOfferingMessage":{ "type":"structure", "required":["ReservedCacheNodesOfferingId"], "members":{ "ReservedCacheNodesOfferingId":{ "shape":"String", "documentation":"

The ID of the reserved cache node offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" }, "ReservedCacheNodeId":{ "shape":"String", "documentation":"

A customer-specified identifier to track this reservation.

The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation.

Example: myreservationID

" }, "CacheNodeCount":{ "shape":"IntegerOptional", "documentation":"

The number of cache node instances to reserve.

Default: 1

" } }, "documentation":"

Represents the input of a PurchaseReservedCacheNodesOffering operation.

" }, "PurchaseReservedCacheNodesOfferingResult":{ "type":"structure", "members":{ "ReservedCacheNode":{"shape":"ReservedCacheNode"} } }, "RebootCacheClusterMessage":{ "type":"structure", "required":[ "CacheClusterId", "CacheNodeIdsToReboot" ], "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

The cache cluster identifier. This parameter is stored as a lowercase string.

" }, "CacheNodeIdsToReboot":{ "shape":"CacheNodeIdsList", "documentation":"

A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.

" } }, "documentation":"

Represents the input of a RebootCacheCluster operation.

" }, "RebootCacheClusterResult":{ "type":"structure", "members":{ "CacheCluster":{"shape":"CacheCluster"} } }, "RecurringCharge":{ "type":"structure", "members":{ "RecurringChargeAmount":{ "shape":"Double", "documentation":"

The monetary amount of the recurring charge.

" }, "RecurringChargeFrequency":{ "shape":"String", "documentation":"

The frequency of the recurring charge.

" } }, "documentation":"

Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.

", "wrapper":true }, "RecurringChargeList":{ "type":"list", "member":{ "shape":"RecurringCharge", "locationName":"RecurringCharge" } }, "RemoveTagsFromResourceMessage":{ "type":"structure", "required":[ "ResourceName", "TagKeys" ], "members":{ "ResourceName":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" }, "TagKeys":{ "shape":"KeyList", "documentation":"

A list of TagKeys identifying the tags you want removed from the named resource.

" } }, "documentation":"

Represents the input of a RemoveTagsFromResource operation.

" }, "ReplicationGroup":{ "type":"structure", "members":{ "ReplicationGroupId":{ "shape":"String", "documentation":"

The identifier for the replication group.

" }, "Description":{ "shape":"String", "documentation":"

The description of the replication group.

" }, "Status":{ "shape":"String", "documentation":"

The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

" }, "PendingModifiedValues":{ "shape":"ReplicationGroupPendingModifiedValues", "documentation":"

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

" }, "MemberClusters":{ "shape":"ClusterIdList", "documentation":"

The names of all the cache clusters that are part of this replication group.

" }, "NodeGroups":{ "shape":"NodeGroupList", "documentation":"

A single element list with information about the nodes in the replication group.

" }, "SnapshottingClusterId":{ "shape":"String", "documentation":"

The cache cluster ID that is used as the daily snapshot source for the replication group.

" }, "AutomaticFailover":{ "shape":"AutomaticFailoverStatus", "documentation":"

Indicates the status of Multi-AZ for this replication group.

ElastiCache Multi-AZ replication groups are not supported on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled):T1 and T2 cache node types.

    Redis (cluster mode enabled): T1 node types.

" }, "ConfigurationEndpoint":{ "shape":"Endpoint", "documentation":"

The configuration endpoint for this replicaiton group. Use the configuration endpoint to connect to this replication group.

" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", "documentation":"

The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" }, "SnapshotWindow":{ "shape":"String", "documentation":"

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

Note: This parameter is only valid if the Engine parameter is redis.

" } }, "documentation":"

Contains all of the attributes of a specific Redis replication group.

", "wrapper":true }, "ReplicationGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

The specified replication group already exists.

", "error":{ "code":"ReplicationGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ReplicationGroupList":{ "type":"list", "member":{ "shape":"ReplicationGroup", "locationName":"ReplicationGroup" } }, "ReplicationGroupMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "ReplicationGroups":{ "shape":"ReplicationGroupList", "documentation":"

A list of replication groups. Each item in the list contains detailed information about one replication group.

" } }, "documentation":"

Represents the output of a DescribeReplicationGroups operation.

" }, "ReplicationGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The specified replication group does not exist.

", "error":{ "code":"ReplicationGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ReplicationGroupPendingModifiedValues":{ "type":"structure", "members":{ "PrimaryClusterId":{ "shape":"String", "documentation":"

The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

" }, "AutomaticFailoverStatus":{ "shape":"PendingAutomaticFailoverStatus", "documentation":"

Indicates the status of Multi-AZ for this Redis replication group.

ElastiCache Multi-AZ replication groups are not supported on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled):T1 and T2 cache node types.

    Redis (cluster mode enabled): T1 node types.

" } }, "documentation":"

The settings to be applied to the Redis replication group, either immediately or during the next maintenance window.

" }, "ReservedCacheNode":{ "type":"structure", "members":{ "ReservedCacheNodeId":{ "shape":"String", "documentation":"

The unique identifier for the reservation.

" }, "ReservedCacheNodesOfferingId":{ "shape":"String", "documentation":"

The offering identifier.

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The cache node type for the reserved cache nodes.

Valid node types are as follows:

  • General purpose:

    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

  • Compute optimized: cache.c1.xlarge

  • Memory optimized:

    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

" }, "StartTime":{ "shape":"TStamp", "documentation":"

The time the reservation started.

" }, "Duration":{ "shape":"Integer", "documentation":"

The duration of the reservation in seconds.

" }, "FixedPrice":{ "shape":"Double", "documentation":"

The fixed price charged for this reserved cache node.

" }, "UsagePrice":{ "shape":"Double", "documentation":"

The hourly price charged for this reserved cache node.

" }, "CacheNodeCount":{ "shape":"Integer", "documentation":"

The number of cache nodes that have been reserved.

" }, "ProductDescription":{ "shape":"String", "documentation":"

The description of the reserved cache node.

" }, "OfferingType":{ "shape":"String", "documentation":"

The offering type of this reserved cache node.

" }, "State":{ "shape":"String", "documentation":"

The state of the reserved cache node.

" }, "RecurringCharges":{ "shape":"RecurringChargeList", "documentation":"

The recurring price charged to run this reserved cache node.

" } }, "documentation":"

Represents the output of a PurchaseReservedCacheNodesOffering operation.

", "wrapper":true }, "ReservedCacheNodeAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

You already have a reservation with the given identifier.

", "error":{ "code":"ReservedCacheNodeAlreadyExists", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ReservedCacheNodeList":{ "type":"list", "member":{ "shape":"ReservedCacheNode", "locationName":"ReservedCacheNode" } }, "ReservedCacheNodeMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "ReservedCacheNodes":{ "shape":"ReservedCacheNodeList", "documentation":"

A list of reserved cache nodes. Each element in the list contains detailed information about one node.

" } }, "documentation":"

Represents the output of a DescribeReservedCacheNodes operation.

" }, "ReservedCacheNodeNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The requested reserved cache node was not found.

", "error":{ "code":"ReservedCacheNodeNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ReservedCacheNodeQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request cannot be processed because it would exceed the user's cache node quota.

", "error":{ "code":"ReservedCacheNodeQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ReservedCacheNodesOffering":{ "type":"structure", "members":{ "ReservedCacheNodesOfferingId":{ "shape":"String", "documentation":"

A unique identifier for the reserved cache node offering.

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The cache node type for the reserved cache node.

Valid node types are as follows:

  • General purpose:

    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

  • Compute optimized: cache.c1.xlarge

  • Memory optimized:

    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

" }, "Duration":{ "shape":"Integer", "documentation":"

The duration of the offering. in seconds.

" }, "FixedPrice":{ "shape":"Double", "documentation":"

The fixed price charged for this offering.

" }, "UsagePrice":{ "shape":"Double", "documentation":"

The hourly price charged for this offering.

" }, "ProductDescription":{ "shape":"String", "documentation":"

The cache engine used by the offering.

" }, "OfferingType":{ "shape":"String", "documentation":"

The offering type.

" }, "RecurringCharges":{ "shape":"RecurringChargeList", "documentation":"

The recurring price charged to run this reserved cache node.

" } }, "documentation":"

Describes all of the attributes of a reserved cache node offering.

", "wrapper":true }, "ReservedCacheNodesOfferingList":{ "type":"list", "member":{ "shape":"ReservedCacheNodesOffering", "locationName":"ReservedCacheNodesOffering" } }, "ReservedCacheNodesOfferingMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "ReservedCacheNodesOfferings":{ "shape":"ReservedCacheNodesOfferingList", "documentation":"

A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.

" } }, "documentation":"

Represents the output of a DescribeReservedCacheNodesOfferings operation.

" }, "ReservedCacheNodesOfferingNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The requested cache node offering does not exist.

", "error":{ "code":"ReservedCacheNodesOfferingNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResetCacheParameterGroupMessage":{ "type":"structure", "required":["CacheParameterGroupName"], "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the cache parameter group to reset.

" }, "ResetAllParameters":{ "shape":"Boolean", "documentation":"

If true, all parameters in the cache parameter group are reset to their default values. If false, only the parameters listed by ParameterNameValues are reset to their default values.

Valid values: true | false

" }, "ParameterNameValues":{ "shape":"ParameterNameValueList", "documentation":"

An array of parameter names to reset to their default values. If ResetAllParameters is true, do not use ParameterNameValues. If ResetAllParameters is false, you must specify the name of at least one parameter to reset.

" } }, "documentation":"

Represents the input of a ResetCacheParameterGroup operation.

" }, "RevokeCacheSecurityGroupIngressMessage":{ "type":"structure", "required":[ "CacheSecurityGroupName", "EC2SecurityGroupName", "EC2SecurityGroupOwnerId" ], "members":{ "CacheSecurityGroupName":{ "shape":"String", "documentation":"

The name of the cache security group to revoke ingress from.

" }, "EC2SecurityGroupName":{ "shape":"String", "documentation":"

The name of the Amazon EC2 security group to revoke access from.

" }, "EC2SecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.

" } }, "documentation":"

Represents the input of a RevokeCacheSecurityGroupIngress operation.

" }, "RevokeCacheSecurityGroupIngressResult":{ "type":"structure", "members":{ "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} } }, "SecurityGroupIdsList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroupId" } }, "SecurityGroupMembership":{ "type":"structure", "members":{ "SecurityGroupId":{ "shape":"String", "documentation":"

The identifier of the cache security group.

" }, "Status":{ "shape":"String", "documentation":"

The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

" } }, "documentation":"

Represents a single cache security group and its status.

" }, "SecurityGroupMembershipList":{ "type":"list", "member":{"shape":"SecurityGroupMembership"} }, "Snapshot":{ "type":"structure", "members":{ "SnapshotName":{ "shape":"String", "documentation":"

The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

" }, "ReplicationGroupId":{ "shape":"String", "documentation":"

The unique identifier of the source replication group.

" }, "ReplicationGroupDescription":{ "shape":"String", "documentation":"

A description of the source replication group.

" }, "CacheClusterId":{ "shape":"String", "documentation":"

The user-supplied identifier of the source cache cluster.

" }, "SnapshotStatus":{ "shape":"String", "documentation":"

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

" }, "SnapshotSource":{ "shape":"String", "documentation":"

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The name of the compute and memory capacity node type for the source cache cluster.

Valid node types are as follows:

  • General purpose:

    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge, cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

  • Compute optimized: cache.c1.xlarge

  • Memory optimized:

    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All T2 instances are created in an Amazon Virtual Private Cloud (Amazon VPC).

  • Redis backup/restore is not supported for Redis (cluster mode disabled) T1 and T2 instances. Backup/restore is supported on Redis (cluster mode enabled) T2 instances.

  • Redis Append-only files (AOF) functionality is not supported for T1 or T2 instances.

For a complete listing of node types and specifications, see Amazon ElastiCache Product Features and Details and either Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

" }, "Engine":{ "shape":"String", "documentation":"

The name of the cache engine (memcached or redis) used by the source cache cluster.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version of the cache engine version that is used by the source cache cluster.

" }, "NumCacheNodes":{ "shape":"IntegerOptional", "documentation":"

The number of cache nodes in the source cache cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

" }, "PreferredAvailabilityZone":{ "shape":"String", "documentation":"

The name of the Availability Zone in which the source cache cluster is located.

" }, "CacheClusterCreateTime":{ "shape":"TStamp", "documentation":"

The date and time when the source cache cluster was created.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

" }, "TopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number used by each cache nodes in the source cache cluster.

" }, "CacheParameterGroupName":{ "shape":"String", "documentation":"

The cache parameter group that is associated with the source cache cluster.

" }, "CacheSubnetGroupName":{ "shape":"String", "documentation":"

The name of the cache subnet group associated with the source cache cluster.

" }, "VpcId":{ "shape":"String", "documentation":"

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.

" }, "AutoMinorVersionUpgrade":{ "shape":"Boolean", "documentation":"

This parameter is currently disabled.

" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", "documentation":"

For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.

Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" }, "SnapshotWindow":{ "shape":"String", "documentation":"

The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.

" }, "NumNodeGroups":{ "shape":"IntegerOptional", "documentation":"

The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.

" }, "AutomaticFailover":{ "shape":"AutomaticFailoverStatus", "documentation":"

Indicates the status of Multi-AZ for the source replication group.

ElastiCache Multi-AZ replication groups are not supported on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled):T1 and T2 cache node types.

    Redis (cluster mode enabled): T1 node types.

" }, "NodeSnapshots":{ "shape":"NodeSnapshotList", "documentation":"

A list of the cache nodes in the source cache cluster.

" } }, "documentation":"

Represents a copy of an entire Redis cache cluster as of the time when the snapshot was taken.

", "wrapper":true }, "SnapshotAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

You already have a snapshot with the given name.

", "error":{ "code":"SnapshotAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SnapshotArnsList":{ "type":"list", "member":{ "shape":"String", "locationName":"SnapshotArn" } }, "SnapshotFeatureNotSupportedFault":{ "type":"structure", "members":{ }, "documentation":"

You attempted one of the following operations:

  • Creating a snapshot of a Redis cache cluster running on a cache.t1.micro cache node.

  • Creating a snapshot of a cache cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

", "error":{ "code":"SnapshotFeatureNotSupportedFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SnapshotList":{ "type":"list", "member":{ "shape":"Snapshot", "locationName":"Snapshot" } }, "SnapshotNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The requested snapshot name does not refer to an existing snapshot.

", "error":{ "code":"SnapshotNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "SnapshotQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

", "error":{ "code":"SnapshotQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SourceType":{ "type":"string", "enum":[ "cache-cluster", "cache-parameter-group", "cache-security-group", "cache-subnet-group", "replication-group" ] }, "String":{"type":"string"}, "Subnet":{ "type":"structure", "members":{ "SubnetIdentifier":{ "shape":"String", "documentation":"

The unique identifier for the subnet.

" }, "SubnetAvailabilityZone":{ "shape":"AvailabilityZone", "documentation":"

The Availability Zone associated with the subnet.

" } }, "documentation":"

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.

" }, "SubnetIdentifierList":{ "type":"list", "member":{ "shape":"String", "locationName":"SubnetIdentifier" } }, "SubnetInUse":{ "type":"structure", "members":{ }, "documentation":"

The requested subnet is being used by another cache subnet group.

", "error":{ "code":"SubnetInUse", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SubnetList":{ "type":"list", "member":{ "shape":"Subnet", "locationName":"Subnet" } }, "TStamp":{"type":"timestamp"}, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The key for the tag.

" }, "Value":{ "shape":"String", "documentation":"

The tag's value. May not be null.

" } }, "documentation":"

A cost allocation Tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. A tag with a null Value is permitted.

" }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"Tag" } }, "TagListMessage":{ "type":"structure", "members":{ "TagList":{ "shape":"TagList", "documentation":"

A list of cost allocation tags as key-value pairs.

" } }, "documentation":"

Represents the output from the AddTagsToResource, ListTagsOnResource, and RemoveTagsFromResource operations.

" }, "TagNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The requested tag was not found on this resource.

", "error":{ "code":"TagNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "TagQuotaPerResourceExceeded":{ "type":"structure", "members":{ }, "documentation":"

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 10.

", "error":{ "code":"TagQuotaPerResourceExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true } }, "documentation":"Amazon ElastiCache

Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.

With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.

In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.

" } botocore-1.5.7/botocore/data/elasticache/2014-09-30/0000777454262600001440000000000013042511307022434 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/elasticache/2014-09-30/waiters-2.json0000666454262600001440000000720713042511306025151 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "CacheClusterAvailable": { "delay": 30, "operation": "DescribeCacheClusters", "maxAttempts": 60, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "CacheClusters[].CacheClusterStatus" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "CacheClusters[].CacheClusterStatus" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "CacheClusters[].CacheClusterStatus" }, { "expected": "incompatible-network", "matcher": "pathAny", "state": "failure", "argument": "CacheClusters[].CacheClusterStatus" }, { "expected": "restore-failed", "matcher": "pathAny", "state": "failure", "argument": "CacheClusters[].CacheClusterStatus" } ] }, "CacheClusterDeleted": { "delay": 30, "operation": "DescribeCacheClusters", "maxAttempts": 60, "acceptors": [ { "expected": "CacheClusterNotFound", "matcher": "error", "state": "success" }, { "expected": "creating", "matcher": "pathAny", "state": "failure", "argument": "CacheClusters[].CacheClusterStatus" }, { "expected": "modifying", "matcher": "pathAny", "state": "failure", "argument": "CacheClusters[].CacheClusterStatus" }, { "expected": "rebooting", "matcher": "pathAny", "state": "failure", "argument": "CacheClusters[].CacheClusterStatus" } ] }, "ReplicationGroupAvailable": { "delay": 30, "operation": "DescribeReplicationGroups", "maxAttempts": 60, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "ReplicationGroups[].Status" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "ReplicationGroups[].Status" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "ReplicationGroups[].Status" }, { "expected": "incompatible-network", "matcher": "pathAny", "state": "failure", "argument": "ReplicationGroups[].Status" }, { "expected": "restore-failed", "matcher": "pathAny", "state": "failure", "argument": "ReplicationGroups[].Status" } ] }, "ReplicationGroupDeleted": { "delay": 30, "operation": "DescribeReplicationGroups", "maxAttempts": 60, "acceptors": [ { "expected": "ReplicationGroupNotFoundFault", "matcher": "error", "state": "success" }, { "expected": "creating", "matcher": "pathAny", "state": "failure", "argument": "ReplicationGroups[].Status" }, { "expected": "modifying", "matcher": "pathAny", "state": "failure", "argument": "ReplicationGroups[].Status" }, { "expected": "rebooting", "matcher": "pathAny", "state": "failure", "argument": "ReplicationGroups[].Status" } ] } } } botocore-1.5.7/botocore/data/elasticache/2014-09-30/paginators-1.json0000666454262600001440000000417313042511306025640 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeCacheClusters": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheClusters" }, "DescribeCacheEngineVersions": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheEngineVersions" }, "DescribeCacheParameterGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheParameterGroups" }, "DescribeCacheParameters": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Parameters" }, "DescribeCacheSecurityGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheSecurityGroups" }, "DescribeCacheSubnetGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "CacheSubnetGroups" }, "DescribeEngineDefaultParameters": { "input_token": "Marker", "output_token": "EngineDefaults.Marker", "limit_key": "MaxRecords", "result_key": "EngineDefaults.Parameters" }, "DescribeEvents": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Events" }, "DescribeReservedCacheNodes": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReservedCacheNodes" }, "DescribeReservedCacheNodesOfferings": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReservedCacheNodesOfferings" }, "DescribeReplicationGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReplicationGroups" }, "DescribeSnapshots": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Snapshots" } } } botocore-1.5.7/botocore/data/elasticache/2014-09-30/service-2.json0000666454262600001440000066345013042511306025143 0ustar pysdk-ciamazon00000000000000{ "metadata":{ "apiVersion":"2014-09-30", "endpointPrefix":"elasticache", "serviceFullName":"Amazon ElastiCache", "signatureVersion":"v4", "xmlNamespace":"http://elasticache.amazonaws.com/doc/2014-09-30/", "protocol":"query" }, "documentation":"Amazon ElastiCache

Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.

With ElastiCache, customers gain all of the benefits of a high-performance, in-memory cache with far less of the administrative burden of launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.

In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.

", "operations":{ "AuthorizeCacheSecurityGroupIngress":{ "name":"AuthorizeCacheSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"AuthorizeCacheSecurityGroupIngressMessage", "documentation":"

Represents the input of an AuthorizeCacheSecurityGroupIngress operation.

" }, "output":{ "shape":"AuthorizeCacheSecurityGroupIngressResult", "wrapper":true, "documentation":"

Represents the output of one of the following operations:

  • AuthorizeCacheSecurityGroupIngress
  • CreateCacheSecurityGroup
  • RevokeCacheSecurityGroupIngress
", "resultWrapper":"AuthorizeCacheSecurityGroupIngressResult" }, "errors":[ { "shape":"CacheSecurityGroupNotFoundFault", "error":{ "code":"CacheSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" }, { "shape":"InvalidCacheSecurityGroupStateFault", "error":{ "code":"InvalidCacheSecurityGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The current state of the cache security group does not allow deletion.

" }, { "shape":"AuthorizationAlreadyExistsFault", "error":{ "code":"AuthorizationAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified Amazon EC2 security group is already authorized for the specified cache security group.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The AuthorizeCacheSecurityGroupIngress operation allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

" }, "CopySnapshot":{ "name":"CopySnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CopySnapshotMessage", "documentation":"

Represents the input of a CopySnapshotMessage operation.

" }, "output":{ "shape":"CopySnapshotResult", "wrapper":true, "documentation":"

Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

", "resultWrapper":"CopySnapshotResult" }, "errors":[ { "shape":"SnapshotAlreadyExistsFault", "error":{ "code":"SnapshotAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You already have a snapshot with the given name.

" }, { "shape":"SnapshotNotFoundFault", "error":{ "code":"SnapshotNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested snapshot name does not refer to an existing snapshot.

" }, { "shape":"SnapshotQuotaExceededFault", "error":{ "code":"SnapshotQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

" }, { "shape":"InvalidSnapshotStateFault", "error":{ "code":"InvalidSnapshotState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The current state of the snapshot does not allow the requested action to occur.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The CopySnapshot operation makes a copy of an existing snapshot.

" }, "CreateCacheCluster":{ "name":"CreateCacheCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateCacheClusterMessage", "documentation":"

Represents the input of a CreateCacheCluster operation.

" }, "output":{ "shape":"CreateCacheClusterResult", "wrapper":true, "documentation":"

Contains all of the attributes of a specific cache cluster.

", "resultWrapper":"CreateCacheClusterResult" }, "errors":[ { "shape":"ReplicationGroupNotFoundFault", "error":{ "code":"ReplicationGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified replication group does not exist.

" }, { "shape":"InvalidReplicationGroupStateFault", "error":{ "code":"InvalidReplicationGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested replication group is not in the available state.

" }, { "shape":"CacheClusterAlreadyExistsFault", "error":{ "code":"CacheClusterAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You already have a cache cluster with the given identifier.

" }, { "shape":"InsufficientCacheClusterCapacityFault", "error":{ "code":"InsufficientCacheClusterCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache node type is not available in the specified Availability Zone.

" }, { "shape":"CacheSecurityGroupNotFoundFault", "error":{ "code":"CacheSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" }, { "shape":"CacheSubnetGroupNotFoundFault", "error":{ "code":"CacheSubnetGroupNotFoundFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" }, { "shape":"ClusterQuotaForCustomerExceededFault", "error":{ "code":"ClusterQuotaForCustomerExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache clusters per customer.

" }, { "shape":"NodeQuotaForClusterExceededFault", "error":{ "code":"NodeQuotaForClusterExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

" }, { "shape":"NodeQuotaForCustomerExceededFault", "error":{ "code":"NodeQuotaForCustomerExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

" }, { "shape":"CacheParameterGroupNotFoundFault", "error":{ "code":"CacheParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" }, { "shape":"InvalidVPCNetworkStateFault", "error":{ "code":"InvalidVPCNetworkStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The VPC network is in an invalid state.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The CreateCacheCluster operation creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis.

" }, "CreateCacheParameterGroup":{ "name":"CreateCacheParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateCacheParameterGroupMessage", "documentation":"

Represents the input of a CreateCacheParameterGroup operation.

" }, "output":{ "shape":"CreateCacheParameterGroupResult", "wrapper":true, "documentation":"

Represents the output of a CreateCacheParameterGroup operation.

", "resultWrapper":"CreateCacheParameterGroupResult" }, "errors":[ { "shape":"CacheParameterGroupQuotaExceededFault", "error":{ "code":"CacheParameterGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the maximum number of cache security groups.

" }, { "shape":"CacheParameterGroupAlreadyExistsFault", "error":{ "code":"CacheParameterGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

A cache parameter group with the requested name already exists.

" }, { "shape":"InvalidCacheParameterGroupStateFault", "error":{ "code":"InvalidCacheParameterGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The current state of the cache parameter group does not allow the requested action to occur.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

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.

" }, "CreateCacheSecurityGroup":{ "name":"CreateCacheSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateCacheSecurityGroupMessage", "documentation":"

Represents the input of a CreateCacheSecurityGroup operation.

" }, "output":{ "shape":"CreateCacheSecurityGroupResult", "wrapper":true, "documentation":"

Represents the output of one of the following operations:

  • AuthorizeCacheSecurityGroupIngress
  • CreateCacheSecurityGroup
  • RevokeCacheSecurityGroupIngress
", "resultWrapper":"CreateCacheSecurityGroupResult" }, "errors":[ { "shape":"CacheSecurityGroupAlreadyExistsFault", "error":{ "code":"CacheSecurityGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

A cache security group with the specified name already exists.

" }, { "shape":"CacheSecurityGroupQuotaExceededFault", "error":{ "code":"QuotaExceeded.CacheSecurityGroup", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache security groups.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The CreateCacheSecurityGroup operation creates a new cache security group. Use a cache security group to control access to one or more cache clusters.

Cache security groups are only used when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cache cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.

" }, "CreateCacheSubnetGroup":{ "name":"CreateCacheSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateCacheSubnetGroupMessage", "documentation":"

Represents the input of a CreateCacheSubnetGroup operation.

" }, "output":{ "shape":"CreateCacheSubnetGroupResult", "wrapper":true, "documentation":"

Represents the output of one of the following operations:

  • CreateCacheSubnetGroup
  • ModifyCacheSubnetGroup
", "resultWrapper":"CreateCacheSubnetGroupResult" }, "errors":[ { "shape":"CacheSubnetGroupAlreadyExistsFault", "error":{ "code":"CacheSubnetGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache subnet group name is already in use by an existing cache subnet group.

" }, { "shape":"CacheSubnetGroupQuotaExceededFault", "error":{ "code":"CacheSubnetGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache subnet groups.

" }, { "shape":"CacheSubnetQuotaExceededFault", "error":{ "code":"CacheSubnetQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

" }, { "shape":"InvalidSubnet", "error":{ "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

An invalid subnet identifier was specified.

" } ], "documentation":"

The CreateCacheSubnetGroup operation creates a new cache subnet group.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).

" }, "CreateReplicationGroup":{ "name":"CreateReplicationGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateReplicationGroupMessage", "documentation":"

Represents the input of a CreateReplicationGroup operation.

" }, "output":{ "shape":"CreateReplicationGroupResult", "wrapper":true, "documentation":"

Contains all of the attributes of a specific replication group.

", "resultWrapper":"CreateReplicationGroupResult" }, "errors":[ { "shape":"CacheClusterNotFoundFault", "error":{ "code":"CacheClusterNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" }, { "shape":"InvalidCacheClusterStateFault", "error":{ "code":"InvalidCacheClusterState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache cluster is not in the available state.

" }, { "shape":"ReplicationGroupAlreadyExistsFault", "error":{ "code":"ReplicationGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified replication group already exists.

" }, { "shape":"InsufficientCacheClusterCapacityFault", "error":{ "code":"InsufficientCacheClusterCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache node type is not available in the specified Availability Zone.

" }, { "shape":"CacheSecurityGroupNotFoundFault", "error":{ "code":"CacheSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" }, { "shape":"CacheSubnetGroupNotFoundFault", "error":{ "code":"CacheSubnetGroupNotFoundFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" }, { "shape":"ClusterQuotaForCustomerExceededFault", "error":{ "code":"ClusterQuotaForCustomerExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache clusters per customer.

" }, { "shape":"NodeQuotaForClusterExceededFault", "error":{ "code":"NodeQuotaForClusterExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

" }, { "shape":"NodeQuotaForCustomerExceededFault", "error":{ "code":"NodeQuotaForCustomerExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

" }, { "shape":"CacheParameterGroupNotFoundFault", "error":{ "code":"CacheParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" }, { "shape":"InvalidVPCNetworkStateFault", "error":{ "code":"InvalidVPCNetworkStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The VPC network is in an invalid state.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The CreateReplicationGroup operation creates a replication group. A replication group is a collection of cache clusters, where one of the cache clusters is a read/write primary and the others are read-only replicas. Writes to the primary are automatically propagated to the replicas.

When you create a replication group, you must specify an existing cache cluster that is in the primary role. When the replication group has been successfully created, you can add one or more read replica replicas to it, up to a total of five read replicas.

Note: This action is valid only for Redis.

" }, "CreateSnapshot":{ "name":"CreateSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateSnapshotMessage", "documentation":"

Represents the input of a CreateSnapshot operation.

" }, "output":{ "shape":"CreateSnapshotResult", "wrapper":true, "documentation":"

Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

", "resultWrapper":"CreateSnapshotResult" }, "errors":[ { "shape":"SnapshotAlreadyExistsFault", "error":{ "code":"SnapshotAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You already have a snapshot with the given name.

" }, { "shape":"CacheClusterNotFoundFault", "error":{ "code":"CacheClusterNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" }, { "shape":"InvalidCacheClusterStateFault", "error":{ "code":"InvalidCacheClusterState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache cluster is not in the available state.

" }, { "shape":"SnapshotQuotaExceededFault", "error":{ "code":"SnapshotQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

" }, { "shape":"SnapshotFeatureNotSupportedFault", "error":{ "code":"SnapshotFeatureNotSupportedFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You attempted one of the following actions:

  • Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.

  • Creating a snapshot of a cache cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" } ], "documentation":"

The CreateSnapshot operation creates a copy of an entire cache cluster at a specific moment in time.

" }, "DeleteCacheCluster":{ "name":"DeleteCacheCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteCacheClusterMessage", "documentation":"

Represents the input of a DeleteCacheCluster operation.

" }, "output":{ "shape":"DeleteCacheClusterResult", "wrapper":true, "documentation":"

Contains all of the attributes of a specific cache cluster.

", "resultWrapper":"DeleteCacheClusterResult" }, "errors":[ { "shape":"CacheClusterNotFoundFault", "error":{ "code":"CacheClusterNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" }, { "shape":"InvalidCacheClusterStateFault", "error":{ "code":"InvalidCacheClusterState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache cluster is not in the available state.

" }, { "shape":"SnapshotAlreadyExistsFault", "error":{ "code":"SnapshotAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You already have a snapshot with the given name.

" }, { "shape":"SnapshotFeatureNotSupportedFault", "error":{ "code":"SnapshotFeatureNotSupportedFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You attempted one of the following actions:

  • Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.

  • Creating a snapshot of a cache cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

" }, { "shape":"SnapshotQuotaExceededFault", "error":{ "code":"SnapshotQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The DeleteCacheCluster operation deletes a previously provisioned cache cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this operation.

This API cannot be used to delete a cache cluster that is the last read replica of a replication group that has automatic failover mode enabled.

" }, "DeleteCacheParameterGroup":{ "name":"DeleteCacheParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteCacheParameterGroupMessage", "documentation":"

Represents the input of a DeleteCacheParameterGroup operation.

" }, "errors":[ { "shape":"InvalidCacheParameterGroupStateFault", "error":{ "code":"InvalidCacheParameterGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The current state of the cache parameter group does not allow the requested action to occur.

" }, { "shape":"CacheParameterGroupNotFoundFault", "error":{ "code":"CacheParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The DeleteCacheParameterGroup operation deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.

" }, "DeleteCacheSecurityGroup":{ "name":"DeleteCacheSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteCacheSecurityGroupMessage", "documentation":"

Represents the input of a DeleteCacheSecurityGroup operation.

" }, "errors":[ { "shape":"InvalidCacheSecurityGroupStateFault", "error":{ "code":"InvalidCacheSecurityGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The current state of the cache security group does not allow deletion.

" }, { "shape":"CacheSecurityGroupNotFoundFault", "error":{ "code":"CacheSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The DeleteCacheSecurityGroup operation deletes a cache security group.

" }, "DeleteCacheSubnetGroup":{ "name":"DeleteCacheSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteCacheSubnetGroupMessage", "documentation":"

Represents the input of a DeleteCacheSubnetGroup operation.

" }, "errors":[ { "shape":"CacheSubnetGroupInUse", "error":{ "code":"CacheSubnetGroupInUse", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache subnet group is currently in use.

" }, { "shape":"CacheSubnetGroupNotFoundFault", "error":{ "code":"CacheSubnetGroupNotFoundFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" } ], "documentation":"

The DeleteCacheSubnetGroup operation deletes a cache subnet group.

" }, "DeleteReplicationGroup":{ "name":"DeleteReplicationGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteReplicationGroupMessage", "documentation":"

Represents the input of a DeleteReplicationGroup operation.

" }, "output":{ "shape":"DeleteReplicationGroupResult", "wrapper":true, "documentation":"

Contains all of the attributes of a specific replication group.

", "resultWrapper":"DeleteReplicationGroupResult" }, "errors":[ { "shape":"ReplicationGroupNotFoundFault", "error":{ "code":"ReplicationGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified replication group does not exist.

" }, { "shape":"InvalidReplicationGroupStateFault", "error":{ "code":"InvalidReplicationGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested replication group is not in the available state.

" }, { "shape":"SnapshotAlreadyExistsFault", "error":{ "code":"SnapshotAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You already have a snapshot with the given name.

" }, { "shape":"SnapshotFeatureNotSupportedFault", "error":{ "code":"SnapshotFeatureNotSupportedFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You attempted one of the following actions:

  • Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.

  • Creating a snapshot of a cache cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

" }, { "shape":"SnapshotQuotaExceededFault", "error":{ "code":"SnapshotQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The DeleteReplicationGroup operation deletes an existing cluster. By default, this operation deletes the entire cluster, including the primary node group and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary node group.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

" }, "DeleteSnapshot":{ "name":"DeleteSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteSnapshotMessage", "documentation":"

Represents the input of a DeleteSnapshot operation.

" }, "output":{ "shape":"DeleteSnapshotResult", "wrapper":true, "documentation":"

Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

", "resultWrapper":"DeleteSnapshotResult" }, "errors":[ { "shape":"SnapshotNotFoundFault", "error":{ "code":"SnapshotNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested snapshot name does not refer to an existing snapshot.

" }, { "shape":"InvalidSnapshotStateFault", "error":{ "code":"InvalidSnapshotState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The current state of the snapshot does not allow the requested action to occur.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The DeleteSnapshot operation deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.

" }, "DescribeCacheClusters":{ "name":"DescribeCacheClusters", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeCacheClustersMessage", "documentation":"

Represents the input of a DescribeCacheClusters operation.

" }, "output":{ "shape":"CacheClusterMessage", "documentation":"

Represents the output of a DescribeCacheClusters operation.

", "resultWrapper":"DescribeCacheClustersResult" }, "errors":[ { "shape":"CacheClusterNotFoundFault", "error":{ "code":"CacheClusterNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The DescribeCacheClusters operation returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.

By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional ShowDetails flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster level information will be displayed.

If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is available, the cluster is ready for use.

If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.

" }, "DescribeCacheEngineVersions":{ "name":"DescribeCacheEngineVersions", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeCacheEngineVersionsMessage", "documentation":"

Represents the input of a DescribeCacheEngineVersions operation.

" }, "output":{ "shape":"CacheEngineVersionMessage", "documentation":"

Represents the output of a DescribeCacheEngineVersions operation.

", "resultWrapper":"DescribeCacheEngineVersionsResult" }, "documentation":"

The DescribeCacheEngineVersions operation returns a list of the available cache engines and their versions.

" }, "DescribeCacheParameterGroups":{ "name":"DescribeCacheParameterGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeCacheParameterGroupsMessage", "documentation":"

Represents the input of a DescribeCacheParameterGroups operation.

" }, "output":{ "shape":"CacheParameterGroupsMessage", "documentation":"

Represents the output of a DescribeCacheParameterGroups operation.

", "resultWrapper":"DescribeCacheParameterGroupsResult" }, "errors":[ { "shape":"CacheParameterGroupNotFoundFault", "error":{ "code":"CacheParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The DescribeCacheParameterGroups operation returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group.

" }, "DescribeCacheParameters":{ "name":"DescribeCacheParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeCacheParametersMessage", "documentation":"

Represents the input of a DescribeCacheParameters operation.

" }, "output":{ "shape":"CacheParameterGroupDetails", "documentation":"

Represents the output of a DescribeCacheParameters operation.

", "resultWrapper":"DescribeCacheParametersResult" }, "errors":[ { "shape":"CacheParameterGroupNotFoundFault", "error":{ "code":"CacheParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The DescribeCacheParameters operation returns the detailed parameter list for a particular cache parameter group.

" }, "DescribeCacheSecurityGroups":{ "name":"DescribeCacheSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeCacheSecurityGroupsMessage", "documentation":"

Represents the input of a DescribeCacheSecurityGroups operation.

" }, "output":{ "shape":"CacheSecurityGroupMessage", "documentation":"

Represents the output of a DescribeCacheSecurityGroups operation.

", "resultWrapper":"DescribeCacheSecurityGroupsResult" }, "errors":[ { "shape":"CacheSecurityGroupNotFoundFault", "error":{ "code":"CacheSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The DescribeCacheSecurityGroups operation returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group.

" }, "DescribeCacheSubnetGroups":{ "name":"DescribeCacheSubnetGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeCacheSubnetGroupsMessage", "documentation":"

Represents the input of a DescribeCacheSubnetGroups operation.

" }, "output":{ "shape":"CacheSubnetGroupMessage", "documentation":"

Represents the output of a DescribeCacheSubnetGroups operation.

", "resultWrapper":"DescribeCacheSubnetGroupsResult" }, "errors":[ { "shape":"CacheSubnetGroupNotFoundFault", "error":{ "code":"CacheSubnetGroupNotFoundFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" } ], "documentation":"

The DescribeCacheSubnetGroups operation returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.

" }, "DescribeEngineDefaultParameters":{ "name":"DescribeEngineDefaultParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeEngineDefaultParametersMessage", "documentation":"

Represents the input of a DescribeEngineDefaultParameters operation.

" }, "output":{ "shape":"DescribeEngineDefaultParametersResult", "wrapper":true, "documentation":"

Represents the output of a DescribeEngineDefaultParameters operation.

", "resultWrapper":"DescribeEngineDefaultParametersResult" }, "errors":[ { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The DescribeEngineDefaultParameters operation returns the default engine and system parameter information for the specified cache engine.

" }, "DescribeEvents":{ "name":"DescribeEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeEventsMessage", "documentation":"

Represents the input of a DescribeEvents operation.

" }, "output":{ "shape":"EventsMessage", "documentation":"

Represents the output of a DescribeEvents operation.

", "resultWrapper":"DescribeEventsResult" }, "errors":[ { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The DescribeEvents operation returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter.

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

" }, "DescribeReplicationGroups":{ "name":"DescribeReplicationGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeReplicationGroupsMessage", "documentation":"

Represents the input of a DescribeReplicationGroups operation.

" }, "output":{ "shape":"ReplicationGroupMessage", "documentation":"

Represents the output of a DescribeReplicationGroups operation.

", "resultWrapper":"DescribeReplicationGroupsResult" }, "errors":[ { "shape":"ReplicationGroupNotFoundFault", "error":{ "code":"ReplicationGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified replication group does not exist.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The DescribeReplicationGroups operation returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

" }, "DescribeReservedCacheNodes":{ "name":"DescribeReservedCacheNodes", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeReservedCacheNodesMessage", "documentation":"

Represents the input of a DescribeReservedCacheNodes operation.

" }, "output":{ "shape":"ReservedCacheNodeMessage", "documentation":"

Represents the output of a DescribeReservedCacheNodes operation.

", "resultWrapper":"DescribeReservedCacheNodesResult" }, "errors":[ { "shape":"ReservedCacheNodeNotFoundFault", "error":{ "code":"ReservedCacheNodeNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested reserved cache node was not found.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The DescribeReservedCacheNodes operation returns information about reserved cache nodes for this account, or about a specified reserved cache node.

" }, "DescribeReservedCacheNodesOfferings":{ "name":"DescribeReservedCacheNodesOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeReservedCacheNodesOfferingsMessage", "documentation":"

Represents the input of a DescribeReservedCacheNodesOfferings operation.

" }, "output":{ "shape":"ReservedCacheNodesOfferingMessage", "documentation":"

Represents the output of a DescribeReservedCacheNodesOfferings operation.

", "resultWrapper":"DescribeReservedCacheNodesOfferingsResult" }, "errors":[ { "shape":"ReservedCacheNodesOfferingNotFoundFault", "error":{ "code":"ReservedCacheNodesOfferingNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache node offering does not exist.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The DescribeReservedCacheNodesOfferings operation lists available reserved cache node offerings.

" }, "DescribeSnapshots":{ "name":"DescribeSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeSnapshotsMessage", "documentation":"

Represents the input of a DescribeSnapshotsMessage operation.

" }, "output":{ "shape":"DescribeSnapshotsListMessage", "documentation":"

Represents the output of a DescribeSnapshots operation.

", "resultWrapper":"DescribeSnapshotsResult" }, "errors":[ { "shape":"CacheClusterNotFoundFault", "error":{ "code":"CacheClusterNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" }, { "shape":"SnapshotNotFoundFault", "error":{ "code":"SnapshotNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested snapshot name does not refer to an existing snapshot.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The DescribeSnapshots operation returns information about cache cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

" }, "ModifyCacheCluster":{ "name":"ModifyCacheCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ModifyCacheClusterMessage", "documentation":"

Represents the input of a ModifyCacheCluster operation.

" }, "output":{ "shape":"ModifyCacheClusterResult", "wrapper":true, "documentation":"

Contains all of the attributes of a specific cache cluster.

", "resultWrapper":"ModifyCacheClusterResult" }, "errors":[ { "shape":"InvalidCacheClusterStateFault", "error":{ "code":"InvalidCacheClusterState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache cluster is not in the available state.

" }, { "shape":"InvalidCacheSecurityGroupStateFault", "error":{ "code":"InvalidCacheSecurityGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The current state of the cache security group does not allow deletion.

" }, { "shape":"InsufficientCacheClusterCapacityFault", "error":{ "code":"InsufficientCacheClusterCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache node type is not available in the specified Availability Zone.

" }, { "shape":"CacheClusterNotFoundFault", "error":{ "code":"CacheClusterNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" }, { "shape":"NodeQuotaForClusterExceededFault", "error":{ "code":"NodeQuotaForClusterExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

" }, { "shape":"NodeQuotaForCustomerExceededFault", "error":{ "code":"NodeQuotaForCustomerExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

" }, { "shape":"CacheSecurityGroupNotFoundFault", "error":{ "code":"CacheSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" }, { "shape":"CacheParameterGroupNotFoundFault", "error":{ "code":"CacheParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" }, { "shape":"InvalidVPCNetworkStateFault", "error":{ "code":"InvalidVPCNetworkStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The VPC network is in an invalid state.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The ModifyCacheCluster operation modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.

" }, "ModifyCacheParameterGroup":{ "name":"ModifyCacheParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ModifyCacheParameterGroupMessage", "documentation":"

Represents the input of a ModifyCacheParameterGroup operation.

" }, "output":{ "shape":"CacheParameterGroupNameMessage", "documentation":"

Represents the output of one of the following operations:

  • ModifyCacheParameterGroup
  • ResetCacheParameterGroup
", "resultWrapper":"ModifyCacheParameterGroupResult" }, "errors":[ { "shape":"CacheParameterGroupNotFoundFault", "error":{ "code":"CacheParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" }, { "shape":"InvalidCacheParameterGroupStateFault", "error":{ "code":"InvalidCacheParameterGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The current state of the cache parameter group does not allow the requested action to occur.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The ModifyCacheParameterGroup operation modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

" }, "ModifyCacheSubnetGroup":{ "name":"ModifyCacheSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ModifyCacheSubnetGroupMessage", "documentation":"

Represents the input of a ModifyCacheSubnetGroup operation.

" }, "output":{ "shape":"ModifyCacheSubnetGroupResult", "wrapper":true, "documentation":"

Represents the output of one of the following operations:

  • CreateCacheSubnetGroup
  • ModifyCacheSubnetGroup
", "resultWrapper":"ModifyCacheSubnetGroupResult" }, "errors":[ { "shape":"CacheSubnetGroupNotFoundFault", "error":{ "code":"CacheSubnetGroupNotFoundFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" }, { "shape":"CacheSubnetQuotaExceededFault", "error":{ "code":"CacheSubnetQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

" }, { "shape":"SubnetInUse", "error":{ "code":"SubnetInUse", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested subnet is being used by another cache subnet group.

" }, { "shape":"InvalidSubnet", "error":{ "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

An invalid subnet identifier was specified.

" } ], "documentation":"

The ModifyCacheSubnetGroup operation modifies an existing cache subnet group.

" }, "ModifyReplicationGroup":{ "name":"ModifyReplicationGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ModifyReplicationGroupMessage", "documentation":"

Represents the input of a ModifyReplicationGroups operation.

" }, "output":{ "shape":"ModifyReplicationGroupResult", "wrapper":true, "documentation":"

Contains all of the attributes of a specific replication group.

", "resultWrapper":"ModifyReplicationGroupResult" }, "errors":[ { "shape":"ReplicationGroupNotFoundFault", "error":{ "code":"ReplicationGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified replication group does not exist.

" }, { "shape":"InvalidReplicationGroupStateFault", "error":{ "code":"InvalidReplicationGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested replication group is not in the available state.

" }, { "shape":"InvalidCacheClusterStateFault", "error":{ "code":"InvalidCacheClusterState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache cluster is not in the available state.

" }, { "shape":"InvalidCacheSecurityGroupStateFault", "error":{ "code":"InvalidCacheSecurityGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The current state of the cache security group does not allow deletion.

" }, { "shape":"InsufficientCacheClusterCapacityFault", "error":{ "code":"InsufficientCacheClusterCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache node type is not available in the specified Availability Zone.

" }, { "shape":"CacheClusterNotFoundFault", "error":{ "code":"CacheClusterNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" }, { "shape":"NodeQuotaForClusterExceededFault", "error":{ "code":"NodeQuotaForClusterExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

" }, { "shape":"NodeQuotaForCustomerExceededFault", "error":{ "code":"NodeQuotaForCustomerExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

" }, { "shape":"CacheSecurityGroupNotFoundFault", "error":{ "code":"CacheSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" }, { "shape":"CacheParameterGroupNotFoundFault", "error":{ "code":"CacheParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" }, { "shape":"InvalidVPCNetworkStateFault", "error":{ "code":"InvalidVPCNetworkStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The VPC network is in an invalid state.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The ModifyReplicationGroup operation modifies the settings for a replication group.

" }, "PurchaseReservedCacheNodesOffering":{ "name":"PurchaseReservedCacheNodesOffering", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"PurchaseReservedCacheNodesOfferingMessage", "documentation":"

Represents the input of a PurchaseReservedCacheNodesOffering operation.

" }, "output":{ "shape":"PurchaseReservedCacheNodesOfferingResult", "wrapper":true, "documentation":"

Represents the output of a PurchaseReservedCacheNodesOffering operation.

", "resultWrapper":"PurchaseReservedCacheNodesOfferingResult" }, "errors":[ { "shape":"ReservedCacheNodesOfferingNotFoundFault", "error":{ "code":"ReservedCacheNodesOfferingNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache node offering does not exist.

" }, { "shape":"ReservedCacheNodeAlreadyExistsFault", "error":{ "code":"ReservedCacheNodeAlreadyExists", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

You already have a reservation with the given identifier.

" }, { "shape":"ReservedCacheNodeQuotaExceededFault", "error":{ "code":"ReservedCacheNodeQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the user's cache node quota.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The PurchaseReservedCacheNodesOffering operation allows you to purchase a reserved cache node offering.

" }, "RebootCacheCluster":{ "name":"RebootCacheCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"RebootCacheClusterMessage", "documentation":"

Represents the input of a RebootCacheCluster operation.

" }, "output":{ "shape":"RebootCacheClusterResult", "wrapper":true, "documentation":"

Contains all of the attributes of a specific cache cluster.

", "resultWrapper":"RebootCacheClusterResult" }, "errors":[ { "shape":"InvalidCacheClusterStateFault", "error":{ "code":"InvalidCacheClusterState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache cluster is not in the available state.

" }, { "shape":"CacheClusterNotFoundFault", "error":{ "code":"CacheClusterNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" } ], "documentation":"

The RebootCacheCluster operation reboots some, or all, of the cache nodes within a provisioned cache cluster. This API will apply any modified cache parameter groups to the cache cluster. The reboot action takes place as soon as possible, and results in a momentary outage to the cache cluster. During the reboot, the cache cluster status is set to REBOOTING.

The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

When the reboot is complete, a cache cluster event is created.

" }, "ResetCacheParameterGroup":{ "name":"ResetCacheParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ResetCacheParameterGroupMessage", "documentation":"

Represents the input of a ResetCacheParameterGroup operation.

" }, "output":{ "shape":"CacheParameterGroupNameMessage", "documentation":"

Represents the output of one of the following operations:

  • ModifyCacheParameterGroup
  • ResetCacheParameterGroup
", "resultWrapper":"ResetCacheParameterGroupResult" }, "errors":[ { "shape":"InvalidCacheParameterGroupStateFault", "error":{ "code":"InvalidCacheParameterGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The current state of the cache parameter group does not allow the requested action to occur.

" }, { "shape":"CacheParameterGroupNotFoundFault", "error":{ "code":"CacheParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The ResetCacheParameterGroup operation modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.

" }, "RevokeCacheSecurityGroupIngress":{ "name":"RevokeCacheSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"RevokeCacheSecurityGroupIngressMessage", "documentation":"

Represents the input of a RevokeCacheSecurityGroupIngress operation.

" }, "output":{ "shape":"RevokeCacheSecurityGroupIngressResult", "wrapper":true, "documentation":"

Represents the output of one of the following operations:

  • AuthorizeCacheSecurityGroupIngress
  • CreateCacheSecurityGroup
  • RevokeCacheSecurityGroupIngress
", "resultWrapper":"RevokeCacheSecurityGroupIngressResult" }, "errors":[ { "shape":"CacheSecurityGroupNotFoundFault", "error":{ "code":"CacheSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" }, { "shape":"AuthorizationNotFoundFault", "error":{ "code":"AuthorizationNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified Amazon EC2 security group is not authorized for the specified cache security group.

" }, { "shape":"InvalidCacheSecurityGroupStateFault", "error":{ "code":"InvalidCacheSecurityGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The current state of the cache security group does not allow deletion.

" }, { "shape":"InvalidParameterValueException", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidParameterCombinationException", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" } ], "documentation":"

The RevokeCacheSecurityGroupIngress operation revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.

" } }, "shapes":{ "AZMode":{ "type":"string", "enum":[ "single-az", "cross-az" ] }, "AuthorizationAlreadyExistsFault":{ "type":"structure", "members":{ }, "error":{ "code":"AuthorizationAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified Amazon EC2 security group is already authorized for the specified cache security group.

" }, "AuthorizationNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"AuthorizationNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified Amazon EC2 security group is not authorized for the specified cache security group.

" }, "AuthorizeCacheSecurityGroupIngressMessage":{ "type":"structure", "required":[ "CacheSecurityGroupName", "EC2SecurityGroupName", "EC2SecurityGroupOwnerId" ], "members":{ "CacheSecurityGroupName":{ "shape":"String", "documentation":"

The cache security group which will allow network ingress.

" }, "EC2SecurityGroupName":{ "shape":"String", "documentation":"

The Amazon EC2 security group to be authorized for ingress to the cache security group.

" }, "EC2SecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.

" } }, "documentation":"

Represents the input of an AuthorizeCacheSecurityGroupIngress operation.

" }, "AutomaticFailoverStatus":{ "type":"string", "enum":[ "enabled", "disabled", "enabling", "disabling" ] }, "AvailabilityZone":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the Availability Zone.

" } }, "wrapper":true, "documentation":"

Describes an Availability Zone in which the cache cluster is launched.

" }, "AvailabilityZonesList":{ "type":"list", "member":{ "shape":"String", "locationName":"AvailabilityZone" } }, "AwsQueryErrorMessage":{"type":"string"}, "Boolean":{"type":"boolean"}, "BooleanOptional":{"type":"boolean"}, "CacheCluster":{ "type":"structure", "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.

" }, "ConfigurationEndpoint":{"shape":"Endpoint"}, "ClientDownloadLandingPage":{ "shape":"String", "documentation":"

The URL of the web page where you can download the latest ElastiCache client library.

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The name of the compute and memory capacity node type for the cache cluster.

" }, "Engine":{ "shape":"String", "documentation":"

The name of the cache engine (memcached or redis) to be used for this cache cluster.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version of the cache engine version that is used in this cache cluster.

" }, "CacheClusterStatus":{ "shape":"String", "documentation":"

The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.

" }, "NumCacheNodes":{ "shape":"IntegerOptional", "documentation":"

The number of cache nodes in the cache cluster.

" }, "PreferredAvailabilityZone":{ "shape":"String", "documentation":"

The name of the Availability Zone in which the cache cluster is located or \"Multiple\" if the cache nodes are located in different Availability Zones.

" }, "CacheClusterCreateTime":{ "shape":"TStamp", "documentation":"

The date and time when the cache cluster was created.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The time range (in UTC) during which weekly system maintenance can occur.

" }, "PendingModifiedValues":{"shape":"PendingModifiedValues"}, "NotificationConfiguration":{"shape":"NotificationConfiguration"}, "CacheSecurityGroups":{ "shape":"CacheSecurityGroupMembershipList", "documentation":"

A list of cache security group elements, composed of name and status sub-elements.

" }, "CacheParameterGroup":{"shape":"CacheParameterGroupStatus"}, "CacheSubnetGroupName":{ "shape":"String", "documentation":"

The name of the cache subnet group associated with the cache cluster.

" }, "CacheNodes":{ "shape":"CacheNodeList", "documentation":"

A list of cache nodes that are members of the cache cluster.

" }, "AutoMinorVersionUpgrade":{ "shape":"Boolean", "documentation":"

If true, then minor version patches are applied automatically; if false, then automatic minor version patches are disabled.

" }, "SecurityGroups":{ "shape":"SecurityGroupMembershipList", "documentation":"

A list of VPC Security Groups associated with the cache cluster.

" }, "ReplicationGroupId":{ "shape":"String", "documentation":"

The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.

" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", "documentation":"

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" }, "SnapshotWindow":{ "shape":"String", "documentation":"

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

Example: 05:00-09:00

" } }, "wrapper":true, "documentation":"

Contains all of the attributes of a specific cache cluster.

" }, "CacheClusterAlreadyExistsFault":{ "type":"structure", "members":{ }, "error":{ "code":"CacheClusterAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You already have a cache cluster with the given identifier.

" }, "CacheClusterList":{ "type":"list", "member":{ "shape":"CacheCluster", "locationName":"CacheCluster" } }, "CacheClusterMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "CacheClusters":{ "shape":"CacheClusterList", "documentation":"

A list of cache clusters. Each item in the list contains detailed information about one cache cluster.

" } }, "documentation":"

Represents the output of a DescribeCacheClusters operation.

" }, "CacheClusterNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"CacheClusterNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" }, "CacheEngineVersion":{ "type":"structure", "members":{ "Engine":{ "shape":"String", "documentation":"

The name of the cache engine.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the cache engine.

" }, "CacheParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the cache parameter group family associated with this cache engine.

" }, "CacheEngineDescription":{ "shape":"String", "documentation":"

The description of the cache engine.

" }, "CacheEngineVersionDescription":{ "shape":"String", "documentation":"

The description of the cache engine version.

" } }, "documentation":"

Provides all of the details about a particular cache engine version.

" }, "CacheEngineVersionList":{ "type":"list", "member":{ "shape":"CacheEngineVersion", "locationName":"CacheEngineVersion" } }, "CacheEngineVersionMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "CacheEngineVersions":{ "shape":"CacheEngineVersionList", "documentation":"

A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.

" } }, "documentation":"

Represents the output of a DescribeCacheEngineVersions operation.

" }, "CacheNode":{ "type":"structure", "members":{ "CacheNodeId":{ "shape":"String", "documentation":"

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

" }, "CacheNodeStatus":{ "shape":"String", "documentation":"

The current state of this cache node.

" }, "CacheNodeCreateTime":{ "shape":"TStamp", "documentation":"

The date and time when the cache node was created.

" }, "Endpoint":{ "shape":"Endpoint", "documentation":"

The hostname and IP address for connecting to this cache node.

" }, "ParameterGroupStatus":{ "shape":"String", "documentation":"

The status of the parameter group applied to this cache node.

" }, "SourceCacheNodeId":{ "shape":"String", "documentation":"

The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.

" }, "CustomerAvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone where this node was created and now resides.

" } }, "documentation":"

Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.

" }, "CacheNodeIdsList":{ "type":"list", "member":{ "shape":"String", "locationName":"CacheNodeId" } }, "CacheNodeList":{ "type":"list", "member":{ "shape":"CacheNode", "locationName":"CacheNode" } }, "CacheNodeTypeSpecificParameter":{ "type":"structure", "members":{ "ParameterName":{ "shape":"String", "documentation":"

The name of the parameter.

" }, "Description":{ "shape":"String", "documentation":"

A description of the parameter.

" }, "Source":{ "shape":"String", "documentation":"

The source of the parameter value.

" }, "DataType":{ "shape":"String", "documentation":"

The valid data type for the parameter.

" }, "AllowedValues":{ "shape":"String", "documentation":"

The valid range of values for the parameter.

" }, "IsModifiable":{ "shape":"Boolean", "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" }, "MinimumEngineVersion":{ "shape":"String", "documentation":"

The earliest cache engine version to which the parameter can apply.

" }, "CacheNodeTypeSpecificValues":{ "shape":"CacheNodeTypeSpecificValueList", "documentation":"

A list of cache node types and their corresponding values for this parameter.

" } }, "documentation":"

A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.

" }, "CacheNodeTypeSpecificParametersList":{ "type":"list", "member":{ "shape":"CacheNodeTypeSpecificParameter", "locationName":"CacheNodeTypeSpecificParameter" } }, "CacheNodeTypeSpecificValue":{ "type":"structure", "members":{ "CacheNodeType":{ "shape":"String", "documentation":"

The cache node type for which this value applies.

" }, "Value":{ "shape":"String", "documentation":"

The value for the cache node type.

" } }, "documentation":"

A value that applies only to a certain cache node type.

" }, "CacheNodeTypeSpecificValueList":{ "type":"list", "member":{ "shape":"CacheNodeTypeSpecificValue", "locationName":"CacheNodeTypeSpecificValue" } }, "CacheParameterGroup":{ "type":"structure", "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the cache parameter group.

" }, "CacheParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the cache parameter group family that this cache parameter group is compatible with.

" }, "Description":{ "shape":"String", "documentation":"

The description for this cache parameter group.

" } }, "wrapper":true, "documentation":"

Represents the output of a CreateCacheParameterGroup operation.

" }, "CacheParameterGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "error":{ "code":"CacheParameterGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

A cache parameter group with the requested name already exists.

" }, "CacheParameterGroupDetails":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

A list of Parameter instances.

" }, "CacheNodeTypeSpecificParameters":{ "shape":"CacheNodeTypeSpecificParametersList", "documentation":"

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

" } }, "documentation":"

Represents the output of a DescribeCacheParameters operation.

" }, "CacheParameterGroupList":{ "type":"list", "member":{ "shape":"CacheParameterGroup", "locationName":"CacheParameterGroup" } }, "CacheParameterGroupNameMessage":{ "type":"structure", "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the cache parameter group.

" } }, "documentation":"

Represents the output of one of the following operations:

  • ModifyCacheParameterGroup
  • ResetCacheParameterGroup
" }, "CacheParameterGroupNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"CacheParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" }, "CacheParameterGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"CacheParameterGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the maximum number of cache security groups.

" }, "CacheParameterGroupStatus":{ "type":"structure", "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the cache parameter group.

" }, "ParameterApplyStatus":{ "shape":"String", "documentation":"

The status of parameter updates.

" }, "CacheNodeIdsToReboot":{ "shape":"CacheNodeIdsList", "documentation":"

A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

" } }, "documentation":"

The status of the cache parameter group.

" }, "CacheParameterGroupsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "CacheParameterGroups":{ "shape":"CacheParameterGroupList", "documentation":"

A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.

" } }, "documentation":"

Represents the output of a DescribeCacheParameterGroups operation.

" }, "CacheSecurityGroup":{ "type":"structure", "members":{ "OwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the cache security group owner.

" }, "CacheSecurityGroupName":{ "shape":"String", "documentation":"

The name of the cache security group.

" }, "Description":{ "shape":"String", "documentation":"

The description of the cache security group.

" }, "EC2SecurityGroups":{ "shape":"EC2SecurityGroupList", "documentation":"

A list of Amazon EC2 security groups that are associated with this cache security group.

" } }, "wrapper":true, "documentation":"

Represents the output of one of the following operations:

  • AuthorizeCacheSecurityGroupIngress
  • CreateCacheSecurityGroup
  • RevokeCacheSecurityGroupIngress
" }, "CacheSecurityGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "error":{ "code":"CacheSecurityGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

A cache security group with the specified name already exists.

" }, "CacheSecurityGroupMembership":{ "type":"structure", "members":{ "CacheSecurityGroupName":{ "shape":"String", "documentation":"

The name of the cache security group.

" }, "Status":{ "shape":"String", "documentation":"

The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

" } }, "documentation":"

Represents a cache cluster's status within a particular cache security group.

" }, "CacheSecurityGroupMembershipList":{ "type":"list", "member":{ "shape":"CacheSecurityGroupMembership", "locationName":"CacheSecurityGroup" } }, "CacheSecurityGroupMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "CacheSecurityGroups":{ "shape":"CacheSecurityGroups", "documentation":"

A list of cache security groups. Each element in the list contains detailed information about one group.

" } }, "documentation":"

Represents the output of a DescribeCacheSecurityGroups operation.

" }, "CacheSecurityGroupNameList":{ "type":"list", "member":{ "shape":"String", "locationName":"CacheSecurityGroupName" } }, "CacheSecurityGroupNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"CacheSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" }, "CacheSecurityGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"QuotaExceeded.CacheSecurityGroup", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache security groups.

" }, "CacheSecurityGroups":{ "type":"list", "member":{ "shape":"CacheSecurityGroup", "locationName":"CacheSecurityGroup" } }, "CacheSubnetGroup":{ "type":"structure", "members":{ "CacheSubnetGroupName":{ "shape":"String", "documentation":"

The name of the cache subnet group.

" }, "CacheSubnetGroupDescription":{ "shape":"String", "documentation":"

The description of the cache subnet group.

" }, "VpcId":{ "shape":"String", "documentation":"

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

" }, "Subnets":{ "shape":"SubnetList", "documentation":"

A list of subnets associated with the cache subnet group.

" } }, "wrapper":true, "documentation":"

Represents the output of one of the following operations:

  • CreateCacheSubnetGroup
  • ModifyCacheSubnetGroup
" }, "CacheSubnetGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "error":{ "code":"CacheSubnetGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache subnet group name is already in use by an existing cache subnet group.

" }, "CacheSubnetGroupInUse":{ "type":"structure", "members":{ }, "error":{ "code":"CacheSubnetGroupInUse", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache subnet group is currently in use.

" }, "CacheSubnetGroupMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "CacheSubnetGroups":{ "shape":"CacheSubnetGroups", "documentation":"

A list of cache subnet groups. Each element in the list contains detailed information about one group.

" } }, "documentation":"

Represents the output of a DescribeCacheSubnetGroups operation.

" }, "CacheSubnetGroupNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"CacheSubnetGroupNotFoundFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" }, "CacheSubnetGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"CacheSubnetGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache subnet groups.

" }, "CacheSubnetGroups":{ "type":"list", "member":{ "shape":"CacheSubnetGroup", "locationName":"CacheSubnetGroup" } }, "CacheSubnetQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"CacheSubnetQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

" }, "ClusterIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"ClusterId" } }, "ClusterQuotaForCustomerExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"ClusterQuotaForCustomerExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache clusters per customer.

" }, "CopySnapshotMessage":{ "type":"structure", "required":[ "SourceSnapshotName", "TargetSnapshotName" ], "members":{ "SourceSnapshotName":{ "shape":"String", "documentation":"

The name of an existing snapshot from which to copy.

" }, "TargetSnapshotName":{ "shape":"String", "documentation":"

A name for the copied snapshot.

" } }, "documentation":"

Represents the input of a CopySnapshotMessage operation.

" }, "CreateCacheClusterMessage":{ "type":"structure", "required":["CacheClusterId"], "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

The node group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.
  • The first character must be a letter.
  • A name cannot end with a hyphen or contain two consecutive hyphens.
" }, "ReplicationGroupId":{ "shape":"String", "documentation":"

The ID of the replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be a standalone primary that is not part of any replication group.

If the specified replication group is Automatic Failover enabled and the availability zone is not specified, the cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.

Note: This parameter is only valid if the Engine parameter is redis.

" }, "AZMode":{ "shape":"AZMode", "documentation":"

Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

This parameter is only supported for Memcached cache clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

" }, "PreferredAvailabilityZone":{ "shape":"String", "documentation":"

The EC2 Availability Zone in which the cache cluster will be created.

All nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

" }, "PreferredAvailabilityZones":{ "shape":"PreferredAvailabilityZoneList", "documentation":"

A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.

This option is only supported on Memcached.

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

Example: One Memcached node in each of three different Availability Zones: PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d

Example: All three Memcached nodes in one Availability Zone: PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a

" }, "NumCacheNodes":{ "shape":"IntegerOptional", "documentation":"

The initial number of cache nodes that the cache cluster will have.

For Memcached, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

For Redis, only single-node cache cluster are supported at this time, so the value for this parameter must be 1.

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The compute and memory capacity of the nodes in the node group.

Valid node types are as follows:

  • General purpose:
    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
  • Compute optimized: cache.c1.xlarge
  • Memory optimized
    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
  • Redis backup/restore is not supported for t2 instances.
  • Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

" }, "Engine":{ "shape":"String", "documentation":"

The name of the cache engine to be used for this cache cluster.

Valid values for this parameter are:

memcached | redis

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the cache engine to be used for this cache cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

" }, "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the parameter group to associate with this cache cluster. If this argument is omitted, the default parameter group for the specified engine is used.

" }, "CacheSubnetGroupName":{ "shape":"String", "documentation":"

The name of the subnet group to be used for the cache cluster.

Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).

" }, "CacheSecurityGroupNames":{ "shape":"CacheSecurityGroupNameList", "documentation":"

A list of security group names to associate with this cache cluster.

Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).

" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdsList", "documentation":"

One or more VPC security groups associated with the cache cluster.

Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).

" }, "SnapshotArns":{ "shape":"SnapshotArnsList", "documentation":"

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.

Note: This parameter is only valid if the Engine parameter is redis.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

" }, "SnapshotName":{ "shape":"String", "documentation":"

The name of a snapshot from which to restore data into the new node group. The snapshot status changes to restoring while the new node group is being created.

Note: This parameter is only valid if the Engine parameter is redis.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range (in UTC) during which system maintenance can occur.

Example: sun:05:00-sun:09:00

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which each of the cache nodes will accept connections.

" }, "NotificationTopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

Determines whether minor engine upgrades will be applied automatically to the node group during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.

Default: true

" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", "documentation":"

The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Note: This parameter is only valid if the Engine parameter is redis.

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

" }, "SnapshotWindow":{ "shape":"String", "documentation":"

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

Note: This parameter is only valid if the Engine parameter is redis.

" } }, "documentation":"

Represents the input of a CreateCacheCluster operation.

" }, "CreateCacheParameterGroupMessage":{ "type":"structure", "required":[ "CacheParameterGroupName", "CacheParameterGroupFamily", "Description" ], "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

A user-specified name for the cache parameter group.

" }, "CacheParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the cache parameter group family the cache parameter group can be used with.

Valid values are: memcached1.4 | redis2.6 | redis2.8

" }, "Description":{ "shape":"String", "documentation":"

A user-specified description for the cache parameter group.

" } }, "documentation":"

Represents the input of a CreateCacheParameterGroup operation.

" }, "CreateCacheSecurityGroupMessage":{ "type":"structure", "required":[ "CacheSecurityGroupName", "Description" ], "members":{ "CacheSecurityGroupName":{ "shape":"String", "documentation":"

A name for the cache security group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word \"Default\".

Example: mysecuritygroup

" }, "Description":{ "shape":"String", "documentation":"

A description for the cache security group.

" } }, "documentation":"

Represents the input of a CreateCacheSecurityGroup operation.

" }, "CreateCacheSubnetGroupMessage":{ "type":"structure", "required":[ "CacheSubnetGroupName", "CacheSubnetGroupDescription", "SubnetIds" ], "members":{ "CacheSubnetGroupName":{ "shape":"String", "documentation":"

A name for the cache subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

" }, "CacheSubnetGroupDescription":{ "shape":"String", "documentation":"

A description for the cache subnet group.

" }, "SubnetIds":{ "shape":"SubnetIdentifierList", "documentation":"

A list of VPC subnet IDs for the cache subnet group.

" } }, "documentation":"

Represents the input of a CreateCacheSubnetGroup operation.

" }, "CreateReplicationGroupMessage":{ "type":"structure", "required":[ "ReplicationGroupId", "ReplicationGroupDescription" ], "members":{ "ReplicationGroupId":{ "shape":"String", "documentation":"

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.
  • The first character must be a letter.
  • A name cannot end with a hyphen or contain two consecutive hyphens.
" }, "ReplicationGroupDescription":{ "shape":"String", "documentation":"

A user-created description for the replication group.

" }, "PrimaryClusterId":{ "shape":"String", "documentation":"

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 available.

This parameter is not required if NumCacheClusters is specified.

" }, "AutomaticFailoverEnabled":{ "shape":"BooleanOptional", "documentation":"

Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.

If true, automatic failover is enabled for this replication group. If false, automatic failover is disabled for this replication group.

Default: false

" }, "NumCacheClusters":{ "shape":"IntegerOptional", "documentation":"

The number of cache clusters this replication group will initially have.

If AutomaticFailover is enabled, the value of this parameter must be at least 2.

The maximum permitted value for NumCacheClusters is 6 (primary plus 5 replicas). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request forrm at http://aws.amazon.com/contact-us/elasticache-node-limit-request.

" }, "PreferredCacheClusterAZs":{ "shape":"AvailabilityZonesList", "documentation":"

A list of EC2 availability zones in which the replication group's cache clusters will be created. The order of the availability zones in the list is not important.

Default: system chosen availability zones.

Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-east-1a PreferredAvailabilityZones.member.2=us-east-1c PreferredAvailabilityZones.member.3=us-east-1d

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The compute and memory capacity of the nodes in the node group.

Valid node types are as follows:

  • General purpose:
    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
  • Compute optimized: cache.c1.xlarge
  • Memory optimized
    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
  • Redis backup/restore is not supported for t2 instances.
  • Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

" }, "Engine":{ "shape":"String", "documentation":"

The name of the cache engine to be used for the cache clusters in this replication group.

Default: redis

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version number of the cach engine to be used for the cache clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

" }, "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

" }, "CacheSubnetGroupName":{ "shape":"String", "documentation":"

The name of the cache subnet group to be used for the replication group.

" }, "CacheSecurityGroupNames":{ "shape":"CacheSecurityGroupNameList", "documentation":"

A list of cache security group names to associate with this replication group.

" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdsList", "documentation":"

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (VPC).

" }, "SnapshotArns":{ "shape":"SnapshotArnsList", "documentation":"

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.

Note: This parameter is only valid if the Engine parameter is redis.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

" }, "SnapshotName":{ "shape":"String", "documentation":"

The name of a snapshot from which to restore data into the new node group. The snapshot status changes to restoring while the new node group is being created.

Note: This parameter is only valid if the Engine parameter is redis.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range (in UTC) during which system maintenance can occur.

Example: sun:05:00-sun:09:00

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which each member of the replication group will accept connections.

" }, "NotificationTopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

Determines whether minor engine upgrades will be applied automatically to the node group during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.

Default: true

" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", "documentation":"

The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Note: This parameter is only valid if the Engine parameter is redis.

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

" }, "SnapshotWindow":{ "shape":"String", "documentation":"

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

Note: This parameter is only valid if the Engine parameter is redis.

" } }, "documentation":"

Represents the input of a CreateReplicationGroup operation.

" }, "CreateSnapshotMessage":{ "type":"structure", "required":[ "CacheClusterId", "SnapshotName" ], "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

The identifier of an existing cache cluster. The snapshot will be created from this cache cluster.

" }, "SnapshotName":{ "shape":"String", "documentation":"

A name for the snapshot being created.

" } }, "documentation":"

Represents the input of a CreateSnapshot operation.

" }, "DeleteCacheClusterMessage":{ "type":"structure", "required":["CacheClusterId"], "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

" }, "FinalSnapshotIdentifier":{ "shape":"String", "documentation":"

The user-supplied name of a final cache cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward.

" } }, "documentation":"

Represents the input of a DeleteCacheCluster operation.

" }, "DeleteCacheParameterGroupMessage":{ "type":"structure", "required":["CacheParameterGroupName"], "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the cache parameter group to delete.

" } }, "documentation":"

Represents the input of a DeleteCacheParameterGroup operation.

" }, "DeleteCacheSecurityGroupMessage":{ "type":"structure", "required":["CacheSecurityGroupName"], "members":{ "CacheSecurityGroupName":{ "shape":"String", "documentation":"

The name of the cache security group to delete.

" } }, "documentation":"

Represents the input of a DeleteCacheSecurityGroup operation.

" }, "DeleteCacheSubnetGroupMessage":{ "type":"structure", "required":["CacheSubnetGroupName"], "members":{ "CacheSubnetGroupName":{ "shape":"String", "documentation":"

The name of the cache subnet group to delete.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

" } }, "documentation":"

Represents the input of a DeleteCacheSubnetGroup operation.

" }, "DeleteReplicationGroupMessage":{ "type":"structure", "required":["ReplicationGroupId"], "members":{ "ReplicationGroupId":{ "shape":"String", "documentation":"

The identifier for the cluster to be deleted. This parameter is not case sensitive.

" }, "RetainPrimaryCluster":{ "shape":"BooleanOptional", "documentation":"

If set to true, all of the read replicas will be deleted, but the primary node will be retained.

" }, "FinalSnapshotIdentifier":{ "shape":"String", "documentation":"

The name of a final node group snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the cluster is immediately deleted.

" } }, "documentation":"

Represents the input of a DeleteReplicationGroup operation.

" }, "DeleteSnapshotMessage":{ "type":"structure", "required":["SnapshotName"], "members":{ "SnapshotName":{ "shape":"String", "documentation":"

The name of the snapshot to be deleted.

" } }, "documentation":"

Represents the input of a DeleteSnapshot operation.

" }, "DescribeCacheClustersMessage":{ "type":"structure", "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "ShowCacheNodeInfo":{ "shape":"BooleanOptional", "documentation":"

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

" } }, "documentation":"

Represents the input of a DescribeCacheClusters operation.

" }, "DescribeCacheEngineVersionsMessage":{ "type":"structure", "members":{ "Engine":{ "shape":"String", "documentation":"

The cache engine to return. Valid values: memcached | redis

" }, "EngineVersion":{ "shape":"String", "documentation":"

The cache engine version to return.

Example: 1.4.14

" }, "CacheParameterGroupFamily":{ "shape":"String", "documentation":"

The name of a specific cache parameter group family to return details for.

Constraints:

  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "DefaultOnly":{ "shape":"Boolean", "documentation":"

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

" } }, "documentation":"

Represents the input of a DescribeCacheEngineVersions operation.

" }, "DescribeCacheParameterGroupsMessage":{ "type":"structure", "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of a specific cache parameter group to return details for.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeCacheParameterGroups operation.

" }, "DescribeCacheParametersMessage":{ "type":"structure", "required":["CacheParameterGroupName"], "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of a specific cache parameter group to return details for.

" }, "Source":{ "shape":"String", "documentation":"

The parameter types to return.

Valid values: user | system | engine-default

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeCacheParameters operation.

" }, "DescribeCacheSecurityGroupsMessage":{ "type":"structure", "members":{ "CacheSecurityGroupName":{ "shape":"String", "documentation":"

The name of the cache security group to return details for.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeCacheSecurityGroups operation.

" }, "DescribeCacheSubnetGroupsMessage":{ "type":"structure", "members":{ "CacheSubnetGroupName":{ "shape":"String", "documentation":"

The name of the cache subnet group to return details for.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeCacheSubnetGroups operation.

" }, "DescribeEngineDefaultParametersMessage":{ "type":"structure", "required":["CacheParameterGroupFamily"], "members":{ "CacheParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the cache parameter group family. Valid values are: memcached1.4 | redis2.6 | redis2.8

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeEngineDefaultParameters operation.

" }, "DescribeEventsMessage":{ "type":"structure", "members":{ "SourceIdentifier":{ "shape":"String", "documentation":"

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

" }, "SourceType":{ "shape":"SourceType", "documentation":"

The event source to retrieve events for. If no value is specified, all events are returned.

Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group

" }, "StartTime":{ "shape":"TStamp", "documentation":"

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

" }, "EndTime":{ "shape":"TStamp", "documentation":"

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

" }, "Duration":{ "shape":"IntegerOptional", "documentation":"

The number of minutes' worth of events to retrieve.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeEvents operation.

" }, "DescribeReplicationGroupsMessage":{ "type":"structure", "members":{ "ReplicationGroupId":{ "shape":"String", "documentation":"

The identifier for the replication group to be described. This parameter is not case sensitive.

If you do not specify this parameter, information about all replication groups is returned.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeReplicationGroups operation.

" }, "DescribeReservedCacheNodesMessage":{ "type":"structure", "members":{ "ReservedCacheNodeId":{ "shape":"String", "documentation":"

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

" }, "ReservedCacheNodesOfferingId":{ "shape":"String", "documentation":"

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

" }, "Duration":{ "shape":"String", "documentation":"

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" }, "ProductDescription":{ "shape":"String", "documentation":"

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

" }, "OfferingType":{ "shape":"String", "documentation":"

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeReservedCacheNodes operation.

" }, "DescribeReservedCacheNodesOfferingsMessage":{ "type":"structure", "members":{ "ReservedCacheNodesOfferingId":{ "shape":"String", "documentation":"

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.

" }, "Duration":{ "shape":"String", "documentation":"

Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" }, "ProductDescription":{ "shape":"String", "documentation":"

The product description filter value. Use this parameter to show only the available offerings matching the specified product description.

" }, "OfferingType":{ "shape":"String", "documentation":"

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

Represents the input of a DescribeReservedCacheNodesOfferings operation.

" }, "DescribeSnapshotsListMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "Snapshots":{ "shape":"SnapshotList", "documentation":"

A list of snapshots. Each item in the list contains detailed information about one snapshot.

" } }, "documentation":"

Represents the output of a DescribeSnapshots operation.

" }, "DescribeSnapshotsMessage":{ "type":"structure", "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.

" }, "SnapshotName":{ "shape":"String", "documentation":"

A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.

" }, "SnapshotSource":{ "shape":"String", "documentation":"

If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

" }, "Marker":{ "shape":"String", "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 50

Constraints: minimum 20; maximum 50.

" } }, "documentation":"

Represents the input of a DescribeSnapshotsMessage operation.

" }, "Double":{"type":"double"}, "EC2SecurityGroup":{ "type":"structure", "members":{ "Status":{ "shape":"String", "documentation":"

The status of the Amazon EC2 security group.

" }, "EC2SecurityGroupName":{ "shape":"String", "documentation":"

The name of the Amazon EC2 security group.

" }, "EC2SecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account ID of the Amazon EC2 security group owner.

" } }, "documentation":"

Provides ownership and status information for an Amazon EC2 security group.

" }, "EC2SecurityGroupList":{ "type":"list", "member":{ "shape":"EC2SecurityGroup", "locationName":"EC2SecurityGroup" } }, "Endpoint":{ "type":"structure", "members":{ "Address":{ "shape":"String", "documentation":"

The DNS hostname of the cache node.

" }, "Port":{ "shape":"Integer", "documentation":"

The port number that the cache engine is listening on.

" } }, "documentation":"

Represents the information required for client programs to connect to a cache node.

" }, "EngineDefaults":{ "type":"structure", "members":{ "CacheParameterGroupFamily":{ "shape":"String", "documentation":"

Specifies the name of the cache parameter group family to which the engine default parameters apply.

" }, "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

Contains a list of engine default parameters.

" }, "CacheNodeTypeSpecificParameters":{ "shape":"CacheNodeTypeSpecificParametersList", "documentation":"

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

" } }, "wrapper":true, "documentation":"

Represents the output of a DescribeEngineDefaultParameters operation.

" }, "Event":{ "type":"structure", "members":{ "SourceIdentifier":{ "shape":"String", "documentation":"

The identifier for the source of the event. For example, if the event occurred at the cache cluster level, the identifier would be the name of the cache cluster.

" }, "SourceType":{ "shape":"SourceType", "documentation":"

Specifies the origin of this event - a cache cluster, a parameter group, a security group, etc.

" }, "Message":{ "shape":"String", "documentation":"

The text of the event.

" }, "Date":{ "shape":"TStamp", "documentation":"

The date and time when the event occurred.

" } }, "documentation":"

Represents a single occurrence of something interesting within the system. Some examples of events are creating a cache cluster, adding or removing a cache node, or rebooting a node.

" }, "EventList":{ "type":"list", "member":{ "shape":"Event", "locationName":"Event" } }, "EventsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "Events":{ "shape":"EventList", "documentation":"

A list of events. Each element in the list contains detailed information about one event.

" } }, "documentation":"

Represents the output of a DescribeEvents operation.

" }, "InsufficientCacheClusterCapacityFault":{ "type":"structure", "members":{ }, "error":{ "code":"InsufficientCacheClusterCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache node type is not available in the specified Availability Zone.

" }, "Integer":{"type":"integer"}, "IntegerOptional":{"type":"integer"}, "InvalidCacheClusterStateFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidCacheClusterState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested cache cluster is not in the available state.

" }, "InvalidCacheParameterGroupStateFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidCacheParameterGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The current state of the cache parameter group does not allow the requested action to occur.

" }, "InvalidCacheSecurityGroupStateFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidCacheSecurityGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The current state of the cache security group does not allow deletion.

" }, "InvalidParameterCombinationException":{ "type":"structure", "members":{ "message":{ "shape":"AwsQueryErrorMessage", "documentation":"

Two or more parameters that must not be used together were used together.

" } }, "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Two or more incompatible parameters were specified.

" }, "InvalidParameterValueException":{ "type":"structure", "members":{ "message":{ "shape":"AwsQueryErrorMessage", "documentation":"

A parameter value is invalid.

" } }, "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, "InvalidReplicationGroupStateFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidReplicationGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested replication group is not in the available state.

" }, "InvalidSnapshotStateFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidSnapshotState", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The current state of the snapshot does not allow the requested action to occur.

" }, "InvalidSubnet":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

An invalid subnet identifier was specified.

" }, "InvalidVPCNetworkStateFault":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidVPCNetworkStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The VPC network is in an invalid state.

" }, "ModifyCacheClusterMessage":{ "type":"structure", "required":["CacheClusterId"], "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

The cache cluster identifier. This value is stored as a lowercase string.

" }, "NumCacheNodes":{ "shape":"IntegerOptional", "documentation":"

The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), then more nodes will be added. If the value is less than the number of existing cache nodes, then nodes will be removed. If the value is equal to the number of current cache nodes, then any pending add or remove requests are canceled.

If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

For cache clusters running Redis, the value of NumCacheNodesmust be 1.

Note:
Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See ApplyImmediately.
A pending action to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending actions to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending action to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending action to add nodes. The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending actions to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cache cluster.

" }, "CacheNodeIdsToRemove":{ "shape":"CacheNodeIdsList", "documentation":"

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 is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.

" }, "AZMode":{ "shape":"AZMode", "documentation":"

Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.

Valid values: single-az | cross-az.

This option is only supported for Memcached cache clusters.

" }, "NewAvailabilityZones":{ "shape":"PreferredAvailabilityZoneList", "documentation":"

The list of Availability Zones where the new Memcached cache nodes will be created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

This option is only supported on Memcached clusters.

Scenarios:

  • Scenario 1: You have 3 active nodes and wish to add 2 nodes.
    Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.
  • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node.
    Specify NumCacheNodes=6 ((3 + 2) + 1)
    • and optionally specify an Availability Zone for the new node.
  • Scenario 3: You want to cancel all pending actions.
    Specify NumCacheNodes=3 to cancel all pending actions.

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

Impact of new add/remove requests upon pending requests

Scenarios Pending Operation New Request Results
Scenario-1 Delete Delete The new delete, pending or immediate, replaces the pending delete.
Scenario-2 Delete Create The new create, pending or immediate, replaces the pending delete.
Scenario-3 Create Delete The new delete, pending or immediate, replaces the pending create.
Scenario-4 Create Create The new create is added to the pending create.
Important:
If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.

Example: NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d

" }, "CacheSecurityGroupNames":{ "shape":"CacheSecurityGroupNameList", "documentation":"

A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.

This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".

" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdsList", "documentation":"

Specifies the VPC Security Groups associated with the cache cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range (in UTC) during which system maintenance can occur. Note that system maintenance may result in an outage. This change is made immediately. If you are moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure that pending changes are applied.

" }, "NotificationTopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

" }, "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

" }, "NotificationTopicStatus":{ "shape":"String", "documentation":"

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

" }, "ApplyImmediately":{ "shape":"Boolean", "documentation":"

If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.

If false, then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

Valid values: true | false

Default: false

" }, "EngineVersion":{ "shape":"String", "documentation":"

The upgraded version of the cache engine to be run on the cache nodes.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

If true, then minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.

Valid values: true | false

Default: true

" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", "documentation":"

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" }, "SnapshotWindow":{ "shape":"String", "documentation":"

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

" } }, "documentation":"

Represents the input of a ModifyCacheCluster operation.

" }, "ModifyCacheParameterGroupMessage":{ "type":"structure", "required":[ "CacheParameterGroupName", "ParameterNameValues" ], "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the cache parameter group to modify.

" }, "ParameterNameValues":{ "shape":"ParameterNameValueList", "documentation":"

An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.

" } }, "documentation":"

Represents the input of a ModifyCacheParameterGroup operation.

" }, "ModifyCacheSubnetGroupMessage":{ "type":"structure", "required":["CacheSubnetGroupName"], "members":{ "CacheSubnetGroupName":{ "shape":"String", "documentation":"

The name for the cache subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

" }, "CacheSubnetGroupDescription":{ "shape":"String", "documentation":"

A description for the cache subnet group.

" }, "SubnetIds":{ "shape":"SubnetIdentifierList", "documentation":"

The EC2 subnet IDs for the cache subnet group.

" } }, "documentation":"

Represents the input of a ModifyCacheSubnetGroup operation.

" }, "ModifyReplicationGroupMessage":{ "type":"structure", "required":["ReplicationGroupId"], "members":{ "ReplicationGroupId":{ "shape":"String", "documentation":"

The identifier of the replication group to modify.

" }, "ReplicationGroupDescription":{ "shape":"String", "documentation":"

A description for the replication group. Maximum length is 255 characters.

" }, "PrimaryClusterId":{ "shape":"String", "documentation":"

If this parameter is specified, ElastiCache will promote each of the cache clusters in the specified replication group to the primary role. The nodes of all other cache clusters in the replication group will be read replicas.

" }, "SnapshottingClusterId":{ "shape":"String", "documentation":"

The cache cluster ID that will be used as the daily snapshot source for the replication group.

" }, "AutomaticFailoverEnabled":{ "shape":"BooleanOptional", "documentation":"

Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

" }, "CacheSecurityGroupNames":{ "shape":"CacheSecurityGroupNameList", "documentation":"

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".

" }, "SecurityGroupIds":{ "shape":"SecurityGroupIdsList", "documentation":"

Specifies the VPC Security Groups associated with the cache clusters in the replication group.

This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range (in UTC) during which replication group system maintenance can occur. Note that system maintenance may result in an outage. This change is made immediately. If you are moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure that pending changes are applied.

" }, "NotificationTopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

" }, "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

" }, "NotificationTopicStatus":{ "shape":"String", "documentation":"

The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.

Valid values: active | inactive

" }, "ApplyImmediately":{ "shape":"Boolean", "documentation":"

If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.

If false, then changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

Valid values: true | false

Default: false

" }, "EngineVersion":{ "shape":"String", "documentation":"

The upgraded version of the cache engine to be run on the cache clusters in the replication group.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

Determines whether minor engine upgrades will be applied automatically to all of the clusters in the replication group during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.

" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", "documentation":"

The number of days for which ElastiCache will retain automatic node group snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" }, "SnapshotWindow":{ "shape":"String", "documentation":"

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the node group specified by SnapshottingClusterId.

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

" } }, "documentation":"

Represents the input of a ModifyReplicationGroups operation.

" }, "NodeGroup":{ "type":"structure", "members":{ "NodeGroupId":{ "shape":"String", "documentation":"

The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.

" }, "Status":{ "shape":"String", "documentation":"

The current state of this replication group - creating, available, etc.

" }, "PrimaryEndpoint":{"shape":"Endpoint"}, "NodeGroupMembers":{ "shape":"NodeGroupMemberList", "documentation":"

A list containing information about individual nodes within the node group.

" } }, "documentation":"

Represents a collection of cache nodes in a replication group.

" }, "NodeGroupList":{ "type":"list", "member":{ "shape":"NodeGroup", "locationName":"NodeGroup" } }, "NodeGroupMember":{ "type":"structure", "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

The ID of the cache cluster to which the node belongs.

" }, "CacheNodeId":{ "shape":"String", "documentation":"

The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

" }, "ReadEndpoint":{"shape":"Endpoint"}, "PreferredAvailabilityZone":{ "shape":"String", "documentation":"

The name of the Availability Zone in which the node is located.

" }, "CurrentRole":{ "shape":"String", "documentation":"

The role that is currently assigned to the node - primary or replica.

" } }, "documentation":"

Represents a single node within a node group.

" }, "NodeGroupMemberList":{ "type":"list", "member":{ "shape":"NodeGroupMember", "locationName":"NodeGroupMember" } }, "NodeQuotaForClusterExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"NodeQuotaForClusterExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

" }, "NodeQuotaForCustomerExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"NodeQuotaForCustomerExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

" }, "NodeSnapshot":{ "type":"structure", "members":{ "CacheNodeId":{ "shape":"String", "documentation":"

The cache node identifier for the node in the source cache cluster.

" }, "CacheSize":{ "shape":"String", "documentation":"

The size of the cache on the source cache node.

" }, "CacheNodeCreateTime":{ "shape":"TStamp", "documentation":"

The date and time when the cache node was created in the source cache cluster.

" }, "SnapshotCreateTime":{ "shape":"TStamp", "documentation":"

The date and time when the source node's metadata and cache data set was obtained for the snapshot.

" } }, "wrapper":true, "documentation":"

Represents an individual cache node in a snapshot of a cache cluster.

" }, "NodeSnapshotList":{ "type":"list", "member":{ "shape":"NodeSnapshot", "locationName":"NodeSnapshot" } }, "NotificationConfiguration":{ "type":"structure", "members":{ "TopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that identifies the topic.

" }, "TopicStatus":{ "shape":"String", "documentation":"

The current state of the topic.

" } }, "documentation":"

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

" }, "Parameter":{ "type":"structure", "members":{ "ParameterName":{ "shape":"String", "documentation":"

The name of the parameter.

" }, "ParameterValue":{ "shape":"String", "documentation":"

The value of the parameter.

" }, "Description":{ "shape":"String", "documentation":"

A description of the parameter.

" }, "Source":{ "shape":"String", "documentation":"

The source of the parameter.

" }, "DataType":{ "shape":"String", "documentation":"

The valid data type for the parameter.

" }, "AllowedValues":{ "shape":"String", "documentation":"

The valid range of values for the parameter.

" }, "IsModifiable":{ "shape":"Boolean", "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" }, "MinimumEngineVersion":{ "shape":"String", "documentation":"

The earliest cache engine version to which the parameter can apply.

" } }, "documentation":"

Describes an individual setting that controls some aspect of ElastiCache behavior.

" }, "ParameterNameValue":{ "type":"structure", "members":{ "ParameterName":{ "shape":"String", "documentation":"

The name of the parameter.

" }, "ParameterValue":{ "shape":"String", "documentation":"

The value of the parameter.

" } }, "documentation":"

Describes a name-value pair that is used to update the value of a parameter.

" }, "ParameterNameValueList":{ "type":"list", "member":{ "shape":"ParameterNameValue", "locationName":"ParameterNameValue" } }, "ParametersList":{ "type":"list", "member":{ "shape":"Parameter", "locationName":"Parameter" } }, "PendingAutomaticFailoverStatus":{ "type":"string", "enum":[ "enabled", "disabled" ] }, "PendingModifiedValues":{ "type":"structure", "members":{ "NumCacheNodes":{ "shape":"IntegerOptional", "documentation":"

The new number of cache nodes for the cache cluster.

" }, "CacheNodeIdsToRemove":{ "shape":"CacheNodeIdsList", "documentation":"

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.).

" }, "EngineVersion":{ "shape":"String", "documentation":"

The new cache engine version that the cache cluster will run.

" } }, "documentation":"

A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.

" }, "PreferredAvailabilityZoneList":{ "type":"list", "member":{ "shape":"String", "locationName":"PreferredAvailabilityZone" } }, "PurchaseReservedCacheNodesOfferingMessage":{ "type":"structure", "required":["ReservedCacheNodesOfferingId"], "members":{ "ReservedCacheNodesOfferingId":{ "shape":"String", "documentation":"

The ID of the reserved cache node offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" }, "ReservedCacheNodeId":{ "shape":"String", "documentation":"

A customer-specified identifier to track this reservation.

Example: myreservationID

" }, "CacheNodeCount":{ "shape":"IntegerOptional", "documentation":"

The number of cache node instances to reserve.

Default: 1

" } }, "documentation":"

Represents the input of a PurchaseReservedCacheNodesOffering operation.

" }, "RebootCacheClusterMessage":{ "type":"structure", "required":[ "CacheClusterId", "CacheNodeIdsToReboot" ], "members":{ "CacheClusterId":{ "shape":"String", "documentation":"

The cache cluster identifier. This parameter is stored as a lowercase string.

" }, "CacheNodeIdsToReboot":{ "shape":"CacheNodeIdsList", "documentation":"

A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.

" } }, "documentation":"

Represents the input of a RebootCacheCluster operation.

" }, "RecurringCharge":{ "type":"structure", "members":{ "RecurringChargeAmount":{ "shape":"Double", "documentation":"

The monetary amount of the recurring charge.

" }, "RecurringChargeFrequency":{ "shape":"String", "documentation":"

The frequency of the recurring charge.

" } }, "wrapper":true, "documentation":"

Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.

" }, "RecurringChargeList":{ "type":"list", "member":{ "shape":"RecurringCharge", "locationName":"RecurringCharge" } }, "ReplicationGroup":{ "type":"structure", "members":{ "ReplicationGroupId":{ "shape":"String", "documentation":"

The identifier for the replication group.

" }, "Description":{ "shape":"String", "documentation":"

The description of the replication group.

" }, "Status":{ "shape":"String", "documentation":"

The current state of this replication group - creating, available, etc.

" }, "PendingModifiedValues":{ "shape":"ReplicationGroupPendingModifiedValues", "documentation":"

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

" }, "MemberClusters":{ "shape":"ClusterIdList", "documentation":"

The names of all the cache clusters that are part of this replication group.

" }, "NodeGroups":{ "shape":"NodeGroupList", "documentation":"

A single element list with information about the nodes in the replication group.

" }, "SnapshottingClusterId":{ "shape":"String", "documentation":"

The cache cluster ID that is used as the daily snapshot source for the replication group.

" }, "AutomaticFailover":{ "shape":"AutomaticFailoverStatus", "documentation":"

Indicates the status of automatic failover for this replication group.

" } }, "wrapper":true, "documentation":"

Contains all of the attributes of a specific replication group.

" }, "ReplicationGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "error":{ "code":"ReplicationGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified replication group already exists.

" }, "ReplicationGroupList":{ "type":"list", "member":{ "shape":"ReplicationGroup", "locationName":"ReplicationGroup" } }, "ReplicationGroupMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "ReplicationGroups":{ "shape":"ReplicationGroupList", "documentation":"

A list of replication groups. Each item in the list contains detailed information about one replication group.

" } }, "documentation":"

Represents the output of a DescribeReplicationGroups operation.

" }, "ReplicationGroupNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"ReplicationGroupNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified replication group does not exist.

" }, "ReplicationGroupPendingModifiedValues":{ "type":"structure", "members":{ "PrimaryClusterId":{ "shape":"String", "documentation":"

The primary cluster ID which will be applied immediately (if --apply-immediately was specified), or during the next maintenance window.

" }, "AutomaticFailoverStatus":{ "shape":"PendingAutomaticFailoverStatus", "documentation":"

Indicates the status of automatic failover for this replication group.

" } }, "documentation":"

The settings to be applied to the replication group, either immediately or during the next maintenance window.

" }, "ReservedCacheNode":{ "type":"structure", "members":{ "ReservedCacheNodeId":{ "shape":"String", "documentation":"

The unique identifier for the reservation.

" }, "ReservedCacheNodesOfferingId":{ "shape":"String", "documentation":"

The offering identifier.

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The cache node type for the reserved cache nodes.

" }, "StartTime":{ "shape":"TStamp", "documentation":"

The time the reservation started.

" }, "Duration":{ "shape":"Integer", "documentation":"

The duration of the reservation in seconds.

" }, "FixedPrice":{ "shape":"Double", "documentation":"

The fixed price charged for this reserved cache node.

" }, "UsagePrice":{ "shape":"Double", "documentation":"

The hourly price charged for this reserved cache node.

" }, "CacheNodeCount":{ "shape":"Integer", "documentation":"

The number of cache nodes that have been reserved.

" }, "ProductDescription":{ "shape":"String", "documentation":"

The description of the reserved cache node.

" }, "OfferingType":{ "shape":"String", "documentation":"

The offering type of this reserved cache node.

" }, "State":{ "shape":"String", "documentation":"

The state of the reserved cache node.

" }, "RecurringCharges":{ "shape":"RecurringChargeList", "documentation":"

The recurring price charged to run this reserved cache node.

" } }, "wrapper":true, "documentation":"

Represents the output of a PurchaseReservedCacheNodesOffering operation.

" }, "ReservedCacheNodeAlreadyExistsFault":{ "type":"structure", "members":{ }, "error":{ "code":"ReservedCacheNodeAlreadyExists", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

You already have a reservation with the given identifier.

" }, "ReservedCacheNodeList":{ "type":"list", "member":{ "shape":"ReservedCacheNode", "locationName":"ReservedCacheNode" } }, "ReservedCacheNodeMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "ReservedCacheNodes":{ "shape":"ReservedCacheNodeList", "documentation":"

A list of reserved cache nodes. Each element in the list contains detailed information about one node.

" } }, "documentation":"

Represents the output of a DescribeReservedCacheNodes operation.

" }, "ReservedCacheNodeNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"ReservedCacheNodeNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested reserved cache node was not found.

" }, "ReservedCacheNodeQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"ReservedCacheNodeQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the user's cache node quota.

" }, "ReservedCacheNodesOffering":{ "type":"structure", "members":{ "ReservedCacheNodesOfferingId":{ "shape":"String", "documentation":"

A unique identifier for the reserved cache node offering.

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The cache node type for the reserved cache node.

" }, "Duration":{ "shape":"Integer", "documentation":"

The duration of the offering. in seconds.

" }, "FixedPrice":{ "shape":"Double", "documentation":"

The fixed price charged for this offering.

" }, "UsagePrice":{ "shape":"Double", "documentation":"

The hourly price charged for this offering.

" }, "ProductDescription":{ "shape":"String", "documentation":"

The cache engine used by the offering.

" }, "OfferingType":{ "shape":"String", "documentation":"

The offering type.

" }, "RecurringCharges":{ "shape":"RecurringChargeList", "documentation":"

The recurring price charged to run this reserved cache node.

" } }, "wrapper":true, "documentation":"

Describes all of the attributes of a reserved cache node offering.

" }, "ReservedCacheNodesOfferingList":{ "type":"list", "member":{ "shape":"ReservedCacheNodesOffering", "locationName":"ReservedCacheNodesOffering" } }, "ReservedCacheNodesOfferingMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Provides an identifier to allow retrieval of paginated results.

" }, "ReservedCacheNodesOfferings":{ "shape":"ReservedCacheNodesOfferingList", "documentation":"

A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.

" } }, "documentation":"

Represents the output of a DescribeReservedCacheNodesOfferings operation.

" }, "ReservedCacheNodesOfferingNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"ReservedCacheNodesOfferingNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested cache node offering does not exist.

" }, "ResetCacheParameterGroupMessage":{ "type":"structure", "required":[ "CacheParameterGroupName", "ParameterNameValues" ], "members":{ "CacheParameterGroupName":{ "shape":"String", "documentation":"

The name of the cache parameter group to reset.

" }, "ResetAllParameters":{ "shape":"Boolean", "documentation":"

If true, all parameters in the cache parameter group will be reset to default values. If false, no such action occurs.

Valid values: true | false

" }, "ParameterNameValues":{ "shape":"ParameterNameValueList", "documentation":"

An array of parameter names to be reset. If you are not resetting the entire cache parameter group, you must specify at least one parameter name.

" } }, "documentation":"

Represents the input of a ResetCacheParameterGroup operation.

" }, "RevokeCacheSecurityGroupIngressMessage":{ "type":"structure", "required":[ "CacheSecurityGroupName", "EC2SecurityGroupName", "EC2SecurityGroupOwnerId" ], "members":{ "CacheSecurityGroupName":{ "shape":"String", "documentation":"

The name of the cache security group to revoke ingress from.

" }, "EC2SecurityGroupName":{ "shape":"String", "documentation":"

The name of the Amazon EC2 security group to revoke access from.

" }, "EC2SecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.

" } }, "documentation":"

Represents the input of a RevokeCacheSecurityGroupIngress operation.

" }, "SecurityGroupIdsList":{ "type":"list", "member":{ "shape":"String", "locationName":"SecurityGroupId" } }, "SecurityGroupMembership":{ "type":"structure", "members":{ "SecurityGroupId":{ "shape":"String", "documentation":"

The identifier of the cache security group.

" }, "Status":{ "shape":"String", "documentation":"

The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

" } }, "documentation":"

Represents a single cache security group and its status..

" }, "SecurityGroupMembershipList":{ "type":"list", "member":{"shape":"SecurityGroupMembership"} }, "Snapshot":{ "type":"structure", "members":{ "SnapshotName":{ "shape":"String", "documentation":"

The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.

" }, "CacheClusterId":{ "shape":"String", "documentation":"

The user-supplied identifier of the source cache cluster.

" }, "SnapshotStatus":{ "shape":"String", "documentation":"

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

" }, "SnapshotSource":{ "shape":"String", "documentation":"

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

" }, "CacheNodeType":{ "shape":"String", "documentation":"

The name of the compute and memory capacity node type for the source cache cluster.

" }, "Engine":{ "shape":"String", "documentation":"

The name of the cache engine (memcached or redis) used by the source cache cluster.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The version of the cache engine version that is used by the source cache cluster.

" }, "NumCacheNodes":{ "shape":"IntegerOptional", "documentation":"

The number of cache nodes in the source cache cluster.

" }, "PreferredAvailabilityZone":{ "shape":"String", "documentation":"

The name of the Availability Zone in which the source cache cluster is located.

" }, "CacheClusterCreateTime":{ "shape":"TStamp", "documentation":"

The date and time when the source cache cluster was created.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The time range (in UTC) during which weekly system maintenance can occur on the source cache cluster.

" }, "TopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number used by each cache nodes in the source cache cluster.

" }, "CacheParameterGroupName":{ "shape":"String", "documentation":"

The cache parameter group that is associated with the source cache cluster.

" }, "CacheSubnetGroupName":{ "shape":"String", "documentation":"

The name of the cache subnet group associated with the source cache cluster.

" }, "VpcId":{ "shape":"String", "documentation":"

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.

" }, "AutoMinorVersionUpgrade":{ "shape":"Boolean", "documentation":"

For the source cache cluster, indicates whether minor version patches are applied automatically (true) or not (false).

" }, "SnapshotRetentionLimit":{ "shape":"IntegerOptional", "documentation":"

For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.

For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.

Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" }, "SnapshotWindow":{ "shape":"String", "documentation":"

The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.

" }, "NodeSnapshots":{ "shape":"NodeSnapshotList", "documentation":"

A list of the cache nodes in the source cache cluster.

" } }, "wrapper":true, "documentation":"

Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

" }, "SnapshotAlreadyExistsFault":{ "type":"structure", "members":{ }, "error":{ "code":"SnapshotAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You already have a snapshot with the given name.

" }, "SnapshotArnsList":{ "type":"list", "member":{ "shape":"String", "locationName":"SnapshotArn" } }, "SnapshotFeatureNotSupportedFault":{ "type":"structure", "members":{ }, "error":{ "code":"SnapshotFeatureNotSupportedFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

You attempted one of the following actions:

  • Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.

  • Creating a snapshot of a cache cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

" }, "SnapshotList":{ "type":"list", "member":{ "shape":"Snapshot", "locationName":"Snapshot" } }, "SnapshotNotFoundFault":{ "type":"structure", "members":{ }, "error":{ "code":"SnapshotNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The requested snapshot name does not refer to an existing snapshot.

" }, "SnapshotQuotaExceededFault":{ "type":"structure", "members":{ }, "error":{ "code":"SnapshotQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

" }, "SourceType":{ "type":"string", "enum":[ "cache-cluster", "cache-parameter-group", "cache-security-group", "cache-subnet-group" ] }, "String":{"type":"string"}, "Subnet":{ "type":"structure", "members":{ "SubnetIdentifier":{ "shape":"String", "documentation":"

The unique identifier for the subnet

" }, "SubnetAvailabilityZone":{ "shape":"AvailabilityZone", "documentation":"

The Availability Zone associated with the subnet

" } }, "documentation":"

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.

" }, "SubnetIdentifierList":{ "type":"list", "member":{ "shape":"String", "locationName":"SubnetIdentifier" } }, "SubnetInUse":{ "type":"structure", "members":{ }, "error":{ "code":"SubnetInUse", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The requested subnet is being used by another cache subnet group.

" }, "SubnetList":{ "type":"list", "member":{ "shape":"Subnet", "locationName":"Subnet" } }, "TStamp":{"type":"timestamp"}, "AuthorizeCacheSecurityGroupIngressResult":{ "type":"structure", "members":{ "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} } }, "CopySnapshotResult":{ "type":"structure", "members":{ "Snapshot":{"shape":"Snapshot"} } }, "CreateCacheClusterResult":{ "type":"structure", "members":{ "CacheCluster":{"shape":"CacheCluster"} } }, "CreateCacheParameterGroupResult":{ "type":"structure", "members":{ "CacheParameterGroup":{"shape":"CacheParameterGroup"} } }, "CreateCacheSecurityGroupResult":{ "type":"structure", "members":{ "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} } }, "CreateCacheSubnetGroupResult":{ "type":"structure", "members":{ "CacheSubnetGroup":{"shape":"CacheSubnetGroup"} } }, "CreateReplicationGroupResult":{ "type":"structure", "members":{ "ReplicationGroup":{"shape":"ReplicationGroup"} } }, "CreateSnapshotResult":{ "type":"structure", "members":{ "Snapshot":{"shape":"Snapshot"} } }, "DeleteCacheClusterResult":{ "type":"structure", "members":{ "CacheCluster":{"shape":"CacheCluster"} } }, "DeleteReplicationGroupResult":{ "type":"structure", "members":{ "ReplicationGroup":{"shape":"ReplicationGroup"} } }, "DeleteSnapshotResult":{ "type":"structure", "members":{ "Snapshot":{"shape":"Snapshot"} } }, "DescribeEngineDefaultParametersResult":{ "type":"structure", "members":{ "EngineDefaults":{"shape":"EngineDefaults"} } }, "ModifyCacheClusterResult":{ "type":"structure", "members":{ "CacheCluster":{"shape":"CacheCluster"} } }, "ModifyCacheSubnetGroupResult":{ "type":"structure", "members":{ "CacheSubnetGroup":{"shape":"CacheSubnetGroup"} } }, "ModifyReplicationGroupResult":{ "type":"structure", "members":{ "ReplicationGroup":{"shape":"ReplicationGroup"} } }, "PurchaseReservedCacheNodesOfferingResult":{ "type":"structure", "members":{ "ReservedCacheNode":{"shape":"ReservedCacheNode"} } }, "RebootCacheClusterResult":{ "type":"structure", "members":{ "CacheCluster":{"shape":"CacheCluster"} } }, "RevokeCacheSecurityGroupIngressResult":{ "type":"structure", "members":{ "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} } } } } botocore-1.5.7/botocore/data/redshift/0000777454262600001440000000000013042511307020743 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/redshift/2012-12-01/0000777454262600001440000000000013042511307021765 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/redshift/2012-12-01/waiters-2.json0000666454262600001440000000350513042511306024477 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "ClusterAvailable": { "delay": 60, "operation": "DescribeClusters", "maxAttempts": 30, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Clusters[].ClusterStatus" }, { "expected": "deleting", "matcher": "pathAny", "state": "failure", "argument": "Clusters[].ClusterStatus" }, { "expected": "ClusterNotFound", "matcher": "error", "state": "retry" } ] }, "ClusterDeleted": { "delay": 60, "operation": "DescribeClusters", "maxAttempts": 30, "acceptors": [ { "expected": "ClusterNotFound", "matcher": "error", "state": "success" }, { "expected": "creating", "matcher": "pathAny", "state": "failure", "argument": "Clusters[].ClusterStatus" }, { "expected": "rebooting", "matcher": "pathAny", "state": "failure", "argument": "Clusters[].ClusterStatus" } ] }, "SnapshotAvailable": { "delay": 15, "operation": "DescribeClusterSnapshots", "maxAttempts": 20, "acceptors": [ { "expected": "available", "matcher": "pathAll", "state": "success", "argument": "Snapshots[].Status" }, { "expected": "failed", "matcher": "pathAny", "state": "failure", "argument": "Snapshots[].Status" }, { "expected": "deleted", "matcher": "pathAny", "state": "failure", "argument": "Snapshots[].Status" } ] } } } botocore-1.5.7/botocore/data/redshift/2012-12-01/paginators-1.json0000666454262600001440000000524613042511306025173 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeClusterParameterGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ParameterGroups" }, "DescribeClusterParameters": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Parameters" }, "DescribeClusterSecurityGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ClusterSecurityGroups" }, "DescribeClusterSnapshots": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Snapshots" }, "DescribeClusterSubnetGroups": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ClusterSubnetGroups" }, "DescribeClusterVersions": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ClusterVersions" }, "DescribeClusters": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Clusters" }, "DescribeDefaultClusterParameters": { "input_token": "Marker", "output_token": "DefaultClusterParameters.Marker", "limit_key": "MaxRecords", "result_key": "DefaultClusterParameters.Parameters" }, "DescribeEventSubscriptions": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "EventSubscriptionsList" }, "DescribeEvents": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "Events" }, "DescribeHsmClientCertificates": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "HsmClientCertificates" }, "DescribeHsmConfigurations": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "HsmConfigurations" }, "DescribeOrderableClusterOptions": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "OrderableClusterOptions" }, "DescribeReservedNodeOfferings": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReservedNodeOfferings" }, "DescribeReservedNodes": { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "ReservedNodes" } } } botocore-1.5.7/botocore/data/redshift/2012-12-01/service-2.json0000666454262600001440000107725313042511306024475 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"redshift-2012-12-01", "apiVersion":"2012-12-01", "endpointPrefix":"redshift", "protocol":"query", "serviceFullName":"Amazon Redshift", "signatureVersion":"v4", "xmlNamespace":"http://redshift.amazonaws.com/doc/2012-12-01/" }, "operations":{ "AuthorizeClusterSecurityGroupIngress":{ "name":"AuthorizeClusterSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeClusterSecurityGroupIngressMessage"}, "output":{ "shape":"AuthorizeClusterSecurityGroupIngressResult", "resultWrapper":"AuthorizeClusterSecurityGroupIngressResult" }, "errors":[ {"shape":"ClusterSecurityGroupNotFoundFault"}, {"shape":"InvalidClusterSecurityGroupStateFault"}, {"shape":"AuthorizationAlreadyExistsFault"}, {"shape":"AuthorizationQuotaExceededFault"} ], "documentation":"

Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.

If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS region.

If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.

You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.

" }, "AuthorizeSnapshotAccess":{ "name":"AuthorizeSnapshotAccess", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AuthorizeSnapshotAccessMessage"}, "output":{ "shape":"AuthorizeSnapshotAccessResult", "resultWrapper":"AuthorizeSnapshotAccessResult" }, "errors":[ {"shape":"ClusterSnapshotNotFoundFault"}, {"shape":"AuthorizationAlreadyExistsFault"}, {"shape":"AuthorizationQuotaExceededFault"}, {"shape":"DependentServiceRequestThrottlingFault"}, {"shape":"InvalidClusterSnapshotStateFault"}, {"shape":"LimitExceededFault"} ], "documentation":"

Authorizes the specified AWS customer account to restore the specified snapshot.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

" }, "CopyClusterSnapshot":{ "name":"CopyClusterSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CopyClusterSnapshotMessage"}, "output":{ "shape":"CopyClusterSnapshotResult", "resultWrapper":"CopyClusterSnapshotResult" }, "errors":[ {"shape":"ClusterSnapshotAlreadyExistsFault"}, {"shape":"ClusterSnapshotNotFoundFault"}, {"shape":"InvalidClusterSnapshotStateFault"}, {"shape":"ClusterSnapshotQuotaExceededFault"} ], "documentation":"

Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.

When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

" }, "CreateCluster":{ "name":"CreateCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateClusterMessage"}, "output":{ "shape":"CreateClusterResult", "resultWrapper":"CreateClusterResult" }, "errors":[ {"shape":"ClusterAlreadyExistsFault"}, {"shape":"InsufficientClusterCapacityFault"}, {"shape":"ClusterParameterGroupNotFoundFault"}, {"shape":"ClusterSecurityGroupNotFoundFault"}, {"shape":"ClusterQuotaExceededFault"}, {"shape":"NumberOfNodesQuotaExceededFault"}, {"shape":"NumberOfNodesPerClusterLimitExceededFault"}, {"shape":"ClusterSubnetGroupNotFoundFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"InvalidClusterSubnetGroupStateFault"}, {"shape":"InvalidSubnet"}, {"shape":"UnauthorizedOperation"}, {"shape":"HsmClientCertificateNotFoundFault"}, {"shape":"HsmConfigurationNotFoundFault"}, {"shape":"InvalidElasticIpFault"}, {"shape":"TagLimitExceededFault"}, {"shape":"InvalidTagFault"}, {"shape":"LimitExceededFault"}, {"shape":"DependentServiceRequestThrottlingFault"} ], "documentation":"

Creates a new cluster.

To create the cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

" }, "CreateClusterParameterGroup":{ "name":"CreateClusterParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateClusterParameterGroupMessage"}, "output":{ "shape":"CreateClusterParameterGroupResult", "resultWrapper":"CreateClusterParameterGroupResult" }, "errors":[ {"shape":"ClusterParameterGroupQuotaExceededFault"}, {"shape":"ClusterParameterGroupAlreadyExistsFault"}, {"shape":"TagLimitExceededFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Creates an Amazon Redshift parameter group.

Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.

Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

" }, "CreateClusterSecurityGroup":{ "name":"CreateClusterSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateClusterSecurityGroupMessage"}, "output":{ "shape":"CreateClusterSecurityGroupResult", "resultWrapper":"CreateClusterSecurityGroupResult" }, "errors":[ {"shape":"ClusterSecurityGroupAlreadyExistsFault"}, {"shape":"ClusterSecurityGroupQuotaExceededFault"}, {"shape":"TagLimitExceededFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

" }, "CreateClusterSnapshot":{ "name":"CreateClusterSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateClusterSnapshotMessage"}, "output":{ "shape":"CreateClusterSnapshotResult", "resultWrapper":"CreateClusterSnapshotResult" }, "errors":[ {"shape":"ClusterSnapshotAlreadyExistsFault"}, {"shape":"InvalidClusterStateFault"}, {"shape":"ClusterNotFoundFault"}, {"shape":"ClusterSnapshotQuotaExceededFault"}, {"shape":"TagLimitExceededFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Creates a manual snapshot of the specified cluster. The cluster must be in the available state.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

" }, "CreateClusterSubnetGroup":{ "name":"CreateClusterSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateClusterSubnetGroupMessage"}, "output":{ "shape":"CreateClusterSubnetGroupResult", "resultWrapper":"CreateClusterSubnetGroupResult" }, "errors":[ {"shape":"ClusterSubnetGroupAlreadyExistsFault"}, {"shape":"ClusterSubnetGroupQuotaExceededFault"}, {"shape":"ClusterSubnetQuotaExceededFault"}, {"shape":"InvalidSubnet"}, {"shape":"UnauthorizedOperation"}, {"shape":"TagLimitExceededFault"}, {"shape":"InvalidTagFault"}, {"shape":"DependentServiceRequestThrottlingFault"} ], "documentation":"

Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.

For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.

" }, "CreateEventSubscription":{ "name":"CreateEventSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateEventSubscriptionMessage"}, "output":{ "shape":"CreateEventSubscriptionResult", "resultWrapper":"CreateEventSubscriptionResult" }, "errors":[ {"shape":"EventSubscriptionQuotaExceededFault"}, {"shape":"SubscriptionAlreadyExistFault"}, {"shape":"SNSInvalidTopicFault"}, {"shape":"SNSNoAuthorizationFault"}, {"shape":"SNSTopicArnNotFoundFault"}, {"shape":"SubscriptionEventIdNotFoundFault"}, {"shape":"SubscriptionCategoryNotFoundFault"}, {"shape":"SubscriptionSeverityNotFoundFault"}, {"shape":"SourceNotFoundFault"}, {"shape":"TagLimitExceededFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.

If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.

" }, "CreateHsmClientCertificate":{ "name":"CreateHsmClientCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateHsmClientCertificateMessage"}, "output":{ "shape":"CreateHsmClientCertificateResult", "resultWrapper":"CreateHsmClientCertificateResult" }, "errors":[ {"shape":"HsmClientCertificateAlreadyExistsFault"}, {"shape":"HsmClientCertificateQuotaExceededFault"}, {"shape":"TagLimitExceededFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.

The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.

" }, "CreateHsmConfiguration":{ "name":"CreateHsmConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateHsmConfigurationMessage"}, "output":{ "shape":"CreateHsmConfigurationResult", "resultWrapper":"CreateHsmConfigurationResult" }, "errors":[ {"shape":"HsmConfigurationAlreadyExistsFault"}, {"shape":"HsmConfigurationQuotaExceededFault"}, {"shape":"TagLimitExceededFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.

In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.

" }, "CreateSnapshotCopyGrant":{ "name":"CreateSnapshotCopyGrant", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSnapshotCopyGrantMessage"}, "output":{ "shape":"CreateSnapshotCopyGrantResult", "resultWrapper":"CreateSnapshotCopyGrantResult" }, "errors":[ {"shape":"SnapshotCopyGrantAlreadyExistsFault"}, {"shape":"SnapshotCopyGrantQuotaExceededFault"}, {"shape":"LimitExceededFault"}, {"shape":"TagLimitExceededFault"}, {"shape":"InvalidTagFault"}, {"shape":"DependentServiceRequestThrottlingFault"} ], "documentation":"

Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

" }, "CreateTags":{ "name":"CreateTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTagsMessage"}, "errors":[ {"shape":"TagLimitExceededFault"}, {"shape":"ResourceNotFoundFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Adds one or more tags to a specified resource.

A resource can have up to 10 tags. If you try to create more than 10 tags for a resource, you will receive an error and the attempt will fail.

If you specify a key that already exists for the resource, the value for that key will be updated with the new value.

" }, "DeleteCluster":{ "name":"DeleteCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteClusterMessage"}, "output":{ "shape":"DeleteClusterResult", "resultWrapper":"DeleteClusterResult" }, "errors":[ {"shape":"ClusterNotFoundFault"}, {"shape":"InvalidClusterStateFault"}, {"shape":"ClusterSnapshotAlreadyExistsFault"}, {"shape":"ClusterSnapshotQuotaExceededFault"} ], "documentation":"

Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be \"final-snapshot\" while the snapshot is being taken, then it's \"deleting\" once Amazon Redshift begins deleting the cluster.

For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

" }, "DeleteClusterParameterGroup":{ "name":"DeleteClusterParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteClusterParameterGroupMessage"}, "errors":[ {"shape":"InvalidClusterParameterGroupStateFault"}, {"shape":"ClusterParameterGroupNotFoundFault"} ], "documentation":"

Deletes a specified Amazon Redshift parameter group.

You cannot delete a parameter group if it is associated with a cluster.

" }, "DeleteClusterSecurityGroup":{ "name":"DeleteClusterSecurityGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteClusterSecurityGroupMessage"}, "errors":[ {"shape":"InvalidClusterSecurityGroupStateFault"}, {"shape":"ClusterSecurityGroupNotFoundFault"} ], "documentation":"

Deletes an Amazon Redshift security group.

You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

" }, "DeleteClusterSnapshot":{ "name":"DeleteClusterSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteClusterSnapshotMessage"}, "output":{ "shape":"DeleteClusterSnapshotResult", "resultWrapper":"DeleteClusterSnapshotResult" }, "errors":[ {"shape":"InvalidClusterSnapshotStateFault"}, {"shape":"ClusterSnapshotNotFoundFault"} ], "documentation":"

Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot.

Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.

" }, "DeleteClusterSubnetGroup":{ "name":"DeleteClusterSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteClusterSubnetGroupMessage"}, "errors":[ {"shape":"InvalidClusterSubnetGroupStateFault"}, {"shape":"InvalidClusterSubnetStateFault"}, {"shape":"ClusterSubnetGroupNotFoundFault"} ], "documentation":"

Deletes the specified cluster subnet group.

" }, "DeleteEventSubscription":{ "name":"DeleteEventSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteEventSubscriptionMessage"}, "errors":[ {"shape":"SubscriptionNotFoundFault"}, {"shape":"InvalidSubscriptionStateFault"} ], "documentation":"

Deletes an Amazon Redshift event notification subscription.

" }, "DeleteHsmClientCertificate":{ "name":"DeleteHsmClientCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteHsmClientCertificateMessage"}, "errors":[ {"shape":"InvalidHsmClientCertificateStateFault"}, {"shape":"HsmClientCertificateNotFoundFault"} ], "documentation":"

Deletes the specified HSM client certificate.

" }, "DeleteHsmConfiguration":{ "name":"DeleteHsmConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteHsmConfigurationMessage"}, "errors":[ {"shape":"InvalidHsmConfigurationStateFault"}, {"shape":"HsmConfigurationNotFoundFault"} ], "documentation":"

Deletes the specified Amazon Redshift HSM configuration.

" }, "DeleteSnapshotCopyGrant":{ "name":"DeleteSnapshotCopyGrant", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSnapshotCopyGrantMessage"}, "errors":[ {"shape":"InvalidSnapshotCopyGrantStateFault"}, {"shape":"SnapshotCopyGrantNotFoundFault"} ], "documentation":"

Deletes the specified snapshot copy grant.

" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsMessage"}, "errors":[ {"shape":"ResourceNotFoundFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.

" }, "DescribeClusterParameterGroups":{ "name":"DescribeClusterParameterGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClusterParameterGroupsMessage"}, "output":{ "shape":"ClusterParameterGroupsMessage", "resultWrapper":"DescribeClusterParameterGroupsResult" }, "errors":[ {"shape":"ClusterParameterGroupNotFoundFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.

" }, "DescribeClusterParameters":{ "name":"DescribeClusterParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClusterParametersMessage"}, "output":{ "shape":"ClusterParameterGroupDetails", "resultWrapper":"DescribeClusterParametersResult" }, "errors":[ {"shape":"ClusterParameterGroupNotFoundFault"} ], "documentation":"

Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.

You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

" }, "DescribeClusterSecurityGroups":{ "name":"DescribeClusterSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClusterSecurityGroupsMessage"}, "output":{ "shape":"ClusterSecurityGroupMessage", "resultWrapper":"DescribeClusterSecurityGroupsResult" }, "errors":[ {"shape":"ClusterSecurityGroupNotFoundFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.

" }, "DescribeClusterSnapshots":{ "name":"DescribeClusterSnapshots", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClusterSnapshotsMessage"}, "output":{ "shape":"SnapshotMessage", "resultWrapper":"DescribeClusterSnapshotsResult" }, "errors":[ {"shape":"ClusterSnapshotNotFoundFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.

If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.

" }, "DescribeClusterSubnetGroups":{ "name":"DescribeClusterSubnetGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClusterSubnetGroupsMessage"}, "output":{ "shape":"ClusterSubnetGroupMessage", "resultWrapper":"DescribeClusterSubnetGroupsResult" }, "errors":[ {"shape":"ClusterSubnetGroupNotFoundFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.

" }, "DescribeClusterVersions":{ "name":"DescribeClusterVersions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClusterVersionsMessage"}, "output":{ "shape":"ClusterVersionsMessage", "resultWrapper":"DescribeClusterVersionsResult" }, "documentation":"

Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

" }, "DescribeClusters":{ "name":"DescribeClusters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClustersMessage"}, "output":{ "shape":"ClustersMessage", "resultWrapper":"DescribeClustersResult" }, "errors":[ {"shape":"ClusterNotFoundFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned.

If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.

" }, "DescribeDefaultClusterParameters":{ "name":"DescribeDefaultClusterParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDefaultClusterParametersMessage"}, "output":{ "shape":"DescribeDefaultClusterParametersResult", "resultWrapper":"DescribeDefaultClusterParametersResult" }, "documentation":"

Returns a list of parameter settings for the specified parameter group family.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

" }, "DescribeEventCategories":{ "name":"DescribeEventCategories", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventCategoriesMessage"}, "output":{ "shape":"EventCategoriesMessage", "resultWrapper":"DescribeEventCategoriesResult" }, "documentation":"

Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.

" }, "DescribeEventSubscriptions":{ "name":"DescribeEventSubscriptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventSubscriptionsMessage"}, "output":{ "shape":"EventSubscriptionsMessage", "resultWrapper":"DescribeEventSubscriptionsResult" }, "errors":[ {"shape":"SubscriptionNotFoundFault"} ], "documentation":"

Lists descriptions of all the Amazon Redshift event notifications subscription for a customer account. If you specify a subscription name, lists the description for that subscription.

" }, "DescribeEvents":{ "name":"DescribeEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventsMessage"}, "output":{ "shape":"EventsMessage", "resultWrapper":"DescribeEventsResult" }, "documentation":"

Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

" }, "DescribeHsmClientCertificates":{ "name":"DescribeHsmClientCertificates", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHsmClientCertificatesMessage"}, "output":{ "shape":"HsmClientCertificateMessage", "resultWrapper":"DescribeHsmClientCertificatesResult" }, "errors":[ {"shape":"HsmClientCertificateNotFoundFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned.

If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.

" }, "DescribeHsmConfigurations":{ "name":"DescribeHsmConfigurations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeHsmConfigurationsMessage"}, "output":{ "shape":"HsmConfigurationMessage", "resultWrapper":"DescribeHsmConfigurationsResult" }, "errors":[ {"shape":"HsmConfigurationNotFoundFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned.

If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.

" }, "DescribeLoggingStatus":{ "name":"DescribeLoggingStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLoggingStatusMessage"}, "output":{ "shape":"LoggingStatus", "resultWrapper":"DescribeLoggingStatusResult" }, "errors":[ {"shape":"ClusterNotFoundFault"} ], "documentation":"

Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.

" }, "DescribeOrderableClusterOptions":{ "name":"DescribeOrderableClusterOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeOrderableClusterOptionsMessage"}, "output":{ "shape":"OrderableClusterOptionsMessage", "resultWrapper":"DescribeOrderableClusterOptionsResult" }, "documentation":"

Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

" }, "DescribeReservedNodeOfferings":{ "name":"DescribeReservedNodeOfferings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedNodeOfferingsMessage"}, "output":{ "shape":"ReservedNodeOfferingsMessage", "resultWrapper":"DescribeReservedNodeOfferingsResult" }, "errors":[ {"shape":"ReservedNodeOfferingNotFoundFault"}, {"shape":"UnsupportedOperationFault"} ], "documentation":"

Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.

For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.

" }, "DescribeReservedNodes":{ "name":"DescribeReservedNodes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReservedNodesMessage"}, "output":{ "shape":"ReservedNodesMessage", "resultWrapper":"DescribeReservedNodesResult" }, "errors":[ {"shape":"ReservedNodeNotFoundFault"} ], "documentation":"

Returns the descriptions of the reserved nodes.

" }, "DescribeResize":{ "name":"DescribeResize", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeResizeMessage"}, "output":{ "shape":"ResizeProgressMessage", "resultWrapper":"DescribeResizeResult" }, "errors":[ {"shape":"ClusterNotFoundFault"}, {"shape":"ResizeNotFoundFault"} ], "documentation":"

Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize.

A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.

" }, "DescribeSnapshotCopyGrants":{ "name":"DescribeSnapshotCopyGrants", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotCopyGrantsMessage"}, "output":{ "shape":"SnapshotCopyGrantMessage", "resultWrapper":"DescribeSnapshotCopyGrantsResult" }, "errors":[ {"shape":"SnapshotCopyGrantNotFoundFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Returns a list of snapshot copy grants owned by the AWS account in the destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

" }, "DescribeTableRestoreStatus":{ "name":"DescribeTableRestoreStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTableRestoreStatusMessage"}, "output":{ "shape":"TableRestoreStatusMessage", "resultWrapper":"DescribeTableRestoreStatusResult" }, "errors":[ {"shape":"TableRestoreNotFoundFault"}, {"shape":"ClusterNotFoundFault"} ], "documentation":"

Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsMessage"}, "output":{ "shape":"TaggedResourceListMessage", "resultWrapper":"DescribeTagsResult" }, "errors":[ {"shape":"ResourceNotFoundFault"}, {"shape":"InvalidTagFault"} ], "documentation":"

Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.

The following are limitations for DescribeTags:

  • You cannot specify an ARN and a resource-type value together in the same request.

  • You cannot use the MaxRecords and Marker parameters together with the ARN parameter.

  • The MaxRecords parameter can be a range from 10 to 50 results to return in a request.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned.

If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.

" }, "DisableLogging":{ "name":"DisableLogging", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableLoggingMessage"}, "output":{ "shape":"LoggingStatus", "resultWrapper":"DisableLoggingResult" }, "errors":[ {"shape":"ClusterNotFoundFault"} ], "documentation":"

Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

" }, "DisableSnapshotCopy":{ "name":"DisableSnapshotCopy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableSnapshotCopyMessage"}, "output":{ "shape":"DisableSnapshotCopyResult", "resultWrapper":"DisableSnapshotCopyResult" }, "errors":[ {"shape":"ClusterNotFoundFault"}, {"shape":"SnapshotCopyAlreadyDisabledFault"}, {"shape":"InvalidClusterStateFault"}, {"shape":"UnauthorizedOperation"} ], "documentation":"

Disables the automatic copying of snapshots from one region to another region for a specified cluster.

If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.

" }, "EnableLogging":{ "name":"EnableLogging", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableLoggingMessage"}, "output":{ "shape":"LoggingStatus", "resultWrapper":"EnableLoggingResult" }, "errors":[ {"shape":"ClusterNotFoundFault"}, {"shape":"BucketNotFoundFault"}, {"shape":"InsufficientS3BucketPolicyFault"}, {"shape":"InvalidS3KeyPrefixFault"}, {"shape":"InvalidS3BucketNameFault"} ], "documentation":"

Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

" }, "EnableSnapshotCopy":{ "name":"EnableSnapshotCopy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableSnapshotCopyMessage"}, "output":{ "shape":"EnableSnapshotCopyResult", "resultWrapper":"EnableSnapshotCopyResult" }, "errors":[ {"shape":"IncompatibleOrderableOptions"}, {"shape":"InvalidClusterStateFault"}, {"shape":"ClusterNotFoundFault"}, {"shape":"CopyToRegionDisabledFault"}, {"shape":"SnapshotCopyAlreadyEnabledFault"}, {"shape":"UnknownSnapshotCopyRegionFault"}, {"shape":"UnauthorizedOperation"}, {"shape":"SnapshotCopyGrantNotFoundFault"}, {"shape":"LimitExceededFault"}, {"shape":"DependentServiceRequestThrottlingFault"} ], "documentation":"

Enables the automatic copy of snapshots from one region to another region for a specified cluster.

" }, "ModifyCluster":{ "name":"ModifyCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyClusterMessage"}, "output":{ "shape":"ModifyClusterResult", "resultWrapper":"ModifyClusterResult" }, "errors":[ {"shape":"InvalidClusterStateFault"}, {"shape":"InvalidClusterSecurityGroupStateFault"}, {"shape":"ClusterNotFoundFault"}, {"shape":"NumberOfNodesQuotaExceededFault"}, {"shape":"ClusterSecurityGroupNotFoundFault"}, {"shape":"ClusterParameterGroupNotFoundFault"}, {"shape":"InsufficientClusterCapacityFault"}, {"shape":"UnsupportedOptionFault"}, {"shape":"UnauthorizedOperation"}, {"shape":"HsmClientCertificateNotFoundFault"}, {"shape":"HsmConfigurationNotFoundFault"}, {"shape":"ClusterAlreadyExistsFault"}, {"shape":"LimitExceededFault"}, {"shape":"DependentServiceRequestThrottlingFault"}, {"shape":"InvalidElasticIpFault"} ], "documentation":"

Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.

" }, "ModifyClusterIamRoles":{ "name":"ModifyClusterIamRoles", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyClusterIamRolesMessage"}, "output":{ "shape":"ModifyClusterIamRolesResult", "resultWrapper":"ModifyClusterIamRolesResult" }, "errors":[ {"shape":"InvalidClusterStateFault"}, {"shape":"ClusterNotFoundFault"} ], "documentation":"

Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

A cluster can have up to 10 IAM roles associated at any time.

" }, "ModifyClusterParameterGroup":{ "name":"ModifyClusterParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyClusterParameterGroupMessage"}, "output":{ "shape":"ClusterParameterGroupNameMessage", "resultWrapper":"ModifyClusterParameterGroupResult" }, "errors":[ {"shape":"ClusterParameterGroupNotFoundFault"}, {"shape":"InvalidClusterParameterGroupStateFault"} ], "documentation":"

Modifies the parameters of a parameter group.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

" }, "ModifyClusterSubnetGroup":{ "name":"ModifyClusterSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyClusterSubnetGroupMessage"}, "output":{ "shape":"ModifyClusterSubnetGroupResult", "resultWrapper":"ModifyClusterSubnetGroupResult" }, "errors":[ {"shape":"ClusterSubnetGroupNotFoundFault"}, {"shape":"ClusterSubnetQuotaExceededFault"}, {"shape":"SubnetAlreadyInUse"}, {"shape":"InvalidSubnet"}, {"shape":"UnauthorizedOperation"}, {"shape":"DependentServiceRequestThrottlingFault"} ], "documentation":"

Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.

" }, "ModifyEventSubscription":{ "name":"ModifyEventSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyEventSubscriptionMessage"}, "output":{ "shape":"ModifyEventSubscriptionResult", "resultWrapper":"ModifyEventSubscriptionResult" }, "errors":[ {"shape":"SubscriptionNotFoundFault"}, {"shape":"SNSInvalidTopicFault"}, {"shape":"SNSNoAuthorizationFault"}, {"shape":"SNSTopicArnNotFoundFault"}, {"shape":"SubscriptionEventIdNotFoundFault"}, {"shape":"SubscriptionCategoryNotFoundFault"}, {"shape":"SubscriptionSeverityNotFoundFault"}, {"shape":"SourceNotFoundFault"}, {"shape":"InvalidSubscriptionStateFault"} ], "documentation":"

Modifies an existing Amazon Redshift event notification subscription.

" }, "ModifySnapshotCopyRetentionPeriod":{ "name":"ModifySnapshotCopyRetentionPeriod", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifySnapshotCopyRetentionPeriodMessage"}, "output":{ "shape":"ModifySnapshotCopyRetentionPeriodResult", "resultWrapper":"ModifySnapshotCopyRetentionPeriodResult" }, "errors":[ {"shape":"ClusterNotFoundFault"}, {"shape":"SnapshotCopyDisabledFault"}, {"shape":"UnauthorizedOperation"}, {"shape":"InvalidClusterStateFault"} ], "documentation":"

Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.

" }, "PurchaseReservedNodeOffering":{ "name":"PurchaseReservedNodeOffering", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurchaseReservedNodeOfferingMessage"}, "output":{ "shape":"PurchaseReservedNodeOfferingResult", "resultWrapper":"PurchaseReservedNodeOfferingResult" }, "errors":[ {"shape":"ReservedNodeOfferingNotFoundFault"}, {"shape":"ReservedNodeAlreadyExistsFault"}, {"shape":"ReservedNodeQuotaExceededFault"}, {"shape":"UnsupportedOperationFault"} ], "documentation":"

Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve.

For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.

" }, "RebootCluster":{ "name":"RebootCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootClusterMessage"}, "output":{ "shape":"RebootClusterResult", "resultWrapper":"RebootClusterResult" }, "errors":[ {"shape":"InvalidClusterStateFault"}, {"shape":"ClusterNotFoundFault"} ], "documentation":"

Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

" }, "ResetClusterParameterGroup":{ "name":"ResetClusterParameterGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetClusterParameterGroupMessage"}, "output":{ "shape":"ClusterParameterGroupNameMessage", "resultWrapper":"ResetClusterParameterGroupResult" }, "errors":[ {"shape":"InvalidClusterParameterGroupStateFault"}, {"shape":"ClusterParameterGroupNotFoundFault"} ], "documentation":"

Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to \"engine-default\". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.

" }, "RestoreFromClusterSnapshot":{ "name":"RestoreFromClusterSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreFromClusterSnapshotMessage"}, "output":{ "shape":"RestoreFromClusterSnapshotResult", "resultWrapper":"RestoreFromClusterSnapshotResult" }, "errors":[ {"shape":"AccessToSnapshotDeniedFault"}, {"shape":"ClusterAlreadyExistsFault"}, {"shape":"ClusterSnapshotNotFoundFault"}, {"shape":"ClusterQuotaExceededFault"}, {"shape":"InsufficientClusterCapacityFault"}, {"shape":"InvalidClusterSnapshotStateFault"}, {"shape":"InvalidRestoreFault"}, {"shape":"NumberOfNodesQuotaExceededFault"}, {"shape":"NumberOfNodesPerClusterLimitExceededFault"}, {"shape":"InvalidVPCNetworkStateFault"}, {"shape":"InvalidClusterSubnetGroupStateFault"}, {"shape":"InvalidSubnet"}, {"shape":"ClusterSubnetGroupNotFoundFault"}, {"shape":"UnauthorizedOperation"}, {"shape":"HsmClientCertificateNotFoundFault"}, {"shape":"HsmConfigurationNotFoundFault"}, {"shape":"InvalidElasticIpFault"}, {"shape":"ClusterParameterGroupNotFoundFault"}, {"shape":"ClusterSecurityGroupNotFoundFault"}, {"shape":"LimitExceededFault"}, {"shape":"DependentServiceRequestThrottlingFault"} ], "documentation":"

Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.

If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

" }, "RestoreTableFromClusterSnapshot":{ "name":"RestoreTableFromClusterSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreTableFromClusterSnapshotMessage"}, "output":{ "shape":"RestoreTableFromClusterSnapshotResult", "resultWrapper":"RestoreTableFromClusterSnapshotResult" }, "errors":[ {"shape":"ClusterSnapshotNotFoundFault"}, {"shape":"InProgressTableRestoreQuotaExceededFault"}, {"shape":"InvalidClusterSnapshotStateFault"}, {"shape":"InvalidTableRestoreArgumentFault"}, {"shape":"ClusterNotFoundFault"}, {"shape":"InvalidClusterStateFault"}, {"shape":"UnsupportedOperationFault"} ], "documentation":"

Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.

You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot.

" }, "RevokeClusterSecurityGroupIngress":{ "name":"RevokeClusterSecurityGroupIngress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeClusterSecurityGroupIngressMessage"}, "output":{ "shape":"RevokeClusterSecurityGroupIngressResult", "resultWrapper":"RevokeClusterSecurityGroupIngressResult" }, "errors":[ {"shape":"ClusterSecurityGroupNotFoundFault"}, {"shape":"AuthorizationNotFoundFault"}, {"shape":"InvalidClusterSecurityGroupStateFault"} ], "documentation":"

Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

" }, "RevokeSnapshotAccess":{ "name":"RevokeSnapshotAccess", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeSnapshotAccessMessage"}, "output":{ "shape":"RevokeSnapshotAccessResult", "resultWrapper":"RevokeSnapshotAccessResult" }, "errors":[ {"shape":"AccessToSnapshotDeniedFault"}, {"shape":"AuthorizationNotFoundFault"}, {"shape":"ClusterSnapshotNotFoundFault"} ], "documentation":"

Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

" }, "RotateEncryptionKey":{ "name":"RotateEncryptionKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RotateEncryptionKeyMessage"}, "output":{ "shape":"RotateEncryptionKeyResult", "resultWrapper":"RotateEncryptionKeyResult" }, "errors":[ {"shape":"ClusterNotFoundFault"}, {"shape":"InvalidClusterStateFault"}, {"shape":"DependentServiceRequestThrottlingFault"} ], "documentation":"

Rotates the encryption keys for a cluster.

" } }, "shapes":{ "AccessToSnapshotDeniedFault":{ "type":"structure", "members":{ }, "documentation":"

The owner of the specified snapshot has not authorized your account to access the snapshot.

", "error":{ "code":"AccessToSnapshotDenied", "httpStatusCode":400, "senderFault":true }, "exception":true }, "AccountWithRestoreAccess":{ "type":"structure", "members":{ "AccountId":{ "shape":"String", "documentation":"

The identifier of an AWS customer account authorized to restore a snapshot.

" } }, "documentation":"

Describes an AWS customer account authorized to restore a snapshot.

" }, "AccountsWithRestoreAccessList":{ "type":"list", "member":{ "shape":"AccountWithRestoreAccess", "locationName":"AccountWithRestoreAccess" } }, "AuthorizationAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.

", "error":{ "code":"AuthorizationAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "AuthorizationNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.

", "error":{ "code":"AuthorizationNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "AuthorizationQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The authorization quota for the cluster security group has been reached.

", "error":{ "code":"AuthorizationQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "AuthorizeClusterSecurityGroupIngressMessage":{ "type":"structure", "required":["ClusterSecurityGroupName"], "members":{ "ClusterSecurityGroupName":{ "shape":"String", "documentation":"

The name of the security group to which the ingress rule is added.

" }, "CIDRIP":{ "shape":"String", "documentation":"

The IP range to be added the Amazon Redshift security group.

" }, "EC2SecurityGroupName":{ "shape":"String", "documentation":"

The EC2 security group to be added the Amazon Redshift security group.

" }, "EC2SecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.

Example: 111122223333

" } }, "documentation":"

" }, "AuthorizeClusterSecurityGroupIngressResult":{ "type":"structure", "members":{ "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} } }, "AuthorizeSnapshotAccessMessage":{ "type":"structure", "required":[ "SnapshotIdentifier", "AccountWithRestoreAccess" ], "members":{ "SnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier of the snapshot the account is authorized to restore.

" }, "SnapshotClusterIdentifier":{ "shape":"String", "documentation":"

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.

" }, "AccountWithRestoreAccess":{ "shape":"String", "documentation":"

The identifier of the AWS customer account authorized to restore the specified snapshot.

" } }, "documentation":"

" }, "AuthorizeSnapshotAccessResult":{ "type":"structure", "members":{ "Snapshot":{"shape":"Snapshot"} } }, "AvailabilityZone":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the availability zone.

" } }, "documentation":"

Describes an availability zone.

", "wrapper":true }, "AvailabilityZoneList":{ "type":"list", "member":{ "shape":"AvailabilityZone", "locationName":"AvailabilityZone" } }, "Boolean":{"type":"boolean"}, "BooleanOptional":{"type":"boolean"}, "BucketNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

Could not find the specified S3 bucket.

", "error":{ "code":"BucketNotFoundFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Cluster":{ "type":"structure", "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The unique identifier of the cluster.

" }, "NodeType":{ "shape":"String", "documentation":"

The node type for the nodes in the cluster.

" }, "ClusterStatus":{ "shape":"String", "documentation":"

The current state of the cluster. Possible values are the following:

  • available

  • creating

  • deleting

  • final-snapshot

  • hardware-failure

  • incompatible-hsm

  • incompatible-network

  • incompatible-parameters

  • incompatible-restore

  • modifying

  • rebooting

  • renaming

  • resizing

  • rotating-keys

  • storage-full

  • updating-hsm

" }, "ModifyStatus":{ "shape":"String", "documentation":"

The status of a modify operation, if any, initiated for the cluster.

" }, "MasterUsername":{ "shape":"String", "documentation":"

The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

" }, "DBName":{ "shape":"String", "documentation":"

The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

" }, "Endpoint":{ "shape":"Endpoint", "documentation":"

The connection endpoint.

" }, "ClusterCreateTime":{ "shape":"TStamp", "documentation":"

The date and time that the cluster was created.

" }, "AutomatedSnapshotRetentionPeriod":{ "shape":"Integer", "documentation":"

The number of days that automatic cluster snapshots are retained.

" }, "ClusterSecurityGroups":{ "shape":"ClusterSecurityGroupMembershipList", "documentation":"

A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.

Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

" }, "VpcSecurityGroups":{ "shape":"VpcSecurityGroupMembershipList", "documentation":"

A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

" }, "ClusterParameterGroups":{ "shape":"ClusterParameterGroupStatusList", "documentation":"

The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

" }, "ClusterSubnetGroupName":{ "shape":"String", "documentation":"

The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

" }, "VpcId":{ "shape":"String", "documentation":"

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The name of the Availability Zone in which the cluster is located.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.

" }, "PendingModifiedValues":{ "shape":"PendingModifiedValues", "documentation":"

A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

" }, "ClusterVersion":{ "shape":"String", "documentation":"

The version ID of the Amazon Redshift engine that is running on the cluster.

" }, "AllowVersionUpgrade":{ "shape":"Boolean", "documentation":"

A Boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

" }, "NumberOfNodes":{ "shape":"Integer", "documentation":"

The number of compute nodes in the cluster.

" }, "PubliclyAccessible":{ "shape":"Boolean", "documentation":"

A Boolean value that, if true, indicates that the cluster can be accessed from a public network.

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

A Boolean value that, if true, indicates that data in the cluster is encrypted at rest.

" }, "RestoreStatus":{ "shape":"RestoreStatus", "documentation":"

A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

" }, "HsmStatus":{ "shape":"HsmStatus", "documentation":"

A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.

Values: active, applying

" }, "ClusterSnapshotCopyStatus":{ "shape":"ClusterSnapshotCopyStatus", "documentation":"

A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

" }, "ClusterPublicKey":{ "shape":"String", "documentation":"

The public key for the cluster.

" }, "ClusterNodes":{ "shape":"ClusterNodesList", "documentation":"

The nodes in the cluster.

" }, "ElasticIpStatus":{ "shape":"ElasticIpStatus", "documentation":"

The status of the elastic IP (EIP) address.

" }, "ClusterRevisionNumber":{ "shape":"String", "documentation":"

The specific revision number of the database in the cluster.

" }, "Tags":{ "shape":"TagList", "documentation":"

The list of tags for the cluster.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.

" }, "EnhancedVpcRouting":{ "shape":"Boolean", "documentation":"

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

" }, "IamRoles":{ "shape":"ClusterIamRoleList", "documentation":"

A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

" } }, "documentation":"

Describes a cluster.

", "wrapper":true }, "ClusterAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

The account already has a cluster with the given identifier.

", "error":{ "code":"ClusterAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ClusterIamRole":{ "type":"structure", "members":{ "IamRoleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

" }, "ApplyStatus":{ "shape":"String", "documentation":"

A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

The following are possible statuses and descriptions.

  • in-sync: The role is available for use by the cluster.

  • adding: The role is in the process of being associated with the cluster.

  • removing: The role is in the process of being disassociated with the cluster.

" } }, "documentation":"

An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS services.

" }, "ClusterIamRoleList":{ "type":"list", "member":{ "shape":"ClusterIamRole", "locationName":"ClusterIamRole" } }, "ClusterList":{ "type":"list", "member":{ "shape":"Cluster", "locationName":"Cluster" } }, "ClusterNode":{ "type":"structure", "members":{ "NodeRole":{ "shape":"String", "documentation":"

Whether the node is a leader node or a compute node.

" }, "PrivateIPAddress":{ "shape":"String", "documentation":"

The private IP address of a node within a cluster.

" }, "PublicIPAddress":{ "shape":"String", "documentation":"

The public IP address of a node within a cluster.

" } }, "documentation":"

The identifier of a node in a cluster.

" }, "ClusterNodesList":{ "type":"list", "member":{"shape":"ClusterNode"} }, "ClusterNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The ClusterIdentifier parameter does not refer to an existing cluster.

", "error":{ "code":"ClusterNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ClusterParameterGroup":{ "type":"structure", "members":{ "ParameterGroupName":{ "shape":"String", "documentation":"

The name of the cluster parameter group.

" }, "ParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the cluster parameter group family that this cluster parameter group is compatible with.

" }, "Description":{ "shape":"String", "documentation":"

The description of the parameter group.

" }, "Tags":{ "shape":"TagList", "documentation":"

The list of tags for the cluster parameter group.

" } }, "documentation":"

Describes a parameter group.

", "wrapper":true }, "ClusterParameterGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

A cluster parameter group with the same name already exists.

", "error":{ "code":"ClusterParameterGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ClusterParameterGroupDetails":{ "type":"structure", "members":{ "Parameters":{ "shape":"ParametersList", "documentation":"

A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.

" }, "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" } }, "documentation":"

Contains the output from the DescribeClusterParameters action.

" }, "ClusterParameterGroupNameMessage":{ "type":"structure", "members":{ "ParameterGroupName":{ "shape":"String", "documentation":"

The name of the cluster parameter group.

" }, "ParameterGroupStatus":{ "shape":"String", "documentation":"

The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.

" } }, "documentation":"

" }, "ClusterParameterGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The parameter group name does not refer to an existing parameter group.

", "error":{ "code":"ClusterParameterGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ClusterParameterGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request would result in the user exceeding the allowed number of cluster parameter groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

", "error":{ "code":"ClusterParameterGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ClusterParameterGroupStatus":{ "type":"structure", "members":{ "ParameterGroupName":{ "shape":"String", "documentation":"

The name of the cluster parameter group.

" }, "ParameterApplyStatus":{ "shape":"String", "documentation":"

The status of parameter updates.

" }, "ClusterParameterStatusList":{ "shape":"ClusterParameterStatusList", "documentation":"

The list of parameter statuses.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

" } }, "documentation":"

Describes the status of a parameter group.

" }, "ClusterParameterGroupStatusList":{ "type":"list", "member":{ "shape":"ClusterParameterGroupStatus", "locationName":"ClusterParameterGroup" } }, "ClusterParameterGroupsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" }, "ParameterGroups":{ "shape":"ParameterGroupList", "documentation":"

A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.

" } }, "documentation":"

Contains the output from the DescribeClusterParameterGroups action.

" }, "ClusterParameterStatus":{ "type":"structure", "members":{ "ParameterName":{ "shape":"String", "documentation":"

The name of the parameter.

" }, "ParameterApplyStatus":{ "shape":"String", "documentation":"

The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.

The following are possible statuses and descriptions.

  • in-sync: The parameter value is in sync with the database.

  • pending-reboot: The parameter value will be applied after the cluster reboots.

  • applying: The parameter value is being applied to the database.

  • invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.

  • apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.

  • apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.

  • unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.

" }, "ParameterApplyErrorDescription":{ "shape":"String", "documentation":"

The error that prevented the parameter from being applied to the database.

" } }, "documentation":"

Describes the status of a parameter group.

" }, "ClusterParameterStatusList":{ "type":"list", "member":{"shape":"ClusterParameterStatus"} }, "ClusterQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

", "error":{ "code":"ClusterQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ClusterSecurityGroup":{ "type":"structure", "members":{ "ClusterSecurityGroupName":{ "shape":"String", "documentation":"

The name of the cluster security group to which the operation was applied.

" }, "Description":{ "shape":"String", "documentation":"

A description of the security group.

" }, "EC2SecurityGroups":{ "shape":"EC2SecurityGroupList", "documentation":"

A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.

" }, "IPRanges":{ "shape":"IPRangeList", "documentation":"

A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.

" }, "Tags":{ "shape":"TagList", "documentation":"

The list of tags for the cluster security group.

" } }, "documentation":"

Describes a security group.

", "wrapper":true }, "ClusterSecurityGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

A cluster security group with the same name already exists.

", "error":{ "code":"ClusterSecurityGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ClusterSecurityGroupMembership":{ "type":"structure", "members":{ "ClusterSecurityGroupName":{ "shape":"String", "documentation":"

The name of the cluster security group.

" }, "Status":{ "shape":"String", "documentation":"

The status of the cluster security group.

" } }, "documentation":"

Describes a cluster security group.

" }, "ClusterSecurityGroupMembershipList":{ "type":"list", "member":{ "shape":"ClusterSecurityGroupMembership", "locationName":"ClusterSecurityGroup" } }, "ClusterSecurityGroupMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" }, "ClusterSecurityGroups":{ "shape":"ClusterSecurityGroups", "documentation":"

A list of ClusterSecurityGroup instances.

" } }, "documentation":"

" }, "ClusterSecurityGroupNameList":{ "type":"list", "member":{ "shape":"String", "locationName":"ClusterSecurityGroupName" } }, "ClusterSecurityGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The cluster security group name does not refer to an existing cluster security group.

", "error":{ "code":"ClusterSecurityGroupNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ClusterSecurityGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request would result in the user exceeding the allowed number of cluster security groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

", "error":{ "code":"QuotaExceeded.ClusterSecurityGroup", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ClusterSecurityGroups":{ "type":"list", "member":{ "shape":"ClusterSecurityGroup", "locationName":"ClusterSecurityGroup" } }, "ClusterSnapshotAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

The value specified as a snapshot identifier is already used by an existing snapshot.

", "error":{ "code":"ClusterSnapshotAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ClusterSnapshotCopyStatus":{ "type":"structure", "members":{ "DestinationRegion":{ "shape":"String", "documentation":"

The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

" }, "RetentionPeriod":{ "shape":"Long", "documentation":"

The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

" }, "SnapshotCopyGrantName":{ "shape":"String", "documentation":"

The name of the snapshot copy grant.

" } }, "documentation":"

Returns the destination region and retention period that are configured for cross-region snapshot copy.

" }, "ClusterSnapshotNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The snapshot identifier does not refer to an existing cluster snapshot.

", "error":{ "code":"ClusterSnapshotNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ClusterSnapshotQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request would result in the user exceeding the allowed number of cluster snapshots.

", "error":{ "code":"ClusterSnapshotQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ClusterSubnetGroup":{ "type":"structure", "members":{ "ClusterSubnetGroupName":{ "shape":"String", "documentation":"

The name of the cluster subnet group.

" }, "Description":{ "shape":"String", "documentation":"

The description of the cluster subnet group.

" }, "VpcId":{ "shape":"String", "documentation":"

The VPC ID of the cluster subnet group.

" }, "SubnetGroupStatus":{ "shape":"String", "documentation":"

The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid.

" }, "Subnets":{ "shape":"SubnetList", "documentation":"

A list of the VPC Subnet elements.

" }, "Tags":{ "shape":"TagList", "documentation":"

The list of tags for the cluster subnet group.

" } }, "documentation":"

Describes a subnet group.

", "wrapper":true }, "ClusterSubnetGroupAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

A ClusterSubnetGroupName is already used by an existing cluster subnet group.

", "error":{ "code":"ClusterSubnetGroupAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ClusterSubnetGroupMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" }, "ClusterSubnetGroups":{ "shape":"ClusterSubnetGroups", "documentation":"

A list of ClusterSubnetGroup instances.

" } }, "documentation":"

Contains the output from the DescribeClusterSubnetGroups action.

" }, "ClusterSubnetGroupNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The cluster subnet group name does not refer to an existing cluster subnet group.

", "error":{ "code":"ClusterSubnetGroupNotFoundFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ClusterSubnetGroupQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request would result in user exceeding the allowed number of cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

", "error":{ "code":"ClusterSubnetGroupQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ClusterSubnetGroups":{ "type":"list", "member":{ "shape":"ClusterSubnetGroup", "locationName":"ClusterSubnetGroup" } }, "ClusterSubnetQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

", "error":{ "code":"ClusterSubnetQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ClusterVersion":{ "type":"structure", "members":{ "ClusterVersion":{ "shape":"String", "documentation":"

The version number used by the cluster.

" }, "ClusterParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the cluster parameter group family for the cluster.

" }, "Description":{ "shape":"String", "documentation":"

The description of the cluster version.

" } }, "documentation":"

Describes a cluster version, including the parameter group family and description of the version.

" }, "ClusterVersionList":{ "type":"list", "member":{ "shape":"ClusterVersion", "locationName":"ClusterVersion" } }, "ClusterVersionsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" }, "ClusterVersions":{ "shape":"ClusterVersionList", "documentation":"

A list of Version elements.

" } }, "documentation":"

Contains the output from the DescribeClusterVersions action.

" }, "ClustersMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" }, "Clusters":{ "shape":"ClusterList", "documentation":"

A list of Cluster objects, where each object describes one cluster.

" } }, "documentation":"

Contains the output from the DescribeClusters action.

" }, "CopyClusterSnapshotMessage":{ "type":"structure", "required":[ "SourceSnapshotIdentifier", "TargetSnapshotIdentifier" ], "members":{ "SourceSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier for the source snapshot.

Constraints:

  • Must be the identifier for a valid automated snapshot whose state is available.

" }, "SourceSnapshotClusterIdentifier":{ "shape":"String", "documentation":"

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.

Constraints:

  • Must be the identifier for a valid cluster.

" }, "TargetSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier given to the new manual snapshot.

Constraints:

  • Cannot be null, empty, or blank.

  • Must contain from 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • Must be unique for the AWS account that is making the request.

" } }, "documentation":"

" }, "CopyClusterSnapshotResult":{ "type":"structure", "members":{ "Snapshot":{"shape":"Snapshot"} } }, "CopyToRegionDisabledFault":{ "type":"structure", "members":{ }, "documentation":"

Cross-region snapshot copy was temporarily disabled. Try your request again.

", "error":{ "code":"CopyToRegionDisabledFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "CreateClusterMessage":{ "type":"structure", "required":[ "ClusterIdentifier", "NodeType", "MasterUsername", "MasterUserPassword" ], "members":{ "DBName":{ "shape":"String", "documentation":"

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

Default: dev

Constraints:

  • Must contain 1 to 64 alphanumeric characters.

  • Must contain only lowercase letters.

  • Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

" }, "ClusterIdentifier":{ "shape":"String", "documentation":"

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • Alphabetic characters must be lowercase.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • Must be unique for all clusters within an AWS account.

Example: myexamplecluster

" }, "ClusterType":{ "shape":"String", "documentation":"

The type of the cluster. When cluster type is specified as

  • single-node, the NumberOfNodes parameter is not required.

  • multi-node, the NumberOfNodes parameter is required.

Valid Values: multi-node | single-node

Default: multi-node

" }, "NodeType":{ "shape":"String", "documentation":"

The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

Valid Values: ds1.xlarge | ds1.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge.

" }, "MasterUsername":{ "shape":"String", "documentation":"

The user name associated with the master user account for the cluster that is being created.

Constraints:

  • Must be 1 - 128 alphanumeric characters.

  • First character must be a letter.

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

" }, "MasterUserPassword":{ "shape":"String", "documentation":"

The password associated with the master user account for the cluster that is being created.

Constraints:

  • Must be between 8 and 64 characters in length.

  • Must contain at least one uppercase letter.

  • Must contain at least one lowercase letter.

  • Must contain one number.

  • Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), \" (double quote), \\, /, @, or space.

" }, "ClusterSecurityGroups":{ "shape":"ClusterSecurityGroupNameList", "documentation":"

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

" }, "ClusterSubnetGroupName":{ "shape":"String", "documentation":"

The name of a cluster subnet group to be associated with this cluster.

If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-1d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

" }, "ClusterParameterGroupName":{ "shape":"String", "documentation":"

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" }, "AutomatedSnapshotRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

Default: 1

Constraints: Must be a value from 0 to 35.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which the cluster accepts incoming connections.

The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

Default: 5439

Valid Values: 1150-65535

" }, "ClusterVersion":{ "shape":"String", "documentation":"

The version of the Amazon Redshift engine software that you want to deploy on the cluster.

The version selected runs on all the nodes in the cluster.

Constraints: Only version 1.0 is currently available.

Example: 1.0

" }, "AllowVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default: true

" }, "NumberOfNodes":{ "shape":"IntegerOptional", "documentation":"

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default: 1

Constraints: Value must be at least 1 and no more than 100.

" }, "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"

If true, the cluster can be accessed from a public network.

" }, "Encrypted":{ "shape":"BooleanOptional", "documentation":"

If true, the data in the cluster is encrypted at rest.

Default: false

" }, "HsmClientCertificateIdentifier":{ "shape":"String", "documentation":"

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

" }, "HsmConfigurationIdentifier":{ "shape":"String", "documentation":"

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

" }, "ElasticIp":{ "shape":"String", "documentation":"

The Elastic IP (EIP) address for the cluster.

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 Cluster Management Guide.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of tag instances.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

" }, "EnhancedVpcRouting":{ "shape":"BooleanOptional", "documentation":"

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

" }, "IamRoles":{ "shape":"IamRoleArnList", "documentation":"

A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.

A cluster can have up to 10 IAM roles associated with it at any time.

" } }, "documentation":"

" }, "CreateClusterParameterGroupMessage":{ "type":"structure", "required":[ "ParameterGroupName", "ParameterGroupFamily", "Description" ], "members":{ "ParameterGroupName":{ "shape":"String", "documentation":"

The name of the cluster parameter group.

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • Must be unique withing your AWS account.

This value is stored as a lower-case string.

" }, "ParameterGroupFamily":{ "shape":"String", "documentation":"

The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.

To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is \"redshift-1.0\".

" }, "Description":{ "shape":"String", "documentation":"

A description of the parameter group.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of tag instances.

" } }, "documentation":"

" }, "CreateClusterParameterGroupResult":{ "type":"structure", "members":{ "ClusterParameterGroup":{"shape":"ClusterParameterGroup"} } }, "CreateClusterResult":{ "type":"structure", "members":{ "Cluster":{"shape":"Cluster"} } }, "CreateClusterSecurityGroupMessage":{ "type":"structure", "required":[ "ClusterSecurityGroupName", "Description" ], "members":{ "ClusterSecurityGroupName":{ "shape":"String", "documentation":"

The name for the security group. Amazon Redshift stores the value as a lowercase string.

Constraints:

  • Must contain no more than 255 alphanumeric characters or hyphens.

  • Must not be \"Default\".

  • Must be unique for all security groups that are created by your AWS account.

Example: examplesecuritygroup

" }, "Description":{ "shape":"String", "documentation":"

A description for the security group.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of tag instances.

" } }, "documentation":"

" }, "CreateClusterSecurityGroupResult":{ "type":"structure", "members":{ "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} } }, "CreateClusterSnapshotMessage":{ "type":"structure", "required":[ "SnapshotIdentifier", "ClusterIdentifier" ], "members":{ "SnapshotIdentifier":{ "shape":"String", "documentation":"

A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.

Constraints:

  • Cannot be null, empty, or blank

  • Must contain from 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

" }, "ClusterIdentifier":{ "shape":"String", "documentation":"

The cluster identifier for which you want a snapshot.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of tag instances.

" } }, "documentation":"

" }, "CreateClusterSnapshotResult":{ "type":"structure", "members":{ "Snapshot":{"shape":"Snapshot"} } }, "CreateClusterSubnetGroupMessage":{ "type":"structure", "required":[ "ClusterSubnetGroupName", "Description", "SubnetIds" ], "members":{ "ClusterSubnetGroupName":{ "shape":"String", "documentation":"

The name for the subnet group. Amazon Redshift stores the value as a lowercase string.

Constraints:

  • Must contain no more than 255 alphanumeric characters or hyphens.

  • Must not be \"Default\".

  • Must be unique for all subnet groups that are created by your AWS account.

Example: examplesubnetgroup

" }, "Description":{ "shape":"String", "documentation":"

A description for the subnet group.

" }, "SubnetIds":{ "shape":"SubnetIdentifierList", "documentation":"

An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of tag instances.

" } }, "documentation":"

" }, "CreateClusterSubnetGroupResult":{ "type":"structure", "members":{ "ClusterSubnetGroup":{"shape":"ClusterSubnetGroup"} } }, "CreateEventSubscriptionMessage":{ "type":"structure", "required":[ "SubscriptionName", "SnsTopicArn" ], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the event subscription to be created.

Constraints:

  • Cannot be null, empty, or blank.

  • Must contain from 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" }, "SnsTopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" }, "SourceType":{ "shape":"String", "documentation":"

The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.

Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

" }, "SourceIds":{ "shape":"SourceIdsList", "documentation":"

A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

Example: my-cluster-1, my-cluster-2

Example: my-snapshot-20131010

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

Specifies the Amazon Redshift event categories to be published by the event notification subscription.

Values: Configuration, Management, Monitoring, Security

" }, "Severity":{ "shape":"String", "documentation":"

Specifies the Amazon Redshift event severity to be published by the event notification subscription.

Values: ERROR, INFO

" }, "Enabled":{ "shape":"BooleanOptional", "documentation":"

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of tag instances.

" } }, "documentation":"

" }, "CreateEventSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "CreateHsmClientCertificateMessage":{ "type":"structure", "required":["HsmClientCertificateIdentifier"], "members":{ "HsmClientCertificateIdentifier":{ "shape":"String", "documentation":"

The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of tag instances.

" } }, "documentation":"

" }, "CreateHsmClientCertificateResult":{ "type":"structure", "members":{ "HsmClientCertificate":{"shape":"HsmClientCertificate"} } }, "CreateHsmConfigurationMessage":{ "type":"structure", "required":[ "HsmConfigurationIdentifier", "Description", "HsmIpAddress", "HsmPartitionName", "HsmPartitionPassword", "HsmServerPublicCertificate" ], "members":{ "HsmConfigurationIdentifier":{ "shape":"String", "documentation":"

The identifier to be assigned to the new Amazon Redshift HSM configuration.

" }, "Description":{ "shape":"String", "documentation":"

A text description of the HSM configuration to be created.

" }, "HsmIpAddress":{ "shape":"String", "documentation":"

The IP address that the Amazon Redshift cluster must use to access the HSM.

" }, "HsmPartitionName":{ "shape":"String", "documentation":"

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

" }, "HsmPartitionPassword":{ "shape":"String", "documentation":"

The password required to access the HSM partition.

" }, "HsmServerPublicCertificate":{ "shape":"String", "documentation":"

The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of tag instances.

" } }, "documentation":"

" }, "CreateHsmConfigurationResult":{ "type":"structure", "members":{ "HsmConfiguration":{"shape":"HsmConfiguration"} } }, "CreateSnapshotCopyGrantMessage":{ "type":"structure", "required":["SnapshotCopyGrantName"], "members":{ "SnapshotCopyGrantName":{ "shape":"String", "documentation":"

The name of the snapshot copy grant. This name must be unique in the region for the AWS account.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • Alphabetic characters must be lowercase.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • Must be unique for all clusters within an AWS account.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of tag instances.

" } }, "documentation":"

The result of the CreateSnapshotCopyGrant action.

" }, "CreateSnapshotCopyGrantResult":{ "type":"structure", "members":{ "SnapshotCopyGrant":{"shape":"SnapshotCopyGrant"} } }, "CreateTagsMessage":{ "type":"structure", "required":[ "ResourceName", "Tags" ], "members":{ "ResourceName":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.

" }, "Tags":{ "shape":"TagList", "documentation":"

One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags \"Key\"=\"owner\",\"Value\"=\"admin\" \"Key\"=\"environment\",\"Value\"=\"test\" \"Key\"=\"version\",\"Value\"=\"1.0\".

" } }, "documentation":"

Contains the output from the CreateTags action.

" }, "DefaultClusterParameters":{ "type":"structure", "members":{ "ParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the cluster parameter group family to which the engine default parameters apply.

" }, "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

The list of cluster default parameters.

" } }, "documentation":"

Describes the default cluster parameters for a parameter group family.

", "wrapper":true }, "DeleteClusterMessage":{ "type":"structure", "required":["ClusterIdentifier"], "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The identifier of the cluster to be deleted.

Constraints:

  • Must contain lowercase characters.

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" }, "SkipFinalClusterSnapshot":{ "shape":"Boolean", "documentation":"

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.

The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

Default: false

" }, "FinalClusterSnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

Constraints:

  • Must be 1 to 255 alphanumeric characters.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" } }, "documentation":"

" }, "DeleteClusterParameterGroupMessage":{ "type":"structure", "required":["ParameterGroupName"], "members":{ "ParameterGroupName":{ "shape":"String", "documentation":"

The name of the parameter group to be deleted.

Constraints:

  • Must be the name of an existing cluster parameter group.

  • Cannot delete a default cluster parameter group.

" } }, "documentation":"

" }, "DeleteClusterResult":{ "type":"structure", "members":{ "Cluster":{"shape":"Cluster"} } }, "DeleteClusterSecurityGroupMessage":{ "type":"structure", "required":["ClusterSecurityGroupName"], "members":{ "ClusterSecurityGroupName":{ "shape":"String", "documentation":"

The name of the cluster security group to be deleted.

" } }, "documentation":"

" }, "DeleteClusterSnapshotMessage":{ "type":"structure", "required":["SnapshotIdentifier"], "members":{ "SnapshotIdentifier":{ "shape":"String", "documentation":"

The unique identifier of the manual snapshot to be deleted.

Constraints: Must be the name of an existing snapshot that is in the available state.

" }, "SnapshotClusterIdentifier":{ "shape":"String", "documentation":"

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.

Constraints: Must be the name of valid cluster.

" } }, "documentation":"

" }, "DeleteClusterSnapshotResult":{ "type":"structure", "members":{ "Snapshot":{"shape":"Snapshot"} } }, "DeleteClusterSubnetGroupMessage":{ "type":"structure", "required":["ClusterSubnetGroupName"], "members":{ "ClusterSubnetGroupName":{ "shape":"String", "documentation":"

The name of the cluster subnet group name to be deleted.

" } }, "documentation":"

" }, "DeleteEventSubscriptionMessage":{ "type":"structure", "required":["SubscriptionName"], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the Amazon Redshift event notification subscription to be deleted.

" } }, "documentation":"

" }, "DeleteHsmClientCertificateMessage":{ "type":"structure", "required":["HsmClientCertificateIdentifier"], "members":{ "HsmClientCertificateIdentifier":{ "shape":"String", "documentation":"

The identifier of the HSM client certificate to be deleted.

" } }, "documentation":"

" }, "DeleteHsmConfigurationMessage":{ "type":"structure", "required":["HsmConfigurationIdentifier"], "members":{ "HsmConfigurationIdentifier":{ "shape":"String", "documentation":"

The identifier of the Amazon Redshift HSM configuration to be deleted.

" } }, "documentation":"

" }, "DeleteSnapshotCopyGrantMessage":{ "type":"structure", "required":["SnapshotCopyGrantName"], "members":{ "SnapshotCopyGrantName":{ "shape":"String", "documentation":"

The name of the snapshot copy grant to delete.

" } }, "documentation":"

The result of the DeleteSnapshotCopyGrant action.

" }, "DeleteTagsMessage":{ "type":"structure", "required":[ "ResourceName", "TagKeys" ], "members":{ "ResourceName":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

The tag key that you want to delete.

" } }, "documentation":"

Contains the output from the DeleteTags action.

" }, "DependentServiceRequestThrottlingFault":{ "type":"structure", "members":{ }, "documentation":"

The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.

", "error":{ "code":"DependentServiceRequestThrottlingFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DescribeClusterParameterGroupsMessage":{ "type":"structure", "members":{ "ParameterGroupName":{ "shape":"String", "documentation":"

The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.

" }, "TagValues":{ "shape":"TagValueList", "documentation":"

A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

" } }, "documentation":"

" }, "DescribeClusterParametersMessage":{ "type":"structure", "required":["ParameterGroupName"], "members":{ "ParameterGroupName":{ "shape":"String", "documentation":"

The name of a cluster parameter group for which to return details.

" }, "Source":{ "shape":"String", "documentation":"

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

" } }, "documentation":"

" }, "DescribeClusterSecurityGroupsMessage":{ "type":"structure", "members":{ "ClusterSecurityGroupName":{ "shape":"String", "documentation":"

The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.

Example: securitygroup1

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.

" }, "TagValues":{ "shape":"TagValueList", "documentation":"

A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.

" } }, "documentation":"

" }, "DescribeClusterSnapshotsMessage":{ "type":"structure", "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The identifier of the cluster for which information about snapshots is requested.

" }, "SnapshotIdentifier":{ "shape":"String", "documentation":"

The snapshot identifier of the snapshot about which to return information.

" }, "SnapshotType":{ "shape":"String", "documentation":"

The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

Valid Values: automated | manual

" }, "StartTime":{ "shape":"TStamp", "documentation":"

A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

" }, "EndTime":{ "shape":"TStamp", "documentation":"

A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

" }, "OwnerAccount":{ "shape":"String", "documentation":"

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.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

" }, "TagValues":{ "shape":"TagValueList", "documentation":"

A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

" } }, "documentation":"

" }, "DescribeClusterSubnetGroupsMessage":{ "type":"structure", "members":{ "ClusterSubnetGroupName":{ "shape":"String", "documentation":"

The name of the cluster subnet group for which information is requested.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.

" }, "TagValues":{ "shape":"TagValueList", "documentation":"

A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.

" } }, "documentation":"

" }, "DescribeClusterVersionsMessage":{ "type":"structure", "members":{ "ClusterVersion":{ "shape":"String", "documentation":"

The specific cluster version to return.

Example: 1.0

" }, "ClusterParameterGroupFamily":{ "shape":"String", "documentation":"

The name of a specific cluster parameter group family to return details for.

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

" } }, "documentation":"

" }, "DescribeClustersMessage":{ "type":"structure", "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

" }, "TagValues":{ "shape":"TagValueList", "documentation":"

A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

" } }, "documentation":"

" }, "DescribeDefaultClusterParametersMessage":{ "type":"structure", "required":["ParameterGroupFamily"], "members":{ "ParameterGroupFamily":{ "shape":"String", "documentation":"

The name of the cluster parameter group family.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

" } }, "documentation":"

" }, "DescribeDefaultClusterParametersResult":{ "type":"structure", "members":{ "DefaultClusterParameters":{"shape":"DefaultClusterParameters"} } }, "DescribeEventCategoriesMessage":{ "type":"structure", "members":{ "SourceType":{ "shape":"String", "documentation":"

The source type, such as cluster or parameter group, to which the described event categories apply.

Valid values: cluster, cluster-snapshot, cluster-parameter-group, and cluster-security-group.

" } }, "documentation":"

" }, "DescribeEventSubscriptionsMessage":{ "type":"structure", "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the Amazon Redshift event notification subscription to be described.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

" } }, "documentation":"

" }, "DescribeEventsMessage":{ "type":"structure", "members":{ "SourceIdentifier":{ "shape":"String", "documentation":"

The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType must also be provided.

  • Specify a cluster identifier when SourceType is cluster.

  • Specify a cluster security group name when SourceType is cluster-security-group.

  • Specify a cluster parameter group name when SourceType is cluster-parameter-group.

  • Specify a cluster snapshot identifier when SourceType is cluster-snapshot.

" }, "SourceType":{ "shape":"SourceType", "documentation":"

The event source to retrieve events for. If no value is specified, all events are returned.

Constraints:

If SourceType is supplied, SourceIdentifier must also be provided.

  • Specify cluster when SourceIdentifier is a cluster identifier.

  • Specify cluster-security-group when SourceIdentifier is a cluster security group name.

  • Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.

  • Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

" }, "StartTime":{ "shape":"TStamp", "documentation":"

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

" }, "EndTime":{ "shape":"TStamp", "documentation":"

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

" }, "Duration":{ "shape":"IntegerOptional", "documentation":"

The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

Default: 60

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

" } }, "documentation":"

" }, "DescribeHsmClientCertificatesMessage":{ "type":"structure", "members":{ "HsmClientCertificateIdentifier":{ "shape":"String", "documentation":"

The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them.

" }, "TagValues":{ "shape":"TagValueList", "documentation":"

A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.

" } }, "documentation":"

" }, "DescribeHsmConfigurationsMessage":{ "type":"structure", "members":{ "HsmConfigurationIdentifier":{ "shape":"String", "documentation":"

The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them.

" }, "TagValues":{ "shape":"TagValueList", "documentation":"

A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them.

" } }, "documentation":"

" }, "DescribeLoggingStatusMessage":{ "type":"structure", "required":["ClusterIdentifier"], "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The identifier of the cluster from which to get the logging status.

Example: examplecluster

" } }, "documentation":"

" }, "DescribeOrderableClusterOptionsMessage":{ "type":"structure", "members":{ "ClusterVersion":{ "shape":"String", "documentation":"

The version filter value. Specify this parameter to show only the available offerings matching the specified version.

Default: All versions.

Constraints: Must be one of the version returned from DescribeClusterVersions.

" }, "NodeType":{ "shape":"String", "documentation":"

The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

" } }, "documentation":"

" }, "DescribeReservedNodeOfferingsMessage":{ "type":"structure", "members":{ "ReservedNodeOfferingId":{ "shape":"String", "documentation":"

The unique identifier for the offering.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

" } }, "documentation":"

" }, "DescribeReservedNodesMessage":{ "type":"structure", "members":{ "ReservedNodeId":{ "shape":"String", "documentation":"

Identifier for the node reservation.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

" } }, "documentation":"

" }, "DescribeResizeMessage":{ "type":"structure", "required":["ClusterIdentifier"], "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.

By default, resize operations for all clusters defined for an AWS account are returned.

" } }, "documentation":"

" }, "DescribeSnapshotCopyGrantsMessage":{ "type":"structure", "members":{ "SnapshotCopyGrantName":{ "shape":"String", "documentation":"

The name of the snapshot copy grant.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

" }, "TagValues":{ "shape":"TagValueList", "documentation":"

A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

" } }, "documentation":"

The result of the DescribeSnapshotCopyGrants action.

" }, "DescribeTableRestoreStatusMessage":{ "type":"structure", "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The Amazon Redshift cluster that the table is being restored to.

" }, "TableRestoreRequestId":{ "shape":"String", "documentation":"

The identifier of the table restore request to return status for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

" } }, "documentation":"

" }, "DescribeTagsMessage":{ "type":"structure", "members":{ "ResourceName":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.

" }, "ResourceType":{ "shape":"String", "documentation":"

The type of resource with which you want to view tags. Valid resource types are:

  • Cluster

  • CIDR/IP

  • EC2 security group

  • Snapshot

  • Cluster security group

  • Subnet group

  • HSM connection

  • HSM certificate

  • Parameter group

  • Snapshot copy grant

For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

" }, "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

" }, "TagValues":{ "shape":"TagValueList", "documentation":"

A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

" } }, "documentation":"

" }, "DisableLoggingMessage":{ "type":"structure", "required":["ClusterIdentifier"], "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The identifier of the cluster on which logging is to be stopped.

Example: examplecluster

" } }, "documentation":"

" }, "DisableSnapshotCopyMessage":{ "type":"structure", "required":["ClusterIdentifier"], "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.

Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

" } }, "documentation":"

" }, "DisableSnapshotCopyResult":{ "type":"structure", "members":{ "Cluster":{"shape":"Cluster"} } }, "Double":{"type":"double"}, "DoubleOptional":{"type":"double"}, "EC2SecurityGroup":{ "type":"structure", "members":{ "Status":{ "shape":"String", "documentation":"

The status of the EC2 security group.

" }, "EC2SecurityGroupName":{ "shape":"String", "documentation":"

The name of the EC2 Security Group.

" }, "EC2SecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

" }, "Tags":{ "shape":"TagList", "documentation":"

The list of tags for the EC2 security group.

" } }, "documentation":"

Describes an Amazon EC2 security group.

" }, "EC2SecurityGroupList":{ "type":"list", "member":{ "shape":"EC2SecurityGroup", "locationName":"EC2SecurityGroup" } }, "ElasticIpStatus":{ "type":"structure", "members":{ "ElasticIp":{ "shape":"String", "documentation":"

The elastic IP (EIP) address for the cluster.

" }, "Status":{ "shape":"String", "documentation":"

The status of the elastic IP (EIP) address.

" } }, "documentation":"

Describes the status of the elastic IP (EIP) address.

" }, "EnableLoggingMessage":{ "type":"structure", "required":[ "ClusterIdentifier", "BucketName" ], "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The identifier of the cluster on which logging is to be started.

Example: examplecluster

" }, "BucketName":{ "shape":"String", "documentation":"

The name of an existing S3 bucket where the log files are to be stored.

Constraints:

  • Must be in the same region as the cluster

  • The cluster must have read bucket and put object permissions

" }, "S3KeyPrefix":{ "shape":"String", "documentation":"

The prefix applied to the log file names.

Constraints:

  • Cannot exceed 512 characters

  • Cannot contain spaces( ), double quotes (\"), single quotes ('), a backslash (\\), or control characters. The hexadecimal codes for invalid characters are:

    • x00 to x20

    • x22

    • x27

    • x5c

    • x7f or larger

" } }, "documentation":"

" }, "EnableSnapshotCopyMessage":{ "type":"structure", "required":[ "ClusterIdentifier", "DestinationRegion" ], "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The unique identifier of the source cluster to copy snapshots from.

Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

" }, "DestinationRegion":{ "shape":"String", "documentation":"

The destination region that you want to copy snapshots to.

Constraints: Must be the name of a valid region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

" }, "RetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

The number of days to retain automated snapshots in the destination region after they are copied from the source region.

Default: 7.

Constraints: Must be at least 1 and no more than 35.

" }, "SnapshotCopyGrantName":{ "shape":"String", "documentation":"

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

" } }, "documentation":"

" }, "EnableSnapshotCopyResult":{ "type":"structure", "members":{ "Cluster":{"shape":"Cluster"} } }, "Endpoint":{ "type":"structure", "members":{ "Address":{ "shape":"String", "documentation":"

The DNS address of the Cluster.

" }, "Port":{ "shape":"Integer", "documentation":"

The port that the database engine is listening on.

" } }, "documentation":"

Describes a connection endpoint.

" }, "Event":{ "type":"structure", "members":{ "SourceIdentifier":{ "shape":"String", "documentation":"

The identifier for the source of the event.

" }, "SourceType":{ "shape":"SourceType", "documentation":"

The source type for this event.

" }, "Message":{ "shape":"String", "documentation":"

The text of this event.

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

A list of the event categories.

Values: Configuration, Management, Monitoring, Security

" }, "Severity":{ "shape":"String", "documentation":"

The severity of the event.

Values: ERROR, INFO

" }, "Date":{ "shape":"TStamp", "documentation":"

The date and time of the event.

" }, "EventId":{ "shape":"String", "documentation":"

The identifier of the event.

" } }, "documentation":"

Describes an event.

" }, "EventCategoriesList":{ "type":"list", "member":{ "shape":"String", "locationName":"EventCategory" } }, "EventCategoriesMap":{ "type":"structure", "members":{ "SourceType":{ "shape":"String", "documentation":"

The source type, such as cluster or cluster-snapshot, that the returned categories belong to.

" }, "Events":{ "shape":"EventInfoMapList", "documentation":"

The events in the event category.

" } }, "documentation":"

Describes event categories.

", "wrapper":true }, "EventCategoriesMapList":{ "type":"list", "member":{ "shape":"EventCategoriesMap", "locationName":"EventCategoriesMap" } }, "EventCategoriesMessage":{ "type":"structure", "members":{ "EventCategoriesMapList":{ "shape":"EventCategoriesMapList", "documentation":"

A list of event categories descriptions.

" } }, "documentation":"

" }, "EventInfoMap":{ "type":"structure", "members":{ "EventId":{ "shape":"String", "documentation":"

The identifier of an Amazon Redshift event.

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

The category of an Amazon Redshift event.

" }, "EventDescription":{ "shape":"String", "documentation":"

The description of an Amazon Redshift event.

" }, "Severity":{ "shape":"String", "documentation":"

The severity of the event.

Values: ERROR, INFO

" } }, "documentation":"

Describes event information.

", "wrapper":true }, "EventInfoMapList":{ "type":"list", "member":{ "shape":"EventInfoMap", "locationName":"EventInfoMap" } }, "EventList":{ "type":"list", "member":{ "shape":"Event", "locationName":"Event" } }, "EventSubscription":{ "type":"structure", "members":{ "CustomerAwsId":{ "shape":"String", "documentation":"

The AWS customer account associated with the Amazon Redshift event notification subscription.

" }, "CustSubscriptionId":{ "shape":"String", "documentation":"

The name of the Amazon Redshift event notification subscription.

" }, "SnsTopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.

" }, "Status":{ "shape":"String", "documentation":"

The status of the Amazon Redshift event notification subscription.

Constraints:

  • Can be one of the following: active | no-permission | topic-not-exist

  • The status \"no-permission\" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

" }, "SubscriptionCreationTime":{ "shape":"TStamp", "documentation":"

The date and time the Amazon Redshift event notification subscription was created.

" }, "SourceType":{ "shape":"String", "documentation":"

The source type of the events returned the Amazon Redshift event notification, such as cluster, or cluster-snapshot.

" }, "SourceIdsList":{ "shape":"SourceIdsList", "documentation":"

A list of the sources that publish events to the Amazon Redshift event notification subscription.

" }, "EventCategoriesList":{ "shape":"EventCategoriesList", "documentation":"

The list of Amazon Redshift event categories specified in the event notification subscription.

Values: Configuration, Management, Monitoring, Security

" }, "Severity":{ "shape":"String", "documentation":"

The event severity specified in the Amazon Redshift event notification subscription.

Values: ERROR, INFO

" }, "Enabled":{ "shape":"Boolean", "documentation":"

A Boolean value indicating whether the subscription is enabled. true indicates the subscription is enabled.

" }, "Tags":{ "shape":"TagList", "documentation":"

The list of tags for the event subscription.

" } }, "documentation":"

Describes event subscriptions.

", "wrapper":true }, "EventSubscriptionQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request would exceed the allowed number of event subscriptions for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

", "error":{ "code":"EventSubscriptionQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "EventSubscriptionsList":{ "type":"list", "member":{ "shape":"EventSubscription", "locationName":"EventSubscription" } }, "EventSubscriptionsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" }, "EventSubscriptionsList":{ "shape":"EventSubscriptionsList", "documentation":"

A list of event subscriptions.

" } }, "documentation":"

" }, "EventsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" }, "Events":{ "shape":"EventList", "documentation":"

A list of Event instances.

" } }, "documentation":"

" }, "HsmClientCertificate":{ "type":"structure", "members":{ "HsmClientCertificateIdentifier":{ "shape":"String", "documentation":"

The identifier of the HSM client certificate.

" }, "HsmClientCertificatePublicKey":{ "shape":"String", "documentation":"

The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.

" }, "Tags":{ "shape":"TagList", "documentation":"

The list of tags for the HSM client certificate.

" } }, "documentation":"

Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.

", "wrapper":true }, "HsmClientCertificateAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

There is already an existing Amazon Redshift HSM client certificate with the specified identifier.

", "error":{ "code":"HsmClientCertificateAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "HsmClientCertificateList":{ "type":"list", "member":{ "shape":"HsmClientCertificate", "locationName":"HsmClientCertificate" } }, "HsmClientCertificateMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" }, "HsmClientCertificates":{ "shape":"HsmClientCertificateList", "documentation":"

A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM.

" } }, "documentation":"

" }, "HsmClientCertificateNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

There is no Amazon Redshift HSM client certificate with the specified identifier.

", "error":{ "code":"HsmClientCertificateNotFoundFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "HsmClientCertificateQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The quota for HSM client certificates has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

", "error":{ "code":"HsmClientCertificateQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "HsmConfiguration":{ "type":"structure", "members":{ "HsmConfigurationIdentifier":{ "shape":"String", "documentation":"

The name of the Amazon Redshift HSM configuration.

" }, "Description":{ "shape":"String", "documentation":"

A text description of the HSM configuration.

" }, "HsmIpAddress":{ "shape":"String", "documentation":"

The IP address that the Amazon Redshift cluster must use to access the HSM.

" }, "HsmPartitionName":{ "shape":"String", "documentation":"

The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

" }, "Tags":{ "shape":"TagList", "documentation":"

The list of tags for the HSM configuration.

" } }, "documentation":"

Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.

", "wrapper":true }, "HsmConfigurationAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

There is already an existing Amazon Redshift HSM configuration with the specified identifier.

", "error":{ "code":"HsmConfigurationAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "HsmConfigurationList":{ "type":"list", "member":{ "shape":"HsmConfiguration", "locationName":"HsmConfiguration" } }, "HsmConfigurationMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" }, "HsmConfigurations":{ "shape":"HsmConfigurationList", "documentation":"

A list of HsmConfiguration objects.

" } }, "documentation":"

" }, "HsmConfigurationNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

There is no Amazon Redshift HSM configuration with the specified identifier.

", "error":{ "code":"HsmConfigurationNotFoundFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "HsmConfigurationQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The quota for HSM configurations has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

", "error":{ "code":"HsmConfigurationQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "HsmStatus":{ "type":"structure", "members":{ "HsmClientCertificateIdentifier":{ "shape":"String", "documentation":"

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

" }, "HsmConfigurationIdentifier":{ "shape":"String", "documentation":"

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

" }, "Status":{ "shape":"String", "documentation":"

Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.

Values: active, applying

" } }, "documentation":"

Describes the status of changes to HSM settings.

" }, "IPRange":{ "type":"structure", "members":{ "Status":{ "shape":"String", "documentation":"

The status of the IP range, for example, \"authorized\".

" }, "CIDRIP":{ "shape":"String", "documentation":"

The IP range in Classless Inter-Domain Routing (CIDR) notation.

" }, "Tags":{ "shape":"TagList", "documentation":"

The list of tags for the IP range.

" } }, "documentation":"

Describes an IP range used in a security group.

" }, "IPRangeList":{ "type":"list", "member":{ "shape":"IPRange", "locationName":"IPRange" } }, "IamRoleArnList":{ "type":"list", "member":{ "shape":"String", "locationName":"IamRoleArn" } }, "ImportTablesCompleted":{ "type":"list", "member":{"shape":"String"} }, "ImportTablesInProgress":{ "type":"list", "member":{"shape":"String"} }, "ImportTablesNotStarted":{ "type":"list", "member":{"shape":"String"} }, "InProgressTableRestoreQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

You have exceeded the allowed number of table restore requests. Wait for your current table restore requests to complete before making a new request.

", "error":{ "code":"InProgressTableRestoreQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "IncompatibleOrderableOptions":{ "type":"structure", "members":{ }, "documentation":"

The specified options are incompatible.

", "error":{ "code":"IncompatibleOrderableOptions", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InsufficientClusterCapacityFault":{ "type":"structure", "members":{ }, "documentation":"

The number of nodes specified exceeds the allotted capacity of the cluster.

", "error":{ "code":"InsufficientClusterCapacity", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InsufficientS3BucketPolicyFault":{ "type":"structure", "members":{ }, "documentation":"

The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling logging.

", "error":{ "code":"InsufficientS3BucketPolicyFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Integer":{"type":"integer"}, "IntegerOptional":{"type":"integer"}, "InvalidClusterParameterGroupStateFault":{ "type":"structure", "members":{ }, "documentation":"

The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.

", "error":{ "code":"InvalidClusterParameterGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidClusterSecurityGroupStateFault":{ "type":"structure", "members":{ }, "documentation":"

The state of the cluster security group is not available.

", "error":{ "code":"InvalidClusterSecurityGroupState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidClusterSnapshotStateFault":{ "type":"structure", "members":{ }, "documentation":"

The specified cluster snapshot is not in the available state, or other accounts are authorized to access the snapshot.

", "error":{ "code":"InvalidClusterSnapshotState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidClusterStateFault":{ "type":"structure", "members":{ }, "documentation":"

The specified cluster is not in the available state.

", "error":{ "code":"InvalidClusterState", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidClusterSubnetGroupStateFault":{ "type":"structure", "members":{ }, "documentation":"

The cluster subnet group cannot be deleted because it is in use.

", "error":{ "code":"InvalidClusterSubnetGroupStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidClusterSubnetStateFault":{ "type":"structure", "members":{ }, "documentation":"

The state of the subnet is invalid.

", "error":{ "code":"InvalidClusterSubnetStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidElasticIpFault":{ "type":"structure", "members":{ }, "documentation":"

The Elastic IP (EIP) is invalid or cannot be found.

", "error":{ "code":"InvalidElasticIpFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidHsmClientCertificateStateFault":{ "type":"structure", "members":{ }, "documentation":"

The specified HSM client certificate is not in the available state, or it is still in use by one or more Amazon Redshift clusters.

", "error":{ "code":"InvalidHsmClientCertificateStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidHsmConfigurationStateFault":{ "type":"structure", "members":{ }, "documentation":"

The specified HSM configuration is not in the available state, or it is still in use by one or more Amazon Redshift clusters.

", "error":{ "code":"InvalidHsmConfigurationStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidRestoreFault":{ "type":"structure", "members":{ }, "documentation":"

The restore is invalid.

", "error":{ "code":"InvalidRestore", "httpStatusCode":406, "senderFault":true }, "exception":true }, "InvalidS3BucketNameFault":{ "type":"structure", "members":{ }, "documentation":"

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.

", "error":{ "code":"InvalidS3BucketNameFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidS3KeyPrefixFault":{ "type":"structure", "members":{ }, "documentation":"

The string specified for the logging S3 key prefix does not comply with the documented constraints.

", "error":{ "code":"InvalidS3KeyPrefixFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidSnapshotCopyGrantStateFault":{ "type":"structure", "members":{ }, "documentation":"

The snapshot copy grant can't be deleted because it is used by one or more clusters.

", "error":{ "code":"InvalidSnapshotCopyGrantStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidSubnet":{ "type":"structure", "members":{ }, "documentation":"

The requested subnet is not valid, or not all of the subnets are in the same VPC.

", "error":{ "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidSubscriptionStateFault":{ "type":"structure", "members":{ }, "documentation":"

The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.

", "error":{ "code":"InvalidSubscriptionStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidTableRestoreArgumentFault":{ "type":"structure", "members":{ }, "documentation":"

The value specified for the sourceDatabaseName, sourceSchemaName, or sourceTableName parameter, or a combination of these, doesn't exist in the snapshot.

", "error":{ "code":"InvalidTableRestoreArgument", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidTagFault":{ "type":"structure", "members":{ }, "documentation":"

The tag is invalid.

", "error":{ "code":"InvalidTagFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidVPCNetworkStateFault":{ "type":"structure", "members":{ }, "documentation":"

The cluster subnet group does not cover all Availability Zones.

", "error":{ "code":"InvalidVPCNetworkStateFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "LimitExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The encryption key has exceeded its grant limit in AWS KMS.

", "error":{ "code":"LimitExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "LoggingStatus":{ "type":"structure", "members":{ "LoggingEnabled":{ "shape":"Boolean", "documentation":"

true if logging is on, false if logging is off.

" }, "BucketName":{ "shape":"String", "documentation":"

The name of the S3 bucket where the log files are stored.

" }, "S3KeyPrefix":{ "shape":"String", "documentation":"

The prefix applied to the log file names.

" }, "LastSuccessfulDeliveryTime":{ "shape":"TStamp", "documentation":"

The last time that logs were delivered.

" }, "LastFailureTime":{ "shape":"TStamp", "documentation":"

The last time when logs failed to be delivered.

" }, "LastFailureMessage":{ "shape":"String", "documentation":"

The message indicating that logs failed to be delivered.

" } }, "documentation":"

Describes the status of logging for a cluster.

" }, "Long":{"type":"long"}, "LongOptional":{"type":"long"}, "ModifyClusterIamRolesMessage":{ "type":"structure", "required":["ClusterIdentifier"], "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The unique identifier of the cluster for which you want to associate or disassociate IAM roles.

" }, "AddIamRoles":{ "shape":"IamRoleArnList", "documentation":"

Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request.

" }, "RemoveIamRoles":{ "shape":"IamRoleArnList", "documentation":"

Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.

" } }, "documentation":"

" }, "ModifyClusterIamRolesResult":{ "type":"structure", "members":{ "Cluster":{"shape":"Cluster"} } }, "ModifyClusterMessage":{ "type":"structure", "required":["ClusterIdentifier"], "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The unique identifier of the cluster to be modified.

Example: examplecluster

" }, "ClusterType":{ "shape":"String", "documentation":"

The new cluster type.

When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.

Valid Values: multi-node | single-node

" }, "NodeType":{ "shape":"String", "documentation":"

The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.

When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.

Valid Values: ds1.xlarge | ds1.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge.

" }, "NumberOfNodes":{ "shape":"IntegerOptional", "documentation":"

The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.

When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.

Valid Values: Integer greater than 0.

" }, "ClusterSecurityGroups":{ "shape":"ClusterSecurityGroupNameList", "documentation":"

A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.

Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A list of virtual private cloud (VPC) security groups to be associated with the cluster.

" }, "MasterUserPassword":{ "shape":"String", "documentation":"

The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost.

Default: Uses existing setting.

Constraints:

  • Must be between 8 and 64 characters in length.

  • Must contain at least one uppercase letter.

  • Must contain at least one lowercase letter.

  • Must contain one number.

  • Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), \" (double quote), \\, /, @, or space.

" }, "ClusterParameterGroupName":{ "shape":"String", "documentation":"

The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.

Default: Uses existing setting.

Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.

" }, "AutomatedSnapshotRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.

Default: Uses existing setting.

Constraints: Must be a value from 0 to 35.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.

This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes.

" }, "ClusterVersion":{ "shape":"String", "documentation":"

The new version number of the Amazon Redshift engine to upgrade to.

For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Example: 1.0

" }, "AllowVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

Default: false

" }, "HsmClientCertificateIdentifier":{ "shape":"String", "documentation":"

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

" }, "HsmConfigurationIdentifier":{ "shape":"String", "documentation":"

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

" }, "NewClusterIdentifier":{ "shape":"String", "documentation":"

The new identifier for the cluster.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • Alphabetic characters must be lowercase.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • Must be unique for all clusters within an AWS account.

Example: examplecluster

" }, "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"

If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.

" }, "ElasticIp":{ "shape":"String", "documentation":"

The Elastic IP (EIP) address for the cluster.

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 Cluster Management Guide.

" }, "EnhancedVpcRouting":{ "shape":"BooleanOptional", "documentation":"

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

" } }, "documentation":"

" }, "ModifyClusterParameterGroupMessage":{ "type":"structure", "required":[ "ParameterGroupName", "Parameters" ], "members":{ "ParameterGroupName":{ "shape":"String", "documentation":"

The name of the parameter group to be modified.

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.

For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.

For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.

" } }, "documentation":"

" }, "ModifyClusterResult":{ "type":"structure", "members":{ "Cluster":{"shape":"Cluster"} } }, "ModifyClusterSubnetGroupMessage":{ "type":"structure", "required":[ "ClusterSubnetGroupName", "SubnetIds" ], "members":{ "ClusterSubnetGroupName":{ "shape":"String", "documentation":"

The name of the subnet group to be modified.

" }, "Description":{ "shape":"String", "documentation":"

A text description of the subnet group to be modified.

" }, "SubnetIds":{ "shape":"SubnetIdentifierList", "documentation":"

An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

" } }, "documentation":"

" }, "ModifyClusterSubnetGroupResult":{ "type":"structure", "members":{ "ClusterSubnetGroup":{"shape":"ClusterSubnetGroup"} } }, "ModifyEventSubscriptionMessage":{ "type":"structure", "required":["SubscriptionName"], "members":{ "SubscriptionName":{ "shape":"String", "documentation":"

The name of the modified Amazon Redshift event notification subscription.

" }, "SnsTopicArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.

" }, "SourceType":{ "shape":"String", "documentation":"

The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.

Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

" }, "SourceIds":{ "shape":"SourceIdsList", "documentation":"

A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

Example: my-cluster-1, my-cluster-2

Example: my-snapshot-20131010

" }, "EventCategories":{ "shape":"EventCategoriesList", "documentation":"

Specifies the Amazon Redshift event categories to be published by the event notification subscription.

Values: Configuration, Management, Monitoring, Security

" }, "Severity":{ "shape":"String", "documentation":"

Specifies the Amazon Redshift event severity to be published by the event notification subscription.

Values: ERROR, INFO

" }, "Enabled":{ "shape":"BooleanOptional", "documentation":"

A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled

" } }, "documentation":"

" }, "ModifyEventSubscriptionResult":{ "type":"structure", "members":{ "EventSubscription":{"shape":"EventSubscription"} } }, "ModifySnapshotCopyRetentionPeriodMessage":{ "type":"structure", "required":[ "ClusterIdentifier", "RetentionPeriod" ], "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

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.

Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

" }, "RetentionPeriod":{ "shape":"Integer", "documentation":"

The number of days to retain automated snapshots in the destination region after they are copied from the source region.

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.

Constraints: Must be at least 1 and no more than 35.

" } }, "documentation":"

" }, "ModifySnapshotCopyRetentionPeriodResult":{ "type":"structure", "members":{ "Cluster":{"shape":"Cluster"} } }, "NumberOfNodesPerClusterLimitExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The operation would exceed the number of nodes allowed for a cluster.

", "error":{ "code":"NumberOfNodesPerClusterLimitExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "NumberOfNodesQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

", "error":{ "code":"NumberOfNodesQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "OrderableClusterOption":{ "type":"structure", "members":{ "ClusterVersion":{ "shape":"String", "documentation":"

The version of the orderable cluster.

" }, "ClusterType":{ "shape":"String", "documentation":"

The cluster type, for example multi-node.

" }, "NodeType":{ "shape":"String", "documentation":"

The node type for the orderable cluster.

" }, "AvailabilityZones":{ "shape":"AvailabilityZoneList", "documentation":"

A list of availability zones for the orderable cluster.

" } }, "documentation":"

Describes an orderable cluster option.

", "wrapper":true }, "OrderableClusterOptionsList":{ "type":"list", "member":{ "shape":"OrderableClusterOption", "locationName":"OrderableClusterOption" } }, "OrderableClusterOptionsMessage":{ "type":"structure", "members":{ "OrderableClusterOptions":{ "shape":"OrderableClusterOptionsList", "documentation":"

An OrderableClusterOption structure containing information about orderable options for the cluster.

" }, "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" } }, "documentation":"

Contains the output from the DescribeOrderableClusterOptions action.

" }, "Parameter":{ "type":"structure", "members":{ "ParameterName":{ "shape":"String", "documentation":"

The name of the parameter.

" }, "ParameterValue":{ "shape":"String", "documentation":"

The value of the parameter.

" }, "Description":{ "shape":"String", "documentation":"

A description of the parameter.

" }, "Source":{ "shape":"String", "documentation":"

The source of the parameter value, such as \"engine-default\" or \"user\".

" }, "DataType":{ "shape":"String", "documentation":"

The data type of the parameter.

" }, "AllowedValues":{ "shape":"String", "documentation":"

The valid range of values for the parameter.

" }, "ApplyType":{ "shape":"ParameterApplyType", "documentation":"

Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

" }, "IsModifiable":{ "shape":"Boolean", "documentation":"

If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" }, "MinimumEngineVersion":{ "shape":"String", "documentation":"

The earliest engine version to which the parameter can apply.

" } }, "documentation":"

Describes a parameter in a cluster parameter group.

" }, "ParameterApplyType":{ "type":"string", "enum":[ "static", "dynamic" ] }, "ParameterGroupList":{ "type":"list", "member":{ "shape":"ClusterParameterGroup", "locationName":"ClusterParameterGroup" } }, "ParametersList":{ "type":"list", "member":{ "shape":"Parameter", "locationName":"Parameter" } }, "PendingModifiedValues":{ "type":"structure", "members":{ "MasterUserPassword":{ "shape":"String", "documentation":"

The pending or in-progress change of the master user password for the cluster.

" }, "NodeType":{ "shape":"String", "documentation":"

The pending or in-progress change of the cluster's node type.

" }, "NumberOfNodes":{ "shape":"IntegerOptional", "documentation":"

The pending or in-progress change of the number of nodes in the cluster.

" }, "ClusterType":{ "shape":"String", "documentation":"

The pending or in-progress change of the cluster type.

" }, "ClusterVersion":{ "shape":"String", "documentation":"

The pending or in-progress change of the service version.

" }, "AutomatedSnapshotRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

The pending or in-progress change of the automated snapshot retention period.

" }, "ClusterIdentifier":{ "shape":"String", "documentation":"

The pending or in-progress change of the new identifier for the cluster.

" }, "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"

The pending or in-progress change of the ability to connect to the cluster from the public network.

" }, "EnhancedVpcRouting":{ "shape":"BooleanOptional", "documentation":"

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

" } }, "documentation":"

Describes cluster attributes that are in a pending state. A change to one or more the attributes was requested and is in progress or will be applied.

" }, "PurchaseReservedNodeOfferingMessage":{ "type":"structure", "required":["ReservedNodeOfferingId"], "members":{ "ReservedNodeOfferingId":{ "shape":"String", "documentation":"

The unique identifier of the reserved node offering you want to purchase.

" }, "NodeCount":{ "shape":"IntegerOptional", "documentation":"

The number of reserved nodes that you want to purchase.

Default: 1

" } }, "documentation":"

" }, "PurchaseReservedNodeOfferingResult":{ "type":"structure", "members":{ "ReservedNode":{"shape":"ReservedNode"} } }, "RebootClusterMessage":{ "type":"structure", "required":["ClusterIdentifier"], "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The cluster identifier.

" } }, "documentation":"

" }, "RebootClusterResult":{ "type":"structure", "members":{ "Cluster":{"shape":"Cluster"} } }, "RecurringCharge":{ "type":"structure", "members":{ "RecurringChargeAmount":{ "shape":"Double", "documentation":"

The amount charged per the period of time specified by the recurring charge frequency.

" }, "RecurringChargeFrequency":{ "shape":"String", "documentation":"

The frequency at which the recurring charge amount is applied.

" } }, "documentation":"

Describes a recurring charge.

", "wrapper":true }, "RecurringChargeList":{ "type":"list", "member":{ "shape":"RecurringCharge", "locationName":"RecurringCharge" } }, "ReservedNode":{ "type":"structure", "members":{ "ReservedNodeId":{ "shape":"String", "documentation":"

The unique identifier for the reservation.

" }, "ReservedNodeOfferingId":{ "shape":"String", "documentation":"

The identifier for the reserved node offering.

" }, "NodeType":{ "shape":"String", "documentation":"

The node type of the reserved node.

" }, "StartTime":{ "shape":"TStamp", "documentation":"

The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.

" }, "Duration":{ "shape":"Integer", "documentation":"

The duration of the node reservation in seconds.

" }, "FixedPrice":{ "shape":"Double", "documentation":"

The fixed cost Amazon Redshift charges you for this reserved node.

" }, "UsagePrice":{ "shape":"Double", "documentation":"

The hourly rate Amazon Redshift charges you for this reserved node.

" }, "CurrencyCode":{ "shape":"String", "documentation":"

The currency code for the reserved cluster.

" }, "NodeCount":{ "shape":"Integer", "documentation":"

The number of reserved compute nodes.

" }, "State":{ "shape":"String", "documentation":"

The state of the reserved compute node.

Possible Values:

  • pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.

  • active-This reserved node is owned by the caller and is available for use.

  • payment-failed-Payment failed for the purchase attempt.

" }, "OfferingType":{ "shape":"String", "documentation":"

The anticipated utilization of the reserved node, as defined in the reserved node offering.

" }, "RecurringCharges":{ "shape":"RecurringChargeList", "documentation":"

The recurring charges for the reserved node.

" } }, "documentation":"

Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.

", "wrapper":true }, "ReservedNodeAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

User already has a reservation with the given identifier.

", "error":{ "code":"ReservedNodeAlreadyExists", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ReservedNodeList":{ "type":"list", "member":{ "shape":"ReservedNode", "locationName":"ReservedNode" } }, "ReservedNodeNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The specified reserved compute node not found.

", "error":{ "code":"ReservedNodeNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ReservedNodeOffering":{ "type":"structure", "members":{ "ReservedNodeOfferingId":{ "shape":"String", "documentation":"

The offering identifier.

" }, "NodeType":{ "shape":"String", "documentation":"

The node type offered by the reserved node offering.

" }, "Duration":{ "shape":"Integer", "documentation":"

The duration, in seconds, for which the offering will reserve the node.

" }, "FixedPrice":{ "shape":"Double", "documentation":"

The upfront fixed charge you will pay to purchase the specific reserved node offering.

" }, "UsagePrice":{ "shape":"Double", "documentation":"

The rate you are charged for each hour the cluster that is using the offering is running.

" }, "CurrencyCode":{ "shape":"String", "documentation":"

The currency code for the compute nodes offering.

" }, "OfferingType":{ "shape":"String", "documentation":"

The anticipated utilization of the reserved node, as defined in the reserved node offering.

" }, "RecurringCharges":{ "shape":"RecurringChargeList", "documentation":"

The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes.

" } }, "documentation":"

Describes a reserved node offering.

", "wrapper":true }, "ReservedNodeOfferingList":{ "type":"list", "member":{ "shape":"ReservedNodeOffering", "locationName":"ReservedNodeOffering" } }, "ReservedNodeOfferingNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

Specified offering does not exist.

", "error":{ "code":"ReservedNodeOfferingNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ReservedNodeOfferingsMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" }, "ReservedNodeOfferings":{ "shape":"ReservedNodeOfferingList", "documentation":"

A list of ReservedNodeOffering objects.

" } }, "documentation":"

" }, "ReservedNodeQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

Request would exceed the user's compute node quota. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

", "error":{ "code":"ReservedNodeQuotaExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ReservedNodesMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" }, "ReservedNodes":{ "shape":"ReservedNodeList", "documentation":"

The list of ReservedNode objects.

" } }, "documentation":"

" }, "ResetClusterParameterGroupMessage":{ "type":"structure", "required":["ParameterGroupName"], "members":{ "ParameterGroupName":{ "shape":"String", "documentation":"

The name of the cluster parameter group to be reset.

" }, "ResetAllParameters":{ "shape":"Boolean", "documentation":"

If true, all parameters in the specified parameter group will be reset to their default values.

Default: true

" }, "Parameters":{ "shape":"ParametersList", "documentation":"

An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.

Constraints: A maximum of 20 parameters can be reset in a single request.

" } }, "documentation":"

" }, "ResizeNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

A resize operation for the specified cluster is not found.

", "error":{ "code":"ResizeNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ResizeProgressMessage":{ "type":"structure", "members":{ "TargetNodeType":{ "shape":"String", "documentation":"

The node type that the cluster will have after the resize operation is complete.

" }, "TargetNumberOfNodes":{ "shape":"IntegerOptional", "documentation":"

The number of nodes that the cluster will have after the resize operation is complete.

" }, "TargetClusterType":{ "shape":"String", "documentation":"

The cluster type after the resize operation is complete.

Valid Values: multi-node | single-node

" }, "Status":{ "shape":"String", "documentation":"

The status of the resize operation.

Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED

" }, "ImportTablesCompleted":{ "shape":"ImportTablesCompleted", "documentation":"

The names of tables that have been completely imported .

Valid Values: List of table names.

" }, "ImportTablesInProgress":{ "shape":"ImportTablesInProgress", "documentation":"

The names of tables that are being currently imported.

Valid Values: List of table names.

" }, "ImportTablesNotStarted":{ "shape":"ImportTablesNotStarted", "documentation":"

The names of tables that have not been yet imported.

Valid Values: List of table names

" }, "AvgResizeRateInMegaBytesPerSecond":{ "shape":"DoubleOptional", "documentation":"

The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.

" }, "TotalResizeDataInMegaBytes":{ "shape":"LongOptional", "documentation":"

The estimated total amount of data, in megabytes, on the cluster before the resize operation began.

" }, "ProgressInMegaBytes":{ "shape":"LongOptional", "documentation":"

While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).

" }, "ElapsedTimeInSeconds":{ "shape":"LongOptional", "documentation":"

The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.

" }, "EstimatedTimeToCompletionInSeconds":{ "shape":"LongOptional", "documentation":"

The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.

" } }, "documentation":"

Describes the result of a cluster resize operation.

" }, "ResourceNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The resource could not be found.

", "error":{ "code":"ResourceNotFoundFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "RestorableNodeTypeList":{ "type":"list", "member":{ "shape":"String", "locationName":"NodeType" } }, "RestoreFromClusterSnapshotMessage":{ "type":"structure", "required":[ "ClusterIdentifier", "SnapshotIdentifier" ], "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The identifier of the cluster that will be created from restoring the snapshot.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • Alphabetic characters must be lowercase.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • Must be unique for all clusters within an AWS account.

" }, "SnapshotIdentifier":{ "shape":"String", "documentation":"

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

Example: my-snapshot-id

" }, "SnapshotClusterIdentifier":{ "shape":"String", "documentation":"

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.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port number on which the cluster accepts connections.

Default: The same port as the original cluster.

Constraints: Must be between 1115 and 65535.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-1a

" }, "AllowVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

Default: true

" }, "ClusterSubnetGroupName":{ "shape":"String", "documentation":"

The name of the subnet group where you want to cluster restored.

A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.

" }, "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"

If true, the cluster can be accessed from a public network.

" }, "OwnerAccount":{ "shape":"String", "documentation":"

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.

" }, "HsmClientCertificateIdentifier":{ "shape":"String", "documentation":"

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

" }, "HsmConfigurationIdentifier":{ "shape":"String", "documentation":"

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

" }, "ElasticIp":{ "shape":"String", "documentation":"

The elastic IP (EIP) address for the cluster.

" }, "ClusterParameterGroupName":{ "shape":"String", "documentation":"

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" }, "ClusterSecurityGroups":{ "shape":"ClusterSecurityGroupNameList", "documentation":"

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Cluster security groups only apply to clusters outside of VPCs.

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

VPC security groups only apply to clusters in VPCs.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

" }, "AutomatedSnapshotRetentionPeriod":{ "shape":"IntegerOptional", "documentation":"

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

Default: The value selected for the cluster from which the snapshot was taken.

Constraints: Must be a value from 0 to 35.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.

" }, "NodeType":{ "shape":"String", "documentation":"

The node type that the restored cluster will be provisioned with.

Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds2.xlarge into ds1.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide

" }, "EnhancedVpcRouting":{ "shape":"BooleanOptional", "documentation":"

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

" }, "AdditionalInfo":{ "shape":"String", "documentation":"

Reserved.

" }, "IamRoles":{ "shape":"IamRoleArnList", "documentation":"

A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.

A cluster can have up to 10 IAM roles associated at any time.

" } }, "documentation":"

" }, "RestoreFromClusterSnapshotResult":{ "type":"structure", "members":{ "Cluster":{"shape":"Cluster"} } }, "RestoreStatus":{ "type":"structure", "members":{ "Status":{ "shape":"String", "documentation":"

The status of the restore action. Returns starting, restoring, completed, or failed.

" }, "CurrentRestoreRateInMegaBytesPerSecond":{ "shape":"Double", "documentation":"

The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.

" }, "SnapshotSizeInMegaBytes":{ "shape":"Long", "documentation":"

The size of the set of snapshot data used to restore the cluster.

" }, "ProgressInMegaBytes":{ "shape":"Long", "documentation":"

The number of megabytes that have been transferred from snapshot storage.

" }, "ElapsedTimeInSeconds":{ "shape":"Long", "documentation":"

The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.

" }, "EstimatedTimeToCompletionInSeconds":{ "shape":"Long", "documentation":"

The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.

" } }, "documentation":"

Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

" }, "RestoreTableFromClusterSnapshotMessage":{ "type":"structure", "required":[ "ClusterIdentifier", "SnapshotIdentifier", "SourceDatabaseName", "SourceTableName", "NewTableName" ], "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The identifier of the Amazon Redshift cluster to restore the table to.

" }, "SnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.

" }, "SourceDatabaseName":{ "shape":"String", "documentation":"

The name of the source database that contains the table to restore from.

" }, "SourceSchemaName":{ "shape":"String", "documentation":"

The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.

" }, "SourceTableName":{ "shape":"String", "documentation":"

The name of the source table to restore from.

" }, "TargetDatabaseName":{ "shape":"String", "documentation":"

The name of the database to restore the table to.

" }, "TargetSchemaName":{ "shape":"String", "documentation":"

The name of the schema to restore the table to.

" }, "NewTableName":{ "shape":"String", "documentation":"

The name of the table to create as a result of the current request.

" } }, "documentation":"

" }, "RestoreTableFromClusterSnapshotResult":{ "type":"structure", "members":{ "TableRestoreStatus":{"shape":"TableRestoreStatus"} } }, "RevokeClusterSecurityGroupIngressMessage":{ "type":"structure", "required":["ClusterSecurityGroupName"], "members":{ "ClusterSecurityGroupName":{ "shape":"String", "documentation":"

The name of the security Group from which to revoke the ingress rule.

" }, "CIDRIP":{ "shape":"String", "documentation":"

The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.

" }, "EC2SecurityGroupName":{ "shape":"String", "documentation":"

The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided.

" }, "EC2SecurityGroupOwnerId":{ "shape":"String", "documentation":"

The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.

Example: 111122223333

" } }, "documentation":"

" }, "RevokeClusterSecurityGroupIngressResult":{ "type":"structure", "members":{ "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} } }, "RevokeSnapshotAccessMessage":{ "type":"structure", "required":[ "SnapshotIdentifier", "AccountWithRestoreAccess" ], "members":{ "SnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier of the snapshot that the account can no longer access.

" }, "SnapshotClusterIdentifier":{ "shape":"String", "documentation":"

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.

" }, "AccountWithRestoreAccess":{ "shape":"String", "documentation":"

The identifier of the AWS customer account that can no longer restore the specified snapshot.

" } }, "documentation":"

" }, "RevokeSnapshotAccessResult":{ "type":"structure", "members":{ "Snapshot":{"shape":"Snapshot"} } }, "RotateEncryptionKeyMessage":{ "type":"structure", "required":["ClusterIdentifier"], "members":{ "ClusterIdentifier":{ "shape":"String", "documentation":"

The unique identifier of the cluster that you want to rotate the encryption keys for.

Constraints: Must be the name of valid cluster that has encryption enabled.

" } }, "documentation":"

" }, "RotateEncryptionKeyResult":{ "type":"structure", "members":{ "Cluster":{"shape":"Cluster"} } }, "SNSInvalidTopicFault":{ "type":"structure", "members":{ }, "documentation":"

Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.

", "error":{ "code":"SNSInvalidTopic", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SNSNoAuthorizationFault":{ "type":"structure", "members":{ }, "documentation":"

You do not have permission to publish to the specified Amazon SNS topic.

", "error":{ "code":"SNSNoAuthorization", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SNSTopicArnNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.

", "error":{ "code":"SNSTopicArnNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "Snapshot":{ "type":"structure", "members":{ "SnapshotIdentifier":{ "shape":"String", "documentation":"

The snapshot identifier that is provided in the request.

" }, "ClusterIdentifier":{ "shape":"String", "documentation":"

The identifier of the cluster for which the snapshot was taken.

" }, "SnapshotCreateTime":{ "shape":"TStamp", "documentation":"

The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

" }, "Status":{ "shape":"String", "documentation":"

The snapshot status. The value of the status depends on the API operation used.

" }, "Port":{ "shape":"Integer", "documentation":"

The port that the cluster is listening on.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the cluster was created.

" }, "ClusterCreateTime":{ "shape":"TStamp", "documentation":"

The time (UTC) when the cluster was originally created.

" }, "MasterUsername":{ "shape":"String", "documentation":"

The master user name for the cluster.

" }, "ClusterVersion":{ "shape":"String", "documentation":"

The version ID of the Amazon Redshift engine that is running on the cluster.

" }, "SnapshotType":{ "shape":"String", "documentation":"

The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type \"manual\".

" }, "NodeType":{ "shape":"String", "documentation":"

The node type of the nodes in the cluster.

" }, "NumberOfNodes":{ "shape":"Integer", "documentation":"

The number of nodes in the cluster.

" }, "DBName":{ "shape":"String", "documentation":"

The name of the database that was created when the cluster was created.

" }, "VpcId":{ "shape":"String", "documentation":"

The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

" }, "Encrypted":{ "shape":"Boolean", "documentation":"

If true, the data in the snapshot is encrypted at rest.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

" }, "EncryptedWithHSM":{ "shape":"Boolean", "documentation":"

A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

" }, "AccountsWithRestoreAccess":{ "shape":"AccountsWithRestoreAccessList", "documentation":"

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.

" }, "OwnerAccount":{ "shape":"String", "documentation":"

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.

" }, "TotalBackupSizeInMegaBytes":{ "shape":"Double", "documentation":"

The size of the complete set of backup data that would be used to restore the cluster.

" }, "ActualIncrementalBackupSizeInMegaBytes":{ "shape":"Double", "documentation":"

The size of the incremental backup.

" }, "BackupProgressInMegaBytes":{ "shape":"Double", "documentation":"

The number of megabytes that have been transferred to the snapshot backup.

" }, "CurrentBackupRateInMegaBytesPerSecond":{ "shape":"Double", "documentation":"

The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

" }, "EstimatedSecondsToCompletion":{ "shape":"Long", "documentation":"

The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

" }, "ElapsedTimeInSeconds":{ "shape":"Long", "documentation":"

The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

" }, "SourceRegion":{ "shape":"String", "documentation":"

The source region from which the snapshot was copied.

" }, "Tags":{ "shape":"TagList", "documentation":"

The list of tags for the cluster snapshot.

" }, "RestorableNodeTypes":{ "shape":"RestorableNodeTypeList", "documentation":"

The list of node types that this cluster snapshot is able to restore into.

" }, "EnhancedVpcRouting":{ "shape":"Boolean", "documentation":"

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

" } }, "documentation":"

Describes a snapshot.

", "wrapper":true }, "SnapshotCopyAlreadyDisabledFault":{ "type":"structure", "members":{ }, "documentation":"

The cluster already has cross-region snapshot copy disabled.

", "error":{ "code":"SnapshotCopyAlreadyDisabledFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SnapshotCopyAlreadyEnabledFault":{ "type":"structure", "members":{ }, "documentation":"

The cluster already has cross-region snapshot copy enabled.

", "error":{ "code":"SnapshotCopyAlreadyEnabledFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SnapshotCopyDisabledFault":{ "type":"structure", "members":{ }, "documentation":"

Cross-region snapshot copy was temporarily disabled. Try your request again.

", "error":{ "code":"SnapshotCopyDisabledFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SnapshotCopyGrant":{ "type":"structure", "members":{ "SnapshotCopyGrantName":{ "shape":"String", "documentation":"

The name of the snapshot copy grant.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

The unique identifier of the customer master key (CMK) in AWS KMS to which Amazon Redshift is granted permission.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of tag instances.

" } }, "documentation":"

The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified customer master key (CMK) from AWS KMS in the destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

", "wrapper":true }, "SnapshotCopyGrantAlreadyExistsFault":{ "type":"structure", "members":{ }, "documentation":"

The snapshot copy grant can't be created because a grant with the same name already exists.

", "error":{ "code":"SnapshotCopyGrantAlreadyExistsFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SnapshotCopyGrantList":{ "type":"list", "member":{ "shape":"SnapshotCopyGrant", "locationName":"SnapshotCopyGrant" } }, "SnapshotCopyGrantMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

" }, "SnapshotCopyGrants":{ "shape":"SnapshotCopyGrantList", "documentation":"

The list of SnapshotCopyGrant objects.

" } }, "documentation":"

" }, "SnapshotCopyGrantNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.

", "error":{ "code":"SnapshotCopyGrantNotFoundFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SnapshotCopyGrantQuotaExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The AWS account has exceeded the maximum number of snapshot copy grants in this region.

", "error":{ "code":"SnapshotCopyGrantQuotaExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SnapshotList":{ "type":"list", "member":{ "shape":"Snapshot", "locationName":"Snapshot" } }, "SnapshotMessage":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" }, "Snapshots":{ "shape":"SnapshotList", "documentation":"

A list of Snapshot instances.

" } }, "documentation":"

Contains the output from the DescribeClusterSnapshots action.

" }, "SourceIdsList":{ "type":"list", "member":{ "shape":"String", "locationName":"SourceId" } }, "SourceNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The specified Amazon Redshift event source could not be found.

", "error":{ "code":"SourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "SourceType":{ "type":"string", "enum":[ "cluster", "cluster-parameter-group", "cluster-security-group", "cluster-snapshot" ] }, "String":{"type":"string"}, "Subnet":{ "type":"structure", "members":{ "SubnetIdentifier":{ "shape":"String", "documentation":"

The identifier of the subnet.

" }, "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, "SubnetStatus":{ "shape":"String", "documentation":"

The status of the subnet.

" } }, "documentation":"

Describes a subnet.

" }, "SubnetAlreadyInUse":{ "type":"structure", "members":{ }, "documentation":"

A specified subnet is already in use by another cluster.

", "error":{ "code":"SubnetAlreadyInUse", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SubnetIdentifierList":{ "type":"list", "member":{ "shape":"String", "locationName":"SubnetIdentifier" } }, "SubnetList":{ "type":"list", "member":{ "shape":"Subnet", "locationName":"Subnet" } }, "SubscriptionAlreadyExistFault":{ "type":"structure", "members":{ }, "documentation":"

There is already an existing event notification subscription with the specified name.

", "error":{ "code":"SubscriptionAlreadyExist", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SubscriptionCategoryNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.

", "error":{ "code":"SubscriptionCategoryNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "SubscriptionEventIdNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

An Amazon Redshift event with the specified event ID does not exist.

", "error":{ "code":"SubscriptionEventIdNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "SubscriptionNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

An Amazon Redshift event notification subscription with the specified name does not exist.

", "error":{ "code":"SubscriptionNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "SubscriptionSeverityNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.

", "error":{ "code":"SubscriptionSeverityNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "TStamp":{"type":"timestamp"}, "TableRestoreNotFoundFault":{ "type":"structure", "members":{ }, "documentation":"

The specified TableRestoreRequestId value was not found.

", "error":{ "code":"TableRestoreNotFoundFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TableRestoreStatus":{ "type":"structure", "members":{ "TableRestoreRequestId":{ "shape":"String", "documentation":"

The unique identifier for the table restore request.

" }, "Status":{ "shape":"TableRestoreStatusType", "documentation":"

A value that describes the current state of the table restore request.

Valid Values: SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS

" }, "Message":{ "shape":"String", "documentation":"

A description of the status of the table restore request. Status values include SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS.

" }, "RequestTime":{ "shape":"TStamp", "documentation":"

The time that the table restore request was made, in Universal Coordinated Time (UTC).

" }, "ProgressInMegaBytes":{ "shape":"LongOptional", "documentation":"

The amount of data restored to the new table so far, in megabytes (MB).

" }, "TotalDataInMegaBytes":{ "shape":"LongOptional", "documentation":"

The total amount of data to restore to the new table, in megabytes (MB).

" }, "ClusterIdentifier":{ "shape":"String", "documentation":"

The identifier of the Amazon Redshift cluster that the table is being restored to.

" }, "SnapshotIdentifier":{ "shape":"String", "documentation":"

The identifier of the snapshot that the table is being restored from.

" }, "SourceDatabaseName":{ "shape":"String", "documentation":"

The name of the source database that contains the table being restored.

" }, "SourceSchemaName":{ "shape":"String", "documentation":"

The name of the source schema that contains the table being restored.

" }, "SourceTableName":{ "shape":"String", "documentation":"

The name of the source table being restored.

" }, "TargetDatabaseName":{ "shape":"String", "documentation":"

The name of the database to restore the table to.

" }, "TargetSchemaName":{ "shape":"String", "documentation":"

The name of the schema to restore the table to.

" }, "NewTableName":{ "shape":"String", "documentation":"

The name of the table to create as a result of the table restore request.

" } }, "documentation":"

Describes the status of a RestoreTableFromClusterSnapshot operation.

", "wrapper":true }, "TableRestoreStatusList":{ "type":"list", "member":{ "shape":"TableRestoreStatus", "locationName":"TableRestoreStatus" } }, "TableRestoreStatusMessage":{ "type":"structure", "members":{ "TableRestoreStatusDetails":{ "shape":"TableRestoreStatusList", "documentation":"

A list of status details for one or more table restore requests.

" }, "Marker":{ "shape":"String", "documentation":"

A pagination token that can be used in a subsequent DescribeTableRestoreStatus request.

" } }, "documentation":"

" }, "TableRestoreStatusType":{ "type":"string", "enum":[ "PENDING", "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED" ] }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The key, or name, for the resource tag.

" }, "Value":{ "shape":"String", "documentation":"

The value for the resource tag.

" } }, "documentation":"

A tag consisting of a name/value pair for a resource.

" }, "TagKeyList":{ "type":"list", "member":{ "shape":"String", "locationName":"TagKey" } }, "TagLimitExceededFault":{ "type":"structure", "members":{ }, "documentation":"

The request exceeds the limit of 10 tags for the resource.

", "error":{ "code":"TagLimitExceededFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"Tag" } }, "TagValueList":{ "type":"list", "member":{ "shape":"String", "locationName":"TagValue" } }, "TaggedResource":{ "type":"structure", "members":{ "Tag":{ "shape":"Tag", "documentation":"

The tag for the resource.

" }, "ResourceName":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) with which the tag is associated. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.

" }, "ResourceType":{ "shape":"String", "documentation":"

The type of resource with which the tag is associated. Valid resource types are:

  • Cluster

  • CIDR/IP

  • EC2 security group

  • Snapshot

  • Cluster security group

  • Subnet group

  • HSM connection

  • HSM certificate

  • Parameter group

For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.

" } }, "documentation":"

A tag and its associated resource.

" }, "TaggedResourceList":{ "type":"list", "member":{ "shape":"TaggedResource", "locationName":"TaggedResource" } }, "TaggedResourceListMessage":{ "type":"structure", "members":{ "TaggedResources":{ "shape":"TaggedResourceList", "documentation":"

A list of tags with their associated resources.

" }, "Marker":{ "shape":"String", "documentation":"

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

" } }, "documentation":"

" }, "UnauthorizedOperation":{ "type":"structure", "members":{ }, "documentation":"

Your account is not authorized to perform the requested operation.

", "error":{ "code":"UnauthorizedOperation", "httpStatusCode":400, "senderFault":true }, "exception":true }, "UnknownSnapshotCopyRegionFault":{ "type":"structure", "members":{ }, "documentation":"

The specified region is incorrect or does not exist.

", "error":{ "code":"UnknownSnapshotCopyRegionFault", "httpStatusCode":404, "senderFault":true }, "exception":true }, "UnsupportedOperationFault":{ "type":"structure", "members":{ }, "documentation":"

The requested operation isn't supported.

", "error":{ "code":"UnsupportedOperation", "httpStatusCode":400, "senderFault":true }, "exception":true }, "UnsupportedOptionFault":{ "type":"structure", "members":{ }, "documentation":"

A request option was specified that is not supported.

", "error":{ "code":"UnsupportedOptionFault", "httpStatusCode":400, "senderFault":true }, "exception":true }, "VpcSecurityGroupIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcSecurityGroupId" } }, "VpcSecurityGroupMembership":{ "type":"structure", "members":{ "VpcSecurityGroupId":{ "shape":"String", "documentation":"

The identifier of the VPC security group.

" }, "Status":{ "shape":"String", "documentation":"

The status of the VPC security group.

" } }, "documentation":"

Describes the members of a VPC security group.

" }, "VpcSecurityGroupMembershipList":{ "type":"list", "member":{ "shape":"VpcSecurityGroupMembership", "locationName":"VpcSecurityGroup" } } }, "documentation":"Amazon Redshift

Overview

This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces.

Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers.

If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the Amazon Redshift Getting Started Guide.

If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design, build, query, and maintain the databases that make up your data warehouse.

" } botocore-1.5.7/botocore/data/codedeploy/0000777454262600001440000000000013042511307021262 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/codedeploy/2014-10-06/0000777454262600001440000000000013042511307022311 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/codedeploy/2014-10-06/waiters-2.json0000666454262600001440000000122613042511306025021 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DeploymentSuccessful": { "delay": 15, "operation": "GetDeployment", "maxAttempts": 120, "acceptors": [ { "expected": "Succeeded", "matcher": "path", "state": "success", "argument": "deploymentInfo.status" }, { "expected": "Failed", "matcher": "path", "state": "failure", "argument": "deploymentInfo.status" }, { "expected": "Stopped", "matcher": "path", "state": "failure", "argument": "deploymentInfo.status" } ] } } } botocore-1.5.7/botocore/data/codedeploy/2014-10-06/service-2.json0000777454262600001440000041740413042511307025020 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2014-10-06", "endpointPrefix":"codedeploy", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"CodeDeploy", "serviceFullName":"AWS CodeDeploy", "signatureVersion":"v4", "targetPrefix":"CodeDeploy_20141006", "timestampFormat":"unixTimestamp", "uid":"codedeploy-2014-10-06" }, "operations":{ "AddTagsToOnPremisesInstances":{ "name":"AddTagsToOnPremisesInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsToOnPremisesInstancesInput"}, "errors":[ {"shape":"InstanceNameRequiredException"}, {"shape":"TagRequiredException"}, {"shape":"InvalidTagException"}, {"shape":"TagLimitExceededException"}, {"shape":"InstanceLimitExceededException"}, {"shape":"InstanceNotRegisteredException"} ], "documentation":"

Adds tags to on-premises instances.

" }, "BatchGetApplicationRevisions":{ "name":"BatchGetApplicationRevisions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetApplicationRevisionsInput"}, "output":{"shape":"BatchGetApplicationRevisionsOutput"}, "errors":[ {"shape":"ApplicationDoesNotExistException"}, {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"}, {"shape":"RevisionRequiredException"}, {"shape":"InvalidRevisionException"}, {"shape":"BatchLimitExceededException"} ], "documentation":"

Gets information about one or more application revisions.

" }, "BatchGetApplications":{ "name":"BatchGetApplications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetApplicationsInput"}, "output":{"shape":"BatchGetApplicationsOutput"}, "errors":[ {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"}, {"shape":"ApplicationDoesNotExistException"}, {"shape":"BatchLimitExceededException"} ], "documentation":"

Gets information about one or more applications.

" }, "BatchGetDeploymentGroups":{ "name":"BatchGetDeploymentGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetDeploymentGroupsInput"}, "output":{"shape":"BatchGetDeploymentGroupsOutput"}, "errors":[ {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"}, {"shape":"ApplicationDoesNotExistException"}, {"shape":"DeploymentGroupNameRequiredException"}, {"shape":"InvalidDeploymentGroupNameException"}, {"shape":"BatchLimitExceededException"} ], "documentation":"

Gets information about one or more deployment groups.

" }, "BatchGetDeploymentInstances":{ "name":"BatchGetDeploymentInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetDeploymentInstancesInput"}, "output":{"shape":"BatchGetDeploymentInstancesOutput"}, "errors":[ {"shape":"DeploymentIdRequiredException"}, {"shape":"DeploymentDoesNotExistException"}, {"shape":"InstanceIdRequiredException"}, {"shape":"InvalidDeploymentIdException"}, {"shape":"InvalidInstanceNameException"}, {"shape":"BatchLimitExceededException"} ], "documentation":"

Gets information about one or more instance that are part of a deployment group.

" }, "BatchGetDeployments":{ "name":"BatchGetDeployments", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetDeploymentsInput"}, "output":{"shape":"BatchGetDeploymentsOutput"}, "errors":[ {"shape":"DeploymentIdRequiredException"}, {"shape":"InvalidDeploymentIdException"}, {"shape":"BatchLimitExceededException"} ], "documentation":"

Gets information about one or more deployments.

" }, "BatchGetOnPremisesInstances":{ "name":"BatchGetOnPremisesInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetOnPremisesInstancesInput"}, "output":{"shape":"BatchGetOnPremisesInstancesOutput"}, "errors":[ {"shape":"InstanceNameRequiredException"}, {"shape":"InvalidInstanceNameException"}, {"shape":"BatchLimitExceededException"} ], "documentation":"

Gets information about one or more on-premises instances.

" }, "ContinueDeployment":{ "name":"ContinueDeployment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ContinueDeploymentInput"}, "errors":[ {"shape":"DeploymentIdRequiredException"}, {"shape":"DeploymentDoesNotExistException"}, {"shape":"DeploymentAlreadyCompletedException"}, {"shape":"InvalidDeploymentIdException"}, {"shape":"DeploymentIsNotInReadyStateException"}, {"shape":"UnsupportedActionForDeploymentTypeException"} ], "documentation":"

Starts the process of rerouting traffic from instances in the original environment to instances in thereplacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)

" }, "CreateApplication":{ "name":"CreateApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateApplicationInput"}, "output":{"shape":"CreateApplicationOutput"}, "errors":[ {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"}, {"shape":"ApplicationAlreadyExistsException"}, {"shape":"ApplicationLimitExceededException"} ], "documentation":"

Creates an application.

" }, "CreateDeployment":{ "name":"CreateDeployment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDeploymentInput"}, "output":{"shape":"CreateDeploymentOutput"}, "errors":[ {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"}, {"shape":"ApplicationDoesNotExistException"}, {"shape":"DeploymentGroupNameRequiredException"}, {"shape":"InvalidDeploymentGroupNameException"}, {"shape":"DeploymentGroupDoesNotExistException"}, {"shape":"RevisionRequiredException"}, {"shape":"RevisionDoesNotExistException"}, {"shape":"InvalidRevisionException"}, {"shape":"InvalidDeploymentConfigNameException"}, {"shape":"DeploymentConfigDoesNotExistException"}, {"shape":"DescriptionTooLongException"}, {"shape":"DeploymentLimitExceededException"}, {"shape":"InvalidTargetInstancesException"}, {"shape":"InvalidAutoRollbackConfigException"}, {"shape":"InvalidLoadBalancerInfoException"} ], "documentation":"

Deploys an application revision through the specified deployment group.

" }, "CreateDeploymentConfig":{ "name":"CreateDeploymentConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDeploymentConfigInput"}, "output":{"shape":"CreateDeploymentConfigOutput"}, "errors":[ {"shape":"InvalidDeploymentConfigNameException"}, {"shape":"DeploymentConfigNameRequiredException"}, {"shape":"DeploymentConfigAlreadyExistsException"}, {"shape":"InvalidMinimumHealthyHostValueException"}, {"shape":"DeploymentConfigLimitExceededException"} ], "documentation":"

Creates a deployment configuration.

" }, "CreateDeploymentGroup":{ "name":"CreateDeploymentGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDeploymentGroupInput"}, "output":{"shape":"CreateDeploymentGroupOutput"}, "errors":[ {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"}, {"shape":"ApplicationDoesNotExistException"}, {"shape":"DeploymentGroupNameRequiredException"}, {"shape":"InvalidDeploymentGroupNameException"}, {"shape":"DeploymentGroupAlreadyExistsException"}, {"shape":"InvalidEC2TagException"}, {"shape":"InvalidTagException"}, {"shape":"InvalidAutoScalingGroupException"}, {"shape":"InvalidDeploymentConfigNameException"}, {"shape":"DeploymentConfigDoesNotExistException"}, {"shape":"RoleRequiredException"}, {"shape":"InvalidRoleException"}, {"shape":"DeploymentGroupLimitExceededException"}, {"shape":"LifecycleHookLimitExceededException"}, {"shape":"InvalidTriggerConfigException"}, {"shape":"TriggerTargetsLimitExceededException"}, {"shape":"InvalidAlarmConfigException"}, {"shape":"AlarmsLimitExceededException"}, {"shape":"InvalidAutoRollbackConfigException"}, {"shape":"InvalidLoadBalancerInfoException"}, {"shape":"InvalidDeploymentStyleException"}, {"shape":"InvalidBlueGreenDeploymentConfigurationException"} ], "documentation":"

Creates a deployment group to which application revisions will be deployed.

" }, "DeleteApplication":{ "name":"DeleteApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteApplicationInput"}, "errors":[ {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"} ], "documentation":"

Deletes an application.

" }, "DeleteDeploymentConfig":{ "name":"DeleteDeploymentConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDeploymentConfigInput"}, "errors":[ {"shape":"InvalidDeploymentConfigNameException"}, {"shape":"DeploymentConfigNameRequiredException"}, {"shape":"DeploymentConfigInUseException"}, {"shape":"InvalidOperationException"} ], "documentation":"

Deletes a deployment configuration.

A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.

" }, "DeleteDeploymentGroup":{ "name":"DeleteDeploymentGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDeploymentGroupInput"}, "output":{"shape":"DeleteDeploymentGroupOutput"}, "errors":[ {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"}, {"shape":"DeploymentGroupNameRequiredException"}, {"shape":"InvalidDeploymentGroupNameException"}, {"shape":"InvalidRoleException"} ], "documentation":"

Deletes a deployment group.

" }, "DeregisterOnPremisesInstance":{ "name":"DeregisterOnPremisesInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterOnPremisesInstanceInput"}, "errors":[ {"shape":"InstanceNameRequiredException"}, {"shape":"InvalidInstanceNameException"} ], "documentation":"

Deregisters an on-premises instance.

" }, "GetApplication":{ "name":"GetApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetApplicationInput"}, "output":{"shape":"GetApplicationOutput"}, "errors":[ {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"}, {"shape":"ApplicationDoesNotExistException"} ], "documentation":"

Gets information about an application.

" }, "GetApplicationRevision":{ "name":"GetApplicationRevision", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetApplicationRevisionInput"}, "output":{"shape":"GetApplicationRevisionOutput"}, "errors":[ {"shape":"ApplicationDoesNotExistException"}, {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"}, {"shape":"RevisionDoesNotExistException"}, {"shape":"RevisionRequiredException"}, {"shape":"InvalidRevisionException"} ], "documentation":"

Gets information about an application revision.

" }, "GetDeployment":{ "name":"GetDeployment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDeploymentInput"}, "output":{"shape":"GetDeploymentOutput"}, "errors":[ {"shape":"DeploymentIdRequiredException"}, {"shape":"InvalidDeploymentIdException"}, {"shape":"DeploymentDoesNotExistException"} ], "documentation":"

Gets information about a deployment.

" }, "GetDeploymentConfig":{ "name":"GetDeploymentConfig", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDeploymentConfigInput"}, "output":{"shape":"GetDeploymentConfigOutput"}, "errors":[ {"shape":"InvalidDeploymentConfigNameException"}, {"shape":"DeploymentConfigNameRequiredException"}, {"shape":"DeploymentConfigDoesNotExistException"} ], "documentation":"

Gets information about a deployment configuration.

" }, "GetDeploymentGroup":{ "name":"GetDeploymentGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDeploymentGroupInput"}, "output":{"shape":"GetDeploymentGroupOutput"}, "errors":[ {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"}, {"shape":"ApplicationDoesNotExistException"}, {"shape":"DeploymentGroupNameRequiredException"}, {"shape":"InvalidDeploymentGroupNameException"}, {"shape":"DeploymentGroupDoesNotExistException"} ], "documentation":"

Gets information about a deployment group.

" }, "GetDeploymentInstance":{ "name":"GetDeploymentInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDeploymentInstanceInput"}, "output":{"shape":"GetDeploymentInstanceOutput"}, "errors":[ {"shape":"DeploymentIdRequiredException"}, {"shape":"DeploymentDoesNotExistException"}, {"shape":"InstanceIdRequiredException"}, {"shape":"InvalidDeploymentIdException"}, {"shape":"InstanceDoesNotExistException"}, {"shape":"InvalidInstanceNameException"} ], "documentation":"

Gets information about an instance as part of a deployment.

" }, "GetOnPremisesInstance":{ "name":"GetOnPremisesInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetOnPremisesInstanceInput"}, "output":{"shape":"GetOnPremisesInstanceOutput"}, "errors":[ {"shape":"InstanceNameRequiredException"}, {"shape":"InstanceNotRegisteredException"}, {"shape":"InvalidInstanceNameException"} ], "documentation":"

Gets information about an on-premises instance.

" }, "ListApplicationRevisions":{ "name":"ListApplicationRevisions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListApplicationRevisionsInput"}, "output":{"shape":"ListApplicationRevisionsOutput"}, "errors":[ {"shape":"ApplicationDoesNotExistException"}, {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"}, {"shape":"InvalidSortByException"}, {"shape":"InvalidSortOrderException"}, {"shape":"InvalidBucketNameFilterException"}, {"shape":"InvalidKeyPrefixFilterException"}, {"shape":"BucketNameFilterRequiredException"}, {"shape":"InvalidDeployedStateFilterException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Lists information about revisions for an application.

" }, "ListApplications":{ "name":"ListApplications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListApplicationsInput"}, "output":{"shape":"ListApplicationsOutput"}, "errors":[ {"shape":"InvalidNextTokenException"} ], "documentation":"

Lists the applications registered with the applicable IAM user or AWS account.

" }, "ListDeploymentConfigs":{ "name":"ListDeploymentConfigs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDeploymentConfigsInput"}, "output":{"shape":"ListDeploymentConfigsOutput"}, "errors":[ {"shape":"InvalidNextTokenException"} ], "documentation":"

Lists the deployment configurations with the applicable IAM user or AWS account.

" }, "ListDeploymentGroups":{ "name":"ListDeploymentGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDeploymentGroupsInput"}, "output":{"shape":"ListDeploymentGroupsOutput"}, "errors":[ {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"}, {"shape":"ApplicationDoesNotExistException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Lists the deployment groups for an application registered with the applicable IAM user or AWS account.

" }, "ListDeploymentInstances":{ "name":"ListDeploymentInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDeploymentInstancesInput"}, "output":{"shape":"ListDeploymentInstancesOutput"}, "errors":[ {"shape":"DeploymentIdRequiredException"}, {"shape":"DeploymentDoesNotExistException"}, {"shape":"DeploymentNotStartedException"}, {"shape":"InvalidNextTokenException"}, {"shape":"InvalidDeploymentIdException"}, {"shape":"InvalidInstanceStatusException"}, {"shape":"InvalidInstanceTypeException"} ], "documentation":"

Lists the instance for a deployment associated with the applicable IAM user or AWS account.

" }, "ListDeployments":{ "name":"ListDeployments", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDeploymentsInput"}, "output":{"shape":"ListDeploymentsOutput"}, "errors":[ {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"}, {"shape":"ApplicationDoesNotExistException"}, {"shape":"InvalidDeploymentGroupNameException"}, {"shape":"DeploymentGroupDoesNotExistException"}, {"shape":"DeploymentGroupNameRequiredException"}, {"shape":"InvalidTimeRangeException"}, {"shape":"InvalidDeploymentStatusException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.

" }, "ListOnPremisesInstances":{ "name":"ListOnPremisesInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListOnPremisesInstancesInput"}, "output":{"shape":"ListOnPremisesInstancesOutput"}, "errors":[ {"shape":"InvalidRegistrationStatusException"}, {"shape":"InvalidTagFilterException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Gets a list of names for one or more on-premises instances.

Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.

" }, "RegisterApplicationRevision":{ "name":"RegisterApplicationRevision", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterApplicationRevisionInput"}, "errors":[ {"shape":"ApplicationDoesNotExistException"}, {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"}, {"shape":"DescriptionTooLongException"}, {"shape":"RevisionRequiredException"}, {"shape":"InvalidRevisionException"} ], "documentation":"

Registers with AWS CodeDeploy a revision for the specified application.

" }, "RegisterOnPremisesInstance":{ "name":"RegisterOnPremisesInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterOnPremisesInstanceInput"}, "errors":[ {"shape":"InstanceNameAlreadyRegisteredException"}, {"shape":"IamArnRequiredException"}, {"shape":"IamSessionArnAlreadyRegisteredException"}, {"shape":"IamUserArnAlreadyRegisteredException"}, {"shape":"InstanceNameRequiredException"}, {"shape":"IamUserArnRequiredException"}, {"shape":"InvalidInstanceNameException"}, {"shape":"InvalidIamSessionArnException"}, {"shape":"InvalidIamUserArnException"}, {"shape":"MultipleIamArnsProvidedException"} ], "documentation":"

Registers an on-premises instance.

Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.

" }, "RemoveTagsFromOnPremisesInstances":{ "name":"RemoveTagsFromOnPremisesInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTagsFromOnPremisesInstancesInput"}, "errors":[ {"shape":"InstanceNameRequiredException"}, {"shape":"TagRequiredException"}, {"shape":"InvalidTagException"}, {"shape":"TagLimitExceededException"}, {"shape":"InstanceLimitExceededException"}, {"shape":"InstanceNotRegisteredException"} ], "documentation":"

Removes one or more tags from one or more on-premises instances.

" }, "SkipWaitTimeForInstanceTermination":{ "name":"SkipWaitTimeForInstanceTermination", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SkipWaitTimeForInstanceTerminationInput"}, "errors":[ {"shape":"DeploymentIdRequiredException"}, {"shape":"DeploymentDoesNotExistException"}, {"shape":"DeploymentAlreadyCompletedException"}, {"shape":"InvalidDeploymentIdException"}, {"shape":"DeploymentNotStartedException"}, {"shape":"UnsupportedActionForDeploymentTypeException"} ], "documentation":"

In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is completed.

" }, "StopDeployment":{ "name":"StopDeployment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopDeploymentInput"}, "output":{"shape":"StopDeploymentOutput"}, "errors":[ {"shape":"DeploymentIdRequiredException"}, {"shape":"DeploymentDoesNotExistException"}, {"shape":"DeploymentAlreadyCompletedException"}, {"shape":"InvalidDeploymentIdException"} ], "documentation":"

Attempts to stop an ongoing deployment.

" }, "UpdateApplication":{ "name":"UpdateApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateApplicationInput"}, "errors":[ {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"}, {"shape":"ApplicationAlreadyExistsException"}, {"shape":"ApplicationDoesNotExistException"} ], "documentation":"

Changes the name of an application.

" }, "UpdateDeploymentGroup":{ "name":"UpdateDeploymentGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDeploymentGroupInput"}, "output":{"shape":"UpdateDeploymentGroupOutput"}, "errors":[ {"shape":"ApplicationNameRequiredException"}, {"shape":"InvalidApplicationNameException"}, {"shape":"ApplicationDoesNotExistException"}, {"shape":"InvalidDeploymentGroupNameException"}, {"shape":"DeploymentGroupAlreadyExistsException"}, {"shape":"DeploymentGroupNameRequiredException"}, {"shape":"DeploymentGroupDoesNotExistException"}, {"shape":"InvalidEC2TagException"}, {"shape":"InvalidTagException"}, {"shape":"InvalidAutoScalingGroupException"}, {"shape":"InvalidDeploymentConfigNameException"}, {"shape":"DeploymentConfigDoesNotExistException"}, {"shape":"InvalidRoleException"}, {"shape":"LifecycleHookLimitExceededException"}, {"shape":"InvalidTriggerConfigException"}, {"shape":"TriggerTargetsLimitExceededException"}, {"shape":"InvalidAlarmConfigException"}, {"shape":"AlarmsLimitExceededException"}, {"shape":"InvalidAutoRollbackConfigException"}, {"shape":"InvalidLoadBalancerInfoException"}, {"shape":"InvalidDeploymentStyleException"}, {"shape":"InvalidBlueGreenDeploymentConfigurationException"} ], "documentation":"

Changes information about a deployment group.

" } }, "shapes":{ "AddTagsToOnPremisesInstancesInput":{ "type":"structure", "required":[ "tags", "instanceNames" ], "members":{ "tags":{ "shape":"TagList", "documentation":"

The tag key-value pairs to add to the on-premises instances.

Keys and values are both required. Keys cannot be null or empty strings. Value-only tags are not allowed.

" }, "instanceNames":{ "shape":"InstanceNameList", "documentation":"

The names of the on-premises instances to which to add tags.

" } }, "documentation":"

Represents the input of, and adds tags to, an on-premises instance operation.

" }, "AdditionalDeploymentStatusInfo":{"type":"string"}, "Alarm":{ "type":"structure", "members":{ "name":{ "shape":"AlarmName", "documentation":"

The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.

" } }, "documentation":"

Information about an alarm.

" }, "AlarmConfiguration":{ "type":"structure", "members":{ "enabled":{ "shape":"Boolean", "documentation":"

Indicates whether the alarm configuration is enabled.

" }, "ignorePollAlarmFailure":{ "shape":"Boolean", "documentation":"

Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.

  • true: The deployment will proceed even if alarm status information can't be retrieved from Amazon CloudWatch.

  • false: The deployment will stop if alarm status information can't be retrieved from Amazon CloudWatch.

" }, "alarms":{ "shape":"AlarmList", "documentation":"

A list of alarms configured for the deployment group. A maximum of 10 alarms can be added to a deployment group.

" } }, "documentation":"

Information about alarms associated with the deployment group.

" }, "AlarmList":{ "type":"list", "member":{"shape":"Alarm"} }, "AlarmName":{"type":"string"}, "AlarmsLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

The maximum number of alarms for a deployment group (10) was exceeded.

", "exception":true }, "ApplicationAlreadyExistsException":{ "type":"structure", "members":{ }, "documentation":"

An application with the specified name already exists with the applicable IAM user or AWS account.

", "exception":true }, "ApplicationDoesNotExistException":{ "type":"structure", "members":{ }, "documentation":"

The application does not exist with the applicable IAM user or AWS account.

", "exception":true }, "ApplicationId":{"type":"string"}, "ApplicationInfo":{ "type":"structure", "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

The application ID.

" }, "applicationName":{ "shape":"ApplicationName", "documentation":"

The application name.

" }, "createTime":{ "shape":"Timestamp", "documentation":"

The time at which the application was created.

" }, "linkedToGitHub":{ "shape":"Boolean", "documentation":"

True if the user has authenticated with GitHub for the specified application; otherwise, false.

" } }, "documentation":"

Information about an application.

" }, "ApplicationLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

More applications were attempted to be created than are allowed.

", "exception":true }, "ApplicationName":{ "type":"string", "max":100, "min":1 }, "ApplicationNameRequiredException":{ "type":"structure", "members":{ }, "documentation":"

The minimum number of required application names was not specified.

", "exception":true }, "ApplicationRevisionSortBy":{ "type":"string", "enum":[ "registerTime", "firstUsedTime", "lastUsedTime" ] }, "ApplicationsInfoList":{ "type":"list", "member":{"shape":"ApplicationInfo"} }, "ApplicationsList":{ "type":"list", "member":{"shape":"ApplicationName"} }, "AutoRollbackConfiguration":{ "type":"structure", "members":{ "enabled":{ "shape":"Boolean", "documentation":"

Indicates whether a defined automatic rollback configuration is currently enabled.

" }, "events":{ "shape":"AutoRollbackEventsList", "documentation":"

The event type or types that trigger a rollback.

" } }, "documentation":"

Information about a configuration for automatically rolling back to a previous version of an application revision when a deployment doesn't complete successfully.

" }, "AutoRollbackEvent":{ "type":"string", "enum":[ "DEPLOYMENT_FAILURE", "DEPLOYMENT_STOP_ON_ALARM", "DEPLOYMENT_STOP_ON_REQUEST" ] }, "AutoRollbackEventsList":{ "type":"list", "member":{"shape":"AutoRollbackEvent"} }, "AutoScalingGroup":{ "type":"structure", "members":{ "name":{ "shape":"AutoScalingGroupName", "documentation":"

The Auto Scaling group name.

" }, "hook":{ "shape":"AutoScalingGroupHook", "documentation":"

An Auto Scaling lifecycle event hook name.

" } }, "documentation":"

Information about an Auto Scaling group.

" }, "AutoScalingGroupHook":{"type":"string"}, "AutoScalingGroupList":{ "type":"list", "member":{"shape":"AutoScalingGroup"} }, "AutoScalingGroupName":{"type":"string"}, "AutoScalingGroupNameList":{ "type":"list", "member":{"shape":"AutoScalingGroupName"} }, "BatchGetApplicationRevisionsInput":{ "type":"structure", "required":[ "applicationName", "revisions" ], "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The name of an AWS CodeDeploy application about which to get revision information.

" }, "revisions":{ "shape":"RevisionLocationList", "documentation":"

Information to get about the application revisions, including type and location.

" } }, "documentation":"

Represents the input of a batch get application revisions operation.

" }, "BatchGetApplicationRevisionsOutput":{ "type":"structure", "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application that corresponds to the revisions.

" }, "errorMessage":{ "shape":"ErrorMessage", "documentation":"

Information about errors that may have occurred during the API call.

" }, "revisions":{ "shape":"RevisionInfoList", "documentation":"

Additional information about the revisions, including the type and location.

" } }, "documentation":"

Represents the output of a batch get application revisions operation.

" }, "BatchGetApplicationsInput":{ "type":"structure", "members":{ "applicationNames":{ "shape":"ApplicationsList", "documentation":"

A list of application names separated by spaces.

" } }, "documentation":"

Represents the input of a batch get applications operation.

" }, "BatchGetApplicationsOutput":{ "type":"structure", "members":{ "applicationsInfo":{ "shape":"ApplicationsInfoList", "documentation":"

Information about the applications.

" } }, "documentation":"

Represents the output of a batch get applications operation.

" }, "BatchGetDeploymentGroupsInput":{ "type":"structure", "required":[ "applicationName", "deploymentGroupNames" ], "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

" }, "deploymentGroupNames":{ "shape":"DeploymentGroupsList", "documentation":"

The deployment groups' names.

" } }, "documentation":"

Represents the input of a batch get deployment groups operation.

" }, "BatchGetDeploymentGroupsOutput":{ "type":"structure", "members":{ "deploymentGroupsInfo":{ "shape":"DeploymentGroupInfoList", "documentation":"

Information about the deployment groups.

" }, "errorMessage":{ "shape":"ErrorMessage", "documentation":"

Information about errors that may have occurred during the API call.

" } }, "documentation":"

Represents the output of a batch get deployment groups operation.

" }, "BatchGetDeploymentInstancesInput":{ "type":"structure", "required":[ "deploymentId", "instanceIds" ], "members":{ "deploymentId":{ "shape":"DeploymentId", "documentation":"

The unique ID of a deployment.

" }, "instanceIds":{ "shape":"InstancesList", "documentation":"

The unique IDs of instances in the deployment group.

" } }, "documentation":"

Represents the input of a batch get deployment instances operation.

" }, "BatchGetDeploymentInstancesOutput":{ "type":"structure", "members":{ "instancesSummary":{ "shape":"InstanceSummaryList", "documentation":"

Information about the instance.

" }, "errorMessage":{ "shape":"ErrorMessage", "documentation":"

Information about errors that may have occurred during the API call.

" } }, "documentation":"

Represents the output of a batch get deployment instance operation.

" }, "BatchGetDeploymentsInput":{ "type":"structure", "members":{ "deploymentIds":{ "shape":"DeploymentsList", "documentation":"

A list of deployment IDs, separated by spaces.

" } }, "documentation":"

Represents the input of a batch get deployments operation.

" }, "BatchGetDeploymentsOutput":{ "type":"structure", "members":{ "deploymentsInfo":{ "shape":"DeploymentsInfoList", "documentation":"

Information about the deployments.

" } }, "documentation":"

Represents the output of a batch get deployments operation.

" }, "BatchGetOnPremisesInstancesInput":{ "type":"structure", "members":{ "instanceNames":{ "shape":"InstanceNameList", "documentation":"

The names of the on-premises instances about which to get information.

" } }, "documentation":"

Represents the input of a batch get on-premises instances operation.

" }, "BatchGetOnPremisesInstancesOutput":{ "type":"structure", "members":{ "instanceInfos":{ "shape":"InstanceInfoList", "documentation":"

Information about the on-premises instances.

" } }, "documentation":"

Represents the output of a batch get on-premises instances operation.

" }, "BatchLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

The maximum number of names or IDs allowed for this request (100) was exceeded.

", "exception":true }, "BlueGreenDeploymentConfiguration":{ "type":"structure", "members":{ "terminateBlueInstancesOnDeploymentSuccess":{ "shape":"BlueInstanceTerminationOption", "documentation":"

Information about whether to terminate instances in the original fleet during a blue/green deployment.

" }, "deploymentReadyOption":{ "shape":"DeploymentReadyOption", "documentation":"

Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.

" }, "greenFleetProvisioningOption":{ "shape":"GreenFleetProvisioningOption", "documentation":"

Information about how instances are provisioned for a replacement environment in a blue/green deployment.

" } }, "documentation":"

Information about blue/green deployment options for a deployment group.

" }, "BlueInstanceTerminationOption":{ "type":"structure", "members":{ "action":{ "shape":"InstanceAction", "documentation":"

The action to take on instances in the original environment after a successful blue/green deployment.

  • TERMINATE: Instances are terminated after a specified wait time.

  • KEEP_ALIVE: Instances are left running after they are deregistered from the load balancer and removed from the deployment group.

" }, "terminationWaitTimeInMinutes":{ "shape":"Duration", "documentation":"

The number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.

" } }, "documentation":"

Information about whether instances in the original environment are terminated when a blue/green deployment is successful.

" }, "Boolean":{"type":"boolean"}, "BucketNameFilterRequiredException":{ "type":"structure", "members":{ }, "documentation":"

A bucket name is required, but was not provided.

", "exception":true }, "BundleType":{ "type":"string", "enum":[ "tar", "tgz", "zip" ] }, "CommitId":{"type":"string"}, "ContinueDeploymentInput":{ "type":"structure", "members":{ "deploymentId":{ "shape":"DeploymentId", "documentation":"

The deployment ID of the blue/green deployment for which you want to start rerouting traffic to the replacement environment.

" } } }, "CreateApplicationInput":{ "type":"structure", "required":["applicationName"], "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application. This name must be unique with the applicable IAM user or AWS account.

" } }, "documentation":"

Represents the input of a create application operation.

" }, "CreateApplicationOutput":{ "type":"structure", "members":{ "applicationId":{ "shape":"ApplicationId", "documentation":"

A unique application ID.

" } }, "documentation":"

Represents the output of a create application operation.

" }, "CreateDeploymentConfigInput":{ "type":"structure", "required":["deploymentConfigName"], "members":{ "deploymentConfigName":{ "shape":"DeploymentConfigName", "documentation":"

The name of the deployment configuration to create.

" }, "minimumHealthyHosts":{ "shape":"MinimumHealthyHosts", "documentation":"

The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.

The type parameter takes either of the following values:

  • HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.

  • FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS CodeDeploy converts the percentage to the equivalent number of instance and rounds up fractional instances.

The value parameter takes an integer.

For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.

" } }, "documentation":"

Represents the input of a create deployment configuration operation.

" }, "CreateDeploymentConfigOutput":{ "type":"structure", "members":{ "deploymentConfigId":{ "shape":"DeploymentConfigId", "documentation":"

A unique deployment configuration ID.

" } }, "documentation":"

Represents the output of a create deployment configuration operation.

" }, "CreateDeploymentGroupInput":{ "type":"structure", "required":[ "applicationName", "deploymentGroupName", "serviceRoleArn" ], "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

" }, "deploymentGroupName":{ "shape":"DeploymentGroupName", "documentation":"

The name of a new deployment group for the specified application.

" }, "deploymentConfigName":{ "shape":"DeploymentConfigName", "documentation":"

If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.

CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or the deployment group.

For more information about the predefined deployment configurations in AWS CodeDeploy, see see Working with Deployment Groups in AWS CodeDeploy in the AWS CodeDeploy User Guide.

" }, "ec2TagFilters":{ "shape":"EC2TagFilterList", "documentation":"

The Amazon EC2 tags on which to filter.

" }, "onPremisesInstanceTagFilters":{ "shape":"TagFilterList", "documentation":"

The on-premises instance tags on which to filter.

" }, "autoScalingGroups":{ "shape":"AutoScalingGroupNameList", "documentation":"

A list of associated Auto Scaling groups.

" }, "serviceRoleArn":{ "shape":"Role", "documentation":"

A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

" }, "triggerConfigurations":{ "shape":"TriggerConfigList", "documentation":"

Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an AWS CodeDeploy Event in the AWS CodeDeploy User Guide.

" }, "alarmConfiguration":{ "shape":"AlarmConfiguration", "documentation":"

Information to add about Amazon CloudWatch alarms when the deployment group is created.

" }, "autoRollbackConfiguration":{ "shape":"AutoRollbackConfiguration", "documentation":"

Configuration information for an automatic rollback that is added when a deployment group is created.

" }, "deploymentStyle":{ "shape":"DeploymentStyle", "documentation":"

Information about the type of deployment, standard or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.

" }, "blueGreenDeploymentConfiguration":{ "shape":"BlueGreenDeploymentConfiguration", "documentation":"

Information about blue/green deployment options for a deployment group.

" }, "loadBalancerInfo":{ "shape":"LoadBalancerInfo", "documentation":"

Information about the load balancer used in a blue/green deployment.

" } }, "documentation":"

Represents the input of a create deployment group operation.

" }, "CreateDeploymentGroupOutput":{ "type":"structure", "members":{ "deploymentGroupId":{ "shape":"DeploymentGroupId", "documentation":"

A unique deployment group ID.

" } }, "documentation":"

Represents the output of a create deployment group operation.

" }, "CreateDeploymentInput":{ "type":"structure", "required":["applicationName"], "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

" }, "deploymentGroupName":{ "shape":"DeploymentGroupName", "documentation":"

The name of the deployment group.

" }, "revision":{ "shape":"RevisionLocation", "documentation":"

The type and location of the revision to deploy.

" }, "deploymentConfigName":{ "shape":"DeploymentConfigName", "documentation":"

The name of a deployment configuration associated with the applicable IAM user or AWS account.

If not specified, the value configured in the deployment group will be used as the default. If the deployment group does not have a deployment configuration associated with it, then CodeDeployDefault.OneAtATime will be used by default.

" }, "description":{ "shape":"Description", "documentation":"

A comment about the deployment.

" }, "ignoreApplicationStopFailures":{ "shape":"Boolean", "documentation":"

If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event.

If set to false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to fail to an instance, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.

" }, "targetInstances":{ "shape":"TargetInstances", "documentation":"

Information about the instances that will belong to the replacement environment in a blue/green deployment.

" }, "autoRollbackConfiguration":{ "shape":"AutoRollbackConfiguration", "documentation":"

Configuration information for an automatic rollback that is added when a deployment is created.

" }, "updateOutdatedInstancesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

" } }, "documentation":"

Represents the input of a create deployment operation.

" }, "CreateDeploymentOutput":{ "type":"structure", "members":{ "deploymentId":{ "shape":"DeploymentId", "documentation":"

A unique deployment ID.

" } }, "documentation":"

Represents the output of a create deployment operation.

" }, "DeleteApplicationInput":{ "type":"structure", "required":["applicationName"], "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

" } }, "documentation":"

Represents the input of a delete application operation.

" }, "DeleteDeploymentConfigInput":{ "type":"structure", "required":["deploymentConfigName"], "members":{ "deploymentConfigName":{ "shape":"DeploymentConfigName", "documentation":"

The name of a deployment configuration associated with the applicable IAM user or AWS account.

" } }, "documentation":"

Represents the input of a delete deployment configuration operation.

" }, "DeleteDeploymentGroupInput":{ "type":"structure", "required":[ "applicationName", "deploymentGroupName" ], "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

" }, "deploymentGroupName":{ "shape":"DeploymentGroupName", "documentation":"

The name of an existing deployment group for the specified application.

" } }, "documentation":"

Represents the input of a delete deployment group operation.

" }, "DeleteDeploymentGroupOutput":{ "type":"structure", "members":{ "hooksNotCleanedUp":{ "shape":"AutoScalingGroupList", "documentation":"

If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group. If the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.

" } }, "documentation":"

Represents the output of a delete deployment group operation.

" }, "DeploymentAlreadyCompletedException":{ "type":"structure", "members":{ }, "documentation":"

The deployment is already complete.

", "exception":true }, "DeploymentConfigAlreadyExistsException":{ "type":"structure", "members":{ }, "documentation":"

A deployment configuration with the specified name already exists with the applicable IAM user or AWS account.

", "exception":true }, "DeploymentConfigDoesNotExistException":{ "type":"structure", "members":{ }, "documentation":"

The deployment configuration does not exist with the applicable IAM user or AWS account.

", "exception":true }, "DeploymentConfigId":{"type":"string"}, "DeploymentConfigInUseException":{ "type":"structure", "members":{ }, "documentation":"

The deployment configuration is still in use.

", "exception":true }, "DeploymentConfigInfo":{ "type":"structure", "members":{ "deploymentConfigId":{ "shape":"DeploymentConfigId", "documentation":"

The deployment configuration ID.

" }, "deploymentConfigName":{ "shape":"DeploymentConfigName", "documentation":"

The deployment configuration name.

" }, "minimumHealthyHosts":{ "shape":"MinimumHealthyHosts", "documentation":"

Information about the number or percentage of minimum healthy instance.

" }, "createTime":{ "shape":"Timestamp", "documentation":"

The time at which the deployment configuration was created.

" } }, "documentation":"

Information about a deployment configuration.

" }, "DeploymentConfigLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

The deployment configurations limit was exceeded.

", "exception":true }, "DeploymentConfigName":{ "type":"string", "max":100, "min":1 }, "DeploymentConfigNameRequiredException":{ "type":"structure", "members":{ }, "documentation":"

The deployment configuration name was not specified.

", "exception":true }, "DeploymentConfigsList":{ "type":"list", "member":{"shape":"DeploymentConfigName"} }, "DeploymentCreator":{ "type":"string", "enum":[ "user", "autoscaling", "codeDeployRollback" ] }, "DeploymentDoesNotExistException":{ "type":"structure", "members":{ }, "documentation":"

The deployment does not exist with the applicable IAM user or AWS account.

", "exception":true }, "DeploymentGroupAlreadyExistsException":{ "type":"structure", "members":{ }, "documentation":"

A deployment group with the specified name already exists with the applicable IAM user or AWS account.

", "exception":true }, "DeploymentGroupDoesNotExistException":{ "type":"structure", "members":{ }, "documentation":"

The named deployment group does not exist with the applicable IAM user or AWS account.

", "exception":true }, "DeploymentGroupId":{"type":"string"}, "DeploymentGroupInfo":{ "type":"structure", "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The application name.

" }, "deploymentGroupId":{ "shape":"DeploymentGroupId", "documentation":"

The deployment group ID.

" }, "deploymentGroupName":{ "shape":"DeploymentGroupName", "documentation":"

The deployment group name.

" }, "deploymentConfigName":{ "shape":"DeploymentConfigName", "documentation":"

The deployment configuration name.

" }, "ec2TagFilters":{ "shape":"EC2TagFilterList", "documentation":"

The Amazon EC2 tags on which to filter.

" }, "onPremisesInstanceTagFilters":{ "shape":"TagFilterList", "documentation":"

The on-premises instance tags on which to filter.

" }, "autoScalingGroups":{ "shape":"AutoScalingGroupList", "documentation":"

A list of associated Auto Scaling groups.

" }, "serviceRoleArn":{ "shape":"Role", "documentation":"

A service role ARN.

" }, "targetRevision":{ "shape":"RevisionLocation", "documentation":"

Information about the deployment group's target revision, including type and location.

" }, "triggerConfigurations":{ "shape":"TriggerConfigList", "documentation":"

Information about triggers associated with the deployment group.

" }, "alarmConfiguration":{ "shape":"AlarmConfiguration", "documentation":"

A list of alarms associated with the deployment group.

" }, "autoRollbackConfiguration":{ "shape":"AutoRollbackConfiguration", "documentation":"

Information about the automatic rollback configuration associated with the deployment group.

" }, "deploymentStyle":{ "shape":"DeploymentStyle", "documentation":"

Information about the type of deployment, either standard or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

" }, "blueGreenDeploymentConfiguration":{ "shape":"BlueGreenDeploymentConfiguration", "documentation":"

Information about blue/green deployment options for a deployment group.

" }, "loadBalancerInfo":{ "shape":"LoadBalancerInfo", "documentation":"

Information about the load balancer to use in a blue/green deployment.

" } }, "documentation":"

Information about a deployment group.

" }, "DeploymentGroupInfoList":{ "type":"list", "member":{"shape":"DeploymentGroupInfo"} }, "DeploymentGroupLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

The deployment groups limit was exceeded.

", "exception":true }, "DeploymentGroupName":{ "type":"string", "max":100, "min":1 }, "DeploymentGroupNameRequiredException":{ "type":"structure", "members":{ }, "documentation":"

The deployment group name was not specified.

", "exception":true }, "DeploymentGroupsList":{ "type":"list", "member":{"shape":"DeploymentGroupName"} }, "DeploymentId":{"type":"string"}, "DeploymentIdRequiredException":{ "type":"structure", "members":{ }, "documentation":"

At least one deployment ID must be specified.

", "exception":true }, "DeploymentInfo":{ "type":"structure", "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The application name.

" }, "deploymentGroupName":{ "shape":"DeploymentGroupName", "documentation":"

The deployment group name.

" }, "deploymentConfigName":{ "shape":"DeploymentConfigName", "documentation":"

The deployment configuration name.

" }, "deploymentId":{ "shape":"DeploymentId", "documentation":"

The deployment ID.

" }, "revision":{ "shape":"RevisionLocation", "documentation":"

Information about the location of stored application artifacts and the service from which to retrieve them.

" }, "status":{ "shape":"DeploymentStatus", "documentation":"

The current state of the deployment as a whole.

" }, "errorInformation":{ "shape":"ErrorInformation", "documentation":"

Information about any error associated with this deployment.

" }, "createTime":{ "shape":"Timestamp", "documentation":"

A timestamp indicating when the deployment was created.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

A timestamp indicating when the deployment was deployed to the deployment group.

In some cases, the reported value of the start time may be later than the complete time. This is due to differences in the clock settings of back-end servers that participate in the deployment process.

" }, "completeTime":{ "shape":"Timestamp", "documentation":"

A timestamp indicating when the deployment was complete.

" }, "deploymentOverview":{ "shape":"DeploymentOverview", "documentation":"

A summary of the deployment status of the instances in the deployment.

" }, "description":{ "shape":"Description", "documentation":"

A comment about the deployment.

" }, "creator":{ "shape":"DeploymentCreator", "documentation":"

The means by which the deployment was created:

  • user: A user created the deployment.

  • autoscaling: Auto Scaling created the deployment.

  • codeDeployRollback: A rollback process created the deployment.

" }, "ignoreApplicationStopFailures":{ "shape":"Boolean", "documentation":"

If true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed at that point and will continue on to the BeforeInstall deployment lifecycle event.

If false or not specified, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.

" }, "autoRollbackConfiguration":{ "shape":"AutoRollbackConfiguration", "documentation":"

Information about the automatic rollback configuration associated with the deployment.

" }, "updateOutdatedInstancesOnly":{ "shape":"Boolean", "documentation":"

Indicates whether only instances that are not running the latest application revision are to be deployed to.

" }, "rollbackInfo":{ "shape":"RollbackInfo", "documentation":"

Information about a deployment rollback.

" }, "deploymentStyle":{ "shape":"DeploymentStyle", "documentation":"

Information about the type of deployment, either standard or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

" }, "targetInstances":{ "shape":"TargetInstances", "documentation":"

Information about the instances that belong to the replacement environment in a blue/green deployment.

" }, "instanceTerminationWaitTimeStarted":{ "shape":"Boolean", "documentation":"

Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified; otherwise, 'true' as soon as the termination wait period starts.

" }, "blueGreenDeploymentConfiguration":{ "shape":"BlueGreenDeploymentConfiguration", "documentation":"

Information about blue/green deployment options for this deployment.

" }, "loadBalancerInfo":{ "shape":"LoadBalancerInfo", "documentation":"

Information about the load balancer used in this blue/green deployment.

" }, "additionalDeploymentStatusInfo":{ "shape":"AdditionalDeploymentStatusInfo", "documentation":"

Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.

" } }, "documentation":"

Information about a deployment.

" }, "DeploymentIsNotInReadyStateException":{ "type":"structure", "members":{ }, "documentation":"

The deployment does not have a status of Ready and can't continue yet.

", "exception":true }, "DeploymentLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

The number of allowed deployments was exceeded.

", "exception":true }, "DeploymentNotStartedException":{ "type":"structure", "members":{ }, "documentation":"

The specified deployment has not started.

", "exception":true }, "DeploymentOption":{ "type":"string", "enum":[ "WITH_TRAFFIC_CONTROL", "WITHOUT_TRAFFIC_CONTROL" ] }, "DeploymentOverview":{ "type":"structure", "members":{ "Pending":{ "shape":"InstanceCount", "documentation":"

The number of instances in the deployment in a pending state.

" }, "InProgress":{ "shape":"InstanceCount", "documentation":"

The number of instances in which the deployment is in progress.

" }, "Succeeded":{ "shape":"InstanceCount", "documentation":"

The number of instances in the deployment to which revisions have been successfully deployed.

" }, "Failed":{ "shape":"InstanceCount", "documentation":"

The number of instances in the deployment in a failed state.

" }, "Skipped":{ "shape":"InstanceCount", "documentation":"

The number of instances in the deployment in a skipped state.

" }, "Ready":{ "shape":"InstanceCount", "documentation":"

The number of instances in a replacement environment ready to receive traffic in a blue/green deployment.

" } }, "documentation":"

Information about the deployment status of the instances in the deployment.

" }, "DeploymentReadyAction":{ "type":"string", "enum":[ "CONTINUE_DEPLOYMENT", "STOP_DEPLOYMENT" ] }, "DeploymentReadyOption":{ "type":"structure", "members":{ "actionOnTimeout":{ "shape":"DeploymentReadyAction", "documentation":"

Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.

  • CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.

  • STOP_DEPLOYMENT: Do not register new instances with load balancer unless traffic is rerouted manually. If traffic is not rerouted manually before the end of the specified wait period, the deployment status is changed to Stopped.

" }, "waitTimeInMinutes":{ "shape":"Duration", "documentation":"

The number of minutes to wait before the status of a blue/green deployment changed to Stopped if rerouting is not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout

" } }, "documentation":"

Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.

" }, "DeploymentStatus":{ "type":"string", "enum":[ "Created", "Queued", "InProgress", "Succeeded", "Failed", "Stopped", "Ready" ] }, "DeploymentStatusList":{ "type":"list", "member":{"shape":"DeploymentStatus"} }, "DeploymentStyle":{ "type":"structure", "members":{ "deploymentType":{ "shape":"DeploymentType", "documentation":"

Indicates whether to run a standard deployment or a blue/green deployment.

" }, "deploymentOption":{ "shape":"DeploymentOption", "documentation":"

Indicates whether to route deployment traffic behind a load balancer.

" } }, "documentation":"

Information about the type of deployment, either standard or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

" }, "DeploymentType":{ "type":"string", "enum":[ "IN_PLACE", "BLUE_GREEN" ] }, "DeploymentsInfoList":{ "type":"list", "member":{"shape":"DeploymentInfo"} }, "DeploymentsList":{ "type":"list", "member":{"shape":"DeploymentId"} }, "DeregisterOnPremisesInstanceInput":{ "type":"structure", "required":["instanceName"], "members":{ "instanceName":{ "shape":"InstanceName", "documentation":"

The name of the on-premises instance to deregister.

" } }, "documentation":"

Represents the input of a deregister on-premises instance operation.

" }, "Description":{"type":"string"}, "DescriptionTooLongException":{ "type":"structure", "members":{ }, "documentation":"

The description is too long.

", "exception":true }, "Diagnostics":{ "type":"structure", "members":{ "errorCode":{ "shape":"LifecycleErrorCode", "documentation":"

The associated error code:

  • Success: The specified script ran.

  • ScriptMissing: The specified script was not found in the specified location.

  • ScriptNotExecutable: The specified script is not a recognized executable file type.

  • ScriptTimedOut: The specified script did not finish running in the specified time period.

  • ScriptFailed: The specified script failed to run as expected.

  • UnknownError: The specified script did not run for an unknown reason.

" }, "scriptName":{ "shape":"ScriptName", "documentation":"

The name of the script.

" }, "message":{ "shape":"LifecycleMessage", "documentation":"

The message associated with the error.

" }, "logTail":{ "shape":"LogTail", "documentation":"

The last portion of the diagnostic log.

If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.

" } }, "documentation":"

Diagnostic information about executable scripts that are part of a deployment.

" }, "Duration":{"type":"integer"}, "EC2TagFilter":{ "type":"structure", "members":{ "Key":{ "shape":"Key", "documentation":"

The tag filter key.

" }, "Value":{ "shape":"Value", "documentation":"

The tag filter value.

" }, "Type":{ "shape":"EC2TagFilterType", "documentation":"

The tag filter type:

  • KEY_ONLY: Key only.

  • VALUE_ONLY: Value only.

  • KEY_AND_VALUE: Key and value.

" } }, "documentation":"

Information about a tag filter.

" }, "EC2TagFilterList":{ "type":"list", "member":{"shape":"EC2TagFilter"} }, "EC2TagFilterType":{ "type":"string", "enum":[ "KEY_ONLY", "VALUE_ONLY", "KEY_AND_VALUE" ] }, "ELBInfo":{ "type":"structure", "members":{ "name":{ "shape":"ELBName", "documentation":"

The name of the load balancer that will be used to route traffic from original instances to replacement instances in a blue/green deployment.

" } }, "documentation":"

Information about a load balancer in Elastic Load Balancing to use in a blue/green deployment.

" }, "ELBInfoList":{ "type":"list", "member":{"shape":"ELBInfo"} }, "ELBName":{"type":"string"}, "ETag":{"type":"string"}, "ErrorCode":{ "type":"string", "enum":[ "DEPLOYMENT_GROUP_MISSING", "APPLICATION_MISSING", "REVISION_MISSING", "IAM_ROLE_MISSING", "IAM_ROLE_PERMISSIONS", "NO_EC2_SUBSCRIPTION", "OVER_MAX_INSTANCES", "NO_INSTANCES", "TIMEOUT", "HEALTH_CONSTRAINTS_INVALID", "HEALTH_CONSTRAINTS", "INTERNAL_ERROR", "THROTTLED", "ALARM_ACTIVE", "AGENT_ISSUE", "AUTO_SCALING_IAM_ROLE_PERMISSIONS", "AUTO_SCALING_CONFIGURATION", "MANUAL_STOP" ] }, "ErrorInformation":{ "type":"structure", "members":{ "code":{ "shape":"ErrorCode", "documentation":"

For information about additional error codes, see Error Codes for AWS CodeDeploy in the AWS CodeDeploy User Guide.

The error code:

  • APPLICATION_MISSING: The application was missing. This error code will most likely be raised if the application is deleted after the deployment is created but before it is started.

  • DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code will most likely be raised if the deployment group is deleted after the deployment is created but before it is started.

  • HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified.

  • HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints specified.

  • IAM_ROLE_MISSING: The service role cannot be accessed.

  • IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.

  • INTERNAL_ERROR: There was an internal error.

  • NO_EC2_SUBSCRIPTION: The calling account is not subscribed to the Amazon EC2 service.

  • NO_INSTANCES: No instance were specified, or no instance can be found.

  • OVER_MAX_INSTANCES: The maximum number of instance was exceeded.

  • THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more AWS services.

  • TIMEOUT: The deployment has timed out.

  • REVISION_MISSING: The revision ID was missing. This error code will most likely be raised if the revision is deleted after the deployment is created but before it is started.

" }, "message":{ "shape":"ErrorMessage", "documentation":"

An accompanying error message.

" } }, "documentation":"

Information about a deployment error.

" }, "ErrorMessage":{"type":"string"}, "GenericRevisionInfo":{ "type":"structure", "members":{ "description":{ "shape":"Description", "documentation":"

A comment about the revision.

" }, "deploymentGroups":{ "shape":"DeploymentGroupsList", "documentation":"

The deployment groups for which this is the current target revision.

" }, "firstUsedTime":{ "shape":"Timestamp", "documentation":"

When the revision was first used by AWS CodeDeploy.

" }, "lastUsedTime":{ "shape":"Timestamp", "documentation":"

When the revision was last used by AWS CodeDeploy.

" }, "registerTime":{ "shape":"Timestamp", "documentation":"

When the revision was registered with AWS CodeDeploy.

" } }, "documentation":"

Information about an application revision.

" }, "GetApplicationInput":{ "type":"structure", "required":["applicationName"], "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

" } }, "documentation":"

Represents the input of a get application operation.

" }, "GetApplicationOutput":{ "type":"structure", "members":{ "application":{ "shape":"ApplicationInfo", "documentation":"

Information about the application.

" } }, "documentation":"

Represents the output of a get application operation.

" }, "GetApplicationRevisionInput":{ "type":"structure", "required":[ "applicationName", "revision" ], "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application that corresponds to the revision.

" }, "revision":{ "shape":"RevisionLocation", "documentation":"

Information about the application revision to get, including type and location.

" } }, "documentation":"

Represents the input of a get application revision operation.

" }, "GetApplicationRevisionOutput":{ "type":"structure", "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application that corresponds to the revision.

" }, "revision":{ "shape":"RevisionLocation", "documentation":"

Additional information about the revision, including type and location.

" }, "revisionInfo":{ "shape":"GenericRevisionInfo", "documentation":"

General information about the revision.

" } }, "documentation":"

Represents the output of a get application revision operation.

" }, "GetDeploymentConfigInput":{ "type":"structure", "required":["deploymentConfigName"], "members":{ "deploymentConfigName":{ "shape":"DeploymentConfigName", "documentation":"

The name of a deployment configuration associated with the applicable IAM user or AWS account.

" } }, "documentation":"

Represents the input of a get deployment configuration operation.

" }, "GetDeploymentConfigOutput":{ "type":"structure", "members":{ "deploymentConfigInfo":{ "shape":"DeploymentConfigInfo", "documentation":"

Information about the deployment configuration.

" } }, "documentation":"

Represents the output of a get deployment configuration operation.

" }, "GetDeploymentGroupInput":{ "type":"structure", "required":[ "applicationName", "deploymentGroupName" ], "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

" }, "deploymentGroupName":{ "shape":"DeploymentGroupName", "documentation":"

The name of an existing deployment group for the specified application.

" } }, "documentation":"

Represents the input of a get deployment group operation.

" }, "GetDeploymentGroupOutput":{ "type":"structure", "members":{ "deploymentGroupInfo":{ "shape":"DeploymentGroupInfo", "documentation":"

Information about the deployment group.

" } }, "documentation":"

Represents the output of a get deployment group operation.

" }, "GetDeploymentInput":{ "type":"structure", "required":["deploymentId"], "members":{ "deploymentId":{ "shape":"DeploymentId", "documentation":"

A deployment ID associated with the applicable IAM user or AWS account.

" } }, "documentation":"

Represents the input of a get deployment operation.

" }, "GetDeploymentInstanceInput":{ "type":"structure", "required":[ "deploymentId", "instanceId" ], "members":{ "deploymentId":{ "shape":"DeploymentId", "documentation":"

The unique ID of a deployment.

" }, "instanceId":{ "shape":"InstanceId", "documentation":"

The unique ID of an instance in the deployment group.

" } }, "documentation":"

Represents the input of a get deployment instance operation.

" }, "GetDeploymentInstanceOutput":{ "type":"structure", "members":{ "instanceSummary":{ "shape":"InstanceSummary", "documentation":"

Information about the instance.

" } }, "documentation":"

Represents the output of a get deployment instance operation.

" }, "GetDeploymentOutput":{ "type":"structure", "members":{ "deploymentInfo":{ "shape":"DeploymentInfo", "documentation":"

Information about the deployment.

" } }, "documentation":"

Represents the output of a get deployment operation.

" }, "GetOnPremisesInstanceInput":{ "type":"structure", "required":["instanceName"], "members":{ "instanceName":{ "shape":"InstanceName", "documentation":"

The name of the on-premises instance about which to get information.

" } }, "documentation":"

Represents the input of a get on-premises instance operation.

" }, "GetOnPremisesInstanceOutput":{ "type":"structure", "members":{ "instanceInfo":{ "shape":"InstanceInfo", "documentation":"

Information about the on-premises instance.

" } }, "documentation":"

Represents the output of a get on-premises instance operation.

" }, "GitHubLocation":{ "type":"structure", "members":{ "repository":{ "shape":"Repository", "documentation":"

The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.

Specified as account/repository.

" }, "commitId":{ "shape":"CommitId", "documentation":"

The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.

" } }, "documentation":"

Information about the location of application artifacts stored in GitHub.

" }, "GreenFleetProvisioningAction":{ "type":"string", "enum":[ "DISCOVER_EXISTING", "COPY_AUTO_SCALING_GROUP" ] }, "GreenFleetProvisioningOption":{ "type":"structure", "members":{ "action":{ "shape":"GreenFleetProvisioningAction", "documentation":"

The method used to add instances to a replacement environment.

  • DISCOVER_EXISTING: Use instances that already exist or will be created manually.

  • COPY_AUTO_SCALING_GROUP: Use settings from a specified Auto Scaling group to define and create instances in a new Auto Scaling group.

" } }, "documentation":"

Information about the instances that belong to the replacement environment in a blue/green deployment.

" }, "IamArnRequiredException":{ "type":"structure", "members":{ }, "documentation":"

No IAM ARN was included in the request. You must use an IAM session ARN or IAM user ARN in the request.

", "exception":true }, "IamSessionArn":{"type":"string"}, "IamSessionArnAlreadyRegisteredException":{ "type":"structure", "members":{ }, "documentation":"

The request included an IAM session ARN that has already been used to register a different instance.

", "exception":true }, "IamUserArn":{"type":"string"}, "IamUserArnAlreadyRegisteredException":{ "type":"structure", "members":{ }, "documentation":"

The specified IAM user ARN is already registered with an on-premises instance.

", "exception":true }, "IamUserArnRequiredException":{ "type":"structure", "members":{ }, "documentation":"

An IAM user ARN was not specified.

", "exception":true }, "InstanceAction":{ "type":"string", "enum":[ "TERMINATE", "KEEP_ALIVE" ] }, "InstanceArn":{"type":"string"}, "InstanceCount":{"type":"long"}, "InstanceDoesNotExistException":{ "type":"structure", "members":{ }, "documentation":"

The specified instance does not exist in the deployment group.

", "exception":true }, "InstanceId":{"type":"string"}, "InstanceIdRequiredException":{ "type":"structure", "members":{ }, "documentation":"

The instance ID was not specified.

", "exception":true }, "InstanceInfo":{ "type":"structure", "members":{ "instanceName":{ "shape":"InstanceName", "documentation":"

The name of the on-premises instance.

" }, "iamSessionArn":{ "shape":"IamSessionArn", "documentation":"

The ARN of the IAM session associated with the on-premises instance.

" }, "iamUserArn":{ "shape":"IamUserArn", "documentation":"

The IAM user ARN associated with the on-premises instance.

" }, "instanceArn":{ "shape":"InstanceArn", "documentation":"

The ARN of the on-premises instance.

" }, "registerTime":{ "shape":"Timestamp", "documentation":"

The time at which the on-premises instance was registered.

" }, "deregisterTime":{ "shape":"Timestamp", "documentation":"

If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.

" }, "tags":{ "shape":"TagList", "documentation":"

The tags currently associated with the on-premises instance.

" } }, "documentation":"

Information about an on-premises instance.

" }, "InstanceInfoList":{ "type":"list", "member":{"shape":"InstanceInfo"} }, "InstanceLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

The maximum number of allowed on-premises instances in a single call was exceeded.

", "exception":true }, "InstanceName":{"type":"string"}, "InstanceNameAlreadyRegisteredException":{ "type":"structure", "members":{ }, "documentation":"

The specified on-premises instance name is already registered.

", "exception":true }, "InstanceNameList":{ "type":"list", "member":{"shape":"InstanceName"} }, "InstanceNameRequiredException":{ "type":"structure", "members":{ }, "documentation":"

An on-premises instance name was not specified.

", "exception":true }, "InstanceNotRegisteredException":{ "type":"structure", "members":{ }, "documentation":"

The specified on-premises instance is not registered.

", "exception":true }, "InstanceStatus":{ "type":"string", "enum":[ "Pending", "InProgress", "Succeeded", "Failed", "Skipped", "Unknown", "Ready" ] }, "InstanceStatusList":{ "type":"list", "member":{"shape":"InstanceStatus"} }, "InstanceSummary":{ "type":"structure", "members":{ "deploymentId":{ "shape":"DeploymentId", "documentation":"

The deployment ID.

" }, "instanceId":{ "shape":"InstanceId", "documentation":"

The instance ID.

" }, "status":{ "shape":"InstanceStatus", "documentation":"

The deployment status for this instance:

  • Pending: The deployment is pending for this instance.

  • In Progress: The deployment is in progress for this instance.

  • Succeeded: The deployment has succeeded for this instance.

  • Failed: The deployment has failed for this instance.

  • Skipped: The deployment has been skipped for this instance.

  • Unknown: The deployment status is unknown for this instance.

" }, "lastUpdatedAt":{ "shape":"Timestamp", "documentation":"

A timestamp indicating when the instance information was last updated.

" }, "lifecycleEvents":{ "shape":"LifecycleEventList", "documentation":"

A list of lifecycle events for this instance.

" }, "instanceType":{ "shape":"InstanceType", "documentation":"

Information about which environment an instance belongs to in a blue/green deployment.

  • BLUE: The instance is part of the original environment.

  • GREEN: The instance is part of the replacement environment.

" } }, "documentation":"

Information about an instance in a deployment.

" }, "InstanceSummaryList":{ "type":"list", "member":{"shape":"InstanceSummary"} }, "InstanceType":{ "type":"string", "enum":[ "Blue", "Green" ] }, "InstanceTypeList":{ "type":"list", "member":{"shape":"InstanceType"} }, "InstancesList":{ "type":"list", "member":{"shape":"InstanceId"} }, "InvalidAlarmConfigException":{ "type":"structure", "members":{ }, "documentation":"

The format of the alarm configuration is invalid. Possible causes include:

  • The alarm list is null.

  • The alarm object is null.

  • The alarm name is empty or null or exceeds the 255 character limit.

  • Two alarms with the same name have been specified.

  • The alarm configuration is enabled but the alarm list is empty.

", "exception":true }, "InvalidApplicationNameException":{ "type":"structure", "members":{ }, "documentation":"

The application name was specified in an invalid format.

", "exception":true }, "InvalidAutoRollbackConfigException":{ "type":"structure", "members":{ }, "documentation":"

The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled but an invalid triggering event type or no event types were listed.

", "exception":true }, "InvalidAutoScalingGroupException":{ "type":"structure", "members":{ }, "documentation":"

The Auto Scaling group was specified in an invalid format or does not exist.

", "exception":true }, "InvalidBlueGreenDeploymentConfigurationException":{ "type":"structure", "members":{ }, "documentation":"

The configuration for the blue/green deployment group was provided in an invalid format. For information about deployment configuration format, see CreateDeploymentConfig.

", "exception":true }, "InvalidBucketNameFilterException":{ "type":"structure", "members":{ }, "documentation":"

The bucket name either doesn't exist or was specified in an invalid format.

", "exception":true }, "InvalidDeployedStateFilterException":{ "type":"structure", "members":{ }, "documentation":"

The deployed state filter was specified in an invalid format.

", "exception":true }, "InvalidDeploymentConfigNameException":{ "type":"structure", "members":{ }, "documentation":"

The deployment configuration name was specified in an invalid format.

", "exception":true }, "InvalidDeploymentGroupNameException":{ "type":"structure", "members":{ }, "documentation":"

The deployment group name was specified in an invalid format.

", "exception":true }, "InvalidDeploymentIdException":{ "type":"structure", "members":{ }, "documentation":"

At least one of the deployment IDs was specified in an invalid format.

", "exception":true }, "InvalidDeploymentStatusException":{ "type":"structure", "members":{ }, "documentation":"

The specified deployment status doesn't exist or cannot be determined.

", "exception":true }, "InvalidDeploymentStyleException":{ "type":"structure", "members":{ }, "documentation":"

An invalid deployment style was specified. Valid deployment types include \"IN_PLACE\" and \"BLUE_GREEN\". Valid deployment options for blue/green deployments include \"WITH_TRAFFIC_CONTROL\" and \"WITHOUT_TRAFFIC_CONTROL\".

", "exception":true }, "InvalidEC2TagException":{ "type":"structure", "members":{ }, "documentation":"

The tag was specified in an invalid format.

", "exception":true }, "InvalidIamSessionArnException":{ "type":"structure", "members":{ }, "documentation":"

The IAM session ARN was specified in an invalid format.

", "exception":true }, "InvalidIamUserArnException":{ "type":"structure", "members":{ }, "documentation":"

The IAM user ARN was specified in an invalid format.

", "exception":true }, "InvalidInstanceNameException":{ "type":"structure", "members":{ }, "documentation":"

The specified on-premises instance name was specified in an invalid format.

", "exception":true }, "InvalidInstanceStatusException":{ "type":"structure", "members":{ }, "documentation":"

The specified instance status does not exist.

", "exception":true }, "InvalidInstanceTypeException":{ "type":"structure", "members":{ }, "documentation":"

An invalid instance type was specified for instances in a blue/green deployment. Valid values include \"Blue\" for an original environment and \"Green\" for a replacement environment.

", "exception":true }, "InvalidKeyPrefixFilterException":{ "type":"structure", "members":{ }, "documentation":"

The specified key prefix filter was specified in an invalid format.

", "exception":true }, "InvalidLoadBalancerInfoException":{ "type":"structure", "members":{ }, "documentation":"

An invalid load balancer name, or no load balancer name, was specified.

", "exception":true }, "InvalidMinimumHealthyHostValueException":{ "type":"structure", "members":{ }, "documentation":"

The minimum healthy instance value was specified in an invalid format.

", "exception":true }, "InvalidNextTokenException":{ "type":"structure", "members":{ }, "documentation":"

The next token was specified in an invalid format.

", "exception":true }, "InvalidOperationException":{ "type":"structure", "members":{ }, "documentation":"

An invalid operation was detected.

", "exception":true }, "InvalidRegistrationStatusException":{ "type":"structure", "members":{ }, "documentation":"

The registration status was specified in an invalid format.

", "exception":true }, "InvalidRevisionException":{ "type":"structure", "members":{ }, "documentation":"

The revision was specified in an invalid format.

", "exception":true }, "InvalidRoleException":{ "type":"structure", "members":{ }, "documentation":"

The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Auto Scaling.

", "exception":true }, "InvalidSortByException":{ "type":"structure", "members":{ }, "documentation":"

The column name to sort by is either not present or was specified in an invalid format.

", "exception":true }, "InvalidSortOrderException":{ "type":"structure", "members":{ }, "documentation":"

The sort order was specified in an invalid format.

", "exception":true }, "InvalidTagException":{ "type":"structure", "members":{ }, "documentation":"

The specified tag was specified in an invalid format.

", "exception":true }, "InvalidTagFilterException":{ "type":"structure", "members":{ }, "documentation":"

The specified tag filter was specified in an invalid format.

", "exception":true }, "InvalidTargetInstancesException":{ "type":"structure", "members":{ }, "documentation":"

The target instance configuration is invalid. Possible causes include:

  • Configuration data for target instances was entered for an in-place deployment.

  • The limit of 10 tags for a tag type was exceeded.

  • The combined length of the tag names exceeded the limit.

  • A specified tag is not currently applied to any instances.

", "exception":true }, "InvalidTimeRangeException":{ "type":"structure", "members":{ }, "documentation":"

The specified time range was specified in an invalid format.

", "exception":true }, "InvalidTriggerConfigException":{ "type":"structure", "members":{ }, "documentation":"

The trigger was specified in an invalid format.

", "exception":true }, "Key":{"type":"string"}, "LifecycleErrorCode":{ "type":"string", "enum":[ "Success", "ScriptMissing", "ScriptNotExecutable", "ScriptTimedOut", "ScriptFailed", "UnknownError" ] }, "LifecycleEvent":{ "type":"structure", "members":{ "lifecycleEventName":{ "shape":"LifecycleEventName", "documentation":"

The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService.

" }, "diagnostics":{ "shape":"Diagnostics", "documentation":"

Diagnostic information about the deployment lifecycle event.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

A timestamp indicating when the deployment lifecycle event started.

" }, "endTime":{ "shape":"Timestamp", "documentation":"

A timestamp indicating when the deployment lifecycle event ended.

" }, "status":{ "shape":"LifecycleEventStatus", "documentation":"

The deployment lifecycle event status:

  • Pending: The deployment lifecycle event is pending.

  • InProgress: The deployment lifecycle event is in progress.

  • Succeeded: The deployment lifecycle event ran successfully.

  • Failed: The deployment lifecycle event has failed.

  • Skipped: The deployment lifecycle event has been skipped.

  • Unknown: The deployment lifecycle event is unknown.

" } }, "documentation":"

Information about a deployment lifecycle event.

" }, "LifecycleEventList":{ "type":"list", "member":{"shape":"LifecycleEvent"} }, "LifecycleEventName":{"type":"string"}, "LifecycleEventStatus":{ "type":"string", "enum":[ "Pending", "InProgress", "Succeeded", "Failed", "Skipped", "Unknown" ] }, "LifecycleHookLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

The limit for lifecycle hooks was exceeded.

", "exception":true }, "LifecycleMessage":{"type":"string"}, "ListApplicationRevisionsInput":{ "type":"structure", "required":["applicationName"], "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

" }, "sortBy":{ "shape":"ApplicationRevisionSortBy", "documentation":"

The column name to use to sort the list results:

  • registerTime: Sort by the time the revisions were registered with AWS CodeDeploy.

  • firstUsedTime: Sort by the time the revisions were first used in a deployment.

  • lastUsedTime: Sort by the time the revisions were last used in a deployment.

If not specified or set to null, the results will be returned in an arbitrary order.

" }, "sortOrder":{ "shape":"SortOrder", "documentation":"

The order in which to sort the list results:

  • ascending: ascending order.

  • descending: descending order.

If not specified, the results will be sorted in ascending order.

If set to null, the results will be sorted in an arbitrary order.

" }, "s3Bucket":{ "shape":"S3Bucket", "documentation":"

An Amazon S3 bucket name to limit the search for revisions.

If set to null, all of the user's buckets will be searched.

" }, "s3KeyPrefix":{ "shape":"S3Key", "documentation":"

A key prefix for the set of Amazon S3 objects to limit the search for revisions.

" }, "deployed":{ "shape":"ListStateFilterAction", "documentation":"

Whether to list revisions based on whether the revision is the target revision of an deployment group:

  • include: List revisions that are target revisions of a deployment group.

  • exclude: Do not list revisions that are target revisions of a deployment group.

  • ignore: List all revisions.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

An identifier returned from the previous list application revisions call. It can be used to return the next set of applications in the list.

" } }, "documentation":"

Represents the input of a list application revisions operation.

" }, "ListApplicationRevisionsOutput":{ "type":"structure", "members":{ "revisions":{ "shape":"RevisionLocationList", "documentation":"

A list of locations that contain the matching revisions.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

If a large amount of information is returned, an identifier will also be returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list.

" } }, "documentation":"

Represents the output of a list application revisions operation.

" }, "ListApplicationsInput":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list.

" } }, "documentation":"

Represents the input of a list applications operation.

" }, "ListApplicationsOutput":{ "type":"structure", "members":{ "applications":{ "shape":"ApplicationsList", "documentation":"

A list of application names.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list applications call to return the next set of applications, will also be returned. in the list.

" } }, "documentation":"

Represents the output of a list applications operation.

" }, "ListDeploymentConfigsInput":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

An identifier returned from the previous list deployment configurations call. It can be used to return the next set of deployment configurations in the list.

" } }, "documentation":"

Represents the input of a list deployment configurations operation.

" }, "ListDeploymentConfigsOutput":{ "type":"structure", "members":{ "deploymentConfigsList":{ "shape":"DeploymentConfigsList", "documentation":"

A list of deployment configurations, including built-in configurations such as CodeDeployDefault.OneAtATime.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment configurations call to return the next set of deployment configurations in the list.

" } }, "documentation":"

Represents the output of a list deployment configurations operation.

" }, "ListDeploymentGroupsInput":{ "type":"structure", "required":["applicationName"], "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

An identifier returned from the previous list deployment groups call. It can be used to return the next set of deployment groups in the list.

" } }, "documentation":"

Represents the input of a list deployment groups operation.

" }, "ListDeploymentGroupsOutput":{ "type":"structure", "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The application name.

" }, "deploymentGroups":{ "shape":"DeploymentGroupsList", "documentation":"

A list of corresponding deployment group names.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment groups call to return the next set of deployment groups in the list.

" } }, "documentation":"

Represents the output of a list deployment groups operation.

" }, "ListDeploymentInstancesInput":{ "type":"structure", "required":["deploymentId"], "members":{ "deploymentId":{ "shape":"DeploymentId", "documentation":"

The unique ID of a deployment.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

An identifier returned from the previous list deployment instances call. It can be used to return the next set of deployment instances in the list.

" }, "instanceStatusFilter":{ "shape":"InstanceStatusList", "documentation":"

A subset of instances to list by status:

  • Pending: Include those instance with pending deployments.

  • InProgress: Include those instance where deployments are still in progress.

  • Succeeded: Include those instances with successful deployments.

  • Failed: Include those instance with failed deployments.

  • Skipped: Include those instance with skipped deployments.

  • Unknown: Include those instance with deployments in an unknown state.

" }, "instanceTypeFilter":{ "shape":"InstanceTypeList", "documentation":"

The set of instances in a blue/green deployment, either those in the original environment (\"BLUE\") or those in the replacement environment (\"GREEN\"), for which you want to view instance information.

" } }, "documentation":"

Represents the input of a list deployment instances operation.

" }, "ListDeploymentInstancesOutput":{ "type":"structure", "members":{ "instancesList":{ "shape":"InstancesList", "documentation":"

A list of instance IDs.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment instances call to return the next set of deployment instances in the list.

" } }, "documentation":"

Represents the output of a list deployment instances operation.

" }, "ListDeploymentsInput":{ "type":"structure", "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

" }, "deploymentGroupName":{ "shape":"DeploymentGroupName", "documentation":"

The name of an existing deployment group for the specified application.

" }, "includeOnlyStatuses":{ "shape":"DeploymentStatusList", "documentation":"

A subset of deployments to list by status:

  • Created: Include created deployments in the resulting list.

  • Queued: Include queued deployments in the resulting list.

  • In Progress: Include in-progress deployments in the resulting list.

  • Succeeded: Include successful deployments in the resulting list.

  • Failed: Include failed deployments in the resulting list.

  • Stopped: Include stopped deployments in the resulting list.

" }, "createTimeRange":{ "shape":"TimeRange", "documentation":"

A time range (start and end) for returning a subset of the list of deployments.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.

" } }, "documentation":"

Represents the input of a list deployments operation.

" }, "ListDeploymentsOutput":{ "type":"structure", "members":{ "deployments":{ "shape":"DeploymentsList", "documentation":"

A list of deployment IDs.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployments call to return the next set of deployments in the list.

" } }, "documentation":"

Represents the output of a list deployments operation.

" }, "ListOnPremisesInstancesInput":{ "type":"structure", "members":{ "registrationStatus":{ "shape":"RegistrationStatus", "documentation":"

The registration status of the on-premises instances:

  • Deregistered: Include deregistered on-premises instances in the resulting list.

  • Registered: Include registered on-premises instances in the resulting list.

" }, "tagFilters":{ "shape":"TagFilterList", "documentation":"

The on-premises instance tags that will be used to restrict the corresponding on-premises instance names returned.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.

" } }, "documentation":"

Represents the input of a list on-premises instances operation.

" }, "ListOnPremisesInstancesOutput":{ "type":"structure", "members":{ "instanceNames":{ "shape":"InstanceNameList", "documentation":"

The list of matching on-premises instance names.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list.

" } }, "documentation":"

Represents the output of list on-premises instances operation.

" }, "ListStateFilterAction":{ "type":"string", "enum":[ "include", "exclude", "ignore" ] }, "LoadBalancerInfo":{ "type":"structure", "members":{ "elbInfoList":{ "shape":"ELBInfoList", "documentation":"

An array containing information about the load balancer in Elastic Load Balancing to use in a blue/green deployment.

" } }, "documentation":"

Information about the load balancer used in a blue/green deployment.

" }, "LogTail":{"type":"string"}, "Message":{"type":"string"}, "MinimumHealthyHosts":{ "type":"structure", "members":{ "value":{ "shape":"MinimumHealthyHostsValue", "documentation":"

The minimum healthy instance value.

" }, "type":{ "shape":"MinimumHealthyHostsType", "documentation":"

The minimum healthy instance type:

  • HOST_COUNT: The minimum number of healthy instance as an absolute value.

  • FLEET_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment.

In an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment will be successful if six or more instances are deployed to successfully; otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instance at a time. The deployment will be successful if four or more instance are deployed to successfully; otherwise, the deployment fails.

In a call to the get deployment configuration operation, CodeDeployDefault.OneAtATime will return a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy will try to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment still succeeds.

" } }, "documentation":"

Information about minimum healthy instance.

" }, "MinimumHealthyHostsType":{ "type":"string", "enum":[ "HOST_COUNT", "FLEET_PERCENT" ] }, "MinimumHealthyHostsValue":{"type":"integer"}, "MultipleIamArnsProvidedException":{ "type":"structure", "members":{ }, "documentation":"

Both an IAM user ARN and an IAM session ARN were included in the request. Use only one ARN type.

", "exception":true }, "NextToken":{"type":"string"}, "NullableBoolean":{"type":"boolean"}, "RegisterApplicationRevisionInput":{ "type":"structure", "required":[ "applicationName", "revision" ], "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

" }, "description":{ "shape":"Description", "documentation":"

A comment about the revision.

" }, "revision":{ "shape":"RevisionLocation", "documentation":"

Information about the application revision to register, including type and location.

" } }, "documentation":"

Represents the input of a register application revision operation.

" }, "RegisterOnPremisesInstanceInput":{ "type":"structure", "required":["instanceName"], "members":{ "instanceName":{ "shape":"InstanceName", "documentation":"

The name of the on-premises instance to register.

" }, "iamSessionArn":{ "shape":"IamSessionArn", "documentation":"

The ARN of the IAM session to associate with the on-premises instance.

" }, "iamUserArn":{ "shape":"IamUserArn", "documentation":"

The ARN of the IAM user to associate with the on-premises instance.

" } }, "documentation":"

Represents the input of the register on-premises instance operation.

" }, "RegistrationStatus":{ "type":"string", "enum":[ "Registered", "Deregistered" ] }, "RemoveTagsFromOnPremisesInstancesInput":{ "type":"structure", "required":[ "tags", "instanceNames" ], "members":{ "tags":{ "shape":"TagList", "documentation":"

The tag key-value pairs to remove from the on-premises instances.

" }, "instanceNames":{ "shape":"InstanceNameList", "documentation":"

The names of the on-premises instances from which to remove tags.

" } }, "documentation":"

Represents the input of a remove tags from on-premises instances operation.

" }, "Repository":{"type":"string"}, "RevisionDoesNotExistException":{ "type":"structure", "members":{ }, "documentation":"

The named revision does not exist with the applicable IAM user or AWS account.

", "exception":true }, "RevisionInfo":{ "type":"structure", "members":{ "revisionLocation":{ "shape":"RevisionLocation", "documentation":"

Information about the location and type of an application revision.

" }, "genericRevisionInfo":{ "shape":"GenericRevisionInfo", "documentation":"

Information about an application revision, including usage details and associated deployment groups.

" } }, "documentation":"

Information about an application revision.

" }, "RevisionInfoList":{ "type":"list", "member":{"shape":"RevisionInfo"} }, "RevisionLocation":{ "type":"structure", "members":{ "revisionType":{ "shape":"RevisionLocationType", "documentation":"

The type of application revision:

  • S3: An application revision stored in Amazon S3.

  • GitHub: An application revision stored in GitHub.

" }, "s3Location":{ "shape":"S3Location", "documentation":"

Information about the location of application artifacts stored in Amazon S3.

" }, "gitHubLocation":{ "shape":"GitHubLocation", "documentation":"

Information about the location of application artifacts stored in GitHub.

" } }, "documentation":"

Information about the location of an application revision.

" }, "RevisionLocationList":{ "type":"list", "member":{"shape":"RevisionLocation"} }, "RevisionLocationType":{ "type":"string", "enum":[ "S3", "GitHub" ] }, "RevisionRequiredException":{ "type":"structure", "members":{ }, "documentation":"

The revision ID was not specified.

", "exception":true }, "Role":{"type":"string"}, "RoleRequiredException":{ "type":"structure", "members":{ }, "documentation":"

The role ID was not specified.

", "exception":true }, "RollbackInfo":{ "type":"structure", "members":{ "rollbackDeploymentId":{ "shape":"DeploymentId", "documentation":"

The ID of the deployment rollback.

" }, "rollbackTriggeringDeploymentId":{ "shape":"DeploymentId", "documentation":"

The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped.

" }, "rollbackMessage":{ "shape":"Description", "documentation":"

Information describing the status of a deployment rollback; for example, whether the deployment can't be rolled back, is in progress, failed, or succeeded.

" } }, "documentation":"

Information about a deployment rollback.

" }, "S3Bucket":{"type":"string"}, "S3Key":{"type":"string"}, "S3Location":{ "type":"structure", "members":{ "bucket":{ "shape":"S3Bucket", "documentation":"

The name of the Amazon S3 bucket where the application revision is stored.

" }, "key":{ "shape":"S3Key", "documentation":"

The name of the Amazon S3 object that represents the bundled artifacts for the application revision.

" }, "bundleType":{ "shape":"BundleType", "documentation":"

The file type of the application revision. Must be one of the following:

  • tar: A tar archive file.

  • tgz: A compressed tar archive file.

  • zip: A zip archive file.

" }, "version":{ "shape":"VersionId", "documentation":"

A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.

If the version is not specified, the system will use the most recent version by default.

" }, "eTag":{ "shape":"ETag", "documentation":"

The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.

If the ETag is not specified as an input parameter, ETag validation of the object will be skipped.

" } }, "documentation":"

Information about the location of application artifacts stored in Amazon S3.

" }, "ScriptName":{"type":"string"}, "SkipWaitTimeForInstanceTerminationInput":{ "type":"structure", "members":{ "deploymentId":{ "shape":"DeploymentId", "documentation":"

The ID of the blue/green deployment for which you want to skip the instance termination wait time.

" } } }, "SortOrder":{ "type":"string", "enum":[ "ascending", "descending" ] }, "StopDeploymentInput":{ "type":"structure", "required":["deploymentId"], "members":{ "deploymentId":{ "shape":"DeploymentId", "documentation":"

The unique ID of a deployment.

" }, "autoRollbackEnabled":{ "shape":"NullableBoolean", "documentation":"

Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.

" } }, "documentation":"

Represents the input of a stop deployment operation.

" }, "StopDeploymentOutput":{ "type":"structure", "members":{ "status":{ "shape":"StopStatus", "documentation":"

The status of the stop deployment operation:

  • Pending: The stop operation is pending.

  • Succeeded: The stop operation was successful.

" }, "statusMessage":{ "shape":"Message", "documentation":"

An accompanying status message.

" } }, "documentation":"

Represents the output of a stop deployment operation.

" }, "StopStatus":{ "type":"string", "enum":[ "Pending", "Succeeded" ] }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"Key", "documentation":"

The tag's key.

" }, "Value":{ "shape":"Value", "documentation":"

The tag's value.

" } }, "documentation":"

Information about a tag.

" }, "TagFilter":{ "type":"structure", "members":{ "Key":{ "shape":"Key", "documentation":"

The on-premises instance tag filter key.

" }, "Value":{ "shape":"Value", "documentation":"

The on-premises instance tag filter value.

" }, "Type":{ "shape":"TagFilterType", "documentation":"

The on-premises instance tag filter type:

  • KEY_ONLY: Key only.

  • VALUE_ONLY: Value only.

  • KEY_AND_VALUE: Key and value.

" } }, "documentation":"

Information about an on-premises instance tag filter.

" }, "TagFilterList":{ "type":"list", "member":{"shape":"TagFilter"} }, "TagFilterType":{ "type":"string", "enum":[ "KEY_ONLY", "VALUE_ONLY", "KEY_AND_VALUE" ] }, "TagLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

The maximum allowed number of tags was exceeded.

", "exception":true }, "TagList":{ "type":"list", "member":{"shape":"Tag"} }, "TagRequiredException":{ "type":"structure", "members":{ }, "documentation":"

A tag was not specified.

", "exception":true }, "TargetInstances":{ "type":"structure", "members":{ "tagFilters":{ "shape":"EC2TagFilterList", "documentation":"

The tag filter key, type, and value used to identify Amazon EC2 instances in a replacement environment for a blue/green deployment.

" }, "autoScalingGroups":{ "shape":"AutoScalingGroupNameList", "documentation":"

The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.

" } }, "documentation":"

Information about the instances to be used in the replacement environment in a blue/green deployment.

" }, "TimeRange":{ "type":"structure", "members":{ "start":{ "shape":"Timestamp", "documentation":"

The start time of the time range.

Specify null to leave the start time open-ended.

" }, "end":{ "shape":"Timestamp", "documentation":"

The end time of the time range.

Specify null to leave the end time open-ended.

" } }, "documentation":"

Information about a time range.

" }, "Timestamp":{"type":"timestamp"}, "TriggerConfig":{ "type":"structure", "members":{ "triggerName":{ "shape":"TriggerName", "documentation":"

The name of the notification trigger.

" }, "triggerTargetArn":{ "shape":"TriggerTargetArn", "documentation":"

The ARN of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.

" }, "triggerEvents":{ "shape":"TriggerEventTypeList", "documentation":"

The event type or types for which notifications are triggered.

" } }, "documentation":"

Information about notification triggers for the deployment group.

" }, "TriggerConfigList":{ "type":"list", "member":{"shape":"TriggerConfig"} }, "TriggerEventType":{ "type":"string", "enum":[ "DeploymentStart", "DeploymentSuccess", "DeploymentFailure", "DeploymentStop", "DeploymentRollback", "DeploymentReady", "InstanceStart", "InstanceSuccess", "InstanceFailure", "InstanceReady" ] }, "TriggerEventTypeList":{ "type":"list", "member":{"shape":"TriggerEventType"} }, "TriggerName":{"type":"string"}, "TriggerTargetArn":{"type":"string"}, "TriggerTargetsLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

The maximum allowed number of triggers was exceeded.

", "exception":true }, "UnsupportedActionForDeploymentTypeException":{ "type":"structure", "members":{ }, "documentation":"

A call was submitted that is not supported for the specified deployment type.

", "exception":true }, "UpdateApplicationInput":{ "type":"structure", "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The current name of the application you want to change.

" }, "newApplicationName":{ "shape":"ApplicationName", "documentation":"

The new name to give the application.

" } }, "documentation":"

Represents the input of an update application operation.

" }, "UpdateDeploymentGroupInput":{ "type":"structure", "required":[ "applicationName", "currentDeploymentGroupName" ], "members":{ "applicationName":{ "shape":"ApplicationName", "documentation":"

The application name corresponding to the deployment group to update.

" }, "currentDeploymentGroupName":{ "shape":"DeploymentGroupName", "documentation":"

The current name of the deployment group.

" }, "newDeploymentGroupName":{ "shape":"DeploymentGroupName", "documentation":"

The new name of the deployment group, if you want to change it.

" }, "deploymentConfigName":{ "shape":"DeploymentConfigName", "documentation":"

The replacement deployment configuration name to use, if you want to change it.

" }, "ec2TagFilters":{ "shape":"EC2TagFilterList", "documentation":"

The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

" }, "onPremisesInstanceTagFilters":{ "shape":"TagFilterList", "documentation":"

The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

" }, "autoScalingGroups":{ "shape":"AutoScalingGroupNameList", "documentation":"

The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them. To keep the Auto Scaling groups, enter their names. To remove Auto Scaling groups, do not enter any Auto Scaling group names.

" }, "serviceRoleArn":{ "shape":"Role", "documentation":"

A replacement ARN for the service role, if you want to change it.

" }, "triggerConfigurations":{ "shape":"TriggerConfigList", "documentation":"

Information about triggers to change when the deployment group is updated. For examples, see Modify Triggers in an AWS CodeDeploy Deployment Group in the AWS CodeDeploy User Guide.

" }, "alarmConfiguration":{ "shape":"AlarmConfiguration", "documentation":"

Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.

" }, "autoRollbackConfiguration":{ "shape":"AutoRollbackConfiguration", "documentation":"

Information for an automatic rollback configuration that is added or changed when a deployment group is updated.

" }, "deploymentStyle":{ "shape":"DeploymentStyle", "documentation":"

Information about the type of deployment, either standard or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

" }, "blueGreenDeploymentConfiguration":{ "shape":"BlueGreenDeploymentConfiguration", "documentation":"

Information about blue/green deployment options for a deployment group.

" }, "loadBalancerInfo":{ "shape":"LoadBalancerInfo", "documentation":"

Information about the load balancer used in a blue/green deployment.

" } }, "documentation":"

Represents the input of an update deployment group operation.

" }, "UpdateDeploymentGroupOutput":{ "type":"structure", "members":{ "hooksNotCleanedUp":{ "shape":"AutoScalingGroupList", "documentation":"

If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the AWS account. If the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the AWS account.

" } }, "documentation":"

Represents the output of an update deployment group operation.

" }, "Value":{"type":"string"}, "VersionId":{"type":"string"} }, "documentation":"AWS CodeDeploy

Overview

This reference guide provides descriptions of the AWS CodeDeploy APIs. For more information about AWS CodeDeploy, see the AWS CodeDeploy User Guide.

Using the APIs

You can use the AWS CodeDeploy APIs to work with the following:

  • Applications are unique identifiers used by AWS CodeDeploy to ensure the correct combinations of revisions, deployment configurations, and deployment groups are being referenced during deployments.

    You can use the AWS CodeDeploy APIs to create, delete, get, list, and update applications.

  • Deployment configurations are sets of deployment rules and success and failure conditions used by AWS CodeDeploy during deployments.

    You can use the AWS CodeDeploy APIs to create, delete, get, and list deployment configurations.

  • Deployment groups are groups of instances to which application revisions can be deployed.

    You can use the AWS CodeDeploy APIs to create, delete, get, list, and update deployment groups.

  • Instances represent Amazon EC2 instances to which application revisions are deployed. Instances are identified by their Amazon EC2 tags or Auto Scaling group names. Instances belong to deployment groups.

    You can use the AWS CodeDeploy APIs to get and list instance.

  • Deployments represent the process of deploying revisions to instances.

    You can use the AWS CodeDeploy APIs to create, get, list, and stop deployments.

  • Application revisions are archive files stored in Amazon S3 buckets or GitHub repositories. These revisions contain source content (such as source code, web pages, executable files, and deployment scripts) along with an application specification (AppSpec) file. (The AppSpec file is unique to AWS CodeDeploy; it defines the deployment actions you want AWS CodeDeploy to execute.) For application revisions stored in Amazon S3 buckets, an application revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For application revisions stored in GitHub repositories, an application revision is uniquely identified by its repository name and commit ID. Application revisions are deployed through deployment groups.

    You can use the AWS CodeDeploy APIs to get, list, and register application revisions.

" } botocore-1.5.7/botocore/data/cloudwatch/0000777454262600001440000000000013042511307021270 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudwatch/2010-08-01/0000777454262600001440000000000013042511307022315 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudwatch/2010-08-01/paginators-1.json0000666454262600001440000000076313042511306025522 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeAlarmHistory": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxRecords", "result_key": "AlarmHistoryItems" }, "DescribeAlarms": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxRecords", "result_key": "MetricAlarms" }, "ListMetrics": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Metrics" } } } botocore-1.5.7/botocore/data/cloudwatch/2010-08-01/service-2.json0000666454262600001440000013644513042511306025023 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"monitoring-2010-08-01", "apiVersion":"2010-08-01", "endpointPrefix":"monitoring", "protocol":"query", "serviceAbbreviation":"CloudWatch", "serviceFullName":"Amazon CloudWatch", "signatureVersion":"v4", "xmlNamespace":"http://monitoring.amazonaws.com/doc/2010-08-01/" }, "operations":{ "DeleteAlarms":{ "name":"DeleteAlarms", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAlarmsInput"}, "errors":[ {"shape":"ResourceNotFound"} ], "documentation":"

Deletes the specified alarms. In the event of an error, no alarms are deleted.

" }, "DescribeAlarmHistory":{ "name":"DescribeAlarmHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAlarmHistoryInput"}, "output":{ "shape":"DescribeAlarmHistoryOutput", "resultWrapper":"DescribeAlarmHistoryResult" }, "errors":[ {"shape":"InvalidNextToken"} ], "documentation":"

Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for all alarms are returned.

Note that Amazon CloudWatch retains the history of an alarm even if you delete the alarm.

" }, "DescribeAlarms":{ "name":"DescribeAlarms", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAlarmsInput"}, "output":{ "shape":"DescribeAlarmsOutput", "resultWrapper":"DescribeAlarmsResult" }, "errors":[ {"shape":"InvalidNextToken"} ], "documentation":"

Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.

" }, "DescribeAlarmsForMetric":{ "name":"DescribeAlarmsForMetric", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAlarmsForMetricInput"}, "output":{ "shape":"DescribeAlarmsForMetricOutput", "resultWrapper":"DescribeAlarmsForMetricResult" }, "documentation":"

Retrieves the alarms for the specified metric. Specify a statistic, period, or unit to filter the results.

" }, "DisableAlarmActions":{ "name":"DisableAlarmActions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableAlarmActionsInput"}, "documentation":"

Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.

" }, "EnableAlarmActions":{ "name":"EnableAlarmActions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableAlarmActionsInput"}, "documentation":"

Enables the actions for the specified alarms.

" }, "GetMetricStatistics":{ "name":"GetMetricStatistics", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetMetricStatisticsInput"}, "output":{ "shape":"GetMetricStatisticsOutput", "resultWrapper":"GetMetricStatisticsResult" }, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"MissingRequiredParameterException"}, {"shape":"InvalidParameterCombinationException"}, {"shape":"InternalServiceFault"} ], "documentation":"

Gets statistics for the specified metric.

Amazon CloudWatch retains metric data as follows:

  • Data points with a period of 60 seconds (1 minute) are available for 15 days

  • Data points with a period of 300 seconds (5 minute) are available for 63 days

  • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months)

Note that CloudWatch started retaining 5-minute and 1-hour metric data as of 9 July 2016.

The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, Amazon CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. A period can be as short as one minute (60 seconds). Note that data points are not returned in chronological order.

Amazon CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, Amazon CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.

For a list of metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.

" }, "ListMetrics":{ "name":"ListMetrics", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListMetricsInput"}, "output":{ "shape":"ListMetricsOutput", "resultWrapper":"ListMetricsResult" }, "errors":[ {"shape":"InternalServiceFault"}, {"shape":"InvalidParameterValueException"} ], "documentation":"

List the specified metrics. You can use the returned metrics with GetMetricStatistics to obtain statistical data.

Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricStatistics.

" }, "PutMetricAlarm":{ "name":"PutMetricAlarm", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutMetricAlarmInput"}, "errors":[ {"shape":"LimitExceededFault"} ], "documentation":"

Creates or updates an alarm and associates it with the specified metric. Optionally, this operation can associate one or more Amazon SNS resources with the alarm.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is evaluated and its state is set appropriately. Any actions associated with the state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

If you are an AWS Identity and Access Management (IAM) user, you must have Amazon EC2 permissions for some operations:

  • ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance status metrics

  • ec2:StopInstances for alarms with stop actions

  • ec2:TerminateInstances for alarms with terminate actions

  • ec2:DescribeInstanceRecoveryAttribute and ec2:RecoverInstances for alarms with recover actions

If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions won't be performed. However, if you are later granted the required permissions, the alarm actions that you created earlier will be performed.

If you are using an IAM role (for example, an Amazon EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.

If you are using temporary security credentials granted using the AWS Security Token Service (AWS STS), you cannot stop or terminate an Amazon EC2 instance using alarm actions.

Note that you must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role. After this IAM role is created, you can create stop, terminate, or reboot alarms using a command-line interface or an API.

" }, "PutMetricData":{ "name":"PutMetricData", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutMetricDataInput"}, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"MissingRequiredParameterException"}, {"shape":"InvalidParameterCombinationException"}, {"shape":"InternalServiceFault"} ], "documentation":"

Publishes metric data points to Amazon CloudWatch. Amazon CloudWatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric. When Amazon CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.

Each PutMetricData request is limited to 8 KB in size for HTTP GET requests and is limited to 40 KB in size for HTTP POST requests.

Although the Value parameter accepts numbers of type Double, Amazon CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (e.g., NaN, +Infinity, -Infinity) are not supported.

Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricStatistics from the time they are submitted.

" }, "SetAlarmState":{ "name":"SetAlarmState", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetAlarmStateInput"}, "errors":[ {"shape":"ResourceNotFound"}, {"shape":"InvalidFormatFault"} ], "documentation":"

Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an Amazon SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens very quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

" } }, "shapes":{ "ActionPrefix":{ "type":"string", "max":1024, "min":1 }, "ActionsEnabled":{"type":"boolean"}, "AlarmArn":{ "type":"string", "max":1600, "min":1 }, "AlarmDescription":{ "type":"string", "max":1024, "min":0 }, "AlarmHistoryItem":{ "type":"structure", "members":{ "AlarmName":{ "shape":"AlarmName", "documentation":"

The descriptive name for the alarm.

" }, "Timestamp":{ "shape":"Timestamp", "documentation":"

The time stamp for the alarm history item.

" }, "HistoryItemType":{ "shape":"HistoryItemType", "documentation":"

The type of alarm history item.

" }, "HistorySummary":{ "shape":"HistorySummary", "documentation":"

A summary of the alarm history, in text format.

" }, "HistoryData":{ "shape":"HistoryData", "documentation":"

Data about the alarm, in JSON format.

" } }, "documentation":"

Represents the history of a specific alarm.

" }, "AlarmHistoryItems":{ "type":"list", "member":{"shape":"AlarmHistoryItem"} }, "AlarmName":{ "type":"string", "max":255, "min":1 }, "AlarmNamePrefix":{ "type":"string", "max":255, "min":1 }, "AlarmNames":{ "type":"list", "member":{"shape":"AlarmName"}, "max":100 }, "AwsQueryErrorMessage":{"type":"string"}, "ComparisonOperator":{ "type":"string", "enum":[ "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold" ] }, "Datapoint":{ "type":"structure", "members":{ "Timestamp":{ "shape":"Timestamp", "documentation":"

The time stamp used for the data point.

" }, "SampleCount":{ "shape":"DatapointValue", "documentation":"

The number of metric values that contributed to the aggregate value of this data point.

" }, "Average":{ "shape":"DatapointValue", "documentation":"

The average of the metric values that correspond to the data point.

" }, "Sum":{ "shape":"DatapointValue", "documentation":"

The sum of the metric values for the data point.

" }, "Minimum":{ "shape":"DatapointValue", "documentation":"

The minimum metric value for the data point.

" }, "Maximum":{ "shape":"DatapointValue", "documentation":"

The maximum metric value for the data point.

" }, "Unit":{ "shape":"StandardUnit", "documentation":"

The standard unit for the data point.

" }, "ExtendedStatistics":{ "shape":"DatapointValueMap", "documentation":"

The percentile statistic for the data point.

" } }, "documentation":"

Encapsulates the statistical data that Amazon CloudWatch computes from metric data.

", "xmlOrder":[ "Timestamp", "SampleCount", "Average", "Sum", "Minimum", "Maximum", "Unit", "ExtendedStatistics" ] }, "DatapointValue":{"type":"double"}, "DatapointValueMap":{ "type":"map", "key":{"shape":"ExtendedStatistic"}, "value":{"shape":"DatapointValue"} }, "Datapoints":{ "type":"list", "member":{"shape":"Datapoint"} }, "DeleteAlarmsInput":{ "type":"structure", "required":["AlarmNames"], "members":{ "AlarmNames":{ "shape":"AlarmNames", "documentation":"

The alarms to be deleted.

" } } }, "DescribeAlarmHistoryInput":{ "type":"structure", "members":{ "AlarmName":{ "shape":"AlarmName", "documentation":"

The name of the alarm.

" }, "HistoryItemType":{ "shape":"HistoryItemType", "documentation":"

The type of alarm histories to retrieve.

" }, "StartDate":{ "shape":"Timestamp", "documentation":"

The starting date to retrieve alarm history.

" }, "EndDate":{ "shape":"Timestamp", "documentation":"

The ending date to retrieve alarm history.

" }, "MaxRecords":{ "shape":"MaxRecords", "documentation":"

The maximum number of alarm history records to retrieve.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

" } } }, "DescribeAlarmHistoryOutput":{ "type":"structure", "members":{ "AlarmHistoryItems":{ "shape":"AlarmHistoryItems", "documentation":"

The alarm histories, in JSON format.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token that marks the start of the next batch of returned results.

" } } }, "DescribeAlarmsForMetricInput":{ "type":"structure", "required":[ "MetricName", "Namespace" ], "members":{ "MetricName":{ "shape":"MetricName", "documentation":"

The name of the metric.

" }, "Namespace":{ "shape":"Namespace", "documentation":"

The namespace of the metric.

" }, "Statistic":{ "shape":"Statistic", "documentation":"

The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.

" }, "ExtendedStatistic":{ "shape":"ExtendedStatistic", "documentation":"

The percentile statistic for the metric. Specify a value between p0.0 and p100.

" }, "Dimensions":{ "shape":"Dimensions", "documentation":"

The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.

" }, "Period":{ "shape":"Period", "documentation":"

The period, in seconds, over which the statistic is applied.

" }, "Unit":{ "shape":"StandardUnit", "documentation":"

The unit for the metric.

" } } }, "DescribeAlarmsForMetricOutput":{ "type":"structure", "members":{ "MetricAlarms":{ "shape":"MetricAlarms", "documentation":"

The information for each alarm with the specified metric.

" } } }, "DescribeAlarmsInput":{ "type":"structure", "members":{ "AlarmNames":{ "shape":"AlarmNames", "documentation":"

The names of the alarms.

" }, "AlarmNamePrefix":{ "shape":"AlarmNamePrefix", "documentation":"

The alarm name prefix. You cannot specify AlarmNames if this parameter is specified.

" }, "StateValue":{ "shape":"StateValue", "documentation":"

The state value to be used in matching alarms.

" }, "ActionPrefix":{ "shape":"ActionPrefix", "documentation":"

The action name prefix.

" }, "MaxRecords":{ "shape":"MaxRecords", "documentation":"

The maximum number of alarm descriptions to retrieve.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

" } } }, "DescribeAlarmsOutput":{ "type":"structure", "members":{ "MetricAlarms":{ "shape":"MetricAlarms", "documentation":"

The information for the specified alarms.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token that marks the start of the next batch of returned results.

" } } }, "Dimension":{ "type":"structure", "required":[ "Name", "Value" ], "members":{ "Name":{ "shape":"DimensionName", "documentation":"

The name of the dimension.

" }, "Value":{ "shape":"DimensionValue", "documentation":"

The value representing the dimension measurement.

" } }, "documentation":"

Expands the identity of a metric.

", "xmlOrder":[ "Name", "Value" ] }, "DimensionFilter":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DimensionName", "documentation":"

The dimension name to be matched.

" }, "Value":{ "shape":"DimensionValue", "documentation":"

The value of the dimension to be matched.

" } }, "documentation":"

Represents filters for a dimension.

" }, "DimensionFilters":{ "type":"list", "member":{"shape":"DimensionFilter"}, "max":10 }, "DimensionName":{ "type":"string", "max":255, "min":1 }, "DimensionValue":{ "type":"string", "max":255, "min":1 }, "Dimensions":{ "type":"list", "member":{"shape":"Dimension"}, "max":10 }, "DisableAlarmActionsInput":{ "type":"structure", "required":["AlarmNames"], "members":{ "AlarmNames":{ "shape":"AlarmNames", "documentation":"

The names of the alarms.

" } } }, "EnableAlarmActionsInput":{ "type":"structure", "required":["AlarmNames"], "members":{ "AlarmNames":{ "shape":"AlarmNames", "documentation":"

The names of the alarms.

" } } }, "ErrorMessage":{ "type":"string", "max":255, "min":1 }, "EvaluationPeriods":{ "type":"integer", "min":1 }, "ExtendedStatistic":{ "type":"string", "pattern":"p(\\d{1,2}(\\.\\d{0,2})?|100)" }, "ExtendedStatistics":{ "type":"list", "member":{"shape":"ExtendedStatistic"}, "max":10, "min":1 }, "FaultDescription":{"type":"string"}, "GetMetricStatisticsInput":{ "type":"structure", "required":[ "Namespace", "MetricName", "StartTime", "EndTime", "Period" ], "members":{ "Namespace":{ "shape":"Namespace", "documentation":"

The namespace of the metric, with or without spaces.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

The name of the metric, with or without spaces.

" }, "Dimensions":{ "shape":"Dimensions", "documentation":"

The dimensions. CloudWatch treats each unique combination of dimensions as a separate metric. You can't retrieve statistics using combinations of dimensions that were not specially published. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide.

" }, "StartTime":{ "shape":"Timestamp", "documentation":"

The time stamp that determines the first data point to return. Note that start times are evaluated relative to the time that CloudWatch receives the request.

The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

CloudWatch rounds the specified time stamp as follows:

  • Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

  • Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

  • Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

" }, "EndTime":{ "shape":"Timestamp", "documentation":"

The time stamp that determines the last data point to return.

The value specified is exclusive; results will include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

" }, "Period":{ "shape":"Period", "documentation":"

The granularity, in seconds, of the returned data points. A period can be as short as one minute (60 seconds) and must be a multiple of 60. The default value is 60.

If the StartTime parameter specifies a time stamp that is greater than 15 days ago, you must specify the period as follows or no data points in that time range is returned:

  • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

  • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

" }, "Statistics":{ "shape":"Statistics", "documentation":"

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistic.

" }, "ExtendedStatistics":{ "shape":"ExtendedStatistics", "documentation":"

The percentile statistics. Specify values between p0.0 and p100.

" }, "Unit":{ "shape":"StandardUnit", "documentation":"

The unit for a given metric. Metrics may be reported in multiple units. Not supplying a unit results in all units being returned. If the metric only ever reports one unit, specifying a unit has no effect.

" } } }, "GetMetricStatisticsOutput":{ "type":"structure", "members":{ "Label":{ "shape":"MetricLabel", "documentation":"

A label for the specified metric.

" }, "Datapoints":{ "shape":"Datapoints", "documentation":"

The data points for the specified metric.

" } } }, "HistoryData":{ "type":"string", "max":4095, "min":1 }, "HistoryItemType":{ "type":"string", "enum":[ "ConfigurationUpdate", "StateUpdate", "Action" ] }, "HistorySummary":{ "type":"string", "max":255, "min":1 }, "InternalServiceFault":{ "type":"structure", "members":{ "Message":{ "shape":"FaultDescription", "documentation":"

" } }, "documentation":"

Request processing has failed due to some unknown error, exception, or failure.

", "error":{ "code":"InternalServiceError", "httpStatusCode":500 }, "exception":true, "xmlOrder":["Message"] }, "InvalidFormatFault":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

" } }, "documentation":"

Data was not syntactically valid JSON.

", "error":{ "code":"InvalidFormat", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidNextToken":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

" } }, "documentation":"

The next token specified is invalid.

", "error":{ "code":"InvalidNextToken", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidParameterCombinationException":{ "type":"structure", "members":{ "message":{ "shape":"AwsQueryErrorMessage", "documentation":"

" } }, "documentation":"

Parameters that cannot be used together were used together.

", "error":{ "code":"InvalidParameterCombination", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidParameterValueException":{ "type":"structure", "members":{ "message":{ "shape":"AwsQueryErrorMessage", "documentation":"

" } }, "documentation":"

The value of an input parameter is bad or out-of-range.

", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true }, "LimitExceededFault":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

" } }, "documentation":"

The quota for alarms for this customer has already been reached.

", "error":{ "code":"LimitExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ListMetricsInput":{ "type":"structure", "members":{ "Namespace":{ "shape":"Namespace", "documentation":"

The namespace to filter against.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

The name of the metric to filter against.

" }, "Dimensions":{ "shape":"DimensionFilters", "documentation":"

The dimensions to filter against.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

" } } }, "ListMetricsOutput":{ "type":"structure", "members":{ "Metrics":{ "shape":"Metrics", "documentation":"

The metrics.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token that marks the start of the next batch of returned results.

" } }, "xmlOrder":[ "Metrics", "NextToken" ] }, "MaxRecords":{ "type":"integer", "max":100, "min":1 }, "Metric":{ "type":"structure", "members":{ "Namespace":{ "shape":"Namespace", "documentation":"

The namespace of the metric.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

The name of the metric.

" }, "Dimensions":{ "shape":"Dimensions", "documentation":"

The dimensions for the metric.

" } }, "documentation":"

Represents a specific metric.

", "xmlOrder":[ "Namespace", "MetricName", "Dimensions" ] }, "MetricAlarm":{ "type":"structure", "members":{ "AlarmName":{ "shape":"AlarmName", "documentation":"

The name of the alarm.

" }, "AlarmArn":{ "shape":"AlarmArn", "documentation":"

The Amazon Resource Name (ARN) of the alarm.

" }, "AlarmDescription":{ "shape":"AlarmDescription", "documentation":"

The description of the alarm.

" }, "AlarmConfigurationUpdatedTimestamp":{ "shape":"Timestamp", "documentation":"

The time stamp of the last update to the alarm configuration.

" }, "ActionsEnabled":{ "shape":"ActionsEnabled", "documentation":"

Indicates whether actions should be executed during any changes to the alarm state.

" }, "OKActions":{ "shape":"ResourceList", "documentation":"

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

" }, "AlarmActions":{ "shape":"ResourceList", "documentation":"

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

" }, "InsufficientDataActions":{ "shape":"ResourceList", "documentation":"

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

" }, "StateValue":{ "shape":"StateValue", "documentation":"

The state value for the alarm.

" }, "StateReason":{ "shape":"StateReason", "documentation":"

An explanation for the alarm state, in text format.

" }, "StateReasonData":{ "shape":"StateReasonData", "documentation":"

An explanation for the alarm state, in JSON format.

" }, "StateUpdatedTimestamp":{ "shape":"Timestamp", "documentation":"

The time stamp of the last update to the alarm state.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

The name of the metric associated with the alarm.

" }, "Namespace":{ "shape":"Namespace", "documentation":"

The namespace of the metric associated with the alarm.

" }, "Statistic":{ "shape":"Statistic", "documentation":"

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

" }, "ExtendedStatistic":{ "shape":"ExtendedStatistic", "documentation":"

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

" }, "Dimensions":{ "shape":"Dimensions", "documentation":"

The dimensions for the metric associated with the alarm.

" }, "Period":{ "shape":"Period", "documentation":"

The period, in seconds, over which the statistic is applied.

" }, "Unit":{ "shape":"StandardUnit", "documentation":"

The unit of the metric associated with the alarm.

" }, "EvaluationPeriods":{ "shape":"EvaluationPeriods", "documentation":"

The number of periods over which data is compared to the specified threshold.

" }, "Threshold":{ "shape":"Threshold", "documentation":"

The value to compare with the specified statistic.

" }, "ComparisonOperator":{ "shape":"ComparisonOperator", "documentation":"

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

" } }, "documentation":"

Represents an alarm.

", "xmlOrder":[ "AlarmName", "AlarmArn", "AlarmDescription", "AlarmConfigurationUpdatedTimestamp", "ActionsEnabled", "OKActions", "AlarmActions", "InsufficientDataActions", "StateValue", "StateReason", "StateReasonData", "StateUpdatedTimestamp", "MetricName", "Namespace", "Statistic", "Dimensions", "Period", "Unit", "EvaluationPeriods", "Threshold", "ComparisonOperator", "ExtendedStatistic" ] }, "MetricAlarms":{ "type":"list", "member":{"shape":"MetricAlarm"} }, "MetricData":{ "type":"list", "member":{"shape":"MetricDatum"} }, "MetricDatum":{ "type":"structure", "required":["MetricName"], "members":{ "MetricName":{ "shape":"MetricName", "documentation":"

The name of the metric.

" }, "Dimensions":{ "shape":"Dimensions", "documentation":"

The dimensions associated with the metric.

" }, "Timestamp":{ "shape":"Timestamp", "documentation":"

The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

" }, "Value":{ "shape":"DatapointValue", "documentation":"

The value for the metric.

Although the parameter accepts numbers of type Double, Amazon CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

" }, "StatisticValues":{ "shape":"StatisticSet", "documentation":"

The statistical values for the metric.

" }, "Unit":{ "shape":"StandardUnit", "documentation":"

The unit of the metric.

" } }, "documentation":"

Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.

" }, "MetricLabel":{"type":"string"}, "MetricName":{ "type":"string", "max":255, "min":1 }, "Metrics":{ "type":"list", "member":{"shape":"Metric"} }, "MissingRequiredParameterException":{ "type":"structure", "members":{ "message":{ "shape":"AwsQueryErrorMessage", "documentation":"

" } }, "documentation":"

An input parameter that is required is missing.

", "error":{ "code":"MissingParameter", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Namespace":{ "type":"string", "max":255, "min":1, "pattern":"[^:].*" }, "NextToken":{ "type":"string", "max":1024, "min":0 }, "Period":{ "type":"integer", "min":60 }, "PutMetricAlarmInput":{ "type":"structure", "required":[ "AlarmName", "MetricName", "Namespace", "Period", "EvaluationPeriods", "Threshold", "ComparisonOperator" ], "members":{ "AlarmName":{ "shape":"AlarmName", "documentation":"

The name for the alarm. This name must be unique within the AWS account.

" }, "AlarmDescription":{ "shape":"AlarmDescription", "documentation":"

The description for the alarm.

" }, "ActionsEnabled":{ "shape":"ActionsEnabled", "documentation":"

Indicates whether actions should be executed during any changes to the alarm state.

" }, "OKActions":{ "shape":"ResourceList", "documentation":"

The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0

" }, "AlarmActions":{ "shape":"ResourceList", "documentation":"

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0

" }, "InsufficientDataActions":{ "shape":"ResourceList", "documentation":"

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0

" }, "MetricName":{ "shape":"MetricName", "documentation":"

The name for the metric associated with the alarm.

" }, "Namespace":{ "shape":"Namespace", "documentation":"

The namespace for the metric associated with the alarm.

" }, "Statistic":{ "shape":"Statistic", "documentation":"

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

" }, "ExtendedStatistic":{ "shape":"ExtendedStatistic", "documentation":"

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

" }, "Dimensions":{ "shape":"Dimensions", "documentation":"

The dimensions for the metric associated with the alarm.

" }, "Period":{ "shape":"Period", "documentation":"

The period, in seconds, over which the specified statistic is applied.

" }, "Unit":{ "shape":"StandardUnit", "documentation":"

The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.

If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the Amazon CloudWatch alarm can get stuck in the INSUFFICIENT DATA state.

" }, "EvaluationPeriods":{ "shape":"EvaluationPeriods", "documentation":"

The number of periods over which data is compared to the specified threshold.

" }, "Threshold":{ "shape":"Threshold", "documentation":"

The value against which the specified statistic is compared.

" }, "ComparisonOperator":{ "shape":"ComparisonOperator", "documentation":"

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

" } } }, "PutMetricDataInput":{ "type":"structure", "required":[ "Namespace", "MetricData" ], "members":{ "Namespace":{ "shape":"Namespace", "documentation":"

The namespace for the metric data.

You cannot specify a namespace that begins with \"AWS/\". Namespaces that begin with \"AWS/\" are reserved for use by Amazon Web Services products.

" }, "MetricData":{ "shape":"MetricData", "documentation":"

The data for the metric.

" } } }, "ResourceList":{ "type":"list", "member":{"shape":"ResourceName"}, "max":5 }, "ResourceName":{ "type":"string", "max":1024, "min":1 }, "ResourceNotFound":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

" } }, "documentation":"

The named resource does not exist.

", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "SetAlarmStateInput":{ "type":"structure", "required":[ "AlarmName", "StateValue", "StateReason" ], "members":{ "AlarmName":{ "shape":"AlarmName", "documentation":"

The name for the alarm. This name must be unique within the AWS account. The maximum length is 255 characters.

" }, "StateValue":{ "shape":"StateValue", "documentation":"

The value of the state.

" }, "StateReason":{ "shape":"StateReason", "documentation":"

The reason that this alarm is set to this specific state, in text format.

" }, "StateReasonData":{ "shape":"StateReasonData", "documentation":"

The reason that this alarm is set to this specific state, in JSON format.

" } } }, "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" ] }, "StateReason":{ "type":"string", "max":1023, "min":0 }, "StateReasonData":{ "type":"string", "max":4000, "min":0 }, "StateValue":{ "type":"string", "enum":[ "OK", "ALARM", "INSUFFICIENT_DATA" ] }, "Statistic":{ "type":"string", "enum":[ "SampleCount", "Average", "Sum", "Minimum", "Maximum" ] }, "StatisticSet":{ "type":"structure", "required":[ "SampleCount", "Sum", "Minimum", "Maximum" ], "members":{ "SampleCount":{ "shape":"DatapointValue", "documentation":"

The number of samples used for the statistic set.

" }, "Sum":{ "shape":"DatapointValue", "documentation":"

The sum of values for the sample set.

" }, "Minimum":{ "shape":"DatapointValue", "documentation":"

The minimum value of the sample set.

" }, "Maximum":{ "shape":"DatapointValue", "documentation":"

The maximum value of the sample set.

" } }, "documentation":"

Represents a set of statistics that describes a specific metric.

" }, "Statistics":{ "type":"list", "member":{"shape":"Statistic"}, "max":5, "min":1 }, "Threshold":{"type":"double"}, "Timestamp":{"type":"timestamp"} }, "documentation":"

Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real-time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.

CloudWatch alarms send notifications or automatically make changes to the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon Elastic Compute Cloud (Amazon EC2) instances and then use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.

In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.

" } botocore-1.5.7/botocore/data/kinesis/0000777454262600001440000000000013042511307020600 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/kinesis/2013-12-02/0000777454262600001440000000000013042511307021624 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/kinesis/2013-12-02/waiters-2.json0000666454262600001440000000114713042511306024336 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "StreamExists": { "delay": 10, "operation": "DescribeStream", "maxAttempts": 18, "acceptors": [ { "expected": "ACTIVE", "matcher": "path", "state": "success", "argument": "StreamDescription.StreamStatus" } ] }, "StreamNotExists": { "delay": 10, "operation": "DescribeStream", "maxAttempts": 18, "acceptors": [ { "expected": "ResourceNotFoundException", "matcher": "error", "state": "success" } ] } } } botocore-1.5.7/botocore/data/kinesis/2013-12-02/paginators-1.json0000666454262600001440000000140513042511306025023 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeStream": { "input_token": "ExclusiveStartShardId", "limit_key": "Limit", "more_results": "StreamDescription.HasMoreShards", "output_token": "StreamDescription.Shards[-1].ShardId", "result_key": "StreamDescription.Shards", "non_aggregate_keys": [ "StreamDescription.StreamARN", "StreamDescription.StreamName", "StreamDescription.StreamStatus", "StreamDescription.RetentionPeriodHours", "StreamDescription.EnhancedMonitoring" ] }, "ListStreams": { "input_token": "ExclusiveStartStreamName", "limit_key": "Limit", "more_results": "HasMoreStreams", "output_token": "StreamNames[-1]", "result_key": "StreamNames" } } } botocore-1.5.7/botocore/data/kinesis/2013-12-02/service-2.json0000666454262600001440000022643613042511306024332 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"kinesis-2013-12-02", "apiVersion":"2013-12-02", "endpointPrefix":"kinesis", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"Kinesis", "serviceFullName":"Amazon Kinesis", "signatureVersion":"v4", "targetPrefix":"Kinesis_20131202" }, "operations":{ "AddTagsToStream":{ "name":"AddTagsToStream", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsToStreamInput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidArgumentException"}, {"shape":"LimitExceededException"} ], "documentation":"

Adds or updates tags for the specified Amazon Kinesis stream. Each stream can have up to 10 tags.

If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys.

" }, "CreateStream":{ "name":"CreateStream", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateStreamInput"}, "errors":[ {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidArgumentException"} ], "documentation":"

Creates an Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.

You specify and control the number of shards that a stream is composed of. Each shard can support reads up to 5 transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. 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.

The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. 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.

CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Amazon Kinesis immediately returns and sets the stream status to CREATING. After the stream is created, Amazon Kinesis sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream.

You receive a LimitExceededException when making a CreateStream request if you try to do one of the following:

  • Have more than five streams in the CREATING state at any point in time.

  • Create more shards than are authorized for your account.

For the default shard limit for an AWS account, see Streams Limits in the Amazon Kinesis Streams Developer Guide. If you need to increase this limit, contact AWS Support.

You can use DescribeStream to check the stream status, which is returned in StreamStatus.

CreateStream has a limit of 5 transactions per second per account.

" }, "DecreaseStreamRetentionPeriod":{ "name":"DecreaseStreamRetentionPeriod", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DecreaseStreamRetentionPeriodInput"}, "errors":[ {"shape":"ResourceInUseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidArgumentException"} ], "documentation":"

Decreases the Amazon Kinesis stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.

This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.

" }, "DeleteStream":{ "name":"DeleteStream", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteStreamInput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

Deletes an Amazon Kinesis stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it will receive the exception ResourceNotFoundException.

If the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specified stream is in the DELETING state until Amazon Kinesis completes the deletion.

Note: Amazon Kinesis might continue to accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the DELETING state until the stream deletion is complete.

When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.

You can use the DescribeStream operation to check the state of the stream, which is returned in StreamStatus.

DeleteStream has a limit of 5 transactions per second per account.

" }, "DescribeLimits":{ "name":"DescribeLimits", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLimitsInput"}, "output":{"shape":"DescribeLimitsOutput"}, "errors":[ {"shape":"LimitExceededException"} ], "documentation":"

Describes the shard limits and usage for the account.

If you update your account limits, the old limits might be returned for a few minutes.

This operation has a limit of 1 transaction per second per account.

" }, "DescribeStream":{ "name":"DescribeStream", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStreamInput"}, "output":{"shape":"DescribeStreamOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

Describes the specified Amazon Kinesis stream.

The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.

You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream in the Amazon Kinesis Streams Developer Guide.

There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.

This operation has a limit of 10 transactions per second per account.

" }, "DisableEnhancedMonitoring":{ "name":"DisableEnhancedMonitoring", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableEnhancedMonitoringInput"}, "output":{"shape":"EnhancedMonitoringOutput"}, "errors":[ {"shape":"InvalidArgumentException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceInUseException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Disables enhanced monitoring.

" }, "EnableEnhancedMonitoring":{ "name":"EnableEnhancedMonitoring", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableEnhancedMonitoringInput"}, "output":{"shape":"EnhancedMonitoringOutput"}, "errors":[ {"shape":"InvalidArgumentException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceInUseException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Enables enhanced Amazon Kinesis stream monitoring for shard-level metrics.

" }, "GetRecords":{ "name":"GetRecords", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRecordsInput"}, "output":{"shape":"GetRecordsOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidArgumentException"}, {"shape":"ProvisionedThroughputExceededException"}, {"shape":"ExpiredIteratorException"} ], "documentation":"

Gets data records from an Amazon Kinesis stream's shard.

Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains records.

You can scale by provisioning multiple shards per stream while considering service limits (for more information, see Streams Limits in the Amazon Kinesis Streams Developer Guide). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in NextShardIterator. Specify the shard iterator returned in NextShardIterator in subsequent calls to GetRecords. Note that if the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.

Each data record can be up to 1 MB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit.

The size of the data returned by GetRecords varies depending on the utilization of the shard. The maximum size of data that GetRecords can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw ProvisionedThroughputExceededException. If there is insufficient provisioned throughput on the shard, subsequent calls made within the next 1 second throw ProvisionedThroughputExceededException. Note that GetRecords won't return any data when it throws an exception. For this reason, we recommend that you wait one second between calls to GetRecords; however, it's possible that the application will get exceptions for longer than 1 second.

To detect whether the application is falling behind in processing, you can use the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon Kinesis Streams Developer Guide).

Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side timestamp, whereas a client-side timestamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with PutRecords). The timestamp has millisecond precision. There are no guarantees about the timestamp accuracy, or that the timestamp is always increasing. For example, records in a shard or across a stream might have timestamps that are out of order.

" }, "GetShardIterator":{ "name":"GetShardIterator", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetShardIteratorInput"}, "output":{"shape":"GetShardIteratorOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidArgumentException"}, {"shape":"ProvisionedThroughputExceededException"} ], "documentation":"

Gets an Amazon Kinesis shard iterator. A shard iterator expires five minutes after it is returned to the requester.

A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.

You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type, or right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier calls to PutRecord, PutRecords, GetRecords, or DescribeStream. In the request, you can specify the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in time, TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or LATEST so that you always read the most recent data in the shard.

When you read repeatedly from a stream, use a GetShardIterator request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard iterator is returned by every GetRecords request in NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords request.

If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException. For more information about throughput limits, see GetRecords, and Streams Limits in the Amazon Kinesis Streams Developer Guide.

If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. Note that a shard can be closed as a result of using SplitShard or MergeShards.

GetShardIterator has a limit of 5 transactions per second per account per open shard.

" }, "IncreaseStreamRetentionPeriod":{ "name":"IncreaseStreamRetentionPeriod", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"IncreaseStreamRetentionPeriodInput"}, "errors":[ {"shape":"ResourceInUseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidArgumentException"} ], "documentation":"

Increases the Amazon Kinesis stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours (7 days).

Upon choosing a longer stream retention period, this operation will increase the time period records are accessible that have not yet expired. However, it will not make previous data that has expired (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours will remain inaccessible to consumer applications.

" }, "ListStreams":{ "name":"ListStreams", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListStreamsInput"}, "output":{"shape":"ListStreamsOutput"}, "errors":[ {"shape":"LimitExceededException"} ], "documentation":"

Lists your Amazon Kinesis streams.

The number of streams may be too large to return from a single call to ListStreams. You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Amazon Kinesis uses the default limit, which is currently 10.

You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list.

ListStreams has a limit of 5 transactions per second per account.

" }, "ListTagsForStream":{ "name":"ListTagsForStream", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForStreamInput"}, "output":{"shape":"ListTagsForStreamOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidArgumentException"}, {"shape":"LimitExceededException"} ], "documentation":"

Lists the tags for the specified Amazon Kinesis stream.

" }, "MergeShards":{ "name":"MergeShards", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MergeShardsInput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidArgumentException"}, {"shape":"LimitExceededException"} ], "documentation":"

Merges two adjacent shards in an Amazon Kinesis stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. 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, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.

MergeShards is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see Merge Two Shards in the Amazon Kinesis Streams Developer Guide.

If the stream is in the ACTIVE state, you can call MergeShards. If a stream is in the CREATING, UPDATING, or DELETING state, MergeShards returns a ResourceInUseException. If the specified stream does not exist, MergeShards returns a ResourceNotFoundException.

You can use DescribeStream to check the state of the stream, which is returned in StreamStatus.

MergeShards is an asynchronous operation. Upon receiving a MergeShards request, Amazon Kinesis immediately returns a response and sets the StreamStatus to UPDATING. After the operation is completed, Amazon Kinesis sets the StreamStatus to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.

You use DescribeStream to determine the shard IDs that are specified in the MergeShards request.

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards or SplitShard, you will receive a LimitExceededException.

MergeShards has limit of 5 transactions per second per account.

" }, "PutRecord":{ "name":"PutRecord", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutRecordInput"}, "output":{"shape":"PutRecordOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidArgumentException"}, {"shape":"ProvisionedThroughputExceededException"} ], "documentation":"

Writes a single data record into an Amazon Kinesis stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to.

Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Streams Developer Guide.

PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.

Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Streams Developer Guide.

If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException.

Data records are accessible for only 24 hours from the time that they are added to a stream.

" }, "PutRecords":{ "name":"PutRecords", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutRecordsInput"}, "output":{"shape":"PutRecordsOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidArgumentException"}, {"shape":"ProvisionedThroughputExceededException"} ], "documentation":"

Writes multiple data records into an Amazon Kinesis stream in a single call (also referred to as a PutRecords request). Use this operation to send data into the stream for data ingestion and processing.

Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

The partition key is used by Amazon Kinesis as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Streams Developer Guide.

Each record in the Records array may include an optional parameter, ExplicitHashKey, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Streams Developer Guide.

The PutRecords response includes an array of response Records. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array.

The response Records array includes both successfully and unsuccessfully processed records. Amazon Kinesis attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records.

A successfully-processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream.

An unsuccessfully-processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Streams Developer Guide.

By default, data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream. This retention period can be modified using the DecreaseStreamRetentionPeriod and IncreaseStreamRetentionPeriod operations.

" }, "RemoveTagsFromStream":{ "name":"RemoveTagsFromStream", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTagsFromStreamInput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidArgumentException"}, {"shape":"LimitExceededException"} ], "documentation":"

Removes tags from the specified Amazon Kinesis stream. Removed tags are deleted and cannot be recovered after this operation successfully completes.

If you specify a tag that does not exist, it is ignored.

" }, "SplitShard":{ "name":"SplitShard", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SplitShardInput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidArgumentException"}, {"shape":"LimitExceededException"} ], "documentation":"

Splits a shard into two new shards in the Amazon Kinesis stream to increase the stream's capacity to ingest and transport data. SplitShard is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested.

You can also use SplitShard when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call SplitShard to increase stream capacity, so that more Amazon Kinesis applications can simultaneously read data from the stream for real-time processing.

You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might simply be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information about splitting shards, see Split a Shard in the Amazon Kinesis Streams Developer Guide.

You can use DescribeStream to determine the shard ID and hash key values for the ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request.

SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Amazon Kinesis immediately returns a response and sets the stream status to UPDATING. After the operation is completed, Amazon Kinesis sets the stream status to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.

You can use DescribeStream to check the status of the stream, which is returned in StreamStatus. If the stream is in the ACTIVE state, you can call SplitShard. If a stream is in CREATING or UPDATING or DELETING states, DescribeStream returns a ResourceInUseException.

If the specified stream does not exist, DescribeStream returns a ResourceNotFoundException. If you try to create more shards than are authorized for your account, you receive a LimitExceededException.

For the default shard limit for an AWS account, see Streams Limits in the Amazon Kinesis Streams Developer Guide. If you need to increase this limit, contact AWS Support.

If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException.

SplitShard has limit of 5 transactions per second per account.

" }, "UpdateShardCount":{ "name":"UpdateShardCount", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateShardCountInput"}, "output":{"shape":"UpdateShardCountOutput"}, "errors":[ {"shape":"InvalidArgumentException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceInUseException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates the shard count of the specified stream to the specified number of shards.

Updating the shard count is an asynchronous operation. Upon receiving the request, Amazon Kinesis returns immediately and sets the status of the stream to UPDATING. After the update is complete, Amazon Kinesis sets the status of the stream back to ACTIVE. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is UPDATING.

To update the shard count, Amazon Kinesis performs splits and merges and individual shards. This can cause short-lived shards to be created, in addition to the final shards. We recommend that you double or halve the shard count, as this results in the fewest number of splits or merges.

This operation has a rate limit of twice per rolling 24 hour period. You cannot scale above double your current shard count, scale below half your current shard count, or exceed the shard limits for your account.

For the default limits for an AWS account, see Streams Limits in the Amazon Kinesis Streams Developer Guide. If you need to increase a limit, contact AWS Support.

" } }, "shapes":{ "AddTagsToStreamInput":{ "type":"structure", "required":[ "StreamName", "Tags" ], "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the stream.

" }, "Tags":{ "shape":"TagMap", "documentation":"

The set of key-value pairs to use to create the tags.

" } }, "documentation":"

Represents the input for AddTagsToStream.

" }, "BooleanObject":{"type":"boolean"}, "CreateStreamInput":{ "type":"structure", "required":[ "StreamName", "ShardCount" ], "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream. It is also scoped by region. That is, two streams in two different AWS accounts can have the same name, and two streams in the same AWS account but in two different regions can have the same name.

" }, "ShardCount":{ "shape":"PositiveIntegerObject", "documentation":"

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 provisioned throughput.

DefaultShardLimit;

" } }, "documentation":"

Represents the input for CreateStream.

" }, "Data":{ "type":"blob", "max":1048576, "min":0 }, "DecreaseStreamRetentionPeriodInput":{ "type":"structure", "required":[ "StreamName", "RetentionPeriodHours" ], "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the stream to modify.

" }, "RetentionPeriodHours":{ "shape":"PositiveIntegerObject", "documentation":"

The new retention period of the stream, in hours. Must be less than the current retention period.

" } }, "documentation":"

Represents the input for DecreaseStreamRetentionPeriod.

" }, "DeleteStreamInput":{ "type":"structure", "required":["StreamName"], "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the stream to delete.

" } }, "documentation":"

Represents the input for DeleteStream.

" }, "DescribeLimitsInput":{ "type":"structure", "members":{ } }, "DescribeLimitsOutput":{ "type":"structure", "required":[ "ShardLimit", "OpenShardCount" ], "members":{ "ShardLimit":{ "shape":"ShardCountObject", "documentation":"

The maximum number of shards.

" }, "OpenShardCount":{ "shape":"ShardCountObject", "documentation":"

The number of open shards.

" } } }, "DescribeStreamInput":{ "type":"structure", "required":["StreamName"], "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the stream to describe.

" }, "Limit":{ "shape":"DescribeStreamInputLimit", "documentation":"

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

" }, "ExclusiveStartShardId":{ "shape":"ShardId", "documentation":"

The shard ID of the shard to start with.

" } }, "documentation":"

Represents the input for DescribeStream.

" }, "DescribeStreamInputLimit":{ "type":"integer", "max":10000, "min":1 }, "DescribeStreamOutput":{ "type":"structure", "required":["StreamDescription"], "members":{ "StreamDescription":{ "shape":"StreamDescription", "documentation":"

The current status of the stream, the stream ARN, an array of shard objects that comprise the stream, and whether there are more shards available.

" } }, "documentation":"

Represents the output for DescribeStream.

" }, "DisableEnhancedMonitoringInput":{ "type":"structure", "required":[ "StreamName", "ShardLevelMetrics" ], "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the Amazon Kinesis stream for which to disable enhanced monitoring.

" }, "ShardLevelMetrics":{ "shape":"MetricsNameList", "documentation":"

List of shard-level metrics to disable.

The following are the valid shard-level metrics. The value \"ALL\" disables every metric.

  • IncomingBytes

  • IncomingRecords

  • OutgoingBytes

  • OutgoingRecords

  • WriteProvisionedThroughputExceeded

  • ReadProvisionedThroughputExceeded

  • IteratorAgeMilliseconds

  • ALL

For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.

" } }, "documentation":"

Represents the input for DisableEnhancedMonitoring.

" }, "EnableEnhancedMonitoringInput":{ "type":"structure", "required":[ "StreamName", "ShardLevelMetrics" ], "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the stream for which to enable enhanced monitoring.

" }, "ShardLevelMetrics":{ "shape":"MetricsNameList", "documentation":"

List of shard-level metrics to enable.

The following are the valid shard-level metrics. The value \"ALL\" enables every metric.

  • IncomingBytes

  • IncomingRecords

  • OutgoingBytes

  • OutgoingRecords

  • WriteProvisionedThroughputExceeded

  • ReadProvisionedThroughputExceeded

  • IteratorAgeMilliseconds

  • ALL

For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.

" } }, "documentation":"

Represents the input for EnableEnhancedMonitoring.

" }, "EnhancedMetrics":{ "type":"structure", "members":{ "ShardLevelMetrics":{ "shape":"MetricsNameList", "documentation":"

List of shard-level metrics.

The following are the valid shard-level metrics. The value \"ALL\" enhances every metric.

  • IncomingBytes

  • IncomingRecords

  • OutgoingBytes

  • OutgoingRecords

  • WriteProvisionedThroughputExceeded

  • ReadProvisionedThroughputExceeded

  • IteratorAgeMilliseconds

  • ALL

For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch in the Amazon Kinesis Streams Developer Guide.

" } }, "documentation":"

Represents enhanced metrics types.

" }, "EnhancedMonitoringList":{ "type":"list", "member":{"shape":"EnhancedMetrics"} }, "EnhancedMonitoringOutput":{ "type":"structure", "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the Amazon Kinesis stream.

" }, "CurrentShardLevelMetrics":{ "shape":"MetricsNameList", "documentation":"

Represents the current state of the metrics that are in the enhanced state before the operation.

" }, "DesiredShardLevelMetrics":{ "shape":"MetricsNameList", "documentation":"

Represents the list of all the metrics that would be in the enhanced state after the operation.

" } }, "documentation":"

Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.

" }, "ErrorCode":{"type":"string"}, "ErrorMessage":{"type":"string"}, "ExpiredIteratorException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A message that provides information about the error.

" } }, "documentation":"

The provided iterator exceeds the maximum age allowed.

", "exception":true }, "GetRecordsInput":{ "type":"structure", "required":["ShardIterator"], "members":{ "ShardIterator":{ "shape":"ShardIterator", "documentation":"

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

" }, "Limit":{ "shape":"GetRecordsInputLimit", "documentation":"

The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.

" } }, "documentation":"

Represents the input for GetRecords.

" }, "GetRecordsInputLimit":{ "type":"integer", "max":10000, "min":1 }, "GetRecordsOutput":{ "type":"structure", "required":["Records"], "members":{ "Records":{ "shape":"RecordList", "documentation":"

The data records retrieved from the shard.

" }, "NextShardIterator":{ "shape":"ShardIterator", "documentation":"

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator will not return any more data.

" }, "MillisBehindLatest":{ "shape":"MillisBehindLatest", "documentation":"

The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.

" } }, "documentation":"

Represents the output for GetRecords.

" }, "GetShardIteratorInput":{ "type":"structure", "required":[ "StreamName", "ShardId", "ShardIteratorType" ], "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the Amazon Kinesis stream.

" }, "ShardId":{ "shape":"ShardId", "documentation":"

The shard ID of the Amazon Kinesis shard to get the iterator for.

" }, "ShardIteratorType":{ "shape":"ShardIteratorType", "documentation":"

Determines how the shard iterator is used to start reading data records from the shard.

The following are the valid Amazon Kinesis shard iterator types:

  • AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

  • AT_TIMESTAMP - Start reading from the position denoted by a specific timestamp, provided in the value Timestamp.

  • TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

  • LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.

" }, "StartingSequenceNumber":{ "shape":"SequenceNumber", "documentation":"

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

" }, "Timestamp":{ "shape":"Timestamp", "documentation":"

The timestamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A timestamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact timestamp does not exist, the iterator returned is for the next (later) record. If the timestamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

" } }, "documentation":"

Represents the input for GetShardIterator.

" }, "GetShardIteratorOutput":{ "type":"structure", "members":{ "ShardIterator":{ "shape":"ShardIterator", "documentation":"

The position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard.

" } }, "documentation":"

Represents the output for GetShardIterator.

" }, "HashKey":{ "type":"string", "pattern":"0|([1-9]\\d{0,38})" }, "HashKeyRange":{ "type":"structure", "required":[ "StartingHashKey", "EndingHashKey" ], "members":{ "StartingHashKey":{ "shape":"HashKey", "documentation":"

The starting hash key of the hash key range.

" }, "EndingHashKey":{ "shape":"HashKey", "documentation":"

The ending hash key of the hash key range.

" } }, "documentation":"

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

" }, "IncreaseStreamRetentionPeriodInput":{ "type":"structure", "required":[ "StreamName", "RetentionPeriodHours" ], "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the stream to modify.

" }, "RetentionPeriodHours":{ "shape":"PositiveIntegerObject", "documentation":"

The new retention period of the stream, in hours. Must be more than the current retention period.

" } }, "documentation":"

Represents the input for IncreaseStreamRetentionPeriod.

" }, "InvalidArgumentException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A message that provides information about the error.

" } }, "documentation":"

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

", "exception":true }, "LimitExceededException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A message that provides information about the error.

" } }, "documentation":"

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed (5).

", "exception":true }, "ListStreamsInput":{ "type":"structure", "members":{ "Limit":{ "shape":"ListStreamsInputLimit", "documentation":"

The maximum number of streams to list.

" }, "ExclusiveStartStreamName":{ "shape":"StreamName", "documentation":"

The name of the stream to start the list with.

" } }, "documentation":"

Represents the input for ListStreams.

" }, "ListStreamsInputLimit":{ "type":"integer", "max":10000, "min":1 }, "ListStreamsOutput":{ "type":"structure", "required":[ "StreamNames", "HasMoreStreams" ], "members":{ "StreamNames":{ "shape":"StreamNameList", "documentation":"

The names of the streams that are associated with the AWS account making the ListStreams request.

" }, "HasMoreStreams":{ "shape":"BooleanObject", "documentation":"

If set to true, there are more streams available to list.

" } }, "documentation":"

Represents the output for ListStreams.

" }, "ListTagsForStreamInput":{ "type":"structure", "required":["StreamName"], "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the stream.

" }, "ExclusiveStartTagKey":{ "shape":"TagKey", "documentation":"

The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.

" }, "Limit":{ "shape":"ListTagsForStreamInputLimit", "documentation":"

The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.

" } }, "documentation":"

Represents the input for ListTagsForStream.

" }, "ListTagsForStreamInputLimit":{ "type":"integer", "max":10, "min":1 }, "ListTagsForStreamOutput":{ "type":"structure", "required":[ "Tags", "HasMoreTags" ], "members":{ "Tags":{ "shape":"TagList", "documentation":"

A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.

" }, "HasMoreTags":{ "shape":"BooleanObject", "documentation":"

If set to true, more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.

" } }, "documentation":"

Represents the output for ListTagsForStream.

" }, "MergeShardsInput":{ "type":"structure", "required":[ "StreamName", "ShardToMerge", "AdjacentShardToMerge" ], "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the stream for the merge.

" }, "ShardToMerge":{ "shape":"ShardId", "documentation":"

The shard ID of the shard to combine with the adjacent shard for the merge.

" }, "AdjacentShardToMerge":{ "shape":"ShardId", "documentation":"

The shard ID of the adjacent shard for the merge.

" } }, "documentation":"

Represents the input for MergeShards.

" }, "MetricsName":{ "type":"string", "enum":[ "IncomingBytes", "IncomingRecords", "OutgoingBytes", "OutgoingRecords", "WriteProvisionedThroughputExceeded", "ReadProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "ALL" ] }, "MetricsNameList":{ "type":"list", "member":{"shape":"MetricsName"}, "max":7, "min":1 }, "MillisBehindLatest":{ "type":"long", "min":0 }, "PartitionKey":{ "type":"string", "max":256, "min":1 }, "PositiveIntegerObject":{ "type":"integer", "max":100000, "min":1 }, "ProvisionedThroughputExceededException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A message that provides information about the error.

" } }, "documentation":"

The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Streams Developer Guide, and Error Retries and Exponential Backoff in AWS in the AWS General Reference.

", "exception":true }, "PutRecordInput":{ "type":"structure", "required":[ "StreamName", "Data", "PartitionKey" ], "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the stream to put the data record into.

" }, "Data":{ "shape":"Data", "documentation":"

The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

" }, "PartitionKey":{ "shape":"PartitionKey", "documentation":"

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

" }, "ExplicitHashKey":{ "shape":"HashKey", "documentation":"

The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.

" }, "SequenceNumberForOrdering":{ "shape":"SequenceNumber", "documentation":"

Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the result when putting record n-1). If this parameter is not set, records will be coarsely ordered based on arrival time.

" } }, "documentation":"

Represents the input for PutRecord.

" }, "PutRecordOutput":{ "type":"structure", "required":[ "ShardId", "SequenceNumber" ], "members":{ "ShardId":{ "shape":"ShardId", "documentation":"

The shard ID of the shard where the data record was placed.

" }, "SequenceNumber":{ "shape":"SequenceNumber", "documentation":"

The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.

" } }, "documentation":"

Represents the output for PutRecord.

" }, "PutRecordsInput":{ "type":"structure", "required":[ "Records", "StreamName" ], "members":{ "Records":{ "shape":"PutRecordsRequestEntryList", "documentation":"

The records associated with the request.

" }, "StreamName":{ "shape":"StreamName", "documentation":"

The stream name associated with the request.

" } }, "documentation":"

A PutRecords request.

" }, "PutRecordsOutput":{ "type":"structure", "required":["Records"], "members":{ "FailedRecordCount":{ "shape":"PositiveIntegerObject", "documentation":"

The number of unsuccessfully processed records in a PutRecords request.

" }, "Records":{ "shape":"PutRecordsResultEntryList", "documentation":"

An array of successfully and unsuccessfully processed record results, correlated with the request by natural ordering. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to a stream includes ErrorCode and ErrorMessage in the result.

" } }, "documentation":"

PutRecords results.

" }, "PutRecordsRequestEntry":{ "type":"structure", "required":[ "Data", "PartitionKey" ], "members":{ "Data":{ "shape":"Data", "documentation":"

The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

" }, "ExplicitHashKey":{ "shape":"HashKey", "documentation":"

The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.

" }, "PartitionKey":{ "shape":"PartitionKey", "documentation":"

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

" } }, "documentation":"

Represents the output for PutRecords.

" }, "PutRecordsRequestEntryList":{ "type":"list", "member":{"shape":"PutRecordsRequestEntry"}, "max":500, "min":1 }, "PutRecordsResultEntry":{ "type":"structure", "members":{ "SequenceNumber":{ "shape":"SequenceNumber", "documentation":"

The sequence number for an individual record result.

" }, "ShardId":{ "shape":"ShardId", "documentation":"

The shard ID for an individual record result.

" }, "ErrorCode":{ "shape":"ErrorCode", "documentation":"

The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

" }, "ErrorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message \"Internal Service Failure\".

" } }, "documentation":"

Represents the result of an individual record from a PutRecords request. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to the stream includes ErrorCode and ErrorMessage in the result.

" }, "PutRecordsResultEntryList":{ "type":"list", "member":{"shape":"PutRecordsResultEntry"}, "max":500, "min":1 }, "Record":{ "type":"structure", "required":[ "SequenceNumber", "Data", "PartitionKey" ], "members":{ "SequenceNumber":{ "shape":"SequenceNumber", "documentation":"

The unique identifier of the record in the stream.

" }, "ApproximateArrivalTimestamp":{ "shape":"Timestamp", "documentation":"

The approximate time that the record was inserted into the stream.

" }, "Data":{ "shape":"Data", "documentation":"

The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

" }, "PartitionKey":{ "shape":"PartitionKey", "documentation":"

Identifies which shard in the stream the data record is assigned to.

" } }, "documentation":"

The unit of data of the Amazon Kinesis stream, which is composed of a sequence number, a partition key, and a data blob.

" }, "RecordList":{ "type":"list", "member":{"shape":"Record"} }, "RemoveTagsFromStreamInput":{ "type":"structure", "required":[ "StreamName", "TagKeys" ], "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the stream.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

A list of tag keys. Each corresponding tag is removed from the stream.

" } }, "documentation":"

Represents the input for RemoveTagsFromStream.

" }, "ResourceInUseException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A message that provides information about the error.

" } }, "documentation":"

The resource is not available for this operation. For successful operation, the resource needs to be in the ACTIVE state.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A message that provides information about the error.

" } }, "documentation":"

The requested resource could not be found. The stream might not be specified correctly.

", "exception":true }, "ScalingType":{ "type":"string", "enum":["UNIFORM_SCALING"] }, "SequenceNumber":{ "type":"string", "pattern":"0|([1-9]\\d{0,128})" }, "SequenceNumberRange":{ "type":"structure", "required":["StartingSequenceNumber"], "members":{ "StartingSequenceNumber":{ "shape":"SequenceNumber", "documentation":"

The starting sequence number for the range.

" }, "EndingSequenceNumber":{ "shape":"SequenceNumber", "documentation":"

The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.

" } }, "documentation":"

The range of possible sequence numbers for the shard.

" }, "Shard":{ "type":"structure", "required":[ "ShardId", "HashKeyRange", "SequenceNumberRange" ], "members":{ "ShardId":{ "shape":"ShardId", "documentation":"

The unique identifier of the shard within the stream.

" }, "ParentShardId":{ "shape":"ShardId", "documentation":"

The shard ID of the shard's parent.

" }, "AdjacentParentShardId":{ "shape":"ShardId", "documentation":"

The shard ID of the shard adjacent to the shard's parent.

" }, "HashKeyRange":{ "shape":"HashKeyRange", "documentation":"

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

" }, "SequenceNumberRange":{ "shape":"SequenceNumberRange", "documentation":"

The range of possible sequence numbers for the shard.

" } }, "documentation":"

A uniquely identified group of data records in an Amazon Kinesis stream.

" }, "ShardCountObject":{ "type":"integer", "max":1000000, "min":0 }, "ShardId":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z0-9_.-]+" }, "ShardIterator":{ "type":"string", "max":512, "min":1 }, "ShardIteratorType":{ "type":"string", "enum":[ "AT_SEQUENCE_NUMBER", "AFTER_SEQUENCE_NUMBER", "TRIM_HORIZON", "LATEST", "AT_TIMESTAMP" ] }, "ShardList":{ "type":"list", "member":{"shape":"Shard"} }, "SplitShardInput":{ "type":"structure", "required":[ "StreamName", "ShardToSplit", "NewStartingHashKey" ], "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the stream for the shard split.

" }, "ShardToSplit":{ "shape":"ShardId", "documentation":"

The shard ID of the shard to split.

" }, "NewStartingHashKey":{ "shape":"HashKey", "documentation":"

A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.

" } }, "documentation":"

Represents the input for SplitShard.

" }, "StreamARN":{"type":"string"}, "StreamDescription":{ "type":"structure", "required":[ "StreamName", "StreamARN", "StreamStatus", "Shards", "HasMoreShards", "RetentionPeriodHours", "StreamCreationTimestamp", "EnhancedMonitoring" ], "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the stream being described.

" }, "StreamARN":{ "shape":"StreamARN", "documentation":"

The Amazon Resource Name (ARN) for the stream being described.

" }, "StreamStatus":{ "shape":"StreamStatus", "documentation":"

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis completes the deletion.

  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

" }, "Shards":{ "shape":"ShardList", "documentation":"

The shards that comprise the stream.

" }, "HasMoreShards":{ "shape":"BooleanObject", "documentation":"

If set to true, more shards in the stream are available to describe.

" }, "RetentionPeriodHours":{ "shape":"PositiveIntegerObject", "documentation":"

The current retention period, in hours.

" }, "StreamCreationTimestamp":{ "shape":"Timestamp", "documentation":"

The approximate time that the stream was created.

" }, "EnhancedMonitoring":{ "shape":"EnhancedMonitoringList", "documentation":"

Represents the current enhanced monitoring settings of the stream.

" } }, "documentation":"

Represents the output for DescribeStream.

" }, "StreamName":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z0-9_.-]+" }, "StreamNameList":{ "type":"list", "member":{"shape":"StreamName"} }, "StreamStatus":{ "type":"string", "enum":[ "CREATING", "DELETING", "ACTIVE", "UPDATING" ] }, "Tag":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"TagKey", "documentation":"

A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

" }, "Value":{ "shape":"TagValue", "documentation":"

An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

" } }, "documentation":"

Metadata assigned to the stream, consisting of a key-value pair.

" }, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":10, "min":1 }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "min":0 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":10, "min":1 }, "TagValue":{ "type":"string", "max":256, "min":0 }, "Timestamp":{"type":"timestamp"}, "UpdateShardCountInput":{ "type":"structure", "required":[ "StreamName", "TargetShardCount", "ScalingType" ], "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the stream.

" }, "TargetShardCount":{ "shape":"PositiveIntegerObject", "documentation":"

The new number of shards.

" }, "ScalingType":{ "shape":"ScalingType", "documentation":"

The scaling type. Uniform scaling creates shards of equal size.

" } } }, "UpdateShardCountOutput":{ "type":"structure", "members":{ "StreamName":{ "shape":"StreamName", "documentation":"

The name of the stream.

" }, "CurrentShardCount":{ "shape":"PositiveIntegerObject", "documentation":"

The current number of shards.

" }, "TargetShardCount":{ "shape":"PositiveIntegerObject", "documentation":"

The updated number of shards.

" } } } }, "documentation":"Amazon Kinesis Streams Service API Reference

Amazon Kinesis Streams is a managed service that scales elastically for real time processing of streaming big data.

" } botocore-1.5.7/botocore/data/elbv2/0000777454262600001440000000000013042511307020145 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/elbv2/2015-12-01/0000777454262600001440000000000013042511307021172 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/elbv2/2015-12-01/paginators-1.json0000666454262600001440000000102313042511306024365 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeLoadBalancers": { "input_token": "Marker", "output_token": "NextMarker", "limit_key": "PageSize", "result_key": "LoadBalancers" }, "DescribeTargetGroups": { "input_token": "Marker", "output_token": "NextMarker", "limit_key": "PageSize", "result_key": "TargetGroups" }, "DescribeListeners": { "input_token": "Marker", "output_token": "NextMarker", "limit_key": "PageSize", "result_key": "Listeners" } } } botocore-1.5.7/botocore/data/elbv2/2015-12-01/service-2.json0000666454262600001440000026201613042511306023672 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-12-01", "endpointPrefix":"elasticloadbalancing", "protocol":"query", "serviceAbbreviation":"Elastic Load Balancing v2", "serviceFullName":"Elastic Load Balancing", "signatureVersion":"v4", "uid":"elasticloadbalancingv2-2015-12-01", "xmlNamespace":"http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/" }, "operations":{ "AddTags":{ "name":"AddTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsInput"}, "output":{ "shape":"AddTagsOutput", "resultWrapper":"AddTagsResult" }, "errors":[ {"shape":"DuplicateTagKeysException"}, {"shape":"TooManyTagsException"}, {"shape":"LoadBalancerNotFoundException"}, {"shape":"TargetGroupNotFoundException"} ], "documentation":"

Adds the specified tags to the specified resource. You can tag your Application Load Balancers and your target groups.

Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value.

To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags.

" }, "CreateListener":{ "name":"CreateListener", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateListenerInput"}, "output":{ "shape":"CreateListenerOutput", "resultWrapper":"CreateListenerResult" }, "errors":[ {"shape":"DuplicateListenerException"}, {"shape":"TooManyListenersException"}, {"shape":"TooManyCertificatesException"}, {"shape":"LoadBalancerNotFoundException"}, {"shape":"TargetGroupNotFoundException"}, {"shape":"TargetGroupAssociationLimitException"}, {"shape":"InvalidConfigurationRequestException"}, {"shape":"IncompatibleProtocolsException"}, {"shape":"SSLPolicyNotFoundException"}, {"shape":"CertificateNotFoundException"}, {"shape":"UnsupportedProtocolException"}, {"shape":"TooManyRegistrationsForTargetIdException"} ], "documentation":"

Creates a listener for the specified Application Load Balancer.

You can create up to 10 listeners per load balancer.

To update a listener, use ModifyListener. When you are finished with a listener, you can delete it using DeleteListener. If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer.

For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide.

" }, "CreateLoadBalancer":{ "name":"CreateLoadBalancer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateLoadBalancerInput"}, "output":{ "shape":"CreateLoadBalancerOutput", "resultWrapper":"CreateLoadBalancerResult" }, "errors":[ {"shape":"DuplicateLoadBalancerNameException"}, {"shape":"TooManyLoadBalancersException"}, {"shape":"InvalidConfigurationRequestException"}, {"shape":"SubnetNotFoundException"}, {"shape":"InvalidSubnetException"}, {"shape":"InvalidSecurityGroupException"}, {"shape":"InvalidSchemeException"}, {"shape":"TooManyTagsException"}, {"shape":"DuplicateTagKeysException"} ], "documentation":"

Creates an Application Load Balancer.

When you create a load balancer, you can specify security groups, subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups, SetSubnets, SetIpAddressType, and AddTags.

To create listeners for your load balancer, use CreateListener. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.

You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide.

For more information, see Application Load Balancers in the Application Load Balancers Guide.

" }, "CreateRule":{ "name":"CreateRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRuleInput"}, "output":{ "shape":"CreateRuleOutput", "resultWrapper":"CreateRuleResult" }, "errors":[ {"shape":"PriorityInUseException"}, {"shape":"TooManyTargetGroupsException"}, {"shape":"TooManyRulesException"}, {"shape":"TargetGroupAssociationLimitException"}, {"shape":"ListenerNotFoundException"}, {"shape":"TargetGroupNotFoundException"}, {"shape":"InvalidConfigurationRequestException"}, {"shape":"TooManyRegistrationsForTargetIdException"} ], "documentation":"

Creates a rule for the specified listener.

Each rule can have one action and one condition. Rules are evaluated in priority order, from the lowest value to the highest value. When the condition for a rule is met, the specified action is taken. If no conditions are met, the default action for the default rule is taken. For more information, see Listener Rules in the Application Load Balancers Guide.

To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.

" }, "CreateTargetGroup":{ "name":"CreateTargetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTargetGroupInput"}, "output":{ "shape":"CreateTargetGroupOutput", "resultWrapper":"CreateTargetGroupResult" }, "errors":[ {"shape":"DuplicateTargetGroupNameException"}, {"shape":"TooManyTargetGroupsException"} ], "documentation":"

Creates a target group.

To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth.

To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule.

To delete a target group, use DeleteTargetGroup.

For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide.

" }, "DeleteListener":{ "name":"DeleteListener", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteListenerInput"}, "output":{ "shape":"DeleteListenerOutput", "resultWrapper":"DeleteListenerResult" }, "errors":[ {"shape":"ListenerNotFoundException"} ], "documentation":"

Deletes the specified listener.

Alternatively, your listener is deleted when you delete the load balancer it is attached to using DeleteLoadBalancer.

" }, "DeleteLoadBalancer":{ "name":"DeleteLoadBalancer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteLoadBalancerInput"}, "output":{ "shape":"DeleteLoadBalancerOutput", "resultWrapper":"DeleteLoadBalancerResult" }, "errors":[ {"shape":"LoadBalancerNotFoundException"}, {"shape":"OperationNotPermittedException"} ], "documentation":"

Deletes the specified Application Load Balancer and its attached listeners.

You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.

Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.

" }, "DeleteRule":{ "name":"DeleteRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRuleInput"}, "output":{ "shape":"DeleteRuleOutput", "resultWrapper":"DeleteRuleResult" }, "errors":[ {"shape":"RuleNotFoundException"}, {"shape":"OperationNotPermittedException"} ], "documentation":"

Deletes the specified rule.

" }, "DeleteTargetGroup":{ "name":"DeleteTargetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTargetGroupInput"}, "output":{ "shape":"DeleteTargetGroupOutput", "resultWrapper":"DeleteTargetGroupResult" }, "errors":[ {"shape":"ResourceInUseException"} ], "documentation":"

Deletes the specified target group.

You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks.

" }, "DeregisterTargets":{ "name":"DeregisterTargets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterTargetsInput"}, "output":{ "shape":"DeregisterTargetsOutput", "resultWrapper":"DeregisterTargetsResult" }, "errors":[ {"shape":"TargetGroupNotFoundException"}, {"shape":"InvalidTargetException"} ], "documentation":"

Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.

" }, "DescribeListeners":{ "name":"DescribeListeners", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeListenersInput"}, "output":{ "shape":"DescribeListenersOutput", "resultWrapper":"DescribeListenersResult" }, "errors":[ {"shape":"ListenerNotFoundException"}, {"shape":"LoadBalancerNotFoundException"} ], "documentation":"

Describes the specified listeners or the listeners for the specified Application Load Balancer. You must specify either a load balancer or one or more listeners.

" }, "DescribeLoadBalancerAttributes":{ "name":"DescribeLoadBalancerAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLoadBalancerAttributesInput"}, "output":{ "shape":"DescribeLoadBalancerAttributesOutput", "resultWrapper":"DescribeLoadBalancerAttributesResult" }, "errors":[ {"shape":"LoadBalancerNotFoundException"} ], "documentation":"

Describes the attributes for the specified Application Load Balancer.

" }, "DescribeLoadBalancers":{ "name":"DescribeLoadBalancers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLoadBalancersInput"}, "output":{ "shape":"DescribeLoadBalancersOutput", "resultWrapper":"DescribeLoadBalancersResult" }, "errors":[ {"shape":"LoadBalancerNotFoundException"} ], "documentation":"

Describes the specified Application Load Balancers or all of your Application Load Balancers.

To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.

" }, "DescribeRules":{ "name":"DescribeRules", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRulesInput"}, "output":{ "shape":"DescribeRulesOutput", "resultWrapper":"DescribeRulesResult" }, "errors":[ {"shape":"ListenerNotFoundException"}, {"shape":"RuleNotFoundException"} ], "documentation":"

Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.

" }, "DescribeSSLPolicies":{ "name":"DescribeSSLPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSSLPoliciesInput"}, "output":{ "shape":"DescribeSSLPoliciesOutput", "resultWrapper":"DescribeSSLPoliciesResult" }, "errors":[ {"shape":"SSLPolicyNotFoundException"} ], "documentation":"

Describes the specified policies or all policies used for SSL negotiation.

Note that the only supported policy at this time is ELBSecurityPolicy-2015-05.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsInput"}, "output":{ "shape":"DescribeTagsOutput", "resultWrapper":"DescribeTagsResult" }, "errors":[ {"shape":"LoadBalancerNotFoundException"}, {"shape":"TargetGroupNotFoundException"}, {"shape":"ListenerNotFoundException"}, {"shape":"RuleNotFoundException"} ], "documentation":"

Describes the tags for the specified resources.

" }, "DescribeTargetGroupAttributes":{ "name":"DescribeTargetGroupAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTargetGroupAttributesInput"}, "output":{ "shape":"DescribeTargetGroupAttributesOutput", "resultWrapper":"DescribeTargetGroupAttributesResult" }, "errors":[ {"shape":"TargetGroupNotFoundException"} ], "documentation":"

Describes the attributes for the specified target group.

" }, "DescribeTargetGroups":{ "name":"DescribeTargetGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTargetGroupsInput"}, "output":{ "shape":"DescribeTargetGroupsOutput", "resultWrapper":"DescribeTargetGroupsResult" }, "errors":[ {"shape":"LoadBalancerNotFoundException"}, {"shape":"TargetGroupNotFoundException"} ], "documentation":"

Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.

To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.

" }, "DescribeTargetHealth":{ "name":"DescribeTargetHealth", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTargetHealthInput"}, "output":{ "shape":"DescribeTargetHealthOutput", "resultWrapper":"DescribeTargetHealthResult" }, "errors":[ {"shape":"InvalidTargetException"}, {"shape":"TargetGroupNotFoundException"}, {"shape":"HealthUnavailableException"} ], "documentation":"

Describes the health of the specified targets or all of your targets.

" }, "ModifyListener":{ "name":"ModifyListener", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyListenerInput"}, "output":{ "shape":"ModifyListenerOutput", "resultWrapper":"ModifyListenerResult" }, "errors":[ {"shape":"DuplicateListenerException"}, {"shape":"TooManyListenersException"}, {"shape":"TooManyCertificatesException"}, {"shape":"ListenerNotFoundException"}, {"shape":"TargetGroupNotFoundException"}, {"shape":"TargetGroupAssociationLimitException"}, {"shape":"IncompatibleProtocolsException"}, {"shape":"SSLPolicyNotFoundException"}, {"shape":"CertificateNotFoundException"}, {"shape":"InvalidConfigurationRequestException"}, {"shape":"UnsupportedProtocolException"}, {"shape":"TooManyRegistrationsForTargetIdException"} ], "documentation":"

Modifies the specified properties of the specified listener.

Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP removes the security policy and SSL certificate properties. If you change the protocol from HTTP to HTTPS, you must add the security policy.

" }, "ModifyLoadBalancerAttributes":{ "name":"ModifyLoadBalancerAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyLoadBalancerAttributesInput"}, "output":{ "shape":"ModifyLoadBalancerAttributesOutput", "resultWrapper":"ModifyLoadBalancerAttributesResult" }, "errors":[ {"shape":"LoadBalancerNotFoundException"}, {"shape":"InvalidConfigurationRequestException"} ], "documentation":"

Modifies the specified attributes of the specified Application Load Balancer.

If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.

" }, "ModifyRule":{ "name":"ModifyRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyRuleInput"}, "output":{ "shape":"ModifyRuleOutput", "resultWrapper":"ModifyRuleResult" }, "errors":[ {"shape":"TargetGroupAssociationLimitException"}, {"shape":"RuleNotFoundException"}, {"shape":"OperationNotPermittedException"}, {"shape":"TooManyRegistrationsForTargetIdException"} ], "documentation":"

Modifies the specified rule.

Any existing properties that you do not modify retain their current values.

To modify the default action, use ModifyListener.

" }, "ModifyTargetGroup":{ "name":"ModifyTargetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyTargetGroupInput"}, "output":{ "shape":"ModifyTargetGroupOutput", "resultWrapper":"ModifyTargetGroupResult" }, "errors":[ {"shape":"TargetGroupNotFoundException"} ], "documentation":"

Modifies the health checks used when evaluating the health state of the targets in the specified target group.

To monitor the health of the targets, use DescribeTargetHealth.

" }, "ModifyTargetGroupAttributes":{ "name":"ModifyTargetGroupAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyTargetGroupAttributesInput"}, "output":{ "shape":"ModifyTargetGroupAttributesOutput", "resultWrapper":"ModifyTargetGroupAttributesResult" }, "errors":[ {"shape":"TargetGroupNotFoundException"} ], "documentation":"

Modifies the specified attributes of the specified target group.

" }, "RegisterTargets":{ "name":"RegisterTargets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterTargetsInput"}, "output":{ "shape":"RegisterTargetsOutput", "resultWrapper":"RegisterTargetsResult" }, "errors":[ {"shape":"TargetGroupNotFoundException"}, {"shape":"TooManyTargetsException"}, {"shape":"InvalidTargetException"}, {"shape":"TooManyRegistrationsForTargetIdException"} ], "documentation":"

Registers the specified targets with the specified target group.

By default, the load balancer routes requests to registered targets using the protocol and port number for the target group. Alternatively, you can override the port for a target when you register it.

The target must be in the virtual private cloud (VPC) that you specified for the target group. If the target is an EC2 instance, it must be in the running state when you register it.

To remove a target from a target group, use DeregisterTargets.

" }, "RemoveTags":{ "name":"RemoveTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTagsInput"}, "output":{ "shape":"RemoveTagsOutput", "resultWrapper":"RemoveTagsResult" }, "errors":[ {"shape":"LoadBalancerNotFoundException"}, {"shape":"TargetGroupNotFoundException"}, {"shape":"ListenerNotFoundException"}, {"shape":"RuleNotFoundException"}, {"shape":"TooManyTagsException"} ], "documentation":"

Removes the specified tags from the specified resource.

To list the current tags for your resources, use DescribeTags.

" }, "SetIpAddressType":{ "name":"SetIpAddressType", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetIpAddressTypeInput"}, "output":{ "shape":"SetIpAddressTypeOutput", "resultWrapper":"SetIpAddressTypeResult" }, "errors":[ {"shape":"LoadBalancerNotFoundException"}, {"shape":"InvalidConfigurationRequestException"}, {"shape":"InvalidSubnetException"} ], "documentation":"

Sets the type of IP addresses used by the subnets of the specified Application Load Balancer.

" }, "SetRulePriorities":{ "name":"SetRulePriorities", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetRulePrioritiesInput"}, "output":{ "shape":"SetRulePrioritiesOutput", "resultWrapper":"SetRulePrioritiesResult" }, "errors":[ {"shape":"RuleNotFoundException"}, {"shape":"PriorityInUseException"}, {"shape":"OperationNotPermittedException"} ], "documentation":"

Sets the priorities of the specified rules.

You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority.

" }, "SetSecurityGroups":{ "name":"SetSecurityGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetSecurityGroupsInput"}, "output":{ "shape":"SetSecurityGroupsOutput", "resultWrapper":"SetSecurityGroupsResult" }, "errors":[ {"shape":"LoadBalancerNotFoundException"}, {"shape":"InvalidConfigurationRequestException"}, {"shape":"InvalidSecurityGroupException"} ], "documentation":"

Associates the specified security groups with the specified load balancer. The specified security groups override the previously associated security groups.

" }, "SetSubnets":{ "name":"SetSubnets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetSubnetsInput"}, "output":{ "shape":"SetSubnetsOutput", "resultWrapper":"SetSubnetsResult" }, "errors":[ {"shape":"LoadBalancerNotFoundException"}, {"shape":"InvalidConfigurationRequestException"}, {"shape":"SubnetNotFoundException"}, {"shape":"InvalidSubnetException"} ], "documentation":"

Enables the Availability Zone for the specified subnets for the specified load balancer. The specified subnets replace the previously enabled subnets.

" } }, "shapes":{ "Action":{ "type":"structure", "required":[ "Type", "TargetGroupArn" ], "members":{ "Type":{ "shape":"ActionTypeEnum", "documentation":"

The type of action.

" }, "TargetGroupArn":{ "shape":"TargetGroupArn", "documentation":"

The Amazon Resource Name (ARN) of the target group.

" } }, "documentation":"

Information about an action.

" }, "ActionTypeEnum":{ "type":"string", "enum":["forward"] }, "Actions":{ "type":"list", "member":{"shape":"Action"} }, "AddTagsInput":{ "type":"structure", "required":[ "ResourceArns", "Tags" ], "members":{ "ResourceArns":{ "shape":"ResourceArns", "documentation":"

The Amazon Resource Name (ARN) of the resource.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags. Each resource can have a maximum of 10 tags.

" } } }, "AddTagsOutput":{ "type":"structure", "members":{ } }, "AvailabilityZone":{ "type":"structure", "members":{ "ZoneName":{ "shape":"ZoneName", "documentation":"

The name of the Availability Zone.

" }, "SubnetId":{ "shape":"SubnetId", "documentation":"

The ID of the subnet.

" } }, "documentation":"

Information about an Availability Zone.

" }, "AvailabilityZones":{ "type":"list", "member":{"shape":"AvailabilityZone"} }, "CanonicalHostedZoneId":{"type":"string"}, "Certificate":{ "type":"structure", "members":{ "CertificateArn":{ "shape":"CertificateArn", "documentation":"

The Amazon Resource Name (ARN) of the certificate.

" } }, "documentation":"

Information about an SSL server certificate deployed on a load balancer.

" }, "CertificateArn":{"type":"string"}, "CertificateList":{ "type":"list", "member":{"shape":"Certificate"} }, "CertificateNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified certificate does not exist.

", "error":{ "code":"CertificateNotFound", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Cipher":{ "type":"structure", "members":{ "Name":{ "shape":"CipherName", "documentation":"

The name of the cipher.

" }, "Priority":{ "shape":"CipherPriority", "documentation":"

The priority of the cipher.

" } }, "documentation":"

Information about a cipher used in a policy.

" }, "CipherName":{"type":"string"}, "CipherPriority":{"type":"integer"}, "Ciphers":{ "type":"list", "member":{"shape":"Cipher"} }, "ConditionFieldName":{ "type":"string", "max":64 }, "CreateListenerInput":{ "type":"structure", "required":[ "LoadBalancerArn", "Protocol", "Port", "DefaultActions" ], "members":{ "LoadBalancerArn":{ "shape":"LoadBalancerArn", "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" }, "Protocol":{ "shape":"ProtocolEnum", "documentation":"

The protocol for connections from clients to the load balancer.

" }, "Port":{ "shape":"Port", "documentation":"

The port on which the load balancer is listening.

" }, "SslPolicy":{ "shape":"SslPolicyName", "documentation":"

The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.

" }, "Certificates":{ "shape":"CertificateList", "documentation":"

The SSL server certificate. You must provide exactly one certificate if the protocol is HTTPS.

" }, "DefaultActions":{ "shape":"Actions", "documentation":"

The default action for the listener.

" } } }, "CreateListenerOutput":{ "type":"structure", "members":{ "Listeners":{ "shape":"Listeners", "documentation":"

Information about the listener.

" } } }, "CreateLoadBalancerInput":{ "type":"structure", "required":[ "Name", "Subnets" ], "members":{ "Name":{ "shape":"LoadBalancerName", "documentation":"

The name of the load balancer.

This name must be unique within your AWS account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.

" }, "Subnets":{ "shape":"Subnets", "documentation":"

The IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify subnets from at least two Availability Zones.

" }, "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

The IDs of the security groups to assign to the load balancer.

" }, "Scheme":{ "shape":"LoadBalancerSchemeEnum", "documentation":"

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the Internet.

The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer.

The default is an Internet-facing load balancer.

" }, "Tags":{ "shape":"TagList", "documentation":"

One or more tags to assign to the load balancer.

" }, "IpAddressType":{ "shape":"IpAddressType", "documentation":"

The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4.

" } } }, "CreateLoadBalancerOutput":{ "type":"structure", "members":{ "LoadBalancers":{ "shape":"LoadBalancers", "documentation":"

Information about the load balancer.

" } } }, "CreateRuleInput":{ "type":"structure", "required":[ "ListenerArn", "Conditions", "Priority", "Actions" ], "members":{ "ListenerArn":{ "shape":"ListenerArn", "documentation":"

The Amazon Resource Name (ARN) of the listener.

" }, "Conditions":{ "shape":"RuleConditionList", "documentation":"

A condition. Each condition has the field path-pattern and specifies one path pattern. A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters in a path pattern.

  • A-Z, a-z, 0-9

  • _ - . $ / ~ \" ' @ : +

  • & (using &amp;)

  • * (matches 0 or more characters)

  • ? (matches exactly 1 character)

" }, "Priority":{ "shape":"RulePriority", "documentation":"

The priority for the rule. A listener can't have multiple rules with the same priority.

" }, "Actions":{ "shape":"Actions", "documentation":"

An action. Each action has the type forward and specifies a target group.

" } } }, "CreateRuleOutput":{ "type":"structure", "members":{ "Rules":{ "shape":"Rules", "documentation":"

Information about the rule.

" } } }, "CreateTargetGroupInput":{ "type":"structure", "required":[ "Name", "Protocol", "Port", "VpcId" ], "members":{ "Name":{ "shape":"TargetGroupName", "documentation":"

The name of the target group.

" }, "Protocol":{ "shape":"ProtocolEnum", "documentation":"

The protocol to use for routing traffic to the targets.

" }, "Port":{ "shape":"Port", "documentation":"

The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target.

" }, "VpcId":{ "shape":"VpcId", "documentation":"

The identifier of the virtual private cloud (VPC).

" }, "HealthCheckProtocol":{ "shape":"ProtocolEnum", "documentation":"

The protocol the load balancer uses when performing health checks on targets. The default is the HTTP protocol.

" }, "HealthCheckPort":{ "shape":"HealthCheckPort", "documentation":"

The port the load balancer uses when performing health checks on targets. The default is traffic-port, which indicates the port on which each target receives traffic from the load balancer.

" }, "HealthCheckPath":{ "shape":"Path", "documentation":"

The ping path that is the destination on the targets for health checks. The default is /.

" }, "HealthCheckIntervalSeconds":{ "shape":"HealthCheckIntervalSeconds", "documentation":"

The approximate amount of time, in seconds, between health checks of an individual target. The default is 30 seconds.

" }, "HealthCheckTimeoutSeconds":{ "shape":"HealthCheckTimeoutSeconds", "documentation":"

The amount of time, in seconds, during which no response from a target means a failed health check. The default is 5 seconds.

" }, "HealthyThresholdCount":{ "shape":"HealthCheckThresholdCount", "documentation":"

The number of consecutive health checks successes required before considering an unhealthy target healthy. The default is 5.

" }, "UnhealthyThresholdCount":{ "shape":"HealthCheckThresholdCount", "documentation":"

The number of consecutive health check failures required before considering a target unhealthy. The default is 2.

" }, "Matcher":{ "shape":"Matcher", "documentation":"

The HTTP codes to use when checking for a successful response from a target. The default is 200.

" } } }, "CreateTargetGroupOutput":{ "type":"structure", "members":{ "TargetGroups":{ "shape":"TargetGroups", "documentation":"

Information about the target group.

" } } }, "CreatedTime":{"type":"timestamp"}, "DNSName":{"type":"string"}, "DeleteListenerInput":{ "type":"structure", "required":["ListenerArn"], "members":{ "ListenerArn":{ "shape":"ListenerArn", "documentation":"

The Amazon Resource Name (ARN) of the listener.

" } } }, "DeleteListenerOutput":{ "type":"structure", "members":{ } }, "DeleteLoadBalancerInput":{ "type":"structure", "required":["LoadBalancerArn"], "members":{ "LoadBalancerArn":{ "shape":"LoadBalancerArn", "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" } } }, "DeleteLoadBalancerOutput":{ "type":"structure", "members":{ } }, "DeleteRuleInput":{ "type":"structure", "required":["RuleArn"], "members":{ "RuleArn":{ "shape":"RuleArn", "documentation":"

The Amazon Resource Name (ARN) of the rule.

" } } }, "DeleteRuleOutput":{ "type":"structure", "members":{ } }, "DeleteTargetGroupInput":{ "type":"structure", "required":["TargetGroupArn"], "members":{ "TargetGroupArn":{ "shape":"TargetGroupArn", "documentation":"

The Amazon Resource Name (ARN) of the target group.

" } } }, "DeleteTargetGroupOutput":{ "type":"structure", "members":{ } }, "DeregisterTargetsInput":{ "type":"structure", "required":[ "TargetGroupArn", "Targets" ], "members":{ "TargetGroupArn":{ "shape":"TargetGroupArn", "documentation":"

The Amazon Resource Name (ARN) of the target group.

" }, "Targets":{ "shape":"TargetDescriptions", "documentation":"

The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it.

" } } }, "DeregisterTargetsOutput":{ "type":"structure", "members":{ } }, "DescribeListenersInput":{ "type":"structure", "members":{ "LoadBalancerArn":{ "shape":"LoadBalancerArn", "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" }, "ListenerArns":{ "shape":"ListenerArns", "documentation":"

The Amazon Resource Names (ARN) of the listeners.

" }, "Marker":{ "shape":"Marker", "documentation":"

The marker for the next set of results. (You received this marker from a previous call.)

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of results to return with this call.

" } } }, "DescribeListenersOutput":{ "type":"structure", "members":{ "Listeners":{ "shape":"Listeners", "documentation":"

Information about the listeners.

" }, "NextMarker":{ "shape":"Marker", "documentation":"

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

" } } }, "DescribeLoadBalancerAttributesInput":{ "type":"structure", "required":["LoadBalancerArn"], "members":{ "LoadBalancerArn":{ "shape":"LoadBalancerArn", "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" } } }, "DescribeLoadBalancerAttributesOutput":{ "type":"structure", "members":{ "Attributes":{ "shape":"LoadBalancerAttributes", "documentation":"

Information about the load balancer attributes.

" } } }, "DescribeLoadBalancersInput":{ "type":"structure", "members":{ "LoadBalancerArns":{ "shape":"LoadBalancerArns", "documentation":"

The Amazon Resource Names (ARN) of the load balancers.

" }, "Names":{ "shape":"LoadBalancerNames", "documentation":"

The names of the load balancers.

" }, "Marker":{ "shape":"Marker", "documentation":"

The marker for the next set of results. (You received this marker from a previous call.)

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of results to return with this call.

" } } }, "DescribeLoadBalancersOutput":{ "type":"structure", "members":{ "LoadBalancers":{ "shape":"LoadBalancers", "documentation":"

Information about the load balancers.

" }, "NextMarker":{ "shape":"Marker", "documentation":"

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

" } } }, "DescribeRulesInput":{ "type":"structure", "members":{ "ListenerArn":{ "shape":"ListenerArn", "documentation":"

The Amazon Resource Name (ARN) of the listener.

" }, "RuleArns":{ "shape":"RuleArns", "documentation":"

The Amazon Resource Names (ARN) of the rules.

" } } }, "DescribeRulesOutput":{ "type":"structure", "members":{ "Rules":{ "shape":"Rules", "documentation":"

Information about the rules.

" } } }, "DescribeSSLPoliciesInput":{ "type":"structure", "members":{ "Names":{ "shape":"SslPolicyNames", "documentation":"

The names of the policies.

" }, "Marker":{ "shape":"Marker", "documentation":"

The marker for the next set of results. (You received this marker from a previous call.)

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of results to return with this call.

" } } }, "DescribeSSLPoliciesOutput":{ "type":"structure", "members":{ "SslPolicies":{ "shape":"SslPolicies", "documentation":"

Information about the policies.

" }, "NextMarker":{ "shape":"Marker", "documentation":"

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

" } } }, "DescribeTagsInput":{ "type":"structure", "required":["ResourceArns"], "members":{ "ResourceArns":{ "shape":"ResourceArns", "documentation":"

The Amazon Resource Names (ARN) of the resources.

" } } }, "DescribeTagsOutput":{ "type":"structure", "members":{ "TagDescriptions":{ "shape":"TagDescriptions", "documentation":"

Information about the tags.

" } } }, "DescribeTargetGroupAttributesInput":{ "type":"structure", "required":["TargetGroupArn"], "members":{ "TargetGroupArn":{ "shape":"TargetGroupArn", "documentation":"

The Amazon Resource Name (ARN) of the target group.

" } } }, "DescribeTargetGroupAttributesOutput":{ "type":"structure", "members":{ "Attributes":{ "shape":"TargetGroupAttributes", "documentation":"

Information about the target group attributes

" } } }, "DescribeTargetGroupsInput":{ "type":"structure", "members":{ "LoadBalancerArn":{ "shape":"LoadBalancerArn", "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" }, "TargetGroupArns":{ "shape":"TargetGroupArns", "documentation":"

The Amazon Resource Names (ARN) of the target groups.

" }, "Names":{ "shape":"TargetGroupNames", "documentation":"

The names of the target groups.

" }, "Marker":{ "shape":"Marker", "documentation":"

The marker for the next set of results. (You received this marker from a previous call.)

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of results to return with this call.

" } } }, "DescribeTargetGroupsOutput":{ "type":"structure", "members":{ "TargetGroups":{ "shape":"TargetGroups", "documentation":"

Information about the target groups.

" }, "NextMarker":{ "shape":"Marker", "documentation":"

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

" } } }, "DescribeTargetHealthInput":{ "type":"structure", "required":["TargetGroupArn"], "members":{ "TargetGroupArn":{ "shape":"TargetGroupArn", "documentation":"

The Amazon Resource Name (ARN) of the target group.

" }, "Targets":{ "shape":"TargetDescriptions", "documentation":"

The targets.

" } } }, "DescribeTargetHealthOutput":{ "type":"structure", "members":{ "TargetHealthDescriptions":{ "shape":"TargetHealthDescriptions", "documentation":"

Information about the health of the targets.

" } } }, "Description":{"type":"string"}, "DuplicateListenerException":{ "type":"structure", "members":{ }, "documentation":"

A listener with the specified port already exists.

", "error":{ "code":"DuplicateListener", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DuplicateLoadBalancerNameException":{ "type":"structure", "members":{ }, "documentation":"

A load balancer with the specified name already exists for this account.

", "error":{ "code":"DuplicateLoadBalancerName", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DuplicateTagKeysException":{ "type":"structure", "members":{ }, "documentation":"

A tag key was specified more than once.

", "error":{ "code":"DuplicateTagKeys", "httpStatusCode":400, "senderFault":true }, "exception":true }, "DuplicateTargetGroupNameException":{ "type":"structure", "members":{ }, "documentation":"

A target group with the specified name already exists.

", "error":{ "code":"DuplicateTargetGroupName", "httpStatusCode":400, "senderFault":true }, "exception":true }, "HealthCheckIntervalSeconds":{ "type":"integer", "max":300, "min":5 }, "HealthCheckPort":{"type":"string"}, "HealthCheckThresholdCount":{ "type":"integer", "max":10, "min":2 }, "HealthCheckTimeoutSeconds":{ "type":"integer", "max":60, "min":2 }, "HealthUnavailableException":{ "type":"structure", "members":{ }, "documentation":"

The health of the specified targets could not be retrieved due to an internal error.

", "error":{ "code":"HealthUnavailable", "httpStatusCode":500 }, "exception":true }, "HttpCode":{"type":"string"}, "IncompatibleProtocolsException":{ "type":"structure", "members":{ }, "documentation":"

The specified configuration is not valid with this protocol.

", "error":{ "code":"IncompatibleProtocols", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidConfigurationRequestException":{ "type":"structure", "members":{ }, "documentation":"

The requested configuration is not valid.

", "error":{ "code":"InvalidConfigurationRequest", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidSchemeException":{ "type":"structure", "members":{ }, "documentation":"

The requested scheme is not valid.

", "error":{ "code":"InvalidScheme", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidSecurityGroupException":{ "type":"structure", "members":{ }, "documentation":"

The specified security group does not exist.

", "error":{ "code":"InvalidSecurityGroup", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidSubnetException":{ "type":"structure", "members":{ }, "documentation":"

The specified subnet is out of available addresses.

", "error":{ "code":"InvalidSubnet", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidTargetException":{ "type":"structure", "members":{ }, "documentation":"

The specified target does not exist or is not in the same VPC as the target group.

", "error":{ "code":"InvalidTarget", "httpStatusCode":400, "senderFault":true }, "exception":true }, "IpAddressType":{ "type":"string", "enum":[ "ipv4", "dualstack" ] }, "IsDefault":{"type":"boolean"}, "ListOfString":{ "type":"list", "member":{"shape":"StringValue"} }, "Listener":{ "type":"structure", "members":{ "ListenerArn":{ "shape":"ListenerArn", "documentation":"

The Amazon Resource Name (ARN) of the listener.

" }, "LoadBalancerArn":{ "shape":"LoadBalancerArn", "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" }, "Port":{ "shape":"Port", "documentation":"

The port on which the load balancer is listening.

" }, "Protocol":{ "shape":"ProtocolEnum", "documentation":"

The protocol for connections from clients to the load balancer.

" }, "Certificates":{ "shape":"CertificateList", "documentation":"

The SSL server certificate. You must provide a certificate if the protocol is HTTPS.

" }, "SslPolicy":{ "shape":"SslPolicyName", "documentation":"

The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.

" }, "DefaultActions":{ "shape":"Actions", "documentation":"

The default actions for the listener.

" } }, "documentation":"

Information about a listener.

" }, "ListenerArn":{"type":"string"}, "ListenerArns":{ "type":"list", "member":{"shape":"ListenerArn"} }, "ListenerNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified listener does not exist.

", "error":{ "code":"ListenerNotFound", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Listeners":{ "type":"list", "member":{"shape":"Listener"} }, "LoadBalancer":{ "type":"structure", "members":{ "LoadBalancerArn":{ "shape":"LoadBalancerArn", "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" }, "DNSName":{ "shape":"DNSName", "documentation":"

The public DNS name of the load balancer.

" }, "CanonicalHostedZoneId":{ "shape":"CanonicalHostedZoneId", "documentation":"

The ID of the Amazon Route 53 hosted zone associated with the load balancer.

" }, "CreatedTime":{ "shape":"CreatedTime", "documentation":"

The date and time the load balancer was created.

" }, "LoadBalancerName":{ "shape":"LoadBalancerName", "documentation":"

The name of the load balancer.

" }, "Scheme":{ "shape":"LoadBalancerSchemeEnum", "documentation":"

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the Internet.

The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer.

" }, "VpcId":{ "shape":"VpcId", "documentation":"

The ID of the VPC for the load balancer.

" }, "State":{ "shape":"LoadBalancerState", "documentation":"

The state of the load balancer.

" }, "Type":{ "shape":"LoadBalancerTypeEnum", "documentation":"

The type of load balancer.

" }, "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

The Availability Zones for the load balancer.

" }, "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

The IDs of the security groups for the load balancer.

" }, "IpAddressType":{ "shape":"IpAddressType", "documentation":"

The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).

" } }, "documentation":"

Information about a load balancer.

" }, "LoadBalancerArn":{"type":"string"}, "LoadBalancerArns":{ "type":"list", "member":{"shape":"LoadBalancerArn"} }, "LoadBalancerAttribute":{ "type":"structure", "members":{ "Key":{ "shape":"LoadBalancerAttributeKey", "documentation":"

The name of the attribute.

  • access_logs.s3.enabled - Indicates whether access logs stored in Amazon S3 are enabled. The value is true or false.

  • access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs in Amazon S3 are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permission to write to the bucket.

  • access_logs.s3.prefix - The prefix for the location in the S3 bucket. If you don't specify a prefix, the access logs are stored in the root of the bucket.

  • deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false.

  • idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-3600. The default is 60 seconds.

" }, "Value":{ "shape":"LoadBalancerAttributeValue", "documentation":"

The value of the attribute.

" } }, "documentation":"

Information about a load balancer attribute.

" }, "LoadBalancerAttributeKey":{ "type":"string", "max":256, "pattern":"^[a-zA-Z0-9._]+$" }, "LoadBalancerAttributeValue":{ "type":"string", "max":1024 }, "LoadBalancerAttributes":{ "type":"list", "member":{"shape":"LoadBalancerAttribute"}, "max":20 }, "LoadBalancerName":{"type":"string"}, "LoadBalancerNames":{ "type":"list", "member":{"shape":"LoadBalancerName"} }, "LoadBalancerNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified load balancer does not exist.

", "error":{ "code":"LoadBalancerNotFound", "httpStatusCode":400, "senderFault":true }, "exception":true }, "LoadBalancerSchemeEnum":{ "type":"string", "enum":[ "internet-facing", "internal" ] }, "LoadBalancerState":{ "type":"structure", "members":{ "Code":{ "shape":"LoadBalancerStateEnum", "documentation":"

The state code. The initial state of the load balancer is provisioning. After the load balancer is fully set up and ready to route traffic, its state is active. If the load balancer could not be set up, its state is failed.

" }, "Reason":{ "shape":"StateReason", "documentation":"

A description of the state.

" } }, "documentation":"

Information about the state of the load balancer.

" }, "LoadBalancerStateEnum":{ "type":"string", "enum":[ "active", "provisioning", "failed" ] }, "LoadBalancerTypeEnum":{ "type":"string", "enum":["application"] }, "LoadBalancers":{ "type":"list", "member":{"shape":"LoadBalancer"} }, "Marker":{"type":"string"}, "Matcher":{ "type":"structure", "required":["HttpCode"], "members":{ "HttpCode":{ "shape":"HttpCode", "documentation":"

The HTTP codes. The default value is 200. You can specify multiple values (for example, \"200,202\") or a range of values (for example, \"200-299\").

" } }, "documentation":"

Information to use when checking for a successful response from a target.

" }, "ModifyListenerInput":{ "type":"structure", "required":["ListenerArn"], "members":{ "ListenerArn":{ "shape":"ListenerArn", "documentation":"

The Amazon Resource Name (ARN) of the listener.

" }, "Port":{ "shape":"Port", "documentation":"

The port for connections from clients to the load balancer.

" }, "Protocol":{ "shape":"ProtocolEnum", "documentation":"

The protocol for connections from clients to the load balancer.

" }, "SslPolicy":{ "shape":"SslPolicyName", "documentation":"

The security policy that defines which ciphers and protocols are supported.

" }, "Certificates":{ "shape":"CertificateList", "documentation":"

The SSL server certificate.

" }, "DefaultActions":{ "shape":"Actions", "documentation":"

The default actions.

" } } }, "ModifyListenerOutput":{ "type":"structure", "members":{ "Listeners":{ "shape":"Listeners", "documentation":"

Information about the modified listeners.

" } } }, "ModifyLoadBalancerAttributesInput":{ "type":"structure", "required":[ "LoadBalancerArn", "Attributes" ], "members":{ "LoadBalancerArn":{ "shape":"LoadBalancerArn", "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" }, "Attributes":{ "shape":"LoadBalancerAttributes", "documentation":"

The load balancer attributes.

" } } }, "ModifyLoadBalancerAttributesOutput":{ "type":"structure", "members":{ "Attributes":{ "shape":"LoadBalancerAttributes", "documentation":"

Information about the load balancer attributes.

" } } }, "ModifyRuleInput":{ "type":"structure", "required":["RuleArn"], "members":{ "RuleArn":{ "shape":"RuleArn", "documentation":"

The Amazon Resource Name (ARN) of the rule.

" }, "Conditions":{ "shape":"RuleConditionList", "documentation":"

The conditions.

" }, "Actions":{ "shape":"Actions", "documentation":"

The actions.

" } } }, "ModifyRuleOutput":{ "type":"structure", "members":{ "Rules":{ "shape":"Rules", "documentation":"

Information about the rule.

" } } }, "ModifyTargetGroupAttributesInput":{ "type":"structure", "required":[ "TargetGroupArn", "Attributes" ], "members":{ "TargetGroupArn":{ "shape":"TargetGroupArn", "documentation":"

The Amazon Resource Name (ARN) of the target group.

" }, "Attributes":{ "shape":"TargetGroupAttributes", "documentation":"

The attributes.

" } } }, "ModifyTargetGroupAttributesOutput":{ "type":"structure", "members":{ "Attributes":{ "shape":"TargetGroupAttributes", "documentation":"

Information about the attributes.

" } } }, "ModifyTargetGroupInput":{ "type":"structure", "required":["TargetGroupArn"], "members":{ "TargetGroupArn":{ "shape":"TargetGroupArn", "documentation":"

The Amazon Resource Name (ARN) of the target group.

" }, "HealthCheckProtocol":{ "shape":"ProtocolEnum", "documentation":"

The protocol to use to connect with the target.

" }, "HealthCheckPort":{ "shape":"HealthCheckPort", "documentation":"

The port to use to connect with the target.

" }, "HealthCheckPath":{ "shape":"Path", "documentation":"

The ping path that is the destination for the health check request.

" }, "HealthCheckIntervalSeconds":{ "shape":"HealthCheckIntervalSeconds", "documentation":"

The approximate amount of time, in seconds, between health checks of an individual target.

" }, "HealthCheckTimeoutSeconds":{ "shape":"HealthCheckTimeoutSeconds", "documentation":"

The amount of time, in seconds, during which no response means a failed health check.

" }, "HealthyThresholdCount":{ "shape":"HealthCheckThresholdCount", "documentation":"

The number of consecutive health checks successes required before considering an unhealthy target healthy.

" }, "UnhealthyThresholdCount":{ "shape":"HealthCheckThresholdCount", "documentation":"

The number of consecutive health check failures required before considering the target unhealthy.

" }, "Matcher":{ "shape":"Matcher", "documentation":"

The HTTP codes to use when checking for a successful response from a target.

" } } }, "ModifyTargetGroupOutput":{ "type":"structure", "members":{ "TargetGroups":{ "shape":"TargetGroups", "documentation":"

Information about the target group.

" } } }, "OperationNotPermittedException":{ "type":"structure", "members":{ }, "documentation":"

This operation is not allowed.

", "error":{ "code":"OperationNotPermitted", "httpStatusCode":400, "senderFault":true }, "exception":true }, "PageSize":{ "type":"integer", "max":400, "min":1 }, "Path":{ "type":"string", "max":1024, "min":1 }, "Port":{ "type":"integer", "max":65535, "min":1 }, "PriorityInUseException":{ "type":"structure", "members":{ }, "documentation":"

The specified priority is in use.

", "error":{ "code":"PriorityInUse", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ProtocolEnum":{ "type":"string", "enum":[ "HTTP", "HTTPS" ] }, "RegisterTargetsInput":{ "type":"structure", "required":[ "TargetGroupArn", "Targets" ], "members":{ "TargetGroupArn":{ "shape":"TargetGroupArn", "documentation":"

The Amazon Resource Name (ARN) of the target group.

" }, "Targets":{ "shape":"TargetDescriptions", "documentation":"

The targets. The default port for a target is the port for the target group. You can specify a port override. If a target is already registered, you can register it again using a different port.

" } } }, "RegisterTargetsOutput":{ "type":"structure", "members":{ } }, "RemoveTagsInput":{ "type":"structure", "required":[ "ResourceArns", "TagKeys" ], "members":{ "ResourceArns":{ "shape":"ResourceArns", "documentation":"

The Amazon Resource Name (ARN) of the resource.

" }, "TagKeys":{ "shape":"TagKeys", "documentation":"

The tag keys for the tags to remove.

" } } }, "RemoveTagsOutput":{ "type":"structure", "members":{ } }, "ResourceArn":{"type":"string"}, "ResourceArns":{ "type":"list", "member":{"shape":"ResourceArn"} }, "ResourceInUseException":{ "type":"structure", "members":{ }, "documentation":"

A specified resource is in use.

", "error":{ "code":"ResourceInUse", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Rule":{ "type":"structure", "members":{ "RuleArn":{ "shape":"RuleArn", "documentation":"

The Amazon Resource Name (ARN) of the rule.

" }, "Priority":{ "shape":"String", "documentation":"

The priority.

" }, "Conditions":{ "shape":"RuleConditionList", "documentation":"

The conditions.

" }, "Actions":{ "shape":"Actions", "documentation":"

The actions.

" }, "IsDefault":{ "shape":"IsDefault", "documentation":"

Indicates whether this is the default rule.

" } }, "documentation":"

Information about a rule.

" }, "RuleArn":{"type":"string"}, "RuleArns":{ "type":"list", "member":{"shape":"RuleArn"} }, "RuleCondition":{ "type":"structure", "members":{ "Field":{ "shape":"ConditionFieldName", "documentation":"

The only possible value is path-pattern.

" }, "Values":{ "shape":"ListOfString", "documentation":"

The path pattern. You can specify a single path pattern.

A path pattern is case sensitive, can be up to 128 characters in length, and can contain any of the following characters. Note that you can include up to three wildcard characters in a path pattern.

  • A-Z, a-z, 0-9

  • _ - . $ / ~ \" ' @ : +

  • & (using &amp;)

  • * (matches 0 or more characters)

  • ? (matches exactly 1 character)

" } }, "documentation":"

Information about a condition for a rule.

" }, "RuleConditionList":{ "type":"list", "member":{"shape":"RuleCondition"} }, "RuleNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified rule does not exist.

", "error":{ "code":"RuleNotFound", "httpStatusCode":400, "senderFault":true }, "exception":true }, "RulePriority":{ "type":"integer", "max":99999, "min":1 }, "RulePriorityList":{ "type":"list", "member":{"shape":"RulePriorityPair"} }, "RulePriorityPair":{ "type":"structure", "members":{ "RuleArn":{ "shape":"RuleArn", "documentation":"

The Amazon Resource Name (ARN) of the rule.

" }, "Priority":{ "shape":"RulePriority", "documentation":"

The rule priority.

" } }, "documentation":"

Information about the priorities for the rules for a listener.

" }, "Rules":{ "type":"list", "member":{"shape":"Rule"} }, "SSLPolicyNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified SSL policy does not exist.

", "error":{ "code":"SSLPolicyNotFound", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SecurityGroupId":{"type":"string"}, "SecurityGroups":{ "type":"list", "member":{"shape":"SecurityGroupId"} }, "SetIpAddressTypeInput":{ "type":"structure", "required":[ "LoadBalancerArn", "IpAddressType" ], "members":{ "LoadBalancerArn":{ "shape":"LoadBalancerArn", "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" }, "IpAddressType":{ "shape":"IpAddressType", "documentation":"

The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4.

" } } }, "SetIpAddressTypeOutput":{ "type":"structure", "members":{ "IpAddressType":{ "shape":"IpAddressType", "documentation":"

The IP address type.

" } } }, "SetRulePrioritiesInput":{ "type":"structure", "required":["RulePriorities"], "members":{ "RulePriorities":{ "shape":"RulePriorityList", "documentation":"

The rule priorities.

" } } }, "SetRulePrioritiesOutput":{ "type":"structure", "members":{ "Rules":{ "shape":"Rules", "documentation":"

Information about the rules.

" } } }, "SetSecurityGroupsInput":{ "type":"structure", "required":[ "LoadBalancerArn", "SecurityGroups" ], "members":{ "LoadBalancerArn":{ "shape":"LoadBalancerArn", "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" }, "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

The IDs of the security groups.

" } } }, "SetSecurityGroupsOutput":{ "type":"structure", "members":{ "SecurityGroupIds":{ "shape":"SecurityGroups", "documentation":"

The IDs of the security groups associated with the load balancer.

" } } }, "SetSubnetsInput":{ "type":"structure", "required":[ "LoadBalancerArn", "Subnets" ], "members":{ "LoadBalancerArn":{ "shape":"LoadBalancerArn", "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" }, "Subnets":{ "shape":"Subnets", "documentation":"

The IDs of the subnets. You must specify at least two subnets. You can add only one subnet per Availability Zone.

" } } }, "SetSubnetsOutput":{ "type":"structure", "members":{ "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

Information about the subnet and Availability Zone.

" } } }, "SslPolicies":{ "type":"list", "member":{"shape":"SslPolicy"} }, "SslPolicy":{ "type":"structure", "members":{ "SslProtocols":{ "shape":"SslProtocols", "documentation":"

The protocols.

" }, "Ciphers":{ "shape":"Ciphers", "documentation":"

The ciphers.

" }, "Name":{ "shape":"SslPolicyName", "documentation":"

The name of the policy.

" } }, "documentation":"

Information about a policy used for SSL negotiation.

" }, "SslPolicyName":{"type":"string"}, "SslPolicyNames":{ "type":"list", "member":{"shape":"SslPolicyName"} }, "SslProtocol":{"type":"string"}, "SslProtocols":{ "type":"list", "member":{"shape":"SslProtocol"} }, "StateReason":{"type":"string"}, "String":{"type":"string"}, "StringValue":{"type":"string"}, "SubnetId":{"type":"string"}, "SubnetNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified subnet does not exist.

", "error":{ "code":"SubnetNotFound", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Subnets":{ "type":"list", "member":{"shape":"SubnetId"} }, "Tag":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"TagKey", "documentation":"

The key of the tag.

" }, "Value":{ "shape":"TagValue", "documentation":"

The value of the tag.

" } }, "documentation":"

Information about a tag.

" }, "TagDescription":{ "type":"structure", "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The Amazon Resource Name (ARN) of the resource.

" }, "Tags":{ "shape":"TagList", "documentation":"

Information about the tags.

" } }, "documentation":"

The tags associated with a resource.

" }, "TagDescriptions":{ "type":"list", "member":{"shape":"TagDescription"} }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"} }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "min":1 }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TargetDescription":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"TargetId", "documentation":"

The ID of the target.

" }, "Port":{ "shape":"Port", "documentation":"

The port on which the target is listening.

" } }, "documentation":"

Information about a target.

" }, "TargetDescriptions":{ "type":"list", "member":{"shape":"TargetDescription"} }, "TargetGroup":{ "type":"structure", "members":{ "TargetGroupArn":{ "shape":"TargetGroupArn", "documentation":"

The Amazon Resource Name (ARN) of the target group.

" }, "TargetGroupName":{ "shape":"TargetGroupName", "documentation":"

The name of the target group.

" }, "Protocol":{ "shape":"ProtocolEnum", "documentation":"

The protocol to use for routing traffic to the targets.

" }, "Port":{ "shape":"Port", "documentation":"

The port on which the targets are listening.

" }, "VpcId":{ "shape":"VpcId", "documentation":"

The ID of the VPC for the targets.

" }, "HealthCheckProtocol":{ "shape":"ProtocolEnum", "documentation":"

The protocol to use to connect with the target.

" }, "HealthCheckPort":{ "shape":"HealthCheckPort", "documentation":"

The port to use to connect with the target.

" }, "HealthCheckIntervalSeconds":{ "shape":"HealthCheckIntervalSeconds", "documentation":"

The approximate amount of time, in seconds, between health checks of an individual target.

" }, "HealthCheckTimeoutSeconds":{ "shape":"HealthCheckTimeoutSeconds", "documentation":"

The amount of time, in seconds, during which no response means a failed health check.

" }, "HealthyThresholdCount":{ "shape":"HealthCheckThresholdCount", "documentation":"

The number of consecutive health checks successes required before considering an unhealthy target healthy.

" }, "UnhealthyThresholdCount":{ "shape":"HealthCheckThresholdCount", "documentation":"

The number of consecutive health check failures required before considering the target unhealthy.

" }, "HealthCheckPath":{ "shape":"Path", "documentation":"

The destination for the health check request.

" }, "Matcher":{ "shape":"Matcher", "documentation":"

The HTTP codes to use when checking for a successful response from a target.

" }, "LoadBalancerArns":{ "shape":"LoadBalancerArns", "documentation":"

The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.

" } }, "documentation":"

Information about a target group.

" }, "TargetGroupArn":{"type":"string"}, "TargetGroupArns":{ "type":"list", "member":{"shape":"TargetGroupArn"} }, "TargetGroupAssociationLimitException":{ "type":"structure", "members":{ }, "documentation":"

You've reached the limit on the number of load balancers per target group.

", "error":{ "code":"TargetGroupAssociationLimit", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TargetGroupAttribute":{ "type":"structure", "members":{ "Key":{ "shape":"TargetGroupAttributeKey", "documentation":"

The name of the attribute.

  • deregistration_delay.timeout_seconds - The amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds.

  • stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false.

  • stickiness.type - The type of sticky sessions. The possible value is lb_cookie.

  • stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).

" }, "Value":{ "shape":"TargetGroupAttributeValue", "documentation":"

The value of the attribute.

" } }, "documentation":"

Information about a target group attribute.

" }, "TargetGroupAttributeKey":{ "type":"string", "max":256, "pattern":"^[a-zA-Z0-9._]+$" }, "TargetGroupAttributeValue":{"type":"string"}, "TargetGroupAttributes":{ "type":"list", "member":{"shape":"TargetGroupAttribute"} }, "TargetGroupName":{"type":"string"}, "TargetGroupNames":{ "type":"list", "member":{"shape":"TargetGroupName"} }, "TargetGroupNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified target group does not exist.

", "error":{ "code":"TargetGroupNotFound", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TargetGroups":{ "type":"list", "member":{"shape":"TargetGroup"} }, "TargetHealth":{ "type":"structure", "members":{ "State":{ "shape":"TargetHealthStateEnum", "documentation":"

The state of the target.

" }, "Reason":{ "shape":"TargetHealthReasonEnum", "documentation":"

The reason code. If the target state is healthy, a reason code is not provided.

If the target state is initial, the reason code can be one of the following values:

  • Elb.RegistrationInProgress - The target is in the process of being registered with the load balancer.

  • Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of health checks required to determine its health status.

If the target state is unhealthy, the reason code can be one of the following values:

  • Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

  • Target.Timeout - The health check requests timed out.

  • Target.FailedHealthChecks - The health checks failed because the connection to the target timed out, the target response was malformed, or the target failed the health check for an unknown reason.

  • Elb.InternalError - The health checks failed due to an internal error.

If the target state is unused, the reason code can be one of the following values:

  • Target.NotRegistered - The target is not registered with the target group.

  • Target.NotInUse - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.

  • Target.InvalidState - The target is in the stopped or terminated state.

If the target state is draining, the reason code can be the following value:

  • Target.DeregistrationInProgress - The target is in the process of being deregistered and the deregistration delay period has not expired.

" }, "Description":{ "shape":"Description", "documentation":"

A description of the target health that provides additional details. If the state is healthy, a description is not provided.

" } }, "documentation":"

Information about the current health of a target.

" }, "TargetHealthDescription":{ "type":"structure", "members":{ "Target":{ "shape":"TargetDescription", "documentation":"

The description of the target.

" }, "HealthCheckPort":{ "shape":"HealthCheckPort", "documentation":"

The port to use to connect with the target.

" }, "TargetHealth":{ "shape":"TargetHealth", "documentation":"

The health information for the target.

" } }, "documentation":"

Information about the health of a target.

" }, "TargetHealthDescriptions":{ "type":"list", "member":{"shape":"TargetHealthDescription"} }, "TargetHealthReasonEnum":{ "type":"string", "enum":[ "Elb.RegistrationInProgress", "Elb.InitialHealthChecking", "Target.ResponseCodeMismatch", "Target.Timeout", "Target.FailedHealthChecks", "Target.NotRegistered", "Target.NotInUse", "Target.DeregistrationInProgress", "Target.InvalidState", "Elb.InternalError" ] }, "TargetHealthStateEnum":{ "type":"string", "enum":[ "initial", "healthy", "unhealthy", "unused", "draining" ] }, "TargetId":{"type":"string"}, "TooManyCertificatesException":{ "type":"structure", "members":{ }, "documentation":"

You've reached the limit on the number of certificates per listener.

", "error":{ "code":"TooManyCertificates", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TooManyListenersException":{ "type":"structure", "members":{ }, "documentation":"

You've reached the limit on the number of listeners per load balancer.

", "error":{ "code":"TooManyListeners", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TooManyLoadBalancersException":{ "type":"structure", "members":{ }, "documentation":"

You've reached the limit on the number of load balancers for your AWS account.

", "error":{ "code":"TooManyLoadBalancers", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TooManyRegistrationsForTargetIdException":{ "type":"structure", "members":{ }, "documentation":"

You've reached the limit on the number of times a target can be registered with a load balancer.

", "error":{ "code":"TooManyRegistrationsForTargetId", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TooManyRulesException":{ "type":"structure", "members":{ }, "documentation":"

You've reached the limit on the number of rules per load balancer.

", "error":{ "code":"TooManyRules", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TooManyTagsException":{ "type":"structure", "members":{ }, "documentation":"

You've reached the limit on the number of tags per load balancer.

", "error":{ "code":"TooManyTags", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TooManyTargetGroupsException":{ "type":"structure", "members":{ }, "documentation":"

You've reached the limit on the number of target groups for your AWS account.

", "error":{ "code":"TooManyTargetGroups", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TooManyTargetsException":{ "type":"structure", "members":{ }, "documentation":"

You've reached the limit on the number of targets.

", "error":{ "code":"TooManyTargets", "httpStatusCode":400, "senderFault":true }, "exception":true }, "UnsupportedProtocolException":{ "type":"structure", "members":{ }, "documentation":"

The specified protocol is not supported.

", "error":{ "code":"UnsupportedProtocol", "httpStatusCode":400, "senderFault":true }, "exception":true }, "VpcId":{"type":"string"}, "ZoneName":{"type":"string"} }, "documentation":"Elastic Load Balancing

A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.

Elastic Load Balancing supports two types of load balancers: Classic Load Balancers and Application Load Balancers. A Classic Load Balancer makes routing and load balancing decisions either at the transport layer (TCP/SSL) or the application layer (HTTP/HTTPS), and supports either EC2-Classic or a VPC. An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS), supports path-based routing, and can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC). For more information, see the Elastic Load Balancing User Guide.

This reference covers the 2015-12-01 API, which supports Application Load Balancers. The 2012-06-01 API supports Classic Load Balancers.

To get started, complete the following tasks:

  1. Create an Application Load Balancer using CreateLoadBalancer.

  2. Create a target group using CreateTargetGroup.

  3. Register targets for the target group using RegisterTargets.

  4. Create one or more listeners for your load balancer using CreateListener.

  5. (Optional) Create one or more rules for content routing based on URL using CreateRule.

To delete an Application Load Balancer and its related resources, complete the following tasks:

  1. Delete the load balancer using DeleteLoadBalancer.

  2. Delete the target group using DeleteTargetGroup.

All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.

" } botocore-1.5.7/botocore/data/elasticbeanstalk/0000777454262600001440000000000013042511307022444 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/elasticbeanstalk/2010-12-01/0000777454262600001440000000000013042511307023464 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/elasticbeanstalk/2010-12-01/examples-1.json0000666454262600001440000011111113042511306026326 0ustar pysdk-ciamazon00000000000000{ "version": "1.0", "examples": { "AbortEnvironmentUpdate": [ { "input": { "EnvironmentName": "my-env" }, "comments": { "input": { }, "output": { } }, "description": "The following code aborts a running application version deployment for an environment named my-env:", "id": "to-abort-a-deployment-1456267848227", "title": "To abort a deployment" } ], "CheckDNSAvailability": [ { "input": { "CNAMEPrefix": "my-cname" }, "output": { "Available": true, "FullyQualifiedCNAME": "my-cname.us-west-2.elasticbeanstalk.com" }, "comments": { "input": { }, "output": { } }, "description": "The following operation checks the availability of the subdomain my-cname:", "id": "to-check-the-availability-of-a-cname-1456268589537", "title": "To check the availability of a CNAME" } ], "CreateApplication": [ { "input": { "ApplicationName": "my-app", "Description": "my application" }, "output": { "Application": { "ApplicationName": "my-app", "ConfigurationTemplates": [ ], "DateCreated": "2015-02-12T18:32:21.181Z", "DateUpdated": "2015-02-12T18:32:21.181Z", "Description": "my application" } }, "comments": { "input": { }, "output": { } }, "description": "The following operation creates a new application named my-app:", "id": "to-create-a-new-application-1456268895683", "title": "To create a new application" } ], "CreateApplicationVersion": [ { "input": { "ApplicationName": "my-app", "AutoCreateApplication": true, "Description": "my-app-v1", "Process": true, "SourceBundle": { "S3Bucket": "my-bucket", "S3Key": "sample.war" }, "VersionLabel": "v1" }, "output": { "ApplicationVersion": { "ApplicationName": "my-app", "DateCreated": "2015-02-03T23:01:25.412Z", "DateUpdated": "2015-02-03T23:01:25.412Z", "Description": "my-app-v1", "SourceBundle": { "S3Bucket": "my-bucket", "S3Key": "sample.war" }, "VersionLabel": "v1" } }, "comments": { "input": { }, "output": { } }, "description": "The following operation creates a new version (v1) of an application named my-app:", "id": "to-create-a-new-application-1456268895683", "title": "To create a new application" } ], "CreateConfigurationTemplate": [ { "input": { "ApplicationName": "my-app", "EnvironmentId": "e-rpqsewtp2j", "TemplateName": "my-app-v1" }, "output": { "ApplicationName": "my-app", "DateCreated": "2015-08-12T18:40:39Z", "DateUpdated": "2015-08-12T18:40:39Z", "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", "TemplateName": "my-app-v1" }, "comments": { "input": { }, "output": { } }, "description": "The following operation creates a configuration template named my-app-v1 from the settings applied to an environment with the id e-rpqsewtp2j:", "id": "to-create-a-configuration-template-1456269283586", "title": "To create a configuration template" } ], "CreateEnvironment": [ { "input": { "ApplicationName": "my-app", "CNAMEPrefix": "my-app", "EnvironmentName": "my-env", "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", "VersionLabel": "v1" }, "output": { "ApplicationName": "my-app", "CNAME": "my-app.elasticbeanstalk.com", "DateCreated": "2015-02-03T23:04:54.479Z", "DateUpdated": "2015-02-03T23:04:54.479Z", "EnvironmentId": "e-izqpassy4h", "EnvironmentName": "my-env", "Health": "Grey", "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", "Status": "Launching", "Tier": { "Name": "WebServer", "Type": "Standard", "Version": " " }, "VersionLabel": "v1" }, "comments": { "input": { }, "output": { } }, "description": "The following operation creates a new environment for version v1 of a java application named my-app:", "id": "to-create-a-new-environment-for-an-application-1456269380396", "title": "To create a new environment for an application" } ], "CreateStorageLocation": [ { "output": { "S3Bucket": "elasticbeanstalk-us-west-2-0123456789012" }, "comments": { "input": { }, "output": { } }, "description": "The following operation creates a new environment for version v1 of a java application named my-app:", "id": "to-create-a-new-environment-for-an-application-1456269380396", "title": "To create a new environment for an application" } ], "DeleteApplication": [ { "input": { "ApplicationName": "my-app" }, "comments": { "input": { }, "output": { } }, "description": "The following operation deletes an application named my-app:", "id": "to-delete-an-application-1456269699366", "title": "To delete an application" } ], "DeleteApplicationVersion": [ { "input": { "ApplicationName": "my-app", "DeleteSourceBundle": true, "VersionLabel": "22a0-stage-150819_182129" }, "comments": { "input": { }, "output": { } }, "description": "The following operation deletes an application version named 22a0-stage-150819_182129 for an application named my-app:", "id": "to-delete-an-application-version-1456269792956", "title": "To delete an application version" } ], "DeleteConfigurationTemplate": [ { "input": { "ApplicationName": "my-app", "TemplateName": "my-template" }, "comments": { "input": { }, "output": { } }, "description": "The following operation deletes a configuration template named my-template for an application named my-app:", "id": "to-delete-a-configuration-template-1456269836701", "title": "To delete a configuration template" } ], "DeleteEnvironmentConfiguration": [ { "input": { "ApplicationName": "my-app", "EnvironmentName": "my-env" }, "comments": { "input": { }, "output": { } }, "description": "The following operation deletes a draft configuration for an environment named my-env:", "id": "to-delete-a-draft-configuration-1456269886654", "title": "To delete a draft configuration" } ], "DescribeApplicationVersions": [ { "input": { "ApplicationName": "my-app", "VersionLabels": [ "v2" ] }, "output": { "ApplicationVersions": [ { "ApplicationName": "my-app", "DateCreated": "2015-07-23T01:32:26.079Z", "DateUpdated": "2015-07-23T01:32:26.079Z", "Description": "update cover page", "SourceBundle": { "S3Bucket": "elasticbeanstalk-us-west-2-015321684451", "S3Key": "my-app/5026-stage-150723_224258.war" }, "VersionLabel": "v2" }, { "ApplicationName": "my-app", "DateCreated": "2015-07-23T22:26:10.816Z", "DateUpdated": "2015-07-23T22:26:10.816Z", "Description": "initial version", "SourceBundle": { "S3Bucket": "elasticbeanstalk-us-west-2-015321684451", "S3Key": "my-app/5026-stage-150723_222618.war" }, "VersionLabel": "v1" } ] }, "comments": { "input": { }, "output": { } }, "description": "The following operation retrieves information about an application version labeled v2:", "id": "to-view-information-about-an-application-version-1456269947428", "title": "To view information about an application version" } ], "DescribeApplications": [ { "input": { }, "output": { "Applications": [ { "ApplicationName": "ruby", "ConfigurationTemplates": [ ], "DateCreated": "2015-08-13T21:05:44.376Z", "DateUpdated": "2015-08-13T21:05:44.376Z", "Versions": [ "Sample Application" ] }, { "ApplicationName": "pythonsample", "ConfigurationTemplates": [ ], "DateCreated": "2015-08-13T19:05:43.637Z", "DateUpdated": "2015-08-13T19:05:43.637Z", "Description": "Application created from the EB CLI using \"eb init\"", "Versions": [ "Sample Application" ] }, { "ApplicationName": "nodejs-example", "ConfigurationTemplates": [ ], "DateCreated": "2015-08-06T17:50:02.486Z", "DateUpdated": "2015-08-06T17:50:02.486Z", "Versions": [ "add elasticache", "First Release" ] } ] }, "comments": { "input": { }, "output": { } }, "description": "The following operation retrieves information about applications in the current region:", "id": "to-view-a-list-of-applications-1456270027373", "title": "To view a list of applications" } ], "DescribeConfigurationOptions": [ { "input": { "ApplicationName": "my-app", "EnvironmentName": "my-env" }, "output": { "Options": [ { "ChangeSeverity": "NoInterruption", "DefaultValue": "30", "MaxValue": 300, "MinValue": 5, "Name": "Interval", "Namespace": "aws:elb:healthcheck", "UserDefined": false, "ValueType": "Scalar" }, { "ChangeSeverity": "NoInterruption", "DefaultValue": "2000000", "MinValue": 0, "Name": "LowerThreshold", "Namespace": "aws:autoscaling:trigger", "UserDefined": false, "ValueType": "Scalar" } ] }, "comments": { "input": { }, "output": { } }, "description": "The following operation retrieves descriptions of all available configuration options for an environment named my-env:", "id": "to-view-configuration-options-for-an-environment-1456276763917", "title": "To view configuration options for an environment" } ], "DescribeConfigurationSettings": [ { "input": { "ApplicationName": "my-app", "EnvironmentName": "my-env" }, "output": { "ConfigurationSettings": [ { "ApplicationName": "my-app", "DateCreated": "2015-08-13T19:16:25Z", "DateUpdated": "2015-08-13T23:30:07Z", "DeploymentStatus": "deployed", "Description": "Environment created from the EB CLI using \"eb create\"", "EnvironmentName": "my-env", "OptionSettings": [ { "Namespace": "aws:autoscaling:asg", "OptionName": "Availability Zones", "ResourceName": "AWSEBAutoScalingGroup", "Value": "Any" }, { "Namespace": "aws:autoscaling:asg", "OptionName": "Cooldown", "ResourceName": "AWSEBAutoScalingGroup", "Value": "360" }, { "Namespace": "aws:elb:policies", "OptionName": "ConnectionDrainingTimeout", "ResourceName": "AWSEBLoadBalancer", "Value": "20" }, { "Namespace": "aws:elb:policies", "OptionName": "ConnectionSettingIdleTimeout", "ResourceName": "AWSEBLoadBalancer", "Value": "60" } ], "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8" } ] }, "comments": { "input": { }, "output": { "abbreviated": "Output is abbreviated" } }, "description": "The following operation retrieves configuration settings for an environment named my-env:", "id": "to-view-configurations-settings-for-an-environment-1456276924537", "title": "To view configurations settings for an environment" } ], "DescribeEnvironmentHealth": [ { "input": { "AttributeNames": [ "All" ], "EnvironmentName": "my-env" }, "output": { "ApplicationMetrics": { "Duration": 10, "Latency": { "P10": 0.001, "P50": 0.001, "P75": 0.002, "P85": 0.003, "P90": 0.003, "P95": 0.004, "P99": 0.004, "P999": 0.004 }, "RequestCount": 45, "StatusCodes": { "Status2xx": 45, "Status3xx": 0, "Status4xx": 0, "Status5xx": 0 } }, "Causes": [ ], "Color": "Green", "EnvironmentName": "my-env", "HealthStatus": "Ok", "InstancesHealth": { "Degraded": 0, "Info": 0, "NoData": 0, "Ok": 1, "Pending": 0, "Severe": 0, "Unknown": 0, "Warning": 0 }, "RefreshedAt": "2015-08-20T21:09:18Z" }, "comments": { "input": { }, "output": { } }, "description": "The following operation retrieves overall health information for an environment named my-env:", "id": "to-view-environment-health-1456277109510", "title": "To view environment health" } ], "DescribeEnvironmentResources": [ { "input": { "EnvironmentName": "my-env" }, "output": { "EnvironmentResources": { "AutoScalingGroups": [ { "Name": "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingGroup-QSB2ZO88SXZT" } ], "EnvironmentName": "my-env", "Instances": [ { "Id": "i-0c91c786" } ], "LaunchConfigurations": [ { "Name": "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingLaunchConfiguration-1UUVQIBC96TQ2" } ], "LoadBalancers": [ { "Name": "awseb-e-q-AWSEBLoa-1EEPZ0K98BIF0" } ], "Queues": [ ], "Triggers": [ ] } }, "comments": { "input": { }, "output": { } }, "description": "The following operation retrieves information about resources in an environment named my-env:", "id": "to-view-information-about-the-aws-resources-in-your-environment-1456277206232", "title": "To view information about the AWS resources in your environment" } ], "DescribeEnvironments": [ { "input": { "EnvironmentNames": [ "my-env" ] }, "output": { "Environments": [ { "AbortableOperationInProgress": false, "ApplicationName": "my-app", "CNAME": "my-env.elasticbeanstalk.com", "DateCreated": "2015-08-07T20:48:49.599Z", "DateUpdated": "2015-08-12T18:16:55.019Z", "EndpointURL": "awseb-e-w-AWSEBLoa-1483140XB0Q4L-109QXY8121.us-west-2.elb.amazonaws.com", "EnvironmentId": "e-rpqsewtp2j", "EnvironmentName": "my-env", "Health": "Green", "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", "Status": "Ready", "Tier": { "Name": "WebServer", "Type": "Standard", "Version": " " }, "VersionLabel": "7f58-stage-150812_025409" } ] }, "comments": { "input": { }, "output": { } }, "description": "The following operation retrieves information about an environment named my-env:", "id": "to-view-information-about-an-environment-1456277288662", "title": "To view information about an environment" } ], "DescribeEvents": [ { "input": { "EnvironmentName": "my-env" }, "output": { "Events": [ { "ApplicationName": "my-app", "EnvironmentName": "my-env", "EventDate": "2015-08-20T07:06:53.535Z", "Message": "Environment health has transitioned from Info to Ok.", "Severity": "INFO" }, { "ApplicationName": "my-app", "EnvironmentName": "my-env", "EventDate": "2015-08-20T07:06:02.049Z", "Message": "Environment update completed successfully.", "RequestId": "b7f3960b-4709-11e5-ba1e-07e16200da41", "Severity": "INFO" }, { "ApplicationName": "my-app", "EnvironmentName": "my-env", "EventDate": "2015-08-13T19:16:27.561Z", "Message": "Using elasticbeanstalk-us-west-2-012445113685 as Amazon S3 storage bucket for environment data.", "RequestId": "ca8dfbf6-41ef-11e5-988b-651aa638f46b", "Severity": "INFO" }, { "ApplicationName": "my-app", "EnvironmentName": "my-env", "EventDate": "2015-08-13T19:16:26.581Z", "Message": "createEnvironment is starting.", "RequestId": "cdfba8f6-41ef-11e5-988b-65638f41aa6b", "Severity": "INFO" } ] }, "comments": { "input": { }, "output": { } }, "description": "The following operation retrieves events for an environment named my-env:", "id": "to-view-events-for-an-environment-1456277367589", "title": "To view events for an environment" } ], "DescribeInstancesHealth": [ { "input": { "AttributeNames": [ "All" ], "EnvironmentName": "my-env" }, "output": { "InstanceHealthList": [ { "ApplicationMetrics": { "Duration": 10, "Latency": { "P10": 0, "P50": 0.001, "P75": 0.002, "P85": 0.003, "P90": 0.004, "P95": 0.005, "P99": 0.006, "P999": 0.006 }, "RequestCount": 48, "StatusCodes": { "Status2xx": 47, "Status3xx": 0, "Status4xx": 1, "Status5xx": 0 } }, "Causes": [ ], "Color": "Green", "HealthStatus": "Ok", "InstanceId": "i-08691cc7", "LaunchedAt": "2015-08-13T19:17:09Z", "System": { "CPUUtilization": { "IOWait": 0.2, "IRQ": 0, "Idle": 97.8, "Nice": 0.1, "SoftIRQ": 0.1, "System": 0.3, "User": 1.5 }, "LoadAverage": [ 0, 0.02, 0.05 ] } } ], "RefreshedAt": "2015-08-20T21:09:08Z" }, "comments": { "input": { }, "output": { } }, "description": "The following operation retrieves health information for instances in an environment named my-env:", "id": "to-view-environment-health-1456277424757", "title": "To view environment health" } ], "ListAvailableSolutionStacks": [ { "output": { "SolutionStackDetails": [ { "PermittedFileTypes": [ "zip" ], "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Node.js" } ], "SolutionStacks": [ "64bit Amazon Linux 2015.03 v2.0.0 running Node.js", "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.6", "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.5", "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.4", "64bit Amazon Linux 2015.03 v2.0.0 running Python 3.4", "64bit Amazon Linux 2015.03 v2.0.0 running Python 2.7", "64bit Amazon Linux 2015.03 v2.0.0 running Python", "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Puma)", "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Passenger Standalone)", "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Puma)", "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Passenger Standalone)", "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Puma)", "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Passenger Standalone)", "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 1.9.3", "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 7", "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 6", "64bit Windows Server Core 2012 R2 running IIS 8.5", "64bit Windows Server 2012 R2 running IIS 8.5", "64bit Windows Server 2012 running IIS 8", "64bit Windows Server 2008 R2 running IIS 7.5", "64bit Amazon Linux 2015.03 v2.0.0 running Docker 1.6.2", "64bit Amazon Linux 2015.03 v2.0.0 running Multi-container Docker 1.6.2 (Generic)", "64bit Debian jessie v2.0.0 running GlassFish 4.1 Java 8 (Preconfigured - Docker)", "64bit Debian jessie v2.0.0 running GlassFish 4.0 Java 7 (Preconfigured - Docker)", "64bit Debian jessie v2.0.0 running Go 1.4 (Preconfigured - Docker)", "64bit Debian jessie v2.0.0 running Go 1.3 (Preconfigured - Docker)", "64bit Debian jessie v2.0.0 running Python 3.4 (Preconfigured - Docker)" ] }, "comments": { "input": { }, "output": { } }, "description": "The following operation lists solution stacks for all currently available platform configurations and any that you have used in the past:", "id": "to-view-solution-stacks-1456277504811", "title": "To view solution stacks" } ], "RebuildEnvironment": [ { "input": { "EnvironmentName": "my-env" }, "comments": { "input": { }, "output": { } }, "description": "The following operation terminates and recreates the resources in an environment named my-env:", "id": "to-rebuild-an-environment-1456277600918", "title": "To rebuild an environment" } ], "RequestEnvironmentInfo": [ { "input": { "EnvironmentName": "my-env", "InfoType": "tail" }, "comments": { "input": { }, "output": { } }, "description": "The following operation requests logs from an environment named my-env:", "id": "to-request-tailed-logs-1456277657045", "title": "To request tailed logs" } ], "RestartAppServer": [ { "input": { "EnvironmentName": "my-env" }, "comments": { "input": { }, "output": { } }, "description": "The following operation restarts application servers on all instances in an environment named my-env:", "id": "to-restart-application-servers-1456277739302", "title": "To restart application servers" } ], "RetrieveEnvironmentInfo": [ { "input": { "EnvironmentName": "my-env", "InfoType": "tail" }, "output": { "EnvironmentInfo": [ { "Ec2InstanceId": "i-09c1c867", "InfoType": "tail", "Message": "https://elasticbeanstalk-us-west-2-0123456789012.s3.amazonaws.com/resources/environments/logs/tail/e-fyqyju3yjs/i-09c1c867/TailLogs-1440109397703.out?AWSAccessKeyId=AKGPT4J56IAJ2EUBL5CQ&Expires=1440195891&Signature=n%2BEalOV6A2HIOx4Rcfb7LT16bBM%3D", "SampleTimestamp": "2015-08-20T22:23:17.703Z" } ] }, "comments": { "input": { }, "output": { } }, "description": "The following operation retrieves a link to logs from an environment named my-env:", "id": "to-retrieve-tailed-logs-1456277792734", "title": "To retrieve tailed logs" } ], "SwapEnvironmentCNAMEs": [ { "input": { "DestinationEnvironmentName": "my-env-green", "SourceEnvironmentName": "my-env-blue" }, "comments": { "input": { }, "output": { } }, "description": "The following operation swaps the assigned subdomains of two environments:", "id": "to-swap-environment-cnames-1456277839438", "title": "To swap environment CNAMES" } ], "TerminateEnvironment": [ { "input": { "EnvironmentName": "my-env" }, "output": { "AbortableOperationInProgress": false, "ApplicationName": "my-app", "CNAME": "my-env.elasticbeanstalk.com", "DateCreated": "2015-08-12T18:52:53.622Z", "DateUpdated": "2015-08-12T19:05:54.744Z", "EndpointURL": "awseb-e-f-AWSEBLoa-1I9XUMP4-8492WNUP202574.us-west-2.elb.amazonaws.com", "EnvironmentId": "e-fh2eravpns", "EnvironmentName": "my-env", "Health": "Grey", "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", "Status": "Terminating", "Tier": { "Name": "WebServer", "Type": "Standard", "Version": " " } }, "comments": { "input": { }, "output": { } }, "description": "The following operation terminates an Elastic Beanstalk environment named my-env:", "id": "to-terminate-an-environment-1456277888556", "title": "To terminate an environment" } ], "UpdateApplication": [ { "input": { "ApplicationName": "my-app", "Description": "my Elastic Beanstalk application" }, "output": { "Application": { "ApplicationName": "my-app", "ConfigurationTemplates": [ ], "DateCreated": "2015-08-13T19:15:50.449Z", "DateUpdated": "2015-08-20T22:34:56.195Z", "Description": "my Elastic Beanstalk application", "Versions": [ "2fba-stage-150819_234450", "bf07-stage-150820_214945", "93f8", "fd7c-stage-150820_000431", "22a0-stage-150819_185942" ] } }, "comments": { "input": { }, "output": { } }, "description": "The following operation updates the description of an application named my-app:", "id": "to-change-an-applications-description-1456277957075", "title": "To change an application's description" } ], "UpdateApplicationVersion": [ { "input": { "ApplicationName": "my-app", "Description": "new description", "VersionLabel": "22a0-stage-150819_185942" }, "output": { "ApplicationVersion": { "ApplicationName": "my-app", "DateCreated": "2015-08-19T18:59:17.646Z", "DateUpdated": "2015-08-20T22:53:28.871Z", "Description": "new description", "SourceBundle": { "S3Bucket": "elasticbeanstalk-us-west-2-0123456789012", "S3Key": "my-app/22a0-stage-150819_185942.war" }, "VersionLabel": "22a0-stage-150819_185942" } }, "comments": { "input": { }, "output": { } }, "description": "The following operation updates the description of an application version named 22a0-stage-150819_185942:", "id": "to-change-an-application-versions-description-1456278019237", "title": "To change an application version's description" } ], "UpdateConfigurationTemplate": [ { "input": { "ApplicationName": "my-app", "OptionsToRemove": [ { "Namespace": "aws:elasticbeanstalk:healthreporting:system", "OptionName": "ConfigDocument" } ], "TemplateName": "my-template" }, "output": { "ApplicationName": "my-app", "DateCreated": "2015-08-20T22:39:31Z", "DateUpdated": "2015-08-20T22:43:11Z", "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", "TemplateName": "my-template" }, "comments": { "input": { }, "output": { } }, "description": "The following operation removes the configured CloudWatch custom health metrics configuration ConfigDocument from a saved configuration template named my-template:", "id": "to-update-a-configuration-template-1456278075300", "title": "To update a configuration template" } ], "UpdateEnvironment": [ { "input": { "EnvironmentName": "my-env", "VersionLabel": "v2" }, "output": { "ApplicationName": "my-app", "CNAME": "my-env.elasticbeanstalk.com", "DateCreated": "2015-02-03T23:04:54.453Z", "DateUpdated": "2015-02-03T23:12:29.119Z", "EndpointURL": "awseb-e-i-AWSEBLoa-1RDLX6TC9VUAO-0123456789.us-west-2.elb.amazonaws.com", "EnvironmentId": "e-szqipays4h", "EnvironmentName": "my-env", "Health": "Grey", "SolutionStackName": "64bit Amazon Linux running Tomcat 7", "Status": "Updating", "Tier": { "Name": "WebServer", "Type": "Standard", "Version": " " }, "VersionLabel": "v2" }, "comments": { "input": { }, "output": { } }, "description": "The following operation updates an environment named \"my-env\" to version \"v2\" of the application to which it belongs:", "id": "to-update-an-environment-to-a-new-version-1456278210718", "title": "To update an environment to a new version" }, { "input": { "EnvironmentName": "my-env", "OptionSettings": [ { "Namespace": "aws:elb:healthcheck", "OptionName": "Interval", "Value": "15" }, { "Namespace": "aws:elb:healthcheck", "OptionName": "Timeout", "Value": "8" }, { "Namespace": "aws:elb:healthcheck", "OptionName": "HealthyThreshold", "Value": "2" }, { "Namespace": "aws:elb:healthcheck", "OptionName": "UnhealthyThreshold", "Value": "3" } ] }, "output": { "AbortableOperationInProgress": true, "ApplicationName": "my-app", "CNAME": "my-env.elasticbeanstalk.com", "DateCreated": "2015-08-07T20:48:49.599Z", "DateUpdated": "2015-08-12T18:15:23.804Z", "EndpointURL": "awseb-e-w-AWSEBLoa-14XB83101Q4L-104QXY80921.sa-east-1.elb.amazonaws.com", "EnvironmentId": "e-wtp2rpqsej", "EnvironmentName": "my-env", "Health": "Grey", "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", "Status": "Updating", "Tier": { "Name": "WebServer", "Type": "Standard", "Version": " " }, "VersionLabel": "7f58-stage-150812_025409" }, "comments": { "input": { }, "output": { } }, "description": "The following operation configures several options in the aws:elb:loadbalancer namespace:", "id": "to-configure-option-settings-1456278286349", "title": "To configure option settings" } ], "ValidateConfigurationSettings": [ { "input": { "ApplicationName": "my-app", "EnvironmentName": "my-env", "OptionSettings": [ { "Namespace": "aws:elasticbeanstalk:healthreporting:system", "OptionName": "ConfigDocument", "Value": "{\"CloudWatchMetrics\": {\"Environment\": {\"ApplicationLatencyP99.9\": null,\"InstancesSevere\": 60,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": 60,\"InstancesUnknown\": 60,\"ApplicationLatencyP85\": 60,\"InstancesInfo\": null,\"ApplicationRequests2xx\": null,\"InstancesDegraded\": null,\"InstancesWarning\": 60,\"ApplicationLatencyP50\": 60,\"ApplicationRequestsTotal\": null,\"InstancesNoData\": null,\"InstancesPending\": 60,\"ApplicationLatencyP10\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": null,\"InstancesOk\": 60,\"ApplicationRequests3xx\": null,\"ApplicationRequests4xx\": null},\"Instance\": {\"ApplicationLatencyP99.9\": null,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": null,\"ApplicationLatencyP85\": null,\"CPUUser\": 60,\"ApplicationRequests2xx\": null,\"CPUIdle\": null,\"ApplicationLatencyP50\": null,\"ApplicationRequestsTotal\": 60,\"RootFilesystemUtil\": null,\"LoadAverage1min\": null,\"CPUIrq\": null,\"CPUNice\": 60,\"CPUIowait\": 60,\"ApplicationLatencyP10\": null,\"LoadAverage5min\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": 60,\"CPUSystem\": 60,\"ApplicationRequests3xx\": 60,\"ApplicationRequests4xx\": null,\"InstanceHealth\": null,\"CPUSoftirq\": 60}},\"Version\": 1}" } ] }, "output": { "Messages": [ ] }, "comments": { "input": { }, "output": { } }, "description": "The following operation validates a CloudWatch custom metrics config document:", "id": "to-validate-configuration-settings-1456278393654", "title": "To validate configuration settings" } ] } } botocore-1.5.7/botocore/data/elasticbeanstalk/2010-12-01/paginators-1.json0000666454262600001440000000027313042511306026665 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeEvents": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxRecords", "result_key": "Events" } } } botocore-1.5.7/botocore/data/elasticbeanstalk/2010-12-01/service-2.json0000777454262600001440000043501713042511306026172 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2010-12-01", "endpointPrefix":"elasticbeanstalk", "protocol":"query", "serviceAbbreviation":"Elastic Beanstalk", "serviceFullName":"AWS Elastic Beanstalk", "signatureVersion":"v4", "uid":"elasticbeanstalk-2010-12-01", "xmlNamespace":"http://elasticbeanstalk.amazonaws.com/docs/2010-12-01/" }, "operations":{ "AbortEnvironmentUpdate":{ "name":"AbortEnvironmentUpdate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AbortEnvironmentUpdateMessage"}, "errors":[ {"shape":"InsufficientPrivilegesException"} ], "documentation":"

Cancels in-progress environment configuration update or application version deployment.

" }, "ApplyEnvironmentManagedAction":{ "name":"ApplyEnvironmentManagedAction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ApplyEnvironmentManagedActionRequest"}, "output":{ "shape":"ApplyEnvironmentManagedActionResult", "resultWrapper":"ApplyEnvironmentManagedActionResult" }, "errors":[ {"shape":"ElasticBeanstalkServiceException"}, {"shape":"ManagedActionInvalidStateException"} ], "documentation":"

Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.

" }, "CheckDNSAvailability":{ "name":"CheckDNSAvailability", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CheckDNSAvailabilityMessage"}, "output":{ "shape":"CheckDNSAvailabilityResultMessage", "resultWrapper":"CheckDNSAvailabilityResult" }, "documentation":"

Checks if the specified CNAME is available.

" }, "ComposeEnvironments":{ "name":"ComposeEnvironments", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ComposeEnvironmentsMessage"}, "output":{ "shape":"EnvironmentDescriptionsMessage", "resultWrapper":"ComposeEnvironmentsResult" }, "errors":[ {"shape":"TooManyEnvironmentsException"}, {"shape":"InsufficientPrivilegesException"} ], "documentation":"

Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named env.yaml. See Compose Environments for details.

" }, "CreateApplication":{ "name":"CreateApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateApplicationMessage"}, "output":{ "shape":"ApplicationDescriptionMessage", "resultWrapper":"CreateApplicationResult" }, "errors":[ {"shape":"TooManyApplicationsException"} ], "documentation":"

Creates an application that has one configuration template named default and no application versions.

" }, "CreateApplicationVersion":{ "name":"CreateApplicationVersion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateApplicationVersionMessage"}, "output":{ "shape":"ApplicationVersionDescriptionMessage", "resultWrapper":"CreateApplicationVersionResult" }, "errors":[ {"shape":"TooManyApplicationsException"}, {"shape":"TooManyApplicationVersionsException"}, {"shape":"InsufficientPrivilegesException"}, {"shape":"S3LocationNotInServiceRegionException"}, {"shape":"CodeBuildNotInServiceRegionException"} ], "documentation":"

Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:

Specify a commit in an AWS CodeCommit repository with SourceBuildInformation.

Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration.

Specify a source bundle in S3 with SourceBundle

Omit both SourceBuildInformation and SourceBundle to use the default sample application.

Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.

" }, "CreateConfigurationTemplate":{ "name":"CreateConfigurationTemplate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateConfigurationTemplateMessage"}, "output":{ "shape":"ConfigurationSettingsDescription", "resultWrapper":"CreateConfigurationTemplateResult" }, "errors":[ {"shape":"InsufficientPrivilegesException"}, {"shape":"TooManyBucketsException"}, {"shape":"TooManyConfigurationTemplatesException"} ], "documentation":"

Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.

Related Topics

" }, "CreateEnvironment":{ "name":"CreateEnvironment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateEnvironmentMessage"}, "output":{ "shape":"EnvironmentDescription", "resultWrapper":"CreateEnvironmentResult" }, "errors":[ {"shape":"TooManyEnvironmentsException"}, {"shape":"InsufficientPrivilegesException"} ], "documentation":"

Launches an environment for the specified application using the specified configuration.

" }, "CreateStorageLocation":{ "name":"CreateStorageLocation", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"CreateStorageLocationResultMessage", "resultWrapper":"CreateStorageLocationResult" }, "errors":[ {"shape":"TooManyBucketsException"}, {"shape":"S3SubscriptionRequiredException"}, {"shape":"InsufficientPrivilegesException"} ], "documentation":"

Creates the Amazon S3 storage location for the account.

This location is used to store user log files.

" }, "DeleteApplication":{ "name":"DeleteApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteApplicationMessage"}, "errors":[ {"shape":"OperationInProgressException"} ], "documentation":"

Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.

You cannot delete an application that has a running environment.

" }, "DeleteApplicationVersion":{ "name":"DeleteApplicationVersion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteApplicationVersionMessage"}, "errors":[ {"shape":"SourceBundleDeletionException"}, {"shape":"InsufficientPrivilegesException"}, {"shape":"OperationInProgressException"}, {"shape":"S3LocationNotInServiceRegionException"} ], "documentation":"

Deletes the specified version from the specified application.

You cannot delete an application version that is associated with a running environment.

" }, "DeleteConfigurationTemplate":{ "name":"DeleteConfigurationTemplate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteConfigurationTemplateMessage"}, "errors":[ {"shape":"OperationInProgressException"} ], "documentation":"

Deletes the specified configuration template.

When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.

" }, "DeleteEnvironmentConfiguration":{ "name":"DeleteEnvironmentConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteEnvironmentConfigurationMessage"}, "documentation":"

Deletes the draft configuration associated with the running environment.

Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.

" }, "DescribeApplicationVersions":{ "name":"DescribeApplicationVersions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeApplicationVersionsMessage"}, "output":{ "shape":"ApplicationVersionDescriptionsMessage", "resultWrapper":"DescribeApplicationVersionsResult" }, "documentation":"

Retrieve a list of application versions.

" }, "DescribeApplications":{ "name":"DescribeApplications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeApplicationsMessage"}, "output":{ "shape":"ApplicationDescriptionsMessage", "resultWrapper":"DescribeApplicationsResult" }, "documentation":"

Returns the descriptions of existing applications.

" }, "DescribeConfigurationOptions":{ "name":"DescribeConfigurationOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConfigurationOptionsMessage"}, "output":{ "shape":"ConfigurationOptionsDescription", "resultWrapper":"DescribeConfigurationOptionsResult" }, "errors":[ {"shape":"TooManyBucketsException"} ], "documentation":"

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

" }, "DescribeConfigurationSettings":{ "name":"DescribeConfigurationSettings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConfigurationSettingsMessage"}, "output":{ "shape":"ConfigurationSettingsDescriptions", "resultWrapper":"DescribeConfigurationSettingsResult" }, "errors":[ {"shape":"TooManyBucketsException"} ], "documentation":"

Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.

When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

Related Topics

" }, "DescribeEnvironmentHealth":{ "name":"DescribeEnvironmentHealth", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEnvironmentHealthRequest"}, "output":{ "shape":"DescribeEnvironmentHealthResult", "resultWrapper":"DescribeEnvironmentHealthResult" }, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ElasticBeanstalkServiceException"} ], "documentation":"

Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.

" }, "DescribeEnvironmentManagedActionHistory":{ "name":"DescribeEnvironmentManagedActionHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEnvironmentManagedActionHistoryRequest"}, "output":{ "shape":"DescribeEnvironmentManagedActionHistoryResult", "resultWrapper":"DescribeEnvironmentManagedActionHistoryResult" }, "errors":[ {"shape":"ElasticBeanstalkServiceException"} ], "documentation":"

Lists an environment's completed and failed managed actions.

" }, "DescribeEnvironmentManagedActions":{ "name":"DescribeEnvironmentManagedActions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEnvironmentManagedActionsRequest"}, "output":{ "shape":"DescribeEnvironmentManagedActionsResult", "resultWrapper":"DescribeEnvironmentManagedActionsResult" }, "errors":[ {"shape":"ElasticBeanstalkServiceException"} ], "documentation":"

Lists an environment's upcoming and in-progress managed actions.

" }, "DescribeEnvironmentResources":{ "name":"DescribeEnvironmentResources", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEnvironmentResourcesMessage"}, "output":{ "shape":"EnvironmentResourceDescriptionsMessage", "resultWrapper":"DescribeEnvironmentResourcesResult" }, "errors":[ {"shape":"InsufficientPrivilegesException"} ], "documentation":"

Returns AWS resources for this environment.

" }, "DescribeEnvironments":{ "name":"DescribeEnvironments", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEnvironmentsMessage"}, "output":{ "shape":"EnvironmentDescriptionsMessage", "resultWrapper":"DescribeEnvironmentsResult" }, "documentation":"

Returns descriptions for existing environments.

" }, "DescribeEvents":{ "name":"DescribeEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventsMessage"}, "output":{ "shape":"EventDescriptionsMessage", "resultWrapper":"DescribeEventsResult" }, "documentation":"

Returns list of event descriptions matching criteria up to the last 6 weeks.

This action returns the most recent 1,000 events from the specified NextToken.

" }, "DescribeInstancesHealth":{ "name":"DescribeInstancesHealth", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancesHealthRequest"}, "output":{ "shape":"DescribeInstancesHealthResult", "resultWrapper":"DescribeInstancesHealthResult" }, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ElasticBeanstalkServiceException"} ], "documentation":"

Retrives detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.

" }, "ListAvailableSolutionStacks":{ "name":"ListAvailableSolutionStacks", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"ListAvailableSolutionStacksResultMessage", "resultWrapper":"ListAvailableSolutionStacksResult" }, "documentation":"

Returns a list of the available solution stack names.

" }, "RebuildEnvironment":{ "name":"RebuildEnvironment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebuildEnvironmentMessage"}, "errors":[ {"shape":"InsufficientPrivilegesException"} ], "documentation":"

Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.

" }, "RequestEnvironmentInfo":{ "name":"RequestEnvironmentInfo", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RequestEnvironmentInfoMessage"}, "documentation":"

Initiates a request to compile the specified type of information of the deployed environment.

Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.

Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs.

Use RetrieveEnvironmentInfo to obtain the set of logs.

Related Topics

" }, "RestartAppServer":{ "name":"RestartAppServer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestartAppServerMessage"}, "documentation":"

Causes the environment to restart the application container server running on each Amazon EC2 instance.

" }, "RetrieveEnvironmentInfo":{ "name":"RetrieveEnvironmentInfo", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RetrieveEnvironmentInfoMessage"}, "output":{ "shape":"RetrieveEnvironmentInfoResultMessage", "resultWrapper":"RetrieveEnvironmentInfoResult" }, "documentation":"

Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

" }, "SwapEnvironmentCNAMEs":{ "name":"SwapEnvironmentCNAMEs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SwapEnvironmentCNAMEsMessage"}, "documentation":"

Swaps the CNAMEs of two environments.

" }, "TerminateEnvironment":{ "name":"TerminateEnvironment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateEnvironmentMessage"}, "output":{ "shape":"EnvironmentDescription", "resultWrapper":"TerminateEnvironmentResult" }, "errors":[ {"shape":"InsufficientPrivilegesException"} ], "documentation":"

Terminates the specified environment.

" }, "UpdateApplication":{ "name":"UpdateApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateApplicationMessage"}, "output":{ "shape":"ApplicationDescriptionMessage", "resultWrapper":"UpdateApplicationResult" }, "documentation":"

Updates the specified application to have the specified properties.

If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.

" }, "UpdateApplicationResourceLifecycle":{ "name":"UpdateApplicationResourceLifecycle", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateApplicationResourceLifecycleMessage"}, "output":{ "shape":"ApplicationResourceLifecycleDescriptionMessage", "resultWrapper":"UpdateApplicationResourceLifecycleResult" }, "errors":[ {"shape":"InsufficientPrivilegesException"} ], "documentation":"

Modifies lifecycle settings for an application.

" }, "UpdateApplicationVersion":{ "name":"UpdateApplicationVersion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateApplicationVersionMessage"}, "output":{ "shape":"ApplicationVersionDescriptionMessage", "resultWrapper":"UpdateApplicationVersionResult" }, "documentation":"

Updates the specified application version to have the specified properties.

If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string.

" }, "UpdateConfigurationTemplate":{ "name":"UpdateConfigurationTemplate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateConfigurationTemplateMessage"}, "output":{ "shape":"ConfigurationSettingsDescription", "resultWrapper":"UpdateConfigurationTemplateResult" }, "errors":[ {"shape":"InsufficientPrivilegesException"}, {"shape":"TooManyBucketsException"} ], "documentation":"

Updates the specified configuration template to have the specified properties or configuration option values.

If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Related Topics

" }, "UpdateEnvironment":{ "name":"UpdateEnvironment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateEnvironmentMessage"}, "output":{ "shape":"EnvironmentDescription", "resultWrapper":"UpdateEnvironmentResult" }, "errors":[ {"shape":"InsufficientPrivilegesException"}, {"shape":"TooManyBucketsException"} ], "documentation":"

Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.

Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error.

When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.

" }, "ValidateConfigurationSettings":{ "name":"ValidateConfigurationSettings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ValidateConfigurationSettingsMessage"}, "output":{ "shape":"ConfigurationSettingsValidationMessages", "resultWrapper":"ValidateConfigurationSettingsResult" }, "errors":[ {"shape":"InsufficientPrivilegesException"}, {"shape":"TooManyBucketsException"} ], "documentation":"

Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

This action returns a list of messages indicating any errors or warnings associated with the selection of option values.

" } }, "shapes":{ "AbortEnvironmentUpdateMessage":{ "type":"structure", "members":{ "EnvironmentId":{ "shape":"EnvironmentId", "documentation":"

This specifies the ID of the environment with the in-progress update that you want to cancel.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

This specifies the name of the environment with the in-progress update that you want to cancel.

" } }, "documentation":"

" }, "AbortableOperationInProgress":{"type":"boolean"}, "ActionHistoryStatus":{ "type":"string", "enum":[ "Completed", "Failed", "Unknown" ] }, "ActionStatus":{ "type":"string", "enum":[ "Scheduled", "Pending", "Running", "Unknown" ] }, "ActionType":{ "type":"string", "enum":[ "InstanceRefresh", "PlatformUpdate", "Unknown" ] }, "ApplicationDescription":{ "type":"structure", "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application.

" }, "Description":{ "shape":"Description", "documentation":"

User-defined description of the application.

" }, "DateCreated":{ "shape":"CreationDate", "documentation":"

The date when the application was created.

" }, "DateUpdated":{ "shape":"UpdateDate", "documentation":"

The date when the application was last modified.

" }, "Versions":{ "shape":"VersionLabelsList", "documentation":"

The names of the versions for this application.

" }, "ConfigurationTemplates":{ "shape":"ConfigurationTemplateNamesList", "documentation":"

The names of the configuration templates associated with this application.

" }, "ResourceLifecycleConfig":{ "shape":"ApplicationResourceLifecycleConfig", "documentation":"

The lifecycle settings for the application.

" } }, "documentation":"

Describes the properties of an application.

" }, "ApplicationDescriptionList":{ "type":"list", "member":{"shape":"ApplicationDescription"} }, "ApplicationDescriptionMessage":{ "type":"structure", "members":{ "Application":{ "shape":"ApplicationDescription", "documentation":"

The ApplicationDescription of the application.

" } }, "documentation":"

Result message containing a single description of an application.

" }, "ApplicationDescriptionsMessage":{ "type":"structure", "members":{ "Applications":{ "shape":"ApplicationDescriptionList", "documentation":"

This parameter contains a list of ApplicationDescription.

" } }, "documentation":"

Result message containing a list of application descriptions.

" }, "ApplicationMetrics":{ "type":"structure", "members":{ "Duration":{ "shape":"NullableInteger", "documentation":"

The amount of time that the metrics cover (usually 10 seconds). For example, you might have 5 requests (request_count) within the most recent time slice of 10 seconds (duration).

" }, "RequestCount":{ "shape":"RequestCount", "documentation":"

Average number of requests handled by the web server per second over the last 10 seconds.

" }, "StatusCodes":{ "shape":"StatusCodes", "documentation":"

Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response.

" }, "Latency":{ "shape":"Latency", "documentation":"

Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in seconds with one milisecond resolution.

" } }, "documentation":"

Application request metrics for an AWS Elastic Beanstalk environment.

" }, "ApplicationName":{ "type":"string", "max":100, "min":1 }, "ApplicationNamesList":{ "type":"list", "member":{"shape":"ApplicationName"} }, "ApplicationResourceLifecycleConfig":{ "type":"structure", "members":{ "ServiceRole":{ "shape":"String", "documentation":"

The ARN of an IAM service role that Elastic Beanstalk has permission to assume.

" }, "VersionLifecycleConfig":{ "shape":"ApplicationVersionLifecycleConfig", "documentation":"

The application version lifecycle configuration.

" } }, "documentation":"

The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.

" }, "ApplicationResourceLifecycleDescriptionMessage":{ "type":"structure", "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application.

" }, "ResourceLifecycleConfig":{ "shape":"ApplicationResourceLifecycleConfig", "documentation":"

The lifecycle configuration.

" } } }, "ApplicationVersionDescription":{ "type":"structure", "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application to which the application version belongs.

" }, "Description":{ "shape":"Description", "documentation":"

The description of the application version.

" }, "VersionLabel":{ "shape":"VersionLabel", "documentation":"

A unique identifier for the application version.

" }, "SourceBuildInformation":{ "shape":"SourceBuildInformation", "documentation":"

If the version's source code was retrieved from AWS CodeCommit, the location of the source code for the application version.

" }, "BuildArn":{ "shape":"String", "documentation":"

Reference to the artifact from the AWS CodeBuild build.

" }, "SourceBundle":{ "shape":"S3Location", "documentation":"

The storage location of the application version's source bundle in Amazon S3.

" }, "DateCreated":{ "shape":"CreationDate", "documentation":"

The creation date of the application version.

" }, "DateUpdated":{ "shape":"UpdateDate", "documentation":"

The last modified date of the application version.

" }, "Status":{ "shape":"ApplicationVersionStatus", "documentation":"

The processing status of the application version.

" } }, "documentation":"

Describes the properties of an application version.

" }, "ApplicationVersionDescriptionList":{ "type":"list", "member":{"shape":"ApplicationVersionDescription"} }, "ApplicationVersionDescriptionMessage":{ "type":"structure", "members":{ "ApplicationVersion":{ "shape":"ApplicationVersionDescription", "documentation":"

The ApplicationVersionDescription of the application version.

" } }, "documentation":"

Result message wrapping a single description of an application version.

" }, "ApplicationVersionDescriptionsMessage":{ "type":"structure", "members":{ "ApplicationVersions":{ "shape":"ApplicationVersionDescriptionList", "documentation":"

List of ApplicationVersionDescription objects sorted in order of creation.

" }, "NextToken":{ "shape":"Token", "documentation":"

For a paginated request, the token that you can pass in a subsequent request to get the next page.

" } }, "documentation":"

Result message wrapping a list of application version descriptions.

" }, "ApplicationVersionLifecycleConfig":{ "type":"structure", "members":{ "MaxCountRule":{ "shape":"MaxCountRule", "documentation":"

Specify a max count rule to restrict the number of application versions that are retained for an application.

" }, "MaxAgeRule":{ "shape":"MaxAgeRule", "documentation":"

Specify a max age rule to restrict the length of time that application versions are retained for an application.

" } }, "documentation":"

The application version lifecycle settings for an application. Defines the rules that Elastic Beanstalk applies to an application's versions in order to avoid hitting the per-region limit for application versions.

When Elastic Beanstalk deletes an application version from its database, you can no longer deploy that version to an environment. The source bundle remains in S3 unless you configure the rule to delete it.

" }, "ApplicationVersionProccess":{"type":"boolean"}, "ApplicationVersionStatus":{ "type":"string", "enum":[ "Processed", "Unprocessed", "Failed", "Processing", "Building" ] }, "ApplyEnvironmentManagedActionRequest":{ "type":"structure", "required":["ActionId"], "members":{ "EnvironmentName":{ "shape":"String", "documentation":"

The name of the target environment.

" }, "EnvironmentId":{ "shape":"String", "documentation":"

The environment ID of the target environment.

" }, "ActionId":{ "shape":"String", "documentation":"

The action ID of the scheduled managed action to execute.

" } }, "documentation":"

Request to execute a scheduled managed action immediately.

" }, "ApplyEnvironmentManagedActionResult":{ "type":"structure", "members":{ "ActionId":{ "shape":"String", "documentation":"

The action ID of the managed action.

" }, "ActionDescription":{ "shape":"String", "documentation":"

A description of the managed action.

" }, "ActionType":{ "shape":"ActionType", "documentation":"

The type of managed action.

" }, "Status":{ "shape":"String", "documentation":"

The status of the managed action.

" } }, "documentation":"

The result message containing information about the managed action.

" }, "AutoCreateApplication":{"type":"boolean"}, "AutoScalingGroup":{ "type":"structure", "members":{ "Name":{ "shape":"ResourceId", "documentation":"

The name of the AutoScalingGroup .

" } }, "documentation":"

Describes an Auto Scaling launch configuration.

" }, "AutoScalingGroupList":{ "type":"list", "member":{"shape":"AutoScalingGroup"} }, "AvailableSolutionStackDetailsList":{ "type":"list", "member":{"shape":"SolutionStackDescription"} }, "AvailableSolutionStackNamesList":{ "type":"list", "member":{"shape":"SolutionStackName"} }, "BoxedBoolean":{"type":"boolean"}, "BoxedInt":{"type":"integer"}, "BuildConfiguration":{ "type":"structure", "required":[ "CodeBuildServiceRole", "Image" ], "members":{ "ArtifactName":{ "shape":"String", "documentation":"

The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact-name.zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip.

" }, "CodeBuildServiceRole":{ "shape":"NonEmptyString", "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

" }, "ComputeType":{ "shape":"ComputeType", "documentation":"

Information about the compute resources the build project will use.

  • BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds

  • BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds

  • BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds

" }, "Image":{ "shape":"NonEmptyString", "documentation":"

The ID of the Docker image to use for this build project.

" }, "TimeoutInMinutes":{ "shape":"BoxedInt", "documentation":"

How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.

" } }, "documentation":"

Settings for an AWS CodeBuild build.

" }, "CPUUtilization":{ "type":"structure", "members":{ "User":{ "shape":"NullableDouble", "documentation":"

Percentage of time that the CPU has spent in the User state over the last 10 seconds.

" }, "Nice":{ "shape":"NullableDouble", "documentation":"

Percentage of time that the CPU has spent in the Nice state over the last 10 seconds.

" }, "System":{ "shape":"NullableDouble", "documentation":"

Percentage of time that the CPU has spent in the System state over the last 10 seconds.

" }, "Idle":{ "shape":"NullableDouble", "documentation":"

Percentage of time that the CPU has spent in the Idle state over the last 10 seconds.

" }, "IOWait":{ "shape":"NullableDouble", "documentation":"

Percentage of time that the CPU has spent in the I/O Wait state over the last 10 seconds.

" }, "IRQ":{ "shape":"NullableDouble", "documentation":"

Percentage of time that the CPU has spent in the IRQ state over the last 10 seconds.

" }, "SoftIRQ":{ "shape":"NullableDouble", "documentation":"

Percentage of time that the CPU has spent in the SoftIRQ state over the last 10 seconds.

" } }, "documentation":"

CPU utilization metrics for an instance.

" }, "Cause":{ "type":"string", "max":255, "min":1 }, "Causes":{ "type":"list", "member":{"shape":"Cause"} }, "CheckDNSAvailabilityMessage":{ "type":"structure", "required":["CNAMEPrefix"], "members":{ "CNAMEPrefix":{ "shape":"DNSCnamePrefix", "documentation":"

The prefix used when this CNAME is reserved.

" } }, "documentation":"

Results message indicating whether a CNAME is available.

" }, "CheckDNSAvailabilityResultMessage":{ "type":"structure", "members":{ "Available":{ "shape":"CnameAvailability", "documentation":"

Indicates if the specified CNAME is available:

  • true : The CNAME is available.

  • false : The CNAME is not available.

" }, "FullyQualifiedCNAME":{ "shape":"DNSCname", "documentation":"

The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.

" } }, "documentation":"

Indicates if the specified CNAME is available.

" }, "CnameAvailability":{"type":"boolean"}, "CodeBuildNotInServiceRegionException":{ "type":"structure", "members":{ }, "documentation":"

AWS CodeBuild is not available in the specified region.

", "error":{ "code":"CodeBuildNotInServiceRegionException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ComposeEnvironmentsMessage":{ "type":"structure", "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application to which the specified source bundles belong.

" }, "GroupName":{ "shape":"GroupName", "documentation":"

The name of the group to which the target environments belong. Specify a group name only if the environment name defined in each target environment's manifest ends with a + (plus) character. See Environment Manifest (env.yaml) for details.

" }, "VersionLabels":{ "shape":"VersionLabels", "documentation":"

A list of version labels, specifying one or more application source bundles that belong to the target application. Each source bundle must include an environment manifest that specifies the name of the environment and the name of the solution stack to use, and optionally can specify environment links to create.

" } }, "documentation":"

Request to create or update a group of environments.

" }, "ComputeType":{ "type":"string", "enum":[ "BUILD_GENERAL1_SMALL", "BUILD_GENERAL1_MEDIUM", "BUILD_GENERAL1_LARGE" ] }, "ConfigurationDeploymentStatus":{ "type":"string", "enum":[ "deployed", "pending", "failed" ] }, "ConfigurationOptionDefaultValue":{"type":"string"}, "ConfigurationOptionDescription":{ "type":"structure", "members":{ "Namespace":{ "shape":"OptionNamespace", "documentation":"

A unique namespace identifying the option's associated AWS resource.

" }, "Name":{ "shape":"ConfigurationOptionName", "documentation":"

The name of the configuration option.

" }, "DefaultValue":{ "shape":"ConfigurationOptionDefaultValue", "documentation":"

The default value for this configuration option.

" }, "ChangeSeverity":{ "shape":"ConfigurationOptionSeverity", "documentation":"

An indication of which action is required if the value for this configuration option changes:

  • NoInterruption : There is no interruption to the environment or application availability.

  • RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.

  • RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.

" }, "UserDefined":{ "shape":"UserDefinedOption", "documentation":"

An indication of whether the user defined this configuration option:

  • true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.

  • false : This configuration was not defined by the user.

Constraint: You can remove only UserDefined options from a configuration.

Valid Values: true | false

" }, "ValueType":{ "shape":"ConfigurationOptionValueType", "documentation":"

An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

  • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.

  • List : Values for this option are multiple selections from the possible values.

  • Boolean : Values for this option are either true or false .

  • Json : Values for this option are a JSON representation of a ConfigDocument.

" }, "ValueOptions":{ "shape":"ConfigurationOptionPossibleValues", "documentation":"

If specified, values for the configuration option are selected from this list.

" }, "MinValue":{ "shape":"OptionRestrictionMinValue", "documentation":"

If specified, the configuration option must be a numeric value greater than this value.

" }, "MaxValue":{ "shape":"OptionRestrictionMaxValue", "documentation":"

If specified, the configuration option must be a numeric value less than this value.

" }, "MaxLength":{ "shape":"OptionRestrictionMaxLength", "documentation":"

If specified, the configuration option must be a string value no longer than this value.

" }, "Regex":{ "shape":"OptionRestrictionRegex", "documentation":"

If specified, the configuration option must be a string value that satisfies this regular expression.

" } }, "documentation":"

Describes the possible values for a configuration option.

" }, "ConfigurationOptionDescriptionsList":{ "type":"list", "member":{"shape":"ConfigurationOptionDescription"} }, "ConfigurationOptionName":{"type":"string"}, "ConfigurationOptionPossibleValue":{"type":"string"}, "ConfigurationOptionPossibleValues":{ "type":"list", "member":{"shape":"ConfigurationOptionPossibleValue"} }, "ConfigurationOptionSetting":{ "type":"structure", "members":{ "ResourceName":{ "shape":"ResourceName", "documentation":"

A unique resource name for a time-based scaling configuration option.

" }, "Namespace":{ "shape":"OptionNamespace", "documentation":"

A unique namespace identifying the option's associated AWS resource.

" }, "OptionName":{ "shape":"ConfigurationOptionName", "documentation":"

The name of the configuration option.

" }, "Value":{ "shape":"ConfigurationOptionValue", "documentation":"

The current value for the configuration option.

" } }, "documentation":"

A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide.

" }, "ConfigurationOptionSettingsList":{ "type":"list", "member":{"shape":"ConfigurationOptionSetting"} }, "ConfigurationOptionSeverity":{"type":"string"}, "ConfigurationOptionValue":{"type":"string"}, "ConfigurationOptionValueType":{ "type":"string", "enum":[ "Scalar", "List" ] }, "ConfigurationOptionsDescription":{ "type":"structure", "members":{ "SolutionStackName":{ "shape":"SolutionStackName", "documentation":"

The name of the solution stack these configuration options belong to.

" }, "Options":{ "shape":"ConfigurationOptionDescriptionsList", "documentation":"

A list of ConfigurationOptionDescription.

" } }, "documentation":"

Describes the settings for a specified configuration set.

" }, "ConfigurationSettingsDescription":{ "type":"structure", "members":{ "SolutionStackName":{ "shape":"SolutionStackName", "documentation":"

The name of the solution stack this configuration set uses.

" }, "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application associated with this configuration set.

" }, "TemplateName":{ "shape":"ConfigurationTemplateName", "documentation":"

If not null, the name of the configuration template for this configuration set.

" }, "Description":{ "shape":"Description", "documentation":"

Describes this configuration set.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

If not null, the name of the environment for this configuration set.

" }, "DeploymentStatus":{ "shape":"ConfigurationDeploymentStatus", "documentation":"

If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

  • null: This configuration is not associated with a running environment.

  • pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.

  • deployed: This is the configuration that is currently deployed to the associated running environment.

  • failed: This is a draft configuration that failed to successfully deploy.

" }, "DateCreated":{ "shape":"CreationDate", "documentation":"

The date (in UTC time) when this configuration set was created.

" }, "DateUpdated":{ "shape":"UpdateDate", "documentation":"

The date (in UTC time) when this configuration set was last modified.

" }, "OptionSettings":{ "shape":"ConfigurationOptionSettingsList", "documentation":"

A list of the configuration options and their values in this configuration set.

" } }, "documentation":"

Describes the settings for a configuration set.

" }, "ConfigurationSettingsDescriptionList":{ "type":"list", "member":{"shape":"ConfigurationSettingsDescription"} }, "ConfigurationSettingsDescriptions":{ "type":"structure", "members":{ "ConfigurationSettings":{ "shape":"ConfigurationSettingsDescriptionList", "documentation":"

A list of ConfigurationSettingsDescription.

" } }, "documentation":"

The results from a request to change the configuration settings of an environment.

" }, "ConfigurationSettingsValidationMessages":{ "type":"structure", "members":{ "Messages":{ "shape":"ValidationMessagesList", "documentation":"

A list of ValidationMessage.

" } }, "documentation":"

Provides a list of validation messages.

" }, "ConfigurationTemplateName":{ "type":"string", "max":100, "min":1 }, "ConfigurationTemplateNamesList":{ "type":"list", "member":{"shape":"ConfigurationTemplateName"} }, "CreateApplicationMessage":{ "type":"structure", "required":["ApplicationName"], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application.

Constraint: This name must be unique within your account. If the specified name already exists, the action returns an InvalidParameterValue error.

" }, "Description":{ "shape":"Description", "documentation":"

Describes the application.

" }, "ResourceLifecycleConfig":{ "shape":"ApplicationResourceLifecycleConfig", "documentation":"

Specify an application resource lifecycle configuration to prevent your application from accumulating too many versions.

" } }, "documentation":"

Request to create an application.

" }, "CreateApplicationVersionMessage":{ "type":"structure", "required":[ "ApplicationName", "VersionLabel" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error.

" }, "VersionLabel":{ "shape":"VersionLabel", "documentation":"

A label identifying this version.

Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an InvalidParameterValue error.

" }, "Description":{ "shape":"Description", "documentation":"

Describes this version.

" }, "SourceBuildInformation":{ "shape":"SourceBuildInformation", "documentation":"

Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version.

" }, "SourceBundle":{ "shape":"S3Location", "documentation":"

The Amazon S3 bucket and key that identify the location of the source bundle for this version.

The Amazon S3 bucket must be in the same region as the environment.

Specify a source bundle in S3 or a commit in an AWS CodeCommit repository (with SourceBuildInformation), but not both. If neither SourceBundle nor SourceBuildInformation are provided, Elastic Beanstalk uses a sample application.

" }, "BuildConfiguration":{ "shape":"BuildConfiguration", "documentation":"

Settings for an AWS CodeBuild build.

" }, "AutoCreateApplication":{ "shape":"AutoCreateApplication", "documentation":"

Set to true to create an application with the specified name if it doesn't already exist.

" }, "Process":{ "shape":"ApplicationVersionProccess", "documentation":"

Preprocesses and validates the environment manifest and configuration files in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.

" } }, "documentation":"

" }, "CreateConfigurationTemplateMessage":{ "type":"structure", "required":[ "ApplicationName", "TemplateName" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

" }, "TemplateName":{ "shape":"ConfigurationTemplateName", "documentation":"

The name of the configuration template.

Constraint: This name must be unique per application.

Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

" }, "SolutionStackName":{ "shape":"SolutionStackName", "documentation":"

The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.

Use ListAvailableSolutionStacks to obtain a list of available solution stacks.

A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error.

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.

" }, "SourceConfiguration":{ "shape":"SourceConfiguration", "documentation":"

If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration.

If no configuration template is found, returns an InvalidParameterValue error.

Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error.

" }, "EnvironmentId":{ "shape":"EnvironmentId", "documentation":"

The ID of the environment used with this configuration template.

" }, "Description":{ "shape":"Description", "documentation":"

Describes this configuration.

" }, "OptionSettings":{ "shape":"ConfigurationOptionSettingsList", "documentation":"

If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.

" } }, "documentation":"

Request to create a configuration template.

" }, "CreateEnvironmentMessage":{ "type":"structure", "required":["ApplicationName"], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application that contains the version to be deployed.

If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

A unique name for the deployment environment. Used in the application URL.

Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique in your account. If the specified name already exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.

" }, "GroupName":{ "shape":"GroupName", "documentation":"

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.

" }, "Description":{ "shape":"Description", "documentation":"

Describes this environment.

" }, "CNAMEPrefix":{ "shape":"DNSCnamePrefix", "documentation":"

If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

" }, "Tier":{ "shape":"EnvironmentTier", "documentation":"

This specifies the tier to use for creating this environment.

" }, "Tags":{ "shape":"Tags", "documentation":"

This specifies the tags applied to resources in the environment.

" }, "VersionLabel":{ "shape":"VersionLabel", "documentation":"

The name of the application version to deploy.

If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

" }, "TemplateName":{ "shape":"ConfigurationTemplateName", "documentation":"

The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Condition: You must specify either this parameter or a SolutionStackName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

" }, "SolutionStackName":{ "shape":"SolutionStackName", "documentation":"

This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

" }, "OptionSettings":{ "shape":"ConfigurationOptionSettingsList", "documentation":"

If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

" }, "OptionsToRemove":{ "shape":"OptionsSpecifierList", "documentation":"

A list of custom user-defined configuration options to remove from the configuration set for this new environment.

" } }, "documentation":"

" }, "CreateStorageLocationResultMessage":{ "type":"structure", "members":{ "S3Bucket":{ "shape":"S3Bucket", "documentation":"

The name of the Amazon S3 bucket created.

" } }, "documentation":"

Results of a CreateStorageLocationResult call.

" }, "CreationDate":{"type":"timestamp"}, "DNSCname":{ "type":"string", "max":255, "min":1 }, "DNSCnamePrefix":{ "type":"string", "max":63, "min":4 }, "DeleteApplicationMessage":{ "type":"structure", "required":["ApplicationName"], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application to delete.

" }, "TerminateEnvByForce":{ "shape":"TerminateEnvForce", "documentation":"

When set to true, running environments will be terminated before deleting the application.

" } }, "documentation":"

Request to delete an application.

" }, "DeleteApplicationVersionMessage":{ "type":"structure", "required":[ "ApplicationName", "VersionLabel" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application to which the version belongs.

" }, "VersionLabel":{ "shape":"VersionLabel", "documentation":"

The label of the version to delete.

" }, "DeleteSourceBundle":{ "shape":"DeleteSourceBundle", "documentation":"

Set to true to delete the source bundle from your storage bucket. Otherwise, the application version is deleted only from Elastic Beanstalk and the source bundle remains in Amazon S3.

" } }, "documentation":"

Request to delete an application version.

" }, "DeleteConfigurationTemplateMessage":{ "type":"structure", "required":[ "ApplicationName", "TemplateName" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application to delete the configuration template from.

" }, "TemplateName":{ "shape":"ConfigurationTemplateName", "documentation":"

The name of the configuration template to delete.

" } }, "documentation":"

Request to delete a configuration template.

" }, "DeleteEnvironmentConfigurationMessage":{ "type":"structure", "required":[ "ApplicationName", "EnvironmentName" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application the environment is associated with.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of the environment to delete the draft configuration from.

" } }, "documentation":"

Request to delete a draft environment configuration.

" }, "DeleteSourceBundle":{"type":"boolean"}, "Deployment":{ "type":"structure", "members":{ "VersionLabel":{ "shape":"String", "documentation":"

The version label of the application version in the deployment.

" }, "DeploymentId":{ "shape":"NullableLong", "documentation":"

The ID of the deployment. This number increases by one each time that you deploy source code or change instance configuration settings.

" }, "Status":{ "shape":"String", "documentation":"

The status of the deployment:

  • In Progress : The deployment is in progress.

  • Deployed : The deployment succeeded.

  • Failed : The deployment failed.

" }, "DeploymentTime":{ "shape":"DeploymentTimestamp", "documentation":"

For in-progress deployments, the time that the deloyment started.

For completed deployments, the time that the deployment ended.

" } }, "documentation":"

Information about an application version deployment.

" }, "DeploymentTimestamp":{"type":"timestamp"}, "DescribeApplicationVersionsMessage":{ "type":"structure", "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

Specify an application name to show only application versions for that application.

" }, "VersionLabels":{ "shape":"VersionLabelsList", "documentation":"

Specify a version label to show a specific application version.

" }, "MaxRecords":{ "shape":"MaxRecords", "documentation":"

Specify a maximum number of application versions to paginate in the request.

" }, "NextToken":{ "shape":"Token", "documentation":"

Specify a next token to retrieve the next page in a paginated request.

" } }, "documentation":"

Request to describe application versions.

" }, "DescribeApplicationsMessage":{ "type":"structure", "members":{ "ApplicationNames":{ "shape":"ApplicationNamesList", "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.

" } }, "documentation":"

Request to describe one or more applications.

" }, "DescribeConfigurationOptionsMessage":{ "type":"structure", "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

" }, "TemplateName":{ "shape":"ConfigurationTemplateName", "documentation":"

The name of the configuration template whose configuration options you want to describe.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of the environment whose configuration options you want to describe.

" }, "SolutionStackName":{ "shape":"SolutionStackName", "documentation":"

The name of the solution stack whose configuration options you want to describe.

" }, "Options":{ "shape":"OptionsSpecifierList", "documentation":"

If specified, restricts the descriptions to only the specified options.

" } }, "documentation":"

Result message containig a list of application version descriptions.

" }, "DescribeConfigurationSettingsMessage":{ "type":"structure", "required":["ApplicationName"], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The application for the environment or configuration template.

" }, "TemplateName":{ "shape":"ConfigurationTemplateName", "documentation":"

The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" } }, "documentation":"

Result message containing all of the configuration settings for a specified solution stack or configuration template.

" }, "DescribeEnvironmentHealthRequest":{ "type":"structure", "members":{ "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

Specify the environment by name.

You must specify either this or an EnvironmentName, or both.

" }, "EnvironmentId":{ "shape":"EnvironmentId", "documentation":"

Specify the environment by ID.

You must specify either this or an EnvironmentName, or both.

" }, "AttributeNames":{ "shape":"EnvironmentHealthAttributes", "documentation":"

Specify the response elements to return. To retrieve all attributes, set to All. If no attribute names are specified, returns the name of the environment.

" } }, "documentation":"

See the example below to learn how to create a request body.

" }, "DescribeEnvironmentHealthResult":{ "type":"structure", "members":{ "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The environment's name.

" }, "HealthStatus":{ "shape":"String", "documentation":"

The health status of the environment. For example, Ok.

" }, "Status":{ "shape":"EnvironmentHealth", "documentation":"

The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.

" }, "Color":{ "shape":"String", "documentation":"

The health color of the environment.

" }, "Causes":{ "shape":"Causes", "documentation":"

Descriptions of the data that contributed to the environment's current health status.

" }, "ApplicationMetrics":{ "shape":"ApplicationMetrics", "documentation":"

Application request metrics for the environment.

" }, "InstancesHealth":{ "shape":"InstanceHealthSummary", "documentation":"

Summary health information for the instances in the environment.

" }, "RefreshedAt":{ "shape":"RefreshedAt", "documentation":"

The date and time that the health information was retrieved.

" } }, "documentation":"

Health details for an AWS Elastic Beanstalk environment.

" }, "DescribeEnvironmentManagedActionHistoryRequest":{ "type":"structure", "members":{ "EnvironmentId":{ "shape":"EnvironmentId", "documentation":"

The environment ID of the target environment.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of the target environment.

" }, "NextToken":{ "shape":"String", "documentation":"

The pagination token returned by a previous request.

" }, "MaxItems":{ "shape":"Integer", "documentation":"

The maximum number of items to return for a single request.

" } }, "documentation":"

Request to list completed and failed managed actions.

" }, "DescribeEnvironmentManagedActionHistoryResult":{ "type":"structure", "members":{ "ManagedActionHistoryItems":{ "shape":"ManagedActionHistoryItems", "documentation":"

A list of completed and failed managed actions.

" }, "NextToken":{ "shape":"String", "documentation":"

A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results.

" } }, "documentation":"

A result message containing a list of completed and failed managed actions.

" }, "DescribeEnvironmentManagedActionsRequest":{ "type":"structure", "members":{ "EnvironmentName":{ "shape":"String", "documentation":"

The name of the target environment.

" }, "EnvironmentId":{ "shape":"String", "documentation":"

The environment ID of the target environment.

" }, "Status":{ "shape":"ActionStatus", "documentation":"

To show only actions with a particular status, specify a status.

" } }, "documentation":"

Request to list an environment's upcoming and in-progress managed actions.

" }, "DescribeEnvironmentManagedActionsResult":{ "type":"structure", "members":{ "ManagedActions":{ "shape":"ManagedActions", "documentation":"

A list of upcoming and in-progress managed actions.

" } }, "documentation":"

The result message containing a list of managed actions.

" }, "DescribeEnvironmentResourcesMessage":{ "type":"structure", "members":{ "EnvironmentId":{ "shape":"EnvironmentId", "documentation":"

The ID of the environment to retrieve AWS resource usage data.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of the environment to retrieve AWS resource usage data.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" } }, "documentation":"

Request to describe the resources in an environment.

" }, "DescribeEnvironmentsMessage":{ "type":"structure", "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

" }, "VersionLabel":{ "shape":"VersionLabel", "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

" }, "EnvironmentIds":{ "shape":"EnvironmentIdList", "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

" }, "EnvironmentNames":{ "shape":"EnvironmentNamesList", "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

" }, "IncludeDeleted":{ "shape":"IncludeDeleted", "documentation":"

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

" }, "IncludedDeletedBackTo":{ "shape":"IncludeDeletedBackTo", "documentation":"

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

" } }, "documentation":"

Request to describe one or more environments.

" }, "DescribeEventsMessage":{ "type":"structure", "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

" }, "VersionLabel":{ "shape":"VersionLabel", "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

" }, "TemplateName":{ "shape":"ConfigurationTemplateName", "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

" }, "EnvironmentId":{ "shape":"EnvironmentId", "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

" }, "RequestId":{ "shape":"RequestId", "documentation":"

If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

" }, "Severity":{ "shape":"EventSeverity", "documentation":"

If specified, limits the events returned from this call to include only those with the specified severity or higher.

" }, "StartTime":{ "shape":"TimeFilterStart", "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

" }, "EndTime":{ "shape":"TimeFilterEnd", "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

" }, "MaxRecords":{ "shape":"MaxRecords", "documentation":"

Specifies the maximum number of events that can be returned, beginning with the most recent event.

" }, "NextToken":{ "shape":"Token", "documentation":"

Pagination token. If specified, the events return the next batch of results.

" } }, "documentation":"

Request to retrieve a list of events for an environment.

" }, "DescribeInstancesHealthRequest":{ "type":"structure", "members":{ "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

Specify the AWS Elastic Beanstalk environment by name.

" }, "EnvironmentId":{ "shape":"EnvironmentId", "documentation":"

Specify the AWS Elastic Beanstalk environment by ID.

" }, "AttributeNames":{ "shape":"InstancesHealthAttributes", "documentation":"

Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no attribute names are specified, returns a list of instances.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Specify the pagination token returned by a previous call.

" } }, "documentation":"

Parameters for a call to DescribeInstancesHealth.

" }, "DescribeInstancesHealthResult":{ "type":"structure", "members":{ "InstanceHealthList":{ "shape":"InstanceHealthList", "documentation":"

Detailed health information about each instance.

" }, "RefreshedAt":{ "shape":"RefreshedAt", "documentation":"

The date and time that the health information was retrieved.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Pagination token for the next page of results, if available.

" } }, "documentation":"

Detailed health information about the Amazon EC2 instances in an AWS Elastic Beanstalk environment.

" }, "Description":{ "type":"string", "max":200 }, "Ec2InstanceId":{"type":"string"}, "ElasticBeanstalkServiceException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The exception error message.

" } }, "documentation":"

A generic service exception has occurred.

", "exception":true }, "EndpointURL":{"type":"string"}, "EnvironmentDescription":{ "type":"structure", "members":{ "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of this environment.

" }, "EnvironmentId":{ "shape":"EnvironmentId", "documentation":"

The ID of this environment.

" }, "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application associated with this environment.

" }, "VersionLabel":{ "shape":"VersionLabel", "documentation":"

The application version deployed in this environment.

" }, "SolutionStackName":{ "shape":"SolutionStackName", "documentation":"

The name of the SolutionStack deployed with this environment.

" }, "TemplateName":{ "shape":"ConfigurationTemplateName", "documentation":"

The name of the configuration template used to originally launch this environment.

" }, "Description":{ "shape":"Description", "documentation":"

Describes this environment.

" }, "EndpointURL":{ "shape":"EndpointURL", "documentation":"

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

" }, "CNAME":{ "shape":"DNSCname", "documentation":"

The URL to the CNAME for this environment.

" }, "DateCreated":{ "shape":"CreationDate", "documentation":"

The creation date for this environment.

" }, "DateUpdated":{ "shape":"UpdateDate", "documentation":"

The last modified date for this environment.

" }, "Status":{ "shape":"EnvironmentStatus", "documentation":"

The current operational status of the environment:

  • Launching: Environment is in the process of initial deployment.

  • Updating: Environment is in the process of updating its configuration settings or application version.

  • Ready: Environment is available to have an action performed on it, such as update or terminate.

  • Terminating: Environment is in the shut-down process.

  • Terminated: Environment is not running.

" }, "AbortableOperationInProgress":{ "shape":"AbortableOperationInProgress", "documentation":"

Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

true: There is an update in progress.

false: There are no updates currently in progress.

" }, "Health":{ "shape":"EnvironmentHealth", "documentation":"

Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

  • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.

  • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.

  • Green: Indicates the environment is healthy and fully functional.

  • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironement request.

Default: Grey

" }, "HealthStatus":{ "shape":"EnvironmentHealthStatus", "documentation":"

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

" }, "Resources":{ "shape":"EnvironmentResourcesDescription", "documentation":"

The description of the AWS resources used by this environment.

" }, "Tier":{ "shape":"EnvironmentTier", "documentation":"

Describes the current tier of this environment.

" }, "EnvironmentLinks":{ "shape":"EnvironmentLinks", "documentation":"

A list of links to other environments in the same group.

" } }, "documentation":"

Describes the properties of an environment.

" }, "EnvironmentDescriptionsList":{ "type":"list", "member":{"shape":"EnvironmentDescription"} }, "EnvironmentDescriptionsMessage":{ "type":"structure", "members":{ "Environments":{ "shape":"EnvironmentDescriptionsList", "documentation":"

Returns an EnvironmentDescription list.

" } }, "documentation":"

Result message containing a list of environment descriptions.

" }, "EnvironmentHealth":{ "type":"string", "enum":[ "Green", "Yellow", "Red", "Grey" ] }, "EnvironmentHealthAttribute":{ "type":"string", "enum":[ "Status", "Color", "Causes", "ApplicationMetrics", "InstancesHealth", "All", "HealthStatus", "RefreshedAt" ] }, "EnvironmentHealthAttributes":{ "type":"list", "member":{"shape":"EnvironmentHealthAttribute"} }, "EnvironmentHealthStatus":{ "type":"string", "enum":[ "NoData", "Unknown", "Pending", "Ok", "Info", "Warning", "Degraded", "Severe" ] }, "EnvironmentId":{"type":"string"}, "EnvironmentIdList":{ "type":"list", "member":{"shape":"EnvironmentId"} }, "EnvironmentInfoDescription":{ "type":"structure", "members":{ "InfoType":{ "shape":"EnvironmentInfoType", "documentation":"

The type of information retrieved.

" }, "Ec2InstanceId":{ "shape":"Ec2InstanceId", "documentation":"

The Amazon EC2 Instance ID for this information.

" }, "SampleTimestamp":{ "shape":"SampleTimestamp", "documentation":"

The time stamp when this information was retrieved.

" }, "Message":{ "shape":"Message", "documentation":"

The retrieved information.

" } }, "documentation":"

The information retrieved from the Amazon EC2 instances.

" }, "EnvironmentInfoDescriptionList":{ "type":"list", "member":{"shape":"EnvironmentInfoDescription"} }, "EnvironmentInfoType":{ "type":"string", "enum":[ "tail", "bundle" ] }, "EnvironmentLink":{ "type":"structure", "members":{ "LinkName":{ "shape":"String", "documentation":"

The name of the link.

" }, "EnvironmentName":{ "shape":"String", "documentation":"

The name of the linked environment (the dependency).

" } }, "documentation":"

A link to another environment, defined in the environment's manifest. Links provide connection information in system properties that can be used to connect to another environment in the same group. See Environment Manifest (env.yaml) for details.

" }, "EnvironmentLinks":{ "type":"list", "member":{"shape":"EnvironmentLink"} }, "EnvironmentName":{ "type":"string", "max":40, "min":4 }, "EnvironmentNamesList":{ "type":"list", "member":{"shape":"EnvironmentName"} }, "EnvironmentResourceDescription":{ "type":"structure", "members":{ "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of the environment.

" }, "AutoScalingGroups":{ "shape":"AutoScalingGroupList", "documentation":"

The AutoScalingGroups used by this environment.

" }, "Instances":{ "shape":"InstanceList", "documentation":"

The Amazon EC2 instances used by this environment.

" }, "LaunchConfigurations":{ "shape":"LaunchConfigurationList", "documentation":"

The Auto Scaling launch configurations in use by this environment.

" }, "LoadBalancers":{ "shape":"LoadBalancerList", "documentation":"

The LoadBalancers in use by this environment.

" }, "Triggers":{ "shape":"TriggerList", "documentation":"

The AutoScaling triggers in use by this environment.

" }, "Queues":{ "shape":"QueueList", "documentation":"

The queues used by this environment.

" } }, "documentation":"

Describes the AWS resources in use by this environment. This data is live.

" }, "EnvironmentResourceDescriptionsMessage":{ "type":"structure", "members":{ "EnvironmentResources":{ "shape":"EnvironmentResourceDescription", "documentation":"

A list of EnvironmentResourceDescription.

" } }, "documentation":"

Result message containing a list of environment resource descriptions.

" }, "EnvironmentResourcesDescription":{ "type":"structure", "members":{ "LoadBalancer":{ "shape":"LoadBalancerDescription", "documentation":"

Describes the LoadBalancer.

" } }, "documentation":"

Describes the AWS resources in use by this environment. This data is not live data.

" }, "EnvironmentStatus":{ "type":"string", "enum":[ "Launching", "Updating", "Ready", "Terminating", "Terminated" ] }, "EnvironmentTier":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of this environment tier.

" }, "Type":{ "shape":"String", "documentation":"

The type of this environment tier.

" }, "Version":{ "shape":"String", "documentation":"

The version of this environment tier.

" } }, "documentation":"

Describes the properties of an environment tier

" }, "EventDate":{"type":"timestamp"}, "EventDescription":{ "type":"structure", "members":{ "EventDate":{ "shape":"EventDate", "documentation":"

The date when the event occurred.

" }, "Message":{ "shape":"EventMessage", "documentation":"

The event message.

" }, "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The application associated with the event.

" }, "VersionLabel":{ "shape":"VersionLabel", "documentation":"

The release label for the application version associated with this event.

" }, "TemplateName":{ "shape":"ConfigurationTemplateName", "documentation":"

The name of the configuration associated with this event.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of the environment associated with this event.

" }, "RequestId":{ "shape":"RequestId", "documentation":"

The web service request ID for the activity of this event.

" }, "Severity":{ "shape":"EventSeverity", "documentation":"

The severity level of this event.

" } }, "documentation":"

Describes an event.

" }, "EventDescriptionList":{ "type":"list", "member":{"shape":"EventDescription"} }, "EventDescriptionsMessage":{ "type":"structure", "members":{ "Events":{ "shape":"EventDescriptionList", "documentation":"

A list of EventDescription.

" }, "NextToken":{ "shape":"Token", "documentation":"

If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents call to get the next batch of events.

" } }, "documentation":"

Result message wrapping a list of event descriptions.

" }, "EventMessage":{"type":"string"}, "EventSeverity":{ "type":"string", "enum":[ "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "FATAL" ] }, "ExceptionMessage":{"type":"string"}, "FailureType":{ "type":"string", "enum":[ "UpdateCancelled", "CancellationFailed", "RollbackFailed", "RollbackSuccessful", "InternalFailure", "InvalidEnvironmentState", "PermissionsError" ] }, "FileTypeExtension":{ "type":"string", "max":100, "min":1 }, "ForceTerminate":{"type":"boolean"}, "GroupName":{ "type":"string", "max":19, "min":1 }, "IncludeDeleted":{"type":"boolean"}, "IncludeDeletedBackTo":{"type":"timestamp"}, "Instance":{ "type":"structure", "members":{ "Id":{ "shape":"ResourceId", "documentation":"

The ID of the Amazon EC2 instance.

" } }, "documentation":"

The description of an Amazon EC2 instance.

" }, "InstanceHealthList":{ "type":"list", "member":{"shape":"SingleInstanceHealth"} }, "InstanceHealthSummary":{ "type":"structure", "members":{ "NoData":{ "shape":"NullableInteger", "documentation":"

Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance.

" }, "Unknown":{ "shape":"NullableInteger", "documentation":"

Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance.

" }, "Pending":{ "shape":"NullableInteger", "documentation":"

Grey. An operation is in progress on an instance within the command timeout.

" }, "Ok":{ "shape":"NullableInteger", "documentation":"

Green. An instance is passing health checks and the health agent is not reporting any problems.

" }, "Info":{ "shape":"NullableInteger", "documentation":"

Green. An operation is in progress on an instance.

" }, "Warning":{ "shape":"NullableInteger", "documentation":"

Yellow. The health agent is reporting a moderate number of request failures or other issues for an instance or environment.

" }, "Degraded":{ "shape":"NullableInteger", "documentation":"

Red. The health agent is reporting a high number of request failures or other issues for an instance or environment.

" }, "Severe":{ "shape":"NullableInteger", "documentation":"

Red. The health agent is reporting a very high number of request failures or other issues for an instance or environment.

" } }, "documentation":"

Represents summary information about the health of an instance. For more information, see Health Colors and Statuses.

" }, "InstanceId":{ "type":"string", "max":255, "min":1 }, "InstanceList":{ "type":"list", "member":{"shape":"Instance"} }, "InstancesHealthAttribute":{ "type":"string", "enum":[ "HealthStatus", "Color", "Causes", "ApplicationMetrics", "RefreshedAt", "LaunchedAt", "System", "Deployment", "AvailabilityZone", "InstanceType", "All" ] }, "InstancesHealthAttributes":{ "type":"list", "member":{"shape":"InstancesHealthAttribute"} }, "InsufficientPrivilegesException":{ "type":"structure", "members":{ }, "documentation":"

The specified account does not have sufficient privileges for one of more AWS services.

", "error":{ "code":"InsufficientPrivilegesException", "httpStatusCode":403, "senderFault":true }, "exception":true }, "Integer":{"type":"integer"}, "InvalidRequestException":{ "type":"structure", "members":{ }, "documentation":"

One or more input parameters is not valid. Please correct the input parameters and try the operation again.

", "error":{ "code":"InvalidRequestException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Latency":{ "type":"structure", "members":{ "P999":{ "shape":"NullableDouble", "documentation":"

The average latency for the slowest 0.1 percent of requests over the last 10 seconds.

" }, "P99":{ "shape":"NullableDouble", "documentation":"

The average latency for the slowest 1 percent of requests over the last 10 seconds.

" }, "P95":{ "shape":"NullableDouble", "documentation":"

The average latency for the slowest 5 percent of requests over the last 10 seconds.

" }, "P90":{ "shape":"NullableDouble", "documentation":"

The average latency for the slowest 10 percent of requests over the last 10 seconds.

" }, "P85":{ "shape":"NullableDouble", "documentation":"

The average latency for the slowest 15 percent of requests over the last 10 seconds.

" }, "P75":{ "shape":"NullableDouble", "documentation":"

The average latency for the slowest 25 percent of requests over the last 10 seconds.

" }, "P50":{ "shape":"NullableDouble", "documentation":"

The average latency for the slowest 50 percent of requests over the last 10 seconds.

" }, "P10":{ "shape":"NullableDouble", "documentation":"

The average latency for the slowest 90 percent of requests over the last 10 seconds.

" } }, "documentation":"

Represents the average latency for the slowest X percent of requests over the last 10 seconds.

" }, "LaunchConfiguration":{ "type":"structure", "members":{ "Name":{ "shape":"ResourceId", "documentation":"

The name of the launch configuration.

" } }, "documentation":"

Describes an Auto Scaling launch configuration.

" }, "LaunchConfigurationList":{ "type":"list", "member":{"shape":"LaunchConfiguration"} }, "LaunchedAt":{"type":"timestamp"}, "ListAvailableSolutionStacksResultMessage":{ "type":"structure", "members":{ "SolutionStacks":{ "shape":"AvailableSolutionStackNamesList", "documentation":"

A list of available solution stacks.

" }, "SolutionStackDetails":{ "shape":"AvailableSolutionStackDetailsList", "documentation":"

A list of available solution stacks and their SolutionStackDescription.

" } }, "documentation":"

A list of available AWS Elastic Beanstalk solution stacks.

" }, "Listener":{ "type":"structure", "members":{ "Protocol":{ "shape":"String", "documentation":"

The protocol that is used by the Listener.

" }, "Port":{ "shape":"Integer", "documentation":"

The port that is used by the Listener.

" } }, "documentation":"

Describes the properties of a Listener for the LoadBalancer.

" }, "LoadAverage":{ "type":"list", "member":{"shape":"LoadAverageValue"} }, "LoadAverageValue":{"type":"double"}, "LoadBalancer":{ "type":"structure", "members":{ "Name":{ "shape":"ResourceId", "documentation":"

The name of the LoadBalancer.

" } }, "documentation":"

Describes a LoadBalancer.

" }, "LoadBalancerDescription":{ "type":"structure", "members":{ "LoadBalancerName":{ "shape":"String", "documentation":"

The name of the LoadBalancer.

" }, "Domain":{ "shape":"String", "documentation":"

The domain name of the LoadBalancer.

" }, "Listeners":{ "shape":"LoadBalancerListenersDescription", "documentation":"

A list of Listeners used by the LoadBalancer.

" } }, "documentation":"

Describes the details of a LoadBalancer.

" }, "LoadBalancerList":{ "type":"list", "member":{"shape":"LoadBalancer"} }, "LoadBalancerListenersDescription":{ "type":"list", "member":{"shape":"Listener"} }, "ManagedAction":{ "type":"structure", "members":{ "ActionId":{ "shape":"String", "documentation":"

A unique identifier for the managed action.

" }, "ActionDescription":{ "shape":"String", "documentation":"

A description of the managed action.

" }, "ActionType":{ "shape":"ActionType", "documentation":"

The type of managed action.

" }, "Status":{ "shape":"ActionStatus", "documentation":"

The status of the managed action. If the action is Scheduled, you can apply it immediately with ApplyEnvironmentManagedAction.

" }, "WindowStartTime":{ "shape":"Timestamp", "documentation":"

The start time of the maintenance window in which the managed action will execute.

" } }, "documentation":"

The record of an upcoming or in-progress managed action.

" }, "ManagedActionHistoryItem":{ "type":"structure", "members":{ "ActionId":{ "shape":"String", "documentation":"

A unique identifier for the managed action.

" }, "ActionType":{ "shape":"ActionType", "documentation":"

The type of the managed action.

" }, "ActionDescription":{ "shape":"String", "documentation":"

A description of the managed action.

" }, "FailureType":{ "shape":"FailureType", "documentation":"

If the action failed, the type of failure.

" }, "Status":{ "shape":"ActionHistoryStatus", "documentation":"

The status of the action.

" }, "FailureDescription":{ "shape":"String", "documentation":"

If the action failed, a description of the failure.

" }, "ExecutedTime":{ "shape":"Timestamp", "documentation":"

The date and time that the action started executing.

" }, "FinishedTime":{ "shape":"Timestamp", "documentation":"

The date and time that the action finished executing.

" } }, "documentation":"

The record of a completed or failed managed action.

" }, "ManagedActionHistoryItems":{ "type":"list", "member":{"shape":"ManagedActionHistoryItem"}, "max":100, "min":1 }, "ManagedActionInvalidStateException":{ "type":"structure", "members":{ }, "documentation":"

Cannot modify the managed action in its current state.

", "error":{ "code":"ManagedActionInvalidStateException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ManagedActions":{ "type":"list", "member":{"shape":"ManagedAction"}, "max":100, "min":1 }, "MaxAgeRule":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"BoxedBoolean", "documentation":"

Specify true to apply the rule, or false to disable it.

" }, "MaxAgeInDays":{ "shape":"BoxedInt", "documentation":"

Specify the number of days to retain an application versions.

" }, "DeleteSourceFromS3":{ "shape":"BoxedBoolean", "documentation":"

Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

" } }, "documentation":"

A lifecycle rule that deletes application versions after the specified number of days.

" }, "MaxCountRule":{ "type":"structure", "required":["Enabled"], "members":{ "Enabled":{ "shape":"BoxedBoolean", "documentation":"

Specify true to apply the rule, or false to disable it.

" }, "MaxCount":{ "shape":"BoxedInt", "documentation":"

Specify the maximum number of application versions to retain.

" }, "DeleteSourceFromS3":{ "shape":"BoxedBoolean", "documentation":"

Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

" } }, "documentation":"

A lifecycle rule that deletes the oldest application version when the maximum count is exceeded.

" }, "MaxRecords":{ "type":"integer", "max":1000, "min":1 }, "Message":{"type":"string"}, "NextToken":{ "type":"string", "max":100, "min":1 }, "NonEmptyString":{ "type":"string", "pattern":".*\\S.*" }, "NullableDouble":{"type":"double"}, "NullableInteger":{"type":"integer"}, "NullableLong":{"type":"long"}, "OperationInProgressException":{ "type":"structure", "members":{ }, "documentation":"

Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.

", "error":{ "code":"OperationInProgressFailure", "httpStatusCode":400, "senderFault":true }, "exception":true }, "OptionNamespace":{"type":"string"}, "OptionRestrictionMaxLength":{"type":"integer"}, "OptionRestrictionMaxValue":{"type":"integer"}, "OptionRestrictionMinValue":{"type":"integer"}, "OptionRestrictionRegex":{ "type":"structure", "members":{ "Pattern":{ "shape":"RegexPattern", "documentation":"

The regular expression pattern that a string configuration option value with this restriction must match.

" }, "Label":{ "shape":"RegexLabel", "documentation":"

A unique name representing this regular expression.

" } }, "documentation":"

A regular expression representing a restriction on a string configuration option value.

" }, "OptionSpecification":{ "type":"structure", "members":{ "ResourceName":{ "shape":"ResourceName", "documentation":"

A unique resource name for a time-based scaling configuration option.

" }, "Namespace":{ "shape":"OptionNamespace", "documentation":"

A unique namespace identifying the option's associated AWS resource.

" }, "OptionName":{ "shape":"ConfigurationOptionName", "documentation":"

The name of the configuration option.

" } }, "documentation":"

A specification identifying an individual configuration option.

" }, "OptionsSpecifierList":{ "type":"list", "member":{"shape":"OptionSpecification"} }, "Queue":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the queue.

" }, "URL":{ "shape":"String", "documentation":"

The URL of the queue.

" } }, "documentation":"

Describes a queue.

" }, "QueueList":{ "type":"list", "member":{"shape":"Queue"} }, "RebuildEnvironmentMessage":{ "type":"structure", "members":{ "EnvironmentId":{ "shape":"EnvironmentId", "documentation":"

The ID of the environment to rebuild.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of the environment to rebuild.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" } }, "documentation":"

" }, "RefreshedAt":{"type":"timestamp"}, "RegexLabel":{"type":"string"}, "RegexPattern":{"type":"string"}, "RequestCount":{"type":"integer"}, "RequestEnvironmentInfoMessage":{ "type":"structure", "required":["InfoType"], "members":{ "EnvironmentId":{ "shape":"EnvironmentId", "documentation":"

The ID of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" }, "InfoType":{ "shape":"EnvironmentInfoType", "documentation":"

The type of information to request.

" } }, "documentation":"

Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.

" }, "RequestId":{"type":"string"}, "ResourceId":{"type":"string"}, "ResourceName":{ "type":"string", "max":256, "min":1 }, "RestartAppServerMessage":{ "type":"structure", "members":{ "EnvironmentId":{ "shape":"EnvironmentId", "documentation":"

The ID of the environment to restart the server for.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of the environment to restart the server for.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" } }, "documentation":"

" }, "RetrieveEnvironmentInfoMessage":{ "type":"structure", "required":["InfoType"], "members":{ "EnvironmentId":{ "shape":"EnvironmentId", "documentation":"

The ID of the data's environment.

If no such environment is found, returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of the data's environment.

If no such environment is found, returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" }, "InfoType":{ "shape":"EnvironmentInfoType", "documentation":"

The type of information to retrieve.

" } }, "documentation":"

Request to download logs retrieved with RequestEnvironmentInfo.

" }, "RetrieveEnvironmentInfoResultMessage":{ "type":"structure", "members":{ "EnvironmentInfo":{ "shape":"EnvironmentInfoDescriptionList", "documentation":"

The EnvironmentInfoDescription of the environment.

" } }, "documentation":"

Result message containing a description of the requested environment info.

" }, "S3Bucket":{ "type":"string", "max":255 }, "S3Key":{ "type":"string", "max":1024 }, "S3Location":{ "type":"structure", "members":{ "S3Bucket":{ "shape":"S3Bucket", "documentation":"

The Amazon S3 bucket where the data is located.

" }, "S3Key":{ "shape":"S3Key", "documentation":"

The Amazon S3 key where the data is located.

" } }, "documentation":"

The bucket and key of an item stored in Amazon S3.

" }, "S3LocationNotInServiceRegionException":{ "type":"structure", "members":{ }, "documentation":"

The specified S3 bucket does not belong to the S3 region in which the service is running. The following regions are supported:

  • IAD/us-east-1

  • PDX/us-west-2

  • DUB/eu-west-1

", "error":{ "code":"S3LocationNotInServiceRegionException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "S3SubscriptionRequiredException":{ "type":"structure", "members":{ }, "documentation":"

The specified account does not have a subscription to Amazon S3.

", "error":{ "code":"S3SubscriptionRequiredException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SampleTimestamp":{"type":"timestamp"}, "SingleInstanceHealth":{ "type":"structure", "members":{ "InstanceId":{ "shape":"InstanceId", "documentation":"

The ID of the Amazon EC2 instance.

" }, "HealthStatus":{ "shape":"String", "documentation":"

Returns the health status of the specified instance. For more information, see Health Colors and Statuses.

" }, "Color":{ "shape":"String", "documentation":"

Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses.

" }, "Causes":{ "shape":"Causes", "documentation":"

Represents the causes, which provide more information about the current health status.

" }, "LaunchedAt":{ "shape":"LaunchedAt", "documentation":"

The time at which the EC2 instance was launched.

" }, "ApplicationMetrics":{ "shape":"ApplicationMetrics", "documentation":"

Request metrics from your application.

" }, "System":{ "shape":"SystemStatus", "documentation":"

Operating system metrics from the instance.

" }, "Deployment":{ "shape":"Deployment", "documentation":"

Information about the most recent deployment to an instance.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The availability zone in which the instance runs.

" }, "InstanceType":{ "shape":"String", "documentation":"

The instance's type.

" } }, "documentation":"

Detailed health information about an Amazon EC2 instance in your Elastic Beanstalk environment.

" }, "SolutionStackDescription":{ "type":"structure", "members":{ "SolutionStackName":{ "shape":"SolutionStackName", "documentation":"

The name of the solution stack.

" }, "PermittedFileTypes":{ "shape":"SolutionStackFileTypeList", "documentation":"

The permitted file types allowed for a solution stack.

" } }, "documentation":"

Describes the solution stack.

" }, "SolutionStackFileTypeList":{ "type":"list", "member":{"shape":"FileTypeExtension"} }, "SolutionStackName":{ "type":"string", "max":100 }, "SourceBuildInformation":{ "type":"structure", "required":[ "SourceType", "SourceRepository", "SourceLocation" ], "members":{ "SourceType":{ "shape":"SourceType", "documentation":"

The type of repository.

  • Git

  • Zip

" }, "SourceRepository":{ "shape":"SourceRepository", "documentation":"

Location where the repository is stored.

  • CodeCommit

  • S3

" }, "SourceLocation":{ "shape":"SourceLocation", "documentation":"

The location of the source code, as a formatted string, depending on the value of SourceRepository

  • For CodeCommit, the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a.

  • For S3, the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file.

" } }, "documentation":"

Location of the source code for an application version.

" }, "SourceBundleDeletionException":{ "type":"structure", "members":{ }, "documentation":"

Unable to delete the Amazon S3 source bundle associated with the application version. The application version was deleted successfully.

", "error":{ "code":"SourceBundleDeletionFailure", "httpStatusCode":400, "senderFault":true }, "exception":true }, "SourceConfiguration":{ "type":"structure", "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application associated with the configuration.

" }, "TemplateName":{ "shape":"ConfigurationTemplateName", "documentation":"

The name of the configuration template.

" } }, "documentation":"

A specification for an environment configuration

" }, "SourceLocation":{ "type":"string", "max":255, "min":3, "pattern":".+/.+" }, "SourceRepository":{ "type":"string", "enum":[ "CodeCommit", "S3" ] }, "SourceType":{ "type":"string", "enum":[ "Git", "Zip" ] }, "StatusCodes":{ "type":"structure", "members":{ "Status2xx":{ "shape":"NullableInteger", "documentation":"

The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code.

" }, "Status3xx":{ "shape":"NullableInteger", "documentation":"

The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code.

" }, "Status4xx":{ "shape":"NullableInteger", "documentation":"

The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code.

" }, "Status5xx":{ "shape":"NullableInteger", "documentation":"

The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code.

" } }, "documentation":"

Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response. For more information, see Status Code Definitions.

" }, "String":{"type":"string"}, "SwapEnvironmentCNAMEsMessage":{ "type":"structure", "members":{ "SourceEnvironmentId":{ "shape":"EnvironmentId", "documentation":"

The ID of the source environment.

Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentId, you must specify the DestinationEnvironmentId.

" }, "SourceEnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of the source environment.

Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentName, you must specify the DestinationEnvironmentName.

" }, "DestinationEnvironmentId":{ "shape":"EnvironmentId", "documentation":"

The ID of the destination environment.

Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentId with the DestinationEnvironmentId.

" }, "DestinationEnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of the destination environment.

Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentName with the DestinationEnvironmentName.

" } }, "documentation":"

Swaps the CNAMEs of two environments.

" }, "SystemStatus":{ "type":"structure", "members":{ "CPUUtilization":{ "shape":"CPUUtilization", "documentation":"

CPU utilization metrics for the instance.

" }, "LoadAverage":{ "shape":"LoadAverage", "documentation":"

Load average in the last 1-minute and 5-minute periods. For more information, see Operating System Metrics.

" } }, "documentation":"

CPU utilization and load average metrics for an Amazon EC2 instance.

" }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"TagKey", "documentation":"

The key of the tag.

" }, "Value":{ "shape":"TagValue", "documentation":"

The value of the tag.

" } }, "documentation":"

Describes a tag applied to a resource in an environment.

" }, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagValue":{ "type":"string", "max":256, "min":1 }, "Tags":{ "type":"list", "member":{"shape":"Tag"} }, "TerminateEnvForce":{"type":"boolean"}, "TerminateEnvironmentMessage":{ "type":"structure", "members":{ "EnvironmentId":{ "shape":"EnvironmentId", "documentation":"

The ID of the environment to terminate.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of the environment to terminate.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" }, "TerminateResources":{ "shape":"TerminateEnvironmentResources", "documentation":"

Indicates whether the associated AWS resources should shut down when the environment is terminated:

  • true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.

  • false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

For more information, see the AWS Elastic Beanstalk User Guide.

Default: true

Valid Values: true | false

" }, "ForceTerminate":{ "shape":"ForceTerminate", "documentation":"

Terminates the target environment even if another environment in the same group is dependent on it.

" } }, "documentation":"

Request to terminate an environment.

" }, "TerminateEnvironmentResources":{"type":"boolean"}, "TimeFilterEnd":{"type":"timestamp"}, "TimeFilterStart":{"type":"timestamp"}, "Timestamp":{"type":"timestamp"}, "Token":{"type":"string"}, "TooManyApplicationVersionsException":{ "type":"structure", "members":{ }, "documentation":"

The specified account has reached its limit of application versions.

", "exception":true }, "TooManyApplicationsException":{ "type":"structure", "members":{ }, "documentation":"

The specified account has reached its limit of applications.

", "error":{ "code":"TooManyApplicationsException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TooManyBucketsException":{ "type":"structure", "members":{ }, "documentation":"

The specified account has reached its limit of Amazon S3 buckets.

", "error":{ "code":"TooManyBucketsException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TooManyConfigurationTemplatesException":{ "type":"structure", "members":{ }, "documentation":"

The specified account has reached its limit of configuration templates.

", "error":{ "code":"TooManyConfigurationTemplatesException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "TooManyEnvironmentsException":{ "type":"structure", "members":{ }, "documentation":"

The specified account has reached its limit of environments.

", "error":{ "code":"TooManyEnvironmentsException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Trigger":{ "type":"structure", "members":{ "Name":{ "shape":"ResourceId", "documentation":"

The name of the trigger.

" } }, "documentation":"

Describes a trigger.

" }, "TriggerList":{ "type":"list", "member":{"shape":"Trigger"} }, "UpdateApplicationMessage":{ "type":"structure", "required":["ApplicationName"], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue error.

" }, "Description":{ "shape":"Description", "documentation":"

A new description for the application.

Default: If not specified, AWS Elastic Beanstalk does not update the description.

" } }, "documentation":"

Request to update an application.

" }, "UpdateApplicationResourceLifecycleMessage":{ "type":"structure", "required":[ "ApplicationName", "ResourceLifecycleConfig" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application.

" }, "ResourceLifecycleConfig":{ "shape":"ApplicationResourceLifecycleConfig", "documentation":"

The lifecycle configuration.

" } } }, "UpdateApplicationVersionMessage":{ "type":"structure", "required":[ "ApplicationName", "VersionLabel" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application associated with this version.

If no application is found with this name, UpdateApplication returns an InvalidParameterValue error.

" }, "VersionLabel":{ "shape":"VersionLabel", "documentation":"

The name of the version to update.

If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error.

" }, "Description":{ "shape":"Description", "documentation":"

A new description for this version.

" } }, "documentation":"

" }, "UpdateConfigurationTemplateMessage":{ "type":"structure", "required":[ "ApplicationName", "TemplateName" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application associated with the configuration template to update.

If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

" }, "TemplateName":{ "shape":"ConfigurationTemplateName", "documentation":"

The name of the configuration template to update.

If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

" }, "Description":{ "shape":"Description", "documentation":"

A new description for the configuration.

" }, "OptionSettings":{ "shape":"ConfigurationOptionSettingsList", "documentation":"

A list of configuration option settings to update with the new specified option value.

" }, "OptionsToRemove":{ "shape":"OptionsSpecifierList", "documentation":"

A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

" } }, "documentation":"

The result message containing the options for the specified solution stack.

" }, "UpdateDate":{"type":"timestamp"}, "UpdateEnvironmentMessage":{ "type":"structure", "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application with which the environment is associated.

" }, "EnvironmentId":{ "shape":"EnvironmentId", "documentation":"

The ID of the environment to update.

If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" }, "GroupName":{ "shape":"GroupName", "documentation":"

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.

" }, "Description":{ "shape":"Description", "documentation":"

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

" }, "Tier":{ "shape":"EnvironmentTier", "documentation":"

This specifies the tier to use to update the environment.

Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.

" }, "VersionLabel":{ "shape":"VersionLabel", "documentation":"

If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

" }, "TemplateName":{ "shape":"ConfigurationTemplateName", "documentation":"

If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

" }, "SolutionStackName":{ "shape":"SolutionStackName", "documentation":"

This specifies the platform version that the environment will run after the environment is updated.

" }, "OptionSettings":{ "shape":"ConfigurationOptionSettingsList", "documentation":"

If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

" }, "OptionsToRemove":{ "shape":"OptionsSpecifierList", "documentation":"

A list of custom user-defined configuration options to remove from the configuration set for this environment.

" } }, "documentation":"

Request to update an environment.

" }, "UserDefinedOption":{"type":"boolean"}, "ValidateConfigurationSettingsMessage":{ "type":"structure", "required":[ "ApplicationName", "OptionSettings" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

The name of the application that the configuration template or environment belongs to.

" }, "TemplateName":{ "shape":"ConfigurationTemplateName", "documentation":"

The name of the configuration template to validate the settings against.

Condition: You cannot specify both this and an environment name.

" }, "EnvironmentName":{ "shape":"EnvironmentName", "documentation":"

The name of the environment to validate the settings against.

Condition: You cannot specify both this and a configuration template name.

" }, "OptionSettings":{ "shape":"ConfigurationOptionSettingsList", "documentation":"

A list of the options and desired values to evaluate.

" } }, "documentation":"

A list of validation messages for a specified configuration template.

" }, "ValidationMessage":{ "type":"structure", "members":{ "Message":{ "shape":"ValidationMessageString", "documentation":"

A message describing the error or warning.

" }, "Severity":{ "shape":"ValidationSeverity", "documentation":"

An indication of the severity of this message:

  • error: This message indicates that this is not a valid setting for an option.

  • warning: This message is providing information you should take into account.

" }, "Namespace":{ "shape":"OptionNamespace", "documentation":"

The namespace to which the option belongs.

" }, "OptionName":{ "shape":"ConfigurationOptionName", "documentation":"

The name of the option.

" } }, "documentation":"

An error or warning for a desired configuration option value.

" }, "ValidationMessageString":{"type":"string"}, "ValidationMessagesList":{ "type":"list", "member":{"shape":"ValidationMessage"} }, "ValidationSeverity":{ "type":"string", "enum":[ "error", "warning" ] }, "VersionLabel":{ "type":"string", "max":100, "min":1 }, "VersionLabels":{ "type":"list", "member":{"shape":"VersionLabel"} }, "VersionLabelsList":{ "type":"list", "member":{"shape":"VersionLabel"} } }, "documentation":"AWS Elastic Beanstalk

AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.

For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services.

Endpoints

For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the Amazon Web Services Glossary.

" } botocore-1.5.7/botocore/data/cur/0000777454262600001440000000000013042511307017724 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cur/2017-01-06/0000777454262600001440000000000013042511307020756 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cur/2017-01-06/service-2.json0000666454262600001440000001764413042511306023463 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2017-01-06", "endpointPrefix":"cur", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"AWS Cost and Usage Report Service", "signatureVersion":"v4", "signingName":"cur", "targetPrefix":"AWSOrigamiServiceGatewayService", "uid":"cur-2017-01-06" }, "operations":{ "DeleteReportDefinition":{ "name":"DeleteReportDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteReportDefinitionRequest"}, "output":{"shape":"DeleteReportDefinitionResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"ValidationException"} ], "documentation":"Delete a specified report definition" }, "DescribeReportDefinitions":{ "name":"DescribeReportDefinitions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReportDefinitionsRequest"}, "output":{"shape":"DescribeReportDefinitionsResponse"}, "errors":[ {"shape":"InternalErrorException"} ], "documentation":"Describe a list of report definitions owned by the account" }, "PutReportDefinition":{ "name":"PutReportDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutReportDefinitionRequest"}, "output":{"shape":"PutReportDefinitionResponse"}, "errors":[ {"shape":"DuplicateReportNameException"}, {"shape":"ReportLimitReachedException"}, {"shape":"InternalErrorException"}, {"shape":"ValidationException"} ], "documentation":"Create a new report definition" } }, "shapes":{ "AWSRegion":{ "type":"string", "documentation":"Region of customer S3 bucket.", "enum":[ "us-east-1", "us-west-1", "us-west-2", "eu-central-1", "eu-west-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1" ] }, "AdditionalArtifact":{ "type":"string", "documentation":"Enable support for Redshift and/or QuickSight.", "enum":[ "REDSHIFT", "QUICKSIGHT" ] }, "AdditionalArtifactList":{ "type":"list", "member":{"shape":"AdditionalArtifact"}, "documentation":"A list of additional artifacts." }, "CompressionFormat":{ "type":"string", "documentation":"Preferred compression format for report.", "enum":[ "ZIP", "GZIP" ] }, "DeleteReportDefinitionRequest":{ "type":"structure", "members":{ "ReportName":{"shape":"ReportName"} }, "documentation":"Request of DeleteReportDefinition" }, "DeleteReportDefinitionResponse":{ "type":"structure", "members":{ "ResponseMessage":{"shape":"DeleteResponseMessage"} }, "documentation":"Response of DeleteReportDefinition" }, "DeleteResponseMessage":{ "type":"string", "documentation":"A message indicates if the deletion is successful." }, "DescribeReportDefinitionsRequest":{ "type":"structure", "members":{ "MaxResults":{"shape":"MaxResults"}, "NextToken":{"shape":"GenericString"} }, "documentation":"Request of DescribeReportDefinitions" }, "DescribeReportDefinitionsResponse":{ "type":"structure", "members":{ "ReportDefinitions":{"shape":"ReportDefinitionList"}, "NextToken":{"shape":"GenericString"} }, "documentation":"Response of DescribeReportDefinitions" }, "DuplicateReportNameException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"This exception is thrown when putting a report preference with a name that already exists.", "exception":true }, "ErrorMessage":{ "type":"string", "documentation":"A message to show the detail of the exception." }, "GenericString":{ "type":"string", "documentation":"A generic string." }, "InternalErrorException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"This exception is thrown on a known dependency failure.", "exception":true, "fault":true }, "MaxResults":{ "type":"integer", "documentation":"The max number of results returned by the operation.", "box":true, "max":5, "min":5 }, "PutReportDefinitionRequest":{ "type":"structure", "required":["ReportDefinition"], "members":{ "ReportDefinition":{"shape":"ReportDefinition"} }, "documentation":"Request of PutReportDefinition" }, "PutReportDefinitionResponse":{ "type":"structure", "members":{ }, "documentation":"Response of PutReportDefinition" }, "ReportDefinition":{ "type":"structure", "required":[ "ReportName", "TimeUnit", "Format", "Compression", "AdditionalSchemaElements", "S3Bucket", "S3Prefix", "S3Region" ], "members":{ "ReportName":{"shape":"ReportName"}, "TimeUnit":{"shape":"TimeUnit"}, "Format":{"shape":"ReportFormat"}, "Compression":{"shape":"CompressionFormat"}, "AdditionalSchemaElements":{"shape":"SchemaElementList"}, "S3Bucket":{"shape":"S3Bucket"}, "S3Prefix":{"shape":"S3Prefix"}, "S3Region":{"shape":"AWSRegion"}, "AdditionalArtifacts":{"shape":"AdditionalArtifactList"} }, "documentation":"The definition of AWS Cost and Usage Report. Customer can specify the report name, time unit, report format, compression format, S3 bucket and additional artifacts and schema elements in the definition." }, "ReportDefinitionList":{ "type":"list", "member":{"shape":"ReportDefinition"}, "documentation":"A list of report definitions." }, "ReportFormat":{ "type":"string", "documentation":"Preferred format for report.", "enum":["textORcsv"] }, "ReportLimitReachedException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"This exception is thrown when the number of report preference reaches max limit. The max number is 5.", "exception":true }, "ReportName":{ "type":"string", "documentation":"Preferred name for a report, it has to be unique. Must starts with a number/letter, case sensitive. Limited to 256 characters.", "max":256, "pattern":"[0-9A-Za-z!\\-_.*\\'()]+" }, "S3Bucket":{ "type":"string", "documentation":"Name of customer S3 bucket.", "max":256 }, "S3Prefix":{ "type":"string", "documentation":"Preferred report path prefix. Limited to 256 characters.", "max":256, "pattern":"[0-9A-Za-z!\\-_.*\\'()/]*" }, "SchemaElement":{ "type":"string", "documentation":"Preference of including Resource IDs. You can include additional details about individual resource IDs in your report.", "enum":["RESOURCES"] }, "SchemaElementList":{ "type":"list", "member":{"shape":"SchemaElement"}, "documentation":"A list of schema elements." }, "TimeUnit":{ "type":"string", "documentation":"The frequency on which report data are measured and displayed.", "enum":[ "HOURLY", "DAILY" ] }, "ValidationException":{ "type":"structure", "members":{ "Message":{"shape":"ErrorMessage"} }, "documentation":"This exception is thrown when providing an invalid input. eg. Put a report preference with an invalid report name, or Delete a report preference with an empty report name.", "exception":true } }, "documentation":"All public APIs for AWS Cost and Usage Report service" } botocore-1.5.7/botocore/data/_retry.json0000666454262600001440000001173213042511306021335 0ustar pysdk-ciamazon00000000000000{ "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 } } }, "too_many_requests": { "applies_when": { "response": { "http_status_code": 429 } } }, "general_socket_errors": { "applies_when": { "socket_errors": ["GENERAL_CONNECTION_ERROR"] } }, "general_server_error": { "applies_when": { "response": { "http_status_code": 500 } } }, "bad_gateway": { "applies_when": { "response": { "http_status_code": 502 } } }, "service_unavailable": { "applies_when": { "response": { "http_status_code": 503 } } }, "gateway_timeout": { "applies_when": { "response": { "http_status_code": 504 } } }, "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"}, "bad_gateway": {"$ref": "bad_gateway"}, "service_unavailable": {"$ref": "service_unavailable"}, "gateway_timeout": {"$ref": "gateway_timeout"}, "limit_exceeded": {"$ref": "limit_exceeded"}, "throttling_exception": {"$ref": "throttling_exception"}, "throttling": {"$ref": "throttling"}, "too_many_requests": {"$ref": "too_many_requests"} } }, "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 } } }, "crc32": { "applies_when": { "response": { "crc32body": "x-amz-crc32" } } } } } }, "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 } } } } } }, "kinesis": { "DescribeStream": { "policies": { "request_limit_exceeded": { "applies_when": { "response": { "service_error_code": "LimitExceededException", "http_status_code": 400 } } } } } }, "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" } } }, "contentmd5": { "applies_when": { "response": { "http_status_code": 400, "service_error_code": "BadDigest" } } } } } }, "route53": { "__default__": { "policies": { "request_limit_exceeded": { "applies_when": { "response": { "service_error_code": "Throttling", "http_status_code": 400 } } }, "still_processing": { "applies_when": { "response": { "service_error_code": "PriorRequestNotComplete", "http_status_code": 400 } } } } } } } } botocore-1.5.7/botocore/data/directconnect/0000777454262600001440000000000013042511307021757 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/directconnect/2012-10-25/0000777454262600001440000000000013042511307023005 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/directconnect/2012-10-25/service-2.json0000666454262600001440000017054613042511306025513 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2012-10-25", "endpointPrefix":"directconnect", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"AWS Direct Connect", "signatureVersion":"v4", "targetPrefix":"OvertureService", "uid":"directconnect-2012-10-25" }, "operations":{ "AllocateConnectionOnInterconnect":{ "name":"AllocateConnectionOnInterconnect", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AllocateConnectionOnInterconnectRequest"}, "output":{"shape":"Connection"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Creates a hosted connection on an interconnect.

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect.

This is intended for use by AWS Direct Connect partners only.

" }, "AllocatePrivateVirtualInterface":{ "name":"AllocatePrivateVirtualInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AllocatePrivateVirtualInterfaceRequest"}, "output":{"shape":"VirtualInterface"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Provisions a private virtual interface to be owned by a different customer.

The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer.

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.

" }, "AllocatePublicVirtualInterface":{ "name":"AllocatePublicVirtualInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AllocatePublicVirtualInterfaceRequest"}, "output":{"shape":"VirtualInterface"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Provisions a public virtual interface to be owned by a different customer.

The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer.

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.

When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.

" }, "ConfirmConnection":{ "name":"ConfirmConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmConnectionRequest"}, "output":{"shape":"ConfirmConnectionResponse"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Confirm the creation of a hosted connection on an interconnect.

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.

" }, "ConfirmPrivateVirtualInterface":{ "name":"ConfirmPrivateVirtualInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmPrivateVirtualInterfaceRequest"}, "output":{"shape":"ConfirmPrivateVirtualInterfaceResponse"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Accept ownership of a private virtual interface created by another customer.

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.

" }, "ConfirmPublicVirtualInterface":{ "name":"ConfirmPublicVirtualInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmPublicVirtualInterfaceRequest"}, "output":{"shape":"ConfirmPublicVirtualInterfaceResponse"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Accept ownership of a public virtual interface created by another customer.

After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic.

" }, "CreateBGPPeer":{ "name":"CreateBGPPeer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateBGPPeerRequest"}, "output":{"shape":"CreateBGPPeerResponse"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Creates a new BGP peer on a specified virtual interface. The BGP peer cannot be in the same address family (IPv4/IPv6) of an existing BGP peer on the virtual interface.

You must create a BGP peer for the corresponding address family in order to access AWS resources that also use that address family.

When creating a IPv6 BGP peer, the Amazon address and customer address fields must be left blank. IPv6 addresses are automatically assigned from Amazon's pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

For a public virtual interface, the Autonomous System Number (ASN) must be private or already whitelisted for the virtual interface.

" }, "CreateConnection":{ "name":"CreateConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateConnectionRequest"}, "output":{"shape":"Connection"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Creates a new connection between the customer network and a specific AWS Direct Connect location.

A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your 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.

" }, "CreateInterconnect":{ "name":"CreateInterconnect", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInterconnectRequest"}, "output":{"shape":"Interconnect"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.

An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an 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.

For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner.

This is intended for use by AWS Direct Connect partners only.

" }, "CreatePrivateVirtualInterface":{ "name":"CreatePrivateVirtualInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePrivateVirtualInterfaceRequest"}, "output":{"shape":"VirtualInterface"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC).

" }, "CreatePublicVirtualInterface":{ "name":"CreatePublicVirtualInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePublicVirtualInterfaceRequest"}, "output":{"shape":"VirtualInterface"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

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).

When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.

" }, "DeleteBGPPeer":{ "name":"DeleteBGPPeer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteBGPPeerRequest"}, "output":{"shape":"DeleteBGPPeerResponse"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Deletes a BGP peer on the specified virtual interface that matches the specified customer address and ASN. You cannot delete the last BGP peer from a virtual interface.

" }, "DeleteConnection":{ "name":"DeleteConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteConnectionRequest"}, "output":{"shape":"Connection"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Deletes the connection.

Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. 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.

" }, "DeleteInterconnect":{ "name":"DeleteInterconnect", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteInterconnectRequest"}, "output":{"shape":"DeleteInterconnectResponse"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Deletes the specified interconnect.

This is intended for use by AWS Direct Connect partners only.

" }, "DeleteVirtualInterface":{ "name":"DeleteVirtualInterface", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVirtualInterfaceRequest"}, "output":{"shape":"DeleteVirtualInterfaceResponse"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Deletes a virtual interface.

" }, "DescribeConnectionLoa":{ "name":"DescribeConnectionLoa", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConnectionLoaRequest"}, "output":{"shape":"DescribeConnectionLoaResponse"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Returns the LOA-CFA for a Connection.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect user guide.

" }, "DescribeConnections":{ "name":"DescribeConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConnectionsRequest"}, "output":{"shape":"Connections"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Displays all connections in this region.

If a connection ID is provided, the call returns only that particular connection.

" }, "DescribeConnectionsOnInterconnect":{ "name":"DescribeConnectionsOnInterconnect", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConnectionsOnInterconnectRequest"}, "output":{"shape":"Connections"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Return a list of connections that have been provisioned on the given interconnect.

This is intended for use by AWS Direct Connect partners only.

" }, "DescribeInterconnectLoa":{ "name":"DescribeInterconnectLoa", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInterconnectLoaRequest"}, "output":{"shape":"DescribeInterconnectLoaResponse"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Returns the LOA-CFA for an Interconnect.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect user guide.

" }, "DescribeInterconnects":{ "name":"DescribeInterconnects", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInterconnectsRequest"}, "output":{"shape":"Interconnects"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Returns a list of interconnects owned by the AWS account.

If an interconnect ID is provided, it will only return this particular interconnect.

" }, "DescribeLocations":{ "name":"DescribeLocations", "http":{ "method":"POST", "requestUri":"/" }, "output":{"shape":"Locations"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

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.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsRequest"}, "output":{"shape":"DescribeTagsResponse"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Describes the tags associated with the specified Direct Connect resources.

" }, "DescribeVirtualGateways":{ "name":"DescribeVirtualGateways", "http":{ "method":"POST", "requestUri":"/" }, "output":{"shape":"VirtualGateways"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Returns a list of virtual private gateways owned by the AWS account.

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.

" }, "DescribeVirtualInterfaces":{ "name":"DescribeVirtualInterfaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVirtualInterfacesRequest"}, "output":{"shape":"VirtualInterfaces"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

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.

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

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.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"DuplicateTagKeysException"}, {"shape":"TooManyTagsException"}, {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Adds the specified tags to the specified Direct Connect resource. Each Direct Connect resource can have a maximum of 50 tags.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the Direct Connect resource, this action updates its value.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"DirectConnectServerException"}, {"shape":"DirectConnectClientException"} ], "documentation":"

Removes one or more tags from the specified Direct Connect resource.

" } }, "shapes":{ "ASN":{ "type":"integer", "documentation":"

Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

Example: 65000

" }, "AddressFamily":{ "type":"string", "documentation":"

Indicates the address family for the BGP peer.

  • ipv4: IPv4 address family

  • ipv6: IPv6 address family

", "enum":[ "ipv4", "ipv6" ] }, "AllocateConnectionOnInterconnectRequest":{ "type":"structure", "required":[ "bandwidth", "connectionName", "ownerAccount", "interconnectId", "vlan" ], "members":{ "bandwidth":{ "shape":"Bandwidth", "documentation":"

Bandwidth of the connection.

Example: \"500Mbps\"

Default: None

Values: 50M, 100M, 200M, 300M, 400M, or 500M

" }, "connectionName":{ "shape":"ConnectionName", "documentation":"

Name of the provisioned connection.

Example: \"500M Connection to AWS\"

Default: None

" }, "ownerAccount":{ "shape":"OwnerAccount", "documentation":"

Numeric account Id of the customer for whom the connection will be provisioned.

Example: 123443215678

Default: None

" }, "interconnectId":{ "shape":"InterconnectId", "documentation":"

ID of the interconnect on which the connection will be provisioned.

Example: dxcon-456abc78

Default: None

" }, "vlan":{ "shape":"VLAN", "documentation":"

The dedicated VLAN provisioned to the connection.

Example: 101

Default: None

" } }, "documentation":"

Container for the parameters to the AllocateConnectionOnInterconnect operation.

" }, "AllocatePrivateVirtualInterfaceRequest":{ "type":"structure", "required":[ "connectionId", "ownerAccount", "newPrivateVirtualInterfaceAllocation" ], "members":{ "connectionId":{ "shape":"ConnectionId", "documentation":"

The connection ID on which the private virtual interface is provisioned.

Default: None

" }, "ownerAccount":{ "shape":"OwnerAccount", "documentation":"

The AWS account that will own the new private virtual interface.

Default: None

" }, "newPrivateVirtualInterfaceAllocation":{ "shape":"NewPrivateVirtualInterfaceAllocation", "documentation":"

Detailed information for the private virtual interface to be provisioned.

Default: None

" } }, "documentation":"

Container for the parameters to the AllocatePrivateVirtualInterface operation.

" }, "AllocatePublicVirtualInterfaceRequest":{ "type":"structure", "required":[ "connectionId", "ownerAccount", "newPublicVirtualInterfaceAllocation" ], "members":{ "connectionId":{ "shape":"ConnectionId", "documentation":"

The connection ID on which the public virtual interface is provisioned.

Default: None

" }, "ownerAccount":{ "shape":"OwnerAccount", "documentation":"

The AWS account that will own the new public virtual interface.

Default: None

" }, "newPublicVirtualInterfaceAllocation":{ "shape":"NewPublicVirtualInterfaceAllocation", "documentation":"

Detailed information for the public virtual interface to be provisioned.

Default: None

" } }, "documentation":"

Container for the parameters to the AllocatePublicVirtualInterface operation.

" }, "AmazonAddress":{ "type":"string", "documentation":"

IP address assigned to the Amazon interface.

Example: 192.168.1.1/30 or 2001:db8::1/125

" }, "BGPAuthKey":{ "type":"string", "documentation":"

Authentication key for BGP configuration.

Example: asdf34example

" }, "BGPPeer":{ "type":"structure", "members":{ "asn":{"shape":"ASN"}, "authKey":{"shape":"BGPAuthKey"}, "addressFamily":{"shape":"AddressFamily"}, "amazonAddress":{"shape":"AmazonAddress"}, "customerAddress":{"shape":"CustomerAddress"}, "bgpPeerState":{"shape":"BGPPeerState"}, "bgpStatus":{"shape":"BGPStatus"} }, "documentation":"

A structure containing information about a BGP peer.

" }, "BGPPeerList":{ "type":"list", "member":{"shape":"BGPPeer"}, "documentation":"

A list of the BGP peers configured on this virtual interface.

" }, "BGPPeerState":{ "type":"string", "documentation":"

The state of the BGP peer.

  • Verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

  • Pending: The BGP peer has been created, and is in this state until it is ready to be established.

  • Available: The BGP peer can be established.

  • Deleting: The BGP peer is in the process of being deleted.

  • Deleted: The BGP peer has been deleted and cannot be established.

", "enum":[ "verifying", "pending", "available", "deleting", "deleted" ] }, "BGPStatus":{ "type":"string", "documentation":"

The Up/Down state of the BGP peer.

  • Up: The BGP peer is established.

  • Down: The BGP peer is down.

", "enum":[ "up", "down" ] }, "Bandwidth":{ "type":"string", "documentation":"

Bandwidth of the connection.

Example: 1Gbps

Default: None

" }, "CIDR":{"type":"string"}, "ConfirmConnectionRequest":{ "type":"structure", "required":["connectionId"], "members":{ "connectionId":{"shape":"ConnectionId"} }, "documentation":"

Container for the parameters to the ConfirmConnection operation.

" }, "ConfirmConnectionResponse":{ "type":"structure", "members":{ "connectionState":{"shape":"ConnectionState"} }, "documentation":"

The response received when ConfirmConnection is called.

" }, "ConfirmPrivateVirtualInterfaceRequest":{ "type":"structure", "required":[ "virtualInterfaceId", "virtualGatewayId" ], "members":{ "virtualInterfaceId":{"shape":"VirtualInterfaceId"}, "virtualGatewayId":{ "shape":"VirtualGatewayId", "documentation":"

ID of the virtual private gateway that will be attached to the virtual interface.

A virtual private gateway can be managed via the Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.

Default: None

" } }, "documentation":"

Container for the parameters to the ConfirmPrivateVirtualInterface operation.

" }, "ConfirmPrivateVirtualInterfaceResponse":{ "type":"structure", "members":{ "virtualInterfaceState":{"shape":"VirtualInterfaceState"} }, "documentation":"

The response received when ConfirmPrivateVirtualInterface is called.

" }, "ConfirmPublicVirtualInterfaceRequest":{ "type":"structure", "required":["virtualInterfaceId"], "members":{ "virtualInterfaceId":{"shape":"VirtualInterfaceId"} }, "documentation":"

Container for the parameters to the ConfirmPublicVirtualInterface operation.

" }, "ConfirmPublicVirtualInterfaceResponse":{ "type":"structure", "members":{ "virtualInterfaceState":{"shape":"VirtualInterfaceState"} }, "documentation":"

The response received when ConfirmPublicVirtualInterface is called.

" }, "Connection":{ "type":"structure", "members":{ "ownerAccount":{ "shape":"OwnerAccount", "documentation":"

The AWS account that will own the new connection.

" }, "connectionId":{"shape":"ConnectionId"}, "connectionName":{"shape":"ConnectionName"}, "connectionState":{"shape":"ConnectionState"}, "region":{"shape":"Region"}, "location":{"shape":"LocationCode"}, "bandwidth":{ "shape":"Bandwidth", "documentation":"

Bandwidth of the connection.

Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

Default: None

" }, "vlan":{"shape":"VLAN"}, "partnerName":{ "shape":"PartnerName", "documentation":"

The name of the AWS Direct Connect service provider associated with the connection.

" }, "loaIssueTime":{ "shape":"LoaIssueTime", "documentation":"

The time of the most recent call to DescribeConnectionLoa for this Connection.

" } }, "documentation":"

A connection represents the physical network connection between the AWS Direct Connect location and the customer.

" }, "ConnectionId":{ "type":"string", "documentation":"

ID of the connection.

Example: dxcon-fg5678gh

Default: None

" }, "ConnectionList":{ "type":"list", "member":{"shape":"Connection"}, "documentation":"

A list of connections.

" }, "ConnectionName":{ "type":"string", "documentation":"

The name of the connection.

Example: \"My Connection to AWS\"

Default: None

" }, "ConnectionState":{ "type":"string", "documentation":"

State of the connection.

  • Ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

  • Requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

  • Pending: The connection has been approved, and is being initialized.

  • Available: The network link is up, and the connection is ready for use.

  • Down: The network link is down.

  • Deleting: The connection is in the process of being deleted.

  • Deleted: The connection has been deleted.

  • Rejected: A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

", "enum":[ "ordering", "requested", "pending", "available", "down", "deleting", "deleted", "rejected" ] }, "Connections":{ "type":"structure", "members":{ "connections":{ "shape":"ConnectionList", "documentation":"

A list of connections.

" } }, "documentation":"

A structure containing a list of connections.

" }, "CreateBGPPeerRequest":{ "type":"structure", "members":{ "virtualInterfaceId":{ "shape":"VirtualInterfaceId", "documentation":"

The ID of the virtual interface on which the BGP peer will be provisioned.

Example: dxvif-456abc78

Default: None

" }, "newBGPPeer":{ "shape":"NewBGPPeer", "documentation":"

Detailed information for the BGP peer to be created.

Default: None

" } }, "documentation":"

Container for the parameters to the CreateBGPPeer operation.

" }, "CreateBGPPeerResponse":{ "type":"structure", "members":{ "virtualInterface":{"shape":"VirtualInterface"} }, "documentation":"

The response received when CreateBGPPeer is called.

" }, "CreateConnectionRequest":{ "type":"structure", "required":[ "location", "bandwidth", "connectionName" ], "members":{ "location":{"shape":"LocationCode"}, "bandwidth":{"shape":"Bandwidth"}, "connectionName":{"shape":"ConnectionName"} }, "documentation":"

Container for the parameters to the CreateConnection operation.

" }, "CreateInterconnectRequest":{ "type":"structure", "required":[ "interconnectName", "bandwidth", "location" ], "members":{ "interconnectName":{ "shape":"InterconnectName", "documentation":"

The name of the interconnect.

Example: \"1G Interconnect to AWS\"

Default: None

" }, "bandwidth":{ "shape":"Bandwidth", "documentation":"

The port bandwidth

Example: 1Gbps

Default: None

Available values: 1Gbps,10Gbps

" }, "location":{ "shape":"LocationCode", "documentation":"

Where the interconnect is located

Example: EqSV5

Default: None

" } }, "documentation":"

Container for the parameters to the CreateInterconnect operation.

" }, "CreatePrivateVirtualInterfaceRequest":{ "type":"structure", "required":[ "connectionId", "newPrivateVirtualInterface" ], "members":{ "connectionId":{"shape":"ConnectionId"}, "newPrivateVirtualInterface":{ "shape":"NewPrivateVirtualInterface", "documentation":"

Detailed information for the private virtual interface to be created.

Default: None

" } }, "documentation":"

Container for the parameters to the CreatePrivateVirtualInterface operation.

" }, "CreatePublicVirtualInterfaceRequest":{ "type":"structure", "required":[ "connectionId", "newPublicVirtualInterface" ], "members":{ "connectionId":{"shape":"ConnectionId"}, "newPublicVirtualInterface":{ "shape":"NewPublicVirtualInterface", "documentation":"

Detailed information for the public virtual interface to be created.

Default: None

" } }, "documentation":"

Container for the parameters to the CreatePublicVirtualInterface operation.

" }, "CustomerAddress":{ "type":"string", "documentation":"

IP address assigned to the customer interface.

Example: 192.168.1.2/30 or 2001:db8::2/125

" }, "DeleteBGPPeerRequest":{ "type":"structure", "members":{ "virtualInterfaceId":{ "shape":"VirtualInterfaceId", "documentation":"

The ID of the virtual interface from which the BGP peer will be deleted.

Example: dxvif-456abc78

Default: None

" }, "asn":{"shape":"ASN"}, "customerAddress":{"shape":"CustomerAddress"} }, "documentation":"

Container for the parameters to the DeleteBGPPeer operation.

" }, "DeleteBGPPeerResponse":{ "type":"structure", "members":{ "virtualInterface":{"shape":"VirtualInterface"} }, "documentation":"

The response received when DeleteBGPPeer is called.

" }, "DeleteConnectionRequest":{ "type":"structure", "required":["connectionId"], "members":{ "connectionId":{"shape":"ConnectionId"} }, "documentation":"

Container for the parameters to the DeleteConnection operation.

" }, "DeleteInterconnectRequest":{ "type":"structure", "required":["interconnectId"], "members":{ "interconnectId":{"shape":"InterconnectId"} }, "documentation":"

Container for the parameters to the DeleteInterconnect operation.

" }, "DeleteInterconnectResponse":{ "type":"structure", "members":{ "interconnectState":{"shape":"InterconnectState"} }, "documentation":"

The response received when DeleteInterconnect is called.

" }, "DeleteVirtualInterfaceRequest":{ "type":"structure", "required":["virtualInterfaceId"], "members":{ "virtualInterfaceId":{"shape":"VirtualInterfaceId"} }, "documentation":"

Container for the parameters to the DeleteVirtualInterface operation.

" }, "DeleteVirtualInterfaceResponse":{ "type":"structure", "members":{ "virtualInterfaceState":{"shape":"VirtualInterfaceState"} }, "documentation":"

The response received when DeleteVirtualInterface is called.

" }, "DescribeConnectionLoaRequest":{ "type":"structure", "required":["connectionId"], "members":{ "connectionId":{"shape":"ConnectionId"}, "providerName":{ "shape":"ProviderName", "documentation":"

The name of the APN partner or service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

Default: None

" }, "loaContentType":{"shape":"LoaContentType"} }, "documentation":"

Container for the parameters to the DescribeConnectionLoa operation.

" }, "DescribeConnectionLoaResponse":{ "type":"structure", "members":{ "loa":{"shape":"Loa"} }, "documentation":"

The response received when DescribeConnectionLoa is called.

" }, "DescribeConnectionsOnInterconnectRequest":{ "type":"structure", "required":["interconnectId"], "members":{ "interconnectId":{ "shape":"InterconnectId", "documentation":"

ID of the interconnect on which a list of connection is provisioned.

Example: dxcon-abc123

Default: None

" } }, "documentation":"

Container for the parameters to the DescribeConnectionsOnInterconnect operation.

" }, "DescribeConnectionsRequest":{ "type":"structure", "members":{ "connectionId":{"shape":"ConnectionId"} }, "documentation":"

Container for the parameters to the DescribeConnections operation.

" }, "DescribeInterconnectLoaRequest":{ "type":"structure", "required":["interconnectId"], "members":{ "interconnectId":{"shape":"InterconnectId"}, "providerName":{ "shape":"ProviderName", "documentation":"

The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

Default: None

" }, "loaContentType":{"shape":"LoaContentType"} }, "documentation":"

Container for the parameters to the DescribeInterconnectLoa operation.

" }, "DescribeInterconnectLoaResponse":{ "type":"structure", "members":{ "loa":{"shape":"Loa"} }, "documentation":"

The response received when DescribeInterconnectLoa is called.

" }, "DescribeInterconnectsRequest":{ "type":"structure", "members":{ "interconnectId":{"shape":"InterconnectId"} }, "documentation":"

Container for the parameters to the DescribeInterconnects operation.

" }, "DescribeTagsRequest":{ "type":"structure", "required":["resourceArns"], "members":{ "resourceArns":{ "shape":"ResourceArnList", "documentation":"

The Amazon Resource Names (ARNs) of the Direct Connect resources.

" } }, "documentation":"

Container for the parameters to the DescribeTags operation.

" }, "DescribeTagsResponse":{ "type":"structure", "members":{ "resourceTags":{ "shape":"ResourceTagList", "documentation":"

Information about the tags.

" } }, "documentation":"

The response received when DescribeTags is called.

" }, "DescribeVirtualInterfacesRequest":{ "type":"structure", "members":{ "connectionId":{"shape":"ConnectionId"}, "virtualInterfaceId":{"shape":"VirtualInterfaceId"} }, "documentation":"

Container for the parameters to the DescribeVirtualInterfaces operation.

" }, "DirectConnectClientException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

This is an exception thrown when there is an issue with the input provided by the API call. For example, the name provided for a connection contains a pound sign (#). This can also occur when a valid value is provided, but is otherwise constrained. For example, the valid VLAN tag range is 1-4096 but each can only be used once per connection.

" } }, "documentation":"

The API was called with invalid parameters. The error message will contain additional details about the cause.

", "exception":true }, "DirectConnectServerException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

This is an exception thrown when there is a backend issue on the server side.

" } }, "documentation":"

A server-side error occurred during the API call. The error message will contain additional details about the cause.

", "exception":true }, "DuplicateTagKeysException":{ "type":"structure", "members":{ }, "documentation":"

A tag key was specified more than once.

", "exception":true }, "ErrorMessage":{"type":"string"}, "Interconnect":{ "type":"structure", "members":{ "interconnectId":{"shape":"InterconnectId"}, "interconnectName":{"shape":"InterconnectName"}, "interconnectState":{"shape":"InterconnectState"}, "region":{"shape":"Region"}, "location":{"shape":"LocationCode"}, "bandwidth":{"shape":"Bandwidth"}, "loaIssueTime":{ "shape":"LoaIssueTime", "documentation":"

The time of the most recent call to DescribeInterconnectLoa for this Interconnect.

" } }, "documentation":"

An interconnect is a connection that can host other connections.

Like a standard AWS Direct Connect connection, an interconnect represents the physical connection between an AWS Direct Connect partner's network and a specific Direct Connect 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.

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.

" }, "InterconnectId":{ "type":"string", "documentation":"

The ID of the interconnect.

Example: dxcon-abc123

" }, "InterconnectList":{ "type":"list", "member":{"shape":"Interconnect"}, "documentation":"

A list of interconnects.

" }, "InterconnectName":{ "type":"string", "documentation":"

The name of the interconnect.

Example: \"1G Interconnect to AWS\"

" }, "InterconnectState":{ "type":"string", "documentation":"

State of the interconnect.

  • Requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

  • Pending>: The interconnect has been approved, and is being initialized.

  • Available: The network link is up, and the interconnect is ready for use.

  • Down: The network link is down.

  • Deleting: The interconnect is in the process of being deleted.

  • Deleted: The interconnect has been deleted.

", "enum":[ "requested", "pending", "available", "down", "deleting", "deleted" ] }, "Interconnects":{ "type":"structure", "members":{ "interconnects":{ "shape":"InterconnectList", "documentation":"

A list of interconnects.

" } }, "documentation":"

A structure containing a list of interconnects.

" }, "Loa":{ "type":"structure", "members":{ "loaContent":{"shape":"LoaContent"}, "loaContentType":{"shape":"LoaContentType"} }, "documentation":"

A structure containing the Letter of Authorization - Connecting Facility Assignment (LOA-CFA) for a connection.

" }, "LoaContent":{ "type":"blob", "documentation":"

The binary contents of the LOA-CFA document.

" }, "LoaContentType":{ "type":"string", "documentation":"

A standard media type indicating the content type of the LOA-CFA document. Currently, the only supported value is \"application/pdf\".

Default: application/pdf

", "enum":["application/pdf"] }, "LoaIssueTime":{"type":"timestamp"}, "Location":{ "type":"structure", "members":{ "locationCode":{ "shape":"LocationCode", "documentation":"

The code used to indicate the AWS Direct Connect location.

" }, "locationName":{ "shape":"LocationName", "documentation":"

The name of the AWS Direct Connect location. The name includes the colocation partner name and the physical site of the lit building.

" } }, "documentation":"

An AWS Direct Connect location where connections and interconnects can be requested.

" }, "LocationCode":{ "type":"string", "documentation":"

Where the connection is located.

Example: EqSV5

Default: None

" }, "LocationList":{ "type":"list", "member":{"shape":"Location"} }, "LocationName":{"type":"string"}, "Locations":{ "type":"structure", "members":{ "locations":{ "shape":"LocationList", "documentation":"

A list of colocation hubs where network providers have equipment. Most regions have multiple locations available.

" } }, "documentation":"

A location is a network facility where AWS Direct Connect routers are available to be connected. Generally, these are colocation hubs where many network providers have equipment, and where cross connects can be delivered. Locations include a name and facility code, and must be provided when creating a connection.

" }, "NewBGPPeer":{ "type":"structure", "members":{ "asn":{"shape":"ASN"}, "authKey":{"shape":"BGPAuthKey"}, "addressFamily":{"shape":"AddressFamily"}, "amazonAddress":{"shape":"AmazonAddress"}, "customerAddress":{"shape":"CustomerAddress"} }, "documentation":"

A structure containing information about a new BGP peer.

" }, "NewPrivateVirtualInterface":{ "type":"structure", "required":[ "virtualInterfaceName", "vlan", "asn", "virtualGatewayId" ], "members":{ "virtualInterfaceName":{"shape":"VirtualInterfaceName"}, "vlan":{"shape":"VLAN"}, "asn":{"shape":"ASN"}, "authKey":{"shape":"BGPAuthKey"}, "amazonAddress":{"shape":"AmazonAddress"}, "customerAddress":{"shape":"CustomerAddress"}, "addressFamily":{"shape":"AddressFamily"}, "virtualGatewayId":{"shape":"VirtualGatewayId"} }, "documentation":"

A structure containing information about a new private virtual interface.

" }, "NewPrivateVirtualInterfaceAllocation":{ "type":"structure", "required":[ "virtualInterfaceName", "vlan", "asn" ], "members":{ "virtualInterfaceName":{"shape":"VirtualInterfaceName"}, "vlan":{"shape":"VLAN"}, "asn":{"shape":"ASN"}, "authKey":{"shape":"BGPAuthKey"}, "amazonAddress":{"shape":"AmazonAddress"}, "addressFamily":{"shape":"AddressFamily"}, "customerAddress":{"shape":"CustomerAddress"} }, "documentation":"

A structure containing information about a private virtual interface that will be provisioned on a connection.

" }, "NewPublicVirtualInterface":{ "type":"structure", "required":[ "virtualInterfaceName", "vlan", "asn" ], "members":{ "virtualInterfaceName":{"shape":"VirtualInterfaceName"}, "vlan":{"shape":"VLAN"}, "asn":{"shape":"ASN"}, "authKey":{"shape":"BGPAuthKey"}, "amazonAddress":{"shape":"AmazonAddress"}, "customerAddress":{"shape":"CustomerAddress"}, "addressFamily":{"shape":"AddressFamily"}, "routeFilterPrefixes":{"shape":"RouteFilterPrefixList"} }, "documentation":"

A structure containing information about a new public virtual interface.

" }, "NewPublicVirtualInterfaceAllocation":{ "type":"structure", "required":[ "virtualInterfaceName", "vlan", "asn" ], "members":{ "virtualInterfaceName":{"shape":"VirtualInterfaceName"}, "vlan":{"shape":"VLAN"}, "asn":{"shape":"ASN"}, "authKey":{"shape":"BGPAuthKey"}, "amazonAddress":{"shape":"AmazonAddress"}, "customerAddress":{"shape":"CustomerAddress"}, "addressFamily":{"shape":"AddressFamily"}, "routeFilterPrefixes":{"shape":"RouteFilterPrefixList"} }, "documentation":"

A structure containing information about a public virtual interface that will be provisioned on a connection.

" }, "OwnerAccount":{"type":"string"}, "PartnerName":{"type":"string"}, "ProviderName":{"type":"string"}, "Region":{ "type":"string", "documentation":"

The AWS region where the connection is located.

Example: us-east-1

Default: None

" }, "ResourceArn":{"type":"string"}, "ResourceArnList":{ "type":"list", "member":{"shape":"ResourceArn"} }, "ResourceTag":{ "type":"structure", "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"

The Amazon Resource Name (ARN) of the Direct Connect resource.

" }, "tags":{ "shape":"TagList", "documentation":"

The tags.

" } }, "documentation":"

The tags associated with a Direct Connect resource.

" }, "ResourceTagList":{ "type":"list", "member":{"shape":"ResourceTag"} }, "RouteFilterPrefix":{ "type":"structure", "members":{ "cidr":{ "shape":"CIDR", "documentation":"

CIDR notation for the advertised route. Multiple routes are separated by commas.

IPv6 CIDRs must be at least a /64 or shorter

Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

" } }, "documentation":"

A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

" }, "RouteFilterPrefixList":{ "type":"list", "member":{"shape":"RouteFilterPrefix"}, "documentation":"

A list of routes to be advertised to the AWS network in this region (public virtual interface).

" }, "RouterConfig":{"type":"string"}, "Tag":{ "type":"structure", "required":["key"], "members":{ "key":{ "shape":"TagKey", "documentation":"

The key of the tag.

" }, "value":{ "shape":"TagValue", "documentation":"

The value of the tag.

" } }, "documentation":"

Information about a tag.

" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"} }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "min":1 }, "TagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tags" ], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"

The Amazon Resource Name (ARN) of the Direct Connect resource.

Example: arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-fg5678gh

" }, "tags":{ "shape":"TagList", "documentation":"

The list of tags to add.

" } }, "documentation":"

Container for the parameters to the TagResource operation.

" }, "TagResourceResponse":{ "type":"structure", "members":{ }, "documentation":"

The response received when TagResource is called.

" }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TooManyTagsException":{ "type":"structure", "members":{ }, "documentation":"

You have reached the limit on the number of tags that can be assigned to a Direct Connect resource.

", "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "resourceArn", "tagKeys" ], "members":{ "resourceArn":{ "shape":"ResourceArn", "documentation":"

The Amazon Resource Name (ARN) of the Direct Connect resource.

" }, "tagKeys":{ "shape":"TagKeyList", "documentation":"

The list of tag keys to remove.

" } }, "documentation":"

Container for the parameters to the UntagResource operation.

" }, "UntagResourceResponse":{ "type":"structure", "members":{ }, "documentation":"

The response received when UntagResource is called.

" }, "VLAN":{ "type":"integer", "documentation":"

The VLAN ID.

Example: 101

" }, "VirtualGateway":{ "type":"structure", "members":{ "virtualGatewayId":{"shape":"VirtualGatewayId"}, "virtualGatewayState":{"shape":"VirtualGatewayState"} }, "documentation":"

You can create one or more AWS Direct Connect private virtual interfaces linking to your virtual private gateway.

Virtual private gateways can be managed using the Amazon Virtual Private Cloud (Amazon VPC) console or the Amazon EC2 CreateVpnGateway action.

" }, "VirtualGatewayId":{ "type":"string", "documentation":"

The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

Example: vgw-123er56

" }, "VirtualGatewayList":{ "type":"list", "member":{"shape":"VirtualGateway"}, "documentation":"

A list of virtual private gateways.

" }, "VirtualGatewayState":{ "type":"string", "documentation":"

State of the virtual private gateway.

  • Pending: This is the initial state after calling CreateVpnGateway.

  • Available: Ready for use by a private virtual interface.

  • Deleting: This is the initial state after calling DeleteVpnGateway.

  • Deleted: In this state, a private virtual interface is unable to send traffic over this gateway.

" }, "VirtualGateways":{ "type":"structure", "members":{ "virtualGateways":{ "shape":"VirtualGatewayList", "documentation":"

A list of virtual private gateways.

" } }, "documentation":"

A structure containing a list of virtual private gateways.

" }, "VirtualInterface":{ "type":"structure", "members":{ "ownerAccount":{ "shape":"OwnerAccount", "documentation":"

The AWS account that will own the new virtual interface.

" }, "virtualInterfaceId":{"shape":"VirtualInterfaceId"}, "location":{"shape":"LocationCode"}, "connectionId":{"shape":"ConnectionId"}, "virtualInterfaceType":{"shape":"VirtualInterfaceType"}, "virtualInterfaceName":{"shape":"VirtualInterfaceName"}, "vlan":{"shape":"VLAN"}, "asn":{"shape":"ASN"}, "authKey":{"shape":"BGPAuthKey"}, "amazonAddress":{"shape":"AmazonAddress"}, "customerAddress":{"shape":"CustomerAddress"}, "addressFamily":{"shape":"AddressFamily"}, "virtualInterfaceState":{"shape":"VirtualInterfaceState"}, "customerRouterConfig":{ "shape":"RouterConfig", "documentation":"

Information for generating the customer router configuration.

" }, "virtualGatewayId":{"shape":"VirtualGatewayId"}, "routeFilterPrefixes":{"shape":"RouteFilterPrefixList"}, "bgpPeers":{"shape":"BGPPeerList"} }, "documentation":"

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.

" }, "VirtualInterfaceId":{ "type":"string", "documentation":"

ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

" }, "VirtualInterfaceList":{ "type":"list", "member":{"shape":"VirtualInterface"}, "documentation":"

A list of virtual interfaces.

" }, "VirtualInterfaceName":{ "type":"string", "documentation":"

The name of the virtual interface assigned by the customer.

Example: \"My VPC\"

" }, "VirtualInterfaceState":{ "type":"string", "documentation":"

State of the virtual interface.

  • Confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

  • Verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

  • Pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

  • Available: A virtual interface that is able to forward traffic.

  • Down: A virtual interface that is BGP down.

  • Deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

  • Deleted: A virtual interface that cannot forward traffic.

  • Rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

", "enum":[ "confirming", "verifying", "pending", "available", "down", "deleting", "deleted", "rejected" ] }, "VirtualInterfaceType":{ "type":"string", "documentation":"

The type of virtual interface.

Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

" }, "VirtualInterfaces":{ "type":"structure", "members":{ "virtualInterfaces":{ "shape":"VirtualInterfaceList", "documentation":"

A list of virtual interfaces.

" } }, "documentation":"

A structure containing a list of virtual interfaces.

" } }, "documentation":"

AWS Direct Connect links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. With this connection in place, you can create virtual interfaces directly to the AWS cloud (for example, to Amazon Elastic Compute Cloud (Amazon EC2) and Amazon Simple Storage Service (Amazon S3)) and to Amazon Virtual Private Cloud (Amazon VPC), bypassing Internet service providers in your network path. An AWS Direct Connect location provides access to AWS in the region it is associated with, as well as access to other US regions. For example, you can provision a single connection to any AWS Direct Connect location in the US and use it to access public AWS services in all US Regions and AWS GovCloud (US).

" } botocore-1.5.7/botocore/data/dynamodb/0000777454262600001440000000000013042511307020730 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/dynamodb/2012-08-10/0000777454262600001440000000000013042511307021757 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/dynamodb/2012-08-10/waiters-2.json0000666454262600001440000000132713042511306024471 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "TableExists": { "delay": 20, "operation": "DescribeTable", "maxAttempts": 25, "acceptors": [ { "expected": "ACTIVE", "matcher": "path", "state": "success", "argument": "Table.TableStatus" }, { "expected": "ResourceNotFoundException", "matcher": "error", "state": "retry" } ] }, "TableNotExists": { "delay": 20, "operation": "DescribeTable", "maxAttempts": 25, "acceptors": [ { "expected": "ResourceNotFoundException", "matcher": "error", "state": "success" } ] } } } botocore-1.5.7/botocore/data/dynamodb/2012-08-10/paginators-1.json0000666454262600001440000000141613042511306025160 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListTables": { "input_token": "ExclusiveStartTableName", "output_token": "LastEvaluatedTableName", "limit_key": "Limit", "result_key": "TableNames" }, "Query": { "input_token": "ExclusiveStartKey", "output_token": "LastEvaluatedKey", "limit_key": "Limit", "result_key": [ "Items", "Count", "ScannedCount" ], "non_aggregate_keys": [ "ConsumedCapacity" ] }, "Scan": { "input_token": "ExclusiveStartKey", "output_token": "LastEvaluatedKey", "limit_key": "Limit", "result_key": [ "Items", "Count", "ScannedCount" ], "non_aggregate_keys": [ "ConsumedCapacity" ] } } } botocore-1.5.7/botocore/data/dynamodb/2012-08-10/service-2.json0000666454262600001440000066320613042511306024465 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2012-08-10", "endpointPrefix":"dynamodb", "jsonVersion":"1.0", "protocol":"json", "serviceAbbreviation":"DynamoDB", "serviceFullName":"Amazon DynamoDB", "signatureVersion":"v4", "targetPrefix":"DynamoDB_20120810", "uid":"dynamodb-2012-08-10" }, "operations":{ "BatchGetItem":{ "name":"BatchGetItem", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetItemInput"}, "output":{"shape":"BatchGetItemOutput"}, "errors":[ {"shape":"ProvisionedThroughputExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerError"} ], "documentation":"

The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.

A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys. You can use this value to retry the operation starting with the next item to get.

If you request more than 100 items BatchGetItem will return a ValidationException with the message \"Too many items requested for the BatchGetItem call\".

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem will return a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.

In order to minimize response latency, BatchGetItem retrieves items in parallel.

When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the ProjectionExpression parameter.

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 type of read. For more information, see Capacity Units Calculations in the Amazon DynamoDB Developer Guide.

" }, "BatchWriteItem":{ "name":"BatchWriteItem", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchWriteItemInput"}, "output":{"shape":"BatchWriteItemOutput"}, "errors":[ {"shape":"ProvisionedThroughputExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ItemCollectionSizeLimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB.

BatchWriteItem cannot update items. To update items, use the UpdateItem action.

The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.

Note that if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem will return a ProvisionedThroughputExceededException.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.

If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.

Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.

If one or more of the following is true, DynamoDB rejects the entire batch write operation:

  • One or more tables specified in the BatchWriteItem request does not exist.

  • Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.

  • You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.

  • There are more than 25 requests in the batch.

  • Any individual item in a batch exceeds 400 KB.

  • The total request size exceeds 16 MB.

" }, "CreateTable":{ "name":"CreateTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTableInput"}, "output":{"shape":"CreateTableOutput"}, "errors":[ {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

The CreateTable operation adds a new table to your account. In an AWS account, table 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.

CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.

You can optionally define secondary indexes on the new table, as part of the CreateTable operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.

You can use the DescribeTable action to check the table status.

" }, "DeleteItem":{ "name":"DeleteItem", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteItemInput"}, "output":{"shape":"DeleteItemOutput"}, "errors":[ {"shape":"ConditionalCheckFailedException"}, {"shape":"ProvisionedThroughputExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ItemCollectionSizeLimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

" }, "DeleteTable":{ "name":"DeleteTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTableInput"}, "output":{"shape":"DeleteTableOutput"}, "errors":[ {"shape":"ResourceInUseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.

DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.

When you delete a table, any indexes on that table are also deleted.

If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.

Use the DescribeTable action to check the status of the table.

" }, "DescribeLimits":{ "name":"DescribeLimits", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLimitsInput"}, "output":{"shape":"DescribeLimitsOutput"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Returns the current provisioned-capacity limits for your AWS account in a region, both for the region as a whole and for any one DynamoDB table that you create there.

When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given region. Also, there are per-table limits that apply when you create a table there. For more information, see Limits page in the Amazon DynamoDB Developer Guide.

Although you can increase these limits by filing a case at AWS Support Center, obtaining the increase is not instantaneous. The DescribeLimits action lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit.

For example, you could use one of the AWS SDKs to do the following:

  1. Call DescribeLimits for a particular region to obtain your current account limits on provisioned capacity there.

  2. Create a variable to hold the aggregate read capacity units provisioned for all your tables in that region, and one to hold the aggregate write capacity units. Zero them both.

  3. Call ListTables to obtain a list of all your DynamoDB tables.

  4. For each table name listed by ListTables, do the following:

    • Call DescribeTable with the table name.

    • Use the data returned by DescribeTable to add the read capacity units and write capacity units provisioned for the table itself to your variables.

    • If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.

  5. Report the account limits for that region returned by DescribeLimits, along with the total current provisioned capacity levels you have calculated.

This will let you see whether you are getting close to your account-level limits.

The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.

For existing tables and their GSIs, DynamoDB will not let you increase provisioned capacity extremely rapidly, but the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits.

DescribeLimits should only be called periodically. You can expect throttling errors if you call it more than once in a minute.

The DescribeLimits Request element has no content.

" }, "DescribeTable":{ "name":"DescribeTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTableInput"}, "output":{"shape":"DescribeTableOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.

" }, "GetItem":{ "name":"GetItem", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetItemInput"}, "output":{"shape":"GetItemOutput"}, "errors":[ {"shape":"ProvisionedThroughputExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerError"} ], "documentation":"

The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data and there will be no Item element in the response.

GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

" }, "ListTables":{ "name":"ListTables", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTablesInput"}, "output":{"shape":"ListTablesOutput"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names.

" }, "ListTagsOfResource":{ "name":"ListTagsOfResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsOfResourceInput"}, "output":{"shape":"ListTagsOfResourceOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerError"} ], "documentation":"

List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

" }, "PutItem":{ "name":"PutItem", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutItemInput"}, "output":{"shape":"PutItemOutput"}, "errors":[ {"shape":"ConditionalCheckFailedException"}, {"shape":"ProvisionedThroughputExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ItemCollectionSizeLimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values.

In addition to putting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a ValidationException exception.

To prevent a new item from replacing an existing item, use a conditional expression that contains the attribute_not_exists function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the attribute_not_exists function will only succeed if no matching item exists.

For more information about PutItem, see Working with Items in the Amazon DynamoDB Developer Guide.

" }, "Query":{ "name":"Query", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"QueryInput"}, "output":{"shape":"QueryOutput"}, "errors":[ {"shape":"ProvisionedThroughputExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerError"} ], "documentation":"

A Query operation uses the primary key of a table or a secondary index to directly access items from that table or index.

Use the KeyConditionExpression parameter to provide a specific value for the partition key. The Query operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. You can use the ScanIndexForward parameter to get results in forward or reverse order, by sort key.

Queries that do not return results consume the minimum number of read capacity units for that type of read operation.

If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and results are returned to the user with the LastEvaluatedKey element to continue the query in a subsequent operation. Unlike a Scan operation, a Query operation never returns both an empty result set and a LastEvaluatedKey value. LastEvaluatedKey is only provided if you have used the Limit parameter, or if the result set exceeds 1 MB (prior to applying a filter).

You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the ConsistentRead parameter to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index.

" }, "Scan":{ "name":"Scan", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ScanInput"}, "output":{"shape":"ScanOutput"}, "errors":[ {"shape":"ProvisionedThroughputExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerError"} ], "documentation":"

The Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a FilterExpression operation.

If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.

By default, Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.

By default, Scan uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the ConsistentRead parameter to true.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceInput"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerError"}, {"shape":"ResourceInUseException"} ], "documentation":"

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to 5 times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceInput"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerError"}, {"shape":"ResourceInUseException"} ], "documentation":"

Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to 5 times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

" }, "UpdateItem":{ "name":"UpdateItem", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateItemInput"}, "output":{"shape":"UpdateItemOutput"}, "errors":[ {"shape":"ConditionalCheckFailedException"}, {"shape":"ProvisionedThroughputExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ItemCollectionSizeLimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).

You can also return the item's attribute values in the same UpdateItem operation using the ReturnValues parameter.

" }, "UpdateTable":{ "name":"UpdateTable", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateTableInput"}, "output":{"shape":"UpdateTableOutput"}, "errors":[ {"shape":"ResourceInUseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"InternalServerError"} ], "documentation":"

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

You can only perform one of the following operations at once:

  • Modify the provisioned throughput settings of the table.

  • Enable or disable Streams on the table.

  • Remove a global secondary index from the table.

  • Create a new global secondary index on the table. Once the index begins backfilling, you can use UpdateTable to perform other operations.

UpdateTable is an asynchronous operation; while it is executing, the table status changes from ACTIVE to UPDATING. While it is UPDATING, you cannot issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.

" } }, "shapes":{ "AttributeAction":{ "type":"string", "enum":[ "ADD", "PUT", "DELETE" ] }, "AttributeDefinition":{ "type":"structure", "required":[ "AttributeName", "AttributeType" ], "members":{ "AttributeName":{ "shape":"KeySchemaAttributeName", "documentation":"

A name for the attribute.

" }, "AttributeType":{ "shape":"ScalarAttributeType", "documentation":"

The data type for the attribute, where:

  • S - the attribute is of type String

  • N - the attribute is of type Number

  • B - the attribute is of type Binary

" } }, "documentation":"

Represents an attribute for describing the key schema for the table and indexes.

" }, "AttributeDefinitions":{ "type":"list", "member":{"shape":"AttributeDefinition"} }, "AttributeMap":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValue"} }, "AttributeName":{ "type":"string", "max":65535 }, "AttributeNameList":{ "type":"list", "member":{"shape":"AttributeName"}, "min":1 }, "AttributeUpdates":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValueUpdate"} }, "AttributeValue":{ "type":"structure", "members":{ "S":{ "shape":"StringAttributeValue", "documentation":"

An attribute of type String. For example:

\"S\": \"Hello\"

" }, "N":{ "shape":"NumberAttributeValue", "documentation":"

An attribute of type Number. For example:

\"N\": \"123.45\"

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

" }, "B":{ "shape":"BinaryAttributeValue", "documentation":"

An attribute of type Binary. For example:

\"B\": \"dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk\"

" }, "SS":{ "shape":"StringSetAttributeValue", "documentation":"

An attribute of type String Set. For example:

\"SS\": [\"Giraffe\", \"Hippo\" ,\"Zebra\"]

" }, "NS":{ "shape":"NumberSetAttributeValue", "documentation":"

An attribute of type Number Set. For example:

\"NS\": [\"42.2\", \"-19\", \"7.5\", \"3.14\"]

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

" }, "BS":{ "shape":"BinarySetAttributeValue", "documentation":"

An attribute of type Binary Set. For example:

\"BS\": [\"U3Vubnk=\", \"UmFpbnk=\", \"U25vd3k=\"]

" }, "M":{ "shape":"MapAttributeValue", "documentation":"

An attribute of type Map. For example:

\"M\": {\"Name\": {\"S\": \"Joe\"}, \"Age\": {\"N\": \"35\"}}

" }, "L":{ "shape":"ListAttributeValue", "documentation":"

An attribute of type List. For example:

\"L\": [\"Cookies\", \"Coffee\", 3.14159]

" }, "NULL":{ "shape":"NullAttributeValue", "documentation":"

An attribute of type Null. For example:

\"NULL\": true

" }, "BOOL":{ "shape":"BooleanAttributeValue", "documentation":"

An attribute of type Boolean. For example:

\"BOOL\": true

" } }, "documentation":"

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

" }, "AttributeValueList":{ "type":"list", "member":{"shape":"AttributeValue"} }, "AttributeValueUpdate":{ "type":"structure", "members":{ "Value":{ "shape":"AttributeValue", "documentation":"

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data TYpes in the Amazon DynamoDB Developer Guide.

" }, "Action":{ "shape":"AttributeAction", "documentation":"

Specifies how to perform the update. Valid values are PUT (default), DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table.

If an item with the specified Key is found in the table:

  • PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.

  • DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.

    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error.

  • ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

    • If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

      If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

      In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

    • If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2], and the ADD action specified [3], then the final attribute value would be [1,2,3]. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.

      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.

    This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types.

If no item with the specified Key is found:

  • PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute.

  • DELETE - Nothing happens; there is no attribute to delete.

  • ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.

" } }, "documentation":"

For the UpdateItem operation, represents the attributes to be modified, the action to perform on each, and the new value for each.

You cannot use UpdateItem to update any primary key attributes. Instead, you will need to delete the item, and then use PutItem to create a new item with new attributes.

Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.

" }, "Backfilling":{"type":"boolean"}, "BatchGetItemInput":{ "type":"structure", "required":["RequestItems"], "members":{ "RequestItems":{ "shape":"BatchGetRequestMap", "documentation":"

A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per BatchGetItem request.

Each element in the map of items to retrieve consists of the following:

  • ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.

  • ExpressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter. The following are some use cases for using ExpressionAttributeNames:

    • To access an attribute whose name conflicts with a DynamoDB reserved word.

    • To create a placeholder for repeating occurrences of an attribute name in an expression.

    • To prevent special characters in an attribute name from being misinterpreted in an expression.

    Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

    • Percentile

    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

    • {\"#P\":\"Percentile\"}

    You could then use this substitution in an expression, as in this example:

    • #P = :val

    Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

    For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

  • Keys - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide both the partition key value and the sort key value.

  • ProjectionExpression - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

    If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

    For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

  • AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

" }, "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"} }, "documentation":"

Represents the input of a BatchGetItem operation.

" }, "BatchGetItemOutput":{ "type":"structure", "members":{ "Responses":{ "shape":"BatchGetResponseMap", "documentation":"

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.

" }, "UnprocessedKeys":{ "shape":"BatchGetRequestMap", "documentation":"

A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each element consists of:

  • Keys - An array of primary key attribute values that define specific items in the table.

  • ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.

  • ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.

" }, "ConsumedCapacity":{ "shape":"ConsumedCapacityMultiple", "documentation":"

The read capacity units consumed by the entire BatchGetItem operation.

Each element consists of:

  • TableName - The table that consumed the provisioned throughput.

  • CapacityUnits - The total number of capacity units consumed.

" } }, "documentation":"

Represents the output of a BatchGetItem operation.

" }, "BatchGetRequestMap":{ "type":"map", "key":{"shape":"TableName"}, "value":{"shape":"KeysAndAttributes"}, "max":100, "min":1 }, "BatchGetResponseMap":{ "type":"map", "key":{"shape":"TableName"}, "value":{"shape":"ItemList"} }, "BatchWriteItemInput":{ "type":"structure", "required":["RequestItems"], "members":{ "RequestItems":{ "shape":"BatchWriteItemRequestMap", "documentation":"

A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

  • DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

    • Key - A map of primary key attribute values that uniquely identify the ! item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

  • PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

    • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.

      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.

" }, "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, "ReturnItemCollectionMetrics":{ "shape":"ReturnItemCollectionMetrics", "documentation":"

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" } }, "documentation":"

Represents the input of a BatchWriteItem operation.

" }, "BatchWriteItemOutput":{ "type":"structure", "members":{ "UnprocessedItems":{ "shape":"BatchWriteItemRequestMap", "documentation":"

A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).

  • DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

    • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

  • PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

    • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.

      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.

If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.

" }, "ItemCollectionMetrics":{ "shape":"ItemCollectionMetricsPerTable", "documentation":"

A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.

Each entry consists of the following subelements:

  • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item.

  • SizeEstimateRange - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.

    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

" }, "ConsumedCapacity":{ "shape":"ConsumedCapacityMultiple", "documentation":"

The capacity units consumed by the entire BatchWriteItem operation.

Each element consists of:

  • TableName - The table that consumed the provisioned throughput.

  • CapacityUnits - The total number of capacity units consumed.

" } }, "documentation":"

Represents the output of a BatchWriteItem operation.

" }, "BatchWriteItemRequestMap":{ "type":"map", "key":{"shape":"TableName"}, "value":{"shape":"WriteRequests"}, "max":25, "min":1 }, "BinaryAttributeValue":{"type":"blob"}, "BinarySetAttributeValue":{ "type":"list", "member":{"shape":"BinaryAttributeValue"} }, "BooleanAttributeValue":{"type":"boolean"}, "BooleanObject":{"type":"boolean"}, "Capacity":{ "type":"structure", "members":{ "CapacityUnits":{ "shape":"ConsumedCapacityUnits", "documentation":"

The total number of capacity units consumed on a table or an index.

" } }, "documentation":"

Represents the amount of provisioned throughput capacity consumed on a table or an index.

" }, "ComparisonOperator":{ "type":"string", "enum":[ "EQ", "NE", "IN", "LE", "LT", "GE", "GT", "BETWEEN", "NOT_NULL", "NULL", "CONTAINS", "NOT_CONTAINS", "BEGINS_WITH" ] }, "Condition":{ "type":"structure", "required":["ComparisonOperator"], "members":{ "AttributeValueList":{ "shape":"AttributeValueList", "documentation":"

One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

For type Number, value comparisons are numeric.

String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

" }, "ComparisonOperator":{ "shape":"ComparisonOperator", "documentation":"

A comparator for evaluating attributes. For example, equals, greater than, less than, etc.

The following comparison operators are available:

EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

The following are descriptions of each comparison operator.

  • EQ : Equal. EQ is supported for all data types, including lists and maps.

    AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.

  • NE : Not equal. NE is supported for all data types, including lists and maps.

    AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.

  • LE : Less than or equal.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.

  • LT : Less than.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.

  • GE : Greater than or equal.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.

  • GT : Greater than.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.

  • NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

    This operator tests for the existence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute \"a\" exists; its data type is not relevant to the NOT_NULL comparison operator.

  • NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

    This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute \"a\" exists; its data type is not relevant to the NULL comparison operator.

  • CONTAINS : Checks for a subsequence, or value in a set.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.

    CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.

  • NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.

    NOT_CONTAINS is supported for lists: When evaluating \"a NOT CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.

  • BEGINS_WITH : Checks for a prefix.

    AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).

  • IN : Checks for matching elements in a list.

    AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.

  • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

    AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}

For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents the selection criteria for a Query or Scan operation:

  • For a Query operation, Condition is used for specifying the KeyConditions to use when querying a table or an index. For KeyConditions, only the following comparison operators are supported:

    EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN

    Condition is also used in a QueryFilter, which evaluates the query results and returns only the desired values.

  • For a Scan operation, Condition is used in a ScanFilter, which evaluates the scan results and returns only the desired values.

" }, "ConditionExpression":{"type":"string"}, "ConditionalCheckFailedException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The conditional request failed.

" } }, "documentation":"

A condition specified in the operation could not be evaluated.

", "exception":true }, "ConditionalOperator":{ "type":"string", "enum":[ "AND", "OR" ] }, "ConsistentRead":{"type":"boolean"}, "ConsumedCapacity":{ "type":"structure", "members":{ "TableName":{ "shape":"TableName", "documentation":"

The name of the table that was affected by the operation.

" }, "CapacityUnits":{ "shape":"ConsumedCapacityUnits", "documentation":"

The total number of capacity units consumed by the operation.

" }, "Table":{ "shape":"Capacity", "documentation":"

The amount of throughput consumed on the table affected by the operation.

" }, "LocalSecondaryIndexes":{ "shape":"SecondaryIndexesCapacityMap", "documentation":"

The amount of throughput consumed on each local index affected by the operation.

" }, "GlobalSecondaryIndexes":{ "shape":"SecondaryIndexesCapacityMap", "documentation":"

The amount of throughput consumed on each global index affected by the operation.

" } }, "documentation":"

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 the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" }, "ConsumedCapacityMultiple":{ "type":"list", "member":{"shape":"ConsumedCapacity"} }, "ConsumedCapacityUnits":{"type":"double"}, "CreateGlobalSecondaryIndexAction":{ "type":"structure", "required":[ "IndexName", "KeySchema", "Projection", "ProvisionedThroughput" ], "members":{ "IndexName":{ "shape":"IndexName", "documentation":"

The name of the global secondary index to be created.

" }, "KeySchema":{ "shape":"KeySchema", "documentation":"

The key schema for the global secondary index.

" }, "Projection":{ "shape":"Projection", "documentation":"

Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" }, "ProvisionedThroughput":{ "shape":"ProvisionedThroughput", "documentation":"

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents a new global secondary index to be added to an existing table.

" }, "CreateTableInput":{ "type":"structure", "required":[ "AttributeDefinitions", "TableName", "KeySchema", "ProvisionedThroughput" ], "members":{ "AttributeDefinitions":{ "shape":"AttributeDefinitions", "documentation":"

An array of attributes that describe the key schema for the table and indexes.

" }, "TableName":{ "shape":"TableName", "documentation":"

The name of the table to create.

" }, "KeySchema":{ "shape":"KeySchema", "documentation":"

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

  • AttributeName - The name of this key attribute.

  • KeyType - The role that the key attribute will assume:

    • HASH - partition key

    • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

For a composite primary key (partition key and sort key), you must provide 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.

For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.

" }, "LocalSecondaryIndexes":{ "shape":"LocalSecondaryIndexList", "documentation":"

One or more local secondary indexes (the maximum is five) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:

  • IndexName - The name of the local secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the 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.

" }, "GlobalSecondaryIndexes":{ "shape":"GlobalSecondaryIndexList", "documentation":"

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:

  • IndexName - The name of the global secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the global secondary index.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the 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.

  • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

" }, "ProvisionedThroughput":{ "shape":"ProvisionedThroughput", "documentation":"

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" }, "StreamSpecification":{ "shape":"StreamSpecification", "documentation":"

The settings for DynamoDB Streams on the table. These settings consist of:

  • StreamEnabled - Indicates whether Streams is to be enabled (true) or disabled (false).

  • StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:

    • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

    • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

    • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

    • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

" } }, "documentation":"

Represents the input of a CreateTable operation.

" }, "CreateTableOutput":{ "type":"structure", "members":{ "TableDescription":{ "shape":"TableDescription", "documentation":"

Represents the properties of the table.

" } }, "documentation":"

Represents the output of a CreateTable operation.

" }, "Date":{"type":"timestamp"}, "DeleteGlobalSecondaryIndexAction":{ "type":"structure", "required":["IndexName"], "members":{ "IndexName":{ "shape":"IndexName", "documentation":"

The name of the global secondary index to be deleted.

" } }, "documentation":"

Represents a global secondary index to be deleted from an existing table.

" }, "DeleteItemInput":{ "type":"structure", "required":[ "TableName", "Key" ], "members":{ "TableName":{ "shape":"TableName", "documentation":"

The name of the table from which to delete the item.

" }, "Key":{ "shape":"Key", "documentation":"

A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

" }, "Expected":{ "shape":"ExpectedAttributeMap", "documentation":"

This is a legacy parameter. Use ConditionExpresssion instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

" }, "ConditionalOperator":{ "shape":"ConditionalOperator", "documentation":"

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

" }, "ReturnValues":{ "shape":"ReturnValue", "documentation":"

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

  • ALL_OLD - The content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.

" }, "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, "ReturnItemCollectionMetrics":{ "shape":"ReturnItemCollectionMetrics", "documentation":"

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" }, "ConditionExpression":{ "shape":"ConditionExpression", "documentation":"

A condition that must be satisfied in order for a conditional DeleteItem to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

" }, "ExpressionAttributeNames":{ "shape":"ExpressionAttributeNameMap", "documentation":"

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {\"#P\":\"Percentile\"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" }, "ExpressionAttributeValues":{ "shape":"ExpressionAttributeValueMap", "documentation":"

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents the input of a DeleteItem operation.

" }, "DeleteItemOutput":{ "type":"structure", "members":{ "Attributes":{ "shape":"AttributeMap", "documentation":"

A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

" }, "ConsumedCapacity":{ "shape":"ConsumedCapacity", "documentation":"

The capacity units consumed by the DeleteItem 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 the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" }, "ItemCollectionMetrics":{ "shape":"ItemCollectionMetrics", "documentation":"

Information about item collections, if any, that were affected by the DeleteItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

  • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

  • SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

" } }, "documentation":"

Represents the output of a DeleteItem operation.

" }, "DeleteRequest":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"Key", "documentation":"

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.

" } }, "documentation":"

Represents a request to perform a DeleteItem operation on an item.

" }, "DeleteTableInput":{ "type":"structure", "required":["TableName"], "members":{ "TableName":{ "shape":"TableName", "documentation":"

The name of the table to delete.

" } }, "documentation":"

Represents the input of a DeleteTable operation.

" }, "DeleteTableOutput":{ "type":"structure", "members":{ "TableDescription":{ "shape":"TableDescription", "documentation":"

Represents the properties of a table.

" } }, "documentation":"

Represents the output of a DeleteTable operation.

" }, "DescribeLimitsInput":{ "type":"structure", "members":{ }, "documentation":"

Represents the input of a DescribeLimits operation. Has no content.

" }, "DescribeLimitsOutput":{ "type":"structure", "members":{ "AccountMaxReadCapacityUnits":{ "shape":"PositiveLongObject", "documentation":"

The maximum total read capacity units that your account allows you to provision across all of your tables in this region.

" }, "AccountMaxWriteCapacityUnits":{ "shape":"PositiveLongObject", "documentation":"

The maximum total write capacity units that your account allows you to provision across all of your tables in this region.

" }, "TableMaxReadCapacityUnits":{ "shape":"PositiveLongObject", "documentation":"

The maximum read capacity units that your account allows you to provision for a new table that you are creating in this region, including the read capacity units provisioned for its global secondary indexes (GSIs).

" }, "TableMaxWriteCapacityUnits":{ "shape":"PositiveLongObject", "documentation":"

The maximum write capacity units that your account allows you to provision for a new table that you are creating in this region, including the write capacity units provisioned for its global secondary indexes (GSIs).

" } }, "documentation":"

Represents the output of a DescribeLimits operation.

" }, "DescribeTableInput":{ "type":"structure", "required":["TableName"], "members":{ "TableName":{ "shape":"TableName", "documentation":"

The name of the table to describe.

" } }, "documentation":"

Represents the input of a DescribeTable operation.

" }, "DescribeTableOutput":{ "type":"structure", "members":{ "Table":{ "shape":"TableDescription", "documentation":"

The properties of the table.

" } }, "documentation":"

Represents the output of a DescribeTable operation.

" }, "ErrorMessage":{"type":"string"}, "ExpectedAttributeMap":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"ExpectedAttributeValue"} }, "ExpectedAttributeValue":{ "type":"structure", "members":{ "Value":{ "shape":"AttributeValue", "documentation":"

Represents the data for the expected attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

" }, "Exists":{ "shape":"BooleanObject", "documentation":"

Causes DynamoDB to evaluate the value before attempting a conditional operation:

  • If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionalCheckFailedException.

  • If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionalCheckFailedException.

The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

DynamoDB returns a ValidationException if:

  • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

  • Exists is false but you also provide a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

" }, "ComparisonOperator":{ "shape":"ComparisonOperator", "documentation":"

A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc.

The following comparison operators are available:

EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

The following are descriptions of each comparison operator.

  • EQ : Equal. EQ is supported for all data types, including lists and maps.

    AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.

  • NE : Not equal. NE is supported for all data types, including lists and maps.

    AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.

  • LE : Less than or equal.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.

  • LT : Less than.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.

  • GE : Greater than or equal.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.

  • GT : Greater than.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.

  • NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

    This operator tests for the existence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute \"a\" exists; its data type is not relevant to the NOT_NULL comparison operator.

  • NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

    This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute \"a\" exists; its data type is not relevant to the NULL comparison operator.

  • CONTAINS : Checks for a subsequence, or value in a set.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.

    CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.

  • NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.

    NOT_CONTAINS is supported for lists: When evaluating \"a NOT CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.

  • BEGINS_WITH : Checks for a prefix.

    AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).

  • IN : Checks for matching elements in a list.

    AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.

  • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

    AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}

" }, "AttributeValueList":{ "shape":"AttributeValueList", "documentation":"

One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

For type Number, value comparisons are numeric.

String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents a condition to be compared with an attribute value. This condition can be used with DeleteItem, PutItem or UpdateItem operations; if the comparison evaluates to true, the operation succeeds; if not, the operation fails. You can use ExpectedAttributeValue in one of two different ways:

  • Use AttributeValueList to specify one or more values to compare against an attribute. Use ComparisonOperator to specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds.

  • Use Value to specify a value that DynamoDB will compare against an attribute. If the values match, then ExpectedAttributeValue evaluates to true and the conditional operation succeeds. Optionally, you can also set Exists to false, indicating that you do not expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false.

Value and Exists are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.

" }, "ExpressionAttributeNameMap":{ "type":"map", "key":{"shape":"ExpressionAttributeNameVariable"}, "value":{"shape":"AttributeName"} }, "ExpressionAttributeNameVariable":{"type":"string"}, "ExpressionAttributeValueMap":{ "type":"map", "key":{"shape":"ExpressionAttributeValueVariable"}, "value":{"shape":"AttributeValue"} }, "ExpressionAttributeValueVariable":{"type":"string"}, "FilterConditionMap":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"Condition"} }, "GetItemInput":{ "type":"structure", "required":[ "TableName", "Key" ], "members":{ "TableName":{ "shape":"TableName", "documentation":"

The name of the table containing the requested item.

" }, "Key":{ "shape":"Key", "documentation":"

A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

" }, "AttributesToGet":{ "shape":"AttributeNameList", "documentation":"

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

" }, "ConsistentRead":{ "shape":"ConsistentRead", "documentation":"

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

" }, "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, "ProjectionExpression":{ "shape":"ProjectionExpression", "documentation":"

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" }, "ExpressionAttributeNames":{ "shape":"ExpressionAttributeNameMap", "documentation":"

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {\"#P\":\"Percentile\"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents the input of a GetItem operation.

" }, "GetItemOutput":{ "type":"structure", "members":{ "Item":{ "shape":"AttributeMap", "documentation":"

A map of attribute names to AttributeValue objects, as specified by ProjectionExpression.

" }, "ConsumedCapacity":{ "shape":"ConsumedCapacity", "documentation":"

The capacity units consumed by the GetItem 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 the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents the output of a GetItem operation.

" }, "GlobalSecondaryIndex":{ "type":"structure", "required":[ "IndexName", "KeySchema", "Projection", "ProvisionedThroughput" ], "members":{ "IndexName":{ "shape":"IndexName", "documentation":"

The name of the global secondary index. The name must be unique among all other indexes on this table.

" }, "KeySchema":{ "shape":"KeySchema", "documentation":"

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

" }, "Projection":{ "shape":"Projection", "documentation":"

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" }, "ProvisionedThroughput":{ "shape":"ProvisionedThroughput", "documentation":"

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents the properties of a global secondary index.

" }, "GlobalSecondaryIndexDescription":{ "type":"structure", "members":{ "IndexName":{ "shape":"IndexName", "documentation":"

The name of the global secondary index.

" }, "KeySchema":{ "shape":"KeySchema", "documentation":"

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

" }, "Projection":{ "shape":"Projection", "documentation":"

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" }, "IndexStatus":{ "shape":"IndexStatus", "documentation":"

The current state of the global secondary index:

  • CREATING - The index is being created.

  • UPDATING - The index is being updated.

  • DELETING - The index is being deleted.

  • ACTIVE - The index is ready for use.

" }, "Backfilling":{ "shape":"Backfilling", "documentation":"

Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.

" }, "ProvisionedThroughput":{ "shape":"ProvisionedThroughputDescription", "documentation":"

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" }, "IndexSizeBytes":{ "shape":"Long", "documentation":"

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" }, "ItemCount":{ "shape":"Long", "documentation":"

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" }, "IndexArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies the index.

" } }, "documentation":"

Represents the properties of a global secondary index.

" }, "GlobalSecondaryIndexDescriptionList":{ "type":"list", "member":{"shape":"GlobalSecondaryIndexDescription"} }, "GlobalSecondaryIndexList":{ "type":"list", "member":{"shape":"GlobalSecondaryIndex"} }, "GlobalSecondaryIndexUpdate":{ "type":"structure", "members":{ "Update":{ "shape":"UpdateGlobalSecondaryIndexAction", "documentation":"

The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

" }, "Create":{ "shape":"CreateGlobalSecondaryIndexAction", "documentation":"

The parameters required for creating a global secondary index on an existing table:

  • IndexName

  • KeySchema

  • AttributeDefinitions

  • Projection

  • ProvisionedThroughput

" }, "Delete":{ "shape":"DeleteGlobalSecondaryIndexAction", "documentation":"

The name of an existing global secondary index to be removed.

" } }, "documentation":"

Represents one of the following:

  • A new global secondary index to be added to an existing table.

  • New provisioned throughput parameters for an existing global secondary index.

  • An existing global secondary index to be removed from an existing table.

" }, "GlobalSecondaryIndexUpdateList":{ "type":"list", "member":{"shape":"GlobalSecondaryIndexUpdate"} }, "IndexName":{ "type":"string", "max":255, "min":3, "pattern":"[a-zA-Z0-9_.-]+" }, "IndexStatus":{ "type":"string", "enum":[ "CREATING", "UPDATING", "DELETING", "ACTIVE" ] }, "Integer":{"type":"integer"}, "InternalServerError":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The server encountered an internal error trying to fulfill the request.

" } }, "documentation":"

An error occurred on the server side.

", "exception":true, "fault":true }, "ItemCollectionKeyAttributeMap":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValue"} }, "ItemCollectionMetrics":{ "type":"structure", "members":{ "ItemCollectionKey":{ "shape":"ItemCollectionKeyAttributeMap", "documentation":"

The partition key value of the item collection. This value is the same as the partition key value of the item.

" }, "SizeEstimateRangeGB":{ "shape":"ItemCollectionSizeEstimateRange", "documentation":"

An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

" } }, "documentation":"

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.

" }, "ItemCollectionMetricsMultiple":{ "type":"list", "member":{"shape":"ItemCollectionMetrics"} }, "ItemCollectionMetricsPerTable":{ "type":"map", "key":{"shape":"TableName"}, "value":{"shape":"ItemCollectionMetricsMultiple"} }, "ItemCollectionSizeEstimateBound":{"type":"double"}, "ItemCollectionSizeEstimateRange":{ "type":"list", "member":{"shape":"ItemCollectionSizeEstimateBound"} }, "ItemCollectionSizeLimitExceededException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The total size of an item collection has exceeded the maximum limit of 10 gigabytes.

" } }, "documentation":"

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

", "exception":true }, "ItemList":{ "type":"list", "member":{"shape":"AttributeMap"} }, "Key":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValue"} }, "KeyConditions":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"Condition"} }, "KeyExpression":{"type":"string"}, "KeyList":{ "type":"list", "member":{"shape":"Key"}, "max":100, "min":1 }, "KeySchema":{ "type":"list", "member":{"shape":"KeySchemaElement"}, "max":2, "min":1 }, "KeySchemaAttributeName":{ "type":"string", "max":255, "min":1 }, "KeySchemaElement":{ "type":"structure", "required":[ "AttributeName", "KeyType" ], "members":{ "AttributeName":{ "shape":"KeySchemaAttributeName", "documentation":"

The name of a key attribute.

" }, "KeyType":{ "shape":"KeyType", "documentation":"

The role that this key attribute will assume:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

" } }, "documentation":"

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.

A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.

A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.

" }, "KeyType":{ "type":"string", "enum":[ "HASH", "RANGE" ] }, "KeysAndAttributes":{ "type":"structure", "required":["Keys"], "members":{ "Keys":{ "shape":"KeyList", "documentation":"

The primary key attribute values that define the items and the attributes associated with the items.

" }, "AttributesToGet":{ "shape":"AttributeNameList", "documentation":"

This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

" }, "ConsistentRead":{ "shape":"ConsistentRead", "documentation":"

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

" }, "ProjectionExpression":{ "shape":"ProjectionExpression", "documentation":"

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" }, "ExpressionAttributeNames":{ "shape":"ExpressionAttributeNameMap", "documentation":"

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {\"#P\":\"Percentile\"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents a set of primary keys and, for each key, the attributes to retrieve from the table.

For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key. For a composite primary key, you must provide both the partition key and the sort key.

" }, "LimitExceededException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Too many operations for a given subscriber.

" } }, "documentation":"

The number of concurrent table requests (cumulative number of tables in the CREATING, DELETING or UPDATING state) exceeds the maximum allowed of 10.

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.

The total limit of tables in the ACTIVE state is 250.

", "exception":true }, "ListAttributeValue":{ "type":"list", "member":{"shape":"AttributeValue"} }, "ListTablesInput":{ "type":"structure", "members":{ "ExclusiveStartTableName":{ "shape":"TableName", "documentation":"

The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.

" }, "Limit":{ "shape":"ListTablesInputLimit", "documentation":"

A maximum number of table names to return. If this parameter is not specified, the limit is 100.

" } }, "documentation":"

Represents the input of a ListTables operation.

" }, "ListTablesInputLimit":{ "type":"integer", "max":100, "min":1 }, "ListTablesOutput":{ "type":"structure", "members":{ "TableNames":{ "shape":"TableNameList", "documentation":"

The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.

If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.

" }, "LastEvaluatedTableName":{ "shape":"TableName", "documentation":"

The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned.

If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.

" } }, "documentation":"

Represents the output of a ListTables operation.

" }, "ListTagsOfResourceInput":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"ResourceArnString", "documentation":"

The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

" }, "NextToken":{ "shape":"NextTokenString", "documentation":"

An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource. When provided in this manner, this API fetches the next page of results.

" } } }, "ListTagsOfResourceOutput":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"

The tags currently associated with the Amazon DynamoDB resource.

" }, "NextToken":{ "shape":"NextTokenString", "documentation":"

If this value is returned, there are additional results to be displayed. To retrieve them, call ListTagsOfResource again, with NextToken set to this value.

" } } }, "LocalSecondaryIndex":{ "type":"structure", "required":[ "IndexName", "KeySchema", "Projection" ], "members":{ "IndexName":{ "shape":"IndexName", "documentation":"

The name of the local secondary index. The name must be unique among all other indexes on this table.

" }, "KeySchema":{ "shape":"KeySchema", "documentation":"

The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

" }, "Projection":{ "shape":"Projection", "documentation":"

Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" } }, "documentation":"

Represents the properties of a local secondary index.

" }, "LocalSecondaryIndexDescription":{ "type":"structure", "members":{ "IndexName":{ "shape":"IndexName", "documentation":"

Represents the name of the local secondary index.

" }, "KeySchema":{ "shape":"KeySchema", "documentation":"

The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

" }, "Projection":{ "shape":"Projection", "documentation":"

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" }, "IndexSizeBytes":{ "shape":"Long", "documentation":"

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" }, "ItemCount":{ "shape":"Long", "documentation":"

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" }, "IndexArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies the index.

" } }, "documentation":"

Represents the properties of a local secondary index.

" }, "LocalSecondaryIndexDescriptionList":{ "type":"list", "member":{"shape":"LocalSecondaryIndexDescription"} }, "LocalSecondaryIndexList":{ "type":"list", "member":{"shape":"LocalSecondaryIndex"} }, "Long":{"type":"long"}, "MapAttributeValue":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValue"} }, "NextTokenString":{"type":"string"}, "NonKeyAttributeName":{ "type":"string", "max":255, "min":1 }, "NonKeyAttributeNameList":{ "type":"list", "member":{"shape":"NonKeyAttributeName"}, "max":20, "min":1 }, "NullAttributeValue":{"type":"boolean"}, "NumberAttributeValue":{"type":"string"}, "NumberSetAttributeValue":{ "type":"list", "member":{"shape":"NumberAttributeValue"} }, "PositiveIntegerObject":{ "type":"integer", "min":1 }, "PositiveLongObject":{ "type":"long", "min":1 }, "Projection":{ "type":"structure", "members":{ "ProjectionType":{ "shape":"ProjectionType", "documentation":"

The set of attributes that are projected into the index:

  • KEYS_ONLY - Only the index and primary keys are projected into the index.

  • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

  • ALL - All of the table attributes are projected into the index.

" }, "NonKeyAttributes":{ "shape":"NonKeyAttributeNameList", "documentation":"

Represents the non-key attribute names which will be projected into the index.

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.

" } }, "documentation":"

Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" }, "ProjectionExpression":{"type":"string"}, "ProjectionType":{ "type":"string", "enum":[ "ALL", "KEYS_ONLY", "INCLUDE" ] }, "ProvisionedThroughput":{ "type":"structure", "required":[ "ReadCapacityUnits", "WriteCapacityUnits" ], "members":{ "ReadCapacityUnits":{ "shape":"PositiveLongObject", "documentation":"

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

" }, "WriteCapacityUnits":{ "shape":"PositiveLongObject", "documentation":"

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" }, "ProvisionedThroughputDescription":{ "type":"structure", "members":{ "LastIncreaseDateTime":{ "shape":"Date", "documentation":"

The date and time of the last provisioned throughput increase for this table.

" }, "LastDecreaseDateTime":{ "shape":"Date", "documentation":"

The date and time of the last provisioned throughput decrease for this table.

" }, "NumberOfDecreasesToday":{ "shape":"PositiveLongObject", "documentation":"

The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

" }, "ReadCapacityUnits":{ "shape":"PositiveLongObject", "documentation":"

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

" }, "WriteCapacityUnits":{ "shape":"PositiveLongObject", "documentation":"

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

" } }, "documentation":"

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

" }, "ProvisionedThroughputExceededException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

You exceeded your maximum allowed provisioned throughput.

" } }, "documentation":"

Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

", "exception":true }, "PutItemInput":{ "type":"structure", "required":[ "TableName", "Item" ], "members":{ "TableName":{ "shape":"TableName", "documentation":"

The name of the table to contain the item.

" }, "Item":{ "shape":"PutItemInputAttributeMap", "documentation":"

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

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.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

" }, "Expected":{ "shape":"ExpectedAttributeMap", "documentation":"

This is a legacy parameter. Use ConditionExpresssion instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

" }, "ReturnValues":{ "shape":"ReturnValue", "documentation":"

Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

  • ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.

" }, "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, "ReturnItemCollectionMetrics":{ "shape":"ReturnItemCollectionMetrics", "documentation":"

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" }, "ConditionalOperator":{ "shape":"ConditionalOperator", "documentation":"

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

" }, "ConditionExpression":{ "shape":"ConditionExpression", "documentation":"

A condition that must be satisfied in order for a conditional PutItem operation to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

" }, "ExpressionAttributeNames":{ "shape":"ExpressionAttributeNameMap", "documentation":"

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {\"#P\":\"Percentile\"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" }, "ExpressionAttributeValues":{ "shape":"ExpressionAttributeValueMap", "documentation":"

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents the input of a PutItem operation.

" }, "PutItemInputAttributeMap":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValue"} }, "PutItemOutput":{ "type":"structure", "members":{ "Attributes":{ "shape":"AttributeMap", "documentation":"

The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.

" }, "ConsumedCapacity":{ "shape":"ConsumedCapacity", "documentation":"

The capacity units consumed by the PutItem 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 the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" }, "ItemCollectionMetrics":{ "shape":"ItemCollectionMetrics", "documentation":"

Information about item collections, if any, that were affected by the PutItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

  • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

  • SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

" } }, "documentation":"

Represents the output of a PutItem operation.

" }, "PutRequest":{ "type":"structure", "required":["Item"], "members":{ "Item":{ "shape":"PutItemInputAttributeMap", "documentation":"

A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema.

" } }, "documentation":"

Represents a request to perform a PutItem operation on an item.

" }, "QueryInput":{ "type":"structure", "required":["TableName"], "members":{ "TableName":{ "shape":"TableName", "documentation":"

The name of the table containing the requested items.

" }, "IndexName":{ "shape":"IndexName", "documentation":"

The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the IndexName parameter, you must also provide TableName.

" }, "Select":{ "shape":"Select", "documentation":"

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

  • ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

  • ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.

  • COUNT - Returns the number of matching items, rather than the matching items themselves.

  • SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.

    If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.

" }, "AttributesToGet":{ "shape":"AttributeNameList", "documentation":"

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

" }, "Limit":{ "shape":"PositiveIntegerObject", "documentation":"

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.

" }, "ConsistentRead":{ "shape":"ConsistentRead", "documentation":"

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

" }, "KeyConditions":{ "shape":"KeyConditions", "documentation":"

This is a legacy parameter. Use KeyConditionExpression instead. For more information, see KeyConditions in the Amazon DynamoDB Developer Guide.

" }, "QueryFilter":{ "shape":"FilterConditionMap", "documentation":"

This is a legacy parameter. Use FilterExpression instead. For more information, see QueryFilter in the Amazon DynamoDB Developer Guide.

" }, "ConditionalOperator":{ "shape":"ConditionalOperator", "documentation":"

This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

" }, "ScanIndexForward":{ "shape":"BooleanObject", "documentation":"

Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order.

Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of ASCII character code values. For type Binary, DynamoDB treats each byte of the binary data as unsigned.

If ScanIndexForward is true, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If ScanIndexForward is false, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.

" }, "ExclusiveStartKey":{ "shape":"Key", "documentation":"

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

" }, "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, "ProjectionExpression":{ "shape":"ProjectionExpression", "documentation":"

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" }, "FilterExpression":{ "shape":"ConditionExpression", "documentation":"

A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression does not allow key attributes. You cannot define a filter expression based on a partition key or a sort key.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

" }, "KeyConditionExpression":{ "shape":"KeyExpression", "documentation":"

The condition that specifies the key value(s) for items to be retrieved by the Query action.

The condition must perform an equality test on a single partition key value. The condition can also perform one of several comparison tests on a single sort key value. Query can use KeyConditionExpression to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.

The partition key equality test is required, and must be specified in the following format:

partitionKeyName = :partitionkeyval

If you also want to provide a condition for the sort key, it must be combined using AND with the condition for the sort key. Following is an example, using the = comparison operator for the sort key:

partitionKeyName = :partitionkeyval AND sortKeyName = :sortkeyval

Valid comparisons for the sort key condition are as follows:

  • sortKeyName = :sortkeyval - true if the sort key value is equal to :sortkeyval.

  • sortKeyName < :sortkeyval - true if the sort key value is less than :sortkeyval.

  • sortKeyName <= :sortkeyval - true if the sort key value is less than or equal to :sortkeyval.

  • sortKeyName > :sortkeyval - true if the sort key value is greater than :sortkeyval.

  • sortKeyName >= :sortkeyval - true if the sort key value is greater than or equal to :sortkeyval.

  • sortKeyName BETWEEN :sortkeyval1 AND :sortkeyval2 - true if the sort key value is greater than or equal to :sortkeyval1, and less than or equal to :sortkeyval2.

  • begins_with ( sortKeyName, :sortkeyval ) - true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function name begins_with is case-sensitive.

Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval and :sortval with actual values at runtime.

You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word:

  • Size = :myval

To work around this, define a placeholder (such a #S) to represent the attribute name Size. KeyConditionExpression then is as follows:

  • #S = :myval

For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.

For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.

" }, "ExpressionAttributeNames":{ "shape":"ExpressionAttributeNameMap", "documentation":"

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {\"#P\":\"Percentile\"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" }, "ExpressionAttributeValues":{ "shape":"ExpressionAttributeValueMap", "documentation":"

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents the input of a Query operation.

" }, "QueryOutput":{ "type":"structure", "members":{ "Items":{ "shape":"ItemList", "documentation":"

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.

" }, "Count":{ "shape":"Integer", "documentation":"

The number of items in the response.

If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

If you did not use a filter in the request, then Count and ScannedCount are the same.

" }, "ScannedCount":{ "shape":"Integer", "documentation":"

The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

" }, "LastEvaluatedKey":{ "shape":"Key", "documentation":"

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it 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 empty.

" }, "ConsumedCapacity":{ "shape":"ConsumedCapacity", "documentation":"

The capacity units consumed by the Query 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 the ReturnConsumedCapacity parameter was specified For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents the output of a Query operation.

" }, "ResourceArnString":{ "type":"string", "max":1283, "min":1 }, "ResourceInUseException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The resource which is being attempted to be changed is in use.

" } }, "documentation":"

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The resource which is being requested does not exist.

" } }, "documentation":"

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

", "exception":true }, "ReturnConsumedCapacity":{ "type":"string", "documentation":"

Determines the level of detail about provisioned throughput consumption that is returned in the response:

  • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

  • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

  • NONE - No ConsumedCapacity details are included in the response.

", "enum":[ "INDEXES", "TOTAL", "NONE" ] }, "ReturnItemCollectionMetrics":{ "type":"string", "enum":[ "SIZE", "NONE" ] }, "ReturnValue":{ "type":"string", "enum":[ "NONE", "ALL_OLD", "UPDATED_OLD", "ALL_NEW", "UPDATED_NEW" ] }, "ScalarAttributeType":{ "type":"string", "enum":[ "S", "N", "B" ] }, "ScanInput":{ "type":"structure", "required":["TableName"], "members":{ "TableName":{ "shape":"TableName", "documentation":"

The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs.

" }, "IndexName":{ "shape":"IndexName", "documentation":"

The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.

" }, "AttributesToGet":{ "shape":"AttributeNameList", "documentation":"

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

" }, "Limit":{ "shape":"PositiveIntegerObject", "documentation":"

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed data set size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.

" }, "Select":{ "shape":"Select", "documentation":"

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

  • ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index DynamoDB will fetch the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

  • ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.

  • COUNT - Returns the number of matching items, rather than the matching items themselves.

  • SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.

    If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.

" }, "ScanFilter":{ "shape":"FilterConditionMap", "documentation":"

This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.

" }, "ConditionalOperator":{ "shape":"ConditionalOperator", "documentation":"

This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

" }, "ExclusiveStartKey":{ "shape":"Key", "documentation":"

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

" }, "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, "TotalSegments":{ "shape":"ScanTotalSegments", "documentation":"

For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.

The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.

If you specify TotalSegments, you must also specify Segment.

" }, "Segment":{ "shape":"ScanSegment", "documentation":"

For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.

Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.

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.

The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.

If you provide Segment, you must also provide TotalSegments.

" }, "ProjectionExpression":{ "shape":"ProjectionExpression", "documentation":"

A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" }, "FilterExpression":{ "shape":"ConditionExpression", "documentation":"

A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

" }, "ExpressionAttributeNames":{ "shape":"ExpressionAttributeNameMap", "documentation":"

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {\"#P\":\"Percentile\"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" }, "ExpressionAttributeValues":{ "shape":"ExpressionAttributeValueMap", "documentation":"

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

" }, "ConsistentRead":{ "shape":"ConsistentRead", "documentation":"

A Boolean value that determines the read consistency model during the scan:

  • If ConsistentRead is false, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem).

  • If ConsistentRead is true, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.

The default setting for ConsistentRead is false.

The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

" } }, "documentation":"

Represents the input of a Scan operation.

" }, "ScanOutput":{ "type":"structure", "members":{ "Items":{ "shape":"ItemList", "documentation":"

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.

" }, "Count":{ "shape":"Integer", "documentation":"

The number of items in the response.

If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

If you did not use a filter in the request, then Count is the same as ScannedCount.

" }, "ScannedCount":{ "shape":"Integer", "documentation":"

The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

" }, "LastEvaluatedKey":{ "shape":"Key", "documentation":"

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it 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 empty.

" }, "ConsumedCapacity":{ "shape":"ConsumedCapacity", "documentation":"

The capacity units consumed by the Scan 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 the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents the output of a Scan operation.

" }, "ScanSegment":{ "type":"integer", "max":999999, "min":0 }, "ScanTotalSegments":{ "type":"integer", "max":1000000, "min":1 }, "SecondaryIndexesCapacityMap":{ "type":"map", "key":{"shape":"IndexName"}, "value":{"shape":"Capacity"} }, "Select":{ "type":"string", "enum":[ "ALL_ATTRIBUTES", "ALL_PROJECTED_ATTRIBUTES", "SPECIFIC_ATTRIBUTES", "COUNT" ] }, "StreamArn":{ "type":"string", "max":1024, "min":37 }, "StreamEnabled":{"type":"boolean"}, "StreamSpecification":{ "type":"structure", "members":{ "StreamEnabled":{ "shape":"StreamEnabled", "documentation":"

Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

" }, "StreamViewType":{ "shape":"StreamViewType", "documentation":"

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

  • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

  • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

  • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

  • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

" } }, "documentation":"

Represents the DynamoDB Streams configuration for a table in DynamoDB.

" }, "StreamViewType":{ "type":"string", "enum":[ "NEW_IMAGE", "OLD_IMAGE", "NEW_AND_OLD_IMAGES", "KEYS_ONLY" ] }, "String":{"type":"string"}, "StringAttributeValue":{"type":"string"}, "StringSetAttributeValue":{ "type":"list", "member":{"shape":"StringAttributeValue"} }, "TableDescription":{ "type":"structure", "members":{ "AttributeDefinitions":{ "shape":"AttributeDefinitions", "documentation":"

An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

Each AttributeDefinition object in this array is composed of:

  • AttributeName - The name of the attribute.

  • AttributeType - The data type for the attribute.

" }, "TableName":{ "shape":"TableName", "documentation":"

The name of the table.

" }, "KeySchema":{ "shape":"KeySchema", "documentation":"

The primary key structure for the table. Each KeySchemaElement consists of:

  • AttributeName - The name of the attribute.

  • KeyType - The role of the attribute:

    • HASH - partition key

    • RANGE - sort key

    The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

    The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

" }, "TableStatus":{ "shape":"TableStatus", "documentation":"

The current state of the table:

  • CREATING - The table is being created.

  • UPDATING - The table is being updated.

  • DELETING - The table is being deleted.

  • ACTIVE - The table is ready for use.

" }, "CreationDateTime":{ "shape":"Date", "documentation":"

The date and time when the table was created, in UNIX epoch time format.

" }, "ProvisionedThroughput":{ "shape":"ProvisionedThroughputDescription", "documentation":"

The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

" }, "TableSizeBytes":{ "shape":"Long", "documentation":"

The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" }, "ItemCount":{ "shape":"Long", "documentation":"

The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" }, "TableArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies the table.

" }, "LocalSecondaryIndexes":{ "shape":"LocalSecondaryIndexDescriptionList", "documentation":"

Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

  • IndexName - The name of the local secondary index.

  • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the 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.

  • IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

  • ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

If the table is in the DELETING state, no information about indexes will be returned.

" }, "GlobalSecondaryIndexes":{ "shape":"GlobalSecondaryIndexDescriptionList", "documentation":"

The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

  • Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)

  • IndexName - The name of the global secondary index.

  • IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

  • IndexStatus - The current status of the global secondary index:

    • CREATING - The index is being created.

    • UPDATING - The index is being updated.

    • DELETING - The index is being deleted.

    • ACTIVE - The index is ready for use.

  • ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

  • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the 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.

  • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.

If the table is in the DELETING state, no information about indexes will be returned.

" }, "StreamSpecification":{ "shape":"StreamSpecification", "documentation":"

The current DynamoDB Streams configuration for the table.

" }, "LatestStreamLabel":{ "shape":"String", "documentation":"

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • the AWS customer ID.

  • the table name.

  • the StreamLabel.

" }, "LatestStreamArn":{ "shape":"StreamArn", "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

" } }, "documentation":"

Represents the properties of a table.

" }, "TableName":{ "type":"string", "max":255, "min":3, "pattern":"[a-zA-Z0-9_.-]+" }, "TableNameList":{ "type":"list", "member":{"shape":"TableName"} }, "TableStatus":{ "type":"string", "enum":[ "CREATING", "UPDATING", "DELETING", "ACTIVE" ] }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKeyString", "documentation":"

The key of the tag.Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

" }, "Value":{ "shape":"TagValueString", "documentation":"

The value of the tag. Tag values are case-sensitive and can be null.

" } }, "documentation":"

Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table.

AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

" }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKeyString"} }, "TagKeyString":{ "type":"string", "max":128, "min":1 }, "TagList":{ "type":"list", "member":{"shape":"Tag"} }, "TagResourceInput":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"ResourceArnString", "documentation":"

Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags to be assigned to the Amazon DynamoDB resource.

" } } }, "TagValueString":{ "type":"string", "max":256, "min":0 }, "UntagResourceInput":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"ResourceArnString", "documentation":"

The Amazon DyanamoDB resource the tags will be removed from. This value is an Amazon Resource Name (ARN).

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

A list of tag keys. Existing tags of the resource whose keys are members of this list will be removed from the Amazon DynamoDB resource.

" } } }, "UpdateExpression":{"type":"string"}, "UpdateGlobalSecondaryIndexAction":{ "type":"structure", "required":[ "IndexName", "ProvisionedThroughput" ], "members":{ "IndexName":{ "shape":"IndexName", "documentation":"

The name of the global secondary index to be updated.

" }, "ProvisionedThroughput":{ "shape":"ProvisionedThroughput", "documentation":"

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents the new provisioned throughput settings to be applied to a global secondary index.

" }, "UpdateItemInput":{ "type":"structure", "required":[ "TableName", "Key" ], "members":{ "TableName":{ "shape":"TableName", "documentation":"

The name of the table containing the item to update.

" }, "Key":{ "shape":"Key", "documentation":"

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

" }, "AttributeUpdates":{ "shape":"AttributeUpdates", "documentation":"

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

" }, "Expected":{ "shape":"ExpectedAttributeMap", "documentation":"

This is a legacy parameter. Use ConditionExpresssion instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

" }, "ConditionalOperator":{ "shape":"ConditionalOperator", "documentation":"

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

" }, "ReturnValues":{ "shape":"ReturnValue", "documentation":"

Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:

  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

  • ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.

  • UPDATED_OLD - The old versions of only the updated attributes are returned.

  • ALL_NEW - All of the attributes of the new version of the item are returned.

  • UPDATED_NEW - The new versions of only the updated attributes are returned.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.

Values returned are strongly consistent

" }, "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, "ReturnItemCollectionMetrics":{ "shape":"ReturnItemCollectionMetrics", "documentation":"

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" }, "UpdateExpression":{ "shape":"UpdateExpression", "documentation":"

An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.

The following action values are available for UpdateExpression.

  • SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val

    SET supports the following functions:

    • if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.

    • list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.

    These function names are case-sensitive.

  • REMOVE - Removes one or more attributes from an item.

  • ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

    • If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

      If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

      Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

    • If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.

      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.

    The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.

  • DELETE - Deletes an element from a set.

    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.

    The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes.

You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

" }, "ConditionExpression":{ "shape":"ConditionExpression", "documentation":"

A condition that must be satisfied in order for a conditional update to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

" }, "ExpressionAttributeNames":{ "shape":"ExpressionAttributeNameMap", "documentation":"

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {\"#P\":\"Percentile\"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" }, "ExpressionAttributeValues":{ "shape":"ExpressionAttributeValueMap", "documentation":"

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

" } }, "documentation":"

Represents the input of an UpdateItem operation.

" }, "UpdateItemOutput":{ "type":"structure", "members":{ "Attributes":{ "shape":"AttributeMap", "documentation":"

A map of attribute values as they appeared before the UpdateItem operation. This map only appears if ReturnValues was specified as something other than NONE in the request. Each element represents one attribute.

" }, "ConsumedCapacity":{ "shape":"ConsumedCapacity", "documentation":"

The capacity units consumed by the UpdateItem 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 the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" }, "ItemCollectionMetrics":{ "shape":"ItemCollectionMetrics", "documentation":"

Information about item collections, if any, that were affected by the UpdateItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

  • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

  • SizeEstimateRange - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

" } }, "documentation":"

Represents the output of an UpdateItem operation.

" }, "UpdateTableInput":{ "type":"structure", "required":["TableName"], "members":{ "AttributeDefinitions":{ "shape":"AttributeDefinitions", "documentation":"

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

" }, "TableName":{ "shape":"TableName", "documentation":"

The name of the table to be updated.

" }, "ProvisionedThroughput":{ "shape":"ProvisionedThroughput", "documentation":"

The new provisioned throughput settings for the specified table or index.

" }, "GlobalSecondaryIndexUpdates":{ "shape":"GlobalSecondaryIndexUpdateList", "documentation":"

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

  • Create - add a new global secondary index to the table.

  • Update - modify the provisioned throughput settings of an existing global secondary index.

  • Delete - remove a global secondary index from the table.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

" }, "StreamSpecification":{ "shape":"StreamSpecification", "documentation":"

Represents the DynamoDB Streams configuration for the table.

You will receive a ResourceInUseException if you attempt to enable a stream on a table that already has a stream, or if you attempt to disable a stream on a table which does not have a stream.

" } }, "documentation":"

Represents the input of an UpdateTable operation.

" }, "UpdateTableOutput":{ "type":"structure", "members":{ "TableDescription":{ "shape":"TableDescription", "documentation":"

Represents the properties of the table.

" } }, "documentation":"

Represents the output of an UpdateTable operation.

" }, "WriteRequest":{ "type":"structure", "members":{ "PutRequest":{ "shape":"PutRequest", "documentation":"

A request to perform a PutItem operation.

" }, "DeleteRequest":{ "shape":"DeleteRequest", "documentation":"

A request to perform a DeleteItem operation.

" } }, "documentation":"

Represents an operation to perform - either DeleteItem or PutItem. You can only request one of these operations, not both, in a single WriteRequest. If you do need to perform both of these operations, you will need to provide two separate WriteRequest objects.

" }, "WriteRequests":{ "type":"list", "member":{"shape":"WriteRequest"}, "max":25, "min":1 } }, "documentation":"Amazon DynamoDB

Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.

With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the AWS Management Console to monitor resource utilization and performance metrics.

DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an AWS region, providing built-in high availability and data durability.

" } botocore-1.5.7/botocore/data/route53domains/0000777454262600001440000000000013042511307022014 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/route53domains/2014-05-15/0000777454262600001440000000000013042511307023047 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/route53domains/2014-05-15/paginators-1.json0000666454262600001440000000056313042511306026252 0ustar pysdk-ciamazon00000000000000{ "version": "1.0", "pagination": { "ListDomains": { "limit_key": "MaxItems", "input_token": "Marker", "output_token": "NextPageMarker", "result_key": "Domains" }, "ListOperations": { "limit_key": "MaxItems", "input_token": "Marker", "output_token": "NextPageMarker", "result_key": "Operations" } } } botocore-1.5.7/botocore/data/route53domains/2014-05-15/service-2.json0000666454262600001440000025637513042511306025562 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"route53domains-2014-05-15", "apiVersion":"2014-05-15", "endpointPrefix":"route53domains", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Amazon Route 53 Domains", "signatureVersion":"v4", "targetPrefix":"Route53Domains_v20140515" }, "operations":{ "CheckDomainAvailability":{ "name":"CheckDomainAvailability", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CheckDomainAvailabilityRequest"}, "output":{"shape":"CheckDomainAvailabilityResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"UnsupportedTLD"} ], "documentation":"

This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.

" }, "DeleteTagsForDomain":{ "name":"DeleteTagsForDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsForDomainRequest"}, "output":{"shape":"DeleteTagsForDomainResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"OperationLimitExceeded"}, {"shape":"UnsupportedTLD"} ], "documentation":"

This operation deletes the specified tags for a domain.

All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.

" }, "DisableDomainAutoRenew":{ "name":"DisableDomainAutoRenew", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableDomainAutoRenewRequest"}, "output":{"shape":"DisableDomainAutoRenewResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"UnsupportedTLD"} ], "documentation":"

This operation disables automatic renewal of domain registration for the specified domain.

" }, "DisableDomainTransferLock":{ "name":"DisableDomainTransferLock", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableDomainTransferLockRequest"}, "output":{"shape":"DisableDomainTransferLockResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"DuplicateRequest"}, {"shape":"TLDRulesViolation"}, {"shape":"OperationLimitExceeded"}, {"shape":"UnsupportedTLD"} ], "documentation":"

This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

" }, "EnableDomainAutoRenew":{ "name":"EnableDomainAutoRenew", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableDomainAutoRenewRequest"}, "output":{"shape":"EnableDomainAutoRenewResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"UnsupportedTLD"}, {"shape":"TLDRulesViolation"} ], "documentation":"

This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account.

The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see \"Renewal, restoration, and deletion times\" on the website for our registrar partner, Gandi. Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline.

" }, "EnableDomainTransferLock":{ "name":"EnableDomainTransferLock", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableDomainTransferLockRequest"}, "output":{"shape":"EnableDomainTransferLockResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"DuplicateRequest"}, {"shape":"TLDRulesViolation"}, {"shape":"OperationLimitExceeded"}, {"shape":"UnsupportedTLD"} ], "documentation":"

This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

" }, "GetContactReachabilityStatus":{ "name":"GetContactReachabilityStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetContactReachabilityStatusRequest"}, "output":{"shape":"GetContactReachabilityStatusResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"OperationLimitExceeded"}, {"shape":"UnsupportedTLD"} ], "documentation":"

For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded.

If you want us to resend the email, use the ResendContactReachabilityEmail operation.

" }, "GetDomainDetail":{ "name":"GetDomainDetail", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDomainDetailRequest"}, "output":{"shape":"GetDomainDetailResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"UnsupportedTLD"} ], "documentation":"

This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output.

" }, "GetDomainSuggestions":{ "name":"GetDomainSuggestions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDomainSuggestionsRequest"}, "output":{"shape":"GetDomainSuggestionsResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"UnsupportedTLD"} ], "documentation":"

The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without spaces).

Parameters:

  • DomainName (string): The basis for your domain suggestion search, a string with (or without) top-level domain specified.
  • SuggestionCount (int): The number of domain suggestions to be returned, maximum 50, minimum 1.
  • OnlyAvailable (bool): If true, availability check will be performed on suggestion results, and only available domains will be returned. If false, suggestions will be returned without checking whether the domain is actually available, and caller will have to call checkDomainAvailability for each suggestion to determine availability for registration.

" }, "GetOperationDetail":{ "name":"GetOperationDetail", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetOperationDetailRequest"}, "output":{"shape":"GetOperationDetailResponse"}, "errors":[ {"shape":"InvalidInput"} ], "documentation":"

This operation returns the current status of an operation that is not completed.

" }, "ListDomains":{ "name":"ListDomains", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDomainsRequest"}, "output":{"shape":"ListDomainsResponse"}, "errors":[ {"shape":"InvalidInput"} ], "documentation":"

This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.

" }, "ListOperations":{ "name":"ListOperations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListOperationsRequest"}, "output":{"shape":"ListOperationsResponse"}, "errors":[ {"shape":"InvalidInput"} ], "documentation":"

This operation returns the operation IDs of operations that are not yet complete.

" }, "ListTagsForDomain":{ "name":"ListTagsForDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForDomainRequest"}, "output":{"shape":"ListTagsForDomainResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"OperationLimitExceeded"}, {"shape":"UnsupportedTLD"} ], "documentation":"

This operation returns all of the tags that are associated with the specified domain.

All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.

" }, "RegisterDomain":{ "name":"RegisterDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterDomainRequest"}, "output":{"shape":"RegisterDomainResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"UnsupportedTLD"}, {"shape":"DuplicateRequest"}, {"shape":"TLDRulesViolation"}, {"shape":"DomainLimitExceeded"}, {"shape":"OperationLimitExceeded"} ], "documentation":"

This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. For some top-level domains (TLDs), this operation requires extra parameters.

When you register a domain, Amazon Route 53 does the following:

  • Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.
  • Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.
  • Optionally enables privacy protection, so WHOIS queries return contact information for our registrar partner, Gandi, instead of the information you entered for registrant, admin, and tech contacts.
  • If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email.
  • Charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.
" }, "RenewDomain":{ "name":"RenewDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RenewDomainRequest"}, "output":{"shape":"RenewDomainResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"UnsupportedTLD"}, {"shape":"DuplicateRequest"}, {"shape":"TLDRulesViolation"}, {"shape":"OperationLimitExceeded"} ], "documentation":"

This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account.

We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 documentation.

" }, "ResendContactReachabilityEmail":{ "name":"ResendContactReachabilityEmail", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResendContactReachabilityEmailRequest"}, "output":{"shape":"ResendContactReachabilityEmailResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"OperationLimitExceeded"}, {"shape":"UnsupportedTLD"} ], "documentation":"

For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact.

" }, "RetrieveDomainAuthCode":{ "name":"RetrieveDomainAuthCode", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RetrieveDomainAuthCodeRequest"}, "output":{"shape":"RetrieveDomainAuthCodeResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"UnsupportedTLD"} ], "documentation":"

This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.

" }, "TransferDomain":{ "name":"TransferDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TransferDomainRequest"}, "output":{"shape":"TransferDomainResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"UnsupportedTLD"}, {"shape":"DuplicateRequest"}, {"shape":"TLDRulesViolation"}, {"shape":"DomainLimitExceeded"}, {"shape":"OperationLimitExceeded"} ], "documentation":"

This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered with the AWS registrar partner, Gandi.

For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.

If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you consider transferring your DNS service to Amazon Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time.

Caution! If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable.

If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.

" }, "UpdateDomainContact":{ "name":"UpdateDomainContact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDomainContactRequest"}, "output":{"shape":"UpdateDomainContactResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"DuplicateRequest"}, {"shape":"TLDRulesViolation"}, {"shape":"OperationLimitExceeded"}, {"shape":"UnsupportedTLD"} ], "documentation":"

This operation updates the contact information for a particular domain. Information for at least one contact (registrant, administrator, or technical) must be supplied for update.

If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

" }, "UpdateDomainContactPrivacy":{ "name":"UpdateDomainContactPrivacy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDomainContactPrivacyRequest"}, "output":{"shape":"UpdateDomainContactPrivacyResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"DuplicateRequest"}, {"shape":"TLDRulesViolation"}, {"shape":"OperationLimitExceeded"}, {"shape":"UnsupportedTLD"} ], "documentation":"

This operation updates the specified domain contact's privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the Gandi privacy features.

This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

" }, "UpdateDomainNameservers":{ "name":"UpdateDomainNameservers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDomainNameserversRequest"}, "output":{"shape":"UpdateDomainNameserversResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"DuplicateRequest"}, {"shape":"TLDRulesViolation"}, {"shape":"OperationLimitExceeded"}, {"shape":"UnsupportedTLD"} ], "documentation":"

This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.

If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

" }, "UpdateTagsForDomain":{ "name":"UpdateTagsForDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateTagsForDomainRequest"}, "output":{"shape":"UpdateTagsForDomainResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"OperationLimitExceeded"}, {"shape":"UnsupportedTLD"} ], "documentation":"

This operation adds or updates tags for a specified domain.

All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.

" }, "ViewBilling":{ "name":"ViewBilling", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ViewBillingRequest"}, "output":{"shape":"ViewBillingResponse"}, "errors":[ {"shape":"InvalidInput"} ], "documentation":"

This operation returns all the domain-related billing records for the current AWS account for a specified period

" } }, "shapes":{ "AddressLine":{ "type":"string", "max":255 }, "BillingRecord":{ "type":"structure", "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of a domain.

Type: String

" }, "Operation":{ "shape":"OperationType", "documentation":"

The operation that you were charged for.

Type: String

Valid values:

  • REGISTER_DOMAIN
  • TRANSFER_IN_DOMAIN
  • RENEW_DOMAIN
  • CHANGE_DOMAIN_OWNER

" }, "InvoiceId":{ "shape":"InvoiceId", "documentation":"

The ID of the invoice that is associated with the billing record.

Type: String

" }, "BillDate":{ "shape":"Timestamp", "documentation":"

The date that the operation was billed, in Unix format.

Type: Double

" }, "Price":{ "shape":"Price", "documentation":"

The price that you were charged for the operation, in US dollars.

Type: Double

Example value: 12.0

" } } }, "BillingRecords":{ "type":"list", "member":{"shape":"BillingRecord"} }, "Boolean":{"type":"boolean"}, "CheckDomainAvailabilityRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" }, "IdnLangCode":{ "shape":"LangCode", "documentation":"

Reserved for future use.

" } }, "documentation":"

The CheckDomainAvailability request contains the following elements.

" }, "CheckDomainAvailabilityResponse":{ "type":"structure", "required":["Availability"], "members":{ "Availability":{ "shape":"DomainAvailability", "documentation":"

Whether the domain name is available for registering.

You can only register domains designated as AVAILABLE.

Type: String

Valid values:

  • AVAILABLE – The domain name is available.
  • AVAILABLE_RESERVED – The domain name is reserved under specific conditions.
  • AVAILABLE_PREORDER – The domain name is available and can be preordered.
  • UNAVAILABLE – The domain name is not available.
  • UNAVAILABLE_PREMIUM – The domain name is not available.
  • UNAVAILABLE_RESTRICTED – The domain name is forbidden.
  • RESERVED – The domain name has been reserved for another person or organization.
  • DONT_KNOW – The TLD registry didn't reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.
" } }, "documentation":"

The CheckDomainAvailability response includes the following elements.

" }, "City":{ "type":"string", "max":255 }, "ContactDetail":{ "type":"structure", "members":{ "FirstName":{ "shape":"ContactName", "documentation":"

First name of contact.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

" }, "LastName":{ "shape":"ContactName", "documentation":"

Last name of contact.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

" }, "ContactType":{ "shape":"ContactType", "documentation":"

Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

Type: String

Default: None

Constraints: Maximum 255 characters.

Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

" }, "OrganizationName":{ "shape":"ContactName", "documentation":"

Name of the organization for contact types other than PERSON.

Type: String

Default: None

Constraints: Maximum 255 characters. Contact type must not be PERSON.

Parents: RegistrantContact, AdminContact, TechContact

Required: No

" }, "AddressLine1":{ "shape":"AddressLine", "documentation":"

First line of the contact's address.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

" }, "AddressLine2":{ "shape":"AddressLine", "documentation":"

Second line of contact's address, if any.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: No

" }, "City":{ "shape":"City", "documentation":"

The city of the contact's address.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

" }, "State":{ "shape":"State", "documentation":"

The state or province of the contact's city.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: No

" }, "CountryCode":{ "shape":"CountryCode", "documentation":"

Code for the country of the contact's address.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

" }, "ZipCode":{ "shape":"ZipCode", "documentation":"

The zip or postal code of the contact's address.

Type: String

Default: None

Constraints: Maximum 255 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: No

" }, "PhoneNumber":{ "shape":"ContactNumber", "documentation":"

The phone number of the contact.

Type: String

Default: None

Constraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code>]\". For example, a US phone number might appear as \"+1.1234567890\".

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

" }, "Email":{ "shape":"Email", "documentation":"

Email address of the contact.

Type: String

Default: None

Constraints: Maximum 254 characters.

Parents: RegistrantContact, AdminContact, TechContact

Required: Yes

" }, "Fax":{ "shape":"ContactNumber", "documentation":"

Fax number of the contact.

Type: String

Default: None

Constraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code]\". For example, a US phone number might appear as \"+1.1234567890\".

Parents: RegistrantContact, AdminContact, TechContact

Required: No

" }, "ExtraParams":{ "shape":"ExtraParamList", "documentation":"

A list of name-value pairs for parameters required by certain top-level domains.

Type: Complex

Default: None

Parents: RegistrantContact, AdminContact, TechContact

Children: Name, Value

Required: No

" } }, "documentation":"

ContactDetail includes the following elements.

", "sensitive":true }, "ContactName":{ "type":"string", "max":255 }, "ContactNumber":{ "type":"string", "max":30 }, "ContactType":{ "type":"string", "enum":[ "PERSON", "COMPANY", "ASSOCIATION", "PUBLIC_BODY", "RESELLER" ] }, "CountryCode":{ "type":"string", "enum":[ "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BR", "BS", "BT", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GH", "GI", "GL", "GM", "GN", "GQ", "GR", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IQ", "IR", "IS", "IT", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PT", "PW", "PY", "QA", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SY", "SZ", "TC", "TD", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ] }, "CurrentExpiryYear":{"type":"integer"}, "DNSSec":{"type":"string"}, "DeleteTagsForDomainRequest":{ "type":"structure", "required":[ "DomainName", "TagsToDelete" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The domain for which you want to delete one or more tags.

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when they're surrounded by letters, numbers, or other hyphens. You can't specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.

Required: Yes

" }, "TagsToDelete":{ "shape":"TagKeyList", "documentation":"

A list of tag keys to delete.

Type: A list that contains the keys of the tags that you want to delete.

Default: None

Required: No

'>" } }, "documentation":"

The DeleteTagsForDomainRequest includes the following elements.

" }, "DeleteTagsForDomainResponse":{ "type":"structure", "members":{ } }, "DisableDomainAutoRenewRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"} } }, "DisableDomainAutoRenewResponse":{ "type":"structure", "members":{ } }, "DisableDomainTransferLockRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" } }, "documentation":"

The DisableDomainTransferLock request includes the following element.

" }, "DisableDomainTransferLockResponse":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Type: String

Default: None

Constraints: Maximum 255 characters.

" } }, "documentation":"

The DisableDomainTransferLock response includes the following element.

" }, "DomainAuthCode":{ "type":"string", "max":1024, "sensitive":true }, "DomainAvailability":{ "type":"string", "enum":[ "AVAILABLE", "AVAILABLE_RESERVED", "AVAILABLE_PREORDER", "UNAVAILABLE", "UNAVAILABLE_PREMIUM", "UNAVAILABLE_RESTRICTED", "RESERVED", "DONT_KNOW" ] }, "DomainLimitExceeded":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The number of domains has exceeded the allowed threshold for the account.

", "exception":true }, "DomainName":{ "type":"string", "max":255, "pattern":"[a-zA-Z0-9_\\-.]*" }, "DomainStatus":{"type":"string"}, "DomainStatusList":{ "type":"list", "member":{"shape":"DomainStatus"} }, "DomainSuggestion":{ "type":"structure", "members":{ "DomainName":{"shape":"DomainName"}, "Availability":{"shape":"String"} } }, "DomainSuggestionsList":{ "type":"list", "member":{"shape":"DomainSuggestion"} }, "DomainSummary":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of a domain.

Type: String

" }, "AutoRenew":{ "shape":"Boolean", "documentation":"

Indicates whether the domain is automatically renewed upon expiration.

Type: Boolean

Valid values: True | False

" }, "TransferLock":{ "shape":"Boolean", "documentation":"

Indicates whether a domain is locked from unauthorized transfer to another party.

Type: Boolean

Valid values: True | False

" }, "Expiry":{ "shape":"Timestamp", "documentation":"

Expiration date of the domain in Coordinated Universal Time (UTC).

Type: Long

" } } }, "DomainSummaryList":{ "type":"list", "member":{"shape":"DomainSummary"} }, "DuplicateRequest":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The request is already in progress for the domain.

", "exception":true }, "DurationInYears":{ "type":"integer", "max":10, "min":1 }, "Email":{ "type":"string", "max":254 }, "EnableDomainAutoRenewRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"} } }, "EnableDomainAutoRenewResponse":{ "type":"structure", "members":{ } }, "EnableDomainTransferLockRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" } }, "documentation":"

The EnableDomainTransferLock request includes the following element.

" }, "EnableDomainTransferLockResponse":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Type: String

Default: None

Constraints: Maximum 255 characters.

" } }, "documentation":"

The EnableDomainTransferLock response includes the following elements.

" }, "ErrorMessage":{"type":"string"}, "ExtraParam":{ "type":"structure", "required":[ "Name", "Value" ], "members":{ "Name":{ "shape":"ExtraParamName", "documentation":"

Name of the additional parameter required by the top-level domain.

Type: String

Default: None

Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | CA_BUSINESS_ENTITY_TYPE |ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER

Parent: ExtraParams

Required: Yes

" }, "Value":{ "shape":"ExtraParamValue", "documentation":"

Values corresponding to the additional parameter names required by some top-level domains.

Type: String

Default: None

Constraints: Maximum 2048 characters.

Parent: ExtraParams

Required: Yes

" } }, "documentation":"

ExtraParam includes the following elements.

" }, "ExtraParamList":{ "type":"list", "member":{"shape":"ExtraParam"} }, "ExtraParamName":{ "type":"string", "enum":[ "DUNS_NUMBER", "BRAND_NUMBER", "BIRTH_DEPARTMENT", "BIRTH_DATE_IN_YYYY_MM_DD", "BIRTH_COUNTRY", "BIRTH_CITY", "DOCUMENT_NUMBER", "AU_ID_NUMBER", "AU_ID_TYPE", "CA_LEGAL_TYPE", "CA_BUSINESS_ENTITY_TYPE", "ES_IDENTIFICATION", "ES_IDENTIFICATION_TYPE", "ES_LEGAL_FORM", "FI_BUSINESS_NUMBER", "FI_ID_NUMBER", "IT_PIN", "RU_PASSPORT_DATA", "SE_ID_NUMBER", "SG_ID_NUMBER", "VAT_NUMBER" ] }, "ExtraParamValue":{ "type":"string", "max":2048 }, "FIAuthKey":{"type":"string"}, "GetContactReachabilityStatusRequest":{ "type":"structure", "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid.

Type: String

Default: None

Required: Yes

" } } }, "GetContactReachabilityStatusResponse":{ "type":"structure", "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The domain name for which you requested the reachability status.

" }, "status":{ "shape":"ReachabilityStatus", "documentation":"

Whether the registrant contact has responded. PENDING indicates that we sent the confirmation email and haven't received a response yet, DONE indicates that we sent the email and got confirmation from the registrant contact, and EXPIRED indicates that the time limit expired before the registrant contact responded.

Type: String

Valid values: PENDING, DONE, EXPIRED

" } } }, "GetDomainDetailRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" } }, "documentation":"

The GetDomainDetail request includes the following element.

" }, "GetDomainDetailResponse":{ "type":"structure", "required":[ "DomainName", "Nameservers", "AdminContact", "RegistrantContact", "TechContact" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of a domain.

Type: String

" }, "Nameservers":{ "shape":"NameserverList", "documentation":"

The name of the domain.

Type: String

" }, "AutoRenew":{ "shape":"Boolean", "documentation":"

Specifies whether the domain registration is set to renew automatically.

Type: Boolean

" }, "AdminContact":{ "shape":"ContactDetail", "documentation":"

Provides details about the domain administrative contact.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

" }, "RegistrantContact":{ "shape":"ContactDetail", "documentation":"

Provides details about the domain registrant.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

" }, "TechContact":{ "shape":"ContactDetail", "documentation":"

Provides details about the domain technical contact.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

" }, "AdminPrivacy":{ "shape":"Boolean", "documentation":"

Specifies whether contact information for the admin contact is concealed from WHOIS queries. If the value is true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

" }, "RegistrantPrivacy":{ "shape":"Boolean", "documentation":"

Specifies whether contact information for the registrant contact is concealed from WHOIS queries. If the value is true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

" }, "TechPrivacy":{ "shape":"Boolean", "documentation":"

Specifies whether contact information for the tech contact is concealed from WHOIS queries. If the value is true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

" }, "RegistrarName":{ "shape":"RegistrarName", "documentation":"

Name of the registrar of the domain as identified in the registry. Amazon Route 53 domains are registered by registrar Gandi. The value is \"GANDI SAS\".

Type: String

" }, "WhoIsServer":{ "shape":"RegistrarWhoIsServer", "documentation":"

The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.

Type: String

" }, "RegistrarUrl":{ "shape":"RegistrarUrl", "documentation":"

Web address of the registrar.

Type: String

" }, "AbuseContactEmail":{ "shape":"Email", "documentation":"

Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.

Type: String

" }, "AbuseContactPhone":{ "shape":"ContactNumber", "documentation":"

Phone number for reporting abuse.

Type: String

" }, "RegistryDomainId":{ "shape":"RegistryDomainId", "documentation":"

Reserved for future use.

" }, "CreationDate":{ "shape":"Timestamp", "documentation":"

The date when the domain was created as found in the response to a WHOIS query. The date format is Unix time.

" }, "UpdatedDate":{ "shape":"Timestamp", "documentation":"

The last updated date of the domain as found in the response to a WHOIS query. The date format is Unix time.

" }, "ExpirationDate":{ "shape":"Timestamp", "documentation":"

The date when the registration for the domain is set to expire. The date format is Unix time.

" }, "Reseller":{ "shape":"Reseller", "documentation":"

Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have \"Amazon\" as the reseller.

Type: String

" }, "DnsSec":{ "shape":"DNSSec", "documentation":"

Reserved for future use.

" }, "StatusList":{ "shape":"DomainStatusList", "documentation":"

An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.

ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.

For a current list of domain name status codes and an explanation of what each code means, go to the ICANN website and search for epp status codes. (Search on the ICANN website; web searches sometimes return an old version of the document.)

Type: Array of String

" } }, "documentation":"

The GetDomainDetail response includes the following elements.

" }, "GetDomainSuggestionsRequest":{ "type":"structure", "required":[ "DomainName", "SuggestionCount", "OnlyAvailable" ], "members":{ "DomainName":{"shape":"DomainName"}, "SuggestionCount":{"shape":"Integer"}, "OnlyAvailable":{"shape":"Boolean"} } }, "GetDomainSuggestionsResponse":{ "type":"structure", "members":{ "SuggestionsList":{"shape":"DomainSuggestionsList"} } }, "GetOperationDetailRequest":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"

The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request.

Type: String

Default: None

Required: Yes

" } }, "documentation":"

The GetOperationDetail request includes the following element.

" }, "GetOperationDetailResponse":{ "type":"structure", "members":{ "OperationId":{ "shape":"OperationId", "documentation":"

The identifier for the operation.

Type: String

" }, "Status":{ "shape":"OperationStatus", "documentation":"

The current status of the requested operation in the system.

Type: String

" }, "Message":{ "shape":"ErrorMessage", "documentation":"

Detailed information on the status including possible errors.

Type: String

" }, "DomainName":{ "shape":"DomainName", "documentation":"

The name of a domain.

Type: String

" }, "Type":{ "shape":"OperationType", "documentation":"

The type of operation that was requested.

Type: String

" }, "SubmittedDate":{ "shape":"Timestamp", "documentation":"

The date when the request was submitted.

" } }, "documentation":"

The GetOperationDetail response includes the following elements.

" }, "GlueIp":{ "type":"string", "max":45 }, "GlueIpList":{ "type":"list", "member":{"shape":"GlueIp"} }, "HostName":{ "type":"string", "max":255, "pattern":"[a-zA-Z0-9_\\-.]*" }, "Integer":{"type":"integer"}, "InvalidInput":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The requested item is not acceptable. For example, for an OperationId it may refer to the ID of an operation that is already completed. For a domain name, it may not be a valid domain name or belong to the requester account.

", "exception":true }, "InvoiceId":{"type":"string"}, "LangCode":{ "type":"string", "max":3 }, "ListDomainsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"PageMarker", "documentation":"

For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

Type: String

Default: None

Constraints: The marker must match the value specified in the previous request.

Required: No

" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

Number of domains to be returned.

Type: Integer

Default: 20

Constraints: A numeral between 1 and 100.

Required: No

" } }, "documentation":"

The ListDomains request includes the following elements.

" }, "ListDomainsResponse":{ "type":"structure", "required":["Domains"], "members":{ "Domains":{ "shape":"DomainSummaryList", "documentation":"

A summary of domains.

Type: Complex type containing a list of domain summaries.

Children: AutoRenew, DomainName, Expiry, TransferLock

" }, "NextPageMarker":{ "shape":"PageMarker", "documentation":"

If there are more domains than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

Type: String

Parent: Operations

" } }, "documentation":"

The ListDomains response includes the following elements.

" }, "ListOperationsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"PageMarker", "documentation":"

For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for MaxItems, you can use Marker to return additional operations. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

Type: String

Default: None

Required: No

" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

Number of domains to be returned.

Type: Integer

Default: 20

Constraints: A value between 1 and 100.

Required: No

" } }, "documentation":"

The ListOperations request includes the following elements.

" }, "ListOperationsResponse":{ "type":"structure", "required":["Operations"], "members":{ "Operations":{ "shape":"OperationSummaryList", "documentation":"

Lists summaries of the operations.

Type: Complex type containing a list of operation summaries

Children: OperationId, Status, SubmittedDate, Type

" }, "NextPageMarker":{ "shape":"PageMarker", "documentation":"

If there are more operations than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

Type: String

Parent: Operations

" } }, "documentation":"

The ListOperations response includes the following elements.

" }, "ListTagsForDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The domain for which you want to get a list of tags.

" } }, "documentation":"

The ListTagsForDomainRequest includes the following elements.

" }, "ListTagsForDomainResponse":{ "type":"structure", "required":["TagList"], "members":{ "TagList":{ "shape":"TagList", "documentation":"

A list of the tags that are associated with the specified domain.

Type: A complex type containing a list of tags

Each tag includes the following elements.

  • Key

    The key (name) of a tag.

    Type: String

  • Value

    The value of a tag.

    Type: String

" } }, "documentation":"

The ListTagsForDomain response includes the following elements.

" }, "Nameserver":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"HostName", "documentation":"

The fully qualified host name of the name server.

Type: String

Constraint: Maximum 255 characterss

Parent: Nameservers

" }, "GlueIps":{ "shape":"GlueIpList", "documentation":"

Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.

Type: List of IP addresses.

Constraints: The list can contain only one IPv4 and one IPv6 address.

Parent: Nameservers

" } }, "documentation":"

Nameserver includes the following elements.

" }, "NameserverList":{ "type":"list", "member":{"shape":"Nameserver"} }, "OperationId":{ "type":"string", "max":255 }, "OperationLimitExceeded":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The number of operations or jobs running exceeded the allowed threshold for the account.

", "exception":true }, "OperationStatus":{ "type":"string", "enum":[ "SUBMITTED", "IN_PROGRESS", "ERROR", "SUCCESSFUL", "FAILED" ] }, "OperationSummary":{ "type":"structure", "required":[ "OperationId", "Status", "Type", "SubmittedDate" ], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"

Identifier returned to track the requested action.

Type: String

" }, "Status":{ "shape":"OperationStatus", "documentation":"

The current status of the requested operation in the system.

Type: String

" }, "Type":{ "shape":"OperationType", "documentation":"

Type of the action requested.

Type: String

Valid values: REGISTER_DOMAIN | DELETE_DOMAIN | TRANSFER_IN_DOMAIN | UPDATE_DOMAIN_CONTACT | UPDATE_NAMESERVER | CHANGE_PRIVACY_PROTECTION | DOMAIN_LOCK

" }, "SubmittedDate":{ "shape":"Timestamp", "documentation":"

The date when the request was submitted.

" } }, "documentation":"

OperationSummary includes the following elements.

" }, "OperationSummaryList":{ "type":"list", "member":{"shape":"OperationSummary"} }, "OperationType":{ "type":"string", "enum":[ "REGISTER_DOMAIN", "DELETE_DOMAIN", "TRANSFER_IN_DOMAIN", "UPDATE_DOMAIN_CONTACT", "UPDATE_NAMESERVER", "CHANGE_PRIVACY_PROTECTION", "DOMAIN_LOCK" ] }, "PageMarker":{ "type":"string", "max":4096 }, "PageMaxItems":{ "type":"integer", "max":100 }, "Price":{"type":"double"}, "ReachabilityStatus":{ "type":"string", "enum":[ "PENDING", "DONE", "EXPIRED" ] }, "RegisterDomainRequest":{ "type":"structure", "required":[ "DomainName", "DurationInYears", "AdminContact", "RegistrantContact", "TechContact" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" }, "IdnLangCode":{ "shape":"LangCode", "documentation":"

Reserved for future use.

" }, "DurationInYears":{ "shape":"DurationInYears", "documentation":"

The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.

Type: Integer

Default: 1

Valid values: Integer from 1 to 10

Required: Yes

" }, "AutoRenew":{ "shape":"Boolean", "documentation":"

Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.

Type: Boolean

Valid values: true | false

Default: true

Required: No

" }, "AdminContact":{ "shape":"ContactDetail", "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" }, "RegistrantContact":{ "shape":"ContactDetail", "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" }, "TechContact":{ "shape":"ContactDetail", "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" }, "PrivacyProtectAdminContact":{ "shape":"Boolean", "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: true

Valid values: true | false

Required: No

" }, "PrivacyProtectRegistrantContact":{ "shape":"Boolean", "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: true

Valid values: true | false

Required: No

" }, "PrivacyProtectTechContact":{ "shape":"Boolean", "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: true

Valid values: true | false

Required: No

" } }, "documentation":"

The RegisterDomain request includes the following elements.

" }, "RegisterDomainResponse":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Type: String

Default: None

Constraints: Maximum 255 characters.

" } }, "documentation":"

The RegisterDomain response includes the following element.

" }, "RegistrarName":{"type":"string"}, "RegistrarUrl":{"type":"string"}, "RegistrarWhoIsServer":{"type":"string"}, "RegistryDomainId":{"type":"string"}, "RenewDomainRequest":{ "type":"structure", "required":[ "DomainName", "CurrentExpiryYear" ], "members":{ "DomainName":{"shape":"DomainName"}, "DurationInYears":{ "shape":"DurationInYears", "documentation":"

The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 documentation.

Type: Integer

Default: 1

Valid values: Integer from 1 to 10

Required: No

" }, "CurrentExpiryYear":{ "shape":"CurrentExpiryYear", "documentation":"

The year when the registration for the domain is set to expire. This value must match the current expiration date for the domain.

Type: Integer

Default: None

Valid values: Integer

Required: Yes

" } }, "documentation":"

A RenewDomain request includes the number of years that you want to renew for and the current expiration year.

" }, "RenewDomainResponse":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{"shape":"OperationId"} } }, "Reseller":{"type":"string"}, "ResendContactReachabilityEmailRequest":{ "type":"structure", "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The name of the domain for which you want Amazon Route 53 to resend a confirmation email to the registrant contact.

Type: String

Default: None

Required: Yes

" } } }, "ResendContactReachabilityEmailResponse":{ "type":"structure", "members":{ "domainName":{ "shape":"DomainName", "documentation":"

The domain name for which you requested a confirmation email.

" }, "emailAddress":{ "shape":"Email", "documentation":"

The email address for the registrant contact at the time that we sent the verification email.

" }, "isAlreadyVerified":{ "shape":"Boolean", "documentation":"

True if the email address for the registrant contact has already been verified, and false otherwise. If the email address has already been verified, we don't send another confirmation email.

" } } }, "RetrieveDomainAuthCodeRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" } }, "documentation":"

The RetrieveDomainAuthCode request includes the following element.

" }, "RetrieveDomainAuthCodeResponse":{ "type":"structure", "required":["AuthCode"], "members":{ "AuthCode":{ "shape":"DomainAuthCode", "documentation":"

The authorization code for the domain.

Type: String

" } }, "documentation":"

The RetrieveDomainAuthCode response includes the following element.

" }, "State":{ "type":"string", "max":255 }, "String":{"type":"string"}, "TLDRulesViolation":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The top-level domain does not support this operation.

", "exception":true }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"TagKey", "documentation":"

The key (name) of a tag.

Type: String

Default: None

Valid values: A-Z, a-z, 0-9, space, \".:/=+\\-@\"

Constraints: Each key can be 1-128 characters long.

Required: Yes

" }, "Value":{ "shape":"TagValue", "documentation":"

The value of a tag.

Type: String

Default: None

Valid values: A-Z, a-z, 0-9, space, \".:/=+\\-@\"

Constraints: Each value can be 0-256 characters long.

Required: Yes

" } }, "documentation":"

Each tag includes the following elements.

" }, "TagKey":{"type":"string"}, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"} }, "TagList":{ "type":"list", "member":{"shape":"Tag"} }, "TagValue":{"type":"string"}, "Timestamp":{"type":"timestamp"}, "TransferDomainRequest":{ "type":"structure", "required":[ "DomainName", "DurationInYears", "AdminContact", "RegistrantContact", "TechContact" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" }, "IdnLangCode":{ "shape":"LangCode", "documentation":"

Reserved for future use.

" }, "DurationInYears":{ "shape":"DurationInYears", "documentation":"

The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.

Type: Integer

Default: 1

Valid values: Integer from 1 to 10

Required: Yes

" }, "Nameservers":{ "shape":"NameserverList", "documentation":"

Contains details for the host and glue IP addresses.

Type: Complex

Children: GlueIps, Name

Required: No

" }, "AuthCode":{ "shape":"DomainAuthCode", "documentation":"

The authorization code for the domain. You get this value from the current registrar.

Type: String

Required: Yes

" }, "AutoRenew":{ "shape":"Boolean", "documentation":"

Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.

Type: Boolean

Valid values: true | false

Default: true

Required: No

" }, "AdminContact":{ "shape":"ContactDetail", "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" }, "RegistrantContact":{ "shape":"ContactDetail", "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" }, "TechContact":{ "shape":"ContactDetail", "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" }, "PrivacyProtectAdminContact":{ "shape":"Boolean", "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: true

Valid values: true | false

Required: No

" }, "PrivacyProtectRegistrantContact":{ "shape":"Boolean", "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: true

Valid values: true | false

Required: No

" }, "PrivacyProtectTechContact":{ "shape":"Boolean", "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: true

Valid values: true | false

Required: No

" } }, "documentation":"

The TransferDomain request includes the following elements.

" }, "TransferDomainResponse":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Type: String

Default: None

Constraints: Maximum 255 characters.

" } }, "documentation":"

The TranserDomain response includes the following element.

" }, "UnsupportedTLD":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

Amazon Route 53 does not support this top-level domain.

", "exception":true }, "UpdateDomainContactPrivacyRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" }, "AdminPrivacy":{ "shape":"Boolean", "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: None

Valid values: true | false

Required: No

" }, "RegistrantPrivacy":{ "shape":"Boolean", "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: None

Valid values: true | false

Required: No

" }, "TechPrivacy":{ "shape":"Boolean", "documentation":"

Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

Type: Boolean

Default: None

Valid values: true | false

Required: No

" } }, "documentation":"

The UpdateDomainContactPrivacy request includes the following elements.

" }, "UpdateDomainContactPrivacyResponse":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Type: String

Default: None

Constraints: Maximum 255 characters.

" } }, "documentation":"

The UpdateDomainContactPrivacy response includes the following element.

" }, "UpdateDomainContactRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" }, "AdminContact":{ "shape":"ContactDetail", "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" }, "RegistrantContact":{ "shape":"ContactDetail", "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" }, "TechContact":{ "shape":"ContactDetail", "documentation":"

Provides detailed contact information.

Type: Complex

Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

Required: Yes

" } }, "documentation":"

The UpdateDomainContact request includes the following elements.

" }, "UpdateDomainContactResponse":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Type: String

Default: None

Constraints: Maximum 255 characters.

" } }, "documentation":"

The UpdateDomainContact response includes the following element.

" }, "UpdateDomainNameserversRequest":{ "type":"structure", "required":[ "DomainName", "Nameservers" ], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

Required: Yes

" }, "FIAuthKey":{ "shape":"FIAuthKey", "documentation":"

The authorization key for .fi domains

" }, "Nameservers":{ "shape":"NameserverList", "documentation":"

A list of new name servers for the domain.

Type: Complex

Children: Name, GlueIps

Required: Yes

" } }, "documentation":"

The UpdateDomainNameserver request includes the following elements.

" }, "UpdateDomainNameserversResponse":{ "type":"structure", "required":["OperationId"], "members":{ "OperationId":{ "shape":"OperationId", "documentation":"

Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

Type: String

Default: None

Constraints: Maximum 255 characters.

" } }, "documentation":"

The UpdateDomainNameservers response includes the following element.

" }, "UpdateTagsForDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The domain for which you want to add or update tags.

The name of a domain.

Type: String

Default: None

Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when they're surrounded by letters, numbers, or other hyphens. You can't specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.

Required: Yes

" }, "TagsToUpdate":{ "shape":"TagList", "documentation":"

A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced.

Type: A complex type containing a list of tags

Default: None

Required: No

'>

Each tag includes the following elements:

  • Key

    The key (name) of a tag.

    Type: String

    Default: None

    Valid values: Unicode characters including alphanumeric, space, and \".:/=+\\-@\"

    Constraints: Each key can be 1-128 characters long.

    Required: Yes

  • Value

    The value of a tag.

    Type: String

    Default: None

    Valid values: Unicode characters including alphanumeric, space, and \".:/=+\\-@\"

    Constraints: Each value can be 0-256 characters long.

    Required: Yes

" } }, "documentation":"

The UpdateTagsForDomainRequest includes the following elements.

" }, "UpdateTagsForDomainResponse":{ "type":"structure", "members":{ } }, "ViewBillingRequest":{ "type":"structure", "members":{ "Start":{ "shape":"Timestamp", "documentation":"

The beginning date and time for the time period for which you want a list of billing records. Specify the date in Unix time format.

Type: Double

Default: None

Required: Yes

" }, "End":{ "shape":"Timestamp", "documentation":"

The end date and time for the time period for which you want a list of billing records. Specify the date in Unix time format.

Type: Double

Default: None

Required: Yes

" }, "Marker":{ "shape":"PageMarker", "documentation":"

For an initial request for a list of billing records, omit this element. If the number of billing records that are associated with the current AWS account during the specified period is greater than the value that you specified for MaxItems, you can use Marker to return additional billing records. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

Type: String

Default: None

Constraints: The marker must match the value of NextPageMarker that was returned in the previous response.

Required: No

" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The number of billing records to be returned.

Type: Integer

Default: 20

Constraints: A value between 1 and 100.

Required: No

" } }, "documentation":"

The ViewBilling request includes the following elements.

" }, "ViewBillingResponse":{ "type":"structure", "members":{ "NextPageMarker":{ "shape":"PageMarker", "documentation":"

If there are more billing records than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

Type: String

Parent: BillingRecords

" }, "BillingRecords":{ "shape":"BillingRecords", "documentation":"

A summary of billing records.

Type: Complex type containing a list of billing record summaries.

Children: DomainName, Operation, InvoiceId, BillDate and Price

" } }, "documentation":"

The ViewBilling response includes the following elements.

" }, "ZipCode":{ "type":"string", "max":255 } } } botocore-1.5.7/botocore/data/apigateway/0000777454262600001440000000000013042511307021266 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/apigateway/2015-07-09/0000777454262600001440000000000013042511307022327 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/apigateway/2015-07-09/paginators-1.json0000666454262600001440000000234713042511306025534 0ustar pysdk-ciamazon00000000000000{ "pagination": { "GetApiKeys": { "input_token": "position", "output_token": "position", "limit_key": "limit", "result_key": "items" }, "GetBasePathMappings": { "input_token": "position", "output_token": "position", "limit_key": "limit", "result_key": "items" }, "GetClientCertificates": { "input_token": "position", "output_token": "position", "limit_key": "limit", "result_key": "items" }, "GetDeployments": { "input_token": "position", "output_token": "position", "limit_key": "limit", "result_key": "items" }, "GetDomainNames": { "input_token": "position", "output_token": "position", "limit_key": "limit", "result_key": "items" }, "GetModels": { "input_token": "position", "output_token": "position", "limit_key": "limit", "result_key": "items" }, "GetResources": { "input_token": "position", "output_token": "position", "limit_key": "limit", "result_key": "items" }, "GetRestApis": { "input_token": "position", "output_token": "position", "limit_key": "limit", "result_key": "items" } } } botocore-1.5.7/botocore/data/apigateway/2015-07-09/service-2.json0000777454262600001440000101506113042511306025027 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-07-09", "endpointPrefix":"apigateway", "protocol":"rest-json", "serviceFullName":"Amazon API Gateway", "signatureVersion":"v4", "uid":"apigateway-2015-07-09" }, "operations":{ "CreateApiKey":{ "name":"CreateApiKey", "http":{ "method":"POST", "requestUri":"/apikeys", "responseCode":201 }, "input":{"shape":"CreateApiKeyRequest"}, "output":{"shape":"ApiKey"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"LimitExceededException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"} ], "documentation":"

Create an ApiKey resource.

AWS CLI
" }, "CreateAuthorizer":{ "name":"CreateAuthorizer", "http":{ "method":"POST", "requestUri":"/restapis/{restapi_id}/authorizers", "responseCode":201 }, "input":{"shape":"CreateAuthorizerRequest"}, "output":{"shape":"Authorizer"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Adds a new Authorizer resource to an existing RestApi resource.

AWS CLI
" }, "CreateBasePathMapping":{ "name":"CreateBasePathMapping", "http":{ "method":"POST", "requestUri":"/domainnames/{domain_name}/basepathmappings", "responseCode":201 }, "input":{"shape":"CreateBasePathMappingRequest"}, "output":{"shape":"BasePathMapping"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"ConflictException"}, {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Creates a new BasePathMapping resource.

" }, "CreateDeployment":{ "name":"CreateDeployment", "http":{ "method":"POST", "requestUri":"/restapis/{restapi_id}/deployments", "responseCode":201 }, "input":{"shape":"CreateDeploymentRequest"}, "output":{"shape":"Deployment"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"LimitExceededException"}, {"shape":"TooManyRequestsException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Creates a Deployment resource, which makes a specified RestApi callable over the internet.

" }, "CreateDocumentationPart":{ "name":"CreateDocumentationPart", "http":{ "method":"POST", "requestUri":"/restapis/{restapi_id}/documentation/parts", "responseCode":201 }, "input":{"shape":"CreateDocumentationPartRequest"}, "output":{"shape":"DocumentationPart"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"TooManyRequestsException"} ] }, "CreateDocumentationVersion":{ "name":"CreateDocumentationVersion", "http":{ "method":"POST", "requestUri":"/restapis/{restapi_id}/documentation/versions", "responseCode":201 }, "input":{"shape":"CreateDocumentationVersionRequest"}, "output":{"shape":"DocumentationVersion"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"TooManyRequestsException"} ] }, "CreateDomainName":{ "name":"CreateDomainName", "http":{ "method":"POST", "requestUri":"/domainnames", "responseCode":201 }, "input":{"shape":"CreateDomainNameRequest"}, "output":{"shape":"DomainName"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Creates a new domain name.

" }, "CreateModel":{ "name":"CreateModel", "http":{ "method":"POST", "requestUri":"/restapis/{restapi_id}/models", "responseCode":201 }, "input":{"shape":"CreateModelRequest"}, "output":{"shape":"Model"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"LimitExceededException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Adds a new Model resource to an existing RestApi resource.

" }, "CreateResource":{ "name":"CreateResource", "http":{ "method":"POST", "requestUri":"/restapis/{restapi_id}/resources/{parent_id}", "responseCode":201 }, "input":{"shape":"CreateResourceRequest"}, "output":{"shape":"Resource"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"LimitExceededException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Creates a Resource resource.

" }, "CreateRestApi":{ "name":"CreateRestApi", "http":{ "method":"POST", "requestUri":"/restapis", "responseCode":201 }, "input":{"shape":"CreateRestApiRequest"}, "output":{"shape":"RestApi"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"LimitExceededException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Creates a new RestApi resource.

" }, "CreateStage":{ "name":"CreateStage", "http":{ "method":"POST", "requestUri":"/restapis/{restapi_id}/stages", "responseCode":201 }, "input":{"shape":"CreateStageRequest"}, "output":{"shape":"Stage"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"LimitExceededException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Creates a new Stage resource that references a pre-existing Deployment for the API.

" }, "CreateUsagePlan":{ "name":"CreateUsagePlan", "http":{ "method":"POST", "requestUri":"/usageplans", "responseCode":201 }, "input":{"shape":"CreateUsagePlanRequest"}, "output":{"shape":"UsagePlan"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictException"}, {"shape":"NotFoundException"} ], "documentation":"

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

" }, "CreateUsagePlanKey":{ "name":"CreateUsagePlanKey", "http":{ "method":"POST", "requestUri":"/usageplans/{usageplanId}/keys", "responseCode":201 }, "input":{"shape":"CreateUsagePlanKeyRequest"}, "output":{"shape":"UsagePlanKey"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Creates a usage plan key for adding an existing API key to a usage plan.

" }, "DeleteApiKey":{ "name":"DeleteApiKey", "http":{ "method":"DELETE", "requestUri":"/apikeys/{api_Key}", "responseCode":202 }, "input":{"shape":"DeleteApiKeyRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Deletes the ApiKey resource.

" }, "DeleteAuthorizer":{ "name":"DeleteAuthorizer", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/authorizers/{authorizer_id}", "responseCode":202 }, "input":{"shape":"DeleteAuthorizerRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"} ], "documentation":"

Deletes an existing Authorizer resource.

AWS CLI
" }, "DeleteBasePathMapping":{ "name":"DeleteBasePathMapping", "http":{ "method":"DELETE", "requestUri":"/domainnames/{domain_name}/basepathmappings/{base_path}", "responseCode":202 }, "input":{"shape":"DeleteBasePathMappingRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Deletes the BasePathMapping resource.

" }, "DeleteClientCertificate":{ "name":"DeleteClientCertificate", "http":{ "method":"DELETE", "requestUri":"/clientcertificates/{clientcertificate_id}", "responseCode":202 }, "input":{"shape":"DeleteClientCertificateRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"BadRequestException"}, {"shape":"NotFoundException"} ], "documentation":"

Deletes the ClientCertificate resource.

" }, "DeleteDeployment":{ "name":"DeleteDeployment", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/deployments/{deployment_id}", "responseCode":202 }, "input":{"shape":"DeleteDeploymentRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.

" }, "DeleteDocumentationPart":{ "name":"DeleteDocumentationPart", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/documentation/parts/{part_id}", "responseCode":202 }, "input":{"shape":"DeleteDocumentationPartRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"ConflictException"}, {"shape":"BadRequestException"} ] }, "DeleteDocumentationVersion":{ "name":"DeleteDocumentationVersion", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/documentation/versions/{doc_version}", "responseCode":202 }, "input":{"shape":"DeleteDocumentationVersionRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"TooManyRequestsException"} ] }, "DeleteDomainName":{ "name":"DeleteDomainName", "http":{ "method":"DELETE", "requestUri":"/domainnames/{domain_name}", "responseCode":202 }, "input":{"shape":"DeleteDomainNameRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Deletes the DomainName resource.

" }, "DeleteIntegration":{ "name":"DeleteIntegration", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration", "responseCode":204 }, "input":{"shape":"DeleteIntegrationRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"ConflictException"} ], "documentation":"

Represents a delete integration.

" }, "DeleteIntegrationResponse":{ "name":"DeleteIntegrationResponse", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}", "responseCode":204 }, "input":{"shape":"DeleteIntegrationResponseRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"} ], "documentation":"

Represents a delete integration response.

" }, "DeleteMethod":{ "name":"DeleteMethod", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}", "responseCode":204 }, "input":{"shape":"DeleteMethodRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"ConflictException"} ], "documentation":"

Deletes an existing Method resource.

" }, "DeleteMethodResponse":{ "name":"DeleteMethodResponse", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}", "responseCode":204 }, "input":{"shape":"DeleteMethodResponseRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"} ], "documentation":"

Deletes an existing MethodResponse resource.

" }, "DeleteModel":{ "name":"DeleteModel", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/models/{model_name}", "responseCode":202 }, "input":{"shape":"DeleteModelRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"} ], "documentation":"

Deletes a model.

" }, "DeleteResource":{ "name":"DeleteResource", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}", "responseCode":202 }, "input":{"shape":"DeleteResourceRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Deletes a Resource resource.

" }, "DeleteRestApi":{ "name":"DeleteRestApi", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}", "responseCode":202 }, "input":{"shape":"DeleteRestApiRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"BadRequestException"} ], "documentation":"

Deletes the specified API.

" }, "DeleteStage":{ "name":"DeleteStage", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/stages/{stage_name}", "responseCode":202 }, "input":{"shape":"DeleteStageRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"BadRequestException"} ], "documentation":"

Deletes a Stage resource.

" }, "DeleteUsagePlan":{ "name":"DeleteUsagePlan", "http":{ "method":"DELETE", "requestUri":"/usageplans/{usageplanId}", "responseCode":202 }, "input":{"shape":"DeleteUsagePlanRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"BadRequestException"}, {"shape":"NotFoundException"} ], "documentation":"

Deletes a usage plan of a given plan Id.

" }, "DeleteUsagePlanKey":{ "name":"DeleteUsagePlanKey", "http":{ "method":"DELETE", "requestUri":"/usageplans/{usageplanId}/keys/{keyId}", "responseCode":202 }, "input":{"shape":"DeleteUsagePlanKeyRequest"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Deletes a usage plan key and remove the underlying API key from the associated usage plan.

" }, "FlushStageAuthorizersCache":{ "name":"FlushStageAuthorizersCache", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/stages/{stage_name}/cache/authorizers", "responseCode":202 }, "input":{"shape":"FlushStageAuthorizersCacheRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Flushes all authorizer cache entries on a stage.

" }, "FlushStageCache":{ "name":"FlushStageCache", "http":{ "method":"DELETE", "requestUri":"/restapis/{restapi_id}/stages/{stage_name}/cache/data", "responseCode":202 }, "input":{"shape":"FlushStageCacheRequest"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Flushes a stage's cache.

" }, "GenerateClientCertificate":{ "name":"GenerateClientCertificate", "http":{ "method":"POST", "requestUri":"/clientcertificates", "responseCode":201 }, "input":{"shape":"GenerateClientCertificateRequest"}, "output":{"shape":"ClientCertificate"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"LimitExceededException"} ], "documentation":"

Generates a ClientCertificate resource.

" }, "GetAccount":{ "name":"GetAccount", "http":{ "method":"GET", "requestUri":"/account" }, "input":{"shape":"GetAccountRequest"}, "output":{"shape":"Account"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Gets information about the current Account resource.

" }, "GetApiKey":{ "name":"GetApiKey", "http":{ "method":"GET", "requestUri":"/apikeys/{api_Key}" }, "input":{"shape":"GetApiKeyRequest"}, "output":{"shape":"ApiKey"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Gets information about the current ApiKey resource.

" }, "GetApiKeys":{ "name":"GetApiKeys", "http":{ "method":"GET", "requestUri":"/apikeys" }, "input":{"shape":"GetApiKeysRequest"}, "output":{"shape":"ApiKeys"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Gets information about the current ApiKeys resource.

" }, "GetAuthorizer":{ "name":"GetAuthorizer", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/authorizers/{authorizer_id}" }, "input":{"shape":"GetAuthorizerRequest"}, "output":{"shape":"Authorizer"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Describe an existing Authorizer resource.

AWS CLI
" }, "GetAuthorizers":{ "name":"GetAuthorizers", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/authorizers" }, "input":{"shape":"GetAuthorizersRequest"}, "output":{"shape":"Authorizers"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Describe an existing Authorizers resource.

AWS CLI
" }, "GetBasePathMapping":{ "name":"GetBasePathMapping", "http":{ "method":"GET", "requestUri":"/domainnames/{domain_name}/basepathmappings/{base_path}" }, "input":{"shape":"GetBasePathMappingRequest"}, "output":{"shape":"BasePathMapping"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Describe a BasePathMapping resource.

" }, "GetBasePathMappings":{ "name":"GetBasePathMappings", "http":{ "method":"GET", "requestUri":"/domainnames/{domain_name}/basepathmappings" }, "input":{"shape":"GetBasePathMappingsRequest"}, "output":{"shape":"BasePathMappings"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Represents a collection of BasePathMapping resources.

" }, "GetClientCertificate":{ "name":"GetClientCertificate", "http":{ "method":"GET", "requestUri":"/clientcertificates/{clientcertificate_id}" }, "input":{"shape":"GetClientCertificateRequest"}, "output":{"shape":"ClientCertificate"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Gets information about the current ClientCertificate resource.

" }, "GetClientCertificates":{ "name":"GetClientCertificates", "http":{ "method":"GET", "requestUri":"/clientcertificates" }, "input":{"shape":"GetClientCertificatesRequest"}, "output":{"shape":"ClientCertificates"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Gets a collection of ClientCertificate resources.

" }, "GetDeployment":{ "name":"GetDeployment", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/deployments/{deployment_id}" }, "input":{"shape":"GetDeploymentRequest"}, "output":{"shape":"Deployment"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Gets information about a Deployment resource.

" }, "GetDeployments":{ "name":"GetDeployments", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/deployments" }, "input":{"shape":"GetDeploymentsRequest"}, "output":{"shape":"Deployments"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Gets information about a Deployments collection.

" }, "GetDocumentationPart":{ "name":"GetDocumentationPart", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/documentation/parts/{part_id}" }, "input":{"shape":"GetDocumentationPartRequest"}, "output":{"shape":"DocumentationPart"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ] }, "GetDocumentationParts":{ "name":"GetDocumentationParts", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/documentation/parts" }, "input":{"shape":"GetDocumentationPartsRequest"}, "output":{"shape":"DocumentationParts"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ] }, "GetDocumentationVersion":{ "name":"GetDocumentationVersion", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/documentation/versions/{doc_version}" }, "input":{"shape":"GetDocumentationVersionRequest"}, "output":{"shape":"DocumentationVersion"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ] }, "GetDocumentationVersions":{ "name":"GetDocumentationVersions", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/documentation/versions" }, "input":{"shape":"GetDocumentationVersionsRequest"}, "output":{"shape":"DocumentationVersions"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ] }, "GetDomainName":{ "name":"GetDomainName", "http":{ "method":"GET", "requestUri":"/domainnames/{domain_name}" }, "input":{"shape":"GetDomainNameRequest"}, "output":{"shape":"DomainName"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"ServiceUnavailableException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

" }, "GetDomainNames":{ "name":"GetDomainNames", "http":{ "method":"GET", "requestUri":"/domainnames" }, "input":{"shape":"GetDomainNamesRequest"}, "output":{"shape":"DomainNames"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Represents a collection of DomainName resources.

" }, "GetExport":{ "name":"GetExport", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/stages/{stage_name}/exports/{export_type}", "responseCode":200 }, "input":{"shape":"GetExportRequest"}, "output":{"shape":"ExportResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Exports a deployed version of a RestApi in a specified format.

" }, "GetIntegration":{ "name":"GetIntegration", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration" }, "input":{"shape":"GetIntegrationRequest"}, "output":{"shape":"Integration"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Represents a get integration.

" }, "GetIntegrationResponse":{ "name":"GetIntegrationResponse", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}" }, "input":{"shape":"GetIntegrationResponseRequest"}, "output":{"shape":"IntegrationResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Represents a get integration response.

" }, "GetMethod":{ "name":"GetMethod", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}" }, "input":{"shape":"GetMethodRequest"}, "output":{"shape":"Method"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Describe an existing Method resource.

" }, "GetMethodResponse":{ "name":"GetMethodResponse", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}" }, "input":{"shape":"GetMethodResponseRequest"}, "output":{"shape":"MethodResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Describes a MethodResponse resource.

" }, "GetModel":{ "name":"GetModel", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/models/{model_name}" }, "input":{"shape":"GetModelRequest"}, "output":{"shape":"Model"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Describes an existing model defined for a RestApi resource.

" }, "GetModelTemplate":{ "name":"GetModelTemplate", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/models/{model_name}/default_template" }, "input":{"shape":"GetModelTemplateRequest"}, "output":{"shape":"Template"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Generates a sample mapping template that can be used to transform a payload into the structure of a model.

" }, "GetModels":{ "name":"GetModels", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/models" }, "input":{"shape":"GetModelsRequest"}, "output":{"shape":"Models"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Describes existing Models defined for a RestApi resource.

" }, "GetResource":{ "name":"GetResource", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}" }, "input":{"shape":"GetResourceRequest"}, "output":{"shape":"Resource"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Lists information about a resource.

" }, "GetResources":{ "name":"GetResources", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/resources" }, "input":{"shape":"GetResourcesRequest"}, "output":{"shape":"Resources"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Lists information about a collection of Resource resources.

" }, "GetRestApi":{ "name":"GetRestApi", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}" }, "input":{"shape":"GetRestApiRequest"}, "output":{"shape":"RestApi"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Lists the RestApi resource in the collection.

" }, "GetRestApis":{ "name":"GetRestApis", "http":{ "method":"GET", "requestUri":"/restapis" }, "input":{"shape":"GetRestApisRequest"}, "output":{"shape":"RestApis"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Lists the RestApis resources for your collection.

" }, "GetSdk":{ "name":"GetSdk", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/stages/{stage_name}/sdks/{sdk_type}", "responseCode":200 }, "input":{"shape":"GetSdkRequest"}, "output":{"shape":"SdkResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Generates a client SDK for a RestApi and Stage.

" }, "GetSdkType":{ "name":"GetSdkType", "http":{ "method":"GET", "requestUri":"/sdktypes/{sdktype_id}" }, "input":{"shape":"GetSdkTypeRequest"}, "output":{"shape":"SdkType"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ] }, "GetSdkTypes":{ "name":"GetSdkTypes", "http":{ "method":"GET", "requestUri":"/sdktypes" }, "input":{"shape":"GetSdkTypesRequest"}, "output":{"shape":"SdkTypes"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"TooManyRequestsException"} ] }, "GetStage":{ "name":"GetStage", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/stages/{stage_name}" }, "input":{"shape":"GetStageRequest"}, "output":{"shape":"Stage"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Gets information about a Stage resource.

" }, "GetStages":{ "name":"GetStages", "http":{ "method":"GET", "requestUri":"/restapis/{restapi_id}/stages" }, "input":{"shape":"GetStagesRequest"}, "output":{"shape":"Stages"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Gets information about one or more Stage resources.

" }, "GetUsage":{ "name":"GetUsage", "http":{ "method":"GET", "requestUri":"/usageplans/{usageplanId}/usage" }, "input":{"shape":"GetUsageRequest"}, "output":{"shape":"Usage"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Gets the usage data of a usage plan in a specified time interval.

" }, "GetUsagePlan":{ "name":"GetUsagePlan", "http":{ "method":"GET", "requestUri":"/usageplans/{usageplanId}" }, "input":{"shape":"GetUsagePlanRequest"}, "output":{"shape":"UsagePlan"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Gets a usage plan of a given plan identifier.

" }, "GetUsagePlanKey":{ "name":"GetUsagePlanKey", "http":{ "method":"GET", "requestUri":"/usageplans/{usageplanId}/keys/{keyId}", "responseCode":200 }, "input":{"shape":"GetUsagePlanKeyRequest"}, "output":{"shape":"UsagePlanKey"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Gets a usage plan key of a given key identifier.

" }, "GetUsagePlanKeys":{ "name":"GetUsagePlanKeys", "http":{ "method":"GET", "requestUri":"/usageplans/{usageplanId}/keys" }, "input":{"shape":"GetUsagePlanKeysRequest"}, "output":{"shape":"UsagePlanKeys"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Gets all the usage plan keys representing the API keys added to a specified usage plan.

" }, "GetUsagePlans":{ "name":"GetUsagePlans", "http":{ "method":"GET", "requestUri":"/usageplans" }, "input":{"shape":"GetUsagePlansRequest"}, "output":{"shape":"UsagePlans"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"ConflictException"}, {"shape":"NotFoundException"} ], "documentation":"

Gets all the usage plans of the caller's account.

" }, "ImportApiKeys":{ "name":"ImportApiKeys", "http":{ "method":"POST", "requestUri":"/apikeys?mode=import", "responseCode":201 }, "input":{"shape":"ImportApiKeysRequest"}, "output":{"shape":"ApiKeyIds"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"LimitExceededException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"} ], "documentation":"

Import API keys from an external source, such as a CSV-formatted file.

" }, "ImportDocumentationParts":{ "name":"ImportDocumentationParts", "http":{ "method":"PUT", "requestUri":"/restapis/{restapi_id}/documentation/parts" }, "input":{"shape":"ImportDocumentationPartsRequest"}, "output":{"shape":"DocumentationPartIds"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"LimitExceededException"}, {"shape":"TooManyRequestsException"} ] }, "ImportRestApi":{ "name":"ImportRestApi", "http":{ "method":"POST", "requestUri":"/restapis?mode=import", "responseCode":201 }, "input":{"shape":"ImportRestApiRequest"}, "output":{"shape":"RestApi"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"LimitExceededException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"ConflictException"} ], "documentation":"

A feature of the Amazon API Gateway control service for creating a new API from an external API definition file.

" }, "PutIntegration":{ "name":"PutIntegration", "http":{ "method":"PUT", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration", "responseCode":201 }, "input":{"shape":"PutIntegrationRequest"}, "output":{"shape":"Integration"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Represents a put integration.

" }, "PutIntegrationResponse":{ "name":"PutIntegrationResponse", "http":{ "method":"PUT", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}", "responseCode":201 }, "input":{"shape":"PutIntegrationResponseRequest"}, "output":{"shape":"IntegrationResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"ConflictException"} ], "documentation":"

Represents a put integration.

" }, "PutMethod":{ "name":"PutMethod", "http":{ "method":"PUT", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}", "responseCode":201 }, "input":{"shape":"PutMethodRequest"}, "output":{"shape":"Method"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"LimitExceededException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Add a method to an existing Resource resource.

" }, "PutMethodResponse":{ "name":"PutMethodResponse", "http":{ "method":"PUT", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}", "responseCode":201 }, "input":{"shape":"PutMethodResponseRequest"}, "output":{"shape":"MethodResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"LimitExceededException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Adds a MethodResponse to an existing Method resource.

" }, "PutRestApi":{ "name":"PutRestApi", "http":{ "method":"PUT", "requestUri":"/restapis/{restapi_id}" }, "input":{"shape":"PutRestApiRequest"}, "output":{"shape":"RestApi"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"LimitExceededException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"ConflictException"} ], "documentation":"

A feature of the Amazon API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.

" }, "TestInvokeAuthorizer":{ "name":"TestInvokeAuthorizer", "http":{ "method":"POST", "requestUri":"/restapis/{restapi_id}/authorizers/{authorizer_id}" }, "input":{"shape":"TestInvokeAuthorizerRequest"}, "output":{"shape":"TestInvokeAuthorizerResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.

Enable custom authorizers
" }, "TestInvokeMethod":{ "name":"TestInvokeMethod", "http":{ "method":"POST", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}" }, "input":{"shape":"TestInvokeMethodRequest"}, "output":{"shape":"TestInvokeMethodResponse"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.

" }, "UpdateAccount":{ "name":"UpdateAccount", "http":{ "method":"PATCH", "requestUri":"/account" }, "input":{"shape":"UpdateAccountRequest"}, "output":{"shape":"Account"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Changes information about the current Account resource.

" }, "UpdateApiKey":{ "name":"UpdateApiKey", "http":{ "method":"PATCH", "requestUri":"/apikeys/{api_Key}" }, "input":{"shape":"UpdateApiKeyRequest"}, "output":{"shape":"ApiKey"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"ConflictException"} ], "documentation":"

Changes information about an ApiKey resource.

" }, "UpdateAuthorizer":{ "name":"UpdateAuthorizer", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/authorizers/{authorizer_id}" }, "input":{"shape":"UpdateAuthorizerRequest"}, "output":{"shape":"Authorizer"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Updates an existing Authorizer resource.

AWS CLI
" }, "UpdateBasePathMapping":{ "name":"UpdateBasePathMapping", "http":{ "method":"PATCH", "requestUri":"/domainnames/{domain_name}/basepathmappings/{base_path}" }, "input":{"shape":"UpdateBasePathMappingRequest"}, "output":{"shape":"BasePathMapping"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Changes information about the BasePathMapping resource.

" }, "UpdateClientCertificate":{ "name":"UpdateClientCertificate", "http":{ "method":"PATCH", "requestUri":"/clientcertificates/{clientcertificate_id}" }, "input":{"shape":"UpdateClientCertificateRequest"}, "output":{"shape":"ClientCertificate"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"BadRequestException"}, {"shape":"NotFoundException"} ], "documentation":"

Changes information about an ClientCertificate resource.

" }, "UpdateDeployment":{ "name":"UpdateDeployment", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/deployments/{deployment_id}" }, "input":{"shape":"UpdateDeploymentRequest"}, "output":{"shape":"Deployment"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Changes information about a Deployment resource.

" }, "UpdateDocumentationPart":{ "name":"UpdateDocumentationPart", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/documentation/parts/{part_id}" }, "input":{"shape":"UpdateDocumentationPartRequest"}, "output":{"shape":"DocumentationPart"}, "errors":[ {"shape":"BadRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"LimitExceededException"}, {"shape":"TooManyRequestsException"} ] }, "UpdateDocumentationVersion":{ "name":"UpdateDocumentationVersion", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/documentation/versions/{doc_version}" }, "input":{"shape":"UpdateDocumentationVersionRequest"}, "output":{"shape":"DocumentationVersion"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ] }, "UpdateDomainName":{ "name":"UpdateDomainName", "http":{ "method":"PATCH", "requestUri":"/domainnames/{domain_name}" }, "input":{"shape":"UpdateDomainNameRequest"}, "output":{"shape":"DomainName"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Changes information about the DomainName resource.

" }, "UpdateIntegration":{ "name":"UpdateIntegration", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration" }, "input":{"shape":"UpdateIntegrationRequest"}, "output":{"shape":"Integration"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"}, {"shape":"ConflictException"} ], "documentation":"

Represents an update integration.

" }, "UpdateIntegrationResponse":{ "name":"UpdateIntegrationResponse", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/integration/responses/{status_code}" }, "input":{"shape":"UpdateIntegrationResponseRequest"}, "output":{"shape":"IntegrationResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Represents an update integration response.

" }, "UpdateMethod":{ "name":"UpdateMethod", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}" }, "input":{"shape":"UpdateMethodRequest"}, "output":{"shape":"Method"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Updates an existing Method resource.

" }, "UpdateMethodResponse":{ "name":"UpdateMethodResponse", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}/methods/{http_method}/responses/{status_code}", "responseCode":201 }, "input":{"shape":"UpdateMethodResponseRequest"}, "output":{"shape":"MethodResponse"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"LimitExceededException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Updates an existing MethodResponse resource.

" }, "UpdateModel":{ "name":"UpdateModel", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/models/{model_name}" }, "input":{"shape":"UpdateModelRequest"}, "output":{"shape":"Model"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"BadRequestException"}, {"shape":"ConflictException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Changes information about a model.

" }, "UpdateResource":{ "name":"UpdateResource", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/resources/{resource_id}" }, "input":{"shape":"UpdateResourceRequest"}, "output":{"shape":"Resource"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Changes information about a Resource resource.

" }, "UpdateRestApi":{ "name":"UpdateRestApi", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}" }, "input":{"shape":"UpdateRestApiRequest"}, "output":{"shape":"RestApi"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Changes information about the specified API.

" }, "UpdateStage":{ "name":"UpdateStage", "http":{ "method":"PATCH", "requestUri":"/restapis/{restapi_id}/stages/{stage_name}" }, "input":{"shape":"UpdateStageRequest"}, "output":{"shape":"Stage"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"BadRequestException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Changes information about a Stage resource.

" }, "UpdateUsage":{ "name":"UpdateUsage", "http":{ "method":"PATCH", "requestUri":"/usageplans/{usageplanId}/keys/{keyId}/usage" }, "input":{"shape":"UpdateUsageRequest"}, "output":{"shape":"Usage"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"BadRequestException"}, {"shape":"NotFoundException"} ], "documentation":"

Grants a temporary extension to the reamining quota of a usage plan associated with a specified API key.

" }, "UpdateUsagePlan":{ "name":"UpdateUsagePlan", "http":{ "method":"PATCH", "requestUri":"/usageplans/{usageplanId}" }, "input":{"shape":"UpdateUsagePlanRequest"}, "output":{"shape":"UsagePlan"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"BadRequestException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Updates a usage plan of a given plan Id.

" } }, "shapes":{ "Account":{ "type":"structure", "members":{ "cloudwatchRoleArn":{ "shape":"String", "documentation":"

The ARN of an Amazon CloudWatch role for the current Account.

" }, "throttleSettings":{ "shape":"ThrottleSettings", "documentation":"

Specifies the API request limits configured for the current Account.

" }, "features":{ "shape":"ListOfString", "documentation":"

A list of features supported for the account. When usage plans are enabled, the features list will include an entry of \"UsagePlans\".

" }, "apiKeyVersion":{ "shape":"String", "documentation":"

The version of the API keys used for the account.

" } }, "documentation":"

Represents an AWS account that is associated with Amazon API Gateway.

To view the account info, call GET on this resource.

Error Codes

The following exception may be thrown when the request fails.

  • UnauthorizedException
  • NotFoundException
  • TooManyRequestsException

For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes

Example: Get the information about an account.

Request
GET /account HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html\", \"name\": \"account\", \"templated\": true }, \"self\": { \"href\": \"/account\" }, \"account:update\": { \"href\": \"/account\" } }, \"cloudwatchRoleArn\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\", \"throttleSettings\": { \"rateLimit\": 500, \"burstLimit\": 1000 } }

In addition to making the REST API call directly, you can use the AWS CLI and an AWS SDK to access this resource.

API Gateway Limits Developer Guide, AWS CLI
" }, "ApiKey":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The identifier of the API Key.

" }, "value":{ "shape":"String", "documentation":"

The value of the API Key.

" }, "name":{ "shape":"String", "documentation":"

The name of the API Key.

" }, "customerId":{ "shape":"String", "documentation":"

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

" }, "description":{ "shape":"String", "documentation":"

The description of the API Key.

" }, "enabled":{ "shape":"Boolean", "documentation":"

Specifies whether the API Key can be used by callers.

" }, "createdDate":{ "shape":"Timestamp", "documentation":"

The date when the API Key was created, in ISO 8601 format.

" }, "lastUpdatedDate":{ "shape":"Timestamp", "documentation":"

When the API Key was last updated, in ISO 8601 format.

" }, "stageKeys":{ "shape":"ListOfString", "documentation":"

A list of Stage resources that are associated with the ApiKey resource.

" } }, "documentation":"

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

Use API Keys
" }, "ApiKeyIds":{ "type":"structure", "members":{ "ids":{ "shape":"ListOfString", "documentation":"

A list of all the ApiKey identifiers.

" }, "warnings":{ "shape":"ListOfString", "documentation":"

A list of warning messages.

" } }, "documentation":"

The identifier of an ApiKey used in a UsagePlan.

" }, "ApiKeys":{ "type":"structure", "members":{ "warnings":{ "shape":"ListOfString", "documentation":"

A list of warning messages logged during the import of API keys when the failOnWarnings option is set to true.

" }, "position":{"shape":"String"}, "items":{ "shape":"ListOfApiKey", "documentation":"

The current page of any ApiKey resources in the collection of ApiKey resources.

", "locationName":"item" } }, "documentation":"

Represents a collection of API keys as represented by an ApiKeys resource.

Use API Keys
" }, "ApiKeysFormat":{ "type":"string", "enum":["csv"] }, "ApiStage":{ "type":"structure", "members":{ "apiId":{ "shape":"String", "documentation":"

API Id of the associated API stage in a usage plan.

" }, "stage":{ "shape":"String", "documentation":"

API stage name of the associated API stage in a usage plan.

" } }, "documentation":"

API stage name of the associated API stage in a usage plan.

" }, "Authorizer":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The identifier for the authorizer resource.

" }, "name":{ "shape":"String", "documentation":"

[Required] The name of the authorizer.

" }, "type":{ "shape":"AuthorizerType", "documentation":"

[Required] The type of the authorizer. Currently, the valid type is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito user pool.

" }, "providerARNs":{ "shape":"ListOfARNs", "documentation":"

A list of the provider ARNs of the authorizer. For an TOKEN authorizer, this is not defined. For authorizers of the COGNITO_USER_POOLS type, each element corresponds to a user pool ARN of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}.

" }, "authType":{ "shape":"String", "documentation":"

Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

" }, "authorizerUri":{ "shape":"String", "documentation":"

[Required] Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

" }, "authorizerCredentials":{ "shape":"String", "documentation":"

Specifies the credentials required for the authorizer, if any. Two options are available. To specify an IAM role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

" }, "identitySource":{ "shape":"String", "documentation":"

[Required] The source of the identity in an incoming request. For a TOKEN authorizer, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token. For COGNITO_USER_POOLS authorizers, this property is used.

" }, "identityValidationExpression":{ "shape":"String", "documentation":"

A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.

" }, "authorizerResultTtlInSeconds":{ "shape":"NullableInteger", "documentation":"

The TTL in seconds of cached authorizer results. If greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

" } }, "documentation":"

Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

Enable custom authorization
" }, "AuthorizerType":{ "type":"string", "documentation":"

The authorizer type. the current value is TOKEN for a Lambda function or COGNITO_USER_POOLS for an Amazon Cognito Your User Pool.

", "enum":[ "TOKEN", "COGNITO_USER_POOLS" ] }, "Authorizers":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfAuthorizer", "documentation":"

Gets the current list of Authorizer resources in the collection.

", "locationName":"item" } }, "documentation":"

Represents a collection of Authorizer resources.

Enable custom authorization
" }, "BadRequestException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "error":{"httpStatusCode":400}, "exception":true }, "BasePathMapping":{ "type":"structure", "members":{ "basePath":{ "shape":"String", "documentation":"

The base path name that callers of the API must provide as part of the URL after the domain name.

" }, "restApiId":{ "shape":"String", "documentation":"

The name of the API.

" }, "stage":{ "shape":"String", "documentation":"

The name of the API's stage.

" } }, "documentation":"

Represents the base path that callers of the API must provide as part of the URL after the domain name.

A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account.
Use Custom Domain Names
" }, "BasePathMappings":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfBasePathMapping", "documentation":"

The current page of any BasePathMapping resources in the collection of base path mapping resources.

", "locationName":"item" } }, "documentation":"

Represents a collection of BasePathMapping resources.

Use Custom Domain Names
" }, "Blob":{"type":"blob"}, "Boolean":{"type":"boolean"}, "CacheClusterSize":{ "type":"string", "documentation":"

Returns the size of the CacheCluster.

", "enum":[ "0.5", "1.6", "6.1", "13.5", "28.4", "58.2", "118", "237" ] }, "CacheClusterStatus":{ "type":"string", "documentation":"

Returns the status of the CacheCluster.

", "enum":[ "CREATE_IN_PROGRESS", "AVAILABLE", "DELETE_IN_PROGRESS", "NOT_AVAILABLE", "FLUSH_IN_PROGRESS" ] }, "ClientCertificate":{ "type":"structure", "members":{ "clientCertificateId":{ "shape":"String", "documentation":"

The identifier of the client certificate.

" }, "description":{ "shape":"String", "documentation":"

The description of the client certificate.

" }, "pemEncodedCertificate":{ "shape":"String", "documentation":"

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

" }, "createdDate":{ "shape":"Timestamp", "documentation":"

The date when the client certificate was created, in ISO 8601 format.

" }, "expirationDate":{ "shape":"Timestamp", "documentation":"

The date when the client certificate will expire, in ISO 8601 format.

" } }, "documentation":"

Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

Client certificates are used authenticate an API by the back-end server. To authenticate an API client (or user), use a custom Authorizer.
Use Client-Side Certificate
" }, "ClientCertificates":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfClientCertificate", "documentation":"

The current page of any ClientCertificate resources in the collection of ClientCertificate resources.

", "locationName":"item" } }, "documentation":"

Represents a collection of ClientCertificate resources.

Use Client-Side Certificate
" }, "ConflictException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "error":{"httpStatusCode":409}, "exception":true }, "ContentHandlingStrategy":{ "type":"string", "enum":[ "CONVERT_TO_BINARY", "CONVERT_TO_TEXT" ] }, "CreateApiKeyRequest":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the ApiKey.

" }, "description":{ "shape":"String", "documentation":"

The description of the ApiKey.

" }, "enabled":{ "shape":"Boolean", "documentation":"

Specifies whether the ApiKey can be used by callers.

" }, "generateDistinctId":{ "shape":"Boolean", "documentation":"

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.

" }, "value":{ "shape":"String", "documentation":"

Specifies a value of the API key.

" }, "stageKeys":{ "shape":"ListOfStageKeys", "documentation":"

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

" }, "customerId":{ "shape":"String", "documentation":"

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

" } }, "documentation":"

Request to create an ApiKey resource.

" }, "CreateAuthorizerRequest":{ "type":"structure", "required":[ "restApiId", "name", "type", "identitySource" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier under which the Authorizer will be created.

", "location":"uri", "locationName":"restapi_id" }, "name":{ "shape":"String", "documentation":"

[Required] The name of the authorizer.

" }, "type":{ "shape":"AuthorizerType", "documentation":"

[Required] The type of the authorizer.

" }, "providerARNs":{ "shape":"ListOfARNs", "documentation":"

A list of the Cognito Your User Pool authorizer's provider ARNs.

" }, "authType":{ "shape":"String", "documentation":"

Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

" }, "authorizerUri":{ "shape":"String", "documentation":"

[Required] Specifies the authorizer's Uniform Resource Identifier (URI).

" }, "authorizerCredentials":{ "shape":"String", "documentation":"

Specifies the credentials required for the authorizer, if any.

" }, "identitySource":{ "shape":"String", "documentation":"

[Required] The source of the identity in an incoming request.

" }, "identityValidationExpression":{ "shape":"String", "documentation":"

A validation expression for the incoming identity.

" }, "authorizerResultTtlInSeconds":{ "shape":"NullableInteger", "documentation":"

The TTL of cached authorizer results.

" } }, "documentation":"

Request to add a new Authorizer to an existing RestApi resource.

" }, "CreateBasePathMappingRequest":{ "type":"structure", "required":[ "domainName", "restApiId" ], "members":{ "domainName":{ "shape":"String", "documentation":"

The domain name of the BasePathMapping resource to create.

", "location":"uri", "locationName":"domain_name" }, "basePath":{ "shape":"String", "documentation":"

The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify a base path name after the domain name.

" }, "restApiId":{ "shape":"String", "documentation":"

The name of the API that you want to apply this mapping to.

" }, "stage":{ "shape":"String", "documentation":"

The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want callers to explicitly specify the stage name after any base path name.

" } }, "documentation":"

Requests Amazon API Gateway to create a new BasePathMapping resource.

" }, "CreateDeploymentRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi resource identifier for the Deployment resource to create.

", "location":"uri", "locationName":"restapi_id" }, "stageName":{ "shape":"String", "documentation":"

The name of the Stage resource for the Deployment resource to create.

" }, "stageDescription":{ "shape":"String", "documentation":"

The description of the Stage resource for the Deployment resource to create.

" }, "description":{ "shape":"String", "documentation":"

The description for the Deployment resource to create.

" }, "cacheClusterEnabled":{ "shape":"NullableBoolean", "documentation":"

Enables a cache cluster for the Stage resource specified in the input.

" }, "cacheClusterSize":{ "shape":"CacheClusterSize", "documentation":"

Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.

" }, "variables":{ "shape":"MapOfStringToString", "documentation":"

A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

" } }, "documentation":"

Requests Amazon API Gateway to create a Deployment resource.

" }, "CreateDocumentationPartRequest":{ "type":"structure", "required":[ "restApiId", "location", "properties" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

[Required] The identifier of an API of the to-be-created documentation part.

", "location":"uri", "locationName":"restapi_id" }, "location":{ "shape":"DocumentationPartLocation", "documentation":"

[Required] The location of the targeted API entity of the to-be-created documentation part.

" }, "properties":{ "shape":"String", "documentation":"

[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only Swagger-compliant key-value pairs can be exported and, hence, published.

" } }, "documentation":"

Creates a new documentation part of a given API.

" }, "CreateDocumentationVersionRequest":{ "type":"structure", "required":[ "restApiId", "documentationVersion" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

[Required] Specifies the API identifier of the to-be-created documentation version.

", "location":"uri", "locationName":"restapi_id" }, "documentationVersion":{ "shape":"String", "documentation":"

[Required] The version identifier of the new snapshot.

" }, "stageName":{ "shape":"String", "documentation":"

The stage name to be associated with the new documentation snapshot.

" }, "description":{ "shape":"String", "documentation":"

A description about the new documentation snapshot.

" } }, "documentation":"

Creates a new documentation version of a given API.

" }, "CreateDomainNameRequest":{ "type":"structure", "required":[ "domainName", "certificateName", "certificateBody", "certificatePrivateKey", "certificateChain" ], "members":{ "domainName":{ "shape":"String", "documentation":"

The name of the DomainName resource.

" }, "certificateName":{ "shape":"String", "documentation":"

The name of the certificate.

" }, "certificateBody":{ "shape":"String", "documentation":"

The body of the server certificate provided by your certificate authority.

" }, "certificatePrivateKey":{ "shape":"String", "documentation":"

Your certificate's private key.

" }, "certificateChain":{ "shape":"String", "documentation":"

The intermediate certificates and optionally the root certificate, one after the other without any blank lines. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.

" } }, "documentation":"

A request to create a new domain name.

" }, "CreateModelRequest":{ "type":"structure", "required":[ "restApiId", "name", "contentType" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier under which the Model will be created.

", "location":"uri", "locationName":"restapi_id" }, "name":{ "shape":"String", "documentation":"

The name of the model.

" }, "description":{ "shape":"String", "documentation":"

The description of the model.

" }, "schema":{ "shape":"String", "documentation":"

The schema for the model. For application/json models, this should be JSON-schema draft v4 model.

" }, "contentType":{ "shape":"String", "documentation":"

The content-type for the model.

" } }, "documentation":"

Request to add a new Model to an existing RestApi resource.

" }, "CreateResourceRequest":{ "type":"structure", "required":[ "restApiId", "parentId", "pathPart" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The identifier of the RestApi for the resource.

", "location":"uri", "locationName":"restapi_id" }, "parentId":{ "shape":"String", "documentation":"

The parent resource's identifier.

", "location":"uri", "locationName":"parent_id" }, "pathPart":{ "shape":"String", "documentation":"

The last path segment for this resource.

" } }, "documentation":"

Requests Amazon API Gateway to create a Resource resource.

" }, "CreateRestApiRequest":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"String", "documentation":"

The name of the RestApi.

" }, "description":{ "shape":"String", "documentation":"

The description of the RestApi.

" }, "version":{ "shape":"String", "documentation":"

A version identifier for the API.

" }, "cloneFrom":{ "shape":"String", "documentation":"

The ID of the RestApi that you want to clone from.

" }, "binaryMediaTypes":{ "shape":"ListOfString", "documentation":"

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

" } }, "documentation":"

The POST Request to add a new RestApi resource to your collection.

" }, "CreateStageRequest":{ "type":"structure", "required":[ "restApiId", "stageName", "deploymentId" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The identifier of the RestApi resource for the Stage resource to create.

", "location":"uri", "locationName":"restapi_id" }, "stageName":{ "shape":"String", "documentation":"

The name for the Stage resource.

" }, "deploymentId":{ "shape":"String", "documentation":"

The identifier of the Deployment resource for the Stage resource.

" }, "description":{ "shape":"String", "documentation":"

The description of the Stage resource.

" }, "cacheClusterEnabled":{ "shape":"Boolean", "documentation":"

Whether cache clustering is enabled for the stage.

" }, "cacheClusterSize":{ "shape":"CacheClusterSize", "documentation":"

The stage's cache cluster size.

" }, "variables":{ "shape":"MapOfStringToString", "documentation":"

A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

" }, "documentationVersion":{ "shape":"String", "documentation":"

The version of the associated API documentation.

" } }, "documentation":"

Requests Amazon API Gateway to create a Stage resource.

" }, "CreateUsagePlanKeyRequest":{ "type":"structure", "required":[ "usagePlanId", "keyId", "keyType" ], "members":{ "usagePlanId":{ "shape":"String", "documentation":"

The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.

", "location":"uri", "locationName":"usageplanId" }, "keyId":{ "shape":"String", "documentation":"

The identifier of a UsagePlanKey resource for a plan customer.

" }, "keyType":{ "shape":"String", "documentation":"

The type of a UsagePlanKey resource for a plan customer.

" } }, "documentation":"

The POST request to create a usage plan key for adding an existing API key to a usage plan.

" }, "CreateUsagePlanRequest":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"String", "documentation":"

The name of the usage plan.

" }, "description":{ "shape":"String", "documentation":"

The description of the usage plan.

" }, "apiStages":{ "shape":"ListOfApiStage", "documentation":"

The associated API stages of the usage plan.

" }, "throttle":{ "shape":"ThrottleSettings", "documentation":"

The throttling limits of the usage plan.

" }, "quota":{ "shape":"QuotaSettings", "documentation":"

The quota of the usage plan.

" } }, "documentation":"

The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.

" }, "DeleteApiKeyRequest":{ "type":"structure", "required":["apiKey"], "members":{ "apiKey":{ "shape":"String", "documentation":"

The identifier of the ApiKey resource to be deleted.

", "location":"uri", "locationName":"api_Key" } }, "documentation":"

A request to delete the ApiKey resource.

" }, "DeleteAuthorizerRequest":{ "type":"structure", "required":[ "restApiId", "authorizerId" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier for the Authorizer resource.

", "location":"uri", "locationName":"restapi_id" }, "authorizerId":{ "shape":"String", "documentation":"

The identifier of the Authorizer resource.

", "location":"uri", "locationName":"authorizer_id" } }, "documentation":"

Request to delete an existing Authorizer resource.

" }, "DeleteBasePathMappingRequest":{ "type":"structure", "required":[ "domainName", "basePath" ], "members":{ "domainName":{ "shape":"String", "documentation":"

The domain name of the BasePathMapping resource to delete.

", "location":"uri", "locationName":"domain_name" }, "basePath":{ "shape":"String", "documentation":"

The base path name of the BasePathMapping resource to delete.

", "location":"uri", "locationName":"base_path" } }, "documentation":"

A request to delete the BasePathMapping resource.

" }, "DeleteClientCertificateRequest":{ "type":"structure", "required":["clientCertificateId"], "members":{ "clientCertificateId":{ "shape":"String", "documentation":"

The identifier of the ClientCertificate resource to be deleted.

", "location":"uri", "locationName":"clientcertificate_id" } }, "documentation":"

A request to delete the ClientCertificate resource.

" }, "DeleteDeploymentRequest":{ "type":"structure", "required":[ "restApiId", "deploymentId" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The identifier of the RestApi resource for the Deployment resource to delete.

", "location":"uri", "locationName":"restapi_id" }, "deploymentId":{ "shape":"String", "documentation":"

The identifier of the Deployment resource to delete.

", "location":"uri", "locationName":"deployment_id" } }, "documentation":"

Requests Amazon API Gateway to delete a Deployment resource.

" }, "DeleteDocumentationPartRequest":{ "type":"structure", "required":[ "restApiId", "documentationPartId" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

[Required] Specifies the identifier of an API of the to-be-deleted documentation part.

", "location":"uri", "locationName":"restapi_id" }, "documentationPartId":{ "shape":"String", "documentation":"

[Required] The identifier of the to-be-deleted documentation part.

", "location":"uri", "locationName":"part_id" } }, "documentation":"

Deletes an existing documentation part of an API.

" }, "DeleteDocumentationVersionRequest":{ "type":"structure", "required":[ "restApiId", "documentationVersion" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

[Required] The identifier of an API of a to-be-deleted documentation snapshot.

", "location":"uri", "locationName":"restapi_id" }, "documentationVersion":{ "shape":"String", "documentation":"

[Required] The version identifier of a to-be-deleted documentation snapshot.

", "location":"uri", "locationName":"doc_version" } }, "documentation":"

Deletes an existing documentation version of an API.

" }, "DeleteDomainNameRequest":{ "type":"structure", "required":["domainName"], "members":{ "domainName":{ "shape":"String", "documentation":"

The name of the DomainName resource to be deleted.

", "location":"uri", "locationName":"domain_name" } }, "documentation":"

A request to delete the DomainName resource.

" }, "DeleteIntegrationRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

Specifies a delete integration request's API identifier.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

Specifies a delete integration request's resource identifier.

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

Specifies a delete integration request's HTTP method.

", "location":"uri", "locationName":"http_method" } }, "documentation":"

Represents a delete integration request.

" }, "DeleteIntegrationResponseRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "statusCode" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

Specifies a delete integration response request's API identifier.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

Specifies a delete integration response request's resource identifier.

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

Specifies a delete integration response request's HTTP method.

", "location":"uri", "locationName":"http_method" }, "statusCode":{ "shape":"StatusCode", "documentation":"

Specifies a delete integration response request's status code.

", "location":"uri", "locationName":"status_code" } }, "documentation":"

Represents a delete integration response request.

" }, "DeleteMethodRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier for the Method resource.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

The Resource identifier for the Method resource.

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

The HTTP verb of the Method resource.

", "location":"uri", "locationName":"http_method" } }, "documentation":"

Request to delete an existing Method resource.

" }, "DeleteMethodResponseRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "statusCode" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier for the MethodResponse resource.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

The Resource identifier for the MethodResponse resource.

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

The HTTP verb of the Method resource.

", "location":"uri", "locationName":"http_method" }, "statusCode":{ "shape":"StatusCode", "documentation":"

The status code identifier for the MethodResponse resource.

", "location":"uri", "locationName":"status_code" } }, "documentation":"

A request to delete an existing MethodResponse resource.

" }, "DeleteModelRequest":{ "type":"structure", "required":[ "restApiId", "modelName" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi under which the model will be deleted.

", "location":"uri", "locationName":"restapi_id" }, "modelName":{ "shape":"String", "documentation":"

The name of the model to delete.

", "location":"uri", "locationName":"model_name" } }, "documentation":"

Request to delete an existing model in an existing RestApi resource.

" }, "DeleteResourceRequest":{ "type":"structure", "required":[ "restApiId", "resourceId" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier for the Resource resource.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

The identifier of the Resource resource.

", "location":"uri", "locationName":"resource_id" } }, "documentation":"

Request to delete a Resource.

" }, "DeleteRestApiRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "documentation":"

The ID of the RestApi you want to delete.

", "location":"uri", "locationName":"restapi_id" } }, "documentation":"

Request to delete the specified API from your collection.

" }, "DeleteStageRequest":{ "type":"structure", "required":[ "restApiId", "stageName" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The identifier of the RestApi resource for the Stage resource to delete.

", "location":"uri", "locationName":"restapi_id" }, "stageName":{ "shape":"String", "documentation":"

The name of the Stage resource to delete.

", "location":"uri", "locationName":"stage_name" } }, "documentation":"

Requests Amazon API Gateway to delete a Stage resource.

" }, "DeleteUsagePlanKeyRequest":{ "type":"structure", "required":[ "usagePlanId", "keyId" ], "members":{ "usagePlanId":{ "shape":"String", "documentation":"

The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

", "location":"uri", "locationName":"usageplanId" }, "keyId":{ "shape":"String", "documentation":"

The Id of the UsagePlanKey resource to be deleted.

", "location":"uri", "locationName":"keyId" } }, "documentation":"

The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.

" }, "DeleteUsagePlanRequest":{ "type":"structure", "required":["usagePlanId"], "members":{ "usagePlanId":{ "shape":"String", "documentation":"

The Id of the to-be-deleted usage plan.

", "location":"uri", "locationName":"usageplanId" } }, "documentation":"

The DELETE request to delete a uasge plan of a given plan Id.

" }, "Deployment":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The identifier for the deployment resource.

" }, "description":{ "shape":"String", "documentation":"

The description for the deployment resource.

" }, "createdDate":{ "shape":"Timestamp", "documentation":"

The date and time that the deployment resource was created.

" }, "apiSummary":{ "shape":"PathToMapOfMethodSnapshot", "documentation":"

A summary of the RestApi at the date and time that the deployment resource was created.

" } }, "documentation":"

An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.

To create a deployment, call POST on the Deployments resource of a RestApi. To view, update, or delete a deployment, call GET, PATCH, or DELETE on the specified deployment resource (/restapis/{restapi_id}/deployments/{deployment_id}).
RestApi, Deployments, Stage, AWS CLI, AWS SDKs
" }, "Deployments":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfDeployment", "documentation":"

The current page of any Deployment resources in the collection of deployment resources.

", "locationName":"item" } }, "documentation":"

Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.

To create a new deployment of a RestApi, make a POST request against this resource. To view, update, or delete an existing deployment, make a GET, PATCH, or DELETE request, respectively, on a specified Deployment resource.
Deploying an API, AWS CLI, AWS SDKs
" }, "DocumentationPart":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The DocumentationPart identifier, generated by Amazon API Gateway when the DocumentationPart is created.

" }, "location":{ "shape":"DocumentationPartLocation", "documentation":"

The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

" }, "properties":{ "shape":"String", "documentation":"

A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., \"{ \\\"description\\\": \\\"The API does ...\\\" }\". Only Swagger-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a Swagger extension of x-amazon-apigateway-documentation.

" } }, "documentation":"

A documentation part for a targeted API entity.

A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Valid location fields depend on the API entity type. All valid fields are not required.

The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.

Documenting an API, DocumentationParts
" }, "DocumentationPartIds":{ "type":"structure", "members":{ "ids":{ "shape":"ListOfString", "documentation":"

A list of the returned documentation part identifiers.

" }, "warnings":{ "shape":"ListOfString", "documentation":"

A list of warning messages reported during import of documentation parts.

" } }, "documentation":"

A collection of the imported DocumentationPart identifiers.

This is used to return the result when documentation parts in an external (e.g., Swagger) file are imported into Amazon API Gateway
Documenting an API, documentationpart:import, DocumentationPart
" }, "DocumentationPartLocation":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"DocumentationPartType", "documentation":"

The type of API entity to which the documentation content applies. It is a valid and required field for API entity types of API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not apply to any entity of the API, AUTHROZER, MODEL, or RESOURCE type.

" }, "path":{ "shape":"String", "documentation":"

The URL path of the target. It is a valid field for the API entity types of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix.

" }, "method":{ "shape":"String", "documentation":"

The HTTP verb of a method. It is a valid field for the API entity types of METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.

" }, "statusCode":{ "shape":"DocumentationPartLocationStatusCode", "documentation":"

The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.

" }, "name":{ "shape":"String", "documentation":"

The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any other entity type.

" } }, "documentation":"

Specifies the target API entity to which the documentation applies.

" }, "DocumentationPartLocationStatusCode":{ "type":"string", "pattern":"^([1-5]\\d\\d|\\*|\\s*)$" }, "DocumentationPartType":{ "type":"string", "enum":[ "API", "AUTHORIZER", "MODEL", "RESOURCE", "METHOD", "PATH_PARAMETER", "QUERY_PARAMETER", "REQUEST_HEADER", "REQUEST_BODY", "RESPONSE", "RESPONSE_HEADER", "RESPONSE_BODY" ] }, "DocumentationParts":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfDocumentationPart", "documentation":"

The current page of DocumentationPart resources in the DocumentationParts collection.

", "locationName":"item" } }, "documentation":"

The collection of documentation parts of an API.

Documenting an API, DocumentationPart
" }, "DocumentationVersion":{ "type":"structure", "members":{ "version":{ "shape":"String", "documentation":"

The version identifier of the API documentation snapshot.

" }, "createdDate":{ "shape":"Timestamp", "documentation":"

The date when the API documentation snapshot is created.

" }, "description":{ "shape":"String", "documentation":"

The description of the API documentation snapshot.

" } }, "documentation":"

A snapshot of the documentation of an API.

Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., Swagger) file.

Documenting an API, DocumentationPart, DocumentationVersions
" }, "DocumentationVersions":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfDocumentationVersion", "documentation":"

The current page of DocumentationVersion items from the DocumentationVersions collection of an API.

", "locationName":"item" } }, "documentation":"

The collection of documentation snapshots of an API.

Use the DocumentationVersions to manage documentation snapshots associated with various API stages.

Documenting an API, DocumentationPart, DocumentationVersion
" }, "DomainName":{ "type":"structure", "members":{ "domainName":{ "shape":"String", "documentation":"

The name of the DomainName resource.

" }, "certificateName":{ "shape":"String", "documentation":"

The name of the certificate.

" }, "certificateUploadDate":{ "shape":"Timestamp", "documentation":"

The date when the certificate was uploaded, in ISO 8601 format.

" }, "distributionDomainName":{ "shape":"String", "documentation":"

The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.

" } }, "documentation":"

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

Use Client-Side Certificate
" }, "DomainNames":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfDomainName", "documentation":"

The current page of any DomainName resources in the collection of DomainName resources.

", "locationName":"item" } }, "documentation":"

Represents a collection of DomainName resources.

Use Client-Side Certificate
" }, "Double":{"type":"double"}, "ExportResponse":{ "type":"structure", "members":{ "contentType":{ "shape":"String", "documentation":"

The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.

", "location":"header", "locationName":"Content-Type" }, "contentDisposition":{ "shape":"String", "documentation":"

The content-disposition header value in the HTTP response.

", "location":"header", "locationName":"Content-Disposition" }, "body":{ "shape":"Blob", "documentation":"

The binary blob response to GetExport, which contains the export.

" } }, "documentation":"

The binary blob response to GetExport, which contains the generated SDK.

", "payload":"body" }, "FlushStageAuthorizersCacheRequest":{ "type":"structure", "required":[ "restApiId", "stageName" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The API identifier of the stage to flush.

", "location":"uri", "locationName":"restapi_id" }, "stageName":{ "shape":"String", "documentation":"

The name of the stage to flush.

", "location":"uri", "locationName":"stage_name" } }, "documentation":"

Request to flush authorizer cache entries on a specified stage.

" }, "FlushStageCacheRequest":{ "type":"structure", "required":[ "restApiId", "stageName" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The API identifier of the stage to flush its cache.

", "location":"uri", "locationName":"restapi_id" }, "stageName":{ "shape":"String", "documentation":"

The name of the stage to flush its cache.

", "location":"uri", "locationName":"stage_name" } }, "documentation":"

Requests Amazon API Gateway to flush a stage's cache.

" }, "GenerateClientCertificateRequest":{ "type":"structure", "members":{ "description":{ "shape":"String", "documentation":"

The description of the ClientCertificate.

" } }, "documentation":"

A request to generate a ClientCertificate resource.

" }, "GetAccountRequest":{ "type":"structure", "members":{ }, "documentation":"

Requests Amazon API Gateway to get information about the current Account resource.

" }, "GetApiKeyRequest":{ "type":"structure", "required":["apiKey"], "members":{ "apiKey":{ "shape":"String", "documentation":"

The identifier of the ApiKey resource.

", "location":"uri", "locationName":"api_Key" }, "includeValue":{ "shape":"NullableBoolean", "documentation":"

A boolean flag to specify whether (true) or not (false) the result contains the key value.

", "location":"querystring", "locationName":"includeValue" } }, "documentation":"

A request to get information about the current ApiKey resource.

" }, "GetApiKeysRequest":{ "type":"structure", "members":{ "position":{ "shape":"String", "documentation":"

The position of the current ApiKeys resource to get information about.

", "location":"querystring", "locationName":"position" }, "limit":{ "shape":"NullableInteger", "documentation":"

The maximum number of ApiKeys to get information about.

", "location":"querystring", "locationName":"limit" }, "nameQuery":{ "shape":"String", "documentation":"

The name of queried API keys.

", "location":"querystring", "locationName":"name" }, "customerId":{ "shape":"String", "documentation":"

The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.

", "location":"querystring", "locationName":"customerId" }, "includeValues":{ "shape":"NullableBoolean", "documentation":"

A boolean flag to specify whether (true) or not (false) the result contains key values.

", "location":"querystring", "locationName":"includeValues" } }, "documentation":"

A request to get information about the current ApiKeys resource.

" }, "GetAuthorizerRequest":{ "type":"structure", "required":[ "restApiId", "authorizerId" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier for the Authorizer resource.

", "location":"uri", "locationName":"restapi_id" }, "authorizerId":{ "shape":"String", "documentation":"

The identifier of the Authorizer resource.

", "location":"uri", "locationName":"authorizer_id" } }, "documentation":"

Request to describe an existing Authorizer resource.

" }, "GetAuthorizersRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier for the Authorizers resource.

", "location":"uri", "locationName":"restapi_id" }, "position":{ "shape":"String", "documentation":"

If not all Authorizer resources in the response were present, the position will specify where to start the next page of results.

", "location":"querystring", "locationName":"position" }, "limit":{ "shape":"NullableInteger", "documentation":"

Limit the number of Authorizer resources in the response.

", "location":"querystring", "locationName":"limit" } }, "documentation":"

Request to describe an existing Authorizers resource.

" }, "GetBasePathMappingRequest":{ "type":"structure", "required":[ "domainName", "basePath" ], "members":{ "domainName":{ "shape":"String", "documentation":"

The domain name of the BasePathMapping resource to be described.

", "location":"uri", "locationName":"domain_name" }, "basePath":{ "shape":"String", "documentation":"

The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify any base path name after the domain name.

", "location":"uri", "locationName":"base_path" } }, "documentation":"

Request to describe a BasePathMapping resource.

" }, "GetBasePathMappingsRequest":{ "type":"structure", "required":["domainName"], "members":{ "domainName":{ "shape":"String", "documentation":"

The domain name of a BasePathMapping resource.

", "location":"uri", "locationName":"domain_name" }, "position":{ "shape":"String", "documentation":"

The position of the current BasePathMapping resource in the collection to get information about.

", "location":"querystring", "locationName":"position" }, "limit":{ "shape":"NullableInteger", "documentation":"

The maximum number of BasePathMapping resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.

", "location":"querystring", "locationName":"limit" } }, "documentation":"

A request to get information about a collection of BasePathMapping resources.

" }, "GetClientCertificateRequest":{ "type":"structure", "required":["clientCertificateId"], "members":{ "clientCertificateId":{ "shape":"String", "documentation":"

The identifier of the ClientCertificate resource to be described.

", "location":"uri", "locationName":"clientcertificate_id" } }, "documentation":"

A request to get information about the current ClientCertificate resource.

" }, "GetClientCertificatesRequest":{ "type":"structure", "members":{ "position":{ "shape":"String", "documentation":"

The position of the current ClientCertificate resource in the collection to get information about.

", "location":"querystring", "locationName":"position" }, "limit":{ "shape":"NullableInteger", "documentation":"

The maximum number of ClientCertificate resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.

", "location":"querystring", "locationName":"limit" } }, "documentation":"

A request to get information about a collection of ClientCertificate resources.

" }, "GetDeploymentRequest":{ "type":"structure", "required":[ "restApiId", "deploymentId" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The identifier of the RestApi resource for the Deployment resource to get information about.

", "location":"uri", "locationName":"restapi_id" }, "deploymentId":{ "shape":"String", "documentation":"

The identifier of the Deployment resource to get information about.

", "location":"uri", "locationName":"deployment_id" } }, "documentation":"

Requests Amazon API Gateway to get information about a Deployment resource.

" }, "GetDeploymentsRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "documentation":"

The identifier of the RestApi resource for the collection of Deployment resources to get information about.

", "location":"uri", "locationName":"restapi_id" }, "position":{ "shape":"String", "documentation":"

The position of the current Deployment resource in the collection to get information about.

", "location":"querystring", "locationName":"position" }, "limit":{ "shape":"NullableInteger", "documentation":"

The maximum number of Deployment resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.

", "location":"querystring", "locationName":"limit" } }, "documentation":"

Requests Amazon API Gateway to get information about a Deployments collection.

" }, "GetDocumentationPartRequest":{ "type":"structure", "required":[ "restApiId", "documentationPartId" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

[Required] The identifier of an API of the to-be-retrieved documentation part.

", "location":"uri", "locationName":"restapi_id" }, "documentationPartId":{ "shape":"String", "documentation":"

[Required] The identifier of the to-be-retrieved documentation part.

", "location":"uri", "locationName":"part_id" } }, "documentation":"

Gets a specified documentation part of a given API.

" }, "GetDocumentationPartsRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "documentation":"

[Required] The identifier of the API of the to-be-retrieved documentation parts.

", "location":"uri", "locationName":"restapi_id" }, "type":{ "shape":"DocumentationPartType", "documentation":"

The type of API entities of the to-be-retrieved documentation parts.

", "location":"querystring", "locationName":"type" }, "nameQuery":{ "shape":"String", "documentation":"

The name of API entities of the to-be-retrieved documentation parts.

", "location":"querystring", "locationName":"name" }, "path":{ "shape":"String", "documentation":"

The path of API entities of the to-be-retrieved documentation parts.

", "location":"querystring", "locationName":"path" }, "position":{ "shape":"String", "documentation":"

The position of the to-be-retrieved documentation part in the DocumentationParts collection.

", "location":"querystring", "locationName":"position" }, "limit":{ "shape":"NullableInteger", "documentation":"

The size of the paged results.

", "location":"querystring", "locationName":"limit" } }, "documentation":"

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

" }, "GetDocumentationVersionRequest":{ "type":"structure", "required":[ "restApiId", "documentationVersion" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

[Required] The identifier of the API of the to-be-retrieved documentation snapshot.

", "location":"uri", "locationName":"restapi_id" }, "documentationVersion":{ "shape":"String", "documentation":"

[Required] The version identifier of the to-be-retrieved documentation snapshot.

", "location":"uri", "locationName":"doc_version" } }, "documentation":"

Gets a documentation snapshot of an API.

" }, "GetDocumentationVersionsRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "documentation":"

[Required] The identifier of an API of the to-be-retrieved documentation versions.

", "location":"uri", "locationName":"restapi_id" }, "position":{ "shape":"String", "documentation":"

The position of the returned DocumentationVersion in the DocumentationVersions collection.

", "location":"querystring", "locationName":"position" }, "limit":{ "shape":"NullableInteger", "documentation":"

The page size of the returned documentation versions.

", "location":"querystring", "locationName":"limit" } }, "documentation":"

Gets the documentation versions of an API.

" }, "GetDomainNameRequest":{ "type":"structure", "required":["domainName"], "members":{ "domainName":{ "shape":"String", "documentation":"

The name of the DomainName resource.

", "location":"uri", "locationName":"domain_name" } }, "documentation":"

Request to get the name of a DomainName resource.

" }, "GetDomainNamesRequest":{ "type":"structure", "members":{ "position":{ "shape":"String", "documentation":"

The position of the current domain names to get information about.

", "location":"querystring", "locationName":"position" }, "limit":{ "shape":"NullableInteger", "documentation":"

The maximum number of DomainName resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.

", "location":"querystring", "locationName":"limit" } }, "documentation":"

Request to describe a collection of DomainName resources.

" }, "GetExportRequest":{ "type":"structure", "required":[ "restApiId", "stageName", "exportType" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The identifier of the RestApi to be exported.

", "location":"uri", "locationName":"restapi_id" }, "stageName":{ "shape":"String", "documentation":"

The name of the Stage that will be exported.

", "location":"uri", "locationName":"stage_name" }, "exportType":{ "shape":"String", "documentation":"

The type of export. Currently only 'swagger' is supported.

", "location":"uri", "locationName":"export_type" }, "parameters":{ "shape":"MapOfStringToString", "documentation":"

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType swagger, any combination of the following parameters are supported: integrations will export the API with x-amazon-apigateway-integration extensions. authorizers will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

", "location":"querystring" }, "accepts":{ "shape":"String", "documentation":"

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType of swagger. This should be specified in the Accept header for direct API requests.

", "location":"header", "locationName":"Accept" } }, "documentation":"

Request a new export of a RestApi for a particular Stage.

" }, "GetIntegrationRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

Specifies a get integration request's API identifier.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

Specifies a get integration request's resource identifier

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

Specifies a get integration request's HTTP method.

", "location":"uri", "locationName":"http_method" } }, "documentation":"

Represents a get integration request.

" }, "GetIntegrationResponseRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "statusCode" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

Specifies a get integration response request's API identifier.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

Specifies a get integration response request's resource identifier.

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

Specifies a get integration response request's HTTP method.

", "location":"uri", "locationName":"http_method" }, "statusCode":{ "shape":"StatusCode", "documentation":"

Specifies a get integration response request's status code.

", "location":"uri", "locationName":"status_code" } }, "documentation":"

Represents a get integration response request.

" }, "GetMethodRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier for the Method resource.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

The Resource identifier for the Method resource.

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

Specifies the method request's HTTP method type.

", "location":"uri", "locationName":"http_method" } }, "documentation":"

Request to describe an existing Method resource.

" }, "GetMethodResponseRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "statusCode" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier for the MethodResponse resource.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

The Resource identifier for the MethodResponse resource.

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

The HTTP verb of the Method resource.

", "location":"uri", "locationName":"http_method" }, "statusCode":{ "shape":"StatusCode", "documentation":"

The status code for the MethodResponse resource.

", "location":"uri", "locationName":"status_code" } }, "documentation":"

Request to describe a MethodResponse resource.

" }, "GetModelRequest":{ "type":"structure", "required":[ "restApiId", "modelName" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier under which the Model exists.

", "location":"uri", "locationName":"restapi_id" }, "modelName":{ "shape":"String", "documentation":"

The name of the model as an identifier.

", "location":"uri", "locationName":"model_name" }, "flatten":{ "shape":"Boolean", "documentation":"

A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.

", "location":"querystring", "locationName":"flatten" } }, "documentation":"

Request to list information about a model in an existing RestApi resource.

" }, "GetModelTemplateRequest":{ "type":"structure", "required":[ "restApiId", "modelName" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The ID of the RestApi under which the model exists.

", "location":"uri", "locationName":"restapi_id" }, "modelName":{ "shape":"String", "documentation":"

The name of the model for which to generate a template.

", "location":"uri", "locationName":"model_name" } }, "documentation":"

Request to generate a sample mapping template used to transform the payload.

" }, "GetModelsRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier.

", "location":"uri", "locationName":"restapi_id" }, "position":{ "shape":"String", "documentation":"

The position of the next set of results in the Models resource to get information about.

", "location":"querystring", "locationName":"position" }, "limit":{ "shape":"NullableInteger", "documentation":"

The maximum number of models in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.

", "location":"querystring", "locationName":"limit" } }, "documentation":"

Request to list existing Models defined for a RestApi resource.

" }, "GetResourceRequest":{ "type":"structure", "required":[ "restApiId", "resourceId" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier for the resource.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

The identifier for the Resource resource.

", "location":"uri", "locationName":"resource_id" } }, "documentation":"

Request to list information about a resource.

" }, "GetResourcesRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier for the Resource.

", "location":"uri", "locationName":"restapi_id" }, "position":{ "shape":"String", "documentation":"

The position of the next set of results in the current Resources resource to get information about.

", "location":"querystring", "locationName":"position" }, "limit":{ "shape":"NullableInteger", "documentation":"

The maximum number of Resource resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.

", "location":"querystring", "locationName":"limit" } }, "documentation":"

Request to list information about a collection of resources.

" }, "GetRestApiRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "documentation":"

The identifier of the RestApi resource.

", "location":"uri", "locationName":"restapi_id" } }, "documentation":"

The GET request to list an existing RestApi defined for your collection.

" }, "GetRestApisRequest":{ "type":"structure", "members":{ "position":{ "shape":"String", "documentation":"

The position of the current RestApis resource in the collection to get information about.

", "location":"querystring", "locationName":"position" }, "limit":{ "shape":"NullableInteger", "documentation":"

The maximum number of RestApi resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.

", "location":"querystring", "locationName":"limit" } }, "documentation":"

The GET request to list existing RestApis defined for your collection.

" }, "GetSdkRequest":{ "type":"structure", "required":[ "restApiId", "stageName", "sdkType" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The identifier of the RestApi that the SDK will use.

", "location":"uri", "locationName":"restapi_id" }, "stageName":{ "shape":"String", "documentation":"

The name of the Stage that the SDK will use.

", "location":"uri", "locationName":"stage_name" }, "sdkType":{ "shape":"String", "documentation":"

The language for the generated SDK. Currently javascript, android, and objectivec (for iOS) are supported.

", "location":"uri", "locationName":"sdk_type" }, "parameters":{ "shape":"MapOfStringToString", "documentation":"

A key-value map of query string parameters that specify properties of the SDK, depending on the requested sdkType. For sdkType of objectivec, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required.

", "location":"querystring" } }, "documentation":"

Request a new generated client SDK for a RestApi and Stage.

" }, "GetSdkTypeRequest":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"String", "documentation":"

The identifier of the queried SdkType instance.

", "location":"uri", "locationName":"sdktype_id" } }, "documentation":"

Get an SdkType instance.

" }, "GetSdkTypesRequest":{ "type":"structure", "members":{ "position":{ "shape":"String", "documentation":"

The position of the last fetched element in the SdkTypes collection.

", "location":"querystring", "locationName":"position" }, "limit":{ "shape":"NullableInteger", "documentation":"

The maximum number of SdkType instances to be returned.

", "location":"querystring", "locationName":"limit" } }, "documentation":"

Get the SdkTypes collection.

" }, "GetStageRequest":{ "type":"structure", "required":[ "restApiId", "stageName" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The identifier of the RestApi resource for the Stage resource to get information about.

", "location":"uri", "locationName":"restapi_id" }, "stageName":{ "shape":"String", "documentation":"

The name of the Stage resource to get information about.

", "location":"uri", "locationName":"stage_name" } }, "documentation":"

Requests Amazon API Gateway to get information about a Stage resource.

" }, "GetStagesRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "documentation":"

The stages' API identifiers.

", "location":"uri", "locationName":"restapi_id" }, "deploymentId":{ "shape":"String", "documentation":"

The stages' deployment identifiers.

", "location":"querystring", "locationName":"deploymentId" } }, "documentation":"

Requests Amazon API Gateway to get information about one or more Stage resources.

" }, "GetUsagePlanKeyRequest":{ "type":"structure", "required":[ "usagePlanId", "keyId" ], "members":{ "usagePlanId":{ "shape":"String", "documentation":"

The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

", "location":"uri", "locationName":"usageplanId" }, "keyId":{ "shape":"String", "documentation":"

The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

", "location":"uri", "locationName":"keyId" } }, "documentation":"

The GET request to get a usage plan key of a given key identifier.

" }, "GetUsagePlanKeysRequest":{ "type":"structure", "required":["usagePlanId"], "members":{ "usagePlanId":{ "shape":"String", "documentation":"

The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

", "location":"uri", "locationName":"usageplanId" }, "position":{ "shape":"String", "documentation":"

A query parameter specifying the zero-based index specifying the position of a usage plan key.

", "location":"querystring", "locationName":"position" }, "limit":{ "shape":"NullableInteger", "documentation":"

A query parameter specifying the maximum number usage plan keys returned by the GET request.

", "location":"querystring", "locationName":"limit" }, "nameQuery":{ "shape":"String", "documentation":"

A query parameter specifying the name of the to-be-returned usage plan keys.

", "location":"querystring", "locationName":"name" } }, "documentation":"

The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

" }, "GetUsagePlanRequest":{ "type":"structure", "required":["usagePlanId"], "members":{ "usagePlanId":{ "shape":"String", "documentation":"

The identifier of the UsagePlan resource to be retrieved.

", "location":"uri", "locationName":"usageplanId" } }, "documentation":"

The GET request to get a usage plan of a given plan identifier.

" }, "GetUsagePlansRequest":{ "type":"structure", "members":{ "position":{ "shape":"String", "documentation":"

The zero-based array index specifying the position of the to-be-retrieved UsagePlan resource.

", "location":"querystring", "locationName":"position" }, "keyId":{ "shape":"String", "documentation":"

The identifier of the API key associated with the usage plans.

", "location":"querystring", "locationName":"keyId" }, "limit":{ "shape":"NullableInteger", "documentation":"

The number of UsagePlan resources to be returned as the result.

", "location":"querystring", "locationName":"limit" } }, "documentation":"

The GET request to get all the usage plans of the caller's account.

" }, "GetUsageRequest":{ "type":"structure", "required":[ "usagePlanId", "startDate", "endDate" ], "members":{ "usagePlanId":{ "shape":"String", "documentation":"

The Id of the usage plan associated with the usage data.

", "location":"uri", "locationName":"usageplanId" }, "keyId":{ "shape":"String", "documentation":"

The Id of the API key associated with the resultant usage data.

", "location":"querystring", "locationName":"keyId" }, "startDate":{ "shape":"String", "documentation":"

The starting date (e.g., 2016-01-01) of the usage data.

", "location":"querystring", "locationName":"startDate" }, "endDate":{ "shape":"String", "documentation":"

The ending date (e.g., 2016-12-31) of the usage data.

", "location":"querystring", "locationName":"endDate" }, "position":{ "shape":"String", "documentation":"

Position

", "location":"querystring", "locationName":"position" }, "limit":{ "shape":"NullableInteger", "documentation":"

The maximum number of results to be returned.

", "location":"querystring", "locationName":"limit" } }, "documentation":"

The GET request to get the usage data of a usage plan in a specified time interval.

" }, "ImportApiKeysRequest":{ "type":"structure", "required":[ "body", "format" ], "members":{ "body":{ "shape":"Blob", "documentation":"

The payload of the POST request to import API keys. For the payload format, see API Key File Format.

" }, "format":{ "shape":"ApiKeysFormat", "documentation":"

A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

", "location":"querystring", "locationName":"format" }, "failOnWarnings":{ "shape":"Boolean", "documentation":"

A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.

", "location":"querystring", "locationName":"failonwarnings" } }, "documentation":"

The POST request to import API keys from an external source, such as a CSV-formatted file.

", "payload":"body" }, "ImportDocumentationPartsRequest":{ "type":"structure", "required":[ "restApiId", "body" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

[Required] The identifier of an API of the to-be-imported documentation parts.

", "location":"uri", "locationName":"restapi_id" }, "mode":{ "shape":"PutMode", "documentation":"

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

", "location":"querystring", "locationName":"mode" }, "failOnWarnings":{ "shape":"Boolean", "documentation":"

A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.

", "location":"querystring", "locationName":"failonwarnings" }, "body":{ "shape":"Blob", "documentation":"

[Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.

" } }, "documentation":"

Import documentation parts from an external (e.g., Swagger) definition file.

", "payload":"body" }, "ImportRestApiRequest":{ "type":"structure", "required":["body"], "members":{ "failOnWarnings":{ "shape":"Boolean", "documentation":"

A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

", "location":"querystring", "locationName":"failonwarnings" }, "parameters":{ "shape":"MapOfStringToString", "documentation":"

Custom header parameters as part of the request.

", "location":"querystring" }, "body":{ "shape":"Blob", "documentation":"

The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported.

" } }, "documentation":"

A POST request to import an API to Amazon API Gateway using an input of an API definition file.

", "payload":"body" }, "Integer":{"type":"integer"}, "Integration":{ "type":"structure", "members":{ "type":{ "shape":"IntegrationType", "documentation":"

Specifies the integration's type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.

" }, "httpMethod":{ "shape":"String", "documentation":"

Specifies the integration's HTTP method type.

" }, "uri":{ "shape":"String", "documentation":"

Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification. For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}. Region, subdomain and service are used to determine the right endpoint. For AWS services that use the Action= query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /.

" }, "credentials":{ "shape":"String", "documentation":"

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\\*:user/\\*. To use resource-based permissions on supported AWS services, specify null.

" }, "requestParameters":{ "shape":"MapOfStringToString", "documentation":"

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

" }, "requestTemplates":{ "shape":"MapOfStringToString", "documentation":"

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

" }, "passthroughBehavior":{ "shape":"String", "documentation":"

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

  • WHEN_NO_MATCH passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
" }, "contentHandling":{ "shape":"ContentHandlingStrategy", "documentation":"

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.

" }, "cacheNamespace":{ "shape":"String", "documentation":"

Specifies the integration's cache namespace.

" }, "cacheKeyParameters":{ "shape":"ListOfString", "documentation":"

Specifies the integration's cache key parameters.

" }, "integrationResponses":{ "shape":"MapOfIntegrationResponse", "documentation":"

Specifies the integration's responses.

Example: Get integration responses of a method

Request

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns 200 OK status and a payload as follows:

{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"title\": \"200\" }, \"integrationresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" }, \"integrationresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" } }, \"responseParameters\": { \"method.response.header.Content-Type\": \"'application/xml'\" }, \"responseTemplates\": { \"application/json\": \"$util.urlDecode(\\\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\\\")\\n\" }, \"statusCode\": \"200\" }

Creating an API
" } }, "documentation":"

Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

In the API Gateway console, the built-in Lambda integration is an AWS integration.
Creating an API
" }, "IntegrationResponse":{ "type":"structure", "members":{ "statusCode":{ "shape":"StatusCode", "documentation":"

Specifies the status code that is used to map the integration response to an existing MethodResponse.

" }, "selectionPattern":{ "shape":"String", "documentation":"

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

" }, "responseParameters":{ "shape":"MapOfStringToString", "documentation":"

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

" }, "responseTemplates":{ "shape":"MapOfStringToString", "documentation":"

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

" }, "contentHandling":{ "shape":"ContentHandlingStrategy", "documentation":"

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

" } }, "documentation":"

Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.

Creating an API
" }, "IntegrationType":{ "type":"string", "documentation":"

The integration type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.

", "enum":[ "HTTP", "AWS", "MOCK", "HTTP_PROXY", "AWS_PROXY" ] }, "LimitExceededException":{ "type":"structure", "members":{ "retryAfterSeconds":{ "shape":"String", "location":"header", "locationName":"Retry-After" }, "message":{"shape":"String"} }, "error":{"httpStatusCode":429}, "exception":true }, "ListOfARNs":{ "type":"list", "member":{"shape":"ProviderARN"} }, "ListOfApiKey":{ "type":"list", "member":{"shape":"ApiKey"} }, "ListOfApiStage":{ "type":"list", "member":{"shape":"ApiStage"} }, "ListOfAuthorizer":{ "type":"list", "member":{"shape":"Authorizer"} }, "ListOfBasePathMapping":{ "type":"list", "member":{"shape":"BasePathMapping"} }, "ListOfClientCertificate":{ "type":"list", "member":{"shape":"ClientCertificate"} }, "ListOfDeployment":{ "type":"list", "member":{"shape":"Deployment"} }, "ListOfDocumentationPart":{ "type":"list", "member":{"shape":"DocumentationPart"} }, "ListOfDocumentationVersion":{ "type":"list", "member":{"shape":"DocumentationVersion"} }, "ListOfDomainName":{ "type":"list", "member":{"shape":"DomainName"} }, "ListOfLong":{ "type":"list", "member":{"shape":"Long"} }, "ListOfModel":{ "type":"list", "member":{"shape":"Model"} }, "ListOfPatchOperation":{ "type":"list", "member":{"shape":"PatchOperation"}, "documentation":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list." }, "ListOfResource":{ "type":"list", "member":{"shape":"Resource"} }, "ListOfRestApi":{ "type":"list", "member":{"shape":"RestApi"} }, "ListOfSdkConfigurationProperty":{ "type":"list", "member":{"shape":"SdkConfigurationProperty"} }, "ListOfSdkType":{ "type":"list", "member":{"shape":"SdkType"} }, "ListOfStage":{ "type":"list", "member":{"shape":"Stage"} }, "ListOfStageKeys":{ "type":"list", "member":{"shape":"StageKey"} }, "ListOfString":{ "type":"list", "member":{"shape":"String"} }, "ListOfUsage":{ "type":"list", "member":{"shape":"ListOfLong"} }, "ListOfUsagePlan":{ "type":"list", "member":{"shape":"UsagePlan"} }, "ListOfUsagePlanKey":{ "type":"list", "member":{"shape":"UsagePlanKey"} }, "Long":{"type":"long"}, "MapOfHeaderValues":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "MapOfIntegrationResponse":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"IntegrationResponse"} }, "MapOfKeyUsages":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"ListOfUsage"} }, "MapOfMethod":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"Method"} }, "MapOfMethodResponse":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"MethodResponse"} }, "MapOfMethodSettings":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"MethodSetting"} }, "MapOfMethodSnapshot":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"MethodSnapshot"} }, "MapOfStringToBoolean":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"NullableBoolean"} }, "MapOfStringToList":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"ListOfString"} }, "MapOfStringToString":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "Method":{ "type":"structure", "members":{ "httpMethod":{ "shape":"String", "documentation":"

The method's HTTP verb.

" }, "authorizationType":{ "shape":"String", "documentation":"

The method's authorization type.

" }, "authorizerId":{ "shape":"String", "documentation":"

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

" }, "apiKeyRequired":{ "shape":"NullableBoolean", "documentation":"

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

" }, "operationName":{ "shape":"String", "documentation":"

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in PetStore example.

" }, "requestParameters":{ "shape":"MapOfStringToBoolean", "documentation":"

A key-value map defining required or optional method request parameters that can be accepted by Amazon API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

" }, "requestModels":{ "shape":"MapOfStringToString", "documentation":"

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

" }, "methodResponses":{ "shape":"MapOfMethodResponse", "documentation":"

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request

GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\", \"name\": \"methodresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\", \"title\": \"200\" }, \"methodresponse:delete\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\" }, \"methodresponse:update\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\" } }, \"responseModels\": { \"application/json\": \"Empty\" }, \"responseParameters\": { \"method.response.header.operator\": false, \"method.response.header.operand_2\": false, \"method.response.header.operand_1\": false }, \"statusCode\": \"200\" }

AWS CLI
" }, "methodIntegration":{ "shape":"Integration", "documentation":"

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Example:

Request

GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ \"_links\": { \"curies\": [ { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true } ], \"self\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\" }, \"integration:delete\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\" }, \"integration:responses\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integration:update\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\" }, \"integrationresponse:put\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}\", \"templated\": true } }, \"cacheKeyParameters\": [], \"cacheNamespace\": \"0cjtch\", \"credentials\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\", \"httpMethod\": \"POST\", \"passthroughBehavior\": \"WHEN_NO_MATCH\", \"requestTemplates\": { \"application/json\": \"{\\n \\\"a\\\": \\\"$input.params('operand1')\\\",\\n \\\"b\\\": \\\"$input.params('operand2')\\\", \\n \\\"op\\\": \\\"$input.params('operator')\\\" \\n}\" }, \"type\": \"AWS\", \"uri\": \"arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations\", \"_embedded\": { \"integration:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integrationresponse:delete\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\" }, \"integrationresponse:update\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\" } }, \"responseParameters\": { \"method.response.header.operator\": \"integration.response.body.op\", \"method.response.header.operand_2\": \"integration.response.body.b\", \"method.response.header.operand_1\": \"integration.response.body.a\" }, \"responseTemplates\": { \"application/json\": \"#set($res = $input.path('$'))\\n{\\n \\\"result\\\": \\\"$res.a, $res.b, $res.op => $res.c\\\",\\n \\\"a\\\" : \\\"$res.a\\\",\\n \\\"b\\\" : \\\"$res.b\\\",\\n \\\"op\\\" : \\\"$res.op\\\",\\n \\\"c\\\" : \\\"$res.c\\\"\\n}\" }, \"selectionPattern\": \"\", \"statusCode\": \"200\" } } }

AWS CLI
" } }, "documentation":"

Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.

Example: Retrive the GET method on a specified resource

Request

The following example request retrieves the information about the GET method on an API resource (3kzxbg5sa2) of an API (fugvjdxtri). 

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ \"_links\": { \"curies\": [ { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html\", \"name\": \"method\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\", \"name\": \"methodresponse\", \"templated\": true } ], \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\", \"name\": \"GET\", \"title\": \"GET\" }, \"integration:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"method:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\" }, \"method:integration\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"method:responses\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"method:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\" }, \"methodresponse:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}\", \"templated\": true } }, \"apiKeyRequired\": true, \"authorizationType\": \"NONE\", \"httpMethod\": \"GET\", \"_embedded\": { \"method:integration\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integration:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integration:responses\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integration:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integrationresponse:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}\", \"templated\": true } }, \"cacheKeyParameters\": [], \"cacheNamespace\": \"3kzxbg5sa2\", \"credentials\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\", \"httpMethod\": \"POST\", \"passthroughBehavior\": \"WHEN_NO_MATCH\", \"requestParameters\": { \"integration.request.header.Content-Type\": \"'application/x-amz-json-1.1'\" }, \"requestTemplates\": { \"application/json\": \"{\\n}\" }, \"type\": \"AWS\", \"uri\": \"arn:aws:apigateway:us-east-1:kinesis:action/ListStreams\", \"_embedded\": { \"integration:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integrationresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" }, \"integrationresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" } }, \"responseParameters\": { \"method.response.header.Content-Type\": \"'application/xml'\" }, \"responseTemplates\": { \"application/json\": \"$util.urlDecode(\\\"%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E\\\")\" }, \"statusCode\": \"200\" } } }, \"method:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"methodresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" }, \"methodresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" } }, \"responseModels\": { \"application/json\": \"Empty\" }, \"responseParameters\": { \"method.response.header.Content-Type\": false }, \"statusCode\": \"200\" } } }

In the example above, the response template for the 200 OK response maps the JSON output from the ListStreams action in the back end to an XML output. The mapping template is URL-encoded as %3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E and the output is decoded using the $util.urlDecode() helper function.

MethodResponse, Integration, IntegrationResponse, Resource, Set up an API's method
" }, "MethodResponse":{ "type":"structure", "members":{ "statusCode":{ "shape":"StatusCode", "documentation":"

The method response's status code.

" }, "responseParameters":{ "shape":"MapOfStringToBoolean", "documentation":"

A key-value map specifying required or optional response parameters that Amazon API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. Amazon API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

" }, "responseModels":{ "shape":"MapOfStringToString", "documentation":"

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

" } }, "documentation":"

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

Example: A MethodResponse instance of an API

Request

The example request retrieves a MethodResponse of the 200 status code.

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns 200 OK status and a payload as follows:

{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\", \"name\": \"methodresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"title\": \"200\" }, \"methodresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" }, \"methodresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" } }, \"responseModels\": { \"application/json\": \"Empty\" }, \"responseParameters\": { \"method.response.header.Content-Type\": false }, \"statusCode\": \"200\" }

Method, IntegrationResponse, Integration Creating an API
" }, "MethodSetting":{ "type":"structure", "members":{ "metricsEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.

" }, "loggingLevel":{ "shape":"String", "documentation":"

Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO.

" }, "dataTraceEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.

" }, "throttlingBurstLimit":{ "shape":"Integer", "documentation":"

Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

" }, "throttlingRateLimit":{ "shape":"Double", "documentation":"

Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.

" }, "cachingEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.

" }, "cacheTtlInSeconds":{ "shape":"Integer", "documentation":"

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.

" }, "cacheDataEncrypted":{ "shape":"Boolean", "documentation":"

Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.

" }, "requireAuthorizationForCacheControl":{ "shape":"Boolean", "documentation":"

Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.

" }, "unauthorizedCacheControlHeaderStrategy":{ "shape":"UnauthorizedCacheControlHeaderStrategy", "documentation":"

Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.

" } }, "documentation":"

Specifies the method setting properties.

" }, "MethodSnapshot":{ "type":"structure", "members":{ "authorizationType":{ "shape":"String", "documentation":"

Specifies the type of authorization used for the method.

" }, "apiKeyRequired":{ "shape":"Boolean", "documentation":"

Specifies whether the method requires a valid ApiKey.

" } }, "documentation":"

Represents a summary of a Method resource, given a particular date and time.

" }, "Model":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The identifier for the model resource.

" }, "name":{ "shape":"String", "documentation":"

The name of the model.

" }, "description":{ "shape":"String", "documentation":"

The description of the model.

" }, "schema":{ "shape":"String", "documentation":"

The schema for the model. For application/json models, this should be JSON-schema draft v4 model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

" }, "contentType":{ "shape":"String", "documentation":"

The content-type for the model.

" } }, "documentation":"

Represents the data structure of a method's request or response payload.

A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.

A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.

Method, MethodResponse, Models and Mappings
" }, "Models":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfModel", "documentation":"

Gets the current Model resource in the collection.

", "locationName":"item" } }, "documentation":"

Represents a collection of Model resources.

Method, MethodResponse, Models and Mappings
" }, "NotFoundException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "error":{"httpStatusCode":404}, "exception":true }, "NullableBoolean":{"type":"boolean"}, "NullableInteger":{"type":"integer"}, "Op":{ "type":"string", "enum":[ "add", "remove", "replace", "move", "copy", "test" ] }, "PatchOperation":{ "type":"structure", "members":{ "op":{ "shape":"Op", "documentation":"

An update operation to be performed with this PATCH request. The valid value can be \"add\", \"remove\", or \"replace\". Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.

" }, "path":{ "shape":"String", "documentation":"

The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {\"name\":\"value\"}, the path for this property is /name. If the name property value is a JSON object (e.g., {\"name\": {\"child/name\": \"child-value\"}}), the path for the child/name property will be /name/child~1name. Any slash (\"/\") character appearing in path names must be escaped with \"~1\", as shown in the example above. Each op operation can have only one path associated with it.

" }, "value":{ "shape":"String", "documentation":"

The new target value of the update operation.

" }, "from":{ "shape":"String", "documentation":"

Not supported.

" } }, "documentation":"A single patch operation to apply to the specified resource. Please refer to http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used." }, "PathToMapOfMethodSnapshot":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"MapOfMethodSnapshot"} }, "ProviderARN":{"type":"string"}, "PutIntegrationRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "type" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

Specifies a put integration request's API identifier.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

Specifies a put integration request's resource ID.

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

Specifies a put integration request's HTTP method.

", "location":"uri", "locationName":"http_method" }, "type":{ "shape":"IntegrationType", "documentation":"

Specifies a put integration input's type.

" }, "integrationHttpMethod":{ "shape":"String", "documentation":"

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

", "locationName":"httpMethod" }, "uri":{ "shape":"String", "documentation":"

Specifies a put integration input's Uniform Resource Identifier (URI). When the integration type is HTTP or AWS, this field is required. For integration with Lambda as an AWS service proxy, this value is of the 'arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/<functionArn>/invocations' format.

" }, "credentials":{ "shape":"String", "documentation":"

Specifies whether credentials are required for a put integration.

" }, "requestParameters":{ "shape":"MapOfStringToString", "documentation":"

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

" }, "requestTemplates":{ "shape":"MapOfStringToString", "documentation":"

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

" }, "passthroughBehavior":{ "shape":"String", "documentation":"

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

  • WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.

  • NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

  • WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

" }, "cacheNamespace":{ "shape":"String", "documentation":"

Specifies a put integration input's cache namespace.

" }, "cacheKeyParameters":{ "shape":"ListOfString", "documentation":"

Specifies a put integration input's cache key parameters.

" }, "contentHandling":{ "shape":"ContentHandlingStrategy", "documentation":"

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.

" } }, "documentation":"

Represents a put integration request.

" }, "PutIntegrationResponseRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "statusCode" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

Specifies a put integration response request's API identifier.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

Specifies a put integration response request's resource identifier.

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

Specifies a put integration response request's HTTP method.

", "location":"uri", "locationName":"http_method" }, "statusCode":{ "shape":"StatusCode", "documentation":"

Specifies the status code that is used to map the integration response to an existing MethodResponse.

", "location":"uri", "locationName":"status_code" }, "selectionPattern":{ "shape":"String", "documentation":"

Specifies the selection pattern of a put integration response.

" }, "responseParameters":{ "shape":"MapOfStringToString", "documentation":"

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

" }, "responseTemplates":{ "shape":"MapOfStringToString", "documentation":"

Specifies a put integration response's templates.

" }, "contentHandling":{ "shape":"ContentHandlingStrategy", "documentation":"

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

" } }, "documentation":"

Represents a put integration response request.

" }, "PutMethodRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "authorizationType" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier for the new Method resource.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

The Resource identifier for the new Method resource.

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

Specifies the method request's HTTP method type.

", "location":"uri", "locationName":"http_method" }, "authorizationType":{ "shape":"String", "documentation":"

Specifies the type of authorization used for the method.

" }, "authorizerId":{ "shape":"String", "documentation":"

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.

" }, "apiKeyRequired":{ "shape":"Boolean", "documentation":"

Specifies whether the method required a valid ApiKey.

" }, "operationName":{ "shape":"String", "documentation":"

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in PetStore example.

" }, "requestParameters":{ "shape":"MapOfStringToBoolean", "documentation":"

A key-value map defining required or optional method request parameters that can be accepted by Amazon API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

" }, "requestModels":{ "shape":"MapOfStringToString", "documentation":"

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

" } }, "documentation":"

Request to add a method to an existing Resource resource.

" }, "PutMethodResponseRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "statusCode" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier for the Method resource.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

The Resource identifier for the Method resource.

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

The HTTP verb of the Method resource.

", "location":"uri", "locationName":"http_method" }, "statusCode":{ "shape":"StatusCode", "documentation":"

The method response's status code.

", "location":"uri", "locationName":"status_code" }, "responseParameters":{ "shape":"MapOfStringToBoolean", "documentation":"

A key-value map specifying required or optional response parameters that Amazon API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

" }, "responseModels":{ "shape":"MapOfStringToString", "documentation":"

Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.

" } }, "documentation":"

Request to add a MethodResponse to an existing Method resource.

" }, "PutMode":{ "type":"string", "enum":[ "merge", "overwrite" ] }, "PutRestApiRequest":{ "type":"structure", "required":[ "restApiId", "body" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The identifier of the RestApi to be updated.

", "location":"uri", "locationName":"restapi_id" }, "mode":{ "shape":"PutMode", "documentation":"

The mode query parameter to specify the update mode. Valid values are \"merge\" and \"overwrite\". By default, the update mode is \"merge\".

", "location":"querystring", "locationName":"mode" }, "failOnWarnings":{ "shape":"Boolean", "documentation":"

A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.

", "location":"querystring", "locationName":"failonwarnings" }, "parameters":{ "shape":"MapOfStringToString", "documentation":"

Custom headers supplied as part of the request.

", "location":"querystring" }, "body":{ "shape":"Blob", "documentation":"

The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.

" } }, "documentation":"

A PUT request to update an existing API, with external API definitions specified as the request body.

", "payload":"body" }, "QuotaPeriodType":{ "type":"string", "enum":[ "DAY", "WEEK", "MONTH" ] }, "QuotaSettings":{ "type":"structure", "members":{ "limit":{ "shape":"Integer", "documentation":"

The maximum number of requests that can be made in a given time period.

" }, "offset":{ "shape":"Integer", "documentation":"

The number of requests subtracted from the given limit in the initial time period.

" }, "period":{ "shape":"QuotaPeriodType", "documentation":"

The time period in which the limit applies. Valid values are \"DAY\", \"WEEK\" or \"MONTH\".

" } }, "documentation":"

Quotas configured for a usage plan.

" }, "Resource":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The resource's identifier.

" }, "parentId":{ "shape":"String", "documentation":"

The parent resource's identifier.

" }, "pathPart":{ "shape":"String", "documentation":"

The last path segment for this resource.

" }, "path":{ "shape":"String", "documentation":"

The full path for this resource.

" }, "resourceMethods":{ "shape":"MapOfMethod", "documentation":"

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160608T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160608/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ \"_links\": { \"curies\": [ { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html\", \"name\": \"method\", \"templated\": true }, { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\", \"name\": \"methodresponse\", \"templated\": true } ], \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\", \"name\": \"GET\", \"title\": \"GET\" }, \"integration:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"method:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\" }, \"method:integration\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"method:responses\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"method:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\" }, \"methodresponse:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}\", \"templated\": true } }, \"apiKeyRequired\": false, \"authorizationType\": \"NONE\", \"httpMethod\": \"GET\", \"_embedded\": { \"method:integration\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integration:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integration:responses\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integration:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integrationresponse:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}\", \"templated\": true } }, \"cacheKeyParameters\": [], \"cacheNamespace\": \"3kzxbg5sa2\", \"credentials\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\", \"httpMethod\": \"POST\", \"passthroughBehavior\": \"WHEN_NO_MATCH\", \"requestParameters\": { \"integration.request.header.Content-Type\": \"'application/x-amz-json-1.1'\" }, \"requestTemplates\": { \"application/json\": \"{\\n}\" }, \"type\": \"AWS\", \"uri\": \"arn:aws:apigateway:us-east-1:kinesis:action/ListStreams\", \"_embedded\": { \"integration:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integrationresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" }, \"integrationresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" } }, \"responseParameters\": { \"method.response.header.Content-Type\": \"'application/xml'\" }, \"responseTemplates\": { \"application/json\": \"$util.urlDecode(\\\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\\\")\\n\" }, \"statusCode\": \"200\" } } }, \"method:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"methodresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" }, \"methodresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" } }, \"responseModels\": { \"application/json\": \"Empty\" }, \"responseParameters\": { \"method.response.header.Content-Type\": false }, \"statusCode\": \"200\" } } }

If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

" } }, "documentation":"

Represents an API resource.

Create an API
" }, "Resources":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfResource", "documentation":"

Gets the current Resource resource in the collection.

", "locationName":"item" } }, "documentation":"

Represents a collection of Resource resources.

Create an API
" }, "RestApi":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.

" }, "name":{ "shape":"String", "documentation":"

The API's name.

" }, "description":{ "shape":"String", "documentation":"

The API's description.

" }, "createdDate":{ "shape":"Timestamp", "documentation":"

The date when the API was created, in ISO 8601 format.

" }, "version":{ "shape":"String", "documentation":"

A version identifier for the API.

" }, "warnings":{ "shape":"ListOfString", "documentation":"

The warning messages reported when failonwarnings is turned on during API import.

" }, "binaryMediaTypes":{ "shape":"ListOfString", "documentation":"

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

" } }, "documentation":"

Represents a REST API.

Create an API
" }, "RestApis":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfRestApi", "documentation":"

An array of links to the current page of RestApi resources.

", "locationName":"item" } }, "documentation":"

Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.

Create an API
" }, "SdkConfigurationProperty":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of a an SdkType configuration property.

" }, "friendlyName":{ "shape":"String", "documentation":"

The user-friendly name of an SdkType configuration property.

" }, "description":{ "shape":"String", "documentation":"

The description of an SdkType configuration property.

" }, "required":{ "shape":"Boolean", "documentation":"

A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).

" }, "defaultValue":{ "shape":"String", "documentation":"

The default value of an SdkType configuration property.

" } }, "documentation":"

A configuration property of an SDK type.

" }, "SdkResponse":{ "type":"structure", "members":{ "contentType":{ "shape":"String", "documentation":"

The content-type header value in the HTTP response.

", "location":"header", "locationName":"Content-Type" }, "contentDisposition":{ "shape":"String", "documentation":"

The content-disposition header value in the HTTP response.

", "location":"header", "locationName":"Content-Disposition" }, "body":{ "shape":"Blob", "documentation":"

The binary blob response to GetSdk, which contains the generated SDK.

" } }, "documentation":"

The binary blob response to GetSdk, which contains the generated SDK.

", "payload":"body" }, "SdkType":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The identifier of an SdkType instance.

" }, "friendlyName":{ "shape":"String", "documentation":"

The user-friendly name of an SdkType instance.

" }, "description":{ "shape":"String", "documentation":"

The description of an SdkType.

" }, "configurationProperties":{ "shape":"ListOfSdkConfigurationProperty", "documentation":"

A list of configuration properties of an SdkType.

" } }, "documentation":"

A type of SDK that API Gateway can generate.

" }, "SdkTypes":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfSdkType", "documentation":"

The set of SdkType items that comprise this view of the SdkTypes collection.

", "locationName":"item" } }, "documentation":"

The collection of SdkType instances.

" }, "ServiceUnavailableException":{ "type":"structure", "members":{ "retryAfterSeconds":{ "shape":"String", "location":"header", "locationName":"Retry-After" }, "message":{"shape":"String"} }, "error":{"httpStatusCode":503}, "exception":true, "fault":true }, "Stage":{ "type":"structure", "members":{ "deploymentId":{ "shape":"String", "documentation":"

The identifier of the Deployment that the stage points to.

" }, "clientCertificateId":{ "shape":"String", "documentation":"

The identifier of a client certificate for an API stage.

" }, "stageName":{ "shape":"String", "documentation":"

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.

" }, "description":{ "shape":"String", "documentation":"

The stage's description.

" }, "cacheClusterEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether a cache cluster is enabled for the stage.

" }, "cacheClusterSize":{ "shape":"CacheClusterSize", "documentation":"

The size of the cache cluster for the stage, if enabled.

" }, "cacheClusterStatus":{ "shape":"CacheClusterStatus", "documentation":"

The status of the cache cluster for the stage, if enabled.

" }, "methodSettings":{ "shape":"MapOfMethodSettings", "documentation":"

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\\*/\\* for overriding all methods in the stage.

" }, "variables":{ "shape":"MapOfStringToString", "documentation":"

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

" }, "documentationVersion":{ "shape":"String", "documentation":"

The version of the associated API documentation.

" }, "createdDate":{ "shape":"Timestamp", "documentation":"

The date and time that the stage was created, in ISO 8601 format.

" }, "lastUpdatedDate":{ "shape":"Timestamp", "documentation":"

The date and time that information about the stage was last updated, in ISO 8601 format.

" } }, "documentation":"

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

Deploy an API
" }, "StageKey":{ "type":"structure", "members":{ "restApiId":{ "shape":"String", "documentation":"

A list of Stage resources that are associated with the ApiKey resource.

" }, "stageName":{ "shape":"String", "documentation":"

The stage name in the RestApi that the stage key references.

" } }, "documentation":"

A reference to a unique stage identified in the format {restApiId}/{stage}.

" }, "Stages":{ "type":"structure", "members":{ "item":{ "shape":"ListOfStage", "documentation":"

An individual Stage resource.

" } }, "documentation":"

A list of Stage resources that are associated with the ApiKey resource.

Deploying API in Stages
" }, "StatusCode":{ "type":"string", "documentation":"

The status code.

", "pattern":"[1-5]\\d\\d" }, "String":{"type":"string"}, "Template":{ "type":"structure", "members":{ "value":{ "shape":"String", "documentation":"

The Apache Velocity Template Language (VTL) template content used for the template resource.

" } }, "documentation":"

Represents a mapping template used to transform a payload.

Mapping Templates
" }, "TestInvokeAuthorizerRequest":{ "type":"structure", "required":[ "restApiId", "authorizerId" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

Specifies a test invoke authorizer request's RestApi identifier.

", "location":"uri", "locationName":"restapi_id" }, "authorizerId":{ "shape":"String", "documentation":"

Specifies a test invoke authorizer request's Authorizer ID.

", "location":"uri", "locationName":"authorizer_id" }, "headers":{ "shape":"MapOfHeaderValues", "documentation":"

[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

" }, "pathWithQueryString":{ "shape":"String", "documentation":"

[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

" }, "body":{ "shape":"String", "documentation":"

[Optional] The simulated request body of an incoming invocation request.

" }, "stageVariables":{ "shape":"MapOfStringToString", "documentation":"

A key-value map of stage variables to simulate an invocation on a deployed Stage.

" }, "additionalContext":{ "shape":"MapOfStringToString", "documentation":"

[Optional] A key-value map of additional context variables.

" } }, "documentation":"

Make a request to simulate the execution of an Authorizer.

" }, "TestInvokeAuthorizerResponse":{ "type":"structure", "members":{ "clientStatus":{ "shape":"Integer", "documentation":"

The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.

" }, "log":{ "shape":"String", "documentation":"

The Amazon API Gateway execution log for the test authorizer request.

" }, "latency":{ "shape":"Long", "documentation":"

The execution latency of the test authorizer request.

" }, "principalId":{ "shape":"String", "documentation":"

The principal identity returned by the Authorizer

" }, "policy":{ "shape":"String", "documentation":"

The JSON policy document returned by the Authorizer

" }, "authorization":{"shape":"MapOfStringToList"}, "claims":{ "shape":"MapOfStringToString", "documentation":"

The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.

" } }, "documentation":"

Represents the response of the test invoke request for a custom Authorizer

" }, "TestInvokeMethodRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

Specifies a test invoke method request's API identifier.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

Specifies a test invoke method request's resource ID.

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

Specifies a test invoke method request's HTTP method.

", "location":"uri", "locationName":"http_method" }, "pathWithQueryString":{ "shape":"String", "documentation":"

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

" }, "body":{ "shape":"String", "documentation":"

The simulated request body of an incoming invocation request.

" }, "headers":{ "shape":"MapOfHeaderValues", "documentation":"

A key-value map of headers to simulate an incoming invocation request.

" }, "clientCertificateId":{ "shape":"String", "documentation":"

A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

" }, "stageVariables":{ "shape":"MapOfStringToString", "documentation":"

A key-value map of stage variables to simulate an invocation on a deployed Stage.

" } }, "documentation":"

Make a request to simulate the execution of a Method.

" }, "TestInvokeMethodResponse":{ "type":"structure", "members":{ "status":{ "shape":"Integer", "documentation":"

The HTTP status code.

" }, "body":{ "shape":"String", "documentation":"

The body of the HTTP response.

" }, "headers":{ "shape":"MapOfHeaderValues", "documentation":"

The headers of the HTTP response.

" }, "log":{ "shape":"String", "documentation":"

The Amazon API Gateway execution log for the test invoke request.

" }, "latency":{ "shape":"Long", "documentation":"

The execution latency of the test invoke request.

" } }, "documentation":"

Represents the response of the test invoke request in the HTTP method.

Test API using the API Gateway console
" }, "ThrottleSettings":{ "type":"structure", "members":{ "burstLimit":{ "shape":"Integer", "documentation":"

The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

" }, "rateLimit":{ "shape":"Double", "documentation":"

The API request steady-state rate limit.

" } }, "documentation":"

The API request rate limits.

" }, "Timestamp":{"type":"timestamp"}, "TooManyRequestsException":{ "type":"structure", "members":{ "retryAfterSeconds":{ "shape":"String", "location":"header", "locationName":"Retry-After" }, "message":{"shape":"String"} }, "error":{"httpStatusCode":429}, "exception":true }, "UnauthorizedCacheControlHeaderStrategy":{ "type":"string", "enum":[ "FAIL_WITH_403", "SUCCEED_WITH_RESPONSE_HEADER", "SUCCEED_WITHOUT_RESPONSE_HEADER" ] }, "UnauthorizedException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "error":{"httpStatusCode":401}, "exception":true }, "UpdateAccountRequest":{ "type":"structure", "members":{ "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

Requests Amazon API Gateway to change information about the current Account resource.

" }, "UpdateApiKeyRequest":{ "type":"structure", "required":["apiKey"], "members":{ "apiKey":{ "shape":"String", "documentation":"

The identifier of the ApiKey resource to be updated.

", "location":"uri", "locationName":"api_Key" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

A request to change information about an ApiKey resource.

" }, "UpdateAuthorizerRequest":{ "type":"structure", "required":[ "restApiId", "authorizerId" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier for the Authorizer resource.

", "location":"uri", "locationName":"restapi_id" }, "authorizerId":{ "shape":"String", "documentation":"

The identifier of the Authorizer resource.

", "location":"uri", "locationName":"authorizer_id" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

Request to update an existing Authorizer resource.

" }, "UpdateBasePathMappingRequest":{ "type":"structure", "required":[ "domainName", "basePath" ], "members":{ "domainName":{ "shape":"String", "documentation":"

The domain name of the BasePathMapping resource to change.

", "location":"uri", "locationName":"domain_name" }, "basePath":{ "shape":"String", "documentation":"

The base path of the BasePathMapping resource to change.

", "location":"uri", "locationName":"base_path" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

A request to change information about the BasePathMapping resource.

" }, "UpdateClientCertificateRequest":{ "type":"structure", "required":["clientCertificateId"], "members":{ "clientCertificateId":{ "shape":"String", "documentation":"

The identifier of the ClientCertificate resource to be updated.

", "location":"uri", "locationName":"clientcertificate_id" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

A request to change information about an ClientCertificate resource.

" }, "UpdateDeploymentRequest":{ "type":"structure", "required":[ "restApiId", "deploymentId" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The replacement identifier of the RestApi resource for the Deployment resource to change information about.

", "location":"uri", "locationName":"restapi_id" }, "deploymentId":{ "shape":"String", "documentation":"

The replacement identifier for the Deployment resource to change information about.

", "location":"uri", "locationName":"deployment_id" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

Requests Amazon API Gateway to change information about a Deployment resource.

" }, "UpdateDocumentationPartRequest":{ "type":"structure", "required":[ "restApiId", "documentationPartId" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

[Required] The identifier of an API of the to-be-updated documentation part.

", "location":"uri", "locationName":"restapi_id" }, "documentationPartId":{ "shape":"String", "documentation":"

[Required] The identifier of the to-be-updated documentation part.

", "location":"uri", "locationName":"part_id" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

Updates an existing documentation part of a given API.

" }, "UpdateDocumentationVersionRequest":{ "type":"structure", "required":[ "restApiId", "documentationVersion" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

[Required] The identifier of an API of the to-be-updated documentation version.

", "location":"uri", "locationName":"restapi_id" }, "documentationVersion":{ "shape":"String", "documentation":"

[Required] The version identifier of the to-be-updated documentation version.

", "location":"uri", "locationName":"doc_version" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

Updates an existing documentation version of an API.

" }, "UpdateDomainNameRequest":{ "type":"structure", "required":["domainName"], "members":{ "domainName":{ "shape":"String", "documentation":"

The name of the DomainName resource to be changed.

", "location":"uri", "locationName":"domain_name" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

A request to change information about the DomainName resource.

" }, "UpdateIntegrationRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

Represents an update integration request's API identifier.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

Represents an update integration request's resource identifier.

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

Represents an update integration request's HTTP method.

", "location":"uri", "locationName":"http_method" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

Represents an update integration request.

" }, "UpdateIntegrationResponseRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "statusCode" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

Specifies an update integration response request's API identifier.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

Specifies an update integration response request's resource identifier.

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

Specifies an update integration response request's HTTP method.

", "location":"uri", "locationName":"http_method" }, "statusCode":{ "shape":"StatusCode", "documentation":"

Specifies an update integration response request's status code.

", "location":"uri", "locationName":"status_code" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

Represents an update integration response request.

" }, "UpdateMethodRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier for the Method resource.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

The Resource identifier for the Method resource.

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

The HTTP verb of the Method resource.

", "location":"uri", "locationName":"http_method" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

Request to update an existing Method resource.

" }, "UpdateMethodResponseRequest":{ "type":"structure", "required":[ "restApiId", "resourceId", "httpMethod", "statusCode" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier for the MethodResponse resource.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

The Resource identifier for the MethodResponse resource.

", "location":"uri", "locationName":"resource_id" }, "httpMethod":{ "shape":"String", "documentation":"

The HTTP verb of the Method resource.

", "location":"uri", "locationName":"http_method" }, "statusCode":{ "shape":"StatusCode", "documentation":"

The status code for the MethodResponse resource.

", "location":"uri", "locationName":"status_code" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

A request to update an existing MethodResponse resource.

" }, "UpdateModelRequest":{ "type":"structure", "required":[ "restApiId", "modelName" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier under which the model exists.

", "location":"uri", "locationName":"restapi_id" }, "modelName":{ "shape":"String", "documentation":"

The name of the model to update.

", "location":"uri", "locationName":"model_name" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

Request to update an existing model in an existing RestApi resource.

" }, "UpdateResourceRequest":{ "type":"structure", "required":[ "restApiId", "resourceId" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The RestApi identifier for the Resource resource.

", "location":"uri", "locationName":"restapi_id" }, "resourceId":{ "shape":"String", "documentation":"

The identifier of the Resource resource.

", "location":"uri", "locationName":"resource_id" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

Request to change information about a Resource resource.

" }, "UpdateRestApiRequest":{ "type":"structure", "required":["restApiId"], "members":{ "restApiId":{ "shape":"String", "documentation":"

The ID of the RestApi you want to update.

", "location":"uri", "locationName":"restapi_id" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

Request to update an existing RestApi resource in your collection.

" }, "UpdateStageRequest":{ "type":"structure", "required":[ "restApiId", "stageName" ], "members":{ "restApiId":{ "shape":"String", "documentation":"

The identifier of the RestApi resource for the Stage resource to change information about.

", "location":"uri", "locationName":"restapi_id" }, "stageName":{ "shape":"String", "documentation":"

The name of the Stage resource to change information about.

", "location":"uri", "locationName":"stage_name" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

Requests Amazon API Gateway to change information about a Stage resource.

" }, "UpdateUsagePlanRequest":{ "type":"structure", "required":["usagePlanId"], "members":{ "usagePlanId":{ "shape":"String", "documentation":"

The Id of the to-be-updated usage plan.

", "location":"uri", "locationName":"usageplanId" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

The PATCH request to update a usage plan of a given plan Id.

" }, "UpdateUsageRequest":{ "type":"structure", "required":[ "usagePlanId", "keyId" ], "members":{ "usagePlanId":{ "shape":"String", "documentation":"

The Id of the usage plan associated with the usage data.

", "location":"uri", "locationName":"usageplanId" }, "keyId":{ "shape":"String", "documentation":"

The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

", "location":"uri", "locationName":"keyId" }, "patchOperations":{ "shape":"ListOfPatchOperation", "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" } }, "documentation":"

The PATCH request to grant a temporary extension to the reamining quota of a usage plan associated with a specified API key.

" }, "Usage":{ "type":"structure", "members":{ "usagePlanId":{ "shape":"String", "documentation":"

The plan Id associated with this usage data.

" }, "startDate":{ "shape":"String", "documentation":"

The starting date of the usage data.

" }, "endDate":{ "shape":"String", "documentation":"

The ending date of the usage data.

" }, "position":{"shape":"String"}, "items":{ "shape":"MapOfKeyUsages", "documentation":"

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., \"values\" : { \"{api_key}\" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

", "locationName":"values" } }, "documentation":"

Represents the usage data of a usage plan.

Create and Use Usage Plans, Manage Usage in a Usage Plan
" }, "UsagePlan":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The identifier of a UsagePlan resource.

" }, "name":{ "shape":"String", "documentation":"

The name of a usage plan.

" }, "description":{ "shape":"String", "documentation":"

The description of a usage plan.

" }, "apiStages":{ "shape":"ListOfApiStage", "documentation":"

The associated API stages of a usage plan.

" }, "throttle":{ "shape":"ThrottleSettings", "documentation":"

The request throttle limits of a usage plan.

" }, "quota":{ "shape":"QuotaSettings", "documentation":"

The maximum number of permitted requests per a given unit time interval.

" }, "productCode":{ "shape":"String", "documentation":"

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

" } }, "documentation":"

Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.

In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.

Create and Use Usage Plans
" }, "UsagePlanKey":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The Id of a usage plan key.

" }, "type":{ "shape":"String", "documentation":"

The type of a usage plan key. Currently, the valid key type is API_KEY.

" }, "value":{ "shape":"String", "documentation":"

The value of a usage plan key.

" }, "name":{ "shape":"String", "documentation":"

The name of a usage plan key.

" } }, "documentation":"

Represents a usage plan key to identify a plan customer.

To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.

\"
Create and Use Usage Plans
" }, "UsagePlanKeys":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfUsagePlanKey", "documentation":"

Gets the current item of the usage plan keys collection.

", "locationName":"item" } }, "documentation":"

Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.

Create and Use Usage Plans
" }, "UsagePlans":{ "type":"structure", "members":{ "position":{"shape":"String"}, "items":{ "shape":"ListOfUsagePlan", "documentation":"

Gets the current item when enumerating the collection of UsagePlan.

", "locationName":"item" } }, "documentation":"

Represents a collection of usage plans for an AWS account.

Create and Use Usage Plans
" } }, "documentation":"Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. Amazon API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

" } botocore-1.5.7/botocore/data/dms/0000777454262600001440000000000013042511307017716 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/dms/2016-01-01/0000777454262600001440000000000013042511307020742 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/dms/2016-01-01/service-2.json0000666454262600001440000027541113042511306023445 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-01-01", "endpointPrefix":"dms", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"AWS Database Migration Service", "signatureVersion":"v4", "targetPrefix":"AmazonDMSv20160101", "uid":"dms-2016-01-01" }, "operations":{ "AddTagsToResource":{ "name":"AddTagsToResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsToResourceMessage"}, "output":{"shape":"AddTagsToResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"} ], "documentation":"

Adds metadata tags to a DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS.

" }, "CreateEndpoint":{ "name":"CreateEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateEndpointMessage"}, "output":{"shape":"CreateEndpointResponse"}, "errors":[ {"shape":"KMSKeyNotAccessibleFault"}, {"shape":"ResourceAlreadyExistsFault"}, {"shape":"ResourceQuotaExceededFault"}, {"shape":"InvalidResourceStateFault"}, {"shape":"ResourceNotFoundFault"}, {"shape":"AccessDeniedFault"} ], "documentation":"

Creates an endpoint using the provided settings.

" }, "CreateReplicationInstance":{ "name":"CreateReplicationInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateReplicationInstanceMessage"}, "output":{"shape":"CreateReplicationInstanceResponse"}, "errors":[ {"shape":"AccessDeniedFault"}, {"shape":"ResourceAlreadyExistsFault"}, {"shape":"InsufficientResourceCapacityFault"}, {"shape":"ResourceQuotaExceededFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"ResourceNotFoundFault"}, {"shape":"ReplicationSubnetGroupDoesNotCoverEnoughAZs"}, {"shape":"InvalidResourceStateFault"}, {"shape":"InvalidSubnet"}, {"shape":"KMSKeyNotAccessibleFault"} ], "documentation":"

Creates the replication instance using the specified parameters.

" }, "CreateReplicationSubnetGroup":{ "name":"CreateReplicationSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateReplicationSubnetGroupMessage"}, "output":{"shape":"CreateReplicationSubnetGroupResponse"}, "errors":[ {"shape":"AccessDeniedFault"}, {"shape":"ResourceAlreadyExistsFault"}, {"shape":"ResourceNotFoundFault"}, {"shape":"ResourceQuotaExceededFault"}, {"shape":"ReplicationSubnetGroupDoesNotCoverEnoughAZs"}, {"shape":"InvalidSubnet"} ], "documentation":"

Creates a replication subnet group given a list of the subnet IDs in a VPC.

" }, "CreateReplicationTask":{ "name":"CreateReplicationTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateReplicationTaskMessage"}, "output":{"shape":"CreateReplicationTaskResponse"}, "errors":[ {"shape":"InvalidResourceStateFault"}, {"shape":"ResourceAlreadyExistsFault"}, {"shape":"ResourceNotFoundFault"}, {"shape":"KMSKeyNotAccessibleFault"}, {"shape":"ResourceQuotaExceededFault"} ], "documentation":"

Creates a replication task using the specified parameters.

" }, "DeleteCertificate":{ "name":"DeleteCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCertificateMessage"}, "output":{"shape":"DeleteCertificateResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"}, {"shape":"InvalidResourceStateFault"} ], "documentation":"

Deletes the specified certificate.

" }, "DeleteEndpoint":{ "name":"DeleteEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteEndpointMessage"}, "output":{"shape":"DeleteEndpointResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"}, {"shape":"InvalidResourceStateFault"} ], "documentation":"

Deletes the specified endpoint.

All tasks associated with the endpoint must be deleted before you can delete the endpoint.

" }, "DeleteReplicationInstance":{ "name":"DeleteReplicationInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteReplicationInstanceMessage"}, "output":{"shape":"DeleteReplicationInstanceResponse"}, "errors":[ {"shape":"InvalidResourceStateFault"}, {"shape":"ResourceNotFoundFault"} ], "documentation":"

Deletes the specified replication instance.

You must delete any migration tasks that are associated with the replication instance before you can delete it.

" }, "DeleteReplicationSubnetGroup":{ "name":"DeleteReplicationSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteReplicationSubnetGroupMessage"}, "output":{"shape":"DeleteReplicationSubnetGroupResponse"}, "errors":[ {"shape":"InvalidResourceStateFault"}, {"shape":"ResourceNotFoundFault"} ], "documentation":"

Deletes a subnet group.

" }, "DeleteReplicationTask":{ "name":"DeleteReplicationTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteReplicationTaskMessage"}, "output":{"shape":"DeleteReplicationTaskResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"}, {"shape":"InvalidResourceStateFault"} ], "documentation":"

Deletes the specified replication task.

" }, "DescribeAccountAttributes":{ "name":"DescribeAccountAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAccountAttributesMessage"}, "output":{"shape":"DescribeAccountAttributesResponse"}, "documentation":"

Lists all of the AWS DMS attributes for a customer account. The attributes include AWS DMS quotas for the account, such as the number of replication instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

This command does not take any parameters.

" }, "DescribeCertificates":{ "name":"DescribeCertificates", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCertificatesMessage"}, "output":{"shape":"DescribeCertificatesResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"} ], "documentation":"

Provides a description of the certificate.

" }, "DescribeConnections":{ "name":"DescribeConnections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConnectionsMessage"}, "output":{"shape":"DescribeConnectionsResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"} ], "documentation":"

Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.

" }, "DescribeEndpointTypes":{ "name":"DescribeEndpointTypes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEndpointTypesMessage"}, "output":{"shape":"DescribeEndpointTypesResponse"}, "documentation":"

Returns information about the type of endpoints available.

" }, "DescribeEndpoints":{ "name":"DescribeEndpoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEndpointsMessage"}, "output":{"shape":"DescribeEndpointsResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"} ], "documentation":"

Returns information about the endpoints for your account in the current region.

" }, "DescribeOrderableReplicationInstances":{ "name":"DescribeOrderableReplicationInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeOrderableReplicationInstancesMessage"}, "output":{"shape":"DescribeOrderableReplicationInstancesResponse"}, "documentation":"

Returns information about the replication instance types that can be created in the specified region.

" }, "DescribeRefreshSchemasStatus":{ "name":"DescribeRefreshSchemasStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRefreshSchemasStatusMessage"}, "output":{"shape":"DescribeRefreshSchemasStatusResponse"}, "errors":[ {"shape":"InvalidResourceStateFault"}, {"shape":"ResourceNotFoundFault"} ], "documentation":"

Returns the status of the RefreshSchemas operation.

" }, "DescribeReplicationInstances":{ "name":"DescribeReplicationInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReplicationInstancesMessage"}, "output":{"shape":"DescribeReplicationInstancesResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"} ], "documentation":"

Returns information about replication instances for your account in the current region.

" }, "DescribeReplicationSubnetGroups":{ "name":"DescribeReplicationSubnetGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReplicationSubnetGroupsMessage"}, "output":{"shape":"DescribeReplicationSubnetGroupsResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"} ], "documentation":"

Returns information about the replication subnet groups.

" }, "DescribeReplicationTasks":{ "name":"DescribeReplicationTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReplicationTasksMessage"}, "output":{"shape":"DescribeReplicationTasksResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"} ], "documentation":"

Returns information about replication tasks for your account in the current region.

" }, "DescribeSchemas":{ "name":"DescribeSchemas", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSchemasMessage"}, "output":{"shape":"DescribeSchemasResponse"}, "errors":[ {"shape":"InvalidResourceStateFault"}, {"shape":"ResourceNotFoundFault"} ], "documentation":"

Returns information about the schema for the specified endpoint.

" }, "DescribeTableStatistics":{ "name":"DescribeTableStatistics", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTableStatisticsMessage"}, "output":{"shape":"DescribeTableStatisticsResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"}, {"shape":"InvalidResourceStateFault"} ], "documentation":"

Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.

" }, "ImportCertificate":{ "name":"ImportCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportCertificateMessage"}, "output":{"shape":"ImportCertificateResponse"}, "errors":[ {"shape":"ResourceAlreadyExistsFault"}, {"shape":"InvalidCertificateFault"} ], "documentation":"

Uploads the specified certificate.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceMessage"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"} ], "documentation":"

Lists all tags for an AWS DMS resource.

" }, "ModifyEndpoint":{ "name":"ModifyEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyEndpointMessage"}, "output":{"shape":"ModifyEndpointResponse"}, "errors":[ {"shape":"InvalidResourceStateFault"}, {"shape":"ResourceNotFoundFault"}, {"shape":"ResourceAlreadyExistsFault"}, {"shape":"KMSKeyNotAccessibleFault"} ], "documentation":"

Modifies the specified endpoint.

" }, "ModifyReplicationInstance":{ "name":"ModifyReplicationInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyReplicationInstanceMessage"}, "output":{"shape":"ModifyReplicationInstanceResponse"}, "errors":[ {"shape":"InvalidResourceStateFault"}, {"shape":"ResourceAlreadyExistsFault"}, {"shape":"ResourceNotFoundFault"}, {"shape":"InsufficientResourceCapacityFault"}, {"shape":"StorageQuotaExceededFault"}, {"shape":"UpgradeDependencyFailureFault"} ], "documentation":"

Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.

Some settings are applied during the maintenance window.

" }, "ModifyReplicationSubnetGroup":{ "name":"ModifyReplicationSubnetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyReplicationSubnetGroupMessage"}, "output":{"shape":"ModifyReplicationSubnetGroupResponse"}, "errors":[ {"shape":"AccessDeniedFault"}, {"shape":"ResourceNotFoundFault"}, {"shape":"ResourceQuotaExceededFault"}, {"shape":"SubnetAlreadyInUse"}, {"shape":"ReplicationSubnetGroupDoesNotCoverEnoughAZs"}, {"shape":"InvalidSubnet"} ], "documentation":"

Modifies the settings for the specified replication subnet group.

" }, "ModifyReplicationTask":{ "name":"ModifyReplicationTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyReplicationTaskMessage"}, "output":{"shape":"ModifyReplicationTaskResponse"}, "errors":[ {"shape":"InvalidResourceStateFault"}, {"shape":"ResourceNotFoundFault"}, {"shape":"ResourceAlreadyExistsFault"}, {"shape":"KMSKeyNotAccessibleFault"} ], "documentation":"

Modifies the specified replication task.

You can't modify the task endpoints. The task must be stopped before you can modify it.

" }, "RefreshSchemas":{ "name":"RefreshSchemas", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RefreshSchemasMessage"}, "output":{"shape":"RefreshSchemasResponse"}, "errors":[ {"shape":"InvalidResourceStateFault"}, {"shape":"ResourceNotFoundFault"}, {"shape":"KMSKeyNotAccessibleFault"}, {"shape":"ResourceQuotaExceededFault"} ], "documentation":"

Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.

" }, "RemoveTagsFromResource":{ "name":"RemoveTagsFromResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTagsFromResourceMessage"}, "output":{"shape":"RemoveTagsFromResourceResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"} ], "documentation":"

Removes metadata tags from a DMS resource.

" }, "StartReplicationTask":{ "name":"StartReplicationTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartReplicationTaskMessage"}, "output":{"shape":"StartReplicationTaskResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"}, {"shape":"InvalidResourceStateFault"} ], "documentation":"

Starts the replication task.

" }, "StopReplicationTask":{ "name":"StopReplicationTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopReplicationTaskMessage"}, "output":{"shape":"StopReplicationTaskResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"}, {"shape":"InvalidResourceStateFault"} ], "documentation":"

Stops the replication task.

" }, "TestConnection":{ "name":"TestConnection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TestConnectionMessage"}, "output":{"shape":"TestConnectionResponse"}, "errors":[ {"shape":"ResourceNotFoundFault"}, {"shape":"InvalidResourceStateFault"}, {"shape":"KMSKeyNotAccessibleFault"}, {"shape":"ResourceQuotaExceededFault"} ], "documentation":"

Tests the connection between the replication instance and the endpoint.

" } }, "shapes":{ "AccessDeniedFault":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

" } }, "documentation":"

AWS DMS was denied access to the endpoint.

", "exception":true }, "AccountQuota":{ "type":"structure", "members":{ "AccountQuotaName":{ "shape":"String", "documentation":"

The name of the AWS DMS quota for this AWS account.

" }, "Used":{ "shape":"Long", "documentation":"

The amount currently used toward the quota maximum.

" }, "Max":{ "shape":"Long", "documentation":"

The maximum allowed value for the quota.

" } }, "documentation":"

Describes a quota for an AWS account, for example, the number of replication instances allowed.

" }, "AccountQuotaList":{ "type":"list", "member":{ "shape":"AccountQuota", "locationName":"AccountQuota" } }, "AddTagsToResourceMessage":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the AWS DMS resource the tag is to be added to. AWS DMS resources include a replication instance, endpoint, and a replication task.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tag to be assigned to the DMS resource.

" } }, "documentation":"

" }, "AddTagsToResourceResponse":{ "type":"structure", "members":{ }, "documentation":"

" }, "AvailabilityZone":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the availability zone.

" } }, "documentation":"

" }, "Boolean":{"type":"boolean"}, "BooleanOptional":{"type":"boolean"}, "Certificate":{ "type":"structure", "members":{ "CertificateIdentifier":{ "shape":"String", "documentation":"

The customer-assigned name of the certificate. Valid characters are A-z and 0-9.

" }, "CertificateCreationDate":{ "shape":"TStamp", "documentation":"

The date that the certificate was created.

" }, "CertificatePem":{ "shape":"String", "documentation":"

The contents of the .pem X.509 certificate file for the certificate.

" }, "CertificateWallet":{ "shape":"CertificateWallet", "documentation":"

The location of the imported Oracle Wallet certificate for use with SSL.

" }, "CertificateArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the certificate.

" }, "CertificateOwner":{ "shape":"String", "documentation":"

The owner of the certificate.

" }, "ValidFromDate":{ "shape":"TStamp", "documentation":"

The beginning date that the certificate is valid.

" }, "ValidToDate":{ "shape":"TStamp", "documentation":"

The final date that the certificate is valid.

" }, "SigningAlgorithm":{ "shape":"String", "documentation":"

The signing algorithm for the certificate.

" }, "KeyLength":{ "shape":"IntegerOptional", "documentation":"

The key length of the cryptographic algorithm being used.

" } }, "documentation":"

The SSL certificate that can be used to encrypt connections between the endpoints and the replication instance.

" }, "CertificateList":{ "type":"list", "member":{ "shape":"Certificate", "locationName":"Certificate" } }, "CertificateWallet":{"type":"blob"}, "Connection":{ "type":"structure", "members":{ "ReplicationInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" }, "EndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" }, "Status":{ "shape":"String", "documentation":"

The connection status.

" }, "LastFailureMessage":{ "shape":"String", "documentation":"

The error message when the connection last failed.

" }, "EndpointIdentifier":{ "shape":"String", "documentation":"

The identifier of the endpoint. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

" }, "ReplicationInstanceIdentifier":{ "shape":"String", "documentation":"

The replication instance identifier. This parameter is stored as a lowercase string.

" } }, "documentation":"

" }, "ConnectionList":{ "type":"list", "member":{ "shape":"Connection", "locationName":"Connection" } }, "CreateEndpointMessage":{ "type":"structure", "required":[ "EndpointIdentifier", "EndpointType", "EngineName" ], "members":{ "EndpointIdentifier":{ "shape":"String", "documentation":"

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

" }, "EndpointType":{ "shape":"ReplicationEndpointTypeValue", "documentation":"

The type of endpoint.

" }, "EngineName":{ "shape":"String", "documentation":"

The type of engine for the endpoint. Valid values include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, SYBASE, and SQLSERVER.

" }, "Username":{ "shape":"String", "documentation":"

The user name to be used to login to the endpoint database.

" }, "Password":{ "shape":"SecretString", "documentation":"

The password to be used to login to the endpoint database.

" }, "ServerName":{ "shape":"String", "documentation":"

The name of the server where the endpoint database resides.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port used by the endpoint database.

" }, "DatabaseName":{ "shape":"String", "documentation":"

The name of the endpoint database.

" }, "ExtraConnectionAttributes":{ "shape":"String", "documentation":"

Additional attributes associated with the connection.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

" }, "Tags":{ "shape":"TagList", "documentation":"

Tags to be added to the endpoint.

" }, "CertificateArn":{ "shape":"String", "documentation":"

The Amazon Resource Number (ARN) for the certificate.

" }, "SslMode":{ "shape":"DmsSslModeValue", "documentation":"

The SSL mode to use for the SSL connection.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

" } }, "documentation":"

" }, "CreateEndpointResponse":{ "type":"structure", "members":{ "Endpoint":{ "shape":"Endpoint", "documentation":"

The endpoint that was created.

" } }, "documentation":"

" }, "CreateReplicationInstanceMessage":{ "type":"structure", "required":[ "ReplicationInstanceIdentifier", "ReplicationInstanceClass" ], "members":{ "ReplicationInstanceIdentifier":{ "shape":"String", "documentation":"

The replication instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

" }, "AllocatedStorage":{ "shape":"IntegerOptional", "documentation":"

The amount of storage (in gigabytes) to be initially allocated for the replication instance.

" }, "ReplicationInstanceClass":{ "shape":"String", "documentation":"

The compute and memory capacity of the replication instance as specified by the replication instance class.

Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The EC2 Availability Zone that the replication instance will be created in.

Default: A random, system-chosen Availability Zone in the endpoint's region.

Example: us-east-1d

" }, "ReplicationSubnetGroupIdentifier":{ "shape":"String", "documentation":"

A subnet group to associate with the replication instance.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The engine version number of the replication instance.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.

Default: true

" }, "Tags":{ "shape":"TagList", "documentation":"

Tags to be associated with the replication instance.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

The KMS key identifier that will be used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

" }, "PubliclyAccessible":{ "shape":"BooleanOptional", "documentation":"

Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.

" } }, "documentation":"

" }, "CreateReplicationInstanceResponse":{ "type":"structure", "members":{ "ReplicationInstance":{ "shape":"ReplicationInstance", "documentation":"

The replication instance that was created.

" } }, "documentation":"

" }, "CreateReplicationSubnetGroupMessage":{ "type":"structure", "required":[ "ReplicationSubnetGroupIdentifier", "ReplicationSubnetGroupDescription", "SubnetIds" ], "members":{ "ReplicationSubnetGroupIdentifier":{ "shape":"String", "documentation":"

The name for the replication subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be \"default\".

Example: mySubnetgroup

" }, "ReplicationSubnetGroupDescription":{ "shape":"String", "documentation":"

The description for the subnet group.

" }, "SubnetIds":{ "shape":"SubnetIdentifierList", "documentation":"

The EC2 subnet IDs for the subnet group.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tag to be assigned to the subnet group.

" } }, "documentation":"

" }, "CreateReplicationSubnetGroupResponse":{ "type":"structure", "members":{ "ReplicationSubnetGroup":{ "shape":"ReplicationSubnetGroup", "documentation":"

The replication subnet group that was created.

" } }, "documentation":"

" }, "CreateReplicationTaskMessage":{ "type":"structure", "required":[ "ReplicationTaskIdentifier", "SourceEndpointArn", "TargetEndpointArn", "ReplicationInstanceArn", "MigrationType", "TableMappings" ], "members":{ "ReplicationTaskIdentifier":{ "shape":"String", "documentation":"

The replication task identifier.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" }, "SourceEndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" }, "TargetEndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" }, "ReplicationInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" }, "MigrationType":{ "shape":"MigrationTypeValue", "documentation":"

The migration type.

" }, "TableMappings":{ "shape":"String", "documentation":"

The path of the JSON file that contains the table mappings. Preceed the path with \"file://\".

For example, --table-mappings file://mappingfile.json

" }, "ReplicationTaskSettings":{ "shape":"String", "documentation":"

Settings for the task, such as target metadata settings. For a complete list of task settings, see Task Settings for AWS Database Migration Service Tasks.

" }, "CdcStartTime":{ "shape":"TStamp", "documentation":"

The start time for the Change Data Capture (CDC) operation.

" }, "Tags":{ "shape":"TagList", "documentation":"

Tags to be added to the replication instance.

" } }, "documentation":"

" }, "CreateReplicationTaskResponse":{ "type":"structure", "members":{ "ReplicationTask":{ "shape":"ReplicationTask", "documentation":"

The replication task that was created.

" } }, "documentation":"

" }, "DeleteCertificateMessage":{ "type":"structure", "required":["CertificateArn"], "members":{ "CertificateArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the deleted certificate.

" } } }, "DeleteCertificateResponse":{ "type":"structure", "members":{ "Certificate":{ "shape":"Certificate", "documentation":"

The Secure Sockets Layer (SSL) certificate.

" } } }, "DeleteEndpointMessage":{ "type":"structure", "required":["EndpointArn"], "members":{ "EndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" } }, "documentation":"

" }, "DeleteEndpointResponse":{ "type":"structure", "members":{ "Endpoint":{ "shape":"Endpoint", "documentation":"

The endpoint that was deleted.

" } }, "documentation":"

" }, "DeleteReplicationInstanceMessage":{ "type":"structure", "required":["ReplicationInstanceArn"], "members":{ "ReplicationInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the replication instance to be deleted.

" } }, "documentation":"

" }, "DeleteReplicationInstanceResponse":{ "type":"structure", "members":{ "ReplicationInstance":{ "shape":"ReplicationInstance", "documentation":"

The replication instance that was deleted.

" } }, "documentation":"

" }, "DeleteReplicationSubnetGroupMessage":{ "type":"structure", "required":["ReplicationSubnetGroupIdentifier"], "members":{ "ReplicationSubnetGroupIdentifier":{ "shape":"String", "documentation":"

The subnet group name of the replication instance.

" } }, "documentation":"

" }, "DeleteReplicationSubnetGroupResponse":{ "type":"structure", "members":{ }, "documentation":"

" }, "DeleteReplicationTaskMessage":{ "type":"structure", "required":["ReplicationTaskArn"], "members":{ "ReplicationTaskArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the replication task to be deleted.

" } }, "documentation":"

" }, "DeleteReplicationTaskResponse":{ "type":"structure", "members":{ "ReplicationTask":{ "shape":"ReplicationTask", "documentation":"

The deleted replication task.

" } }, "documentation":"

" }, "DescribeAccountAttributesMessage":{ "type":"structure", "members":{ }, "documentation":"

" }, "DescribeAccountAttributesResponse":{ "type":"structure", "members":{ "AccountQuotas":{ "shape":"AccountQuotaList", "documentation":"

Account quota information.

" } }, "documentation":"

" }, "DescribeCertificatesMessage":{ "type":"structure", "members":{ "Filters":{ "shape":"FilterList", "documentation":"

Filters applied to the certificate described in the form of key-value pairs.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 10

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } } }, "DescribeCertificatesResponse":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

The pagination token.

" }, "Certificates":{ "shape":"CertificateList", "documentation":"

The Secure Sockets Layer (SSL) certificates associated with the replication instance.

" } } }, "DescribeConnectionsMessage":{ "type":"structure", "members":{ "Filters":{ "shape":"FilterList", "documentation":"

The filters applied to the connection.

Valid filter names: endpoint-arn | replication-instance-arn

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeConnectionsResponse":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "Connections":{ "shape":"ConnectionList", "documentation":"

A description of the connections.

" } }, "documentation":"

" }, "DescribeEndpointTypesMessage":{ "type":"structure", "members":{ "Filters":{ "shape":"FilterList", "documentation":"

Filters applied to the describe action.

Valid filter names: engine-name | endpoint-type

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeEndpointTypesResponse":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "SupportedEndpointTypes":{ "shape":"SupportedEndpointTypeList", "documentation":"

The type of endpoints that are supported.

" } }, "documentation":"

" }, "DescribeEndpointsMessage":{ "type":"structure", "members":{ "Filters":{ "shape":"FilterList", "documentation":"

Filters applied to the describe action.

Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeEndpointsResponse":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "Endpoints":{ "shape":"EndpointList", "documentation":"

Endpoint description.

" } }, "documentation":"

" }, "DescribeOrderableReplicationInstancesMessage":{ "type":"structure", "members":{ "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeOrderableReplicationInstancesResponse":{ "type":"structure", "members":{ "OrderableReplicationInstances":{ "shape":"OrderableReplicationInstanceList", "documentation":"

The order-able replication instances available.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeRefreshSchemasStatusMessage":{ "type":"structure", "required":["EndpointArn"], "members":{ "EndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" } }, "documentation":"

" }, "DescribeRefreshSchemasStatusResponse":{ "type":"structure", "members":{ "RefreshSchemasStatus":{ "shape":"RefreshSchemasStatus", "documentation":"

The status of the schema.

" } }, "documentation":"

" }, "DescribeReplicationInstancesMessage":{ "type":"structure", "members":{ "Filters":{ "shape":"FilterList", "documentation":"

Filters applied to the describe action.

Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeReplicationInstancesResponse":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "ReplicationInstances":{ "shape":"ReplicationInstanceList", "documentation":"

The replication instances described.

" } }, "documentation":"

" }, "DescribeReplicationSubnetGroupsMessage":{ "type":"structure", "members":{ "Filters":{ "shape":"FilterList", "documentation":"

Filters applied to the describe action.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeReplicationSubnetGroupsResponse":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "ReplicationSubnetGroups":{ "shape":"ReplicationSubnetGroups", "documentation":"

A description of the replication subnet groups.

" } }, "documentation":"

" }, "DescribeReplicationTasksMessage":{ "type":"structure", "members":{ "Filters":{ "shape":"FilterList", "documentation":"

Filters applied to the describe action.

Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeReplicationTasksResponse":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "ReplicationTasks":{ "shape":"ReplicationTaskList", "documentation":"

A description of the replication tasks.

" } }, "documentation":"

" }, "DescribeSchemasMessage":{ "type":"structure", "required":["EndpointArn"], "members":{ "EndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeSchemasResponse":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" }, "Schemas":{ "shape":"SchemaList", "documentation":"

The described schema.

" } }, "documentation":"

" }, "DescribeTableStatisticsMessage":{ "type":"structure", "required":["ReplicationTaskArn"], "members":{ "ReplicationTaskArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the replication task.

" }, "MaxRecords":{ "shape":"IntegerOptional", "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DescribeTableStatisticsResponse":{ "type":"structure", "members":{ "ReplicationTaskArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the replication task.

" }, "TableStatistics":{ "shape":"TableStatisticsList", "documentation":"

The table statistics.

" }, "Marker":{ "shape":"String", "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" } }, "documentation":"

" }, "DmsSslModeValue":{ "type":"string", "enum":[ "none", "require", "verify-ca", "verify-full" ] }, "Endpoint":{ "type":"structure", "members":{ "EndpointIdentifier":{ "shape":"String", "documentation":"

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

" }, "EndpointType":{ "shape":"ReplicationEndpointTypeValue", "documentation":"

The type of endpoint.

" }, "EngineName":{ "shape":"String", "documentation":"

The database engine name. Valid values include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, SYBASE, and SQLSERVER.

" }, "Username":{ "shape":"String", "documentation":"

The user name used to connect to the endpoint.

" }, "ServerName":{ "shape":"String", "documentation":"

The name of the server at the endpoint.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port value used to access the endpoint.

" }, "DatabaseName":{ "shape":"String", "documentation":"

The name of the database at the endpoint.

" }, "ExtraConnectionAttributes":{ "shape":"String", "documentation":"

Additional connection attributes used to connect to the endpoint.

" }, "Status":{ "shape":"String", "documentation":"

The status of the endpoint.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

" }, "EndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" }, "CertificateArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

" }, "SslMode":{ "shape":"DmsSslModeValue", "documentation":"

The SSL mode used to connect to the endpoint.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

" } }, "documentation":"

" }, "EndpointList":{ "type":"list", "member":{ "shape":"Endpoint", "locationName":"Endpoint" } }, "ExceptionMessage":{"type":"string"}, "Filter":{ "type":"structure", "required":[ "Name", "Values" ], "members":{ "Name":{ "shape":"String", "documentation":"

The name of the filter.

" }, "Values":{ "shape":"FilterValueList", "documentation":"

The filter value.

" } }, "documentation":"

" }, "FilterList":{ "type":"list", "member":{ "shape":"Filter", "locationName":"Filter" } }, "FilterValueList":{ "type":"list", "member":{ "shape":"String", "locationName":"Value" } }, "ImportCertificateMessage":{ "type":"structure", "required":["CertificateIdentifier"], "members":{ "CertificateIdentifier":{ "shape":"String", "documentation":"

The customer-assigned name of the certificate. Valid characters are A-z and 0-9.

" }, "CertificatePem":{ "shape":"String", "documentation":"

The contents of the .pem X.509 certificate file for the certificate.

" }, "CertificateWallet":{ "shape":"CertificateWallet", "documentation":"

The location of the imported Oracle Wallet certificate for use with SSL.

" } } }, "ImportCertificateResponse":{ "type":"structure", "members":{ "Certificate":{ "shape":"Certificate", "documentation":"

The certificate to be uploaded.

" } } }, "InsufficientResourceCapacityFault":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

" } }, "documentation":"

There are not enough resources allocated to the database migration.

", "exception":true }, "Integer":{"type":"integer"}, "IntegerOptional":{"type":"integer"}, "InvalidCertificateFault":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"

The certificate was not valid.

", "exception":true }, "InvalidResourceStateFault":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

" } }, "documentation":"

The resource is in a state that prevents it from being used for database migration.

", "exception":true }, "InvalidSubnet":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

" } }, "documentation":"

The subnet provided is invalid.

", "exception":true }, "KMSKeyNotAccessibleFault":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

" } }, "documentation":"

AWS DMS cannot access the KMS key.

", "exception":true }, "KeyList":{ "type":"list", "member":{"shape":"String"} }, "ListTagsForResourceMessage":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource.

" } }, "documentation":"

" }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "TagList":{ "shape":"TagList", "documentation":"

A list of tags for the resource.

" } }, "documentation":"

" }, "Long":{"type":"long"}, "MigrationTypeValue":{ "type":"string", "enum":[ "full-load", "cdc", "full-load-and-cdc" ] }, "ModifyEndpointMessage":{ "type":"structure", "required":["EndpointArn"], "members":{ "EndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" }, "EndpointIdentifier":{ "shape":"String", "documentation":"

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

" }, "EndpointType":{ "shape":"ReplicationEndpointTypeValue", "documentation":"

The type of endpoint.

" }, "EngineName":{ "shape":"String", "documentation":"

The type of engine for the endpoint. Valid values include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, SYBASE, and SQLSERVER.

" }, "Username":{ "shape":"String", "documentation":"

The user name to be used to login to the endpoint database.

" }, "Password":{ "shape":"SecretString", "documentation":"

The password to be used to login to the endpoint database.

" }, "ServerName":{ "shape":"String", "documentation":"

The name of the server where the endpoint database resides.

" }, "Port":{ "shape":"IntegerOptional", "documentation":"

The port used by the endpoint database.

" }, "DatabaseName":{ "shape":"String", "documentation":"

The name of the endpoint database.

" }, "ExtraConnectionAttributes":{ "shape":"String", "documentation":"

Additional attributes associated with the connection.

" }, "CertificateArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

" }, "SslMode":{ "shape":"DmsSslModeValue", "documentation":"

The SSL mode to be used.

SSL mode can be one of four values: none, require, verify-ca, verify-full.

The default value is none.

" } }, "documentation":"

" }, "ModifyEndpointResponse":{ "type":"structure", "members":{ "Endpoint":{ "shape":"Endpoint", "documentation":"

The modified endpoint.

" } }, "documentation":"

" }, "ModifyReplicationInstanceMessage":{ "type":"structure", "required":["ReplicationInstanceArn"], "members":{ "ReplicationInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" }, "AllocatedStorage":{ "shape":"IntegerOptional", "documentation":"

The amount of storage (in gigabytes) to be allocated for the replication instance.

" }, "ApplyImmediately":{ "shape":"Boolean", "documentation":"

Indicates whether the changes should be applied immediately or during the next maintenance window.

" }, "ReplicationInstanceClass":{ "shape":"String", "documentation":"

The compute and memory capacity of the replication instance.

Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", "documentation":"

Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The engine version number of the replication instance.

" }, "AllowMajorVersionUpgrade":{ "shape":"Boolean", "documentation":"

Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version.

" }, "AutoMinorVersionUpgrade":{ "shape":"BooleanOptional", "documentation":"

Indicates that minor version upgrades will be applied automatically to the replication instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and AWS DMS has enabled auto patching for that engine version.

" }, "ReplicationInstanceIdentifier":{ "shape":"String", "documentation":"

The replication instance identifier. This parameter is stored as a lowercase string.

" } }, "documentation":"

" }, "ModifyReplicationInstanceResponse":{ "type":"structure", "members":{ "ReplicationInstance":{ "shape":"ReplicationInstance", "documentation":"

The modified replication instance.

" } }, "documentation":"

" }, "ModifyReplicationSubnetGroupMessage":{ "type":"structure", "required":[ "ReplicationSubnetGroupIdentifier", "SubnetIds" ], "members":{ "ReplicationSubnetGroupIdentifier":{ "shape":"String", "documentation":"

The name of the replication instance subnet group.

" }, "ReplicationSubnetGroupDescription":{ "shape":"String", "documentation":"

The description of the replication instance subnet group.

" }, "SubnetIds":{ "shape":"SubnetIdentifierList", "documentation":"

A list of subnet IDs.

" } }, "documentation":"

" }, "ModifyReplicationSubnetGroupResponse":{ "type":"structure", "members":{ "ReplicationSubnetGroup":{ "shape":"ReplicationSubnetGroup", "documentation":"

The modified replication subnet group.

" } }, "documentation":"

" }, "ModifyReplicationTaskMessage":{ "type":"structure", "required":["ReplicationTaskArn"], "members":{ "ReplicationTaskArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the replication task.

" }, "ReplicationTaskIdentifier":{ "shape":"String", "documentation":"

The replication task identifier.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" }, "MigrationType":{ "shape":"MigrationTypeValue", "documentation":"

The migration type.

Valid values: full-load | cdc | full-load-and-cdc

" }, "TableMappings":{ "shape":"String", "documentation":"

The path of the JSON file that contains the table mappings. Preceed the path with \"file://\".

For example, --table-mappings file://mappingfile.json

" }, "ReplicationTaskSettings":{ "shape":"String", "documentation":"

JSON file that contains settings for the task, such as target metadata settings.

" }, "CdcStartTime":{ "shape":"TStamp", "documentation":"

The start time for the Change Data Capture (CDC) operation.

" } }, "documentation":"

" }, "ModifyReplicationTaskResponse":{ "type":"structure", "members":{ "ReplicationTask":{ "shape":"ReplicationTask", "documentation":"

The replication task that was modified.

" } }, "documentation":"

" }, "OrderableReplicationInstance":{ "type":"structure", "members":{ "EngineVersion":{ "shape":"String", "documentation":"

The version of the replication engine.

" }, "ReplicationInstanceClass":{ "shape":"String", "documentation":"

The compute and memory capacity of the replication instance.

Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

" }, "StorageType":{ "shape":"String", "documentation":"

The type of storage used by the replication instance.

" }, "MinAllocatedStorage":{ "shape":"Integer", "documentation":"

The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

" }, "MaxAllocatedStorage":{ "shape":"Integer", "documentation":"

The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

" }, "DefaultAllocatedStorage":{ "shape":"Integer", "documentation":"

The default amount of storage (in gigabytes) that is allocated for the replication instance.

" }, "IncludedAllocatedStorage":{ "shape":"Integer", "documentation":"

The amount of storage (in gigabytes) that is allocated for the replication instance.

" } }, "documentation":"

" }, "OrderableReplicationInstanceList":{ "type":"list", "member":{ "shape":"OrderableReplicationInstance", "locationName":"OrderableReplicationInstance" } }, "RefreshSchemasMessage":{ "type":"structure", "required":[ "EndpointArn", "ReplicationInstanceArn" ], "members":{ "EndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" }, "ReplicationInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" } }, "documentation":"

" }, "RefreshSchemasResponse":{ "type":"structure", "members":{ "RefreshSchemasStatus":{ "shape":"RefreshSchemasStatus", "documentation":"

The status of the refreshed schema.

" } }, "documentation":"

" }, "RefreshSchemasStatus":{ "type":"structure", "members":{ "EndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" }, "ReplicationInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" }, "Status":{ "shape":"RefreshSchemasStatusTypeValue", "documentation":"

The status of the schema.

" }, "LastRefreshDate":{ "shape":"TStamp", "documentation":"

The date the schema was last refreshed.

" }, "LastFailureMessage":{ "shape":"String", "documentation":"

The last failure message for the schema.

" } }, "documentation":"

" }, "RefreshSchemasStatusTypeValue":{ "type":"string", "enum":[ "successful", "failed", "refreshing" ] }, "RemoveTagsFromResourceMessage":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"String", "documentation":"

>The Amazon Resource Name (ARN) of the AWS DMS resource the tag is to be removed from.

" }, "TagKeys":{ "shape":"KeyList", "documentation":"

The tag key (name) of the tag to be removed.

" } }, "documentation":"

" }, "RemoveTagsFromResourceResponse":{ "type":"structure", "members":{ }, "documentation":"

" }, "ReplicationEndpointTypeValue":{ "type":"string", "enum":[ "source", "target" ] }, "ReplicationInstance":{ "type":"structure", "members":{ "ReplicationInstanceIdentifier":{ "shape":"String", "documentation":"

The replication instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

" }, "ReplicationInstanceClass":{ "shape":"String", "documentation":"

The compute and memory capacity of the replication instance.

Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

" }, "ReplicationInstanceStatus":{ "shape":"String", "documentation":"

The status of the replication instance.

" }, "AllocatedStorage":{ "shape":"Integer", "documentation":"

The amount of storage (in gigabytes) that is allocated for the replication instance.

" }, "InstanceCreateTime":{ "shape":"TStamp", "documentation":"

The time the replication instance was created.

" }, "VpcSecurityGroups":{ "shape":"VpcSecurityGroupMembershipList", "documentation":"

The VPC security group for the instance.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone for the instance.

" }, "ReplicationSubnetGroup":{ "shape":"ReplicationSubnetGroup", "documentation":"

The subnet group for the replication instance.

" }, "PreferredMaintenanceWindow":{ "shape":"String", "documentation":"

The maintenance window times for the replication instance.

" }, "PendingModifiedValues":{ "shape":"ReplicationPendingModifiedValues", "documentation":"

The pending modification values.

" }, "MultiAZ":{ "shape":"Boolean", "documentation":"

Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The engine version number of the replication instance.

" }, "AutoMinorVersionUpgrade":{ "shape":"Boolean", "documentation":"

Boolean value indicating if minor version upgrades will be automatically applied to the instance.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

The KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.

" }, "ReplicationInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" }, "ReplicationInstancePublicIpAddress":{ "shape":"String", "documentation":"

The public IP address of the replication instance.

", "deprecated":true }, "ReplicationInstancePrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the replication instance.

", "deprecated":true }, "ReplicationInstancePublicIpAddresses":{ "shape":"ReplicationInstancePublicIpAddressList", "documentation":"

The public IP address of the replication instance.

" }, "ReplicationInstancePrivateIpAddresses":{ "shape":"ReplicationInstancePrivateIpAddressList", "documentation":"

The private IP address of the replication instance.

" }, "PubliclyAccessible":{ "shape":"Boolean", "documentation":"

Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.

" }, "SecondaryAvailabilityZone":{ "shape":"String", "documentation":"

The availability zone of the standby replication instance in a Multi-AZ deployment.

" } }, "documentation":"

" }, "ReplicationInstanceList":{ "type":"list", "member":{ "shape":"ReplicationInstance", "locationName":"ReplicationInstance" } }, "ReplicationInstancePrivateIpAddressList":{ "type":"list", "member":{"shape":"String"} }, "ReplicationInstancePublicIpAddressList":{ "type":"list", "member":{"shape":"String"} }, "ReplicationPendingModifiedValues":{ "type":"structure", "members":{ "ReplicationInstanceClass":{ "shape":"String", "documentation":"

The compute and memory capacity of the replication instance.

Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

" }, "AllocatedStorage":{ "shape":"IntegerOptional", "documentation":"

The amount of storage (in gigabytes) that is allocated for the replication instance.

" }, "MultiAZ":{ "shape":"BooleanOptional", "documentation":"

Specifies if the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The engine version number of the replication instance.

" } }, "documentation":"

" }, "ReplicationSubnetGroup":{ "type":"structure", "members":{ "ReplicationSubnetGroupIdentifier":{ "shape":"String", "documentation":"

The identifier of the replication instance subnet group.

" }, "ReplicationSubnetGroupDescription":{ "shape":"String", "documentation":"

The description of the replication subnet group.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC.

" }, "SubnetGroupStatus":{ "shape":"String", "documentation":"

The status of the subnet group.

" }, "Subnets":{ "shape":"SubnetList", "documentation":"

The subnets that are in the subnet group.

" } }, "documentation":"

" }, "ReplicationSubnetGroupDoesNotCoverEnoughAZs":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

" } }, "documentation":"

The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.

", "exception":true }, "ReplicationSubnetGroups":{ "type":"list", "member":{ "shape":"ReplicationSubnetGroup", "locationName":"ReplicationSubnetGroup" } }, "ReplicationTask":{ "type":"structure", "members":{ "ReplicationTaskIdentifier":{ "shape":"String", "documentation":"

The replication task identifier.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" }, "SourceEndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" }, "TargetEndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" }, "ReplicationInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" }, "MigrationType":{ "shape":"MigrationTypeValue", "documentation":"

The type of migration.

" }, "TableMappings":{ "shape":"String", "documentation":"

Table mappings specified in the task.

" }, "ReplicationTaskSettings":{ "shape":"String", "documentation":"

The settings for the replication task.

" }, "Status":{ "shape":"String", "documentation":"

The status of the replication task.

" }, "LastFailureMessage":{ "shape":"String", "documentation":"

The last error (failure) message generated for the replication instance.

" }, "StopReason":{ "shape":"String", "documentation":"

The reason the replication task was stopped.

" }, "ReplicationTaskCreationDate":{ "shape":"TStamp", "documentation":"

The date the replication task was created.

" }, "ReplicationTaskStartDate":{ "shape":"TStamp", "documentation":"

The date the replication task is scheduled to start.

" }, "ReplicationTaskArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the replication task.

" }, "ReplicationTaskStats":{ "shape":"ReplicationTaskStats", "documentation":"

The statistics for the task, including elapsed time, tables loaded, and table errors.

" } }, "documentation":"

" }, "ReplicationTaskList":{ "type":"list", "member":{ "shape":"ReplicationTask", "locationName":"ReplicationTask" } }, "ReplicationTaskStats":{ "type":"structure", "members":{ "FullLoadProgressPercent":{ "shape":"Integer", "documentation":"

The percent complete for the full load migration task.

" }, "ElapsedTimeMillis":{ "shape":"Long", "documentation":"

The elapsed time of the task, in milliseconds.

" }, "TablesLoaded":{ "shape":"Integer", "documentation":"

The number of tables loaded for this task.

" }, "TablesLoading":{ "shape":"Integer", "documentation":"

The number of tables currently loading for this task.

" }, "TablesQueued":{ "shape":"Integer", "documentation":"

The number of tables queued for this task.

" }, "TablesErrored":{ "shape":"Integer", "documentation":"

The number of errors that have occurred during this task.

" } }, "documentation":"

" }, "ResourceAlreadyExistsFault":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

" } }, "documentation":"

The resource you are attempting to create already exists.

", "exception":true }, "ResourceNotFoundFault":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

" } }, "documentation":"

The resource could not be found.

", "exception":true }, "ResourceQuotaExceededFault":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

" } }, "documentation":"

The quota for this resource quota has been exceeded.

", "exception":true }, "SchemaList":{ "type":"list", "member":{"shape":"String"} }, "SecretString":{ "type":"string", "sensitive":true }, "StartReplicationTaskMessage":{ "type":"structure", "required":[ "ReplicationTaskArn", "StartReplicationTaskType" ], "members":{ "ReplicationTaskArn":{ "shape":"String", "documentation":"

The Amazon Resource Number (ARN) of the replication task to be started.

" }, "StartReplicationTaskType":{ "shape":"StartReplicationTaskTypeValue", "documentation":"

The type of replication task.

" }, "CdcStartTime":{ "shape":"TStamp", "documentation":"

The start time for the Change Data Capture (CDC) operation.

" } }, "documentation":"

" }, "StartReplicationTaskResponse":{ "type":"structure", "members":{ "ReplicationTask":{ "shape":"ReplicationTask", "documentation":"

The replication task started.

" } }, "documentation":"

" }, "StartReplicationTaskTypeValue":{ "type":"string", "enum":[ "start-replication", "resume-processing", "reload-target" ] }, "StopReplicationTaskMessage":{ "type":"structure", "required":["ReplicationTaskArn"], "members":{ "ReplicationTaskArn":{ "shape":"String", "documentation":"

The Amazon Resource Number(ARN) of the replication task to be stopped.

" } }, "documentation":"

" }, "StopReplicationTaskResponse":{ "type":"structure", "members":{ "ReplicationTask":{ "shape":"ReplicationTask", "documentation":"

The replication task stopped.

" } }, "documentation":"

" }, "StorageQuotaExceededFault":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

" } }, "documentation":"

The storage quota has been exceeded.

", "exception":true }, "String":{"type":"string"}, "Subnet":{ "type":"structure", "members":{ "SubnetIdentifier":{ "shape":"String", "documentation":"

The subnet identifier.

" }, "SubnetAvailabilityZone":{ "shape":"AvailabilityZone", "documentation":"

The Availability Zone of the subnet.

" }, "SubnetStatus":{ "shape":"String", "documentation":"

The status of the subnet.

" } }, "documentation":"

" }, "SubnetAlreadyInUse":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

" } }, "documentation":"

The specified subnet is already in use.

", "exception":true }, "SubnetIdentifierList":{ "type":"list", "member":{ "shape":"String", "locationName":"SubnetIdentifier" } }, "SubnetList":{ "type":"list", "member":{ "shape":"Subnet", "locationName":"Subnet" } }, "SupportedEndpointType":{ "type":"structure", "members":{ "EngineName":{ "shape":"String", "documentation":"

The database engine name. Valid values include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, SYBASE, and SQLSERVER.

" }, "SupportsCDC":{ "shape":"Boolean", "documentation":"

Indicates if Change Data Capture (CDC) is supported.

" }, "EndpointType":{ "shape":"ReplicationEndpointTypeValue", "documentation":"

The type of endpoint.

" } }, "documentation":"

" }, "SupportedEndpointTypeList":{ "type":"list", "member":{ "shape":"SupportedEndpointType", "locationName":"SupportedEndpointType" } }, "TStamp":{"type":"timestamp"}, "TableStatistics":{ "type":"structure", "members":{ "SchemaName":{ "shape":"String", "documentation":"

The schema name.

" }, "TableName":{ "shape":"String", "documentation":"

The name of the table.

" }, "Inserts":{ "shape":"Long", "documentation":"

The number of insert actions performed on a table.

" }, "Deletes":{ "shape":"Long", "documentation":"

The number of delete actions performed on a table.

" }, "Updates":{ "shape":"Long", "documentation":"

The number of update actions performed on a table.

" }, "Ddls":{ "shape":"Long", "documentation":"

The Data Definition Language (DDL) used to build and modify the structure of your tables.

" }, "FullLoadRows":{ "shape":"Long", "documentation":"

The number of rows added during the Full Load operation.

" }, "LastUpdateTime":{ "shape":"TStamp", "documentation":"

The last time the table was updated.

" }, "TableState":{ "shape":"String", "documentation":"

The state of the table.

" } }, "documentation":"

" }, "TableStatisticsList":{ "type":"list", "member":{"shape":"TableStatistics"} }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" }, "Value":{ "shape":"String", "documentation":"

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" } }, "documentation":"

" }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"Tag" } }, "TestConnectionMessage":{ "type":"structure", "required":[ "ReplicationInstanceArn", "EndpointArn" ], "members":{ "ReplicationInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" }, "EndpointArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" } }, "documentation":"

" }, "TestConnectionResponse":{ "type":"structure", "members":{ "Connection":{ "shape":"Connection", "documentation":"

The connection tested.

" } }, "documentation":"

" }, "UpgradeDependencyFailureFault":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

" } }, "documentation":"

An upgrade dependency is preventing the database migration.

", "exception":true }, "VpcSecurityGroupIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"VpcSecurityGroupId" } }, "VpcSecurityGroupMembership":{ "type":"structure", "members":{ "VpcSecurityGroupId":{ "shape":"String", "documentation":"

The VPC security group Id.

" }, "Status":{ "shape":"String", "documentation":"

The status of the VPC security group.

" } }, "documentation":"

" }, "VpcSecurityGroupMembershipList":{ "type":"list", "member":{ "shape":"VpcSecurityGroupMembership", "locationName":"VpcSecurityGroupMembership" } } }, "documentation":"AWS Database Migration Service

AWS Database Migration Service (AWS DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL.

" } botocore-1.5.7/botocore/data/config/0000777454262600001440000000000013042511307020400 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/config/2014-11-12/0000777454262600001440000000000013042511307021425 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/config/2014-11-12/paginators-1.json0000666454262600001440000000211413042511306024622 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeComplianceByConfigRule": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "ComplianceByConfigRules" }, "DescribeComplianceByResource": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "ComplianceByResources" }, "DescribeConfigRules": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "ConfigRules" }, "GetComplianceDetailsByConfigRule": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "EvaluationResults" }, "GetComplianceDetailsByResource": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "EvaluationResults" }, "GetResourceConfigHistory": { "input_token": "nextToken", "output_token": "nextToken", "result_key": "configurationItems" }, "ListDiscoveredResources": { "input_token": "nextToken", "output_token": "nextToken", "result_key": "resourceIdentifiers" } } } botocore-1.5.7/botocore/data/config/2014-11-12/service-2.json0000777454262600001440000032611613042511306024132 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2014-11-12", "endpointPrefix":"config", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"Config Service", "serviceFullName":"AWS Config", "signatureVersion":"v4", "targetPrefix":"StarlingDoveService", "uid":"config-2014-11-12" }, "operations":{ "DeleteConfigRule":{ "name":"DeleteConfigRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteConfigRuleRequest"}, "errors":[ {"shape":"NoSuchConfigRuleException"}, {"shape":"ResourceInUseException"} ], "documentation":"

Deletes the specified AWS Config rule and all of its evaluation results.

AWS Config sets the state of a rule to DELETING until the deletion is complete. You cannot update a rule while it is in this state. If you make a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException.

You can check the state of a rule by using the DescribeConfigRules request.

" }, "DeleteConfigurationRecorder":{ "name":"DeleteConfigurationRecorder", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteConfigurationRecorderRequest"}, "errors":[ {"shape":"NoSuchConfigurationRecorderException"} ], "documentation":"

Deletes the configuration recorder.

After the configuration recorder is deleted, AWS Config will not record resource configuration changes until you create a new configuration recorder.

This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory action, but you will not be able to access this information in the AWS Config console until you create a new configuration recorder.

" }, "DeleteDeliveryChannel":{ "name":"DeleteDeliveryChannel", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDeliveryChannelRequest"}, "errors":[ {"shape":"NoSuchDeliveryChannelException"}, {"shape":"LastDeliveryChannelDeleteFailedException"} ], "documentation":"

Deletes the delivery channel.

Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.

" }, "DeleteEvaluationResults":{ "name":"DeleteEvaluationResults", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteEvaluationResultsRequest"}, "output":{"shape":"DeleteEvaluationResultsResponse"}, "errors":[ {"shape":"NoSuchConfigRuleException"}, {"shape":"ResourceInUseException"} ], "documentation":"

Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your AWS resources against the rule.

" }, "DeliverConfigSnapshot":{ "name":"DeliverConfigSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeliverConfigSnapshotRequest"}, "output":{"shape":"DeliverConfigSnapshotResponse"}, "errors":[ {"shape":"NoSuchDeliveryChannelException"}, {"shape":"NoAvailableConfigurationRecorderException"}, {"shape":"NoRunningConfigurationRecorderException"} ], "documentation":"

Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified.

  • Notification of starting the delivery.

  • Notification of delivery completed, if the delivery was successfully completed.

  • Notification of delivery failure, if the delivery failed to complete.

" }, "DescribeComplianceByConfigRule":{ "name":"DescribeComplianceByConfigRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeComplianceByConfigRuleRequest"}, "output":{"shape":"DescribeComplianceByConfigRuleResponse"}, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"NoSuchConfigRuleException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule.

A rule is compliant if all of the evaluated resources comply with it, and it is noncompliant if any of these resources do not comply.

If AWS Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions:

  • AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.

  • The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission.

  • The rule's AWS Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

" }, "DescribeComplianceByResource":{ "name":"DescribeComplianceByResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeComplianceByResourceRequest"}, "output":{"shape":"DescribeComplianceByResourceResponse"}, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Indicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with.

A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.

If AWS Config has no current evaluation results for the resource, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource:

  • AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.

  • The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission.

  • The rule's AWS Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

" }, "DescribeConfigRuleEvaluationStatus":{ "name":"DescribeConfigRuleEvaluationStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConfigRuleEvaluationStatusRequest"}, "output":{"shape":"DescribeConfigRuleEvaluationStatusResponse"}, "errors":[ {"shape":"NoSuchConfigRuleException"}, {"shape":"InvalidParameterValueException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure.

" }, "DescribeConfigRules":{ "name":"DescribeConfigRules", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConfigRulesRequest"}, "output":{"shape":"DescribeConfigRulesResponse"}, "errors":[ {"shape":"NoSuchConfigRuleException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Returns details about your AWS Config rules.

" }, "DescribeConfigurationRecorderStatus":{ "name":"DescribeConfigurationRecorderStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConfigurationRecorderStatusRequest"}, "output":{"shape":"DescribeConfigurationRecorderStatusResponse"}, "errors":[ {"shape":"NoSuchConfigurationRecorderException"} ], "documentation":"

Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account.

Currently, you can specify only one configuration recorder per region in your account.

" }, "DescribeConfigurationRecorders":{ "name":"DescribeConfigurationRecorders", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConfigurationRecordersRequest"}, "output":{"shape":"DescribeConfigurationRecordersResponse"}, "errors":[ {"shape":"NoSuchConfigurationRecorderException"} ], "documentation":"

Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.

Currently, you can specify only one configuration recorder per region in your account.

" }, "DescribeDeliveryChannelStatus":{ "name":"DescribeDeliveryChannelStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDeliveryChannelStatusRequest"}, "output":{"shape":"DescribeDeliveryChannelStatusResponse"}, "errors":[ {"shape":"NoSuchDeliveryChannelException"} ], "documentation":"

Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.

Currently, you can specify only one delivery channel per region in your account.

" }, "DescribeDeliveryChannels":{ "name":"DescribeDeliveryChannels", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDeliveryChannelsRequest"}, "output":{"shape":"DescribeDeliveryChannelsResponse"}, "errors":[ {"shape":"NoSuchDeliveryChannelException"} ], "documentation":"

Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.

Currently, you can specify only one delivery channel per region in your account.

" }, "GetComplianceDetailsByConfigRule":{ "name":"GetComplianceDetailsByConfigRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetComplianceDetailsByConfigRuleRequest"}, "output":{"shape":"GetComplianceDetailsByConfigRuleResponse"}, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidNextTokenException"}, {"shape":"NoSuchConfigRuleException"} ], "documentation":"

Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.

" }, "GetComplianceDetailsByResource":{ "name":"GetComplianceDetailsByResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetComplianceDetailsByResourceRequest"}, "output":{"shape":"GetComplianceDetailsByResourceResponse"}, "errors":[ {"shape":"InvalidParameterValueException"} ], "documentation":"

Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule.

" }, "GetComplianceSummaryByConfigRule":{ "name":"GetComplianceSummaryByConfigRule", "http":{ "method":"POST", "requestUri":"/" }, "output":{"shape":"GetComplianceSummaryByConfigRuleResponse"}, "documentation":"

Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.

" }, "GetComplianceSummaryByResourceType":{ "name":"GetComplianceSummaryByResourceType", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetComplianceSummaryByResourceTypeRequest"}, "output":{"shape":"GetComplianceSummaryByResourceTypeResponse"}, "errors":[ {"shape":"InvalidParameterValueException"} ], "documentation":"

Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.

" }, "GetResourceConfigHistory":{ "name":"GetResourceConfigHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetResourceConfigHistoryRequest"}, "output":{"shape":"GetResourceConfigHistoryResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InvalidTimeRangeException"}, {"shape":"InvalidLimitException"}, {"shape":"InvalidNextTokenException"}, {"shape":"NoAvailableConfigurationRecorderException"}, {"shape":"ResourceNotDiscoveredException"} ], "documentation":"

Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval.

The response is paginated, and by default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the limit parameter. The response includes a nextToken string, and to get the next page of results, run the request again and enter this string for the nextToken parameter.

Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken.

" }, "ListDiscoveredResources":{ "name":"ListDiscoveredResources", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDiscoveredResourcesRequest"}, "output":{"shape":"ListDiscoveredResourcesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InvalidLimitException"}, {"shape":"InvalidNextTokenException"}, {"shape":"NoAvailableConfigurationRecorderException"} ], "documentation":"

Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.

You can specify either resource IDs or a resource name but not both in the same request.

The response is paginated, and by default AWS Config lists 100 resource identifiers on each page. You can customize this number with the limit parameter. The response includes a nextToken string, and to get the next page of results, run the request again and enter this string for the nextToken parameter.

" }, "PutConfigRule":{ "name":"PutConfigRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutConfigRuleRequest"}, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"MaxNumberOfConfigRulesExceededException"}, {"shape":"ResourceInUseException"}, {"shape":"InsufficientPermissionsException"}, {"shape":"NoAvailableConfigurationRecorderException"} ], "documentation":"

Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.

You can use this action for custom Config rules and AWS managed Config rules. A custom Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.

If you are adding a new custom Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the PutConfigRule action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object.

If you are adding a new AWS managed Config rule, specify the rule's identifier for the SourceIdentifier key. To reference AWS managed Config rule identifiers, see Using AWS Managed Config Rules.

For any new rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by AWS Config for new rules.

If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request.

The maximum number of rules that AWS Config supports is 50.

For more information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide.

For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.

" }, "PutConfigurationRecorder":{ "name":"PutConfigurationRecorder", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutConfigurationRecorderRequest"}, "errors":[ {"shape":"MaxNumberOfConfigurationRecordersExceededException"}, {"shape":"InvalidConfigurationRecorderNameException"}, {"shape":"InvalidRoleException"}, {"shape":"InvalidRecordingGroupException"} ], "documentation":"

Creates a new configuration recorder to record the selected resource configurations.

You can use this action to change the role roleARN and/or the recordingGroup of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.

Currently, you can specify only one configuration recorder per region in your account.

If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types.

" }, "PutDeliveryChannel":{ "name":"PutDeliveryChannel", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutDeliveryChannelRequest"}, "errors":[ {"shape":"MaxNumberOfDeliveryChannelsExceededException"}, {"shape":"NoAvailableConfigurationRecorderException"}, {"shape":"InvalidDeliveryChannelNameException"}, {"shape":"NoSuchBucketException"}, {"shape":"InvalidS3KeyPrefixException"}, {"shape":"InvalidSNSTopicARNException"}, {"shape":"InsufficientDeliveryPolicyException"} ], "documentation":"

Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.

Before you can create a delivery channel, you must create a configuration recorder.

You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.

You can have only one delivery channel per region in your account.

" }, "PutEvaluations":{ "name":"PutEvaluations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutEvaluationsRequest"}, "output":{"shape":"PutEvaluationsResponse"}, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidResultTokenException"}, {"shape":"NoSuchConfigRuleException"} ], "documentation":"

Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule.

" }, "StartConfigRulesEvaluation":{ "name":"StartConfigRulesEvaluation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartConfigRulesEvaluationRequest"}, "output":{"shape":"StartConfigRulesEvaluationResponse"}, "errors":[ {"shape":"NoSuchConfigRuleException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidParameterValueException"} ], "documentation":"

Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when you want to test a rule that you updated is working as expected. StartConfigRulesEvaluation does not re-record the latest configuration state for your resources; it re-runs an evaluation against the last known state of your resources.

You can specify up to 25 Config rules per request.

An existing StartConfigRulesEvaluation call must complete for the specified rules before you can call the API again. If you chose to have AWS Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts.

You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a new rule, AWS Config automatically evaluates your resources against the rule.

The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example:

  1. You have a custom rule that evaluates your IAM resources every 24 hours.

  2. You update your Lambda function to add additional conditions to your rule.

  3. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API.

  4. AWS Config invokes your Lambda function and evaluates your IAM resources.

  5. Your custom rule will still run periodic evaluations every 24 hours.

" }, "StartConfigurationRecorder":{ "name":"StartConfigurationRecorder", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartConfigurationRecorderRequest"}, "errors":[ {"shape":"NoSuchConfigurationRecorderException"}, {"shape":"NoAvailableDeliveryChannelException"} ], "documentation":"

Starts recording configurations of the AWS resources you have selected to record in your AWS account.

You must have created at least one delivery channel to successfully start the configuration recorder.

" }, "StopConfigurationRecorder":{ "name":"StopConfigurationRecorder", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopConfigurationRecorderRequest"}, "errors":[ {"shape":"NoSuchConfigurationRecorderException"} ], "documentation":"

Stops recording configurations of the AWS resources you have selected to record in your AWS account.

" } }, "shapes":{ "ARN":{"type":"string"}, "AccountId":{"type":"string"}, "AllSupported":{"type":"boolean"}, "AvailabilityZone":{"type":"string"}, "AwsRegion":{"type":"string"}, "Boolean":{"type":"boolean"}, "ChannelName":{ "type":"string", "max":256, "min":1 }, "ChronologicalOrder":{ "type":"string", "enum":[ "Reverse", "Forward" ] }, "Compliance":{ "type":"structure", "members":{ "ComplianceType":{ "shape":"ComplianceType", "documentation":"

Indicates whether an AWS resource or AWS Config rule is compliant.

A resource is compliant if it complies with all of the AWS Config rules that evaluate it, and it is noncompliant if it does not comply with one or more of these rules.

A rule is compliant if all of the resources that the rule evaluates comply with it, and it is noncompliant if any of these resources do not comply.

AWS Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the AWS resource or Config rule.

For the Compliance data type, AWS Config supports only COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA values. AWS Config does not support the NOT_APPLICABLE value for the Compliance data type.

" }, "ComplianceContributorCount":{ "shape":"ComplianceContributorCount", "documentation":"

The number of AWS resources or AWS Config rules that cause a result of NON_COMPLIANT, up to a maximum number.

" } }, "documentation":"

Indicates whether an AWS resource or AWS Config rule is compliant and provides the number of contributors that affect the compliance.

" }, "ComplianceByConfigRule":{ "type":"structure", "members":{ "ConfigRuleName":{ "shape":"StringWithCharLimit64", "documentation":"

The name of the AWS Config rule.

" }, "Compliance":{ "shape":"Compliance", "documentation":"

Indicates whether the AWS Config rule is compliant.

" } }, "documentation":"

Indicates whether an AWS Config rule is compliant. A rule is compliant if all of the resources that the rule evaluated comply with it, and it is noncompliant if any of these resources do not comply.

" }, "ComplianceByConfigRules":{ "type":"list", "member":{"shape":"ComplianceByConfigRule"} }, "ComplianceByResource":{ "type":"structure", "members":{ "ResourceType":{ "shape":"StringWithCharLimit256", "documentation":"

The type of the AWS resource that was evaluated.

" }, "ResourceId":{ "shape":"StringWithCharLimit256", "documentation":"

The ID of the AWS resource that was evaluated.

" }, "Compliance":{ "shape":"Compliance", "documentation":"

Indicates whether the AWS resource complies with all of the AWS Config rules that evaluated it.

" } }, "documentation":"

Indicates whether an AWS resource that is evaluated according to one or more AWS Config rules is compliant. A resource is compliant if it complies with all of the rules that evaluate it, and it is noncompliant if it does not comply with one or more of these rules.

" }, "ComplianceByResources":{ "type":"list", "member":{"shape":"ComplianceByResource"} }, "ComplianceContributorCount":{ "type":"structure", "members":{ "CappedCount":{ "shape":"Integer", "documentation":"

The number of AWS resources or AWS Config rules responsible for the current compliance of the item.

" }, "CapExceeded":{ "shape":"Boolean", "documentation":"

Indicates whether the maximum count is reached.

" } }, "documentation":"

The number of AWS resources or AWS Config rules responsible for the current compliance of the item, up to a maximum number.

" }, "ComplianceResourceTypes":{ "type":"list", "member":{"shape":"StringWithCharLimit256"}, "max":100, "min":0 }, "ComplianceSummariesByResourceType":{ "type":"list", "member":{"shape":"ComplianceSummaryByResourceType"} }, "ComplianceSummary":{ "type":"structure", "members":{ "CompliantResourceCount":{ "shape":"ComplianceContributorCount", "documentation":"

The number of AWS Config rules or AWS resources that are compliant, up to a maximum of 25 for rules and 100 for resources.

" }, "NonCompliantResourceCount":{ "shape":"ComplianceContributorCount", "documentation":"

The number of AWS Config rules or AWS resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.

" }, "ComplianceSummaryTimestamp":{ "shape":"Date", "documentation":"

The time that AWS Config created the compliance summary.

" } }, "documentation":"

The number of AWS Config rules or AWS resources that are compliant and noncompliant.

" }, "ComplianceSummaryByResourceType":{ "type":"structure", "members":{ "ResourceType":{ "shape":"StringWithCharLimit256", "documentation":"

The type of AWS resource.

" }, "ComplianceSummary":{ "shape":"ComplianceSummary", "documentation":"

The number of AWS resources that are compliant or noncompliant, up to a maximum of 100 for each compliance.

" } }, "documentation":"

The number of AWS resources of a specific type that are compliant or noncompliant, up to a maximum of 100 for each compliance.

" }, "ComplianceType":{ "type":"string", "enum":[ "COMPLIANT", "NON_COMPLIANT", "NOT_APPLICABLE", "INSUFFICIENT_DATA" ] }, "ComplianceTypes":{ "type":"list", "member":{"shape":"ComplianceType"}, "max":3, "min":0 }, "ConfigExportDeliveryInfo":{ "type":"structure", "members":{ "lastStatus":{ "shape":"DeliveryStatus", "documentation":"

Status of the last attempted delivery.

" }, "lastErrorCode":{ "shape":"String", "documentation":"

The error code from the last attempted delivery.

" }, "lastErrorMessage":{ "shape":"String", "documentation":"

The error message from the last attempted delivery.

" }, "lastAttemptTime":{ "shape":"Date", "documentation":"

The time of the last attempted delivery.

" }, "lastSuccessfulTime":{ "shape":"Date", "documentation":"

The time of the last successful delivery.

" }, "nextDeliveryTime":{ "shape":"Date", "documentation":"

The time that the next delivery occurs.

" } }, "documentation":"

A list that contains the status of the delivery of either the snapshot or the configuration history to the specified Amazon S3 bucket.

" }, "ConfigRule":{ "type":"structure", "required":["Source"], "members":{ "ConfigRuleName":{ "shape":"StringWithCharLimit64", "documentation":"

The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.

" }, "ConfigRuleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the AWS Config rule.

" }, "ConfigRuleId":{ "shape":"String", "documentation":"

The ID of the AWS Config rule.

" }, "Description":{ "shape":"EmptiableStringWithCharLimit256", "documentation":"

The description that you provide for the AWS Config rule.

" }, "Scope":{ "shape":"Scope", "documentation":"

Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.

" }, "Source":{ "shape":"Source", "documentation":"

Provides the rule owner (AWS or customer), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.

" }, "InputParameters":{ "shape":"StringWithCharLimit1024", "documentation":"

A string in JSON format that is passed to the AWS Config rule Lambda function.

" }, "MaximumExecutionFrequency":{ "shape":"MaximumExecutionFrequency", "documentation":"

The maximum frequency with which AWS Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:

  • You are using an AWS managed rule that is triggered at a periodic frequency.

  • Your custom rule is triggered when AWS Config delivers the configuration snapshot.

For more information, see ConfigSnapshotDeliveryProperties.

" }, "ConfigRuleState":{ "shape":"ConfigRuleState", "documentation":"

Indicates whether the AWS Config rule is active or is currently being deleted by AWS Config. It can also indicate the evaluation status for the Config rule.

AWS Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.

AWS Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.

AWS Config sets the state of a rule to DELETING temporarily after you use the DeleteConfigRule request to delete the rule. After AWS Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.

" } }, "documentation":"

An AWS Config rule represents an AWS Lambda function that you create for a custom rule or a predefined function for an AWS managed rule. The function evaluates configuration items to assess whether your AWS resources comply with your desired configurations. This function can run when AWS Config detects a configuration change to an AWS resource and at a periodic frequency that you choose (for example, every 24 hours).

You can use the AWS CLI and AWS SDKs if you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.

" }, "ConfigRuleEvaluationStatus":{ "type":"structure", "members":{ "ConfigRuleName":{ "shape":"StringWithCharLimit64", "documentation":"

The name of the AWS Config rule.

" }, "ConfigRuleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the AWS Config rule.

" }, "ConfigRuleId":{ "shape":"String", "documentation":"

The ID of the AWS Config rule.

" }, "LastSuccessfulInvocationTime":{ "shape":"Date", "documentation":"

The time that AWS Config last successfully invoked the AWS Config rule to evaluate your AWS resources.

" }, "LastFailedInvocationTime":{ "shape":"Date", "documentation":"

The time that AWS Config last failed to invoke the AWS Config rule to evaluate your AWS resources.

" }, "LastSuccessfulEvaluationTime":{ "shape":"Date", "documentation":"

The time that AWS Config last successfully evaluated your AWS resources against the rule.

" }, "LastFailedEvaluationTime":{ "shape":"Date", "documentation":"

The time that AWS Config last failed to evaluate your AWS resources against the rule.

" }, "FirstActivatedTime":{ "shape":"Date", "documentation":"

The time that you first activated the AWS Config rule.

" }, "LastErrorCode":{ "shape":"String", "documentation":"

The error code that AWS Config returned when the rule last failed.

" }, "LastErrorMessage":{ "shape":"String", "documentation":"

The error message that AWS Config returned when the rule last failed.

" }, "FirstEvaluationStarted":{ "shape":"Boolean", "documentation":"

Indicates whether AWS Config has evaluated your resources against the rule at least once.

  • true - AWS Config has evaluated your AWS resources against the rule at least once.

  • false - AWS Config has not once finished evaluating your AWS resources against the rule.

" } }, "documentation":"

Status information for your AWS managed Config rules. The status includes information such as the last time the rule ran, the last time it failed, and the related error for the last failure.

This action does not return status information about custom Config rules.

" }, "ConfigRuleEvaluationStatusList":{ "type":"list", "member":{"shape":"ConfigRuleEvaluationStatus"} }, "ConfigRuleNames":{ "type":"list", "member":{"shape":"StringWithCharLimit64"}, "max":25, "min":0 }, "ConfigRuleState":{ "type":"string", "enum":[ "ACTIVE", "DELETING", "DELETING_RESULTS", "EVALUATING" ] }, "ConfigRules":{ "type":"list", "member":{"shape":"ConfigRule"} }, "ConfigSnapshotDeliveryProperties":{ "type":"structure", "members":{ "deliveryFrequency":{ "shape":"MaximumExecutionFrequency", "documentation":"

The frequency with which AWS Config delivers configuration snapshots.

" } }, "documentation":"

Provides options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel.

If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:

The frequency for a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot is set by one of two values, depending on which is less frequent:

  • The value for the deliveryFrequency parameter within the delivery channel configuration, which sets how often AWS Config delivers configuration snapshots. This value also sets how often AWS Config invokes evaluations for Config rules.

  • The value for the MaximumExecutionFrequency parameter, which sets the maximum frequency with which AWS Config invokes evaluations for the rule. For more information, see ConfigRule.

If the deliveryFrequency value is less frequent than the MaximumExecutionFrequency value for a rule, AWS Config invokes the rule only as often as the deliveryFrequency value.

  1. For example, you want your rule to run evaluations when AWS Config delivers the configuration snapshot.

  2. You specify the MaximumExecutionFrequency value for Six_Hours.

  3. You then specify the delivery channel deliveryFrequency value for TwentyFour_Hours.

  4. Because the value for deliveryFrequency is less frequent than MaximumExecutionFrequency, AWS Config invokes evaluations for the rule every 24 hours.

You should set the MaximumExecutionFrequency value to be at least as frequent as the deliveryFrequency value. You can view the deliveryFrequency value by using the DescribeDeliveryChannnels action.

To update the deliveryFrequency with which AWS Config delivers your configuration snapshots, use the PutDeliveryChannel action.

" }, "ConfigStreamDeliveryInfo":{ "type":"structure", "members":{ "lastStatus":{ "shape":"DeliveryStatus", "documentation":"

Status of the last attempted delivery.

Note Providing an SNS topic on a DeliveryChannel for AWS Config is optional. If the SNS delivery is turned off, the last status will be Not_Applicable.

" }, "lastErrorCode":{ "shape":"String", "documentation":"

The error code from the last attempted delivery.

" }, "lastErrorMessage":{ "shape":"String", "documentation":"

The error message from the last attempted delivery.

" }, "lastStatusChangeTime":{ "shape":"Date", "documentation":"

The time from the last status change.

" } }, "documentation":"

A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic.

" }, "Configuration":{"type":"string"}, "ConfigurationItem":{ "type":"structure", "members":{ "version":{ "shape":"Version", "documentation":"

The version number of the resource configuration.

" }, "accountId":{ "shape":"AccountId", "documentation":"

The 12 digit AWS account ID associated with the resource.

" }, "configurationItemCaptureTime":{ "shape":"ConfigurationItemCaptureTime", "documentation":"

The time when the configuration recording was initiated.

" }, "configurationItemStatus":{ "shape":"ConfigurationItemStatus", "documentation":"

The configuration item status.

" }, "configurationStateId":{ "shape":"ConfigurationStateId", "documentation":"

An identifier that indicates the ordering of the configuration items of a resource.

" }, "configurationItemMD5Hash":{ "shape":"ConfigurationItemMD5Hash", "documentation":"

Unique MD5 hash that represents the configuration item's state.

You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.

" }, "arn":{ "shape":"ARN", "documentation":"

The Amazon Resource Name (ARN) of the resource.

" }, "resourceType":{ "shape":"ResourceType", "documentation":"

The type of AWS resource.

" }, "resourceId":{ "shape":"ResourceId", "documentation":"

The ID of the resource (for example., sg-xxxxxx).

" }, "resourceName":{ "shape":"ResourceName", "documentation":"

The custom name of the resource, if available.

" }, "awsRegion":{ "shape":"AwsRegion", "documentation":"

The region where the resource resides.

" }, "availabilityZone":{ "shape":"AvailabilityZone", "documentation":"

The Availability Zone associated with the resource.

" }, "resourceCreationTime":{ "shape":"ResourceCreationTime", "documentation":"

The time stamp when the resource was created.

" }, "tags":{ "shape":"Tags", "documentation":"

A mapping of key value tags associated with the resource.

" }, "relatedEvents":{ "shape":"RelatedEventList", "documentation":"

A list of CloudTrail event IDs.

A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What is AWS CloudTrail?.

An empty field indicates that the current configuration was not initiated by any event.

" }, "relationships":{ "shape":"RelationshipList", "documentation":"

A list of related AWS resources.

" }, "configuration":{ "shape":"Configuration", "documentation":"

The description of the resource configuration.

" }, "supplementaryConfiguration":{ "shape":"SupplementaryConfiguration", "documentation":"

Configuration attributes that AWS Config returns for certain resource types to supplement the information returned for the configuration parameter.

" } }, "documentation":"

A list that contains detailed configurations of a specified resource.

" }, "ConfigurationItemCaptureTime":{"type":"timestamp"}, "ConfigurationItemList":{ "type":"list", "member":{"shape":"ConfigurationItem"} }, "ConfigurationItemMD5Hash":{"type":"string"}, "ConfigurationItemStatus":{ "type":"string", "enum":[ "Ok", "Failed", "Discovered", "Deleted" ] }, "ConfigurationRecorder":{ "type":"structure", "members":{ "name":{ "shape":"RecorderName", "documentation":"

The name of the recorder. By default, AWS Config automatically assigns the name \"default\" when creating the configuration recorder. You cannot change the assigned name.

" }, "roleARN":{ "shape":"String", "documentation":"

Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources associated with the account.

" }, "recordingGroup":{ "shape":"RecordingGroup", "documentation":"

Specifies the types of AWS resource for which AWS Config records configuration changes.

" } }, "documentation":"

An object that represents the recording of configuration changes of an AWS resource.

" }, "ConfigurationRecorderList":{ "type":"list", "member":{"shape":"ConfigurationRecorder"} }, "ConfigurationRecorderNameList":{ "type":"list", "member":{"shape":"RecorderName"} }, "ConfigurationRecorderStatus":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the configuration recorder.

" }, "lastStartTime":{ "shape":"Date", "documentation":"

The time the recorder was last started.

" }, "lastStopTime":{ "shape":"Date", "documentation":"

The time the recorder was last stopped.

" }, "recording":{ "shape":"Boolean", "documentation":"

Specifies whether the recorder is currently recording or not.

" }, "lastStatus":{ "shape":"RecorderStatus", "documentation":"

The last (previous) status of the recorder.

" }, "lastErrorCode":{ "shape":"String", "documentation":"

The error code indicating that the recording failed.

" }, "lastErrorMessage":{ "shape":"String", "documentation":"

The message indicating that the recording failed due to an error.

" }, "lastStatusChangeTime":{ "shape":"Date", "documentation":"

The time when the status was last changed.

" } }, "documentation":"

The current status of the configuration recorder.

" }, "ConfigurationRecorderStatusList":{ "type":"list", "member":{"shape":"ConfigurationRecorderStatus"} }, "ConfigurationStateId":{"type":"string"}, "Date":{"type":"timestamp"}, "DeleteConfigRuleRequest":{ "type":"structure", "required":["ConfigRuleName"], "members":{ "ConfigRuleName":{ "shape":"StringWithCharLimit64", "documentation":"

The name of the AWS Config rule that you want to delete.

" } }, "documentation":"

" }, "DeleteConfigurationRecorderRequest":{ "type":"structure", "required":["ConfigurationRecorderName"], "members":{ "ConfigurationRecorderName":{ "shape":"RecorderName", "documentation":"

The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by using the DescribeConfigurationRecorders action.

" } }, "documentation":"

The request object for the DeleteConfigurationRecorder action.

" }, "DeleteDeliveryChannelRequest":{ "type":"structure", "required":["DeliveryChannelName"], "members":{ "DeliveryChannelName":{ "shape":"ChannelName", "documentation":"

The name of the delivery channel to delete.

" } }, "documentation":"

The input for the DeleteDeliveryChannel action. The action accepts the following data in JSON format.

" }, "DeleteEvaluationResultsRequest":{ "type":"structure", "required":["ConfigRuleName"], "members":{ "ConfigRuleName":{ "shape":"StringWithCharLimit64", "documentation":"

The name of the Config rule for which you want to delete the evaluation results.

" } }, "documentation":"

" }, "DeleteEvaluationResultsResponse":{ "type":"structure", "members":{ }, "documentation":"

The output when you delete the evaluation results for the specified Config rule.

" }, "DeliverConfigSnapshotRequest":{ "type":"structure", "required":["deliveryChannelName"], "members":{ "deliveryChannelName":{ "shape":"ChannelName", "documentation":"

The name of the delivery channel through which the snapshot is delivered.

" } }, "documentation":"

The input for the DeliverConfigSnapshot action.

" }, "DeliverConfigSnapshotResponse":{ "type":"structure", "members":{ "configSnapshotId":{ "shape":"String", "documentation":"

The ID of the snapshot that is being created.

" } }, "documentation":"

The output for the DeliverConfigSnapshot action in JSON format.

" }, "DeliveryChannel":{ "type":"structure", "members":{ "name":{ "shape":"ChannelName", "documentation":"

The name of the delivery channel. By default, AWS Config assigns the name \"default\" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.

" }, "s3BucketName":{ "shape":"String", "documentation":"

The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files.

If you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config. For more information, see Permissions for the Amazon S3 Bucket in the AWS Config Developer Guide.

" }, "s3KeyPrefix":{ "shape":"String", "documentation":"

The prefix for the specified Amazon S3 bucket.

" }, "snsTopicARN":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes.

If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see Permissions for the Amazon SNS Topic in the AWS Config Developer Guide.

" }, "configSnapshotDeliveryProperties":{"shape":"ConfigSnapshotDeliveryProperties"} }, "documentation":"

The channel through which AWS Config delivers notifications and updated configuration states.

" }, "DeliveryChannelList":{ "type":"list", "member":{"shape":"DeliveryChannel"} }, "DeliveryChannelNameList":{ "type":"list", "member":{"shape":"ChannelName"} }, "DeliveryChannelStatus":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the delivery channel.

" }, "configSnapshotDeliveryInfo":{ "shape":"ConfigExportDeliveryInfo", "documentation":"

A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.

" }, "configHistoryDeliveryInfo":{ "shape":"ConfigExportDeliveryInfo", "documentation":"

A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.

" }, "configStreamDeliveryInfo":{ "shape":"ConfigStreamDeliveryInfo", "documentation":"

A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic.

" } }, "documentation":"

The status of a specified delivery channel.

Valid values: Success | Failure

" }, "DeliveryChannelStatusList":{ "type":"list", "member":{"shape":"DeliveryChannelStatus"} }, "DeliveryStatus":{ "type":"string", "enum":[ "Success", "Failure", "Not_Applicable" ] }, "DescribeComplianceByConfigRuleRequest":{ "type":"structure", "members":{ "ConfigRuleNames":{ "shape":"ConfigRuleNames", "documentation":"

Specify one or more AWS Config rule names to filter the results by rule.

" }, "ComplianceTypes":{ "shape":"ComplianceTypes", "documentation":"

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" } }, "documentation":"

" }, "DescribeComplianceByConfigRuleResponse":{ "type":"structure", "members":{ "ComplianceByConfigRules":{ "shape":"ComplianceByConfigRules", "documentation":"

Indicates whether each of the specified AWS Config rules is compliant.

" }, "NextToken":{ "shape":"String", "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" } }, "documentation":"

" }, "DescribeComplianceByResourceRequest":{ "type":"structure", "members":{ "ResourceType":{ "shape":"StringWithCharLimit256", "documentation":"

The types of AWS resources for which you want compliance information; for example, AWS::EC2::Instance. For this action, you can specify that the resource type is an AWS account by specifying AWS::::Account.

" }, "ResourceId":{ "shape":"StringWithCharLimit256", "documentation":"

The ID of the AWS resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for ResourceType.

" }, "ComplianceTypes":{ "shape":"ComplianceTypes", "documentation":"

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

" }, "Limit":{ "shape":"Limit", "documentation":"

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" } }, "documentation":"

" }, "DescribeComplianceByResourceResponse":{ "type":"structure", "members":{ "ComplianceByResources":{ "shape":"ComplianceByResources", "documentation":"

Indicates whether the specified AWS resource complies with all of the AWS Config rules that evaluate it.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" } }, "documentation":"

" }, "DescribeConfigRuleEvaluationStatusRequest":{ "type":"structure", "members":{ "ConfigRuleNames":{ "shape":"ConfigRuleNames", "documentation":"

The name of the AWS managed Config rules for which you want status information. If you do not specify any names, AWS Config returns status information for all AWS managed Config rules that you use.

" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" }, "Limit":{ "shape":"RuleLimit", "documentation":"

The number of rule evaluation results that you want returned.

This parameter is required if the rule limit for your account is more than the default of 50 rules.

For more information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide.

" } }, "documentation":"

" }, "DescribeConfigRuleEvaluationStatusResponse":{ "type":"structure", "members":{ "ConfigRulesEvaluationStatus":{ "shape":"ConfigRuleEvaluationStatusList", "documentation":"

Status information about your AWS managed Config rules.

" }, "NextToken":{ "shape":"String", "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" } }, "documentation":"

" }, "DescribeConfigRulesRequest":{ "type":"structure", "members":{ "ConfigRuleNames":{ "shape":"ConfigRuleNames", "documentation":"

The names of the AWS Config rules for which you want details. If you do not specify any names, AWS Config returns details for all your rules.

" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" } }, "documentation":"

" }, "DescribeConfigRulesResponse":{ "type":"structure", "members":{ "ConfigRules":{ "shape":"ConfigRules", "documentation":"

The details about your AWS Config rules.

" }, "NextToken":{ "shape":"String", "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" } }, "documentation":"

" }, "DescribeConfigurationRecorderStatusRequest":{ "type":"structure", "members":{ "ConfigurationRecorderNames":{ "shape":"ConfigurationRecorderNameList", "documentation":"

The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.

" } }, "documentation":"

The input for the DescribeConfigurationRecorderStatus action.

" }, "DescribeConfigurationRecorderStatusResponse":{ "type":"structure", "members":{ "ConfigurationRecordersStatus":{ "shape":"ConfigurationRecorderStatusList", "documentation":"

A list that contains status of the specified recorders.

" } }, "documentation":"

The output for the DescribeConfigurationRecorderStatus action in JSON format.

" }, "DescribeConfigurationRecordersRequest":{ "type":"structure", "members":{ "ConfigurationRecorderNames":{ "shape":"ConfigurationRecorderNameList", "documentation":"

A list of configuration recorder names.

" } }, "documentation":"

The input for the DescribeConfigurationRecorders action.

" }, "DescribeConfigurationRecordersResponse":{ "type":"structure", "members":{ "ConfigurationRecorders":{ "shape":"ConfigurationRecorderList", "documentation":"

A list that contains the descriptions of the specified configuration recorders.

" } }, "documentation":"

The output for the DescribeConfigurationRecorders action.

" }, "DescribeDeliveryChannelStatusRequest":{ "type":"structure", "members":{ "DeliveryChannelNames":{ "shape":"DeliveryChannelNameList", "documentation":"

A list of delivery channel names.

" } }, "documentation":"

The input for the DeliveryChannelStatus action.

" }, "DescribeDeliveryChannelStatusResponse":{ "type":"structure", "members":{ "DeliveryChannelsStatus":{ "shape":"DeliveryChannelStatusList", "documentation":"

A list that contains the status of a specified delivery channel.

" } }, "documentation":"

The output for the DescribeDeliveryChannelStatus action.

" }, "DescribeDeliveryChannelsRequest":{ "type":"structure", "members":{ "DeliveryChannelNames":{ "shape":"DeliveryChannelNameList", "documentation":"

A list of delivery channel names.

" } }, "documentation":"

The input for the DescribeDeliveryChannels action.

" }, "DescribeDeliveryChannelsResponse":{ "type":"structure", "members":{ "DeliveryChannels":{ "shape":"DeliveryChannelList", "documentation":"

A list that contains the descriptions of the specified delivery channel.

" } }, "documentation":"

The output for the DescribeDeliveryChannels action.

" }, "EarlierTime":{"type":"timestamp"}, "EmptiableStringWithCharLimit256":{ "type":"string", "max":256, "min":0 }, "Evaluation":{ "type":"structure", "required":[ "ComplianceResourceType", "ComplianceResourceId", "ComplianceType", "OrderingTimestamp" ], "members":{ "ComplianceResourceType":{ "shape":"StringWithCharLimit256", "documentation":"

The type of AWS resource that was evaluated.

" }, "ComplianceResourceId":{ "shape":"StringWithCharLimit256", "documentation":"

The ID of the AWS resource that was evaluated.

" }, "ComplianceType":{ "shape":"ComplianceType", "documentation":"

Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

" }, "Annotation":{ "shape":"StringWithCharLimit256", "documentation":"

Supplementary information about how the evaluation determined the compliance.

" }, "OrderingTimestamp":{ "shape":"OrderingTimestamp", "documentation":"

The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).

" } }, "documentation":"

Identifies an AWS resource and indicates whether it complies with the AWS Config rule that it was evaluated against.

" }, "EvaluationResult":{ "type":"structure", "members":{ "EvaluationResultIdentifier":{ "shape":"EvaluationResultIdentifier", "documentation":"

Uniquely identifies the evaluation result.

" }, "ComplianceType":{ "shape":"ComplianceType", "documentation":"

Indicates whether the AWS resource complies with the AWS Config rule that evaluated it.

For the EvaluationResult data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.

" }, "ResultRecordedTime":{ "shape":"Date", "documentation":"

The time when AWS Config recorded the evaluation result.

" }, "ConfigRuleInvokedTime":{ "shape":"Date", "documentation":"

The time when the AWS Config rule evaluated the AWS resource.

" }, "Annotation":{ "shape":"StringWithCharLimit256", "documentation":"

Supplementary information about how the evaluation determined the compliance.

" }, "ResultToken":{ "shape":"String", "documentation":"

An encrypted token that associates an evaluation with an AWS Config rule. The token identifies the rule, the AWS resource being evaluated, and the event that triggered the evaluation.

" } }, "documentation":"

The details of an AWS Config evaluation. Provides the AWS resource that was evaluated, the compliance of the resource, related timestamps, and supplementary information.

" }, "EvaluationResultIdentifier":{ "type":"structure", "members":{ "EvaluationResultQualifier":{ "shape":"EvaluationResultQualifier", "documentation":"

Identifies an AWS Config rule used to evaluate an AWS resource, and provides the type and ID of the evaluated resource.

" }, "OrderingTimestamp":{ "shape":"Date", "documentation":"

The time of the event that triggered the evaluation of your AWS resources. The time can indicate when AWS Config delivered a configuration item change notification, or it can indicate when AWS Config delivered the configuration snapshot, depending on which event triggered the evaluation.

" } }, "documentation":"

Uniquely identifies an evaluation result.

" }, "EvaluationResultQualifier":{ "type":"structure", "members":{ "ConfigRuleName":{ "shape":"StringWithCharLimit64", "documentation":"

The name of the AWS Config rule that was used in the evaluation.

" }, "ResourceType":{ "shape":"StringWithCharLimit256", "documentation":"

The type of AWS resource that was evaluated.

" }, "ResourceId":{ "shape":"StringWithCharLimit256", "documentation":"

The ID of the evaluated AWS resource.

" } }, "documentation":"

Identifies an AWS Config rule that evaluated an AWS resource, and provides the type and ID of the resource that the rule evaluated.

" }, "EvaluationResults":{ "type":"list", "member":{"shape":"EvaluationResult"} }, "Evaluations":{ "type":"list", "member":{"shape":"Evaluation"}, "max":100, "min":0 }, "EventSource":{ "type":"string", "enum":["aws.config"] }, "GetComplianceDetailsByConfigRuleRequest":{ "type":"structure", "required":["ConfigRuleName"], "members":{ "ConfigRuleName":{ "shape":"StringWithCharLimit64", "documentation":"

The name of the AWS Config rule for which you want compliance information.

" }, "ComplianceTypes":{ "shape":"ComplianceTypes", "documentation":"

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

" }, "Limit":{ "shape":"Limit", "documentation":"

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" } }, "documentation":"

" }, "GetComplianceDetailsByConfigRuleResponse":{ "type":"structure", "members":{ "EvaluationResults":{ "shape":"EvaluationResults", "documentation":"

Indicates whether the AWS resource complies with the specified AWS Config rule.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" } }, "documentation":"

" }, "GetComplianceDetailsByResourceRequest":{ "type":"structure", "required":[ "ResourceType", "ResourceId" ], "members":{ "ResourceType":{ "shape":"StringWithCharLimit256", "documentation":"

The type of the AWS resource for which you want compliance information.

" }, "ResourceId":{ "shape":"StringWithCharLimit256", "documentation":"

The ID of the AWS resource for which you want compliance information.

" }, "ComplianceTypes":{ "shape":"ComplianceTypes", "documentation":"

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

" }, "NextToken":{ "shape":"String", "documentation":"

The NextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" } }, "documentation":"

" }, "GetComplianceDetailsByResourceResponse":{ "type":"structure", "members":{ "EvaluationResults":{ "shape":"EvaluationResults", "documentation":"

Indicates whether the specified AWS resource complies each AWS Config rule.

" }, "NextToken":{ "shape":"String", "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" } }, "documentation":"

" }, "GetComplianceSummaryByConfigRuleResponse":{ "type":"structure", "members":{ "ComplianceSummary":{ "shape":"ComplianceSummary", "documentation":"

The number of AWS Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each.

" } }, "documentation":"

" }, "GetComplianceSummaryByResourceTypeRequest":{ "type":"structure", "members":{ "ResourceTypes":{ "shape":"ResourceTypes", "documentation":"

Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.

For this request, you can specify an AWS resource type such as AWS::EC2::Instance, and you can specify that the resource type is an AWS account by specifying AWS::::Account.

" } }, "documentation":"

" }, "GetComplianceSummaryByResourceTypeResponse":{ "type":"structure", "members":{ "ComplianceSummariesByResourceType":{ "shape":"ComplianceSummariesByResourceType", "documentation":"

The number of resources that are compliant and the number that are noncompliant. If one or more resource types were provided with the request, the numbers are returned for each resource type. The maximum number returned is 100.

" } }, "documentation":"

" }, "GetResourceConfigHistoryRequest":{ "type":"structure", "required":[ "resourceType", "resourceId" ], "members":{ "resourceType":{ "shape":"ResourceType", "documentation":"

The resource type.

" }, "resourceId":{ "shape":"ResourceId", "documentation":"

The ID of the resource (for example., sg-xxxxxx).

" }, "laterTime":{ "shape":"LaterTime", "documentation":"

The time stamp that indicates a later time. If not specified, current time is taken.

" }, "earlierTime":{ "shape":"EarlierTime", "documentation":"

The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start from when the first configuration item was recorded.

" }, "chronologicalOrder":{ "shape":"ChronologicalOrder", "documentation":"

The chronological order for configuration items listed. By default the results are listed in reverse chronological order.

" }, "limit":{ "shape":"Limit", "documentation":"

The maximum number of configuration items returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" } }, "documentation":"

The input for the GetResourceConfigHistory action.

" }, "GetResourceConfigHistoryResponse":{ "type":"structure", "members":{ "configurationItems":{ "shape":"ConfigurationItemList", "documentation":"

A list that contains the configuration history of one or more resources.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" } }, "documentation":"

The output for the GetResourceConfigHistory action.

" }, "IncludeGlobalResourceTypes":{"type":"boolean"}, "InsufficientDeliveryPolicyException":{ "type":"structure", "members":{ }, "documentation":"

Your Amazon S3 bucket policy does not permit AWS Config to write to it.

", "exception":true }, "InsufficientPermissionsException":{ "type":"structure", "members":{ }, "documentation":"

Indicates one of the following errors:

  • The rule cannot be created because the IAM role assigned to AWS Config lacks permissions to perform the config:Put* action.

  • The AWS Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.

", "exception":true }, "Integer":{"type":"integer"}, "InvalidConfigurationRecorderNameException":{ "type":"structure", "members":{ }, "documentation":"

You have provided a configuration recorder name that is not valid.

", "exception":true }, "InvalidDeliveryChannelNameException":{ "type":"structure", "members":{ }, "documentation":"

The specified delivery channel name is not valid.

", "exception":true }, "InvalidLimitException":{ "type":"structure", "members":{ }, "documentation":"

The specified limit is outside the allowable range.

", "exception":true }, "InvalidNextTokenException":{ "type":"structure", "members":{ }, "documentation":"

The specified next token is invalid. Specify the NextToken string that was returned in the previous response to get the next page of results.

", "exception":true }, "InvalidParameterValueException":{ "type":"structure", "members":{ }, "documentation":"

One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

", "exception":true }, "InvalidRecordingGroupException":{ "type":"structure", "members":{ }, "documentation":"

AWS Config throws an exception if the recording group does not contain a valid list of resource types. Invalid values could also be incorrectly formatted.

", "exception":true }, "InvalidResultTokenException":{ "type":"structure", "members":{ }, "documentation":"

The speNexcified token is invalid.

", "exception":true }, "InvalidRoleException":{ "type":"structure", "members":{ }, "documentation":"

You have provided a null or empty role ARN.

", "exception":true }, "InvalidS3KeyPrefixException":{ "type":"structure", "members":{ }, "documentation":"

The specified Amazon S3 key prefix is not valid.

", "exception":true }, "InvalidSNSTopicARNException":{ "type":"structure", "members":{ }, "documentation":"

The specified Amazon SNS topic does not exist.

", "exception":true }, "InvalidTimeRangeException":{ "type":"structure", "members":{ }, "documentation":"

The specified time range is not valid. The earlier time is not chronologically before the later time.

", "exception":true }, "LastDeliveryChannelDeleteFailedException":{ "type":"structure", "members":{ }, "documentation":"

You cannot delete the delivery channel you specified because the configuration recorder is running.

", "exception":true }, "LaterTime":{"type":"timestamp"}, "Limit":{ "type":"integer", "max":100, "min":0 }, "LimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown if an evaluation is in progress or if you call the StartConfigRulesEvaluation API more than once per minute.

", "exception":true }, "ListDiscoveredResourcesRequest":{ "type":"structure", "required":["resourceType"], "members":{ "resourceType":{ "shape":"ResourceType", "documentation":"

The type of resources that you want AWS Config to list in the response.

" }, "resourceIds":{ "shape":"ResourceIdList", "documentation":"

The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

" }, "resourceName":{ "shape":"ResourceName", "documentation":"

The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

" }, "limit":{ "shape":"Limit", "documentation":"

The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.

" }, "includeDeletedResources":{ "shape":"Boolean", "documentation":"

Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" } }, "documentation":"

" }, "ListDiscoveredResourcesResponse":{ "type":"structure", "members":{ "resourceIdentifiers":{ "shape":"ResourceIdentifierList", "documentation":"

The details that identify a resource that is discovered by AWS Config, including the resource type, ID, and (if available) the custom resource name.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" } }, "documentation":"

" }, "MaxNumberOfConfigRulesExceededException":{ "type":"structure", "members":{ }, "documentation":"

Failed to add the AWS Config rule because the account already contains the maximum number of 50 rules. Consider deleting any deactivated rules before adding new rules.

", "exception":true }, "MaxNumberOfConfigurationRecordersExceededException":{ "type":"structure", "members":{ }, "documentation":"

You have reached the limit on the number of recorders you can create.

", "exception":true }, "MaxNumberOfDeliveryChannelsExceededException":{ "type":"structure", "members":{ }, "documentation":"

You have reached the limit on the number of delivery channels you can create.

", "exception":true }, "MaximumExecutionFrequency":{ "type":"string", "enum":[ "One_Hour", "Three_Hours", "Six_Hours", "Twelve_Hours", "TwentyFour_Hours" ] }, "MessageType":{ "type":"string", "enum":[ "ConfigurationItemChangeNotification", "ConfigurationSnapshotDeliveryCompleted", "ScheduledNotification", "OversizedConfigurationItemChangeNotification" ] }, "Name":{"type":"string"}, "NextToken":{"type":"string"}, "NoAvailableConfigurationRecorderException":{ "type":"structure", "members":{ }, "documentation":"

There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.

", "exception":true }, "NoAvailableDeliveryChannelException":{ "type":"structure", "members":{ }, "documentation":"

There is no delivery channel available to record configurations.

", "exception":true }, "NoRunningConfigurationRecorderException":{ "type":"structure", "members":{ }, "documentation":"

There is no configuration recorder running.

", "exception":true }, "NoSuchBucketException":{ "type":"structure", "members":{ }, "documentation":"

The specified Amazon S3 bucket does not exist.

", "exception":true }, "NoSuchConfigRuleException":{ "type":"structure", "members":{ }, "documentation":"

One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again.

", "exception":true }, "NoSuchConfigurationRecorderException":{ "type":"structure", "members":{ }, "documentation":"

You have specified a configuration recorder that does not exist.

", "exception":true }, "NoSuchDeliveryChannelException":{ "type":"structure", "members":{ }, "documentation":"

You have specified a delivery channel that does not exist.

", "exception":true }, "OrderingTimestamp":{"type":"timestamp"}, "Owner":{ "type":"string", "enum":[ "CUSTOM_LAMBDA", "AWS" ] }, "PutConfigRuleRequest":{ "type":"structure", "required":["ConfigRule"], "members":{ "ConfigRule":{"shape":"ConfigRule"} }, "documentation":"

" }, "PutConfigurationRecorderRequest":{ "type":"structure", "required":["ConfigurationRecorder"], "members":{ "ConfigurationRecorder":{ "shape":"ConfigurationRecorder", "documentation":"

The configuration recorder object that records each configuration change made to the resources.

" } }, "documentation":"

The input for the PutConfigurationRecorder action.

" }, "PutDeliveryChannelRequest":{ "type":"structure", "required":["DeliveryChannel"], "members":{ "DeliveryChannel":{ "shape":"DeliveryChannel", "documentation":"

The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic.

" } }, "documentation":"

The input for the PutDeliveryChannel action.

" }, "PutEvaluationsRequest":{ "type":"structure", "required":["ResultToken"], "members":{ "Evaluations":{ "shape":"Evaluations", "documentation":"

The assessments that the AWS Lambda function performs. Each evaluation identifies an AWS resource and indicates whether it complies with the AWS Config rule that invokes the AWS Lambda function.

" }, "ResultToken":{ "shape":"String", "documentation":"

An encrypted token that associates an evaluation with an AWS Config rule. Identifies the rule and the event that triggered the evaluation

" } }, "documentation":"

" }, "PutEvaluationsResponse":{ "type":"structure", "members":{ "FailedEvaluations":{ "shape":"Evaluations", "documentation":"

Requests that failed because of a client or server error.

" } }, "documentation":"

" }, "RecorderName":{ "type":"string", "max":256, "min":1 }, "RecorderStatus":{ "type":"string", "enum":[ "Pending", "Success", "Failure" ] }, "RecordingGroup":{ "type":"structure", "members":{ "allSupported":{ "shape":"AllSupported", "documentation":"

Specifies whether AWS Config records configuration changes for every supported type of regional resource.

If you set this option to true, when AWS Config adds support for a new type of regional resource, it automatically starts recording resources of that type.

If you set this option to true, you cannot enumerate a list of resourceTypes.

" }, "includeGlobalResourceTypes":{ "shape":"IncludeGlobalResourceTypes", "documentation":"

Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.

Before you can set this option to true, you must set the allSupported option to true.

If you set this option to true, when AWS Config adds support for a new type of global resource, it automatically starts recording resources of that type.

The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.

" }, "resourceTypes":{ "shape":"ResourceTypeList", "documentation":"

A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

Before you can set this option to true, you must set the allSupported option to false.

If you set this option to true, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

For a list of valid resourceTypes values, see the resourceType Value column in Supported AWS Resource Types.

" } }, "documentation":"

Specifies the types of AWS resource for which AWS Config records configuration changes.

In the recording group, you specify whether all supported types or specific types of resources are recorded.

By default, AWS Config records configuration changes for all supported types of regional resources that AWS Config discovers in the region in which it is running. Regional resources are tied to a region and can be used only in that region. Examples of regional resources are EC2 instances and EBS volumes.

You can also have AWS Config record configuration changes for supported types of global resources (for example, IAM resources). Global resources are not tied to an individual region and can be used in all regions.

The configuration details for any global resource are the same in all regions. If you customize AWS Config in multiple regions to record global resources, it will create multiple configuration items each time a global resource changes: one configuration item for each region. These configuration items will contain identical data. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources, unless you want the configuration items to be available in multiple regions.

If you don't want AWS Config to record all resources, you can specify which types of resources it will record with the resourceTypes parameter.

For a list of supported resource types, see Supported resource types.

For more information, see Selecting Which Resources AWS Config Records.

" }, "ReevaluateConfigRuleNames":{ "type":"list", "member":{"shape":"StringWithCharLimit64"}, "max":25, "min":1 }, "RelatedEvent":{"type":"string"}, "RelatedEventList":{ "type":"list", "member":{"shape":"RelatedEvent"} }, "Relationship":{ "type":"structure", "members":{ "resourceType":{ "shape":"ResourceType", "documentation":"

The resource type of the related resource.

" }, "resourceId":{ "shape":"ResourceId", "documentation":"

The ID of the related resource (for example, sg-xxxxxx).

" }, "resourceName":{ "shape":"ResourceName", "documentation":"

The custom name of the related resource, if available.

" }, "relationshipName":{ "shape":"RelationshipName", "documentation":"

The type of relationship with the related resource.

" } }, "documentation":"

The relationship of the related resource to the main resource.

" }, "RelationshipList":{ "type":"list", "member":{"shape":"Relationship"} }, "RelationshipName":{"type":"string"}, "ResourceCreationTime":{"type":"timestamp"}, "ResourceDeletionTime":{"type":"timestamp"}, "ResourceId":{"type":"string"}, "ResourceIdList":{ "type":"list", "member":{"shape":"ResourceId"} }, "ResourceIdentifier":{ "type":"structure", "members":{ "resourceType":{ "shape":"ResourceType", "documentation":"

The type of resource.

" }, "resourceId":{ "shape":"ResourceId", "documentation":"

The ID of the resource (for example., sg-xxxxxx).

" }, "resourceName":{ "shape":"ResourceName", "documentation":"

The custom name of the resource (if available).

" }, "resourceDeletionTime":{ "shape":"ResourceDeletionTime", "documentation":"

The time that the resource was deleted.

" } }, "documentation":"

The details that identify a resource that is discovered by AWS Config, including the resource type, ID, and (if available) the custom resource name.

" }, "ResourceIdentifierList":{ "type":"list", "member":{"shape":"ResourceIdentifier"} }, "ResourceInUseException":{ "type":"structure", "members":{ }, "documentation":"

The rule is currently being deleted or the rule is deleting your evaluation results. Try your request again later.

", "exception":true }, "ResourceName":{"type":"string"}, "ResourceNotDiscoveredException":{ "type":"structure", "members":{ }, "documentation":"

You have specified a resource that is either unknown or has not been discovered.

", "exception":true }, "ResourceType":{ "type":"string", "enum":[ "AWS::EC2::CustomerGateway", "AWS::EC2::EIP", "AWS::EC2::Host", "AWS::EC2::Instance", "AWS::EC2::InternetGateway", "AWS::EC2::NetworkAcl", "AWS::EC2::NetworkInterface", "AWS::EC2::RouteTable", "AWS::EC2::SecurityGroup", "AWS::EC2::Subnet", "AWS::CloudTrail::Trail", "AWS::EC2::Volume", "AWS::EC2::VPC", "AWS::EC2::VPNConnection", "AWS::EC2::VPNGateway", "AWS::IAM::Group", "AWS::IAM::Policy", "AWS::IAM::Role", "AWS::IAM::User", "AWS::ACM::Certificate", "AWS::RDS::DBInstance", "AWS::RDS::DBSubnetGroup", "AWS::RDS::DBSecurityGroup", "AWS::RDS::DBSnapshot", "AWS::RDS::EventSubscription", "AWS::ElasticLoadBalancingV2::LoadBalancer", "AWS::S3::Bucket", "AWS::SSM::ManagedInstanceInventory", "AWS::Redshift::Cluster", "AWS::Redshift::ClusterSnapshot", "AWS::Redshift::ClusterParameterGroup", "AWS::Redshift::ClusterSecurityGroup", "AWS::Redshift::ClusterSubnetGroup", "AWS::Redshift::EventSubscription" ] }, "ResourceTypeList":{ "type":"list", "member":{"shape":"ResourceType"} }, "ResourceTypes":{ "type":"list", "member":{"shape":"StringWithCharLimit256"}, "max":20, "min":0 }, "RuleLimit":{ "type":"integer", "max":50, "min":0 }, "Scope":{ "type":"structure", "members":{ "ComplianceResourceTypes":{ "shape":"ComplianceResourceTypes", "documentation":"

The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId.

" }, "TagKey":{ "shape":"StringWithCharLimit128", "documentation":"

The tag key that is applied to only those AWS resources that you want you want to trigger an evaluation for the rule.

" }, "TagValue":{ "shape":"StringWithCharLimit256", "documentation":"

The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

" }, "ComplianceResourceId":{ "shape":"StringWithCharLimit256", "documentation":"

The IDs of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

" } }, "documentation":"

Defines which resources trigger an evaluation for an AWS Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

" }, "Source":{ "type":"structure", "required":[ "Owner", "SourceIdentifier" ], "members":{ "Owner":{ "shape":"Owner", "documentation":"

Indicates whether AWS or the customer owns and manages the AWS Config rule.

" }, "SourceIdentifier":{ "shape":"StringWithCharLimit256", "documentation":"

For AWS Config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using AWS Managed Config Rules.

For custom rules, the identifier is the Amazon Resource Name (ARN) of the rule's AWS Lambda function, such as arn:aws:lambda:us-east-1:123456789012:function:custom_rule_name.

" }, "SourceDetails":{ "shape":"SourceDetails", "documentation":"

Provides the source and type of the event that causes AWS Config to evaluate your AWS resources.

" } }, "documentation":"

Provides the AWS Config rule owner (AWS or customer), the rule identifier, and the events that trigger the evaluation of your AWS resources.

" }, "SourceDetail":{ "type":"structure", "members":{ "EventSource":{ "shape":"EventSource", "documentation":"

The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.

" }, "MessageType":{ "shape":"MessageType", "documentation":"

The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following notification types:

  • ConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change.

  • OversizedConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

  • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

  • ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when AWS Config delivers a configuration snapshot.

If you want your custom rule to be triggered by configuration changes, specify both ConfigurationItemChangeNotification and OversizedConfigurationItemChangeNotification.

" }, "MaximumExecutionFrequency":{ "shape":"MaximumExecutionFrequency", "documentation":"

The frequency that you want AWS Config to run evaluations for a rule that is triggered periodically. If you specify a value for MaximumExecutionFrequency, then MessageType must use the ScheduledNotification value.

" } }, "documentation":"

Provides the source and the message types that trigger AWS Config to evaluate your AWS resources against a rule. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for SourceDetail only for custom rules.

" }, "SourceDetails":{ "type":"list", "member":{"shape":"SourceDetail"}, "max":25, "min":0 }, "StartConfigRulesEvaluationRequest":{ "type":"structure", "members":{ "ConfigRuleNames":{ "shape":"ReevaluateConfigRuleNames", "documentation":"

The list of names of Config rules that you want to run evaluations for.

" } }, "documentation":"

" }, "StartConfigRulesEvaluationResponse":{ "type":"structure", "members":{ }, "documentation":"

The output when you start the evaluation for the specified Config rule.

" }, "StartConfigurationRecorderRequest":{ "type":"structure", "required":["ConfigurationRecorderName"], "members":{ "ConfigurationRecorderName":{ "shape":"RecorderName", "documentation":"

The name of the recorder object that records each configuration change made to the resources.

" } }, "documentation":"

The input for the StartConfigurationRecorder action.

" }, "StopConfigurationRecorderRequest":{ "type":"structure", "required":["ConfigurationRecorderName"], "members":{ "ConfigurationRecorderName":{ "shape":"RecorderName", "documentation":"

The name of the recorder object that records each configuration change made to the resources.

" } }, "documentation":"

The input for the StopConfigurationRecorder action.

" }, "String":{"type":"string"}, "StringWithCharLimit1024":{ "type":"string", "max":1024, "min":1 }, "StringWithCharLimit128":{ "type":"string", "max":128, "min":1 }, "StringWithCharLimit256":{ "type":"string", "max":256, "min":1 }, "StringWithCharLimit64":{ "type":"string", "max":64, "min":1 }, "SupplementaryConfiguration":{ "type":"map", "key":{"shape":"SupplementaryConfigurationName"}, "value":{"shape":"SupplementaryConfigurationValue"} }, "SupplementaryConfigurationName":{"type":"string"}, "SupplementaryConfigurationValue":{"type":"string"}, "Tags":{ "type":"map", "key":{"shape":"Name"}, "value":{"shape":"Value"} }, "ValidationException":{ "type":"structure", "members":{ }, "documentation":"

The requested action is not valid.

", "exception":true }, "Value":{"type":"string"}, "Version":{"type":"string"} }, "documentation":"AWS Config

AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an Elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by AWS Config, see Supported AWS Resources.

You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config

This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config.

The AWS Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process.

For detailed information about AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see What Is AWS Config? in the AWS Config Developer Guide.

" } botocore-1.5.7/botocore/data/pinpoint/0000777454262600001440000000000013042511307020773 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/pinpoint/2016-12-01/0000777454262600001440000000000013042511307022021 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/pinpoint/2016-12-01/service-2.json0000666454262600001440000031040113042511306024511 0ustar pysdk-ciamazon00000000000000{ "metadata" : { "apiVersion" : "2016-12-01", "endpointPrefix" : "pinpoint", "signingName" : "mobiletargeting", "signatureVersion":"v4", "serviceFullName" : "Amazon Pinpoint", "protocol" : "rest-json", "jsonVersion" : "1.1" }, "operations" : { "CreateCampaign" : { "name" : "CreateCampaign", "http" : { "method" : "POST", "requestUri" : "/v1/apps/{application-id}/campaigns", "responseCode" : 201 }, "input" : { "shape" : "CreateCampaignRequest" }, "output" : { "shape" : "CreateCampaignResponse", "documentation" : "201 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Creates or updates a campaign." }, "CreateImportJob" : { "name" : "CreateImportJob", "http" : { "method" : "POST", "requestUri" : "/v1/apps/{application-id}/jobs/import", "responseCode" : 201 }, "input" : { "shape" : "CreateImportJobRequest" }, "output" : { "shape" : "CreateImportJobResponse", "documentation" : "201 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Creates or updates an import job." }, "CreateSegment" : { "name" : "CreateSegment", "http" : { "method" : "POST", "requestUri" : "/v1/apps/{application-id}/segments", "responseCode" : 201 }, "input" : { "shape" : "CreateSegmentRequest" }, "output" : { "shape" : "CreateSegmentResponse", "documentation" : "201 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Used to create or update a segment." }, "DeleteApnsChannel" : { "name" : "DeleteApnsChannel", "http" : { "method" : "DELETE", "requestUri" : "/v1/apps/{application-id}/channels/apns", "responseCode" : 200 }, "input" : { "shape" : "DeleteApnsChannelRequest" }, "output" : { "shape" : "DeleteApnsChannelResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Deletes the APNs channel for an app." }, "DeleteCampaign" : { "name" : "DeleteCampaign", "http" : { "method" : "DELETE", "requestUri" : "/v1/apps/{application-id}/campaigns/{campaign-id}", "responseCode" : 200 }, "input" : { "shape" : "DeleteCampaignRequest" }, "output" : { "shape" : "DeleteCampaignResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Deletes a campaign." }, "DeleteGcmChannel" : { "name" : "DeleteGcmChannel", "http" : { "method" : "DELETE", "requestUri" : "/v1/apps/{application-id}/channels/gcm", "responseCode" : 200 }, "input" : { "shape" : "DeleteGcmChannelRequest" }, "output" : { "shape" : "DeleteGcmChannelResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Deletes the GCM channel for an app." }, "DeleteSegment" : { "name" : "DeleteSegment", "http" : { "method" : "DELETE", "requestUri" : "/v1/apps/{application-id}/segments/{segment-id}", "responseCode" : 200 }, "input" : { "shape" : "DeleteSegmentRequest" }, "output" : { "shape" : "DeleteSegmentResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Deletes a segment." }, "GetApnsChannel" : { "name" : "GetApnsChannel", "http" : { "method" : "GET", "requestUri" : "/v1/apps/{application-id}/channels/apns", "responseCode" : 200 }, "input" : { "shape" : "GetApnsChannelRequest" }, "output" : { "shape" : "GetApnsChannelResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Returns information about the APNs channel for an app." }, "GetApplicationSettings" : { "name" : "GetApplicationSettings", "http" : { "method" : "GET", "requestUri" : "/v1/apps/{application-id}/settings", "responseCode" : 200 }, "input" : { "shape" : "GetApplicationSettingsRequest" }, "output" : { "shape" : "GetApplicationSettingsResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Used to request the settings for an app." }, "GetCampaign" : { "name" : "GetCampaign", "http" : { "method" : "GET", "requestUri" : "/v1/apps/{application-id}/campaigns/{campaign-id}", "responseCode" : 200 }, "input" : { "shape" : "GetCampaignRequest" }, "output" : { "shape" : "GetCampaignResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Returns information about a campaign." }, "GetCampaignActivities" : { "name" : "GetCampaignActivities", "http" : { "method" : "GET", "requestUri" : "/v1/apps/{application-id}/campaigns/{campaign-id}/activities", "responseCode" : 200 }, "input" : { "shape" : "GetCampaignActivitiesRequest" }, "output" : { "shape" : "GetCampaignActivitiesResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Returns information about the activity performed by a campaign." }, "GetCampaignVersion" : { "name" : "GetCampaignVersion", "http" : { "method" : "GET", "requestUri" : "/v1/apps/{application-id}/campaigns/{campaign-id}/versions/{version}", "responseCode" : 200 }, "input" : { "shape" : "GetCampaignVersionRequest" }, "output" : { "shape" : "GetCampaignVersionResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Returns information about your campaign versions." }, "GetCampaignVersions" : { "name" : "GetCampaignVersions", "http" : { "method" : "GET", "requestUri" : "/v1/apps/{application-id}/campaigns/{campaign-id}/versions", "responseCode" : 200 }, "input" : { "shape" : "GetCampaignVersionsRequest" }, "output" : { "shape" : "GetCampaignVersionsResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Returns information about your campaign versions." }, "GetCampaigns" : { "name" : "GetCampaigns", "http" : { "method" : "GET", "requestUri" : "/v1/apps/{application-id}/campaigns", "responseCode" : 200 }, "input" : { "shape" : "GetCampaignsRequest" }, "output" : { "shape" : "GetCampaignsResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Returns information about your campaigns." }, "GetEndpoint" : { "name" : "GetEndpoint", "http" : { "method" : "GET", "requestUri" : "/v1/apps/{application-id}/endpoints/{endpoint-id}", "responseCode" : 200 }, "input" : { "shape" : "GetEndpointRequest" }, "output" : { "shape" : "GetEndpointResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Returns information about an endpoint." }, "GetGcmChannel" : { "name" : "GetGcmChannel", "http" : { "method" : "GET", "requestUri" : "/v1/apps/{application-id}/channels/gcm", "responseCode" : 200 }, "input" : { "shape" : "GetGcmChannelRequest" }, "output" : { "shape" : "GetGcmChannelResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Returns information about the GCM channel for an app." }, "GetImportJob" : { "name" : "GetImportJob", "http" : { "method" : "GET", "requestUri" : "/v1/apps/{application-id}/jobs/import/{job-id}", "responseCode" : 200 }, "input" : { "shape" : "GetImportJobRequest" }, "output" : { "shape" : "GetImportJobResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Returns information about an import job." }, "GetImportJobs" : { "name" : "GetImportJobs", "http" : { "method" : "GET", "requestUri" : "/v1/apps/{application-id}/jobs/import", "responseCode" : 200 }, "input" : { "shape" : "GetImportJobsRequest" }, "output" : { "shape" : "GetImportJobsResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Returns information about your import jobs." }, "GetSegment" : { "name" : "GetSegment", "http" : { "method" : "GET", "requestUri" : "/v1/apps/{application-id}/segments/{segment-id}", "responseCode" : 200 }, "input" : { "shape" : "GetSegmentRequest" }, "output" : { "shape" : "GetSegmentResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Returns information about a segment." }, "GetSegmentImportJobs" : { "name" : "GetSegmentImportJobs", "http" : { "method" : "GET", "requestUri" : "/v1/apps/{application-id}/segments/{segment-id}/jobs/import", "responseCode" : 200 }, "input" : { "shape" : "GetSegmentImportJobsRequest" }, "output" : { "shape" : "GetSegmentImportJobsResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Returns a list of import jobs for a specific segment." }, "GetSegmentVersion" : { "name" : "GetSegmentVersion", "http" : { "method" : "GET", "requestUri" : "/v1/apps/{application-id}/segments/{segment-id}/versions/{version}", "responseCode" : 200 }, "input" : { "shape" : "GetSegmentVersionRequest" }, "output" : { "shape" : "GetSegmentVersionResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Returns information about a segment version." }, "GetSegmentVersions" : { "name" : "GetSegmentVersions", "http" : { "method" : "GET", "requestUri" : "/v1/apps/{application-id}/segments/{segment-id}/versions", "responseCode" : 200 }, "input" : { "shape" : "GetSegmentVersionsRequest" }, "output" : { "shape" : "GetSegmentVersionsResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Returns information about your segment versions." }, "GetSegments" : { "name" : "GetSegments", "http" : { "method" : "GET", "requestUri" : "/v1/apps/{application-id}/segments", "responseCode" : 200 }, "input" : { "shape" : "GetSegmentsRequest" }, "output" : { "shape" : "GetSegmentsResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Used to get information about your segments." }, "UpdateApnsChannel" : { "name" : "UpdateApnsChannel", "http" : { "method" : "PUT", "requestUri" : "/v1/apps/{application-id}/channels/apns", "responseCode" : 200 }, "input" : { "shape" : "UpdateApnsChannelRequest" }, "output" : { "shape" : "UpdateApnsChannelResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Use to update the APNs channel for an app." }, "UpdateApplicationSettings" : { "name" : "UpdateApplicationSettings", "http" : { "method" : "PUT", "requestUri" : "/v1/apps/{application-id}/settings", "responseCode" : 200 }, "input" : { "shape" : "UpdateApplicationSettingsRequest" }, "output" : { "shape" : "UpdateApplicationSettingsResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Used to update the settings for an app." }, "UpdateCampaign" : { "name" : "UpdateCampaign", "http" : { "method" : "PUT", "requestUri" : "/v1/apps/{application-id}/campaigns/{campaign-id}", "responseCode" : 200 }, "input" : { "shape" : "UpdateCampaignRequest" }, "output" : { "shape" : "UpdateCampaignResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Use to update a campaign." }, "UpdateEndpoint" : { "name" : "UpdateEndpoint", "http" : { "method" : "PUT", "requestUri" : "/v1/apps/{application-id}/endpoints/{endpoint-id}", "responseCode" : 202 }, "input" : { "shape" : "UpdateEndpointRequest" }, "output" : { "shape" : "UpdateEndpointResponse", "documentation" : "202 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Use to update an endpoint." }, "UpdateEndpointsBatch" : { "name" : "UpdateEndpointsBatch", "http" : { "method" : "PUT", "requestUri" : "/v1/apps/{application-id}/endpoints", "responseCode" : 202 }, "input" : { "shape" : "UpdateEndpointsBatchRequest" }, "output" : { "shape" : "UpdateEndpointsBatchResponse", "documentation" : "202 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Use to update your endpoints." }, "UpdateGcmChannel" : { "name" : "UpdateGcmChannel", "http" : { "method" : "PUT", "requestUri" : "/v1/apps/{application-id}/channels/gcm", "responseCode" : 200 }, "input" : { "shape" : "UpdateGcmChannelRequest" }, "output" : { "shape" : "UpdateGcmChannelResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Use to update the GCM channel for an app." }, "UpdateSegment" : { "name" : "UpdateSegment", "http" : { "method" : "PUT", "requestUri" : "/v1/apps/{application-id}/segments/{segment-id}", "responseCode" : 200 }, "input" : { "shape" : "UpdateSegmentRequest" }, "output" : { "shape" : "UpdateSegmentResponse", "documentation" : "200 response" }, "errors" : [ { "shape" : "BadRequestException", "documentation" : "400 response" }, { "shape" : "InternalServerErrorException", "documentation" : "500 response" }, { "shape" : "ForbiddenException", "documentation" : "403 response" }, { "shape" : "NotFoundException", "documentation" : "404 response" }, { "shape" : "MethodNotAllowedException", "documentation" : "405 response" }, { "shape" : "TooManyRequestsException", "documentation" : "429 response" } ], "documentation" : "Use to update a segment." } }, "shapes" : { "APNSChannelRequest" : { "type" : "structure", "members" : { "Certificate" : { "shape" : "__string", "documentation" : "The distribution certificate from Apple." }, "PrivateKey" : { "shape" : "__string", "documentation" : "The certificate private key." } } }, "APNSChannelResponse" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string" }, "CreationDate" : { "shape" : "__string", "documentation" : "When was this segment created" }, "Id" : { "shape" : "__string" }, "IsArchived" : { "shape" : "__boolean", "documentation" : "Is this channel archived" }, "LastModifiedBy" : { "shape" : "__string", "documentation" : "Who last updated this entry" }, "LastModifiedDate" : { "shape" : "__string", "documentation" : "Last date this was updated" }, "Platform" : { "shape" : "__string", "documentation" : "The platform type. Will be APNS." }, "Version" : { "shape" : "__integer", "documentation" : "Version of channel" } } }, "Action" : { "type" : "string", "enum" : [ "OPEN_APP", "DEEP_LINK", "URL" ] }, "ActivitiesResponse" : { "type" : "structure", "members" : { "Item" : { "shape" : "ListOfActivityResponse", "documentation" : "List of campaign activities" } } }, "ActivityResponse" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "documentation" : "The ID of the application to which the campaign applies." }, "CampaignId" : { "shape" : "__string", "documentation" : "The ID of the campaign to which the activity applies." }, "End" : { "shape" : "__string", "documentation" : "The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format." }, "Id" : { "shape" : "__string", "documentation" : "The unique activity ID." }, "Result" : { "shape" : "__string", "documentation" : "Indicates whether the activity succeeded.\n\nValid values: SUCCESS, FAIL" }, "ScheduledStart" : { "shape" : "__string", "documentation" : "The scheduled start time for the activity in ISO 8601 format." }, "Start" : { "shape" : "__string", "documentation" : "The actual start time of the activity in ISO 8601 format." }, "State" : { "shape" : "__string", "documentation" : "The state of the activity.\n\nValid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED" }, "SuccessfulEndpointCount" : { "shape" : "__integer", "documentation" : "The total number of endpoints to which the campaign successfully delivered messages." }, "TotalEndpointCount" : { "shape" : "__integer", "documentation" : "The total number of endpoints to which the campaign attempts to deliver messages." }, "TreatmentId" : { "shape" : "__string", "documentation" : "The ID of a variation of the campaign used for A/B testing." } } }, "ApplicationSettingsResource" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "documentation" : "The unique ID for the application." }, "LastModifiedDate" : { "shape" : "__string", "documentation" : "The date that the settings were last updated in ISO 8601 format." }, "Limits" : { "shape" : "CampaignLimits", "documentation" : "The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own." }, "QuietTime" : { "shape" : "QuietTime", "documentation" : "The default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own." } } }, "AttributeDimension" : { "type" : "structure", "members" : { "AttributeType" : { "shape" : "AttributeType", "documentation" : "The type of dimension:\nINCLUSIVE – Endpoints that match the criteria are included in the segment.\nEXCLUSIVE – Endpoints that match the criteria are excluded from the segment." }, "Values" : { "shape" : "ListOf__string", "documentation" : "The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type." } } }, "AttributeType" : { "type" : "string", "enum" : [ "INCLUSIVE", "EXCLUSIVE" ] }, "BadRequestException" : { "type" : "structure", "members" : { "Message" : { "shape" : "__string" } }, "exception" : true, "error" : { "httpStatusCode" : 400 } }, "CampaignLimits" : { "type" : "structure", "members" : { "Daily" : { "shape" : "__integer", "documentation" : "The maximum number of messages that the campaign can send daily." }, "Total" : { "shape" : "__integer", "documentation" : "The maximum total number of messages that the campaign can send." } } }, "CampaignResponse" : { "type" : "structure", "members" : { "AdditionalTreatments" : { "shape" : "ListOfTreatmentResource", "documentation" : "Treatments that are defined in addition to the default treatment." }, "ApplicationId" : { "shape" : "__string", "documentation" : "The ID of the application to which the campaign applies." }, "CreationDate" : { "shape" : "__string", "documentation" : "The date the campaign was created in ISO 8601 format." }, "DefaultState" : { "shape" : "CampaignState", "documentation" : "The status of the campaign's default treatment. Only present for A/B test campaigns." }, "Description" : { "shape" : "__string", "documentation" : "A description of the campaign." }, "HoldoutPercent" : { "shape" : "__integer", "documentation" : "The allocated percentage of end users who will not receive messages from this campaign." }, "Id" : { "shape" : "__string", "documentation" : "The unique campaign ID." }, "IsPaused" : { "shape" : "__boolean", "documentation" : "Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false." }, "LastModifiedDate" : { "shape" : "__string", "documentation" : "The date the campaign was last updated in ISO 8601 format.\t" }, "Limits" : { "shape" : "CampaignLimits", "documentation" : "The campaign limits settings." }, "MessageConfiguration" : { "shape" : "MessageConfiguration", "documentation" : "The message configuration settings." }, "Name" : { "shape" : "__string", "documentation" : "The custom name of the campaign." }, "Schedule" : { "shape" : "Schedule", "documentation" : "The campaign schedule." }, "SegmentId" : { "shape" : "__string", "documentation" : "The ID of the segment to which the campaign sends messages." }, "SegmentVersion" : { "shape" : "__integer", "documentation" : "The version of the segment to which the campaign sends messages." }, "State" : { "shape" : "CampaignState", "documentation" : "The campaign status.\n\nAn A/B test campaign will have a status of COMPLETED only when all treatments have a status of COMPLETED." }, "TreatmentDescription" : { "shape" : "__string", "documentation" : "A custom description for the treatment." }, "TreatmentName" : { "shape" : "__string", "documentation" : "The custom name of a variation of the campaign used for A/B testing." }, "Version" : { "shape" : "__integer", "documentation" : "The campaign version number." } } }, "CampaignState" : { "type" : "structure", "members" : { "CampaignStatus" : { "shape" : "CampaignStatus", "documentation" : "The status of the campaign, or the status of a treatment that belongs to an A/B test campaign.\n\nValid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED" } } }, "CampaignStatus" : { "type" : "string", "enum" : [ "SCHEDULED", "EXECUTING", "PENDING_NEXT_RUN", "COMPLETED", "PAUSED" ] }, "CampaignsResponse" : { "type" : "structure", "members" : { "Item" : { "shape" : "ListOfCampaignResponse", "documentation" : "A list of campaigns." }, "NextToken" : { "shape" : "__string", "documentation" : "The string that you use in a subsequent request to get the next page of results in a paginated response." } } }, "ChannelType" : { "type" : "string", "enum" : [ "APNS", "GCM" ] }, "CreateCampaignRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "WriteCampaignRequest" : { "shape" : "WriteCampaignRequest" } }, "required" : [ "ApplicationId", "WriteCampaignRequest" ], "payload" : "WriteCampaignRequest" }, "CreateCampaignResponse" : { "type" : "structure", "members" : { "CampaignResponse" : { "shape" : "CampaignResponse" } }, "required" : [ "CampaignResponse" ], "payload" : "CampaignResponse" }, "CreateImportJobRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "ImportJobRequest" : { "shape" : "ImportJobRequest" } }, "required" : [ "ApplicationId", "ImportJobRequest" ], "payload" : "ImportJobRequest" }, "CreateImportJobResponse" : { "type" : "structure", "members" : { "ImportJobResponse" : { "shape" : "ImportJobResponse" } }, "required" : [ "ImportJobResponse" ], "payload" : "ImportJobResponse" }, "CreateSegmentRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "WriteSegmentRequest" : { "shape" : "WriteSegmentRequest" } }, "required" : [ "ApplicationId", "WriteSegmentRequest" ], "payload" : "WriteSegmentRequest" }, "CreateSegmentResponse" : { "type" : "structure", "members" : { "SegmentResponse" : { "shape" : "SegmentResponse" } }, "required" : [ "SegmentResponse" ], "payload" : "SegmentResponse" }, "DeleteApnsChannelRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" } }, "required" : [ "ApplicationId" ] }, "DeleteApnsChannelResponse" : { "type" : "structure", "members" : { "APNSChannelResponse" : { "shape" : "APNSChannelResponse" } }, "required" : [ "APNSChannelResponse" ], "payload" : "APNSChannelResponse" }, "DeleteCampaignRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "CampaignId" : { "shape" : "__string", "location" : "uri", "locationName" : "campaign-id" } }, "required" : [ "CampaignId", "ApplicationId" ] }, "DeleteCampaignResponse" : { "type" : "structure", "members" : { "CampaignResponse" : { "shape" : "CampaignResponse" } }, "required" : [ "CampaignResponse" ], "payload" : "CampaignResponse" }, "DeleteGcmChannelRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" } }, "required" : [ "ApplicationId" ] }, "DeleteGcmChannelResponse" : { "type" : "structure", "members" : { "GCMChannelResponse" : { "shape" : "GCMChannelResponse" } }, "required" : [ "GCMChannelResponse" ], "payload" : "GCMChannelResponse" }, "DeleteSegmentRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "SegmentId" : { "shape" : "__string", "location" : "uri", "locationName" : "segment-id" } }, "required" : [ "SegmentId", "ApplicationId" ] }, "DeleteSegmentResponse" : { "type" : "structure", "members" : { "SegmentResponse" : { "shape" : "SegmentResponse" } }, "required" : [ "SegmentResponse" ], "payload" : "SegmentResponse" }, "DimensionType" : { "type" : "string", "enum" : [ "INCLUSIVE", "EXCLUSIVE" ] }, "Duration" : { "type" : "string", "enum" : [ "HR_24", "DAY_7", "DAY_14", "DAY_30" ] }, "EndpointBatchItem" : { "type" : "structure", "members" : { "Address" : { "shape" : "__string", "documentation" : "The address or token of the endpoint." }, "Attributes" : { "shape" : "MapOfListOf__string", "documentation" : "Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment." }, "ChannelType" : { "shape" : "ChannelType", "documentation" : "The channel type.\n\nValid values: APNS, GCM" }, "Demographic" : { "shape" : "EndpointDemographic", "documentation" : "The endpoint demographic attributes." }, "EffectiveDate" : { "shape" : "__string", "documentation" : "The last time the endpoint was updated. Provided in ISO 8601 format." }, "EndpointStatus" : { "shape" : "__string", "documentation" : "The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated." }, "Id" : { "shape" : "__string" }, "Location" : { "shape" : "EndpointLocation", "documentation" : "The endpoint location attributes." }, "Metrics" : { "shape" : "MapOf__double", "documentation" : "Custom metrics that your app reports to Amazon Pinpoint." }, "OptOut" : { "shape" : "__string", "documentation" : "Indicates whether a user has opted out of receiving messages with one of the following values:\n\nALL – User receives all messages.\nNONE – User receives no messages." }, "RequestId" : { "shape" : "__string", "documentation" : "The unique ID for the most recent request to update the endpoint." }, "User" : { "shape" : "EndpointUser", "documentation" : "Custom user-specific attributes that your app reports to Amazon Pinpoint." } } }, "EndpointBatchRequest" : { "type" : "structure", "members" : { "Item" : { "shape" : "ListOfEndpointBatchItem", "documentation" : "List of items to update. Maximum 100 items" } } }, "EndpointDemographic" : { "type" : "structure", "members" : { "AppVersion" : { "shape" : "__string", "documentation" : "The version of the application associated with the endpoint." }, "Locale" : { "shape" : "__string", "documentation" : "The endpoint locale in the following format: The ISO 639-1 alpha-2 code, followed by an underscore, followed by an ISO 3166-1 alpha-2 value.\n" }, "Make" : { "shape" : "__string", "documentation" : "The endpoint make, such as such as Apple or Samsung." }, "Model" : { "shape" : "__string", "documentation" : "The endpoint model, such as iPhone." }, "ModelVersion" : { "shape" : "__string", "documentation" : "The endpoint model version." }, "Platform" : { "shape" : "__string", "documentation" : "The endpoint platform, such as ios or android." }, "PlatformVersion" : { "shape" : "__string", "documentation" : "The endpoint platform version." }, "Timezone" : { "shape" : "__string", "documentation" : "The timezone of the endpoint. Specified as a tz database value, such as Americas/Los_Angeles." } } }, "EndpointLocation" : { "type" : "structure", "members" : { "City" : { "shape" : "__string", "documentation" : "The city where the endpoint is located." }, "Country" : { "shape" : "__string", "documentation" : "Country according to ISO 3166-1 Alpha-2 codes. For example, US." }, "Latitude" : { "shape" : "__double", "documentation" : "The latitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile)." }, "Longitude" : { "shape" : "__double", "documentation" : "The longitude of the endpoint location. Rounded to one decimal (Roughly corresponding to a mile)." }, "PostalCode" : { "shape" : "__string", "documentation" : "The postal code or zip code of the endpoint." }, "Region" : { "shape" : "__string", "documentation" : "The region of the endpoint location. For example, corresponds to a state in US." } } }, "EndpointRequest" : { "type" : "structure", "members" : { "Address" : { "shape" : "__string", "documentation" : "The address or token of the endpoint." }, "Attributes" : { "shape" : "MapOfListOf__string", "documentation" : "Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment." }, "ChannelType" : { "shape" : "ChannelType", "documentation" : "The channel type.\n\nValid values: APNS, GCM" }, "Demographic" : { "shape" : "EndpointDemographic", "documentation" : "The endpoint demographic attributes." }, "EffectiveDate" : { "shape" : "__string", "documentation" : "The last time the endpoint was updated. Provided in ISO 8601 format." }, "EndpointStatus" : { "shape" : "__string", "documentation" : "The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated." }, "Location" : { "shape" : "EndpointLocation", "documentation" : "The endpoint location attributes." }, "Metrics" : { "shape" : "MapOf__double", "documentation" : "Custom metrics that your app reports to Amazon Pinpoint." }, "OptOut" : { "shape" : "__string", "documentation" : "Indicates whether a user has opted out of receiving messages with one of the following values:\n\nALL – User receives all messages.\nNONE – User receives no messages." }, "RequestId" : { "shape" : "__string", "documentation" : "The unique ID for the most recent request to update the endpoint." }, "User" : { "shape" : "EndpointUser", "documentation" : "Custom user-specific attributes that your app reports to Amazon Pinpoint." } } }, "EndpointResponse" : { "type" : "structure", "members" : { "Address" : { "shape" : "__string", "documentation" : "The address or token of the endpoint." }, "ApplicationId" : { "shape" : "__string", "documentation" : "The ID of the application associated with the endpoint." }, "Attributes" : { "shape" : "MapOfListOf__string", "documentation" : "Custom attributes that your app reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create a segment." }, "ChannelType" : { "shape" : "ChannelType", "documentation" : "The channel type.\n\nValid values: APNS, GCM" }, "CohortId" : { "shape" : "__string", "documentation" : "A number from 0 - 99 that represents the cohort the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an app. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for a campaign." }, "CreationDate" : { "shape" : "__string", "documentation" : "The last time the endpoint was created. Provided in ISO 8601 format." }, "Demographic" : { "shape" : "EndpointDemographic", "documentation" : "The endpoint demographic attributes." }, "EffectiveDate" : { "shape" : "__string", "documentation" : "The last time the endpoint was updated. Provided in ISO 8601 format." }, "EndpointStatus" : { "shape" : "__string", "documentation" : "The endpoint status. Can be either ACTIVE or INACTIVE. Will be set to INACTIVE if a delivery fails. Will be set to ACTIVE if the address is updated." }, "Id" : { "shape" : "__string", "documentation" : "The unique ID that you assigned to the endpoint. The ID should be a globally unique identifier (GUID) to ensure that it is unique compared to all other endpoints for the application." }, "Location" : { "shape" : "EndpointLocation", "documentation" : "The endpoint location attributes." }, "Metrics" : { "shape" : "MapOf__double", "documentation" : "Custom metrics that your app reports to Amazon Pinpoint." }, "OptOut" : { "shape" : "__string", "documentation" : "Indicates whether a user has opted out of receiving messages with one of the following values:\n\nALL – User receives all messages.\nNONE – User receives no messages." }, "RequestId" : { "shape" : "__string", "documentation" : "The unique ID for the most recent request to update the endpoint." }, "ShardId" : { "shape" : "__string", "documentation" : "The ShardId of endpoint" }, "User" : { "shape" : "EndpointUser", "documentation" : "Custom user-specific attributes that your app reports to Amazon Pinpoint." } } }, "EndpointUser" : { "type" : "structure", "members" : { "UserAttributes" : { "shape" : "MapOfListOf__string", "documentation" : "Custom attributesd specific to the user." }, "UserId" : { "shape" : "__string", "documentation" : "The unique ID of the user." } } }, "ForbiddenException" : { "type" : "structure", "members" : { "Message" : { "shape" : "__string" } }, "exception" : true, "error" : { "httpStatusCode" : 403 } }, "Format" : { "type" : "string", "enum" : [ "CSV", "JSON" ] }, "Frequency" : { "type" : "string", "enum" : [ "ONCE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY" ] }, "GCMChannelRequest" : { "type" : "structure", "members" : { "ApiKey" : { "shape" : "__string", "documentation" : "Platform credential API key from Google." } } }, "GCMChannelResponse" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string" }, "CreationDate" : { "shape" : "__string", "documentation" : "When was this segment created" }, "Credential" : { "shape" : "__string", "documentation" : "The GCM API key from Google." }, "Id" : { "shape" : "__string" }, "IsArchived" : { "shape" : "__boolean", "documentation" : "Is this channel archived" }, "LastModifiedBy" : { "shape" : "__string", "documentation" : "Who last updated this entry" }, "LastModifiedDate" : { "shape" : "__string", "documentation" : "Last date this was updated" }, "Platform" : { "shape" : "__string", "documentation" : "The platform type. Will be GCM" }, "Version" : { "shape" : "__integer", "documentation" : "Version of channel" } } }, "GetApnsChannelRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" } }, "required" : [ "ApplicationId" ] }, "GetApnsChannelResponse" : { "type" : "structure", "members" : { "APNSChannelResponse" : { "shape" : "APNSChannelResponse" } }, "required" : [ "APNSChannelResponse" ], "payload" : "APNSChannelResponse" }, "GetApplicationSettingsRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" } }, "required" : [ "ApplicationId" ] }, "GetApplicationSettingsResponse" : { "type" : "structure", "members" : { "ApplicationSettingsResource" : { "shape" : "ApplicationSettingsResource" } }, "required" : [ "ApplicationSettingsResource" ], "payload" : "ApplicationSettingsResource" }, "GetCampaignActivitiesRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "CampaignId" : { "shape" : "__string", "location" : "uri", "locationName" : "campaign-id" }, "PageSize" : { "shape" : "__string", "location" : "querystring", "locationName" : "page-size" }, "Token" : { "shape" : "__string", "location" : "querystring", "locationName" : "token" } }, "required" : [ "ApplicationId", "CampaignId" ] }, "GetCampaignActivitiesResponse" : { "type" : "structure", "members" : { "ActivitiesResponse" : { "shape" : "ActivitiesResponse" } }, "required" : [ "ActivitiesResponse" ], "payload" : "ActivitiesResponse" }, "GetCampaignRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "CampaignId" : { "shape" : "__string", "location" : "uri", "locationName" : "campaign-id" } }, "required" : [ "CampaignId", "ApplicationId" ] }, "GetCampaignResponse" : { "type" : "structure", "members" : { "CampaignResponse" : { "shape" : "CampaignResponse" } }, "required" : [ "CampaignResponse" ], "payload" : "CampaignResponse" }, "GetCampaignVersionRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "CampaignId" : { "shape" : "__string", "location" : "uri", "locationName" : "campaign-id" }, "Version" : { "shape" : "__string", "location" : "uri", "locationName" : "version" } }, "required" : [ "Version", "ApplicationId", "CampaignId" ] }, "GetCampaignVersionResponse" : { "type" : "structure", "members" : { "CampaignResponse" : { "shape" : "CampaignResponse" } }, "required" : [ "CampaignResponse" ], "payload" : "CampaignResponse" }, "GetCampaignVersionsRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "CampaignId" : { "shape" : "__string", "location" : "uri", "locationName" : "campaign-id" }, "PageSize" : { "shape" : "__string", "location" : "querystring", "locationName" : "page-size" }, "Token" : { "shape" : "__string", "location" : "querystring", "locationName" : "token" } }, "required" : [ "ApplicationId", "CampaignId" ] }, "GetCampaignVersionsResponse" : { "type" : "structure", "members" : { "CampaignsResponse" : { "shape" : "CampaignsResponse" } }, "required" : [ "CampaignsResponse" ], "payload" : "CampaignsResponse" }, "GetCampaignsRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "PageSize" : { "shape" : "__string", "location" : "querystring", "locationName" : "page-size" }, "Token" : { "shape" : "__string", "location" : "querystring", "locationName" : "token" } }, "required" : [ "ApplicationId" ] }, "GetCampaignsResponse" : { "type" : "structure", "members" : { "CampaignsResponse" : { "shape" : "CampaignsResponse" } }, "required" : [ "CampaignsResponse" ], "payload" : "CampaignsResponse" }, "GetEndpointRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "EndpointId" : { "shape" : "__string", "location" : "uri", "locationName" : "endpoint-id" } }, "required" : [ "ApplicationId", "EndpointId" ] }, "GetEndpointResponse" : { "type" : "structure", "members" : { "EndpointResponse" : { "shape" : "EndpointResponse" } }, "required" : [ "EndpointResponse" ], "payload" : "EndpointResponse" }, "GetGcmChannelRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" } }, "required" : [ "ApplicationId" ] }, "GetGcmChannelResponse" : { "type" : "structure", "members" : { "GCMChannelResponse" : { "shape" : "GCMChannelResponse" } }, "required" : [ "GCMChannelResponse" ], "payload" : "GCMChannelResponse" }, "GetImportJobRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "JobId" : { "shape" : "__string", "location" : "uri", "locationName" : "job-id" } }, "required" : [ "ApplicationId", "JobId" ] }, "GetImportJobResponse" : { "type" : "structure", "members" : { "ImportJobResponse" : { "shape" : "ImportJobResponse" } }, "required" : [ "ImportJobResponse" ], "payload" : "ImportJobResponse" }, "GetImportJobsRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "PageSize" : { "shape" : "__string", "location" : "querystring", "locationName" : "page-size" }, "Token" : { "shape" : "__string", "location" : "querystring", "locationName" : "token" } }, "required" : [ "ApplicationId" ] }, "GetImportJobsResponse" : { "type" : "structure", "members" : { "ImportJobsResponse" : { "shape" : "ImportJobsResponse" } }, "required" : [ "ImportJobsResponse" ], "payload" : "ImportJobsResponse" }, "GetSegmentImportJobsRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "PageSize" : { "shape" : "__string", "location" : "querystring", "locationName" : "page-size" }, "SegmentId" : { "shape" : "__string", "location" : "uri", "locationName" : "segment-id" }, "Token" : { "shape" : "__string", "location" : "querystring", "locationName" : "token" } }, "required" : [ "SegmentId", "ApplicationId" ] }, "GetSegmentImportJobsResponse" : { "type" : "structure", "members" : { "ImportJobsResponse" : { "shape" : "ImportJobsResponse" } }, "required" : [ "ImportJobsResponse" ], "payload" : "ImportJobsResponse" }, "GetSegmentRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "SegmentId" : { "shape" : "__string", "location" : "uri", "locationName" : "segment-id" } }, "required" : [ "SegmentId", "ApplicationId" ] }, "GetSegmentResponse" : { "type" : "structure", "members" : { "SegmentResponse" : { "shape" : "SegmentResponse" } }, "required" : [ "SegmentResponse" ], "payload" : "SegmentResponse" }, "GetSegmentVersionRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "SegmentId" : { "shape" : "__string", "location" : "uri", "locationName" : "segment-id" }, "Version" : { "shape" : "__string", "location" : "uri", "locationName" : "version" } }, "required" : [ "SegmentId", "Version", "ApplicationId" ] }, "GetSegmentVersionResponse" : { "type" : "structure", "members" : { "SegmentResponse" : { "shape" : "SegmentResponse" } }, "required" : [ "SegmentResponse" ], "payload" : "SegmentResponse" }, "GetSegmentVersionsRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "PageSize" : { "shape" : "__string", "location" : "querystring", "locationName" : "page-size" }, "SegmentId" : { "shape" : "__string", "location" : "uri", "locationName" : "segment-id" }, "Token" : { "shape" : "__string", "location" : "querystring", "locationName" : "token" } }, "required" : [ "SegmentId", "ApplicationId" ] }, "GetSegmentVersionsResponse" : { "type" : "structure", "members" : { "SegmentsResponse" : { "shape" : "SegmentsResponse" } }, "required" : [ "SegmentsResponse" ], "payload" : "SegmentsResponse" }, "GetSegmentsRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "PageSize" : { "shape" : "__string", "location" : "querystring", "locationName" : "page-size" }, "Token" : { "shape" : "__string", "location" : "querystring", "locationName" : "token" } }, "required" : [ "ApplicationId" ] }, "GetSegmentsResponse" : { "type" : "structure", "members" : { "SegmentsResponse" : { "shape" : "SegmentsResponse" } }, "required" : [ "SegmentsResponse" ], "payload" : "SegmentsResponse" }, "ImportJobRequest" : { "type" : "structure", "members" : { "DefineSegment" : { "shape" : "__boolean", "documentation" : "Sets whether the endpoints create a segment when they are imported." }, "ExternalId" : { "shape" : "__string", "documentation" : "A unique, custom ID assigned to the IAM role that restricts who can assume the role.\t" }, "Format" : { "shape" : "Format", "documentation" : "The format of the files that contain the endpoint definitions.\nValid values: CSV, JSON" }, "RegisterEndpoints" : { "shape" : "__boolean", "documentation" : "Sets whether the endpoints are registered with Amazon Pinpoint when they are imported." }, "RoleArn" : { "shape" : "__string", "documentation" : "The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import." }, "S3Url" : { "shape" : "__string", "documentation" : "A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file.\nThe URL should follow this format: s3://bucket-name/folder-name/file-name\n\nAmazon Pinpoint will import endpoints from this location and any subfolders it contains." }, "SegmentId" : { "shape" : "__string", "documentation" : "The ID of the segment to update if the import job is meant to update an existing segment." }, "SegmentName" : { "shape" : "__string", "documentation" : "A custom name for the segment created by the import job. Use if DefineSegment is true." } } }, "ImportJobResource" : { "type" : "structure", "members" : { "DefineSegment" : { "shape" : "__boolean", "documentation" : "Sets whether the endpoints create a segment when they are imported." }, "ExternalId" : { "shape" : "__string", "documentation" : "A unique, custom ID assigned to the IAM role that restricts who can assume the role.\t" }, "Format" : { "shape" : "Format", "documentation" : "The format of the files that contain the endpoint definitions.\nValid values: CSV, JSON" }, "RegisterEndpoints" : { "shape" : "__boolean", "documentation" : "Sets whether the endpoints are registered with Amazon Pinpoint when they are imported." }, "RoleArn" : { "shape" : "__string", "documentation" : "The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import." }, "S3Url" : { "shape" : "__string", "documentation" : "A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file.\nThe URL should follow this format: s3://bucket-name/folder-name/file-name\n\nAmazon Pinpoint will import endpoints from this location and any subfolders it contains." }, "SegmentId" : { "shape" : "__string", "documentation" : "The ID of the segment to update if the import job is meant to update an existing segment." }, "SegmentName" : { "shape" : "__string", "documentation" : "A custom name for the segment created by the import job. Use if DefineSegment is true." } } }, "ImportJobResponse" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "documentation" : "The unique ID of the application to which the import job applies." }, "CompletedPieces" : { "shape" : "__integer", "documentation" : "The number of pieces that have successfully imported as of the time of the request." }, "CompletionDate" : { "shape" : "__string", "documentation" : "The date the import job completed in ISO 8601 format." }, "CreationDate" : { "shape" : "__string", "documentation" : "The date the import job was created in ISO 8601 format." }, "Definition" : { "shape" : "ImportJobResource", "documentation" : "The import job settings." }, "FailedPieces" : { "shape" : "__integer", "documentation" : "The number of pieces that have failed to import as of the time of the request." }, "Failures" : { "shape" : "ListOf__string", "documentation" : "Provides up to 100 of the first failed entries for the job, if any exist." }, "Id" : { "shape" : "__string", "documentation" : "The unique ID of the import job." }, "JobStatus" : { "shape" : "JobStatus", "documentation" : "The status of the import job.\nValid values: CREATED, INITIALIZING, PROCESSING, COMPLETING, COMPLETED, FAILING, FAILED\n\nThe job status is FAILED if one or more pieces failed to import." }, "TotalFailures" : { "shape" : "__integer", "documentation" : "The number of endpoints that failed to import; for example, because of syntax errors." }, "TotalPieces" : { "shape" : "__integer", "documentation" : "The total number of pieces that must be imported to finish the job. Each piece is an approximately equal portion of the endpoints to import." }, "TotalProcessed" : { "shape" : "__integer", "documentation" : "The number of endpoints that were processed by the import job." }, "Type" : { "shape" : "__string", "documentation" : "The job type. Will be Import." } } }, "ImportJobsResponse" : { "type" : "structure", "members" : { "Item" : { "shape" : "ListOfImportJobResponse", "documentation" : "A list of import jobs for the application." }, "NextToken" : { "shape" : "__string", "documentation" : "The string that you use in a subsequent request to get the next page of results in a paginated response." } } }, "InternalServerErrorException" : { "type" : "structure", "members" : { "Message" : { "shape" : "__string" } }, "exception" : true, "error" : { "httpStatusCode" : 500 } }, "JobStatus" : { "type" : "string", "enum" : [ "CREATED", "INITIALIZING", "PROCESSING", "COMPLETING", "COMPLETED", "FAILING", "FAILED" ] }, "ListOfActivityResponse" : { "type" : "list", "member" : { "shape" : "ActivityResponse" } }, "ListOfCampaignResponse" : { "type" : "list", "member" : { "shape" : "CampaignResponse" } }, "ListOfEndpointBatchItem" : { "type" : "list", "member" : { "shape" : "EndpointBatchItem" } }, "ListOfImportJobResponse" : { "type" : "list", "member" : { "shape" : "ImportJobResponse" } }, "ListOfSegmentResponse" : { "type" : "list", "member" : { "shape" : "SegmentResponse" } }, "ListOfTreatmentResource" : { "type" : "list", "member" : { "shape" : "TreatmentResource" } }, "ListOfWriteTreatmentResource" : { "type" : "list", "member" : { "shape" : "WriteTreatmentResource" } }, "ListOf__string" : { "type" : "list", "member" : { "shape" : "__string" } }, "MapOfAttributeDimension" : { "type" : "map", "key" : { "shape" : "__string" }, "value" : { "shape" : "AttributeDimension" } }, "MapOfListOf__string" : { "type" : "map", "key" : { "shape" : "__string" }, "value" : { "shape" : "ListOf__string" } }, "MapOf__double" : { "type" : "map", "key" : { "shape" : "__string" }, "value" : { "shape" : "__double" } }, "Message" : { "type" : "structure", "members" : { "Action" : { "shape" : "Action", "documentation" : "The action that occurs if the user taps a push notification delivered by the campaign:\nOPEN_APP – Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action.\n\nDEEP_LINK – Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app.\n\nURL – The default mobile browser on the user's device launches and opens a web page at the URL you specify." }, "Body" : { "shape" : "__string", "documentation" : "The message body. Can include up to 140 characters." }, "ImageIconUrl" : { "shape" : "__string", "documentation" : "The URL that points to the icon image for the push notification icon, for example, the app icon." }, "ImageUrl" : { "shape" : "__string", "documentation" : "The URL that points to an image used in the push notification." }, "JsonBody" : { "shape" : "__string", "documentation" : "The JSON payload used for a silent push." }, "MediaUrl" : { "shape" : "__string", "documentation" : "The URL that points to the media resource, for example a .mp4 or .gif file." }, "SilentPush" : { "shape" : "__boolean", "documentation" : "Indicates if the message should display on the users device.\n\nSilent pushes can be used for Remote Configuration and Phone Home use cases. " }, "Title" : { "shape" : "__string", "documentation" : "The message title that displays above the message on the user's device." }, "Url" : { "shape" : "__string", "documentation" : "The URL to open in the user's mobile browser. Used if the value for Action is URL." } } }, "MessageBody" : { "type" : "structure", "members" : { "Message" : { "shape" : "__string" }, "RequestID" : { "shape" : "__string" } } }, "MessageConfiguration" : { "type" : "structure", "members" : { "APNSMessage" : { "shape" : "Message", "documentation" : "The message that the campaign delivers to APNS channels. Overrides the default message." }, "DefaultMessage" : { "shape" : "Message", "documentation" : "The default message for all channels." }, "GCMMessage" : { "shape" : "Message", "documentation" : "The message that the campaign delivers to GCM channels. Overrides the default message." } } }, "MethodNotAllowedException" : { "type" : "structure", "members" : { "Message" : { "shape" : "__string" } }, "exception" : true, "error" : { "httpStatusCode" : 405 } }, "NotFoundException" : { "type" : "structure", "members" : { "Message" : { "shape" : "__string" } }, "exception" : true, "error" : { "httpStatusCode" : 404 } }, "QuietTime" : { "type" : "structure", "members" : { "End" : { "shape" : "__string", "documentation" : "The default end time for quiet time in ISO 8601 format." }, "Start" : { "shape" : "__string", "documentation" : "The default start time for quiet time in ISO 8601 format." } } }, "RecencyDimension" : { "type" : "structure", "members" : { "Duration" : { "shape" : "Duration", "documentation" : "The length of time during which users have been active or inactive with your app.\nValid values: HR_24, DAY_7, DAY_14, DAY_30" }, "RecencyType" : { "shape" : "RecencyType", "documentation" : "The recency dimension type:\nACTIVE – Users who have used your app within the specified duration are included in the segment.\nINACTIVE – Users who have not used your app within the specified duration are included in the segment." } } }, "RecencyType" : { "type" : "string", "enum" : [ "ACTIVE", "INACTIVE" ] }, "Schedule" : { "type" : "structure", "members" : { "EndTime" : { "shape" : "__string", "documentation" : "The scheduled time that the campaign ends in ISO 8601 format." }, "Frequency" : { "shape" : "Frequency", "documentation" : "How often the campaign delivers messages.\n\nValid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY" }, "IsLocalTime" : { "shape" : "__boolean", "documentation" : "Indicates whether the campaign schedule takes effect according to each user's local time." }, "QuietTime" : { "shape" : "QuietTime", "documentation" : "The time during which the campaign sends no messages." }, "StartTime" : { "shape" : "__string", "documentation" : "The scheduled time that the campaign begins in ISO 8601 format." }, "Timezone" : { "shape" : "__string", "documentation" : "The starting UTC offset for the schedule if the value for isLocalTime is true\n\nValid values: \nUTC\nUTC+01\nUTC+02\nUTC+03\nUTC+03:30\nUTC+04\nUTC+04:30\nUTC+05\nUTC+05:30\nUTC+05:45\nUTC+06\nUTC+06:30\nUTC+07\nUTC+08\nUTC+09\nUTC+09:30\nUTC+10\nUTC+10:30\nUTC+11\nUTC+12\nUTC+13\nUTC-02\nUTC-03\nUTC-04\nUTC-05\nUTC-06\nUTC-07\nUTC-08\nUTC-09\nUTC-10\nUTC-11" } } }, "SegmentBehaviors" : { "type" : "structure", "members" : { "Recency" : { "shape" : "RecencyDimension", "documentation" : "The recency of use." } } }, "SegmentDemographics" : { "type" : "structure", "members" : { "AppVersion" : { "shape" : "SetDimension", "documentation" : "The app version criteria for the segment." }, "DeviceType" : { "shape" : "SetDimension", "documentation" : "The device type criteria for the segment." }, "Make" : { "shape" : "SetDimension", "documentation" : "The device make criteria for the segment." }, "Model" : { "shape" : "SetDimension", "documentation" : "The device model criteria for the segment." }, "Platform" : { "shape" : "SetDimension", "documentation" : "The device platform criteria for the segment." } } }, "SegmentDimensions" : { "type" : "structure", "members" : { "Attributes" : { "shape" : "MapOfAttributeDimension", "documentation" : "Custom segment attributes." }, "Behavior" : { "shape" : "SegmentBehaviors", "documentation" : "The segment behaviors attributes." }, "Demographic" : { "shape" : "SegmentDemographics", "documentation" : "The segment demographics attributes." }, "Location" : { "shape" : "SegmentLocation", "documentation" : "The segment location attributes.\n" } } }, "SegmentImportResource" : { "type" : "structure", "members" : { "ExternalId" : { "shape" : "__string", "documentation" : "A unique, custom ID assigned to the IAM role that restricts who can assume the role." }, "Format" : { "shape" : "Format", "documentation" : "The format of the endpoint files that were imported to create this segment.\nValid values: CSV, JSON" }, "RoleArn" : { "shape" : "__string", "documentation" : "The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the endpoints in Amazon S3." }, "S3Url" : { "shape" : "__string", "documentation" : "A URL that points to the Amazon S3 location from which the endpoints for this segment were imported." }, "Size" : { "shape" : "__integer", "documentation" : "The number of endpoints that were successfully imported to create this segment." } } }, "SegmentLocation" : { "type" : "structure", "members" : { "Country" : { "shape" : "SetDimension", "documentation" : "The country filter according to ISO 3166-1 Alpha-2 codes." } } }, "SegmentResponse" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "documentation" : "The ID of the application to which the segment applies." }, "CreationDate" : { "shape" : "__string", "documentation" : "The date the segment was created in ISO 8601 format." }, "Dimensions" : { "shape" : "SegmentDimensions", "documentation" : "The segment dimensions attributes." }, "Id" : { "shape" : "__string", "documentation" : "The unique segment ID." }, "ImportDefinition" : { "shape" : "SegmentImportResource", "documentation" : "The import job settings." }, "LastModifiedDate" : { "shape" : "__string", "documentation" : "The date the segment was last updated in ISO 8601 format." }, "Name" : { "shape" : "__string", "documentation" : "The name of segment" }, "SegmentType" : { "shape" : "SegmentType", "documentation" : "The segment type:\nDIMENSIONAL – A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource.\nIMPORT – A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource." }, "Version" : { "shape" : "__integer", "documentation" : "The segment version number." } } }, "SegmentType" : { "type" : "string", "enum" : [ "DIMENSIONAL", "IMPORT" ] }, "SegmentsResponse" : { "type" : "structure", "members" : { "Item" : { "shape" : "ListOfSegmentResponse", "documentation" : "The list of segments." }, "NextToken" : { "shape" : "__string", "documentation" : "An identifier used to retrieve the next page of results. The token is null if no additional pages exist." } } }, "SetDimension" : { "type" : "structure", "members" : { "DimensionType" : { "shape" : "DimensionType", "documentation" : "The type of dimension:\nINCLUSIVE – Endpoints that match the criteria are included in the segment.\nEXCLUSIVE – Endpoints that match the criteria are excluded from the segment." }, "Values" : { "shape" : "ListOf__string", "documentation" : "The criteria values for the segment dimension. Endpoints with matching attribute values are included or excluded from the segment, depending on the setting for Type." } } }, "TooManyRequestsException" : { "type" : "structure", "members" : { "Message" : { "shape" : "__string" } }, "exception" : true, "error" : { "httpStatusCode" : 429 } }, "TreatmentResource" : { "type" : "structure", "members" : { "Id" : { "shape" : "__string", "documentation" : "The unique treatment ID." }, "MessageConfiguration" : { "shape" : "MessageConfiguration", "documentation" : "The message configuration settings." }, "Schedule" : { "shape" : "Schedule", "documentation" : "The campaign schedule." }, "SizePercent" : { "shape" : "__integer", "documentation" : "The allocated percentage of users for this treatment." }, "State" : { "shape" : "CampaignState", "documentation" : "The treatment status." }, "TreatmentDescription" : { "shape" : "__string", "documentation" : "A custom description for the treatment." }, "TreatmentName" : { "shape" : "__string", "documentation" : "The custom name of a variation of the campaign used for A/B testing." } } }, "UpdateApnsChannelRequest" : { "type" : "structure", "members" : { "APNSChannelRequest" : { "shape" : "APNSChannelRequest" }, "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" } }, "required" : [ "ApplicationId", "APNSChannelRequest" ], "payload" : "APNSChannelRequest" }, "UpdateApnsChannelResponse" : { "type" : "structure", "members" : { "APNSChannelResponse" : { "shape" : "APNSChannelResponse" } }, "required" : [ "APNSChannelResponse" ], "payload" : "APNSChannelResponse" }, "UpdateApplicationSettingsRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "WriteApplicationSettingsRequest" : { "shape" : "WriteApplicationSettingsRequest" } }, "required" : [ "ApplicationId", "WriteApplicationSettingsRequest" ], "payload" : "WriteApplicationSettingsRequest" }, "UpdateApplicationSettingsResponse" : { "type" : "structure", "members" : { "ApplicationSettingsResource" : { "shape" : "ApplicationSettingsResource" } }, "required" : [ "ApplicationSettingsResource" ], "payload" : "ApplicationSettingsResource" }, "UpdateCampaignRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "CampaignId" : { "shape" : "__string", "location" : "uri", "locationName" : "campaign-id" }, "WriteCampaignRequest" : { "shape" : "WriteCampaignRequest" } }, "required" : [ "CampaignId", "ApplicationId", "WriteCampaignRequest" ], "payload" : "WriteCampaignRequest" }, "UpdateCampaignResponse" : { "type" : "structure", "members" : { "CampaignResponse" : { "shape" : "CampaignResponse" } }, "required" : [ "CampaignResponse" ], "payload" : "CampaignResponse" }, "UpdateEndpointRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "EndpointId" : { "shape" : "__string", "location" : "uri", "locationName" : "endpoint-id" }, "EndpointRequest" : { "shape" : "EndpointRequest" } }, "required" : [ "ApplicationId", "EndpointId", "EndpointRequest" ], "payload" : "EndpointRequest" }, "UpdateEndpointResponse" : { "type" : "structure", "members" : { "MessageBody" : { "shape" : "MessageBody" } }, "required" : [ "MessageBody" ], "payload" : "MessageBody" }, "UpdateEndpointsBatchRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "EndpointBatchRequest" : { "shape" : "EndpointBatchRequest" } }, "required" : [ "ApplicationId", "EndpointBatchRequest" ], "payload" : "EndpointBatchRequest" }, "UpdateEndpointsBatchResponse" : { "type" : "structure", "members" : { "MessageBody" : { "shape" : "MessageBody" } }, "required" : [ "MessageBody" ], "payload" : "MessageBody" }, "UpdateGcmChannelRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "GCMChannelRequest" : { "shape" : "GCMChannelRequest" } }, "required" : [ "ApplicationId", "GCMChannelRequest" ], "payload" : "GCMChannelRequest" }, "UpdateGcmChannelResponse" : { "type" : "structure", "members" : { "GCMChannelResponse" : { "shape" : "GCMChannelResponse" } }, "required" : [ "GCMChannelResponse" ], "payload" : "GCMChannelResponse" }, "UpdateSegmentRequest" : { "type" : "structure", "members" : { "ApplicationId" : { "shape" : "__string", "location" : "uri", "locationName" : "application-id" }, "SegmentId" : { "shape" : "__string", "location" : "uri", "locationName" : "segment-id" }, "WriteSegmentRequest" : { "shape" : "WriteSegmentRequest" } }, "required" : [ "SegmentId", "ApplicationId", "WriteSegmentRequest" ], "payload" : "WriteSegmentRequest" }, "UpdateSegmentResponse" : { "type" : "structure", "members" : { "SegmentResponse" : { "shape" : "SegmentResponse" } }, "required" : [ "SegmentResponse" ], "payload" : "SegmentResponse" }, "WriteApplicationSettingsRequest" : { "type" : "structure", "members" : { "Limits" : { "shape" : "CampaignLimits", "documentation" : "The default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own." }, "QuietTime" : { "shape" : "QuietTime", "documentation" : "The default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own." } } }, "WriteCampaignRequest" : { "type" : "structure", "members" : { "AdditionalTreatments" : { "shape" : "ListOfWriteTreatmentResource", "documentation" : "Treatments that are defined in addition to the default treatment." }, "Description" : { "shape" : "__string", "documentation" : "A description of the campaign." }, "HoldoutPercent" : { "shape" : "__integer", "documentation" : "The allocated percentage of end users who will not receive messages from this campaign." }, "IsPaused" : { "shape" : "__boolean", "documentation" : "Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by setting IsPaused to false." }, "Limits" : { "shape" : "CampaignLimits", "documentation" : "The campaign limits settings." }, "MessageConfiguration" : { "shape" : "MessageConfiguration", "documentation" : "The message configuration settings." }, "Name" : { "shape" : "__string", "documentation" : "The custom name of the campaign." }, "Schedule" : { "shape" : "Schedule", "documentation" : "The campaign schedule." }, "SegmentId" : { "shape" : "__string", "documentation" : "The ID of the segment to which the campaign sends messages." }, "SegmentVersion" : { "shape" : "__integer", "documentation" : "The version of the segment to which the campaign sends messages." }, "TreatmentDescription" : { "shape" : "__string", "documentation" : "A custom description for the treatment." }, "TreatmentName" : { "shape" : "__string", "documentation" : "The custom name of a variation of the campaign used for A/B testing." } } }, "WriteSegmentRequest" : { "type" : "structure", "members" : { "Dimensions" : { "shape" : "SegmentDimensions", "documentation" : "The segment dimensions attributes." }, "Name" : { "shape" : "__string", "documentation" : "The name of segment" } } }, "WriteTreatmentResource" : { "type" : "structure", "members" : { "MessageConfiguration" : { "shape" : "MessageConfiguration", "documentation" : "The message configuration settings." }, "Schedule" : { "shape" : "Schedule", "documentation" : "The campaign schedule." }, "SizePercent" : { "shape" : "__integer", "documentation" : "The allocated percentage of users for this treatment." }, "TreatmentDescription" : { "shape" : "__string", "documentation" : "A custom description for the treatment." }, "TreatmentName" : { "shape" : "__string", "documentation" : "The custom name of a variation of the campaign used for A/B testing." } } }, "__boolean" : { "type" : "boolean" }, "__double" : { "type" : "double" }, "__integer" : { "type" : "integer" }, "__string" : { "type" : "string" } } } botocore-1.5.7/botocore/data/batch/0000777454262600001440000000000013042511307020214 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/batch/2016-08-10/0000777454262600001440000000000013042511307021247 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/batch/2016-08-10/service-2.json0000666454262600001440000020326013042511306023743 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-08-10", "endpointPrefix":"batch", "jsonVersion":"1.1", "protocol":"rest-json", "serviceAbbreviation":"AWS Batch", "serviceFullName":"AWS Batch", "signatureVersion":"v4", "uid":"batch-2016-08-10" }, "operations":{ "CancelJob":{ "name":"CancelJob", "http":{ "method":"POST", "requestUri":"/v1/canceljob" }, "input":{"shape":"CancelJobRequest"}, "output":{"shape":"CancelJobResponse"}, "errors":[ {"shape":"ClientException"}, {"shape":"ServerException"} ], "documentation":"

Cancels jobs in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are cancelled. Jobs that have progressed to STARTING or RUNNING are not cancelled (but the API operation still succeeds, even if no jobs are cancelled); these jobs must be terminated with the TerminateJob operation.

" }, "CreateComputeEnvironment":{ "name":"CreateComputeEnvironment", "http":{ "method":"POST", "requestUri":"/v1/createcomputeenvironment" }, "input":{"shape":"CreateComputeEnvironmentRequest"}, "output":{"shape":"CreateComputeEnvironmentResponse"}, "errors":[ {"shape":"ClientException"}, {"shape":"ServerException"} ], "documentation":"

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGEDcompute environments.

In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use the latest Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.

In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see Container Instance AMIs in the Amazon EC2 Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it and then manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS Container Instance in the Amazon EC2 Container Service Developer Guide.

" }, "CreateJobQueue":{ "name":"CreateJobQueue", "http":{ "method":"POST", "requestUri":"/v1/createjobqueue" }, "input":{"shape":"CreateJobQueueRequest"}, "output":{"shape":"CreateJobQueueResponse"}, "errors":[ {"shape":"ClientException"}, {"shape":"ServerException"} ], "documentation":"

Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.

You also set a priority to the job queue that determines the order in which the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.

" }, "DeleteComputeEnvironment":{ "name":"DeleteComputeEnvironment", "http":{ "method":"POST", "requestUri":"/v1/deletecomputeenvironment" }, "input":{"shape":"DeleteComputeEnvironmentRequest"}, "output":{"shape":"DeleteComputeEnvironmentResponse"}, "errors":[ {"shape":"ClientException"}, {"shape":"ServerException"} ], "documentation":"

Deletes an AWS Batch compute environment.

Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation.

" }, "DeleteJobQueue":{ "name":"DeleteJobQueue", "http":{ "method":"POST", "requestUri":"/v1/deletejobqueue" }, "input":{"shape":"DeleteJobQueueRequest"}, "output":{"shape":"DeleteJobQueueResponse"}, "errors":[ {"shape":"ClientException"}, {"shape":"ServerException"} ], "documentation":"

Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation and terminate any jobs that have not completed with the TerminateJob.

It is not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request.

" }, "DeregisterJobDefinition":{ "name":"DeregisterJobDefinition", "http":{ "method":"POST", "requestUri":"/v1/deregisterjobdefinition" }, "input":{"shape":"DeregisterJobDefinitionRequest"}, "output":{"shape":"DeregisterJobDefinitionResponse"}, "errors":[ {"shape":"ClientException"}, {"shape":"ServerException"} ], "documentation":"

Deregisters an AWS Batch job definition.

" }, "DescribeComputeEnvironments":{ "name":"DescribeComputeEnvironments", "http":{ "method":"POST", "requestUri":"/v1/describecomputeenvironments" }, "input":{"shape":"DescribeComputeEnvironmentsRequest"}, "output":{"shape":"DescribeComputeEnvironmentsResponse"}, "errors":[ {"shape":"ClientException"}, {"shape":"ServerException"} ], "documentation":"

Describes one or more of your compute environments.

If you are using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into.

" }, "DescribeJobDefinitions":{ "name":"DescribeJobDefinitions", "http":{ "method":"POST", "requestUri":"/v1/describejobdefinitions" }, "input":{"shape":"DescribeJobDefinitionsRequest"}, "output":{"shape":"DescribeJobDefinitionsResponse"}, "errors":[ {"shape":"ClientException"}, {"shape":"ServerException"} ], "documentation":"

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.

" }, "DescribeJobQueues":{ "name":"DescribeJobQueues", "http":{ "method":"POST", "requestUri":"/v1/describejobqueues" }, "input":{"shape":"DescribeJobQueuesRequest"}, "output":{"shape":"DescribeJobQueuesResponse"}, "errors":[ {"shape":"ClientException"}, {"shape":"ServerException"} ], "documentation":"

Describes one or more of your job queues.

" }, "DescribeJobs":{ "name":"DescribeJobs", "http":{ "method":"POST", "requestUri":"/v1/describejobs" }, "input":{"shape":"DescribeJobsRequest"}, "output":{"shape":"DescribeJobsResponse"}, "errors":[ {"shape":"ClientException"}, {"shape":"ServerException"} ], "documentation":"

Describes a list of AWS Batch jobs.

" }, "ListJobs":{ "name":"ListJobs", "http":{ "method":"POST", "requestUri":"/v1/listjobs" }, "input":{"shape":"ListJobsRequest"}, "output":{"shape":"ListJobsResponse"}, "errors":[ {"shape":"ClientException"}, {"shape":"ServerException"} ], "documentation":"

Returns a list of task jobs for a specified job queue. You can filter the results by job status with the jobStatus parameter.

" }, "RegisterJobDefinition":{ "name":"RegisterJobDefinition", "http":{ "method":"POST", "requestUri":"/v1/registerjobdefinition" }, "input":{"shape":"RegisterJobDefinitionRequest"}, "output":{"shape":"RegisterJobDefinitionResponse"}, "errors":[ {"shape":"ClientException"}, {"shape":"ServerException"} ], "documentation":"

Registers an AWS Batch job definition.

" }, "SubmitJob":{ "name":"SubmitJob", "http":{ "method":"POST", "requestUri":"/v1/submitjob" }, "input":{"shape":"SubmitJobRequest"}, "output":{"shape":"SubmitJobResponse"}, "errors":[ {"shape":"ClientException"}, {"shape":"ServerException"} ], "documentation":"

Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.

" }, "TerminateJob":{ "name":"TerminateJob", "http":{ "method":"POST", "requestUri":"/v1/terminatejob" }, "input":{"shape":"TerminateJobRequest"}, "output":{"shape":"TerminateJobResponse"}, "errors":[ {"shape":"ClientException"}, {"shape":"ServerException"} ], "documentation":"

Terminates jobs in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled.

" }, "UpdateComputeEnvironment":{ "name":"UpdateComputeEnvironment", "http":{ "method":"POST", "requestUri":"/v1/updatecomputeenvironment" }, "input":{"shape":"UpdateComputeEnvironmentRequest"}, "output":{"shape":"UpdateComputeEnvironmentResponse"}, "errors":[ {"shape":"ClientException"}, {"shape":"ServerException"} ], "documentation":"

Updates an AWS Batch compute environment.

" }, "UpdateJobQueue":{ "name":"UpdateJobQueue", "http":{ "method":"POST", "requestUri":"/v1/updatejobqueue" }, "input":{"shape":"UpdateJobQueueRequest"}, "output":{"shape":"UpdateJobQueueResponse"}, "errors":[ {"shape":"ClientException"}, {"shape":"ServerException"} ], "documentation":"

Updates a job queue.

" } }, "shapes":{ "Boolean":{"type":"boolean"}, "CEState":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "CEStatus":{ "type":"string", "enum":[ "CREATING", "UPDATING", "DELETING", "DELETED", "VALID", "INVALID" ] }, "CEType":{ "type":"string", "enum":[ "MANAGED", "UNMANAGED" ] }, "CRType":{ "type":"string", "enum":[ "EC2", "SPOT" ] }, "CancelJobRequest":{ "type":"structure", "required":[ "jobId", "reason" ], "members":{ "jobId":{ "shape":"String", "documentation":"

A list of up to 100 job IDs to cancel.

" }, "reason":{ "shape":"String", "documentation":"

A message to attach to the job that explains the reason for cancelling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

" } } }, "CancelJobResponse":{ "type":"structure", "members":{ } }, "ClientException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

", "error":{"httpStatusCode":400}, "exception":true }, "ComputeEnvironmentDetail":{ "type":"structure", "required":[ "computeEnvironmentName", "computeEnvironmentArn", "ecsClusterArn" ], "members":{ "computeEnvironmentName":{ "shape":"String", "documentation":"

The name of the compute environment.

" }, "computeEnvironmentArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the compute environment.

" }, "ecsClusterArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

" }, "type":{ "shape":"CEType", "documentation":"

The type of the compute environment.

" }, "state":{ "shape":"CEState", "documentation":"

The state of the compute environment. The valid values are ENABLED or DISABLED. An ENABLED state indicates that you can register instances with the compute environment and that the associated instances can accept jobs.

" }, "status":{ "shape":"CEStatus", "documentation":"

The current status of the compute environment (for example, CREATING or VALID).

" }, "statusReason":{ "shape":"String", "documentation":"

A short, human-readable string to provide additional details about the current status of the compute environment.

" }, "computeResources":{ "shape":"ComputeResource", "documentation":"

The compute resources defined for the compute environment.

" }, "serviceRole":{ "shape":"String", "documentation":"

The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.

" } }, "documentation":"

An object representing an AWS Batch compute environment.

" }, "ComputeEnvironmentDetailList":{ "type":"list", "member":{"shape":"ComputeEnvironmentDetail"} }, "ComputeEnvironmentOrder":{ "type":"structure", "required":[ "order", "computeEnvironment" ], "members":{ "order":{ "shape":"Integer", "documentation":"

The order of the compute environment.

" }, "computeEnvironment":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the compute environment.

" } }, "documentation":"

The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

" }, "ComputeEnvironmentOrders":{ "type":"list", "member":{"shape":"ComputeEnvironmentOrder"} }, "ComputeResource":{ "type":"structure", "required":[ "type", "minvCpus", "maxvCpus", "instanceTypes", "subnets", "securityGroupIds", "instanceRole" ], "members":{ "type":{ "shape":"CRType", "documentation":"

The type of compute environment.

" }, "minvCpus":{ "shape":"Integer", "documentation":"

The minimum number of EC2 vCPUs that an environment should maintain.

" }, "maxvCpus":{ "shape":"Integer", "documentation":"

The maximum number of EC2 vCPUs that an environment can reach.

" }, "desiredvCpus":{ "shape":"Integer", "documentation":"

The desired number of EC2 vCPUS in the compute environment.

" }, "instanceTypes":{ "shape":"StringList", "documentation":"

The instances types that may launched.

" }, "subnets":{ "shape":"StringList", "documentation":"

The VPC subnets into which the compute resources are launched.

" }, "securityGroupIds":{ "shape":"StringList", "documentation":"

The EC2 security group that is associated with instances launched in the compute environment.

" }, "ec2KeyPair":{ "shape":"String", "documentation":"

The EC2 key pair that is used for instances launched in the compute environment.

" }, "instanceRole":{ "shape":"String", "documentation":"

The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.

" }, "tags":{ "shape":"TagsMap", "documentation":"

Key-value pair tags to be applied to resources that are launched in the compute environment.

" }, "bidPercentage":{ "shape":"Integer", "documentation":"

The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.

" }, "spotIamFleetRole":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.

" } }, "documentation":"

An object representing an AWS Batch compute resource.

" }, "ComputeResourceUpdate":{ "type":"structure", "members":{ "minvCpus":{ "shape":"Integer", "documentation":"

The minimum number of EC2 vCPUs that an environment should maintain.

" }, "maxvCpus":{ "shape":"Integer", "documentation":"

The maximum number of EC2 vCPUs that an environment can reach.

" }, "desiredvCpus":{ "shape":"Integer", "documentation":"

The desired number of EC2 vCPUS in the compute environment.

" } }, "documentation":"

An object representing the attributes of a compute environment that can be updated.

" }, "ContainerDetail":{ "type":"structure", "members":{ "image":{ "shape":"String", "documentation":"

The image used to start the container.

" }, "vcpus":{ "shape":"Integer", "documentation":"

The number of VCPUs allocated for the job.

" }, "memory":{ "shape":"Integer", "documentation":"

The number of MiB of memory reserved for the job.

" }, "command":{ "shape":"StringList", "documentation":"

The command that is passed to the container.

" }, "jobRoleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) associated with the job upon execution.

" }, "volumes":{ "shape":"Volumes", "documentation":"

A list of volumes associated with the job.

" }, "environment":{ "shape":"EnvironmentVariables", "documentation":"

The environment variables to pass to a container.

" }, "mountPoints":{ "shape":"MountPoints", "documentation":"

The mount points for data volumes in your container.

" }, "readonlyRootFilesystem":{ "shape":"Boolean", "documentation":"

When this parameter is true, the container is given read-only access to its root file system.

" }, "ulimits":{ "shape":"Ulimits", "documentation":"

A list of ulimit values to set in the container.

" }, "privileged":{ "shape":"Boolean", "documentation":"

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).

" }, "user":{ "shape":"String", "documentation":"

The user name to use inside the container.

" }, "exitCode":{ "shape":"Integer", "documentation":"

The exit code to return upon completion.

" }, "reason":{ "shape":"String", "documentation":"

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

" }, "containerInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the container instance on which the container is running.

" } }, "documentation":"

An object representing the details of a container that is part of a job.

" }, "ContainerOverrides":{ "type":"structure", "members":{ "vcpus":{ "shape":"Integer", "documentation":"

The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.

" }, "memory":{ "shape":"Integer", "documentation":"

The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.

" }, "command":{ "shape":"StringList", "documentation":"

The command to send to the container that overrides the default command from the Docker image or the job definition.

" }, "environment":{ "shape":"EnvironmentVariables", "documentation":"

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.

" } }, "documentation":"

The overrides that should be sent to a container.

" }, "ContainerProperties":{ "type":"structure", "required":[ "image", "vcpus", "memory" ], "members":{ "image":{ "shape":"String", "documentation":"

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

  • Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).

  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

" }, "vcpus":{ "shape":"Integer", "documentation":"

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares.

" }, "memory":{ "shape":"Integer", "documentation":"

The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

" }, "command":{ "shape":"StringList", "documentation":"

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

" }, "jobRoleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.

" }, "volumes":{ "shape":"Volumes", "documentation":"

A list of data volumes used in a job.

" }, "environment":{ "shape":"EnvironmentVariables", "documentation":"

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We do not recommend using plain text environment variables for sensitive information, such as credential data.

" }, "mountPoints":{ "shape":"MountPoints", "documentation":"

The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

" }, "readonlyRootFilesystem":{ "shape":"Boolean", "documentation":"

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

" }, "privileged":{ "shape":"Boolean", "documentation":"

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.

" }, "ulimits":{ "shape":"Ulimits", "documentation":"

A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.

" }, "user":{ "shape":"String", "documentation":"

The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

" } }, "documentation":"

Container properties are used in job definitions to describe the container that is launched as part of a job.

" }, "CreateComputeEnvironmentRequest":{ "type":"structure", "required":[ "computeEnvironmentName", "type", "serviceRole" ], "members":{ "computeEnvironmentName":{ "shape":"String", "documentation":"

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.

" }, "type":{ "shape":"CEType", "documentation":"

The type of the compute environment.

" }, "state":{ "shape":"CEState", "documentation":"

The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

" }, "computeResources":{ "shape":"ComputeResource", "documentation":"

Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments.

" }, "serviceRole":{ "shape":"String", "documentation":"

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

" } } }, "CreateComputeEnvironmentResponse":{ "type":"structure", "members":{ "computeEnvironmentName":{ "shape":"String", "documentation":"

The name of the compute environment.

" }, "computeEnvironmentArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the compute environment.

" } } }, "CreateJobQueueRequest":{ "type":"structure", "required":[ "jobQueueName", "priority", "computeEnvironmentOrder" ], "members":{ "jobQueueName":{ "shape":"String", "documentation":"

The name of the job queue.

" }, "state":{ "shape":"JQState", "documentation":"

The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs.

" }, "priority":{ "shape":"Integer", "documentation":"

The priority of the job queue. Job queues with a higher priority (or a lower integer value for the priority parameter) are evaluated first when associated with same compute environment. Priority is determined in ascending order, for example, a job queue with a priority value of 1 is given scheduling preference over a job queue with a priority value of 10.

" }, "computeEnvironmentOrder":{ "shape":"ComputeEnvironmentOrders", "documentation":"

The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should execute a given job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to 3 compute environments with a job queue.

" } } }, "CreateJobQueueResponse":{ "type":"structure", "required":[ "jobQueueName", "jobQueueArn" ], "members":{ "jobQueueName":{ "shape":"String", "documentation":"

The name of the job queue.

" }, "jobQueueArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the job queue.

" } } }, "DeleteComputeEnvironmentRequest":{ "type":"structure", "required":["computeEnvironment"], "members":{ "computeEnvironment":{ "shape":"String", "documentation":"

The name or Amazon Resource Name (ARN) of the compute environment to delete.

" } } }, "DeleteComputeEnvironmentResponse":{ "type":"structure", "members":{ } }, "DeleteJobQueueRequest":{ "type":"structure", "required":["jobQueue"], "members":{ "jobQueue":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the queue to delete.

" } } }, "DeleteJobQueueResponse":{ "type":"structure", "members":{ } }, "DeregisterJobDefinitionRequest":{ "type":"structure", "required":["jobDefinition"], "members":{ "jobDefinition":{ "shape":"String", "documentation":"

The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to deregister.

" } } }, "DeregisterJobDefinitionResponse":{ "type":"structure", "members":{ } }, "DescribeComputeEnvironmentsRequest":{ "type":"structure", "members":{ "computeEnvironments":{ "shape":"StringList", "documentation":"

A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

" }, "maxResults":{ "shape":"Integer", "documentation":"

The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" } } }, "DescribeComputeEnvironmentsResponse":{ "type":"structure", "members":{ "computeEnvironments":{ "shape":"ComputeEnvironmentDetailList", "documentation":"

The list of compute environments.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value to include in a future DescribeComputeEnvironments request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "DescribeJobDefinitionsRequest":{ "type":"structure", "members":{ "jobDefinitions":{ "shape":"StringList", "documentation":"

A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.

" }, "maxResults":{ "shape":"Integer", "documentation":"

The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.

" }, "jobDefinitionName":{ "shape":"String", "documentation":"

The name of the job definition to describe.

" }, "status":{ "shape":"String", "documentation":"

The status with which to filter job definitions.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value returned from a previous paginated DescribeJobDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" } } }, "DescribeJobDefinitionsResponse":{ "type":"structure", "members":{ "jobDefinitions":{ "shape":"JobDefinitionList", "documentation":"

The list of job definitions.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value to include in a future DescribeJobDefinitions request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "DescribeJobQueuesRequest":{ "type":"structure", "members":{ "jobQueues":{ "shape":"StringList", "documentation":"

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

" }, "maxResults":{ "shape":"Integer", "documentation":"

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" } } }, "DescribeJobQueuesResponse":{ "type":"structure", "members":{ "jobQueues":{ "shape":"JobQueueDetailList", "documentation":"

The list of job queues.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value to include in a future DescribeJobQueues request. When the results of a DescribeJobQueues request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "DescribeJobsRequest":{ "type":"structure", "required":["jobs"], "members":{ "jobs":{ "shape":"StringList", "documentation":"

A space-separated list of up to 100 job IDs.

" } } }, "DescribeJobsResponse":{ "type":"structure", "members":{ "jobs":{ "shape":"JobDetailList", "documentation":"

The list of jobs.

" } } }, "EnvironmentVariables":{ "type":"list", "member":{"shape":"KeyValuePair"} }, "Host":{ "type":"structure", "members":{ "sourcePath":{ "shape":"String", "documentation":"

The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

" } }, "documentation":"

The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.

" }, "Integer":{"type":"integer"}, "JQState":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "JQStatus":{ "type":"string", "enum":[ "CREATING", "UPDATING", "DELETING", "DELETED", "VALID", "INVALID" ] }, "JobDefinition":{ "type":"structure", "required":[ "jobDefinitionName", "jobDefinitionArn", "revision", "type" ], "members":{ "jobDefinitionName":{ "shape":"String", "documentation":"

The name of the job definition.

" }, "jobDefinitionArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the job definition.

" }, "revision":{ "shape":"Integer", "documentation":"

The revision of the job definition.

" }, "status":{ "shape":"String", "documentation":"

The status of the job definition.

" }, "type":{ "shape":"String", "documentation":"

The type of job definition.

" }, "parameters":{ "shape":"ParametersMap", "documentation":"

Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

" }, "containerProperties":{ "shape":"ContainerProperties", "documentation":"

An object with various properties specific to container-based jobs.

" } }, "documentation":"

An object representing an AWS Batch job definition.

" }, "JobDefinitionList":{ "type":"list", "member":{"shape":"JobDefinition"} }, "JobDefinitionType":{ "type":"string", "enum":["container"] }, "JobDependency":{ "type":"structure", "members":{ "jobId":{ "shape":"String", "documentation":"

The job ID of the AWS Batch job associated with this dependency.

" } }, "documentation":"

An object representing an AWS Batch job dependency.

" }, "JobDependencyList":{ "type":"list", "member":{"shape":"JobDependency"} }, "JobDetail":{ "type":"structure", "required":[ "jobName", "jobId", "jobQueue", "status", "startedAt", "jobDefinition" ], "members":{ "jobName":{ "shape":"String", "documentation":"

The name of the job.

" }, "jobId":{ "shape":"String", "documentation":"

The ID for the job.

" }, "jobQueue":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the job queue with which the job is associated.

" }, "status":{ "shape":"JobStatus", "documentation":"

The current status for the job.

" }, "statusReason":{ "shape":"String", "documentation":"

A short, human-readable string to provide additional details about the current status of the job.

" }, "createdAt":{ "shape":"Long", "documentation":"

The Unix timestamp for when the job was created (when the task entered the PENDING state).

" }, "startedAt":{ "shape":"Long", "documentation":"

The Unix timestamp for when the job was started (when the task transitioned from the PENDING state to the RUNNING state).

" }, "stoppedAt":{ "shape":"Long", "documentation":"

The Unix timestamp for when the job was stopped (when the task transitioned from the RUNNING state to the STOPPED state).

" }, "dependsOn":{ "shape":"JobDependencyList", "documentation":"

A list of job names or IDs on which this job depends.

" }, "jobDefinition":{ "shape":"String", "documentation":"

The job definition that is used by this job.

" }, "parameters":{ "shape":"ParametersMap", "documentation":"

Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

" }, "container":{ "shape":"ContainerDetail", "documentation":"

An object representing the details of the container that is associated with the job.

" } }, "documentation":"

An object representing an AWS Batch job.

" }, "JobDetailList":{ "type":"list", "member":{"shape":"JobDetail"} }, "JobQueueDetail":{ "type":"structure", "required":[ "jobQueueName", "jobQueueArn", "state", "priority", "computeEnvironmentOrder" ], "members":{ "jobQueueName":{ "shape":"String", "documentation":"

The name of the job queue.

" }, "jobQueueArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the job queue.

" }, "state":{ "shape":"JQState", "documentation":"

Describes the ability of the queue to accept new jobs.

" }, "status":{ "shape":"JQStatus", "documentation":"

The status of the job queue (for example, CREATING or VALID).

" }, "statusReason":{ "shape":"String", "documentation":"

A short, human-readable string to provide additional details about the current status of the job queue.

" }, "priority":{ "shape":"Integer", "documentation":"

The priority of the job queue.

" }, "computeEnvironmentOrder":{ "shape":"ComputeEnvironmentOrders", "documentation":"

The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.

" } }, "documentation":"

An object representing the details of an AWS Batch job queue.

" }, "JobQueueDetailList":{ "type":"list", "member":{"shape":"JobQueueDetail"} }, "JobStatus":{ "type":"string", "enum":[ "SUBMITTED", "PENDING", "RUNNABLE", "STARTING", "RUNNING", "SUCCEEDED", "FAILED" ] }, "JobSummary":{ "type":"structure", "required":[ "jobId", "jobName" ], "members":{ "jobId":{ "shape":"String", "documentation":"

The ID of the job.

" }, "jobName":{ "shape":"String", "documentation":"

The name of the job.

" } }, "documentation":"

An object representing summary details of a job.

" }, "JobSummaryList":{ "type":"list", "member":{"shape":"JobSummary"} }, "KeyValuePair":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the key value pair. For environment variables, this is the name of the environment variable.

" }, "value":{ "shape":"String", "documentation":"

The value of the key value pair. For environment variables, this is the value of the environment variable.

" } }, "documentation":"

A key-value pair object.

" }, "ListJobsRequest":{ "type":"structure", "required":["jobQueue"], "members":{ "jobQueue":{ "shape":"String", "documentation":"

The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.

" }, "jobStatus":{ "shape":"JobStatus", "documentation":"

The job status with which to filter jobs in the specified queue.

" }, "maxResults":{ "shape":"Integer", "documentation":"

The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListJobs returns up to 100 results and a nextToken value if applicable.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" } } }, "ListJobsResponse":{ "type":"structure", "required":["jobSummaryList"], "members":{ "jobSummaryList":{ "shape":"JobSummaryList", "documentation":"

A list of job summaries that match the request.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value to include in a future ListJobs request. When the results of a ListJobs request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "Long":{"type":"long"}, "MountPoint":{ "type":"structure", "members":{ "containerPath":{ "shape":"String", "documentation":"

The path on the container at which to mount the host volume.

" }, "readOnly":{ "shape":"Boolean", "documentation":"

If this value is true, the container has read-only access to the volume; otherwise, the container can write to the volume. The default value is false.

" }, "sourceVolume":{ "shape":"String", "documentation":"

The name of the volume to mount.

" } }, "documentation":"

Details on a volume mount point that is used in a job's container properties.

" }, "MountPoints":{ "type":"list", "member":{"shape":"MountPoint"} }, "ParametersMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "RegisterJobDefinitionRequest":{ "type":"structure", "required":[ "jobDefinitionName", "type" ], "members":{ "jobDefinitionName":{ "shape":"String", "documentation":"

The name of the job definition to register.

" }, "type":{ "shape":"JobDefinitionType", "documentation":"

The type of job definition.

" }, "parameters":{ "shape":"ParametersMap", "documentation":"

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

" }, "containerProperties":{ "shape":"ContainerProperties", "documentation":"

An object with various properties specific for container-based jobs. This parameter is required if the type parameter is container.

" } } }, "RegisterJobDefinitionResponse":{ "type":"structure", "required":[ "jobDefinitionName", "jobDefinitionArn", "revision" ], "members":{ "jobDefinitionName":{ "shape":"String", "documentation":"

The name of the job definition.

" }, "jobDefinitionArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the job definition.

" }, "revision":{ "shape":"Integer", "documentation":"

The revision of the job definition.

" } } }, "ServerException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

These errors are usually caused by a server issue.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"String"} }, "SubmitJobRequest":{ "type":"structure", "required":[ "jobName", "jobQueue", "jobDefinition" ], "members":{ "jobName":{ "shape":"String", "documentation":"

The name of the job.

" }, "jobQueue":{ "shape":"String", "documentation":"

The job queue into which the job will be submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

" }, "dependsOn":{ "shape":"JobDependencyList", "documentation":"

A list of job names or IDs on which this job depends. A job can depend upon a maximum of 100 jobs.

" }, "jobDefinition":{ "shape":"String", "documentation":"

The job definition used by this job. This value can be either a name:revision or the Amazon Resource Name (ARN) for the job definition.

" }, "parameters":{ "shape":"ParametersMap", "documentation":"

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

" }, "containerOverrides":{ "shape":"ContainerOverrides", "documentation":"

A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.

" } } }, "SubmitJobResponse":{ "type":"structure", "required":[ "jobName", "jobId" ], "members":{ "jobName":{ "shape":"String", "documentation":"

The name of the job.

" }, "jobId":{ "shape":"String", "documentation":"

The unique identifier for the job.

" } } }, "TagsMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "TerminateJobRequest":{ "type":"structure", "required":[ "jobId", "reason" ], "members":{ "jobId":{ "shape":"String", "documentation":"

Job IDs to be terminated. Up to 100 jobs can be specified.

" }, "reason":{ "shape":"String", "documentation":"

A message to attach to the job that explains the reason for cancelling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

" } } }, "TerminateJobResponse":{ "type":"structure", "members":{ } }, "Ulimit":{ "type":"structure", "required":[ "hardLimit", "name", "softLimit" ], "members":{ "hardLimit":{ "shape":"Integer", "documentation":"

The hard limit for the ulimit type.

" }, "name":{ "shape":"String", "documentation":"

The type of the ulimit.

" }, "softLimit":{ "shape":"Integer", "documentation":"

The soft limit for the ulimit type.

" } }, "documentation":"

The ulimit settings to pass to the container.

" }, "Ulimits":{ "type":"list", "member":{"shape":"Ulimit"} }, "UpdateComputeEnvironmentRequest":{ "type":"structure", "required":["computeEnvironment"], "members":{ "computeEnvironment":{ "shape":"String", "documentation":"

The name or full Amazon Resource Name (ARN) of the compute environment to update.

" }, "state":{ "shape":"CEState", "documentation":"

The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.

" }, "computeResources":{ "shape":"ComputeResourceUpdate", "documentation":"

Details of the compute resources managed by the compute environment. Required for a managed compute environment.

" }, "serviceRole":{ "shape":"String", "documentation":"

The name or full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to ECS, Auto Scaling, and EC2 on your behalf.

" } } }, "UpdateComputeEnvironmentResponse":{ "type":"structure", "members":{ "computeEnvironmentName":{ "shape":"String", "documentation":"

The name of compute environment.

" }, "computeEnvironmentArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the compute environment.

" } } }, "UpdateJobQueueRequest":{ "type":"structure", "required":["jobQueue"], "members":{ "jobQueue":{ "shape":"String", "documentation":"

The name or the Amazon Resource Name (ARN) of the job queue.

" }, "state":{ "shape":"JQState", "documentation":"

Describes the queue's ability to accept new jobs.

" }, "priority":{ "shape":"Integer", "documentation":"

The priority of the job queue. Job queues with a higher priority (or a lower integer value for the priority parameter) are evaluated first when associated with same compute environment. Priority is determined in ascending order, for example, a job queue with a priority value of 1 is given scheduling preference over a job queue with a priority value of 10.

" }, "computeEnvironmentOrder":{ "shape":"ComputeEnvironmentOrders", "documentation":"

Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should execute a given job.

" } } }, "UpdateJobQueueResponse":{ "type":"structure", "members":{ "jobQueueName":{ "shape":"String", "documentation":"

The name of the job queue.

" }, "jobQueueArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the job queue.

" } } }, "Volume":{ "type":"structure", "members":{ "host":{ "shape":"Host", "documentation":"

The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.

" }, "name":{ "shape":"String", "documentation":"

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

" } }, "documentation":"

A data volume used in a job's container properties.

" }, "Volumes":{ "type":"list", "member":{"shape":"Volume"} } }, "documentation":"

AWS Batch enables you to run batch computing workloads on the AWS Cloud. Batch computing is a common way for developers, scientists, and engineers to access large amounts of compute resources, and AWS Batch removes the undifferentiated heavy lifting of configuring and managing the required infrastructure. AWS Batch will be familiar to users of traditional batch computing software. This service can efficiently provision resources in response to jobs submitted in order to eliminate capacity constraints, reduce compute costs, and deliver results quickly.

As a fully managed service, AWS Batch enables developers, scientists, and engineers to run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes the workload distribution based on the quantity and scale of the workloads. With AWS Batch, there is no need to install or manage batch computing software, which allows you to focus on analyzing results and solving problems. AWS Batch reduces operational complexities, saves time, and reduces costs, which makes it easy for developers, scientists, and engineers to run their batch jobs in the AWS Cloud.

" } botocore-1.5.7/botocore/data/autoscaling/0000777454262600001440000000000013042511307021444 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/autoscaling/2011-01-01/0000777454262600001440000000000013042511307022463 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/autoscaling/2011-01-01/paginators-1.json0000666454262600001440000000272413042511306025667 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeAutoScalingGroups": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxRecords", "result_key": "AutoScalingGroups" }, "DescribeAutoScalingInstances": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxRecords", "result_key": "AutoScalingInstances" }, "DescribeLaunchConfigurations": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxRecords", "result_key": "LaunchConfigurations" }, "DescribeNotificationConfigurations": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxRecords", "result_key": "NotificationConfigurations" }, "DescribePolicies": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxRecords", "result_key": "ScalingPolicies" }, "DescribeScalingActivities": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxRecords", "result_key": "Activities" }, "DescribeScheduledActions": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxRecords", "result_key": "ScheduledUpdateGroupActions" }, "DescribeTags": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxRecords", "result_key": "Tags" } } } botocore-1.5.7/botocore/data/autoscaling/2011-01-01/service-2.json0000666454262600001440000050104613042511306025162 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2011-01-01", "endpointPrefix":"autoscaling", "protocol":"query", "serviceFullName":"Auto Scaling", "signatureVersion":"v4", "uid":"autoscaling-2011-01-01", "xmlNamespace":"http://autoscaling.amazonaws.com/doc/2011-01-01/" }, "operations":{ "AttachInstances":{ "name":"AttachInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachInstancesQuery"}, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Attaches one or more EC2 instances to the specified Auto Scaling group.

When you attach instances, Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.

If there is a Classic load balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.

For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Auto Scaling User Guide.

" }, "AttachLoadBalancerTargetGroups":{ "name":"AttachLoadBalancerTargetGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachLoadBalancerTargetGroupsType"}, "output":{ "shape":"AttachLoadBalancerTargetGroupsResultType", "resultWrapper":"AttachLoadBalancerTargetGroupsResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Attaches one or more target groups to the specified Auto Scaling group.

To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups.

For more information, see Attach a Load Balancer to Your Auto Scaling Group in the Auto Scaling User Guide.

" }, "AttachLoadBalancers":{ "name":"AttachLoadBalancers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachLoadBalancersType"}, "output":{ "shape":"AttachLoadBalancersResultType", "resultWrapper":"AttachLoadBalancersResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Attaches one or more Classic load balancers to the specified Auto Scaling group.

To attach an Application load balancer instead, see AttachLoadBalancerTargetGroups.

To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers.

For more information, see Attach a Load Balancer to Your Auto Scaling Group in the Auto Scaling User Guide.

" }, "CompleteLifecycleAction":{ "name":"CompleteLifecycleAction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CompleteLifecycleActionType"}, "output":{ "shape":"CompleteLifecycleActionAnswer", "resultWrapper":"CompleteLifecycleActionResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Completes the lifecycle action for the specified token or instance with the specified result.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Auto Scaling Lifecycle in the Auto Scaling User Guide.

" }, "CreateAutoScalingGroup":{ "name":"CreateAutoScalingGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAutoScalingGroupType"}, "errors":[ {"shape":"AlreadyExistsFault"}, {"shape":"LimitExceededFault"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Creates an Auto Scaling group with the specified name and attributes.

If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see DescribeAccountLimits.

For more information, see Auto Scaling Groups in the Auto Scaling User Guide.

" }, "CreateLaunchConfiguration":{ "name":"CreateLaunchConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateLaunchConfigurationType"}, "errors":[ {"shape":"AlreadyExistsFault"}, {"shape":"LimitExceededFault"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Creates a launch configuration.

If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating this limit, see DescribeAccountLimits.

For more information, see Launch Configurations in the Auto Scaling User Guide.

" }, "CreateOrUpdateTags":{ "name":"CreateOrUpdateTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateOrUpdateTagsType"}, "errors":[ {"shape":"LimitExceededFault"}, {"shape":"AlreadyExistsFault"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Creates or updates tags for the specified Auto Scaling group.

When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.

For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling User Guide.

" }, "DeleteAutoScalingGroup":{ "name":"DeleteAutoScalingGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAutoScalingGroupType"}, "errors":[ {"shape":"ScalingActivityInProgressFault"}, {"shape":"ResourceInUseFault"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Deletes the specified Auto Scaling group.

If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed.

If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.

To remove instances from the Auto Scaling group before deleting it, call DetachInstances with the list of instances and the option to decrement the desired capacity so that Auto Scaling does not launch replacement instances.

To terminate all instances before deleting the Auto Scaling group, call UpdateAutoScalingGroup and set the minimum size and desired capacity of the Auto Scaling group to zero.

" }, "DeleteLaunchConfiguration":{ "name":"DeleteLaunchConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"LaunchConfigurationNameType"}, "errors":[ {"shape":"ResourceInUseFault"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Deletes the specified launch configuration.

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

" }, "DeleteLifecycleHook":{ "name":"DeleteLifecycleHook", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteLifecycleHookType"}, "output":{ "shape":"DeleteLifecycleHookAnswer", "resultWrapper":"DeleteLifecycleHookResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Deletes the specified lifecycle hook.

If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).

" }, "DeleteNotificationConfiguration":{ "name":"DeleteNotificationConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteNotificationConfigurationType"}, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Deletes the specified notification.

" }, "DeletePolicy":{ "name":"DeletePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePolicyType"}, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Deletes the specified Auto Scaling policy.

Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.

" }, "DeleteScheduledAction":{ "name":"DeleteScheduledAction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteScheduledActionType"}, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Deletes the specified scheduled action.

" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsType"}, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Deletes the specified tags.

" }, "DescribeAccountLimits":{ "name":"DescribeAccountLimits", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"DescribeAccountLimitsAnswer", "resultWrapper":"DescribeAccountLimitsResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Describes the current Auto Scaling resource limits for your AWS account.

For information about requesting an increase in these limits, see AWS Service Limits in the Amazon Web Services General Reference.

" }, "DescribeAdjustmentTypes":{ "name":"DescribeAdjustmentTypes", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"DescribeAdjustmentTypesAnswer", "resultWrapper":"DescribeAdjustmentTypesResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Describes the policy adjustment types for use with PutScalingPolicy.

" }, "DescribeAutoScalingGroups":{ "name":"DescribeAutoScalingGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AutoScalingGroupNamesType"}, "output":{ "shape":"AutoScalingGroupsType", "resultWrapper":"DescribeAutoScalingGroupsResult" }, "errors":[ {"shape":"InvalidNextToken"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Describes one or more Auto Scaling groups.

" }, "DescribeAutoScalingInstances":{ "name":"DescribeAutoScalingInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAutoScalingInstancesType"}, "output":{ "shape":"AutoScalingInstancesType", "resultWrapper":"DescribeAutoScalingInstancesResult" }, "errors":[ {"shape":"InvalidNextToken"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Describes one or more Auto Scaling instances.

" }, "DescribeAutoScalingNotificationTypes":{ "name":"DescribeAutoScalingNotificationTypes", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"DescribeAutoScalingNotificationTypesAnswer", "resultWrapper":"DescribeAutoScalingNotificationTypesResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Describes the notification types that are supported by Auto Scaling.

" }, "DescribeLaunchConfigurations":{ "name":"DescribeLaunchConfigurations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"LaunchConfigurationNamesType"}, "output":{ "shape":"LaunchConfigurationsType", "resultWrapper":"DescribeLaunchConfigurationsResult" }, "errors":[ {"shape":"InvalidNextToken"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Describes one or more launch configurations.

" }, "DescribeLifecycleHookTypes":{ "name":"DescribeLifecycleHookTypes", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"DescribeLifecycleHookTypesAnswer", "resultWrapper":"DescribeLifecycleHookTypesResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Describes the available types of lifecycle hooks.

" }, "DescribeLifecycleHooks":{ "name":"DescribeLifecycleHooks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLifecycleHooksType"}, "output":{ "shape":"DescribeLifecycleHooksAnswer", "resultWrapper":"DescribeLifecycleHooksResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Describes the lifecycle hooks for the specified Auto Scaling group.

" }, "DescribeLoadBalancerTargetGroups":{ "name":"DescribeLoadBalancerTargetGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLoadBalancerTargetGroupsRequest"}, "output":{ "shape":"DescribeLoadBalancerTargetGroupsResponse", "resultWrapper":"DescribeLoadBalancerTargetGroupsResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Describes the target groups for the specified Auto Scaling group.

" }, "DescribeLoadBalancers":{ "name":"DescribeLoadBalancers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLoadBalancersRequest"}, "output":{ "shape":"DescribeLoadBalancersResponse", "resultWrapper":"DescribeLoadBalancersResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Describes the load balancers for the specified Auto Scaling group.

Note that this operation describes only Classic load balancers. If you have Application load balancers, use DescribeLoadBalancerTargetGroups instead.

" }, "DescribeMetricCollectionTypes":{ "name":"DescribeMetricCollectionTypes", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"DescribeMetricCollectionTypesAnswer", "resultWrapper":"DescribeMetricCollectionTypesResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Describes the available CloudWatch metrics for Auto Scaling.

Note that the GroupStandbyInstances metric is not returned by default. You must explicitly request this metric when calling EnableMetricsCollection.

" }, "DescribeNotificationConfigurations":{ "name":"DescribeNotificationConfigurations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNotificationConfigurationsType"}, "output":{ "shape":"DescribeNotificationConfigurationsAnswer", "resultWrapper":"DescribeNotificationConfigurationsResult" }, "errors":[ {"shape":"InvalidNextToken"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Describes the notification actions associated with the specified Auto Scaling group.

" }, "DescribePolicies":{ "name":"DescribePolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePoliciesType"}, "output":{ "shape":"PoliciesType", "resultWrapper":"DescribePoliciesResult" }, "errors":[ {"shape":"InvalidNextToken"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Describes the policies for the specified Auto Scaling group.

" }, "DescribeScalingActivities":{ "name":"DescribeScalingActivities", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeScalingActivitiesType"}, "output":{ "shape":"ActivitiesType", "resultWrapper":"DescribeScalingActivitiesResult" }, "errors":[ {"shape":"InvalidNextToken"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Describes one or more scaling activities for the specified Auto Scaling group.

" }, "DescribeScalingProcessTypes":{ "name":"DescribeScalingProcessTypes", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"ProcessesType", "resultWrapper":"DescribeScalingProcessTypesResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.

" }, "DescribeScheduledActions":{ "name":"DescribeScheduledActions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeScheduledActionsType"}, "output":{ "shape":"ScheduledActionsType", "resultWrapper":"DescribeScheduledActionsResult" }, "errors":[ {"shape":"InvalidNextToken"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsType"}, "output":{ "shape":"TagsType", "resultWrapper":"DescribeTagsResult" }, "errors":[ {"shape":"InvalidNextToken"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Describes the specified tags.

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

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

" }, "DescribeTerminationPolicyTypes":{ "name":"DescribeTerminationPolicyTypes", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"DescribeTerminationPolicyTypesAnswer", "resultWrapper":"DescribeTerminationPolicyTypesResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Describes the termination policies supported by Auto Scaling.

" }, "DetachInstances":{ "name":"DetachInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachInstancesQuery"}, "output":{ "shape":"DetachInstancesAnswer", "resultWrapper":"DetachInstancesResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Removes one or more instances from the specified Auto Scaling group.

After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.

If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached.

If there is a Classic load balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.

For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Auto Scaling User Guide.

" }, "DetachLoadBalancerTargetGroups":{ "name":"DetachLoadBalancerTargetGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachLoadBalancerTargetGroupsType"}, "output":{ "shape":"DetachLoadBalancerTargetGroupsResultType", "resultWrapper":"DetachLoadBalancerTargetGroupsResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Detaches one or more target groups from the specified Auto Scaling group.

" }, "DetachLoadBalancers":{ "name":"DetachLoadBalancers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachLoadBalancersType"}, "output":{ "shape":"DetachLoadBalancersResultType", "resultWrapper":"DetachLoadBalancersResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Detaches one or more Classic load balancers from the specified Auto Scaling group.

Note that this operation detaches only Classic load balancers. If you have Application load balancers, use DetachLoadBalancerTargetGroups instead.

When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using DescribeLoadBalancers. Note that the instances remain running.

" }, "DisableMetricsCollection":{ "name":"DisableMetricsCollection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableMetricsCollectionQuery"}, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Disables group metrics for the specified Auto Scaling group.

" }, "EnableMetricsCollection":{ "name":"EnableMetricsCollection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableMetricsCollectionQuery"}, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Auto Scaling User Guide.

" }, "EnterStandby":{ "name":"EnterStandby", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnterStandbyQuery"}, "output":{ "shape":"EnterStandbyAnswer", "resultWrapper":"EnterStandbyResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Moves the specified instances into Standby mode.

For more information, see Auto Scaling Lifecycle in the Auto Scaling User Guide.

" }, "ExecutePolicy":{ "name":"ExecutePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ExecutePolicyType"}, "errors":[ {"shape":"ScalingActivityInProgressFault"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Executes the specified policy.

" }, "ExitStandby":{ "name":"ExitStandby", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ExitStandbyQuery"}, "output":{ "shape":"ExitStandbyAnswer", "resultWrapper":"ExitStandbyResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Moves the specified instances out of Standby mode.

For more information, see Auto Scaling Lifecycle in the Auto Scaling User Guide.

" }, "PutLifecycleHook":{ "name":"PutLifecycleHook", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutLifecycleHookType"}, "output":{ "shape":"PutLifecycleHookAnswer", "resultWrapper":"PutLifecycleHookResult" }, "errors":[ {"shape":"LimitExceededFault"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Creates or updates a lifecycle hook for the specified Auto Scaling Group.

A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Auto Scaling Lifecycle Hooks in the Auto Scaling User Guide.

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.

" }, "PutNotificationConfiguration":{ "name":"PutNotificationConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutNotificationConfigurationType"}, "errors":[ {"shape":"LimitExceededFault"}, {"shape":"ResourceContentionFault"} ], "documentation":"

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

This configuration overwrites any existing configuration.

For more information see Getting SNS Notifications When Your Auto Scaling Group Scales in the Auto Scaling User Guide.

" }, "PutScalingPolicy":{ "name":"PutScalingPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutScalingPolicyType"}, "output":{ "shape":"PolicyARNType", "resultWrapper":"PutScalingPolicyResult" }, "errors":[ {"shape":"LimitExceededFault"}, {"shape":"ResourceContentionFault"} ], "documentation":"

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

If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.

" }, "PutScheduledUpdateGroupAction":{ "name":"PutScheduledUpdateGroupAction", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutScheduledUpdateGroupActionType"}, "errors":[ {"shape":"AlreadyExistsFault"}, {"shape":"LimitExceededFault"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged.

For more information, see Scheduled Scaling in the Auto Scaling User Guide.

" }, "RecordLifecycleActionHeartbeat":{ "name":"RecordLifecycleActionHeartbeat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RecordLifecycleActionHeartbeatType"}, "output":{ "shape":"RecordLifecycleActionHeartbeatAnswer", "resultWrapper":"RecordLifecycleActionHeartbeatResult" }, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using PutLifecycleHook.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Auto Scaling Lifecycle in the Auto Scaling User Guide.

" }, "ResumeProcesses":{ "name":"ResumeProcesses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ScalingProcessQuery"}, "errors":[ {"shape":"ResourceInUseFault"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Resumes the specified suspended Auto Scaling processes, or all suspended process, for the specified Auto Scaling group.

For more information, see Suspending and Resuming Auto Scaling Processes in the Auto Scaling User Guide.

" }, "SetDesiredCapacity":{ "name":"SetDesiredCapacity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetDesiredCapacityType"}, "errors":[ {"shape":"ScalingActivityInProgressFault"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Sets the size of the specified Auto Scaling group.

For more information about desired capacity, see What Is Auto Scaling? in the Auto Scaling User Guide.

" }, "SetInstanceHealth":{ "name":"SetInstanceHealth", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetInstanceHealthQuery"}, "errors":[ {"shape":"ResourceContentionFault"} ], "documentation":"

Sets the health status of the specified instance.

For more information, see Health Checks in the Auto Scaling User Guide.

" }, "SetInstanceProtection":{ "name":"SetInstanceProtection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetInstanceProtectionQuery"}, "output":{ "shape":"SetInstanceProtectionAnswer", "resultWrapper":"SetInstanceProtectionResult" }, "errors":[ {"shape":"LimitExceededFault"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Updates the instance protection settings of the specified instances.

For more information, see Instance Protection in the Auto Scaling User Guide.

" }, "SuspendProcesses":{ "name":"SuspendProcesses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ScalingProcessQuery"}, "errors":[ {"shape":"ResourceInUseFault"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Suspends the specified Auto Scaling processes, or all processes, for the specified Auto Scaling group.

Note that if you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly.

To resume processes that have been suspended, use ResumeProcesses.

For more information, see Suspending and Resuming Auto Scaling Processes in the Auto Scaling User Guide.

" }, "TerminateInstanceInAutoScalingGroup":{ "name":"TerminateInstanceInAutoScalingGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateInstanceInAutoScalingGroupType"}, "output":{ "shape":"ActivityType", "resultWrapper":"TerminateInstanceInAutoScalingGroupResult" }, "errors":[ {"shape":"ScalingActivityInProgressFault"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Terminates the specified instance and optionally adjusts the desired group size.

This call simply makes a termination request. The instance is not terminated immediately.

" }, "UpdateAutoScalingGroup":{ "name":"UpdateAutoScalingGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAutoScalingGroupType"}, "errors":[ {"shape":"ScalingActivityInProgressFault"}, {"shape":"ResourceContentionFault"} ], "documentation":"

Updates the configuration for the specified Auto Scaling group.

To update an Auto Scaling group with a launch configuration with InstanceMonitoring set to False, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection.

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

Note the following:

  • If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MinSize.

  • If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, we implicitly call SetDesiredCapacity to set the size of the group to the new value of MaxSize.

  • All other optional parameters are left unchanged if not specified.

" } }, "shapes":{ "Activities":{ "type":"list", "member":{"shape":"Activity"} }, "ActivitiesType":{ "type":"structure", "required":["Activities"], "members":{ "Activities":{ "shape":"Activities", "documentation":"

The scaling activities. Activities are sorted by start time. Activities still in progress are described first.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } }, "documentation":"

Contains the output of DescribeScalingActivities.

" }, "Activity":{ "type":"structure", "required":[ "ActivityId", "AutoScalingGroupName", "Cause", "StartTime", "StatusCode" ], "members":{ "ActivityId":{ "shape":"XmlString", "documentation":"

The ID of the activity.

" }, "AutoScalingGroupName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the Auto Scaling group.

" }, "Description":{ "shape":"XmlString", "documentation":"

A friendly, more verbose description of the activity.

" }, "Cause":{ "shape":"XmlStringMaxLen1023", "documentation":"

The reason the activity began.

" }, "StartTime":{ "shape":"TimestampType", "documentation":"

The start time of the activity.

" }, "EndTime":{ "shape":"TimestampType", "documentation":"

The end time of the activity.

" }, "StatusCode":{ "shape":"ScalingActivityStatusCode", "documentation":"

The current status of the activity.

" }, "StatusMessage":{ "shape":"XmlStringMaxLen255", "documentation":"

A friendly, more verbose description of the activity status.

" }, "Progress":{ "shape":"Progress", "documentation":"

A value between 0 and 100 that indicates the progress of the activity.

" }, "Details":{ "shape":"XmlString", "documentation":"

The details about the activity.

" } }, "documentation":"

Describes scaling activity, which is a long-running process that represents a change to your Auto Scaling group, such as changing its size or replacing an instance.

" }, "ActivityIds":{ "type":"list", "member":{"shape":"XmlString"} }, "ActivityType":{ "type":"structure", "members":{ "Activity":{ "shape":"Activity", "documentation":"

A scaling activity.

" } }, "documentation":"

Contains the output of TerminateInstancesInAutoScalingGroup.

" }, "AdjustmentType":{ "type":"structure", "members":{ "AdjustmentType":{ "shape":"XmlStringMaxLen255", "documentation":"

The policy adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

" } }, "documentation":"

Describes a policy adjustment type.

For more information, see Dynamic Scaling in the Auto Scaling User Guide.

" }, "AdjustmentTypes":{ "type":"list", "member":{"shape":"AdjustmentType"} }, "Alarm":{ "type":"structure", "members":{ "AlarmName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the alarm.

" }, "AlarmARN":{ "shape":"ResourceName", "documentation":"

The Amazon Resource Name (ARN) of the alarm.

" } }, "documentation":"

Describes an alarm.

" }, "Alarms":{ "type":"list", "member":{"shape":"Alarm"} }, "AlreadyExistsFault":{ "type":"structure", "members":{ "message":{ "shape":"XmlStringMaxLen255", "documentation":"

" } }, "documentation":"

You already have an Auto Scaling group or launch configuration with this name.

", "error":{ "code":"AlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "AsciiStringMaxLen255":{ "type":"string", "max":255, "min":1, "pattern":"[A-Za-z0-9\\-_\\/]+" }, "AssociatePublicIpAddress":{"type":"boolean"}, "AttachInstancesQuery":{ "type":"structure", "required":["AutoScalingGroupName"], "members":{ "InstanceIds":{ "shape":"InstanceIds", "documentation":"

One or more instance IDs.

" }, "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the group.

" } }, "documentation":"

Contains the parameters for AttachInstances.

" }, "AttachLoadBalancerTargetGroupsResultType":{ "type":"structure", "members":{ } }, "AttachLoadBalancerTargetGroupsType":{ "type":"structure", "required":[ "AutoScalingGroupName", "TargetGroupARNs" ], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the Auto Scaling group.

" }, "TargetGroupARNs":{ "shape":"TargetGroupARNs", "documentation":"

The Amazon Resource Names (ARN) of the target groups.

" } }, "documentation":"

Contains the parameters for AttachLoadBalancerTargetGroups.

" }, "AttachLoadBalancersResultType":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of AttachLoadBalancers.

" }, "AttachLoadBalancersType":{ "type":"structure", "required":[ "AutoScalingGroupName", "LoadBalancerNames" ], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the group.

" }, "LoadBalancerNames":{ "shape":"LoadBalancerNames", "documentation":"

One or more load balancer names.

" } }, "documentation":"

Contains the parameters for AttachLoadBalancers.

" }, "AutoScalingGroup":{ "type":"structure", "required":[ "AutoScalingGroupName", "MinSize", "MaxSize", "DesiredCapacity", "DefaultCooldown", "AvailabilityZones", "HealthCheckType", "CreatedTime" ], "members":{ "AutoScalingGroupName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the group.

" }, "AutoScalingGroupARN":{ "shape":"ResourceName", "documentation":"

The Amazon Resource Name (ARN) of the group.

" }, "LaunchConfigurationName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the associated launch configuration.

" }, "MinSize":{ "shape":"AutoScalingGroupMinSize", "documentation":"

The minimum size of the group.

" }, "MaxSize":{ "shape":"AutoScalingGroupMaxSize", "documentation":"

The maximum size of the group.

" }, "DesiredCapacity":{ "shape":"AutoScalingGroupDesiredCapacity", "documentation":"

The desired size of the group.

" }, "DefaultCooldown":{ "shape":"Cooldown", "documentation":"

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.

" }, "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

One or more Availability Zones for the group.

" }, "LoadBalancerNames":{ "shape":"LoadBalancerNames", "documentation":"

One or more load balancers associated with the group.

" }, "TargetGroupARNs":{ "shape":"TargetGroupARNs", "documentation":"

The Amazon Resource Names (ARN) of the target groups for your load balancer.

" }, "HealthCheckType":{ "shape":"XmlStringMaxLen32", "documentation":"

The service to use for the health checks. The valid values are EC2 and ELB.

" }, "HealthCheckGracePeriod":{ "shape":"HealthCheckGracePeriod", "documentation":"

The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service.

" }, "Instances":{ "shape":"Instances", "documentation":"

The EC2 instances associated with the group.

" }, "CreatedTime":{ "shape":"TimestampType", "documentation":"

The date and time the group was created.

" }, "SuspendedProcesses":{ "shape":"SuspendedProcesses", "documentation":"

The suspended processes associated with the group.

" }, "PlacementGroup":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

" }, "VPCZoneIdentifier":{ "shape":"XmlStringMaxLen2047", "documentation":"

One or more subnet IDs, if applicable, separated by commas.

If you specify VPCZoneIdentifier and AvailabilityZones, ensure that the Availability Zones of the subnets match the values for AvailabilityZones.

" }, "EnabledMetrics":{ "shape":"EnabledMetrics", "documentation":"

The metrics enabled for the group.

" }, "Status":{ "shape":"XmlStringMaxLen255", "documentation":"

The current state of the group when DeleteAutoScalingGroup is in progress.

" }, "Tags":{ "shape":"TagDescriptionList", "documentation":"

The tags for the group.

" }, "TerminationPolicies":{ "shape":"TerminationPolicies", "documentation":"

The termination policies for the group.

" }, "NewInstancesProtectedFromScaleIn":{ "shape":"InstanceProtected", "documentation":"

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

" } }, "documentation":"

Describes an Auto Scaling group.

" }, "AutoScalingGroupDesiredCapacity":{"type":"integer"}, "AutoScalingGroupMaxSize":{"type":"integer"}, "AutoScalingGroupMinSize":{"type":"integer"}, "AutoScalingGroupNames":{ "type":"list", "member":{"shape":"ResourceName"} }, "AutoScalingGroupNamesType":{ "type":"structure", "members":{ "AutoScalingGroupNames":{ "shape":"AutoScalingGroupNames", "documentation":"

The group names. If you omit this parameter, all Auto Scaling groups are described.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxRecords":{ "shape":"MaxRecords", "documentation":"

The maximum number of items to return with this call.

" } }, "documentation":"

Contains the parameters for DescribeAutoScalingGroups.

" }, "AutoScalingGroups":{ "type":"list", "member":{"shape":"AutoScalingGroup"} }, "AutoScalingGroupsType":{ "type":"structure", "required":["AutoScalingGroups"], "members":{ "AutoScalingGroups":{ "shape":"AutoScalingGroups", "documentation":"

The groups.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } }, "documentation":"

Contains the output for DescribeAutoScalingGroups.

" }, "AutoScalingInstanceDetails":{ "type":"structure", "required":[ "InstanceId", "AutoScalingGroupName", "AvailabilityZone", "LifecycleState", "HealthStatus", "LaunchConfigurationName", "ProtectedFromScaleIn" ], "members":{ "InstanceId":{ "shape":"XmlStringMaxLen19", "documentation":"

The ID of the instance.

" }, "AutoScalingGroupName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the Auto Scaling group associated with the instance.

" }, "AvailabilityZone":{ "shape":"XmlStringMaxLen255", "documentation":"

The Availability Zone for the instance.

" }, "LifecycleState":{ "shape":"XmlStringMaxLen32", "documentation":"

The lifecycle state for the instance. For more information, see Auto Scaling Lifecycle in the Auto Scaling User Guide.

" }, "HealthStatus":{ "shape":"XmlStringMaxLen32", "documentation":"

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

" }, "LaunchConfigurationName":{ "shape":"XmlStringMaxLen255", "documentation":"

The launch configuration associated with the instance.

" }, "ProtectedFromScaleIn":{ "shape":"InstanceProtected", "documentation":"

Indicates whether the instance is protected from termination by Auto Scaling when scaling in.

" } }, "documentation":"

Describes an EC2 instance associated with an Auto Scaling group.

" }, "AutoScalingInstances":{ "type":"list", "member":{"shape":"AutoScalingInstanceDetails"} }, "AutoScalingInstancesType":{ "type":"structure", "members":{ "AutoScalingInstances":{ "shape":"AutoScalingInstances", "documentation":"

The instances.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } }, "documentation":"

Contains the output of DescribeAutoScalingInstances.

" }, "AutoScalingNotificationTypes":{ "type":"list", "member":{"shape":"XmlStringMaxLen255"} }, "AvailabilityZones":{ "type":"list", "member":{"shape":"XmlStringMaxLen255"}, "min":1 }, "BlockDeviceEbsDeleteOnTermination":{"type":"boolean"}, "BlockDeviceEbsEncrypted":{"type":"boolean"}, "BlockDeviceEbsIops":{ "type":"integer", "max":20000, "min":100 }, "BlockDeviceEbsVolumeSize":{ "type":"integer", "max":16384, "min":1 }, "BlockDeviceEbsVolumeType":{ "type":"string", "max":255, "min":1 }, "BlockDeviceMapping":{ "type":"structure", "required":["DeviceName"], "members":{ "VirtualName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the virtual device (for example, ephemeral0).

" }, "DeviceName":{ "shape":"XmlStringMaxLen255", "documentation":"

The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh).

" }, "Ebs":{ "shape":"Ebs", "documentation":"

The information about the Amazon EBS volume.

" }, "NoDevice":{ "shape":"NoDevice", "documentation":"

Suppresses a device mapping.

If this parameter is true for the root device, the instance might fail the EC2 health check. Auto Scaling launches a replacement instance if the instance fails the health check.

" } }, "documentation":"

Describes a block device mapping.

" }, "BlockDeviceMappings":{ "type":"list", "member":{"shape":"BlockDeviceMapping"} }, "ClassicLinkVPCSecurityGroups":{ "type":"list", "member":{"shape":"XmlStringMaxLen255"} }, "CompleteLifecycleActionAnswer":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of CompleteLifecycleAction.

" }, "CompleteLifecycleActionType":{ "type":"structure", "required":[ "LifecycleHookName", "AutoScalingGroupName", "LifecycleActionResult" ], "members":{ "LifecycleHookName":{ "shape":"AsciiStringMaxLen255", "documentation":"

The name of the lifecycle hook.

" }, "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the group for the lifecycle hook.

" }, "LifecycleActionToken":{ "shape":"LifecycleActionToken", "documentation":"

A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

" }, "LifecycleActionResult":{ "shape":"LifecycleActionResult", "documentation":"

The action for the group to take. This parameter can be either CONTINUE or ABANDON.

" }, "InstanceId":{ "shape":"XmlStringMaxLen19", "documentation":"

The ID of the instance.

" } }, "documentation":"

Contains the parameters for CompleteLifecycleAction.

" }, "Cooldown":{"type":"integer"}, "CreateAutoScalingGroupType":{ "type":"structure", "required":[ "AutoScalingGroupName", "MinSize", "MaxSize" ], "members":{ "AutoScalingGroupName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the group. This name must be unique within the scope of your AWS account.

" }, "LaunchConfigurationName":{ "shape":"ResourceName", "documentation":"

The name of the launch configuration. Alternatively, specify an EC2 instance instead of a launch configuration.

" }, "InstanceId":{ "shape":"XmlStringMaxLen19", "documentation":"

The ID of the instance used to create a launch configuration for the group. Alternatively, specify a launch configuration instead of an EC2 instance.

When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.

For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Auto Scaling User Guide.

" }, "MinSize":{ "shape":"AutoScalingGroupMinSize", "documentation":"

The minimum size of the group.

" }, "MaxSize":{ "shape":"AutoScalingGroupMaxSize", "documentation":"

The maximum size of the group.

" }, "DesiredCapacity":{ "shape":"AutoScalingGroupDesiredCapacity", "documentation":"

The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.

" }, "DefaultCooldown":{ "shape":"Cooldown", "documentation":"

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.

For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.

" }, "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets.

" }, "LoadBalancerNames":{ "shape":"LoadBalancerNames", "documentation":"

One or more Classic load balancers. To specify an Application load balancer, use TargetGroupARNs instead.

For more information, see Using a Load Balancer With an Auto Scaling Group in the Auto Scaling User Guide.

" }, "TargetGroupARNs":{ "shape":"TargetGroupARNs", "documentation":"

The Amazon Resource Names (ARN) of the target groups.

" }, "HealthCheckType":{ "shape":"XmlStringMaxLen32", "documentation":"

The service to use for the health checks. The valid values are EC2 and ELB.

By default, health checks use Amazon EC2 instance status checks to determine the health of an instance. For more information, see Health Checks in the Auto Scaling User Guide.

" }, "HealthCheckGracePeriod":{ "shape":"HealthCheckGracePeriod", "documentation":"

The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default is 0.

This parameter is required if you are adding an ELB health check.

For more information, see Health Checks in the Auto Scaling User Guide.

" }, "PlacementGroup":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

" }, "VPCZoneIdentifier":{ "shape":"XmlStringMaxLen2047", "documentation":"

A comma-separated list of subnet identifiers for your virtual private cloud (VPC).

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

For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.

" }, "TerminationPolicies":{ "shape":"TerminationPolicies", "documentation":"

One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Auto Scaling User Guide.

" }, "NewInstancesProtectedFromScaleIn":{ "shape":"InstanceProtected", "documentation":"

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

" }, "Tags":{ "shape":"Tags", "documentation":"

One or more tags.

For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling User Guide.

" } }, "documentation":"

Contains the parameters for CreateAutoScalingGroup.

" }, "CreateLaunchConfigurationType":{ "type":"structure", "required":["LaunchConfigurationName"], "members":{ "LaunchConfigurationName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the launch configuration. This name must be unique within the scope of your AWS account.

" }, "ImageId":{ "shape":"XmlStringMaxLen255", "documentation":"

The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Finding an AMI in the Amazon Elastic Compute Cloud User Guide.

" }, "KeyName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" }, "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

One or more security groups with which to associate the instances.

If your instances are launched in EC2-Classic, you can either specify security group names or the security group IDs. For more information about security groups for EC2-Classic, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide.

If your instances are launched into a VPC, specify security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" }, "ClassicLinkVPCId":{ "shape":"XmlStringMaxLen255", "documentation":"

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter is supported only if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "ClassicLinkVPCSecurityGroups":{ "shape":"ClassicLinkVPCSecurityGroups", "documentation":"

The IDs of one or more security groups for the specified ClassicLink-enabled VPC. This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "UserData":{ "shape":"XmlStringUserData", "documentation":"

The user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon Elastic Compute Cloud User Guide.

" }, "InstanceId":{ "shape":"XmlStringMaxLen19", "documentation":"

The ID of the instance to use to create the launch configuration.

The new launch configuration derives attributes from the instance, with the exception of the block device mapping.

To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.

For more information, see Create a Launch Configuration Using an EC2 Instance in the Auto Scaling User Guide.

" }, "InstanceType":{ "shape":"XmlStringMaxLen255", "documentation":"

The instance type of the EC2 instance. For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.

" }, "KernelId":{ "shape":"XmlStringMaxLen255", "documentation":"

The ID of the kernel associated with the AMI.

" }, "RamdiskId":{ "shape":"XmlStringMaxLen255", "documentation":"

The ID of the RAM disk associated with the AMI.

" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappings", "documentation":"

One or more mappings that specify how block devices are exposed to the instance. For more information, see Block Device Mapping in the Amazon Elastic Compute Cloud User Guide.

" }, "InstanceMonitoring":{ "shape":"InstanceMonitoring", "documentation":"

Enables detailed monitoring (true) or basic monitoring (false) for the Auto Scaling instances.

" }, "SpotPrice":{ "shape":"SpotPrice", "documentation":"

The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see Launching Spot Instances in Your Auto Scaling Group in the Auto Scaling User Guide.

" }, "IamInstanceProfile":{ "shape":"XmlStringMaxLen1600", "documentation":"

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

EC2 instances launched with an IAM role will automatically have AWS security credentials available. You can use IAM roles with Auto Scaling to automatically enable applications running on your EC2 instances to securely access other AWS resources. For more information, see Launch Auto Scaling Instances with an IAM Role in the Auto Scaling User Guide.

" }, "EbsOptimized":{ "shape":"EbsOptimized", "documentation":"

Indicates whether the instance is optimized for Amazon EBS I/O. By default, the instance is not optimized for EBS I/O. The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional usage charges apply. For more information, see Amazon EBS-Optimized Instances in the Amazon Elastic Compute Cloud User Guide.

" }, "AssociatePublicIpAddress":{ "shape":"AssociatePublicIpAddress", "documentation":"

Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.

If you specify this parameter, be sure to specify at least one subnet when you create your group.

Default: If the instance is launched into a default subnet, the default is true. If the instance is launched into a nondefault subnet, the default is false. For more information, see Supported Platforms in the Amazon Elastic Compute Cloud User Guide.

" }, "PlacementTenancy":{ "shape":"XmlStringMaxLen64", "documentation":"

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC.

You must set the value of this parameter to dedicated if want to launch Dedicated Instances into a shared tenancy VPC (VPC with instance placement tenancy attribute set to default).

If you specify this parameter, be sure to specify at least one subnet when you create your group.

For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.

Valid values: default | dedicated

" } }, "documentation":"

Contains the parameters for CreateLaunchConfiguration.

" }, "CreateOrUpdateTagsType":{ "type":"structure", "required":["Tags"], "members":{ "Tags":{ "shape":"Tags", "documentation":"

One or more tags.

" } }, "documentation":"

Contains the parameters for CreateOrUpdateTags.

" }, "DeleteAutoScalingGroupType":{ "type":"structure", "required":["AutoScalingGroupName"], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the group to delete.

" }, "ForceDelete":{ "shape":"ForceDelete", "documentation":"

Specifies that the group will be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.

" } }, "documentation":"

Contains the parameters for DeleteAutoScalingGroup.

" }, "DeleteLifecycleHookAnswer":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of DeleteLifecycleHook.

" }, "DeleteLifecycleHookType":{ "type":"structure", "required":[ "LifecycleHookName", "AutoScalingGroupName" ], "members":{ "LifecycleHookName":{ "shape":"AsciiStringMaxLen255", "documentation":"

The name of the lifecycle hook.

" }, "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the Auto Scaling group for the lifecycle hook.

" } }, "documentation":"

Contains the parameters for DeleteLifecycleHook.

" }, "DeleteNotificationConfigurationType":{ "type":"structure", "required":[ "AutoScalingGroupName", "TopicARN" ], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the Auto Scaling group.

" }, "TopicARN":{ "shape":"ResourceName", "documentation":"

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

" } }, "documentation":"

Contains the parameters for DeleteNotificationConfiguration.

" }, "DeletePolicyType":{ "type":"structure", "required":["PolicyName"], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the Auto Scaling group.

" }, "PolicyName":{ "shape":"ResourceName", "documentation":"

The name or Amazon Resource Name (ARN) of the policy.

" } }, "documentation":"

Contains the parameters for DeletePolicy.

" }, "DeleteScheduledActionType":{ "type":"structure", "required":[ "AutoScalingGroupName", "ScheduledActionName" ], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the Auto Scaling group.

" }, "ScheduledActionName":{ "shape":"ResourceName", "documentation":"

The name of the action to delete.

" } }, "documentation":"

Contains the parameters for DeleteScheduledAction.

" }, "DeleteTagsType":{ "type":"structure", "required":["Tags"], "members":{ "Tags":{ "shape":"Tags", "documentation":"

One or more tags.

" } }, "documentation":"

Contains the parameters for DeleteTags.

" }, "DescribeAccountLimitsAnswer":{ "type":"structure", "members":{ "MaxNumberOfAutoScalingGroups":{ "shape":"MaxNumberOfAutoScalingGroups", "documentation":"

The maximum number of groups allowed for your AWS account. The default limit is 20 per region.

" }, "MaxNumberOfLaunchConfigurations":{ "shape":"MaxNumberOfLaunchConfigurations", "documentation":"

The maximum number of launch configurations allowed for your AWS account. The default limit is 100 per region.

" }, "NumberOfAutoScalingGroups":{ "shape":"NumberOfAutoScalingGroups", "documentation":"

The current number of groups for your AWS account.

" }, "NumberOfLaunchConfigurations":{ "shape":"NumberOfLaunchConfigurations", "documentation":"

The current number of launch configurations for your AWS account.

" } }, "documentation":"

Contains the parameters for DescribeAccountLimits.

" }, "DescribeAdjustmentTypesAnswer":{ "type":"structure", "members":{ "AdjustmentTypes":{ "shape":"AdjustmentTypes", "documentation":"

The policy adjustment types.

" } }, "documentation":"

Contains the parameters for DescribeAdjustmentTypes.

" }, "DescribeAutoScalingInstancesType":{ "type":"structure", "members":{ "InstanceIds":{ "shape":"InstanceIds", "documentation":"

The instances to describe; up to 50 instance IDs. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.

" }, "MaxRecords":{ "shape":"MaxRecords", "documentation":"

The maximum number of items to return with this call.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } }, "documentation":"

Contains the parameters for DescribeAutoScalingInstances.

" }, "DescribeAutoScalingNotificationTypesAnswer":{ "type":"structure", "members":{ "AutoScalingNotificationTypes":{ "shape":"AutoScalingNotificationTypes", "documentation":"

The notification types.

" } }, "documentation":"

Contains the output of DescribeAutoScalingNotificationTypes.

" }, "DescribeLifecycleHookTypesAnswer":{ "type":"structure", "members":{ "LifecycleHookTypes":{ "shape":"AutoScalingNotificationTypes", "documentation":"

The lifecycle hook types.

" } }, "documentation":"

Contains the output of DescribeLifecycleHookTypes.

" }, "DescribeLifecycleHooksAnswer":{ "type":"structure", "members":{ "LifecycleHooks":{ "shape":"LifecycleHooks", "documentation":"

The lifecycle hooks for the specified group.

" } }, "documentation":"

Contains the output of DescribeLifecycleHooks.

" }, "DescribeLifecycleHooksType":{ "type":"structure", "required":["AutoScalingGroupName"], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the group.

" }, "LifecycleHookNames":{ "shape":"LifecycleHookNames", "documentation":"

The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle hooks are described.

" } }, "documentation":"

Contains the parameters for DescribeLifecycleHooks.

" }, "DescribeLoadBalancerTargetGroupsRequest":{ "type":"structure", "required":["AutoScalingGroupName"], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the Auto Scaling group.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxRecords":{ "shape":"MaxRecords", "documentation":"

The maximum number of items to return with this call.

" } }, "documentation":"

Contains the parameters for DescribeLoadBalancerTargetGroups.

" }, "DescribeLoadBalancerTargetGroupsResponse":{ "type":"structure", "members":{ "LoadBalancerTargetGroups":{ "shape":"LoadBalancerTargetGroupStates", "documentation":"

Information about the target groups.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } }, "documentation":"

Contains the output of DescribeLoadBalancerTargetGroups.

" }, "DescribeLoadBalancersRequest":{ "type":"structure", "required":["AutoScalingGroupName"], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the group.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxRecords":{ "shape":"MaxRecords", "documentation":"

The maximum number of items to return with this call.

" } }, "documentation":"

Contains the parameters for DescribeLoadBalancers.

" }, "DescribeLoadBalancersResponse":{ "type":"structure", "members":{ "LoadBalancers":{ "shape":"LoadBalancerStates", "documentation":"

The load balancers.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } }, "documentation":"

Contains the output of DescribeLoadBalancers.

" }, "DescribeMetricCollectionTypesAnswer":{ "type":"structure", "members":{ "Metrics":{ "shape":"MetricCollectionTypes", "documentation":"

One or more metrics.

" }, "Granularities":{ "shape":"MetricGranularityTypes", "documentation":"

The granularities for the metrics.

" } }, "documentation":"

Contains the output of DescribeMetricsCollectionTypes.

" }, "DescribeNotificationConfigurationsAnswer":{ "type":"structure", "required":["NotificationConfigurations"], "members":{ "NotificationConfigurations":{ "shape":"NotificationConfigurations", "documentation":"

The notification configurations.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } }, "documentation":"

Contains the output from DescribeNotificationConfigurations.

" }, "DescribeNotificationConfigurationsType":{ "type":"structure", "members":{ "AutoScalingGroupNames":{ "shape":"AutoScalingGroupNames", "documentation":"

The name of the group.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxRecords":{ "shape":"MaxRecords", "documentation":"

The maximum number of items to return with this call.

" } }, "documentation":"

Contains the parameters for DescribeNotificationConfigurations.

" }, "DescribePoliciesType":{ "type":"structure", "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the group.

" }, "PolicyNames":{ "shape":"PolicyNames", "documentation":"

One or more policy names or policy ARNs to be described. If you omit this parameter, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.

" }, "PolicyTypes":{ "shape":"PolicyTypes", "documentation":"

One or more policy types. Valid values are SimpleScaling and StepScaling.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxRecords":{ "shape":"MaxRecords", "documentation":"

The maximum number of items to be returned with each call.

" } }, "documentation":"

Contains the parameters for DescribePolicies.

" }, "DescribeScalingActivitiesType":{ "type":"structure", "members":{ "ActivityIds":{ "shape":"ActivityIds", "documentation":"

The activity IDs of the desired scaling activities. If you omit this parameter, all activities for the past six weeks are described. If you specify an Auto Scaling group, the results are limited to that group. The list of requested activities cannot contain more than 50 items. If unknown activities are requested, they are ignored with no error.

" }, "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the group.

" }, "MaxRecords":{ "shape":"MaxRecords", "documentation":"

The maximum number of items to return with this call.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" } }, "documentation":"

Contains the parameters for DescribeScalingActivities.

" }, "DescribeScheduledActionsType":{ "type":"structure", "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the group.

" }, "ScheduledActionNames":{ "shape":"ScheduledActionNames", "documentation":"

Describes one or more scheduled actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.

You can describe up to a maximum of 50 instances with a single call. If there are more items to return, the call returns a token. To get the next set of items, repeat the call with the returned token.

" }, "StartTime":{ "shape":"TimestampType", "documentation":"

The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

" }, "EndTime":{ "shape":"TimestampType", "documentation":"

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

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxRecords":{ "shape":"MaxRecords", "documentation":"

The maximum number of items to return with this call.

" } }, "documentation":"

Contains the parameters for DescribeScheduledActions.

" }, "DescribeTagsType":{ "type":"structure", "members":{ "Filters":{ "shape":"Filters", "documentation":"

A filter used to scope the tags to return.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxRecords":{ "shape":"MaxRecords", "documentation":"

The maximum number of items to return with this call.

" } }, "documentation":"

Contains the parameters for DescribeTags.

" }, "DescribeTerminationPolicyTypesAnswer":{ "type":"structure", "members":{ "TerminationPolicyTypes":{ "shape":"TerminationPolicies", "documentation":"

The termination policies supported by Auto Scaling (OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, and Default).

" } }, "documentation":"

Contains the output of DescribeTerminationPolicyTypes.

" }, "DetachInstancesAnswer":{ "type":"structure", "members":{ "Activities":{ "shape":"Activities", "documentation":"

The activities related to detaching the instances from the Auto Scaling group.

" } }, "documentation":"

Contains the output of DetachInstances.

" }, "DetachInstancesQuery":{ "type":"structure", "required":[ "AutoScalingGroupName", "ShouldDecrementDesiredCapacity" ], "members":{ "InstanceIds":{ "shape":"InstanceIds", "documentation":"

One or more instance IDs.

" }, "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the group.

" }, "ShouldDecrementDesiredCapacity":{ "shape":"ShouldDecrementDesiredCapacity", "documentation":"

If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

" } }, "documentation":"

Contains the parameters for DetachInstances.

" }, "DetachLoadBalancerTargetGroupsResultType":{ "type":"structure", "members":{ } }, "DetachLoadBalancerTargetGroupsType":{ "type":"structure", "required":[ "AutoScalingGroupName", "TargetGroupARNs" ], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the Auto Scaling group.

" }, "TargetGroupARNs":{ "shape":"TargetGroupARNs", "documentation":"

The Amazon Resource Names (ARN) of the target groups.

" } } }, "DetachLoadBalancersResultType":{ "type":"structure", "members":{ }, "documentation":"

Contains the output for DetachLoadBalancers.

" }, "DetachLoadBalancersType":{ "type":"structure", "required":[ "AutoScalingGroupName", "LoadBalancerNames" ], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the Auto Scaling group.

" }, "LoadBalancerNames":{ "shape":"LoadBalancerNames", "documentation":"

One or more load balancer names.

" } }, "documentation":"

Contains the parameters for DetachLoadBalancers.

" }, "DisableMetricsCollectionQuery":{ "type":"structure", "required":["AutoScalingGroupName"], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name or Amazon Resource Name (ARN) of the group.

" }, "Metrics":{ "shape":"Metrics", "documentation":"

One or more of the following metrics. If you omit this parameter, all metrics are disabled.

  • GroupMinSize

  • GroupMaxSize

  • GroupDesiredCapacity

  • GroupInServiceInstances

  • GroupPendingInstances

  • GroupStandbyInstances

  • GroupTerminatingInstances

  • GroupTotalInstances

" } }, "documentation":"

Contains the parameters for DisableMetricsCollection.

" }, "Ebs":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"XmlStringMaxLen255", "documentation":"

The ID of the snapshot.

" }, "VolumeSize":{ "shape":"BlockDeviceEbsVolumeSize", "documentation":"

The volume size, in GiB. For standard volumes, specify a value from 1 to 1,024. For io1 volumes, specify a value from 4 to 16,384. For gp2 volumes, specify a value from 1 to 16,384. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size.

" }, "VolumeType":{ "shape":"BlockDeviceEbsVolumeType", "documentation":"

The volume type. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Valid values: standard | io1 | gp2

Default: standard

" }, "DeleteOnTermination":{ "shape":"BlockDeviceEbsDeleteOnTermination", "documentation":"

Indicates whether the volume is deleted on instance termination.

Default: true

" }, "Iops":{ "shape":"BlockDeviceEbsIops", "documentation":"

The number of I/O operations per second (IOPS) to provision for the volume.

Constraint: Required when the volume type is io1.

" }, "Encrypted":{ "shape":"BlockDeviceEbsEncrypted", "documentation":"

Indicates whether the volume should be encrypted. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" } }, "documentation":"

Describes an Amazon EBS volume.

" }, "EbsOptimized":{"type":"boolean"}, "EnableMetricsCollectionQuery":{ "type":"structure", "required":[ "AutoScalingGroupName", "Granularity" ], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name or ARN of the Auto Scaling group.

" }, "Metrics":{ "shape":"Metrics", "documentation":"

One or more of the following metrics. If you omit this parameter, all metrics are enabled.

  • GroupMinSize

  • GroupMaxSize

  • GroupDesiredCapacity

  • GroupInServiceInstances

  • GroupPendingInstances

  • GroupStandbyInstances

  • GroupTerminatingInstances

  • GroupTotalInstances

" }, "Granularity":{ "shape":"XmlStringMaxLen255", "documentation":"

The granularity to associate with the metrics to collect. The only valid value is 1Minute.

" } }, "documentation":"

Contains the parameters for EnableMetricsCollection.

" }, "EnabledMetric":{ "type":"structure", "members":{ "Metric":{ "shape":"XmlStringMaxLen255", "documentation":"

One of the following metrics:

  • GroupMinSize

  • GroupMaxSize

  • GroupDesiredCapacity

  • GroupInServiceInstances

  • GroupPendingInstances

  • GroupStandbyInstances

  • GroupTerminatingInstances

  • GroupTotalInstances

" }, "Granularity":{ "shape":"XmlStringMaxLen255", "documentation":"

The granularity of the metric. The only valid value is 1Minute.

" } }, "documentation":"

Describes an enabled metric.

" }, "EnabledMetrics":{ "type":"list", "member":{"shape":"EnabledMetric"} }, "EnterStandbyAnswer":{ "type":"structure", "members":{ "Activities":{ "shape":"Activities", "documentation":"

The activities related to moving instances into Standby mode.

" } }, "documentation":"

Contains the output of EnterStandby.

" }, "EnterStandbyQuery":{ "type":"structure", "required":[ "AutoScalingGroupName", "ShouldDecrementDesiredCapacity" ], "members":{ "InstanceIds":{ "shape":"InstanceIds", "documentation":"

One or more instances to move into Standby mode. You must specify at least one instance ID.

" }, "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the Auto Scaling group.

" }, "ShouldDecrementDesiredCapacity":{ "shape":"ShouldDecrementDesiredCapacity", "documentation":"

Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.

" } }, "documentation":"

Contains the parameters for EnteStandby.

" }, "EstimatedInstanceWarmup":{"type":"integer"}, "ExecutePolicyType":{ "type":"structure", "required":["PolicyName"], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

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

" }, "PolicyName":{ "shape":"ResourceName", "documentation":"

The name or ARN of the policy.

" }, "HonorCooldown":{ "shape":"HonorCooldown", "documentation":"

If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete.

This parameter is not supported if the policy type is StepScaling.

For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.

" }, "MetricValue":{ "shape":"MetricScale", "documentation":"

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

This parameter is required if the policy type is StepScaling and not supported otherwise.

" }, "BreachThreshold":{ "shape":"MetricScale", "documentation":"

The breach threshold for the alarm.

This parameter is required if the policy type is StepScaling and not supported otherwise.

" } }, "documentation":"

Contains the parameters for ExecutePolicy.

" }, "ExitStandbyAnswer":{ "type":"structure", "members":{ "Activities":{ "shape":"Activities", "documentation":"

The activities related to moving instances out of Standby mode.

" } }, "documentation":"

Contains the parameters for ExitStandby.

" }, "ExitStandbyQuery":{ "type":"structure", "required":["AutoScalingGroupName"], "members":{ "InstanceIds":{ "shape":"InstanceIds", "documentation":"

One or more instance IDs. You must specify at least one instance ID.

" }, "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the Auto Scaling group.

" } }, "documentation":"

Contains the parameters for ExitStandby.

" }, "Filter":{ "type":"structure", "members":{ "Name":{ "shape":"XmlString", "documentation":"

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

" }, "Values":{ "shape":"Values", "documentation":"

The value of the filter.

" } }, "documentation":"

Describes a filter.

" }, "Filters":{ "type":"list", "member":{"shape":"Filter"} }, "ForceDelete":{"type":"boolean"}, "GlobalTimeout":{"type":"integer"}, "HealthCheckGracePeriod":{"type":"integer"}, "HeartbeatTimeout":{"type":"integer"}, "HonorCooldown":{"type":"boolean"}, "Instance":{ "type":"structure", "required":[ "InstanceId", "AvailabilityZone", "LifecycleState", "HealthStatus", "LaunchConfigurationName", "ProtectedFromScaleIn" ], "members":{ "InstanceId":{ "shape":"XmlStringMaxLen19", "documentation":"

The ID of the instance.

" }, "AvailabilityZone":{ "shape":"XmlStringMaxLen255", "documentation":"

The Availability Zone in which the instance is running.

" }, "LifecycleState":{ "shape":"LifecycleState", "documentation":"

A description of the current lifecycle state. Note that the Quarantined state is not used.

" }, "HealthStatus":{ "shape":"XmlStringMaxLen32", "documentation":"

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

" }, "LaunchConfigurationName":{ "shape":"XmlStringMaxLen255", "documentation":"

The launch configuration associated with the instance.

" }, "ProtectedFromScaleIn":{ "shape":"InstanceProtected", "documentation":"

Indicates whether the instance is protected from termination by Auto Scaling when scaling in.

" } }, "documentation":"

Describes an EC2 instance.

" }, "InstanceIds":{ "type":"list", "member":{"shape":"XmlStringMaxLen19"} }, "InstanceMonitoring":{ "type":"structure", "members":{ "Enabled":{ "shape":"MonitoringEnabled", "documentation":"

If True, instance monitoring is enabled.

" } }, "documentation":"

Describes whether instance monitoring is enabled.

" }, "InstanceProtected":{"type":"boolean"}, "Instances":{ "type":"list", "member":{"shape":"Instance"} }, "InvalidNextToken":{ "type":"structure", "members":{ "message":{ "shape":"XmlStringMaxLen255", "documentation":"

" } }, "documentation":"

The NextToken value is not valid.

", "error":{ "code":"InvalidNextToken", "httpStatusCode":400, "senderFault":true }, "exception":true }, "LaunchConfiguration":{ "type":"structure", "required":[ "LaunchConfigurationName", "ImageId", "InstanceType", "CreatedTime" ], "members":{ "LaunchConfigurationName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the launch configuration.

" }, "LaunchConfigurationARN":{ "shape":"ResourceName", "documentation":"

The Amazon Resource Name (ARN) of the launch configuration.

" }, "ImageId":{ "shape":"XmlStringMaxLen255", "documentation":"

The ID of the Amazon Machine Image (AMI).

" }, "KeyName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the key pair.

" }, "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

The security groups to associate with the instances.

" }, "ClassicLinkVPCId":{ "shape":"XmlStringMaxLen255", "documentation":"

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "ClassicLinkVPCSecurityGroups":{ "shape":"ClassicLinkVPCSecurityGroups", "documentation":"

The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId. This parameter is required if you specify a ClassicLink-enabled VPC, and cannot be used otherwise. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" }, "UserData":{ "shape":"XmlStringUserData", "documentation":"

The user data available to the instances.

" }, "InstanceType":{ "shape":"XmlStringMaxLen255", "documentation":"

The instance type for the instances.

" }, "KernelId":{ "shape":"XmlStringMaxLen255", "documentation":"

The ID of the kernel associated with the AMI.

" }, "RamdiskId":{ "shape":"XmlStringMaxLen255", "documentation":"

The ID of the RAM disk associated with the AMI.

" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappings", "documentation":"

A block device mapping, which specifies the block devices for the instance.

" }, "InstanceMonitoring":{ "shape":"InstanceMonitoring", "documentation":"

Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.

" }, "SpotPrice":{ "shape":"SpotPrice", "documentation":"

The price to bid when launching Spot Instances.

" }, "IamInstanceProfile":{ "shape":"XmlStringMaxLen1600", "documentation":"

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

" }, "CreatedTime":{ "shape":"TimestampType", "documentation":"

The creation date and time for the launch configuration.

" }, "EbsOptimized":{ "shape":"EbsOptimized", "documentation":"

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

" }, "AssociatePublicIpAddress":{ "shape":"AssociatePublicIpAddress", "documentation":"

[EC2-VPC] Indicates whether to assign a public IP address to each instance.

" }, "PlacementTenancy":{ "shape":"XmlStringMaxLen64", "documentation":"

The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs in an isolated, single-tenant hardware and can only be launched into a VPC.

" } }, "documentation":"

Describes a launch configuration.

" }, "LaunchConfigurationNameType":{ "type":"structure", "required":["LaunchConfigurationName"], "members":{ "LaunchConfigurationName":{ "shape":"ResourceName", "documentation":"

The name of the launch configuration.

" } }, "documentation":"

Contains the parameters for DeleteLaunchConfiguration.

" }, "LaunchConfigurationNames":{ "type":"list", "member":{"shape":"ResourceName"} }, "LaunchConfigurationNamesType":{ "type":"structure", "members":{ "LaunchConfigurationNames":{ "shape":"LaunchConfigurationNames", "documentation":"

The launch configuration names. If you omit this parameter, all launch configurations are described.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "MaxRecords":{ "shape":"MaxRecords", "documentation":"

The maximum number of items to return with this call. The default is 100.

" } }, "documentation":"

Contains the parameters for DescribeLaunchConfigurations.

" }, "LaunchConfigurations":{ "type":"list", "member":{"shape":"LaunchConfiguration"} }, "LaunchConfigurationsType":{ "type":"structure", "required":["LaunchConfigurations"], "members":{ "LaunchConfigurations":{ "shape":"LaunchConfigurations", "documentation":"

The launch configurations.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } }, "documentation":"

Contains the output of DescribeLaunchConfigurations.

" }, "LifecycleActionResult":{"type":"string"}, "LifecycleActionToken":{ "type":"string", "max":36, "min":36 }, "LifecycleHook":{ "type":"structure", "members":{ "LifecycleHookName":{ "shape":"AsciiStringMaxLen255", "documentation":"

The name of the lifecycle hook.

" }, "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the Auto Scaling group for the lifecycle hook.

" }, "LifecycleTransition":{ "shape":"LifecycleTransition", "documentation":"

The state of the EC2 instance to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.

" }, "NotificationTargetARN":{ "shape":"ResourceName", "documentation":"

The ARN of the notification target that Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. The notification message sent to the target includes the following:

  • Lifecycle action token

  • User account ID

  • Name of the Auto Scaling group

  • Lifecycle hook name

  • EC2 instance ID

  • Lifecycle transition

  • Notification metadata

" }, "RoleARN":{ "shape":"ResourceName", "documentation":"

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

" }, "NotificationMetadata":{ "shape":"XmlStringMaxLen1023", "documentation":"

Additional information that you want to include any time Auto Scaling sends a message to the notification target.

" }, "HeartbeatTimeout":{ "shape":"HeartbeatTimeout", "documentation":"

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The default is 3600 seconds (1 hour). When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

" }, "GlobalTimeout":{ "shape":"GlobalTimeout", "documentation":"

The maximum time, in seconds, that an instance can remain in a Pending:Wait or Terminating:Wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

" }, "DefaultResult":{ "shape":"LifecycleActionResult", "documentation":"

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON. The default value is CONTINUE.

" } }, "documentation":"

Describes a lifecycle hook, which tells Auto Scaling that you want to perform an action when an instance launches or terminates. When you have a lifecycle hook in place, the Auto Scaling group will either:

  • Pause the instance after it launches, but before it is put into service

  • Pause the instance as it terminates, but before it is fully terminated

For more information, see Auto Scaling Lifecycle in the Auto Scaling User Guide.

" }, "LifecycleHookNames":{ "type":"list", "member":{"shape":"AsciiStringMaxLen255"} }, "LifecycleHooks":{ "type":"list", "member":{"shape":"LifecycleHook"} }, "LifecycleState":{ "type":"string", "enum":[ "Pending", "Pending:Wait", "Pending:Proceed", "Quarantined", "InService", "Terminating", "Terminating:Wait", "Terminating:Proceed", "Terminated", "Detaching", "Detached", "EnteringStandby", "Standby" ] }, "LifecycleTransition":{"type":"string"}, "LimitExceededFault":{ "type":"structure", "members":{ "message":{ "shape":"XmlStringMaxLen255", "documentation":"

" } }, "documentation":"

You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

", "error":{ "code":"LimitExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "LoadBalancerNames":{ "type":"list", "member":{"shape":"XmlStringMaxLen255"} }, "LoadBalancerState":{ "type":"structure", "members":{ "LoadBalancerName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the load balancer.

" }, "State":{ "shape":"XmlStringMaxLen255", "documentation":"

One of the following load balancer states:

  • Adding - The instances in the group are being registered with the load balancer.

  • Added - All instances in the group are registered with the load balancer.

  • InService - At least one instance in the group passed an ELB health check.

  • Removing - The instances in the group are being deregistered from the load balancer. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.

  • Removed - All instances in the group are deregistered from the load balancer.

" } }, "documentation":"

Describes the state of a Classic load balancer.

If you specify a load balancer when creating the Auto Scaling group, the state of the load balancer is InService.

If you attach a load balancer to an existing Auto Scaling group, the initial state is Adding. The state transitions to Added after all instances in the group are registered with the load balancer. If ELB health checks are enabled for the load balancer, the state transitions to InService after at least one instance in the group passes the health check. If EC2 health checks are enabled instead, the load balancer remains in the Added state.

" }, "LoadBalancerStates":{ "type":"list", "member":{"shape":"LoadBalancerState"} }, "LoadBalancerTargetGroupState":{ "type":"structure", "members":{ "LoadBalancerTargetGroupARN":{ "shape":"XmlStringMaxLen511", "documentation":"

The Amazon Resource Name (ARN) of the target group.

" }, "State":{ "shape":"XmlStringMaxLen255", "documentation":"

The state of the target group.

  • Adding - The Auto Scaling instances are being registered with the target group.

  • Added - All Auto Scaling instances are registered with the target group.

  • InService - At least one Auto Scaling instance passed an ELB health check.

  • Removing - The Auto Scaling instances are being deregistered from the target group. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.

  • Removed - All Auto Scaling instances are deregistered from the target group.

" } }, "documentation":"

Describes the state of a target group.

If you attach a target group to an existing Auto Scaling group, the initial state is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If ELB health checks are enabled, the state transitions to InService after at least one Auto Scaling instance passes the health check. If EC2 health checks are enabled instead, the target group remains in the Added state.

" }, "LoadBalancerTargetGroupStates":{ "type":"list", "member":{"shape":"LoadBalancerTargetGroupState"} }, "MaxNumberOfAutoScalingGroups":{"type":"integer"}, "MaxNumberOfLaunchConfigurations":{"type":"integer"}, "MaxRecords":{"type":"integer"}, "MetricCollectionType":{ "type":"structure", "members":{ "Metric":{ "shape":"XmlStringMaxLen255", "documentation":"

One of the following metrics:

  • GroupMinSize

  • GroupMaxSize

  • GroupDesiredCapacity

  • GroupInServiceInstances

  • GroupPendingInstances

  • GroupStandbyInstances

  • GroupTerminatingInstances

  • GroupTotalInstances

" } }, "documentation":"

Describes a metric.

" }, "MetricCollectionTypes":{ "type":"list", "member":{"shape":"MetricCollectionType"} }, "MetricGranularityType":{ "type":"structure", "members":{ "Granularity":{ "shape":"XmlStringMaxLen255", "documentation":"

The granularity. The only valid value is 1Minute.

" } }, "documentation":"

Describes a granularity of a metric.

" }, "MetricGranularityTypes":{ "type":"list", "member":{"shape":"MetricGranularityType"} }, "MetricScale":{"type":"double"}, "Metrics":{ "type":"list", "member":{"shape":"XmlStringMaxLen255"} }, "MinAdjustmentMagnitude":{"type":"integer"}, "MinAdjustmentStep":{ "type":"integer", "deprecated":true }, "MonitoringEnabled":{"type":"boolean"}, "NoDevice":{"type":"boolean"}, "NotificationConfiguration":{ "type":"structure", "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the group.

" }, "TopicARN":{ "shape":"ResourceName", "documentation":"

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

" }, "NotificationType":{ "shape":"XmlStringMaxLen255", "documentation":"

One of the following event notification types:

  • autoscaling:EC2_INSTANCE_LAUNCH

  • autoscaling:EC2_INSTANCE_LAUNCH_ERROR

  • autoscaling:EC2_INSTANCE_TERMINATE

  • autoscaling:EC2_INSTANCE_TERMINATE_ERROR

  • autoscaling:TEST_NOTIFICATION

" } }, "documentation":"

Describes a notification.

" }, "NotificationConfigurations":{ "type":"list", "member":{"shape":"NotificationConfiguration"} }, "NotificationTargetResourceName":{ "type":"string", "max":1600, "min":0, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "NumberOfAutoScalingGroups":{"type":"integer"}, "NumberOfLaunchConfigurations":{"type":"integer"}, "PoliciesType":{ "type":"structure", "members":{ "ScalingPolicies":{ "shape":"ScalingPolicies", "documentation":"

The scaling policies.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } }, "documentation":"

Contains the output of DescribePolicies.

" }, "PolicyARNType":{ "type":"structure", "members":{ "PolicyARN":{ "shape":"ResourceName", "documentation":"

The Amazon Resource Name (ARN) of the policy.

" } }, "documentation":"

Contains the output of PutScalingPolicy.

" }, "PolicyIncrement":{"type":"integer"}, "PolicyNames":{ "type":"list", "member":{"shape":"ResourceName"} }, "PolicyTypes":{ "type":"list", "member":{"shape":"XmlStringMaxLen64"} }, "ProcessNames":{ "type":"list", "member":{"shape":"XmlStringMaxLen255"} }, "ProcessType":{ "type":"structure", "required":["ProcessName"], "members":{ "ProcessName":{ "shape":"XmlStringMaxLen255", "documentation":"

One of the following processes:

  • Launch

  • Terminate

  • AddToLoadBalancer

  • AlarmNotification

  • AZRebalance

  • HealthCheck

  • ReplaceUnhealthy

  • ScheduledActions

" } }, "documentation":"

Describes a process type.

For more information, see Auto Scaling Processes in the Auto Scaling User Guide.

" }, "Processes":{ "type":"list", "member":{"shape":"ProcessType"} }, "ProcessesType":{ "type":"structure", "members":{ "Processes":{ "shape":"Processes", "documentation":"

The names of the process types.

" } }, "documentation":"

Contains the output of DescribeScalingProcessTypes.

" }, "Progress":{"type":"integer"}, "PropagateAtLaunch":{"type":"boolean"}, "ProtectedFromScaleIn":{"type":"boolean"}, "PutLifecycleHookAnswer":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of PutLifecycleHook.

" }, "PutLifecycleHookType":{ "type":"structure", "required":[ "LifecycleHookName", "AutoScalingGroupName" ], "members":{ "LifecycleHookName":{ "shape":"AsciiStringMaxLen255", "documentation":"

The name of the lifecycle hook.

" }, "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the Auto Scaling group to which you want to assign the lifecycle hook.

" }, "LifecycleTransition":{ "shape":"LifecycleTransition", "documentation":"

The instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

" }, "RoleARN":{ "shape":"ResourceName", "documentation":"

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

" }, "NotificationTargetARN":{ "shape":"NotificationTargetResourceName", "documentation":"

The ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Auto Scaling sends it a test message. Test messages contains the following additional key/value pair: \"Event\": \"autoscaling:TEST_NOTIFICATION\".

" }, "NotificationMetadata":{ "shape":"XmlStringMaxLen1023", "documentation":"

Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.

" }, "HeartbeatTimeout":{ "shape":"HeartbeatTimeout", "documentation":"

The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default is 3600 seconds (1 hour).

" }, "DefaultResult":{ "shape":"LifecycleActionResult", "documentation":"

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

" } }, "documentation":"

Contains the parameters for PutLifecycleHook.

" }, "PutNotificationConfigurationType":{ "type":"structure", "required":[ "AutoScalingGroupName", "TopicARN", "NotificationTypes" ], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the Auto Scaling group.

" }, "TopicARN":{ "shape":"ResourceName", "documentation":"

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

" }, "NotificationTypes":{ "shape":"AutoScalingNotificationTypes", "documentation":"

The type of event that will cause the notification to be sent. For details about notification types supported by Auto Scaling, see DescribeAutoScalingNotificationTypes.

" } }, "documentation":"

Contains the parameters for PutNotificationConfiguration.

" }, "PutScalingPolicyType":{ "type":"structure", "required":[ "AutoScalingGroupName", "PolicyName", "AdjustmentType" ], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name or ARN of the group.

" }, "PolicyName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the policy.

" }, "PolicyType":{ "shape":"XmlStringMaxLen64", "documentation":"

The policy type. Valid values are SimpleScaling and StepScaling. If the policy type is null, the value is treated as SimpleScaling.

" }, "AdjustmentType":{ "shape":"XmlStringMaxLen255", "documentation":"

The adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

For more information, see Dynamic Scaling in the Auto Scaling User Guide.

" }, "MinAdjustmentStep":{ "shape":"MinAdjustmentStep", "documentation":"

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

" }, "MinAdjustmentMagnitude":{ "shape":"MinAdjustmentMagnitude", "documentation":"

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

" }, "ScalingAdjustment":{ "shape":"PolicyIncrement", "documentation":"

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

This parameter is required if the policy type is SimpleScaling and not supported otherwise.

" }, "Cooldown":{ "shape":"Cooldown", "documentation":"

The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start. If this parameter is not specified, the default cooldown period for the group applies.

This parameter is not supported unless the policy type is SimpleScaling.

For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.

" }, "MetricAggregationType":{ "shape":"XmlStringMaxLen32", "documentation":"

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

This parameter is not supported if the policy type is SimpleScaling.

" }, "StepAdjustments":{ "shape":"StepAdjustments", "documentation":"

A set of adjustments that enable you to scale based on the size of the alarm breach.

This parameter is required if the policy type is StepScaling and not supported otherwise.

" }, "EstimatedInstanceWarmup":{ "shape":"EstimatedInstanceWarmup", "documentation":"

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.

This parameter is not supported if the policy type is SimpleScaling.

" } }, "documentation":"

Contains the parameters for PutScalingPolicy.

" }, "PutScheduledUpdateGroupActionType":{ "type":"structure", "required":[ "AutoScalingGroupName", "ScheduledActionName" ], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

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

" }, "ScheduledActionName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of this scaling action.

" }, "Time":{ "shape":"TimestampType", "documentation":"

This parameter is deprecated.

" }, "StartTime":{ "shape":"TimestampType", "documentation":"

The time for this action to start, in \"YYYY-MM-DDThh:mm:ssZ\" format in UTC/GMT only (for example, 2014-06-01T00:00:00Z).

If you specify Recurrence and StartTime, Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

If you try to schedule your action in the past, Auto Scaling returns an error message.

" }, "EndTime":{ "shape":"TimestampType", "documentation":"

The time for the recurring schedule to end. Auto Scaling does not perform the action after this time.

" }, "Recurrence":{ "shape":"XmlStringMaxLen255", "documentation":"

The recurring schedule for this action, in Unix cron syntax format. For more information, see Cron in Wikipedia.

" }, "MinSize":{ "shape":"AutoScalingGroupMinSize", "documentation":"

The minimum size for the Auto Scaling group.

" }, "MaxSize":{ "shape":"AutoScalingGroupMaxSize", "documentation":"

The maximum size for the Auto Scaling group.

" }, "DesiredCapacity":{ "shape":"AutoScalingGroupDesiredCapacity", "documentation":"

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

" } }, "documentation":"

Contains the parameters for PutScheduledUpdateGroupAction.

" }, "RecordLifecycleActionHeartbeatAnswer":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of RecordLifecycleActionHeartBeat.

" }, "RecordLifecycleActionHeartbeatType":{ "type":"structure", "required":[ "LifecycleHookName", "AutoScalingGroupName" ], "members":{ "LifecycleHookName":{ "shape":"AsciiStringMaxLen255", "documentation":"

The name of the lifecycle hook.

" }, "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the Auto Scaling group for the hook.

" }, "LifecycleActionToken":{ "shape":"LifecycleActionToken", "documentation":"

A token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

" }, "InstanceId":{ "shape":"XmlStringMaxLen19", "documentation":"

The ID of the instance.

" } }, "documentation":"

Contains the parameters for RecordLifecycleActionHeartbeat.

" }, "ResourceContentionFault":{ "type":"structure", "members":{ "message":{ "shape":"XmlStringMaxLen255", "documentation":"

" } }, "documentation":"

You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

", "error":{ "code":"ResourceContention", "httpStatusCode":500, "senderFault":true }, "exception":true }, "ResourceInUseFault":{ "type":"structure", "members":{ "message":{ "shape":"XmlStringMaxLen255", "documentation":"

" } }, "documentation":"

The operation can't be performed because the resource is in use.

", "error":{ "code":"ResourceInUse", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ResourceName":{ "type":"string", "max":1600, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "ScalingActivityInProgressFault":{ "type":"structure", "members":{ "message":{ "shape":"XmlStringMaxLen255", "documentation":"

" } }, "documentation":"

The operation can't be performed because there are scaling activities in progress.

", "error":{ "code":"ScalingActivityInProgress", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ScalingActivityStatusCode":{ "type":"string", "enum":[ "PendingSpotBidPlacement", "WaitingForSpotInstanceRequestId", "WaitingForSpotInstanceId", "WaitingForInstanceId", "PreInService", "InProgress", "WaitingForELBConnectionDraining", "MidLifecycleAction", "WaitingForInstanceWarmup", "Successful", "Failed", "Cancelled" ] }, "ScalingPolicies":{ "type":"list", "member":{"shape":"ScalingPolicy"} }, "ScalingPolicy":{ "type":"structure", "members":{ "AutoScalingGroupName":{ "shape":"XmlStringMaxLen255", "documentation":"

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

" }, "PolicyName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the scaling policy.

" }, "PolicyARN":{ "shape":"ResourceName", "documentation":"

The Amazon Resource Name (ARN) of the policy.

" }, "PolicyType":{ "shape":"XmlStringMaxLen64", "documentation":"

The policy type. Valid values are SimpleScaling and StepScaling.

" }, "AdjustmentType":{ "shape":"XmlStringMaxLen255", "documentation":"

The adjustment type, which specifies how ScalingAdjustment is interpreted. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

" }, "MinAdjustmentStep":{ "shape":"MinAdjustmentStep", "documentation":"

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

" }, "MinAdjustmentMagnitude":{ "shape":"MinAdjustmentMagnitude", "documentation":"

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

" }, "ScalingAdjustment":{ "shape":"PolicyIncrement", "documentation":"

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

" }, "Cooldown":{ "shape":"Cooldown", "documentation":"

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

" }, "StepAdjustments":{ "shape":"StepAdjustments", "documentation":"

A set of adjustments that enable you to scale based on the size of the alarm breach.

" }, "MetricAggregationType":{ "shape":"XmlStringMaxLen32", "documentation":"

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average.

" }, "EstimatedInstanceWarmup":{ "shape":"EstimatedInstanceWarmup", "documentation":"

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

" }, "Alarms":{ "shape":"Alarms", "documentation":"

The CloudWatch alarms related to the policy.

" } }, "documentation":"

Describes a scaling policy.

" }, "ScalingProcessQuery":{ "type":"structure", "required":["AutoScalingGroupName"], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

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

" }, "ScalingProcesses":{ "shape":"ProcessNames", "documentation":"

One or more of the following processes. If you omit this parameter, all processes are specified.

  • Launch

  • Terminate

  • HealthCheck

  • ReplaceUnhealthy

  • AZRebalance

  • AlarmNotification

  • ScheduledActions

  • AddToLoadBalancer

" } }, "documentation":"

Contains the parameters for SuspendProcesses and ResumeProcesses.

" }, "ScheduledActionNames":{ "type":"list", "member":{"shape":"ResourceName"} }, "ScheduledActionsType":{ "type":"structure", "members":{ "ScheduledUpdateGroupActions":{ "shape":"ScheduledUpdateGroupActions", "documentation":"

The scheduled actions.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } }, "documentation":"

Contains the output of DescribeScheduledActions.

" }, "ScheduledUpdateGroupAction":{ "type":"structure", "members":{ "AutoScalingGroupName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the group.

" }, "ScheduledActionName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the scheduled action.

" }, "ScheduledActionARN":{ "shape":"ResourceName", "documentation":"

The Amazon Resource Name (ARN) of the scheduled action.

" }, "Time":{ "shape":"TimestampType", "documentation":"

This parameter is deprecated.

" }, "StartTime":{ "shape":"TimestampType", "documentation":"

The date and time that the action is scheduled to begin. This date and time can be up to one month in the future.

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

" }, "EndTime":{ "shape":"TimestampType", "documentation":"

The date and time that the action is scheduled to end. This date and time can be up to one month in the future.

" }, "Recurrence":{ "shape":"XmlStringMaxLen255", "documentation":"

The recurring schedule for the action.

" }, "MinSize":{ "shape":"AutoScalingGroupMinSize", "documentation":"

The minimum size of the group.

" }, "MaxSize":{ "shape":"AutoScalingGroupMaxSize", "documentation":"

The maximum size of the group.

" }, "DesiredCapacity":{ "shape":"AutoScalingGroupDesiredCapacity", "documentation":"

The number of instances you prefer to maintain in the group.

" } }, "documentation":"

Describes a scheduled update to an Auto Scaling group.

" }, "ScheduledUpdateGroupActions":{ "type":"list", "member":{"shape":"ScheduledUpdateGroupAction"} }, "SecurityGroups":{ "type":"list", "member":{"shape":"XmlString"} }, "SetDesiredCapacityType":{ "type":"structure", "required":[ "AutoScalingGroupName", "DesiredCapacity" ], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the Auto Scaling group.

" }, "DesiredCapacity":{ "shape":"AutoScalingGroupDesiredCapacity", "documentation":"

The number of EC2 instances that should be running in the Auto Scaling group.

" }, "HonorCooldown":{ "shape":"HonorCooldown", "documentation":"

By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group. Specify True to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity.

" } }, "documentation":"

Contains the parameters for SetDesiredCapacity.

" }, "SetInstanceHealthQuery":{ "type":"structure", "required":[ "InstanceId", "HealthStatus" ], "members":{ "InstanceId":{ "shape":"XmlStringMaxLen19", "documentation":"

The ID of the instance.

" }, "HealthStatus":{ "shape":"XmlStringMaxLen32", "documentation":"

The health status of the instance. Set to Healthy if you want the instance to remain in service. Set to Unhealthy if you want the instance to be out of service. Auto Scaling will terminate and replace the unhealthy instance.

" }, "ShouldRespectGracePeriod":{ "shape":"ShouldRespectGracePeriod", "documentation":"

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call will respect the grace period. Set this to False, if you do not want the call to respect the grace period associated with the group.

For more information, see the description of the health check grace period for CreateAutoScalingGroup.

" } }, "documentation":"

Contains the parameters for SetInstanceHealth.

" }, "SetInstanceProtectionAnswer":{ "type":"structure", "members":{ }, "documentation":"

Contains the output of SetInstanceProtection.

" }, "SetInstanceProtectionQuery":{ "type":"structure", "required":[ "InstanceIds", "AutoScalingGroupName", "ProtectedFromScaleIn" ], "members":{ "InstanceIds":{ "shape":"InstanceIds", "documentation":"

One or more instance IDs.

" }, "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the group.

" }, "ProtectedFromScaleIn":{ "shape":"ProtectedFromScaleIn", "documentation":"

Indicates whether the instance is protected from termination by Auto Scaling when scaling in.

" } }, "documentation":"

Contains the parameters for SetInstanceProtection.

" }, "ShouldDecrementDesiredCapacity":{"type":"boolean"}, "ShouldRespectGracePeriod":{"type":"boolean"}, "SpotPrice":{ "type":"string", "max":255, "min":1 }, "StepAdjustment":{ "type":"structure", "required":["ScalingAdjustment"], "members":{ "MetricIntervalLowerBound":{ "shape":"MetricScale", "documentation":"

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.

" }, "MetricIntervalUpperBound":{ "shape":"MetricScale", "documentation":"

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.

The upper bound must be greater than the lower bound.

" }, "ScalingAdjustment":{ "shape":"PolicyIncrement", "documentation":"

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

" } }, "documentation":"

Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.

For the following examples, suppose that you have an alarm with a breach threshold of 50:

  • If you want the adjustment to be triggered when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.

  • If you want the adjustment to be triggered when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.

There are a few rules for the step adjustments for your step policy:

  • The ranges of your step adjustments can't overlap or have a gap.

  • At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.

  • At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.

  • The upper and lower bound can't be null in the same step adjustment.

" }, "StepAdjustments":{ "type":"list", "member":{"shape":"StepAdjustment"} }, "SuspendedProcess":{ "type":"structure", "members":{ "ProcessName":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the suspended process.

" }, "SuspensionReason":{ "shape":"XmlStringMaxLen255", "documentation":"

The reason that the process was suspended.

" } }, "documentation":"

Describes an Auto Scaling process that has been suspended. For more information, see ProcessType.

" }, "SuspendedProcesses":{ "type":"list", "member":{"shape":"SuspendedProcess"} }, "Tag":{ "type":"structure", "required":["Key"], "members":{ "ResourceId":{ "shape":"XmlString", "documentation":"

The name of the group.

" }, "ResourceType":{ "shape":"XmlString", "documentation":"

The type of resource. The only supported value is auto-scaling-group.

" }, "Key":{ "shape":"TagKey", "documentation":"

The tag key.

" }, "Value":{ "shape":"TagValue", "documentation":"

The tag value.

" }, "PropagateAtLaunch":{ "shape":"PropagateAtLaunch", "documentation":"

Determines whether the tag is added to new instances as they are launched in the group.

" } }, "documentation":"

Describes a tag for an Auto Scaling group.

" }, "TagDescription":{ "type":"structure", "members":{ "ResourceId":{ "shape":"XmlString", "documentation":"

The name of the group.

" }, "ResourceType":{ "shape":"XmlString", "documentation":"

The type of resource. The only supported value is auto-scaling-group.

" }, "Key":{ "shape":"TagKey", "documentation":"

The tag key.

" }, "Value":{ "shape":"TagValue", "documentation":"

The tag value.

" }, "PropagateAtLaunch":{ "shape":"PropagateAtLaunch", "documentation":"

Determines whether the tag is added to new instances as they are launched in the group.

" } }, "documentation":"

Describes a tag for an Auto Scaling group.

" }, "TagDescriptionList":{ "type":"list", "member":{"shape":"TagDescription"} }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "Tags":{ "type":"list", "member":{"shape":"Tag"} }, "TagsType":{ "type":"structure", "members":{ "Tags":{ "shape":"TagDescriptionList", "documentation":"

One or more tags.

" }, "NextToken":{ "shape":"XmlString", "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

" } }, "documentation":"

Contains the output of DescribeTags.

" }, "TargetGroupARNs":{ "type":"list", "member":{"shape":"XmlStringMaxLen511"} }, "TerminateInstanceInAutoScalingGroupType":{ "type":"structure", "required":[ "InstanceId", "ShouldDecrementDesiredCapacity" ], "members":{ "InstanceId":{ "shape":"XmlStringMaxLen19", "documentation":"

The ID of the instance.

" }, "ShouldDecrementDesiredCapacity":{ "shape":"ShouldDecrementDesiredCapacity", "documentation":"

If true, terminating the instance also decrements the size of the Auto Scaling group.

" } }, "documentation":"

Contains the parameters for TerminateInstanceInAutoScalingGroup.

" }, "TerminationPolicies":{ "type":"list", "member":{"shape":"XmlStringMaxLen1600"} }, "TimestampType":{"type":"timestamp"}, "UpdateAutoScalingGroupType":{ "type":"structure", "required":["AutoScalingGroupName"], "members":{ "AutoScalingGroupName":{ "shape":"ResourceName", "documentation":"

The name of the Auto Scaling group.

" }, "LaunchConfigurationName":{ "shape":"ResourceName", "documentation":"

The name of the launch configuration.

" }, "MinSize":{ "shape":"AutoScalingGroupMinSize", "documentation":"

The minimum size of the Auto Scaling group.

" }, "MaxSize":{ "shape":"AutoScalingGroupMaxSize", "documentation":"

The maximum size of the Auto Scaling group.

" }, "DesiredCapacity":{ "shape":"AutoScalingGroupDesiredCapacity", "documentation":"

The number of EC2 instances that should be running in the Auto Scaling group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.

" }, "DefaultCooldown":{ "shape":"Cooldown", "documentation":"

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default is 300.

For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.

" }, "AvailabilityZones":{ "shape":"AvailabilityZones", "documentation":"

One or more Availability Zones for the group.

" }, "HealthCheckType":{ "shape":"XmlStringMaxLen32", "documentation":"

The service to use for the health checks. The valid values are EC2 and ELB.

" }, "HealthCheckGracePeriod":{ "shape":"HealthCheckGracePeriod", "documentation":"

The amount of time, in seconds, that Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default is 0.

For more information, see Health Checks in the Auto Scaling User Guide.

" }, "PlacementGroup":{ "shape":"XmlStringMaxLen255", "documentation":"

The name of the placement group into which you'll launch your instances, if any. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

" }, "VPCZoneIdentifier":{ "shape":"XmlStringMaxLen2047", "documentation":"

The ID of the subnet, if you are launching into a VPC. You can specify several subnets in a comma-separated list.

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

For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling User Guide.

" }, "TerminationPolicies":{ "shape":"TerminationPolicies", "documentation":"

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

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Auto Scaling User Guide.

" }, "NewInstancesProtectedFromScaleIn":{ "shape":"InstanceProtected", "documentation":"

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

" } }, "documentation":"

Contains the parameters for UpdateAutoScalingGroup.

" }, "Values":{ "type":"list", "member":{"shape":"XmlString"} }, "XmlString":{ "type":"string", "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "XmlStringMaxLen1023":{ "type":"string", "max":1023, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "XmlStringMaxLen1600":{ "type":"string", "max":1600, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "XmlStringMaxLen19":{ "type":"string", "max":19, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "XmlStringMaxLen2047":{ "type":"string", "max":2047, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "XmlStringMaxLen255":{ "type":"string", "max":255, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "XmlStringMaxLen32":{ "type":"string", "max":32, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "XmlStringMaxLen511":{ "type":"string", "max":511, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "XmlStringMaxLen64":{ "type":"string", "max":64, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "XmlStringUserData":{ "type":"string", "max":21847, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" } }, "documentation":"Auto Scaling

Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service in conjunction with the Amazon CloudWatch and Elastic Load Balancing services.

" } botocore-1.5.7/botocore/data/polly/0000777454262600001440000000000013042511307020272 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/polly/2016-06-10/0000777454262600001440000000000013042511307021323 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/polly/2016-06-10/service-2.json0000666454262600001440000005660513042511306024030 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-06-10", "endpointPrefix":"polly", "protocol":"rest-json", "serviceFullName":"Amazon Polly", "signatureVersion":"v4", "uid":"polly-2016-06-10" }, "operations":{ "DeleteLexicon":{ "name":"DeleteLexicon", "http":{ "method":"DELETE", "requestUri":"/v1/lexicons/{LexiconName}", "responseCode":200 }, "input":{"shape":"DeleteLexiconInput"}, "output":{"shape":"DeleteLexiconOutput"}, "errors":[ {"shape":"LexiconNotFoundException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the specified pronunciation lexicon stored in an AWS Region. A lexicon which has been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon or ListLexicon APIs.

For more information, see Managing Lexicons.

" }, "DescribeVoices":{ "name":"DescribeVoices", "http":{ "method":"GET", "requestUri":"/v1/voices", "responseCode":200 }, "input":{"shape":"DescribeVoicesInput"}, "output":{"shape":"DescribeVoicesOutput"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Returns the list of voices that are available for use when requesting speech synthesis. Each voice speaks a specified language, is either male or female, and is identified by an ID, which is the ASCII version of the voice name.

When synthesizing speech ( SynthesizeSpeech ), you provide the voice ID for the voice you want from the list of voices returned by DescribeVoices.

For example, you want your news reader application to read news in a specific language, but giving a user the option to choose the voice. Using the DescribeVoices operation you can provide the user with a list of available voices to select from.

You can optionally specify a language code to filter the available voices. For example, if you specify en-US, the operation returns a list of all available US English voices.

This operation requires permissions to perform the polly:DescribeVoices action.

" }, "GetLexicon":{ "name":"GetLexicon", "http":{ "method":"GET", "requestUri":"/v1/lexicons/{LexiconName}", "responseCode":200 }, "input":{"shape":"GetLexiconInput"}, "output":{"shape":"GetLexiconOutput"}, "errors":[ {"shape":"LexiconNotFoundException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see Managing Lexicons.

" }, "ListLexicons":{ "name":"ListLexicons", "http":{ "method":"GET", "requestUri":"/v1/lexicons", "responseCode":200 }, "input":{"shape":"ListLexiconsInput"}, "output":{"shape":"ListLexiconsOutput"}, "errors":[ {"shape":"InvalidNextTokenException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see Managing Lexicons.

" }, "PutLexicon":{ "name":"PutLexicon", "http":{ "method":"PUT", "requestUri":"/v1/lexicons/{LexiconName}", "responseCode":200 }, "input":{"shape":"PutLexiconInput"}, "output":{"shape":"PutLexiconOutput"}, "errors":[ {"shape":"InvalidLexiconException"}, {"shape":"UnsupportedPlsAlphabetException"}, {"shape":"UnsupportedPlsLanguageException"}, {"shape":"LexiconSizeExceededException"}, {"shape":"MaxLexemeLengthExceededException"}, {"shape":"MaxLexiconsNumberExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Stores a pronunciation lexicon in an AWS Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation.

For more information, see Managing Lexicons.

" }, "SynthesizeSpeech":{ "name":"SynthesizeSpeech", "http":{ "method":"POST", "requestUri":"/v1/speech", "responseCode":200 }, "input":{"shape":"SynthesizeSpeechInput"}, "output":{"shape":"SynthesizeSpeechOutput"}, "errors":[ {"shape":"TextLengthExceededException"}, {"shape":"InvalidSampleRateException"}, {"shape":"InvalidSsmlException"}, {"shape":"LexiconNotFoundException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works.

" } }, "shapes":{ "Alphabet":{"type":"string"}, "AudioStream":{ "type":"blob", "streaming":true }, "ContentType":{"type":"string"}, "DeleteLexiconInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"LexiconName", "documentation":"

The name of the lexicon to delete. Must be an existing lexicon in the region.

", "location":"uri", "locationName":"LexiconName" } } }, "DeleteLexiconOutput":{ "type":"structure", "members":{ } }, "DescribeVoicesInput":{ "type":"structure", "members":{ "LanguageCode":{ "shape":"LanguageCode", "documentation":"

The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

", "location":"querystring", "locationName":"LanguageCode" }, "NextToken":{ "shape":"NextToken", "documentation":"

An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.

", "location":"querystring", "locationName":"NextToken" } } }, "DescribeVoicesOutput":{ "type":"structure", "members":{ "Voices":{ "shape":"VoiceList", "documentation":"

A list of voices with their properties.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token to use in the next request to continue the listing of voices. NextToken is returned only if the response is truncated.

" } } }, "ErrorMessage":{"type":"string"}, "Gender":{ "type":"string", "enum":[ "Female", "Male" ] }, "GetLexiconInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"LexiconName", "documentation":"

Name of the lexicon.

", "location":"uri", "locationName":"LexiconName" } } }, "GetLexiconOutput":{ "type":"structure", "members":{ "Lexicon":{ "shape":"Lexicon", "documentation":"

Lexicon object that provides name and the string content of the lexicon.

" }, "LexiconAttributes":{ "shape":"LexiconAttributes", "documentation":"

Metadata of the lexicon, including phonetic alphabetic used, language code, lexicon ARN, number of lexemes defined in the lexicon, and size of lexicon in bytes.

" } } }, "InvalidLexiconException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

Amazon Polly can't find the specified lexicon. Verify that the lexicon's name is spelled correctly, and then try again.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidNextTokenException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The NextToken is invalid. Verify that it's spelled correctly, and then try again.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidSampleRateException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The specified sample rate is not valid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidSsmlException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try again.

", "error":{"httpStatusCode":400}, "exception":true }, "LanguageCode":{ "type":"string", "enum":[ "cy-GB", "da-DK", "de-DE", "en-AU", "en-GB", "en-GB-WLS", "en-IN", "en-US", "es-ES", "es-US", "fr-CA", "fr-FR", "is-IS", "it-IT", "ja-JP", "nb-NO", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ro-RO", "ru-RU", "sv-SE", "tr-TR" ] }, "LanguageName":{"type":"string"}, "LastModified":{"type":"timestamp"}, "LexemesCount":{"type":"integer"}, "Lexicon":{ "type":"structure", "members":{ "Content":{ "shape":"LexiconContent", "documentation":"

Lexicon content in string format. The content of a lexicon must be in PLS format.

" }, "Name":{ "shape":"LexiconName", "documentation":"

Name of the lexicon.

" } }, "documentation":"

Provides lexicon name and lexicon content in string format. For more information, see Pronunciation Lexicon Specification (PLS) Version 1.0.

" }, "LexiconArn":{"type":"string"}, "LexiconAttributes":{ "type":"structure", "members":{ "Alphabet":{ "shape":"Alphabet", "documentation":"

Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa.

" }, "LanguageCode":{ "shape":"LanguageCode", "documentation":"

Language code that the lexicon applies to. A lexicon with a language code such as \"en\" would be applied to all English languages (en-GB, en-US, en-AUS, en-WLS, and so on.

" }, "LastModified":{ "shape":"LastModified", "documentation":"

Date lexicon was last modified (a timestamp value).

" }, "LexiconArn":{ "shape":"LexiconArn", "documentation":"

Amazon Resource Name (ARN) of the lexicon.

" }, "LexemesCount":{ "shape":"LexemesCount", "documentation":"

Number of lexemes in the lexicon.

" }, "Size":{ "shape":"Size", "documentation":"

Total size of the lexicon, in characters.

" } }, "documentation":"

Contains metadata describing the lexicon such as the number of lexemes, language code, and so on. For more information, see Managing Lexicons.

" }, "LexiconContent":{"type":"string"}, "LexiconDescription":{ "type":"structure", "members":{ "Name":{ "shape":"LexiconName", "documentation":"

Name of the lexicon.

" }, "Attributes":{ "shape":"LexiconAttributes", "documentation":"

Provides lexicon metadata.

" } }, "documentation":"

Describes the content of the lexicon.

" }, "LexiconDescriptionList":{ "type":"list", "member":{"shape":"LexiconDescription"} }, "LexiconName":{ "type":"string", "pattern":"[0-9A-Za-z]{1,20}", "sensitive":true }, "LexiconNameList":{ "type":"list", "member":{"shape":"LexiconName"}, "max":5 }, "LexiconNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its name is misspelled or specifying a lexicon that is in a different region.

Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.

", "error":{"httpStatusCode":404}, "exception":true }, "LexiconSizeExceededException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The maximum size of the specified lexicon would be exceeded by this operation.

", "error":{"httpStatusCode":400}, "exception":true }, "ListLexiconsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

An opaque pagination token returned from previous ListLexicons operation. If present, indicates where to continue the list of lexicons.

", "location":"querystring", "locationName":"NextToken" } } }, "ListLexiconsOutput":{ "type":"structure", "members":{ "Lexicons":{ "shape":"LexiconDescriptionList", "documentation":"

A list of lexicon names and attributes.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token to use in the next request to continue the listing of lexicons. NextToken is returned only if the response is truncated.

" } } }, "MaxLexemeLengthExceededException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The maximum size of the lexeme would be exceeded by this operation.

", "error":{"httpStatusCode":400}, "exception":true }, "MaxLexiconsNumberExceededException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The maximum number of lexicons would be exceeded by this operation.

", "error":{"httpStatusCode":400}, "exception":true }, "NextToken":{"type":"string"}, "OutputFormat":{ "type":"string", "enum":[ "mp3", "ogg_vorbis", "pcm" ] }, "PutLexiconInput":{ "type":"structure", "required":[ "Name", "Content" ], "members":{ "Name":{ "shape":"LexiconName", "documentation":"

Name of the lexicon. The name must follow the regular express format [0-9A-Za-z]{1,20}. That is, the name is a case-sensitive alphanumeric string up to 20 characters long.

", "location":"uri", "locationName":"LexiconName" }, "Content":{ "shape":"LexiconContent", "documentation":"

Content of the PLS lexicon as string data.

" } } }, "PutLexiconOutput":{ "type":"structure", "members":{ } }, "RequestCharacters":{"type":"integer"}, "SampleRate":{"type":"string"}, "ServiceFailureException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

An unknown condition has caused a service failure.

", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "Size":{"type":"integer"}, "SynthesizeSpeechInput":{ "type":"structure", "required":[ "OutputFormat", "Text", "VoiceId" ], "members":{ "LexiconNames":{ "shape":"LexiconNameList", "documentation":"

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see PutLexicon.

" }, "OutputFormat":{ "shape":"OutputFormat", "documentation":"

The audio format in which the resulting stream will be encoded.

" }, "SampleRate":{ "shape":"SampleRate", "documentation":"

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", and \"22050\". The default value is \"22050\".

Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".

" }, "Text":{ "shape":"Text", "documentation":"

Input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

" }, "TextType":{ "shape":"TextType", "documentation":"

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

" }, "VoiceId":{ "shape":"VoiceId", "documentation":"

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

" } } }, "SynthesizeSpeechOutput":{ "type":"structure", "members":{ "AudioStream":{ "shape":"AudioStream", "documentation":"

Stream containing the synthesized speech.

" }, "ContentType":{ "shape":"ContentType", "documentation":"

Specifies the type audio stream. This should reflect the OutputFormat parameter in your request.

  • If you request mp3 as the OutputFormat, the ContentType returned is audio/mpeg.

  • If you request ogg_vorbis as the OutputFormat, the ContentType returned is audio/ogg.

  • If you request pcm as the OutputFormat, the ContentType returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

", "location":"header", "locationName":"Content-Type" }, "RequestCharacters":{ "shape":"RequestCharacters", "documentation":"

Number of characters synthesized.

", "location":"header", "locationName":"x-amzn-RequestCharacters" } }, "payload":"AudioStream" }, "Text":{"type":"string"}, "TextLengthExceededException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The value of the \"Text\" parameter is longer than the accepted limits. The limit for input text is a maximum of 3000 characters total, of which no more than 1500 can be billed characters. SSML tags are not counted as billed characters.

", "error":{"httpStatusCode":400}, "exception":true }, "TextType":{ "type":"string", "enum":[ "ssml", "text" ] }, "UnsupportedPlsAlphabetException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The alphabet specified by the lexicon is not a supported alphabet. Valid values are x-sampa and ipa.

", "error":{"httpStatusCode":400}, "exception":true }, "UnsupportedPlsLanguageException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The language specified in the lexicon is unsupported. For a list of supported languages, see Lexicon Attributes.

", "error":{"httpStatusCode":400}, "exception":true }, "Voice":{ "type":"structure", "members":{ "Gender":{ "shape":"Gender", "documentation":"

Gender of the voice.

" }, "Id":{ "shape":"VoiceId", "documentation":"

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

" }, "LanguageCode":{ "shape":"LanguageCode", "documentation":"

Language code of the voice.

" }, "LanguageName":{ "shape":"LanguageName", "documentation":"

Human readable name of the language in English.

" }, "Name":{ "shape":"VoiceName", "documentation":"

Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

" } }, "documentation":"

Description of the voice.

" }, "VoiceId":{ "type":"string", "enum":[ "Geraint", "Gwyneth", "Mads", "Naja", "Hans", "Marlene", "Nicole", "Russell", "Amy", "Brian", "Emma", "Raveena", "Ivy", "Joanna", "Joey", "Justin", "Kendra", "Kimberly", "Salli", "Conchita", "Enrique", "Miguel", "Penelope", "Chantal", "Celine", "Mathieu", "Dora", "Karl", "Carla", "Giorgio", "Mizuki", "Liv", "Lotte", "Ruben", "Ewa", "Jacek", "Jan", "Maja", "Ricardo", "Vitoria", "Cristiano", "Ines", "Carmen", "Maxim", "Tatyana", "Astrid", "Filiz" ] }, "VoiceList":{ "type":"list", "member":{"shape":"Voice"} }, "VoiceName":{"type":"string"} }, "documentation":"

Amazon Polly is a web service that makes it easy to synthesize speech from text.

The Amazon Polly service provides API operations for synthesizing high-quality speech from plain text and Speech Synthesis Markup Language (SSML), along with managing pronunciations lexicons that enable you to get the best results for your application domain.

" } botocore-1.5.7/botocore/data/route53/0000777454262600001440000000000013042511307020441 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/route53/2013-04-01/0000777454262600001440000000000013042511307021465 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/route53/2013-04-01/waiters-2.json0000666454262600001440000000052213042511306024173 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "ResourceRecordSetsChanged": { "delay": 30, "maxAttempts": 60, "operation": "GetChange", "acceptors": [ { "matcher": "path", "expected": "INSYNC", "argument": "ChangeInfo.Status", "state": "success" } ] } } } botocore-1.5.7/botocore/data/route53/2013-04-01/paginators-1.json0000666454262600001440000000145313042511306024667 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListHealthChecks": { "input_token": "Marker", "output_token": "NextMarker", "more_results": "IsTruncated", "limit_key": "MaxItems", "result_key": "HealthChecks" }, "ListHostedZones": { "input_token": "Marker", "output_token": "NextMarker", "more_results": "IsTruncated", "limit_key": "MaxItems", "result_key": "HostedZones" }, "ListResourceRecordSets": { "more_results": "IsTruncated", "limit_key": "MaxItems", "result_key": "ResourceRecordSets", "input_token": [ "StartRecordName", "StartRecordType", "StartRecordIdentifier" ], "output_token": [ "NextRecordName", "NextRecordType", "NextRecordIdentifier" ] } } } botocore-1.5.7/botocore/data/route53/2013-04-01/service-2.json0000666454262600001440000114011113042511306024155 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2013-04-01", "endpointPrefix":"route53", "globalEndpoint":"route53.amazonaws.com", "protocol":"rest-xml", "serviceAbbreviation":"Route 53", "serviceFullName":"Amazon Route 53", "signatureVersion":"v4", "uid":"route53-2013-04-01" }, "operations":{ "AssociateVPCWithHostedZone":{ "name":"AssociateVPCWithHostedZone", "http":{ "method":"POST", "requestUri":"/2013-04-01/hostedzone/{Id}/associatevpc" }, "input":{ "shape":"AssociateVPCWithHostedZoneRequest", "locationName":"AssociateVPCWithHostedZoneRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"AssociateVPCWithHostedZoneResponse"}, "errors":[ {"shape":"NoSuchHostedZone"}, {"shape":"NotAuthorizedException"}, {"shape":"InvalidVPCId"}, {"shape":"InvalidInput"}, {"shape":"PublicZoneVPCAssociation"}, {"shape":"ConflictingDomainExists"}, {"shape":"LimitsExceeded"} ], "documentation":"

Associates an Amazon VPC with a private hosted zone.

To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.

Send a POST request to the /2013-04-01/hostedzone/hosted zone ID/associatevpc resource. The request body must include a document with an AssociateVPCWithHostedZoneRequest element. The response contains a ChangeInfo data type that you can use to track the progress of the request.

If you want to associate a VPC that was created by using one AWS account with a private hosted zone that was created by using a different account, the AWS account that created the private hosted zone must first submit a CreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an AssociateVPCWithHostedZone request.

" }, "ChangeResourceRecordSets":{ "name":"ChangeResourceRecordSets", "http":{ "method":"POST", "requestUri":"/2013-04-01/hostedzone/{Id}/rrset/" }, "input":{ "shape":"ChangeResourceRecordSetsRequest", "locationName":"ChangeResourceRecordSetsRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"ChangeResourceRecordSetsResponse"}, "errors":[ {"shape":"NoSuchHostedZone"}, {"shape":"NoSuchHealthCheck"}, {"shape":"InvalidChangeBatch"}, {"shape":"InvalidInput"}, {"shape":"PriorRequestNotComplete"} ], "documentation":"

Create, change, update, or delete authoritative DNS information on all Amazon Route 53 servers. Send a POST request to:

/2013-04-01/hostedzone/Amazon Route 53 hosted Zone ID/rrset resource.

The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. When using the Amazon Route 53 API to change resource record sets, Amazon Route 53 either makes all or none of the changes in a change batch request. This ensures that Amazon Route 53 never partially implements the intended changes to the resource record sets in a hosted zone.

For example, a change batch request that deletes the CNAME record for www.example.com and creates an alias resource record set for www.example.com. Amazon Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If either the DELETE or the CREATE action fails, then both changes (plus any other changes in the batch) fail, and the original CNAME record continues to exist.

Due to the nature of transactional changes, you can't 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, Amazon Route 53 returns an InvalidChangeBatch error.

To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Amazon Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide.

Use ChangeResourceRecordsSetsRequest to perform the following actions:

  • CREATE: Creates a resource record set that has the specified values.

  • DELETE: Deletes an existing resource record set that has the specified values.

  • UPSERT: If a resource record set does not already exist, AWS creates it. If a resource set does exist, Amazon Route 53 updates it with the values in the request.

The values that you need to include in the request depend on the type of resource record set that you're creating, deleting, or updating:

Basic resource record sets (excluding alias, failover, geolocation, latency, and weighted resource record sets)

  • Name

  • Type

  • TTL

Failover, geolocation, latency, or weighted resource record sets (excluding alias resource record sets)

  • Name

  • Type

  • TTL

  • SetIdentifier

Alias resource record sets (including failover alias, geolocation alias, latency alias, and weighted alias resource record sets)

  • Name

  • Type

  • AliasTarget (includes DNSName, EvaluateTargetHealth, and HostedZoneId)

  • SetIdentifier (for failover, geolocation, latency, and weighted resource record sets)

When you submit a ChangeResourceRecordSets request, Amazon Route 53 propagates your changes to all of the Amazon Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Amazon Route 53 name servers in a few minutes. In rare circumstances, propagation can take up to 30 minutes. For more information, see GetChange

For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide.

" }, "ChangeTagsForResource":{ "name":"ChangeTagsForResource", "http":{ "method":"POST", "requestUri":"/2013-04-01/tags/{ResourceType}/{ResourceId}" }, "input":{ "shape":"ChangeTagsForResourceRequest", "locationName":"ChangeTagsForResourceRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"ChangeTagsForResourceResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"NoSuchHealthCheck"}, {"shape":"NoSuchHostedZone"}, {"shape":"PriorRequestNotComplete"}, {"shape":"ThrottlingException"} ], "documentation":"

Adds, edits, or deletes tags for a health check or a hosted zone.

For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

" }, "CreateHealthCheck":{ "name":"CreateHealthCheck", "http":{ "method":"POST", "requestUri":"/2013-04-01/healthcheck", "responseCode":201 }, "input":{ "shape":"CreateHealthCheckRequest", "locationName":"CreateHealthCheckRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"CreateHealthCheckResponse"}, "errors":[ {"shape":"TooManyHealthChecks"}, {"shape":"HealthCheckAlreadyExists"}, {"shape":"InvalidInput"} ], "documentation":"

Creates a new health check.

To create a new health check, send a POST request to the /2013-04-01/healthcheck resource. The request body must include a document with a CreateHealthCheckRequest element. The response returns the CreateHealthCheckResponse element, containing the health check ID specified when adding health check to a resource record set. For information about adding health checks to resource record sets, see ResourceRecordSet$HealthCheckId in ChangeResourceRecordSets.

If you are registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to an Amazon Route 53 health check.

You can associate health checks with failover resource record sets in a private hosted zone. Note the following:

  • Amazon Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.

  • You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.

  • You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide.

" }, "CreateHostedZone":{ "name":"CreateHostedZone", "http":{ "method":"POST", "requestUri":"/2013-04-01/hostedzone", "responseCode":201 }, "input":{ "shape":"CreateHostedZoneRequest", "locationName":"CreateHostedZoneRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"CreateHostedZoneResponse"}, "errors":[ {"shape":"InvalidDomainName"}, {"shape":"HostedZoneAlreadyExists"}, {"shape":"TooManyHostedZones"}, {"shape":"InvalidVPCId"}, {"shape":"InvalidInput"}, {"shape":"DelegationSetNotAvailable"}, {"shape":"ConflictingDomainExists"}, {"shape":"NoSuchDelegationSet"}, {"shape":"DelegationSetNotReusable"} ], "documentation":"

Creates a new public hosted zone, used to specify how the Domain Name System (DNS) routes traffic on the Internet for a domain, such as example.com, and its subdomains.

Public hosted zones can't be converted to a private hosted zone or vice versa. Instead, create a new hosted zone with the same name and create new resource record sets.

Send a POST request to the /2013-04-01/hostedzone resource. The request body must include a document with a CreateHostedZoneRequest element. The response returns the CreateHostedZoneResponse element containing metadata about the hosted zone.

Fore more information about charges for hosted zones, see Amazon Route 53 Pricing.

Note the following:

  • You can't create a hosted zone for a top-level domain (TLD).

  • Amazon Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Amazon Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.

  • If your domain is registered with a registrar other than Amazon Route 53, you must update the name servers with your registrar to make Amazon Route 53 your DNS service. For more information, see Configuring Amazon Route 53 as your DNS Service in the Amazon Route 53 Developer's Guide.

After creating 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 Amazon Route 53 DNS servers.

When trying to create a hosted zone using a reusable delegation set, specify an optional DelegationSetId, and Amazon Route 53 would assign those 4 NS records for the zone, instead of allotting a new one.

" }, "CreateReusableDelegationSet":{ "name":"CreateReusableDelegationSet", "http":{ "method":"POST", "requestUri":"/2013-04-01/delegationset", "responseCode":201 }, "input":{ "shape":"CreateReusableDelegationSetRequest", "locationName":"CreateReusableDelegationSetRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"CreateReusableDelegationSetResponse"}, "errors":[ {"shape":"DelegationSetAlreadyCreated"}, {"shape":"LimitsExceeded"}, {"shape":"HostedZoneNotFound"}, {"shape":"InvalidArgument"}, {"shape":"InvalidInput"}, {"shape":"DelegationSetNotAvailable"}, {"shape":"DelegationSetAlreadyReusable"} ], "documentation":"

Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones. If a hosted zoned ID is specified, CreateReusableDelegationSet marks the delegation set associated with that zone as reusable

Send a POST request to the /2013-04-01/delegationset resource. The request body must include a document with a CreateReusableDelegationSetRequest element.

A reusable delegation set can't be associated with a private hosted zone/

For more information, including a procedure on how to create and configure a reusable delegation set (also known as white label name servers), see Configuring White Label Name Servers.

" }, "CreateTrafficPolicy":{ "name":"CreateTrafficPolicy", "http":{ "method":"POST", "requestUri":"/2013-04-01/trafficpolicy", "responseCode":201 }, "input":{ "shape":"CreateTrafficPolicyRequest", "locationName":"CreateTrafficPolicyRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"CreateTrafficPolicyResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"TooManyTrafficPolicies"}, {"shape":"TrafficPolicyAlreadyExists"}, {"shape":"InvalidTrafficPolicyDocument"} ], "documentation":"

Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).

Send a POST request to the /2013-04-01/trafficpolicy resource. The request body must include a document with a CreateTrafficPolicyRequest element. The response includes the CreateTrafficPolicyResponse element, which contains information about the new traffic policy.

" }, "CreateTrafficPolicyInstance":{ "name":"CreateTrafficPolicyInstance", "http":{ "method":"POST", "requestUri":"/2013-04-01/trafficpolicyinstance", "responseCode":201 }, "input":{ "shape":"CreateTrafficPolicyInstanceRequest", "locationName":"CreateTrafficPolicyInstanceRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"CreateTrafficPolicyInstanceResponse"}, "errors":[ {"shape":"NoSuchHostedZone"}, {"shape":"InvalidInput"}, {"shape":"TooManyTrafficPolicyInstances"}, {"shape":"NoSuchTrafficPolicy"}, {"shape":"TrafficPolicyInstanceAlreadyExists"} ], "documentation":"

Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created.

Send a POST request to the /2013-04-01/trafficpolicyinstance resource. The request body must include a document with a CreateTrafficPolicyRequest element. The response returns the CreateTrafficPolicyInstanceResponse element, which contains information about the traffic policy instance.

" }, "CreateTrafficPolicyVersion":{ "name":"CreateTrafficPolicyVersion", "http":{ "method":"POST", "requestUri":"/2013-04-01/trafficpolicy/{Id}", "responseCode":201 }, "input":{ "shape":"CreateTrafficPolicyVersionRequest", "locationName":"CreateTrafficPolicyVersionRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"CreateTrafficPolicyVersionResponse"}, "errors":[ {"shape":"NoSuchTrafficPolicy"}, {"shape":"InvalidInput"}, {"shape":"ConcurrentModification"}, {"shape":"InvalidTrafficPolicyDocument"} ], "documentation":"

Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy.

Send a POST request to the /2013-04-01/trafficpolicy/ resource. The request body includes a document with a CreateTrafficPolicyVersionRequest element. The response returns the CreateTrafficPolicyVersionResponse element, which contains information about the new version of the traffic policy.

" }, "CreateVPCAssociationAuthorization":{ "name":"CreateVPCAssociationAuthorization", "http":{ "method":"POST", "requestUri":"/2013-04-01/hostedzone/{Id}/authorizevpcassociation" }, "input":{ "shape":"CreateVPCAssociationAuthorizationRequest", "locationName":"CreateVPCAssociationAuthorizationRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"CreateVPCAssociationAuthorizationResponse"}, "errors":[ {"shape":"TooManyVPCAssociationAuthorizations"}, {"shape":"NoSuchHostedZone"}, {"shape":"InvalidVPCId"}, {"shape":"InvalidInput"} ], "documentation":"

Authorizes the AWS account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request.

If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC.

Send a POST request to the /2013-04-01/hostedzone/hosted zone ID/authorizevpcassociation resource. The request body must include a document with a CreateVPCAssociationAuthorizationRequest element. The response contains information about the authorization.

" }, "DeleteHealthCheck":{ "name":"DeleteHealthCheck", "http":{ "method":"DELETE", "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}" }, "input":{"shape":"DeleteHealthCheckRequest"}, "output":{"shape":"DeleteHealthCheckResponse"}, "errors":[ {"shape":"NoSuchHealthCheck"}, {"shape":"HealthCheckInUse"}, {"shape":"InvalidInput"} ], "documentation":"

Deletes a health check. Send a DELETE request to the /2013-04-01/healthcheck/health check ID resource.

Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide.

" }, "DeleteHostedZone":{ "name":"DeleteHostedZone", "http":{ "method":"DELETE", "requestUri":"/2013-04-01/hostedzone/{Id}" }, "input":{"shape":"DeleteHostedZoneRequest"}, "output":{"shape":"DeleteHostedZoneResponse"}, "errors":[ {"shape":"NoSuchHostedZone"}, {"shape":"HostedZoneNotEmpty"}, {"shape":"PriorRequestNotComplete"}, {"shape":"InvalidInput"}, {"shape":"InvalidDomainName"} ], "documentation":"

Deletes a hosted zone. Send a DELETE request to the /Amazon Route 53 API version/hostedzone/hosted zone ID resource.

Delete a hosted zone only if there are no resource record sets other than the default SOA record and NS resource record sets. If the hosted zone contains other resource record sets, delete them before deleting the hosted zone. If you try to delete a hosted zone that contains other resource record sets, Amazon Route 53 denies your request with a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets.

" }, "DeleteReusableDelegationSet":{ "name":"DeleteReusableDelegationSet", "http":{ "method":"DELETE", "requestUri":"/2013-04-01/delegationset/{Id}" }, "input":{"shape":"DeleteReusableDelegationSetRequest"}, "output":{"shape":"DeleteReusableDelegationSetResponse"}, "errors":[ {"shape":"NoSuchDelegationSet"}, {"shape":"DelegationSetInUse"}, {"shape":"DelegationSetNotReusable"}, {"shape":"InvalidInput"} ], "documentation":"

Deletes a reusable delegation set. Send a DELETE request to the /2013-04-01/delegationset/delegation set ID resource.

You can delete a reusable delegation set only if there are no associated hosted zones.

To verify that the reusable delegation set is not associated with any hosted zones, run the GetReusableDelegationSet action and specify the ID of the reusable delegation set that you want to delete.

" }, "DeleteTrafficPolicy":{ "name":"DeleteTrafficPolicy", "http":{ "method":"DELETE", "requestUri":"/2013-04-01/trafficpolicy/{Id}/{Version}" }, "input":{"shape":"DeleteTrafficPolicyRequest"}, "output":{"shape":"DeleteTrafficPolicyResponse"}, "errors":[ {"shape":"NoSuchTrafficPolicy"}, {"shape":"InvalidInput"}, {"shape":"TrafficPolicyInUse"}, {"shape":"ConcurrentModification"} ], "documentation":"

Deletes a traffic policy.

Send a DELETE request to the /Amazon Route 53 API version/trafficpolicy resource.

" }, "DeleteTrafficPolicyInstance":{ "name":"DeleteTrafficPolicyInstance", "http":{ "method":"DELETE", "requestUri":"/2013-04-01/trafficpolicyinstance/{Id}" }, "input":{"shape":"DeleteTrafficPolicyInstanceRequest"}, "output":{"shape":"DeleteTrafficPolicyInstanceResponse"}, "errors":[ {"shape":"NoSuchTrafficPolicyInstance"}, {"shape":"InvalidInput"}, {"shape":"PriorRequestNotComplete"} ], "documentation":"

Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.

Send a DELETE request to the /Amazon Route 53 API version/trafficpolicy/traffic policy instance ID resource.

In the Amazon Route 53 console, traffic policy instances are known as policy records.

" }, "DeleteVPCAssociationAuthorization":{ "name":"DeleteVPCAssociationAuthorization", "http":{ "method":"POST", "requestUri":"/2013-04-01/hostedzone/{Id}/deauthorizevpcassociation" }, "input":{ "shape":"DeleteVPCAssociationAuthorizationRequest", "locationName":"DeleteVPCAssociationAuthorizationRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"DeleteVPCAssociationAuthorizationResponse"}, "errors":[ {"shape":"VPCAssociationAuthorizationNotFound"}, {"shape":"NoSuchHostedZone"}, {"shape":"InvalidVPCId"}, {"shape":"InvalidInput"} ], "documentation":"

Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a DeleteVPCAssociationAuthorization request.

Sending this request only prevents the AWS account that created the VPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone, DeleteVPCAssociationAuthorization won't disassociate the VPC from the hosted zone. If you want to delete an existing association, use DisassociateVPCFromHostedZone.

Send a DELETE request to the /2013-04-01/hostedzone/hosted zone ID/deauthorizevpcassociation resource. The request body must include a document with a DeleteVPCAssociationAuthorizationRequest element.

" }, "DisassociateVPCFromHostedZone":{ "name":"DisassociateVPCFromHostedZone", "http":{ "method":"POST", "requestUri":"/2013-04-01/hostedzone/{Id}/disassociatevpc" }, "input":{ "shape":"DisassociateVPCFromHostedZoneRequest", "locationName":"DisassociateVPCFromHostedZoneRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"DisassociateVPCFromHostedZoneResponse"}, "errors":[ {"shape":"NoSuchHostedZone"}, {"shape":"InvalidVPCId"}, {"shape":"VPCAssociationNotFound"}, {"shape":"LastVPCAssociation"}, {"shape":"InvalidInput"} ], "documentation":"

Disassociates a VPC from a Amazon Route 53 private hosted zone.

You can't disassociate the last VPC from a private hosted zone.

Send a POST request to the /2013-04-01/hostedzone/hosted zone ID/disassociatevpc resource. The request body must include a document with a DisassociateVPCFromHostedZoneRequest element. The response includes a DisassociateVPCFromHostedZoneResponse element.

You can't disassociate a VPC from a private hosted zone when only one VPC is associated with the hosted zone. You also can't convert a private hosted zone into a public hosted zone.

" }, "GetChange":{ "name":"GetChange", "http":{ "method":"GET", "requestUri":"/2013-04-01/change/{Id}" }, "input":{"shape":"GetChangeRequest"}, "output":{"shape":"GetChangeResponse"}, "errors":[ {"shape":"NoSuchChange"}, {"shape":"InvalidInput"} ], "documentation":"

Returns the current status of a change batch request. The status is one of the following values:

  • PENDING indicates that the changes in this request have not replicated to all Amazon Route 53 DNS servers. This is the initial status of all change batch requests.

  • INSYNC indicates that the changes have replicated to all Amazon Route 53 DNS servers.

" }, "GetCheckerIpRanges":{ "name":"GetCheckerIpRanges", "http":{ "method":"GET", "requestUri":"/2013-04-01/checkeripranges" }, "input":{"shape":"GetCheckerIpRangesRequest"}, "output":{"shape":"GetCheckerIpRangesResponse"}, "documentation":"

Retrieves a list of the IP ranges used by Amazon Route 53 health checkers to check the health of your resources. Send a GET request to the /Amazon Route 53 API version/checkeripranges resource. Use these IP addresses to configure router and firewall rules to allow health checkers to check the health of your resources.

" }, "GetGeoLocation":{ "name":"GetGeoLocation", "http":{ "method":"GET", "requestUri":"/2013-04-01/geolocation" }, "input":{"shape":"GetGeoLocationRequest"}, "output":{"shape":"GetGeoLocationResponse"}, "errors":[ {"shape":"NoSuchGeoLocation"}, {"shape":"InvalidInput"} ], "documentation":"

Retrieves a single geo location. Send a GET request to the /2013-04-01/geolocation resource with one of these options: continentcode | countrycode | countrycode and subdivisioncode.

" }, "GetHealthCheck":{ "name":"GetHealthCheck", "http":{ "method":"GET", "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}" }, "input":{"shape":"GetHealthCheckRequest"}, "output":{"shape":"GetHealthCheckResponse"}, "errors":[ {"shape":"NoSuchHealthCheck"}, {"shape":"InvalidInput"}, {"shape":"IncompatibleVersion"} ], "documentation":"

Gets information about a specified health check. Send a GET request to the /2013-04-01/healthcheck/health check ID resource. For more information about using the console to perform this operation, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

" }, "GetHealthCheckCount":{ "name":"GetHealthCheckCount", "http":{ "method":"GET", "requestUri":"/2013-04-01/healthcheckcount" }, "input":{"shape":"GetHealthCheckCountRequest"}, "output":{"shape":"GetHealthCheckCountResponse"}, "documentation":"

To retrieve a count of all your health checks, send a GET request to the /2013-04-01/healthcheckcount resource.

" }, "GetHealthCheckLastFailureReason":{ "name":"GetHealthCheckLastFailureReason", "http":{ "method":"GET", "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}/lastfailurereason" }, "input":{"shape":"GetHealthCheckLastFailureReasonRequest"}, "output":{"shape":"GetHealthCheckLastFailureReasonResponse"}, "errors":[ {"shape":"NoSuchHealthCheck"}, {"shape":"InvalidInput"} ], "documentation":"

If you want to learn why a health check is currently failing or why it failed most recently (if at all), you can get the failure reason for the most recent failure. Send a GET request to the /Amazon Route 53 API version/healthcheck/health check ID/lastfailurereason resource.

" }, "GetHealthCheckStatus":{ "name":"GetHealthCheckStatus", "http":{ "method":"GET", "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}/status" }, "input":{"shape":"GetHealthCheckStatusRequest"}, "output":{"shape":"GetHealthCheckStatusResponse"}, "errors":[ {"shape":"NoSuchHealthCheck"}, {"shape":"InvalidInput"} ], "documentation":"

Gets status of a specified health check. Send a GET request to the /2013-04-01/healthcheck/health check ID/status resource. You can use this call to get a health check's current status.

" }, "GetHostedZone":{ "name":"GetHostedZone", "http":{ "method":"GET", "requestUri":"/2013-04-01/hostedzone/{Id}" }, "input":{"shape":"GetHostedZoneRequest"}, "output":{"shape":"GetHostedZoneResponse"}, "errors":[ {"shape":"NoSuchHostedZone"}, {"shape":"InvalidInput"} ], "documentation":"

Retrieves the delegation set for a hosted zone, including the four name servers assigned to the hosted zone. Send a GET request to the /Amazon Route 53 API version/hostedzone/hosted zone ID resource.

" }, "GetHostedZoneCount":{ "name":"GetHostedZoneCount", "http":{ "method":"GET", "requestUri":"/2013-04-01/hostedzonecount" }, "input":{"shape":"GetHostedZoneCountRequest"}, "output":{"shape":"GetHostedZoneCountResponse"}, "errors":[ {"shape":"InvalidInput"} ], "documentation":"

Retrieves a count of all your hosted zones. Send a GET request to the /2013-04-01/hostedzonecount resource.

" }, "GetReusableDelegationSet":{ "name":"GetReusableDelegationSet", "http":{ "method":"GET", "requestUri":"/2013-04-01/delegationset/{Id}" }, "input":{"shape":"GetReusableDelegationSetRequest"}, "output":{"shape":"GetReusableDelegationSetResponse"}, "errors":[ {"shape":"NoSuchDelegationSet"}, {"shape":"DelegationSetNotReusable"}, {"shape":"InvalidInput"} ], "documentation":"

Retrieves the reusable delegation set. Send a GET request to the /2013-04-01/delegationset/delegation set ID resource.

" }, "GetTrafficPolicy":{ "name":"GetTrafficPolicy", "http":{ "method":"GET", "requestUri":"/2013-04-01/trafficpolicy/{Id}/{Version}" }, "input":{"shape":"GetTrafficPolicyRequest"}, "output":{"shape":"GetTrafficPolicyResponse"}, "errors":[ {"shape":"NoSuchTrafficPolicy"}, {"shape":"InvalidInput"} ], "documentation":"

Gets information about a specific traffic policy version.

Send a GET request to the /Amazon Route 53 API version/trafficpolicy resource.

" }, "GetTrafficPolicyInstance":{ "name":"GetTrafficPolicyInstance", "http":{ "method":"GET", "requestUri":"/2013-04-01/trafficpolicyinstance/{Id}" }, "input":{"shape":"GetTrafficPolicyInstanceRequest"}, "output":{"shape":"GetTrafficPolicyInstanceResponse"}, "errors":[ {"shape":"NoSuchTrafficPolicyInstance"}, {"shape":"InvalidInput"} ], "documentation":"

Gets information about a specified traffic policy instance.

Send a GET request to the /Amazon Route 53 API version/trafficpolicyinstance resource.

After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

In the Amazon Route 53 console, traffic policy instances are known as policy records.

" }, "GetTrafficPolicyInstanceCount":{ "name":"GetTrafficPolicyInstanceCount", "http":{ "method":"GET", "requestUri":"/2013-04-01/trafficpolicyinstancecount" }, "input":{"shape":"GetTrafficPolicyInstanceCountRequest"}, "output":{"shape":"GetTrafficPolicyInstanceCountResponse"}, "documentation":"

Gets the number of traffic policy instances that are associated with the current AWS account.

To get the number of traffic policy instances, send a GET request to the /2013-04-01/trafficpolicyinstancecount resource.

" }, "ListGeoLocations":{ "name":"ListGeoLocations", "http":{ "method":"GET", "requestUri":"/2013-04-01/geolocations" }, "input":{"shape":"ListGeoLocationsRequest"}, "output":{"shape":"ListGeoLocationsResponse"}, "errors":[ {"shape":"InvalidInput"} ], "documentation":"

Retrieves a list of supported geo locations. Send a GET request to the /2013-04-01/geolocations resource. The response to this request includes a GeoLocationDetailsList element for each location that Amazon Route 53 supports.

Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country.

" }, "ListHealthChecks":{ "name":"ListHealthChecks", "http":{ "method":"GET", "requestUri":"/2013-04-01/healthcheck" }, "input":{"shape":"ListHealthChecksRequest"}, "output":{"shape":"ListHealthChecksResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"IncompatibleVersion"} ], "documentation":"

Retrieve a list of your health checks. Send a GET request to the /2013-04-01/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.

For information about listing health checks using the Amazon Route 53 console, see Amazon Route 53 Health Checks and DNS Failover.

" }, "ListHostedZones":{ "name":"ListHostedZones", "http":{ "method":"GET", "requestUri":"/2013-04-01/hostedzone" }, "input":{"shape":"ListHostedZonesRequest"}, "output":{"shape":"ListHostedZonesResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"NoSuchDelegationSet"}, {"shape":"DelegationSetNotReusable"} ], "documentation":"

To retrieve a list of your public and private hosted zones, send a GET request to the /2013-04-01/hostedzone resource. The response to this request includes a HostedZones child element for each hosted zone created by the current AWS account.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the maxitems parameter to list them in groups of up to 100. The response includes four values that help navigate from one group of maxitems hosted zones to the next:

  • MaxItems is the value specified for the maxitems parameter in the request that produced the current response.

  • If the value of IsTruncated in the response is true, there are more hosted zones associated with the current AWS account.

  • NextMarker is the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to ListHostedZones, and specify the value of the NextMarker element in the marker parameter.

    If IsTruncated is false, the NextMarker element is omitted from the response.

  • If you're making the second or subsequent call to ListHostedZones, the Marker element matches the value that you specified in the marker parameter in the previous request.

" }, "ListHostedZonesByName":{ "name":"ListHostedZonesByName", "http":{ "method":"GET", "requestUri":"/2013-04-01/hostedzonesbyname" }, "input":{"shape":"ListHostedZonesByNameRequest"}, "output":{"shape":"ListHostedZonesByNameResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"InvalidDomainName"} ], "documentation":"

Retrieves a list of your hosted zones in lexicographic order. Send a GET request to the /2013-04-01/hostedzonesbyname resource. The response includes a HostedZones child element for each hosted zone created by the current AWS account.

ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example:

  • com.example.www.

Note the trailing dot, which can change the sort order in some circumstances.

If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for example.com, specify ex\\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as:

  • com.ex\\344mple.

The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

Amazon Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list them in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next:

  • The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the dnsname and hostedzoneid parameters in the request that produced the current response.

  • The MaxItems element in the response contains the value, if any, that you specified for the maxitems parameter in the request that produced the current response.

  • If the value of IsTruncated in the response is true, there are more hosted zones associated with the current AWS account.

    If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. The NextDNSName element and NextHostedZoneId elements are omitted from the response.

  • The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to ListHostedZonesByName, and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

" }, "ListResourceRecordSets":{ "name":"ListResourceRecordSets", "http":{ "method":"GET", "requestUri":"/2013-04-01/hostedzone/{Id}/rrset" }, "input":{"shape":"ListResourceRecordSetsRequest"}, "output":{"shape":"ListResourceRecordSetsResponse"}, "errors":[ {"shape":"NoSuchHostedZone"}, {"shape":"InvalidInput"} ], "documentation":"

Lists the resource record sets in a specified hosted zone.

ListResourceRecordSets returns up to 100 resource record sets at a time in ASCII order, beginning at a position specified by the name and type elements. The action sorts results first by DNS name with the labels reversed, for example:

com.example.www.

Note the trailing dot, which can change the sort order in some circumstances.

When multiple records have the same DNS name, the action sorts results by the record type.

You can use the name and type elements to adjust the beginning position of the list of resource record sets returned:

If you do not specify Name or Type

The results begin with the first resource record set that the hosted zone contains.

If you specify Name but not Type

The results begin with the first resource record set in the list whose name is greater than or equal to Name.

If you specify Type but not Name

Amazon Route 53 returns the InvalidInput error.

If you specify both Name and Type

The results begin with the first resource record set in the list whose name is greater than or equal to Name, and whose type is greater than or equal to Type.

This action returns the most current version of the records. This includes records that are PENDING, and that are not yet available on all Amazon Route 53 DNS servers.

To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a ChangeResourceRecordSets request while you're paging through the results of a ListResourceRecordSets request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes.

" }, "ListReusableDelegationSets":{ "name":"ListReusableDelegationSets", "http":{ "method":"GET", "requestUri":"/2013-04-01/delegationset" }, "input":{"shape":"ListReusableDelegationSetsRequest"}, "output":{"shape":"ListReusableDelegationSetsResponse"}, "errors":[ {"shape":"InvalidInput"} ], "documentation":"

To retrieve a list of your reusable delegation sets, send a GET request to the /2013-04-01/delegationset resource. The response to this request includes a DelegationSets element with zero, one, or multiple DelegationSet child elements. By default, the list of delegation sets 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 delegation set that the list begins with.

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.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/2013-04-01/tags/{ResourceType}/{ResourceId}" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"NoSuchHealthCheck"}, {"shape":"NoSuchHostedZone"}, {"shape":"PriorRequestNotComplete"}, {"shape":"ThrottlingException"} ], "documentation":"

Lists tags for one health check or hosted zone.

For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

" }, "ListTagsForResources":{ "name":"ListTagsForResources", "http":{ "method":"POST", "requestUri":"/2013-04-01/tags/{ResourceType}" }, "input":{ "shape":"ListTagsForResourcesRequest", "locationName":"ListTagsForResourcesRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"ListTagsForResourcesResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"NoSuchHealthCheck"}, {"shape":"NoSuchHostedZone"}, {"shape":"PriorRequestNotComplete"}, {"shape":"ThrottlingException"} ], "documentation":"

Lists tags for up to 10 health checks or hosted zones.

For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

" }, "ListTrafficPolicies":{ "name":"ListTrafficPolicies", "http":{ "method":"GET", "requestUri":"/2013-04-01/trafficpolicies" }, "input":{"shape":"ListTrafficPoliciesRequest"}, "output":{"shape":"ListTrafficPoliciesResponse"}, "errors":[ {"shape":"InvalidInput"} ], "documentation":"

Gets information about the latest version for every traffic policy that is associated with the current AWS account. Send a GET request to the /Amazon Route 53 API version/trafficpolicy resource.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policies, you can use the maxitems parameter to list them in groups of up to 100.

The response includes three values that help you navigate from one group of maxitems traffic policies to the next:

  • IsTruncated

    If the value of IsTruncated in the response is true, there are more traffic policies associated with the current AWS account.

    If IsTruncated is false, this response includes the last traffic policy that is associated with the current account.

  • TrafficPolicyIdMarker

    If IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies. If you want to list more traffic policies, make another call to ListTrafficPolicies, and specify the value of the TrafficPolicyIdMarker element from the response in the TrafficPolicyIdMarker request parameter.

    If IsTruncated is false, the TrafficPolicyIdMarker element is omitted from the response.

  • MaxItems

    The value that you specified for the MaxItems parameter in the request that produced the current response.

" }, "ListTrafficPolicyInstances":{ "name":"ListTrafficPolicyInstances", "http":{ "method":"GET", "requestUri":"/2013-04-01/trafficpolicyinstances" }, "input":{"shape":"ListTrafficPolicyInstancesRequest"}, "output":{"shape":"ListTrafficPolicyInstancesResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"NoSuchTrafficPolicyInstance"} ], "documentation":"

Gets information about the traffic policy instances that you created by using the current AWS account.

After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

Send a GET request to the /Amazon Route 53 API version/trafficpolicyinstance resource.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

The response includes five values that help you navigate from one group of MaxItems traffic policy instances to the next:

  • IsTruncated

    If the value of IsTruncated in the response is true, there are more traffic policy instances associated with the current AWS account.

    If IsTruncated is false, this response includes the last traffic policy instance that is associated with the current account.

  • MaxItems

    The value that you specified for the MaxItems parameter in the request that produced the current response.

  • HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker

    If IsTruncated is true, these three values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstances, and specify these values in the corresponding request parameters.

    If IsTruncated is false, all three elements are omitted from the response.

" }, "ListTrafficPolicyInstancesByHostedZone":{ "name":"ListTrafficPolicyInstancesByHostedZone", "http":{ "method":"GET", "requestUri":"/2013-04-01/trafficpolicyinstances/hostedzone" }, "input":{"shape":"ListTrafficPolicyInstancesByHostedZoneRequest"}, "output":{"shape":"ListTrafficPolicyInstancesByHostedZoneResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"NoSuchTrafficPolicyInstance"}, {"shape":"NoSuchHostedZone"} ], "documentation":"

Gets information about the traffic policy instances that you created in a specified hosted zone.

After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

Send a GET request to the /Amazon Route 53 API version/trafficpolicyinstance resource and include the ID of the hosted zone.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

The response includes four values that help you navigate from one group of MaxItems traffic policy instances to the next:

  • IsTruncated

    If the value of IsTruncated in the response is true, there are more traffic policy instances associated with the current AWS account.

    If IsTruncated is false, this response includes the last traffic policy instance that is associated with the current account.

  • MaxItems

    The value that you specified for the MaxItems parameter in the request that produced the current response.

  • TrafficPolicyInstanceNameMarker and TrafficPolicyInstanceTypeMarker

    If IsTruncated is true, these two values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstancesByHostedZone, and specify these values in the corresponding request parameters.

    If IsTruncated is false, all three elements are omitted from the response.

" }, "ListTrafficPolicyInstancesByPolicy":{ "name":"ListTrafficPolicyInstancesByPolicy", "http":{ "method":"GET", "requestUri":"/2013-04-01/trafficpolicyinstances/trafficpolicy" }, "input":{"shape":"ListTrafficPolicyInstancesByPolicyRequest"}, "output":{"shape":"ListTrafficPolicyInstancesByPolicyResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"NoSuchTrafficPolicyInstance"}, {"shape":"NoSuchTrafficPolicy"} ], "documentation":"

Gets information about the traffic policy instances that you created by using a specify traffic policy version.

After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

Send a GET request to the /Route 53 API version/trafficpolicyinstance resource and include the ID and version of the traffic policy.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

The response includes five values that help you navigate from one group of MaxItems traffic policy instances to the next:

  • IsTruncated

    If the value of IsTruncated in the response is true, there are more traffic policy instances associated with the specified traffic policy.

    If IsTruncated is false, this response includes the last traffic policy instance that is associated with the specified traffic policy.

  • MaxItems

    The value that you specified for the MaxItems parameter in the request that produced the current response.

  • HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker

    If IsTruncated is true, these values in the response represent the first traffic policy instance in the next group of MaxItems traffic policy instances. To list more traffic policy instances, make another call to ListTrafficPolicyInstancesByPolicy, and specify these values in the corresponding request parameters.

    If IsTruncated is false, all three elements are omitted from the response.

" }, "ListTrafficPolicyVersions":{ "name":"ListTrafficPolicyVersions", "http":{ "method":"GET", "requestUri":"/2013-04-01/trafficpolicies/{Id}/versions" }, "input":{"shape":"ListTrafficPolicyVersionsRequest"}, "output":{"shape":"ListTrafficPolicyVersionsResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"NoSuchTrafficPolicy"} ], "documentation":"

Gets information about all of the versions for a specified traffic policy.

Send a GET request to the /Amazon Route 53 API version/trafficpolicy resource and specify the ID of the traffic policy for which you want to list versions.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policies, you can use the maxitems parameter to list them in groups of up to 100.

The response includes three values that help you navigate from one group of maxitems traffic policies to the next:

  • IsTruncated

    If the value of IsTruncated in the response is true, there are more traffic policy versions associated with the specified traffic policy.

    If IsTruncated is false, this response includes the last traffic policy version that is associated with the specified traffic policy.

  • TrafficPolicyVersionMarker

    The ID of the next traffic policy version that is associated with the current AWS account. If you want to list more traffic policies, make another call to ListTrafficPolicyVersions, and specify the value of the TrafficPolicyVersionMarker element in the TrafficPolicyVersionMarker request parameter.

    If IsTruncated is false, Amazon Route 53 omits the TrafficPolicyVersionMarker element from the response.

  • MaxItems

    The value that you specified for the MaxItems parameter in the request that produced the current response.

" }, "ListVPCAssociationAuthorizations":{ "name":"ListVPCAssociationAuthorizations", "http":{ "method":"GET", "requestUri":"/2013-04-01/hostedzone/{Id}/authorizevpcassociation" }, "input":{"shape":"ListVPCAssociationAuthorizationsRequest"}, "output":{"shape":"ListVPCAssociationAuthorizationsResponse"}, "errors":[ {"shape":"NoSuchHostedZone"}, {"shape":"InvalidInput"}, {"shape":"InvalidPaginationToken"} ], "documentation":"

Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more CreateVPCAssociationAuthorization requests.

Send a GET request to the /2013-04-01/hostedzone/hosted zone ID/authorizevpcassociation resource. The response to this request includes a VPCs element with a VPC child element for each VPC that can be associated with the hosted zone.

Amazon Route 53 returns up to 50 VPCs per page. To return fewer VPCs per page, include the MaxResults parameter:

/2013-04-01/hostedzone/hosted zone ID/authorizevpcassociation?MaxItems=VPCs per page

If the response includes a NextToken element, there are more VPCs to list. To get the next page of VPCs, submit another ListVPCAssociationAuthorizations request, and include the value of the NextToken element from the response in the NextToken request parameter:

/2013-04-01/hostedzone/hosted zone ID/authorizevpcassociation?MaxItems=VPCs per page&NextToken=

" }, "TestDNSAnswer":{ "name":"TestDNSAnswer", "http":{ "method":"GET", "requestUri":"/2013-04-01/testdnsanswer" }, "input":{"shape":"TestDNSAnswerRequest"}, "output":{"shape":"TestDNSAnswerResponse"}, "errors":[ {"shape":"NoSuchHostedZone"}, {"shape":"InvalidInput"} ], "documentation":"

Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.

" }, "UpdateHealthCheck":{ "name":"UpdateHealthCheck", "http":{ "method":"POST", "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}" }, "input":{ "shape":"UpdateHealthCheckRequest", "locationName":"UpdateHealthCheckRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"UpdateHealthCheckResponse"}, "errors":[ {"shape":"NoSuchHealthCheck"}, {"shape":"InvalidInput"}, {"shape":"HealthCheckVersionMismatch"} ], "documentation":"

Updates an existing health check.

Send a POST request to the /2013-04-01/healthcheck/health check ID resource. The request body must include a document with an UpdateHealthCheckRequest element. For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide.

" }, "UpdateHostedZoneComment":{ "name":"UpdateHostedZoneComment", "http":{ "method":"POST", "requestUri":"/2013-04-01/hostedzone/{Id}" }, "input":{ "shape":"UpdateHostedZoneCommentRequest", "locationName":"UpdateHostedZoneCommentRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"UpdateHostedZoneCommentResponse"}, "errors":[ {"shape":"NoSuchHostedZone"}, {"shape":"InvalidInput"} ], "documentation":"

Updates the hosted zone comment. Send a POST request to the /2013-04-01/hostedzone/hosted zone ID resource.

" }, "UpdateTrafficPolicyComment":{ "name":"UpdateTrafficPolicyComment", "http":{ "method":"POST", "requestUri":"/2013-04-01/trafficpolicy/{Id}/{Version}" }, "input":{ "shape":"UpdateTrafficPolicyCommentRequest", "locationName":"UpdateTrafficPolicyCommentRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"UpdateTrafficPolicyCommentResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"NoSuchTrafficPolicy"}, {"shape":"ConcurrentModification"} ], "documentation":"

Updates the comment for a specified traffic policy version.

Send a POST request to the /2013-04-01/trafficpolicy/ resource.

The request body must include a document with an UpdateTrafficPolicyCommentRequest element.

" }, "UpdateTrafficPolicyInstance":{ "name":"UpdateTrafficPolicyInstance", "http":{ "method":"POST", "requestUri":"/2013-04-01/trafficpolicyinstance/{Id}" }, "input":{ "shape":"UpdateTrafficPolicyInstanceRequest", "locationName":"UpdateTrafficPolicyInstanceRequest", "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} }, "output":{"shape":"UpdateTrafficPolicyInstanceResponse"}, "errors":[ {"shape":"InvalidInput"}, {"shape":"NoSuchTrafficPolicy"}, {"shape":"NoSuchTrafficPolicyInstance"}, {"shape":"PriorRequestNotComplete"}, {"shape":"ConflictingTypes"} ], "documentation":"

Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.

Send a POST request to the /2013-04-01/trafficpolicyinstance/traffic policy ID resource. The request body must include a document with an UpdateTrafficPolicyInstanceRequest element.

When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Amazon Route 53 performs the following operations:

  1. Amazon Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how substantial the differences are between the existing resource record sets and the new resource record sets.

  2. When all of the new resource record sets have been created, Amazon Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.

  3. Amazon Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.

" } }, "shapes":{ "AlarmIdentifier":{ "type":"structure", "required":[ "Region", "Name" ], "members":{ "Region":{ "shape":"CloudWatchRegion", "documentation":"

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

For the current list of CloudWatch regions, see Amazon CloudWatch in AWS Regions and Endpoints in the Amazon Web Services General Reference.

" }, "Name":{ "shape":"AlarmName", "documentation":"

The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

" } }, "documentation":"

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

" }, "AlarmName":{ "type":"string", "max":256, "min":1 }, "AliasHealthEnabled":{"type":"boolean"}, "AliasTarget":{ "type":"structure", "required":[ "HostedZoneId", "DNSName", "EvaluateTargetHealth" ], "members":{ "HostedZoneId":{ "shape":"ResourceId", "documentation":"

Alias resource records sets only: The value used depends on where the queries are routed:

A CloudFront distribution

Specify Z2FDTNDATAQYW2.

Alias resource record sets for CloudFront can't be created in a private zone.
Elastic Beanstalk environment

Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the Regions and Endpoints chapter of the Amazon Web Services General Reference.

ELB load balancer

Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:

  • AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab. Use the same process to get the value of DNS name. (You specify the value of DNS name for AliasTarget$DNSName.)

  • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameId and DNSName. (You specify the value of DNSName for AliasTarget$DNSName.) For more information, see the applicable guide:

  • AWS CLI: Use describe-load-balancers to get the value of CanonicalHostedZoneNameID and DNSName. (You specify the value of DNSName for AliasTarget$DNSName.)

An Amazon S3 bucket configured as a static website

Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon Simple Storage Service Website Endpoints in the Amazon Web Services General Reference.

Another Amazon Route 53 resource record set in your hosted zone

Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)

" }, "DNSName":{ "shape":"DNSName", "documentation":"

Alias resource record sets only: The value that you specify depends on where you want to route queries:

  • A CloudFront distribution: Specify the domain name that CloudFront assigned when you created your distribution.

    Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.

  • Elastic Beanstalk environment: Specify the CNAME attribute for the environment. (The environment must have a regionalized domain name.) You can use the following methods to get the value of the CNAME attribute:

    • AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.

    • Elastic Beanstalk API: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.

    • AWS CLI: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the AWS Command Line Interface Reference.

  • An ELB load balancer: Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for HostedZoneId and DNSName. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail.

    • AWS Management Console: Go to the EC2 page, click Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field. (If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack.) Use the same process to get the value of the Hosted zone field. See AliasTarget$HostedZoneId.

    • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of DNSName and CanonicalHostedZoneNameId. (You specify the value of CanonicalHostedZoneNameId for AliasTarget$HostedZoneId.) For more information, see the applicable guide:

    • AWS CLI: Use describe-load-balancers to get the value of DNSName and CanonicalHostedZoneNameId. (You specify the value of CanonicalHostedZoneNameId for AliasTarget$HostedZoneId.)

  • An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon S3 website endpoint in which you created the bucket, for example, s3-website-us-east-1.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.

  • Another Amazon Route 53 resource record set: Specify the value of the Name element for a resource record set in the current hosted zone.

" }, "EvaluateTargetHealth":{ "shape":"AliasHealthEnabled", "documentation":"

Applies only to alias, weighted alias, latency alias, and failover alias record sets: If you set the value of EvaluateTargetHealth to true for the resource record set or sets in an alias, weighted alias, latency alias, or failover alias resource record set, and if you specify a value for HealthCheck$Id for every resource record set that is referenced by these alias resource record sets, the alias resource record sets inherit the health of the referenced resource record sets.

In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:

  • Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.

  • Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)

  • Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.

  • Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.

Note the following:

  • You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.

  • If the AWS resource that you specify in AliasTarget is a resource record set or a group of resource record sets (for example, a group of weighted resource record sets), but it is not another alias resource record set, we recommend that you associate a health check with all of the resource record sets in the alias target.For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.

  • If you specify an Elastic Beanstalk environment in HostedZoneId and DNSName, and if the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one EC2 instance.) If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Amazon Route 53 routes queries to other available resources that are healthy, if any.

    If the environment contains a single EC2 instance, there are no special requirements.

  • If you specify an ELB load balancer in AliasTarget , Elastic Load Balancing routes queries only to the healthy EC2 instances that are registered with the load balancer. If no EC2 instances are healthy or if the load balancer itself is unhealthy, and if EvaluateTargetHealth is true for the corresponding alias resource record set, Amazon Route 53 routes queries to other resources. When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Amazon Route 53 health checks, but they perform a similar function. Do not create Amazon Route 53 health checks for the EC2 instances that you register with an ELB load balancer.

    For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developers Guide.

  • We recommend that you set EvaluateTargetHealth to true only when you have enough idle capacity to handle the failure of one or more endpoints.

For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

" } }, "documentation":"

Alias resource record sets only: Information about the CloudFront distribution, Elastic Beanstalk environment, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set that you're redirecting queries to. The Elastic Beanstalk environment must have a regionalized subdomain.

When creating resource record sets for a private hosted zone, note the following:

  • Resource record sets can't be created for CloudFront distributions in a private hosted zone.

  • Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.

  • For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone.

" }, "AssociateVPCComment":{"type":"string"}, "AssociateVPCWithHostedZoneRequest":{ "type":"structure", "required":[ "HostedZoneId", "VPC" ], "members":{ "HostedZoneId":{ "shape":"ResourceId", "documentation":"

The ID of the private hosted zone that you want to associate an Amazon VPC with.

Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association.

", "location":"uri", "locationName":"Id" }, "VPC":{ "shape":"VPC", "documentation":"

A complex type that contains information about the VPC that you want to associate with a private hosted zone.

" }, "Comment":{ "shape":"AssociateVPCComment", "documentation":"

Optional: A comment about the association request.

" } }, "documentation":"

A complex type that contains information about the request to associate a VPC with a private hosted zone.

" }, "AssociateVPCWithHostedZoneResponse":{ "type":"structure", "required":["ChangeInfo"], "members":{ "ChangeInfo":{ "shape":"ChangeInfo", "documentation":"

A complex type that describes the changes made to your hosted zone.

" } }, "documentation":"

A complex type that contains the response information for the AssociateVPCWithHostedZone request.

" }, "Change":{ "type":"structure", "required":[ "Action", "ResourceRecordSet" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

The action to perform:

  • CREATE: Creates a resource record set that has the specified values.

  • DELETE: Deletes a existing resource record set.

    To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance . Amazon Route 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, Amazon Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

  • UPSERT: If a resource record set doesn't already exist, Amazon Route 53 creates it. If a resource record set does exist, Amazon Route 53 updates it with the values in the request.

The values that you need to include in the request depend on the type of resource record set that you're creating, deleting, or updating:

Basic resource record sets (excluding alias, failover, geolocation, latency, and weighted resource record sets)

  • Name

  • Type

  • TTL

Failover, geolocation, latency, or weighted resource record sets (excluding alias resource record sets)

  • Name

  • Type

  • TTL

  • SetIdentifier

Alias resource record sets (including failover alias, geolocation alias, latency alias, and weighted alias resource record sets)

  • Name

  • Type

  • AliasTarget (includes DNSName, EvaluateTargetHealth, and HostedZoneId)

  • SetIdentifier (for failover, geolocation, latency, and weighted resource record sets)

" }, "ResourceRecordSet":{ "shape":"ResourceRecordSet", "documentation":"

Information about the resource record set to create, delete, or update.

" } }, "documentation":"

The information for each resource record set that you want to change.

" }, "ChangeAction":{ "type":"string", "enum":[ "CREATE", "DELETE", "UPSERT" ] }, "ChangeBatch":{ "type":"structure", "required":["Changes"], "members":{ "Comment":{ "shape":"ResourceDescription", "documentation":"

Optional: Any comments you want to include about a change batch request.

" }, "Changes":{ "shape":"Changes", "documentation":"

Information about the changes to make to the record sets.

" } }, "documentation":"

The information for a change request.

" }, "ChangeInfo":{ "type":"structure", "required":[ "Id", "Status", "SubmittedAt" ], "members":{ "Id":{ "shape":"ResourceId", "documentation":"

The ID of the request.

" }, "Status":{ "shape":"ChangeStatus", "documentation":"

The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

" }, "SubmittedAt":{ "shape":"TimeStamp", "documentation":"

The date and time the change request was submitted, in Coordinated Universal Time (UTC) format: YYYY-MM-DDThh:mm:ssZ. For more information, see the Wikipedia entry ISO 8601.

" }, "Comment":{ "shape":"ResourceDescription", "documentation":"

A complex type that describes change information about changes made to your hosted zone.

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

" } }, "documentation":"

A complex type that describes change information about changes made to your hosted zone.

" }, "ChangeResourceRecordSetsRequest":{ "type":"structure", "required":[ "HostedZoneId", "ChangeBatch" ], "members":{ "HostedZoneId":{ "shape":"ResourceId", "documentation":"

The ID of the hosted zone that contains the resource record sets that you want to change.

", "location":"uri", "locationName":"Id" }, "ChangeBatch":{ "shape":"ChangeBatch", "documentation":"

A complex type that contains an optional comment and the Changes element.

" } }, "documentation":"

A complex type that contains change information for the resource record set.

" }, "ChangeResourceRecordSetsResponse":{ "type":"structure", "required":["ChangeInfo"], "members":{ "ChangeInfo":{ "shape":"ChangeInfo", "documentation":"

A complex type that contains information about changes made to your hosted zone.

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

" } }, "documentation":"

A complex type containing the response for the request.

" }, "ChangeStatus":{ "type":"string", "enum":[ "PENDING", "INSYNC" ] }, "ChangeTagsForResourceRequest":{ "type":"structure", "required":[ "ResourceType", "ResourceId" ], "members":{ "ResourceType":{ "shape":"TagResourceType", "documentation":"

The type of the resource.

  • The resource type for health checks is healthcheck.

  • The resource type for hosted zones is hostedzone.

", "location":"uri", "locationName":"ResourceType" }, "ResourceId":{ "shape":"TagResourceId", "documentation":"

The ID of the resource for which you want to add, change, or delete tags.

", "location":"uri", "locationName":"ResourceId" }, "AddTags":{ "shape":"TagList", "documentation":"

A complex type that contains a list of the tags that you want to add to the specified health check or hosted zone and/or the tags for which you want to edit the Value element.

You can add a maximum of 10 tags to a health check or a hosted zone.

" }, "RemoveTagKeys":{ "shape":"TagKeyList", "documentation":"

A complex type that contains a list of the tags that you want to delete from the specified health check or hosted zone. You can specify up to 10 keys.

" } }, "documentation":"

A complex type that contains information about the tags that you want to add, edit, or delete.

" }, "ChangeTagsForResourceResponse":{ "type":"structure", "members":{ }, "documentation":"

Empty response for the request.

" }, "Changes":{ "type":"list", "member":{ "shape":"Change", "locationName":"Change" }, "min":1 }, "CheckerIpRanges":{ "type":"list", "member":{"shape":"IPAddressCidr"} }, "ChildHealthCheckList":{ "type":"list", "member":{ "shape":"HealthCheckId", "locationName":"ChildHealthCheck" }, "max":256 }, "CloudWatchAlarmConfiguration":{ "type":"structure", "required":[ "EvaluationPeriods", "Threshold", "ComparisonOperator", "Period", "MetricName", "Namespace", "Statistic" ], "members":{ "EvaluationPeriods":{ "shape":"EvaluationPeriods", "documentation":"

For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.

" }, "Threshold":{ "shape":"Threshold", "documentation":"

For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.

" }, "ComparisonOperator":{ "shape":"ComparisonOperator", "documentation":"

For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.

" }, "Period":{ "shape":"Period", "documentation":"

For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

The name of the CloudWatch metric that the alarm is associated with.

" }, "Namespace":{ "shape":"Namespace", "documentation":"

The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

" }, "Statistic":{ "shape":"Statistic", "documentation":"

For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.

" }, "Dimensions":{ "shape":"DimensionList", "documentation":"

For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric.For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

" } }, "documentation":"

A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.

" }, "CloudWatchRegion":{ "type":"string", "enum":[ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-central-1", "eu-west-1", "eu-west-2", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2", "sa-east-1" ], "max":64, "min":1 }, "ComparisonOperator":{ "type":"string", "enum":[ "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold" ] }, "ConcurrentModification":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

Another user submitted a request to update the object at the same time that you did. Retry the request.

", "error":{"httpStatusCode":400}, "exception":true }, "ConflictingDomainExists":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

You specified an Amazon VPC that you're already using for another hosted zone, and the domain that you specified for one of the hosted zones is a subdomain of the domain that you specified for the other hosted zone. For example, you can't use the same Amazon VPC for the hosted zones for example.com and test.example.com.

", "exception":true }, "ConflictingTypes":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

You tried to update a traffic policy instance by using a traffic policy version that has a different DNS type than the current type for the instance. You specified the type in the JSON document in the CreateTrafficPolicy or CreateTrafficPolicyVersionrequest.

", "error":{"httpStatusCode":400}, "exception":true }, "CreateHealthCheckRequest":{ "type":"structure", "required":[ "CallerReference", "HealthCheckConfig" ], "members":{ "CallerReference":{ "shape":"HealthCheckNonce", "documentation":"

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.

" }, "HealthCheckConfig":{ "shape":"HealthCheckConfig", "documentation":"

A complex type that contains the response to a CreateHealthCheck request.

" } }, "documentation":"

A complex type that contains the health check request information.

" }, "CreateHealthCheckResponse":{ "type":"structure", "required":[ "HealthCheck", "Location" ], "members":{ "HealthCheck":{ "shape":"HealthCheck", "documentation":"

A complex type that contains identifying information about the health check.

" }, "Location":{ "shape":"ResourceURI", "documentation":"

The unique URL representing the new health check.

", "location":"header", "locationName":"Location" } }, "documentation":"

A complex type containing the response information for the new health check.

" }, "CreateHostedZoneRequest":{ "type":"structure", "required":[ "Name", "CallerReference" ], "members":{ "Name":{ "shape":"DNSName", "documentation":"

The name of the domain. For resource record types that include a domain name, specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Amazon Route 53, change the name servers for your domain to the set of NameServers that CreateHostedZone returns in the DelegationSet element.

" }, "VPC":{ "shape":"VPC", "documentation":"

The VPC that you want your hosted zone to be associated with. By providing this parameter, your newly created hosted can't be resolved anywhere other than the given VPC.

" }, "CallerReference":{ "shape":"Nonce", "documentation":"

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, for example, a date/time stamp.

" }, "HostedZoneConfig":{ "shape":"HostedZoneConfig", "documentation":"

(Optional) A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the HostedZoneConfig and Comment elements.

" }, "DelegationSetId":{ "shape":"ResourceId", "documentation":"

If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see CreateReusableDelegationSet.

Type

String

Default

None

Parent

CreatedHostedZoneRequest

" } }, "documentation":"

A complex type containing the hosted zone request information.

" }, "CreateHostedZoneResponse":{ "type":"structure", "required":[ "HostedZone", "ChangeInfo", "DelegationSet", "Location" ], "members":{ "HostedZone":{ "shape":"HostedZone", "documentation":"

A complex type that contains general information about the hosted zone.

" }, "ChangeInfo":{ "shape":"ChangeInfo", "documentation":"

A complex type that describes the changes made to your hosted zone.

" }, "DelegationSet":{ "shape":"DelegationSet", "documentation":"

A complex type that describes the name servers for this hosted zone.

" }, "VPC":{ "shape":"VPC", "documentation":"

A complex type that contains information about an Amazon VPC that you associated with this hosted zone.

" }, "Location":{ "shape":"ResourceURI", "documentation":"

The unique URL representing the new hosted zone.

", "location":"header", "locationName":"Location" } }, "documentation":"

A complex type containing the response information for the hosted zone.

" }, "CreateReusableDelegationSetRequest":{ "type":"structure", "required":["CallerReference"], "members":{ "CallerReference":{ "shape":"Nonce", "documentation":"

A unique string that identifies the request, and that allows you to retry failed CreateReusableDelegationSet requests without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateReusableDelegationSet request. CallerReference can be any unique string, for example a date/time stamp.

" }, "HostedZoneId":{ "shape":"ResourceId", "documentation":"

If you want to mark the delegation set for an existing hosted zone as reusable, the ID for that hosted zone.

" } } }, "CreateReusableDelegationSetResponse":{ "type":"structure", "required":[ "DelegationSet", "Location" ], "members":{ "DelegationSet":{ "shape":"DelegationSet", "documentation":"

A complex type that contains name server information.

" }, "Location":{ "shape":"ResourceURI", "documentation":"

The unique URL representing the new reusable delegation set.

", "location":"header", "locationName":"Location" } } }, "CreateTrafficPolicyInstanceRequest":{ "type":"structure", "required":[ "HostedZoneId", "Name", "TTL", "TrafficPolicyId", "TrafficPolicyVersion" ], "members":{ "HostedZoneId":{ "shape":"ResourceId", "documentation":"

The ID of the hosted zone in which you want Amazon Route 53 to create resource record sets by using the configuration in a traffic policy.

" }, "Name":{ "shape":"DNSName", "documentation":"

The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Amazon Route 53 creates for this traffic policy instance.

" }, "TTL":{ "shape":"TTL", "documentation":"

(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone.

" }, "TrafficPolicyId":{ "shape":"TrafficPolicyId", "documentation":"

The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.

" }, "TrafficPolicyVersion":{ "shape":"TrafficPolicyVersion", "documentation":"

The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone.

" } }, "documentation":"

A complex type that contains information about the resource record sets that you want to create based on a specified traffic policy.

" }, "CreateTrafficPolicyInstanceResponse":{ "type":"structure", "required":[ "TrafficPolicyInstance", "Location" ], "members":{ "TrafficPolicyInstance":{ "shape":"TrafficPolicyInstance", "documentation":"

A complex type that contains settings for the new traffic policy instance.

" }, "Location":{ "shape":"ResourceURI", "documentation":"

A unique URL that represents a new traffic policy instance.

", "location":"header", "locationName":"Location" } }, "documentation":"

A complex type that contains the response information for the CreateTrafficPolicyInstance request.

" }, "CreateTrafficPolicyRequest":{ "type":"structure", "required":[ "Name", "Document" ], "members":{ "Name":{ "shape":"TrafficPolicyName", "documentation":"

The name of the traffic policy.

" }, "Document":{ "shape":"TrafficPolicyDocument", "documentation":"

The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format.

" }, "Comment":{ "shape":"TrafficPolicyComment", "documentation":"

(Optional) Any comments that you want to include about the traffic policy.

" } }, "documentation":"

A complex type that contains information about the traffic policy that you want to create.

" }, "CreateTrafficPolicyResponse":{ "type":"structure", "required":[ "TrafficPolicy", "Location" ], "members":{ "TrafficPolicy":{ "shape":"TrafficPolicy", "documentation":"

A complex type that contains settings for the new traffic policy.

" }, "Location":{ "shape":"ResourceURI", "documentation":"

A unique URL that represents a new traffic policy.

", "location":"header", "locationName":"Location" } }, "documentation":"

A complex type that contains the response information for the CreateTrafficPolicy request.

" }, "CreateTrafficPolicyVersionRequest":{ "type":"structure", "required":[ "Id", "Document" ], "members":{ "Id":{ "shape":"TrafficPolicyId", "documentation":"

The ID of the traffic policy for which you want to create a new version.

", "location":"uri", "locationName":"Id" }, "Document":{ "shape":"TrafficPolicyDocument", "documentation":"

The definition of this version of the traffic policy, in JSON format. You specified the JSON in the CreateTrafficPolicyVersion request. For more information about the JSON format, see CreateTrafficPolicy.

" }, "Comment":{ "shape":"TrafficPolicyComment", "documentation":"

The comment that you specified in the CreateTrafficPolicyVersion request, if any.

" } }, "documentation":"

A complex type that contains information about the traffic policy for which you want to create a new version.

" }, "CreateTrafficPolicyVersionResponse":{ "type":"structure", "required":[ "TrafficPolicy", "Location" ], "members":{ "TrafficPolicy":{ "shape":"TrafficPolicy", "documentation":"

A complex type that contains settings for the new version of the traffic policy.

" }, "Location":{ "shape":"ResourceURI", "documentation":"

A unique URL that represents a new traffic policy version.

", "location":"header", "locationName":"Location" } }, "documentation":"

A complex type that contains the response information for the CreateTrafficPolicyVersion request.

" }, "CreateVPCAssociationAuthorizationRequest":{ "type":"structure", "required":[ "HostedZoneId", "VPC" ], "members":{ "HostedZoneId":{ "shape":"ResourceId", "documentation":"

The ID of the private hosted zone that you want to authorize associating a VPC with.

", "location":"uri", "locationName":"Id" }, "VPC":{ "shape":"VPC", "documentation":"

A complex type that contains the VPC ID and region for the VPC that you want to authorize associating with your hosted zone.

" } }, "documentation":"

A complex type that contains information about the request to authorize associating a VPC with your private hosted zone. Authorization is only required when a private hosted zone and a VPC were created by using different accounts.

" }, "CreateVPCAssociationAuthorizationResponse":{ "type":"structure", "required":[ "HostedZoneId", "VPC" ], "members":{ "HostedZoneId":{ "shape":"ResourceId", "documentation":"

The ID of the hosted zone that you authorized associating a VPC with.

" }, "VPC":{ "shape":"VPC", "documentation":"

The VPC that you authorized associating with a hosted zone.

" } }, "documentation":"

A complex type that contains the response information from a CreateVPCAssociationAuthorization request.

" }, "DNSName":{ "type":"string", "max":1024 }, "DNSRCode":{"type":"string"}, "DelegationSet":{ "type":"structure", "required":["NameServers"], "members":{ "Id":{ "shape":"ResourceId", "documentation":"

The ID that Amazon Route 53 assigns to a reusable delegation set.

" }, "CallerReference":{ "shape":"Nonce", "documentation":"

A unique string that identifies the request, and that allows you to retry failed CreateReusableDelegationSet requests without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateReusableDelegationSet request. CallerReference can be any unique string, for example, a date/time stamp.

" }, "NameServers":{ "shape":"DelegationSetNameServers", "documentation":"

A complex type that contains a list of the authoritative name servers for the hosted zone.

" } }, "documentation":"

A complex type that describes the name servers for this hosted zone.

" }, "DelegationSetAlreadyCreated":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

A delegation set with the same owner and caller reference combination has already been created.

", "exception":true }, "DelegationSetAlreadyReusable":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

The specified delegation set has already been marked as reusable.

", "exception":true }, "DelegationSetInUse":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

The specified delegation contains associated hosted zones which must be deleted before the reusable delegation set can be deleted.

", "exception":true }, "DelegationSetNameServers":{ "type":"list", "member":{ "shape":"DNSName", "locationName":"NameServer" }, "min":1 }, "DelegationSetNotAvailable":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

You can create a hosted zone that has the same name as an existing hosted zone (example.com is common), but there is a limit to the number of hosted zones that have the same name. If you get this error, Amazon Route 53 has reached that limit. If you own the domain name and Amazon Route 53 generates this error, contact Customer Support.

", "exception":true }, "DelegationSetNotReusable":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

A reusable delegation set with the specified ID does not exist.

", "exception":true }, "DelegationSets":{ "type":"list", "member":{ "shape":"DelegationSet", "locationName":"DelegationSet" } }, "DeleteHealthCheckRequest":{ "type":"structure", "required":["HealthCheckId"], "members":{ "HealthCheckId":{ "shape":"HealthCheckId", "documentation":"

The ID of the health check that you want to delete.

", "location":"uri", "locationName":"HealthCheckId" } }, "documentation":"

This action deletes a health check. Send a DELETE request to the /2013-04-01/DeleteHealthCheckRequest resource.

" }, "DeleteHealthCheckResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element.

" }, "DeleteHostedZoneRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"ResourceId", "documentation":"

The ID of the hosted zone you want to delete.

", "location":"uri", "locationName":"Id" } }, "documentation":"

A complex type that contains information about the hosted zone that you want to delete.

" }, "DeleteHostedZoneResponse":{ "type":"structure", "required":["ChangeInfo"], "members":{ "ChangeInfo":{ "shape":"ChangeInfo", "documentation":"

A complex type that contains the ID, the status, and the date and time of your delete request.

" } }, "documentation":"

A complex type containing the response information for the request.

" }, "DeleteReusableDelegationSetRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"ResourceId", "documentation":"

The ID of the reusable delegation set you want to delete.

", "location":"uri", "locationName":"Id" } }, "documentation":"

A complex type containing the information for the delete request.

" }, "DeleteReusableDelegationSetResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element.

" }, "DeleteTrafficPolicyInstanceRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"TrafficPolicyInstanceId", "documentation":"

The ID of the traffic policy instance that you want to delete.

When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created the traffic policy instance.

", "location":"uri", "locationName":"Id" } }, "documentation":"

A complex type that contains information about the traffic policy instance that you want to delete.

" }, "DeleteTrafficPolicyInstanceResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element.

" }, "DeleteTrafficPolicyRequest":{ "type":"structure", "required":[ "Id", "Version" ], "members":{ "Id":{ "shape":"TrafficPolicyId", "documentation":"

The ID of the traffic policy that you want to delete.

", "location":"uri", "locationName":"Id" }, "Version":{ "shape":"TrafficPolicyVersion", "documentation":"

The version number of the traffic policy that you want to delete.

", "location":"uri", "locationName":"Version" } }, "documentation":"

A request to delete a specified traffic policy version.

" }, "DeleteTrafficPolicyResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element.

" }, "DeleteVPCAssociationAuthorizationRequest":{ "type":"structure", "required":[ "HostedZoneId", "VPC" ], "members":{ "HostedZoneId":{ "shape":"ResourceId", "documentation":"

When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, the ID of the hosted zone.

", "location":"uri", "locationName":"Id" }, "VPC":{ "shape":"VPC", "documentation":"

When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, a complex type that includes the ID and region of the VPC.

" } }, "documentation":"

A complex type that contains information about the request to remove authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account.

" }, "DeleteVPCAssociationAuthorizationResponse":{ "type":"structure", "members":{ }, "documentation":"

Empty response for the request.

" }, "Dimension":{ "type":"structure", "required":[ "Name", "Value" ], "members":{ "Name":{ "shape":"DimensionField", "documentation":"

For the metric that the CloudWatch alarm is associated with, the name of one dimension.

" }, "Value":{ "shape":"DimensionField", "documentation":"

For the metric that the CloudWatch alarm is associated with, the value of one dimension.

" } }, "documentation":"

For the metric that the CloudWatch alarm is associated with, a complex type that contains information about one dimension.

" }, "DimensionField":{ "type":"string", "max":255, "min":1 }, "DimensionList":{ "type":"list", "member":{ "shape":"Dimension", "locationName":"Dimension" }, "max":10 }, "DisassociateVPCComment":{"type":"string"}, "DisassociateVPCFromHostedZoneRequest":{ "type":"structure", "required":[ "HostedZoneId", "VPC" ], "members":{ "HostedZoneId":{ "shape":"ResourceId", "documentation":"

The ID of the private hosted zone that you want to disassociate a VPC from.

", "location":"uri", "locationName":"Id" }, "VPC":{ "shape":"VPC", "documentation":"

A complex type that contains information about the VPC that you're disassociating from the specified hosted zone.

" }, "Comment":{ "shape":"DisassociateVPCComment", "documentation":"

Optional: A comment about the disassociation request.

" } }, "documentation":"

A complex type that contains information about the VPC that you want to disassociate from a specified private hosted zone.

" }, "DisassociateVPCFromHostedZoneResponse":{ "type":"structure", "required":["ChangeInfo"], "members":{ "ChangeInfo":{ "shape":"ChangeInfo", "documentation":"

A complex type that describes the changes made to the specified private hosted zone.

" } }, "documentation":"

A complex type that contains the response information for the disassociate request.

" }, "EnableSNI":{"type":"boolean"}, "ErrorMessage":{"type":"string"}, "ErrorMessages":{ "type":"list", "member":{ "shape":"ErrorMessage", "locationName":"Message" } }, "EvaluationPeriods":{ "type":"integer", "min":1 }, "FailureThreshold":{ "type":"integer", "max":10, "min":1 }, "FullyQualifiedDomainName":{ "type":"string", "max":255 }, "GeoLocation":{ "type":"structure", "members":{ "ContinentCode":{ "shape":"GeoLocationContinentCode", "documentation":"

The two-letter code for the continent.

Valid values: AF | AN | AS | EU | OC | NA | SA

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

" }, "CountryCode":{ "shape":"GeoLocationCountryCode", "documentation":"

The two-letter code for the country.

" }, "SubdivisionCode":{ "shape":"GeoLocationSubdivisionCode", "documentation":"

The code for the subdivision, for example, a state in the United States or a province in Canada.

" } }, "documentation":"

A complex type that contains information about a geo location.

" }, "GeoLocationContinentCode":{ "type":"string", "max":2, "min":2 }, "GeoLocationContinentName":{ "type":"string", "max":32, "min":1 }, "GeoLocationCountryCode":{ "type":"string", "max":2, "min":1 }, "GeoLocationCountryName":{ "type":"string", "max":64, "min":1 }, "GeoLocationDetails":{ "type":"structure", "members":{ "ContinentCode":{ "shape":"GeoLocationContinentCode", "documentation":"

The two-letter code for the continent.

" }, "ContinentName":{ "shape":"GeoLocationContinentName", "documentation":"

The full name of the continent.

" }, "CountryCode":{ "shape":"GeoLocationCountryCode", "documentation":"

The two-letter code for the country.

" }, "CountryName":{ "shape":"GeoLocationCountryName", "documentation":"

The name of the country.

" }, "SubdivisionCode":{ "shape":"GeoLocationSubdivisionCode", "documentation":"

The code for the subdivision, for example, a state in the United States or a province in Canada.

" }, "SubdivisionName":{ "shape":"GeoLocationSubdivisionName", "documentation":"

The full name of the subdivision, for example, a state in the United States or a province in Canada.

" } }, "documentation":"

A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code.

" }, "GeoLocationDetailsList":{ "type":"list", "member":{ "shape":"GeoLocationDetails", "locationName":"GeoLocationDetails" } }, "GeoLocationSubdivisionCode":{ "type":"string", "max":3, "min":1 }, "GeoLocationSubdivisionName":{ "type":"string", "max":64, "min":1 }, "GetChangeRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"ResourceId", "documentation":"

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.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The input for a GetChange request.

" }, "GetChangeResponse":{ "type":"structure", "required":["ChangeInfo"], "members":{ "ChangeInfo":{ "shape":"ChangeInfo", "documentation":"

A complex type that contains information about the specified change batch.

" } }, "documentation":"

A complex type that contains the ChangeInfo element.

" }, "GetCheckerIpRangesRequest":{ "type":"structure", "members":{ }, "documentation":"

Empty request.

" }, "GetCheckerIpRangesResponse":{ "type":"structure", "required":["CheckerIpRanges"], "members":{ "CheckerIpRanges":{ "shape":"CheckerIpRanges", "documentation":"

A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.

" } }, "documentation":"

A complex type that contains the CheckerIpRanges element.

" }, "GetGeoLocationRequest":{ "type":"structure", "members":{ "ContinentCode":{ "shape":"GeoLocationContinentCode", "documentation":"

Amazon Route 53 supports the following continent codes:

  • AF: Africa

  • AN: Antarctica

  • AS: Asia

  • EU: Europe

  • OC: Oceania

  • NA: North America

  • SA: South America

", "location":"querystring", "locationName":"continentcode" }, "CountryCode":{ "shape":"GeoLocationCountryCode", "documentation":"

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.

", "location":"querystring", "locationName":"countrycode" }, "SubdivisionCode":{ "shape":"GeoLocationSubdivisionCode", "documentation":"

Amazon Route 53 uses the one- to three-letter subdivision codes that are specified in ISO standard 3166-1 alpha-2. Amazon Route 53 doesn't support subdivision codes for all countries. If you specify SubdivisionCode, you must also specify CountryCode.

", "location":"querystring", "locationName":"subdivisioncode" } }, "documentation":"

A complex type that contains information about the request to get a geo location.

" }, "GetGeoLocationResponse":{ "type":"structure", "required":["GeoLocationDetails"], "members":{ "GeoLocationDetails":{ "shape":"GeoLocationDetails", "documentation":"

A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code.

" } }, "documentation":"

A complex type that contains the response information for the specified geolocation code.

" }, "GetHealthCheckCountRequest":{ "type":"structure", "members":{ }, "documentation":"

To retrieve a count of all your health checks, send a GET request to the /2013-04-01/healthcheckcount resource.

" }, "GetHealthCheckCountResponse":{ "type":"structure", "required":["HealthCheckCount"], "members":{ "HealthCheckCount":{ "shape":"HealthCheckCount", "documentation":"

The number of health checks associated with the current AWS account.

" } }, "documentation":"

A complex type that contains the response to a healthcheckcount request.

" }, "GetHealthCheckLastFailureReasonRequest":{ "type":"structure", "required":["HealthCheckId"], "members":{ "HealthCheckId":{ "shape":"HealthCheckId", "documentation":"

The ID for the health check for which you want the last failure reason. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

", "location":"uri", "locationName":"HealthCheckId" } }, "documentation":"

This action gets the reason that a specified health check failed most recently.

To get the reason for the last failure of a health check, send a GET request to the /2013-04-01/healthcheck/health check ID/lastfailurereason resource.

For information about viewing the last failure reason for a health check using the Amazon Route 53 console, see Viewing Health Check Status and the Reason for Health Check Failures in the Amazon Route 53 Developer Guide.

" }, "GetHealthCheckLastFailureReasonResponse":{ "type":"structure", "required":["HealthCheckObservations"], "members":{ "HealthCheckObservations":{ "shape":"HealthCheckObservations", "documentation":"

A list that contains one Observation element for each Amazon Route 53 health checker that is reporting a last failure reason.

" } }, "documentation":"

A complex type that contains the response to a GetHealthCheckLastFailureReason request.

" }, "GetHealthCheckRequest":{ "type":"structure", "required":["HealthCheckId"], "members":{ "HealthCheckId":{ "shape":"HealthCheckId", "documentation":"

The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.

", "location":"uri", "locationName":"HealthCheckId" } }, "documentation":"

This action gets information about a specified health check.

Send a GET request to the /Amazon Route 53 API version/gethealthcheckrequest resource.

For information about getting information about a health check using the Amazon Route 53 console, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

" }, "GetHealthCheckResponse":{ "type":"structure", "required":["HealthCheck"], "members":{ "HealthCheck":{ "shape":"HealthCheck", "documentation":"

A complex type that contains information about one health check that is associated with the current AWS account.

" } }, "documentation":"

A complex type that contains the response to a GetHealthCheck request.

" }, "GetHealthCheckStatusRequest":{ "type":"structure", "required":["HealthCheckId"], "members":{ "HealthCheckId":{ "shape":"HealthCheckId", "documentation":"

If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include the HealthCheckId element and specify the ID of the applicable health check.

Amazon Route 53 determines whether a resource record set is healthy by periodically sending a request to the endpoint that is specified in the health check. If that endpoint returns an HTTP status code of 2xx or 3xx, the endpoint is healthy. If the endpoint returns an HTTP status code of 400 or greater, or if the endpoint doesn't respond for a certain amount of time, Amazon Route 53 considers the endpoint unhealthy and also considers the resource record set unhealthy.

The HealthCheckId element is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations:

  • You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.

  • You set EvaluateTargetHealth to true for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets. For more information about this configuration, see EvaluateTargetHealth.

    Amazon Route 53 doesn't check the health of the endpoint specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Amazon Route 53 checks the health of the endpoint that you specified in the health check.

For geolocation resource record sets, if an endpoint is unhealthy, Amazon Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value of CountryCode is *), in that order, until it finds a resource record set for which the endpoint is healthy.

If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-1-www.example.com), not the name of the resource record sets (example.com).

In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and then associate the health check with those resource record sets, health check results will be unpredictable.

", "location":"uri", "locationName":"HealthCheckId" } }, "documentation":"

A complex type that contains information about the request to get health check status for a health check.

" }, "GetHealthCheckStatusResponse":{ "type":"structure", "required":["HealthCheckObservations"], "members":{ "HealthCheckObservations":{ "shape":"HealthCheckObservations", "documentation":"

A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker that is reporting a status about the health check endpoint.

" } }, "documentation":"

A complex type that contains the response to a GetHealthCheck request.

" }, "GetHostedZoneCountRequest":{ "type":"structure", "members":{ }, "documentation":"

To retrieve a count of all your hosted zones, send a GET request to the /2013-04-01/hostedzonecount resource.

" }, "GetHostedZoneCountResponse":{ "type":"structure", "required":["HostedZoneCount"], "members":{ "HostedZoneCount":{ "shape":"HostedZoneCount", "documentation":"

The total number of public and private hosted zones associated with the current AWS account.

" } }, "documentation":"

A complex type that contains the response to a hostedzonecount request.

" }, "GetHostedZoneRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"ResourceId", "documentation":"

The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The input for a GetHostedZone request.

" }, "GetHostedZoneResponse":{ "type":"structure", "required":["HostedZone"], "members":{ "HostedZone":{ "shape":"HostedZone", "documentation":"

A complex type that contains general information about the hosted zone.

" }, "DelegationSet":{ "shape":"DelegationSet", "documentation":"

A complex type that describes the name servers for this hosted zone.

" }, "VPCs":{ "shape":"VPCs", "documentation":"

A complex type that contains information about VPCs associated with the specified hosted zone.

" } }, "documentation":"

A complex type containing the response information for the hosted zone.

" }, "GetReusableDelegationSetRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"ResourceId", "documentation":"

The ID of the reusable delegation set for which you want to get a list of the name server.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The input for a GetReusableDelegationSet request.

" }, "GetReusableDelegationSetResponse":{ "type":"structure", "required":["DelegationSet"], "members":{ "DelegationSet":{ "shape":"DelegationSet", "documentation":"

A complex type that contains information about the reusable delegation set.

" } }, "documentation":"

A complex type that contains the response to the GetReusableDelegationSet request.

" }, "GetTrafficPolicyInstanceCountRequest":{ "type":"structure", "members":{ }, "documentation":"

To retrieve a count of all your traffic policy instances, send a GET request to the /2013-04-01/trafficpolicyinstancecount resource.

" }, "GetTrafficPolicyInstanceCountResponse":{ "type":"structure", "required":["TrafficPolicyInstanceCount"], "members":{ "TrafficPolicyInstanceCount":{ "shape":"TrafficPolicyInstanceCount", "documentation":"

The number of traffic policy instances that are associated with the current AWS account.

" } }, "documentation":"

A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.

" }, "GetTrafficPolicyInstanceRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"TrafficPolicyInstanceId", "documentation":"

The ID of the traffic policy instance that you want to get information about.

", "location":"uri", "locationName":"Id" } }, "documentation":"

Gets information about a specified traffic policy instance.

To get information about a traffic policy instance, send a GET request to the /Amazon Route 53 API version/trafficpolicyinstance/Id resource.

" }, "GetTrafficPolicyInstanceResponse":{ "type":"structure", "required":["TrafficPolicyInstance"], "members":{ "TrafficPolicyInstance":{ "shape":"TrafficPolicyInstance", "documentation":"

A complex type that contains settings for the traffic policy instance.

" } }, "documentation":"

A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.

" }, "GetTrafficPolicyRequest":{ "type":"structure", "required":[ "Id", "Version" ], "members":{ "Id":{ "shape":"TrafficPolicyId", "documentation":"

The ID of the traffic policy that you want to get information about.

", "location":"uri", "locationName":"Id" }, "Version":{ "shape":"TrafficPolicyVersion", "documentation":"

The version number of the traffic policy that you want to get information about.

", "location":"uri", "locationName":"Version" } }, "documentation":"

Gets information about a specific traffic policy version. To get the information, send a GET request to the /2013-04-01/trafficpolicy resource, and specify the ID and the version of the traffic policy.

" }, "GetTrafficPolicyResponse":{ "type":"structure", "required":["TrafficPolicy"], "members":{ "TrafficPolicy":{ "shape":"TrafficPolicy", "documentation":"

A complex type that contains settings for the specified traffic policy.

" } }, "documentation":"

A complex type that contains the response information for the request.

" }, "HealthCheck":{ "type":"structure", "required":[ "Id", "CallerReference", "HealthCheckConfig", "HealthCheckVersion" ], "members":{ "Id":{ "shape":"HealthCheckId", "documentation":"

The identifier that Amazon Route 53assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.

" }, "CallerReference":{ "shape":"HealthCheckNonce", "documentation":"

A unique string that you specified when you created the health check.

" }, "HealthCheckConfig":{ "shape":"HealthCheckConfig", "documentation":"

A complex type that contains detailed information about one health check.

" }, "HealthCheckVersion":{ "shape":"HealthCheckVersion", "documentation":"

The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.

" }, "CloudWatchAlarmConfiguration":{ "shape":"CloudWatchAlarmConfiguration", "documentation":"

A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.

" } }, "documentation":"

A complex type that contains information about one health check that is associated with the current AWS account.

" }, "HealthCheckAlreadyExists":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

The health check you're attempting to create already exists.

Amazon Route 53 returns this error when a health check has already been created with the specified value for CallerReference.

", "error":{"httpStatusCode":409}, "exception":true }, "HealthCheckConfig":{ "type":"structure", "required":["Type"], "members":{ "IPAddress":{ "shape":"IPAddress", "documentation":"

The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address returned by DNS, Amazon Route 53 then checks the health of the endpoint.

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

For more information, see HealthCheckConfig$FullyQualifiedDomainName.

Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

" }, "Port":{ "shape":"Port", "documentation":"

The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress.

" }, "Type":{ "shape":"HealthCheckType", "documentation":"

The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

You can't change the value of Type after you create a health check.

You can create the following types of health checks:

  • HTTP: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

  • HTTPS: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

    If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

  • HTTP_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

  • HTTPS_STR_MATCH: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

  • TCP: Amazon Route 53 tries to establish a TCP connection.

  • CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.

  • CALCULATED: For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

For more information about how Amazon Route 53 determines whether an endpoint is healthy, see the introduction to this topic.

" }, "ResourcePath":{ "shape":"ResourcePath", "documentation":"

The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html.

" }, "FullyQualifiedDomainName":{ "shape":"FullyQualifiedDomainName", "documentation":"

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

If you specify a value for IPAddress:

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks.

When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify another value for Port and any value except TCP for Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases.

If you don't specify a value for IPAddress :

Amazon Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint.

If you don't specify a value for IPAddress, Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a \"DNS resolution failed\" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-1-www.example.com), not the name of the resource record sets (www.example.com).

In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a Host header.

" }, "SearchString":{ "shape":"SearchString", "documentation":"

If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy.

Amazon Route 53 considers case when searching for SearchString in the response body.

" }, "RequestInterval":{ "shape":"RequestInterval", "documentation":"

The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request. Each Amazon Route 53 health checker makes requests at this interval.

You can't change the value of RequestInterval after you create a health check.

" }, "FailureThreshold":{ "shape":"FailureThreshold", "documentation":"

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

" }, "MeasureLatency":{ "shape":"MeasureLatency", "documentation":"

Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Amazon Route 53 console.

You can't change the value of MeasureLatency after you create a health check.

" }, "Inverted":{ "shape":"Inverted", "documentation":"

Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

" }, "HealthThreshold":{ "shape":"HealthThreshold", "documentation":"

The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the HealthCheckConfig$ChildHealthChecks and HealthCheckConfig$ChildHealthChecks elements.

Note the following:

  • If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.

  • If you specify 0, Amazon Route 53 always considers this health check to be healthy.

" }, "ChildHealthChecks":{ "shape":"ChildHealthCheckList", "documentation":"

(CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

" }, "EnableSNI":{ "shape":"EnableSNI", "documentation":"

Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

" }, "Regions":{ "shape":"HealthCheckRegionList", "documentation":"

A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.

" }, "AlarmIdentifier":{ "shape":"AlarmIdentifier", "documentation":"

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

" }, "InsufficientDataHealthStatus":{ "shape":"InsufficientDataHealthStatus", "documentation":"

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

  • Healthy: Amazon Route 53 considers the health check to be healthy.

  • Unhealthy: Amazon Route 53 considers the health check to be unhealthy.

  • LastKnownStatus: Amazon Route 53uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

" } }, "documentation":"

A complex type that contains information about the health check.

" }, "HealthCheckCount":{"type":"long"}, "HealthCheckId":{ "type":"string", "max":64 }, "HealthCheckInUse":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

The health check ID for this health check is referenced in the HealthCheckId element in one of the resource record sets in one of the hosted zones that are owned by the current AWS account.

", "error":{"httpStatusCode":400}, "exception":true }, "HealthCheckNonce":{ "type":"string", "max":64, "min":1 }, "HealthCheckObservation":{ "type":"structure", "members":{ "Region":{ "shape":"HealthCheckRegion", "documentation":"

The region of the Amazon Route 53 health checker that provided the status in StatusReport.

" }, "IPAddress":{ "shape":"IPAddress", "documentation":"

The IP address of the Amazon Route 53 health checker that provided the failure reason in StatusReport.

" }, "StatusReport":{ "shape":"StatusReport", "documentation":"

A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker and the time of the failed health check.

" } }, "documentation":"

A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker.

" }, "HealthCheckObservations":{ "type":"list", "member":{ "shape":"HealthCheckObservation", "locationName":"HealthCheckObservation" } }, "HealthCheckRegion":{ "type":"string", "documentation":"

An Amazon EC2 Region that you want Amazon Route 53 to use to perform health checks.

", "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" ], "max":64, "min":1 }, "HealthCheckRegionList":{ "type":"list", "member":{ "shape":"HealthCheckRegion", "locationName":"Region" }, "max":64, "min":1 }, "HealthCheckType":{ "type":"string", "enum":[ "HTTP", "HTTPS", "HTTP_STR_MATCH", "HTTPS_STR_MATCH", "TCP", "CALCULATED", "CLOUDWATCH_METRIC" ] }, "HealthCheckVersion":{ "type":"long", "min":1 }, "HealthCheckVersionMismatch":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The value of HealthCheckVersion in the request doesn't match the value of HealthCheckVersion in the health check.

", "error":{"httpStatusCode":409}, "exception":true }, "HealthChecks":{ "type":"list", "member":{ "shape":"HealthCheck", "locationName":"HealthCheck" } }, "HealthThreshold":{ "type":"integer", "max":256, "min":0 }, "HostedZone":{ "type":"structure", "required":[ "Id", "Name", "CallerReference" ], "members":{ "Id":{ "shape":"ResourceId", "documentation":"

The ID that Amazon Route 53 assigned to the hosted zone when you created it.

" }, "Name":{ "shape":"DNSName", "documentation":"

The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.

For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone.

" }, "CallerReference":{ "shape":"Nonce", "documentation":"

The value that you specified for CallerReference when you created the hosted zone.

" }, "Config":{ "shape":"HostedZoneConfig", "documentation":"

A complex type that includes the Comment and PrivateZone elements. If you omitted the HostedZoneConfig and Comment elements from the request, the Config and Comment elements don't appear in the response.

" }, "ResourceRecordSetCount":{ "shape":"HostedZoneRRSetCount", "documentation":"

The number of resource record sets in the hosted zone.

" } }, "documentation":"

A complex type that contains general information about the hosted zone.

" }, "HostedZoneAlreadyExists":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

The hosted zone you are trying to create already exists. Amazon Route 53 returns this error when a hosted zone has already been created with the specified CallerReference.

", "error":{"httpStatusCode":409}, "exception":true }, "HostedZoneConfig":{ "type":"structure", "members":{ "Comment":{ "shape":"ResourceDescription", "documentation":"

Any comments that you want to include about the hosted zone.

" }, "PrivateZone":{ "shape":"IsPrivateZone", "documentation":"

A value that indicates whether this is a private hosted zone.

" } }, "documentation":"

A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the HostedZoneConfig and Comment elements.

" }, "HostedZoneCount":{"type":"long"}, "HostedZoneNotEmpty":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

The hosted zone contains resource records that are not SOA or NS records.

", "error":{"httpStatusCode":400}, "exception":true }, "HostedZoneNotFound":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

The specified HostedZone can't be found.

", "exception":true }, "HostedZoneRRSetCount":{"type":"long"}, "HostedZones":{ "type":"list", "member":{ "shape":"HostedZone", "locationName":"HostedZone" } }, "IPAddress":{ "type":"string", "max":45, "pattern":"(^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$)" }, "IPAddressCidr":{"type":"string"}, "IncompatibleVersion":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

The resource you are trying to access is unsupported on this Amazon Route 53 endpoint. Please consider using a newer endpoint or a tool that does so.

", "error":{"httpStatusCode":400}, "exception":true }, "InsufficientDataHealthStatus":{ "type":"string", "enum":[ "Healthy", "Unhealthy", "LastKnownStatus" ] }, "InvalidArgument":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

Parameter name and problem.

", "exception":true }, "InvalidChangeBatch":{ "type":"structure", "members":{ "messages":{ "shape":"ErrorMessages", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

This exception contains a list of messages that might contain one or more error messages. Each error message indicates one error in the change batch.

", "exception":true }, "InvalidDomainName":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

The specified domain name is not valid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidInput":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

The input is not valid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidPaginationToken":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidTrafficPolicyDocument":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

The format of the traffic policy document that you specified in the Document element is invalid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidVPCId":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.

", "error":{"httpStatusCode":400}, "exception":true }, "Inverted":{"type":"boolean"}, "IsPrivateZone":{"type":"boolean"}, "LastVPCAssociation":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

The VPC that you're trying to disassociate from the private hosted zone is the last VPC that is associated with the hosted zone. Amazon Route 53 doesn't support disassociating the last VPC from a hosted zone.

", "error":{"httpStatusCode":400}, "exception":true }, "LimitsExceeded":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

The limits specified for a resource have been exceeded.

", "exception":true }, "ListGeoLocationsRequest":{ "type":"structure", "members":{ "StartContinentCode":{ "shape":"GeoLocationContinentCode", "documentation":"

The code for the continent with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextContinentCode from the previous response has a value, enter that value in StartContinentCode to return the next page of results.

Include StartContinentCode only if you want to list continents. Don't include StartContinentCode when you're listing countries or countries with their subdivisions.

", "location":"querystring", "locationName":"startcontinentcode" }, "StartCountryCode":{ "shape":"GeoLocationCountryCode", "documentation":"

The code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextCountryCode from the previous response has a value, enter that value in StartCountryCode to return the next page of results.

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.

", "location":"querystring", "locationName":"startcountrycode" }, "StartSubdivisionCode":{ "shape":"GeoLocationSubdivisionCode", "documentation":"

The code for the subdivision (for example, state or province) with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Amazon Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextSubdivisionCode from the previous response has a value, enter that value in StartSubdivisionCode to return the next page of results.

To list subdivisions of a country, you must include both StartCountryCode and StartSubdivisionCode.

", "location":"querystring", "locationName":"startsubdivisioncode" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

(Optional) The maximum number of geolocations to be included in the response body for this request. If more than MaxItems geolocations remain to be listed, then the value of the IsTruncated element in the response is true.

", "location":"querystring", "locationName":"maxitems" } }, "documentation":"

To get a list of geographic locations that Amazon Route 53 supports for geolocation, send a GET request to the /Amazon Route 53 API version/geolocations resource. The response to this request includes a GeoLocationDetails element for each location that Amazon Route 53 supports.

Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country.

" }, "ListGeoLocationsResponse":{ "type":"structure", "required":[ "GeoLocationDetailsList", "IsTruncated", "MaxItems" ], "members":{ "GeoLocationDetailsList":{ "shape":"GeoLocationDetailsList", "documentation":"

A complex type that contains one GeoLocationDetails element for each location that Amazon Route 53 supports for geolocation.

" }, "IsTruncated":{ "shape":"PageTruncated", "documentation":"

A value that indicates whether more locations remain to be listed after the last location in this response. If so, the value of IsTruncated is true. To get more values, submit another request and include the values of NextContinentCode, NextCountryCode, and NextSubdivisionCode in the StartContinentCode, StartCountryCode, and StartSubdivisionCode, as applicable.

" }, "NextContinentCode":{ "shape":"GeoLocationContinentCode", "documentation":"

If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextContinentCode in the StartContinentCode parameter in another GET ListGeoLocations request.

" }, "NextCountryCode":{ "shape":"GeoLocationCountryCode", "documentation":"

If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextCountryCode in the StartCountryCode parameter in another GET ListGeoLocations request.

" }, "NextSubdivisionCode":{ "shape":"GeoLocationSubdivisionCode", "documentation":"

If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextSubdivisionCode in the StartSubdivisionCode parameter in another GET ListGeoLocations request.

" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The value that you specified for MaxItems in the request.

" } }, "documentation":"

A complex type containing the response information for the request.

" }, "ListHealthChecksRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"PageMarker", "documentation":"

If the response to a ListHealthChecks is more than one page, marker is the health check ID for the first health check on the next page of results. For more information, see ListHealthChecksResponse$MaxItems.

", "location":"querystring", "locationName":"marker" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The maximum number of HealthCheck elements you want ListHealthChecks to return on each page of the response body. If the AWS account includes more HealthCheck elements than the value of maxitems, the response is broken into pages. Each page contains the number of HealthCheck elements specified by maxitems.

For example, suppose you specify 10 for maxitems and the current AWS account has 51 health checks. In the response, ListHealthChecks sets ListHealthChecksResponse$IsTruncated to true and includes the ListHealthChecksResponse$NextMarker element. To access the second and subsequent pages, you resend the GET ListHealthChecks request, add the ListHealthChecksResponse$Marker parameter to the request, and specify the value of the ListHealthChecksResponse$NextMarker element from the previous response. On the last (sixth) page of the response, which contains only one HealthCheck element:

", "location":"querystring", "locationName":"maxitems" } }, "documentation":"

To retrieve a list of your health checks, send a GET request to the /2013-04-01/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.

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.

" }, "ListHealthChecksResponse":{ "type":"structure", "required":[ "HealthChecks", "Marker", "IsTruncated", "MaxItems" ], "members":{ "HealthChecks":{ "shape":"HealthChecks", "documentation":"

A complex type that contains one HealthCheck element for each health check that is associated with the current AWS account.

" }, "Marker":{ "shape":"PageMarker", "documentation":"

For the second and subsequent calls to ListHealthChecks, Marker is the value that you specified for the marker parameter in the previous request.

" }, "IsTruncated":{ "shape":"PageTruncated", "documentation":"

A flag that indicates whether there are more health checks to be listed. If the response was truncated, you can get the next group of maxitems health checks by calling ListHealthChecks again and specifying the value of the NextMarker element in the marker parameter.

Valid Values: true | false

" }, "NextMarker":{ "shape":"PageMarker", "documentation":"

If IsTruncated is true, the value of NextMarker identifies the first health check in the next group of maxitems health checks. Call ListHealthChecks again and specify the value of NextMarker in the marker parameter.

" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The value that you specified for the maxitems parameter in the call to ListHealthChecks that produced the current response.

" } }, "documentation":"

A complex type that contains the response to a ListHealthChecks request.

" }, "ListHostedZonesByNameRequest":{ "type":"structure", "members":{ "DNSName":{ "shape":"DNSName", "documentation":"

(Optional) For your first request to ListHostedZonesByName, include the dnsname parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the dnsname parameter, Amazon Route 53 returns all of the hosted zones that were created by the current AWS account, in ASCII order. For subsequent requests, include both dnsname and hostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response.

", "location":"querystring", "locationName":"dnsname" }, "HostedZoneId":{ "shape":"ResourceId", "documentation":"

(Optional) For your first request to ListHostedZonesByName, do not include the hostedzoneid parameter.

If you have more hosted zones than the value of maxitems, ListHostedZonesByName returns only the first maxitems hosted zones. To get the next group of maxitems hosted zones, submit another request to ListHostedZonesByName and include both dnsname and hostedzoneid parameters. For the value of hostedzoneid, specify the value of the NextHostedZoneId element from the previous response.

", "location":"querystring", "locationName":"hostedzoneid" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems hosted zones, then the value of the IsTruncated element in the response is true, and the values of NextDNSName and NextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones.

", "location":"querystring", "locationName":"maxitems" } }, "documentation":"

To retrieve a list of your public and private hosted zones in ASCII order by domain name, send a GET request to the /Amazon Route 53 API version/hostedzonesbyname resource. The response to this request includes a HostedZone child element for each hosted zone that was created by the current AWS account. ListHostedZonesByName sorts hosted zones by name with the labels reversed, for example:

com.example.www.

Note the trailing dot, which can change the sort order in some circumstances.

If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex\\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as: com.ex\\344mple. The labels are reversed, and it's alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

Amazon Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, you can use the MaxItems parameter to list them in groups of up to 100. The response includes values that help you navigate from one group of MaxItems hosted zones to the next:

  • The DNSName and HostedZoneId elements in the response contain the values, if any, that you specified for the dnsname and hostedzoneid parameters in the request that produced the current response.

  • The MaxItems element in the response contains the value, if any, that you specified for the maxitems parameter in the request that produced the current response.

  • If the value of IsTruncated in the response is true, there are more hosted zones associated with the current Amazon Route 53 account.

    If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. The NextDNSName element and NextHostedZoneId elements are omitted from the response.

  • The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to ListHostedZonesByName, and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

" }, "ListHostedZonesByNameResponse":{ "type":"structure", "required":[ "HostedZones", "IsTruncated", "MaxItems" ], "members":{ "HostedZones":{ "shape":"HostedZones", "documentation":"

A complex type that contains general information about the hosted zone.

" }, "DNSName":{ "shape":"DNSName", "documentation":"

For the second and subsequent calls to ListHostedZonesByName, DNSName is the value that you specified for the dnsname parameter in the request that produced the current response.

" }, "HostedZoneId":{ "shape":"ResourceId", "documentation":"

The ID that Amazon Route 53 assigned to the hosted zone when you created it.

" }, "IsTruncated":{ "shape":"PageTruncated", "documentation":"

A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of maxitems hosted zones by calling ListHostedZonesByName again and specifying the values of NextDNSName and NextHostedZoneId elements in the dnsname and hostedzoneid parameters.

" }, "NextDNSName":{ "shape":"DNSName", "documentation":"

If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

This element is present only if IsTruncated is true.

" }, "NextHostedZoneId":{ "shape":"ResourceId", "documentation":"

If IsTruncated is true, the value of NextHostedZoneId identifies the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

This element is present only if IsTruncated is true.

" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The value that you specified for the maxitems parameter in the call to ListHostedZonesByName that produced the current response.

" } }, "documentation":"

A complex type that contains the response information for the request.

" }, "ListHostedZonesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"PageMarker", "documentation":"

(Optional) If you have more hosted zones than the value of maxitems, ListHostedZones returns only the first maxitems hosted zones. To get the next group of maxitems hosted zones, submit another request to ListHostedZones. For the value of marker, specify the value of the NextMarker element that was returned in the previous response.

Hosted zones are listed in the order in which they were created.

", "location":"querystring", "locationName":"marker" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

(Optional) The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems hosted zones, the value of the IsTruncated element in the response is true, and the value of the NextMarker element is the hosted zone ID of the first hosted zone in the next group of maxitems hosted zones.

", "location":"querystring", "locationName":"maxitems" }, "DelegationSetId":{ "shape":"ResourceId", "documentation":"

If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set.

", "location":"querystring", "locationName":"delegationsetid" } }, "documentation":"

To retrieve a list of your public and private hosted zones, send a GET request to the /2013-04-01/hostedzone resource. The response to this request includes a HostedZone child element for each hosted zone that was created by the current AWS account.

Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the maxitems parameter to list them in groups of up to 100. The response includes four values that help you navigate from one group of maxitems hosted zones to the next:

  • MaxItems is the value that you specified for the maxitems parameter in the request that produced the current response.

  • If the value of IsTruncated in the response is true, there are more hosted zones associated with the current AWS account.

    If IsTruncated is false, this response includes the last hosted zone that is associated with the current account.

  • NextMarker is the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to ListHostedZones, and specify the value of the NextMarker element in the marker parameter.

    If IsTruncated is false, the NextMarker element is omitted from the response.

  • If you're making the second or subsequent call to ListHostedZones, the Marker element matches the value that you specified in the marker parameter in the previous request.

" }, "ListHostedZonesResponse":{ "type":"structure", "required":[ "HostedZones", "Marker", "IsTruncated", "MaxItems" ], "members":{ "HostedZones":{ "shape":"HostedZones", "documentation":"

A complex type that contains general information about the hosted zone.

" }, "Marker":{ "shape":"PageMarker", "documentation":"

For the second and subsequent calls to ListHostedZones, Marker is the value that you specified for the marker parameter in the request that produced the current response.

" }, "IsTruncated":{ "shape":"PageTruncated", "documentation":"

A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of maxitems hosted zones by calling ListHostedZones again and specifying the value of the NextMarker element in the marker parameter.

" }, "NextMarker":{ "shape":"PageMarker", "documentation":"

If IsTruncated is true, the value of NextMarker identifies the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZones again and specify the value of NextMarker in the marker parameter.

This element is present only if IsTruncated is true.

" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The value that you specified for the maxitems parameter in the call to ListHostedZones that produced the current response.

" } } }, "ListResourceRecordSetsRequest":{ "type":"structure", "required":["HostedZoneId"], "members":{ "HostedZoneId":{ "shape":"ResourceId", "documentation":"

The ID of the hosted zone that contains the resource record sets that you want to get.

", "location":"uri", "locationName":"Id" }, "StartRecordName":{ "shape":"DNSName", "documentation":"

The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.

", "location":"querystring", "locationName":"name" }, "StartRecordType":{ "shape":"RRType", "documentation":"

The type of resource record set to begin the record listing from.

Valid values for basic resource record sets: A | AAAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

Values for weighted, latency, geo, and failover resource record sets: A | AAAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT

Values for alias resource record sets:

  • CloudFront distribution: A or AAAA

  • Elastic Beanstalk environment that has a regionalized subdomain: A

  • ELB load balancer: A | AAAA

  • Amazon S3 bucket: A

Constraint: Specifying type without specifying name returns an InvalidInput error.

", "location":"querystring", "locationName":"type" }, "StartRecordIdentifier":{ "shape":"ResourceRecordSetIdentifier", "documentation":"

Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

", "location":"querystring", "locationName":"identifier" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

(Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more than maxitems resource record sets, the value of the IsTruncated element in the response is true, and the values of the NextRecordName and NextRecordType elements in the response identify the first resource record set in the next group of maxitems resource record sets.

", "location":"querystring", "locationName":"maxitems" } }, "documentation":"

The input for a ListResourceRecordSets request.

" }, "ListResourceRecordSetsResponse":{ "type":"structure", "required":[ "ResourceRecordSets", "IsTruncated", "MaxItems" ], "members":{ "ResourceRecordSets":{ "shape":"ResourceRecordSets", "documentation":"

Information about multiple resource record sets.

" }, "IsTruncated":{ "shape":"PageTruncated", "documentation":"

A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you can make a follow-up pagination request by using the NextRecordName element.

" }, "NextRecordName":{ "shape":"DNSName", "documentation":"

If the results were truncated, the name of the next record in the list.

This element is present only if IsTruncated is true.

" }, "NextRecordType":{ "shape":"RRType", "documentation":"

If the results were truncated, the type of the next record in the list.

This element is present only if IsTruncated is true.

" }, "NextRecordIdentifier":{ "shape":"ResourceRecordSetIdentifier", "documentation":"

Weighted, latency, geolocation, and failover 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.

" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The maximum number of records you requested.

" } }, "documentation":"

A complex type that contains list information for the resource record set.

" }, "ListReusableDelegationSetsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"PageMarker", "documentation":"

If you're making the second or subsequent call to ListReusableDelegationSets, the Marker element matches the value that you specified in the marker parameter in the previous request.

", "location":"querystring", "locationName":"marker" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The value that you specified for the maxitems parameter in the request that produced the current response.

", "location":"querystring", "locationName":"maxitems" } }, "documentation":"

To retrieve a list of your reusable delegation sets, send a GET request to the /2013-04-01/delegationset resource. The response to this request includes a DelegationSets element with zero or more DelegationSet child elements. By default, the list of reusable delegation sets 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 delegation set that the list begins with.

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.

" }, "ListReusableDelegationSetsResponse":{ "type":"structure", "required":[ "DelegationSets", "Marker", "IsTruncated", "MaxItems" ], "members":{ "DelegationSets":{ "shape":"DelegationSets", "documentation":"

A complex type that contains one DelegationSet element for each reusable delegation set that was created by the current AWS account.

" }, "Marker":{ "shape":"PageMarker", "documentation":"

For the second and subsequent calls to ListReusableDelegationSets, Marker is the value that you specified for the marker parameter in the request that produced the current response.

" }, "IsTruncated":{ "shape":"PageTruncated", "documentation":"

A flag that indicates whether there are more reusable delegation sets to be listed. If the response is truncated, you can get the next group of maxitems reusable delegation sets by calling ListReusableDelegationSets again and specifying the value of the NextMarker element in the marker parameter.

" }, "NextMarker":{ "shape":"PageMarker", "documentation":"

If IsTruncated is true, the value of NextMarker identifies the first reusable delegation set in the next group of maxitems reusable delegation sets. Call ListReusableDelegationSets again and specify the value of NextMarker in the marker parameter.

" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The value that you specified for the maxitems parameter in the call to ListReusableDelegationSets that produced the current response.

" } }, "documentation":"

A complex type that contains information about the reusable delegation sets that are associated with the current AWS account.

" }, "ListTagsForResourceRequest":{ "type":"structure", "required":[ "ResourceType", "ResourceId" ], "members":{ "ResourceType":{ "shape":"TagResourceType", "documentation":"

The type of the resource.

  • The resource type for health checks is healthcheck.

  • The resource type for hosted zones is hostedzone.

", "location":"uri", "locationName":"ResourceType" }, "ResourceId":{ "shape":"TagResourceId", "documentation":"

The ID of the resource for which you want to retrieve tags.

", "location":"uri", "locationName":"ResourceId" } }, "documentation":"

A complex type containing information about a request for a list of the tags that are associated with an individual resource.

" }, "ListTagsForResourceResponse":{ "type":"structure", "required":["ResourceTagSet"], "members":{ "ResourceTagSet":{ "shape":"ResourceTagSet", "documentation":"

A ResourceTagSet containing tags associated with the specified resource.

" } }, "documentation":"

A complex type that contains information about the health checks or hosted zones for which you want to list tags.

" }, "ListTagsForResourcesRequest":{ "type":"structure", "required":[ "ResourceType", "ResourceIds" ], "members":{ "ResourceType":{ "shape":"TagResourceType", "documentation":"

The type of the resources.

  • The resource type for health checks is healthcheck.

  • The resource type for hosted zones is hostedzone.

", "location":"uri", "locationName":"ResourceType" }, "ResourceIds":{ "shape":"TagResourceIdList", "documentation":"

A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.

" } }, "documentation":"

A complex type that contains information about the health checks or hosted zones for which you want to list tags.

" }, "ListTagsForResourcesResponse":{ "type":"structure", "required":["ResourceTagSets"], "members":{ "ResourceTagSets":{ "shape":"ResourceTagSetList", "documentation":"

A list of ResourceTagSets containing tags associated with the specified resources.

" } }, "documentation":"

A complex type containing tags for the specified resources.

" }, "ListTrafficPoliciesRequest":{ "type":"structure", "members":{ "TrafficPolicyIdMarker":{ "shape":"TrafficPolicyId", "documentation":"

(Conditional) For your first request to ListTrafficPolicies, do not include the TrafficPolicyIdMarker parameter.

If you have more traffic policies than the value of MaxItems, ListTrafficPolicies returns only the first MaxItems traffic policies. To get the next group of MaxItems policies, submit another request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value of the TrafficPolicyIdMarker element that was returned in the previous response.

Policies are listed in the order in which they were created.

", "location":"querystring", "locationName":"trafficpolicyid" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

(Optional) The maximum number of traffic policies to be included in the response body for this request. If you have more than MaxItems traffic policies, the value of the IsTruncated element in the response is true, and the value of the TrafficPolicyIdMarker element is the ID of the first traffic policy in the next group of MaxItems traffic policies.

", "location":"querystring", "locationName":"maxitems" } }, "documentation":"

A complex type that contains the information about the request to list the traffic policies that are associated with the current AWS account.

" }, "ListTrafficPoliciesResponse":{ "type":"structure", "required":[ "TrafficPolicySummaries", "IsTruncated", "TrafficPolicyIdMarker", "MaxItems" ], "members":{ "TrafficPolicySummaries":{ "shape":"TrafficPolicySummaries", "documentation":"

A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current AWS account.

" }, "IsTruncated":{ "shape":"PageTruncated", "documentation":"

A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of MaxItems traffic policies by calling ListTrafficPolicies again and specifying the value of the TrafficPolicyIdMarker element in the TrafficPolicyIdMarker request parameter.

Valid Values: true | false

" }, "TrafficPolicyIdMarker":{ "shape":"TrafficPolicyId", "documentation":"

If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies.

" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The value that you specified for the MaxItems parameter in the call to ListTrafficPolicies that produced the current response.

" } }, "documentation":"

A complex type that contains the response information for the request.

" }, "ListTrafficPolicyInstancesByHostedZoneRequest":{ "type":"structure", "required":["HostedZoneId"], "members":{ "HostedZoneId":{ "shape":"ResourceId", "documentation":"

The ID of the hosted zone for which you want to list traffic policy instances.

", "location":"querystring", "locationName":"id" }, "TrafficPolicyInstanceNameMarker":{ "shape":"DNSName", "documentation":"

For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

If the value of IsTruncated in the previous response was false, omit this value.

", "location":"querystring", "locationName":"trafficpolicyinstancename" }, "TrafficPolicyInstanceTypeMarker":{ "shape":"RRType", "documentation":"

For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

", "location":"querystring", "locationName":"trafficpolicyinstancetype" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

", "location":"querystring", "locationName":"maxitems" } }, "documentation":"

A request for the traffic policy instances that you created in a specified hosted zone.

" }, "ListTrafficPolicyInstancesByHostedZoneResponse":{ "type":"structure", "required":[ "TrafficPolicyInstances", "IsTruncated", "MaxItems" ], "members":{ "TrafficPolicyInstances":{ "shape":"TrafficPolicyInstances", "documentation":"

A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

" }, "TrafficPolicyInstanceNameMarker":{ "shape":"DNSName", "documentation":"

If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

" }, "TrafficPolicyInstanceTypeMarker":{ "shape":"RRType", "documentation":"

If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.

" }, "IsTruncated":{ "shape":"PageTruncated", "documentation":"

A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of MaxItems traffic policy instances by calling ListTrafficPolicyInstancesByHostedZone again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByHostedZone that produced the current response.

" } }, "documentation":"

A complex type that contains the response information for the request.

" }, "ListTrafficPolicyInstancesByPolicyRequest":{ "type":"structure", "required":[ "TrafficPolicyId", "TrafficPolicyVersion" ], "members":{ "TrafficPolicyId":{ "shape":"TrafficPolicyId", "documentation":"

The ID of the traffic policy for which you want to list traffic policy instances.

", "location":"querystring", "locationName":"id" }, "TrafficPolicyVersion":{ "shape":"TrafficPolicyVersion", "documentation":"

The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.

", "location":"querystring", "locationName":"version" }, "HostedZoneIdMarker":{ "shape":"ResourceId", "documentation":"

For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.

If the value of IsTruncated in the previous response was true, HostedZoneIdMarker is the ID of the hosted zone for the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

If the value of IsTruncated in the previous response was false, omit this value.

", "location":"querystring", "locationName":"hostedzoneid" }, "TrafficPolicyInstanceNameMarker":{ "shape":"DNSName", "documentation":"

For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

If the value of IsTruncated in the previous response was false, omit this value.

", "location":"querystring", "locationName":"trafficpolicyinstancename" }, "TrafficPolicyInstanceTypeMarker":{ "shape":"RRType", "documentation":"

For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

", "location":"querystring", "locationName":"trafficpolicyinstancetype" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

", "location":"querystring", "locationName":"maxitems" } }, "documentation":"

A complex type that contains the information about the request to list your traffic policy instances.

" }, "ListTrafficPolicyInstancesByPolicyResponse":{ "type":"structure", "required":[ "TrafficPolicyInstances", "IsTruncated", "MaxItems" ], "members":{ "TrafficPolicyInstances":{ "shape":"TrafficPolicyInstances", "documentation":"

A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

" }, "HostedZoneIdMarker":{ "shape":"ResourceId", "documentation":"

If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of MaxItems traffic policy instances.

" }, "TrafficPolicyInstanceNameMarker":{ "shape":"DNSName", "documentation":"

If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

" }, "TrafficPolicyInstanceTypeMarker":{ "shape":"RRType", "documentation":"

If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.

" }, "IsTruncated":{ "shape":"PageTruncated", "documentation":"

A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of MaxItems traffic policy instances by calling ListTrafficPolicyInstancesByPolicy again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByPolicy that produced the current response.

" } }, "documentation":"

A complex type that contains the response information for the request.

" }, "ListTrafficPolicyInstancesRequest":{ "type":"structure", "members":{ "HostedZoneIdMarker":{ "shape":"ResourceId", "documentation":"

For the first request to ListTrafficPolicyInstances, omit this value.

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get the next group of MaxItems traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneIdMarker, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

", "location":"querystring", "locationName":"hostedzoneid" }, "TrafficPolicyInstanceNameMarker":{ "shape":"DNSName", "documentation":"

For the first request to ListTrafficPolicyInstances, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

", "location":"querystring", "locationName":"trafficpolicyinstancename" }, "TrafficPolicyInstanceTypeMarker":{ "shape":"RRType", "documentation":"

For the first request to ListTrafficPolicyInstances, omit this value.

If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

", "location":"querystring", "locationName":"trafficpolicyinstancetype" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

", "location":"querystring", "locationName":"maxitems" } }, "documentation":"

A complex type that contains the information about the request to list your traffic policy instances.

" }, "ListTrafficPolicyInstancesResponse":{ "type":"structure", "required":[ "TrafficPolicyInstances", "IsTruncated", "MaxItems" ], "members":{ "TrafficPolicyInstances":{ "shape":"TrafficPolicyInstances", "documentation":"

A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

" }, "HostedZoneIdMarker":{ "shape":"ResourceId", "documentation":"

If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of MaxItems traffic policy instances.

" }, "TrafficPolicyInstanceNameMarker":{ "shape":"DNSName", "documentation":"

If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

" }, "TrafficPolicyInstanceTypeMarker":{ "shape":"RRType", "documentation":"

If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.

" }, "IsTruncated":{ "shape":"PageTruncated", "documentation":"

A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of MaxItems traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that produced the current response.

" } }, "documentation":"

A complex type that contains the response information for the request.

" }, "ListTrafficPolicyVersionsRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"TrafficPolicyId", "documentation":"

Specify the value of Id of the traffic policy for which you want to list all versions.

", "location":"uri", "locationName":"Id" }, "TrafficPolicyVersionMarker":{ "shape":"TrafficPolicyVersionMarker", "documentation":"

For your first request to ListTrafficPolicyVersions, do not include the TrafficPolicyVersionMarker parameter.

If you have more traffic policy versions than the value of MaxItems, ListTrafficPolicyVersions returns only the first group of MaxItems versions. To get the next group of MaxItems traffic policy versions, submit another request to ListTrafficPolicyVersions. For the value of TrafficPolicyVersionMarker, specify the value of the TrafficPolicyVersionMarker element that was returned in the previous response.

Traffic policy versions are listed in sequential order.

", "location":"querystring", "locationName":"trafficpolicyversion" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than MaxItems versions, the value of the IsTruncated element in the response is true, and the value of the TrafficPolicyVersionMarker element is the ID of the first version in the next group of MaxItems traffic policy versions.

", "location":"querystring", "locationName":"maxitems" } }, "documentation":"

A complex type that contains the information about the request to list your traffic policies.

" }, "ListTrafficPolicyVersionsResponse":{ "type":"structure", "required":[ "TrafficPolicies", "IsTruncated", "TrafficPolicyVersionMarker", "MaxItems" ], "members":{ "TrafficPolicies":{ "shape":"TrafficPolicies", "documentation":"

A list that contains one TrafficPolicy element for each traffic policy version that is associated with the specified traffic policy.

" }, "IsTruncated":{ "shape":"PageTruncated", "documentation":"

A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of maxitems traffic policies by calling ListTrafficPolicyVersions again and specifying the value of the NextMarker element in the marker parameter.

" }, "TrafficPolicyVersionMarker":{ "shape":"TrafficPolicyVersionMarker", "documentation":"

If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the first traffic policy in the next group of MaxItems traffic policies. Call ListTrafficPolicyVersions again and specify the value of TrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter.

This element is present only if IsTruncated is true.

" }, "MaxItems":{ "shape":"PageMaxItems", "documentation":"

The value that you specified for the maxitems parameter in the call to ListTrafficPolicyVersions that produced the current response.

" } }, "documentation":"

A complex type that contains the response information for the request.

" }, "ListVPCAssociationAuthorizationsRequest":{ "type":"structure", "required":["HostedZoneId"], "members":{ "HostedZoneId":{ "shape":"ResourceId", "documentation":"

The ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone.

", "location":"uri", "locationName":"Id" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

Optional: If a response includes a NextToken element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of results, submit another request, and include the value of the NextToken element in from the response in the NextToken parameter in another ListVPCAssociationAuthorizations request.

", "location":"querystring", "locationName":"nexttoken" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

Optional: An integer that specifies the maximum number of VPCs that you want Amazon Route 53 to return.

", "location":"querystring", "locationName":"maxresults" } }, "documentation":"

A complex type that contains information about that can be associated with your hosted zone.

" }, "ListVPCAssociationAuthorizationsResponse":{ "type":"structure", "required":[ "HostedZoneId", "VPCs" ], "members":{ "HostedZoneId":{ "shape":"ResourceId", "documentation":"

The ID of the hosted zone that you can associate the listed VPCs with.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

When the response includes a NextToken element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of VPCs, submit another ListVPCAssociationAuthorizations request, and include the value of the NextToken element from the response in the NextToken request parameter:

/2013-04-01/hostedzone/hosted zone ID/authorizevpcassociation?MaxItems=VPCs per page&NextToken=

" }, "VPCs":{ "shape":"VPCs", "documentation":"

The list of VPCs that are authorized to be associated with the specified hosted zone.

" } }, "documentation":"

A complex type that contains the response information for the request.

" }, "MaxResults":{"type":"string"}, "MeasureLatency":{"type":"boolean"}, "Message":{ "type":"string", "max":1024 }, "MetricName":{ "type":"string", "max":255, "min":1 }, "Nameserver":{ "type":"string", "max":255, "min":0 }, "Namespace":{ "type":"string", "max":255, "min":1 }, "NoSuchChange":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

A change with the specified change ID does not exist.

", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchDelegationSet":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

A reusable delegation set with the specified ID does not exist.

", "exception":true }, "NoSuchGeoLocation":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

Amazon Route 53 doesn't support the specified geolocation.

", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchHealthCheck":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

No health check exists with the ID that you specified in the DeleteHealthCheck request.

", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchHostedZone":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

No hosted zone exists with the ID that you specified.

", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchTrafficPolicy":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

No traffic policy exists with the specified ID.

", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchTrafficPolicyInstance":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

No traffic policy instance exists with the specified ID.

", "error":{"httpStatusCode":404}, "exception":true }, "Nonce":{ "type":"string", "max":128, "min":1 }, "NotAuthorizedException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

Associating the specified VPC with the specified hosted zone has not been authorized.

", "error":{"httpStatusCode":401}, "exception":true }, "PageMarker":{ "type":"string", "max":64 }, "PageMaxItems":{"type":"string"}, "PageTruncated":{"type":"boolean"}, "PaginationToken":{ "type":"string", "max":256 }, "Period":{ "type":"integer", "min":60 }, "Port":{ "type":"integer", "max":65535, "min":1 }, "PriorRequestNotComplete":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent requests for the same hosted zone and return an HTTP 400 error (Bad request). If Amazon Route 53 returns this error repeatedly for the same request, we recommend that you wait, in intervals of increasing duration, before you try the request again.

", "error":{"httpStatusCode":400}, "exception":true }, "PublicZoneVPCAssociation":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

You're trying to associate a VPC with a public hosted zone. Amazon Route 53 doesn't support associating a VPC with a public hosted zone.

", "error":{"httpStatusCode":400}, "exception":true }, "RData":{ "type":"string", "max":4000 }, "RRType":{ "type":"string", "enum":[ "SOA", "A", "TXT", "NS", "CNAME", "MX", "NAPTR", "PTR", "SRV", "SPF", "AAAA" ] }, "RecordData":{ "type":"list", "member":{ "shape":"RecordDataEntry", "locationName":"RecordDataEntry" } }, "RecordDataEntry":{ "type":"string", "documentation":"

A value that Amazon Route 53 returned for this resource record set. A RecordDataEntry element is one of the following:

  • For non-alias resource record sets, a RecordDataEntry element contains one value in the resource record set. If the resource record set contains multiple values, the response includes one RecordDataEntry element for each value.

  • For multiple resource record sets that have the same name and type, which includes weighted, latency, geolocation, and failover, a RecordDataEntry element contains the value from the appropriate resource record set based on the request.

  • For alias resource record sets that refer to AWS resources other than another resource record set, the RecordDataEntry element contains an IP address or a domain name for the AWS resource, depending on the type of resource.

  • For alias resource record sets that refer to other resource record sets, a RecordDataEntry element contains one value from the referenced resource record set. If the referenced resource record set contains multiple values, the response includes one RecordDataEntry element for each value.

", "max":512, "min":0 }, "RequestInterval":{ "type":"integer", "max":30, "min":10 }, "ResourceDescription":{ "type":"string", "max":256 }, "ResourceId":{ "type":"string", "max":32 }, "ResourcePath":{ "type":"string", "max":255 }, "ResourceRecord":{ "type":"structure", "required":["Value"], "members":{ "Value":{ "shape":"RData", "documentation":"

The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action, if the current value does not match the actual value, an error is returned. For descriptions about how to format Value for different record types, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

You can specify more than one value for all record types except CNAME and SOA.

If you are creating an alias resource record set, omit Value.

" } }, "documentation":"

Information specific to the resource record.

If you are creating an alias resource record set, omit ResourceRecord.

" }, "ResourceRecordSet":{ "type":"structure", "required":[ "Name", "Type" ], "members":{ "Name":{ "shape":"DNSName", "documentation":"

The name of the domain you want to perform the action on.

Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 still assumes that the domain name that you specify is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

You can use the asterisk (*) wildcard to replace the leftmost label in a domain name. For example, *.example.com. Note the following:

  • The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com.

  • The * can't replace any of the middle labels, for example, marketing.*.example.com.

  • If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.

    You can't use the * wildcard for resource records sets that have a type of NS.

You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You can't use an * for one of the middle labels, for example, marketing.*.example.com. In addition, the * must replace the entire label; for example, you can't specify prod*.example.com.

" }, "Type":{ "shape":"RRType", "documentation":"

The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

Valid values for basic resource record sets: A | AAAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.

SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated to say, \"...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.\" In RFC 7208, see section 14.1, The SPF DNS Record Type.

Values for alias resource record sets:

  • CloudFront distributions: A

    If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA.

  • AWS Elastic Beanstalk environment that has a regionalized subdomain: A

  • ELB load balancers: A | AAAA

  • Amazon S3 buckets: A

  • Another resource record set in this hosted zone: Specify the type of the resource record set for which you're creating the alias. Specify any value except NS or SOA.

" }, "SetIdentifier":{ "shape":"ResourceRecordSetIdentifier", "documentation":"

Weighted, Latency, Geo, 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. The value of SetIdentifier must be unique for each resource record set that has the same combination of DNS name and type. Omit SetIdentifier for any other types of record sets.

" }, "Weight":{ "shape":"ResourceRecordSetWeight", "documentation":"

Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Amazon Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Amazon Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:

  • You must specify a value for the Weight element for every weighted resource record set.

  • You can only specify one ResourceRecord per weighted resource record set.

  • You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets.

  • You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements.

  • For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Amazon Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.

    The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Amazon Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.

" }, "Region":{ "shape":"ResourceRecordSetRegion", "documentation":"

Latency-based resource record sets only: The Amazon EC2 Region where the resource that is specified in this resource record set resides. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.

Creating latency and latency alias resource record sets in private hosted zones is not supported.

When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Amazon Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Amazon Route 53 then returns the value that is associated with the selected resource record set.

Note the following:

  • You can only specify one ResourceRecord per latency resource record set.

  • You can only create one latency resource record set for each Amazon EC2 Region.

  • You are not required to create latency resource record sets for all Amazon EC2 Regions. Amazon Route 53 will choose the region with the best latency from among the regions for which you create latency resource record sets.

  • You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.

" }, "GeoLocation":{ "shape":"GeoLocation", "documentation":"

Geo location resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF.

Creating geolocation and geolocation alias resource record sets in private hosted zones is not supported.

If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.

You can't create two geolocation resource record sets that specify the same geographic location.

The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.

Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Amazon Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *, which handles both queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Amazon Route 53 returns a \"no answer\" response for queries from those locations.

You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.

" }, "Failover":{ "shape":"ResourceRecordSetFailover", "documentation":"

Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.

Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:

  • When the primary resource record set is healthy, Amazon Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.

  • When the primary resource record set is unhealthy and the secondary resource record set is healthy, Amazon Route 53 responds to DNS queries with the applicable value from the secondary resource record set.

  • When the secondary resource record set is unhealthy, Amazon Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.

  • If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Amazon Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.

You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.

For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.

For more information about configuring failover for Amazon Route 53, see the following topics in the Amazon Route 53 Developer Guide:

Valid values: PRIMARY | SECONDARY

" }, "TTL":{ "shape":"TTL", "documentation":"

The resource record cache time to live (TTL), in seconds. Note the following:

  • If you're creating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL for the alias target.

  • If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.

  • All of the resource record sets in a group of weighted, latency, geolocation, or failover resource record sets must have the same value for TTL.

  • If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for Weight.

" }, "ResourceRecords":{ "shape":"ResourceRecords", "documentation":"

Information about the resource records to act upon.

If you are creating an alias resource record set, omit ResourceRecords.

" }, "AliasTarget":{ "shape":"AliasTarget", "documentation":"

Alias resource record sets only: Information about the CloudFront distribution, AWS Elastic Beanstalk environment, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which you are redirecting queries. The AWS Elastic Beanstalk environment must have a regionalized subdomain.

If you're creating resource records sets for a private hosted zone, note the following:

  • You can't create alias resource record sets for CloudFront distributions in a private hosted zone.

  • Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.

  • For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.

" }, "HealthCheckId":{ "shape":"HealthCheckId", "documentation":"

If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include the HealthCheckId element and specify the ID of the applicable health check.

Amazon Route 53 determines whether a resource record set is healthy based on one of the following:

  • By periodically sending a request to the endpoint that is specified in the health check

  • By aggregating the status of a specified group of health checks (calculated health checks)

  • By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)

For information about how Amazon Route 53 determines whether a health check is healthy, see CreateHealthCheck.

The HealthCheckId element is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations:

  • You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.

  • You set EvaluateTargetHealth to true for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets.

Amazon Route 53 doesn't check the health of the endpoint specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Amazon Route 53 checks the health of the endpoint that you specified in the health check.

For geolocation resource record sets, if an endpoint is unhealthy, Amazon Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value of CountryCode is *), in that order, until it finds a resource record set for which the endpoint is healthy.

If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-1-www.example.com), not the name of the resource record sets (example.com).

n this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and then associate the health check with those resource record sets, health check results will be unpredictable.

For more information, see the following topics in the Amazon Route 53 Developer Guide:

" }, "TrafficPolicyInstanceId":{ "shape":"TrafficPolicyInstanceId", "documentation":"

When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. TrafficPolicyInstanceId is the ID of the traffic policy instance that Amazon Route 53 created this resource record set for.

To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Amazon Route 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, Amazon Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

" } }, "documentation":"

Information about the resource record set to create or delete.

" }, "ResourceRecordSetFailover":{ "type":"string", "enum":[ "PRIMARY", "SECONDARY" ] }, "ResourceRecordSetIdentifier":{ "type":"string", "max":128, "min":1 }, "ResourceRecordSetRegion":{ "type":"string", "enum":[ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-west-2", "eu-central-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2", "sa-east-1", "cn-north-1", "ap-south-1" ], "max":64, "min":1 }, "ResourceRecordSetWeight":{ "type":"long", "max":255, "min":0 }, "ResourceRecordSets":{ "type":"list", "member":{ "shape":"ResourceRecordSet", "locationName":"ResourceRecordSet" } }, "ResourceRecords":{ "type":"list", "member":{ "shape":"ResourceRecord", "locationName":"ResourceRecord" }, "min":1 }, "ResourceTagSet":{ "type":"structure", "members":{ "ResourceType":{ "shape":"TagResourceType", "documentation":"

The type of the resource.

  • The resource type for health checks is healthcheck.

  • The resource type for hosted zones is hostedzone.

" }, "ResourceId":{ "shape":"TagResourceId", "documentation":"

The ID for the specified resource.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags associated with the specified resource.

" } }, "documentation":"

A complex type containing a resource and its associated tags.

" }, "ResourceTagSetList":{ "type":"list", "member":{ "shape":"ResourceTagSet", "locationName":"ResourceTagSet" } }, "ResourceURI":{ "type":"string", "max":1024 }, "SearchString":{ "type":"string", "max":255 }, "Statistic":{ "type":"string", "enum":[ "Average", "Sum", "SampleCount", "Maximum", "Minimum" ] }, "Status":{"type":"string"}, "StatusReport":{ "type":"structure", "members":{ "Status":{ "shape":"Status", "documentation":"

A description of the status of the health check endpoint as reported by one of the Amazon Route 53 health checkers.

" }, "CheckedTime":{ "shape":"TimeStamp", "documentation":"

The time at which the health checker performed the health check in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2014-10-27T17:48:16.751Z represents October 27, 2014 at 17:48:16.751 UTC.

" } }, "documentation":"

A complex type that contains the status that one Amazon Route 53 health checker reports and the time of the health check.

" }, "SubnetMask":{ "type":"string", "max":2, "min":0 }, "TTL":{ "type":"long", "max":2147483647, "min":0 }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"TagKey", "documentation":"

The value of Key depends on the operation that you want to perform:

  • Add a tag to a health check or hosted zone: Key is the name that you want to give the new tag.

  • Edit a tag: Key is the name of the tag whose Value element you want to remove.

  • Delete a key: Key is the name of the tag you want to remove.

  • Give a name to a health check: Edit the default Name tag. In the Amazon Route 53 console, the list of your health checks includes a Name column that lets you see the name that you've given to each health check.

" }, "Value":{ "shape":"TagValue", "documentation":"

The value of Value depends on the operation that you want to perform:

  • Add a tag to a health check or hosted zone: Value is the value that you want to give the new tag.

  • Edit a tag: Value is the new value that you want to assign the tag.

" } }, "documentation":"

A complex type that contains information about a tag that you want to add or edit for the specified health check or hosted zone.

" }, "TagKey":{ "type":"string", "max":128 }, "TagKeyList":{ "type":"list", "member":{ "shape":"TagKey", "locationName":"Key" }, "max":10, "min":1 }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"Tag" }, "max":10, "min":1 }, "TagResourceId":{ "type":"string", "max":64 }, "TagResourceIdList":{ "type":"list", "member":{ "shape":"TagResourceId", "locationName":"ResourceId" }, "max":10, "min":1 }, "TagResourceType":{ "type":"string", "enum":[ "healthcheck", "hostedzone" ] }, "TagValue":{ "type":"string", "max":256 }, "TestDNSAnswerRequest":{ "type":"structure", "required":[ "HostedZoneId", "RecordName", "RecordType" ], "members":{ "HostedZoneId":{ "shape":"ResourceId", "documentation":"

The ID of the hosted zone that you want Amazon Route 53 to simulate a query for.

", "location":"querystring", "locationName":"hostedzoneid" }, "RecordName":{ "shape":"DNSName", "documentation":"

The name of the resource record set that you want Amazon Route 53 to simulate a query for.

", "location":"querystring", "locationName":"recordname" }, "RecordType":{ "shape":"RRType", "documentation":"

The type of the resource record set.

", "location":"querystring", "locationName":"recordtype" }, "ResolverIP":{ "shape":"IPAddress", "documentation":"

If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. If you omit this value, TestDnsAnswer uses the IP address of a DNS resolver in the AWS US East region.

", "location":"querystring", "locationName":"resolverip" }, "EDNS0ClientSubnetIP":{ "shape":"IPAddress", "documentation":"

If the resolver that you specified for resolverip supports EDNS0, specify the IP address of a client in the applicable location.

", "location":"querystring", "locationName":"edns0clientsubnetip" }, "EDNS0ClientSubnetMask":{ "shape":"SubnetMask", "documentation":"

If you specify an IP address for edns0clientsubnetip, you can optionally specify the number of bits of the IP address that you want the checking tool to include in the DNS query. For example, if you specify 192.0.2.44 for edns0clientsubnetip and 24 for edns0clientsubnetmask, the checking tool will simulate a request from 192.0.2.0/24. The default value is 24 bits.

", "location":"querystring", "locationName":"edns0clientsubnetmask" } }, "documentation":"

Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.

Parameters

hostedzoneid

The ID of the hosted zone that you want Amazon Route 53 to simulate a query for.

recordname

The name of the resource record set that you want Amazon Route 53 to simulate a query for.

recordtype

The type of the resource record set.

resolverip (optional)

If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. If you omit this value, TestDNSAnswer uses the IP address of a DNS resolver in the AWS US East region.

edns0clientsubnetip (optional)

If the resolver that you specified for resolverip supports EDNS0, specify the IP address of a client in the applicable location.

edns0clientsubnetmask (optional)

If you specify an IP address for edns0clientsubnetip, you can optionally specify the number of bits of the IP address that you want the checking tool to include in the DNS query. For example, if you specify 192.0.2.44 for edns0clientsubnetip and 24 for edns0clientsubnetmask, the checking tool will simulate a request from 192.0.2.0/24. The default value is 24 bits.

" }, "TestDNSAnswerResponse":{ "type":"structure", "required":[ "Nameserver", "RecordName", "RecordType", "RecordData", "ResponseCode", "Protocol" ], "members":{ "Nameserver":{ "shape":"Nameserver", "documentation":"

The Amazon Route 53 name server used to respond to the request.

" }, "RecordName":{ "shape":"DNSName", "documentation":"

The name of the resource record set that you submitted a request for.

" }, "RecordType":{ "shape":"RRType", "documentation":"

The type of the resource record set that you submitted a request for.

" }, "RecordData":{ "shape":"RecordData", "documentation":"

A list that contains values that Amazon Route 53 returned for this resource record set.

" }, "ResponseCode":{ "shape":"DNSRCode", "documentation":"

A code that indicates whether the request is valid or not. The most common response code is NOERROR, meaning that the request is valid. If the response is not valid, Amazon Route 53 returns a response code that describes the error. For a list of possible response codes, see DNS RCODES on the IANA website.

" }, "Protocol":{ "shape":"TransportProtocol", "documentation":"

The protocol that Amazon Route 53 used to respond to the request, either UDP or TCP.

" } }, "documentation":"

A complex type that contains the response to a TestDNSAnswer request.

" }, "Threshold":{"type":"double"}, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

", "error":{"httpStatusCode":400}, "exception":true }, "TimeStamp":{"type":"timestamp"}, "TooManyHealthChecks":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

You have reached the maximum number of active health checks for an AWS account. The default limit is 100. To request a higher limit, create a case with the AWS Support Center.

", "exception":true }, "TooManyHostedZones":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

This hosted zone can't be created because the hosted zone limit is exceeded. To request a limit increase, go to the Amazon Route 53 Contact Us page.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyTrafficPolicies":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

You've created the maximum number of traffic policies that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyTrafficPolicyInstances":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

You've created the maximum number of traffic policy instances that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyVPCAssociationAuthorizations":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

You've created the maximum number of authorizations that can be created for the specified hosted zone. To authorize another VPC to be associated with the hosted zone, submit a DeleteVPCAssociationAuthorization request to remove an existing authorization. To get a list of existing authorizations, submit a ListVPCAssociationAuthorizations request.

", "error":{"httpStatusCode":400}, "exception":true }, "TrafficPolicies":{ "type":"list", "member":{ "shape":"TrafficPolicy", "locationName":"TrafficPolicy" } }, "TrafficPolicy":{ "type":"structure", "required":[ "Id", "Version", "Name", "Type", "Document" ], "members":{ "Id":{ "shape":"TrafficPolicyId", "documentation":"

The ID that Amazon Route 53 assigned to a traffic policy when you created it.

" }, "Version":{ "shape":"TrafficPolicyVersion", "documentation":"

The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value of Version is always 1.

" }, "Name":{ "shape":"TrafficPolicyName", "documentation":"

The name that you specified when you created the traffic policy.

" }, "Type":{ "shape":"RRType", "documentation":"

The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.

" }, "Document":{ "shape":"TrafficPolicyDocument", "documentation":"

The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic policy in the CreateTrafficPolicy request. For more information about the JSON format, see Traffic Policy Document Format.

" }, "Comment":{ "shape":"TrafficPolicyComment", "documentation":"

The comment that you specify in the CreateTrafficPolicy request, if any.

" } }, "documentation":"

A complex type that contains settings for a traffic policy.

" }, "TrafficPolicyAlreadyExists":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

A traffic policy that has the same value for Name already exists.

", "error":{"httpStatusCode":409}, "exception":true }, "TrafficPolicyComment":{ "type":"string", "max":1024 }, "TrafficPolicyDocument":{ "type":"string", "max":102400 }, "TrafficPolicyId":{ "type":"string", "max":36, "min":1 }, "TrafficPolicyInUse":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

One or more traffic policy instances were created by using the specified traffic policy.

", "error":{"httpStatusCode":400}, "exception":true }, "TrafficPolicyInstance":{ "type":"structure", "required":[ "Id", "HostedZoneId", "Name", "TTL", "State", "Message", "TrafficPolicyId", "TrafficPolicyVersion", "TrafficPolicyType" ], "members":{ "Id":{ "shape":"TrafficPolicyInstanceId", "documentation":"

The ID that Amazon Route 53 assigned to the new traffic policy instance.

" }, "HostedZoneId":{ "shape":"ResourceId", "documentation":"

The ID of the hosted zone that Amazon Route 53 created resource record sets in.

" }, "Name":{ "shape":"DNSName", "documentation":"

The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance.

" }, "TTL":{ "shape":"TTL", "documentation":"

The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.

" }, "State":{ "shape":"TrafficPolicyInstanceState", "documentation":"

The value of State is one of the following values:

Applied

Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Amazon Route 53 edge locations.

Creating

Amazon Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request completed successfully.

Failed

Amazon Route 53 wasn't able to create or update the resource record sets. When the value of State is Failed, see Message for an explanation of what caused the request to fail.

" }, "Message":{ "shape":"Message", "documentation":"

If State is Failed, an explanation of the reason for the failure. If State is another value, Message is empty.

" }, "TrafficPolicyId":{ "shape":"TrafficPolicyId", "documentation":"

The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

" }, "TrafficPolicyVersion":{ "shape":"TrafficPolicyVersion", "documentation":"

The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

" }, "TrafficPolicyType":{ "shape":"RRType", "documentation":"

The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.

" } }, "documentation":"

A complex type that contains settings for the new traffic policy instance.

" }, "TrafficPolicyInstanceAlreadyExists":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

Traffic policy instance with given Id already exists.

", "error":{"httpStatusCode":409}, "exception":true }, "TrafficPolicyInstanceCount":{"type":"integer"}, "TrafficPolicyInstanceId":{ "type":"string", "max":36, "min":1 }, "TrafficPolicyInstanceState":{"type":"string"}, "TrafficPolicyInstances":{ "type":"list", "member":{ "shape":"TrafficPolicyInstance", "locationName":"TrafficPolicyInstance" } }, "TrafficPolicyName":{ "type":"string", "max":512 }, "TrafficPolicySummaries":{ "type":"list", "member":{ "shape":"TrafficPolicySummary", "locationName":"TrafficPolicySummary" } }, "TrafficPolicySummary":{ "type":"structure", "required":[ "Id", "Name", "Type", "LatestVersion", "TrafficPolicyCount" ], "members":{ "Id":{ "shape":"TrafficPolicyId", "documentation":"

The ID that Amazon Route 53 assigned to the traffic policy when you created it.

" }, "Name":{ "shape":"TrafficPolicyName", "documentation":"

The name that you specified for the traffic policy when you created it.

" }, "Type":{ "shape":"RRType", "documentation":"

The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.

" }, "LatestVersion":{ "shape":"TrafficPolicyVersion", "documentation":"

The version number of the latest version of the traffic policy.

" }, "TrafficPolicyCount":{ "shape":"TrafficPolicyVersion", "documentation":"

The number of traffic policies that are associated with the current AWS account.

" } }, "documentation":"

A complex type that contains information about the latest version of one traffic policy that is associated with the current AWS account.

" }, "TrafficPolicyVersion":{ "type":"integer", "max":1000, "min":1 }, "TrafficPolicyVersionMarker":{ "type":"string", "max":4 }, "TransportProtocol":{"type":"string"}, "UpdateHealthCheckRequest":{ "type":"structure", "required":["HealthCheckId"], "members":{ "HealthCheckId":{ "shape":"HealthCheckId", "documentation":"

The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

", "location":"uri", "locationName":"HealthCheckId" }, "HealthCheckVersion":{ "shape":"HealthCheckVersion", "documentation":"

A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you update settings for the health check.

We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of HealthCheckVersion for the health check that you want to update, and that you include that value in your UpdateHealthCheck request. This prevents Amazon Route 53 from overwriting an intervening update:

  • f the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Amazon Route 53 updates the health check with the new settings.

  • If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Amazon Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

" }, "IPAddress":{ "shape":"IPAddress", "documentation":"

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Amazon Route 53 then checks the health of the endpoint.

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see Elastic IP Addresses (EIP) in the Amazon EC2 User Guide for Linux Instances.

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

For more information, see UpdateHealthCheckRequest$FullyQualifiedDomainName.

Constraints: Amazon Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

" }, "Port":{ "shape":"Port", "documentation":"

The port on the endpoint on which you want Amazon Route 53 to perform health checks.

" }, "ResourcePath":{ "shape":"ResourcePath", "documentation":"

The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.

Specify this value only if you want to change it.

" }, "FullyQualifiedDomainName":{ "shape":"FullyQualifiedDomainName", "documentation":"

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

If you specify a value for IPAddress:

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks.

When Amazon Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Amazon Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify another value for Port and any value except TCP for Type, Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Amazon Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

If you don't specify a value for IPAddress:

If you don't specify a value for IPAddress, Amazon Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Amazon Route 53 then checks the health of the endpoint.

If you don't specify a value for IPAddress, Amazon Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a \"DNS resolution failed\" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-1-www.example.com), not the name of the resource record sets (www.example.com).

In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Amazon Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Amazon Route 53 doesn't pass a Host header.

" }, "SearchString":{ "shape":"SearchString", "documentation":"

If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)

" }, "FailureThreshold":{ "shape":"FailureThreshold", "documentation":"

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

" }, "Inverted":{ "shape":"Inverted", "documentation":"

Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

" }, "HealthThreshold":{ "shape":"HealthThreshold", "documentation":"

The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks and ChildHealthCheck elements.

Note the following:

  • If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy.

  • If you specify 0, Amazon Route 53 always considers this health check to be healthy.

" }, "ChildHealthChecks":{ "shape":"ChildHealthCheckList", "documentation":"

A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

" }, "EnableSNI":{ "shape":"EnableSNI", "documentation":"

Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

" }, "Regions":{ "shape":"HealthCheckRegionList", "documentation":"

A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.

" }, "AlarmIdentifier":{"shape":"AlarmIdentifier"}, "InsufficientDataHealthStatus":{ "shape":"InsufficientDataHealthStatus", "documentation":"

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

  • Healthy: Amazon Route 53 considers the health check to be healthy.

  • Unhealthy: Amazon Route 53 considers the health check to be unhealthy.

  • LastKnownStatus: Amazon Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

" } }, "documentation":"

A complex type that contains the health check request information.

" }, "UpdateHealthCheckResponse":{ "type":"structure", "required":["HealthCheck"], "members":{ "HealthCheck":{"shape":"HealthCheck"} } }, "UpdateHostedZoneCommentRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"ResourceId", "documentation":"

The ID for the hosted zone for which you want to update the comment.

", "location":"uri", "locationName":"Id" }, "Comment":{ "shape":"ResourceDescription", "documentation":"

The new comment for the hosted zone. If you don't specify a value for Comment, Amazon Route 53 deletes the existing value of the Comment element, if any.

" } }, "documentation":"

A complex type that contains the hosted zone request information.

" }, "UpdateHostedZoneCommentResponse":{ "type":"structure", "required":["HostedZone"], "members":{ "HostedZone":{"shape":"HostedZone"} }, "documentation":"

A complex type that contains the response to the UpdateHostedZoneCommentRequest.

" }, "UpdateTrafficPolicyCommentRequest":{ "type":"structure", "required":[ "Id", "Version", "Comment" ], "members":{ "Id":{ "shape":"TrafficPolicyId", "documentation":"

The value of Id for the traffic policy for which you want to update the comment.

", "location":"uri", "locationName":"Id" }, "Version":{ "shape":"TrafficPolicyVersion", "documentation":"

The value of Version for the traffic policy for which you want to update the comment.

", "location":"uri", "locationName":"Version" }, "Comment":{ "shape":"TrafficPolicyComment", "documentation":"

The new comment for the specified traffic policy and version.

" } }, "documentation":"

A complex type that contains information about the traffic policy for which you want to update the comment.

" }, "UpdateTrafficPolicyCommentResponse":{ "type":"structure", "required":["TrafficPolicy"], "members":{ "TrafficPolicy":{ "shape":"TrafficPolicy", "documentation":"

A complex type that contains settings for the specified traffic policy.

" } }, "documentation":"

A complex type that contains the response information for the traffic policy.

" }, "UpdateTrafficPolicyInstanceRequest":{ "type":"structure", "required":[ "Id", "TTL", "TrafficPolicyId", "TrafficPolicyVersion" ], "members":{ "Id":{ "shape":"TrafficPolicyInstanceId", "documentation":"

The ID of the traffic policy instance that you want to update.

", "location":"uri", "locationName":"Id" }, "TTL":{ "shape":"TTL", "documentation":"

The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets.

" }, "TrafficPolicyId":{ "shape":"TrafficPolicyId", "documentation":"

The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.

" }, "TrafficPolicyVersion":{ "shape":"TrafficPolicyVersion", "documentation":"

The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.

" } }, "documentation":"

A complex type that contains information about the resource record sets that you want to update based on a specified traffic policy instance.

" }, "UpdateTrafficPolicyInstanceResponse":{ "type":"structure", "required":["TrafficPolicyInstance"], "members":{ "TrafficPolicyInstance":{ "shape":"TrafficPolicyInstance", "documentation":"

A complex type that contains settings for the updated traffic policy instance.

" } }, "documentation":"

A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.

" }, "VPC":{ "type":"structure", "members":{ "VPCRegion":{ "shape":"VPCRegion", "documentation":"

The region in which you created the VPC that you want to associate with the specified Amazon Route 53 hosted zone.

" }, "VPCId":{"shape":"VPCId"} }, "documentation":"

A complex type that contains information about an Amazon VPC that is associated with a private hosted zone.

" }, "VPCAssociationAuthorizationNotFound":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

The VPC that you specified is not authorized to be associated with the hosted zone.

", "error":{"httpStatusCode":404}, "exception":true }, "VPCAssociationNotFound":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Descriptive message for the error response.

" } }, "documentation":"

The specified VPC and hosted zone are not currently associated.

", "error":{"httpStatusCode":404}, "exception":true }, "VPCId":{ "type":"string", "documentation":"

The ID of an Amazon VPC.

", "max":1024 }, "VPCRegion":{ "type":"string", "enum":[ "us-east-1", "us-east-2", "us-west-1", "us-west-2", "eu-west-1", "eu-west-2", "eu-central-1", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "ap-northeast-1", "ap-northeast-2", "sa-east-1", "ca-central-1", "cn-north-1" ], "max":64, "min":1 }, "VPCs":{ "type":"list", "member":{ "shape":"VPC", "locationName":"VPC" }, "documentation":"

A list of VPC elements.

", "min":1 } } } botocore-1.5.7/botocore/data/swf/0000777454262600001440000000000013042511307017732 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/swf/2012-01-25/0000777454262600001440000000000013042511307020760 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/swf/2012-01-25/paginators-1.json0000666454262600001440000000273013042511306024161 0ustar pysdk-ciamazon00000000000000{ "pagination": { "GetWorkflowExecutionHistory": { "limit_key": "maximumPageSize", "input_token": "nextPageToken", "output_token": "nextPageToken", "result_key": "events" }, "ListActivityTypes": { "limit_key": "maximumPageSize", "input_token": "nextPageToken", "output_token": "nextPageToken", "result_key": "typeInfos" }, "ListClosedWorkflowExecutions": { "limit_key": "maximumPageSize", "input_token": "nextPageToken", "output_token": "nextPageToken", "result_key": "executionInfos" }, "ListDomains": { "limit_key": "maximumPageSize", "input_token": "nextPageToken", "output_token": "nextPageToken", "result_key": "domainInfos" }, "ListOpenWorkflowExecutions": { "limit_key": "maximumPageSize", "input_token": "nextPageToken", "output_token": "nextPageToken", "result_key": "executionInfos" }, "ListWorkflowTypes": { "limit_key": "maximumPageSize", "input_token": "nextPageToken", "output_token": "nextPageToken", "result_key": "typeInfos" }, "PollForDecisionTask": { "limit_key": "maximumPageSize", "input_token": "nextPageToken", "output_token": "nextPageToken", "result_key": "events", "non_aggregate_keys": [ "taskToken", "startedEventId", "workflowExecution", "workflowType", "previousStartedEventId" ] } } } botocore-1.5.7/botocore/data/swf/2012-01-25/service-2.json0000666454262600001440000121473613042511306023467 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"swf-2012-01-25", "apiVersion":"2012-01-25", "endpointPrefix":"swf", "jsonVersion":"1.0", "serviceAbbreviation":"Amazon SWF", "serviceFullName":"Amazon Simple Workflow Service", "signatureVersion":"v4", "targetPrefix":"SimpleWorkflowService", "timestampFormat":"unixTimestamp", "protocol":"json" }, "documentation":"Amazon Simple Workflow Service

The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.

Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.

This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide.

", "operations":{ "CountClosedWorkflowExecutions":{ "name":"CountClosedWorkflowExecutions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CountClosedWorkflowExecutionsInput"}, "output":{ "shape":"WorkflowExecutionCount", "documentation":"

Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions

" }, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
    • typeFilter.name: String constraint. The key is swf:typeFilter.name.
    • typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "CountOpenWorkflowExecutions":{ "name":"CountOpenWorkflowExecutions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CountOpenWorkflowExecutionsInput"}, "output":{ "shape":"WorkflowExecutionCount", "documentation":"

Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions

" }, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
    • typeFilter.name: String constraint. The key is swf:typeFilter.name.
    • typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "CountPendingActivityTasks":{ "name":"CountPendingActivityTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CountPendingActivityTasksInput"}, "output":{ "shape":"PendingTaskCount", "documentation":"

Contains the count of tasks in a task list.

" }, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

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. If you specify a task list that no activity task was ever scheduled in then 0 will be returned.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "CountPendingDecisionTasks":{ "name":"CountPendingDecisionTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CountPendingDecisionTasksInput"}, "output":{ "shape":"PendingTaskCount", "documentation":"

Contains the count of tasks in a task list.

" }, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

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. If you specify a task list that no decision task was ever scheduled in then 0 will be returned.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "DeprecateActivityType":{ "name":"DeprecateActivityType", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeprecateActivityTypeInput"}, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"TypeDeprecatedFault", "exception":true, "documentation":"

Returned when the specified activity or workflow type was already deprecated.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated will continue to run.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • activityType.name: String constraint. The key is swf:activityType.name.
    • activityType.version: String constraint. The key is swf:activityType.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "DeprecateDomain":{ "name":"DeprecateDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeprecateDomainInput"}, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"DomainDeprecatedFault", "exception":true, "documentation":"

Returned when the specified domain has been deprecated.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "DeprecateWorkflowType":{ "name":"DeprecateWorkflowType", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeprecateWorkflowTypeInput"}, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"TypeDeprecatedFault", "exception":true, "documentation":"

Returned when the specified activity or workflow type was already deprecated.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • workflowType.name: String constraint. The key is swf:workflowType.name.
    • workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "DescribeActivityType":{ "name":"DescribeActivityType", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeActivityTypeInput"}, "output":{ "shape":"ActivityTypeDetail", "documentation":"

Detailed information about an activity type.

" }, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • activityType.name: String constraint. The key is swf:activityType.name.
    • activityType.version: String constraint. The key is swf:activityType.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "DescribeDomain":{ "name":"DescribeDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDomainInput"}, "output":{ "shape":"DomainDetail", "documentation":"

Contains details of a domain.

" }, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Returns information about the specified domain, including description and status.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "DescribeWorkflowExecution":{ "name":"DescribeWorkflowExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWorkflowExecutionInput"}, "output":{ "shape":"WorkflowExecutionDetail", "documentation":"

Contains details about a workflow execution.

" }, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Returns information about the specified workflow execution including its type and some statistics.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "DescribeWorkflowType":{ "name":"DescribeWorkflowType", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWorkflowTypeInput"}, "output":{ "shape":"WorkflowTypeDetail", "documentation":"

Contains details about a workflow type.

" }, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, and so on.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • workflowType.name: String constraint. The key is swf:workflowType.name.
    • workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "GetWorkflowExecutionHistory":{ "name":"GetWorkflowExecutionHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetWorkflowExecutionHistoryInput"}, "output":{ "shape":"History", "documentation":"

Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution.

" }, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "ListActivityTypes":{ "name":"ListActivityTypes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListActivityTypesInput"}, "output":{ "shape":"ActivityTypeInfos", "documentation":"

Contains a paginated list of activity type information structures.

" }, "errors":[ { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" }, { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" } ], "documentation":"

Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "ListClosedWorkflowExecutions":{ "name":"ListClosedWorkflowExecutions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListClosedWorkflowExecutionsInput"}, "output":{ "shape":"WorkflowExecutionInfos", "documentation":"

Contains a paginated list of information about workflow executions.

" }, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
    • typeFilter.name: String constraint. The key is swf:typeFilter.name.
    • typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "ListDomains":{ "name":"ListDomains", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDomainsInput"}, "output":{ "shape":"DomainInfos", "documentation":"

Contains a paginated collection of DomainInfo structures.

" }, "errors":[ { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "ListOpenWorkflowExecutions":{ "name":"ListOpenWorkflowExecutions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListOpenWorkflowExecutionsInput"}, "output":{ "shape":"WorkflowExecutionInfos", "documentation":"

Contains a paginated list of information about workflow executions.

" }, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.
    • typeFilter.name: String constraint. The key is swf:typeFilter.name.
    • typeFilter.version: String constraint. The key is swf:typeFilter.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "ListWorkflowTypes":{ "name":"ListWorkflowTypes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListWorkflowTypesInput"}, "output":{ "shape":"WorkflowTypeInfos", "documentation":"

Contains a paginated list of information structures about workflow types.

" }, "errors":[ { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" }, { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" } ], "documentation":"

Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "PollForActivityTask":{ "name":"PollForActivityTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PollForActivityTaskInput"}, "output":{ "shape":"ActivityTask", "documentation":"

Unit of work sent to an activity worker.

" }, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" }, { "shape":"LimitExceededFault", "exception":true, "documentation":"

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

" } ], "documentation":"

Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.

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).

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "PollForDecisionTask":{ "name":"PollForDecisionTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PollForDecisionTaskInput"}, "output":{ "shape":"DecisionTask", "documentation":"

A structure that represents a decision task. Decision tasks are sent to deciders in order for them to make decisions.

" }, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" }, { "shape":"LimitExceededFault", "exception":true, "documentation":"

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

" } ], "documentation":"

Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.

This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.

Deciders should set their client-side socket timeout to at least 70 seconds (10 seconds higher than the timeout). Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "RecordActivityTaskHeartbeat":{ "name":"RecordActivityTaskHeartbeat", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RecordActivityTaskHeartbeatInput"}, "output":{ "shape":"ActivityTaskStatus", "documentation":"

Status information about an activity task.

" }, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also (optionally) specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true.

This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType.

This action does not in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history will contain a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.

The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType. This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted. If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "RegisterActivityType":{ "name":"RegisterActivityType", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterActivityTypeInput"}, "errors":[ { "shape":"TypeAlreadyExistsFault", "exception":true, "documentation":"

Returned if the type already exists in the specified domain. You will get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type.

" }, { "shape":"LimitExceededFault", "exception":true, "documentation":"

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

" }, { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Registers a new activity type along with its configuration settings in the specified domain.

A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.
    • name: String constraint. The key is swf:name.
    • version: String constraint. The key is swf:version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "RegisterDomain":{ "name":"RegisterDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterDomainInput"}, "errors":[ { "shape":"DomainAlreadyExistsFault", "exception":true, "documentation":"

Returned if the specified domain already exists. You will get this fault even if the existing domain is in deprecated status.

" }, { "shape":"LimitExceededFault", "exception":true, "documentation":"

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Registers a new domain.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "RegisterWorkflowType":{ "name":"RegisterWorkflowType", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterWorkflowTypeInput"}, "errors":[ { "shape":"TypeAlreadyExistsFault", "exception":true, "documentation":"

Returned if the type already exists in the specified domain. You will get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type.

" }, { "shape":"LimitExceededFault", "exception":true, "documentation":"

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

" }, { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Registers a new workflow type and its configuration settings in the specified domain.

The retention period for the workflow history is set by the RegisterDomain action.

If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.
    • name: String constraint. The key is swf:name.
    • version: String constraint. The key is swf:version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "RequestCancelWorkflowExecution":{ "name":"RequestCancelWorkflowExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RequestCancelWorkflowExecutionInput"}, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

If the runId is not specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain. Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "RespondActivityTaskCanceled":{ "name":"RespondActivityTaskCanceled", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RespondActivityTaskCanceledInput"}, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be optionally provided using the details argument.

These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.

Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "RespondActivityTaskCompleted":{ "name":"RespondActivityTaskCompleted", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RespondActivityTaskCompletedInput"}, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.

If the requested task does not complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "RespondActivityTaskFailed":{ "name":"RespondActivityTaskFailed", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RespondActivityTaskFailedInput"}, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "RespondDecisionTaskCompleted":{ "name":"RespondDecisionTaskCompleted", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RespondDecisionTaskCompletedInput"}, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.

A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history.

Access Control

If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the 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 to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "SignalWorkflowExecution":{ "name":"SignalWorkflowExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SignalWorkflowExecutionInput"}, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).

If a runId is not specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain. If the specified workflow execution is not open, this method fails with UnknownResource.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "StartWorkflowExecution":{ "name":"StartWorkflowExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartWorkflowExecutionInput"}, "output":{ "shape":"Run", "documentation":"

Specifies the runId of a workflow execution.

" }, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"TypeDeprecatedFault", "exception":true, "documentation":"

Returned when the specified activity or workflow type was already deprecated.

" }, { "shape":"WorkflowExecutionAlreadyStartedFault", "exception":true, "documentation":"

Returned by StartWorkflowExecution when an open execution with the same workflowId is already running in the specified domain.

" }, { "shape":"LimitExceededFault", "exception":true, "documentation":"

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" }, { "shape":"DefaultUndefinedFault", "exception":true } ], "documentation":"

Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.

This action returns the newly started workflow execution.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • tagList.member.0: The key is swf:tagList.member.0.
    • tagList.member.1: The key is swf:tagList.member.1.
    • tagList.member.2: The key is swf:tagList.member.2.
    • tagList.member.3: The key is swf:tagList.member.3.
    • tagList.member.4: The key is swf:tagList.member.4.
    • taskList: String constraint. The key is swf:taskList.name.
    • workflowType.name: String constraint. The key is swf:workflowType.name.
    • workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "TerminateWorkflowExecution":{ "name":"TerminateWorkflowExecution", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateWorkflowExecutionInput"}, "errors":[ { "shape":"UnknownResourceFault", "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, { "shape":"OperationNotPermittedFault", "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" } ], "documentation":"

Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.

If the identified workflow execution was in progress, it is terminated immediately. If a runId is not specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain. You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution does not.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" } }, "shapes":{ "ActivityId":{ "type":"string", "min":1, "max":256 }, "ActivityTask":{ "type":"structure", "required":[ "taskToken", "activityId", "startedEventId", "workflowExecution", "activityType" ], "members":{ "taskToken":{ "shape":"TaskToken", "documentation":"

The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

" }, "activityId":{ "shape":"ActivityId", "documentation":"

The unique ID of the task.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the ActivityTaskStarted event recorded in the history.

" }, "workflowExecution":{ "shape":"WorkflowExecution", "documentation":"

The workflow execution that started this activity task.

" }, "activityType":{ "shape":"ActivityType", "documentation":"

The type of this activity task.

" }, "input":{ "shape":"Data", "documentation":"

The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.

" } }, "documentation":"

Unit of work sent to an activity worker.

" }, "ActivityTaskCancelRequestedEventAttributes":{ "type":"structure", "required":[ "decisionTaskCompletedEventId", "activityId" ], "members":{ "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "activityId":{ "shape":"ActivityId", "documentation":"

The unique ID of the task.

" } }, "documentation":"

Provides details of the ActivityTaskCancelRequested event.

" }, "ActivityTaskCanceledEventAttributes":{ "type":"structure", "required":[ "scheduledEventId", "startedEventId" ], "members":{ "details":{ "shape":"Data", "documentation":"

Details of the cancellation (if any).

" }, "scheduledEventId":{ "shape":"EventId", "documentation":"

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "latestCancelRequestedEventId":{ "shape":"EventId", "documentation":"

If set, contains the ID of the last ActivityTaskCancelRequested event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the ActivityTaskCanceled event.

" }, "ActivityTaskCompletedEventAttributes":{ "type":"structure", "required":[ "scheduledEventId", "startedEventId" ], "members":{ "result":{ "shape":"Data", "documentation":"

The results of the activity task (if any).

" }, "scheduledEventId":{ "shape":"EventId", "documentation":"

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the ActivityTaskCompleted event.

" }, "ActivityTaskFailedEventAttributes":{ "type":"structure", "required":[ "scheduledEventId", "startedEventId" ], "members":{ "reason":{ "shape":"FailureReason", "documentation":"

The reason provided for the failure (if any).

" }, "details":{ "shape":"Data", "documentation":"

The details of the failure (if any).

" }, "scheduledEventId":{ "shape":"EventId", "documentation":"

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the ActivityTaskFailed event.

" }, "ActivityTaskScheduledEventAttributes":{ "type":"structure", "required":[ "activityType", "activityId", "taskList", "decisionTaskCompletedEventId" ], "members":{ "activityType":{ "shape":"ActivityType", "documentation":"

The type of the activity task.

" }, "activityId":{ "shape":"ActivityId", "documentation":"

The unique ID of the activity task.

" }, "input":{ "shape":"Data", "documentation":"

The input provided to the activity task.

" }, "control":{ "shape":"Data", "documentation":"

Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.

" }, "scheduleToStartTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

The maximum amount of time the activity task can wait to be assigned to a worker.

" }, "scheduleToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

The maximum amount of time for this activity task.

" }, "startToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

The maximum amount of time a worker may take to process the activity task.

" }, "taskList":{ "shape":"TaskList", "documentation":"

The task list in which the activity task has been scheduled.

" }, "taskPriority":{ "shape":"TaskPriority", "documentation":"

Optional. The priority to assign to the scheduled activity task. If set, this will override any default priority value that was assigned when the activity type was registered.

Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "heartbeatTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it will be ignored.

" } }, "documentation":"

Provides details of the ActivityTaskScheduled event.

" }, "ActivityTaskStartedEventAttributes":{ "type":"structure", "required":["scheduledEventId"], "members":{ "identity":{ "shape":"Identity", "documentation":"

Identity of the worker that was assigned this task. This aids diagnostics when problems arise. The form of this identity is user defined.

" }, "scheduledEventId":{ "shape":"EventId", "documentation":"

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the ActivityTaskStarted event.

" }, "ActivityTaskStatus":{ "type":"structure", "required":["cancelRequested"], "members":{ "cancelRequested":{ "shape":"Canceled", "documentation":"

Set to true if cancellation of the task is requested.

" } }, "documentation":"

Status information about an activity task.

" }, "ActivityTaskTimedOutEventAttributes":{ "type":"structure", "required":[ "timeoutType", "scheduledEventId", "startedEventId" ], "members":{ "timeoutType":{ "shape":"ActivityTaskTimeoutType", "documentation":"

The type of the timeout that caused this event.

" }, "scheduledEventId":{ "shape":"EventId", "documentation":"

The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "details":{ "shape":"LimitedData", "documentation":"

Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat.

" } }, "documentation":"

Provides details of the ActivityTaskTimedOut event.

" }, "ActivityTaskTimeoutType":{ "type":"string", "enum":[ "START_TO_CLOSE", "SCHEDULE_TO_START", "SCHEDULE_TO_CLOSE", "HEARTBEAT" ] }, "ActivityType":{ "type":"structure", "required":[ "name", "version" ], "members":{ "name":{ "shape":"Name", "documentation":"

The name of this activity.

The combination of activity type name and version must be unique within a domain." }, "version":{ "shape":"Version", "documentation":"

The version of this activity.

The combination of activity type name and version must be unique with in a domain." } }, "documentation":"

Represents an activity type.

" }, "ActivityTypeConfiguration":{ "type":"structure", "members":{ "defaultTaskStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

Optional. The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "defaultTaskHeartbeatTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

Optional. The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.

You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "defaultTaskList":{ "shape":"TaskList", "documentation":"

Optional. The default task list specified for this activity type at registration. This default is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask decision.

" }, "defaultTaskPriority":{ "shape":"TaskPriority", "documentation":"

Optional. The default task priority for tasks of this activity type, specified at registration. If not set, then \"0\" will be used as the default priority. This default can be overridden when scheduling an activity task.

Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

" }, "defaultTaskScheduleToStartTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

Optional. The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "defaultTaskScheduleToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

Optional. The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" } }, "documentation":"

Configuration settings registered with the activity type.

" }, "ActivityTypeDetail":{ "type":"structure", "required":[ "typeInfo", "configuration" ], "members":{ "typeInfo":{ "shape":"ActivityTypeInfo", "documentation":"

General information about the activity type.

The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.

  • REGISTERED: The type is registered and available. Workers supporting this type should be running.
  • DEPRECATED: The type was deprecated using DeprecateActivityType, but is still in use. You should keep workers supporting this type running. You cannot create new tasks of this type.
" }, "configuration":{ "shape":"ActivityTypeConfiguration", "documentation":"

The configuration settings registered with the activity type.

" } }, "documentation":"

Detailed information about an activity type.

" }, "ActivityTypeInfo":{ "type":"structure", "required":[ "activityType", "status", "creationDate" ], "members":{ "activityType":{ "shape":"ActivityType", "documentation":"

The ActivityType type structure representing the activity type.

" }, "status":{ "shape":"RegistrationStatus", "documentation":"

The current status of the activity type.

" }, "description":{ "shape":"Description", "documentation":"

The description of the activity type provided in RegisterActivityType.

" }, "creationDate":{ "shape":"Timestamp", "documentation":"

The date and time this activity type was created through RegisterActivityType.

" }, "deprecationDate":{ "shape":"Timestamp", "documentation":"

If DEPRECATED, the date and time DeprecateActivityType was called.

" } }, "documentation":"

Detailed information about an activity type.

" }, "ActivityTypeInfoList":{ "type":"list", "member":{"shape":"ActivityTypeInfo"} }, "ActivityTypeInfos":{ "type":"structure", "required":["typeInfos"], "members":{ "typeInfos":{ "shape":"ActivityTypeInfoList", "documentation":"

List of activity type information.

" }, "nextPageToken":{ "shape":"PageToken", "documentation":"

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

" } }, "documentation":"

Contains a paginated list of activity type information structures.

" }, "Arn":{ "type":"string", "min":1, "max":1224 }, "CancelTimerDecisionAttributes":{ "type":"structure", "required":["timerId"], "members":{ "timerId":{ "shape":"TimerId", "documentation":"

Required. The unique ID of the timer to cancel.

" } }, "documentation":"

Provides details of the CancelTimer decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "CancelTimerFailedCause":{ "type":"string", "enum":[ "TIMER_ID_UNKNOWN", "OPERATION_NOT_PERMITTED" ] }, "CancelTimerFailedEventAttributes":{ "type":"structure", "required":[ "timerId", "cause", "decisionTaskCompletedEventId" ], "members":{ "timerId":{ "shape":"TimerId", "documentation":"

The timerId provided in the CancelTimer decision that failed.

" }, "cause":{ "shape":"CancelTimerFailedCause", "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the CancelTimerFailed event.

" }, "CancelWorkflowExecutionDecisionAttributes":{ "type":"structure", "members":{ "details":{ "shape":"Data", "documentation":"

Optional. details of the cancellation.

" } }, "documentation":"

Provides details of the CancelWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "CancelWorkflowExecutionFailedCause":{ "type":"string", "enum":[ "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED" ] }, "CancelWorkflowExecutionFailedEventAttributes":{ "type":"structure", "required":[ "cause", "decisionTaskCompletedEventId" ], "members":{ "cause":{ "shape":"CancelWorkflowExecutionFailedCause", "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the CancelWorkflowExecutionFailed event.

" }, "Canceled":{"type":"boolean"}, "CauseMessage":{ "type":"string", "max":1728 }, "ChildPolicy":{ "type":"string", "enum":[ "TERMINATE", "REQUEST_CANCEL", "ABANDON" ] }, "ChildWorkflowExecutionCanceledEventAttributes":{ "type":"structure", "required":[ "workflowExecution", "workflowType", "initiatedEventId", "startedEventId" ], "members":{ "workflowExecution":{ "shape":"WorkflowExecution", "documentation":"

The child workflow execution that was canceled.

" }, "workflowType":{ "shape":"WorkflowType", "documentation":"

The type of the child workflow execution.

" }, "details":{ "shape":"Data", "documentation":"

Details of the cancellation (if provided).

" }, "initiatedEventId":{ "shape":"EventId", "documentation":"

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provide details of the ChildWorkflowExecutionCanceled event.

" }, "ChildWorkflowExecutionCompletedEventAttributes":{ "type":"structure", "required":[ "workflowExecution", "workflowType", "initiatedEventId", "startedEventId" ], "members":{ "workflowExecution":{ "shape":"WorkflowExecution", "documentation":"

The child workflow execution that was completed.

" }, "workflowType":{ "shape":"WorkflowType", "documentation":"

The type of the child workflow execution.

" }, "result":{ "shape":"Data", "documentation":"

The result of the child workflow execution (if any).

" }, "initiatedEventId":{ "shape":"EventId", "documentation":"

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the ChildWorkflowExecutionCompleted event.

" }, "ChildWorkflowExecutionFailedEventAttributes":{ "type":"structure", "required":[ "workflowExecution", "workflowType", "initiatedEventId", "startedEventId" ], "members":{ "workflowExecution":{ "shape":"WorkflowExecution", "documentation":"

The child workflow execution that failed.

" }, "workflowType":{ "shape":"WorkflowType", "documentation":"

The type of the child workflow execution.

" }, "reason":{ "shape":"FailureReason", "documentation":"

The reason for the failure (if provided).

" }, "details":{ "shape":"Data", "documentation":"

The details of the failure (if provided).

" }, "initiatedEventId":{ "shape":"EventId", "documentation":"

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the ChildWorkflowExecutionFailed event.

" }, "ChildWorkflowExecutionStartedEventAttributes":{ "type":"structure", "required":[ "workflowExecution", "workflowType", "initiatedEventId" ], "members":{ "workflowExecution":{ "shape":"WorkflowExecution", "documentation":"

The child workflow execution that was started.

" }, "workflowType":{ "shape":"WorkflowType", "documentation":"

The type of the child workflow execution.

" }, "initiatedEventId":{ "shape":"EventId", "documentation":"

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the ChildWorkflowExecutionStarted event.

" }, "ChildWorkflowExecutionTerminatedEventAttributes":{ "type":"structure", "required":[ "workflowExecution", "workflowType", "initiatedEventId", "startedEventId" ], "members":{ "workflowExecution":{ "shape":"WorkflowExecution", "documentation":"

The child workflow execution that was terminated.

" }, "workflowType":{ "shape":"WorkflowType", "documentation":"

The type of the child workflow execution.

" }, "initiatedEventId":{ "shape":"EventId", "documentation":"

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the ChildWorkflowExecutionTerminated event.

" }, "ChildWorkflowExecutionTimedOutEventAttributes":{ "type":"structure", "required":[ "workflowExecution", "workflowType", "timeoutType", "initiatedEventId", "startedEventId" ], "members":{ "workflowExecution":{ "shape":"WorkflowExecution", "documentation":"

The child workflow execution that timed out.

" }, "workflowType":{ "shape":"WorkflowType", "documentation":"

The type of the child workflow execution.

" }, "timeoutType":{ "shape":"WorkflowExecutionTimeoutType", "documentation":"

The type of the timeout that caused the child workflow execution to time out.

" }, "initiatedEventId":{ "shape":"EventId", "documentation":"

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the ChildWorkflowExecutionTimedOut event.

" }, "CloseStatus":{ "type":"string", "enum":[ "COMPLETED", "FAILED", "CANCELED", "TERMINATED", "CONTINUED_AS_NEW", "TIMED_OUT" ] }, "CloseStatusFilter":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"CloseStatus", "documentation":"

Required. The close status that must match the close status of an execution for it to meet the criteria of this filter.

" } }, "documentation":"

Used to filter the closed workflow executions in visibility APIs by their close status.

" }, "CompleteWorkflowExecutionDecisionAttributes":{ "type":"structure", "members":{ "result":{ "shape":"Data", "documentation":"

The result of the workflow execution. The form of the result is implementation defined.

" } }, "documentation":"

Provides details of the CompleteWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "CompleteWorkflowExecutionFailedCause":{ "type":"string", "enum":[ "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED" ] }, "CompleteWorkflowExecutionFailedEventAttributes":{ "type":"structure", "required":[ "cause", "decisionTaskCompletedEventId" ], "members":{ "cause":{ "shape":"CompleteWorkflowExecutionFailedCause", "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the CompleteWorkflowExecutionFailed event.

" }, "ContinueAsNewWorkflowExecutionDecisionAttributes":{ "type":"structure", "members":{ "input":{ "shape":"Data", "documentation":"

The input provided to the new workflow execution.

" }, "executionStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

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. 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." }, "taskList":{"shape":"TaskList"}, "taskPriority":{ "shape":"TaskPriority", "documentation":"

Optional. The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

" }, "taskStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

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. 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." }, "childPolicy":{ "shape":"ChildPolicy", "documentation":"

If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

The supported child policies are:

  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON: no action will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned." }, "tagList":{ "shape":"TagList", "documentation":"

The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

" }, "workflowTypeVersion":{"shape":"Version"}, "lambdaRole":{ "shape":"Arn", "documentation":"

The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.

In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field." } }, "documentation":"

Provides details of the ContinueAsNewWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • tag: Optional.. A tag used to identify the workflow execution
    • taskList: String constraint. The key is swf:taskList.name.
    • workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "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", "CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED" ] }, "ContinueAsNewWorkflowExecutionFailedEventAttributes":{ "type":"structure", "required":[ "cause", "decisionTaskCompletedEventId" ], "members":{ "cause":{ "shape":"ContinueAsNewWorkflowExecutionFailedCause", "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the ContinueAsNewWorkflowExecutionFailed event.

" }, "Count":{ "type":"integer", "min":0 }, "CountClosedWorkflowExecutionsInput":{ "type":"structure", "required":["domain"], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain containing the workflow executions to count.

" }, "startTimeFilter":{ "shape":"ExecutionTimeFilter", "documentation":"

If specified, only workflow executions that meet the start time criteria of the filter are counted.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both." }, "closeTimeFilter":{ "shape":"ExecutionTimeFilter", "documentation":"

If specified, only workflow executions that meet the close time criteria of the filter are counted.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both." }, "executionFilter":{ "shape":"WorkflowExecutionFilter", "documentation":"

If specified, only workflow executions matching the WorkflowId in the filter are counted.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request." }, "typeFilter":{ "shape":"WorkflowTypeFilter", "documentation":"

If specified, indicates the type of the workflow executions to be counted.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request." }, "tagFilter":{ "shape":"TagFilter", "documentation":"

If specified, only executions that have a tag that matches the filter are counted.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request." }, "closeStatusFilter":{ "shape":"CloseStatusFilter", "documentation":"

If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request." } } }, "CountOpenWorkflowExecutionsInput":{ "type":"structure", "required":[ "domain", "startTimeFilter" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain containing the workflow executions to count.

" }, "startTimeFilter":{ "shape":"ExecutionTimeFilter", "documentation":"

Specifies the start time criteria that workflow executions must meet in order to be counted.

" }, "typeFilter":{ "shape":"WorkflowTypeFilter", "documentation":"

Specifies the type of the workflow executions to be counted.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request." }, "tagFilter":{ "shape":"TagFilter", "documentation":"

If specified, only executions that have a tag that matches the filter are counted.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request." }, "executionFilter":{ "shape":"WorkflowExecutionFilter", "documentation":"

If specified, only workflow executions matching the WorkflowId in the filter are counted.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request." } } }, "CountPendingActivityTasksInput":{ "type":"structure", "required":[ "domain", "taskList" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain that contains the task list.

" }, "taskList":{ "shape":"TaskList", "documentation":"

The name of the task list.

" } } }, "CountPendingDecisionTasksInput":{ "type":"structure", "required":[ "domain", "taskList" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain that contains the task list.

" }, "taskList":{ "shape":"TaskList", "documentation":"

The name of the task list.

" } } }, "Data":{ "type":"string", "max":32768 }, "Decision":{ "type":"structure", "required":["decisionType"], "members":{ "decisionType":{ "shape":"DecisionType", "documentation":"

Specifies the type of the decision.

" }, "scheduleActivityTaskDecisionAttributes":{ "shape":"ScheduleActivityTaskDecisionAttributes", "documentation":"

Provides details of the ScheduleActivityTask decision. It is not set for other decision types.

" }, "requestCancelActivityTaskDecisionAttributes":{ "shape":"RequestCancelActivityTaskDecisionAttributes", "documentation":"

Provides details of the RequestCancelActivityTask decision. It is not set for other decision types.

" }, "completeWorkflowExecutionDecisionAttributes":{ "shape":"CompleteWorkflowExecutionDecisionAttributes", "documentation":"

Provides details of the CompleteWorkflowExecution decision. It is not set for other decision types.

" }, "failWorkflowExecutionDecisionAttributes":{ "shape":"FailWorkflowExecutionDecisionAttributes", "documentation":"

Provides details of the FailWorkflowExecution decision. It is not set for other decision types.

" }, "cancelWorkflowExecutionDecisionAttributes":{ "shape":"CancelWorkflowExecutionDecisionAttributes", "documentation":"

Provides details of the CancelWorkflowExecution decision. It is not set for other decision types.

" }, "continueAsNewWorkflowExecutionDecisionAttributes":{ "shape":"ContinueAsNewWorkflowExecutionDecisionAttributes", "documentation":"

Provides details of the ContinueAsNewWorkflowExecution decision. It is not set for other decision types.

" }, "recordMarkerDecisionAttributes":{ "shape":"RecordMarkerDecisionAttributes", "documentation":"

Provides details of the RecordMarker decision. It is not set for other decision types.

" }, "startTimerDecisionAttributes":{ "shape":"StartTimerDecisionAttributes", "documentation":"

Provides details of the StartTimer decision. It is not set for other decision types.

" }, "cancelTimerDecisionAttributes":{ "shape":"CancelTimerDecisionAttributes", "documentation":"

Provides details of the CancelTimer decision. It is not set for other decision types.

" }, "signalExternalWorkflowExecutionDecisionAttributes":{ "shape":"SignalExternalWorkflowExecutionDecisionAttributes", "documentation":"

Provides details of the SignalExternalWorkflowExecution decision. It is not set for other decision types.

" }, "requestCancelExternalWorkflowExecutionDecisionAttributes":{ "shape":"RequestCancelExternalWorkflowExecutionDecisionAttributes", "documentation":"

Provides details of the RequestCancelExternalWorkflowExecution decision. It is not set for other decision types.

" }, "startChildWorkflowExecutionDecisionAttributes":{ "shape":"StartChildWorkflowExecutionDecisionAttributes", "documentation":"

Provides details of the StartChildWorkflowExecution decision. It is not set for other decision types.

" }, "scheduleLambdaFunctionDecisionAttributes":{"shape":"ScheduleLambdaFunctionDecisionAttributes"} }, "documentation":"

Specifies a decision made by the decider. A decision can be one of these types:

  • CancelTimer: cancels a previously started timer and records a TimerCanceled event in the history.
  • CancelWorkflowExecution: closes the workflow execution and records a WorkflowExecutionCanceled event in the history.
  • CompleteWorkflowExecution: closes the workflow execution and records a WorkflowExecutionCompleted event in the history .
  • ContinueAsNewWorkflowExecution: closes the workflow execution and starts a new workflow execution of the same type using the same workflow ID and a unique run ID. A WorkflowExecutionContinuedAsNew event is recorded in the history.
  • FailWorkflowExecution: closes the workflow execution and records a WorkflowExecutionFailed event in the history.
  • RecordMarker: records a MarkerRecorded event in the history. Markers can be used for adding custom information in the history for instance to let deciders know that they do not need to look at the history beyond the marker event.
  • RequestCancelActivityTask: attempts to cancel a previously scheduled activity task. If the activity task was scheduled but has not been assigned to a worker, then it will be canceled. If the activity task was already assigned to a worker, then the worker will be informed that cancellation has been requested in the response to RecordActivityTaskHeartbeat.
  • RequestCancelExternalWorkflowExecution: requests that a request be made to cancel the specified external workflow execution and records a RequestCancelExternalWorkflowExecutionInitiated event in the history.
  • ScheduleActivityTask: schedules an activity task.
  • ScheduleLambdaFunction: schedules a AWS Lambda function.
  • SignalExternalWorkflowExecution: requests a signal to be delivered to the specified external workflow execution and records a SignalExternalWorkflowExecutionInitiated event in the history.
  • StartChildWorkflowExecution: requests that a child workflow execution be started and records a StartChildWorkflowExecutionInitiated event in the history. The child workflow execution is a separate workflow execution with its own history.
  • StartTimer: starts a timer for this workflow execution and records a TimerStarted event in the history. This timer will fire after the specified delay and record a TimerFired event.

Access Control

If you grant permission to use RespondDecisionTaskCompleted, you can use IAM policies to express permissions for the list of decisions 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 keep policies readable. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Decision Failure

Decisions can fail for several reasons

  • The ordering of decisions should follow a logical flow. Some decisions might not make sense in the current context of the workflow execution and will therefore fail.
  • A limit on your account was reached.
  • The decision lacks sufficient permissions.

One of the following events might be added to the history to indicate an error. The event attribute's cause parameter indicates the cause. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

  • ScheduleActivityTaskFailed: a ScheduleActivityTask decision failed. This could happen if the activity type specified in the decision is not registered, is in a deprecated state, or the decision is not properly configured.
  • ScheduleLambdaFunctionFailed: a ScheduleLambdaFunctionFailed decision failed. This could happen if the AWS Lambda function specified in the decision does not exist, or the AWS Lambda service's limits are exceeded.
  • RequestCancelActivityTaskFailed: a RequestCancelActivityTask decision failed. This could happen if there is no open activity task with the specified activityId.
  • StartTimerFailed: a StartTimer decision failed. This could happen if there is another open timer with the same timerId.
  • CancelTimerFailed: a CancelTimer decision failed. This could happen if there is no open timer with the specified timerId.
  • StartChildWorkflowExecutionFailed: a StartChildWorkflowExecution decision failed. This could happen if the workflow type specified is not registered, is deprecated, or the decision is not properly configured.
  • SignalExternalWorkflowExecutionFailed: a SignalExternalWorkflowExecution decision failed. This could happen if the workflowID specified in the decision was incorrect.
  • RequestCancelExternalWorkflowExecutionFailed: a RequestCancelExternalWorkflowExecution decision failed. This could happen if the workflowID specified in the decision was incorrect.
  • CancelWorkflowExecutionFailed: a CancelWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.
  • CompleteWorkflowExecutionFailed: a CompleteWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.
  • ContinueAsNewWorkflowExecutionFailed: a ContinueAsNewWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution or the ContinueAsNewWorkflowExecution decision was not configured correctly.
  • FailWorkflowExecutionFailed: a FailWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.

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.

A workflow execution may be closed by the decider by returning one of the following decisions when completing a decision task: CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution and ContinueAsNewWorkflowExecution. An UnhandledDecision fault will be returned if a workflow closing decision is specified and a signal or activity event had been added to the history while the decision task was being performed by the decider. Unlike the above situations which are logic issues, this fault is always possible because of race conditions in a distributed system. The right action here is to call RespondDecisionTaskCompleted without any decisions. This would result in another decision task with these new events included in the history. The decider should handle the new events and may decide to close the workflow execution.

How to code a decision

You code a decision by first setting the decision type field to one of the above decision values, and then set the corresponding attributes field shown below:

" }, "DecisionList":{ "type":"list", "member":{"shape":"Decision"} }, "DecisionTask":{ "type":"structure", "required":[ "taskToken", "startedEventId", "workflowExecution", "workflowType", "events" ], "members":{ "taskToken":{ "shape":"TaskToken", "documentation":"

The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskStarted event recorded in the history.

" }, "workflowExecution":{ "shape":"WorkflowExecution", "documentation":"

The workflow execution for which this decision task was created.

" }, "workflowType":{ "shape":"WorkflowType", "documentation":"

The type of the workflow execution for which this decision task was created.

" }, "events":{ "shape":"HistoryEventList", "documentation":"

A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.

" }, "nextPageToken":{ "shape":"PageToken", "documentation":"

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

" }, "previousStartedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider. This can be used to determine the events in the history new since the last decision task received by the decider.

" } }, "documentation":"

A structure that represents a decision task. Decision tasks are sent to deciders in order for them to make decisions.

" }, "DecisionTaskCompletedEventAttributes":{ "type":"structure", "required":[ "scheduledEventId", "startedEventId" ], "members":{ "executionContext":{ "shape":"Data", "documentation":"

User defined context for the workflow execution.

" }, "scheduledEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the DecisionTaskCompleted event.

" }, "DecisionTaskScheduledEventAttributes":{ "type":"structure", "required":["taskList"], "members":{ "taskList":{ "shape":"TaskList", "documentation":"

The name of the task list in which the decision task was scheduled.

" }, "taskPriority":{ "shape":"TaskPriority", "documentation":"

Optional. A task priority that, if set, specifies the priority for this decision task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

" }, "startToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

The maximum duration for this decision task. The task is considered timed out if it does not completed within this duration.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" } }, "documentation":"

Provides details about the DecisionTaskScheduled event.

" }, "DecisionTaskStartedEventAttributes":{ "type":"structure", "required":["scheduledEventId"], "members":{ "identity":{ "shape":"Identity", "documentation":"

Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

" }, "scheduledEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the DecisionTaskStarted event.

" }, "DecisionTaskTimedOutEventAttributes":{ "type":"structure", "required":[ "timeoutType", "scheduledEventId", "startedEventId" ], "members":{ "timeoutType":{ "shape":"DecisionTaskTimeoutType", "documentation":"

The type of timeout that expired before the decision task could be completed.

" }, "scheduledEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the DecisionTaskTimedOut event.

" }, "DecisionTaskTimeoutType":{ "type":"string", "enum":["START_TO_CLOSE"] }, "DecisionType":{ "type":"string", "enum":[ "ScheduleActivityTask", "RequestCancelActivityTask", "CompleteWorkflowExecution", "FailWorkflowExecution", "CancelWorkflowExecution", "ContinueAsNewWorkflowExecution", "RecordMarker", "StartTimer", "CancelTimer", "SignalExternalWorkflowExecution", "RequestCancelExternalWorkflowExecution", "StartChildWorkflowExecution", "ScheduleLambdaFunction" ] }, "DefaultUndefinedFault":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "exception":true }, "DeprecateActivityTypeInput":{ "type":"structure", "required":[ "domain", "activityType" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain in which the activity type is registered.

" }, "activityType":{ "shape":"ActivityType", "documentation":"

The activity type to deprecate.

" } } }, "DeprecateDomainInput":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"DomainName", "documentation":"

The name of the domain to deprecate.

" } } }, "DeprecateWorkflowTypeInput":{ "type":"structure", "required":[ "domain", "workflowType" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain in which the workflow type is registered.

" }, "workflowType":{ "shape":"WorkflowType", "documentation":"

The workflow type to deprecate.

" } } }, "DescribeActivityTypeInput":{ "type":"structure", "required":[ "domain", "activityType" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain in which the activity type is registered.

" }, "activityType":{ "shape":"ActivityType", "documentation":"

The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.

" } } }, "DescribeDomainInput":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"DomainName", "documentation":"

The name of the domain to describe.

" } } }, "DescribeWorkflowExecutionInput":{ "type":"structure", "required":[ "domain", "execution" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain containing the workflow execution.

" }, "execution":{ "shape":"WorkflowExecution", "documentation":"

The workflow execution to describe.

" } } }, "DescribeWorkflowTypeInput":{ "type":"structure", "required":[ "domain", "workflowType" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain in which this workflow type is registered.

" }, "workflowType":{ "shape":"WorkflowType", "documentation":"

The workflow type to describe.

" } } }, "Description":{ "type":"string", "max":1024 }, "DomainAlreadyExistsFault":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A description that may help with diagnosing the cause of the fault.

" } }, "exception":true, "documentation":"

Returned if the specified domain already exists. You will get this fault even if the existing domain is in deprecated status.

" }, "DomainConfiguration":{ "type":"structure", "required":["workflowExecutionRetentionPeriodInDays"], "members":{ "workflowExecutionRetentionPeriodInDays":{ "shape":"DurationInDays", "documentation":"

The retention period for workflow executions in this domain.

" } }, "documentation":"

Contains the configuration settings of a domain.

" }, "DomainDeprecatedFault":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A description that may help with diagnosing the cause of the fault.

" } }, "exception":true, "documentation":"

Returned when the specified domain has been deprecated.

" }, "DomainDetail":{ "type":"structure", "required":[ "domainInfo", "configuration" ], "members":{ "domainInfo":{"shape":"DomainInfo"}, "configuration":{"shape":"DomainConfiguration"} }, "documentation":"

Contains details of a domain.

" }, "DomainInfo":{ "type":"structure", "required":[ "name", "status" ], "members":{ "name":{ "shape":"DomainName", "documentation":"

The name of the domain. This name is unique within the account.

" }, "status":{ "shape":"RegistrationStatus", "documentation":"

The status of the domain:

  • REGISTERED: The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.
  • DEPRECATED: The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.
" }, "description":{ "shape":"Description", "documentation":"

The description of the domain provided through RegisterDomain.

" } }, "documentation":"

Contains general information about a domain.

" }, "DomainInfoList":{ "type":"list", "member":{"shape":"DomainInfo"} }, "DomainInfos":{ "type":"structure", "required":["domainInfos"], "members":{ "domainInfos":{ "shape":"DomainInfoList", "documentation":"

A list of DomainInfo structures.

" }, "nextPageToken":{ "shape":"PageToken", "documentation":"

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

" } }, "documentation":"

Contains a paginated collection of DomainInfo structures.

" }, "DomainName":{ "type":"string", "min":1, "max":256 }, "DurationInDays":{ "type":"string", "min":1, "max":8 }, "DurationInSeconds":{ "type":"string", "min":1, "max":8 }, "DurationInSecondsOptional":{ "type":"string", "max":8 }, "ErrorMessage":{"type":"string"}, "EventId":{"type":"long"}, "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", "LambdaFunctionScheduled", "LambdaFunctionStarted", "LambdaFunctionCompleted", "LambdaFunctionFailed", "LambdaFunctionTimedOut", "ScheduleLambdaFunctionFailed", "StartLambdaFunctionFailed" ] }, "ExecutionStatus":{ "type":"string", "enum":[ "OPEN", "CLOSED" ] }, "ExecutionTimeFilter":{ "type":"structure", "required":["oldestDate"], "members":{ "oldestDate":{ "shape":"Timestamp", "documentation":"

Specifies the oldest start or close date and time to return.

" }, "latestDate":{ "shape":"Timestamp", "documentation":"

Specifies the latest start or close date and time to return.

" } }, "documentation":"

Used to filter the workflow executions in visibility APIs by various time-based rules. Each parameter, if specified, defines a rule that must be satisfied by each returned query result. The parameter values are in the Unix Time format. For example: \"oldestDate\": 1325376070.

" }, "ExternalWorkflowExecutionCancelRequestedEventAttributes":{ "type":"structure", "required":[ "workflowExecution", "initiatedEventId" ], "members":{ "workflowExecution":{ "shape":"WorkflowExecution", "documentation":"

The external workflow execution to which the cancellation request was delivered.

" }, "initiatedEventId":{ "shape":"EventId", "documentation":"

The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the ExternalWorkflowExecutionCancelRequested event.

" }, "ExternalWorkflowExecutionSignaledEventAttributes":{ "type":"structure", "required":[ "workflowExecution", "initiatedEventId" ], "members":{ "workflowExecution":{ "shape":"WorkflowExecution", "documentation":"

The external workflow execution that the signal was delivered to.

" }, "initiatedEventId":{ "shape":"EventId", "documentation":"

The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the ExternalWorkflowExecutionSignaled event.

" }, "FailWorkflowExecutionDecisionAttributes":{ "type":"structure", "members":{ "reason":{ "shape":"FailureReason", "documentation":"

A descriptive reason for the failure that may help in diagnostics.

" }, "details":{ "shape":"Data", "documentation":"

Optional. Details of the failure.

" } }, "documentation":"

Provides details of the FailWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "FailWorkflowExecutionFailedCause":{ "type":"string", "enum":[ "UNHANDLED_DECISION", "OPERATION_NOT_PERMITTED" ] }, "FailWorkflowExecutionFailedEventAttributes":{ "type":"structure", "required":[ "cause", "decisionTaskCompletedEventId" ], "members":{ "cause":{ "shape":"FailWorkflowExecutionFailedCause", "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the FailWorkflowExecutionFailed event.

" }, "FailureReason":{ "type":"string", "max":256 }, "FunctionId":{ "type":"string", "min":1, "max":256 }, "FunctionInput":{ "type":"string", "min":1, "max":32768 }, "FunctionName":{ "type":"string", "min":1, "max":64 }, "GetWorkflowExecutionHistoryInput":{ "type":"structure", "required":[ "domain", "execution" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain containing the workflow execution.

" }, "execution":{ "shape":"WorkflowExecution", "documentation":"

Specifies the workflow execution for which to return the history.

" }, "nextPageToken":{ "shape":"PageToken", "documentation":"

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

" }, "maximumPageSize":{ "shape":"PageSize", "documentation":"

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

" }, "reverseOrder":{ "shape":"ReverseOrder", "documentation":"

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

" } } }, "History":{ "type":"structure", "required":["events"], "members":{ "events":{ "shape":"HistoryEventList", "documentation":"

The list of history events.

" }, "nextPageToken":{ "shape":"PageToken", "documentation":"

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

" } }, "documentation":"

Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution.

" }, "HistoryEvent":{ "type":"structure", "required":[ "eventTimestamp", "eventType", "eventId" ], "members":{ "eventTimestamp":{ "shape":"Timestamp", "documentation":"

The date and time when the event occurred.

" }, "eventType":{ "shape":"EventType", "documentation":"

The type of the history event.

" }, "eventId":{ "shape":"EventId", "documentation":"

The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history.

" }, "workflowExecutionStartedEventAttributes":{ "shape":"WorkflowExecutionStartedEventAttributes", "documentation":"

If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "workflowExecutionCompletedEventAttributes":{ "shape":"WorkflowExecutionCompletedEventAttributes", "documentation":"

If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "completeWorkflowExecutionFailedEventAttributes":{ "shape":"CompleteWorkflowExecutionFailedEventAttributes", "documentation":"

If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "workflowExecutionFailedEventAttributes":{ "shape":"WorkflowExecutionFailedEventAttributes", "documentation":"

If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "failWorkflowExecutionFailedEventAttributes":{ "shape":"FailWorkflowExecutionFailedEventAttributes", "documentation":"

If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "workflowExecutionTimedOutEventAttributes":{ "shape":"WorkflowExecutionTimedOutEventAttributes", "documentation":"

If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "workflowExecutionCanceledEventAttributes":{ "shape":"WorkflowExecutionCanceledEventAttributes", "documentation":"

If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "cancelWorkflowExecutionFailedEventAttributes":{ "shape":"CancelWorkflowExecutionFailedEventAttributes", "documentation":"

If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "workflowExecutionContinuedAsNewEventAttributes":{ "shape":"WorkflowExecutionContinuedAsNewEventAttributes", "documentation":"

If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "continueAsNewWorkflowExecutionFailedEventAttributes":{ "shape":"ContinueAsNewWorkflowExecutionFailedEventAttributes", "documentation":"

If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "workflowExecutionTerminatedEventAttributes":{ "shape":"WorkflowExecutionTerminatedEventAttributes", "documentation":"

If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "workflowExecutionCancelRequestedEventAttributes":{ "shape":"WorkflowExecutionCancelRequestedEventAttributes", "documentation":"

If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "decisionTaskScheduledEventAttributes":{ "shape":"DecisionTaskScheduledEventAttributes", "documentation":"

If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "decisionTaskStartedEventAttributes":{ "shape":"DecisionTaskStartedEventAttributes", "documentation":"

If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "decisionTaskCompletedEventAttributes":{ "shape":"DecisionTaskCompletedEventAttributes", "documentation":"

If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "decisionTaskTimedOutEventAttributes":{ "shape":"DecisionTaskTimedOutEventAttributes", "documentation":"

If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "activityTaskScheduledEventAttributes":{ "shape":"ActivityTaskScheduledEventAttributes", "documentation":"

If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "activityTaskStartedEventAttributes":{ "shape":"ActivityTaskStartedEventAttributes", "documentation":"

If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "activityTaskCompletedEventAttributes":{ "shape":"ActivityTaskCompletedEventAttributes", "documentation":"

If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "activityTaskFailedEventAttributes":{ "shape":"ActivityTaskFailedEventAttributes", "documentation":"

If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "activityTaskTimedOutEventAttributes":{ "shape":"ActivityTaskTimedOutEventAttributes", "documentation":"

If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "activityTaskCanceledEventAttributes":{ "shape":"ActivityTaskCanceledEventAttributes", "documentation":"

If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "activityTaskCancelRequestedEventAttributes":{ "shape":"ActivityTaskCancelRequestedEventAttributes", "documentation":"

If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "workflowExecutionSignaledEventAttributes":{ "shape":"WorkflowExecutionSignaledEventAttributes", "documentation":"

If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "markerRecordedEventAttributes":{ "shape":"MarkerRecordedEventAttributes", "documentation":"

If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "recordMarkerFailedEventAttributes":{ "shape":"RecordMarkerFailedEventAttributes", "documentation":"

If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "timerStartedEventAttributes":{ "shape":"TimerStartedEventAttributes", "documentation":"

If the event is of type TimerStarted then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "timerFiredEventAttributes":{ "shape":"TimerFiredEventAttributes", "documentation":"

If the event is of type TimerFired then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "timerCanceledEventAttributes":{ "shape":"TimerCanceledEventAttributes", "documentation":"

If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "startChildWorkflowExecutionInitiatedEventAttributes":{ "shape":"StartChildWorkflowExecutionInitiatedEventAttributes", "documentation":"

If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "childWorkflowExecutionStartedEventAttributes":{ "shape":"ChildWorkflowExecutionStartedEventAttributes", "documentation":"

If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "childWorkflowExecutionCompletedEventAttributes":{ "shape":"ChildWorkflowExecutionCompletedEventAttributes", "documentation":"

If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "childWorkflowExecutionFailedEventAttributes":{ "shape":"ChildWorkflowExecutionFailedEventAttributes", "documentation":"

If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "childWorkflowExecutionTimedOutEventAttributes":{ "shape":"ChildWorkflowExecutionTimedOutEventAttributes", "documentation":"

If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "childWorkflowExecutionCanceledEventAttributes":{ "shape":"ChildWorkflowExecutionCanceledEventAttributes", "documentation":"

If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "childWorkflowExecutionTerminatedEventAttributes":{ "shape":"ChildWorkflowExecutionTerminatedEventAttributes", "documentation":"

If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "signalExternalWorkflowExecutionInitiatedEventAttributes":{ "shape":"SignalExternalWorkflowExecutionInitiatedEventAttributes", "documentation":"

If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "externalWorkflowExecutionSignaledEventAttributes":{ "shape":"ExternalWorkflowExecutionSignaledEventAttributes", "documentation":"

If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "signalExternalWorkflowExecutionFailedEventAttributes":{ "shape":"SignalExternalWorkflowExecutionFailedEventAttributes", "documentation":"

If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "externalWorkflowExecutionCancelRequestedEventAttributes":{ "shape":"ExternalWorkflowExecutionCancelRequestedEventAttributes", "documentation":"

If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "requestCancelExternalWorkflowExecutionInitiatedEventAttributes":{ "shape":"RequestCancelExternalWorkflowExecutionInitiatedEventAttributes", "documentation":"

If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "requestCancelExternalWorkflowExecutionFailedEventAttributes":{ "shape":"RequestCancelExternalWorkflowExecutionFailedEventAttributes", "documentation":"

If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "scheduleActivityTaskFailedEventAttributes":{ "shape":"ScheduleActivityTaskFailedEventAttributes", "documentation":"

If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "requestCancelActivityTaskFailedEventAttributes":{ "shape":"RequestCancelActivityTaskFailedEventAttributes", "documentation":"

If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "startTimerFailedEventAttributes":{ "shape":"StartTimerFailedEventAttributes", "documentation":"

If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "cancelTimerFailedEventAttributes":{ "shape":"CancelTimerFailedEventAttributes", "documentation":"

If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "startChildWorkflowExecutionFailedEventAttributes":{ "shape":"StartChildWorkflowExecutionFailedEventAttributes", "documentation":"

If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

" }, "lambdaFunctionScheduledEventAttributes":{"shape":"LambdaFunctionScheduledEventAttributes"}, "lambdaFunctionStartedEventAttributes":{"shape":"LambdaFunctionStartedEventAttributes"}, "lambdaFunctionCompletedEventAttributes":{"shape":"LambdaFunctionCompletedEventAttributes"}, "lambdaFunctionFailedEventAttributes":{"shape":"LambdaFunctionFailedEventAttributes"}, "lambdaFunctionTimedOutEventAttributes":{"shape":"LambdaFunctionTimedOutEventAttributes"}, "scheduleLambdaFunctionFailedEventAttributes":{"shape":"ScheduleLambdaFunctionFailedEventAttributes"}, "startLambdaFunctionFailedEventAttributes":{"shape":"StartLambdaFunctionFailedEventAttributes"} }, "documentation":"

Event within a workflow execution. A history event can be one of these types:

  • WorkflowExecutionStarted: The workflow execution was started.
  • WorkflowExecutionCompleted: The workflow execution was closed due to successful completion.
  • WorkflowExecutionFailed: The workflow execution closed due to a failure.
  • WorkflowExecutionTimedOut: The workflow execution was closed because a time out was exceeded.
  • WorkflowExecutionCanceled: The workflow execution was successfully canceled and closed.
  • WorkflowExecutionTerminated: The workflow execution was terminated.
  • WorkflowExecutionContinuedAsNew: The workflow execution was closed and a new execution of the same type was created with the same workflowId.
  • WorkflowExecutionCancelRequested: A request to cancel this workflow execution was made.
  • DecisionTaskScheduled: A decision task was scheduled for the workflow execution.
  • DecisionTaskStarted: The decision task was dispatched to a decider.
  • DecisionTaskCompleted: The decider successfully completed a decision task by calling RespondDecisionTaskCompleted.
  • DecisionTaskTimedOut: The decision task timed out.
  • ActivityTaskScheduled: An activity task was scheduled for execution.
  • ScheduleActivityTaskFailed: Failed to process ScheduleActivityTask decision. This happens when the decision is not configured properly, for example the activity type specified is not registered.
  • ActivityTaskStarted: The scheduled activity task was dispatched to a worker.
  • ActivityTaskCompleted: An activity worker successfully completed an activity task by calling RespondActivityTaskCompleted.
  • ActivityTaskFailed: An activity worker failed an activity task by calling RespondActivityTaskFailed.
  • ActivityTaskTimedOut: The activity task timed out.
  • ActivityTaskCanceled: The activity task was successfully canceled.
  • ActivityTaskCancelRequested: A RequestCancelActivityTask decision was received by the system.
  • RequestCancelActivityTaskFailed: Failed to process RequestCancelActivityTask decision. This happens when the decision is not configured properly.
  • WorkflowExecutionSignaled: An external signal was received for the workflow execution.
  • MarkerRecorded: A marker was recorded in the workflow history as the result of a RecordMarker decision.
  • TimerStarted: A timer was started for the workflow execution due to a StartTimer decision.
  • StartTimerFailed: Failed to process StartTimer decision. This happens when the decision is not configured properly, for example a timer already exists with the specified timer ID.
  • TimerFired: A timer, previously started for this workflow execution, fired.
  • TimerCanceled: A timer, previously started for this workflow execution, was successfully canceled.
  • CancelTimerFailed: Failed to process CancelTimer decision. This happens when the decision is not configured properly, for example no timer exists with the specified timer ID.
  • StartChildWorkflowExecutionInitiated: A request was made to start a child workflow execution.
  • StartChildWorkflowExecutionFailed: Failed to process StartChildWorkflowExecution decision. This happens when the decision is not configured properly, for example the workflow type specified is not registered.
  • ChildWorkflowExecutionStarted: A child workflow execution was successfully started.
  • ChildWorkflowExecutionCompleted: A child workflow execution, started by this workflow execution, completed successfully and was closed.
  • ChildWorkflowExecutionFailed: A child workflow execution, started by this workflow execution, failed to complete successfully and was closed.
  • ChildWorkflowExecutionTimedOut: A child workflow execution, started by this workflow execution, timed out and was closed.
  • ChildWorkflowExecutionCanceled: A child workflow execution, started by this workflow execution, was canceled and closed.
  • ChildWorkflowExecutionTerminated: A child workflow execution, started by this workflow execution, was terminated.
  • SignalExternalWorkflowExecutionInitiated: A request to signal an external workflow was made.
  • ExternalWorkflowExecutionSignaled: A signal, requested by this workflow execution, was successfully delivered to the target external workflow execution.
  • SignalExternalWorkflowExecutionFailed: The request to signal an external workflow execution failed.
  • RequestCancelExternalWorkflowExecutionInitiated: A request was made to request the cancellation of an external workflow execution.
  • ExternalWorkflowExecutionCancelRequested: Request to cancel an external workflow execution was successfully delivered to the target execution.
  • RequestCancelExternalWorkflowExecutionFailed: Request to cancel an external workflow execution failed.
  • LambdaFunctionScheduled: An AWS Lambda function was scheduled for execution.
  • LambdaFunctionStarted: The scheduled function was invoked in the AWS Lambda service.
  • LambdaFunctionCompleted: The AWS Lambda function successfully completed.
  • LambdaFunctionFailed: The AWS Lambda function execution failed.
  • LambdaFunctionTimedOut: The AWS Lambda function execution timed out.
  • ScheduleLambdaFunctionFailed: Failed to process ScheduleLambdaFunction decision. This happens when the workflow execution does not have the proper IAM role attached to invoke AWS Lambda functions.
  • StartLambdaFunctionFailed: Failed to invoke the scheduled function in the AWS Lambda service. This happens when the AWS Lambda service is not available in the current region, or received too many requests.
" }, "HistoryEventList":{ "type":"list", "member":{"shape":"HistoryEvent"} }, "Identity":{ "type":"string", "max":256 }, "LambdaFunctionCompletedEventAttributes":{ "type":"structure", "required":[ "scheduledEventId", "startedEventId" ], "members":{ "scheduledEventId":{ "shape":"EventId", "documentation":"

The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the LambdaFunctionStarted event recorded in the history.

" }, "result":{ "shape":"Data", "documentation":"

The result of the function execution (if any).

" } }, "documentation":"

Provides details for the LambdaFunctionCompleted event.

" }, "LambdaFunctionFailedEventAttributes":{ "type":"structure", "required":[ "scheduledEventId", "startedEventId" ], "members":{ "scheduledEventId":{ "shape":"EventId", "documentation":"

The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the LambdaFunctionStarted event recorded in the history.

" }, "reason":{ "shape":"FailureReason", "documentation":"

The reason provided for the failure (if any).

" }, "details":{ "shape":"Data", "documentation":"

The details of the failure (if any).

" } }, "documentation":"

Provides details for the LambdaFunctionFailed event.

" }, "LambdaFunctionScheduledEventAttributes":{ "type":"structure", "required":[ "id", "name", "decisionTaskCompletedEventId" ], "members":{ "id":{ "shape":"FunctionId", "documentation":"

The unique Amazon SWF ID for the AWS Lambda task.

" }, "name":{ "shape":"FunctionName", "documentation":"

The name of the scheduled AWS Lambda function.

" }, "input":{ "shape":"FunctionInput", "documentation":"

Input provided to the AWS Lambda function.

" }, "startToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

The maximum time, in seconds, that the AWS Lambda function can take to execute from start to close before it is marked as failed.

" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event for the decision that resulted in the scheduling of this AWS Lambda function. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details for the LambdaFunctionScheduled event.

" }, "LambdaFunctionStartedEventAttributes":{ "type":"structure", "required":["scheduledEventId"], "members":{ "scheduledEventId":{ "shape":"EventId", "documentation":"

The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details for the LambdaFunctionStarted event.

" }, "LambdaFunctionTimedOutEventAttributes":{ "type":"structure", "required":[ "scheduledEventId", "startedEventId" ], "members":{ "scheduledEventId":{ "shape":"EventId", "documentation":"

The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the LambdaFunctionStarted event recorded in the history.

" }, "timeoutType":{ "shape":"LambdaFunctionTimeoutType", "documentation":"

The type of the timeout that caused this event.

" } }, "documentation":"

Provides details for the LambdaFunctionTimedOut event.

" }, "LambdaFunctionTimeoutType":{ "type":"string", "enum":["START_TO_CLOSE"] }, "LimitExceededFault":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A description that may help with diagnosing the cause of the fault.

" } }, "exception":true, "documentation":"

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

" }, "LimitedData":{ "type":"string", "max":2048 }, "ListActivityTypesInput":{ "type":"structure", "required":[ "domain", "registrationStatus" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain in which the activity types have been registered.

" }, "name":{ "shape":"Name", "documentation":"

If specified, only lists the activity types that have this name.

" }, "registrationStatus":{ "shape":"RegistrationStatus", "documentation":"

Specifies the registration status of the activity types to list.

" }, "nextPageToken":{ "shape":"PageToken", "documentation":"

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

" }, "maximumPageSize":{ "shape":"PageSize", "documentation":"

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

" }, "reverseOrder":{ "shape":"ReverseOrder", "documentation":"

When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the activity types.

" } } }, "ListClosedWorkflowExecutionsInput":{ "type":"structure", "required":["domain"], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain that contains the workflow executions to list.

" }, "startTimeFilter":{ "shape":"ExecutionTimeFilter", "documentation":"

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. Also, if this parameter is specified, the returned results are ordered by their start times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both." }, "closeTimeFilter":{ "shape":"ExecutionTimeFilter", "documentation":"

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. Also, if this parameter is specified, the returned results are ordered by their close times.

startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both." }, "executionFilter":{ "shape":"WorkflowExecutionFilter", "documentation":"

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request." }, "closeStatusFilter":{ "shape":"CloseStatusFilter", "documentation":"

If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request." }, "typeFilter":{ "shape":"WorkflowTypeFilter", "documentation":"

If specified, only executions of the type specified in the filter are returned.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request." }, "tagFilter":{ "shape":"TagFilter", "documentation":"

If specified, only executions that have the matching tag are listed.

closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request." }, "nextPageToken":{ "shape":"PageToken", "documentation":"

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

" }, "maximumPageSize":{ "shape":"PageSize", "documentation":"

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

" }, "reverseOrder":{ "shape":"ReverseOrder", "documentation":"

When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

" } } }, "ListDomainsInput":{ "type":"structure", "required":["registrationStatus"], "members":{ "nextPageToken":{ "shape":"PageToken", "documentation":"

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

" }, "registrationStatus":{ "shape":"RegistrationStatus", "documentation":"

Specifies the registration status of the domains to list.

" }, "maximumPageSize":{ "shape":"PageSize", "documentation":"

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

" }, "reverseOrder":{ "shape":"ReverseOrder", "documentation":"

When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

" } } }, "ListOpenWorkflowExecutionsInput":{ "type":"structure", "required":[ "domain", "startTimeFilter" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain that contains the workflow executions to list.

" }, "startTimeFilter":{ "shape":"ExecutionTimeFilter", "documentation":"

Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

" }, "typeFilter":{ "shape":"WorkflowTypeFilter", "documentation":"

If specified, only executions of the type specified in the filter are returned.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request." }, "tagFilter":{ "shape":"TagFilter", "documentation":"

If specified, only executions that have the matching tag are listed.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request." }, "nextPageToken":{ "shape":"PageToken", "documentation":"

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

" }, "maximumPageSize":{ "shape":"PageSize", "documentation":"

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

" }, "reverseOrder":{ "shape":"ReverseOrder", "documentation":"

When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.

" }, "executionFilter":{ "shape":"WorkflowExecutionFilter", "documentation":"

If specified, only workflow executions matching the workflow ID specified in the filter are returned.

executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request." } } }, "ListWorkflowTypesInput":{ "type":"structure", "required":[ "domain", "registrationStatus" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain in which the workflow types have been registered.

" }, "name":{ "shape":"Name", "documentation":"

If specified, lists the workflow type with this name.

" }, "registrationStatus":{ "shape":"RegistrationStatus", "documentation":"

Specifies the registration status of the workflow types to list.

" }, "nextPageToken":{ "shape":"PageToken", "documentation":"

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

" }, "maximumPageSize":{ "shape":"PageSize", "documentation":"

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

" }, "reverseOrder":{ "shape":"ReverseOrder", "documentation":"

When set to true, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name of the workflow types.

" } } }, "MarkerName":{ "type":"string", "min":1, "max":256 }, "MarkerRecordedEventAttributes":{ "type":"structure", "required":[ "markerName", "decisionTaskCompletedEventId" ], "members":{ "markerName":{ "shape":"MarkerName", "documentation":"

The name of the marker.

" }, "details":{ "shape":"Data", "documentation":"

Details of the marker (if any).

" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarker decision that requested this marker. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the MarkerRecorded event.

" }, "Name":{ "type":"string", "min":1, "max":256 }, "OpenDecisionTasksCount":{ "type":"integer", "min":0, "max":1 }, "OperationNotPermittedFault":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A description that may help with diagnosing the cause of the fault.

" } }, "exception":true, "documentation":"

Returned when the caller does not have sufficient permissions to invoke the action.

" }, "PageSize":{ "type":"integer", "min":0, "max":1000 }, "PageToken":{ "type":"string", "max":2048 }, "PendingTaskCount":{ "type":"structure", "required":["count"], "members":{ "count":{ "shape":"Count", "documentation":"

The number of tasks in the task list.

" }, "truncated":{ "shape":"Truncated", "documentation":"

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.

" } }, "documentation":"

Contains the count of tasks in a task list.

" }, "PollForActivityTaskInput":{ "type":"structure", "required":[ "domain", "taskList" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain that contains the task lists being polled.

" }, "taskList":{ "shape":"TaskList", "documentation":"

Specifies the task list to poll for activity tasks.

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 quotarnquot.

" }, "identity":{ "shape":"Identity", "documentation":"

Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

" } } }, "PollForDecisionTaskInput":{ "type":"structure", "required":[ "domain", "taskList" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain containing the task lists to poll.

" }, "taskList":{ "shape":"TaskList", "documentation":"

Specifies the task list to poll for decision tasks.

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 quotarnquot.

" }, "identity":{ "shape":"Identity", "documentation":"

Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

" }, "nextPageToken":{ "shape":"PageToken", "documentation":"

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken will not return a new decision task.." }, "maximumPageSize":{ "shape":"PageSize", "documentation":"

The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

" }, "reverseOrder":{ "shape":"ReverseOrder", "documentation":"

When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events.

" } } }, "RecordActivityTaskHeartbeatInput":{ "type":"structure", "required":["taskToken"], "members":{ "taskToken":{ "shape":"TaskToken", "documentation":"

The taskToken of the ActivityTask.

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. " }, "details":{ "shape":"LimitedData", "documentation":"

If specified, contains details about the progress of the task.

" } } }, "RecordMarkerDecisionAttributes":{ "type":"structure", "required":["markerName"], "members":{ "markerName":{ "shape":"MarkerName", "documentation":"

Required. The name of the marker.

" }, "details":{ "shape":"Data", "documentation":"

Optional. details of the marker.

" } }, "documentation":"

Provides details of the RecordMarker decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "RecordMarkerFailedCause":{ "type":"string", "enum":["OPERATION_NOT_PERMITTED"] }, "RecordMarkerFailedEventAttributes":{ "type":"structure", "required":[ "markerName", "cause", "decisionTaskCompletedEventId" ], "members":{ "markerName":{ "shape":"MarkerName", "documentation":"

The marker's name.

" }, "cause":{ "shape":"RecordMarkerFailedCause", "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarkerFailed decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the RecordMarkerFailed event.

" }, "RegisterActivityTypeInput":{ "type":"structure", "required":[ "domain", "name", "version" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain in which this activity is to be registered.

" }, "name":{ "shape":"Name", "documentation":"

The name of the activity type within the domain.

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 quotarnquot.

" }, "version":{ "shape":"Version", "documentation":"

The version of the activity type.

The activity type consists of the name and version, the combination of which must be unique within the domain.

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 quotarnquot.

" }, "description":{ "shape":"Description", "documentation":"

A textual description of the activity type.

" }, "defaultTaskStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "defaultTaskHeartbeatTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "defaultTaskList":{ "shape":"TaskList", "documentation":"

If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask decision.

" }, "defaultTaskPriority":{ "shape":"TaskPriority", "documentation":"

The default task priority to assign to the activity type. If not assigned, then \"0\" will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

" }, "defaultTaskScheduleToStartTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "defaultTaskScheduleToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" } } }, "RegisterDomainInput":{ "type":"structure", "required":[ "name", "workflowExecutionRetentionPeriodInDays" ], "members":{ "name":{ "shape":"DomainName", "documentation":"

Name of the domain to register. The name must be unique in the region that the domain is registered in.

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 quotarnquot.

" }, "description":{ "shape":"Description", "documentation":"

A text description of the domain.

" }, "workflowExecutionRetentionPeriodInDays":{ "shape":"DurationInDays", "documentation":"

The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution is not available in the results of visibility calls.

If you pass the value NONE or 0 (zero), then the workflow execution history will not be retained. As soon as the workflow execution completes, the execution record and its history are deleted.

The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.

" } } }, "RegisterWorkflowTypeInput":{ "type":"structure", "required":[ "domain", "name", "version" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain in which to register the workflow type.

" }, "name":{ "shape":"Name", "documentation":"

The name of the workflow type.

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 quotarnquot.

" }, "version":{ "shape":"Version", "documentation":"

The version of the workflow type.

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 workflow types, use the ListWorkflowTypes action.

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 quotarnquot.

" }, "description":{ "shape":"Description", "documentation":"

Textual description of the workflow type.

" }, "defaultTaskStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "defaultExecutionStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution action or StartChildWorkflowExecution decision.

The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for defaultExecutionStartToCloseTimeout; there is a 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.

" }, "defaultTaskList":{ "shape":"TaskList", "documentation":"

If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list is not provided when starting the execution through the StartWorkflowExecution action or StartChildWorkflowExecution decision.

" }, "defaultTaskPriority":{ "shape":"TaskPriority", "documentation":"

The default task priority to assign to the workflow type. If not assigned, then \"0\" will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

" }, "defaultChildPolicy":{ "shape":"ChildPolicy", "documentation":"

If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

The supported child policies are:

  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON: no action will be taken. The child executions will continue to run.
" }, "defaultLambdaRole":{ "shape":"Arn", "documentation":"

The ARN of the default IAM role to use when a workflow execution of this type invokes AWS Lambda functions.

This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution and ContinueAsNewWorkflowExecution decision.

" } } }, "RegistrationStatus":{ "type":"string", "enum":[ "REGISTERED", "DEPRECATED" ] }, "RequestCancelActivityTaskDecisionAttributes":{ "type":"structure", "required":["activityId"], "members":{ "activityId":{ "shape":"ActivityId", "documentation":"

The activityId of the activity task to be canceled.

" } }, "documentation":"

Provides details of the RequestCancelActivityTask decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "RequestCancelActivityTaskFailedCause":{ "type":"string", "enum":[ "ACTIVITY_ID_UNKNOWN", "OPERATION_NOT_PERMITTED" ] }, "RequestCancelActivityTaskFailedEventAttributes":{ "type":"structure", "required":[ "activityId", "cause", "decisionTaskCompletedEventId" ], "members":{ "activityId":{ "shape":"ActivityId", "documentation":"

The activityId provided in the RequestCancelActivityTask decision that failed.

" }, "cause":{ "shape":"RequestCancelActivityTaskFailedCause", "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the RequestCancelActivityTaskFailed event.

" }, "RequestCancelExternalWorkflowExecutionDecisionAttributes":{ "type":"structure", "required":["workflowId"], "members":{ "workflowId":{ "shape":"WorkflowId", "documentation":"

Required. The workflowId of the external workflow execution to cancel.

" }, "runId":{ "shape":"RunIdOptional", "documentation":"

The runId of the external workflow execution to cancel.

" }, "control":{ "shape":"Data", "documentation":"

Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.

" } }, "documentation":"

Provides details of the RequestCancelExternalWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "RequestCancelExternalWorkflowExecutionFailedCause":{ "type":"string", "enum":[ "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED" ] }, "RequestCancelExternalWorkflowExecutionFailedEventAttributes":{ "type":"structure", "required":[ "workflowId", "cause", "initiatedEventId", "decisionTaskCompletedEventId" ], "members":{ "workflowId":{ "shape":"WorkflowId", "documentation":"

The workflowId of the external workflow to which the cancel request was to be delivered.

" }, "runId":{ "shape":"RunIdOptional", "documentation":"

The runId of the external workflow execution.

" }, "cause":{ "shape":"RequestCancelExternalWorkflowExecutionFailedCause", "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." }, "initiatedEventId":{ "shape":"EventId", "documentation":"

The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "control":{"shape":"Data"} }, "documentation":"

Provides details of the RequestCancelExternalWorkflowExecutionFailed event.

" }, "RequestCancelExternalWorkflowExecutionInitiatedEventAttributes":{ "type":"structure", "required":[ "workflowId", "decisionTaskCompletedEventId" ], "members":{ "workflowId":{ "shape":"WorkflowId", "documentation":"

The workflowId of the external workflow execution to be canceled.

" }, "runId":{ "shape":"RunIdOptional", "documentation":"

The runId of the external workflow execution to be canceled.

" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "control":{ "shape":"Data", "documentation":"

Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.

" } }, "documentation":"

Provides details of the RequestCancelExternalWorkflowExecutionInitiated event.

" }, "RequestCancelWorkflowExecutionInput":{ "type":"structure", "required":[ "domain", "workflowId" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain containing the workflow execution to cancel.

" }, "workflowId":{ "shape":"WorkflowId", "documentation":"

The workflowId of the workflow execution to cancel.

" }, "runId":{ "shape":"RunIdOptional", "documentation":"

The runId of the workflow execution to cancel.

" } } }, "RespondActivityTaskCanceledInput":{ "type":"structure", "required":["taskToken"], "members":{ "taskToken":{ "shape":"TaskToken", "documentation":"

The taskToken of the ActivityTask.

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." }, "details":{ "shape":"Data", "documentation":"

Optional. Information about the cancellation.

" } } }, "RespondActivityTaskCompletedInput":{ "type":"structure", "required":["taskToken"], "members":{ "taskToken":{ "shape":"TaskToken", "documentation":"

The taskToken of the ActivityTask.

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." }, "result":{ "shape":"Data", "documentation":"

The result of the activity task. It is a free form string that is implementation specific.

" } } }, "RespondActivityTaskFailedInput":{ "type":"structure", "required":["taskToken"], "members":{ "taskToken":{ "shape":"TaskToken", "documentation":"

The taskToken of the ActivityTask.

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." }, "reason":{ "shape":"FailureReason", "documentation":"

Description of the error that may assist in diagnostics.

" }, "details":{ "shape":"Data", "documentation":"

Optional. Detailed information about the failure.

" } } }, "RespondDecisionTaskCompletedInput":{ "type":"structure", "required":["taskToken"], "members":{ "taskToken":{ "shape":"TaskToken", "documentation":"

The taskToken from the DecisionTask.

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." }, "decisions":{ "shape":"DecisionList", "documentation":"

The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the decision structure for details.

" }, "executionContext":{ "shape":"Data", "documentation":"

User defined context to add to workflow execution.

" } } }, "ReverseOrder":{"type":"boolean"}, "Run":{ "type":"structure", "members":{ "runId":{ "shape":"RunId", "documentation":"

The runId of a workflow execution. This ID is generated by the service and can be used to uniquely identify the workflow execution within a domain.

" } }, "documentation":"

Specifies the runId of a workflow execution.

" }, "RunId":{ "type":"string", "min":1, "max":64 }, "RunIdOptional":{ "type":"string", "max":64 }, "ScheduleActivityTaskDecisionAttributes":{ "type":"structure", "required":[ "activityType", "activityId" ], "members":{ "activityType":{ "shape":"ActivityType", "documentation":"

Required. The type of the activity task to schedule.

" }, "activityId":{ "shape":"ActivityId", "documentation":"

Required. The activityId of the activity task.

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 quotarnquot.

" }, "control":{ "shape":"Data", "documentation":"

Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.

" }, "input":{ "shape":"Data", "documentation":"

The input provided to the activity task.

" }, "scheduleToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

The maximum duration for this activity task.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault will be returned." }, "taskList":{ "shape":"TaskList", "documentation":"

If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type will be used.

A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault will be returned.

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 quotarnquot.

" }, "taskPriority":{ "shape":"TaskPriority", "documentation":"

Optional. If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

" }, "scheduleToStartTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

Optional. If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault will be returned." }, "startToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault will be returned." }, "heartbeatTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it will be ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" } }, "documentation":"

Provides details of the ScheduleActivityTask decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • activityType.name: String constraint. The key is swf:activityType.name.
    • activityType.version: String constraint. The key is swf:activityType.version.
    • taskList: String constraint. The key is swf:taskList.name.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "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" ] }, "ScheduleActivityTaskFailedEventAttributes":{ "type":"structure", "required":[ "activityType", "activityId", "cause", "decisionTaskCompletedEventId" ], "members":{ "activityType":{ "shape":"ActivityType", "documentation":"

The activity type provided in the ScheduleActivityTask decision that failed.

" }, "activityId":{ "shape":"ActivityId", "documentation":"

The activityId provided in the ScheduleActivityTask decision that failed.

" }, "cause":{ "shape":"ScheduleActivityTaskFailedCause", "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the ScheduleActivityTaskFailed event.

" }, "ScheduleLambdaFunctionDecisionAttributes":{ "type":"structure", "required":[ "id", "name" ], "members":{ "id":{ "shape":"FunctionId", "documentation":"

Required. The SWF id of the AWS Lambda task.

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 quotarnquot.

" }, "name":{ "shape":"FunctionName", "documentation":"

Required. The name of the AWS Lambda function to invoke.

" }, "input":{ "shape":"FunctionInput", "documentation":"

The input provided to the AWS Lambda function.

" }, "startToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

If set, specifies the maximum duration the function may take to execute.

" } }, "documentation":"

Provides details of the ScheduleLambdaFunction decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • activityType.name: String constraint. The key is swf:activityType.name.
    • activityType.version: String constraint. The key is swf:activityType.version.
    • taskList: String constraint. The key is swf:taskList.name.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "ScheduleLambdaFunctionFailedCause":{ "type":"string", "enum":[ "ID_ALREADY_IN_USE", "OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED", "LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED", "LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION" ] }, "ScheduleLambdaFunctionFailedEventAttributes":{ "type":"structure", "required":[ "id", "name", "cause", "decisionTaskCompletedEventId" ], "members":{ "id":{ "shape":"FunctionId", "documentation":"

The unique Amazon SWF ID of the AWS Lambda task.

" }, "name":{ "shape":"FunctionName", "documentation":"

The name of the scheduled AWS Lambda function.

" }, "cause":{ "shape":"ScheduleLambdaFunctionFailedCause", "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this AWS Lambda function. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details for the ScheduleLambdaFunctionFailed event.

" }, "SignalExternalWorkflowExecutionDecisionAttributes":{ "type":"structure", "required":[ "workflowId", "signalName" ], "members":{ "workflowId":{ "shape":"WorkflowId", "documentation":"

Required. The workflowId of the workflow execution to be signaled.

" }, "runId":{ "shape":"RunIdOptional", "documentation":"

The runId of the workflow execution to be signaled.

" }, "signalName":{ "shape":"SignalName", "documentation":"

Required. The name of the signal.The target workflow execution will use the signal name and input to process the signal.

" }, "input":{ "shape":"Data", "documentation":"

Optional. Input data to be provided with the signal. The target workflow execution will use the signal name and input data to process the signal.

" }, "control":{ "shape":"Data", "documentation":"

Optional. Data attached to the event that can be used by the decider in subsequent decision tasks.

" } }, "documentation":"

Provides details of the SignalExternalWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "SignalExternalWorkflowExecutionFailedCause":{ "type":"string", "enum":[ "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED" ] }, "SignalExternalWorkflowExecutionFailedEventAttributes":{ "type":"structure", "required":[ "workflowId", "cause", "initiatedEventId", "decisionTaskCompletedEventId" ], "members":{ "workflowId":{ "shape":"WorkflowId", "documentation":"

The workflowId of the external workflow execution that the signal was being delivered to.

" }, "runId":{ "shape":"RunIdOptional", "documentation":"

The runId of the external workflow execution that the signal was being delivered to.

" }, "cause":{ "shape":"SignalExternalWorkflowExecutionFailedCause", "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." }, "initiatedEventId":{ "shape":"EventId", "documentation":"

The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "control":{"shape":"Data"} }, "documentation":"

Provides details of the SignalExternalWorkflowExecutionFailed event.

" }, "SignalExternalWorkflowExecutionInitiatedEventAttributes":{ "type":"structure", "required":[ "workflowId", "signalName", "decisionTaskCompletedEventId" ], "members":{ "workflowId":{ "shape":"WorkflowId", "documentation":"

The workflowId of the external workflow execution.

" }, "runId":{ "shape":"RunIdOptional", "documentation":"

The runId of the external workflow execution to send the signal to.

" }, "signalName":{ "shape":"SignalName", "documentation":"

The name of the signal.

" }, "input":{ "shape":"Data", "documentation":"

Input provided to the signal (if any).

" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "control":{ "shape":"Data", "documentation":"

Optional. data attached to the event that can be used by the decider in subsequent decision tasks.

" } }, "documentation":"

Provides details of the SignalExternalWorkflowExecutionInitiated event.

" }, "SignalName":{ "type":"string", "min":1, "max":256 }, "SignalWorkflowExecutionInput":{ "type":"structure", "required":[ "domain", "workflowId", "signalName" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain containing the workflow execution to signal.

" }, "workflowId":{ "shape":"WorkflowId", "documentation":"

The workflowId of the workflow execution to signal.

" }, "runId":{ "shape":"RunIdOptional", "documentation":"

The runId of the workflow execution to signal.

" }, "signalName":{ "shape":"SignalName", "documentation":"

The name of the signal. This name must be meaningful to the target workflow.

" }, "input":{ "shape":"Data", "documentation":"

Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.

" } } }, "StartChildWorkflowExecutionDecisionAttributes":{ "type":"structure", "required":[ "workflowType", "workflowId" ], "members":{ "workflowType":{ "shape":"WorkflowType", "documentation":"

Required. The type of the workflow execution to be started.

" }, "workflowId":{ "shape":"WorkflowId", "documentation":"

Required. The workflowId of the workflow execution.

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 quotarnquot.

" }, "control":{ "shape":"Data", "documentation":"

Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the child workflow execution.

" }, "input":{ "shape":"Data", "documentation":"

The input to be provided to the workflow execution.

" }, "executionStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

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. 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." }, "taskList":{ "shape":"TaskList", "documentation":"

The name of the task list to be used for decision tasks of the child workflow execution.

A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.

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 quotarnquot.

" }, "taskPriority":{ "shape":"TaskPriority", "documentation":"

Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

" }, "taskStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

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. 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." }, "childPolicy":{ "shape":"ChildPolicy", "documentation":"

Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

The supported child policies are:

  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON: no action will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned." }, "tagList":{ "shape":"TagList", "documentation":"

The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

" }, "lambdaRole":{ "shape":"Arn", "documentation":"

The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.

In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field." } }, "documentation":"

Provides details of the StartChildWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
    • tagList.member.N: The key is \"swf:tagList.N\" where N is the tag number from 0 to 4, inclusive.
    • taskList: String constraint. The key is swf:taskList.name.
    • workflowType.name: String constraint. The key is swf:workflowType.name.
    • workflowType.version: String constraint. The key is swf:workflowType.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "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" ] }, "StartChildWorkflowExecutionFailedEventAttributes":{ "type":"structure", "required":[ "workflowType", "cause", "workflowId", "initiatedEventId", "decisionTaskCompletedEventId" ], "members":{ "workflowType":{ "shape":"WorkflowType", "documentation":"

The workflow type provided in the StartChildWorkflowExecution decision that failed.

" }, "cause":{ "shape":"StartChildWorkflowExecutionFailedCause", "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." }, "workflowId":{ "shape":"WorkflowId", "documentation":"

The workflowId of the child workflow execution.

" }, "initiatedEventId":{ "shape":"EventId", "documentation":"

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

" }, "control":{"shape":"Data"} }, "documentation":"

Provides details of the StartChildWorkflowExecutionFailed event.

" }, "StartChildWorkflowExecutionInitiatedEventAttributes":{ "type":"structure", "required":[ "workflowId", "workflowType", "taskList", "decisionTaskCompletedEventId", "childPolicy" ], "members":{ "workflowId":{ "shape":"WorkflowId", "documentation":"

The workflowId of the child workflow execution.

" }, "workflowType":{ "shape":"WorkflowType", "documentation":"

The type of the child workflow execution.

" }, "control":{ "shape":"Data", "documentation":"

Optional. Data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.

" }, "input":{ "shape":"Data", "documentation":"

The inputs provided to the child workflow execution (if any).

" }, "executionStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "taskList":{ "shape":"TaskList", "documentation":"

The name of the task list used for the decision tasks of the child workflow execution.

" }, "taskPriority":{ "shape":"TaskPriority", "documentation":"

Optional. The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

" }, "childPolicy":{ "shape":"ChildPolicy", "documentation":"

The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

The supported child policies are:

  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON: no action will be taken. The child executions will continue to run.
" }, "taskStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

The maximum duration allowed for the decision tasks for this workflow execution.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "tagList":{ "shape":"TagList", "documentation":"

The list of tags to associated with the child workflow execution.

" }, "lambdaRole":{ "shape":"Arn", "documentation":"

The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.

" } }, "documentation":"

Provides details of the StartChildWorkflowExecutionInitiated event.

" }, "StartLambdaFunctionFailedCause":{ "type":"string", "enum":["ASSUME_ROLE_FAILED"] }, "StartLambdaFunctionFailedEventAttributes":{ "type":"structure", "members":{ "scheduledEventId":{ "shape":"EventId", "documentation":"

The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "cause":{ "shape":"StartLambdaFunctionFailedCause", "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." }, "message":{ "shape":"CauseMessage", "documentation":"

The error message (if any).

" } }, "documentation":"

Provides details for the StartLambdaFunctionFailed event.

" }, "StartTimerDecisionAttributes":{ "type":"structure", "required":[ "timerId", "startToFireTimeout" ], "members":{ "timerId":{ "shape":"TimerId", "documentation":"

Required. The unique ID of the timer.

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 quotarnquot.

" }, "control":{ "shape":"Data", "documentation":"

Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.

" }, "startToFireTimeout":{ "shape":"DurationInSeconds", "documentation":"

Required. The duration to wait before firing the timer.

The duration is specified in seconds; an integer greater than or equal to 0.

" } }, "documentation":"

Provides details of the StartTimer decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.
  • Use an Action element to allow or deny permission to call this action.
  • You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

" }, "StartTimerFailedCause":{ "type":"string", "enum":[ "TIMER_ID_ALREADY_IN_USE", "OPEN_TIMERS_LIMIT_EXCEEDED", "TIMER_CREATION_RATE_EXCEEDED", "OPERATION_NOT_PERMITTED" ] }, "StartTimerFailedEventAttributes":{ "type":"structure", "required":[ "timerId", "cause", "decisionTaskCompletedEventId" ], "members":{ "timerId":{ "shape":"TimerId", "documentation":"

The timerId provided in the StartTimer decision that failed.

" }, "cause":{ "shape":"StartTimerFailedCause", "documentation":"

The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows." }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the StartTimerFailed event.

" }, "StartWorkflowExecutionInput":{ "type":"structure", "required":[ "domain", "workflowId", "workflowType" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The name of the domain in which the workflow execution is created.

" }, "workflowId":{ "shape":"WorkflowId", "documentation":"

The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time.

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 quotarnquot.

" }, "workflowType":{ "shape":"WorkflowType", "documentation":"

The type of the workflow to start.

" }, "taskList":{ "shape":"TaskList", "documentation":"

The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.

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 quotarnquot.

" }, "taskPriority":{ "shape":"TaskPriority", "documentation":"

The task priority to use for this workflow execution. This will override any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

" }, "input":{ "shape":"Data", "documentation":"

The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

" }, "executionStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit will cause the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for this timeout; there is a one-year max limit on the time that a workflow execution can run.

An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned." }, "tagList":{ "shape":"TagList", "documentation":"

The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

" }, "taskStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

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. 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." }, "childPolicy":{ "shape":"ChildPolicy", "documentation":"

If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

The supported child policies are:

  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON: no action will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned." }, "lambdaRole":{ "shape":"Arn", "documentation":"

The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.

In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field." } } }, "Tag":{ "type":"string", "min":1, "max":256 }, "TagFilter":{ "type":"structure", "required":["tag"], "members":{ "tag":{ "shape":"Tag", "documentation":"

Required. Specifies the tag that must be associated with the execution for it to meet the filter criteria.

" } }, "documentation":"

Used to filter the workflow executions in visibility APIs based on a tag.

" }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":5 }, "TaskList":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"Name", "documentation":"

The name of the task list.

" } }, "documentation":"

Represents a task list.

" }, "TaskPriority":{ "type":"string", "max":11 }, "TaskToken":{ "type":"string", "min":1, "max":1024 }, "TerminateReason":{ "type":"string", "max":256 }, "TerminateWorkflowExecutionInput":{ "type":"structure", "required":[ "domain", "workflowId" ], "members":{ "domain":{ "shape":"DomainName", "documentation":"

The domain of the workflow execution to terminate.

" }, "workflowId":{ "shape":"WorkflowId", "documentation":"

The workflowId of the workflow execution to terminate.

" }, "runId":{ "shape":"RunIdOptional", "documentation":"

The runId of the workflow execution to terminate.

" }, "reason":{ "shape":"TerminateReason", "documentation":"

Optional. A descriptive reason for terminating the workflow execution.

" }, "details":{ "shape":"Data", "documentation":"

Optional. Details for terminating the workflow execution.

" }, "childPolicy":{ "shape":"ChildPolicy", "documentation":"

If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

The supported child policies are:

  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON: no action will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned." } } }, "TimerCanceledEventAttributes":{ "type":"structure", "required":[ "timerId", "startedEventId", "decisionTaskCompletedEventId" ], "members":{ "timerId":{ "shape":"TimerId", "documentation":"

The unique ID of the timer that was canceled.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the TimerCanceled event.

" }, "TimerFiredEventAttributes":{ "type":"structure", "required":[ "timerId", "startedEventId" ], "members":{ "timerId":{ "shape":"TimerId", "documentation":"

The unique ID of the timer that fired.

" }, "startedEventId":{ "shape":"EventId", "documentation":"

The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the TimerFired event.

" }, "TimerId":{ "type":"string", "min":1, "max":256 }, "TimerStartedEventAttributes":{ "type":"structure", "required":[ "timerId", "startToFireTimeout", "decisionTaskCompletedEventId" ], "members":{ "timerId":{ "shape":"TimerId", "documentation":"

The unique ID of the timer that was started.

" }, "control":{ "shape":"Data", "documentation":"

Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.

" }, "startToFireTimeout":{ "shape":"DurationInSeconds", "documentation":"

The duration of time after which the timer will fire.

The duration is specified in seconds; an integer greater than or equal to 0.

" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the TimerStarted event.

" }, "Timestamp":{"type":"timestamp"}, "Truncated":{"type":"boolean"}, "TypeAlreadyExistsFault":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A description that may help with diagnosing the cause of the fault.

" } }, "exception":true, "documentation":"

Returned if the type already exists in the specified domain. You will get this fault even if the existing type is in deprecated status. You can specify another version if the intent is to create a new distinct version of the type.

" }, "TypeDeprecatedFault":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A description that may help with diagnosing the cause of the fault.

" } }, "exception":true, "documentation":"

Returned when the specified activity or workflow type was already deprecated.

" }, "UnknownResourceFault":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A description that may help with diagnosing the cause of the fault.

" } }, "exception":true, "documentation":"

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

" }, "Version":{ "type":"string", "min":1, "max":64 }, "VersionOptional":{ "type":"string", "max":64 }, "WorkflowExecution":{ "type":"structure", "required":[ "workflowId", "runId" ], "members":{ "workflowId":{ "shape":"WorkflowId", "documentation":"

The user defined identifier associated with the workflow execution.

" }, "runId":{ "shape":"RunId", "documentation":"

A system-generated unique identifier for the workflow execution.

" } }, "documentation":"

Represents a workflow execution.

" }, "WorkflowExecutionAlreadyStartedFault":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A description that may help with diagnosing the cause of the fault.

" } }, "exception":true, "documentation":"

Returned by StartWorkflowExecution when an open execution with the same workflowId is already running in the specified domain.

" }, "WorkflowExecutionCancelRequestedCause":{ "type":"string", "enum":["CHILD_POLICY_APPLIED"] }, "WorkflowExecutionCancelRequestedEventAttributes":{ "type":"structure", "members":{ "externalWorkflowExecution":{ "shape":"WorkflowExecution", "documentation":"

The external workflow execution for which the cancellation was requested.

" }, "externalInitiatedEventId":{ "shape":"EventId", "documentation":"

The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "cause":{ "shape":"WorkflowExecutionCancelRequestedCause", "documentation":"

If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.

" } }, "documentation":"

Provides details of the WorkflowExecutionCancelRequested event.

" }, "WorkflowExecutionCanceledEventAttributes":{ "type":"structure", "required":["decisionTaskCompletedEventId"], "members":{ "details":{ "shape":"Data", "documentation":"

Details for the cancellation (if any).

" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the WorkflowExecutionCanceled event.

" }, "WorkflowExecutionCompletedEventAttributes":{ "type":"structure", "required":["decisionTaskCompletedEventId"], "members":{ "result":{ "shape":"Data", "documentation":"

The result produced by the workflow execution upon successful completion.

" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the WorkflowExecutionCompleted event.

" }, "WorkflowExecutionConfiguration":{ "type":"structure", "required":[ "taskStartToCloseTimeout", "executionStartToCloseTimeout", "taskList", "childPolicy" ], "members":{ "taskStartToCloseTimeout":{ "shape":"DurationInSeconds", "documentation":"

The maximum duration allowed for decision tasks for this workflow execution.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "executionStartToCloseTimeout":{ "shape":"DurationInSeconds", "documentation":"

The total duration for this workflow execution.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "taskList":{ "shape":"TaskList", "documentation":"

The task list used for the decision tasks generated for this workflow execution.

" }, "taskPriority":{ "shape":"TaskPriority", "documentation":"

The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

" }, "childPolicy":{ "shape":"ChildPolicy", "documentation":"

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

The supported child policies are:

  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON: no action will be taken. The child executions will continue to run.
" }, "lambdaRole":{ "shape":"Arn", "documentation":"

The IAM role used by this workflow execution when invoking AWS Lambda functions.

" } }, "documentation":"

The configuration settings for a workflow execution including timeout values, tasklist etc. These configuration settings are determined from the defaults specified when registering the workflow type and those specified when starting the workflow execution.

" }, "WorkflowExecutionContinuedAsNewEventAttributes":{ "type":"structure", "required":[ "decisionTaskCompletedEventId", "newExecutionRunId", "taskList", "childPolicy", "workflowType" ], "members":{ "input":{ "shape":"Data", "documentation":"

The input provided to the new workflow execution.

" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "newExecutionRunId":{ "shape":"RunId", "documentation":"

The runId of the new workflow execution.

" }, "executionStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

The total duration allowed for the new workflow execution.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "taskList":{"shape":"TaskList"}, "taskPriority":{"shape":"TaskPriority"}, "taskStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

The maximum duration of decision tasks for the new workflow execution.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "childPolicy":{ "shape":"ChildPolicy", "documentation":"

The policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

The supported child policies are:

  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON: no action will be taken. The child executions will continue to run.
" }, "tagList":{ "shape":"TagList", "documentation":"

The list of tags associated with the new workflow execution.

" }, "workflowType":{"shape":"WorkflowType"}, "lambdaRole":{ "shape":"Arn", "documentation":"

The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.

" } }, "documentation":"

Provides details of the WorkflowExecutionContinuedAsNew event.

" }, "WorkflowExecutionCount":{ "type":"structure", "required":["count"], "members":{ "count":{ "shape":"Count", "documentation":"

The number of workflow executions.

" }, "truncated":{ "shape":"Truncated", "documentation":"

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.

" } }, "documentation":"

Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions

" }, "WorkflowExecutionDetail":{ "type":"structure", "required":[ "executionInfo", "executionConfiguration", "openCounts" ], "members":{ "executionInfo":{ "shape":"WorkflowExecutionInfo", "documentation":"

Information about the workflow execution.

" }, "executionConfiguration":{ "shape":"WorkflowExecutionConfiguration", "documentation":"

The configuration settings for this workflow execution including timeout values, tasklist etc.

" }, "openCounts":{ "shape":"WorkflowExecutionOpenCounts", "documentation":"

The number of tasks for this workflow execution. This includes open and closed tasks of all types.

" }, "latestActivityTaskTimestamp":{ "shape":"Timestamp", "documentation":"

The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.

" }, "latestExecutionContext":{ "shape":"Data", "documentation":"

The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.

" } }, "documentation":"

Contains details about a workflow execution.

" }, "WorkflowExecutionFailedEventAttributes":{ "type":"structure", "required":["decisionTaskCompletedEventId"], "members":{ "reason":{ "shape":"FailureReason", "documentation":"

The descriptive reason provided for the failure (if any).

" }, "details":{ "shape":"Data", "documentation":"

The details of the failure (if any).

" }, "decisionTaskCompletedEventId":{ "shape":"EventId", "documentation":"

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" } }, "documentation":"

Provides details of the WorkflowExecutionFailed event.

" }, "WorkflowExecutionFilter":{ "type":"structure", "required":["workflowId"], "members":{ "workflowId":{ "shape":"WorkflowId", "documentation":"

The workflowId to pass of match the criteria of this filter.

" } }, "documentation":"

Used to filter the workflow executions in visibility APIs by their workflowId.

" }, "WorkflowExecutionInfo":{ "type":"structure", "required":[ "execution", "workflowType", "startTimestamp", "executionStatus" ], "members":{ "execution":{ "shape":"WorkflowExecution", "documentation":"

The workflow execution this information is about.

" }, "workflowType":{ "shape":"WorkflowType", "documentation":"

The type of the workflow execution.

" }, "startTimestamp":{ "shape":"Timestamp", "documentation":"

The time when the execution was started.

" }, "closeTimestamp":{ "shape":"Timestamp", "documentation":"

The time when the workflow execution was closed. Set only if the execution status is CLOSED.

" }, "executionStatus":{ "shape":"ExecutionStatus", "documentation":"

The current status of the execution.

" }, "closeStatus":{ "shape":"CloseStatus", "documentation":"

If the execution status is closed then this specifies how the execution was closed:

  • COMPLETED: the execution was successfully completed.
  • CANCELED: the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.
  • TERMINATED: the execution was force terminated.
  • FAILED: the execution failed to complete.
  • TIMED_OUT: the execution did not complete in the alloted time and was automatically timed out.
  • CONTINUED_AS_NEW: the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.
" }, "parent":{ "shape":"WorkflowExecution", "documentation":"

If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

" }, "tagList":{ "shape":"TagList", "documentation":"

The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

" }, "cancelRequested":{ "shape":"Canceled", "documentation":"

Set to true if a cancellation is requested for this workflow execution.

" } }, "documentation":"

Contains information about a workflow execution.

" }, "WorkflowExecutionInfoList":{ "type":"list", "member":{"shape":"WorkflowExecutionInfo"} }, "WorkflowExecutionInfos":{ "type":"structure", "required":["executionInfos"], "members":{ "executionInfos":{ "shape":"WorkflowExecutionInfoList", "documentation":"

The list of workflow information structures.

" }, "nextPageToken":{ "shape":"PageToken", "documentation":"

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

" } }, "documentation":"

Contains a paginated list of information about workflow executions.

" }, "WorkflowExecutionOpenCounts":{ "type":"structure", "required":[ "openActivityTasks", "openDecisionTasks", "openTimers", "openChildWorkflowExecutions" ], "members":{ "openActivityTasks":{ "shape":"Count", "documentation":"

The count of activity tasks whose status is OPEN.

" }, "openDecisionTasks":{ "shape":"OpenDecisionTasksCount", "documentation":"

The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task.

" }, "openTimers":{ "shape":"Count", "documentation":"

The count of timers started by this workflow execution that have not fired yet.

" }, "openChildWorkflowExecutions":{ "shape":"Count", "documentation":"

The count of child workflow executions whose status is OPEN.

" }, "openLambdaFunctions":{ "shape":"Count", "documentation":"

The count of AWS Lambda functions that are currently executing.

" } }, "documentation":"

Contains the counts of open tasks, child workflow executions and timers for a workflow execution.

" }, "WorkflowExecutionSignaledEventAttributes":{ "type":"structure", "required":["signalName"], "members":{ "signalName":{ "shape":"SignalName", "documentation":"

The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.

" }, "input":{ "shape":"Data", "documentation":"

Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine how to process the signal.

" }, "externalWorkflowExecution":{ "shape":"WorkflowExecution", "documentation":"

The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.

" }, "externalInitiatedEventId":{ "shape":"EventId", "documentation":"

The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflow decision to signal this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. This field is set only if the signal was initiated by another workflow execution.

" } }, "documentation":"

Provides details of the WorkflowExecutionSignaled event.

" }, "WorkflowExecutionStartedEventAttributes":{ "type":"structure", "required":[ "childPolicy", "taskList", "workflowType" ], "members":{ "input":{ "shape":"Data", "documentation":"

The input provided to the workflow execution (if any).

" }, "executionStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

The maximum duration for this workflow execution.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "taskStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

The maximum duration of decision tasks for this workflow type.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "childPolicy":{ "shape":"ChildPolicy", "documentation":"

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

The supported child policies are:

  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON: no action will be taken. The child executions will continue to run.
" }, "taskList":{ "shape":"TaskList", "documentation":"

The name of the task list for scheduling the decision tasks for this workflow execution.

" }, "workflowType":{ "shape":"WorkflowType", "documentation":"

The workflow type of this execution.

" }, "tagList":{ "shape":"TagList", "documentation":"

The list of tags associated with this workflow execution. An execution can have up to 5 tags.

" }, "taskPriority":{"shape":"TaskPriority"}, "continuedExecutionRunId":{ "shape":"RunIdOptional", "documentation":"

If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.

" }, "parentWorkflowExecution":{ "shape":"WorkflowExecution", "documentation":"

The source workflow execution that started this workflow execution. The member is not set if the workflow execution was not started by a workflow.

" }, "parentInitiatedEventId":{ "shape":"EventId", "documentation":"

The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

" }, "lambdaRole":{ "shape":"Arn", "documentation":"

The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.

" } }, "documentation":"

Provides details of WorkflowExecutionStarted event.

" }, "WorkflowExecutionTerminatedCause":{ "type":"string", "enum":[ "CHILD_POLICY_APPLIED", "EVENT_LIMIT_EXCEEDED", "OPERATOR_INITIATED" ] }, "WorkflowExecutionTerminatedEventAttributes":{ "type":"structure", "required":["childPolicy"], "members":{ "reason":{ "shape":"TerminateReason", "documentation":"

The reason provided for the termination (if any).

" }, "details":{ "shape":"Data", "documentation":"

The details provided for the termination (if any).

" }, "childPolicy":{ "shape":"ChildPolicy", "documentation":"

The policy used for the child workflow executions of this workflow execution.

The supported child policies are:

  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON: no action will be taken. The child executions will continue to run.
" }, "cause":{ "shape":"WorkflowExecutionTerminatedCause", "documentation":"

If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.

" } }, "documentation":"

Provides details of the WorkflowExecutionTerminated event.

" }, "WorkflowExecutionTimedOutEventAttributes":{ "type":"structure", "required":[ "timeoutType", "childPolicy" ], "members":{ "timeoutType":{ "shape":"WorkflowExecutionTimeoutType", "documentation":"

The type of timeout that caused this event.

" }, "childPolicy":{ "shape":"ChildPolicy", "documentation":"

The policy used for the child workflow executions of this workflow execution.

The supported child policies are:

  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON: no action will be taken. The child executions will continue to run.
" } }, "documentation":"

Provides details of the WorkflowExecutionTimedOut event.

" }, "WorkflowExecutionTimeoutType":{ "type":"string", "enum":["START_TO_CLOSE"] }, "WorkflowId":{ "type":"string", "min":1, "max":256 }, "WorkflowType":{ "type":"structure", "required":[ "name", "version" ], "members":{ "name":{ "shape":"Name", "documentation":"

Required. The name of the workflow type.

The combination of workflow type name and version must be unique with in a domain." }, "version":{ "shape":"Version", "documentation":"

Required. The version of the workflow type.

The combination of workflow type name and version must be unique with in a domain." } }, "documentation":"

Represents a workflow type.

" }, "WorkflowTypeConfiguration":{ "type":"structure", "members":{ "defaultTaskStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

Optional. The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task does not close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "defaultExecutionStartToCloseTimeout":{ "shape":"DurationInSecondsOptional", "documentation":"

Optional. The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

The duration is specified in seconds; an integer greater than or equal to 0. The value \"NONE\" can be used to specify unlimited duration.

" }, "defaultTaskList":{ "shape":"TaskList", "documentation":"

Optional. The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

" }, "defaultTaskPriority":{ "shape":"TaskPriority", "documentation":"

Optional. The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

" }, "defaultChildPolicy":{ "shape":"ChildPolicy", "documentation":"

Optional. The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

The supported child policies are:

  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
  • ABANDON: no action will be taken. The child executions will continue to run.
" }, "defaultLambdaRole":{ "shape":"Arn", "documentation":"

The default IAM role to use when a workflow execution invokes a AWS Lambda function.

" } }, "documentation":"

The configuration settings of a workflow type.

" }, "WorkflowTypeDetail":{ "type":"structure", "required":[ "typeInfo", "configuration" ], "members":{ "typeInfo":{ "shape":"WorkflowTypeInfo", "documentation":"

General information about the workflow type.

The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.

  • REGISTERED: The type is registered and available. Workers supporting this type should be running.
  • DEPRECATED: The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type.
" }, "configuration":{ "shape":"WorkflowTypeConfiguration", "documentation":"

Configuration settings of the workflow type registered through RegisterWorkflowType

" } }, "documentation":"

Contains details about a workflow type.

" }, "WorkflowTypeFilter":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"Name", "documentation":"

Required. Name of the workflow type.

" }, "version":{ "shape":"VersionOptional", "documentation":"

Version of the workflow type.

" } }, "documentation":"

Used to filter workflow execution query results by type. Each parameter, if specified, defines a rule that must be satisfied by each returned result.

" }, "WorkflowTypeInfo":{ "type":"structure", "required":[ "workflowType", "status", "creationDate" ], "members":{ "workflowType":{ "shape":"WorkflowType", "documentation":"

The workflow type this information is about.

" }, "status":{ "shape":"RegistrationStatus", "documentation":"

The current status of the workflow type.

" }, "description":{ "shape":"Description", "documentation":"

The description of the type registered through RegisterWorkflowType.

" }, "creationDate":{ "shape":"Timestamp", "documentation":"

The date when this type was registered.

" }, "deprecationDate":{ "shape":"Timestamp", "documentation":"

If the type is in deprecated state, then it is set to the date when the type was deprecated.

" } }, "documentation":"

Contains information about a workflow type.

" }, "WorkflowTypeInfoList":{ "type":"list", "member":{"shape":"WorkflowTypeInfo"} }, "WorkflowTypeInfos":{ "type":"structure", "required":["typeInfos"], "members":{ "typeInfos":{ "shape":"WorkflowTypeInfoList", "documentation":"

The list of workflow type information.

" }, "nextPageToken":{ "shape":"PageToken", "documentation":"

If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call.

" } }, "documentation":"

Contains a paginated list of information structures about workflow types.

" } }, "examples":{ } } botocore-1.5.7/botocore/data/ses/0000777454262600001440000000000013042511307017725 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ses/2010-12-01/0000777454262600001440000000000013042511307020745 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ses/2010-12-01/waiters-2.json0000666454262600001440000000057413042511306023462 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "IdentityExists": { "delay": 3, "operation": "GetIdentityVerificationAttributes", "maxAttempts": 20, "acceptors": [ { "expected": "Success", "matcher": "pathAll", "state": "success", "argument": "VerificationAttributes.*.VerificationStatus" } ] } } } botocore-1.5.7/botocore/data/ses/2010-12-01/paginators-1.json0000666454262600001440000000027513042511306024150 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListIdentities": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxItems", "result_key": "Identities" } } } botocore-1.5.7/botocore/data/ses/2010-12-01/service-2.json0000666454262600001440000053672213042511306023455 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"email-2010-12-01", "apiVersion":"2010-12-01", "endpointPrefix":"email", "protocol":"query", "serviceAbbreviation":"Amazon SES", "serviceFullName":"Amazon Simple Email Service", "signatureVersion":"v4", "signingName":"ses", "xmlNamespace":"http://ses.amazonaws.com/doc/2010-12-01/" }, "operations":{ "CloneReceiptRuleSet":{ "name":"CloneReceiptRuleSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CloneReceiptRuleSetRequest"}, "output":{ "shape":"CloneReceiptRuleSetResponse", "resultWrapper":"CloneReceiptRuleSetResult" }, "errors":[ {"shape":"RuleSetDoesNotExistException"}, {"shape":"AlreadyExistsException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.

For information about setting up rule sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "CreateConfigurationSet":{ "name":"CreateConfigurationSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateConfigurationSetRequest"}, "output":{ "shape":"CreateConfigurationSetResponse", "resultWrapper":"CreateConfigurationSetResult" }, "errors":[ {"shape":"ConfigurationSetAlreadyExistsException"}, {"shape":"InvalidConfigurationSetException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a configuration set.

Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "CreateConfigurationSetEventDestination":{ "name":"CreateConfigurationSetEventDestination", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateConfigurationSetEventDestinationRequest"}, "output":{ "shape":"CreateConfigurationSetEventDestinationResponse", "resultWrapper":"CreateConfigurationSetEventDestinationResult" }, "errors":[ {"shape":"ConfigurationSetDoesNotExistException"}, {"shape":"EventDestinationAlreadyExistsException"}, {"shape":"InvalidCloudWatchDestinationException"}, {"shape":"InvalidFirehoseDestinationException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a configuration set event destination.

When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose.

An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "CreateReceiptFilter":{ "name":"CreateReceiptFilter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateReceiptFilterRequest"}, "output":{ "shape":"CreateReceiptFilterResponse", "resultWrapper":"CreateReceiptFilterResult" }, "errors":[ {"shape":"LimitExceededException"}, {"shape":"AlreadyExistsException"} ], "documentation":"

Creates a new IP address filter.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "CreateReceiptRule":{ "name":"CreateReceiptRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateReceiptRuleRequest"}, "output":{ "shape":"CreateReceiptRuleResponse", "resultWrapper":"CreateReceiptRuleResult" }, "errors":[ {"shape":"InvalidSnsTopicException"}, {"shape":"InvalidS3ConfigurationException"}, {"shape":"InvalidLambdaFunctionException"}, {"shape":"AlreadyExistsException"}, {"shape":"RuleDoesNotExistException"}, {"shape":"RuleSetDoesNotExistException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a receipt rule.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "CreateReceiptRuleSet":{ "name":"CreateReceiptRuleSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateReceiptRuleSetRequest"}, "output":{ "shape":"CreateReceiptRuleSetResponse", "resultWrapper":"CreateReceiptRuleSetResult" }, "errors":[ {"shape":"AlreadyExistsException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates an empty receipt rule set.

For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "DeleteConfigurationSet":{ "name":"DeleteConfigurationSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteConfigurationSetRequest"}, "output":{ "shape":"DeleteConfigurationSetResponse", "resultWrapper":"DeleteConfigurationSetResult" }, "errors":[ {"shape":"ConfigurationSetDoesNotExistException"} ], "documentation":"

Deletes a configuration set.

Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "DeleteConfigurationSetEventDestination":{ "name":"DeleteConfigurationSetEventDestination", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteConfigurationSetEventDestinationRequest"}, "output":{ "shape":"DeleteConfigurationSetEventDestinationResponse", "resultWrapper":"DeleteConfigurationSetEventDestinationResult" }, "errors":[ {"shape":"ConfigurationSetDoesNotExistException"}, {"shape":"EventDestinationDoesNotExistException"} ], "documentation":"

Deletes a configuration set event destination.

Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "DeleteIdentity":{ "name":"DeleteIdentity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteIdentityRequest"}, "output":{ "shape":"DeleteIdentityResponse", "resultWrapper":"DeleteIdentityResult" }, "documentation":"

Deletes the specified identity (an email address or a domain) from the list of verified identities.

This action is throttled at one request per second.

" }, "DeleteIdentityPolicy":{ "name":"DeleteIdentityPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteIdentityPolicyRequest"}, "output":{ "shape":"DeleteIdentityPolicyResponse", "resultWrapper":"DeleteIdentityPolicyResult" }, "documentation":"

Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "DeleteReceiptFilter":{ "name":"DeleteReceiptFilter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteReceiptFilterRequest"}, "output":{ "shape":"DeleteReceiptFilterResponse", "resultWrapper":"DeleteReceiptFilterResult" }, "documentation":"

Deletes the specified IP address filter.

For information about managing IP address filters, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "DeleteReceiptRule":{ "name":"DeleteReceiptRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteReceiptRuleRequest"}, "output":{ "shape":"DeleteReceiptRuleResponse", "resultWrapper":"DeleteReceiptRuleResult" }, "errors":[ {"shape":"RuleSetDoesNotExistException"} ], "documentation":"

Deletes the specified receipt rule.

For information about managing receipt rules, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "DeleteReceiptRuleSet":{ "name":"DeleteReceiptRuleSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteReceiptRuleSetRequest"}, "output":{ "shape":"DeleteReceiptRuleSetResponse", "resultWrapper":"DeleteReceiptRuleSetResult" }, "errors":[ {"shape":"CannotDeleteException"} ], "documentation":"

Deletes the specified receipt rule set and all of the receipt rules it contains.

The currently active rule set cannot be deleted.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "DeleteVerifiedEmailAddress":{ "name":"DeleteVerifiedEmailAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVerifiedEmailAddressRequest"}, "documentation":"

Deletes the specified email address from the list of verified addresses.

The DeleteVerifiedEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The DeleteIdentity action is now preferred.

This action is throttled at one request per second.

" }, "DescribeActiveReceiptRuleSet":{ "name":"DescribeActiveReceiptRuleSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeActiveReceiptRuleSetRequest"}, "output":{ "shape":"DescribeActiveReceiptRuleSetResponse", "resultWrapper":"DescribeActiveReceiptRuleSetResult" }, "documentation":"

Returns the metadata and receipt rules for the receipt rule set that is currently active.

For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "DescribeConfigurationSet":{ "name":"DescribeConfigurationSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConfigurationSetRequest"}, "output":{ "shape":"DescribeConfigurationSetResponse", "resultWrapper":"DescribeConfigurationSetResult" }, "errors":[ {"shape":"ConfigurationSetDoesNotExistException"} ], "documentation":"

Returns the details of the specified configuration set.

Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "DescribeReceiptRule":{ "name":"DescribeReceiptRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReceiptRuleRequest"}, "output":{ "shape":"DescribeReceiptRuleResponse", "resultWrapper":"DescribeReceiptRuleResult" }, "errors":[ {"shape":"RuleDoesNotExistException"}, {"shape":"RuleSetDoesNotExistException"} ], "documentation":"

Returns the details of the specified receipt rule.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "DescribeReceiptRuleSet":{ "name":"DescribeReceiptRuleSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeReceiptRuleSetRequest"}, "output":{ "shape":"DescribeReceiptRuleSetResponse", "resultWrapper":"DescribeReceiptRuleSetResult" }, "errors":[ {"shape":"RuleSetDoesNotExistException"} ], "documentation":"

Returns the details of the specified receipt rule set.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "GetIdentityDkimAttributes":{ "name":"GetIdentityDkimAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetIdentityDkimAttributesRequest"}, "output":{ "shape":"GetIdentityDkimAttributesResponse", "resultWrapper":"GetIdentityDkimAttributesResult" }, "documentation":"

Returns the current status of Easy DKIM signing for an entity. For domain name identities, this action also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.

This action takes a list of identities as input and returns the following information for each:

  • Whether Easy DKIM signing is enabled or disabled.

  • A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.

  • Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.

This action is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.

For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.

" }, "GetIdentityMailFromDomainAttributes":{ "name":"GetIdentityMailFromDomainAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetIdentityMailFromDomainAttributesRequest"}, "output":{ "shape":"GetIdentityMailFromDomainAttributesResponse", "resultWrapper":"GetIdentityMailFromDomainAttributesResult" }, "documentation":"

Returns the custom MAIL FROM attributes for a list of identities (email addresses and/or domains).

This action is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.

" }, "GetIdentityNotificationAttributes":{ "name":"GetIdentityNotificationAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetIdentityNotificationAttributesRequest"}, "output":{ "shape":"GetIdentityNotificationAttributesResponse", "resultWrapper":"GetIdentityNotificationAttributesResult" }, "documentation":"

Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.

This action is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

" }, "GetIdentityPolicies":{ "name":"GetIdentityPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetIdentityPoliciesRequest"}, "output":{ "shape":"GetIdentityPoliciesResponse", "resultWrapper":"GetIdentityPoliciesResult" }, "documentation":"

Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "GetIdentityVerificationAttributes":{ "name":"GetIdentityVerificationAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetIdentityVerificationAttributesRequest"}, "output":{ "shape":"GetIdentityVerificationAttributesResponse", "resultWrapper":"GetIdentityVerificationAttributesResult" }, "documentation":"

Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.

This action is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.

" }, "GetSendQuota":{ "name":"GetSendQuota", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"GetSendQuotaResponse", "resultWrapper":"GetSendQuotaResult" }, "documentation":"

Returns the user's current sending limits.

This action is throttled at one request per second.

" }, "GetSendStatistics":{ "name":"GetSendStatistics", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"GetSendStatisticsResponse", "resultWrapper":"GetSendStatisticsResult" }, "documentation":"

Returns the user's sending statistics. The result is a list of data points, representing the last two weeks of sending activity.

Each data point in the list contains statistics for a 15-minute interval.

This action is throttled at one request per second.

" }, "ListConfigurationSets":{ "name":"ListConfigurationSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListConfigurationSetsRequest"}, "output":{ "shape":"ListConfigurationSetsResponse", "resultWrapper":"ListConfigurationSetsResult" }, "documentation":"

Lists the configuration sets associated with your AWS account.

Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second and can return up to 50 configuration sets at a time.

" }, "ListIdentities":{ "name":"ListIdentities", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListIdentitiesRequest"}, "output":{ "shape":"ListIdentitiesResponse", "resultWrapper":"ListIdentitiesResult" }, "documentation":"

Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.

This action is throttled at one request per second.

" }, "ListIdentityPolicies":{ "name":"ListIdentityPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListIdentityPoliciesRequest"}, "output":{ "shape":"ListIdentityPoliciesResponse", "resultWrapper":"ListIdentityPoliciesResult" }, "documentation":"

Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies.

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "ListReceiptFilters":{ "name":"ListReceiptFilters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListReceiptFiltersRequest"}, "output":{ "shape":"ListReceiptFiltersResponse", "resultWrapper":"ListReceiptFiltersResult" }, "documentation":"

Lists the IP address filters associated with your AWS account.

For information about managing IP address filters, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "ListReceiptRuleSets":{ "name":"ListReceiptRuleSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListReceiptRuleSetsRequest"}, "output":{ "shape":"ListReceiptRuleSetsResponse", "resultWrapper":"ListReceiptRuleSetsResult" }, "documentation":"

Lists the receipt rule sets that exist under your AWS account. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "ListVerifiedEmailAddresses":{ "name":"ListVerifiedEmailAddresses", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"ListVerifiedEmailAddressesResponse", "resultWrapper":"ListVerifiedEmailAddressesResult" }, "documentation":"

Returns a list containing all of the email addresses that have been verified.

The ListVerifiedEmailAddresses action is deprecated as of the May 15, 2012 release of Domain Verification. The ListIdentities action is now preferred.

This action is throttled at one request per second.

" }, "PutIdentityPolicy":{ "name":"PutIdentityPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutIdentityPolicyRequest"}, "output":{ "shape":"PutIdentityPolicyResponse", "resultWrapper":"PutIdentityPolicyResult" }, "errors":[ {"shape":"InvalidPolicyException"} ], "documentation":"

Adds or updates a sending authorization policy for the specified identity (an email address or a domain).

This API is for the identity owner only. If you have not verified the identity, this API will return an error.

Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "ReorderReceiptRuleSet":{ "name":"ReorderReceiptRuleSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReorderReceiptRuleSetRequest"}, "output":{ "shape":"ReorderReceiptRuleSetResponse", "resultWrapper":"ReorderReceiptRuleSetResult" }, "errors":[ {"shape":"RuleSetDoesNotExistException"}, {"shape":"RuleDoesNotExistException"} ], "documentation":"

Reorders the receipt rules within a receipt rule set.

All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "SendBounce":{ "name":"SendBounce", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SendBounceRequest"}, "output":{ "shape":"SendBounceResponse", "resultWrapper":"SendBounceResult" }, "errors":[ {"shape":"MessageRejected"} ], "documentation":"

Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.

You cannot use this API to send generic bounces for mail that was not received by Amazon SES.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "SendEmail":{ "name":"SendEmail", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SendEmailRequest"}, "output":{ "shape":"SendEmailResponse", "resultWrapper":"SendEmailResult" }, "errors":[ {"shape":"MessageRejected"}, {"shape":"MailFromDomainNotVerifiedException"}, {"shape":"ConfigurationSetDoesNotExistException"} ], "documentation":"

Composes an email message based on input data, and then immediately queues the message for sending.

There are several important points to know about SendEmail:

  • You can only send email from verified email addresses and domains; otherwise, you will get an \"Email address not verified\" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide.

  • The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.

  • Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.

  • For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide.

" }, "SendRawEmail":{ "name":"SendRawEmail", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SendRawEmailRequest"}, "output":{ "shape":"SendRawEmailResponse", "resultWrapper":"SendRawEmailResult" }, "errors":[ {"shape":"MessageRejected"}, {"shape":"MailFromDomainNotVerifiedException"}, {"shape":"ConfigurationSetDoesNotExistException"} ], "documentation":"

Sends an email message, with header and content specified by the client. The SendRawEmail action is useful for sending multipart MIME emails. The raw text of the message must comply with Internet email standards; otherwise, the message cannot be sent.

There are several important points to know about SendRawEmail:

  • You can only send email from verified email addresses and domains; otherwise, you will get an \"Email address not verified\" error. If your account is still in the Amazon SES sandbox, you must also verify every recipient email address except for the recipients provided by the Amazon SES mailbox simulator. For more information, go to the Amazon SES Developer Guide.

  • The total size of the message cannot exceed 10 MB. This includes any attachments that are part of the message.

  • Amazon SES has a limit on the total number of recipients per message. The combined number of To:, CC: and BCC: email addresses cannot exceed 50. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call Amazon SES repeatedly to send the message to each group.

  • The To:, CC:, and BCC: headers in the raw message can contain a group list. Note that each recipient in a group list counts towards the 50-recipient limit.

  • Amazon SES overrides any Message-ID and Date headers you provide.

  • For every message that you send, the total number of recipients (To:, CC: and BCC:) is counted against your sending quota - the maximum number of emails you can send in a 24-hour period. For information about your sending quota, go to the Amazon SES Developer Guide.

  • If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's \"Source,\" \"From,\" and \"Return-Path\" parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email:

    • X-SES-SOURCE-ARN

    • X-SES-FROM-ARN

    • X-SES-RETURN-PATH-ARN

    Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.

    For the most common sending authorization use case, we recommend that you specify the SourceIdentityArn and do not specify either the FromIdentityArn or ReturnPathIdentityArn. (The same note applies to the corresponding X-headers.) If you only specify the SourceIdentityArn, Amazon SES will simply set the \"From\" address and the \"Return Path\" address to the identity specified in SourceIdentityArn. For more information about sending authorization, see the Amazon SES Developer Guide.

" }, "SetActiveReceiptRuleSet":{ "name":"SetActiveReceiptRuleSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetActiveReceiptRuleSetRequest"}, "output":{ "shape":"SetActiveReceiptRuleSetResponse", "resultWrapper":"SetActiveReceiptRuleSetResult" }, "errors":[ {"shape":"RuleSetDoesNotExistException"} ], "documentation":"

Sets the specified receipt rule set as the active receipt rule set.

To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.

For information about managing receipt rule sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "SetIdentityDkimEnabled":{ "name":"SetIdentityDkimEnabled", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetIdentityDkimEnabledRequest"}, "output":{ "shape":"SetIdentityDkimEnabledResponse", "resultWrapper":"SetIdentityDkimEnabledResult" }, "documentation":"

Enables or disables Easy DKIM signing of email sent from an identity:

  • If Easy DKIM signing is enabled for a domain name identity (e.g., example.com), then Amazon SES will DKIM-sign all email sent by addresses under that domain name (e.g., user@example.com).

  • If Easy DKIM signing is enabled for an email address, then Amazon SES will DKIM-sign all email sent by that email address.

For email addresses (e.g., user@example.com), you can only enable Easy DKIM signing if the corresponding domain (e.g., example.com) has been set up for Easy DKIM using the AWS Console or the VerifyDomainDkim action.

This action is throttled at one request per second.

For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.

" }, "SetIdentityFeedbackForwardingEnabled":{ "name":"SetIdentityFeedbackForwardingEnabled", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetIdentityFeedbackForwardingEnabledRequest"}, "output":{ "shape":"SetIdentityFeedbackForwardingEnabledResponse", "resultWrapper":"SetIdentityFeedbackForwardingEnabledResult" }, "documentation":"

Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.

Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.

This action is throttled at one request per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

" }, "SetIdentityHeadersInNotificationsEnabled":{ "name":"SetIdentityHeadersInNotificationsEnabled", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetIdentityHeadersInNotificationsEnabledRequest"}, "output":{ "shape":"SetIdentityHeadersInNotificationsEnabledResponse", "resultWrapper":"SetIdentityHeadersInNotificationsEnabledResult" }, "documentation":"

Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.

This action is throttled at one request per second.

For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

" }, "SetIdentityMailFromDomain":{ "name":"SetIdentityMailFromDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetIdentityMailFromDomainRequest"}, "output":{ "shape":"SetIdentityMailFromDomainResponse", "resultWrapper":"SetIdentityMailFromDomainResult" }, "documentation":"

Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).

To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "SetIdentityNotificationTopic":{ "name":"SetIdentityNotificationTopic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetIdentityNotificationTopicRequest"}, "output":{ "shape":"SetIdentityNotificationTopicResponse", "resultWrapper":"SetIdentityNotificationTopicResult" }, "documentation":"

Given an identity (an email address or a domain), sets the Amazon Simple Notification Service (Amazon SNS) topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with that identity as the Source.

Unless feedback forwarding is enabled, you must specify Amazon SNS topics for bounce and complaint notifications. For more information, see SetIdentityFeedbackForwardingEnabled.

This action is throttled at one request per second.

For more information about feedback notification, see the Amazon SES Developer Guide.

" }, "SetReceiptRulePosition":{ "name":"SetReceiptRulePosition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetReceiptRulePositionRequest"}, "output":{ "shape":"SetReceiptRulePositionResponse", "resultWrapper":"SetReceiptRulePositionResult" }, "errors":[ {"shape":"RuleSetDoesNotExistException"}, {"shape":"RuleDoesNotExistException"} ], "documentation":"

Sets the position of the specified receipt rule in the receipt rule set.

For information about managing receipt rules, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "UpdateConfigurationSetEventDestination":{ "name":"UpdateConfigurationSetEventDestination", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateConfigurationSetEventDestinationRequest"}, "output":{ "shape":"UpdateConfigurationSetEventDestinationResponse", "resultWrapper":"UpdateConfigurationSetEventDestinationResult" }, "errors":[ {"shape":"ConfigurationSetDoesNotExistException"}, {"shape":"EventDestinationDoesNotExistException"}, {"shape":"InvalidCloudWatchDestinationException"}, {"shape":"InvalidFirehoseDestinationException"} ], "documentation":"

Updates the event destination of a configuration set.

When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose.

Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch or Amazon Kinesis Firehose. For information about using configuration sets, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "UpdateReceiptRule":{ "name":"UpdateReceiptRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateReceiptRuleRequest"}, "output":{ "shape":"UpdateReceiptRuleResponse", "resultWrapper":"UpdateReceiptRuleResult" }, "errors":[ {"shape":"InvalidSnsTopicException"}, {"shape":"InvalidS3ConfigurationException"}, {"shape":"InvalidLambdaFunctionException"}, {"shape":"RuleSetDoesNotExistException"}, {"shape":"RuleDoesNotExistException"}, {"shape":"LimitExceededException"} ], "documentation":"

Updates a receipt rule.

For information about managing receipt rules, see the Amazon SES Developer Guide.

This action is throttled at one request per second.

" }, "VerifyDomainDkim":{ "name":"VerifyDomainDkim", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"VerifyDomainDkimRequest"}, "output":{ "shape":"VerifyDomainDkimResponse", "resultWrapper":"VerifyDomainDkimResult" }, "documentation":"

Returns a set of DKIM tokens for a domain. DKIM tokens are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain.

This action is throttled at one request per second.

To enable or disable Easy DKIM signing for a domain, use the SetIdentityDkimEnabled action.

For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.

" }, "VerifyDomainIdentity":{ "name":"VerifyDomainIdentity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"VerifyDomainIdentityRequest"}, "output":{ "shape":"VerifyDomainIdentityResponse", "resultWrapper":"VerifyDomainIdentityResult" }, "documentation":"

Verifies a domain.

This action is throttled at one request per second.

" }, "VerifyEmailAddress":{ "name":"VerifyEmailAddress", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"VerifyEmailAddressRequest"}, "documentation":"

Verifies an email address. This action causes a confirmation email message to be sent to the specified address.

The VerifyEmailAddress action is deprecated as of the May 15, 2012 release of Domain Verification. The VerifyEmailIdentity action is now preferred.

This action is throttled at one request per second.

" }, "VerifyEmailIdentity":{ "name":"VerifyEmailIdentity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"VerifyEmailIdentityRequest"}, "output":{ "shape":"VerifyEmailIdentityResponse", "resultWrapper":"VerifyEmailIdentityResult" }, "documentation":"

Verifies an email address. This action causes a confirmation email message to be sent to the specified address.

This action is throttled at one request per second.

" } }, "shapes":{ "AddHeaderAction":{ "type":"structure", "required":[ "HeaderName", "HeaderValue" ], "members":{ "HeaderName":{ "shape":"HeaderName", "documentation":"

The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

" }, "HeaderValue":{ "shape":"HeaderValue", "documentation":"

Must be less than 2048 characters, and must not contain newline characters (\"\\r\" or \"\\n\").

" } }, "documentation":"

When included in a receipt rule, this action adds a header to the received email.

For information about adding a header using a receipt rule, see the Amazon SES Developer Guide.

" }, "Address":{"type":"string"}, "AddressList":{ "type":"list", "member":{"shape":"Address"} }, "AlreadyExistsException":{ "type":"structure", "members":{ "Name":{"shape":"RuleOrRuleSetName"} }, "documentation":"

Indicates that a resource could not be created because of a naming conflict.

", "error":{ "code":"AlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "AmazonResourceName":{"type":"string"}, "ArrivalDate":{"type":"timestamp"}, "BehaviorOnMXFailure":{ "type":"string", "enum":[ "UseDefaultValue", "RejectMessage" ] }, "Body":{ "type":"structure", "members":{ "Text":{ "shape":"Content", "documentation":"

The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).

" }, "Html":{ "shape":"Content", "documentation":"

The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.

" } }, "documentation":"

Represents the body of the message. You can specify text, HTML, or both. If you use both, then the message should display correctly in the widest variety of email clients.

" }, "BounceAction":{ "type":"structure", "required":[ "SmtpReplyCode", "Message", "Sender" ], "members":{ "TopicArn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

" }, "SmtpReplyCode":{ "shape":"BounceSmtpReplyCode", "documentation":"

The SMTP reply code, as defined by RFC 5321.

" }, "StatusCode":{ "shape":"BounceStatusCode", "documentation":"

The SMTP enhanced status code, as defined by RFC 3463.

" }, "Message":{ "shape":"BounceMessage", "documentation":"

Human-readable text to include in the bounce message.

" }, "Sender":{ "shape":"Address", "documentation":"

The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.

" } }, "documentation":"

When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

For information about sending a bounce message in response to a received email, see the Amazon SES Developer Guide.

" }, "BounceMessage":{"type":"string"}, "BounceSmtpReplyCode":{"type":"string"}, "BounceStatusCode":{"type":"string"}, "BounceType":{ "type":"string", "enum":[ "DoesNotExist", "MessageTooLarge", "ExceededQuota", "ContentRejected", "Undefined", "TemporaryFailure" ] }, "BouncedRecipientInfo":{ "type":"structure", "required":["Recipient"], "members":{ "Recipient":{ "shape":"Address", "documentation":"

The email address of the recipient of the bounced email.

" }, "RecipientArn":{ "shape":"AmazonResourceName", "documentation":"

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide.

" }, "BounceType":{ "shape":"BounceType", "documentation":"

The reason for the bounce. You must provide either this parameter or RecipientDsnFields.

" }, "RecipientDsnFields":{ "shape":"RecipientDsnFields", "documentation":"

Recipient-related DSN fields, most of which would normally be filled in automatically when provided with a BounceType. You must provide either this parameter or BounceType.

" } }, "documentation":"

Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

" }, "BouncedRecipientInfoList":{ "type":"list", "member":{"shape":"BouncedRecipientInfo"} }, "CannotDeleteException":{ "type":"structure", "members":{ "Name":{"shape":"RuleOrRuleSetName"} }, "documentation":"

Indicates that the delete operation could not be completed.

", "error":{ "code":"CannotDelete", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Charset":{"type":"string"}, "Cidr":{"type":"string"}, "CloneReceiptRuleSetRequest":{ "type":"structure", "required":[ "RuleSetName", "OriginalRuleSetName" ], "members":{ "RuleSetName":{ "shape":"ReceiptRuleSetName", "documentation":"

The name of the rule set to create. The name must:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).

  • Start and end with a letter or number.

  • Contain less than 64 characters.

" }, "OriginalRuleSetName":{ "shape":"ReceiptRuleSetName", "documentation":"

The name of the rule set to clone.

" } }, "documentation":"

Represents a request to create a receipt rule set by cloning an existing one. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "CloneReceiptRuleSetResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "CloudWatchDestination":{ "type":"structure", "required":["DimensionConfigurations"], "members":{ "DimensionConfigurations":{ "shape":"CloudWatchDimensionConfigurations", "documentation":"

A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.

" } }, "documentation":"

Contains information associated with an Amazon CloudWatch event destination to which email sending events are published.

Event destinations, such as Amazon CloudWatch, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

" }, "CloudWatchDimensionConfiguration":{ "type":"structure", "required":[ "DimensionName", "DimensionValueSource", "DefaultDimensionValue" ], "members":{ "DimensionName":{ "shape":"DimensionName", "documentation":"

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Contain less than 256 characters.

" }, "DimensionValueSource":{ "shape":"DimensionValueSource", "documentation":"

The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon SES to use your own email headers, choose emailHeader.

" }, "DefaultDimensionValue":{ "shape":"DefaultDimensionValue", "documentation":"

The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Contain less than 256 characters.

" } }, "documentation":"

Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.

For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide.

" }, "CloudWatchDimensionConfigurations":{ "type":"list", "member":{"shape":"CloudWatchDimensionConfiguration"} }, "ConfigurationSet":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"ConfigurationSetName", "documentation":"

The name of the configuration set. The name must:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Contain less than 64 characters.

" } }, "documentation":"

The name of the configuration set.

Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

" }, "ConfigurationSetAlreadyExistsException":{ "type":"structure", "members":{ "ConfigurationSetName":{"shape":"ConfigurationSetName"} }, "documentation":"

Indicates that the configuration set could not be created because of a naming conflict.

", "error":{ "code":"ConfigurationSetAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ConfigurationSetAttribute":{ "type":"string", "enum":["eventDestinations"] }, "ConfigurationSetAttributeList":{ "type":"list", "member":{"shape":"ConfigurationSetAttribute"} }, "ConfigurationSetDoesNotExistException":{ "type":"structure", "members":{ "ConfigurationSetName":{"shape":"ConfigurationSetName"} }, "documentation":"

Indicates that the configuration set does not exist.

", "error":{ "code":"ConfigurationSetDoesNotExist", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ConfigurationSetName":{"type":"string"}, "ConfigurationSets":{ "type":"list", "member":{"shape":"ConfigurationSet"} }, "Content":{ "type":"structure", "required":["Data"], "members":{ "Data":{ "shape":"MessageData", "documentation":"

The textual data of the content.

" }, "Charset":{ "shape":"Charset", "documentation":"

The character set of the content.

" } }, "documentation":"

Represents textual data, plus an optional character set specification.

By default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol. If the text must contain any other characters, then you must also specify a character set. Examples include UTF-8, ISO-8859-1, and Shift_JIS.

" }, "Counter":{"type":"long"}, "CreateConfigurationSetEventDestinationRequest":{ "type":"structure", "required":[ "ConfigurationSetName", "EventDestination" ], "members":{ "ConfigurationSetName":{ "shape":"ConfigurationSetName", "documentation":"

The name of the configuration set to which to apply the event destination.

" }, "EventDestination":{ "shape":"EventDestination", "documentation":"

An object that describes the AWS service to which Amazon SES will publish the email sending events associated with the specified configuration set.

" } }, "documentation":"

Represents a request to create a configuration set event destination. A configuration set event destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an AWS service in which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

" }, "CreateConfigurationSetEventDestinationResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "CreateConfigurationSetRequest":{ "type":"structure", "required":["ConfigurationSet"], "members":{ "ConfigurationSet":{ "shape":"ConfigurationSet", "documentation":"

A data structure that contains the name of the configuration set.

" } }, "documentation":"

Represents a request to create a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

" }, "CreateConfigurationSetResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "CreateReceiptFilterRequest":{ "type":"structure", "required":["Filter"], "members":{ "Filter":{ "shape":"ReceiptFilter", "documentation":"

A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.

" } }, "documentation":"

Represents a request to create a new IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "CreateReceiptFilterResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "CreateReceiptRuleRequest":{ "type":"structure", "required":[ "RuleSetName", "Rule" ], "members":{ "RuleSetName":{ "shape":"ReceiptRuleSetName", "documentation":"

The name of the rule set to which to add the rule.

" }, "After":{ "shape":"ReceiptRuleName", "documentation":"

The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list.

" }, "Rule":{ "shape":"ReceiptRule", "documentation":"

A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.

" } }, "documentation":"

Represents a request to create a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "CreateReceiptRuleResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "CreateReceiptRuleSetRequest":{ "type":"structure", "required":["RuleSetName"], "members":{ "RuleSetName":{ "shape":"ReceiptRuleSetName", "documentation":"

The name of the rule set to create. The name must:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).

  • Start and end with a letter or number.

  • Contain less than 64 characters.

" } }, "documentation":"

Represents a request to create an empty receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "CreateReceiptRuleSetResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "CustomMailFromStatus":{ "type":"string", "enum":[ "Pending", "Success", "Failed", "TemporaryFailure" ] }, "DefaultDimensionValue":{"type":"string"}, "DeleteConfigurationSetEventDestinationRequest":{ "type":"structure", "required":[ "ConfigurationSetName", "EventDestinationName" ], "members":{ "ConfigurationSetName":{ "shape":"ConfigurationSetName", "documentation":"

The name of the configuration set from which to delete the event destination.

" }, "EventDestinationName":{ "shape":"EventDestinationName", "documentation":"

The name of the event destination to delete.

" } }, "documentation":"

Represents a request to delete a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

" }, "DeleteConfigurationSetEventDestinationResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "DeleteConfigurationSetRequest":{ "type":"structure", "required":["ConfigurationSetName"], "members":{ "ConfigurationSetName":{ "shape":"ConfigurationSetName", "documentation":"

The name of the configuration set to delete.

" } }, "documentation":"

Represents a request to delete a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

" }, "DeleteConfigurationSetResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "DeleteIdentityPolicyRequest":{ "type":"structure", "required":[ "Identity", "PolicyName" ], "members":{ "Identity":{ "shape":"Identity", "documentation":"

The identity that is associated with the policy that you want to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

" }, "PolicyName":{ "shape":"PolicyName", "documentation":"

The name of the policy to be deleted.

" } }, "documentation":"

Represents a request to delete a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.

" }, "DeleteIdentityPolicyResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "DeleteIdentityRequest":{ "type":"structure", "required":["Identity"], "members":{ "Identity":{ "shape":"Identity", "documentation":"

The identity to be removed from the list of identities for the AWS Account.

" } }, "documentation":"

Represents a request to delete one of your Amazon SES identities (an email address or domain).

" }, "DeleteIdentityResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "DeleteReceiptFilterRequest":{ "type":"structure", "required":["FilterName"], "members":{ "FilterName":{ "shape":"ReceiptFilterName", "documentation":"

The name of the IP address filter to delete.

" } }, "documentation":"

Represents a request to delete an IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "DeleteReceiptFilterResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "DeleteReceiptRuleRequest":{ "type":"structure", "required":[ "RuleSetName", "RuleName" ], "members":{ "RuleSetName":{ "shape":"ReceiptRuleSetName", "documentation":"

The name of the receipt rule set that contains the receipt rule to delete.

" }, "RuleName":{ "shape":"ReceiptRuleName", "documentation":"

The name of the receipt rule to delete.

" } }, "documentation":"

Represents a request to delete a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "DeleteReceiptRuleResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "DeleteReceiptRuleSetRequest":{ "type":"structure", "required":["RuleSetName"], "members":{ "RuleSetName":{ "shape":"ReceiptRuleSetName", "documentation":"

The name of the receipt rule set to delete.

" } }, "documentation":"

Represents a request to delete a receipt rule set and all of the receipt rules it contains. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "DeleteReceiptRuleSetResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "DeleteVerifiedEmailAddressRequest":{ "type":"structure", "required":["EmailAddress"], "members":{ "EmailAddress":{ "shape":"Address", "documentation":"

An email address to be removed from the list of verified addresses.

" } }, "documentation":"

Represents a request to delete an email address from the list of email addresses you have attempted to verify under your AWS account.

" }, "DescribeActiveReceiptRuleSetRequest":{ "type":"structure", "members":{ }, "documentation":"

Represents a request to return the metadata and receipt rules for the receipt rule set that is currently active. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "DescribeActiveReceiptRuleSetResponse":{ "type":"structure", "members":{ "Metadata":{ "shape":"ReceiptRuleSetMetadata", "documentation":"

The metadata for the currently active receipt rule set. The metadata consists of the rule set name and a timestamp of when the rule set was created.

" }, "Rules":{ "shape":"ReceiptRulesList", "documentation":"

The receipt rules that belong to the active rule set.

" } }, "documentation":"

Represents the metadata and receipt rules for the receipt rule set that is currently active.

" }, "DescribeConfigurationSetRequest":{ "type":"structure", "required":["ConfigurationSetName"], "members":{ "ConfigurationSetName":{ "shape":"ConfigurationSetName", "documentation":"

The name of the configuration set to describe.

" }, "ConfigurationSetAttributeNames":{ "shape":"ConfigurationSetAttributeList", "documentation":"

A list of configuration set attributes to return.

" } }, "documentation":"

Represents a request to return the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

" }, "DescribeConfigurationSetResponse":{ "type":"structure", "members":{ "ConfigurationSet":{ "shape":"ConfigurationSet", "documentation":"

The configuration set object associated with the specified configuration set.

" }, "EventDestinations":{ "shape":"EventDestinations", "documentation":"

A list of event destinations associated with the configuration set.

" } }, "documentation":"

Represents the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

" }, "DescribeReceiptRuleRequest":{ "type":"structure", "required":[ "RuleSetName", "RuleName" ], "members":{ "RuleSetName":{ "shape":"ReceiptRuleSetName", "documentation":"

The name of the receipt rule set to which the receipt rule belongs.

" }, "RuleName":{ "shape":"ReceiptRuleName", "documentation":"

The name of the receipt rule.

" } }, "documentation":"

Represents a request to return the details of a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "DescribeReceiptRuleResponse":{ "type":"structure", "members":{ "Rule":{ "shape":"ReceiptRule", "documentation":"

A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.

" } }, "documentation":"

Represents the details of a receipt rule.

" }, "DescribeReceiptRuleSetRequest":{ "type":"structure", "required":["RuleSetName"], "members":{ "RuleSetName":{ "shape":"ReceiptRuleSetName", "documentation":"

The name of the receipt rule set to describe.

" } }, "documentation":"

Represents a request to return the details of a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "DescribeReceiptRuleSetResponse":{ "type":"structure", "members":{ "Metadata":{ "shape":"ReceiptRuleSetMetadata", "documentation":"

The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created.

" }, "Rules":{ "shape":"ReceiptRulesList", "documentation":"

A list of the receipt rules that belong to the specified receipt rule set.

" } }, "documentation":"

Represents the details of the specified receipt rule set.

" }, "Destination":{ "type":"structure", "members":{ "ToAddresses":{ "shape":"AddressList", "documentation":"

The To: field(s) of the message.

" }, "CcAddresses":{ "shape":"AddressList", "documentation":"

The CC: field(s) of the message.

" }, "BccAddresses":{ "shape":"AddressList", "documentation":"

The BCC: field(s) of the message.

" } }, "documentation":"

Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.

" }, "DiagnosticCode":{"type":"string"}, "DimensionName":{"type":"string"}, "DimensionValueSource":{ "type":"string", "enum":[ "messageTag", "emailHeader" ] }, "DkimAttributes":{ "type":"map", "key":{"shape":"Identity"}, "value":{"shape":"IdentityDkimAttributes"} }, "Domain":{"type":"string"}, "DsnAction":{ "type":"string", "enum":[ "failed", "delayed", "delivered", "relayed", "expanded" ] }, "DsnStatus":{"type":"string"}, "Enabled":{"type":"boolean"}, "EventDestination":{ "type":"structure", "required":[ "Name", "MatchingEventTypes" ], "members":{ "Name":{ "shape":"EventDestinationName", "documentation":"

The name of the event destination. The name must:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Contain less than 64 characters.

" }, "Enabled":{ "shape":"Enabled", "documentation":"

Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false.

" }, "MatchingEventTypes":{ "shape":"EventTypes", "documentation":"

The type of email sending events to publish to the event destination.

" }, "KinesisFirehoseDestination":{ "shape":"KinesisFirehoseDestination", "documentation":"

An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

" }, "CloudWatchDestination":{ "shape":"CloudWatchDestination", "documentation":"

An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.

" } }, "documentation":"

Contains information about the event destination to which the specified email sending events are published.

When you create or update an event destination, you must provide one, and only one, destination. The destination can be either Amazon CloudWatch or Amazon Kinesis Firehose.

Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch or Amazon Kinesis Firehose. For information about using configuration sets, see the Amazon SES Developer Guide.

" }, "EventDestinationAlreadyExistsException":{ "type":"structure", "members":{ "ConfigurationSetName":{"shape":"ConfigurationSetName"}, "EventDestinationName":{"shape":"EventDestinationName"} }, "documentation":"

Indicates that the event destination could not be created because of a naming conflict.

", "error":{ "code":"EventDestinationAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "EventDestinationDoesNotExistException":{ "type":"structure", "members":{ "ConfigurationSetName":{"shape":"ConfigurationSetName"}, "EventDestinationName":{"shape":"EventDestinationName"} }, "documentation":"

Indicates that the event destination does not exist.

", "error":{ "code":"EventDestinationDoesNotExist", "httpStatusCode":400, "senderFault":true }, "exception":true }, "EventDestinationName":{"type":"string"}, "EventDestinations":{ "type":"list", "member":{"shape":"EventDestination"} }, "EventType":{ "type":"string", "enum":[ "send", "reject", "bounce", "complaint", "delivery" ] }, "EventTypes":{ "type":"list", "member":{"shape":"EventType"} }, "Explanation":{"type":"string"}, "ExtensionField":{ "type":"structure", "required":[ "Name", "Value" ], "members":{ "Name":{ "shape":"ExtensionFieldName", "documentation":"

The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

" }, "Value":{ "shape":"ExtensionFieldValue", "documentation":"

The value of the header to add. Must be less than 2048 characters, and must not contain newline characters (\"\\r\" or \"\\n\").

" } }, "documentation":"

Additional X-headers to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

" }, "ExtensionFieldList":{ "type":"list", "member":{"shape":"ExtensionField"} }, "ExtensionFieldName":{"type":"string"}, "ExtensionFieldValue":{"type":"string"}, "GetIdentityDkimAttributesRequest":{ "type":"structure", "required":["Identities"], "members":{ "Identities":{ "shape":"IdentityList", "documentation":"

A list of one or more verified identities - email addresses, domains, or both.

" } }, "documentation":"

Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this request also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published. For more information about Easy DKIM, see the Amazon SES Developer Guide.

" }, "GetIdentityDkimAttributesResponse":{ "type":"structure", "required":["DkimAttributes"], "members":{ "DkimAttributes":{ "shape":"DkimAttributes", "documentation":"

The DKIM attributes for an email address or a domain.

" } }, "documentation":"

Represents the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this response also contains the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published.

" }, "GetIdentityMailFromDomainAttributesRequest":{ "type":"structure", "required":["Identities"], "members":{ "Identities":{ "shape":"IdentityList", "documentation":"

A list of one or more identities.

" } }, "documentation":"

Represents a request to return the Amazon SES custom MAIL FROM attributes for a list of identities. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.

" }, "GetIdentityMailFromDomainAttributesResponse":{ "type":"structure", "required":["MailFromDomainAttributes"], "members":{ "MailFromDomainAttributes":{ "shape":"MailFromDomainAttributes", "documentation":"

A map of identities to custom MAIL FROM attributes.

" } }, "documentation":"

Represents the custom MAIL FROM attributes for a list of identities.

" }, "GetIdentityNotificationAttributesRequest":{ "type":"structure", "required":["Identities"], "members":{ "Identities":{ "shape":"IdentityList", "documentation":"

A list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

" } }, "documentation":"

Represents a request to return the notification attributes for a list of identities you verified with Amazon SES. For information about Amazon SES notifications, see the Amazon SES Developer Guide.

" }, "GetIdentityNotificationAttributesResponse":{ "type":"structure", "required":["NotificationAttributes"], "members":{ "NotificationAttributes":{ "shape":"NotificationAttributes", "documentation":"

A map of Identity to IdentityNotificationAttributes.

" } }, "documentation":"

Represents the notification attributes for a list of identities.

" }, "GetIdentityPoliciesRequest":{ "type":"structure", "required":[ "Identity", "PolicyNames" ], "members":{ "Identity":{ "shape":"Identity", "documentation":"

The identity for which the policies will be retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

" }, "PolicyNames":{ "shape":"PolicyNameList", "documentation":"

A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies.

" } }, "documentation":"

Represents a request to return the requested sending authorization policies for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.

" }, "GetIdentityPoliciesResponse":{ "type":"structure", "required":["Policies"], "members":{ "Policies":{ "shape":"PolicyMap", "documentation":"

A map of policy names to policies.

" } }, "documentation":"

Represents the requested sending authorization policies.

" }, "GetIdentityVerificationAttributesRequest":{ "type":"structure", "required":["Identities"], "members":{ "Identities":{ "shape":"IdentityList", "documentation":"

A list of identities.

" } }, "documentation":"

Represents a request to return the Amazon SES verification status of a list of identities. For domain identities, this request also returns the verification token. For information about verifying identities with Amazon SES, see the Amazon SES Developer Guide.

" }, "GetIdentityVerificationAttributesResponse":{ "type":"structure", "required":["VerificationAttributes"], "members":{ "VerificationAttributes":{ "shape":"VerificationAttributes", "documentation":"

A map of Identities to IdentityVerificationAttributes objects.

" } }, "documentation":"

The Amazon SES verification status of a list of identities. For domain identities, this response also contains the verification token.

" }, "GetSendQuotaResponse":{ "type":"structure", "members":{ "Max24HourSend":{ "shape":"Max24HourSend", "documentation":"

The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota.

" }, "MaxSendRate":{ "shape":"MaxSendRate", "documentation":"

The maximum number of emails that Amazon SES can accept from the user's account per second.

The rate at which Amazon SES accepts the user's messages might be less than the maximum send rate.

" }, "SentLast24Hours":{ "shape":"SentLast24Hours", "documentation":"

The number of emails sent during the previous 24 hours.

" } }, "documentation":"

Represents your Amazon SES daily sending quota, maximum send rate, and the number of emails you have sent in the last 24 hours.

" }, "GetSendStatisticsResponse":{ "type":"structure", "members":{ "SendDataPoints":{ "shape":"SendDataPointList", "documentation":"

A list of data points, each of which represents 15 minutes of activity.

" } }, "documentation":"

Represents a list of data points. This list contains aggregated data from the previous two weeks of your sending activity with Amazon SES.

" }, "HeaderName":{"type":"string"}, "HeaderValue":{"type":"string"}, "Identity":{"type":"string"}, "IdentityDkimAttributes":{ "type":"structure", "required":[ "DkimEnabled", "DkimVerificationStatus" ], "members":{ "DkimEnabled":{ "shape":"Enabled", "documentation":"

True if DKIM signing is enabled for email sent from the identity; false otherwise. The default value is true.

" }, "DkimVerificationStatus":{ "shape":"VerificationStatus", "documentation":"

Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)

" }, "DkimTokens":{ "shape":"VerificationTokenList", "documentation":"

A set of character strings that represent the domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)

For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.

" } }, "documentation":"

Represents the DKIM attributes of a verified email address or a domain.

" }, "IdentityList":{ "type":"list", "member":{"shape":"Identity"} }, "IdentityMailFromDomainAttributes":{ "type":"structure", "required":[ "MailFromDomain", "MailFromDomainStatus", "BehaviorOnMXFailure" ], "members":{ "MailFromDomain":{ "shape":"MailFromDomainName", "documentation":"

The custom MAIL FROM domain that the identity is configured to use.

" }, "MailFromDomainStatus":{ "shape":"CustomMailFromStatus", "documentation":"

The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.

" }, "BehaviorOnMXFailure":{ "shape":"BehaviorOnMXFailure", "documentation":"

The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

" } }, "documentation":"

Represents the custom MAIL FROM domain attributes of a verified identity (email address or domain).

" }, "IdentityNotificationAttributes":{ "type":"structure", "required":[ "BounceTopic", "ComplaintTopic", "DeliveryTopic", "ForwardingEnabled" ], "members":{ "BounceTopic":{ "shape":"NotificationTopic", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.

" }, "ComplaintTopic":{ "shape":"NotificationTopic", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.

" }, "DeliveryTopic":{ "shape":"NotificationTopic", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.

" }, "ForwardingEnabled":{ "shape":"Enabled", "documentation":"

Describes whether Amazon SES will forward bounce and complaint notifications as email. true indicates that Amazon SES will forward bounce and complaint notifications as email, while false indicates that bounce and complaint notifications will be published only to the specified bounce and complaint Amazon SNS topics.

" }, "HeadersInBounceNotificationsEnabled":{ "shape":"Enabled", "documentation":"

Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Bounce. A value of true specifies that Amazon SES will include headers in bounce notifications, and a value of false specifies that Amazon SES will not include headers in bounce notifications.

" }, "HeadersInComplaintNotificationsEnabled":{ "shape":"Enabled", "documentation":"

Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Complaint. A value of true specifies that Amazon SES will include headers in complaint notifications, and a value of false specifies that Amazon SES will not include headers in complaint notifications.

" }, "HeadersInDeliveryNotificationsEnabled":{ "shape":"Enabled", "documentation":"

Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Delivery. A value of true specifies that Amazon SES will include headers in delivery notifications, and a value of false specifies that Amazon SES will not include headers in delivery notifications.

" } }, "documentation":"

Represents the notification attributes of an identity, including whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications, and whether feedback forwarding is enabled for bounce and complaint notifications.

" }, "IdentityType":{ "type":"string", "enum":[ "EmailAddress", "Domain" ] }, "IdentityVerificationAttributes":{ "type":"structure", "required":["VerificationStatus"], "members":{ "VerificationStatus":{ "shape":"VerificationStatus", "documentation":"

The verification status of the identity: \"Pending\", \"Success\", \"Failed\", or \"TemporaryFailure\".

" }, "VerificationToken":{ "shape":"VerificationToken", "documentation":"

The verification token for a domain identity. Null for email address identities.

" } }, "documentation":"

Represents the verification attributes of a single identity.

" }, "InvalidCloudWatchDestinationException":{ "type":"structure", "members":{ "ConfigurationSetName":{"shape":"ConfigurationSetName"}, "EventDestinationName":{"shape":"EventDestinationName"} }, "documentation":"

Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.

", "error":{ "code":"InvalidCloudWatchDestination", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidConfigurationSetException":{ "type":"structure", "members":{ }, "documentation":"

Indicates that the configuration set is invalid. See the error message for details.

", "error":{ "code":"InvalidConfigurationSet", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidFirehoseDestinationException":{ "type":"structure", "members":{ "ConfigurationSetName":{"shape":"ConfigurationSetName"}, "EventDestinationName":{"shape":"EventDestinationName"} }, "documentation":"

Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.

", "error":{ "code":"InvalidFirehoseDestination", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidLambdaFunctionException":{ "type":"structure", "members":{ "FunctionArn":{"shape":"AmazonResourceName"} }, "documentation":"

Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

", "error":{ "code":"InvalidLambdaFunction", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidPolicyException":{ "type":"structure", "members":{ }, "documentation":"

Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.

", "error":{ "code":"InvalidPolicy", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidS3ConfigurationException":{ "type":"structure", "members":{ "Bucket":{"shape":"S3BucketName"} }, "documentation":"

Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

", "error":{ "code":"InvalidS3Configuration", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidSnsTopicException":{ "type":"structure", "members":{ "Topic":{"shape":"AmazonResourceName"} }, "documentation":"

Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

", "error":{ "code":"InvalidSnsTopic", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvocationType":{ "type":"string", "enum":[ "Event", "RequestResponse" ] }, "KinesisFirehoseDestination":{ "type":"structure", "required":[ "IAMRoleARN", "DeliveryStreamARN" ], "members":{ "IAMRoleARN":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.

" }, "DeliveryStreamARN":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the Amazon Kinesis Firehose stream to which to publish email sending events.

" } }, "documentation":"

Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

Event destinations, such as Amazon Kinesis Firehose, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

" }, "LambdaAction":{ "type":"structure", "required":["FunctionArn"], "members":{ "TopicArn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

" }, "FunctionArn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.

" }, "InvocationType":{ "shape":"InvocationType", "documentation":"

The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.

There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.

" } }, "documentation":"

When included in a receipt rule, this action calls an AWS Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

To enable Amazon SES to call your AWS Lambda function or to publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide.

For information about using AWS Lambda actions in receipt rules, see the Amazon SES Developer Guide.

" }, "LastAttemptDate":{"type":"timestamp"}, "LimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

", "error":{ "code":"LimitExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ListConfigurationSetsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

A token returned from a previous call to ListConfigurationSets to indicate the position of the configuration set in the configuration set list.

" }, "MaxItems":{ "shape":"MaxItems", "documentation":"

The number of configuration sets to return.

" } }, "documentation":"

Represents a request to list the configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

" }, "ListConfigurationSetsResponse":{ "type":"structure", "members":{ "ConfigurationSets":{ "shape":"ConfigurationSets", "documentation":"

A list of configuration sets.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

A token indicating that there are additional configuration sets available to be listed. Pass this token to successive calls of ListConfigurationSets.

" } }, "documentation":"

A list of configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

" }, "ListIdentitiesRequest":{ "type":"structure", "members":{ "IdentityType":{ "shape":"IdentityType", "documentation":"

The type of the identities to list. Possible values are \"EmailAddress\" and \"Domain\". If this parameter is omitted, then all identities will be listed.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use for pagination.

" }, "MaxItems":{ "shape":"MaxItems", "documentation":"

The maximum number of identities per page. Possible values are 1-1000 inclusive.

" } }, "documentation":"

Represents a request to return a list of all identities (email addresses and domains) that you have attempted to verify under your AWS account, regardless of verification status.

" }, "ListIdentitiesResponse":{ "type":"structure", "required":["Identities"], "members":{ "Identities":{ "shape":"IdentityList", "documentation":"

A list of identities.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token used for pagination.

" } }, "documentation":"

A list of all identities that you have attempted to verify under your AWS account, regardless of verification status.

" }, "ListIdentityPoliciesRequest":{ "type":"structure", "required":["Identity"], "members":{ "Identity":{ "shape":"Identity", "documentation":"

The identity that is associated with the policy for which the policies will be listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

" } }, "documentation":"

Represents a request to return a list of sending authorization policies that are attached to an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.

" }, "ListIdentityPoliciesResponse":{ "type":"structure", "required":["PolicyNames"], "members":{ "PolicyNames":{ "shape":"PolicyNameList", "documentation":"

A list of names of policies that apply to the specified identity.

" } }, "documentation":"

A list of names of sending authorization policies that apply to an identity.

" }, "ListReceiptFiltersRequest":{ "type":"structure", "members":{ }, "documentation":"

Represents a request to list the IP address filters that exist under your AWS account. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "ListReceiptFiltersResponse":{ "type":"structure", "members":{ "Filters":{ "shape":"ReceiptFilterList", "documentation":"

A list of IP address filter data structures, which each consist of a name, an IP address range, and whether to allow or block mail from it.

" } }, "documentation":"

A list of IP address filters that exist under your AWS account.

" }, "ListReceiptRuleSetsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

A token returned from a previous call to ListReceiptRuleSets to indicate the position in the receipt rule set list.

" } }, "documentation":"

Represents a request to list the receipt rule sets that exist under your AWS account. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "ListReceiptRuleSetsResponse":{ "type":"structure", "members":{ "RuleSets":{ "shape":"ReceiptRuleSetsLists", "documentation":"

The metadata for the currently active receipt rule set. The metadata consists of the rule set name and the timestamp of when the rule set was created.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

A token indicating that there are additional receipt rule sets available to be listed. Pass this token to successive calls of ListReceiptRuleSets to retrieve up to 100 receipt rule sets at a time.

" } }, "documentation":"

A list of receipt rule sets that exist under your AWS account.

" }, "ListVerifiedEmailAddressesResponse":{ "type":"structure", "members":{ "VerifiedEmailAddresses":{ "shape":"AddressList", "documentation":"

A list of email addresses that have been verified.

" } }, "documentation":"

A list of email addresses that you have verified with Amazon SES under your AWS account.

" }, "MailFromDomainAttributes":{ "type":"map", "key":{"shape":"Identity"}, "value":{"shape":"IdentityMailFromDomainAttributes"} }, "MailFromDomainName":{"type":"string"}, "MailFromDomainNotVerifiedException":{ "type":"structure", "members":{ }, "documentation":"

Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.

", "error":{ "code":"MailFromDomainNotVerifiedException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Max24HourSend":{"type":"double"}, "MaxItems":{"type":"integer"}, "MaxSendRate":{"type":"double"}, "Message":{ "type":"structure", "required":[ "Subject", "Body" ], "members":{ "Subject":{ "shape":"Content", "documentation":"

The subject of the message: A short summary of the content, which will appear in the recipient's inbox.

" }, "Body":{ "shape":"Body", "documentation":"

The message body.

" } }, "documentation":"

Represents the message to be sent, composed of a subject and a body.

" }, "MessageData":{"type":"string"}, "MessageDsn":{ "type":"structure", "required":["ReportingMta"], "members":{ "ReportingMta":{ "shape":"ReportingMta", "documentation":"

The reporting MTA that attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). The default value is dns; inbound-smtp.[region].amazonaws.com.

" }, "ArrivalDate":{ "shape":"ArrivalDate", "documentation":"

When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.

" }, "ExtensionFields":{ "shape":"ExtensionFieldList", "documentation":"

Additional X-headers to include in the DSN.

" } }, "documentation":"

Message-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

" }, "MessageId":{"type":"string"}, "MessageRejected":{ "type":"structure", "members":{ }, "documentation":"

Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.

", "error":{ "code":"MessageRejected", "httpStatusCode":400, "senderFault":true }, "exception":true }, "MessageTag":{ "type":"structure", "required":[ "Name", "Value" ], "members":{ "Name":{ "shape":"MessageTagName", "documentation":"

The name of the tag. The name must:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Contain less than 256 characters.

" }, "Value":{ "shape":"MessageTagValue", "documentation":"

The value of the tag. The value must:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Contain less than 256 characters.

" } }, "documentation":"

Contains the name and value of a tag that you can provide to SendEmail or SendRawEmail to apply to an email.

Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

" }, "MessageTagList":{ "type":"list", "member":{"shape":"MessageTag"} }, "MessageTagName":{"type":"string"}, "MessageTagValue":{"type":"string"}, "NextToken":{"type":"string"}, "NotificationAttributes":{ "type":"map", "key":{"shape":"Identity"}, "value":{"shape":"IdentityNotificationAttributes"} }, "NotificationTopic":{"type":"string"}, "NotificationType":{ "type":"string", "enum":[ "Bounce", "Complaint", "Delivery" ] }, "Policy":{ "type":"string", "min":1 }, "PolicyMap":{ "type":"map", "key":{"shape":"PolicyName"}, "value":{"shape":"Policy"} }, "PolicyName":{ "type":"string", "max":64, "min":1 }, "PolicyNameList":{ "type":"list", "member":{"shape":"PolicyName"} }, "PutIdentityPolicyRequest":{ "type":"structure", "required":[ "Identity", "PolicyName", "Policy" ], "members":{ "Identity":{ "shape":"Identity", "documentation":"

The identity to which the policy will apply. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

To successfully call this API, you must own the identity.

" }, "PolicyName":{ "shape":"PolicyName", "documentation":"

The name of the policy.

The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

" }, "Policy":{ "shape":"Policy", "documentation":"

The text of the policy in JSON format. The policy cannot exceed 4 KB.

For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.

" } }, "documentation":"

Represents a request to add or update a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.

" }, "PutIdentityPolicyResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "RawMessage":{ "type":"structure", "required":["Data"], "members":{ "Data":{ "shape":"RawMessageData", "documentation":"

The raw data of the message. The client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, MIME encoding, and base64 encoding.

The To:, CC:, and BCC: headers in the raw message can contain a group list.

If you are using SendRawEmail with sending authorization, you can include X-headers in the raw message to specify the \"Source,\" \"From,\" and \"Return-Path\" addresses. For more information, see the documentation for SendRawEmail.

Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.

For more information, go to the Amazon SES Developer Guide.

" } }, "documentation":"

Represents the raw data of the message.

" }, "RawMessageData":{"type":"blob"}, "ReceiptAction":{ "type":"structure", "members":{ "S3Action":{ "shape":"S3Action", "documentation":"

Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.

" }, "BounceAction":{ "shape":"BounceAction", "documentation":"

Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

" }, "WorkmailAction":{ "shape":"WorkmailAction", "documentation":"

Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.

" }, "LambdaAction":{ "shape":"LambdaAction", "documentation":"

Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.

" }, "StopAction":{ "shape":"StopAction", "documentation":"

Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.

" }, "AddHeaderAction":{ "shape":"AddHeaderAction", "documentation":"

Adds a header to the received email.

" }, "SNSAction":{ "shape":"SNSAction", "documentation":"

Publishes the email content within a notification to Amazon SNS.

" } }, "documentation":"

An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

" }, "ReceiptActionsList":{ "type":"list", "member":{"shape":"ReceiptAction"} }, "ReceiptFilter":{ "type":"structure", "required":[ "Name", "IpFilter" ], "members":{ "Name":{ "shape":"ReceiptFilterName", "documentation":"

The name of the IP address filter. The name must:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).

  • Start and end with a letter or number.

  • Contain less than 64 characters.

" }, "IpFilter":{ "shape":"ReceiptIpFilter", "documentation":"

A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.

" } }, "documentation":"

A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

" }, "ReceiptFilterList":{ "type":"list", "member":{"shape":"ReceiptFilter"} }, "ReceiptFilterName":{"type":"string"}, "ReceiptFilterPolicy":{ "type":"string", "enum":[ "Block", "Allow" ] }, "ReceiptIpFilter":{ "type":"structure", "required":[ "Policy", "Cidr" ], "members":{ "Policy":{ "shape":"ReceiptFilterPolicy", "documentation":"

Indicates whether to block or allow incoming mail from the specified IP addresses.

" }, "Cidr":{ "shape":"Cidr", "documentation":"

A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317.

" } }, "documentation":"

A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

" }, "ReceiptRule":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"ReceiptRuleName", "documentation":"

The name of the receipt rule. The name must:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).

  • Start and end with a letter or number.

  • Contain less than 64 characters.

" }, "Enabled":{ "shape":"Enabled", "documentation":"

If true, the receipt rule is active. The default value is false.

" }, "TlsPolicy":{ "shape":"TlsPolicy", "documentation":"

Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

" }, "Recipients":{ "shape":"RecipientsList", "documentation":"

The recipient domains and email addresses to which the receipt rule applies. If this field is not specified, this rule will match all recipients under all verified domains.

" }, "Actions":{ "shape":"ReceiptActionsList", "documentation":"

An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

" }, "ScanEnabled":{ "shape":"Enabled", "documentation":"

If true, then messages to which this receipt rule applies are scanned for spam and viruses. The default value is false.

" } }, "documentation":"

Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.

Each receipt rule defines a set of email addresses or domains to which it applies. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.

For information about setting up receipt rules, see the Amazon SES Developer Guide.

" }, "ReceiptRuleName":{"type":"string"}, "ReceiptRuleNamesList":{ "type":"list", "member":{"shape":"ReceiptRuleName"} }, "ReceiptRuleSetMetadata":{ "type":"structure", "members":{ "Name":{ "shape":"ReceiptRuleSetName", "documentation":"

The name of the receipt rule set. The name must:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).

  • Start and end with a letter or number.

  • Contain less than 64 characters.

" }, "CreatedTimestamp":{ "shape":"Timestamp", "documentation":"

The date and time the receipt rule set was created.

" } }, "documentation":"

Information about a receipt rule set.

A receipt rule set is a collection of rules that specify what Amazon SES should do with mail it receives on behalf of your account's verified domains.

For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

" }, "ReceiptRuleSetName":{"type":"string"}, "ReceiptRuleSetsLists":{ "type":"list", "member":{"shape":"ReceiptRuleSetMetadata"} }, "ReceiptRulesList":{ "type":"list", "member":{"shape":"ReceiptRule"} }, "Recipient":{"type":"string"}, "RecipientDsnFields":{ "type":"structure", "required":[ "Action", "Status" ], "members":{ "FinalRecipient":{ "shape":"Address", "documentation":"

The email address to which the message was ultimately delivered. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

" }, "Action":{ "shape":"DsnAction", "documentation":"

The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.

" }, "RemoteMta":{ "shape":"RemoteMta", "documentation":"

The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

" }, "Status":{ "shape":"DsnStatus", "documentation":"

The status code that indicates what went wrong. This is required by RFC 3464.

" }, "DiagnosticCode":{ "shape":"DiagnosticCode", "documentation":"

An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

" }, "LastAttemptDate":{ "shape":"LastAttemptDate", "documentation":"

The time the final delivery attempt was made, in RFC 822 date-time format.

" }, "ExtensionFields":{ "shape":"ExtensionFieldList", "documentation":"

Additional X-headers to include in the DSN.

" } }, "documentation":"

Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

" }, "RecipientsList":{ "type":"list", "member":{"shape":"Recipient"} }, "RemoteMta":{"type":"string"}, "ReorderReceiptRuleSetRequest":{ "type":"structure", "required":[ "RuleSetName", "RuleNames" ], "members":{ "RuleSetName":{ "shape":"ReceiptRuleSetName", "documentation":"

The name of the receipt rule set to reorder.

" }, "RuleNames":{ "shape":"ReceiptRuleNamesList", "documentation":"

A list of the specified receipt rule set's receipt rules in the order that you want to put them.

" } }, "documentation":"

Represents a request to reorder the receipt rules within a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "ReorderReceiptRuleSetResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "ReportingMta":{"type":"string"}, "RuleDoesNotExistException":{ "type":"structure", "members":{ "Name":{"shape":"RuleOrRuleSetName"} }, "documentation":"

Indicates that the provided receipt rule does not exist.

", "error":{ "code":"RuleDoesNotExist", "httpStatusCode":400, "senderFault":true }, "exception":true }, "RuleOrRuleSetName":{"type":"string"}, "RuleSetDoesNotExistException":{ "type":"structure", "members":{ "Name":{"shape":"RuleOrRuleSetName"} }, "documentation":"

Indicates that the provided receipt rule set does not exist.

", "error":{ "code":"RuleSetDoesNotExist", "httpStatusCode":400, "senderFault":true }, "exception":true }, "S3Action":{ "type":"structure", "required":["BucketName"], "members":{ "TopicArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

" }, "BucketName":{ "shape":"S3BucketName", "documentation":"

The name of the Amazon S3 bucket to which to save the received email.

" }, "ObjectKeyPrefix":{ "shape":"S3KeyPrefix", "documentation":"

The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.

" }, "KmsKeyArn":{ "shape":"AmazonResourceName", "documentation":"

The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:

  • To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key.

  • To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide.

For more information about key policies, see the AWS KMS Developer Guide. If you do not specify a master key, Amazon SES will not encrypt your emails.

Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS Java SDK and AWS Ruby SDK only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.

" } }, "documentation":"

When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

To enable Amazon SES to write emails to your Amazon S3 bucket, use an AWS KMS key to encrypt your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide.

When you save your emails to an Amazon S3 bucket, the maximum email size (including headers) is 30 MB. Emails larger than that will bounce.

For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide.

" }, "S3BucketName":{"type":"string"}, "S3KeyPrefix":{"type":"string"}, "SNSAction":{ "type":"structure", "required":["TopicArn"], "members":{ "TopicArn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

" }, "Encoding":{ "shape":"SNSActionEncoding", "documentation":"

The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.

" } }, "documentation":"

When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS notifications. Amazon SNS notifications for all other actions simply provide information about the email. They do not include the email content itself.

If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a policy to the topic to give Amazon SES permissions to access it. For information about giving permissions, see the Amazon SES Developer Guide.

You can only publish emails that are 150 KB or less (including the header) to Amazon SNS. Larger emails will bounce. If you anticipate emails larger than 150 KB, use the S3 action instead.

For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon SES Developer Guide.

" }, "SNSActionEncoding":{ "type":"string", "enum":[ "UTF-8", "Base64" ] }, "SendBounceRequest":{ "type":"structure", "required":[ "OriginalMessageId", "BounceSender", "BouncedRecipientInfoList" ], "members":{ "OriginalMessageId":{ "shape":"MessageId", "documentation":"

The message ID of the message to be bounced.

" }, "BounceSender":{ "shape":"Address", "documentation":"

The address to use in the \"From\" header of the bounce message. This must be an identity that you have verified with Amazon SES.

" }, "Explanation":{ "shape":"Explanation", "documentation":"

Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.

" }, "MessageDsn":{ "shape":"MessageDsn", "documentation":"

Message-related DSN fields. If not specified, Amazon SES will choose the values.

" }, "BouncedRecipientInfoList":{ "shape":"BouncedRecipientInfoList", "documentation":"

A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.

" }, "BounceSenderArn":{ "shape":"AmazonResourceName", "documentation":"

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the \"From\" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.

" } }, "documentation":"

Represents a request to send a bounce message to the sender of an email you received through Amazon SES.

" }, "SendBounceResponse":{ "type":"structure", "members":{ "MessageId":{ "shape":"MessageId", "documentation":"

The message ID of the bounce message.

" } }, "documentation":"

Represents a unique message ID.

" }, "SendDataPoint":{ "type":"structure", "members":{ "Timestamp":{ "shape":"Timestamp", "documentation":"

Time of the data point.

" }, "DeliveryAttempts":{ "shape":"Counter", "documentation":"

Number of emails that have been sent.

" }, "Bounces":{ "shape":"Counter", "documentation":"

Number of emails that have bounced.

" }, "Complaints":{ "shape":"Counter", "documentation":"

Number of unwanted emails that were rejected by recipients.

" }, "Rejects":{ "shape":"Counter", "documentation":"

Number of emails rejected by Amazon SES.

" } }, "documentation":"

Represents sending statistics data. Each SendDataPoint contains statistics for a 15-minute period of sending activity.

" }, "SendDataPointList":{ "type":"list", "member":{"shape":"SendDataPoint"} }, "SendEmailRequest":{ "type":"structure", "required":[ "Source", "Destination", "Message" ], "members":{ "Source":{ "shape":"Address", "documentation":"

The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.

" }, "Destination":{ "shape":"Destination", "documentation":"

The destination for this email, composed of To:, CC:, and BCC: fields.

" }, "Message":{ "shape":"Message", "documentation":"

The message to be sent.

" }, "ReplyToAddresses":{ "shape":"AddressList", "documentation":"

The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

" }, "ReturnPath":{ "shape":"Address", "documentation":"

The email address to which bounces and complaints are to be forwarded when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

" }, "SourceArn":{ "shape":"AmazonResourceName", "documentation":"

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

" }, "ReturnPathArn":{ "shape":"AmazonResourceName", "documentation":"

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

For more information about sending authorization, see the Amazon SES Developer Guide.

" }, "Tags":{ "shape":"MessageTagList", "documentation":"

A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

" }, "ConfigurationSetName":{ "shape":"ConfigurationSetName", "documentation":"

The name of the configuration set to use when you send an email using SendEmail.

" } }, "documentation":"

Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "SendEmailResponse":{ "type":"structure", "required":["MessageId"], "members":{ "MessageId":{ "shape":"MessageId", "documentation":"

The unique message identifier returned from the SendEmail action.

" } }, "documentation":"

Represents a unique message ID.

" }, "SendRawEmailRequest":{ "type":"structure", "required":["RawMessage"], "members":{ "Source":{ "shape":"Address", "documentation":"

The identity's email address. If you do not provide a value for this parameter, you must specify a \"From\" address in the raw text of the message. (You can also specify both.)

By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=. For more information, see RFC 2047.

If you specify the Source parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.

" }, "Destinations":{ "shape":"AddressList", "documentation":"

A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.

" }, "RawMessage":{ "shape":"RawMessage", "documentation":"

The raw text of the message. The client is responsible for ensuring the following:

  • Message must contain a header and a body, separated by a blank line.

  • All required header fields must be present.

  • Each part of a multipart MIME message must be formatted properly.

  • MIME content types must be among those supported by Amazon SES. For more information, go to the Amazon SES Developer Guide.

  • Must be base64-encoded.

" }, "FromArn":{ "shape":"AmazonResourceName", "documentation":"

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular \"From\" address in the header of the raw email.

Instead of using this parameter, you can use the X-header X-SES-FROM-ARN in the raw message of the email. If you use both the FromArn parameter and the corresponding X-header, Amazon SES uses the value of the FromArn parameter.

For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

" }, "SourceArn":{ "shape":"AmazonResourceName", "documentation":"

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

Instead of using this parameter, you can use the X-header X-SES-SOURCE-ARN in the raw message of the email. If you use both the SourceArn parameter and the corresponding X-header, Amazon SES uses the value of the SourceArn parameter.

For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

" }, "ReturnPathArn":{ "shape":"AmazonResourceName", "documentation":"

This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.

For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

Instead of using this parameter, you can use the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both the ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the value of the ReturnPathArn parameter.

For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

" }, "Tags":{ "shape":"MessageTagList", "documentation":"

A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

" }, "ConfigurationSetName":{ "shape":"ConfigurationSetName", "documentation":"

The name of the configuration set to use when you send an email using SendRawEmail.

" } }, "documentation":"

Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "SendRawEmailResponse":{ "type":"structure", "required":["MessageId"], "members":{ "MessageId":{ "shape":"MessageId", "documentation":"

The unique message identifier returned from the SendRawEmail action.

" } }, "documentation":"

Represents a unique message ID.

" }, "SentLast24Hours":{"type":"double"}, "SetActiveReceiptRuleSetRequest":{ "type":"structure", "members":{ "RuleSetName":{ "shape":"ReceiptRuleSetName", "documentation":"

The name of the receipt rule set to make active. Setting this value to null disables all email receiving.

" } }, "documentation":"

Represents a request to set a receipt rule set as the active receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "SetActiveReceiptRuleSetResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "SetIdentityDkimEnabledRequest":{ "type":"structure", "required":[ "Identity", "DkimEnabled" ], "members":{ "Identity":{ "shape":"Identity", "documentation":"

The identity for which DKIM signing should be enabled or disabled.

" }, "DkimEnabled":{ "shape":"Enabled", "documentation":"

Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it.

" } }, "documentation":"

Represents a request to enable or disable Amazon SES Easy DKIM signing for an identity. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.

" }, "SetIdentityDkimEnabledResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "SetIdentityFeedbackForwardingEnabledRequest":{ "type":"structure", "required":[ "Identity", "ForwardingEnabled" ], "members":{ "Identity":{ "shape":"Identity", "documentation":"

The identity for which to set bounce and complaint notification forwarding. Examples: user@example.com, example.com.

" }, "ForwardingEnabled":{ "shape":"Enabled", "documentation":"

Sets whether Amazon SES will forward bounce and complaint notifications as email. true specifies that Amazon SES will forward bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. false specifies that Amazon SES will publish bounce and complaint notifications only through Amazon SNS. This value can only be set to false when Amazon SNS topics are set for both Bounce and Complaint notification types.

" } }, "documentation":"

Represents a request to enable or disable whether Amazon SES forwards you bounce and complaint notifications through email. For information about email feedback forwarding, see the Amazon SES Developer Guide.

" }, "SetIdentityFeedbackForwardingEnabledResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "SetIdentityHeadersInNotificationsEnabledRequest":{ "type":"structure", "required":[ "Identity", "NotificationType", "Enabled" ], "members":{ "Identity":{ "shape":"Identity", "documentation":"

The identity for which to enable or disable headers in notifications. Examples: user@example.com, example.com.

" }, "NotificationType":{ "shape":"NotificationType", "documentation":"

The notification type for which to enable or disable headers in notifications.

" }, "Enabled":{ "shape":"Enabled", "documentation":"

Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES will include headers in notifications, and a value of false specifies that Amazon SES will not include headers in notifications.

This value can only be set when NotificationType is already set to use a particular Amazon SNS topic.

" } }, "documentation":"

Represents a request to set whether Amazon SES includes the original email headers in the Amazon SNS notifications of a specified type. For information about notifications, see the Amazon SES Developer Guide.

" }, "SetIdentityHeadersInNotificationsEnabledResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "SetIdentityMailFromDomainRequest":{ "type":"structure", "required":["Identity"], "members":{ "Identity":{ "shape":"Identity", "documentation":"

The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.

" }, "MailFromDomain":{ "shape":"MailFromDomainName", "documentation":"

The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a \"From\" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of null disables the custom MAIL FROM setting for the identity.

" }, "BehaviorOnMXFailure":{ "shape":"BehaviorOnMXFailure", "documentation":"

The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES will return a MailFromDomainNotVerified error and not send the email.

The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup is in the Pending, Failed, and TemporaryFailure states.

" } }, "documentation":"

Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for a verified identity. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.

" }, "SetIdentityMailFromDomainResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "SetIdentityNotificationTopicRequest":{ "type":"structure", "required":[ "Identity", "NotificationType" ], "members":{ "Identity":{ "shape":"Identity", "documentation":"

The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

" }, "NotificationType":{ "shape":"NotificationType", "documentation":"

The type of notifications that will be published to the specified Amazon SNS topic.

" }, "SnsTopic":{ "shape":"NotificationTopic", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, SnsTopic is cleared and publishing is disabled.

" } }, "documentation":"

Represents a request to specify the Amazon SNS topic to which Amazon SES will publish bounce, complaint, or delivery notifications for emails sent with that identity as the Source. For information about Amazon SES notifications, see the Amazon SES Developer Guide.

" }, "SetIdentityNotificationTopicResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "SetReceiptRulePositionRequest":{ "type":"structure", "required":[ "RuleSetName", "RuleName" ], "members":{ "RuleSetName":{ "shape":"ReceiptRuleSetName", "documentation":"

The name of the receipt rule set that contains the receipt rule to reposition.

" }, "RuleName":{ "shape":"ReceiptRuleName", "documentation":"

The name of the receipt rule to reposition.

" }, "After":{ "shape":"ReceiptRuleName", "documentation":"

The name of the receipt rule after which to place the specified receipt rule.

" } }, "documentation":"

Represents a request to set the position of a receipt rule in a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "SetReceiptRulePositionResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "StopAction":{ "type":"structure", "required":["Scope"], "members":{ "Scope":{ "shape":"StopScope", "documentation":"

The scope to which the Stop action applies. That is, what is being stopped.

" }, "TopicArn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

" } }, "documentation":"

When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

For information about setting a stop action in a receipt rule, see the Amazon SES Developer Guide.

" }, "StopScope":{ "type":"string", "enum":["RuleSet"] }, "Timestamp":{"type":"timestamp"}, "TlsPolicy":{ "type":"string", "enum":[ "Require", "Optional" ] }, "UpdateConfigurationSetEventDestinationRequest":{ "type":"structure", "required":[ "ConfigurationSetName", "EventDestination" ], "members":{ "ConfigurationSetName":{ "shape":"ConfigurationSetName", "documentation":"

The name of the configuration set that you want to update.

" }, "EventDestination":{ "shape":"EventDestination", "documentation":"

The event destination object that you want to apply to the specified configuration set.

" } }, "documentation":"

Represents a request to update the event destination of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

" }, "UpdateConfigurationSetEventDestinationResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "UpdateReceiptRuleRequest":{ "type":"structure", "required":[ "RuleSetName", "Rule" ], "members":{ "RuleSetName":{ "shape":"ReceiptRuleSetName", "documentation":"

The name of the receipt rule set to which the receipt rule belongs.

" }, "Rule":{ "shape":"ReceiptRule", "documentation":"

A data structure that contains the updated receipt rule information.

" } }, "documentation":"

Represents a request to update a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

" }, "UpdateReceiptRuleResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "VerificationAttributes":{ "type":"map", "key":{"shape":"Identity"}, "value":{"shape":"IdentityVerificationAttributes"} }, "VerificationStatus":{ "type":"string", "enum":[ "Pending", "Success", "Failed", "TemporaryFailure", "NotStarted" ] }, "VerificationToken":{"type":"string"}, "VerificationTokenList":{ "type":"list", "member":{"shape":"VerificationToken"} }, "VerifyDomainDkimRequest":{ "type":"structure", "required":["Domain"], "members":{ "Domain":{ "shape":"Domain", "documentation":"

The name of the domain to be verified for Easy DKIM signing.

" } }, "documentation":"

Represents a request to generate the CNAME records needed to set up Easy DKIM with Amazon SES. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.

" }, "VerifyDomainDkimResponse":{ "type":"structure", "required":["DkimTokens"], "members":{ "DkimTokens":{ "shape":"VerificationTokenList", "documentation":"

A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address.

Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign emails originating from that domain.

For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.

" } }, "documentation":"

Returns CNAME records that you must publish to the DNS server of your domain to set up Easy DKIM with Amazon SES.

" }, "VerifyDomainIdentityRequest":{ "type":"structure", "required":["Domain"], "members":{ "Domain":{ "shape":"Domain", "documentation":"

The domain to be verified.

" } }, "documentation":"

Represents a request to begin Amazon SES domain verification and to generate the TXT records that you must publish to the DNS server of your domain to complete the verification. For information about domain verification, see the Amazon SES Developer Guide.

" }, "VerifyDomainIdentityResponse":{ "type":"structure", "required":["VerificationToken"], "members":{ "VerificationToken":{ "shape":"VerificationToken", "documentation":"

A TXT record that must be placed in the DNS settings for the domain, in order to complete domain verification.

" } }, "documentation":"

Returns a TXT record that you must publish to the DNS server of your domain to complete domain verification with Amazon SES.

" }, "VerifyEmailAddressRequest":{ "type":"structure", "required":["EmailAddress"], "members":{ "EmailAddress":{ "shape":"Address", "documentation":"

The email address to be verified.

" } }, "documentation":"

Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.

" }, "VerifyEmailIdentityRequest":{ "type":"structure", "required":["EmailAddress"], "members":{ "EmailAddress":{ "shape":"Address", "documentation":"

The email address to be verified.

" } }, "documentation":"

Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.

" }, "VerifyEmailIdentityResponse":{ "type":"structure", "members":{ }, "documentation":"

An empty element returned on a successful request.

" }, "WorkmailAction":{ "type":"structure", "required":["OrganizationArn"], "members":{ "TopicArn":{ "shape":"AmazonResourceName", "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

" }, "OrganizationArn":{ "shape":"AmazonResourceName", "documentation":"

The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.

" } }, "documentation":"

When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). You will typically not use this action directly because Amazon WorkMail adds the rule automatically during its setup procedure.

For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide.

" } }, "documentation":"Amazon Simple Email Service

This is the API Reference for Amazon Simple Email Service (Amazon SES). This documentation is intended to be used in conjunction with the Amazon SES Developer Guide.

For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.

" } botocore-1.5.7/botocore/data/ecs/0000777454262600001440000000000013042511307017705 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ecs/2014-11-13/0000777454262600001440000000000013042511307020733 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ecs/2014-11-13/waiters-2.json0000666454262600001440000000431513042511306023445 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "TasksRunning": { "delay": 6, "operation": "DescribeTasks", "maxAttempts": 100, "acceptors": [ { "expected": "STOPPED", "matcher": "pathAny", "state": "failure", "argument": "tasks[].lastStatus" }, { "expected": "MISSING", "matcher": "pathAny", "state": "failure", "argument": "failures[].reason" }, { "expected": "RUNNING", "matcher": "pathAll", "state": "success", "argument": "tasks[].lastStatus" } ] }, "TasksStopped": { "delay": 6, "operation": "DescribeTasks", "maxAttempts": 100, "acceptors": [ { "expected": "STOPPED", "matcher": "pathAll", "state": "success", "argument": "tasks[].lastStatus" } ] }, "ServicesStable": { "delay": 15, "operation": "DescribeServices", "maxAttempts": 40, "acceptors": [ { "expected": "MISSING", "matcher": "pathAny", "state": "failure", "argument": "failures[].reason" }, { "expected": "DRAINING", "matcher": "pathAny", "state": "failure", "argument": "services[].status" }, { "expected": "INACTIVE", "matcher": "pathAny", "state": "failure", "argument": "services[].status" }, { "expected": true, "matcher": "path", "state": "success", "argument": "services | [@[?length(deployments)!=`1`], @[?desiredCount!=runningCount]][] | length(@) == `0`" } ] }, "ServicesInactive": { "delay": 15, "operation": "DescribeServices", "maxAttempts": 40, "acceptors": [ { "expected": "MISSING", "matcher": "pathAny", "state": "failure", "argument": "failures[].reason" }, { "expected": "INACTIVE", "matcher": "pathAny", "state": "success", "argument": "services[].status" } ] } } } botocore-1.5.7/botocore/data/ecs/2014-11-13/paginators-1.json0000666454262600001440000000167413042511306024142 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListClusters": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", "result_key": "clusterArns" }, "ListContainerInstances": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", "result_key": "containerInstanceArns" }, "ListTaskDefinitions": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", "result_key": "taskDefinitionArns" }, "ListTaskDefinitionFamilies": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", "result_key": "families" }, "ListTasks": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", "result_key": "taskArns" }, "ListServices": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", "result_key": "serviceArns" } } } botocore-1.5.7/botocore/data/ecs/2014-11-13/service-2.json0000666454262600001440000052457513042511306023446 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2014-11-13", "endpointPrefix":"ecs", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"Amazon ECS", "serviceFullName":"Amazon EC2 Container Service", "signatureVersion":"v4", "targetPrefix":"AmazonEC2ContainerServiceV20141113", "uid":"ecs-2014-11-13" }, "operations":{ "CreateCluster":{ "name":"CreateCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateClusterRequest"}, "output":{"shape":"CreateClusterResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.

" }, "CreateService":{ "name":"CreateService", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateServiceRequest"}, "output":{"shape":"CreateServiceResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see UpdateService.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon EC2 Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition or the desired count of a service with an UpdateService operation), the service scheduler uses the minimumHealthyPercent and maximumPercent parameters to determine the deployment strategy.

The minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if desiredCount is four tasks and the minimum is 50%, the scheduler can stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer. The default value is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs.

The maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if desiredCount is four tasks and the maximum is 200%, the scheduler can start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value is 200%.

When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:

  • Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).

  • By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):

    • Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.

    • Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.

" }, "DeleteAttributes":{ "name":"DeleteAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAttributesRequest"}, "output":{"shape":"DeleteAttributesResponse"}, "errors":[ {"shape":"ClusterNotFoundException"}, {"shape":"TargetNotFoundException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Deletes one or more custom attributes from an Amazon ECS resource.

" }, "DeleteCluster":{ "name":"DeleteCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteClusterRequest"}, "output":{"shape":"DeleteClusterResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"ClusterContainsContainerInstancesException"}, {"shape":"ClusterContainsServicesException"} ], "documentation":"

Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

" }, "DeleteService":{ "name":"DeleteService", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteServiceRequest"}, "output":{"shape":"DeleteServiceResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"ServiceNotFoundException"} ], "documentation":"

Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.

When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in ListServices API operations. After the tasks have stopped, then the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with DescribeServices API operations; however, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices API operations on those services will return a ServiceNotFoundException error.

" }, "DeregisterContainerInstance":{ "name":"DeregisterContainerInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterContainerInstanceRequest"}, "output":{"shape":"DeregisterContainerInstanceResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.

If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.

If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).

" }, "DeregisterTaskDefinition":{ "name":"DeregisterTaskDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterTaskDefinitionRequest"}, "output":{"shape":"DeregisterTaskDefinitionResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count.

You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect).

" }, "DescribeClusters":{ "name":"DescribeClusters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClustersRequest"}, "output":{"shape":"DescribeClustersResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Describes one or more of your clusters.

" }, "DescribeContainerInstances":{ "name":"DescribeContainerInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeContainerInstancesRequest"}, "output":{"shape":"DescribeContainerInstancesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.

" }, "DescribeServices":{ "name":"DescribeServices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeServicesRequest"}, "output":{"shape":"DescribeServicesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

Describes the specified services running in your cluster.

" }, "DescribeTaskDefinition":{ "name":"DescribeTaskDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTaskDefinitionRequest"}, "output":{"shape":"DescribeTaskDefinitionResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.

You can only describe INACTIVE task definitions while an active task or service references them.

" }, "DescribeTasks":{ "name":"DescribeTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTasksRequest"}, "output":{"shape":"DescribeTasksResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

Describes a specified task or tasks.

" }, "DiscoverPollEndpoint":{ "name":"DiscoverPollEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DiscoverPollEndpointRequest"}, "output":{"shape":"DiscoverPollEndpointResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"} ], "documentation":"

This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.

Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.

" }, "ListAttributes":{ "name":"ListAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAttributesRequest"}, "output":{"shape":"ListAttributesResponse"}, "errors":[ {"shape":"ClusterNotFoundException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, LisAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).

" }, "ListClusters":{ "name":"ListClusters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListClustersRequest"}, "output":{"shape":"ListClustersResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Returns a list of existing clusters.

" }, "ListContainerInstances":{ "name":"ListContainerInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListContainerInstancesRequest"}, "output":{"shape":"ListContainerInstancesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.

" }, "ListServices":{ "name":"ListServices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListServicesRequest"}, "output":{"shape":"ListServicesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

Lists the services that are running in a specified cluster.

" }, "ListTaskDefinitionFamilies":{ "name":"ListTaskDefinitionFamilies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTaskDefinitionFamiliesRequest"}, "output":{"shape":"ListTaskDefinitionFamiliesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definition revisions).

You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.

" }, "ListTaskDefinitions":{ "name":"ListTaskDefinitions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTaskDefinitionsRequest"}, "output":{"shape":"ListTaskDefinitionsResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.

" }, "ListTasks":{ "name":"ListTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTasksRequest"}, "output":{"shape":"ListTasksResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"ServiceNotFoundException"} ], "documentation":"

Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters.

Recently-stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.

" }, "PutAttributes":{ "name":"PutAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutAttributesRequest"}, "output":{"shape":"PutAttributesResponse"}, "errors":[ {"shape":"ClusterNotFoundException"}, {"shape":"TargetNotFoundException"}, {"shape":"AttributeLimitExceededException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon EC2 Container Service Developer Guide.

" }, "RegisterContainerInstance":{ "name":"RegisterContainerInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterContainerInstanceRequest"}, "output":{"shape":"RegisterContainerInstanceResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"} ], "documentation":"

This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.

Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.

" }, "RegisterTaskDefinition":{ "name":"RegisterTaskDefinition", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterTaskDefinitionRequest"}, "output":{"shape":"RegisterTaskDefinitionResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon EC2 Container Service Developer Guide.

You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference.

" }, "RunTask":{ "name":"RunTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RunTaskRequest"}, "output":{"shape":"RunTaskResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

Starts a new task using the specified task definition.

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon EC2 Container Service Developer Guide.

Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.

" }, "StartTask":{ "name":"StartTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartTaskRequest"}, "output":{"shape":"StartTaskResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

Starts a new task from the specified task definition on the specified container instance or instances.

Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon EC2 Container Service Developer Guide.

" }, "StopTask":{ "name":"StopTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopTaskRequest"}, "output":{"shape":"StopTaskResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

Stops a running task.

When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

" }, "SubmitContainerStateChange":{ "name":"SubmitContainerStateChange", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SubmitContainerStateChangeRequest"}, "output":{"shape":"SubmitContainerStateChangeResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"} ], "documentation":"

This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a container changed states.

" }, "SubmitTaskStateChange":{ "name":"SubmitTaskStateChange", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SubmitTaskStateChangeRequest"}, "output":{"shape":"SubmitTaskStateChangeResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"} ], "documentation":"

This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a task changed states.

" }, "UpdateContainerAgent":{ "name":"UpdateContainerAgent", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateContainerAgentRequest"}, "output":{"shape":"UpdateContainerAgentResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"UpdateInProgressException"}, {"shape":"NoUpdateAvailableException"}, {"shape":"MissingVersionException"} ], "documentation":"

Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.

UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon EC2 Container Service Developer Guide.

" }, "UpdateContainerInstancesState":{ "name":"UpdateContainerInstancesState", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateContainerInstancesStateRequest"}, "output":{"shape":"UpdateContainerInstancesStateResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"} ], "documentation":"

Modifies the status of an Amazon ECS container instance.

You can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.

When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.

Service tasks on the container instance that are in the RUNNING state are stopped and replaced according the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. Note that you can change the deployment configuration of your service using UpdateService.

  • If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during task replacement. For example, desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.

  • The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if desiredCount of four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained (provided that the cluster resources required to do this are available). If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.

Any PENDING or RUNNING tasks that do not belong to a service are not affected; you must wait for them to finish or stop them manually.

A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks.

When you set a container instance to ACTIVE, the Amazon ECS scheduler can begin scheduling tasks on the instance again.

" }, "UpdateService":{ "name":"UpdateService", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateServiceRequest"}, "output":{"shape":"UpdateServiceResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"ClientException"}, {"shape":"InvalidParameterException"}, {"shape":"ClusterNotFoundException"}, {"shape":"ServiceNotFoundException"}, {"shape":"ServiceNotActiveException"} ], "documentation":"

Modifies the desired count, deployment configuration, or task definition used in a service.

You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.

You can use UpdateService to modify your task definition and deploy a new version of your service.

You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.

  • If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.

  • The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).

When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:

  • Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).

  • By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):

    • Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.

    • Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.

When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:

  • Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.

  • Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.

" } }, "shapes":{ "AgentUpdateStatus":{ "type":"string", "enum":[ "PENDING", "STAGING", "STAGED", "UPDATING", "UPDATED", "FAILED" ] }, "Attribute":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"String", "documentation":"

The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.

" }, "value":{ "shape":"String", "documentation":"

The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.

" }, "targetType":{ "shape":"TargetType", "documentation":"

The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full Amazon Resource Name (ARN).

" }, "targetId":{ "shape":"String", "documentation":"

The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

" } }, "documentation":"

An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon EC2 Container Service Developer Guide.

" }, "AttributeLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.

", "exception":true }, "Attributes":{ "type":"list", "member":{"shape":"Attribute"} }, "Boolean":{"type":"boolean"}, "BoxedBoolean":{ "type":"boolean", "box":true }, "BoxedInteger":{ "type":"integer", "box":true }, "ClientException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

", "exception":true }, "Cluster":{ "type":"structure", "members":{ "clusterArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test ..

" }, "clusterName":{ "shape":"String", "documentation":"

A user-generated string that you use to identify your cluster.

" }, "status":{ "shape":"String", "documentation":"

The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

" }, "registeredContainerInstancesCount":{ "shape":"Integer", "documentation":"

The number of container instances registered into the cluster.

" }, "runningTasksCount":{ "shape":"Integer", "documentation":"

The number of tasks in the cluster that are in the RUNNING state.

" }, "pendingTasksCount":{ "shape":"Integer", "documentation":"

The number of tasks in the cluster that are in the PENDING state.

" }, "activeServicesCount":{ "shape":"Integer", "documentation":"

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

" } }, "documentation":"

A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.

" }, "ClusterContainsContainerInstancesException":{ "type":"structure", "members":{ }, "documentation":"

You cannot delete a cluster that has registered container instances. You must first deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.

", "exception":true }, "ClusterContainsServicesException":{ "type":"structure", "members":{ }, "documentation":"

You cannot delete a cluster that contains services. You must first update the service to reduce its desired task count to 0 and then delete the service. For more information, see UpdateService and DeleteService.

", "exception":true }, "ClusterNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

", "exception":true }, "Clusters":{ "type":"list", "member":{"shape":"Cluster"} }, "Container":{ "type":"structure", "members":{ "containerArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the container.

" }, "taskArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the task.

" }, "name":{ "shape":"String", "documentation":"

The name of the container.

" }, "lastStatus":{ "shape":"String", "documentation":"

The last known status of the container.

" }, "exitCode":{ "shape":"BoxedInteger", "documentation":"

The exit code returned from the container.

" }, "reason":{ "shape":"String", "documentation":"

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

" }, "networkBindings":{ "shape":"NetworkBindings", "documentation":"

The network bindings associated with the container.

" } }, "documentation":"

A Docker container that is part of a task.

" }, "ContainerDefinition":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.

" }, "image":{ "shape":"String", "documentation":"

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

Amazon ECS task definitions currently only support tags as image identifiers within a specified repository (and not sha256 digests).

  • Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).

  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

" }, "cpu":{ "shape":"Integer", "documentation":"

The number of cpu units reserved for the container. A container instance has 1,024 cpu units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.

You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.

For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

  • Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.

  • Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.

" }, "memory":{ "shape":"BoxedInteger", "documentation":"

The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

" }, "memoryReservation":{ "shape":"BoxedInteger", "documentation":"

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.

You must specify a non-zero integer for one or both of memory or memoryReservation in container definitions. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

" }, "links":{ "shape":"StringList", "documentation":"

The link parameter allows containers to communicate with each other without the need for port mappings, using the name parameter and optionally, an alias for the link. This construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for each name and alias. For more information on linking Docker containers, see https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

" }, "portMappings":{ "shape":"PortMappingList", "documentation":"

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you cannot specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description of a selected task in the Amazon ECS console, or the networkBindings section DescribeTasks responses.

" }, "essential":{ "shape":"BoxedBoolean", "documentation":"

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.

" }, "entryPoint":{ "shape":"StringList", "documentation":"

Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

" }, "command":{ "shape":"StringList", "documentation":"

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

" }, "environment":{ "shape":"EnvironmentVariables", "documentation":"

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We do not recommend using plain text environment variables for sensitive information, such as credential data.

" }, "mountPoints":{ "shape":"MountPointList", "documentation":"

The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

" }, "volumesFrom":{ "shape":"VolumeFromList", "documentation":"

Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.

" }, "hostname":{ "shape":"String", "documentation":"

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.

" }, "user":{ "shape":"String", "documentation":"

The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

" }, "workingDirectory":{ "shape":"String", "documentation":"

The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.

" }, "disableNetworking":{ "shape":"BoxedBoolean", "documentation":"

When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.

" }, "privileged":{ "shape":"BoxedBoolean", "documentation":"

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.

" }, "readonlyRootFilesystem":{ "shape":"BoxedBoolean", "documentation":"

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

" }, "dnsServers":{ "shape":"StringList", "documentation":"

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.

" }, "dnsSearchDomains":{ "shape":"StringList", "documentation":"

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.

" }, "extraHosts":{ "shape":"HostEntryList", "documentation":"

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.

" }, "dockerSecurityOptions":{ "shape":"StringList", "documentation":"

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.

" }, "dockerLabels":{ "shape":"DockerLabelsMap", "documentation":"

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"

" }, "ulimits":{ "shape":"UlimitList", "documentation":"

A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"

" }, "logConfiguration":{ "shape":"LogConfiguration", "documentation":"

The log configuration specification for the container. This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon EC2 Container Service Developer Guide.

" } }, "documentation":"

Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

" }, "ContainerDefinitions":{ "type":"list", "member":{"shape":"ContainerDefinition"} }, "ContainerInstance":{ "type":"structure", "members":{ "containerInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID .

" }, "ec2InstanceId":{ "shape":"String", "documentation":"

The EC2 instance ID of the container instance.

" }, "version":{ "shape":"Long", "documentation":"

The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch events for the container instance (inside the detail object) to verify that the version in your event stream is current.

" }, "versionInfo":{ "shape":"VersionInfo", "documentation":"

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

" }, "remainingResources":{ "shape":"Resources", "documentation":"

For most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks. For port resource types, this parameter describes the ports that are reserved by the Amazon ECS container agent and any containers that have reserved port mappings; any port that is not specified here is available for new tasks.

" }, "registeredResources":{ "shape":"Resources", "documentation":"

For most resource types, this parameter describes the registered resources on the container instance that are in use by current tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

" }, "status":{ "shape":"String", "documentation":"

The status of the container instance. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that the container instance can accept tasks.

" }, "agentConnected":{ "shape":"Boolean", "documentation":"

This parameter returns true if the agent is actually connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false, and instances without a connected agent cannot accept placement requests.

" }, "runningTasksCount":{ "shape":"Integer", "documentation":"

The number of tasks on the container instance that are in the RUNNING status.

" }, "pendingTasksCount":{ "shape":"Integer", "documentation":"

The number of tasks on the container instance that are in the PENDING status.

" }, "agentUpdateStatus":{ "shape":"AgentUpdateStatus", "documentation":"

The status of the most recent agent update. If an update has never been requested, this value is NULL.

" }, "attributes":{ "shape":"Attributes", "documentation":"

The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

" } }, "documentation":"

An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

" }, "ContainerInstanceStatus":{ "type":"string", "enum":[ "ACTIVE", "DRAINING" ] }, "ContainerInstances":{ "type":"list", "member":{"shape":"ContainerInstance"} }, "ContainerOverride":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the container that receives the override.

" }, "command":{ "shape":"StringList", "documentation":"

The command to send to the container that overrides the default command from the Docker image or the task definition.

" }, "environment":{ "shape":"EnvironmentVariables", "documentation":"

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.

" } }, "documentation":"

The overrides that should be sent to a container.

" }, "ContainerOverrides":{ "type":"list", "member":{"shape":"ContainerOverride"} }, "Containers":{ "type":"list", "member":{"shape":"Container"} }, "CreateClusterRequest":{ "type":"structure", "members":{ "clusterName":{ "shape":"String", "documentation":"

The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

" } } }, "CreateClusterResponse":{ "type":"structure", "members":{ "cluster":{ "shape":"Cluster", "documentation":"

The full description of your new cluster.

" } } }, "CreateServiceRequest":{ "type":"structure", "required":[ "serviceName", "taskDefinition", "desiredCount" ], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.

" }, "serviceName":{ "shape":"String", "documentation":"

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.

" }, "taskDefinition":{ "shape":"String", "documentation":"

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

" }, "loadBalancers":{ "shape":"LoadBalancers", "documentation":"

A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.

For Elastic Load Balancing Classic load balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

For Elastic Load Balancing Application load balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

" }, "desiredCount":{ "shape":"BoxedInteger", "documentation":"

The number of instantiations of the specified task definition to place and keep running on your cluster.

" }, "clientToken":{ "shape":"String", "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

" }, "role":{ "shape":"String", "documentation":"

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is required if you are using a load balancer with your service. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.

" }, "deploymentConfiguration":{ "shape":"DeploymentConfiguration", "documentation":"

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

" }, "placementConstraints":{ "shape":"PlacementConstraints", "documentation":"

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).

" }, "placementStrategy":{ "shape":"PlacementStrategies", "documentation":"

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.

" } } }, "CreateServiceResponse":{ "type":"structure", "members":{ "service":{ "shape":"Service", "documentation":"

The full description of your service following the create call.

" } } }, "DeleteAttributesRequest":{ "type":"structure", "required":["attributes"], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.

" }, "attributes":{ "shape":"Attributes", "documentation":"

The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type.

" } } }, "DeleteAttributesResponse":{ "type":"structure", "members":{ "attributes":{ "shape":"Attributes", "documentation":"

A list of attribute objects that were successfully deleted from your resource.

" } } }, "DeleteClusterRequest":{ "type":"structure", "required":["cluster"], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster to delete.

" } } }, "DeleteClusterResponse":{ "type":"structure", "members":{ "cluster":{ "shape":"Cluster", "documentation":"

The full description of the deleted cluster.

" } } }, "DeleteServiceRequest":{ "type":"structure", "required":["service"], "members":{ "cluster":{ "shape":"String", "documentation":"

The name of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.

" }, "service":{ "shape":"String", "documentation":"

The name of the service to delete.

" } } }, "DeleteServiceResponse":{ "type":"structure", "members":{ "service":{ "shape":"Service", "documentation":"

The full description of the deleted service.

" } } }, "Deployment":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The ID of the deployment.

" }, "status":{ "shape":"String", "documentation":"

The status of the deployment. Valid values are PRIMARY (for the most recent deployment), ACTIVE (for previous deployments that still have tasks running, but are being replaced with the PRIMARY deployment), and INACTIVE (for deployments that have been completely replaced).

" }, "taskDefinition":{ "shape":"String", "documentation":"

The most recent task definition that was specified for the service to use.

" }, "desiredCount":{ "shape":"Integer", "documentation":"

The most recent desired count of tasks that was specified for the service to deploy or maintain.

" }, "pendingCount":{ "shape":"Integer", "documentation":"

The number of tasks in the deployment that are in the PENDING status.

" }, "runningCount":{ "shape":"Integer", "documentation":"

The number of tasks in the deployment that are in the RUNNING status.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for when the service was created.

" }, "updatedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for when the service was last updated.

" } }, "documentation":"

The details of an Amazon ECS service deployment.

" }, "DeploymentConfiguration":{ "type":"structure", "members":{ "maximumPercent":{ "shape":"BoxedInteger", "documentation":"

The upper limit (as a percentage of the service's desiredCount) of the number of tasks that are allowed in the RUNNING or PENDING state in a service during a deployment. The maximum number of tasks during a deployment is the desiredCount multiplied by maximumPercent/100, rounded down to the nearest integer value.

" }, "minimumHealthyPercent":{ "shape":"BoxedInteger", "documentation":"

The lower limit (as a percentage of the service's desiredCount) of the number of running tasks that must remain in the RUNNING state in a service during a deployment. The minimum healthy tasks during a deployment is the desiredCount multiplied by minimumHealthyPercent/100, rounded up to the nearest integer value.

" } }, "documentation":"

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

" }, "Deployments":{ "type":"list", "member":{"shape":"Deployment"} }, "DeregisterContainerInstanceRequest":{ "type":"structure", "required":["containerInstance"], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

" }, "containerInstance":{ "shape":"String", "documentation":"

The container instance ID or full Amazon Resource Name (ARN) of the container instance to deregister. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID .

" }, "force":{ "shape":"BoxedBoolean", "documentation":"

Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

Any containers in orphaned service tasks that are registered with a Classic load balancer or an Application load balancer target group are deregistered, and they will begin connection draining according to the settings on the load balancer or target group.

" } } }, "DeregisterContainerInstanceResponse":{ "type":"structure", "members":{ "containerInstance":{ "shape":"ContainerInstance", "documentation":"

The container instance that was deregistered.

" } } }, "DeregisterTaskDefinitionRequest":{ "type":"structure", "required":["taskDefinition"], "members":{ "taskDefinition":{ "shape":"String", "documentation":"

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision.

" } } }, "DeregisterTaskDefinitionResponse":{ "type":"structure", "members":{ "taskDefinition":{ "shape":"TaskDefinition", "documentation":"

The full description of the deregistered task.

" } } }, "DescribeClustersRequest":{ "type":"structure", "members":{ "clusters":{ "shape":"StringList", "documentation":"

A space-separated list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

" } } }, "DescribeClustersResponse":{ "type":"structure", "members":{ "clusters":{ "shape":"Clusters", "documentation":"

The list of clusters.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "DescribeContainerInstancesRequest":{ "type":"structure", "required":["containerInstances"], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed.

" }, "containerInstances":{ "shape":"StringList", "documentation":"

A space-separated list of container instance IDs or full Amazon Resource Name (ARN) entries.

" } } }, "DescribeContainerInstancesResponse":{ "type":"structure", "members":{ "containerInstances":{ "shape":"ContainerInstances", "documentation":"

The list of container instances.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "DescribeServicesRequest":{ "type":"structure", "required":["services"], "members":{ "cluster":{ "shape":"String", "documentation":"

The name of the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed.

" }, "services":{ "shape":"StringList", "documentation":"

A list of services to describe. You may specify up to 10 services to describe in a single operation.

" } } }, "DescribeServicesResponse":{ "type":"structure", "members":{ "services":{ "shape":"Services", "documentation":"

The list of services described.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "DescribeTaskDefinitionRequest":{ "type":"structure", "required":["taskDefinition"], "members":{ "taskDefinition":{ "shape":"String", "documentation":"

The family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.

" } } }, "DescribeTaskDefinitionResponse":{ "type":"structure", "members":{ "taskDefinition":{ "shape":"TaskDefinition", "documentation":"

The full task definition description.

" } } }, "DescribeTasksRequest":{ "type":"structure", "required":["tasks"], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to describe. If you do not specify a cluster, the default cluster is assumed.

" }, "tasks":{ "shape":"StringList", "documentation":"

A space-separated list of task IDs or full Amazon Resource Name (ARN) entries.

" } } }, "DescribeTasksResponse":{ "type":"structure", "members":{ "tasks":{ "shape":"Tasks", "documentation":"

The list of tasks.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "DesiredStatus":{ "type":"string", "enum":[ "RUNNING", "PENDING", "STOPPED" ] }, "DiscoverPollEndpointRequest":{ "type":"structure", "members":{ "containerInstance":{ "shape":"String", "documentation":"

The container instance ID or full Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID .

" }, "cluster":{ "shape":"String", "documentation":"

The cluster that the container instance belongs to.

" } } }, "DiscoverPollEndpointResponse":{ "type":"structure", "members":{ "endpoint":{ "shape":"String", "documentation":"

The endpoint for the Amazon ECS agent to poll.

" }, "telemetryEndpoint":{ "shape":"String", "documentation":"

The telemetry endpoint for the Amazon ECS agent.

" } } }, "DockerLabelsMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "Double":{"type":"double"}, "EnvironmentVariables":{ "type":"list", "member":{"shape":"KeyValuePair"} }, "Failure":{ "type":"structure", "members":{ "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the failed resource.

" }, "reason":{ "shape":"String", "documentation":"

The reason for the failure.

" } }, "documentation":"

A failed resource.

" }, "Failures":{ "type":"list", "member":{"shape":"Failure"} }, "HostEntry":{ "type":"structure", "required":[ "hostname", "ipAddress" ], "members":{ "hostname":{ "shape":"String", "documentation":"

The hostname to use in the /etc/hosts entry.

" }, "ipAddress":{ "shape":"String", "documentation":"

The IP address to use in the /etc/hosts entry.

" } }, "documentation":"

Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.

" }, "HostEntryList":{ "type":"list", "member":{"shape":"HostEntry"} }, "HostVolumeProperties":{ "type":"structure", "members":{ "sourcePath":{ "shape":"String", "documentation":"

The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

" } }, "documentation":"

Details on a container instance host volume.

" }, "Integer":{"type":"integer"}, "InvalidParameterException":{ "type":"structure", "members":{ }, "documentation":"

The specified parameter is invalid. Review the available parameters for the API request.

", "exception":true }, "KeyValuePair":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the key value pair. For environment variables, this is the name of the environment variable.

" }, "value":{ "shape":"String", "documentation":"

The value of the key value pair. For environment variables, this is the value of the environment variable.

" } }, "documentation":"

A key and value pair object.

" }, "ListAttributesRequest":{ "type":"structure", "required":["targetType"], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

" }, "targetType":{ "shape":"TargetType", "documentation":"

The type of the target with which to list attributes.

" }, "attributeName":{ "shape":"String", "documentation":"

The name of the attribute with which to filter the results.

" }, "attributeValue":{ "shape":"String", "documentation":"

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value returned from a previous paginated ListAttributes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" }, "maxResults":{ "shape":"BoxedInteger", "documentation":"

The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

" } } }, "ListAttributesResponse":{ "type":"structure", "members":{ "attributes":{ "shape":"Attributes", "documentation":"

A list of attribute objects that meet the criteria of the request.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value to include in a future ListAttributes request. When the results of a ListAttributes request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "ListClustersRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "documentation":"

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" }, "maxResults":{ "shape":"BoxedInteger", "documentation":"

The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.

" } } }, "ListClustersResponse":{ "type":"structure", "members":{ "clusterArns":{ "shape":"StringList", "documentation":"

The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "ListContainerInstancesRequest":{ "type":"structure", "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

" }, "filter":{ "shape":"String", "documentation":"

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" }, "maxResults":{ "shape":"BoxedInteger", "documentation":"

The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

" }, "status":{ "shape":"ContainerInstanceStatus", "documentation":"

The container instance status with which to filter the ListContainerInstances results. Specifying a container instance status of DRAINING limits the results to container instances that have been set to drain with the UpdateContainerInstancesState operation.

" } } }, "ListContainerInstancesResponse":{ "type":"structure", "members":{ "containerInstanceArns":{ "shape":"StringList", "documentation":"

The list of container instances with full Amazon Resource Name (ARN) entries for each container instance associated with the specified cluster.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "ListServicesRequest":{ "type":"structure", "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value returned from a previous paginated ListServices request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" }, "maxResults":{ "shape":"BoxedInteger", "documentation":"

The maximum number of container instance results returned by ListServices in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then ListServices returns up to 10 results and a nextToken value if applicable.

" } } }, "ListServicesResponse":{ "type":"structure", "members":{ "serviceArns":{ "shape":"StringList", "documentation":"

The list of full Amazon Resource Name (ARN) entries for each service associated with the specified cluster.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "ListTaskDefinitionFamiliesRequest":{ "type":"structure", "members":{ "familyPrefix":{ "shape":"String", "documentation":"

The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

" }, "status":{ "shape":"TaskDefinitionFamilyStatus", "documentation":"

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value returned from a previous paginated ListTaskDefinitionFamilies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" }, "maxResults":{ "shape":"BoxedInteger", "documentation":"

The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.

" } } }, "ListTaskDefinitionFamiliesResponse":{ "type":"structure", "members":{ "families":{ "shape":"StringList", "documentation":"

The list of task definition family names that match the ListTaskDefinitionFamilies request.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "ListTaskDefinitionsRequest":{ "type":"structure", "members":{ "familyPrefix":{ "shape":"String", "documentation":"

The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

" }, "status":{ "shape":"TaskDefinitionStatus", "documentation":"

The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

" }, "sort":{ "shape":"SortOrder", "documentation":"

The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value returned from a previous paginated ListTaskDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" }, "maxResults":{ "shape":"BoxedInteger", "documentation":"

The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

" } } }, "ListTaskDefinitionsResponse":{ "type":"structure", "members":{ "taskDefinitionArns":{ "shape":"StringList", "documentation":"

The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions request.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "ListTasksRequest":{ "type":"structure", "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed.

" }, "containerInstance":{ "shape":"String", "documentation":"

The container instance ID or full Amazon Resource Name (ARN) of the container instance with which to filter the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

" }, "family":{ "shape":"String", "documentation":"

The name of the family with which to filter the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value returned from a previous paginated ListTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" }, "maxResults":{ "shape":"BoxedInteger", "documentation":"

The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.

" }, "startedBy":{ "shape":"String", "documentation":"

The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.

" }, "serviceName":{ "shape":"String", "documentation":"

The name of the service with which to filter the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

" }, "desiredStatus":{ "shape":"DesiredStatus", "documentation":"

The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that ECS has set the desired status to STOPPED, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this will not return any results because ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

" } } }, "ListTasksResponse":{ "type":"structure", "members":{ "taskArns":{ "shape":"StringList", "documentation":"

The list of task Amazon Resource Name (ARN) entries for the ListTasks request.

" }, "nextToken":{ "shape":"String", "documentation":"

The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "LoadBalancer":{ "type":"structure", "members":{ "targetGroupArn":{ "shape":"String", "documentation":"

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group associated with a service.

" }, "loadBalancerName":{ "shape":"String", "documentation":"

The name of the load balancer.

" }, "containerName":{ "shape":"String", "documentation":"

The name of the container (as it appears in a container definition) to associate with the load balancer.

" }, "containerPort":{ "shape":"BoxedInteger", "documentation":"

The port on the container to associate with the load balancer. This port must correspond to a containerPort in the service's task definition. Your container instances must allow ingress traffic on the hostPort of the port mapping.

" } }, "documentation":"

Details on a load balancer that is used with a service.

" }, "LoadBalancers":{ "type":"list", "member":{"shape":"LoadBalancer"} }, "LogConfiguration":{ "type":"structure", "required":["logDriver"], "members":{ "logDriver":{ "shape":"LogDriver", "documentation":"

The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently provide support for running modified copies of this software.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"

" }, "options":{ "shape":"LogConfigurationOptionsMap", "documentation":"

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep \"Server API version\"

" } }, "documentation":"

Log configuration options to send to a custom log driver for the container.

" }, "LogConfigurationOptionsMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "LogDriver":{ "type":"string", "enum":[ "json-file", "syslog", "journald", "gelf", "fluentd", "awslogs", "splunk" ] }, "Long":{"type":"long"}, "MissingVersionException":{ "type":"structure", "members":{ }, "documentation":"

Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.

", "exception":true }, "MountPoint":{ "type":"structure", "members":{ "sourceVolume":{ "shape":"String", "documentation":"

The name of the volume to mount.

" }, "containerPath":{ "shape":"String", "documentation":"

The path on the container to mount the host volume at.

" }, "readOnly":{ "shape":"BoxedBoolean", "documentation":"

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

" } }, "documentation":"

Details on a volume mount point that is used in a container definition.

" }, "MountPointList":{ "type":"list", "member":{"shape":"MountPoint"} }, "NetworkBinding":{ "type":"structure", "members":{ "bindIP":{ "shape":"String", "documentation":"

The IP address that the container is bound to on the container instance.

" }, "containerPort":{ "shape":"BoxedInteger", "documentation":"

The port number on the container that is be used with the network binding.

" }, "hostPort":{ "shape":"BoxedInteger", "documentation":"

The port number on the host that is used with the network binding.

" }, "protocol":{ "shape":"TransportProtocol", "documentation":"

The protocol used for the network binding.

" } }, "documentation":"

Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

" }, "NetworkBindings":{ "type":"list", "member":{"shape":"NetworkBinding"} }, "NetworkMode":{ "type":"string", "enum":[ "bridge", "host", "none" ] }, "NoUpdateAvailableException":{ "type":"structure", "members":{ }, "documentation":"

There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version.

", "exception":true }, "PlacementConstraint":{ "type":"structure", "members":{ "type":{ "shape":"PlacementConstraintType", "documentation":"

The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict selection to a group of valid candidates. Note that distinctInstance is not supported in task definitions.

" }, "expression":{ "shape":"String", "documentation":"

A cluster query language expression to apply to the constraint. Note you cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.

" } }, "documentation":"

An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon EC2 Container Service Developer Guide.

" }, "PlacementConstraintType":{ "type":"string", "enum":[ "distinctInstance", "memberOf" ] }, "PlacementConstraints":{ "type":"list", "member":{"shape":"PlacementConstraint"} }, "PlacementStrategies":{ "type":"list", "member":{"shape":"PlacementStrategy"} }, "PlacementStrategy":{ "type":"structure", "members":{ "type":{ "shape":"PlacementStrategyType", "documentation":"

The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).

" }, "field":{ "shape":"String", "documentation":"

The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

" } }, "documentation":"

The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon EC2 Container Service Developer Guide.

" }, "PlacementStrategyType":{ "type":"string", "enum":[ "random", "spread", "binpack" ] }, "PortMapping":{ "type":"structure", "members":{ "containerPort":{ "shape":"BoxedInteger", "documentation":"

The port number on the container that is bound to the user-specified or automatically assigned host port. If you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range (for more information, see hostPort). Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

" }, "hostPort":{ "shape":"BoxedInteger", "documentation":"

The port number on the container instance to reserve for your container. You can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.

The default ephemeral port range is 49153 to 65535, and this range is used for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range; if this kernel parameter is unavailable, the default ephemeral port range is used. You should not attempt to specify a host port in the ephemeral port range, because these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released).The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).

" }, "protocol":{ "shape":"TransportProtocol", "documentation":"

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

" } }, "documentation":"

Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

" }, "PortMappingList":{ "type":"list", "member":{"shape":"PortMapping"} }, "PutAttributesRequest":{ "type":"structure", "required":["attributes"], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.

" }, "attributes":{ "shape":"Attributes", "documentation":"

The attributes to apply to your resource. You can specify up to 10 custom attributes per resource. You can specify up to 10 attributes in a single call.

" } } }, "PutAttributesResponse":{ "type":"structure", "members":{ "attributes":{ "shape":"Attributes", "documentation":"

The attributes applied to your resource.

" } } }, "RegisterContainerInstanceRequest":{ "type":"structure", "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed.

" }, "instanceIdentityDocument":{ "shape":"String", "documentation":"

The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/

" }, "instanceIdentityDocumentSignature":{ "shape":"String", "documentation":"

The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/

" }, "totalResources":{ "shape":"Resources", "documentation":"

The resources available on the instance.

" }, "versionInfo":{ "shape":"VersionInfo", "documentation":"

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

" }, "containerInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the container instance (if it was previously registered).

" }, "attributes":{ "shape":"Attributes", "documentation":"

The container instance attributes that this container instance supports.

" } } }, "RegisterContainerInstanceResponse":{ "type":"structure", "members":{ "containerInstance":{ "shape":"ContainerInstance", "documentation":"

The container instance that was registered.

" } } }, "RegisterTaskDefinitionRequest":{ "type":"structure", "required":[ "family", "containerDefinitions" ], "members":{ "family":{ "shape":"String", "documentation":"

You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

" }, "taskRoleArn":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon EC2 Container Service Developer Guide.

" }, "networkMode":{ "shape":"NetworkMode", "documentation":"

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, and host.

The default Docker network mode is bridge. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the task's containers do not have external connectivity. The host network mode offers the highest networking performance for containers because they use the host network stack instead of the virtualized network stack provided by the bridge mode; however, exposed container ports are mapped directly to the corresponding host port, so you cannot take advantage of dynamic host port mappings or run multiple instantiations of the same task on a single container instance if port mappings are used.

For more information, see Network settings in the Docker run reference.

" }, "containerDefinitions":{ "shape":"ContainerDefinitions", "documentation":"

A list of container definitions in JSON format that describe the different containers that make up your task.

" }, "volumes":{ "shape":"VolumeList", "documentation":"

A list of volume definitions in JSON format that containers in your task may use.

" }, "placementConstraints":{ "shape":"TaskDefinitionPlacementConstraints", "documentation":"

An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).

" } } }, "RegisterTaskDefinitionResponse":{ "type":"structure", "members":{ "taskDefinition":{ "shape":"TaskDefinition", "documentation":"

The full description of the registered task definition.

" } } }, "RequiresAttributes":{ "type":"list", "member":{"shape":"Attribute"} }, "Resource":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the resource, such as cpu, memory, ports, or a user-defined resource.

" }, "type":{ "shape":"String", "documentation":"

The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET.

" }, "doubleValue":{ "shape":"Double", "documentation":"

When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

" }, "longValue":{ "shape":"Long", "documentation":"

When the longValue type is set, the value of the resource must be an extended precision floating-point type.

" }, "integerValue":{ "shape":"Integer", "documentation":"

When the integerValue type is set, the value of the resource must be an integer.

" }, "stringSetValue":{ "shape":"StringList", "documentation":"

When the stringSetValue type is set, the value of the resource must be a string type.

" } }, "documentation":"

Describes the resources available for a container instance.

" }, "Resources":{ "type":"list", "member":{"shape":"Resource"} }, "RunTaskRequest":{ "type":"structure", "required":["taskDefinition"], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.

" }, "taskDefinition":{ "shape":"String", "documentation":"

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.

" }, "overrides":{ "shape":"TaskOverride", "documentation":"

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

" }, "count":{ "shape":"BoxedInteger", "documentation":"

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

" }, "startedBy":{ "shape":"String", "documentation":"

An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

" }, "group":{ "shape":"String", "documentation":"

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

" }, "placementConstraints":{ "shape":"PlacementConstraints", "documentation":"

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at run time).

" }, "placementStrategy":{ "shape":"PlacementStrategies", "documentation":"

The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules per task.

" } } }, "RunTaskResponse":{ "type":"structure", "members":{ "tasks":{ "shape":"Tasks", "documentation":"

A full description of the tasks that were run. Each task that was successfully placed on your cluster are described here.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "ServerException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

These errors are usually caused by a server issue.

", "exception":true, "fault":true }, "Service":{ "type":"structure", "members":{ "serviceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service .

" }, "serviceName":{ "shape":"String", "documentation":"

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.

" }, "clusterArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the cluster that hosts the service.

" }, "loadBalancers":{ "shape":"LoadBalancers", "documentation":"

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

" }, "status":{ "shape":"String", "documentation":"

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

" }, "desiredCount":{ "shape":"Integer", "documentation":"

The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

" }, "runningCount":{ "shape":"Integer", "documentation":"

The number of tasks in the cluster that are in the RUNNING state.

" }, "pendingCount":{ "shape":"Integer", "documentation":"

The number of tasks in the cluster that are in the PENDING state.

" }, "taskDefinition":{ "shape":"String", "documentation":"

The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

" }, "deploymentConfiguration":{ "shape":"DeploymentConfiguration", "documentation":"

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

" }, "deployments":{ "shape":"Deployments", "documentation":"

The current state of deployments for the service.

" }, "roleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

" }, "events":{ "shape":"ServiceEvents", "documentation":"

The event stream for your service. A maximum of 100 of the latest events are displayed.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for when the service was created.

" }, "placementConstraints":{ "shape":"PlacementConstraints", "documentation":"

The placement constraints for the tasks in the service.

" }, "placementStrategy":{ "shape":"PlacementStrategies", "documentation":"

The placement strategy that determines how tasks for the service are placed.

" } }, "documentation":"

Details on a service within a cluster

" }, "ServiceEvent":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The ID string of the event.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for when the event was triggered.

" }, "message":{ "shape":"String", "documentation":"

The event message.

" } }, "documentation":"

Details on an event associated with a service.

" }, "ServiceEvents":{ "type":"list", "member":{"shape":"ServiceEvent"} }, "ServiceNotActiveException":{ "type":"structure", "members":{ }, "documentation":"

The specified service is not active. You cannot update a service that is not active. If you have previously deleted a service, you can re-create it with CreateService.

", "exception":true }, "ServiceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and region-specific.

", "exception":true }, "Services":{ "type":"list", "member":{"shape":"Service"} }, "SortOrder":{ "type":"string", "enum":[ "ASC", "DESC" ] }, "StartTaskRequest":{ "type":"structure", "required":[ "taskDefinition", "containerInstances" ], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.

" }, "taskDefinition":{ "shape":"String", "documentation":"

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.

" }, "overrides":{ "shape":"TaskOverride", "documentation":"

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

" }, "containerInstances":{ "shape":"StringList", "documentation":"

The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

" }, "startedBy":{ "shape":"String", "documentation":"

An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

" }, "group":{ "shape":"String", "documentation":"

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

" } } }, "StartTaskResponse":{ "type":"structure", "members":{ "tasks":{ "shape":"Tasks", "documentation":"

A full description of the tasks that were started. Each task that was successfully placed on your container instances are described here.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "StopTaskRequest":{ "type":"structure", "required":["task"], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

" }, "task":{ "shape":"String", "documentation":"

The task ID or full Amazon Resource Name (ARN) entry of the task to stop.

" }, "reason":{ "shape":"String", "documentation":"

An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message will appear in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

" } } }, "StopTaskResponse":{ "type":"structure", "members":{ "task":{ "shape":"Task", "documentation":"

The task that was stopped.

" } } }, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"String"} }, "SubmitContainerStateChangeRequest":{ "type":"structure", "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container.

" }, "task":{ "shape":"String", "documentation":"

The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.

" }, "containerName":{ "shape":"String", "documentation":"

The name of the container.

" }, "status":{ "shape":"String", "documentation":"

The status of the state change request.

" }, "exitCode":{ "shape":"BoxedInteger", "documentation":"

The exit code returned for the state change request.

" }, "reason":{ "shape":"String", "documentation":"

The reason for the state change request.

" }, "networkBindings":{ "shape":"NetworkBindings", "documentation":"

The network bindings of the container.

" } } }, "SubmitContainerStateChangeResponse":{ "type":"structure", "members":{ "acknowledgment":{ "shape":"String", "documentation":"

Acknowledgement of the state change.

" } } }, "SubmitTaskStateChangeRequest":{ "type":"structure", "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

" }, "task":{ "shape":"String", "documentation":"

The task ID or full Amazon Resource Name (ARN) of the task in the state change request.

" }, "status":{ "shape":"String", "documentation":"

The status of the state change request.

" }, "reason":{ "shape":"String", "documentation":"

The reason for the state change request.

" } } }, "SubmitTaskStateChangeResponse":{ "type":"structure", "members":{ "acknowledgment":{ "shape":"String", "documentation":"

Acknowledgement of the state change.

" } } }, "TargetNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and region-specific.

", "exception":true }, "TargetType":{ "type":"string", "enum":["container-instance"] }, "Task":{ "type":"structure", "members":{ "taskArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the task.

" }, "clusterArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the cluster that hosts the task.

" }, "taskDefinitionArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the task definition that creates the task.

" }, "containerInstanceArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the container instances that host the task.

" }, "overrides":{ "shape":"TaskOverride", "documentation":"

One or more container overrides.

" }, "lastStatus":{ "shape":"String", "documentation":"

The last known status of the task.

" }, "desiredStatus":{ "shape":"String", "documentation":"

The desired status of the task.

" }, "containers":{ "shape":"Containers", "documentation":"

The containers associated with the task.

" }, "startedBy":{ "shape":"String", "documentation":"

The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

" }, "version":{ "shape":"Long", "documentation":"

The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch events, you can compare the version of a task reported by the Amazon ECS APIs with the version reported in CloudWatch events for the task (inside the detail object) to verify that the version in your event stream is current.

" }, "stoppedReason":{ "shape":"String", "documentation":"

The reason the task was stopped.

" }, "createdAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for when the task was created (the task entered the PENDING state).

" }, "startedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for when the task was started (the task transitioned from the PENDING state to the RUNNING state).

" }, "stoppedAt":{ "shape":"Timestamp", "documentation":"

The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).

" }, "group":{ "shape":"String", "documentation":"

The name of the task group associated with the task.

" } }, "documentation":"

Details on a task in a cluster.

" }, "TaskDefinition":{ "type":"structure", "members":{ "taskDefinitionArn":{ "shape":"String", "documentation":"

The full Amazon Resource Name (ARN) of the task definition.

" }, "containerDefinitions":{ "shape":"ContainerDefinitions", "documentation":"

A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

" }, "family":{ "shape":"String", "documentation":"

The family of your task definition, used as the definition name.

" }, "taskRoleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.

" }, "networkMode":{ "shape":"NetworkMode", "documentation":"

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, and host.

If the network mode is none, the containers do not have external connectivity. The default Docker network mode is bridge. The host network mode offers the highest networking performance for containers because it uses the host network stack instead of the virtualized network stack provided by the bridge mode.

For more information, see Network settings in the Docker run reference.

" }, "revision":{ "shape":"Integer", "documentation":"

The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1; each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family).

" }, "volumes":{ "shape":"VolumeList", "documentation":"

The list of volumes in a task. For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide.

" }, "status":{ "shape":"TaskDefinitionStatus", "documentation":"

The status of the task definition.

" }, "requiresAttributes":{ "shape":"RequiresAttributes", "documentation":"

The container instance attributes required by your task.

" }, "placementConstraints":{ "shape":"TaskDefinitionPlacementConstraints", "documentation":"

An array of placement constraint objects to use for tasks.

" } }, "documentation":"

Details of a task definition.

" }, "TaskDefinitionFamilyStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE", "ALL" ] }, "TaskDefinitionPlacementConstraint":{ "type":"structure", "members":{ "type":{ "shape":"TaskDefinitionPlacementConstraintType", "documentation":"

The type of constraint. The DistinctInstance constraint ensures that each task in a particular group is running on a different container instance. The MemberOf constraint restricts selection to be from a group of valid candidates.

" }, "expression":{ "shape":"String", "documentation":"

A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.

" } }, "documentation":"

An object representing a constraint on task placement in the task definition. For more information, see Task Placement Constraints in the Amazon EC2 Container Service Developer Guide.

" }, "TaskDefinitionPlacementConstraintType":{ "type":"string", "enum":["memberOf"] }, "TaskDefinitionPlacementConstraints":{ "type":"list", "member":{"shape":"TaskDefinitionPlacementConstraint"} }, "TaskDefinitionStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] }, "TaskOverride":{ "type":"structure", "members":{ "containerOverrides":{ "shape":"ContainerOverrides", "documentation":"

One or more container overrides sent to a task.

" }, "taskRoleArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.

" } }, "documentation":"

The overrides associated with a task.

" }, "Tasks":{ "type":"list", "member":{"shape":"Task"} }, "Timestamp":{"type":"timestamp"}, "TransportProtocol":{ "type":"string", "enum":[ "tcp", "udp" ] }, "Ulimit":{ "type":"structure", "required":[ "name", "softLimit", "hardLimit" ], "members":{ "name":{ "shape":"UlimitName", "documentation":"

The type of the ulimit.

" }, "softLimit":{ "shape":"Integer", "documentation":"

The soft limit for the ulimit type.

" }, "hardLimit":{ "shape":"Integer", "documentation":"

The hard limit for the ulimit type.

" } }, "documentation":"

The ulimit settings to pass to the container.

" }, "UlimitList":{ "type":"list", "member":{"shape":"Ulimit"} }, "UlimitName":{ "type":"string", "enum":[ "core", "cpu", "data", "fsize", "locks", "memlock", "msgqueue", "nice", "nofile", "nproc", "rss", "rtprio", "rttime", "sigpending", "stack" ] }, "UpdateContainerAgentRequest":{ "type":"structure", "required":["containerInstance"], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.

" }, "containerInstance":{ "shape":"String", "documentation":"

The container instance ID or full Amazon Resource Name (ARN) entries for the container instance on which you would like to update the Amazon ECS container agent.

" } } }, "UpdateContainerAgentResponse":{ "type":"structure", "members":{ "containerInstance":{ "shape":"ContainerInstance", "documentation":"

The container instance for which the container agent was updated.

" } } }, "UpdateContainerInstancesStateRequest":{ "type":"structure", "required":[ "containerInstances", "status" ], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.

" }, "containerInstances":{ "shape":"StringList", "documentation":"

A space-separated list of container instance IDs or full Amazon Resource Name (ARN) entries.

" }, "status":{ "shape":"ContainerInstanceStatus", "documentation":"

The container instance state with which to update the container instance.

" } } }, "UpdateContainerInstancesStateResponse":{ "type":"structure", "members":{ "containerInstances":{ "shape":"ContainerInstances", "documentation":"

The list of container instances.

" }, "failures":{ "shape":"Failures", "documentation":"

Any failures associated with the call.

" } } }, "UpdateInProgressException":{ "type":"structure", "members":{ }, "documentation":"

There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

", "exception":true }, "UpdateServiceRequest":{ "type":"structure", "required":["service"], "members":{ "cluster":{ "shape":"String", "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.

" }, "service":{ "shape":"String", "documentation":"

The name of the service to update.

" }, "desiredCount":{ "shape":"BoxedInteger", "documentation":"

The number of instantiations of the task to place and keep running in your service.

" }, "taskDefinition":{ "shape":"String", "documentation":"

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

" }, "deploymentConfiguration":{ "shape":"DeploymentConfiguration", "documentation":"

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

" } } }, "UpdateServiceResponse":{ "type":"structure", "members":{ "service":{ "shape":"Service", "documentation":"

The full description of your service following the update call.

" } } }, "VersionInfo":{ "type":"structure", "members":{ "agentVersion":{ "shape":"String", "documentation":"

The version number of the Amazon ECS container agent.

" }, "agentHash":{ "shape":"String", "documentation":"

The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

" }, "dockerVersion":{ "shape":"String", "documentation":"

The Docker version running on the container instance.

" } }, "documentation":"

The Docker and Amazon ECS container agent version information about a container instance.

" }, "Volume":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

" }, "host":{ "shape":"HostVolumeProperties", "documentation":"

The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.

" } }, "documentation":"

A data volume used in a task definition.

" }, "VolumeFrom":{ "type":"structure", "members":{ "sourceContainer":{ "shape":"String", "documentation":"

The name of the container to mount volumes from.

" }, "readOnly":{ "shape":"BoxedBoolean", "documentation":"

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

" } }, "documentation":"

Details on a data volume from another container.

" }, "VolumeFromList":{ "type":"list", "member":{"shape":"VolumeFrom"} }, "VolumeList":{ "type":"list", "member":{"shape":"Volume"} } }, "documentation":"

Amazon EC2 Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles.

You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.

" } botocore-1.5.7/botocore/data/s3/0000777454262600001440000000000013042511307017460 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/s3/2006-03-01/0000777454262600001440000000000013042511307020505 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/s3/2006-03-01/waiters-2.json0000666454262600001440000000230413042511306023213 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "BucketExists": { "delay": 5, "operation": "HeadBucket", "maxAttempts": 20, "acceptors": [ { "expected": 200, "matcher": "status", "state": "success" }, { "expected": 404, "matcher": "status", "state": "retry" } ] }, "BucketNotExists": { "delay": 5, "operation": "HeadBucket", "maxAttempts": 20, "acceptors": [ { "expected": 404, "matcher": "status", "state": "success" } ] }, "ObjectExists": { "delay": 5, "operation": "HeadObject", "maxAttempts": 20, "acceptors": [ { "expected": 200, "matcher": "status", "state": "success" }, { "expected": 404, "matcher": "status", "state": "retry" } ] }, "ObjectNotExists": { "delay": 5, "operation": "HeadObject", "maxAttempts": 20, "acceptors": [ { "expected": 404, "matcher": "status", "state": "success" } ] } } } botocore-1.5.7/botocore/data/s3/2006-03-01/paginators-1.json0000666454262600001440000000303713042511306023707 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListMultipartUploads": { "limit_key": "MaxUploads", "more_results": "IsTruncated", "output_token": [ "NextKeyMarker", "NextUploadIdMarker" ], "input_token": [ "KeyMarker", "UploadIdMarker" ], "result_key": [ "Uploads", "CommonPrefixes" ] }, "ListObjectVersions": { "more_results": "IsTruncated", "limit_key": "MaxKeys", "output_token": [ "NextKeyMarker", "NextVersionIdMarker" ], "input_token": [ "KeyMarker", "VersionIdMarker" ], "result_key": [ "Versions", "DeleteMarkers", "CommonPrefixes" ] }, "ListObjects": { "more_results": "IsTruncated", "limit_key": "MaxKeys", "output_token": "NextMarker || Contents[-1].Key", "input_token": "Marker", "result_key": [ "Contents", "CommonPrefixes" ] }, "ListObjectsV2": { "more_results": "IsTruncated", "limit_key": "MaxKeys", "output_token": "NextContinuationToken", "input_token": "ContinuationToken", "result_key": [ "Contents", "CommonPrefixes" ] }, "ListParts": { "more_results": "IsTruncated", "limit_key": "MaxParts", "output_token": "NextPartNumberMarker", "input_token": "PartNumberMarker", "result_key": "Parts", "non_aggregate_keys": [ "Initiator", "Owner", "StorageClass" ] } } } botocore-1.5.7/botocore/data/s3/2006-03-01/service-2.json0000666454262600001440000070100013042511306023174 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2006-03-01", "checksumFormat":"md5", "endpointPrefix":"s3", "globalEndpoint":"s3.amazonaws.com", "protocol":"rest-xml", "serviceAbbreviation":"Amazon S3", "serviceFullName":"Amazon Simple Storage Service", "signatureVersion":"s3", "timestampFormat":"rfc822", "uid":"s3-2006-03-01" }, "operations":{ "AbortMultipartUpload":{ "name":"AbortMultipartUpload", "http":{ "method":"DELETE", "requestUri":"/{Bucket}/{Key+}" }, "input":{"shape":"AbortMultipartUploadRequest"}, "output":{"shape":"AbortMultipartUploadOutput"}, "errors":[ {"shape":"NoSuchUpload"} ], "documentationUrl":"http://docs.amazonwebservices.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", "requestUri":"/{Bucket}/{Key+}" }, "input":{"shape":"CompleteMultipartUploadRequest"}, "output":{"shape":"CompleteMultipartUploadOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadComplete.html", "documentation":"Completes a multipart upload by assembling previously uploaded parts." }, "CopyObject":{ "name":"CopyObject", "http":{ "method":"PUT", "requestUri":"/{Bucket}/{Key+}" }, "input":{"shape":"CopyObjectRequest"}, "output":{"shape":"CopyObjectOutput"}, "errors":[ {"shape":"ObjectNotInActiveTierError"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectCOPY.html", "documentation":"Creates a copy of an object that is already stored in Amazon S3.", "alias":"PutObjectCopy" }, "CreateBucket":{ "name":"CreateBucket", "http":{ "method":"PUT", "requestUri":"/{Bucket}" }, "input":{"shape":"CreateBucketRequest"}, "output":{"shape":"CreateBucketOutput"}, "errors":[ {"shape":"BucketAlreadyExists"}, {"shape":"BucketAlreadyOwnedByYou"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html", "documentation":"Creates a new bucket.", "alias":"PutBucket" }, "CreateMultipartUpload":{ "name":"CreateMultipartUpload", "http":{ "method":"POST", "requestUri":"/{Bucket}/{Key+}?uploads" }, "input":{"shape":"CreateMultipartUploadRequest"}, "output":{"shape":"CreateMultipartUploadOutput"}, "documentationUrl":"http://docs.amazonwebservices.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.

", "alias":"InitiateMultipartUpload" }, "DeleteBucket":{ "name":"DeleteBucket", "http":{ "method":"DELETE", "requestUri":"/{Bucket}" }, "input":{"shape":"DeleteBucketRequest"}, "documentationUrl":"http://docs.amazonwebservices.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." }, "DeleteBucketAnalyticsConfiguration":{ "name":"DeleteBucketAnalyticsConfiguration", "http":{ "method":"DELETE", "requestUri":"/{Bucket}?analytics" }, "input":{"shape":"DeleteBucketAnalyticsConfigurationRequest"}, "documentation":"Deletes an analytics configuration for the bucket (specified by the analytics configuration ID)." }, "DeleteBucketCors":{ "name":"DeleteBucketCors", "http":{ "method":"DELETE", "requestUri":"/{Bucket}?cors" }, "input":{"shape":"DeleteBucketCorsRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEcors.html", "documentation":"Deletes the cors configuration information set for the bucket." }, "DeleteBucketInventoryConfiguration":{ "name":"DeleteBucketInventoryConfiguration", "http":{ "method":"DELETE", "requestUri":"/{Bucket}?inventory" }, "input":{"shape":"DeleteBucketInventoryConfigurationRequest"}, "documentation":"Deletes an inventory configuration (identified by the inventory ID) from the bucket." }, "DeleteBucketLifecycle":{ "name":"DeleteBucketLifecycle", "http":{ "method":"DELETE", "requestUri":"/{Bucket}?lifecycle" }, "input":{"shape":"DeleteBucketLifecycleRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETElifecycle.html", "documentation":"Deletes the lifecycle configuration from the bucket." }, "DeleteBucketMetricsConfiguration":{ "name":"DeleteBucketMetricsConfiguration", "http":{ "method":"DELETE", "requestUri":"/{Bucket}?metrics" }, "input":{"shape":"DeleteBucketMetricsConfigurationRequest"}, "documentation":"Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket." }, "DeleteBucketPolicy":{ "name":"DeleteBucketPolicy", "http":{ "method":"DELETE", "requestUri":"/{Bucket}?policy" }, "input":{"shape":"DeleteBucketPolicyRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEpolicy.html", "documentation":"Deletes the policy from the bucket." }, "DeleteBucketReplication":{ "name":"DeleteBucketReplication", "http":{ "method":"DELETE", "requestUri":"/{Bucket}?replication" }, "input":{"shape":"DeleteBucketReplicationRequest"}, "documentation":"Deletes the replication configuration from the bucket." }, "DeleteBucketTagging":{ "name":"DeleteBucketTagging", "http":{ "method":"DELETE", "requestUri":"/{Bucket}?tagging" }, "input":{"shape":"DeleteBucketTaggingRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEtagging.html", "documentation":"Deletes the tags from the bucket." }, "DeleteBucketWebsite":{ "name":"DeleteBucketWebsite", "http":{ "method":"DELETE", "requestUri":"/{Bucket}?website" }, "input":{"shape":"DeleteBucketWebsiteRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEwebsite.html", "documentation":"This operation removes the website configuration from the bucket." }, "DeleteObject":{ "name":"DeleteObject", "http":{ "method":"DELETE", "requestUri":"/{Bucket}/{Key+}" }, "input":{"shape":"DeleteObjectRequest"}, "output":{"shape":"DeleteObjectOutput"}, "documentationUrl":"http://docs.amazonwebservices.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." }, "DeleteObjectTagging":{ "name":"DeleteObjectTagging", "http":{ "method":"DELETE", "requestUri":"/{Bucket}/{Key+}?tagging" }, "input":{"shape":"DeleteObjectTaggingRequest"}, "output":{"shape":"DeleteObjectTaggingOutput"}, "documentation":"Removes the tag-set from an existing object." }, "DeleteObjects":{ "name":"DeleteObjects", "http":{ "method":"POST", "requestUri":"/{Bucket}?delete" }, "input":{"shape":"DeleteObjectsRequest"}, "output":{"shape":"DeleteObjectsOutput"}, "documentationUrl":"http://docs.amazonwebservices.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.", "alias":"DeleteMultipleObjects" }, "GetBucketAccelerateConfiguration":{ "name":"GetBucketAccelerateConfiguration", "http":{ "method":"GET", "requestUri":"/{Bucket}?accelerate" }, "input":{"shape":"GetBucketAccelerateConfigurationRequest"}, "output":{"shape":"GetBucketAccelerateConfigurationOutput"}, "documentation":"Returns the accelerate configuration of a bucket." }, "GetBucketAcl":{ "name":"GetBucketAcl", "http":{ "method":"GET", "requestUri":"/{Bucket}?acl" }, "input":{"shape":"GetBucketAclRequest"}, "output":{"shape":"GetBucketAclOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html", "documentation":"Gets the access control policy for the bucket." }, "GetBucketAnalyticsConfiguration":{ "name":"GetBucketAnalyticsConfiguration", "http":{ "method":"GET", "requestUri":"/{Bucket}?analytics" }, "input":{"shape":"GetBucketAnalyticsConfigurationRequest"}, "output":{"shape":"GetBucketAnalyticsConfigurationOutput"}, "documentation":"Gets an analytics configuration for the bucket (specified by the analytics configuration ID)." }, "GetBucketCors":{ "name":"GetBucketCors", "http":{ "method":"GET", "requestUri":"/{Bucket}?cors" }, "input":{"shape":"GetBucketCorsRequest"}, "output":{"shape":"GetBucketCorsOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html", "documentation":"Returns the cors configuration for the bucket." }, "GetBucketInventoryConfiguration":{ "name":"GetBucketInventoryConfiguration", "http":{ "method":"GET", "requestUri":"/{Bucket}?inventory" }, "input":{"shape":"GetBucketInventoryConfigurationRequest"}, "output":{"shape":"GetBucketInventoryConfigurationOutput"}, "documentation":"Returns an inventory configuration (identified by the inventory ID) from the bucket." }, "GetBucketLifecycle":{ "name":"GetBucketLifecycle", "http":{ "method":"GET", "requestUri":"/{Bucket}?lifecycle" }, "input":{"shape":"GetBucketLifecycleRequest"}, "output":{"shape":"GetBucketLifecycleOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html", "documentation":"Deprecated, see the GetBucketLifecycleConfiguration operation.", "deprecated":true }, "GetBucketLifecycleConfiguration":{ "name":"GetBucketLifecycleConfiguration", "http":{ "method":"GET", "requestUri":"/{Bucket}?lifecycle" }, "input":{"shape":"GetBucketLifecycleConfigurationRequest"}, "output":{"shape":"GetBucketLifecycleConfigurationOutput"}, "documentation":"Returns the lifecycle configuration information set on the bucket." }, "GetBucketLocation":{ "name":"GetBucketLocation", "http":{ "method":"GET", "requestUri":"/{Bucket}?location" }, "input":{"shape":"GetBucketLocationRequest"}, "output":{"shape":"GetBucketLocationOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html", "documentation":"Returns the region the bucket resides in." }, "GetBucketLogging":{ "name":"GetBucketLogging", "http":{ "method":"GET", "requestUri":"/{Bucket}?logging" }, "input":{"shape":"GetBucketLoggingRequest"}, "output":{"shape":"GetBucketLoggingOutput"}, "documentationUrl":"http://docs.amazonwebservices.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." }, "GetBucketMetricsConfiguration":{ "name":"GetBucketMetricsConfiguration", "http":{ "method":"GET", "requestUri":"/{Bucket}?metrics" }, "input":{"shape":"GetBucketMetricsConfigurationRequest"}, "output":{"shape":"GetBucketMetricsConfigurationOutput"}, "documentation":"Gets a metrics configuration (specified by the metrics configuration ID) from the bucket." }, "GetBucketNotification":{ "name":"GetBucketNotification", "http":{ "method":"GET", "requestUri":"/{Bucket}?notification" }, "input":{"shape":"GetBucketNotificationConfigurationRequest"}, "output":{"shape":"NotificationConfigurationDeprecated"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETnotification.html", "documentation":"Deprecated, see the GetBucketNotificationConfiguration operation.", "deprecated":true }, "GetBucketNotificationConfiguration":{ "name":"GetBucketNotificationConfiguration", "http":{ "method":"GET", "requestUri":"/{Bucket}?notification" }, "input":{"shape":"GetBucketNotificationConfigurationRequest"}, "output":{"shape":"NotificationConfiguration"}, "documentation":"Returns the notification configuration of a bucket." }, "GetBucketPolicy":{ "name":"GetBucketPolicy", "http":{ "method":"GET", "requestUri":"/{Bucket}?policy" }, "input":{"shape":"GetBucketPolicyRequest"}, "output":{"shape":"GetBucketPolicyOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html", "documentation":"Returns the policy of a specified bucket." }, "GetBucketReplication":{ "name":"GetBucketReplication", "http":{ "method":"GET", "requestUri":"/{Bucket}?replication" }, "input":{"shape":"GetBucketReplicationRequest"}, "output":{"shape":"GetBucketReplicationOutput"}, "documentation":"Returns the replication configuration of a bucket." }, "GetBucketRequestPayment":{ "name":"GetBucketRequestPayment", "http":{ "method":"GET", "requestUri":"/{Bucket}?requestPayment" }, "input":{"shape":"GetBucketRequestPaymentRequest"}, "output":{"shape":"GetBucketRequestPaymentOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html", "documentation":"Returns the request payment configuration of a bucket." }, "GetBucketTagging":{ "name":"GetBucketTagging", "http":{ "method":"GET", "requestUri":"/{Bucket}?tagging" }, "input":{"shape":"GetBucketTaggingRequest"}, "output":{"shape":"GetBucketTaggingOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETtagging.html", "documentation":"Returns the tag set associated with the bucket." }, "GetBucketVersioning":{ "name":"GetBucketVersioning", "http":{ "method":"GET", "requestUri":"/{Bucket}?versioning" }, "input":{"shape":"GetBucketVersioningRequest"}, "output":{"shape":"GetBucketVersioningOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html", "documentation":"Returns the versioning state of a bucket." }, "GetBucketWebsite":{ "name":"GetBucketWebsite", "http":{ "method":"GET", "requestUri":"/{Bucket}?website" }, "input":{"shape":"GetBucketWebsiteRequest"}, "output":{"shape":"GetBucketWebsiteOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html", "documentation":"Returns the website configuration for a bucket." }, "GetObject":{ "name":"GetObject", "http":{ "method":"GET", "requestUri":"/{Bucket}/{Key+}" }, "input":{"shape":"GetObjectRequest"}, "output":{"shape":"GetObjectOutput"}, "errors":[ {"shape":"NoSuchKey"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html", "documentation":"Retrieves objects from Amazon S3." }, "GetObjectAcl":{ "name":"GetObjectAcl", "http":{ "method":"GET", "requestUri":"/{Bucket}/{Key+}?acl" }, "input":{"shape":"GetObjectAclRequest"}, "output":{"shape":"GetObjectAclOutput"}, "errors":[ {"shape":"NoSuchKey"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETacl.html", "documentation":"Returns the access control list (ACL) of an object." }, "GetObjectTagging":{ "name":"GetObjectTagging", "http":{ "method":"GET", "requestUri":"/{Bucket}/{Key+}?tagging" }, "input":{"shape":"GetObjectTaggingRequest"}, "output":{"shape":"GetObjectTaggingOutput"}, "documentation":"Returns the tag-set of an object." }, "GetObjectTorrent":{ "name":"GetObjectTorrent", "http":{ "method":"GET", "requestUri":"/{Bucket}/{Key+}?torrent" }, "input":{"shape":"GetObjectTorrentRequest"}, "output":{"shape":"GetObjectTorrentOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETtorrent.html", "documentation":"Return torrent files from a bucket." }, "HeadBucket":{ "name":"HeadBucket", "http":{ "method":"HEAD", "requestUri":"/{Bucket}" }, "input":{"shape":"HeadBucketRequest"}, "errors":[ {"shape":"NoSuchBucket"} ], "documentationUrl":"http://docs.amazonwebservices.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", "requestUri":"/{Bucket}/{Key+}" }, "input":{"shape":"HeadObjectRequest"}, "output":{"shape":"HeadObjectOutput"}, "errors":[ {"shape":"NoSuchKey"} ], "documentationUrl":"http://docs.amazonwebservices.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." }, "ListBucketAnalyticsConfigurations":{ "name":"ListBucketAnalyticsConfigurations", "http":{ "method":"GET", "requestUri":"/{Bucket}?analytics" }, "input":{"shape":"ListBucketAnalyticsConfigurationsRequest"}, "output":{"shape":"ListBucketAnalyticsConfigurationsOutput"}, "documentation":"Lists the analytics configurations for the bucket." }, "ListBucketInventoryConfigurations":{ "name":"ListBucketInventoryConfigurations", "http":{ "method":"GET", "requestUri":"/{Bucket}?inventory" }, "input":{"shape":"ListBucketInventoryConfigurationsRequest"}, "output":{"shape":"ListBucketInventoryConfigurationsOutput"}, "documentation":"Returns a list of inventory configurations for the bucket." }, "ListBucketMetricsConfigurations":{ "name":"ListBucketMetricsConfigurations", "http":{ "method":"GET", "requestUri":"/{Bucket}?metrics" }, "input":{"shape":"ListBucketMetricsConfigurationsRequest"}, "output":{"shape":"ListBucketMetricsConfigurationsOutput"}, "documentation":"Lists the metrics configurations for the bucket." }, "ListBuckets":{ "name":"ListBuckets", "http":{ "method":"GET", "requestUri":"/" }, "output":{"shape":"ListBucketsOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html", "documentation":"Returns a list of all buckets owned by the authenticated sender of the request.", "alias":"GetService" }, "ListMultipartUploads":{ "name":"ListMultipartUploads", "http":{ "method":"GET", "requestUri":"/{Bucket}?uploads" }, "input":{"shape":"ListMultipartUploadsRequest"}, "output":{"shape":"ListMultipartUploadsOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html", "documentation":"This operation lists in-progress multipart uploads." }, "ListObjectVersions":{ "name":"ListObjectVersions", "http":{ "method":"GET", "requestUri":"/{Bucket}?versions" }, "input":{"shape":"ListObjectVersionsRequest"}, "output":{"shape":"ListObjectVersionsOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html", "documentation":"Returns metadata about all of the versions of objects in a bucket.", "alias":"GetBucketObjectVersions" }, "ListObjects":{ "name":"ListObjects", "http":{ "method":"GET", "requestUri":"/{Bucket}" }, "input":{"shape":"ListObjectsRequest"}, "output":{"shape":"ListObjectsOutput"}, "errors":[ {"shape":"NoSuchBucket"} ], "documentationUrl":"http://docs.amazonwebservices.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.", "alias":"GetBucket" }, "ListObjectsV2":{ "name":"ListObjectsV2", "http":{ "method":"GET", "requestUri":"/{Bucket}?list-type=2" }, "input":{"shape":"ListObjectsV2Request"}, "output":{"shape":"ListObjectsV2Output"}, "errors":[ {"shape":"NoSuchBucket"} ], "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. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development." }, "ListParts":{ "name":"ListParts", "http":{ "method":"GET", "requestUri":"/{Bucket}/{Key+}" }, "input":{"shape":"ListPartsRequest"}, "output":{"shape":"ListPartsOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html", "documentation":"Lists the parts that have been uploaded for a specific multipart upload." }, "PutBucketAccelerateConfiguration":{ "name":"PutBucketAccelerateConfiguration", "http":{ "method":"PUT", "requestUri":"/{Bucket}?accelerate" }, "input":{"shape":"PutBucketAccelerateConfigurationRequest"}, "documentation":"Sets the accelerate configuration of an existing bucket." }, "PutBucketAcl":{ "name":"PutBucketAcl", "http":{ "method":"PUT", "requestUri":"/{Bucket}?acl" }, "input":{"shape":"PutBucketAclRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html", "documentation":"Sets the permissions on a bucket using access control lists (ACL)." }, "PutBucketAnalyticsConfiguration":{ "name":"PutBucketAnalyticsConfiguration", "http":{ "method":"PUT", "requestUri":"/{Bucket}?analytics" }, "input":{"shape":"PutBucketAnalyticsConfigurationRequest"}, "documentation":"Sets an analytics configuration for the bucket (specified by the analytics configuration ID)." }, "PutBucketCors":{ "name":"PutBucketCors", "http":{ "method":"PUT", "requestUri":"/{Bucket}?cors" }, "input":{"shape":"PutBucketCorsRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTcors.html", "documentation":"Sets the cors configuration for a bucket." }, "PutBucketInventoryConfiguration":{ "name":"PutBucketInventoryConfiguration", "http":{ "method":"PUT", "requestUri":"/{Bucket}?inventory" }, "input":{"shape":"PutBucketInventoryConfigurationRequest"}, "documentation":"Adds an inventory configuration (identified by the inventory ID) from the bucket." }, "PutBucketLifecycle":{ "name":"PutBucketLifecycle", "http":{ "method":"PUT", "requestUri":"/{Bucket}?lifecycle" }, "input":{"shape":"PutBucketLifecycleRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html", "documentation":"Deprecated, see the PutBucketLifecycleConfiguration operation.", "deprecated":true }, "PutBucketLifecycleConfiguration":{ "name":"PutBucketLifecycleConfiguration", "http":{ "method":"PUT", "requestUri":"/{Bucket}?lifecycle" }, "input":{"shape":"PutBucketLifecycleConfigurationRequest"}, "documentation":"Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it." }, "PutBucketLogging":{ "name":"PutBucketLogging", "http":{ "method":"PUT", "requestUri":"/{Bucket}?logging" }, "input":{"shape":"PutBucketLoggingRequest"}, "documentationUrl":"http://docs.amazonwebservices.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." }, "PutBucketMetricsConfiguration":{ "name":"PutBucketMetricsConfiguration", "http":{ "method":"PUT", "requestUri":"/{Bucket}?metrics" }, "input":{"shape":"PutBucketMetricsConfigurationRequest"}, "documentation":"Sets a metrics configuration (specified by the metrics configuration ID) for the bucket." }, "PutBucketNotification":{ "name":"PutBucketNotification", "http":{ "method":"PUT", "requestUri":"/{Bucket}?notification" }, "input":{"shape":"PutBucketNotificationRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTnotification.html", "documentation":"Deprecated, see the PutBucketNotificationConfiguraiton operation.", "deprecated":true }, "PutBucketNotificationConfiguration":{ "name":"PutBucketNotificationConfiguration", "http":{ "method":"PUT", "requestUri":"/{Bucket}?notification" }, "input":{"shape":"PutBucketNotificationConfigurationRequest"}, "documentation":"Enables notifications of specified events for a bucket." }, "PutBucketPolicy":{ "name":"PutBucketPolicy", "http":{ "method":"PUT", "requestUri":"/{Bucket}?policy" }, "input":{"shape":"PutBucketPolicyRequest"}, "documentationUrl":"http://docs.amazonwebservices.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." }, "PutBucketReplication":{ "name":"PutBucketReplication", "http":{ "method":"PUT", "requestUri":"/{Bucket}?replication" }, "input":{"shape":"PutBucketReplicationRequest"}, "documentation":"Creates a new replication configuration (or replaces an existing one, if present)." }, "PutBucketRequestPayment":{ "name":"PutBucketRequestPayment", "http":{ "method":"PUT", "requestUri":"/{Bucket}?requestPayment" }, "input":{"shape":"PutBucketRequestPaymentRequest"}, "documentationUrl":"http://docs.amazonwebservices.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. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html" }, "PutBucketTagging":{ "name":"PutBucketTagging", "http":{ "method":"PUT", "requestUri":"/{Bucket}?tagging" }, "input":{"shape":"PutBucketTaggingRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTtagging.html", "documentation":"Sets the tags for a bucket." }, "PutBucketVersioning":{ "name":"PutBucketVersioning", "http":{ "method":"PUT", "requestUri":"/{Bucket}?versioning" }, "input":{"shape":"PutBucketVersioningRequest"}, "documentationUrl":"http://docs.amazonwebservices.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", "requestUri":"/{Bucket}?website" }, "input":{"shape":"PutBucketWebsiteRequest"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html", "documentation":"Set the website configuration for a bucket." }, "PutObject":{ "name":"PutObject", "http":{ "method":"PUT", "requestUri":"/{Bucket}/{Key+}" }, "input":{"shape":"PutObjectRequest"}, "output":{"shape":"PutObjectOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUT.html", "documentation":"Adds an object to a bucket." }, "PutObjectAcl":{ "name":"PutObjectAcl", "http":{ "method":"PUT", "requestUri":"/{Bucket}/{Key+}?acl" }, "input":{"shape":"PutObjectAclRequest"}, "output":{"shape":"PutObjectAclOutput"}, "errors":[ {"shape":"NoSuchKey"} ], "documentationUrl":"http://docs.amazonwebservices.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" }, "PutObjectTagging":{ "name":"PutObjectTagging", "http":{ "method":"PUT", "requestUri":"/{Bucket}/{Key+}?tagging" }, "input":{"shape":"PutObjectTaggingRequest"}, "output":{"shape":"PutObjectTaggingOutput"}, "documentation":"Sets the supplied tag-set to an object that already exists in a bucket" }, "RestoreObject":{ "name":"RestoreObject", "http":{ "method":"POST", "requestUri":"/{Bucket}/{Key+}?restore" }, "input":{"shape":"RestoreObjectRequest"}, "output":{"shape":"RestoreObjectOutput"}, "errors":[ {"shape":"ObjectAlreadyInActiveTierError"} ], "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectRestore.html", "documentation":"Restores an archived copy of an object back into Amazon S3", "alias":"PostObjectRestore" }, "UploadPart":{ "name":"UploadPart", "http":{ "method":"PUT", "requestUri":"/{Bucket}/{Key+}" }, "input":{"shape":"UploadPartRequest"}, "output":{"shape":"UploadPartOutput"}, "documentationUrl":"http://docs.amazonwebservices.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", "requestUri":"/{Bucket}/{Key+}" }, "input":{"shape":"UploadPartCopyRequest"}, "output":{"shape":"UploadPartCopyOutput"}, "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPartCopy.html", "documentation":"Uploads a part by copying data from an existing object as data source." } }, "shapes":{ "AbortDate":{"type":"timestamp"}, "AbortIncompleteMultipartUpload":{ "type":"structure", "members":{ "DaysAfterInitiation":{ "shape":"DaysAfterInitiation", "documentation":"Indicates the number of days that must pass since initiation for Lifecycle to abort an Incomplete Multipart Upload." } }, "documentation":"Specifies the days since the initiation of an Incomplete Multipart Upload that Lifecycle will wait before permanently removing all parts of the upload." }, "AbortMultipartUploadOutput":{ "type":"structure", "members":{ "RequestCharged":{ "shape":"RequestCharged", "location":"header", "locationName":"x-amz-request-charged" } } }, "AbortMultipartUploadRequest":{ "type":"structure", "required":[ "Bucket", "Key", "UploadId" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "Key":{ "shape":"ObjectKey", "location":"uri", "locationName":"Key" }, "UploadId":{ "shape":"MultipartUploadId", "location":"querystring", "locationName":"uploadId" }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", "locationName":"x-amz-request-payer" } } }, "AbortRuleId":{"type":"string"}, "AccelerateConfiguration":{ "type":"structure", "members":{ "Status":{ "shape":"BucketAccelerateStatus", "documentation":"The accelerate configuration of the bucket." } } }, "AcceptRanges":{"type":"string"}, "AccessControlPolicy":{ "type":"structure", "members":{ "Grants":{ "shape":"Grants", "documentation":"A list of grants.", "locationName":"AccessControlList" }, "Owner":{"shape":"Owner"} } }, "AccountId":{"type":"string"}, "AllowedHeader":{"type":"string"}, "AllowedHeaders":{ "type":"list", "member":{"shape":"AllowedHeader"}, "flattened":true }, "AllowedMethod":{"type":"string"}, "AllowedMethods":{ "type":"list", "member":{"shape":"AllowedMethod"}, "flattened":true }, "AllowedOrigin":{"type":"string"}, "AllowedOrigins":{ "type":"list", "member":{"shape":"AllowedOrigin"}, "flattened":true }, "AnalyticsAndOperator":{ "type":"structure", "members":{ "Prefix":{ "shape":"Prefix", "documentation":"The prefix to use when evaluating an AND predicate." }, "Tags":{ "shape":"TagSet", "documentation":"The list of tags to use when evaluating an AND predicate.", "flattened":true, "locationName":"Tag" } } }, "AnalyticsConfiguration":{ "type":"structure", "required":[ "Id", "StorageClassAnalysis" ], "members":{ "Id":{ "shape":"AnalyticsId", "documentation":"The identifier used to represent an analytics configuration." }, "Filter":{ "shape":"AnalyticsFilter", "documentation":"The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis." }, "StorageClassAnalysis":{ "shape":"StorageClassAnalysis", "documentation":"If present, it indicates that data related to access patterns will be collected and made available to analyze the tradeoffs between different storage classes." } } }, "AnalyticsConfigurationList":{ "type":"list", "member":{"shape":"AnalyticsConfiguration"}, "flattened":true }, "AnalyticsExportDestination":{ "type":"structure", "required":["S3BucketDestination"], "members":{ "S3BucketDestination":{ "shape":"AnalyticsS3BucketDestination", "documentation":"A destination signifying output to an S3 bucket." } } }, "AnalyticsFilter":{ "type":"structure", "members":{ "Prefix":{ "shape":"Prefix", "documentation":"The prefix to use when evaluating an analytics filter." }, "Tag":{ "shape":"Tag", "documentation":"The tag to use when evaluating an analytics filter." }, "And":{ "shape":"AnalyticsAndOperator", "documentation":"A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates." } } }, "AnalyticsId":{"type":"string"}, "AnalyticsS3BucketDestination":{ "type":"structure", "required":[ "Format", "Bucket" ], "members":{ "Format":{ "shape":"AnalyticsS3ExportFileFormat", "documentation":"The file format used when exporting data to Amazon S3." }, "BucketAccountId":{ "shape":"AccountId", "documentation":"The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data." }, "Bucket":{ "shape":"BucketName", "documentation":"The Amazon resource name (ARN) of the bucket to which data is exported." }, "Prefix":{ "shape":"Prefix", "documentation":"The prefix to use when exporting data. The exported data begins with this prefix." } } }, "AnalyticsS3ExportFileFormat":{ "type":"string", "enum":["CSV"] }, "Body":{"type":"blob"}, "Bucket":{ "type":"structure", "members":{ "Name":{ "shape":"BucketName", "documentation":"The name of the bucket." }, "CreationDate":{ "shape":"CreationDate", "documentation":"Date the bucket was created." } } }, "BucketAccelerateStatus":{ "type":"string", "enum":[ "Enabled", "Suspended" ] }, "BucketAlreadyExists":{ "type":"structure", "members":{ }, "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.", "exception":true }, "BucketAlreadyOwnedByYou":{ "type":"structure", "members":{ }, "exception":true }, "BucketCannedACL":{ "type":"string", "enum":[ "private", "public-read", "public-read-write", "authenticated-read" ] }, "BucketLifecycleConfiguration":{ "type":"structure", "required":["Rules"], "members":{ "Rules":{ "shape":"LifecycleRules", "locationName":"Rule" } } }, "BucketLocationConstraint":{ "type":"string", "enum":[ "EU", "eu-west-1", "us-west-1", "us-west-2", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "sa-east-1", "cn-north-1", "eu-central-1" ] }, "BucketLoggingStatus":{ "type":"structure", "members":{ "LoggingEnabled":{"shape":"LoggingEnabled"} } }, "BucketLogsPermission":{ "type":"string", "enum":[ "FULL_CONTROL", "READ", "WRITE" ] }, "BucketName":{"type":"string"}, "BucketVersioningStatus":{ "type":"string", "enum":[ "Enabled", "Suspended" ] }, "Buckets":{ "type":"list", "member":{ "shape":"Bucket", "locationName":"Bucket" } }, "CORSConfiguration":{ "type":"structure", "required":["CORSRules"], "members":{ "CORSRules":{ "shape":"CORSRules", "locationName":"CORSRule" } } }, "CORSRule":{ "type":"structure", "required":[ "AllowedMethods", "AllowedOrigins" ], "members":{ "AllowedHeaders":{ "shape":"AllowedHeaders", "documentation":"Specifies which headers are allowed in a pre-flight OPTIONS request.", "locationName":"AllowedHeader" }, "AllowedMethods":{ "shape":"AllowedMethods", "documentation":"Identifies HTTP methods that the domain/origin specified in the rule is allowed to execute.", "locationName":"AllowedMethod" }, "AllowedOrigins":{ "shape":"AllowedOrigins", "documentation":"One or more origins you want customers to be able to access the bucket from.", "locationName":"AllowedOrigin" }, "ExposeHeaders":{ "shape":"ExposeHeaders", "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).", "locationName":"ExposeHeader" }, "MaxAgeSeconds":{ "shape":"MaxAgeSeconds", "documentation":"The time in seconds that your browser is to cache the preflight response for the specified resource." } } }, "CORSRules":{ "type":"list", "member":{"shape":"CORSRule"}, "flattened":true }, "CacheControl":{"type":"string"}, "CloudFunction":{"type":"string"}, "CloudFunctionConfiguration":{ "type":"structure", "members":{ "Id":{"shape":"NotificationId"}, "Event":{ "shape":"Event", "deprecated":true }, "Events":{ "shape":"EventList", "locationName":"Event" }, "CloudFunction":{"shape":"CloudFunction"}, "InvocationRole":{"shape":"CloudFunctionInvocationRole"} } }, "CloudFunctionInvocationRole":{"type":"string"}, "Code":{"type":"string"}, "CommonPrefix":{ "type":"structure", "members":{ "Prefix":{"shape":"Prefix"} } }, "CommonPrefixList":{ "type":"list", "member":{"shape":"CommonPrefix"}, "flattened":true }, "CompleteMultipartUploadOutput":{ "type":"structure", "members":{ "Location":{"shape":"Location"}, "Bucket":{"shape":"BucketName"}, "Key":{"shape":"ObjectKey"}, "Expiration":{ "shape":"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.", "location":"header", "locationName":"x-amz-expiration" }, "ETag":{ "shape":"ETag", "documentation":"Entity tag of the object." }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", "location":"header", "locationName":"x-amz-server-side-encryption" }, "VersionId":{ "shape":"ObjectVersionId", "documentation":"Version of the object.", "location":"header", "locationName":"x-amz-version-id" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", "documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "RequestCharged":{ "shape":"RequestCharged", "location":"header", "locationName":"x-amz-request-charged" } } }, "CompleteMultipartUploadRequest":{ "type":"structure", "required":[ "Bucket", "Key", "UploadId" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "Key":{ "shape":"ObjectKey", "location":"uri", "locationName":"Key" }, "MultipartUpload":{ "shape":"CompletedMultipartUpload", "locationName":"CompleteMultipartUpload", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} }, "UploadId":{ "shape":"MultipartUploadId", "location":"querystring", "locationName":"uploadId" }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", "locationName":"x-amz-request-payer" } }, "payload":"MultipartUpload" }, "CompletedMultipartUpload":{ "type":"structure", "members":{ "Parts":{ "shape":"CompletedPartList", "locationName":"Part" } } }, "CompletedPart":{ "type":"structure", "members":{ "ETag":{ "shape":"ETag", "documentation":"Entity tag returned when the part was uploaded." }, "PartNumber":{ "shape":"PartNumber", "documentation":"Part number that identifies the part. This is a positive integer between 1 and 10,000." } } }, "CompletedPartList":{ "type":"list", "member":{"shape":"CompletedPart"}, "flattened":true }, "Condition":{ "type":"structure", "members":{ "HttpErrorCodeReturnedEquals":{ "shape":"HttpErrorCodeReturnedEquals", "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":{ "shape":"KeyPrefixEquals", "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." } } }, "ContentDisposition":{"type":"string"}, "ContentEncoding":{"type":"string"}, "ContentLanguage":{"type":"string"}, "ContentLength":{"type":"long"}, "ContentMD5":{"type":"string"}, "ContentRange":{"type":"string"}, "ContentType":{"type":"string"}, "CopyObjectOutput":{ "type":"structure", "members":{ "CopyObjectResult":{"shape":"CopyObjectResult"}, "Expiration":{ "shape":"Expiration", "documentation":"If the object expiration is configured, the response includes this header.", "location":"header", "locationName":"x-amz-expiration" }, "CopySourceVersionId":{ "shape":"CopySourceVersionId", "location":"header", "locationName":"x-amz-copy-source-version-id" }, "VersionId":{ "shape":"ObjectVersionId", "documentation":"Version ID of the newly created copy.", "location":"header", "locationName":"x-amz-version-id" }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", "location":"header", "locationName":"x-amz-server-side-encryption" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", "documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "RequestCharged":{ "shape":"RequestCharged", "location":"header", "locationName":"x-amz-request-charged" } }, "payload":"CopyObjectResult" }, "CopyObjectRequest":{ "type":"structure", "required":[ "Bucket", "CopySource", "Key" ], "members":{ "ACL":{ "shape":"ObjectCannedACL", "documentation":"The canned ACL to apply to the object.", "location":"header", "locationName":"x-amz-acl" }, "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "CacheControl":{ "shape":"CacheControl", "documentation":"Specifies caching behavior along the request/reply chain.", "location":"header", "locationName":"Cache-Control" }, "ContentDisposition":{ "shape":"ContentDisposition", "documentation":"Specifies presentational information for the object.", "location":"header", "locationName":"Content-Disposition" }, "ContentEncoding":{ "shape":"ContentEncoding", "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.", "location":"header", "locationName":"Content-Encoding" }, "ContentLanguage":{ "shape":"ContentLanguage", "documentation":"The language the content is in.", "location":"header", "locationName":"Content-Language" }, "ContentType":{ "shape":"ContentType", "documentation":"A standard MIME type describing the format of the object data.", "location":"header", "locationName":"Content-Type" }, "CopySource":{ "shape":"CopySource", "documentation":"The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.", "location":"header", "locationName":"x-amz-copy-source" }, "CopySourceIfMatch":{ "shape":"CopySourceIfMatch", "documentation":"Copies the object if its entity tag (ETag) matches the specified tag.", "location":"header", "locationName":"x-amz-copy-source-if-match" }, "CopySourceIfModifiedSince":{ "shape":"CopySourceIfModifiedSince", "documentation":"Copies the object if it has been modified since the specified time.", "location":"header", "locationName":"x-amz-copy-source-if-modified-since" }, "CopySourceIfNoneMatch":{ "shape":"CopySourceIfNoneMatch", "documentation":"Copies the object if its entity tag (ETag) is different than the specified ETag.", "location":"header", "locationName":"x-amz-copy-source-if-none-match" }, "CopySourceIfUnmodifiedSince":{ "shape":"CopySourceIfUnmodifiedSince", "documentation":"Copies the object if it hasn't been modified since the specified time.", "location":"header", "locationName":"x-amz-copy-source-if-unmodified-since" }, "Expires":{ "shape":"Expires", "documentation":"The date and time at which the object is no longer cacheable.", "location":"header", "locationName":"Expires" }, "GrantFullControl":{ "shape":"GrantFullControl", "documentation":"Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.", "location":"header", "locationName":"x-amz-grant-full-control" }, "GrantRead":{ "shape":"GrantRead", "documentation":"Allows grantee to read the object data and its metadata.", "location":"header", "locationName":"x-amz-grant-read" }, "GrantReadACP":{ "shape":"GrantReadACP", "documentation":"Allows grantee to read the object ACL.", "location":"header", "locationName":"x-amz-grant-read-acp" }, "GrantWriteACP":{ "shape":"GrantWriteACP", "documentation":"Allows grantee to write the ACL for the applicable object.", "location":"header", "locationName":"x-amz-grant-write-acp" }, "Key":{ "shape":"ObjectKey", "location":"uri", "locationName":"Key" }, "Metadata":{ "shape":"Metadata", "documentation":"A map of metadata to store with the object in S3.", "location":"headers", "locationName":"x-amz-meta-" }, "MetadataDirective":{ "shape":"MetadataDirective", "documentation":"Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.", "location":"header", "locationName":"x-amz-metadata-directive" }, "TaggingDirective":{ "shape":"TaggingDirective", "documentation":"Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.", "location":"header", "locationName":"x-amz-tagging-directive" }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", "location":"header", "locationName":"x-amz-server-side-encryption" }, "StorageClass":{ "shape":"StorageClass", "documentation":"The type of storage to use for the object. Defaults to 'STANDARD'.", "location":"header", "locationName":"x-amz-storage-class" }, "WebsiteRedirectLocation":{ "shape":"WebsiteRedirectLocation", "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.", "location":"header", "locationName":"x-amz-website-redirect-location" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256).", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", "documentation":"Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "CopySourceSSECustomerAlgorithm":{ "shape":"CopySourceSSECustomerAlgorithm", "documentation":"Specifies the algorithm to use when decrypting the source object (e.g., AES256).", "location":"header", "locationName":"x-amz-copy-source-server-side-encryption-customer-algorithm" }, "CopySourceSSECustomerKey":{ "shape":"CopySourceSSECustomerKey", "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.", "location":"header", "locationName":"x-amz-copy-source-server-side-encryption-customer-key" }, "CopySourceSSECustomerKeyMD5":{ "shape":"CopySourceSSECustomerKeyMD5", "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.", "location":"header", "locationName":"x-amz-copy-source-server-side-encryption-customer-key-MD5" }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", "locationName":"x-amz-request-payer" }, "Tagging":{ "shape":"TaggingHeader", "documentation":"The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters", "location":"header", "locationName":"x-amz-tagging" } } }, "CopyObjectResult":{ "type":"structure", "members":{ "ETag":{"shape":"ETag"}, "LastModified":{"shape":"LastModified"} } }, "CopyPartResult":{ "type":"structure", "members":{ "ETag":{ "shape":"ETag", "documentation":"Entity tag of the object." }, "LastModified":{ "shape":"LastModified", "documentation":"Date and time at which the object was uploaded." } } }, "CopySource":{ "type":"string", "pattern":"\\/.+\\/.+" }, "CopySourceIfMatch":{"type":"string"}, "CopySourceIfModifiedSince":{"type":"timestamp"}, "CopySourceIfNoneMatch":{"type":"string"}, "CopySourceIfUnmodifiedSince":{"type":"timestamp"}, "CopySourceRange":{"type":"string"}, "CopySourceSSECustomerAlgorithm":{"type":"string"}, "CopySourceSSECustomerKey":{ "type":"string", "sensitive":true }, "CopySourceSSECustomerKeyMD5":{"type":"string"}, "CopySourceVersionId":{"type":"string"}, "CreateBucketConfiguration":{ "type":"structure", "members":{ "LocationConstraint":{ "shape":"BucketLocationConstraint", "documentation":"Specifies the region where the bucket will be created. If you don't specify a region, the bucket will be created in US Standard." } } }, "CreateBucketOutput":{ "type":"structure", "members":{ "Location":{ "shape":"Location", "location":"header", "locationName":"Location" } } }, "CreateBucketRequest":{ "type":"structure", "required":["Bucket"], "members":{ "ACL":{ "shape":"BucketCannedACL", "documentation":"The canned ACL to apply to the bucket.", "location":"header", "locationName":"x-amz-acl" }, "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "CreateBucketConfiguration":{ "shape":"CreateBucketConfiguration", "locationName":"CreateBucketConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} }, "GrantFullControl":{ "shape":"GrantFullControl", "documentation":"Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.", "location":"header", "locationName":"x-amz-grant-full-control" }, "GrantRead":{ "shape":"GrantRead", "documentation":"Allows grantee to list the objects in the bucket.", "location":"header", "locationName":"x-amz-grant-read" }, "GrantReadACP":{ "shape":"GrantReadACP", "documentation":"Allows grantee to read the bucket ACL.", "location":"header", "locationName":"x-amz-grant-read-acp" }, "GrantWrite":{ "shape":"GrantWrite", "documentation":"Allows grantee to create, overwrite, and delete any object in the bucket.", "location":"header", "locationName":"x-amz-grant-write" }, "GrantWriteACP":{ "shape":"GrantWriteACP", "documentation":"Allows grantee to write the ACL for the applicable bucket.", "location":"header", "locationName":"x-amz-grant-write-acp" } }, "payload":"CreateBucketConfiguration" }, "CreateMultipartUploadOutput":{ "type":"structure", "members":{ "AbortDate":{ "shape":"AbortDate", "documentation":"Date when multipart upload will become eligible for abort operation by lifecycle.", "location":"header", "locationName":"x-amz-abort-date" }, "AbortRuleId":{ "shape":"AbortRuleId", "documentation":"Id of the lifecycle rule that makes a multipart upload eligible for abort operation.", "location":"header", "locationName":"x-amz-abort-rule-id" }, "Bucket":{ "shape":"BucketName", "documentation":"Name of the bucket to which the multipart upload was initiated.", "locationName":"Bucket" }, "Key":{ "shape":"ObjectKey", "documentation":"Object key for which the multipart upload was initiated." }, "UploadId":{ "shape":"MultipartUploadId", "documentation":"ID for the initiated multipart upload." }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", "location":"header", "locationName":"x-amz-server-side-encryption" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", "documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "RequestCharged":{ "shape":"RequestCharged", "location":"header", "locationName":"x-amz-request-charged" } } }, "CreateMultipartUploadRequest":{ "type":"structure", "required":[ "Bucket", "Key" ], "members":{ "ACL":{ "shape":"ObjectCannedACL", "documentation":"The canned ACL to apply to the object.", "location":"header", "locationName":"x-amz-acl" }, "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "CacheControl":{ "shape":"CacheControl", "documentation":"Specifies caching behavior along the request/reply chain.", "location":"header", "locationName":"Cache-Control" }, "ContentDisposition":{ "shape":"ContentDisposition", "documentation":"Specifies presentational information for the object.", "location":"header", "locationName":"Content-Disposition" }, "ContentEncoding":{ "shape":"ContentEncoding", "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.", "location":"header", "locationName":"Content-Encoding" }, "ContentLanguage":{ "shape":"ContentLanguage", "documentation":"The language the content is in.", "location":"header", "locationName":"Content-Language" }, "ContentType":{ "shape":"ContentType", "documentation":"A standard MIME type describing the format of the object data.", "location":"header", "locationName":"Content-Type" }, "Expires":{ "shape":"Expires", "documentation":"The date and time at which the object is no longer cacheable.", "location":"header", "locationName":"Expires" }, "GrantFullControl":{ "shape":"GrantFullControl", "documentation":"Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.", "location":"header", "locationName":"x-amz-grant-full-control" }, "GrantRead":{ "shape":"GrantRead", "documentation":"Allows grantee to read the object data and its metadata.", "location":"header", "locationName":"x-amz-grant-read" }, "GrantReadACP":{ "shape":"GrantReadACP", "documentation":"Allows grantee to read the object ACL.", "location":"header", "locationName":"x-amz-grant-read-acp" }, "GrantWriteACP":{ "shape":"GrantWriteACP", "documentation":"Allows grantee to write the ACL for the applicable object.", "location":"header", "locationName":"x-amz-grant-write-acp" }, "Key":{ "shape":"ObjectKey", "location":"uri", "locationName":"Key" }, "Metadata":{ "shape":"Metadata", "documentation":"A map of metadata to store with the object in S3.", "location":"headers", "locationName":"x-amz-meta-" }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", "location":"header", "locationName":"x-amz-server-side-encryption" }, "StorageClass":{ "shape":"StorageClass", "documentation":"The type of storage to use for the object. Defaults to 'STANDARD'.", "location":"header", "locationName":"x-amz-storage-class" }, "WebsiteRedirectLocation":{ "shape":"WebsiteRedirectLocation", "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.", "location":"header", "locationName":"x-amz-website-redirect-location" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256).", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", "documentation":"Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", "locationName":"x-amz-request-payer" } } }, "CreationDate":{"type":"timestamp"}, "Date":{ "type":"timestamp", "timestampFormat":"iso8601" }, "Days":{"type":"integer"}, "DaysAfterInitiation":{"type":"integer"}, "Delete":{ "type":"structure", "required":["Objects"], "members":{ "Objects":{ "shape":"ObjectIdentifierList", "locationName":"Object" }, "Quiet":{ "shape":"Quiet", "documentation":"Element to enable quiet mode for the request. When you add this element, you must set its value to true." } } }, "DeleteBucketAnalyticsConfigurationRequest":{ "type":"structure", "required":[ "Bucket", "Id" ], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket from which an analytics configuration is deleted.", "location":"uri", "locationName":"Bucket" }, "Id":{ "shape":"AnalyticsId", "documentation":"The identifier used to represent an analytics configuration.", "location":"querystring", "locationName":"id" } } }, "DeleteBucketCorsRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "DeleteBucketInventoryConfigurationRequest":{ "type":"structure", "required":[ "Bucket", "Id" ], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket containing the inventory configuration to delete.", "location":"uri", "locationName":"Bucket" }, "Id":{ "shape":"InventoryId", "documentation":"The ID used to identify the inventory configuration.", "location":"querystring", "locationName":"id" } } }, "DeleteBucketLifecycleRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "DeleteBucketMetricsConfigurationRequest":{ "type":"structure", "required":[ "Bucket", "Id" ], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket containing the metrics configuration to delete.", "location":"uri", "locationName":"Bucket" }, "Id":{ "shape":"MetricsId", "documentation":"The ID used to identify the metrics configuration.", "location":"querystring", "locationName":"id" } } }, "DeleteBucketPolicyRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "DeleteBucketReplicationRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "DeleteBucketRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "DeleteBucketTaggingRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "DeleteBucketWebsiteRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "DeleteMarker":{"type":"boolean"}, "DeleteMarkerEntry":{ "type":"structure", "members":{ "Owner":{"shape":"Owner"}, "Key":{ "shape":"ObjectKey", "documentation":"The object key." }, "VersionId":{ "shape":"ObjectVersionId", "documentation":"Version ID of an object." }, "IsLatest":{ "shape":"IsLatest", "documentation":"Specifies whether the object is (true) or is not (false) the latest version of an object." }, "LastModified":{ "shape":"LastModified", "documentation":"Date and time the object was last modified." } } }, "DeleteMarkerVersionId":{"type":"string"}, "DeleteMarkers":{ "type":"list", "member":{"shape":"DeleteMarkerEntry"}, "flattened":true }, "DeleteObjectOutput":{ "type":"structure", "members":{ "DeleteMarker":{ "shape":"DeleteMarker", "documentation":"Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.", "location":"header", "locationName":"x-amz-delete-marker" }, "VersionId":{ "shape":"ObjectVersionId", "documentation":"Returns the version ID of the delete marker created as a result of the DELETE operation.", "location":"header", "locationName":"x-amz-version-id" }, "RequestCharged":{ "shape":"RequestCharged", "location":"header", "locationName":"x-amz-request-charged" } } }, "DeleteObjectRequest":{ "type":"structure", "required":[ "Bucket", "Key" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "Key":{ "shape":"ObjectKey", "location":"uri", "locationName":"Key" }, "MFA":{ "shape":"MFA", "documentation":"The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.", "location":"header", "locationName":"x-amz-mfa" }, "VersionId":{ "shape":"ObjectVersionId", "documentation":"VersionId used to reference a specific version of the object.", "location":"querystring", "locationName":"versionId" }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", "locationName":"x-amz-request-payer" } } }, "DeleteObjectTaggingOutput":{ "type":"structure", "members":{ "VersionId":{ "shape":"ObjectVersionId", "documentation":"The versionId of the object the tag-set was removed from.", "location":"header", "locationName":"x-amz-version-id" } } }, "DeleteObjectTaggingRequest":{ "type":"structure", "required":[ "Bucket", "Key" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "Key":{ "shape":"ObjectKey", "location":"uri", "locationName":"Key" }, "VersionId":{ "shape":"ObjectVersionId", "documentation":"The versionId of the object that the tag-set will be removed from.", "location":"querystring", "locationName":"versionId" } } }, "DeleteObjectsOutput":{ "type":"structure", "members":{ "Deleted":{"shape":"DeletedObjects"}, "RequestCharged":{ "shape":"RequestCharged", "location":"header", "locationName":"x-amz-request-charged" }, "Errors":{ "shape":"Errors", "locationName":"Error" } } }, "DeleteObjectsRequest":{ "type":"structure", "required":[ "Bucket", "Delete" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "Delete":{ "shape":"Delete", "locationName":"Delete", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} }, "MFA":{ "shape":"MFA", "documentation":"The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.", "location":"header", "locationName":"x-amz-mfa" }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", "locationName":"x-amz-request-payer" } }, "payload":"Delete" }, "DeletedObject":{ "type":"structure", "members":{ "Key":{"shape":"ObjectKey"}, "VersionId":{"shape":"ObjectVersionId"}, "DeleteMarker":{"shape":"DeleteMarker"}, "DeleteMarkerVersionId":{"shape":"DeleteMarkerVersionId"} } }, "DeletedObjects":{ "type":"list", "member":{"shape":"DeletedObject"}, "flattened":true }, "Delimiter":{"type":"string"}, "Destination":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"Amazon resource name (ARN) of the bucket where you want Amazon S3 to store replicas of the object identified by the rule." }, "StorageClass":{ "shape":"StorageClass", "documentation":"The class of storage used to store the object." } } }, "DisplayName":{"type":"string"}, "ETag":{"type":"string"}, "EmailAddress":{"type":"string"}, "EncodingType":{ "type":"string", "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.", "enum":["url"] }, "Error":{ "type":"structure", "members":{ "Key":{"shape":"ObjectKey"}, "VersionId":{"shape":"ObjectVersionId"}, "Code":{"shape":"Code"}, "Message":{"shape":"Message"} } }, "ErrorDocument":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"ObjectKey", "documentation":"The object key name to use when a 4XX class error occurs." } } }, "Errors":{ "type":"list", "member":{"shape":"Error"}, "flattened":true }, "Event":{ "type":"string", "documentation":"Bucket event for which to send notifications.", "enum":[ "s3:ReducedRedundancyLostObject", "s3:ObjectCreated:*", "s3:ObjectCreated:Put", "s3:ObjectCreated:Post", "s3:ObjectCreated:Copy", "s3:ObjectCreated:CompleteMultipartUpload", "s3:ObjectRemoved:*", "s3:ObjectRemoved:Delete", "s3:ObjectRemoved:DeleteMarkerCreated" ] }, "EventList":{ "type":"list", "member":{"shape":"Event"}, "flattened":true }, "Expiration":{"type":"string"}, "ExpirationStatus":{ "type":"string", "enum":[ "Enabled", "Disabled" ] }, "ExpiredObjectDeleteMarker":{"type":"boolean"}, "Expires":{"type":"timestamp"}, "ExposeHeader":{"type":"string"}, "ExposeHeaders":{ "type":"list", "member":{"shape":"ExposeHeader"}, "flattened":true }, "FetchOwner":{"type":"boolean"}, "FilterRule":{ "type":"structure", "members":{ "Name":{ "shape":"FilterRuleName", "documentation":"Object key name prefix or suffix identifying one or more objects to which the filtering rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide." }, "Value":{"shape":"FilterRuleValue"} }, "documentation":"Container for key value pair that defines the criteria for the filter rule." }, "FilterRuleList":{ "type":"list", "member":{"shape":"FilterRule"}, "documentation":"A list of containers for key value pair that defines the criteria for the filter rule.", "flattened":true }, "FilterRuleName":{ "type":"string", "enum":[ "prefix", "suffix" ] }, "FilterRuleValue":{"type":"string"}, "GetBucketAccelerateConfigurationOutput":{ "type":"structure", "members":{ "Status":{ "shape":"BucketAccelerateStatus", "documentation":"The accelerate configuration of the bucket." } } }, "GetBucketAccelerateConfigurationRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"Name of the bucket for which the accelerate configuration is retrieved.", "location":"uri", "locationName":"Bucket" } } }, "GetBucketAclOutput":{ "type":"structure", "members":{ "Owner":{"shape":"Owner"}, "Grants":{ "shape":"Grants", "documentation":"A list of grants.", "locationName":"AccessControlList" } } }, "GetBucketAclRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "GetBucketAnalyticsConfigurationOutput":{ "type":"structure", "members":{ "AnalyticsConfiguration":{ "shape":"AnalyticsConfiguration", "documentation":"The configuration and any analyses for the analytics filter." } }, "payload":"AnalyticsConfiguration" }, "GetBucketAnalyticsConfigurationRequest":{ "type":"structure", "required":[ "Bucket", "Id" ], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket from which an analytics configuration is retrieved.", "location":"uri", "locationName":"Bucket" }, "Id":{ "shape":"AnalyticsId", "documentation":"The identifier used to represent an analytics configuration.", "location":"querystring", "locationName":"id" } } }, "GetBucketCorsOutput":{ "type":"structure", "members":{ "CORSRules":{ "shape":"CORSRules", "locationName":"CORSRule" } } }, "GetBucketCorsRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "GetBucketInventoryConfigurationOutput":{ "type":"structure", "members":{ "InventoryConfiguration":{ "shape":"InventoryConfiguration", "documentation":"Specifies the inventory configuration." } }, "payload":"InventoryConfiguration" }, "GetBucketInventoryConfigurationRequest":{ "type":"structure", "required":[ "Bucket", "Id" ], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket containing the inventory configuration to retrieve.", "location":"uri", "locationName":"Bucket" }, "Id":{ "shape":"InventoryId", "documentation":"The ID used to identify the inventory configuration.", "location":"querystring", "locationName":"id" } } }, "GetBucketLifecycleConfigurationOutput":{ "type":"structure", "members":{ "Rules":{ "shape":"LifecycleRules", "locationName":"Rule" } } }, "GetBucketLifecycleConfigurationRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "GetBucketLifecycleOutput":{ "type":"structure", "members":{ "Rules":{ "shape":"Rules", "locationName":"Rule" } } }, "GetBucketLifecycleRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "GetBucketLocationOutput":{ "type":"structure", "members":{ "LocationConstraint":{"shape":"BucketLocationConstraint"} } }, "GetBucketLocationRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "GetBucketLoggingOutput":{ "type":"structure", "members":{ "LoggingEnabled":{"shape":"LoggingEnabled"} } }, "GetBucketLoggingRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "GetBucketMetricsConfigurationOutput":{ "type":"structure", "members":{ "MetricsConfiguration":{ "shape":"MetricsConfiguration", "documentation":"Specifies the metrics configuration." } }, "payload":"MetricsConfiguration" }, "GetBucketMetricsConfigurationRequest":{ "type":"structure", "required":[ "Bucket", "Id" ], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket containing the metrics configuration to retrieve.", "location":"uri", "locationName":"Bucket" }, "Id":{ "shape":"MetricsId", "documentation":"The ID used to identify the metrics configuration.", "location":"querystring", "locationName":"id" } } }, "GetBucketNotificationConfigurationRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"Name of the bucket to get the notification configuration for.", "location":"uri", "locationName":"Bucket" } } }, "GetBucketPolicyOutput":{ "type":"structure", "members":{ "Policy":{ "shape":"Policy", "documentation":"The bucket policy as a JSON document." } }, "payload":"Policy" }, "GetBucketPolicyRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "GetBucketReplicationOutput":{ "type":"structure", "members":{ "ReplicationConfiguration":{"shape":"ReplicationConfiguration"} }, "payload":"ReplicationConfiguration" }, "GetBucketReplicationRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "GetBucketRequestPaymentOutput":{ "type":"structure", "members":{ "Payer":{ "shape":"Payer", "documentation":"Specifies who pays for the download and request fees." } } }, "GetBucketRequestPaymentRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "GetBucketTaggingOutput":{ "type":"structure", "required":["TagSet"], "members":{ "TagSet":{"shape":"TagSet"} } }, "GetBucketTaggingRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "GetBucketVersioningOutput":{ "type":"structure", "members":{ "Status":{ "shape":"BucketVersioningStatus", "documentation":"The versioning state of the bucket." }, "MFADelete":{ "shape":"MFADeleteStatus", "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.", "locationName":"MfaDelete" } } }, "GetBucketVersioningRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "GetBucketWebsiteOutput":{ "type":"structure", "members":{ "RedirectAllRequestsTo":{"shape":"RedirectAllRequestsTo"}, "IndexDocument":{"shape":"IndexDocument"}, "ErrorDocument":{"shape":"ErrorDocument"}, "RoutingRules":{"shape":"RoutingRules"} } }, "GetBucketWebsiteRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "GetObjectAclOutput":{ "type":"structure", "members":{ "Owner":{"shape":"Owner"}, "Grants":{ "shape":"Grants", "documentation":"A list of grants.", "locationName":"AccessControlList" }, "RequestCharged":{ "shape":"RequestCharged", "location":"header", "locationName":"x-amz-request-charged" } } }, "GetObjectAclRequest":{ "type":"structure", "required":[ "Bucket", "Key" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "Key":{ "shape":"ObjectKey", "location":"uri", "locationName":"Key" }, "VersionId":{ "shape":"ObjectVersionId", "documentation":"VersionId used to reference a specific version of the object.", "location":"querystring", "locationName":"versionId" }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", "locationName":"x-amz-request-payer" } } }, "GetObjectOutput":{ "type":"structure", "members":{ "Body":{ "shape":"Body", "documentation":"Object data.", "streaming":true }, "DeleteMarker":{ "shape":"DeleteMarker", "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.", "location":"header", "locationName":"x-amz-delete-marker" }, "AcceptRanges":{ "shape":"AcceptRanges", "location":"header", "locationName":"accept-ranges" }, "Expiration":{ "shape":"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.", "location":"header", "locationName":"x-amz-expiration" }, "Restore":{ "shape":"Restore", "documentation":"Provides information about object restoration operation and expiration time of the restored object copy.", "location":"header", "locationName":"x-amz-restore" }, "LastModified":{ "shape":"LastModified", "documentation":"Last modified date of the object", "location":"header", "locationName":"Last-Modified" }, "ContentLength":{ "shape":"ContentLength", "documentation":"Size of the body in bytes.", "location":"header", "locationName":"Content-Length" }, "ETag":{ "shape":"ETag", "documentation":"An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL", "location":"header", "locationName":"ETag" }, "MissingMeta":{ "shape":"MissingMeta", "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.", "location":"header", "locationName":"x-amz-missing-meta" }, "VersionId":{ "shape":"ObjectVersionId", "documentation":"Version of the object.", "location":"header", "locationName":"x-amz-version-id" }, "CacheControl":{ "shape":"CacheControl", "documentation":"Specifies caching behavior along the request/reply chain.", "location":"header", "locationName":"Cache-Control" }, "ContentDisposition":{ "shape":"ContentDisposition", "documentation":"Specifies presentational information for the object.", "location":"header", "locationName":"Content-Disposition" }, "ContentEncoding":{ "shape":"ContentEncoding", "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.", "location":"header", "locationName":"Content-Encoding" }, "ContentLanguage":{ "shape":"ContentLanguage", "documentation":"The language the content is in.", "location":"header", "locationName":"Content-Language" }, "ContentRange":{ "shape":"ContentRange", "documentation":"The portion of the object returned in the response.", "location":"header", "locationName":"Content-Range" }, "ContentType":{ "shape":"ContentType", "documentation":"A standard MIME type describing the format of the object data.", "location":"header", "locationName":"Content-Type" }, "Expires":{ "shape":"Expires", "documentation":"The date and time at which the object is no longer cacheable.", "location":"header", "locationName":"Expires" }, "WebsiteRedirectLocation":{ "shape":"WebsiteRedirectLocation", "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.", "location":"header", "locationName":"x-amz-website-redirect-location" }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", "location":"header", "locationName":"x-amz-server-side-encryption" }, "Metadata":{ "shape":"Metadata", "documentation":"A map of metadata to store with the object in S3.", "location":"headers", "locationName":"x-amz-meta-" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", "documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "StorageClass":{ "shape":"StorageClass", "location":"header", "locationName":"x-amz-storage-class" }, "RequestCharged":{ "shape":"RequestCharged", "location":"header", "locationName":"x-amz-request-charged" }, "ReplicationStatus":{ "shape":"ReplicationStatus", "location":"header", "locationName":"x-amz-replication-status" }, "PartsCount":{ "shape":"PartsCount", "documentation":"The count of parts this object has.", "location":"header", "locationName":"x-amz-mp-parts-count" }, "TagCount":{ "shape":"TagCount", "documentation":"The number of tags, if any, on the object.", "location":"header", "locationName":"x-amz-tagging-count" } }, "payload":"Body" }, "GetObjectRequest":{ "type":"structure", "required":[ "Bucket", "Key" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "IfMatch":{ "shape":"IfMatch", "documentation":"Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).", "location":"header", "locationName":"If-Match" }, "IfModifiedSince":{ "shape":"IfModifiedSince", "documentation":"Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).", "location":"header", "locationName":"If-Modified-Since" }, "IfNoneMatch":{ "shape":"IfNoneMatch", "documentation":"Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).", "location":"header", "locationName":"If-None-Match" }, "IfUnmodifiedSince":{ "shape":"IfUnmodifiedSince", "documentation":"Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).", "location":"header", "locationName":"If-Unmodified-Since" }, "Key":{ "shape":"ObjectKey", "location":"uri", "locationName":"Key" }, "Range":{ "shape":"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.", "location":"header", "locationName":"Range" }, "ResponseCacheControl":{ "shape":"ResponseCacheControl", "documentation":"Sets the Cache-Control header of the response.", "location":"querystring", "locationName":"response-cache-control" }, "ResponseContentDisposition":{ "shape":"ResponseContentDisposition", "documentation":"Sets the Content-Disposition header of the response", "location":"querystring", "locationName":"response-content-disposition" }, "ResponseContentEncoding":{ "shape":"ResponseContentEncoding", "documentation":"Sets the Content-Encoding header of the response.", "location":"querystring", "locationName":"response-content-encoding" }, "ResponseContentLanguage":{ "shape":"ResponseContentLanguage", "documentation":"Sets the Content-Language header of the response.", "location":"querystring", "locationName":"response-content-language" }, "ResponseContentType":{ "shape":"ResponseContentType", "documentation":"Sets the Content-Type header of the response.", "location":"querystring", "locationName":"response-content-type" }, "ResponseExpires":{ "shape":"ResponseExpires", "documentation":"Sets the Expires header of the response.", "location":"querystring", "locationName":"response-expires" }, "VersionId":{ "shape":"ObjectVersionId", "documentation":"VersionId used to reference a specific version of the object.", "location":"querystring", "locationName":"versionId" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256).", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", "locationName":"x-amz-request-payer" }, "PartNumber":{ "shape":"PartNumber", "documentation":"Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.", "location":"querystring", "locationName":"partNumber" } } }, "GetObjectTaggingOutput":{ "type":"structure", "required":["TagSet"], "members":{ "VersionId":{ "shape":"ObjectVersionId", "location":"header", "locationName":"x-amz-version-id" }, "TagSet":{"shape":"TagSet"} } }, "GetObjectTaggingRequest":{ "type":"structure", "required":[ "Bucket", "Key" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "Key":{ "shape":"ObjectKey", "location":"uri", "locationName":"Key" }, "VersionId":{ "shape":"ObjectVersionId", "location":"querystring", "locationName":"versionId" } } }, "GetObjectTorrentOutput":{ "type":"structure", "members":{ "Body":{ "shape":"Body", "streaming":true }, "RequestCharged":{ "shape":"RequestCharged", "location":"header", "locationName":"x-amz-request-charged" } }, "payload":"Body" }, "GetObjectTorrentRequest":{ "type":"structure", "required":[ "Bucket", "Key" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "Key":{ "shape":"ObjectKey", "location":"uri", "locationName":"Key" }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", "locationName":"x-amz-request-payer" } } }, "GlacierJobParameters":{ "type":"structure", "required":["Tier"], "members":{ "Tier":{ "shape":"Tier", "documentation":"Glacier retrieval tier at which the restore will be processed." } } }, "Grant":{ "type":"structure", "members":{ "Grantee":{"shape":"Grantee"}, "Permission":{ "shape":"Permission", "documentation":"Specifies the permission given to the grantee." } } }, "GrantFullControl":{"type":"string"}, "GrantRead":{"type":"string"}, "GrantReadACP":{"type":"string"}, "GrantWrite":{"type":"string"}, "GrantWriteACP":{"type":"string"}, "Grantee":{ "type":"structure", "required":["Type"], "members":{ "DisplayName":{ "shape":"DisplayName", "documentation":"Screen name of the grantee." }, "EmailAddress":{ "shape":"EmailAddress", "documentation":"Email address of the grantee." }, "ID":{ "shape":"ID", "documentation":"The canonical user ID of the grantee." }, "Type":{ "shape":"Type", "documentation":"Type of grantee", "locationName":"xsi:type", "xmlAttribute":true }, "URI":{ "shape":"URI", "documentation":"URI of the grantee group." } }, "xmlNamespace":{ "prefix":"xsi", "uri":"http://www.w3.org/2001/XMLSchema-instance" } }, "Grants":{ "type":"list", "member":{ "shape":"Grant", "locationName":"Grant" } }, "HeadBucketRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" } } }, "HeadObjectOutput":{ "type":"structure", "members":{ "DeleteMarker":{ "shape":"DeleteMarker", "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.", "location":"header", "locationName":"x-amz-delete-marker" }, "AcceptRanges":{ "shape":"AcceptRanges", "location":"header", "locationName":"accept-ranges" }, "Expiration":{ "shape":"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.", "location":"header", "locationName":"x-amz-expiration" }, "Restore":{ "shape":"Restore", "documentation":"Provides information about object restoration operation and expiration time of the restored object copy.", "location":"header", "locationName":"x-amz-restore" }, "LastModified":{ "shape":"LastModified", "documentation":"Last modified date of the object", "location":"header", "locationName":"Last-Modified" }, "ContentLength":{ "shape":"ContentLength", "documentation":"Size of the body in bytes.", "location":"header", "locationName":"Content-Length" }, "ETag":{ "shape":"ETag", "documentation":"An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL", "location":"header", "locationName":"ETag" }, "MissingMeta":{ "shape":"MissingMeta", "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.", "location":"header", "locationName":"x-amz-missing-meta" }, "VersionId":{ "shape":"ObjectVersionId", "documentation":"Version of the object.", "location":"header", "locationName":"x-amz-version-id" }, "CacheControl":{ "shape":"CacheControl", "documentation":"Specifies caching behavior along the request/reply chain.", "location":"header", "locationName":"Cache-Control" }, "ContentDisposition":{ "shape":"ContentDisposition", "documentation":"Specifies presentational information for the object.", "location":"header", "locationName":"Content-Disposition" }, "ContentEncoding":{ "shape":"ContentEncoding", "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.", "location":"header", "locationName":"Content-Encoding" }, "ContentLanguage":{ "shape":"ContentLanguage", "documentation":"The language the content is in.", "location":"header", "locationName":"Content-Language" }, "ContentType":{ "shape":"ContentType", "documentation":"A standard MIME type describing the format of the object data.", "location":"header", "locationName":"Content-Type" }, "Expires":{ "shape":"Expires", "documentation":"The date and time at which the object is no longer cacheable.", "location":"header", "locationName":"Expires" }, "WebsiteRedirectLocation":{ "shape":"WebsiteRedirectLocation", "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.", "location":"header", "locationName":"x-amz-website-redirect-location" }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", "location":"header", "locationName":"x-amz-server-side-encryption" }, "Metadata":{ "shape":"Metadata", "documentation":"A map of metadata to store with the object in S3.", "location":"headers", "locationName":"x-amz-meta-" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", "documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "StorageClass":{ "shape":"StorageClass", "location":"header", "locationName":"x-amz-storage-class" }, "RequestCharged":{ "shape":"RequestCharged", "location":"header", "locationName":"x-amz-request-charged" }, "ReplicationStatus":{ "shape":"ReplicationStatus", "location":"header", "locationName":"x-amz-replication-status" }, "PartsCount":{ "shape":"PartsCount", "documentation":"The count of parts this object has.", "location":"header", "locationName":"x-amz-mp-parts-count" } } }, "HeadObjectRequest":{ "type":"structure", "required":[ "Bucket", "Key" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "IfMatch":{ "shape":"IfMatch", "documentation":"Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).", "location":"header", "locationName":"If-Match" }, "IfModifiedSince":{ "shape":"IfModifiedSince", "documentation":"Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).", "location":"header", "locationName":"If-Modified-Since" }, "IfNoneMatch":{ "shape":"IfNoneMatch", "documentation":"Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).", "location":"header", "locationName":"If-None-Match" }, "IfUnmodifiedSince":{ "shape":"IfUnmodifiedSince", "documentation":"Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).", "location":"header", "locationName":"If-Unmodified-Since" }, "Key":{ "shape":"ObjectKey", "location":"uri", "locationName":"Key" }, "Range":{ "shape":"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.", "location":"header", "locationName":"Range" }, "VersionId":{ "shape":"ObjectVersionId", "documentation":"VersionId used to reference a specific version of the object.", "location":"querystring", "locationName":"versionId" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256).", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", "locationName":"x-amz-request-payer" }, "PartNumber":{ "shape":"PartNumber", "documentation":"Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.", "location":"querystring", "locationName":"partNumber" } } }, "HostName":{"type":"string"}, "HttpErrorCodeReturnedEquals":{"type":"string"}, "HttpRedirectCode":{"type":"string"}, "ID":{"type":"string"}, "IfMatch":{"type":"string"}, "IfModifiedSince":{"type":"timestamp"}, "IfNoneMatch":{"type":"string"}, "IfUnmodifiedSince":{"type":"timestamp"}, "IndexDocument":{ "type":"structure", "required":["Suffix"], "members":{ "Suffix":{ "shape":"Suffix", "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." } } }, "Initiated":{"type":"timestamp"}, "Initiator":{ "type":"structure", "members":{ "ID":{ "shape":"ID", "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." }, "DisplayName":{ "shape":"DisplayName", "documentation":"Name of the Principal." } } }, "InventoryConfiguration":{ "type":"structure", "required":[ "Destination", "IsEnabled", "Id", "IncludedObjectVersions", "Schedule" ], "members":{ "Destination":{ "shape":"InventoryDestination", "documentation":"Contains information about where to publish the inventory results." }, "IsEnabled":{ "shape":"IsEnabled", "documentation":"Specifies whether the inventory is enabled or disabled." }, "Filter":{ "shape":"InventoryFilter", "documentation":"Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria." }, "Id":{ "shape":"InventoryId", "documentation":"The ID used to identify the inventory configuration." }, "IncludedObjectVersions":{ "shape":"InventoryIncludedObjectVersions", "documentation":"Specifies which object version(s) to included in the inventory results." }, "OptionalFields":{ "shape":"InventoryOptionalFields", "documentation":"Contains the optional fields that are included in the inventory results." }, "Schedule":{ "shape":"InventorySchedule", "documentation":"Specifies the schedule for generating inventory results." } } }, "InventoryConfigurationList":{ "type":"list", "member":{"shape":"InventoryConfiguration"}, "flattened":true }, "InventoryDestination":{ "type":"structure", "required":["S3BucketDestination"], "members":{ "S3BucketDestination":{ "shape":"InventoryS3BucketDestination", "documentation":"Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published." } } }, "InventoryFilter":{ "type":"structure", "required":["Prefix"], "members":{ "Prefix":{ "shape":"Prefix", "documentation":"The prefix that an object must have to be included in the inventory results." } } }, "InventoryFormat":{ "type":"string", "enum":["CSV"] }, "InventoryFrequency":{ "type":"string", "enum":[ "Daily", "Weekly" ] }, "InventoryId":{"type":"string"}, "InventoryIncludedObjectVersions":{ "type":"string", "enum":[ "All", "Current" ] }, "InventoryOptionalField":{ "type":"string", "enum":[ "Size", "LastModifiedDate", "StorageClass", "ETag", "IsMultipartUploaded", "ReplicationStatus" ] }, "InventoryOptionalFields":{ "type":"list", "member":{ "shape":"InventoryOptionalField", "locationName":"Field" } }, "InventoryS3BucketDestination":{ "type":"structure", "required":[ "Bucket", "Format" ], "members":{ "AccountId":{ "shape":"AccountId", "documentation":"The ID of the account that owns the destination bucket." }, "Bucket":{ "shape":"BucketName", "documentation":"The Amazon resource name (ARN) of the bucket where inventory results will be published." }, "Format":{ "shape":"InventoryFormat", "documentation":"Specifies the output format of the inventory results." }, "Prefix":{ "shape":"Prefix", "documentation":"The prefix that is prepended to all inventory results." } } }, "InventorySchedule":{ "type":"structure", "required":["Frequency"], "members":{ "Frequency":{ "shape":"InventoryFrequency", "documentation":"Specifies how frequently inventory results are produced." } } }, "IsEnabled":{"type":"boolean"}, "IsLatest":{"type":"boolean"}, "IsTruncated":{"type":"boolean"}, "KeyCount":{"type":"integer"}, "KeyMarker":{"type":"string"}, "KeyPrefixEquals":{"type":"string"}, "LambdaFunctionArn":{"type":"string"}, "LambdaFunctionConfiguration":{ "type":"structure", "required":[ "LambdaFunctionArn", "Events" ], "members":{ "Id":{"shape":"NotificationId"}, "LambdaFunctionArn":{ "shape":"LambdaFunctionArn", "documentation":"Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.", "locationName":"CloudFunction" }, "Events":{ "shape":"EventList", "locationName":"Event" }, "Filter":{"shape":"NotificationConfigurationFilter"} }, "documentation":"Container for specifying the AWS Lambda notification configuration." }, "LambdaFunctionConfigurationList":{ "type":"list", "member":{"shape":"LambdaFunctionConfiguration"}, "flattened":true }, "LastModified":{"type":"timestamp"}, "LifecycleConfiguration":{ "type":"structure", "required":["Rules"], "members":{ "Rules":{ "shape":"Rules", "locationName":"Rule" } } }, "LifecycleExpiration":{ "type":"structure", "members":{ "Date":{ "shape":"Date", "documentation":"Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format." }, "Days":{ "shape":"Days", "documentation":"Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer." }, "ExpiredObjectDeleteMarker":{ "shape":"ExpiredObjectDeleteMarker", "documentation":"Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy." } } }, "LifecycleRule":{ "type":"structure", "required":["Status"], "members":{ "Expiration":{"shape":"LifecycleExpiration"}, "ID":{ "shape":"ID", "documentation":"Unique identifier for the rule. The value cannot be longer than 255 characters." }, "Prefix":{ "shape":"Prefix", "documentation":"Prefix identifying one or more objects to which the rule applies. This is deprecated; use Filter instead.", "deprecated":true }, "Filter":{"shape":"LifecycleRuleFilter"}, "Status":{ "shape":"ExpirationStatus", "documentation":"If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied." }, "Transitions":{ "shape":"TransitionList", "locationName":"Transition" }, "NoncurrentVersionTransitions":{ "shape":"NoncurrentVersionTransitionList", "locationName":"NoncurrentVersionTransition" }, "NoncurrentVersionExpiration":{"shape":"NoncurrentVersionExpiration"}, "AbortIncompleteMultipartUpload":{"shape":"AbortIncompleteMultipartUpload"} } }, "LifecycleRuleAndOperator":{ "type":"structure", "members":{ "Prefix":{"shape":"Prefix"}, "Tags":{ "shape":"TagSet", "documentation":"All of these tags must exist in the object's tag set in order for the rule to apply.", "flattened":true, "locationName":"Tag" } }, "documentation":"This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator." }, "LifecycleRuleFilter":{ "type":"structure", "members":{ "Prefix":{ "shape":"Prefix", "documentation":"Prefix identifying one or more objects to which the rule applies." }, "Tag":{ "shape":"Tag", "documentation":"This tag must exist in the object's tag set in order for the rule to apply." }, "And":{"shape":"LifecycleRuleAndOperator"} }, "documentation":"The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified." }, "LifecycleRules":{ "type":"list", "member":{"shape":"LifecycleRule"}, "flattened":true }, "ListBucketAnalyticsConfigurationsOutput":{ "type":"structure", "members":{ "IsTruncated":{ "shape":"IsTruncated", "documentation":"Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request." }, "ContinuationToken":{ "shape":"Token", "documentation":"The ContinuationToken that represents where this request began." }, "NextContinuationToken":{ "shape":"NextToken", "documentation":"NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value." }, "AnalyticsConfigurationList":{ "shape":"AnalyticsConfigurationList", "documentation":"The list of analytics configurations for a bucket.", "locationName":"AnalyticsConfiguration" } } }, "ListBucketAnalyticsConfigurationsRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket from which analytics configurations are retrieved.", "location":"uri", "locationName":"Bucket" }, "ContinuationToken":{ "shape":"Token", "documentation":"The ContinuationToken that represents a placeholder from where this request should begin.", "location":"querystring", "locationName":"continuation-token" } } }, "ListBucketInventoryConfigurationsOutput":{ "type":"structure", "members":{ "ContinuationToken":{ "shape":"Token", "documentation":"If sent in the request, the marker that is used as a starting point for this inventory configuration list response." }, "InventoryConfigurationList":{ "shape":"InventoryConfigurationList", "documentation":"The list of inventory configurations for a bucket.", "locationName":"InventoryConfiguration" }, "IsTruncated":{ "shape":"IsTruncated", "documentation":"Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated." }, "NextContinuationToken":{ "shape":"NextToken", "documentation":"The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands." } } }, "ListBucketInventoryConfigurationsRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket containing the inventory configurations to retrieve.", "location":"uri", "locationName":"Bucket" }, "ContinuationToken":{ "shape":"Token", "documentation":"The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.", "location":"querystring", "locationName":"continuation-token" } } }, "ListBucketMetricsConfigurationsOutput":{ "type":"structure", "members":{ "IsTruncated":{ "shape":"IsTruncated", "documentation":"Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request." }, "ContinuationToken":{ "shape":"Token", "documentation":"The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request." }, "NextContinuationToken":{ "shape":"NextToken", "documentation":"The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands." }, "MetricsConfigurationList":{ "shape":"MetricsConfigurationList", "documentation":"The list of metrics configurations for a bucket.", "locationName":"MetricsConfiguration" } } }, "ListBucketMetricsConfigurationsRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket containing the metrics configurations to retrieve.", "location":"uri", "locationName":"Bucket" }, "ContinuationToken":{ "shape":"Token", "documentation":"The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.", "location":"querystring", "locationName":"continuation-token" } } }, "ListBucketsOutput":{ "type":"structure", "members":{ "Buckets":{"shape":"Buckets"}, "Owner":{"shape":"Owner"} } }, "ListMultipartUploadsOutput":{ "type":"structure", "members":{ "Bucket":{ "shape":"BucketName", "documentation":"Name of the bucket to which the multipart upload was initiated." }, "KeyMarker":{ "shape":"KeyMarker", "documentation":"The key at or after which the listing began." }, "UploadIdMarker":{ "shape":"UploadIdMarker", "documentation":"Upload ID after which listing began." }, "NextKeyMarker":{ "shape":"NextKeyMarker", "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." }, "Prefix":{ "shape":"Prefix", "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." }, "Delimiter":{"shape":"Delimiter"}, "NextUploadIdMarker":{ "shape":"NextUploadIdMarker", "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." }, "MaxUploads":{ "shape":"MaxUploads", "documentation":"Maximum number of multipart uploads that could have been included in the response." }, "IsTruncated":{ "shape":"IsTruncated", "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." }, "Uploads":{ "shape":"MultipartUploadList", "locationName":"Upload" }, "CommonPrefixes":{"shape":"CommonPrefixList"}, "EncodingType":{ "shape":"EncodingType", "documentation":"Encoding type used by Amazon S3 to encode object keys in the response." } } }, "ListMultipartUploadsRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "Delimiter":{ "shape":"Delimiter", "documentation":"Character you use to group keys.", "location":"querystring", "locationName":"delimiter" }, "EncodingType":{ "shape":"EncodingType", "location":"querystring", "locationName":"encoding-type" }, "KeyMarker":{ "shape":"KeyMarker", "documentation":"Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.", "location":"querystring", "locationName":"key-marker" }, "MaxUploads":{ "shape":"MaxUploads", "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.", "location":"querystring", "locationName":"max-uploads" }, "Prefix":{ "shape":"Prefix", "documentation":"Lists in-progress uploads only for those keys that begin with the specified prefix.", "location":"querystring", "locationName":"prefix" }, "UploadIdMarker":{ "shape":"UploadIdMarker", "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.", "location":"querystring", "locationName":"upload-id-marker" } } }, "ListObjectVersionsOutput":{ "type":"structure", "members":{ "IsTruncated":{ "shape":"IsTruncated", "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":{ "shape":"KeyMarker", "documentation":"Marks the last Key returned in a truncated response." }, "VersionIdMarker":{"shape":"VersionIdMarker"}, "NextKeyMarker":{ "shape":"NextKeyMarker", "documentation":"Use this value for the key marker request parameter in a subsequent request." }, "NextVersionIdMarker":{ "shape":"NextVersionIdMarker", "documentation":"Use this value for the next version id marker parameter in a subsequent request." }, "Versions":{ "shape":"ObjectVersionList", "locationName":"Version" }, "DeleteMarkers":{ "shape":"DeleteMarkers", "locationName":"DeleteMarker" }, "Name":{"shape":"BucketName"}, "Prefix":{"shape":"Prefix"}, "Delimiter":{"shape":"Delimiter"}, "MaxKeys":{"shape":"MaxKeys"}, "CommonPrefixes":{"shape":"CommonPrefixList"}, "EncodingType":{ "shape":"EncodingType", "documentation":"Encoding type used by Amazon S3 to encode object keys in the response." } } }, "ListObjectVersionsRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "Delimiter":{ "shape":"Delimiter", "documentation":"A delimiter is a character you use to group keys.", "location":"querystring", "locationName":"delimiter" }, "EncodingType":{ "shape":"EncodingType", "location":"querystring", "locationName":"encoding-type" }, "KeyMarker":{ "shape":"KeyMarker", "documentation":"Specifies the key to start with when listing objects in a bucket.", "location":"querystring", "locationName":"key-marker" }, "MaxKeys":{ "shape":"MaxKeys", "documentation":"Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.", "location":"querystring", "locationName":"max-keys" }, "Prefix":{ "shape":"Prefix", "documentation":"Limits the response to keys that begin with the specified prefix.", "location":"querystring", "locationName":"prefix" }, "VersionIdMarker":{ "shape":"VersionIdMarker", "documentation":"Specifies the object version you want to start listing from.", "location":"querystring", "locationName":"version-id-marker" } } }, "ListObjectsOutput":{ "type":"structure", "members":{ "IsTruncated":{ "shape":"IsTruncated", "documentation":"A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria." }, "Marker":{"shape":"Marker"}, "NextMarker":{ "shape":"NextMarker", "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." }, "Contents":{"shape":"ObjectList"}, "Name":{"shape":"BucketName"}, "Prefix":{"shape":"Prefix"}, "Delimiter":{"shape":"Delimiter"}, "MaxKeys":{"shape":"MaxKeys"}, "CommonPrefixes":{"shape":"CommonPrefixList"}, "EncodingType":{ "shape":"EncodingType", "documentation":"Encoding type used by Amazon S3 to encode object keys in the response." } } }, "ListObjectsRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "Delimiter":{ "shape":"Delimiter", "documentation":"A delimiter is a character you use to group keys.", "location":"querystring", "locationName":"delimiter" }, "EncodingType":{ "shape":"EncodingType", "location":"querystring", "locationName":"encoding-type" }, "Marker":{ "shape":"Marker", "documentation":"Specifies the key to start with when listing objects in a bucket.", "location":"querystring", "locationName":"marker" }, "MaxKeys":{ "shape":"MaxKeys", "documentation":"Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.", "location":"querystring", "locationName":"max-keys" }, "Prefix":{ "shape":"Prefix", "documentation":"Limits the response to keys that begin with the specified prefix.", "location":"querystring", "locationName":"prefix" }, "RequestPayer":{ "shape":"RequestPayer", "documentation":"Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.", "location":"header", "locationName":"x-amz-request-payer" } } }, "ListObjectsV2Output":{ "type":"structure", "members":{ "IsTruncated":{ "shape":"IsTruncated", "documentation":"A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria." }, "Contents":{ "shape":"ObjectList", "documentation":"Metadata about each object returned." }, "Name":{ "shape":"BucketName", "documentation":"Name of the bucket to list." }, "Prefix":{ "shape":"Prefix", "documentation":"Limits the response to keys that begin with the specified prefix." }, "Delimiter":{ "shape":"Delimiter", "documentation":"A delimiter is a character you use to group keys." }, "MaxKeys":{ "shape":"MaxKeys", "documentation":"Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more." }, "CommonPrefixes":{ "shape":"CommonPrefixList", "documentation":"CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter" }, "EncodingType":{ "shape":"EncodingType", "documentation":"Encoding type used by Amazon S3 to encode object keys in the response." }, "KeyCount":{ "shape":"KeyCount", "documentation":"KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys" }, "ContinuationToken":{ "shape":"Token", "documentation":"ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key" }, "NextContinuationToken":{ "shape":"NextToken", "documentation":"NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key" }, "StartAfter":{ "shape":"StartAfter", "documentation":"StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket" } } }, "ListObjectsV2Request":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"Name of the bucket to list.", "location":"uri", "locationName":"Bucket" }, "Delimiter":{ "shape":"Delimiter", "documentation":"A delimiter is a character you use to group keys.", "location":"querystring", "locationName":"delimiter" }, "EncodingType":{ "shape":"EncodingType", "documentation":"Encoding type used by Amazon S3 to encode object keys in the response.", "location":"querystring", "locationName":"encoding-type" }, "MaxKeys":{ "shape":"MaxKeys", "documentation":"Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.", "location":"querystring", "locationName":"max-keys" }, "Prefix":{ "shape":"Prefix", "documentation":"Limits the response to keys that begin with the specified prefix.", "location":"querystring", "locationName":"prefix" }, "ContinuationToken":{ "shape":"Token", "documentation":"ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key", "location":"querystring", "locationName":"continuation-token" }, "FetchOwner":{ "shape":"FetchOwner", "documentation":"The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true", "location":"querystring", "locationName":"fetch-owner" }, "StartAfter":{ "shape":"StartAfter", "documentation":"StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket", "location":"querystring", "locationName":"start-after" }, "RequestPayer":{ "shape":"RequestPayer", "documentation":"Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.", "location":"header", "locationName":"x-amz-request-payer" } } }, "ListPartsOutput":{ "type":"structure", "members":{ "AbortDate":{ "shape":"AbortDate", "documentation":"Date when multipart upload will become eligible for abort operation by lifecycle.", "location":"header", "locationName":"x-amz-abort-date" }, "AbortRuleId":{ "shape":"AbortRuleId", "documentation":"Id of the lifecycle rule that makes a multipart upload eligible for abort operation.", "location":"header", "locationName":"x-amz-abort-rule-id" }, "Bucket":{ "shape":"BucketName", "documentation":"Name of the bucket to which the multipart upload was initiated." }, "Key":{ "shape":"ObjectKey", "documentation":"Object key for which the multipart upload was initiated." }, "UploadId":{ "shape":"MultipartUploadId", "documentation":"Upload ID identifying the multipart upload whose parts are being listed." }, "PartNumberMarker":{ "shape":"PartNumberMarker", "documentation":"Part number after which listing begins." }, "NextPartNumberMarker":{ "shape":"NextPartNumberMarker", "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." }, "MaxParts":{ "shape":"MaxParts", "documentation":"Maximum number of parts that were allowed in the response." }, "IsTruncated":{ "shape":"IsTruncated", "documentation":"Indicates whether the returned list of parts is truncated." }, "Parts":{ "shape":"Parts", "locationName":"Part" }, "Initiator":{ "shape":"Initiator", "documentation":"Identifies who initiated the multipart upload." }, "Owner":{"shape":"Owner"}, "StorageClass":{ "shape":"StorageClass", "documentation":"The class of storage used to store the object." }, "RequestCharged":{ "shape":"RequestCharged", "location":"header", "locationName":"x-amz-request-charged" } } }, "ListPartsRequest":{ "type":"structure", "required":[ "Bucket", "Key", "UploadId" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "Key":{ "shape":"ObjectKey", "location":"uri", "locationName":"Key" }, "MaxParts":{ "shape":"MaxParts", "documentation":"Sets the maximum number of parts to return.", "location":"querystring", "locationName":"max-parts" }, "PartNumberMarker":{ "shape":"PartNumberMarker", "documentation":"Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.", "location":"querystring", "locationName":"part-number-marker" }, "UploadId":{ "shape":"MultipartUploadId", "documentation":"Upload ID identifying the multipart upload whose parts are being listed.", "location":"querystring", "locationName":"uploadId" }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", "locationName":"x-amz-request-payer" } } }, "Location":{"type":"string"}, "LoggingEnabled":{ "type":"structure", "members":{ "TargetBucket":{ "shape":"TargetBucket", "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":{"shape":"TargetGrants"}, "TargetPrefix":{ "shape":"TargetPrefix", "documentation":"This element lets you specify a prefix for the keys that the log files will be stored under." } } }, "MFA":{"type":"string"}, "MFADelete":{ "type":"string", "enum":[ "Enabled", "Disabled" ] }, "MFADeleteStatus":{ "type":"string", "enum":[ "Enabled", "Disabled" ] }, "Marker":{"type":"string"}, "MaxAgeSeconds":{"type":"integer"}, "MaxKeys":{"type":"integer"}, "MaxParts":{"type":"integer"}, "MaxUploads":{"type":"integer"}, "Message":{"type":"string"}, "Metadata":{ "type":"map", "key":{"shape":"MetadataKey"}, "value":{"shape":"MetadataValue"} }, "MetadataDirective":{ "type":"string", "enum":[ "COPY", "REPLACE" ] }, "MetadataKey":{"type":"string"}, "MetadataValue":{"type":"string"}, "MetricsAndOperator":{ "type":"structure", "members":{ "Prefix":{ "shape":"Prefix", "documentation":"The prefix used when evaluating an AND predicate." }, "Tags":{ "shape":"TagSet", "documentation":"The list of tags used when evaluating an AND predicate.", "flattened":true, "locationName":"Tag" } } }, "MetricsConfiguration":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"MetricsId", "documentation":"The ID used to identify the metrics configuration." }, "Filter":{ "shape":"MetricsFilter", "documentation":"Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator)." } } }, "MetricsConfigurationList":{ "type":"list", "member":{"shape":"MetricsConfiguration"}, "flattened":true }, "MetricsFilter":{ "type":"structure", "members":{ "Prefix":{ "shape":"Prefix", "documentation":"The prefix used when evaluating a metrics filter." }, "Tag":{ "shape":"Tag", "documentation":"The tag used when evaluating a metrics filter." }, "And":{ "shape":"MetricsAndOperator", "documentation":"A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply." } } }, "MetricsId":{"type":"string"}, "MissingMeta":{"type":"integer"}, "MultipartUpload":{ "type":"structure", "members":{ "UploadId":{ "shape":"MultipartUploadId", "documentation":"Upload ID that identifies the multipart upload." }, "Key":{ "shape":"ObjectKey", "documentation":"Key of the object for which the multipart upload was initiated." }, "Initiated":{ "shape":"Initiated", "documentation":"Date and time at which the multipart upload was initiated." }, "StorageClass":{ "shape":"StorageClass", "documentation":"The class of storage used to store the object." }, "Owner":{"shape":"Owner"}, "Initiator":{ "shape":"Initiator", "documentation":"Identifies who initiated the multipart upload." } } }, "MultipartUploadId":{"type":"string"}, "MultipartUploadList":{ "type":"list", "member":{"shape":"MultipartUpload"}, "flattened":true }, "NextKeyMarker":{"type":"string"}, "NextMarker":{"type":"string"}, "NextPartNumberMarker":{"type":"integer"}, "NextToken":{"type":"string"}, "NextUploadIdMarker":{"type":"string"}, "NextVersionIdMarker":{"type":"string"}, "NoSuchBucket":{ "type":"structure", "members":{ }, "documentation":"The specified bucket does not exist.", "exception":true }, "NoSuchKey":{ "type":"structure", "members":{ }, "documentation":"The specified key does not exist.", "exception":true }, "NoSuchUpload":{ "type":"structure", "members":{ }, "documentation":"The specified multipart upload does not exist.", "exception":true }, "NoncurrentVersionExpiration":{ "type":"structure", "members":{ "NoncurrentDays":{ "shape":"Days", "documentation":"Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide." } }, "documentation":"Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime." }, "NoncurrentVersionTransition":{ "type":"structure", "members":{ "NoncurrentDays":{ "shape":"Days", "documentation":"Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide." }, "StorageClass":{ "shape":"TransitionStorageClass", "documentation":"The class of storage used to store the object." } }, "documentation":"Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA or GLACIER storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA or GLACIER storage class at a specific period in the object's lifetime." }, "NoncurrentVersionTransitionList":{ "type":"list", "member":{"shape":"NoncurrentVersionTransition"}, "flattened":true }, "NotificationConfiguration":{ "type":"structure", "members":{ "TopicConfigurations":{ "shape":"TopicConfigurationList", "locationName":"TopicConfiguration" }, "QueueConfigurations":{ "shape":"QueueConfigurationList", "locationName":"QueueConfiguration" }, "LambdaFunctionConfigurations":{ "shape":"LambdaFunctionConfigurationList", "locationName":"CloudFunctionConfiguration" } }, "documentation":"Container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off on the bucket." }, "NotificationConfigurationDeprecated":{ "type":"structure", "members":{ "TopicConfiguration":{"shape":"TopicConfigurationDeprecated"}, "QueueConfiguration":{"shape":"QueueConfigurationDeprecated"}, "CloudFunctionConfiguration":{"shape":"CloudFunctionConfiguration"} } }, "NotificationConfigurationFilter":{ "type":"structure", "members":{ "Key":{ "shape":"S3KeyFilter", "locationName":"S3Key" } }, "documentation":"Container for object key name filtering rules. For information about key name filtering, go to Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide." }, "NotificationId":{ "type":"string", "documentation":"Optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID." }, "Object":{ "type":"structure", "members":{ "Key":{"shape":"ObjectKey"}, "LastModified":{"shape":"LastModified"}, "ETag":{"shape":"ETag"}, "Size":{"shape":"Size"}, "StorageClass":{ "shape":"ObjectStorageClass", "documentation":"The class of storage used to store the object." }, "Owner":{"shape":"Owner"} } }, "ObjectAlreadyInActiveTierError":{ "type":"structure", "members":{ }, "documentation":"This operation is not allowed against this storage tier", "exception":true }, "ObjectCannedACL":{ "type":"string", "enum":[ "private", "public-read", "public-read-write", "authenticated-read", "aws-exec-read", "bucket-owner-read", "bucket-owner-full-control" ] }, "ObjectIdentifier":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"ObjectKey", "documentation":"Key name of the object to delete." }, "VersionId":{ "shape":"ObjectVersionId", "documentation":"VersionId for the specific version of the object to delete." } } }, "ObjectIdentifierList":{ "type":"list", "member":{"shape":"ObjectIdentifier"}, "flattened":true }, "ObjectKey":{ "type":"string", "min":1 }, "ObjectList":{ "type":"list", "member":{"shape":"Object"}, "flattened":true }, "ObjectNotInActiveTierError":{ "type":"structure", "members":{ }, "documentation":"The source object of the COPY operation is not in the active tier and is only stored in Amazon Glacier.", "exception":true }, "ObjectStorageClass":{ "type":"string", "enum":[ "STANDARD", "REDUCED_REDUNDANCY", "GLACIER" ] }, "ObjectVersion":{ "type":"structure", "members":{ "ETag":{"shape":"ETag"}, "Size":{ "shape":"Size", "documentation":"Size in bytes of the object." }, "StorageClass":{ "shape":"ObjectVersionStorageClass", "documentation":"The class of storage used to store the object." }, "Key":{ "shape":"ObjectKey", "documentation":"The object key." }, "VersionId":{ "shape":"ObjectVersionId", "documentation":"Version ID of an object." }, "IsLatest":{ "shape":"IsLatest", "documentation":"Specifies whether the object is (true) or is not (false) the latest version of an object." }, "LastModified":{ "shape":"LastModified", "documentation":"Date and time the object was last modified." }, "Owner":{"shape":"Owner"} } }, "ObjectVersionId":{"type":"string"}, "ObjectVersionList":{ "type":"list", "member":{"shape":"ObjectVersion"}, "flattened":true }, "ObjectVersionStorageClass":{ "type":"string", "enum":["STANDARD"] }, "Owner":{ "type":"structure", "members":{ "DisplayName":{"shape":"DisplayName"}, "ID":{"shape":"ID"} } }, "Part":{ "type":"structure", "members":{ "PartNumber":{ "shape":"PartNumber", "documentation":"Part number identifying the part. This is a positive integer between 1 and 10,000." }, "LastModified":{ "shape":"LastModified", "documentation":"Date and time at which the part was uploaded." }, "ETag":{ "shape":"ETag", "documentation":"Entity tag returned when the part was uploaded." }, "Size":{ "shape":"Size", "documentation":"Size of the uploaded part data." } } }, "PartNumber":{"type":"integer"}, "PartNumberMarker":{"type":"integer"}, "Parts":{ "type":"list", "member":{"shape":"Part"}, "flattened":true }, "PartsCount":{"type":"integer"}, "Payer":{ "type":"string", "enum":[ "Requester", "BucketOwner" ] }, "Permission":{ "type":"string", "enum":[ "FULL_CONTROL", "WRITE", "WRITE_ACP", "READ", "READ_ACP" ] }, "Policy":{"type":"string"}, "Prefix":{"type":"string"}, "Protocol":{ "type":"string", "enum":[ "http", "https" ] }, "PutBucketAccelerateConfigurationRequest":{ "type":"structure", "required":[ "Bucket", "AccelerateConfiguration" ], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"Name of the bucket for which the accelerate configuration is set.", "location":"uri", "locationName":"Bucket" }, "AccelerateConfiguration":{ "shape":"AccelerateConfiguration", "documentation":"Specifies the Accelerate Configuration you want to set for the bucket.", "locationName":"AccelerateConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} } }, "payload":"AccelerateConfiguration" }, "PutBucketAclRequest":{ "type":"structure", "required":["Bucket"], "members":{ "ACL":{ "shape":"BucketCannedACL", "documentation":"The canned ACL to apply to the bucket.", "location":"header", "locationName":"x-amz-acl" }, "AccessControlPolicy":{ "shape":"AccessControlPolicy", "locationName":"AccessControlPolicy", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} }, "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "ContentMD5":{ "shape":"ContentMD5", "location":"header", "locationName":"Content-MD5" }, "GrantFullControl":{ "shape":"GrantFullControl", "documentation":"Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.", "location":"header", "locationName":"x-amz-grant-full-control" }, "GrantRead":{ "shape":"GrantRead", "documentation":"Allows grantee to list the objects in the bucket.", "location":"header", "locationName":"x-amz-grant-read" }, "GrantReadACP":{ "shape":"GrantReadACP", "documentation":"Allows grantee to read the bucket ACL.", "location":"header", "locationName":"x-amz-grant-read-acp" }, "GrantWrite":{ "shape":"GrantWrite", "documentation":"Allows grantee to create, overwrite, and delete any object in the bucket.", "location":"header", "locationName":"x-amz-grant-write" }, "GrantWriteACP":{ "shape":"GrantWriteACP", "documentation":"Allows grantee to write the ACL for the applicable bucket.", "location":"header", "locationName":"x-amz-grant-write-acp" } }, "payload":"AccessControlPolicy" }, "PutBucketAnalyticsConfigurationRequest":{ "type":"structure", "required":[ "Bucket", "Id", "AnalyticsConfiguration" ], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket to which an analytics configuration is stored.", "location":"uri", "locationName":"Bucket" }, "Id":{ "shape":"AnalyticsId", "documentation":"The identifier used to represent an analytics configuration.", "location":"querystring", "locationName":"id" }, "AnalyticsConfiguration":{ "shape":"AnalyticsConfiguration", "documentation":"The configuration and any analyses for the analytics filter.", "locationName":"AnalyticsConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} } }, "payload":"AnalyticsConfiguration" }, "PutBucketCorsRequest":{ "type":"structure", "required":[ "Bucket", "CORSConfiguration" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "CORSConfiguration":{ "shape":"CORSConfiguration", "locationName":"CORSConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} }, "ContentMD5":{ "shape":"ContentMD5", "location":"header", "locationName":"Content-MD5" } }, "payload":"CORSConfiguration" }, "PutBucketInventoryConfigurationRequest":{ "type":"structure", "required":[ "Bucket", "Id", "InventoryConfiguration" ], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket where the inventory configuration will be stored.", "location":"uri", "locationName":"Bucket" }, "Id":{ "shape":"InventoryId", "documentation":"The ID used to identify the inventory configuration.", "location":"querystring", "locationName":"id" }, "InventoryConfiguration":{ "shape":"InventoryConfiguration", "documentation":"Specifies the inventory configuration.", "locationName":"InventoryConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} } }, "payload":"InventoryConfiguration" }, "PutBucketLifecycleConfigurationRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "LifecycleConfiguration":{ "shape":"BucketLifecycleConfiguration", "locationName":"LifecycleConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} } }, "payload":"LifecycleConfiguration" }, "PutBucketLifecycleRequest":{ "type":"structure", "required":["Bucket"], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "ContentMD5":{ "shape":"ContentMD5", "location":"header", "locationName":"Content-MD5" }, "LifecycleConfiguration":{ "shape":"LifecycleConfiguration", "locationName":"LifecycleConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} } }, "payload":"LifecycleConfiguration" }, "PutBucketLoggingRequest":{ "type":"structure", "required":[ "Bucket", "BucketLoggingStatus" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "BucketLoggingStatus":{ "shape":"BucketLoggingStatus", "locationName":"BucketLoggingStatus", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} }, "ContentMD5":{ "shape":"ContentMD5", "location":"header", "locationName":"Content-MD5" } }, "payload":"BucketLoggingStatus" }, "PutBucketMetricsConfigurationRequest":{ "type":"structure", "required":[ "Bucket", "Id", "MetricsConfiguration" ], "members":{ "Bucket":{ "shape":"BucketName", "documentation":"The name of the bucket for which the metrics configuration is set.", "location":"uri", "locationName":"Bucket" }, "Id":{ "shape":"MetricsId", "documentation":"The ID used to identify the metrics configuration.", "location":"querystring", "locationName":"id" }, "MetricsConfiguration":{ "shape":"MetricsConfiguration", "documentation":"Specifies the metrics configuration.", "locationName":"MetricsConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} } }, "payload":"MetricsConfiguration" }, "PutBucketNotificationConfigurationRequest":{ "type":"structure", "required":[ "Bucket", "NotificationConfiguration" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "NotificationConfiguration":{ "shape":"NotificationConfiguration", "locationName":"NotificationConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} } }, "payload":"NotificationConfiguration" }, "PutBucketNotificationRequest":{ "type":"structure", "required":[ "Bucket", "NotificationConfiguration" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "ContentMD5":{ "shape":"ContentMD5", "location":"header", "locationName":"Content-MD5" }, "NotificationConfiguration":{ "shape":"NotificationConfigurationDeprecated", "locationName":"NotificationConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} } }, "payload":"NotificationConfiguration" }, "PutBucketPolicyRequest":{ "type":"structure", "required":[ "Bucket", "Policy" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "ContentMD5":{ "shape":"ContentMD5", "location":"header", "locationName":"Content-MD5" }, "Policy":{ "shape":"Policy", "documentation":"The bucket policy as a JSON document." } }, "payload":"Policy" }, "PutBucketReplicationRequest":{ "type":"structure", "required":[ "Bucket", "ReplicationConfiguration" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "ContentMD5":{ "shape":"ContentMD5", "location":"header", "locationName":"Content-MD5" }, "ReplicationConfiguration":{ "shape":"ReplicationConfiguration", "locationName":"ReplicationConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} } }, "payload":"ReplicationConfiguration" }, "PutBucketRequestPaymentRequest":{ "type":"structure", "required":[ "Bucket", "RequestPaymentConfiguration" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "ContentMD5":{ "shape":"ContentMD5", "location":"header", "locationName":"Content-MD5" }, "RequestPaymentConfiguration":{ "shape":"RequestPaymentConfiguration", "locationName":"RequestPaymentConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} } }, "payload":"RequestPaymentConfiguration" }, "PutBucketTaggingRequest":{ "type":"structure", "required":[ "Bucket", "Tagging" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "ContentMD5":{ "shape":"ContentMD5", "location":"header", "locationName":"Content-MD5" }, "Tagging":{ "shape":"Tagging", "locationName":"Tagging", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} } }, "payload":"Tagging" }, "PutBucketVersioningRequest":{ "type":"structure", "required":[ "Bucket", "VersioningConfiguration" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "ContentMD5":{ "shape":"ContentMD5", "location":"header", "locationName":"Content-MD5" }, "MFA":{ "shape":"MFA", "documentation":"The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.", "location":"header", "locationName":"x-amz-mfa" }, "VersioningConfiguration":{ "shape":"VersioningConfiguration", "locationName":"VersioningConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} } }, "payload":"VersioningConfiguration" }, "PutBucketWebsiteRequest":{ "type":"structure", "required":[ "Bucket", "WebsiteConfiguration" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "ContentMD5":{ "shape":"ContentMD5", "location":"header", "locationName":"Content-MD5" }, "WebsiteConfiguration":{ "shape":"WebsiteConfiguration", "locationName":"WebsiteConfiguration", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} } }, "payload":"WebsiteConfiguration" }, "PutObjectAclOutput":{ "type":"structure", "members":{ "RequestCharged":{ "shape":"RequestCharged", "location":"header", "locationName":"x-amz-request-charged" } } }, "PutObjectAclRequest":{ "type":"structure", "required":[ "Bucket", "Key" ], "members":{ "ACL":{ "shape":"ObjectCannedACL", "documentation":"The canned ACL to apply to the object.", "location":"header", "locationName":"x-amz-acl" }, "AccessControlPolicy":{ "shape":"AccessControlPolicy", "locationName":"AccessControlPolicy", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} }, "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "ContentMD5":{ "shape":"ContentMD5", "location":"header", "locationName":"Content-MD5" }, "GrantFullControl":{ "shape":"GrantFullControl", "documentation":"Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.", "location":"header", "locationName":"x-amz-grant-full-control" }, "GrantRead":{ "shape":"GrantRead", "documentation":"Allows grantee to list the objects in the bucket.", "location":"header", "locationName":"x-amz-grant-read" }, "GrantReadACP":{ "shape":"GrantReadACP", "documentation":"Allows grantee to read the bucket ACL.", "location":"header", "locationName":"x-amz-grant-read-acp" }, "GrantWrite":{ "shape":"GrantWrite", "documentation":"Allows grantee to create, overwrite, and delete any object in the bucket.", "location":"header", "locationName":"x-amz-grant-write" }, "GrantWriteACP":{ "shape":"GrantWriteACP", "documentation":"Allows grantee to write the ACL for the applicable bucket.", "location":"header", "locationName":"x-amz-grant-write-acp" }, "Key":{ "shape":"ObjectKey", "location":"uri", "locationName":"Key" }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", "locationName":"x-amz-request-payer" }, "VersionId":{ "shape":"ObjectVersionId", "documentation":"VersionId used to reference a specific version of the object.", "location":"querystring", "locationName":"versionId" } }, "payload":"AccessControlPolicy" }, "PutObjectOutput":{ "type":"structure", "members":{ "Expiration":{ "shape":"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.", "location":"header", "locationName":"x-amz-expiration" }, "ETag":{ "shape":"ETag", "documentation":"Entity tag for the uploaded object.", "location":"header", "locationName":"ETag" }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", "location":"header", "locationName":"x-amz-server-side-encryption" }, "VersionId":{ "shape":"ObjectVersionId", "documentation":"Version of the object.", "location":"header", "locationName":"x-amz-version-id" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", "documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "RequestCharged":{ "shape":"RequestCharged", "location":"header", "locationName":"x-amz-request-charged" } } }, "PutObjectRequest":{ "type":"structure", "required":[ "Bucket", "Key" ], "members":{ "ACL":{ "shape":"ObjectCannedACL", "documentation":"The canned ACL to apply to the object.", "location":"header", "locationName":"x-amz-acl" }, "Body":{ "shape":"Body", "documentation":"Object data.", "streaming":true }, "Bucket":{ "shape":"BucketName", "documentation":"Name of the bucket to which the PUT operation was initiated.", "location":"uri", "locationName":"Bucket" }, "CacheControl":{ "shape":"CacheControl", "documentation":"Specifies caching behavior along the request/reply chain.", "location":"header", "locationName":"Cache-Control" }, "ContentDisposition":{ "shape":"ContentDisposition", "documentation":"Specifies presentational information for the object.", "location":"header", "locationName":"Content-Disposition" }, "ContentEncoding":{ "shape":"ContentEncoding", "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.", "location":"header", "locationName":"Content-Encoding" }, "ContentLanguage":{ "shape":"ContentLanguage", "documentation":"The language the content is in.", "location":"header", "locationName":"Content-Language" }, "ContentLength":{ "shape":"ContentLength", "documentation":"Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.", "location":"header", "locationName":"Content-Length" }, "ContentMD5":{ "shape":"ContentMD5", "documentation":"The base64-encoded 128-bit MD5 digest of the part data.", "location":"header", "locationName":"Content-MD5" }, "ContentType":{ "shape":"ContentType", "documentation":"A standard MIME type describing the format of the object data.", "location":"header", "locationName":"Content-Type" }, "Expires":{ "shape":"Expires", "documentation":"The date and time at which the object is no longer cacheable.", "location":"header", "locationName":"Expires" }, "GrantFullControl":{ "shape":"GrantFullControl", "documentation":"Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.", "location":"header", "locationName":"x-amz-grant-full-control" }, "GrantRead":{ "shape":"GrantRead", "documentation":"Allows grantee to read the object data and its metadata.", "location":"header", "locationName":"x-amz-grant-read" }, "GrantReadACP":{ "shape":"GrantReadACP", "documentation":"Allows grantee to read the object ACL.", "location":"header", "locationName":"x-amz-grant-read-acp" }, "GrantWriteACP":{ "shape":"GrantWriteACP", "documentation":"Allows grantee to write the ACL for the applicable object.", "location":"header", "locationName":"x-amz-grant-write-acp" }, "Key":{ "shape":"ObjectKey", "documentation":"Object key for which the PUT operation was initiated.", "location":"uri", "locationName":"Key" }, "Metadata":{ "shape":"Metadata", "documentation":"A map of metadata to store with the object in S3.", "location":"headers", "locationName":"x-amz-meta-" }, "ServerSideEncryption":{ "shape":"ServerSideEncryption", "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", "location":"header", "locationName":"x-amz-server-side-encryption" }, "StorageClass":{ "shape":"StorageClass", "documentation":"The type of storage to use for the object. Defaults to 'STANDARD'.", "location":"header", "locationName":"x-amz-storage-class" }, "WebsiteRedirectLocation":{ "shape":"WebsiteRedirectLocation", "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.", "location":"header", "locationName":"x-amz-website-redirect-location" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256).", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", "documentation":"Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", "locationName":"x-amz-request-payer" }, "Tagging":{ "shape":"TaggingHeader", "documentation":"The tag-set for the object. The tag-set must be encoded as URL Query parameters", "location":"header", "locationName":"x-amz-tagging" } }, "payload":"Body" }, "PutObjectTaggingOutput":{ "type":"structure", "members":{ "VersionId":{ "shape":"ObjectVersionId", "location":"header", "locationName":"x-amz-version-id" } } }, "PutObjectTaggingRequest":{ "type":"structure", "required":[ "Bucket", "Key", "Tagging" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "Key":{ "shape":"ObjectKey", "location":"uri", "locationName":"Key" }, "VersionId":{ "shape":"ObjectVersionId", "location":"querystring", "locationName":"versionId" }, "ContentMD5":{ "shape":"ContentMD5", "location":"header", "locationName":"Content-MD5" }, "Tagging":{ "shape":"Tagging", "locationName":"Tagging", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} } }, "payload":"Tagging" }, "QueueArn":{"type":"string"}, "QueueConfiguration":{ "type":"structure", "required":[ "QueueArn", "Events" ], "members":{ "Id":{"shape":"NotificationId"}, "QueueArn":{ "shape":"QueueArn", "documentation":"Amazon SQS queue ARN to which Amazon S3 will publish a message when it detects events of specified type.", "locationName":"Queue" }, "Events":{ "shape":"EventList", "locationName":"Event" }, "Filter":{"shape":"NotificationConfigurationFilter"} }, "documentation":"Container for specifying an configuration when you want Amazon S3 to publish events to an Amazon Simple Queue Service (Amazon SQS) queue." }, "QueueConfigurationDeprecated":{ "type":"structure", "members":{ "Id":{"shape":"NotificationId"}, "Event":{ "shape":"Event", "deprecated":true }, "Events":{ "shape":"EventList", "locationName":"Event" }, "Queue":{"shape":"QueueArn"} } }, "QueueConfigurationList":{ "type":"list", "member":{"shape":"QueueConfiguration"}, "flattened":true }, "Quiet":{"type":"boolean"}, "Range":{"type":"string"}, "Redirect":{ "type":"structure", "members":{ "HostName":{ "shape":"HostName", "documentation":"The host name to use in the redirect request." }, "HttpRedirectCode":{ "shape":"HttpRedirectCode", "documentation":"The HTTP redirect code to use on the response. Not required if one of the siblings is present." }, "Protocol":{ "shape":"Protocol", "documentation":"Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request." }, "ReplaceKeyPrefixWith":{ "shape":"ReplaceKeyPrefixWith", "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":{ "shape":"ReplaceKeyWith", "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." } } }, "RedirectAllRequestsTo":{ "type":"structure", "required":["HostName"], "members":{ "HostName":{ "shape":"HostName", "documentation":"Name of the host where requests will be redirected." }, "Protocol":{ "shape":"Protocol", "documentation":"Protocol to use (http, https) when redirecting requests. The default is the protocol that is used in the original request." } } }, "ReplaceKeyPrefixWith":{"type":"string"}, "ReplaceKeyWith":{"type":"string"}, "ReplicationConfiguration":{ "type":"structure", "required":[ "Role", "Rules" ], "members":{ "Role":{ "shape":"Role", "documentation":"Amazon Resource Name (ARN) of an IAM role for Amazon S3 to assume when replicating the objects." }, "Rules":{ "shape":"ReplicationRules", "documentation":"Container for information about a particular replication rule. Replication configuration must have at least one rule and can contain up to 1,000 rules.", "locationName":"Rule" } }, "documentation":"Container for replication rules. You can add as many as 1,000 rules. Total replication configuration size can be up to 2 MB." }, "ReplicationRule":{ "type":"structure", "required":[ "Prefix", "Status", "Destination" ], "members":{ "ID":{ "shape":"ID", "documentation":"Unique identifier for the rule. The value cannot be longer than 255 characters." }, "Prefix":{ "shape":"Prefix", "documentation":"Object keyname prefix identifying one or more objects to which the rule applies. Maximum prefix length can be up to 1,024 characters. Overlapping prefixes are not supported." }, "Status":{ "shape":"ReplicationRuleStatus", "documentation":"The rule is ignored if status is not Enabled." }, "Destination":{"shape":"Destination"} } }, "ReplicationRuleStatus":{ "type":"string", "enum":[ "Enabled", "Disabled" ] }, "ReplicationRules":{ "type":"list", "member":{"shape":"ReplicationRule"}, "flattened":true }, "ReplicationStatus":{ "type":"string", "enum":[ "COMPLETE", "PENDING", "FAILED", "REPLICA" ] }, "RequestCharged":{ "type":"string", "documentation":"If present, indicates that the requester was successfully charged for the request.", "enum":["requester"] }, "RequestPayer":{ "type":"string", "documentation":"Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html", "enum":["requester"] }, "RequestPaymentConfiguration":{ "type":"structure", "required":["Payer"], "members":{ "Payer":{ "shape":"Payer", "documentation":"Specifies who pays for the download and request fees." } } }, "ResponseCacheControl":{"type":"string"}, "ResponseContentDisposition":{"type":"string"}, "ResponseContentEncoding":{"type":"string"}, "ResponseContentLanguage":{"type":"string"}, "ResponseContentType":{"type":"string"}, "ResponseExpires":{"type":"timestamp"}, "Restore":{"type":"string"}, "RestoreObjectOutput":{ "type":"structure", "members":{ "RequestCharged":{ "shape":"RequestCharged", "location":"header", "locationName":"x-amz-request-charged" } } }, "RestoreObjectRequest":{ "type":"structure", "required":[ "Bucket", "Key" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "Key":{ "shape":"ObjectKey", "location":"uri", "locationName":"Key" }, "VersionId":{ "shape":"ObjectVersionId", "location":"querystring", "locationName":"versionId" }, "RestoreRequest":{ "shape":"RestoreRequest", "locationName":"RestoreRequest", "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", "locationName":"x-amz-request-payer" } }, "payload":"RestoreRequest" }, "RestoreRequest":{ "type":"structure", "required":["Days"], "members":{ "Days":{ "shape":"Days", "documentation":"Lifetime of the active copy in days" }, "GlacierJobParameters":{ "shape":"GlacierJobParameters", "documentation":"Glacier related prameters pertaining to this job." } } }, "Role":{"type":"string"}, "RoutingRule":{ "type":"structure", "required":["Redirect"], "members":{ "Condition":{ "shape":"Condition", "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":{ "shape":"Redirect", "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." } } }, "RoutingRules":{ "type":"list", "member":{ "shape":"RoutingRule", "locationName":"RoutingRule" } }, "Rule":{ "type":"structure", "required":[ "Prefix", "Status" ], "members":{ "Expiration":{"shape":"LifecycleExpiration"}, "ID":{ "shape":"ID", "documentation":"Unique identifier for the rule. The value cannot be longer than 255 characters." }, "Prefix":{ "shape":"Prefix", "documentation":"Prefix identifying one or more objects to which the rule applies." }, "Status":{ "shape":"ExpirationStatus", "documentation":"If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied." }, "Transition":{"shape":"Transition"}, "NoncurrentVersionTransition":{"shape":"NoncurrentVersionTransition"}, "NoncurrentVersionExpiration":{"shape":"NoncurrentVersionExpiration"}, "AbortIncompleteMultipartUpload":{"shape":"AbortIncompleteMultipartUpload"} } }, "Rules":{ "type":"list", "member":{"shape":"Rule"}, "flattened":true }, "S3KeyFilter":{ "type":"structure", "members":{ "FilterRules":{ "shape":"FilterRuleList", "locationName":"FilterRule" } }, "documentation":"Container for object key name prefix and suffix filtering rules." }, "SSECustomerAlgorithm":{"type":"string"}, "SSECustomerKey":{ "type":"string", "sensitive":true }, "SSECustomerKeyMD5":{"type":"string"}, "SSEKMSKeyId":{ "type":"string", "sensitive":true }, "ServerSideEncryption":{ "type":"string", "enum":[ "AES256", "aws:kms" ] }, "Size":{"type":"integer"}, "StartAfter":{"type":"string"}, "StorageClass":{ "type":"string", "enum":[ "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA" ] }, "StorageClassAnalysis":{ "type":"structure", "members":{ "DataExport":{ "shape":"StorageClassAnalysisDataExport", "documentation":"A container used to describe how data related to the storage class analysis should be exported." } } }, "StorageClassAnalysisDataExport":{ "type":"structure", "required":[ "OutputSchemaVersion", "Destination" ], "members":{ "OutputSchemaVersion":{ "shape":"StorageClassAnalysisSchemaVersion", "documentation":"The version of the output schema to use when exporting data. Must be V_1." }, "Destination":{ "shape":"AnalyticsExportDestination", "documentation":"The place to store the data for an analysis." } } }, "StorageClassAnalysisSchemaVersion":{ "type":"string", "enum":["V_1"] }, "Suffix":{"type":"string"}, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"ObjectKey", "documentation":"Name of the tag." }, "Value":{ "shape":"Value", "documentation":"Value of the tag." } } }, "TagCount":{"type":"integer"}, "TagSet":{ "type":"list", "member":{ "shape":"Tag", "locationName":"Tag" } }, "Tagging":{ "type":"structure", "required":["TagSet"], "members":{ "TagSet":{"shape":"TagSet"} } }, "TaggingDirective":{ "type":"string", "enum":[ "COPY", "REPLACE" ] }, "TaggingHeader":{"type":"string"}, "TargetBucket":{"type":"string"}, "TargetGrant":{ "type":"structure", "members":{ "Grantee":{"shape":"Grantee"}, "Permission":{ "shape":"BucketLogsPermission", "documentation":"Logging permissions assigned to the Grantee for the bucket." } } }, "TargetGrants":{ "type":"list", "member":{ "shape":"TargetGrant", "locationName":"Grant" } }, "TargetPrefix":{"type":"string"}, "Tier":{ "type":"string", "enum":[ "Standard", "Bulk", "Expedited" ] }, "Token":{"type":"string"}, "TopicArn":{"type":"string"}, "TopicConfiguration":{ "type":"structure", "required":[ "TopicArn", "Events" ], "members":{ "Id":{"shape":"NotificationId"}, "TopicArn":{ "shape":"TopicArn", "documentation":"Amazon SNS topic ARN to which Amazon S3 will publish a message when it detects events of specified type.", "locationName":"Topic" }, "Events":{ "shape":"EventList", "locationName":"Event" }, "Filter":{"shape":"NotificationConfigurationFilter"} }, "documentation":"Container for specifying the configuration when you want Amazon S3 to publish events to an Amazon Simple Notification Service (Amazon SNS) topic." }, "TopicConfigurationDeprecated":{ "type":"structure", "members":{ "Id":{"shape":"NotificationId"}, "Events":{ "shape":"EventList", "locationName":"Event" }, "Event":{ "shape":"Event", "documentation":"Bucket event for which to send notifications.", "deprecated":true }, "Topic":{ "shape":"TopicArn", "documentation":"Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket." } } }, "TopicConfigurationList":{ "type":"list", "member":{"shape":"TopicConfiguration"}, "flattened":true }, "Transition":{ "type":"structure", "members":{ "Date":{ "shape":"Date", "documentation":"Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format." }, "Days":{ "shape":"Days", "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":{ "shape":"TransitionStorageClass", "documentation":"The class of storage used to store the object." } } }, "TransitionList":{ "type":"list", "member":{"shape":"Transition"}, "flattened":true }, "TransitionStorageClass":{ "type":"string", "enum":[ "GLACIER", "STANDARD_IA" ] }, "Type":{ "type":"string", "enum":[ "CanonicalUser", "AmazonCustomerByEmail", "Group" ] }, "URI":{"type":"string"}, "UploadIdMarker":{"type":"string"}, "UploadPartCopyOutput":{ "type":"structure", "members":{ "CopySourceVersionId":{ "shape":"CopySourceVersionId", "documentation":"The version of the source object that was copied, if you have enabled versioning on the source bucket.", "location":"header", "locationName":"x-amz-copy-source-version-id" }, "CopyPartResult":{"shape":"CopyPartResult"}, "ServerSideEncryption":{ "shape":"ServerSideEncryption", "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", "location":"header", "locationName":"x-amz-server-side-encryption" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", "documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "RequestCharged":{ "shape":"RequestCharged", "location":"header", "locationName":"x-amz-request-charged" } }, "payload":"CopyPartResult" }, "UploadPartCopyRequest":{ "type":"structure", "required":[ "Bucket", "CopySource", "Key", "PartNumber", "UploadId" ], "members":{ "Bucket":{ "shape":"BucketName", "location":"uri", "locationName":"Bucket" }, "CopySource":{ "shape":"CopySource", "documentation":"The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.", "location":"header", "locationName":"x-amz-copy-source" }, "CopySourceIfMatch":{ "shape":"CopySourceIfMatch", "documentation":"Copies the object if its entity tag (ETag) matches the specified tag.", "location":"header", "locationName":"x-amz-copy-source-if-match" }, "CopySourceIfModifiedSince":{ "shape":"CopySourceIfModifiedSince", "documentation":"Copies the object if it has been modified since the specified time.", "location":"header", "locationName":"x-amz-copy-source-if-modified-since" }, "CopySourceIfNoneMatch":{ "shape":"CopySourceIfNoneMatch", "documentation":"Copies the object if its entity tag (ETag) is different than the specified ETag.", "location":"header", "locationName":"x-amz-copy-source-if-none-match" }, "CopySourceIfUnmodifiedSince":{ "shape":"CopySourceIfUnmodifiedSince", "documentation":"Copies the object if it hasn't been modified since the specified time.", "location":"header", "locationName":"x-amz-copy-source-if-unmodified-since" }, "CopySourceRange":{ "shape":"CopySourceRange", "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.", "location":"header", "locationName":"x-amz-copy-source-range" }, "Key":{ "shape":"ObjectKey", "location":"uri", "locationName":"Key" }, "PartNumber":{ "shape":"PartNumber", "documentation":"Part number of part being copied. This is a positive integer between 1 and 10,000.", "location":"querystring", "locationName":"partNumber" }, "UploadId":{ "shape":"MultipartUploadId", "documentation":"Upload ID identifying the multipart upload whose part is being copied.", "location":"querystring", "locationName":"uploadId" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256).", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "CopySourceSSECustomerAlgorithm":{ "shape":"CopySourceSSECustomerAlgorithm", "documentation":"Specifies the algorithm to use when decrypting the source object (e.g., AES256).", "location":"header", "locationName":"x-amz-copy-source-server-side-encryption-customer-algorithm" }, "CopySourceSSECustomerKey":{ "shape":"CopySourceSSECustomerKey", "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.", "location":"header", "locationName":"x-amz-copy-source-server-side-encryption-customer-key" }, "CopySourceSSECustomerKeyMD5":{ "shape":"CopySourceSSECustomerKeyMD5", "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.", "location":"header", "locationName":"x-amz-copy-source-server-side-encryption-customer-key-MD5" }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", "locationName":"x-amz-request-payer" } } }, "UploadPartOutput":{ "type":"structure", "members":{ "ServerSideEncryption":{ "shape":"ServerSideEncryption", "documentation":"The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).", "location":"header", "locationName":"x-amz-server-side-encryption" }, "ETag":{ "shape":"ETag", "documentation":"Entity tag for the uploaded object.", "location":"header", "locationName":"ETag" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", "documentation":"If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId":{ "shape":"SSEKMSKeyId", "documentation":"If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.", "location":"header", "locationName":"x-amz-server-side-encryption-aws-kms-key-id" }, "RequestCharged":{ "shape":"RequestCharged", "location":"header", "locationName":"x-amz-request-charged" } } }, "UploadPartRequest":{ "type":"structure", "required":[ "Bucket", "Key", "PartNumber", "UploadId" ], "members":{ "Body":{ "shape":"Body", "documentation":"Object data.", "streaming":true }, "Bucket":{ "shape":"BucketName", "documentation":"Name of the bucket to which the multipart upload was initiated.", "location":"uri", "locationName":"Bucket" }, "ContentLength":{ "shape":"ContentLength", "documentation":"Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.", "location":"header", "locationName":"Content-Length" }, "ContentMD5":{ "shape":"ContentMD5", "documentation":"The base64-encoded 128-bit MD5 digest of the part data.", "location":"header", "locationName":"Content-MD5" }, "Key":{ "shape":"ObjectKey", "documentation":"Object key for which the multipart upload was initiated.", "location":"uri", "locationName":"Key" }, "PartNumber":{ "shape":"PartNumber", "documentation":"Part number of part being uploaded. This is a positive integer between 1 and 10,000.", "location":"querystring", "locationName":"partNumber" }, "UploadId":{ "shape":"MultipartUploadId", "documentation":"Upload ID identifying the multipart upload whose part is being uploaded.", "location":"querystring", "locationName":"uploadId" }, "SSECustomerAlgorithm":{ "shape":"SSECustomerAlgorithm", "documentation":"Specifies the algorithm to use to when encrypting the object (e.g., AES256).", "location":"header", "locationName":"x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey":{ "shape":"SSECustomerKey", "documentation":"Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5":{ "shape":"SSECustomerKeyMD5", "documentation":"Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.", "location":"header", "locationName":"x-amz-server-side-encryption-customer-key-MD5" }, "RequestPayer":{ "shape":"RequestPayer", "location":"header", "locationName":"x-amz-request-payer" } }, "payload":"Body" }, "Value":{"type":"string"}, "VersionIdMarker":{"type":"string"}, "VersioningConfiguration":{ "type":"structure", "members":{ "MFADelete":{ "shape":"MFADelete", "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.", "locationName":"MfaDelete" }, "Status":{ "shape":"BucketVersioningStatus", "documentation":"The versioning state of the bucket." } } }, "WebsiteConfiguration":{ "type":"structure", "members":{ "ErrorDocument":{"shape":"ErrorDocument"}, "IndexDocument":{"shape":"IndexDocument"}, "RedirectAllRequestsTo":{"shape":"RedirectAllRequestsTo"}, "RoutingRules":{"shape":"RoutingRules"} } }, "WebsiteRedirectLocation":{"type":"string"} } } botocore-1.5.7/botocore/data/sdb/0000777454262600001440000000000013042511307017703 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/sdb/2009-04-15/0000777454262600001440000000000013042511307020741 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/sdb/2009-04-15/paginators-1.json0000666454262600001440000000047513042511306024146 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListDomains": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxNumberOfDomains", "result_key": "DomainNames" }, "Select": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Items" } } } botocore-1.5.7/botocore/data/sdb/2009-04-15/service-2.json0000666454262600001440000012653113042511306023442 0ustar pysdk-ciamazon00000000000000{ "metadata":{ "uid":"sdb-2009-04-15", "apiVersion":"2009-04-15", "endpointPrefix":"sdb", "serviceFullName":"Amazon SimpleDB", "signatureVersion":"v2", "xmlNamespace":"http://sdb.amazonaws.com/doc/2009-04-15/", "protocol":"query" }, "documentation":"Amazon SimpleDB is a web service providing the core database functions of data indexing and querying in the cloud. By offloading the time and effort associated with building and operating a web-scale database, SimpleDB provides developers the freedom to focus on application development.

A traditional, clustered relational database requires a sizable upfront capital outlay, is complex to design, and often requires extensive and repetitive database administration. Amazon SimpleDB is dramatically simpler, requiring no schema, automatically indexing your data and providing a simple API for storage and access. This approach eliminates the administrative burden of data modeling, index maintenance, and performance tuning. Developers gain access to this functionality within Amazon's proven computing environment, are able to scale instantly, and pay only for what they use.

Visit http://aws.amazon.com/simpledb/ for more information.

", "operations":{ "BatchDeleteAttributes":{ "name":"BatchDeleteAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchDeleteAttributesRequest"}, "documentation":"

Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies. This enables Amazon SimpleDB to optimize requests, which generally yields better throughput.

The following limitations are enforced for this operation:

  • 1 MB request size
  • 25 item limit per BatchDeleteAttributes operation

" }, "BatchPutAttributes":{ "name":"BatchPutAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchPutAttributesRequest"}, "errors":[ { "shape":"DuplicateItemName", "error":{ "code":"DuplicateItemName", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The item name was specified more than once.

" }, { "shape":"InvalidParameterValue", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"MissingParameter", "error":{ "code":"MissingParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request must contain the specified missing parameter.

" }, { "shape":"NoSuchDomain", "error":{ "code":"NoSuchDomain", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified domain does not exist.

" }, { "shape":"NumberItemAttributesExceeded", "error":{ "code":"NumberItemAttributesExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

Too many attributes in this item.

" }, { "shape":"NumberDomainAttributesExceeded", "error":{ "code":"NumberDomainAttributesExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

Too many attributes in this domain.

" }, { "shape":"NumberDomainBytesExceeded", "error":{ "code":"NumberDomainBytesExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

Too many bytes in this domain.

" }, { "shape":"NumberSubmittedItemsExceeded", "error":{ "code":"NumberSubmittedItemsExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

Too many items exist in a single call.

" }, { "shape":"NumberSubmittedAttributesExceeded", "error":{ "code":"NumberSubmittedAttributesExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

Too many attributes exist in a single call.

" } ], "documentation":"

The BatchPutAttributes operation creates or replaces attributes within one or more items. By using this operation, the client can perform multiple PutAttribute operation with a single call. This helps yield savings in round trips and latencies, enabling Amazon SimpleDB to optimize requests and generally produce better throughput.

The client may specify the item name with the Item.X.ItemName parameter. The client may specify new attributes using a combination of the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value parameters. The client may specify the first attribute for the first item using the parameters Item.0.Attribute.0.Name and Item.0.Attribute.0.Value, and for the second attribute for the first item by the parameters Item.0.Attribute.1.Name and Item.0.Attribute.1.Value, and so on.

Attributes are uniquely identified within an item by their name/value combination. For example, a single item can have the attributes { \"first_name\", \"first_value\" } and { \"first_name\", \"second_value\" }. However, it cannot have two attribute instances where both the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value are the same.

Optionally, the requester can supply the Replace parameter for each individual value. Setting this value to true will cause the new attribute values to replace the existing attribute values. For example, if an item I has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requester does a BatchPutAttributes of {'I', 'b', '4' } with the Replace parameter set to true, the final attributes of the item will be { 'a', '1' } and { 'b', '4' }, replacing the previous values of the 'b' attribute with the new value.

This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method. This operation does not support conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists.

You can execute multiple BatchPutAttributes operations and other operations in parallel. However, large numbers of concurrent BatchPutAttributes calls can result in Service Unavailable (503) responses.

The following limitations are enforced for this operation:

  • 256 attribute name-value pairs per item
  • 1 MB request size
  • 1 billion attributes per domain
  • 10 GB of total user data storage per domain
  • 25 item limit per BatchPutAttributes operation

" }, "CreateDomain":{ "name":"CreateDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDomainRequest"}, "errors":[ { "shape":"InvalidParameterValue", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"MissingParameter", "error":{ "code":"MissingParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request must contain the specified missing parameter.

" }, { "shape":"NumberDomainsExceeded", "error":{ "code":"NumberDomainsExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

Too many domains exist per this account.

" } ], "documentation":"

The CreateDomain operation creates a new domain. The domain name should be unique among the domains associated with the Access Key ID provided in the request. The CreateDomain operation may take 10 or more seconds to complete.

The client can create up to 100 domains per account.

If the client requires additional domains, go to http://aws.amazon.com/contact-us/simpledb-limit-request/.

" }, "DeleteAttributes":{ "name":"DeleteAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAttributesRequest"}, "errors":[ { "shape":"InvalidParameterValue", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"MissingParameter", "error":{ "code":"MissingParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request must contain the specified missing parameter.

" }, { "shape":"NoSuchDomain", "error":{ "code":"NoSuchDomain", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified domain does not exist.

" }, { "shape":"AttributeDoesNotExist", "error":{ "code":"AttributeDoesNotExist", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified attribute does not exist.

" } ], "documentation":"

Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is deleted.

DeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Because Amazon SimpleDB makes multiple copies of item data and uses an eventual consistency update model, performing a GetAttributes or Select operation (read) immediately after a DeleteAttributes or PutAttributes operation (write) might not return updated item data.

" }, "DeleteDomain":{ "name":"DeleteDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDomainRequest"}, "errors":[ { "shape":"MissingParameter", "error":{ "code":"MissingParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request must contain the specified missing parameter.

" } ], "documentation":"

The DeleteDomain operation deletes a domain. Any items (and their attributes) in the domain are deleted as well. The DeleteDomain operation might take 10 or more seconds to complete.

" }, "DomainMetadata":{ "name":"DomainMetadata", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DomainMetadataRequest"}, "output":{ "shape":"DomainMetadataResult", "resultWrapper":"DomainMetadataResult" }, "errors":[ { "shape":"MissingParameter", "error":{ "code":"MissingParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request must contain the specified missing parameter.

" }, { "shape":"NoSuchDomain", "error":{ "code":"NoSuchDomain", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified domain does not exist.

" } ], "documentation":"

Returns information about the domain, including when the domain was created, the number of items and attributes in the domain, and the size of the attribute names and values.

" }, "GetAttributes":{ "name":"GetAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAttributesRequest"}, "output":{ "shape":"GetAttributesResult", "resultWrapper":"GetAttributesResult" }, "errors":[ { "shape":"InvalidParameterValue", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"MissingParameter", "error":{ "code":"MissingParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request must contain the specified missing parameter.

" }, { "shape":"NoSuchDomain", "error":{ "code":"NoSuchDomain", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified domain does not exist.

" } ], "documentation":"

Returns all of the attributes associated with the specified item. Optionally, the attributes returned can be limited to one or more attributes by specifying an attribute name parameter.

If the item does not exist on the replica that was accessed for this operation, an empty set is returned. The system does not return an error as it cannot guarantee the item does not exist on other replicas.

" }, "ListDomains":{ "name":"ListDomains", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDomainsRequest"}, "output":{ "shape":"ListDomainsResult", "resultWrapper":"ListDomainsResult" }, "errors":[ { "shape":"InvalidParameterValue", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidNextToken", "error":{ "code":"InvalidNextToken", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified NextToken is not valid.

" } ], "documentation":"

The ListDomains operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times with the NextToken provided by the operation returns up to MaxNumberOfDomains more domain names with each successive operation call.

" }, "PutAttributes":{ "name":"PutAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutAttributesRequest"}, "errors":[ { "shape":"InvalidParameterValue", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"MissingParameter", "error":{ "code":"MissingParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request must contain the specified missing parameter.

" }, { "shape":"NoSuchDomain", "error":{ "code":"NoSuchDomain", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified domain does not exist.

" }, { "shape":"NumberDomainAttributesExceeded", "error":{ "code":"NumberDomainAttributesExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

Too many attributes in this domain.

" }, { "shape":"NumberDomainBytesExceeded", "error":{ "code":"NumberDomainBytesExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

Too many bytes in this domain.

" }, { "shape":"NumberItemAttributesExceeded", "error":{ "code":"NumberItemAttributesExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

Too many attributes in this item.

" }, { "shape":"AttributeDoesNotExist", "error":{ "code":"AttributeDoesNotExist", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified attribute does not exist.

" } ], "documentation":"

The PutAttributes operation creates or replaces attributes in an item. The client may specify new attributes using a combination of the Attribute.X.Name and Attribute.X.Value parameters. The client specifies the first attribute by the parameters Attribute.0.Name and Attribute.0.Value, the second attribute by the parameters Attribute.1.Name and Attribute.1.Value, and so on.

Attributes are uniquely identified in an item by their name/value combination. For example, a single item can have the attributes { \"first_name\", \"first_value\" } and { \"first_name\", second_value\" }. However, it cannot have two attribute instances where both the Attribute.X.Name and Attribute.X.Value are the same.

Optionally, the requestor can supply the Replace parameter for each individual attribute. Setting this value to true causes the new attribute value to replace the existing attribute value(s). For example, if an item has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requestor calls PutAttributes using the attributes { 'b', '4' } with the Replace parameter set to true, the final attributes of the item are changed to { 'a', '1' } and { 'b', '4' }, which replaces the previous values of the 'b' attribute with the new value.

You cannot specify an empty string as an attribute name.

Because Amazon SimpleDB makes multiple copies of client data and uses an eventual consistency update model, an immediate GetAttributes or Select operation (read) immediately after a PutAttributes or DeleteAttributes operation (write) might not return the updated data.

The following limitations are enforced for this operation:

  • 256 total attribute name-value pairs per item
  • One billion attributes per domain
  • 10 GB of total user data storage per domain

" }, "Select":{ "name":"Select", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SelectRequest"}, "output":{ "shape":"SelectResult", "resultWrapper":"SelectResult" }, "errors":[ { "shape":"InvalidParameterValue", "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, { "shape":"InvalidNextToken", "error":{ "code":"InvalidNextToken", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified NextToken is not valid.

" }, { "shape":"InvalidNumberPredicates", "error":{ "code":"InvalidNumberPredicates", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Too many predicates exist in the query expression.

" }, { "shape":"InvalidNumberValueTests", "error":{ "code":"InvalidNumberValueTests", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Too many predicates exist in the query expression.

" }, { "shape":"InvalidQueryExpression", "error":{ "code":"InvalidQueryExpression", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified query expression syntax is not valid.

" }, { "shape":"MissingParameter", "error":{ "code":"MissingParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request must contain the specified missing parameter.

" }, { "shape":"NoSuchDomain", "error":{ "code":"NoSuchDomain", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified domain does not exist.

" }, { "shape":"RequestTimeout", "error":{ "code":"RequestTimeout", "httpStatusCode":408, "senderFault":true }, "exception":true, "documentation":"

A timeout occurred when attempting to query the specified domain with specified query expression.

" }, { "shape":"TooManyRequestedAttributes", "error":{ "code":"TooManyRequestedAttributes", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Too many attributes requested.

" } ], "documentation":"

The Select operation returns a set of attributes for ItemNames that match the select expression. Select is similar to the standard SQL SELECT statement.

The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items returned per page to enforce this limit. For example, if the client asks to retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100 items and an appropriate NextToken so the client can access the next page of results.

For information on how to construct select expressions, see Using Select to Create Amazon SimpleDB Queries in the Developer Guide.

" } }, "shapes":{ "Attribute":{ "type":"structure", "required":[ "Name", "Value" ], "members":{ "Name":{ "shape":"String", "documentation":"The name of the attribute." }, "AlternateNameEncoding":{ "shape":"String", "documentation":"

" }, "Value":{ "shape":"String", "documentation":"The value of the attribute." }, "AlternateValueEncoding":{ "shape":"String", "documentation":"

" } }, "documentation":"

" }, "AttributeDoesNotExist":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"AttributeDoesNotExist", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"

The specified attribute does not exist.

" }, "AttributeList":{ "type":"list", "member":{ "shape":"Attribute", "locationName":"Attribute" }, "flattened":true }, "AttributeNameList":{ "type":"list", "member":{ "shape":"String", "locationName":"AttributeName" }, "flattened":true }, "BatchDeleteAttributesRequest":{ "type":"structure", "required":[ "DomainName", "Items" ], "members":{ "DomainName":{ "shape":"String", "documentation":"The name of the domain in which the attributes are being deleted." }, "Items":{ "shape":"DeletableItemList", "documentation":"A list of items on which to perform the operation." } } }, "BatchPutAttributesRequest":{ "type":"structure", "required":[ "DomainName", "Items" ], "members":{ "DomainName":{ "shape":"String", "documentation":"The name of the domain in which the attributes are being stored." }, "Items":{ "shape":"ReplaceableItemList", "documentation":"A list of items on which to perform the operation." } } }, "Boolean":{"type":"boolean"}, "CreateDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"String", "documentation":"The name of the domain to create. The name can range between 3 and 255 characters and can contain the following characters: a-z, A-Z, 0-9, '_', '-', and '.'." } } }, "DeletableItem":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"String", "locationName":"ItemName" }, "Attributes":{"shape":"AttributeList"} } }, "DeletableItemList":{ "type":"list", "member":{ "shape":"DeletableItem", "locationName":"Item" }, "flattened":true }, "DeleteAttributesRequest":{ "type":"structure", "required":[ "DomainName", "ItemName" ], "members":{ "DomainName":{ "shape":"String", "documentation":"The name of the domain in which to perform the operation." }, "ItemName":{ "shape":"String", "documentation":"The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs." }, "Attributes":{ "shape":"AttributeList", "documentation":"A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items." }, "Expected":{ "shape":"UpdateCondition", "documentation":"The update condition which, if specified, determines whether the specified attributes will be deleted or not. The update condition must be satisfied in order for this request to be processed and the attributes to be deleted." } } }, "DeleteDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"String", "documentation":"The name of the domain to delete." } } }, "DomainMetadataRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"String", "documentation":"The name of the domain for which to display the metadata of." } } }, "DomainMetadataResult":{ "type":"structure", "members":{ "ItemCount":{ "shape":"Integer", "documentation":"The number of all items in the domain." }, "ItemNamesSizeBytes":{ "shape":"Long", "documentation":"The total size of all item names in the domain, in bytes." }, "AttributeNameCount":{ "shape":"Integer", "documentation":"The number of unique attribute names in the domain." }, "AttributeNamesSizeBytes":{ "shape":"Long", "documentation":"The total size of all unique attribute names in the domain, in bytes." }, "AttributeValueCount":{ "shape":"Integer", "documentation":"The number of all attribute name/value pairs in the domain." }, "AttributeValuesSizeBytes":{ "shape":"Long", "documentation":"The total size of all attribute values in the domain, in bytes." }, "Timestamp":{ "shape":"Integer", "documentation":"The data and time when metadata was calculated, in Epoch (UNIX) seconds." } } }, "DomainNameList":{ "type":"list", "member":{ "shape":"String", "locationName":"DomainName" }, "flattened":true }, "DuplicateItemName":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"DuplicateItemName", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The item name was specified more than once.

" }, "Float":{"type":"float"}, "GetAttributesRequest":{ "type":"structure", "required":[ "DomainName", "ItemName" ], "members":{ "DomainName":{ "shape":"String", "documentation":"The name of the domain in which to perform the operation." }, "ItemName":{ "shape":"String", "documentation":"The name of the item." }, "AttributeNames":{ "shape":"AttributeNameList", "documentation":"The names of the attributes." }, "ConsistentRead":{ "shape":"Boolean", "documentation":"Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If true, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read." } } }, "GetAttributesResult":{ "type":"structure", "members":{ "Attributes":{ "shape":"AttributeList", "documentation":"The list of attributes returned by the operation." } } }, "Integer":{"type":"integer"}, "InvalidNextToken":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"InvalidNextToken", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified NextToken is not valid.

" }, "InvalidNumberPredicates":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"InvalidNumberPredicates", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Too many predicates exist in the query expression.

" }, "InvalidNumberValueTests":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"InvalidNumberValueTests", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Too many predicates exist in the query expression.

" }, "InvalidParameterValue":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"InvalidParameterValue", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The value for a parameter is invalid.

" }, "InvalidQueryExpression":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"InvalidQueryExpression", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified query expression syntax is not valid.

" }, "Item":{ "type":"structure", "required":[ "Name", "Attributes" ], "members":{ "Name":{ "shape":"String", "documentation":"The name of the item." }, "AlternateNameEncoding":{ "shape":"String", "documentation":"

" }, "Attributes":{ "shape":"AttributeList", "documentation":"A list of attributes." } }, "documentation":"

" }, "ItemList":{ "type":"list", "member":{ "shape":"Item", "locationName":"Item" }, "flattened":true }, "ListDomainsRequest":{ "type":"structure", "members":{ "MaxNumberOfDomains":{ "shape":"Integer", "documentation":"The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100." }, "NextToken":{ "shape":"String", "documentation":"A string informing Amazon SimpleDB where to start the next list of domain names." } } }, "ListDomainsResult":{ "type":"structure", "members":{ "DomainNames":{ "shape":"DomainNameList", "documentation":"A list of domain names that match the expression." }, "NextToken":{ "shape":"String", "documentation":"An opaque token indicating that there are more domains than the specified MaxNumberOfDomains still available." } } }, "Long":{"type":"long"}, "MissingParameter":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"MissingParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The request must contain the specified missing parameter.

" }, "NoSuchDomain":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"NoSuchDomain", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The specified domain does not exist.

" }, "NumberDomainAttributesExceeded":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"NumberDomainAttributesExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

Too many attributes in this domain.

" }, "NumberDomainBytesExceeded":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"NumberDomainBytesExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

Too many bytes in this domain.

" }, "NumberDomainsExceeded":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"NumberDomainsExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

Too many domains exist per this account.

" }, "NumberItemAttributesExceeded":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"NumberItemAttributesExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

Too many attributes in this item.

" }, "NumberSubmittedAttributesExceeded":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"NumberSubmittedAttributesExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

Too many attributes exist in a single call.

" }, "NumberSubmittedItemsExceeded":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"NumberSubmittedItemsExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

Too many items exist in a single call.

" }, "PutAttributesRequest":{ "type":"structure", "required":[ "DomainName", "ItemName", "Attributes" ], "members":{ "DomainName":{ "shape":"String", "documentation":"The name of the domain in which to perform the operation." }, "ItemName":{ "shape":"String", "documentation":"The name of the item." }, "Attributes":{ "shape":"ReplaceableAttributeList", "documentation":"The list of attributes." }, "Expected":{ "shape":"UpdateCondition", "documentation":"The update condition which, if specified, determines whether the specified attributes will be updated or not. The update condition must be satisfied in order for this request to be processed and the attributes to be updated." } } }, "ReplaceableAttribute":{ "type":"structure", "required":[ "Name", "Value" ], "members":{ "Name":{ "shape":"String", "documentation":"The name of the replaceable attribute." }, "Value":{ "shape":"String", "documentation":"The value of the replaceable attribute." }, "Replace":{ "shape":"Boolean", "documentation":"A flag specifying whether or not to replace the attribute/value pair or to add a new attribute/value pair. The default setting is false." } }, "documentation":"

" }, "ReplaceableAttributeList":{ "type":"list", "member":{ "shape":"ReplaceableAttribute", "locationName":"Attribute" }, "flattened":true }, "ReplaceableItem":{ "type":"structure", "required":[ "Name", "Attributes" ], "members":{ "Name":{ "shape":"String", "documentation":"The name of the replaceable item.", "locationName":"ItemName" }, "Attributes":{ "shape":"ReplaceableAttributeList", "documentation":"The list of attributes for a replaceable item." } }, "documentation":"

" }, "ReplaceableItemList":{ "type":"list", "member":{ "shape":"ReplaceableItem", "locationName":"Item" }, "flattened":true }, "RequestTimeout":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"RequestTimeout", "httpStatusCode":408, "senderFault":true }, "exception":true, "documentation":"

A timeout occurred when attempting to query the specified domain with specified query expression.

" }, "SelectRequest":{ "type":"structure", "required":["SelectExpression"], "members":{ "SelectExpression":{ "shape":"String", "documentation":"The expression used to query the domain." }, "NextToken":{ "shape":"String", "documentation":"A string informing Amazon SimpleDB where to start the next list of ItemNames." }, "ConsistentRead":{ "shape":"Boolean", "documentation":"Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If true, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read." } } }, "SelectResult":{ "type":"structure", "members":{ "Items":{ "shape":"ItemList", "documentation":"A list of items that match the select expression." }, "NextToken":{ "shape":"String", "documentation":"An opaque token indicating that more items than MaxNumberOfItems were matched, the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds." } } }, "String":{"type":"string"}, "TooManyRequestedAttributes":{ "type":"structure", "members":{ "BoxUsage":{"shape":"Float"} }, "error":{ "code":"TooManyRequestedAttributes", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Too many attributes requested.

" }, "UpdateCondition":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the attribute involved in the condition.

" }, "Value":{ "shape":"String", "documentation":"

The value of an attribute. This value can only be specified when the Exists parameter is equal to true.

" }, "Exists":{ "shape":"Boolean", "documentation":"

A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied. Specify true if the attribute must exist for the update condition to be satisfied. Specify false if the attribute should not exist in order for the update condition to be satisfied.

" } }, "documentation":"

Specifies the conditions under which data should be updated. If an update condition is specified for a request, the data will only be updated if the condition is satisfied. For example, if an attribute with a specific name and value exists, or if a specific attribute doesn't exist.

" } } } botocore-1.5.7/botocore/data/meteringmarketplace/0000777454262600001440000000000013042511307023156 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/meteringmarketplace/2016-01-14/0000777454262600001440000000000013042511307024206 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/meteringmarketplace/2016-01-14/service-2.json0000666454262600001440000003564213042511306026711 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"meteringmarketplace-2016-01-14", "apiVersion":"2016-01-14", "endpointPrefix":"metering.marketplace", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"AWSMarketplace Metering", "signatureVersion":"v4", "signingName":"aws-marketplace", "targetPrefix":"AWSMPMeteringService" }, "operations":{ "BatchMeterUsage":{ "name":"BatchMeterUsage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchMeterUsageRequest"}, "output":{"shape":"BatchMeterUsageResult"}, "errors":[ {"shape":"InternalServiceErrorException"}, {"shape":"InvalidProductCodeException"}, {"shape":"InvalidUsageDimensionException"}, {"shape":"InvalidCustomerIdentifierException"}, {"shape":"TimestampOutOfBoundsException"}, {"shape":"ThrottlingException"} ], "documentation":"

BatchMeterUsage is called from a SaaS application listed on the AWS Marketplace to post metering records for a set of customers.

For identical requests, the API is idempotent; requests can be retried with the same records or a subset of the input records.

Every request to BatchMeterUsage is for one product. If you need to meter usage for multiple products, you must make multiple calls to BatchMeterUsage.

BatchMeterUsage can process up to 25 UsageRecords at a time.

" }, "MeterUsage":{ "name":"MeterUsage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MeterUsageRequest"}, "output":{"shape":"MeterUsageResult"}, "errors":[ {"shape":"InternalServiceErrorException"}, {"shape":"InvalidProductCodeException"}, {"shape":"InvalidUsageDimensionException"}, {"shape":"InvalidEndpointRegionException"}, {"shape":"TimestampOutOfBoundsException"}, {"shape":"DuplicateRequestException"}, {"shape":"ThrottlingException"} ], "documentation":"

API to emit metering records. For identical requests, the API is idempotent. It simply returns the metering record ID.

MeterUsage is authenticated on the buyer's AWS account, generally when running from an EC2 instance on the AWS Marketplace.

" }, "ResolveCustomer":{ "name":"ResolveCustomer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResolveCustomerRequest"}, "output":{"shape":"ResolveCustomerResult"}, "errors":[ {"shape":"InvalidTokenException"}, {"shape":"ExpiredTokenException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceErrorException"} ], "documentation":"

ResolveCustomer is called by a SaaS application during the registration process. When a buyer visits your website during the registration process, the buyer submits a registration token through their browser. The registration token is resolved through this API to obtain a CustomerIdentifier and product code.

" } }, "shapes":{ "BatchMeterUsageRequest":{ "type":"structure", "required":[ "UsageRecords", "ProductCode" ], "members":{ "UsageRecords":{ "shape":"UsageRecordList", "documentation":"

The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time.

" }, "ProductCode":{ "shape":"ProductCode", "documentation":"

Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.

" } }, "documentation":"

A BatchMeterUsageRequest contains UsageRecords, which indicate quantities of usage within your application.

" }, "BatchMeterUsageResult":{ "type":"structure", "members":{ "Results":{ "shape":"UsageRecordResultList", "documentation":"

Contains all UsageRecords processed by BatchMeterUsage. These records were either honored by AWS Marketplace Metering Service or were invalid.

" }, "UnprocessedRecords":{ "shape":"UsageRecordList", "documentation":"

Contains all UsageRecords that were not processed by BatchMeterUsage. This is a list of UsageRecords. You can retry the failed request by making another BatchMeterUsage call with this list as input in the BatchMeterUsageRequest.

" } }, "documentation":"

Contains the UsageRecords processed by BatchMeterUsage and any records that have failed due to transient error.

" }, "Boolean":{"type":"boolean"}, "CustomerIdentifier":{ "type":"string", "max":255, "min":1 }, "DuplicateRequestException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

A metering record has already been emitted by the same EC2 instance for the given {usageDimension, timestamp} with a different usageQuantity.

", "exception":true }, "ExpiredTokenException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The submitted registration token has expired. This can happen if the buyer's browser takes too long to redirect to your page, the buyer has resubmitted the registration token, or your application has held on to the registration token for too long. Your SaaS registration website should redeem this token as soon as it is submitted by the buyer's browser.

", "exception":true }, "InternalServiceErrorException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

", "exception":true, "fault":true }, "InvalidCustomerIdentifierException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

You have metered usage for a CustomerIdentifier that does not exist.

", "exception":true }, "InvalidEndpointRegionException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The endpoint being called is in a region different from your EC2 instance. The region of the Metering service endpoint and the region of the EC2 instance must match.

", "exception":true }, "InvalidProductCodeException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The product code passed does not match the product code used for publishing the product.

", "exception":true }, "InvalidTokenException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "exception":true }, "InvalidUsageDimensionException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The usage dimension does not match one of the UsageDimensions associated with products.

", "exception":true }, "MeterUsageRequest":{ "type":"structure", "required":[ "ProductCode", "Timestamp", "UsageDimension", "UsageQuantity", "DryRun" ], "members":{ "ProductCode":{ "shape":"ProductCode", "documentation":"

Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.

" }, "Timestamp":{ "shape":"Timestamp", "documentation":"

Timestamp of the hour, recorded in UTC. The seconds and milliseconds portions of the timestamp will be ignored.

" }, "UsageDimension":{ "shape":"UsageDimension", "documentation":"

It will be one of the fcp dimension name provided during the publishing of the product.

" }, "UsageQuantity":{ "shape":"UsageQuantity", "documentation":"

Consumption value for the hour.

" }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the permissions required for the action, but does not make the request. If you have the permissions, the request returns DryRunOperation; otherwise, it returns UnauthorizedException.

" } } }, "MeterUsageResult":{ "type":"structure", "members":{ "MeteringRecordId":{"shape":"String"} } }, "NonEmptyString":{ "type":"string", "pattern":"\\S+" }, "ProductCode":{ "type":"string", "max":255, "min":1 }, "ResolveCustomerRequest":{ "type":"structure", "required":["RegistrationToken"], "members":{ "RegistrationToken":{ "shape":"NonEmptyString", "documentation":"

When a buyer visits your website during the registration process, the buyer submits a registration token through the browser. The registration token is resolved to obtain a CustomerIdentifier and product code.

" } }, "documentation":"

Contains input to the ResolveCustomer operation.

" }, "ResolveCustomerResult":{ "type":"structure", "members":{ "CustomerIdentifier":{ "shape":"CustomerIdentifier", "documentation":"

The CustomerIdentifier is used to identify an individual customer in your application. Calls to BatchMeterUsage require CustomerIdentifiers for each UsageRecord.

" }, "ProductCode":{ "shape":"ProductCode", "documentation":"

The product code is returned to confirm that the buyer is registering for your product. Subsequent BatchMeterUsage calls should be made using this product code.

" } }, "documentation":"

The result of the ResolveCustomer operation. Contains the CustomerIdentifier and product code.

" }, "String":{"type":"string"}, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The calls to the MeterUsage API are throttled.

", "exception":true }, "Timestamp":{"type":"timestamp"}, "TimestampOutOfBoundsException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The timestamp value passed in the meterUsage() is out of allowed range.

", "exception":true }, "UsageDimension":{ "type":"string", "max":255, "min":1 }, "UsageQuantity":{ "type":"integer", "max":1000000, "min":0 }, "UsageRecord":{ "type":"structure", "required":[ "Timestamp", "CustomerIdentifier", "Dimension", "Quantity" ], "members":{ "Timestamp":{ "shape":"Timestamp", "documentation":"

Timestamp of the hour, recorded in UTC. The seconds and milliseconds portions of the timestamp will be ignored.

Your application can meter usage for up to one hour in the past.

" }, "CustomerIdentifier":{ "shape":"CustomerIdentifier", "documentation":"

The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.

" }, "Dimension":{ "shape":"UsageDimension", "documentation":"

During the process of registering a product on AWS Marketplace, up to eight dimensions are specified. These represent different units of value in your application.

" }, "Quantity":{ "shape":"UsageQuantity", "documentation":"

The quantity of usage consumed by the customer for the given dimension and time.

" } }, "documentation":"

A UsageRecord indicates a quantity of usage for a given product, customer, dimension and time.

Multiple requests with the same UsageRecords as input will be deduplicated to prevent double charges.

" }, "UsageRecordList":{ "type":"list", "member":{"shape":"UsageRecord"}, "max":25, "min":0 }, "UsageRecordResult":{ "type":"structure", "members":{ "UsageRecord":{ "shape":"UsageRecord", "documentation":"

The UsageRecord that was part of the BatchMeterUsage request.

" }, "MeteringRecordId":{ "shape":"String", "documentation":"

The MeteringRecordId is a unique identifier for this metering event.

" }, "Status":{ "shape":"UsageRecordResultStatus", "documentation":"

The UsageRecordResult Status indicates the status of an individual UsageRecord processed by BatchMeterUsage.

  • Success- The UsageRecord was accepted and honored by BatchMeterUsage.

  • CustomerNotSubscribed- The CustomerIdentifier specified is not subscribed to your product. The UsageRecord was not honored. Future UsageRecords for this customer will fail until the customer subscribes to your product.

  • DuplicateRecord- Indicates that the UsageRecord was invalid and not honored. A previously metered UsageRecord had the same customer, dimension, and time, but a different quantity.

" } }, "documentation":"

A UsageRecordResult indicates the status of a given UsageRecord processed by BatchMeterUsage.

" }, "UsageRecordResultList":{ "type":"list", "member":{"shape":"UsageRecordResult"} }, "UsageRecordResultStatus":{ "type":"string", "enum":[ "Success", "CustomerNotSubscribed", "DuplicateRecord" ] }, "errorMessage":{"type":"string"} }, "documentation":"AWS Marketplace Metering Service

This reference provides descriptions of the low-level AWS Marketplace Metering Service API.

AWS Marketplace sellers can use this API to submit usage data for custom usage dimensions.

Submitting Metering Records

  • MeterUsage- Submits the metering record for a Marketplace product. MeterUsage is called from an EC2 instance.

  • BatchMeterUsage- Submits the metering record for a set of customers. BatchMeterUsage is called from a software-as-a-service (SaaS) application.

Accepting New Customers

  • ResolveCustomer- Called by a SaaS application during the registration process. When a buyer visits your website during the registration process, the buyer submits a Registration Token through the browser. The Registration Token is resolved through this API to obtain a CustomerIdentifier and Product Code.

" } botocore-1.5.7/botocore/data/iot/0000777454262600001440000000000013042511307017726 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/iot/2015-05-28/0000777454262600001440000000000013042511307020766 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/iot/2015-05-28/service-2.json0000666454262600001440000063302113042511306023464 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"iot-2015-05-28", "apiVersion":"2015-05-28", "endpointPrefix":"iot", "serviceFullName":"AWS IoT", "signatureVersion":"v4", "signingName":"execute-api", "protocol":"rest-json" }, "documentation":"AWS IoT

AWS IoT provides secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each thing (Thing Registry), configure logging, and create and manage policies and credentials to authenticate things.

For more information about how AWS IoT works, see the Developer Guide.

", "operations":{ "AcceptCertificateTransfer":{ "name":"AcceptCertificateTransfer", "http":{ "method":"PATCH", "requestUri":"/accept-certificate-transfer/{certificateId}" }, "input":{ "shape":"AcceptCertificateTransferRequest", "documentation":"

The input for the AcceptCertificateTransfer operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"TransferAlreadyCompletedException", "error":{"httpStatusCode":410}, "exception":true, "documentation":"

You can't revert the certificate transfer because the transfer is already complete.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

" }, "AttachPrincipalPolicy":{ "name":"AttachPrincipalPolicy", "http":{ "method":"PUT", "requestUri":"/principal-policies/{policyName}" }, "input":{ "shape":"AttachPrincipalPolicyRequest", "documentation":"

The input for the AttachPrincipalPolicy operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"LimitExceededException", "error":{"httpStatusCode":410}, "exception":true, "documentation":"

The number of attached entities exceeds the limit.

" } ], "documentation":"

Attaches the specified policy to the specified principal (certificate or other credential).

" }, "AttachThingPrincipal":{ "name":"AttachThingPrincipal", "http":{ "method":"PUT", "requestUri":"/things/{thingName}/principals" }, "input":{ "shape":"AttachThingPrincipalRequest", "documentation":"

The input for the AttachThingPrincipal operation.

" }, "output":{ "shape":"AttachThingPrincipalResponse", "documentation":"

The output from the AttachThingPrincipal operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Attaches the specified principal to the specified thing.

" }, "CancelCertificateTransfer":{ "name":"CancelCertificateTransfer", "http":{ "method":"PATCH", "requestUri":"/cancel-certificate-transfer/{certificateId}" }, "input":{ "shape":"CancelCertificateTransferRequest", "documentation":"

The input for the CancelCertificateTransfer operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"TransferAlreadyCompletedException", "error":{"httpStatusCode":410}, "exception":true, "documentation":"

You can't revert the certificate transfer because the transfer is already complete.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Cancels a pending transfer for the specified certificate.

Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.

After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.

" }, "CreateCertificateFromCsr":{ "name":"CreateCertificateFromCsr", "http":{ "method":"POST", "requestUri":"/certificates" }, "input":{ "shape":"CreateCertificateFromCsrRequest", "documentation":"

The input for the CreateCertificateFromCsr operation.

" }, "output":{ "shape":"CreateCertificateFromCsrResponse", "documentation":"

The output from the CreateCertificateFromCsr operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Creates an X.509 certificate using the specified certificate signing request.

Note Reusing the same certificate signing request (CSR) results in a distinct certificate.

You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.

Assuming a set of CSRs are located inside of the directory my-csr-directory:

On Linux and OS X, the command is:

$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}

This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.

The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:

$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}

On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:

> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}

On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:

> forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path\"

" }, "CreateKeysAndCertificate":{ "name":"CreateKeysAndCertificate", "http":{ "method":"POST", "requestUri":"/keys-and-certificate" }, "input":{ "shape":"CreateKeysAndCertificateRequest", "documentation":"

The input for the CreateKeysAndCertificate operation.

" }, "output":{ "shape":"CreateKeysAndCertificateResponse", "documentation":"

The output of the CreateKeysAndCertificate operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.

Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.

" }, "CreatePolicy":{ "name":"CreatePolicy", "http":{ "method":"POST", "requestUri":"/policies/{policyName}" }, "input":{ "shape":"CreatePolicyRequest", "documentation":"

The input for the CreatePolicy operation.

" }, "output":{ "shape":"CreatePolicyResponse", "documentation":"

The output from the CreatePolicy operation.

" }, "errors":[ { "shape":"ResourceAlreadyExistsException", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

The resource already exists.

" }, { "shape":"MalformedPolicyException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The policy documentation is not valid.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Creates an AWS IoT policy.

The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.

" }, "CreatePolicyVersion":{ "name":"CreatePolicyVersion", "http":{ "method":"POST", "requestUri":"/policies/{policyName}/version" }, "input":{ "shape":"CreatePolicyVersionRequest", "documentation":"

The input for the CreatePolicyVersion operation.

" }, "output":{ "shape":"CreatePolicyVersionResponse", "documentation":"

The output of the CreatePolicyVersion operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"MalformedPolicyException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The policy documentation is not valid.

" }, { "shape":"VersionsLimitExceededException", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

The number of policy versions exceeds the limit.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

" }, "CreateThing":{ "name":"CreateThing", "http":{ "method":"POST", "requestUri":"/things/{thingName}" }, "input":{ "shape":"CreateThingRequest", "documentation":"

The input for the CreateThing operation.

" }, "output":{ "shape":"CreateThingResponse", "documentation":"

The output of the CreateThing operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"ResourceAlreadyExistsException", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

The resource already exists.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" } ], "documentation":"

Creates a thing record in the thing registry.

" }, "CreateThingType":{ "name":"CreateThingType", "http":{ "method":"POST", "requestUri":"/thing-types/{thingTypeName}" }, "input":{ "shape":"CreateThingTypeRequest", "documentation":"

The input for the CreateThingType operation.

" }, "output":{ "shape":"CreateThingTypeResponse", "documentation":"

The output of the CreateThingType operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"ResourceAlreadyExistsException", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

The resource already exists.

" } ], "documentation":"

Creates a new thing type.

" }, "CreateTopicRule":{ "name":"CreateTopicRule", "http":{ "method":"POST", "requestUri":"/rules/{ruleName}" }, "input":{ "shape":"CreateTopicRuleRequest", "documentation":"

The input for the CreateTopicRule operation.

" }, "errors":[ { "shape":"SqlParseException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The Rule-SQL expression can't be parsed correctly.

" }, { "shape":"InternalException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ResourceAlreadyExistsException", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

The resource already exists.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" } ], "documentation":"

Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

" }, "DeleteCACertificate":{ "name":"DeleteCACertificate", "http":{ "method":"DELETE", "requestUri":"/cacertificate/{caCertificateId}" }, "input":{ "shape":"DeleteCACertificateRequest", "documentation":"

Input for the DeleteCACertificate operation.

" }, "output":{ "shape":"DeleteCACertificateResponse", "documentation":"

The output for the DeleteCACertificate operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"CertificateStateException", "error":{"httpStatusCode":406}, "exception":true, "documentation":"

The certificate operation is not allowed.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" } ], "documentation":"

Deletes a registered CA certificate.

" }, "DeleteCertificate":{ "name":"DeleteCertificate", "http":{ "method":"DELETE", "requestUri":"/certificates/{certificateId}" }, "input":{ "shape":"DeleteCertificateRequest", "documentation":"

The input for the DeleteCertificate operation.

" }, "errors":[ { "shape":"CertificateStateException", "error":{"httpStatusCode":406}, "exception":true, "documentation":"

The certificate operation is not allowed.

" }, { "shape":"DeleteConflictException", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

You can't delete the resource because it is attached to one or more resources.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" } ], "documentation":"

Deletes the specified certificate.

A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.

" }, "DeletePolicy":{ "name":"DeletePolicy", "http":{ "method":"DELETE", "requestUri":"/policies/{policyName}" }, "input":{ "shape":"DeletePolicyRequest", "documentation":"

The input for the DeletePolicy operation.

" }, "errors":[ { "shape":"DeleteConflictException", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

You can't delete the resource because it is attached to one or more resources.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Deletes the specified policy.

A policy cannot be deleted if it has non-default versions or it is attached to any certificate.

To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.

When a policy is deleted using DeletePolicy, its default version is deleted with it.

" }, "DeletePolicyVersion":{ "name":"DeletePolicyVersion", "http":{ "method":"DELETE", "requestUri":"/policies/{policyName}/version/{policyVersionId}" }, "input":{ "shape":"DeletePolicyVersionRequest", "documentation":"

The input for the DeletePolicyVersion operation.

" }, "errors":[ { "shape":"DeleteConflictException", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

You can't delete the resource because it is attached to one or more resources.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

" }, "DeleteRegistrationCode":{ "name":"DeleteRegistrationCode", "http":{ "method":"DELETE", "requestUri":"/registrationcode" }, "input":{ "shape":"DeleteRegistrationCodeRequest", "documentation":"

The input for the DeleteRegistrationCode operation.

" }, "output":{ "shape":"DeleteRegistrationCodeResponse", "documentation":"

The output for the DeleteRegistrationCode operation.

" }, "errors":[ { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Deletes a CA certificate registration code.

" }, "DeleteThing":{ "name":"DeleteThing", "http":{ "method":"DELETE", "requestUri":"/things/{thingName}" }, "input":{ "shape":"DeleteThingRequest", "documentation":"

The input for the DeleteThing operation.

" }, "output":{ "shape":"DeleteThingResponse", "documentation":"

The output of the DeleteThing operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"VersionConflictException", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

An exception thrown when the version of a thing passed to a command is different than the version specified with the --version parameter.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Deletes the specified thing.

" }, "DeleteThingType":{ "name":"DeleteThingType", "http":{ "method":"DELETE", "requestUri":"/thing-types/{thingTypeName}" }, "input":{ "shape":"DeleteThingTypeRequest", "documentation":"

The input for the DeleteThingType operation.

" }, "output":{ "shape":"DeleteThingTypeResponse", "documentation":"

The output for the DeleteThingType operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Deletes the specified thing type . You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.

" }, "DeleteTopicRule":{ "name":"DeleteTopicRule", "http":{ "method":"DELETE", "requestUri":"/rules/{ruleName}" }, "input":{ "shape":"DeleteTopicRuleRequest", "documentation":"

The input for the DeleteTopicRule operation.

" }, "errors":[ { "shape":"InternalException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" } ], "documentation":"

Deletes the specified rule.

" }, "DeprecateThingType":{ "name":"DeprecateThingType", "http":{ "method":"POST", "requestUri":"/thing-types/{thingTypeName}/deprecate" }, "input":{ "shape":"DeprecateThingTypeRequest", "documentation":"

The input for the DeprecateThingType operation.

" }, "output":{ "shape":"DeprecateThingTypeResponse", "documentation":"

The output for the DeprecateThingType operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Deprecates a thing type. You can not associate new things with deprecated thing type.

" }, "DescribeCACertificate":{ "name":"DescribeCACertificate", "http":{ "method":"GET", "requestUri":"/cacertificate/{caCertificateId}" }, "input":{ "shape":"DescribeCACertificateRequest", "documentation":"

The input for the DescribeCACertificate operation.

" }, "output":{ "shape":"DescribeCACertificateResponse", "documentation":"

The output from the DescribeCACertificate operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" } ], "documentation":"

Describes a registered CA certificate.

" }, "DescribeCertificate":{ "name":"DescribeCertificate", "http":{ "method":"GET", "requestUri":"/certificates/{certificateId}" }, "input":{ "shape":"DescribeCertificateRequest", "documentation":"

The input for the DescribeCertificate operation.

" }, "output":{ "shape":"DescribeCertificateResponse", "documentation":"

The output of the DescribeCertificate operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" } ], "documentation":"

Gets information about the specified certificate.

" }, "DescribeEndpoint":{ "name":"DescribeEndpoint", "http":{ "method":"GET", "requestUri":"/endpoint" }, "input":{ "shape":"DescribeEndpointRequest", "documentation":"

The input for the DescribeEndpoint operation.

" }, "output":{ "shape":"DescribeEndpointResponse", "documentation":"

The output from the DescribeEndpoint operation.

" }, "errors":[ { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" } ], "documentation":"

Returns a unique endpoint specific to the AWS account making the call.

" }, "DescribeThing":{ "name":"DescribeThing", "http":{ "method":"GET", "requestUri":"/things/{thingName}" }, "input":{ "shape":"DescribeThingRequest", "documentation":"

The input for the DescribeThing operation.

" }, "output":{ "shape":"DescribeThingResponse", "documentation":"

The output from the DescribeThing operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Gets information about the specified thing.

" }, "DescribeThingType":{ "name":"DescribeThingType", "http":{ "method":"GET", "requestUri":"/thing-types/{thingTypeName}" }, "input":{ "shape":"DescribeThingTypeRequest", "documentation":"

The input for the DescribeThingType operation.

" }, "output":{ "shape":"DescribeThingTypeResponse", "documentation":"

The output for the DescribeThingType operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Gets information about the specified thing type.

" }, "DetachPrincipalPolicy":{ "name":"DetachPrincipalPolicy", "http":{ "method":"DELETE", "requestUri":"/principal-policies/{policyName}" }, "input":{ "shape":"DetachPrincipalPolicyRequest", "documentation":"

The input for the DetachPrincipalPolicy operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Removes the specified policy from the specified certificate.

" }, "DetachThingPrincipal":{ "name":"DetachThingPrincipal", "http":{ "method":"DELETE", "requestUri":"/things/{thingName}/principals" }, "input":{ "shape":"DetachThingPrincipalRequest", "documentation":"

The input for the DetachThingPrincipal operation.

" }, "output":{ "shape":"DetachThingPrincipalResponse", "documentation":"

The output from the DetachThingPrincipal operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Detaches the specified principal from the specified thing.

" }, "DisableTopicRule":{ "name":"DisableTopicRule", "http":{ "method":"POST", "requestUri":"/rules/{ruleName}/disable" }, "input":{ "shape":"DisableTopicRuleRequest", "documentation":"

The input for the DisableTopicRuleRequest operation.

" }, "errors":[ { "shape":"InternalException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" } ], "documentation":"

Disables the specified rule.

" }, "EnableTopicRule":{ "name":"EnableTopicRule", "http":{ "method":"POST", "requestUri":"/rules/{ruleName}/enable" }, "input":{ "shape":"EnableTopicRuleRequest", "documentation":"

The input for the EnableTopicRuleRequest operation.

" }, "errors":[ { "shape":"InternalException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" } ], "documentation":"

Enables the specified rule.

" }, "GetLoggingOptions":{ "name":"GetLoggingOptions", "http":{ "method":"GET", "requestUri":"/loggingOptions" }, "input":{ "shape":"GetLoggingOptionsRequest", "documentation":"

The input for the GetLoggingOptions operation.

" }, "output":{ "shape":"GetLoggingOptionsResponse", "documentation":"

The output from the GetLoggingOptions operation.

" }, "errors":[ { "shape":"InternalException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" } ], "documentation":"

Gets the logging options.

" }, "GetPolicy":{ "name":"GetPolicy", "http":{ "method":"GET", "requestUri":"/policies/{policyName}" }, "input":{ "shape":"GetPolicyRequest", "documentation":"

The input for the GetPolicy operation.

" }, "output":{ "shape":"GetPolicyResponse", "documentation":"

The output from the GetPolicy operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Gets information about the specified policy with the policy document of the default version.

" }, "GetPolicyVersion":{ "name":"GetPolicyVersion", "http":{ "method":"GET", "requestUri":"/policies/{policyName}/version/{policyVersionId}" }, "input":{ "shape":"GetPolicyVersionRequest", "documentation":"

The input for the GetPolicyVersion operation.

" }, "output":{ "shape":"GetPolicyVersionResponse", "documentation":"

The output from the GetPolicyVersion operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Gets information about the specified policy version.

" }, "GetRegistrationCode":{ "name":"GetRegistrationCode", "http":{ "method":"GET", "requestUri":"/registrationcode" }, "input":{ "shape":"GetRegistrationCodeRequest", "documentation":"

The input to the GetRegistrationCode operation.

" }, "output":{ "shape":"GetRegistrationCodeResponse", "documentation":"

The output from the GetRegistrationCode operation.

" }, "errors":[ { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" } ], "documentation":"

Gets a registration code used to register a CA certificate with AWS IoT.

" }, "GetTopicRule":{ "name":"GetTopicRule", "http":{ "method":"GET", "requestUri":"/rules/{ruleName}" }, "input":{ "shape":"GetTopicRuleRequest", "documentation":"

The input for the GetTopicRule operation.

" }, "output":{ "shape":"GetTopicRuleResponse", "documentation":"

The output from the GetTopicRule operation.

" }, "errors":[ { "shape":"InternalException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" } ], "documentation":"

Gets information about the specified rule.

" }, "ListCACertificates":{ "name":"ListCACertificates", "http":{ "method":"GET", "requestUri":"/cacertificates" }, "input":{ "shape":"ListCACertificatesRequest", "documentation":"

Input for the ListCACertificates operation.

" }, "output":{ "shape":"ListCACertificatesResponse", "documentation":"

The output from the ListCACertificates operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Lists the CA certificates registered for your AWS account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

" }, "ListCertificates":{ "name":"ListCertificates", "http":{ "method":"GET", "requestUri":"/certificates" }, "input":{ "shape":"ListCertificatesRequest", "documentation":"

The input for the ListCertificates operation.

" }, "output":{ "shape":"ListCertificatesResponse", "documentation":"

The output of the ListCertificates operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Lists the certificates registered in your AWS account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

" }, "ListCertificatesByCA":{ "name":"ListCertificatesByCA", "http":{ "method":"GET", "requestUri":"/certificates-by-ca/{caCertificateId}" }, "input":{ "shape":"ListCertificatesByCARequest", "documentation":"

The input to the ListCertificatesByCA operation.

" }, "output":{ "shape":"ListCertificatesByCAResponse", "documentation":"

The output of the ListCertificatesByCA operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

List the device certificates signed by the specified CA certificate.

" }, "ListOutgoingCertificates":{ "name":"ListOutgoingCertificates", "http":{ "method":"GET", "requestUri":"/certificates-out-going" }, "input":{ "shape":"ListOutgoingCertificatesRequest", "documentation":"

The input to the ListOutgoingCertificates operation.

" }, "output":{ "shape":"ListOutgoingCertificatesResponse", "documentation":"

The output from the ListOutgoingCertificates operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Lists certificates that are being transfered but not yet accepted.

" }, "ListPolicies":{ "name":"ListPolicies", "http":{ "method":"GET", "requestUri":"/policies" }, "input":{ "shape":"ListPoliciesRequest", "documentation":"

The input for the ListPolicies operation.

" }, "output":{ "shape":"ListPoliciesResponse", "documentation":"

The output from the ListPolicies operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Lists your policies.

" }, "ListPolicyPrincipals":{ "name":"ListPolicyPrincipals", "http":{ "method":"GET", "requestUri":"/policy-principals" }, "input":{ "shape":"ListPolicyPrincipalsRequest", "documentation":"

The input for the ListPolicyPrincipals operation.

" }, "output":{ "shape":"ListPolicyPrincipalsResponse", "documentation":"

The output from the ListPolicyPrincipals operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Lists the principals associated with the specified policy.

" }, "ListPolicyVersions":{ "name":"ListPolicyVersions", "http":{ "method":"GET", "requestUri":"/policies/{policyName}/version" }, "input":{ "shape":"ListPolicyVersionsRequest", "documentation":"

The input for the ListPolicyVersions operation.

" }, "output":{ "shape":"ListPolicyVersionsResponse", "documentation":"

The output from the ListPolicyVersions operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Lists the versions of the specified policy and identifies the default version.

" }, "ListPrincipalPolicies":{ "name":"ListPrincipalPolicies", "http":{ "method":"GET", "requestUri":"/principal-policies" }, "input":{ "shape":"ListPrincipalPoliciesRequest", "documentation":"

The input for the ListPrincipalPolicies operation.

" }, "output":{ "shape":"ListPrincipalPoliciesResponse", "documentation":"

The output from the ListPrincipalPolicies operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.

" }, "ListPrincipalThings":{ "name":"ListPrincipalThings", "http":{ "method":"GET", "requestUri":"/principals/things" }, "input":{ "shape":"ListPrincipalThingsRequest", "documentation":"

The input for the ListPrincipalThings operation.

" }, "output":{ "shape":"ListPrincipalThingsResponse", "documentation":"

The output from the ListPrincipalThings operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" } ], "documentation":"

Lists the things associated with the specified principal.

" }, "ListThingPrincipals":{ "name":"ListThingPrincipals", "http":{ "method":"GET", "requestUri":"/things/{thingName}/principals" }, "input":{ "shape":"ListThingPrincipalsRequest", "documentation":"

The input for the ListThingPrincipal operation.

" }, "output":{ "shape":"ListThingPrincipalsResponse", "documentation":"

The output from the ListThingPrincipals operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" } ], "documentation":"

Lists the principals associated with the specified thing.

" }, "ListThingTypes":{ "name":"ListThingTypes", "http":{ "method":"GET", "requestUri":"/thing-types" }, "input":{ "shape":"ListThingTypesRequest", "documentation":"

The input for the ListThingTypes operation.

" }, "output":{ "shape":"ListThingTypesResponse", "documentation":"

The output for the ListThingTypes operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Lists the existing thing types.

" }, "ListThings":{ "name":"ListThings", "http":{ "method":"GET", "requestUri":"/things" }, "input":{ "shape":"ListThingsRequest", "documentation":"

The input for the ListThings operation.

" }, "output":{ "shape":"ListThingsResponse", "documentation":"

The output from the ListThings operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red.

" }, "ListTopicRules":{ "name":"ListTopicRules", "http":{ "method":"GET", "requestUri":"/rules" }, "input":{ "shape":"ListTopicRulesRequest", "documentation":"

The input for the ListTopicRules operation.

" }, "output":{ "shape":"ListTopicRulesResponse", "documentation":"

The output from the ListTopicRules operation.

" }, "errors":[ { "shape":"InternalException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" } ], "documentation":"

Lists the rules for the specific topic.

" }, "RegisterCACertificate":{ "name":"RegisterCACertificate", "http":{ "method":"POST", "requestUri":"/cacertificate" }, "input":{ "shape":"RegisterCACertificateRequest", "documentation":"

The input to the RegisterCACertificate operation.

" }, "output":{ "shape":"RegisterCACertificateResponse", "documentation":"

The output from the RegisterCACertificateResponse operation.

" }, "errors":[ { "shape":"ResourceAlreadyExistsException", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

The resource already exists.

" }, { "shape":"RegistrationCodeValidationException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The registration code is invalid.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"CertificateValidationException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The certificate is invalid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"LimitExceededException", "error":{"httpStatusCode":410}, "exception":true, "documentation":"

The number of attached entities exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field and public key. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.

" }, "RegisterCertificate":{ "name":"RegisterCertificate", "http":{ "method":"POST", "requestUri":"/certificate/register" }, "input":{ "shape":"RegisterCertificateRequest", "documentation":"

The input to the RegisterCertificate operation.

" }, "output":{ "shape":"RegisterCertificateResponse", "documentation":"

The output from the RegisterCertificate operation.

" }, "errors":[ { "shape":"ResourceAlreadyExistsException", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

The resource already exists.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"CertificateValidationException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The certificate is invalid.

" }, { "shape":"CertificateStateException", "error":{"httpStatusCode":406}, "exception":true, "documentation":"

The certificate operation is not allowed.

" }, { "shape":"CertificateConflictException", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Unable to verify the CA certificate used to sign the device certificate you are attempting to register. This is happens when you have registered more than one CA certificate that has the same subject field and public key.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.

" }, "RejectCertificateTransfer":{ "name":"RejectCertificateTransfer", "http":{ "method":"PATCH", "requestUri":"/reject-certificate-transfer/{certificateId}" }, "input":{ "shape":"RejectCertificateTransferRequest", "documentation":"

The input for the RejectCertificateTransfer operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"TransferAlreadyCompletedException", "error":{"httpStatusCode":410}, "exception":true, "documentation":"

You can't revert the certificate transfer because the transfer is already complete.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.

" }, "ReplaceTopicRule":{ "name":"ReplaceTopicRule", "http":{ "method":"PATCH", "requestUri":"/rules/{ruleName}" }, "input":{ "shape":"ReplaceTopicRuleRequest", "documentation":"

The input for the ReplaceTopicRule operation.

" }, "errors":[ { "shape":"SqlParseException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The Rule-SQL expression can't be parsed correctly.

" }, { "shape":"InternalException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" } ], "documentation":"

Replaces the specified rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

" }, "SetDefaultPolicyVersion":{ "name":"SetDefaultPolicyVersion", "http":{ "method":"PATCH", "requestUri":"/policies/{policyName}/version/{policyVersionId}" }, "input":{ "shape":"SetDefaultPolicyVersionRequest", "documentation":"

The input for the SetDefaultPolicyVersion operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.

" }, "SetLoggingOptions":{ "name":"SetLoggingOptions", "http":{ "method":"POST", "requestUri":"/loggingOptions" }, "input":{ "shape":"SetLoggingOptionsRequest", "documentation":"

The input for the SetLoggingOptions operation.

" }, "errors":[ { "shape":"InternalException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" } ], "documentation":"

Sets the logging options.

" }, "TransferCertificate":{ "name":"TransferCertificate", "http":{ "method":"PATCH", "requestUri":"/transfer-certificate/{certificateId}" }, "input":{ "shape":"TransferCertificateRequest", "documentation":"

The input for the TransferCertificate operation.

" }, "output":{ "shape":"TransferCertificateResponse", "documentation":"

The output from the TransferCertificate operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"CertificateStateException", "error":{"httpStatusCode":406}, "exception":true, "documentation":"

The certificate operation is not allowed.

" }, { "shape":"TransferConflictException", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

You can't transfer the certificate because authorization policies are still attached.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Transfers the specified certificate to the specified AWS account.

You can cancel the transfer until it is acknowledged by the recipient.

No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.

The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it.

The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.

" }, "UpdateCACertificate":{ "name":"UpdateCACertificate", "http":{ "method":"PUT", "requestUri":"/cacertificate/{caCertificateId}" }, "input":{ "shape":"UpdateCACertificateRequest", "documentation":"

The input to the UpdateCACertificate operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Updates a registered CA certificate.

" }, "UpdateCertificate":{ "name":"UpdateCertificate", "http":{ "method":"PUT", "requestUri":"/certificates/{certificateId}" }, "input":{ "shape":"UpdateCertificateRequest", "documentation":"

The input for the UpdateCertificate operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, { "shape":"CertificateStateException", "error":{"httpStatusCode":406}, "exception":true, "documentation":"

The certificate operation is not allowed.

" }, { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" } ], "documentation":"

Updates the status of the specified certificate. This operation is idempotent.

Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.

The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.

" }, "UpdateThing":{ "name":"UpdateThing", "http":{ "method":"PATCH", "requestUri":"/things/{thingName}" }, "input":{ "shape":"UpdateThingRequest", "documentation":"

The input for the UpdateThing operation.

" }, "output":{ "shape":"UpdateThingResponse", "documentation":"

The output from the UpdateThing operation.

" }, "errors":[ { "shape":"InvalidRequestException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, { "shape":"VersionConflictException", "error":{"httpStatusCode":409}, "exception":true, "documentation":"

An exception thrown when the version of a thing passed to a command is different than the version specified with the --version parameter.

" }, { "shape":"ThrottlingException", "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, { "shape":"UnauthorizedException", "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, { "shape":"ServiceUnavailableException", "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, { "shape":"InternalFailureException", "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" } ], "documentation":"

Updates the data for a thing.

" } }, "shapes":{ "AcceptCertificateTransferRequest":{ "type":"structure", "required":["certificateId"], "members":{ "certificateId":{ "shape":"CertificateId", "location":"uri", "locationName":"certificateId", "documentation":"

The ID of the certificate.

" }, "setAsActive":{ "shape":"SetAsActive", "location":"querystring", "locationName":"setAsActive", "documentation":"

Specifies whether the certificate is active.

" } }, "documentation":"

The input for the AcceptCertificateTransfer operation.

" }, "Action":{ "type":"structure", "members":{ "dynamoDB":{ "shape":"DynamoDBAction", "documentation":"

Write to a DynamoDB table.

" }, "dynamoDBv2":{ "shape":"DynamoDBv2Action", "documentation":"

Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.

" }, "lambda":{ "shape":"LambdaAction", "documentation":"

Invoke a Lambda function.

" }, "sns":{ "shape":"SnsAction", "documentation":"

Publish to an Amazon SNS topic.

" }, "sqs":{ "shape":"SqsAction", "documentation":"

Publish to an Amazon SQS queue.

" }, "kinesis":{ "shape":"KinesisAction", "documentation":"

Write data to an Amazon Kinesis stream.

" }, "republish":{ "shape":"RepublishAction", "documentation":"

Publish to another MQTT topic.

" }, "s3":{ "shape":"S3Action", "documentation":"

Write to an Amazon S3 bucket.

" }, "firehose":{ "shape":"FirehoseAction", "documentation":"

Write to an Amazon Kinesis Firehose stream.

" }, "cloudwatchMetric":{ "shape":"CloudwatchMetricAction", "documentation":"

Capture a CloudWatch metric.

" }, "cloudwatchAlarm":{ "shape":"CloudwatchAlarmAction", "documentation":"

Change the state of a CloudWatch alarm.

" }, "elasticsearch":{ "shape":"ElasticsearchAction", "documentation":"

Write data to an Amazon Elasticsearch Service domain.

" } }, "documentation":"

Describes the actions associated with a rule.

" }, "ActionList":{ "type":"list", "member":{"shape":"Action"}, "min":0, "max":10 }, "AlarmName":{"type":"string"}, "AllowAutoRegistration":{"type":"boolean"}, "AscendingOrder":{"type":"boolean"}, "AttachPrincipalPolicyRequest":{ "type":"structure", "required":[ "policyName", "principal" ], "members":{ "policyName":{ "shape":"PolicyName", "location":"uri", "locationName":"policyName", "documentation":"

The policy name.

" }, "principal":{ "shape":"Principal", "location":"header", "locationName":"x-amzn-iot-principal", "documentation":"

The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

" } }, "documentation":"

The input for the AttachPrincipalPolicy operation.

" }, "AttachThingPrincipalRequest":{ "type":"structure", "required":[ "thingName", "principal" ], "members":{ "thingName":{ "shape":"ThingName", "location":"uri", "locationName":"thingName", "documentation":"

The name of the thing.

" }, "principal":{ "shape":"Principal", "location":"header", "locationName":"x-amzn-principal", "documentation":"

The principal, such as a certificate or other credential.

" } }, "documentation":"

The input for the AttachThingPrincipal operation.

" }, "AttachThingPrincipalResponse":{ "type":"structure", "members":{ }, "documentation":"

The output from the AttachThingPrincipal operation.

" }, "AttributeName":{ "type":"string", "max":128, "pattern":"[a-zA-Z0-9_.,@/:#-]+" }, "AttributePayload":{ "type":"structure", "members":{ "attributes":{ "shape":"Attributes", "documentation":"

A JSON string containing up to three key-value pair in JSON format. For example:

{\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}})

" }, "merge":{ "shape":"Flag", "documentation":"

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

The merge attribute is only valid when calling UpdateThing.

" } }, "documentation":"

The attribute payload.

" }, "AttributeValue":{ "type":"string", "max":800, "pattern":"[a-zA-Z0-9_.,@/:#-]*", "documentation":"An attribute value for an Thing. An empty or null value in Update means that existing value for that attribute should be deleted. Empty and null values in create are ignored." }, "Attributes":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValue"} }, "AutoRegistrationStatus":{ "type":"string", "enum":[ "ENABLE", "DISABLE" ] }, "AwsAccountId":{ "type":"string", "pattern":"[0-9]{12}" }, "AwsArn":{"type":"string"}, "AwsIotSqlVersion":{"type":"string"}, "Boolean":{"type":"boolean"}, "BucketName":{"type":"string"}, "CACertificate":{ "type":"structure", "members":{ "certificateArn":{ "shape":"CertificateArn", "documentation":"

The ARN of the CA certificate.

" }, "certificateId":{ "shape":"CertificateId", "documentation":"

The ID of the CA certificate.

" }, "status":{ "shape":"CACertificateStatus", "documentation":"

The status of the CA certificate.

The status value REGISTER_INACTIVE is deprecated and should not be used.

" }, "creationDate":{ "shape":"DateType", "documentation":"

The date the CA certificate was created.

" } }, "documentation":"

A CA certificate.

" }, "CACertificateDescription":{ "type":"structure", "members":{ "certificateArn":{ "shape":"CertificateArn", "documentation":"

The CA certificate ARN.

" }, "certificateId":{ "shape":"CertificateId", "documentation":"

The CA certificate ID.

" }, "status":{ "shape":"CACertificateStatus", "documentation":"

The status of a CA certificate.

" }, "certificatePem":{ "shape":"CertificatePem", "documentation":"

The CA certificate data, in PEM format.

" }, "ownedBy":{ "shape":"AwsAccountId", "documentation":"

The owner of the CA certificate.

" }, "creationDate":{ "shape":"DateType", "documentation":"

The date the CA certificate was created.

" }, "autoRegistrationStatus":{ "shape":"AutoRegistrationStatus", "documentation":"

Whether the CA certificate configured for auto registration of device certificates. Valid values are \"ENABLE\" and \"DISABLE\"

" } }, "documentation":"

Describes a CA certificate.

" }, "CACertificateStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] }, "CACertificates":{ "type":"list", "member":{"shape":"CACertificate"} }, "CancelCertificateTransferRequest":{ "type":"structure", "required":["certificateId"], "members":{ "certificateId":{ "shape":"CertificateId", "location":"uri", "locationName":"certificateId", "documentation":"

The ID of the certificate.

" } }, "documentation":"

The input for the CancelCertificateTransfer operation.

" }, "CannedAccessControlList":{ "type":"string", "enum":[ "private", "public-read", "public-read-write", "aws-exec-read", "authenticated-read", "bucket-owner-read", "bucket-owner-full-control", "log-delivery-write" ] }, "Certificate":{ "type":"structure", "members":{ "certificateArn":{ "shape":"CertificateArn", "documentation":"

The ARN of the certificate.

" }, "certificateId":{ "shape":"CertificateId", "documentation":"

The ID of the certificate.

" }, "status":{ "shape":"CertificateStatus", "documentation":"

The status of the certificate.

The status value REGISTER_INACTIVE is deprecated and should not be used.

" }, "creationDate":{ "shape":"DateType", "documentation":"

The date and time the certificate was created.

" } }, "documentation":"

Information about a certificate.

" }, "CertificateArn":{"type":"string"}, "CertificateConflictException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"

Unable to verify the CA certificate used to sign the device certificate you are attempting to register. This is happens when you have registered more than one CA certificate that has the same subject field and public key.

" }, "CertificateDescription":{ "type":"structure", "members":{ "certificateArn":{ "shape":"CertificateArn", "documentation":"

The ARN of the certificate.

" }, "certificateId":{ "shape":"CertificateId", "documentation":"

The ID of the certificate.

" }, "caCertificateId":{ "shape":"CertificateId", "documentation":"

The certificate ID of the CA certificate used to sign this certificate.

" }, "status":{ "shape":"CertificateStatus", "documentation":"

The status of the certificate.

" }, "certificatePem":{ "shape":"CertificatePem", "documentation":"

The certificate data, in PEM format.

" }, "ownedBy":{ "shape":"AwsAccountId", "documentation":"

The ID of the AWS account that owns the certificate.

" }, "previousOwnedBy":{ "shape":"AwsAccountId", "documentation":"

The ID of the AWS account of the previous owner of the certificate.

" }, "creationDate":{ "shape":"DateType", "documentation":"

The date and time the certificate was created.

" }, "lastModifiedDate":{ "shape":"DateType", "documentation":"

The date and time the certificate was last modified.

" }, "transferData":{ "shape":"TransferData", "documentation":"

The transfer data.

" } }, "documentation":"

Describes a certificate.

" }, "CertificateId":{ "type":"string", "min":64, "max":64, "pattern":"(0x)?[a-fA-F0-9]+" }, "CertificatePem":{ "type":"string", "min":1, "max":65536 }, "CertificateSigningRequest":{ "type":"string", "min":1 }, "CertificateStateException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":406}, "exception":true, "documentation":"

The certificate operation is not allowed.

" }, "CertificateStatus":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE", "REVOKED", "PENDING_TRANSFER", "REGISTER_INACTIVE", "PENDING_ACTIVATION" ] }, "CertificateValidationException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

Additional information about the exception.

" } }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The certificate is invalid.

" }, "Certificates":{ "type":"list", "member":{"shape":"Certificate"} }, "ClientId":{"type":"string"}, "CloudwatchAlarmAction":{ "type":"structure", "required":[ "roleArn", "alarmName", "stateReason", "stateValue" ], "members":{ "roleArn":{ "shape":"AwsArn", "documentation":"

The IAM role that allows access to the CloudWatch alarm.

" }, "alarmName":{ "shape":"AlarmName", "documentation":"

The CloudWatch alarm name.

" }, "stateReason":{ "shape":"StateReason", "documentation":"

The reason for the alarm change.

" }, "stateValue":{ "shape":"StateValue", "documentation":"

The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

" } }, "documentation":"

Describes an action that updates a CloudWatch alarm.

" }, "CloudwatchMetricAction":{ "type":"structure", "required":[ "roleArn", "metricNamespace", "metricName", "metricValue", "metricUnit" ], "members":{ "roleArn":{ "shape":"AwsArn", "documentation":"

The IAM role that allows access to the CloudWatch metric.

" }, "metricNamespace":{ "shape":"MetricNamespace", "documentation":"

The CloudWatch metric namespace name.

" }, "metricName":{ "shape":"MetricName", "documentation":"

The CloudWatch metric name.

" }, "metricValue":{ "shape":"MetricValue", "documentation":"

The CloudWatch metric value.

" }, "metricUnit":{ "shape":"MetricUnit", "documentation":"

The metric unit supported by CloudWatch.

" }, "metricTimestamp":{ "shape":"MetricTimestamp", "documentation":"

An optional Unix timestamp.

" } }, "documentation":"

Describes an action that captures a CloudWatch metric.

" }, "CreateCertificateFromCsrRequest":{ "type":"structure", "required":["certificateSigningRequest"], "members":{ "certificateSigningRequest":{ "shape":"CertificateSigningRequest", "documentation":"

The certificate signing request (CSR).

" }, "setAsActive":{ "shape":"SetAsActive", "location":"querystring", "locationName":"setAsActive", "documentation":"

Specifies whether the certificate is active.

" } }, "documentation":"

The input for the CreateCertificateFromCsr operation.

" }, "CreateCertificateFromCsrResponse":{ "type":"structure", "members":{ "certificateArn":{ "shape":"CertificateArn", "documentation":"

The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations.

" }, "certificateId":{ "shape":"CertificateId", "documentation":"

The ID of the certificate. Certificate management operations only take a certificateId.

" }, "certificatePem":{ "shape":"CertificatePem", "documentation":"

The certificate data, in PEM format.

" } }, "documentation":"

The output from the CreateCertificateFromCsr operation.

" }, "CreateKeysAndCertificateRequest":{ "type":"structure", "members":{ "setAsActive":{ "shape":"SetAsActive", "location":"querystring", "locationName":"setAsActive", "documentation":"

Specifies whether the certificate is active.

" } }, "documentation":"

The input for the CreateKeysAndCertificate operation.

" }, "CreateKeysAndCertificateResponse":{ "type":"structure", "members":{ "certificateArn":{ "shape":"CertificateArn", "documentation":"

The ARN of the certificate.

" }, "certificateId":{ "shape":"CertificateId", "documentation":"

The ID of the certificate. AWS IoT issues a default subject name for the certificate (for example, AWS IoT Certificate).

" }, "certificatePem":{ "shape":"CertificatePem", "documentation":"

The certificate data, in PEM format.

" }, "keyPair":{ "shape":"KeyPair", "documentation":"

The generated key pair.

" } }, "documentation":"

The output of the CreateKeysAndCertificate operation.

" }, "CreatePolicyRequest":{ "type":"structure", "required":[ "policyName", "policyDocument" ], "members":{ "policyName":{ "shape":"PolicyName", "location":"uri", "locationName":"policyName", "documentation":"

The policy name.

" }, "policyDocument":{ "shape":"PolicyDocument", "documentation":"

The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.

" } }, "documentation":"

The input for the CreatePolicy operation.

" }, "CreatePolicyResponse":{ "type":"structure", "members":{ "policyName":{ "shape":"PolicyName", "documentation":"

The policy name.

" }, "policyArn":{ "shape":"PolicyArn", "documentation":"

The policy ARN.

" }, "policyDocument":{ "shape":"PolicyDocument", "documentation":"

The JSON document that describes the policy.

" }, "policyVersionId":{ "shape":"PolicyVersionId", "documentation":"

The policy version ID.

" } }, "documentation":"

The output from the CreatePolicy operation.

" }, "CreatePolicyVersionRequest":{ "type":"structure", "required":[ "policyName", "policyDocument" ], "members":{ "policyName":{ "shape":"PolicyName", "location":"uri", "locationName":"policyName", "documentation":"

The policy name.

" }, "policyDocument":{ "shape":"PolicyDocument", "documentation":"

The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespaces

" }, "setAsDefault":{ "shape":"SetAsDefault", "location":"querystring", "locationName":"setAsDefault", "documentation":"

Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

" } }, "documentation":"

The input for the CreatePolicyVersion operation.

" }, "CreatePolicyVersionResponse":{ "type":"structure", "members":{ "policyArn":{ "shape":"PolicyArn", "documentation":"

The policy ARN.

" }, "policyDocument":{ "shape":"PolicyDocument", "documentation":"

The JSON document that describes the policy.

" }, "policyVersionId":{ "shape":"PolicyVersionId", "documentation":"

The policy version ID.

" }, "isDefaultVersion":{ "shape":"IsDefaultVersion", "documentation":"

Specifies whether the policy version is the default.

" } }, "documentation":"

The output of the CreatePolicyVersion operation.

" }, "CreateThingRequest":{ "type":"structure", "required":["thingName"], "members":{ "thingName":{ "shape":"ThingName", "location":"uri", "locationName":"thingName", "documentation":"

The name of the thing to create.

" }, "thingTypeName":{ "shape":"ThingTypeName", "documentation":"

The name of the thing type associated with the new thing.

" }, "attributePayload":{ "shape":"AttributePayload", "documentation":"

The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:

{\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}})

" } }, "documentation":"

The input for the CreateThing operation.

" }, "CreateThingResponse":{ "type":"structure", "members":{ "thingName":{ "shape":"ThingName", "documentation":"

The name of the new thing.

" }, "thingArn":{ "shape":"ThingArn", "documentation":"

The ARN of the new thing.

" } }, "documentation":"

The output of the CreateThing operation.

" }, "CreateThingTypeRequest":{ "type":"structure", "required":["thingTypeName"], "members":{ "thingTypeName":{ "shape":"ThingTypeName", "location":"uri", "locationName":"thingTypeName", "documentation":"

The name of the thing type.

" }, "thingTypeProperties":{ "shape":"ThingTypeProperties", "documentation":"

The ThingTypeProperties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names.

" } }, "documentation":"

The input for the CreateThingType operation.

" }, "CreateThingTypeResponse":{ "type":"structure", "members":{ "thingTypeName":{ "shape":"ThingTypeName", "documentation":"

The name of the thing type.

" }, "thingTypeArn":{ "shape":"ThingTypeArn", "documentation":"

The Amazon Resource Name (ARN) of the thing type.

" } }, "documentation":"

The output of the CreateThingType operation.

" }, "CreateTopicRuleRequest":{ "type":"structure", "required":[ "ruleName", "topicRulePayload" ], "members":{ "ruleName":{ "shape":"RuleName", "location":"uri", "locationName":"ruleName", "documentation":"

The name of the rule.

" }, "topicRulePayload":{ "shape":"TopicRulePayload", "documentation":"

The rule payload.

" } }, "documentation":"

The input for the CreateTopicRule operation.

", "payload":"topicRulePayload" }, "CreatedAtDate":{"type":"timestamp"}, "CreationDate":{"type":"timestamp"}, "DateType":{"type":"timestamp"}, "DeleteCACertificateRequest":{ "type":"structure", "required":["certificateId"], "members":{ "certificateId":{ "shape":"CertificateId", "location":"uri", "locationName":"caCertificateId", "documentation":"

The ID of the certificate to delete.

" } }, "documentation":"

Input for the DeleteCACertificate operation.

" }, "DeleteCACertificateResponse":{ "type":"structure", "members":{ }, "documentation":"

The output for the DeleteCACertificate operation.

" }, "DeleteCertificateRequest":{ "type":"structure", "required":["certificateId"], "members":{ "certificateId":{ "shape":"CertificateId", "location":"uri", "locationName":"certificateId", "documentation":"

The ID of the certificate.

" } }, "documentation":"

The input for the DeleteCertificate operation.

" }, "DeleteConflictException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"

You can't delete the resource because it is attached to one or more resources.

" }, "DeletePolicyRequest":{ "type":"structure", "required":["policyName"], "members":{ "policyName":{ "shape":"PolicyName", "location":"uri", "locationName":"policyName", "documentation":"

The name of the policy to delete.

" } }, "documentation":"

The input for the DeletePolicy operation.

" }, "DeletePolicyVersionRequest":{ "type":"structure", "required":[ "policyName", "policyVersionId" ], "members":{ "policyName":{ "shape":"PolicyName", "location":"uri", "locationName":"policyName", "documentation":"

The name of the policy.

" }, "policyVersionId":{ "shape":"PolicyVersionId", "location":"uri", "locationName":"policyVersionId", "documentation":"

The policy version ID.

" } }, "documentation":"

The input for the DeletePolicyVersion operation.

" }, "DeleteRegistrationCodeRequest":{ "type":"structure", "members":{ }, "documentation":"

The input for the DeleteRegistrationCode operation.

" }, "DeleteRegistrationCodeResponse":{ "type":"structure", "members":{ }, "documentation":"

The output for the DeleteRegistrationCode operation.

" }, "DeleteThingRequest":{ "type":"structure", "required":["thingName"], "members":{ "thingName":{ "shape":"ThingName", "location":"uri", "locationName":"thingName", "documentation":"

The name of the thing to delete.

" }, "expectedVersion":{ "shape":"OptionalVersion", "location":"querystring", "locationName":"expectedVersion", "documentation":"

The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the DeleteThing request is rejected with a VersionConflictException.

" } }, "documentation":"

The input for the DeleteThing operation.

" }, "DeleteThingResponse":{ "type":"structure", "members":{ }, "documentation":"

The output of the DeleteThing operation.

" }, "DeleteThingTypeRequest":{ "type":"structure", "required":["thingTypeName"], "members":{ "thingTypeName":{ "shape":"ThingTypeName", "location":"uri", "locationName":"thingTypeName", "documentation":"

The name of the thing type.

" } }, "documentation":"

The input for the DeleteThingType operation.

" }, "DeleteThingTypeResponse":{ "type":"structure", "members":{ }, "documentation":"

The output for the DeleteThingType operation.

" }, "DeleteTopicRuleRequest":{ "type":"structure", "members":{ "ruleName":{ "shape":"RuleName", "location":"uri", "locationName":"ruleName", "documentation":"

The name of the rule.

" } }, "documentation":"

The input for the DeleteTopicRule operation.

", "required":["ruleName"] }, "DeliveryStreamName":{"type":"string"}, "DeprecateThingTypeRequest":{ "type":"structure", "required":["thingTypeName"], "members":{ "thingTypeName":{ "shape":"ThingTypeName", "location":"uri", "locationName":"thingTypeName", "documentation":"

The name of the thing type to deprecate.

" }, "undoDeprecate":{ "shape":"UndoDeprecate", "documentation":"

Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can associate it with things.

" } }, "documentation":"

The input for the DeprecateThingType operation.

" }, "DeprecateThingTypeResponse":{ "type":"structure", "members":{ }, "documentation":"

The output for the DeprecateThingType operation.

" }, "DeprecationDate":{"type":"timestamp"}, "DescribeCACertificateRequest":{ "type":"structure", "required":["certificateId"], "members":{ "certificateId":{ "shape":"CertificateId", "location":"uri", "locationName":"caCertificateId", "documentation":"

The CA certificate identifier.

" } }, "documentation":"

The input for the DescribeCACertificate operation.

" }, "DescribeCACertificateResponse":{ "type":"structure", "members":{ "certificateDescription":{ "shape":"CACertificateDescription", "documentation":"

The CA certificate description.

" } }, "documentation":"

The output from the DescribeCACertificate operation.

" }, "DescribeCertificateRequest":{ "type":"structure", "required":["certificateId"], "members":{ "certificateId":{ "shape":"CertificateId", "location":"uri", "locationName":"certificateId", "documentation":"

The ID of the certificate.

" } }, "documentation":"

The input for the DescribeCertificate operation.

" }, "DescribeCertificateResponse":{ "type":"structure", "members":{ "certificateDescription":{ "shape":"CertificateDescription", "documentation":"

The description of the certificate.

" } }, "documentation":"

The output of the DescribeCertificate operation.

" }, "DescribeEndpointRequest":{ "type":"structure", "members":{ }, "documentation":"

The input for the DescribeEndpoint operation.

" }, "DescribeEndpointResponse":{ "type":"structure", "members":{ "endpointAddress":{ "shape":"EndpointAddress", "documentation":"

The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.

" } }, "documentation":"

The output from the DescribeEndpoint operation.

" }, "DescribeThingRequest":{ "type":"structure", "required":["thingName"], "members":{ "thingName":{ "shape":"ThingName", "location":"uri", "locationName":"thingName", "documentation":"

The name of the thing.

" } }, "documentation":"

The input for the DescribeThing operation.

" }, "DescribeThingResponse":{ "type":"structure", "members":{ "defaultClientId":{ "shape":"ClientId", "documentation":"

The default client ID.

" }, "thingName":{ "shape":"ThingName", "documentation":"

The name of the thing.

" }, "thingTypeName":{ "shape":"ThingTypeName", "documentation":"

The thing type name.

" }, "attributes":{ "shape":"Attributes", "documentation":"

The thing attributes.

" }, "version":{ "shape":"Version", "documentation":"

The current version of the thing record in the registry.

To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.

" } }, "documentation":"

The output from the DescribeThing operation.

" }, "DescribeThingTypeRequest":{ "type":"structure", "required":["thingTypeName"], "members":{ "thingTypeName":{ "shape":"ThingTypeName", "location":"uri", "locationName":"thingTypeName", "documentation":"

The name of the thing type.

" } }, "documentation":"

The input for the DescribeThingType operation.

" }, "DescribeThingTypeResponse":{ "type":"structure", "members":{ "thingTypeName":{ "shape":"ThingTypeName", "documentation":"

The name of the thing type.

" }, "thingTypeProperties":{ "shape":"ThingTypeProperties", "documentation":"

The ThingTypeProperties contains information about the thing type including description, and a list of searchable thing attribute names.

" }, "thingTypeMetadata":{"shape":"ThingTypeMetadata"} }, "documentation":"

The output for the DescribeThingType operation.

" }, "Description":{"type":"string"}, "DetachPrincipalPolicyRequest":{ "type":"structure", "required":[ "policyName", "principal" ], "members":{ "policyName":{ "shape":"PolicyName", "location":"uri", "locationName":"policyName", "documentation":"

The name of the policy to detach.

" }, "principal":{ "shape":"Principal", "location":"header", "locationName":"x-amzn-iot-principal", "documentation":"

The principal.

If the principal is a certificate, specify the certificate ARN. If the principal is an Amazon Cognito identity, specify the identity ID.

" } }, "documentation":"

The input for the DetachPrincipalPolicy operation.

" }, "DetachThingPrincipalRequest":{ "type":"structure", "required":[ "thingName", "principal" ], "members":{ "thingName":{ "shape":"ThingName", "location":"uri", "locationName":"thingName", "documentation":"

The name of the thing.

" }, "principal":{ "shape":"Principal", "location":"header", "locationName":"x-amzn-principal", "documentation":"

If the principal is a certificate, this value must be ARN of the certificate. If the principal is an Amazon Cognito identity, this value must be the ID of the Amazon Cognito identity.

" } }, "documentation":"

The input for the DetachThingPrincipal operation.

" }, "DetachThingPrincipalResponse":{ "type":"structure", "members":{ }, "documentation":"

The output from the DetachThingPrincipal operation.

" }, "DisableTopicRuleRequest":{ "type":"structure", "required":["ruleName"], "members":{ "ruleName":{ "shape":"RuleName", "location":"uri", "locationName":"ruleName", "documentation":"

The name of the rule to disable.

" } }, "documentation":"

The input for the DisableTopicRuleRequest operation.

" }, "DynamoDBAction":{ "type":"structure", "required":[ "tableName", "roleArn", "hashKeyField", "hashKeyValue" ], "members":{ "tableName":{ "shape":"TableName", "documentation":"

The name of the DynamoDB table.

" }, "roleArn":{ "shape":"AwsArn", "documentation":"

The ARN of the IAM role that grants access to the DynamoDB table.

" }, "operation":{ "shape":"DynamoOperation", "documentation":"

The type of operation to be performed. This follows the substitution template, so it can be ${operation}, but the substitution must result in one of the following: INSERT, UPDATE, or DELETE.

" }, "hashKeyField":{ "shape":"HashKeyField", "documentation":"

The hash key name.

" }, "hashKeyValue":{ "shape":"HashKeyValue", "documentation":"

The hash key value.

" }, "hashKeyType":{ "shape":"DynamoKeyType", "documentation":"

The hash key type. Valid values are \"STRING\" or \"NUMBER\"

" }, "rangeKeyField":{ "shape":"RangeKeyField", "documentation":"

The range key name.

" }, "rangeKeyValue":{ "shape":"RangeKeyValue", "documentation":"

The range key value.

" }, "rangeKeyType":{ "shape":"DynamoKeyType", "documentation":"

The range key type. Valid values are \"STRING\" or \"NUMBER\"

" }, "payloadField":{ "shape":"PayloadField", "documentation":"

The action payload. This name can be customized.

" } }, "documentation":"

Describes an action to write to a DynamoDB table.

The tableName, hashKeyField, and rangeKeyField values must match the values used when you created the table.

The hashKeyValue and rangeKeyvalue fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${sql-expression}.

You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:

\"hashKeyValue\": \"${topic(3)}\"

The following field uses the timestamp:

\"rangeKeyValue\": \"${timestamp()}\"

" }, "DynamoDBv2Action":{ "type":"structure", "members":{ "roleArn":{ "shape":"AwsArn", "documentation":"

The ARN of the IAM role that grants access to the DynamoDB table.

" }, "putItem":{ "shape":"PutItemInput", "documentation":"

Specifies the DynamoDB table to which the message data will be written. For example:

{ \"dynamoDBv2\": { \"roleArn\": \"aws:iam:12341251:my-role\" \"putItem\": { \"tableName\": \"my-table\" } } }

Each attribute in the message payload will be written to a separate column in the DynamoDB database.

" } }, "documentation":"

Describes an action to write to a DynamoDB table.

This DynamoDB action writes each attribute in the message payload into it's own column in the DynamoDB table.

" }, "DynamoKeyType":{ "type":"string", "enum":[ "STRING", "NUMBER" ] }, "DynamoOperation":{"type":"string"}, "ElasticsearchAction":{ "type":"structure", "required":[ "roleArn", "endpoint", "index", "type", "id" ], "members":{ "roleArn":{ "shape":"AwsArn", "documentation":"

The IAM role ARN that has access to Elasticsearch.

" }, "endpoint":{ "shape":"ElasticsearchEndpoint", "documentation":"

The endpoint of your Elasticsearch domain.

" }, "index":{ "shape":"ElasticsearchIndex", "documentation":"

The Elasticsearch index where you want to store your data.

" }, "type":{ "shape":"ElasticsearchType", "documentation":"

The type of document you are storing.

" }, "id":{ "shape":"ElasticsearchId", "documentation":"

The unique identifier for the document you are storing.

" } }, "documentation":"

Describes an action that writes data to an Amazon Elasticsearch Service domain.

" }, "ElasticsearchEndpoint":{ "type":"string", "pattern":"https?://.*" }, "ElasticsearchId":{"type":"string"}, "ElasticsearchIndex":{"type":"string"}, "ElasticsearchType":{"type":"string"}, "EnableTopicRuleRequest":{ "type":"structure", "required":["ruleName"], "members":{ "ruleName":{ "shape":"RuleName", "location":"uri", "locationName":"ruleName", "documentation":"

The name of the topic rule to enable.

" } }, "documentation":"

The input for the EnableTopicRuleRequest operation.

" }, "EndpointAddress":{"type":"string"}, "FirehoseAction":{ "type":"structure", "required":[ "roleArn", "deliveryStreamName" ], "members":{ "roleArn":{ "shape":"AwsArn", "documentation":"

The IAM role that grants access to the Amazon Kinesis Firehost stream.

" }, "deliveryStreamName":{ "shape":"DeliveryStreamName", "documentation":"

The delivery stream name.

" }, "separator":{ "shape":"FirehoseSeparator", "documentation":"

A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma).

" } }, "documentation":"

Describes an action that writes data to an Amazon Kinesis Firehose stream.

" }, "FirehoseSeparator":{ "type":"string", "pattern":"([\\n\\t])|(\\r\\n)|(,)" }, "Flag":{"type":"boolean"}, "FunctionArn":{"type":"string"}, "GetLoggingOptionsRequest":{ "type":"structure", "members":{ }, "documentation":"

The input for the GetLoggingOptions operation.

" }, "GetLoggingOptionsResponse":{ "type":"structure", "members":{ "roleArn":{ "shape":"AwsArn", "documentation":"

The ARN of the IAM role that grants access.

" }, "logLevel":{ "shape":"LogLevel", "documentation":"

The logging level.

" } }, "documentation":"

The output from the GetLoggingOptions operation.

" }, "GetPolicyRequest":{ "type":"structure", "required":["policyName"], "members":{ "policyName":{ "shape":"PolicyName", "location":"uri", "locationName":"policyName", "documentation":"

The name of the policy.

" } }, "documentation":"

The input for the GetPolicy operation.

" }, "GetPolicyResponse":{ "type":"structure", "members":{ "policyName":{ "shape":"PolicyName", "documentation":"

The policy name.

" }, "policyArn":{ "shape":"PolicyArn", "documentation":"

The policy ARN.

" }, "policyDocument":{ "shape":"PolicyDocument", "documentation":"

The JSON document that describes the policy.

" }, "defaultVersionId":{ "shape":"PolicyVersionId", "documentation":"

The default policy version ID.

" } }, "documentation":"

The output from the GetPolicy operation.

" }, "GetPolicyVersionRequest":{ "type":"structure", "required":[ "policyName", "policyVersionId" ], "members":{ "policyName":{ "shape":"PolicyName", "location":"uri", "locationName":"policyName", "documentation":"

The name of the policy.

" }, "policyVersionId":{ "shape":"PolicyVersionId", "location":"uri", "locationName":"policyVersionId", "documentation":"

The policy version ID.

" } }, "documentation":"

The input for the GetPolicyVersion operation.

" }, "GetPolicyVersionResponse":{ "type":"structure", "members":{ "policyArn":{ "shape":"PolicyArn", "documentation":"

The policy ARN.

" }, "policyName":{ "shape":"PolicyName", "documentation":"

The policy name.

" }, "policyDocument":{ "shape":"PolicyDocument", "documentation":"

The JSON document that describes the policy.

" }, "policyVersionId":{ "shape":"PolicyVersionId", "documentation":"

The policy version ID.

" }, "isDefaultVersion":{ "shape":"IsDefaultVersion", "documentation":"

Specifies whether the policy version is the default.

" } }, "documentation":"

The output from the GetPolicyVersion operation.

" }, "GetRegistrationCodeRequest":{ "type":"structure", "members":{ }, "documentation":"

The input to the GetRegistrationCode operation.

" }, "GetRegistrationCodeResponse":{ "type":"structure", "members":{ "registrationCode":{ "shape":"RegistrationCode", "documentation":"

The CA certificate registration code.

" } }, "documentation":"

The output from the GetRegistrationCode operation.

" }, "GetTopicRuleRequest":{ "type":"structure", "required":["ruleName"], "members":{ "ruleName":{ "shape":"RuleName", "location":"uri", "locationName":"ruleName", "documentation":"

The name of the rule.

" } }, "documentation":"

The input for the GetTopicRule operation.

" }, "GetTopicRuleResponse":{ "type":"structure", "members":{ "ruleArn":{ "shape":"RuleArn", "documentation":"

The rule ARN.

" }, "rule":{ "shape":"TopicRule", "documentation":"

The rule.

" } }, "documentation":"

The output from the GetTopicRule operation.

" }, "HashKeyField":{"type":"string"}, "HashKeyValue":{"type":"string"}, "InternalException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, "InternalFailureException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":500}, "exception":true, "fault":true, "documentation":"

An unexpected error has occurred.

" }, "InvalidRequestException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request is not valid.

" }, "IsDefaultVersion":{"type":"boolean"}, "IsDisabled":{"type":"boolean"}, "Key":{"type":"string"}, "KeyPair":{ "type":"structure", "members":{ "PublicKey":{ "shape":"PublicKey", "documentation":"

The public key.

" }, "PrivateKey":{ "shape":"PrivateKey", "documentation":"

The private key.

" } }, "documentation":"

Describes a key pair.

" }, "KinesisAction":{ "type":"structure", "required":[ "roleArn", "streamName" ], "members":{ "roleArn":{ "shape":"AwsArn", "documentation":"

The ARN of the IAM role that grants access to the Amazon Kinesis stream.

" }, "streamName":{ "shape":"StreamName", "documentation":"

The name of the Amazon Kinesis stream.

" }, "partitionKey":{ "shape":"PartitionKey", "documentation":"

The partition key.

" } }, "documentation":"

Describes an action to write data to an Amazon Kinesis stream.

" }, "LambdaAction":{ "type":"structure", "required":["functionArn"], "members":{ "functionArn":{ "shape":"FunctionArn", "documentation":"

The ARN of the Lambda function.

" } }, "documentation":"

Describes an action to invoke a Lambda function.

" }, "LimitExceededException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":410}, "exception":true, "documentation":"

The number of attached entities exceeds the limit.

" }, "ListCACertificatesRequest":{ "type":"structure", "members":{ "pageSize":{ "shape":"PageSize", "location":"querystring", "locationName":"pageSize", "documentation":"

The result page size.

" }, "marker":{ "shape":"Marker", "location":"querystring", "locationName":"marker", "documentation":"

The marker for the next set of results.

" }, "ascendingOrder":{ "shape":"AscendingOrder", "location":"querystring", "locationName":"isAscendingOrder", "documentation":"

Determines the order of the results.

" } }, "documentation":"

Input for the ListCACertificates operation.

" }, "ListCACertificatesResponse":{ "type":"structure", "members":{ "certificates":{ "shape":"CACertificates", "documentation":"

The CA certificates registered in your AWS account.

" }, "nextMarker":{ "shape":"Marker", "documentation":"

The current position within the list of CA certificates.

" } }, "documentation":"

The output from the ListCACertificates operation.

" }, "ListCertificatesByCARequest":{ "type":"structure", "required":["caCertificateId"], "members":{ "caCertificateId":{ "shape":"CertificateId", "location":"uri", "locationName":"caCertificateId", "documentation":"

The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.

" }, "pageSize":{ "shape":"PageSize", "location":"querystring", "locationName":"pageSize", "documentation":"

The result page size.

" }, "marker":{ "shape":"Marker", "location":"querystring", "locationName":"marker", "documentation":"

The marker for the next set of results.

" }, "ascendingOrder":{ "shape":"AscendingOrder", "location":"querystring", "locationName":"isAscendingOrder", "documentation":"

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

" } }, "documentation":"

The input to the ListCertificatesByCA operation.

" }, "ListCertificatesByCAResponse":{ "type":"structure", "members":{ "certificates":{ "shape":"Certificates", "documentation":"

The device certificates signed by the specified CA certificate.

" }, "nextMarker":{ "shape":"Marker", "documentation":"

The marker for the next set of results, or null if there are no additional results.

" } }, "documentation":"

The output of the ListCertificatesByCA operation.

" }, "ListCertificatesRequest":{ "type":"structure", "members":{ "pageSize":{ "shape":"PageSize", "location":"querystring", "locationName":"pageSize", "documentation":"

The result page size.

" }, "marker":{ "shape":"Marker", "location":"querystring", "locationName":"marker", "documentation":"

The marker for the next set of results.

" }, "ascendingOrder":{ "shape":"AscendingOrder", "location":"querystring", "locationName":"isAscendingOrder", "documentation":"

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

" } }, "documentation":"

The input for the ListCertificates operation.

" }, "ListCertificatesResponse":{ "type":"structure", "members":{ "certificates":{ "shape":"Certificates", "documentation":"

The descriptions of the certificates.

" }, "nextMarker":{ "shape":"Marker", "documentation":"

The marker for the next set of results, or null if there are no additional results.

" } }, "documentation":"

The output of the ListCertificates operation.

" }, "ListOutgoingCertificatesRequest":{ "type":"structure", "members":{ "pageSize":{ "shape":"PageSize", "location":"querystring", "locationName":"pageSize", "documentation":"

The result page size.

" }, "marker":{ "shape":"Marker", "location":"querystring", "locationName":"marker", "documentation":"

The marker for the next set of results.

" }, "ascendingOrder":{ "shape":"AscendingOrder", "location":"querystring", "locationName":"isAscendingOrder", "documentation":"

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

" } }, "documentation":"

The input to the ListOutgoingCertificates operation.

" }, "ListOutgoingCertificatesResponse":{ "type":"structure", "members":{ "outgoingCertificates":{ "shape":"OutgoingCertificates", "documentation":"

The certificates that are being transfered but not yet accepted.

" }, "nextMarker":{ "shape":"Marker", "documentation":"

The marker for the next set of results.

" } }, "documentation":"

The output from the ListOutgoingCertificates operation.

" }, "ListPoliciesRequest":{ "type":"structure", "members":{ "marker":{ "shape":"Marker", "location":"querystring", "locationName":"marker", "documentation":"

The marker for the next set of results.

" }, "pageSize":{ "shape":"PageSize", "location":"querystring", "locationName":"pageSize", "documentation":"

The result page size.

" }, "ascendingOrder":{ "shape":"AscendingOrder", "location":"querystring", "locationName":"isAscendingOrder", "documentation":"

Specifies the order for results. If true, the results are returned in ascending creation order.

" } }, "documentation":"

The input for the ListPolicies operation.

" }, "ListPoliciesResponse":{ "type":"structure", "members":{ "policies":{ "shape":"Policies", "documentation":"

The descriptions of the policies.

" }, "nextMarker":{ "shape":"Marker", "documentation":"

The marker for the next set of results, or null if there are no additional results.

" } }, "documentation":"

The output from the ListPolicies operation.

" }, "ListPolicyPrincipalsRequest":{ "type":"structure", "required":["policyName"], "members":{ "policyName":{ "shape":"PolicyName", "location":"header", "locationName":"x-amzn-iot-policy", "documentation":"

The policy name.

" }, "marker":{ "shape":"Marker", "location":"querystring", "locationName":"marker", "documentation":"

The marker for the next set of results.

" }, "pageSize":{ "shape":"PageSize", "location":"querystring", "locationName":"pageSize", "documentation":"

The result page size.

" }, "ascendingOrder":{ "shape":"AscendingOrder", "location":"querystring", "locationName":"isAscendingOrder", "documentation":"

Specifies the order for results. If true, the results are returned in ascending creation order.

" } }, "documentation":"

The input for the ListPolicyPrincipals operation.

" }, "ListPolicyPrincipalsResponse":{ "type":"structure", "members":{ "principals":{ "shape":"Principals", "documentation":"

The descriptions of the principals.

" }, "nextMarker":{ "shape":"Marker", "documentation":"

The marker for the next set of results, or null if there are no additional results.

" } }, "documentation":"

The output from the ListPolicyPrincipals operation.

" }, "ListPolicyVersionsRequest":{ "type":"structure", "required":["policyName"], "members":{ "policyName":{ "shape":"PolicyName", "location":"uri", "locationName":"policyName", "documentation":"

The policy name.

" } }, "documentation":"

The input for the ListPolicyVersions operation.

" }, "ListPolicyVersionsResponse":{ "type":"structure", "members":{ "policyVersions":{ "shape":"PolicyVersions", "documentation":"

The policy versions.

" } }, "documentation":"

The output from the ListPolicyVersions operation.

" }, "ListPrincipalPoliciesRequest":{ "type":"structure", "required":["principal"], "members":{ "principal":{ "shape":"Principal", "location":"header", "locationName":"x-amzn-iot-principal", "documentation":"

The principal.

" }, "marker":{ "shape":"Marker", "location":"querystring", "locationName":"marker", "documentation":"

The marker for the next set of results.

" }, "pageSize":{ "shape":"PageSize", "location":"querystring", "locationName":"pageSize", "documentation":"

The result page size.

" }, "ascendingOrder":{ "shape":"AscendingOrder", "location":"querystring", "locationName":"isAscendingOrder", "documentation":"

Specifies the order for results. If true, results are returned in ascending creation order.

" } }, "documentation":"

The input for the ListPrincipalPolicies operation.

" }, "ListPrincipalPoliciesResponse":{ "type":"structure", "members":{ "policies":{ "shape":"Policies", "documentation":"

The policies.

" }, "nextMarker":{ "shape":"Marker", "documentation":"

The marker for the next set of results, or null if there are no additional results.

" } }, "documentation":"

The output from the ListPrincipalPolicies operation.

" }, "ListPrincipalThingsRequest":{ "type":"structure", "required":["principal"], "members":{ "nextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"nextToken", "documentation":"

The token for the next set of results, or null if there are no additional results.

" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults", "documentation":"

The maximum number of results to return in this operation.

" }, "principal":{ "shape":"Principal", "location":"header", "locationName":"x-amzn-principal", "documentation":"

The principal.

" } }, "documentation":"

The input for the ListPrincipalThings operation.

" }, "ListPrincipalThingsResponse":{ "type":"structure", "members":{ "things":{ "shape":"ThingNameList", "documentation":"

The things.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of results, or null if there are no additional results.

" } }, "documentation":"

The output from the ListPrincipalThings operation.

" }, "ListThingPrincipalsRequest":{ "type":"structure", "required":["thingName"], "members":{ "thingName":{ "shape":"ThingName", "location":"uri", "locationName":"thingName", "documentation":"

The name of the thing.

" } }, "documentation":"

The input for the ListThingPrincipal operation.

" }, "ListThingPrincipalsResponse":{ "type":"structure", "members":{ "principals":{ "shape":"Principals", "documentation":"

The principals associated with the thing.

" } }, "documentation":"

The output from the ListThingPrincipals operation.

" }, "ListThingTypesRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"nextToken", "documentation":"

The token for the next set of results, or null if there are no additional results.

" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults", "documentation":"

The maximum number of results to return in this operation.

" }, "thingTypeName":{ "shape":"ThingTypeName", "location":"querystring", "locationName":"thingTypeName", "documentation":"

The name of the thing type.

" } }, "documentation":"

The input for the ListThingTypes operation.

" }, "ListThingTypesResponse":{ "type":"structure", "members":{ "thingTypes":{ "shape":"ThingTypeList", "documentation":"

The thing types.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of results, or null if there are no additional results.

" } }, "documentation":"

The output for the ListThingTypes operation.

" }, "ListThingsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"nextToken", "documentation":"

The token for the next set of results, or null if there are no additional results.

" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults", "documentation":"

The maximum number of results to return in this operation.

" }, "attributeName":{ "shape":"AttributeName", "location":"querystring", "locationName":"attributeName", "documentation":"

The attribute name used to search for things.

" }, "attributeValue":{ "shape":"AttributeValue", "location":"querystring", "locationName":"attributeValue", "documentation":"

The attribute value used to search for things.

" }, "thingTypeName":{ "shape":"ThingTypeName", "location":"querystring", "locationName":"thingTypeName", "documentation":"

The name of the thing type used to search for things.

" } }, "documentation":"

The input for the ListThings operation.

" }, "ListThingsResponse":{ "type":"structure", "members":{ "things":{ "shape":"ThingAttributeList", "documentation":"

The things.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of results, or null if there are no additional results.

" } }, "documentation":"

The output from the ListThings operation.

" }, "ListTopicRulesRequest":{ "type":"structure", "members":{ "topic":{ "shape":"Topic", "location":"querystring", "locationName":"topic", "documentation":"

The topic.

" }, "maxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"maxResults", "documentation":"

The maximum number of results to return.

" }, "nextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"nextToken", "documentation":"

A token used to retrieve the next value.

" }, "ruleDisabled":{ "shape":"IsDisabled", "location":"querystring", "locationName":"ruleDisabled", "documentation":"

Specifies whether the rule is disabled.

" } }, "documentation":"

The input for the ListTopicRules operation.

" }, "ListTopicRulesResponse":{ "type":"structure", "members":{ "rules":{ "shape":"TopicRuleList", "documentation":"

The rules.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token used to retrieve the next value.

" } }, "documentation":"

The output from the ListTopicRules operation.

" }, "LogLevel":{ "type":"string", "enum":[ "DEBUG", "INFO", "ERROR", "WARN", "DISABLED" ] }, "LoggingOptionsPayload":{ "type":"structure", "required":["roleArn"], "members":{ "roleArn":{ "shape":"AwsArn", "documentation":"

The ARN of the IAM role that grants access.

" }, "logLevel":{ "shape":"LogLevel", "documentation":"

The logging level.

" } }, "documentation":"

Describes the logging options payload.

" }, "MalformedPolicyException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The policy documentation is not valid.

" }, "Marker":{"type":"string"}, "MaxResults":{ "type":"integer", "min":1, "max":10000 }, "Message":{ "type":"string", "max":128 }, "MessageFormat":{ "type":"string", "enum":[ "RAW", "JSON" ] }, "MetricName":{"type":"string"}, "MetricNamespace":{"type":"string"}, "MetricTimestamp":{"type":"string"}, "MetricUnit":{"type":"string"}, "MetricValue":{"type":"string"}, "NextToken":{"type":"string"}, "OptionalVersion":{"type":"long"}, "OutgoingCertificate":{ "type":"structure", "members":{ "certificateArn":{ "shape":"CertificateArn", "documentation":"

The certificate ARN.

" }, "certificateId":{ "shape":"CertificateId", "documentation":"

The certificate ID.

" }, "transferredTo":{ "shape":"AwsAccountId", "documentation":"

The AWS account to which the transfer was made.

" }, "transferDate":{ "shape":"DateType", "documentation":"

The date the transfer was initiated.

" }, "transferMessage":{ "shape":"Message", "documentation":"

The transfer message.

" }, "creationDate":{ "shape":"DateType", "documentation":"

The certificate creation date.

" } }, "documentation":"

A certificate that has been transfered but not yet accepted.

" }, "OutgoingCertificates":{ "type":"list", "member":{"shape":"OutgoingCertificate"} }, "PageSize":{ "type":"integer", "min":1, "max":250 }, "PartitionKey":{"type":"string"}, "PayloadField":{"type":"string"}, "Policies":{ "type":"list", "member":{"shape":"Policy"} }, "Policy":{ "type":"structure", "members":{ "policyName":{ "shape":"PolicyName", "documentation":"

The policy name.

" }, "policyArn":{ "shape":"PolicyArn", "documentation":"

The policy ARN.

" } }, "documentation":"

Describes an AWS IoT policy.

" }, "PolicyArn":{"type":"string"}, "PolicyDocument":{"type":"string"}, "PolicyName":{ "type":"string", "min":1, "max":128, "pattern":"[\\w+=,.@-]+" }, "PolicyVersion":{ "type":"structure", "members":{ "versionId":{ "shape":"PolicyVersionId", "documentation":"

The policy version ID.

" }, "isDefaultVersion":{ "shape":"IsDefaultVersion", "documentation":"

Specifies whether the policy version is the default.

" }, "createDate":{ "shape":"DateType", "documentation":"

The date and time the policy was created.

" } }, "documentation":"

Describes a policy version.

" }, "PolicyVersionId":{ "type":"string", "pattern":"[0-9]+" }, "PolicyVersions":{ "type":"list", "member":{"shape":"PolicyVersion"} }, "Principal":{"type":"string"}, "PrincipalArn":{"type":"string"}, "Principals":{ "type":"list", "member":{"shape":"PrincipalArn"} }, "PrivateKey":{ "type":"string", "min":1, "sensitive":true }, "PublicKey":{ "type":"string", "min":1 }, "PutItemInput":{ "type":"structure", "required":["tableName"], "members":{ "tableName":{ "shape":"TableName", "documentation":"

The table where the message data will be written

" } }, "documentation":"

The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.

" }, "QueueUrl":{"type":"string"}, "RangeKeyField":{"type":"string"}, "RangeKeyValue":{"type":"string"}, "RegisterCACertificateRequest":{ "type":"structure", "required":[ "caCertificate", "verificationCertificate" ], "members":{ "caCertificate":{ "shape":"CertificatePem", "documentation":"

The CA certificate.

" }, "verificationCertificate":{ "shape":"CertificatePem", "documentation":"

The private key verification certificate.

" }, "setAsActive":{ "shape":"SetAsActive", "location":"querystring", "locationName":"setAsActive", "documentation":"

A boolean value that specifies if the CA certificate is set to active.

" }, "allowAutoRegistration":{ "shape":"AllowAutoRegistration", "location":"querystring", "locationName":"allowAutoRegistration", "documentation":"

Allows this CA certificate to be used for auto registration of device certificates.

" } }, "documentation":"

The input to the RegisterCACertificate operation.

" }, "RegisterCACertificateResponse":{ "type":"structure", "members":{ "certificateArn":{ "shape":"CertificateArn", "documentation":"

The CA certificate ARN.

" }, "certificateId":{ "shape":"CertificateId", "documentation":"

The CA certificate identifier.

" } }, "documentation":"

The output from the RegisterCACertificateResponse operation.

" }, "RegisterCertificateRequest":{ "type":"structure", "required":["certificatePem"], "members":{ "certificatePem":{ "shape":"CertificatePem", "documentation":"

The certificate data, in PEM format.

" }, "caCertificatePem":{ "shape":"CertificatePem", "documentation":"

The CA certificate used to sign the device certificate being registered.

" }, "setAsActive":{ "shape":"SetAsActiveFlag", "deprecated":true, "location":"querystring", "locationName":"setAsActive", "documentation":"

A boolean value that specifies if the CA certificate is set to active.

" }, "status":{"shape":"CertificateStatus"} }, "documentation":"

The input to the RegisterCertificate operation.

" }, "RegisterCertificateResponse":{ "type":"structure", "members":{ "certificateArn":{ "shape":"CertificateArn", "documentation":"

The certificate ARN.

" }, "certificateId":{ "shape":"CertificateId", "documentation":"

The certificate identifier.

" } }, "documentation":"

The output from the RegisterCertificate operation.

" }, "RegistrationCode":{ "type":"string", "min":64, "max":64, "pattern":"(0x)?[a-fA-F0-9]+" }, "RegistrationCodeValidationException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

Additional information about the exception.

" } }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The registration code is invalid.

" }, "RejectCertificateTransferRequest":{ "type":"structure", "required":["certificateId"], "members":{ "certificateId":{ "shape":"CertificateId", "location":"uri", "locationName":"certificateId", "documentation":"

The ID of the certificate.

" }, "rejectReason":{ "shape":"Message", "documentation":"

The reason the certificate transfer was rejected.

" } }, "documentation":"

The input for the RejectCertificateTransfer operation.

" }, "RemoveThingType":{"type":"boolean"}, "ReplaceTopicRuleRequest":{ "type":"structure", "required":[ "ruleName", "topicRulePayload" ], "members":{ "ruleName":{ "shape":"RuleName", "location":"uri", "locationName":"ruleName", "documentation":"

The name of the rule.

" }, "topicRulePayload":{ "shape":"TopicRulePayload", "documentation":"

The rule payload.

" } }, "documentation":"

The input for the ReplaceTopicRule operation.

", "payload":"topicRulePayload" }, "RepublishAction":{ "type":"structure", "required":[ "roleArn", "topic" ], "members":{ "roleArn":{ "shape":"AwsArn", "documentation":"

The ARN of the IAM role that grants access.

" }, "topic":{ "shape":"TopicPattern", "documentation":"

The name of the MQTT topic.

" } }, "documentation":"

Describes an action to republish to another topic.

" }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" }, "resourceId":{ "shape":"resourceId", "documentation":"

The ID of the resource that caused the exception.

" }, "resourceArn":{ "shape":"resourceArn", "documentation":"

The ARN of the resource that caused the exception.

" } }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"

The resource already exists.

" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The specified resource does not exist.

" }, "RuleArn":{"type":"string"}, "RuleName":{ "type":"string", "min":1, "max":128, "pattern":"^[a-zA-Z0-9_]+$" }, "S3Action":{ "type":"structure", "required":[ "roleArn", "bucketName", "key" ], "members":{ "roleArn":{ "shape":"AwsArn", "documentation":"

The ARN of the IAM role that grants access.

" }, "bucketName":{ "shape":"BucketName", "documentation":"

The Amazon S3 bucket.

" }, "key":{ "shape":"Key", "documentation":"

The object key.

" }, "cannedAcl":{ "shape":"CannedAccessControlList", "documentation":"

The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs.

" } }, "documentation":"

Describes an action to write data to an Amazon S3 bucket.

" }, "SQL":{"type":"string"}, "SearchableAttributes":{ "type":"list", "member":{"shape":"AttributeName"} }, "ServiceUnavailableException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":503}, "exception":true, "fault":true, "documentation":"

The service is temporarily unavailable.

" }, "SetAsActive":{"type":"boolean"}, "SetAsActiveFlag":{"type":"boolean"}, "SetAsDefault":{"type":"boolean"}, "SetDefaultPolicyVersionRequest":{ "type":"structure", "required":[ "policyName", "policyVersionId" ], "members":{ "policyName":{ "shape":"PolicyName", "location":"uri", "locationName":"policyName", "documentation":"

The policy name.

" }, "policyVersionId":{ "shape":"PolicyVersionId", "location":"uri", "locationName":"policyVersionId", "documentation":"

The policy version ID.

" } }, "documentation":"

The input for the SetDefaultPolicyVersion operation.

" }, "SetLoggingOptionsRequest":{ "type":"structure", "required":["loggingOptionsPayload"], "members":{ "loggingOptionsPayload":{ "shape":"LoggingOptionsPayload", "documentation":"

The logging options payload.

" } }, "documentation":"

The input for the SetLoggingOptions operation.

", "payload":"loggingOptionsPayload" }, "SnsAction":{ "type":"structure", "required":[ "targetArn", "roleArn" ], "members":{ "targetArn":{ "shape":"AwsArn", "documentation":"

The ARN of the SNS topic.

" }, "roleArn":{ "shape":"AwsArn", "documentation":"

The ARN of the IAM role that grants access.

" }, "messageFormat":{ "shape":"MessageFormat", "documentation":"

The message format of the message to publish. Optional. Accepted values are \"JSON\" and \"RAW\". The default value of the attribute is \"RAW\". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see refer to their official documentation.

" } }, "documentation":"

Describes an action to publish to an Amazon SNS topic.

" }, "SqlParseException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The Rule-SQL expression can't be parsed correctly.

" }, "SqsAction":{ "type":"structure", "required":[ "roleArn", "queueUrl" ], "members":{ "roleArn":{ "shape":"AwsArn", "documentation":"

The ARN of the IAM role that grants access.

" }, "queueUrl":{ "shape":"QueueUrl", "documentation":"

The URL of the Amazon SQS queue.

" }, "useBase64":{ "shape":"UseBase64", "documentation":"

Specifies whether to use Base64 encoding.

" } }, "documentation":"

Describes an action to publish data to an Amazon SQS queue.

" }, "StateReason":{"type":"string"}, "StateValue":{"type":"string"}, "StreamName":{"type":"string"}, "TableName":{"type":"string"}, "ThingArn":{"type":"string"}, "ThingAttribute":{ "type":"structure", "members":{ "thingName":{ "shape":"ThingName", "documentation":"

The name of the thing.

" }, "thingTypeName":{ "shape":"ThingTypeName", "documentation":"

The name of the thing type, if the thing has been associated with a type.

" }, "attributes":{ "shape":"Attributes", "documentation":"

A list of thing attributes which are name-value pairs.

" }, "version":{ "shape":"Version", "documentation":"

The version of the thing record in the registry.

" } }, "documentation":"

The properties of the thing, including thing name, thing type name, and a list of thing attributes.

" }, "ThingAttributeList":{ "type":"list", "member":{"shape":"ThingAttribute"} }, "ThingName":{ "type":"string", "min":1, "max":128, "pattern":"[a-zA-Z0-9:_-]+" }, "ThingNameList":{ "type":"list", "member":{"shape":"ThingName"} }, "ThingTypeArn":{"type":"string"}, "ThingTypeDefinition":{ "type":"structure", "members":{ "thingTypeName":{ "shape":"ThingTypeName", "documentation":"

The name of the thing type.

" }, "thingTypeProperties":{ "shape":"ThingTypeProperties", "documentation":"

The ThingTypeProperties for the thing type.

" }, "thingTypeMetadata":{"shape":"ThingTypeMetadata"} }, "documentation":"

The definition of the thing type, including thing type name and description.

" }, "ThingTypeDescription":{ "type":"string", "max":2028, "pattern":"[\\p{Graph}\\x20]*" }, "ThingTypeList":{ "type":"list", "member":{"shape":"ThingTypeDefinition"} }, "ThingTypeMetadata":{ "type":"structure", "members":{ "deprecated":{ "shape":"Boolean", "documentation":"

Whether the thing type is deprecated. If true, no new things could be associated with this type.

" }, "deprecationDate":{ "shape":"DeprecationDate", "documentation":"

The date and time when the thing type was deprecated.

" }, "creationDate":{ "shape":"CreationDate", "documentation":"

The date and time when the thing type was created.

" } }, "documentation":"

The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when time was deprecated.

" }, "ThingTypeName":{ "type":"string", "min":1, "max":128, "pattern":"[a-zA-Z0-9:_-]+" }, "ThingTypeProperties":{ "type":"structure", "members":{ "thingTypeDescription":{ "shape":"ThingTypeDescription", "documentation":"

The description of the thing type.

" }, "searchableAttributes":{ "shape":"SearchableAttributes", "documentation":"

A list of searchable thing attribute names.

" } }, "documentation":"

The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.

" }, "ThrottlingException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":429}, "exception":true, "documentation":"

The rate exceeds the limit.

" }, "Topic":{"type":"string"}, "TopicPattern":{"type":"string"}, "TopicRule":{ "type":"structure", "members":{ "ruleName":{ "shape":"RuleName", "documentation":"

The name of the rule.

" }, "sql":{ "shape":"SQL", "documentation":"

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

" }, "description":{ "shape":"Description", "documentation":"

The description of the rule.

" }, "createdAt":{ "shape":"CreatedAtDate", "documentation":"

The date and time the rule was created.

" }, "actions":{ "shape":"ActionList", "documentation":"

The actions associated with the rule.

" }, "ruleDisabled":{ "shape":"IsDisabled", "documentation":"

Specifies whether the rule is disabled.

" }, "awsIotSqlVersion":{ "shape":"AwsIotSqlVersion", "documentation":"

The version of the SQL rules engine to use when evaluating the rule.

" } }, "documentation":"

Describes a rule.

" }, "TopicRuleList":{ "type":"list", "member":{"shape":"TopicRuleListItem"} }, "TopicRuleListItem":{ "type":"structure", "members":{ "ruleArn":{ "shape":"RuleArn", "documentation":"

The rule ARN.

" }, "ruleName":{ "shape":"RuleName", "documentation":"

The name of the rule.

" }, "topicPattern":{ "shape":"TopicPattern", "documentation":"

The pattern for the topic names that apply.

" }, "createdAt":{ "shape":"CreatedAtDate", "documentation":"

The date and time the rule was created.

" }, "ruleDisabled":{ "shape":"IsDisabled", "documentation":"

Specifies whether the rule is disabled.

" } }, "documentation":"

Describes a rule.

" }, "TopicRulePayload":{ "type":"structure", "required":[ "sql", "actions" ], "members":{ "sql":{ "shape":"SQL", "documentation":"

The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.

" }, "description":{ "shape":"Description", "documentation":"

The description of the rule.

" }, "actions":{ "shape":"ActionList", "documentation":"

The actions associated with the rule.

" }, "ruleDisabled":{ "shape":"IsDisabled", "documentation":"

Specifies whether the rule is disabled.

" }, "awsIotSqlVersion":{ "shape":"AwsIotSqlVersion", "documentation":"

The version of the SQL rules engine to use when evaluating the rule.

" } }, "documentation":"

Describes a rule.

" }, "TransferAlreadyCompletedException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":410}, "exception":true, "documentation":"

You can't revert the certificate transfer because the transfer is already complete.

" }, "TransferCertificateRequest":{ "type":"structure", "required":[ "certificateId", "targetAwsAccount" ], "members":{ "certificateId":{ "shape":"CertificateId", "location":"uri", "locationName":"certificateId", "documentation":"

The ID of the certificate.

" }, "targetAwsAccount":{ "shape":"AwsAccountId", "location":"querystring", "locationName":"targetAwsAccount", "documentation":"

The AWS account.

" }, "transferMessage":{ "shape":"Message", "documentation":"

The transfer message.

" } }, "documentation":"

The input for the TransferCertificate operation.

" }, "TransferCertificateResponse":{ "type":"structure", "members":{ "transferredCertificateArn":{ "shape":"CertificateArn", "documentation":"

The ARN of the certificate.

" } }, "documentation":"

The output from the TransferCertificate operation.

" }, "TransferConflictException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"

You can't transfer the certificate because authorization policies are still attached.

" }, "TransferData":{ "type":"structure", "members":{ "transferMessage":{ "shape":"Message", "documentation":"

The transfer message.

" }, "rejectReason":{ "shape":"Message", "documentation":"

The reason why the transfer was rejected.

" }, "transferDate":{ "shape":"DateType", "documentation":"

The date the transfer took place.

" }, "acceptDate":{ "shape":"DateType", "documentation":"

The date the transfer was accepted.

" }, "rejectDate":{ "shape":"DateType", "documentation":"

The date the transfer was rejected.

" } }, "documentation":"

Data used to transfer a certificate to an AWS account.

" }, "UnauthorizedException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":401}, "exception":true, "documentation":"

You are not authorized to perform this operation.

" }, "UndoDeprecate":{"type":"boolean"}, "UpdateCACertificateRequest":{ "type":"structure", "required":["certificateId"], "members":{ "certificateId":{ "shape":"CertificateId", "location":"uri", "locationName":"caCertificateId", "documentation":"

The CA certificate identifier.

" }, "newStatus":{ "shape":"CACertificateStatus", "location":"querystring", "locationName":"newStatus", "documentation":"

The updated status of the CA certificate.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

" }, "newAutoRegistrationStatus":{ "shape":"AutoRegistrationStatus", "location":"querystring", "locationName":"newAutoRegistrationStatus", "documentation":"

The new value for the auto registration status. Valid values are: \"ENABLE\" or \"DISABLE\".

" } }, "documentation":"

The input to the UpdateCACertificate operation.

" }, "UpdateCertificateRequest":{ "type":"structure", "required":[ "certificateId", "newStatus" ], "members":{ "certificateId":{ "shape":"CertificateId", "location":"uri", "locationName":"certificateId", "documentation":"

The ID of the certificate.

" }, "newStatus":{ "shape":"CertificateStatus", "location":"querystring", "locationName":"newStatus", "documentation":"

The new status.

Note: Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is not intended for developer use.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

" } }, "documentation":"

The input for the UpdateCertificate operation.

" }, "UpdateThingRequest":{ "type":"structure", "required":["thingName"], "members":{ "thingName":{ "shape":"ThingName", "location":"uri", "locationName":"thingName", "documentation":"

The name of the thing to update.

" }, "thingTypeName":{ "shape":"ThingTypeName", "documentation":"

The name of the thing type.

" }, "attributePayload":{ "shape":"AttributePayload", "documentation":"

A list of thing attributes, a JSON string containing name-value pairs. For example:

{\\\"attributes\\\":{\\\"name1\\\":\\\"value2\\\"}})

This data is used to add new attributes or update existing attributes.

" }, "expectedVersion":{ "shape":"OptionalVersion", "documentation":"

The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the UpdateThing request is rejected with a VersionConflictException.

" }, "removeThingType":{ "shape":"RemoveThingType", "documentation":"

Remove a thing type association. If true, the assocation is removed.

" } }, "documentation":"

The input for the UpdateThing operation.

" }, "UpdateThingResponse":{ "type":"structure", "members":{ }, "documentation":"

The output from the UpdateThing operation.

" }, "UseBase64":{"type":"boolean"}, "Version":{"type":"long"}, "VersionConflictException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"

An exception thrown when the version of a thing passed to a command is different than the version specified with the --version parameter.

" }, "VersionsLimitExceededException":{ "type":"structure", "members":{ "message":{ "shape":"errorMessage", "documentation":"

The message for the exception.

" } }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"

The number of policy versions exceeds the limit.

" }, "errorMessage":{"type":"string"}, "resourceArn":{"type":"string"}, "resourceId":{"type":"string"} }, "examples":{ } } botocore-1.5.7/botocore/data/acm/0000777454262600001440000000000013042511307017673 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/acm/2015-12-08/0000777454262600001440000000000013042511307020727 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/acm/2015-12-08/paginators-1.json0000666454262600001440000000031413042511306024124 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListCertificates": { "input_token": "NextToken", "output_token": "NextToken", "limit_key": "MaxItems", "result_key": "CertificateSummaryList" } } } botocore-1.5.7/botocore/data/acm/2015-12-08/service-2.json0000666454262600001440000012034113042511306023421 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-12-08", "endpointPrefix":"acm", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"ACM", "serviceFullName":"AWS Certificate Manager", "signatureVersion":"v4", "targetPrefix":"CertificateManager", "uid":"acm-2015-12-08" }, "operations":{ "AddTagsToCertificate":{ "name":"AddTagsToCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsToCertificateRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"InvalidTagException"}, {"shape":"TooManyTagsException"} ], "documentation":"

Adds one or more tags to an ACM Certificate. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair.

You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM Certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM Certificates.

To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.

" }, "DeleteCertificate":{ "name":"DeleteCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteCertificateRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidArnException"} ], "documentation":"

Deletes an ACM Certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list of ACM Certificates that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by other AWS services.

You cannot delete an ACM Certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.

" }, "DescribeCertificate":{ "name":"DescribeCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCertificateRequest"}, "output":{"shape":"DescribeCertificateResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidArnException"} ], "documentation":"

Returns detailed metadata about the specified ACM Certificate.

" }, "GetCertificate":{ "name":"GetCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCertificateRequest"}, "output":{"shape":"GetCertificateResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"RequestInProgressException"}, {"shape":"InvalidArnException"} ], "documentation":"

Retrieves an ACM Certificate and certificate chain for the certificate specified by an ARN. The chain is an ordered list of certificates that contains the root certificate, intermediate certificates of subordinate CAs, and the ACM Certificate. The certificate and certificate chain are base64 encoded. If you want to decode the certificate chain to see the individual certificate fields, you can use OpenSSL.

Currently, ACM Certificates can be used only with Elastic Load Balancing and Amazon CloudFront.

" }, "ImportCertificate":{ "name":"ImportCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportCertificateRequest"}, "output":{"shape":"ImportCertificateResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

Imports an SSL/TLS certificate into AWS Certificate Manager (ACM) to use with ACM's integrated AWS services.

ACM does not provide managed renewal for certificates that you import.

For more information about importing certificates into ACM, including the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide.

To import a certificate, you must provide the certificate and the matching private key. When the certificate is not self-signed, you must also provide a certificate chain. You can omit the certificate chain when importing a self-signed certificate.

The certificate, private key, and certificate chain must be PEM-encoded. For more information about converting these items to PEM format, see Importing Certificates Troubleshooting in the AWS Certificate Manager User Guide.

To import a new certificate, omit the CertificateArn field. Include this field only when you want to replace a previously imported certificate.

This operation returns the Amazon Resource Name (ARN) of the imported certificate.

" }, "ListCertificates":{ "name":"ListCertificates", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCertificatesRequest"}, "output":{"shape":"ListCertificatesResponse"}, "documentation":"

Retrieves a list of ACM Certificates and the domain name for each. You can optionally filter the list to return only the certificates that match the specified status.

" }, "ListTagsForCertificate":{ "name":"ListTagsForCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForCertificateRequest"}, "output":{"shape":"ListTagsForCertificateResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidArnException"} ], "documentation":"

Lists the tags that have been applied to the ACM Certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM Certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.

" }, "RemoveTagsFromCertificate":{ "name":"RemoveTagsFromCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTagsFromCertificateRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"InvalidTagException"} ], "documentation":"

Remove one or more tags from an ACM Certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value.

To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM Certificate, use the ListTagsForCertificate action.

" }, "RequestCertificate":{ "name":"RequestCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RequestCertificateRequest"}, "output":{"shape":"RequestCertificateResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"InvalidDomainValidationOptionsException"} ], "documentation":"

Requests an ACM Certificate for use with other AWS services. To request an ACM Certificate, you must specify the fully qualified domain name (FQDN) for your site. You can also specify additional FQDNs if users can reach your site by using other names. For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate. After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the AWS Certificate Manager User Guide.

" }, "ResendValidationEmail":{ "name":"ResendValidationEmail", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResendValidationEmailRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidStateException"}, {"shape":"InvalidArnException"}, {"shape":"InvalidDomainValidationOptionsException"} ], "documentation":"

Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM Certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM Certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate.

" } }, "shapes":{ "AddTagsToCertificateRequest":{ "type":"structure", "required":[ "CertificateArn", "Tags" ], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"

String that contains the ARN of the ACM Certificate to which the tag is to be applied. This must be of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" }, "Tags":{ "shape":"TagList", "documentation":"

The key-value pair that defines the tag. The tag value is optional.

" } } }, "Arn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*" }, "CertificateBody":{ "type":"string", "max":32768, "min":1, "pattern":"-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?" }, "CertificateBodyBlob":{ "type":"blob", "max":32768, "min":1 }, "CertificateChain":{ "type":"string", "max":2097152, "min":1, "pattern":"(-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}\\u000D?\\u000A)*-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?" }, "CertificateChainBlob":{ "type":"blob", "max":2097152, "min":1 }, "CertificateDetail":{ "type":"structure", "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" }, "DomainName":{ "shape":"DomainNameString", "documentation":"

The fully qualified domain name for the certificate, such as www.example.com or example.com.

" }, "SubjectAlternativeNames":{ "shape":"DomainList", "documentation":"

One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

" }, "DomainValidationOptions":{ "shape":"DomainValidationList", "documentation":"

Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

" }, "Serial":{ "shape":"String", "documentation":"

The serial number of the certificate.

" }, "Subject":{ "shape":"String", "documentation":"

The name of the entity that is associated with the public key contained in the certificate.

" }, "Issuer":{ "shape":"String", "documentation":"

The name of the certificate authority that issued and signed the certificate.

" }, "CreatedAt":{ "shape":"TStamp", "documentation":"

The time at which the certificate was requested. This value exists only when the certificate type is AMAZON_ISSUED.

" }, "IssuedAt":{ "shape":"TStamp", "documentation":"

The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.

" }, "ImportedAt":{ "shape":"TStamp", "documentation":"

The date and time at which the certificate was imported. This value exists only when the certificate type is IMPORTED.

" }, "Status":{ "shape":"CertificateStatus", "documentation":"

The status of the certificate.

" }, "RevokedAt":{ "shape":"TStamp", "documentation":"

The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.

" }, "RevocationReason":{ "shape":"RevocationReason", "documentation":"

The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.

" }, "NotBefore":{ "shape":"TStamp", "documentation":"

The time before which the certificate is not valid.

" }, "NotAfter":{ "shape":"TStamp", "documentation":"

The time after which the certificate is not valid.

" }, "KeyAlgorithm":{ "shape":"KeyAlgorithm", "documentation":"

The algorithm that was used to generate the key pair (the public and private key).

" }, "SignatureAlgorithm":{ "shape":"String", "documentation":"

The algorithm that was used to sign the certificate.

" }, "InUseBy":{ "shape":"InUseList", "documentation":"

A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources.

" }, "FailureReason":{ "shape":"FailureReason", "documentation":"

The reason the certificate request failed. This value exists only when the certificate status is FAILED. For more information, see Certificate Request Failed in the AWS Certificate Manager User Guide.

" }, "Type":{ "shape":"CertificateType", "documentation":"

The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide.

" }, "RenewalSummary":{ "shape":"RenewalSummary", "documentation":"

Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.

" } }, "documentation":"

Contains metadata about an ACM certificate. This structure is returned in the response to a DescribeCertificate request.

" }, "CertificateStatus":{ "type":"string", "enum":[ "PENDING_VALIDATION", "ISSUED", "INACTIVE", "EXPIRED", "VALIDATION_TIMED_OUT", "REVOKED", "FAILED" ] }, "CertificateStatuses":{ "type":"list", "member":{"shape":"CertificateStatus"} }, "CertificateSummary":{ "type":"structure", "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"

Amazon Resource Name (ARN) of the certificate. This is of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" }, "DomainName":{ "shape":"DomainNameString", "documentation":"

Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.

" } }, "documentation":"

This structure is returned in the response object of ListCertificates action.

" }, "CertificateSummaryList":{ "type":"list", "member":{"shape":"CertificateSummary"} }, "CertificateType":{ "type":"string", "enum":[ "IMPORTED", "AMAZON_ISSUED" ] }, "DeleteCertificateRequest":{ "type":"structure", "required":["CertificateArn"], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"

String that contains the ARN of the ACM Certificate to be deleted. This must be of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" } } }, "DescribeCertificateRequest":{ "type":"structure", "required":["CertificateArn"], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the ACM Certificate. The ARN must have the following form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" } } }, "DescribeCertificateResponse":{ "type":"structure", "members":{ "Certificate":{ "shape":"CertificateDetail", "documentation":"

Metadata about an ACM certificate.

" } } }, "DomainList":{ "type":"list", "member":{"shape":"DomainNameString"}, "max":100, "min":1 }, "DomainNameString":{ "type":"string", "max":253, "min":1, "pattern":"^(\\*\\.)?(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$" }, "DomainStatus":{ "type":"string", "enum":[ "PENDING_VALIDATION", "SUCCESS", "FAILED" ] }, "DomainValidation":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainNameString", "documentation":"

A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.

" }, "ValidationEmails":{ "shape":"ValidationEmailList", "documentation":"

A list of email addresses that ACM used to send domain validation emails.

" }, "ValidationDomain":{ "shape":"DomainNameString", "documentation":"

The domain name that ACM used to send domain validation emails.

" }, "ValidationStatus":{ "shape":"DomainStatus", "documentation":"

The validation status of the domain name.

" } }, "documentation":"

Contains information about the validation of each domain name in the certificate.

" }, "DomainValidationList":{ "type":"list", "member":{"shape":"DomainValidation"}, "max":1000, "min":1 }, "DomainValidationOption":{ "type":"structure", "required":[ "DomainName", "ValidationDomain" ], "members":{ "DomainName":{ "shape":"DomainNameString", "documentation":"

A fully qualified domain name (FQDN) in the certificate request.

" }, "ValidationDomain":{ "shape":"DomainNameString", "documentation":"

The domain name that you want ACM to use to send you validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the DomainName value or a superdomain of the DomainName value. For example, if you request a certificate for testing.example.com, you can specify example.com for this value. In that case, ACM sends domain validation emails to the following five addresses:

  • admin@example.com

  • administrator@example.com

  • hostmaster@example.com

  • postmaster@example.com

  • webmaster@example.com

" } }, "documentation":"

Contains information about the domain names that you want ACM to use to send you emails to validate your ownership of the domain.

" }, "DomainValidationOptionList":{ "type":"list", "member":{"shape":"DomainValidationOption"}, "max":100, "min":1 }, "FailureReason":{ "type":"string", "enum":[ "NO_AVAILABLE_CONTACTS", "ADDITIONAL_VERIFICATION_REQUIRED", "DOMAIN_NOT_ALLOWED", "INVALID_PUBLIC_DOMAIN", "OTHER" ] }, "GetCertificateRequest":{ "type":"structure", "required":["CertificateArn"], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"

String that contains a certificate ARN in the following format:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" } } }, "GetCertificateResponse":{ "type":"structure", "members":{ "Certificate":{ "shape":"CertificateBody", "documentation":"

String that contains the ACM Certificate represented by the ARN specified at input.

" }, "CertificateChain":{ "shape":"CertificateChain", "documentation":"

The certificate chain that contains the root certificate issued by the certificate authority (CA).

" } } }, "IdempotencyToken":{ "type":"string", "max":32, "min":1, "pattern":"\\w+" }, "ImportCertificateRequest":{ "type":"structure", "required":[ "Certificate", "PrivateKey" ], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field.

" }, "Certificate":{ "shape":"CertificateBodyBlob", "documentation":"

The certificate to import. It must meet the following requirements:

  • Must be PEM-encoded.

  • Must contain a 1024-bit or 2048-bit RSA public key.

  • Must be valid at the time of import. You cannot import a certificate before its validity period begins (the certificate's NotBefore date) or after it expires (the certificate's NotAfter date).

" }, "PrivateKey":{ "shape":"PrivateKeyBlob", "documentation":"

The private key that matches the public key in the certificate. It must meet the following requirements:

  • Must be PEM-encoded.

  • Must be unencrypted. You cannot import a private key that is protected by a password or passphrase.

" }, "CertificateChain":{ "shape":"CertificateChainBlob", "documentation":"

The certificate chain. It must be PEM-encoded.

" } } }, "ImportCertificateResponse":{ "type":"structure", "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the imported certificate.

" } } }, "InUseList":{ "type":"list", "member":{"shape":"String"} }, "InvalidArnException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

", "exception":true }, "InvalidDomainValidationOptionsException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

One or more values in the DomainValidationOption structure is incorrect.

", "exception":true }, "InvalidStateException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

Processing has reached an invalid state. For example, this exception can occur if the specified domain is not using email validation, or the current certificate status does not permit the requested operation. See the exception message returned by ACM to determine which state is not valid.

", "exception":true }, "InvalidTagException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with aws:.

", "exception":true }, "KeyAlgorithm":{ "type":"string", "enum":[ "RSA_2048", "RSA_1024", "EC_prime256v1" ] }, "LimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

An ACM limit has been exceeded. For example, you may have input more domains than are allowed or you've requested too many certificates for your account. See the exception message returned by ACM to determine which limit you have violated. For more information about ACM limits, see the Limits topic.

", "exception":true }, "ListCertificatesRequest":{ "type":"structure", "members":{ "CertificateStatuses":{ "shape":"CertificateStatuses", "documentation":"

The status or statuses on which to filter the list of ACM Certificates.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.

" }, "MaxItems":{ "shape":"MaxItems", "documentation":"

Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

" } } }, "ListCertificatesResponse":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.

" }, "CertificateSummaryList":{ "shape":"CertificateSummaryList", "documentation":"

A list of ACM Certificates.

" } } }, "ListTagsForCertificateRequest":{ "type":"structure", "required":["CertificateArn"], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"

String that contains the ARN of the ACM Certificate for which you want to list the tags. This has the following form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" } } }, "ListTagsForCertificateResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"

The key-value pairs that define the applied tags.

" } } }, "MaxItems":{ "type":"integer", "max":1000, "min":1 }, "NextToken":{ "type":"string", "max":320, "min":1, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*" }, "PrivateKeyBlob":{ "type":"blob", "max":524288, "min":1, "sensitive":true }, "RemoveTagsFromCertificateRequest":{ "type":"structure", "required":[ "CertificateArn", "Tags" ], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"

String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" }, "Tags":{ "shape":"TagList", "documentation":"

The key-value pair that defines the tag to remove.

" } } }, "RenewalStatus":{ "type":"string", "enum":[ "PENDING_AUTO_RENEWAL", "PENDING_VALIDATION", "SUCCESS", "FAILED" ] }, "RenewalSummary":{ "type":"structure", "required":[ "RenewalStatus", "DomainValidationOptions" ], "members":{ "RenewalStatus":{ "shape":"RenewalStatus", "documentation":"

The status of ACM's managed renewal of the certificate.

" }, "DomainValidationOptions":{ "shape":"DomainValidationList", "documentation":"

Contains information about the validation of each domain name in the certificate, as it pertains to ACM's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

" } }, "documentation":"

Contains information about the status of ACM's managed renewal for the certificate. This structure exists only when the certificate type is AMAZON_ISSUED.

" }, "RequestCertificateRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainNameString", "documentation":"

Fully qualified domain name (FQDN), such as www.example.com, of the site that you want to secure with an ACM Certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com.

" }, "SubjectAlternativeNames":{ "shape":"DomainList", "documentation":"

Additional FQDNs to be included in the Subject Alternative Name extension of the ACM Certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

Customer chosen string that can be used to distinguish between calls to RequestCertificate. Idempotency tokens time out after one hour. Therefore, if you call RequestCertificate multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates.

" }, "DomainValidationOptions":{ "shape":"DomainValidationOptionList", "documentation":"

The domain name that you want ACM to use to send you emails to validate your ownership of the domain.

" } } }, "RequestCertificateResponse":{ "type":"structure", "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"

String that contains the ARN of the issued certificate. This must be of the form:

arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012

" } } }, "RequestInProgressException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The certificate request is in process and the certificate in your account has not yet been issued.

", "exception":true }, "ResendValidationEmailRequest":{ "type":"structure", "required":[ "CertificateArn", "Domain", "ValidationDomain" ], "members":{ "CertificateArn":{ "shape":"Arn", "documentation":"

String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the RequestCertificate action as soon as the request is made. By default, using this parameter causes email to be sent to all top-level domains you specified in the certificate request.

The ARN must be of the form:

arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012

" }, "Domain":{ "shape":"DomainNameString", "documentation":"

The fully qualified domain name (FQDN) of the certificate that needs to be validated.

" }, "ValidationDomain":{ "shape":"DomainNameString", "documentation":"

The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the Domain value or a superdomain of the Domain value. For example, if you requested a certificate for site.subdomain.example.com and specify a ValidationDomain of subdomain.example.com, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses:

  • admin@subdomain.example.com

  • administrator@subdomain.example.com

  • hostmaster@subdomain.example.com

  • postmaster@subdomain.example.com

  • webmaster@subdomain.example.com

" } } }, "ResourceInUseException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The certificate is in use by another AWS service in the caller's account. Remove the association and try again.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The specified certificate cannot be found in the caller's account, or the caller's account cannot be found.

", "exception":true }, "RevocationReason":{ "type":"string", "enum":[ "UNSPECIFIED", "KEY_COMPROMISE", "CA_COMPROMISE", "AFFILIATION_CHANGED", "SUPERCEDED", "CESSATION_OF_OPERATION", "CERTIFICATE_HOLD", "REMOVE_FROM_CRL", "PRIVILEGE_WITHDRAWN", "A_A_COMPROMISE" ] }, "String":{"type":"string"}, "TStamp":{"type":"timestamp"}, "Tag":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"TagKey", "documentation":"

The key of the tag.

" }, "Value":{ "shape":"TagValue", "documentation":"

The value of the tag.

" } }, "documentation":"

A key-value pair that identifies or specifies metadata about an ACM resource.

" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*" }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":50, "min":1 }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*" }, "TooManyTagsException":{ "type":"structure", "members":{ "message":{"shape":"String"} }, "documentation":"

The request contains too many tags. Try the request again with fewer tags.

", "exception":true }, "ValidationEmailList":{ "type":"list", "member":{"shape":"String"} } }, "documentation":"AWS Certificate Manager

Welcome to the AWS Certificate Manager (ACM) API documentation.

You can use ACM to manage SSL/TLS certificates for your AWS-based websites and applications. For general information about using ACM, see the AWS Certificate Manager User Guide .

" } botocore-1.5.7/botocore/data/clouddirectory/0000777454262600001440000000000013042511307022166 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/clouddirectory/2016-05-10/0000777454262600001440000000000013042511307023216 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/clouddirectory/2016-05-10/service-2.json0000666454262600001440000041566013042511307025724 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-05-10", "endpointPrefix":"clouddirectory", "protocol":"rest-json", "serviceFullName":"Amazon CloudDirectory", "signatureVersion":"v4", "signingName":"clouddirectory", "uid":"clouddirectory-2016-05-10" }, "operations":{ "AddFacetToObject":{ "name":"AddFacetToObject", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/object/facets", "responseCode":200 }, "input":{"shape":"AddFacetToObjectRequest"}, "output":{"shape":"AddFacetToObjectResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetValidationException"} ], "documentation":"

Adds a new Facet to an object.

" }, "ApplySchema":{ "name":"ApplySchema", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/schema/apply", "responseCode":200 }, "input":{"shape":"ApplySchemaRequest"}, "output":{"shape":"ApplySchemaResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidAttachmentException"} ], "documentation":"

Copies input published schema into Directory with same name and version as that of published schema .

" }, "AttachObject":{ "name":"AttachObject", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/object/attach", "responseCode":200 }, "input":{"shape":"AttachObjectRequest"}, "output":{"shape":"AttachObjectResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LinkNameAlreadyInUseException"}, {"shape":"InvalidAttachmentException"}, {"shape":"ValidationException"} ], "documentation":"

Attaches an existing object to another object. An object can be accessed in two ways:

  1. Using the path

  2. Using ObjectIdentifier

" }, "AttachPolicy":{ "name":"AttachPolicy", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/policy/attach", "responseCode":200 }, "input":{"shape":"AttachPolicyRequest"}, "output":{"shape":"AttachPolicyResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"InvalidArnException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotPolicyException"} ], "documentation":"

Attaches a policy object to a regular object. An object can have a limited number of attached policies.

" }, "AttachToIndex":{ "name":"AttachToIndex", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/index/attach", "responseCode":200 }, "input":{"shape":"AttachToIndexRequest"}, "output":{"shape":"AttachToIndexResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LinkNameAlreadyInUseException"}, {"shape":"IndexedAttributeMissingException"}, {"shape":"NotIndexException"} ], "documentation":"

Attaches the specified object to the specified index.

" }, "BatchRead":{ "name":"BatchRead", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/batchread", "responseCode":200 }, "input":{"shape":"BatchReadRequest"}, "output":{"shape":"BatchReadResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"} ], "documentation":"

Performs all the read operations in a batch.

" }, "BatchWrite":{ "name":"BatchWrite", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/batchwrite", "responseCode":200 }, "input":{"shape":"BatchWriteRequest"}, "output":{"shape":"BatchWriteResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"BatchWriteException"} ], "documentation":"

Performs all the write operations in a batch. Either all the operations succeed or none. Batch writes supports only object-related operations.

" }, "CreateDirectory":{ "name":"CreateDirectory", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/directory/create", "responseCode":200 }, "input":{"shape":"CreateDirectoryRequest"}, "output":{"shape":"CreateDirectoryResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryAlreadyExistsException"}, {"shape":"InvalidArnException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.

" }, "CreateFacet":{ "name":"CreateFacet", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/facet/create", "responseCode":200 }, "input":{"shape":"CreateFacetRequest"}, "output":{"shape":"CreateFacetResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetAlreadyExistsException"}, {"shape":"InvalidRuleException"} ], "documentation":"

Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.

" }, "CreateIndex":{ "name":"CreateIndex", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/index", "responseCode":200 }, "input":{"shape":"CreateIndexRequest"}, "output":{"shape":"CreateIndexResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetValidationException"}, {"shape":"LinkNameAlreadyInUseException"}, {"shape":"UnsupportedIndexTypeException"} ], "documentation":"

Creates an index object. See Indexing for more information.

" }, "CreateObject":{ "name":"CreateObject", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/object", "responseCode":200 }, "input":{"shape":"CreateObjectRequest"}, "output":{"shape":"CreateObjectResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"InvalidArnException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetValidationException"}, {"shape":"LinkNameAlreadyInUseException"}, {"shape":"UnsupportedIndexTypeException"} ], "documentation":"

Creates an object in a Directory. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of Facet attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet.

" }, "CreateSchema":{ "name":"CreateSchema", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/schema/create", "responseCode":200 }, "input":{"shape":"CreateSchemaRequest"}, "output":{"shape":"CreateSchemaResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"SchemaAlreadyExistsException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Creates a new schema in a development state. A schema can exist in three phases:

  • Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.

  • Published: Published schemas are immutable and have a version associated with them.

  • Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories.

" }, "DeleteDirectory":{ "name":"DeleteDirectory", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/directory", "responseCode":200 }, "input":{"shape":"DeleteDirectoryRequest"}, "output":{"shape":"DeleteDirectoryResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DirectoryNotDisabledException"}, {"shape":"InternalServiceException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryDeletedException"} ], "documentation":"

Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.

" }, "DeleteFacet":{ "name":"DeleteFacet", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/facet/delete", "responseCode":200 }, "input":{"shape":"DeleteFacetRequest"}, "output":{"shape":"DeleteFacetResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetNotFoundException"}, {"shape":"FacetInUseException"} ], "documentation":"

Deletes a given Facet. All attributes and Rules associated with the facet will be deleted. Only development schema facets are allowed deletion.

" }, "DeleteObject":{ "name":"DeleteObject", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/object/delete", "responseCode":200 }, "input":{"shape":"DeleteObjectRequest"}, "output":{"shape":"DeleteObjectResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ObjectNotDetachedException"} ], "documentation":"

Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted.

" }, "DeleteSchema":{ "name":"DeleteSchema", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/schema", "responseCode":200 }, "input":{"shape":"DeleteSchemaRequest"}, "output":{"shape":"DeleteSchemaResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"StillContainsLinksException"} ], "documentation":"

Deletes a given schema. Schemas in a development and published state can only be deleted.

" }, "DetachFromIndex":{ "name":"DetachFromIndex", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/index/detach", "responseCode":200 }, "input":{"shape":"DetachFromIndexRequest"}, "output":{"shape":"DetachFromIndexResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ObjectAlreadyDetachedException"}, {"shape":"NotIndexException"} ], "documentation":"

Detaches the specified object from the specified index.

" }, "DetachObject":{ "name":"DetachObject", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/object/detach", "responseCode":200 }, "input":{"shape":"DetachObjectRequest"}, "output":{"shape":"DetachObjectResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.

" }, "DetachPolicy":{ "name":"DetachPolicy", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/policy/detach", "responseCode":200 }, "input":{"shape":"DetachPolicyRequest"}, "output":{"shape":"DetachPolicyResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"InvalidArnException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotPolicyException"} ], "documentation":"

Detaches a policy from an object.

" }, "DisableDirectory":{ "name":"DisableDirectory", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/directory/disable", "responseCode":200 }, "input":{"shape":"DisableDirectoryRequest"}, "output":{"shape":"DisableDirectoryResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DirectoryDeletedException"}, {"shape":"InternalServiceException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.

" }, "EnableDirectory":{ "name":"EnableDirectory", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/directory/enable", "responseCode":200 }, "input":{"shape":"EnableDirectoryRequest"}, "output":{"shape":"EnableDirectoryResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"DirectoryDeletedException"}, {"shape":"InternalServiceException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.

" }, "GetDirectory":{ "name":"GetDirectory", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/directory/get", "responseCode":200 }, "input":{"shape":"GetDirectoryRequest"}, "output":{"shape":"GetDirectoryResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Retrieves metadata about a directory.

" }, "GetFacet":{ "name":"GetFacet", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/facet", "responseCode":200 }, "input":{"shape":"GetFacetRequest"}, "output":{"shape":"GetFacetResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetNotFoundException"} ], "documentation":"

Gets details of the Facet, such as Facet Name, Attributes, Rules, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied.

" }, "GetObjectInformation":{ "name":"GetObjectInformation", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/object/information", "responseCode":200 }, "input":{"shape":"GetObjectInformationRequest"}, "output":{"shape":"GetObjectInformationResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves metadata about an object.

" }, "GetSchemaAsJson":{ "name":"GetSchemaAsJson", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/schema/json", "responseCode":200 }, "input":{"shape":"GetSchemaAsJsonRequest"}, "output":{"shape":"GetSchemaAsJsonResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Retrieves a JSON representation of the schema. See JSON Schema Format for more information.

" }, "ListAppliedSchemaArns":{ "name":"ListAppliedSchemaArns", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/schema/applied", "responseCode":200 }, "input":{"shape":"ListAppliedSchemaArnsRequest"}, "output":{"shape":"ListAppliedSchemaArnsResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Lists schemas applied to a directory.

" }, "ListAttachedIndices":{ "name":"ListAttachedIndices", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/object/indices", "responseCode":200 }, "input":{"shape":"ListAttachedIndicesRequest"}, "output":{"shape":"ListAttachedIndicesResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists indices attached to an object.

" }, "ListDevelopmentSchemaArns":{ "name":"ListDevelopmentSchemaArns", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/schema/development", "responseCode":200 }, "input":{"shape":"ListDevelopmentSchemaArnsRequest"}, "output":{"shape":"ListDevelopmentSchemaArnsResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Retrieves the ARNs of schemas in the development state.

" }, "ListDirectories":{ "name":"ListDirectories", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/directory/list", "responseCode":200 }, "input":{"shape":"ListDirectoriesRequest"}, "output":{"shape":"ListDirectoriesResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Lists directories created within an account.

" }, "ListFacetAttributes":{ "name":"ListFacetAttributes", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/facet/attributes", "responseCode":200 }, "input":{"shape":"ListFacetAttributesRequest"}, "output":{"shape":"ListFacetAttributesResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetNotFoundException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Retrieves attributes attached to the facet.

" }, "ListFacetNames":{ "name":"ListFacetNames", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/facet/list", "responseCode":200 }, "input":{"shape":"ListFacetNamesRequest"}, "output":{"shape":"ListFacetNamesResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Retrieves the names of facets that exist in a schema.

" }, "ListIndex":{ "name":"ListIndex", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/index/targets", "responseCode":200 }, "input":{"shape":"ListIndexRequest"}, "output":{"shape":"ListIndexResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotIndexException"} ], "documentation":"

Lists objects attached to the specified index.

" }, "ListObjectAttributes":{ "name":"ListObjectAttributes", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/object/attributes", "responseCode":200 }, "input":{"shape":"ListObjectAttributesRequest"}, "output":{"shape":"ListObjectAttributesResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"InvalidArnException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Lists all attributes associated with an object. This also supports common namespace prefix (key) listing. For example, if you want to retrieve all attributes associated with facet1, key can be facet1. If key is empty, all attributes are returned in a paginated list.

" }, "ListObjectChildren":{ "name":"ListObjectChildren", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/object/children", "responseCode":200 }, "input":{"shape":"ListObjectChildrenRequest"}, "output":{"shape":"ListObjectChildrenResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"InvalidArnException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"}, {"shape":"NotNodeException"} ], "documentation":"

Returns a paginated list of child objects associated with a given object.

" }, "ListObjectParents":{ "name":"ListObjectParents", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/object/parent", "responseCode":200 }, "input":{"shape":"ListObjectParentsRequest"}, "output":{"shape":"ListObjectParentsResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"InvalidArnException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"}, {"shape":"CannotListParentOfRootException"} ], "documentation":"

Lists parent objects associated with a given object in pagination fashion.

" }, "ListObjectPolicies":{ "name":"ListObjectPolicies", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/object/policy", "responseCode":200 }, "input":{"shape":"ListObjectPoliciesRequest"}, "output":{"shape":"ListObjectPoliciesResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Returns policies attached to an object in pagination fashion.

" }, "ListPolicyAttachments":{ "name":"ListPolicyAttachments", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/policy/attachment", "responseCode":200 }, "input":{"shape":"ListPolicyAttachmentsRequest"}, "output":{"shape":"ListPolicyAttachmentsResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"InvalidArnException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ResourceNotFoundException"}, {"shape":"NotPolicyException"} ], "documentation":"

Returns all of the ObjectIdentifiers to which a given policy is attached.

" }, "ListPublishedSchemaArns":{ "name":"ListPublishedSchemaArns", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/schema/published", "responseCode":200 }, "input":{"shape":"ListPublishedSchemaArnsRequest"}, "output":{"shape":"ListPublishedSchemaArnsResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Retrieves published schema ARNs.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/tags", "responseCode":200 }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidTaggingRequestException"} ], "documentation":"

Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.

" }, "LookupPolicy":{ "name":"LookupPolicy", "http":{ "method":"POST", "requestUri":"/amazonclouddirectory/2017-01-11/policy/lookup", "responseCode":200 }, "input":{"shape":"LookupPolicyRequest"}, "output":{"shape":"LookupPolicyResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"InvalidArnException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the objectIdentifier for such objects. If policies are present, it returns objectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored.

" }, "PublishSchema":{ "name":"PublishSchema", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/schema/publish", "responseCode":200 }, "input":{"shape":"PublishSchemaRequest"}, "output":{"shape":"PublishSchemaResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"SchemaAlreadyPublishedException"} ], "documentation":"

Publishes a development schema with a version. If description and attributes are specified, PublishSchema overrides the development schema description and attributes. If not, the development schema description and attributes are used.

" }, "PutSchemaFromJson":{ "name":"PutSchemaFromJson", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/schema/json", "responseCode":200 }, "input":{"shape":"PutSchemaFromJsonRequest"}, "output":{"shape":"PutSchemaFromJsonResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidSchemaDocException"}, {"shape":"InvalidRuleException"} ], "documentation":"

Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.

" }, "RemoveFacetFromObject":{ "name":"RemoveFacetFromObject", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/object/facets/delete", "responseCode":200 }, "input":{"shape":"RemoveFacetFromObjectRequest"}, "output":{"shape":"RemoveFacetFromObjectResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetValidationException"} ], "documentation":"

Removes the specified facet from the specified object.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/tags/add", "responseCode":200 }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidTaggingRequestException"} ], "documentation":"

API for adding tags to a resource.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/tags/remove", "responseCode":200 }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidTaggingRequestException"} ], "documentation":"

API for removing tags from a resource.

" }, "UpdateFacet":{ "name":"UpdateFacet", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/facet", "responseCode":200 }, "input":{"shape":"UpdateFacetRequest"}, "output":{"shape":"UpdateFacetResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"InvalidFacetUpdateException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetNotFoundException"}, {"shape":"InvalidRuleException"} ], "documentation":"

Does the following:

  1. Adds new Attributes, Rules, or ObjectTypes.

  2. Updates existing Attributes, Rules, or ObjectTypes.

  3. Deletes existing Attributes, Rules, or ObjectTypes.

" }, "UpdateObjectAttributes":{ "name":"UpdateObjectAttributes", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/object/update", "responseCode":200 }, "input":{"shape":"UpdateObjectAttributesRequest"}, "output":{"shape":"UpdateObjectAttributesResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"DirectoryNotEnabledException"}, {"shape":"ResourceNotFoundException"}, {"shape":"FacetValidationException"} ], "documentation":"

Updates a given object's attributes.

" }, "UpdateSchema":{ "name":"UpdateSchema", "http":{ "method":"PUT", "requestUri":"/amazonclouddirectory/2017-01-11/schema/update", "responseCode":200 }, "input":{"shape":"UpdateSchemaRequest"}, "output":{"shape":"UpdateSchemaResponse"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidArnException"}, {"shape":"RetryableConflictException"}, {"shape":"ValidationException"}, {"shape":"LimitExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates the schema name with a new name. Only development schema names can be updated.

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Access denied. Check your permissions.

", "error":{"httpStatusCode":403}, "exception":true }, "AddFacetToObjectRequest":{ "type":"structure", "required":[ "DirectoryArn", "SchemaFacet", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory where the object resides. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "SchemaFacet":{ "shape":"SchemaFacet", "documentation":"

Identifiers for the facet that you are adding to the object.

" }, "ObjectAttributeList":{ "shape":"AttributeKeyAndValueList", "documentation":"

Attributes on the facet you are adding to the object.

" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object you are adding the specified facet to.

" } } }, "AddFacetToObjectResponse":{ "type":"structure", "members":{ } }, "ApplySchemaRequest":{ "type":"structure", "required":[ "PublishedSchemaArn", "DirectoryArn" ], "members":{ "PublishedSchemaArn":{ "shape":"Arn", "documentation":"

Published schema ARN that needs to be copied. For more information, see arns.

" }, "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory into which the schema is copied. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" } } }, "ApplySchemaResponse":{ "type":"structure", "members":{ "AppliedSchemaArn":{ "shape":"Arn", "documentation":"

Applied schema ARN associated with the copied schema in the Directory. You can use this ARN to describe the schema information applied on this directory. For more information, see arns.

" }, "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory. For more information, see arns.

" } } }, "Arn":{"type":"string"}, "Arns":{ "type":"list", "member":{"shape":"Arn"} }, "AttachObjectRequest":{ "type":"structure", "required":[ "DirectoryArn", "ParentReference", "ChildReference", "LinkName" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory where both objects reside. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ParentReference":{ "shape":"ObjectReference", "documentation":"

Parent object reference.

" }, "ChildReference":{ "shape":"ObjectReference", "documentation":"

Child object reference to be attached to the object.

" }, "LinkName":{ "shape":"LinkName", "documentation":"

Link name with which the child object is attached to the parent.

" } } }, "AttachObjectResponse":{ "type":"structure", "members":{ "AttachedObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

Attached ObjectIdentifier, which is the child ObjectIdentifier.

" } } }, "AttachPolicyRequest":{ "type":"structure", "required":[ "PolicyReference", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory where both objects reside. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "PolicyReference":{ "shape":"ObjectReference", "documentation":"

Reference associated with the policy object.

" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object to which the policy will be attached.

" } } }, "AttachPolicyResponse":{ "type":"structure", "members":{ } }, "AttachToIndexRequest":{ "type":"structure", "required":[ "DirectoryArn", "IndexReference", "TargetReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory where the object and index exist.

", "location":"header", "locationName":"x-amz-data-partition" }, "IndexReference":{ "shape":"ObjectReference", "documentation":"

A reference to the index that you are attaching the object to.

" }, "TargetReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object that you are attaching to the index.

" } } }, "AttachToIndexResponse":{ "type":"structure", "members":{ "AttachedObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the object that was attached to the index.

" } } }, "AttributeKey":{ "type":"structure", "required":[ "SchemaArn", "FacetName", "Name" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The ARN of the schema that contains the facet and attribute.

" }, "FacetName":{ "shape":"FacetName", "documentation":"

The name of the facet the attribute exists within.

" }, "Name":{ "shape":"AttributeName", "documentation":"

The name of the attribute.

" } }, "documentation":"

A unique identifier for an attribute.

" }, "AttributeKeyAndValue":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"AttributeKey", "documentation":"

The key of the attribute.

" }, "Value":{ "shape":"TypedAttributeValue", "documentation":"

The value of the attribute.

" } }, "documentation":"

The combination of an attribute key and an attribute value.

" }, "AttributeKeyAndValueList":{ "type":"list", "member":{"shape":"AttributeKeyAndValue"} }, "AttributeKeyList":{ "type":"list", "member":{"shape":"AttributeKey"} }, "AttributeName":{ "type":"string", "max":64, "min":1, "pattern":"^[a-zA-Z0-9._-]*$" }, "BatchAddFacetToObject":{ "type":"structure", "required":[ "SchemaFacet", "ObjectAttributeList", "ObjectReference" ], "members":{ "SchemaFacet":{ "shape":"SchemaFacet", "documentation":"

Represents the facet being added to the object.

" }, "ObjectAttributeList":{ "shape":"AttributeKeyAndValueList", "documentation":"

The attributes to set on the object.

" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object being mutated.

" } }, "documentation":"

Represents the output of a batch add facet to object operation.

" }, "BatchAddFacetToObjectResponse":{ "type":"structure", "members":{ }, "documentation":"

The result of a batch add facet to object operation.

" }, "BatchAttachObject":{ "type":"structure", "required":[ "ParentReference", "ChildReference", "LinkName" ], "members":{ "ParentReference":{ "shape":"ObjectReference", "documentation":"

Parent object reference.

" }, "ChildReference":{ "shape":"ObjectReference", "documentation":"

Child object reference to be attached to the object.

" }, "LinkName":{ "shape":"LinkName", "documentation":"

The name of the link.

" } }, "documentation":"

Represents the output of an AttachObject operation.

" }, "BatchAttachObjectResponse":{ "type":"structure", "members":{ "attachedObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the object that has been attached.

" } }, "documentation":"

Represents the output batch AttachObject response operation.

" }, "BatchCreateObject":{ "type":"structure", "required":[ "SchemaFacet", "ObjectAttributeList", "ParentReference", "LinkName", "BatchReferenceName" ], "members":{ "SchemaFacet":{ "shape":"SchemaFacetList", "documentation":"

List of FacetArns that will be associated with the object. For more information, see arns.

" }, "ObjectAttributeList":{ "shape":"AttributeKeyAndValueList", "documentation":"

Attribute map, which contains an attribute ARN as the key and attribute value as the map value.

" }, "ParentReference":{ "shape":"ObjectReference", "documentation":"

If specified, the parent reference to which this object will be attached.

" }, "LinkName":{ "shape":"LinkName", "documentation":"

The name of the link.

" }, "BatchReferenceName":{ "shape":"BatchReferenceName", "documentation":"

The batch reference name. See Batches for more information.

" } }, "documentation":"

Represents the output of a CreateObject operation.

" }, "BatchCreateObjectResponse":{ "type":"structure", "members":{ "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

ID associated with the object.

" } }, "documentation":"

Represents the output of a CreateObject response operation.

" }, "BatchDeleteObject":{ "type":"structure", "required":["ObjectReference"], "members":{ "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object.

" } }, "documentation":"

Represents the output of a DeleteObject operation.

" }, "BatchDeleteObjectResponse":{ "type":"structure", "members":{ }, "documentation":"

Represents the output of a DeleteObject response operation.

" }, "BatchDetachObject":{ "type":"structure", "required":[ "ParentReference", "LinkName", "BatchReferenceName" ], "members":{ "ParentReference":{ "shape":"ObjectReference", "documentation":"

Parent reference from which the object with the specified link name is detached.

" }, "LinkName":{ "shape":"LinkName", "documentation":"

The name of the link.

" }, "BatchReferenceName":{ "shape":"BatchReferenceName", "documentation":"

The batch reference name. See Batches for more information.

" } }, "documentation":"

Represents the output of a DetachObject operation.

" }, "BatchDetachObjectResponse":{ "type":"structure", "members":{ "detachedObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the detached object.

" } }, "documentation":"

Represents the output of a DetachObject response operation.

" }, "BatchListObjectAttributes":{ "type":"structure", "required":["ObjectReference"], "members":{ "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference of the object whose attributes need to be listed.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token used for pagination.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

Maximum number of items to be retrieved in a single call. This is an approximate number.

" } }, "documentation":"

Represents the output of a ListObjectAttributes operation.

" }, "BatchListObjectAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"AttributeKeyAndValueList", "documentation":"

Attributes map associated with the object. AttributeArn is the key; attribute value is the value.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token used for pagination.

" } }, "documentation":"

Represents the output of a ListObjectAttributes response operation.

" }, "BatchListObjectChildren":{ "type":"structure", "required":["ObjectReference"], "members":{ "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference of the object for which child objects are being listed.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token used for pagination.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

Maximum number of items to be retrieved in a single call. This is an approximate number.

" } }, "documentation":"

Represents the output of a ListObjectChildren operation.

" }, "BatchListObjectChildrenResponse":{ "type":"structure", "members":{ "Children":{ "shape":"LinkNameToObjectIdentifierMap", "documentation":"

Children structure, which is a map with key as the LinkName and ObjectIdentifier as the value.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token used for pagination.

" } }, "documentation":"

Represents the output of a ListObjectChildren response operation.

" }, "BatchOperationIndex":{"type":"integer"}, "BatchReadException":{ "type":"structure", "members":{ "Type":{ "shape":"BatchReadExceptionType", "documentation":"

Type of exception, such as InvalidArnException.

" }, "Message":{ "shape":"ExceptionMessage", "documentation":"

Exception message associated with the failure.

" } }, "documentation":"

Batch Read Exception structure, which contains exception type and message.

" }, "BatchReadExceptionType":{ "type":"string", "enum":[ "ValidationException", "InvalidArnException", "ResourceNotFoundException", "InvalidNextTokenException", "AccessDeniedException", "NotNodeException" ] }, "BatchReadOperation":{ "type":"structure", "members":{ "ListObjectAttributes":{ "shape":"BatchListObjectAttributes", "documentation":"

Lists all attributes associated with an object.

" }, "ListObjectChildren":{ "shape":"BatchListObjectChildren", "documentation":"

Returns a paginated list of child objects that are associated with a given object.

" } }, "documentation":"

Represents the output of a BatchRead operation.

" }, "BatchReadOperationList":{ "type":"list", "member":{"shape":"BatchReadOperation"} }, "BatchReadOperationResponse":{ "type":"structure", "members":{ "SuccessfulResponse":{ "shape":"BatchReadSuccessfulResponse", "documentation":"

Identifies which operation in a batch has succeeded.

" }, "ExceptionResponse":{ "shape":"BatchReadException", "documentation":"

Identifies which operation in a batch has failed.

" } }, "documentation":"

Represents the output of a BatchRead response operation.

" }, "BatchReadOperationResponseList":{ "type":"list", "member":{"shape":"BatchReadOperationResponse"} }, "BatchReadRequest":{ "type":"structure", "required":[ "DirectoryArn", "Operations" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Operations":{ "shape":"BatchReadOperationList", "documentation":"

List of operations that are part of the batch.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "BatchReadResponse":{ "type":"structure", "members":{ "Responses":{ "shape":"BatchReadOperationResponseList", "documentation":"

List of all the responses for each batch read.

" } } }, "BatchReadSuccessfulResponse":{ "type":"structure", "members":{ "ListObjectAttributes":{ "shape":"BatchListObjectAttributesResponse", "documentation":"

Lists all attributes associated with an object.

" }, "ListObjectChildren":{ "shape":"BatchListObjectChildrenResponse", "documentation":"

Returns a paginated list of child objects associated with a given object.

" } }, "documentation":"

Represents the output of a BatchRead success response operation.

" }, "BatchReferenceName":{"type":"string"}, "BatchRemoveFacetFromObject":{ "type":"structure", "required":[ "SchemaFacet", "ObjectReference" ], "members":{ "SchemaFacet":{ "shape":"SchemaFacet", "documentation":"

The facet to remove from the object.

" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object whose facet will be removed.

" } }, "documentation":"

Batch operation to remove a facet from an object.

" }, "BatchRemoveFacetFromObjectResponse":{ "type":"structure", "members":{ }, "documentation":"

Empty result representing success.

" }, "BatchUpdateObjectAttributes":{ "type":"structure", "required":[ "ObjectReference", "AttributeUpdates" ], "members":{ "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object.

" }, "AttributeUpdates":{ "shape":"ObjectAttributeUpdateList", "documentation":"

Attributes update structure.

" } }, "documentation":"

Represents the output of a BatchUpdate operation.

" }, "BatchUpdateObjectAttributesResponse":{ "type":"structure", "members":{ "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

ID associated with the object.

" } }, "documentation":"

Represents the output of a BatchUpdate response operation.

" }, "BatchWriteException":{ "type":"structure", "members":{ "Index":{"shape":"BatchOperationIndex"}, "Type":{"shape":"BatchWriteExceptionType"}, "Message":{"shape":"ExceptionMessage"} }, "documentation":"

A BatchWrite exception has occurred.

", "exception":true }, "BatchWriteExceptionType":{ "type":"string", "enum":[ "InternalServiceException", "ValidationException", "InvalidArnException", "LinkNameAlreadyInUseException", "StillContainsLinksException", "FacetValidationException", "ObjectNotDetachedException", "ResourceNotFoundException", "AccessDeniedException" ] }, "BatchWriteOperation":{ "type":"structure", "members":{ "CreateObject":{ "shape":"BatchCreateObject", "documentation":"

Creates an object.

" }, "AttachObject":{ "shape":"BatchAttachObject", "documentation":"

Attaches an object to a Directory.

" }, "DetachObject":{ "shape":"BatchDetachObject", "documentation":"

Detaches an object from a Directory.

" }, "UpdateObjectAttributes":{ "shape":"BatchUpdateObjectAttributes", "documentation":"

Update a given object's attributes.

" }, "DeleteObject":{ "shape":"BatchDeleteObject", "documentation":"

Deletes an object in a Directory.

" }, "AddFacetToObject":{ "shape":"BatchAddFacetToObject", "documentation":"

Batch operation adding a facet to an object.

" }, "RemoveFacetFromObject":{ "shape":"BatchRemoveFacetFromObject", "documentation":"

Batch operation removing a facet from an object.

" } }, "documentation":"

Represents the output of a BatchWrite operation.

" }, "BatchWriteOperationList":{ "type":"list", "member":{"shape":"BatchWriteOperation"} }, "BatchWriteOperationResponse":{ "type":"structure", "members":{ "CreateObject":{ "shape":"BatchCreateObjectResponse", "documentation":"

Creates an object in a Directory.

" }, "AttachObject":{ "shape":"BatchAttachObjectResponse", "documentation":"

Attaches an object to a Directory.

" }, "DetachObject":{ "shape":"BatchDetachObjectResponse", "documentation":"

Detaches an object from a Directory.

" }, "UpdateObjectAttributes":{ "shape":"BatchUpdateObjectAttributesResponse", "documentation":"

Updates a given object’s attributes.

" }, "DeleteObject":{ "shape":"BatchDeleteObjectResponse", "documentation":"

Deletes an object in a Directory.

" }, "AddFacetToObject":{ "shape":"BatchAddFacetToObjectResponse", "documentation":"

Result of an add facet to object batch operation.

" }, "RemoveFacetFromObject":{ "shape":"BatchRemoveFacetFromObjectResponse", "documentation":"

Result of a batch remove facet from object operation.

" } }, "documentation":"

Represents the output of a BatchWrite response operation.

" }, "BatchWriteOperationResponseList":{ "type":"list", "member":{"shape":"BatchWriteOperationResponse"} }, "BatchWriteRequest":{ "type":"structure", "required":[ "DirectoryArn", "Operations" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Operations":{ "shape":"BatchWriteOperationList", "documentation":"

List of operations that are part of the batch.

" } } }, "BatchWriteResponse":{ "type":"structure", "members":{ "Responses":{ "shape":"BatchWriteOperationResponseList", "documentation":"

List of all the responses for each batch write.

" } } }, "BinaryAttributeValue":{"type":"blob"}, "Bool":{"type":"boolean"}, "BooleanAttributeValue":{"type":"boolean"}, "CannotListParentOfRootException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Cannot list the parents of a Directory root.

", "error":{"httpStatusCode":400}, "exception":true }, "ConsistencyLevel":{ "type":"string", "enum":[ "SERIALIZABLE", "EVENTUAL" ] }, "CreateDirectoryRequest":{ "type":"structure", "required":[ "Name", "SchemaArn" ], "members":{ "Name":{ "shape":"DirectoryName", "documentation":"

Name of the Directory. Should be unique per account, per region.

" }, "SchemaArn":{ "shape":"Arn", "documentation":"

ARN of the published schema that will be copied into the data Directory. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" } } }, "CreateDirectoryResponse":{ "type":"structure", "required":[ "DirectoryArn", "Name", "ObjectIdentifier", "AppliedSchemaArn" ], "members":{ "DirectoryArn":{ "shape":"DirectoryArn", "documentation":"

ARN associated with the Directory. For more information, see arns.

" }, "Name":{ "shape":"DirectoryName", "documentation":"

Name of the Directory.

" }, "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The root object node of the created directory.

" }, "AppliedSchemaArn":{ "shape":"Arn", "documentation":"

ARN of the published schema in the Directory. Once a published schema is copied into the directory, it has its own ARN which is referred to applied schema ARN. For more information, see arns.

" } } }, "CreateFacetRequest":{ "type":"structure", "required":[ "SchemaArn", "Name", "ObjectType" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

Schema ARN in which the new Facet will be created. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Name":{ "shape":"FacetName", "documentation":"

Name of the Facet, which is unique for a given schema.

" }, "Attributes":{ "shape":"FacetAttributeList", "documentation":"

Attributes associated with the Facet.e

" }, "ObjectType":{ "shape":"ObjectType", "documentation":"

Specifies whether a given object created from this facet is of type Node, Leaf Node, Policy or Index.

  • Node: Can have multiple children but one parent.

  • Leaf Node: Cannot have children but can have multiple parents.

  • Policy: Allows you to store a policy document and policy type. For more information, see Policies.

  • Index: Can be created with the Index API.

" } } }, "CreateFacetResponse":{ "type":"structure", "members":{ } }, "CreateIndexRequest":{ "type":"structure", "required":[ "DirectoryArn", "OrderedIndexedAttributeList", "IsUnique" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory where the index should be created.

", "location":"header", "locationName":"x-amz-data-partition" }, "OrderedIndexedAttributeList":{ "shape":"AttributeKeyList", "documentation":"

Specifies the Attributes that should be indexed on. Currently only a single attribute is supported.

" }, "IsUnique":{ "shape":"Bool", "documentation":"

Indicates whether objects with the same indexed attribute value can be added to the index.

" }, "ParentReference":{ "shape":"ObjectReference", "documentation":"

A reference to the parent object that contains the index object.

" }, "LinkName":{ "shape":"LinkName", "documentation":"

The name of the link between the parent object and the index object.

" } } }, "CreateIndexResponse":{ "type":"structure", "members":{ "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the index created by this operation.

" } } }, "CreateObjectRequest":{ "type":"structure", "required":[ "DirectoryArn", "SchemaFacets" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory in which the object will be created. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "SchemaFacets":{ "shape":"SchemaFacetList", "documentation":"

List of facet ARNs to be associated with the object. For more information, see arns.

" }, "ObjectAttributeList":{ "shape":"AttributeKeyAndValueList", "documentation":"

Attribute map whose attribute ARN contains the key and attribute value as the map value.

" }, "ParentReference":{ "shape":"ObjectReference", "documentation":"

If specified, the parent reference to which this object will be attached.

" }, "LinkName":{ "shape":"LinkName", "documentation":"

The name of link that is used to attach this object to a parent.

" } } }, "CreateObjectResponse":{ "type":"structure", "members":{ "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

Identifier associated with the object.

" } } }, "CreateSchemaRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"SchemaName", "documentation":"

Name associated with the schema. This is unique to each account and in each region.

" } } }, "CreateSchemaResponse":{ "type":"structure", "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

ARN associated with the schema. For more information, see arns.

" } } }, "Date":{"type":"timestamp"}, "DatetimeAttributeValue":{"type":"timestamp"}, "DeleteDirectoryRequest":{ "type":"structure", "required":["DirectoryArn"], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory to delete.

", "location":"header", "locationName":"x-amz-data-partition" } } }, "DeleteDirectoryResponse":{ "type":"structure", "required":["DirectoryArn"], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the deleted directory.

" } } }, "DeleteFacetRequest":{ "type":"structure", "required":[ "SchemaArn", "Name" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

ARN associated with the Facet. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Name":{ "shape":"FacetName", "documentation":"

The name of the facet to delete.

" } } }, "DeleteFacetResponse":{ "type":"structure", "members":{ } }, "DeleteObjectRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory where the object resides. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object.

" } } }, "DeleteObjectResponse":{ "type":"structure", "members":{ } }, "DeleteSchemaRequest":{ "type":"structure", "required":["SchemaArn"], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

ARN of the development schema. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" } } }, "DeleteSchemaResponse":{ "type":"structure", "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

Input ARN that is returned as part of the response. For more information, see arns.

" } } }, "DetachFromIndexRequest":{ "type":"structure", "required":[ "DirectoryArn", "IndexReference", "TargetReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory the index and object exist in.

", "location":"header", "locationName":"x-amz-data-partition" }, "IndexReference":{ "shape":"ObjectReference", "documentation":"

A reference to the index object.

" }, "TargetReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object being detached from the index.

" } } }, "DetachFromIndexResponse":{ "type":"structure", "members":{ "DetachedObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the object that was detached from the index.

" } } }, "DetachObjectRequest":{ "type":"structure", "required":[ "DirectoryArn", "ParentReference", "LinkName" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory where objects reside. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ParentReference":{ "shape":"ObjectReference", "documentation":"

Parent reference from which the object with the specified link name is detached.

" }, "LinkName":{ "shape":"LinkName", "documentation":"

Link name associated with the object that needs to be detached.

" } } }, "DetachObjectResponse":{ "type":"structure", "members":{ "DetachedObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier that was detached from the object.

" } } }, "DetachPolicyRequest":{ "type":"structure", "required":[ "DirectoryArn", "PolicyReference", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory where both objects reside. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "PolicyReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the policy object.

" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object whose policy object will be detached.

" } } }, "DetachPolicyResponse":{ "type":"structure", "members":{ } }, "Directory":{ "type":"structure", "members":{ "Name":{ "shape":"DirectoryName", "documentation":"

The name of the directory.

" }, "DirectoryArn":{ "shape":"DirectoryArn", "documentation":"

ARN associated with the directory. For more information, see arns.

" }, "State":{ "shape":"DirectoryState", "documentation":"

The state of the directory. Can be either Enabled, Disabled, or Deleted.

" }, "CreationDateTime":{ "shape":"Date", "documentation":"

The date and time when the directory was created.

" } }, "documentation":"

Directory structure that includes the directory name and directory ARN.

" }, "DirectoryAlreadyExistsException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that a Directory could not be created due to a naming conflict. Choose a different name and try again.

", "error":{"httpStatusCode":400}, "exception":true }, "DirectoryArn":{"type":"string"}, "DirectoryDeletedException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

A directory that has been deleted has been attempted to be accessed. Note: The requested resource will eventually cease to exist.

", "error":{"httpStatusCode":400}, "exception":true }, "DirectoryList":{ "type":"list", "member":{"shape":"Directory"} }, "DirectoryName":{ "type":"string", "max":64, "min":1, "pattern":"^[a-zA-Z0-9._-]*$" }, "DirectoryNotDisabledException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

An operation can only operate on a disabled directory.

", "error":{"httpStatusCode":400}, "exception":true }, "DirectoryNotEnabledException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

An operation can only operate on a directory that is not enabled.

", "error":{"httpStatusCode":400}, "exception":true }, "DirectoryState":{ "type":"string", "enum":[ "ENABLED", "DISABLED", "DELETED" ] }, "DisableDirectoryRequest":{ "type":"structure", "required":["DirectoryArn"], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory to disable.

", "location":"header", "locationName":"x-amz-data-partition" } } }, "DisableDirectoryResponse":{ "type":"structure", "required":["DirectoryArn"], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory that has been disabled.

" } } }, "EnableDirectoryRequest":{ "type":"structure", "required":["DirectoryArn"], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory to enable.

", "location":"header", "locationName":"x-amz-data-partition" } } }, "EnableDirectoryResponse":{ "type":"structure", "required":["DirectoryArn"], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the enabled directory.

" } } }, "ExceptionMessage":{"type":"string"}, "Facet":{ "type":"structure", "members":{ "Name":{ "shape":"FacetName", "documentation":"

The name of the Facet.

" }, "ObjectType":{ "shape":"ObjectType", "documentation":"

Object type associated with the facet. See CreateFacetRequest$ObjectType for more details.

" } }, "documentation":"

A structure that contains Name, ARN, Attributes, Rules, and ObjectTypes.

" }, "FacetAlreadyExistsException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

A facet with the same name already exists.

", "error":{"httpStatusCode":400}, "exception":true }, "FacetAttribute":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"AttributeName", "documentation":"

The name of the facet attribute.

" }, "AttributeDefinition":{ "shape":"FacetAttributeDefinition", "documentation":"

A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See Attribute References for more information.

" }, "AttributeReference":{ "shape":"FacetAttributeReference", "documentation":"

Attribute reference associated with the attribute. See Attribute References for more information.

" }, "RequiredBehavior":{ "shape":"RequiredAttributeBehavior", "documentation":"

The required behavior of the FacetAttribute.

" } }, "documentation":"

Attribute associated with the Facet.

" }, "FacetAttributeDefinition":{ "type":"structure", "required":["Type"], "members":{ "Type":{ "shape":"FacetAttributeType", "documentation":"

The type of the attribute.

" }, "DefaultValue":{ "shape":"TypedAttributeValue", "documentation":"

The default value of the attribute (if configured).

" }, "IsImmutable":{ "shape":"Bool", "documentation":"

Whether the attribute is mutable or not.

" }, "Rules":{ "shape":"RuleMap", "documentation":"

Validation rules attached to the attribute definition.

" } }, "documentation":"

A facet attribute definition. See Attribute References for more information.

" }, "FacetAttributeList":{ "type":"list", "member":{"shape":"FacetAttribute"} }, "FacetAttributeReference":{ "type":"structure", "required":[ "TargetFacetName", "TargetAttributeName" ], "members":{ "TargetFacetName":{ "shape":"FacetName", "documentation":"

Target facet name associated with the facet reference. See Attribute References for more information.

" }, "TargetAttributeName":{ "shape":"AttributeName", "documentation":"

Target attribute name associated with the facet reference. See Attribute References for more information.

" } }, "documentation":"

Facet attribute reference that specifies the attribute definition which contains attribute facet name and attribute name.

" }, "FacetAttributeType":{ "type":"string", "enum":[ "STRING", "BINARY", "BOOLEAN", "NUMBER", "DATETIME" ] }, "FacetAttributeUpdate":{ "type":"structure", "members":{ "Attribute":{ "shape":"FacetAttribute", "documentation":"

The attribute to update.

" }, "Action":{ "shape":"UpdateActionType", "documentation":"

The action to perform when updating the attribute.

" } }, "documentation":"

A structure that contains information used to update an attribute.

" }, "FacetAttributeUpdateList":{ "type":"list", "member":{"shape":"FacetAttributeUpdate"} }, "FacetInUseException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Occurs when deleting a facet that contains an attribute which is a target to an attribute reference in a different facet.

", "error":{"httpStatusCode":400}, "exception":true }, "FacetName":{ "type":"string", "max":64, "min":1, "pattern":"^[a-zA-Z0-9._-]*$" }, "FacetNameList":{ "type":"list", "member":{"shape":"FacetName"} }, "FacetNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

The specified Facet could not be found.

", "error":{"httpStatusCode":400}, "exception":true }, "FacetValidationException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

The Facet you provided was not well formed or could not be validated with the schema.

", "error":{"httpStatusCode":400}, "exception":true }, "GetDirectoryRequest":{ "type":"structure", "required":["DirectoryArn"], "members":{ "DirectoryArn":{ "shape":"DirectoryArn", "documentation":"

The ARN of the directory.

", "location":"header", "locationName":"x-amz-data-partition" } } }, "GetDirectoryResponse":{ "type":"structure", "required":["Directory"], "members":{ "Directory":{ "shape":"Directory", "documentation":"

Metadata about the directory.

" } } }, "GetFacetRequest":{ "type":"structure", "required":[ "SchemaArn", "Name" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

ARN associated with the Facet. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Name":{ "shape":"FacetName", "documentation":"

The name of the facet to retrieve.

" } } }, "GetFacetResponse":{ "type":"structure", "members":{ "Facet":{ "shape":"Facet", "documentation":"

Facet structure associated with the facet.

" } } }, "GetObjectInformationRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory being retrieved.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

The consistency level at which to retrieve the object information.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "GetObjectInformationResponse":{ "type":"structure", "members":{ "SchemaFacets":{ "shape":"SchemaFacetList", "documentation":"

The facets attached to the specified object.

" }, "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the specified object.

" } } }, "GetSchemaAsJsonRequest":{ "type":"structure", "required":["SchemaArn"], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The ARN of the schema to retrieve.

", "location":"header", "locationName":"x-amz-data-partition" } } }, "GetSchemaAsJsonResponse":{ "type":"structure", "members":{ "Name":{ "shape":"SchemaName", "documentation":"

The name of the retrieved schema.

" }, "Document":{ "shape":"SchemaJsonDocument", "documentation":"

The JSON representation of the schema document.

" } } }, "IndexAttachment":{ "type":"structure", "members":{ "IndexedAttributes":{ "shape":"AttributeKeyAndValueList", "documentation":"

The indexed attribute values.

" }, "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier of the object attached to the index.

" } }, "documentation":"

Represents an index and an attached object.

" }, "IndexAttachmentList":{ "type":"list", "member":{"shape":"IndexAttachment"} }, "IndexedAttributeMissingException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

An object has been attempted to be attached to an object that does not have the appropriate attribute value.

", "error":{"httpStatusCode":400}, "exception":true }, "InternalServiceException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.

", "error":{"httpStatusCode":500}, "exception":true }, "InvalidArnException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that the provided ARN value is not valid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidAttachmentException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that an attempt to attach an object with the same link name or to apply a schema with same name has occurred. Rename the link or the schema and then try again.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidFacetUpdateException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

An attempt to modify a Facet resulted in an invalid schema exception.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidNextTokenException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that the NextToken value is not valid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRuleException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Occurs when any of the rule parameter keys or values are invalid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidSchemaDocException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that the provided SchemaDoc value is not valid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidTaggingRequestException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.

", "error":{"httpStatusCode":400}, "exception":true }, "LimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates limits are exceeded. See Limits for more information.

", "error":{"httpStatusCode":400}, "exception":true }, "LinkName":{ "type":"string", "max":64 }, "LinkNameAlreadyInUseException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.

", "error":{"httpStatusCode":400}, "exception":true }, "LinkNameToObjectIdentifierMap":{ "type":"map", "key":{"shape":"LinkName"}, "value":{"shape":"ObjectIdentifier"} }, "ListAppliedSchemaArnsRequest":{ "type":"structure", "required":["DirectoryArn"], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory you are listing.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } } }, "ListAppliedSchemaArnsResponse":{ "type":"structure", "members":{ "SchemaArns":{ "shape":"Arns", "documentation":"

The ARNs of schemas that are applied to the directory.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListAttachedIndicesRequest":{ "type":"structure", "required":[ "DirectoryArn", "TargetReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory.

", "location":"header", "locationName":"x-amz-data-partition" }, "TargetReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object to that has indices attached.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

The consistency level to use for this operation.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "ListAttachedIndicesResponse":{ "type":"structure", "members":{ "IndexAttachments":{ "shape":"IndexAttachmentList", "documentation":"

The indices attached to the specified object.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListDevelopmentSchemaArnsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } } }, "ListDevelopmentSchemaArnsResponse":{ "type":"structure", "members":{ "SchemaArns":{ "shape":"Arns", "documentation":"

The ARNs of retrieved development schemas.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListDirectoriesRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" }, "state":{ "shape":"DirectoryState", "documentation":"

The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

" } } }, "ListDirectoriesResponse":{ "type":"structure", "required":["Directories"], "members":{ "Directories":{ "shape":"DirectoryList", "documentation":"

Lists all directories associated with your account in pagination fashion.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListFacetAttributesRequest":{ "type":"structure", "required":[ "SchemaArn", "Name" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The ARN of the schema where the facet resides.

", "location":"header", "locationName":"x-amz-data-partition" }, "Name":{ "shape":"FacetName", "documentation":"

The name of the facet whose attributes will be retrieved.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } } }, "ListFacetAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"FacetAttributeList", "documentation":"

The attributes attached to the facet.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListFacetNamesRequest":{ "type":"structure", "required":["SchemaArn"], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The ARN to retrieve facet names from.

", "location":"header", "locationName":"x-amz-data-partition" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve

" } } }, "ListFacetNamesResponse":{ "type":"structure", "members":{ "FacetNames":{ "shape":"FacetNameList", "documentation":"

The names of facets that exist within the schema.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListIndexRequest":{ "type":"structure", "required":[ "DirectoryArn", "IndexReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory that the index exists in.

", "location":"header", "locationName":"x-amz-data-partition" }, "RangesOnIndexedValues":{ "shape":"ObjectAttributeRangeList", "documentation":"

Specifies the ranges of indexed values that you want to query.

" }, "IndexReference":{ "shape":"ObjectReference", "documentation":"

The reference to the index to list.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve from the index.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

The consistency level to execute the request at.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "ListIndexResponse":{ "type":"structure", "members":{ "IndexAttachments":{ "shape":"IndexAttachmentList", "documentation":"

The objects and indexed values attached to the index.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListObjectAttributesRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory where the object resides. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object whose attributes will be listed.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token used for pagination.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

Maximum number of items to be retrieved in a single call. This is an approximate number.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "ListObjectAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"AttributeKeyAndValueList", "documentation":"

Attributes map associated with the object. AttributeArn is the key, and attribute value is the value.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token used for pagination.

" } } }, "ListObjectChildrenRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory where the object resides. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object for which child objects are being listed.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token used for pagination.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

Maximum number of items to be retrieved in a single call. This is an approximate number.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "ListObjectChildrenResponse":{ "type":"structure", "members":{ "Children":{ "shape":"LinkNameToObjectIdentifierMap", "documentation":"

Children structure, which is a map with key as the LinkName and ObjectIdentifier as the value.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token used for pagination.

" } } }, "ListObjectParentsRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory where the object resides. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object for which parent objects are being listed.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token used for pagination.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

Maximum number of items to be retrieved in a single call. This is an approximate number.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "ListObjectParentsResponse":{ "type":"structure", "members":{ "Parents":{ "shape":"ObjectIdentifierToLinkNameMap", "documentation":"

Parent structure, which is a map with key as the ObjectIdentifier and LinkName as the value.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token used for pagination.

" } } }, "ListObjectPoliciesRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory where objects reside. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object for which policies will be listed.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token used for pagination.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

Maximum number of items to be retrieved in a single call. This is an approximate number.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "ListObjectPoliciesResponse":{ "type":"structure", "members":{ "AttachedPolicyIds":{ "shape":"ObjectIdentifierList", "documentation":"

List of policy ObjectIdentifiers, that are attached to the object.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token used for pagination.

" } } }, "ListPolicyAttachmentsRequest":{ "type":"structure", "required":[ "DirectoryArn", "PolicyReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory where objects reside. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "PolicyReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the policy object.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token used for pagination.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

Maximum number of items to be retrieved in a single call. This is an approximate number.

" }, "ConsistencyLevel":{ "shape":"ConsistencyLevel", "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", "location":"header", "locationName":"x-amz-consistency-level" } } }, "ListPolicyAttachmentsResponse":{ "type":"structure", "members":{ "ObjectIdentifiers":{ "shape":"ObjectIdentifierList", "documentation":"

List of ObjectIdentifiers to which the policy is attached.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token used for pagination.

" } } }, "ListPublishedSchemaArnsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

The maximum number of results to retrieve.

" } } }, "ListPublishedSchemaArnsResponse":{ "type":"structure", "members":{ "SchemaArns":{ "shape":"Arns", "documentation":"

The ARNs of published schemas.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The pagination token.

" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

ARN of the resource. Tagging is only supported for directories.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Next token used for pagination. This is for future use. Currently pagination is not supported for tagging.

" }, "MaxResults":{ "shape":"TagsNumberResults", "documentation":"

The MaxResults parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.

" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "Tags":{ "shape":"TagList", "documentation":"

List of tag key value pairs associated with the response.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "LookupPolicyRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object whose policies will be looked up.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to request the next page of results.

" }, "MaxResults":{ "shape":"NumberResults", "documentation":"

Maximum number of items to be retrieved in a single call. This is an approximate number.

" } } }, "LookupPolicyResponse":{ "type":"structure", "members":{ "PolicyToPathList":{ "shape":"PolicyToPathList", "documentation":"

Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and PolicyType.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Token used for pagination.

" } } }, "NextToken":{"type":"string"}, "NotIndexException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates the requested operation can only operate on index objects.

", "error":{"httpStatusCode":400}, "exception":true }, "NotNodeException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Occurs when any invalid operations are performed on an object which is not a node, such as calling ListObjectChildren for a leaf node object.

", "error":{"httpStatusCode":400}, "exception":true }, "NotPolicyException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates the requested operation can only operate on policy objects.

", "error":{"httpStatusCode":400}, "exception":true }, "NumberAttributeValue":{"type":"string"}, "NumberResults":{ "type":"integer", "min":0 }, "ObjectAlreadyDetachedException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates the object is not attached to the index.

", "error":{"httpStatusCode":400}, "exception":true }, "ObjectAttributeAction":{ "type":"structure", "members":{ "ObjectAttributeActionType":{ "shape":"UpdateActionType", "documentation":"

Type can be either Update or Delete.

" }, "ObjectAttributeUpdateValue":{ "shape":"TypedAttributeValue", "documentation":"

The value that you want to update to.

" } }, "documentation":"

The action to take on the object attribute.

" }, "ObjectAttributeRange":{ "type":"structure", "members":{ "AttributeKey":{ "shape":"AttributeKey", "documentation":"

The key of the attribute the attribute range covers.

" }, "Range":{ "shape":"TypedAttributeValueRange", "documentation":"

The range of attribute values being selected.

" } }, "documentation":"

A range of attributes.

" }, "ObjectAttributeRangeList":{ "type":"list", "member":{"shape":"ObjectAttributeRange"} }, "ObjectAttributeUpdate":{ "type":"structure", "members":{ "ObjectAttributeKey":{ "shape":"AttributeKey", "documentation":"

The key of the attribute being updated.

" }, "ObjectAttributeAction":{ "shape":"ObjectAttributeAction", "documentation":"

The action to perform as part of the attribute update.

" } }, "documentation":"

Structure that contains attribute update information.

" }, "ObjectAttributeUpdateList":{ "type":"list", "member":{"shape":"ObjectAttributeUpdate"} }, "ObjectIdentifier":{"type":"string"}, "ObjectIdentifierList":{ "type":"list", "member":{"shape":"ObjectIdentifier"} }, "ObjectIdentifierToLinkNameMap":{ "type":"map", "key":{"shape":"ObjectIdentifier"}, "value":{"shape":"LinkName"} }, "ObjectNotDetachedException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates the requested operation cannot be completed because the object has not been detached from the tree.

", "error":{"httpStatusCode":400}, "exception":true }, "ObjectReference":{ "type":"structure", "members":{ "Selector":{ "shape":"SelectorObjectReference", "documentation":"

Allows you to specify an object. You can identify an object in one of the following ways:

  • $ObjectIdentifier - Identifies the object by ObjectIdentifier

  • /some/path - Identifies the object based on path

  • #SomeBatchReference - Identifies the object in a batch call

" } }, "documentation":"

Reference that identifies an object.

" }, "ObjectType":{ "type":"string", "enum":[ "NODE", "LEAF_NODE", "POLICY", "INDEX" ] }, "PathString":{"type":"string"}, "PolicyAttachment":{ "type":"structure", "members":{ "PolicyId":{ "shape":"ObjectIdentifier", "documentation":"

The ID of PolicyAttachment.

" }, "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

The ObjectIdentifier associated with PolicyAttachment.

" }, "PolicyType":{ "shape":"PolicyType", "documentation":"

The type of policy that can be associated with PolicyAttachment.

" } }, "documentation":"

Contains the PolicyType, PolicyId, and the ObjectIdentifier to which it is attached.

" }, "PolicyAttachmentList":{ "type":"list", "member":{"shape":"PolicyAttachment"} }, "PolicyToPath":{ "type":"structure", "members":{ "Path":{ "shape":"PathString", "documentation":"

The path that is referenced from the root.

" }, "Policies":{ "shape":"PolicyAttachmentList", "documentation":"

List of policy objects.

" } }, "documentation":"

Used when a regular object exists in a Directory and you want to find all of the policies associated with that object and the parent to that object.

" }, "PolicyToPathList":{ "type":"list", "member":{"shape":"PolicyToPath"} }, "PolicyType":{"type":"string"}, "PublishSchemaRequest":{ "type":"structure", "required":[ "DevelopmentSchemaArn", "Version" ], "members":{ "DevelopmentSchemaArn":{ "shape":"Arn", "documentation":"

ARN associated with the development schema. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Version":{ "shape":"Version", "documentation":"

Version under which the schema will be published.

" }, "Name":{ "shape":"SchemaName", "documentation":"

New name under which the schema will be published. If this is not provided, the development schema is considered.

" } } }, "PublishSchemaResponse":{ "type":"structure", "members":{ "PublishedSchemaArn":{ "shape":"Arn", "documentation":"

ARN associated with the published schema. For more information, see arns.

" } } }, "PutSchemaFromJsonRequest":{ "type":"structure", "required":[ "SchemaArn", "Document" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The ARN of the schema to update.

", "location":"header", "locationName":"x-amz-data-partition" }, "Document":{ "shape":"SchemaJsonDocument", "documentation":"

The replacement JSON schema.

" } } }, "PutSchemaFromJsonResponse":{ "type":"structure", "members":{ "Arn":{ "shape":"Arn", "documentation":"

The ARN of the schema to update.

" } } }, "RangeMode":{ "type":"string", "enum":[ "FIRST", "LAST", "LAST_BEFORE_MISSING_VALUES", "INCLUSIVE", "EXCLUSIVE" ] }, "RemoveFacetFromObjectRequest":{ "type":"structure", "required":[ "DirectoryArn", "SchemaFacet", "ObjectReference" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

The ARN of the directory in which the object resides.

", "location":"header", "locationName":"x-amz-data-partition" }, "SchemaFacet":{ "shape":"SchemaFacet", "documentation":"

The facet to remove.

" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

A reference to the object to remove the facet from.

" } } }, "RemoveFacetFromObjectResponse":{ "type":"structure", "members":{ } }, "RequiredAttributeBehavior":{ "type":"string", "enum":[ "REQUIRED_ALWAYS", "NOT_REQUIRED" ] }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

The specified resource could not be found.

", "error":{"httpStatusCode":404}, "exception":true }, "RetryableConflictException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

", "error":{"httpStatusCode":409}, "exception":true }, "Rule":{ "type":"structure", "members":{ "Type":{ "shape":"RuleType", "documentation":"

The type of attribute validation rule.

" }, "Parameters":{ "shape":"RuleParameterMap", "documentation":"

Min and max parameters associated with the rule.

" } }, "documentation":"

Contains an ARN and parameters associated with the rule.

" }, "RuleKey":{ "type":"string", "max":64, "min":1, "pattern":"^[a-zA-Z0-9._-]*$" }, "RuleMap":{ "type":"map", "key":{"shape":"RuleKey"}, "value":{"shape":"Rule"} }, "RuleParameterKey":{"type":"string"}, "RuleParameterMap":{ "type":"map", "key":{"shape":"RuleParameterKey"}, "value":{"shape":"RuleParameterValue"} }, "RuleParameterValue":{"type":"string"}, "RuleType":{ "type":"string", "enum":[ "BINARY_LENGTH", "NUMBER_COMPARISON", "STRING_FROM_SET", "STRING_LENGTH" ] }, "SchemaAlreadyExistsException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.

", "error":{"httpStatusCode":400}, "exception":true }, "SchemaAlreadyPublishedException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates a schema is already published.

", "error":{"httpStatusCode":400}, "exception":true }, "SchemaFacet":{ "type":"structure", "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

The ARN of the schema that contains the facet.

" }, "FacetName":{ "shape":"FacetName", "documentation":"

The name of the facet.

" } }, "documentation":"

A facet.

" }, "SchemaFacetList":{ "type":"list", "member":{"shape":"SchemaFacet"} }, "SchemaJsonDocument":{"type":"string"}, "SchemaName":{ "type":"string", "max":50, "min":1, "pattern":"^[a-zA-Z0-9._-]*$" }, "SelectorObjectReference":{"type":"string"}, "StillContainsLinksException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

The object could not be deleted because links still exist. Remove the links and then try the operation again.

", "error":{"httpStatusCode":400}, "exception":true }, "StringAttributeValue":{"type":"string"}, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"TagKey", "documentation":"

Key associated with the tag.

" }, "Value":{ "shape":"TagValue", "documentation":"

Value associated with the tag.

" } }, "documentation":"

Tag structure which contains tag key and value.

" }, "TagKey":{"type":"string"}, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"} }, "TagList":{ "type":"list", "member":{"shape":"Tag"} }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

ARN of the resource. Tagging is only supported for directories.

" }, "Tags":{ "shape":"TagList", "documentation":"

List of tag key value pairs.

" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagValue":{"type":"string"}, "TagsNumberResults":{ "type":"integer", "min":50 }, "TypedAttributeValue":{ "type":"structure", "members":{ "StringValue":{ "shape":"StringAttributeValue", "documentation":"

A string data value.

" }, "BinaryValue":{ "shape":"BinaryAttributeValue", "documentation":"

A binary data value.

" }, "BooleanValue":{ "shape":"BooleanAttributeValue", "documentation":"

A Boolean data value.

" }, "NumberValue":{ "shape":"NumberAttributeValue", "documentation":"

A number data value.

" }, "DatetimeValue":{ "shape":"DatetimeAttributeValue", "documentation":"

A date and time value.

" } }, "documentation":"

Represents the data for a typed attribute. You can set one, and only one, of the elements. Each attribute in an item is a name-value pair. Attributes have a single value.

" }, "TypedAttributeValueRange":{ "type":"structure", "required":[ "StartMode", "EndMode" ], "members":{ "StartMode":{ "shape":"RangeMode", "documentation":"

Inclusive or exclusive range start.

" }, "StartValue":{ "shape":"TypedAttributeValue", "documentation":"

The value to start the range at.

" }, "EndMode":{ "shape":"RangeMode", "documentation":"

Inclusive or exclusive range end.

" }, "EndValue":{ "shape":"TypedAttributeValue", "documentation":"

The attribute value to terminate the range at.

" } }, "documentation":"

A range of attribute values.

" }, "UnsupportedIndexTypeException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates the requested index type is not supported.

", "error":{"httpStatusCode":400}, "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"Arn", "documentation":"

ARN of the resource. Tagging is only supported for directories.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

Keys of the tag that needs to be removed from the resource.

" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateActionType":{ "type":"string", "enum":[ "CREATE_OR_UPDATE", "DELETE" ] }, "UpdateFacetRequest":{ "type":"structure", "required":[ "SchemaArn", "Name" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

ARN associated with the Facet. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Name":{ "shape":"FacetName", "documentation":"

" }, "AttributeUpdates":{ "shape":"FacetAttributeUpdateList", "documentation":"

List of attributes that need to be updated in a given schema Facet. Each attribute is followed by AttributeAction, which specifies the type of update operation to perform.

" }, "ObjectType":{ "shape":"ObjectType", "documentation":"

Object type associated with the facet. See CreateFacetRequest$ObjectType for more details.

" } } }, "UpdateFacetResponse":{ "type":"structure", "members":{ } }, "UpdateObjectAttributesRequest":{ "type":"structure", "required":[ "DirectoryArn", "ObjectReference", "AttributeUpdates" ], "members":{ "DirectoryArn":{ "shape":"Arn", "documentation":"

ARN associated with the Directory where the object resides. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "ObjectReference":{ "shape":"ObjectReference", "documentation":"

Reference that identifies the object.

" }, "AttributeUpdates":{ "shape":"ObjectAttributeUpdateList", "documentation":"

Attributes update structure.

" } } }, "UpdateObjectAttributesResponse":{ "type":"structure", "members":{ "ObjectIdentifier":{ "shape":"ObjectIdentifier", "documentation":"

ObjectIdentifier of the updated object.

" } } }, "UpdateSchemaRequest":{ "type":"structure", "required":[ "SchemaArn", "Name" ], "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

ARN of the development schema. For more information, see arns.

", "location":"header", "locationName":"x-amz-data-partition" }, "Name":{ "shape":"SchemaName", "documentation":"

Name of the schema.

" } } }, "UpdateSchemaResponse":{ "type":"structure", "members":{ "SchemaArn":{ "shape":"Arn", "documentation":"

ARN associated with the updated schema. For more information, see arns.

" } } }, "ValidationException":{ "type":"structure", "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Indicates your request is malformed in some manner. See the exception message.

", "error":{"httpStatusCode":400}, "exception":true }, "Version":{ "type":"string", "max":10, "min":1, "pattern":"^[a-zA-Z0-9._-]*$" } }, "documentation":"Amazon Cloud Directory

Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile and IoT applications. This guide describes the Cloud Directory operations that you can call programatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.

" } botocore-1.5.7/botocore/data/cognito-sync/0000777454262600001440000000000013042511307021547 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cognito-sync/2014-06-30/0000777454262600001440000000000013042511307022600 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cognito-sync/2014-06-30/service-2.json0000666454262600001440000025362513042511306025306 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2014-06-30", "endpointPrefix":"cognito-sync", "jsonVersion":"1.1", "serviceFullName":"Amazon Cognito Sync", "signatureVersion":"v4", "protocol":"rest-json", "uid":"cognito-sync-2014-06-30" }, "documentation":"Amazon Cognito Sync

Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity.

With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with Amazon Cognito Identity service.

If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS.

", "operations":{ "BulkPublish":{ "name":"BulkPublish", "http":{ "method":"POST", "requestUri":"/identitypools/{IdentityPoolId}/bulkpublish", "responseCode":200 }, "input":{ "shape":"BulkPublishRequest", "documentation":"The input for the BulkPublish operation." }, "output":{ "shape":"BulkPublishResponse", "documentation":"The output for the BulkPublish operation." }, "errors":[ { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"Thrown if the resource doesn't exist." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." }, { "shape":"DuplicateRequestException", "error":{ "code":"DuplicateRequest", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool." }, { "shape":"AlreadyStreamedException", "error":{ "code":"AlreadyStreamed", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully." } ], "documentation":"

Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

" }, "DeleteDataset":{ "name":"DeleteDataset", "http":{ "method":"DELETE", "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", "responseCode":200 }, "input":{ "shape":"DeleteDatasetRequest", "documentation":"A request to delete the specific dataset." }, "output":{ "shape":"DeleteDatasetResponse", "documentation":"Response to a successful DeleteDataset request." }, "errors":[ { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"Thrown if the resource doesn't exist." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." }, { "shape":"TooManyRequestsException", "error":{ "code":"TooManyRequests", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"Thrown if the request is throttled." }, { "shape":"ResourceConflictException", "error":{ "code":"ResourceConflict", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict." } ], "documentation":"

Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

" }, "DescribeDataset":{ "name":"DescribeDataset", "http":{ "method":"GET", "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", "responseCode":200 }, "input":{ "shape":"DescribeDatasetRequest", "documentation":"A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name." }, "output":{ "shape":"DescribeDatasetResponse", "documentation":"Response to a successful DescribeDataset request." }, "errors":[ { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"Thrown if the resource doesn't exist." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." }, { "shape":"TooManyRequestsException", "error":{ "code":"TooManyRequests", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"Thrown if the request is throttled." } ], "documentation":"

Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

" }, "DescribeIdentityPoolUsage":{ "name":"DescribeIdentityPoolUsage", "http":{ "method":"GET", "requestUri":"/identitypools/{IdentityPoolId}", "responseCode":200 }, "input":{ "shape":"DescribeIdentityPoolUsageRequest", "documentation":"A request for usage information about the identity pool." }, "output":{ "shape":"DescribeIdentityPoolUsageResponse", "documentation":"Response to a successful DescribeIdentityPoolUsage request." }, "errors":[ { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"Thrown if the resource doesn't exist." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." }, { "shape":"TooManyRequestsException", "error":{ "code":"TooManyRequests", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"Thrown if the request is throttled." } ], "documentation":"

Gets usage details (for example, data storage) about a particular identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

" }, "DescribeIdentityUsage":{ "name":"DescribeIdentityUsage", "http":{ "method":"GET", "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}", "responseCode":200 }, "input":{ "shape":"DescribeIdentityUsageRequest", "documentation":"A request for information about the usage of an identity pool." }, "output":{ "shape":"DescribeIdentityUsageResponse", "documentation":"The response to a successful DescribeIdentityUsage request." }, "errors":[ { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"Thrown if the resource doesn't exist." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." }, { "shape":"TooManyRequestsException", "error":{ "code":"TooManyRequests", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"Thrown if the request is throttled." } ], "documentation":"

Gets usage information for an identity, including number of datasets and data usage.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

" }, "GetBulkPublishDetails":{ "name":"GetBulkPublishDetails", "http":{ "method":"POST", "requestUri":"/identitypools/{IdentityPoolId}/getBulkPublishDetails", "responseCode":200 }, "input":{ "shape":"GetBulkPublishDetailsRequest", "documentation":"The input for the GetBulkPublishDetails operation." }, "output":{ "shape":"GetBulkPublishDetailsResponse", "documentation":"The output for the GetBulkPublishDetails operation." }, "errors":[ { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"Thrown if the resource doesn't exist." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." } ], "documentation":"

Get the status of the last BulkPublish operation for an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

" }, "GetCognitoEvents":{ "name":"GetCognitoEvents", "http":{ "method":"GET", "requestUri":"/identitypools/{IdentityPoolId}/events", "responseCode":200 }, "input":{ "shape":"GetCognitoEventsRequest", "documentation":"

A request for a list of the configured Cognito Events

" }, "output":{ "shape":"GetCognitoEventsResponse", "documentation":"

The response from the GetCognitoEvents request

" }, "errors":[ { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"Thrown if the resource doesn't exist." }, { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." }, { "shape":"TooManyRequestsException", "error":{ "code":"TooManyRequests", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"Thrown if the request is throttled." } ], "documentation":"

Gets the events and the corresponding Lambda functions associated with an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

" }, "GetIdentityPoolConfiguration":{ "name":"GetIdentityPoolConfiguration", "http":{ "method":"GET", "requestUri":"/identitypools/{IdentityPoolId}/configuration", "responseCode":200 }, "input":{ "shape":"GetIdentityPoolConfigurationRequest", "documentation":"

The input for the GetIdentityPoolConfiguration operation.

" }, "output":{ "shape":"GetIdentityPoolConfigurationResponse", "documentation":"

The output for the GetIdentityPoolConfiguration operation.

" }, "errors":[ { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"Thrown if the resource doesn't exist." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." }, { "shape":"TooManyRequestsException", "error":{ "code":"TooManyRequests", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"Thrown if the request is throttled." } ], "documentation":"

Gets the configuration settings of an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

" }, "ListDatasets":{ "name":"ListDatasets", "http":{ "method":"GET", "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets", "responseCode":200 }, "input":{ "shape":"ListDatasetsRequest", "documentation":"Request for a list of datasets for an identity." }, "output":{ "shape":"ListDatasetsResponse", "documentation":"Returned for a successful ListDatasets request." }, "errors":[ { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." }, { "shape":"TooManyRequestsException", "error":{ "code":"TooManyRequests", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"Thrown if the request is throttled." } ], "documentation":"

Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.

" }, "ListIdentityPoolUsage":{ "name":"ListIdentityPoolUsage", "http":{ "method":"GET", "requestUri":"/identitypools", "responseCode":200 }, "input":{ "shape":"ListIdentityPoolUsageRequest", "documentation":"A request for usage information on an identity pool." }, "output":{ "shape":"ListIdentityPoolUsageResponse", "documentation":"Returned for a successful ListIdentityPoolUsage request." }, "errors":[ { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." }, { "shape":"TooManyRequestsException", "error":{ "code":"TooManyRequests", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"Thrown if the request is throttled." } ], "documentation":"

Gets a list of identity pools registered with Cognito.

ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.

" }, "ListRecords":{ "name":"ListRecords", "http":{ "method":"GET", "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/records", "responseCode":200 }, "input":{ "shape":"ListRecordsRequest", "documentation":"A request for a list of records." }, "output":{ "shape":"ListRecordsResponse", "documentation":"Returned for a successful ListRecordsRequest." }, "errors":[ { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"TooManyRequestsException", "error":{ "code":"TooManyRequests", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"Thrown if the request is throttled." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." } ], "documentation":"

Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

" }, "RegisterDevice":{ "name":"RegisterDevice", "http":{ "method":"POST", "requestUri":"/identitypools/{IdentityPoolId}/identity/{IdentityId}/device", "responseCode":200 }, "input":{ "shape":"RegisterDeviceRequest", "documentation":"

A request to RegisterDevice.

" }, "output":{ "shape":"RegisterDeviceResponse", "documentation":"

Response to a RegisterDevice request.

" }, "errors":[ { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"Thrown if the resource doesn't exist." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." }, { "shape":"InvalidConfigurationException", "error":{ "code":"InvalidConfiguration", "httpStatusCode":400, "senderFault":true }, "exception":true }, { "shape":"TooManyRequestsException", "error":{ "code":"TooManyRequests", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"Thrown if the request is throttled." } ], "documentation":"

Registers a device to receive push sync notifications.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

" }, "SetCognitoEvents":{ "name":"SetCognitoEvents", "http":{ "method":"POST", "requestUri":"/identitypools/{IdentityPoolId}/events", "responseCode":200 }, "input":{ "shape":"SetCognitoEventsRequest", "documentation":"

A request to configure Cognito Events\"

\"" }, "errors":[ { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"Thrown if the resource doesn't exist." }, { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." }, { "shape":"TooManyRequestsException", "error":{ "code":"TooManyRequests", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"Thrown if the request is throttled." } ], "documentation":"

Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

" }, "SetIdentityPoolConfiguration":{ "name":"SetIdentityPoolConfiguration", "http":{ "method":"POST", "requestUri":"/identitypools/{IdentityPoolId}/configuration", "responseCode":200 }, "input":{ "shape":"SetIdentityPoolConfigurationRequest", "documentation":"

The input for the SetIdentityPoolConfiguration operation.

" }, "output":{ "shape":"SetIdentityPoolConfigurationResponse", "documentation":"

The output for the SetIdentityPoolConfiguration operation

" }, "errors":[ { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"Thrown if the resource doesn't exist." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." }, { "shape":"TooManyRequestsException", "error":{ "code":"TooManyRequests", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"Thrown if the request is throttled." }, { "shape":"ConcurrentModificationException", "error":{ "code":"ConcurrentModification", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Thrown if there are parallel requests to modify a resource.

" } ], "documentation":"

Sets the necessary configuration for push sync.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

" }, "SubscribeToDataset":{ "name":"SubscribeToDataset", "http":{ "method":"POST", "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}", "responseCode":200 }, "input":{ "shape":"SubscribeToDatasetRequest", "documentation":"

A request to SubscribeToDatasetRequest.

" }, "output":{ "shape":"SubscribeToDatasetResponse", "documentation":"

Response to a SubscribeToDataset request.

" }, "errors":[ { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"Thrown if the resource doesn't exist." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." }, { "shape":"InvalidConfigurationException", "error":{ "code":"InvalidConfiguration", "httpStatusCode":400, "senderFault":true }, "exception":true }, { "shape":"TooManyRequestsException", "error":{ "code":"TooManyRequests", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"Thrown if the request is throttled." } ], "documentation":"

Subscribes to receive notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

" }, "UnsubscribeFromDataset":{ "name":"UnsubscribeFromDataset", "http":{ "method":"DELETE", "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}", "responseCode":200 }, "input":{ "shape":"UnsubscribeFromDatasetRequest", "documentation":"

A request to UnsubscribeFromDataset.

" }, "output":{ "shape":"UnsubscribeFromDatasetResponse", "documentation":"

Response to an UnsubscribeFromDataset request.

" }, "errors":[ { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"Thrown if the resource doesn't exist." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." }, { "shape":"InvalidConfigurationException", "error":{ "code":"InvalidConfiguration", "httpStatusCode":400, "senderFault":true }, "exception":true }, { "shape":"TooManyRequestsException", "error":{ "code":"TooManyRequests", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"Thrown if the request is throttled." } ], "documentation":"

Unsubscribes from receiving notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

" }, "UpdateRecords":{ "name":"UpdateRecords", "http":{ "method":"POST", "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", "responseCode":200 }, "input":{ "shape":"UpdateRecordsRequest", "documentation":"A request to post updates to records or add and delete records for a dataset and user." }, "output":{ "shape":"UpdateRecordsResponse", "documentation":"Returned for a successful UpdateRecordsRequest." }, "errors":[ { "shape":"InvalidParameterException", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when the limit on the number of objects or operations has been exceeded." }, { "shape":"NotAuthorizedException", "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"Thrown if the resource doesn't exist." }, { "shape":"ResourceConflictException", "error":{ "code":"ResourceConflict", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict." }, { "shape":"InvalidLambdaFunctionOutputException", "error":{ "code":"InvalidLambdaFunctionOutput", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The AWS Lambda function returned invalid output or an exception.

" }, { "shape":"LambdaThrottledException", "error":{ "code":"LambdaThrottled", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"

AWS Lambda throttled your account, please contact AWS Support

" }, { "shape":"TooManyRequestsException", "error":{ "code":"TooManyRequests", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"Thrown if the request is throttled." }, { "shape":"InternalErrorException", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." } ], "documentation":"

Posts updates to records and adds and deletes records for a dataset and user.

The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.

For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

" } }, "shapes":{ "AlreadyStreamedException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"The message associated with the AlreadyStreamedException exception." } }, "error":{ "code":"AlreadyStreamed", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully." }, "ApplicationArn":{ "type":"string", "pattern":"arn:aws:sns:[-0-9a-z]+:\\d+:app/[A-Z_]+/[a-zA-Z0-9_.-]+" }, "ApplicationArnList":{ "type":"list", "member":{"shape":"ApplicationArn"} }, "AssumeRoleArn":{ "type":"string", "min":20, "max":2048, "pattern":"arn:aws:iam::\\d+:role/.*" }, "Boolean":{"type":"boolean"}, "BulkPublishRequest":{ "type":"structure", "required":["IdentityPoolId"], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "location":"uri", "locationName":"IdentityPoolId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." } }, "documentation":"The input for the BulkPublish operation." }, "BulkPublishResponse":{ "type":"structure", "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." } }, "documentation":"The output for the BulkPublish operation." }, "BulkPublishStatus":{ "type":"string", "enum":[ "NOT_STARTED", "IN_PROGRESS", "FAILED", "SUCCEEDED" ] }, "ClientContext":{"type":"string"}, "CognitoEventType":{"type":"string"}, "CognitoStreams":{ "type":"structure", "members":{ "StreamName":{ "shape":"StreamName", "documentation":"The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool." }, "RoleArn":{ "shape":"AssumeRoleArn", "documentation":"The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream." }, "StreamingStatus":{ "shape":"StreamingStatus", "documentation":"Status of the Cognito streams. Valid values are:

ENABLED - Streaming of updates to identity pool is enabled.

DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.

" } }, "documentation":"Configuration options for configure Cognito streams." }, "ConcurrentModificationException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"String", "documentation":"

The message returned by a ConcurrentModicationException.

" } }, "error":{ "code":"ConcurrentModification", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

Thrown if there are parallel requests to modify a resource.

" }, "Dataset":{ "type":"structure", "members":{ "IdentityId":{ "shape":"IdentityId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." }, "DatasetName":{ "shape":"DatasetName", "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." }, "CreationDate":{ "shape":"Date", "documentation":"Date on which the dataset was created." }, "LastModifiedDate":{ "shape":"Date", "documentation":"Date when the dataset was last modified." }, "LastModifiedBy":{ "shape":"String", "documentation":"The device that made the last change to this dataset." }, "DataStorage":{ "shape":"Long", "documentation":"Total size in bytes of the records in this dataset." }, "NumRecords":{ "shape":"Long", "documentation":"Number of records in this dataset." } }, "documentation":"A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs." }, "DatasetList":{ "type":"list", "member":{"shape":"Dataset"} }, "DatasetName":{ "type":"string", "min":1, "max":128, "pattern":"[a-zA-Z0-9_.:-]+" }, "Date":{"type":"timestamp"}, "DeleteDatasetRequest":{ "type":"structure", "required":[ "IdentityPoolId", "IdentityId", "DatasetName" ], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "location":"uri", "locationName":"IdentityPoolId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." }, "IdentityId":{ "shape":"IdentityId", "location":"uri", "locationName":"IdentityId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." }, "DatasetName":{ "shape":"DatasetName", "location":"uri", "locationName":"DatasetName", "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." } }, "documentation":"A request to delete the specific dataset." }, "DeleteDatasetResponse":{ "type":"structure", "members":{ "Dataset":{ "shape":"Dataset", "documentation":"A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs." } }, "documentation":"Response to a successful DeleteDataset request." }, "DescribeDatasetRequest":{ "type":"structure", "required":[ "IdentityPoolId", "IdentityId", "DatasetName" ], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "location":"uri", "locationName":"IdentityPoolId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." }, "IdentityId":{ "shape":"IdentityId", "location":"uri", "locationName":"IdentityId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." }, "DatasetName":{ "shape":"DatasetName", "location":"uri", "locationName":"DatasetName", "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." } }, "documentation":"A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name." }, "DescribeDatasetResponse":{ "type":"structure", "members":{ "Dataset":{ "shape":"Dataset", "documentation":"Meta data for a collection of data for an identity. An identity can have multiple datasets. A dataset can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs." } }, "documentation":"Response to a successful DescribeDataset request." }, "DescribeIdentityPoolUsageRequest":{ "type":"structure", "required":["IdentityPoolId"], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "location":"uri", "locationName":"IdentityPoolId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." } }, "documentation":"A request for usage information about the identity pool." }, "DescribeIdentityPoolUsageResponse":{ "type":"structure", "members":{ "IdentityPoolUsage":{ "shape":"IdentityPoolUsage", "documentation":"Information about the usage of the identity pool." } }, "documentation":"Response to a successful DescribeIdentityPoolUsage request." }, "DescribeIdentityUsageRequest":{ "type":"structure", "required":[ "IdentityPoolId", "IdentityId" ], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "location":"uri", "locationName":"IdentityPoolId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." }, "IdentityId":{ "shape":"IdentityId", "location":"uri", "locationName":"IdentityId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." } }, "documentation":"A request for information about the usage of an identity pool." }, "DescribeIdentityUsageResponse":{ "type":"structure", "members":{ "IdentityUsage":{ "shape":"IdentityUsage", "documentation":"Usage information for the identity." } }, "documentation":"The response to a successful DescribeIdentityUsage request." }, "DeviceId":{ "type":"string", "min":1, "max":256 }, "DuplicateRequestException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"The message associated with the DuplicateRequestException exception." } }, "error":{ "code":"DuplicateRequest", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool." }, "Events":{ "type":"map", "key":{"shape":"CognitoEventType"}, "value":{"shape":"LambdaFunctionArn"}, "max":1 }, "ExceptionMessage":{"type":"string"}, "GetBulkPublishDetailsRequest":{ "type":"structure", "required":["IdentityPoolId"], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "location":"uri", "locationName":"IdentityPoolId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." } }, "documentation":"The input for the GetBulkPublishDetails operation." }, "GetBulkPublishDetailsResponse":{ "type":"structure", "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." }, "BulkPublishStartTime":{ "shape":"Date", "documentation":"The date/time at which the last bulk publish was initiated." }, "BulkPublishCompleteTime":{ "shape":"Date", "documentation":"If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed." }, "BulkPublishStatus":{ "shape":"BulkPublishStatus", "documentation":"Status of the last bulk publish operation, valid values are:

NOT_STARTED - No bulk publish has been requested for this identity pool

IN_PROGRESS - Data is being published to the configured stream

SUCCEEDED - All data for the identity pool has been published to the configured stream

FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.

" }, "FailureMessage":{ "shape":"String", "documentation":"If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail." } }, "documentation":"The output for the GetBulkPublishDetails operation." }, "GetCognitoEventsRequest":{ "type":"structure", "required":["IdentityPoolId"], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "location":"uri", "locationName":"IdentityPoolId", "documentation":"

The Cognito Identity Pool ID for the request

" } }, "documentation":"

A request for a list of the configured Cognito Events

" }, "GetCognitoEventsResponse":{ "type":"structure", "members":{ "Events":{ "shape":"Events", "documentation":"

The Cognito Events returned from the GetCognitoEvents request

" } }, "documentation":"

The response from the GetCognitoEvents request

" }, "GetIdentityPoolConfigurationRequest":{ "type":"structure", "required":["IdentityPoolId"], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "location":"uri", "locationName":"IdentityPoolId", "documentation":"

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration.

" } }, "documentation":"

The input for the GetIdentityPoolConfiguration operation.

" }, "GetIdentityPoolConfigurationResponse":{ "type":"structure", "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.

" }, "PushSync":{ "shape":"PushSync", "documentation":"

Options to apply to this identity pool for push synchronization.

" }, "CognitoStreams":{ "shape":"CognitoStreams", "documentation":"Options to apply to this identity pool for Amazon Cognito streams." } }, "documentation":"

The output for the GetIdentityPoolConfiguration operation.

" }, "IdentityId":{ "type":"string", "min":1, "max":55, "pattern":"[\\w-]+:[0-9a-f-]+" }, "IdentityPoolId":{ "type":"string", "min":1, "max":55, "pattern":"[\\w-]+:[0-9a-f-]+" }, "IdentityPoolUsage":{ "type":"structure", "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." }, "SyncSessionsCount":{ "shape":"Long", "documentation":"Number of sync sessions for the identity pool." }, "DataStorage":{ "shape":"Long", "documentation":"Data storage information for the identity pool." }, "LastModifiedDate":{ "shape":"Date", "documentation":"Date on which the identity pool was last modified." } }, "documentation":"Usage information for the identity pool." }, "IdentityPoolUsageList":{ "type":"list", "member":{"shape":"IdentityPoolUsage"} }, "IdentityUsage":{ "type":"structure", "members":{ "IdentityId":{ "shape":"IdentityId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." }, "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." }, "LastModifiedDate":{ "shape":"Date", "documentation":"Date on which the identity was last modified." }, "DatasetCount":{ "shape":"Integer", "documentation":"Number of datasets for the identity." }, "DataStorage":{ "shape":"Long", "documentation":"Total data storage for this identity." } }, "documentation":"Usage information for the identity." }, "Integer":{"type":"integer"}, "IntegerString":{"type":"integer"}, "InternalErrorException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"Message returned by InternalErrorException." } }, "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true, "documentation":"Indicates an internal service error." }, "InvalidConfigurationException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"Message returned by InvalidConfigurationException." } }, "error":{ "code":"InvalidConfiguration", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidLambdaFunctionOutputException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

A message returned when an InvalidLambdaFunctionOutputException occurs

" } }, "error":{ "code":"InvalidLambdaFunctionOutput", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"

The AWS Lambda function returned invalid output or an exception.

" }, "InvalidParameterException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"Message returned by InvalidParameterException." } }, "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when a request parameter does not comply with the associated constraints." }, "LambdaFunctionArn":{"type":"string"}, "LambdaThrottledException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

A message returned when an LambdaThrottledException is thrown

" } }, "error":{ "code":"LambdaThrottled", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"

AWS Lambda throttled your account, please contact AWS Support

" }, "LimitExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"Message returned by LimitExceededException." } }, "error":{ "code":"LimitExceeded", "httpStatusCode":400, "senderFault":true }, "exception":true, "documentation":"Thrown when the limit on the number of objects or operations has been exceeded." }, "ListDatasetsRequest":{ "type":"structure", "required":[ "IdentityId", "IdentityPoolId" ], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "location":"uri", "locationName":"IdentityPoolId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." }, "IdentityId":{ "shape":"IdentityId", "location":"uri", "locationName":"IdentityId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." }, "NextToken":{ "shape":"String", "location":"querystring", "locationName":"nextToken", "documentation":"A pagination token for obtaining the next page of results." }, "MaxResults":{ "shape":"IntegerString", "location":"querystring", "locationName":"maxResults", "documentation":"The maximum number of results to be returned." } }, "documentation":"Request for a list of datasets for an identity." }, "ListDatasetsResponse":{ "type":"structure", "members":{ "Datasets":{ "shape":"DatasetList", "documentation":"A set of datasets." }, "Count":{ "shape":"Integer", "documentation":"Number of datasets returned." }, "NextToken":{ "shape":"String", "documentation":"A pagination token for obtaining the next page of results." } }, "documentation":"Returned for a successful ListDatasets request." }, "ListIdentityPoolUsageRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "location":"querystring", "locationName":"nextToken", "documentation":"A pagination token for obtaining the next page of results." }, "MaxResults":{ "shape":"IntegerString", "location":"querystring", "locationName":"maxResults", "documentation":"The maximum number of results to be returned." } }, "documentation":"A request for usage information on an identity pool." }, "ListIdentityPoolUsageResponse":{ "type":"structure", "members":{ "IdentityPoolUsages":{ "shape":"IdentityPoolUsageList", "documentation":"Usage information for the identity pools." }, "MaxResults":{ "shape":"Integer", "documentation":"The maximum number of results to be returned." }, "Count":{ "shape":"Integer", "documentation":"Total number of identities for the identity pool." }, "NextToken":{ "shape":"String", "documentation":"A pagination token for obtaining the next page of results." } }, "documentation":"Returned for a successful ListIdentityPoolUsage request." }, "ListRecordsRequest":{ "type":"structure", "required":[ "IdentityPoolId", "IdentityId", "DatasetName" ], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "location":"uri", "locationName":"IdentityPoolId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." }, "IdentityId":{ "shape":"IdentityId", "location":"uri", "locationName":"IdentityId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." }, "DatasetName":{ "shape":"DatasetName", "location":"uri", "locationName":"DatasetName", "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." }, "LastSyncCount":{ "shape":"Long", "location":"querystring", "locationName":"lastSyncCount", "documentation":"The last server sync count for this record." }, "NextToken":{ "shape":"String", "location":"querystring", "locationName":"nextToken", "documentation":"A pagination token for obtaining the next page of results." }, "MaxResults":{ "shape":"IntegerString", "location":"querystring", "locationName":"maxResults", "documentation":"The maximum number of results to be returned." }, "SyncSessionToken":{ "shape":"SyncSessionToken", "location":"querystring", "locationName":"syncSessionToken", "documentation":"A token containing a session ID, identity ID, and expiration." } }, "documentation":"A request for a list of records." }, "ListRecordsResponse":{ "type":"structure", "members":{ "Records":{ "shape":"RecordList", "documentation":"A list of all records." }, "NextToken":{ "shape":"String", "documentation":"A pagination token for obtaining the next page of results." }, "Count":{ "shape":"Integer", "documentation":"Total number of records." }, "DatasetSyncCount":{ "shape":"Long", "documentation":"Server sync count for this dataset." }, "LastModifiedBy":{ "shape":"String", "documentation":"The user/device that made the last change to this record." }, "MergedDatasetNames":{ "shape":"MergedDatasetNameList", "documentation":"Names of merged datasets." }, "DatasetExists":{ "shape":"Boolean", "documentation":"Indicates whether the dataset exists." }, "DatasetDeletedAfterRequestedSyncCount":{ "shape":"Boolean", "documentation":"A boolean value specifying whether to delete the dataset locally." }, "SyncSessionToken":{ "shape":"String", "documentation":"A token containing a session ID, identity ID, and expiration." } }, "documentation":"Returned for a successful ListRecordsRequest." }, "Long":{"type":"long"}, "MergedDatasetNameList":{ "type":"list", "member":{"shape":"String"} }, "NotAuthorizedException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"The message returned by a NotAuthorizedException." } }, "error":{ "code":"NotAuthorizedError", "httpStatusCode":403, "senderFault":true }, "exception":true, "documentation":"Thrown when a user is not authorized to access the requested resource." }, "Operation":{ "type":"string", "enum":[ "replace", "remove" ] }, "Platform":{ "type":"string", "enum":[ "APNS", "APNS_SANDBOX", "GCM", "ADM" ] }, "PushSync":{ "type":"structure", "members":{ "ApplicationArns":{ "shape":"ApplicationArnList", "documentation":"

List of SNS platform application ARNs that could be used by clients.

" }, "RoleArn":{ "shape":"AssumeRoleArn", "documentation":"

A role configured to allow Cognito to call SNS on behalf of the developer.

" } }, "documentation":"

Configuration options to be applied to the identity pool.

" }, "PushToken":{"type":"string"}, "Record":{ "type":"structure", "members":{ "Key":{ "shape":"RecordKey", "documentation":"The key for the record." }, "Value":{ "shape":"RecordValue", "documentation":"The value for the record." }, "SyncCount":{ "shape":"Long", "documentation":"The server sync count for this record." }, "LastModifiedDate":{ "shape":"Date", "documentation":"The date on which the record was last modified." }, "LastModifiedBy":{ "shape":"String", "documentation":"The user/device that made the last change to this record." }, "DeviceLastModifiedDate":{ "shape":"Date", "documentation":"The last modified date of the client device." } }, "documentation":"The basic data structure of a dataset." }, "RecordKey":{ "type":"string", "min":1, "max":1024 }, "RecordList":{ "type":"list", "member":{"shape":"Record"} }, "RecordPatch":{ "type":"structure", "required":[ "Op", "Key", "SyncCount" ], "members":{ "Op":{ "shape":"Operation", "documentation":"An operation, either replace or remove." }, "Key":{ "shape":"RecordKey", "documentation":"The key associated with the record patch." }, "Value":{ "shape":"RecordValue", "documentation":"The value associated with the record patch." }, "SyncCount":{ "shape":"Long", "documentation":"Last known server sync count for this record. Set to 0 if unknown." }, "DeviceLastModifiedDate":{ "shape":"Date", "documentation":"The last modified date of the client device." } }, "documentation":"An update operation for a record." }, "RecordPatchList":{ "type":"list", "member":{"shape":"RecordPatch"} }, "RecordValue":{ "type":"string", "max":1048575 }, "RegisterDeviceRequest":{ "type":"structure", "required":[ "IdentityPoolId", "IdentityId", "Platform", "Token" ], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "location":"uri", "locationName":"IdentityPoolId", "documentation":"

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.

" }, "IdentityId":{ "shape":"IdentityId", "location":"uri", "locationName":"IdentityId", "documentation":"

The unique ID for this identity.

" }, "Platform":{ "shape":"Platform", "documentation":"

The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

" }, "Token":{ "shape":"PushToken", "documentation":"

The push token.

" } }, "documentation":"

A request to RegisterDevice.

" }, "RegisterDeviceResponse":{ "type":"structure", "members":{ "DeviceId":{ "shape":"DeviceId", "documentation":"

The unique ID generated for this device by Cognito.

" } }, "documentation":"

Response to a RegisterDevice request.

" }, "ResourceConflictException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"The message returned by a ResourceConflictException." } }, "error":{ "code":"ResourceConflict", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict." }, "ResourceNotFoundException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"Message returned by a ResourceNotFoundException." } }, "error":{ "code":"ResourceNotFound", "httpStatusCode":404, "senderFault":true }, "exception":true, "documentation":"Thrown if the resource doesn't exist." }, "SetCognitoEventsRequest":{ "type":"structure", "required":[ "IdentityPoolId", "Events" ], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "location":"uri", "locationName":"IdentityPoolId", "documentation":"

The Cognito Identity Pool to use when configuring Cognito Events

" }, "Events":{ "shape":"Events", "documentation":"

The events to configure

" } }, "documentation":"

A request to configure Cognito Events\"

\"" }, "SetIdentityPoolConfigurationRequest":{ "type":"structure", "required":["IdentityPoolId"], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "location":"uri", "locationName":"IdentityPoolId", "documentation":"

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify.

" }, "PushSync":{ "shape":"PushSync", "documentation":"

Options to apply to this identity pool for push synchronization.

" }, "CognitoStreams":{ "shape":"CognitoStreams", "documentation":"Options to apply to this identity pool for Amazon Cognito streams." } }, "documentation":"

The input for the SetIdentityPoolConfiguration operation.

" }, "SetIdentityPoolConfigurationResponse":{ "type":"structure", "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "documentation":"

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.

" }, "PushSync":{ "shape":"PushSync", "documentation":"

Options to apply to this identity pool for push synchronization.

" }, "CognitoStreams":{ "shape":"CognitoStreams", "documentation":"Options to apply to this identity pool for Amazon Cognito streams." } }, "documentation":"

The output for the SetIdentityPoolConfiguration operation

" }, "StreamName":{ "type":"string", "min":1, "max":128 }, "StreamingStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "String":{"type":"string"}, "SubscribeToDatasetRequest":{ "type":"structure", "required":[ "IdentityPoolId", "IdentityId", "DatasetName", "DeviceId" ], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "location":"uri", "locationName":"IdentityPoolId", "documentation":"

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which the identity belongs.

" }, "IdentityId":{ "shape":"IdentityId", "location":"uri", "locationName":"IdentityId", "documentation":"

Unique ID for this identity.

" }, "DatasetName":{ "shape":"DatasetName", "location":"uri", "locationName":"DatasetName", "documentation":"

The name of the dataset to subcribe to.

" }, "DeviceId":{ "shape":"DeviceId", "location":"uri", "locationName":"DeviceId", "documentation":"

The unique ID generated for this device by Cognito.

" } }, "documentation":"

A request to SubscribeToDatasetRequest.

" }, "SubscribeToDatasetResponse":{ "type":"structure", "members":{ }, "documentation":"

Response to a SubscribeToDataset request.

" }, "SyncSessionToken":{"type":"string"}, "TooManyRequestsException":{ "type":"structure", "required":["message"], "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"Message returned by a TooManyRequestsException." } }, "error":{ "code":"TooManyRequests", "httpStatusCode":429, "senderFault":true }, "exception":true, "documentation":"Thrown if the request is throttled." }, "UnsubscribeFromDatasetRequest":{ "type":"structure", "required":[ "IdentityPoolId", "IdentityId", "DatasetName", "DeviceId" ], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "location":"uri", "locationName":"IdentityPoolId", "documentation":"

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which this identity belongs.

" }, "IdentityId":{ "shape":"IdentityId", "location":"uri", "locationName":"IdentityId", "documentation":"

Unique ID for this identity.

" }, "DatasetName":{ "shape":"DatasetName", "location":"uri", "locationName":"DatasetName", "documentation":"

The name of the dataset from which to unsubcribe.

" }, "DeviceId":{ "shape":"DeviceId", "location":"uri", "locationName":"DeviceId", "documentation":"

The unique ID generated for this device by Cognito.

" } }, "documentation":"

A request to UnsubscribeFromDataset.

" }, "UnsubscribeFromDatasetResponse":{ "type":"structure", "members":{ }, "documentation":"

Response to an UnsubscribeFromDataset request.

" }, "UpdateRecordsRequest":{ "type":"structure", "required":[ "IdentityPoolId", "IdentityId", "DatasetName", "SyncSessionToken" ], "members":{ "IdentityPoolId":{ "shape":"IdentityPoolId", "location":"uri", "locationName":"IdentityPoolId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." }, "IdentityId":{ "shape":"IdentityId", "location":"uri", "locationName":"IdentityId", "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." }, "DatasetName":{ "shape":"DatasetName", "location":"uri", "locationName":"DatasetName", "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." }, "DeviceId":{ "shape":"DeviceId", "documentation":"

The unique ID generated for this device by Cognito.

" }, "RecordPatches":{ "shape":"RecordPatchList", "documentation":"A list of patch operations." }, "SyncSessionToken":{ "shape":"SyncSessionToken", "documentation":"The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity." }, "ClientContext":{ "shape":"ClientContext", "location":"header", "locationName":"x-amz-Client-Context", "documentation":"Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented." } }, "documentation":"A request to post updates to records or add and delete records for a dataset and user." }, "UpdateRecordsResponse":{ "type":"structure", "members":{ "Records":{ "shape":"RecordList", "documentation":"A list of records that have been updated." } }, "documentation":"Returned for a successful UpdateRecordsRequest." } }, "examples":{ } } botocore-1.5.7/botocore/data/opsworks/0000777454262600001440000000000013042511307021022 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/opsworks/2013-02-18/0000777454262600001440000000000013042511307022054 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/opsworks/2013-02-18/waiters-2.json0000666454262600001440000001706713042511306024576 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "AppExists": { "delay": 1, "operation": "DescribeApps", "maxAttempts": 40, "acceptors": [ { "expected": 200, "matcher": "status", "state": "success" }, { "matcher": "status", "expected": 400, "state": "failure" } ] }, "DeploymentSuccessful": { "delay": 15, "operation": "DescribeDeployments", "maxAttempts": 40, "description": "Wait until a deployment has completed successfully", "acceptors": [ { "expected": "successful", "matcher": "pathAll", "state": "success", "argument": "Deployments[].Status" }, { "expected": "failed", "matcher": "pathAny", "state": "failure", "argument": "Deployments[].Status" } ] }, "InstanceOnline": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "description": "Wait until OpsWorks instance is online.", "acceptors": [ { "expected": "online", "matcher": "pathAll", "state": "success", "argument": "Instances[].Status" }, { "expected": "setup_failed", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "shutting_down", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "start_failed", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "stopped", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "terminating", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "stop_failed", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" } ] }, "InstanceRegistered": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "description": "Wait until OpsWorks instance is registered.", "acceptors": [ { "expected": "registered", "matcher": "pathAll", "state": "success", "argument": "Instances[].Status" }, { "expected": "setup_failed", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "shutting_down", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "stopped", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "stopping", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "terminating", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "terminated", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "stop_failed", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" } ] }, "InstanceStopped": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "description": "Wait until OpsWorks instance is stopped.", "acceptors": [ { "expected": "stopped", "matcher": "pathAll", "state": "success", "argument": "Instances[].Status" }, { "expected": "booting", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "online", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "rebooting", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "requested", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "running_setup", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "setup_failed", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "start_failed", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "stop_failed", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" } ] }, "InstanceTerminated": { "delay": 15, "operation": "DescribeInstances", "maxAttempts": 40, "description": "Wait until OpsWorks instance is terminated.", "acceptors": [ { "expected": "terminated", "matcher": "pathAll", "state": "success", "argument": "Instances[].Status" }, { "expected": "ResourceNotFoundException", "matcher": "error", "state": "success" }, { "expected": "booting", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "online", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "pending", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "rebooting", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "requested", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "running_setup", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "setup_failed", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" }, { "expected": "start_failed", "matcher": "pathAny", "state": "failure", "argument": "Instances[].Status" } ] } } } botocore-1.5.7/botocore/data/opsworks/2013-02-18/service-2.json0000666454262600001440000074242513042511306024563 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"opsworks-2013-02-18", "apiVersion":"2013-02-18", "endpointPrefix":"opsworks", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"AWS OpsWorks", "signatureVersion":"v4", "targetPrefix":"OpsWorks_20130218" }, "operations":{ "AssignInstance":{ "name":"AssignInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssignInstanceRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Assign a registered instance to a layer.

  • You can assign registered on-premises instances to any layer type.

  • You can assign registered Amazon EC2 instances only to custom layers.

  • You cannot use this action with instances that were created with AWS OpsWorks.

Required Permissions: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "AssignVolume":{ "name":"AssignVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssignVolumeRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. After you register the volume, you must call UpdateVolume to specify a mount point before calling AssignVolume. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "AssociateElasticIp":{ "name":"AssociateElasticIp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateElasticIpRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "AttachElasticLoadBalancer":{ "name":"AttachElasticLoadBalancer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachElasticLoadBalancerRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see Elastic Load Balancing.

You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "CloneStack":{ "name":"CloneStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CloneStackRequest"}, "output":{"shape":"CloneStackResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "CreateApp":{ "name":"CreateApp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAppRequest"}, "output":{"shape":"CreateAppResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Creates an app for a specified stack. For more information, see Creating Apps.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "CreateDeployment":{ "name":"CreateDeployment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDeploymentRequest"}, "output":{"shape":"CreateDeploymentResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.

Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "CreateInstance":{ "name":"CreateInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInstanceRequest"}, "output":{"shape":"CreateInstanceResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "CreateLayer":{ "name":"CreateLayer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateLayerRequest"}, "output":{"shape":"CreateLayerResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Creates a layer. For more information, see How to Create a Layer.

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. 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 number of custom layers, so you can call CreateLayer as many times as you like for that layer type.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "CreateStack":{ "name":"CreateStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateStackRequest"}, "output":{"shape":"CreateStackResult"}, "errors":[ {"shape":"ValidationException"} ], "documentation":"

Creates a new stack. For more information, see Create a New Stack.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "CreateUserProfile":{ "name":"CreateUserProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateUserProfileRequest"}, "output":{"shape":"CreateUserProfileResult"}, "errors":[ {"shape":"ValidationException"} ], "documentation":"

Creates a new user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DeleteApp":{ "name":"DeleteApp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAppRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes a specified app.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DeleteInstance":{ "name":"DeleteInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteInstanceRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.

For more information, see Deleting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DeleteLayer":{ "name":"DeleteLayer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteLayerRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DeleteStack":{ "name":"DeleteStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteStackRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DeleteUserProfile":{ "name":"DeleteUserProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteUserProfileRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes a user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DeregisterEcsCluster":{ "name":"DeregisterEcsCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterEcsClusterRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.

" }, "DeregisterElasticIp":{ "name":"DeregisterElasticIp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterElasticIpRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DeregisterInstance":{ "name":"DeregisterInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterInstanceRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS OpsWorks.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DeregisterRdsDbInstance":{ "name":"DeregisterRdsDbInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterRdsDbInstanceRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deregisters an Amazon RDS instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DeregisterVolume":{ "name":"DeregisterVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeregisterVolumeRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeAgentVersions":{ "name":"DescribeAgentVersions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAgentVersionsRequest"}, "output":{"shape":"DescribeAgentVersionsResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes the available AWS OpsWorks agent versions. You must specify a stack ID or a configuration manager. DescribeAgentVersions returns a list of available agent versions for the specified stack or configuration manager.

" }, "DescribeApps":{ "name":"DescribeApps", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAppsRequest"}, "output":{"shape":"DescribeAppsResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Requests a description of a specified set of apps.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeCommands":{ "name":"DescribeCommands", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCommandsRequest"}, "output":{"shape":"DescribeCommandsResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes the results of specified commands.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeDeployments":{ "name":"DescribeDeployments", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDeploymentsRequest"}, "output":{"shape":"DescribeDeploymentsResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Requests a description of a specified set of deployments.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeEcsClusters":{ "name":"DescribeEcsClusters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEcsClustersRequest"}, "output":{"shape":"DescribeEcsClustersResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, AWS OpsWorks currently supports only one cluster per layer, so the result set has a maximum of one element.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information on user permissions, see Managing User Permissions.

" }, "DescribeElasticIps":{ "name":"DescribeElasticIps", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeElasticIpsRequest"}, "output":{"shape":"DescribeElasticIpsResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes Elastic IP addresses.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeElasticLoadBalancers":{ "name":"DescribeElasticLoadBalancers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeElasticLoadBalancersRequest"}, "output":{"shape":"DescribeElasticLoadBalancersResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes a stack's Elastic Load Balancing instances.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeInstances":{ "name":"DescribeInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancesRequest"}, "output":{"shape":"DescribeInstancesResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Requests a description of a set of instances.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeLayers":{ "name":"DescribeLayers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLayersRequest"}, "output":{"shape":"DescribeLayersResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Requests a description of one or more layers in a specified stack.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeLoadBasedAutoScaling":{ "name":"DescribeLoadBasedAutoScaling", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLoadBasedAutoScalingRequest"}, "output":{"shape":"DescribeLoadBasedAutoScalingResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes load-based auto scaling configurations for specified layers.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeMyUserProfile":{ "name":"DescribeMyUserProfile", "http":{ "method":"POST", "requestUri":"/" }, "output":{"shape":"DescribeMyUserProfileResult"}, "documentation":"

Describes a user's SSH information.

Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribePermissions":{ "name":"DescribePermissions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePermissionsRequest"}, "output":{"shape":"DescribePermissionsResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes the permissions for a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeRaidArrays":{ "name":"DescribeRaidArrays", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRaidArraysRequest"}, "output":{"shape":"DescribeRaidArraysResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describe an instance's RAID arrays.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeRdsDbInstances":{ "name":"DescribeRdsDbInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRdsDbInstancesRequest"}, "output":{"shape":"DescribeRdsDbInstancesResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes Amazon RDS instances.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeServiceErrors":{ "name":"DescribeServiceErrors", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeServiceErrorsRequest"}, "output":{"shape":"DescribeServiceErrorsResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes AWS OpsWorks service errors.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeStackProvisioningParameters":{ "name":"DescribeStackProvisioningParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStackProvisioningParametersRequest"}, "output":{"shape":"DescribeStackProvisioningParametersResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Requests a description of a stack's provisioning parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeStackSummary":{ "name":"DescribeStackSummary", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStackSummaryRequest"}, "output":{"shape":"DescribeStackSummaryResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeStacks":{ "name":"DescribeStacks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStacksRequest"}, "output":{"shape":"DescribeStacksResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Requests a description of one or more stacks.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeTimeBasedAutoScaling":{ "name":"DescribeTimeBasedAutoScaling", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTimeBasedAutoScalingRequest"}, "output":{"shape":"DescribeTimeBasedAutoScalingResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes time-based auto scaling configurations for specified instances.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeUserProfiles":{ "name":"DescribeUserProfiles", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeUserProfilesRequest"}, "output":{"shape":"DescribeUserProfilesResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describe specified users.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DescribeVolumes":{ "name":"DescribeVolumes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVolumesRequest"}, "output":{"shape":"DescribeVolumesResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes an instance's Amazon EBS volumes.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DetachElasticLoadBalancer":{ "name":"DetachElasticLoadBalancer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachElasticLoadBalancerRequest"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Detaches a specified Elastic Load Balancing instance from its layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "DisassociateElasticIp":{ "name":"DisassociateElasticIp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateElasticIpRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "GetHostnameSuggestion":{ "name":"GetHostnameSuggestion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetHostnameSuggestionRequest"}, "output":{"shape":"GetHostnameSuggestionResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Gets a generated host name for the specified layer, based on the current host name theme.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "GrantAccess":{ "name":"GrantAccess", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GrantAccessRequest"}, "output":{"shape":"GrantAccessResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

This action can be used only with Windows stacks.

Grants RDP access to a Windows instance for a specified time period.

" }, "RebootInstance":{ "name":"RebootInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootInstanceRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "RegisterEcsCluster":{ "name":"RegisterEcsCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterEcsClusterRequest"}, "output":{"shape":"RegisterEcsClusterResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "RegisterElasticIp":{ "name":"RegisterElasticIp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterElasticIpRequest"}, "output":{"shape":"RegisterElasticIpResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "RegisterInstance":{ "name":"RegisterInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterInstanceRequest"}, "output":{"shape":"RegisterInstanceResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Registers instances with a specified stack that were created outside of AWS OpsWorks.

We do not recommend using this action to register instances. The complete registration operation has two primary steps, installing the AWS OpsWorks agent on the instance and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the AWS CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "RegisterRdsDbInstance":{ "name":"RegisterRdsDbInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterRdsDbInstanceRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Registers an Amazon RDS instance with a stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "RegisterVolume":{ "name":"RegisterVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterVolumeRequest"}, "output":{"shape":"RegisterVolumeResult"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "SetLoadBasedAutoScaling":{ "name":"SetLoadBasedAutoScaling", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetLoadBasedAutoScalingRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.

To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "SetPermission":{ "name":"SetPermission", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetPermissionRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Specifies a user's permissions. For more information, see Security and Permissions.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "SetTimeBasedAutoScaling":{ "name":"SetTimeBasedAutoScaling", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetTimeBasedAutoScalingRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "StartInstance":{ "name":"StartInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartInstanceRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "StartStack":{ "name":"StartStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartStackRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Starts a stack's instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "StopInstance":{ "name":"StopInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopInstanceRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "StopStack":{ "name":"StopStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopStackRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Stops a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "UnassignInstance":{ "name":"UnassignInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnassignInstanceRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Unassigns a registered instance from all of it's layers. The instance remains in the stack as an unassigned instance and can be assigned to another layer, as needed. You cannot use this action with instances that were created with AWS OpsWorks.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "UnassignVolume":{ "name":"UnassignVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnassignVolumeRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "UpdateApp":{ "name":"UpdateApp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAppRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates a specified app.

Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "UpdateElasticIp":{ "name":"UpdateElasticIp", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateElasticIpRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates a registered Elastic IP address's name. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "UpdateInstance":{ "name":"UpdateInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateInstanceRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates a specified instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "UpdateLayer":{ "name":"UpdateLayer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateLayerRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates a specified layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "UpdateMyUserProfile":{ "name":"UpdateMyUserProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateMyUserProfileRequest"}, "errors":[ {"shape":"ValidationException"} ], "documentation":"

Updates a user's SSH public key.

Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "UpdateRdsDbInstance":{ "name":"UpdateRdsDbInstance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateRdsDbInstanceRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates an Amazon RDS instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "UpdateStack":{ "name":"UpdateStack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateStackRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "UpdateUserProfile":{ "name":"UpdateUserProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateUserProfileRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates a specified user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" }, "UpdateVolume":{ "name":"UpdateVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateVolumeRequest"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" } }, "shapes":{ "AgentVersion":{ "type":"structure", "members":{ "Version":{ "shape":"String", "documentation":"

The agent version.

" }, "ConfigurationManager":{ "shape":"StackConfigurationManager", "documentation":"

The configuration manager.

" } }, "documentation":"

Describes an agent version.

" }, "AgentVersions":{ "type":"list", "member":{"shape":"AgentVersion"} }, "App":{ "type":"structure", "members":{ "AppId":{ "shape":"String", "documentation":"

The app ID.

" }, "StackId":{ "shape":"String", "documentation":"

The app stack ID.

" }, "Shortname":{ "shape":"String", "documentation":"

The app's short name.

" }, "Name":{ "shape":"String", "documentation":"

The app name.

" }, "Description":{ "shape":"String", "documentation":"

A description of the app.

" }, "DataSources":{ "shape":"DataSources", "documentation":"

The app's data sources.

" }, "Type":{ "shape":"AppType", "documentation":"

The app type.

" }, "AppSource":{ "shape":"Source", "documentation":"

A Source object that describes the app repository.

" }, "Domains":{ "shape":"Strings", "documentation":"

The app vhost settings with multiple domains separated by commas. For example: 'www.example.com, example.com'

" }, "EnableSsl":{ "shape":"Boolean", "documentation":"

Whether to enable SSL for the app.

" }, "SslConfiguration":{ "shape":"SslConfiguration", "documentation":"

An SslConfiguration object with the SSL configuration.

" }, "Attributes":{ "shape":"AppAttributes", "documentation":"

The stack attributes.

" }, "CreatedAt":{ "shape":"String", "documentation":"

When the app was created.

" }, "Environment":{ "shape":"EnvironmentVariables", "documentation":"

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables.

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variable names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an \"Environment: is too large (maximum is 10KB)\" message.

" } }, "documentation":"

A description of the app.

" }, "AppAttributes":{ "type":"map", "key":{"shape":"AppAttributesKeys"}, "value":{"shape":"String"} }, "AppAttributesKeys":{ "type":"string", "enum":[ "DocumentRoot", "RailsEnv", "AutoBundleOnDeploy", "AwsFlowRubySettings" ] }, "AppType":{ "type":"string", "enum":[ "aws-flow-ruby", "java", "rails", "php", "nodejs", "static", "other" ] }, "Apps":{ "type":"list", "member":{"shape":"App"} }, "Architecture":{ "type":"string", "enum":[ "x86_64", "i386" ] }, "AssignInstanceRequest":{ "type":"structure", "required":[ "InstanceId", "LayerIds" ], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "LayerIds":{ "shape":"Strings", "documentation":"

The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer.

" } } }, "AssignVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" } } }, "AssociateElasticIpRequest":{ "type":"structure", "required":["ElasticIp"], "members":{ "ElasticIp":{ "shape":"String", "documentation":"

The Elastic IP address.

" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" } } }, "AttachElasticLoadBalancerRequest":{ "type":"structure", "required":[ "ElasticLoadBalancerName", "LayerId" ], "members":{ "ElasticLoadBalancerName":{ "shape":"String", "documentation":"

The Elastic Load Balancing instance's name.

" }, "LayerId":{ "shape":"String", "documentation":"

The ID of the layer that the Elastic Load Balancing instance is to be attached to.

" } } }, "AutoScalingThresholds":{ "type":"structure", "members":{ "InstanceCount":{ "shape":"Integer", "documentation":"

The number of instances to add or remove when the load exceeds a threshold.

" }, "ThresholdsWaitTime":{ "shape":"Minute", "documentation":"

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

" }, "IgnoreMetricsTime":{ "shape":"Minute", "documentation":"

The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks to suppress scaling events long enough to get the new instances online.

" }, "CpuThreshold":{ "shape":"Double", "documentation":"

The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

" }, "MemoryThreshold":{ "shape":"Double", "documentation":"

The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

" }, "LoadThreshold":{ "shape":"Double", "documentation":"

The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).

" }, "Alarms":{ "shape":"Strings", "documentation":"

Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks to Act on Your Behalf.

" } }, "documentation":"

Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks starts or stops load-based instances.

" }, "AutoScalingType":{ "type":"string", "enum":[ "load", "timer" ] }, "BlockDeviceMapping":{ "type":"structure", "members":{ "DeviceName":{ "shape":"String", "documentation":"

The device name that is exposed to the instance, such as /dev/sdh. For the root device, you can use the explicit device name or you can set this parameter to ROOT_DEVICE and AWS OpsWorks will provide the correct device name.

" }, "NoDevice":{ "shape":"String", "documentation":"

Suppresses the specified device included in the AMI's block device mapping.

" }, "VirtualName":{ "shape":"String", "documentation":"

The virtual device name. For more information, see BlockDeviceMapping.

" }, "Ebs":{ "shape":"EbsBlockDevice", "documentation":"

An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched.

" } }, "documentation":"

Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping data type.

" }, "BlockDeviceMappings":{ "type":"list", "member":{"shape":"BlockDeviceMapping"} }, "Boolean":{ "type":"boolean", "box":true }, "ChefConfiguration":{ "type":"structure", "members":{ "ManageBerkshelf":{ "shape":"Boolean", "documentation":"

Whether to enable Berkshelf.

" }, "BerkshelfVersion":{ "shape":"String", "documentation":"

The Berkshelf version.

" } }, "documentation":"

Describes the Chef configuration.

" }, "CloneStackRequest":{ "type":"structure", "required":[ "SourceStackId", "ServiceRoleArn" ], "members":{ "SourceStackId":{ "shape":"String", "documentation":"

The source stack ID.

" }, "Name":{ "shape":"String", "documentation":"

The cloned stack name.

" }, "Region":{ "shape":"String", "documentation":"

The cloned stack AWS region, such as \"ap-northeast-2\". For more information about AWS regions, see Regions and Endpoints.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.

  • If your account supports EC2 Classic, the default value is no VPC.

  • If your account does not support EC2 Classic, the default value is the default VPC for the specified region.

If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

If you specify a nondefault VPC ID, note the following:

  • It must belong to a VPC in your account that is in the specified region.

  • You must specify a value for DefaultSubnetId.

For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2 Classic, see Supported Platforms.

" }, "Attributes":{ "shape":"StackAttributes", "documentation":"

A list of stack attributes and values as key/value pairs to be added to the cloned stack.

" }, "ServiceRoleArn":{ "shape":"String", "documentation":"

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. 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, 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 Using Identifiers.

You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.

" }, "DefaultInstanceProfileArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (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 Using Identifiers.

" }, "DefaultOs":{ "shape":"String", "documentation":"

The stack's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS 7

  • Red Hat Enterprise Linux 7

  • Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

The default option is the parent stack's operating system. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.

You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.

" }, "HostnameTheme":{ "shape":"String", "documentation":"

The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

  • Baked_Goods

  • Clouds

  • Europe_Cities

  • Fruits

  • Greek_Deities

  • Legendary_creatures_from_Japan

  • Planets_and_Moons

  • Roman_Deities

  • Scottish_Islands

  • US_Cities

  • Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

" }, "DefaultAvailabilityZone":{ "shape":"String", "documentation":"

The cloned stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.

" }, "DefaultSubnetId":{ "shape":"String", "documentation":"

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

" }, "CustomJson":{ "shape":"String", "documentation":"

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes

" }, "ConfigurationManager":{ "shape":"StackConfigurationManager", "documentation":"

The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

" }, "ChefConfiguration":{ "shape":"ChefConfiguration", "documentation":"

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" }, "UseCustomCookbooks":{ "shape":"Boolean", "documentation":"

Whether to use custom cookbooks.

" }, "UseOpsworksSecurityGroups":{ "shape":"Boolean", "documentation":"

Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.

AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

  • True - AWS OpsWorks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group.

  • False - AWS OpsWorks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

" }, "CustomCookbooksSource":{"shape":"Source"}, "DefaultSshKeyName":{ "shape":"String", "documentation":"

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

" }, "ClonePermissions":{ "shape":"Boolean", "documentation":"

Whether to clone the source stack's permissions.

" }, "CloneAppIds":{ "shape":"Strings", "documentation":"

A list of source stack app IDs to be included in the cloned stack.

" }, "DefaultRootDeviceType":{ "shape":"RootDeviceType", "documentation":"

The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

" }, "AgentVersion":{ "shape":"String", "documentation":"

The default AWS OpsWorks agent version. You have the following options:

  • Auto-update - Set this parameter to LATEST. AWS OpsWorks automatically installs new agent versions on the stack's instances as soon as they are available.

  • Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks then automatically installs that version on the stack's instances.

The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

" } } }, "CloneStackResult":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The cloned stack ID.

" } }, "documentation":"

Contains the response to a CloneStack request.

" }, "Command":{ "type":"structure", "members":{ "CommandId":{ "shape":"String", "documentation":"

The command ID.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance where the command was executed.

" }, "DeploymentId":{ "shape":"String", "documentation":"

The command deployment ID.

" }, "CreatedAt":{ "shape":"DateTime", "documentation":"

Date and time when the command was run.

" }, "AcknowledgedAt":{ "shape":"DateTime", "documentation":"

Date and time when the command was acknowledged.

" }, "CompletedAt":{ "shape":"DateTime", "documentation":"

Date when the command completed.

" }, "Status":{ "shape":"String", "documentation":"

The command status:

  • failed

  • successful

  • skipped

  • pending

" }, "ExitCode":{ "shape":"Integer", "documentation":"

The command exit code.

" }, "LogUrl":{ "shape":"String", "documentation":"

The URL of the command log.

" }, "Type":{ "shape":"String", "documentation":"

The command type:

  • deploy

  • rollback

  • start

  • stop

  • restart

  • undeploy

  • update_dependencies

  • install_dependencies

  • update_custom_cookbooks

  • execute_recipes

" } }, "documentation":"

Describes a command.

" }, "Commands":{ "type":"list", "member":{"shape":"Command"} }, "CreateAppRequest":{ "type":"structure", "required":[ "StackId", "Name", "Type" ], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "Shortname":{ "shape":"String", "documentation":"

The app's short name.

" }, "Name":{ "shape":"String", "documentation":"

The app name.

" }, "Description":{ "shape":"String", "documentation":"

A description of the app.

" }, "DataSources":{ "shape":"DataSources", "documentation":"

The app's data source.

" }, "Type":{ "shape":"AppType", "documentation":"

The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify other.

" }, "AppSource":{ "shape":"Source", "documentation":"

A Source object that specifies the app repository.

" }, "Domains":{ "shape":"Strings", "documentation":"

The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

" }, "EnableSsl":{ "shape":"Boolean", "documentation":"

Whether to enable SSL for the app.

" }, "SslConfiguration":{ "shape":"SslConfiguration", "documentation":"

An SslConfiguration object with the SSL configuration.

" }, "Attributes":{ "shape":"AppAttributes", "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" }, "Environment":{ "shape":"EnvironmentVariables", "documentation":"

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instance. For more information, see Environment Variables.

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, \"Environment: is too large (maximum is 10KB).\"

This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version.

" } } }, "CreateAppResult":{ "type":"structure", "members":{ "AppId":{ "shape":"String", "documentation":"

The app ID.

" } }, "documentation":"

Contains the response to a CreateApp request.

" }, "CreateDeploymentRequest":{ "type":"structure", "required":[ "StackId", "Command" ], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "AppId":{ "shape":"String", "documentation":"

The app ID. This parameter is required for app deployments, but not for other deployment commands.

" }, "InstanceIds":{ "shape":"Strings", "documentation":"

The instance IDs for the deployment targets.

" }, "LayerIds":{ "shape":"Strings", "documentation":"

The layer IDs for the deployment targets.

" }, "Command":{ "shape":"DeploymentCommand", "documentation":"

A DeploymentCommand object that specifies the deployment command and any associated arguments.

" }, "Comment":{ "shape":"String", "documentation":"

A user-defined comment.

" }, "CustomJson":{ "shape":"String", "documentation":"

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

" } } }, "CreateDeploymentResult":{ "type":"structure", "members":{ "DeploymentId":{ "shape":"String", "documentation":"

The deployment ID, which can be used with other requests to identify the deployment.

" } }, "documentation":"

Contains the response to a CreateDeployment request.

" }, "CreateInstanceRequest":{ "type":"structure", "required":[ "StackId", "LayerIds", "InstanceType" ], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "LayerIds":{ "shape":"Strings", "documentation":"

An array that contains the instance's layer IDs.

" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

" }, "AutoScalingType":{ "shape":"AutoScalingType", "documentation":"

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

" }, "Hostname":{ "shape":"String", "documentation":"

The instance host name.

" }, "Os":{ "shape":"String", "documentation":"

The instance's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom.

For more information on the supported operating systems, see AWS OpsWorks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information on the supported operating systems, see Operating SystemsFor more information on how to use custom AMIs with AWS OpsWorks, see Using Custom AMIs.

" }, "AmiId":{ "shape":"String", "documentation":"

A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.

If you specify a custom AMI, you must set Os to Custom.

" }, "SshKeyName":{ "shape":"String", "documentation":"

The instance's Amazon EC2 key-pair name.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The instance Availability Zone. For more information, see Regions and Endpoints.

" }, "VirtualizationType":{ "shape":"String", "documentation":"

The instance's virtualization type, paravirtual or hvm.

" }, "SubnetId":{ "shape":"String", "documentation":"

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks to launch the instance in a different subnet.

" }, "Architecture":{ "shape":"Architecture", "documentation":"

The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

" }, "RootDeviceType":{ "shape":"RootDeviceType", "documentation":"

The instance root device type. For more information, see Storage for the Root Device.

" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappings", "documentation":"

An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.

" }, "InstallUpdatesOnBoot":{ "shape":"Boolean", "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true to ensure that your instances have the latest security updates.

" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Whether to create an Amazon EBS-optimized instance.

" }, "AgentVersion":{ "shape":"String", "documentation":"

The default AWS OpsWorks agent version. You have the following options:

  • INHERIT - Use the stack's default agent version setting.

  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks then automatically installs that version on the instance.

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.

" }, "Tenancy":{ "shape":"String", "documentation":"

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

" } } }, "CreateInstanceResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" } }, "documentation":"

Contains the response to a CreateInstance request.

" }, "CreateLayerRequest":{ "type":"structure", "required":[ "StackId", "Type", "Name", "Shortname" ], "members":{ "StackId":{ "shape":"String", "documentation":"

The layer stack ID.

" }, "Type":{ "shape":"LayerType", "documentation":"

The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks.

" }, "Name":{ "shape":"String", "documentation":"

The layer name, which is used by the console.

" }, "Shortname":{ "shape":"String", "documentation":"

For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference.

" }, "Attributes":{ "shape":"LayerAttributes", "documentation":"

One or more user-defined key-value pairs to be added to the stack attributes.

To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.

" }, "CustomInstanceProfileArn":{ "shape":"String", "documentation":"

The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" }, "CustomJson":{ "shape":"String", "documentation":"

A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI.

" }, "CustomSecurityGroupIds":{ "shape":"Strings", "documentation":"

An array containing the layer custom security group IDs.

" }, "Packages":{ "shape":"Strings", "documentation":"

An array of Package objects that describes the layer packages.

" }, "VolumeConfigurations":{ "shape":"VolumeConfigurations", "documentation":"

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" }, "EnableAutoHealing":{ "shape":"Boolean", "documentation":"

Whether to disable auto healing for the layer.

" }, "AutoAssignElasticIps":{ "shape":"Boolean", "documentation":"

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

" }, "AutoAssignPublicIps":{ "shape":"Boolean", "documentation":"

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.

" }, "CustomRecipes":{ "shape":"Recipes", "documentation":"

A LayerCustomRecipes object that specifies the layer custom recipes.

" }, "InstallUpdatesOnBoot":{ "shape":"Boolean", "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

To ensure that your instances have the latest security updates, we strongly recommend using the default value of true.

" }, "UseEbsOptimizedInstances":{ "shape":"Boolean", "documentation":"

Whether to use Amazon EBS-optimized instances.

" }, "LifecycleEventConfiguration":{ "shape":"LifecycleEventConfiguration", "documentation":"

A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

" } } }, "CreateLayerResult":{ "type":"structure", "members":{ "LayerId":{ "shape":"String", "documentation":"

The layer ID.

" } }, "documentation":"

Contains the response to a CreateLayer request.

" }, "CreateStackRequest":{ "type":"structure", "required":[ "Name", "Region", "ServiceRoleArn", "DefaultInstanceProfileArn" ], "members":{ "Name":{ "shape":"String", "documentation":"

The stack name.

" }, "Region":{ "shape":"String", "documentation":"

The stack's AWS region, such as \"ap-south-1\". For more information about Amazon regions, see Regions and Endpoints.

" }, "VpcId":{ "shape":"String", "documentation":"

The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.

  • If your account supports EC2-Classic, the default value is no VPC.

  • If your account does not support EC2-Classic, the default value is the default VPC for the specified region.

If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

If you specify a nondefault VPC ID, note the following:

  • It must belong to a VPC in your account that is in the specified region.

  • You must specify a value for DefaultSubnetId.

For more information on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2-Classic, see Supported Platforms.

" }, "Attributes":{ "shape":"StackAttributes", "documentation":"

One or more user-defined key-value pairs to be added to the stack attributes.

" }, "ServiceRoleArn":{ "shape":"String", "documentation":"

The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.

" }, "DefaultInstanceProfileArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (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 Using Identifiers.

" }, "DefaultOs":{ "shape":"String", "documentation":"

The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs.

The default option is the current Amazon Linux version. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.

" }, "HostnameTheme":{ "shape":"String", "documentation":"

The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

  • Baked_Goods

  • Clouds

  • Europe_Cities

  • Fruits

  • Greek_Deities

  • Legendary_creatures_from_Japan

  • Planets_and_Moons

  • Roman_Deities

  • Scottish_Islands

  • US_Cities

  • Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

" }, "DefaultAvailabilityZone":{ "shape":"String", "documentation":"

The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.

" }, "DefaultSubnetId":{ "shape":"String", "documentation":"

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

" }, "CustomJson":{ "shape":"String", "documentation":"

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

" }, "ConfigurationManager":{ "shape":"StackConfigurationManager", "documentation":"

The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 11.4.

" }, "ChefConfiguration":{ "shape":"ChefConfiguration", "documentation":"

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" }, "UseCustomCookbooks":{ "shape":"Boolean", "documentation":"

Whether the stack uses custom cookbooks.

" }, "UseOpsworksSecurityGroups":{ "shape":"Boolean", "documentation":"

Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.

AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

  • True - AWS OpsWorks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

  • False - AWS OpsWorks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

" }, "CustomCookbooksSource":{"shape":"Source"}, "DefaultSshKeyName":{ "shape":"String", "documentation":"

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

" }, "DefaultRootDeviceType":{ "shape":"RootDeviceType", "documentation":"

The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store. For more information, see Storage for the Root Device.

" }, "AgentVersion":{ "shape":"String", "documentation":"

The default AWS OpsWorks agent version. You have the following options:

  • Auto-update - Set this parameter to LATEST. AWS OpsWorks automatically installs new agent versions on the stack's instances as soon as they are available.

  • Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks then automatically installs that version on the stack's instances.

The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

" } } }, "CreateStackResult":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID, which is an opaque string that you use to identify the stack when performing actions such as DescribeStacks.

" } }, "documentation":"

Contains the response to a CreateStack request.

" }, "CreateUserProfileRequest":{ "type":"structure", "required":["IamUserArn"], "members":{ "IamUserArn":{ "shape":"String", "documentation":"

The user's IAM ARN; this can also be a federated user's ARN.

" }, "SshUsername":{ "shape":"String", "documentation":"

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks generates one from the IAM user name.

" }, "SshPublicKey":{ "shape":"String", "documentation":"

The user's public SSH key.

" }, "AllowSelfManagement":{ "shape":"Boolean", "documentation":"

Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User's Public SSH Key.

" } } }, "CreateUserProfileResult":{ "type":"structure", "members":{ "IamUserArn":{ "shape":"String", "documentation":"

The user's IAM ARN.

" } }, "documentation":"

Contains the response to a CreateUserProfile request.

" }, "DailyAutoScalingSchedule":{ "type":"map", "key":{"shape":"Hour"}, "value":{"shape":"Switch"} }, "DataSource":{ "type":"structure", "members":{ "Type":{ "shape":"String", "documentation":"

The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, or RdsDbInstance.

" }, "Arn":{ "shape":"String", "documentation":"

The data source's ARN.

" }, "DatabaseName":{ "shape":"String", "documentation":"

The database name.

" } }, "documentation":"

Describes an app's data source.

" }, "DataSources":{ "type":"list", "member":{"shape":"DataSource"} }, "DateTime":{"type":"string"}, "DeleteAppRequest":{ "type":"structure", "required":["AppId"], "members":{ "AppId":{ "shape":"String", "documentation":"

The app ID.

" } } }, "DeleteInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "DeleteElasticIp":{ "shape":"Boolean", "documentation":"

Whether to delete the instance Elastic IP address.

" }, "DeleteVolumes":{ "shape":"Boolean", "documentation":"

Whether to delete the instance's Amazon EBS volumes.

" } } }, "DeleteLayerRequest":{ "type":"structure", "required":["LayerId"], "members":{ "LayerId":{ "shape":"String", "documentation":"

The layer ID.

" } } }, "DeleteStackRequest":{ "type":"structure", "required":["StackId"], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" } } }, "DeleteUserProfileRequest":{ "type":"structure", "required":["IamUserArn"], "members":{ "IamUserArn":{ "shape":"String", "documentation":"

The user's IAM ARN. This can also be a federated user's ARN.

" } } }, "Deployment":{ "type":"structure", "members":{ "DeploymentId":{ "shape":"String", "documentation":"

The deployment ID.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "AppId":{ "shape":"String", "documentation":"

The app ID.

" }, "CreatedAt":{ "shape":"DateTime", "documentation":"

Date when the deployment was created.

" }, "CompletedAt":{ "shape":"DateTime", "documentation":"

Date when the deployment completed.

" }, "Duration":{ "shape":"Integer", "documentation":"

The deployment duration.

" }, "IamUserArn":{ "shape":"String", "documentation":"

The user's IAM ARN.

" }, "Comment":{ "shape":"String", "documentation":"

A user-defined comment.

" }, "Command":{"shape":"DeploymentCommand"}, "Status":{ "shape":"String", "documentation":"

The deployment status:

  • running

  • successful

  • failed

" }, "CustomJson":{ "shape":"String", "documentation":"

A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

" }, "InstanceIds":{ "shape":"Strings", "documentation":"

The IDs of the target instances.

" } }, "documentation":"

Describes a deployment of a stack or app.

" }, "DeploymentCommand":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"DeploymentCommandName", "documentation":"

Specifies the operation. You can specify only one command.

For stacks, the following commands are available:

  • execute_recipes: Execute one or more recipes. To specify the recipes, set an Args parameter named recipes to the list of recipes to be executed. For example, to execute phpapp::appsetup, set Args to {\"recipes\":[\"phpapp::appsetup\"]}.

  • install_dependencies: Install the stack's dependencies.

  • update_custom_cookbooks: Update the stack's custom cookbooks.

  • update_dependencies: Update the stack's dependencies.

The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing.

For apps, the following commands are available:

  • deploy: Deploy an app. Ruby on Rails apps have an optional Args parameter named migrate. Set Args to {\"migrate\":[\"true\"]} to migrate the database. The default setting is {\"migrate\":[\"false\"]}.

  • rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions.

  • start: Start the app's web or application server.

  • stop: Stop the app's web or application server.

  • restart: Restart the app's web or application server.

  • undeploy: Undeploy the app.

" }, "Args":{ "shape":"DeploymentCommandArgs", "documentation":"

The arguments of those commands that take arguments. It should be set to a JSON object with the following format:

{\"arg_name1\" : [\"value1\", \"value2\", ...], \"arg_name2\" : [\"value1\", \"value2\", ...], ...}

The update_dependencies command takes two arguments:

  • upgrade_os_to - Specifies the desired Amazon Linux version for instances whose OS you want to upgrade, such as Amazon Linux 2014.09. You must also set the allow_reboot argument to true.

  • allow_reboot - Specifies whether to allow AWS OpsWorks to reboot the instances if necessary, after installing the updates. This argument can be set to either true or false. The default value is false.

For example, to upgrade an instance to Amazon Linux 2014.09, set Args to the following.

{ \"upgrade_os_to\":[\"Amazon Linux 2014.09\"], \"allow_reboot\":[\"true\"] }

" } }, "documentation":"

Used to specify a stack or deployment command.

" }, "DeploymentCommandArgs":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"Strings"} }, "DeploymentCommandName":{ "type":"string", "enum":[ "install_dependencies", "update_dependencies", "update_custom_cookbooks", "execute_recipes", "configure", "setup", "deploy", "rollback", "start", "stop", "restart", "undeploy" ] }, "Deployments":{ "type":"list", "member":{"shape":"Deployment"} }, "DeregisterEcsClusterRequest":{ "type":"structure", "required":["EcsClusterArn"], "members":{ "EcsClusterArn":{ "shape":"String", "documentation":"

The cluster's ARN.

" } } }, "DeregisterElasticIpRequest":{ "type":"structure", "required":["ElasticIp"], "members":{ "ElasticIp":{ "shape":"String", "documentation":"

The Elastic IP address.

" } } }, "DeregisterInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" } } }, "DeregisterRdsDbInstanceRequest":{ "type":"structure", "required":["RdsDbInstanceArn"], "members":{ "RdsDbInstanceArn":{ "shape":"String", "documentation":"

The Amazon RDS instance's ARN.

" } } }, "DeregisterVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "VolumeId":{ "shape":"String", "documentation":"

The AWS OpsWorks volume ID, which is the GUID that AWS OpsWorks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID.

" } } }, "DescribeAgentVersionsRequest":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "ConfigurationManager":{ "shape":"StackConfigurationManager", "documentation":"

The configuration manager.

" } } }, "DescribeAgentVersionsResult":{ "type":"structure", "members":{ "AgentVersions":{ "shape":"AgentVersions", "documentation":"

The agent versions for the specified stack or configuration manager. Note that this value is the complete version number, not the abbreviated number used by the console.

" } }, "documentation":"

Contains the response to a DescribeAgentVersions request.

" }, "DescribeAppsRequest":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

" }, "AppIds":{ "shape":"Strings", "documentation":"

An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

" } } }, "DescribeAppsResult":{ "type":"structure", "members":{ "Apps":{ "shape":"Apps", "documentation":"

An array of App objects that describe the specified apps.

" } }, "documentation":"

Contains the response to a DescribeApps request.

" }, "DescribeCommandsRequest":{ "type":"structure", "members":{ "DeploymentId":{ "shape":"String", "documentation":"

The deployment ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified deployment.

" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified instance.

" }, "CommandIds":{ "shape":"Strings", "documentation":"

An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands. Otherwise, it returns a description of every command.

" } } }, "DescribeCommandsResult":{ "type":"structure", "members":{ "Commands":{ "shape":"Commands", "documentation":"

An array of Command objects that describe each of the specified commands.

" } }, "documentation":"

Contains the response to a DescribeCommands request.

" }, "DescribeDeploymentsRequest":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.

" }, "AppId":{ "shape":"String", "documentation":"

The app ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified app.

" }, "DeploymentIds":{ "shape":"Strings", "documentation":"

An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

" } } }, "DescribeDeploymentsResult":{ "type":"structure", "members":{ "Deployments":{ "shape":"Deployments", "documentation":"

An array of Deployment objects that describe the deployments.

" } }, "documentation":"

Contains the response to a DescribeDeployments request.

" }, "DescribeEcsClustersRequest":{ "type":"structure", "members":{ "EcsClusterArns":{ "shape":"Strings", "documentation":"

A list of ARNs, one for each cluster to be described.

" }, "StackId":{ "shape":"String", "documentation":"

A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

" }, "NextToken":{ "shape":"String", "documentation":"

If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

" }, "MaxResults":{ "shape":"Integer", "documentation":"

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

" } } }, "DescribeEcsClustersResult":{ "type":"structure", "members":{ "EcsClusters":{ "shape":"EcsClusters", "documentation":"

A list of EcsCluster objects containing the cluster descriptions.

" }, "NextToken":{ "shape":"String", "documentation":"

If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object's NextToken parameter to retrieve the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to null.

" } }, "documentation":"

Contains the response to a DescribeEcsClusters request.

" }, "DescribeElasticIpsRequest":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

" }, "StackId":{ "shape":"String", "documentation":"

A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

" }, "Ips":{ "shape":"Strings", "documentation":"

An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

" } } }, "DescribeElasticIpsResult":{ "type":"structure", "members":{ "ElasticIps":{ "shape":"ElasticIps", "documentation":"

An ElasticIps object that describes the specified Elastic IP addresses.

" } }, "documentation":"

Contains the response to a DescribeElasticIps request.

" }, "DescribeElasticLoadBalancersRequest":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

A stack ID. The action describes the stack's Elastic Load Balancing instances.

" }, "LayerIds":{ "shape":"Strings", "documentation":"

A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.

" } } }, "DescribeElasticLoadBalancersResult":{ "type":"structure", "members":{ "ElasticLoadBalancers":{ "shape":"ElasticLoadBalancers", "documentation":"

A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.

" } }, "documentation":"

Contains the response to a DescribeElasticLoadBalancers request.

" }, "DescribeInstancesRequest":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

" }, "LayerId":{ "shape":"String", "documentation":"

A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

" }, "InstanceIds":{ "shape":"Strings", "documentation":"

An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

" } } }, "DescribeInstancesResult":{ "type":"structure", "members":{ "Instances":{ "shape":"Instances", "documentation":"

An array of Instance objects that describe the instances.

" } }, "documentation":"

Contains the response to a DescribeInstances request.

" }, "DescribeLayersRequest":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "LayerIds":{ "shape":"Strings", "documentation":"

An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.

" } } }, "DescribeLayersResult":{ "type":"structure", "members":{ "Layers":{ "shape":"Layers", "documentation":"

An array of Layer objects that describe the layers.

" } }, "documentation":"

Contains the response to a DescribeLayers request.

" }, "DescribeLoadBasedAutoScalingRequest":{ "type":"structure", "required":["LayerIds"], "members":{ "LayerIds":{ "shape":"Strings", "documentation":"

An array of layer IDs.

" } } }, "DescribeLoadBasedAutoScalingResult":{ "type":"structure", "members":{ "LoadBasedAutoScalingConfigurations":{ "shape":"LoadBasedAutoScalingConfigurations", "documentation":"

An array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration.

" } }, "documentation":"

Contains the response to a DescribeLoadBasedAutoScaling request.

" }, "DescribeMyUserProfileResult":{ "type":"structure", "members":{ "UserProfile":{ "shape":"SelfUserProfile", "documentation":"

A UserProfile object that describes the user's SSH information.

" } }, "documentation":"

Contains the response to a DescribeMyUserProfile request.

" }, "DescribePermissionsRequest":{ "type":"structure", "members":{ "IamUserArn":{ "shape":"String", "documentation":"

The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM ARNs, see Using Identifiers.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" } } }, "DescribePermissionsResult":{ "type":"structure", "members":{ "Permissions":{ "shape":"Permissions", "documentation":"

An array of Permission objects that describe the stack permissions.

  • If the request object contains only a stack ID, the array contains a Permission object with permissions for each of the stack IAM ARNs.

  • If the request object contains only an IAM ARN, the array contains a Permission object with permissions for each of the user's stack IDs.

  • If the request contains a stack ID and an IAM ARN, the array contains a single Permission object with permissions for the specified stack and IAM ARN.

" } }, "documentation":"

Contains the response to a DescribePermissions request.

" }, "DescribeRaidArraysRequest":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID arrays associated with the specified instance.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "RaidArrayIds":{ "shape":"Strings", "documentation":"

An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns descriptions of the specified arrays. Otherwise, it returns a description of every array.

" } } }, "DescribeRaidArraysResult":{ "type":"structure", "members":{ "RaidArrays":{ "shape":"RaidArrays", "documentation":"

A RaidArrays object that describes the specified RAID arrays.

" } }, "documentation":"

Contains the response to a DescribeRaidArrays request.

" }, "DescribeRdsDbInstancesRequest":{ "type":"structure", "required":["StackId"], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID that the instances are registered with. The operation returns descriptions of all registered Amazon RDS instances.

" }, "RdsDbInstanceArns":{ "shape":"Strings", "documentation":"

An array containing the ARNs of the instances to be described.

" } } }, "DescribeRdsDbInstancesResult":{ "type":"structure", "members":{ "RdsDbInstances":{ "shape":"RdsDbInstances", "documentation":"

An a array of RdsDbInstance objects that describe the instances.

" } }, "documentation":"

Contains the response to a DescribeRdsDbInstances request.

" }, "DescribeServiceErrorsRequest":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified stack.

" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified instance.

" }, "ServiceErrorIds":{ "shape":"Strings", "documentation":"

An array of service error IDs. If you use this parameter, DescribeServiceErrors returns descriptions of the specified errors. Otherwise, it returns a description of every error.

" } } }, "DescribeServiceErrorsResult":{ "type":"structure", "members":{ "ServiceErrors":{ "shape":"ServiceErrors", "documentation":"

An array of ServiceError objects that describe the specified service errors.

" } }, "documentation":"

Contains the response to a DescribeServiceErrors request.

" }, "DescribeStackProvisioningParametersRequest":{ "type":"structure", "required":["StackId"], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID

" } } }, "DescribeStackProvisioningParametersResult":{ "type":"structure", "members":{ "AgentInstallerUrl":{ "shape":"String", "documentation":"

The AWS OpsWorks agent installer's URL.

" }, "Parameters":{ "shape":"Parameters", "documentation":"

An embedded object that contains the provisioning parameters.

" } }, "documentation":"

Contains the response to a DescribeStackProvisioningParameters request.

" }, "DescribeStackSummaryRequest":{ "type":"structure", "required":["StackId"], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" } } }, "DescribeStackSummaryResult":{ "type":"structure", "members":{ "StackSummary":{ "shape":"StackSummary", "documentation":"

A StackSummary object that contains the results.

" } }, "documentation":"

Contains the response to a DescribeStackSummary request.

" }, "DescribeStacksRequest":{ "type":"structure", "members":{ "StackIds":{ "shape":"Strings", "documentation":"

An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.

" } } }, "DescribeStacksResult":{ "type":"structure", "members":{ "Stacks":{ "shape":"Stacks", "documentation":"

An array of Stack objects that describe the stacks.

" } }, "documentation":"

Contains the response to a DescribeStacks request.

" }, "DescribeTimeBasedAutoScalingRequest":{ "type":"structure", "required":["InstanceIds"], "members":{ "InstanceIds":{ "shape":"Strings", "documentation":"

An array of instance IDs.

" } } }, "DescribeTimeBasedAutoScalingResult":{ "type":"structure", "members":{ "TimeBasedAutoScalingConfigurations":{ "shape":"TimeBasedAutoScalingConfigurations", "documentation":"

An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the specified instances.

" } }, "documentation":"

Contains the response to a DescribeTimeBasedAutoScaling request.

" }, "DescribeUserProfilesRequest":{ "type":"structure", "members":{ "IamUserArns":{ "shape":"Strings", "documentation":"

An array of IAM or federated user ARNs that identify the users to be described.

" } } }, "DescribeUserProfilesResult":{ "type":"structure", "members":{ "UserProfiles":{ "shape":"UserProfiles", "documentation":"

A Users object that describes the specified users.

" } }, "documentation":"

Contains the response to a DescribeUserProfiles request.

" }, "DescribeVolumesRequest":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

" }, "StackId":{ "shape":"String", "documentation":"

A stack ID. The action describes the stack's registered Amazon EBS volumes.

" }, "RaidArrayId":{ "shape":"String", "documentation":"

The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

" }, "VolumeIds":{ "shape":"Strings", "documentation":"

Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

" } } }, "DescribeVolumesResult":{ "type":"structure", "members":{ "Volumes":{ "shape":"Volumes", "documentation":"

An array of volume IDs.

" } }, "documentation":"

Contains the response to a DescribeVolumes request.

" }, "DetachElasticLoadBalancerRequest":{ "type":"structure", "required":[ "ElasticLoadBalancerName", "LayerId" ], "members":{ "ElasticLoadBalancerName":{ "shape":"String", "documentation":"

The Elastic Load Balancing instance's name.

" }, "LayerId":{ "shape":"String", "documentation":"

The ID of the layer that the Elastic Load Balancing instance is attached to.

" } } }, "DisassociateElasticIpRequest":{ "type":"structure", "required":["ElasticIp"], "members":{ "ElasticIp":{ "shape":"String", "documentation":"

The Elastic IP address.

" } } }, "Double":{ "type":"double", "box":true }, "EbsBlockDevice":{ "type":"structure", "members":{ "SnapshotId":{ "shape":"String", "documentation":"

The snapshot ID.

" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.

" }, "VolumeSize":{ "shape":"Integer", "documentation":"

The volume size, in GiB. For more information, see EbsBlockDevice.

" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

" }, "DeleteOnTermination":{ "shape":"Boolean", "documentation":"

Whether the volume is deleted on instance termination.

" } }, "documentation":"

Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 EbsBlockDevice data type.

" }, "EcsCluster":{ "type":"structure", "members":{ "EcsClusterArn":{ "shape":"String", "documentation":"

The cluster's ARN.

" }, "EcsClusterName":{ "shape":"String", "documentation":"

The cluster name.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "RegisteredAt":{ "shape":"DateTime", "documentation":"

The time and date that the cluster was registered with the stack.

" } }, "documentation":"

Describes a registered Amazon ECS cluster.

" }, "EcsClusters":{ "type":"list", "member":{"shape":"EcsCluster"} }, "ElasticIp":{ "type":"structure", "members":{ "Ip":{ "shape":"String", "documentation":"

The IP address.

" }, "Name":{ "shape":"String", "documentation":"

The name.

" }, "Domain":{ "shape":"String", "documentation":"

The domain.

" }, "Region":{ "shape":"String", "documentation":"

The AWS region. For more information, see Regions and Endpoints.

" }, "InstanceId":{ "shape":"String", "documentation":"

The ID of the instance that the address is attached to.

" } }, "documentation":"

Describes an Elastic IP address.

" }, "ElasticIps":{ "type":"list", "member":{"shape":"ElasticIp"} }, "ElasticLoadBalancer":{ "type":"structure", "members":{ "ElasticLoadBalancerName":{ "shape":"String", "documentation":"

The Elastic Load Balancing instance's name.

" }, "Region":{ "shape":"String", "documentation":"

The instance's AWS region.

" }, "DnsName":{ "shape":"String", "documentation":"

The instance's public DNS name.

" }, "StackId":{ "shape":"String", "documentation":"

The ID of the stack that the instance is associated with.

" }, "LayerId":{ "shape":"String", "documentation":"

The ID of the layer that the instance is attached to.

" }, "VpcId":{ "shape":"String", "documentation":"

The VPC ID.

" }, "AvailabilityZones":{ "shape":"Strings", "documentation":"

A list of Availability Zones.

" }, "SubnetIds":{ "shape":"Strings", "documentation":"

A list of subnet IDs, if the stack is running in a VPC.

" }, "Ec2InstanceIds":{ "shape":"Strings", "documentation":"

A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.

" } }, "documentation":"

Describes an Elastic Load Balancing instance.

" }, "ElasticLoadBalancers":{ "type":"list", "member":{"shape":"ElasticLoadBalancer"} }, "EnvironmentVariable":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"String", "documentation":"

(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.

" }, "Value":{ "shape":"String", "documentation":"

(Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable.

" }, "Secure":{ "shape":"Boolean", "documentation":"

(Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an environment variable's value, set Secure to true. DescribeApps then returns *****FILTERED***** instead of the actual value. The default value for Secure is false.

" } }, "documentation":"

Represents an app's environment variable.

" }, "EnvironmentVariables":{ "type":"list", "member":{"shape":"EnvironmentVariable"} }, "GetHostnameSuggestionRequest":{ "type":"structure", "required":["LayerId"], "members":{ "LayerId":{ "shape":"String", "documentation":"

The layer ID.

" } } }, "GetHostnameSuggestionResult":{ "type":"structure", "members":{ "LayerId":{ "shape":"String", "documentation":"

The layer ID.

" }, "Hostname":{ "shape":"String", "documentation":"

The generated host name.

" } }, "documentation":"

Contains the response to a GetHostnameSuggestion request.

" }, "GrantAccessRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance's AWS OpsWorks ID.

" }, "ValidForInMinutes":{ "shape":"ValidForInMinutes", "documentation":"

The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out.

" } } }, "GrantAccessResult":{ "type":"structure", "members":{ "TemporaryCredential":{ "shape":"TemporaryCredential", "documentation":"

A TemporaryCredential object that contains the data needed to log in to the instance by RDP clients, such as the Microsoft Remote Desktop Connection.

" } }, "documentation":"

Contains the response to a GrantAccess request.

" }, "Hour":{"type":"string"}, "Instance":{ "type":"structure", "members":{ "AgentVersion":{ "shape":"String", "documentation":"

The agent version. This parameter is set to INHERIT if the instance inherits the default stack setting or to a a version number for a fixed agent version.

" }, "AmiId":{ "shape":"String", "documentation":"

A custom AMI ID to be used to create the instance. For more information, see Instances

" }, "Architecture":{ "shape":"Architecture", "documentation":"

The instance architecture: \"i386\" or \"x86_64\".

" }, "AutoScalingType":{ "shape":"AutoScalingType", "documentation":"

For load-based or time-based instances, the type.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The instance Availability Zone. For more information, see Regions and Endpoints.

" }, "BlockDeviceMappings":{ "shape":"BlockDeviceMappings", "documentation":"

An array of BlockDeviceMapping objects that specify the instance's block device mappings.

" }, "CreatedAt":{ "shape":"DateTime", "documentation":"

The time that the instance was created.

" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

Whether this is an Amazon EBS-optimized instance.

" }, "Ec2InstanceId":{ "shape":"String", "documentation":"

The ID of the associated Amazon EC2 instance.

" }, "EcsClusterArn":{ "shape":"String", "documentation":"

For container instances, the Amazon ECS cluster's ARN.

" }, "EcsContainerInstanceArn":{ "shape":"String", "documentation":"

For container instances, the instance's ARN.

" }, "ElasticIp":{ "shape":"String", "documentation":"

The instance Elastic IP address .

" }, "Hostname":{ "shape":"String", "documentation":"

The instance host name.

" }, "InfrastructureClass":{ "shape":"String", "documentation":"

For registered instances, the infrastructure class: ec2 or on-premises.

" }, "InstallUpdatesOnBoot":{ "shape":"Boolean", "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "InstanceProfileArn":{ "shape":"String", "documentation":"

The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.

" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type, such as t2.micro.

" }, "LastServiceErrorId":{ "shape":"String", "documentation":"

The ID of the last service error. For more information, call DescribeServiceErrors.

" }, "LayerIds":{ "shape":"Strings", "documentation":"

An array containing the instance layer IDs.

" }, "Os":{ "shape":"String", "documentation":"

The instance's operating system.

" }, "Platform":{ "shape":"String", "documentation":"

The instance's platform.

" }, "PrivateDns":{ "shape":"String", "documentation":"

The The instance's private DNS name.

" }, "PrivateIp":{ "shape":"String", "documentation":"

The instance's private IP address.

" }, "PublicDns":{ "shape":"String", "documentation":"

The instance public DNS name.

" }, "PublicIp":{ "shape":"String", "documentation":"

The instance public IP address.

" }, "RegisteredBy":{ "shape":"String", "documentation":"

For registered instances, who performed the registration.

" }, "ReportedAgentVersion":{ "shape":"String", "documentation":"

The instance's reported AWS OpsWorks agent version.

" }, "ReportedOs":{ "shape":"ReportedOs", "documentation":"

For registered instances, the reported operating system.

" }, "RootDeviceType":{ "shape":"RootDeviceType", "documentation":"

The instance's root device type. For more information, see Storage for the Root Device.

" }, "RootDeviceVolumeId":{ "shape":"String", "documentation":"

The root device volume ID.

" }, "SecurityGroupIds":{ "shape":"Strings", "documentation":"

An array containing the instance security group IDs.

" }, "SshHostDsaKeyFingerprint":{ "shape":"String", "documentation":"

The SSH key's Deep Security Agent (DSA) fingerprint.

" }, "SshHostRsaKeyFingerprint":{ "shape":"String", "documentation":"

The SSH key's RSA fingerprint.

" }, "SshKeyName":{ "shape":"String", "documentation":"

The instance's Amazon EC2 key-pair name.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "Status":{ "shape":"String", "documentation":"

The instance status:

  • booting

  • connection_lost

  • online

  • pending

  • rebooting

  • requested

  • running_setup

  • setup_failed

  • shutting_down

  • start_failed

  • stop_failed

  • stopped

  • stopping

  • terminated

  • terminating

" }, "SubnetId":{ "shape":"String", "documentation":"

The instance's subnet ID; applicable only if the stack is running in a VPC.

" }, "Tenancy":{ "shape":"String", "documentation":"

The instance's tenancy option, such as dedicated or host.

" }, "VirtualizationType":{ "shape":"VirtualizationType", "documentation":"

The instance's virtualization type: paravirtual or hvm.

" } }, "documentation":"

Describes an instance.

" }, "InstanceIdentity":{ "type":"structure", "members":{ "Document":{ "shape":"String", "documentation":"

A JSON document that contains the metadata.

" }, "Signature":{ "shape":"String", "documentation":"

A signature that can be used to verify the document's accuracy and authenticity.

" } }, "documentation":"

Contains a description of an Amazon EC2 instance from the Amazon EC2 metadata service. For more information, see Instance Metadata and User Data.

" }, "Instances":{ "type":"list", "member":{"shape":"Instance"} }, "InstancesCount":{ "type":"structure", "members":{ "Assigning":{ "shape":"Integer", "documentation":"

The number of instances in the Assigning state.

" }, "Booting":{ "shape":"Integer", "documentation":"

The number of instances with booting status.

" }, "ConnectionLost":{ "shape":"Integer", "documentation":"

The number of instances with connection_lost status.

" }, "Deregistering":{ "shape":"Integer", "documentation":"

The number of instances in the Deregistering state.

" }, "Online":{ "shape":"Integer", "documentation":"

The number of instances with online status.

" }, "Pending":{ "shape":"Integer", "documentation":"

The number of instances with pending status.

" }, "Rebooting":{ "shape":"Integer", "documentation":"

The number of instances with rebooting status.

" }, "Registered":{ "shape":"Integer", "documentation":"

The number of instances in the Registered state.

" }, "Registering":{ "shape":"Integer", "documentation":"

The number of instances in the Registering state.

" }, "Requested":{ "shape":"Integer", "documentation":"

The number of instances with requested status.

" }, "RunningSetup":{ "shape":"Integer", "documentation":"

The number of instances with running_setup status.

" }, "SetupFailed":{ "shape":"Integer", "documentation":"

The number of instances with setup_failed status.

" }, "ShuttingDown":{ "shape":"Integer", "documentation":"

The number of instances with shutting_down status.

" }, "StartFailed":{ "shape":"Integer", "documentation":"

The number of instances with start_failed status.

" }, "Stopped":{ "shape":"Integer", "documentation":"

The number of instances with stopped status.

" }, "Stopping":{ "shape":"Integer", "documentation":"

The number of instances with stopping status.

" }, "Terminated":{ "shape":"Integer", "documentation":"

The number of instances with terminated status.

" }, "Terminating":{ "shape":"Integer", "documentation":"

The number of instances with terminating status.

" }, "Unassigning":{ "shape":"Integer", "documentation":"

The number of instances in the Unassigning state.

" } }, "documentation":"

Describes how many instances a stack has for each status.

" }, "Integer":{ "type":"integer", "box":true }, "Layer":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The layer stack ID.

" }, "LayerId":{ "shape":"String", "documentation":"

The layer ID.

" }, "Type":{ "shape":"LayerType", "documentation":"

The layer type.

" }, "Name":{ "shape":"String", "documentation":"

The layer name.

" }, "Shortname":{ "shape":"String", "documentation":"

The layer short name.

" }, "Attributes":{ "shape":"LayerAttributes", "documentation":"

The layer attributes.

For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword attributes, AWS OpsWorks returns *****FILTERED***** instead of the actual value

For an ECS Cluster layer, AWS OpsWorks the EcsClusterArn attribute is set to the cluster's ARN.

" }, "CustomInstanceProfileArn":{ "shape":"String", "documentation":"

The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" }, "CustomJson":{ "shape":"String", "documentation":"

A JSON formatted string containing the layer's custom stack configuration and deployment attributes.

" }, "CustomSecurityGroupIds":{ "shape":"Strings", "documentation":"

An array containing the layer's custom security group IDs.

" }, "DefaultSecurityGroupNames":{ "shape":"Strings", "documentation":"

An array containing the layer's security group names.

" }, "Packages":{ "shape":"Strings", "documentation":"

An array of Package objects that describe the layer's packages.

" }, "VolumeConfigurations":{ "shape":"VolumeConfigurations", "documentation":"

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" }, "EnableAutoHealing":{ "shape":"Boolean", "documentation":"

Whether auto healing is disabled for the layer.

" }, "AutoAssignElasticIps":{ "shape":"Boolean", "documentation":"

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

" }, "AutoAssignPublicIps":{ "shape":"Boolean", "documentation":"

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.

" }, "DefaultRecipes":{"shape":"Recipes"}, "CustomRecipes":{ "shape":"Recipes", "documentation":"

A LayerCustomRecipes object that specifies the layer's custom recipes.

" }, "CreatedAt":{ "shape":"DateTime", "documentation":"

Date when the layer was created.

" }, "InstallUpdatesOnBoot":{ "shape":"Boolean", "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

" }, "UseEbsOptimizedInstances":{ "shape":"Boolean", "documentation":"

Whether the layer uses Amazon EBS-optimized instances.

" }, "LifecycleEventConfiguration":{ "shape":"LifecycleEventConfiguration", "documentation":"

A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

" } }, "documentation":"

Describes a layer.

" }, "LayerAttributes":{ "type":"map", "key":{"shape":"LayerAttributesKeys"}, "value":{"shape":"String"} }, "LayerAttributesKeys":{ "type":"string", "enum":[ "EcsClusterArn", "EnableHaproxyStats", "HaproxyStatsUrl", "HaproxyStatsUser", "HaproxyStatsPassword", "HaproxyHealthCheckUrl", "HaproxyHealthCheckMethod", "MysqlRootPassword", "MysqlRootPasswordUbiquitous", "GangliaUrl", "GangliaUser", "GangliaPassword", "MemcachedMemory", "NodejsVersion", "RubyVersion", "RubygemsVersion", "ManageBundler", "BundlerVersion", "RailsStack", "PassengerVersion", "Jvm", "JvmVersion", "JvmOptions", "JavaAppServer", "JavaAppServerVersion" ] }, "LayerType":{ "type":"string", "enum":[ "aws-flow-ruby", "ecs-cluster", "java-app", "lb", "web", "php-app", "rails-app", "nodejs-app", "memcached", "db-master", "monitoring-master", "custom" ] }, "Layers":{ "type":"list", "member":{"shape":"Layer"} }, "LifecycleEventConfiguration":{ "type":"structure", "members":{ "Shutdown":{ "shape":"ShutdownEventConfiguration", "documentation":"

A ShutdownEventConfiguration object that specifies the Shutdown event configuration.

" } }, "documentation":"

Specifies the lifecycle event configuration

" }, "LoadBasedAutoScalingConfiguration":{ "type":"structure", "members":{ "LayerId":{ "shape":"String", "documentation":"

The layer ID.

" }, "Enable":{ "shape":"Boolean", "documentation":"

Whether load-based auto scaling is enabled for the layer.

" }, "UpScaling":{ "shape":"AutoScalingThresholds", "documentation":"

An AutoScalingThresholds object that describes the upscaling configuration, which defines how and when AWS OpsWorks increases the number of instances.

" }, "DownScaling":{ "shape":"AutoScalingThresholds", "documentation":"

An AutoScalingThresholds object that describes the downscaling configuration, which defines how and when AWS OpsWorks reduces the number of instances.

" } }, "documentation":"

Describes a layer's load-based auto scaling configuration.

" }, "LoadBasedAutoScalingConfigurations":{ "type":"list", "member":{"shape":"LoadBasedAutoScalingConfiguration"} }, "Minute":{ "type":"integer", "box":true, "max":100, "min":1 }, "Parameters":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "Permission":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

A stack ID.

" }, "IamUserArn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more information about IAM ARNs, see Using Identifiers.

" }, "AllowSsh":{ "shape":"Boolean", "documentation":"

Whether the user can use SSH.

" }, "AllowSudo":{ "shape":"Boolean", "documentation":"

Whether the user can use sudo.

" }, "Level":{ "shape":"String", "documentation":"

The user's permission level, which must be the following:

  • deny

  • show

  • deploy

  • manage

  • iam_only

For more information on the permissions associated with these levels, see Managing User Permissions

" } }, "documentation":"

Describes stack or user permissions.

" }, "Permissions":{ "type":"list", "member":{"shape":"Permission"} }, "RaidArray":{ "type":"structure", "members":{ "RaidArrayId":{ "shape":"String", "documentation":"

The array ID.

" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "Name":{ "shape":"String", "documentation":"

The array name.

" }, "RaidLevel":{ "shape":"Integer", "documentation":"

The RAID level.

" }, "NumberOfDisks":{ "shape":"Integer", "documentation":"

The number of disks in the array.

" }, "Size":{ "shape":"Integer", "documentation":"

The array's size.

" }, "Device":{ "shape":"String", "documentation":"

The array's Linux device. For example /dev/mdadm0.

" }, "MountPoint":{ "shape":"String", "documentation":"

The array's mount point.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The array's Availability Zone. For more information, see Regions and Endpoints.

" }, "CreatedAt":{ "shape":"DateTime", "documentation":"

When the RAID array was created.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "VolumeType":{ "shape":"String", "documentation":"

The volume type, standard or PIOPS.

" }, "Iops":{ "shape":"Integer", "documentation":"

For PIOPS volumes, the IOPS per disk.

" } }, "documentation":"

Describes an instance's RAID array.

" }, "RaidArrays":{ "type":"list", "member":{"shape":"RaidArray"} }, "RdsDbInstance":{ "type":"structure", "members":{ "RdsDbInstanceArn":{ "shape":"String", "documentation":"

The instance's ARN.

" }, "DbInstanceIdentifier":{ "shape":"String", "documentation":"

The DB instance identifier.

" }, "DbUser":{ "shape":"String", "documentation":"

The master user name.

" }, "DbPassword":{ "shape":"String", "documentation":"

AWS OpsWorks returns *****FILTERED***** instead of the actual value.

" }, "Region":{ "shape":"String", "documentation":"

The instance's AWS region.

" }, "Address":{ "shape":"String", "documentation":"

The instance's address.

" }, "Engine":{ "shape":"String", "documentation":"

The instance's database engine.

" }, "StackId":{ "shape":"String", "documentation":"

The ID of the stack that the instance is registered with.

" }, "MissingOnRds":{ "shape":"Boolean", "documentation":"

Set to true if AWS OpsWorks was unable to discover the Amazon RDS instance. AWS OpsWorks attempts to discover the instance only once. If this value is set to true, you must deregister the instance and then register it again.

" } }, "documentation":"

Describes an Amazon RDS instance.

" }, "RdsDbInstances":{ "type":"list", "member":{"shape":"RdsDbInstance"} }, "RebootInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" } } }, "Recipes":{ "type":"structure", "members":{ "Setup":{ "shape":"Strings", "documentation":"

An array of custom recipe names to be run following a setup event.

" }, "Configure":{ "shape":"Strings", "documentation":"

An array of custom recipe names to be run following a configure event.

" }, "Deploy":{ "shape":"Strings", "documentation":"

An array of custom recipe names to be run following a deploy event.

" }, "Undeploy":{ "shape":"Strings", "documentation":"

An array of custom recipe names to be run following a undeploy event.

" }, "Shutdown":{ "shape":"Strings", "documentation":"

An array of custom recipe names to be run following a shutdown event.

" } }, "documentation":"

AWS OpsWorks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS OpsWorks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. AWS OpsWorks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

" }, "RegisterEcsClusterRequest":{ "type":"structure", "required":[ "EcsClusterArn", "StackId" ], "members":{ "EcsClusterArn":{ "shape":"String", "documentation":"

The cluster's ARN.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" } } }, "RegisterEcsClusterResult":{ "type":"structure", "members":{ "EcsClusterArn":{ "shape":"String", "documentation":"

The cluster's ARN.

" } }, "documentation":"

Contains the response to a RegisterEcsCluster request.

" }, "RegisterElasticIpRequest":{ "type":"structure", "required":[ "ElasticIp", "StackId" ], "members":{ "ElasticIp":{ "shape":"String", "documentation":"

The Elastic IP address.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" } } }, "RegisterElasticIpResult":{ "type":"structure", "members":{ "ElasticIp":{ "shape":"String", "documentation":"

The Elastic IP address.

" } }, "documentation":"

Contains the response to a RegisterElasticIp request.

" }, "RegisterInstanceRequest":{ "type":"structure", "required":["StackId"], "members":{ "StackId":{ "shape":"String", "documentation":"

The ID of the stack that the instance is to be registered with.

" }, "Hostname":{ "shape":"String", "documentation":"

The instance's hostname.

" }, "PublicIp":{ "shape":"String", "documentation":"

The instance's public IP address.

" }, "PrivateIp":{ "shape":"String", "documentation":"

The instance's private IP address.

" }, "RsaPublicKey":{ "shape":"String", "documentation":"

The instances public RSA key. This key is used to encrypt communication between the instance and the service.

" }, "RsaPublicKeyFingerprint":{ "shape":"String", "documentation":"

The instances public RSA key fingerprint.

" }, "InstanceIdentity":{ "shape":"InstanceIdentity", "documentation":"

An InstanceIdentity object that contains the instance's identity.

" } } }, "RegisterInstanceResult":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The registered instance's AWS OpsWorks ID.

" } }, "documentation":"

Contains the response to a RegisterInstanceResult request.

" }, "RegisterRdsDbInstanceRequest":{ "type":"structure", "required":[ "StackId", "RdsDbInstanceArn", "DbUser", "DbPassword" ], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "RdsDbInstanceArn":{ "shape":"String", "documentation":"

The Amazon RDS instance's ARN.

" }, "DbUser":{ "shape":"String", "documentation":"

The database's master user name.

" }, "DbPassword":{ "shape":"String", "documentation":"

The database password.

" } } }, "RegisterVolumeRequest":{ "type":"structure", "required":["StackId"], "members":{ "Ec2VolumeId":{ "shape":"String", "documentation":"

The Amazon EBS volume ID.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" } } }, "RegisterVolumeResult":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

" } }, "documentation":"

Contains the response to a RegisterVolume request.

" }, "ReportedOs":{ "type":"structure", "members":{ "Family":{ "shape":"String", "documentation":"

The operating system family.

" }, "Name":{ "shape":"String", "documentation":"

The operating system name.

" }, "Version":{ "shape":"String", "documentation":"

The operating system version.

" } }, "documentation":"

A registered instance's reported operating system.

" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The exception message.

" } }, "documentation":"

Indicates that a resource was not found.

", "exception":true }, "RootDeviceType":{ "type":"string", "enum":[ "ebs", "instance-store" ] }, "SelfUserProfile":{ "type":"structure", "members":{ "IamUserArn":{ "shape":"String", "documentation":"

The user's IAM ARN.

" }, "Name":{ "shape":"String", "documentation":"

The user's name.

" }, "SshUsername":{ "shape":"String", "documentation":"

The user's SSH user name.

" }, "SshPublicKey":{ "shape":"String", "documentation":"

The user's SSH public key.

" } }, "documentation":"

Describes a user's SSH information.

" }, "ServiceError":{ "type":"structure", "members":{ "ServiceErrorId":{ "shape":"String", "documentation":"

The error ID.

" }, "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "Type":{ "shape":"String", "documentation":"

The error type.

" }, "Message":{ "shape":"String", "documentation":"

A message that describes the error.

" }, "CreatedAt":{ "shape":"DateTime", "documentation":"

When the error occurred.

" } }, "documentation":"

Describes an AWS OpsWorks service error.

" }, "ServiceErrors":{ "type":"list", "member":{"shape":"ServiceError"} }, "SetLoadBasedAutoScalingRequest":{ "type":"structure", "required":["LayerId"], "members":{ "LayerId":{ "shape":"String", "documentation":"

The layer ID.

" }, "Enable":{ "shape":"Boolean", "documentation":"

Enables load-based auto scaling for the layer.

" }, "UpScaling":{ "shape":"AutoScalingThresholds", "documentation":"

An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, AWS OpsWorks starts a specified number of instances.

" }, "DownScaling":{ "shape":"AutoScalingThresholds", "documentation":"

An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, AWS OpsWorks stops a specified number of instances.

" } } }, "SetPermissionRequest":{ "type":"structure", "required":[ "StackId", "IamUserArn" ], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "IamUserArn":{ "shape":"String", "documentation":"

The user's IAM ARN. This can also be a federated user's ARN.

" }, "AllowSsh":{ "shape":"Boolean", "documentation":"

The user is allowed to use SSH to communicate with the instance.

" }, "AllowSudo":{ "shape":"Boolean", "documentation":"

The user is allowed to use sudo to elevate privileges.

" }, "Level":{ "shape":"String", "documentation":"

The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.

  • deny

  • show

  • deploy

  • manage

  • iam_only

For more information on the permissions associated with these levels, see Managing User Permissions.

" } } }, "SetTimeBasedAutoScalingRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "AutoScalingSchedule":{ "shape":"WeeklyAutoScalingSchedule", "documentation":"

An AutoScalingSchedule with the instance schedule.

" } } }, "ShutdownEventConfiguration":{ "type":"structure", "members":{ "ExecutionTimeout":{ "shape":"Integer", "documentation":"

The time, in seconds, that AWS OpsWorks will wait after triggering a Shutdown event before shutting down an instance.

" }, "DelayUntilElbConnectionsDrained":{ "shape":"Boolean", "documentation":"

Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining

" } }, "documentation":"

The Shutdown event configuration.

" }, "Source":{ "type":"structure", "members":{ "Type":{ "shape":"SourceType", "documentation":"

The repository type.

" }, "Url":{ "shape":"String", "documentation":"

The source URL.

" }, "Username":{ "shape":"String", "documentation":"

This parameter depends on the repository type.

  • For Amazon S3 bundles, set Username to the appropriate IAM access key ID.

  • For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name.

" }, "Password":{ "shape":"String", "documentation":"

When included in a request, the parameter depends on the repository type.

  • For Amazon S3 bundles, set Password to the appropriate IAM secret access key.

  • For HTTP bundles and Subversion repositories, set Password to the password.

For more information on how to safely handle IAM credentials, see http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.

In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.

" }, "SshKey":{ "shape":"String", "documentation":"

In requests, the repository's SSH key.

In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.

" }, "Revision":{ "shape":"String", "documentation":"

The application's version. AWS OpsWorks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.

" } }, "documentation":"

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

" }, "SourceType":{ "type":"string", "enum":[ "git", "svn", "archive", "s3" ] }, "SslConfiguration":{ "type":"structure", "required":[ "Certificate", "PrivateKey" ], "members":{ "Certificate":{ "shape":"String", "documentation":"

The contents of the certificate's domain.crt file.

" }, "PrivateKey":{ "shape":"String", "documentation":"

The private key; the contents of the certificate's domain.kex file.

" }, "Chain":{ "shape":"String", "documentation":"

Optional. Can be used to specify an intermediate certificate authority key or client authentication.

" } }, "documentation":"

Describes an app's SSL configuration.

" }, "Stack":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "Name":{ "shape":"String", "documentation":"

The stack name.

" }, "Arn":{ "shape":"String", "documentation":"

The stack's ARN.

" }, "Region":{ "shape":"String", "documentation":"

The stack AWS region, such as \"ap-northeast-2\". For more information about AWS regions, see Regions and Endpoints.

" }, "VpcId":{ "shape":"String", "documentation":"

The VPC ID; applicable only if the stack is running in a VPC.

" }, "Attributes":{ "shape":"StackAttributes", "documentation":"

The stack's attributes.

" }, "ServiceRoleArn":{ "shape":"String", "documentation":"

The stack AWS Identity and Access Management (IAM) role.

" }, "DefaultInstanceProfileArn":{ "shape":"String", "documentation":"

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 Using Identifiers.

" }, "DefaultOs":{ "shape":"String", "documentation":"

The stack's default operating system.

" }, "HostnameTheme":{ "shape":"String", "documentation":"

The stack host name theme, with spaces replaced by underscores.

" }, "DefaultAvailabilityZone":{ "shape":"String", "documentation":"

The stack's default Availability Zone. For more information, see Regions and Endpoints.

" }, "DefaultSubnetId":{ "shape":"String", "documentation":"

The default subnet ID; applicable only if the stack is running in a VPC.

" }, "CustomJson":{ "shape":"String", "documentation":"

A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

" }, "ConfigurationManager":{ "shape":"StackConfigurationManager", "documentation":"

The configuration manager.

" }, "ChefConfiguration":{ "shape":"ChefConfiguration", "documentation":"

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.

" }, "UseCustomCookbooks":{ "shape":"Boolean", "documentation":"

Whether the stack uses custom cookbooks.

" }, "UseOpsworksSecurityGroups":{ "shape":"Boolean", "documentation":"

Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.

" }, "CustomCookbooksSource":{"shape":"Source"}, "DefaultSshKeyName":{ "shape":"String", "documentation":"

A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.

" }, "CreatedAt":{ "shape":"DateTime", "documentation":"

The date when the stack was created.

" }, "DefaultRootDeviceType":{ "shape":"RootDeviceType", "documentation":"

The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

" }, "AgentVersion":{ "shape":"String", "documentation":"

The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version.

" } }, "documentation":"

Describes a stack.

" }, "StackAttributes":{ "type":"map", "key":{"shape":"StackAttributesKeys"}, "value":{"shape":"String"} }, "StackAttributesKeys":{ "type":"string", "enum":["Color"] }, "StackConfigurationManager":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name. This parameter must be set to \"Chef\".

" }, "Version":{ "shape":"String", "documentation":"

The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4.

" } }, "documentation":"

Describes the configuration manager.

" }, "StackSummary":{ "type":"structure", "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "Name":{ "shape":"String", "documentation":"

The stack name.

" }, "Arn":{ "shape":"String", "documentation":"

The stack's ARN.

" }, "LayersCount":{ "shape":"Integer", "documentation":"

The number of layers.

" }, "AppsCount":{ "shape":"Integer", "documentation":"

The number of apps.

" }, "InstancesCount":{ "shape":"InstancesCount", "documentation":"

An InstancesCount object with the number of instances in each status.

" } }, "documentation":"

Summarizes the number of layers, instances, and apps in a stack.

" }, "Stacks":{ "type":"list", "member":{"shape":"Stack"} }, "StartInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" } } }, "StartStackRequest":{ "type":"structure", "required":["StackId"], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" } } }, "StopInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" } } }, "StopStackRequest":{ "type":"structure", "required":["StackId"], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" } } }, "String":{"type":"string"}, "Strings":{ "type":"list", "member":{"shape":"String"} }, "Switch":{"type":"string"}, "TemporaryCredential":{ "type":"structure", "members":{ "Username":{ "shape":"String", "documentation":"

The user name.

" }, "Password":{ "shape":"String", "documentation":"

The password.

" }, "ValidForInMinutes":{ "shape":"Integer", "documentation":"

The length of time (in minutes) that the grant is valid. When the grant expires, at the end of this period, the user will no longer be able to use the credentials to log in. If they are logged in at the time, they will be automatically logged out.

" }, "InstanceId":{ "shape":"String", "documentation":"

The instance's AWS OpsWorks ID.

" } }, "documentation":"

Contains the data needed by RDP clients such as the Microsoft Remote Desktop Connection to log in to the instance.

" }, "TimeBasedAutoScalingConfiguration":{ "type":"structure", "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "AutoScalingSchedule":{ "shape":"WeeklyAutoScalingSchedule", "documentation":"

A WeeklyAutoScalingSchedule object with the instance schedule.

" } }, "documentation":"

Describes an instance's time-based auto scaling configuration.

" }, "TimeBasedAutoScalingConfigurations":{ "type":"list", "member":{"shape":"TimeBasedAutoScalingConfiguration"} }, "UnassignInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" } } }, "UnassignVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

" } } }, "UpdateAppRequest":{ "type":"structure", "required":["AppId"], "members":{ "AppId":{ "shape":"String", "documentation":"

The app ID.

" }, "Name":{ "shape":"String", "documentation":"

The app name.

" }, "Description":{ "shape":"String", "documentation":"

A description of the app.

" }, "DataSources":{ "shape":"DataSources", "documentation":"

The app's data sources.

" }, "Type":{ "shape":"AppType", "documentation":"

The app type.

" }, "AppSource":{ "shape":"Source", "documentation":"

A Source object that specifies the app repository.

" }, "Domains":{ "shape":"Strings", "documentation":"

The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

" }, "EnableSsl":{ "shape":"Boolean", "documentation":"

Whether SSL is enabled for the app.

" }, "SslConfiguration":{ "shape":"SslConfiguration", "documentation":"

An SslConfiguration object with the SSL configuration.

" }, "Attributes":{ "shape":"AppAttributes", "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" }, "Environment":{ "shape":"EnvironmentVariables", "documentation":"

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances.For more information, see Environment Variables.

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, \"Environment: is too large (maximum is 10KB).\"

This parameter is supported only by Chef 11.10 stacks. If you have specified one or more environment variables, you cannot modify the stack's Chef version.

" } } }, "UpdateElasticIpRequest":{ "type":"structure", "required":["ElasticIp"], "members":{ "ElasticIp":{ "shape":"String", "documentation":"

The address.

" }, "Name":{ "shape":"String", "documentation":"

The new name.

" } } }, "UpdateInstanceRequest":{ "type":"structure", "required":["InstanceId"], "members":{ "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "LayerIds":{ "shape":"Strings", "documentation":"

The instance's layer IDs.

" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

" }, "AutoScalingType":{ "shape":"AutoScalingType", "documentation":"

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

" }, "Hostname":{ "shape":"String", "documentation":"

The instance host name.

" }, "Os":{ "shape":"String", "documentation":"

The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

For more information on the supported operating systems, see AWS OpsWorks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information on the supported operating systems, see Operating Systems. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.

" }, "AmiId":{ "shape":"String", "documentation":"

The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs.

" }, "SshKeyName":{ "shape":"String", "documentation":"

The instance's Amazon EC2 key name.

" }, "Architecture":{ "shape":"Architecture", "documentation":"

The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

" }, "InstallUpdatesOnBoot":{ "shape":"Boolean", "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

" }, "EbsOptimized":{ "shape":"Boolean", "documentation":"

This property cannot be updated.

" }, "AgentVersion":{ "shape":"String", "documentation":"

The default AWS OpsWorks agent version. You have the following options:

  • INHERIT - Use the stack's default agent version setting.

  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks then automatically installs that version on the instance.

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.

" } } }, "UpdateLayerRequest":{ "type":"structure", "required":["LayerId"], "members":{ "LayerId":{ "shape":"String", "documentation":"

The layer ID.

" }, "Name":{ "shape":"String", "documentation":"

The layer name, which is used by the console.

" }, "Shortname":{ "shape":"String", "documentation":"

For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorksand by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\\A[a-z0-9\\-\\_\\.]+\\Z/.

The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference

" }, "Attributes":{ "shape":"LayerAttributes", "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" }, "CustomInstanceProfileArn":{ "shape":"String", "documentation":"

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" }, "CustomJson":{ "shape":"String", "documentation":"

A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON.

" }, "CustomSecurityGroupIds":{ "shape":"Strings", "documentation":"

An array containing the layer's custom security group IDs.

" }, "Packages":{ "shape":"Strings", "documentation":"

An array of Package objects that describe the layer's packages.

" }, "VolumeConfigurations":{ "shape":"VolumeConfigurations", "documentation":"

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" }, "EnableAutoHealing":{ "shape":"Boolean", "documentation":"

Whether to disable auto healing for the layer.

" }, "AutoAssignElasticIps":{ "shape":"Boolean", "documentation":"

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

" }, "AutoAssignPublicIps":{ "shape":"Boolean", "documentation":"

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.

" }, "CustomRecipes":{ "shape":"Recipes", "documentation":"

A LayerCustomRecipes object that specifies the layer's custom recipes.

" }, "InstallUpdatesOnBoot":{ "shape":"Boolean", "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

" }, "UseEbsOptimizedInstances":{ "shape":"Boolean", "documentation":"

Whether to use Amazon EBS-optimized instances.

" }, "LifecycleEventConfiguration":{ "shape":"LifecycleEventConfiguration", "documentation":"

" } } }, "UpdateMyUserProfileRequest":{ "type":"structure", "members":{ "SshPublicKey":{ "shape":"String", "documentation":"

The user's SSH public key.

" } } }, "UpdateRdsDbInstanceRequest":{ "type":"structure", "required":["RdsDbInstanceArn"], "members":{ "RdsDbInstanceArn":{ "shape":"String", "documentation":"

The Amazon RDS instance's ARN.

" }, "DbUser":{ "shape":"String", "documentation":"

The master user name.

" }, "DbPassword":{ "shape":"String", "documentation":"

The database password.

" } } }, "UpdateStackRequest":{ "type":"structure", "required":["StackId"], "members":{ "StackId":{ "shape":"String", "documentation":"

The stack ID.

" }, "Name":{ "shape":"String", "documentation":"

The stack's new name.

" }, "Attributes":{ "shape":"StackAttributes", "documentation":"

One or more user-defined key-value pairs to be added to the stack attributes.

" }, "ServiceRoleArn":{ "shape":"String", "documentation":"

Do not use this parameter. You cannot update a stack's service role.

" }, "DefaultInstanceProfileArn":{ "shape":"String", "documentation":"

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 Using Identifiers.

" }, "DefaultOs":{ "shape":"String", "documentation":"

The stack's operating system, which must be set to one of the following:

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs.

The default option is the stack's current operating system. For more information on the supported operating systems, see AWS OpsWorks Operating Systems.

" }, "HostnameTheme":{ "shape":"String", "documentation":"

The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

  • Baked_Goods

  • Clouds

  • Europe_Cities

  • Fruits

  • Greek_Deities

  • Legendary_creatures_from_Japan

  • Planets_and_Moons

  • Roman_Deities

  • Scottish_Islands

  • US_Cities

  • Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

" }, "DefaultAvailabilityZone":{ "shape":"String", "documentation":"

The stack's default Availability Zone, which must be in the stack's region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.

" }, "DefaultSubnetId":{ "shape":"String", "documentation":"

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

" }, "CustomJson":{ "shape":"String", "documentation":"

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

" }, "ConfigurationManager":{ "shape":"StackConfigurationManager", "documentation":"

The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 11.4.

" }, "ChefConfiguration":{ "shape":"ChefConfiguration", "documentation":"

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" }, "UseCustomCookbooks":{ "shape":"Boolean", "documentation":"

Whether the stack uses custom cookbooks.

" }, "CustomCookbooksSource":{"shape":"Source"}, "DefaultSshKeyName":{ "shape":"String", "documentation":"

A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

" }, "DefaultRootDeviceType":{ "shape":"RootDeviceType", "documentation":"

The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

" }, "UseOpsworksSecurityGroups":{ "shape":"Boolean", "documentation":"

Whether to associate the AWS OpsWorks built-in security groups with the stack's layers.

AWS OpsWorks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings:

  • True - AWS OpsWorks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

  • False - AWS OpsWorks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

" }, "AgentVersion":{ "shape":"String", "documentation":"

The default AWS OpsWorks agent version. You have the following options:

  • Auto-update - Set this parameter to LATEST. AWS OpsWorks automatically installs new agent versions on the stack's instances as soon as they are available.

  • Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks then automatically installs that version on the stack's instances.

The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

" } } }, "UpdateUserProfileRequest":{ "type":"structure", "required":["IamUserArn"], "members":{ "IamUserArn":{ "shape":"String", "documentation":"

The user IAM ARN. This can also be a federated user's ARN.

" }, "SshUsername":{ "shape":"String", "documentation":"

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks generates one from the IAM user name.

" }, "SshPublicKey":{ "shape":"String", "documentation":"

The user's new SSH public key.

" }, "AllowSelfManagement":{ "shape":"Boolean", "documentation":"

Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

" } } }, "UpdateVolumeRequest":{ "type":"structure", "required":["VolumeId"], "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

" }, "Name":{ "shape":"String", "documentation":"

The new name.

" }, "MountPoint":{ "shape":"String", "documentation":"

The new mount point.

" } } }, "UserProfile":{ "type":"structure", "members":{ "IamUserArn":{ "shape":"String", "documentation":"

The user's IAM ARN.

" }, "Name":{ "shape":"String", "documentation":"

The user's name.

" }, "SshUsername":{ "shape":"String", "documentation":"

The user's SSH user name.

" }, "SshPublicKey":{ "shape":"String", "documentation":"

The user's SSH public key.

" }, "AllowSelfManagement":{ "shape":"Boolean", "documentation":"

Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

" } }, "documentation":"

Describes a user's SSH information.

" }, "UserProfiles":{ "type":"list", "member":{"shape":"UserProfile"} }, "ValidForInMinutes":{ "type":"integer", "box":true, "max":1440, "min":60 }, "ValidationException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The exception message.

" } }, "documentation":"

Indicates that a request was not valid.

", "exception":true }, "VirtualizationType":{ "type":"string", "enum":[ "paravirtual", "hvm" ] }, "Volume":{ "type":"structure", "members":{ "VolumeId":{ "shape":"String", "documentation":"

The volume ID.

" }, "Ec2VolumeId":{ "shape":"String", "documentation":"

The Amazon EC2 volume ID.

" }, "Name":{ "shape":"String", "documentation":"

The volume name.

" }, "RaidArrayId":{ "shape":"String", "documentation":"

The RAID array ID.

" }, "InstanceId":{ "shape":"String", "documentation":"

The instance ID.

" }, "Status":{ "shape":"String", "documentation":"

The value returned by DescribeVolumes.

" }, "Size":{ "shape":"Integer", "documentation":"

The volume size.

" }, "Device":{ "shape":"String", "documentation":"

The device name.

" }, "MountPoint":{ "shape":"String", "documentation":"

The volume mount point. For example, \"/mnt/disk1\".

" }, "Region":{ "shape":"String", "documentation":"

The AWS region. For more information about AWS regions, see Regions and Endpoints.

" }, "AvailabilityZone":{ "shape":"String", "documentation":"

The volume Availability Zone. For more information, see Regions and Endpoints.

" }, "VolumeType":{ "shape":"String", "documentation":"

The volume type, standard or PIOPS.

" }, "Iops":{ "shape":"Integer", "documentation":"

For PIOPS volumes, the IOPS per disk.

" } }, "documentation":"

Describes an instance's Amazon EBS volume.

" }, "VolumeConfiguration":{ "type":"structure", "required":[ "MountPoint", "NumberOfDisks", "Size" ], "members":{ "MountPoint":{ "shape":"String", "documentation":"

The volume mount point. For example \"/dev/sdh\".

" }, "RaidLevel":{ "shape":"Integer", "documentation":"

The volume RAID level.

" }, "NumberOfDisks":{ "shape":"Integer", "documentation":"

The number of disks in the volume.

" }, "Size":{ "shape":"Integer", "documentation":"

The volume size.

" }, "VolumeType":{ "shape":"String", "documentation":"

The volume type:

  • standard - Magnetic

  • io1 - Provisioned IOPS (SSD)

  • gp2 - General Purpose (SSD)

" }, "Iops":{ "shape":"Integer", "documentation":"

For PIOPS volumes, the IOPS per disk.

" } }, "documentation":"

Describes an Amazon EBS volume configuration.

" }, "VolumeConfigurations":{ "type":"list", "member":{"shape":"VolumeConfiguration"} }, "VolumeType":{ "type":"string", "enum":[ "gp2", "io1", "standard" ] }, "Volumes":{ "type":"list", "member":{"shape":"Volume"} }, "WeeklyAutoScalingSchedule":{ "type":"structure", "members":{ "Monday":{ "shape":"DailyAutoScalingSchedule", "documentation":"

The schedule for Monday.

" }, "Tuesday":{ "shape":"DailyAutoScalingSchedule", "documentation":"

The schedule for Tuesday.

" }, "Wednesday":{ "shape":"DailyAutoScalingSchedule", "documentation":"

The schedule for Wednesday.

" }, "Thursday":{ "shape":"DailyAutoScalingSchedule", "documentation":"

The schedule for Thursday.

" }, "Friday":{ "shape":"DailyAutoScalingSchedule", "documentation":"

The schedule for Friday.

" }, "Saturday":{ "shape":"DailyAutoScalingSchedule", "documentation":"

The schedule for Saturday.

" }, "Sunday":{ "shape":"DailyAutoScalingSchedule", "documentation":"

The schedule for Sunday.

" } }, "documentation":"

Describes a time-based instance's auto scaling schedule. The schedule consists of a set of key-value pairs.

  • The key is the time period (a UTC hour) and must be an integer from 0 - 23.

  • The value indicates whether the instance should be online or offline for the specified period, and must be set to \"on\" or \"off\"

The default setting for all time periods is off, so you use the following parameters primarily to specify the online periods. You don't have to explicitly specify offline periods unless you want to change an online period to an offline period.

The following example specifies that the instance should be online for four hours, from UTC 1200 - 1600. It will be off for the remainder of the day.

{ \"12\":\"on\", \"13\":\"on\", \"14\":\"on\", \"15\":\"on\" }

" } }, "documentation":"AWS OpsWorks

Welcome to the AWS OpsWorks API Reference. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks actions and data types, including common parameters and error codes.

AWS OpsWorks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.

SDKs and CLI

The most common way to use the AWS OpsWorks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:

Endpoints

AWS OpsWorks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.

  • opsworks.us-east-1.amazonaws.com

  • opsworks.us-west-1.amazonaws.com

  • opsworks.us-west-2.amazonaws.com

  • opsworks.eu-west-1.amazonaws.com

  • opsworks.eu-central-1.amazonaws.com

  • opsworks.ap-northeast-1.amazonaws.com

  • opsworks.ap-northeast-2.amazonaws.com

  • opsworks.ap-south-1.amazonaws.com

  • opsworks.ap-southeast-1.amazonaws.com

  • opsworks.ap-southeast-2.amazonaws.com

  • opsworks.sa-east-1.amazonaws.com

Chef Versions

When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions.

You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.

" } botocore-1.5.7/botocore/data/glacier/0000777454262600001440000000000013042511307020541 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/glacier/2012-06-01/0000777454262600001440000000000013042511307021566 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/glacier/2012-06-01/paginators-1.json0000666454262600001440000000116413042511306024767 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListJobs": { "input_token": "marker", "output_token": "Marker", "limit_key": "limit", "result_key": "JobList" }, "ListMultipartUploads": { "input_token": "marker", "output_token": "Marker", "limit_key": "limit", "result_key": "UploadsList" }, "ListParts": { "input_token": "marker", "output_token": "Marker", "limit_key": "limit", "result_key": "Parts" }, "ListVaults": { "input_token": "marker", "output_token": "Marker", "limit_key": "limit", "result_key": "VaultList" } } } botocore-1.5.7/botocore/data/glacier/2012-06-01/service-2.json0000666454262600001440000045134513042511306024273 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2012-06-01", "checksumFormat":"sha256", "endpointPrefix":"glacier", "protocol":"rest-json", "serviceFullName":"Amazon Glacier", "signatureVersion":"v4", "uid":"glacier-2012-06-01" }, "operations":{ "AbortMultipartUpload":{ "name":"AbortMultipartUpload", "http":{ "method":"DELETE", "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", "responseCode":204 }, "input":{"shape":"AbortMultipartUploadInput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation aborts a multipart upload identified by the upload ID.

After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see UploadMultipartPart and CompleteMultipartUpload.

This operation is idempotent.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Working with Archives in Amazon Glacier and Abort Multipart Upload in the Amazon Glacier Developer Guide.

" }, "AbortVaultLock":{ "name":"AbortVaultLock", "http":{ "method":"DELETE", "requestUri":"/{accountId}/vaults/{vaultName}/lock-policy", "responseCode":204 }, "input":{"shape":"AbortVaultLockInput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation aborts the vault locking process if the vault lock is not in the Locked state. If the vault lock is in the Locked state when this operation is requested, the operation returns an AccessDeniedException error. Aborting the vault locking process removes the vault lock policy from the specified vault.

A vault lock is put into the InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock. You can get the state of a vault lock by calling GetVaultLock. For more information about the vault locking process, see Amazon Glacier Vault Lock. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.

This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the InProgress state or if there is no policy associated with the vault.

" }, "AddTagsToVault":{ "name":"AddTagsToVault", "http":{ "method":"POST", "requestUri":"/{accountId}/vaults/{vaultName}/tags?operation=add", "responseCode":204 }, "input":{"shape":"AddTagsToVaultInput"}, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the tag limit for the vault to be exceeded, the operation throws the LimitExceededException error. If a tag already exists on the vault under a specified key, the existing key value will be overwritten. For more information about tags, see Tagging Amazon Glacier Resources.

" }, "CompleteMultipartUpload":{ "name":"CompleteMultipartUpload", "http":{ "method":"POST", "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", "responseCode":201 }, "input":{"shape":"CompleteMultipartUploadInput"}, "output":{"shape":"ArchiveCreationOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

You call this operation to inform Amazon Glacier that all the archive parts have been uploaded and that Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.

In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see Computing Checksums. On the server side, Amazon Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Amazon Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The ListParts operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue.

Additionally, Amazon Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Amazon Glacier returns an error and the operation fails.

Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Complete Multipart Upload in the Amazon Glacier Developer Guide.

" }, "CompleteVaultLock":{ "name":"CompleteVaultLock", "http":{ "method":"POST", "requestUri":"/{accountId}/vaults/{vaultName}/lock-policy/{lockId}", "responseCode":204 }, "input":{"shape":"CompleteVaultLockInput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state, which causes the vault lock policy to become unchangeable. A vault lock is put into the InProgress state by calling InitiateVaultLock. You can obtain the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.

This operation is idempotent. This request is always successful if the vault lock is in the Locked state and the provided lock ID matches the lock ID originally used to lock the vault.

If an invalid lock ID is passed in the request when the vault lock is in the Locked state, the operation returns an AccessDeniedException error. If an invalid lock ID is passed in the request when the vault lock is in the InProgress state, the operation throws an InvalidParameter error.

" }, "CreateVault":{ "name":"CreateVault", "http":{ "method":"PUT", "requestUri":"/{accountId}/vaults/{vaultName}", "responseCode":201 }, "input":{"shape":"CreateVaultInput"}, "output":{"shape":"CreateVaultOutput"}, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"}, {"shape":"LimitExceededException"} ], "documentation":"

This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon Glacier.

You must use the following guidelines when naming a vault.

  • Names can be between 1 and 255 characters long.

  • Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).

This operation is idempotent.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide.

" }, "DeleteArchive":{ "name":"DeleteArchive", "http":{ "method":"DELETE", "requestUri":"/{accountId}/vaults/{vaultName}/archives/{archiveId}", "responseCode":204 }, "input":{"shape":"DeleteArchiveInput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios:

  • If the archive retrieval job is actively preparing the data for download when Amazon Glacier receives the delete archive request, the archival retrieval operation might fail.

  • If the archive retrieval job has successfully prepared the archive for download when Amazon Glacier receives the delete archive request, you will be able to download the output.

This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Deleting an Archive in Amazon Glacier and Delete Archive in the Amazon Glacier Developer Guide.

" }, "DeleteVault":{ "name":"DeleteVault", "http":{ "method":"DELETE", "requestUri":"/{accountId}/vaults/{vaultName}", "responseCode":204 }, "input":{"shape":"DeleteVaultInput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use DescribeVault to return the number of archives in a vault, and you can use Initiate a Job (POST jobs) to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using Delete Archive (DELETE archive).

This operation is idempotent.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Deleting a Vault in Amazon Glacier and Delete Vault in the Amazon Glacier Developer Guide.

" }, "DeleteVaultAccessPolicy":{ "name":"DeleteVaultAccessPolicy", "http":{ "method":"DELETE", "requestUri":"/{accountId}/vaults/{vaultName}/access-policy", "responseCode":204 }, "input":{"shape":"DeleteVaultAccessPolicyInput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation deletes the access policy associated with the specified vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely remove the access policy, and you might still see the effect of the policy for a short time after you send the delete request.

This operation is idempotent. You can invoke delete multiple times, even if there is no policy associated with the vault. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.

" }, "DeleteVaultNotifications":{ "name":"DeleteVaultNotifications", "http":{ "method":"DELETE", "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration", "responseCode":204 }, "input":{"shape":"DeleteVaultNotificationsInput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon Glacier and Delete Vault Notification Configuration in the Amazon Glacier Developer Guide.

" }, "DescribeJob":{ "name":"DescribeJob", "http":{ "method":"GET", "requestUri":"/{accountId}/vaults/{vaultName}/jobs/{jobId}" }, "input":{"shape":"DescribeJobInput"}, "output":{"shape":"GlacierJobDescription"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon Glacier completes the job. For more information about initiating a job, see InitiateJob.

This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Amazon Glacier can notify the topic after it completes the job.

A job ID will not expire for at least 24 hours after Amazon Glacier completes the job.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For information about the underlying REST API, see Working with Archives in Amazon Glacier in the Amazon Glacier Developer Guide.

" }, "DescribeVault":{ "name":"DescribeVault", "http":{ "method":"GET", "requestUri":"/{accountId}/vaults/{vaultName}" }, "input":{"shape":"DescribeVaultInput"}, "output":{"shape":"DescribeVaultOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use InitiateJob. Amazon Glacier generates vault inventories approximately daily. For more information, see Downloading a Vault Inventory in Amazon Glacier.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon Glacier and Describe Vault in the Amazon Glacier Developer Guide.

" }, "GetDataRetrievalPolicy":{ "name":"GetDataRetrievalPolicy", "http":{ "method":"GET", "requestUri":"/{accountId}/policies/data-retrieval" }, "input":{"shape":"GetDataRetrievalPolicyInput"}, "output":{"shape":"GetDataRetrievalPolicyOutput"}, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies.

" }, "GetJobOutput":{ "name":"GetJobOutput", "http":{ "method":"GET", "requestUri":"/{accountId}/vaults/{vaultName}/jobs/{jobId}/output" }, "input":{"shape":"GetJobOutputInput"}, "output":{"shape":"GetJobOutputOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.

You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon Glacier returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data.

A job ID will not expire for at least 24 hours after Amazon Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the Get Job Output response.

For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of bytes=0-1048575, you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon Glacier The expected size is also returned in the headers from the Get Job Output response.

In the case of an archive retrieval job, depending on the byte range you specify, Amazon Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected.

A job ID does not expire for at least 24 hours after Amazon Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and the underlying REST API, see Downloading a Vault Inventory, Downloading an Archive, and Get Job Output

" }, "GetVaultAccessPolicy":{ "name":"GetVaultAccessPolicy", "http":{ "method":"GET", "requestUri":"/{accountId}/vaults/{vaultName}/access-policy" }, "input":{"shape":"GetVaultAccessPolicyInput"}, "output":{"shape":"GetVaultAccessPolicyOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation retrieves the access-policy subresource set on the vault; for more information on setting this subresource, see Set Vault Access Policy (PUT access-policy). If there is no access policy set on the vault, the operation returns a 404 Not found error. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.

" }, "GetVaultLock":{ "name":"GetVaultLock", "http":{ "method":"GET", "requestUri":"/{accountId}/vaults/{vaultName}/lock-policy" }, "input":{"shape":"GetVaultLockInput"}, "output":{"shape":"GetVaultLockOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation retrieves the following attributes from the lock-policy subresource set on the specified vault:

  • The vault lock policy set on the vault.

  • The state of the vault lock, which is either InProgess or Locked.

  • When the lock ID expires. The lock ID is used to complete the vault locking process.

  • When the vault lock was initiated and put into the InProgress state.

A vault lock is put into the InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock. You can abort the vault locking process by calling AbortVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.

If there is no vault lock policy set on the vault, the operation returns a 404 Not found error. For more information about vault lock policies, Amazon Glacier Access Control with Vault Lock Policies.

" }, "GetVaultNotifications":{ "name":"GetVaultNotifications", "http":{ "method":"GET", "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration" }, "input":{"shape":"GetVaultNotificationsInput"}, "output":{"shape":"GetVaultNotificationsOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation retrieves the notification-configuration subresource of the specified vault.

For information about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration for a vault is not set, the operation returns a 404 Not Found error. For more information about vault notifications, see Configuring Vault Notifications in Amazon Glacier.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon Glacier and Get Vault Notification Configuration in the Amazon Glacier Developer Guide.

" }, "InitiateJob":{ "name":"InitiateJob", "http":{ "method":"POST", "requestUri":"/{accountId}/vaults/{vaultName}/jobs", "responseCode":202 }, "input":{"shape":"InitiateJobInput"}, "output":{"shape":"InitiateJobOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"PolicyEnforcedException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"InsufficientCapacityException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation initiates a job of the specified type. In this release, you can initiate a job to retrieve either an archive or a vault inventory (a list of archives in a vault).

Retrieving data from Amazon Glacier is a two-step process:

  1. Initiate a retrieval job.

    A data retrieval policy can cause your initiate retrieval job request to fail with a PolicyEnforcedException exception. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies. For more information about the PolicyEnforcedException exception, see Error Responses.

  2. After the job completes, download the bytes.

The retrieval request is executed asynchronously. When you initiate a retrieval job, Amazon Glacier creates a job and returns a job ID in the response. When Amazon Glacier completes the job, you can get the job output (archive or inventory data). For information about getting job output, see GetJobOutput operation.

The job must complete before you can get its output. To determine when a job is complete, you have the following options:

  • Use Amazon SNS Notification You can specify an Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Glacier can post a notification after the job is completed. You can specify an SNS topic per job request. The notification is sent only after Amazon Glacier completes the job. In addition to specifying an SNS topic per job request, you can configure vault notifications for a vault so that job notifications are always sent. For more information, see SetVaultNotifications.

  • Get job details You can make a DescribeJob request to obtain job status information while a job is in progress. However, it is more efficient to use an Amazon SNS notification to determine when a job is complete.

The information you get via notification is same that you get by calling DescribeJob.

If for a specific event, you add both the notification configuration on the vault and also specify an SNS topic in your initiate job request, Amazon Glacier sends both notifications. For more information, see SetVaultNotifications.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

About the Vault Inventory

Amazon Glacier prepares an inventory for each vault periodically, every 24 hours. When you initiate a job for a vault inventory, Amazon Glacier returns the last inventory for the vault. The inventory data you get might be up to a day or two days old. Also, the initiate inventory job might take some time to complete before you can download the vault inventory. So you do not want to retrieve a vault inventory for each vault operation. However, in some scenarios, you might find the vault inventory useful. For example, when you upload an archive, you can provide an archive description but not an archive name. Amazon Glacier provides you a unique archive ID, an opaque string of characters. So, you might maintain your own database that maps archive names to their corresponding Amazon Glacier assigned archive IDs. You might find the vault inventory useful in the event you need to reconcile information in your database with the actual vault inventory.

Range Inventory Retrieval

You can limit the number of inventory items retrieved by filtering on the archive creation date or by setting a limit.

Filtering by Archive Creation Date

You can retrieve inventory items for archives created between StartDate and EndDate by specifying values for these parameters in the InitiateJob request. Archives created on or after the StartDate and before the EndDate will be returned. If you only provide the StartDate without the EndDate, you will retrieve the inventory for all archives created on or after the StartDate. If you only provide the EndDate without the StartDate, you will get back the inventory for all archives created before the EndDate.

Limiting Inventory Items per Retrieval

You can limit the number of inventory items returned by setting the Limit parameter in the InitiateJob request. The inventory job output will contain inventory items up to the specified Limit. If there are more inventory items available, the result is paginated. After a job is complete you can use the DescribeJob operation to get a marker that you use in a subsequent InitiateJob request. The marker will indicate the starting point to retrieve the next set of inventory items. You can page through your entire inventory by repeatedly making InitiateJob requests with the marker from the previous DescribeJob output, until you get a marker from DescribeJob that returns null, indicating that there are no more inventory items available.

You can use the Limit parameter together with the date range parameters.

About Ranged Archive Retrieval

You can initiate an archive retrieval for the whole archive or a range of the archive. In the case of ranged archive retrieval, you specify a byte range to return or the whole archive. The range specified must be megabyte (MB) aligned, that is the range start value must be divisible by 1 MB and range end value plus 1 must be divisible by 1 MB or equal the end of the archive. If the ranged archive retrieval is not megabyte aligned, this operation returns a 400 response. Furthermore, to ensure you get checksum values for data you download using Get Job Output API, the range must be tree hash aligned.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and the underlying REST API, see Initiate a Job and Downloading a Vault Inventory

Expedited and Bulk Archive Retrievals

When retrieving an archive, you can specify one of the following options in the Tier field of the request body:

  • Standard The default type of retrieval, which allows access to any of your archives within several hours. Standard retrievals typically complete within 3–5 hours.

  • Bulk Amazon Glacier’s lowest-cost retrieval option, which enables you to retrieve large amounts of data inexpensively in a day. Bulk retrieval requests typically complete within 5–12 hours.

  • Expedited Amazon Glacier’s option for the fastest retrievals. Archives requested using the expedited retrievals typically become accessible within 1–5 minutes.

For more information about expedited and bulk retrievals, see Retrieving Amazon Glacier Archives.

" }, "InitiateMultipartUpload":{ "name":"InitiateMultipartUpload", "http":{ "method":"POST", "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads", "responseCode":201 }, "input":{"shape":"InitiateMultipartUploadInput"}, "output":{"shape":"InitiateMultipartUploadOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation initiates a multipart upload. Amazon Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see UploadMultipartPart).

When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB.

Every part you upload to this resource (see UploadMultipartPart), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB.

You don't need to know the size of the archive when you start a multipart upload because Amazon Glacier does not require you to specify the overall archive size.

After you complete the multipart upload, Amazon Glacier removes the multipart upload resource referenced by the ID. Amazon Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Initiate Multipart Upload in the Amazon Glacier Developer Guide.

" }, "InitiateVaultLock":{ "name":"InitiateVaultLock", "http":{ "method":"POST", "requestUri":"/{accountId}/vaults/{vaultName}/lock-policy", "responseCode":201 }, "input":{"shape":"InitiateVaultLockInput"}, "output":{"shape":"InitiateVaultLockOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation initiates the vault locking process by doing the following:

  • Installing a vault lock policy on the specified vault.

  • Setting the lock state of vault lock to InProgress.

  • Returning a lock ID, which is used to complete the vault locking process.

You can set one vault lock policy for each vault and this policy can be up to 20 KB in size. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.

You must complete the vault locking process within 24 hours after the vault lock enters the InProgress state. After the 24 hour window ends, the lock ID expires, the vault automatically exits the InProgress state, and the vault lock policy is removed from the vault. You call CompleteVaultLock to complete the vault locking process by setting the state of the vault lock to Locked.

After a vault lock is in the Locked state, you cannot initiate a new vault lock for the vault.

You can abort the vault locking process by calling AbortVaultLock. You can get the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.

If this operation is called when the vault lock is in the InProgress state, the operation returns an AccessDeniedException error. When the vault lock is in the InProgress state you must call AbortVaultLock before you can initiate a new vault lock policy.

" }, "ListJobs":{ "name":"ListJobs", "http":{ "method":"GET", "requestUri":"/{accountId}/vaults/{vaultName}/jobs" }, "input":{"shape":"ListJobsInput"}, "output":{"shape":"ListJobsOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished.

Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.

To retrieve an archive or retrieve a vault inventory from Amazon Glacier, you first initiate a job, and after the job completes, you download the data. For an archive retrieval, the output is the archive data. For an inventory retrieval, it is the inventory list. The List Job operation returns a list of these jobs sorted by job initiation time.

The List Jobs operation supports pagination. You should always check the response Marker field. If there are no more jobs to list, the Marker field is set to null. If there are more jobs to list, the Marker field is set to a non-null value, which you can use to continue the pagination of the list. To return a list of jobs that begins at a specific job, set the marker request parameter to the Marker value for that job that you obtained from a previous List Jobs request.

You can set a maximum limit for the number of jobs returned in the response by specifying the limit parameter in the request. The default limit is 1000. The number of jobs returned might be fewer than the limit, but the number of returned jobs never exceeds the limit.

Additionally, you can filter the jobs list returned by specifying the optional statuscode parameter or completed parameter, or both. Using the statuscode parameter, you can specify to return only jobs that match either the InProgress, Succeeded, or Failed status. Using the completed parameter, you can specify to return only jobs that were completed (true) or jobs that were not completed (false).

For the underlying REST API, see List Jobs.

" }, "ListMultipartUploads":{ "name":"ListMultipartUploads", "http":{ "method":"GET", "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads" }, "input":{"shape":"ListMultipartUploadsInput"}, "output":{"shape":"ListMultipartUploadsOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order.

The List Multipart Uploads operation supports pagination. By default, this operation returns up to 1,000 multipart uploads in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of multipart uploads that begins at a specific upload, set the marker request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the limit parameter in the request.

Note the difference between this operation and listing parts (ListParts). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and the underlying REST API, see Working with Archives in Amazon Glacier and List Multipart Uploads in the Amazon Glacier Developer Guide.

" }, "ListParts":{ "name":"ListParts", "http":{ "method":"GET", "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}" }, "input":{"shape":"ListPartsInput"}, "output":{"shape":"ListPartsOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range.

The List Parts operation supports pagination. By default, this operation returns up to 1,000 uploaded parts in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of parts that begins at a specific part, set the marker request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the limit parameter in the request.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and the underlying REST API, see Working with Archives in Amazon Glacier and List Parts in the Amazon Glacier Developer Guide.

" }, "ListProvisionedCapacity":{ "name":"ListProvisionedCapacity", "http":{ "method":"GET", "requestUri":"/{accountId}/provisioned-capacity" }, "input":{"shape":"ListProvisionedCapacityInput"}, "output":{"shape":"ListProvisionedCapacityOutput"}, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation lists the provisioned capacity for the specified AWS account.

" }, "ListTagsForVault":{ "name":"ListTagsForVault", "http":{ "method":"GET", "requestUri":"/{accountId}/vaults/{vaultName}/tags" }, "input":{"shape":"ListTagsForVaultInput"}, "output":{"shape":"ListTagsForVaultOutput"}, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see Tagging Amazon Glacier Resources.

" }, "ListVaults":{ "name":"ListVaults", "http":{ "method":"GET", "requestUri":"/{accountId}/vaults" }, "input":{"shape":"ListVaultsInput"}, "output":{"shape":"ListVaultsOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.

By default, this operation returns up to 1,000 items. If there are more vaults to list, the response marker field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the marker field is null. To return a list of vaults that begins at a specific vault, set the marker request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the limit parameter in the request.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon Glacier and List Vaults in the Amazon Glacier Developer Guide.

" }, "PurchaseProvisionedCapacity":{ "name":"PurchaseProvisionedCapacity", "http":{ "method":"POST", "requestUri":"/{accountId}/provisioned-capacity", "responseCode":201 }, "input":{"shape":"PurchaseProvisionedCapacityInput"}, "output":{"shape":"PurchaseProvisionedCapacityOutput"}, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation purchases a provisioned capacity unit for an AWS account.

" }, "RemoveTagsFromVault":{ "name":"RemoveTagsFromVault", "http":{ "method":"POST", "requestUri":"/{accountId}/vaults/{vaultName}/tags?operation=remove", "responseCode":204 }, "input":{"shape":"RemoveTagsFromVaultInput"}, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see Tagging Amazon Glacier Resources. This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault.

" }, "SetDataRetrievalPolicy":{ "name":"SetDataRetrievalPolicy", "http":{ "method":"PUT", "requestUri":"/{accountId}/policies/data-retrieval", "responseCode":204 }, "input":{"shape":"SetDataRetrievalPolicyInput"}, "errors":[ {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation.

The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies.

" }, "SetVaultAccessPolicy":{ "name":"SetVaultAccessPolicy", "http":{ "method":"PUT", "requestUri":"/{accountId}/vaults/{vaultName}/access-policy", "responseCode":204 }, "input":{"shape":"SetVaultAccessPolicyInput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the access-policy subresource of the vault. An access policy is specific to a vault and is also called a vault subresource. You can set one access policy per vault and the policy can be up to 20 KB in size. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.

" }, "SetVaultNotifications":{ "name":"SetVaultNotifications", "http":{ "method":"PUT", "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration", "responseCode":204 }, "input":{"shape":"SetVaultNotificationsInput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications.

To configure vault notifications, send a PUT request to the notification-configuration subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon Glacier to send notifications to the topic.

Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events:

  • ArchiveRetrievalCompleted This event occurs when a job that was initiated for an archive retrieval is completed (InitiateJob). The status of the completed job can be \"Succeeded\" or \"Failed\". The notification sent to the SNS topic is the same output as returned from DescribeJob.

  • InventoryRetrievalCompleted This event occurs when a job that was initiated for an inventory retrieval is completed (InitiateJob). The status of the completed job can be \"Succeeded\" or \"Failed\". The notification sent to the SNS topic is the same output as returned from DescribeJob.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide.

" }, "UploadArchive":{ "name":"UploadArchive", "http":{ "method":"POST", "requestUri":"/{accountId}/vaults/{vaultName}/archives", "responseCode":201 }, "input":{"shape":"UploadArchiveInput"}, "output":{"shape":"ArchiveCreationOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"RequestTimeoutException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon Glacier returns the archive ID in the x-amz-archive-id header of the response.

You must use the archive ID to access your data in Amazon Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.

You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums.

You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list.

Archives are immutable. After you upload an archive, you cannot edit the archive or its description.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Uploading an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide.

" }, "UploadMultipartPart":{ "name":"UploadMultipartPart", "http":{ "method":"PUT", "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", "responseCode":204 }, "input":{"shape":"UploadMultipartPartInput"}, "output":{"shape":"UploadMultipartPartOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"MissingParameterValueException"}, {"shape":"RequestTimeoutException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload.

Amazon Glacier rejects your upload part request if any of the following conditions is true:

  • SHA256 tree hash does not matchTo ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums.

  • Part size does not matchThe size of each part except the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size.

    If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail.

  • Range does not alignThe byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail.

This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Upload Part in the Amazon Glacier Developer Guide.

" } }, "shapes":{ "AbortMultipartUploadInput":{ "type":"structure", "required":[ "accountId", "vaultName", "uploadId" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "uploadId":{ "shape":"string", "documentation":"

The upload ID of the multipart upload to delete.

", "location":"uri", "locationName":"uploadId" } }, "documentation":"

Provides options to abort a multipart upload identified by the upload ID.

For information about the underlying REST API, see Abort Multipart Upload. For conceptual information, see Working with Archives in Amazon Glacier.

" }, "AbortVaultLockInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" } }, "documentation":"

The input values for AbortVaultLock.

" }, "ActionCode":{ "type":"string", "enum":[ "ArchiveRetrieval", "InventoryRetrieval" ] }, "AddTagsToVaultInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "Tags":{ "shape":"TagMap", "documentation":"

The tags to add to the vault. Each tag is composed of a key and a value. The value can be an empty string.

" } }, "documentation":"

The input values for AddTagsToVault.

" }, "ArchiveCreationOutput":{ "type":"structure", "members":{ "location":{ "shape":"string", "documentation":"

The relative URI path of the newly added archive resource.

", "location":"header", "locationName":"Location" }, "checksum":{ "shape":"string", "documentation":"

The checksum of the archive computed by Amazon Glacier.

", "location":"header", "locationName":"x-amz-sha256-tree-hash" }, "archiveId":{ "shape":"string", "documentation":"

The ID of the archive. This value is also included as part of the location.

", "location":"header", "locationName":"x-amz-archive-id" } }, "documentation":"

Contains the Amazon Glacier response to your request.

For information about the underlying REST API, see Upload Archive. For conceptual information, see Working with Archives in Amazon Glacier.

" }, "CompleteMultipartUploadInput":{ "type":"structure", "required":[ "accountId", "vaultName", "uploadId" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "uploadId":{ "shape":"string", "documentation":"

The upload ID of the multipart upload.

", "location":"uri", "locationName":"uploadId" }, "archiveSize":{ "shape":"string", "documentation":"

The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.

", "location":"header", "locationName":"x-amz-archive-size" }, "checksum":{ "shape":"string", "documentation":"

The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon Glacier, Amazon Glacier returns an error and the request fails.

", "location":"header", "locationName":"x-amz-sha256-tree-hash" } }, "documentation":"

Provides options to complete a multipart upload operation. This informs Amazon Glacier that all the archive parts have been uploaded and Amazon Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Amazon Glacier returns the URI path of the newly created archive resource.

" }, "CompleteVaultLockInput":{ "type":"structure", "required":[ "accountId", "vaultName", "lockId" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "lockId":{ "shape":"string", "documentation":"

The lockId value is the lock ID obtained from a InitiateVaultLock request.

", "location":"uri", "locationName":"lockId" } }, "documentation":"

The input values for CompleteVaultLock.

" }, "CreateVaultInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" } }, "documentation":"

Provides options to create a vault.

" }, "CreateVaultOutput":{ "type":"structure", "members":{ "location":{ "shape":"string", "documentation":"

The URI of the vault that was created.

", "location":"header", "locationName":"Location" } }, "documentation":"

Contains the Amazon Glacier response to your request.

" }, "DataRetrievalPolicy":{ "type":"structure", "members":{ "Rules":{ "shape":"DataRetrievalRulesList", "documentation":"

The policy rule. Although this is a list type, currently there must be only one rule, which contains a Strategy field and optionally a BytesPerHour field.

" } }, "documentation":"

Data retrieval policy.

" }, "DataRetrievalRule":{ "type":"structure", "members":{ "Strategy":{ "shape":"string", "documentation":"

The type of data retrieval policy to set.

Valid values: BytesPerHour|FreeTier|None

" }, "BytesPerHour":{ "shape":"NullableLong", "documentation":"

The maximum number of bytes that can be retrieved in an hour.

This field is required only if the value of the Strategy field is BytesPerHour. Your PUT operation will be rejected if the Strategy field is not set to BytesPerHour and you set this field.

" } }, "documentation":"

Data retrieval policy rule.

" }, "DataRetrievalRulesList":{ "type":"list", "member":{"shape":"DataRetrievalRule"} }, "DateTime":{"type":"string"}, "DeleteArchiveInput":{ "type":"structure", "required":[ "accountId", "vaultName", "archiveId" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "archiveId":{ "shape":"string", "documentation":"

The ID of the archive to delete.

", "location":"uri", "locationName":"archiveId" } }, "documentation":"

Provides options for deleting an archive from an Amazon Glacier vault.

" }, "DeleteVaultAccessPolicyInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" } }, "documentation":"

DeleteVaultAccessPolicy input.

" }, "DeleteVaultInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" } }, "documentation":"

Provides options for deleting a vault from Amazon Glacier.

" }, "DeleteVaultNotificationsInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" } }, "documentation":"

Provides options for deleting a vault notification configuration from an Amazon Glacier vault.

" }, "DescribeJobInput":{ "type":"structure", "required":[ "accountId", "vaultName", "jobId" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "jobId":{ "shape":"string", "documentation":"

The ID of the job to describe.

", "location":"uri", "locationName":"jobId" } }, "documentation":"

Provides options for retrieving a job description.

" }, "DescribeVaultInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" } }, "documentation":"

Provides options for retrieving metadata for a specific vault in Amazon Glacier.

" }, "DescribeVaultOutput":{ "type":"structure", "members":{ "VaultARN":{ "shape":"string", "documentation":"

The Amazon Resource Name (ARN) of the vault.

" }, "VaultName":{ "shape":"string", "documentation":"

The name of the vault.

" }, "CreationDate":{ "shape":"string", "documentation":"

The Universal Coordinated Time (UTC) date when the vault was created. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z.

" }, "LastInventoryDate":{ "shape":"string", "documentation":"

The Universal Coordinated Time (UTC) date when Amazon Glacier completed the last vault inventory. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z.

" }, "NumberOfArchives":{ "shape":"long", "documentation":"

The number of archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.

" }, "SizeInBytes":{ "shape":"long", "documentation":"

Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.

" } }, "documentation":"

Contains the Amazon Glacier response to your request.

" }, "GetDataRetrievalPolicyInput":{ "type":"structure", "required":["accountId"], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" } }, "documentation":"

Input for GetDataRetrievalPolicy.

" }, "GetDataRetrievalPolicyOutput":{ "type":"structure", "members":{ "Policy":{ "shape":"DataRetrievalPolicy", "documentation":"

Contains the returned data retrieval policy in JSON format.

" } }, "documentation":"

Contains the Amazon Glacier response to the GetDataRetrievalPolicy request.

" }, "GetJobOutputInput":{ "type":"structure", "required":[ "accountId", "vaultName", "jobId" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "jobId":{ "shape":"string", "documentation":"

The job ID whose data is downloaded.

", "location":"uri", "locationName":"jobId" }, "range":{ "shape":"string", "documentation":"

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation downloads the entire output.

If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

  1. Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.

  2. Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.

  3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.

  4. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.

", "location":"header", "locationName":"Range" } }, "documentation":"

Provides options for downloading output of an Amazon Glacier job.

" }, "GetJobOutputOutput":{ "type":"structure", "members":{ "body":{ "shape":"Stream", "documentation":"

The job data, either archive data or inventory data.

" }, "checksum":{ "shape":"string", "documentation":"

The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

  • You get the entire range of the archive.

  • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.

  • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.

", "location":"header", "locationName":"x-amz-sha256-tree-hash" }, "status":{ "shape":"httpstatus", "documentation":"

The HTTP response code for a job output request. The value depends on whether a range was specified in the request.

", "location":"statusCode" }, "contentRange":{ "shape":"string", "documentation":"

The range of bytes returned by Amazon Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

", "location":"header", "locationName":"Content-Range" }, "acceptRanges":{ "shape":"string", "documentation":"

Indicates the range units accepted. For more information, see RFC2616.

", "location":"header", "locationName":"Accept-Ranges" }, "contentType":{ "shape":"string", "documentation":"

The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

", "location":"header", "locationName":"Content-Type" }, "archiveDescription":{ "shape":"string", "documentation":"

The description of an archive.

", "location":"header", "locationName":"x-amz-archive-description" } }, "documentation":"

Contains the Amazon Glacier response to your request.

", "payload":"body" }, "GetVaultAccessPolicyInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" } }, "documentation":"

Input for GetVaultAccessPolicy.

" }, "GetVaultAccessPolicyOutput":{ "type":"structure", "members":{ "policy":{ "shape":"VaultAccessPolicy", "documentation":"

Contains the returned vault access policy as a JSON string.

" } }, "documentation":"

Output for GetVaultAccessPolicy.

", "payload":"policy" }, "GetVaultLockInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" } }, "documentation":"

The input values for GetVaultLock.

" }, "GetVaultLockOutput":{ "type":"structure", "members":{ "Policy":{ "shape":"string", "documentation":"

The vault lock policy as a JSON string, which uses \"\\\" as an escape character.

" }, "State":{ "shape":"string", "documentation":"

The state of the vault lock. InProgress or Locked.

" }, "ExpirationDate":{ "shape":"string", "documentation":"

The UTC date and time at which the lock ID expires. This value can be null if the vault lock is in a Locked state.

" }, "CreationDate":{ "shape":"string", "documentation":"

The UTC date and time at which the vault lock was put into the InProgress state.

" } }, "documentation":"

Contains the Amazon Glacier response to your request.

" }, "GetVaultNotificationsInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" } }, "documentation":"

Provides options for retrieving the notification configuration set on an Amazon Glacier vault.

" }, "GetVaultNotificationsOutput":{ "type":"structure", "members":{ "vaultNotificationConfig":{ "shape":"VaultNotificationConfig", "documentation":"

Returns the notification configuration set on the vault.

" } }, "documentation":"

Contains the Amazon Glacier response to your request.

", "payload":"vaultNotificationConfig" }, "GlacierJobDescription":{ "type":"structure", "members":{ "JobId":{ "shape":"string", "documentation":"

An opaque string that identifies an Amazon Glacier job.

" }, "JobDescription":{ "shape":"string", "documentation":"

The job description you provided when you initiated the job.

" }, "Action":{ "shape":"ActionCode", "documentation":"

The job type. It is either ArchiveRetrieval or InventoryRetrieval.

" }, "ArchiveId":{ "shape":"string", "documentation":"

For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

" }, "VaultARN":{ "shape":"string", "documentation":"

The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

" }, "CreationDate":{ "shape":"string", "documentation":"

The UTC date when the job was created. A string representation of ISO 8601 date format, for example, \"2012-03-20T17:03:43.221Z\".

" }, "Completed":{ "shape":"boolean", "documentation":"

The job status. When a job is completed, you get the job's output.

" }, "StatusCode":{ "shape":"StatusCode", "documentation":"

The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

" }, "StatusMessage":{ "shape":"string", "documentation":"

A friendly message that describes the job status.

" }, "ArchiveSizeInBytes":{ "shape":"Size", "documentation":"

For an ArchiveRetrieval job, this is the size in bytes of the archive being requested for download. For the InventoryRetrieval job, the value is null.

" }, "InventorySizeInBytes":{ "shape":"Size", "documentation":"

For an InventoryRetrieval job, this is the size in bytes of the inventory requested for download. For the ArchiveRetrieval job, the value is null.

" }, "SNSTopic":{ "shape":"string", "documentation":"

An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

" }, "CompletionDate":{ "shape":"string", "documentation":"

The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.

" }, "SHA256TreeHash":{ "shape":"string", "documentation":"

For an ArchiveRetrieval job, it is the checksum of the archive. Otherwise, the value is null.

The SHA256 tree hash value for the requested range of an archive. If the Initiate a Job request for an archive specified a tree-hash aligned range, then this field returns a value.

For the specific case when the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

This field is null in the following situations:

  • Archive retrieval jobs that specify a range that is not tree-hash aligned.

  • Archival jobs that specify a range that is equal to the whole archive and the job status is InProgress.

  • Inventory jobs.

" }, "ArchiveSHA256TreeHash":{ "shape":"string", "documentation":"

The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.

" }, "RetrievalByteRange":{ "shape":"string", "documentation":"

The retrieved byte range for archive retrieval jobs in the form \"StartByteValue-EndByteValue\" If no range was specified in the archive retrieval, then the whole archive is retrieved and StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval jobs this field is null.

" }, "Tier":{ "shape":"string", "documentation":"

The retrieval option to use for the archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

" }, "InventoryRetrievalParameters":{ "shape":"InventoryRetrievalJobDescription", "documentation":"

Parameters used for range inventory retrieval.

" } }, "documentation":"

Describes an Amazon Glacier job.

" }, "InitiateJobInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "jobParameters":{ "shape":"JobParameters", "documentation":"

Provides options for specifying job information.

" } }, "documentation":"

Provides options for initiating an Amazon Glacier job.

", "payload":"jobParameters" }, "InitiateJobOutput":{ "type":"structure", "members":{ "location":{ "shape":"string", "documentation":"

The relative URI path of the job.

", "location":"header", "locationName":"Location" }, "jobId":{ "shape":"string", "documentation":"

The ID of the job.

", "location":"header", "locationName":"x-amz-job-id" } }, "documentation":"

Contains the Amazon Glacier response to your request.

" }, "InitiateMultipartUploadInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "archiveDescription":{ "shape":"string", "documentation":"

The archive description that you are uploading in parts.

The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

", "location":"header", "locationName":"x-amz-archive-description" }, "partSize":{ "shape":"string", "documentation":"

The size of each part except the last, in bytes. The last part can be smaller than this part size.

", "location":"header", "locationName":"x-amz-part-size" } }, "documentation":"

Provides options for initiating a multipart upload to an Amazon Glacier vault.

" }, "InitiateMultipartUploadOutput":{ "type":"structure", "members":{ "location":{ "shape":"string", "documentation":"

The relative URI path of the multipart upload ID Amazon Glacier created.

", "location":"header", "locationName":"Location" }, "uploadId":{ "shape":"string", "documentation":"

The ID of the multipart upload. This value is also included as part of the location.

", "location":"header", "locationName":"x-amz-multipart-upload-id" } }, "documentation":"

The Amazon Glacier response to your request.

" }, "InitiateVaultLockInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "policy":{ "shape":"VaultLockPolicy", "documentation":"

The vault lock policy as a JSON string, which uses \"\\\" as an escape character.

" } }, "documentation":"

The input values for InitiateVaultLock.

", "payload":"policy" }, "InitiateVaultLockOutput":{ "type":"structure", "members":{ "lockId":{ "shape":"string", "documentation":"

The lock ID, which is used to complete the vault locking process.

", "location":"header", "locationName":"x-amz-lock-id" } }, "documentation":"

Contains the Amazon Glacier response to your request.

" }, "InsufficientCapacityException":{ "type":"structure", "members":{ "type":{"shape":"string"}, "code":{"shape":"string"}, "message":{"shape":"string"} }, "documentation":"

Returned if there is insufficient capacity to process this expedited request. This error only applies to expedited retrievals and not to standard or bulk retrievals.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidParameterValueException":{ "type":"structure", "members":{ "type":{ "shape":"string", "documentation":"

Client

" }, "code":{ "shape":"string", "documentation":"

400 Bad Request

" }, "message":{ "shape":"string", "documentation":"

Returned if a parameter of the request is incorrectly specified.

" } }, "documentation":"

Returned if a parameter of the request is incorrectly specified.

", "error":{"httpStatusCode":400}, "exception":true }, "InventoryRetrievalJobDescription":{ "type":"structure", "members":{ "Format":{ "shape":"string", "documentation":"

The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON.

" }, "StartDate":{ "shape":"DateTime", "documentation":"

The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

" }, "EndDate":{ "shape":"DateTime", "documentation":"

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

" }, "Limit":{ "shape":"string", "documentation":"

The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

" }, "Marker":{ "shape":"string", "documentation":"

An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.

" } }, "documentation":"

Describes the options for a range inventory retrieval job.

" }, "InventoryRetrievalJobInput":{ "type":"structure", "members":{ "StartDate":{ "shape":"string", "documentation":"

The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

" }, "EndDate":{ "shape":"string", "documentation":"

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

" }, "Limit":{ "shape":"string", "documentation":"

Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are greater than or equal to 1.

" }, "Marker":{ "shape":"string", "documentation":"

An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null.

" } }, "documentation":"

Provides options for specifying a range inventory retrieval job.

" }, "JobList":{ "type":"list", "member":{"shape":"GlacierJobDescription"} }, "JobParameters":{ "type":"structure", "members":{ "Format":{ "shape":"string", "documentation":"

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are \"CSV\" and \"JSON\".

" }, "Type":{ "shape":"string", "documentation":"

The job type. You can initiate a job to retrieve an archive or get an inventory of a vault. Valid values are \"archive-retrieval\" and \"inventory-retrieval\".

" }, "ArchiveId":{ "shape":"string", "documentation":"

The ID of the archive that you want to retrieve. This field is required only if Type is set to archive-retrieval. An error occurs if you specify this request parameter for an inventory retrieval job request.

" }, "Description":{ "shape":"string", "documentation":"

The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

" }, "SNSTopic":{ "shape":"string", "documentation":"

The Amazon SNS topic ARN to which Amazon Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

" }, "RetrievalByteRange":{ "shape":"string", "documentation":"

The byte range to retrieve for an archive retrieval. in the form \"StartByteValue-EndByteValue\" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

An error occurs if you specify this field for an inventory retrieval job request.

" }, "Tier":{ "shape":"string", "documentation":"

The retrieval option to use for the archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

" }, "InventoryRetrievalParameters":{ "shape":"InventoryRetrievalJobInput", "documentation":"

Input parameters used for range inventory retrieval.

" } }, "documentation":"

Provides options for defining a job.

" }, "LimitExceededException":{ "type":"structure", "members":{ "type":{ "shape":"string", "documentation":"

Client

" }, "code":{ "shape":"string", "documentation":"

400 Bad Request

" }, "message":{ "shape":"string", "documentation":"

Returned if the request results in a vault limit or tags limit being exceeded.

" } }, "documentation":"

Returned if the request results in a vault or account limit being exceeded.

", "error":{"httpStatusCode":400}, "exception":true }, "ListJobsInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "limit":{ "shape":"string", "documentation":"

The maximum number of jobs to be returned. The default limit is 1000. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.

", "location":"querystring", "locationName":"limit" }, "marker":{ "shape":"string", "documentation":"

An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.

", "location":"querystring", "locationName":"marker" }, "statuscode":{ "shape":"string", "documentation":"

The type of job status to return. You can specify the following values: InProgress, Succeeded, or Failed.

", "location":"querystring", "locationName":"statuscode" }, "completed":{ "shape":"string", "documentation":"

The state of the jobs to return. You can specify true or false.

", "location":"querystring", "locationName":"completed" } }, "documentation":"

Provides options for retrieving a job list for an Amazon Glacier vault.

" }, "ListJobsOutput":{ "type":"structure", "members":{ "JobList":{ "shape":"JobList", "documentation":"

A list of job objects. Each job object contains metadata describing the job.

" }, "Marker":{ "shape":"string", "documentation":"

An opaque string used for pagination that specifies the job at which the listing of jobs should begin. You get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of the results started in a previous List Jobs request.

" } }, "documentation":"

Contains the Amazon Glacier response to your request.

" }, "ListMultipartUploadsInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "marker":{ "shape":"string", "documentation":"

An opaque string used for pagination. This value specifies the upload at which the listing of uploads should begin. Get the marker value from a previous List Uploads response. You need only include the marker if you are continuing the pagination of results started in a previous List Uploads request.

", "location":"querystring", "locationName":"marker" }, "limit":{ "shape":"string", "documentation":"

Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 1,000 uploads.

", "location":"querystring", "locationName":"limit" } }, "documentation":"

Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.

" }, "ListMultipartUploadsOutput":{ "type":"structure", "members":{ "UploadsList":{ "shape":"UploadsList", "documentation":"

A list of in-progress multipart uploads.

" }, "Marker":{ "shape":"string", "documentation":"

An opaque string that represents where to continue pagination of the results. You use the marker in a new List Multipart Uploads request to obtain more uploads in the list. If there are no more uploads, this value is null.

" } }, "documentation":"

Contains the Amazon Glacier response to your request.

" }, "ListPartsInput":{ "type":"structure", "required":[ "accountId", "vaultName", "uploadId" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "uploadId":{ "shape":"string", "documentation":"

The upload ID of the multipart upload.

", "location":"uri", "locationName":"uploadId" }, "marker":{ "shape":"string", "documentation":"

An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request.

", "location":"querystring", "locationName":"marker" }, "limit":{ "shape":"string", "documentation":"

The maximum number of parts to be returned. The default limit is 1000. The number of parts returned might be fewer than the specified limit, but the number of returned parts never exceeds the limit.

", "location":"querystring", "locationName":"limit" } }, "documentation":"

Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.

" }, "ListPartsOutput":{ "type":"structure", "members":{ "MultipartUploadId":{ "shape":"string", "documentation":"

The ID of the upload to which the parts are associated.

" }, "VaultARN":{ "shape":"string", "documentation":"

The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.

" }, "ArchiveDescription":{ "shape":"string", "documentation":"

The description of the archive that was specified in the Initiate Multipart Upload request.

" }, "PartSizeInBytes":{ "shape":"long", "documentation":"

The part size in bytes. This is the same value that you specified in the Initiate Multipart Upload request.

" }, "CreationDate":{ "shape":"string", "documentation":"

The UTC time at which the multipart upload was initiated.

" }, "Parts":{ "shape":"PartList", "documentation":"

A list of the part sizes of the multipart upload. Each object in the array contains a RangeBytes and sha256-tree-hash name/value pair.

" }, "Marker":{ "shape":"string", "documentation":"

An opaque string that represents where to continue pagination of the results. You use the marker in a new List Parts request to obtain more jobs in the list. If there are no more parts, this value is null.

" } }, "documentation":"

Contains the Amazon Glacier response to your request.

" }, "ListProvisionedCapacityInput":{ "type":"structure", "required":["accountId"], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, don't include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" } } }, "ListProvisionedCapacityOutput":{ "type":"structure", "members":{ "ProvisionedCapacityList":{ "shape":"ProvisionedCapacityList", "documentation":"

The response body contains the following JSON fields.

" } } }, "ListTagsForVaultInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" } }, "documentation":"

The input value for ListTagsForVaultInput.

" }, "ListTagsForVaultOutput":{ "type":"structure", "members":{ "Tags":{ "shape":"TagMap", "documentation":"

The tags attached to the vault. Each tag is composed of a key and a value.

" } }, "documentation":"

Contains the Amazon Glacier response to your request.

" }, "ListVaultsInput":{ "type":"structure", "required":["accountId"], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "marker":{ "shape":"string", "documentation":"

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

", "location":"querystring", "locationName":"marker" }, "limit":{ "shape":"string", "documentation":"

The maximum number of vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

", "location":"querystring", "locationName":"limit" } }, "documentation":"

Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.

" }, "ListVaultsOutput":{ "type":"structure", "members":{ "VaultList":{ "shape":"VaultList", "documentation":"

List of vaults.

" }, "Marker":{ "shape":"string", "documentation":"

The vault ARN at which to continue pagination of the results. You use the marker in another List Vaults request to obtain more vaults in the list.

" } }, "documentation":"

Contains the Amazon Glacier response to your request.

" }, "MissingParameterValueException":{ "type":"structure", "members":{ "type":{ "shape":"string", "documentation":"

Client.

" }, "code":{ "shape":"string", "documentation":"

400 Bad Request

" }, "message":{ "shape":"string", "documentation":"

Returned if no authentication data is found for the request.

" } }, "documentation":"

Returned if a required header or parameter is missing from the request.

", "error":{"httpStatusCode":400}, "exception":true }, "NotificationEventList":{ "type":"list", "member":{"shape":"string"} }, "NullableLong":{"type":"long"}, "PartList":{ "type":"list", "member":{"shape":"PartListElement"} }, "PartListElement":{ "type":"structure", "members":{ "RangeInBytes":{ "shape":"string", "documentation":"

The byte range of a part, inclusive of the upper value of the range.

" }, "SHA256TreeHash":{ "shape":"string", "documentation":"

The SHA256 tree hash value that Amazon Glacier calculated for the part. This field is never null.

" } }, "documentation":"

A list of the part sizes of the multipart upload.

" }, "PolicyEnforcedException":{ "type":"structure", "members":{ "type":{ "shape":"string", "documentation":"

Client

" }, "code":{ "shape":"string", "documentation":"

PolicyEnforcedException

" }, "message":{ "shape":"string", "documentation":"

InitiateJob request denied by current data retrieval policy.

" } }, "documentation":"

Returned if a retrieval job would exceed the current data policy's retrieval rate limit. For more information about data retrieval policies,

", "error":{"httpStatusCode":400}, "exception":true }, "ProvisionedCapacityDescription":{ "type":"structure", "members":{ "CapacityId":{ "shape":"string", "documentation":"

The ID that identifies the provisioned capacity unit.

" }, "StartDate":{ "shape":"string", "documentation":"

The date that the provisioned capacity unit was purchased, in Universal Coordinated Time (UTC).

" }, "ExpirationDate":{ "shape":"string", "documentation":"

The date that the provisioned capacity unit expires, in Universal Coordinated Time (UTC).

" } }, "documentation":"

The definition for a provisioned capacity unit.

" }, "ProvisionedCapacityList":{ "type":"list", "member":{"shape":"ProvisionedCapacityDescription"} }, "PurchaseProvisionedCapacityInput":{ "type":"structure", "required":["accountId"], "members":{ "accountId":{ "shape":"string", "documentation":"

The AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, don't include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" } } }, "PurchaseProvisionedCapacityOutput":{ "type":"structure", "members":{ "capacityId":{ "shape":"string", "documentation":"

The ID that identifies the provisioned capacity unit.

", "location":"header", "locationName":"x-amz-capacity-id" } } }, "RemoveTagsFromVaultInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

A list of tag keys. Each corresponding tag is removed from the vault.

" } }, "documentation":"

The input value for RemoveTagsFromVaultInput.

" }, "RequestTimeoutException":{ "type":"structure", "members":{ "type":{ "shape":"string", "documentation":"

Client

" }, "code":{ "shape":"string", "documentation":"

408 Request Timeout

" }, "message":{ "shape":"string", "documentation":"

Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.

" } }, "documentation":"

Returned if, when uploading an archive, Amazon Glacier times out while receiving the upload.

", "error":{"httpStatusCode":408}, "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "type":{ "shape":"string", "documentation":"

Client

" }, "code":{ "shape":"string", "documentation":"

404 Not Found

" }, "message":{ "shape":"string", "documentation":"

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

" } }, "documentation":"

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

", "error":{"httpStatusCode":404}, "exception":true }, "ServiceUnavailableException":{ "type":"structure", "members":{ "type":{ "shape":"string", "documentation":"

Server

" }, "code":{ "shape":"string", "documentation":"

500 Internal Server Error

" }, "message":{ "shape":"string", "documentation":"

Returned if the service cannot complete the request.

" } }, "documentation":"

Returned if the service cannot complete the request.

", "error":{"httpStatusCode":500}, "exception":true }, "SetDataRetrievalPolicyInput":{ "type":"structure", "required":["accountId"], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "Policy":{ "shape":"DataRetrievalPolicy", "documentation":"

The data retrieval policy in JSON format.

" } }, "documentation":"

SetDataRetrievalPolicy input.

" }, "SetVaultAccessPolicyInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "policy":{ "shape":"VaultAccessPolicy", "documentation":"

The vault access policy as a JSON string.

" } }, "documentation":"

SetVaultAccessPolicy input.

", "payload":"policy" }, "SetVaultNotificationsInput":{ "type":"structure", "required":[ "accountId", "vaultName" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "vaultNotificationConfig":{ "shape":"VaultNotificationConfig", "documentation":"

Provides options for specifying notification configuration.

" } }, "documentation":"

Provides options to configure notifications that will be sent when specific events happen to a vault.

", "payload":"vaultNotificationConfig" }, "Size":{"type":"long"}, "StatusCode":{ "type":"string", "enum":[ "InProgress", "Succeeded", "Failed" ] }, "Stream":{ "type":"blob", "streaming":true }, "TagKey":{"type":"string"}, "TagKeyList":{ "type":"list", "member":{"shape":"string"} }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"} }, "TagValue":{"type":"string"}, "UploadArchiveInput":{ "type":"structure", "required":[ "vaultName", "accountId" ], "members":{ "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "archiveDescription":{ "shape":"string", "documentation":"

The optional description of the archive you are uploading.

", "location":"header", "locationName":"x-amz-archive-description" }, "checksum":{ "shape":"string", "documentation":"

The SHA256 tree hash of the data being uploaded.

", "location":"header", "locationName":"x-amz-sha256-tree-hash" }, "body":{ "shape":"Stream", "documentation":"

The data to upload.

" } }, "documentation":"

Provides options to add an archive to a vault.

", "payload":"body" }, "UploadListElement":{ "type":"structure", "members":{ "MultipartUploadId":{ "shape":"string", "documentation":"

The ID of a multipart upload.

" }, "VaultARN":{ "shape":"string", "documentation":"

The Amazon Resource Name (ARN) of the vault that contains the archive.

" }, "ArchiveDescription":{ "shape":"string", "documentation":"

The description of the archive that was specified in the Initiate Multipart Upload request.

" }, "PartSizeInBytes":{ "shape":"long", "documentation":"

The part size, in bytes, specified in the Initiate Multipart Upload request. This is the size of all the parts in the upload except the last part, which may be smaller than this size.

" }, "CreationDate":{ "shape":"string", "documentation":"

The UTC time at which the multipart upload was initiated.

" } }, "documentation":"

A list of in-progress multipart uploads for a vault.

" }, "UploadMultipartPartInput":{ "type":"structure", "required":[ "accountId", "vaultName", "uploadId" ], "members":{ "accountId":{ "shape":"string", "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", "location":"uri", "locationName":"accountId" }, "vaultName":{ "shape":"string", "documentation":"

The name of the vault.

", "location":"uri", "locationName":"vaultName" }, "uploadId":{ "shape":"string", "documentation":"

The upload ID of the multipart upload.

", "location":"uri", "locationName":"uploadId" }, "checksum":{ "shape":"string", "documentation":"

The SHA256 tree hash of the data being uploaded.

", "location":"header", "locationName":"x-amz-sha256-tree-hash" }, "range":{ "shape":"string", "documentation":"

Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.

", "location":"header", "locationName":"Content-Range" }, "body":{ "shape":"Stream", "documentation":"

The data to upload.

" } }, "documentation":"

Provides options to upload a part of an archive in a multipart upload operation.

", "payload":"body" }, "UploadMultipartPartOutput":{ "type":"structure", "members":{ "checksum":{ "shape":"string", "documentation":"

The SHA256 tree hash that Amazon Glacier computed for the uploaded part.

", "location":"header", "locationName":"x-amz-sha256-tree-hash" } }, "documentation":"

Contains the Amazon Glacier response to your request.

" }, "UploadsList":{ "type":"list", "member":{"shape":"UploadListElement"} }, "VaultAccessPolicy":{ "type":"structure", "members":{ "Policy":{ "shape":"string", "documentation":"

The vault access policy.

" } }, "documentation":"

Contains the vault access policy.

" }, "VaultList":{ "type":"list", "member":{"shape":"DescribeVaultOutput"} }, "VaultLockPolicy":{ "type":"structure", "members":{ "Policy":{ "shape":"string", "documentation":"

The vault lock policy.

" } }, "documentation":"

Contains the vault lock policy.

" }, "VaultNotificationConfig":{ "type":"structure", "members":{ "SNSTopic":{ "shape":"string", "documentation":"

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

" }, "Events":{ "shape":"NotificationEventList", "documentation":"

A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic.

" } }, "documentation":"

Represents a vault's notification configuration.

" }, "boolean":{"type":"boolean"}, "httpstatus":{"type":"integer"}, "long":{"type":"long"}, "string":{"type":"string"} }, "documentation":"

Amazon Glacier is a storage solution for \"cold data.\"

Amazon Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Amazon Glacier, customers can store their data cost effectively for months, years, or decades. Amazon Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.

Amazon Glacier is a great storage choice when low storage cost is paramount, your data is rarely retrieved, and retrieval latency of several hours is acceptable. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, see Amazon Simple Storage Service (Amazon S3).

You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Amazon Glacier.

If you are a first-time user of Amazon Glacier, we recommend that you begin by reading the following sections in the Amazon Glacier Developer Guide:

  • What is Amazon Glacier - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.

  • Getting Started with Amazon Glacier - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives.

" } botocore-1.5.7/botocore/data/storagegateway/0000777454262600001440000000000013042511307022161 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/storagegateway/2013-06-30/0000777454262600001440000000000013042511307023211 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/storagegateway/2013-06-30/paginators-1.json0000666454262600001440000000172313042511306026413 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeTapeArchives": { "input_token": "Marker", "limit_key": "Limit", "output_token": "Marker", "result_key": "TapeArchives" }, "DescribeTapeRecoveryPoints": { "input_token": "Marker", "limit_key": "Limit", "output_token": "Marker", "result_key": "TapeRecoveryPointInfos" }, "DescribeTapes": { "input_token": "Marker", "limit_key": "Limit", "output_token": "Marker", "result_key": "Tapes" }, "DescribeVTLDevices": { "input_token": "Marker", "limit_key": "Limit", "output_token": "Marker", "result_key": "VTLDevices" }, "ListGateways": { "input_token": "Marker", "limit_key": "Limit", "output_token": "Marker", "result_key": "Gateways" }, "ListVolumes": { "input_token": "Marker", "limit_key": "Limit", "output_token": "Marker", "result_key": "VolumeInfos" } } } botocore-1.5.7/botocore/data/storagegateway/2013-06-30/service-2.json0000666454262600001440000046151513042511306025716 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2013-06-30", "endpointPrefix":"storagegateway", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"AWS Storage Gateway", "signatureVersion":"v4", "targetPrefix":"StorageGateway_20130630", "uid":"storagegateway-2013-06-30" }, "operations":{ "ActivateGateway":{ "name":"ActivateGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ActivateGatewayInput"}, "output":{"shape":"ActivateGatewayOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Activates the gateway you previously deployed on your host. For more information, see Activate the AWS Storage Gateway. In the activation process, you specify information such as the you want to use for storing snapshots, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation.

You must turn on the gateway VM before you can activate your gateway.

" }, "AddCache":{ "name":"AddCache", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddCacheInput"}, "output":{"shape":"AddCacheOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Configures one or more gateway local disks as cache for a cached-volume gateway. This operation is supported only for the gateway-cached volume architecture (see Storage Gateway Concepts).

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.

" }, "AddTagsToResource":{ "name":"AddTagsToResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsToResourceInput"}, "output":{"shape":"AddTagsToResourceOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources:

  • Storage gateways of all types

  • Storage Volumes

  • Virtual Tapes

You can create a maximum of 10 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.

" }, "AddUploadBuffer":{ "name":"AddUploadBuffer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddUploadBufferInput"}, "output":{"shape":"AddUploadBufferOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.

" }, "AddWorkingStorage":{ "name":"AddWorkingStorage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddWorkingStorageInput"}, "output":{"shape":"AddWorkingStorageOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Configures one or more gateway local disks as working storage for a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version 20120630. Use AddUploadBuffer instead.

Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored-volume gateway.

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.

" }, "CancelArchival":{ "name":"CancelArchival", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelArchivalInput"}, "output":{"shape":"CancelArchivalOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.

" }, "CancelRetrieval":{ "name":"CancelRetrieval", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelRetrievalInput"}, "output":{"shape":"CancelRetrievalOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS.

" }, "CreateCachediSCSIVolume":{ "name":"CreateCachediSCSIVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCachediSCSIVolumeInput"}, "output":{"shape":"CreateCachediSCSIVolumeOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Creates a cached volume on a specified cached gateway. This operation is supported only for the gateway-cached volume architecture.

Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.

In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, AWS Storage Gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.

" }, "CreateNFSFileShare":{ "name":"CreateNFSFileShare", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateNFSFileShareInput"}, "output":{"shape":"CreateNFSFileShareOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Creates a file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a Network File System (NFS) interface.

" }, "CreateSnapshot":{ "name":"CreateSnapshot", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSnapshotInput"}, "output":{"shape":"CreateSnapshotOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableError"} ], "documentation":"

Initiates a snapshot of a volume.

AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Working With Snapshots in the AWS Storage Gateway Console.

In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears 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.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference.

Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.

" }, "CreateSnapshotFromVolumeRecoveryPoint":{ "name":"CreateSnapshotFromVolumeRecoveryPoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSnapshotFromVolumeRecoveryPointInput"}, "output":{"shape":"CreateSnapshotFromVolumeRecoveryPointOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"}, {"shape":"ServiceUnavailableError"} ], "documentation":"

Initiates a snapshot of a gateway from a volume recovery point. This operation is supported only for the gateway-cached volume architecture.

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, use ListVolumeRecoveryPoints.

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.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.

" }, "CreateStorediSCSIVolume":{ "name":"CreateStorediSCSIVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateStorediSCSIVolumeInput"}, "output":{"shape":"CreateStorediSCSIVolumeOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Creates a volume on a specified gateway. This operation is supported only for the gateway-stored volume architecture.

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.

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.

" }, "CreateTapeWithBarcode":{ "name":"CreateTapeWithBarcode", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTapeWithBarcodeInput"}, "output":{"shape":"CreateTapeWithBarcodeOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape.

Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.

" }, "CreateTapes":{ "name":"CreateTapes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTapesInput"}, "output":{"shape":"CreateTapesOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes.

Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.

" }, "DeleteBandwidthRateLimit":{ "name":"DeleteBandwidthRateLimit", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteBandwidthRateLimitInput"}, "output":{"shape":"DeleteBandwidthRateLimitOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request.

" }, "DeleteChapCredentials":{ "name":"DeleteChapCredentials", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteChapCredentialsInput"}, "output":{"shape":"DeleteChapCredentialsOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.

" }, "DeleteFileShare":{ "name":"DeleteFileShare", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteFileShareInput"}, "output":{"shape":"DeleteFileShareOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Deletes a file share from a file gateway.

" }, "DeleteGateway":{ "name":"DeleteGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteGatewayInput"}, "output":{"shape":"DeleteGatewayOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.

After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.

You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription.  If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page.

" }, "DeleteSnapshotSchedule":{ "name":"DeleteSnapshotSchedule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSnapshotScheduleInput"}, "output":{"shape":"DeleteSnapshotScheduleOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Deletes a snapshot of a volume.

You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action 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).

To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.

" }, "DeleteTape":{ "name":"DeleteTape", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTapeInput"}, "output":{"shape":"DeleteTapeOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Deletes the specified virtual tape.

" }, "DeleteTapeArchive":{ "name":"DeleteTapeArchive", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTapeArchiveInput"}, "output":{"shape":"DeleteTapeArchiveOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Deletes the specified virtual tape from the virtual tape shelf (VTS).

" }, "DeleteVolume":{ "name":"DeleteVolume", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVolumeInput"}, "output":{"shape":"DeleteVolumeOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. For gateway-stored volumes, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.

Before you delete a gateway volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.

" }, "DescribeBandwidthRateLimit":{ "name":"DescribeBandwidthRateLimit", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeBandwidthRateLimitInput"}, "output":{"shape":"DescribeBandwidthRateLimitOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.

This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

" }, "DescribeCache":{ "name":"DescribeCache", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCacheInput"}, "output":{"shape":"DescribeCacheOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns information about the cache of a gateway. This operation is supported only for the gateway-cached volume architecture.

The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

" }, "DescribeCachediSCSIVolumes":{ "name":"DescribeCachediSCSIVolumes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCachediSCSIVolumesInput"}, "output":{"shape":"DescribeCachediSCSIVolumesOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns a description of the gateway volumes specified in the request. This operation is supported only for the gateway-cached volume architecture.

The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).

" }, "DescribeChapCredentials":{ "name":"DescribeChapCredentials", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeChapCredentialsInput"}, "output":{"shape":"DescribeChapCredentialsOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.

" }, "DescribeGatewayInformation":{ "name":"DescribeGatewayInformation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeGatewayInformationInput"}, "output":{"shape":"DescribeGatewayInformationOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

" }, "DescribeMaintenanceStartTime":{ "name":"DescribeMaintenanceStartTime", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMaintenanceStartTimeInput"}, "output":{"shape":"DescribeMaintenanceStartTimeOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.

" }, "DescribeNFSFileShares":{ "name":"DescribeNFSFileShares", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNFSFileSharesInput"}, "output":{"shape":"DescribeNFSFileSharesOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Gets a description for one or more file shares from a file gateway.

" }, "DescribeSnapshotSchedule":{ "name":"DescribeSnapshotSchedule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSnapshotScheduleInput"}, "output":{"shape":"DescribeSnapshotScheduleOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume.

" }, "DescribeStorediSCSIVolumes":{ "name":"DescribeStorediSCSIVolumes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStorediSCSIVolumesInput"}, "output":{"shape":"DescribeStorediSCSIVolumesOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs.

" }, "DescribeTapeArchives":{ "name":"DescribeTapeArchives", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTapeArchivesInput"}, "output":{"shape":"DescribeTapeArchivesOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns a description of specified virtual tapes in the virtual tape shelf (VTS).

If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

" }, "DescribeTapeRecoveryPoints":{ "name":"DescribeTapeRecoveryPoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTapeRecoveryPointsInput"}, "output":{"shape":"DescribeTapeRecoveryPointsOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.

A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.

" }, "DescribeTapes":{ "name":"DescribeTapes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTapesInput"}, "output":{"shape":"DescribeTapesOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway.

" }, "DescribeUploadBuffer":{ "name":"DescribeUploadBuffer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeUploadBufferInput"}, "output":{"shape":"DescribeUploadBufferOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns information about the upload buffer of a gateway. This operation is supported for both the gateway-stored and gateway-cached volume architectures.

The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.

" }, "DescribeVTLDevices":{ "name":"DescribeVTLDevices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeVTLDevicesInput"}, "output":{"shape":"DescribeVTLDevicesOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns a description of virtual tape library (VTL) devices for the specified gateway. In the response, AWS Storage Gateway returns VTL device information.

The list of VTL devices must be from one gateway.

" }, "DescribeWorkingStorage":{ "name":"DescribeWorkingStorage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWorkingStorageInput"}, "output":{"shape":"DescribeWorkingStorageOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns information about the working storage of a gateway. This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.

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.

The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.

" }, "DisableGateway":{ "name":"DisableGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableGatewayInput"}, "output":{"shape":"DisableGatewayOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Disables a gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.

Use this operation for a gateway-VTL that is not reachable or not functioning.

Once a gateway is disabled it cannot be enabled.

" }, "ListFileShares":{ "name":"ListFileShares", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListFileSharesInput"}, "output":{"shape":"ListFileSharesOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account.

" }, "ListGateways":{ "name":"ListGateways", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListGatewaysInput"}, "output":{"shape":"ListGatewaysOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Lists gateways owned by an AWS account in a region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.

If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.

" }, "ListLocalDisks":{ "name":"ListLocalDisks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListLocalDisksInput"}, "output":{"shape":"ListLocalDisksOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.

The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceInput"}, "output":{"shape":"ListTagsForResourceOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Lists the tags that have been added to the specified resource.

" }, "ListTapes":{ "name":"ListTapes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTapesInput"}, "output":{"shape":"ListTapesOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.

This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes.

" }, "ListVolumeInitiators":{ "name":"ListVolumeInitiators", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListVolumeInitiatorsInput"}, "output":{"shape":"ListVolumeInitiatorsOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not.

" }, "ListVolumeRecoveryPoints":{ "name":"ListVolumeRecoveryPoints", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListVolumeRecoveryPointsInput"}, "output":{"shape":"ListVolumeRecoveryPointsOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Lists the recovery points for a specified gateway. This operation is supported only for the gateway-cached volume architecture.

Each gateway-cached volume has one recovery point. 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 create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.

" }, "ListVolumes":{ "name":"ListVolumes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListVolumesInput"}, "output":{"shape":"ListVolumesOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.

The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes.

" }, "RemoveTagsFromResource":{ "name":"RemoveTagsFromResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTagsFromResourceInput"}, "output":{"shape":"RemoveTagsFromResourceOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Removes one or more tags from the specified resource.

" }, "ResetCache":{ "name":"ResetCache", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetCacheInput"}, "output":{"shape":"ResetCacheOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks.

If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.

" }, "RetrieveTapeArchive":{ "name":"RetrieveTapeArchive", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RetrieveTapeArchiveInput"}, "output":{"shape":"RetrieveTapeArchiveOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS.

Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway.

" }, "RetrieveTapeRecoveryPoint":{ "name":"RetrieveTapeRecoveryPoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RetrieveTapeRecoveryPointInput"}, "output":{"shape":"RetrieveTapeRecoveryPointOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Retrieves the recovery point for the specified virtual tape.

A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.

The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a gateway-VTL. There is no charge for retrieving recovery points.

" }, "SetLocalConsolePassword":{ "name":"SetLocalConsolePassword", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetLocalConsolePasswordInput"}, "output":{"shape":"SetLocalConsolePasswordOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.

" }, "ShutdownGateway":{ "name":"ShutdownGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ShutdownGatewayInput"}, "output":{"shape":"ShutdownGatewayOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

The operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.

If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.

If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.

" }, "StartGateway":{ "name":"StartGateway", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartGatewayInput"}, "output":{"shape":"StartGatewayOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.

When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.

To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.

" }, "UpdateBandwidthRateLimit":{ "name":"UpdateBandwidthRateLimit", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateBandwidthRateLimitInput"}, "output":{"shape":"UpdateBandwidthRateLimitOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains.

By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.

To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

" }, "UpdateChapCredentials":{ "name":"UpdateChapCredentials", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateChapCredentialsInput"}, "output":{"shape":"UpdateChapCredentialsOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.

When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.

" }, "UpdateGatewayInformation":{ "name":"UpdateGatewayInformation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateGatewayInformationInput"}, "output":{"shape":"UpdateGatewayInformationOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

For Gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.

" }, "UpdateGatewaySoftwareNow":{ "name":"UpdateGatewaySoftwareNow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateGatewaySoftwareNowInput"}, "output":{"shape":"UpdateGatewaySoftwareNowOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state.

A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings, respectively.

" }, "UpdateMaintenanceStartTime":{ "name":"UpdateMaintenanceStartTime", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateMaintenanceStartTimeInput"}, "output":{"shape":"UpdateMaintenanceStartTimeOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.

" }, "UpdateNFSFileShare":{ "name":"UpdateNFSFileShare", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateNFSFileShareInput"}, "output":{"shape":"UpdateNFSFileShareOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Updates a file share.

To leave a file share field unchanged, set the corresponding input field to null.

" }, "UpdateSnapshotSchedule":{ "name":"UpdateSnapshotSchedule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateSnapshotScheduleInput"}, "output":{"shape":"UpdateSnapshotScheduleOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Updates a snapshot schedule configured for a gateway volume.

The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.

In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.

" }, "UpdateVTLDeviceType":{ "name":"UpdateVTLDeviceType", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateVTLDeviceTypeInput"}, "output":{"shape":"UpdateVTLDeviceTypeOutput"}, "errors":[ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], "documentation":"

Updates the type of medium changer in a gateway-VTL. When you activate a gateway-VTL, you select a medium changer type for the gateway-VTL. This operation enables you to select a different type of medium changer after a gateway-VTL is activated.

" } }, "shapes":{ "ActivateGatewayInput":{ "type":"structure", "required":[ "ActivationKey", "GatewayName", "GatewayTimezone", "GatewayRegion" ], "members":{ "ActivationKey":{ "shape":"ActivationKey", "documentation":"

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

" }, "GatewayName":{ "shape":"GatewayName", "documentation":"

The name you configured for your gateway.

" }, "GatewayTimezone":{ "shape":"GatewayTimezone", "documentation":"

A value that indicates the time zone you want to set for the gateway. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

" }, "GatewayRegion":{ "shape":"RegionId", "documentation":"

A value that indicates the region where you want to store the snapshot backups. The gateway region specified must be the same region as the region in your Host header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary.

Valid Values: \"us-east-1\", \"us-west-1\", \"us-west-2\", \"eu-west-1\", \"eu-central-1\", \"ap-northeast-1\", \"ap-northeast-2\", \"ap-southeast-1\", \"ap-southeast-2\", \"sa-east-1\"

" }, "GatewayType":{ "shape":"GatewayType", "documentation":"

A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is STORED.

" }, "TapeDriveType":{ "shape":"TapeDriveType", "documentation":"

The value that indicates the type of tape drive to use for gateway-VTL. This field is optional.

Valid Values: \"IBM-ULT3580-TD5\"

" }, "MediumChangerType":{ "shape":"MediumChangerType", "documentation":"

The value that indicates the type of medium changer to use for gateway-VTL. This field is optional.

Valid Values: \"STK-L700\", \"AWS-Gateway-VTL\"

" } }, "documentation":"

A JSON object containing one or more of the following fields:

" }, "ActivateGatewayOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.

For gateways activated prior to September 02, 2015 the gateway ARN contains the gateway name rather than the gateway id. Changing the name of the gateway has no effect on the gateway ARN.

" }, "ActivationKey":{ "type":"string", "max":50, "min":1 }, "AddCacheInput":{ "type":"structure", "required":[ "GatewayARN", "DiskIds" ], "members":{ "GatewayARN":{"shape":"GatewayARN"}, "DiskIds":{"shape":"DiskIds"} } }, "AddCacheOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} } }, "AddTagsToResourceInput":{ "type":"structure", "required":[ "ResourceARN", "Tags" ], "members":{ "ResourceARN":{ "shape":"ResourceARN", "documentation":"

The Amazon Resource Name (ARN) of the resource you want to add tags to.

" }, "Tags":{ "shape":"Tags", "documentation":"

The key-value pair that represents the tag you want to add to the resource. The value can be an empty string.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.

" } }, "documentation":"

AddTagsToResourceInput

" }, "AddTagsToResourceOutput":{ "type":"structure", "members":{ "ResourceARN":{ "shape":"ResourceARN", "documentation":"

The Amazon Resource Name (ARN) of the resource you want to add tags to.

" } }, "documentation":"

AddTagsToResourceOutput

" }, "AddUploadBufferInput":{ "type":"structure", "required":[ "GatewayARN", "DiskIds" ], "members":{ "GatewayARN":{"shape":"GatewayARN"}, "DiskIds":{"shape":"DiskIds"} } }, "AddUploadBufferOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} } }, "AddWorkingStorageInput":{ "type":"structure", "required":[ "GatewayARN", "DiskIds" ], "members":{ "GatewayARN":{"shape":"GatewayARN"}, "DiskIds":{ "shape":"DiskIds", "documentation":"

An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

" } }, "documentation":"

A JSON object containing one or more of the following fields:

" }, "AddWorkingStorageOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the of the gateway for which working storage was configured.

" }, "BandwidthDownloadRateLimit":{ "type":"long", "min":102400 }, "BandwidthType":{ "type":"string", "max":25, "min":3 }, "BandwidthUploadRateLimit":{ "type":"long", "min":51200 }, "Boolean":{"type":"boolean"}, "CachediSCSIVolume":{ "type":"structure", "members":{ "VolumeARN":{ "shape":"VolumeARN", "documentation":"

The Amazon Resource Name (ARN) of the storage volume.

" }, "VolumeId":{ "shape":"VolumeId", "documentation":"

The unique identifier of the volume, e.g. vol-AE4B946D.

" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

One of the VolumeType enumeration values that describes the type of the volume.

" }, "VolumeStatus":{ "shape":"VolumeStatus", "documentation":"

One of the VolumeStatus values that indicates the state of the storage volume.

" }, "VolumeSizeInBytes":{ "shape":"long", "documentation":"

The size of the volume in bytes.

" }, "VolumeProgress":{ "shape":"DoubleObject", "documentation":"

Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the cached volume is not restoring or bootstrapping.

" }, "SourceSnapshotId":{ "shape":"SnapshotId", "documentation":"

If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

" }, "VolumeiSCSIAttributes":{ "shape":"VolumeiSCSIAttributes", "documentation":"

An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

" }, "CreatedDate":{"shape":"CreatedDate"} }, "documentation":"

Describes an iSCSI cached volume.

" }, "CachediSCSIVolumes":{ "type":"list", "member":{"shape":"CachediSCSIVolume"} }, "CancelArchivalInput":{ "type":"structure", "required":[ "GatewayARN", "TapeARN" ], "members":{ "GatewayARN":{"shape":"GatewayARN"}, "TapeARN":{ "shape":"TapeARN", "documentation":"

The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.

" } }, "documentation":"

CancelArchivalInput

" }, "CancelArchivalOutput":{ "type":"structure", "members":{ "TapeARN":{ "shape":"TapeARN", "documentation":"

The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.

" } }, "documentation":"

CancelArchivalOutput

" }, "CancelRetrievalInput":{ "type":"structure", "required":[ "GatewayARN", "TapeARN" ], "members":{ "GatewayARN":{"shape":"GatewayARN"}, "TapeARN":{ "shape":"TapeARN", "documentation":"

The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

" } }, "documentation":"

CancelRetrievalInput

" }, "CancelRetrievalOutput":{ "type":"structure", "members":{ "TapeARN":{ "shape":"TapeARN", "documentation":"

The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.

" } }, "documentation":"

CancelRetrievalOutput

" }, "ChapCredentials":{ "type":"list", "member":{"shape":"ChapInfo"} }, "ChapInfo":{ "type":"structure", "members":{ "TargetARN":{ "shape":"TargetARN", "documentation":"

The Amazon Resource Name (ARN) of the volume.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

" }, "SecretToAuthenticateInitiator":{ "shape":"ChapSecret", "documentation":"

The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

" }, "InitiatorName":{ "shape":"IqnName", "documentation":"

The iSCSI initiator that connects to the target.

" }, "SecretToAuthenticateTarget":{ "shape":"ChapSecret", "documentation":"

The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

" } }, "documentation":"

Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.

" }, "ChapSecret":{ "type":"string", "max":100, "min":1 }, "ClientToken":{ "type":"string", "max":100, "min":5 }, "CreateCachediSCSIVolumeInput":{ "type":"structure", "required":[ "GatewayARN", "VolumeSizeInBytes", "TargetName", "NetworkInterfaceId", "ClientToken" ], "members":{ "GatewayARN":{"shape":"GatewayARN"}, "VolumeSizeInBytes":{"shape":"long"}, "SnapshotId":{"shape":"SnapshotId"}, "TargetName":{"shape":"TargetName"}, "SourceVolumeARN":{ "shape":"VolumeARN", "documentation":"

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

" }, "NetworkInterfaceId":{"shape":"NetworkInterfaceId"}, "ClientToken":{"shape":"ClientToken"} } }, "CreateCachediSCSIVolumeOutput":{ "type":"structure", "members":{ "VolumeARN":{"shape":"VolumeARN"}, "TargetARN":{"shape":"TargetARN"} } }, "CreateNFSFileShareInput":{ "type":"structure", "required":[ "ClientToken", "GatewayARN", "Role", "LocationARN" ], "members":{ "ClientToken":{ "shape":"ClientToken", "documentation":"

A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

" }, "NFSFileShareDefaults":{ "shape":"NFSFileShareDefaults", "documentation":"

File share default values. Optional.

" }, "GatewayARN":{ "shape":"GatewayARN", "documentation":"

The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

" }, "KMSEncrypted":{ "shape":"Boolean", "documentation":"

True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

" }, "KMSKey":{ "shape":"KMSKey", "documentation":"

The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional.

" }, "Role":{ "shape":"Role", "documentation":"

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

" }, "LocationARN":{ "shape":"LocationARN", "documentation":"

The ARN of the backend storage used for storing file data.

" }, "DefaultStorageClass":{ "shape":"StorageClass", "documentation":"

The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

" } }, "documentation":"

CreateNFSFileShareInput

" }, "CreateNFSFileShareOutput":{ "type":"structure", "members":{ "FileShareARN":{ "shape":"FileShareARN", "documentation":"

The Amazon Resource Name (ARN) of the newly created file share.

" } }, "documentation":"

CreateNFSFileShareOutput

" }, "CreateSnapshotFromVolumeRecoveryPointInput":{ "type":"structure", "required":[ "VolumeARN", "SnapshotDescription" ], "members":{ "VolumeARN":{"shape":"VolumeARN"}, "SnapshotDescription":{"shape":"SnapshotDescription"} } }, "CreateSnapshotFromVolumeRecoveryPointOutput":{ "type":"structure", "members":{ "SnapshotId":{"shape":"SnapshotId"}, "VolumeARN":{"shape":"VolumeARN"}, "VolumeRecoveryPointTime":{"shape":"string"} } }, "CreateSnapshotInput":{ "type":"structure", "required":[ "VolumeARN", "SnapshotDescription" ], "members":{ "VolumeARN":{ "shape":"VolumeARN", "documentation":"

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

" }, "SnapshotDescription":{ "shape":"SnapshotDescription", "documentation":"

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

" } }, "documentation":"

A JSON object containing one or more of the following fields:

" }, "CreateSnapshotOutput":{ "type":"structure", "members":{ "VolumeARN":{ "shape":"VolumeARN", "documentation":"

The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.

" }, "SnapshotId":{ "shape":"SnapshotId", "documentation":"

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 (CreateStorediSCSIVolume).

" } }, "documentation":"

A JSON object containing the following fields:

" }, "CreateStorediSCSIVolumeInput":{ "type":"structure", "required":[ "GatewayARN", "DiskId", "PreserveExistingData", "TargetName", "NetworkInterfaceId" ], "members":{ "GatewayARN":{"shape":"GatewayARN"}, "DiskId":{ "shape":"DiskId", "documentation":"

The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

" }, "SnapshotId":{ "shape":"SnapshotId", "documentation":"

The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

" }, "PreserveExistingData":{ "shape":"boolean", "documentation":"

Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.

Valid Values: true, false

" }, "TargetName":{ "shape":"TargetName", "documentation":"

The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes of a gateway.

" }, "NetworkInterfaceId":{ "shape":"NetworkInterfaceId", "documentation":"

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

" } }, "documentation":"

A JSON object containing one or more of the following fields:

" }, "CreateStorediSCSIVolumeOutput":{ "type":"structure", "members":{ "VolumeARN":{ "shape":"VolumeARN", "documentation":"

The Amazon Resource Name (ARN) of the configured volume.

" }, "VolumeSizeInBytes":{ "shape":"long", "documentation":"

The size of the volume in bytes.

" }, "TargetARN":{ "shape":"TargetARN", "documentation":"

he Amazon Resource Name (ARN) of the volume target that includes the iSCSI name that initiators can use to connect to the target.

" } }, "documentation":"

A JSON object containing the following fields:

" }, "CreateTapeWithBarcodeInput":{ "type":"structure", "required":[ "GatewayARN", "TapeSizeInBytes", "TapeBarcode" ], "members":{ "GatewayARN":{ "shape":"GatewayARN", "documentation":"

The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and region.

" }, "TapeSizeInBytes":{ "shape":"TapeSize", "documentation":"

The size, in bytes, of the virtual tape that you want to create.

The size must be aligned by gigabyte (1024*1024*1024 byte).

" }, "TapeBarcode":{ "shape":"TapeBarcode", "documentation":"

The barcode that you want to assign to the tape.

" } }, "documentation":"

CreateTapeWithBarcodeInput

" }, "CreateTapeWithBarcodeOutput":{ "type":"structure", "members":{ "TapeARN":{ "shape":"TapeARN", "documentation":"

A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.

" } }, "documentation":"

CreateTapeOutput

" }, "CreateTapesInput":{ "type":"structure", "required":[ "GatewayARN", "TapeSizeInBytes", "ClientToken", "NumTapesToCreate", "TapeBarcodePrefix" ], "members":{ "GatewayARN":{ "shape":"GatewayARN", "documentation":"

The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and region.

" }, "TapeSizeInBytes":{ "shape":"TapeSize", "documentation":"

The size, in bytes, of the virtual tapes that you want to create.

The size must be aligned by gigabyte (1024*1024*1024 byte).

" }, "ClientToken":{ "shape":"ClientToken", "documentation":"

A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

Using the same ClientToken prevents creating the tape multiple times.

" }, "NumTapesToCreate":{ "shape":"NumTapesToCreate", "documentation":"

The number of virtual tapes that you want to create.

" }, "TapeBarcodePrefix":{ "shape":"TapeBarcodePrefix", "documentation":"

A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.

The prefix must be 1 to 4 characters in length and must be one of the uppercase letters from A to Z.

" } }, "documentation":"

CreateTapesInput

" }, "CreateTapesOutput":{ "type":"structure", "members":{ "TapeARNs":{ "shape":"TapeARNs", "documentation":"

A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created.

" } }, "documentation":"

CreateTapeOutput

" }, "CreatedDate":{"type":"timestamp"}, "DayOfWeek":{ "type":"integer", "max":6, "min":0 }, "DeleteBandwidthRateLimitInput":{ "type":"structure", "required":[ "GatewayARN", "BandwidthType" ], "members":{ "GatewayARN":{"shape":"GatewayARN"}, "BandwidthType":{ "shape":"BandwidthType", "documentation":"

One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete.

Valid Values: Upload, Download, All.

" } }, "documentation":"

A JSON object containing the following fields:

" }, "DeleteBandwidthRateLimitOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the of the gateway whose bandwidth rate information was deleted.

" }, "DeleteChapCredentialsInput":{ "type":"structure", "required":[ "TargetARN", "InitiatorName" ], "members":{ "TargetARN":{ "shape":"TargetARN", "documentation":"

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

" }, "InitiatorName":{ "shape":"IqnName", "documentation":"

The iSCSI initiator that connects to the target.

" } }, "documentation":"

A JSON object containing one or more of the following fields:

" }, "DeleteChapCredentialsOutput":{ "type":"structure", "members":{ "TargetARN":{ "shape":"TargetARN", "documentation":"

The Amazon Resource Name (ARN) of the target.

" }, "InitiatorName":{ "shape":"IqnName", "documentation":"

The iSCSI initiator that connects to the target.

" } }, "documentation":"

A JSON object containing the following fields:

" }, "DeleteFileShareInput":{ "type":"structure", "required":["FileShareARN"], "members":{ "FileShareARN":{ "shape":"FileShareARN", "documentation":"

The Amazon Resource Name (ARN) of the file share to be deleted.

" } }, "documentation":"

DeleteFileShareInput

" }, "DeleteFileShareOutput":{ "type":"structure", "members":{ "FileShareARN":{ "shape":"FileShareARN", "documentation":"

The Amazon Resource Name (ARN) of the deleted file share.

" } }, "documentation":"

DeleteFileShareOutput

" }, "DeleteGatewayInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the id of the gateway to delete.

" }, "DeleteGatewayOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the id of the deleted gateway.

" }, "DeleteSnapshotScheduleInput":{ "type":"structure", "required":["VolumeARN"], "members":{ "VolumeARN":{"shape":"VolumeARN"} } }, "DeleteSnapshotScheduleOutput":{ "type":"structure", "members":{ "VolumeARN":{"shape":"VolumeARN"} } }, "DeleteTapeArchiveInput":{ "type":"structure", "required":["TapeARN"], "members":{ "TapeARN":{ "shape":"TapeARN", "documentation":"

The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).

" } }, "documentation":"

DeleteTapeArchiveInput

" }, "DeleteTapeArchiveOutput":{ "type":"structure", "members":{ "TapeARN":{ "shape":"TapeARN", "documentation":"

The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).

" } }, "documentation":"

DeleteTapeArchiveOutput

" }, "DeleteTapeInput":{ "type":"structure", "required":[ "GatewayARN", "TapeARN" ], "members":{ "GatewayARN":{ "shape":"GatewayARN", "documentation":"

The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and region.

" }, "TapeARN":{ "shape":"TapeARN", "documentation":"

The Amazon Resource Name (ARN) of the virtual tape to delete.

" } }, "documentation":"

DeleteTapeInput

" }, "DeleteTapeOutput":{ "type":"structure", "members":{ "TapeARN":{ "shape":"TapeARN", "documentation":"

The Amazon Resource Name (ARN) of the deleted virtual tape.

" } }, "documentation":"

DeleteTapeOutput

" }, "DeleteVolumeInput":{ "type":"structure", "required":["VolumeARN"], "members":{ "VolumeARN":{ "shape":"VolumeARN", "documentation":"

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

" } }, "documentation":"

A JSON object containing the DeleteVolumeInput$VolumeARN to delete.

" }, "DeleteVolumeOutput":{ "type":"structure", "members":{ "VolumeARN":{ "shape":"VolumeARN", "documentation":"

The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.

" } }, "documentation":"

A JSON object containing the of the storage volume that was deleted

" }, "DescribeBandwidthRateLimitInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the of the gateway.

" }, "DescribeBandwidthRateLimitOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"}, "AverageUploadRateLimitInBitsPerSec":{ "shape":"BandwidthUploadRateLimit", "documentation":"

The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.

" }, "AverageDownloadRateLimitInBitsPerSec":{ "shape":"BandwidthDownloadRateLimit", "documentation":"

The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.

" } }, "documentation":"

A JSON object containing the following fields:

" }, "DescribeCacheInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"} } }, "DescribeCacheOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"}, "DiskIds":{"shape":"DiskIds"}, "CacheAllocatedInBytes":{"shape":"long"}, "CacheUsedPercentage":{"shape":"double"}, "CacheDirtyPercentage":{"shape":"double"}, "CacheHitPercentage":{"shape":"double"}, "CacheMissPercentage":{"shape":"double"} } }, "DescribeCachediSCSIVolumesInput":{ "type":"structure", "required":["VolumeARNs"], "members":{ "VolumeARNs":{"shape":"VolumeARNs"} } }, "DescribeCachediSCSIVolumesOutput":{ "type":"structure", "members":{ "CachediSCSIVolumes":{ "shape":"CachediSCSIVolumes", "documentation":"

An array of objects where each object contains metadata about one cached volume.

" } }, "documentation":"

A JSON object containing the following fields:

" }, "DescribeChapCredentialsInput":{ "type":"structure", "required":["TargetARN"], "members":{ "TargetARN":{ "shape":"TargetARN", "documentation":"

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

" } }, "documentation":"

A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.

" }, "DescribeChapCredentialsOutput":{ "type":"structure", "members":{ "ChapCredentials":{ "shape":"ChapCredentials", "documentation":"

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:

  • InitiatorName: The iSCSI initiator that connects to the target.

  • SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

  • SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

  • TargetARN: The Amazon Resource Name (ARN) of the storage volume.

" } }, "documentation":"

A JSON object containing a .

" }, "DescribeGatewayInformationInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the id of the gateway.

" }, "DescribeGatewayInformationOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"}, "GatewayId":{ "shape":"GatewayId", "documentation":"

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

" }, "GatewayName":{ "shape":"string", "documentation":"

The name you configured for your gateway.

" }, "GatewayTimezone":{ "shape":"GatewayTimezone", "documentation":"

A value that indicates the time zone configured for the gateway.

" }, "GatewayState":{ "shape":"GatewayState", "documentation":"

A value that indicates the operating state of the gateway.

" }, "GatewayNetworkInterfaces":{ "shape":"GatewayNetworkInterfaces", "documentation":"

A NetworkInterface array that contains descriptions of the gateway network interfaces.

" }, "GatewayType":{ "shape":"GatewayType", "documentation":"

The type of the gateway.

" }, "NextUpdateAvailabilityDate":{ "shape":"NextUpdateAvailabilityDate", "documentation":"

The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.

" }, "LastSoftwareUpdate":{ "shape":"LastSoftwareUpdate", "documentation":"

The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response.

" } }, "documentation":"

A JSON object containing the following fields:

" }, "DescribeMaintenanceStartTimeInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the of the gateway.

" }, "DescribeMaintenanceStartTimeOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"}, "HourOfDay":{ "shape":"HourOfDay", "documentation":"

The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

" }, "MinuteOfHour":{ "shape":"MinuteOfHour", "documentation":"

The minute component of the maintenance start time represented as mm, where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.

" }, "DayOfWeek":{ "shape":"DayOfWeek", "documentation":"

An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.

" }, "Timezone":{"shape":"GatewayTimezone"} }, "documentation":"

A JSON object containing the following fields:

" }, "DescribeNFSFileSharesInput":{ "type":"structure", "required":["FileShareARNList"], "members":{ "FileShareARNList":{ "shape":"FileShareARNList", "documentation":"

An array containing the Amazon Resource Name (ARN) of each file share to be described.

" } }, "documentation":"

DescribeNFSFileSharesInput

" }, "DescribeNFSFileSharesOutput":{ "type":"structure", "members":{ "NFSFileShareInfoList":{ "shape":"NFSFileShareInfoList", "documentation":"

An array containing a description for each requested file share.

" } }, "documentation":"

DescribeNFSFileSharesOutput

" }, "DescribeSnapshotScheduleInput":{ "type":"structure", "required":["VolumeARN"], "members":{ "VolumeARN":{ "shape":"VolumeARN", "documentation":"

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

" } }, "documentation":"

A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.

" }, "DescribeSnapshotScheduleOutput":{ "type":"structure", "members":{ "VolumeARN":{"shape":"VolumeARN"}, "StartAt":{"shape":"HourOfDay"}, "RecurrenceInHours":{"shape":"RecurrenceInHours"}, "Description":{"shape":"Description"}, "Timezone":{"shape":"GatewayTimezone"} } }, "DescribeStorediSCSIVolumesInput":{ "type":"structure", "required":["VolumeARNs"], "members":{ "VolumeARNs":{ "shape":"VolumeARNs", "documentation":"

An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

" } }, "documentation":"

A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.

" }, "DescribeStorediSCSIVolumesOutput":{ "type":"structure", "members":{ "StorediSCSIVolumes":{"shape":"StorediSCSIVolumes"} } }, "DescribeTapeArchivesInput":{ "type":"structure", "members":{ "TapeARNs":{ "shape":"TapeARNs", "documentation":"

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

" }, "Marker":{ "shape":"Marker", "documentation":"

An opaque string that indicates the position at which to begin describing virtual tapes.

" }, "Limit":{ "shape":"PositiveIntObject", "documentation":"

Specifies that the number of virtual tapes descried be limited to the specified number.

" } }, "documentation":"

DescribeTapeArchivesInput

" }, "DescribeTapeArchivesOutput":{ "type":"structure", "members":{ "TapeArchives":{ "shape":"TapeArchives", "documentation":"

An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name(ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.

" }, "Marker":{ "shape":"Marker", "documentation":"

An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.

" } }, "documentation":"

DescribeTapeArchivesOutput

" }, "DescribeTapeRecoveryPointsInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"}, "Marker":{ "shape":"Marker", "documentation":"

An opaque string that indicates the position at which to begin describing the virtual tape recovery points.

" }, "Limit":{ "shape":"PositiveIntObject", "documentation":"

Specifies that the number of virtual tape recovery points that are described be limited to the specified number.

" } }, "documentation":"

DescribeTapeRecoveryPointsInput

" }, "DescribeTapeRecoveryPointsOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"}, "TapeRecoveryPointInfos":{ "shape":"TapeRecoveryPointInfos", "documentation":"

An array of TapeRecoveryPointInfos that are available for the specified gateway.

" }, "Marker":{ "shape":"Marker", "documentation":"

An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.

Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.

" } }, "documentation":"

DescribeTapeRecoveryPointsOutput

" }, "DescribeTapesInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"}, "TapeARNs":{ "shape":"TapeARNs", "documentation":"

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, AWS Storage Gateway returns a description of all virtual tapes associated with the specified gateway.

" }, "Marker":{ "shape":"Marker", "documentation":"

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

" }, "Limit":{ "shape":"PositiveIntObject", "documentation":"

Specifies that the number of virtual tapes described be limited to the specified number.

Amazon Web Services may impose its own limit, if this field is not set.

" } }, "documentation":"

DescribeTapesInput

" }, "DescribeTapesOutput":{ "type":"structure", "members":{ "Tapes":{ "shape":"Tapes", "documentation":"

An array of virtual tape descriptions.

" }, "Marker":{ "shape":"Marker", "documentation":"

An opaque string which can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.

If a response does not contain a marker, then there are no more results to be retrieved.

" } }, "documentation":"

DescribeTapesOutput

" }, "DescribeUploadBufferInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"} } }, "DescribeUploadBufferOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"}, "DiskIds":{"shape":"DiskIds"}, "UploadBufferUsedInBytes":{"shape":"long"}, "UploadBufferAllocatedInBytes":{"shape":"long"} } }, "DescribeVTLDevicesInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"}, "VTLDeviceARNs":{ "shape":"VTLDeviceARNs", "documentation":"

An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.

All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

" }, "Marker":{ "shape":"Marker", "documentation":"

An opaque string that indicates the position at which to begin describing the VTL devices.

" }, "Limit":{ "shape":"PositiveIntObject", "documentation":"

Specifies that the number of VTL devices described be limited to the specified number.

" } }, "documentation":"

DescribeVTLDevicesInput

" }, "DescribeVTLDevicesOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"}, "VTLDevices":{ "shape":"VTLDevices", "documentation":"

An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices.

" }, "Marker":{ "shape":"Marker", "documentation":"

An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.

" } }, "documentation":"

DescribeVTLDevicesOutput

" }, "DescribeWorkingStorageInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the of the gateway.

" }, "DescribeWorkingStorageOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"}, "DiskIds":{ "shape":"DiskIds", "documentation":"

An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

" }, "WorkingStorageUsedInBytes":{ "shape":"long", "documentation":"

The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.

" }, "WorkingStorageAllocatedInBytes":{ "shape":"long", "documentation":"

The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.

" } }, "documentation":"

A JSON object containing the following fields:

" }, "Description":{ "type":"string", "max":255, "min":1 }, "DeviceType":{ "type":"string", "max":50, "min":2 }, "DeviceiSCSIAttributes":{ "type":"structure", "members":{ "TargetARN":{ "shape":"TargetARN", "documentation":"

Specifies the unique Amazon Resource Name(ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.

" }, "NetworkInterfaceId":{ "shape":"NetworkInterfaceId", "documentation":"

The network interface identifier of the VTL device.

" }, "NetworkInterfacePort":{ "shape":"integer", "documentation":"

The port used to communicate with iSCSI VTL device targets.

" }, "ChapEnabled":{ "shape":"boolean", "documentation":"

Indicates whether mutual CHAP is enabled for the iSCSI target.

" } }, "documentation":"

Lists iSCSI information about a VTL device.

" }, "DisableGatewayInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

DisableGatewayInput

" }, "DisableGatewayOutput":{ "type":"structure", "members":{ "GatewayARN":{ "shape":"GatewayARN", "documentation":"

The unique Amazon Resource Name of the disabled gateway.

" } }, "documentation":"

DisableGatewayOutput

" }, "Disk":{ "type":"structure", "members":{ "DiskId":{"shape":"DiskId"}, "DiskPath":{"shape":"string"}, "DiskNode":{"shape":"string"}, "DiskStatus":{"shape":"string"}, "DiskSizeInBytes":{"shape":"long"}, "DiskAllocationType":{"shape":"DiskAllocationType"}, "DiskAllocationResource":{"shape":"string"} } }, "DiskAllocationType":{ "type":"string", "max":100, "min":3 }, "DiskId":{ "type":"string", "max":300, "min":1 }, "DiskIds":{ "type":"list", "member":{"shape":"DiskId"} }, "Disks":{ "type":"list", "member":{"shape":"Disk"} }, "DoubleObject":{"type":"double"}, "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" ] }, "FileShareARN":{ "type":"string", "documentation":"

The Amazon Resource Name (ARN) of the file share.

", "max":500, "min":50 }, "FileShareARNList":{ "type":"list", "member":{"shape":"FileShareARN"}, "max":10, "min":1 }, "FileShareId":{ "type":"string", "documentation":"

The ID of the file share.

", "max":30, "min":12 }, "FileShareInfo":{ "type":"structure", "members":{ "FileShareARN":{"shape":"FileShareARN"}, "FileShareId":{"shape":"FileShareId"}, "FileShareStatus":{"shape":"FileShareStatus"}, "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

Describes a file share.

" }, "FileShareInfoList":{ "type":"list", "member":{"shape":"FileShareInfo"} }, "FileShareStatus":{ "type":"string", "documentation":"

The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE and DELETING.

", "max":50, "min":3 }, "GatewayARN":{ "type":"string", "documentation":"

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

", "max":500, "min":50 }, "GatewayId":{ "type":"string", "max":30, "min":12 }, "GatewayInfo":{ "type":"structure", "members":{ "GatewayId":{ "shape":"GatewayId", "documentation":"

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

" }, "GatewayARN":{ "shape":"GatewayARN", "documentation":"

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

" }, "GatewayType":{ "shape":"GatewayType", "documentation":"

The type of the gateway.

" }, "GatewayOperationalState":{ "shape":"GatewayOperationalState", "documentation":"

The state of the gateway.

Valid Values: DISABLED or ACTIVE

" }, "GatewayName":{ "shape":"string", "documentation":"

The name of the gateway.

" } }, "documentation":"

Describes a gateway object.

" }, "GatewayName":{ "type":"string", "documentation":"

The name you configured for your gateway.

", "max":255, "min":2, "pattern":"^[ -\\.0-\\[\\]-~]*[!-\\.0-\\[\\]-~][ -\\.0-\\[\\]-~]*$" }, "GatewayNetworkInterfaces":{ "type":"list", "member":{"shape":"NetworkInterface"} }, "GatewayOperationalState":{ "type":"string", "max":25, "min":2 }, "GatewayState":{ "type":"string", "max":25, "min":2 }, "GatewayTimezone":{ "type":"string", "max":10, "min":3 }, "GatewayType":{ "type":"string", "max":20, "min":2 }, "Gateways":{ "type":"list", "member":{"shape":"GatewayInfo"} }, "HourOfDay":{ "type":"integer", "max":23, "min":0 }, "Initiator":{ "type":"string", "max":50, "min":1 }, "Initiators":{ "type":"list", "member":{"shape":"Initiator"} }, "InternalServerError":{ "type":"structure", "members":{ "message":{ "shape":"string", "documentation":"

A human-readable message describing the error that occurred.

" }, "error":{ "shape":"StorageGatewayError", "documentation":"

A StorageGatewayError that provides more information about the cause of the error.

" } }, "documentation":"

An internal server error has occurred during the request. For more information, see the error and message fields.

", "exception":true }, "InvalidGatewayRequestException":{ "type":"structure", "members":{ "message":{ "shape":"string", "documentation":"

A human-readable message describing the error that occurred.

" }, "error":{ "shape":"StorageGatewayError", "documentation":"

A StorageGatewayError that provides more detail about the cause of the error.

" } }, "documentation":"

An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

", "exception":true }, "IqnName":{ "type":"string", "max":255, "min":1, "pattern":"[0-9a-z:.-]+" }, "KMSKey":{ "type":"string", "documentation":"

The ARN of the KMS key used for Amazon S3 server side encryption.

", "max":2048, "min":20 }, "LastSoftwareUpdate":{ "type":"string", "max":25, "min":1 }, "ListFileSharesInput":{ "type":"structure", "members":{ "GatewayARN":{ "shape":"GatewayARN", "documentation":"

The Amazon resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed.

" }, "Limit":{ "shape":"PositiveIntObject", "documentation":"

The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional.

" }, "Marker":{ "shape":"Marker", "documentation":"

Opaque pagination token returned from a previous ListFileShares operation. If present, Marker specifies where to continue the list from after a previous call to ListFileShares. Optional.

" } }, "documentation":"

ListFileShareInput

" }, "ListFileSharesOutput":{ "type":"structure", "members":{ "Marker":{ "shape":"Marker", "documentation":"

If the request includes Marker, the response returns that value in this field.

" }, "NextMarker":{ "shape":"Marker", "documentation":"

If a value is present, there are more file shares to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file shares.

" }, "FileShareInfoList":{ "shape":"FileShareInfoList", "documentation":"

An array of information about the file gateway's file shares.

" } }, "documentation":"

ListFileShareOutput

" }, "ListGatewaysInput":{ "type":"structure", "members":{ "Marker":{ "shape":"Marker", "documentation":"

An opaque string that indicates the position at which to begin the returned list of gateways.

" }, "Limit":{ "shape":"PositiveIntObject", "documentation":"

Specifies that the list of gateways returned be limited to the specified number of items.

" } }, "documentation":"

A JSON object containing zero or more of the following fields:

" }, "ListGatewaysOutput":{ "type":"structure", "members":{ "Gateways":{"shape":"Gateways"}, "Marker":{"shape":"Marker"} } }, "ListLocalDisksInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the of the gateway.

" }, "ListLocalDisksOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"}, "Disks":{"shape":"Disks"} } }, "ListTagsForResourceInput":{ "type":"structure", "required":["ResourceARN"], "members":{ "ResourceARN":{ "shape":"ResourceARN", "documentation":"

The Amazon Resource Name (ARN) of the resource for which you want to list tags.

" }, "Marker":{ "shape":"Marker", "documentation":"

An opaque string that indicates the position at which to begin returning the list of tags.

" }, "Limit":{ "shape":"PositiveIntObject", "documentation":"

Specifies that the list of tags returned be limited to the specified number of items.

" } }, "documentation":"

ListTagsForResourceInput

" }, "ListTagsForResourceOutput":{ "type":"structure", "members":{ "ResourceARN":{ "shape":"ResourceARN", "documentation":"

he Amazon Resource Name (ARN) of the resource for which you want to list tags.

" }, "Marker":{ "shape":"Marker", "documentation":"

An opaque string that indicates the position at which to stop returning the list of tags.

" }, "Tags":{ "shape":"Tags", "documentation":"

An array that contains the tags for the specified resource.

" } }, "documentation":"

ListTagsForResourceOutput

" }, "ListTapesInput":{ "type":"structure", "members":{ "TapeARNs":{"shape":"TapeARNs"}, "Marker":{ "shape":"Marker", "documentation":"

A string that indicates the position at which to begin the returned list of tapes.

" }, "Limit":{ "shape":"PositiveIntObject", "documentation":"

An optional number limit for the tapes in the list returned by this call.

" } }, "documentation":"

A JSON object that contains one or more of the following fields:

" }, "ListTapesOutput":{ "type":"structure", "members":{ "TapeInfos":{"shape":"TapeInfos"}, "Marker":{ "shape":"Marker", "documentation":"

A string that indicates the position at which to begin returning the next list of tapes. Use the marker in your next request to continue pagination of tapes. If there are no more tapes to list, this element does not appear in the response body.

" } }, "documentation":"

A JSON object containing the following fields:

" }, "ListVolumeInitiatorsInput":{ "type":"structure", "required":["VolumeARN"], "members":{ "VolumeARN":{ "shape":"VolumeARN", "documentation":"

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for the gateway.

" } }, "documentation":"

ListVolumeInitiatorsInput

" }, "ListVolumeInitiatorsOutput":{ "type":"structure", "members":{ "Initiators":{ "shape":"Initiators", "documentation":"

The host names and port numbers of all iSCSI initiators that are connected to the gateway.

" } }, "documentation":"

ListVolumeInitiatorsOutput

" }, "ListVolumeRecoveryPointsInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"} } }, "ListVolumeRecoveryPointsOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"}, "VolumeRecoveryPointInfos":{"shape":"VolumeRecoveryPointInfos"} } }, "ListVolumesInput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"}, "Marker":{ "shape":"Marker", "documentation":"

A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

" }, "Limit":{ "shape":"PositiveIntObject", "documentation":"

Specifies that the list of volumes returned be limited to the specified number of items.

" } }, "documentation":"

A JSON object that contains one or more of the following fields:

" }, "ListVolumesOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"}, "Marker":{"shape":"Marker"}, "VolumeInfos":{"shape":"VolumeInfos"} } }, "LocalConsolePassword":{ "type":"string", "max":512, "min":6, "pattern":"^[ -~]+$", "sensitive":true }, "LocationARN":{ "type":"string", "documentation":"

The ARN of the backend storage used for storing file data.

", "max":310, "min":16 }, "Marker":{ "type":"string", "max":1000, "min":1 }, "MediumChangerType":{ "type":"string", "max":50, "min":2 }, "MinuteOfHour":{ "type":"integer", "max":59, "min":0 }, "NFSFileShareDefaults":{ "type":"structure", "members":{ "FileMode":{ "shape":"PermissionMode", "documentation":"

The Unix file mode in the form \"nnnn\". For example, \"0666\" represents the default file mode inside the file share. The default value is 0666.

" }, "DirectoryMode":{ "shape":"PermissionMode", "documentation":"

The Unix directory mode in the form \"nnnn\". For example, \"0666\" represents the default access mode for all directories inside the file share. The default value is 0777.

" }, "GroupId":{ "shape":"PermissionId", "documentation":"

The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody.

" }, "OwnerId":{ "shape":"PermissionId", "documentation":"

The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody.

" } }, "documentation":"

Describes file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions.

" }, "NFSFileShareInfo":{ "type":"structure", "members":{ "NFSFileShareDefaults":{"shape":"NFSFileShareDefaults"}, "FileShareARN":{"shape":"FileShareARN"}, "FileShareId":{"shape":"FileShareId"}, "FileShareStatus":{"shape":"FileShareStatus"}, "GatewayARN":{"shape":"GatewayARN"}, "KMSEncrypted":{ "shape":"boolean", "documentation":"

True to use Amazon S3 server side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

" }, "KMSKey":{"shape":"KMSKey"}, "Path":{"shape":"Path"}, "Role":{"shape":"Role"}, "LocationARN":{"shape":"LocationARN"}, "DefaultStorageClass":{ "shape":"StorageClass", "documentation":"

The default storage class for objects put into an Amazon S3 bucket by file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

" } }, "documentation":"

The Unix file permissions and ownership information assigned, by default, to native S3 objects when Storage Gateway discovers them in S3 buckets.

" }, "NFSFileShareInfoList":{ "type":"list", "member":{"shape":"NFSFileShareInfo"} }, "NetworkInterface":{ "type":"structure", "members":{ "Ipv4Address":{ "shape":"string", "documentation":"

The Internet Protocol version 4 (IPv4) address of the interface.

" }, "MacAddress":{ "shape":"string", "documentation":"

The Media Access Control (MAC) address of the interface.

This is currently unsupported and will not be returned in output.

" }, "Ipv6Address":{ "shape":"string", "documentation":"

The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.

" } }, "documentation":"

Describes a gateway's network interface.

" }, "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" }, "NextUpdateAvailabilityDate":{ "type":"string", "max":25, "min":1 }, "NumTapesToCreate":{ "type":"integer", "max":10, "min":1 }, "Path":{ "type":"string", "documentation":"

The file share path used by the NFS client to identify the mount point.

" }, "PermissionId":{ "type":"long", "max":4294967294, "min":0 }, "PermissionMode":{ "type":"string", "max":4, "min":1, "pattern":"^[0-7]{4}$" }, "PositiveIntObject":{ "type":"integer", "min":1 }, "RecurrenceInHours":{ "type":"integer", "max":24, "min":1 }, "RegionId":{ "type":"string", "max":25, "min":1 }, "RemoveTagsFromResourceInput":{ "type":"structure", "required":[ "ResourceARN", "TagKeys" ], "members":{ "ResourceARN":{ "shape":"ResourceARN", "documentation":"

The Amazon Resource Name (ARN) of the resource you want to remove the tags from.

" }, "TagKeys":{ "shape":"TagKeys", "documentation":"

The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair.

" } }, "documentation":"

RemoveTagsFromResourceInput

" }, "RemoveTagsFromResourceOutput":{ "type":"structure", "members":{ "ResourceARN":{ "shape":"ResourceARN", "documentation":"

The Amazon Resource Name (ARN) of the resource that the tags were removed from.

" } }, "documentation":"

RemoveTagsFromResourceOutput

" }, "ResetCacheInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"} } }, "ResetCacheOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} } }, "ResourceARN":{ "type":"string", "max":500, "min":50 }, "RetrieveTapeArchiveInput":{ "type":"structure", "required":[ "TapeARN", "GatewayARN" ], "members":{ "TapeARN":{ "shape":"TapeARN", "documentation":"

The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).

" }, "GatewayARN":{ "shape":"GatewayARN", "documentation":"

The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and region.

You retrieve archived virtual tapes to only one gateway and the gateway must be a gateway-VTL.

" } }, "documentation":"

RetrieveTapeArchiveInput

" }, "RetrieveTapeArchiveOutput":{ "type":"structure", "members":{ "TapeARN":{ "shape":"TapeARN", "documentation":"

The Amazon Resource Name (ARN) of the retrieved virtual tape.

" } }, "documentation":"

RetrieveTapeArchiveOutput

" }, "RetrieveTapeRecoveryPointInput":{ "type":"structure", "required":[ "TapeARN", "GatewayARN" ], "members":{ "TapeARN":{ "shape":"TapeARN", "documentation":"

The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.

" }, "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

RetrieveTapeRecoveryPointInput

" }, "RetrieveTapeRecoveryPointOutput":{ "type":"structure", "members":{ "TapeARN":{ "shape":"TapeARN", "documentation":"

The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.

" } }, "documentation":"

RetrieveTapeRecoveryPointOutput

" }, "Role":{ "type":"string", "documentation":"

The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.

", "max":2048, "min":20 }, "ServiceUnavailableError":{ "type":"structure", "members":{ "message":{ "shape":"string", "documentation":"

A human-readable message describing the error that occurred.

" }, "error":{ "shape":"StorageGatewayError", "documentation":"

A StorageGatewayError that provides more information about the cause of the error.

" } }, "documentation":"

An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.

", "exception":true }, "SetLocalConsolePasswordInput":{ "type":"structure", "required":[ "GatewayARN", "LocalConsolePassword" ], "members":{ "GatewayARN":{"shape":"GatewayARN"}, "LocalConsolePassword":{ "shape":"LocalConsolePassword", "documentation":"

The password you want to set for your VM local console.

" } }, "documentation":"

SetLocalConsolePasswordInput

" }, "SetLocalConsolePasswordOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} } }, "ShutdownGatewayInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the of the gateway to shut down.

" }, "ShutdownGatewayOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the of the gateway that was shut down.

" }, "SnapshotDescription":{ "type":"string", "max":255, "min":1 }, "SnapshotId":{ "type":"string", "pattern":"\\Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\\z" }, "StartGatewayInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the of the gateway to start.

" }, "StartGatewayOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the of the gateway that was restarted.

" }, "StorageClass":{ "type":"string", "documentation":"

", "max":20, "min":5 }, "StorageGatewayError":{ "type":"structure", "members":{ "errorCode":{ "shape":"ErrorCode", "documentation":"

Additional information about the error.

" }, "errorDetails":{ "shape":"errorDetails", "documentation":"

Human-readable text that provides detail about the error that occurred.

" } }, "documentation":"

Provides additional information about an error that was returned by the service as an or. See the errorCode and errorDetails members for more information about the error.

" }, "StorediSCSIVolume":{ "type":"structure", "members":{ "VolumeARN":{ "shape":"VolumeARN", "documentation":"

The Amazon Resource Name (ARN) of the storage volume.

" }, "VolumeId":{ "shape":"VolumeId", "documentation":"

The unique identifier of the volume, e.g. vol-AE4B946D.

" }, "VolumeType":{ "shape":"VolumeType", "documentation":"

One of the VolumeType enumeration values describing the type of the volume.

" }, "VolumeStatus":{ "shape":"VolumeStatus", "documentation":"

One of the VolumeStatus values that indicates the state of the storage volume.

" }, "VolumeSizeInBytes":{ "shape":"long", "documentation":"

The size of the volume in bytes.

" }, "VolumeProgress":{ "shape":"DoubleObject", "documentation":"

Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

" }, "VolumeDiskId":{ "shape":"DiskId", "documentation":"

The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

" }, "SourceSnapshotId":{ "shape":"SnapshotId", "documentation":"

If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

" }, "PreservedExistingData":{ "shape":"boolean", "documentation":"

Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

Valid Values: true, false

" }, "VolumeiSCSIAttributes":{ "shape":"VolumeiSCSIAttributes", "documentation":"

An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

" }, "CreatedDate":{"shape":"CreatedDate"} }, "documentation":"

Describes an iSCSI stored volume.

" }, "StorediSCSIVolumes":{ "type":"list", "member":{"shape":"StorediSCSIVolume"} }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{"shape":"TagKey"}, "Value":{"shape":"TagValue"} } }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"} }, "TagValue":{ "type":"string", "max":256 }, "Tags":{ "type":"list", "member":{"shape":"Tag"} }, "Tape":{ "type":"structure", "members":{ "TapeARN":{ "shape":"TapeARN", "documentation":"

The Amazon Resource Name (ARN) of the virtual tape.

" }, "TapeBarcode":{ "shape":"TapeBarcode", "documentation":"

The barcode that identifies a specific virtual tape.

" }, "TapeCreatedDate":{"shape":"Time"}, "TapeSizeInBytes":{ "shape":"TapeSize", "documentation":"

The size, in bytes, of the virtual tape.

" }, "TapeStatus":{ "shape":"TapeStatus", "documentation":"

The current state of the virtual tape.

" }, "VTLDevice":{ "shape":"VTLDeviceARN", "documentation":"

The virtual tape library (VTL) device that the virtual tape is associated with.

" }, "Progress":{ "shape":"DoubleObject", "documentation":"

For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.

Range: 0 (not started) to 100 (complete).

" } }, "documentation":"

Describes a virtual tape object.

" }, "TapeARN":{ "type":"string", "max":500, "min":50, "pattern":"^arn:(aws|aws-cn):storagegateway:[a-z\\-0-9]+:[0-9]+:tape\\/[0-9A-Z]{7,16}$" }, "TapeARNs":{ "type":"list", "member":{"shape":"TapeARN"}, "documentation":"

The Amazon Resource Name (ARN) of each of the tapes you want to list. If you don't specify a tape ARN, the response lists all tapes in both your VTL and VTS.

" }, "TapeArchive":{ "type":"structure", "members":{ "TapeARN":{ "shape":"TapeARN", "documentation":"

The Amazon Resource Name (ARN) of an archived virtual tape.

" }, "TapeBarcode":{ "shape":"TapeBarcode", "documentation":"

The barcode that identifies the archived virtual tape.

" }, "TapeCreatedDate":{"shape":"Time"}, "TapeSizeInBytes":{ "shape":"TapeSize", "documentation":"

The size, in bytes, of the archived virtual tape.

" }, "CompletionTime":{ "shape":"Time", "documentation":"

The time that the archiving of the virtual tape was completed.

The string format of the completion time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

" }, "RetrievedTo":{ "shape":"GatewayARN", "documentation":"

The Amazon Resource Name (ARN) of the gateway-VTL that the virtual tape is being retrieved to.

The virtual tape is retrieved from the virtual tape shelf (VTS).

" }, "TapeStatus":{ "shape":"TapeArchiveStatus", "documentation":"

The current state of the archived virtual tape.

" } }, "documentation":"

Represents a virtual tape that is archived in the virtual tape shelf (VTS).

" }, "TapeArchiveStatus":{"type":"string"}, "TapeArchives":{ "type":"list", "member":{"shape":"TapeArchive"} }, "TapeBarcode":{ "type":"string", "max":16, "min":7, "pattern":"^[A-Z0-9]*$" }, "TapeBarcodePrefix":{ "type":"string", "max":4, "min":1, "pattern":"^[A-Z]*$" }, "TapeDriveType":{ "type":"string", "max":50, "min":2 }, "TapeInfo":{ "type":"structure", "members":{ "TapeARN":{ "shape":"TapeARN", "documentation":"

The Amazon Resource Name (ARN) of a virtual tape.

" }, "TapeBarcode":{ "shape":"TapeBarcode", "documentation":"

The barcode that identifies a specific virtual tape.

" }, "TapeSizeInBytes":{ "shape":"TapeSize", "documentation":"

The size, in bytes, of a virtual tape.

" }, "TapeStatus":{ "shape":"TapeStatus", "documentation":"

The status of the tape.

" }, "GatewayARN":{ "shape":"GatewayARN", "documentation":"

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

" } }, "documentation":"

Describes a virtual tape.

" }, "TapeInfos":{ "type":"list", "member":{"shape":"TapeInfo"}, "documentation":"

An array of TapeInfo objects, where each object describes an a single tape. If there not tapes in the tape library or VTS, then the TapeInfos is an empty array.

" }, "TapeRecoveryPointInfo":{ "type":"structure", "members":{ "TapeARN":{ "shape":"TapeARN", "documentation":"

The Amazon Resource Name (ARN) of the virtual tape.

" }, "TapeRecoveryPointTime":{ "shape":"Time", "documentation":"

The time when the point-in-time view of the virtual tape was replicated for later recovery.

The string format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

" }, "TapeSizeInBytes":{ "shape":"TapeSize", "documentation":"

The size, in bytes, of the virtual tapes to recover.

" }, "TapeStatus":{"shape":"TapeRecoveryPointStatus"} }, "documentation":"

Describes a recovery point.

" }, "TapeRecoveryPointInfos":{ "type":"list", "member":{"shape":"TapeRecoveryPointInfo"} }, "TapeRecoveryPointStatus":{"type":"string"}, "TapeSize":{"type":"long"}, "TapeStatus":{"type":"string"}, "Tapes":{ "type":"list", "member":{"shape":"Tape"} }, "TargetARN":{ "type":"string", "max":800, "min":50 }, "TargetName":{ "type":"string", "max":200, "min":1, "pattern":"^[-\\.;a-z0-9]+$" }, "Time":{"type":"timestamp"}, "UpdateBandwidthRateLimitInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"}, "AverageUploadRateLimitInBitsPerSec":{ "shape":"BandwidthUploadRateLimit", "documentation":"

The average upload bandwidth rate limit in bits per second.

" }, "AverageDownloadRateLimitInBitsPerSec":{ "shape":"BandwidthDownloadRateLimit", "documentation":"

The average download bandwidth rate limit in bits per second.

" } }, "documentation":"

A JSON object containing one or more of the following fields:

" }, "UpdateBandwidthRateLimitOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the of the gateway whose throttle information was updated.

" }, "UpdateChapCredentialsInput":{ "type":"structure", "required":[ "TargetARN", "SecretToAuthenticateInitiator", "InitiatorName" ], "members":{ "TargetARN":{ "shape":"TargetARN", "documentation":"

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.

" }, "SecretToAuthenticateInitiator":{ "shape":"ChapSecret", "documentation":"

The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

The secret key must be between 12 and 16 bytes when encoded in UTF-8.

" }, "InitiatorName":{ "shape":"IqnName", "documentation":"

The iSCSI initiator that connects to the target.

" }, "SecretToAuthenticateTarget":{ "shape":"ChapSecret", "documentation":"

The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

Byte constraints: Minimum bytes of 12. Maximum bytes of 16.

The secret key must be between 12 and 16 bytes when encoded in UTF-8.

" } }, "documentation":"

A JSON object containing one or more of the following fields:

" }, "UpdateChapCredentialsOutput":{ "type":"structure", "members":{ "TargetARN":{ "shape":"TargetARN", "documentation":"

The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.

" }, "InitiatorName":{ "shape":"IqnName", "documentation":"

The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.

" } }, "documentation":"

A JSON object containing the following fields:

" }, "UpdateGatewayInformationInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"}, "GatewayName":{"shape":"GatewayName"}, "GatewayTimezone":{"shape":"GatewayTimezone"} } }, "UpdateGatewayInformationOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"}, "GatewayName":{"shape":"string"} }, "documentation":"

A JSON object containing the ARN of the gateway that was updated.

" }, "UpdateGatewaySoftwareNowInput":{ "type":"structure", "required":["GatewayARN"], "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the of the gateway to update.

" }, "UpdateGatewaySoftwareNowOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the of the gateway that was updated.

" }, "UpdateMaintenanceStartTimeInput":{ "type":"structure", "required":[ "GatewayARN", "HourOfDay", "MinuteOfHour", "DayOfWeek" ], "members":{ "GatewayARN":{"shape":"GatewayARN"}, "HourOfDay":{ "shape":"HourOfDay", "documentation":"

The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.

" }, "MinuteOfHour":{ "shape":"MinuteOfHour", "documentation":"

The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.

" }, "DayOfWeek":{ "shape":"DayOfWeek", "documentation":"

The maintenance start time day of the week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.

" } }, "documentation":"

A JSON object containing the following fields:

" }, "UpdateMaintenanceStartTimeOutput":{ "type":"structure", "members":{ "GatewayARN":{"shape":"GatewayARN"} }, "documentation":"

A JSON object containing the of the gateway whose maintenance start time is updated.

" }, "UpdateNFSFileShareInput":{ "type":"structure", "required":["FileShareARN"], "members":{ "FileShareARN":{ "shape":"FileShareARN", "documentation":"

The Amazon Resource Name (ARN) of the file share to be updated.

" }, "KMSEncrypted":{ "shape":"Boolean", "documentation":"

True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

" }, "KMSKey":{ "shape":"KMSKey", "documentation":"

The KMS key used for Amazon S3 server side encryption. This value can only be set when KmsEncrypted is true. Optional.

" }, "NFSFileShareDefaults":{ "shape":"NFSFileShareDefaults", "documentation":"

The default values for the file share. Optional.

" }, "DefaultStorageClass":{ "shape":"StorageClass", "documentation":"

The default storage class for objects put into an Amazon S3 bucket by a file gateway. Possible values are S3_STANDARD or S3_STANDARD_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

" } }, "documentation":"

UpdateNFSFileShareInput

" }, "UpdateNFSFileShareOutput":{ "type":"structure", "members":{ "FileShareARN":{ "shape":"FileShareARN", "documentation":"

The Amazon Resource Name (ARN) of the updated file share.

" } }, "documentation":"

UpdateNFSFileShareOutput

" }, "UpdateSnapshotScheduleInput":{ "type":"structure", "required":[ "VolumeARN", "StartAt", "RecurrenceInHours" ], "members":{ "VolumeARN":{ "shape":"VolumeARN", "documentation":"

The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

" }, "StartAt":{ "shape":"HourOfDay", "documentation":"

The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

" }, "RecurrenceInHours":{ "shape":"RecurrenceInHours", "documentation":"

Frequency of snapshots. Specify the number of hours between snapshots.

" }, "Description":{ "shape":"Description", "documentation":"

Optional description of the snapshot that overwrites the existing description.

" } }, "documentation":"

A JSON object containing one or more of the following fields:

" }, "UpdateSnapshotScheduleOutput":{ "type":"structure", "members":{ "VolumeARN":{ "shape":"VolumeARN", "documentation":"

" } }, "documentation":"

A JSON object containing the of the updated storage volume.

" }, "UpdateVTLDeviceTypeInput":{ "type":"structure", "required":[ "VTLDeviceARN", "DeviceType" ], "members":{ "VTLDeviceARN":{ "shape":"VTLDeviceARN", "documentation":"

The Amazon Resource Name (ARN) of the medium changer you want to select.

" }, "DeviceType":{ "shape":"DeviceType", "documentation":"

The type of medium changer you want to select.

Valid Values: \"STK-L700\", \"AWS-Gateway-VTL\"

" } } }, "UpdateVTLDeviceTypeOutput":{ "type":"structure", "members":{ "VTLDeviceARN":{ "shape":"VTLDeviceARN", "documentation":"

The Amazon Resource Name (ARN) of the medium changer you have selected.

" } }, "documentation":"

UpdateVTLDeviceTypeOutput

" }, "VTLDevice":{ "type":"structure", "members":{ "VTLDeviceARN":{ "shape":"VTLDeviceARN", "documentation":"

Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).

" }, "VTLDeviceType":{"shape":"VTLDeviceType"}, "VTLDeviceVendor":{"shape":"VTLDeviceVendor"}, "VTLDeviceProductIdentifier":{"shape":"VTLDeviceProductIdentifier"}, "DeviceiSCSIAttributes":{ "shape":"DeviceiSCSIAttributes", "documentation":"

A list of iSCSI information about a VTL device.

" } }, "documentation":"

Represents a device object associated with a gateway-VTL.

" }, "VTLDeviceARN":{ "type":"string", "max":500, "min":50 }, "VTLDeviceARNs":{ "type":"list", "member":{"shape":"VTLDeviceARN"} }, "VTLDeviceProductIdentifier":{"type":"string"}, "VTLDeviceType":{"type":"string"}, "VTLDeviceVendor":{"type":"string"}, "VTLDevices":{ "type":"list", "member":{"shape":"VTLDevice"} }, "VolumeARN":{ "type":"string", "max":500, "min":50 }, "VolumeARNs":{ "type":"list", "member":{"shape":"VolumeARN"} }, "VolumeId":{ "type":"string", "max":30, "min":12 }, "VolumeInfo":{ "type":"structure", "members":{ "VolumeARN":{ "shape":"VolumeARN", "documentation":"

The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

" }, "VolumeId":{ "shape":"VolumeId", "documentation":"

The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

" }, "GatewayARN":{"shape":"GatewayARN"}, "GatewayId":{ "shape":"GatewayId", "documentation":"

The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

" }, "VolumeType":{"shape":"VolumeType"}, "VolumeSizeInBytes":{ "shape":"long", "documentation":"

The size of the volume in bytes.

Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

" } }, "documentation":"

Describes a storage volume object.

" }, "VolumeInfos":{ "type":"list", "member":{"shape":"VolumeInfo"} }, "VolumeRecoveryPointInfo":{ "type":"structure", "members":{ "VolumeARN":{"shape":"VolumeARN"}, "VolumeSizeInBytes":{"shape":"long"}, "VolumeUsageInBytes":{"shape":"long"}, "VolumeRecoveryPointTime":{"shape":"string"} } }, "VolumeRecoveryPointInfos":{ "type":"list", "member":{"shape":"VolumeRecoveryPointInfo"} }, "VolumeStatus":{ "type":"string", "max":50, "min":3 }, "VolumeType":{ "type":"string", "max":100, "min":3 }, "VolumeiSCSIAttributes":{ "type":"structure", "members":{ "TargetARN":{ "shape":"TargetARN", "documentation":"

The Amazon Resource Name (ARN) of the volume target.

" }, "NetworkInterfaceId":{ "shape":"NetworkInterfaceId", "documentation":"

The network interface identifier.

" }, "NetworkInterfacePort":{ "shape":"integer", "documentation":"

The port used to communicate with iSCSI targets.

" }, "LunNumber":{ "shape":"PositiveIntObject", "documentation":"

The logical disk number.

" }, "ChapEnabled":{ "shape":"boolean", "documentation":"

Indicates whether mutual CHAP is enabled for the iSCSI target.

" } }, "documentation":"

Lists iSCSI information about a volume.

" }, "boolean":{"type":"boolean"}, "double":{"type":"double"}, "errorDetails":{ "type":"map", "key":{"shape":"string"}, "value":{"shape":"string"} }, "integer":{"type":"integer"}, "long":{"type":"long"}, "string":{"type":"string"} }, "documentation":"AWS Storage Gateway Service

AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and AWS's storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.

Use the following links to get started using the AWS Storage Gateway Service API Reference:

AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-1122AABB. When you use this ID with the EC2 API, you must change it to vol-1122aabb. Otherwise, the EC2 API might not behave as expected.

IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS Resource IDs.

For example, a volume ARN with the longer volume ID format will look like this:

arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.

A snapshot ID with the longer ID format will look like this: snap-78e226633445566ee.

For more information, see Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016.

" } botocore-1.5.7/botocore/data/sns/0000777454262600001440000000000013042511307017736 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/sns/2010-03-31/0000777454262600001440000000000013042511307020761 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/sns/2010-03-31/paginators-1.json0000666454262600001440000000134413042511306024162 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListEndpointsByPlatformApplication": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Endpoints" }, "ListPlatformApplications": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "PlatformApplications" }, "ListSubscriptions": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Subscriptions" }, "ListSubscriptionsByTopic": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Subscriptions" }, "ListTopics": { "input_token": "NextToken", "output_token": "NextToken", "result_key": "Topics" } } } botocore-1.5.7/botocore/data/sns/2010-03-31/service-2.json0000777454262600001440000023151513042511306023464 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"sns-2010-03-31", "apiVersion":"2010-03-31", "endpointPrefix":"sns", "protocol":"query", "serviceAbbreviation":"Amazon SNS", "serviceFullName":"Amazon Simple Notification Service", "signatureVersion":"v4", "xmlNamespace":"http://sns.amazonaws.com/doc/2010-03-31/" }, "operations":{ "AddPermission":{ "name":"AddPermission", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddPermissionInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.

" }, "CheckIfPhoneNumberIsOptedOut":{ "name":"CheckIfPhoneNumberIsOptedOut", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CheckIfPhoneNumberIsOptedOutInput"}, "output":{ "shape":"CheckIfPhoneNumberIsOptedOutResponse", "resultWrapper":"CheckIfPhoneNumberIsOptedOutResult" }, "errors":[ {"shape":"ThrottledException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.

To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.

" }, "ConfirmSubscription":{ "name":"ConfirmSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ConfirmSubscriptionInput"}, "output":{ "shape":"ConfirmSubscriptionResponse", "resultWrapper":"ConfirmSubscriptionResult" }, "errors":[ {"shape":"SubscriptionLimitExceededException"}, {"shape":"InvalidParameterException"}, {"shape":"NotFoundException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to \"true\".

" }, "CreatePlatformApplication":{ "name":"CreatePlatformApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlatformApplicationInput"}, "output":{ "shape":"CreatePlatformApplicationResponse", "resultWrapper":"CreatePlatformApplicationResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Creates a platform application object for one of the supported push notification services, such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is \"SSL certificate\". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is \"Package Security Identifier\". For MPNS, PlatformPrincipal is \"TLS certificate\". For Baidu, PlatformPrincipal is \"API key\".

For APNS/APNS_SANDBOX, PlatformCredential is \"private key\". For GCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\". For WNS, PlatformCredential is \"secret key\". For MPNS, PlatformCredential is \"private key\". For Baidu, PlatformCredential is \"secret key\". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS.

" }, "CreatePlatformEndpoint":{ "name":"CreatePlatformEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlatformEndpointInput"}, "output":{ "shape":"CreateEndpointResponse", "resultWrapper":"CreatePlatformEndpointResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.

When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.

" }, "CreateTopic":{ "name":"CreateTopic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTopicInput"}, "output":{ "shape":"CreateTopicResponse", "resultWrapper":"CreateTopicResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"TopicLimitExceededException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see http://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.

" }, "DeleteEndpoint":{ "name":"DeleteEndpoint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteEndpointInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.

When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.

" }, "DeletePlatformApplication":{ "name":"DeletePlatformApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePlatformApplicationInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "DeleteTopic":{ "name":"DeleteTopic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTopicInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.

" }, "GetEndpointAttributes":{ "name":"GetEndpointAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetEndpointAttributesInput"}, "output":{ "shape":"GetEndpointAttributesResponse", "resultWrapper":"GetEndpointAttributesResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "GetPlatformApplicationAttributes":{ "name":"GetPlatformApplicationAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPlatformApplicationAttributesInput"}, "output":{ "shape":"GetPlatformApplicationAttributesResponse", "resultWrapper":"GetPlatformApplicationAttributesResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "GetSMSAttributes":{ "name":"GetSMSAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSMSAttributesInput"}, "output":{ "shape":"GetSMSAttributesResponse", "resultWrapper":"GetSMSAttributesResult" }, "errors":[ {"shape":"ThrottledException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Returns the settings for sending SMS messages from your account.

These settings are set with the SetSMSAttributes action.

" }, "GetSubscriptionAttributes":{ "name":"GetSubscriptionAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSubscriptionAttributesInput"}, "output":{ "shape":"GetSubscriptionAttributesResponse", "resultWrapper":"GetSubscriptionAttributesResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Returns all of the properties of a subscription.

" }, "GetTopicAttributes":{ "name":"GetTopicAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetTopicAttributesInput"}, "output":{ "shape":"GetTopicAttributesResponse", "resultWrapper":"GetTopicAttributesResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.

" }, "ListEndpointsByPlatformApplication":{ "name":"ListEndpointsByPlatformApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListEndpointsByPlatformApplicationInput"}, "output":{ "shape":"ListEndpointsByPlatformApplicationResponse", "resultWrapper":"ListEndpointsByPlatformApplicationResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "ListPhoneNumbersOptedOut":{ "name":"ListPhoneNumbersOptedOut", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPhoneNumbersOptedOutInput"}, "output":{ "shape":"ListPhoneNumbersOptedOutResponse", "resultWrapper":"ListPhoneNumbersOptedOutResult" }, "errors":[ {"shape":"ThrottledException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.

The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.

" }, "ListPlatformApplications":{ "name":"ListPlatformApplications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPlatformApplicationsInput"}, "output":{ "shape":"ListPlatformApplicationsResponse", "resultWrapper":"ListPlatformApplicationsResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "ListSubscriptions":{ "name":"ListSubscriptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSubscriptionsInput"}, "output":{ "shape":"ListSubscriptionsResponse", "resultWrapper":"ListSubscriptionsResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.

" }, "ListSubscriptionsByTopic":{ "name":"ListSubscriptionsByTopic", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSubscriptionsByTopicInput"}, "output":{ "shape":"ListSubscriptionsByTopicResponse", "resultWrapper":"ListSubscriptionsByTopicResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results.

" }, "ListTopics":{ "name":"ListTopics", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTopicsInput"}, "output":{ "shape":"ListTopicsResponse", "resultWrapper":"ListTopicsResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.

" }, "OptInPhoneNumber":{ "name":"OptInPhoneNumber", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"OptInPhoneNumberInput"}, "output":{ "shape":"OptInPhoneNumberResponse", "resultWrapper":"OptInPhoneNumberResult" }, "errors":[ {"shape":"ThrottledException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.

You can opt in a phone number only once every 30 days.

" }, "Publish":{ "name":"Publish", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PublishInput"}, "output":{ "shape":"PublishResponse", "resultWrapper":"PublishResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"EndpointDisabledException"}, {"shape":"PlatformApplicationDisabledException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Sends a message to all of a topic's subscribed endpoints. When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it to the topic's subscribers shortly. The format of the outgoing message to each subscribed endpoint depends on the notification protocol.

To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.

For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.

" }, "RemovePermission":{ "name":"RemovePermission", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemovePermissionInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Removes a statement from a topic's access control policy.

" }, "SetEndpointAttributes":{ "name":"SetEndpointAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetEndpointAttributesInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "SetPlatformApplicationAttributes":{ "name":"SetPlatformApplicationAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetPlatformApplicationAttributesInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.

" }, "SetSMSAttributes":{ "name":"SetSMSAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetSMSAttributesInput"}, "output":{ "shape":"SetSMSAttributesResponse", "resultWrapper":"SetSMSAttributesResult" }, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ThrottledException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.

You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Sending an SMS Message in the Amazon SNS Developer Guide.

" }, "SetSubscriptionAttributes":{ "name":"SetSubscriptionAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetSubscriptionAttributesInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Allows a subscription owner to set an attribute of the topic to a new value.

" }, "SetTopicAttributes":{ "name":"SetTopicAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetTopicAttributesInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Allows a topic owner to set an attribute of the topic to a new value.

" }, "Subscribe":{ "name":"Subscribe", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SubscribeInput"}, "output":{ "shape":"SubscribeResponse", "resultWrapper":"SubscribeResult" }, "errors":[ {"shape":"SubscriptionLimitExceededException"}, {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"NotFoundException"}, {"shape":"AuthorizationErrorException"} ], "documentation":"

Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.

" }, "Unsubscribe":{ "name":"Unsubscribe", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UnsubscribeInput"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], "documentation":"

Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.

" } }, "shapes":{ "ActionsList":{ "type":"list", "member":{"shape":"action"} }, "AddPermissionInput":{ "type":"structure", "required":[ "TopicArn", "Label", "AWSAccountId", "ActionName" ], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic whose access control policy you wish to modify.

" }, "Label":{ "shape":"label", "documentation":"

A unique identifier for the new policy statement.

" }, "AWSAccountId":{ "shape":"DelegatesList", "documentation":"

The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.

" }, "ActionName":{ "shape":"ActionsList", "documentation":"

The action you want to allow for the specified principal(s).

Valid values: any Amazon SNS action name.

" } } }, "AuthorizationErrorException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

Indicates that the user has been denied access to the requested resource.

", "error":{ "code":"AuthorizationError", "httpStatusCode":403, "senderFault":true }, "exception":true }, "Binary":{"type":"blob"}, "CheckIfPhoneNumberIsOptedOutInput":{ "type":"structure", "required":["phoneNumber"], "members":{ "phoneNumber":{ "shape":"PhoneNumber", "documentation":"

The phone number for which you want to check the opt out status.

" } }, "documentation":"

The input for the CheckIfPhoneNumberIsOptedOut action.

" }, "CheckIfPhoneNumberIsOptedOutResponse":{ "type":"structure", "members":{ "isOptedOut":{ "shape":"boolean", "documentation":"

Indicates whether the phone number is opted out:

  • true – The phone number is opted out, meaning you cannot publish SMS messages to it.

  • false – The phone number is opted in, meaning you can publish SMS messages to it.

" } }, "documentation":"

The response from the CheckIfPhoneNumberIsOptedOut action.

" }, "ConfirmSubscriptionInput":{ "type":"structure", "required":[ "TopicArn", "Token" ], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic for which you wish to confirm a subscription.

" }, "Token":{ "shape":"token", "documentation":"

Short-lived token sent to an endpoint during the Subscribe action.

" }, "AuthenticateOnUnsubscribe":{ "shape":"authenticateOnUnsubscribe", "documentation":"

Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.

" } }, "documentation":"

Input for ConfirmSubscription action.

" }, "ConfirmSubscriptionResponse":{ "type":"structure", "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

The ARN of the created subscription.

" } }, "documentation":"

Response for ConfirmSubscriptions action.

" }, "CreateEndpointResponse":{ "type":"structure", "members":{ "EndpointArn":{ "shape":"String", "documentation":"

EndpointArn returned from CreateEndpoint action.

" } }, "documentation":"

Response from CreateEndpoint action.

" }, "CreatePlatformApplicationInput":{ "type":"structure", "required":[ "Name", "Platform", "Attributes" ], "members":{ "Name":{ "shape":"String", "documentation":"

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.

" }, "Platform":{ "shape":"String", "documentation":"

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

For a list of attributes, see SetPlatformApplicationAttributes

" } }, "documentation":"

Input for CreatePlatformApplication action.

" }, "CreatePlatformApplicationResponse":{ "type":"structure", "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn is returned.

" } }, "documentation":"

Response from CreatePlatformApplication action.

" }, "CreatePlatformEndpointInput":{ "type":"structure", "required":[ "PlatformApplicationArn", "Token" ], "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

" }, "Token":{ "shape":"String", "documentation":"

Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.

" }, "CustomUserData":{ "shape":"String", "documentation":"

Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

For a list of attributes, see SetEndpointAttributes.

" } }, "documentation":"

Input for CreatePlatformEndpoint action.

" }, "CreateTopicInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"topicName", "documentation":"

The name of the topic you want to create.

Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.

" } }, "documentation":"

Input for CreateTopic action.

" }, "CreateTopicResponse":{ "type":"structure", "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The Amazon Resource Name (ARN) assigned to the created topic.

" } }, "documentation":"

Response from CreateTopic action.

" }, "DelegatesList":{ "type":"list", "member":{"shape":"delegate"} }, "DeleteEndpointInput":{ "type":"structure", "required":["EndpointArn"], "members":{ "EndpointArn":{ "shape":"String", "documentation":"

EndpointArn of endpoint to delete.

" } }, "documentation":"

Input for DeleteEndpoint action.

" }, "DeletePlatformApplicationInput":{ "type":"structure", "required":["PlatformApplicationArn"], "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn of platform application object to delete.

" } }, "documentation":"

Input for DeletePlatformApplication action.

" }, "DeleteTopicInput":{ "type":"structure", "required":["TopicArn"], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic you want to delete.

" } } }, "Endpoint":{ "type":"structure", "members":{ "EndpointArn":{ "shape":"String", "documentation":"

EndpointArn for mobile app and device.

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

Attributes for endpoint.

" } }, "documentation":"

Endpoint for mobile app and device.

" }, "EndpointDisabledException":{ "type":"structure", "members":{ "message":{ "shape":"string", "documentation":"

Message for endpoint disabled.

" } }, "documentation":"

Exception error indicating endpoint disabled.

", "error":{ "code":"EndpointDisabled", "httpStatusCode":400, "senderFault":true }, "exception":true }, "GetEndpointAttributesInput":{ "type":"structure", "required":["EndpointArn"], "members":{ "EndpointArn":{ "shape":"String", "documentation":"

EndpointArn for GetEndpointAttributes input.

" } }, "documentation":"

Input for GetEndpointAttributes action.

" }, "GetEndpointAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"MapStringToString", "documentation":"

Attributes include the following:

  • CustomUserData -- arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • Enabled -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

" } }, "documentation":"

Response from GetEndpointAttributes of the EndpointArn.

" }, "GetPlatformApplicationAttributesInput":{ "type":"structure", "required":["PlatformApplicationArn"], "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn for GetPlatformApplicationAttributesInput.

" } }, "documentation":"

Input for GetPlatformApplicationAttributes action.

" }, "GetPlatformApplicationAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"MapStringToString", "documentation":"

Attributes include the following:

  • EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.

  • EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.

  • EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.

  • EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

" } }, "documentation":"

Response for GetPlatformApplicationAttributes action.

" }, "GetSMSAttributesInput":{ "type":"structure", "members":{ "attributes":{ "shape":"ListString", "documentation":"

A list of the individual attribute names, such as MonthlySpendLimit, for which you want values.

For all attribute names, see SetSMSAttributes.

If you don't use this parameter, Amazon SNS returns all SMS attributes.

" } }, "documentation":"

The input for the GetSMSAttributes request.

" }, "GetSMSAttributesResponse":{ "type":"structure", "members":{ "attributes":{ "shape":"MapStringToString", "documentation":"

The SMS attribute names and their values.

" } }, "documentation":"

The response from the GetSMSAttributes request.

" }, "GetSubscriptionAttributesInput":{ "type":"structure", "required":["SubscriptionArn"], "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

The ARN of the subscription whose properties you want to get.

" } }, "documentation":"

Input for GetSubscriptionAttributes.

" }, "GetSubscriptionAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"SubscriptionAttributesMap", "documentation":"

A map of the subscription's attributes. Attributes in this map include the following:

  • SubscriptionArn -- the subscription's ARN

  • TopicArn -- the topic ARN that the subscription is associated with

  • Owner -- the AWS account ID of the subscription's owner

  • ConfirmationWasAuthenticated -- true if the subscription confirmation request was authenticated

  • DeliveryPolicy -- the JSON serialization of the subscription's delivery policy

  • EffectiveDeliveryPolicy -- the JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults

" } }, "documentation":"

Response for GetSubscriptionAttributes action.

" }, "GetTopicAttributesInput":{ "type":"structure", "required":["TopicArn"], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic whose properties you want to get.

" } }, "documentation":"

Input for GetTopicAttributes action.

" }, "GetTopicAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"TopicAttributesMap", "documentation":"

A map of the topic's attributes. Attributes in this map include the following:

  • TopicArn -- the topic's ARN

  • Owner -- the AWS account ID of the topic's owner

  • Policy -- the JSON serialization of the topic's access control policy

  • DisplayName -- the human-readable name used in the \"From\" field for notifications to email and email-json endpoints

  • SubscriptionsPending -- the number of subscriptions pending confirmation on this topic

  • SubscriptionsConfirmed -- the number of confirmed subscriptions on this topic

  • SubscriptionsDeleted -- the number of deleted subscriptions on this topic

  • DeliveryPolicy -- the JSON serialization of the topic's delivery policy

  • EffectiveDeliveryPolicy -- the JSON serialization of the effective delivery policy that takes into account system defaults

" } }, "documentation":"

Response for GetTopicAttributes action.

" }, "InternalErrorException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

Indicates an internal service error.

", "error":{ "code":"InternalError", "httpStatusCode":500 }, "exception":true, "fault":true }, "InvalidParameterException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

", "error":{ "code":"InvalidParameter", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidParameterValueException":{ "type":"structure", "members":{ "message":{ "shape":"string", "documentation":"

The parameter value is invalid.

" } }, "documentation":"

Indicates that a request parameter does not comply with the associated constraints.

", "error":{ "code":"ParameterValueInvalid", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ListEndpointsByPlatformApplicationInput":{ "type":"structure", "required":["PlatformApplicationArn"], "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

" }, "NextToken":{ "shape":"String", "documentation":"

NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

" } }, "documentation":"

Input for ListEndpointsByPlatformApplication action.

" }, "ListEndpointsByPlatformApplicationResponse":{ "type":"structure", "members":{ "Endpoints":{ "shape":"ListOfEndpoints", "documentation":"

Endpoints returned for ListEndpointsByPlatformApplication action.

" }, "NextToken":{ "shape":"String", "documentation":"

NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.

" } }, "documentation":"

Response for ListEndpointsByPlatformApplication action.

" }, "ListOfEndpoints":{ "type":"list", "member":{"shape":"Endpoint"} }, "ListOfPlatformApplications":{ "type":"list", "member":{"shape":"PlatformApplication"} }, "ListPhoneNumbersOptedOutInput":{ "type":"structure", "members":{ "nextToken":{ "shape":"string", "documentation":"

A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.

" } }, "documentation":"

The input for the ListPhoneNumbersOptedOut action.

" }, "ListPhoneNumbersOptedOutResponse":{ "type":"structure", "members":{ "phoneNumbers":{ "shape":"PhoneNumberList", "documentation":"

A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.

" }, "nextToken":{ "shape":"string", "documentation":"

A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.

" } }, "documentation":"

The response from the ListPhoneNumbersOptedOut action.

" }, "ListPlatformApplicationsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"String", "documentation":"

NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.

" } }, "documentation":"

Input for ListPlatformApplications action.

" }, "ListPlatformApplicationsResponse":{ "type":"structure", "members":{ "PlatformApplications":{ "shape":"ListOfPlatformApplications", "documentation":"

Platform applications returned when calling ListPlatformApplications action.

" }, "NextToken":{ "shape":"String", "documentation":"

NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.

" } }, "documentation":"

Response for ListPlatformApplications action.

" }, "ListString":{ "type":"list", "member":{"shape":"String"} }, "ListSubscriptionsByTopicInput":{ "type":"structure", "required":["TopicArn"], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic for which you wish to find subscriptions.

" }, "NextToken":{ "shape":"nextToken", "documentation":"

Token returned by the previous ListSubscriptionsByTopic request.

" } }, "documentation":"

Input for ListSubscriptionsByTopic action.

" }, "ListSubscriptionsByTopicResponse":{ "type":"structure", "members":{ "Subscriptions":{ "shape":"SubscriptionsList", "documentation":"

A list of subscriptions.

" }, "NextToken":{ "shape":"nextToken", "documentation":"

Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.

" } }, "documentation":"

Response for ListSubscriptionsByTopic action.

" }, "ListSubscriptionsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"nextToken", "documentation":"

Token returned by the previous ListSubscriptions request.

" } }, "documentation":"

Input for ListSubscriptions action.

" }, "ListSubscriptionsResponse":{ "type":"structure", "members":{ "Subscriptions":{ "shape":"SubscriptionsList", "documentation":"

A list of subscriptions.

" }, "NextToken":{ "shape":"nextToken", "documentation":"

Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.

" } }, "documentation":"

Response for ListSubscriptions action

" }, "ListTopicsInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"nextToken", "documentation":"

Token returned by the previous ListTopics request.

" } } }, "ListTopicsResponse":{ "type":"structure", "members":{ "Topics":{ "shape":"TopicsList", "documentation":"

A list of topic ARNs.

" }, "NextToken":{ "shape":"nextToken", "documentation":"

Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.

" } }, "documentation":"

Response for ListTopics action.

" }, "MapStringToString":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "MessageAttributeMap":{ "type":"map", "key":{ "shape":"String", "locationName":"Name" }, "value":{ "shape":"MessageAttributeValue", "locationName":"Value" } }, "MessageAttributeValue":{ "type":"structure", "required":["DataType"], "members":{ "DataType":{ "shape":"String", "documentation":"

Amazon SNS supports the following logical data types: String, Number, and Binary. For more information, see Message Attribute Data Types.

" }, "StringValue":{ "shape":"String", "documentation":"

Strings are Unicode with UTF8 binary encoding. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

" }, "BinaryValue":{ "shape":"Binary", "documentation":"

Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

" } }, "documentation":"

The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish.

Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Using Amazon SNS Message Attributes.

" }, "NotFoundException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

Indicates that the requested resource does not exist.

", "error":{ "code":"NotFound", "httpStatusCode":404, "senderFault":true }, "exception":true }, "OptInPhoneNumberInput":{ "type":"structure", "required":["phoneNumber"], "members":{ "phoneNumber":{ "shape":"PhoneNumber", "documentation":"

The phone number to opt in.

" } }, "documentation":"

Input for the OptInPhoneNumber action.

" }, "OptInPhoneNumberResponse":{ "type":"structure", "members":{ }, "documentation":"

The response for the OptInPhoneNumber action.

" }, "PhoneNumber":{"type":"string"}, "PhoneNumberList":{ "type":"list", "member":{"shape":"PhoneNumber"} }, "PlatformApplication":{ "type":"structure", "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn for platform application object.

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

Attributes for platform application object.

" } }, "documentation":"

Platform application object.

" }, "PlatformApplicationDisabledException":{ "type":"structure", "members":{ "message":{ "shape":"string", "documentation":"

Message for platform application disabled.

" } }, "documentation":"

Exception error indicating platform application disabled.

", "error":{ "code":"PlatformApplicationDisabled", "httpStatusCode":400, "senderFault":true }, "exception":true }, "PublishInput":{ "type":"structure", "required":["Message"], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The topic you want to publish to.

If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.

" }, "TargetArn":{ "shape":"String", "documentation":"

Either TopicArn or EndpointArn, but not both.

If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.

" }, "PhoneNumber":{ "shape":"String", "documentation":"

The phone number to which you want to deliver an SMS message. Use E.164 format.

If you don't specify a value for the PhoneNumber parameter, you must specify a value for the TargetArn or TopicArn parameters.

" }, "Message":{ "shape":"message", "documentation":"

The message you want to send to the topic.

If you want to send the same message to all transport protocols, include the text of the message as a String value.

If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

Constraints: Messages must be UTF-8 encoded strings at most 256 KB in size (262144 bytes, not 262144 characters).

JSON-specific constraints:

  • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.

  • The values will be parsed (unescaped) before they are used in outgoing messages.

  • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).

  • Values have a minimum length of 0 (the empty string, \"\", is allowed).

  • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).

  • Non-string values will cause the key to be ignored.

  • Keys that do not correspond to supported transport protocols are ignored.

  • Duplicate keys are not allowed.

  • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).

" }, "Subject":{ "shape":"subject", "documentation":"

Optional parameter to be used as the \"Subject\" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

" }, "MessageStructure":{ "shape":"messageStructure", "documentation":"

Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:

  • be a syntactically valid JSON object; and

  • contain at least a top-level JSON key of \"default\" with a value that is a string.

You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., \"http\").

For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.

Valid value: json

" }, "MessageAttributes":{ "shape":"MessageAttributeMap", "documentation":"

Message attributes for Publish action.

" } }, "documentation":"

Input for Publish action.

" }, "PublishResponse":{ "type":"structure", "members":{ "MessageId":{ "shape":"messageId", "documentation":"

Unique identifier assigned to the published message.

Length Constraint: Maximum 100 characters

" } }, "documentation":"

Response for Publish action.

" }, "RemovePermissionInput":{ "type":"structure", "required":[ "TopicArn", "Label" ], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic whose access control policy you wish to modify.

" }, "Label":{ "shape":"label", "documentation":"

The unique label of the statement you want to remove.

" } }, "documentation":"

Input for RemovePermission action.

" }, "SetEndpointAttributesInput":{ "type":"structure", "required":[ "EndpointArn", "Attributes" ], "members":{ "EndpointArn":{ "shape":"String", "documentation":"

EndpointArn used for SetEndpointAttributes action.

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

A map of the endpoint attributes. Attributes in this map include the following:

  • CustomUserData -- arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

  • Enabled -- flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

  • Token -- device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

" } }, "documentation":"

Input for SetEndpointAttributes action.

" }, "SetPlatformApplicationAttributesInput":{ "type":"structure", "required":[ "PlatformApplicationArn", "Attributes" ], "members":{ "PlatformApplicationArn":{ "shape":"String", "documentation":"

PlatformApplicationArn for SetPlatformApplicationAttributes action.

" }, "Attributes":{ "shape":"MapStringToString", "documentation":"

A map of the platform application attributes. Attributes in this map include the following:

  • PlatformCredential -- The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is private key. For GCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\".

  • PlatformPrincipal -- The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\".

  • EventEndpointCreated -- Topic ARN to which EndpointCreated event notifications should be sent.

  • EventEndpointDeleted -- Topic ARN to which EndpointDeleted event notifications should be sent.

  • EventEndpointUpdated -- Topic ARN to which EndpointUpdate event notifications should be sent.

  • EventDeliveryFailure -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

  • SuccessFeedbackRoleArn -- IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

  • FailureFeedbackRoleArn -- IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

  • SuccessFeedbackSampleRate -- Sample rate percentage (0-100) of successfully delivered messages.

" } }, "documentation":"

Input for SetPlatformApplicationAttributes action.

" }, "SetSMSAttributesInput":{ "type":"structure", "required":["attributes"], "members":{ "attributes":{ "shape":"MapStringToString", "documentation":"

The default settings for sending SMS messages from your account. You can set values for the following attribute names:

MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.

Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.

By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to exceed the maximum, contact AWS Support or your AWS sales representative for a service limit increase.

DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.

DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.

DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.

DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:

  • Promotional – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.

  • Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.

UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:

  • Time that the message was published (in UTC)

  • Message ID

  • Destination phone number

  • Message type

  • Delivery status

  • Message price (in USD)

  • Part number (a message is split into multiple parts if it is too long for a single message)

  • Total number of parts

To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.

For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.

" } }, "documentation":"

The input for the SetSMSAttributes action.

" }, "SetSMSAttributesResponse":{ "type":"structure", "members":{ }, "documentation":"

The response for the SetSMSAttributes action.

" }, "SetSubscriptionAttributesInput":{ "type":"structure", "required":[ "SubscriptionArn", "AttributeName" ], "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

The ARN of the subscription to modify.

" }, "AttributeName":{ "shape":"attributeName", "documentation":"

The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.

Valid values: DeliveryPolicy | RawMessageDelivery

" }, "AttributeValue":{ "shape":"attributeValue", "documentation":"

The new value for the attribute in JSON format.

" } }, "documentation":"

Input for SetSubscriptionAttributes action.

" }, "SetTopicAttributesInput":{ "type":"structure", "required":[ "TopicArn", "AttributeName" ], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic to modify.

" }, "AttributeName":{ "shape":"attributeName", "documentation":"

The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.

Valid values: Policy | DisplayName | DeliveryPolicy

" }, "AttributeValue":{ "shape":"attributeValue", "documentation":"

The new value for the attribute.

" } }, "documentation":"

Input for SetTopicAttributes action.

" }, "String":{"type":"string"}, "SubscribeInput":{ "type":"structure", "required":[ "TopicArn", "Protocol" ], "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the topic you want to subscribe to.

" }, "Protocol":{ "shape":"protocol", "documentation":"

The protocol you want to use. Supported protocols include:

  • http -- delivery of JSON-encoded message via HTTP POST

  • https -- delivery of JSON-encoded message via HTTPS POST

  • email -- delivery of message via SMTP

  • email-json -- delivery of JSON-encoded message via SMTP

  • sms -- delivery of message via SMS

  • sqs -- delivery of JSON-encoded message to an Amazon SQS queue

  • application -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.

  • lambda -- delivery of JSON-encoded message to an AWS Lambda function.

" }, "Endpoint":{ "shape":"endpoint", "documentation":"

The endpoint that you want to receive notifications. Endpoints vary by protocol:

  • For the http protocol, the endpoint is an URL beginning with \"http://\"

  • For the https protocol, the endpoint is a URL beginning with \"https://\"

  • For the email protocol, the endpoint is an email address

  • For the email-json protocol, the endpoint is an email address

  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device

  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue

  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

  • For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.

" } }, "documentation":"

Input for Subscribe action.

" }, "SubscribeResponse":{ "type":"structure", "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

The ARN of the subscription, if the service was able to create a subscription immediately (without requiring endpoint owner confirmation).

" } }, "documentation":"

Response for Subscribe action.

" }, "Subscription":{ "type":"structure", "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

The subscription's ARN.

" }, "Owner":{ "shape":"account", "documentation":"

The subscription's owner.

" }, "Protocol":{ "shape":"protocol", "documentation":"

The subscription's protocol.

" }, "Endpoint":{ "shape":"endpoint", "documentation":"

The subscription's endpoint (format depends on the protocol).

" }, "TopicArn":{ "shape":"topicARN", "documentation":"

The ARN of the subscription's topic.

" } }, "documentation":"

A wrapper type for the attributes of an Amazon SNS subscription.

" }, "SubscriptionAttributesMap":{ "type":"map", "key":{"shape":"attributeName"}, "value":{"shape":"attributeValue"} }, "SubscriptionLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

Indicates that the customer already owns the maximum allowed number of subscriptions.

", "error":{ "code":"SubscriptionLimitExceeded", "httpStatusCode":403, "senderFault":true }, "exception":true }, "SubscriptionsList":{ "type":"list", "member":{"shape":"Subscription"} }, "ThrottledException":{ "type":"structure", "members":{ "message":{ "shape":"string", "documentation":"

Throttled request.

" } }, "documentation":"

Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.

", "error":{ "code":"Throttled", "httpStatusCode":429, "senderFault":true }, "exception":true }, "Topic":{ "type":"structure", "members":{ "TopicArn":{ "shape":"topicARN", "documentation":"

The topic's ARN.

" } }, "documentation":"

A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes.

" }, "TopicAttributesMap":{ "type":"map", "key":{"shape":"attributeName"}, "value":{"shape":"attributeValue"} }, "TopicLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"string"} }, "documentation":"

Indicates that the customer already owns the maximum allowed number of topics.

", "error":{ "code":"TopicLimitExceeded", "httpStatusCode":403, "senderFault":true }, "exception":true }, "TopicsList":{ "type":"list", "member":{"shape":"Topic"} }, "UnsubscribeInput":{ "type":"structure", "required":["SubscriptionArn"], "members":{ "SubscriptionArn":{ "shape":"subscriptionARN", "documentation":"

The ARN of the subscription to be deleted.

" } }, "documentation":"

Input for Unsubscribe action.

" }, "account":{"type":"string"}, "action":{"type":"string"}, "attributeName":{"type":"string"}, "attributeValue":{"type":"string"}, "authenticateOnUnsubscribe":{"type":"string"}, "boolean":{"type":"boolean"}, "delegate":{"type":"string"}, "endpoint":{"type":"string"}, "label":{"type":"string"}, "message":{"type":"string"}, "messageId":{"type":"string"}, "messageStructure":{"type":"string"}, "nextToken":{"type":"string"}, "protocol":{"type":"string"}, "string":{"type":"string"}, "subject":{"type":"string"}, "subscriptionARN":{"type":"string"}, "token":{"type":"string"}, "topicARN":{"type":"string"}, "topicName":{"type":"string"} }, "documentation":"Amazon Simple Notification Service

Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see http://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.

We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.

" } botocore-1.5.7/botocore/data/support/0000777454262600001440000000000013042511307020647 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/support/2013-04-15/0000777454262600001440000000000013042511307021700 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/support/2013-04-15/paginators-1.json0000666454262600001440000000055313042511306025102 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeCases": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", "result_key": "cases" }, "DescribeCommunications": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", "result_key": "communications" } } } botocore-1.5.7/botocore/data/support/2013-04-15/service-2.json0000666454262600001440000016747313042511306024413 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"support-2013-04-15", "apiVersion":"2013-04-15", "endpointPrefix":"support", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"AWS Support", "signatureVersion":"v4", "targetPrefix":"AWSSupport_20130415" }, "operations":{ "AddAttachmentsToSet":{ "name":"AddAttachmentsToSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddAttachmentsToSetRequest"}, "output":{"shape":"AddAttachmentsToSetResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"AttachmentSetIdNotFound"}, {"shape":"AttachmentSetExpired"}, {"shape":"AttachmentSetSizeLimitExceeded"}, {"shape":"AttachmentLimitExceeded"} ], "documentation":"

Adds one or more attachments to an attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists.

An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the expiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB.

" }, "AddCommunicationToCase":{ "name":"AddCommunicationToCase", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddCommunicationToCaseRequest"}, "output":{"shape":"AddCommunicationToCaseResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"CaseIdNotFound"}, {"shape":"AttachmentSetIdNotFound"}, {"shape":"AttachmentSetExpired"} ], "documentation":"

Adds additional customer communication to an AWS Support case. You use the caseId value to identify the case to add communication to. 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.

The response indicates the success or failure of the request.

This operation implements a subset of the features of the AWS Support Center.

" }, "CreateCase":{ "name":"CreateCase", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateCaseRequest"}, "output":{"shape":"CreateCaseResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"CaseCreationLimitExceeded"}, {"shape":"AttachmentSetIdNotFound"}, {"shape":"AttachmentSetExpired"} ], "documentation":"

Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information:

  • issueType. The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\"

  • serviceCode. The code for an AWS service. You obtain the serviceCode by calling DescribeServices.

  • categoryCode. The category for the service defined for the serviceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes.

  • severityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels.

  • subject. The Subject field on the AWS Support Center Create Case page.

  • communicationBody. The Description field on the AWS Support Center Create Case page.

  • attachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.

  • language. The human language in which AWS Support handles the case. English and Japanese are currently supported.

  • ccEmailAddresses. The AWS Support Center CC field on the Create 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.

To add additional communication or attachments to an existing case, use AddCommunicationToCase.

A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases.

" }, "DescribeAttachment":{ "name":"DescribeAttachment", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAttachmentRequest"}, "output":{"shape":"DescribeAttachmentResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"DescribeAttachmentLimitExceeded"}, {"shape":"AttachmentIdNotFound"} ], "documentation":"

Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.

" }, "DescribeCases":{ "name":"DescribeCases", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCasesRequest"}, "output":{"shape":"DescribeCasesResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"CaseIdNotFound"} ], "documentation":"

Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the afterTime and beforeTime request parameters. You can set values for the includeResolvedCases and includeCommunications request parameters to control how much information is returned.

Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.

The response returns the following in JSON format:

  • One or more CaseDetails data types.

  • One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

" }, "DescribeCommunications":{ "name":"DescribeCommunications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeCommunicationsRequest"}, "output":{"shape":"DescribeCommunicationsResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"CaseIdNotFound"} ], "documentation":"

Returns communications (and attachments) for one or more support cases. You can use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a particular case.

Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.

You can use the maxResults and nextToken parameters 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.

" }, "DescribeServices":{ "name":"DescribeServices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeServicesRequest"}, "output":{"shape":"DescribeServicesResponse"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

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.

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 Create 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.

" }, "DescribeSeverityLevels":{ "name":"DescribeSeverityLevels", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSeverityLevelsRequest"}, "output":{"shape":"DescribeSeverityLevelsResponse"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

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.

" }, "DescribeTrustedAdvisorCheckRefreshStatuses":{ "name":"DescribeTrustedAdvisorCheckRefreshStatuses", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTrustedAdvisorCheckRefreshStatusesRequest"}, "output":{"shape":"DescribeTrustedAdvisorCheckRefreshStatusesResponse"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation. Use of the DescribeTrustedAdvisorCheckRefreshStatuses operation for these checks causes an InvalidParameterValue error.

" }, "DescribeTrustedAdvisorCheckResult":{ "name":"DescribeTrustedAdvisorCheckResult", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTrustedAdvisorCheckResultRequest"}, "output":{"shape":"DescribeTrustedAdvisorCheckResultResponse"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains a TrustedAdvisorCheckResult object, which contains these three objects:

In addition, the response contains these fields:

  • status. The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".

  • timestamp. The time of the last refresh of the check.

  • checkId. The unique identifier for the check.

" }, "DescribeTrustedAdvisorCheckSummaries":{ "name":"DescribeTrustedAdvisorCheckSummaries", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTrustedAdvisorCheckSummariesRequest"}, "output":{"shape":"DescribeTrustedAdvisorCheckSummariesResponse"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

The response contains an array of TrustedAdvisorCheckSummary objects.

" }, "DescribeTrustedAdvisorChecks":{ "name":"DescribeTrustedAdvisorChecks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTrustedAdvisorChecksRequest"}, "output":{"shape":"DescribeTrustedAdvisorChecksResponse"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English (\"en\") and Japanese (\"ja\") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check.

" }, "RefreshTrustedAdvisorCheck":{ "name":"RefreshTrustedAdvisorCheck", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RefreshTrustedAdvisorCheckRequest"}, "output":{"shape":"RefreshTrustedAdvisorCheckResponse"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the RefreshTrustedAdvisorCheck operation for these checks causes an InvalidParameterValue error.

The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:

  • status. The refresh status of the check: \"none\", \"enqueued\", \"processing\", \"success\", or \"abandoned\".

  • millisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh.

  • checkId. The unique identifier for the check.

" }, "ResolveCase":{ "name":"ResolveCase", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResolveCaseRequest"}, "output":{"shape":"ResolveCaseResponse"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"CaseIdNotFound"} ], "documentation":"

Takes a caseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.

" } }, "shapes":{ "AddAttachmentsToSetRequest":{ "type":"structure", "required":["attachments"], "members":{ "attachmentSetId":{ "shape":"AttachmentSetId", "documentation":"

The ID of the attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists.

" }, "attachments":{ "shape":"Attachments", "documentation":"

One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment.

" } }, "documentation":"

" }, "AddAttachmentsToSetResponse":{ "type":"structure", "members":{ "attachmentSetId":{ "shape":"AttachmentSetId", "documentation":"

The ID of the attachment set. If an attachmentSetId was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId was specified, the attachments are added to the specified set, if it exists.

" }, "expiryTime":{ "shape":"ExpiryTime", "documentation":"

The time and date when the attachment set expires.

" } }, "documentation":"

The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.

" }, "AddCommunicationToCaseRequest":{ "type":"structure", "required":["communicationBody"], "members":{ "caseId":{ "shape":"CaseId", "documentation":"

The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" }, "communicationBody":{ "shape":"CommunicationBody", "documentation":"

The body of an email communication to add to the support case.

" }, "ccEmailAddresses":{ "shape":"CcEmailAddressList", "documentation":"

The email addresses in the CC line of an email to be added to the support case.

" }, "attachmentSetId":{ "shape":"AttachmentSetId", "documentation":"

The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet

" } }, "documentation":"

To be written.

" }, "AddCommunicationToCaseResponse":{ "type":"structure", "members":{ "result":{ "shape":"Result", "documentation":"

True if AddCommunicationToCase succeeds. Otherwise, returns an error.

" } }, "documentation":"

The result of the AddCommunicationToCase operation.

" }, "AfterTime":{"type":"string"}, "Attachment":{ "type":"structure", "members":{ "fileName":{ "shape":"FileName", "documentation":"

The name of the attachment file.

" }, "data":{ "shape":"Data", "documentation":"

The content of the attachment file.

" } }, "documentation":"

An attachment to a case communication. The attachment consists of the file name and the content of the file.

" }, "AttachmentDetails":{ "type":"structure", "members":{ "attachmentId":{ "shape":"AttachmentId", "documentation":"

The ID of the attachment.

" }, "fileName":{ "shape":"FileName", "documentation":"

The file name of the attachment.

" } }, "documentation":"

The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

" }, "AttachmentId":{"type":"string"}, "AttachmentIdNotFound":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

An attachment with the specified ID could not be found.

" } }, "documentation":"

An attachment with the specified ID could not be found.

", "exception":true }, "AttachmentLimitExceeded":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The limit for the number of attachment sets created in a short period of time has been exceeded.

" } }, "documentation":"

The limit for the number of attachment sets created in a short period of time has been exceeded.

", "exception":true }, "AttachmentSet":{ "type":"list", "member":{"shape":"AttachmentDetails"} }, "AttachmentSetExpired":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

" } }, "documentation":"

The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

", "exception":true }, "AttachmentSetId":{"type":"string"}, "AttachmentSetIdNotFound":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

An attachment set with the specified ID could not be found.

" } }, "documentation":"

An attachment set with the specified ID could not be found.

", "exception":true }, "AttachmentSetSizeLimitExceeded":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.

" } }, "documentation":"

A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.

", "exception":true }, "Attachments":{ "type":"list", "member":{"shape":"Attachment"} }, "BeforeTime":{"type":"string"}, "Boolean":{"type":"boolean"}, "CaseCreationLimitExceeded":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

An error message that indicates that you have exceeded the number of cases you can have open.

" } }, "documentation":"

The case creation limit for the account has been exceeded.

", "exception":true }, "CaseDetails":{ "type":"structure", "members":{ "caseId":{ "shape":"CaseId", "documentation":"

The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" }, "displayId":{ "shape":"DisplayId", "documentation":"

The ID displayed for the case in the AWS Support Center. This is a numeric string.

" }, "subject":{ "shape":"Subject", "documentation":"

The subject line for the case in the AWS Support Center.

" }, "status":{ "shape":"Status", "documentation":"

The status of the case.

" }, "serviceCode":{ "shape":"ServiceCode", "documentation":"

The code for the AWS service returned by the call to DescribeServices.

" }, "categoryCode":{ "shape":"CategoryCode", "documentation":"

The category of problem for the AWS Support case.

" }, "severityCode":{ "shape":"SeverityCode", "documentation":"

The code for the severity level returned by the call to DescribeSeverityLevels.

" }, "submittedBy":{ "shape":"SubmittedBy", "documentation":"

The email address of the account that submitted the case.

" }, "timeCreated":{ "shape":"TimeCreated", "documentation":"

The time that the case was case created in the AWS Support Center.

" }, "recentCommunications":{ "shape":"RecentCaseCommunications", "documentation":"

The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.

" }, "ccEmailAddresses":{ "shape":"CcEmailAddressList", "documentation":"

The email addresses that receive copies of communication about the case.

" }, "language":{ "shape":"Language", "documentation":"

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

" } }, "documentation":"

A JSON-formatted object that contains the metadata for a support case. It is contained the response from a DescribeCases request. CaseDetails contains the following fields:

  • caseId. The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47.

  • categoryCode. The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to DescribeServices.

  • displayId. The identifier for the case on pages in the AWS Support Center.

  • language. The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

  • recentCommunications. One or more Communication objects. Fields of these objects are attachments, body, caseId, submittedBy, and timeCreated.

  • nextToken. A resumption point for pagination.

  • serviceCode. The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices.

  • severityCode. The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels.

  • status. The status of the case in the AWS Support Center.

  • subject. The subject line of the case.

  • submittedBy. The email address of the account that submitted the case.

  • timeCreated. The time the case was created, in ISO-8601 format.

" }, "CaseId":{"type":"string"}, "CaseIdList":{ "type":"list", "member":{"shape":"CaseId"}, "max":100, "min":0 }, "CaseIdNotFound":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The requested CaseId could not be located.

" } }, "documentation":"

The requested caseId could not be located.

", "exception":true }, "CaseList":{ "type":"list", "member":{"shape":"CaseDetails"} }, "CaseStatus":{"type":"string"}, "Category":{ "type":"structure", "members":{ "code":{ "shape":"CategoryCode", "documentation":"

The category code for the support case.

" }, "name":{ "shape":"CategoryName", "documentation":"

The category name for the support case.

" } }, "documentation":"

A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each AWS service.

" }, "CategoryCode":{"type":"string"}, "CategoryList":{ "type":"list", "member":{"shape":"Category"} }, "CategoryName":{"type":"string"}, "CcEmailAddress":{"type":"string"}, "CcEmailAddressList":{ "type":"list", "member":{"shape":"CcEmailAddress"}, "max":10, "min":0 }, "Communication":{ "type":"structure", "members":{ "caseId":{ "shape":"CaseId", "documentation":"

The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" }, "body":{ "shape":"CommunicationBody", "documentation":"

The text of the communication between the customer and AWS Support.

" }, "submittedBy":{ "shape":"SubmittedBy", "documentation":"

The email address of the account that submitted the AWS Support case.

" }, "timeCreated":{ "shape":"TimeCreated", "documentation":"

The time the communication was created.

" }, "attachmentSet":{ "shape":"AttachmentSet", "documentation":"

Information about the attachments to the case communication.

" } }, "documentation":"

A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the account email address, and the date and time of the communication.

" }, "CommunicationBody":{ "type":"string", "max":8000, "min":1 }, "CommunicationList":{ "type":"list", "member":{"shape":"Communication"} }, "CreateCaseRequest":{ "type":"structure", "required":[ "subject", "communicationBody" ], "members":{ "subject":{ "shape":"Subject", "documentation":"

The title of the AWS Support case.

" }, "serviceCode":{ "shape":"ServiceCode", "documentation":"

The code for the AWS service returned by the call to DescribeServices.

" }, "severityCode":{ "shape":"SeverityCode", "documentation":"

The code for the severity level returned by the call to DescribeSeverityLevels.

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.

" }, "categoryCode":{ "shape":"CategoryCode", "documentation":"

The category of problem for the AWS Support case.

" }, "communicationBody":{ "shape":"CommunicationBody", "documentation":"

The communication body text when you create an AWS Support case by calling CreateCase.

" }, "ccEmailAddresses":{ "shape":"CcEmailAddressList", "documentation":"

A list of email addresses that AWS Support copies on case correspondence.

" }, "language":{ "shape":"Language", "documentation":"

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

" }, "issueType":{ "shape":"IssueType", "documentation":"

The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\"

" }, "attachmentSetId":{ "shape":"AttachmentSetId", "documentation":"

The ID of a set of one or more attachments for the case. Create the set by using AddAttachmentsToSet.

" } }, "documentation":"

" }, "CreateCaseResponse":{ "type":"structure", "members":{ "caseId":{ "shape":"CaseId", "documentation":"

The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" } }, "documentation":"

The AWS Support case ID returned by a successful completion of the CreateCase operation.

" }, "Data":{"type":"blob"}, "DescribeAttachmentLimitExceeded":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

" } }, "documentation":"

The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

", "exception":true }, "DescribeAttachmentRequest":{ "type":"structure", "required":["attachmentId"], "members":{ "attachmentId":{ "shape":"AttachmentId", "documentation":"

The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.

" } } }, "DescribeAttachmentResponse":{ "type":"structure", "members":{ "attachment":{ "shape":"Attachment", "documentation":"

The attachment content and file name.

" } }, "documentation":"

The content and file name of the attachment returned by the DescribeAttachment operation.

" }, "DescribeCasesRequest":{ "type":"structure", "members":{ "caseIdList":{ "shape":"CaseIdList", "documentation":"

A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

" }, "displayId":{ "shape":"DisplayId", "documentation":"

The ID displayed for a case in the AWS Support Center user interface.

" }, "afterTime":{ "shape":"AfterTime", "documentation":"

The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

" }, "beforeTime":{ "shape":"BeforeTime", "documentation":"

The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

" }, "includeResolvedCases":{ "shape":"IncludeResolvedCases", "documentation":"

Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A resumption point for pagination.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return before paginating.

" }, "language":{ "shape":"Language", "documentation":"

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

" }, "includeCommunications":{ "shape":"IncludeCommunications", "documentation":"

Specifies whether communications should be included in the DescribeCases results. The default is true.

" } }, "documentation":"

" }, "DescribeCasesResponse":{ "type":"structure", "members":{ "cases":{ "shape":"CaseList", "documentation":"

The details for the cases that match the request.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A resumption point for pagination.

" } }, "documentation":"

Returns an array of CaseDetails objects and a nextToken that defines a point for pagination in the result set.

" }, "DescribeCommunicationsRequest":{ "type":"structure", "required":["caseId"], "members":{ "caseId":{ "shape":"CaseId", "documentation":"

The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" }, "beforeTime":{ "shape":"BeforeTime", "documentation":"

The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

" }, "afterTime":{ "shape":"AfterTime", "documentation":"

The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A resumption point for pagination.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of results to return before paginating.

" } }, "documentation":"

" }, "DescribeCommunicationsResponse":{ "type":"structure", "members":{ "communications":{ "shape":"CommunicationList", "documentation":"

The communications for the case.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A resumption point for pagination.

" } }, "documentation":"

The communications returned by the DescribeCommunications operation.

" }, "DescribeServicesRequest":{ "type":"structure", "members":{ "serviceCodeList":{ "shape":"ServiceCodeList", "documentation":"

A JSON-formatted list of service codes available for AWS services.

" }, "language":{ "shape":"Language", "documentation":"

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

" } }, "documentation":"

" }, "DescribeServicesResponse":{ "type":"structure", "members":{ "services":{ "shape":"ServiceList", "documentation":"

A JSON-formatted list of AWS services.

" } }, "documentation":"

The list of AWS services returned by the DescribeServices operation.

" }, "DescribeSeverityLevelsRequest":{ "type":"structure", "members":{ "language":{ "shape":"Language", "documentation":"

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

" } }, "documentation":"

" }, "DescribeSeverityLevelsResponse":{ "type":"structure", "members":{ "severityLevels":{ "shape":"SeverityLevelsList", "documentation":"

The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.

" } }, "documentation":"

The list of severity levels returned by the DescribeSeverityLevels operation.

" }, "DescribeTrustedAdvisorCheckRefreshStatusesRequest":{ "type":"structure", "required":["checkIds"], "members":{ "checkIds":{ "shape":"StringList", "documentation":"

The IDs of the Trusted Advisor checks to get the status of. Note: Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.

" } }, "documentation":"

" }, "DescribeTrustedAdvisorCheckRefreshStatusesResponse":{ "type":"structure", "required":["statuses"], "members":{ "statuses":{ "shape":"TrustedAdvisorCheckRefreshStatusList", "documentation":"

The refresh status of the specified Trusted Advisor checks.

" } }, "documentation":"

The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.

" }, "DescribeTrustedAdvisorCheckResultRequest":{ "type":"structure", "required":["checkId"], "members":{ "checkId":{ "shape":"String", "documentation":"

The unique identifier for the Trusted Advisor check.

" }, "language":{ "shape":"String", "documentation":"

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

" } }, "documentation":"

" }, "DescribeTrustedAdvisorCheckResultResponse":{ "type":"structure", "members":{ "result":{ "shape":"TrustedAdvisorCheckResult", "documentation":"

The detailed results of the Trusted Advisor check.

" } }, "documentation":"

The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.

" }, "DescribeTrustedAdvisorCheckSummariesRequest":{ "type":"structure", "required":["checkIds"], "members":{ "checkIds":{ "shape":"StringList", "documentation":"

The IDs of the Trusted Advisor checks.

" } }, "documentation":"

" }, "DescribeTrustedAdvisorCheckSummariesResponse":{ "type":"structure", "required":["summaries"], "members":{ "summaries":{ "shape":"TrustedAdvisorCheckSummaryList", "documentation":"

The summary information for the requested Trusted Advisor checks.

" } }, "documentation":"

The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.

" }, "DescribeTrustedAdvisorChecksRequest":{ "type":"structure", "required":["language"], "members":{ "language":{ "shape":"String", "documentation":"

The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

" } }, "documentation":"

" }, "DescribeTrustedAdvisorChecksResponse":{ "type":"structure", "required":["checks"], "members":{ "checks":{ "shape":"TrustedAdvisorCheckList", "documentation":"

Information about all available Trusted Advisor checks.

" } }, "documentation":"

Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.

" }, "DisplayId":{"type":"string"}, "Double":{"type":"double"}, "ErrorMessage":{"type":"string"}, "ExpiryTime":{"type":"string"}, "FileName":{"type":"string"}, "IncludeCommunications":{"type":"boolean"}, "IncludeResolvedCases":{"type":"boolean"}, "InternalServerError":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

An internal server error occurred.

" } }, "documentation":"

An internal server error occurred.

", "exception":true, "fault":true }, "IssueType":{"type":"string"}, "Language":{"type":"string"}, "Long":{"type":"long"}, "MaxResults":{ "type":"integer", "max":100, "min":10 }, "NextToken":{"type":"string"}, "RecentCaseCommunications":{ "type":"structure", "members":{ "communications":{ "shape":"CommunicationList", "documentation":"

The five most recent communications associated with the case.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A resumption point for pagination.

" } }, "documentation":"

The five most recent communications associated with the case.

" }, "RefreshTrustedAdvisorCheckRequest":{ "type":"structure", "required":["checkId"], "members":{ "checkId":{ "shape":"String", "documentation":"

The unique identifier for the Trusted Advisor check to refresh. Note: Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.

" } }, "documentation":"

" }, "RefreshTrustedAdvisorCheckResponse":{ "type":"structure", "required":["status"], "members":{ "status":{ "shape":"TrustedAdvisorCheckRefreshStatus", "documentation":"

The current refresh status for a check, including the amount of time until the check is eligible for refresh.

" } }, "documentation":"

The current refresh status of a Trusted Advisor check.

" }, "ResolveCaseRequest":{ "type":"structure", "members":{ "caseId":{ "shape":"CaseId", "documentation":"

The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

" } }, "documentation":"

" }, "ResolveCaseResponse":{ "type":"structure", "members":{ "initialCaseStatus":{ "shape":"CaseStatus", "documentation":"

The status of the case when the ResolveCase request was sent.

" }, "finalCaseStatus":{ "shape":"CaseStatus", "documentation":"

The status of the case after the ResolveCase request was processed.

" } }, "documentation":"

The status of the case returned by the ResolveCase operation.

" }, "Result":{"type":"boolean"}, "Service":{ "type":"structure", "members":{ "code":{ "shape":"ServiceCode", "documentation":"

The code for an AWS service returned by the DescribeServices response. The name element contains the corresponding friendly name.

" }, "name":{ "shape":"ServiceName", "documentation":"

The friendly name for an AWS service. The code element contains the corresponding code.

" }, "categories":{ "shape":"CategoryList", "documentation":"

A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to AWS Support when you call CreateCase.

" } }, "documentation":"

Information about an AWS service returned by the DescribeServices operation.

" }, "ServiceCode":{"type":"string"}, "ServiceCodeList":{ "type":"list", "member":{"shape":"ServiceCode"}, "max":100, "min":0 }, "ServiceList":{ "type":"list", "member":{"shape":"Service"} }, "ServiceName":{"type":"string"}, "SeverityCode":{"type":"string"}, "SeverityLevel":{ "type":"structure", "members":{ "code":{ "shape":"SeverityLevelCode", "documentation":"

One of four values: \"low,\" \"medium,\" \"high,\" and \"urgent\". These values correspond to response times returned to the caller in severityLevel.name.

" }, "name":{ "shape":"SeverityLevelName", "documentation":"

The name of the severity level that corresponds to the severity level code.

" } }, "documentation":"

A code and name pair that represent a severity level that can be applied to a support case.

" }, "SeverityLevelCode":{"type":"string"}, "SeverityLevelName":{"type":"string"}, "SeverityLevelsList":{ "type":"list", "member":{"shape":"SeverityLevel"} }, "Status":{"type":"string"}, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"String"} }, "Subject":{"type":"string"}, "SubmittedBy":{"type":"string"}, "TimeCreated":{"type":"string"}, "TrustedAdvisorCategorySpecificSummary":{ "type":"structure", "members":{ "costOptimizing":{ "shape":"TrustedAdvisorCostOptimizingSummary", "documentation":"

The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.

" } }, "documentation":"

The container for summary information that relates to the category of the Trusted Advisor check.

" }, "TrustedAdvisorCheckDescription":{ "type":"structure", "required":[ "id", "name", "description", "category", "metadata" ], "members":{ "id":{ "shape":"String", "documentation":"

The unique identifier for the Trusted Advisor check.

" }, "name":{ "shape":"String", "documentation":"

The display name for the Trusted Advisor check.

" }, "description":{ "shape":"String", "documentation":"

The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup).

" }, "category":{ "shape":"String", "documentation":"

The category of the Trusted Advisor check.

" }, "metadata":{ "shape":"StringList", "documentation":"

The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

" } }, "documentation":"

The description and metadata for a Trusted Advisor check.

" }, "TrustedAdvisorCheckList":{ "type":"list", "member":{"shape":"TrustedAdvisorCheckDescription"} }, "TrustedAdvisorCheckRefreshStatus":{ "type":"structure", "required":[ "checkId", "status", "millisUntilNextRefreshable" ], "members":{ "checkId":{ "shape":"String", "documentation":"

The unique identifier for the Trusted Advisor check.

" }, "status":{ "shape":"String", "documentation":"

The status of the Trusted Advisor check for which a refresh has been requested: \"none\", \"enqueued\", \"processing\", \"success\", or \"abandoned\".

" }, "millisUntilNextRefreshable":{ "shape":"Long", "documentation":"

The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.

" } }, "documentation":"

The refresh status of a Trusted Advisor check.

" }, "TrustedAdvisorCheckRefreshStatusList":{ "type":"list", "member":{"shape":"TrustedAdvisorCheckRefreshStatus"} }, "TrustedAdvisorCheckResult":{ "type":"structure", "required":[ "checkId", "timestamp", "status", "resourcesSummary", "categorySpecificSummary", "flaggedResources" ], "members":{ "checkId":{ "shape":"String", "documentation":"

The unique identifier for the Trusted Advisor check.

" }, "timestamp":{ "shape":"String", "documentation":"

The time of the last refresh of the check.

" }, "status":{ "shape":"String", "documentation":"

The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".

" }, "resourcesSummary":{"shape":"TrustedAdvisorResourcesSummary"}, "categorySpecificSummary":{ "shape":"TrustedAdvisorCategorySpecificSummary", "documentation":"

Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

" }, "flaggedResources":{ "shape":"TrustedAdvisorResourceDetailList", "documentation":"

The details about each resource listed in the check result.

" } }, "documentation":"

The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.

" }, "TrustedAdvisorCheckSummary":{ "type":"structure", "required":[ "checkId", "timestamp", "status", "resourcesSummary", "categorySpecificSummary" ], "members":{ "checkId":{ "shape":"String", "documentation":"

The unique identifier for the Trusted Advisor check.

" }, "timestamp":{ "shape":"String", "documentation":"

The time of the last refresh of the check.

" }, "status":{ "shape":"String", "documentation":"

The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".

" }, "hasFlaggedResources":{ "shape":"Boolean", "documentation":"

Specifies whether the Trusted Advisor check has flagged resources.

" }, "resourcesSummary":{"shape":"TrustedAdvisorResourcesSummary"}, "categorySpecificSummary":{ "shape":"TrustedAdvisorCategorySpecificSummary", "documentation":"

Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

" } }, "documentation":"

A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.

" }, "TrustedAdvisorCheckSummaryList":{ "type":"list", "member":{"shape":"TrustedAdvisorCheckSummary"} }, "TrustedAdvisorCostOptimizingSummary":{ "type":"structure", "required":[ "estimatedMonthlySavings", "estimatedPercentMonthlySavings" ], "members":{ "estimatedMonthlySavings":{ "shape":"Double", "documentation":"

The estimated monthly savings that might be realized if the recommended actions are taken.

" }, "estimatedPercentMonthlySavings":{ "shape":"Double", "documentation":"

The estimated percentage of savings that might be realized if the recommended actions are taken.

" } }, "documentation":"

The estimated cost savings that might be realized if the recommended actions are taken.

" }, "TrustedAdvisorResourceDetail":{ "type":"structure", "required":[ "status", "resourceId", "metadata" ], "members":{ "status":{ "shape":"String", "documentation":"

The status code for the resource identified in the Trusted Advisor check.

" }, "region":{ "shape":"String", "documentation":"

The AWS region in which the identified resource is located.

" }, "resourceId":{ "shape":"String", "documentation":"

The unique identifier for the identified resource.

" }, "isSuppressed":{ "shape":"Boolean", "documentation":"

Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user.

" }, "metadata":{ "shape":"StringList", "documentation":"

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. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

" } }, "documentation":"

Contains information about a resource identified by a Trusted Advisor check.

" }, "TrustedAdvisorResourceDetailList":{ "type":"list", "member":{"shape":"TrustedAdvisorResourceDetail"} }, "TrustedAdvisorResourcesSummary":{ "type":"structure", "required":[ "resourcesProcessed", "resourcesFlagged", "resourcesIgnored", "resourcesSuppressed" ], "members":{ "resourcesProcessed":{ "shape":"Long", "documentation":"

The number of AWS resources that were analyzed by the Trusted Advisor check.

" }, "resourcesFlagged":{ "shape":"Long", "documentation":"

The number of AWS resources that were flagged (listed) by the Trusted Advisor check.

" }, "resourcesIgnored":{ "shape":"Long", "documentation":"

The number of AWS resources ignored by Trusted Advisor because information was unavailable.

" }, "resourcesSuppressed":{ "shape":"Long", "documentation":"

The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.

" } }, "documentation":"

Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

" } }, "documentation":"AWS Support

The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.

The AWS Support service also exposes a set of Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.

The following list describes the AWS Support case management operations:

The following list describes the operations available from the AWS Support service for Trusted Advisor:

For authentication of requests, AWS Support uses Signature Version 4 Signing Process.

See About the AWS Support API in the AWS Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.

" } botocore-1.5.7/botocore/data/ecr/0000777454262600001440000000000013042511307017704 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ecr/2015-09-21/0000777454262600001440000000000013042511307020741 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/ecr/2015-09-21/paginators-1.json0000666454262600001440000000101713042511306024137 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListImages": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", "result_key": "imageIds" }, "DescribeImages": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", "result_key": "imageDetails" }, "DescribeRepositories": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "maxResults", "result_key": "repositories" } } } botocore-1.5.7/botocore/data/ecr/2015-09-21/service-2.json0000777454262600001440000016345613042511306023454 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"ecr-2015-09-21", "apiVersion":"2015-09-21", "endpointPrefix":"ecr", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"Amazon ECR", "serviceFullName":"Amazon EC2 Container Registry", "signatureVersion":"v4", "targetPrefix":"AmazonEC2ContainerRegistry_V20150921" }, "operations":{ "BatchCheckLayerAvailability":{ "name":"BatchCheckLayerAvailability", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchCheckLayerAvailabilityRequest"}, "output":{"shape":"BatchCheckLayerAvailabilityResponse"}, "errors":[ {"shape":"RepositoryNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"ServerException"} ], "documentation":"

Check the availability of multiple image layers in a specified registry and repository.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

" }, "BatchDeleteImage":{ "name":"BatchDeleteImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchDeleteImageRequest"}, "output":{"shape":"BatchDeleteImageResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"} ], "documentation":"

Deletes a list of specified images within a specified repository. Images are specified with either imageTag or imageDigest.

You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.

You can completely delete an image (and all of its tags) by specifying the image's digest in your request.

" }, "BatchGetImage":{ "name":"BatchGetImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetImageRequest"}, "output":{"shape":"BatchGetImageResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"} ], "documentation":"

Gets detailed information for specified images within a specified repository. Images are specified with either imageTag or imageDigest.

" }, "CompleteLayerUpload":{ "name":"CompleteLayerUpload", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CompleteLayerUploadRequest"}, "output":{"shape":"CompleteLayerUploadResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"}, {"shape":"UploadNotFoundException"}, {"shape":"InvalidLayerException"}, {"shape":"LayerPartTooSmallException"}, {"shape":"LayerAlreadyExistsException"}, {"shape":"EmptyUploadException"} ], "documentation":"

Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has completed. You can optionally provide a sha256 digest of the image layer for data validation purposes.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

" }, "CreateRepository":{ "name":"CreateRepository", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRepositoryRequest"}, "output":{"shape":"CreateRepositoryResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryAlreadyExistsException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates an image repository.

" }, "DeleteRepository":{ "name":"DeleteRepository", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRepositoryRequest"}, "output":{"shape":"DeleteRepositoryResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"}, {"shape":"RepositoryNotEmptyException"} ], "documentation":"

Deletes an existing image repository. If a repository contains images, you must use the force option to delete it.

" }, "DeleteRepositoryPolicy":{ "name":"DeleteRepositoryPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRepositoryPolicyRequest"}, "output":{"shape":"DeleteRepositoryPolicyResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"}, {"shape":"RepositoryPolicyNotFoundException"} ], "documentation":"

Deletes the repository policy from a specified repository.

" }, "DescribeImages":{ "name":"DescribeImages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeImagesRequest"}, "output":{"shape":"DescribeImagesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"}, {"shape":"ImageNotFoundException"} ], "documentation":"

Returns metadata about the images in a repository, including image size, image tags, and creation date.

Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.

" }, "DescribeRepositories":{ "name":"DescribeRepositories", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRepositoriesRequest"}, "output":{"shape":"DescribeRepositoriesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"} ], "documentation":"

Describes image repositories in a registry.

" }, "GetAuthorizationToken":{ "name":"GetAuthorizationToken", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAuthorizationTokenRequest"}, "output":{"shape":"GetAuthorizationTokenResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the docker CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed.

The authorizationToken returned for each registry specified is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The AWS CLI offers an aws ecr get-login command that simplifies the login process.

" }, "GetDownloadUrlForLayer":{ "name":"GetDownloadUrlForLayer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDownloadUrlForLayerRequest"}, "output":{"shape":"GetDownloadUrlForLayerResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"LayersNotFoundException"}, {"shape":"LayerInaccessibleException"}, {"shape":"RepositoryNotFoundException"} ], "documentation":"

Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

" }, "GetRepositoryPolicy":{ "name":"GetRepositoryPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRepositoryPolicyRequest"}, "output":{"shape":"GetRepositoryPolicyResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"}, {"shape":"RepositoryPolicyNotFoundException"} ], "documentation":"

Retrieves the repository policy for a specified repository.

" }, "InitiateLayerUpload":{ "name":"InitiateLayerUpload", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"InitiateLayerUploadRequest"}, "output":{"shape":"InitiateLayerUploadResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"} ], "documentation":"

Notify Amazon ECR that you intend to upload an image layer.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

" }, "ListImages":{ "name":"ListImages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListImagesRequest"}, "output":{"shape":"ListImagesResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"} ], "documentation":"

Lists all the image IDs for a given repository.

You can filter images based on whether or not they are tagged by setting the tagStatus parameter to TAGGED or UNTAGGED. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.

" }, "PutImage":{ "name":"PutImage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutImageRequest"}, "output":{"shape":"PutImageResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"}, {"shape":"ImageAlreadyExistsException"}, {"shape":"LayersNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates or updates the image manifest and tags associated with an image.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

" }, "SetRepositoryPolicy":{ "name":"SetRepositoryPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetRepositoryPolicyRequest"}, "output":{"shape":"SetRepositoryPolicyResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"RepositoryNotFoundException"} ], "documentation":"

Applies a repository policy on a specified repository to control access permissions.

" }, "UploadLayerPart":{ "name":"UploadLayerPart", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UploadLayerPartRequest"}, "output":{"shape":"UploadLayerPartResponse"}, "errors":[ {"shape":"ServerException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidLayerPartException"}, {"shape":"RepositoryNotFoundException"}, {"shape":"UploadNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

Uploads an image layer part to Amazon ECR.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

" } }, "shapes":{ "Arn":{"type":"string"}, "AuthorizationData":{ "type":"structure", "members":{ "authorizationToken":{ "shape":"Base64", "documentation":"

A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the string is decoded, it is presented in the format user:password for private registry authentication using docker login.

" }, "expiresAt":{ "shape":"ExpirationTimestamp", "documentation":"

The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.

" }, "proxyEndpoint":{ "shape":"ProxyEndpoint", "documentation":"

The registry URL to use for this authorization token in a docker login command. The Amazon ECR registry URL format is https://aws_account_id.dkr.ecr.region.amazonaws.com. For example, https://012345678910.dkr.ecr.us-east-1.amazonaws.com..

" } }, "documentation":"

An object representing authorization data for an Amazon ECR registry.

" }, "AuthorizationDataList":{ "type":"list", "member":{"shape":"AuthorizationData"} }, "Base64":{ "type":"string", "pattern":"^\\S+$" }, "BatchCheckLayerAvailabilityRequest":{ "type":"structure", "required":[ "repositoryName", "layerDigests" ], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry that contains the image layers to check. If you do not specify a registry, the default registry is assumed.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository that is associated with the image layers to check.

" }, "layerDigests":{ "shape":"BatchedOperationLayerDigestList", "documentation":"

The digests of the image layers to check.

" } } }, "BatchCheckLayerAvailabilityResponse":{ "type":"structure", "members":{ "layers":{ "shape":"LayerList", "documentation":"

A list of image layer objects corresponding to the image layer references in the request.

" }, "failures":{ "shape":"LayerFailureList", "documentation":"

Any failures associated with the call.

" } } }, "BatchDeleteImageRequest":{ "type":"structure", "required":[ "repositoryName", "imageIds" ], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository that contains the image to delete.

" }, "imageIds":{ "shape":"ImageIdentifierList", "documentation":"

A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

" } }, "documentation":"

Deletes specified images within a specified repository. Images are specified with either the imageTag or imageDigest.

" }, "BatchDeleteImageResponse":{ "type":"structure", "members":{ "imageIds":{ "shape":"ImageIdentifierList", "documentation":"

The image IDs of the deleted images.

" }, "failures":{ "shape":"ImageFailureList", "documentation":"

Any failures associated with the call.

" } } }, "BatchGetImageRequest":{ "type":"structure", "required":[ "repositoryName", "imageIds" ], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository that contains the images to describe.

" }, "imageIds":{ "shape":"ImageIdentifierList", "documentation":"

A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

" }, "acceptedMediaTypes":{ "shape":"MediaTypeList", "documentation":"

The accepted media types for the request.

Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json

" } } }, "BatchGetImageResponse":{ "type":"structure", "members":{ "images":{ "shape":"ImageList", "documentation":"

A list of image objects corresponding to the image references in the request.

" }, "failures":{ "shape":"ImageFailureList", "documentation":"

Any failures associated with the call.

" } } }, "BatchedOperationLayerDigest":{ "type":"string", "max":1000, "min":0 }, "BatchedOperationLayerDigestList":{ "type":"list", "member":{"shape":"BatchedOperationLayerDigest"}, "max":100, "min":1 }, "CompleteLayerUploadRequest":{ "type":"structure", "required":[ "repositoryName", "uploadId", "layerDigests" ], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry to which to upload layers. If you do not specify a registry, the default registry is assumed.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository to associate with the image layer.

" }, "uploadId":{ "shape":"UploadId", "documentation":"

The upload ID from a previous InitiateLayerUpload operation to associate with the image layer.

" }, "layerDigests":{ "shape":"LayerDigestList", "documentation":"

The sha256 digest of the image layer.

" } } }, "CompleteLayerUploadResponse":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The registry ID associated with the request.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository name associated with the request.

" }, "uploadId":{ "shape":"UploadId", "documentation":"

The upload ID associated with the layer.

" }, "layerDigest":{ "shape":"LayerDigest", "documentation":"

The sha256 digest of the image layer.

" } } }, "CreateRepositoryRequest":{ "type":"structure", "required":["repositoryName"], "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app).

" } } }, "CreateRepositoryResponse":{ "type":"structure", "members":{ "repository":{ "shape":"Repository", "documentation":"

The repository that was created.

" } } }, "CreationTimestamp":{"type":"timestamp"}, "DeleteRepositoryPolicyRequest":{ "type":"structure", "required":["repositoryName"], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry that contains the repository policy to delete. If you do not specify a registry, the default registry is assumed.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository that is associated with the repository policy to delete.

" } } }, "DeleteRepositoryPolicyResponse":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The registry ID associated with the request.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository name associated with the request.

" }, "policyText":{ "shape":"RepositoryPolicyText", "documentation":"

The JSON repository policy that was deleted from the repository.

" } } }, "DeleteRepositoryRequest":{ "type":"structure", "required":["repositoryName"], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry that contains the repository to delete. If you do not specify a registry, the default registry is assumed.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository to delete.

" }, "force":{ "shape":"ForceFlag", "documentation":"

Force the deletion of the repository if it contains images.

" } } }, "DeleteRepositoryResponse":{ "type":"structure", "members":{ "repository":{ "shape":"Repository", "documentation":"

The repository that was deleted.

" } } }, "DescribeImagesFilter":{ "type":"structure", "members":{ "tagStatus":{ "shape":"TagStatus", "documentation":"

The tag status with which to filter your DescribeImages results. You can filter results based on whether they are TAGGED or UNTAGGED.

" } }, "documentation":"

An object representing a filter on a DescribeImages operation.

" }, "DescribeImagesRequest":{ "type":"structure", "required":["repositoryName"], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

" }, "imageIds":{ "shape":"ImageIdentifierList", "documentation":"

The list of image IDs for the requested repository.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The nextToken value returned from a previous paginated DescribeImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of repository results returned by DescribeImages in paginated output. When this parameter is used, DescribeImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable.

" }, "filter":{ "shape":"DescribeImagesFilter", "documentation":"

The filter key and value with which to filter your DescribeImages results.

" } } }, "DescribeImagesResponse":{ "type":"structure", "members":{ "imageDetails":{ "shape":"ImageDetailList", "documentation":"

A list of ImageDetail objects that contain data about the image.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The nextToken value to include in a future DescribeImages request. When the results of a DescribeImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "DescribeRepositoriesRequest":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.

" }, "repositoryNames":{ "shape":"RepositoryNameList", "documentation":"

A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The nextToken value returned from a previous paginated DescribeRepositories request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRepositories request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable.

" } } }, "DescribeRepositoriesResponse":{ "type":"structure", "members":{ "repositories":{ "shape":"RepositoryList", "documentation":"

A list of repository objects corresponding to valid repositories.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The nextToken value to include in a future DescribeRepositories request. When the results of a DescribeRepositories request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "EmptyUploadException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified layer upload does not contain any layer parts.

", "exception":true }, "ExceptionMessage":{"type":"string"}, "ExpirationTimestamp":{"type":"timestamp"}, "ForceFlag":{"type":"boolean"}, "GetAuthorizationTokenRegistryIdList":{ "type":"list", "member":{"shape":"RegistryId"}, "max":10, "min":1 }, "GetAuthorizationTokenRequest":{ "type":"structure", "members":{ "registryIds":{ "shape":"GetAuthorizationTokenRegistryIdList", "documentation":"

A list of AWS account IDs that are associated with the registries for which to get authorization tokens. If you do not specify a registry, the default registry is assumed.

" } } }, "GetAuthorizationTokenResponse":{ "type":"structure", "members":{ "authorizationData":{ "shape":"AuthorizationDataList", "documentation":"

A list of authorization token data objects that correspond to the registryIds values in the request.

" } } }, "GetDownloadUrlForLayerRequest":{ "type":"structure", "required":[ "repositoryName", "layerDigest" ], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry that contains the image layer to download. If you do not specify a registry, the default registry is assumed.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository that is associated with the image layer to download.

" }, "layerDigest":{ "shape":"LayerDigest", "documentation":"

The digest of the image layer to download.

" } } }, "GetDownloadUrlForLayerResponse":{ "type":"structure", "members":{ "downloadUrl":{ "shape":"Url", "documentation":"

The pre-signed Amazon S3 download URL for the requested layer.

" }, "layerDigest":{ "shape":"LayerDigest", "documentation":"

The digest of the image layer to download.

" } } }, "GetRepositoryPolicyRequest":{ "type":"structure", "required":["repositoryName"], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository whose policy you want to retrieve.

" } } }, "GetRepositoryPolicyResponse":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The registry ID associated with the request.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository name associated with the request.

" }, "policyText":{ "shape":"RepositoryPolicyText", "documentation":"

The JSON repository policy text associated with the repository.

" } } }, "Image":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry containing the image.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository associated with the image.

" }, "imageId":{ "shape":"ImageIdentifier", "documentation":"

An object containing the image tag and image digest associated with an image.

" }, "imageManifest":{ "shape":"ImageManifest", "documentation":"

The image manifest associated with the image.

" } }, "documentation":"

An object representing an Amazon ECR image.

" }, "ImageAlreadyExistsException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified image has already been pushed, and there are no changes to the manifest or image tag since the last push.

", "exception":true }, "ImageDetail":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry to which this image belongs.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository to which this image belongs.

" }, "imageDigest":{ "shape":"ImageDigest", "documentation":"

The sha256 digest of the image manifest.

" }, "imageTags":{ "shape":"ImageTagList", "documentation":"

The list of tags associated with this image.

" }, "imageSizeInBytes":{ "shape":"ImageSizeInBytes", "documentation":"

The size, in bytes, of the image in the repository.

Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.

" }, "imagePushedAt":{ "shape":"PushTimestamp", "documentation":"

The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.

" } }, "documentation":"

An object that describes an image returned by a DescribeImages operation.

" }, "ImageDetailList":{ "type":"list", "member":{"shape":"ImageDetail"} }, "ImageDigest":{"type":"string"}, "ImageFailure":{ "type":"structure", "members":{ "imageId":{ "shape":"ImageIdentifier", "documentation":"

The image ID associated with the failure.

" }, "failureCode":{ "shape":"ImageFailureCode", "documentation":"

The code associated with the failure.

" }, "failureReason":{ "shape":"ImageFailureReason", "documentation":"

The reason for the failure.

" } }, "documentation":"

An object representing an Amazon ECR image failure.

" }, "ImageFailureCode":{ "type":"string", "enum":[ "InvalidImageDigest", "InvalidImageTag", "ImageTagDoesNotMatchDigest", "ImageNotFound", "MissingDigestAndTag" ] }, "ImageFailureList":{ "type":"list", "member":{"shape":"ImageFailure"} }, "ImageFailureReason":{"type":"string"}, "ImageIdentifier":{ "type":"structure", "members":{ "imageDigest":{ "shape":"ImageDigest", "documentation":"

The sha256 digest of the image manifest.

" }, "imageTag":{ "shape":"ImageTag", "documentation":"

The tag used for the image.

" } }, "documentation":"

An object with identifying information for an Amazon ECR image.

" }, "ImageIdentifierList":{ "type":"list", "member":{"shape":"ImageIdentifier"}, "max":100, "min":1 }, "ImageList":{ "type":"list", "member":{"shape":"Image"} }, "ImageManifest":{"type":"string"}, "ImageNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"

The image requested does not exist in the specified repository.

", "exception":true }, "ImageSizeInBytes":{"type":"long"}, "ImageTag":{"type":"string"}, "ImageTagList":{ "type":"list", "member":{"shape":"ImageTag"} }, "InitiateLayerUploadRequest":{ "type":"structure", "required":["repositoryName"], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry that you intend to upload layers to. If you do not specify a registry, the default registry is assumed.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository that you intend to upload layers to.

" } } }, "InitiateLayerUploadResponse":{ "type":"structure", "members":{ "uploadId":{ "shape":"UploadId", "documentation":"

The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations.

" }, "partSize":{ "shape":"PartSize", "documentation":"

The size, in bytes, that Amazon ECR expects future layer part uploads to be.

" } } }, "InvalidLayerException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the digest specified.

", "exception":true }, "InvalidLayerPartException":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The registry ID associated with the exception.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository name associated with the exception.

" }, "uploadId":{ "shape":"UploadId", "documentation":"

The upload ID associated with the exception.

" }, "lastValidByteReceived":{ "shape":"PartSize", "documentation":"

The last valid byte received from the layer part upload that is associated with the exception.

" }, "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The layer part size is not valid, or the first byte specified is not consecutive to the last byte of a previous layer part upload.

", "exception":true }, "InvalidParameterException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified parameter is invalid. Review the available parameters for the API request.

", "exception":true }, "Layer":{ "type":"structure", "members":{ "layerDigest":{ "shape":"LayerDigest", "documentation":"

The sha256 digest of the image layer.

" }, "layerAvailability":{ "shape":"LayerAvailability", "documentation":"

The availability status of the image layer.

" }, "layerSize":{ "shape":"LayerSizeInBytes", "documentation":"

The size, in bytes, of the image layer.

" }, "mediaType":{ "shape":"MediaType", "documentation":"

The media type of the layer, such as application/vnd.docker.image.rootfs.diff.tar.gzip or application/vnd.oci.image.layer.v1.tar+gzip.

" } }, "documentation":"

An object representing an Amazon ECR image layer.

" }, "LayerAlreadyExistsException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The image layer already exists in the associated repository.

", "exception":true }, "LayerAvailability":{ "type":"string", "enum":[ "AVAILABLE", "UNAVAILABLE" ] }, "LayerDigest":{ "type":"string", "pattern":"[a-zA-Z0-9-_+.]+:[a-fA-F0-9]+" }, "LayerDigestList":{ "type":"list", "member":{"shape":"LayerDigest"}, "max":100, "min":1 }, "LayerFailure":{ "type":"structure", "members":{ "layerDigest":{ "shape":"BatchedOperationLayerDigest", "documentation":"

The layer digest associated with the failure.

" }, "failureCode":{ "shape":"LayerFailureCode", "documentation":"

The failure code associated with the failure.

" }, "failureReason":{ "shape":"LayerFailureReason", "documentation":"

The reason for the failure.

" } }, "documentation":"

An object representing an Amazon ECR image layer failure.

" }, "LayerFailureCode":{ "type":"string", "enum":[ "InvalidLayerDigest", "MissingLayerDigest" ] }, "LayerFailureList":{ "type":"list", "member":{"shape":"LayerFailure"} }, "LayerFailureReason":{"type":"string"}, "LayerInaccessibleException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified layer is not available because it is not associated with an image. Unassociated image layers may be cleaned up at any time.

", "exception":true }, "LayerList":{ "type":"list", "member":{"shape":"Layer"} }, "LayerPartBlob":{"type":"blob"}, "LayerPartTooSmallException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

Layer parts must be at least 5 MiB in size.

", "exception":true }, "LayerSizeInBytes":{"type":"long"}, "LayersNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified layers could not be found, or the specified layer is not valid for this repository.

", "exception":true }, "LimitExceededException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Default Service Limits in the Amazon EC2 Container Registry User Guide.

", "exception":true }, "ListImagesFilter":{ "type":"structure", "members":{ "tagStatus":{ "shape":"TagStatus", "documentation":"

The tag status with which to filter your ListImages results. You can filter results based on whether they are TAGGED or UNTAGGED.

" } }, "documentation":"

An object representing a filter on a ListImages operation.

" }, "ListImagesRequest":{ "type":"structure", "required":["repositoryName"], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry that contains the repository to list images in. If you do not specify a registry, the default registry is assumed.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository whose image IDs are to be listed.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The nextToken value returned from a previous paginated ListImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" }, "maxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of image results returned by ListImages in paginated output. When this parameter is used, ListImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListImages request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.

" }, "filter":{ "shape":"ListImagesFilter", "documentation":"

The filter key and value with which to filter your ListImages results.

" } } }, "ListImagesResponse":{ "type":"structure", "members":{ "imageIds":{ "shape":"ImageIdentifierList", "documentation":"

The list of image IDs for the requested repository.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The nextToken value to include in a future ListImages request. When the results of a ListImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" } } }, "MaxResults":{ "type":"integer", "max":100, "min":1 }, "MediaType":{ "type":"string", "pattern":"\\w{1,127}\\/[-+.\\w]{1,127}" }, "MediaTypeList":{ "type":"list", "member":{"shape":"MediaType"}, "max":100, "min":1 }, "NextToken":{"type":"string"}, "PartSize":{ "type":"long", "min":0 }, "ProxyEndpoint":{"type":"string"}, "PushTimestamp":{"type":"timestamp"}, "PutImageRequest":{ "type":"structure", "required":[ "repositoryName", "imageManifest" ], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository in which to put the image.

" }, "imageManifest":{ "shape":"ImageManifest", "documentation":"

The image manifest corresponding to the image to be uploaded.

" }, "imageTag":{ "shape":"ImageTag", "documentation":"

The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or OCI formats.

" } } }, "PutImageResponse":{ "type":"structure", "members":{ "image":{ "shape":"Image", "documentation":"

Details of the image uploaded.

" } } }, "RegistryId":{ "type":"string", "pattern":"[0-9]{12}" }, "Repository":{ "type":"structure", "members":{ "repositoryArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the repository, the AWS account ID of the repository owner, the repository namespace, and then the repository name. For example, arn:aws:ecr:region:012345678910:repository/test.

" }, "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry that contains the repository.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository.

" }, "repositoryUri":{ "shape":"Url", "documentation":"

The URI for the repository. You can use this URI for Docker push and pull operations.

" }, "createdAt":{ "shape":"CreationTimestamp", "documentation":"

The date and time, in JavaScript date/time format, when the repository was created.

" } }, "documentation":"

An object representing a repository.

" }, "RepositoryAlreadyExistsException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified repository already exists in the specified registry.

", "exception":true }, "RepositoryList":{ "type":"list", "member":{"shape":"Repository"} }, "RepositoryName":{ "type":"string", "max":256, "min":2, "pattern":"(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*" }, "RepositoryNameList":{ "type":"list", "member":{"shape":"RepositoryName"}, "max":100, "min":1 }, "RepositoryNotEmptyException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified repository contains images. To delete a repository that contains images, you must force the deletion with the force parameter.

", "exception":true }, "RepositoryNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

", "exception":true }, "RepositoryPolicyNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The specified repository and registry combination does not have an associated repository policy.

", "exception":true }, "RepositoryPolicyText":{ "type":"string", "max":10240, "min":0 }, "ServerException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

These errors are usually caused by a server-side issue.

", "exception":true, "fault":true }, "SetRepositoryPolicyRequest":{ "type":"structure", "required":[ "repositoryName", "policyText" ], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository to receive the policy.

" }, "policyText":{ "shape":"RepositoryPolicyText", "documentation":"

The JSON repository policy text to apply to the repository.

" }, "force":{ "shape":"ForceFlag", "documentation":"

If the policy you are attempting to set on a repository policy would prevent you from setting another policy in the future, you must force the SetRepositoryPolicy operation. This is intended to prevent accidental repository lock outs.

" } } }, "SetRepositoryPolicyResponse":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The registry ID associated with the request.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository name associated with the request.

" }, "policyText":{ "shape":"RepositoryPolicyText", "documentation":"

The JSON repository policy text applied to the repository.

" } } }, "TagStatus":{ "type":"string", "enum":[ "TAGGED", "UNTAGGED" ] }, "UploadId":{ "type":"string", "pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" }, "UploadLayerPartRequest":{ "type":"structure", "required":[ "repositoryName", "uploadId", "partFirstByte", "partLastByte", "layerPartBlob" ], "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The AWS account ID associated with the registry that you are uploading layer parts to. If you do not specify a registry, the default registry is assumed.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository that you are uploading layer parts to.

" }, "uploadId":{ "shape":"UploadId", "documentation":"

The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload.

" }, "partFirstByte":{ "shape":"PartSize", "documentation":"

The integer value of the first byte of the layer part.

" }, "partLastByte":{ "shape":"PartSize", "documentation":"

The integer value of the last byte of the layer part.

" }, "layerPartBlob":{ "shape":"LayerPartBlob", "documentation":"

The base64-encoded layer part payload.

" } } }, "UploadLayerPartResponse":{ "type":"structure", "members":{ "registryId":{ "shape":"RegistryId", "documentation":"

The registry ID associated with the request.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository name associated with the request.

" }, "uploadId":{ "shape":"UploadId", "documentation":"

The upload ID associated with the request.

" }, "lastByteReceived":{ "shape":"PartSize", "documentation":"

The integer value of the last byte received in the request.

" } } }, "UploadNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The error message associated with the exception.

" } }, "documentation":"

The upload could not be found, or the specified upload id is not valid for this repository.

", "exception":true }, "Url":{"type":"string"} }, "documentation":"

Amazon EC2 Container Registry (Amazon ECR) is a managed AWS Docker registry service. Customers can use the familiar Docker CLI to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry. Amazon ECR supports private Docker repositories with resource-based permissions using AWS IAM so that specific users or Amazon EC2 instances can access repositories and images. Developers can use the Docker CLI to author and manage images.

" } botocore-1.5.7/botocore/data/gamelift/0000777454262600001440000000000013042511307020723 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/gamelift/2015-10-01/0000777454262600001440000000000013042511307021746 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/gamelift/2015-10-01/service-2.json0000777454262600001440000050640713042511306024456 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"gamelift-2015-10-01", "apiVersion":"2015-10-01", "endpointPrefix":"gamelift", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Amazon GameLift", "signatureVersion":"v4", "targetPrefix":"GameLift" }, "operations":{ "CreateAlias":{ "name":"CreateAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAliasInput"}, "output":{"shape":"CreateAliasOutput"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"InvalidRequestException"}, {"shape":"ConflictException"}, {"shape":"InternalServiceException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates an alias for a fleet. You can use an alias to anonymize your fleet by referencing an alias instead of a specific fleet when you create game sessions. Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. Use a simple alias to point to an active fleet. Use a terminal alias to display a message to incoming traffic instead of routing players to an active fleet. This option is useful when a game server is no longer supported but you want to provide better messaging than a standard 404 error.

To create a fleet alias, specify an alias name, routing strategy, and optional description. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. To reassign the alias to another fleet ID, call UpdateAlias.

" }, "CreateBuild":{ "name":"CreateBuild", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateBuildInput"}, "output":{"shape":"CreateBuildOutput"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"InvalidRequestException"}, {"shape":"ConflictException"}, {"shape":"InternalServiceException"} ], "documentation":"

Initializes a new build record and generates information required to upload a game build to Amazon GameLift. Once the build record has been created and its status is INITIALIZED, you can upload your game build.

Do not use this API action unless you are using your own Amazon Simple Storage Service (Amazon S3) client and need to manually upload your build files. Instead, to create a build, use the CLI command upload-build, which creates a new build record and uploads the build files in one step. (See the Amazon GameLift Developer Guide help on packaging and uploading your build.)

To create a new build, identify the operating system of the game server binaries. All game servers in a build must use the same operating system. Optionally, specify a build name and version; this metadata is stored with other properties in the build record and is displayed in the GameLift console (it is not visible to players). If successful, this action returns the newly created build record along with the Amazon S3 storage location and AWS account credentials. Use the location and credentials to upload your game build.

" }, "CreateFleet":{ "name":"CreateFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateFleetInput"}, "output":{"shape":"CreateFleetOutput"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"} ], "documentation":"

Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can run multiple server processes to host game sessions. You configure a fleet to create instances with certain hardware specifications (see Amazon EC2 Instance Types for more information), and deploy a specified game build to each instance. A newly created fleet passes through several statuses; once it reaches the ACTIVE status, it can begin hosting game sessions.

To create a new fleet, provide a fleet name, an EC2 instance type, and a build ID of the game build to deploy. You can also configure the new fleet with the following settings: (1) a runtime configuration describing what server processes to run on each instance in the fleet (required to create fleet), (2) access permissions for inbound traffic, (3) fleet-wide game session protection, and (4) the location of default log files for GameLift to upload and store.

If the CreateFleet call is successful, Amazon GameLift performs the following tasks:

  • Creates a fleet record and sets the status to NEW (followed by other statuses as the fleet is activated).

  • Sets the fleet's capacity to 1 \"desired\", which causes GameLift to start one new EC2 instance.

  • Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, GameLift staggers each launch by a few seconds.

  • Begins writing events to the fleet event log, which can be accessed in the GameLift console.

  • Sets the fleet's status to ACTIVE once one server process in the fleet is ready to host a game session.

After a fleet is created, use the following actions to change fleet properties and configuration:

  • UpdateFleetAttributes -- Update fleet metadata, including name and description.

  • UpdateFleetCapacity -- Increase or decrease the number of instances you want the fleet to maintain.

  • UpdateFleetPortSettings -- Change the IP address and port ranges that allow access to incoming traffic.

  • UpdateRuntimeConfiguration -- Change how server processes are launched in the fleet, including launch path, launch parameters, and the number of concurrent processes.

" }, "CreateGameSession":{ "name":"CreateGameSession", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateGameSessionInput"}, "output":{"shape":"CreateGameSessionOutput"}, "errors":[ {"shape":"ConflictException"}, {"shape":"InternalServiceException"}, {"shape":"UnauthorizedException"}, {"shape":"InvalidFleetStatusException"}, {"shape":"TerminalRoutingStrategyException"}, {"shape":"InvalidRequestException"}, {"shape":"NotFoundException"}, {"shape":"FleetCapacityExceededException"}, {"shape":"LimitExceededException"}, {"shape":"IdempotentParameterMismatchException"} ], "documentation":"

Creates a multiplayer game session for players. This action creates a game session record and assigns an available server process in the specified fleet to host the game session. A fleet must be in an ACTIVE status before a game session can be created in it.

To create a game session, specify either fleet ID or alias ID, and indicate a maximum number of players to allow in the game session. You can also provide a name and game-specific properties for this game session. If successful, a GameSession object is returned containing session properties, including an IP address. By default, newly created game sessions allow new players to join. Use UpdateGameSession to change the game sessions player session creation policy.

When creating a game session on a fleet with a resource limit creation policy, the request should include a creator ID. If none is provided, GameLift does not evaluate the fleet's resource limit creation policy.

" }, "CreatePlayerSession":{ "name":"CreatePlayerSession", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlayerSessionInput"}, "output":{"shape":"CreatePlayerSessionOutput"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"UnauthorizedException"}, {"shape":"InvalidGameSessionStatusException"}, {"shape":"GameSessionFullException"}, {"shape":"TerminalRoutingStrategyException"}, {"shape":"InvalidRequestException"}, {"shape":"NotFoundException"} ], "documentation":"

Adds a player to a game session and creates a player session record. A game session must be in an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot before players can be added to the session.

To create a player session, specify a game session ID and player ID. If successful, the player is added to the game session and a new PlayerSession object is returned.

" }, "CreatePlayerSessions":{ "name":"CreatePlayerSessions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePlayerSessionsInput"}, "output":{"shape":"CreatePlayerSessionsOutput"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"UnauthorizedException"}, {"shape":"InvalidGameSessionStatusException"}, {"shape":"GameSessionFullException"}, {"shape":"TerminalRoutingStrategyException"}, {"shape":"InvalidRequestException"}, {"shape":"NotFoundException"} ], "documentation":"

Adds a group of players to a game session. Similar to CreatePlayerSession, this action allows you to add multiple players in a single call, which is useful for games that provide party and/or matchmaking features. A game session must be in an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot before players can be added to the session.

To create player sessions, specify a game session ID and a list of player IDs. If successful, the players are added to the game session and a set of new PlayerSession objects is returned.

" }, "DeleteAlias":{ "name":"DeleteAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAliasInput"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"} ], "documentation":"

Deletes an alias. This action removes all record of the alias; game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.

" }, "DeleteBuild":{ "name":"DeleteBuild", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteBuildInput"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Deletes a build. This action permanently deletes the build record and any uploaded build files.

To delete a build, specify its ID. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.

" }, "DeleteFleet":{ "name":"DeleteFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteFleetInput"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidFleetStatusException"}, {"shape":"UnauthorizedException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity.

This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.

" }, "DeleteScalingPolicy":{ "name":"DeleteScalingPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteScalingPolicyInput"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"} ], "documentation":"

Deletes a fleet scaling policy. This action means that the policy is no longer in force and removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.

" }, "DescribeAlias":{ "name":"DescribeAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAliasInput"}, "output":{"shape":"DescribeAliasOutput"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"InvalidRequestException"}, {"shape":"NotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"

Retrieves properties for a specified alias. To get the alias, specify an alias ID. If successful, an Alias object is returned.

" }, "DescribeBuild":{ "name":"DescribeBuild", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeBuildInput"}, "output":{"shape":"DescribeBuildOutput"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"InvalidRequestException"}, {"shape":"NotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"

Retrieves properties for a build. To get a build record, specify a build ID. If successful, an object containing the build properties is returned.

" }, "DescribeEC2InstanceLimits":{ "name":"DescribeEC2InstanceLimits", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEC2InstanceLimitsInput"}, "output":{"shape":"DescribeEC2InstanceLimitsOutput"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"}, {"shape":"UnauthorizedException"} ], "documentation":"

Retrieves the following information for the specified EC2 instance type:

  • maximum number of instances allowed per AWS account (service limit)

  • current usage level for the AWS account

Service limits vary depending on region. Available regions for GameLift can be found in the AWS Management Console for GameLift (see the drop-down list in the upper right corner).

" }, "DescribeFleetAttributes":{ "name":"DescribeFleetAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFleetAttributesInput"}, "output":{"shape":"DescribeFleetAttributesOutput"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"NotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"} ], "documentation":"

Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

" }, "DescribeFleetCapacity":{ "name":"DescribeFleetCapacity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFleetCapacityInput"}, "output":{"shape":"DescribeFleetCapacityOutput"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"NotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"} ], "documentation":"

Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

" }, "DescribeFleetEvents":{ "name":"DescribeFleetEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFleetEventsInput"}, "output":{"shape":"DescribeFleetEventsOutput"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"UnauthorizedException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Retrieves entries from the specified fleet's event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.

" }, "DescribeFleetPortSettings":{ "name":"DescribeFleetPortSettings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFleetPortSettingsInput"}, "output":{"shape":"DescribeFleetPortSettingsOutput"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"NotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"} ], "documentation":"

Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.

" }, "DescribeFleetUtilization":{ "name":"DescribeFleetUtilization", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeFleetUtilizationInput"}, "output":{"shape":"DescribeFleetUtilizationOutput"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"NotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"} ], "documentation":"

Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

" }, "DescribeGameSessionDetails":{ "name":"DescribeGameSessionDetails", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeGameSessionDetailsInput"}, "output":{"shape":"DescribeGameSessionDetailsOutput"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"NotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"TerminalRoutingStrategyException"} ], "documentation":"

Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet.

To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request.

" }, "DescribeGameSessions":{ "name":"DescribeGameSessions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeGameSessionsInput"}, "output":{"shape":"DescribeGameSessionsOutput"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"NotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"TerminalRoutingStrategyException"} ], "documentation":"

Retrieves a set of one or more game sessions and properties. This action can be used in several ways: (1) provide a GameSessionId to request properties for a specific game session; (2) provide a FleetId or an AliasId to request properties for all game sessions running on a fleet. You can also use SearchGameSessions, which allows you to retrieve all game sessions or filter on certain criteria, but only returns game sessions with a status of ACTIVE. If you need to retrieve the protection policy for each game session, use DescribeGameSessionDetails.

To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each session matching the request.

" }, "DescribeInstances":{ "name":"DescribeInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeInstancesInput"}, "output":{"shape":"DescribeInstancesOutput"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"InvalidRequestException"}, {"shape":"NotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"

Retrieves information about a fleet's instances, including instance IDs. Use this action to get details on all instances in the fleet or get details on one specific instance.

To get a specific instance, specify fleet ID and instance ID. To get all instances in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each result.

" }, "DescribePlayerSessions":{ "name":"DescribePlayerSessions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePlayerSessionsInput"}, "output":{"shape":"DescribePlayerSessionsOutput"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"NotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"} ], "documentation":"

Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId parameter to request properties for a specific player session; (2) provide a GameSessionId parameter to request properties for all player sessions in the specified game session; (3) provide a PlayerId parameter to request properties for all player sessions of a specified player.

To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request.

" }, "DescribeRuntimeConfiguration":{ "name":"DescribeRuntimeConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRuntimeConfigurationInput"}, "output":{"shape":"DescribeRuntimeConfigurationOutput"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Retrieves the current runtime configuration for the specified fleet. The runtime configuration tells GameLift how to launch server processes on instances in the fleet.

" }, "DescribeScalingPolicies":{ "name":"DescribeScalingPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeScalingPoliciesInput"}, "output":{"shape":"DescribeScalingPoliciesOutput"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"} ], "documentation":"

Retrieves all scaling policies applied to a fleet.

To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.

" }, "GetGameSessionLogUrl":{ "name":"GetGameSessionLogUrl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetGameSessionLogUrlInput"}, "output":{"shape":"GetGameSessionLogUrlOutput"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3. Use this URL to download the logs.

See the AWS Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.

" }, "GetInstanceAccess":{ "name":"GetInstanceAccess", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInstanceAccessInput"}, "output":{"shape":"GetInstanceAccessOutput"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"InvalidRequestException"}, {"shape":"NotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"

Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or watching activity in real time.

Access requires credentials that match the operating system of the instance. For a Windows instance, GameLift returns a username and password as strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift returns a username and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the AWS CLI, saving the secret can be handled as part of the GetInstanceAccess request (see the example later in this topic). For more information on remote access, see Remotely Accessing an Instance.

To request access to a specific instance, specify the IDs of the instance and the fleet it belongs to. If successful, an InstanceAccess object is returned containing the instance's IP address and a set of credentials.

" }, "ListAliases":{ "name":"ListAliases", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAliasesInput"}, "output":{"shape":"ListAliasesOutput"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"} ], "documentation":"

Retrieves a collection of alias records for this AWS account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.

Aliases are not listed in any particular order.

" }, "ListBuilds":{ "name":"ListBuilds", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListBuildsInput"}, "output":{"shape":"ListBuildsOutput"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"InvalidRequestException"}, {"shape":"InternalServiceException"} ], "documentation":"

Retrieves build records for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.

Build records are not listed in any particular order.

" }, "ListFleets":{ "name":"ListFleets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListFleetsInput"}, "output":{"shape":"ListFleetsOutput"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"NotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"} ], "documentation":"

Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.

Fleet records are not listed in any particular order.

" }, "PutScalingPolicy":{ "name":"PutScalingPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutScalingPolicyInput"}, "output":{"shape":"PutScalingPolicyOutput"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"} ], "documentation":"

Creates or updates a scaling policy for a fleet. An active scaling policy prompts Amazon GameLift to track a certain metric for a fleet and automatically change the fleet's capacity in specific circumstances. Each scaling policy contains one rule statement. Fleets can have multiple scaling policies in force simultaneously.

A scaling policy rule statement has the following structure:

If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].

For example, this policy: \"If the number of idle instances exceeds 20 for more than 15 minutes, then reduce the fleet capacity by 10 instances\" could be implemented as the following rule statement:

If [IdleInstances] is [GreaterThanOrEqualToThreshold] [20] for [15] minutes, then [ChangeInCapacity] by [-10].

To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the rule values. All parameters for this action are required. If successful, the policy name is returned. Scaling policies cannot be suspended or made inactive. To stop enforcing a scaling policy, call DeleteScalingPolicy.

" }, "RequestUploadCredentials":{ "name":"RequestUploadCredentials", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RequestUploadCredentialsInput"}, "output":{"shape":"RequestUploadCredentialsOutput"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"InvalidRequestException"}, {"shape":"NotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"

Retrieves a fresh set of upload credentials and the assigned Amazon S3 storage location for a specific build. Valid credentials are required to upload your game build files to Amazon S3.

Call this action only if you need credentials for a build created with CreateBuild . This is a rare situation; in most cases, builds are created using the CLI command upload-build, which creates a build record and also uploads build files.

Upload credentials are returned when you create the build, but they have a limited lifespan. You can get fresh credentials and use them to re-upload game files until the status of that build changes to READY. Once this happens, you must create a brand new build.

" }, "ResolveAlias":{ "name":"ResolveAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResolveAliasInput"}, "output":{"shape":"ResolveAliasOutput"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"InvalidRequestException"}, {"shape":"NotFoundException"}, {"shape":"TerminalRoutingStrategyException"}, {"shape":"InternalServiceException"} ], "documentation":"

Retrieves the fleet ID that a specified alias is currently pointing to.

" }, "SearchGameSessions":{ "name":"SearchGameSessions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SearchGameSessionsInput"}, "output":{"shape":"SearchGameSessionsOutput"}, "errors":[ {"shape":"InternalServiceException"}, {"shape":"NotFoundException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"}, {"shape":"TerminalRoutingStrategyException"} ], "documentation":"

Retrieves a set of game sessions that match a set of search criteria and sorts them in a specified order. Currently a game session search is limited to a single fleet. Search results include only game sessions that are in ACTIVE status. If you need to retrieve game sessions with a status other than active, use DescribeGameSessions. If you need to retrieve the protection policy for each game session, use DescribeGameSessionDetails.

You can search or sort by the following game session attributes:

  • gameSessionId -- ID value assigned to a game session. This unique value is returned in a GameSession object when a new game session is created.

  • gameSessionName -- Name assigned to a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession. Game session names do not need to be unique to a game session.

  • creationTimeMillis -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds.

  • playerSessionCount -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out.

  • maximumSessions -- Maximum number of player sessions allowed for a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession.

  • hasAvailablePlayerSessions -- Boolean value indicating whether or not a game session has reached its maximum number of players. When searching with this attribute, the search value must be true or false. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join.

To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of GameSession objects matching the request is returned.

Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join.

" }, "UpdateAlias":{ "name":"UpdateAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAliasInput"}, "output":{"shape":"UpdateAliasOutput"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"InvalidRequestException"}, {"shape":"NotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"

Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.

" }, "UpdateBuild":{ "name":"UpdateBuild", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateBuildInput"}, "output":{"shape":"UpdateBuildOutput"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"InvalidRequestException"}, {"shape":"NotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"

Updates metadata in a build record, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.

" }, "UpdateFleetAttributes":{ "name":"UpdateFleetAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateFleetAttributesInput"}, "output":{"shape":"UpdateFleetAttributesOutput"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"InvalidFleetStatusException"}, {"shape":"LimitExceededException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"} ], "documentation":"

Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values you want to change. If successful, the fleet ID for the updated fleet is returned.

" }, "UpdateFleetCapacity":{ "name":"UpdateFleetCapacity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateFleetCapacityInput"}, "output":{"shape":"UpdateFleetCapacityOutput"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidFleetStatusException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"} ], "documentation":"

Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.

If you're using autoscaling (see PutScalingPolicy), you may want to specify a minimum and/or maximum capacity. If you don't provide these, autoscaling can set capacity anywhere between zero and the service limits.

To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the \"Limit Exceeded\" exception occurs.

" }, "UpdateFleetPortSettings":{ "name":"UpdateFleetPortSettings", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateFleetPortSettingsInput"}, "output":{"shape":"UpdateFleetPortSettingsOutput"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"InvalidFleetStatusException"}, {"shape":"LimitExceededException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"UnauthorizedException"} ], "documentation":"

Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned.

" }, "UpdateGameSession":{ "name":"UpdateGameSession", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateGameSessionInput"}, "output":{"shape":"UpdateGameSessionOutput"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServiceException"}, {"shape":"UnauthorizedException"}, {"shape":"InvalidGameSessionStatusException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned.

" }, "UpdateRuntimeConfiguration":{ "name":"UpdateRuntimeConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateRuntimeConfigurationInput"}, "output":{"shape":"UpdateRuntimeConfigurationOutput"}, "errors":[ {"shape":"UnauthorizedException"}, {"shape":"NotFoundException"}, {"shape":"InternalServiceException"}, {"shape":"InvalidRequestException"}, {"shape":"InvalidFleetStatusException"} ], "documentation":"

Updates the current runtime configuration for the specified fleet, which tells GameLift how to launch server processes on instances in the fleet. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in an ACTIVE status.

To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration object with the updated collection of server process configurations.

Each instance in a GameLift fleet checks regularly for an updated runtime configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; they continue to run until they end, while GameLift simply adds new server processes to fit the current runtime configuration. As a result, the runtime configuration changes are applied gradually as existing processes shut down and new processes are launched in GameLift's normal process recycling activity.

" } }, "shapes":{ "Alias":{ "type":"structure", "members":{ "AliasId":{ "shape":"AliasId", "documentation":"

Unique identifier for a fleet alias.

" }, "Name":{ "shape":"NonBlankAndLengthConstraintString", "documentation":"

Descriptive label associated with an alias. Alias names do not need to be unique.

" }, "Description":{ "shape":"FreeText", "documentation":"

Human-readable description of an alias.

" }, "RoutingStrategy":{"shape":"RoutingStrategy"}, "CreationTime":{ "shape":"Timestamp", "documentation":"

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" }, "LastUpdatedTime":{ "shape":"Timestamp", "documentation":"

Time stamp indicating when this data object was last modified. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" } }, "documentation":"

Properties describing a fleet alias.

" }, "AliasId":{ "type":"string", "pattern":"^alias-\\S+" }, "AliasList":{ "type":"list", "member":{"shape":"Alias"} }, "ArnStringModel":{ "type":"string", "max":256, "min":1, "pattern":"[a-zA-Z0-9:/-]+" }, "AwsCredentials":{ "type":"structure", "members":{ "AccessKeyId":{ "shape":"NonEmptyString", "documentation":"

Access key for an AWS account.

" }, "SecretAccessKey":{ "shape":"NonEmptyString", "documentation":"

Secret key for an AWS account.

" }, "SessionToken":{ "shape":"NonEmptyString", "documentation":"

Token specific to a build ID.

" } }, "documentation":"

AWS access credentials required to upload game build files to Amazon GameLift. These credentials are generated with CreateBuild, and are valid for a limited time. If they expire before you upload your game build, get a new set by calling RequestUploadCredentials.

", "sensitive":true }, "Build":{ "type":"structure", "members":{ "BuildId":{ "shape":"BuildId", "documentation":"

Unique identifier for a build.

" }, "Name":{ "shape":"FreeText", "documentation":"

Descriptive label associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

" }, "Version":{ "shape":"FreeText", "documentation":"

Version associated with this build. Version strings do not need to be unique to a build. This value can be set using CreateBuild or UpdateBuild.

" }, "Status":{ "shape":"BuildStatus", "documentation":"

Current status of the build.

Possible build statuses include the following:

  • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED – The game build upload failed. You cannot create new fleets for this build.

" }, "SizeOnDisk":{ "shape":"PositiveLong", "documentation":"

File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED, this value is 0.

" }, "OperatingSystem":{ "shape":"OperatingSystem", "documentation":"

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" } }, "documentation":"

Properties describing a game build.

" }, "BuildId":{ "type":"string", "pattern":"^build-\\S+" }, "BuildList":{ "type":"list", "member":{"shape":"Build"} }, "BuildStatus":{ "type":"string", "enum":[ "INITIALIZED", "READY", "FAILED" ] }, "ComparisonOperatorType":{ "type":"string", "enum":[ "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold" ] }, "ConflictException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "documentation":"

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

", "exception":true }, "CreateAliasInput":{ "type":"structure", "required":[ "Name", "RoutingStrategy" ], "members":{ "Name":{ "shape":"NonBlankAndLengthConstraintString", "documentation":"

Descriptive label associated with an alias. Alias names do not need to be unique.

" }, "Description":{ "shape":"NonZeroAndMaxString", "documentation":"

Human-readable description of an alias.

" }, "RoutingStrategy":{ "shape":"RoutingStrategy", "documentation":"

Object specifying the fleet and routing type to use for the alias.

" } }, "documentation":"

Represents the input for a request action.

" }, "CreateAliasOutput":{ "type":"structure", "members":{ "Alias":{ "shape":"Alias", "documentation":"

Object containing the newly created alias record.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "CreateBuildInput":{ "type":"structure", "members":{ "Name":{ "shape":"NonZeroAndMaxString", "documentation":"

Descriptive label associated with a build. Build names do not need to be unique. A build name can be changed later using UpdateBuild .

" }, "Version":{ "shape":"NonZeroAndMaxString", "documentation":"

Version associated with this build. Version strings do not need to be unique to a build. A build version can be changed later using UpdateBuild .

" }, "StorageLocation":{"shape":"S3Location"}, "OperatingSystem":{ "shape":"OperatingSystem", "documentation":"

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

" } }, "documentation":"

Represents the input for a request action.

" }, "CreateBuildOutput":{ "type":"structure", "members":{ "Build":{ "shape":"Build", "documentation":"

Set of properties for the newly created build.

" }, "UploadCredentials":{ "shape":"AwsCredentials", "documentation":"

AWS credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for. If you need to get fresh credentials, call RequestUploadCredentials .

" }, "StorageLocation":{ "shape":"S3Location", "documentation":"

Amazon S3 path and key, identifying where the game build files are stored.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "CreateFleetInput":{ "type":"structure", "required":[ "Name", "BuildId", "EC2InstanceType" ], "members":{ "Name":{ "shape":"NonZeroAndMaxString", "documentation":"

Descriptive label associated with a fleet. Fleet names do not need to be unique.

" }, "Description":{ "shape":"NonZeroAndMaxString", "documentation":"

Human-readable description of a fleet.

" }, "BuildId":{ "shape":"BuildId", "documentation":"

Unique identifier of the build to be deployed on the new fleet. The build must have been successfully uploaded to GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

" }, "ServerLaunchPath":{ "shape":"NonZeroAndMaxString", "documentation":"

This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.)

" }, "ServerLaunchParameters":{ "shape":"NonZeroAndMaxString", "documentation":"

This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.)

" }, "LogPaths":{ "shape":"StringList", "documentation":"

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, GameLift will automatically upload logs stored on each instance at C:\\game\\logs (for Windows) or /local/game/logs (for Linux). Use the GameLift console to access stored logs.

" }, "EC2InstanceType":{ "shape":"EC2InstanceType", "documentation":"

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

" }, "EC2InboundPermissions":{ "shape":"IpPermissionsList", "documentation":"

Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

" }, "NewGameSessionProtectionPolicy":{ "shape":"ProtectionPolicy", "documentation":"

Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

" }, "RuntimeConfiguration":{ "shape":"RuntimeConfiguration", "documentation":"

Instructions for launching server processes on each instance in the fleet. The runtime configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a runtime configuration with at least one server process configuration; otherwise the request will fail with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a runtime configuration will continue to work.)

" }, "ResourceCreationLimitPolicy":{ "shape":"ResourceCreationLimitPolicy", "documentation":"

Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

" } }, "documentation":"

Represents the input for a request action.

" }, "CreateFleetOutput":{ "type":"structure", "members":{ "FleetAttributes":{ "shape":"FleetAttributes", "documentation":"

Properties for the newly created fleet.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "CreateGameSessionInput":{ "type":"structure", "required":["MaximumPlayerSessionCount"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for a fleet. Each request must reference either a fleet ID or alias ID, but not both.

" }, "AliasId":{ "shape":"AliasId", "documentation":"

Unique identifier for a fleet alias. Each request must reference either a fleet ID or alias ID, but not both.

" }, "MaximumPlayerSessionCount":{ "shape":"WholeNumber", "documentation":"

Maximum number of players that can be connected simultaneously to the game session.

" }, "Name":{ "shape":"NonZeroAndMaxString", "documentation":"

Descriptive label associated with a game session. Session names do not need to be unique.

" }, "GameProperties":{ "shape":"GamePropertyList", "documentation":"

Set of properties used to administer a game session. These properties are passed to the server process hosting it.

" }, "CreatorId":{ "shape":"NonZeroAndMaxString", "documentation":"

Player ID identifying the person or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

" }, "GameSessionId":{ "shape":"IdStringModel", "documentation":"

Custom string to include in the game session ID, with a maximum length of 48 characters. If this parameter is set, GameLift creates a game session ID in the following format: \"arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<custom ID string>\". For example, this full game session ID: \"arn:aws:gamelift:us-west-2::gamesession/fleet-2ec2aae5-c2c7-43ca-b19d-8249fe5fddf2/my-game-session\" includes the custom ID string \"my-game-session\". If this parameter is not set, GameLift creates a game session ID in the same format with an autogenerated ID string.

" } }, "documentation":"

Represents the input for a request action.

" }, "CreateGameSessionOutput":{ "type":"structure", "members":{ "GameSession":{ "shape":"GameSession", "documentation":"

Object containing the newly created game session record.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "CreatePlayerSessionInput":{ "type":"structure", "required":[ "GameSessionId", "PlayerId" ], "members":{ "GameSessionId":{ "shape":"ArnStringModel", "documentation":"

Unique identifier for the game session to add a player to. Game session ID format is as follows: \"arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>\". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

" }, "PlayerId":{ "shape":"NonZeroAndMaxString", "documentation":"

Unique identifier for the player to be added.

" } }, "documentation":"

Represents the input for a request action.

" }, "CreatePlayerSessionOutput":{ "type":"structure", "members":{ "PlayerSession":{ "shape":"PlayerSession", "documentation":"

Object containing the newly created player session record.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "CreatePlayerSessionsInput":{ "type":"structure", "required":[ "GameSessionId", "PlayerIds" ], "members":{ "GameSessionId":{ "shape":"ArnStringModel", "documentation":"

Unique identifier for the game session to add players to. Game session ID format is as follows: \"arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>\". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

" }, "PlayerIds":{ "shape":"PlayerIdList", "documentation":"

List of unique identifiers for the players to be added.

" } }, "documentation":"

Represents the input for a request action.

" }, "CreatePlayerSessionsOutput":{ "type":"structure", "members":{ "PlayerSessions":{ "shape":"PlayerSessionList", "documentation":"

Collection of player session objects created for the added players.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "DeleteAliasInput":{ "type":"structure", "required":["AliasId"], "members":{ "AliasId":{ "shape":"AliasId", "documentation":"

Unique identifier for a fleet alias. Specify the alias you want to delete.

" } }, "documentation":"

Represents the input for a request action.

" }, "DeleteBuildInput":{ "type":"structure", "required":["BuildId"], "members":{ "BuildId":{ "shape":"BuildId", "documentation":"

Unique identifier for the build you want to delete.

" } }, "documentation":"

Represents the input for a request action.

" }, "DeleteFleetInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for the fleet you want to delete.

" } }, "documentation":"

Represents the input for a request action.

" }, "DeleteScalingPolicyInput":{ "type":"structure", "required":[ "Name", "FleetId" ], "members":{ "Name":{ "shape":"NonZeroAndMaxString", "documentation":"

Descriptive label associated with a scaling policy. Policy names do not need to be unique.

" }, "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for a fleet.

" } }, "documentation":"

Represents the input for a request action.

" }, "DescribeAliasInput":{ "type":"structure", "required":["AliasId"], "members":{ "AliasId":{ "shape":"AliasId", "documentation":"

Unique identifier for a fleet alias. Specify the alias you want to retrieve.

" } }, "documentation":"

Represents the input for a request action.

" }, "DescribeAliasOutput":{ "type":"structure", "members":{ "Alias":{ "shape":"Alias", "documentation":"

Object containing the requested alias.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "DescribeBuildInput":{ "type":"structure", "required":["BuildId"], "members":{ "BuildId":{ "shape":"BuildId", "documentation":"

Unique identifier of the build that you want to retrieve properties for.

" } }, "documentation":"

Represents the input for a request action.

" }, "DescribeBuildOutput":{ "type":"structure", "members":{ "Build":{ "shape":"Build", "documentation":"

Set of properties describing the requested build.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "DescribeEC2InstanceLimitsInput":{ "type":"structure", "members":{ "EC2InstanceType":{ "shape":"EC2InstanceType", "documentation":"

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. Leave this parameter blank to retrieve limits for all types.

" } }, "documentation":"

Represents the input for a request action.

" }, "DescribeEC2InstanceLimitsOutput":{ "type":"structure", "members":{ "EC2InstanceLimits":{ "shape":"EC2InstanceLimitList", "documentation":"

Object containing the maximum number of instances for the specified instance type.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "DescribeFleetAttributesInput":{ "type":"structure", "members":{ "FleetIds":{ "shape":"FleetIdList", "documentation":"

Unique identifiers for the fleet(s) that you want to retrieve attributes for. To request attributes for all fleets, leave this parameter empty.

" }, "Limit":{ "shape":"PositiveInteger", "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

" } }, "documentation":"

Represents the input for a request action.

" }, "DescribeFleetAttributesOutput":{ "type":"structure", "members":{ "FleetAttributes":{ "shape":"FleetAttributesList", "documentation":"

Collection of objects containing attribute metadata for each requested fleet ID.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "DescribeFleetCapacityInput":{ "type":"structure", "members":{ "FleetIds":{ "shape":"FleetIdList", "documentation":"

Unique identifier for the fleet(s) you want to retrieve capacity information for. To request capacity information for all fleets, leave this parameter empty.

" }, "Limit":{ "shape":"PositiveInteger", "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

" } }, "documentation":"

Represents the input for a request action.

" }, "DescribeFleetCapacityOutput":{ "type":"structure", "members":{ "FleetCapacity":{ "shape":"FleetCapacityList", "documentation":"

Collection of objects containing capacity information for each requested fleet ID. Leave this parameter empty to retrieve capacity information for all fleets.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "DescribeFleetEventsInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for the fleet to get event logs for.

" }, "StartTime":{ "shape":"Timestamp", "documentation":"

Earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" }, "EndTime":{ "shape":"Timestamp", "documentation":"

Most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" }, "Limit":{ "shape":"PositiveInteger", "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.

" } }, "documentation":"

Represents the input for a request action.

" }, "DescribeFleetEventsOutput":{ "type":"structure", "members":{ "Events":{ "shape":"EventList", "documentation":"

Collection of objects containing event log entries for the specified fleet.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "DescribeFleetPortSettingsInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for the fleet you want to retrieve port settings for.

" } }, "documentation":"

Represents the input for a request action.

" }, "DescribeFleetPortSettingsOutput":{ "type":"structure", "members":{ "InboundPermissions":{ "shape":"IpPermissionsList", "documentation":"

Object containing port settings for the requested fleet ID.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "DescribeFleetUtilizationInput":{ "type":"structure", "members":{ "FleetIds":{ "shape":"FleetIdList", "documentation":"

Unique identifier for the fleet(s) you want to retrieve utilization data for. To request utilization data for all fleets, leave this parameter empty.

" }, "Limit":{ "shape":"PositiveInteger", "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

" } }, "documentation":"

Represents the input for a request action.

" }, "DescribeFleetUtilizationOutput":{ "type":"structure", "members":{ "FleetUtilization":{ "shape":"FleetUtilizationList", "documentation":"

Collection of objects containing utilization information for each requested fleet ID.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "DescribeGameSessionDetailsInput":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.

" }, "GameSessionId":{ "shape":"ArnStringModel", "documentation":"

Unique identifier for the game session to retrieve information on. Game session ID format is as follows: \"arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>\". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

" }, "AliasId":{ "shape":"AliasId", "documentation":"

Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.

" }, "StatusFilter":{ "shape":"NonZeroAndMaxString", "documentation":"

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).

" }, "Limit":{ "shape":"PositiveInteger", "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.

" } }, "documentation":"

Represents the input for a request action.

" }, "DescribeGameSessionDetailsOutput":{ "type":"structure", "members":{ "GameSessionDetails":{ "shape":"GameSessionDetailList", "documentation":"

Collection of objects containing game session properties and the protection policy currently in force for each session matching the request.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "DescribeGameSessionsInput":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.

" }, "GameSessionId":{ "shape":"ArnStringModel", "documentation":"

Unique identifier for the game session to retrieve information on. Game session ID format is as follows: \"arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>\". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

" }, "AliasId":{ "shape":"AliasId", "documentation":"

Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.

" }, "StatusFilter":{ "shape":"NonZeroAndMaxString", "documentation":"

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

" }, "Limit":{ "shape":"PositiveInteger", "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.

" } }, "documentation":"

Represents the input for a request action.

" }, "DescribeGameSessionsOutput":{ "type":"structure", "members":{ "GameSessions":{ "shape":"GameSessionList", "documentation":"

Collection of objects containing game session properties for each session matching the request.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "DescribeInstancesInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for a fleet. Specify the fleet to retrieve instance information for.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

Unique identifier for an instance. Specify an instance to retrieve information for or leave blank to get information on all instances in the fleet.

" }, "Limit":{ "shape":"PositiveInteger", "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.

" } }, "documentation":"

Represents the input for a request action.

" }, "DescribeInstancesOutput":{ "type":"structure", "members":{ "Instances":{ "shape":"InstanceList", "documentation":"

Collection of objects containing properties for each instance returned.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "DescribePlayerSessionsInput":{ "type":"structure", "members":{ "GameSessionId":{ "shape":"ArnStringModel", "documentation":"

Unique identifier for the game session to get player sessions for. Game session ID format is as follows: \"arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>\". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

" }, "PlayerId":{ "shape":"NonZeroAndMaxString", "documentation":"

Unique identifier for a player.

" }, "PlayerSessionId":{ "shape":"PlayerSessionId", "documentation":"

Unique identifier for a player session.

" }, "PlayerSessionStatusFilter":{ "shape":"NonZeroAndMaxString", "documentation":"

Player session status to filter results on.

Possible player session statuses include the following:

  • RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE – The player has been validated by the server process and is currently connected.

  • COMPLETED – The player connection has been dropped.

  • TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the time-out limit (60 seconds).

" }, "Limit":{ "shape":"PositiveInteger", "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.

" } }, "documentation":"

Represents the input for a request action.

" }, "DescribePlayerSessionsOutput":{ "type":"structure", "members":{ "PlayerSessions":{ "shape":"PlayerSessionList", "documentation":"

Collection of objects containing properties for each player session that matches the request.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "DescribeRuntimeConfigurationInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier of the fleet to get the runtime configuration for.

" } }, "documentation":"

Represents the input for a request action.

" }, "DescribeRuntimeConfigurationOutput":{ "type":"structure", "members":{ "RuntimeConfiguration":{ "shape":"RuntimeConfiguration", "documentation":"

Instructions describing how server processes should be launched and maintained on each instance in the fleet.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "DescribeScalingPoliciesInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for a fleet. Specify the fleet to retrieve scaling policies for.

" }, "StatusFilter":{ "shape":"ScalingStatusType", "documentation":"

Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status.

  • ACTIVE – The scaling policy is currently in force.

  • UPDATEREQUESTED – A request to update the scaling policy has been received.

  • UPDATING – A change is being made to the scaling policy.

  • DELETEREQUESTED – A request to delete the scaling policy has been received.

  • DELETING – The scaling policy is being deleted.

  • DELETED – The scaling policy has been deleted.

  • ERROR – An error occurred in creating the policy. It should be removed and recreated.

" }, "Limit":{ "shape":"PositiveInteger", "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.

" } }, "documentation":"

Represents the input for a request action.

" }, "DescribeScalingPoliciesOutput":{ "type":"structure", "members":{ "ScalingPolicies":{ "shape":"ScalingPolicyList", "documentation":"

Collection of objects containing the scaling policies matching the request.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "Double":{"type":"double"}, "EC2InstanceCounts":{ "type":"structure", "members":{ "DESIRED":{ "shape":"WholeNumber", "documentation":"

Ideal number of active instances in the fleet.

" }, "MINIMUM":{ "shape":"WholeNumber", "documentation":"

Minimum value allowed for the fleet's instance count.

" }, "MAXIMUM":{ "shape":"WholeNumber", "documentation":"

Maximum value allowed for the fleet's instance count.

" }, "PENDING":{ "shape":"WholeNumber", "documentation":"

Number of instances in the fleet that are starting but not yet active.

" }, "ACTIVE":{ "shape":"WholeNumber", "documentation":"

Actual number of active instances in the fleet.

" }, "IDLE":{ "shape":"WholeNumber", "documentation":"

Number of active instances in the fleet that are not currently hosting a game session.

" }, "TERMINATING":{ "shape":"WholeNumber", "documentation":"

Number of instances in the fleet that are no longer active but haven't yet been terminated.

" } }, "documentation":"

Current status of fleet capacity. The number of active instances should match or be in the process of matching the number of desired instances. Pending and terminating counts are non-zero only if fleet capacity is adjusting to an UpdateFleetCapacity request, or if access to resources is temporarily affected.

" }, "EC2InstanceLimit":{ "type":"structure", "members":{ "EC2InstanceType":{ "shape":"EC2InstanceType", "documentation":"

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

" }, "CurrentInstances":{ "shape":"WholeNumber", "documentation":"

Number of instances of the specified type that are currently in use by this AWS account.

" }, "InstanceLimit":{ "shape":"WholeNumber", "documentation":"

Number of instances allowed.

" } }, "documentation":"

Maximum number of instances allowed based on the Amazon Elastic Compute Cloud (Amazon EC2) instance type. Instance limits can be retrieved by calling DescribeEC2InstanceLimits.

" }, "EC2InstanceLimitList":{ "type":"list", "member":{"shape":"EC2InstanceLimit"} }, "EC2InstanceType":{ "type":"string", "enum":[ "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge" ] }, "Event":{ "type":"structure", "members":{ "EventId":{ "shape":"NonZeroAndMaxString", "documentation":"

Unique identifier for a fleet event.

" }, "ResourceId":{ "shape":"NonZeroAndMaxString", "documentation":"

Unique identifier for the resource, such as a fleet ID.

" }, "EventCode":{ "shape":"EventCode", "documentation":"

Type of event being logged.

" }, "Message":{ "shape":"NonEmptyString", "documentation":"

Additional information related to the event.

" }, "EventTime":{ "shape":"Timestamp", "documentation":"

Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" } }, "documentation":"

Log entry describing an event involving Amazon GameLift resources (such as a fleet). In addition to tracking activity, event codes and messages can provide additional information for troubleshooting and debugging problems.

" }, "EventCode":{ "type":"string", "enum":[ "GENERIC_EVENT", "FLEET_CREATED", "FLEET_DELETED", "FLEET_SCALING_EVENT", "FLEET_STATE_DOWNLOADING", "FLEET_STATE_VALIDATING", "FLEET_STATE_BUILDING", "FLEET_STATE_ACTIVATING", "FLEET_STATE_ACTIVE", "FLEET_STATE_ERROR", "FLEET_INITIALIZATION_FAILED", "FLEET_BINARY_DOWNLOAD_FAILED", "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND", "FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE", "FLEET_VALIDATION_TIMED_OUT", "FLEET_ACTIVATION_FAILED", "FLEET_ACTIVATION_FAILED_NO_INSTANCES", "FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED", "SERVER_PROCESS_INVALID_PATH", "SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT", "SERVER_PROCESS_PROCESS_READY_TIMEOUT", "SERVER_PROCESS_CRASHED", "SERVER_PROCESS_TERMINATED_UNHEALTHY", "SERVER_PROCESS_FORCE_TERMINATED", "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT" ] }, "EventList":{ "type":"list", "member":{"shape":"Event"} }, "FleetAttributes":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for a fleet.

" }, "Description":{ "shape":"NonZeroAndMaxString", "documentation":"

Human-readable description of the fleet.

" }, "Name":{ "shape":"NonZeroAndMaxString", "documentation":"

Descriptive label associated with a fleet. Fleet names do not need to be unique.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" }, "TerminationTime":{ "shape":"Timestamp", "documentation":"

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" }, "Status":{ "shape":"FleetStatus", "documentation":"

Current status of the fleet.

Possible fleet statuses include the following:

  • NEW – A new fleet has been defined and desired instances is set to 1.

  • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.

  • ACTIVE – Hosts can now accept game sessions.

  • ERROR – An error occurred when downloading, validating, building, or activating the fleet.

  • DELETING – Hosts are responding to a delete fleet request.

  • TERMINATED – The fleet no longer exists.

" }, "BuildId":{ "shape":"BuildId", "documentation":"

Unique identifier for a build.

" }, "ServerLaunchPath":{ "shape":"NonZeroAndMaxString", "documentation":"

Path to a game server executable in the fleet's build, specified for fleets created prior to 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration .

" }, "ServerLaunchParameters":{ "shape":"NonZeroAndMaxString", "documentation":"

Game server launch parameters specified for fleets created prior to 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration .

" }, "LogPaths":{ "shape":"StringList", "documentation":"

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, GameLift will automatically upload logs that are stored on each instance at C:\\game\\logs (for Windows) or /local/game/logs (for Linux). Use the GameLift console to access stored logs.

" }, "NewGameSessionProtectionPolicy":{ "shape":"ProtectionPolicy", "documentation":"

Type of game session protection to set for all new instances started in the fleet.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

" }, "OperatingSystem":{ "shape":"OperatingSystem", "documentation":"

Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

" }, "ResourceCreationLimitPolicy":{ "shape":"ResourceCreationLimitPolicy", "documentation":"

Fleet policy to limit the number of game sessions an individual player can create over a span of time.

" } }, "documentation":"

General properties describing a fleet.

" }, "FleetAttributesList":{ "type":"list", "member":{"shape":"FleetAttributes"} }, "FleetCapacity":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for a fleet.

" }, "InstanceType":{ "shape":"EC2InstanceType", "documentation":"

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

" }, "InstanceCounts":{ "shape":"EC2InstanceCounts", "documentation":"

Current status of fleet capacity.

" } }, "documentation":"

Information about the fleet's capacity. Fleet capacity is measured in EC2 instances. By default, new fleets have a capacity of one instance, but can be updated as needed. The maximum number of instances for a fleet is determined by the fleet's instance type.

" }, "FleetCapacityExceededException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "documentation":"

The specified fleet has no available instances to fulfill a CreateGameSession request. Clients can retry such requests immediately or after a waiting period.

", "exception":true }, "FleetCapacityList":{ "type":"list", "member":{"shape":"FleetCapacity"} }, "FleetId":{ "type":"string", "pattern":"^fleet-\\S+" }, "FleetIdList":{ "type":"list", "member":{"shape":"FleetId"}, "min":1 }, "FleetStatus":{ "type":"string", "enum":[ "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED" ] }, "FleetUtilization":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for a fleet.

" }, "ActiveServerProcessCount":{ "shape":"WholeNumber", "documentation":"

Number of server processes in an ACTIVE status currently running across all instances in the fleet

" }, "ActiveGameSessionCount":{ "shape":"WholeNumber", "documentation":"

Number of active game sessions currently being hosted on all instances in the fleet.

" }, "CurrentPlayerSessionCount":{ "shape":"WholeNumber", "documentation":"

Number of active player sessions currently being hosted on all instances in the fleet.

" }, "MaximumPlayerSessionCount":{ "shape":"WholeNumber", "documentation":"

Maximum players allowed across all game sessions currently being hosted on all instances in the fleet.

" } }, "documentation":"

Current status of fleet utilization, including the number of game and player sessions being hosted.

" }, "FleetUtilizationList":{ "type":"list", "member":{"shape":"FleetUtilization"} }, "FreeText":{"type":"string"}, "GameProperty":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"GamePropertyKey", "documentation":"

TBD

" }, "Value":{ "shape":"GamePropertyValue", "documentation":"

TBD

" } }, "documentation":"

Set of key-value pairs containing information a server process requires to set up a game session. This object allows you to pass in any set of data needed for your game. For more information, see the Amazon GameLift Developer Guide.

" }, "GamePropertyKey":{ "type":"string", "max":32 }, "GamePropertyList":{ "type":"list", "member":{"shape":"GameProperty"}, "max":16 }, "GamePropertyValue":{ "type":"string", "max":96 }, "GameSession":{ "type":"structure", "members":{ "GameSessionId":{ "shape":"NonZeroAndMaxString", "documentation":"

Unique identifier for a game session. Game session ID format is as follows: \"arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>\". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

" }, "Name":{ "shape":"NonZeroAndMaxString", "documentation":"

Descriptive label associated with a game session. Session names do not need to be unique.

" }, "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for a fleet.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" }, "TerminationTime":{ "shape":"Timestamp", "documentation":"

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" }, "CurrentPlayerSessionCount":{ "shape":"WholeNumber", "documentation":"

Number of players currently in the game session.

" }, "MaximumPlayerSessionCount":{ "shape":"WholeNumber", "documentation":"

Maximum number of players allowed in the game session.

" }, "Status":{ "shape":"GameSessionStatus", "documentation":"

Current status of the game session. A game session must be in an ACTIVE status to have player sessions.

" }, "GameProperties":{ "shape":"GamePropertyList", "documentation":"

Set of custom properties for the game session.

" }, "IpAddress":{ "shape":"IpAddress", "documentation":"

IP address of the game session. To connect to a GameLift server process, an app needs both the IP address and port number.

" }, "Port":{ "shape":"PortNumber", "documentation":"

Port number for the game session. To connect to a GameLift server process, an app needs both the IP address and port number.

" }, "PlayerSessionCreationPolicy":{ "shape":"PlayerSessionCreationPolicy", "documentation":"

Indicates whether or not the game session is accepting new players.

" }, "CreatorId":{ "shape":"NonZeroAndMaxString", "documentation":"

Player ID of the person or entity that created the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions for a single player.

" } }, "documentation":"

Properties describing a game session.

" }, "GameSessionDetail":{ "type":"structure", "members":{ "GameSession":{"shape":"GameSession"}, "ProtectionPolicy":{ "shape":"ProtectionPolicy", "documentation":"

Current status of protection for the game session.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

" } }, "documentation":"

A game session's properties and the protection policy currently in force.

" }, "GameSessionDetailList":{ "type":"list", "member":{"shape":"GameSessionDetail"} }, "GameSessionFullException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "documentation":"

The game instance is currently full and cannot allow the requested player(s) to join. Clients can retry such requests immediately or after a waiting period.

", "exception":true }, "GameSessionList":{ "type":"list", "member":{"shape":"GameSession"} }, "GameSessionStatus":{ "type":"string", "enum":[ "ACTIVE", "ACTIVATING", "TERMINATED", "TERMINATING", "ERROR" ] }, "GetGameSessionLogUrlInput":{ "type":"structure", "required":["GameSessionId"], "members":{ "GameSessionId":{ "shape":"ArnStringModel", "documentation":"

Unique identifier for the game session to get logs for. Game session ID format is as follows: \"arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>\". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

" } }, "documentation":"

Represents the input for a request action.

" }, "GetGameSessionLogUrlOutput":{ "type":"structure", "members":{ "PreSignedUrl":{ "shape":"NonZeroAndMaxString", "documentation":"

Location of the requested game session logs, available for download.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "GetInstanceAccessInput":{ "type":"structure", "required":[ "FleetId", "InstanceId" ], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for a fleet. Specify the fleet that contain the instance you want access to. The fleet can be in any of the following statuses: ACTIVATING, ACTIVE, or ERROR. Fleets with an ERROR status can be accessed for a few hours before being deleted.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

Unique identifier for an instance. Specify the instance you want to get access to. You can access an instance in any status.

" } } }, "GetInstanceAccessOutput":{ "type":"structure", "members":{ "InstanceAccess":{ "shape":"InstanceAccess", "documentation":"

Object containing connection information for a fleet instance, including IP address and access credentials.

" } } }, "IdStringModel":{ "type":"string", "max":48, "min":1, "pattern":"[a-zA-Z0-9-]+" }, "IdempotentParameterMismatchException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "documentation":"

A game session with this custom ID string already exists in this fleet. Resolve this conflict before retrying this request.

", "exception":true }, "Instance":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for the fleet that the instance belongs to.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

Unique identifier for the instance.

" }, "IpAddress":{ "shape":"IpAddress", "documentation":"

IP address assigned to the instance.

" }, "OperatingSystem":{ "shape":"OperatingSystem", "documentation":"

Operating system that is running on this instance.

" }, "Type":{ "shape":"EC2InstanceType", "documentation":"

EC2 instance type that defines the computing resources of this instance.

" }, "Status":{ "shape":"InstanceStatus", "documentation":"

Current status of the instance. Possible statuses include the following:

  • PENDING – The instance is in the process of being created and launching server processes as defined in the fleet's runtime configuration.

  • ACTIVE – The instance has been successfully created and at least one server process has successfully launched and reported back to GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

  • TERMINATING – The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" } }, "documentation":"

Properties that describe an instance of a virtual computing resource that hosts one or more game servers. A fleet contains zero or more instances.

" }, "InstanceAccess":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for the fleet containing the instance being accessed.

" }, "InstanceId":{ "shape":"InstanceId", "documentation":"

Unique identifier for the instance being accessed.

" }, "IpAddress":{ "shape":"IpAddress", "documentation":"

IP address assigned to the instance.

" }, "OperatingSystem":{ "shape":"OperatingSystem", "documentation":"

Operating system that is running on the instance.

" }, "Credentials":{ "shape":"InstanceCredentials", "documentation":"

Credentials required to access the instance.

" } }, "documentation":"

Information required to remotely connect to a fleet instance. Access is requested by calling GetInstanceAccess.

" }, "InstanceCredentials":{ "type":"structure", "members":{ "UserName":{ "shape":"NonEmptyString", "documentation":"

User login string.

" }, "Secret":{ "shape":"NonEmptyString", "documentation":"

Secret string. For Windows instances, the secret is a password. For Linux instances, it is a private key.

" } }, "documentation":"

Set of credentials required to remotely access a fleet instance. Access credentials are requested by calling GetInstanceAccess and returned in an InstanceAccess object.

", "sensitive":true }, "InstanceId":{ "type":"string", "pattern":"[a-zA-Z0-9\\.-]+" }, "InstanceList":{ "type":"list", "member":{"shape":"Instance"} }, "InstanceStatus":{ "type":"string", "enum":[ "PENDING", "ACTIVE", "TERMINATING" ] }, "Integer":{"type":"integer"}, "InternalServiceException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "documentation":"

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

", "exception":true, "fault":true }, "InvalidFleetStatusException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "documentation":"

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

", "exception":true }, "InvalidGameSessionStatusException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "documentation":"

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.

", "exception":true }, "InvalidRequestException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "documentation":"

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

", "exception":true }, "IpAddress":{"type":"string"}, "IpPermission":{ "type":"structure", "required":[ "FromPort", "ToPort", "IpRange", "Protocol" ], "members":{ "FromPort":{ "shape":"PortNumber", "documentation":"

Starting value for a range of allowed port numbers.

" }, "ToPort":{ "shape":"PortNumber", "documentation":"

Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

" }, "IpRange":{ "shape":"NonBlankString", "documentation":"

Range of allowed IP addresses. This value must be expressed in CIDR notation. Example: \"000.000.000.000/[subnet mask]\" or optionally the shortened version \"0.0.0.0/[subnet mask]\".

" }, "Protocol":{ "shape":"IpProtocol", "documentation":"

Network communication protocol used by the fleet.

" } }, "documentation":"

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on GameLift. Each game session hosted on a fleet is assigned a unique combination of IP address and port number, which must fall into the fleet's allowed ranges. This combination is included in the GameSession object.

" }, "IpPermissionsList":{ "type":"list", "member":{"shape":"IpPermission"}, "max":50 }, "IpProtocol":{ "type":"string", "enum":[ "TCP", "UDP" ] }, "LimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "documentation":"

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

", "exception":true }, "ListAliasesInput":{ "type":"structure", "members":{ "RoutingStrategyType":{ "shape":"RoutingStrategyType", "documentation":"

Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.

Possible routing types include the following:

  • SIMPLE – The alias resolves to one specific fleet. Use this type when routing to active fleets.

  • TERMINAL – The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

" }, "Name":{ "shape":"NonEmptyString", "documentation":"

Descriptive label associated with an alias. Alias names do not need to be unique.

" }, "Limit":{ "shape":"PositiveInteger", "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" }, "NextToken":{ "shape":"NonEmptyString", "documentation":"

Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.

" } }, "documentation":"

Represents the input for a request action.

" }, "ListAliasesOutput":{ "type":"structure", "members":{ "Aliases":{ "shape":"AliasList", "documentation":"

Collection of alias records that match the list request.

" }, "NextToken":{ "shape":"NonEmptyString", "documentation":"

Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "ListBuildsInput":{ "type":"structure", "members":{ "Status":{ "shape":"BuildStatus", "documentation":"

Build status to filter results by. To retrieve all builds, leave this parameter empty.

Possible build statuses include the following:

  • INITIALIZED – A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY – The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED – The game build upload failed. You cannot create new fleets for this build.

" }, "Limit":{ "shape":"PositiveInteger", "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" }, "NextToken":{ "shape":"NonEmptyString", "documentation":"

Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.

" } }, "documentation":"

Represents the input for a request action.

" }, "ListBuildsOutput":{ "type":"structure", "members":{ "Builds":{ "shape":"BuildList", "documentation":"

Collection of build records that match the request.

" }, "NextToken":{ "shape":"NonEmptyString", "documentation":"

Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "ListFleetsInput":{ "type":"structure", "members":{ "BuildId":{ "shape":"BuildId", "documentation":"

Unique identifier of the build to return fleets for. Use this parameter to return only fleets using the specified build. To retrieve all fleets, leave this parameter empty.

" }, "Limit":{ "shape":"PositiveInteger", "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.

" } }, "documentation":"

Represents the input for a request action.

" }, "ListFleetsOutput":{ "type":"structure", "members":{ "FleetIds":{ "shape":"FleetIdList", "documentation":"

Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by passing this result set to a call to DescribeFleetAttributes, DescribeFleetCapacity, and DescribeFleetUtilization.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "MetricName":{ "type":"string", "enum":[ "ActivatingGameSessions", "ActiveGameSessions", "ActiveInstances", "AvailablePlayerSessions", "CurrentPlayerSessions", "IdleInstances" ] }, "NonBlankAndLengthConstraintString":{ "type":"string", "max":1024, "min":1, "pattern":".*\\S.*" }, "NonBlankString":{ "type":"string", "pattern":"[^\\s]+" }, "NonEmptyString":{ "type":"string", "min":1 }, "NonZeroAndMaxString":{ "type":"string", "max":1024, "min":1 }, "NotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "documentation":"

A service resource associated with the request could not be found. Clients should not retry such requests.

", "exception":true }, "OperatingSystem":{ "type":"string", "enum":[ "WINDOWS_2012", "AMAZON_LINUX" ] }, "PlayerIdList":{ "type":"list", "member":{"shape":"NonZeroAndMaxString"}, "max":25, "min":1 }, "PlayerSession":{ "type":"structure", "members":{ "PlayerSessionId":{ "shape":"PlayerSessionId", "documentation":"

Unique identifier for a player session.

" }, "PlayerId":{ "shape":"NonZeroAndMaxString", "documentation":"

Unique identifier for a player.

" }, "GameSessionId":{ "shape":"NonZeroAndMaxString", "documentation":"

Unique identifier for the game session that the player session is connected to.

" }, "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for a fleet.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" }, "TerminationTime":{ "shape":"Timestamp", "documentation":"

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" }, "Status":{ "shape":"PlayerSessionStatus", "documentation":"

Current status of the player session.

Possible player session statuses include the following:

  • RESERVED – The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE – The player has been validated by the server process and is currently connected.

  • COMPLETED – The player connection has been dropped.

  • TIMEDOUT – A player session request was received, but the player did not connect and/or was not validated within the time-out limit (60 seconds).

" }, "IpAddress":{ "shape":"IpAddress", "documentation":"

Game session IP address. All player sessions reference the game session location.

" }, "Port":{ "shape":"PortNumber", "documentation":"

Port number for the game session. To connect to a GameLift server process, an app needs both the IP address and port number.

" } }, "documentation":"

Properties describing a player session.

" }, "PlayerSessionCreationPolicy":{ "type":"string", "enum":[ "ACCEPT_ALL", "DENY_ALL" ] }, "PlayerSessionId":{ "type":"string", "pattern":"^psess-\\S+" }, "PlayerSessionList":{ "type":"list", "member":{"shape":"PlayerSession"} }, "PlayerSessionStatus":{ "type":"string", "enum":[ "RESERVED", "ACTIVE", "COMPLETED", "TIMEDOUT" ] }, "PortNumber":{ "type":"integer", "max":60000, "min":1 }, "PositiveInteger":{ "type":"integer", "min":1 }, "PositiveLong":{ "type":"long", "min":1 }, "ProtectionPolicy":{ "type":"string", "enum":[ "NoProtection", "FullProtection" ] }, "PutScalingPolicyInput":{ "type":"structure", "required":[ "Name", "FleetId", "ScalingAdjustment", "ScalingAdjustmentType", "Threshold", "ComparisonOperator", "EvaluationPeriods", "MetricName" ], "members":{ "Name":{ "shape":"NonZeroAndMaxString", "documentation":"

Descriptive label associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

" }, "FleetId":{ "shape":"FleetId", "documentation":"

Unique identity for the fleet to scale with this policy.

" }, "ScalingAdjustment":{ "shape":"Integer", "documentation":"

Amount of adjustment to make, based on the scaling adjustment type.

" }, "ScalingAdjustmentType":{ "shape":"ScalingAdjustmentType", "documentation":"

Type of adjustment to make to a fleet's instance count (see FleetCapacity):

  • ChangeInCapacity – add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.

  • ExactCapacity – set the instance count to the scaling adjustment value.

  • PercentChangeInCapacity – increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down; for example, a value of \"-10\" scales the fleet down by 10%.

" }, "Threshold":{ "shape":"Double", "documentation":"

Metric value used to trigger a scaling event.

" }, "ComparisonOperator":{ "shape":"ComparisonOperatorType", "documentation":"

Comparison operator to use when measuring the metric against the threshold value.

" }, "EvaluationPeriods":{ "shape":"PositiveInteger", "documentation":"

Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.

  • ActivatingGameSessions – number of game sessions in the process of being created (game session status = ACTIVATING).

  • ActiveGameSessions – number of game sessions currently running (game session status = ACTIVE).

  • CurrentPlayerSessions – number of active or reserved player sessions (player session status = ACTIVE or RESERVED).

  • AvailablePlayerSessions – number of player session slots currently available in active game sessions across the fleet, calculated by subtracting a game session's current player session count from its maximum player session count. This number includes game sessions that are not currently accepting players (game session PlayerSessionCreationPolicy = DENY_ALL).

  • ActiveInstances – number of instances currently running a game session.

  • IdleInstances – number of instances not currently running a game session.

" } }, "documentation":"

Represents the input for a request action.

" }, "PutScalingPolicyOutput":{ "type":"structure", "members":{ "Name":{ "shape":"NonZeroAndMaxString", "documentation":"

Descriptive label associated with a scaling policy. Policy names do not need to be unique.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "RequestUploadCredentialsInput":{ "type":"structure", "required":["BuildId"], "members":{ "BuildId":{ "shape":"BuildId", "documentation":"

Unique identifier for the build you want to get credentials for.

" } }, "documentation":"

Represents the input for a request action.

" }, "RequestUploadCredentialsOutput":{ "type":"structure", "members":{ "UploadCredentials":{ "shape":"AwsCredentials", "documentation":"

AWS credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.

" }, "StorageLocation":{ "shape":"S3Location", "documentation":"

Amazon S3 path and key, identifying where the game build files are stored.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "ResolveAliasInput":{ "type":"structure", "required":["AliasId"], "members":{ "AliasId":{ "shape":"AliasId", "documentation":"

Unique identifier for the alias you want to resolve.

" } }, "documentation":"

Represents the input for a request action.

" }, "ResolveAliasOutput":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Fleet ID associated with the requested alias.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "ResourceCreationLimitPolicy":{ "type":"structure", "members":{ "NewGameSessionsPerCreator":{ "shape":"WholeNumber", "documentation":"

Maximum number of game sessions that an individual can create during the policy period.

" }, "PolicyPeriodInMinutes":{ "shape":"WholeNumber", "documentation":"

Time span used in evaluating the resource creation limit policy.

" } }, "documentation":"

Policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: \"An individual player can create a maximum number of new game sessions within a specified time period\".

The policy is evaluated when a player tries to create a new game session. For example, with a policy of 10 new game sessions and a time period of 60 minutes, on receiving a CreateGameSession request, GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.

" }, "RoutingStrategy":{ "type":"structure", "members":{ "Type":{ "shape":"RoutingStrategyType", "documentation":"

Type of routing strategy.

Possible routing types include the following:

  • SIMPLE – The alias resolves to one specific fleet. Use this type when routing to active fleets.

  • TERMINAL – The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

" }, "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for a fleet.

" }, "Message":{ "shape":"FreeText", "documentation":"

Message text to be used with a terminal routing strategy.

" } }, "documentation":"

Routing configuration for a fleet alias.

" }, "RoutingStrategyType":{ "type":"string", "enum":[ "SIMPLE", "TERMINAL" ] }, "RuntimeConfiguration":{ "type":"structure", "members":{ "ServerProcesses":{ "shape":"ServerProcessList", "documentation":"

Collection of server process configurations describing what server processes to run on each instance in a fleet

" } }, "documentation":"

Collection of server process configurations that describe what processes should be run on each instance in a fleet. An instance can launch and maintain multiple server processes based on the runtime configuration; it regularly checks for an updated runtime configuration and starts new server processes to match the latest version.

The key purpose of a runtime configuration with multiple server process configurations is to be able to run more than one kind of game server in a single fleet. You can include configurations for more than one server executable in order to run two or more different programs to run on the same instance. This option might be useful, for example, to run more than one version of your game server on the same fleet. Another option is to specify configurations for the same server executable but with different launch parameters.

A GameLift instance is limited to 50 processes running simultaneously. To calculate the total number of processes specified in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the runtime configuration.

" }, "S3Location":{ "type":"structure", "members":{ "Bucket":{ "shape":"NonEmptyString", "documentation":"

Amazon S3 bucket identifier.

" }, "Key":{ "shape":"NonEmptyString", "documentation":"

Amazon S3 bucket key.

" }, "RoleArn":{ "shape":"NonEmptyString", "documentation":"

Amazon resource number for the cross-account access role that allows GameLift access to the S3 bucket.

" } }, "documentation":"

Location in Amazon Simple Storage Service (Amazon S3) where a build's files are stored. This location is assigned in response to a CreateBuild call, and is always in the same region as the service used to create the build. For more details see the Amazon S3 documentation.

" }, "ScalingAdjustmentType":{ "type":"string", "enum":[ "ChangeInCapacity", "ExactCapacity", "PercentChangeInCapacity" ] }, "ScalingPolicy":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identity for the fleet associated with this scaling policy.

" }, "Name":{ "shape":"NonZeroAndMaxString", "documentation":"

Descriptive label associated with a scaling policy. Policy names do not need to be unique.

" }, "Status":{ "shape":"ScalingStatusType", "documentation":"

Current status of the scaling policy. The scaling policy is only in force when in an ACTIVE status.

  • ACTIVE – The scaling policy is currently in force.

  • UPDATE_REQUESTED – A request to update the scaling policy has been received.

  • UPDATING – A change is being made to the scaling policy.

  • DELETE_REQUESTED – A request to delete the scaling policy has been received.

  • DELETING – The scaling policy is being deleted.

  • DELETED – The scaling policy has been deleted.

  • ERROR – An error occurred in creating the policy. It should be removed and recreated.

" }, "ScalingAdjustment":{ "shape":"Integer", "documentation":"

Amount of adjustment to make, based on the scaling adjustment type.

" }, "ScalingAdjustmentType":{ "shape":"ScalingAdjustmentType", "documentation":"

Type of adjustment to make to a fleet's instance count (see FleetCapacity):

  • ChangeInCapacity – add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.

  • ExactCapacity – set the instance count to the scaling adjustment value.

  • PercentChangeInCapacity – increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.

" }, "ComparisonOperator":{ "shape":"ComparisonOperatorType", "documentation":"

Comparison operator to use when measuring a metric against the threshold value.

" }, "Threshold":{ "shape":"Double", "documentation":"

Metric value used to trigger a scaling event.

" }, "EvaluationPeriods":{ "shape":"PositiveInteger", "documentation":"

Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

Name of the GameLift-defined metric that is used to trigger an adjustment.

  • ActivatingGameSessions – number of game sessions in the process of being created (game session status = ACTIVATING).

  • ActiveGameSessions – number of game sessions currently running (game session status = ACTIVE).

  • CurrentPlayerSessions – number of active or reserved player sessions (player session status = ACTIVE or RESERVED).

  • AvailablePlayerSessions – number of player session slots currently available in active game sessions across the fleet, calculated by subtracting a game session's current player session count from its maximum player session count. This number does include game sessions that are not currently accepting players (game session PlayerSessionCreationPolicy = DENY_ALL).

  • ActiveInstances – number of instances currently running a game session.

  • IdleInstances – number of instances not currently running a game session.

" } }, "documentation":"

Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.

" }, "ScalingPolicyList":{ "type":"list", "member":{"shape":"ScalingPolicy"} }, "ScalingStatusType":{ "type":"string", "enum":[ "ACTIVE", "UPDATE_REQUESTED", "UPDATING", "DELETE_REQUESTED", "DELETING", "DELETED", "ERROR" ] }, "SearchGameSessionsInput":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for a fleet. Each request must reference either a fleet ID or alias ID, but not both.

" }, "AliasId":{ "shape":"AliasId", "documentation":"

Unique identifier for a fleet alias. Each request must reference either a fleet ID or alias ID, but not both.

" }, "FilterExpression":{ "shape":"NonZeroAndMaxString", "documentation":"

String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.

A filter expression can contain one or multiple conditions. Each condition consists of the following:

  • Operand -- Name of a game session attribute. Valid values are gameSessionName, gameSessionId, creationTimeMillis, playerSessionCount, maximumSessions, hasAvailablePlayerSessions.

  • Comparator -- Valid comparators are: =, <>, <, >, <=, >=.

  • Value -- Value to be searched for. Values can be numbers, boolean values (true/false) or strings. String values are case sensitive, enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators = and <>. For example, the following filter expression searches on gameSessionName: \"FilterExpression\": \"gameSessionName = 'Matt\\\\'s Awesome Game 1'\".

To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).

Session search evaluates conditions from left to right using the following precedence rules:

  1. =, <>, <, >, <=, >=

  2. Parentheses

  3. NOT

  4. AND

  5. OR

For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: \"maximumSessions>=10 AND hasAvailablePlayerSessions=true\".

" }, "SortExpression":{ "shape":"NonZeroAndMaxString", "documentation":"

Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:

  • Operand -- Name of a game session attribute. Valid values are gameSessionName, gameSessionId, creationTimeMillis, playerSessionCount, maximumSessions, hasAvailablePlayerSessions.

  • Order -- Valid sort orders are ASC (ascending) and DESC (descending).

For example, this sort expression returns the oldest active sessions first: \"SortExpression\": \"creationTimeMillis ASC\". Results with a null value for the sort operand are returned at the end of the list.

" }, "Limit":{ "shape":"PositiveInteger", "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.

" } }, "documentation":"

Represents the input for a request action.

" }, "SearchGameSessionsOutput":{ "type":"structure", "members":{ "GameSessions":{ "shape":"GameSessionList", "documentation":"

Collection of objects containing game session properties for each session matching the request.

" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"

Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "ServerProcess":{ "type":"structure", "required":[ "LaunchPath", "ConcurrentExecutions" ], "members":{ "LaunchPath":{ "shape":"NonZeroAndMaxString", "documentation":"

Location of the server executable in a game build. All game builds are installed on instances at the root : for Windows instances C:\\game, and for Linux instances /local/game. A Windows game build with an executable file located at MyGame\\latest\\server.exe must have a launch path of \"C:\\game\\MyGame\\latest\\server.exe\". A Linux game build with an executable file located at MyGame/latest/server.exe must have a launch path of \"/local/game/MyGame/latest/server.exe\".

" }, "Parameters":{ "shape":"NonZeroAndMaxString", "documentation":"

Optional list of parameters to pass to the server executable on launch.

" }, "ConcurrentExecutions":{ "shape":"PositiveInteger", "documentation":"

Number of server processes using this configuration to run concurrently on an instance.

" } }, "documentation":"

A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration .

" }, "ServerProcessList":{ "type":"list", "member":{"shape":"ServerProcess"}, "max":50, "min":1 }, "StringList":{ "type":"list", "member":{"shape":"NonZeroAndMaxString"} }, "TerminalRoutingStrategyException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "documentation":"

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

", "exception":true }, "Timestamp":{"type":"timestamp"}, "UnauthorizedException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "documentation":"

The client failed authentication. Clients should not retry such requests.

", "exception":true }, "UpdateAliasInput":{ "type":"structure", "required":["AliasId"], "members":{ "AliasId":{ "shape":"AliasId", "documentation":"

Unique identifier for a fleet alias. Specify the alias you want to update.

" }, "Name":{ "shape":"NonBlankAndLengthConstraintString", "documentation":"

Descriptive label associated with an alias. Alias names do not need to be unique.

" }, "Description":{ "shape":"NonZeroAndMaxString", "documentation":"

Human-readable description of an alias.

" }, "RoutingStrategy":{ "shape":"RoutingStrategy", "documentation":"

Object specifying the fleet and routing type to use for the alias.

" } }, "documentation":"

Represents the input for a request action.

" }, "UpdateAliasOutput":{ "type":"structure", "members":{ "Alias":{ "shape":"Alias", "documentation":"

Object containing the updated alias configuration.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "UpdateBuildInput":{ "type":"structure", "required":["BuildId"], "members":{ "BuildId":{ "shape":"BuildId", "documentation":"

Unique identifier of the build you want to update.

" }, "Name":{ "shape":"NonZeroAndMaxString", "documentation":"

Descriptive label associated with a build. Build names do not need to be unique.

" }, "Version":{ "shape":"NonZeroAndMaxString", "documentation":"

Version associated with this build. Version strings do not need to be unique to a build.

" } }, "documentation":"

Represents the input for a request action.

" }, "UpdateBuildOutput":{ "type":"structure", "members":{ "Build":{ "shape":"Build", "documentation":"

Object containing the updated build record.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "UpdateFleetAttributesInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for the fleet you want to update attribute metadata for.

" }, "Name":{ "shape":"NonZeroAndMaxString", "documentation":"

Descriptive label associated with a fleet. Fleet names do not need to be unique.

" }, "Description":{ "shape":"NonZeroAndMaxString", "documentation":"

Human-readable description of a fleet.

" }, "NewGameSessionProtectionPolicy":{ "shape":"ProtectionPolicy", "documentation":"

Game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

" }, "ResourceCreationLimitPolicy":{ "shape":"ResourceCreationLimitPolicy", "documentation":"

Policy that limits the number of game sessions an individual player can create over a span of time.

" } }, "documentation":"

Represents the input for a request action.

" }, "UpdateFleetAttributesOutput":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for the updated fleet.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "UpdateFleetCapacityInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for the fleet you want to update capacity for.

" }, "DesiredInstances":{ "shape":"WholeNumber", "documentation":"

Number of EC2 instances you want this fleet to host.

" }, "MinSize":{ "shape":"WholeNumber", "documentation":"

Minimum value allowed for the fleet's instance count. Default if not set is 0.

" }, "MaxSize":{ "shape":"WholeNumber", "documentation":"

Maximum value allowed for the fleet's instance count. Default if not set is 1.

" } }, "documentation":"

Represents the input for a request action.

" }, "UpdateFleetCapacityOutput":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for the updated fleet.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "UpdateFleetPortSettingsInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for the fleet you want to update port settings for.

" }, "InboundPermissionAuthorizations":{ "shape":"IpPermissionsList", "documentation":"

Collection of port settings to be added to the fleet record.

" }, "InboundPermissionRevocations":{ "shape":"IpPermissionsList", "documentation":"

Collection of port settings to be removed from the fleet record.

" } }, "documentation":"

Represents the input for a request action.

" }, "UpdateFleetPortSettingsOutput":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier for the updated fleet.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "UpdateGameSessionInput":{ "type":"structure", "required":["GameSessionId"], "members":{ "GameSessionId":{ "shape":"ArnStringModel", "documentation":"

Unique identifier for the game session to update. Game session ID format is as follows: \"arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>\". The value of <ID string> is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

" }, "MaximumPlayerSessionCount":{ "shape":"WholeNumber", "documentation":"

Maximum number of players that can be simultaneously connected to the game session.

" }, "Name":{ "shape":"NonZeroAndMaxString", "documentation":"

Descriptive label associated with a game session. Session names do not need to be unique.

" }, "PlayerSessionCreationPolicy":{ "shape":"PlayerSessionCreationPolicy", "documentation":"

Policy determining whether or not the game session accepts new players.

" }, "ProtectionPolicy":{ "shape":"ProtectionPolicy", "documentation":"

Game session protection policy to apply to this game session only.

  • NoProtection – The game session can be terminated during a scale-down event.

  • FullProtection – If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

" } }, "documentation":"

Represents the input for a request action.

" }, "UpdateGameSessionOutput":{ "type":"structure", "members":{ "GameSession":{ "shape":"GameSession", "documentation":"

Object containing the updated game session metadata.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "UpdateRuntimeConfigurationInput":{ "type":"structure", "required":[ "FleetId", "RuntimeConfiguration" ], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"

Unique identifier of the fleet to update runtime configuration for.

" }, "RuntimeConfiguration":{ "shape":"RuntimeConfiguration", "documentation":"

Instructions for launching server processes on each instance in the fleet. The runtime configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance.

" } }, "documentation":"

Represents the input for a request action.

" }, "UpdateRuntimeConfigurationOutput":{ "type":"structure", "members":{ "RuntimeConfiguration":{ "shape":"RuntimeConfiguration", "documentation":"

The runtime configuration currently in force. If the update was successful, this object matches the one in the request.

" } }, "documentation":"

Represents the returned data in response to a request action.

" }, "WholeNumber":{ "type":"integer", "min":0 } }, "documentation":"Amazon GameLift Service

Welcome to the Amazon GameLift API Reference. Amazon GameLift is a managed Amazon Web Services (AWS) service for developers who need a scalable, server-based solution for multiplayer games. Amazon GameLift provides setup and deployment of game servers, and handles infrastructure scaling and session management.

This reference describes the low-level service API for GameLift. You can call this API directly or use the AWS SDK for your preferred language. The AWS SDK includes a set of high-level GameLift actions multiplayer game sessions. Alternatively, you can use the AWS command-line interface (CLI) tool, which includes commands for GameLift. For administrative actions, you can also use the Amazon GameLift console.

More Resources

Manage Games and Players Through GameLift

Call these actions from your game clients and/or services to create and manage multiplayer game sessions and player sessions.

Set Up and Manage Game Servers

Use these administrative actions to configure GameLift to host your game servers. When setting up GameLift, you will need to (1) configure a build for your game and upload build files, and (2) set up one or more fleets to host game sessions. Once you've created and activated a fleet, you can assign aliases to it, scale capacity, track performance and utilization, etc.

To view changes to the API, see the GameLift Document History page.

" } botocore-1.5.7/botocore/data/cloudsearch/0000777454262600001440000000000013042511307021427 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudsearch/2013-01-01/0000777454262600001440000000000013042511307022450 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudsearch/2013-01-01/service-2.json0000666454262600001440000036223613042511306025155 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2013-01-01", "endpointPrefix":"cloudsearch", "serviceFullName":"Amazon CloudSearch", "signatureVersion":"v4", "xmlNamespace":"http://cloudsearch.amazonaws.com/doc/2013-01-01/", "protocol":"query", "uid":"cloudsearch-2013-01-01" }, "documentation":"Amazon CloudSearch Configuration Service

You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

", "operations":{ "BuildSuggesters":{ "name":"BuildSuggesters", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"BuildSuggestersRequest", "documentation":"

Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.

" }, "output":{ "shape":"BuildSuggestersResponse", "documentation":"

The result of a BuildSuggester request. Contains a list of the fields used for suggestions.

", "resultWrapper":"BuildSuggestersResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.

" }, "CreateDomain":{ "name":"CreateDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateDomainRequest", "documentation":"

Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.

" }, "output":{ "shape":"CreateDomainResponse", "documentation":"

The result of a CreateDomainRequest. Contains the status of a newly created domain.

", "resultWrapper":"CreateDomainResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" } ], "documentation":"

Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.

" }, "DefineAnalysisScheme":{ "name":"DefineAnalysisScheme", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DefineAnalysisSchemeRequest", "documentation":"

Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.

" }, "output":{ "shape":"DefineAnalysisSchemeResponse", "documentation":"

The result of a DefineAnalysisScheme request. Contains the status of the newly-configured analysis scheme.

", "resultWrapper":"DefineAnalysisSchemeResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

" }, "DefineExpression":{ "name":"DefineExpression", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DefineExpressionRequest", "documentation":"

Container for the parameters to the DefineExpression operation. Specifies the name of the domain you want to update and the expression you want to configure.

" }, "output":{ "shape":"DefineExpressionResponse", "documentation":"

The result of a DefineExpression request. Contains the status of the newly-configured expression.

", "resultWrapper":"DefineExpressionResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

" }, "DefineIndexField":{ "name":"DefineIndexField", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DefineIndexFieldRequest", "documentation":"

Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.

" }, "output":{ "shape":"DefineIndexFieldResponse", "documentation":"

The result of a DefineIndexField request. Contains the status of the newly-configured index field.

", "resultWrapper":"DefineIndexFieldResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

" }, "DefineSuggester":{ "name":"DefineSuggester", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DefineSuggesterRequest", "documentation":"

Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.

" }, "output":{ "shape":"DefineSuggesterResponse", "documentation":"

The result of a DefineSuggester request. Contains the status of the newly-configured suggester.

", "resultWrapper":"DefineSuggesterResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

" }, "DeleteAnalysisScheme":{ "name":"DeleteAnalysisScheme", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteAnalysisSchemeRequest", "documentation":"

Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.

" }, "output":{ "shape":"DeleteAnalysisSchemeResponse", "documentation":"

The result of a DeleteAnalysisScheme request. Contains the status of the deleted analysis scheme.

", "resultWrapper":"DeleteAnalysisSchemeResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

" }, "DeleteDomain":{ "name":"DeleteDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteDomainRequest", "documentation":"

Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.

" }, "output":{ "shape":"DeleteDomainResponse", "documentation":"

The result of a DeleteDomain request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

", "resultWrapper":"DeleteDomainResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" } ], "documentation":"

Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.

" }, "DeleteExpression":{ "name":"DeleteExpression", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteExpressionRequest", "documentation":"

Container for the parameters to the DeleteExpression operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.

" }, "output":{ "shape":"DeleteExpressionResponse", "documentation":"

The result of a DeleteExpression request. Specifies the expression being deleted.

", "resultWrapper":"DeleteExpressionResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

" }, "DeleteIndexField":{ "name":"DeleteIndexField", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteIndexFieldRequest", "documentation":"

Container for the parameters to the DeleteIndexField operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.

" }, "output":{ "shape":"DeleteIndexFieldResponse", "documentation":"

The result of a DeleteIndexField request.

", "resultWrapper":"DeleteIndexFieldResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

" }, "DeleteSuggester":{ "name":"DeleteSuggester", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteSuggesterRequest", "documentation":"

Container for the parameters to the DeleteSuggester operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.

" }, "output":{ "shape":"DeleteSuggesterResponse", "documentation":"

The result of a DeleteSuggester request. Contains the status of the deleted suggester.

", "resultWrapper":"DeleteSuggesterResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

" }, "DescribeAnalysisSchemes":{ "name":"DescribeAnalysisSchemes", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeAnalysisSchemesRequest", "documentation":"

Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" }, "output":{ "shape":"DescribeAnalysisSchemesResponse", "documentation":"

The result of a DescribeAnalysisSchemes request. Contains the analysis schemes configured for the domain specified in the request.

", "resultWrapper":"DescribeAnalysisSchemesResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

" }, "DescribeAvailabilityOptions":{ "name":"DescribeAvailabilityOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeAvailabilityOptionsRequest", "documentation":"

Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" }, "output":{ "shape":"DescribeAvailabilityOptionsResponse", "documentation":"

The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

", "resultWrapper":"DescribeAvailabilityOptionsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" }, { "shape":"DisabledOperationException", "error":{ "code":"DisabledAction", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" } ], "documentation":"

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

" }, "DescribeDomains":{ "name":"DescribeDomains", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeDomainsRequest", "documentation":"

Container for the parameters to the DescribeDomains operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.

" }, "output":{ "shape":"DescribeDomainsResponse", "documentation":"

The result of a DescribeDomains request. Contains the status of the domains specified in the request or all domains owned by the account.

", "resultWrapper":"DescribeDomainsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" } ], "documentation":"

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&amp;q.parser=structured&amp;size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.

" }, "DescribeExpressions":{ "name":"DescribeExpressions", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeExpressionsRequest", "documentation":"

Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" }, "output":{ "shape":"DescribeExpressionsResponse", "documentation":"

The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request.

", "resultWrapper":"DescribeExpressionsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

" }, "DescribeIndexFields":{ "name":"DescribeIndexFields", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeIndexFieldsRequest", "documentation":"

Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" }, "output":{ "shape":"DescribeIndexFieldsResponse", "documentation":"

The result of a DescribeIndexFields request. Contains the index fields configured for the domain specified in the request.

", "resultWrapper":"DescribeIndexFieldsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.

" }, "DescribeScalingParameters":{ "name":"DescribeScalingParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeScalingParametersRequest", "documentation":"

Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.

" }, "output":{ "shape":"DescribeScalingParametersResponse", "documentation":"

The result of a DescribeScalingParameters request. Contains the scaling parameters configured for the domain specified in the request.

", "resultWrapper":"DescribeScalingParametersResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

" }, "DescribeServiceAccessPolicies":{ "name":"DescribeServiceAccessPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeServiceAccessPoliciesRequest", "documentation":"

Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" }, "output":{ "shape":"DescribeServiceAccessPoliciesResponse", "documentation":"

The result of a DescribeServiceAccessPolicies request.

", "resultWrapper":"DescribeServiceAccessPoliciesResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide.

" }, "DescribeSuggesters":{ "name":"DescribeSuggesters", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeSuggestersRequest", "documentation":"

Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" }, "output":{ "shape":"DescribeSuggestersResponse", "documentation":"

The result of a DescribeSuggesters request.

", "resultWrapper":"DescribeSuggestersResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

" }, "IndexDocuments":{ "name":"IndexDocuments", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"IndexDocumentsRequest", "documentation":"

Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.

" }, "output":{ "shape":"IndexDocumentsResponse", "documentation":"

The result of an IndexDocuments request. Contains the status of the indexing operation, including the fields being indexed.

", "resultWrapper":"IndexDocumentsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.

" }, "ListDomainNames":{ "name":"ListDomainNames", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"ListDomainNamesResponse", "documentation":"

The result of a ListDomainNames request. Contains a list of the domains owned by an account.

", "resultWrapper":"ListDomainNamesResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" } ], "documentation":"

Lists all search domains owned by an account.

" }, "UpdateAvailabilityOptions":{ "name":"UpdateAvailabilityOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"UpdateAvailabilityOptionsRequest", "documentation":"

Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

" }, "output":{ "shape":"UpdateAvailabilityOptionsResponse", "documentation":"

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

", "resultWrapper":"UpdateAvailabilityOptionsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" }, { "shape":"DisabledOperationException", "error":{ "code":"DisabledAction", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" } ], "documentation":"

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

" }, "UpdateScalingParameters":{ "name":"UpdateScalingParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"UpdateScalingParametersRequest", "documentation":"

Container for the parameters to the UpdateScalingParameters operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.

" }, "output":{ "shape":"UpdateScalingParametersResponse", "documentation":"

The result of a UpdateScalingParameters request. Contains the status of the newly-configured scaling parameters.

", "resultWrapper":"UpdateScalingParametersResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" } ], "documentation":"

Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

" }, "UpdateServiceAccessPolicies":{ "name":"UpdateServiceAccessPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"UpdateServiceAccessPoliciesRequest", "documentation":"

Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies the name of the domain you want to update and the access rules you want to configure.

" }, "output":{ "shape":"UpdateServiceAccessPoliciesResponse", "documentation":"

The result of an UpdateServiceAccessPolicies request. Contains the new access policies.

", "resultWrapper":"UpdateServiceAccessPoliciesResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" } ], "documentation":"

Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.

" } }, "shapes":{ "APIVersion":{ "type":"string", "documentation":"

The Amazon CloudSearch API version for a domain: 2011-02-01 or 2013-01-01.

" }, "ARN":{ "type":"string", "documentation":"

The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

" }, "AccessPoliciesStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{"shape":"PolicyDocument"}, "Status":{"shape":"OptionStatus"} }, "documentation":"

The configured access rules for the domain's document and search endpoints, and the current status of those rules.

" }, "AlgorithmicStemming":{ "type":"string", "enum":[ "none", "minimal", "light", "full" ] }, "AnalysisOptions":{ "type":"structure", "members":{ "Synonyms":{ "shape":"String", "documentation":"

A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.

" }, "Stopwords":{ "shape":"String", "documentation":"

A JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.

" }, "StemmingDictionary":{ "shape":"String", "documentation":"

A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.

" }, "JapaneseTokenizationDictionary":{ "shape":"String", "documentation":"

A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.

" }, "AlgorithmicStemming":{ "shape":"AlgorithmicStemming", "documentation":"

The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

" } }, "documentation":"

Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.

" }, "AnalysisScheme":{ "type":"structure", "required":[ "AnalysisSchemeName", "AnalysisSchemeLanguage" ], "members":{ "AnalysisSchemeName":{"shape":"StandardName"}, "AnalysisSchemeLanguage":{"shape":"AnalysisSchemeLanguage"}, "AnalysisOptions":{"shape":"AnalysisOptions"} }, "documentation":"

Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms, Stopwords, StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.

" }, "AnalysisSchemeLanguage":{ "type":"string", "enum":[ "ar", "bg", "ca", "cs", "da", "de", "el", "en", "es", "eu", "fa", "fi", "fr", "ga", "gl", "he", "hi", "hu", "hy", "id", "it", "ja", "ko", "lv", "mul", "nl", "no", "pt", "ro", "ru", "sv", "th", "tr", "zh-Hans", "zh-Hant" ], "documentation":"

An IETF RFC 4646 language code or mul for multiple languages.

" }, "AnalysisSchemeStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{"shape":"AnalysisScheme"}, "Status":{"shape":"OptionStatus"} }, "documentation":"

The status and configuration of an AnalysisScheme.

" }, "AnalysisSchemeStatusList":{ "type":"list", "member":{"shape":"AnalysisSchemeStatus"}, "documentation":"

A list of the analysis schemes configured for a domain.

" }, "AvailabilityOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"MultiAZ", "documentation":"

The availability options configured for the domain.

" }, "Status":{"shape":"OptionStatus"} }, "documentation":"

The status and configuration of the domain's availability options.

" }, "BaseException":{ "type":"structure", "members":{ "Code":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"

An error occurred while processing the request.

" }, "Boolean":{"type":"boolean"}, "BuildSuggestersRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"} }, "documentation":"

Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.

" }, "BuildSuggestersResponse":{ "type":"structure", "members":{ "FieldNames":{"shape":"FieldNameList"} }, "documentation":"

The result of a BuildSuggester request. Contains a list of the fields used for suggestions.

" }, "CreateDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.

" } }, "documentation":"

Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.

" }, "CreateDomainResponse":{ "type":"structure", "members":{ "DomainStatus":{"shape":"DomainStatus"} }, "documentation":"

The result of a CreateDomainRequest. Contains the status of a newly created domain.

" }, "DateArrayOptions":{ "type":"structure", "members":{ "DefaultValue":{ "shape":"FieldValue", "documentation":"A value to use for the field if the field isn't specified for a document." }, "SourceFields":{ "shape":"FieldNameCommaList", "documentation":"

A list of source fields to map to the field.

" }, "FacetEnabled":{ "shape":"Boolean", "documentation":"

Whether facet information can be returned for the field.

" }, "SearchEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field are searchable.

" }, "ReturnEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field can be returned in the search results.

" } }, "documentation":"

Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

" }, "DateOptions":{ "type":"structure", "members":{ "DefaultValue":{ "shape":"FieldValue", "documentation":"A value to use for the field if the field isn't specified for a document." }, "SourceField":{"shape":"FieldName"}, "FacetEnabled":{ "shape":"Boolean", "documentation":"

Whether facet information can be returned for the field.

" }, "SearchEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field are searchable.

" }, "ReturnEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field can be returned in the search results.

" }, "SortEnabled":{ "shape":"Boolean", "documentation":"

Whether the field can be used to sort the search results.

" } }, "documentation":"

Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

" }, "DefineAnalysisSchemeRequest":{ "type":"structure", "required":[ "DomainName", "AnalysisScheme" ], "members":{ "DomainName":{"shape":"DomainName"}, "AnalysisScheme":{"shape":"AnalysisScheme"} }, "documentation":"

Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.

" }, "DefineAnalysisSchemeResponse":{ "type":"structure", "required":["AnalysisScheme"], "members":{ "AnalysisScheme":{"shape":"AnalysisSchemeStatus"} }, "documentation":"

The result of a DefineAnalysisScheme request. Contains the status of the newly-configured analysis scheme.

" }, "DefineExpressionRequest":{ "type":"structure", "required":[ "DomainName", "Expression" ], "members":{ "DomainName":{"shape":"DomainName"}, "Expression":{"shape":"Expression"} }, "documentation":"

Container for the parameters to the DefineExpression operation. Specifies the name of the domain you want to update and the expression you want to configure.

" }, "DefineExpressionResponse":{ "type":"structure", "required":["Expression"], "members":{ "Expression":{"shape":"ExpressionStatus"} }, "documentation":"

The result of a DefineExpression request. Contains the status of the newly-configured expression.

" }, "DefineIndexFieldRequest":{ "type":"structure", "required":[ "DomainName", "IndexField" ], "members":{ "DomainName":{"shape":"DomainName"}, "IndexField":{ "shape":"IndexField", "documentation":"

The index field and field options you want to configure.

" } }, "documentation":"

Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.

" }, "DefineIndexFieldResponse":{ "type":"structure", "required":["IndexField"], "members":{ "IndexField":{"shape":"IndexFieldStatus"} }, "documentation":"

The result of a DefineIndexField request. Contains the status of the newly-configured index field.

" }, "DefineSuggesterRequest":{ "type":"structure", "required":[ "DomainName", "Suggester" ], "members":{ "DomainName":{"shape":"DomainName"}, "Suggester":{"shape":"Suggester"} }, "documentation":"

Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.

" }, "DefineSuggesterResponse":{ "type":"structure", "required":["Suggester"], "members":{ "Suggester":{"shape":"SuggesterStatus"} }, "documentation":"

The result of a DefineSuggester request. Contains the status of the newly-configured suggester.

" }, "DeleteAnalysisSchemeRequest":{ "type":"structure", "required":[ "DomainName", "AnalysisSchemeName" ], "members":{ "DomainName":{"shape":"DomainName"}, "AnalysisSchemeName":{ "shape":"StandardName", "documentation":"

The name of the analysis scheme you want to delete.

" } }, "documentation":"

Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.

" }, "DeleteAnalysisSchemeResponse":{ "type":"structure", "required":["AnalysisScheme"], "members":{ "AnalysisScheme":{ "shape":"AnalysisSchemeStatus", "documentation":"

The status of the analysis scheme being deleted.

" } }, "documentation":"

The result of a DeleteAnalysisScheme request. Contains the status of the deleted analysis scheme.

" }, "DeleteDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain you want to permanently delete.

" } }, "documentation":"

Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.

" }, "DeleteDomainResponse":{ "type":"structure", "members":{ "DomainStatus":{"shape":"DomainStatus"} }, "documentation":"

The result of a DeleteDomain request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

" }, "DeleteExpressionRequest":{ "type":"structure", "required":[ "DomainName", "ExpressionName" ], "members":{ "DomainName":{"shape":"DomainName"}, "ExpressionName":{ "shape":"StandardName", "documentation":"

The name of the Expression to delete.

" } }, "documentation":"

Container for the parameters to the DeleteExpression operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.

" }, "DeleteExpressionResponse":{ "type":"structure", "required":["Expression"], "members":{ "Expression":{ "shape":"ExpressionStatus", "documentation":"

The status of the expression being deleted.

" } }, "documentation":"

The result of a DeleteExpression request. Specifies the expression being deleted.

" }, "DeleteIndexFieldRequest":{ "type":"structure", "required":[ "DomainName", "IndexFieldName" ], "members":{ "DomainName":{"shape":"DomainName"}, "IndexFieldName":{ "shape":"DynamicFieldName", "documentation":"

The name of the index field your want to remove from the domain's indexing options.

" } }, "documentation":"

Container for the parameters to the DeleteIndexField operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.

" }, "DeleteIndexFieldResponse":{ "type":"structure", "required":["IndexField"], "members":{ "IndexField":{ "shape":"IndexFieldStatus", "documentation":"

The status of the index field being deleted.

" } }, "documentation":"

The result of a DeleteIndexField request.

" }, "DeleteSuggesterRequest":{ "type":"structure", "required":[ "DomainName", "SuggesterName" ], "members":{ "DomainName":{"shape":"DomainName"}, "SuggesterName":{ "shape":"StandardName", "documentation":"

Specifies the name of the suggester you want to delete.

" } }, "documentation":"

Container for the parameters to the DeleteSuggester operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.

" }, "DeleteSuggesterResponse":{ "type":"structure", "required":["Suggester"], "members":{ "Suggester":{ "shape":"SuggesterStatus", "documentation":"

The status of the suggester being deleted.

" } }, "documentation":"

The result of a DeleteSuggester request. Contains the status of the deleted suggester.

" }, "DescribeAnalysisSchemesRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain you want to describe.

" }, "AnalysisSchemeNames":{ "shape":"StandardNameList", "documentation":"

The analysis schemes you want to describe.

" }, "Deployed":{ "shape":"Boolean", "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" } }, "documentation":"

Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" }, "DescribeAnalysisSchemesResponse":{ "type":"structure", "required":["AnalysisSchemes"], "members":{ "AnalysisSchemes":{ "shape":"AnalysisSchemeStatusList", "documentation":"

The analysis scheme descriptions.

" } }, "documentation":"

The result of a DescribeAnalysisSchemes request. Contains the analysis schemes configured for the domain specified in the request.

" }, "DescribeAvailabilityOptionsRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain you want to describe.

" }, "Deployed":{ "shape":"Boolean", "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" } }, "documentation":"

Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" }, "DescribeAvailabilityOptionsResponse":{ "type":"structure", "members":{ "AvailabilityOptions":{ "shape":"AvailabilityOptionsStatus", "documentation":"

The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.

" } }, "documentation":"

The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

" }, "DescribeDomainsRequest":{ "type":"structure", "members":{ "DomainNames":{ "shape":"DomainNameList", "documentation":"

The names of the domains you want to include in the response.

" } }, "documentation":"

Container for the parameters to the DescribeDomains operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.

" }, "DescribeDomainsResponse":{ "type":"structure", "required":["DomainStatusList"], "members":{ "DomainStatusList":{"shape":"DomainStatusList"} }, "documentation":"

The result of a DescribeDomains request. Contains the status of the domains specified in the request or all domains owned by the account.

" }, "DescribeExpressionsRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain you want to describe.

" }, "ExpressionNames":{ "shape":"StandardNameList", "documentation":"

Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.

" }, "Deployed":{ "shape":"Boolean", "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" } }, "documentation":"

Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" }, "DescribeExpressionsResponse":{ "type":"structure", "required":["Expressions"], "members":{ "Expressions":{ "shape":"ExpressionStatusList", "documentation":"

The expressions configured for the domain.

" } }, "documentation":"

The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request.

" }, "DescribeIndexFieldsRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain you want to describe.

" }, "FieldNames":{ "shape":"DynamicFieldNameList", "documentation":"

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

" }, "Deployed":{ "shape":"Boolean", "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" } }, "documentation":"

Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" }, "DescribeIndexFieldsResponse":{ "type":"structure", "required":["IndexFields"], "members":{ "IndexFields":{ "shape":"IndexFieldStatusList", "documentation":"

The index fields configured for the domain.

" } }, "documentation":"

The result of a DescribeIndexFields request. Contains the index fields configured for the domain specified in the request.

" }, "DescribeScalingParametersRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"} }, "documentation":"

Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.

" }, "DescribeScalingParametersResponse":{ "type":"structure", "required":["ScalingParameters"], "members":{ "ScalingParameters":{"shape":"ScalingParametersStatus"} }, "documentation":"

The result of a DescribeScalingParameters request. Contains the scaling parameters configured for the domain specified in the request.

" }, "DescribeServiceAccessPoliciesRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain you want to describe.

" }, "Deployed":{ "shape":"Boolean", "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" } }, "documentation":"

Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" }, "DescribeServiceAccessPoliciesResponse":{ "type":"structure", "required":["AccessPolicies"], "members":{ "AccessPolicies":{ "shape":"AccessPoliciesStatus", "documentation":"

The access rules configured for the domain specified in the request.

" } }, "documentation":"

The result of a DescribeServiceAccessPolicies request.

" }, "DescribeSuggestersRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain you want to describe.

" }, "SuggesterNames":{ "shape":"StandardNameList", "documentation":"

The suggesters you want to describe.

" }, "Deployed":{ "shape":"Boolean", "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" } }, "documentation":"

Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" }, "DescribeSuggestersResponse":{ "type":"structure", "required":["Suggesters"], "members":{ "Suggesters":{ "shape":"SuggesterStatusList", "documentation":"

The suggesters configured for the domain specified in the request.

" } }, "documentation":"

The result of a DescribeSuggesters request.

" }, "DisabledOperationException":{ "type":"structure", "members":{ }, "error":{ "code":"DisabledAction", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" }, "DocumentSuggesterOptions":{ "type":"structure", "required":["SourceField"], "members":{ "SourceField":{ "shape":"FieldName", "documentation":"

The name of the index field you want to use for suggestions.

" }, "FuzzyMatching":{ "shape":"SuggesterFuzzyMatching", "documentation":"

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

" }, "SortExpression":{ "shape":"String", "documentation":"

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

" } }, "documentation":"

Options for a search suggester.

" }, "DomainId":{ "type":"string", "min":1, "max":64, "documentation":"

An internally generated unique identifier for a domain.

" }, "DomainName":{ "type":"string", "min":3, "max":28, "pattern":"[a-z][a-z0-9\\-]+", "documentation":"

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

" }, "DomainNameList":{ "type":"list", "member":{"shape":"DomainName"}, "documentation":"

A list of domain names.

" }, "DomainNameMap":{ "type":"map", "key":{"shape":"DomainName"}, "value":{"shape":"APIVersion"}, "documentation":"

A collection of domain names.

" }, "DomainStatus":{ "type":"structure", "required":[ "DomainId", "DomainName", "RequiresIndexDocuments" ], "members":{ "DomainId":{"shape":"DomainId"}, "DomainName":{"shape":"DomainName"}, "ARN":{"shape":"ARN"}, "Created":{ "shape":"Boolean", "documentation":"

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.

" }, "Deleted":{ "shape":"Boolean", "documentation":"

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.

" }, "DocService":{ "shape":"ServiceEndpoint", "documentation":"

The service endpoint for updating documents in a search domain.

" }, "SearchService":{ "shape":"ServiceEndpoint", "documentation":"

The service endpoint for requesting search results from a search domain.

" }, "RequiresIndexDocuments":{ "shape":"Boolean", "documentation":"

True if IndexDocuments needs to be called to activate the current domain configuration.

" }, "Processing":{ "shape":"Boolean", "documentation":"

True if processing is being done to activate the current domain configuration.

" }, "SearchInstanceType":{ "shape":"SearchInstanceType", "documentation":"

The instance type that is being used to process search requests.

" }, "SearchPartitionCount":{ "shape":"PartitionCount", "documentation":"

The number of partitions across which the search index is spread.

" }, "SearchInstanceCount":{ "shape":"InstanceCount", "documentation":"

The number of search instances that are available to process search requests.

" }, "Limits":{"shape":"Limits"} }, "documentation":"

The current status of the search domain.

" }, "DomainStatusList":{ "type":"list", "member":{"shape":"DomainStatus"}, "documentation":"

A list that contains the status of each requested domain.

" }, "Double":{"type":"double"}, "DoubleArrayOptions":{ "type":"structure", "members":{ "DefaultValue":{ "shape":"Double", "documentation":"A value to use for the field if the field isn't specified for a document." }, "SourceFields":{ "shape":"FieldNameCommaList", "documentation":"

A list of source fields to map to the field.

" }, "FacetEnabled":{ "shape":"Boolean", "documentation":"

Whether facet information can be returned for the field.

" }, "SearchEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field are searchable.

" }, "ReturnEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field can be returned in the search results.

" } }, "documentation":"

Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

" }, "DoubleOptions":{ "type":"structure", "members":{ "DefaultValue":{ "shape":"Double", "documentation":"

A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

" }, "SourceField":{ "shape":"FieldName", "documentation":"

The name of the source field to map to the field.

" }, "FacetEnabled":{ "shape":"Boolean", "documentation":"

Whether facet information can be returned for the field.

" }, "SearchEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field are searchable.

" }, "ReturnEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field can be returned in the search results.

" }, "SortEnabled":{ "shape":"Boolean", "documentation":"

Whether the field can be used to sort the search results.

" } }, "documentation":"

Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

" }, "DynamicFieldName":{ "type":"string", "min":1, "max":64, "pattern":"([a-z][a-z0-9_]*\\*?|\\*[a-z0-9_]*)" }, "DynamicFieldNameList":{ "type":"list", "member":{"shape":"DynamicFieldName"} }, "ErrorCode":{ "type":"string", "documentation":"

A machine-parsable string error or warning code.

" }, "ErrorMessage":{ "type":"string", "documentation":"

A human-readable string error or warning message.

" }, "Expression":{ "type":"structure", "required":[ "ExpressionName", "ExpressionValue" ], "members":{ "ExpressionName":{"shape":"StandardName"}, "ExpressionValue":{"shape":"ExpressionValue"} }, "documentation":"

A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.

" }, "ExpressionStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"Expression", "documentation":"

The expression that is evaluated for sorting while processing a search request.

" }, "Status":{"shape":"OptionStatus"} }, "documentation":"

The value of an Expression and its current status.

" }, "ExpressionStatusList":{ "type":"list", "member":{"shape":"ExpressionStatus"}, "documentation":"

Contains the status of multiple expressions.

" }, "ExpressionValue":{ "type":"string", "min":1, "max":10240, "documentation":"

The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

" }, "FieldName":{ "type":"string", "min":1, "max":64, "pattern":"[a-z][a-z0-9_]*", "documentation":"

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

" }, "FieldNameCommaList":{ "type":"string", "pattern":"\\s*[a-z*][a-z0-9_]*\\*?\\s*(,\\s*[a-z*][a-z0-9_]*\\*?\\s*)*" }, "FieldNameList":{ "type":"list", "member":{"shape":"FieldName"}, "documentation":"

A list of field names.

" }, "FieldValue":{ "type":"string", "min":0, "max":1024, "documentation":"

The value of a field attribute.

" }, "IndexDocumentsRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"} }, "documentation":"

Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.

" }, "IndexDocumentsResponse":{ "type":"structure", "members":{ "FieldNames":{ "shape":"FieldNameList", "documentation":"

The names of the fields that are currently being indexed.

" } }, "documentation":"

The result of an IndexDocuments request. Contains the status of the indexing operation, including the fields being indexed.

" }, "IndexField":{ "type":"structure", "required":[ "IndexFieldName", "IndexFieldType" ], "members":{ "IndexFieldName":{ "shape":"DynamicFieldName", "documentation":"

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

" }, "IndexFieldType":{"shape":"IndexFieldType"}, "IntOptions":{"shape":"IntOptions"}, "DoubleOptions":{"shape":"DoubleOptions"}, "LiteralOptions":{"shape":"LiteralOptions"}, "TextOptions":{"shape":"TextOptions"}, "DateOptions":{"shape":"DateOptions"}, "LatLonOptions":{"shape":"LatLonOptions"}, "IntArrayOptions":{"shape":"IntArrayOptions"}, "DoubleArrayOptions":{"shape":"DoubleArrayOptions"}, "LiteralArrayOptions":{"shape":"LiteralArrayOptions"}, "TextArrayOptions":{"shape":"TextArrayOptions"}, "DateArrayOptions":{"shape":"DateArrayOptions"} }, "documentation":"

Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType.

" }, "IndexFieldStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{"shape":"IndexField"}, "Status":{"shape":"OptionStatus"} }, "documentation":"

The value of an IndexField and its current status.

" }, "IndexFieldStatusList":{ "type":"list", "member":{"shape":"IndexFieldStatus"}, "documentation":"

Contains the status of multiple index fields.

" }, "IndexFieldType":{ "type":"string", "enum":[ "int", "double", "literal", "text", "date", "latlon", "int-array", "double-array", "literal-array", "text-array", "date-array" ], "documentation":"

The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

" }, "InstanceCount":{ "type":"integer", "min":1 }, "IntArrayOptions":{ "type":"structure", "members":{ "DefaultValue":{ "shape":"Long", "documentation":"A value to use for the field if the field isn't specified for a document." }, "SourceFields":{ "shape":"FieldNameCommaList", "documentation":"

A list of source fields to map to the field.

" }, "FacetEnabled":{ "shape":"Boolean", "documentation":"

Whether facet information can be returned for the field.

" }, "SearchEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field are searchable.

" }, "ReturnEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field can be returned in the search results.

" } }, "documentation":"

Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.

" }, "IntOptions":{ "type":"structure", "members":{ "DefaultValue":{ "shape":"Long", "documentation":"A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document." }, "SourceField":{ "shape":"FieldName", "documentation":"

The name of the source field to map to the field.

" }, "FacetEnabled":{ "shape":"Boolean", "documentation":"

Whether facet information can be returned for the field.

" }, "SearchEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field are searchable.

" }, "ReturnEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field can be returned in the search results.

" }, "SortEnabled":{ "shape":"Boolean", "documentation":"

Whether the field can be used to sort the search results.

" } }, "documentation":"

Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

" }, "InternalException":{ "type":"structure", "members":{ }, "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, "InvalidTypeException":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, "LatLonOptions":{ "type":"structure", "members":{ "DefaultValue":{ "shape":"FieldValue", "documentation":"A value to use for the field if the field isn't specified for a document." }, "SourceField":{"shape":"FieldName"}, "FacetEnabled":{ "shape":"Boolean", "documentation":"

Whether facet information can be returned for the field.

" }, "SearchEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field are searchable.

" }, "ReturnEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field can be returned in the search results.

" }, "SortEnabled":{ "shape":"Boolean", "documentation":"

Whether the field can be used to sort the search results.

" } }, "documentation":"

Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

" }, "LimitExceededException":{ "type":"structure", "members":{ }, "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, "Limits":{ "type":"structure", "required":[ "MaximumReplicationCount", "MaximumPartitionCount" ], "members":{ "MaximumReplicationCount":{"shape":"MaximumReplicationCount"}, "MaximumPartitionCount":{"shape":"MaximumPartitionCount"} } }, "ListDomainNamesResponse":{ "type":"structure", "members":{ "DomainNames":{ "shape":"DomainNameMap", "documentation":"

The names of the search domains owned by an account.

" } }, "documentation":"

The result of a ListDomainNames request. Contains a list of the domains owned by an account.

" }, "LiteralArrayOptions":{ "type":"structure", "members":{ "DefaultValue":{ "shape":"FieldValue", "documentation":"A value to use for the field if the field isn't specified for a document." }, "SourceFields":{ "shape":"FieldNameCommaList", "documentation":"

A list of source fields to map to the field.

" }, "FacetEnabled":{ "shape":"Boolean", "documentation":"

Whether facet information can be returned for the field.

" }, "SearchEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field are searchable.

" }, "ReturnEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field can be returned in the search results.

" } }, "documentation":"

Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

" }, "LiteralOptions":{ "type":"structure", "members":{ "DefaultValue":{ "shape":"FieldValue", "documentation":"A value to use for the field if the field isn't specified for a document." }, "SourceField":{"shape":"FieldName"}, "FacetEnabled":{ "shape":"Boolean", "documentation":"

Whether facet information can be returned for the field.

" }, "SearchEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field are searchable.

" }, "ReturnEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field can be returned in the search results.

" }, "SortEnabled":{ "shape":"Boolean", "documentation":"

Whether the field can be used to sort the search results.

" } }, "documentation":"

Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

" }, "Long":{"type":"long"}, "MaximumPartitionCount":{ "type":"integer", "min":1 }, "MaximumReplicationCount":{ "type":"integer", "min":1 }, "MultiAZ":{"type":"boolean"}, "OptionState":{ "type":"string", "enum":[ "RequiresIndexDocuments", "Processing", "Active", "FailedToValidate" ], "documentation":"

The state of processing a change to an option. One of:

  • RequiresIndexDocuments: The option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
  • Processing: The option's latest value is in the process of being activated.
  • Active: The option's latest value is fully deployed.
  • FailedToValidate: The option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
" }, "OptionStatus":{ "type":"structure", "required":[ "CreationDate", "UpdateDate", "State" ], "members":{ "CreationDate":{ "shape":"UpdateTimestamp", "documentation":"

A timestamp for when this option was created.

" }, "UpdateDate":{ "shape":"UpdateTimestamp", "documentation":"

A timestamp for when this option was last updated.

" }, "UpdateVersion":{ "shape":"UIntValue", "documentation":"

A unique integer that indicates when this option was last updated.

" }, "State":{ "shape":"OptionState", "documentation":"

The state of processing a change to an option. Possible values:

  • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
  • Processing: the option's latest value is in the process of being activated.
  • Active: the option's latest value is completely deployed.
  • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
" }, "PendingDeletion":{ "shape":"Boolean", "documentation":"

Indicates that the option will be deleted once processing is complete.

" } }, "documentation":"

The status of domain configuration option.

" }, "PartitionCount":{ "type":"integer", "min":1, "documentation":"

The number of partitions used to hold the domain's index.

" }, "PartitionInstanceType":{ "type":"string", "enum":[ "search.m1.small", "search.m1.large", "search.m2.xlarge", "search.m2.2xlarge", "search.m3.medium", "search.m3.large", "search.m3.xlarge", "search.m3.2xlarge" ], "documentation":"

The instance type (such as search.m1.small) on which an index partition is hosted.

" }, "PolicyDocument":{ "type":"string", "documentation":"

Access rules for a domain's document or search service endpoints. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide. The maximum size of a policy document is 100 KB.

" }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" }, "ScalingParameters":{ "type":"structure", "members":{ "DesiredInstanceType":{ "shape":"PartitionInstanceType", "documentation":"

The instance type that you want to preconfigure for your domain. For example, search.m1.small.

" }, "DesiredReplicationCount":{ "shape":"UIntValue", "documentation":"

The number of replicas you want to preconfigure for each index partition.

" }, "DesiredPartitionCount":{ "shape":"UIntValue", "documentation":"

The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.

" } }, "documentation":"

The desired instance type and desired number of replicas of each index partition.

" }, "ScalingParametersStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{"shape":"ScalingParameters"}, "Status":{"shape":"OptionStatus"} }, "documentation":"

The status and configuration of a search domain's scaling parameters.

" }, "SearchInstanceType":{ "type":"string", "documentation":"

The instance type (such as search.m1.small) that is being used to process search requests.

" }, "ServiceEndpoint":{ "type":"structure", "members":{ "Endpoint":{"shape":"ServiceUrl"} }, "documentation":"

The endpoint to which service requests can be submitted.

" }, "ServiceUrl":{ "type":"string", "documentation":"

The endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.

" }, "StandardName":{ "type":"string", "min":1, "max":64, "pattern":"[a-z][a-z0-9_]*", "documentation":"

Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

" }, "StandardNameList":{ "type":"list", "member":{"shape":"StandardName"} }, "String":{"type":"string"}, "Suggester":{ "type":"structure", "required":[ "SuggesterName", "DocumentSuggesterOptions" ], "members":{ "SuggesterName":{"shape":"StandardName"}, "DocumentSuggesterOptions":{"shape":"DocumentSuggesterOptions"} }, "documentation":"

Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.

" }, "SuggesterFuzzyMatching":{ "type":"string", "enum":[ "none", "low", "high" ] }, "SuggesterStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{"shape":"Suggester"}, "Status":{"shape":"OptionStatus"} }, "documentation":"

The value of a Suggester and its current status.

" }, "SuggesterStatusList":{ "type":"list", "member":{"shape":"SuggesterStatus"}, "documentation":"

Contains the status of multiple suggesters.

" }, "TextArrayOptions":{ "type":"structure", "members":{ "DefaultValue":{ "shape":"FieldValue", "documentation":"A value to use for the field if the field isn't specified for a document." }, "SourceFields":{ "shape":"FieldNameCommaList", "documentation":"

A list of source fields to map to the field.

" }, "ReturnEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field can be returned in the search results.

" }, "HighlightEnabled":{ "shape":"Boolean", "documentation":"

Whether highlights can be returned for the field.

" }, "AnalysisScheme":{ "shape":"Word", "documentation":"

The name of an analysis scheme for a text-array field.

" } }, "documentation":"

Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

" }, "TextOptions":{ "type":"structure", "members":{ "DefaultValue":{ "shape":"FieldValue", "documentation":"A value to use for the field if the field isn't specified for a document." }, "SourceField":{"shape":"FieldName"}, "ReturnEnabled":{ "shape":"Boolean", "documentation":"

Whether the contents of the field can be returned in the search results.

" }, "SortEnabled":{ "shape":"Boolean", "documentation":"

Whether the field can be used to sort the search results.

" }, "HighlightEnabled":{ "shape":"Boolean", "documentation":"

Whether highlights can be returned for the field.

" }, "AnalysisScheme":{ "shape":"Word", "documentation":"

The name of an analysis scheme for a text field.

" } }, "documentation":"

Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

" }, "UIntValue":{ "type":"integer", "min":0 }, "UpdateAvailabilityOptionsRequest":{ "type":"structure", "required":[ "DomainName", "MultiAZ" ], "members":{ "DomainName":{"shape":"DomainName"}, "MultiAZ":{ "shape":"Boolean", "documentation":"

You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

" } }, "documentation":"

Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

" }, "UpdateAvailabilityOptionsResponse":{ "type":"structure", "members":{ "AvailabilityOptions":{ "shape":"AvailabilityOptionsStatus", "documentation":"

The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.

" } }, "documentation":"

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

" }, "UpdateScalingParametersRequest":{ "type":"structure", "required":[ "DomainName", "ScalingParameters" ], "members":{ "DomainName":{"shape":"DomainName"}, "ScalingParameters":{"shape":"ScalingParameters"} }, "documentation":"

Container for the parameters to the UpdateScalingParameters operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.

" }, "UpdateScalingParametersResponse":{ "type":"structure", "required":["ScalingParameters"], "members":{ "ScalingParameters":{"shape":"ScalingParametersStatus"} }, "documentation":"

The result of a UpdateScalingParameters request. Contains the status of the newly-configured scaling parameters.

" }, "UpdateServiceAccessPoliciesRequest":{ "type":"structure", "required":[ "DomainName", "AccessPolicies" ], "members":{ "DomainName":{"shape":"DomainName"}, "AccessPolicies":{ "shape":"PolicyDocument", "documentation":"

The access rules you want to configure. These rules replace any existing rules.

" } }, "documentation":"

Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies the name of the domain you want to update and the access rules you want to configure.

" }, "UpdateServiceAccessPoliciesResponse":{ "type":"structure", "required":["AccessPolicies"], "members":{ "AccessPolicies":{ "shape":"AccessPoliciesStatus", "documentation":"

The access rules configured for the domain.

" } }, "documentation":"

The result of an UpdateServiceAccessPolicies request. Contains the new access policies.

" }, "UpdateTimestamp":{"type":"timestamp"}, "Word":{ "type":"string", "pattern":"[\\S]+" } } } botocore-1.5.7/botocore/data/cloudsearch/2011-02-01/0000777454262600001440000000000013042511307022447 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudsearch/2011-02-01/service-2.json0000666454262600001440000024543013042511306025150 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2011-02-01", "endpointPrefix":"cloudsearch", "serviceFullName":"Amazon CloudSearch", "signatureVersion":"v4", "xmlNamespace":"http://cloudsearch.amazonaws.com/doc/2011-02-01/", "protocol":"query" }, "documentation":"Amazon CloudSearch Configuration Service

You use the configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

", "operations":{ "CreateDomain":{ "name":"CreateDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDomainRequest"}, "output":{ "shape":"CreateDomainResponse", "documentation":"

A response message that contains the status of a newly created domain.

", "resultWrapper":"CreateDomainResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" } ], "documentation":"

Creates a new search domain.

" }, "DefineIndexField":{ "name":"DefineIndexField", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DefineIndexFieldRequest"}, "output":{ "shape":"DefineIndexFieldResponse", "documentation":"

A response message that contains the status of an updated index field.

", "resultWrapper":"DefineIndexFieldResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

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.

" }, "DefineRankExpression":{ "name":"DefineRankExpression", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DefineRankExpressionRequest"}, "output":{ "shape":"DefineRankExpressionResponse", "documentation":"

A response message that contains the status of an updated RankExpression.

", "resultWrapper":"DefineRankExpressionResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

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.

" }, "DeleteDomain":{ "name":"DeleteDomain", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDomainRequest"}, "output":{ "shape":"DeleteDomainResponse", "documentation":"

A response message that contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

", "resultWrapper":"DeleteDomainResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" } ], "documentation":"

Permanently deletes a search domain and all of its data.

" }, "DeleteIndexField":{ "name":"DeleteIndexField", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteIndexFieldRequest"}, "output":{ "shape":"DeleteIndexFieldResponse", "documentation":"

A response message that contains the status of a deleted index field.

", "resultWrapper":"DeleteIndexFieldResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Removes an IndexField from the search domain.

" }, "DeleteRankExpression":{ "name":"DeleteRankExpression", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRankExpressionRequest"}, "output":{ "shape":"DeleteRankExpressionResponse", "documentation":"

A response message that contains the status of a deleted RankExpression.

", "resultWrapper":"DeleteRankExpressionResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Removes a RankExpression from the search domain.

" }, "DescribeAvailabilityOptions":{ "name":"DescribeAvailabilityOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeAvailabilityOptionsRequest", "documentation":"

Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" }, "output":{ "shape":"DescribeAvailabilityOptionsResponse", "documentation":"

The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

", "resultWrapper":"DescribeAvailabilityOptionsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" }, { "shape":"DisabledOperationException", "error":{ "code":"DisabledAction", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" } ], "documentation":"

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

" }, "DescribeDefaultSearchField":{ "name":"DescribeDefaultSearchField", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDefaultSearchFieldRequest"}, "output":{ "shape":"DescribeDefaultSearchFieldResponse", "documentation":"

A response message that contains the default search field for a search domain.

", "resultWrapper":"DescribeDefaultSearchFieldResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Gets the default search field configured for the search domain.

" }, "DescribeDomains":{ "name":"DescribeDomains", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDomainsRequest"}, "output":{ "shape":"DescribeDomainsResponse", "documentation":"

A response message that contains the status of one or more domains.

", "resultWrapper":"DescribeDomainsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" } ], "documentation":"

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.

" }, "DescribeIndexFields":{ "name":"DescribeIndexFields", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeIndexFieldsRequest"}, "output":{ "shape":"DescribeIndexFieldsResponse", "documentation":"

A response message that contains the index fields for a search domain.

", "resultWrapper":"DescribeIndexFieldsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default.

" }, "DescribeRankExpressions":{ "name":"DescribeRankExpressions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRankExpressionsRequest"}, "output":{ "shape":"DescribeRankExpressionsResponse", "documentation":"

A response message that contains the rank expressions for a search domain.

", "resultWrapper":"DescribeRankExpressionsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default.

" }, "DescribeServiceAccessPolicies":{ "name":"DescribeServiceAccessPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeServiceAccessPoliciesRequest"}, "output":{ "shape":"DescribeServiceAccessPoliciesResponse", "documentation":"

A response message that contains the access policies for a domain.

", "resultWrapper":"DescribeServiceAccessPoliciesResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Gets information about the resource-based policies that control access to the domain's document and search services.

" }, "DescribeStemmingOptions":{ "name":"DescribeStemmingOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStemmingOptionsRequest"}, "output":{ "shape":"DescribeStemmingOptionsResponse", "documentation":"

A response message that contains the stemming options for a search domain.

", "resultWrapper":"DescribeStemmingOptionsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Gets the stemming dictionary configured for the search domain.

" }, "DescribeStopwordOptions":{ "name":"DescribeStopwordOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStopwordOptionsRequest"}, "output":{ "shape":"DescribeStopwordOptionsResponse", "documentation":"

A response message that contains the stopword options for a search domain.

", "resultWrapper":"DescribeStopwordOptionsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Gets the stopwords configured for the search domain.

" }, "DescribeSynonymOptions":{ "name":"DescribeSynonymOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSynonymOptionsRequest"}, "output":{ "shape":"DescribeSynonymOptionsResponse", "documentation":"

A response message that contains the synonym options for a search domain.

", "resultWrapper":"DescribeSynonymOptionsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Gets the synonym dictionary configured for the search domain.

" }, "IndexDocuments":{ "name":"IndexDocuments", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"IndexDocumentsRequest"}, "output":{ "shape":"IndexDocumentsResponse", "documentation":"

The result of an IndexDocuments action.

", "resultWrapper":"IndexDocumentsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

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.

" }, "UpdateAvailabilityOptions":{ "name":"UpdateAvailabilityOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"UpdateAvailabilityOptionsRequest", "documentation":"

Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

" }, "output":{ "shape":"UpdateAvailabilityOptionsResponse", "documentation":"

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

", "resultWrapper":"UpdateAvailabilityOptionsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" }, { "shape":"DisabledOperationException", "error":{ "code":"DisabledAction", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" } ], "documentation":"

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

" }, "UpdateDefaultSearchField":{ "name":"UpdateDefaultSearchField", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDefaultSearchFieldRequest"}, "output":{ "shape":"UpdateDefaultSearchFieldResponse", "documentation":"

A response message that contains the status of an updated default search field.

", "resultWrapper":"UpdateDefaultSearchFieldResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

Configures the default search field for the search domain. The default search field is the text field that is searched 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.

" }, "UpdateServiceAccessPolicies":{ "name":"UpdateServiceAccessPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateServiceAccessPoliciesRequest"}, "output":{ "shape":"UpdateServiceAccessPoliciesResponse", "documentation":"

A response message that contains the status of updated access policies.

", "resultWrapper":"UpdateServiceAccessPoliciesResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" } ], "documentation":"

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.

" }, "UpdateStemmingOptions":{ "name":"UpdateStemmingOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateStemmingOptionsRequest"}, "output":{ "shape":"UpdateStemmingOptionsResponse", "documentation":"

A response message that contains the status of updated stemming options.

", "resultWrapper":"UpdateStemmingOptionsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

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.

" }, "UpdateStopwordOptions":{ "name":"UpdateStopwordOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateStopwordOptionsRequest"}, "output":{ "shape":"UpdateStopwordOptionsResponse", "documentation":"

A response message that contains the status of updated stopword options.

", "resultWrapper":"UpdateStopwordOptionsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

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.

" }, "UpdateSynonymOptions":{ "name":"UpdateSynonymOptions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateSynonymOptionsRequest"}, "output":{ "shape":"UpdateSynonymOptionsResponse", "documentation":"

A response message that contains the status of updated synonym options.

", "resultWrapper":"UpdateSynonymOptionsResult" }, "errors":[ { "shape":"BaseException", "exception":true, "documentation":"

An error occurred while processing the request.

" }, { "shape":"InternalException", "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, { "shape":"InvalidTypeException", "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, { "shape":"LimitExceededException", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, { "shape":"ResourceNotFoundException", "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" } ], "documentation":"

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.

" } }, "shapes":{ "AccessPoliciesStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{"shape":"PolicyDocument"}, "Status":{"shape":"OptionStatus"} }, "documentation":"

A PolicyDocument that specifies access policies for the search domain's services, and the current status of those policies.

" }, "Arn":{ "type":"string", "documentation":"

An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

" }, "AvailabilityOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"MultiAZ", "documentation":"

The availability options configured for the domain.

" }, "Status":{"shape":"OptionStatus"} }, "documentation":"

The status and configuration of the domain's availability options.

" }, "BaseException":{ "type":"structure", "members":{ "Code":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "exception":true, "documentation":"

An error occurred while processing the request.

" }, "Boolean":{"type":"boolean"}, "CreateDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"} } }, "CreateDomainResponse":{ "type":"structure", "members":{ "DomainStatus":{"shape":"DomainStatus"} }, "documentation":"

A response message that contains the status of a newly created domain.

" }, "DefaultSearchFieldStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"FieldName", "documentation":"

The name of the IndexField to use as the default search field. The default is an empty string, which automatically searches all text fields.

" }, "Status":{"shape":"OptionStatus"} }, "documentation":"

The value of the DefaultSearchField configured for this search domain and its current status.

" }, "DefineIndexFieldRequest":{ "type":"structure", "required":[ "DomainName", "IndexField" ], "members":{ "DomainName":{"shape":"DomainName"}, "IndexField":{"shape":"IndexField"} } }, "DefineIndexFieldResponse":{ "type":"structure", "required":["IndexField"], "members":{ "IndexField":{"shape":"IndexFieldStatus"} }, "documentation":"

A response message that contains the status of an updated index field.

" }, "DefineRankExpressionRequest":{ "type":"structure", "required":[ "DomainName", "RankExpression" ], "members":{ "DomainName":{"shape":"DomainName"}, "RankExpression":{"shape":"NamedRankExpression"} } }, "DefineRankExpressionResponse":{ "type":"structure", "required":["RankExpression"], "members":{ "RankExpression":{"shape":"RankExpressionStatus"} }, "documentation":"

A response message that contains the status of an updated RankExpression.

" }, "DeleteDomainRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"} } }, "DeleteDomainResponse":{ "type":"structure", "members":{ "DomainStatus":{"shape":"DomainStatus"} }, "documentation":"

A response message that contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

" }, "DeleteIndexFieldRequest":{ "type":"structure", "required":[ "DomainName", "IndexFieldName" ], "members":{ "DomainName":{"shape":"DomainName"}, "IndexFieldName":{"shape":"FieldName"} } }, "DeleteIndexFieldResponse":{ "type":"structure", "required":["IndexField"], "members":{ "IndexField":{"shape":"IndexFieldStatus"} }, "documentation":"

A response message that contains the status of a deleted index field.

" }, "DeleteRankExpressionRequest":{ "type":"structure", "required":[ "DomainName", "RankName" ], "members":{ "DomainName":{"shape":"DomainName"}, "RankName":{ "shape":"FieldName", "documentation":"

The name of the RankExpression to delete.

" } } }, "DeleteRankExpressionResponse":{ "type":"structure", "required":["RankExpression"], "members":{ "RankExpression":{"shape":"RankExpressionStatus"} }, "documentation":"

A response message that contains the status of a deleted RankExpression.

" }, "DescribeAvailabilityOptionsRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{ "shape":"DomainName", "documentation":"

The name of the domain you want to describe.

" } }, "documentation":"

Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" }, "DescribeAvailabilityOptionsResponse":{ "type":"structure", "members":{ "AvailabilityOptions":{ "shape":"AvailabilityOptionsStatus", "documentation":"

The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.

" } }, "documentation":"

The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

" }, "DescribeDefaultSearchFieldRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"} } }, "DescribeDefaultSearchFieldResponse":{ "type":"structure", "required":["DefaultSearchField"], "members":{ "DefaultSearchField":{ "shape":"DefaultSearchFieldStatus", "documentation":"

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.

" } }, "documentation":"

A response message that contains the default search field for a search domain.

" }, "DescribeDomainsRequest":{ "type":"structure", "members":{ "DomainNames":{ "shape":"DomainNameList", "documentation":"

Limits the DescribeDomains response to the specified search domains.

" } } }, "DescribeDomainsResponse":{ "type":"structure", "required":["DomainStatusList"], "members":{ "DomainStatusList":{"shape":"DomainStatusList"} }, "documentation":"

A response message that contains the status of one or more domains.

" }, "DescribeIndexFieldsRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"}, "FieldNames":{ "shape":"FieldNameList", "documentation":"

Limits the DescribeIndexFields response to the specified fields.

" } } }, "DescribeIndexFieldsResponse":{ "type":"structure", "required":["IndexFields"], "members":{ "IndexFields":{ "shape":"IndexFieldStatusList", "documentation":"

The index fields configured for the domain.

" } }, "documentation":"

A response message that contains the index fields for a search domain.

" }, "DescribeRankExpressionsRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"}, "RankNames":{ "shape":"FieldNameList", "documentation":"

Limits the DescribeRankExpressions response to the specified fields.

" } } }, "DescribeRankExpressionsResponse":{ "type":"structure", "required":["RankExpressions"], "members":{ "RankExpressions":{ "shape":"RankExpressionStatusList", "documentation":"

The rank expressions configured for the domain.

" } }, "documentation":"

A response message that contains the rank expressions for a search domain.

" }, "DescribeServiceAccessPoliciesRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"} } }, "DescribeServiceAccessPoliciesResponse":{ "type":"structure", "required":["AccessPolicies"], "members":{ "AccessPolicies":{"shape":"AccessPoliciesStatus"} }, "documentation":"

A response message that contains the access policies for a domain.

" }, "DescribeStemmingOptionsRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"} } }, "DescribeStemmingOptionsResponse":{ "type":"structure", "required":["Stems"], "members":{ "Stems":{"shape":"StemmingOptionsStatus"} }, "documentation":"

A response message that contains the stemming options for a search domain.

" }, "DescribeStopwordOptionsRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"} } }, "DescribeStopwordOptionsResponse":{ "type":"structure", "required":["Stopwords"], "members":{ "Stopwords":{"shape":"StopwordOptionsStatus"} }, "documentation":"

A response message that contains the stopword options for a search domain.

" }, "DescribeSynonymOptionsRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"} } }, "DescribeSynonymOptionsResponse":{ "type":"structure", "required":["Synonyms"], "members":{ "Synonyms":{"shape":"SynonymOptionsStatus"} }, "documentation":"

A response message that contains the synonym options for a search domain.

" }, "DisabledOperationException":{ "type":"structure", "members":{ }, "error":{ "code":"DisabledAction", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" }, "DocumentCount":{ "type":"long", "min":0 }, "DomainId":{ "type":"string", "min":1, "max":64, "documentation":"

An internally generated unique identifier for a domain.

" }, "DomainName":{ "type":"string", "min":3, "max":28, "pattern":"[a-z][a-z0-9\\-]+", "documentation":"

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.

" }, "DomainNameList":{ "type":"list", "member":{"shape":"DomainName"}, "documentation":"

A list of domain names.

" }, "DomainStatus":{ "type":"structure", "required":[ "DomainId", "DomainName", "RequiresIndexDocuments" ], "members":{ "DomainId":{"shape":"DomainId"}, "DomainName":{"shape":"DomainName"}, "Created":{ "shape":"Boolean", "documentation":"

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.

" }, "Deleted":{ "shape":"Boolean", "documentation":"

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.

" }, "NumSearchableDocs":{ "shape":"DocumentCount", "documentation":"

The number of documents that have been submitted to the domain and indexed.

" }, "DocService":{ "shape":"ServiceEndpoint", "documentation":"

The service endpoint for updating documents in a search domain.

" }, "SearchService":{ "shape":"ServiceEndpoint", "documentation":"

The service endpoint for requesting search results from a search domain.

" }, "RequiresIndexDocuments":{ "shape":"Boolean", "documentation":"

True if IndexDocuments needs to be called to activate the current domain configuration.

" }, "Processing":{ "shape":"Boolean", "documentation":"

True if processing is being done to activate the current domain configuration.

" }, "SearchInstanceType":{ "shape":"SearchInstanceType", "documentation":"

The instance type (such as search.m1.small) that is being used to process search requests.

" }, "SearchPartitionCount":{ "shape":"PartitionCount", "documentation":"

The number of partitions across which the search index is spread.

" }, "SearchInstanceCount":{ "shape":"InstanceCount", "documentation":"

The number of search instances that are available to process search requests.

" } }, "documentation":"

The current status of the search domain.

" }, "DomainStatusList":{ "type":"list", "member":{"shape":"DomainStatus"}, "documentation":"

The current status of all of your search domains.

" }, "ErrorCode":{ "type":"string", "documentation":"

A machine-parsable string error or warning code.

" }, "ErrorMessage":{ "type":"string", "documentation":"

A human-readable string error or warning message.

" }, "FieldName":{ "type":"string", "min":1, "max":64, "pattern":"[a-z][a-z0-9_]*", "documentation":"

A string that represents the name of an index field. Field 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.

" }, "FieldNameList":{ "type":"list", "member":{"shape":"FieldName"} }, "FieldValue":{ "type":"string", "min":0, "max":1024, "documentation":"

The value of a field or source document attribute.

" }, "IndexDocumentsRequest":{ "type":"structure", "required":["DomainName"], "members":{ "DomainName":{"shape":"DomainName"} } }, "IndexDocumentsResponse":{ "type":"structure", "members":{ "FieldNames":{ "shape":"FieldNameList", "documentation":"

The names of the fields that are currently being processed due to an IndexDocuments action.

" } }, "documentation":"

The result of an IndexDocuments action.

" }, "IndexField":{ "type":"structure", "required":[ "IndexFieldName", "IndexFieldType" ], "members":{ "IndexFieldName":{ "shape":"FieldName", "documentation":"

The name of a field in the search index. Field 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.

" }, "IndexFieldType":{ "shape":"IndexFieldType", "documentation":"

The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

" }, "UIntOptions":{ "shape":"UIntOptions", "documentation":"

Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.

" }, "LiteralOptions":{ "shape":"LiteralOptions", "documentation":"

Options for literal field. Present if IndexFieldType specifies the field is of type literal.

" }, "TextOptions":{ "shape":"TextOptions", "documentation":"

Options for text field. Present if IndexFieldType specifies the field is of type text.

" }, "SourceAttributes":{ "shape":"SourceAttributeList", "documentation":"

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.

" } }, "documentation":"

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.

" }, "IndexFieldStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{"shape":"IndexField"}, "Status":{"shape":"OptionStatus"} }, "documentation":"

The value of an IndexField and its current status.

" }, "IndexFieldStatusList":{ "type":"list", "member":{"shape":"IndexFieldStatus"} }, "IndexFieldType":{ "type":"string", "enum":[ "uint", "literal", "text" ], "documentation":"

The type of IndexField.

" }, "InstanceCount":{ "type":"integer", "min":1 }, "InternalException":{ "type":"structure", "members":{ }, "error":{ "code":"InternalException", "httpStatusCode":500 }, "exception":true, "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" }, "InvalidTypeException":{ "type":"structure", "members":{ }, "error":{ "code":"InvalidType", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it specified an invalid type definition.

" }, "Language":{ "type":"string", "pattern":"[a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*", "documentation":"

An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

" }, "LimitExceededException":{ "type":"structure", "members":{ }, "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because a resource limit has already been met.

" }, "LiteralOptions":{ "type":"structure", "members":{ "DefaultValue":{ "shape":"FieldValue", "documentation":"

The default value for a literal field. Optional.

" }, "SearchEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether search is enabled for this field. Default: False.

" }, "FacetEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether facets are enabled for this field. Default: False.

" }, "ResultEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

" } }, "documentation":"

Options that define a literal field in the search index.

" }, "MultiAZ":{"type":"boolean"}, "NamedRankExpression":{ "type":"structure", "required":[ "RankName", "RankExpression" ], "members":{ "RankName":{ "shape":"FieldName", "documentation":"

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.

" }, "RankExpression":{ "shape":"RankExpression", "documentation":"

The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

  • Integer, floating point, hex and octal literals
  • Shortcut evaluation of logical operators such that an expression a || b evaluates to the value a, if a is true, without evaluating b at all
  • JavaScript order of precedence for operators
  • Arithmetic operators: + - * / %
  • Boolean operators (including the ternary operator)
  • Bitwise operators
  • Comparison operators
  • Common mathematic functions: abs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow
  • Trigonometric library functions: acosh acos asinh asin atanh atan cosh cos sinh sin tanh tan
  • Random generation of a number between 0 and 1: rand
  • Current time in epoch: time
  • The min max functions that operate on a variable argument list

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.

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.

For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.

" } }, "documentation":"

A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.

" }, "OptionState":{ "type":"string", "enum":[ "RequiresIndexDocuments", "Processing", "Active" ], "documentation":"

The state of processing a change to an option.

" }, "OptionStatus":{ "type":"structure", "required":[ "CreationDate", "UpdateDate", "State" ], "members":{ "CreationDate":{ "shape":"UpdateTimestamp", "documentation":"

A timestamp for when this option was created.

" }, "UpdateDate":{ "shape":"UpdateTimestamp", "documentation":"

A timestamp for when this option was last updated.

" }, "UpdateVersion":{ "shape":"UIntValue", "documentation":"

A unique integer that indicates when this option was last updated.

" }, "State":{ "shape":"OptionState", "documentation":"

The state of processing a change to an option. Possible values:

  • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
  • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
  • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
" }, "PendingDeletion":{ "shape":"Boolean", "documentation":"

Indicates that the option will be deleted once processing is complete.

" } }, "documentation":"

The status of an option, including when it was last updated and whether it is actively in use for searches.

" }, "PartitionCount":{ "type":"integer", "min":1 }, "PolicyDocument":{ "type":"string", "documentation":"

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.

Example: {\"Statement\": [{\"Effect\":\"Allow\", \"Action\": \"*\", \"Resource\": \"arn:aws:cs:us-east-1:1234567890:search/movies\", \"Condition\": { \"IpAddress\": { \"aws:SourceIp\": [\"203.0.113.1/32\"] } }}, {\"Effect\":\"Allow\", \"Action\": \"*\", \"Resource\": \"arn:aws:cs:us-east-1:1234567890:documents/movies\", \"Condition\": { \"IpAddress\": { \"aws:SourceIp\": [\"203.0.113.1/32\"] } }} ] }

" }, "RankExpression":{ "type":"string", "min":1, "max":10240, "documentation":"

The current status of the rank expression.

" }, "RankExpressionStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{ "shape":"NamedRankExpression", "documentation":"

The expression that is evaluated for ranking or thresholding while processing a search request.

" }, "Status":{"shape":"OptionStatus"} }, "documentation":"

The value of a RankExpression and its current status.

" }, "RankExpressionStatusList":{ "type":"list", "member":{"shape":"RankExpressionStatus"} }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "error":{ "code":"ResourceNotFound", "httpStatusCode":409, "senderFault":true }, "exception":true, "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" }, "SearchInstanceType":{"type":"string"}, "ServiceEndpoint":{ "type":"structure", "members":{ "Arn":{"shape":"Arn"}, "Endpoint":{"shape":"ServiceUrl"} }, "documentation":"

The endpoint to which service requests can be submitted, including the actual URL prefix for sending requests and the Amazon Resource Name (ARN) so the endpoint can be referenced in other API calls such as UpdateServiceAccessPolicies.

" }, "ServiceUrl":{ "type":"string", "documentation":"

The URL (including /version/pathPrefix) to which service requests can be submitted.

" }, "SourceAttribute":{ "type":"structure", "required":["SourceDataFunction"], "members":{ "SourceDataFunction":{ "shape":"SourceDataFunction", "documentation":"

Identifies the transformation to apply when copying data from a source attribute.

" }, "SourceDataCopy":{ "shape":"SourceData", "documentation":"

Copies data from a source document attribute to an IndexField.

" }, "SourceDataTrimTitle":{ "shape":"SourceDataTrimTitle", "documentation":"

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.

" }, "SourceDataMap":{ "shape":"SourceDataMap", "documentation":"

Maps source document attribute values to new values when populating the IndexField.

" } }, "documentation":"

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.

" }, "SourceAttributeList":{ "type":"list", "member":{"shape":"SourceAttribute"} }, "SourceData":{ "type":"structure", "required":["SourceName"], "members":{ "SourceName":{ "shape":"FieldName", "documentation":"

The name of the document source field to add to this IndexField.

" }, "DefaultValue":{ "shape":"FieldValue", "documentation":"

The default value to use if the source attribute is not specified in a document. Optional.

" } }, "documentation":"

The source attribute name and an optional default value to use if a document doesn't have an attribute of that name.

" }, "SourceDataFunction":{ "type":"string", "enum":[ "Copy", "TrimTitle", "Map" ] }, "SourceDataMap":{ "type":"structure", "required":["SourceName"], "members":{ "SourceName":{ "shape":"FieldName", "documentation":"

The name of the document source field to add to this IndexField.

" }, "DefaultValue":{ "shape":"FieldValue", "documentation":"

The default value to use if the source attribute is not specified in a document. Optional.

" }, "Cases":{ "shape":"StringCaseMap", "documentation":"

A map that translates source field values to custom values.

" } }, "documentation":"

Specifies how to map source attribute values to custom values when populating an IndexField.

" }, "SourceDataTrimTitle":{ "type":"structure", "required":["SourceName"], "members":{ "SourceName":{ "shape":"FieldName", "documentation":"

The name of the document source field to add to this IndexField.

" }, "DefaultValue":{ "shape":"FieldValue", "documentation":"

The default value to use if the source attribute is not specified in a document. Optional.

" }, "Separator":{ "shape":"String", "documentation":"

The separator that follows the text to trim.

" }, "Language":{"shape":"Language"} }, "documentation":"

Specifies how to trim common words from the beginning of a field to enable title sorting by that field.

" }, "StemmingOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{"shape":"StemsDocument"}, "Status":{"shape":"OptionStatus"} }, "documentation":"

The stemming options configured for this search domain and the current status of those options.

" }, "StemsDocument":{ "type":"string", "documentation":"

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\"} }

" }, "StopwordOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{"shape":"StopwordsDocument"}, "Status":{"shape":"OptionStatus"} }, "documentation":"

The stopword options configured for this search domain and the current status of those options.

" }, "StopwordsDocument":{ "type":"string", "documentation":"

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\"] }

" }, "String":{"type":"string"}, "StringCaseMap":{ "type":"map", "key":{"shape":"FieldValue"}, "value":{"shape":"FieldValue"} }, "SynonymOptionsStatus":{ "type":"structure", "required":[ "Options", "Status" ], "members":{ "Options":{"shape":"SynonymsDocument"}, "Status":{"shape":"OptionStatus"} }, "documentation":"

The synonym options configured for this search domain and the current status of those options.

" }, "SynonymsDocument":{ "type":"string", "documentation":"

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\"} }

" }, "TextOptions":{ "type":"structure", "members":{ "DefaultValue":{ "shape":"FieldValue", "documentation":"

The default value for a text field. Optional.

" }, "FacetEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether facets are enabled for this field. Default: False.

" }, "ResultEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

" }, "TextProcessor":{ "shape":"FieldName", "documentation":"

The text processor to apply to this field. Optional. Possible values:

  • cs_text_no_stemming: turns off stemming for the field.

Default: none

" } }, "documentation":"

Options that define a text field in the search index.

" }, "UIntOptions":{ "type":"structure", "members":{ "DefaultValue":{ "shape":"UIntValue", "documentation":"

The default value for an unsigned integer field. Optional.

" } }, "documentation":"

Options that define a uint field in the search index.

" }, "UIntValue":{ "type":"integer", "min":0 }, "UpdateAvailabilityOptionsRequest":{ "type":"structure", "required":[ "DomainName", "MultiAZ" ], "members":{ "DomainName":{"shape":"DomainName"}, "MultiAZ":{ "shape":"Boolean", "documentation":"

You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

" } }, "documentation":"

Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

" }, "UpdateAvailabilityOptionsResponse":{ "type":"structure", "members":{ "AvailabilityOptions":{ "shape":"AvailabilityOptionsStatus", "documentation":"

The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.

" } }, "documentation":"

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

" }, "UpdateDefaultSearchFieldRequest":{ "type":"structure", "required":[ "DomainName", "DefaultSearchField" ], "members":{ "DomainName":{"shape":"DomainName"}, "DefaultSearchField":{ "shape":"String", "documentation":"

The text field to search if the search request does not specify which field to search. The default search field is used when search terms are specified with the q parameter, or if a match expression specified with the bq parameter does not constrain the search to a particular field. The default is an empty string, which automatically searches all text fields.

" } } }, "UpdateDefaultSearchFieldResponse":{ "type":"structure", "required":["DefaultSearchField"], "members":{ "DefaultSearchField":{"shape":"DefaultSearchFieldStatus"} }, "documentation":"

A response message that contains the status of an updated default search field.

" }, "UpdateServiceAccessPoliciesRequest":{ "type":"structure", "required":[ "DomainName", "AccessPolicies" ], "members":{ "DomainName":{"shape":"DomainName"}, "AccessPolicies":{"shape":"PolicyDocument"} } }, "UpdateServiceAccessPoliciesResponse":{ "type":"structure", "required":["AccessPolicies"], "members":{ "AccessPolicies":{"shape":"AccessPoliciesStatus"} }, "documentation":"

A response message that contains the status of updated access policies.

" }, "UpdateStemmingOptionsRequest":{ "type":"structure", "required":[ "DomainName", "Stems" ], "members":{ "DomainName":{"shape":"DomainName"}, "Stems":{"shape":"StemsDocument"} } }, "UpdateStemmingOptionsResponse":{ "type":"structure", "required":["Stems"], "members":{ "Stems":{"shape":"StemmingOptionsStatus"} }, "documentation":"

A response message that contains the status of updated stemming options.

" }, "UpdateStopwordOptionsRequest":{ "type":"structure", "required":[ "DomainName", "Stopwords" ], "members":{ "DomainName":{"shape":"DomainName"}, "Stopwords":{"shape":"StopwordsDocument"} } }, "UpdateStopwordOptionsResponse":{ "type":"structure", "required":["Stopwords"], "members":{ "Stopwords":{"shape":"StopwordOptionsStatus"} }, "documentation":"

A response message that contains the status of updated stopword options.

" }, "UpdateSynonymOptionsRequest":{ "type":"structure", "required":[ "DomainName", "Synonyms" ], "members":{ "DomainName":{"shape":"DomainName"}, "Synonyms":{"shape":"SynonymsDocument"} } }, "UpdateSynonymOptionsResponse":{ "type":"structure", "required":["Synonyms"], "members":{ "Synonyms":{"shape":"SynonymOptionsStatus"} }, "documentation":"

A response message that contains the status of updated synonym options.

" }, "UpdateTimestamp":{"type":"timestamp"} }, "examples":{ } } botocore-1.5.7/botocore/data/kinesisanalytics/0000777454262600001440000000000013042511307022510 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/kinesisanalytics/2015-08-14/0000777454262600001440000000000013042511307023546 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/kinesisanalytics/2015-08-14/service-2.json0000666454262600001440000022602113042511306026242 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"kinesisanalytics-2015-08-14", "apiVersion":"2015-08-14", "endpointPrefix":"kinesisanalytics", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"Kinesis Analytics", "serviceFullName":"Amazon Kinesis Analytics", "signatureVersion":"v4", "targetPrefix":"KinesisAnalytics_20150814", "timestampFormat":"unixTimestamp" }, "operations":{ "AddApplicationInput":{ "name":"AddApplicationInput", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddApplicationInputRequest"}, "output":{"shape":"AddApplicationInputResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidArgumentException"}, {"shape":"ConcurrentModificationException"} ], "documentation":"

Adds a streaming source to your Amazon Kinesis application. For conceptual information, see Configuring Application Input.

You can add a streaming source either when you create an application or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication.

Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.

This operation requires permissions to perform the kinesisanalytics:AddApplicationInput action.

" }, "AddApplicationOutput":{ "name":"AddApplicationOutput", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddApplicationOutputRequest"}, "output":{"shape":"AddApplicationOutputResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidArgumentException"}, {"shape":"ConcurrentModificationException"} ], "documentation":"

Adds an external destination to your Amazon Kinesis Analytics application.

If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream or a Firehose delivery stream), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.

You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For conceptual information, see Understanding Application Output (Destination).

Note that any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.

For the limits on the number of application inputs and outputs you can configure, see Limits.

This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

" }, "AddApplicationReferenceDataSource":{ "name":"AddApplicationReferenceDataSource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddApplicationReferenceDataSourceRequest"}, "output":{"shape":"AddApplicationReferenceDataSourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidArgumentException"}, {"shape":"ConcurrentModificationException"} ], "documentation":"

Adds a reference data source to an existing application.

Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.

For conceptual information, see Configuring Application Input. For the limits on data sources you can add to your application, see Limits.

This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

" }, "CreateApplication":{ "name":"CreateApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateApplicationRequest"}, "output":{"shape":"CreateApplicationResponse"}, "errors":[ {"shape":"CodeValidationException"}, {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidArgumentException"} ], "documentation":"

Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to five streaming destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works.

In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source, with the option of renaming, casting and dropping columns as desired.

Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps.

In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to five streaming destinations.

To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action.

For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started.

" }, "DeleteApplication":{ "name":"DeleteApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteApplicationRequest"}, "output":{"shape":"DeleteApplicationResponse"}, "errors":[ {"shape":"ConcurrentModificationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code).

This operation requires permissions to perform the kinesisanalytics:DeleteApplication action.

" }, "DeleteApplicationOutput":{ "name":"DeleteApplicationOutput", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteApplicationOutputRequest"}, "output":{"shape":"DeleteApplicationOutputResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"ConcurrentModificationException"} ], "documentation":"

Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination.

This operation requires permissions to perform the kinesisanalytics:DeleteApplicationOutput action.

" }, "DeleteApplicationReferenceDataSource":{ "name":"DeleteApplicationReferenceDataSource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteApplicationReferenceDataSourceRequest"}, "output":{"shape":"DeleteApplicationReferenceDataSourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidArgumentException"}, {"shape":"ConcurrentModificationException"} ], "documentation":"

Deletes a reference data source configuration from the specified application configuration.

If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.

This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource action.

" }, "DescribeApplication":{ "name":"DescribeApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeApplicationRequest"}, "output":{"shape":"DescribeApplicationResponse"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns information about a specific Amazon Kinesis Analytics application.

If you want to retrieve a list of all applications in your account, use the ListApplications operation.

This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update.

" }, "DiscoverInputSchema":{ "name":"DiscoverInputSchema", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DiscoverInputSchemaRequest"}, "output":{"shape":"DiscoverInputSchemaResponse"}, "errors":[ {"shape":"InvalidArgumentException"}, {"shape":"UnableToDetectSchemaException"}, {"shape":"ResourceProvisionedThroughputExceededException"} ], "documentation":"

Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream). In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.

You can use the inferred schema when configuring a streaming source for your application. For conceptual information, see Configuring Application Input. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface.

This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema action.

" }, "ListApplications":{ "name":"ListApplications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListApplicationsRequest"}, "output":{"shape":"ListApplicationsResponse"}, "documentation":"

Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response.

If you want detailed information about a specific application, use DescribeApplication.

This operation requires permissions to perform the kinesisanalytics:ListApplications action.

" }, "StartApplication":{ "name":"StartApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartApplicationRequest"}, "output":{"shape":"StartApplicationResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidArgumentException"}, {"shape":"InvalidApplicationConfigurationException"} ], "documentation":"

Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively call this operation to start your application.

After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination.

The application status must be READY for you to start an application. You can get the application status in the console or using the DescribeApplication operation.

After you start the application, you can stop the application from processing the input by calling the StopApplication operation.

This operation requires permissions to perform the kinesisanalytics:StartApplication action.

" }, "StopApplication":{ "name":"StopApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopApplicationRequest"}, "output":{"shape":"StopApplicationResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], "documentation":"

Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination.

This operation requires permissions to perform the kinesisanalytics:StopApplication action.

" }, "UpdateApplication":{ "name":"UpdateApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateApplicationRequest"}, "output":{"shape":"UpdateApplicationResponse"}, "errors":[ {"shape":"CodeValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidArgumentException"}, {"shape":"ConcurrentModificationException"} ], "documentation":"

Updates an existing Kinesis Analytics application. Using this API, you can update application code, input configuration, and output configuration.

Note that Kinesis Analytics updates the CurrentApplicationVersionId each time you update your application.

This opeation requires permission for the kinesisanalytics:UpdateApplication action.

" } }, "shapes":{ "AddApplicationInputRequest":{ "type":"structure", "required":[ "ApplicationName", "CurrentApplicationVersionId", "Input" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source.

" }, "CurrentApplicationVersionId":{ "shape":"ApplicationVersionId", "documentation":"

Current version of your Amazon Kinesis Analytics application. You can use the DescribeApplication operation to find the current application version.

" }, "Input":{"shape":"Input"} }, "documentation":"

" }, "AddApplicationInputResponse":{ "type":"structure", "members":{ }, "documentation":"

" }, "AddApplicationOutputRequest":{ "type":"structure", "required":[ "ApplicationName", "CurrentApplicationVersionId", "Output" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

Name of the application to which you want to add the output configuration.

" }, "CurrentApplicationVersionId":{ "shape":"ApplicationVersionId", "documentation":"

Version of the application to which you want add the output configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

" }, "Output":{ "shape":"Output", "documentation":"

An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream), and record the formation to use when writing to the destination.

" } }, "documentation":"

" }, "AddApplicationOutputResponse":{ "type":"structure", "members":{ }, "documentation":"

" }, "AddApplicationReferenceDataSourceRequest":{ "type":"structure", "required":[ "ApplicationName", "CurrentApplicationVersionId", "ReferenceDataSource" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

Name of an existing application.

" }, "CurrentApplicationVersionId":{ "shape":"ApplicationVersionId", "documentation":"

Version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

" }, "ReferenceDataSource":{ "shape":"ReferenceDataSource", "documentation":"

The reference data source can be an object in your Amazon S3 bucket. Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.

" } }, "documentation":"

" }, "AddApplicationReferenceDataSourceResponse":{ "type":"structure", "members":{ }, "documentation":"

" }, "ApplicationCode":{ "type":"string", "max":51200, "min":0 }, "ApplicationDescription":{ "type":"string", "max":1024, "min":0 }, "ApplicationDetail":{ "type":"structure", "required":[ "ApplicationName", "ApplicationARN", "ApplicationStatus", "ApplicationVersionId" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

Name of the application.

" }, "ApplicationDescription":{ "shape":"ApplicationDescription", "documentation":"

Description of the application.

" }, "ApplicationARN":{ "shape":"ResourceARN", "documentation":"

ARN of the application.

" }, "ApplicationStatus":{ "shape":"ApplicationStatus", "documentation":"

Status of the application.

" }, "CreateTimestamp":{ "shape":"Timestamp", "documentation":"

Timestamp when the application version was created.

" }, "LastUpdateTimestamp":{ "shape":"Timestamp", "documentation":"

Timestamp when the application was last updated.

" }, "InputDescriptions":{ "shape":"InputDescriptions", "documentation":"

Describes the application input configuration. For more information, see Configuring Application Input.

" }, "OutputDescriptions":{ "shape":"OutputDescriptions", "documentation":"

Describes the application output configuration. For more information, see Configuring Application Output.

" }, "ReferenceDataSourceDescriptions":{ "shape":"ReferenceDataSourceDescriptions", "documentation":"

Describes reference data sources configured for the application. For more information, see Configuring Application Input.

" }, "ApplicationCode":{ "shape":"ApplicationCode", "documentation":"

Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.

" }, "ApplicationVersionId":{ "shape":"ApplicationVersionId", "documentation":"

Provides the current application version.

" } }, "documentation":"

Provides a description of the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configuration.

" }, "ApplicationName":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z0-9_.-]+" }, "ApplicationStatus":{ "type":"string", "enum":[ "DELETING", "STARTING", "STOPPING", "READY", "RUNNING", "UPDATING" ] }, "ApplicationSummaries":{ "type":"list", "member":{"shape":"ApplicationSummary"} }, "ApplicationSummary":{ "type":"structure", "required":[ "ApplicationName", "ApplicationARN", "ApplicationStatus" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

Name of the application.

" }, "ApplicationARN":{ "shape":"ResourceARN", "documentation":"

ARN of the application.

" }, "ApplicationStatus":{ "shape":"ApplicationStatus", "documentation":"

Status of the application.

" } }, "documentation":"

Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.

" }, "ApplicationUpdate":{ "type":"structure", "members":{ "InputUpdates":{ "shape":"InputUpdates", "documentation":"

Describes application input configuration updates.

" }, "ApplicationCodeUpdate":{ "shape":"ApplicationCode", "documentation":"

Describes application code updates.

" }, "OutputUpdates":{ "shape":"OutputUpdates", "documentation":"

Describes application output configuration updates.

" }, "ReferenceDataSourceUpdates":{ "shape":"ReferenceDataSourceUpdates", "documentation":"

Describes application reference data source updates.

" } }, "documentation":"

Describes updates to apply to an existing Kinesis Analytics application.

" }, "ApplicationVersionId":{ "type":"long", "max":999999999, "min":1 }, "BooleanObject":{"type":"boolean"}, "BucketARN":{ "type":"string", "max":2048, "min":1, "pattern":"arn:.*" }, "CSVMappingParameters":{ "type":"structure", "required":[ "RecordRowDelimiter", "RecordColumnDelimiter" ], "members":{ "RecordRowDelimiter":{ "shape":"RecordRowDelimiter", "documentation":"

Row delimiter. For example, in a CSV format, '\\n' is the typical row delimiter.

" }, "RecordColumnDelimiter":{ "shape":"RecordColumnDelimiter", "documentation":"

Column delimiter. For example, in a CSV format, a comma (\",\") is the typical column delimiter.

" } }, "documentation":"

Provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the '\\n' as the row delimiter and a comma (\",\") as the column delimiter:

\"name1\", \"address1\"

\"name2, \"address2\"

" }, "CodeValidationException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Test

" } }, "documentation":"

User-provided application code (query) is invalid. This can be a simple syntax error.

", "exception":true }, "ConcurrentModificationException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

" } }, "documentation":"

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

", "exception":true }, "CreateApplicationRequest":{ "type":"structure", "required":["ApplicationName"], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

Name of your Amazon Kinesis Analytics application (for example, sample-app).

" }, "ApplicationDescription":{ "shape":"ApplicationDescription", "documentation":"

Summary description of the application.

" }, "Inputs":{ "shape":"Inputs", "documentation":"

Use this parameter to configure the application input.

You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).

For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf.

To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.

" }, "Outputs":{ "shape":"Outputs", "documentation":"

You can configure application output to write data from any of the in-application streams to up to five destinations.

These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, or both.

In the configuration, you specify the in-application stream name, the destination stream Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf.

In the output configuration, you also provide the output stream Amazon Resource Name (ARN) and the format of data in the stream (for example, JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can assume to write to this stream on your behalf.

" }, "ApplicationCode":{ "shape":"ApplicationCode", "documentation":"

One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads input data and generates a running average of the number of advertisement clicks by vendor.

You can also provide a series of SQL statements, where output of one statement can be used as the input for the next statement.

Note that the application code must create the streams with names specified in the Outputs. For example, if your Outputs defines output streams named ExampleOutputStream1 and ExampleOutputStream2, then your application code must create these streams.

" } }, "documentation":"

TBD

" }, "CreateApplicationResponse":{ "type":"structure", "required":["ApplicationSummary"], "members":{ "ApplicationSummary":{ "shape":"ApplicationSummary", "documentation":"

In response to your CreateApplication request, Amazon Kinesis Analytics returns a response with a summary of the application it created, including the application Amazon Resource Name (ARN), name, and status.

" } }, "documentation":"

TBD

" }, "DeleteApplicationOutputRequest":{ "type":"structure", "required":[ "ApplicationName", "CurrentApplicationVersionId", "OutputId" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

Amazon Kinesis Analytics application name.

" }, "CurrentApplicationVersionId":{ "shape":"ApplicationVersionId", "documentation":"

Amazon Kinesis Analytics application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

" }, "OutputId":{ "shape":"Id", "documentation":"

The ID of the configuration to delete. Each output configuration that is added to the application, either when the application is created or later using the AddApplicationOutput operation, has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the DescribeApplication operation to get the specific OutputId.

" } }, "documentation":"

" }, "DeleteApplicationOutputResponse":{ "type":"structure", "members":{ }, "documentation":"

" }, "DeleteApplicationReferenceDataSourceRequest":{ "type":"structure", "required":[ "ApplicationName", "CurrentApplicationVersionId", "ReferenceId" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

Name of an existing application.

" }, "CurrentApplicationVersionId":{ "shape":"ApplicationVersionId", "documentation":"

Version of the application. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

" }, "ReferenceId":{ "shape":"Id", "documentation":"

ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Amazon Kinesis Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID.

" } } }, "DeleteApplicationReferenceDataSourceResponse":{ "type":"structure", "members":{ } }, "DeleteApplicationRequest":{ "type":"structure", "required":[ "ApplicationName", "CreateTimestamp" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

Name of the Amazon Kinesis Analytics application to delete.

" }, "CreateTimestamp":{ "shape":"Timestamp", "documentation":"

You can use the DescribeApplication operation to get this value.

" } }, "documentation":"

" }, "DeleteApplicationResponse":{ "type":"structure", "members":{ }, "documentation":"

" }, "DescribeApplicationRequest":{ "type":"structure", "required":["ApplicationName"], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

Name of the application.

" } }, "documentation":"

" }, "DescribeApplicationResponse":{ "type":"structure", "required":["ApplicationDetail"], "members":{ "ApplicationDetail":{ "shape":"ApplicationDetail", "documentation":"

Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest version, and input and output configuration details.

" } }, "documentation":"

" }, "DestinationSchema":{ "type":"structure", "members":{ "RecordFormatType":{ "shape":"RecordFormatType", "documentation":"

Specifies the format of the records on the output stream.

" } }, "documentation":"

Describes the data format when records are written to the destination. For more information, see Configuring Application Output.

" }, "DiscoverInputSchemaRequest":{ "type":"structure", "required":[ "ResourceARN", "RoleARN", "InputStartingPositionConfiguration" ], "members":{ "ResourceARN":{ "shape":"ResourceARN", "documentation":"

Amazon Resource Name (ARN) of the streaming source.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.

" }, "InputStartingPositionConfiguration":{ "shape":"InputStartingPositionConfiguration", "documentation":"

Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes.

" } }, "documentation":"

" }, "DiscoverInputSchemaResponse":{ "type":"structure", "members":{ "InputSchema":{ "shape":"SourceSchema", "documentation":"

Schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.

" }, "ParsedInputRecords":{ "shape":"ParsedInputRecords", "documentation":"

An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).

" }, "RawInputRecords":{ "shape":"RawInputRecords", "documentation":"

Raw stream data that was sampled to infer the schema.

" } }, "documentation":"

" }, "ErrorMessage":{"type":"string"}, "FileKey":{"type":"string"}, "Id":{ "type":"string", "max":50, "min":1, "pattern":"[a-zA-Z0-9_.-]+" }, "InAppStreamName":{ "type":"string", "max":32, "min":1, "pattern":"[a-zA-Z][a-zA-Z0-9_]+" }, "InAppStreamNames":{ "type":"list", "member":{"shape":"InAppStreamName"} }, "InAppTableName":{ "type":"string", "max":32, "min":1, "pattern":"[a-zA-Z][a-zA-Z0-9_]+" }, "Input":{ "type":"structure", "required":[ "NamePrefix", "InputSchema" ], "members":{ "NamePrefix":{ "shape":"InAppStreamName", "documentation":"

Name prefix to use when creating in-application stream. Suppose you specify a prefix \"MyInApplicationStream\". Kinesis Analytics will then create one or more (as per the InputParallelism count you specified) in-application streams with names \"MyInApplicationStream_001\", \"MyInApplicationStream_002\" and so on.

" }, "KinesisStreamsInput":{ "shape":"KinesisStreamsInput", "documentation":"

If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

" }, "KinesisFirehoseInput":{ "shape":"KinesisFirehoseInput", "documentation":"

If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the Firehose delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

" }, "InputParallelism":{ "shape":"InputParallelism", "documentation":"

Describes the number of in-application streams to create.

Data from your source will be routed to these in-application input streams.

(see Configuring Application Input.

" }, "InputSchema":{ "shape":"SourceSchema", "documentation":"

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

Also used to describe the format of the reference data source.

" } }, "documentation":"

When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. For more information, see Configuring Application Input.

" }, "InputConfiguration":{ "type":"structure", "required":[ "Id", "InputStartingPositionConfiguration" ], "members":{ "Id":{ "shape":"Id", "documentation":"

Input source ID. You can get this ID by calling the DescribeApplication operation.

" }, "InputStartingPositionConfiguration":{ "shape":"InputStartingPositionConfiguration", "documentation":"

Point at which you want the application to start processing records from the streaming source.

" } }, "documentation":"

When you start your application, you provide this configuration, which identifies the input source and the point in the input source at which you want the application to start processing records.

" }, "InputConfigurations":{ "type":"list", "member":{"shape":"InputConfiguration"} }, "InputDescription":{ "type":"structure", "members":{ "InputId":{ "shape":"Id", "documentation":"

Input ID associated with the application input. This is the ID that Amazon Kinesis Analytics assigns to each input configuration you add to your application.

" }, "NamePrefix":{ "shape":"InAppStreamName", "documentation":"

In-application name prefix.

" }, "InAppStreamNames":{ "shape":"InAppStreamNames", "documentation":"

Returns the in-application stream names that are mapped to the stream source.

" }, "KinesisStreamsInputDescription":{ "shape":"KinesisStreamsInputDescription", "documentation":"

If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

" }, "KinesisFirehoseInputDescription":{ "shape":"KinesisFirehoseInputDescription", "documentation":"

If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

" }, "InputSchema":{"shape":"SourceSchema"}, "InputParallelism":{ "shape":"InputParallelism", "documentation":"

Describes the configured parallelism (number of in-application streams mapped to the streaming source).

" }, "InputStartingPositionConfiguration":{ "shape":"InputStartingPositionConfiguration", "documentation":"

Point at which the application is configured to read from the input stream.

" } }, "documentation":"

Describes the application input configuration. For more information, see Configuring Application Input.

" }, "InputDescriptions":{ "type":"list", "member":{"shape":"InputDescription"} }, "InputParallelism":{ "type":"structure", "members":{ "Count":{ "shape":"InputParallelismCount", "documentation":"

Number of in-application streams to create. For more information, see Limits.

" } }, "documentation":"

Describes the number of in-application streams to create for a given streaming source. For information about parallellism, see Configuring Application Input.

" }, "InputParallelismCount":{ "type":"integer", "max":10, "min":1 }, "InputParallelismUpdate":{ "type":"structure", "members":{ "CountUpdate":{ "shape":"InputParallelismCount", "documentation":"

Number of in-application streams to create for the specified streaming source.

" } }, "documentation":"

Provides updates to the parallelism count.

" }, "InputSchemaUpdate":{ "type":"structure", "members":{ "RecordFormatUpdate":{ "shape":"RecordFormat", "documentation":"

Specifies the format of the records on the streaming source.

" }, "RecordEncodingUpdate":{ "shape":"RecordEncoding", "documentation":"

Specifies the encoding of the records in the streaming source. For example, UTF-8.

" }, "RecordColumnUpdates":{ "shape":"RecordColumns", "documentation":"

A list of RecordColumn objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream.

" } }, "documentation":"

Describes updates for the application's input schema.

" }, "InputStartingPosition":{ "type":"string", "enum":[ "NOW", "TRIM_HORIZON", "LAST_STOPPED_POINT" ] }, "InputStartingPositionConfiguration":{ "type":"structure", "members":{ "InputStartingPosition":{ "shape":"InputStartingPosition", "documentation":"

The starting position on the stream.

  • LATEST - Start reading just after the most recent record in the stream.

  • TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Firehose delivery stream.

  • LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.

" } }, "documentation":"

Describes the point at which the application reads from the streaming source.

" }, "InputUpdate":{ "type":"structure", "required":["InputId"], "members":{ "InputId":{ "shape":"Id", "documentation":"

Input ID of the application input to be updated.

" }, "NamePrefixUpdate":{ "shape":"InAppStreamName", "documentation":"

Name prefix for in-application stream(s) that Kinesis Analytics creates for the specific streaming source.

" }, "KinesisStreamsInputUpdate":{ "shape":"KinesisStreamsInputUpdate", "documentation":"

If a Amazon Kinesis stream is the streaming source to be updated, provides an updated stream ARN and IAM role ARN.

" }, "KinesisFirehoseInputUpdate":{ "shape":"KinesisFirehoseInputUpdate", "documentation":"

If an Amazon Kinesis Firehose delivery stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN) and IAM role ARN.

" }, "InputSchemaUpdate":{ "shape":"InputSchemaUpdate", "documentation":"

Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created.

" }, "InputParallelismUpdate":{ "shape":"InputParallelismUpdate", "documentation":"

Describes the parallelism updates (the number in-application streams Kinesis Analytics creates for the specific streaming source).

" } }, "documentation":"

Describes updates to a specific input configuration (identified by the InputId of an application).

" }, "InputUpdates":{ "type":"list", "member":{"shape":"InputUpdate"} }, "Inputs":{ "type":"list", "member":{"shape":"Input"} }, "InvalidApplicationConfigurationException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

test

" } }, "documentation":"

User-provided application configuration is not valid.

", "exception":true }, "InvalidArgumentException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

" } }, "documentation":"

Specified input parameter value is invalid.

", "exception":true }, "JSONMappingParameters":{ "type":"structure", "required":["RecordRowPath"], "members":{ "RecordRowPath":{ "shape":"RecordRowPath", "documentation":"

Path to the top-level parent that contains the records.

For example, consider the following JSON record:

In the RecordRowPath, \"$\" refers to the root and path \"$.vehicle.Model\" refers to the specific \"Model\" key in the JSON.

" } }, "documentation":"

Provides additional mapping information when JSON is the record format on the streaming source.

" }, "KinesisFirehoseInput":{ "type":"structure", "required":[ "ResourceARN", "RoleARN" ], "members":{ "ResourceARN":{ "shape":"ResourceARN", "documentation":"

ARN of the input Firehose delivery stream.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to make sure the role has necessary permissions to access the stream.

" } }, "documentation":"

Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You provide the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.

" }, "KinesisFirehoseInputDescription":{ "type":"structure", "members":{ "ResourceARN":{ "shape":"ResourceARN", "documentation":"

Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream.

" } }, "documentation":"

Describes the Amazon Kinesis Firehose delivery stream that is configured as the streaming source in the application input configuration.

" }, "KinesisFirehoseInputUpdate":{ "type":"structure", "members":{ "ResourceARNUpdate":{ "shape":"ResourceARN", "documentation":"

ARN of the input Amazon Kinesis Firehose delivery stream to read.

" }, "RoleARNUpdate":{ "shape":"RoleARN", "documentation":"

Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant necessary permissions to this role.

" } }, "documentation":"

When updating application input configuration, provides information about an Amazon Kinesis Firehose delivery stream as the streaming source.

" }, "KinesisFirehoseOutput":{ "type":"structure", "required":[ "ResourceARN", "RoleARN" ], "members":{ "ResourceARN":{ "shape":"ResourceARN", "documentation":"

ARN of the destination Amazon Kinesis Firehose delivery stream to write to.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.

" } }, "documentation":"

When configuring application output, identifies an Amazon Kinesis Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to write to the stream on your behalf.

" }, "KinesisFirehoseOutputDescription":{ "type":"structure", "members":{ "ResourceARN":{ "shape":"ResourceARN", "documentation":"

Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.

" } }, "documentation":"

For an application output, describes the Amazon Kinesis Firehose delivery stream configured as its destination.

" }, "KinesisFirehoseOutputUpdate":{ "type":"structure", "members":{ "ResourceARNUpdate":{ "shape":"ResourceARN", "documentation":"

Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to write to.

" }, "RoleARNUpdate":{ "shape":"RoleARN", "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant necessary permissions to this role.

" } }, "documentation":"

When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis Firehose delivery stream configured as the destination.

" }, "KinesisStreamsInput":{ "type":"structure", "required":[ "ResourceARN", "RoleARN" ], "members":{ "ResourceARN":{ "shape":"ResourceARN", "documentation":"

ARN of the input Amazon Kinesis stream to read.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.

" } }, "documentation":"

Identifies an Amazon Kinesis stream as the streaming source. You provide the stream's ARN and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.

" }, "KinesisStreamsInputDescription":{ "type":"structure", "members":{ "ResourceARN":{ "shape":"ResourceARN", "documentation":"

Amazon Resource Name (ARN) of the Amazon Kinesis stream.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.

" } }, "documentation":"

Describes the Amazon Kinesis stream that is configured as the streaming source in the application input configuration.

" }, "KinesisStreamsInputUpdate":{ "type":"structure", "members":{ "ResourceARNUpdate":{ "shape":"ResourceARN", "documentation":"

Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read.

" }, "RoleARNUpdate":{ "shape":"RoleARN", "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.

" } }, "documentation":"

When updating application input configuration, provides information about an Amazon Kinesis stream as the streaming source.

" }, "KinesisStreamsOutput":{ "type":"structure", "required":[ "ResourceARN", "RoleARN" ], "members":{ "ResourceARN":{ "shape":"ResourceARN", "documentation":"

ARN of the destination Amazon Kinesis stream to write to.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.

" } }, "documentation":"

When configuring application output, identifies a Amazon Kinesis stream as the destination. You provide the stream Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the stream on your behalf.

" }, "KinesisStreamsOutputDescription":{ "type":"structure", "members":{ "ResourceARN":{ "shape":"ResourceARN", "documentation":"

Amazon Resource Name (ARN) of the Amazon Kinesis stream.

" }, "RoleARN":{ "shape":"RoleARN", "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.

" } }, "documentation":"

For an application output, describes the Amazon Kinesis stream configured as its destination.

" }, "KinesisStreamsOutputUpdate":{ "type":"structure", "members":{ "ResourceARNUpdate":{ "shape":"ResourceARN", "documentation":"

Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to write the output.

" }, "RoleARNUpdate":{ "shape":"RoleARN", "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.

" } }, "documentation":"

When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis stream configured as the destination.

" }, "LimitExceededException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

" } }, "documentation":"

Exceeded the number of applications allowed.

", "exception":true }, "ListApplicationsInputLimit":{ "type":"integer", "max":50, "min":1 }, "ListApplicationsRequest":{ "type":"structure", "members":{ "Limit":{ "shape":"ListApplicationsInputLimit", "documentation":"

Maximum number of applications to list.

" }, "ExclusiveStartApplicationName":{ "shape":"ApplicationName", "documentation":"

Name of the application to start the list with. When using pagination to retrieve the list, you don't need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications.

" } }, "documentation":"

" }, "ListApplicationsResponse":{ "type":"structure", "required":[ "ApplicationSummaries", "HasMoreApplications" ], "members":{ "ApplicationSummaries":{ "shape":"ApplicationSummaries", "documentation":"

List of ApplicationSummary objects.

" }, "HasMoreApplications":{ "shape":"BooleanObject", "documentation":"

Returns true if there are more applications to retrieve.

" } }, "documentation":"

" }, "MappingParameters":{ "type":"structure", "members":{ "JSONMappingParameters":{ "shape":"JSONMappingParameters", "documentation":"

Provides additional mapping information when JSON is the record format on the streaming source.

" }, "CSVMappingParameters":{ "shape":"CSVMappingParameters", "documentation":"

Provides additional mapping information when the record format uses delimiters (for example, CSV).

" } }, "documentation":"

When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

" }, "Output":{ "type":"structure", "required":[ "Name", "DestinationSchema" ], "members":{ "Name":{ "shape":"InAppStreamName", "documentation":"

Name of the in-application stream.

" }, "KinesisStreamsOutput":{ "shape":"KinesisStreamsOutput", "documentation":"

Identifies an Amazon Kinesis stream as the destination.

" }, "KinesisFirehoseOutput":{ "shape":"KinesisFirehoseOutput", "documentation":"

Identifies an Amazon Kinesis Firehose delivery stream as the destination.

" }, "DestinationSchema":{"shape":"DestinationSchema"} }, "documentation":"

Describes application output configuration in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream.

You can configure your application to write output to up to five destinations.

" }, "OutputDescription":{ "type":"structure", "members":{ "OutputId":{ "shape":"Id", "documentation":"

A unique identifier for the output configuration.

" }, "Name":{ "shape":"InAppStreamName", "documentation":"

Name of the in-application stream configured as output.

" }, "KinesisStreamsOutputDescription":{ "shape":"KinesisStreamsOutputDescription", "documentation":"

Describes Amazon Kinesis stream configured as the destination where output is written.

" }, "KinesisFirehoseOutputDescription":{ "shape":"KinesisFirehoseOutputDescription", "documentation":"

Describes the Amazon Kinesis Firehose delivery stream configured as the destination where output is written.

" }, "DestinationSchema":{ "shape":"DestinationSchema", "documentation":"

Data format used for writing data to the destination.

" } }, "documentation":"

Describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream.

" }, "OutputDescriptions":{ "type":"list", "member":{"shape":"OutputDescription"} }, "OutputUpdate":{ "type":"structure", "required":["OutputId"], "members":{ "OutputId":{ "shape":"Id", "documentation":"

Identifies the specific output configuration that you want to update.

" }, "NameUpdate":{ "shape":"InAppStreamName", "documentation":"

If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name.

" }, "KinesisStreamsOutputUpdate":{ "shape":"KinesisStreamsOutputUpdate", "documentation":"

Describes an Amazon Kinesis stream as the destination for the output.

" }, "KinesisFirehoseOutputUpdate":{ "shape":"KinesisFirehoseOutputUpdate", "documentation":"

Describes a Amazon Kinesis Firehose delivery stream as the destination for the output.

" }, "DestinationSchemaUpdate":{"shape":"DestinationSchema"} }, "documentation":"

Describes updates to the output configuration identified by the OutputId.

" }, "OutputUpdates":{ "type":"list", "member":{"shape":"OutputUpdate"} }, "Outputs":{ "type":"list", "member":{"shape":"Output"} }, "ParsedInputRecord":{ "type":"list", "member":{"shape":"ParsedInputRecordField"} }, "ParsedInputRecordField":{"type":"string"}, "ParsedInputRecords":{ "type":"list", "member":{"shape":"ParsedInputRecord"} }, "RawInputRecord":{"type":"string"}, "RawInputRecords":{ "type":"list", "member":{"shape":"RawInputRecord"} }, "RecordColumn":{ "type":"structure", "required":[ "Name", "SqlType" ], "members":{ "Name":{ "shape":"RecordColumnName", "documentation":"

Name of the column created in the in-application input stream or reference table.

" }, "Mapping":{ "shape":"RecordColumnMapping", "documentation":"

Reference to the data element in the streaming input of the reference data source.

" }, "SqlType":{ "shape":"RecordColumnSqlType", "documentation":"

Type of column created in the in-application input stream or reference table.

" } }, "documentation":"

Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.

Also used to describe the format of the reference data source.

" }, "RecordColumnDelimiter":{"type":"string"}, "RecordColumnMapping":{"type":"string"}, "RecordColumnName":{ "type":"string", "pattern":"[a-zA-Z][a-zA-Z0-9_]+" }, "RecordColumnSqlType":{"type":"string"}, "RecordColumns":{ "type":"list", "member":{"shape":"RecordColumn"}, "max":1000, "min":1 }, "RecordEncoding":{ "type":"string", "pattern":"UTF-8" }, "RecordFormat":{ "type":"structure", "required":["RecordFormatType"], "members":{ "RecordFormatType":{ "shape":"RecordFormatType", "documentation":"

The type of record format.

" }, "MappingParameters":{"shape":"MappingParameters"} }, "documentation":"

Describes the record format and relevant mapping information that should be applied to schematize the records on the stream.

" }, "RecordFormatType":{ "type":"string", "enum":[ "JSON", "CSV" ] }, "RecordRowDelimiter":{"type":"string"}, "RecordRowPath":{"type":"string"}, "ReferenceDataSource":{ "type":"structure", "required":[ "TableName", "ReferenceSchema" ], "members":{ "TableName":{ "shape":"InAppTableName", "documentation":"

Name of the in-application table to create.

" }, "S3ReferenceDataSource":{"shape":"S3ReferenceDataSource"}, "ReferenceSchema":{"shape":"SourceSchema"} }, "documentation":"

Describes the reference data source by providing the source information (S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.

" }, "ReferenceDataSourceDescription":{ "type":"structure", "required":[ "ReferenceId", "TableName", "S3ReferenceDataSourceDescription" ], "members":{ "ReferenceId":{ "shape":"Id", "documentation":"

ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation.

" }, "TableName":{ "shape":"InAppTableName", "documentation":"

The in-application table name created by the specific reference data source configuration.

" }, "S3ReferenceDataSourceDescription":{ "shape":"S3ReferenceDataSourceDescription", "documentation":"

Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.

" }, "ReferenceSchema":{"shape":"SourceSchema"} }, "documentation":"

Describes the reference data source configured for an application.

" }, "ReferenceDataSourceDescriptions":{ "type":"list", "member":{"shape":"ReferenceDataSourceDescription"} }, "ReferenceDataSourceUpdate":{ "type":"structure", "required":["ReferenceId"], "members":{ "ReferenceId":{ "shape":"Id", "documentation":"

ID of the reference data source being updated. You can use the DescribeApplication operation to get this value.

" }, "TableNameUpdate":{ "shape":"InAppTableName", "documentation":"

In-application table name that is created by this update.

" }, "S3ReferenceDataSourceUpdate":{ "shape":"S3ReferenceDataSourceUpdate", "documentation":"

Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.

" }, "ReferenceSchemaUpdate":{"shape":"SourceSchema"} }, "documentation":"

When you update a reference data source configuration for an application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created.

" }, "ReferenceDataSourceUpdates":{ "type":"list", "member":{"shape":"ReferenceDataSourceUpdate"} }, "ResourceARN":{ "type":"string", "max":2048, "min":1, "pattern":"arn:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:\\d{12}:[a-zA-Z_0-9+=,.@\\-_/:]+" }, "ResourceInUseException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

" } }, "documentation":"

Application is not available for this operation.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

" } }, "documentation":"

Specified application can't be found.

", "exception":true }, "ResourceProvisionedThroughputExceededException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"

Discovery failed to get a record from the streaming source because of the Kinesis Streams ProvisionedThroughputExceededException.

", "exception":true }, "RoleARN":{ "type":"string", "max":2048, "min":1, "pattern":"arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" }, "S3ReferenceDataSource":{ "type":"structure", "required":[ "BucketARN", "FileKey", "ReferenceRoleARN" ], "members":{ "BucketARN":{ "shape":"BucketARN", "documentation":"

Amazon Resource Name (ARN) of the S3 bucket.

" }, "FileKey":{ "shape":"FileKey", "documentation":"

Object key name containing reference data.

" }, "ReferenceRoleARN":{ "shape":"RoleARN", "documentation":"

ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.

" } }, "documentation":"

Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf.

An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

" }, "S3ReferenceDataSourceDescription":{ "type":"structure", "required":[ "BucketARN", "FileKey", "ReferenceRoleARN" ], "members":{ "BucketARN":{ "shape":"BucketARN", "documentation":"

Amazon Resource Name (ARN) of the S3 bucket.

" }, "FileKey":{ "shape":"FileKey", "documentation":"

Amazon S3 object key name.

" }, "ReferenceRoleARN":{ "shape":"RoleARN", "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.

" } }, "documentation":"

Provides the bucket name and object key name that stores the reference data.

" }, "S3ReferenceDataSourceUpdate":{ "type":"structure", "members":{ "BucketARNUpdate":{ "shape":"BucketARN", "documentation":"

Amazon Resource Name (ARN) of the S3 bucket.

" }, "FileKeyUpdate":{ "shape":"FileKey", "documentation":"

Object key name.

" }, "ReferenceRoleARNUpdate":{ "shape":"RoleARN", "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application.

" } }, "documentation":"

Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.

" }, "SourceSchema":{ "type":"structure", "required":[ "RecordFormat", "RecordColumns" ], "members":{ "RecordFormat":{ "shape":"RecordFormat", "documentation":"

Specifies the format of the records on the streaming source.

" }, "RecordEncoding":{ "shape":"RecordEncoding", "documentation":"

Specifies the encoding of the records in the streaming source. For example, UTF-8.

" }, "RecordColumns":{ "shape":"RecordColumns", "documentation":"

A list of RecordColumn objects.

" } }, "documentation":"

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

" }, "StartApplicationRequest":{ "type":"structure", "required":[ "ApplicationName", "InputConfigurations" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

Name of the application.

" }, "InputConfigurations":{ "shape":"InputConfigurations", "documentation":"

Identifies the specific input, by ID, that the application starts consuming. Amazon Kinesis Analytics starts reading the streaming source associated with the input. You can also specify where in the streaming source you want Amazon Kinesis Analytics to start reading.

" } }, "documentation":"

" }, "StartApplicationResponse":{ "type":"structure", "members":{ }, "documentation":"

" }, "StopApplicationRequest":{ "type":"structure", "required":["ApplicationName"], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

Name of the running application to stop.

" } }, "documentation":"

" }, "StopApplicationResponse":{ "type":"structure", "members":{ }, "documentation":"

" }, "Timestamp":{"type":"timestamp"}, "UnableToDetectSchemaException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"}, "RawInputRecords":{"shape":"RawInputRecords"} }, "documentation":"

Data format is not valid, Kinesis Analytics is not able to detect schema for the given streaming source.

", "exception":true }, "UpdateApplicationRequest":{ "type":"structure", "required":[ "ApplicationName", "CurrentApplicationVersionId", "ApplicationUpdate" ], "members":{ "ApplicationName":{ "shape":"ApplicationName", "documentation":"

Name of the Kinesis Analytics application to update.

" }, "CurrentApplicationVersionId":{ "shape":"ApplicationVersionId", "documentation":"

The current application version ID. You can use the DescribeApplication operation to get this value.

" }, "ApplicationUpdate":{ "shape":"ApplicationUpdate", "documentation":"

Describes application updates.

" } } }, "UpdateApplicationResponse":{ "type":"structure", "members":{ } } } } botocore-1.5.7/botocore/data/cloudtrail/0000777454262600001440000000000013042511307021275 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudtrail/2013-11-01/0000777454262600001440000000000013042511307022317 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudtrail/2013-11-01/service-2.json0000666454262600001440000021660613042511306025023 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2013-11-01", "endpointPrefix":"cloudtrail", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"CloudTrail", "serviceFullName":"AWS CloudTrail", "signatureVersion":"v4", "targetPrefix":"com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101", "uid":"cloudtrail-2013-11-01" }, "operations":{ "AddTags":{ "name":"AddTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsRequest"}, "output":{"shape":"AddTagsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"CloudTrailARNInvalidException"}, {"shape":"ResourceTypeNotSupportedException"}, {"shape":"TagsLimitExceededException"}, {"shape":"InvalidTrailNameException"}, {"shape":"InvalidTagParameterException"}, {"shape":"UnsupportedOperationException"}, {"shape":"OperationNotPermittedException"} ], "documentation":"

Adds one or more tags to a trail, up to a limit of 50. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region).

", "idempotent":true }, "CreateTrail":{ "name":"CreateTrail", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTrailRequest"}, "output":{"shape":"CreateTrailResponse"}, "errors":[ {"shape":"MaximumNumberOfTrailsExceededException"}, {"shape":"TrailAlreadyExistsException"}, {"shape":"S3BucketDoesNotExistException"}, {"shape":"InsufficientS3BucketPolicyException"}, {"shape":"InsufficientSnsTopicPolicyException"}, {"shape":"InsufficientEncryptionPolicyException"}, {"shape":"InvalidS3BucketNameException"}, {"shape":"InvalidS3PrefixException"}, {"shape":"InvalidSnsTopicNameException"}, {"shape":"InvalidKmsKeyIdException"}, {"shape":"InvalidTrailNameException"}, {"shape":"TrailNotProvidedException"}, {"shape":"InvalidParameterCombinationException"}, {"shape":"KmsKeyNotFoundException"}, {"shape":"KmsKeyDisabledException"}, {"shape":"KmsException"}, {"shape":"InvalidCloudWatchLogsLogGroupArnException"}, {"shape":"InvalidCloudWatchLogsRoleArnException"}, {"shape":"CloudWatchLogsDeliveryUnavailableException"}, {"shape":"UnsupportedOperationException"}, {"shape":"OperationNotPermittedException"} ], "documentation":"

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.

", "idempotent":true }, "DeleteTrail":{ "name":"DeleteTrail", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTrailRequest"}, "output":{"shape":"DeleteTrailResponse"}, "errors":[ {"shape":"TrailNotFoundException"}, {"shape":"InvalidTrailNameException"}, {"shape":"InvalidHomeRegionException"} ], "documentation":"

Deletes a trail. This operation must be called from the region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

", "idempotent":true }, "DescribeTrails":{ "name":"DescribeTrails", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTrailsRequest"}, "output":{"shape":"DescribeTrailsResponse"}, "errors":[ {"shape":"UnsupportedOperationException"}, {"shape":"OperationNotPermittedException"} ], "documentation":"

Retrieves settings for the trail associated with the current region for your account.

", "idempotent":true }, "GetEventSelectors":{ "name":"GetEventSelectors", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetEventSelectorsRequest"}, "output":{"shape":"GetEventSelectorsResponse"}, "errors":[ {"shape":"TrailNotFoundException"}, {"shape":"InvalidTrailNameException"}, {"shape":"UnsupportedOperationException"}, {"shape":"OperationNotPermittedException"} ], "documentation":"

Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:

  • The S3 objects that you are logging for data events.

  • If your event selector includes management events.

  • If your event selector includes read-only events, write-only events, or all.

For more information, see Configuring Event Selectors for Trails in the AWS CloudTrail User Guide.

", "idempotent":true }, "GetTrailStatus":{ "name":"GetTrailStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetTrailStatusRequest"}, "output":{"shape":"GetTrailStatusResponse"}, "errors":[ {"shape":"TrailNotFoundException"}, {"shape":"InvalidTrailNameException"} ], "documentation":"

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. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.

", "idempotent":true }, "ListPublicKeys":{ "name":"ListPublicKeys", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPublicKeysRequest"}, "output":{"shape":"ListPublicKeysResponse"}, "errors":[ {"shape":"InvalidTimeRangeException"}, {"shape":"UnsupportedOperationException"}, {"shape":"OperationNotPermittedException"}, {"shape":"InvalidTokenException"} ], "documentation":"

Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.

CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.

", "idempotent":true }, "ListTags":{ "name":"ListTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsRequest"}, "output":{"shape":"ListTagsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"CloudTrailARNInvalidException"}, {"shape":"ResourceTypeNotSupportedException"}, {"shape":"InvalidTrailNameException"}, {"shape":"UnsupportedOperationException"}, {"shape":"OperationNotPermittedException"}, {"shape":"InvalidTokenException"} ], "documentation":"

Lists the tags for the trail in the current region.

", "idempotent":true }, "LookupEvents":{ "name":"LookupEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"LookupEventsRequest"}, "output":{"shape":"LookupEventsResponse"}, "errors":[ {"shape":"InvalidLookupAttributesException"}, {"shape":"InvalidTimeRangeException"}, {"shape":"InvalidMaxResultsException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports the following attributes:

  • Event ID

  • Event name

  • Resource name

  • Resource type

  • User name

All attributes are optional. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.

The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.

Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.

", "idempotent":true }, "PutEventSelectors":{ "name":"PutEventSelectors", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutEventSelectorsRequest"}, "output":{"shape":"PutEventSelectorsResponse"}, "errors":[ {"shape":"TrailNotFoundException"}, {"shape":"InvalidTrailNameException"}, {"shape":"InvalidHomeRegionException"}, {"shape":"InvalidEventSelectorsException"}, {"shape":"UnsupportedOperationException"}, {"shape":"OperationNotPermittedException"} ], "documentation":"

Configures an event selector for your trail. Use event selectors to specify the type of events that you want your trail to log. When an event occurs in your account, CloudTrail evaluates the event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

Example

  1. You create an event selector for a trail and specify that you want write-only events.

  2. The EC2 GetConsoleOutput and RunInstances API operations occur in your account.

  3. CloudTrail evaluates whether the events match your event selectors.

  4. The RunInstances is a write-only event and it matches your event selector. The trail logs the event.

  5. The GetConsoleOutput is a read-only event but it doesn't match your event selector. The trail doesn't log the event.

The PutEventSelectors operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

You can configure up to five event selectors for each trail. For more information, see Configuring Event Selectors for Trails in the AWS CloudTrail User Guide.

", "idempotent":true }, "RemoveTags":{ "name":"RemoveTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTagsRequest"}, "output":{"shape":"RemoveTagsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"CloudTrailARNInvalidException"}, {"shape":"ResourceTypeNotSupportedException"}, {"shape":"InvalidTrailNameException"}, {"shape":"InvalidTagParameterException"}, {"shape":"UnsupportedOperationException"}, {"shape":"OperationNotPermittedException"} ], "documentation":"

Removes the specified tags from a trail.

", "idempotent":true }, "StartLogging":{ "name":"StartLogging", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartLoggingRequest"}, "output":{"shape":"StartLoggingResponse"}, "errors":[ {"shape":"TrailNotFoundException"}, {"shape":"InvalidTrailNameException"}, {"shape":"InvalidHomeRegionException"} ], "documentation":"

Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

", "idempotent":true }, "StopLogging":{ "name":"StopLogging", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopLoggingRequest"}, "output":{"shape":"StopLoggingResponse"}, "errors":[ {"shape":"TrailNotFoundException"}, {"shape":"InvalidTrailNameException"}, {"shape":"InvalidHomeRegionException"} ], "documentation":"

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. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.

", "idempotent":true }, "UpdateTrail":{ "name":"UpdateTrail", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateTrailRequest"}, "output":{"shape":"UpdateTrailResponse"}, "errors":[ {"shape":"S3BucketDoesNotExistException"}, {"shape":"InsufficientS3BucketPolicyException"}, {"shape":"InsufficientSnsTopicPolicyException"}, {"shape":"InsufficientEncryptionPolicyException"}, {"shape":"TrailNotFoundException"}, {"shape":"InvalidS3BucketNameException"}, {"shape":"InvalidS3PrefixException"}, {"shape":"InvalidSnsTopicNameException"}, {"shape":"InvalidKmsKeyIdException"}, {"shape":"InvalidTrailNameException"}, {"shape":"TrailNotProvidedException"}, {"shape":"InvalidParameterCombinationException"}, {"shape":"InvalidHomeRegionException"}, {"shape":"KmsKeyNotFoundException"}, {"shape":"KmsKeyDisabledException"}, {"shape":"KmsException"}, {"shape":"InvalidCloudWatchLogsLogGroupArnException"}, {"shape":"InvalidCloudWatchLogsRoleArnException"}, {"shape":"CloudWatchLogsDeliveryUnavailableException"}, {"shape":"UnsupportedOperationException"}, {"shape":"OperationNotPermittedException"} ], "documentation":"

Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

", "idempotent":true } }, "shapes":{ "AddTagsRequest":{ "type":"structure", "required":["ResourceId"], "members":{ "ResourceId":{ "shape":"String", "documentation":"

Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

" }, "TagsList":{ "shape":"TagsList", "documentation":"

Contains a list of CloudTrail tags, up to a limit of 50

" } }, "documentation":"

Specifies the tags to add to a trail.

" }, "AddTagsResponse":{ "type":"structure", "members":{ }, "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "Boolean":{"type":"boolean"}, "ByteBuffer":{"type":"blob"}, "CloudTrailARNInvalidException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

", "exception":true }, "CloudWatchLogsDeliveryUnavailableException":{ "type":"structure", "members":{ }, "documentation":"

Cannot set a CloudWatch Logs delivery for this region.

", "exception":true }, "CreateTrailRequest":{ "type":"structure", "required":[ "Name", "S3BucketName" ], "members":{ "Name":{ "shape":"String", "documentation":"

Specifies the name of the trail. The name must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

  • Start with a letter or number, and end with a letter or number

  • Be between 3 and 128 characters

  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.

  • Not be in IP address format (for example, 192.168.5.4)

" }, "S3BucketName":{ "shape":"String", "documentation":"

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

" }, "S3KeyPrefix":{ "shape":"String", "documentation":"

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

" }, "SnsTopicName":{ "shape":"String", "documentation":"

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

" }, "IncludeGlobalServiceEvents":{ "shape":"Boolean", "documentation":"

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" }, "IsMultiRegionTrail":{ "shape":"Boolean", "documentation":"

Specifies whether the trail is created in the current region or in all regions. The default is false.

" }, "EnableLogFileValidation":{ "shape":"Boolean", "documentation":"

Specifies whether log file integrity validation is enabled. The default is false.

When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

" }, "CloudWatchLogsLogGroupArn":{ "shape":"String", "documentation":"

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

" }, "CloudWatchLogsRoleArn":{ "shape":"String", "documentation":"

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

Examples:

  • alias/MyAliasName

  • arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • 12345678-1234-1234-1234-123456789012

" } }, "documentation":"

Specifies the settings for each trail.

" }, "CreateTrailResponse":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

Specifies the name of the trail.

" }, "S3BucketName":{ "shape":"String", "documentation":"

Specifies the name of the Amazon S3 bucket designated for publishing log files.

" }, "S3KeyPrefix":{ "shape":"String", "documentation":"

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.

" }, "SnsTopicName":{ "shape":"String", "documentation":"

This field is deprecated. Use SnsTopicARN.

", "deprecated":true }, "SnsTopicARN":{ "shape":"String", "documentation":"

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

arn:aws:sns:us-east-1:123456789012:MyTopic

" }, "IncludeGlobalServiceEvents":{ "shape":"Boolean", "documentation":"

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" }, "IsMultiRegionTrail":{ "shape":"Boolean", "documentation":"

Specifies whether the trail exists in one region or in all regions.

" }, "TrailARN":{ "shape":"String", "documentation":"

Specifies the ARN of the trail that was created. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

" }, "LogFileValidationEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether log file integrity validation is enabled.

" }, "CloudWatchLogsLogGroupArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

" }, "CloudWatchLogsRoleArn":{ "shape":"String", "documentation":"

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:

arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

" } }, "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "DataResource":{ "type":"structure", "members":{ "Type":{ "shape":"String", "documentation":"

The resource type in which you want to log data events. You can specify only the following value: AWS::S3::Object.

" }, "Values":{ "shape":"DataResourceValues", "documentation":"

A list of ARN-like strings for the specified S3 objects.

To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::bucket-1/. The trail logs data events for all objects in this S3 bucket.

To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::bucket-1/example-images. The trail logs data events for objects in this S3 bucket that match the prefix.

" } }, "documentation":"

The Amazon S3 objects that you specify in your event selectors for your trail to log data events. Data events are object level API operations that access S3 objects, such as GetObject, DeleteObject, and PutObject. You can specify up to 50 S3 buckets and object prefixes for an event selector.

Example

  1. You create an event selector for a trail and specify an S3 bucket and an empty prefix, such as arn:aws:s3:::bucket-1/.

  2. You upload an image file to bucket-1.

  3. The PutObject API operation occurs on an object in the S3 bucket that you specified in the event selector. The trail processes and logs the event.

  4. You upload another image file to a different S3 bucket named arn:aws:s3:::bucket-2.

  5. The event occurs on an object in an S3 bucket that you didn't specify in the event selector. The trail doesn’t log the event.

" }, "DataResourceValues":{ "type":"list", "member":{"shape":"String"} }, "DataResources":{ "type":"list", "member":{"shape":"DataResource"} }, "Date":{"type":"timestamp"}, "DeleteTrailRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"String", "documentation":"

Specifies the name or the CloudTrail ARN of the trail to be deleted. The format of a trail ARN is: arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

" } }, "documentation":"

The request that specifies the name of a trail to delete.

" }, "DeleteTrailResponse":{ "type":"structure", "members":{ }, "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "DescribeTrailsRequest":{ "type":"structure", "members":{ "trailNameList":{ "shape":"TrailNameList", "documentation":"

Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

If an empty list is specified, information for the trail in the current region is returned.

  • If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current region is returned.

  • If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned.

If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region. To return information about a trail in another region, you must specify its trail ARN.

" }, "includeShadowTrails":{ "shape":"Boolean", "documentation":"

Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region. The default is true.

" } }, "documentation":"

Returns information about the trail.

" }, "DescribeTrailsResponse":{ "type":"structure", "members":{ "trailList":{ "shape":"TrailList", "documentation":"

The list of trail objects.

" } }, "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "Event":{ "type":"structure", "members":{ "EventId":{ "shape":"String", "documentation":"

The CloudTrail ID of the event returned.

" }, "EventName":{ "shape":"String", "documentation":"

The name of the event returned.

" }, "EventTime":{ "shape":"Date", "documentation":"

The date and time of the event returned.

" }, "EventSource":{ "shape":"String", "documentation":"

The AWS service that the request was made to.

" }, "Username":{ "shape":"String", "documentation":"

A user name or role name of the requester that called the API in the event returned.

" }, "Resources":{ "shape":"ResourceList", "documentation":"

A list of resources referenced by the event returned.

" }, "CloudTrailEvent":{ "shape":"String", "documentation":"

A JSON string that contains a representation of the event returned.

" } }, "documentation":"

Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.

" }, "EventSelector":{ "type":"structure", "members":{ "ReadWriteType":{ "shape":"ReadWriteType", "documentation":"

Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation.

By default, the value is All.

" }, "IncludeManagementEvents":{ "shape":"Boolean", "documentation":"

Specify if you want your event selector to include management events for your trail.

For more information, see Management Events in the AWS CloudTrail User Guide.

By default, the value is true.

" }, "DataResources":{ "shape":"DataResources", "documentation":"

CloudTrail supports logging only data events for S3 objects. You can specify up to 50 S3 buckets and object prefixes for an event selector.

For more information, see Data Events in the AWS CloudTrail User Guide.

" } }, "documentation":"

Use event selectors to specify the types of events that you want your trail to log. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

You can configure up to five event selectors for a trail.

" }, "EventSelectors":{ "type":"list", "member":{"shape":"EventSelector"} }, "EventsList":{ "type":"list", "member":{"shape":"Event"} }, "GetEventSelectorsRequest":{ "type":"structure", "members":{ "TrailName":{ "shape":"String", "documentation":"

Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

  • Start with a letter or number, and end with a letter or number

  • Be between 3 and 128 characters

  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.

  • Not be in IP address format (for example, 192.168.5.4)

If you specify a trail ARN, it must be in the format:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

" } } }, "GetEventSelectorsResponse":{ "type":"structure", "members":{ "TrailARN":{ "shape":"String", "documentation":"

The specified trail ARN that has the event selectors.

" }, "EventSelectors":{ "shape":"EventSelectors", "documentation":"

The event selectors that are configured for the trail.

" } } }, "GetTrailStatusRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"String", "documentation":"

Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another region), you must specify its ARN. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

" } }, "documentation":"

The name of a trail about which you want the current status.

" }, "GetTrailStatusResponse":{ "type":"structure", "members":{ "IsLogging":{ "shape":"Boolean", "documentation":"

Whether the CloudTrail is currently logging AWS API calls.

" }, "LatestDeliveryError":{ "shape":"String", "documentation":"

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.

This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To resolve the issue, create a new bucket and call UpdateTrail to specify the new bucket, or fix the existing objects so that CloudTrail can again write to the bucket.

" }, "LatestNotificationError":{ "shape":"String", "documentation":"

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.

" }, "LatestDeliveryTime":{ "shape":"Date", "documentation":"

Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.

" }, "LatestNotificationTime":{ "shape":"Date", "documentation":"

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.

" }, "StartLoggingTime":{ "shape":"Date", "documentation":"

Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account.

" }, "StopLoggingTime":{ "shape":"Date", "documentation":"

Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.

" }, "LatestCloudWatchLogsDeliveryError":{ "shape":"String", "documentation":"

Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.

" }, "LatestCloudWatchLogsDeliveryTime":{ "shape":"Date", "documentation":"

Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.

" }, "LatestDigestDeliveryTime":{ "shape":"Date", "documentation":"

Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.

" }, "LatestDigestDeliveryError":{ "shape":"String", "documentation":"

Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest file to the designated bucket. For more information see the topic Error Responses in the Amazon S3 API Reference.

This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To resolve the issue, create a new bucket and call UpdateTrail to specify the new bucket, or fix the existing objects so that CloudTrail can again write to the bucket.

" }, "LatestDeliveryAttemptTime":{ "shape":"String", "documentation":"

This field is deprecated.

" }, "LatestNotificationAttemptTime":{ "shape":"String", "documentation":"

This field is deprecated.

" }, "LatestNotificationAttemptSucceeded":{ "shape":"String", "documentation":"

This field is deprecated.

" }, "LatestDeliveryAttemptSucceeded":{ "shape":"String", "documentation":"

This field is deprecated.

" }, "TimeLoggingStarted":{ "shape":"String", "documentation":"

This field is deprecated.

" }, "TimeLoggingStopped":{ "shape":"String", "documentation":"

This field is deprecated.

" } }, "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "InsufficientEncryptionPolicyException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.

", "exception":true }, "InsufficientS3BucketPolicyException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the policy on the S3 bucket is not sufficient.

", "exception":true }, "InsufficientSnsTopicPolicyException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the policy on the SNS topic is not sufficient.

", "exception":true }, "InvalidCloudWatchLogsLogGroupArnException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the provided CloudWatch log group is not valid.

", "exception":true }, "InvalidCloudWatchLogsRoleArnException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the provided role is not valid.

", "exception":true }, "InvalidEventSelectorsException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the PutEventSelectors operation is called with an invalid number of event selectors, data resources, or an invalid value for a parameter:

  • Specify a valid number of event selectors (1 to 5) for a trail.

  • Specify a valid number of data resources (1 to 50) for an event selector.

  • Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter with a value of read-only is invalid.

", "exception":true }, "InvalidHomeRegionException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.

", "exception":true }, "InvalidKmsKeyIdException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the KMS key ARN is invalid.

", "exception":true }, "InvalidLookupAttributesException":{ "type":"structure", "members":{ }, "documentation":"

Occurs when an invalid lookup attribute is specified.

", "exception":true }, "InvalidMaxResultsException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown if the limit specified is invalid.

", "exception":true }, "InvalidNextTokenException":{ "type":"structure", "members":{ }, "documentation":"

Invalid token or token that was previously used in a request with different parameters. This exception is thrown if the token is invalid.

", "exception":true }, "InvalidParameterCombinationException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the combination of parameters provided is not valid.

", "exception":true }, "InvalidS3BucketNameException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the provided S3 bucket name is not valid.

", "exception":true }, "InvalidS3PrefixException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the provided S3 prefix is not valid.

", "exception":true }, "InvalidSnsTopicNameException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the provided SNS topic name is not valid.

", "exception":true }, "InvalidTagParameterException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the key or value specified for the tag does not match the regular expression ^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$.

", "exception":true }, "InvalidTimeRangeException":{ "type":"structure", "members":{ }, "documentation":"

Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values.

", "exception":true }, "InvalidTokenException":{ "type":"structure", "members":{ }, "documentation":"

Reserved for future use.

", "exception":true }, "InvalidTrailNameException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

  • Start with a letter or number, and end with a letter or number

  • Be between 3 and 128 characters

  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.

  • Not be in IP address format (for example, 192.168.5.4)

", "exception":true }, "KmsException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when there is an issue with the specified KMS key and the trail can’t be updated.

", "exception":true }, "KmsKeyDisabledException":{ "type":"structure", "members":{ }, "documentation":"

This exception is deprecated.

", "deprecated":true, "exception":true }, "KmsKeyNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region.

", "exception":true }, "ListPublicKeysRequest":{ "type":"structure", "members":{ "StartTime":{ "shape":"Date", "documentation":"

Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.

" }, "EndTime":{ "shape":"Date", "documentation":"

Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.

" }, "NextToken":{ "shape":"String", "documentation":"

Reserved for future use.

" } }, "documentation":"

Requests the public keys for a specified time range.

" }, "ListPublicKeysResponse":{ "type":"structure", "members":{ "PublicKeyList":{ "shape":"PublicKeyList", "documentation":"

Contains an array of PublicKey objects.

The returned public keys may have validity time ranges that overlap.

" }, "NextToken":{ "shape":"String", "documentation":"

Reserved for future use.

" } }, "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "ListTagsRequest":{ "type":"structure", "required":["ResourceIdList"], "members":{ "ResourceIdList":{ "shape":"ResourceIdList", "documentation":"

Specifies a list of trail ARNs whose tags will be listed. The list has a limit of 20 ARNs. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

" }, "NextToken":{ "shape":"String", "documentation":"

Reserved for future use.

" } }, "documentation":"

Specifies a list of trail tags to return.

" }, "ListTagsResponse":{ "type":"structure", "members":{ "ResourceTagList":{"shape":"ResourceTagList"}, "NextToken":{ "shape":"String", "documentation":"

Reserved for future use.

" } }, "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "LookupAttribute":{ "type":"structure", "required":[ "AttributeKey", "AttributeValue" ], "members":{ "AttributeKey":{ "shape":"LookupAttributeKey", "documentation":"

Specifies an attribute on which to filter the events returned.

" }, "AttributeValue":{ "shape":"String", "documentation":"

Specifies a value for the specified AttributeKey.

" } }, "documentation":"

Specifies an attribute and value that filter the events returned.

" }, "LookupAttributeKey":{ "type":"string", "enum":[ "EventId", "EventName", "Username", "ResourceType", "ResourceName", "EventSource" ] }, "LookupAttributesList":{ "type":"list", "member":{"shape":"LookupAttribute"} }, "LookupEventsRequest":{ "type":"structure", "members":{ "LookupAttributes":{ "shape":"LookupAttributesList", "documentation":"

Contains a list of lookup attributes. Currently the list can contain only one item.

" }, "StartTime":{ "shape":"Date", "documentation":"

Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

" }, "EndTime":{ "shape":"Date", "documentation":"

Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The number of events to return. Possible values are 1 through 50. The default is 10.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

" } }, "documentation":"

Contains a request for LookupEvents.

" }, "LookupEventsResponse":{ "type":"structure", "members":{ "Events":{ "shape":"EventsList", "documentation":"

A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

" } }, "documentation":"

Contains a response to a LookupEvents action.

" }, "MaxResults":{ "type":"integer", "max":50, "min":1 }, "MaximumNumberOfTrailsExceededException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the maximum number of trails is reached.

", "exception":true }, "NextToken":{"type":"string"}, "OperationNotPermittedException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the requested operation is not permitted.

", "exception":true }, "PublicKey":{ "type":"structure", "members":{ "Value":{ "shape":"ByteBuffer", "documentation":"

The DER encoded public key value in PKCS#1 format.

" }, "ValidityStartTime":{ "shape":"Date", "documentation":"

The starting time of validity of the public key.

" }, "ValidityEndTime":{ "shape":"Date", "documentation":"

The ending time of validity of the public key.

" }, "Fingerprint":{ "shape":"String", "documentation":"

The fingerprint of the public key.

" } }, "documentation":"

Contains information about a returned public key.

" }, "PublicKeyList":{ "type":"list", "member":{"shape":"PublicKey"} }, "PutEventSelectorsRequest":{ "type":"structure", "members":{ "TrailName":{ "shape":"String", "documentation":"

Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

  • Start with a letter or number, and end with a letter or number

  • Be between 3 and 128 characters

  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.

  • Not be in IP address format (for example, 192.168.5.4)

If you specify a trail ARN, it must be in the format:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

" }, "EventSelectors":{ "shape":"EventSelectors", "documentation":"

Specifies the settings for your event selectors. You can configure up to five event selectors for a trail.

" } } }, "PutEventSelectorsResponse":{ "type":"structure", "members":{ "TrailARN":{ "shape":"String", "documentation":"

Specifies the ARN of the trail that was updated with event selectors. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

" }, "EventSelectors":{ "shape":"EventSelectors", "documentation":"

Specifies the event selectors configured for your trail.

" } } }, "ReadWriteType":{ "type":"string", "enum":[ "ReadOnly", "WriteOnly", "All" ] }, "RemoveTagsRequest":{ "type":"structure", "required":["ResourceId"], "members":{ "ResourceId":{ "shape":"String", "documentation":"

Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

" }, "TagsList":{ "shape":"TagsList", "documentation":"

Specifies a list of tags to be removed.

" } }, "documentation":"

Specifies the tags to remove from a trail.

" }, "RemoveTagsResponse":{ "type":"structure", "members":{ }, "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "Resource":{ "type":"structure", "members":{ "ResourceType":{ "shape":"String", "documentation":"

The type of a resource referenced by the event returned. When the resource type cannot be determined, null is returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail, DBInstance for RDS, and AccessKey for IAM. For a list of resource types supported for event lookup, see Resource Types Supported for Event Lookup.

" }, "ResourceName":{ "shape":"String", "documentation":"

The name of the resource referenced by the event returned. These are user-created names whose values will depend on the environment. For example, the resource name might be \"auto-scaling-test-group\" for an Auto Scaling Group or \"i-1234567\" for an EC2 Instance.

" } }, "documentation":"

Specifies the type and name of a resource referenced by an event.

" }, "ResourceIdList":{ "type":"list", "member":{"shape":"String"} }, "ResourceList":{ "type":"list", "member":{"shape":"Resource"}, "documentation":"

A list of resources referenced by the event returned.

" }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the specified resource is not found.

", "exception":true }, "ResourceTag":{ "type":"structure", "members":{ "ResourceId":{ "shape":"String", "documentation":"

Specifies the ARN of the resource.

" }, "TagsList":{"shape":"TagsList"} }, "documentation":"

A resource tag.

" }, "ResourceTagList":{ "type":"list", "member":{"shape":"ResourceTag"}, "documentation":"

A list of resource tags.

" }, "ResourceTypeNotSupportedException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the specified resource type is not supported by CloudTrail.

", "exception":true }, "S3BucketDoesNotExistException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the specified S3 bucket does not exist.

", "exception":true }, "StartLoggingRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"String", "documentation":"

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs AWS API calls. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

" } }, "documentation":"

The request to CloudTrail to start logging AWS API calls for an account.

" }, "StartLoggingResponse":{ "type":"structure", "members":{ }, "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "StopLoggingRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"String", "documentation":"

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging AWS API calls. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

" } }, "documentation":"

Passes the request to CloudTrail to stop logging AWS API calls for the specified account.

" }, "StopLoggingResponse":{ "type":"structure", "members":{ }, "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" }, "String":{"type":"string"}, "Tag":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"String", "documentation":"

The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.

" }, "Value":{ "shape":"String", "documentation":"

The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.

" } }, "documentation":"

A custom key-value pair associated with a resource such as a CloudTrail trail.

" }, "TagsLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

The number of tags per trail has exceeded the permitted amount. Currently, the limit is 50.

", "exception":true }, "TagsList":{ "type":"list", "member":{"shape":"Tag"}, "documentation":"

A list of tags.

" }, "Trail":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

Name of the trail set by calling CreateTrail. The maximum length is 128 characters.

" }, "S3BucketName":{ "shape":"String", "documentation":"

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.

" }, "S3KeyPrefix":{ "shape":"String", "documentation":"

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.The maximum length is 200 characters.

" }, "SnsTopicName":{ "shape":"String", "documentation":"

This field is deprecated. Use SnsTopicARN.

", "deprecated":true }, "SnsTopicARN":{ "shape":"String", "documentation":"

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

arn:aws:sns:us-east-1:123456789012:MyTopic

" }, "IncludeGlobalServiceEvents":{ "shape":"Boolean", "documentation":"

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

" }, "IsMultiRegionTrail":{ "shape":"Boolean", "documentation":"

Specifies whether the trail belongs only to one region or exists in all regions.

" }, "HomeRegion":{ "shape":"String", "documentation":"

The region in which the trail was created.

" }, "TrailARN":{ "shape":"String", "documentation":"

Specifies the ARN of the trail. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

" }, "LogFileValidationEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether log file validation is enabled.

" }, "CloudWatchLogsLogGroupArn":{ "shape":"String", "documentation":"

Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.

" }, "CloudWatchLogsRoleArn":{ "shape":"String", "documentation":"

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:

arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

" }, "HasCustomEventSelectors":{ "shape":"Boolean", "documentation":"

Specifies if the trail has custom event selectors.

" } }, "documentation":"

The settings for a trail.

" }, "TrailAlreadyExistsException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the specified trail already exists.

", "exception":true }, "TrailList":{ "type":"list", "member":{"shape":"Trail"} }, "TrailNameList":{ "type":"list", "member":{"shape":"String"} }, "TrailNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the trail with the given name is not found.

", "exception":true }, "TrailNotProvidedException":{ "type":"structure", "members":{ }, "documentation":"

This exception is deprecated.

", "exception":true }, "UnsupportedOperationException":{ "type":"structure", "members":{ }, "documentation":"

This exception is thrown when the requested operation is not supported.

", "exception":true }, "UpdateTrailRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"String", "documentation":"

Specifies the name of the trail or trail ARN. If Name is a trail name, the string must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

  • Start with a letter or number, and end with a letter or number

  • Be between 3 and 128 characters

  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.

  • Not be in IP address format (for example, 192.168.5.4)

If Name is a trail ARN, it must be in the format:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

" }, "S3BucketName":{ "shape":"String", "documentation":"

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

" }, "S3KeyPrefix":{ "shape":"String", "documentation":"

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

" }, "SnsTopicName":{ "shape":"String", "documentation":"

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

" }, "IncludeGlobalServiceEvents":{ "shape":"Boolean", "documentation":"

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" }, "IsMultiRegionTrail":{ "shape":"Boolean", "documentation":"

Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted.

" }, "EnableLogFileValidation":{ "shape":"Boolean", "documentation":"

Specifies whether log file validation is enabled. The default is false.

When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

" }, "CloudWatchLogsLogGroupArn":{ "shape":"String", "documentation":"

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

" }, "CloudWatchLogsRoleArn":{ "shape":"String", "documentation":"

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

Examples:

  • alias/MyAliasName

  • arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • 12345678-1234-1234-1234-123456789012

" } }, "documentation":"

Specifies settings to update for the trail.

" }, "UpdateTrailResponse":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

Specifies the name of the trail.

" }, "S3BucketName":{ "shape":"String", "documentation":"

Specifies the name of the Amazon S3 bucket designated for publishing log files.

" }, "S3KeyPrefix":{ "shape":"String", "documentation":"

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.

" }, "SnsTopicName":{ "shape":"String", "documentation":"

This field is deprecated. Use SnsTopicARN.

", "deprecated":true }, "SnsTopicARN":{ "shape":"String", "documentation":"

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

arn:aws:sns:us-east-1:123456789012:MyTopic

" }, "IncludeGlobalServiceEvents":{ "shape":"Boolean", "documentation":"

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" }, "IsMultiRegionTrail":{ "shape":"Boolean", "documentation":"

Specifies whether the trail exists in one region or in all regions.

" }, "TrailARN":{ "shape":"String", "documentation":"

Specifies the ARN of the trail that was updated. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

" }, "LogFileValidationEnabled":{ "shape":"Boolean", "documentation":"

Specifies whether log file integrity validation is enabled.

" }, "CloudWatchLogsLogGroupArn":{ "shape":"String", "documentation":"

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

" }, "CloudWatchLogsRoleArn":{ "shape":"String", "documentation":"

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" }, "KmsKeyId":{ "shape":"String", "documentation":"

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:

arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

" } }, "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" } }, "documentation":"AWS CloudTrail

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

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.

As an alternative to the API, you can use one of the AWS SDKs, which consist of libraries and sample code 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 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.

See the AWS CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.

" } botocore-1.5.7/botocore/data/opsworkscm/0000777454262600001440000000000013042511307021342 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/opsworkscm/2016-11-01/0000777454262600001440000000000013042511307022367 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/opsworkscm/2016-11-01/waiters-2.json0000666454262600001440000000110613042511306025074 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "NodeAssociated": { "delay": 15, "maxAttempts": 15, "operation": "DescribeNodeAssociationStatus", "description": "Wait until node is associated or disassociated.", "acceptors": [ { "expected": "SUCCESS", "state": "success", "matcher": "path", "argument": "NodeAssociationStatus" }, { "expected": "FAILED", "state": "failure", "matcher": "path", "argument": "NodeAssociationStatus" } ] } } } botocore-1.5.7/botocore/data/opsworkscm/2016-11-01/service-2.json0000666454262600001440000014742613042511306025076 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-11-01", "endpointPrefix":"opsworks-cm", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"OpsWorksCM", "serviceFullName":"AWS OpsWorks for Chef Automate", "signatureVersion":"v4", "signingName":"opsworks-cm", "targetPrefix":"OpsWorksCM_V2016_11_01", "uid":"opsworkscm-2016-11-01" }, "operations":{ "AssociateNode":{ "name":"AssociateNode", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateNodeRequest"}, "output":{"shape":"AssociateNodeResponse"}, "errors":[ {"shape":"InvalidStateException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ] }, "CreateBackup":{ "name":"CreateBackup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateBackupRequest"}, "output":{"shape":"CreateBackupResponse"}, "errors":[ {"shape":"InvalidStateException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Creates an application-level backup of a server. While the server is BACKING_UP, the server can not be modified and no additional backup can be created.

Backups can be created for RUNNING, HEALTHY and UNHEALTHY servers.

This operation is asnychronous.

By default 50 manual backups can be created.

A LimitExceededException is thrown then the maximum number of manual backup is reached. A InvalidStateException is thrown when the server is not in any of RUNNING, HEALTHY, UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid.

" }, "CreateServer":{ "name":"CreateServer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateServerRequest"}, "output":{"shape":"CreateServerResponse"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Creates and immedately starts a new Server. The server can be used once it has reached the HEALTHY state.

This operation is asnychronous.

A LimitExceededException is thrown then the maximum number of server backup is reached. A ResourceAlreadyExistsException is raise when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when a backupId is passed, but the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.

By default 10 servers can be created. A LimitExceededException is raised when the limit is exceeded.

When no security groups are provided by using SecurityGroupIds, AWS OpsWorks creates a new security group. This security group opens the Chef server to the world on TCP port 443. If a KeyName is present, SSH access is enabled. SSH is also open to the world on TCP port 22.

By default, the Chef Server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console.

" }, "DeleteBackup":{ "name":"DeleteBackup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteBackupRequest"}, "output":{"shape":"DeleteBackupResponse"}, "errors":[ {"shape":"InvalidStateException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Deletes a backup. You can delete both manual and automated backups.

This operation is asynchronous.

A InvalidStateException is thrown then a backup is already deleting. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.

" }, "DeleteServer":{ "name":"DeleteServer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteServerRequest"}, "output":{"shape":"DeleteServerResponse"}, "errors":[ {"shape":"InvalidStateException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Deletes the server and the underlying AWS CloudFormation stack (including the server's EC2 instance). The server status updated to DELETING. Once the server is successfully deleted, it will no longer be returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.

This operation is asynchronous.

A InvalidStateException is thrown then a server is already deleting. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

" }, "DescribeAccountAttributes":{ "name":"DescribeAccountAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAccountAttributesRequest"}, "output":{"shape":"DescribeAccountAttributesResponse"}, "documentation":"

Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.

This operation is synchronous.

" }, "DescribeBackups":{ "name":"DescribeBackups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeBackupsRequest"}, "output":{"shape":"DescribeBackupsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.

This operation is synchronous.

A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is raised when parameters of the request are invalid.

" }, "DescribeEvents":{ "name":"DescribeEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventsRequest"}, "output":{"shape":"DescribeEventsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InvalidNextTokenException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes events for a specified server. Results are ordered by time, with newest events first.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

" }, "DescribeNodeAssociationStatus":{ "name":"DescribeNodeAssociationStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeNodeAssociationStatusRequest"}, "output":{"shape":"DescribeNodeAssociationStatusResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ] }, "DescribeServers":{ "name":"DescribeServers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeServersRequest"}, "output":{"shape":"DescribeServersResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidNextTokenException"} ], "documentation":"

Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks for Chef Automate does not query other services.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

" }, "DisassociateNode":{ "name":"DisassociateNode", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateNodeRequest"}, "output":{"shape":"DisassociateNodeResponse"}, "errors":[ {"shape":"InvalidStateException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ] }, "RestoreServer":{ "name":"RestoreServer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreServerRequest"}, "output":{"shape":"RestoreServerResponse"}, "errors":[ {"shape":"InvalidStateException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Restores a backup to a server that is in a RUNNING, FAILED, or HEALTHY state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of all of the server's client devices should continue to work.

This operation is asynchronous.

A InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

" }, "StartMaintenance":{ "name":"StartMaintenance", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartMaintenanceRequest"}, "output":{"shape":"StartMaintenanceResponse"}, "errors":[ {"shape":"InvalidStateException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server will switch to UNDER_MAINTENANCE state, while maintenace is in progress.

Maintenace can only be started for HEALTHY and UNHEALTHY servers. A InvalidStateException is thrown otherwise. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

" }, "UpdateServer":{ "name":"UpdateServer", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateServerRequest"}, "output":{"shape":"UpdateServerResponse"}, "errors":[ {"shape":"InvalidStateException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Updates settings for a server.

This operation is synchronous.

" }, "UpdateServerEngineAttributes":{ "name":"UpdateServerEngineAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateServerEngineAttributesRequest"}, "output":{"shape":"UpdateServerEngineAttributesResponse"}, "errors":[ {"shape":"InvalidStateException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ValidationException"} ], "documentation":"

Updates engine specific attributes on a specified server. Server will enter the MODIFYING state when this operation is in progress. Only one update can take place at a time.

This operation can be use to reset Chef Server main API key (CHEF_PIVOTAL_KEY).

This operation is asynchronous.

This operation can only be called for HEALTHY and UNHEALTHY servers. Otherwise a InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.

" } }, "shapes":{ "AccountAttribute":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The attribute name. The following are supported attribute names.

  • ServerLimit: The number of servers that currently existing / maximal allowed. By default 10 servers can be created.

  • ManualBackupLimit: The number of manual backups that currently exist / are maximal allowed. By default 50 manual backups can be created.

" }, "Maximum":{ "shape":"Integer", "documentation":"

The maximum allowed value.

" }, "Used":{ "shape":"Integer", "documentation":"

The current usage, such as the current number of servers associated with the account.

" } }, "documentation":"

Stores account attributes.

" }, "AccountAttributes":{ "type":"list", "member":{"shape":"AccountAttribute"}, "documentation":"

A list of the individual attributes.

" }, "AssociateNodeRequest":{ "type":"structure", "required":[ "ServerName", "NodeName" ], "members":{ "ServerName":{"shape":"ServerName"}, "NodeName":{"shape":"NodeName"}, "EngineAttributes":{"shape":"EngineAttributes"} } }, "AssociateNodeResponse":{ "type":"structure", "members":{ "NodeAssociationStatusToken":{"shape":"NodeAssociationStatusToken"} } }, "AttributeName":{ "type":"string", "max":64, "min":1, "pattern":"[A-Z][A-Z0-9_]*" }, "AttributeValue":{"type":"string"}, "Backup":{ "type":"structure", "members":{ "BackupArn":{ "shape":"String", "documentation":"

The ARN of the backup.

" }, "BackupId":{ "shape":"BackupId", "documentation":"

The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS

" }, "BackupType":{ "shape":"BackupType", "documentation":"

The backup type. Valid values are automated or manual.

" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"

The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z

" }, "Description":{ "shape":"String", "documentation":"

A user-provided description for a manual backup. This field is empty for automated backups.

" }, "Engine":{ "shape":"String", "documentation":"

The engine type that is obtained from the server when the backup is created.

" }, "EngineModel":{ "shape":"String", "documentation":"

The engine model that is obtained from the server when the backup is created.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The engine version that is obtained from the server when the backup is created.

" }, "InstanceProfileArn":{ "shape":"String", "documentation":"

The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.

" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type that is obtained from the server when the backup is created.

" }, "KeyPair":{ "shape":"String", "documentation":"

The key pair that is obtained from the server when the backup is created.

" }, "PreferredBackupWindow":{ "shape":"TimeWindowDefinition", "documentation":"

The preferred backup period that is obtained from the server when the backup is created.

" }, "PreferredMaintenanceWindow":{ "shape":"TimeWindowDefinition", "documentation":"

The preferred maintenance period that is obtained from the server when the backup is created.

" }, "S3DataSize":{ "shape":"Integer", "documentation":"

The size of the backup, in bytes. The size is returned by the instance in the command results.

" }, "S3DataUrl":{ "shape":"String", "documentation":"

The Amazon S3 URL of the backup's tar.gz file.

" }, "S3LogUrl":{ "shape":"String", "documentation":"

The Amazon S3 URL of the backup's log file.

" }, "SecurityGroupIds":{ "shape":"Strings", "documentation":"

The security group IDs that are obtained from the server when the backup is created.

" }, "ServerName":{ "shape":"ServerName", "documentation":"

The name of the server from which the backup was made.

" }, "ServiceRoleArn":{ "shape":"String", "documentation":"

The service role ARN that is obtained from the server when the backup is created.

" }, "Status":{ "shape":"BackupStatus", "documentation":"

The status of a backup while in progress.

" }, "StatusDescription":{ "shape":"String", "documentation":"

An informational message about backup status.

" }, "SubnetIds":{ "shape":"Strings", "documentation":"

The subnet IDs that are obtained from the server when the backup is created.

" }, "ToolsVersion":{ "shape":"String", "documentation":"

The version of AWS OpsWorks for Chef Automate-specific tools that is obtained from the server when the backup is created.

" }, "UserArn":{ "shape":"String", "documentation":"

The IAM user ARN of the requester for manual backups. This field is empty for automated backups.

" } }, "documentation":"

Describes a single backup.

" }, "BackupId":{ "type":"string", "max":79 }, "BackupRetentionCountDefinition":{ "type":"integer", "min":1 }, "BackupStatus":{ "type":"string", "enum":[ "IN_PROGRESS", "OK", "FAILED", "DELETING" ] }, "BackupType":{ "type":"string", "enum":[ "AUTOMATED", "MANUAL" ] }, "Backups":{ "type":"list", "member":{"shape":"Backup"} }, "Boolean":{"type":"boolean"}, "CreateBackupRequest":{ "type":"structure", "required":["ServerName"], "members":{ "ServerName":{ "shape":"ServerName", "documentation":"

The name of the server that you want to back up.

" }, "Description":{ "shape":"String", "documentation":"

A user-defined description of the backup.

" } } }, "CreateBackupResponse":{ "type":"structure", "members":{ "Backup":{ "shape":"Backup", "documentation":"

Backup created by request.

" } } }, "CreateServerRequest":{ "type":"structure", "required":[ "ServerName", "InstanceProfileArn", "ServiceRoleArn" ], "members":{ "DisableAutomatedBackup":{ "shape":"Boolean", "documentation":"

Enable or disable scheduled backups. Valid values are true or false. The default value is true.

" }, "Engine":{ "shape":"String", "documentation":"

The configuration management engine to use. Valid values include Chef.

" }, "EngineModel":{ "shape":"String", "documentation":"

The engine model, or option. Valid values include Single.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The major release version of the engine that you want to use. Values depend on the engine that you choose.

" }, "EngineAttributes":{ "shape":"EngineAttributes", "documentation":"

Engine attributes on a specified server.

Attributes accepted in a createServer request:

  • CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is not stored by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

" }, "BackupRetentionCount":{ "shape":"BackupRetentionCountDefinition", "documentation":"

The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks for Chef Automate deletes the oldest backups if this number is exceeded. The default value is 1.

" }, "ServerName":{ "shape":"ServerName", "documentation":"

The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 32 characters.

" }, "InstanceProfileArn":{ "shape":"InstanceProfileArn", "documentation":"

The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, in this release of AWS OpsWorks for Chef Automate, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml. This template creates a stack that includes the instance profile you need.

" }, "InstanceType":{ "shape":"String", "documentation":"

The Amazon EC2 instance type to use. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, c3.large.

" }, "KeyPair":{ "shape":"KeyPair", "documentation":"

The Amazon EC2 key pair to set for the instance. You may specify this parameter to connect to your instances by using SSH.

" }, "PreferredMaintenanceWindow":{ "shape":"TimeWindowDefinition", "documentation":"

The start time for a one-hour period each week during which AWS OpsWorks for Chef Automate performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.

Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

" }, "PreferredBackupWindow":{ "shape":"TimeWindowDefinition", "documentation":"

The start time for a one-hour period during which AWS OpsWorks for Chef Automate backs up application-level data on your server if backups are enabled. Valid values must be specified in one of the following formats:

  • HH:MM for daily backups

  • DDD:HH:MM for weekly backups

The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

Example: 08:00, which represents a daily start time of 08:00 UTC.

Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

" }, "SecurityGroupIds":{ "shape":"Strings", "documentation":"

A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups must be within the VPC that is specified by SubnetIds.

If you do not specify this parameter, AWS OpsWorks for Chef Automate creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

" }, "ServiceRoleArn":{ "shape":"ServiceRoleArn", "documentation":"

The service role that the AWS OpsWorks for Chef Automate service backend uses to work with your account. Although the AWS OpsWorks console typically creates the service role for you, in this release of AWS OpsWorks for Chef Automate, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml. This template creates a stack that includes the service role that you need.

" }, "SubnetIds":{ "shape":"Strings", "documentation":"

The IDs of subnets in which to launch the server EC2 instance.

Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have \"Auto Assign Public IP\" enabled.

EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have \"Auto Assign Public IP\" enabled.

For more information about supported Amazon EC2 platforms, see Supported Platforms.

" }, "BackupId":{ "shape":"BackupId", "documentation":"

If you specify this field, AWS OpsWorks for Chef Automate creates the server by using the backup represented by BackupId.

" } } }, "CreateServerResponse":{ "type":"structure", "members":{ "Server":{ "shape":"Server", "documentation":"

The server that is created by the request.

" } } }, "DeleteBackupRequest":{ "type":"structure", "required":["BackupId"], "members":{ "BackupId":{ "shape":"BackupId", "documentation":"

The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs. Backup IDs are in the format ServerName-yyyyMMddHHmmssSSS.

" } } }, "DeleteBackupResponse":{ "type":"structure", "members":{ } }, "DeleteServerRequest":{ "type":"structure", "required":["ServerName"], "members":{ "ServerName":{ "shape":"ServerName", "documentation":"

The ID of the server to delete.

" } } }, "DeleteServerResponse":{ "type":"structure", "members":{ } }, "DescribeAccountAttributesRequest":{ "type":"structure", "members":{ } }, "DescribeAccountAttributesResponse":{ "type":"structure", "members":{ "Attributes":{ "shape":"AccountAttributes", "documentation":"

The attributes that are currently set for the account.

" } } }, "DescribeBackupsRequest":{ "type":"structure", "members":{ "BackupId":{ "shape":"BackupId", "documentation":"

Describes a single backup.

" }, "ServerName":{ "shape":"ServerName", "documentation":"

Returns backups for the server with the specified ServerName.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeBackups again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

" } } }, "DescribeBackupsResponse":{ "type":"structure", "members":{ "Backups":{ "shape":"Backups", "documentation":"

Contains the response to a DescribeBackups request.

" }, "NextToken":{ "shape":"String", "documentation":"

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeBackups again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

" } } }, "DescribeEventsRequest":{ "type":"structure", "required":["ServerName"], "members":{ "ServerName":{ "shape":"ServerName", "documentation":"

The name of the server for which you want to view events.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

" } } }, "DescribeEventsResponse":{ "type":"structure", "members":{ "ServerEvents":{ "shape":"ServerEvents", "documentation":"

Contains the response to a DescribeEvents request.

" }, "NextToken":{ "shape":"String", "documentation":"

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

" } } }, "DescribeNodeAssociationStatusRequest":{ "type":"structure", "required":[ "NodeAssociationStatusToken", "ServerName" ], "members":{ "NodeAssociationStatusToken":{"shape":"NodeAssociationStatusToken"}, "ServerName":{"shape":"ServerName"} } }, "DescribeNodeAssociationStatusResponse":{ "type":"structure", "members":{ "NodeAssociationStatus":{"shape":"NodeAssociationStatus"} } }, "DescribeServersRequest":{ "type":"structure", "members":{ "ServerName":{ "shape":"ServerName", "documentation":"

Describes the server with the specified ServerName.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeServers again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

" } } }, "DescribeServersResponse":{ "type":"structure", "members":{ "Servers":{ "shape":"Servers", "documentation":"

Contains the response to a DescribeServers request.

" }, "NextToken":{ "shape":"String", "documentation":"

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeServers again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

" } } }, "DisassociateNodeRequest":{ "type":"structure", "required":[ "ServerName", "NodeName" ], "members":{ "ServerName":{"shape":"ServerName"}, "NodeName":{"shape":"NodeName"}, "EngineAttributes":{"shape":"EngineAttributes"} } }, "DisassociateNodeResponse":{ "type":"structure", "members":{ "NodeAssociationStatusToken":{"shape":"NodeAssociationStatusToken"} } }, "EngineAttribute":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the engine attribute.

" }, "Value":{ "shape":"String", "documentation":"

The value of the engine attribute.

" } }, "documentation":"

A name/value pair that is specific to the engine of the server.

" }, "EngineAttributes":{ "type":"list", "member":{"shape":"EngineAttribute"} }, "InstanceProfileArn":{ "type":"string", "pattern":"arn:aws:iam::[0-9]{12}:instance-profile/.*" }, "Integer":{"type":"integer"}, "InvalidNextTokenException":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

Error or informational message that can contain more detail about a nextToken failure.

" } }, "documentation":"

This occurs when the provided nextToken is not valid.

", "exception":true }, "InvalidStateException":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

Error or informational message that provides more detail if a resource is in a state that is not valid for performing a specified action.

" } }, "documentation":"

The resource is in a state that does not allow you to perform a specified action.

", "exception":true }, "KeyPair":{"type":"string"}, "LimitExceededException":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

Error or informational message that the maximum allowed number of servers or backups has been exceeded.

" } }, "documentation":"

The limit of servers or backups has been reached.

", "exception":true }, "MaintenanceStatus":{ "type":"string", "enum":[ "SUCCESS", "FAILED" ] }, "MaxResults":{ "type":"integer", "min":1 }, "NextToken":{"type":"string"}, "NodeAssociationStatus":{ "type":"string", "enum":[ "SUCCESS", "FAILED", "IN_PROGRESS" ] }, "NodeAssociationStatusToken":{"type":"string"}, "NodeName":{ "type":"string", "pattern":"^[\\-\\p{Alnum}_:.]+$" }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

Error or informational message in response to a CreateServer request that a resource cannot be created because it already exists.

" } }, "documentation":"

The requested resource cannot be created because it already exists.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

Error or informational message that can contain more detail about problems locating or accessing a resource.

" } }, "documentation":"

The requested resource does not exist, or access was denied.

", "exception":true }, "RestoreServerRequest":{ "type":"structure", "required":[ "BackupId", "ServerName" ], "members":{ "BackupId":{ "shape":"BackupId", "documentation":"

The ID of the backup that you want to use to restore a server.

" }, "ServerName":{ "shape":"ServerName", "documentation":"

The name of the server that you want to restore.

" }, "InstanceType":{ "shape":"String", "documentation":"

The type of the instance to create. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, c3.large. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup.

" }, "KeyPair":{ "shape":"KeyPair", "documentation":"

The name of the key pair to set on the new EC2 instance. This can be helpful if any of the administrators who manage the server no longer have the SSH key.

" } } }, "RestoreServerResponse":{ "type":"structure", "members":{ } }, "Server":{ "type":"structure", "members":{ "BackupRetentionCount":{ "shape":"Integer", "documentation":"

The number of automated backups to keep.

" }, "ServerName":{ "shape":"String", "documentation":"

The name of the server.

" }, "CreatedAt":{ "shape":"Timestamp", "documentation":"

Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

" }, "DisableAutomatedBackup":{ "shape":"Boolean", "documentation":"

Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

" }, "Endpoint":{ "shape":"String", "documentation":"

A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io

" }, "Engine":{ "shape":"String", "documentation":"

The engine type of the server. The valid value in this release is Chef.

" }, "EngineModel":{ "shape":"String", "documentation":"

The engine model of the server. The valid value in this release is Single.

" }, "EngineAttributes":{ "shape":"EngineAttributes", "documentation":"

The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks for Chef Automate; they are returned only as part of the result of createServer().

Attributes returned in a createServer response:

  • CHEF_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

  • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

" }, "EngineVersion":{ "shape":"String", "documentation":"

The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12.

" }, "InstanceProfileArn":{ "shape":"String", "documentation":"

The instance profile ARN of the server.

" }, "InstanceType":{ "shape":"String", "documentation":"

The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.

" }, "KeyPair":{ "shape":"String", "documentation":"

The key pair associated with the server.

" }, "MaintenanceStatus":{ "shape":"MaintenanceStatus", "documentation":"

The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

" }, "PreferredMaintenanceWindow":{ "shape":"TimeWindowDefinition", "documentation":"

The preferred maintenance period specified for the server.

" }, "PreferredBackupWindow":{ "shape":"TimeWindowDefinition", "documentation":"

The preferred backup period specified for the server.

" }, "SecurityGroupIds":{ "shape":"Strings", "documentation":"

The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

" }, "ServiceRoleArn":{ "shape":"String", "documentation":"

The service role ARN used to create the server.

" }, "Status":{ "shape":"ServerStatus", "documentation":"

The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as server health.

" }, "StatusReason":{ "shape":"String", "documentation":"

Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).

" }, "SubnetIds":{ "shape":"Strings", "documentation":"

The subnet IDs specified in a CreateServer request.

" }, "ServerArn":{ "shape":"String", "documentation":"

The ARN of the server.

" } }, "documentation":"

Describes a configuration management server.

" }, "ServerEvent":{ "type":"structure", "members":{ "CreatedAt":{ "shape":"Timestamp", "documentation":"

The time when the event occurred.

" }, "ServerName":{ "shape":"String", "documentation":"

The name of the server on or for which the event occurred.

" }, "Message":{ "shape":"String", "documentation":"

A human-readable informational or status message.

" }, "LogUrl":{ "shape":"String", "documentation":"

The Amazon S3 URL of the event's log file.

" } }, "documentation":"

An event that is related to the server, such as the start of maintenance or backup.

" }, "ServerEvents":{ "type":"list", "member":{"shape":"ServerEvent"} }, "ServerName":{ "type":"string", "max":40, "min":1, "pattern":"[a-zA-Z][a-zA-Z0-9\\-]*" }, "ServerStatus":{ "type":"string", "enum":[ "BACKING_UP", "CONNECTION_LOST", "CREATING", "DELETING", "MODIFYING", "FAILED", "HEALTHY", "RUNNING", "SETUP", "UNDER_MAINTENANCE", "UNHEALTHY" ] }, "Servers":{ "type":"list", "member":{"shape":"Server"} }, "ServiceRoleArn":{ "type":"string", "pattern":"arn:aws:iam::[0-9]{12}:role/.*" }, "StartMaintenanceRequest":{ "type":"structure", "required":["ServerName"], "members":{ "ServerName":{ "shape":"ServerName", "documentation":"

The name of the server on which to run maintenance.

" } } }, "StartMaintenanceResponse":{ "type":"structure", "members":{ "Server":{ "shape":"Server", "documentation":"

Contains the response to a StartMaintenance request.

" } } }, "String":{"type":"string"}, "Strings":{ "type":"list", "member":{"shape":"String"} }, "TimeWindowDefinition":{ "type":"string", "documentation":"

DDD:HH:MM (weekly start time) or HH:MM (daily start time).

Time windows always use coordinated universal time (UTC).

Valid strings for day of week (DDD) are: Mon, Tue, Wed, Thr, Fri, Sat, Sun.

", "pattern":"^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$" }, "Timestamp":{"type":"timestamp"}, "UpdateServerEngineAttributesRequest":{ "type":"structure", "required":[ "ServerName", "AttributeName" ], "members":{ "ServerName":{ "shape":"ServerName", "documentation":"

The name of the server to update.

" }, "AttributeName":{ "shape":"AttributeName", "documentation":"

The name of the engine attribute to update.

" }, "AttributeValue":{ "shape":"AttributeValue", "documentation":"

The value to set for the attribute.

" } } }, "UpdateServerEngineAttributesResponse":{ "type":"structure", "members":{ "Server":{ "shape":"Server", "documentation":"

Contains the response to an UpdateServerEngineAttributes request.

" } } }, "UpdateServerRequest":{ "type":"structure", "required":["ServerName"], "members":{ "DisableAutomatedBackup":{ "shape":"Boolean", "documentation":"

Setting DisableAutomatedBackup to true disables automated or scheduled backups. Automated backups are enabled by default.

" }, "BackupRetentionCount":{ "shape":"Integer", "documentation":"

Sets the number of automated backups that you want to keep.

" }, "ServerName":{ "shape":"ServerName", "documentation":"

The name of the server to update.

" }, "PreferredMaintenanceWindow":{"shape":"TimeWindowDefinition"}, "PreferredBackupWindow":{"shape":"TimeWindowDefinition"} } }, "UpdateServerResponse":{ "type":"structure", "members":{ "Server":{ "shape":"Server", "documentation":"

Contains the response to a UpdateServer request.

" } } }, "ValidationException":{ "type":"structure", "members":{ "Message":{ "shape":"String", "documentation":"

Error or informational message that can contain more detail about a validation failure.

" } }, "documentation":"

One or more of the provided request parameters are not valid.

", "exception":true } }, "documentation":"AWS OpsWorks for Chef Automate

A service that runs and manages configuration management servers.

Glossary of terms

  • Server: A server is a configuration management server, and can be highly-available. The configuration manager runs on your instances by using various AWS services, such as Amazon Elastic Compute Cloud (EC2), and potentially Amazon Relational Database Service (RDS). A server is a generic abstraction over the configuration manager that you want to use, much like Amazon RDS. In AWS OpsWorks for Chef Automate, you do not start or stop servers. After you create servers, they continue to run until they are deleted.

  • Engine: The specific configuration manager that you want to use (such as Chef) is the engine.

  • Backup: This is an application-level backup of the data that the configuration manager stores. A backup creates a .tar.gz file that is stored in an Amazon Simple Storage Service (S3) bucket in your account. AWS OpsWorks for Chef Automate creates the S3 bucket when you launch the first instance. A backup maintains a snapshot of all of a server's important attributes at the time of the backup.

  • Events: Events are always related to a server. Events are written during server creation, when health checks run, when backups are created, etc. When you delete a server, the server's events are also deleted.

  • AccountAttributes: Every account has attributes that are assigned in the AWS OpsWorks for Chef Automate database. These attributes store information about configuration limits (servers, backups, etc.) and your customer account.

Throttling limits

All API operations allow for 5 requests per second with a burst of 10 requests per second.

" } botocore-1.5.7/botocore/data/sms/0000777454262600001440000000000013042511307017735 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/sms/2016-10-24/0000777454262600001440000000000013042511307020766 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/sms/2016-10-24/service-2.json0000666454262600001440000005652613042511306023475 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"sms-2016-10-24", "apiVersion":"2016-10-24", "endpointPrefix":"sms", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"SMS", "serviceFullName":"AWS Server Migration Service", "signatureVersion":"v4", "targetPrefix":"AWSServerMigrationService_V2016_10_24" }, "operations":{ "CreateReplicationJob":{ "name":"CreateReplicationJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateReplicationJobRequest"}, "output":{"shape":"CreateReplicationJobResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"MissingRequiredParameterException"}, {"shape":"UnauthorizedOperationException"}, {"shape":"OperationNotPermittedException"}, {"shape":"ServerCannotBeReplicatedException"}, {"shape":"ReplicationJobAlreadyExistsException"}, {"shape":"NoConnectorsAvailableException"}, {"shape":"InternalError"} ], "documentation":"The CreateReplicationJob API is used to create a ReplicationJob to replicate a server on AWS. Call this API to first create a ReplicationJob, which will then schedule periodic ReplicationRuns to replicate your server to AWS. Each ReplicationRun will result in the creation of an AWS AMI." }, "DeleteReplicationJob":{ "name":"DeleteReplicationJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteReplicationJobRequest"}, "output":{"shape":"DeleteReplicationJobResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"MissingRequiredParameterException"}, {"shape":"UnauthorizedOperationException"}, {"shape":"OperationNotPermittedException"}, {"shape":"ReplicationJobNotFoundException"} ], "documentation":"The DeleteReplicationJob API is used to delete a ReplicationJob, resulting in no further ReplicationRuns. This will delete the contents of the S3 bucket used to store SMS artifacts, but will not delete any AMIs created by the SMS service." }, "DeleteServerCatalog":{ "name":"DeleteServerCatalog", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteServerCatalogRequest"}, "output":{"shape":"DeleteServerCatalogResponse"}, "errors":[ {"shape":"UnauthorizedOperationException"}, {"shape":"OperationNotPermittedException"}, {"shape":"InvalidParameterException"}, {"shape":"MissingRequiredParameterException"} ], "documentation":"The DeleteServerCatalog API clears all servers from your server catalog. This means that these servers will no longer be accessible to the Server Migration Service." }, "DisassociateConnector":{ "name":"DisassociateConnector", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateConnectorRequest"}, "output":{"shape":"DisassociateConnectorResponse"}, "errors":[ {"shape":"MissingRequiredParameterException"}, {"shape":"UnauthorizedOperationException"}, {"shape":"OperationNotPermittedException"}, {"shape":"InvalidParameterException"} ], "documentation":"The DisassociateConnector API will disassociate a connector from the Server Migration Service, rendering it unavailable to support replication jobs." }, "GetConnectors":{ "name":"GetConnectors", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetConnectorsRequest"}, "output":{"shape":"GetConnectorsResponse"}, "errors":[ {"shape":"UnauthorizedOperationException"} ], "documentation":"The GetConnectors API returns a list of connectors that are registered with the Server Migration Service." }, "GetReplicationJobs":{ "name":"GetReplicationJobs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetReplicationJobsRequest"}, "output":{"shape":"GetReplicationJobsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"MissingRequiredParameterException"}, {"shape":"UnauthorizedOperationException"} ], "documentation":"The GetReplicationJobs API will return all of your ReplicationJobs and their details. This API returns a paginated list, that may be consecutively called with nextToken to retrieve all ReplicationJobs." }, "GetReplicationRuns":{ "name":"GetReplicationRuns", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetReplicationRunsRequest"}, "output":{"shape":"GetReplicationRunsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"MissingRequiredParameterException"}, {"shape":"UnauthorizedOperationException"} ], "documentation":"The GetReplicationRuns API will return all ReplicationRuns for a given ReplicationJob. This API returns a paginated list, that may be consecutively called with nextToken to retrieve all ReplicationRuns for a ReplicationJob." }, "GetServers":{ "name":"GetServers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetServersRequest"}, "output":{"shape":"GetServersResponse"}, "errors":[ {"shape":"UnauthorizedOperationException"} ], "documentation":"The GetServers API returns a list of all servers in your server catalog. For this call to succeed, you must previously have called ImportServerCatalog." }, "ImportServerCatalog":{ "name":"ImportServerCatalog", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportServerCatalogRequest"}, "output":{"shape":"ImportServerCatalogResponse"}, "errors":[ {"shape":"UnauthorizedOperationException"}, {"shape":"OperationNotPermittedException"}, {"shape":"InvalidParameterException"}, {"shape":"MissingRequiredParameterException"}, {"shape":"NoConnectorsAvailableException"} ], "documentation":"The ImportServerCatalog API is used to gather the complete list of on-premises servers on your premises. This API call requires connectors to be installed and monitoring all servers you would like imported. This API call returns immediately, but may take some time to retrieve all of the servers." }, "StartOnDemandReplicationRun":{ "name":"StartOnDemandReplicationRun", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartOnDemandReplicationRunRequest"}, "output":{"shape":"StartOnDemandReplicationRunResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"MissingRequiredParameterException"}, {"shape":"UnauthorizedOperationException"}, {"shape":"OperationNotPermittedException"}, {"shape":"ReplicationRunLimitExceededException"} ], "documentation":"The StartOnDemandReplicationRun API is used to start a ReplicationRun on demand (in addition to those that are scheduled based on your frequency). This ReplicationRun will start immediately. StartOnDemandReplicationRun is subject to limits on how many on demand ReplicationRuns you may call per 24-hour period." }, "UpdateReplicationJob":{ "name":"UpdateReplicationJob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateReplicationJobRequest"}, "output":{"shape":"UpdateReplicationJobResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"MissingRequiredParameterException"}, {"shape":"OperationNotPermittedException"}, {"shape":"UnauthorizedOperationException"}, {"shape":"ServerCannotBeReplicatedException"}, {"shape":"ReplicationJobNotFoundException"}, {"shape":"InternalError"} ], "documentation":"The UpdateReplicationJob API is used to change the settings of your existing ReplicationJob created using CreateReplicationJob. Calling this API will affect the next scheduled ReplicationRun." } }, "shapes":{ "AmiId":{ "type":"string", "documentation":"The AMI id for the image resulting from a Replication Run." }, "Connector":{ "type":"structure", "members":{ "connectorId":{"shape":"ConnectorId"}, "version":{"shape":"ConnectorVersion"}, "status":{"shape":"ConnectorStatus"}, "capabilityList":{"shape":"ConnectorCapabilityList"}, "vmManagerName":{"shape":"VmManagerName"}, "vmManagerType":{"shape":"VmManagerType"}, "vmManagerId":{"shape":"VmManagerId"}, "ipAddress":{"shape":"IpAddress"}, "macAddress":{"shape":"MacAddress"}, "associatedOn":{"shape":"Timestamp"} }, "documentation":"Object representing a Connector" }, "ConnectorCapability":{ "type":"string", "documentation":"Capabilities for a Connector", "enum":["VSPHERE"] }, "ConnectorCapabilityList":{ "type":"list", "member":{ "shape":"ConnectorCapability", "locationName":"item" }, "documentation":"List of Connector Capabilities" }, "ConnectorId":{ "type":"string", "documentation":"Unique Identifier for Connector" }, "ConnectorList":{ "type":"list", "member":{ "shape":"Connector", "locationName":"item" }, "documentation":"List of connectors" }, "ConnectorStatus":{ "type":"string", "documentation":"Status of on-premise Connector", "enum":[ "HEALTHY", "UNHEALTHY" ] }, "ConnectorVersion":{ "type":"string", "documentation":"Connector version string" }, "CreateReplicationJobRequest":{ "type":"structure", "required":[ "serverId", "seedReplicationTime", "frequency" ], "members":{ "serverId":{"shape":"ServerId"}, "seedReplicationTime":{"shape":"Timestamp"}, "frequency":{"shape":"Frequency"}, "licenseType":{"shape":"LicenseType"}, "roleName":{"shape":"RoleName"}, "description":{"shape":"Description"} } }, "CreateReplicationJobResponse":{ "type":"structure", "members":{ "replicationJobId":{"shape":"ReplicationJobId"} } }, "DeleteReplicationJobRequest":{ "type":"structure", "required":["replicationJobId"], "members":{ "replicationJobId":{"shape":"ReplicationJobId"} } }, "DeleteReplicationJobResponse":{ "type":"structure", "members":{ } }, "DeleteServerCatalogRequest":{ "type":"structure", "members":{ } }, "DeleteServerCatalogResponse":{ "type":"structure", "members":{ } }, "Description":{ "type":"string", "documentation":"The description for a Replication Job/Run." }, "DisassociateConnectorRequest":{ "type":"structure", "required":["connectorId"], "members":{ "connectorId":{"shape":"ConnectorId"} } }, "DisassociateConnectorResponse":{ "type":"structure", "members":{ } }, "ErrorMessage":{ "type":"string", "documentation":"Error Message string" }, "Frequency":{ "type":"integer", "documentation":"Interval between Replication Runs. This value is specified in hours, and represents the time between consecutive Replication Runs." }, "GetConnectorsRequest":{ "type":"structure", "members":{ "nextToken":{"shape":"NextToken"}, "maxResults":{"shape":"MaxResults"} } }, "GetConnectorsResponse":{ "type":"structure", "members":{ "connectorList":{"shape":"ConnectorList"}, "nextToken":{"shape":"NextToken"} } }, "GetReplicationJobsRequest":{ "type":"structure", "members":{ "replicationJobId":{"shape":"ReplicationJobId"}, "nextToken":{"shape":"NextToken"}, "maxResults":{"shape":"MaxResults"} } }, "GetReplicationJobsResponse":{ "type":"structure", "members":{ "replicationJobList":{"shape":"ReplicationJobList"}, "nextToken":{"shape":"NextToken"} } }, "GetReplicationRunsRequest":{ "type":"structure", "required":["replicationJobId"], "members":{ "replicationJobId":{"shape":"ReplicationJobId"}, "nextToken":{"shape":"NextToken"}, "maxResults":{"shape":"MaxResults"} } }, "GetReplicationRunsResponse":{ "type":"structure", "members":{ "replicationJob":{"shape":"ReplicationJob"}, "replicationRunList":{"shape":"ReplicationRunList"}, "nextToken":{"shape":"NextToken"} } }, "GetServersRequest":{ "type":"structure", "members":{ "nextToken":{"shape":"NextToken"}, "maxResults":{"shape":"MaxResults"} } }, "GetServersResponse":{ "type":"structure", "members":{ "lastModifiedOn":{"shape":"Timestamp"}, "serverCatalogStatus":{"shape":"ServerCatalogStatus"}, "serverList":{"shape":"ServerList"}, "nextToken":{"shape":"NextToken"} } }, "ImportServerCatalogRequest":{ "type":"structure", "members":{ } }, "ImportServerCatalogResponse":{ "type":"structure", "members":{ } }, "InternalError":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"An internal error has occured.", "exception":true, "fault":true }, "InvalidParameterException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"A parameter specified in the request is not valid, is unsupported, or cannot be used.", "exception":true }, "IpAddress":{ "type":"string", "documentation":"Internet Protocol (IP) Address" }, "LicenseType":{ "type":"string", "documentation":"The license type to be used for the Amazon Machine Image (AMI) created after a successful ReplicationRun.", "enum":[ "AWS", "BYOL" ] }, "MacAddress":{ "type":"string", "documentation":"Hardware (MAC) address" }, "MaxResults":{ "type":"integer", "documentation":"The maximum number of results to return in one API call. If left empty, this will default to 50." }, "MissingRequiredParameterException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request.", "exception":true }, "NextToken":{ "type":"string", "documentation":"Pagination token to pass as input to API call" }, "NoConnectorsAvailableException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"No connectors are available to handle this request. Please associate connector(s) and verify any existing connectors are healthy and can respond to requests.", "exception":true }, "OperationNotPermittedException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The specified operation is not allowed. This error can occur for a number of reasons; for example, you might be trying to start a Replication Run before seed Replication Run.", "exception":true }, "ReplicationJob":{ "type":"structure", "members":{ "replicationJobId":{"shape":"ReplicationJobId"}, "serverId":{"shape":"ServerId"}, "serverType":{"shape":"ServerType"}, "vmServer":{"shape":"VmServer"}, "seedReplicationTime":{"shape":"Timestamp"}, "frequency":{"shape":"Frequency"}, "nextReplicationRunStartTime":{"shape":"Timestamp"}, "licenseType":{"shape":"LicenseType"}, "roleName":{"shape":"RoleName"}, "latestAmiId":{"shape":"AmiId"}, "state":{"shape":"ReplicationJobState"}, "statusMessage":{"shape":"ReplicationJobStatusMessage"}, "description":{"shape":"Description"}, "replicationRunList":{"shape":"ReplicationRunList"} }, "documentation":"Object representing a Replication Job" }, "ReplicationJobAlreadyExistsException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"An active Replication Job already exists for the specified server.", "exception":true }, "ReplicationJobId":{ "type":"string", "documentation":"The unique identifier for a Replication Job." }, "ReplicationJobList":{ "type":"list", "member":{ "shape":"ReplicationJob", "locationName":"item" }, "documentation":"List of Replication Jobs" }, "ReplicationJobNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The specified Replication Job cannot be found.", "exception":true }, "ReplicationJobState":{ "type":"string", "documentation":"Current state of Replication Job", "enum":[ "PENDING", "ACTIVE", "FAILED", "DELETING", "DELETED" ] }, "ReplicationJobStatusMessage":{ "type":"string", "documentation":"String describing current status of Replication Job" }, "ReplicationJobTerminated":{ "type":"boolean", "documentation":"An indicator of the Replication Job being deleted or failed." }, "ReplicationRun":{ "type":"structure", "members":{ "replicationRunId":{"shape":"ReplicationRunId"}, "state":{"shape":"ReplicationRunState"}, "type":{"shape":"ReplicationRunType"}, "statusMessage":{"shape":"ReplicationRunStatusMessage"}, "amiId":{"shape":"AmiId"}, "scheduledStartTime":{"shape":"Timestamp"}, "completedTime":{"shape":"Timestamp"}, "description":{"shape":"Description"} }, "documentation":"Object representing a Replication Run" }, "ReplicationRunId":{ "type":"string", "documentation":"The unique identifier for a Replication Run." }, "ReplicationRunLimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"This user has exceeded the maximum allowed Replication Run limit.", "exception":true }, "ReplicationRunList":{ "type":"list", "member":{ "shape":"ReplicationRun", "locationName":"item" }, "documentation":"List of Replication Runs" }, "ReplicationRunState":{ "type":"string", "documentation":"Current state of Replication Run", "enum":[ "PENDING", "MISSED", "ACTIVE", "FAILED", "COMPLETED", "DELETING", "DELETED" ] }, "ReplicationRunStatusMessage":{ "type":"string", "documentation":"String describing current status of Replication Run" }, "ReplicationRunType":{ "type":"string", "documentation":"Type of Replication Run", "enum":[ "ON_DEMAND", "AUTOMATIC" ] }, "RoleName":{ "type":"string", "documentation":"Name of service role in customer's account to be used by SMS service." }, "Server":{ "type":"structure", "members":{ "serverId":{"shape":"ServerId"}, "serverType":{"shape":"ServerType"}, "vmServer":{"shape":"VmServer"}, "replicationJobId":{"shape":"ReplicationJobId"}, "replicationJobTerminated":{"shape":"ReplicationJobTerminated"} }, "documentation":"Object representing a server" }, "ServerCannotBeReplicatedException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"The provided server cannot be replicated.", "exception":true }, "ServerCatalogStatus":{ "type":"string", "documentation":"Status of Server catalog", "enum":[ "NOT_IMPORTED", "IMPORTING", "AVAILABLE", "DELETED", "EXPIRED" ] }, "ServerId":{ "type":"string", "documentation":"Unique Identifier for a server" }, "ServerList":{ "type":"list", "member":{ "shape":"Server", "locationName":"item" }, "documentation":"List of servers from catalog" }, "ServerType":{ "type":"string", "documentation":"Type of server.", "enum":["VIRTUAL_MACHINE"] }, "StartOnDemandReplicationRunRequest":{ "type":"structure", "required":["replicationJobId"], "members":{ "replicationJobId":{"shape":"ReplicationJobId"}, "description":{"shape":"Description"} } }, "StartOnDemandReplicationRunResponse":{ "type":"structure", "members":{ "replicationRunId":{"shape":"ReplicationRunId"} } }, "Timestamp":{ "type":"timestamp", "documentation":"Timestamp of an operation" }, "UnauthorizedOperationException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, "documentation":"This user does not have permissions to perform this operation.", "exception":true }, "UpdateReplicationJobRequest":{ "type":"structure", "required":["replicationJobId"], "members":{ "replicationJobId":{"shape":"ReplicationJobId"}, "frequency":{"shape":"Frequency"}, "nextReplicationRunStartTime":{"shape":"Timestamp"}, "licenseType":{"shape":"LicenseType"}, "roleName":{"shape":"RoleName"}, "description":{"shape":"Description"} } }, "UpdateReplicationJobResponse":{ "type":"structure", "members":{ } }, "VmId":{ "type":"string", "documentation":"Unique Identifier for a VM" }, "VmManagerId":{ "type":"string", "documentation":"Unique Identifier for VM Manager" }, "VmManagerName":{ "type":"string", "documentation":"VM Manager Name" }, "VmManagerType":{ "type":"string", "documentation":"VM Management Product", "enum":["VSPHERE"] }, "VmName":{ "type":"string", "documentation":"Name of Virtual Machine" }, "VmPath":{ "type":"string", "documentation":"Path to VM" }, "VmServer":{ "type":"structure", "members":{ "vmServerAddress":{"shape":"VmServerAddress"}, "vmName":{"shape":"VmName"}, "vmManagerName":{"shape":"VmManagerName"}, "vmManagerType":{"shape":"VmManagerType"}, "vmPath":{"shape":"VmPath"} }, "documentation":"Object representing a VM server" }, "VmServerAddress":{ "type":"structure", "members":{ "vmManagerId":{"shape":"VmManagerId"}, "vmId":{"shape":"VmId"} }, "documentation":"Object representing a server's location" } }, "documentation":"Amazon Server Migration Service automates the process of migrating servers to EC2." } botocore-1.5.7/botocore/data/dynamodbstreams/0000777454262600001440000000000013042511307022327 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/dynamodbstreams/2012-08-10/0000777454262600001440000000000013042511307023356 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/dynamodbstreams/2012-08-10/service-2.json0000666454262600001440000007236313042511306026062 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2012-08-10", "endpointPrefix":"streams.dynamodb", "jsonVersion":"1.0", "protocol":"json", "serviceFullName":"Amazon DynamoDB Streams", "signatureVersion":"v4", "signingName":"dynamodb", "targetPrefix":"DynamoDBStreams_20120810", "uid":"streams-dynamodb-2012-08-10" }, "operations":{ "DescribeStream":{ "name":"DescribeStream", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStreamInput"}, "output":{"shape":"DescribeStreamOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.

You can call DescribeStream at a maximum rate of 10 times per second.

Each shard in the stream has a SequenceNumberRange associated with it. If the SequenceNumberRange has a StartingSequenceNumber but no EndingSequenceNumber, then the shard is still open (able to receive more stream records). If both StartingSequenceNumber and EndingSequenceNumber are present, then that shard is closed and can no longer receive more data.

" }, "GetRecords":{ "name":"GetRecords", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRecordsInput"}, "output":{"shape":"GetRecordsOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"InternalServerError"}, {"shape":"ExpiredIteratorException"}, {"shape":"TrimmedDataAccessException"} ], "documentation":"

Retrieves the stream records from a given shard.

Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records.

GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes first.

" }, "GetShardIterator":{ "name":"GetShardIterator", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetShardIteratorInput"}, "output":{"shape":"GetShardIteratorOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerError"}, {"shape":"TrimmedDataAccessException"} ], "documentation":"

Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent GetRecords request to read the stream records from the shard.

A shard iterator expires 15 minutes after it is returned to the requester.

" }, "ListStreams":{ "name":"ListStreams", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListStreamsInput"}, "output":{"shape":"ListStreamsOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerError"} ], "documentation":"

Returns an array of stream ARNs associated with the current account and endpoint. If the TableName parameter is present, then ListStreams will return only the streams ARNs for that table.

You can call ListStreams at a maximum rate of 5 times per second.

" } }, "shapes":{ "AttributeMap":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValue"} }, "AttributeName":{ "type":"string", "max":65535 }, "AttributeValue":{ "type":"structure", "members":{ "S":{ "shape":"StringAttributeValue", "documentation":"

A String data type.

" }, "N":{ "shape":"NumberAttributeValue", "documentation":"

A Number data type.

" }, "B":{ "shape":"BinaryAttributeValue", "documentation":"

A Binary data type.

" }, "SS":{ "shape":"StringSetAttributeValue", "documentation":"

A String Set data type.

" }, "NS":{ "shape":"NumberSetAttributeValue", "documentation":"

A Number Set data type.

" }, "BS":{ "shape":"BinarySetAttributeValue", "documentation":"

A Binary Set data type.

" }, "M":{ "shape":"MapAttributeValue", "documentation":"

A Map data type.

" }, "L":{ "shape":"ListAttributeValue", "documentation":"

A List data type.

" }, "NULL":{ "shape":"NullAttributeValue", "documentation":"

A Null data type.

" }, "BOOL":{ "shape":"BooleanAttributeValue", "documentation":"

A Boolean data type.

" } }, "documentation":"

Represents the data for an attribute. You can set one, and only one, of the elements.

Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.

" }, "BinaryAttributeValue":{"type":"blob"}, "BinarySetAttributeValue":{ "type":"list", "member":{"shape":"BinaryAttributeValue"} }, "BooleanAttributeValue":{"type":"boolean"}, "Date":{"type":"timestamp"}, "DescribeStreamInput":{ "type":"structure", "required":["StreamArn"], "members":{ "StreamArn":{ "shape":"StreamArn", "documentation":"

The Amazon Resource Name (ARN) for the stream.

" }, "Limit":{ "shape":"PositiveIntegerObject", "documentation":"

The maximum number of shard objects to return. The upper limit is 100.

" }, "ExclusiveStartShardId":{ "shape":"ShardId", "documentation":"

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

" } }, "documentation":"

Represents the input of a DescribeStream operation.

" }, "DescribeStreamOutput":{ "type":"structure", "members":{ "StreamDescription":{ "shape":"StreamDescription", "documentation":"

A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards.

" } }, "documentation":"

Represents the output of a DescribeStream operation.

" }, "ErrorMessage":{"type":"string"}, "ExpiredIteratorException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The provided iterator exceeds the maximum age allowed.

" } }, "documentation":"

The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the GetShardIterator action.

", "exception":true }, "GetRecordsInput":{ "type":"structure", "required":["ShardIterator"], "members":{ "ShardIterator":{ "shape":"ShardIterator", "documentation":"

A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.

" }, "Limit":{ "shape":"PositiveIntegerObject", "documentation":"

The maximum number of records to return from the shard. The upper limit is 1000.

" } }, "documentation":"

Represents the input of a GetRecords operation.

" }, "GetRecordsOutput":{ "type":"structure", "members":{ "Records":{ "shape":"RecordList", "documentation":"

The stream records from the shard, which were retrieved using the shard iterator.

" }, "NextShardIterator":{ "shape":"ShardIterator", "documentation":"

The next position in the shard from which to start sequentially reading stream records. If set to null, the shard has been closed and the requested iterator will not return any more data.

" } }, "documentation":"

Represents the output of a GetRecords operation.

" }, "GetShardIteratorInput":{ "type":"structure", "required":[ "StreamArn", "ShardId", "ShardIteratorType" ], "members":{ "StreamArn":{ "shape":"StreamArn", "documentation":"

The Amazon Resource Name (ARN) for the stream.

" }, "ShardId":{ "shape":"ShardId", "documentation":"

The identifier of the shard. The iterator will be returned for this shard ID.

" }, "ShardIteratorType":{ "shape":"ShardIteratorType", "documentation":"

Determines how the shard iterator is used to start reading stream records from the shard:

  • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

  • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

  • LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

" }, "SequenceNumber":{ "shape":"SequenceNumber", "documentation":"

The sequence number of a stream record in the shard from which to start reading.

" } }, "documentation":"

Represents the input of a GetShardIterator operation.

" }, "GetShardIteratorOutput":{ "type":"structure", "members":{ "ShardIterator":{ "shape":"ShardIterator", "documentation":"

The position in the shard from which to start reading stream records sequentially. A shard iterator specifies this position using the sequence number of a stream record in a shard.

" } }, "documentation":"

Represents the output of a GetShardIterator operation.

" }, "InternalServerError":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The server encountered an internal error trying to fulfill the request.

" } }, "documentation":"

An error occurred on the server side.

", "exception":true, "fault":true }, "KeySchema":{ "type":"list", "member":{"shape":"KeySchemaElement"}, "max":2, "min":1 }, "KeySchemaAttributeName":{ "type":"string", "max":255, "min":1 }, "KeySchemaElement":{ "type":"structure", "required":[ "AttributeName", "KeyType" ], "members":{ "AttributeName":{ "shape":"KeySchemaAttributeName", "documentation":"

The name of a key attribute.

" }, "KeyType":{ "shape":"KeyType", "documentation":"

The attribute data, consisting of the data type and the attribute value itself.

" } }, "documentation":"

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.

A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key (partition key) would be represented by one KeySchemaElement. A composite primary key (partition key and sort key) would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.

The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

" }, "KeyType":{ "type":"string", "enum":[ "HASH", "RANGE" ] }, "LimitExceededException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

Too many operations for a given subscriber.

" } }, "documentation":"

Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

", "exception":true }, "ListAttributeValue":{ "type":"list", "member":{"shape":"AttributeValue"} }, "ListStreamsInput":{ "type":"structure", "members":{ "TableName":{ "shape":"TableName", "documentation":"

If this parameter is provided, then only the streams associated with this table name are returned.

" }, "Limit":{ "shape":"PositiveIntegerObject", "documentation":"

The maximum number of streams to return. The upper limit is 100.

" }, "ExclusiveStartStreamArn":{ "shape":"StreamArn", "documentation":"

The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedStreamArn in the previous operation.

" } }, "documentation":"

Represents the input of a ListStreams operation.

" }, "ListStreamsOutput":{ "type":"structure", "members":{ "Streams":{ "shape":"StreamList", "documentation":"

A list of stream descriptors associated with the current account and endpoint.

" }, "LastEvaluatedStreamArn":{ "shape":"StreamArn", "documentation":"

The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedStreamArn is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedStreamArn is not empty, it 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 LastEvaluatedStreamArn is empty.

" } }, "documentation":"

Represents the output of a ListStreams operation.

" }, "MapAttributeValue":{ "type":"map", "key":{"shape":"AttributeName"}, "value":{"shape":"AttributeValue"} }, "NullAttributeValue":{"type":"boolean"}, "NumberAttributeValue":{"type":"string"}, "NumberSetAttributeValue":{ "type":"list", "member":{"shape":"NumberAttributeValue"} }, "OperationType":{ "type":"string", "enum":[ "INSERT", "MODIFY", "REMOVE" ] }, "PositiveIntegerObject":{ "type":"integer", "min":1 }, "PositiveLongObject":{ "type":"long", "min":1 }, "Record":{ "type":"structure", "members":{ "eventID":{ "shape":"String", "documentation":"

A globally unique identifier for the event that was recorded in this stream record.

" }, "eventName":{ "shape":"OperationType", "documentation":"

The type of data modification that was performed on the DynamoDB table:

  • INSERT - a new item was added to the table.

  • MODIFY - one or more of an existing item's attributes were modified.

  • REMOVE - the item was deleted from the table

" }, "eventVersion":{ "shape":"String", "documentation":"

The version number of the stream record format. This number is updated whenever the structure of Record is modified.

Client applications must not assume that eventVersion will remain at a particular value, as this number is subject to change at any time. In general, eventVersion will only increase as the low-level DynamoDB Streams API evolves.

" }, "eventSource":{ "shape":"String", "documentation":"

The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.

" }, "awsRegion":{ "shape":"String", "documentation":"

The region in which the GetRecords request was received.

" }, "dynamodb":{ "shape":"StreamRecord", "documentation":"

The main body of the stream record, containing all of the DynamoDB-specific fields.

" } }, "documentation":"

A description of a unique event within a stream.

" }, "RecordList":{ "type":"list", "member":{"shape":"Record"} }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

The resource which is being requested does not exist.

" } }, "documentation":"

The operation tried to access a nonexistent stream.

", "exception":true }, "SequenceNumber":{ "type":"string", "max":40, "min":21 }, "SequenceNumberRange":{ "type":"structure", "members":{ "StartingSequenceNumber":{ "shape":"SequenceNumber", "documentation":"

The first sequence number.

" }, "EndingSequenceNumber":{ "shape":"SequenceNumber", "documentation":"

The last sequence number.

" } }, "documentation":"

The beginning and ending sequence numbers for the stream records contained within a shard.

" }, "Shard":{ "type":"structure", "members":{ "ShardId":{ "shape":"ShardId", "documentation":"

The system-generated identifier for this shard.

" }, "SequenceNumberRange":{ "shape":"SequenceNumberRange", "documentation":"

The range of possible sequence numbers for the shard.

" }, "ParentShardId":{ "shape":"ShardId", "documentation":"

The shard ID of the current shard's parent.

" } }, "documentation":"

A uniquely identified group of stream records within a stream.

" }, "ShardDescriptionList":{ "type":"list", "member":{"shape":"Shard"} }, "ShardId":{ "type":"string", "max":65, "min":28 }, "ShardIterator":{ "type":"string", "max":2048, "min":1 }, "ShardIteratorType":{ "type":"string", "enum":[ "TRIM_HORIZON", "LATEST", "AT_SEQUENCE_NUMBER", "AFTER_SEQUENCE_NUMBER" ] }, "Stream":{ "type":"structure", "members":{ "StreamArn":{ "shape":"StreamArn", "documentation":"

The Amazon Resource Name (ARN) for the stream.

" }, "TableName":{ "shape":"TableName", "documentation":"

The DynamoDB table with which the stream is associated.

" }, "StreamLabel":{ "shape":"String", "documentation":"

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • the AWS customer ID.

  • the table name

  • the StreamLabel

" } }, "documentation":"

Represents all of the data describing a particular stream.

" }, "StreamArn":{ "type":"string", "max":1024, "min":37 }, "StreamDescription":{ "type":"structure", "members":{ "StreamArn":{ "shape":"StreamArn", "documentation":"

The Amazon Resource Name (ARN) for the stream.

" }, "StreamLabel":{ "shape":"String", "documentation":"

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • the AWS customer ID.

  • the table name

  • the StreamLabel

" }, "StreamStatus":{ "shape":"StreamStatus", "documentation":"

Indicates the current status of the stream:

  • ENABLING - Streams is currently being enabled on the DynamoDB table.

  • ENABLED - the stream is enabled.

  • DISABLING - Streams is currently being disabled on the DynamoDB table.

  • DISABLED - the stream is disabled.

" }, "StreamViewType":{ "shape":"StreamViewType", "documentation":"

Indicates the format of the records within this stream:

  • KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.

  • NEW_IMAGE - entire items from the table, as they appeared after they were modified.

  • OLD_IMAGE - entire items from the table, as they appeared before they were modified.

  • NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.

" }, "CreationRequestDateTime":{ "shape":"Date", "documentation":"

The date and time when the request to create this stream was issued.

" }, "TableName":{ "shape":"TableName", "documentation":"

The DynamoDB table with which the stream is associated.

" }, "KeySchema":{ "shape":"KeySchema", "documentation":"

The key attribute(s) of the stream's DynamoDB table.

" }, "Shards":{ "shape":"ShardDescriptionList", "documentation":"

The shards that comprise the stream.

" }, "LastEvaluatedShardId":{ "shape":"ShardId", "documentation":"

The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedShardId is empty, then the \"last page\" of results has been processed and there is currently no more data to be retrieved.

If LastEvaluatedShardId is not empty, it 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 LastEvaluatedShardId is empty.

" } }, "documentation":"

Represents all of the data describing a particular stream.

" }, "StreamList":{ "type":"list", "member":{"shape":"Stream"} }, "StreamRecord":{ "type":"structure", "members":{ "ApproximateCreationDateTime":{ "shape":"Date", "documentation":"

The approximate date and time when the stream record was created, in UNIX epoch time format.

" }, "Keys":{ "shape":"AttributeMap", "documentation":"

The primary key attribute(s) for the DynamoDB item that was modified.

" }, "NewImage":{ "shape":"AttributeMap", "documentation":"

The item in the DynamoDB table as it appeared after it was modified.

" }, "OldImage":{ "shape":"AttributeMap", "documentation":"

The item in the DynamoDB table as it appeared before it was modified.

" }, "SequenceNumber":{ "shape":"SequenceNumber", "documentation":"

The sequence number of the stream record.

" }, "SizeBytes":{ "shape":"PositiveLongObject", "documentation":"

The size of the stream record, in bytes.

" }, "StreamViewType":{ "shape":"StreamViewType", "documentation":"

The type of data from the modified DynamoDB item that was captured in this stream record:

  • KEYS_ONLY - only the key attributes of the modified item.

  • NEW_IMAGE - the entire item, as it appeared after it was modified.

  • OLD_IMAGE - the entire item, as it appeared before it was modified.

  • NEW_AND_OLD_IMAGES - both the new and the old item images of the item.

" } }, "documentation":"

A description of a single data modification that was performed on an item in a DynamoDB table.

" }, "StreamStatus":{ "type":"string", "enum":[ "ENABLING", "ENABLED", "DISABLING", "DISABLED" ] }, "StreamViewType":{ "type":"string", "enum":[ "NEW_IMAGE", "OLD_IMAGE", "NEW_AND_OLD_IMAGES", "KEYS_ONLY" ] }, "String":{"type":"string"}, "StringAttributeValue":{"type":"string"}, "StringSetAttributeValue":{ "type":"list", "member":{"shape":"StringAttributeValue"} }, "TableName":{ "type":"string", "max":255, "min":3, "pattern":"[a-zA-Z0-9_.-]+" }, "TrimmedDataAccessException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

\"The data you are trying to access has been trimmed.

" } }, "documentation":"

The operation attempted to read past the oldest stream record in a shard.

In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:

  • You request a shard iterator with a sequence number older than the trim point (24 hours).

  • You obtain a shard iterator, but before you use the iterator in a GetRecords request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.

", "exception":true } }, "documentation":"Amazon DynamoDB

Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see Capturing Table Activity with DynamoDB Streams in the Amazon DynamoDB Developer Guide.

The following are short descriptions of each low-level DynamoDB Streams action:

  • DescribeStream - Returns detailed information about a particular stream.

  • GetRecords - Retrieves the stream records from within a shard.

  • GetShardIterator - Returns information on how to retrieve the streams record from a shard with a given shard ID.

  • ListStreams - Returns a list of all the streams associated with the current AWS account and endpoint.

" } botocore-1.5.7/botocore/data/endpoints.json0000666454262600001440000013431413042511306022036 0ustar pysdk-ciamazon00000000000000{ "partitions": [ { "defaults": { "hostname": "{service}.{region}.{dnsSuffix}", "protocols": [ "https" ], "signatureVersions": [ "v4" ] }, "dnsSuffix": "amazonaws.com", "partition": "aws", "partitionName": "AWS Standard", "regionRegex": "^(us|eu|ap|sa|ca)\\-\\w+\\-\\d+$", "regions": { "ap-northeast-1": { "description": "Asia Pacific (Tokyo)" }, "ap-northeast-2": { "description": "Asia Pacific (Seoul)" }, "ap-south-1": { "description": "Asia Pacific (Mumbai)" }, "ap-southeast-1": { "description": "Asia Pacific (Singapore)" }, "ap-southeast-2": { "description": "Asia Pacific (Sydney)" }, "ca-central-1": { "description": "Canada (Central)" }, "eu-central-1": { "description": "EU (Frankfurt)" }, "eu-west-1": { "description": "EU (Ireland)" }, "eu-west-2": { "description": "EU (London)" }, "sa-east-1": { "description": "South America (Sao Paulo)" }, "us-east-1": { "description": "US East (N. Virginia)" }, "us-east-2": { "description": "US East (Ohio)" }, "us-west-1": { "description": "US West (N. California)" }, "us-west-2": { "description": "US West (Oregon)" } }, "services": { "acm": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "apigateway": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "application-autoscaling": { "defaults": { "credentialScope": { "service": "application-autoscaling" }, "hostname": "autoscaling.{region}.amazonaws.com", "protocols": [ "http", "https" ] }, "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "appstream": { "endpoints": { "ap-northeast-1": {}, "us-east-1": {} } }, "appstream2": { "defaults": { "credentialScope": { "service": "appstream" }, "protocols": [ "https" ] }, "endpoints": { "ap-northeast-1": {}, "eu-west-1": {}, "us-east-1": {}, "us-west-2": {} } }, "autoscaling": { "defaults": { "protocols": [ "http", "https" ] }, "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "batch": { "endpoints": { "us-east-1": {} } }, "budgets": { "endpoints": { "aws-global": { "credentialScope": { "region": "us-east-1" }, "hostname": "budgets.amazonaws.com" } }, "isRegionalized": false, "partitionEndpoint": "aws-global" }, "cloudformation": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "cloudfront": { "endpoints": { "aws-global": { "credentialScope": { "region": "us-east-1" }, "hostname": "cloudfront.amazonaws.com", "protocols": [ "http", "https" ] } }, "isRegionalized": false, "partitionEndpoint": "aws-global" }, "cloudhsm": { "endpoints": { "ap-northeast-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "cloudsearch": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "sa-east-1": {}, "us-east-1": {}, "us-west-1": {}, "us-west-2": {} } }, "cloudtrail": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "codebuild": { "endpoints": { "eu-west-1": {}, "us-east-1": {}, "us-west-2": {} } }, "codecommit": { "endpoints": { "eu-west-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-2": {} } }, "codedeploy": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "codepipeline": { "endpoints": { "ap-northeast-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-2": {} } }, "cognito-identity": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-2": {} } }, "cognito-idp": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-2": {} } }, "cognito-sync": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-2": {} } }, "config": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "cur": { "endpoints": { "us-east-1": {} } }, "data.iot": { "defaults": { "credentialScope": { "service": "iotdata" }, "protocols": [ "https" ] }, "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "us-east-1": {}, "us-west-2": {} } }, "datapipeline": { "endpoints": { "ap-northeast-1": {}, "ap-southeast-2": {}, "eu-west-1": {}, "us-east-1": {}, "us-west-2": {} } }, "devicefarm": { "endpoints": { "us-west-2": {} } }, "directconnect": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "discovery": { "endpoints": { "us-west-2": {} } }, "dms": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "ds": { "endpoints": { "ap-northeast-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "us-east-1": {}, "us-west-2": {} } }, "dynamodb": { "defaults": { "protocols": [ "http", "https" ] }, "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "local": { "credentialScope": { "region": "us-east-1" }, "hostname": "localhost:8000", "protocols": [ "http" ] }, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "ec2": { "defaults": { "protocols": [ "http", "https" ] }, "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "ecr": { "endpoints": { "ap-northeast-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "ecs": { "endpoints": { "ap-northeast-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "elasticache": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "elasticbeanstalk": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "elasticfilesystem": { "endpoints": { "eu-west-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-2": {} } }, "elasticloadbalancing": { "defaults": { "protocols": [ "http", "https" ] }, "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "elasticmapreduce": { "defaults": { "protocols": [ "http", "https" ], "sslCommonName": "{region}.{service}.{dnsSuffix}" }, "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": { "sslCommonName": "{service}.{region}.{dnsSuffix}" }, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": { "sslCommonName": "{service}.{region}.{dnsSuffix}" }, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "elastictranscoder": { "endpoints": { "ap-northeast-1": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "eu-west-1": {}, "us-east-1": {}, "us-west-1": {}, "us-west-2": {} } }, "email": { "endpoints": { "eu-west-1": {}, "us-east-1": {}, "us-west-2": {} } }, "es": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "events": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "firehose": { "endpoints": { "eu-west-1": {}, "us-east-1": {}, "us-west-2": {} } }, "gamelift": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "eu-central-1": {}, "eu-west-1": {}, "sa-east-1": {}, "us-east-1": {}, "us-west-2": {} } }, "glacier": { "defaults": { "protocols": [ "http", "https" ] }, "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "health": { "endpoints": { "us-east-1": {} } }, "iam": { "endpoints": { "aws-global": { "credentialScope": { "region": "us-east-1" }, "hostname": "iam.amazonaws.com" } }, "isRegionalized": false, "partitionEndpoint": "aws-global" }, "importexport": { "endpoints": { "aws-global": { "credentialScope": { "region": "us-east-1", "service": "IngestionService" }, "hostname": "importexport.amazonaws.com", "signatureVersions": [ "v2", "v4" ] } }, "isRegionalized": false, "partitionEndpoint": "aws-global" }, "inspector": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-2": {}, "eu-west-1": {}, "us-east-1": {}, "us-west-2": {} } }, "iot": { "defaults": { "credentialScope": { "service": "execute-api" } }, "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-2": {} } }, "kinesis": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "kinesisanalytics": { "endpoints": { "eu-west-1": {}, "us-east-1": {}, "us-west-2": {} } }, "kms": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "lambda": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "lightsail": { "endpoints": { "us-east-1": {} } }, "logs": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "machinelearning": { "endpoints": { "eu-west-1": {}, "us-east-1": {} } }, "marketplacecommerceanalytics": { "endpoints": { "us-east-1": {} } }, "metering.marketplace": { "defaults": { "credentialScope": { "service": "aws-marketplace" } }, "endpoints": { "ap-northeast-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "us-east-1": {}, "us-west-1": {}, "us-west-2": {} } }, "mobileanalytics": { "endpoints": { "us-east-1": {} } }, "monitoring": { "defaults": { "protocols": [ "http", "https" ] }, "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "opsworks": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "opsworks-cm": { "endpoints": { "eu-west-1": {}, "us-east-1": {}, "us-west-2": {} } }, "pinpoint": { "defaults": { "credentialScope": { "service": "mobiletargeting" } }, "endpoints": { "us-east-1": {} } }, "polly": { "endpoints": { "eu-west-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-2": {} } }, "rds": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": { "sslCommonName": "{service}.{dnsSuffix}" }, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "redshift": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "rekognition": { "endpoints": { "eu-west-1": {}, "us-east-1": {}, "us-west-2": {} } }, "route53": { "endpoints": { "aws-global": { "credentialScope": { "region": "us-east-1" }, "hostname": "route53.amazonaws.com" } }, "isRegionalized": false, "partitionEndpoint": "aws-global" }, "route53domains": { "endpoints": { "us-east-1": {} } }, "s3": { "defaults": { "protocols": [ "http", "https" ], "signatureVersions": [ "s3v4" ] }, "endpoints": { "ap-northeast-1": { "hostname": "s3-ap-northeast-1.amazonaws.com", "signatureVersions": [ "s3", "s3v4" ] }, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": { "hostname": "s3-ap-southeast-1.amazonaws.com", "signatureVersions": [ "s3", "s3v4" ] }, "ap-southeast-2": { "hostname": "s3-ap-southeast-2.amazonaws.com", "signatureVersions": [ "s3", "s3v4" ] }, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": { "hostname": "s3-eu-west-1.amazonaws.com", "signatureVersions": [ "s3", "s3v4" ] }, "eu-west-2": {}, "s3-external-1": { "credentialScope": { "region": "us-east-1" }, "hostname": "s3-external-1.amazonaws.com", "signatureVersions": [ "s3", "s3v4" ] }, "sa-east-1": { "hostname": "s3-sa-east-1.amazonaws.com", "signatureVersions": [ "s3", "s3v4" ] }, "us-east-1": { "hostname": "s3.amazonaws.com", "signatureVersions": [ "s3", "s3v4" ] }, "us-east-2": {}, "us-west-1": { "hostname": "s3-us-west-1.amazonaws.com", "signatureVersions": [ "s3", "s3v4" ] }, "us-west-2": { "hostname": "s3-us-west-2.amazonaws.com", "signatureVersions": [ "s3", "s3v4" ] } }, "isRegionalized": true, "partitionEndpoint": "us-east-1" }, "sdb": { "defaults": { "protocols": [ "http", "https" ], "signatureVersions": [ "v2" ] }, "endpoints": { "ap-northeast-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "eu-west-1": {}, "sa-east-1": {}, "us-east-1": { "hostname": "sdb.amazonaws.com" }, "us-west-1": {}, "us-west-2": {} } }, "servicecatalog": { "endpoints": { "ap-northeast-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "us-east-1": {}, "us-east-2": {}, "us-west-2": {} } }, "shield": { "defaults": { "protocols": [ "https" ], "sslCommonName": "Shield.us-east-1.amazonaws.com" }, "endpoints": { "us-east-1": {} }, "isRegionalized": false }, "sms": { "endpoints": { "ap-southeast-2": {}, "eu-west-1": {}, "us-east-1": {} } }, "snowball": { "endpoints": { "ap-south-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "sns": { "defaults": { "protocols": [ "http", "https" ] }, "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "sqs": { "defaults": { "protocols": [ "http", "https" ], "sslCommonName": "{region}.queue.{dnsSuffix}" }, "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": { "sslCommonName": "queue.{dnsSuffix}" }, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "ssm": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "states": { "endpoints": { "ap-northeast-1": {}, "eu-west-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-2": {} } }, "storagegateway": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "streams.dynamodb": { "defaults": { "credentialScope": { "service": "dynamodb" }, "protocols": [ "http", "http", "https", "https" ] }, "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "local": { "credentialScope": { "region": "us-east-1" }, "hostname": "localhost:8000", "protocols": [ "http" ] }, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "sts": { "defaults": { "credentialScope": { "region": "us-east-1" }, "hostname": "sts.amazonaws.com" }, "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": { "credentialScope": { "region": "ap-northeast-2" }, "hostname": "sts.ap-northeast-2.amazonaws.com" }, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "aws-global": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} }, "partitionEndpoint": "aws-global" }, "support": { "endpoints": { "us-east-1": {} } }, "swf": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "ca-central-1": {}, "eu-central-1": {}, "eu-west-1": {}, "eu-west-2": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } }, "waf": { "endpoints": { "aws-global": { "credentialScope": { "region": "us-east-1" }, "hostname": "waf.amazonaws.com" } }, "isRegionalized": false, "partitionEndpoint": "aws-global" }, "waf-regional": { "endpoints": { "ap-northeast-1": {}, "eu-west-1": {}, "us-east-1": {}, "us-west-2": {} } }, "workspaces": { "endpoints": { "ap-northeast-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "us-east-1": {}, "us-west-2": {} } }, "xray": { "endpoints": { "ap-northeast-1": {}, "ap-northeast-2": {}, "ap-south-1": {}, "ap-southeast-1": {}, "ap-southeast-2": {}, "eu-central-1": {}, "eu-west-1": {}, "sa-east-1": {}, "us-east-1": {}, "us-east-2": {}, "us-west-1": {}, "us-west-2": {} } } } }, { "defaults": { "hostname": "{service}.{region}.{dnsSuffix}", "protocols": [ "https" ], "signatureVersions": [ "v4" ] }, "dnsSuffix": "amazonaws.com.cn", "partition": "aws-cn", "partitionName": "AWS China", "regionRegex": "^cn\\-\\w+\\-\\d+$", "regions": { "cn-north-1": { "description": "China (Beijing)" } }, "services": { "autoscaling": { "defaults": { "protocols": [ "http", "https" ] }, "endpoints": { "cn-north-1": {} } }, "cloudformation": { "endpoints": { "cn-north-1": {} } }, "cloudtrail": { "endpoints": { "cn-north-1": {} } }, "config": { "endpoints": { "cn-north-1": {} } }, "directconnect": { "endpoints": { "cn-north-1": {} } }, "dynamodb": { "defaults": { "protocols": [ "http", "https" ] }, "endpoints": { "cn-north-1": {} } }, "ec2": { "defaults": { "protocols": [ "http", "https" ] }, "endpoints": { "cn-north-1": {} } }, "elasticache": { "endpoints": { "cn-north-1": {} } }, "elasticbeanstalk": { "endpoints": { "cn-north-1": {} } }, "elasticloadbalancing": { "defaults": { "protocols": [ "http", "https" ] }, "endpoints": { "cn-north-1": {} } }, "elasticmapreduce": { "defaults": { "protocols": [ "http", "https" ] }, "endpoints": { "cn-north-1": {} } }, "events": { "endpoints": { "cn-north-1": {} } }, "glacier": { "defaults": { "protocols": [ "http", "https" ] }, "endpoints": { "cn-north-1": {} } }, "iam": { "endpoints": { "aws-cn-global": { "credentialScope": { "region": "cn-north-1" }, "hostname": "iam.cn-north-1.amazonaws.com.cn" } }, "isRegionalized": false, "partitionEndpoint": "aws-cn-global" }, "kinesis": { "endpoints": { "cn-north-1": {} } }, "logs": { "endpoints": { "cn-north-1": {} } }, "monitoring": { "defaults": { "protocols": [ "http", "https" ] }, "endpoints": { "cn-north-1": {} } }, "rds": { "endpoints": { "cn-north-1": {} } }, "redshift": { "endpoints": { "cn-north-1": {} } }, "s3": { "defaults": { "protocols": [ "http", "https" ], "signatureVersions": [ "s3v4" ] }, "endpoints": { "cn-north-1": {} } }, "sns": { "defaults": { "protocols": [ "http", "https" ] }, "endpoints": { "cn-north-1": {} } }, "sqs": { "defaults": { "protocols": [ "http", "https" ], "sslCommonName": "{region}.queue.{dnsSuffix}" }, "endpoints": { "cn-north-1": {} } }, "storagegateway": { "endpoints": { "cn-north-1": {} } }, "streams.dynamodb": { "defaults": { "credentialScope": { "service": "dynamodb" }, "protocols": [ "http", "http", "https", "https" ] }, "endpoints": { "cn-north-1": {} } }, "sts": { "endpoints": { "cn-north-1": {} } }, "swf": { "endpoints": { "cn-north-1": {} } } } }, { "defaults": { "hostname": "{service}.{region}.{dnsSuffix}", "protocols": [ "https" ], "signatureVersions": [ "v4" ] }, "dnsSuffix": "amazonaws.com", "partition": "aws-us-gov", "partitionName": "AWS GovCloud (US)", "regionRegex": "^us\\-gov\\-\\w+\\-\\d+$", "regions": { "us-gov-west-1": { "description": "AWS GovCloud (US)" } }, "services": { "autoscaling": { "endpoints": { "us-gov-west-1": { "protocols": [ "http", "https" ] } } }, "cloudformation": { "endpoints": { "us-gov-west-1": {} } }, "cloudhsm": { "endpoints": { "us-gov-west-1": {} } }, "cloudtrail": { "endpoints": { "us-gov-west-1": {} } }, "config": { "endpoints": { "us-gov-west-1": {} } }, "directconnect": { "endpoints": { "us-gov-west-1": {} } }, "dynamodb": { "endpoints": { "us-gov-west-1": {} } }, "ec2": { "endpoints": { "us-gov-west-1": {} } }, "elasticache": { "endpoints": { "us-gov-west-1": {} } }, "elasticloadbalancing": { "endpoints": { "us-gov-west-1": { "protocols": [ "http", "https" ] } } }, "elasticmapreduce": { "endpoints": { "us-gov-west-1": { "protocols": [ "http", "https" ] } } }, "glacier": { "endpoints": { "us-gov-west-1": { "protocols": [ "http", "https" ] } } }, "iam": { "endpoints": { "aws-us-gov-global": { "credentialScope": { "region": "us-gov-west-1" }, "hostname": "iam.us-gov.amazonaws.com" } }, "isRegionalized": false, "partitionEndpoint": "aws-us-gov-global" }, "kms": { "endpoints": { "us-gov-west-1": {} } }, "logs": { "endpoints": { "us-gov-west-1": {} } }, "monitoring": { "endpoints": { "us-gov-west-1": {} } }, "rds": { "endpoints": { "us-gov-west-1": {} } }, "redshift": { "endpoints": { "us-gov-west-1": {} } }, "s3": { "defaults": { "signatureVersions": [ "s3", "s3v4" ] }, "endpoints": { "fips-us-gov-west-1": { "credentialScope": { "region": "us-gov-west-1" }, "hostname": "s3-fips-us-gov-west-1.amazonaws.com" }, "us-gov-west-1": { "hostname": "s3-us-gov-west-1.amazonaws.com", "protocols": [ "http", "https" ] } } }, "snowball": { "endpoints": { "us-gov-west-1": {} } }, "sns": { "endpoints": { "us-gov-west-1": { "protocols": [ "http", "https" ] } } }, "sqs": { "endpoints": { "us-gov-west-1": { "protocols": [ "http", "https" ], "sslCommonName": "{region}.queue.{dnsSuffix}" } } }, "streams.dynamodb": { "defaults": { "credentialScope": { "service": "dynamodb" } }, "endpoints": { "us-gov-west-1": {} } }, "sts": { "endpoints": { "us-gov-west-1": {} } }, "swf": { "endpoints": { "us-gov-west-1": {} } } } } ], "version": 3 } botocore-1.5.7/botocore/data/servicecatalog/0000777454262600001440000000000013042511307022126 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/servicecatalog/2015-12-10/0000777454262600001440000000000013042511307023153 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/servicecatalog/2015-12-10/service-2.json0000666454262600001440000034532113042511306025654 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"servicecatalog-2015-12-10", "apiVersion":"2015-12-10", "endpointPrefix":"servicecatalog", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"AWS Service Catalog", "signatureVersion":"v4", "targetPrefix":"AWS242ServiceCatalogService" }, "operations":{ "AcceptPortfolioShare":{ "name":"AcceptPortfolioShare", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AcceptPortfolioShareInput"}, "output":{"shape":"AcceptPortfolioShareOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

Accepts an offer to share a portfolio.

" }, "AssociatePrincipalWithPortfolio":{ "name":"AssociatePrincipalWithPortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociatePrincipalWithPortfolioInput"}, "output":{"shape":"AssociatePrincipalWithPortfolioOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

Associates the specified principal ARN with the specified portfolio.

" }, "AssociateProductWithPortfolio":{ "name":"AssociateProductWithPortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateProductWithPortfolioInput"}, "output":{"shape":"AssociateProductWithPortfolioOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

Associates a product with a portfolio.

" }, "CreateConstraint":{ "name":"CreateConstraint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateConstraintInput"}, "output":{"shape":"CreateConstraintOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"LimitExceededException"}, {"shape":"DuplicateResourceException"} ], "documentation":"

Creates a new constraint.

" }, "CreatePortfolio":{ "name":"CreatePortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePortfolioInput"}, "output":{"shape":"CreatePortfolioOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a new portfolio.

" }, "CreatePortfolioShare":{ "name":"CreatePortfolioShare", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePortfolioShareInput"}, "output":{"shape":"CreatePortfolioShareOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Creates a new portfolio share.

" }, "CreateProduct":{ "name":"CreateProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateProductInput"}, "output":{"shape":"CreateProductOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a new product.

" }, "CreateProvisioningArtifact":{ "name":"CreateProvisioningArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateProvisioningArtifactInput"}, "output":{"shape":"CreateProvisioningArtifactOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"LimitExceededException"} ], "documentation":"

Create a new provisioning artifact for the specified product. This operation will not work with a product that has been shared with you.

" }, "DeleteConstraint":{ "name":"DeleteConstraint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteConstraintInput"}, "output":{"shape":"DeleteConstraintOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Deletes the specified constraint.

" }, "DeletePortfolio":{ "name":"DeletePortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePortfolioInput"}, "output":{"shape":"DeletePortfolioOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"}, {"shape":"ResourceInUseException"} ], "documentation":"

Deletes the specified portfolio. This operation will not work with a portfolio that has been shared with you or if it has products, users, constraints, or shared accounts associated with it.

" }, "DeletePortfolioShare":{ "name":"DeletePortfolioShare", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePortfolioShareInput"}, "output":{"shape":"DeletePortfolioShareOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes the specified portfolio share.

" }, "DeleteProduct":{ "name":"DeleteProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteProductInput"}, "output":{"shape":"DeleteProductOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Deletes the specified product. This operation will not work with a product that has been shared with you or is associated with a portfolio.

" }, "DeleteProvisioningArtifact":{ "name":"DeleteProvisioningArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteProvisioningArtifactInput"}, "output":{"shape":"DeleteProvisioningArtifactOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Deletes the specified provisioning artifact. This operation will not work on a provisioning artifact associated with a product that has been shared with you, or on the last provisioning artifact associated with a product (a product must have at least one provisioning artifact).

" }, "DescribeConstraint":{ "name":"DescribeConstraint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConstraintInput"}, "output":{"shape":"DescribeConstraintOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves detailed information for a specified constraint.

" }, "DescribePortfolio":{ "name":"DescribePortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribePortfolioInput"}, "output":{"shape":"DescribePortfolioOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves detailed information and any tags associated with the specified portfolio.

" }, "DescribeProduct":{ "name":"DescribeProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeProductInput"}, "output":{"shape":"DescribeProductOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Retrieves information about a specified product.

This operation is functionally identical to DescribeProductView except that it takes as input ProductId instead of ProductViewId.

" }, "DescribeProductAsAdmin":{ "name":"DescribeProductAsAdmin", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeProductAsAdminInput"}, "output":{"shape":"DescribeProductAsAdminOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves information about a specified product, run with administrator access.

" }, "DescribeProductView":{ "name":"DescribeProductView", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeProductViewInput"}, "output":{"shape":"DescribeProductViewOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Retrieves information about a specified product.

This operation is functionally identical to DescribeProduct except that it takes as input ProductViewId instead of ProductId.

" }, "DescribeProvisioningArtifact":{ "name":"DescribeProvisioningArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeProvisioningArtifactInput"}, "output":{"shape":"DescribeProvisioningArtifactOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves detailed information about the specified provisioning artifact.

" }, "DescribeProvisioningParameters":{ "name":"DescribeProvisioningParameters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeProvisioningParametersInput"}, "output":{"shape":"DescribeProvisioningParametersOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Provides information about parameters required to provision a specified product in a specified manner. Use this operation to obtain the list of ProvisioningArtifactParameters parameters available to call the ProvisionProduct operation for the specified product.

" }, "DescribeRecord":{ "name":"DescribeRecord", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRecordInput"}, "output":{"shape":"DescribeRecordOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves a paginated list of the full details of a specific request. Use this operation after calling a request operation (ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

" }, "DisassociatePrincipalFromPortfolio":{ "name":"DisassociatePrincipalFromPortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociatePrincipalFromPortfolioInput"}, "output":{"shape":"DisassociatePrincipalFromPortfolioOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Disassociates a previously associated principal ARN from a specified portfolio.

" }, "DisassociateProductFromPortfolio":{ "name":"DisassociateProductFromPortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateProductFromPortfolioInput"}, "output":{"shape":"DisassociateProductFromPortfolioOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Disassociates the specified product from the specified portfolio.

" }, "ListAcceptedPortfolioShares":{ "name":"ListAcceptedPortfolioShares", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAcceptedPortfolioSharesInput"}, "output":{"shape":"ListAcceptedPortfolioSharesOutput"}, "errors":[ {"shape":"InvalidParametersException"} ], "documentation":"

Lists details of all portfolios for which sharing was accepted by this account.

" }, "ListConstraintsForPortfolio":{ "name":"ListConstraintsForPortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListConstraintsForPortfolioInput"}, "output":{"shape":"ListConstraintsForPortfolioOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Retrieves detailed constraint information for the specified portfolio and product.

" }, "ListLaunchPaths":{ "name":"ListLaunchPaths", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListLaunchPathsInput"}, "output":{"shape":"ListLaunchPathsOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Returns a paginated list of all paths to a specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.

" }, "ListPortfolioAccess":{ "name":"ListPortfolioAccess", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPortfolioAccessInput"}, "output":{"shape":"ListPortfolioAccessOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists the account IDs that have been authorized sharing of the specified portfolio.

" }, "ListPortfolios":{ "name":"ListPortfolios", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPortfoliosInput"}, "output":{"shape":"ListPortfoliosOutput"}, "errors":[ {"shape":"InvalidParametersException"} ], "documentation":"

Lists all portfolios in the catalog.

" }, "ListPortfoliosForProduct":{ "name":"ListPortfoliosForProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPortfoliosForProductInput"}, "output":{"shape":"ListPortfoliosForProductOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists all portfolios that the specified product is associated with.

" }, "ListPrincipalsForPortfolio":{ "name":"ListPrincipalsForPortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPrincipalsForPortfolioInput"}, "output":{"shape":"ListPrincipalsForPortfolioOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Lists all principal ARNs associated with the specified portfolio.

" }, "ListProvisioningArtifacts":{ "name":"ListProvisioningArtifacts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListProvisioningArtifactsInput"}, "output":{"shape":"ListProvisioningArtifactsOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Lists all provisioning artifacts associated with the specified product.

" }, "ListRecordHistory":{ "name":"ListRecordHistory", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRecordHistoryInput"}, "output":{"shape":"ListRecordHistoryOutput"}, "errors":[ {"shape":"InvalidParametersException"} ], "documentation":"

Returns a paginated list of all performed requests, in the form of RecordDetails objects that are filtered as specified.

" }, "ProvisionProduct":{ "name":"ProvisionProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ProvisionProductInput"}, "output":{"shape":"ProvisionProductOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"}, {"shape":"DuplicateResourceException"} ], "documentation":"

Requests a Provision of a specified product. A ProvisionedProduct is a resourced instance for a product. For example, provisioning a CloudFormation-template-backed product results in launching a CloudFormation stack and all the underlying resources that come with it.

You can check the status of this request using the DescribeRecord operation.

" }, "RejectPortfolioShare":{ "name":"RejectPortfolioShare", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RejectPortfolioShareInput"}, "output":{"shape":"RejectPortfolioShareOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Rejects an offer to share a portfolio.

" }, "ScanProvisionedProducts":{ "name":"ScanProvisionedProducts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ScanProvisionedProductsInput"}, "output":{"shape":"ScanProvisionedProductsOutput"}, "errors":[ {"shape":"InvalidParametersException"} ], "documentation":"

Returns a paginated list of all the ProvisionedProduct objects that are currently available (not terminated).

" }, "SearchProducts":{ "name":"SearchProducts", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SearchProductsInput"}, "output":{"shape":"SearchProductsOutput"}, "errors":[ {"shape":"InvalidParametersException"} ], "documentation":"

Returns a paginated list all of the Products objects to which the caller has access.

The output of this operation can be used as input for other operations, such as DescribeProductView.

" }, "SearchProductsAsAdmin":{ "name":"SearchProductsAsAdmin", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SearchProductsAsAdminInput"}, "output":{"shape":"SearchProductsAsAdminOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Retrieves summary and status information about all products created within the caller's account. If a portfolio ID is provided, this operation retrieves information for only those products that are associated with the specified portfolio.

" }, "TerminateProvisionedProduct":{ "name":"TerminateProvisionedProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateProvisionedProductInput"}, "output":{"shape":"TerminateProvisionedProductOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Requests termination of an existing ProvisionedProduct object. If there are Tags associated with the object, they are terminated when the ProvisionedProduct object is terminated.

This operation does not delete any records associated with the ProvisionedProduct object.

You can check the status of this request using the DescribeRecord operation.

" }, "UpdateConstraint":{ "name":"UpdateConstraint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateConstraintInput"}, "output":{"shape":"UpdateConstraintOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Updates an existing constraint.

" }, "UpdatePortfolio":{ "name":"UpdatePortfolio", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdatePortfolioInput"}, "output":{"shape":"UpdatePortfolioOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"} ], "documentation":"

Updates the specified portfolio's details. This operation will not work with a product that has been shared with you.

" }, "UpdateProduct":{ "name":"UpdateProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateProductInput"}, "output":{"shape":"UpdateProductOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Updates an existing product.

" }, "UpdateProvisionedProduct":{ "name":"UpdateProvisionedProduct", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateProvisionedProductInput"}, "output":{"shape":"UpdateProvisionedProductOutput"}, "errors":[ {"shape":"InvalidParametersException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Requests updates to the configuration of an existing ProvisionedProduct object. If there are tags associated with the object, they cannot be updated or added with this operation. Depending on the specific updates requested, this operation may update with no interruption, with some interruption, or replace the ProvisionedProduct object entirely.

You can check the status of this request using the DescribeRecord operation.

" }, "UpdateProvisioningArtifact":{ "name":"UpdateProvisioningArtifact", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateProvisioningArtifactInput"}, "output":{"shape":"UpdateProvisioningArtifactOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParametersException"} ], "documentation":"

Updates an existing provisioning artifact's information. This operation will not work on a provisioning artifact associated with a product that has been shared with you.

" } }, "shapes":{ "AcceptLanguage":{"type":"string"}, "AcceptPortfolioShareInput":{ "type":"structure", "required":["PortfolioId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" } } }, "AcceptPortfolioShareOutput":{ "type":"structure", "members":{ } }, "AccessLevelFilter":{ "type":"structure", "members":{ "Key":{ "shape":"AccessLevelFilterKey", "documentation":"

Specifies the access level.

Account allows results at the account level.

Role allows results based on the federated role of the specified user.

User allows results limited to the specified user.

" }, "Value":{ "shape":"AccessLevelFilterValue", "documentation":"

Specifies the user to which the access level applies. A value of Self is currently supported.

" } }, "documentation":"

The access level to limit results.

" }, "AccessLevelFilterKey":{ "type":"string", "enum":[ "Account", "Role", "User" ] }, "AccessLevelFilterValue":{"type":"string"}, "AccountId":{ "type":"string", "pattern":"^[0-9]{12}$" }, "AccountIds":{ "type":"list", "member":{"shape":"AccountId"} }, "AddTags":{ "type":"list", "member":{"shape":"Tag"}, "max":20 }, "AllowedValue":{"type":"string"}, "AllowedValues":{ "type":"list", "member":{"shape":"AllowedValue"} }, "ApproximateCount":{"type":"integer"}, "AssociatePrincipalWithPortfolioInput":{ "type":"structure", "required":[ "PortfolioId", "PrincipalARN", "PrincipalType" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "PrincipalARN":{ "shape":"PrincipalARN", "documentation":"

The ARN representing the principal (IAM user, role, or group).

" }, "PrincipalType":{ "shape":"PrincipalType", "documentation":"

The principal type. Must be IAM

" } } }, "AssociatePrincipalWithPortfolioOutput":{ "type":"structure", "members":{ } }, "AssociateProductWithPortfolioInput":{ "type":"structure", "required":[ "ProductId", "PortfolioId" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "SourcePortfolioId":{ "shape":"Id", "documentation":"

The identifier of the source portfolio to use with this association.

" } } }, "AssociateProductWithPortfolioOutput":{ "type":"structure", "members":{ } }, "AttributeValue":{"type":"string"}, "ConstraintDescription":{ "type":"string", "max":2000 }, "ConstraintDetail":{ "type":"structure", "members":{ "ConstraintId":{ "shape":"Id", "documentation":"

The identifier of the constraint.

" }, "Type":{ "shape":"ConstraintType", "documentation":"

The type of the constraint.

" }, "Description":{ "shape":"ConstraintDescription", "documentation":"

The text description of the constraint.

" }, "Owner":{ "shape":"AccountId", "documentation":"

The owner of the constraint.

" } }, "documentation":"

Detailed constraint information.

" }, "ConstraintDetails":{ "type":"list", "member":{"shape":"ConstraintDetail"} }, "ConstraintParameters":{"type":"string"}, "ConstraintSummaries":{ "type":"list", "member":{"shape":"ConstraintSummary"} }, "ConstraintSummary":{ "type":"structure", "members":{ "Type":{ "shape":"ConstraintType", "documentation":"

The type of the constraint.

" }, "Description":{ "shape":"ConstraintDescription", "documentation":"

The text description of the constraint.

" } }, "documentation":"

An administrator-specified constraint to apply when provisioning a product.

" }, "ConstraintType":{ "type":"string", "max":1024, "min":1 }, "CreateConstraintInput":{ "type":"structure", "required":[ "PortfolioId", "ProductId", "Parameters", "Type", "IdempotencyToken" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "Parameters":{ "shape":"ConstraintParameters", "documentation":"

The constraint parameters.

" }, "Type":{ "shape":"ConstraintType", "documentation":"

The type of the constraint.

" }, "Description":{ "shape":"ConstraintDescription", "documentation":"

The text description of the constraint.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.

", "idempotencyToken":true } } }, "CreateConstraintOutput":{ "type":"structure", "members":{ "ConstraintDetail":{ "shape":"ConstraintDetail", "documentation":"

The resulting detailed constraint information.

" }, "ConstraintParameters":{ "shape":"ConstraintParameters", "documentation":"

The resulting constraint parameters.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the current request.

" } } }, "CreatePortfolioInput":{ "type":"structure", "required":[ "DisplayName", "ProviderName", "IdempotencyToken" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "DisplayName":{ "shape":"PortfolioDisplayName", "documentation":"

The name to use for display purposes.

" }, "Description":{ "shape":"PortfolioDescription", "documentation":"

The text description of the portfolio.

" }, "ProviderName":{ "shape":"ProviderName", "documentation":"

The name of the portfolio provider.

" }, "Tags":{ "shape":"AddTags", "documentation":"

Tags to associate with the new portfolio.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.

", "idempotencyToken":true } } }, "CreatePortfolioOutput":{ "type":"structure", "members":{ "PortfolioDetail":{ "shape":"PortfolioDetail", "documentation":"

The resulting detailed portfolio information.

" }, "Tags":{ "shape":"Tags", "documentation":"

Tags successfully associated with the new portfolio.

" } } }, "CreatePortfolioShareInput":{ "type":"structure", "required":[ "PortfolioId", "AccountId" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "AccountId":{ "shape":"AccountId", "documentation":"

The account ID with which to share the portfolio.

" } } }, "CreatePortfolioShareOutput":{ "type":"structure", "members":{ } }, "CreateProductInput":{ "type":"structure", "required":[ "Name", "Owner", "ProductType", "ProvisioningArtifactParameters", "IdempotencyToken" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "Name":{ "shape":"ProductViewName", "documentation":"

The name of the product.

" }, "Owner":{ "shape":"ProductViewOwner", "documentation":"

The owner of the product.

" }, "Description":{ "shape":"ProductViewShortDescription", "documentation":"

The text description of the product.

" }, "Distributor":{ "shape":"ProductViewOwner", "documentation":"

The distributor of the product.

" }, "SupportDescription":{ "shape":"SupportDescription", "documentation":"

Support information about the product.

" }, "SupportEmail":{ "shape":"SupportEmail", "documentation":"

Contact email for product support.

" }, "SupportUrl":{ "shape":"SupportUrl", "documentation":"

Contact URL for product support.

" }, "ProductType":{ "shape":"ProductType", "documentation":"

The type of the product to create.

" }, "Tags":{ "shape":"AddTags", "documentation":"

Tags to associate with the new product.

" }, "ProvisioningArtifactParameters":{ "shape":"ProvisioningArtifactProperties", "documentation":"

Parameters for the provisioning artifact.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.

", "idempotencyToken":true } } }, "CreateProductOutput":{ "type":"structure", "members":{ "ProductViewDetail":{ "shape":"ProductViewDetail", "documentation":"

The resulting detailed product view information.

" }, "ProvisioningArtifactDetail":{ "shape":"ProvisioningArtifactDetail", "documentation":"

The resulting detailed provisioning artifact information.

" }, "Tags":{ "shape":"Tags", "documentation":"

Tags successfully associated with the new product.

" } } }, "CreateProvisioningArtifactInput":{ "type":"structure", "required":[ "ProductId", "Parameters", "IdempotencyToken" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "Parameters":{ "shape":"ProvisioningArtifactProperties", "documentation":"

The parameters to use when creating the new provisioning artifact.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.

", "idempotencyToken":true } } }, "CreateProvisioningArtifactOutput":{ "type":"structure", "members":{ "ProvisioningArtifactDetail":{ "shape":"ProvisioningArtifactDetail", "documentation":"

The resulting detailed provisioning artifact information.

" }, "Info":{ "shape":"ProvisioningArtifactInfo", "documentation":"

Additional information about the provisioning artifact create request.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the current request.

" } } }, "CreatedTime":{"type":"timestamp"}, "CreationTime":{"type":"timestamp"}, "DefaultValue":{"type":"string"}, "DeleteConstraintInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "Id":{ "shape":"Id", "documentation":"

The identifier of the constraint to delete.

" } } }, "DeleteConstraintOutput":{ "type":"structure", "members":{ } }, "DeletePortfolioInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "Id":{ "shape":"Id", "documentation":"

The identifier of the portfolio for the delete request.

" } } }, "DeletePortfolioOutput":{ "type":"structure", "members":{ } }, "DeletePortfolioShareInput":{ "type":"structure", "required":[ "PortfolioId", "AccountId" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "AccountId":{ "shape":"AccountId", "documentation":"

The account ID associated with the share to delete.

" } } }, "DeletePortfolioShareOutput":{ "type":"structure", "members":{ } }, "DeleteProductInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "Id":{ "shape":"Id", "documentation":"

The identifier of the product for the delete request.

" } } }, "DeleteProductOutput":{ "type":"structure", "members":{ } }, "DeleteProvisioningArtifactInput":{ "type":"structure", "required":[ "ProductId", "ProvisioningArtifactId" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact for the delete request.

" } } }, "DeleteProvisioningArtifactOutput":{ "type":"structure", "members":{ } }, "DescribeConstraintInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "Id":{ "shape":"Id", "documentation":"

The identifier of the constraint.

" } } }, "DescribeConstraintOutput":{ "type":"structure", "members":{ "ConstraintDetail":{ "shape":"ConstraintDetail", "documentation":"

Detailed constraint information.

" }, "ConstraintParameters":{ "shape":"ConstraintParameters", "documentation":"

The current parameters associated with the specified constraint.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the current request.

" } } }, "DescribePortfolioInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "Id":{ "shape":"Id", "documentation":"

The identifier of the portfolio for which to retrieve information.

" } } }, "DescribePortfolioOutput":{ "type":"structure", "members":{ "PortfolioDetail":{ "shape":"PortfolioDetail", "documentation":"

Detailed portfolio information.

" }, "Tags":{ "shape":"Tags", "documentation":"

Tags associated with the portfolio.

" } } }, "DescribeProductAsAdminInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "Id":{ "shape":"Id", "documentation":"

The identifier of the product for which to retrieve information.

" } } }, "DescribeProductAsAdminOutput":{ "type":"structure", "members":{ "ProductViewDetail":{ "shape":"ProductViewDetail", "documentation":"

Detailed product view information.

" }, "Tags":{ "shape":"Tags", "documentation":"

Tags associated with the product.

" } } }, "DescribeProductInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "Id":{ "shape":"Id", "documentation":"

The ProductId of the product to describe.

" } } }, "DescribeProductOutput":{ "type":"structure", "members":{ "ProductViewSummary":{ "shape":"ProductViewSummary", "documentation":"

The summary metadata about the specified product.

" }, "ProvisioningArtifacts":{ "shape":"ProvisioningArtifacts", "documentation":"

A list of provisioning artifact objects for the specified product. The ProvisioningArtifacts parameter represent the ways the specified product can be provisioned.

" } } }, "DescribeProductViewInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "Id":{ "shape":"Id", "documentation":"

The ProductViewId of the product to describe.

" } } }, "DescribeProductViewOutput":{ "type":"structure", "members":{ "ProductViewSummary":{ "shape":"ProductViewSummary", "documentation":"

The summary metadata about the specified product.

" }, "ProvisioningArtifacts":{ "shape":"ProvisioningArtifacts", "documentation":"

A list of provisioning artifact objects for the specified product. The ProvisioningArtifacts represent the ways in which the specified product can be provisioned.

" } } }, "DescribeProvisioningArtifactInput":{ "type":"structure", "required":[ "ProvisioningArtifactId", "ProductId" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" } } }, "DescribeProvisioningArtifactOutput":{ "type":"structure", "members":{ "ProvisioningArtifactDetail":{ "shape":"ProvisioningArtifactDetail", "documentation":"

Detailed provisioning artifact information.

" }, "Info":{ "shape":"ProvisioningArtifactInfo", "documentation":"

Additional information about the provisioning artifact.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the current request.

" } } }, "DescribeProvisioningParametersInput":{ "type":"structure", "required":[ "ProductId", "ProvisioningArtifactId" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The provisioning artifact identifier for this product.

" }, "PathId":{ "shape":"Id", "documentation":"

The identifier of the path for this product's provisioning. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.

" } } }, "DescribeProvisioningParametersOutput":{ "type":"structure", "members":{ "ProvisioningArtifactParameters":{ "shape":"ProvisioningArtifactParameters", "documentation":"

The list of parameters used to successfully provision the product. Each parameter includes a list of allowable values and additional metadata about each parameter.

" }, "ConstraintSummaries":{ "shape":"ConstraintSummaries", "documentation":"

The list of constraint summaries that apply to provisioning this product.

" }, "UsageInstructions":{ "shape":"UsageInstructions", "documentation":"

Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.

" } } }, "DescribeRecordInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "Id":{ "shape":"Id", "documentation":"

The record identifier of the ProvisionedProduct object for which to retrieve output information. This is the RecordDetail.RecordId obtained from the request operation's response.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

" } } }, "DescribeRecordOutput":{ "type":"structure", "members":{ "RecordDetail":{ "shape":"RecordDetail", "documentation":"

Detailed record information for the specified product.

" }, "RecordOutputs":{ "shape":"RecordOutputs", "documentation":"

A list of outputs for the specified Product object created as the result of a request. For example, a CloudFormation-backed product that creates an S3 bucket would have an output for the S3 bucket URL.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } } }, "Description":{"type":"string"}, "DisassociatePrincipalFromPortfolioInput":{ "type":"structure", "required":[ "PortfolioId", "PrincipalARN" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "PrincipalARN":{ "shape":"PrincipalARN", "documentation":"

The ARN representing the principal (IAM user, role, or group).

" } } }, "DisassociatePrincipalFromPortfolioOutput":{ "type":"structure", "members":{ } }, "DisassociateProductFromPortfolioInput":{ "type":"structure", "required":[ "ProductId", "PortfolioId" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" } } }, "DisassociateProductFromPortfolioOutput":{ "type":"structure", "members":{ } }, "DuplicateResourceException":{ "type":"structure", "members":{ }, "documentation":"

The specified resource is a duplicate.

", "exception":true }, "ErrorCode":{"type":"string"}, "ErrorDescription":{"type":"string"}, "HasDefaultPath":{"type":"boolean"}, "Id":{ "type":"string", "max":100, "min":1 }, "IdempotencyToken":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" }, "IgnoreErrors":{"type":"boolean"}, "InstructionType":{"type":"string"}, "InstructionValue":{"type":"string"}, "InvalidParametersException":{ "type":"structure", "members":{ }, "documentation":"

One or more parameters provided to the operation are invalid.

", "exception":true }, "LastRequestId":{"type":"string"}, "LaunchPathSummaries":{ "type":"list", "member":{"shape":"LaunchPathSummary"} }, "LaunchPathSummary":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"

The unique identifier of the product path.

" }, "ConstraintSummaries":{ "shape":"ConstraintSummaries", "documentation":"

List of constraints on the portfolio-product relationship.

" }, "Tags":{ "shape":"Tags", "documentation":"

List of tags used by this launch path.

" }, "Name":{ "shape":"PortfolioName", "documentation":"

Corresponds to the name of the portfolio to which the user was assigned.

" } }, "documentation":"

Summary information about a path for a user to have access to a specified product.

" }, "LimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

The current limits of the service would have been exceeded by this operation. Reduce the resource use or increase the service limits and retry the operation.

", "exception":true }, "ListAcceptedPortfolioSharesInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

" } } }, "ListAcceptedPortfolioSharesOutput":{ "type":"structure", "members":{ "PortfolioDetails":{ "shape":"PortfolioDetails", "documentation":"

List of detailed portfolio information objects.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } } }, "ListConstraintsForPortfolioInput":{ "type":"structure", "required":["PortfolioId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

" } } }, "ListConstraintsForPortfolioOutput":{ "type":"structure", "members":{ "ConstraintDetails":{ "shape":"ConstraintDetails", "documentation":"

List of detailed constraint information objects.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } } }, "ListLaunchPathsInput":{ "type":"structure", "required":["ProductId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.. Identifies the product for which to retrieve LaunchPathSummaries information.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

" } } }, "ListLaunchPathsOutput":{ "type":"structure", "members":{ "LaunchPathSummaries":{ "shape":"LaunchPathSummaries", "documentation":"

List of launch path information summaries for the specified PageToken.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } } }, "ListPortfolioAccessInput":{ "type":"structure", "required":["PortfolioId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" } } }, "ListPortfolioAccessOutput":{ "type":"structure", "members":{ "AccountIds":{ "shape":"AccountIds", "documentation":"

List of account IDs associated with access to the portfolio.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } } }, "ListPortfoliosForProductInput":{ "type":"structure", "required":["ProductId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

" } } }, "ListPortfoliosForProductOutput":{ "type":"structure", "members":{ "PortfolioDetails":{ "shape":"PortfolioDetails", "documentation":"

List of detailed portfolio information objects.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } } }, "ListPortfoliosInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

" } } }, "ListPortfoliosOutput":{ "type":"structure", "members":{ "PortfolioDetails":{ "shape":"PortfolioDetails", "documentation":"

List of detailed portfolio information objects.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } } }, "ListPrincipalsForPortfolioInput":{ "type":"structure", "required":["PortfolioId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

" } } }, "ListPrincipalsForPortfolioOutput":{ "type":"structure", "members":{ "Principals":{ "shape":"Principals", "documentation":"

The IAM principals (users or roles) associated with the portfolio.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } } }, "ListProvisioningArtifactsInput":{ "type":"structure", "required":["ProductId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" } } }, "ListProvisioningArtifactsOutput":{ "type":"structure", "members":{ "ProvisioningArtifactDetails":{ "shape":"ProvisioningArtifactDetails", "documentation":"

List of detailed provisioning artifact information objects.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } } }, "ListRecordHistoryInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "AccessLevelFilter":{ "shape":"AccessLevelFilter", "documentation":"

The access level for obtaining results. If left unspecified, User level access is used.

" }, "SearchFilter":{ "shape":"ListRecordHistorySearchFilter", "documentation":"

The filter to limit search results.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

" } } }, "ListRecordHistoryOutput":{ "type":"structure", "members":{ "RecordDetails":{ "shape":"RecordDetails", "documentation":"

A list of record detail objects, listed in reverse chronological order.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } } }, "ListRecordHistorySearchFilter":{ "type":"structure", "members":{ "Key":{ "shape":"SearchFilterKey", "documentation":"

The filter key.

" }, "Value":{ "shape":"SearchFilterValue", "documentation":"

The filter value for Key.

" } }, "documentation":"

The search filter to limit results when listing request history records.

" }, "NoEcho":{"type":"boolean"}, "NotificationArn":{ "type":"string", "max":1224, "min":1, "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" }, "NotificationArns":{ "type":"list", "member":{"shape":"NotificationArn"}, "max":5 }, "OutputKey":{"type":"string"}, "OutputValue":{"type":"string"}, "PageSize":{ "type":"integer", "max":20, "min":0 }, "PageToken":{ "type":"string", "pattern":"[\\u0009\\u000a\\u000d\\u0020-\\uD7FF\\uE000-\\uFFFD]*" }, "ParameterConstraints":{ "type":"structure", "members":{ "AllowedValues":{ "shape":"AllowedValues", "documentation":"

The values that the administrator has allowed for the parameter.

" } }, "documentation":"

The constraints that the administrator has put on the parameter.

" }, "ParameterKey":{ "type":"string", "max":1000, "min":1 }, "ParameterType":{"type":"string"}, "ParameterValue":{ "type":"string", "max":1000 }, "PortfolioDescription":{ "type":"string", "max":2000 }, "PortfolioDetail":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier for the portfolio.

" }, "ARN":{ "shape":"ResourceARN", "documentation":"

The ARN assigned to the portfolio.

" }, "DisplayName":{ "shape":"PortfolioDisplayName", "documentation":"

The name to use for display purposes.

" }, "Description":{ "shape":"PortfolioDescription", "documentation":"

The text description of the portfolio.

" }, "CreatedTime":{ "shape":"CreationTime", "documentation":"

The UTC timestamp of the creation time.

" }, "ProviderName":{ "shape":"ProviderName", "documentation":"

The name of the portfolio provider.

" } }, "documentation":"

Detailed portfolio information.

" }, "PortfolioDetails":{ "type":"list", "member":{"shape":"PortfolioDetail"} }, "PortfolioDisplayName":{ "type":"string", "max":100, "min":1 }, "PortfolioName":{"type":"string"}, "Principal":{ "type":"structure", "members":{ "PrincipalARN":{ "shape":"PrincipalARN", "documentation":"

The ARN representing the principal (IAM user, role, or group).

" }, "PrincipalType":{ "shape":"PrincipalType", "documentation":"

The principal type. Must be IAM

" } }, "documentation":"

A principal's ARN and type.

" }, "PrincipalARN":{ "type":"string", "max":1000, "min":1 }, "PrincipalType":{ "type":"string", "enum":["IAM"] }, "Principals":{ "type":"list", "member":{"shape":"Principal"} }, "ProductSource":{ "type":"string", "enum":["ACCOUNT"] }, "ProductType":{ "type":"string", "enum":["CLOUD_FORMATION_TEMPLATE"] }, "ProductViewAggregationType":{"type":"string"}, "ProductViewAggregationValue":{ "type":"structure", "members":{ "Value":{ "shape":"AttributeValue", "documentation":"

The value of the product view aggregation.

" }, "ApproximateCount":{ "shape":"ApproximateCount", "documentation":"

An approximate count of the products that match the value.

" } }, "documentation":"

A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.

" }, "ProductViewAggregationValues":{ "type":"list", "member":{"shape":"ProductViewAggregationValue"} }, "ProductViewAggregations":{ "type":"map", "key":{"shape":"ProductViewAggregationType"}, "value":{"shape":"ProductViewAggregationValues"} }, "ProductViewDetail":{ "type":"structure", "members":{ "ProductViewSummary":{ "shape":"ProductViewSummary", "documentation":"

The summary metadata about the specified product view.

" }, "Status":{ "shape":"Status", "documentation":"

Current status of the product.

" }, "ProductARN":{ "shape":"ResourceARN", "documentation":"

The ARN associated with the product.

" }, "CreatedTime":{ "shape":"CreatedTime", "documentation":"

The UTC timestamp of the creation time.

" } }, "documentation":"

Detailed product view information.

" }, "ProductViewDetails":{ "type":"list", "member":{"shape":"ProductViewDetail"} }, "ProductViewDistributor":{"type":"string"}, "ProductViewFilterBy":{ "type":"string", "enum":[ "FullTextSearch", "Owner", "ProductType" ] }, "ProductViewFilterValue":{"type":"string"}, "ProductViewFilterValues":{ "type":"list", "member":{"shape":"ProductViewFilterValue"} }, "ProductViewFilters":{ "type":"map", "key":{"shape":"ProductViewFilterBy"}, "value":{"shape":"ProductViewFilterValues"} }, "ProductViewName":{"type":"string"}, "ProductViewOwner":{"type":"string"}, "ProductViewShortDescription":{"type":"string"}, "ProductViewSortBy":{ "type":"string", "enum":[ "Title", "VersionCount", "CreationDate" ] }, "ProductViewSummaries":{ "type":"list", "member":{"shape":"ProductViewSummary"} }, "ProductViewSummary":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"

The product view identifier.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "Name":{ "shape":"ProductViewName", "documentation":"

The name of the product.

" }, "Owner":{ "shape":"ProductViewOwner", "documentation":"

The owner of the product. Contact the product administrator for the significance of this value.

" }, "ShortDescription":{ "shape":"ProductViewShortDescription", "documentation":"

Short description of the product.

" }, "Type":{ "shape":"ProductType", "documentation":"

The product type. Contact the product administrator for the significance of this value.

" }, "Distributor":{ "shape":"ProductViewDistributor", "documentation":"

The distributor of the product. Contact the product administrator for the significance of this value.

" }, "HasDefaultPath":{ "shape":"HasDefaultPath", "documentation":"

A value of false indicates that the product does not have a default path, while a value of true indicates that it does. If it's false, call ListLaunchPaths to disambiguate between paths. If true, ListLaunchPaths is not required, and the output of the ProductViewSummary operation can be used directly with DescribeProvisioningParameters.

" }, "SupportEmail":{ "shape":"SupportEmail", "documentation":"

The email contact information to obtain support for this Product.

" }, "SupportDescription":{ "shape":"SupportDescription", "documentation":"

The description of the support for this Product.

" }, "SupportUrl":{ "shape":"SupportUrl", "documentation":"

The URL information to obtain support for this Product.

" } }, "documentation":"

The summary metadata about the specified product.

" }, "ProviderName":{ "type":"string", "max":20, "min":1 }, "ProvisionProductInput":{ "type":"structure", "required":[ "ProductId", "ProvisioningArtifactId", "ProvisionedProductName", "ProvisionToken" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The provisioning artifact identifier for this product.

" }, "PathId":{ "shape":"Id", "documentation":"

The identifier of the path for this product's provisioning. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.

" }, "ProvisionedProductName":{ "shape":"ProvisionedProductName", "documentation":"

A user-friendly name to identify the ProvisionedProduct object. This value must be unique for the AWS account and cannot be updated after the product is provisioned.

" }, "ProvisioningParameters":{ "shape":"ProvisioningParameters", "documentation":"

Parameters specified by the administrator that are required for provisioning the product.

" }, "Tags":{ "shape":"Tags", "documentation":"

A list of tags to use as provisioning options.

" }, "NotificationArns":{ "shape":"NotificationArns", "documentation":"

Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

" }, "ProvisionToken":{ "shape":"IdempotencyToken", "documentation":"

An idempotency token that uniquely identifies the provisioning request.

", "idempotencyToken":true } } }, "ProvisionProductOutput":{ "type":"structure", "members":{ "RecordDetail":{ "shape":"RecordDetail", "documentation":"

The detailed result of the ProvisionProduct request, containing the inputs made to that request, the current state of the request, a pointer to the ProvisionedProduct object of the request, and a list of any errors that the request encountered.

" } } }, "ProvisionedProductDetail":{ "type":"structure", "members":{ "Name":{ "shape":"ProvisionedProductNameOrArn", "documentation":"

The user-friendly name of the ProvisionedProduct object.

" }, "Arn":{ "shape":"ProvisionedProductNameOrArn", "documentation":"

The ARN associated with the ProvisionedProduct object.

" }, "Type":{ "shape":"ProvisionedProductType", "documentation":"

The type of the ProvisionedProduct object.

" }, "Id":{ "shape":"ProvisionedProductId", "documentation":"

The identifier of the ProvisionedProduct object.

" }, "Status":{ "shape":"RecordStatus", "documentation":"

The current status of the ProvisionedProduct.

" }, "StatusMessage":{ "shape":"ProvisionedProductStatusMessage", "documentation":"

The current status message of the ProvisionedProduct.

" }, "CreatedTime":{ "shape":"CreatedTime", "documentation":"

The UTC timestamp of the creation time.

" }, "IdempotencyToken":{ "shape":"IdempotencyToken", "documentation":"

A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.

" }, "LastRecordId":{ "shape":"LastRequestId", "documentation":"

The record identifier of the last request performed on this ProvisionedProduct object.

" } }, "documentation":"

Detailed information about a ProvisionedProduct object.

" }, "ProvisionedProductDetails":{ "type":"list", "member":{"shape":"ProvisionedProductDetail"} }, "ProvisionedProductId":{"type":"string"}, "ProvisionedProductName":{"type":"string"}, "ProvisionedProductNameOrArn":{ "type":"string", "max":1224, "min":1, "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]{0,127}|arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" }, "ProvisionedProductStatusMessage":{"type":"string"}, "ProvisionedProductType":{"type":"string"}, "ProvisioningArtifact":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier for the artifact.

" }, "Name":{ "shape":"ProvisioningArtifactName", "documentation":"

The name of the artifact.

" }, "Description":{ "shape":"ProvisioningArtifactDescription", "documentation":"

The text description of the artifact.

" }, "CreatedTime":{ "shape":"ProvisioningArtifactCreatedTime", "documentation":"

The UTC timestamp of the creation time.

" } }, "documentation":"

Contains information indicating the ways in which a product can be provisioned.

" }, "ProvisioningArtifactCreatedTime":{"type":"timestamp"}, "ProvisioningArtifactDescription":{"type":"string"}, "ProvisioningArtifactDetail":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact.

" }, "Name":{ "shape":"ProvisioningArtifactName", "documentation":"

The name assigned to the provisioning artifact.

" }, "Description":{ "shape":"ProvisioningArtifactName", "documentation":"

The text description of the provisioning artifact.

" }, "Type":{ "shape":"ProvisioningArtifactType", "documentation":"

The type of the provisioning artifact.

" }, "CreatedTime":{ "shape":"CreationTime", "documentation":"

The UTC timestamp of the creation time.

" } }, "documentation":"

Detailed provisioning artifact information.

" }, "ProvisioningArtifactDetails":{ "type":"list", "member":{"shape":"ProvisioningArtifactDetail"} }, "ProvisioningArtifactInfo":{ "type":"map", "key":{"shape":"ProvisioningArtifactInfoKey"}, "value":{"shape":"ProvisioningArtifactInfoValue"}, "max":1, "min":1 }, "ProvisioningArtifactInfoKey":{"type":"string"}, "ProvisioningArtifactInfoValue":{"type":"string"}, "ProvisioningArtifactName":{"type":"string"}, "ProvisioningArtifactParameter":{ "type":"structure", "members":{ "ParameterKey":{ "shape":"ParameterKey", "documentation":"

The parameter key.

" }, "DefaultValue":{ "shape":"DefaultValue", "documentation":"

The default value for this parameter.

" }, "ParameterType":{ "shape":"ParameterType", "documentation":"

The parameter type.

" }, "IsNoEcho":{ "shape":"NoEcho", "documentation":"

If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information.

" }, "Description":{ "shape":"Description", "documentation":"

The text description of the parameter.

" }, "ParameterConstraints":{ "shape":"ParameterConstraints", "documentation":"

The list of constraints that the administrator has put on the parameter.

" } }, "documentation":"

A parameter used to successfully provision the product. This value includes a list of allowable values and additional metadata.

" }, "ProvisioningArtifactParameters":{ "type":"list", "member":{"shape":"ProvisioningArtifactParameter"} }, "ProvisioningArtifactProperties":{ "type":"structure", "required":["Info"], "members":{ "Name":{ "shape":"ProvisioningArtifactName", "documentation":"

The name assigned to the provisioning artifact properties.

" }, "Description":{ "shape":"ProvisioningArtifactDescription", "documentation":"

The text description of the provisioning artifact properties.

" }, "Info":{ "shape":"ProvisioningArtifactInfo", "documentation":"

Additional information about the provisioning artifact properties.

" }, "Type":{ "shape":"ProvisioningArtifactType", "documentation":"

The type of the provisioning artifact properties.

" } }, "documentation":"

Provisioning artifact properties.

" }, "ProvisioningArtifactType":{ "type":"string", "enum":["CLOUD_FORMATION_TEMPLATE"] }, "ProvisioningArtifacts":{ "type":"list", "member":{"shape":"ProvisioningArtifact"} }, "ProvisioningParameter":{ "type":"structure", "members":{ "Key":{ "shape":"ParameterKey", "documentation":"

The ProvisioningArtifactParameter.ParameterKey parameter from DescribeProvisioningParameters.

" }, "Value":{ "shape":"ParameterValue", "documentation":"

The value to use for provisioning. Any constraints on this value can be found in ProvisioningArtifactParameter for Key.

" } }, "documentation":"

The arameter key/value pairs used to provision a product.

" }, "ProvisioningParameters":{ "type":"list", "member":{"shape":"ProvisioningParameter"} }, "RecordDetail":{ "type":"structure", "members":{ "RecordId":{ "shape":"Id", "documentation":"

The identifier of the ProvisionedProduct object record.

" }, "ProvisionedProductName":{ "shape":"ProvisionedProductName", "documentation":"

The user-friendly name of the ProvisionedProduct object.

" }, "Status":{ "shape":"RecordStatus", "documentation":"

The status of the ProvisionedProduct object.

" }, "CreatedTime":{ "shape":"CreatedTime", "documentation":"

The UTC timestamp of the creation time.

" }, "UpdatedTime":{ "shape":"UpdatedTime", "documentation":"

The time when the record for the ProvisionedProduct object was last updated.

" }, "ProvisionedProductType":{ "shape":"ProvisionedProductType", "documentation":"

The type of the ProvisionedProduct object.

" }, "RecordType":{ "shape":"RecordType", "documentation":"

The record type for this record.

" }, "ProvisionedProductId":{ "shape":"Id", "documentation":"

The identifier of the ProvisionedProduct object.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The provisioning artifact identifier for this product.

" }, "PathId":{ "shape":"Id", "documentation":"

The identifier of the path for this product's provisioning.

" }, "RecordErrors":{ "shape":"RecordErrors", "documentation":"

A list of errors that occurred while processing the request.

" }, "RecordTags":{ "shape":"RecordTags", "documentation":"

List of tags associated with this record.

" } }, "documentation":"

The full details of a specific ProvisionedProduct object.

" }, "RecordDetails":{ "type":"list", "member":{"shape":"RecordDetail"} }, "RecordError":{ "type":"structure", "members":{ "Code":{ "shape":"ErrorCode", "documentation":"

The numeric value of the error.

" }, "Description":{ "shape":"ErrorDescription", "documentation":"

The text description of the error.

" } }, "documentation":"

The error code and description resulting from an operation.

" }, "RecordErrors":{ "type":"list", "member":{"shape":"RecordError"} }, "RecordOutput":{ "type":"structure", "members":{ "OutputKey":{ "shape":"OutputKey", "documentation":"

The output key.

" }, "OutputValue":{ "shape":"OutputValue", "documentation":"

The output value.

" }, "Description":{ "shape":"Description", "documentation":"

The text description of the output.

" } }, "documentation":"

An output for the specified Product object created as the result of a request. For example, a CloudFormation-backed product that creates an S3 bucket would have an output for the S3 bucket URL.

" }, "RecordOutputs":{ "type":"list", "member":{"shape":"RecordOutput"} }, "RecordStatus":{ "type":"string", "enum":[ "IN_PROGRESS", "SUCCEEDED", "ERROR" ] }, "RecordTag":{ "type":"structure", "members":{ "Key":{ "shape":"RecordTagKey", "documentation":"

The key for this tag.

" }, "Value":{ "shape":"RecordTagValue", "documentation":"

The value for this tag.

" } }, "documentation":"

A tag associated with the record, stored as a key-value pair.

" }, "RecordTagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" }, "RecordTagValue":{ "type":"string", "max":256, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" }, "RecordTags":{ "type":"list", "member":{"shape":"RecordTag"}, "max":50 }, "RecordType":{"type":"string"}, "RejectPortfolioShareInput":{ "type":"structure", "required":["PortfolioId"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" } } }, "RejectPortfolioShareOutput":{ "type":"structure", "members":{ } }, "ResourceARN":{ "type":"string", "max":150, "min":1 }, "ResourceInUseException":{ "type":"structure", "members":{ }, "documentation":"

The operation was requested against a resource that is currently in use. Free the resource from use and retry the operation.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified resource was not found.

", "exception":true }, "ScanProvisionedProductsInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "AccessLevelFilter":{ "shape":"AccessLevelFilter", "documentation":"

The access level for obtaining results. If left unspecified, User level access is used.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

" } } }, "ScanProvisionedProductsOutput":{ "type":"structure", "members":{ "ProvisionedProducts":{ "shape":"ProvisionedProductDetails", "documentation":"

A list of ProvisionedProduct detail objects.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } } }, "SearchFilterKey":{"type":"string"}, "SearchFilterValue":{"type":"string"}, "SearchProductsAsAdminInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "PortfolioId":{ "shape":"Id", "documentation":"

The portfolio identifier.

" }, "Filters":{ "shape":"ProductViewFilters", "documentation":"

The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the administrator has access.

" }, "SortBy":{ "shape":"ProductViewSortBy", "documentation":"

The sort field specifier. If no value is specified, results are not sorted.

" }, "SortOrder":{ "shape":"SortOrder", "documentation":"

The sort order specifier. If no value is specified, results are not sorted.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

" }, "ProductSource":{ "shape":"ProductSource", "documentation":"

Access level of the source of the product.

" } } }, "SearchProductsAsAdminOutput":{ "type":"structure", "members":{ "ProductViewDetails":{ "shape":"ProductViewDetails", "documentation":"

List of detailed product view information objects.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } } }, "SearchProductsInput":{ "type":"structure", "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "Filters":{ "shape":"ProductViewFilters", "documentation":"

The list of filters with which to limit search results. If no search filters are specified, the output is all the products to which the calling user has access.

" }, "PageSize":{ "shape":"PageSize", "documentation":"

The maximum number of items to return in the results. If more results exist than fit in the specified PageSize, the value of NextPageToken in the response is non-null.

" }, "SortBy":{ "shape":"ProductViewSortBy", "documentation":"

The sort field specifier. If no value is specified, results are not sorted.

" }, "SortOrder":{ "shape":"SortOrder", "documentation":"

The sort order specifier. If no value is specified, results are not sorted.

" }, "PageToken":{ "shape":"PageToken", "documentation":"

The page token of the first page retrieved. If null, this retrieves the first page of size PageSize.

" } } }, "SearchProductsOutput":{ "type":"structure", "members":{ "ProductViewSummaries":{ "shape":"ProductViewSummaries", "documentation":"

A list of the product view summary objects.

" }, "ProductViewAggregations":{ "shape":"ProductViewAggregations", "documentation":"

A list of the product view aggregation value objects.

" }, "NextPageToken":{ "shape":"PageToken", "documentation":"

The page token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" } } }, "SortOrder":{ "type":"string", "enum":[ "ASCENDING", "DESCENDING" ] }, "Status":{ "type":"string", "enum":[ "AVAILABLE", "CREATING", "FAILED" ] }, "SupportDescription":{"type":"string"}, "SupportEmail":{"type":"string"}, "SupportUrl":{"type":"string"}, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

The ProvisioningArtifactParameter.TagKey parameter from DescribeProvisioningParameters.

" }, "Value":{ "shape":"TagValue", "documentation":"

The esired value for this key.

" } }, "documentation":"

Key/value pairs to associate with this provisioning. These tags are entirely discretionary and are propagated to the resources created in the provisioning.

" }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"} }, "TagValue":{ "type":"string", "max":256, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Tags":{ "type":"list", "member":{"shape":"Tag"}, "max":50 }, "TerminateProvisionedProductInput":{ "type":"structure", "required":["TerminateToken"], "members":{ "ProvisionedProductName":{ "shape":"ProvisionedProductNameOrArn", "documentation":"

The name of the ProvisionedProduct object to terminate. You must specify either ProvisionedProductName or ProvisionedProductId, but not both.

" }, "ProvisionedProductId":{ "shape":"Id", "documentation":"

The identifier of the ProvisionedProduct object to terminate. You must specify either ProvisionedProductName or ProvisionedProductId, but not both.

" }, "TerminateToken":{ "shape":"IdempotencyToken", "documentation":"

An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the ProvisionedProduct object is terminated, further requests to terminate the same ProvisionedProduct object always return ResourceNotFound regardless of the value of TerminateToken.

", "idempotencyToken":true }, "IgnoreErrors":{ "shape":"IgnoreErrors", "documentation":"

If set to true, AWS Service Catalog stops managing the specified ProvisionedProduct object even if it cannot delete the underlying resources.

" }, "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" } } }, "TerminateProvisionedProductOutput":{ "type":"structure", "members":{ "RecordDetail":{ "shape":"RecordDetail", "documentation":"

The detailed result of the TerminateProvisionedProduct request, containing the inputs made to that request, the current state of the request, a pointer to the ProvisionedProduct object that the request is modifying, and a list of any errors that the request encountered.

" } } }, "UpdateConstraintInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "Id":{ "shape":"Id", "documentation":"

The identifier of the constraint to update.

" }, "Description":{ "shape":"ConstraintDescription", "documentation":"

The updated text description of the constraint.

" } } }, "UpdateConstraintOutput":{ "type":"structure", "members":{ "ConstraintDetail":{ "shape":"ConstraintDetail", "documentation":"

The resulting detailed constraint information.

" }, "ConstraintParameters":{ "shape":"ConstraintParameters", "documentation":"

The resulting updated constraint parameters.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the current request.

" } } }, "UpdatePortfolioInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "Id":{ "shape":"Id", "documentation":"

The identifier of the portfolio for the update request.

" }, "DisplayName":{ "shape":"PortfolioDisplayName", "documentation":"

The name to use for display purposes.

" }, "Description":{ "shape":"PortfolioDescription", "documentation":"

The updated text description of the portfolio.

" }, "ProviderName":{ "shape":"ProviderName", "documentation":"

The updated name of the portfolio provider.

" }, "AddTags":{ "shape":"AddTags", "documentation":"

Tags to add to the existing list of tags associated with the portfolio.

" }, "RemoveTags":{ "shape":"TagKeys", "documentation":"

Tags to remove from the existing list of tags associated with the portfolio.

" } } }, "UpdatePortfolioOutput":{ "type":"structure", "members":{ "PortfolioDetail":{ "shape":"PortfolioDetail", "documentation":"

The resulting detailed portfolio information.

" }, "Tags":{ "shape":"Tags", "documentation":"

Tags associated with the portfolio.

" } } }, "UpdateProductInput":{ "type":"structure", "required":["Id"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "Id":{ "shape":"Id", "documentation":"

The identifier of the product for the update request.

" }, "Name":{ "shape":"ProductViewName", "documentation":"

The updated product name.

" }, "Owner":{ "shape":"ProductViewOwner", "documentation":"

The updated owner of the product.

" }, "Description":{ "shape":"ProductViewShortDescription", "documentation":"

The updated text description of the product.

" }, "Distributor":{ "shape":"ProductViewOwner", "documentation":"

The updated distributor of the product.

" }, "SupportDescription":{ "shape":"SupportDescription", "documentation":"

The updated support description for the product.

" }, "SupportEmail":{ "shape":"SupportEmail", "documentation":"

The updated support email for the product.

" }, "SupportUrl":{ "shape":"SupportUrl", "documentation":"

The updated support URL for the product.

" }, "AddTags":{ "shape":"AddTags", "documentation":"

Tags to add to the existing list of tags associated with the product.

" }, "RemoveTags":{ "shape":"TagKeys", "documentation":"

Tags to remove from the existing list of tags associated with the product.

" } } }, "UpdateProductOutput":{ "type":"structure", "members":{ "ProductViewDetail":{ "shape":"ProductViewDetail", "documentation":"

The resulting detailed product view information.

" }, "Tags":{ "shape":"Tags", "documentation":"

Tags associated with the product.

" } } }, "UpdateProvisionedProductInput":{ "type":"structure", "required":["UpdateToken"], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "ProvisionedProductName":{ "shape":"ProvisionedProductNameOrArn", "documentation":"

The updated name of the ProvisionedProduct object . You must specify either ProvisionedProductName or ProvisionedProductId, but not both.

" }, "ProvisionedProductId":{ "shape":"Id", "documentation":"

The identifier of the ProvisionedProduct object to update. You must specify either ProvisionedProductName or ProvisionedProductId, but not both.

" }, "ProductId":{ "shape":"Id", "documentation":"

The identifier of the ProvisionedProduct object.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The provisioning artifact identifier for this product.

" }, "PathId":{ "shape":"Id", "documentation":"

The identifier of the path to use in the updated ProvisionedProduct object. This value is optional if the product has a default path, and is required if there is more than one path for the specified product.

" }, "ProvisioningParameters":{ "shape":"UpdateProvisioningParameters", "documentation":"

A list of ProvisioningParameter objects used to update the ProvisionedProduct object.

" }, "UpdateToken":{ "shape":"IdempotencyToken", "documentation":"

The idempotency token that uniquely identifies the provisioning update request.

", "idempotencyToken":true } } }, "UpdateProvisionedProductOutput":{ "type":"structure", "members":{ "RecordDetail":{ "shape":"RecordDetail", "documentation":"

The detailed result of the UpdateProvisionedProduct request, containing the inputs made to that request, the current state of the request, a pointer to the ProvisionedProduct object that the request is modifying, and a list of any errors that the request encountered.

" } } }, "UpdateProvisioningArtifactInput":{ "type":"structure", "required":[ "ProductId", "ProvisioningArtifactId" ], "members":{ "AcceptLanguage":{ "shape":"AcceptLanguage", "documentation":"

The language code to use for this operation. Supported language codes are as follows:

\"en\" (English)

\"jp\" (Japanese)

\"zh\" (Chinese)

If no code is specified, \"en\" is used as the default.

" }, "ProductId":{ "shape":"Id", "documentation":"

The product identifier.

" }, "ProvisioningArtifactId":{ "shape":"Id", "documentation":"

The identifier of the provisioning artifact for the update request.

" }, "Name":{ "shape":"ProvisioningArtifactName", "documentation":"

The updated name of the provisioning artifact.

" }, "Description":{ "shape":"ProvisioningArtifactDescription", "documentation":"

The updated text description of the provisioning artifact.

" } } }, "UpdateProvisioningArtifactOutput":{ "type":"structure", "members":{ "ProvisioningArtifactDetail":{ "shape":"ProvisioningArtifactDetail", "documentation":"

The resulting detailed provisioning artifact information.

" }, "Info":{ "shape":"ProvisioningArtifactInfo", "documentation":"

Additional information about the provisioning artifact update request.

" }, "Status":{ "shape":"Status", "documentation":"

The status of the current request.

" } } }, "UpdateProvisioningParameter":{ "type":"structure", "members":{ "Key":{ "shape":"ParameterKey", "documentation":"

The ProvisioningArtifactParameter.ParameterKey parameter from DescribeProvisioningParameters.

" }, "Value":{ "shape":"ParameterValue", "documentation":"

The value to use for updating the product provisioning. Any constraints on this value can be found in the ProvisioningArtifactParameter parameter for Key.

" }, "UsePreviousValue":{ "shape":"UsePreviousValue", "documentation":"

If true, uses the currently set value for Key, ignoring UpdateProvisioningParameter.Value.

" } }, "documentation":"

The parameter key/value pair used to update a ProvisionedProduct object. If UsePreviousValue is set to true, Value is ignored and the value for Key is kept as previously set (current value).

" }, "UpdateProvisioningParameters":{ "type":"list", "member":{"shape":"UpdateProvisioningParameter"} }, "UpdatedTime":{"type":"timestamp"}, "UsageInstruction":{ "type":"structure", "members":{ "Type":{ "shape":"InstructionType", "documentation":"

The usage instruction type for the value.

" }, "Value":{ "shape":"InstructionValue", "documentation":"

The usage instruction value for this type.

" } }, "documentation":"

Additional information provided by the administrator.

" }, "UsageInstructions":{ "type":"list", "member":{"shape":"UsageInstruction"} }, "UsePreviousValue":{"type":"boolean"} }, "documentation":"AWS Service Catalog

Overview

AWS Service Catalog allows organizations to create and manage catalogs of IT services that are approved for use on AWS. This documentation provides reference material for the AWS Service Catalog end user API. To get the most out of this documentation, you need to be familiar with the terminology discussed in AWS Service Catalog Concepts.

Additional Resources

" } botocore-1.5.7/botocore/data/events/0000777454262600001440000000000013042511307020437 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/events/2014-02-03/0000777454262600001440000000000013042511307021464 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/events/2014-02-03/service-2.json0000666454262600001440000011143713042511306024164 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2014-02-03", "endpointPrefix":"events", "jsonVersion":"1.1", "serviceFullName":"Amazon CloudWatch Events", "signatureVersion":"v4", "targetPrefix":"AWSEvents", "protocol":"json" }, "documentation":"

Amazon CloudWatch Events helps you to respond to state changes in your AWS resources. When your resources change state they automatically send events into an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a pre-determined schedule. For example, you can configure rules to:

  • Automatically invoke an AWS Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.
  • Direct specific API records from CloudTrail to an Amazon Kinesis stream for detailed analysis of potential security or availability risks.
  • Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.

For more information about Amazon CloudWatch Events features, see the Amazon CloudWatch Developer Guide.

", "operations":{ "DeleteRule":{ "name":"DeleteRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteRuleRequest", "documentation":"

Container for the parameters to the DeleteRule operation.

" }, "errors":[ { "shape":"ConcurrentModificationException", "exception":true, "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Deletes a rule. You must remove all targets from a rule using RemoveTargets before you can delete the rule.

Note: When you make a change with this action, incoming events might still continue to match to the deleted rule. Please allow a short period of time for changes to take effect.

" }, "DescribeRule":{ "name":"DescribeRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeRuleRequest", "documentation":"

Container for the parameters to the DescribeRule operation.

" }, "output":{ "shape":"DescribeRuleResponse", "documentation":"

The result of the DescribeRule operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

The rule does not exist.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Describes the details of the specified rule.

" }, "DisableRule":{ "name":"DisableRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DisableRuleRequest", "documentation":"

Container for the parameters to the DisableRule operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

The rule does not exist.

" }, { "shape":"ConcurrentModificationException", "exception":true, "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Disables a rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.

Note: When you make a change with this action, incoming events might still continue to match to the disabled rule. Please allow a short period of time for changes to take effect.

" }, "EnableRule":{ "name":"EnableRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"EnableRuleRequest", "documentation":"

Container for the parameters to the EnableRule operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

The rule does not exist.

" }, { "shape":"ConcurrentModificationException", "exception":true, "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Enables a rule. If the rule does not exist, the operation fails.

Note: When you make a change with this action, incoming events might not immediately start matching to a newly enabled rule. Please allow a short period of time for changes to take effect.

" }, "ListRuleNamesByTarget":{ "name":"ListRuleNamesByTarget", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ListRuleNamesByTargetRequest", "documentation":"

Container for the parameters to the ListRuleNamesByTarget operation.

" }, "output":{ "shape":"ListRuleNamesByTargetResponse", "documentation":"

The result of the ListRuleNamesByTarget operation.

" }, "errors":[ { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Lists the names of the rules that the given target is put to. Using this action, you can find out which of the rules in Amazon CloudWatch Events can invoke a specific target in your account. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat the ListRulesByTarget action until the NextToken in the response is returned as null.

" }, "ListRules":{ "name":"ListRules", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ListRulesRequest", "documentation":"

Container for the parameters to the ListRules operation.

" }, "output":{ "shape":"ListRulesResponse", "documentation":"

The result of the ListRules operation.

" }, "errors":[ { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Lists the Amazon CloudWatch Events rules in your account. You can either list all the rules or you can provide a prefix to match to the rule names. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat the ListRules action until the NextToken in the response is returned as null.

" }, "ListTargetsByRule":{ "name":"ListTargetsByRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ListTargetsByRuleRequest", "documentation":"

Container for the parameters to the ListTargetsByRule operation.

" }, "output":{ "shape":"ListTargetsByRuleResponse", "documentation":"

The result of the ListTargetsByRule operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

The rule does not exist.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Lists of targets assigned to the rule.

" }, "PutEvents":{ "name":"PutEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"PutEventsRequest", "documentation":"

Container for the parameters to the PutEvents operation.

" }, "output":{ "shape":"PutEventsResponse", "documentation":"

The result of the PutEvents operation.

" }, "errors":[ { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.

" }, "PutRule":{ "name":"PutRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"PutRuleRequest", "documentation":"

Container for the parameters to the PutRule operation.

" }, "output":{ "shape":"PutRuleResponse", "documentation":"

The result of the PutRule operation.

" }, "errors":[ { "shape":"InvalidEventPatternException", "exception":true, "documentation":"

The event pattern is invalid.

" }, { "shape":"LimitExceededException", "exception":true, "documentation":"

This exception occurs if you try to create more rules or add more targets to a rule than allowed by default.

" }, { "shape":"ConcurrentModificationException", "exception":true, "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Creates or updates a rule. Rules are enabled by default, or based on value of the State parameter. You can disable a rule using DisableRule.

Note: When you make a change with this action, incoming events might not immediately start matching to new or updated rules. Please allow a short period of time for changes to take effect.

A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule will trigger on matching events as well as on a schedule.

Note: Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

" }, "PutTargets":{ "name":"PutTargets", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"PutTargetsRequest", "documentation":"

Container for the parameters to the PutTargets operation.

" }, "output":{ "shape":"PutTargetsResponse", "documentation":"

The result of the PutTargets operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

The rule does not exist.

" }, { "shape":"ConcurrentModificationException", "exception":true, "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" }, { "shape":"LimitExceededException", "exception":true, "documentation":"

This exception occurs if you try to create more rules or add more targets to a rule than allowed by default.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Adds target(s) to a rule. Updates the target(s) if they are already associated with the role. In other words, if there is already a target with the given target ID, then the target associated with that ID is updated.

Note: When you make a change with this action, when the associated rule triggers, new or updated targets might not be immediately invoked. Please allow a short period of time for changes to take effect.

" }, "RemoveTargets":{ "name":"RemoveTargets", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"RemoveTargetsRequest", "documentation":"

Container for the parameters to the RemoveTargets operation.

" }, "output":{ "shape":"RemoveTargetsResponse", "documentation":"

The result of the RemoveTargets operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

The rule does not exist.

" }, { "shape":"ConcurrentModificationException", "exception":true, "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Removes target(s) from a rule so that when the rule is triggered, those targets will no longer be invoked.

Note: When you make a change with this action, when the associated rule triggers, removed targets might still continue to be invoked. Please allow a short period of time for changes to take effect.

" }, "TestEventPattern":{ "name":"TestEventPattern", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"TestEventPatternRequest", "documentation":"

Container for the parameters to the TestEventPattern operation.

" }, "output":{ "shape":"TestEventPatternResponse", "documentation":"

The result of the TestEventPattern operation.

" }, "errors":[ { "shape":"InvalidEventPatternException", "exception":true, "documentation":"

The event pattern is invalid.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Tests whether an event pattern matches the provided event.

Note: Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

" } }, "shapes":{ "Boolean":{"type":"boolean"}, "ConcurrentModificationException":{ "type":"structure", "members":{ }, "exception":true, "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" }, "DeleteRuleRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule to be deleted.

" } }, "documentation":"

Container for the parameters to the DeleteRule operation.

" }, "DescribeRuleRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule you want to describe details for.

" } }, "documentation":"

Container for the parameters to the DescribeRule operation.

" }, "DescribeRuleResponse":{ "type":"structure", "members":{ "Name":{ "shape":"RuleName", "documentation":"

The rule's name.

" }, "Arn":{ "shape":"RuleArn", "documentation":"

The Amazon Resource Name (ARN) associated with the rule.

" }, "EventPattern":{ "shape":"EventPattern", "documentation":"

The event pattern.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\".

" }, "State":{ "shape":"RuleState", "documentation":"

Specifies whether the rule is enabled or disabled.

" }, "Description":{ "shape":"RuleDescription", "documentation":"

The rule's description.

" }, "RoleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" } }, "documentation":"

The result of the DescribeRule operation.

" }, "DisableRuleRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule you want to disable.

" } }, "documentation":"

Container for the parameters to the DisableRule operation.

" }, "EnableRuleRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule that you want to enable.

" } }, "documentation":"

Container for the parameters to the EnableRule operation.

" }, "ErrorCode":{"type":"string"}, "ErrorMessage":{"type":"string"}, "EventId":{"type":"string"}, "EventPattern":{ "type":"string", "max":2048 }, "EventResource":{"type":"string"}, "EventResourceList":{ "type":"list", "member":{"shape":"EventResource"} }, "EventTime":{"type":"timestamp"}, "Integer":{"type":"integer"}, "InternalException":{ "type":"structure", "members":{ }, "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" }, "InvalidEventPatternException":{ "type":"structure", "members":{ }, "exception":true, "documentation":"

The event pattern is invalid.

" }, "LimitExceededException":{ "type":"structure", "members":{ }, "exception":true, "documentation":"

This exception occurs if you try to create more rules or add more targets to a rule than allowed by default.

" }, "LimitMax100":{ "type":"integer", "min":1, "max":100 }, "ListRuleNamesByTargetRequest":{ "type":"structure", "required":["TargetArn"], "members":{ "TargetArn":{ "shape":"TargetArn", "documentation":"

The Amazon Resource Name (ARN) of the target resource that you want to list the rules for.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

" }, "Limit":{ "shape":"LimitMax100", "documentation":"

The maximum number of results to return.

" } }, "documentation":"

Container for the parameters to the ListRuleNamesByTarget operation.

" }, "ListRuleNamesByTargetResponse":{ "type":"structure", "members":{ "RuleNames":{ "shape":"RuleNameList", "documentation":"

List of rules names that can invoke the given target.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Indicates that there are additional results to retrieve.

" } }, "documentation":"

The result of the ListRuleNamesByTarget operation.

" }, "ListRulesRequest":{ "type":"structure", "members":{ "NamePrefix":{ "shape":"RuleName", "documentation":"

The prefix matching the rule name.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

" }, "Limit":{ "shape":"LimitMax100", "documentation":"

The maximum number of results to return.

" } }, "documentation":"

Container for the parameters to the ListRules operation.

" }, "ListRulesResponse":{ "type":"structure", "members":{ "Rules":{ "shape":"RuleResponseList", "documentation":"

List of rules matching the specified criteria.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Indicates that there are additional results to retrieve.

" } }, "documentation":"

The result of the ListRules operation.

" }, "ListTargetsByRuleRequest":{ "type":"structure", "required":["Rule"], "members":{ "Rule":{ "shape":"RuleName", "documentation":"

The name of the rule whose targets you want to list.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

" }, "Limit":{ "shape":"LimitMax100", "documentation":"

The maximum number of results to return.

" } }, "documentation":"

Container for the parameters to the ListTargetsByRule operation.

" }, "ListTargetsByRuleResponse":{ "type":"structure", "members":{ "Targets":{ "shape":"TargetList", "documentation":"

Lists the targets assigned to the rule.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Indicates that there are additional results to retrieve.

" } }, "documentation":"

The result of the ListTargetsByRule operation.

" }, "NextToken":{ "type":"string", "min":1, "max":2048 }, "PutEventsRequest":{ "type":"structure", "required":["Entries"], "members":{ "Entries":{ "shape":"PutEventsRequestEntryList", "documentation":"

The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.

" } }, "documentation":"

Container for the parameters to the PutEvents operation.

" }, "PutEventsRequestEntry":{ "type":"structure", "members":{ "Time":{ "shape":"EventTime", "documentation":"

Timestamp of event, per RFC3339. If no timestamp is provided, the timestamp of the PutEvents call will be used.

" }, "Source":{ "shape":"String", "documentation":"

The source of the event.

" }, "Resources":{ "shape":"EventResourceList", "documentation":"

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

" }, "DetailType":{ "shape":"String", "documentation":"

Free-form string used to decide what fields to expect in the event detail.

" }, "Detail":{ "shape":"String", "documentation":"

In the JSON sense, an object containing fields, which may also contain nested sub-objects. No constraints are imposed on its contents.

" } }, "documentation":"

Contains information about the event to be used in the PutEvents action.

" }, "PutEventsRequestEntryList":{ "type":"list", "member":{"shape":"PutEventsRequestEntry"}, "min":1, "max":10 }, "PutEventsResponse":{ "type":"structure", "members":{ "FailedEntryCount":{ "shape":"Integer", "documentation":"

The number of failed entries.

" }, "Entries":{ "shape":"PutEventsResultEntryList", "documentation":"

A list of successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry will have the event ID in it. If not, then the ErrorCode and ErrorMessage can be used to identify the problem with the entry.

" } }, "documentation":"

The result of the PutEvents operation.

" }, "PutEventsResultEntry":{ "type":"structure", "members":{ "EventId":{ "shape":"EventId", "documentation":"

The ID of the event submitted to Amazon CloudWatch Events.

" }, "ErrorCode":{ "shape":"ErrorCode", "documentation":"

The error code representing why the event submission failed on this entry.

" }, "ErrorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message explaining why the event submission failed on this entry.

" } }, "documentation":"

A PutEventsResult contains a list of PutEventsResultEntry.

" }, "PutEventsResultEntryList":{ "type":"list", "member":{"shape":"PutEventsResultEntry"} }, "PutRuleRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule that you are creating or updating.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\".

" }, "EventPattern":{ "shape":"EventPattern", "documentation":"

The event pattern.

" }, "State":{ "shape":"RuleState", "documentation":"

Indicates whether the rule is enabled or disabled.

" }, "Description":{ "shape":"RuleDescription", "documentation":"

A description of the rule.

" }, "RoleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" } }, "documentation":"

Container for the parameters to the PutRule operation.

" }, "PutRuleResponse":{ "type":"structure", "members":{ "RuleArn":{ "shape":"RuleArn", "documentation":"

The Amazon Resource Name (ARN) that identifies the rule.

" } }, "documentation":"

The result of the PutRule operation.

" }, "PutTargetsRequest":{ "type":"structure", "required":[ "Rule", "Targets" ], "members":{ "Rule":{ "shape":"RuleName", "documentation":"

The name of the rule you want to add targets to.

" }, "Targets":{ "shape":"TargetList", "documentation":"

List of targets you want to update or add to the rule.

" } }, "documentation":"

Container for the parameters to the PutTargets operation.

" }, "PutTargetsResponse":{ "type":"structure", "members":{ "FailedEntryCount":{ "shape":"Integer", "documentation":"

The number of failed entries.

" }, "FailedEntries":{ "shape":"PutTargetsResultEntryList", "documentation":"

An array of failed target entries.

" } }, "documentation":"

The result of the PutTargets operation.

" }, "PutTargetsResultEntry":{ "type":"structure", "members":{ "TargetId":{ "shape":"TargetId", "documentation":"

The ID of the target submitted to Amazon CloudWatch Events.

" }, "ErrorCode":{ "shape":"ErrorCode", "documentation":"

The error code representing why the target submission failed on this entry.

" }, "ErrorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message explaining why the target submission failed on this entry.

" } }, "documentation":"

A PutTargetsResult contains a list of PutTargetsResultEntry.

" }, "PutTargetsResultEntryList":{ "type":"list", "member":{"shape":"PutTargetsResultEntry"} }, "RemoveTargetsRequest":{ "type":"structure", "required":[ "Rule", "Ids" ], "members":{ "Rule":{ "shape":"RuleName", "documentation":"

The name of the rule you want to remove targets from.

" }, "Ids":{ "shape":"TargetIdList", "documentation":"

The list of target IDs to remove from the rule.

" } }, "documentation":"

Container for the parameters to the RemoveTargets operation.

" }, "RemoveTargetsResponse":{ "type":"structure", "members":{ "FailedEntryCount":{ "shape":"Integer", "documentation":"

The number of failed entries.

" }, "FailedEntries":{ "shape":"RemoveTargetsResultEntryList", "documentation":"

An array of failed target entries.

" } }, "documentation":"

The result of the RemoveTargets operation.

" }, "RemoveTargetsResultEntry":{ "type":"structure", "members":{ "TargetId":{ "shape":"TargetId", "documentation":"

The ID of the target requested to be removed by Amazon CloudWatch Events.

" }, "ErrorCode":{ "shape":"ErrorCode", "documentation":"

The error code representing why the target removal failed on this entry.

" }, "ErrorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message explaining why the target removal failed on this entry.

" } }, "documentation":"

The ID of the target requested to be removed from the rule by Amazon CloudWatch Events.

" }, "RemoveTargetsResultEntryList":{ "type":"list", "member":{"shape":"RemoveTargetsResultEntry"} }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "exception":true, "documentation":"

The rule does not exist.

" }, "RoleArn":{ "type":"string", "min":1, "max":1600 }, "Rule":{ "type":"structure", "members":{ "Name":{ "shape":"RuleName", "documentation":"

The rule's name.

" }, "Arn":{ "shape":"RuleArn", "documentation":"

The Amazon Resource Name (ARN) of the rule.

" }, "EventPattern":{ "shape":"EventPattern", "documentation":"

The event pattern of the rule.

" }, "State":{ "shape":"RuleState", "documentation":"

The rule's state.

" }, "Description":{ "shape":"RuleDescription", "documentation":"

The description of the rule.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\".

" }, "RoleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) associated with the role that is used for target invocation.

" } }, "documentation":"

Contains information about a rule in Amazon CloudWatch Events. A ListRulesResult contains a list of Rules.

" }, "RuleArn":{ "type":"string", "min":1, "max":1600 }, "RuleDescription":{ "type":"string", "max":512 }, "RuleName":{ "type":"string", "min":1, "max":64, "pattern":"[\\.\\-_A-Za-z0-9]+" }, "RuleNameList":{ "type":"list", "member":{"shape":"RuleName"} }, "RuleResponseList":{ "type":"list", "member":{"shape":"Rule"} }, "RuleState":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "ScheduleExpression":{ "type":"string", "max":256 }, "String":{"type":"string"}, "Target":{ "type":"structure", "required":[ "Id", "Arn" ], "members":{ "Id":{ "shape":"TargetId", "documentation":"

The unique target assignment ID.

" }, "Arn":{ "shape":"TargetArn", "documentation":"

The Amazon Resource Name (ARN) associated of the target.

" }, "Input":{ "shape":"TargetInput", "documentation":"

Valid JSON text passed to the target. For more information about JSON text, see The JavaScript Object Notation (JSON) Data Interchange Format.

" }, "InputPath":{ "shape":"TargetInputPath", "documentation":"

The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. For more information about JSON paths, see JSONPath.

" } }, "documentation":"

Targets are the resources that can be invoked when a rule is triggered. For example, AWS Lambda functions, Amazon Kinesis streams, and built-in targets.

Input and InputPath are mutually-exclusive and optional parameters of a target. When a rule is triggered due to a matched event, if for a target:

  • Neither Input nor InputPath is specified, then the entire event is passed to the target in JSON form.
  • InputPath is specified in the form of JSONPath (e.g. $.detail), then only the part of the event specified in the path is passed to the target (e.g. only the detail part of the event is passed).
  • Input is specified in the form of a valid JSON, then the matched event is overridden with this constant.
" }, "TargetArn":{ "type":"string", "min":1, "max":1600 }, "TargetId":{ "type":"string", "min":1, "max":64, "pattern":"[\\.\\-_A-Za-z0-9]+" }, "TargetIdList":{ "type":"list", "member":{"shape":"TargetId"}, "min":1, "max":100 }, "TargetInput":{ "type":"string", "max":8192 }, "TargetInputPath":{ "type":"string", "max":256 }, "TargetList":{ "type":"list", "member":{"shape":"Target"} }, "TestEventPatternRequest":{ "type":"structure", "required":[ "EventPattern", "Event" ], "members":{ "EventPattern":{ "shape":"EventPattern", "documentation":"

The event pattern you want to test.

" }, "Event":{ "shape":"String", "documentation":"

The event in the JSON format to test against the event pattern.

" } }, "documentation":"

Container for the parameters to the TestEventPattern operation.

" }, "TestEventPatternResponse":{ "type":"structure", "members":{ "Result":{ "shape":"Boolean", "documentation":"

Indicates whether the event matches the event pattern.

" } }, "documentation":"

The result of the TestEventPattern operation.

" } }, "examples":{ } } botocore-1.5.7/botocore/data/events/2015-10-07/0000777454262600001440000000000013042511307021470 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/events/2015-10-07/service-2.json0000666454262600001440000011374513042511306024174 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"events-2015-10-07", "apiVersion":"2015-10-07", "endpointPrefix":"events", "jsonVersion":"1.1", "serviceFullName":"Amazon CloudWatch Events", "signatureVersion":"v4", "targetPrefix":"AWSEvents", "protocol":"json" }, "documentation":"

Amazon CloudWatch Events helps you to respond to state changes in your AWS resources. When your resources change state they automatically send events into an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a pre-determined schedule. For example, you can configure rules to:

  • Automatically invoke an AWS Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.
  • Direct specific API records from CloudTrail to an Amazon Kinesis stream for detailed analysis of potential security or availability risks.
  • Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.

For more information about Amazon CloudWatch Events features, see the Amazon CloudWatch Developer Guide.

", "operations":{ "DeleteRule":{ "name":"DeleteRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteRuleRequest", "documentation":"

Container for the parameters to the DeleteRule operation.

" }, "errors":[ { "shape":"ConcurrentModificationException", "exception":true, "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Deletes a rule. You must remove all targets from a rule using RemoveTargets before you can delete the rule.

Note: When you delete a rule, incoming events might still continue to match to the deleted rule. Please allow a short period of time for changes to take effect.

" }, "DescribeRule":{ "name":"DescribeRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeRuleRequest", "documentation":"

Container for the parameters to the DescribeRule operation.

" }, "output":{ "shape":"DescribeRuleResponse", "documentation":"

The result of the DescribeRule operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

The rule does not exist.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Describes the details of the specified rule.

" }, "DisableRule":{ "name":"DisableRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DisableRuleRequest", "documentation":"

Container for the parameters to the DisableRule operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

The rule does not exist.

" }, { "shape":"ConcurrentModificationException", "exception":true, "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Disables a rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.

Note: When you disable a rule, incoming events might still continue to match to the disabled rule. Please allow a short period of time for changes to take effect.

" }, "EnableRule":{ "name":"EnableRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"EnableRuleRequest", "documentation":"

Container for the parameters to the EnableRule operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

The rule does not exist.

" }, { "shape":"ConcurrentModificationException", "exception":true, "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Enables a rule. If the rule does not exist, the operation fails.

Note: When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Please allow a short period of time for changes to take effect.

" }, "ListRuleNamesByTarget":{ "name":"ListRuleNamesByTarget", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ListRuleNamesByTargetRequest", "documentation":"

Container for the parameters to the ListRuleNamesByTarget operation.

" }, "output":{ "shape":"ListRuleNamesByTargetResponse", "documentation":"

The result of the ListRuleNamesByTarget operation.

" }, "errors":[ { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Lists the names of the rules that the given target is put to. You can see which of the rules in Amazon CloudWatch Events can invoke a specific target in your account. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat ListRulesByTarget until the NextToken in the response is returned as null.

" }, "ListRules":{ "name":"ListRules", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ListRulesRequest", "documentation":"

Container for the parameters to the ListRules operation.

" }, "output":{ "shape":"ListRulesResponse", "documentation":"

The result of the ListRules operation.

" }, "errors":[ { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Lists the Amazon CloudWatch Events rules in your account. You can either list all the rules or you can provide a prefix to match to the rule names. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat ListRules until the NextToken in the response is returned as null.

" }, "ListTargetsByRule":{ "name":"ListTargetsByRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"ListTargetsByRuleRequest", "documentation":"

Container for the parameters to the ListTargetsByRule operation.

" }, "output":{ "shape":"ListTargetsByRuleResponse", "documentation":"

The result of the ListTargetsByRule operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

The rule does not exist.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Lists of targets assigned to the rule.

" }, "PutEvents":{ "name":"PutEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"PutEventsRequest", "documentation":"

Container for the parameters to the PutEvents operation.

" }, "output":{ "shape":"PutEventsResponse", "documentation":"

The result of the PutEvents operation.

" }, "errors":[ { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.

" }, "PutRule":{ "name":"PutRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"PutRuleRequest", "documentation":"

Container for the parameters to the PutRule operation.

" }, "output":{ "shape":"PutRuleResponse", "documentation":"

The result of the PutRule operation.

" }, "errors":[ { "shape":"InvalidEventPatternException", "exception":true, "documentation":"

The event pattern is invalid.

" }, { "shape":"LimitExceededException", "exception":true, "documentation":"

This exception occurs if you try to create more rules or add more targets to a rule than allowed by default.

" }, { "shape":"ConcurrentModificationException", "exception":true, "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Creates or updates a rule. Rules are enabled by default, or based on value of the State parameter. You can disable a rule using DisableRule.

Note: When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Please allow a short period of time for changes to take effect.

A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule will trigger on matching events as well as on a schedule.

Note: Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

" }, "PutTargets":{ "name":"PutTargets", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"PutTargetsRequest", "documentation":"

Container for the parameters to the PutTargets operation.

" }, "output":{ "shape":"PutTargetsResponse", "documentation":"

The result of the PutTargets operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

The rule does not exist.

" }, { "shape":"ConcurrentModificationException", "exception":true, "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" }, { "shape":"LimitExceededException", "exception":true, "documentation":"

This exception occurs if you try to create more rules or add more targets to a rule than allowed by default.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Adds target(s) to a rule. Targets are the resources that can be invoked when a rule is triggered. For example, AWS Lambda functions, Amazon Kinesis streams, and built-in targets. Updates the target(s) if they are already associated with the role. In other words, if there is already a target with the given target ID, then the target associated with that ID is updated.

In order to be able to make API calls against the resources you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For Amazon Kinesis streams, CloudWatch Events relies on IAM roles. For more information, see Permissions for Sending Events to Targets in the Amazon CloudWatch Developer Guide.

Input and InputPath are mutually-exclusive and optional parameters of a target. When a rule is triggered due to a matched event, if for a target:

  • Neither Input nor InputPath is specified, then the entire event is passed to the target in JSON form.
  • InputPath is specified in the form of JSONPath (e.g. $.detail), then only the part of the event specified in the path is passed to the target (e.g. only the detail part of the event is passed).
  • Input is specified in the form of a valid JSON, then the matched event is overridden with this constant.

Note: When you add targets to a rule, when the associated rule triggers, new or updated targets might not be immediately invoked. Please allow a short period of time for changes to take effect.

" }, "RemoveTargets":{ "name":"RemoveTargets", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"RemoveTargetsRequest", "documentation":"

Container for the parameters to the RemoveTargets operation.

" }, "output":{ "shape":"RemoveTargetsResponse", "documentation":"

The result of the RemoveTargets operation.

" }, "errors":[ { "shape":"ResourceNotFoundException", "exception":true, "documentation":"

The rule does not exist.

" }, { "shape":"ConcurrentModificationException", "exception":true, "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Removes target(s) from a rule so that when the rule is triggered, those targets will no longer be invoked.

Note: When you remove a target, when the associated rule triggers, removed targets might still continue to be invoked. Please allow a short period of time for changes to take effect.

" }, "TestEventPattern":{ "name":"TestEventPattern", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"TestEventPatternRequest", "documentation":"

Container for the parameters to the TestEventPattern operation.

" }, "output":{ "shape":"TestEventPatternResponse", "documentation":"

The result of the TestEventPattern operation.

" }, "errors":[ { "shape":"InvalidEventPatternException", "exception":true, "documentation":"

The event pattern is invalid.

" }, { "shape":"InternalException", "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" } ], "documentation":"

Tests whether an event pattern matches the provided event.

Note: Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

" } }, "shapes":{ "Boolean":{"type":"boolean"}, "ConcurrentModificationException":{ "type":"structure", "members":{ }, "exception":true, "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" }, "DeleteRuleRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule to be deleted.

" } }, "documentation":"

Container for the parameters to the DeleteRule operation.

" }, "DescribeRuleRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule you want to describe details for.

" } }, "documentation":"

Container for the parameters to the DescribeRule operation.

" }, "DescribeRuleResponse":{ "type":"structure", "members":{ "Name":{ "shape":"RuleName", "documentation":"

The rule's name.

" }, "Arn":{ "shape":"RuleArn", "documentation":"

The Amazon Resource Name (ARN) associated with the rule.

" }, "EventPattern":{ "shape":"EventPattern", "documentation":"

The event pattern.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\".

" }, "State":{ "shape":"RuleState", "documentation":"

Specifies whether the rule is enabled or disabled.

" }, "Description":{ "shape":"RuleDescription", "documentation":"

The rule's description.

" }, "RoleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" } }, "documentation":"

The result of the DescribeRule operation.

" }, "DisableRuleRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule you want to disable.

" } }, "documentation":"

Container for the parameters to the DisableRule operation.

" }, "EnableRuleRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule that you want to enable.

" } }, "documentation":"

Container for the parameters to the EnableRule operation.

" }, "ErrorCode":{"type":"string"}, "ErrorMessage":{"type":"string"}, "EventId":{"type":"string"}, "EventPattern":{ "type":"string", "max":2048 }, "EventResource":{"type":"string"}, "EventResourceList":{ "type":"list", "member":{"shape":"EventResource"} }, "EventTime":{"type":"timestamp"}, "Integer":{"type":"integer"}, "InternalException":{ "type":"structure", "members":{ }, "exception":true, "fault":true, "documentation":"

This exception occurs due to unexpected causes.

" }, "InvalidEventPatternException":{ "type":"structure", "members":{ }, "exception":true, "documentation":"

The event pattern is invalid.

" }, "LimitExceededException":{ "type":"structure", "members":{ }, "exception":true, "documentation":"

This exception occurs if you try to create more rules or add more targets to a rule than allowed by default.

" }, "LimitMax100":{ "type":"integer", "min":1, "max":100 }, "ListRuleNamesByTargetRequest":{ "type":"structure", "required":["TargetArn"], "members":{ "TargetArn":{ "shape":"TargetArn", "documentation":"

The Amazon Resource Name (ARN) of the target resource that you want to list the rules for.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

" }, "Limit":{ "shape":"LimitMax100", "documentation":"

The maximum number of results to return.

" } }, "documentation":"

Container for the parameters to the ListRuleNamesByTarget operation.

" }, "ListRuleNamesByTargetResponse":{ "type":"structure", "members":{ "RuleNames":{ "shape":"RuleNameList", "documentation":"

List of rules names that can invoke the given target.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Indicates that there are additional results to retrieve.

" } }, "documentation":"

The result of the ListRuleNamesByTarget operation.

" }, "ListRulesRequest":{ "type":"structure", "members":{ "NamePrefix":{ "shape":"RuleName", "documentation":"

The prefix matching the rule name.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

" }, "Limit":{ "shape":"LimitMax100", "documentation":"

The maximum number of results to return.

" } }, "documentation":"

Container for the parameters to the ListRules operation.

" }, "ListRulesResponse":{ "type":"structure", "members":{ "Rules":{ "shape":"RuleResponseList", "documentation":"

List of rules matching the specified criteria.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Indicates that there are additional results to retrieve.

" } }, "documentation":"

The result of the ListRules operation.

" }, "ListTargetsByRuleRequest":{ "type":"structure", "required":["Rule"], "members":{ "Rule":{ "shape":"RuleName", "documentation":"

The name of the rule whose targets you want to list.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

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

" }, "Limit":{ "shape":"LimitMax100", "documentation":"

The maximum number of results to return.

" } }, "documentation":"

Container for the parameters to the ListTargetsByRule operation.

" }, "ListTargetsByRuleResponse":{ "type":"structure", "members":{ "Targets":{ "shape":"TargetList", "documentation":"

Lists the targets assigned to the rule.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Indicates that there are additional results to retrieve.

" } }, "documentation":"

The result of the ListTargetsByRule operation.

" }, "NextToken":{ "type":"string", "min":1, "max":2048 }, "PutEventsRequest":{ "type":"structure", "required":["Entries"], "members":{ "Entries":{ "shape":"PutEventsRequestEntryList", "documentation":"

The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.

" } }, "documentation":"

Container for the parameters to the PutEvents operation.

" }, "PutEventsRequestEntry":{ "type":"structure", "members":{ "Time":{ "shape":"EventTime", "documentation":"

Timestamp of event, per RFC3339. If no timestamp is provided, the timestamp of the PutEvents call will be used.

" }, "Source":{ "shape":"String", "documentation":"

The source of the event.

" }, "Resources":{ "shape":"EventResourceList", "documentation":"

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

" }, "DetailType":{ "shape":"String", "documentation":"

Free-form string used to decide what fields to expect in the event detail.

" }, "Detail":{ "shape":"String", "documentation":"

In the JSON sense, an object containing fields, which may also contain nested sub-objects. No constraints are imposed on its contents.

" } }, "documentation":"

Contains information about the event to be used in PutEvents.

" }, "PutEventsRequestEntryList":{ "type":"list", "member":{"shape":"PutEventsRequestEntry"}, "min":1, "max":10 }, "PutEventsResponse":{ "type":"structure", "members":{ "FailedEntryCount":{ "shape":"Integer", "documentation":"

The number of failed entries.

" }, "Entries":{ "shape":"PutEventsResultEntryList", "documentation":"

A list of successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry will have the event ID in it. If not, then the ErrorCode and ErrorMessage can be used to identify the problem with the entry.

" } }, "documentation":"

The result of the PutEvents operation.

" }, "PutEventsResultEntry":{ "type":"structure", "members":{ "EventId":{ "shape":"EventId", "documentation":"

The ID of the event submitted to Amazon CloudWatch Events.

" }, "ErrorCode":{ "shape":"ErrorCode", "documentation":"

The error code representing why the event submission failed on this entry.

" }, "ErrorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message explaining why the event submission failed on this entry.

" } }, "documentation":"

A PutEventsResult contains a list of PutEventsResultEntry.

" }, "PutEventsResultEntryList":{ "type":"list", "member":{"shape":"PutEventsResultEntry"} }, "PutRuleRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule that you are creating or updating.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\".

" }, "EventPattern":{ "shape":"EventPattern", "documentation":"

The event pattern.

" }, "State":{ "shape":"RuleState", "documentation":"

Indicates whether the rule is enabled or disabled.

" }, "Description":{ "shape":"RuleDescription", "documentation":"

A description of the rule.

" }, "RoleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" } }, "documentation":"

Container for the parameters to the PutRule operation.

" }, "PutRuleResponse":{ "type":"structure", "members":{ "RuleArn":{ "shape":"RuleArn", "documentation":"

The Amazon Resource Name (ARN) that identifies the rule.

" } }, "documentation":"

The result of the PutRule operation.

" }, "PutTargetsRequest":{ "type":"structure", "required":[ "Rule", "Targets" ], "members":{ "Rule":{ "shape":"RuleName", "documentation":"

The name of the rule you want to add targets to.

" }, "Targets":{ "shape":"TargetList", "documentation":"

List of targets you want to update or add to the rule.

" } }, "documentation":"

Container for the parameters to the PutTargets operation.

" }, "PutTargetsResponse":{ "type":"structure", "members":{ "FailedEntryCount":{ "shape":"Integer", "documentation":"

The number of failed entries.

" }, "FailedEntries":{ "shape":"PutTargetsResultEntryList", "documentation":"

An array of failed target entries.

" } }, "documentation":"

The result of the PutTargets operation.

" }, "PutTargetsResultEntry":{ "type":"structure", "members":{ "TargetId":{ "shape":"TargetId", "documentation":"

The ID of the target submitted to Amazon CloudWatch Events.

" }, "ErrorCode":{ "shape":"ErrorCode", "documentation":"

The error code representing why the target submission failed on this entry.

" }, "ErrorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message explaining why the target submission failed on this entry.

" } }, "documentation":"

A PutTargetsResult contains a list of PutTargetsResultEntry.

" }, "PutTargetsResultEntryList":{ "type":"list", "member":{"shape":"PutTargetsResultEntry"} }, "RemoveTargetsRequest":{ "type":"structure", "required":[ "Rule", "Ids" ], "members":{ "Rule":{ "shape":"RuleName", "documentation":"

The name of the rule you want to remove targets from.

" }, "Ids":{ "shape":"TargetIdList", "documentation":"

The list of target IDs to remove from the rule.

" } }, "documentation":"

Container for the parameters to the RemoveTargets operation.

" }, "RemoveTargetsResponse":{ "type":"structure", "members":{ "FailedEntryCount":{ "shape":"Integer", "documentation":"

The number of failed entries.

" }, "FailedEntries":{ "shape":"RemoveTargetsResultEntryList", "documentation":"

An array of failed target entries.

" } }, "documentation":"

The result of the RemoveTargets operation.

" }, "RemoveTargetsResultEntry":{ "type":"structure", "members":{ "TargetId":{ "shape":"TargetId", "documentation":"

The ID of the target requested to be removed by Amazon CloudWatch Events.

" }, "ErrorCode":{ "shape":"ErrorCode", "documentation":"

The error code representing why the target removal failed on this entry.

" }, "ErrorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message explaining why the target removal failed on this entry.

" } }, "documentation":"

The ID of the target requested to be removed from the rule by Amazon CloudWatch Events.

" }, "RemoveTargetsResultEntryList":{ "type":"list", "member":{"shape":"RemoveTargetsResultEntry"} }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "exception":true, "documentation":"

The rule does not exist.

" }, "RoleArn":{ "type":"string", "min":1, "max":1600 }, "Rule":{ "type":"structure", "members":{ "Name":{ "shape":"RuleName", "documentation":"

The rule's name.

" }, "Arn":{ "shape":"RuleArn", "documentation":"

The Amazon Resource Name (ARN) of the rule.

" }, "EventPattern":{ "shape":"EventPattern", "documentation":"

The event pattern of the rule.

" }, "State":{ "shape":"RuleState", "documentation":"

The rule's state.

" }, "Description":{ "shape":"RuleDescription", "documentation":"

The description of the rule.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\".

" }, "RoleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) associated with the role that is used for target invocation.

" } }, "documentation":"

Contains information about a rule in Amazon CloudWatch Events. A ListRulesResult contains a list of Rules.

" }, "RuleArn":{ "type":"string", "min":1, "max":1600 }, "RuleDescription":{ "type":"string", "max":512 }, "RuleName":{ "type":"string", "min":1, "max":64, "pattern":"[\\.\\-_A-Za-z0-9]+" }, "RuleNameList":{ "type":"list", "member":{"shape":"RuleName"} }, "RuleResponseList":{ "type":"list", "member":{"shape":"Rule"} }, "RuleState":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "ScheduleExpression":{ "type":"string", "max":256 }, "String":{"type":"string"}, "Target":{ "type":"structure", "required":[ "Id", "Arn" ], "members":{ "Id":{ "shape":"TargetId", "documentation":"

The unique target assignment ID.

" }, "Arn":{ "shape":"TargetArn", "documentation":"

The Amazon Resource Name (ARN) associated of the target.

" }, "Input":{ "shape":"TargetInput", "documentation":"

Valid JSON text passed to the target. For more information about JSON text, see The JavaScript Object Notation (JSON) Data Interchange Format.

" }, "InputPath":{ "shape":"TargetInputPath", "documentation":"

The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. For more information about JSON paths, see JSONPath.

" } }, "documentation":"

Targets are the resources that can be invoked when a rule is triggered. For example, AWS Lambda functions, Amazon Kinesis streams, and built-in targets.

Input and InputPath are mutually-exclusive and optional parameters of a target. When a rule is triggered due to a matched event, if for a target:

  • Neither Input nor InputPath is specified, then the entire event is passed to the target in JSON form.
  • InputPath is specified in the form of JSONPath (e.g. $.detail), then only the part of the event specified in the path is passed to the target (e.g. only the detail part of the event is passed).
  • Input is specified in the form of a valid JSON, then the matched event is overridden with this constant.
" }, "TargetArn":{ "type":"string", "min":1, "max":1600 }, "TargetId":{ "type":"string", "min":1, "max":64, "pattern":"[\\.\\-_A-Za-z0-9]+" }, "TargetIdList":{ "type":"list", "member":{"shape":"TargetId"}, "min":1, "max":100 }, "TargetInput":{ "type":"string", "max":8192 }, "TargetInputPath":{ "type":"string", "max":256 }, "TargetList":{ "type":"list", "member":{"shape":"Target"} }, "TestEventPatternRequest":{ "type":"structure", "required":[ "EventPattern", "Event" ], "members":{ "EventPattern":{ "shape":"EventPattern", "documentation":"

The event pattern you want to test.

" }, "Event":{ "shape":"String", "documentation":"

The event in the JSON format to test against the event pattern.

" } }, "documentation":"

Container for the parameters to the TestEventPattern operation.

" }, "TestEventPatternResponse":{ "type":"structure", "members":{ "Result":{ "shape":"Boolean", "documentation":"

Indicates whether the event matches the event pattern.

" } }, "documentation":"

The result of the TestEventPattern operation.

" } }, "examples":{ } } botocore-1.5.7/botocore/data/kms/0000777454262600001440000000000013042511307017725 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/kms/2014-11-01/0000777454262600001440000000000013042511307020750 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/kms/2014-11-01/paginators-1.json0000666454262600001440000000141113042511306024144 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListAliases": { "limit_key": "Limit", "input_token": "Marker", "output_token": "NextMarker", "more_results": "Truncated", "result_key": "Aliases" }, "ListGrants": { "limit_key": "Limit", "input_token": "Marker", "output_token": "NextMarker", "more_results": "Truncated", "result_key": "Grants" }, "ListKeyPolicies": { "limit_key": "Limit", "input_token": "Marker", "output_token": "NextMarker", "more_results": "Truncated", "result_key": "PolicyNames" }, "ListKeys": { "limit_key": "Limit", "input_token": "Marker", "output_token": "NextMarker", "more_results": "Truncated", "result_key": "Keys" } } } botocore-1.5.7/botocore/data/kms/2014-11-01/service-2.json0000777454262600001440000031661113042511306023454 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2014-11-01", "endpointPrefix":"kms", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"KMS", "serviceFullName":"AWS Key Management Service", "signatureVersion":"v4", "targetPrefix":"TrentService", "uid":"kms-2014-11-01" }, "operations":{ "CancelKeyDeletion":{ "name":"CancelKeyDeletion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelKeyDeletionRequest"}, "output":{"shape":"CancelKeyDeletionResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the Disabled state. To enable a CMK, use EnableKey.

For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

" }, "CreateAlias":{ "name":"CreateAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAliasRequest"}, "errors":[ {"shape":"DependencyTimeoutException"}, {"shape":"AlreadyExistsException"}, {"shape":"NotFoundException"}, {"shape":"InvalidAliasNameException"}, {"shape":"KMSInternalException"}, {"shape":"LimitExceededException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word \"alias\" followed by a forward slash (alias/). An alias that begins with \"aws\" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).

The alias and the key it is mapped to must be in the same AWS account and the same region.

To map an alias to a different key, call UpdateAlias.

" }, "CreateGrant":{ "name":"CreateGrant", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateGrantRequest"}, "output":{"shape":"CreateGrantResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DisabledException"}, {"shape":"DependencyTimeoutException"}, {"shape":"InvalidArnException"}, {"shape":"KMSInternalException"}, {"shape":"InvalidGrantTokenException"}, {"shape":"LimitExceededException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.

For more information about grants, see Grants in the AWS Key Management Service Developer Guide.

" }, "CreateKey":{ "name":"CreateKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateKeyRequest"}, "output":{"shape":"CreateKeyResponse"}, "errors":[ {"shape":"MalformedPolicyDocumentException"}, {"shape":"DependencyTimeoutException"}, {"shape":"InvalidArnException"}, {"shape":"UnsupportedOperationException"}, {"shape":"KMSInternalException"}, {"shape":"LimitExceededException"} ], "documentation":"

Creates a customer master key (CMK).

You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:

" }, "Decrypt":{ "name":"Decrypt", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DecryptRequest"}, "output":{"shape":"DecryptResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DisabledException"}, {"shape":"InvalidCiphertextException"}, {"shape":"KeyUnavailableException"}, {"shape":"DependencyTimeoutException"}, {"shape":"InvalidGrantTokenException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:

Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant Decrypt permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant Decrypt access in an IAM user policy. Instead grant Decrypt access only in key policies. If you must grant Decrypt access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.

" }, "DeleteAlias":{ "name":"DeleteAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAliasRequest"}, "errors":[ {"shape":"DependencyTimeoutException"}, {"shape":"NotFoundException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Deletes the specified alias. To map an alias to a different key, call UpdateAlias.

" }, "DeleteImportedKeyMaterial":{ "name":"DeleteImportedKeyMaterial", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteImportedKeyMaterialRequest"}, "errors":[ {"shape":"InvalidArnException"}, {"shape":"UnsupportedOperationException"}, {"shape":"DependencyTimeoutException"}, {"shape":"NotFoundException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Deletes key material that you previously imported and makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

When the specified CMK is in the PendingDeletion state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to PendingImport.

After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.

" }, "DescribeKey":{ "name":"DescribeKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeKeyRequest"}, "output":{"shape":"DescribeKeyResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"} ], "documentation":"

Provides detailed information about the specified customer master key.

" }, "DisableKey":{ "name":"DisableKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableKeyRequest"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" }, "DisableKeyRotation":{ "name":"DisableKeyRotation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableKeyRotationRequest"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DisabledException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"}, {"shape":"UnsupportedOperationException"} ], "documentation":"

Disables rotation of the specified key.

" }, "EnableKey":{ "name":"EnableKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableKeyRequest"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"LimitExceededException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Marks a key as enabled, thereby permitting its use.

" }, "EnableKeyRotation":{ "name":"EnableKeyRotation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableKeyRotationRequest"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DisabledException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"}, {"shape":"UnsupportedOperationException"} ], "documentation":"

Enables rotation of the specified customer master key.

" }, "Encrypt":{ "name":"Encrypt", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EncryptRequest"}, "output":{"shape":"EncryptResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DisabledException"}, {"shape":"KeyUnavailableException"}, {"shape":"DependencyTimeoutException"}, {"shape":"InvalidKeyUsageException"}, {"shape":"InvalidGrantTokenException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Encrypts plaintext into ciphertext by using a customer master key. The Encrypt function has two primary use cases:

  • You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.

  • If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.

Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted again by calling Encrypt.

If you want to encrypt data locally in your application, you can use the GenerateDataKey function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.

" }, "GenerateDataKey":{ "name":"GenerateDataKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GenerateDataKeyRequest"}, "output":{"shape":"GenerateDataKeyResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DisabledException"}, {"shape":"KeyUnavailableException"}, {"shape":"DependencyTimeoutException"}, {"shape":"InvalidKeyUsageException"}, {"shape":"InvalidGrantTokenException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Returns a data encryption key that you can use in your application to encrypt data locally.

You must specify the customer master key (CMK) under which to generate the data key. You must also specify the length of the data key using either the KeySpec or NumberOfBytes field. You must specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use KeySpec.

This operation returns a plaintext copy of the data key in the Plaintext field of the response, and an encrypted copy of the data key in the CiphertextBlob field. The data key is encrypted under the CMK specified in the KeyId field of the request.

We recommend that you use the following pattern to encrypt data locally in your application:

  1. Use this operation (GenerateDataKey) to retrieve a data encryption key.

  2. Use the plaintext data encryption key (returned in the Plaintext field of the response) to encrypt data locally, then erase the plaintext data key from memory.

  3. Store the encrypted data key (returned in the CiphertextBlob field of the response) alongside the locally encrypted data.

To decrypt data locally:

  1. Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.

  2. Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.

To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return an arbitrary unpredictable byte string, use GenerateRandom.

If you use the optional EncryptionContext field, you must store at least enough information to be able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better secure the ciphertext. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

" }, "GenerateDataKeyWithoutPlaintext":{ "name":"GenerateDataKeyWithoutPlaintext", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GenerateDataKeyWithoutPlaintextRequest"}, "output":{"shape":"GenerateDataKeyWithoutPlaintextResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DisabledException"}, {"shape":"KeyUnavailableException"}, {"shape":"DependencyTimeoutException"}, {"shape":"InvalidKeyUsageException"}, {"shape":"InvalidGrantTokenException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key.

This operation is useful in a system that has multiple components with different degrees of trust. For example, consider a system that stores encrypted data in containers. Each container stores the encrypted data and an encrypted copy of the data key. One component of the system, called the control plane, creates new containers. When it creates a new container, it uses this operation (GenerateDataKeyWithoutPlaintext) to get an encrypted data key and then stores it in the container. Later, a different component of the system, called the data plane, puts encrypted data into the containers. To do this, it passes the encrypted data key to the Decrypt operation, then uses the returned plaintext data key to encrypt data, and finally stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.

" }, "GenerateRandom":{ "name":"GenerateRandom", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GenerateRandomRequest"}, "output":{"shape":"GenerateRandomResponse"}, "errors":[ {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"} ], "documentation":"

Generates an unpredictable byte string.

" }, "GetKeyPolicy":{ "name":"GetKeyPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetKeyPolicyRequest"}, "output":{"shape":"GetKeyPolicyResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Retrieves a policy attached to the specified key.

" }, "GetKeyRotationStatus":{ "name":"GetKeyRotationStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetKeyRotationStatusRequest"}, "output":{"shape":"GetKeyRotationStatusResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"}, {"shape":"UnsupportedOperationException"} ], "documentation":"

Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.

" }, "GetParametersForImport":{ "name":"GetParametersForImport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetParametersForImportRequest"}, "output":{"shape":"GetParametersForImportResponse"}, "errors":[ {"shape":"InvalidArnException"}, {"shape":"UnsupportedOperationException"}, {"shape":"DependencyTimeoutException"}, {"shape":"NotFoundException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's Origin must be EXTERNAL. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material.

This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from the same response must be used together. These items are valid for 24 hours, after which they cannot be used for a subsequent ImportKeyMaterial request. To retrieve new ones, send another GetParametersForImport request.

" }, "ImportKeyMaterial":{ "name":"ImportKeyMaterial", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportKeyMaterialRequest"}, "output":{"shape":"ImportKeyMaterialResponse"}, "errors":[ {"shape":"InvalidArnException"}, {"shape":"UnsupportedOperationException"}, {"shape":"DependencyTimeoutException"}, {"shape":"NotFoundException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"}, {"shape":"InvalidCiphertextException"}, {"shape":"IncorrectKeyMaterialException"}, {"shape":"ExpiredImportTokenException"}, {"shape":"InvalidImportTokenException"} ], "documentation":"

Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

You must specify the key ID of the CMK to import the key material into. This CMK's Origin must be EXTERNAL. You must also send an import token and the encrypted key material. Send the import token that you received in the same GetParametersForImport response that contained the public key that you used to encrypt the key material. You must also specify whether the key material expires and if so, when. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you can reimport the same key material. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date.

When this operation is successful, the specified CMK's key state changes to Enabled, and you can use the CMK.

After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.

" }, "ListAliases":{ "name":"ListAliases", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAliasesRequest"}, "output":{"shape":"ListAliasesResponse"}, "errors":[ {"shape":"DependencyTimeoutException"}, {"shape":"InvalidMarkerException"}, {"shape":"KMSInternalException"} ], "documentation":"

Lists all of the key aliases in the account.

" }, "ListGrants":{ "name":"ListGrants", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListGrantsRequest"}, "output":{"shape":"ListGrantsResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DependencyTimeoutException"}, {"shape":"InvalidMarkerException"}, {"shape":"InvalidArnException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

List the grants for a specified key.

" }, "ListKeyPolicies":{ "name":"ListKeyPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListKeyPoliciesRequest"}, "output":{"shape":"ListKeyPoliciesResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Retrieves a list of policies attached to a key.

" }, "ListKeys":{ "name":"ListKeys", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListKeysRequest"}, "output":{"shape":"ListKeysResponse"}, "errors":[ {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"InvalidMarkerException"} ], "documentation":"

Lists the customer master keys.

" }, "ListRetirableGrants":{ "name":"ListRetirableGrants", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRetirableGrantsRequest"}, "output":{"shape":"ListGrantsResponse"}, "errors":[ {"shape":"DependencyTimeoutException"}, {"shape":"InvalidMarkerException"}, {"shape":"InvalidArnException"}, {"shape":"NotFoundException"}, {"shape":"KMSInternalException"} ], "documentation":"

Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.

A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.

" }, "PutKeyPolicy":{ "name":"PutKeyPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutKeyPolicyRequest"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"MalformedPolicyDocumentException"}, {"shape":"DependencyTimeoutException"}, {"shape":"UnsupportedOperationException"}, {"shape":"KMSInternalException"}, {"shape":"LimitExceededException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Attaches a key policy to the specified customer master key (CMK).

For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.

" }, "ReEncrypt":{ "name":"ReEncrypt", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReEncryptRequest"}, "output":{"shape":"ReEncryptResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DisabledException"}, {"shape":"InvalidCiphertextException"}, {"shape":"KeyUnavailableException"}, {"shape":"DependencyTimeoutException"}, {"shape":"InvalidKeyUsageException"}, {"shape":"InvalidGrantTokenException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext.

Unlike other operations, ReEncrypt is authorized twice, once as ReEncryptFrom on the source CMK and once as ReEncryptTo on the destination CMK. We recommend that you include the \"kms:ReEncrypt*\" permission in your key policies to permit reencryption from or to the CMK. This permission is automatically included in the key policy when you create a CMK through the console, but you must include it manually when you create a CMK programmatically or when you set a key policy with the PutKeyPolicy operation.

" }, "RetireGrant":{ "name":"RetireGrant", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RetireGrantRequest"}, "errors":[ {"shape":"InvalidGrantTokenException"}, {"shape":"InvalidGrantIdException"}, {"shape":"NotFoundException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:

  • The AWS account (root user) under which the grant was created

  • The RetiringPrincipal, if present in the grant

  • The GranteePrincipal, if RetireGrant is an operation specified in the grant

You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.

" }, "RevokeGrant":{ "name":"RevokeGrant", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeGrantRequest"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DependencyTimeoutException"}, {"shape":"InvalidArnException"}, {"shape":"InvalidGrantIdException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Revokes a grant. You can revoke a grant to actively deny operations that depend on it.

" }, "ScheduleKeyDeletion":{ "name":"ScheduleKeyDeletion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ScheduleKeyDeletionRequest"}, "output":{"shape":"ScheduleKeyDeletionResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.

Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

" }, "UpdateAlias":{ "name":"UpdateAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAliasRequest"}, "errors":[ {"shape":"DependencyTimeoutException"}, {"shape":"NotFoundException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Updates an alias to map it to a different key.

An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.

An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word \"alias\" followed by a forward slash (alias/). An alias that begins with \"aws\" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).

The alias and the key it is mapped to must be in the same AWS account and the same region.

" }, "UpdateKeyDescription":{ "name":"UpdateKeyDescription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateKeyDescriptionRequest"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"

Updates the description of a customer master key (CMK).

" } }, "shapes":{ "AWSAccountIdType":{"type":"string"}, "AlgorithmSpec":{ "type":"string", "enum":[ "RSAES_PKCS1_V1_5", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256" ] }, "AliasList":{ "type":"list", "member":{"shape":"AliasListEntry"} }, "AliasListEntry":{ "type":"structure", "members":{ "AliasName":{ "shape":"AliasNameType", "documentation":"

String that contains the alias.

" }, "AliasArn":{ "shape":"ArnType", "documentation":"

String that contains the key ARN.

" }, "TargetKeyId":{ "shape":"KeyIdType", "documentation":"

String that contains the key identifier referred to by the alias.

" } }, "documentation":"

Contains information about an alias.

" }, "AliasNameType":{ "type":"string", "max":256, "min":1, "pattern":"^[a-zA-Z0-9:/_-]+$" }, "AlreadyExistsException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because it attempted to create a resource that already exists.

", "exception":true }, "ArnType":{ "type":"string", "max":2048, "min":20 }, "BooleanType":{"type":"boolean"}, "CancelKeyDeletionRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

The unique identifier for the customer master key (CMK) for which to cancel deletion.

To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

  • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.

" } } }, "CancelKeyDeletionResponse":{ "type":"structure", "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

The unique identifier of the master key for which deletion is canceled.

" } } }, "CiphertextType":{ "type":"blob", "max":6144, "min":1 }, "CreateAliasRequest":{ "type":"structure", "required":[ "AliasName", "TargetKeyId" ], "members":{ "AliasName":{ "shape":"AliasNameType", "documentation":"

String that contains the display name. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.

" }, "TargetKeyId":{ "shape":"KeyIdType", "documentation":"

An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

" } } }, "CreateGrantRequest":{ "type":"structure", "required":[ "KeyId", "GranteePrincipal" ], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

The unique identifier for the customer master key (CMK) that the grant applies to.

To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:

  • Globally unique key ID: 12345678-1234-1234-1234-123456789012

  • Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012

" }, "GranteePrincipal":{ "shape":"PrincipalIdType", "documentation":"

The principal that is given permission to perform the operations that the grant permits.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

" }, "RetiringPrincipal":{ "shape":"PrincipalIdType", "documentation":"

The principal that is given permission to retire the grant by using RetireGrant operation.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

" }, "Operations":{ "shape":"GrantOperationList", "documentation":"

A list of operations that the grant permits.

" }, "Constraints":{ "shape":"GrantConstraints", "documentation":"

The conditions under which the operations permitted by the grant are allowed.

You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

" }, "GrantTokens":{ "shape":"GrantTokenList", "documentation":"

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

" }, "Name":{ "shape":"GrantNameType", "documentation":"

A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.

When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

" } } }, "CreateGrantResponse":{ "type":"structure", "members":{ "GrantToken":{ "shape":"GrantTokenType", "documentation":"

The grant token.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

" }, "GrantId":{ "shape":"GrantIdType", "documentation":"

The unique identifier for the grant.

You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.

" } } }, "CreateKeyRequest":{ "type":"structure", "members":{ "Policy":{ "shape":"PolicyType", "documentation":"

The key policy to attach to the CMK.

If you specify a policy and do not set BypassPolicyLockoutSafetyCheck to true, the policy must meet the following criteria:

  • It must allow the principal making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

  • The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.

If you do not specify a policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.

The policy size limit is 32 KiB (32768 bytes).

" }, "Description":{ "shape":"DescriptionType", "documentation":"

A description of the CMK.

Use a description that helps you decide whether the CMK is appropriate for a task.

" }, "KeyUsage":{ "shape":"KeyUsageType", "documentation":"

The intended use of the CMK.

You can use CMKs only for symmetric encryption and decryption.

" }, "Origin":{ "shape":"OriginType", "documentation":"

The source of the CMK's key material.

The default is AWS_KMS, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL, the request creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

The CMK's Origin is immutable and is set when the CMK is created.

" }, "BypassPolicyLockoutSafetyCheck":{ "shape":"BooleanType", "documentation":"

A flag to indicate whether to bypass the key policy lockout safety check.

Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.

For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

Use this parameter only when you include a policy in the request and you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK.

The default value is false.

" } } }, "CreateKeyResponse":{ "type":"structure", "members":{ "KeyMetadata":{ "shape":"KeyMetadata", "documentation":"

Metadata associated with the CMK.

" } } }, "DataKeySpec":{ "type":"string", "enum":[ "AES_256", "AES_128" ] }, "DateType":{"type":"timestamp"}, "DecryptRequest":{ "type":"structure", "required":["CiphertextBlob"], "members":{ "CiphertextBlob":{ "shape":"CiphertextType", "documentation":"

Ciphertext to be decrypted. The blob includes metadata.

" }, "EncryptionContext":{ "shape":"EncryptionContextType", "documentation":"

The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

" }, "GrantTokens":{ "shape":"GrantTokenList", "documentation":"

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

" } } }, "DecryptResponse":{ "type":"structure", "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.

" }, "Plaintext":{ "shape":"PlaintextType", "documentation":"

Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.

" } } }, "DeleteAliasRequest":{ "type":"structure", "required":["AliasName"], "members":{ "AliasName":{ "shape":"AliasNameType", "documentation":"

The alias to be deleted. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/AWS\" are reserved.

" } } }, "DeleteImportedKeyMaterialRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

The identifier of the CMK whose key material to delete. The CMK's Origin must be EXTERNAL.

A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

  • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

" } } }, "DependencyTimeoutException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The system timed out while trying to fulfill the request. The request can be retried.

", "exception":true, "fault":true }, "DescribeKeyRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

  • Alias Name Example - alias/MyAliasName

" }, "GrantTokens":{ "shape":"GrantTokenList", "documentation":"

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

" } } }, "DescribeKeyResponse":{ "type":"structure", "members":{ "KeyMetadata":{ "shape":"KeyMetadata", "documentation":"

Metadata associated with the key.

" } } }, "DescriptionType":{ "type":"string", "max":8192, "min":0 }, "DisableKeyRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

A unique identifier for the CMK.

Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:

  • Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

" } } }, "DisableKeyRotationRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

" } } }, "DisabledException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because the specified CMK is not enabled.

", "exception":true }, "EnableKeyRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

" } } }, "EnableKeyRotationRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

" } } }, "EncryptRequest":{ "type":"structure", "required":[ "KeyId", "Plaintext" ], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

  • Alias Name Example - alias/MyAliasName

" }, "Plaintext":{ "shape":"PlaintextType", "documentation":"

Data to be encrypted.

" }, "EncryptionContext":{ "shape":"EncryptionContextType", "documentation":"

Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt API or decryption will fail. For more information, see Encryption Context.

" }, "GrantTokens":{ "shape":"GrantTokenList", "documentation":"

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

" } } }, "EncryptResponse":{ "type":"structure", "members":{ "CiphertextBlob":{ "shape":"CiphertextType", "documentation":"

The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.

" }, "KeyId":{ "shape":"KeyIdType", "documentation":"

The ID of the key used during encryption.

" } } }, "EncryptionContextKey":{"type":"string"}, "EncryptionContextType":{ "type":"map", "key":{"shape":"EncryptionContextKey"}, "value":{"shape":"EncryptionContextValue"} }, "EncryptionContextValue":{"type":"string"}, "ErrorMessageType":{"type":"string"}, "ExpirationModelType":{ "type":"string", "enum":[ "KEY_MATERIAL_EXPIRES", "KEY_MATERIAL_DOES_NOT_EXPIRE" ] }, "ExpiredImportTokenException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because the provided import token is expired. Use GetParametersForImport to retrieve a new import token and public key, use the new public key to encrypt the key material, and then try the request again.

", "exception":true }, "GenerateDataKeyRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

The identifier of the CMK under which to generate and encrypt the data encryption key.

A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of an alias that refers to the CMK. Examples:

  • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • CMK ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

" }, "EncryptionContext":{ "shape":"EncryptionContextType", "documentation":"

A set of key-value pairs that represents additional authenticated data.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

" }, "NumberOfBytes":{ "shape":"NumberOfBytesType", "documentation":"

The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.

" }, "KeySpec":{ "shape":"DataKeySpec", "documentation":"

The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

" }, "GrantTokens":{ "shape":"GrantTokenList", "documentation":"

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

" } } }, "GenerateDataKeyResponse":{ "type":"structure", "members":{ "CiphertextBlob":{ "shape":"CiphertextType", "documentation":"

The encrypted data encryption key.

" }, "Plaintext":{ "shape":"PlaintextType", "documentation":"

The data encryption key. Use this data key for local encryption and decryption, then remove it from memory as soon as possible.

" }, "KeyId":{ "shape":"KeyIdType", "documentation":"

The identifier of the CMK under which the data encryption key was generated and encrypted.

" } } }, "GenerateDataKeyWithoutPlaintextRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

The identifier of the CMK under which to generate and encrypt the data encryption key.

A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of an alias that refers to the CMK. Examples:

  • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • CMK ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

" }, "EncryptionContext":{ "shape":"EncryptionContextType", "documentation":"

A set of key-value pairs that represents additional authenticated data.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

" }, "KeySpec":{ "shape":"DataKeySpec", "documentation":"

The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

" }, "NumberOfBytes":{ "shape":"NumberOfBytesType", "documentation":"

The length of the data encryption key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.

" }, "GrantTokens":{ "shape":"GrantTokenList", "documentation":"

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

" } } }, "GenerateDataKeyWithoutPlaintextResponse":{ "type":"structure", "members":{ "CiphertextBlob":{ "shape":"CiphertextType", "documentation":"

The encrypted data encryption key.

" }, "KeyId":{ "shape":"KeyIdType", "documentation":"

The identifier of the CMK under which the data encryption key was generated and encrypted.

" } } }, "GenerateRandomRequest":{ "type":"structure", "members":{ "NumberOfBytes":{ "shape":"NumberOfBytesType", "documentation":"

The length of the byte string.

" } } }, "GenerateRandomResponse":{ "type":"structure", "members":{ "Plaintext":{ "shape":"PlaintextType", "documentation":"

The unpredictable byte string.

" } } }, "GetKeyPolicyRequest":{ "type":"structure", "required":[ "KeyId", "PolicyName" ], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

" }, "PolicyName":{ "shape":"PolicyNameType", "documentation":"

String that contains the name of the policy. Currently, this must be \"default\". Policy names can be discovered by calling ListKeyPolicies.

" } } }, "GetKeyPolicyResponse":{ "type":"structure", "members":{ "Policy":{ "shape":"PolicyType", "documentation":"

A policy document in JSON format.

" } } }, "GetKeyRotationStatusRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

" } } }, "GetKeyRotationStatusResponse":{ "type":"structure", "members":{ "KeyRotationEnabled":{ "shape":"BooleanType", "documentation":"

A Boolean value that specifies whether key rotation is enabled.

" } } }, "GetParametersForImportRequest":{ "type":"structure", "required":[ "KeyId", "WrappingAlgorithm", "WrappingKeySpec" ], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

The identifier of the CMK into which you will import key material. The CMK's Origin must be EXTERNAL.

A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

  • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

" }, "WrappingAlgorithm":{ "shape":"AlgorithmSpec", "documentation":"

The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.

" }, "WrappingKeySpec":{ "shape":"WrappingKeySpec", "documentation":"

The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.

" } } }, "GetParametersForImportResponse":{ "type":"structure", "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

The identifier of the CMK to use in a subsequent ImportKeyMaterial request. This is the same CMK specified in the GetParametersForImport request.

" }, "ImportToken":{ "shape":"CiphertextType", "documentation":"

The import token to send in a subsequent ImportKeyMaterial request.

" }, "PublicKey":{ "shape":"PlaintextType", "documentation":"

The public key to use to encrypt the key material before importing it with ImportKeyMaterial.

" }, "ParametersValidTo":{ "shape":"DateType", "documentation":"

The time at which the import token and public key are no longer valid. After this time, you cannot use them to make an ImportKeyMaterial request and you must send another GetParametersForImport request to retrieve new ones.

" } } }, "GrantConstraints":{ "type":"structure", "members":{ "EncryptionContextSubset":{ "shape":"EncryptionContextType", "documentation":"

Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list or is a subset of this list, the grant allows the operation. Otherwise, the operation is not allowed.

" }, "EncryptionContextEquals":{ "shape":"EncryptionContextType", "documentation":"

Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list, the grant allows the operation. Otherwise, the operation is not allowed.

" } }, "documentation":"

A structure for specifying the conditions under which the operations permitted by the grant are allowed.

You can use this structure to allow the operations permitted by the grant only when a specified encryption context is present. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide.

" }, "GrantIdType":{ "type":"string", "max":128, "min":1 }, "GrantList":{ "type":"list", "member":{"shape":"GrantListEntry"} }, "GrantListEntry":{ "type":"structure", "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

The unique identifier for the customer master key (CMK) to which the grant applies.

" }, "GrantId":{ "shape":"GrantIdType", "documentation":"

The unique identifier for the grant.

" }, "Name":{ "shape":"GrantNameType", "documentation":"

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

The date and time when the grant was created.

" }, "GranteePrincipal":{ "shape":"PrincipalIdType", "documentation":"

The principal that receives the grant's permissions.

" }, "RetiringPrincipal":{ "shape":"PrincipalIdType", "documentation":"

The principal that can retire the grant.

" }, "IssuingAccount":{ "shape":"PrincipalIdType", "documentation":"

The AWS account under which the grant was issued.

" }, "Operations":{ "shape":"GrantOperationList", "documentation":"

The list of operations permitted by the grant.

" }, "Constraints":{ "shape":"GrantConstraints", "documentation":"

The conditions under which the grant's operations are allowed.

" } }, "documentation":"

Contains information about an entry in a list of grants.

" }, "GrantNameType":{ "type":"string", "max":256, "min":1, "pattern":"^[a-zA-Z0-9:/_-]+$" }, "GrantOperation":{ "type":"string", "enum":[ "Decrypt", "Encrypt", "GenerateDataKey", "GenerateDataKeyWithoutPlaintext", "ReEncryptFrom", "ReEncryptTo", "CreateGrant", "RetireGrant", "DescribeKey" ] }, "GrantOperationList":{ "type":"list", "member":{"shape":"GrantOperation"} }, "GrantTokenList":{ "type":"list", "member":{"shape":"GrantTokenType"}, "max":10, "min":0 }, "GrantTokenType":{ "type":"string", "max":8192, "min":1 }, "ImportKeyMaterialRequest":{ "type":"structure", "required":[ "KeyId", "ImportToken", "EncryptedKeyMaterial" ], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

The identifier of the CMK to import the key material into. The CMK's Origin must be EXTERNAL.

A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

  • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

" }, "ImportToken":{ "shape":"CiphertextType", "documentation":"

The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material.

" }, "EncryptedKeyMaterial":{ "shape":"CiphertextType", "documentation":"

The encrypted key material to import. It must be encrypted with the public key that you received in the response to a previous GetParametersForImport request, using the wrapping algorithm that you specified in that request.

" }, "ValidTo":{ "shape":"DateType", "documentation":"

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE. Otherwise it is required.

" }, "ExpirationModel":{ "shape":"ExpirationModelType", "documentation":"

Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, in which case you must include the ValidTo parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.

" } } }, "ImportKeyMaterialResponse":{ "type":"structure", "members":{ } }, "IncorrectKeyMaterialException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because the provided key material is invalid or is not the same key material that was previously imported into this customer master key (CMK).

", "exception":true }, "InvalidAliasNameException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because the specified alias name is not valid.

", "exception":true }, "InvalidArnException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because a specified ARN was not valid.

", "exception":true }, "InvalidCiphertextException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.

", "exception":true }, "InvalidGrantIdException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because the specified GrantId is not valid.

", "exception":true }, "InvalidGrantTokenException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because the specified grant token is not valid.

", "exception":true }, "InvalidImportTokenException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because the provided import token is invalid or is associated with a different customer master key (CMK).

", "exception":true }, "InvalidKeyUsageException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because the specified KeySpec value is not valid.

", "exception":true }, "InvalidMarkerException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because the marker that specifies where pagination should next begin is not valid.

", "exception":true }, "KMSInternalException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because an internal exception occurred. The request can be retried.

", "exception":true }, "KMSInvalidStateException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because the state of the specified resource is not valid for this request.

For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

", "exception":true }, "KeyIdType":{ "type":"string", "max":256, "min":1 }, "KeyList":{ "type":"list", "member":{"shape":"KeyListEntry"} }, "KeyListEntry":{ "type":"structure", "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

Unique identifier of the key.

" }, "KeyArn":{ "shape":"ArnType", "documentation":"

ARN of the key.

" } }, "documentation":"

Contains information about each entry in the key list.

" }, "KeyMetadata":{ "type":"structure", "required":["KeyId"], "members":{ "AWSAccountId":{ "shape":"AWSAccountIdType", "documentation":"

The twelve-digit account ID of the AWS account that owns the CMK.

" }, "KeyId":{ "shape":"KeyIdType", "documentation":"

The globally unique identifier for the CMK.

" }, "Arn":{ "shape":"ArnType", "documentation":"

The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

" }, "CreationDate":{ "shape":"DateType", "documentation":"

The date and time when the CMK was created.

" }, "Enabled":{ "shape":"BooleanType", "documentation":"

Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.

" }, "Description":{ "shape":"DescriptionType", "documentation":"

The description of the CMK.

" }, "KeyUsage":{ "shape":"KeyUsageType", "documentation":"

The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the CMK for the Encrypt and Decrypt operations.

" }, "KeyState":{ "shape":"KeyState", "documentation":"

The state of the CMK.

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" }, "DeletionDate":{ "shape":"DateType", "documentation":"

The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion, otherwise this value is omitted.

" }, "ValidTo":{ "shape":"DateType", "documentation":"

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

" }, "Origin":{ "shape":"OriginType", "documentation":"

The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.

" }, "ExpirationModel":{ "shape":"ExpirationModelType", "documentation":"

Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

" } }, "documentation":"

Contains metadata about a customer master key (CMK).

This data type is used as a response element for the CreateKey and DescribeKey operations.

" }, "KeyState":{ "type":"string", "enum":[ "Enabled", "Disabled", "PendingDeletion", "PendingImport" ] }, "KeyUnavailableException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because the specified CMK was not available. The request can be retried.

", "exception":true, "fault":true }, "KeyUsageType":{ "type":"string", "enum":["ENCRYPT_DECRYPT"] }, "LimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.

", "exception":true }, "LimitType":{ "type":"integer", "max":1000, "min":1 }, "ListAliasesRequest":{ "type":"structure", "members":{ "Limit":{ "shape":"LimitType", "documentation":"

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

" }, "Marker":{ "shape":"MarkerType", "documentation":"

Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.

" } } }, "ListAliasesResponse":{ "type":"structure", "members":{ "Aliases":{ "shape":"AliasList", "documentation":"

A list of key aliases in the user's account.

" }, "NextMarker":{ "shape":"MarkerType", "documentation":"

When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" }, "Truncated":{ "shape":"BooleanType", "documentation":"

A flag that indicates whether there are more items in the list. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.

" } } }, "ListGrantsRequest":{ "type":"structure", "required":["KeyId"], "members":{ "Limit":{ "shape":"LimitType", "documentation":"

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

" }, "Marker":{ "shape":"MarkerType", "documentation":"

Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.

" }, "KeyId":{ "shape":"KeyIdType", "documentation":"

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

" } } }, "ListGrantsResponse":{ "type":"structure", "members":{ "Grants":{ "shape":"GrantList", "documentation":"

A list of grants.

" }, "NextMarker":{ "shape":"MarkerType", "documentation":"

When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" }, "Truncated":{ "shape":"BooleanType", "documentation":"

A flag that indicates whether there are more items in the list. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.

" } } }, "ListKeyPoliciesRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

A unique identifier for the customer master key (CMK). You can use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

  • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

" }, "Limit":{ "shape":"LimitType", "documentation":"

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

Currently only 1 policy can be attached to a key.

" }, "Marker":{ "shape":"MarkerType", "documentation":"

Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.

" } } }, "ListKeyPoliciesResponse":{ "type":"structure", "members":{ "PolicyNames":{ "shape":"PolicyNameList", "documentation":"

A list of policy names. Currently, there is only one policy and it is named \"Default\".

" }, "NextMarker":{ "shape":"MarkerType", "documentation":"

When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" }, "Truncated":{ "shape":"BooleanType", "documentation":"

A flag that indicates whether there are more items in the list. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.

" } } }, "ListKeysRequest":{ "type":"structure", "members":{ "Limit":{ "shape":"LimitType", "documentation":"

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

" }, "Marker":{ "shape":"MarkerType", "documentation":"

Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.

" } } }, "ListKeysResponse":{ "type":"structure", "members":{ "Keys":{ "shape":"KeyList", "documentation":"

A list of keys.

" }, "NextMarker":{ "shape":"MarkerType", "documentation":"

When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" }, "Truncated":{ "shape":"BooleanType", "documentation":"

A flag that indicates whether there are more items in the list. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.

" } } }, "ListRetirableGrantsRequest":{ "type":"structure", "required":["RetiringPrincipal"], "members":{ "Limit":{ "shape":"LimitType", "documentation":"

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

" }, "Marker":{ "shape":"MarkerType", "documentation":"

Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the response you just received.

" }, "RetiringPrincipal":{ "shape":"PrincipalIdType", "documentation":"

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

" } } }, "MalformedPolicyDocumentException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because the specified policy is not syntactically or semantically correct.

", "exception":true }, "MarkerType":{ "type":"string", "max":320, "min":1, "pattern":"[\\u0020-\\u00FF]*" }, "NotFoundException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because the specified entity or resource could not be found.

", "exception":true }, "NumberOfBytesType":{ "type":"integer", "max":1024, "min":1 }, "OriginType":{ "type":"string", "enum":[ "AWS_KMS", "EXTERNAL" ] }, "PendingWindowInDaysType":{ "type":"integer", "max":365, "min":1 }, "PlaintextType":{ "type":"blob", "max":4096, "min":1, "sensitive":true }, "PolicyNameList":{ "type":"list", "member":{"shape":"PolicyNameType"} }, "PolicyNameType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w]+" }, "PolicyType":{ "type":"string", "max":131072, "min":1, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" }, "PrincipalIdType":{ "type":"string", "max":256, "min":1 }, "PutKeyPolicyRequest":{ "type":"structure", "required":[ "KeyId", "PolicyName", "Policy" ], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

A unique identifier for the CMK.

Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:

  • Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

" }, "PolicyName":{ "shape":"PolicyNameType", "documentation":"

The name of the key policy.

This value must be default.

" }, "Policy":{ "shape":"PolicyType", "documentation":"

The key policy to attach to the CMK.

If you do not set BypassPolicyLockoutSafetyCheck to true, the policy must meet the following criteria:

  • It must allow the principal making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

  • The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.

The policy size limit is 32 KiB (32768 bytes).

" }, "BypassPolicyLockoutSafetyCheck":{ "shape":"BooleanType", "documentation":"

A flag to indicate whether to bypass the key policy lockout safety check.

Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.

For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

Use this parameter only when you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK.

The default value is false.

" } } }, "ReEncryptRequest":{ "type":"structure", "required":[ "CiphertextBlob", "DestinationKeyId" ], "members":{ "CiphertextBlob":{ "shape":"CiphertextType", "documentation":"

Ciphertext of the data to reencrypt.

" }, "SourceEncryptionContext":{ "shape":"EncryptionContextType", "documentation":"

Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

" }, "DestinationKeyId":{ "shape":"KeyIdType", "documentation":"

A unique identifier for the CMK to use to reencrypt the data. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

  • Alias Name Example - alias/MyAliasName

" }, "DestinationEncryptionContext":{ "shape":"EncryptionContextType", "documentation":"

Encryption context to use when the data is reencrypted.

" }, "GrantTokens":{ "shape":"GrantTokenList", "documentation":"

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

" } } }, "ReEncryptResponse":{ "type":"structure", "members":{ "CiphertextBlob":{ "shape":"CiphertextType", "documentation":"

The reencrypted data.

" }, "SourceKeyId":{ "shape":"KeyIdType", "documentation":"

Unique identifier of the CMK used to originally encrypt the data.

" }, "KeyId":{ "shape":"KeyIdType", "documentation":"

Unique identifier of the CMK used to reencrypt the data.

" } } }, "RetireGrantRequest":{ "type":"structure", "members":{ "GrantToken":{ "shape":"GrantTokenType", "documentation":"

Token that identifies the grant to be retired.

" }, "KeyId":{ "shape":"KeyIdType", "documentation":"

The Amazon Resource Name of the CMK associated with the grant. Example:

  • arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

" }, "GrantId":{ "shape":"GrantIdType", "documentation":"

Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

" } } }, "RevokeGrantRequest":{ "type":"structure", "required":[ "KeyId", "GrantId" ], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or the fully specified ARN to a key.

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

" }, "GrantId":{ "shape":"GrantIdType", "documentation":"

Identifier of the grant to be revoked.

" } } }, "ScheduleKeyDeletionRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

The unique identifier for the customer master key (CMK) to delete.

To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

  • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.

" }, "PendingWindowInDays":{ "shape":"PendingWindowInDaysType", "documentation":"

The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.

" } } }, "ScheduleKeyDeletionResponse":{ "type":"structure", "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

The unique identifier of the customer master key (CMK) for which deletion is scheduled.

" }, "DeletionDate":{ "shape":"DateType", "documentation":"

The date and time after which AWS KMS deletes the customer master key (CMK).

" } } }, "UnsupportedOperationException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"

The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

", "exception":true }, "UpdateAliasRequest":{ "type":"structure", "required":[ "AliasName", "TargetKeyId" ], "members":{ "AliasName":{ "shape":"AliasNameType", "documentation":"

String that contains the name of the alias to be modified. The name must start with the word \"alias\" followed by a forward slash (alias/). Aliases that begin with \"alias/aws\" are reserved.

" }, "TargetKeyId":{ "shape":"KeyIdType", "documentation":"

Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.

" } } }, "UpdateKeyDescriptionRequest":{ "type":"structure", "required":[ "KeyId", "Description" ], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"

A unique identifier for the CMK. This value can be a globally unique identifier or the fully specified ARN to a key.

  • Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

" }, "Description":{ "shape":"DescriptionType", "documentation":"

New description for the CMK.

" } } }, "WrappingKeySpec":{ "type":"string", "enum":["RSA_2048"] } }, "documentation":"AWS Key Management Service

AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.

Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.

Signing Requests

Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.

All AWS KMS operations require Signature Version 4.

Logging API Requests

AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

Additional Resources

For more information about credentials and request signing, see the following:

Commonly Used APIs

Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console.

" } botocore-1.5.7/botocore/data/cloudsearchdomain/0000777454262600001440000000000013042511307022617 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudsearchdomain/2013-01-01/0000777454262600001440000000000013042511307023640 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudsearchdomain/2013-01-01/service-2.json0000666454262600001440000012512513042511306026337 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2013-01-01", "endpointPrefix":"cloudsearchdomain", "jsonVersion":"1.1", "protocol":"rest-json", "serviceFullName":"Amazon CloudSearch Domain", "signatureVersion":"v4", "signingName":"cloudsearch", "uid":"cloudsearchdomain-2013-01-01" }, "operations":{ "Search":{ "name":"Search", "http":{ "method":"GET", "requestUri":"/2013-01-01/search?format=sdk&pretty=true" }, "input":{"shape":"SearchRequest"}, "output":{"shape":"SearchResponse"}, "errors":[ {"shape":"SearchException"} ], "documentation":"

Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers:

  • simple: search all text and text-array fields for the specified string. Search for phrases, individual terms, and prefixes.
  • structured: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.
  • lucene: specify search criteria using the Apache Lucene query parser syntax.
  • dismax: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.

For more information, see Searching Your Data in the Amazon CloudSearch Developer Guide.

The endpoint for submitting Search requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

" }, "Suggest":{ "name":"Suggest", "http":{ "method":"GET", "requestUri":"/2013-01-01/suggest?format=sdk&pretty=true" }, "input":{"shape":"SuggestRequest"}, "output":{"shape":"SuggestResponse"}, "errors":[ {"shape":"SearchException"} ], "documentation":"

Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.

For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide.

The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

" }, "UploadDocuments":{ "name":"UploadDocuments", "http":{ "method":"POST", "requestUri":"/2013-01-01/documents/batch?format=sdk" }, "input":{"shape":"UploadDocumentsRequest"}, "output":{"shape":"UploadDocumentsResponse"}, "errors":[ {"shape":"DocumentServiceException"} ], "documentation":"

Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service.

The endpoint for submitting UploadDocuments requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data in the Amazon CloudSearch Developer Guide. For more information about uploading data for indexing, see Uploading Data in the Amazon CloudSearch Developer Guide.

" } }, "shapes":{ "Adds":{"type":"long"}, "Blob":{ "type":"blob", "streaming":true }, "Bucket":{ "type":"structure", "members":{ "value":{ "shape":"String", "documentation":"

The facet value being counted.

" }, "count":{ "shape":"Long", "documentation":"

The number of hits that contain the facet value in the specified facet field.

" } }, "documentation":"

A container for facet information.

" }, "BucketInfo":{ "type":"structure", "members":{ "buckets":{ "shape":"BucketList", "documentation":"

A list of the calculated facet values and counts.

" } }, "documentation":"

A container for the calculated facet values and counts.

" }, "BucketList":{ "type":"list", "member":{"shape":"Bucket"} }, "ContentType":{ "type":"string", "enum":[ "application/json", "application/xml" ] }, "Cursor":{"type":"string"}, "Deletes":{"type":"long"}, "DocumentServiceException":{ "type":"structure", "members":{ "status":{ "shape":"String", "documentation":"

The return status of a document upload request, error or success.

" }, "message":{ "shape":"String", "documentation":"

The description of the errors returned by the document service.

" } }, "documentation":"

Information about any problems encountered while processing an upload request.

", "exception":true }, "DocumentServiceWarning":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

The description for a warning returned by the document service.

" } }, "documentation":"

A warning returned by the document service when an issue is discovered while processing an upload request.

" }, "DocumentServiceWarnings":{ "type":"list", "member":{"shape":"DocumentServiceWarning"} }, "Double":{"type":"double"}, "Expr":{"type":"string"}, "Exprs":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "Facet":{"type":"string"}, "Facets":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"BucketInfo"} }, "FieldStats":{ "type":"structure", "members":{ "min":{ "shape":"String", "documentation":"

The minimum value found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

" }, "max":{ "shape":"String", "documentation":"

The maximum value found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

" }, "count":{ "shape":"Long", "documentation":"

The number of documents that contain a value in the specified field in the result set.

" }, "missing":{ "shape":"Long", "documentation":"

The number of documents that do not contain a value in the specified field in the result set.

" }, "sum":{ "shape":"Double", "documentation":"

The sum of the field values across the documents in the result set. null for date fields.

" }, "sumOfSquares":{ "shape":"Double", "documentation":"

The sum of all field values in the result set squared.

" }, "mean":{ "shape":"String", "documentation":"

The average of the values found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

" }, "stddev":{ "shape":"Double", "documentation":"

The standard deviation of the values in the specified field in the result set.

" } }, "documentation":"

The statistics for a field calculated in the request.

" }, "FieldValue":{ "type":"list", "member":{"shape":"String"} }, "Fields":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"FieldValue"} }, "FilterQuery":{"type":"string"}, "Highlight":{"type":"string"}, "Highlights":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "Hit":{ "type":"structure", "members":{ "id":{ "shape":"String", "documentation":"

The document ID of a document that matches the search request.

" }, "fields":{ "shape":"Fields", "documentation":"

The fields returned from a document that matches the search request.

" }, "exprs":{ "shape":"Exprs", "documentation":"

The expressions returned from a document that matches the search request.

" }, "highlights":{ "shape":"Highlights", "documentation":"

The highlights returned from a document that matches the search request.

" } }, "documentation":"

Information about a document that matches the search request.

" }, "HitList":{ "type":"list", "member":{"shape":"Hit"} }, "Hits":{ "type":"structure", "members":{ "found":{ "shape":"Long", "documentation":"

The total number of documents that match the search request.

" }, "start":{ "shape":"Long", "documentation":"

The index of the first matching document.

" }, "cursor":{ "shape":"String", "documentation":"

A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.

" }, "hit":{ "shape":"HitList", "documentation":"

A document that matches the search request.

" } }, "documentation":"

The collection of documents that match the search request.

" }, "Long":{"type":"long"}, "Partial":{"type":"boolean"}, "Query":{"type":"string"}, "QueryOptions":{"type":"string"}, "QueryParser":{ "type":"string", "enum":[ "simple", "structured", "lucene", "dismax" ] }, "Return":{"type":"string"}, "SearchException":{ "type":"structure", "members":{ "message":{ "shape":"String", "documentation":"

A description of the error returned by the search service.

" } }, "documentation":"

Information about any problems encountered while processing a search request.

", "exception":true }, "SearchRequest":{ "type":"structure", "required":["query"], "members":{ "cursor":{ "shape":"Cursor", "documentation":"

Retrieves a cursor value you can use to page through large result sets. Use the size parameter to control the number of hits to include in each response. You can specify either the cursor or start parameter in a request; they are mutually exclusive. To get the first cursor, set the cursor value to initial. In subsequent requests, specify the cursor value returned in the hits section of the response.

For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.

", "location":"querystring", "locationName":"cursor" }, "expr":{ "shape":"Expr", "documentation":"

Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify expressions as return fields.

You specify the expressions in JSON using the form {\"EXPRESSIONNAME\":\"EXPRESSION\"}. You can define and use multiple expressions in a search request. For example:

{\"expression1\":\"_score*rating\", \"expression2\":\"(1/rank)*year\"}

For information about the variables, operators, and functions you can use in expressions, see Writing Expressions in the Amazon CloudSearch Developer Guide.

", "location":"querystring", "locationName":"expr" }, "facet":{ "shape":"Facet", "documentation":"

Specifies one or more fields for which to get facet information, and options that control how the facet information is returned. Each specified field must be facet-enabled in the domain configuration. The fields and options are specified in JSON using the form {\"FIELD\":{\"OPTION\":VALUE,\"OPTION:\"STRING\"},\"FIELD\":{\"OPTION\":VALUE,\"OPTION\":\"STRING\"}}.

You can specify the following faceting options:

  • buckets specifies an array of the facet values or ranges to count. Ranges are specified using the same syntax that you use to search for a range of values. For more information, see Searching for a Range of Values in the Amazon CloudSearch Developer Guide. Buckets are returned in the order they are specified in the request. The sort and size options are not valid if you specify buckets.

  • size specifies the maximum number of facets to include in the results. By default, Amazon CloudSearch returns counts for the top 10. The size parameter is only valid when you specify the sort option; it cannot be used in conjunction with buckets.

  • sort specifies how you want to sort the facets in the results: bucket or count. Specify bucket to sort alphabetically or numerically by facet value (in ascending order). Specify count to sort by the facet counts computed for each facet value (in descending order). To retrieve facet counts for particular values or ranges of values, use the buckets option instead of sort.

If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results.

To count particular buckets of values, use the buckets option. For example, the following request uses the buckets option to calculate and return facet counts by decade.

{\"year\":{\"buckets\":[\"[1970,1979]\",\"[1980,1989]\",\"[1990,1999]\",\"[2000,2009]\",\"[2010,}\"]}}

To sort facets by facet count, use the count option. For example, the following request sets the sort option to count to sort the facet values by facet count, with the facet values that have the most matching documents listed first. Setting the size option to 3 returns only the top three facet values.

{\"year\":{\"sort\":\"count\",\"size\":3}}

To sort the facets by value, use the bucket option. For example, the following request sets the sort option to bucket to sort the facet values numerically by year, with earliest year listed first.

{\"year\":{\"sort\":\"bucket\"}}

For more information, see Getting and Using Facet Information in the Amazon CloudSearch Developer Guide.

", "location":"querystring", "locationName":"facet" }, "filterQuery":{ "shape":"FilterQuery", "documentation":"

Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use filterQuery in conjunction with the query parameter to filter the documents that match the constraints specified in the query parameter. Specifying a filter controls only which matching documents are included in the results, it has no effect on how they are scored and sorted. The filterQuery parameter supports the full structured query syntax.

For more information about using filters, see Filtering Matching Documents in the Amazon CloudSearch Developer Guide.

", "location":"querystring", "locationName":"fq" }, "highlight":{ "shape":"Highlight", "documentation":"

Retrieves highlights for matches in the specified text or text-array fields. Each specified field must be highlight enabled in the domain configuration. The fields and options are specified in JSON using the form {\"FIELD\":{\"OPTION\":VALUE,\"OPTION:\"STRING\"},\"FIELD\":{\"OPTION\":VALUE,\"OPTION\":\"STRING\"}}.

You can specify the following highlight options:

  • format: specifies the format of the data in the text field: text or html. When data is returned as HTML, all non-alphanumeric characters are encoded. The default is html.
  • max_phrases: specifies the maximum number of occurrences of the search term(s) you want to highlight. By default, the first occurrence is highlighted.
  • pre_tag: specifies the string to prepend to an occurrence of a search term. The default for HTML highlights is &lt;em&gt;. The default for text highlights is *.
  • post_tag: specifies the string to append to an occurrence of a search term. The default for HTML highlights is &lt;/em&gt;. The default for text highlights is *.

If no highlight options are specified for a field, the returned field text is treated as HTML and the first match is highlighted with emphasis tags: &lt;em>search-term&lt;/em&gt;.

For example, the following request retrieves highlights for the actors and title fields.

{ \"actors\": {}, \"title\": {\"format\": \"text\",\"max_phrases\": 2,\"pre_tag\": \"\",\"post_tag\": \"\"} }

", "location":"querystring", "locationName":"highlight" }, "partial":{ "shape":"Partial", "documentation":"

Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage.

", "location":"querystring", "locationName":"partial" }, "query":{ "shape":"Query", "documentation":"

Specifies the search criteria for the request. How you specify the search criteria depends on the query parser used for the request and the parser options specified in the queryOptions parameter. By default, the simple query parser is used to process requests. To use the structured, lucene, or dismax query parser, you must also specify the queryParser parameter.

For more information about specifying search criteria, see Searching Your Data in the Amazon CloudSearch Developer Guide.

", "location":"querystring", "locationName":"q" }, "queryOptions":{ "shape":"QueryOptions", "documentation":"

Configures options for the query parser specified in the queryParser parameter. You specify the options in JSON using the following form {\"OPTION1\":\"VALUE1\",\"OPTION2\":VALUE2\"...\"OPTIONN\":\"VALUEN\"}.

The options you can configure vary according to which parser you use:

  • defaultOperator: The default operator used to combine individual terms in the search string. For example: defaultOperator: 'or'. For the dismax parser, you specify a percentage that represents the percentage of terms in the search string (rounded down) that must match, rather than a default operator. A value of 0% is the equivalent to OR, and a value of 100% is equivalent to AND. The percentage must be specified as a value in the range 0-100 followed by the percent (%) symbol. For example, defaultOperator: 50%. Valid values: and, or, a percentage in the range 0%-100% (dismax). Default: and (simple, structured, lucene) or 100 (dismax). Valid for: simple, structured, lucene, and dismax.
  • fields: An array of the fields to search when no fields are specified in a search. If no fields are specified in a search and this option is not specified, all text and text-array fields are searched. You can specify a weight for each field to control the relative importance of each field when Amazon CloudSearch calculates relevance scores. To specify a field weight, append a caret (^) symbol and the weight to the field name. For example, to boost the importance of the title field over the description field you could specify: \"fields\":[\"title^5\",\"description\"]. Valid values: The name of any configured field and an optional numeric value greater than zero. Default: All text and text-array fields. Valid for: simple, structured, lucene, and dismax.
  • operators: An array of the operators or special characters you want to disable for the simple query parser. If you disable the and, or, or not operators, the corresponding operators (+, |, -) have no special meaning and are dropped from the search string. Similarly, disabling prefix disables the wildcard operator (*) and disabling phrase disables the ability to search for phrases by enclosing phrases in double quotes. Disabling precedence disables the ability to control order of precedence using parentheses. Disabling near disables the ability to use the ~ operator to perform a sloppy phrase search. Disabling the fuzzy operator disables the ability to use the ~ operator to perform a fuzzy search. escape disables the ability to use a backslash (\\) to escape special characters within the search string. Disabling whitespace is an advanced option that prevents the parser from tokenizing on whitespace, which can be useful for Vietnamese. (It prevents Vietnamese words from being split incorrectly.) For example, you could disable all operators other than the phrase operator to support just simple term and phrase queries: \"operators\":[\"and\",\"not\",\"or\", \"prefix\"]. Valid values: and, escape, fuzzy, near, not, or, phrase, precedence, prefix, whitespace. Default: All operators and special characters are enabled. Valid for: simple.
  • phraseFields: An array of the text or text-array fields you want to use for phrase searches. When the terms in the search string appear in close proximity within a field, the field scores higher. You can specify a weight for each field to boost that score. The phraseSlop option controls how much the matches can deviate from the search string and still be boosted. To specify a field weight, append a caret (^) symbol and the weight to the field name. For example, to boost phrase matches in the title field over the abstract field, you could specify: \"phraseFields\":[\"title^3\", \"plot\"] Valid values: The name of any text or text-array field and an optional numeric value greater than zero. Default: No fields. If you don't specify any fields with phraseFields, proximity scoring is disabled even if phraseSlop is specified. Valid for: dismax.
  • phraseSlop: An integer value that specifies how much matches can deviate from the search phrase and still be boosted according to the weights specified in the phraseFields option; for example, phraseSlop: 2. You must also specify phraseFields to enable proximity scoring. Valid values: positive integers. Default: 0. Valid for: dismax.
  • explicitPhraseSlop: An integer value that specifies how much a match can deviate from the search phrase when the phrase is enclosed in double quotes in the search string. (Phrases that exceed this proximity distance are not considered a match.) For example, to specify a slop of three for dismax phrase queries, you would specify \"explicitPhraseSlop\":3. Valid values: positive integers. Default: 0. Valid for: dismax.
  • tieBreaker: When a term in the search string is found in a document's field, a score is calculated for that field based on how common the word is in that field compared to other documents. If the term occurs in multiple fields within a document, by default only the highest scoring field contributes to the document's overall score. You can specify a tieBreaker value to enable the matches in lower-scoring fields to contribute to the document's score. That way, if two documents have the same max field score for a particular term, the score for the document that has matches in more fields will be higher. The formula for calculating the score with a tieBreaker is (max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields). Set tieBreaker to 0 to disregard all but the highest scoring field (pure max): \"tieBreaker\":0. Set to 1 to sum the scores from all fields (pure sum): \"tieBreaker\":1. Valid values: 0.0 to 1.0. Default: 0.0. Valid for: dismax.
", "location":"querystring", "locationName":"q.options" }, "queryParser":{ "shape":"QueryParser", "documentation":"

Specifies which query parser to use to process the request. If queryParser is not specified, Amazon CloudSearch uses the simple query parser.

Amazon CloudSearch supports four query parsers:

  • simple: perform simple searches of text and text-array fields. By default, the simple query parser searches all text and text-array fields. You can specify which fields to search by with the queryOptions parameter. If you prefix a search term with a plus sign (+) documents must contain the term to be considered a match. (This is the default, unless you configure the default operator with the queryOptions parameter.) You can use the - (NOT), | (OR), and * (wildcard) operators to exclude particular terms, find results that match any of the specified terms, or search for a prefix. To search for a phrase rather than individual terms, enclose the phrase in double quotes. For more information, see Searching for Text in the Amazon CloudSearch Developer Guide.
  • structured: perform advanced searches by combining multiple expressions to define the search criteria. You can also search within particular fields, search for values and ranges of values, and use advanced options such as term boosting, matchall, and near. For more information, see Constructing Compound Queries in the Amazon CloudSearch Developer Guide.
  • lucene: search using the Apache Lucene query parser syntax. For more information, see Apache Lucene Query Parser Syntax.
  • dismax: search using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser. For more information, see DisMax Query Parser Syntax.
", "location":"querystring", "locationName":"q.parser" }, "return":{ "shape":"Return", "documentation":"

Specifies the field and expression values to include in the response. Multiple fields or expressions are specified as a comma-separated list. By default, a search response includes all return enabled fields (_all_fields). To return only the document IDs for the matching documents, specify _no_fields. To retrieve the relevance score calculated for each document, specify _score.

", "location":"querystring", "locationName":"return" }, "size":{ "shape":"Size", "documentation":"

Specifies the maximum number of search hits to include in the response.

", "location":"querystring", "locationName":"size" }, "sort":{ "shape":"Sort", "documentation":"

Specifies the fields or custom expressions to use to sort the search results. Multiple fields or expressions are specified as a comma-separated list. You must specify the sort direction (asc or desc) for each field; for example, year desc,title asc. To use a field to sort results, the field must be sort-enabled in the domain configuration. Array type fields cannot be used for sorting. If no sort parameter is specified, results are sorted by their default relevance scores in descending order: _score desc. You can also sort by document ID (_id asc) and version (_version desc).

For more information, see Sorting Results in the Amazon CloudSearch Developer Guide.

", "location":"querystring", "locationName":"sort" }, "start":{ "shape":"Start", "documentation":"

Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the first result is at index 0. You can specify either the start or cursor parameter in a request, they are mutually exclusive.

For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.

", "location":"querystring", "locationName":"start" }, "stats":{ "shape":"Stat", "documentation":"

Specifies one or more fields for which to get statistics information. Each specified field must be facet-enabled in the domain configuration. The fields are specified in JSON using the form:

{\"FIELD-A\":{},\"FIELD-B\":{}}

There are currently no options supported for statistics.

", "location":"querystring", "locationName":"stats" } }, "documentation":"

Container for the parameters to the Search request.

" }, "SearchResponse":{ "type":"structure", "members":{ "status":{ "shape":"SearchStatus", "documentation":"

The status information returned for the search request.

" }, "hits":{ "shape":"Hits", "documentation":"

The documents that match the search criteria.

" }, "facets":{ "shape":"Facets", "documentation":"

The requested facet information.

" }, "stats":{ "shape":"Stats", "documentation":"

The requested field statistics information.

" } }, "documentation":"

The result of a Search request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information.

" }, "SearchStatus":{ "type":"structure", "members":{ "timems":{ "shape":"Long", "documentation":"

How long it took to process the request, in milliseconds.

" }, "rid":{ "shape":"String", "documentation":"

The encrypted resource ID for the request.

" } }, "documentation":"

Contains the resource id (rid) and the time it took to process the request (timems).

" }, "Size":{"type":"long"}, "Sort":{"type":"string"}, "Start":{"type":"long"}, "Stat":{"type":"string"}, "Stats":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"FieldStats"}, "documentation":"

The statistics calculated in the request.

" }, "String":{"type":"string"}, "SuggestModel":{ "type":"structure", "members":{ "query":{ "shape":"String", "documentation":"

The query string specified in the suggest request.

" }, "found":{ "shape":"Long", "documentation":"

The number of documents that were found to match the query string.

" }, "suggestions":{ "shape":"Suggestions", "documentation":"

The documents that match the query string.

" } }, "documentation":"

Container for the suggestion information returned in a SuggestResponse.

" }, "SuggestRequest":{ "type":"structure", "required":[ "query", "suggester" ], "members":{ "query":{ "shape":"Query", "documentation":"

Specifies the string for which you want to get suggestions.

", "location":"querystring", "locationName":"q" }, "suggester":{ "shape":"Suggester", "documentation":"

Specifies the name of the suggester to use to find suggested matches.

", "location":"querystring", "locationName":"suggester" }, "size":{ "shape":"SuggestionsSize", "documentation":"

Specifies the maximum number of suggestions to return.

", "location":"querystring", "locationName":"size" } }, "documentation":"

Container for the parameters to the Suggest request.

" }, "SuggestResponse":{ "type":"structure", "members":{ "status":{ "shape":"SuggestStatus", "documentation":"

The status of a SuggestRequest. Contains the resource ID (rid) and how long it took to process the request (timems).

" }, "suggest":{ "shape":"SuggestModel", "documentation":"

Container for the matching search suggestion information.

" } }, "documentation":"

Contains the response to a Suggest request.

" }, "SuggestStatus":{ "type":"structure", "members":{ "timems":{ "shape":"Long", "documentation":"

How long it took to process the request, in milliseconds.

" }, "rid":{ "shape":"String", "documentation":"

The encrypted resource ID for the request.

" } }, "documentation":"

Contains the resource id (rid) and the time it took to process the request (timems).

" }, "Suggester":{"type":"string"}, "SuggestionMatch":{ "type":"structure", "members":{ "suggestion":{ "shape":"String", "documentation":"

The string that matches the query string specified in the SuggestRequest.

" }, "score":{ "shape":"Long", "documentation":"

The relevance score of a suggested match.

" }, "id":{ "shape":"String", "documentation":"

The document ID of the suggested document.

" } }, "documentation":"

An autocomplete suggestion that matches the query string specified in a SuggestRequest.

" }, "Suggestions":{ "type":"list", "member":{"shape":"SuggestionMatch"} }, "SuggestionsSize":{"type":"long"}, "UploadDocumentsRequest":{ "type":"structure", "required":[ "documents", "contentType" ], "members":{ "documents":{ "shape":"Blob", "documentation":"

A batch of documents formatted in JSON or HTML.

" }, "contentType":{ "shape":"ContentType", "documentation":"

The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:

  • application/json
  • application/xml
", "location":"header", "locationName":"Content-Type" } }, "documentation":"

Container for the parameters to the UploadDocuments request.

", "payload":"documents" }, "UploadDocumentsResponse":{ "type":"structure", "members":{ "status":{ "shape":"String", "documentation":"

The status of an UploadDocumentsRequest.

" }, "adds":{ "shape":"Adds", "documentation":"

The number of documents that were added to the search domain.

" }, "deletes":{ "shape":"Deletes", "documentation":"

The number of documents that were deleted from the search domain.

" }, "warnings":{ "shape":"DocumentServiceWarnings", "documentation":"

Any warnings returned by the document service about the documents being uploaded.

" } }, "documentation":"

Contains the response to an UploadDocuments request.

" } }, "documentation":"

You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.

The endpoints for submitting UploadDocuments, Search, and Suggest requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.

For more information, see the Amazon CloudSearch Developer Guide.

" } botocore-1.5.7/botocore/data/emr/0000777454262600001440000000000013042511307017716 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/emr/2009-03-31/0000777454262600001440000000000013042511307020751 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/emr/2009-03-31/waiters-2.json0000666454262600001440000000267513042511306023472 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "ClusterRunning": { "delay": 30, "operation": "DescribeCluster", "maxAttempts": 60, "acceptors": [ { "state": "success", "matcher": "path", "argument": "Cluster.Status.State", "expected": "RUNNING" }, { "state": "success", "matcher": "path", "argument": "Cluster.Status.State", "expected": "WAITING" }, { "state": "failure", "matcher": "path", "argument": "Cluster.Status.State", "expected": "TERMINATING" }, { "state": "failure", "matcher": "path", "argument": "Cluster.Status.State", "expected": "TERMINATED" }, { "state": "failure", "matcher": "path", "argument": "Cluster.Status.State", "expected": "TERMINATED_WITH_ERRORS" } ] }, "ClusterTerminated": { "delay": 30, "operation": "DescribeCluster", "maxAttempts": 60, "acceptors": [ { "state": "success", "matcher": "path", "argument": "Cluster.Status.State", "expected": "TERMINATED" }, { "state": "failure", "matcher": "path", "argument": "Cluster.Status.State", "expected": "TERMINATED_WITH_ERRORS" } ] } } } botocore-1.5.7/botocore/data/emr/2009-03-31/paginators-1.json0000666454262600001440000000123013042511306024144 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListBootstrapActions": { "input_token": "Marker", "output_token": "Marker", "result_key": "BootstrapActions" }, "ListClusters": { "input_token": "Marker", "output_token": "Marker", "result_key": "Clusters" }, "ListInstanceGroups": { "input_token": "Marker", "output_token": "Marker", "result_key": "InstanceGroups" }, "ListInstances": { "input_token": "Marker", "output_token": "Marker", "result_key": "Instances" }, "ListSteps": { "input_token": "Marker", "output_token": "Marker", "result_key": "Steps" } } } botocore-1.5.7/botocore/data/emr/2009-03-31/service-2.json0000666454262600001440000040067213042511306023453 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"elasticmapreduce-2009-03-31", "apiVersion":"2009-03-31", "endpointPrefix":"elasticmapreduce", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"Amazon EMR", "serviceFullName":"Amazon Elastic MapReduce", "signatureVersion":"v4", "targetPrefix":"ElasticMapReduce", "timestampFormat":"unixTimestamp" }, "operations":{ "AddInstanceGroups":{ "name":"AddInstanceGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddInstanceGroupsInput"}, "output":{"shape":"AddInstanceGroupsOutput"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

Adds one or more instance groups to a running cluster.

" }, "AddJobFlowSteps":{ "name":"AddJobFlowSteps", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddJobFlowStepsInput"}, "output":{"shape":"AddJobFlowStepsOutput"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

AddJobFlowSteps adds new steps to a running job flow. A maximum of 256 steps are allowed in each job flow.

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, see Add More than 256 Steps to a Job Flow in the Amazon EMR Developer's Guide.

A step specifies the location of a JAR file stored either on the master node of the job flow or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step.

Amazon EMR executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully.

You can only add steps to a job flow that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING.

" }, "AddTags":{ "name":"AddTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddTagsInput"}, "output":{"shape":"AddTagsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

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. For more information, see Tagging Amazon EMR Resources.

" }, "CancelSteps":{ "name":"CancelSteps", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelStepsInput"}, "output":{"shape":"CancelStepsOutput"}, "errors":[ {"shape":"InternalServerError"}, {"shape":"InvalidRequestException"} ], "documentation":"

Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee a step will be canceled, even if the request is successfully submitted. You can only cancel steps that are in a PENDING state.

" }, "CreateSecurityConfiguration":{ "name":"CreateSecurityConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSecurityConfigurationInput"}, "output":{"shape":"CreateSecurityConfigurationOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Creates a security configuration, which is stored in the service and can be specified when a cluster is created.

" }, "DeleteSecurityConfiguration":{ "name":"DeleteSecurityConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSecurityConfigurationInput"}, "output":{"shape":"DeleteSecurityConfigurationOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Deletes a security configuration.

" }, "DescribeCluster":{ "name":"DescribeCluster", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeClusterInput"}, "output":{"shape":"DescribeClusterOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on. For information about the cluster steps, see ListSteps.

" }, "DescribeJobFlows":{ "name":"DescribeJobFlows", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeJobFlowsInput"}, "output":{"shape":"DescribeJobFlowsOutput"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

This API is deprecated and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead.

DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time.

Regardless of supplied parameters, only job flows created within the last two months are returned.

If no parameters are supplied, then job flows matching either of the following criteria are returned:

  • Job flows created and completed in the last two weeks

  • Job flows created within the last two months that are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, STARTING

Amazon EMR can return a maximum of 512 job flow descriptions.

", "deprecated":true }, "DescribeSecurityConfiguration":{ "name":"DescribeSecurityConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSecurityConfigurationInput"}, "output":{"shape":"DescribeSecurityConfigurationOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Provides the details of a security configuration by returning the configuration JSON.

" }, "DescribeStep":{ "name":"DescribeStep", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeStepInput"}, "output":{"shape":"DescribeStepOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Provides more detail about the cluster step.

" }, "ListBootstrapActions":{ "name":"ListBootstrapActions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListBootstrapActionsInput"}, "output":{"shape":"ListBootstrapActionsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Provides information about the bootstrap actions associated with a cluster.

" }, "ListClusters":{ "name":"ListClusters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListClustersInput"}, "output":{"shape":"ListClustersOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

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. 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.

" }, "ListInstanceGroups":{ "name":"ListInstanceGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListInstanceGroupsInput"}, "output":{"shape":"ListInstanceGroupsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Provides all available details about the instance groups in a cluster.

" }, "ListInstances":{ "name":"ListInstances", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListInstancesInput"}, "output":{"shape":"ListInstancesOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Provides information about the cluster instances that Amazon EMR provisions on behalf of a user when it creates the cluster. 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.

" }, "ListSecurityConfigurations":{ "name":"ListSecurityConfigurations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSecurityConfigurationsInput"}, "output":{"shape":"ListSecurityConfigurationsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Lists all the security configurations visible to this account, providing their creation dates and times, and their names. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListSecurityConfigurations calls.

" }, "ListSteps":{ "name":"ListSteps", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListStepsInput"}, "output":{"shape":"ListStepsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request.

" }, "ModifyInstanceGroups":{ "name":"ModifyInstanceGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyInstanceGroupsInput"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically.

" }, "PutAutoScalingPolicy":{ "name":"PutAutoScalingPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutAutoScalingPolicyInput"}, "output":{"shape":"PutAutoScalingPolicyOutput"}, "documentation":"

Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric.

" }, "RemoveAutoScalingPolicy":{ "name":"RemoveAutoScalingPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveAutoScalingPolicyInput"}, "output":{"shape":"RemoveAutoScalingPolicyOutput"}, "documentation":"

Removes an automatic scaling policy from a specified instance group within an EMR cluster.

" }, "RemoveTags":{ "name":"RemoveTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTagsInput"}, "output":{"shape":"RemoveTagsOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"InvalidRequestException"} ], "documentation":"

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. For more information, see Tagging Amazon EMR Resources.

The following example removes the stack tag with value Prod from a cluster:

" }, "RunJobFlow":{ "name":"RunJobFlow", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RunJobFlowInput"}, "output":{"shape":"RunJobFlowOutput"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

RunJobFlow creates and starts running a new job flow. The job flow will run the steps specified. After the job flow completes, the cluster is stopped and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the JobFlowInstancesConfig KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the job flow will transition to the WAITING state rather than shutting down after the steps have completed.

For additional protection, you can set the JobFlowInstancesConfig TerminationProtected parameter to TRUE to lock the job flow and prevent it from being terminated by API call, user intervention, or in the event of a job flow error.

A maximum of 256 steps are allowed in each job flow.

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, see Add More than 256 Steps to a Job Flow in the Amazon EMR Management Guide.

For long running job flows, we recommend that you periodically store your results.

" }, "SetTerminationProtection":{ "name":"SetTerminationProtection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetTerminationProtectionInput"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

SetTerminationProtection locks a job flow so the EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection on a job flow is analogous to calling the Amazon EC2 DisableAPITermination API on all of the EC2 instances in a cluster.

SetTerminationProtection is used to prevent accidental termination of a job flow and to ensure that in the event of an error, the instances will persist so you can recover any data stored in their ephemeral instance storage.

To terminate a job flow that has been locked by setting SetTerminationProtection to true, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to false.

For more information, seeProtecting a Job Flow from Termination in the Amazon EMR Guide.

" }, "SetVisibleToAllUsers":{ "name":"SetVisibleToAllUsers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetVisibleToAllUsersInput"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

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 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.

" }, "TerminateJobFlows":{ "name":"TerminateJobFlows", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateJobFlowsInput"}, "errors":[ {"shape":"InternalServerError"} ], "documentation":"

TerminateJobFlows shuts a list of job flows down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the job flow is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the job flow was created.

The maximum number of JobFlows allowed is 10. The call to TerminateJobFlows is asynchronous. Depending on the configuration of the job flow, it may take up to 1-5 minutes for the job flow to completely terminate and release allocated resources, such as Amazon EC2 instances.

" } }, "shapes":{ "ActionOnFailure":{ "type":"string", "enum":[ "TERMINATE_JOB_FLOW", "TERMINATE_CLUSTER", "CANCEL_AND_WAIT", "CONTINUE" ] }, "AddInstanceGroupsInput":{ "type":"structure", "required":[ "InstanceGroups", "JobFlowId" ], "members":{ "InstanceGroups":{ "shape":"InstanceGroupConfigList", "documentation":"

Instance groups to add.

" }, "JobFlowId":{ "shape":"XmlStringMaxLen256", "documentation":"

Job flow in which to add the instance groups.

" } }, "documentation":"

Input to an AddInstanceGroups call.

" }, "AddInstanceGroupsOutput":{ "type":"structure", "members":{ "JobFlowId":{ "shape":"XmlStringMaxLen256", "documentation":"

The job flow ID in which the instance groups are added.

" }, "InstanceGroupIds":{ "shape":"InstanceGroupIdsList", "documentation":"

Instance group IDs of the newly created instance groups.

" } }, "documentation":"

Output from an AddInstanceGroups call.

" }, "AddJobFlowStepsInput":{ "type":"structure", "required":[ "JobFlowId", "Steps" ], "members":{ "JobFlowId":{ "shape":"XmlStringMaxLen256", "documentation":"

A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be obtained from ListClusters.

" }, "Steps":{ "shape":"StepConfigList", "documentation":"

A list of StepConfig to be executed by the job flow.

" } }, "documentation":"

The input argument to the AddJobFlowSteps operation.

" }, "AddJobFlowStepsOutput":{ "type":"structure", "members":{ "StepIds":{ "shape":"StepIdsList", "documentation":"

The identifiers of the list of steps added to the job flow.

" } }, "documentation":"

The output for the AddJobFlowSteps operation.

" }, "AddTagsInput":{ "type":"structure", "required":[ "ResourceId", "Tags" ], "members":{ "ResourceId":{ "shape":"ResourceId", "documentation":"

The Amazon EMR resource identifier to which tags will be added. This value must be a cluster identifier.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of tags to associate with a cluster and propagate to 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.

" } }, "documentation":"

This input identifies a cluster and a list of tags to attach.

" }, "AddTagsOutput":{ "type":"structure", "members":{ }, "documentation":"

This output indicates the result of adding tags to a resource.

" }, "AdjustmentType":{ "type":"string", "enum":[ "CHANGE_IN_CAPACITY", "PERCENT_CHANGE_IN_CAPACITY", "EXACT_CAPACITY" ] }, "Application":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the application.

" }, "Version":{ "shape":"String", "documentation":"

The version of the application.

" }, "Args":{ "shape":"StringList", "documentation":"

Arguments for Amazon EMR to pass to the application.

" }, "AdditionalInfo":{ "shape":"StringMap", "documentation":"

This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.

" } }, "documentation":"

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 script as bootstrap action argument. For more information, see Launch a Job Flow on the MapR Distribution for Hadoop. Currently supported values are:

  • \"mapr-m3\" - launch the job flow using MapR M3 Edition.

  • \"mapr-m5\" - launch the job flow using MapR M5 Edition.

  • \"mapr\" with the user arguments specifying \"--edition,m3\" or \"--edition,m5\" - launch the job flow using MapR M3 or M5 Edition, respectively.

In Amazon EMR releases 4.0 and greater, the only accepted parameter is the application name. To pass arguments to applications, you supply a configuration for each application.

" }, "ApplicationList":{ "type":"list", "member":{"shape":"Application"} }, "AutoScalingPolicy":{ "type":"structure", "required":[ "Constraints", "Rules" ], "members":{ "Constraints":{ "shape":"ScalingConstraints", "documentation":"

The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.

" }, "Rules":{ "shape":"ScalingRuleList", "documentation":"

The scale-in and scale-out rules that comprise the automatic scaling policy.

" } }, "documentation":"

An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. An automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.

" }, "AutoScalingPolicyDescription":{ "type":"structure", "members":{ "Status":{ "shape":"AutoScalingPolicyStatus", "documentation":"

The status of an automatic scaling policy.

" }, "Constraints":{ "shape":"ScalingConstraints", "documentation":"

The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.

" }, "Rules":{ "shape":"ScalingRuleList", "documentation":"

The scale-in and scale-out rules that comprise the automatic scaling policy.

" } }, "documentation":"

An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.

" }, "AutoScalingPolicyState":{ "type":"string", "enum":[ "PENDING", "ATTACHING", "ATTACHED", "DETACHING", "DETACHED", "FAILED" ] }, "AutoScalingPolicyStateChangeReason":{ "type":"structure", "members":{ "Code":{ "shape":"AutoScalingPolicyStateChangeReasonCode", "documentation":"

The code indicating the reason for the change in status.USER_REQUEST indicates that the scaling policy status was changed by a user. PROVISION_FAILURE indicates that the status change was because the policy failed to provision. CLEANUP_FAILURE indicates something unclean happened.-->

" }, "Message":{ "shape":"String", "documentation":"

A friendly, more verbose message that accompanies an automatic scaling policy state change.

" } }, "documentation":"

The reason for an AutoScalingPolicyStatus change.

" }, "AutoScalingPolicyStateChangeReasonCode":{ "type":"string", "enum":[ "USER_REQUEST", "PROVISION_FAILURE", "CLEANUP_FAILURE" ] }, "AutoScalingPolicyStatus":{ "type":"structure", "members":{ "State":{ "shape":"AutoScalingPolicyState", "documentation":"

" }, "StateChangeReason":{ "shape":"AutoScalingPolicyStateChangeReason", "documentation":"

The reason for a change in status.

" } }, "documentation":"

The status of an automatic scaling policy.

" }, "Boolean":{"type":"boolean"}, "BooleanObject":{"type":"boolean"}, "BootstrapActionConfig":{ "type":"structure", "required":[ "Name", "ScriptBootstrapAction" ], "members":{ "Name":{ "shape":"XmlStringMaxLen256", "documentation":"

The name of the bootstrap action.

" }, "ScriptBootstrapAction":{ "shape":"ScriptBootstrapActionConfig", "documentation":"

The script run by the bootstrap action.

" } }, "documentation":"

Configuration of a bootstrap action.

" }, "BootstrapActionConfigList":{ "type":"list", "member":{"shape":"BootstrapActionConfig"} }, "BootstrapActionDetail":{ "type":"structure", "members":{ "BootstrapActionConfig":{ "shape":"BootstrapActionConfig", "documentation":"

A description of the bootstrap action.

" } }, "documentation":"

Reports the configuration of a bootstrap action in a job flow.

" }, "BootstrapActionDetailList":{ "type":"list", "member":{"shape":"BootstrapActionDetail"} }, "CancelStepsInfo":{ "type":"structure", "members":{ "StepId":{"shape":"StepId"}, "Status":{"shape":"CancelStepsRequestStatus"}, "Reason":{"shape":"String"} } }, "CancelStepsInfoList":{ "type":"list", "member":{"shape":"CancelStepsInfo"} }, "CancelStepsInput":{ "type":"structure", "members":{ "ClusterId":{ "shape":"XmlStringMaxLen256", "documentation":"

The ClusterID for which specified steps will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs.

" }, "StepIds":{ "shape":"StepIdsList", "documentation":"

The list of StepIDs to cancel. Use ListSteps to get steps and their states for the specified cluster.

" } }, "documentation":"

The input argument to the CancelSteps operation.

" }, "CancelStepsOutput":{ "type":"structure", "members":{ "CancelStepsInfoList":{ "shape":"CancelStepsInfoList", "documentation":"

A list of CancelStepsInfo, which shows the status of specified cancel requests for each StepID specified.

" } }, "documentation":"

The output for the CancelSteps operation.

" }, "CancelStepsRequestStatus":{ "type":"string", "enum":[ "SUBMITTED", "FAILED" ] }, "CloudWatchAlarmDefinition":{ "type":"structure", "required":[ "ComparisonOperator", "MetricName", "Period", "Threshold" ], "members":{ "ComparisonOperator":{ "shape":"ComparisonOperator", "documentation":"

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

" }, "EvaluationPeriods":{ "shape":"Integer", "documentation":"

The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

" }, "MetricName":{ "shape":"String", "documentation":"

The name of the CloudWatch metric that is watched to determine an alarm condition.

" }, "Namespace":{ "shape":"String", "documentation":"

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

" }, "Period":{ "shape":"Integer", "documentation":"

The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.

" }, "Statistic":{ "shape":"Statistic", "documentation":"

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

" }, "Threshold":{ "shape":"NonNegativeDouble", "documentation":"

The value against which the specified statistic is compared.

" }, "Unit":{ "shape":"Unit", "documentation":"

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

" }, "Dimensions":{ "shape":"MetricDimensionList", "documentation":"

A CloudWatch metric dimension.

" } }, "documentation":"

The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered. When the defined alarm conditions are satisfied, scaling activity begins.

" }, "Cluster":{ "type":"structure", "members":{ "Id":{ "shape":"ClusterId", "documentation":"

The unique identifier for the cluster.

" }, "Name":{ "shape":"String", "documentation":"

The name of the cluster.

" }, "Status":{ "shape":"ClusterStatus", "documentation":"

The current status details about the cluster.

" }, "Ec2InstanceAttributes":{ "shape":"Ec2InstanceAttributes", "documentation":"

Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

" }, "LogUri":{ "shape":"String", "documentation":"

The path to the Amazon S3 location where logs for this cluster are stored.

" }, "RequestedAmiVersion":{ "shape":"String", "documentation":"

The AMI version requested for this cluster.

" }, "RunningAmiVersion":{ "shape":"String", "documentation":"

The AMI version running on this cluster.

" }, "ReleaseLabel":{ "shape":"String", "documentation":"

The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.

" }, "AutoTerminate":{ "shape":"Boolean", "documentation":"

Specifies whether the cluster should terminate after completing all steps.

" }, "TerminationProtected":{ "shape":"Boolean", "documentation":"

Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.

" }, "VisibleToAllUsers":{ "shape":"Boolean", "documentation":"

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. 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.

" }, "Applications":{ "shape":"ApplicationList", "documentation":"

The applications installed on this cluster.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of tags associated with a cluster.

" }, "ServiceRole":{ "shape":"String", "documentation":"

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

" }, "NormalizedInstanceHours":{ "shape":"Integer", "documentation":"

An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

" }, "MasterPublicDnsName":{ "shape":"String", "documentation":"

The public DNS name of the master EC2 instance.

" }, "Configurations":{ "shape":"ConfigurationList", "documentation":"

Amazon EMR releases 4.x or later.

The list of Configurations supplied to the EMR cluster.

" }, "SecurityConfiguration":{ "shape":"XmlString", "documentation":"

The name of the security configuration applied to the cluster.

" }, "AutoScalingRole":{ "shape":"XmlString", "documentation":"

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

" }, "ScaleDownBehavior":{ "shape":"ScaleDownBehavior", "documentation":"

The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

" } }, "documentation":"

The detailed description of the cluster.

" }, "ClusterId":{"type":"string"}, "ClusterState":{ "type":"string", "enum":[ "STARTING", "BOOTSTRAPPING", "RUNNING", "WAITING", "TERMINATING", "TERMINATED", "TERMINATED_WITH_ERRORS" ] }, "ClusterStateChangeReason":{ "type":"structure", "members":{ "Code":{ "shape":"ClusterStateChangeReasonCode", "documentation":"

The programmatic code for the state change reason.

" }, "Message":{ "shape":"String", "documentation":"

The descriptive message for the state change reason.

" } }, "documentation":"

The reason that the cluster changed to its current state.

" }, "ClusterStateChangeReasonCode":{ "type":"string", "enum":[ "INTERNAL_ERROR", "VALIDATION_ERROR", "INSTANCE_FAILURE", "BOOTSTRAP_FAILURE", "USER_REQUEST", "STEP_FAILURE", "ALL_STEPS_COMPLETED" ] }, "ClusterStateList":{ "type":"list", "member":{"shape":"ClusterState"} }, "ClusterStatus":{ "type":"structure", "members":{ "State":{ "shape":"ClusterState", "documentation":"

The current state of the cluster.

" }, "StateChangeReason":{ "shape":"ClusterStateChangeReason", "documentation":"

The reason for the cluster status change.

" }, "Timeline":{ "shape":"ClusterTimeline", "documentation":"

A timeline that represents the status of a cluster over the lifetime of the cluster.

" } }, "documentation":"

The detailed status of the cluster.

" }, "ClusterSummary":{ "type":"structure", "members":{ "Id":{ "shape":"ClusterId", "documentation":"

The unique identifier for the cluster.

" }, "Name":{ "shape":"String", "documentation":"

The name of the cluster.

" }, "Status":{ "shape":"ClusterStatus", "documentation":"

The details about the current status of the cluster.

" }, "NormalizedInstanceHours":{ "shape":"Integer", "documentation":"

An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

" } }, "documentation":"

The summary description of the cluster.

" }, "ClusterSummaryList":{ "type":"list", "member":{"shape":"ClusterSummary"} }, "ClusterTimeline":{ "type":"structure", "members":{ "CreationDateTime":{ "shape":"Date", "documentation":"

The creation date and time of the cluster.

" }, "ReadyDateTime":{ "shape":"Date", "documentation":"

The date and time when the cluster was ready to execute steps.

" }, "EndDateTime":{ "shape":"Date", "documentation":"

The date and time when the cluster was terminated.

" } }, "documentation":"

Represents the timeline of the cluster's lifecycle.

" }, "Command":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the command.

" }, "ScriptPath":{ "shape":"String", "documentation":"

The Amazon S3 location of the command script.

" }, "Args":{ "shape":"StringList", "documentation":"

Arguments for Amazon EMR to pass to the command for execution.

" } }, "documentation":"

An entity describing an executable that runs on a cluster.

" }, "CommandList":{ "type":"list", "member":{"shape":"Command"} }, "ComparisonOperator":{ "type":"string", "enum":[ "GREATER_THAN_OR_EQUAL", "GREATER_THAN", "LESS_THAN", "LESS_THAN_OR_EQUAL" ] }, "Configuration":{ "type":"structure", "members":{ "Classification":{ "shape":"String", "documentation":"

The classification of a configuration. For more information see, Amazon EMR Configurations.

" }, "Configurations":{ "shape":"ConfigurationList", "documentation":"

A list of configurations you apply to this configuration object.

" }, "Properties":{ "shape":"StringMap", "documentation":"

A set of properties supplied to the Configuration object.

" } }, "documentation":"

Amazon EMR releases 4.x or later.

Specifies a hardware and software configuration of the EMR cluster. This includes configurations for applications and software bundled with Amazon EMR. The Configuration object is a JSON object which is defined by a classification and a set of properties. Configurations can be nested, so a configuration may have its own Configuration objects listed.

" }, "ConfigurationList":{ "type":"list", "member":{"shape":"Configuration"} }, "CreateSecurityConfigurationInput":{ "type":"structure", "required":[ "Name", "SecurityConfiguration" ], "members":{ "Name":{ "shape":"XmlString", "documentation":"

The name of the security configuration.

" }, "SecurityConfiguration":{ "shape":"String", "documentation":"

The security configuration details in JSON format.

" } } }, "CreateSecurityConfigurationOutput":{ "type":"structure", "required":[ "Name", "CreationDateTime" ], "members":{ "Name":{ "shape":"XmlString", "documentation":"

The name of the security configuration.

" }, "CreationDateTime":{ "shape":"Date", "documentation":"

The date and time the security configuration was created.

" } } }, "Date":{"type":"timestamp"}, "DeleteSecurityConfigurationInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"XmlString", "documentation":"

The name of the security configuration.

" } } }, "DeleteSecurityConfigurationOutput":{ "type":"structure", "members":{ } }, "DescribeClusterInput":{ "type":"structure", "required":["ClusterId"], "members":{ "ClusterId":{ "shape":"ClusterId", "documentation":"

The identifier of the cluster to describe.

" } }, "documentation":"

This input determines which cluster to describe.

" }, "DescribeClusterOutput":{ "type":"structure", "members":{ "Cluster":{ "shape":"Cluster", "documentation":"

This output contains the details for the requested cluster.

" } }, "documentation":"

This output contains the description of the cluster.

" }, "DescribeJobFlowsInput":{ "type":"structure", "members":{ "CreatedAfter":{ "shape":"Date", "documentation":"

Return only job flows created after this date and time.

" }, "CreatedBefore":{ "shape":"Date", "documentation":"

Return only job flows created before this date and time.

" }, "JobFlowIds":{ "shape":"XmlStringList", "documentation":"

Return only job flows whose job flow ID is contained in this list.

" }, "JobFlowStates":{ "shape":"JobFlowExecutionStateList", "documentation":"

Return only job flows whose state is contained in this list.

" } }, "documentation":"

The input for the DescribeJobFlows operation.

" }, "DescribeJobFlowsOutput":{ "type":"structure", "members":{ "JobFlows":{ "shape":"JobFlowDetailList", "documentation":"

A list of job flows matching the parameters supplied.

" } }, "documentation":"

The output for the DescribeJobFlows operation.

" }, "DescribeSecurityConfigurationInput":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"XmlString", "documentation":"

The name of the security configuration.

" } } }, "DescribeSecurityConfigurationOutput":{ "type":"structure", "members":{ "Name":{ "shape":"XmlString", "documentation":"

The name of the security configuration.

" }, "SecurityConfiguration":{ "shape":"String", "documentation":"

The security configuration details in JSON format.

" }, "CreationDateTime":{ "shape":"Date", "documentation":"

The date and time the security configuration was created

" } } }, "DescribeStepInput":{ "type":"structure", "required":[ "ClusterId", "StepId" ], "members":{ "ClusterId":{ "shape":"ClusterId", "documentation":"

The identifier of the cluster with steps to describe.

" }, "StepId":{ "shape":"StepId", "documentation":"

The identifier of the step to describe.

" } }, "documentation":"

This input determines which step to describe.

" }, "DescribeStepOutput":{ "type":"structure", "members":{ "Step":{ "shape":"Step", "documentation":"

The step details for the requested step identifier.

" } }, "documentation":"

This output contains the description of the cluster step.

" }, "EC2InstanceIdsList":{ "type":"list", "member":{"shape":"InstanceId"} }, "EC2InstanceIdsToTerminateList":{ "type":"list", "member":{"shape":"InstanceId"} }, "EbsBlockDevice":{ "type":"structure", "members":{ "VolumeSpecification":{ "shape":"VolumeSpecification", "documentation":"

EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.

" }, "Device":{ "shape":"String", "documentation":"

The device name that is exposed to the instance, such as /dev/sdh.

" } }, "documentation":"

Configuration of requested EBS block device associated with the instance group.

" }, "EbsBlockDeviceConfig":{ "type":"structure", "required":["VolumeSpecification"], "members":{ "VolumeSpecification":{ "shape":"VolumeSpecification", "documentation":"

EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.

" }, "VolumesPerInstance":{ "shape":"Integer", "documentation":"

Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group

" } }, "documentation":"

Configuration of requested EBS block device associated with the instance group with count of volumes that will be associated to every instance.

" }, "EbsBlockDeviceConfigList":{ "type":"list", "member":{"shape":"EbsBlockDeviceConfig"} }, "EbsBlockDeviceList":{ "type":"list", "member":{"shape":"EbsBlockDevice"} }, "EbsConfiguration":{ "type":"structure", "members":{ "EbsBlockDeviceConfigs":{ "shape":"EbsBlockDeviceConfigList", "documentation":"

An array of Amazon EBS volume specifications attached to a cluster instance.

" }, "EbsOptimized":{ "shape":"BooleanObject", "documentation":"

Indicates whether an Amazon EBS volume is EBS-optimized.

" } }, "documentation":"

The Amazon EBS configuration of a cluster instance.

" }, "EbsVolume":{ "type":"structure", "members":{ "Device":{ "shape":"String", "documentation":"

The device name that is exposed to the instance, such as /dev/sdh.

" }, "VolumeId":{ "shape":"String", "documentation":"

The volume identifier of the EBS volume.

" } }, "documentation":"

EBS block device that's attached to an EC2 instance.

" }, "EbsVolumeList":{ "type":"list", "member":{"shape":"EbsVolume"} }, "Ec2InstanceAttributes":{ "type":"structure", "members":{ "Ec2KeyName":{ "shape":"String", "documentation":"

The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named \"hadoop\".

" }, "Ec2SubnetId":{ "shape":"String", "documentation":"

To launch the job flow in Amazon VPC, set this parameter to the identifier of the Amazon VPC subnet where 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 a VPC.

Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus, you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a VPC.

" }, "Ec2AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone in which the cluster will run.

" }, "IamInstanceProfile":{ "shape":"String", "documentation":"

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

" }, "EmrManagedMasterSecurityGroup":{ "shape":"String", "documentation":"

The identifier of the Amazon EC2 security group for the master node.

" }, "EmrManagedSlaveSecurityGroup":{ "shape":"String", "documentation":"

The identifier of the Amazon EC2 security group for the slave nodes.

" }, "ServiceAccessSecurityGroup":{ "shape":"String", "documentation":"

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

" }, "AdditionalMasterSecurityGroups":{ "shape":"StringList", "documentation":"

A list of additional Amazon EC2 security group IDs for the master node.

" }, "AdditionalSlaveSecurityGroups":{ "shape":"StringList", "documentation":"

A list of additional Amazon EC2 security group IDs for the slave nodes.

" } }, "documentation":"

Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

" }, "ErrorCode":{ "type":"string", "max":256, "min":1 }, "ErrorMessage":{"type":"string"}, "FailureDetails":{ "type":"structure", "members":{ "Reason":{ "shape":"String", "documentation":"

The reason for the step failure. In the case where the service cannot successfully determine the root cause of the failure, it returns \"Unknown Error\" as a reason.

" }, "Message":{ "shape":"String", "documentation":"

The descriptive message including the error the EMR service has identified as the cause of step failure. This is text from an error log that describes the root cause of the failure.

" }, "LogFile":{ "shape":"String", "documentation":"

The path to the log file where the step failure root cause was originally recorded.

" } }, "documentation":"

The details of the step failure. The service attempts to detect the root cause for many common failures.

" }, "HadoopJarStepConfig":{ "type":"structure", "required":["Jar"], "members":{ "Properties":{ "shape":"KeyValueList", "documentation":"

A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.

" }, "Jar":{ "shape":"XmlString", "documentation":"

A path to a JAR file run during the step.

" }, "MainClass":{ "shape":"XmlString", "documentation":"

The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file.

" }, "Args":{ "shape":"XmlStringList", "documentation":"

A list of command line arguments passed to the JAR file's main function when executed.

" } }, "documentation":"

A job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.

" }, "HadoopStepConfig":{ "type":"structure", "members":{ "Jar":{ "shape":"String", "documentation":"

The path to the JAR file that runs during the step.

" }, "Properties":{ "shape":"StringMap", "documentation":"

The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.

" }, "MainClass":{ "shape":"String", "documentation":"

The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.

" }, "Args":{ "shape":"StringList", "documentation":"

The list of command line arguments to pass to the JAR file's main function for execution.

" } }, "documentation":"

A cluster step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.

" }, "Instance":{ "type":"structure", "members":{ "Id":{ "shape":"InstanceId", "documentation":"

The unique identifier for the instance in Amazon EMR.

" }, "Ec2InstanceId":{ "shape":"InstanceId", "documentation":"

The unique identifier of the instance in Amazon EC2.

" }, "PublicDnsName":{ "shape":"String", "documentation":"

The public DNS name of the instance.

" }, "PublicIpAddress":{ "shape":"String", "documentation":"

The public IP address of the instance.

" }, "PrivateDnsName":{ "shape":"String", "documentation":"

The private DNS name of the instance.

" }, "PrivateIpAddress":{ "shape":"String", "documentation":"

The private IP address of the instance.

" }, "Status":{ "shape":"InstanceStatus", "documentation":"

The current status of the instance.

" }, "InstanceGroupId":{ "shape":"String", "documentation":"

The identifier of the instance group to which this instance belongs.

" }, "EbsVolumes":{ "shape":"EbsVolumeList", "documentation":"

The list of EBS volumes that are attached to this instance.

" } }, "documentation":"

Represents an EC2 instance provisioned as part of cluster.

" }, "InstanceGroup":{ "type":"structure", "members":{ "Id":{ "shape":"InstanceGroupId", "documentation":"

The identifier of the instance group.

" }, "Name":{ "shape":"String", "documentation":"

The name of the instance group.

" }, "Market":{ "shape":"MarketType", "documentation":"

The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

" }, "InstanceGroupType":{ "shape":"InstanceGroupType", "documentation":"

The type of the instance group. Valid values are MASTER, CORE or TASK.

" }, "BidPrice":{ "shape":"String", "documentation":"

The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.

" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The EC2 instance type for all instances in the instance group.

" }, "RequestedInstanceCount":{ "shape":"Integer", "documentation":"

The target number of instances for the instance group.

" }, "RunningInstanceCount":{ "shape":"Integer", "documentation":"

The number of instances currently running in this instance group.

" }, "Status":{ "shape":"InstanceGroupStatus", "documentation":"

The current status of the instance group.

" }, "Configurations":{ "shape":"ConfigurationList", "documentation":"

Amazon EMR releases 4.x or later.

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

" }, "EbsBlockDevices":{ "shape":"EbsBlockDeviceList", "documentation":"

The EBS block devices that are mapped to this instance group.

" }, "EbsOptimized":{ "shape":"BooleanObject", "documentation":"

If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.

" }, "ShrinkPolicy":{ "shape":"ShrinkPolicy", "documentation":"

Policy for customizing shrink operations.

" }, "AutoScalingPolicy":{ "shape":"AutoScalingPolicyDescription", "documentation":"

An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.

" } }, "documentation":"

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.

" }, "InstanceGroupConfig":{ "type":"structure", "required":[ "InstanceRole", "InstanceType", "InstanceCount" ], "members":{ "Name":{ "shape":"XmlStringMaxLen256", "documentation":"

Friendly name given to the instance group.

" }, "Market":{ "shape":"MarketType", "documentation":"

Market type of the EC2 instances used to create a cluster node.

" }, "InstanceRole":{ "shape":"InstanceRoleType", "documentation":"

The role of the instance group in the cluster.

" }, "BidPrice":{ "shape":"XmlStringMaxLen256", "documentation":"

Bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.

" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

The EC2 instance type for all instances in the instance group.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

Target number of instances for the instance group.

" }, "Configurations":{ "shape":"ConfigurationList", "documentation":"

Amazon EMR releases 4.x or later.

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

" }, "EbsConfiguration":{ "shape":"EbsConfiguration", "documentation":"

EBS configurations that will be attached to each EC2 instance in the instance group.

" }, "AutoScalingPolicy":{ "shape":"AutoScalingPolicy", "documentation":"

An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.

" } }, "documentation":"

Configuration defining a new instance group.

" }, "InstanceGroupConfigList":{ "type":"list", "member":{"shape":"InstanceGroupConfig"} }, "InstanceGroupDetail":{ "type":"structure", "required":[ "Market", "InstanceRole", "InstanceType", "InstanceRequestCount", "InstanceRunningCount", "State", "CreationDateTime" ], "members":{ "InstanceGroupId":{ "shape":"XmlStringMaxLen256", "documentation":"

Unique identifier for the instance group.

" }, "Name":{ "shape":"XmlStringMaxLen256", "documentation":"

Friendly name for the instance group.

" }, "Market":{ "shape":"MarketType", "documentation":"

Market type of the EC2 instances used to create a cluster node.

" }, "InstanceRole":{ "shape":"InstanceRoleType", "documentation":"

Instance group role in the cluster

" }, "BidPrice":{ "shape":"XmlStringMaxLen256", "documentation":"

Bid price for EC2 Instances when launching nodes as Spot Instances, expressed in USD.

" }, "InstanceType":{ "shape":"InstanceType", "documentation":"

EC2 instance type.

" }, "InstanceRequestCount":{ "shape":"Integer", "documentation":"

Target number of instances to run in the instance group.

" }, "InstanceRunningCount":{ "shape":"Integer", "documentation":"

Actual count of running instances.

" }, "State":{ "shape":"InstanceGroupState", "documentation":"

State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED.

" }, "LastStateChangeReason":{ "shape":"XmlString", "documentation":"

Details regarding the state of the instance group.

" }, "CreationDateTime":{ "shape":"Date", "documentation":"

The date/time the instance group was created.

" }, "StartDateTime":{ "shape":"Date", "documentation":"

The date/time the instance group was started.

" }, "ReadyDateTime":{ "shape":"Date", "documentation":"

The date/time the instance group was available to the cluster.

" }, "EndDateTime":{ "shape":"Date", "documentation":"

The date/time the instance group was terminated.

" } }, "documentation":"

Detailed information about an instance group.

" }, "InstanceGroupDetailList":{ "type":"list", "member":{"shape":"InstanceGroupDetail"} }, "InstanceGroupId":{"type":"string"}, "InstanceGroupIdsList":{ "type":"list", "member":{"shape":"XmlStringMaxLen256"} }, "InstanceGroupList":{ "type":"list", "member":{"shape":"InstanceGroup"} }, "InstanceGroupModifyConfig":{ "type":"structure", "required":["InstanceGroupId"], "members":{ "InstanceGroupId":{ "shape":"XmlStringMaxLen256", "documentation":"

Unique ID of the instance group to expand or shrink.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

Target size for the instance group.

" }, "EC2InstanceIdsToTerminate":{ "shape":"EC2InstanceIdsToTerminateList", "documentation":"

The EC2 InstanceIds to terminate. After you terminate the instances, the instance group will not return to its original requested size.

" }, "ShrinkPolicy":{ "shape":"ShrinkPolicy", "documentation":"

Policy for customizing shrink operations.

" } }, "documentation":"

Modify an instance group size.

" }, "InstanceGroupModifyConfigList":{ "type":"list", "member":{"shape":"InstanceGroupModifyConfig"} }, "InstanceGroupState":{ "type":"string", "enum":[ "PROVISIONING", "BOOTSTRAPPING", "RUNNING", "RESIZING", "SUSPENDED", "TERMINATING", "TERMINATED", "ARRESTED", "SHUTTING_DOWN", "ENDED" ] }, "InstanceGroupStateChangeReason":{ "type":"structure", "members":{ "Code":{ "shape":"InstanceGroupStateChangeReasonCode", "documentation":"

The programmable code for the state change reason.

" }, "Message":{ "shape":"String", "documentation":"

The status change reason description.

" } }, "documentation":"

The status change reason details for the instance group.

" }, "InstanceGroupStateChangeReasonCode":{ "type":"string", "enum":[ "INTERNAL_ERROR", "VALIDATION_ERROR", "INSTANCE_FAILURE", "CLUSTER_TERMINATED" ] }, "InstanceGroupStatus":{ "type":"structure", "members":{ "State":{ "shape":"InstanceGroupState", "documentation":"

The current state of the instance group.

" }, "StateChangeReason":{ "shape":"InstanceGroupStateChangeReason", "documentation":"

The status change reason details for the instance group.

" }, "Timeline":{ "shape":"InstanceGroupTimeline", "documentation":"

The timeline of the instance group status over time.

" } }, "documentation":"

The details of the instance group status.

" }, "InstanceGroupTimeline":{ "type":"structure", "members":{ "CreationDateTime":{ "shape":"Date", "documentation":"

The creation date and time of the instance group.

" }, "ReadyDateTime":{ "shape":"Date", "documentation":"

The date and time when the instance group became ready to perform tasks.

" }, "EndDateTime":{ "shape":"Date", "documentation":"

The date and time when the instance group terminated.

" } }, "documentation":"

The timeline of the instance group lifecycle.

" }, "InstanceGroupType":{ "type":"string", "enum":[ "MASTER", "CORE", "TASK" ] }, "InstanceGroupTypeList":{ "type":"list", "member":{"shape":"InstanceGroupType"} }, "InstanceId":{"type":"string"}, "InstanceList":{ "type":"list", "member":{"shape":"Instance"} }, "InstanceResizePolicy":{ "type":"structure", "members":{ "InstancesToTerminate":{ "shape":"EC2InstanceIdsList", "documentation":"

Specific list of instances to be terminated when shrinking an instance group.

" }, "InstancesToProtect":{ "shape":"EC2InstanceIdsList", "documentation":"

Specific list of instances to be protected when shrinking an instance group.

" }, "InstanceTerminationTimeout":{ "shape":"Integer", "documentation":"

Decommissioning timeout override for the specific list of instances to be terminated.

" } }, "documentation":"

Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.

" }, "InstanceRoleType":{ "type":"string", "enum":[ "MASTER", "CORE", "TASK" ] }, "InstanceState":{ "type":"string", "enum":[ "AWAITING_FULFILLMENT", "PROVISIONING", "BOOTSTRAPPING", "RUNNING", "TERMINATED" ] }, "InstanceStateChangeReason":{ "type":"structure", "members":{ "Code":{ "shape":"InstanceStateChangeReasonCode", "documentation":"

The programmable code for the state change reason.

" }, "Message":{ "shape":"String", "documentation":"

The status change reason description.

" } }, "documentation":"

The details of the status change reason for the instance.

" }, "InstanceStateChangeReasonCode":{ "type":"string", "enum":[ "INTERNAL_ERROR", "VALIDATION_ERROR", "INSTANCE_FAILURE", "BOOTSTRAP_FAILURE", "CLUSTER_TERMINATED" ] }, "InstanceStateList":{ "type":"list", "member":{"shape":"InstanceState"} }, "InstanceStatus":{ "type":"structure", "members":{ "State":{ "shape":"InstanceState", "documentation":"

The current state of the instance.

" }, "StateChangeReason":{ "shape":"InstanceStateChangeReason", "documentation":"

The details of the status change reason for the instance.

" }, "Timeline":{ "shape":"InstanceTimeline", "documentation":"

The timeline of the instance status over time.

" } }, "documentation":"

The instance status details.

" }, "InstanceTimeline":{ "type":"structure", "members":{ "CreationDateTime":{ "shape":"Date", "documentation":"

The creation date and time of the instance.

" }, "ReadyDateTime":{ "shape":"Date", "documentation":"

The date and time when the instance was ready to perform tasks.

" }, "EndDateTime":{ "shape":"Date", "documentation":"

The date and time when the instance was terminated.

" } }, "documentation":"

The timeline of the instance lifecycle.

" }, "InstanceType":{ "type":"string", "max":256, "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "Integer":{"type":"integer"}, "InternalServerError":{ "type":"structure", "members":{ }, "documentation":"

Indicates that an error occurred while processing the request and that the request was not completed.

", "exception":true }, "InternalServerException":{ "type":"structure", "members":{ "Message":{ "shape":"ErrorMessage", "documentation":"

The message associated with the exception.

" } }, "documentation":"

This exception occurs when there is an internal failure in the EMR service.

", "exception":true, "fault":true }, "InvalidRequestException":{ "type":"structure", "members":{ "ErrorCode":{ "shape":"ErrorCode", "documentation":"

The error code associated with the exception.

" }, "Message":{ "shape":"ErrorMessage", "documentation":"

The message associated with the exception.

" } }, "documentation":"

This exception occurs when there is something wrong with user input.

", "exception":true }, "JobFlowDetail":{ "type":"structure", "required":[ "JobFlowId", "Name", "ExecutionStatusDetail", "Instances" ], "members":{ "JobFlowId":{ "shape":"XmlStringMaxLen256", "documentation":"

The job flow identifier.

" }, "Name":{ "shape":"XmlStringMaxLen256", "documentation":"

The name of the job flow.

" }, "LogUri":{ "shape":"XmlString", "documentation":"

The location in Amazon S3 where log files for the job are stored.

" }, "AmiVersion":{ "shape":"XmlStringMaxLen256", "documentation":"

The version of the AMI used to initialize Amazon EC2 instances in the job flow. For a list of AMI versions currently supported by Amazon EMR, see AMI Versions Supported in EMR in the Amazon EMR Developer Guide.

" }, "ExecutionStatusDetail":{ "shape":"JobFlowExecutionStatusDetail", "documentation":"

Describes the execution status of the job flow.

" }, "Instances":{ "shape":"JobFlowInstancesDetail", "documentation":"

Describes the Amazon EC2 instances of the job flow.

" }, "Steps":{ "shape":"StepDetailList", "documentation":"

A list of steps run by the job flow.

" }, "BootstrapActions":{ "shape":"BootstrapActionDetailList", "documentation":"

A list of the bootstrap actions run by the job flow.

" }, "SupportedProducts":{ "shape":"SupportedProductsList", "documentation":"

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.

" }, "VisibleToAllUsers":{ "shape":"Boolean", "documentation":"

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.

" }, "JobFlowRole":{ "shape":"XmlString", "documentation":"

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

" }, "ServiceRole":{ "shape":"XmlString", "documentation":"

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

" }, "AutoScalingRole":{ "shape":"XmlString", "documentation":"

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides a way for the automatic scaling feature to get the required permissions it needs to launch and terminate EC2 instances in an instance group.

" }, "ScaleDownBehavior":{ "shape":"ScaleDownBehavior", "documentation":"

The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

" } }, "documentation":"

A description of a job flow.

" }, "JobFlowDetailList":{ "type":"list", "member":{"shape":"JobFlowDetail"} }, "JobFlowExecutionState":{ "type":"string", "documentation":"

The type of instance.

", "enum":[ "STARTING", "BOOTSTRAPPING", "RUNNING", "WAITING", "SHUTTING_DOWN", "TERMINATED", "COMPLETED", "FAILED" ] }, "JobFlowExecutionStateList":{ "type":"list", "member":{"shape":"JobFlowExecutionState"} }, "JobFlowExecutionStatusDetail":{ "type":"structure", "required":[ "State", "CreationDateTime" ], "members":{ "State":{ "shape":"JobFlowExecutionState", "documentation":"

The state of the job flow.

" }, "CreationDateTime":{ "shape":"Date", "documentation":"

The creation date and time of the job flow.

" }, "StartDateTime":{ "shape":"Date", "documentation":"

The start date and time of the job flow.

" }, "ReadyDateTime":{ "shape":"Date", "documentation":"

The date and time when the job flow was ready to start running bootstrap actions.

" }, "EndDateTime":{ "shape":"Date", "documentation":"

The completion date and time of the job flow.

" }, "LastStateChangeReason":{ "shape":"XmlString", "documentation":"

Description of the job flow last changed state.

" } }, "documentation":"

Describes the status of the job flow.

" }, "JobFlowInstancesConfig":{ "type":"structure", "members":{ "MasterInstanceType":{ "shape":"InstanceType", "documentation":"

The EC2 instance type of the master node.

" }, "SlaveInstanceType":{ "shape":"InstanceType", "documentation":"

The EC2 instance type of the slave nodes.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of EC2 instances used to execute the job flow.

" }, "InstanceGroups":{ "shape":"InstanceGroupConfigList", "documentation":"

Configuration for the job flow's instance groups.

" }, "Ec2KeyName":{ "shape":"XmlStringMaxLen256", "documentation":"

The name of the EC2 key pair that can be used to ssh to the master node as the user called \"hadoop.\"

" }, "Placement":{ "shape":"PlacementType", "documentation":"

The Availability Zone the job flow will run in.

" }, "KeepJobFlowAliveWhenNoSteps":{ "shape":"Boolean", "documentation":"

Specifies whether the job flow should be kept alive after completing all steps.

" }, "TerminationProtected":{ "shape":"Boolean", "documentation":"

Specifies whether to lock the job flow to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job flow error.

" }, "HadoopVersion":{ "shape":"XmlStringMaxLen256", "documentation":"

The Hadoop version for the job flow. Valid inputs are \"0.18\" (deprecated), \"0.20\" (deprecated), \"0.20.205\" (deprecated), \"1.0.3\", \"2.2.0\", or \"2.4.0\". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.

" }, "Ec2SubnetId":{ "shape":"XmlStringMaxLen256", "documentation":"

To launch the job flow in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where 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 Amazon VPC.

Amazon VPC currently does not support cluster compute quadruple extra large (cc1.4xlarge) instances. Thus you cannot specify the cc1.4xlarge instance type for nodes of a job flow launched in a Amazon VPC.

" }, "EmrManagedMasterSecurityGroup":{ "shape":"XmlStringMaxLen256", "documentation":"

The identifier of the Amazon EC2 security group for the master node.

" }, "EmrManagedSlaveSecurityGroup":{ "shape":"XmlStringMaxLen256", "documentation":"

The identifier of the Amazon EC2 security group for the slave nodes.

" }, "ServiceAccessSecurityGroup":{ "shape":"XmlStringMaxLen256", "documentation":"

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

" }, "AdditionalMasterSecurityGroups":{ "shape":"SecurityGroupsList", "documentation":"

A list of additional Amazon EC2 security group IDs for the master node.

" }, "AdditionalSlaveSecurityGroups":{ "shape":"SecurityGroupsList", "documentation":"

A list of additional Amazon EC2 security group IDs for the slave nodes.

" } }, "documentation":"

A description of the Amazon EC2 instance running the job flow. A valid JobFlowInstancesConfig must contain at least InstanceGroups, which is the recommended configuration. However, a valid alternative is to have MasterInstanceType, SlaveInstanceType, and InstanceCount (all three must be present).

" }, "JobFlowInstancesDetail":{ "type":"structure", "required":[ "MasterInstanceType", "SlaveInstanceType", "InstanceCount" ], "members":{ "MasterInstanceType":{ "shape":"InstanceType", "documentation":"

The Amazon EC2 master node instance type.

" }, "MasterPublicDnsName":{ "shape":"XmlString", "documentation":"

The DNS name of the master node.

" }, "MasterInstanceId":{ "shape":"XmlString", "documentation":"

The Amazon EC2 instance identifier of the master node.

" }, "SlaveInstanceType":{ "shape":"InstanceType", "documentation":"

The Amazon EC2 slave node instance type.

" }, "InstanceCount":{ "shape":"Integer", "documentation":"

The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and slave node. If the value is greater than 1, one instance is the master node and all others are slave nodes.

" }, "InstanceGroups":{ "shape":"InstanceGroupDetailList", "documentation":"

Details about the job flow's instance groups.

" }, "NormalizedInstanceHours":{ "shape":"Integer", "documentation":"

An approximation of the cost of the job flow, represented in m1.small/hours. This value is incremented one time for every hour that an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

" }, "Ec2KeyName":{ "shape":"XmlStringMaxLen256", "documentation":"

The name of an Amazon EC2 key pair that can be used to ssh to the master node of job flow.

" }, "Ec2SubnetId":{ "shape":"XmlStringMaxLen256", "documentation":"

For job flows launched within Amazon Virtual Private Cloud, this value specifies the identifier of the subnet where the job flow was launched.

" }, "Placement":{ "shape":"PlacementType", "documentation":"

The Amazon EC2 Availability Zone for the job flow.

" }, "KeepJobFlowAliveWhenNoSteps":{ "shape":"Boolean", "documentation":"

Specifies whether the job flow should terminate after completing all steps.

" }, "TerminationProtected":{ "shape":"Boolean", "documentation":"

Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job flow error.

" }, "HadoopVersion":{ "shape":"XmlStringMaxLen256", "documentation":"

The Hadoop version for the job flow.

" } }, "documentation":"

Specify the type of Amazon EC2 instances to run the job flow on.

" }, "KeyValue":{ "type":"structure", "members":{ "Key":{ "shape":"XmlString", "documentation":"

The unique identifier of a key value pair.

" }, "Value":{ "shape":"XmlString", "documentation":"

The value part of the identified key.

" } }, "documentation":"

A key value pair.

" }, "KeyValueList":{ "type":"list", "member":{"shape":"KeyValue"} }, "ListBootstrapActionsInput":{ "type":"structure", "required":["ClusterId"], "members":{ "ClusterId":{ "shape":"ClusterId", "documentation":"

The cluster identifier for the bootstrap actions to list.

" }, "Marker":{ "shape":"Marker", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" } }, "documentation":"

This input determines which bootstrap actions to retrieve.

" }, "ListBootstrapActionsOutput":{ "type":"structure", "members":{ "BootstrapActions":{ "shape":"CommandList", "documentation":"

The bootstrap actions associated with the cluster.

" }, "Marker":{ "shape":"Marker", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" } }, "documentation":"

This output contains the bootstrap actions detail.

" }, "ListClustersInput":{ "type":"structure", "members":{ "CreatedAfter":{ "shape":"Date", "documentation":"

The creation date and time beginning value filter for listing clusters.

" }, "CreatedBefore":{ "shape":"Date", "documentation":"

The creation date and time end value filter for listing clusters.

" }, "ClusterStates":{ "shape":"ClusterStateList", "documentation":"

The cluster state filters to apply when listing clusters.

" }, "Marker":{ "shape":"Marker", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" } }, "documentation":"

This input determines how the ListClusters action filters the list of clusters that it returns.

" }, "ListClustersOutput":{ "type":"structure", "members":{ "Clusters":{ "shape":"ClusterSummaryList", "documentation":"

The list of clusters for the account based on the given filters.

" }, "Marker":{ "shape":"Marker", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" } }, "documentation":"

This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.

" }, "ListInstanceGroupsInput":{ "type":"structure", "required":["ClusterId"], "members":{ "ClusterId":{ "shape":"ClusterId", "documentation":"

The identifier of the cluster for which to list the instance groups.

" }, "Marker":{ "shape":"Marker", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" } }, "documentation":"

This input determines which instance groups to retrieve.

" }, "ListInstanceGroupsOutput":{ "type":"structure", "members":{ "InstanceGroups":{ "shape":"InstanceGroupList", "documentation":"

The list of instance groups for the cluster and given filters.

" }, "Marker":{ "shape":"Marker", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" } }, "documentation":"

This input determines which instance groups to retrieve.

" }, "ListInstancesInput":{ "type":"structure", "required":["ClusterId"], "members":{ "ClusterId":{ "shape":"ClusterId", "documentation":"

The identifier of the cluster for which to list the instances.

" }, "InstanceGroupId":{ "shape":"InstanceGroupId", "documentation":"

The identifier of the instance group for which to list the instances.

" }, "InstanceGroupTypes":{ "shape":"InstanceGroupTypeList", "documentation":"

The type of instance group for which to list the instances.

" }, "InstanceStates":{ "shape":"InstanceStateList", "documentation":"

A list of instance states that will filter the instances returned with this request.

" }, "Marker":{ "shape":"Marker", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" } }, "documentation":"

This input determines which instances to list.

" }, "ListInstancesOutput":{ "type":"structure", "members":{ "Instances":{ "shape":"InstanceList", "documentation":"

The list of instances for the cluster and given filters.

" }, "Marker":{ "shape":"Marker", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" } }, "documentation":"

This output contains the list of instances.

" }, "ListSecurityConfigurationsInput":{ "type":"structure", "members":{ "Marker":{ "shape":"Marker", "documentation":"

The pagination token that indicates the set of results to retrieve.

" } } }, "ListSecurityConfigurationsOutput":{ "type":"structure", "members":{ "SecurityConfigurations":{ "shape":"SecurityConfigurationList", "documentation":"

The creation date and time, and name, of each security configuration.

" }, "Marker":{ "shape":"Marker", "documentation":"

A pagination token that indicates the next set of results to retrieve. Include the marker in the next ListSecurityConfiguration call to retrieve the next page of results, if required.

" } } }, "ListStepsInput":{ "type":"structure", "required":["ClusterId"], "members":{ "ClusterId":{ "shape":"ClusterId", "documentation":"

The identifier of the cluster for which to list the steps.

" }, "StepStates":{ "shape":"StepStateList", "documentation":"

The filter to limit the step list based on certain states.

" }, "StepIds":{ "shape":"XmlStringList", "documentation":"

The filter to limit the step list based on the identifier of the steps.

" }, "Marker":{ "shape":"Marker", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" } }, "documentation":"

This input determines which steps to list.

" }, "ListStepsOutput":{ "type":"structure", "members":{ "Steps":{ "shape":"StepSummaryList", "documentation":"

The filtered list of steps for the cluster.

" }, "Marker":{ "shape":"Marker", "documentation":"

The pagination token that indicates the next set of results to retrieve.

" } }, "documentation":"

This output contains the list of steps returned in reverse order. This means that the last step is the first element in the list.

" }, "Marker":{"type":"string"}, "MarketType":{ "type":"string", "enum":[ "ON_DEMAND", "SPOT" ] }, "MetricDimension":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

The dimension name.

" }, "Value":{ "shape":"String", "documentation":"

The dimension value.

" } }, "documentation":"

A CloudWatch dimension, which is specified using a Key (known as a Name in CloudWatch), Value pair. By default, Amazon EMR uses one dimension whose Key is JobFlowID and Value is a variable representing the cluster ID, which is ${emr:cluster_id}. This enables the rule to bootstrap when the cluster ID becomes available, and also enables a single automatic scaling policy to be reused for multiple clusters and instance groups.

" }, "MetricDimensionList":{ "type":"list", "member":{"shape":"MetricDimension"} }, "ModifyInstanceGroupsInput":{ "type":"structure", "members":{ "ClusterId":{ "shape":"ClusterId", "documentation":"

The ID of the cluster to which the instance group belongs.

" }, "InstanceGroups":{ "shape":"InstanceGroupModifyConfigList", "documentation":"

Instance groups to change.

" } }, "documentation":"

Change the size of some instance groups.

" }, "NewSupportedProductsList":{ "type":"list", "member":{"shape":"SupportedProductConfig"} }, "NonNegativeDouble":{ "type":"double", "min":0.0 }, "PlacementType":{ "type":"structure", "required":["AvailabilityZone"], "members":{ "AvailabilityZone":{ "shape":"XmlString", "documentation":"

The Amazon EC2 Availability Zone for the job flow.

" } }, "documentation":"

The Amazon EC2 location for the job flow.

" }, "PutAutoScalingPolicyInput":{ "type":"structure", "required":[ "ClusterId", "InstanceGroupId", "AutoScalingPolicy" ], "members":{ "ClusterId":{ "shape":"ClusterId", "documentation":"

Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.

" }, "InstanceGroupId":{ "shape":"InstanceGroupId", "documentation":"

Specifies the ID of the instance group to which the automatic scaling policy is applied.

" }, "AutoScalingPolicy":{ "shape":"AutoScalingPolicy", "documentation":"

Specifies the definition of the automatic scaling policy.

" } } }, "PutAutoScalingPolicyOutput":{ "type":"structure", "members":{ "ClusterId":{ "shape":"ClusterId", "documentation":"

Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.

" }, "InstanceGroupId":{ "shape":"InstanceGroupId", "documentation":"

Specifies the ID of the instance group to which the scaling policy is applied.

" }, "AutoScalingPolicy":{ "shape":"AutoScalingPolicyDescription", "documentation":"

The automatic scaling policy definition.

" } } }, "RemoveAutoScalingPolicyInput":{ "type":"structure", "required":[ "ClusterId", "InstanceGroupId" ], "members":{ "ClusterId":{ "shape":"ClusterId", "documentation":"

Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.

" }, "InstanceGroupId":{ "shape":"InstanceGroupId", "documentation":"

Specifies the ID of the instance group to which the scaling policy is applied.

" } } }, "RemoveAutoScalingPolicyOutput":{ "type":"structure", "members":{ } }, "RemoveTagsInput":{ "type":"structure", "required":[ "ResourceId", "TagKeys" ], "members":{ "ResourceId":{ "shape":"ResourceId", "documentation":"

The Amazon EMR resource identifier from which tags will be removed. This value must be a cluster identifier.

" }, "TagKeys":{ "shape":"StringList", "documentation":"

A list of tag keys to remove from a resource.

" } }, "documentation":"

This input identifies a cluster and a list of tags to remove.

" }, "RemoveTagsOutput":{ "type":"structure", "members":{ }, "documentation":"

This output indicates the result of removing tags from a resource.

" }, "ResourceId":{"type":"string"}, "RunJobFlowInput":{ "type":"structure", "required":[ "Name", "Instances" ], "members":{ "Name":{ "shape":"XmlStringMaxLen256", "documentation":"

The name of the job flow.

" }, "LogUri":{ "shape":"XmlString", "documentation":"

The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.

" }, "AdditionalInfo":{ "shape":"XmlString", "documentation":"

A JSON string for selecting additional features.

" }, "AmiVersion":{ "shape":"XmlStringMaxLen256", "documentation":"

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use ReleaseLabel.

The version of the Amazon Machine Image (AMI) to use when launching Amazon EC2 instances in the job flow. The following values are valid:

  • The version number of the AMI to use, for example, \"2.0.\"

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 JobFlowInstancesConfig HadoopVersion parameter to modify the version of Hadoop from the defaults shown above.

For details about the AMI versions currently supported by Amazon Elastic MapReduce, see AMI Versions Supported in Elastic MapReduce in the Amazon Elastic MapReduce Developer Guide.

Previously, the EMR AMI version API parameter options allowed you to use latest for the latest AMI version rather than specify a numerical value. Some regions no longer support this deprecated option as they only have a newer release label version of EMR, which requires you to specify an EMR release label release (EMR 4.x or later).

" }, "ReleaseLabel":{ "shape":"XmlStringMaxLen256", "documentation":"

Amazon EMR releases 4.x or later.

The release label for the Amazon EMR release. For Amazon EMR 3.x and 2.x AMIs, use amiVersion instead instead of ReleaseLabel.

" }, "Instances":{ "shape":"JobFlowInstancesConfig", "documentation":"

A specification of the number and type of Amazon EC2 instances on which to run the job flow.

" }, "Steps":{ "shape":"StepConfigList", "documentation":"

A list of steps to be executed by the job flow.

" }, "BootstrapActions":{ "shape":"BootstrapActionConfigList", "documentation":"

A list of bootstrap actions that will be run before Hadoop is started on the cluster nodes.

" }, "SupportedProducts":{ "shape":"SupportedProductsList", "documentation":"

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use Applications.

A list of strings that indicates third-party software to use with the job flow. For more information, see Use Third Party Applications with Amazon EMR. Currently supported values are:

  • \"mapr-m3\" - launch the job flow using MapR M3 Edition.

  • \"mapr-m5\" - launch the job flow using MapR M5 Edition.

" }, "NewSupportedProducts":{ "shape":"NewSupportedProductsList", "documentation":"

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and greater, use Applications.

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 script as bootstrap action arguments. For more information, see Launch a Job Flow on the MapR Distribution for Hadoop. Currently supported values are:

  • \"mapr-m3\" - launch the cluster using MapR M3 Edition.

  • \"mapr-m5\" - launch the cluster using MapR M5 Edition.

  • \"mapr\" with the user arguments specifying \"--edition,m3\" or \"--edition,m5\" - launch the job flow using MapR M3 or M5 Edition respectively.

  • \"mapr-m7\" - launch the cluster using MapR M7 Edition.

  • \"hunk\" - launch the cluster with the Hunk Big Data Analtics Platform.

  • \"hue\"- launch the cluster with Hue installed.

  • \"spark\" - launch the cluster with Apache Spark installed.

  • \"ganglia\" - launch the cluster with the Ganglia Monitoring System installed.

" }, "Applications":{ "shape":"ApplicationList", "documentation":"

Amazon EMR releases 4.x or later.

A list of applications for the cluster. Valid values are: \"Hadoop\", \"Hive\", \"Mahout\", \"Pig\", and \"Spark.\" They are case insensitive.

" }, "Configurations":{ "shape":"ConfigurationList", "documentation":"

Amazon EMR releases 4.x or later.

The list of configurations supplied for the EMR cluster you are creating.

" }, "VisibleToAllUsers":{ "shape":"Boolean", "documentation":"

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.

" }, "JobFlowRole":{ "shape":"XmlString", "documentation":"

Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole. In order to use the default role, you must have already created it using the CLI or console.

" }, "ServiceRole":{ "shape":"XmlString", "documentation":"

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

" }, "Tags":{ "shape":"TagList", "documentation":"

A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

" }, "SecurityConfiguration":{ "shape":"XmlString", "documentation":"

The name of a security configuration to apply to the cluster.

" }, "AutoScalingRole":{ "shape":"XmlString", "documentation":"

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

" }, "ScaleDownBehavior":{ "shape":"ScaleDownBehavior", "documentation":"

Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

" } }, "documentation":"

Input to the RunJobFlow operation.

" }, "RunJobFlowOutput":{ "type":"structure", "members":{ "JobFlowId":{ "shape":"XmlStringMaxLen256", "documentation":"

An unique identifier for the job flow.

" } }, "documentation":"

The result of the RunJobFlow operation.

" }, "ScaleDownBehavior":{ "type":"string", "enum":[ "TERMINATE_AT_INSTANCE_HOUR", "TERMINATE_AT_TASK_COMPLETION" ] }, "ScalingAction":{ "type":"structure", "required":["SimpleScalingPolicyConfiguration"], "members":{ "Market":{ "shape":"MarketType", "documentation":"

Not available for instance groups. Instance groups use the market type specified for the group.

" }, "SimpleScalingPolicyConfiguration":{ "shape":"SimpleScalingPolicyConfiguration", "documentation":"

The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.

" } }, "documentation":"

The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.

" }, "ScalingConstraints":{ "type":"structure", "required":[ "MinCapacity", "MaxCapacity" ], "members":{ "MinCapacity":{ "shape":"Integer", "documentation":"

The lower boundary of EC2 instances in an instance group below which scaling activities are not allowed to shrink. Scale-in activities will not terminate instances below this boundary.

" }, "MaxCapacity":{ "shape":"Integer", "documentation":"

The upper boundary of EC2 instances in an instance group beyond which scaling activities are not allowed to grow. Scale-out activities will not add instances beyond this boundary.

" } }, "documentation":"

The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activities triggered by automatic scaling rules will not cause an instance group to grow above or below these limits.

" }, "ScalingRule":{ "type":"structure", "required":[ "Name", "Action", "Trigger" ], "members":{ "Name":{ "shape":"String", "documentation":"

The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.

" }, "Description":{ "shape":"String", "documentation":"

A friendly, more verbose description of the automatic scaling rule.

" }, "Action":{ "shape":"ScalingAction", "documentation":"

The conditions that trigger an automatic scaling activity.

" }, "Trigger":{ "shape":"ScalingTrigger", "documentation":"

The CloudWatch alarm definition that determines when automatic scaling activity is triggered.

" } }, "documentation":"

A scale-in or scale-out rule that defines scaling activity, including the CloudWatch metric alarm that triggers activity, how EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules.

" }, "ScalingRuleList":{ "type":"list", "member":{"shape":"ScalingRule"} }, "ScalingTrigger":{ "type":"structure", "required":["CloudWatchAlarmDefinition"], "members":{ "CloudWatchAlarmDefinition":{ "shape":"CloudWatchAlarmDefinition", "documentation":"

The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger parameters, scaling activity begins.

" } }, "documentation":"

The conditions that trigger an automatic scaling activity.

" }, "ScriptBootstrapActionConfig":{ "type":"structure", "required":["Path"], "members":{ "Path":{ "shape":"XmlString", "documentation":"

Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system.

" }, "Args":{ "shape":"XmlStringList", "documentation":"

A list of command line arguments to pass to the bootstrap action script.

" } }, "documentation":"

Configuration of the script to run during a bootstrap action.

" }, "SecurityConfigurationList":{ "type":"list", "member":{"shape":"SecurityConfigurationSummary"} }, "SecurityConfigurationSummary":{ "type":"structure", "members":{ "Name":{ "shape":"XmlString", "documentation":"

The name of the security configuration.

" }, "CreationDateTime":{ "shape":"Date", "documentation":"

The date and time the security configuration was created.

" } }, "documentation":"

The creation date and time, and name, of a security configuration.

" }, "SecurityGroupsList":{ "type":"list", "member":{"shape":"XmlStringMaxLen256"} }, "SetTerminationProtectionInput":{ "type":"structure", "required":[ "JobFlowIds", "TerminationProtected" ], "members":{ "JobFlowIds":{ "shape":"XmlStringList", "documentation":"

A list of strings that uniquely identify the job flows to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .

" }, "TerminationProtected":{ "shape":"Boolean", "documentation":"

A Boolean that indicates whether to protect the job flow and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.

" } }, "documentation":"

The input argument to the TerminationProtection operation.

" }, "SetVisibleToAllUsersInput":{ "type":"structure", "required":[ "JobFlowIds", "VisibleToAllUsers" ], "members":{ "JobFlowIds":{ "shape":"XmlStringList", "documentation":"

Identifiers of the job flows to receive the new visibility setting.

" }, "VisibleToAllUsers":{ "shape":"Boolean", "documentation":"

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.

" } }, "documentation":"

The input to the SetVisibleToAllUsers action.

" }, "ShrinkPolicy":{ "type":"structure", "members":{ "DecommissionTimeout":{ "shape":"Integer", "documentation":"

The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout.

" }, "InstanceResizePolicy":{ "shape":"InstanceResizePolicy", "documentation":"

Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.

" } }, "documentation":"

Policy for customizing shrink operations. Allows configuration of decommissioning timeout and targeted instance shrinking.

" }, "SimpleScalingPolicyConfiguration":{ "type":"structure", "required":["ScalingAdjustment"], "members":{ "AdjustmentType":{ "shape":"AdjustmentType", "documentation":"

The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or terminated (if ScalingAdjustment is a negative number) each time the scaling activity is triggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2 instance count increments or decrements by ScalingAdjustment, which should be expressed as an integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage specified by ScalingAdjustment, which should be expressed as a decimal, for example, 0.20 indicates an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity results in an instance group with the number of EC2 instances specified by ScalingAdjustment, which should be expressed as a positive integer.

" }, "ScalingAdjustment":{ "shape":"Integer", "documentation":"

The amount by which to scale in or scale out, based on the specified AdjustmentType. A positive value adds to the instance group's EC2 instance count while a negative number removes instances. If AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive integer. If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the percentage as a decimal. For example, -0.20 indicates a decrease in 20% increments of cluster capacity.

" }, "CoolDown":{ "shape":"Integer", "documentation":"

The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start. The default value is 0.

" } }, "documentation":"

An automatic scaling configuration, which describes how the policy adds or removes instances, the cooldown period, and the number of EC2 instances that will be added each time the CloudWatch metric alarm condition is satisfied.

" }, "Statistic":{ "type":"string", "enum":[ "SAMPLE_COUNT", "AVERAGE", "SUM", "MINIMUM", "MAXIMUM" ] }, "Step":{ "type":"structure", "members":{ "Id":{ "shape":"StepId", "documentation":"

The identifier of the cluster step.

" }, "Name":{ "shape":"String", "documentation":"

The name of the cluster step.

" }, "Config":{ "shape":"HadoopStepConfig", "documentation":"

The Hadoop job configuration of the cluster step.

" }, "ActionOnFailure":{ "shape":"ActionOnFailure", "documentation":"

This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.

" }, "Status":{ "shape":"StepStatus", "documentation":"

The current execution status details of the cluster step.

" } }, "documentation":"

This represents a step in a cluster.

" }, "StepConfig":{ "type":"structure", "required":[ "Name", "HadoopJarStep" ], "members":{ "Name":{ "shape":"XmlStringMaxLen256", "documentation":"

The name of the job flow step.

" }, "ActionOnFailure":{ "shape":"ActionOnFailure", "documentation":"

The action to take if the job flow step fails.

" }, "HadoopJarStep":{ "shape":"HadoopJarStepConfig", "documentation":"

The JAR file used for the job flow step.

" } }, "documentation":"

Specification of a job flow step.

" }, "StepConfigList":{ "type":"list", "member":{"shape":"StepConfig"} }, "StepDetail":{ "type":"structure", "required":[ "StepConfig", "ExecutionStatusDetail" ], "members":{ "StepConfig":{ "shape":"StepConfig", "documentation":"

The step configuration.

" }, "ExecutionStatusDetail":{ "shape":"StepExecutionStatusDetail", "documentation":"

The description of the step status.

" } }, "documentation":"

Combines the execution state and configuration of a step.

" }, "StepDetailList":{ "type":"list", "member":{"shape":"StepDetail"} }, "StepExecutionState":{ "type":"string", "enum":[ "PENDING", "RUNNING", "CONTINUE", "COMPLETED", "CANCELLED", "FAILED", "INTERRUPTED" ] }, "StepExecutionStatusDetail":{ "type":"structure", "required":[ "State", "CreationDateTime" ], "members":{ "State":{ "shape":"StepExecutionState", "documentation":"

The state of the job flow step.

" }, "CreationDateTime":{ "shape":"Date", "documentation":"

The creation date and time of the step.

" }, "StartDateTime":{ "shape":"Date", "documentation":"

The start date and time of the step.

" }, "EndDateTime":{ "shape":"Date", "documentation":"

The completion date and time of the step.

" }, "LastStateChangeReason":{ "shape":"XmlString", "documentation":"

A description of the step's current state.

" } }, "documentation":"

The execution state of a step.

" }, "StepId":{"type":"string"}, "StepIdsList":{ "type":"list", "member":{"shape":"XmlStringMaxLen256"} }, "StepState":{ "type":"string", "enum":[ "PENDING", "CANCEL_PENDING", "RUNNING", "COMPLETED", "CANCELLED", "FAILED", "INTERRUPTED" ] }, "StepStateChangeReason":{ "type":"structure", "members":{ "Code":{ "shape":"StepStateChangeReasonCode", "documentation":"

The programmable code for the state change reason. Note: Currently, the service provides no code for the state change.

" }, "Message":{ "shape":"String", "documentation":"

The descriptive message for the state change reason.

" } }, "documentation":"

The details of the step state change reason.

" }, "StepStateChangeReasonCode":{ "type":"string", "enum":["NONE"] }, "StepStateList":{ "type":"list", "member":{"shape":"StepState"} }, "StepStatus":{ "type":"structure", "members":{ "State":{ "shape":"StepState", "documentation":"

The execution state of the cluster step.

" }, "StateChangeReason":{ "shape":"StepStateChangeReason", "documentation":"

The reason for the step execution status change.

" }, "FailureDetails":{ "shape":"FailureDetails", "documentation":"

The details for the step failure including reason, message, and log file path where the root cause was identified.

" }, "Timeline":{ "shape":"StepTimeline", "documentation":"

The timeline of the cluster step status over time.

" } }, "documentation":"

The execution status details of the cluster step.

" }, "StepSummary":{ "type":"structure", "members":{ "Id":{ "shape":"StepId", "documentation":"

The identifier of the cluster step.

" }, "Name":{ "shape":"String", "documentation":"

The name of the cluster step.

" }, "Config":{ "shape":"HadoopStepConfig", "documentation":"

The Hadoop job configuration of the cluster step.

" }, "ActionOnFailure":{ "shape":"ActionOnFailure", "documentation":"

This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.

" }, "Status":{ "shape":"StepStatus", "documentation":"

The current execution status details of the cluster step.

" } }, "documentation":"

The summary of the cluster step.

" }, "StepSummaryList":{ "type":"list", "member":{"shape":"StepSummary"} }, "StepTimeline":{ "type":"structure", "members":{ "CreationDateTime":{ "shape":"Date", "documentation":"

The date and time when the cluster step was created.

" }, "StartDateTime":{ "shape":"Date", "documentation":"

The date and time when the cluster step execution started.

" }, "EndDateTime":{ "shape":"Date", "documentation":"

The date and time when the cluster step execution completed or failed.

" } }, "documentation":"

The timeline of the cluster step lifecycle.

" }, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{"shape":"String"} }, "StringMap":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "SupportedProductConfig":{ "type":"structure", "members":{ "Name":{ "shape":"XmlStringMaxLen256", "documentation":"

The name of the product configuration.

" }, "Args":{ "shape":"XmlStringList", "documentation":"

The list of user-supplied arguments.

" } }, "documentation":"

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.

" }, "SupportedProductsList":{ "type":"list", "member":{"shape":"XmlStringMaxLen256"} }, "Tag":{ "type":"structure", "members":{ "Key":{ "shape":"String", "documentation":"

A user-defined key, which is the minimum required information for a valid tag. For more information, see Tagging Amazon EMR Resources.

" }, "Value":{ "shape":"String", "documentation":"

A user-defined value, which is optional in a tag. For more information, see Tagging Amazon EMR Resources.

" } }, "documentation":"

A key/value pair containing 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. For more information, see Tagging Amazon EMR Resources.

" }, "TagList":{ "type":"list", "member":{"shape":"Tag"} }, "TerminateJobFlowsInput":{ "type":"structure", "required":["JobFlowIds"], "members":{ "JobFlowIds":{ "shape":"XmlStringList", "documentation":"

A list of job flows to be shutdown.

" } }, "documentation":"

Input to the TerminateJobFlows operation.

" }, "Unit":{ "type":"string", "enum":[ "NONE", "SECONDS", "MICRO_SECONDS", "MILLI_SECONDS", "BYTES", "KILO_BYTES", "MEGA_BYTES", "GIGA_BYTES", "TERA_BYTES", "BITS", "KILO_BITS", "MEGA_BITS", "GIGA_BITS", "TERA_BITS", "PERCENT", "COUNT", "BYTES_PER_SECOND", "KILO_BYTES_PER_SECOND", "MEGA_BYTES_PER_SECOND", "GIGA_BYTES_PER_SECOND", "TERA_BYTES_PER_SECOND", "BITS_PER_SECOND", "KILO_BITS_PER_SECOND", "MEGA_BITS_PER_SECOND", "GIGA_BITS_PER_SECOND", "TERA_BITS_PER_SECOND", "COUNT_PER_SECOND" ] }, "VolumeSpecification":{ "type":"structure", "required":[ "VolumeType", "SizeInGB" ], "members":{ "VolumeType":{ "shape":"String", "documentation":"

The volume type. Volume types supported are gp2, io1, standard.

" }, "Iops":{ "shape":"Integer", "documentation":"

The number of I/O operations per second (IOPS) that the volume supports.

" }, "SizeInGB":{ "shape":"Integer", "documentation":"

The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.

" } }, "documentation":"

EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.

" }, "XmlString":{ "type":"string", "max":10280, "min":0, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" }, "XmlStringList":{ "type":"list", "member":{"shape":"XmlString"} }, "XmlStringMaxLen256":{ "type":"string", "max":256, "min":0, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" } }, "documentation":"

Amazon EMR is a web service that makes it easy to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several AWS products to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehousing.

" } botocore-1.5.7/botocore/data/efs/0000777454262600001440000000000013042511307017710 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/efs/2015-02-01/0000777454262600001440000000000013042511307020734 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/efs/2015-02-01/service-2.json0000666454262600001440000013622013042511306023431 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-02-01", "endpointPrefix":"elasticfilesystem", "protocol":"rest-json", "serviceAbbreviation":"EFS", "serviceFullName":"Amazon Elastic File System", "signatureVersion":"v4", "uid":"elasticfilesystem-2015-02-01" }, "operations":{ "CreateFileSystem":{ "name":"CreateFileSystem", "http":{ "method":"POST", "requestUri":"/2015-02-01/file-systems", "responseCode":201 }, "input":{"shape":"CreateFileSystemRequest"}, "output":{"shape":"FileSystemDescription"}, "errors":[ {"shape":"BadRequest"}, {"shape":"InternalServerError"}, {"shape":"FileSystemAlreadyExists"}, {"shape":"FileSystemLimitExceeded"} ], "documentation":"

Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:

  • Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

  • Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

For basic use cases, you can use a randomly generated UUID for the creation token.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.

This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS: Performance Modes.

After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see Amazon EFS: How it Works.

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

" }, "CreateMountTarget":{ "name":"CreateMountTarget", "http":{ "method":"POST", "requestUri":"/2015-02-01/mount-targets", "responseCode":200 }, "input":{"shape":"CreateMountTargetRequest"}, "output":{"shape":"MountTargetDescription"}, "errors":[ {"shape":"BadRequest"}, {"shape":"InternalServerError"}, {"shape":"FileSystemNotFound"}, {"shape":"IncorrectFileSystemLifeCycleState"}, {"shape":"MountTargetConflict"}, {"shape":"SubnetNotFound"}, {"shape":"NoFreeAddressesInSubnet"}, {"shape":"IpAddressInUse"}, {"shape":"NetworkInterfaceLimitExceeded"}, {"shape":"SecurityGroupLimitExceeded"}, {"shape":"SecurityGroupNotFound"}, {"shape":"UnsupportedAvailabilityZone"} ], "documentation":"

Creates a mount target for a file system. You can then mount the file system on EC2 instances via the mount target.

You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see Amazon EFS: How it Works.

In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be available. For more information, see DescribeFileSystems.

In the request, you also provide a subnet ID, which determines the following:

  • VPC in which Amazon EFS creates the mount target

  • Availability Zone in which Amazon EFS creates the mount target

  • IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request)

After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system via the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview.

Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements:

  • Must belong to the same VPC as the subnets of the existing mount targets

  • Must not be in the same Availability Zone as any of the subnets of the existing mount targets

If the request satisfies the requirements, Amazon EFS does the following:

  • Creates a new mount target in the specified subnet.

  • Also creates a new network interface in the subnet as follows:

    • If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address).

    • If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.

    • Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId.

    • Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS.

    Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails.

The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating, you can check the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount target state.

We recommend you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you won't be able to access your file system through that mount target.

This operation requires permissions for the following action on the file system:

  • elasticfilesystem:CreateMountTarget

This operation also requires permissions for the following Amazon EC2 actions:

  • ec2:DescribeSubnets

  • ec2:DescribeNetworkInterfaces

  • ec2:CreateNetworkInterface

" }, "CreateTags":{ "name":"CreateTags", "http":{ "method":"POST", "requestUri":"/2015-02-01/create-tags/{FileSystemId}", "responseCode":204 }, "input":{"shape":"CreateTagsRequest"}, "errors":[ {"shape":"BadRequest"}, {"shape":"InternalServerError"}, {"shape":"FileSystemNotFound"} ], "documentation":"

Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the Name tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation.

This operation requires permission for the elasticfilesystem:CreateTags action.

" }, "DeleteFileSystem":{ "name":"DeleteFileSystem", "http":{ "method":"DELETE", "requestUri":"/2015-02-01/file-systems/{FileSystemId}", "responseCode":204 }, "input":{"shape":"DeleteFileSystemRequest"}, "errors":[ {"shape":"BadRequest"}, {"shape":"InternalServerError"}, {"shape":"FileSystemNotFound"}, {"shape":"FileSystemInUse"} ], "documentation":"

Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system.

You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.

The DeleteFileSystem call returns while the file system state is still deleting. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound error.

This operation requires permissions for the elasticfilesystem:DeleteFileSystem action.

" }, "DeleteMountTarget":{ "name":"DeleteMountTarget", "http":{ "method":"DELETE", "requestUri":"/2015-02-01/mount-targets/{MountTargetId}", "responseCode":204 }, "input":{"shape":"DeleteMountTargetRequest"}, "errors":[ {"shape":"BadRequest"}, {"shape":"InternalServerError"}, {"shape":"DependencyTimeout"}, {"shape":"MountTargetNotFound"} ], "documentation":"

Deletes the specified mount target.

This operation forcibly breaks any mounts of the file system via the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC via another mount target.

This operation requires permissions for the following action on the file system:

  • elasticfilesystem:DeleteMountTarget

The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system.

The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:

  • ec2:DeleteNetworkInterface

" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/2015-02-01/delete-tags/{FileSystemId}", "responseCode":204 }, "input":{"shape":"DeleteTagsRequest"}, "errors":[ {"shape":"BadRequest"}, {"shape":"InternalServerError"}, {"shape":"FileSystemNotFound"} ], "documentation":"

Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that does not exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag Restrictions in the AWS Billing and Cost Management User Guide.

This operation requires permissions for the elasticfilesystem:DeleteTags action.

" }, "DescribeFileSystems":{ "name":"DescribeFileSystems", "http":{ "method":"GET", "requestUri":"/2015-02-01/file-systems", "responseCode":200 }, "input":{"shape":"DescribeFileSystemsRequest"}, "output":{"shape":"DescribeFileSystemsResponse"}, "errors":[ {"shape":"BadRequest"}, {"shape":"InternalServerError"}, {"shape":"FileSystemNotFound"} ], "documentation":"

Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker.

To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker.

The implementation may return fewer than MaxItems file system descriptions while still including a NextMarker value.

The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multi-call iteration is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.

" }, "DescribeMountTargetSecurityGroups":{ "name":"DescribeMountTargetSecurityGroups", "http":{ "method":"GET", "requestUri":"/2015-02-01/mount-targets/{MountTargetId}/security-groups", "responseCode":200 }, "input":{"shape":"DescribeMountTargetSecurityGroupsRequest"}, "output":{"shape":"DescribeMountTargetSecurityGroupsResponse"}, "errors":[ {"shape":"BadRequest"}, {"shape":"InternalServerError"}, {"shape":"MountTargetNotFound"}, {"shape":"IncorrectMountTargetState"} ], "documentation":"

Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted.

This operation requires permissions for the following actions:

  • elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount target's file system.

  • ec2:DescribeNetworkInterfaceAttribute action on the mount target's network interface.

" }, "DescribeMountTargets":{ "name":"DescribeMountTargets", "http":{ "method":"GET", "requestUri":"/2015-02-01/mount-targets", "responseCode":200 }, "input":{"shape":"DescribeMountTargetsRequest"}, "output":{"shape":"DescribeMountTargetsResponse"}, "errors":[ {"shape":"BadRequest"}, {"shape":"InternalServerError"}, {"shape":"FileSystemNotFound"}, {"shape":"MountTargetNotFound"} ], "documentation":"

Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeMountTargets action, on either the file system ID that you specify in FileSystemId, or on the file system of the mount target that you specify in MountTargetId.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"GET", "requestUri":"/2015-02-01/tags/{FileSystemId}/", "responseCode":200 }, "input":{"shape":"DescribeTagsRequest"}, "output":{"shape":"DescribeTagsResponse"}, "errors":[ {"shape":"BadRequest"}, {"shape":"InternalServerError"}, {"shape":"FileSystemNotFound"} ], "documentation":"

Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call and the order of tags returned across the responses of a multi-call iteration (when using pagination) is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeTags action.

" }, "ModifyMountTargetSecurityGroups":{ "name":"ModifyMountTargetSecurityGroups", "http":{ "method":"PUT", "requestUri":"/2015-02-01/mount-targets/{MountTargetId}/security-groups", "responseCode":204 }, "input":{"shape":"ModifyMountTargetSecurityGroupsRequest"}, "errors":[ {"shape":"BadRequest"}, {"shape":"InternalServerError"}, {"shape":"MountTargetNotFound"}, {"shape":"IncorrectMountTargetState"}, {"shape":"SecurityGroupLimitExceeded"}, {"shape":"SecurityGroupNotFound"} ], "documentation":"

Modifies the set of security groups in effect for a mount target.

When you create a mount target, Amazon EFS also creates a new network interface. For more information, see CreateMountTarget. This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted.

The operation requires permissions for the following actions:

  • elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount target's file system.

  • ec2:ModifyNetworkInterfaceAttribute action on the mount target's network interface.

" } }, "shapes":{ "AwsAccountId":{"type":"string"}, "BadRequest":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

", "error":{"httpStatusCode":400}, "exception":true }, "CreateFileSystemRequest":{ "type":"structure", "required":["CreationToken"], "members":{ "CreationToken":{ "shape":"CreationToken", "documentation":"

String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

" }, "PerformanceMode":{ "shape":"PerformanceMode", "documentation":"

The PerformanceMode of the file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. This can't be changed after the file system has been created.

" } } }, "CreateMountTargetRequest":{ "type":"structure", "required":[ "FileSystemId", "SubnetId" ], "members":{ "FileSystemId":{ "shape":"FileSystemId", "documentation":"

ID of the file system for which to create the mount target.

" }, "SubnetId":{ "shape":"SubnetId", "documentation":"

ID of the subnet to add the mount target in.

" }, "IpAddress":{ "shape":"IpAddress", "documentation":"

Valid IPv4 address within the address range of the specified subnet.

" }, "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be for the same VPC as subnet specified.

" } }, "documentation":"

" }, "CreateTagsRequest":{ "type":"structure", "required":[ "FileSystemId", "Tags" ], "members":{ "FileSystemId":{ "shape":"FileSystemId", "documentation":"

ID of the file system whose tags you want to modify (String). This operation modifies the tags only, not the file system.

", "location":"uri", "locationName":"FileSystemId" }, "Tags":{ "shape":"Tags", "documentation":"

Array of Tag objects to add. Each Tag object is a key-value pair.

" } }, "documentation":"

" }, "CreationToken":{ "type":"string", "max":64, "min":1 }, "DeleteFileSystemRequest":{ "type":"structure", "required":["FileSystemId"], "members":{ "FileSystemId":{ "shape":"FileSystemId", "documentation":"

ID of the file system you want to delete.

", "location":"uri", "locationName":"FileSystemId" } }, "documentation":"

" }, "DeleteMountTargetRequest":{ "type":"structure", "required":["MountTargetId"], "members":{ "MountTargetId":{ "shape":"MountTargetId", "documentation":"

ID of the mount target to delete (String).

", "location":"uri", "locationName":"MountTargetId" } }, "documentation":"

" }, "DeleteTagsRequest":{ "type":"structure", "required":[ "FileSystemId", "TagKeys" ], "members":{ "FileSystemId":{ "shape":"FileSystemId", "documentation":"

ID of the file system whose tags you want to delete (String).

", "location":"uri", "locationName":"FileSystemId" }, "TagKeys":{ "shape":"TagKeys", "documentation":"

List of tag keys to delete.

" } }, "documentation":"

" }, "DependencyTimeout":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

The service timed out trying to fulfill the request, and the client should try the call again.

", "error":{"httpStatusCode":504}, "exception":true }, "DescribeFileSystemsRequest":{ "type":"structure", "members":{ "MaxItems":{ "shape":"MaxItems", "documentation":"

(Optional) Specifies the maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon EFS returns is the minimum of the MaxItems parameter specified in the request and the service's internal maximum number of items per page.

", "location":"querystring", "locationName":"MaxItems" }, "Marker":{ "shape":"Marker", "documentation":"

(Optional) Opaque pagination token returned from a previous DescribeFileSystems operation (String). If present, specifies to continue the list from where the returning call had left off.

", "location":"querystring", "locationName":"Marker" }, "CreationToken":{ "shape":"CreationToken", "documentation":"

(Optional) Restricts the list to the file system with this creation token (String). You specify a creation token when you create an Amazon EFS file system.

", "location":"querystring", "locationName":"CreationToken" }, "FileSystemId":{ "shape":"FileSystemId", "documentation":"

(Optional) ID of the file system whose description you want to retrieve (String).

", "location":"querystring", "locationName":"FileSystemId" } }, "documentation":"

" }, "DescribeFileSystemsResponse":{ "type":"structure", "members":{ "Marker":{ "shape":"Marker", "documentation":"

Present if provided by caller in the request (String).

" }, "FileSystems":{ "shape":"FileSystemDescriptions", "documentation":"

Array of file system descriptions.

" }, "NextMarker":{ "shape":"Marker", "documentation":"

Present if there are more file systems than returned in the response (String). You can use the NextMarker in the subsequent request to fetch the descriptions.

" } } }, "DescribeMountTargetSecurityGroupsRequest":{ "type":"structure", "required":["MountTargetId"], "members":{ "MountTargetId":{ "shape":"MountTargetId", "documentation":"

ID of the mount target whose security groups you want to retrieve.

", "location":"uri", "locationName":"MountTargetId" } }, "documentation":"

" }, "DescribeMountTargetSecurityGroupsResponse":{ "type":"structure", "required":["SecurityGroups"], "members":{ "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

Array of security groups.

" } } }, "DescribeMountTargetsRequest":{ "type":"structure", "members":{ "MaxItems":{ "shape":"MaxItems", "documentation":"

(Optional) Maximum number of mount targets to return in the response. It must be an integer with a value greater than zero.

", "location":"querystring", "locationName":"MaxItems" }, "Marker":{ "shape":"Marker", "documentation":"

(Optional) Opaque pagination token returned from a previous DescribeMountTargets operation (String). If present, it specifies to continue the list from where the previous returning call left off.

", "location":"querystring", "locationName":"Marker" }, "FileSystemId":{ "shape":"FileSystemId", "documentation":"

(Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if MountTargetId is not included.

", "location":"querystring", "locationName":"FileSystemId" }, "MountTargetId":{ "shape":"MountTargetId", "documentation":"

(Optional) ID of the mount target that you want to have described (String). It must be included in your request if FileSystemId is not included.

", "location":"querystring", "locationName":"MountTargetId" } }, "documentation":"

" }, "DescribeMountTargetsResponse":{ "type":"structure", "members":{ "Marker":{ "shape":"Marker", "documentation":"

If the request included the Marker, the response returns that value in this field.

" }, "MountTargets":{ "shape":"MountTargetDescriptions", "documentation":"

Returns the file system's mount targets as an array of MountTargetDescription objects.

" }, "NextMarker":{ "shape":"Marker", "documentation":"

If a value is present, there are more mount targets to return. In a subsequent request, you can provide Marker in your request with this value to retrieve the next set of mount targets.

" } }, "documentation":"

" }, "DescribeTagsRequest":{ "type":"structure", "required":["FileSystemId"], "members":{ "MaxItems":{ "shape":"MaxItems", "documentation":"

(Optional) Maximum number of file system tags to return in the response. It must be an integer with a value greater than zero.

", "location":"querystring", "locationName":"MaxItems" }, "Marker":{ "shape":"Marker", "documentation":"

(Optional) Opaque pagination token returned from a previous DescribeTags operation (String). If present, it specifies to continue the list from where the previous call left off.

", "location":"querystring", "locationName":"Marker" }, "FileSystemId":{ "shape":"FileSystemId", "documentation":"

ID of the file system whose tag set you want to retrieve.

", "location":"uri", "locationName":"FileSystemId" } }, "documentation":"

" }, "DescribeTagsResponse":{ "type":"structure", "required":["Tags"], "members":{ "Marker":{ "shape":"Marker", "documentation":"

If the request included a Marker, the response returns that value in this field.

" }, "Tags":{ "shape":"Tags", "documentation":"

Returns tags associated with the file system as an array of Tag objects.

" }, "NextMarker":{ "shape":"Marker", "documentation":"

If a value is present, there are more tags to return. In a subsequent request, you can provide the value of NextMarker as the value of the Marker parameter in your next request to retrieve the next set of tags.

" } }, "documentation":"

" }, "ErrorCode":{ "type":"string", "min":1 }, "ErrorMessage":{"type":"string"}, "FileSystemAlreadyExists":{ "type":"structure", "required":[ "ErrorCode", "FileSystemId" ], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"}, "FileSystemId":{"shape":"FileSystemId"} }, "documentation":"

Returned if the file system you are trying to create already exists, with the creation token you provided.

", "error":{"httpStatusCode":409}, "exception":true }, "FileSystemDescription":{ "type":"structure", "required":[ "OwnerId", "CreationToken", "FileSystemId", "CreationTime", "LifeCycleState", "NumberOfMountTargets", "SizeInBytes", "PerformanceMode" ], "members":{ "OwnerId":{ "shape":"AwsAccountId", "documentation":"

AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.

" }, "CreationToken":{ "shape":"CreationToken", "documentation":"

Opaque string specified in the request.

" }, "FileSystemId":{ "shape":"FileSystemId", "documentation":"

ID of the file system, assigned by Amazon EFS.

" }, "CreationTime":{ "shape":"Timestamp", "documentation":"

Time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).

" }, "LifeCycleState":{ "shape":"LifeCycleState", "documentation":"

Lifecycle phase of the file system.

" }, "Name":{ "shape":"TagValue", "documentation":"

You can add tags to a file system, including a Name tag. For more information, see CreateTags. If the file system has a Name tag, Amazon EFS returns the value in this field.

" }, "NumberOfMountTargets":{ "shape":"MountTargetCount", "documentation":"

Current number of mount targets that the file system has. For more information, see CreateMountTarget.

" }, "SizeInBytes":{ "shape":"FileSystemSize", "documentation":"

Latest known metered size (in bytes) of data stored in the file system, in bytes, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size the file system was at any instant in time.

" }, "PerformanceMode":{ "shape":"PerformanceMode", "documentation":"

The PerformanceMode of the file system.

" } }, "documentation":"

Description of the file system.

" }, "FileSystemDescriptions":{ "type":"list", "member":{"shape":"FileSystemDescription"} }, "FileSystemId":{"type":"string"}, "FileSystemInUse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

Returned if a file system has mount targets.

", "error":{"httpStatusCode":409}, "exception":true }, "FileSystemLimitExceeded":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

Returned if the AWS account has already created maximum number of file systems allowed per account.

", "error":{"httpStatusCode":403}, "exception":true }, "FileSystemNotFound":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

Returned if the specified FileSystemId does not exist in the requester's AWS account.

", "error":{"httpStatusCode":404}, "exception":true }, "FileSystemSize":{ "type":"structure", "required":["Value"], "members":{ "Value":{ "shape":"FileSystemSizeValue", "documentation":"

Latest known metered size (in bytes) of data stored in the file system.

" }, "Timestamp":{ "shape":"Timestamp", "documentation":"

Time at which the size of data, returned in the Value field, was determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z.

" } }, "documentation":"

Latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. Note that the value does not represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value will represent the actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not necessarily the exact size the file system was at any instant in time.

" }, "FileSystemSizeValue":{ "type":"long", "min":0 }, "IncorrectFileSystemLifeCycleState":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

Returned if the file system's life cycle state is not \"created\".

", "error":{"httpStatusCode":409}, "exception":true }, "IncorrectMountTargetState":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

Returned if the mount target is not in the correct state for the operation.

", "error":{"httpStatusCode":409}, "exception":true }, "InternalServerError":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

Returned if an error occurred on the server side.

", "error":{"httpStatusCode":500}, "exception":true }, "IpAddress":{"type":"string"}, "IpAddressInUse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

Returned if the request specified an IpAddress that is already in use in the subnet.

", "error":{"httpStatusCode":409}, "exception":true }, "LifeCycleState":{ "type":"string", "enum":[ "creating", "available", "deleting", "deleted" ] }, "Marker":{"type":"string"}, "MaxItems":{ "type":"integer", "min":1 }, "ModifyMountTargetSecurityGroupsRequest":{ "type":"structure", "required":["MountTargetId"], "members":{ "MountTargetId":{ "shape":"MountTargetId", "documentation":"

ID of the mount target whose security groups you want to modify.

", "location":"uri", "locationName":"MountTargetId" }, "SecurityGroups":{ "shape":"SecurityGroups", "documentation":"

Array of up to five VPC security group IDs.

" } }, "documentation":"

" }, "MountTargetConflict":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.

", "error":{"httpStatusCode":409}, "exception":true }, "MountTargetCount":{ "type":"integer", "min":0 }, "MountTargetDescription":{ "type":"structure", "required":[ "MountTargetId", "FileSystemId", "SubnetId", "LifeCycleState" ], "members":{ "OwnerId":{ "shape":"AwsAccountId", "documentation":"

AWS account ID that owns the resource.

" }, "MountTargetId":{ "shape":"MountTargetId", "documentation":"

System-assigned mount target ID.

" }, "FileSystemId":{ "shape":"FileSystemId", "documentation":"

ID of the file system for which the mount target is intended.

" }, "SubnetId":{ "shape":"SubnetId", "documentation":"

ID of the mount target's subnet.

" }, "LifeCycleState":{ "shape":"LifeCycleState", "documentation":"

Lifecycle state of the mount target.

" }, "IpAddress":{ "shape":"IpAddress", "documentation":"

Address at which the file system may be mounted via the mount target.

" }, "NetworkInterfaceId":{ "shape":"NetworkInterfaceId", "documentation":"

ID of the network interface that Amazon EFS created when it created the mount target.

" } }, "documentation":"

Provides a description of a mount target.

" }, "MountTargetDescriptions":{ "type":"list", "member":{"shape":"MountTargetDescription"} }, "MountTargetId":{"type":"string"}, "MountTargetNotFound":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

Returned if there is no mount target with the specified ID found in the caller's account.

", "error":{"httpStatusCode":404}, "exception":true }, "NetworkInterfaceId":{"type":"string"}, "NetworkInterfaceLimitExceeded":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

The calling account has reached the ENI limit for the specific AWS region. Client should try to delete some ENIs or get its account limit raised. For more information, see Amazon VPC Limits in the Amazon Virtual Private Cloud User Guide (see the Network interfaces per VPC entry in the table).

", "error":{"httpStatusCode":409}, "exception":true }, "NoFreeAddressesInSubnet":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

Returned if IpAddress was not specified in the request and there are no free IP addresses in the subnet.

", "error":{"httpStatusCode":409}, "exception":true }, "PerformanceMode":{ "type":"string", "enum":[ "generalPurpose", "maxIO" ] }, "SecurityGroup":{"type":"string"}, "SecurityGroupLimitExceeded":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

Returned if the size of SecurityGroups specified in the request is greater than five.

", "error":{"httpStatusCode":400}, "exception":true }, "SecurityGroupNotFound":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

Returned if one of the specified security groups does not exist in the subnet's VPC.

", "error":{"httpStatusCode":400}, "exception":true }, "SecurityGroups":{ "type":"list", "member":{"shape":"SecurityGroup"}, "max":5 }, "SubnetId":{"type":"string"}, "SubnetNotFound":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

Returned if there is no subnet with ID SubnetId provided in the request.

", "error":{"httpStatusCode":400}, "exception":true }, "Tag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"TagKey", "documentation":"

Tag key (String). The key can't start with aws:.

" }, "Value":{ "shape":"TagValue", "documentation":"

Value of the tag key.

" } }, "documentation":"

A tag is a key-value pair. Allowed characters: letters, whitespace, and numbers, representable in UTF-8, and the following characters: + - = . _ : /

" }, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"} }, "TagValue":{ "type":"string", "max":256 }, "Tags":{ "type":"list", "member":{"shape":"Tag"} }, "Timestamp":{"type":"timestamp"}, "UnsupportedAvailabilityZone":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{"shape":"ErrorCode"}, "Message":{"shape":"ErrorMessage"} }, "documentation":"

", "error":{"httpStatusCode":400}, "exception":true } }, "documentation":"Amazon Elastic File System

Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 instances in the AWS Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so your applications have the storage they need, when they need it. For more information, see the User Guide.

" } botocore-1.5.7/botocore/data/sts/0000777454262600001440000000000013042511307017744 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/sts/2011-06-15/0000777454262600001440000000000013042511307020775 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/sts/2011-06-15/service-2.json0000666454262600001440000022426413042511306023500 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2011-06-15", "endpointPrefix":"sts", "globalEndpoint":"sts.amazonaws.com", "protocol":"query", "serviceAbbreviation":"AWS STS", "serviceFullName":"AWS Security Token Service", "signatureVersion":"v4", "uid":"sts-2011-06-15", "xmlNamespace":"https://sts.amazonaws.com/doc/2011-06-15/" }, "operations":{ "AssumeRole":{ "name":"AssumeRole", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssumeRoleRequest"}, "output":{ "shape":"AssumeRoleResponse", "resultWrapper":"AssumeRoleResult" }, "errors":[ {"shape":"MalformedPolicyDocumentException"}, {"shape":"PackedPolicyTooLargeException"}, {"shape":"RegionDisabledException"} ], "documentation":"

Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) that you can use to access AWS resources that you might not normally have access to. Typically, you use AssumeRole for cross-account access or federation. For a comparison of AssumeRole with the other APIs that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS APIs in the IAM User Guide.

Important: You cannot call AssumeRole by using AWS root account credentials; access is denied. You must use credentials for an IAM user or an IAM role to call AssumeRole.

For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see IAM Roles (Delegation and Federation) in the IAM User Guide.

For federation, you can, for example, grant single sign-on access to the AWS Management Console. If you already have an identity and authentication system in your corporate network, you don't have to recreate user identities in AWS in order to grant those user identities access to AWS. Instead, after a user has been authenticated, you call AssumeRole (and specify the role with the appropriate permissions) to get temporary security credentials for that user. With those temporary security credentials, you construct a sign-in URL that users can use to access the console. For more information, see Common Scenarios for Temporary Credentials in the IAM User Guide.

The temporary security credentials are valid for the duration that you specified when calling AssumeRole, which can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour.

The temporary security credentials created by AssumeRole can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's GetFederationToken or GetSessionToken APIs.

Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.

To assume a role, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate access to this account's role.

The user who wants to access the role must also have permissions delegated from the role's administrator. If the user is in a different account than the role, then the user's administrator must attach a policy that allows the user to call AssumeRole on the ARN of the role in the other account. If the user is in the same account as the role, then you can either attach a policy to the user (identical to the previous different account user), or you can add the user as a principal directly in the role's trust policy

Using MFA with AssumeRole

You can optionally include multi-factor authentication (MFA) information when you call AssumeRole. This is useful for cross-account scenarios in which you want to make sure that the user who is assuming the role has been authenticated using an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication; if the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example.

\"Condition\": {\"Bool\": {\"aws:MultiFactorAuthPresent\": true}}

For more information, see Configuring MFA-Protected API Access in the IAM User Guide guide.

To use MFA with AssumeRole, you pass values for the SerialNumber and TokenCode parameters. The SerialNumber value identifies the user's hardware or virtual MFA device. The TokenCode is the time-based one-time password (TOTP) that the MFA devices produces.

" }, "AssumeRoleWithSAML":{ "name":"AssumeRoleWithSAML", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssumeRoleWithSAMLRequest"}, "output":{ "shape":"AssumeRoleWithSAMLResponse", "resultWrapper":"AssumeRoleWithSAMLResult" }, "errors":[ {"shape":"MalformedPolicyDocumentException"}, {"shape":"PackedPolicyTooLargeException"}, {"shape":"IDPRejectedClaimException"}, {"shape":"InvalidIdentityTokenException"}, {"shape":"ExpiredTokenException"}, {"shape":"RegionDisabledException"} ], "documentation":"

Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. For a comparison of AssumeRoleWithSAML with the other APIs that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS APIs in the IAM User Guide.

The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services.

The temporary security credentials are valid for the duration that you specified when calling AssumeRole, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. The duration can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour.

The temporary security credentials created by AssumeRoleWithSAML can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's GetFederationToken or GetSessionToken APIs.

Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by the intersection of both the access policy of the role that is being assumed, and the policy that you pass. This means that both policies must grant the permission for the action to be allowed. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.

Before your application can call AssumeRoleWithSAML, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider, and create an IAM role that specifies this SAML provider in its trust policy.

Calling AssumeRoleWithSAML does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider.

Calling AssumeRoleWithSAML can result in an entry in your AWS CloudTrail logs. The entry includes the value in the NameID element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the Persistent Identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).

For more information, see the following resources:

" }, "AssumeRoleWithWebIdentity":{ "name":"AssumeRoleWithWebIdentity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssumeRoleWithWebIdentityRequest"}, "output":{ "shape":"AssumeRoleWithWebIdentityResponse", "resultWrapper":"AssumeRoleWithWebIdentityResult" }, "errors":[ {"shape":"MalformedPolicyDocumentException"}, {"shape":"PackedPolicyTooLargeException"}, {"shape":"IDPRejectedClaimException"}, {"shape":"IDPCommunicationErrorException"}, {"shape":"InvalidIdentityTokenException"}, {"shape":"ExpiredTokenException"}, {"shape":"RegionDisabledException"} ], "documentation":"

Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider.

For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the AWS SDK for iOS and the AWS SDK for Android to uniquely identify a user and supply the user with a consistent identity throughout the lifetime of an application.

To learn more about Amazon Cognito, see Amazon Cognito Overview in the AWS SDK for Android Developer Guide guide and Amazon Cognito Overview in the AWS SDK for iOS Developer Guide.

Calling AssumeRoleWithWebIdentity does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application, and without deploying server-based proxy services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity with the other APIs that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS APIs in the IAM User Guide.

The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service APIs.

The credentials are valid for the duration that you specified when calling AssumeRoleWithWebIdentity, which can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour.

The temporary security credentials created by AssumeRoleWithWebIdentity can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's GetFederationToken or GetSessionToken APIs.

Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.

Before your application can call AssumeRoleWithWebIdentity, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy.

Calling AssumeRoleWithWebIdentity can result in an entry in your AWS CloudTrail logs. The entry includes the Subject of the provided Web Identity Token. We recommend that you avoid using any personally identifiable information (PII) in this field. For example, you could instead use a GUID or a pairwise identifier, as suggested in the OIDC specification.

For more information about how to use web identity federation and the AssumeRoleWithWebIdentity API, see the following resources:

" }, "DecodeAuthorizationMessage":{ "name":"DecodeAuthorizationMessage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DecodeAuthorizationMessageRequest"}, "output":{ "shape":"DecodeAuthorizationMessageResponse", "resultWrapper":"DecodeAuthorizationMessageResult" }, "errors":[ {"shape":"InvalidAuthorizationMessageException"} ], "documentation":"

Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request.

For example, if a user is not authorized to perform an action that he or she has requested, the request returns a Client.UnauthorizedOperation response (an HTTP 403 response). Some AWS actions additionally return an encoded message that can provide details about this authorization failure.

Only certain AWS actions return an encoded authorization message. The documentation for an individual action indicates whether that action returns an encoded message in addition to returning an HTTP code.

The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the action should not see. To decode an authorization status message, a user must be granted permissions via an IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) action.

The decoded message includes the following type of information:

  • Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see Determining Whether a Request is Allowed or Denied in the IAM User Guide.

  • The principal who made the request.

  • The requested action.

  • The requested resource.

  • The values of condition keys in the context of the user's request.

" }, "GetCallerIdentity":{ "name":"GetCallerIdentity", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCallerIdentityRequest"}, "output":{ "shape":"GetCallerIdentityResponse", "resultWrapper":"GetCallerIdentityResult" }, "documentation":"

Returns details about the IAM identity whose credentials are used to call the API.

" }, "GetFederationToken":{ "name":"GetFederationToken", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetFederationTokenRequest"}, "output":{ "shape":"GetFederationTokenResponse", "resultWrapper":"GetFederationTokenResult" }, "errors":[ {"shape":"MalformedPolicyDocumentException"}, {"shape":"PackedPolicyTooLargeException"}, {"shape":"RegionDisabledException"} ], "documentation":"

Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. Because you must call the GetFederationToken action using the long-term security credentials of an IAM user, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. For a comparison of GetFederationToken with the other APIs that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS APIs in the IAM User Guide.

If you are creating a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider, we recommend that you use Amazon Cognito or AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider.

The GetFederationToken action must be called by using the long-term AWS security credentials of an IAM user. You can also call GetFederationToken using the security credentials of an AWS root account, but we do not recommended it. Instead, we recommend that you create an IAM user for the purpose of the proxy application and then attach a policy to the IAM user that limits federated users to only the actions and resources that they need access to. For more information, see IAM Best Practices in the IAM User Guide.

The temporary security credentials that are obtained by using the long-term credentials of an IAM user are valid for the specified duration, from 900 seconds (15 minutes) up to a maximium of 129600 seconds (36 hours). The default is 43200 seconds (12 hours). Temporary credentials that are obtained by using AWS root account credentials have a maximum duration of 3600 seconds (1 hour).

The temporary security credentials created by GetFederationToken can be used to make API calls to any AWS service with the following exceptions:

  • You cannot use these credentials to call any IAM APIs.

  • You cannot call any STS APIs except GetCallerIdentity.

Permissions

The permissions for the temporary security credentials returned by GetFederationToken are determined by a combination of the following:

  • The policy or policies that are attached to the IAM user whose credentials are used to call GetFederationToken.

  • The policy that is passed as a parameter in the call.

The passed policy is attached to the temporary security credentials that result from the GetFederationToken API call--that is, to the federated user. When the federated user makes an AWS request, AWS evaluates the policy attached to the federated user in combination with the policy or policies attached to the IAM user whose credentials were used to call GetFederationToken. AWS allows the federated user's request only when both the federated user and the IAM user are explicitly allowed to perform the requested action. The passed policy cannot grant more permissions than those that are defined in the IAM user policy.

A typical use case is that the permissions of the IAM user whose credentials are used to call GetFederationToken are designed to allow access to all the actions and resources that any federated user will need. Then, for individual users, you pass a policy to the operation that scopes down the permissions to a level that's appropriate to that individual user, using a policy that allows only a subset of permissions that are granted to the IAM user.

If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.

For more information about how permissions work, see Permissions for GetFederationToken. For information about using GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker.

" }, "GetSessionToken":{ "name":"GetSessionToken", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSessionTokenRequest"}, "output":{ "shape":"GetSessionTokenResponse", "resultWrapper":"GetSessionTokenResult" }, "errors":[ {"shape":"RegionDisabledException"} ], "documentation":"

Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use GetSessionToken if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 StopInstances. MFA-enabled IAM users would need to call GetSessionToken and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of GetSessionToken with the other APIs that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS APIs in the IAM User Guide.

The GetSessionToken action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, from 900 seconds (15 minutes) up to a maximum of 129600 seconds (36 hours), with a default of 43200 seconds (12 hours); credentials that are created by using account credentials can range from 900 seconds (15 minutes) up to a maximum of 3600 seconds (1 hour), with a default of 1 hour.

The temporary security credentials created by GetSessionToken can be used to make API calls to any AWS service with the following exceptions:

  • You cannot call any IAM APIs unless MFA authentication information is included in the request.

  • You cannot call any STS API except AssumeRole or GetCallerIdentity.

We recommend that you do not call GetSessionToken with root account credentials. Instead, follow our best practices by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS.

The permissions associated with the temporary security credentials returned by GetSessionToken are based on the permissions associated with account or IAM user whose credentials are used to call the action. If GetSessionToken is called using root account credentials, the temporary credentials have root account permissions. Similarly, if GetSessionToken is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user.

For more information about using GetSessionToken to create temporary credentials, go to Temporary Credentials for Users in Untrusted Environments in the IAM User Guide.

" } }, "shapes":{ "AssumeRoleRequest":{ "type":"structure", "required":[ "RoleArn", "RoleSessionName" ], "members":{ "RoleArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the role to assume.

" }, "RoleSessionName":{ "shape":"roleSessionNameType", "documentation":"

An identifier for the assumed role session.

Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

" }, "Policy":{ "shape":"sessionPolicyDocumentType", "documentation":"

An IAM policy in JSON format.

This parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both (the intersection of) the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.

The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\\u0020-\\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.

The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

" }, "DurationSeconds":{ "shape":"roleDurationSecondsType", "documentation":"

The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

This is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session, separately from the DurationSeconds parameter on this API. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM User Guide.

" }, "ExternalId":{ "shape":"externalIdType", "documentation":"

A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide.

The regex used to validated this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:\\/-

" }, "SerialNumber":{ "shape":"serialNumberType", "documentation":"

The identification number of the MFA device that is associated with the user who is making the AssumeRole call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user).

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

" }, "TokenCode":{ "shape":"tokenCodeType", "documentation":"

The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the TokenCode value is missing or expired, the AssumeRole call returns an \"access denied\" error.

The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

" } } }, "AssumeRoleResponse":{ "type":"structure", "members":{ "Credentials":{ "shape":"Credentials", "documentation":"

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

" }, "AssumedRoleUser":{ "shape":"AssumedRoleUser", "documentation":"

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.

" }, "PackedPolicySize":{ "shape":"nonNegativeIntegerType", "documentation":"

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

" } }, "documentation":"

Contains the response to a successful AssumeRole request, including temporary AWS credentials that can be used to make AWS requests.

" }, "AssumeRoleWithSAMLRequest":{ "type":"structure", "required":[ "RoleArn", "PrincipalArn", "SAMLAssertion" ], "members":{ "RoleArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the role that the caller is assuming.

" }, "PrincipalArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

" }, "SAMLAssertion":{ "shape":"SAMLAssertionType", "documentation":"

The base-64 encoded SAML authentication response provided by the IdP.

For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.

" }, "Policy":{ "shape":"sessionPolicyDocumentType", "documentation":"

An IAM policy in JSON format.

The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.

The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\\u0020-\\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.

The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

" }, "DurationSeconds":{ "shape":"roleDurationSecondsType", "documentation":"

The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's SessionNotOnOrAfter value. The actual expiration time is whichever value is shorter.

This is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session, separately from the DurationSeconds parameter on this API. For more information, see Enabling SAML 2.0 Federated Users to Access the AWS Management Console in the IAM User Guide.

" } } }, "AssumeRoleWithSAMLResponse":{ "type":"structure", "members":{ "Credentials":{ "shape":"Credentials", "documentation":"

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

" }, "AssumedRoleUser":{ "shape":"AssumedRoleUser", "documentation":"

The identifiers for the temporary security credentials that the operation returns.

" }, "PackedPolicySize":{ "shape":"nonNegativeIntegerType", "documentation":"

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

" }, "Subject":{ "shape":"Subject", "documentation":"

The value of the NameID element in the Subject element of the SAML assertion.

" }, "SubjectType":{ "shape":"SubjectType", "documentation":"

The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion. Typical examples of the format are transient or persistent.

If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If the format includes any other prefix, the format is returned with no modifications.

" }, "Issuer":{ "shape":"Issuer", "documentation":"

The value of the Issuer element of the SAML assertion.

" }, "Audience":{ "shape":"Audience", "documentation":"

The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.

" }, "NameQualifier":{ "shape":"NameQualifier", "documentation":"

A hash value based on the concatenation of the Issuer response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM. The combination of NameQualifier and Subject can be used to uniquely identify a federated user.

The following pseudocode shows how the hash value is calculated:

BASE64 ( SHA1 ( \"https://example.com/saml\" + \"123456789012\" + \"/MySAMLIdP\" ) )

" } }, "documentation":"

Contains the response to a successful AssumeRoleWithSAML request, including temporary AWS credentials that can be used to make AWS requests.

" }, "AssumeRoleWithWebIdentityRequest":{ "type":"structure", "required":[ "RoleArn", "RoleSessionName", "WebIdentityToken" ], "members":{ "RoleArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the role that the caller is assuming.

" }, "RoleSessionName":{ "shape":"roleSessionNameType", "documentation":"

An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the AssumedRoleUser response element.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

" }, "WebIdentityToken":{ "shape":"clientTokenType", "documentation":"

The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an AssumeRoleWithWebIdentity call.

" }, "ProviderId":{ "shape":"urlType", "documentation":"

The fully qualified host component of the domain name of the identity provider.

Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com and graph.facebook.com are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.

Do not specify this value for OpenID Connect ID tokens.

" }, "Policy":{ "shape":"sessionPolicyDocumentType", "documentation":"

An IAM policy in JSON format.

The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRoleWithWebIdentity in the IAM User Guide.

The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\\u0020-\\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.

The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

" }, "DurationSeconds":{ "shape":"roleDurationSecondsType", "documentation":"

The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

This is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session, separately from the DurationSeconds parameter on this API. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM User Guide.

" } } }, "AssumeRoleWithWebIdentityResponse":{ "type":"structure", "members":{ "Credentials":{ "shape":"Credentials", "documentation":"

The temporary security credentials, which include an access key ID, a secret access key, and a security token.

Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

" }, "SubjectFromWebIdentityToken":{ "shape":"webIdentitySubjectType", "documentation":"

The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim.

" }, "AssumedRoleUser":{ "shape":"AssumedRoleUser", "documentation":"

The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.

" }, "PackedPolicySize":{ "shape":"nonNegativeIntegerType", "documentation":"

A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

" }, "Provider":{ "shape":"Issuer", "documentation":"

The issuing authority of the web identity token presented. For OpenID Connect ID Tokens this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.

" }, "Audience":{ "shape":"Audience", "documentation":"

The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.

" } }, "documentation":"

Contains the response to a successful AssumeRoleWithWebIdentity request, including temporary AWS credentials that can be used to make AWS requests.

" }, "AssumedRoleUser":{ "type":"structure", "required":[ "AssumedRoleId", "Arn" ], "members":{ "AssumedRoleId":{ "shape":"assumedRoleIdType", "documentation":"

A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role ID is generated by AWS when the role is created.

" }, "Arn":{ "shape":"arnType", "documentation":"

The ARN of the temporary security credentials that are returned from the AssumeRole action. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.

" } }, "documentation":"

The identifiers for the temporary security credentials that the operation returns.

" }, "Audience":{"type":"string"}, "Credentials":{ "type":"structure", "required":[ "AccessKeyId", "SecretAccessKey", "SessionToken", "Expiration" ], "members":{ "AccessKeyId":{ "shape":"accessKeyIdType", "documentation":"

The access key ID that identifies the temporary security credentials.

" }, "SecretAccessKey":{ "shape":"accessKeySecretType", "documentation":"

The secret access key that can be used to sign requests.

" }, "SessionToken":{ "shape":"tokenType", "documentation":"

The token that users must pass to the service API to use the temporary credentials.

" }, "Expiration":{ "shape":"dateType", "documentation":"

The date on which the current credentials expire.

" } }, "documentation":"

AWS credentials for API authentication.

" }, "DecodeAuthorizationMessageRequest":{ "type":"structure", "required":["EncodedMessage"], "members":{ "EncodedMessage":{ "shape":"encodedMessageType", "documentation":"

The encoded message that was returned with the response.

" } } }, "DecodeAuthorizationMessageResponse":{ "type":"structure", "members":{ "DecodedMessage":{ "shape":"decodedMessageType", "documentation":"

An XML document that contains the decoded message.

" } }, "documentation":"

A document that contains additional information about the authorization status of a request from an encoded message that is returned in response to an AWS request.

" }, "ExpiredTokenException":{ "type":"structure", "members":{ "message":{"shape":"expiredIdentityTokenMessage"} }, "documentation":"

The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request.

", "error":{ "code":"ExpiredTokenException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "FederatedUser":{ "type":"structure", "required":[ "FederatedUserId", "Arn" ], "members":{ "FederatedUserId":{ "shape":"federatedIdType", "documentation":"

The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.

" }, "Arn":{ "shape":"arnType", "documentation":"

The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.

" } }, "documentation":"

Identifiers for the federated user that is associated with the credentials.

" }, "GetCallerIdentityRequest":{ "type":"structure", "members":{ } }, "GetCallerIdentityResponse":{ "type":"structure", "members":{ "UserId":{ "shape":"userIdType", "documentation":"

The unique identifier of the calling entity. The exact value depends on the type of entity making the call. The values returned are those listed in the aws:userid column in the Principal table found on the Policy Variables reference page in the IAM User Guide.

" }, "Account":{ "shape":"accountType", "documentation":"

The AWS account ID number of the account that owns or contains the calling entity.

" }, "Arn":{ "shape":"arnType", "documentation":"

The AWS ARN associated with the calling entity.

" } }, "documentation":"

Contains the response to a successful GetCallerIdentity request, including information about the entity making the request.

" }, "GetFederationTokenRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"userNameType", "documentation":"

The name of the federated user. The name is used as an identifier for the temporary security credentials (such as Bob). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

" }, "Policy":{ "shape":"sessionPolicyDocumentType", "documentation":"

An IAM policy in JSON format that is passed with the GetFederationToken call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to call GetFederationToken. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy.

If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.

The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\\u0020-\\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.

The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

For more information about how permissions work, see Permissions for GetFederationToken.

" }, "DurationSeconds":{ "shape":"durationSecondsType", "documentation":"

The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour.

" } } }, "GetFederationTokenResponse":{ "type":"structure", "members":{ "Credentials":{ "shape":"Credentials", "documentation":"

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

" }, "FederatedUser":{ "shape":"FederatedUser", "documentation":"

Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.

" }, "PackedPolicySize":{ "shape":"nonNegativeIntegerType", "documentation":"

A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.

" } }, "documentation":"

Contains the response to a successful GetFederationToken request, including temporary AWS credentials that can be used to make AWS requests.

" }, "GetSessionTokenRequest":{ "type":"structure", "members":{ "DurationSeconds":{ "shape":"durationSecondsType", "documentation":"

The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.

" }, "SerialNumber":{ "shape":"serialNumberType", "documentation":"

The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.

The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

" }, "TokenCode":{ "shape":"tokenCodeType", "documentation":"

The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, and the user does not provide a code when requesting a set of temporary security credentials, the user will receive an \"access denied\" response when requesting resources that require MFA authentication.

The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

" } } }, "GetSessionTokenResponse":{ "type":"structure", "members":{ "Credentials":{ "shape":"Credentials", "documentation":"

The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

" } }, "documentation":"

Contains the response to a successful GetSessionToken request, including temporary AWS credentials that can be used to make AWS requests.

" }, "IDPCommunicationErrorException":{ "type":"structure", "members":{ "message":{"shape":"idpCommunicationErrorMessage"} }, "documentation":"

The request could not be fulfilled because the non-AWS identity provider (IDP) that was asked to verify the incoming identity token could not be reached. This is often a transient error caused by network conditions. Retry the request a limited number of times so that you don't exceed the request rate. If the error persists, the non-AWS identity provider might be down or not responding.

", "error":{ "code":"IDPCommunicationError", "httpStatusCode":400, "senderFault":true }, "exception":true }, "IDPRejectedClaimException":{ "type":"structure", "members":{ "message":{"shape":"idpRejectedClaimMessage"} }, "documentation":"

The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid.

If this error is returned for the AssumeRoleWithWebIdentity operation, it can also mean that the claim has expired or has been explicitly revoked.

", "error":{ "code":"IDPRejectedClaim", "httpStatusCode":403, "senderFault":true }, "exception":true }, "InvalidAuthorizationMessageException":{ "type":"structure", "members":{ "message":{"shape":"invalidAuthorizationMessage"} }, "documentation":"

The error returned if the message passed to DecodeAuthorizationMessage was invalid. This can happen if the token contains invalid characters, such as linebreaks.

", "error":{ "code":"InvalidAuthorizationMessageException", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidIdentityTokenException":{ "type":"structure", "members":{ "message":{"shape":"invalidIdentityTokenMessage"} }, "documentation":"

The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request.

", "error":{ "code":"InvalidIdentityToken", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Issuer":{"type":"string"}, "MalformedPolicyDocumentException":{ "type":"structure", "members":{ "message":{"shape":"malformedPolicyDocumentMessage"} }, "documentation":"

The request was rejected because the policy document was malformed. The error message describes the specific error.

", "error":{ "code":"MalformedPolicyDocument", "httpStatusCode":400, "senderFault":true }, "exception":true }, "NameQualifier":{"type":"string"}, "PackedPolicyTooLargeException":{ "type":"structure", "members":{ "message":{"shape":"packedPolicyTooLargeMessage"} }, "documentation":"

The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows.

", "error":{ "code":"PackedPolicyTooLarge", "httpStatusCode":400, "senderFault":true }, "exception":true }, "RegionDisabledException":{ "type":"structure", "members":{ "message":{"shape":"regionDisabledMessage"} }, "documentation":"

STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide.

", "error":{ "code":"RegionDisabledException", "httpStatusCode":403, "senderFault":true }, "exception":true }, "SAMLAssertionType":{ "type":"string", "max":50000, "min":4 }, "Subject":{"type":"string"}, "SubjectType":{"type":"string"}, "accessKeyIdType":{ "type":"string", "max":32, "min":16, "pattern":"[\\w]*" }, "accessKeySecretType":{"type":"string"}, "accountType":{"type":"string"}, "arnType":{ "type":"string", "max":2048, "min":20, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]+" }, "assumedRoleIdType":{ "type":"string", "max":96, "min":2, "pattern":"[\\w+=,.@:-]*" }, "clientTokenType":{ "type":"string", "max":2048, "min":4 }, "dateType":{"type":"timestamp"}, "decodedMessageType":{"type":"string"}, "durationSecondsType":{ "type":"integer", "max":129600, "min":900 }, "encodedMessageType":{ "type":"string", "max":10240, "min":1 }, "expiredIdentityTokenMessage":{"type":"string"}, "externalIdType":{ "type":"string", "max":1224, "min":2, "pattern":"[\\w+=,.@:\\/-]*" }, "federatedIdType":{ "type":"string", "max":96, "min":2, "pattern":"[\\w+=,.@\\:-]*" }, "idpCommunicationErrorMessage":{"type":"string"}, "idpRejectedClaimMessage":{"type":"string"}, "invalidAuthorizationMessage":{"type":"string"}, "invalidIdentityTokenMessage":{"type":"string"}, "malformedPolicyDocumentMessage":{"type":"string"}, "nonNegativeIntegerType":{ "type":"integer", "min":0 }, "packedPolicyTooLargeMessage":{"type":"string"}, "regionDisabledMessage":{"type":"string"}, "roleDurationSecondsType":{ "type":"integer", "max":3600, "min":900 }, "roleSessionNameType":{ "type":"string", "max":64, "min":2, "pattern":"[\\w+=,.@-]*" }, "serialNumberType":{ "type":"string", "max":256, "min":9, "pattern":"[\\w+=/:,.@-]*" }, "sessionPolicyDocumentType":{ "type":"string", "max":2048, "min":1, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" }, "tokenCodeType":{ "type":"string", "max":6, "min":6, "pattern":"[\\d]*" }, "tokenType":{"type":"string"}, "urlType":{ "type":"string", "max":2048, "min":4 }, "userIdType":{"type":"string"}, "userNameType":{ "type":"string", "max":32, "min":2, "pattern":"[\\w+=,.@-]*" }, "webIdentitySubjectType":{ "type":"string", "max":255, "min":6 } }, "documentation":"AWS Security Token Service

The AWS Security Token Service (STS) is a web service that enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more detailed information about using this service, go to Temporary Security Credentials.

As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to STS. For example, the SDKs take care of cryptographically 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.

For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about the Query API, go to Making Query Requests in Using IAM. For information about using security tokens with other AWS products, go to AWS Services That Work with IAM in the IAM User Guide.

If you're new to AWS and need additional technical information about a specific AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/.

Endpoints

The AWS Security Token Service (STS) has a default endpoint of https://sts.amazonaws.com that maps to the US East (N. Virginia) region. Additional regions are available and are activated by default. For more information, see Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide.

For information about STS endpoints, see Regions and Endpoints in the AWS General Reference.

Recording API requests

STS supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to STS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

" } botocore-1.5.7/botocore/data/firehose/0000777454262600001440000000000013042511307020737 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/firehose/2015-08-04/0000777454262600001440000000000013042511307021774 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/firehose/2015-08-04/service-2.json0000666454262600001440000021103213042511306024464 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-08-04", "endpointPrefix":"firehose", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"Firehose", "serviceFullName":"Amazon Kinesis Firehose", "signatureVersion":"v4", "targetPrefix":"Firehose_20150804", "uid":"firehose-2015-08-04" }, "operations":{ "CreateDeliveryStream":{ "name":"CreateDeliveryStream", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateDeliveryStreamInput"}, "output":{"shape":"CreateDeliveryStreamOutput"}, "errors":[ {"shape":"InvalidArgumentException"}, {"shape":"LimitExceededException"}, {"shape":"ResourceInUseException"} ], "documentation":"

Creates a delivery stream.

By default, you can create up to 20 delivery streams per region.

This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream.

A delivery stream is configured with a single destination: Amazon S3, Amazon Elasticsearch Service, or Amazon Redshift. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, or RedshiftDestinationConfiguration.

When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. Note that BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly; for example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.

A few notes about Amazon Redshift as a destination:

  • An Amazon Redshift destination requires an S3 bucket as intermediate location, as Firehose first delivers data to S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter.

  • The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

  • We strongly recommend that you use the user name and password you provide exclusively with Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions.

Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Firehose principal to assume the role, and the role should have permissions that allows the service to deliver the data. For more information, see Amazon S3 Bucket Access in the Amazon Kinesis Firehose Developer Guide.

" }, "DeleteDeliveryStream":{ "name":"DeleteDeliveryStream", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDeliveryStreamInput"}, "output":{"shape":"DeleteDeliveryStreamOutput"}, "errors":[ {"shape":"ResourceInUseException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes a delivery stream and its data.

You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state.

To check the state of a delivery stream, use DescribeDeliveryStream.

While the delivery stream is DELETING state, the service may continue to accept the records, but the service doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.

" }, "DescribeDeliveryStream":{ "name":"DescribeDeliveryStream", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDeliveryStreamInput"}, "output":{"shape":"DescribeDeliveryStreamOutput"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call DescribeDeliveryStream to see if the delivery stream is ACTIVE and therefore ready for data to be sent to it.

" }, "ListDeliveryStreams":{ "name":"ListDeliveryStreams", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDeliveryStreamsInput"}, "output":{"shape":"ListDeliveryStreamsOutput"}, "documentation":"

Lists your delivery streams.

The number of delivery streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more delivery streams to list, you can request them by specifying the name of the last delivery stream returned in the call in the ExclusiveStartDeliveryStreamName parameter of a subsequent call.

" }, "PutRecord":{ "name":"PutRecord", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutRecordInput"}, "output":{"shape":"PutRecordOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidArgumentException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Writes a single data record into an Amazon Kinesis Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers.

By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Firehose Limits.

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, etc.

Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\\n) or some other character unique within the data. This allows the consumer application(s) to parse individual data items when reading the data from the destination.

The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.

If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.

Data records sent to Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.

" }, "PutRecordBatch":{ "name":"PutRecordBatch", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutRecordBatchInput"}, "output":{"shape":"PutRecordBatchOutput"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidArgumentException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers.

By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see Amazon Kinesis Firehose Limits.

Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, web site clickstream data, and so on.

Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\\n) or some other character unique within the data. This allows the consumer application(s) to parse individual data items when reading the data from the destination.

The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Each entry in the RequestResponses array provides additional information about the processed record, and directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Firehose attempts to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records.

A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailable or InternalFailure. ErrorMessage provides more detailed information about the error.

If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.

If PutRecordBatch throws ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.

Data records sent to Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.

" }, "UpdateDestination":{ "name":"UpdateDestination", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDestinationInput"}, "output":{"shape":"UpdateDestinationOutput"}, "errors":[ {"shape":"InvalidArgumentException"}, {"shape":"ResourceInUseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConcurrentModificationException"} ], "documentation":"

Updates the specified destination of the specified delivery stream.

You can use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.

Note that switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.

If the destination type is the same, Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified then the existing EncryptionConfiguration is maintained on the destination.

If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Firehose does not merge any parameters. In this case, all parameters must be specified.

Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. You should use the new version ID to set CurrentDeliveryStreamVersionId in the next call.

" } }, "shapes":{ "AWSKMSKeyARN":{ "type":"string", "max":512, "min":1, "pattern":"arn:.*" }, "BooleanObject":{"type":"boolean"}, "BucketARN":{ "type":"string", "max":2048, "min":1, "pattern":"arn:.*" }, "BufferingHints":{ "type":"structure", "members":{ "SizeInMBs":{ "shape":"SizeInMBs", "documentation":"

Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.

" }, "IntervalInSeconds":{ "shape":"IntervalInSeconds", "documentation":"

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300.

" } }, "documentation":"

Describes hints for the buffering to perform before delivering data to the destination. Please note that these options are treated as hints, and therefore Firehose may choose to use different values when it is optimal.

" }, "CloudWatchLoggingOptions":{ "type":"structure", "members":{ "Enabled":{ "shape":"BooleanObject", "documentation":"

Enables or disables CloudWatch logging.

" }, "LogGroupName":{ "shape":"LogGroupName", "documentation":"

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

" }, "LogStreamName":{ "shape":"LogStreamName", "documentation":"

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

" } }, "documentation":"

Describes the CloudWatch logging options for your delivery stream.

" }, "ClusterJDBCURL":{ "type":"string", "min":1, "pattern":"jdbc:(redshift|postgresql)://((?!-)[A-Za-z0-9-]{1,63}(?A message that provides information about the error.

" } }, "documentation":"

Another modification has already happened. Fetch VersionId again and use it to update the destination.

", "exception":true }, "CopyCommand":{ "type":"structure", "required":["DataTableName"], "members":{ "DataTableName":{ "shape":"DataTableName", "documentation":"

The name of the target table. The table must already exist in the database.

" }, "DataTableColumns":{ "shape":"DataTableColumns", "documentation":"

A comma-separated list of column names.

" }, "CopyOptions":{ "shape":"CopyOptions", "documentation":"

Optional parameters to use with the Amazon Redshift COPY command. For more information, see the \"Optional Parameters\" section of Amazon Redshift COPY command. Some possible examples that would apply to Firehose are as follows:

delimiter '\\t' lzop; - fields are delimited with \"\\t\" (TAB character) and compressed using lzop.

delimiter '| - fields are delimited with \"|\" (this is the default delimiter).

delimiter '|' escape - the delimiter should be escaped.

fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

For more examples, see Amazon Redshift COPY command examples.

" } }, "documentation":"

Describes a COPY command for Amazon Redshift.

" }, "CopyOptions":{"type":"string"}, "CreateDeliveryStreamInput":{ "type":"structure", "required":["DeliveryStreamName"], "members":{ "DeliveryStreamName":{ "shape":"DeliveryStreamName", "documentation":"

The name of the delivery stream. This name must be unique per AWS account in the same region. You can have multiple delivery streams with the same name if they are in different accounts or different regions.

" }, "S3DestinationConfiguration":{ "shape":"S3DestinationConfiguration", "documentation":"

[Deprecated] The destination in Amazon S3. You can specify only one destination.

", "deprecated":true }, "ExtendedS3DestinationConfiguration":{ "shape":"ExtendedS3DestinationConfiguration", "documentation":"

The destination in Amazon S3. You can specify only one destination.

" }, "RedshiftDestinationConfiguration":{ "shape":"RedshiftDestinationConfiguration", "documentation":"

The destination in Amazon Redshift. You can specify only one destination.

" }, "ElasticsearchDestinationConfiguration":{ "shape":"ElasticsearchDestinationConfiguration", "documentation":"

The destination in Amazon ES. You can specify only one destination.

" } } }, "CreateDeliveryStreamOutput":{ "type":"structure", "members":{ "DeliveryStreamARN":{ "shape":"DeliveryStreamARN", "documentation":"

The ARN of the delivery stream.

" } } }, "Data":{ "type":"blob", "max":1024000, "min":0 }, "DataTableColumns":{"type":"string"}, "DataTableName":{ "type":"string", "min":1 }, "DeleteDeliveryStreamInput":{ "type":"structure", "required":["DeliveryStreamName"], "members":{ "DeliveryStreamName":{ "shape":"DeliveryStreamName", "documentation":"

The name of the delivery stream.

" } } }, "DeleteDeliveryStreamOutput":{ "type":"structure", "members":{ } }, "DeliveryStreamARN":{ "type":"string", "max":512, "min":1, "pattern":"arn:.*" }, "DeliveryStreamDescription":{ "type":"structure", "required":[ "DeliveryStreamName", "DeliveryStreamARN", "DeliveryStreamStatus", "VersionId", "Destinations", "HasMoreDestinations" ], "members":{ "DeliveryStreamName":{ "shape":"DeliveryStreamName", "documentation":"

The name of the delivery stream.

" }, "DeliveryStreamARN":{ "shape":"DeliveryStreamARN", "documentation":"

The Amazon Resource Name (ARN) of the delivery stream.

" }, "DeliveryStreamStatus":{ "shape":"DeliveryStreamStatus", "documentation":"

The status of the delivery stream.

" }, "VersionId":{ "shape":"DeliveryStreamVersionId", "documentation":"

Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.

" }, "CreateTimestamp":{ "shape":"Timestamp", "documentation":"

The date and time that the delivery stream was created.

" }, "LastUpdateTimestamp":{ "shape":"Timestamp", "documentation":"

The date and time that the delivery stream was last updated.

" }, "Destinations":{ "shape":"DestinationDescriptionList", "documentation":"

The destinations.

" }, "HasMoreDestinations":{ "shape":"BooleanObject", "documentation":"

Indicates whether there are more destinations available to list.

" } }, "documentation":"

Contains information about a delivery stream.

" }, "DeliveryStreamName":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z0-9_.-]+" }, "DeliveryStreamNameList":{ "type":"list", "member":{"shape":"DeliveryStreamName"} }, "DeliveryStreamStatus":{ "type":"string", "enum":[ "CREATING", "DELETING", "ACTIVE" ] }, "DeliveryStreamVersionId":{ "type":"string", "max":50, "min":1, "pattern":"[0-9]+" }, "DescribeDeliveryStreamInput":{ "type":"structure", "required":["DeliveryStreamName"], "members":{ "DeliveryStreamName":{ "shape":"DeliveryStreamName", "documentation":"

The name of the delivery stream.

" }, "Limit":{ "shape":"DescribeDeliveryStreamInputLimit", "documentation":"

The limit on the number of destinations to return. Currently, you can have one destination per delivery stream.

" }, "ExclusiveStartDestinationId":{ "shape":"DestinationId", "documentation":"

The ID of the destination to start returning the destination information. Currently Firehose supports one destination per delivery stream.

" } } }, "DescribeDeliveryStreamInputLimit":{ "type":"integer", "max":10000, "min":1 }, "DescribeDeliveryStreamOutput":{ "type":"structure", "required":["DeliveryStreamDescription"], "members":{ "DeliveryStreamDescription":{ "shape":"DeliveryStreamDescription", "documentation":"

Information about the delivery stream.

" } } }, "DestinationDescription":{ "type":"structure", "required":["DestinationId"], "members":{ "DestinationId":{ "shape":"DestinationId", "documentation":"

The ID of the destination.

" }, "S3DestinationDescription":{ "shape":"S3DestinationDescription", "documentation":"

[Deprecated] The destination in Amazon S3.

" }, "ExtendedS3DestinationDescription":{ "shape":"ExtendedS3DestinationDescription", "documentation":"

The destination in Amazon S3.

" }, "RedshiftDestinationDescription":{ "shape":"RedshiftDestinationDescription", "documentation":"

The destination in Amazon Redshift.

" }, "ElasticsearchDestinationDescription":{ "shape":"ElasticsearchDestinationDescription", "documentation":"

The destination in Amazon ES.

" } }, "documentation":"

Describes the destination for a delivery stream.

" }, "DestinationDescriptionList":{ "type":"list", "member":{"shape":"DestinationDescription"} }, "DestinationId":{ "type":"string", "max":100, "min":1 }, "ElasticsearchBufferingHints":{ "type":"structure", "members":{ "IntervalInSeconds":{ "shape":"ElasticsearchBufferingIntervalInSeconds", "documentation":"

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).

" }, "SizeInMBs":{ "shape":"ElasticsearchBufferingSizeInMBs", "documentation":"

Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.

" } }, "documentation":"

Describes the buffering to perform before delivering data to the Amazon ES destination.

" }, "ElasticsearchBufferingIntervalInSeconds":{ "type":"integer", "max":900, "min":60 }, "ElasticsearchBufferingSizeInMBs":{ "type":"integer", "max":100, "min":1 }, "ElasticsearchDestinationConfiguration":{ "type":"structure", "required":[ "RoleARN", "DomainARN", "IndexName", "TypeName", "S3Configuration" ], "members":{ "RoleARN":{ "shape":"RoleARN", "documentation":"

The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access.

" }, "DomainARN":{ "shape":"ElasticsearchDomainARN", "documentation":"

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.

" }, "IndexName":{ "shape":"ElasticsearchIndexName", "documentation":"

The Elasticsearch index name.

" }, "TypeName":{ "shape":"ElasticsearchTypeName", "documentation":"

The Elasticsearch type name.

" }, "IndexRotationPeriod":{ "shape":"ElasticsearchIndexRotationPeriod", "documentation":"

The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. The default value is OneDay.

" }, "BufferingHints":{ "shape":"ElasticsearchBufferingHints", "documentation":"

The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

" }, "RetryOptions":{ "shape":"ElasticsearchRetryOptions", "documentation":"

The retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

" }, "S3BackupMode":{ "shape":"ElasticsearchS3BackupMode", "documentation":"

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination. Default value is FailedDocumentsOnly.

" }, "S3Configuration":{ "shape":"S3DestinationConfiguration", "documentation":"

The configuration for the intermediate Amazon S3 location from which Amazon ES obtains data.

" }, "ProcessingConfiguration":{ "shape":"ProcessingConfiguration", "documentation":"

The data processing configuration.

" }, "CloudWatchLoggingOptions":{ "shape":"CloudWatchLoggingOptions", "documentation":"

The CloudWatch logging options for your delivery stream.

" } }, "documentation":"

Describes the configuration of a destination in Amazon ES.

" }, "ElasticsearchDestinationDescription":{ "type":"structure", "members":{ "RoleARN":{ "shape":"RoleARN", "documentation":"

The ARN of the AWS credentials.

" }, "DomainARN":{ "shape":"ElasticsearchDomainARN", "documentation":"

The ARN of the Amazon ES domain.

" }, "IndexName":{ "shape":"ElasticsearchIndexName", "documentation":"

The Elasticsearch index name.

" }, "TypeName":{ "shape":"ElasticsearchTypeName", "documentation":"

The Elasticsearch type name.

" }, "IndexRotationPeriod":{ "shape":"ElasticsearchIndexRotationPeriod", "documentation":"

The Elasticsearch index rotation period

" }, "BufferingHints":{ "shape":"ElasticsearchBufferingHints", "documentation":"

The buffering options.

" }, "RetryOptions":{ "shape":"ElasticsearchRetryOptions", "documentation":"

The Amazon ES retry options.

" }, "S3BackupMode":{ "shape":"ElasticsearchS3BackupMode", "documentation":"

The Amazon S3 backup mode.

" }, "S3DestinationDescription":{ "shape":"S3DestinationDescription", "documentation":"

The Amazon S3 destination.

" }, "ProcessingConfiguration":{ "shape":"ProcessingConfiguration", "documentation":"

The data processing configuration.

" }, "CloudWatchLoggingOptions":{ "shape":"CloudWatchLoggingOptions", "documentation":"

The CloudWatch logging options.

" } }, "documentation":"

The destination description in Amazon ES.

" }, "ElasticsearchDestinationUpdate":{ "type":"structure", "members":{ "RoleARN":{ "shape":"RoleARN", "documentation":"

The ARN of the IAM role to be assumed by Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Amazon S3 Bucket Access.

" }, "DomainARN":{ "shape":"ElasticsearchDomainARN", "documentation":"

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the IAM role specified in RoleARN.

" }, "IndexName":{ "shape":"ElasticsearchIndexName", "documentation":"

The Elasticsearch index name.

" }, "TypeName":{ "shape":"ElasticsearchTypeName", "documentation":"

The Elasticsearch type name.

" }, "IndexRotationPeriod":{ "shape":"ElasticsearchIndexRotationPeriod", "documentation":"

The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default value is OneDay.

" }, "BufferingHints":{ "shape":"ElasticsearchBufferingHints", "documentation":"

The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.

" }, "RetryOptions":{ "shape":"ElasticsearchRetryOptions", "documentation":"

The retry behavior in the event that Firehose is unable to deliver documents to Amazon ES. Default value is 300 (5 minutes).

" }, "S3Update":{ "shape":"S3DestinationUpdate", "documentation":"

The Amazon S3 destination.

" }, "ProcessingConfiguration":{ "shape":"ProcessingConfiguration", "documentation":"

The data processing configuration.

" }, "CloudWatchLoggingOptions":{ "shape":"CloudWatchLoggingOptions", "documentation":"

The CloudWatch logging options for your delivery stream.

" } }, "documentation":"

Describes an update for a destination in Amazon ES.

" }, "ElasticsearchDomainARN":{ "type":"string", "max":512, "min":1, "pattern":"arn:.*" }, "ElasticsearchIndexName":{ "type":"string", "max":80, "min":1 }, "ElasticsearchIndexRotationPeriod":{ "type":"string", "enum":[ "NoRotation", "OneHour", "OneDay", "OneWeek", "OneMonth" ] }, "ElasticsearchRetryDurationInSeconds":{ "type":"integer", "max":7200, "min":0 }, "ElasticsearchRetryOptions":{ "type":"structure", "members":{ "DurationInSeconds":{ "shape":"ElasticsearchRetryDurationInSeconds", "documentation":"

After an initial failure to deliver to Amazon ES, the total amount of time during which Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

" } }, "documentation":"

Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon ES.

" }, "ElasticsearchS3BackupMode":{ "type":"string", "enum":[ "FailedDocumentsOnly", "AllDocuments" ] }, "ElasticsearchTypeName":{ "type":"string", "max":100, "min":1 }, "EncryptionConfiguration":{ "type":"structure", "members":{ "NoEncryptionConfig":{ "shape":"NoEncryptionConfig", "documentation":"

Specifically override existing encryption information to ensure no encryption is used.

" }, "KMSEncryptionConfig":{ "shape":"KMSEncryptionConfig", "documentation":"

The encryption key.

" } }, "documentation":"

Describes the encryption for a destination in Amazon S3.

" }, "ErrorCode":{"type":"string"}, "ErrorMessage":{"type":"string"}, "ExtendedS3DestinationConfiguration":{ "type":"structure", "required":[ "RoleARN", "BucketARN" ], "members":{ "RoleARN":{ "shape":"RoleARN", "documentation":"

The ARN of the AWS credentials.

" }, "BucketARN":{ "shape":"BucketARN", "documentation":"

The ARN of the S3 bucket.

" }, "Prefix":{ "shape":"Prefix", "documentation":"

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Firehose Developer Guide.

" }, "BufferingHints":{ "shape":"BufferingHints", "documentation":"

The buffering option.

" }, "CompressionFormat":{ "shape":"CompressionFormat", "documentation":"

The compression format. If no value is specified, the default is UNCOMPRESSED.

" }, "EncryptionConfiguration":{ "shape":"EncryptionConfiguration", "documentation":"

The encryption configuration. If no value is specified, the default is no encryption.

" }, "CloudWatchLoggingOptions":{ "shape":"CloudWatchLoggingOptions", "documentation":"

The CloudWatch logging options for your delivery stream.

" }, "ProcessingConfiguration":{ "shape":"ProcessingConfiguration", "documentation":"

The data processing configuration.

" }, "S3BackupMode":{ "shape":"S3BackupMode", "documentation":"

The Amazon S3 backup mode.

" }, "S3BackupConfiguration":{ "shape":"S3DestinationConfiguration", "documentation":"

The configuration for backup in Amazon S3.

" } }, "documentation":"

Describes the configuration of a destination in Amazon S3.

" }, "ExtendedS3DestinationDescription":{ "type":"structure", "required":[ "RoleARN", "BucketARN", "BufferingHints", "CompressionFormat", "EncryptionConfiguration" ], "members":{ "RoleARN":{ "shape":"RoleARN", "documentation":"

The ARN of the AWS credentials.

" }, "BucketARN":{ "shape":"BucketARN", "documentation":"

The ARN of the S3 bucket.

" }, "Prefix":{ "shape":"Prefix", "documentation":"

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Firehose Developer Guide.

" }, "BufferingHints":{ "shape":"BufferingHints", "documentation":"

The buffering option.

" }, "CompressionFormat":{ "shape":"CompressionFormat", "documentation":"

The compression format. If no value is specified, the default is UNCOMPRESSED.

" }, "EncryptionConfiguration":{ "shape":"EncryptionConfiguration", "documentation":"

The encryption configuration. If no value is specified, the default is no encryption.

" }, "CloudWatchLoggingOptions":{ "shape":"CloudWatchLoggingOptions", "documentation":"

The CloudWatch logging options for your delivery stream.

" }, "ProcessingConfiguration":{ "shape":"ProcessingConfiguration", "documentation":"

The data processing configuration.

" }, "S3BackupMode":{ "shape":"S3BackupMode", "documentation":"

The Amazon S3 backup mode.

" }, "S3BackupDescription":{ "shape":"S3DestinationDescription", "documentation":"

The configuration for backup in Amazon S3.

" } }, "documentation":"

Describes a destination in Amazon S3.

" }, "ExtendedS3DestinationUpdate":{ "type":"structure", "members":{ "RoleARN":{ "shape":"RoleARN", "documentation":"

The ARN of the AWS credentials.

" }, "BucketARN":{ "shape":"BucketARN", "documentation":"

The ARN of the S3 bucket.

" }, "Prefix":{ "shape":"Prefix", "documentation":"

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Firehose Developer Guide.

" }, "BufferingHints":{ "shape":"BufferingHints", "documentation":"

The buffering option.

" }, "CompressionFormat":{ "shape":"CompressionFormat", "documentation":"

The compression format. If no value is specified, the default is UNCOMPRESSED.

" }, "EncryptionConfiguration":{ "shape":"EncryptionConfiguration", "documentation":"

The encryption configuration. If no value is specified, the default is no encryption.

" }, "CloudWatchLoggingOptions":{ "shape":"CloudWatchLoggingOptions", "documentation":"

The CloudWatch logging options for your delivery stream.

" }, "ProcessingConfiguration":{ "shape":"ProcessingConfiguration", "documentation":"

The data processing configuration.

" }, "S3BackupMode":{ "shape":"S3BackupMode", "documentation":"

Enables or disables Amazon S3 backup mode.

" }, "S3BackupUpdate":{ "shape":"S3DestinationUpdate", "documentation":"

The Amazon S3 destination for backup.

" } }, "documentation":"

Describes an update for a destination in Amazon S3.

" }, "IntervalInSeconds":{ "type":"integer", "max":900, "min":60 }, "InvalidArgumentException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A message that provides information about the error.

" } }, "documentation":"

The specified input parameter has an value that is not valid.

", "exception":true }, "KMSEncryptionConfig":{ "type":"structure", "required":["AWSKMSKeyARN"], "members":{ "AWSKMSKeyARN":{ "shape":"AWSKMSKeyARN", "documentation":"

The ARN of the encryption key. Must belong to the same region as the destination Amazon S3 bucket.

" } }, "documentation":"

Describes an encryption key for a destination in Amazon S3.

" }, "LimitExceededException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A message that provides information about the error.

" } }, "documentation":"

You have already reached the limit for a requested resource.

", "exception":true }, "ListDeliveryStreamsInput":{ "type":"structure", "members":{ "Limit":{ "shape":"ListDeliveryStreamsInputLimit", "documentation":"

The maximum number of delivery streams to list.

" }, "ExclusiveStartDeliveryStreamName":{ "shape":"DeliveryStreamName", "documentation":"

The name of the delivery stream to start the list with.

" } } }, "ListDeliveryStreamsInputLimit":{ "type":"integer", "max":10000, "min":1 }, "ListDeliveryStreamsOutput":{ "type":"structure", "required":[ "DeliveryStreamNames", "HasMoreDeliveryStreams" ], "members":{ "DeliveryStreamNames":{ "shape":"DeliveryStreamNameList", "documentation":"

The names of the delivery streams.

" }, "HasMoreDeliveryStreams":{ "shape":"BooleanObject", "documentation":"

Indicates whether there are more delivery streams available to list.

" } } }, "LogGroupName":{"type":"string"}, "LogStreamName":{"type":"string"}, "NoEncryptionConfig":{ "type":"string", "enum":["NoEncryption"] }, "NonNegativeIntegerObject":{ "type":"integer", "min":0 }, "Password":{ "type":"string", "min":6, "sensitive":true }, "Prefix":{"type":"string"}, "ProcessingConfiguration":{ "type":"structure", "members":{ "Enabled":{ "shape":"BooleanObject", "documentation":"

Enables or disables data processing.

" }, "Processors":{ "shape":"ProcessorList", "documentation":"

The data processors.

" } }, "documentation":"

Describes a data processing configuration.

" }, "Processor":{ "type":"structure", "required":["Type"], "members":{ "Type":{ "shape":"ProcessorType", "documentation":"

The type of processor.

" }, "Parameters":{ "shape":"ProcessorParameterList", "documentation":"

The processor parameters.

" } }, "documentation":"

Describes a data processor.

" }, "ProcessorList":{ "type":"list", "member":{"shape":"Processor"} }, "ProcessorParameter":{ "type":"structure", "required":[ "ParameterName", "ParameterValue" ], "members":{ "ParameterName":{ "shape":"ProcessorParameterName", "documentation":"

The name of the parameter.

" }, "ParameterValue":{ "shape":"ProcessorParameterValue", "documentation":"

The parameter value.

" } }, "documentation":"

Describes the processor parameter.

" }, "ProcessorParameterList":{ "type":"list", "member":{"shape":"ProcessorParameter"} }, "ProcessorParameterName":{ "type":"string", "enum":[ "LambdaArn", "NumberOfRetries" ] }, "ProcessorParameterValue":{ "type":"string", "max":512, "min":1 }, "ProcessorType":{ "type":"string", "enum":["Lambda"] }, "PutRecordBatchInput":{ "type":"structure", "required":[ "DeliveryStreamName", "Records" ], "members":{ "DeliveryStreamName":{ "shape":"DeliveryStreamName", "documentation":"

The name of the delivery stream.

" }, "Records":{ "shape":"PutRecordBatchRequestEntryList", "documentation":"

One or more records.

" } } }, "PutRecordBatchOutput":{ "type":"structure", "required":[ "FailedPutCount", "RequestResponses" ], "members":{ "FailedPutCount":{ "shape":"NonNegativeIntegerObject", "documentation":"

The number of records that might have failed processing.

" }, "RequestResponses":{ "shape":"PutRecordBatchResponseEntryList", "documentation":"

The results array. For each record, the index of the response element is the same as the index used in the request array.

" } } }, "PutRecordBatchRequestEntryList":{ "type":"list", "member":{"shape":"Record"}, "max":500, "min":1 }, "PutRecordBatchResponseEntry":{ "type":"structure", "members":{ "RecordId":{ "shape":"PutResponseRecordId", "documentation":"

The ID of the record.

" }, "ErrorCode":{ "shape":"ErrorCode", "documentation":"

The error code for an individual record result.

" }, "ErrorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message for an individual record result.

" } }, "documentation":"

Contains the result for an individual record from a PutRecordBatch request. If the record is successfully added to your delivery stream, it receives a record ID. If the record fails to be added to your delivery stream, the result includes an error code and an error message.

" }, "PutRecordBatchResponseEntryList":{ "type":"list", "member":{"shape":"PutRecordBatchResponseEntry"}, "max":500, "min":1 }, "PutRecordInput":{ "type":"structure", "required":[ "DeliveryStreamName", "Record" ], "members":{ "DeliveryStreamName":{ "shape":"DeliveryStreamName", "documentation":"

The name of the delivery stream.

" }, "Record":{ "shape":"Record", "documentation":"

The record.

" } } }, "PutRecordOutput":{ "type":"structure", "required":["RecordId"], "members":{ "RecordId":{ "shape":"PutResponseRecordId", "documentation":"

The ID of the record.

" } } }, "PutResponseRecordId":{ "type":"string", "min":1 }, "Record":{ "type":"structure", "required":["Data"], "members":{ "Data":{ "shape":"Data", "documentation":"

The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KB.

" } }, "documentation":"

The unit of data in a delivery stream.

" }, "RedshiftDestinationConfiguration":{ "type":"structure", "required":[ "RoleARN", "ClusterJDBCURL", "CopyCommand", "Username", "Password", "S3Configuration" ], "members":{ "RoleARN":{ "shape":"RoleARN", "documentation":"

The ARN of the AWS credentials.

" }, "ClusterJDBCURL":{ "shape":"ClusterJDBCURL", "documentation":"

The database connection string.

" }, "CopyCommand":{ "shape":"CopyCommand", "documentation":"

The COPY command.

" }, "Username":{ "shape":"Username", "documentation":"

The name of the user.

" }, "Password":{ "shape":"Password", "documentation":"

The user password.

" }, "RetryOptions":{ "shape":"RedshiftRetryOptions", "documentation":"

The retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

" }, "S3Configuration":{ "shape":"S3DestinationConfiguration", "documentation":"

The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.

The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

" }, "ProcessingConfiguration":{ "shape":"ProcessingConfiguration", "documentation":"

The data processing configuration.

" }, "S3BackupMode":{ "shape":"RedshiftS3BackupMode", "documentation":"

The Amazon S3 backup mode.

" }, "S3BackupConfiguration":{ "shape":"S3DestinationConfiguration", "documentation":"

The configuration for backup in Amazon S3.

" }, "CloudWatchLoggingOptions":{ "shape":"CloudWatchLoggingOptions", "documentation":"

The CloudWatch logging options for your delivery stream.

" } }, "documentation":"

Describes the configuration of a destination in Amazon Redshift.

" }, "RedshiftDestinationDescription":{ "type":"structure", "required":[ "RoleARN", "ClusterJDBCURL", "CopyCommand", "Username", "S3DestinationDescription" ], "members":{ "RoleARN":{ "shape":"RoleARN", "documentation":"

The ARN of the AWS credentials.

" }, "ClusterJDBCURL":{ "shape":"ClusterJDBCURL", "documentation":"

The database connection string.

" }, "CopyCommand":{ "shape":"CopyCommand", "documentation":"

The COPY command.

" }, "Username":{ "shape":"Username", "documentation":"

The name of the user.

" }, "RetryOptions":{ "shape":"RedshiftRetryOptions", "documentation":"

The retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

" }, "S3DestinationDescription":{ "shape":"S3DestinationDescription", "documentation":"

The Amazon S3 destination.

" }, "ProcessingConfiguration":{ "shape":"ProcessingConfiguration", "documentation":"

The data processing configuration.

" }, "S3BackupMode":{ "shape":"RedshiftS3BackupMode", "documentation":"

The Amazon S3 backup mode.

" }, "S3BackupDescription":{ "shape":"S3DestinationDescription", "documentation":"

The configuration for backup in Amazon S3.

" }, "CloudWatchLoggingOptions":{ "shape":"CloudWatchLoggingOptions", "documentation":"

The CloudWatch logging options for your delivery stream.

" } }, "documentation":"

Describes a destination in Amazon Redshift.

" }, "RedshiftDestinationUpdate":{ "type":"structure", "members":{ "RoleARN":{ "shape":"RoleARN", "documentation":"

The ARN of the AWS credentials.

" }, "ClusterJDBCURL":{ "shape":"ClusterJDBCURL", "documentation":"

The database connection string.

" }, "CopyCommand":{ "shape":"CopyCommand", "documentation":"

The COPY command.

" }, "Username":{ "shape":"Username", "documentation":"

The name of the user.

" }, "Password":{ "shape":"Password", "documentation":"

The user password.

" }, "RetryOptions":{ "shape":"RedshiftRetryOptions", "documentation":"

The retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

" }, "S3Update":{ "shape":"S3DestinationUpdate", "documentation":"

The Amazon S3 destination.

The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

" }, "ProcessingConfiguration":{ "shape":"ProcessingConfiguration", "documentation":"

The data processing configuration.

" }, "S3BackupMode":{ "shape":"RedshiftS3BackupMode", "documentation":"

The Amazon S3 backup mode.

" }, "S3BackupUpdate":{ "shape":"S3DestinationUpdate", "documentation":"

The Amazon S3 destination for backup.

" }, "CloudWatchLoggingOptions":{ "shape":"CloudWatchLoggingOptions", "documentation":"

The CloudWatch logging options for your delivery stream.

" } }, "documentation":"

Describes an update for a destination in Amazon Redshift.

" }, "RedshiftRetryDurationInSeconds":{ "type":"integer", "max":7200, "min":0 }, "RedshiftRetryOptions":{ "type":"structure", "members":{ "DurationInSeconds":{ "shape":"RedshiftRetryDurationInSeconds", "documentation":"

The length of time during which Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Firehose does not retry if the value of DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.

" } }, "documentation":"

Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift.

" }, "RedshiftS3BackupMode":{ "type":"string", "enum":[ "Disabled", "Enabled" ] }, "ResourceInUseException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A message that provides information about the error.

" } }, "documentation":"

The resource is already in use and not available for this operation.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A message that provides information about the error.

" } }, "documentation":"

The specified resource could not be found.

", "exception":true }, "RoleARN":{ "type":"string", "max":512, "min":1, "pattern":"arn:.*" }, "S3BackupMode":{ "type":"string", "enum":[ "Disabled", "Enabled" ] }, "S3DestinationConfiguration":{ "type":"structure", "required":[ "RoleARN", "BucketARN" ], "members":{ "RoleARN":{ "shape":"RoleARN", "documentation":"

The ARN of the AWS credentials.

" }, "BucketARN":{ "shape":"BucketARN", "documentation":"

The ARN of the S3 bucket.

" }, "Prefix":{ "shape":"Prefix", "documentation":"

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Firehose Developer Guide.

" }, "BufferingHints":{ "shape":"BufferingHints", "documentation":"

The buffering option. If no value is specified, BufferingHints object default values are used.

" }, "CompressionFormat":{ "shape":"CompressionFormat", "documentation":"

The compression format. If no value is specified, the default is UNCOMPRESSED.

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

" }, "EncryptionConfiguration":{ "shape":"EncryptionConfiguration", "documentation":"

The encryption configuration. If no value is specified, the default is no encryption.

" }, "CloudWatchLoggingOptions":{ "shape":"CloudWatchLoggingOptions", "documentation":"

The CloudWatch logging options for your delivery stream.

" } }, "documentation":"

Describes the configuration of a destination in Amazon S3.

" }, "S3DestinationDescription":{ "type":"structure", "required":[ "RoleARN", "BucketARN", "BufferingHints", "CompressionFormat", "EncryptionConfiguration" ], "members":{ "RoleARN":{ "shape":"RoleARN", "documentation":"

The ARN of the AWS credentials.

" }, "BucketARN":{ "shape":"BucketARN", "documentation":"

The ARN of the S3 bucket.

" }, "Prefix":{ "shape":"Prefix", "documentation":"

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Firehose Developer Guide.

" }, "BufferingHints":{ "shape":"BufferingHints", "documentation":"

The buffering option. If no value is specified, BufferingHints object default values are used.

" }, "CompressionFormat":{ "shape":"CompressionFormat", "documentation":"

The compression format. If no value is specified, the default is UNCOMPRESSED.

" }, "EncryptionConfiguration":{ "shape":"EncryptionConfiguration", "documentation":"

The encryption configuration. If no value is specified, the default is no encryption.

" }, "CloudWatchLoggingOptions":{ "shape":"CloudWatchLoggingOptions", "documentation":"

The CloudWatch logging options for your delivery stream.

" } }, "documentation":"

Describes a destination in Amazon S3.

" }, "S3DestinationUpdate":{ "type":"structure", "members":{ "RoleARN":{ "shape":"RoleARN", "documentation":"

The ARN of the AWS credentials.

" }, "BucketARN":{ "shape":"BucketARN", "documentation":"

The ARN of the S3 bucket.

" }, "Prefix":{ "shape":"Prefix", "documentation":"

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see Amazon S3 Object Name Format in the Amazon Kinesis Firehose Developer Guide.

" }, "BufferingHints":{ "shape":"BufferingHints", "documentation":"

The buffering option. If no value is specified, BufferingHints object default values are used.

" }, "CompressionFormat":{ "shape":"CompressionFormat", "documentation":"

The compression format. If no value is specified, the default is UNCOMPRESSED.

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

" }, "EncryptionConfiguration":{ "shape":"EncryptionConfiguration", "documentation":"

The encryption configuration. If no value is specified, the default is no encryption.

" }, "CloudWatchLoggingOptions":{ "shape":"CloudWatchLoggingOptions", "documentation":"

The CloudWatch logging options for your delivery stream.

" } }, "documentation":"

Describes an update for a destination in Amazon S3.

" }, "ServiceUnavailableException":{ "type":"structure", "members":{ "message":{ "shape":"ErrorMessage", "documentation":"

A message that provides information about the error.

" } }, "documentation":"

The service is unavailable, back off and retry the operation. If you continue to see the exception, throughput limits for the delivery stream may have been exceeded. For more information about limits and how to request an increase, see Amazon Kinesis Firehose Limits.

", "exception":true, "fault":true }, "SizeInMBs":{ "type":"integer", "max":128, "min":1 }, "Timestamp":{"type":"timestamp"}, "UpdateDestinationInput":{ "type":"structure", "required":[ "DeliveryStreamName", "CurrentDeliveryStreamVersionId", "DestinationId" ], "members":{ "DeliveryStreamName":{ "shape":"DeliveryStreamName", "documentation":"

The name of the delivery stream.

" }, "CurrentDeliveryStreamVersionId":{ "shape":"DeliveryStreamVersionId", "documentation":"

Obtain this value from the VersionId result of DeliveryStreamDescription. This value is required, and helps the service to perform conditional operations. For example, if there is a interleaving update and this value is null, then the update destination fails. After the update is successful, the VersionId value is updated. The service then performs a merge of the old configuration with the new configuration.

" }, "DestinationId":{ "shape":"DestinationId", "documentation":"

The ID of the destination.

" }, "S3DestinationUpdate":{ "shape":"S3DestinationUpdate", "documentation":"

[Deprecated] Describes an update for a destination in Amazon S3.

", "deprecated":true }, "ExtendedS3DestinationUpdate":{ "shape":"ExtendedS3DestinationUpdate", "documentation":"

Describes an update for a destination in Amazon S3.

" }, "RedshiftDestinationUpdate":{ "shape":"RedshiftDestinationUpdate", "documentation":"

Describes an update for a destination in Amazon Redshift.

" }, "ElasticsearchDestinationUpdate":{ "shape":"ElasticsearchDestinationUpdate", "documentation":"

Describes an update for a destination in Amazon ES.

" } } }, "UpdateDestinationOutput":{ "type":"structure", "members":{ } }, "Username":{ "type":"string", "min":1, "sensitive":true } }, "documentation":"Amazon Kinesis Firehose API Reference

Amazon Kinesis Firehose is a fully-managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Elasticsearch Service (Amazon ES), and Amazon Redshift.

" } botocore-1.5.7/botocore/data/workspaces/0000777454262600001440000000000013042511307021314 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/workspaces/2015-04-08/0000777454262600001440000000000013042511307022351 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/workspaces/2015-04-08/service-2.json0000666454262600001440000013231113042511306025043 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"workspaces-2015-04-08", "apiVersion":"2015-04-08", "endpointPrefix":"workspaces", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Amazon WorkSpaces", "signatureVersion":"v4", "targetPrefix":"WorkspacesService" }, "operations":{ "CreateTags":{ "name":"CreateTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTagsRequest"}, "output":{"shape":"CreateTagsResult"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValuesException"}, {"shape":"ResourceLimitExceededException"} ], "documentation":"

Creates tags for a WorkSpace.

" }, "CreateWorkspaces":{ "name":"CreateWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateWorkspacesRequest"}, "output":{"shape":"CreateWorkspacesResult"}, "errors":[ {"shape":"ResourceLimitExceededException"}, {"shape":"InvalidParameterValuesException"} ], "documentation":"

Creates one or more WorkSpaces.

This operation is asynchronous and returns before the WorkSpaces are created.

" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsRequest"}, "output":{"shape":"DeleteTagsResult"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValuesException"} ], "documentation":"

Deletes tags from a WorkSpace.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsRequest"}, "output":{"shape":"DescribeTagsResult"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Describes tags for a WorkSpace.

" }, "DescribeWorkspaceBundles":{ "name":"DescribeWorkspaceBundles", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWorkspaceBundlesRequest"}, "output":{"shape":"DescribeWorkspaceBundlesResult"}, "errors":[ {"shape":"InvalidParameterValuesException"} ], "documentation":"

Obtains information about the WorkSpace bundles that are available to your account in the specified region.

You can filter the results with either the BundleIds parameter, or the Owner parameter, but not both.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

" }, "DescribeWorkspaceDirectories":{ "name":"DescribeWorkspaceDirectories", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWorkspaceDirectoriesRequest"}, "output":{"shape":"DescribeWorkspaceDirectoriesResult"}, "errors":[ {"shape":"InvalidParameterValuesException"} ], "documentation":"

Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

" }, "DescribeWorkspaces":{ "name":"DescribeWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWorkspacesRequest"}, "output":{"shape":"DescribeWorkspacesResult"}, "errors":[ {"shape":"InvalidParameterValuesException"}, {"shape":"ResourceUnavailableException"} ], "documentation":"

Obtains information about the specified WorkSpaces.

Only one of the filter parameters, such as BundleId, DirectoryId, or WorkspaceIds, can be specified at a time.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

" }, "DescribeWorkspacesConnectionStatus":{ "name":"DescribeWorkspacesConnectionStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeWorkspacesConnectionStatusRequest"}, "output":{"shape":"DescribeWorkspacesConnectionStatusResult"}, "errors":[ {"shape":"InvalidParameterValuesException"} ], "documentation":"

Describes the connection status of a specified WorkSpace.

" }, "ModifyWorkspaceProperties":{ "name":"ModifyWorkspaceProperties", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ModifyWorkspacePropertiesRequest"}, "output":{"shape":"ModifyWorkspacePropertiesResult"}, "errors":[ {"shape":"InvalidParameterValuesException"}, {"shape":"InvalidResourceStateException"}, {"shape":"OperationInProgressException"}, {"shape":"UnsupportedWorkspaceConfigurationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceUnavailableException"} ], "documentation":"

Modifies the WorkSpace properties, including the RunningMode and AutoStop time.

" }, "RebootWorkspaces":{ "name":"RebootWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebootWorkspacesRequest"}, "output":{"shape":"RebootWorkspacesResult"}, "documentation":"

Reboots the specified WorkSpaces.

To be able to reboot a WorkSpace, the WorkSpace must have a State of AVAILABLE, IMPAIRED, or INOPERABLE.

This operation is asynchronous and returns before the WorkSpaces have rebooted.

" }, "RebuildWorkspaces":{ "name":"RebuildWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RebuildWorkspacesRequest"}, "output":{"shape":"RebuildWorkspacesResult"}, "documentation":"

Rebuilds the specified WorkSpaces.

Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur:

  • The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost.

  • The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old.

To be able to rebuild a WorkSpace, the WorkSpace must have a State of AVAILABLE or ERROR.

This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.

" }, "StartWorkspaces":{ "name":"StartWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartWorkspacesRequest"}, "output":{"shape":"StartWorkspacesResult"}, "documentation":"

Starts the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to “STOPPED.”

" }, "StopWorkspaces":{ "name":"StopWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopWorkspacesRequest"}, "output":{"shape":"StopWorkspacesResult"}, "documentation":"

Stops the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

" }, "TerminateWorkspaces":{ "name":"TerminateWorkspaces", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TerminateWorkspacesRequest"}, "output":{"shape":"TerminateWorkspacesResult"}, "documentation":"

Terminates the specified WorkSpaces.

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace.

You can terminate a WorkSpace that is in any state except SUSPENDED.

This operation is asynchronous and returns before the WorkSpaces have been completely terminated.

" } }, "shapes":{ "ARN":{ "type":"string", "pattern":"^arn:aws:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$" }, "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "exception":true }, "Alias":{"type":"string"}, "BooleanObject":{"type":"boolean"}, "BundleId":{ "type":"string", "pattern":"^wsb-[0-9a-z]{8,63}$" }, "BundleIdList":{ "type":"list", "member":{"shape":"BundleId"}, "max":25, "min":1 }, "BundleList":{ "type":"list", "member":{"shape":"WorkspaceBundle"} }, "BundleOwner":{"type":"string"}, "Compute":{ "type":"string", "enum":[ "VALUE", "STANDARD", "PERFORMANCE" ] }, "ComputeType":{ "type":"structure", "members":{ "Name":{ "shape":"Compute", "documentation":"

The name of the compute type for the bundle.

" } }, "documentation":"

Contains information about the compute type of a WorkSpace bundle.

" }, "ComputerName":{"type":"string"}, "ConnectionState":{ "type":"string", "enum":[ "CONNECTED", "DISCONNECTED", "UNKNOWN" ] }, "CreateTagsRequest":{ "type":"structure", "required":[ "ResourceId", "Tags" ], "members":{ "ResourceId":{ "shape":"NonEmptyString", "documentation":"

The resource ID of the request.

" }, "Tags":{ "shape":"TagList", "documentation":"

The tags of the request.

" } }, "documentation":"

The request of the CreateTags operation.

" }, "CreateTagsResult":{ "type":"structure", "members":{ }, "documentation":"

The result of the CreateTags operation.

" }, "CreateWorkspacesRequest":{ "type":"structure", "required":["Workspaces"], "members":{ "Workspaces":{ "shape":"WorkspaceRequestList", "documentation":"

An array of structures that specify the WorkSpaces to create.

" } }, "documentation":"

Contains the inputs for the CreateWorkspaces operation.

" }, "CreateWorkspacesResult":{ "type":"structure", "members":{ "FailedRequests":{ "shape":"FailedCreateWorkspaceRequests", "documentation":"

An array of structures that represent the WorkSpaces that could not be created.

" }, "PendingRequests":{ "shape":"WorkspaceList", "documentation":"

An array of structures that represent the WorkSpaces that were created.

Because this operation is asynchronous, the identifier in WorkspaceId is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information will be returned.

" } }, "documentation":"

Contains the result of the CreateWorkspaces operation.

" }, "DefaultOu":{"type":"string"}, "DefaultWorkspaceCreationProperties":{ "type":"structure", "members":{ "EnableWorkDocs":{ "shape":"BooleanObject", "documentation":"

Specifies if the directory is enabled for Amazon WorkDocs.

" }, "EnableInternetAccess":{ "shape":"BooleanObject", "documentation":"

A public IP address will be attached to all WorkSpaces that are created or rebuilt.

" }, "DefaultOu":{ "shape":"DefaultOu", "documentation":"

The organizational unit (OU) in the directory that the WorkSpace machine accounts are placed in.

" }, "CustomSecurityGroupId":{ "shape":"SecurityGroupId", "documentation":"

The identifier of any custom security groups that are applied to the WorkSpaces when they are created.

" }, "UserEnabledAsLocalAdministrator":{ "shape":"BooleanObject", "documentation":"

The WorkSpace user is an administrator on the WorkSpace.

" } }, "documentation":"

Contains default WorkSpace creation information.

" }, "DeleteTagsRequest":{ "type":"structure", "required":[ "ResourceId", "TagKeys" ], "members":{ "ResourceId":{ "shape":"NonEmptyString", "documentation":"

The resource ID of the request.

" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

The tag keys of the request.

" } }, "documentation":"

The request of the DeleteTags operation.

" }, "DeleteTagsResult":{ "type":"structure", "members":{ }, "documentation":"

The result of the DeleteTags operation.

" }, "DescribeTagsRequest":{ "type":"structure", "required":["ResourceId"], "members":{ "ResourceId":{ "shape":"NonEmptyString", "documentation":"

The resource ID of the request.

" } }, "documentation":"

The request of the DescribeTags operation.

" }, "DescribeTagsResult":{ "type":"structure", "members":{ "TagList":{ "shape":"TagList", "documentation":"

The list of tags.

" } }, "documentation":"

The result of the DescribeTags operation.

" }, "DescribeWorkspaceBundlesRequest":{ "type":"structure", "members":{ "BundleIds":{ "shape":"BundleIdList", "documentation":"

An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

" }, "Owner":{ "shape":"BundleOwner", "documentation":"

The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.

This contains one of the following values:

  • null- Retrieves the bundles that belong to the account making the call.

  • AMAZON- Retrieves the bundles that are provided by AWS.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

The NextToken value from a previous call to this operation. Pass null if this is the first call.

" } }, "documentation":"

Contains the inputs for the DescribeWorkspaceBundles operation.

" }, "DescribeWorkspaceBundlesResult":{ "type":"structure", "members":{ "Bundles":{ "shape":"BundleList", "documentation":"

An array of structures that contain information about the bundles.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to this operation to retrieve the next set of items. This token is valid for one day and must be used within that time frame.

" } }, "documentation":"

Contains the results of the DescribeWorkspaceBundles operation.

" }, "DescribeWorkspaceDirectoriesRequest":{ "type":"structure", "members":{ "DirectoryIds":{ "shape":"DirectoryIdList", "documentation":"

An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

The NextToken value from a previous call to this operation. Pass null if this is the first call.

" } }, "documentation":"

Contains the inputs for the DescribeWorkspaceDirectories operation.

" }, "DescribeWorkspaceDirectoriesResult":{ "type":"structure", "members":{ "Directories":{ "shape":"DirectoryList", "documentation":"

An array of structures that contain information about the directories.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to this operation to retrieve the next set of items. This token is valid for one day and must be used within that time frame.

" } }, "documentation":"

Contains the results of the DescribeWorkspaceDirectories operation.

" }, "DescribeWorkspacesConnectionStatusRequest":{ "type":"structure", "members":{ "WorkspaceIds":{ "shape":"WorkspaceIdList", "documentation":"

An array of strings that contain the identifiers of the WorkSpaces.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

The next token of the request.

" } } }, "DescribeWorkspacesConnectionStatusResult":{ "type":"structure", "members":{ "WorkspacesConnectionStatus":{ "shape":"WorkspaceConnectionStatusList", "documentation":"

The connection status of the WorkSpace.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

The next token of the result.

" } } }, "DescribeWorkspacesRequest":{ "type":"structure", "members":{ "WorkspaceIds":{ "shape":"WorkspaceIdList", "documentation":"

An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.

Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

" }, "DirectoryId":{ "shape":"DirectoryId", "documentation":"

Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with the UserName parameter. This parameter cannot be combined with any other filter parameter.

" }, "UserName":{ "shape":"UserName", "documentation":"

Used with the DirectoryId parameter to specify the directory user for whom to obtain the WorkSpace.

" }, "BundleId":{ "shape":"BundleId", "documentation":"

The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter.

" }, "Limit":{ "shape":"Limit", "documentation":"

The maximum number of items to return.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

The NextToken value from a previous call to this operation. Pass null if this is the first call.

" } }, "documentation":"

Contains the inputs for the DescribeWorkspaces operation.

" }, "DescribeWorkspacesResult":{ "type":"structure", "members":{ "Workspaces":{ "shape":"WorkspaceList", "documentation":"

An array of structures that contain the information about the WorkSpaces.

Because the CreateWorkspaces operation is asynchronous, some of this information may be incomplete for a newly-created WorkSpace.

" }, "NextToken":{ "shape":"PaginationToken", "documentation":"

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to this operation to retrieve the next set of items. This token is valid for one day and must be used within that time frame.

" } }, "documentation":"

Contains the results for the DescribeWorkspaces operation.

" }, "Description":{"type":"string"}, "DirectoryId":{ "type":"string", "pattern":"^d-[0-9a-f]{8,63}$" }, "DirectoryIdList":{ "type":"list", "member":{"shape":"DirectoryId"}, "max":25, "min":1 }, "DirectoryList":{ "type":"list", "member":{"shape":"WorkspaceDirectory"} }, "DirectoryName":{"type":"string"}, "DnsIpAddresses":{ "type":"list", "member":{"shape":"IpAddress"} }, "ErrorType":{"type":"string"}, "ExceptionMessage":{"type":"string"}, "FailedCreateWorkspaceRequest":{ "type":"structure", "members":{ "WorkspaceRequest":{ "shape":"WorkspaceRequest", "documentation":"

A FailedCreateWorkspaceRequest$WorkspaceRequest object that contains the information about the WorkSpace that could not be created.

" }, "ErrorCode":{ "shape":"ErrorType", "documentation":"

The error code.

" }, "ErrorMessage":{ "shape":"Description", "documentation":"

The textual error message.

" } }, "documentation":"

Contains information about a WorkSpace that could not be created.

" }, "FailedCreateWorkspaceRequests":{ "type":"list", "member":{"shape":"FailedCreateWorkspaceRequest"} }, "FailedRebootWorkspaceRequests":{ "type":"list", "member":{"shape":"FailedWorkspaceChangeRequest"} }, "FailedRebuildWorkspaceRequests":{ "type":"list", "member":{"shape":"FailedWorkspaceChangeRequest"} }, "FailedStartWorkspaceRequests":{ "type":"list", "member":{"shape":"FailedWorkspaceChangeRequest"} }, "FailedStopWorkspaceRequests":{ "type":"list", "member":{"shape":"FailedWorkspaceChangeRequest"} }, "FailedTerminateWorkspaceRequests":{ "type":"list", "member":{"shape":"FailedWorkspaceChangeRequest"} }, "FailedWorkspaceChangeRequest":{ "type":"structure", "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The identifier of the WorkSpace.

" }, "ErrorCode":{ "shape":"ErrorType", "documentation":"

The error code.

" }, "ErrorMessage":{ "shape":"Description", "documentation":"

The textual error message.

" } }, "documentation":"

Contains information about a WorkSpace that could not be rebooted (RebootWorkspaces), rebuilt (RebuildWorkspaces), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).

" }, "InvalidParameterValuesException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The exception error message.

" } }, "documentation":"

One or more parameter values are not valid.

", "exception":true }, "InvalidResourceStateException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"

The specified WorkSpace has an invalid state for this operation.

", "exception":true }, "IpAddress":{"type":"string"}, "Limit":{ "type":"integer", "max":25, "min":1 }, "ModifyWorkspacePropertiesRequest":{ "type":"structure", "required":[ "WorkspaceId", "WorkspaceProperties" ], "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The ID of the WorkSpace.

" }, "WorkspaceProperties":{ "shape":"WorkspaceProperties", "documentation":"

The WorkSpace properties of the request.

" } } }, "ModifyWorkspacePropertiesResult":{ "type":"structure", "members":{ } }, "NonEmptyString":{ "type":"string", "min":1 }, "OperationInProgressException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"

The properties of this WorkSpace are currently being modified. Try again in a moment.

", "exception":true }, "PaginationToken":{ "type":"string", "max":63, "min":1 }, "RebootRequest":{ "type":"structure", "required":["WorkspaceId"], "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The identifier of the WorkSpace to reboot.

" } }, "documentation":"

Contains information used with the RebootWorkspaces operation to reboot a WorkSpace.

" }, "RebootWorkspaceRequests":{ "type":"list", "member":{"shape":"RebootRequest"}, "max":25, "min":1 }, "RebootWorkspacesRequest":{ "type":"structure", "required":["RebootWorkspaceRequests"], "members":{ "RebootWorkspaceRequests":{ "shape":"RebootWorkspaceRequests", "documentation":"

An array of structures that specify the WorkSpaces to reboot.

" } }, "documentation":"

Contains the inputs for the RebootWorkspaces operation.

" }, "RebootWorkspacesResult":{ "type":"structure", "members":{ "FailedRequests":{ "shape":"FailedRebootWorkspaceRequests", "documentation":"

An array of structures representing any WorkSpaces that could not be rebooted.

" } }, "documentation":"

Contains the results of the RebootWorkspaces operation.

" }, "RebuildRequest":{ "type":"structure", "required":["WorkspaceId"], "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The identifier of the WorkSpace to rebuild.

" } }, "documentation":"

Contains information used with the RebuildWorkspaces operation to rebuild a WorkSpace.

" }, "RebuildWorkspaceRequests":{ "type":"list", "member":{"shape":"RebuildRequest"}, "max":1, "min":1 }, "RebuildWorkspacesRequest":{ "type":"structure", "required":["RebuildWorkspaceRequests"], "members":{ "RebuildWorkspaceRequests":{ "shape":"RebuildWorkspaceRequests", "documentation":"

An array of structures that specify the WorkSpaces to rebuild.

" } }, "documentation":"

Contains the inputs for the RebuildWorkspaces operation.

" }, "RebuildWorkspacesResult":{ "type":"structure", "members":{ "FailedRequests":{ "shape":"FailedRebuildWorkspaceRequests", "documentation":"

An array of structures representing any WorkSpaces that could not be rebuilt.

" } }, "documentation":"

Contains the results of the RebuildWorkspaces operation.

" }, "RegistrationCode":{ "type":"string", "max":20, "min":1 }, "ResourceLimitExceededException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The exception error message.

" } }, "documentation":"

Your resource limits have been exceeded.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The resource could not be found.

" }, "ResourceId":{ "shape":"NonEmptyString", "documentation":"

The resource could not be found.

" } }, "documentation":"

The resource could not be found.

", "exception":true }, "ResourceUnavailableException":{ "type":"structure", "members":{ "message":{ "shape":"ExceptionMessage", "documentation":"

The exception error message.

" }, "ResourceId":{ "shape":"NonEmptyString", "documentation":"

The identifier of the resource that is not available.

" } }, "documentation":"

The specified resource is not available.

", "exception":true }, "RunningMode":{ "type":"string", "enum":[ "AUTO_STOP", "ALWAYS_ON" ] }, "RunningModeAutoStopTimeoutInMinutes":{"type":"integer"}, "SecurityGroupId":{ "type":"string", "pattern":"^(sg-[0-9a-f]{8})$" }, "StartRequest":{ "type":"structure", "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The ID of the WorkSpace.

" } }, "documentation":"

Describes the start request.

" }, "StartWorkspaceRequests":{ "type":"list", "member":{"shape":"StartRequest"}, "max":25, "min":1 }, "StartWorkspacesRequest":{ "type":"structure", "required":["StartWorkspaceRequests"], "members":{ "StartWorkspaceRequests":{ "shape":"StartWorkspaceRequests", "documentation":"

The requests.

" } } }, "StartWorkspacesResult":{ "type":"structure", "members":{ "FailedRequests":{ "shape":"FailedStartWorkspaceRequests", "documentation":"

The failed requests.

" } } }, "StopRequest":{ "type":"structure", "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The ID of the WorkSpace.

" } }, "documentation":"

Describes the stop request.

" }, "StopWorkspaceRequests":{ "type":"list", "member":{"shape":"StopRequest"}, "max":25, "min":1 }, "StopWorkspacesRequest":{ "type":"structure", "required":["StopWorkspaceRequests"], "members":{ "StopWorkspaceRequests":{ "shape":"StopWorkspaceRequests", "documentation":"

The requests.

" } } }, "StopWorkspacesResult":{ "type":"structure", "members":{ "FailedRequests":{ "shape":"FailedStopWorkspaceRequests", "documentation":"

The failed requests.

" } } }, "SubnetId":{ "type":"string", "pattern":"^(subnet-[0-9a-f]{8})$" }, "SubnetIds":{ "type":"list", "member":{"shape":"SubnetId"} }, "Tag":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"TagKey", "documentation":"

The key of the tag.

" }, "Value":{ "shape":"TagValue", "documentation":"

The value of the tag.

" } }, "documentation":"

Describes the tag of the WorkSpace.

" }, "TagKey":{ "type":"string", "max":127, "min":1 }, "TagKeyList":{ "type":"list", "member":{"shape":"NonEmptyString"} }, "TagList":{ "type":"list", "member":{"shape":"Tag"} }, "TagValue":{ "type":"string", "max":255 }, "TerminateRequest":{ "type":"structure", "required":["WorkspaceId"], "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The identifier of the WorkSpace to terminate.

" } }, "documentation":"

Contains information used with the TerminateWorkspaces operation to terminate a WorkSpace.

" }, "TerminateWorkspaceRequests":{ "type":"list", "member":{"shape":"TerminateRequest"}, "max":25, "min":1 }, "TerminateWorkspacesRequest":{ "type":"structure", "required":["TerminateWorkspaceRequests"], "members":{ "TerminateWorkspaceRequests":{ "shape":"TerminateWorkspaceRequests", "documentation":"

An array of structures that specify the WorkSpaces to terminate.

" } }, "documentation":"

Contains the inputs for the TerminateWorkspaces operation.

" }, "TerminateWorkspacesResult":{ "type":"structure", "members":{ "FailedRequests":{ "shape":"FailedTerminateWorkspaceRequests", "documentation":"

An array of structures representing any WorkSpaces that could not be terminated.

" } }, "documentation":"

Contains the results of the TerminateWorkspaces operation.

" }, "Timestamp":{"type":"timestamp"}, "UnsupportedWorkspaceConfigurationException":{ "type":"structure", "members":{ "message":{"shape":"ExceptionMessage"} }, "documentation":"

The WorkSpace does not have the supported configuration for this operation. For more information, see the Amazon WorkSpaces Administration Guide.

", "exception":true }, "UserName":{ "type":"string", "max":63, "min":1 }, "UserStorage":{ "type":"structure", "members":{ "Capacity":{ "shape":"NonEmptyString", "documentation":"

The amount of user storage for the bundle.

" } }, "documentation":"

Contains information about the user storage for a WorkSpace bundle.

" }, "VolumeEncryptionKey":{"type":"string"}, "Workspace":{ "type":"structure", "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The identifier of the WorkSpace.

" }, "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the AWS Directory Service directory that the WorkSpace belongs to.

" }, "UserName":{ "shape":"UserName", "documentation":"

The user that the WorkSpace is assigned to.

" }, "IpAddress":{ "shape":"IpAddress", "documentation":"

The IP address of the WorkSpace.

" }, "State":{ "shape":"WorkspaceState", "documentation":"

The operational state of the WorkSpace.

" }, "BundleId":{ "shape":"BundleId", "documentation":"

The identifier of the bundle that the WorkSpace was created from.

" }, "SubnetId":{ "shape":"SubnetId", "documentation":"

The identifier of the subnet that the WorkSpace is in.

" }, "ErrorMessage":{ "shape":"Description", "documentation":"

If the WorkSpace could not be created, this contains a textual error message that describes the failure.

" }, "ErrorCode":{ "shape":"WorkspaceErrorCode", "documentation":"

If the WorkSpace could not be created, this contains the error code.

" }, "ComputerName":{ "shape":"ComputerName", "documentation":"

The name of the WorkSpace as seen by the operating system.

" }, "VolumeEncryptionKey":{ "shape":"VolumeEncryptionKey", "documentation":"

The KMS key used to encrypt data stored on your WorkSpace.

" }, "UserVolumeEncryptionEnabled":{ "shape":"BooleanObject", "documentation":"

Specifies whether the data stored on the user volume, or D: drive, is encrypted.

" }, "RootVolumeEncryptionEnabled":{ "shape":"BooleanObject", "documentation":"

Specifies whether the data stored on the root volume, or C: drive, is encrypted.

" }, "WorkspaceProperties":{"shape":"WorkspaceProperties"} }, "documentation":"

Contains information about a WorkSpace.

" }, "WorkspaceBundle":{ "type":"structure", "members":{ "BundleId":{ "shape":"BundleId", "documentation":"

The bundle identifier.

" }, "Name":{ "shape":"NonEmptyString", "documentation":"

The name of the bundle.

" }, "Owner":{ "shape":"BundleOwner", "documentation":"

The owner of the bundle. This contains the owner's account identifier, or AMAZON if the bundle is provided by AWS.

" }, "Description":{ "shape":"Description", "documentation":"

The bundle description.

" }, "UserStorage":{ "shape":"UserStorage", "documentation":"

A UserStorage object that specifies the amount of user storage that the bundle contains.

" }, "ComputeType":{ "shape":"ComputeType", "documentation":"

A ComputeType object that specifies the compute type for the bundle.

" } }, "documentation":"

Contains information about a WorkSpace bundle.

" }, "WorkspaceConnectionStatus":{ "type":"structure", "members":{ "WorkspaceId":{ "shape":"WorkspaceId", "documentation":"

The ID of the WorkSpace.

" }, "ConnectionState":{ "shape":"ConnectionState", "documentation":"

The connection state of the WorkSpace. Returns UNKOWN if the WorkSpace is in a Stopped state.

" }, "ConnectionStateCheckTimestamp":{ "shape":"Timestamp", "documentation":"

The timestamp of the connection state check.

" }, "LastKnownUserConnectionTimestamp":{ "shape":"Timestamp", "documentation":"

The timestamp of the last known user connection.

" } }, "documentation":"

Describes the connection status of a WorkSpace.

" }, "WorkspaceConnectionStatusList":{ "type":"list", "member":{"shape":"WorkspaceConnectionStatus"} }, "WorkspaceDirectory":{ "type":"structure", "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The directory identifier.

" }, "Alias":{ "shape":"Alias", "documentation":"

The directory alias.

" }, "DirectoryName":{ "shape":"DirectoryName", "documentation":"

The name of the directory.

" }, "RegistrationCode":{ "shape":"RegistrationCode", "documentation":"

The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

" }, "SubnetIds":{ "shape":"SubnetIds", "documentation":"

An array of strings that contains the identifiers of the subnets used with the directory.

" }, "DnsIpAddresses":{ "shape":"DnsIpAddresses", "documentation":"

An array of strings that contains the IP addresses of the DNS servers for the directory.

" }, "CustomerUserName":{ "shape":"UserName", "documentation":"

The user name for the service account.

" }, "IamRoleId":{ "shape":"ARN", "documentation":"

The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

" }, "DirectoryType":{ "shape":"WorkspaceDirectoryType", "documentation":"

The directory type.

" }, "WorkspaceSecurityGroupId":{ "shape":"SecurityGroupId", "documentation":"

The identifier of the security group that is assigned to new WorkSpaces.

" }, "State":{ "shape":"WorkspaceDirectoryState", "documentation":"

The state of the directory's registration with Amazon WorkSpaces

" }, "WorkspaceCreationProperties":{ "shape":"DefaultWorkspaceCreationProperties", "documentation":"

A structure that specifies the default creation properties for all WorkSpaces in the directory.

" } }, "documentation":"

Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces.

" }, "WorkspaceDirectoryState":{ "type":"string", "enum":[ "REGISTERING", "REGISTERED", "DEREGISTERING", "DEREGISTERED", "ERROR" ] }, "WorkspaceDirectoryType":{ "type":"string", "enum":[ "SIMPLE_AD", "AD_CONNECTOR" ] }, "WorkspaceErrorCode":{"type":"string"}, "WorkspaceId":{ "type":"string", "pattern":"^ws-[0-9a-z]{8,63}$" }, "WorkspaceIdList":{ "type":"list", "member":{"shape":"WorkspaceId"}, "max":25, "min":1 }, "WorkspaceList":{ "type":"list", "member":{"shape":"Workspace"} }, "WorkspaceProperties":{ "type":"structure", "members":{ "RunningMode":{ "shape":"RunningMode", "documentation":"

The running mode of the WorkSpace. AlwaysOn WorkSpaces are billed monthly. AutoStop WorkSpaces are billed by the hour and stopped when no longer being used in order to save on costs.

" }, "RunningModeAutoStopTimeoutInMinutes":{ "shape":"RunningModeAutoStopTimeoutInMinutes", "documentation":"

The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals.

" } }, "documentation":"

Describes the properties of a WorkSpace.

" }, "WorkspaceRequest":{ "type":"structure", "required":[ "DirectoryId", "UserName", "BundleId" ], "members":{ "DirectoryId":{ "shape":"DirectoryId", "documentation":"

The identifier of the AWS Directory Service directory to create the WorkSpace in. You can use the DescribeWorkspaceDirectories operation to obtain a list of the directories that are available.

" }, "UserName":{ "shape":"UserName", "documentation":"

The username that the WorkSpace is assigned to. This username must exist in the AWS Directory Service directory specified by the DirectoryId member.

" }, "BundleId":{ "shape":"BundleId", "documentation":"

The identifier of the bundle to create the WorkSpace from. You can use the DescribeWorkspaceBundles operation to obtain a list of the bundles that are available.

" }, "VolumeEncryptionKey":{ "shape":"VolumeEncryptionKey", "documentation":"

The KMS key used to encrypt data stored on your WorkSpace.

" }, "UserVolumeEncryptionEnabled":{ "shape":"BooleanObject", "documentation":"

Specifies whether the data stored on the user volume, or D: drive, is encrypted.

" }, "RootVolumeEncryptionEnabled":{ "shape":"BooleanObject", "documentation":"

Specifies whether the data stored on the root volume, or C: drive, is encrypted.

" }, "WorkspaceProperties":{"shape":"WorkspaceProperties"}, "Tags":{ "shape":"TagList", "documentation":"

The tags of the WorkSpace request.

" } }, "documentation":"

Contains information about a WorkSpace creation request.

" }, "WorkspaceRequestList":{ "type":"list", "member":{"shape":"WorkspaceRequest"}, "max":25, "min":1 }, "WorkspaceState":{ "type":"string", "enum":[ "PENDING", "AVAILABLE", "IMPAIRED", "UNHEALTHY", "REBOOTING", "STARTING", "REBUILDING", "MAINTENANCE", "TERMINATING", "TERMINATED", "SUSPENDED", "STOPPING", "STOPPED", "ERROR" ] } }, "documentation":"Amazon WorkSpaces Service

This reference provides detailed information about the Amazon WorkSpaces operations.

" } botocore-1.5.7/botocore/data/xray/0000777454262600001440000000000013042511307020116 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/xray/2016-04-12/0000777454262600001440000000000013042511307021147 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/xray/2016-04-12/service-2.json0000666454262600001440000007451713042511306023656 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-04-12", "endpointPrefix":"xray", "protocol":"rest-json", "serviceFullName":"AWS X-Ray", "signatureVersion":"v4", "uid":"xray-2016-04-12" }, "operations":{ "BatchGetTraces":{ "name":"BatchGetTraces", "http":{ "method":"POST", "requestUri":"/Traces" }, "input":{"shape":"BatchGetTracesRequest"}, "output":{"shape":"BatchGetTracesResult"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ThrottledException"} ], "documentation":"

Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.

" }, "GetServiceGraph":{ "name":"GetServiceGraph", "http":{ "method":"POST", "requestUri":"/ServiceGraph" }, "input":{"shape":"GetServiceGraphRequest"}, "output":{"shape":"GetServiceGraphResult"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ThrottledException"} ], "documentation":"

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.

" }, "GetTraceGraph":{ "name":"GetTraceGraph", "http":{ "method":"POST", "requestUri":"/TraceGraph" }, "input":{"shape":"GetTraceGraphRequest"}, "output":{"shape":"GetTraceGraphResult"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ThrottledException"} ], "documentation":"

Retrieves a service graph for one or more specific trace IDs.

" }, "GetTraceSummaries":{ "name":"GetTraceSummaries", "http":{ "method":"POST", "requestUri":"/TraceSummaries" }, "input":{"shape":"GetTraceSummariesRequest"}, "output":{"shape":"GetTraceSummariesResult"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ThrottledException"} ], "documentation":"

Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces.

" }, "PutTelemetryRecords":{ "name":"PutTelemetryRecords", "http":{ "method":"POST", "requestUri":"/TelemetryRecords" }, "input":{"shape":"PutTelemetryRecordsRequest"}, "output":{"shape":"PutTelemetryRecordsResult"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ThrottledException"} ], "documentation":"

Used by the AWS X-Ray daemon to upload telemetry.

" }, "PutTraceSegments":{ "name":"PutTraceSegments", "http":{ "method":"POST", "requestUri":"/TraceSegments" }, "input":{"shape":"PutTraceSegmentsRequest"}, "output":{"shape":"PutTraceSegmentsResult"}, "errors":[ {"shape":"InvalidRequestException"}, {"shape":"ThrottledException"} ], "documentation":"

Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.

" } }, "shapes":{ "Alias":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The canonical name of the alias.

" }, "Names":{ "shape":"AliasNames", "documentation":"

A list of names for the alias, including the canonical name.

" }, "Type":{ "shape":"String", "documentation":"

The type of the alias.

" } }, "documentation":"

An alias for an edge.

" }, "AliasList":{ "type":"list", "member":{"shape":"Alias"} }, "AliasNames":{ "type":"list", "member":{"shape":"String"} }, "AnnotationKey":{"type":"string"}, "AnnotationValue":{ "type":"structure", "members":{ "NumberValue":{ "shape":"NullableDouble", "documentation":"

Value for a Number annotation.

" }, "BooleanValue":{ "shape":"NullableBoolean", "documentation":"

Value for a Boolean annotation.

" }, "StringValue":{ "shape":"String", "documentation":"

Value for a String annotation.

" } }, "documentation":"

Value of a segment annotation. Has one of three value types: Number, Boolean or String.

" }, "Annotations":{ "type":"map", "key":{"shape":"AnnotationKey"}, "value":{"shape":"ValuesWithServiceIds"} }, "BackendConnectionErrors":{ "type":"structure", "members":{ "TimeoutCount":{ "shape":"NullableInteger", "documentation":"

" }, "ConnectionRefusedCount":{ "shape":"NullableInteger", "documentation":"

" }, "HTTPCode4XXCount":{ "shape":"NullableInteger", "documentation":"

" }, "HTTPCode5XXCount":{ "shape":"NullableInteger", "documentation":"

" }, "UnknownHostCount":{ "shape":"NullableInteger", "documentation":"

" }, "OtherCount":{ "shape":"NullableInteger", "documentation":"

" } }, "documentation":"

" }, "BatchGetTracesRequest":{ "type":"structure", "required":["TraceIds"], "members":{ "TraceIds":{ "shape":"TraceIdList", "documentation":"

Specify the trace IDs of requests for which to retrieve segments.

" }, "NextToken":{ "shape":"String", "documentation":"

Pagination token. Not used.

" } } }, "BatchGetTracesResult":{ "type":"structure", "members":{ "Traces":{ "shape":"TraceList", "documentation":"

Full traces for the specified requests.

" }, "UnprocessedTraceIds":{ "shape":"UnprocessedTraceIdList", "documentation":"

Trace IDs of requests that haven't been processed.

" }, "NextToken":{ "shape":"String", "documentation":"

Pagination token. Not used.

" } } }, "Double":{"type":"double"}, "Edge":{ "type":"structure", "members":{ "ReferenceId":{ "shape":"NullableInteger", "documentation":"

Identifier of the edge. Unique within a service map.

" }, "StartTime":{ "shape":"Timestamp", "documentation":"

The start time of the first segment on the edge.

" }, "EndTime":{ "shape":"Timestamp", "documentation":"

The end time of the last segment on the edge.

" }, "SummaryStatistics":{ "shape":"EdgeStatistics", "documentation":"

Response statistics for segments on the edge.

" }, "ResponseTimeHistogram":{ "shape":"Histogram", "documentation":"

Histogram describing the prominence of response times on the edge.

" }, "Aliases":{ "shape":"AliasList", "documentation":"

Aliases for the edge.

" } }, "documentation":"

Information about a connection between two services.

" }, "EdgeList":{ "type":"list", "member":{"shape":"Edge"} }, "EdgeStatistics":{ "type":"structure", "members":{ "OkCount":{ "shape":"NullableLong", "documentation":"

The number of requests that completed with a 2xx Success status code.

" }, "ErrorStatistics":{ "shape":"ErrorStatistics", "documentation":"

Information about requests that failed with a 4xx Client Error status code.

" }, "FaultStatistics":{ "shape":"FaultStatistics", "documentation":"

Information about requests that failed with a 5xx Server Error status code.

" }, "TotalCount":{ "shape":"NullableLong", "documentation":"

The total number of completed requests.

" }, "TotalResponseTime":{ "shape":"NullableDouble", "documentation":"

The aggregate response time of completed requests.

" } }, "documentation":"

Response statistics for an edge.

" }, "ErrorStatistics":{ "type":"structure", "members":{ "ThrottleCount":{ "shape":"NullableLong", "documentation":"

The number of requests that failed with a 419 throttling status code.

" }, "OtherCount":{ "shape":"NullableLong", "documentation":"

The number of requests that failed with untracked 4xx Client Error status codes.

" }, "TotalCount":{ "shape":"NullableLong", "documentation":"

The total number of requests that failed with a 4xx Client Error status code.

" } }, "documentation":"

Information about requests that failed with a 4xx Client Error status code.

" }, "FaultStatistics":{ "type":"structure", "members":{ "OtherCount":{ "shape":"NullableLong", "documentation":"

The number of requests that failed with untracked 5xx Server Error status codes.

" }, "TotalCount":{ "shape":"NullableLong", "documentation":"

The total number of requests that failed with a 5xx Server Error status code.

" } }, "documentation":"

Information about requests that failed with a 5xx Server Error status code.

" }, "FilterExpression":{ "type":"string", "max":2000, "min":0 }, "GetServiceGraphRequest":{ "type":"structure", "required":[ "StartTime", "EndTime" ], "members":{ "StartTime":{ "shape":"Timestamp", "documentation":"

The start of the time frame for which to generate a graph.

" }, "EndTime":{ "shape":"Timestamp", "documentation":"

The end of the time frame for which to generate a graph.

" }, "NextToken":{ "shape":"String", "documentation":"

Pagination token. Not used.

" } } }, "GetServiceGraphResult":{ "type":"structure", "members":{ "StartTime":{ "shape":"Timestamp", "documentation":"

The start of the time frame for which the graph was generated.

" }, "EndTime":{ "shape":"Timestamp", "documentation":"

The end of the time frame for which the graph was generated.

" }, "Services":{ "shape":"ServiceList", "documentation":"

The services that have processed a traced request during the specified time frame.

" }, "NextToken":{ "shape":"String", "documentation":"

Pagination token. Not used.

" } } }, "GetTraceGraphRequest":{ "type":"structure", "required":["TraceIds"], "members":{ "TraceIds":{ "shape":"TraceIdList", "documentation":"

Trace IDs of requests for which to generate a service graph.

" }, "NextToken":{ "shape":"String", "documentation":"

Pagination token. Not used.

" } } }, "GetTraceGraphResult":{ "type":"structure", "members":{ "Services":{ "shape":"ServiceList", "documentation":"

The services that have processed one of the specified requests.

" }, "NextToken":{ "shape":"String", "documentation":"

Pagination token. Not used.

" } } }, "GetTraceSummariesRequest":{ "type":"structure", "required":[ "StartTime", "EndTime" ], "members":{ "StartTime":{ "shape":"Timestamp", "documentation":"

The start of the time frame for which to retrieve traces.

" }, "EndTime":{ "shape":"Timestamp", "documentation":"

The end of the time frame for which to retrieve traces.

" }, "Sampling":{ "shape":"NullableBoolean", "documentation":"

Set to true to get summaries for only a subset of available traces.

" }, "FilterExpression":{ "shape":"FilterExpression", "documentation":"

Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.

" }, "NextToken":{ "shape":"String", "documentation":"

Specify the pagination token returned by a previous request to retrieve the next page of results.

" } } }, "GetTraceSummariesResult":{ "type":"structure", "members":{ "TraceSummaries":{ "shape":"TraceSummaryList", "documentation":"

Trace IDs and metadata for traces that were found in the specified time frame.

" }, "ApproximateTime":{ "shape":"Timestamp", "documentation":"

The start time of this page of results.

" }, "TracesProcessedCount":{ "shape":"NullableLong", "documentation":"

The number of traces that were processed to get this set of summaries.

" }, "NextToken":{ "shape":"String", "documentation":"

If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most most recent results, closest to the end of the time frame.

" } } }, "Histogram":{ "type":"list", "member":{"shape":"HistogramEntry"} }, "HistogramEntry":{ "type":"structure", "members":{ "Value":{ "shape":"Double", "documentation":"

The value of the entry.

" }, "Count":{ "shape":"Integer", "documentation":"

The prevalence of the entry.

" } }, "documentation":"

An entry in a histogram for a statistic. A histogram maps the range of observed values on the X axis, and the prevalence of each value on the Y axis.

" }, "Http":{ "type":"structure", "members":{ "HttpURL":{ "shape":"String", "documentation":"

The request URL.

" }, "HttpStatus":{ "shape":"NullableInteger", "documentation":"

The response status.

" }, "HttpMethod":{ "shape":"String", "documentation":"

The request method.

" }, "UserAgent":{ "shape":"String", "documentation":"

The request's user agent string.

" }, "ClientIp":{ "shape":"String", "documentation":"

The IP address of the requestor.

" } }, "documentation":"

Information about an HTTP request.

" }, "Integer":{"type":"integer"}, "InvalidRequestException":{ "type":"structure", "members":{ }, "documentation":"

The request is missing required parameters or has invalid parameters.

", "exception":true }, "NullableBoolean":{"type":"boolean"}, "NullableDouble":{"type":"double"}, "NullableInteger":{"type":"integer"}, "NullableLong":{"type":"long"}, "PutTelemetryRecordsRequest":{ "type":"structure", "required":["TelemetryRecords"], "members":{ "TelemetryRecords":{ "shape":"TelemetryRecordList", "documentation":"

" }, "EC2InstanceId":{ "shape":"String", "documentation":"

" }, "Hostname":{ "shape":"String", "documentation":"

" }, "ResourceARN":{ "shape":"String", "documentation":"

" } } }, "PutTelemetryRecordsResult":{ "type":"structure", "members":{ } }, "PutTraceSegmentsRequest":{ "type":"structure", "required":["TraceSegmentDocuments"], "members":{ "TraceSegmentDocuments":{ "shape":"TraceSegmentDocumentList", "documentation":"

A JSON document defining one or more segments or subsegments. Segments must include the following fields.

Required Segment Document Fields

  • name - The name of the service that handled the request.

  • id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits.

  • trace_id - A unique identifier that connects all segments and subsegments originating from a single client request.

  • start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9.

  • end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress.

  • in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in progress segment when your application receives a request that will take a long time to serve, to trace the fact that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment.

A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes:

Trace ID Format

  • The version number, i.e. 1.

  • The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal.

  • A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.

" } } }, "PutTraceSegmentsResult":{ "type":"structure", "members":{ "UnprocessedTraceSegments":{ "shape":"UnprocessedTraceSegmentList", "documentation":"

Segments that failed processing.

" } } }, "Segment":{ "type":"structure", "members":{ "Id":{ "shape":"SegmentId", "documentation":"

The segment's ID.

" }, "Document":{ "shape":"SegmentDocument", "documentation":"

The segment document.

" } }, "documentation":"

Information about a segment

" }, "SegmentDocument":{ "type":"string", "min":1 }, "SegmentId":{ "type":"string", "max":16, "min":16 }, "SegmentList":{ "type":"list", "member":{"shape":"Segment"} }, "Service":{ "type":"structure", "members":{ "ReferenceId":{ "shape":"NullableInteger", "documentation":"

Identifier for the service. Unique within the service map.

" }, "Name":{ "shape":"String", "documentation":"

The canonical name of the service.

" }, "Names":{ "shape":"ServiceNames", "documentation":"

A list of names for the service, including the canonical name.

" }, "Root":{ "shape":"NullableBoolean", "documentation":"

Indicates that the service was the first service to process a request.

" }, "AccountId":{ "shape":"String", "documentation":"

Identifier of the AWS account in which the service runs.

" }, "Type":{ "shape":"String", "documentation":"

The type of service.

  • AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance for a application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.

  • AWS Service - The type of an AWS service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.

  • client - Represents the clients that sent requests to a root service.

  • remote - A downstream service of indeterminate type.

" }, "State":{ "shape":"String", "documentation":"

The service's state.

" }, "StartTime":{ "shape":"Timestamp", "documentation":"

The start time of the first segment that the service generated.

" }, "EndTime":{ "shape":"Timestamp", "documentation":"

The end time of the last segment that the service generated.

" }, "Edges":{ "shape":"EdgeList", "documentation":"

Connections to downstream services.

" }, "SummaryStatistics":{ "shape":"ServiceStatistics", "documentation":"

Aggregated statistics for the service.

" }, "DurationHistogram":{ "shape":"Histogram", "documentation":"

Histogram mapping the spread of trace durations

" } }, "documentation":"

Information about an application that processed requests, users that made requests, or downstream services, resources and applications that an application used.

" }, "ServiceId":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

" }, "Names":{ "shape":"ServiceNames", "documentation":"

" }, "AccountId":{ "shape":"String", "documentation":"

" }, "Type":{ "shape":"String", "documentation":"

" } }, "documentation":"

" }, "ServiceIds":{ "type":"list", "member":{"shape":"ServiceId"} }, "ServiceList":{ "type":"list", "member":{"shape":"Service"} }, "ServiceNames":{ "type":"list", "member":{"shape":"String"} }, "ServiceStatistics":{ "type":"structure", "members":{ "OkCount":{ "shape":"NullableLong", "documentation":"

The number of requests that completed with a 2xx Success status code.

" }, "ErrorStatistics":{ "shape":"ErrorStatistics", "documentation":"

Information about requests that failed with a 4xx Client Error status code.

" }, "FaultStatistics":{ "shape":"FaultStatistics", "documentation":"

Information about requests that failed with a 5xx Server Error status code.

" }, "TotalCount":{ "shape":"NullableLong", "documentation":"

The total number of completed requests.

" }, "TotalResponseTime":{ "shape":"NullableDouble", "documentation":"

The aggregate response time of completed requests.

" } }, "documentation":"

Response statistics for a service.

" }, "String":{"type":"string"}, "TelemetryRecord":{ "type":"structure", "members":{ "Timestamp":{ "shape":"Timestamp", "documentation":"

" }, "SegmentsReceivedCount":{ "shape":"NullableInteger", "documentation":"

" }, "SegmentsSentCount":{ "shape":"NullableInteger", "documentation":"

" }, "SegmentsSpilloverCount":{ "shape":"NullableInteger", "documentation":"

" }, "SegmentsRejectedCount":{ "shape":"NullableInteger", "documentation":"

" }, "BackendConnectionErrors":{ "shape":"BackendConnectionErrors", "documentation":"

" } }, "documentation":"

" }, "TelemetryRecordList":{ "type":"list", "member":{"shape":"TelemetryRecord"} }, "ThrottledException":{ "type":"structure", "members":{ }, "documentation":"

The request exceeds the maximum number of requests per second.

", "error":{"httpStatusCode":429}, "exception":true }, "Timestamp":{"type":"timestamp"}, "Trace":{ "type":"structure", "members":{ "Id":{ "shape":"TraceId", "documentation":"

The unique identifier for the request that generated the trace's segments and subsegments.

" }, "Duration":{ "shape":"NullableDouble", "documentation":"

The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.

" }, "Segments":{ "shape":"SegmentList", "documentation":"

Segment documents for the segments and subsegments that comprise the trace.

" } }, "documentation":"

A collection of segment documents with matching trace IDs.

" }, "TraceId":{ "type":"string", "max":35, "min":35 }, "TraceIdList":{ "type":"list", "member":{"shape":"TraceId"} }, "TraceList":{ "type":"list", "member":{"shape":"Trace"} }, "TraceSegmentDocument":{"type":"string"}, "TraceSegmentDocumentList":{ "type":"list", "member":{"shape":"TraceSegmentDocument"} }, "TraceSummary":{ "type":"structure", "members":{ "Id":{ "shape":"TraceId", "documentation":"

The unique identifier for the request that generated the trace's segments and subsegments.

" }, "Duration":{ "shape":"NullableDouble", "documentation":"

The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.

" }, "ResponseTime":{ "shape":"NullableDouble", "documentation":"

The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.

" }, "HasFault":{ "shape":"NullableBoolean", "documentation":"

One or more of the segment documents has a 500 series error.

" }, "HasError":{ "shape":"NullableBoolean", "documentation":"

One or more of the segment documents has a 400 series error.

" }, "HasThrottle":{ "shape":"NullableBoolean", "documentation":"

One or more of the segment documents has a 429 throttling error.

" }, "IsPartial":{ "shape":"NullableBoolean", "documentation":"

One or more of the segment documents is in progress.

" }, "Http":{ "shape":"Http", "documentation":"

Information about the HTTP request served by the trace.

" }, "Annotations":{ "shape":"Annotations", "documentation":"

Annotations from the trace's segment documents.

" }, "Users":{ "shape":"TraceUsers", "documentation":"

Users from the trace's segment documents.

" }, "ServiceIds":{ "shape":"ServiceIds", "documentation":"

Service IDs from the trace's segment documents.

" } }, "documentation":"

Metadata generated from the segment documents in a trace.

" }, "TraceSummaryList":{ "type":"list", "member":{"shape":"TraceSummary"} }, "TraceUser":{ "type":"structure", "members":{ "UserName":{ "shape":"String", "documentation":"

The user's name.

" }, "ServiceIds":{ "shape":"ServiceIds", "documentation":"

Services that the user's request hit.

" } }, "documentation":"

Information about a user recorded in segment documents.

" }, "TraceUsers":{ "type":"list", "member":{"shape":"TraceUser"} }, "UnprocessedTraceIdList":{ "type":"list", "member":{"shape":"TraceId"} }, "UnprocessedTraceSegment":{ "type":"structure", "members":{ "Id":{ "shape":"String", "documentation":"

The segment's ID.

" }, "ErrorCode":{ "shape":"String", "documentation":"

The error that caused processing to fail.

" }, "Message":{ "shape":"String", "documentation":"

The error message.

" } }, "documentation":"

Information about a segment that failed processing.

" }, "UnprocessedTraceSegmentList":{ "type":"list", "member":{"shape":"UnprocessedTraceSegment"} }, "ValueWithServiceIds":{ "type":"structure", "members":{ "AnnotationValue":{ "shape":"AnnotationValue", "documentation":"

Values of the annotation.

" }, "ServiceIds":{ "shape":"ServiceIds", "documentation":"

Services to which the annotation applies.

" } }, "documentation":"

Information about a segment annotation.

" }, "ValuesWithServiceIds":{ "type":"list", "member":{"shape":"ValueWithServiceIds"} } }, "documentation":"

AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.

" } botocore-1.5.7/botocore/data/cloudfront/0000777454262600001440000000000013042511307021312 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudfront/2015-04-17/0000777454262600001440000000000013042511307022347 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudfront/2015-04-17/waiters-2.json0000666454262600001440000000224013042511306025054 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DistributionDeployed": { "delay": 60, "operation": "GetDistribution", "maxAttempts": 25, "description": "Wait until a distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "Distribution.Status" } ] }, "InvalidationCompleted": { "delay": 20, "operation": "GetInvalidation", "maxAttempts": 60, "description": "Wait until an invalidation has completed.", "acceptors": [ { "expected": "Completed", "matcher": "path", "state": "success", "argument": "Invalidation.Status" } ] }, "StreamingDistributionDeployed": { "delay": 60, "operation": "GetStreamingDistribution", "maxAttempts": 25, "description": "Wait until a streaming distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "StreamingDistribution.Status" } ] } } } botocore-1.5.7/botocore/data/cloudfront/2015-04-17/paginators-1.json0000666454262600001440000000214613042511306025551 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListCloudFrontOriginAccessIdentities": { "input_token": "Marker", "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", "limit_key": "MaxItems", "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", "result_key": "CloudFrontOriginAccessIdentityList.Items" }, "ListDistributions": { "input_token": "Marker", "output_token": "DistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "DistributionList.IsTruncated", "result_key": "DistributionList.Items" }, "ListInvalidations": { "input_token": "Marker", "output_token": "InvalidationList.NextMarker", "limit_key": "MaxItems", "more_results": "InvalidationList.IsTruncated", "result_key": "InvalidationList.Items" }, "ListStreamingDistributions": { "input_token": "Marker", "output_token": "StreamingDistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "StreamingDistributionList.IsTruncated", "result_key": "StreamingDistributionList.Items" } } } botocore-1.5.7/botocore/data/cloudfront/2015-04-17/service-2.json0000666454262600001440000044643413042511306025057 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-04-17", "endpointPrefix":"cloudfront", "globalEndpoint":"cloudfront.amazonaws.com", "serviceAbbreviation":"CloudFront", "serviceFullName":"Amazon CloudFront", "signatureVersion":"v4", "protocol":"rest-xml" }, "operations":{ "CreateCloudFrontOriginAccessIdentity":{ "name":"CreateCloudFrontOriginAccessIdentity2015_04_17", "http":{ "method":"POST", "requestUri":"/2015-04-17/origin-access-identity/cloudfront", "responseCode":201 }, "input":{ "shape":"CreateCloudFrontOriginAccessIdentityRequest", "documentation":"The request to create a new origin access identity." }, "output":{ "shape":"CreateCloudFrontOriginAccessIdentityResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"CloudFrontOriginAccessIdentityAlreadyExists", "error":{"httpStatusCode":409}, "exception":true, "documentation":"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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"TooManyCloudFrontOriginAccessIdentities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Create a new origin access identity." }, "CreateDistribution":{ "name":"CreateDistribution2015_04_17", "http":{ "method":"POST", "requestUri":"/2015-04-17/distribution", "responseCode":201 }, "input":{ "shape":"CreateDistributionRequest", "documentation":"The request to create a new distribution." }, "output":{ "shape":"CreateDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"DistributionAlreadyExists", "error":{"httpStatusCode":409}, "exception":true, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." }, { "shape":"InvalidOrigin", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"InvalidViewerCertificate", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidMinimumProtocolVersion", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"TooManyDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more CNAMEs than are allowed per distribution." }, { "shape":"TooManyDistributions", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." }, { "shape":"InvalidDefaultRootObject", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The default root object file name is too big or contains an invalid character." }, { "shape":"InvalidRelativePath", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." }, { "shape":"InvalidErrorCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidResponseCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InvalidRequiredProtocol", "error":{"httpStatusCode":400}, "exception":true, "documentation":"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." }, { "shape":"NoSuchOrigin", "error":{"httpStatusCode":404}, "exception":true, "documentation":"No origin exists with the specified Origin Id." }, { "shape":"TooManyOrigins", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore origins for the distribution." }, { "shape":"TooManyCacheBehaviors", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore cache behaviors for the distribution." }, { "shape":"TooManyCookieNamesInWhiteList", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." }, { "shape":"InvalidForwardCookies", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." }, { "shape":"TooManyHeadersInForwardedValues", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidHeadersForS3Origin", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." }, { "shape":"TooManyCertificates", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore custom ssl certificates." }, { "shape":"InvalidLocationCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidGeoRestrictionParameter", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidProtocolSettings", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." }, { "shape":"InvalidTTLOrder", "error":{"httpStatusCode":400}, "exception":true } ], "documentation":"Create a new distribution." }, "CreateInvalidation":{ "name":"CreateInvalidation2015_04_17", "http":{ "method":"POST", "requestUri":"/2015-04-17/distribution/{DistributionId}/invalidation", "responseCode":201 }, "input":{ "shape":"CreateInvalidationRequest", "documentation":"The request to create an invalidation." }, "output":{ "shape":"CreateInvalidationResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"BatchTooLarge", "error":{"httpStatusCode":413}, "exception":true }, { "shape":"TooManyInvalidationsInProgress", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Create a new invalidation." }, "CreateStreamingDistribution":{ "name":"CreateStreamingDistribution2015_04_17", "http":{ "method":"POST", "requestUri":"/2015-04-17/streaming-distribution", "responseCode":201 }, "input":{ "shape":"CreateStreamingDistributionRequest", "documentation":"The request to create a new streaming distribution." }, "output":{ "shape":"CreateStreamingDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"StreamingDistributionAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"InvalidOrigin", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"TooManyStreamingDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyStreamingDistributions", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Create a new streaming distribution." }, "DeleteCloudFrontOriginAccessIdentity":{ "name":"DeleteCloudFrontOriginAccessIdentity2015_04_17", "http":{ "method":"DELETE", "requestUri":"/2015-04-17/origin-access-identity/cloudfront/{Id}", "responseCode":204 }, "input":{ "shape":"DeleteCloudFrontOriginAccessIdentityRequest", "documentation":"The request to delete a origin access identity." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"CloudFrontOriginAccessIdentityInUse", "error":{"httpStatusCode":409}, "exception":true } ], "documentation":"Delete an origin access identity." }, "DeleteDistribution":{ "name":"DeleteDistribution2015_04_17", "http":{ "method":"DELETE", "requestUri":"/2015-04-17/distribution/{Id}", "responseCode":204 }, "input":{ "shape":"DeleteDistributionRequest", "documentation":"The request to delete a distribution." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"DistributionNotDisabled", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." } ], "documentation":"Delete a distribution." }, "DeleteStreamingDistribution":{ "name":"DeleteStreamingDistribution2015_04_17", "http":{ "method":"DELETE", "requestUri":"/2015-04-17/streaming-distribution/{Id}", "responseCode":204 }, "input":{ "shape":"DeleteStreamingDistributionRequest", "documentation":"The request to delete a streaming distribution." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"StreamingDistributionNotDisabled", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." } ], "documentation":"Delete a streaming distribution." }, "GetCloudFrontOriginAccessIdentity":{ "name":"GetCloudFrontOriginAccessIdentity2015_04_17", "http":{ "method":"GET", "requestUri":"/2015-04-17/origin-access-identity/cloudfront/{Id}" }, "input":{ "shape":"GetCloudFrontOriginAccessIdentityRequest", "documentation":"The request to get an origin access identity's information." }, "output":{ "shape":"GetCloudFrontOriginAccessIdentityResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about an origin access identity." }, "GetCloudFrontOriginAccessIdentityConfig":{ "name":"GetCloudFrontOriginAccessIdentityConfig2015_04_17", "http":{ "method":"GET", "requestUri":"/2015-04-17/origin-access-identity/cloudfront/{Id}/config" }, "input":{ "shape":"GetCloudFrontOriginAccessIdentityConfigRequest", "documentation":"The request to get an origin access identity's configuration." }, "output":{ "shape":"GetCloudFrontOriginAccessIdentityConfigResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the configuration information about an origin access identity." }, "GetDistribution":{ "name":"GetDistribution2015_04_17", "http":{ "method":"GET", "requestUri":"/2015-04-17/distribution/{Id}" }, "input":{ "shape":"GetDistributionRequest", "documentation":"The request to get a distribution's information." }, "output":{ "shape":"GetDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about a distribution." }, "GetDistributionConfig":{ "name":"GetDistributionConfig2015_04_17", "http":{ "method":"GET", "requestUri":"/2015-04-17/distribution/{Id}/config" }, "input":{ "shape":"GetDistributionConfigRequest", "documentation":"The request to get a distribution configuration." }, "output":{ "shape":"GetDistributionConfigResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the configuration information about a distribution." }, "GetInvalidation":{ "name":"GetInvalidation2015_04_17", "http":{ "method":"GET", "requestUri":"/2015-04-17/distribution/{DistributionId}/invalidation/{Id}" }, "input":{ "shape":"GetInvalidationRequest", "documentation":"The request to get an invalidation's information." }, "output":{ "shape":"GetInvalidationResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchInvalidation", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified invalidation does not exist." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about an invalidation." }, "GetStreamingDistribution":{ "name":"GetStreamingDistribution2015_04_17", "http":{ "method":"GET", "requestUri":"/2015-04-17/streaming-distribution/{Id}" }, "input":{ "shape":"GetStreamingDistributionRequest", "documentation":"The request to get a streaming distribution's information." }, "output":{ "shape":"GetStreamingDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about a streaming distribution." }, "GetStreamingDistributionConfig":{ "name":"GetStreamingDistributionConfig2015_04_17", "http":{ "method":"GET", "requestUri":"/2015-04-17/streaming-distribution/{Id}/config" }, "input":{ "shape":"GetStreamingDistributionConfigRequest", "documentation":"To request to get a streaming distribution configuration." }, "output":{ "shape":"GetStreamingDistributionConfigResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the configuration information about a streaming distribution." }, "ListCloudFrontOriginAccessIdentities":{ "name":"ListCloudFrontOriginAccessIdentities2015_04_17", "http":{ "method":"GET", "requestUri":"/2015-04-17/origin-access-identity/cloudfront" }, "input":{ "shape":"ListCloudFrontOriginAccessIdentitiesRequest", "documentation":"The request to list origin access identities." }, "output":{ "shape":"ListCloudFrontOriginAccessIdentitiesResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." } ], "documentation":"List origin access identities." }, "ListDistributions":{ "name":"ListDistributions2015_04_17", "http":{ "method":"GET", "requestUri":"/2015-04-17/distribution" }, "input":{ "shape":"ListDistributionsRequest", "documentation":"The request to list your distributions." }, "output":{ "shape":"ListDistributionsResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." } ], "documentation":"List distributions." }, "ListInvalidations":{ "name":"ListInvalidations2015_04_17", "http":{ "method":"GET", "requestUri":"/2015-04-17/distribution/{DistributionId}/invalidation" }, "input":{ "shape":"ListInvalidationsRequest", "documentation":"The request to list invalidations." }, "output":{ "shape":"ListInvalidationsResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"List invalidation batches." }, "ListStreamingDistributions":{ "name":"ListStreamingDistributions2015_04_17", "http":{ "method":"GET", "requestUri":"/2015-04-17/streaming-distribution" }, "input":{ "shape":"ListStreamingDistributionsRequest", "documentation":"The request to list your streaming distributions." }, "output":{ "shape":"ListStreamingDistributionsResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." } ], "documentation":"List streaming distributions." }, "UpdateCloudFrontOriginAccessIdentity":{ "name":"UpdateCloudFrontOriginAccessIdentity2015_04_17", "http":{ "method":"PUT", "requestUri":"/2015-04-17/origin-access-identity/cloudfront/{Id}/config" }, "input":{ "shape":"UpdateCloudFrontOriginAccessIdentityRequest", "documentation":"The request to update an origin access identity." }, "output":{ "shape":"UpdateCloudFrontOriginAccessIdentityResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"IllegalUpdate", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Update an origin access identity." }, "UpdateDistribution":{ "name":"UpdateDistribution2015_04_17", "http":{ "method":"PUT", "requestUri":"/2015-04-17/distribution/{Id}/config" }, "input":{ "shape":"UpdateDistributionRequest", "documentation":"The request to update a distribution." }, "output":{ "shape":"UpdateDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"IllegalUpdate", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"TooManyDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more CNAMEs than are allowed per distribution." }, { "shape":"InvalidDefaultRootObject", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The default root object file name is too big or contains an invalid character." }, { "shape":"InvalidRelativePath", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." }, { "shape":"InvalidErrorCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidResponseCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"InvalidViewerCertificate", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidMinimumProtocolVersion", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidRequiredProtocol", "error":{"httpStatusCode":400}, "exception":true, "documentation":"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." }, { "shape":"NoSuchOrigin", "error":{"httpStatusCode":404}, "exception":true, "documentation":"No origin exists with the specified Origin Id." }, { "shape":"TooManyOrigins", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore origins for the distribution." }, { "shape":"TooManyCacheBehaviors", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore cache behaviors for the distribution." }, { "shape":"TooManyCookieNamesInWhiteList", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." }, { "shape":"InvalidForwardCookies", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." }, { "shape":"TooManyHeadersInForwardedValues", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidHeadersForS3Origin", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." }, { "shape":"TooManyCertificates", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore custom ssl certificates." }, { "shape":"InvalidLocationCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidGeoRestrictionParameter", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidTTLOrder", "error":{"httpStatusCode":400}, "exception":true } ], "documentation":"Update a distribution." }, "UpdateStreamingDistribution":{ "name":"UpdateStreamingDistribution2015_04_17", "http":{ "method":"PUT", "requestUri":"/2015-04-17/streaming-distribution/{Id}/config" }, "input":{ "shape":"UpdateStreamingDistributionRequest", "documentation":"The request to update a streaming distribution." }, "output":{ "shape":"UpdateStreamingDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"IllegalUpdate", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"TooManyStreamingDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Update a streaming distribution." } }, "shapes":{ "AccessDenied":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, "ActiveTrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Each active trusted signer." }, "Quantity":{ "shape":"integer", "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." }, "Items":{ "shape":"SignerList", "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." } }, "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." }, "AliasList":{ "type":"list", "member":{ "shape":"string", "locationName":"CNAME" } }, "Aliases":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of CNAMEs, if any, for this distribution." }, "Items":{ "shape":"AliasList", "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "AllowedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." }, "CachedMethods":{"shape":"CachedMethods"} }, "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." }, "AwsAccountNumberList":{ "type":"list", "member":{ "shape":"string", "locationName":"AwsAccountNumber" } }, "BatchTooLarge":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":413}, "exception":true }, "CNAMEAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CacheBehavior":{ "type":"structure", "required":[ "PathPattern", "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "PathPattern":{ "shape":"string", "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." }, "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "DefaultTTL":{ "shape":"long", "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "MaxTTL":{ "shape":"long", "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." } }, "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." }, "CacheBehaviorList":{ "type":"list", "member":{ "shape":"CacheBehavior", "locationName":"CacheBehavior" } }, "CacheBehaviors":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of cache behaviors for this distribution." }, "Items":{ "shape":"CacheBehaviorList", "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CachedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." } }, "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." }, "CloudFrontOriginAccessIdentity":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The current configuration information for the identity." } }, "documentation":"CloudFront origin access identity." }, "CloudFrontOriginAccessIdentityAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, "CloudFrontOriginAccessIdentityConfig":{ "type":"structure", "required":[ "CallerReference", "Comment" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the origin access identity." } }, "documentation":"Origin access identity configuration." }, "CloudFrontOriginAccessIdentityInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more origin access identities remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." }, "Items":{ "shape":"CloudFrontOriginAccessIdentitySummaryList", "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." } }, "documentation":"The CloudFrontOriginAccessIdentityList type." }, "CloudFrontOriginAccessIdentitySummary":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId", "Comment" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "Comment":{ "shape":"string", "documentation":"The comment for this origin access identity, as originally specified when created." } }, "documentation":"Summary of the information about a CloudFront origin access identity." }, "CloudFrontOriginAccessIdentitySummaryList":{ "type":"list", "member":{ "shape":"CloudFrontOriginAccessIdentitySummary", "locationName":"CloudFrontOriginAccessIdentitySummary" } }, "CookieNameList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "CookieNames":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of whitelisted cookies for this cache behavior." }, "Items":{ "shape":"CookieNameList", "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." }, "CookiePreference":{ "type":"structure", "required":["Forward"], "members":{ "Forward":{ "shape":"ItemSelection", "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." }, "WhitelistedNames":{ "shape":"CookieNames", "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." } }, "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." }, "CreateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["CloudFrontOriginAccessIdentityConfig"], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-04-17/"}, "locationName":"CloudFrontOriginAccessIdentityConfig" } }, "documentation":"The request to create a new origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "CreateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the origin access identity created." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "CreateDistributionRequest":{ "type":"structure", "required":["DistributionConfig"], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-04-17/"}, "locationName":"DistributionConfig" } }, "documentation":"The request to create a new distribution.", "payload":"DistributionConfig" }, "CreateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the distribution created." } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "CreateInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "InvalidationBatch" ], "members":{ "DistributionId":{ "shape":"string", "location":"uri", "locationName":"DistributionId", "documentation":"The distribution's id." }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The batch information for the invalidation.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-04-17/"}, "locationName":"InvalidationBatch" } }, "documentation":"The request to create an invalidation.", "payload":"InvalidationBatch" }, "CreateInvalidationResult":{ "type":"structure", "members":{ "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID." }, "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "CreateStreamingDistributionRequest":{ "type":"structure", "required":["StreamingDistributionConfig"], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-04-17/"}, "locationName":"StreamingDistributionConfig" } }, "documentation":"The request to create a new streaming distribution.", "payload":"StreamingDistributionConfig" }, "CreateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the streaming distribution created." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "CustomErrorResponse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{ "shape":"integer", "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." }, "ResponsePagePath":{ "shape":"string", "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." }, "ResponseCode":{ "shape":"string", "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." }, "ErrorCachingMinTTL":{ "shape":"long", "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." } }, "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." }, "CustomErrorResponseList":{ "type":"list", "member":{ "shape":"CustomErrorResponse", "locationName":"CustomErrorResponse" } }, "CustomErrorResponses":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom error responses for this distribution." }, "Items":{ "shape":"CustomErrorResponseList", "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "CustomOriginConfig":{ "type":"structure", "required":[ "HTTPPort", "HTTPSPort", "OriginProtocolPolicy" ], "members":{ "HTTPPort":{ "shape":"integer", "documentation":"The HTTP port the custom origin listens on." }, "HTTPSPort":{ "shape":"integer", "documentation":"The HTTPS port the custom origin listens on." }, "OriginProtocolPolicy":{ "shape":"OriginProtocolPolicy", "documentation":"The origin protocol policy to apply to your origin." } }, "documentation":"A customer origin." }, "DefaultCacheBehavior":{ "type":"structure", "required":[ "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "DefaultTTL":{ "shape":"long", "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "MaxTTL":{ "shape":"long", "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." } }, "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "DeleteCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The origin access identity's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to delete a origin access identity.", "required":["Id"] }, "DeleteDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to delete a distribution.", "required":["Id"] }, "DeleteStreamingDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to delete a streaming distribution.", "required":["Id"] }, "Distribution":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "InProgressInvalidationBatches", "DomainName", "ActiveTrustedSigners", "DistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "InProgressInvalidationBatches":{ "shape":"integer", "documentation":"The number of invalidation batches currently in progress." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The current configuration information for the distribution." } }, "documentation":"A distribution." }, "DistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." }, "DistributionConfig":{ "type":"structure", "required":[ "CallerReference", "Origins", "DefaultCacheBehavior", "Comment", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "DefaultRootObject":{ "shape":"string", "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the distribution." }, "Logging":{ "shape":"LoggingConfig", "documentation":"A complex type that controls whether access logs are written for the distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"} }, "documentation":"A distribution Configuration." }, "DistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of distributions that were created by the current AWS account." }, "Items":{ "shape":"DistributionSummaryList", "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A distribution list." }, "DistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "DistributionSummary":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "DomainName", "Aliases", "Origins", "DefaultCacheBehavior", "CacheBehaviors", "CustomErrorResponses", "Comment", "PriceClass", "Enabled", "ViewerCertificate", "Restrictions" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponses elements." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"} }, "documentation":"A summary of the information for an Amazon CloudFront distribution." }, "DistributionSummaryList":{ "type":"list", "member":{ "shape":"DistributionSummary", "locationName":"DistributionSummary" } }, "ForwardedValues":{ "type":"structure", "required":[ "QueryString", "Cookies" ], "members":{ "QueryString":{ "shape":"boolean", "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "Cookies":{ "shape":"CookiePreference", "documentation":"A complex type that specifies how CloudFront handles cookies." }, "Headers":{ "shape":"Headers", "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." } }, "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "GeoRestriction":{ "type":"structure", "required":[ "RestrictionType", "Quantity" ], "members":{ "RestrictionType":{ "shape":"GeoRestrictionType", "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." }, "Quantity":{ "shape":"integer", "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." }, "Items":{ "shape":"LocationList", "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." } }, "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." }, "GeoRestrictionType":{ "type":"string", "enum":[ "blacklist", "whitelist", "none" ] }, "GetCloudFrontOriginAccessIdentityConfigRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The identity's id." } }, "documentation":"The request to get an origin access identity's configuration.", "required":["Id"] }, "GetCloudFrontOriginAccessIdentityConfigResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "GetCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The identity's id." } }, "documentation":"The request to get an origin access identity's information.", "required":["Id"] }, "GetCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "GetDistributionConfigRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution's id." } }, "documentation":"The request to get a distribution configuration.", "required":["Id"] }, "GetDistributionConfigResult":{ "type":"structure", "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionConfig" }, "GetDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution's id." } }, "documentation":"The request to get a distribution's information.", "required":["Id"] }, "GetDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "GetInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "Id" ], "members":{ "DistributionId":{ "shape":"string", "location":"uri", "locationName":"DistributionId", "documentation":"The distribution's id." }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The invalidation's id." } }, "documentation":"The request to get an invalidation's information." }, "GetInvalidationResult":{ "type":"structure", "members":{ "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "GetStreamingDistributionConfigRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The streaming distribution's id." } }, "documentation":"To request to get a streaming distribution configuration.", "required":["Id"] }, "GetStreamingDistributionConfigResult":{ "type":"structure", "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionConfig" }, "GetStreamingDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The streaming distribution's id." } }, "documentation":"The request to get a streaming distribution's information.", "required":["Id"] }, "GetStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "HeaderList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "Headers":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." }, "Items":{ "shape":"HeaderList", "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." } }, "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." }, "IllegalUpdate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, "InconsistentQuantities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." }, "InvalidArgument":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, "InvalidDefaultRootObject":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The default root object file name is too big or contains an invalid character." }, "InvalidErrorCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidForwardCookies":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." }, "InvalidGeoRestrictionParameter":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidHeadersForS3Origin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidIfMatchVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, "InvalidLocationCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidMinimumProtocolVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." }, "InvalidOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, "InvalidProtocolSettings":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." }, "InvalidRelativePath":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." }, "InvalidRequiredProtocol":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"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." }, "InvalidResponseCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidTTLOrder":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidViewerCertificate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "Invalidation":{ "type":"structure", "required":[ "Id", "Status", "CreateTime", "InvalidationBatch" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." }, "CreateTime":{ "shape":"timestamp", "documentation":"The date and time the invalidation request was first made." }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The current invalidation information for the batch request." } }, "documentation":"An invalidation." }, "InvalidationBatch":{ "type":"structure", "required":[ "Paths", "CallerReference" ], "members":{ "Paths":{ "shape":"Paths", "documentation":"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. 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. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." }, "CallerReference":{ "shape":"string", "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. 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, the response includes the same information returned to the original request. 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, CloudFront returns an InvalidationBatchAlreadyExists error." } }, "documentation":"An invalidation batch." }, "InvalidationList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of invalidation batches that were created by the current AWS account." }, "Items":{ "shape":"InvalidationSummaryList", "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." } }, "documentation":"An invalidation list." }, "InvalidationSummary":{ "type":"structure", "required":[ "Id", "CreateTime", "Status" ], "members":{ "Id":{ "shape":"string", "documentation":"The unique ID for an invalidation request." }, "CreateTime":{"shape":"timestamp"}, "Status":{ "shape":"string", "documentation":"The status of an invalidation request." } }, "documentation":"Summary of an invalidation request." }, "InvalidationSummaryList":{ "type":"list", "member":{ "shape":"InvalidationSummary", "locationName":"InvalidationSummary" } }, "ItemSelection":{ "type":"string", "enum":[ "none", "whitelist", "all" ] }, "KeyPairIdList":{ "type":"list", "member":{ "shape":"string", "locationName":"KeyPairId" } }, "KeyPairIds":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." }, "Items":{ "shape":"KeyPairIdList", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." }, "ListCloudFrontOriginAccessIdentitiesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"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. 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)." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of origin access identities you want in the response body." } }, "documentation":"The request to list origin access identities." }, "ListCloudFrontOriginAccessIdentitiesResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityList":{ "shape":"CloudFrontOriginAccessIdentityList", "documentation":"The CloudFrontOriginAccessIdentityList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityList" }, "ListDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"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. 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)." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of distributions you want in the response body." } }, "documentation":"The request to list your distributions." }, "ListDistributionsResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionList" }, "ListInvalidationsRequest":{ "type":"structure", "required":["DistributionId"], "members":{ "DistributionId":{ "shape":"string", "location":"uri", "locationName":"DistributionId", "documentation":"The distribution's id." }, "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. 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. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of invalidation batches you want in the response body." } }, "documentation":"The request to list invalidations." }, "ListInvalidationsResult":{ "type":"structure", "members":{ "InvalidationList":{ "shape":"InvalidationList", "documentation":"Information about invalidation batches." } }, "documentation":"The returned result of the corresponding request.", "payload":"InvalidationList" }, "ListStreamingDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"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. 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)." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of streaming distributions you want in the response body." } }, "documentation":"The request to list your streaming distributions." }, "ListStreamingDistributionsResult":{ "type":"structure", "members":{ "StreamingDistributionList":{ "shape":"StreamingDistributionList", "documentation":"The StreamingDistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionList" }, "LocationList":{ "type":"list", "member":{ "shape":"string", "locationName":"Location" } }, "LoggingConfig":{ "type":"structure", "required":[ "Enabled", "IncludeCookies", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." }, "IncludeCookies":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for the distribution." }, "Method":{ "type":"string", "enum":[ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ] }, "MethodsList":{ "type":"list", "member":{ "shape":"Method", "locationName":"Method" } }, "MinimumProtocolVersion":{ "type":"string", "enum":[ "SSLv3", "TLSv1" ] }, "MissingBody":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, "NoSuchCloudFrontOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, "NoSuchDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, "NoSuchInvalidation":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified invalidation does not exist." }, "NoSuchOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"No origin exists with the specified Origin Id." }, "NoSuchStreamingDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, "Origin":{ "type":"structure", "required":[ "Id", "DomainName" ], "members":{ "Id":{ "shape":"string", "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." }, "DomainName":{ "shape":"string", "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." }, "OriginPath":{ "shape":"string", "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." }, "S3OriginConfig":{ "shape":"S3OriginConfig", "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "CustomOriginConfig":{ "shape":"CustomOriginConfig", "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." } }, "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." }, "OriginList":{ "type":"list", "member":{ "shape":"Origin", "locationName":"Origin" }, "min":1 }, "OriginProtocolPolicy":{ "type":"string", "enum":[ "http-only", "match-viewer" ] }, "Origins":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of origins for this distribution." }, "Items":{ "shape":"OriginList", "documentation":"A complex type that contains origins for this distribution." } }, "documentation":"A complex type that contains information about origins for this distribution." }, "PathList":{ "type":"list", "member":{ "shape":"string", "locationName":"Path" } }, "Paths":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of objects that you want to invalidate." }, "Items":{ "shape":"PathList", "documentation":"A complex type that contains a list of the objects that you want to invalidate." } }, "documentation":"A complex type that contains information about the objects that you want to invalidate." }, "PreconditionFailed":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, "PriceClass":{ "type":"string", "enum":[ "PriceClass_100", "PriceClass_200", "PriceClass_All" ] }, "Restrictions":{ "type":"structure", "required":["GeoRestriction"], "members":{ "GeoRestriction":{"shape":"GeoRestriction"} }, "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." }, "S3Origin":{ "type":"structure", "required":[ "DomainName", "OriginAccessIdentity" ], "members":{ "DomainName":{ "shape":"string", "documentation":"The DNS name of the S3 origin." }, "OriginAccessIdentity":{ "shape":"string", "documentation":"Your S3 origin's origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "S3OriginConfig":{ "type":"structure", "required":["OriginAccessIdentity"], "members":{ "OriginAccessIdentity":{ "shape":"string", "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "SSLSupportMethod":{ "type":"string", "enum":[ "sni-only", "vip" ] }, "Signer":{ "type":"structure", "members":{ "AwsAccountNumber":{ "shape":"string", "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." }, "KeyPairIds":{ "shape":"KeyPairIds", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." }, "SignerList":{ "type":"list", "member":{ "shape":"Signer", "locationName":"Signer" } }, "StreamingDistribution":{ "type":"structure", "required":[ "Id", "Status", "DomainName", "ActiveTrustedSigners", "StreamingDistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." }, "Status":{ "shape":"string", "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The current configuration information for the streaming distribution." } }, "documentation":"A streaming distribution." }, "StreamingDistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionConfig":{ "type":"structure", "required":[ "CallerReference", "S3Origin", "Comment", "TrustedSigners", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the streaming distribution." }, "Logging":{ "shape":"StreamingLoggingConfig", "documentation":"A complex type that controls whether access logs are written for the streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this streaming distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." } }, "documentation":"The configuration for the streaming distribution." }, "StreamingDistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more streaming distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of streaming distributions that were created by the current AWS account." }, "Items":{ "shape":"StreamingDistributionSummaryList", "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A streaming distribution list." }, "StreamingDistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionSummary":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "DomainName", "S3Origin", "Aliases", "TrustedSigners", "Comment", "PriceClass", "Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." } }, "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." }, "StreamingDistributionSummaryList":{ "type":"list", "member":{ "shape":"StreamingDistributionSummary", "locationName":"StreamingDistributionSummary" } }, "StreamingLoggingConfig":{ "type":"structure", "required":[ "Enabled", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for this streaming distribution." }, "TooManyCacheBehaviors":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore cache behaviors for the distribution." }, "TooManyCertificates":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore custom ssl certificates." }, "TooManyCloudFrontOriginAccessIdentities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." }, "TooManyCookieNamesInWhiteList":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." }, "TooManyDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more CNAMEs than are allowed per distribution." }, "TooManyDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." }, "TooManyHeadersInForwardedValues":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyInvalidationsInProgress":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." }, "TooManyOrigins":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore origins for the distribution." }, "TooManyStreamingDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." }, "TooManyTrustedSigners":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, "TrustedSignerDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, "TrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." }, "Quantity":{ "shape":"integer", "documentation":"The number of trusted signers for this cache behavior." }, "Items":{ "shape":"AwsAccountNumberList", "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "UpdateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":[ "CloudFrontOriginAccessIdentityConfig", "Id" ], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The identity's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-04-17/"}, "locationName":"CloudFrontOriginAccessIdentityConfig" }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The identity's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to update an origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "UpdateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "UpdateDistributionRequest":{ "type":"structure", "required":[ "DistributionConfig", "Id" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-04-17/"}, "locationName":"DistributionConfig" }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to update a distribution.", "payload":"DistributionConfig" }, "UpdateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "UpdateStreamingDistributionRequest":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Id" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-04-17/"}, "locationName":"StreamingDistributionConfig" }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The streaming distribution's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to update a streaming distribution.", "payload":"StreamingDistributionConfig" }, "UpdateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "ViewerCertificate":{ "type":"structure", "members":{ "IAMCertificateId":{ "shape":"string", "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate." }, "CloudFrontDefaultCertificate":{ "shape":"boolean", "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId." }, "SSLSupportMethod":{ "shape":"SSLSupportMethod", "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." }, "MinimumProtocolVersion":{ "shape":"MinimumProtocolVersion", "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." } }, "documentation":"A complex type that contains information about viewer certificates for this distribution." }, "ViewerProtocolPolicy":{ "type":"string", "enum":[ "allow-all", "https-only", "redirect-to-https" ] }, "boolean":{"type":"boolean"}, "integer":{"type":"integer"}, "long":{"type":"long"}, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} } } botocore-1.5.7/botocore/data/cloudfront/2014-10-21/0000777454262600001440000000000013042511307022336 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudfront/2014-10-21/waiters-2.json0000666454262600001440000000224013042511306025043 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DistributionDeployed": { "delay": 60, "operation": "GetDistribution", "maxAttempts": 25, "description": "Wait until a distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "Distribution.Status" } ] }, "InvalidationCompleted": { "delay": 20, "operation": "GetInvalidation", "maxAttempts": 60, "description": "Wait until an invalidation has completed.", "acceptors": [ { "expected": "Completed", "matcher": "path", "state": "success", "argument": "Invalidation.Status" } ] }, "StreamingDistributionDeployed": { "delay": 60, "operation": "GetStreamingDistribution", "maxAttempts": 25, "description": "Wait until a streaming distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "StreamingDistribution.Status" } ] } } } botocore-1.5.7/botocore/data/cloudfront/2014-10-21/paginators-1.json0000666454262600001440000000214613042511306025540 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListCloudFrontOriginAccessIdentities": { "input_token": "Marker", "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", "limit_key": "MaxItems", "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", "result_key": "CloudFrontOriginAccessIdentityList.Items" }, "ListDistributions": { "input_token": "Marker", "output_token": "DistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "DistributionList.IsTruncated", "result_key": "DistributionList.Items" }, "ListInvalidations": { "input_token": "Marker", "output_token": "InvalidationList.NextMarker", "limit_key": "MaxItems", "more_results": "InvalidationList.IsTruncated", "result_key": "InvalidationList.Items" }, "ListStreamingDistributions": { "input_token": "Marker", "output_token": "StreamingDistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "StreamingDistributionList.IsTruncated", "result_key": "StreamingDistributionList.Items" } } } botocore-1.5.7/botocore/data/cloudfront/2014-10-21/service-2.json0000666454262600001440000043777113042511306025052 0ustar pysdk-ciamazon00000000000000{ "metadata":{ "apiVersion":"2014-10-21", "endpointPrefix":"cloudfront", "globalEndpoint":"cloudfront.amazonaws.com", "serviceAbbreviation":"CloudFront", "serviceFullName":"Amazon CloudFront", "signatureVersion":"v4", "protocol":"rest-xml" }, "operations":{ "CreateCloudFrontOriginAccessIdentity":{ "name":"CreateCloudFrontOriginAccessIdentity2014_10_21", "http":{ "method":"POST", "requestUri":"/2014-10-21/origin-access-identity/cloudfront", "responseCode":201 }, "input":{ "shape":"CreateCloudFrontOriginAccessIdentityRequest", "documentation":"The request to create a new origin access identity." }, "output":{ "shape":"CreateCloudFrontOriginAccessIdentityResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"CloudFrontOriginAccessIdentityAlreadyExists", "error":{"httpStatusCode":409}, "exception":true, "documentation":"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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"TooManyCloudFrontOriginAccessIdentities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Create a new origin access identity." }, "CreateDistribution":{ "name":"CreateDistribution2014_10_21", "http":{ "method":"POST", "requestUri":"/2014-10-21/distribution", "responseCode":201 }, "input":{ "shape":"CreateDistributionRequest", "documentation":"The request to create a new distribution." }, "output":{ "shape":"CreateDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"DistributionAlreadyExists", "error":{"httpStatusCode":409}, "exception":true, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." }, { "shape":"InvalidOrigin", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"InvalidViewerCertificate", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"TooManyDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more CNAMEs than are allowed per distribution." }, { "shape":"TooManyDistributions", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." }, { "shape":"InvalidDefaultRootObject", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The default root object file name is too big or contains an invalid character." }, { "shape":"InvalidRelativePath", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." }, { "shape":"InvalidErrorCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidResponseCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InvalidRequiredProtocol", "error":{"httpStatusCode":400}, "exception":true, "documentation":"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." }, { "shape":"NoSuchOrigin", "error":{"httpStatusCode":404}, "exception":true, "documentation":"No origin exists with the specified Origin Id." }, { "shape":"TooManyOrigins", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore origins for the distribution." }, { "shape":"TooManyCacheBehaviors", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore cache behaviors for the distribution." }, { "shape":"TooManyCookieNamesInWhiteList", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." }, { "shape":"InvalidForwardCookies", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." }, { "shape":"TooManyHeadersInForwardedValues", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidHeadersForS3Origin", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." }, { "shape":"TooManyCertificates", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore custom ssl certificates." }, { "shape":"InvalidLocationCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidGeoRestrictionParameter", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidProtocolSettings", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." } ], "documentation":"Create a new distribution." }, "CreateInvalidation":{ "name":"CreateInvalidation2014_10_21", "http":{ "method":"POST", "requestUri":"/2014-10-21/distribution/{DistributionId}/invalidation", "responseCode":201 }, "input":{ "shape":"CreateInvalidationRequest", "documentation":"The request to create an invalidation." }, "output":{ "shape":"CreateInvalidationResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"BatchTooLarge", "error":{"httpStatusCode":413}, "exception":true }, { "shape":"TooManyInvalidationsInProgress", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Create a new invalidation." }, "CreateStreamingDistribution":{ "name":"CreateStreamingDistribution2014_10_21", "http":{ "method":"POST", "requestUri":"/2014-10-21/streaming-distribution", "responseCode":201 }, "input":{ "shape":"CreateStreamingDistributionRequest", "documentation":"The request to create a new streaming distribution." }, "output":{ "shape":"CreateStreamingDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"StreamingDistributionAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"InvalidOrigin", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"TooManyStreamingDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyStreamingDistributions", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Create a new streaming distribution." }, "DeleteCloudFrontOriginAccessIdentity":{ "name":"DeleteCloudFrontOriginAccessIdentity2014_10_21", "http":{ "method":"DELETE", "requestUri":"/2014-10-21/origin-access-identity/cloudfront/{Id}", "responseCode":204 }, "input":{ "shape":"DeleteCloudFrontOriginAccessIdentityRequest", "documentation":"The request to delete a origin access identity." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"CloudFrontOriginAccessIdentityInUse", "error":{"httpStatusCode":409}, "exception":true } ], "documentation":"Delete an origin access identity." }, "DeleteDistribution":{ "name":"DeleteDistribution2014_10_21", "http":{ "method":"DELETE", "requestUri":"/2014-10-21/distribution/{Id}", "responseCode":204 }, "input":{ "shape":"DeleteDistributionRequest", "documentation":"The request to delete a distribution." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"DistributionNotDisabled", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." } ], "documentation":"Delete a distribution." }, "DeleteStreamingDistribution":{ "name":"DeleteStreamingDistribution2014_10_21", "http":{ "method":"DELETE", "requestUri":"/2014-10-21/streaming-distribution/{Id}", "responseCode":204 }, "input":{ "shape":"DeleteStreamingDistributionRequest", "documentation":"The request to delete a streaming distribution." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"StreamingDistributionNotDisabled", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." } ], "documentation":"Delete a streaming distribution." }, "GetCloudFrontOriginAccessIdentity":{ "name":"GetCloudFrontOriginAccessIdentity2014_10_21", "http":{ "method":"GET", "requestUri":"/2014-10-21/origin-access-identity/cloudfront/{Id}" }, "input":{ "shape":"GetCloudFrontOriginAccessIdentityRequest", "documentation":"The request to get an origin access identity's information." }, "output":{ "shape":"GetCloudFrontOriginAccessIdentityResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about an origin access identity." }, "GetCloudFrontOriginAccessIdentityConfig":{ "name":"GetCloudFrontOriginAccessIdentityConfig2014_10_21", "http":{ "method":"GET", "requestUri":"/2014-10-21/origin-access-identity/cloudfront/{Id}/config" }, "input":{ "shape":"GetCloudFrontOriginAccessIdentityConfigRequest", "documentation":"The request to get an origin access identity's configuration." }, "output":{ "shape":"GetCloudFrontOriginAccessIdentityConfigResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the configuration information about an origin access identity." }, "GetDistribution":{ "name":"GetDistribution2014_10_21", "http":{ "method":"GET", "requestUri":"/2014-10-21/distribution/{Id}" }, "input":{ "shape":"GetDistributionRequest", "documentation":"The request to get a distribution's information." }, "output":{ "shape":"GetDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about a distribution." }, "GetDistributionConfig":{ "name":"GetDistributionConfig2014_10_21", "http":{ "method":"GET", "requestUri":"/2014-10-21/distribution/{Id}/config" }, "input":{ "shape":"GetDistributionConfigRequest", "documentation":"The request to get a distribution configuration." }, "output":{ "shape":"GetDistributionConfigResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the configuration information about a distribution." }, "GetInvalidation":{ "name":"GetInvalidation2014_10_21", "http":{ "method":"GET", "requestUri":"/2014-10-21/distribution/{DistributionId}/invalidation/{Id}" }, "input":{ "shape":"GetInvalidationRequest", "documentation":"The request to get an invalidation's information." }, "output":{ "shape":"GetInvalidationResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchInvalidation", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified invalidation does not exist." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about an invalidation." }, "GetStreamingDistribution":{ "name":"GetStreamingDistribution2014_10_21", "http":{ "method":"GET", "requestUri":"/2014-10-21/streaming-distribution/{Id}" }, "input":{ "shape":"GetStreamingDistributionRequest", "documentation":"The request to get a streaming distribution's information." }, "output":{ "shape":"GetStreamingDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about a streaming distribution." }, "GetStreamingDistributionConfig":{ "name":"GetStreamingDistributionConfig2014_10_21", "http":{ "method":"GET", "requestUri":"/2014-10-21/streaming-distribution/{Id}/config" }, "input":{ "shape":"GetStreamingDistributionConfigRequest", "documentation":"To request to get a streaming distribution configuration." }, "output":{ "shape":"GetStreamingDistributionConfigResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the configuration information about a streaming distribution." }, "ListCloudFrontOriginAccessIdentities":{ "name":"ListCloudFrontOriginAccessIdentities2014_10_21", "http":{ "method":"GET", "requestUri":"/2014-10-21/origin-access-identity/cloudfront" }, "input":{ "shape":"ListCloudFrontOriginAccessIdentitiesRequest", "documentation":"The request to list origin access identities." }, "output":{ "shape":"ListCloudFrontOriginAccessIdentitiesResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." } ], "documentation":"List origin access identities." }, "ListDistributions":{ "name":"ListDistributions2014_10_21", "http":{ "method":"GET", "requestUri":"/2014-10-21/distribution" }, "input":{ "shape":"ListDistributionsRequest", "documentation":"The request to list your distributions." }, "output":{ "shape":"ListDistributionsResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." } ], "documentation":"List distributions." }, "ListInvalidations":{ "name":"ListInvalidations2014_10_21", "http":{ "method":"GET", "requestUri":"/2014-10-21/distribution/{DistributionId}/invalidation" }, "input":{ "shape":"ListInvalidationsRequest", "documentation":"The request to list invalidations." }, "output":{ "shape":"ListInvalidationsResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"List invalidation batches." }, "ListStreamingDistributions":{ "name":"ListStreamingDistributions2014_10_21", "http":{ "method":"GET", "requestUri":"/2014-10-21/streaming-distribution" }, "input":{ "shape":"ListStreamingDistributionsRequest", "documentation":"The request to list your streaming distributions." }, "output":{ "shape":"ListStreamingDistributionsResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." } ], "documentation":"List streaming distributions." }, "UpdateCloudFrontOriginAccessIdentity":{ "name":"UpdateCloudFrontOriginAccessIdentity2014_10_21", "http":{ "method":"PUT", "requestUri":"/2014-10-21/origin-access-identity/cloudfront/{Id}/config" }, "input":{ "shape":"UpdateCloudFrontOriginAccessIdentityRequest", "documentation":"The request to update an origin access identity." }, "output":{ "shape":"UpdateCloudFrontOriginAccessIdentityResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"IllegalUpdate", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Update an origin access identity." }, "UpdateDistribution":{ "name":"UpdateDistribution2014_10_21", "http":{ "method":"PUT", "requestUri":"/2014-10-21/distribution/{Id}/config" }, "input":{ "shape":"UpdateDistributionRequest", "documentation":"The request to update a distribution." }, "output":{ "shape":"UpdateDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"IllegalUpdate", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"TooManyDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more CNAMEs than are allowed per distribution." }, { "shape":"InvalidDefaultRootObject", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The default root object file name is too big or contains an invalid character." }, { "shape":"InvalidRelativePath", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." }, { "shape":"InvalidErrorCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidResponseCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"InvalidViewerCertificate", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidRequiredProtocol", "error":{"httpStatusCode":400}, "exception":true, "documentation":"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." }, { "shape":"NoSuchOrigin", "error":{"httpStatusCode":404}, "exception":true, "documentation":"No origin exists with the specified Origin Id." }, { "shape":"TooManyOrigins", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore origins for the distribution." }, { "shape":"TooManyCacheBehaviors", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore cache behaviors for the distribution." }, { "shape":"TooManyCookieNamesInWhiteList", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." }, { "shape":"InvalidForwardCookies", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." }, { "shape":"TooManyHeadersInForwardedValues", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidHeadersForS3Origin", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." }, { "shape":"TooManyCertificates", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore custom ssl certificates." }, { "shape":"InvalidLocationCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidGeoRestrictionParameter", "error":{"httpStatusCode":400}, "exception":true } ], "documentation":"Update a distribution." }, "UpdateStreamingDistribution":{ "name":"UpdateStreamingDistribution2014_10_21", "http":{ "method":"PUT", "requestUri":"/2014-10-21/streaming-distribution/{Id}/config" }, "input":{ "shape":"UpdateStreamingDistributionRequest", "documentation":"The request to update a streaming distribution." }, "output":{ "shape":"UpdateStreamingDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"IllegalUpdate", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"TooManyStreamingDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Update a streaming distribution." } }, "shapes":{ "AccessDenied":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, "ActiveTrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Each active trusted signer." }, "Quantity":{ "shape":"integer", "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." }, "Items":{ "shape":"SignerList", "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." } }, "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." }, "AliasList":{ "type":"list", "member":{ "shape":"string", "locationName":"CNAME" } }, "Aliases":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of CNAMEs, if any, for this distribution." }, "Items":{ "shape":"AliasList", "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "AllowedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." }, "CachedMethods":{"shape":"CachedMethods"} }, "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." }, "AwsAccountNumberList":{ "type":"list", "member":{ "shape":"string", "locationName":"AwsAccountNumber" } }, "BatchTooLarge":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":413}, "exception":true }, "CNAMEAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CacheBehavior":{ "type":"structure", "required":[ "PathPattern", "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "PathPattern":{ "shape":"string", "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." }, "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." } }, "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." }, "CacheBehaviorList":{ "type":"list", "member":{ "shape":"CacheBehavior", "locationName":"CacheBehavior" } }, "CacheBehaviors":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of cache behaviors for this distribution." }, "Items":{ "shape":"CacheBehaviorList", "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CachedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." } }, "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." }, "CloudFrontOriginAccessIdentity":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The current configuration information for the identity." } }, "documentation":"CloudFront origin access identity." }, "CloudFrontOriginAccessIdentityAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, "CloudFrontOriginAccessIdentityConfig":{ "type":"structure", "required":[ "CallerReference", "Comment" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the origin access identity." } }, "documentation":"Origin access identity configuration." }, "CloudFrontOriginAccessIdentityInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more origin access identities remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." }, "Items":{ "shape":"CloudFrontOriginAccessIdentitySummaryList", "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." } }, "documentation":"The CloudFrontOriginAccessIdentityList type." }, "CloudFrontOriginAccessIdentitySummary":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId", "Comment" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "Comment":{ "shape":"string", "documentation":"The comment for this origin access identity, as originally specified when created." } }, "documentation":"Summary of the information about a CloudFront origin access identity." }, "CloudFrontOriginAccessIdentitySummaryList":{ "type":"list", "member":{ "shape":"CloudFrontOriginAccessIdentitySummary", "locationName":"CloudFrontOriginAccessIdentitySummary" } }, "CookieNameList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "CookieNames":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of whitelisted cookies for this cache behavior." }, "Items":{ "shape":"CookieNameList", "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." }, "CookiePreference":{ "type":"structure", "required":["Forward"], "members":{ "Forward":{ "shape":"ItemSelection", "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." }, "WhitelistedNames":{ "shape":"CookieNames", "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." } }, "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." }, "CreateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["CloudFrontOriginAccessIdentityConfig"], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, "locationName":"CloudFrontOriginAccessIdentityConfig" } }, "documentation":"The request to create a new origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "CreateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the origin access identity created." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "CreateDistributionRequest":{ "type":"structure", "required":["DistributionConfig"], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, "locationName":"DistributionConfig" } }, "documentation":"The request to create a new distribution.", "payload":"DistributionConfig" }, "CreateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the distribution created." } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "CreateInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "InvalidationBatch" ], "members":{ "DistributionId":{ "shape":"string", "location":"uri", "locationName":"DistributionId", "documentation":"The distribution's id." }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The batch information for the invalidation.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, "locationName":"InvalidationBatch" } }, "documentation":"The request to create an invalidation.", "payload":"InvalidationBatch" }, "CreateInvalidationResult":{ "type":"structure", "members":{ "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID." }, "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "CreateStreamingDistributionRequest":{ "type":"structure", "required":["StreamingDistributionConfig"], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, "locationName":"StreamingDistributionConfig" } }, "documentation":"The request to create a new streaming distribution.", "payload":"StreamingDistributionConfig" }, "CreateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the streaming distribution created." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "CustomErrorResponse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{ "shape":"integer", "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." }, "ResponsePagePath":{ "shape":"string", "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." }, "ResponseCode":{ "shape":"string", "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." }, "ErrorCachingMinTTL":{ "shape":"long", "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." } }, "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." }, "CustomErrorResponseList":{ "type":"list", "member":{ "shape":"CustomErrorResponse", "locationName":"CustomErrorResponse" } }, "CustomErrorResponses":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom error responses for this distribution." }, "Items":{ "shape":"CustomErrorResponseList", "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "CustomOriginConfig":{ "type":"structure", "required":[ "HTTPPort", "HTTPSPort", "OriginProtocolPolicy" ], "members":{ "HTTPPort":{ "shape":"integer", "documentation":"The HTTP port the custom origin listens on." }, "HTTPSPort":{ "shape":"integer", "documentation":"The HTTPS port the custom origin listens on." }, "OriginProtocolPolicy":{ "shape":"OriginProtocolPolicy", "documentation":"The origin protocol policy to apply to your origin." } }, "documentation":"A customer origin." }, "DefaultCacheBehavior":{ "type":"structure", "required":[ "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." } }, "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "DeleteCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The origin access identity's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to delete a origin access identity.", "required":["Id"] }, "DeleteDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to delete a distribution.", "required":["Id"] }, "DeleteStreamingDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to delete a streaming distribution.", "required":["Id"] }, "Distribution":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "InProgressInvalidationBatches", "DomainName", "ActiveTrustedSigners", "DistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "InProgressInvalidationBatches":{ "shape":"integer", "documentation":"The number of invalidation batches currently in progress." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The current configuration information for the distribution." } }, "documentation":"A distribution." }, "DistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." }, "DistributionConfig":{ "type":"structure", "required":[ "CallerReference", "Aliases", "DefaultRootObject", "Origins", "DefaultCacheBehavior", "CacheBehaviors", "Comment", "Logging", "PriceClass", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "DefaultRootObject":{ "shape":"string", "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the distribution." }, "Logging":{ "shape":"LoggingConfig", "documentation":"A complex type that controls whether access logs are written for the distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"} }, "documentation":"A distribution Configuration." }, "DistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of distributions that were created by the current AWS account." }, "Items":{ "shape":"DistributionSummaryList", "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A distribution list." }, "DistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "DistributionSummary":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "DomainName", "Aliases", "Origins", "DefaultCacheBehavior", "CacheBehaviors", "CustomErrorResponses", "Comment", "PriceClass", "Enabled", "ViewerCertificate", "Restrictions" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponses elements." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"} }, "documentation":"A summary of the information for an Amazon CloudFront distribution." }, "DistributionSummaryList":{ "type":"list", "member":{ "shape":"DistributionSummary", "locationName":"DistributionSummary" } }, "ForwardedValues":{ "type":"structure", "required":[ "QueryString", "Cookies" ], "members":{ "QueryString":{ "shape":"boolean", "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "Cookies":{ "shape":"CookiePreference", "documentation":"A complex type that specifies how CloudFront handles cookies." }, "Headers":{ "shape":"Headers", "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." } }, "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "GeoRestriction":{ "type":"structure", "required":[ "RestrictionType", "Quantity" ], "members":{ "RestrictionType":{ "shape":"GeoRestrictionType", "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." }, "Quantity":{ "shape":"integer", "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." }, "Items":{ "shape":"LocationList", "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." } }, "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." }, "GeoRestrictionType":{ "type":"string", "enum":[ "blacklist", "whitelist", "none" ] }, "GetCloudFrontOriginAccessIdentityConfigRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The identity's id." } }, "documentation":"The request to get an origin access identity's configuration.", "required":["Id"] }, "GetCloudFrontOriginAccessIdentityConfigResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "GetCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The identity's id." } }, "documentation":"The request to get an origin access identity's information.", "required":["Id"] }, "GetCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "GetDistributionConfigRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution's id." } }, "documentation":"The request to get a distribution configuration.", "required":["Id"] }, "GetDistributionConfigResult":{ "type":"structure", "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionConfig" }, "GetDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution's id." } }, "documentation":"The request to get a distribution's information.", "required":["Id"] }, "GetDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "GetInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "Id" ], "members":{ "DistributionId":{ "shape":"string", "location":"uri", "locationName":"DistributionId", "documentation":"The distribution's id." }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The invalidation's id." } }, "documentation":"The request to get an invalidation's information." }, "GetInvalidationResult":{ "type":"structure", "members":{ "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "GetStreamingDistributionConfigRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The streaming distribution's id." } }, "documentation":"To request to get a streaming distribution configuration.", "required":["Id"] }, "GetStreamingDistributionConfigResult":{ "type":"structure", "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionConfig" }, "GetStreamingDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The streaming distribution's id." } }, "documentation":"The request to get a streaming distribution's information.", "required":["Id"] }, "GetStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "HeaderList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "Headers":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." }, "Items":{ "shape":"HeaderList", "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." } }, "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." }, "IllegalUpdate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, "InconsistentQuantities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." }, "InvalidArgument":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, "InvalidDefaultRootObject":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The default root object file name is too big or contains an invalid character." }, "InvalidErrorCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidForwardCookies":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." }, "InvalidGeoRestrictionParameter":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidHeadersForS3Origin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidIfMatchVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, "InvalidLocationCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." }, "InvalidOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, "InvalidProtocolSettings":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." }, "InvalidRelativePath":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." }, "InvalidRequiredProtocol":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"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." }, "InvalidResponseCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidViewerCertificate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "Invalidation":{ "type":"structure", "required":[ "Id", "Status", "CreateTime", "InvalidationBatch" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." }, "CreateTime":{ "shape":"timestamp", "documentation":"The date and time the invalidation request was first made." }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The current invalidation information for the batch request." } }, "documentation":"An invalidation." }, "InvalidationBatch":{ "type":"structure", "required":[ "Paths", "CallerReference" ], "members":{ "Paths":{ "shape":"Paths", "documentation":"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. 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. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." }, "CallerReference":{ "shape":"string", "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. 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, the response includes the same information returned to the original request. 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, CloudFront returns an InvalidationBatchAlreadyExists error." } }, "documentation":"An invalidation batch." }, "InvalidationList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of invalidation batches that were created by the current AWS account." }, "Items":{ "shape":"InvalidationSummaryList", "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." } }, "documentation":"An invalidation list." }, "InvalidationSummary":{ "type":"structure", "required":[ "Id", "CreateTime", "Status" ], "members":{ "Id":{ "shape":"string", "documentation":"The unique ID for an invalidation request." }, "CreateTime":{"shape":"timestamp"}, "Status":{ "shape":"string", "documentation":"The status of an invalidation request." } }, "documentation":"Summary of an invalidation request." }, "InvalidationSummaryList":{ "type":"list", "member":{ "shape":"InvalidationSummary", "locationName":"InvalidationSummary" } }, "ItemSelection":{ "type":"string", "enum":[ "none", "whitelist", "all" ] }, "KeyPairIdList":{ "type":"list", "member":{ "shape":"string", "locationName":"KeyPairId" } }, "KeyPairIds":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." }, "Items":{ "shape":"KeyPairIdList", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." }, "ListCloudFrontOriginAccessIdentitiesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"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. 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)." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of origin access identities you want in the response body." } }, "documentation":"The request to list origin access identities." }, "ListCloudFrontOriginAccessIdentitiesResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityList":{ "shape":"CloudFrontOriginAccessIdentityList", "documentation":"The CloudFrontOriginAccessIdentityList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityList" }, "ListDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"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. 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)." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of distributions you want in the response body." } }, "documentation":"The request to list your distributions." }, "ListDistributionsResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionList" }, "ListInvalidationsRequest":{ "type":"structure", "required":["DistributionId"], "members":{ "DistributionId":{ "shape":"string", "location":"uri", "locationName":"DistributionId", "documentation":"The distribution's id." }, "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. 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. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of invalidation batches you want in the response body." } }, "documentation":"The request to list invalidations." }, "ListInvalidationsResult":{ "type":"structure", "members":{ "InvalidationList":{ "shape":"InvalidationList", "documentation":"Information about invalidation batches." } }, "documentation":"The returned result of the corresponding request.", "payload":"InvalidationList" }, "ListStreamingDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"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. 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)." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of streaming distributions you want in the response body." } }, "documentation":"The request to list your streaming distributions." }, "ListStreamingDistributionsResult":{ "type":"structure", "members":{ "StreamingDistributionList":{ "shape":"StreamingDistributionList", "documentation":"The StreamingDistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionList" }, "LocationList":{ "type":"list", "member":{ "shape":"string", "locationName":"Location" } }, "LoggingConfig":{ "type":"structure", "required":[ "Enabled", "IncludeCookies", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." }, "IncludeCookies":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for the distribution." }, "Method":{ "type":"string", "enum":[ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ] }, "MethodsList":{ "type":"list", "member":{ "shape":"Method", "locationName":"Method" } }, "MinimumProtocolVersion":{ "type":"string", "enum":[ "SSLv3", "TLSv1" ] }, "MissingBody":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, "NoSuchCloudFrontOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, "NoSuchDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, "NoSuchInvalidation":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified invalidation does not exist." }, "NoSuchOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"No origin exists with the specified Origin Id." }, "NoSuchStreamingDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, "Origin":{ "type":"structure", "required":[ "Id", "DomainName" ], "members":{ "Id":{ "shape":"string", "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." }, "DomainName":{ "shape":"string", "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." }, "S3OriginConfig":{ "shape":"S3OriginConfig", "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "CustomOriginConfig":{ "shape":"CustomOriginConfig", "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." } }, "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." }, "OriginList":{ "type":"list", "member":{ "shape":"Origin", "locationName":"Origin" }, "min":1 }, "OriginProtocolPolicy":{ "type":"string", "enum":[ "http-only", "match-viewer" ] }, "Origins":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of origins for this distribution." }, "Items":{ "shape":"OriginList", "documentation":"A complex type that contains origins for this distribution." } }, "documentation":"A complex type that contains information about origins for this distribution." }, "PathList":{ "type":"list", "member":{ "shape":"string", "locationName":"Path" } }, "Paths":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of objects that you want to invalidate." }, "Items":{ "shape":"PathList", "documentation":"A complex type that contains a list of the objects that you want to invalidate." } }, "documentation":"A complex type that contains information about the objects that you want to invalidate." }, "PreconditionFailed":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, "PriceClass":{ "type":"string", "enum":[ "PriceClass_100", "PriceClass_200", "PriceClass_All" ] }, "Restrictions":{ "type":"structure", "required":["GeoRestriction"], "members":{ "GeoRestriction":{"shape":"GeoRestriction"} }, "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." }, "S3Origin":{ "type":"structure", "required":[ "DomainName", "OriginAccessIdentity" ], "members":{ "DomainName":{ "shape":"string", "documentation":"The DNS name of the S3 origin." }, "OriginAccessIdentity":{ "shape":"string", "documentation":"Your S3 origin's origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "S3OriginConfig":{ "type":"structure", "required":["OriginAccessIdentity"], "members":{ "OriginAccessIdentity":{ "shape":"string", "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "SSLSupportMethod":{ "type":"string", "enum":[ "sni-only", "vip" ] }, "Signer":{ "type":"structure", "members":{ "AwsAccountNumber":{ "shape":"string", "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." }, "KeyPairIds":{ "shape":"KeyPairIds", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." }, "SignerList":{ "type":"list", "member":{ "shape":"Signer", "locationName":"Signer" } }, "StreamingDistribution":{ "type":"structure", "required":[ "Id", "Status", "DomainName", "ActiveTrustedSigners", "StreamingDistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." }, "Status":{ "shape":"string", "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The current configuration information for the streaming distribution." } }, "documentation":"A streaming distribution." }, "StreamingDistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionConfig":{ "type":"structure", "required":[ "CallerReference", "S3Origin", "Aliases", "Comment", "Logging", "TrustedSigners", "PriceClass", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the streaming distribution." }, "Logging":{ "shape":"StreamingLoggingConfig", "documentation":"A complex type that controls whether access logs are written for the streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this streaming distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." } }, "documentation":"The configuration for the streaming distribution." }, "StreamingDistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more streaming distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of streaming distributions that were created by the current AWS account." }, "Items":{ "shape":"StreamingDistributionSummaryList", "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A streaming distribution list." }, "StreamingDistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionSummary":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "DomainName", "S3Origin", "Aliases", "TrustedSigners", "Comment", "PriceClass", "Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." } }, "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." }, "StreamingDistributionSummaryList":{ "type":"list", "member":{ "shape":"StreamingDistributionSummary", "locationName":"StreamingDistributionSummary" } }, "StreamingLoggingConfig":{ "type":"structure", "required":[ "Enabled", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for this streaming distribution." }, "TooManyCacheBehaviors":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore cache behaviors for the distribution." }, "TooManyCertificates":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore custom ssl certificates." }, "TooManyCloudFrontOriginAccessIdentities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." }, "TooManyCookieNamesInWhiteList":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." }, "TooManyDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more CNAMEs than are allowed per distribution." }, "TooManyDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." }, "TooManyHeadersInForwardedValues":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyInvalidationsInProgress":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." }, "TooManyOrigins":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore origins for the distribution." }, "TooManyStreamingDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." }, "TooManyTrustedSigners":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, "TrustedSignerDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, "TrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." }, "Quantity":{ "shape":"integer", "documentation":"The number of trusted signers for this cache behavior." }, "Items":{ "shape":"AwsAccountNumberList", "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "UpdateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":[ "CloudFrontOriginAccessIdentityConfig", "Id" ], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The identity's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, "locationName":"CloudFrontOriginAccessIdentityConfig" }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The identity's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to update an origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "UpdateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "UpdateDistributionRequest":{ "type":"structure", "required":[ "DistributionConfig", "Id" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, "locationName":"DistributionConfig" }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to update a distribution.", "payload":"DistributionConfig" }, "UpdateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "UpdateStreamingDistributionRequest":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Id" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, "locationName":"StreamingDistributionConfig" }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The streaming distribution's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to update a streaming distribution.", "payload":"StreamingDistributionConfig" }, "UpdateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "ViewerCertificate":{ "type":"structure", "members":{ "IAMCertificateId":{ "shape":"string", "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate." }, "CloudFrontDefaultCertificate":{ "shape":"boolean", "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId." }, "SSLSupportMethod":{ "shape":"SSLSupportMethod", "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." }, "MinimumProtocolVersion":{ "shape":"MinimumProtocolVersion", "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." } }, "documentation":"A complex type that contains information about viewer certificates for this distribution." }, "ViewerProtocolPolicy":{ "type":"string", "enum":[ "allow-all", "https-only", "redirect-to-https" ] }, "boolean":{"type":"boolean"}, "integer":{"type":"integer"}, "long":{"type":"long"}, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} } } botocore-1.5.7/botocore/data/cloudfront/2015-09-17/0000777454262600001440000000000013042511307022354 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudfront/2015-09-17/waiters-2.json0000666454262600001440000000224013042511306025061 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DistributionDeployed": { "delay": 60, "operation": "GetDistribution", "maxAttempts": 25, "description": "Wait until a distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "Distribution.Status" } ] }, "InvalidationCompleted": { "delay": 20, "operation": "GetInvalidation", "maxAttempts": 60, "description": "Wait until an invalidation has completed.", "acceptors": [ { "expected": "Completed", "matcher": "path", "state": "success", "argument": "Invalidation.Status" } ] }, "StreamingDistributionDeployed": { "delay": 60, "operation": "GetStreamingDistribution", "maxAttempts": 25, "description": "Wait until a streaming distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "StreamingDistribution.Status" } ] } } } botocore-1.5.7/botocore/data/cloudfront/2015-09-17/paginators-1.json0000666454262600001440000000214613042511306025556 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListCloudFrontOriginAccessIdentities": { "input_token": "Marker", "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", "limit_key": "MaxItems", "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", "result_key": "CloudFrontOriginAccessIdentityList.Items" }, "ListDistributions": { "input_token": "Marker", "output_token": "DistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "DistributionList.IsTruncated", "result_key": "DistributionList.Items" }, "ListInvalidations": { "input_token": "Marker", "output_token": "InvalidationList.NextMarker", "limit_key": "MaxItems", "more_results": "InvalidationList.IsTruncated", "result_key": "InvalidationList.Items" }, "ListStreamingDistributions": { "input_token": "Marker", "output_token": "StreamingDistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "StreamingDistributionList.IsTruncated", "result_key": "StreamingDistributionList.Items" } } } botocore-1.5.7/botocore/data/cloudfront/2015-09-17/service-2.json0000666454262600001440000037730213042511306025061 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-09-17", "endpointPrefix":"cloudfront", "globalEndpoint":"cloudfront.amazonaws.com", "protocol":"rest-xml", "serviceAbbreviation":"CloudFront", "serviceFullName":"Amazon CloudFront", "signatureVersion":"v4" }, "operations":{ "CreateCloudFrontOriginAccessIdentity":{ "name":"CreateCloudFrontOriginAccessIdentity2015_09_17", "http":{ "method":"POST", "requestUri":"/2015-09-17/origin-access-identity/cloudfront", "responseCode":201 }, "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, {"shape":"MissingBody"}, {"shape":"TooManyCloudFrontOriginAccessIdentities"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new origin access identity." }, "CreateDistribution":{ "name":"CreateDistribution2015_09_17", "http":{ "method":"POST", "requestUri":"/2015-09-17/distribution", "responseCode":201 }, "input":{"shape":"CreateDistributionRequest"}, "output":{"shape":"CreateDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"DistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"MissingBody"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"TooManyDistributions"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidProtocolSettings"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"} ], "documentation":"Create a new distribution." }, "CreateInvalidation":{ "name":"CreateInvalidation2015_09_17", "http":{ "method":"POST", "requestUri":"/2015-09-17/distribution/{DistributionId}/invalidation", "responseCode":201 }, "input":{"shape":"CreateInvalidationRequest"}, "output":{"shape":"CreateInvalidationResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"MissingBody"}, {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"BatchTooLarge"}, {"shape":"TooManyInvalidationsInProgress"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new invalidation." }, "CreateStreamingDistribution":{ "name":"CreateStreamingDistribution2015_09_17", "http":{ "method":"POST", "requestUri":"/2015-09-17/streaming-distribution", "responseCode":201 }, "input":{"shape":"CreateStreamingDistributionRequest"}, "output":{"shape":"CreateStreamingDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"StreamingDistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"MissingBody"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"TooManyStreamingDistributions"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new streaming distribution." }, "DeleteCloudFrontOriginAccessIdentity":{ "name":"DeleteCloudFrontOriginAccessIdentity2015_09_17", "http":{ "method":"DELETE", "requestUri":"/2015-09-17/origin-access-identity/cloudfront/{Id}", "responseCode":204 }, "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"PreconditionFailed"}, {"shape":"CloudFrontOriginAccessIdentityInUse"} ], "documentation":"Delete an origin access identity." }, "DeleteDistribution":{ "name":"DeleteDistribution2015_09_17", "http":{ "method":"DELETE", "requestUri":"/2015-09-17/distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"DistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"Delete a distribution." }, "DeleteStreamingDistribution":{ "name":"DeleteStreamingDistribution2015_09_17", "http":{ "method":"DELETE", "requestUri":"/2015-09-17/streaming-distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteStreamingDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"StreamingDistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"Delete a streaming distribution." }, "GetCloudFrontOriginAccessIdentity":{ "name":"GetCloudFrontOriginAccessIdentity2015_09_17", "http":{ "method":"GET", "requestUri":"/2015-09-17/origin-access-identity/cloudfront/{Id}" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about an origin access identity." }, "GetCloudFrontOriginAccessIdentityConfig":{ "name":"GetCloudFrontOriginAccessIdentityConfig2015_09_17", "http":{ "method":"GET", "requestUri":"/2015-09-17/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about an origin access identity." }, "GetDistribution":{ "name":"GetDistribution2015_09_17", "http":{ "method":"GET", "requestUri":"/2015-09-17/distribution/{Id}" }, "input":{"shape":"GetDistributionRequest"}, "output":{"shape":"GetDistributionResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about a distribution." }, "GetDistributionConfig":{ "name":"GetDistributionConfig2015_09_17", "http":{ "method":"GET", "requestUri":"/2015-09-17/distribution/{Id}/config" }, "input":{"shape":"GetDistributionConfigRequest"}, "output":{"shape":"GetDistributionConfigResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about a distribution." }, "GetInvalidation":{ "name":"GetInvalidation2015_09_17", "http":{ "method":"GET", "requestUri":"/2015-09-17/distribution/{DistributionId}/invalidation/{Id}" }, "input":{"shape":"GetInvalidationRequest"}, "output":{"shape":"GetInvalidationResult"}, "errors":[ {"shape":"NoSuchInvalidation"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about an invalidation." }, "GetStreamingDistribution":{ "name":"GetStreamingDistribution2015_09_17", "http":{ "method":"GET", "requestUri":"/2015-09-17/streaming-distribution/{Id}" }, "input":{"shape":"GetStreamingDistributionRequest"}, "output":{"shape":"GetStreamingDistributionResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about a streaming distribution." }, "GetStreamingDistributionConfig":{ "name":"GetStreamingDistributionConfig2015_09_17", "http":{ "method":"GET", "requestUri":"/2015-09-17/streaming-distribution/{Id}/config" }, "input":{"shape":"GetStreamingDistributionConfigRequest"}, "output":{"shape":"GetStreamingDistributionConfigResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about a streaming distribution." }, "ListCloudFrontOriginAccessIdentities":{ "name":"ListCloudFrontOriginAccessIdentities2015_09_17", "http":{ "method":"GET", "requestUri":"/2015-09-17/origin-access-identity/cloudfront" }, "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List origin access identities." }, "ListDistributions":{ "name":"ListDistributions2015_09_17", "http":{ "method":"GET", "requestUri":"/2015-09-17/distribution" }, "input":{"shape":"ListDistributionsRequest"}, "output":{"shape":"ListDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List distributions." }, "ListDistributionsByWebACLId":{ "name":"ListDistributionsByWebACLId2015_09_17", "http":{ "method":"GET", "requestUri":"/2015-09-17/distributionsByWebACLId/{WebACLId}" }, "input":{"shape":"ListDistributionsByWebACLIdRequest"}, "output":{"shape":"ListDistributionsByWebACLIdResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"InvalidWebACLId"} ], "documentation":"List the distributions that are associated with a specified AWS WAF web ACL." }, "ListInvalidations":{ "name":"ListInvalidations2015_09_17", "http":{ "method":"GET", "requestUri":"/2015-09-17/distribution/{DistributionId}/invalidation" }, "input":{"shape":"ListInvalidationsRequest"}, "output":{"shape":"ListInvalidationsResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"List invalidation batches." }, "ListStreamingDistributions":{ "name":"ListStreamingDistributions2015_09_17", "http":{ "method":"GET", "requestUri":"/2015-09-17/streaming-distribution" }, "input":{"shape":"ListStreamingDistributionsRequest"}, "output":{"shape":"ListStreamingDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List streaming distributions." }, "UpdateCloudFrontOriginAccessIdentity":{ "name":"UpdateCloudFrontOriginAccessIdentity2015_09_17", "http":{ "method":"PUT", "requestUri":"/2015-09-17/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"PreconditionFailed"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Update an origin access identity." }, "UpdateDistribution":{ "name":"UpdateDistribution2015_09_17", "http":{ "method":"PUT", "requestUri":"/2015-09-17/distribution/{Id}/config" }, "input":{"shape":"UpdateDistributionRequest"}, "output":{"shape":"UpdateDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"} ], "documentation":"Update a distribution." }, "UpdateStreamingDistribution":{ "name":"UpdateStreamingDistribution2015_09_17", "http":{ "method":"PUT", "requestUri":"/2015-09-17/streaming-distribution/{Id}/config" }, "input":{"shape":"UpdateStreamingDistributionRequest"}, "output":{"shape":"UpdateStreamingDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InconsistentQuantities"} ], "documentation":"Update a streaming distribution." } }, "shapes":{ "AccessDenied":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Access denied.", "error":{"httpStatusCode":403}, "exception":true }, "ActiveTrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Each active trusted signer." }, "Quantity":{ "shape":"integer", "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." }, "Items":{ "shape":"SignerList", "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." } }, "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." }, "AliasList":{ "type":"list", "member":{ "shape":"string", "locationName":"CNAME" } }, "Aliases":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of CNAMEs, if any, for this distribution." }, "Items":{ "shape":"AliasList", "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "AllowedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." }, "CachedMethods":{"shape":"CachedMethods"} }, "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." }, "AwsAccountNumberList":{ "type":"list", "member":{ "shape":"string", "locationName":"AwsAccountNumber" } }, "BatchTooLarge":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":413}, "exception":true }, "CNAMEAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CacheBehavior":{ "type":"structure", "required":[ "PathPattern", "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "PathPattern":{ "shape":"string", "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." }, "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "DefaultTTL":{ "shape":"long", "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "MaxTTL":{ "shape":"long", "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "Compress":{ "shape":"boolean", "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." } }, "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." }, "CacheBehaviorList":{ "type":"list", "member":{ "shape":"CacheBehavior", "locationName":"CacheBehavior" } }, "CacheBehaviors":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of cache behaviors for this distribution." }, "Items":{ "shape":"CacheBehaviorList", "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CachedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." } }, "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." }, "CertificateSource":{ "type":"string", "enum":[ "cloudfront", "iam" ] }, "CloudFrontOriginAccessIdentity":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The current configuration information for the identity." } }, "documentation":"CloudFront origin access identity." }, "CloudFrontOriginAccessIdentityAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.", "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityConfig":{ "type":"structure", "required":[ "CallerReference", "Comment" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the origin access identity." } }, "documentation":"Origin access identity configuration." }, "CloudFrontOriginAccessIdentityInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more origin access identities remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." }, "Items":{ "shape":"CloudFrontOriginAccessIdentitySummaryList", "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." } }, "documentation":"The CloudFrontOriginAccessIdentityList type." }, "CloudFrontOriginAccessIdentitySummary":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId", "Comment" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "Comment":{ "shape":"string", "documentation":"The comment for this origin access identity, as originally specified when created." } }, "documentation":"Summary of the information about a CloudFront origin access identity." }, "CloudFrontOriginAccessIdentitySummaryList":{ "type":"list", "member":{ "shape":"CloudFrontOriginAccessIdentitySummary", "locationName":"CloudFrontOriginAccessIdentitySummary" } }, "CookieNameList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "CookieNames":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of whitelisted cookies for this cache behavior." }, "Items":{ "shape":"CookieNameList", "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." }, "CookiePreference":{ "type":"structure", "required":["Forward"], "members":{ "Forward":{ "shape":"ItemSelection", "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." }, "WhitelistedNames":{ "shape":"CookieNames", "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." } }, "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." }, "CreateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["CloudFrontOriginAccessIdentityConfig"], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information.", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-09-17/"} } }, "documentation":"The request to create a new origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "CreateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the origin access identity created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "CreateDistributionRequest":{ "type":"structure", "required":["DistributionConfig"], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-09-17/"} } }, "documentation":"The request to create a new distribution.", "payload":"DistributionConfig" }, "CreateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "CreateInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "InvalidationBatch" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The batch information for the invalidation.", "locationName":"InvalidationBatch", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-09-17/"} } }, "documentation":"The request to create an invalidation.", "payload":"InvalidationBatch" }, "CreateInvalidationResult":{ "type":"structure", "members":{ "Location":{ "shape":"string", "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.", "location":"header", "locationName":"Location" }, "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "CreateStreamingDistributionRequest":{ "type":"structure", "required":["StreamingDistributionConfig"], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-09-17/"} } }, "documentation":"The request to create a new streaming distribution.", "payload":"StreamingDistributionConfig" }, "CreateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "CustomErrorResponse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{ "shape":"integer", "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." }, "ResponsePagePath":{ "shape":"string", "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." }, "ResponseCode":{ "shape":"string", "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." }, "ErrorCachingMinTTL":{ "shape":"long", "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." } }, "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." }, "CustomErrorResponseList":{ "type":"list", "member":{ "shape":"CustomErrorResponse", "locationName":"CustomErrorResponse" } }, "CustomErrorResponses":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom error responses for this distribution." }, "Items":{ "shape":"CustomErrorResponseList", "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "CustomOriginConfig":{ "type":"structure", "required":[ "HTTPPort", "HTTPSPort", "OriginProtocolPolicy" ], "members":{ "HTTPPort":{ "shape":"integer", "documentation":"The HTTP port the custom origin listens on." }, "HTTPSPort":{ "shape":"integer", "documentation":"The HTTPS port the custom origin listens on." }, "OriginProtocolPolicy":{ "shape":"OriginProtocolPolicy", "documentation":"The origin protocol policy to apply to your origin." } }, "documentation":"A customer origin." }, "DefaultCacheBehavior":{ "type":"structure", "required":[ "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "DefaultTTL":{ "shape":"long", "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "MaxTTL":{ "shape":"long", "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "Compress":{ "shape":"boolean", "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." } }, "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "DeleteCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The origin access identity's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a origin access identity." }, "DeleteDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a distribution." }, "DeleteStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a streaming distribution." }, "Distribution":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "InProgressInvalidationBatches", "DomainName", "ActiveTrustedSigners", "DistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "InProgressInvalidationBatches":{ "shape":"integer", "documentation":"The number of invalidation batches currently in progress." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The current configuration information for the distribution." } }, "documentation":"A distribution." }, "DistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution.", "error":{"httpStatusCode":409}, "exception":true }, "DistributionConfig":{ "type":"structure", "required":[ "CallerReference", "Origins", "DefaultCacheBehavior", "Comment", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "DefaultRootObject":{ "shape":"string", "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the distribution." }, "Logging":{ "shape":"LoggingConfig", "documentation":"A complex type that controls whether access logs are written for the distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"(Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution." } }, "documentation":"A distribution Configuration." }, "DistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of distributions that were created by the current AWS account." }, "Items":{ "shape":"DistributionSummaryList", "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A distribution list." }, "DistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "DistributionSummary":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "DomainName", "Aliases", "Origins", "DefaultCacheBehavior", "CacheBehaviors", "CustomErrorResponses", "Comment", "PriceClass", "Enabled", "ViewerCertificate", "Restrictions", "WebACLId" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponses elements." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"The Web ACL Id (if any) associated with the distribution." } }, "documentation":"A summary of the information for an Amazon CloudFront distribution." }, "DistributionSummaryList":{ "type":"list", "member":{ "shape":"DistributionSummary", "locationName":"DistributionSummary" } }, "ForwardedValues":{ "type":"structure", "required":[ "QueryString", "Cookies" ], "members":{ "QueryString":{ "shape":"boolean", "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "Cookies":{ "shape":"CookiePreference", "documentation":"A complex type that specifies how CloudFront handles cookies." }, "Headers":{ "shape":"Headers", "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." } }, "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "GeoRestriction":{ "type":"structure", "required":[ "RestrictionType", "Quantity" ], "members":{ "RestrictionType":{ "shape":"GeoRestrictionType", "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." }, "Quantity":{ "shape":"integer", "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." }, "Items":{ "shape":"LocationList", "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." } }, "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." }, "GeoRestrictionType":{ "type":"string", "enum":[ "blacklist", "whitelist", "none" ] }, "GetCloudFrontOriginAccessIdentityConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an origin access identity's configuration." }, "GetCloudFrontOriginAccessIdentityConfigResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "GetCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an origin access identity's information." }, "GetCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "GetDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a distribution configuration." }, "GetDistributionConfigResult":{ "type":"structure", "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionConfig" }, "GetDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a distribution's information." }, "GetDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "GetInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "Id" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "Id":{ "shape":"string", "documentation":"The invalidation's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an invalidation's information." }, "GetInvalidationResult":{ "type":"structure", "members":{ "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "GetStreamingDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"To request to get a streaming distribution configuration." }, "GetStreamingDistributionConfigResult":{ "type":"structure", "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionConfig" }, "GetStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a streaming distribution's information." }, "GetStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "HeaderList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "Headers":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." }, "Items":{ "shape":"HeaderList", "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." } }, "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." }, "IllegalUpdate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Origin and CallerReference cannot be updated.", "error":{"httpStatusCode":400}, "exception":true }, "InconsistentQuantities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The value of Quantity and the size of Items do not match.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidArgument":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The argument is invalid.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidDefaultRootObject":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The default root object file name is too big or contains an invalid character.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidErrorCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidForwardCookies":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidGeoRestrictionParameter":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidHeadersForS3Origin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidIfMatchVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The If-Match version is missing or not valid for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidLocationCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidMinimumProtocolVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The origin access identity is not valid or doesn't exist.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidProtocolSettings":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI).", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRelativePath":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/).", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRequiredProtocol":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"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.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidResponseCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidTTLOrder":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidViewerCertificate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidWebACLId":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "Invalidation":{ "type":"structure", "required":[ "Id", "Status", "CreateTime", "InvalidationBatch" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." }, "CreateTime":{ "shape":"timestamp", "documentation":"The date and time the invalidation request was first made." }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The current invalidation information for the batch request." } }, "documentation":"An invalidation." }, "InvalidationBatch":{ "type":"structure", "required":[ "Paths", "CallerReference" ], "members":{ "Paths":{ "shape":"Paths", "documentation":"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. 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. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." }, "CallerReference":{ "shape":"string", "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. 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, the response includes the same information returned to the original request. 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, CloudFront returns an InvalidationBatchAlreadyExists error." } }, "documentation":"An invalidation batch." }, "InvalidationList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of invalidation batches that were created by the current AWS account." }, "Items":{ "shape":"InvalidationSummaryList", "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." } }, "documentation":"An invalidation list." }, "InvalidationSummary":{ "type":"structure", "required":[ "Id", "CreateTime", "Status" ], "members":{ "Id":{ "shape":"string", "documentation":"The unique ID for an invalidation request." }, "CreateTime":{"shape":"timestamp"}, "Status":{ "shape":"string", "documentation":"The status of an invalidation request." } }, "documentation":"Summary of an invalidation request." }, "InvalidationSummaryList":{ "type":"list", "member":{ "shape":"InvalidationSummary", "locationName":"InvalidationSummary" } }, "ItemSelection":{ "type":"string", "enum":[ "none", "whitelist", "all" ] }, "KeyPairIdList":{ "type":"list", "member":{ "shape":"string", "locationName":"KeyPairId" } }, "KeyPairIds":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." }, "Items":{ "shape":"KeyPairIdList", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." }, "ListCloudFrontOriginAccessIdentitiesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"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. 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).", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of origin access identities you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list origin access identities." }, "ListCloudFrontOriginAccessIdentitiesResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityList":{ "shape":"CloudFrontOriginAccessIdentityList", "documentation":"The CloudFrontOriginAccessIdentityList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityList" }, "ListDistributionsByWebACLIdRequest":{ "type":"structure", "required":["WebACLId"], "members":{ "Marker":{ "shape":"string", "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", "location":"querystring", "locationName":"MaxItems" }, "WebACLId":{ "shape":"string", "documentation":"The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify \"null\" for the Id, the request returns a list of the distributions that aren't associated with a web ACL.", "location":"uri", "locationName":"WebACLId" } }, "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL." }, "ListDistributionsByWebACLIdResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.", "payload":"DistributionList" }, "ListDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list your distributions." }, "ListDistributionsResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionList" }, "ListInvalidationsRequest":{ "type":"structure", "required":["DistributionId"], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "Marker":{ "shape":"string", "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. 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. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of invalidation batches you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list invalidations." }, "ListInvalidationsResult":{ "type":"structure", "members":{ "InvalidationList":{ "shape":"InvalidationList", "documentation":"Information about invalidation batches." } }, "documentation":"The returned result of the corresponding request.", "payload":"InvalidationList" }, "ListStreamingDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"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. 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).", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of streaming distributions you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list your streaming distributions." }, "ListStreamingDistributionsResult":{ "type":"structure", "members":{ "StreamingDistributionList":{ "shape":"StreamingDistributionList", "documentation":"The StreamingDistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionList" }, "LocationList":{ "type":"list", "member":{ "shape":"string", "locationName":"Location" } }, "LoggingConfig":{ "type":"structure", "required":[ "Enabled", "IncludeCookies", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." }, "IncludeCookies":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for the distribution." }, "Method":{ "type":"string", "enum":[ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ] }, "MethodsList":{ "type":"list", "member":{ "shape":"Method", "locationName":"Method" } }, "MinimumProtocolVersion":{ "type":"string", "enum":[ "SSLv3", "TLSv1" ] }, "MissingBody":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set.", "error":{"httpStatusCode":400}, "exception":true }, "NoSuchCloudFrontOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified origin access identity does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified distribution does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchInvalidation":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified invalidation does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"No origin exists with the specified Origin Id.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchStreamingDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified streaming distribution does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "Origin":{ "type":"structure", "required":[ "Id", "DomainName" ], "members":{ "Id":{ "shape":"string", "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." }, "DomainName":{ "shape":"string", "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." }, "OriginPath":{ "shape":"string", "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." }, "S3OriginConfig":{ "shape":"S3OriginConfig", "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "CustomOriginConfig":{ "shape":"CustomOriginConfig", "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." } }, "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." }, "OriginList":{ "type":"list", "member":{ "shape":"Origin", "locationName":"Origin" }, "min":1 }, "OriginProtocolPolicy":{ "type":"string", "enum":[ "http-only", "match-viewer" ] }, "Origins":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of origins for this distribution." }, "Items":{ "shape":"OriginList", "documentation":"A complex type that contains origins for this distribution." } }, "documentation":"A complex type that contains information about origins for this distribution." }, "PathList":{ "type":"list", "member":{ "shape":"string", "locationName":"Path" } }, "Paths":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of objects that you want to invalidate." }, "Items":{ "shape":"PathList", "documentation":"A complex type that contains a list of the objects that you want to invalidate." } }, "documentation":"A complex type that contains information about the objects that you want to invalidate." }, "PreconditionFailed":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The precondition given in one or more of the request-header fields evaluated to false.", "error":{"httpStatusCode":412}, "exception":true }, "PriceClass":{ "type":"string", "enum":[ "PriceClass_100", "PriceClass_200", "PriceClass_All" ] }, "Restrictions":{ "type":"structure", "required":["GeoRestriction"], "members":{ "GeoRestriction":{"shape":"GeoRestriction"} }, "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." }, "S3Origin":{ "type":"structure", "required":[ "DomainName", "OriginAccessIdentity" ], "members":{ "DomainName":{ "shape":"string", "documentation":"The DNS name of the S3 origin." }, "OriginAccessIdentity":{ "shape":"string", "documentation":"Your S3 origin's origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "S3OriginConfig":{ "type":"structure", "required":["OriginAccessIdentity"], "members":{ "OriginAccessIdentity":{ "shape":"string", "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "SSLSupportMethod":{ "type":"string", "enum":[ "sni-only", "vip" ] }, "Signer":{ "type":"structure", "members":{ "AwsAccountNumber":{ "shape":"string", "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." }, "KeyPairIds":{ "shape":"KeyPairIds", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." }, "SignerList":{ "type":"list", "member":{ "shape":"Signer", "locationName":"Signer" } }, "StreamingDistribution":{ "type":"structure", "required":[ "Id", "Status", "DomainName", "ActiveTrustedSigners", "StreamingDistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." }, "Status":{ "shape":"string", "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The current configuration information for the streaming distribution." } }, "documentation":"A streaming distribution." }, "StreamingDistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionConfig":{ "type":"structure", "required":[ "CallerReference", "S3Origin", "Comment", "TrustedSigners", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the streaming distribution." }, "Logging":{ "shape":"StreamingLoggingConfig", "documentation":"A complex type that controls whether access logs are written for the streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this streaming distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." } }, "documentation":"The configuration for the streaming distribution." }, "StreamingDistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more streaming distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of streaming distributions that were created by the current AWS account." }, "Items":{ "shape":"StreamingDistributionSummaryList", "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A streaming distribution list." }, "StreamingDistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionSummary":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "DomainName", "S3Origin", "Aliases", "TrustedSigners", "Comment", "PriceClass", "Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." } }, "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." }, "StreamingDistributionSummaryList":{ "type":"list", "member":{ "shape":"StreamingDistributionSummary", "locationName":"StreamingDistributionSummary" } }, "StreamingLoggingConfig":{ "type":"structure", "required":[ "Enabled", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for this streaming distribution." }, "TooManyCacheBehaviors":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore cache behaviors for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCertificates":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore custom ssl certificates.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCloudFrontOriginAccessIdentities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCookieNamesInWhiteList":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more CNAMEs than are allowed per distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyHeadersInForwardedValues":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyInvalidationsInProgress":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyOrigins":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore origins for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyTrustedSigners":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more trusted signers than are allowed per distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSignerDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"One or more of your trusted signers do not exist.", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." }, "Quantity":{ "shape":"integer", "documentation":"The number of trusted signers for this cache behavior." }, "Items":{ "shape":"AwsAccountNumberList", "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "UpdateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":[ "CloudFrontOriginAccessIdentityConfig", "Id" ], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The identity's configuration information.", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-09-17/"} }, "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update an origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "UpdateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "UpdateDistributionRequest":{ "type":"structure", "required":[ "DistributionConfig", "Id" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-09-17/"} }, "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update a distribution.", "payload":"DistributionConfig" }, "UpdateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "UpdateStreamingDistributionRequest":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Id" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-09-17/"} }, "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update a streaming distribution.", "payload":"StreamingDistributionConfig" }, "UpdateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "ViewerCertificate":{ "type":"structure", "members":{ "Certificate":{ "shape":"string", "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), set to the IAM certificate identifier of the custom viewer certificate for this distribution." }, "CertificateSource":{ "shape":"CertificateSource", "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to \"cloudfront\". If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), set to \"iam\", and update the Certificate field with the IAM certificate identifier of the custom viewer certificate for this distribution." }, "SSLSupportMethod":{ "shape":"SSLSupportMethod", "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." }, "MinimumProtocolVersion":{ "shape":"MinimumProtocolVersion", "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." }, "IAMCertificateId":{ "shape":"string", "documentation":"Note: this field is deprecated. Please use \"iam\" as CertificateSource and specify the IAM certificate Id as the Certificate. If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate.", "deprecated":true }, "CloudFrontDefaultCertificate":{ "shape":"boolean", "documentation":"Note: this field is deprecated. Please use \"cloudfront\" as CertificateSource and omit specifying a Certificate. If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId.", "deprecated":true } }, "documentation":"A complex type that contains information about viewer certificates for this distribution." }, "ViewerProtocolPolicy":{ "type":"string", "enum":[ "allow-all", "https-only", "redirect-to-https" ] }, "boolean":{"type":"boolean"}, "integer":{"type":"integer"}, "long":{"type":"long"}, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} } } botocore-1.5.7/botocore/data/cloudfront/2014-05-31/0000777454262600001440000000000013042511307022343 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudfront/2014-05-31/waiters-2.json0000666454262600001440000000224013042511306025050 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DistributionDeployed": { "delay": 60, "operation": "GetDistribution", "maxAttempts": 25, "description": "Wait until a distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "Distribution.Status" } ] }, "InvalidationCompleted": { "delay": 20, "operation": "GetInvalidation", "maxAttempts": 60, "description": "Wait until an invalidation has completed.", "acceptors": [ { "expected": "Completed", "matcher": "path", "state": "success", "argument": "Invalidation.Status" } ] }, "StreamingDistributionDeployed": { "delay": 60, "operation": "GetStreamingDistribution", "maxAttempts": 25, "description": "Wait until a streaming distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "StreamingDistribution.Status" } ] } } } botocore-1.5.7/botocore/data/cloudfront/2014-05-31/paginators-1.json0000666454262600001440000000214613042511306025545 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListCloudFrontOriginAccessIdentities": { "input_token": "Marker", "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", "limit_key": "MaxItems", "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", "result_key": "CloudFrontOriginAccessIdentityList.Items" }, "ListDistributions": { "input_token": "Marker", "output_token": "DistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "DistributionList.IsTruncated", "result_key": "DistributionList.Items" }, "ListInvalidations": { "input_token": "Marker", "output_token": "InvalidationList.NextMarker", "limit_key": "MaxItems", "more_results": "InvalidationList.IsTruncated", "result_key": "InvalidationList.Items" }, "ListStreamingDistributions": { "input_token": "Marker", "output_token": "StreamingDistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "StreamingDistributionList.IsTruncated", "result_key": "StreamingDistributionList.Items" } } } botocore-1.5.7/botocore/data/cloudfront/2014-05-31/service-2.json0000666454262600001440000043211613042511306025043 0ustar pysdk-ciamazon00000000000000{ "metadata":{ "apiVersion":"2014-05-31", "endpointPrefix":"cloudfront", "globalEndpoint":"cloudfront.amazonaws.com", "serviceAbbreviation":"CloudFront", "serviceFullName":"Amazon CloudFront", "signatureVersion":"v4", "protocol":"rest-xml" }, "operations":{ "CreateCloudFrontOriginAccessIdentity":{ "name":"CreateCloudFrontOriginAccessIdentity2014_05_31", "http":{ "method":"POST", "requestUri":"/2014-05-31/origin-access-identity/cloudfront", "responseCode":201 }, "input":{ "shape":"CreateCloudFrontOriginAccessIdentityRequest", "documentation":"The request to create a new origin access identity." }, "output":{ "shape":"CreateCloudFrontOriginAccessIdentityResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"CloudFrontOriginAccessIdentityAlreadyExists", "error":{"httpStatusCode":409}, "exception":true, "documentation":"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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"TooManyCloudFrontOriginAccessIdentities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Create a new origin access identity." }, "CreateDistribution":{ "name":"CreateDistribution2014_05_31", "http":{ "method":"POST", "requestUri":"/2014-05-31/distribution", "responseCode":201 }, "input":{ "shape":"CreateDistributionRequest", "documentation":"The request to create a new distribution." }, "output":{ "shape":"CreateDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"DistributionAlreadyExists", "error":{"httpStatusCode":409}, "exception":true, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." }, { "shape":"InvalidOrigin", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"InvalidViewerCertificate", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"TooManyDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more CNAMEs than are allowed per distribution." }, { "shape":"TooManyDistributions", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." }, { "shape":"InvalidDefaultRootObject", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The default root object file name is too big or contains an invalid character." }, { "shape":"InvalidRelativePath", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." }, { "shape":"InvalidErrorCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidResponseCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InvalidRequiredProtocol", "error":{"httpStatusCode":400}, "exception":true, "documentation":"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." }, { "shape":"NoSuchOrigin", "error":{"httpStatusCode":404}, "exception":true, "documentation":"No origin exists with the specified Origin Id." }, { "shape":"TooManyOrigins", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore origins for the distribution." }, { "shape":"TooManyCacheBehaviors", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore cache behaviors for the distribution." }, { "shape":"TooManyCookieNamesInWhiteList", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." }, { "shape":"InvalidForwardCookies", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." }, { "shape":"TooManyHeadersInForwardedValues", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidHeadersForS3Origin", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." }, { "shape":"TooManyCertificates", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore custom ssl certificates." }, { "shape":"InvalidLocationCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidGeoRestrictionParameter", "error":{"httpStatusCode":400}, "exception":true } ], "documentation":"Create a new distribution." }, "CreateInvalidation":{ "name":"CreateInvalidation2014_05_31", "http":{ "method":"POST", "requestUri":"/2014-05-31/distribution/{DistributionId}/invalidation", "responseCode":201 }, "input":{ "shape":"CreateInvalidationRequest", "documentation":"The request to create an invalidation." }, "output":{ "shape":"CreateInvalidationResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"BatchTooLarge", "error":{"httpStatusCode":413}, "exception":true }, { "shape":"TooManyInvalidationsInProgress", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Create a new invalidation." }, "CreateStreamingDistribution":{ "name":"CreateStreamingDistribution2014_05_31", "http":{ "method":"POST", "requestUri":"/2014-05-31/streaming-distribution", "responseCode":201 }, "input":{ "shape":"CreateStreamingDistributionRequest", "documentation":"The request to create a new streaming distribution." }, "output":{ "shape":"CreateStreamingDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"StreamingDistributionAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"InvalidOrigin", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"TooManyStreamingDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyStreamingDistributions", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Create a new streaming distribution." }, "DeleteCloudFrontOriginAccessIdentity":{ "name":"DeleteCloudFrontOriginAccessIdentity2014_05_31", "http":{ "method":"DELETE", "requestUri":"/2014-05-31/origin-access-identity/cloudfront/{Id}", "responseCode":204 }, "input":{ "shape":"DeleteCloudFrontOriginAccessIdentityRequest", "documentation":"The request to delete a origin access identity." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"CloudFrontOriginAccessIdentityInUse", "error":{"httpStatusCode":409}, "exception":true } ], "documentation":"Delete an origin access identity." }, "DeleteDistribution":{ "name":"DeleteDistribution2014_05_31", "http":{ "method":"DELETE", "requestUri":"/2014-05-31/distribution/{Id}", "responseCode":204 }, "input":{ "shape":"DeleteDistributionRequest", "documentation":"The request to delete a distribution." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"DistributionNotDisabled", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." } ], "documentation":"Delete a distribution." }, "DeleteStreamingDistribution":{ "name":"DeleteStreamingDistribution2014_05_31", "http":{ "method":"DELETE", "requestUri":"/2014-05-31/streaming-distribution/{Id}", "responseCode":204 }, "input":{ "shape":"DeleteStreamingDistributionRequest", "documentation":"The request to delete a streaming distribution." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"StreamingDistributionNotDisabled", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." } ], "documentation":"Delete a streaming distribution." }, "GetCloudFrontOriginAccessIdentity":{ "name":"GetCloudFrontOriginAccessIdentity2014_05_31", "http":{ "method":"GET", "requestUri":"/2014-05-31/origin-access-identity/cloudfront/{Id}" }, "input":{ "shape":"GetCloudFrontOriginAccessIdentityRequest", "documentation":"The request to get an origin access identity's information." }, "output":{ "shape":"GetCloudFrontOriginAccessIdentityResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about an origin access identity." }, "GetCloudFrontOriginAccessIdentityConfig":{ "name":"GetCloudFrontOriginAccessIdentityConfig2014_05_31", "http":{ "method":"GET", "requestUri":"/2014-05-31/origin-access-identity/cloudfront/{Id}/config" }, "input":{ "shape":"GetCloudFrontOriginAccessIdentityConfigRequest", "documentation":"The request to get an origin access identity's configuration." }, "output":{ "shape":"GetCloudFrontOriginAccessIdentityConfigResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the configuration information about an origin access identity." }, "GetDistribution":{ "name":"GetDistribution2014_05_31", "http":{ "method":"GET", "requestUri":"/2014-05-31/distribution/{Id}" }, "input":{ "shape":"GetDistributionRequest", "documentation":"The request to get a distribution's information." }, "output":{ "shape":"GetDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about a distribution." }, "GetDistributionConfig":{ "name":"GetDistributionConfig2014_05_31", "http":{ "method":"GET", "requestUri":"/2014-05-31/distribution/{Id}/config" }, "input":{ "shape":"GetDistributionConfigRequest", "documentation":"The request to get a distribution configuration." }, "output":{ "shape":"GetDistributionConfigResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the configuration information about a distribution." }, "GetInvalidation":{ "name":"GetInvalidation2014_05_31", "http":{ "method":"GET", "requestUri":"/2014-05-31/distribution/{DistributionId}/invalidation/{Id}" }, "input":{ "shape":"GetInvalidationRequest", "documentation":"The request to get an invalidation's information." }, "output":{ "shape":"GetInvalidationResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchInvalidation", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified invalidation does not exist." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about an invalidation." }, "GetStreamingDistribution":{ "name":"GetStreamingDistribution2014_05_31", "http":{ "method":"GET", "requestUri":"/2014-05-31/streaming-distribution/{Id}" }, "input":{ "shape":"GetStreamingDistributionRequest", "documentation":"The request to get a streaming distribution's information." }, "output":{ "shape":"GetStreamingDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about a streaming distribution." }, "GetStreamingDistributionConfig":{ "name":"GetStreamingDistributionConfig2014_05_31", "http":{ "method":"GET", "requestUri":"/2014-05-31/streaming-distribution/{Id}/config" }, "input":{ "shape":"GetStreamingDistributionConfigRequest", "documentation":"To request to get a streaming distribution configuration." }, "output":{ "shape":"GetStreamingDistributionConfigResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the configuration information about a streaming distribution." }, "ListCloudFrontOriginAccessIdentities":{ "name":"ListCloudFrontOriginAccessIdentities2014_05_31", "http":{ "method":"GET", "requestUri":"/2014-05-31/origin-access-identity/cloudfront" }, "input":{ "shape":"ListCloudFrontOriginAccessIdentitiesRequest", "documentation":"The request to list origin access identities." }, "output":{ "shape":"ListCloudFrontOriginAccessIdentitiesResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." } ], "documentation":"List origin access identities." }, "ListDistributions":{ "name":"ListDistributions2014_05_31", "http":{ "method":"GET", "requestUri":"/2014-05-31/distribution" }, "input":{ "shape":"ListDistributionsRequest", "documentation":"The request to list your distributions." }, "output":{ "shape":"ListDistributionsResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." } ], "documentation":"List distributions." }, "ListInvalidations":{ "name":"ListInvalidations2014_05_31", "http":{ "method":"GET", "requestUri":"/2014-05-31/distribution/{DistributionId}/invalidation" }, "input":{ "shape":"ListInvalidationsRequest", "documentation":"The request to list invalidations." }, "output":{ "shape":"ListInvalidationsResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"List invalidation batches." }, "ListStreamingDistributions":{ "name":"ListStreamingDistributions2014_05_31", "http":{ "method":"GET", "requestUri":"/2014-05-31/streaming-distribution" }, "input":{ "shape":"ListStreamingDistributionsRequest", "documentation":"The request to list your streaming distributions." }, "output":{ "shape":"ListStreamingDistributionsResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." } ], "documentation":"List streaming distributions." }, "UpdateCloudFrontOriginAccessIdentity":{ "name":"UpdateCloudFrontOriginAccessIdentity2014_05_31", "http":{ "method":"PUT", "requestUri":"/2014-05-31/origin-access-identity/cloudfront/{Id}/config" }, "input":{ "shape":"UpdateCloudFrontOriginAccessIdentityRequest", "documentation":"The request to update an origin access identity." }, "output":{ "shape":"UpdateCloudFrontOriginAccessIdentityResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"IllegalUpdate", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Update an origin access identity." }, "UpdateDistribution":{ "name":"UpdateDistribution2014_05_31", "http":{ "method":"PUT", "requestUri":"/2014-05-31/distribution/{Id}/config" }, "input":{ "shape":"UpdateDistributionRequest", "documentation":"The request to update a distribution." }, "output":{ "shape":"UpdateDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"IllegalUpdate", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"TooManyDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more CNAMEs than are allowed per distribution." }, { "shape":"InvalidDefaultRootObject", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The default root object file name is too big or contains an invalid character." }, { "shape":"InvalidRelativePath", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." }, { "shape":"InvalidErrorCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidResponseCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"InvalidViewerCertificate", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidRequiredProtocol", "error":{"httpStatusCode":400}, "exception":true, "documentation":"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." }, { "shape":"NoSuchOrigin", "error":{"httpStatusCode":404}, "exception":true, "documentation":"No origin exists with the specified Origin Id." }, { "shape":"TooManyOrigins", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore origins for the distribution." }, { "shape":"TooManyCacheBehaviors", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore cache behaviors for the distribution." }, { "shape":"TooManyCookieNamesInWhiteList", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." }, { "shape":"InvalidForwardCookies", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." }, { "shape":"TooManyHeadersInForwardedValues", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidHeadersForS3Origin", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." }, { "shape":"TooManyCertificates", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore custom ssl certificates." }, { "shape":"InvalidLocationCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidGeoRestrictionParameter", "error":{"httpStatusCode":400}, "exception":true } ], "documentation":"Update a distribution." }, "UpdateStreamingDistribution":{ "name":"UpdateStreamingDistribution2014_05_31", "http":{ "method":"PUT", "requestUri":"/2014-05-31/streaming-distribution/{Id}/config" }, "input":{ "shape":"UpdateStreamingDistributionRequest", "documentation":"The request to update a streaming distribution." }, "output":{ "shape":"UpdateStreamingDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"IllegalUpdate", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"TooManyStreamingDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Update a streaming distribution." } }, "shapes":{ "AccessDenied":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, "ActiveTrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Each active trusted signer." }, "Quantity":{ "shape":"integer", "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." }, "Items":{ "shape":"SignerList", "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." } }, "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." }, "AliasList":{ "type":"list", "member":{ "shape":"string", "locationName":"CNAME" } }, "Aliases":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of CNAMEs, if any, for this distribution." }, "Items":{ "shape":"AliasList", "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "AllowedMethods":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT requests)." }, "Items":{ "shape":"AllowedMethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." } }, "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are two options: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT requests. If you choose the second option, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." }, "AllowedMethodsList":{ "type":"list", "member":{ "shape":"Method", "locationName":"Method" } }, "AwsAccountNumberList":{ "type":"list", "member":{ "shape":"string", "locationName":"AwsAccountNumber" } }, "BatchTooLarge":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":413}, "exception":true }, "CNAMEAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CacheBehavior":{ "type":"structure", "required":[ "PathPattern", "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "PathPattern":{ "shape":"string", "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." }, "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." } }, "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." }, "CacheBehaviorList":{ "type":"list", "member":{ "shape":"CacheBehavior", "locationName":"CacheBehavior" } }, "CacheBehaviors":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of cache behaviors for this distribution." }, "Items":{ "shape":"CacheBehaviorList", "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CloudFrontOriginAccessIdentity":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The current configuration information for the identity." } }, "documentation":"CloudFront origin access identity." }, "CloudFrontOriginAccessIdentityAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, "CloudFrontOriginAccessIdentityConfig":{ "type":"structure", "required":[ "CallerReference", "Comment" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the origin access identity." } }, "documentation":"Origin access identity configuration." }, "CloudFrontOriginAccessIdentityInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more origin access identities remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." }, "Items":{ "shape":"CloudFrontOriginAccessIdentitySummaryList", "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." } }, "documentation":"The CloudFrontOriginAccessIdentityList type." }, "CloudFrontOriginAccessIdentitySummary":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId", "Comment" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "Comment":{ "shape":"string", "documentation":"The comment for this origin access identity, as originally specified when created." } }, "documentation":"Summary of the information about a CloudFront origin access identity." }, "CloudFrontOriginAccessIdentitySummaryList":{ "type":"list", "member":{ "shape":"CloudFrontOriginAccessIdentitySummary", "locationName":"CloudFrontOriginAccessIdentitySummary" } }, "CookieNameList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "CookieNames":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of whitelisted cookies for this cache behavior." }, "Items":{ "shape":"CookieNameList", "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." }, "CookiePreference":{ "type":"structure", "required":["Forward"], "members":{ "Forward":{ "shape":"ItemSelection", "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." }, "WhitelistedNames":{ "shape":"CookieNames", "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." } }, "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." }, "CreateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["CloudFrontOriginAccessIdentityConfig"], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, "locationName":"CloudFrontOriginAccessIdentityConfig" } }, "documentation":"The request to create a new origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "CreateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the origin access identity created." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "CreateDistributionRequest":{ "type":"structure", "required":["DistributionConfig"], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, "locationName":"DistributionConfig" } }, "documentation":"The request to create a new distribution.", "payload":"DistributionConfig" }, "CreateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the distribution created." } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "CreateInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "InvalidationBatch" ], "members":{ "DistributionId":{ "shape":"string", "location":"uri", "locationName":"DistributionId", "documentation":"The distribution's id." }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The batch information for the invalidation.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, "locationName":"InvalidationBatch" } }, "documentation":"The request to create an invalidation.", "payload":"InvalidationBatch" }, "CreateInvalidationResult":{ "type":"structure", "members":{ "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID." }, "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "CreateStreamingDistributionRequest":{ "type":"structure", "required":["StreamingDistributionConfig"], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, "locationName":"StreamingDistributionConfig" } }, "documentation":"The request to create a new streaming distribution.", "payload":"StreamingDistributionConfig" }, "CreateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the streaming distribution created." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "CustomErrorResponse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{ "shape":"integer", "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." }, "ResponsePagePath":{ "shape":"string", "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." }, "ResponseCode":{ "shape":"string", "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." }, "ErrorCachingMinTTL":{ "shape":"long", "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." } }, "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." }, "CustomErrorResponseList":{ "type":"list", "member":{ "shape":"CustomErrorResponse", "locationName":"CustomErrorResponse" } }, "CustomErrorResponses":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom error responses for this distribution." }, "Items":{ "shape":"CustomErrorResponseList", "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "CustomOriginConfig":{ "type":"structure", "required":[ "HTTPPort", "HTTPSPort", "OriginProtocolPolicy" ], "members":{ "HTTPPort":{ "shape":"integer", "documentation":"The HTTP port the custom origin listens on." }, "HTTPSPort":{ "shape":"integer", "documentation":"The HTTPS port the custom origin listens on." }, "OriginProtocolPolicy":{ "shape":"OriginProtocolPolicy", "documentation":"The origin protocol policy to apply to your origin." } }, "documentation":"A customer origin." }, "DefaultCacheBehavior":{ "type":"structure", "required":[ "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." } }, "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "DeleteCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The origin access identity's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to delete a origin access identity.", "required":["Id"] }, "DeleteDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to delete a distribution.", "required":["Id"] }, "DeleteStreamingDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to delete a streaming distribution.", "required":["Id"] }, "Distribution":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "InProgressInvalidationBatches", "DomainName", "ActiveTrustedSigners", "DistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "InProgressInvalidationBatches":{ "shape":"integer", "documentation":"The number of invalidation batches currently in progress." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The current configuration information for the distribution." } }, "documentation":"A distribution." }, "DistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." }, "DistributionConfig":{ "type":"structure", "required":[ "CallerReference", "Aliases", "DefaultRootObject", "Origins", "DefaultCacheBehavior", "CacheBehaviors", "Comment", "Logging", "PriceClass", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "DefaultRootObject":{ "shape":"string", "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the distribution." }, "Logging":{ "shape":"LoggingConfig", "documentation":"A complex type that controls whether access logs are written for the distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"} }, "documentation":"A distribution Configuration." }, "DistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of distributions that were created by the current AWS account." }, "Items":{ "shape":"DistributionSummaryList", "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A distribution list." }, "DistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "DistributionSummary":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "DomainName", "Aliases", "Origins", "DefaultCacheBehavior", "CacheBehaviors", "CustomErrorResponses", "Comment", "PriceClass", "Enabled", "ViewerCertificate", "Restrictions" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponses elements." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"} }, "documentation":"A summary of the information for an Amazon CloudFront distribution." }, "DistributionSummaryList":{ "type":"list", "member":{ "shape":"DistributionSummary", "locationName":"DistributionSummary" } }, "ForwardedValues":{ "type":"structure", "required":[ "QueryString", "Cookies" ], "members":{ "QueryString":{ "shape":"boolean", "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "Cookies":{ "shape":"CookiePreference", "documentation":"A complex type that specifies how CloudFront handles cookies." }, "Headers":{ "shape":"Headers", "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." } }, "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "GeoRestriction":{ "type":"structure", "required":[ "RestrictionType", "Quantity" ], "members":{ "RestrictionType":{ "shape":"GeoRestrictionType", "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." }, "Quantity":{ "shape":"integer", "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." }, "Items":{ "shape":"LocationList", "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." } }, "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." }, "GeoRestrictionType":{ "type":"string", "enum":[ "blacklist", "whitelist", "none" ] }, "GetCloudFrontOriginAccessIdentityConfigRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The identity's id." } }, "documentation":"The request to get an origin access identity's configuration.", "required":["Id"] }, "GetCloudFrontOriginAccessIdentityConfigResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "GetCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The identity's id." } }, "documentation":"The request to get an origin access identity's information.", "required":["Id"] }, "GetCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "GetDistributionConfigRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution's id." } }, "documentation":"The request to get a distribution configuration.", "required":["Id"] }, "GetDistributionConfigResult":{ "type":"structure", "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionConfig" }, "GetDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution's id." } }, "documentation":"The request to get a distribution's information.", "required":["Id"] }, "GetDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "GetInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "Id" ], "members":{ "DistributionId":{ "shape":"string", "location":"uri", "locationName":"DistributionId", "documentation":"The distribution's id." }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The invalidation's id." } }, "documentation":"The request to get an invalidation's information." }, "GetInvalidationResult":{ "type":"structure", "members":{ "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "GetStreamingDistributionConfigRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The streaming distribution's id." } }, "documentation":"To request to get a streaming distribution configuration.", "required":["Id"] }, "GetStreamingDistributionConfigResult":{ "type":"structure", "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionConfig" }, "GetStreamingDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The streaming distribution's id." } }, "documentation":"The request to get a streaming distribution's information.", "required":["Id"] }, "GetStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "HeaderList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "Headers":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." }, "Items":{ "shape":"HeaderList", "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." } }, "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." }, "IllegalUpdate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, "InconsistentQuantities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." }, "InvalidArgument":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, "InvalidDefaultRootObject":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The default root object file name is too big or contains an invalid character." }, "InvalidErrorCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidForwardCookies":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." }, "InvalidGeoRestrictionParameter":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidHeadersForS3Origin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidIfMatchVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, "InvalidLocationCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." }, "InvalidOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, "InvalidRelativePath":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." }, "InvalidRequiredProtocol":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"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." }, "InvalidResponseCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidViewerCertificate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "Invalidation":{ "type":"structure", "required":[ "Id", "Status", "CreateTime", "InvalidationBatch" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." }, "CreateTime":{ "shape":"timestamp", "documentation":"The date and time the invalidation request was first made." }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The current invalidation information for the batch request." } }, "documentation":"An invalidation." }, "InvalidationBatch":{ "type":"structure", "required":[ "Paths", "CallerReference" ], "members":{ "Paths":{ "shape":"Paths", "documentation":"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. 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. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." }, "CallerReference":{ "shape":"string", "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. 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, the response includes the same information returned to the original request. 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, CloudFront returns an InvalidationBatchAlreadyExists error." } }, "documentation":"An invalidation batch." }, "InvalidationList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of invalidation batches that were created by the current AWS account." }, "Items":{ "shape":"InvalidationSummaryList", "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." } }, "documentation":"An invalidation list." }, "InvalidationSummary":{ "type":"structure", "required":[ "Id", "CreateTime", "Status" ], "members":{ "Id":{ "shape":"string", "documentation":"The unique ID for an invalidation request." }, "CreateTime":{"shape":"timestamp"}, "Status":{ "shape":"string", "documentation":"The status of an invalidation request." } }, "documentation":"Summary of an invalidation request." }, "InvalidationSummaryList":{ "type":"list", "member":{ "shape":"InvalidationSummary", "locationName":"InvalidationSummary" } }, "ItemSelection":{ "type":"string", "enum":[ "none", "whitelist", "all" ] }, "KeyPairIdList":{ "type":"list", "member":{ "shape":"string", "locationName":"KeyPairId" } }, "KeyPairIds":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." }, "Items":{ "shape":"KeyPairIdList", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." }, "ListCloudFrontOriginAccessIdentitiesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"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. 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)." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of origin access identities you want in the response body." } }, "documentation":"The request to list origin access identities." }, "ListCloudFrontOriginAccessIdentitiesResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityList":{ "shape":"CloudFrontOriginAccessIdentityList", "documentation":"The CloudFrontOriginAccessIdentityList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityList" }, "ListDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"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. 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)." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of distributions you want in the response body." } }, "documentation":"The request to list your distributions." }, "ListDistributionsResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionList" }, "ListInvalidationsRequest":{ "type":"structure", "required":["DistributionId"], "members":{ "DistributionId":{ "shape":"string", "location":"uri", "locationName":"DistributionId", "documentation":"The distribution's id." }, "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. 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. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of invalidation batches you want in the response body." } }, "documentation":"The request to list invalidations." }, "ListInvalidationsResult":{ "type":"structure", "members":{ "InvalidationList":{ "shape":"InvalidationList", "documentation":"Information about invalidation batches." } }, "documentation":"The returned result of the corresponding request.", "payload":"InvalidationList" }, "ListStreamingDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"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. 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)." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of streaming distributions you want in the response body." } }, "documentation":"The request to list your streaming distributions." }, "ListStreamingDistributionsResult":{ "type":"structure", "members":{ "StreamingDistributionList":{ "shape":"StreamingDistributionList", "documentation":"The StreamingDistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionList" }, "LocationList":{ "type":"list", "member":{ "shape":"string", "locationName":"Location" } }, "LoggingConfig":{ "type":"structure", "required":[ "Enabled", "IncludeCookies", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." }, "IncludeCookies":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for the distribution." }, "Method":{ "type":"string", "enum":[ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ] }, "MissingBody":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, "NoSuchCloudFrontOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, "NoSuchDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, "NoSuchInvalidation":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified invalidation does not exist." }, "NoSuchOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"No origin exists with the specified Origin Id." }, "NoSuchStreamingDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, "Origin":{ "type":"structure", "required":[ "Id", "DomainName" ], "members":{ "Id":{ "shape":"string", "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." }, "DomainName":{ "shape":"string", "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." }, "S3OriginConfig":{ "shape":"S3OriginConfig", "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "CustomOriginConfig":{ "shape":"CustomOriginConfig", "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." } }, "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." }, "OriginList":{ "type":"list", "member":{ "shape":"Origin", "locationName":"Origin" }, "min":1 }, "OriginProtocolPolicy":{ "type":"string", "enum":[ "http-only", "match-viewer" ] }, "Origins":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of origins for this distribution." }, "Items":{ "shape":"OriginList", "documentation":"A complex type that contains origins for this distribution." } }, "documentation":"A complex type that contains information about origins for this distribution." }, "PathList":{ "type":"list", "member":{ "shape":"string", "locationName":"Path" } }, "Paths":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of objects that you want to invalidate." }, "Items":{ "shape":"PathList", "documentation":"A complex type that contains a list of the objects that you want to invalidate." } }, "documentation":"A complex type that contains information about the objects that you want to invalidate." }, "PreconditionFailed":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, "PriceClass":{ "type":"string", "enum":[ "PriceClass_100", "PriceClass_200", "PriceClass_All" ] }, "Restrictions":{ "type":"structure", "required":["GeoRestriction"], "members":{ "GeoRestriction":{"shape":"GeoRestriction"} }, "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." }, "S3Origin":{ "type":"structure", "required":[ "DomainName", "OriginAccessIdentity" ], "members":{ "DomainName":{ "shape":"string", "documentation":"The DNS name of the S3 origin." }, "OriginAccessIdentity":{ "shape":"string", "documentation":"Your S3 origin's origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "S3OriginConfig":{ "type":"structure", "required":["OriginAccessIdentity"], "members":{ "OriginAccessIdentity":{ "shape":"string", "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "SSLSupportMethod":{ "type":"string", "enum":[ "sni-only", "vip" ] }, "Signer":{ "type":"structure", "members":{ "AwsAccountNumber":{ "shape":"string", "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." }, "KeyPairIds":{ "shape":"KeyPairIds", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." }, "SignerList":{ "type":"list", "member":{ "shape":"Signer", "locationName":"Signer" } }, "StreamingDistribution":{ "type":"structure", "required":[ "Id", "Status", "DomainName", "ActiveTrustedSigners", "StreamingDistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." }, "Status":{ "shape":"string", "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The current configuration information for the streaming distribution." } }, "documentation":"A streaming distribution." }, "StreamingDistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionConfig":{ "type":"structure", "required":[ "CallerReference", "S3Origin", "Aliases", "Comment", "Logging", "TrustedSigners", "PriceClass", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the streaming distribution." }, "Logging":{ "shape":"StreamingLoggingConfig", "documentation":"A complex type that controls whether access logs are written for the streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this streaming distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." } }, "documentation":"The configuration for the streaming distribution." }, "StreamingDistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more streaming distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of streaming distributions that were created by the current AWS account." }, "Items":{ "shape":"StreamingDistributionSummaryList", "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A streaming distribution list." }, "StreamingDistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionSummary":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "DomainName", "S3Origin", "Aliases", "TrustedSigners", "Comment", "PriceClass", "Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." } }, "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." }, "StreamingDistributionSummaryList":{ "type":"list", "member":{ "shape":"StreamingDistributionSummary", "locationName":"StreamingDistributionSummary" } }, "StreamingLoggingConfig":{ "type":"structure", "required":[ "Enabled", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for this streaming distribution." }, "TooManyCacheBehaviors":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore cache behaviors for the distribution." }, "TooManyCertificates":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore custom ssl certificates." }, "TooManyCloudFrontOriginAccessIdentities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." }, "TooManyCookieNamesInWhiteList":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." }, "TooManyDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more CNAMEs than are allowed per distribution." }, "TooManyDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." }, "TooManyHeadersInForwardedValues":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyInvalidationsInProgress":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." }, "TooManyOrigins":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore origins for the distribution." }, "TooManyStreamingDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." }, "TooManyTrustedSigners":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, "TrustedSignerDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, "TrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." }, "Quantity":{ "shape":"integer", "documentation":"The number of trusted signers for this cache behavior." }, "Items":{ "shape":"AwsAccountNumberList", "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "UpdateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":[ "CloudFrontOriginAccessIdentityConfig", "Id" ], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The identity's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, "locationName":"CloudFrontOriginAccessIdentityConfig" }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The identity's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to update an origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "UpdateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "UpdateDistributionRequest":{ "type":"structure", "required":[ "DistributionConfig", "Id" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, "locationName":"DistributionConfig" }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to update a distribution.", "payload":"DistributionConfig" }, "UpdateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "UpdateStreamingDistributionRequest":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Id" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, "locationName":"StreamingDistributionConfig" }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The streaming distribution's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to update a streaming distribution.", "payload":"StreamingDistributionConfig" }, "UpdateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "ViewerCertificate":{ "type":"structure", "members":{ "IAMCertificateId":{ "shape":"string", "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate." }, "CloudFrontDefaultCertificate":{ "shape":"boolean", "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId." }, "SSLSupportMethod":{ "shape":"SSLSupportMethod", "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." } }, "documentation":"A complex type that contains information about viewer certificates for this distribution." }, "ViewerProtocolPolicy":{ "type":"string", "enum":[ "allow-all", "https-only", "redirect-to-https" ] }, "boolean":{"type":"boolean"}, "integer":{"type":"integer"}, "long":{"type":"long"}, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} } } botocore-1.5.7/botocore/data/cloudfront/2016-11-25/0000777454262600001440000000000013042511307022345 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudfront/2016-11-25/waiters-2.json0000666454262600001440000000224013042511306025052 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DistributionDeployed": { "delay": 60, "operation": "GetDistribution", "maxAttempts": 25, "description": "Wait until a distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "Distribution.Status" } ] }, "InvalidationCompleted": { "delay": 20, "operation": "GetInvalidation", "maxAttempts": 60, "description": "Wait until an invalidation has completed.", "acceptors": [ { "expected": "Completed", "matcher": "path", "state": "success", "argument": "Invalidation.Status" } ] }, "StreamingDistributionDeployed": { "delay": 60, "operation": "GetStreamingDistribution", "maxAttempts": 25, "description": "Wait until a streaming distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "StreamingDistribution.Status" } ] } } } botocore-1.5.7/botocore/data/cloudfront/2016-11-25/paginators-1.json0000666454262600001440000000214613042511306025547 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListCloudFrontOriginAccessIdentities": { "input_token": "Marker", "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", "limit_key": "MaxItems", "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", "result_key": "CloudFrontOriginAccessIdentityList.Items" }, "ListDistributions": { "input_token": "Marker", "output_token": "DistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "DistributionList.IsTruncated", "result_key": "DistributionList.Items" }, "ListInvalidations": { "input_token": "Marker", "output_token": "InvalidationList.NextMarker", "limit_key": "MaxItems", "more_results": "InvalidationList.IsTruncated", "result_key": "InvalidationList.Items" }, "ListStreamingDistributions": { "input_token": "Marker", "output_token": "StreamingDistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "StreamingDistributionList.IsTruncated", "result_key": "StreamingDistributionList.Items" } } } botocore-1.5.7/botocore/data/cloudfront/2016-11-25/service-2.json0000666454262600001440000060246413042511306025052 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-11-25", "endpointPrefix":"cloudfront", "globalEndpoint":"cloudfront.amazonaws.com", "protocol":"rest-xml", "serviceAbbreviation":"CloudFront", "serviceFullName":"Amazon CloudFront", "signatureVersion":"v4", "uid":"cloudfront-2016-11-25" }, "operations":{ "CreateCloudFrontOriginAccessIdentity":{ "name":"CreateCloudFrontOriginAccessIdentity2016_11_25", "http":{ "method":"POST", "requestUri":"/2016-11-25/origin-access-identity/cloudfront", "responseCode":201 }, "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, {"shape":"MissingBody"}, {"shape":"TooManyCloudFrontOriginAccessIdentities"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" }, "CreateDistribution":{ "name":"CreateDistribution2016_11_25", "http":{ "method":"POST", "requestUri":"/2016-11-25/distribution", "responseCode":201 }, "input":{"shape":"CreateDistributionRequest"}, "output":{"shape":"CreateDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"DistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"MissingBody"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"TooManyDistributions"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidProtocolSettings"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"}, {"shape":"TooManyQueryStringParameters"}, {"shape":"InvalidQueryStringParameters"}, {"shape":"TooManyDistributionsWithLambdaAssociations"}, {"shape":"TooManyLambdaFunctionAssociations"}, {"shape":"InvalidLambdaFunctionAssociation"} ], "documentation":"

Creates a new web distribution. Send a GET request to the /CloudFront API version/distribution/distribution ID resource.

" }, "CreateDistributionWithTags":{ "name":"CreateDistributionWithTags2016_11_25", "http":{ "method":"POST", "requestUri":"/2016-11-25/distribution?WithTags", "responseCode":201 }, "input":{"shape":"CreateDistributionWithTagsRequest"}, "output":{"shape":"CreateDistributionWithTagsResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"DistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"MissingBody"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"TooManyDistributions"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidProtocolSettings"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"}, {"shape":"InvalidTagging"}, {"shape":"TooManyQueryStringParameters"}, {"shape":"InvalidQueryStringParameters"}, {"shape":"TooManyDistributionsWithLambdaAssociations"}, {"shape":"TooManyLambdaFunctionAssociations"}, {"shape":"InvalidLambdaFunctionAssociation"} ], "documentation":"

Create a new distribution with tags.

" }, "CreateInvalidation":{ "name":"CreateInvalidation2016_11_25", "http":{ "method":"POST", "requestUri":"/2016-11-25/distribution/{DistributionId}/invalidation", "responseCode":201 }, "input":{"shape":"CreateInvalidationRequest"}, "output":{"shape":"CreateInvalidationResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"MissingBody"}, {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"BatchTooLarge"}, {"shape":"TooManyInvalidationsInProgress"}, {"shape":"InconsistentQuantities"} ], "documentation":"

Create a new invalidation.

" }, "CreateStreamingDistribution":{ "name":"CreateStreamingDistribution2016_11_25", "http":{ "method":"POST", "requestUri":"/2016-11-25/streaming-distribution", "responseCode":201 }, "input":{"shape":"CreateStreamingDistributionRequest"}, "output":{"shape":"CreateStreamingDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"StreamingDistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"MissingBody"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"TooManyStreamingDistributions"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"

Creates a new RMTP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP.

To create a new web distribution, submit a POST request to the CloudFront API version/distribution resource. The request body must include a document with a StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig element and returns other information about the RTMP distribution.

To get the status of your request, use the GET StreamingDistribution API action. When the value of Enabled is true and the value of Status is Deployed, your distribution is ready. A distribution usually deploys in less than 15 minutes.

For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide.

Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the Quantity element and the number of values specified.

" }, "CreateStreamingDistributionWithTags":{ "name":"CreateStreamingDistributionWithTags2016_11_25", "http":{ "method":"POST", "requestUri":"/2016-11-25/streaming-distribution?WithTags", "responseCode":201 }, "input":{"shape":"CreateStreamingDistributionWithTagsRequest"}, "output":{"shape":"CreateStreamingDistributionWithTagsResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"StreamingDistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"MissingBody"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"TooManyStreamingDistributions"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"}, {"shape":"InvalidTagging"} ], "documentation":"

Create a new streaming distribution with tags.

" }, "DeleteCloudFrontOriginAccessIdentity":{ "name":"DeleteCloudFrontOriginAccessIdentity2016_11_25", "http":{ "method":"DELETE", "requestUri":"/2016-11-25/origin-access-identity/cloudfront/{Id}", "responseCode":204 }, "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"PreconditionFailed"}, {"shape":"CloudFrontOriginAccessIdentityInUse"} ], "documentation":"

Delete an origin access identity.

" }, "DeleteDistribution":{ "name":"DeleteDistribution2016_11_25", "http":{ "method":"DELETE", "requestUri":"/2016-11-25/distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"DistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"

Delete a distribution.

" }, "DeleteStreamingDistribution":{ "name":"DeleteStreamingDistribution2016_11_25", "http":{ "method":"DELETE", "requestUri":"/2016-11-25/streaming-distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteStreamingDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"StreamingDistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"

Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.

To delete an RTMP distribution using the CloudFront API:

  1. Disable the RTMP distribution.

  2. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  5. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  8. Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" }, "GetCloudFrontOriginAccessIdentity":{ "name":"GetCloudFrontOriginAccessIdentity2016_11_25", "http":{ "method":"GET", "requestUri":"/2016-11-25/origin-access-identity/cloudfront/{Id}" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"

Get the information about an origin access identity.

" }, "GetCloudFrontOriginAccessIdentityConfig":{ "name":"GetCloudFrontOriginAccessIdentityConfig2016_11_25", "http":{ "method":"GET", "requestUri":"/2016-11-25/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"

Get the configuration information about an origin access identity.

" }, "GetDistribution":{ "name":"GetDistribution2016_11_25", "http":{ "method":"GET", "requestUri":"/2016-11-25/distribution/{Id}" }, "input":{"shape":"GetDistributionRequest"}, "output":{"shape":"GetDistributionResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"

Get the information about a distribution.

" }, "GetDistributionConfig":{ "name":"GetDistributionConfig2016_11_25", "http":{ "method":"GET", "requestUri":"/2016-11-25/distribution/{Id}/config" }, "input":{"shape":"GetDistributionConfigRequest"}, "output":{"shape":"GetDistributionConfigResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"

Get the configuration information about a distribution.

" }, "GetInvalidation":{ "name":"GetInvalidation2016_11_25", "http":{ "method":"GET", "requestUri":"/2016-11-25/distribution/{DistributionId}/invalidation/{Id}" }, "input":{"shape":"GetInvalidationRequest"}, "output":{"shape":"GetInvalidationResult"}, "errors":[ {"shape":"NoSuchInvalidation"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"

Get the information about an invalidation.

" }, "GetStreamingDistribution":{ "name":"GetStreamingDistribution2016_11_25", "http":{ "method":"GET", "requestUri":"/2016-11-25/streaming-distribution/{Id}" }, "input":{"shape":"GetStreamingDistributionRequest"}, "output":{"shape":"GetStreamingDistributionResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"

Gets information about a specified RTMP distribution, including the distribution configuration.

" }, "GetStreamingDistributionConfig":{ "name":"GetStreamingDistributionConfig2016_11_25", "http":{ "method":"GET", "requestUri":"/2016-11-25/streaming-distribution/{Id}/config" }, "input":{"shape":"GetStreamingDistributionConfigRequest"}, "output":{"shape":"GetStreamingDistributionConfigResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"

Get the configuration information about a streaming distribution.

" }, "ListCloudFrontOriginAccessIdentities":{ "name":"ListCloudFrontOriginAccessIdentities2016_11_25", "http":{ "method":"GET", "requestUri":"/2016-11-25/origin-access-identity/cloudfront" }, "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"

Lists origin access identities.

" }, "ListDistributions":{ "name":"ListDistributions2016_11_25", "http":{ "method":"GET", "requestUri":"/2016-11-25/distribution" }, "input":{"shape":"ListDistributionsRequest"}, "output":{"shape":"ListDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"

List distributions.

" }, "ListDistributionsByWebACLId":{ "name":"ListDistributionsByWebACLId2016_11_25", "http":{ "method":"GET", "requestUri":"/2016-11-25/distributionsByWebACLId/{WebACLId}" }, "input":{"shape":"ListDistributionsByWebACLIdRequest"}, "output":{"shape":"ListDistributionsByWebACLIdResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"InvalidWebACLId"} ], "documentation":"

List the distributions that are associated with a specified AWS WAF web ACL.

" }, "ListInvalidations":{ "name":"ListInvalidations2016_11_25", "http":{ "method":"GET", "requestUri":"/2016-11-25/distribution/{DistributionId}/invalidation" }, "input":{"shape":"ListInvalidationsRequest"}, "output":{"shape":"ListInvalidationsResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"

Lists invalidation batches.

" }, "ListStreamingDistributions":{ "name":"ListStreamingDistributions2016_11_25", "http":{ "method":"GET", "requestUri":"/2016-11-25/streaming-distribution" }, "input":{"shape":"ListStreamingDistributionsRequest"}, "output":{"shape":"ListStreamingDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"

List streaming distributions.

" }, "ListTagsForResource":{ "name":"ListTagsForResource2016_11_25", "http":{ "method":"GET", "requestUri":"/2016-11-25/tagging" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"

List tags for a CloudFront resource.

" }, "TagResource":{ "name":"TagResource2016_11_25", "http":{ "method":"POST", "requestUri":"/2016-11-25/tagging?Operation=Tag", "responseCode":204 }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"

Add tags to a CloudFront resource.

" }, "UntagResource":{ "name":"UntagResource2016_11_25", "http":{ "method":"POST", "requestUri":"/2016-11-25/tagging?Operation=Untag", "responseCode":204 }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"

Remove tags from a CloudFront resource.

" }, "UpdateCloudFrontOriginAccessIdentity":{ "name":"UpdateCloudFrontOriginAccessIdentity2016_11_25", "http":{ "method":"PUT", "requestUri":"/2016-11-25/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"PreconditionFailed"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"

Update an origin access identity.

" }, "UpdateDistribution":{ "name":"UpdateDistribution2016_11_25", "http":{ "method":"PUT", "requestUri":"/2016-11-25/distribution/{Id}/config" }, "input":{"shape":"UpdateDistributionRequest"}, "output":{"shape":"UpdateDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"}, {"shape":"TooManyQueryStringParameters"}, {"shape":"InvalidQueryStringParameters"}, {"shape":"TooManyDistributionsWithLambdaAssociations"}, {"shape":"TooManyLambdaFunctionAssociations"}, {"shape":"InvalidLambdaFunctionAssociation"} ], "documentation":"

Update a distribution.

" }, "UpdateStreamingDistribution":{ "name":"UpdateStreamingDistribution2016_11_25", "http":{ "method":"PUT", "requestUri":"/2016-11-25/streaming-distribution/{Id}/config" }, "input":{"shape":"UpdateStreamingDistributionRequest"}, "output":{"shape":"UpdateStreamingDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InconsistentQuantities"} ], "documentation":"

Update a streaming distribution.

" } }, "shapes":{ "AccessDenied":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Access denied.

", "error":{"httpStatusCode":403}, "exception":true }, "ActiveTrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"

Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this RTMP distribution have active CloudFront key pairs. If not, Enabled is false.

For more information, see ActiveTrustedSigners.

" }, "Quantity":{ "shape":"integer", "documentation":"

A complex type that contains one Signer complex type for each trusted signer specified in the TrustedSigners complex type.

For more information, see ActiveTrustedSigners.

" }, "Items":{ "shape":"SignerList", "documentation":"

A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type.

For more information, see ActiveTrustedSigners.

" } }, "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" }, "AliasList":{ "type":"list", "member":{ "shape":"string", "locationName":"CNAME" } }, "Aliases":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of CNAME aliases, if any, that you want to associate with this distribution.

" }, "Items":{ "shape":"AliasList", "documentation":"

A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

" } }, "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" }, "AllowedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).

" }, "Items":{ "shape":"MethodsList", "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

" }, "CachedMethods":{"shape":"CachedMethods"} }, "documentation":"

A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:

  • CloudFront forwards only GET and HEAD requests.

  • CloudFront forwards only GET, HEAD, and OPTIONS requests.

  • CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests.

If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.

" }, "AwsAccountNumberList":{ "type":"list", "member":{ "shape":"string", "locationName":"AwsAccountNumber" } }, "BatchTooLarge":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":413}, "exception":true }, "CNAMEAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CacheBehavior":{ "type":"structure", "required":[ "PathPattern", "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "PathPattern":{ "shape":"string", "documentation":"

The pattern (for example, images/*.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/*.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

" }, "TargetOriginId":{ "shape":"string", "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.

" }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" }, "MinTTL":{ "shape":"long", "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" }, "DefaultTTL":{ "shape":"long", "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" }, "MaxTTL":{ "shape":"long", "documentation":"

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" }, "Compress":{ "shape":"boolean", "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" }, "LambdaFunctionAssociations":{ "shape":"LambdaFunctionAssociations", "documentation":"

A complex type that contains zero or more Lambda function associations for a cache behavior.

" } }, "documentation":"

A complex type that describes how CloudFront processes requests.

You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.

For the current limit on the number of cache behaviors that you can add to a distribution, see Amazon CloudFront Limits in the AWS General Reference.

If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error.

To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.

To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.

For more information about cache behaviors, see Cache Behaviors in the Amazon CloudFront Developer Guide.

" }, "CacheBehaviorList":{ "type":"list", "member":{ "shape":"CacheBehavior", "locationName":"CacheBehavior" } }, "CacheBehaviors":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of cache behaviors for this distribution.

" }, "Items":{ "shape":"CacheBehaviorList", "documentation":"

Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.

" } }, "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" }, "CachedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).

" }, "Items":{ "shape":"MethodsList", "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to cache responses to.

" } }, "documentation":"

A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:

  • CloudFront caches responses to GET and HEAD requests.

  • CloudFront caches responses to GET, HEAD, and OPTIONS requests.

If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.

" }, "CertificateSource":{ "type":"string", "enum":[ "cloudfront", "iam", "acm" ] }, "CloudFrontOriginAccessIdentity":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId" ], "members":{ "Id":{ "shape":"string", "documentation":"

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

" }, "S3CanonicalUserId":{ "shape":"string", "documentation":"

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.

" }, "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"

The current configuration information for the identity.

" } }, "documentation":"

CloudFront origin access identity.

" }, "CloudFrontOriginAccessIdentityAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

", "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityConfig":{ "type":"structure", "required":[ "CallerReference", "Comment" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"

A unique number that ensures the request can't be replayed.

If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.

If the CallerReference is a value already sent in a previous identity request, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request.

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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

" }, "Comment":{ "shape":"string", "documentation":"

Any comments you want to include about the origin access identity.

" } }, "documentation":"

Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource.

" }, "CloudFrontOriginAccessIdentityInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"

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. 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).

" }, "NextMarker":{ "shape":"string", "documentation":"

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.

" }, "MaxItems":{ "shape":"integer", "documentation":"

The maximum number of origin access identities you want in the response body.

" }, "IsTruncated":{ "shape":"boolean", "documentation":"

A flag that indicates whether more origin access identities remain to be listed. 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.

" }, "Quantity":{ "shape":"integer", "documentation":"

The number of CloudFront origin access identities that were created by the current AWS account.

" }, "Items":{ "shape":"CloudFrontOriginAccessIdentitySummaryList", "documentation":"

A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account.

" } }, "documentation":"

Lists the origin access identities for CloudFront.Send a GET request to the /CloudFront API version/origin-access-identity/cloudfront resource. The response includes a CloudFrontOriginAccessIdentityList element with zero or more CloudFrontOriginAccessIdentitySummary child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the MaxItems and Marker parameters.

" }, "CloudFrontOriginAccessIdentitySummary":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId", "Comment" ], "members":{ "Id":{ "shape":"string", "documentation":"

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

" }, "S3CanonicalUserId":{ "shape":"string", "documentation":"

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.

" }, "Comment":{ "shape":"string", "documentation":"

The comment for this origin access identity, as originally specified when created.

" } }, "documentation":"

Summary of the information about a CloudFront origin access identity.

" }, "CloudFrontOriginAccessIdentitySummaryList":{ "type":"list", "member":{ "shape":"CloudFrontOriginAccessIdentitySummary", "locationName":"CloudFrontOriginAccessIdentitySummary" } }, "CookieNameList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "CookieNames":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

" }, "Items":{ "shape":"CookieNameList", "documentation":"

A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

" } }, "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" }, "CookiePreference":{ "type":"structure", "required":["Forward"], "members":{ "Forward":{ "shape":"ItemSelection", "documentation":"

Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.

" }, "WhitelistedNames":{ "shape":"CookieNames", "documentation":"

Required if you specify whitelist for the value of Forward:. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.

If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.

For the current limit on the number of cookie names that you can whitelist for each cache behavior, see Amazon CloudFront Limits in the AWS General Reference.

" } }, "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" }, "CreateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["CloudFrontOriginAccessIdentityConfig"], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"

The current configuration information for the identity.

", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} } }, "documentation":"

The request to create a new origin access identity.

", "payload":"CloudFrontOriginAccessIdentityConfig" }, "CreateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"

The origin access identity's information.

" }, "Location":{ "shape":"string", "documentation":"

The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.

", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"

The current version of the origin access identity created.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"CloudFrontOriginAccessIdentity" }, "CreateDistributionRequest":{ "type":"structure", "required":["DistributionConfig"], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"

The distribution's configuration information.

", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} } }, "documentation":"

The request to create a new distribution.

", "payload":"DistributionConfig" }, "CreateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"

The distribution's information.

" }, "Location":{ "shape":"string", "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"

The current version of the distribution created.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"Distribution" }, "CreateDistributionWithTagsRequest":{ "type":"structure", "required":["DistributionConfigWithTags"], "members":{ "DistributionConfigWithTags":{ "shape":"DistributionConfigWithTags", "documentation":"

The distribution's configuration information.

", "locationName":"DistributionConfigWithTags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} } }, "documentation":"

The request to create a new distribution with tags.

", "payload":"DistributionConfigWithTags" }, "CreateDistributionWithTagsResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"

The distribution's information.

" }, "Location":{ "shape":"string", "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"

The current version of the distribution created.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"Distribution" }, "CreateInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "InvalidationBatch" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"

The distribution's id.

", "location":"uri", "locationName":"DistributionId" }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"

The batch information for the invalidation.

", "locationName":"InvalidationBatch", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} } }, "documentation":"

The request to create an invalidation.

", "payload":"InvalidationBatch" }, "CreateInvalidationResult":{ "type":"structure", "members":{ "Location":{ "shape":"string", "documentation":"

The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.

", "location":"header", "locationName":"Location" }, "Invalidation":{ "shape":"Invalidation", "documentation":"

The invalidation's information.

" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"Invalidation" }, "CreateStreamingDistributionRequest":{ "type":"structure", "required":["StreamingDistributionConfig"], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"

The streaming distribution's configuration information.

", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} } }, "documentation":"

The request to create a new streaming distribution.

", "payload":"StreamingDistributionConfig" }, "CreateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"

The streaming distribution's information.

" }, "Location":{ "shape":"string", "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"

The current version of the streaming distribution created.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"StreamingDistribution" }, "CreateStreamingDistributionWithTagsRequest":{ "type":"structure", "required":["StreamingDistributionConfigWithTags"], "members":{ "StreamingDistributionConfigWithTags":{ "shape":"StreamingDistributionConfigWithTags", "documentation":"

The streaming distribution's configuration information.

", "locationName":"StreamingDistributionConfigWithTags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} } }, "documentation":"

The request to create a new streaming distribution with tags.

", "payload":"StreamingDistributionConfigWithTags" }, "CreateStreamingDistributionWithTagsResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"

The streaming distribution's information.

" }, "Location":{ "shape":"string", "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"StreamingDistribution" }, "CustomErrorResponse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{ "shape":"integer", "documentation":"

The HTTP status code for which you want to specify a custom error page and/or a caching duration.

" }, "ResponsePagePath":{ "shape":"string", "documentation":"

The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:

  • The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/*.

  • The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.

If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.

" }, "ResponseCode":{ "shape":"string", "documentation":"

The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:

  • Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted.

  • If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors.

  • You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down.

If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

" }, "ErrorCachingMinTTL":{ "shape":"long", "documentation":"

The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.

If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" } }, "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" }, "CustomErrorResponseList":{ "type":"list", "member":{ "shape":"CustomErrorResponse", "locationName":"CustomErrorResponse" } }, "CustomErrorResponses":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.

" }, "Items":{ "shape":"CustomErrorResponseList", "documentation":"

A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.

" } }, "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" }, "CustomHeaders":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of custom headers, if any, for this distribution.

" }, "Items":{ "shape":"OriginCustomHeadersList", "documentation":"

Optional: A list that contains one OriginCustomHeader element for each custom header that you want CloudFront to forward to the origin. If Quantity is 0, omit Items.

" } }, "documentation":"

A complex type that contains the list of Custom Headers for each origin.

" }, "CustomOriginConfig":{ "type":"structure", "required":[ "HTTPPort", "HTTPSPort", "OriginProtocolPolicy" ], "members":{ "HTTPPort":{ "shape":"integer", "documentation":"

The HTTP port the custom origin listens on.

" }, "HTTPSPort":{ "shape":"integer", "documentation":"

The HTTPS port the custom origin listens on.

" }, "OriginProtocolPolicy":{ "shape":"OriginProtocolPolicy", "documentation":"

The origin protocol policy to apply to your origin.

" }, "OriginSslProtocols":{ "shape":"OriginSslProtocols", "documentation":"

The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

" } }, "documentation":"

A customer origin.

" }, "DefaultCacheBehavior":{ "type":"structure", "required":[ "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "TargetOriginId":{ "shape":"string", "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.

" }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" }, "MinTTL":{ "shape":"long", "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" }, "DefaultTTL":{ "shape":"long", "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" }, "MaxTTL":{"shape":"long"}, "Compress":{ "shape":"boolean", "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" }, "LambdaFunctionAssociations":{ "shape":"LambdaFunctionAssociations", "documentation":"

A complex type that contains zero or more Lambda function associations for a cache behavior.

" } }, "documentation":"

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" }, "DeleteCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The origin access identity's ID.

", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"

The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"If-Match" } }, "documentation":"

Deletes a origin access identity.

" }, "DeleteDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The distribution ID.

", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"

The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"If-Match" } }, "documentation":"

This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.

To delete a web distribution using the CloudFront API:

  1. Disable the web distribution

  2. Submit a GET Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 2.

  5. Review the response to the PUT Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Distribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 6.

  8. Review the response to your DELETE Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" }, "DeleteStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The distribution ID.

", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"

The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"If-Match" } }, "documentation":"

The request to delete a streaming distribution.

" }, "Distribution":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "InProgressInvalidationBatches", "DomainName", "ActiveTrustedSigners", "DistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" }, "ARN":{ "shape":"string", "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" }, "Status":{ "shape":"string", "documentation":"

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"

The date and time the distribution was last modified.

" }, "InProgressInvalidationBatches":{ "shape":"integer", "documentation":"

The number of invalidation batches currently in progress.

" }, "DomainName":{ "shape":"string", "documentation":"

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

" }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"

CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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.

" }, "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"

The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.

" } }, "documentation":"

The distribution's information.

" }, "DistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The caller reference you attempted to create the distribution with is associated with another distribution.

", "error":{"httpStatusCode":409}, "exception":true }, "DistributionConfig":{ "type":"structure", "required":[ "CallerReference", "Origins", "DefaultCacheBehavior", "Comment", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value you already sent in a previous request to create a distribution, and if the content of the DistributionConfig is identical to the original request (ignoring white space), CloudFront returns the same the response that it returned to the original request.

If 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, CloudFront returns a DistributionAlreadyExists error.

" }, "Aliases":{ "shape":"Aliases", "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" }, "DefaultRootObject":{ "shape":"string", "documentation":"

The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

Specify only the object name, for example, index.html. Do not add a / before the object name.

If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

To replace the default root object, update the distribution configuration and specify the new object.

For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

" }, "Origins":{ "shape":"Origins", "documentation":"

A complex type that contains information about origins for this distribution.

" }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"

A complex type that controls the following:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" }, "Comment":{ "shape":"string", "documentation":"

Any comments you want to include about the distribution.

If you don't want to specify a comment, include an empty Comment element.

To delete an existing comment, update the distribution configuration and include an empty Comment element.

To add or change a comment, update the distribution configuration and specify the new comment.

" }, "Logging":{ "shape":"LoggingConfig", "documentation":"

A complex type that controls whether access logs are written for the distribution.

For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.

" }, "PriceClass":{ "shape":"PriceClass", "documentation":"

The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes map to CloudFront regions, see Amazon CloudFront Pricing.

" }, "Enabled":{ "shape":"boolean", "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket.

If you do not want to enable logging when you create a distribution, or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements.

If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

" }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.

AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide.

" }, "HttpVersion":{ "shape":"HttpVersion", "documentation":"

(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.

For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for \"http/2 optimization.\"

" }, "IsIPV6Enabled":{ "shape":"boolean", "documentation":"

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, do not enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:

  • You enable IPv6 for the distribution

  • You're using alternate domain names in the URLs for your objects

For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 Developer Guide.

If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

" } }, "documentation":"

A distribution configuration.

" }, "DistributionConfigWithTags":{ "type":"structure", "required":[ "DistributionConfig", "Tags" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"

A distribution configuration.

" }, "Tags":{ "shape":"Tags", "documentation":"

A complex type that contains zero or more Tag elements.

" } }, "documentation":"

A distribution Configuration and a list of tags to be associated with the distribution.

" }, "DistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"

The value you provided for the Marker request parameter.

" }, "NextMarker":{ "shape":"string", "documentation":"

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.

" }, "MaxItems":{ "shape":"integer", "documentation":"

The value you provided for the MaxItems request parameter.

" }, "IsTruncated":{ "shape":"boolean", "documentation":"

A flag that indicates whether more distributions remain to be listed. 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.

" }, "Quantity":{ "shape":"integer", "documentation":"

The number of distributions that were created by the current AWS account.

" }, "Items":{ "shape":"DistributionSummaryList", "documentation":"

A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account.

" } }, "documentation":"

A distribution list.

" }, "DistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "DistributionSummary":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "DomainName", "Aliases", "Origins", "DefaultCacheBehavior", "CacheBehaviors", "CustomErrorResponses", "Comment", "PriceClass", "Enabled", "ViewerCertificate", "Restrictions", "WebACLId", "HttpVersion", "IsIPV6Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" }, "ARN":{ "shape":"string", "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" }, "Status":{ "shape":"string", "documentation":"

The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"

The date and time the distribution was last modified.

" }, "DomainName":{ "shape":"string", "documentation":"

The domain name that corresponds to the distribution. For example: d604721fxaaqy9.cloudfront.net.

" }, "Aliases":{ "shape":"Aliases", "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" }, "Origins":{ "shape":"Origins", "documentation":"

A complex type that contains information about origins for this distribution.

" }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"

A complex type that contains zero or more CustomErrorResponses elements.

" }, "Comment":{ "shape":"string", "documentation":"

The comment originally specified when this distribution was created.

" }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"

Whether the distribution is enabled to accept user requests for content.

" }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"

The Web ACL Id (if any) associated with the distribution.

" }, "HttpVersion":{ "shape":"HttpVersion", "documentation":"

Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.

" }, "IsIPV6Enabled":{ "shape":"boolean", "documentation":"

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

" } }, "documentation":"

A summary of the information about a CloudFront distribution.

" }, "DistributionSummaryList":{ "type":"list", "member":{ "shape":"DistributionSummary", "locationName":"DistributionSummary" } }, "EventType":{ "type":"string", "enum":[ "viewer-request", "viewer-response", "origin-request", "origin-response" ] }, "ForwardedValues":{ "type":"structure", "required":[ "QueryString", "Cookies" ], "members":{ "QueryString":{ "shape":"boolean", "documentation":"

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

" }, "Cookies":{ "shape":"CookiePreference", "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" }, "Headers":{ "shape":"Headers", "documentation":"

A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior.

" }, "QueryStringCacheKeys":{ "shape":"QueryStringCacheKeys", "documentation":"

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

" } }, "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" }, "GeoRestriction":{ "type":"structure", "required":[ "RestrictionType", "Quantity" ], "members":{ "RestrictionType":{ "shape":"GeoRestrictionType", "documentation":"

The method that you want to use to restrict distribution of your content by country:

  • none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.

  • blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content.

  • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

" }, "Quantity":{ "shape":"integer", "documentation":"

When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.

" }, "Items":{ "shape":"LocationList", "documentation":"

A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes.

" } }, "documentation":"

A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.

" }, "GeoRestrictionType":{ "type":"string", "enum":[ "blacklist", "whitelist", "none" ] }, "GetCloudFrontOriginAccessIdentityConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The identity's ID.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfigComplexType.

" }, "GetCloudFrontOriginAccessIdentityConfigResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"

The origin access identity's configuration information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"CloudFrontOriginAccessIdentityConfig" }, "GetCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The identity's ID.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The request to get an origin access identity's information.

" }, "GetCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"

The origin access identity's information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"CloudFrontOriginAccessIdentity" }, "GetDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The distribution's ID.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The request to get a distribution configuration.

" }, "GetDistributionConfigResult":{ "type":"structure", "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"

The distribution's configuration information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"DistributionConfig" }, "GetDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The distribution's ID.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The request to get a distribution's information.

" }, "GetDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"

The distribution's information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the distribution's information. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"Distribution" }, "GetInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "Id" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"

The distribution's ID.

", "location":"uri", "locationName":"DistributionId" }, "Id":{ "shape":"string", "documentation":"

The identifier for the invalidation request, for example, IDFDVBD632BHDS5.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The request to get an invalidation's information.

" }, "GetInvalidationResult":{ "type":"structure", "members":{ "Invalidation":{ "shape":"Invalidation", "documentation":"

The invalidation's information. For more information, see Invalidation Complex Type.

" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"Invalidation" }, "GetStreamingDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The streaming distribution's ID.

", "location":"uri", "locationName":"Id" } }, "documentation":"

To request to get a streaming distribution configuration.

" }, "GetStreamingDistributionConfigResult":{ "type":"structure", "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"

The streaming distribution's configuration information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"StreamingDistributionConfig" }, "GetStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The streaming distribution's ID.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The request to get a streaming distribution's information.

" }, "GetStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"

The streaming distribution's information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"StreamingDistribution" }, "HeaderList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "Headers":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of different headers that you want CloudFront to forward to the origin for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

    If you configure CloudFront to forward all headers to your origin, CloudFront doesn't cache the objects associated with this cache behavior. Instead, it sends every request to the origin.

  • Forward a whitelist of headers you specify: Specify the number of headers that you want to forward, and specify the header names in Name elements. CloudFront caches your objects based on the values in all of the specified headers. CloudFront also forwards the headers that it forwards by default, but it caches your objects based only on the headers that you specify.

  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

" }, "Items":{ "shape":"HeaderList", "documentation":"

A complex type that contains one Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items.

" } }, "documentation":"

A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior.

For the headers that you specify, CloudFront also caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to cache your content based on values in the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see How CloudFront Forwards and Caches Headers in the Amazon CloudFront Developer Guide.

" }, "HttpVersion":{ "type":"string", "enum":[ "http1.1", "http2" ] }, "IllegalUpdate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Origin and CallerReference cannot be updated.

", "error":{"httpStatusCode":400}, "exception":true }, "InconsistentQuantities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The value of Quantity and the size of Items do not match.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidArgument":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The argument is invalid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidDefaultRootObject":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The default root object file name is too big or contains an invalid character.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidErrorCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidForwardCookies":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidGeoRestrictionParameter":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidHeadersForS3Origin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidIfMatchVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The If-Match version is missing or not valid for the distribution.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidLambdaFunctionAssociation":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The specified Lambda function association is invalid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidLocationCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidMinimumProtocolVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The origin access identity is not valid or doesn't exist.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidProtocolSettings":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidQueryStringParameters":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidRelativePath":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The relative path is too big, is not URL-encoded, or does not begin with a slash (/).

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRequiredProtocol":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

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.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidResponseCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidTTLOrder":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidTagging":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidViewerCertificate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidWebACLId":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "Invalidation":{ "type":"structure", "required":[ "Id", "Status", "CreateTime", "InvalidationBatch" ], "members":{ "Id":{ "shape":"string", "documentation":"

The identifier for the invalidation request. For example: IDFDVBD632BHDS5.

" }, "Status":{ "shape":"string", "documentation":"

The status of the invalidation request. When the invalidation batch is finished, the status is Completed.

" }, "CreateTime":{ "shape":"timestamp", "documentation":"

The date and time the invalidation request was first made.

" }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"

The current invalidation information for the batch request.

" } }, "documentation":"

An invalidation.

" }, "InvalidationBatch":{ "type":"structure", "required":[ "Paths", "CallerReference" ], "members":{ "Paths":{ "shape":"Paths", "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" }, "CallerReference":{ "shape":"string", "documentation":"

A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp, for example, 20120301090000.

If you make a second invalidation request with the same value for CallerReference, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference.

If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.

" } }, "documentation":"

An invalidation batch.

" }, "InvalidationList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"

The value that you provided for the Marker request parameter.

" }, "NextMarker":{ "shape":"string", "documentation":"

If IsTruncated is true, this element is present and contains the value that you can use for the Marker request parameter to continue listing your invalidation batches where they left off.

" }, "MaxItems":{ "shape":"integer", "documentation":"

The value that you provided for the MaxItems request parameter.

" }, "IsTruncated":{ "shape":"boolean", "documentation":"

A flag that indicates whether more invalidation batch requests remain to be listed. 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.

" }, "Quantity":{ "shape":"integer", "documentation":"

The number of invalidation batches that were created by the current AWS account.

" }, "Items":{ "shape":"InvalidationSummaryList", "documentation":"

A complex type that contains one InvalidationSummary element for each invalidation batch created by the current AWS account.

" } }, "documentation":"

The InvalidationList complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.

" }, "InvalidationSummary":{ "type":"structure", "required":[ "Id", "CreateTime", "Status" ], "members":{ "Id":{ "shape":"string", "documentation":"

The unique ID for an invalidation request.

" }, "CreateTime":{"shape":"timestamp"}, "Status":{ "shape":"string", "documentation":"

The status of an invalidation request.

" } }, "documentation":"

A summary of an invalidation request.

" }, "InvalidationSummaryList":{ "type":"list", "member":{ "shape":"InvalidationSummary", "locationName":"InvalidationSummary" } }, "ItemSelection":{ "type":"string", "enum":[ "none", "whitelist", "all" ] }, "KeyPairIdList":{ "type":"list", "member":{ "shape":"string", "locationName":"KeyPairId" } }, "KeyPairIds":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of active CloudFront key pairs for AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" }, "Items":{ "shape":"KeyPairIdList", "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" } }, "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" }, "LambdaFunctionAssociation":{ "type":"structure", "members":{ "LambdaFunctionARN":{ "shape":"string", "documentation":"

The ARN of the Lambda function.

" }, "EventType":{ "shape":"EventType", "documentation":"

Specifies the event type that triggers a Lambda function invocation. Valid values are:

  • viewer-request

  • origin-request

  • viewer-response

  • origin-response

" } }, "documentation":"

A complex type that contains a Lambda function association.

" }, "LambdaFunctionAssociationList":{ "type":"list", "member":{ "shape":"LambdaFunctionAssociation", "locationName":"LambdaFunctionAssociation" } }, "LambdaFunctionAssociations":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of Lambda function associations for this cache behavior.

" }, "Items":{ "shape":"LambdaFunctionAssociationList", "documentation":"

Optional: A complex type that contains LambdaFunctionAssociation items for this cache behavior. If Quantity is 0, you can omit Items.

" } }, "documentation":"

A complex type that specifies a list of Lambda functions associations for a cache behavior.

If you want to invoke one or more Lambda functions triggered by requests that match the PathPattern of the cache behavior, specify the applicable values for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation items in this list (one for each possible value of EventType) and each EventType can be associated with the Lambda function only once.

If you don't want to invoke any Lambda functions for the requests that match PathPattern, specify 0 for Quantity and omit Items.

" }, "ListCloudFrontOriginAccessIdentitiesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"

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. 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).

", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"

The maximum number of origin access identities you want in the response body.

", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"

The request to list origin access identities.

" }, "ListCloudFrontOriginAccessIdentitiesResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityList":{ "shape":"CloudFrontOriginAccessIdentityList", "documentation":"

The CloudFrontOriginAccessIdentityList type.

" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"CloudFrontOriginAccessIdentityList" }, "ListDistributionsByWebACLIdRequest":{ "type":"structure", "required":["WebACLId"], "members":{ "Marker":{ "shape":"string", "documentation":"

Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)

", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"

The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.

", "location":"querystring", "locationName":"MaxItems" }, "WebACLId":{ "shape":"string", "documentation":"

The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify \"null\" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.

", "location":"uri", "locationName":"WebACLId" } }, "documentation":"

The request to list distributions that are associated with a specified AWS WAF web ACL.

" }, "ListDistributionsByWebACLIdResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"

The DistributionList type.

" } }, "documentation":"

The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.

", "payload":"DistributionList" }, "ListDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"

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. 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).

", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"

The maximum number of distributions you want in the response body.

", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"

The request to list your distributions.

" }, "ListDistributionsResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"

The DistributionList type.

" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"DistributionList" }, "ListInvalidationsRequest":{ "type":"structure", "required":["DistributionId"], "members":{ "DistributionId":{ "shape":"string", "documentation":"

The distribution's ID.

", "location":"uri", "locationName":"DistributionId" }, "Marker":{ "shape":"string", "documentation":"

Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. 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. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.

", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"

The maximum number of invalidation batches that you want in the response body.

", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"

The request to list invalidations.

" }, "ListInvalidationsResult":{ "type":"structure", "members":{ "InvalidationList":{ "shape":"InvalidationList", "documentation":"

Information about invalidation batches.

" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"InvalidationList" }, "ListStreamingDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"

The value that you provided for the Marker request parameter.

", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"

The value that you provided for the MaxItems request parameter.

", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"

The request to list your streaming distributions.

" }, "ListStreamingDistributionsResult":{ "type":"structure", "members":{ "StreamingDistributionList":{ "shape":"StreamingDistributionList", "documentation":"

The StreamingDistributionList type.

" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"StreamingDistributionList" }, "ListTagsForResourceRequest":{ "type":"structure", "required":["Resource"], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"

An ARN of a CloudFront resource.

", "location":"querystring", "locationName":"Resource" } }, "documentation":"

The request to list tags for a CloudFront resource.

" }, "ListTagsForResourceResult":{ "type":"structure", "required":["Tags"], "members":{ "Tags":{ "shape":"Tags", "documentation":"

A complex type that contains zero or more Tag elements.

" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"Tags" }, "LocationList":{ "type":"list", "member":{ "shape":"string", "locationName":"Location" } }, "LoggingConfig":{ "type":"structure", "required":[ "Enabled", "IncludeCookies", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.

" }, "IncludeCookies":{ "shape":"boolean", "documentation":"

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.

" }, "Bucket":{ "shape":"string", "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" }, "Prefix":{ "shape":"string", "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" } }, "documentation":"

A complex type that controls whether access logs are written for the distribution.

" }, "Method":{ "type":"string", "enum":[ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ] }, "MethodsList":{ "type":"list", "member":{ "shape":"Method", "locationName":"Method" } }, "MinimumProtocolVersion":{ "type":"string", "enum":[ "SSLv3", "TLSv1" ] }, "MissingBody":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

", "error":{"httpStatusCode":400}, "exception":true }, "NoSuchCloudFrontOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The specified origin access identity does not exist.

", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The specified distribution does not exist.

", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchInvalidation":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The specified invalidation does not exist.

", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

No origin exists with the specified Origin Id.

", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchResource":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true }, "NoSuchStreamingDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The specified streaming distribution does not exist.

", "error":{"httpStatusCode":404}, "exception":true }, "Origin":{ "type":"structure", "required":[ "Id", "DomainName" ], "members":{ "Id":{ "shape":"string", "documentation":"

A unique identifier for the origin. The value of Id must be unique within the distribution.

When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

" }, "DomainName":{ "shape":"string", "documentation":"

Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com.

Constraints for Amazon S3 origins:

  • If you configured Amazon S3 Transfer Acceleration for your bucket, do not specify the s3-accelerate endpoint for DomainName.

  • The bucket name must be between 3 and 63 characters long (inclusive).

  • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

  • The bucket name must not contain adjacent periods.

Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

Constraints for custom origins:

  • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

  • The name cannot exceed 128 characters.

" }, "OriginPath":{ "shape":"string", "documentation":"

An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName, for example, example.com/production. Do not include a / at the end of the directory name.

For example, suppose you've specified the following values for your distribution:

  • DomainName: An Amazon S3 bucket named myawsbucket.

  • OriginPath: /production

  • CNAME: example.com

When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

" }, "CustomHeaders":{ "shape":"CustomHeaders", "documentation":"

A complex type that contains names and values for the custom headers that you want.

" }, "S3OriginConfig":{ "shape":"S3OriginConfig", "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" }, "CustomOriginConfig":{ "shape":"CustomOriginConfig", "documentation":"

A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead.

" } }, "documentation":"

A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files. You must create at least one origin.

For the current limit on the number of origins that you can create for a distribution, see Amazon CloudFront Limits in the AWS General Reference.

" }, "OriginCustomHeader":{ "type":"structure", "required":[ "HeaderName", "HeaderValue" ], "members":{ "HeaderName":{ "shape":"string", "documentation":"

The name of a header that you want CloudFront to forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

" }, "HeaderValue":{ "shape":"string", "documentation":"

The value for the header that you specified in the HeaderName field.

" } }, "documentation":"

A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.

" }, "OriginCustomHeadersList":{ "type":"list", "member":{ "shape":"OriginCustomHeader", "locationName":"OriginCustomHeader" } }, "OriginList":{ "type":"list", "member":{ "shape":"Origin", "locationName":"Origin" }, "min":1 }, "OriginProtocolPolicy":{ "type":"string", "enum":[ "http-only", "match-viewer", "https-only" ] }, "OriginSslProtocols":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

" }, "Items":{ "shape":"SslProtocolsList", "documentation":"

A list that contains allowed SSL/TLS protocols for this distribution.

" } }, "documentation":"

A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

" }, "Origins":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of origins for this distribution.

" }, "Items":{ "shape":"OriginList", "documentation":"

A complex type that contains origins for this distribution.

" } }, "documentation":"

A complex type that contains information about origins for this distribution.

" }, "PathList":{ "type":"list", "member":{ "shape":"string", "locationName":"Path" } }, "Paths":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of objects that you want to invalidate.

" }, "Items":{ "shape":"PathList", "documentation":"

A complex type that contains a list of the paths that you want to invalidate.

" } }, "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" }, "PreconditionFailed":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The precondition given in one or more of the request-header fields evaluated to false.

", "error":{"httpStatusCode":412}, "exception":true }, "PriceClass":{ "type":"string", "enum":[ "PriceClass_100", "PriceClass_200", "PriceClass_All" ] }, "QueryStringCacheKeys":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of whitelisted query string parameters for this cache behavior.

" }, "Items":{ "shape":"QueryStringCacheKeysList", "documentation":"

(Optional) A list that contains the query string parameters that you want CloudFront to use as a basis for caching for this cache behavior. If Quantity is 0, you can omit Items.

" } } }, "QueryStringCacheKeysList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "ResourceARN":{ "type":"string", "pattern":"arn:aws:cloudfront::[0-9]+:.*" }, "Restrictions":{ "type":"structure", "required":["GeoRestriction"], "members":{ "GeoRestriction":{"shape":"GeoRestriction"} }, "documentation":"

A complex type that identifies ways in which you want to restrict distribution of your content.

" }, "S3Origin":{ "type":"structure", "required":[ "DomainName", "OriginAccessIdentity" ], "members":{ "DomainName":{ "shape":"string", "documentation":"

The DNS name of the Amazon S3 origin.

" }, "OriginAccessIdentity":{ "shape":"string", "documentation":"

The CloudFront origin access identity to associate with the RTMP distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.

If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon Amazon CloudFront Developer Guide.

" } }, "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" }, "S3OriginConfig":{ "type":"structure", "required":["OriginAccessIdentity"], "members":{ "OriginAccessIdentity":{ "shape":"string", "documentation":"

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/CloudFront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" } }, "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" }, "SSLSupportMethod":{ "type":"string", "enum":[ "sni-only", "vip" ] }, "Signer":{ "type":"structure", "members":{ "AwsAccountNumber":{ "shape":"string", "documentation":"

An AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid values include:

  • self, which is the AWS account used to create the distribution.

  • An AWS account number.

" }, "KeyPairIds":{ "shape":"KeyPairIds", "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

" } }, "documentation":"

A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any.

" }, "SignerList":{ "type":"list", "member":{ "shape":"Signer", "locationName":"Signer" } }, "SslProtocol":{ "type":"string", "enum":[ "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2" ] }, "SslProtocolsList":{ "type":"list", "member":{ "shape":"SslProtocol", "locationName":"SslProtocol" } }, "StreamingDistribution":{ "type":"structure", "required":[ "Id", "ARN", "Status", "DomainName", "ActiveTrustedSigners", "StreamingDistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"

The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.

" }, "ARN":{"shape":"string"}, "Status":{ "shape":"string", "documentation":"

The current status of the RTMP distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"

The date and time that the distribution was last modified.

" }, "DomainName":{ "shape":"string", "documentation":"

The domain name that corresponds to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net.

" }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" }, "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"

The current configuration information for the RTMP distribution.

" } }, "documentation":"

A streaming distribution.

" }, "StreamingDistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionConfig":{ "type":"structure", "required":[ "CallerReference", "S3Origin", "Comment", "TrustedSigners", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"

A unique number that ensures that the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value that 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), the response includes the same information returned to the original request. If the CallerReference is a value that you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

" }, "S3Origin":{ "shape":"S3Origin", "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" }, "Aliases":{ "shape":"Aliases", "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" }, "Comment":{ "shape":"string", "documentation":"

Any comments you want to include about the streaming distribution.

" }, "Logging":{ "shape":"StreamingLoggingConfig", "documentation":"

A complex type that controls whether access logs are written for the streaming distribution.

" }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"

A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" }, "PriceClass":{ "shape":"PriceClass", "documentation":"

A complex type that contains information about price class for this streaming distribution.

" }, "Enabled":{ "shape":"boolean", "documentation":"

Whether the streaming distribution is enabled to accept user requests for content.

" } }, "documentation":"

The RTMP distribution's configuration information.

" }, "StreamingDistributionConfigWithTags":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Tags" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"

A streaming distribution Configuration.

" }, "Tags":{ "shape":"Tags", "documentation":"

A complex type that contains zero or more Tag elements.

" } }, "documentation":"

A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.

" }, "StreamingDistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"

The value you provided for the Marker request parameter.

" }, "NextMarker":{ "shape":"string", "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP distributions where they left off.

" }, "MaxItems":{ "shape":"integer", "documentation":"

The value you provided for the MaxItems request parameter.

" }, "IsTruncated":{ "shape":"boolean", "documentation":"

A flag that indicates whether more streaming distributions remain to be listed. 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.

" }, "Quantity":{ "shape":"integer", "documentation":"

The number of streaming distributions that were created by the current AWS account.

" }, "Items":{ "shape":"StreamingDistributionSummaryList", "documentation":"

A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.

" } }, "documentation":"

A streaming distribution list.

" }, "StreamingDistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionSummary":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "DomainName", "S3Origin", "Aliases", "TrustedSigners", "Comment", "PriceClass", "Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" }, "ARN":{ "shape":"string", "documentation":"

The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" }, "Status":{ "shape":"string", "documentation":"

Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"

The date and time the distribution was last modified.

" }, "DomainName":{ "shape":"string", "documentation":"

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

" }, "S3Origin":{ "shape":"S3Origin", "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" }, "Aliases":{ "shape":"Aliases", "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items.If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" }, "Comment":{ "shape":"string", "documentation":"

The comment originally specified when this distribution was created.

" }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"

Whether the distribution is enabled to accept end user requests for content.

" } }, "documentation":"

A summary of the information for an Amazon CloudFront streaming distribution.

" }, "StreamingDistributionSummaryList":{ "type":"list", "member":{ "shape":"StreamingDistributionSummary", "locationName":"StreamingDistributionSummary" } }, "StreamingLoggingConfig":{ "type":"structure", "required":[ "Enabled", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

" }, "Bucket":{ "shape":"string", "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" }, "Prefix":{ "shape":"string", "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" } }, "documentation":"

A complex type that controls whether access logs are written for this streaming distribution.

" }, "Tag":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"TagKey", "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" }, "Value":{ "shape":"TagValue", "documentation":"

A string that contains an optional Tag value.

The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" } }, "documentation":"

A complex type that contains Tag key and Tag value.

" }, "TagKey":{ "type":"string", "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeyList":{ "type":"list", "member":{ "shape":"TagKey", "locationName":"Key" } }, "TagKeys":{ "type":"structure", "members":{ "Items":{ "shape":"TagKeyList", "documentation":"

A complex type that contains Tag key elements.

" } }, "documentation":"

A complex type that contains zero or more Tag elements.

" }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"Tag" } }, "TagResourceRequest":{ "type":"structure", "required":[ "Resource", "Tags" ], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"

An ARN of a CloudFront resource.

", "location":"querystring", "locationName":"Resource" }, "Tags":{ "shape":"Tags", "documentation":"

A complex type that contains zero or more Tag elements.

", "locationName":"Tags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} } }, "documentation":"

The request to add tags to a CloudFront resource.

", "payload":"Tags" }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Tags":{ "type":"structure", "members":{ "Items":{ "shape":"TagList", "documentation":"

A complex type that contains Tag elements.

" } }, "documentation":"

A complex type that contains zero or more Tag elements.

" }, "TooManyCacheBehaviors":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

You cannot create more cache behaviors for the distribution.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCertificates":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

You cannot create anymore custom SSL/TLS certificates.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCloudFrontOriginAccessIdentities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Processing your request would cause you to exceed the maximum number of origin access identities allowed.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCookieNamesInWhiteList":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Your request contains more cookie names in the whitelist than are allowed per cache behavior.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Your request contains more CNAMEs than are allowed per distribution.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Processing your request would cause you to exceed the maximum number of distributions allowed.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributionsWithLambdaAssociations":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Processing your request would cause the maximum number of distributions with Lambda function associations per owner to be exceeded.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyHeadersInForwardedValues":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyInvalidationsInProgress":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyLambdaFunctionAssociations":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Your request contains more Lambda function associations than are allowed per distribution.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyOriginCustomHeaders":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyOrigins":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

You cannot create more origins for the distribution.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyQueryStringParameters":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Processing your request would cause you to exceed the maximum number of streaming distributions allowed.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyTrustedSigners":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Your request contains more trusted signers than are allowed per distribution.

", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSignerDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

One or more of your trusted signers do not exist.

", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"

Specifies whether you want to require viewers to use signed URLs to access the files specified by PathPattern and TargetOriginId.

" }, "Quantity":{ "shape":"integer", "documentation":"

The number of trusted signers for this cache behavior.

" }, "Items":{ "shape":"AwsAccountNumberList", "documentation":"

Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.

" } }, "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

For more information about updating the distribution configuration, see DistributionConfig .

" }, "UntagResourceRequest":{ "type":"structure", "required":[ "Resource", "TagKeys" ], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"

An ARN of a CloudFront resource.

", "location":"querystring", "locationName":"Resource" }, "TagKeys":{ "shape":"TagKeys", "documentation":"

A complex type that contains zero or more Tag key elements.

", "locationName":"TagKeys", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} } }, "documentation":"

The request to remove tags from a CloudFront resource.

", "payload":"TagKeys" }, "UpdateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":[ "CloudFrontOriginAccessIdentityConfig", "Id" ], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"

The identity's configuration information.

", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} }, "Id":{ "shape":"string", "documentation":"

The identity's id.

", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"

The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"If-Match" } }, "documentation":"

The request to update an origin access identity.

", "payload":"CloudFrontOriginAccessIdentityConfig" }, "UpdateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"

The origin access identity's information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"CloudFrontOriginAccessIdentity" }, "UpdateDistributionRequest":{ "type":"structure", "required":[ "DistributionConfig", "Id" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"

The distribution's configuration information.

", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} }, "Id":{ "shape":"string", "documentation":"

The distribution's id.

", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"

The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"If-Match" } }, "documentation":"

The request to update a distribution.

", "payload":"DistributionConfig" }, "UpdateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"

The distribution's information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"Distribution" }, "UpdateStreamingDistributionRequest":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Id" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"

The streaming distribution's configuration information.

", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} }, "Id":{ "shape":"string", "documentation":"

The streaming distribution's id.

", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"

The value of the ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"If-Match" } }, "documentation":"

The request to update a streaming distribution.

", "payload":"StreamingDistributionConfig" }, "UpdateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"

The streaming distribution's information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"StreamingDistribution" }, "ViewerCertificate":{ "type":"structure", "members":{ "CloudFrontDefaultCertificate":{"shape":"boolean"}, "IAMCertificateId":{"shape":"string"}, "ACMCertificateArn":{"shape":"string"}, "SSLSupportMethod":{ "shape":"SSLSupportMethod", "documentation":"

If you specify a value for ACMCertificateArn or for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:

  • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges.

  • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:

    • Use the vip option (dedicated IP addresses) instead of sni-only.

    • Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.

    • If you can control which browser your users use, upgrade the browser to one that supports SNI.

    • Use HTTP instead of HTTPS.

Do not specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

" }, "MinimumProtocolVersion":{ "shape":"MinimumProtocolVersion", "documentation":"

Specify the minimum version of the SSL/TLS protocol that you want CloudFront to use for HTTPS connections between viewers and CloudFront: SSLv3 or TLSv1. CloudFront serves your objects only to viewers that support SSL/TLS version that you specify and later versions. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. Note the following:

  • If you specify <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>, the minimum SSL protocol version is TLSv1 and can't be changed.

  • If you're using a custom certificate (if you specify a value for ACMCertificateArn or for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion.

" }, "Certificate":{ "shape":"string", "documentation":"

Include one of these values to specify the following:

  • Whether you want viewers to use HTTP or HTTPS to request your objects.

  • If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net.

  • If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.

You must specify one (and only one) of the three values. Do not specify false for CloudFrontDefaultCertificate.

If you want viewers to use HTTP to request your objects: Specify the following value:

<CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

In addition, specify allow-all for ViewerProtocolPolicy for all of your cache behaviors.

If you want viewers to use HTTPS to request your objects: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:

  • If you're using an alternate domain name, such as example.com: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:

    • <ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.

    • <IAMCertificateId>IAM certificate ID<IAMCertificateId> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.

    If you specify ACMCertificateArn or IAMCertificateId, you must also specify a value for SSLSupportMethod.

    If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (https://example.com/logo.jpg). If you use the domain name that is associated with your CloudFront distribution (https://d111111abcdef8.cloudfront.net/logo.jpg) and the viewer supports SNI, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for SSLSupportMethod:

    • vip: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.

    • sni-only: CloudFront drops the connection with the browser without returning the object.

  • If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net : Specify the following value:

    <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

    If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:

    • <ViewerProtocolPolicy>https-only<ViewerProtocolPolicy>

    • <ViewerProtocolPolicy>redirect-to-https<ViewerProtocolPolicy>

    You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:

    • <OriginProtocolPolicy>https-only<OriginProtocolPolicy>

    • <OriginProtocolPolicy>match-viewer<OriginProtocolPolicy>

    For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

", "deprecated":true }, "CertificateSource":{ "shape":"CertificateSource", "documentation":"

This field is deprecated. You can use one of the following: [ACMCertificateArn, IAMCertificateId, or CloudFrontDefaultCertificate].

", "deprecated":true } }, "documentation":"

A complex type that specifies the following:

  • Which SSL/TLS certificate to use when viewers request objects using HTTPS

  • Whether you want CloudFront to use dedicated IP addresses or SNI when you're using alternate domain names in your object names

  • The minimum protocol version that you want CloudFront to use when communicating with viewers

For more information, see Using an HTTPS Connection to Access Your Objects in the Amazon Amazon CloudFront Developer Guide.

" }, "ViewerProtocolPolicy":{ "type":"string", "enum":[ "allow-all", "https-only", "redirect-to-https" ] }, "boolean":{"type":"boolean"}, "integer":{"type":"integer"}, "long":{"type":"long"}, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} }, "documentation":"Amazon CloudFront

This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about the CloudFront API actions, data types, and errors. For detailed information about CloudFront features and their associated API calls, see the Amazon CloudFront Developer Guide.

" } botocore-1.5.7/botocore/data/cloudfront/2016-09-07/0000777454262600001440000000000013042511307022354 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudfront/2016-09-07/waiters-2.json0000666454262600001440000000224013042511306025061 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DistributionDeployed": { "delay": 60, "operation": "GetDistribution", "maxAttempts": 25, "description": "Wait until a distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "Distribution.Status" } ] }, "InvalidationCompleted": { "delay": 20, "operation": "GetInvalidation", "maxAttempts": 60, "description": "Wait until an invalidation has completed.", "acceptors": [ { "expected": "Completed", "matcher": "path", "state": "success", "argument": "Invalidation.Status" } ] }, "StreamingDistributionDeployed": { "delay": 60, "operation": "GetStreamingDistribution", "maxAttempts": 25, "description": "Wait until a streaming distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "StreamingDistribution.Status" } ] } } } botocore-1.5.7/botocore/data/cloudfront/2016-09-07/paginators-1.json0000666454262600001440000000214613042511306025556 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListCloudFrontOriginAccessIdentities": { "input_token": "Marker", "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", "limit_key": "MaxItems", "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", "result_key": "CloudFrontOriginAccessIdentityList.Items" }, "ListDistributions": { "input_token": "Marker", "output_token": "DistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "DistributionList.IsTruncated", "result_key": "DistributionList.Items" }, "ListInvalidations": { "input_token": "Marker", "output_token": "InvalidationList.NextMarker", "limit_key": "MaxItems", "more_results": "InvalidationList.IsTruncated", "result_key": "InvalidationList.Items" }, "ListStreamingDistributions": { "input_token": "Marker", "output_token": "StreamingDistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "StreamingDistributionList.IsTruncated", "result_key": "StreamingDistributionList.Items" } } } botocore-1.5.7/botocore/data/cloudfront/2016-09-07/service-2.json0000777454262600001440000045027013042511306025060 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-09-07", "endpointPrefix":"cloudfront", "globalEndpoint":"cloudfront.amazonaws.com", "protocol":"rest-xml", "serviceAbbreviation":"CloudFront", "serviceFullName":"Amazon CloudFront", "signatureVersion":"v4" }, "operations":{ "CreateCloudFrontOriginAccessIdentity":{ "name":"CreateCloudFrontOriginAccessIdentity2016_09_07", "http":{ "method":"POST", "requestUri":"/2016-09-07/origin-access-identity/cloudfront", "responseCode":201 }, "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, {"shape":"MissingBody"}, {"shape":"TooManyCloudFrontOriginAccessIdentities"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new origin access identity." }, "CreateDistribution":{ "name":"CreateDistribution2016_09_07", "http":{ "method":"POST", "requestUri":"/2016-09-07/distribution", "responseCode":201 }, "input":{"shape":"CreateDistributionRequest"}, "output":{"shape":"CreateDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"DistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"MissingBody"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"TooManyDistributions"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidProtocolSettings"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"}, {"shape":"TooManyQueryStringParameters"}, {"shape":"InvalidQueryStringParameters"} ], "documentation":"Create a new distribution." }, "CreateDistributionWithTags":{ "name":"CreateDistributionWithTags2016_09_07", "http":{ "method":"POST", "requestUri":"/2016-09-07/distribution?WithTags", "responseCode":201 }, "input":{"shape":"CreateDistributionWithTagsRequest"}, "output":{"shape":"CreateDistributionWithTagsResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"DistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"MissingBody"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"TooManyDistributions"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidProtocolSettings"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"}, {"shape":"InvalidTagging"}, {"shape":"TooManyQueryStringParameters"}, {"shape":"InvalidQueryStringParameters"} ], "documentation":"Create a new distribution with tags." }, "CreateInvalidation":{ "name":"CreateInvalidation2016_09_07", "http":{ "method":"POST", "requestUri":"/2016-09-07/distribution/{DistributionId}/invalidation", "responseCode":201 }, "input":{"shape":"CreateInvalidationRequest"}, "output":{"shape":"CreateInvalidationResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"MissingBody"}, {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"BatchTooLarge"}, {"shape":"TooManyInvalidationsInProgress"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new invalidation." }, "CreateStreamingDistribution":{ "name":"CreateStreamingDistribution2016_09_07", "http":{ "method":"POST", "requestUri":"/2016-09-07/streaming-distribution", "responseCode":201 }, "input":{"shape":"CreateStreamingDistributionRequest"}, "output":{"shape":"CreateStreamingDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"StreamingDistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"MissingBody"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"TooManyStreamingDistributions"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new streaming distribution." }, "CreateStreamingDistributionWithTags":{ "name":"CreateStreamingDistributionWithTags2016_09_07", "http":{ "method":"POST", "requestUri":"/2016-09-07/streaming-distribution?WithTags", "responseCode":201 }, "input":{"shape":"CreateStreamingDistributionWithTagsRequest"}, "output":{"shape":"CreateStreamingDistributionWithTagsResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"StreamingDistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"MissingBody"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"TooManyStreamingDistributions"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"}, {"shape":"InvalidTagging"} ], "documentation":"Create a new streaming distribution with tags." }, "DeleteCloudFrontOriginAccessIdentity":{ "name":"DeleteCloudFrontOriginAccessIdentity2016_09_07", "http":{ "method":"DELETE", "requestUri":"/2016-09-07/origin-access-identity/cloudfront/{Id}", "responseCode":204 }, "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"PreconditionFailed"}, {"shape":"CloudFrontOriginAccessIdentityInUse"} ], "documentation":"Delete an origin access identity." }, "DeleteDistribution":{ "name":"DeleteDistribution2016_09_07", "http":{ "method":"DELETE", "requestUri":"/2016-09-07/distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"DistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"Delete a distribution." }, "DeleteStreamingDistribution":{ "name":"DeleteStreamingDistribution2016_09_07", "http":{ "method":"DELETE", "requestUri":"/2016-09-07/streaming-distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteStreamingDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"StreamingDistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"Delete a streaming distribution." }, "GetCloudFrontOriginAccessIdentity":{ "name":"GetCloudFrontOriginAccessIdentity2016_09_07", "http":{ "method":"GET", "requestUri":"/2016-09-07/origin-access-identity/cloudfront/{Id}" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about an origin access identity." }, "GetCloudFrontOriginAccessIdentityConfig":{ "name":"GetCloudFrontOriginAccessIdentityConfig2016_09_07", "http":{ "method":"GET", "requestUri":"/2016-09-07/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about an origin access identity." }, "GetDistribution":{ "name":"GetDistribution2016_09_07", "http":{ "method":"GET", "requestUri":"/2016-09-07/distribution/{Id}" }, "input":{"shape":"GetDistributionRequest"}, "output":{"shape":"GetDistributionResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about a distribution." }, "GetDistributionConfig":{ "name":"GetDistributionConfig2016_09_07", "http":{ "method":"GET", "requestUri":"/2016-09-07/distribution/{Id}/config" }, "input":{"shape":"GetDistributionConfigRequest"}, "output":{"shape":"GetDistributionConfigResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about a distribution." }, "GetInvalidation":{ "name":"GetInvalidation2016_09_07", "http":{ "method":"GET", "requestUri":"/2016-09-07/distribution/{DistributionId}/invalidation/{Id}" }, "input":{"shape":"GetInvalidationRequest"}, "output":{"shape":"GetInvalidationResult"}, "errors":[ {"shape":"NoSuchInvalidation"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about an invalidation." }, "GetStreamingDistribution":{ "name":"GetStreamingDistribution2016_09_07", "http":{ "method":"GET", "requestUri":"/2016-09-07/streaming-distribution/{Id}" }, "input":{"shape":"GetStreamingDistributionRequest"}, "output":{"shape":"GetStreamingDistributionResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about a streaming distribution." }, "GetStreamingDistributionConfig":{ "name":"GetStreamingDistributionConfig2016_09_07", "http":{ "method":"GET", "requestUri":"/2016-09-07/streaming-distribution/{Id}/config" }, "input":{"shape":"GetStreamingDistributionConfigRequest"}, "output":{"shape":"GetStreamingDistributionConfigResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about a streaming distribution." }, "ListCloudFrontOriginAccessIdentities":{ "name":"ListCloudFrontOriginAccessIdentities2016_09_07", "http":{ "method":"GET", "requestUri":"/2016-09-07/origin-access-identity/cloudfront" }, "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List origin access identities." }, "ListDistributions":{ "name":"ListDistributions2016_09_07", "http":{ "method":"GET", "requestUri":"/2016-09-07/distribution" }, "input":{"shape":"ListDistributionsRequest"}, "output":{"shape":"ListDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List distributions." }, "ListDistributionsByWebACLId":{ "name":"ListDistributionsByWebACLId2016_09_07", "http":{ "method":"GET", "requestUri":"/2016-09-07/distributionsByWebACLId/{WebACLId}" }, "input":{"shape":"ListDistributionsByWebACLIdRequest"}, "output":{"shape":"ListDistributionsByWebACLIdResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"InvalidWebACLId"} ], "documentation":"List the distributions that are associated with a specified AWS WAF web ACL." }, "ListInvalidations":{ "name":"ListInvalidations2016_09_07", "http":{ "method":"GET", "requestUri":"/2016-09-07/distribution/{DistributionId}/invalidation" }, "input":{"shape":"ListInvalidationsRequest"}, "output":{"shape":"ListInvalidationsResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"List invalidation batches." }, "ListStreamingDistributions":{ "name":"ListStreamingDistributions2016_09_07", "http":{ "method":"GET", "requestUri":"/2016-09-07/streaming-distribution" }, "input":{"shape":"ListStreamingDistributionsRequest"}, "output":{"shape":"ListStreamingDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List streaming distributions." }, "ListTagsForResource":{ "name":"ListTagsForResource2016_09_07", "http":{ "method":"GET", "requestUri":"/2016-09-07/tagging" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"List tags for a CloudFront resource." }, "TagResource":{ "name":"TagResource2016_09_07", "http":{ "method":"POST", "requestUri":"/2016-09-07/tagging?Operation=Tag", "responseCode":204 }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"Add tags to a CloudFront resource." }, "UntagResource":{ "name":"UntagResource2016_09_07", "http":{ "method":"POST", "requestUri":"/2016-09-07/tagging?Operation=Untag", "responseCode":204 }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"Remove tags from a CloudFront resource." }, "UpdateCloudFrontOriginAccessIdentity":{ "name":"UpdateCloudFrontOriginAccessIdentity2016_09_07", "http":{ "method":"PUT", "requestUri":"/2016-09-07/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"PreconditionFailed"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Update an origin access identity." }, "UpdateDistribution":{ "name":"UpdateDistribution2016_09_07", "http":{ "method":"PUT", "requestUri":"/2016-09-07/distribution/{Id}/config" }, "input":{"shape":"UpdateDistributionRequest"}, "output":{"shape":"UpdateDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"}, {"shape":"TooManyQueryStringParameters"}, {"shape":"InvalidQueryStringParameters"} ], "documentation":"Update a distribution." }, "UpdateStreamingDistribution":{ "name":"UpdateStreamingDistribution2016_09_07", "http":{ "method":"PUT", "requestUri":"/2016-09-07/streaming-distribution/{Id}/config" }, "input":{"shape":"UpdateStreamingDistributionRequest"}, "output":{"shape":"UpdateStreamingDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InconsistentQuantities"} ], "documentation":"Update a streaming distribution." } }, "shapes":{ "AccessDenied":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Access denied.", "error":{"httpStatusCode":403}, "exception":true }, "ActiveTrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Each active trusted signer." }, "Quantity":{ "shape":"integer", "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." }, "Items":{ "shape":"SignerList", "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." } }, "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." }, "AliasList":{ "type":"list", "member":{ "shape":"string", "locationName":"CNAME" } }, "Aliases":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of CNAMEs, if any, for this distribution." }, "Items":{ "shape":"AliasList", "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "AllowedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." }, "CachedMethods":{"shape":"CachedMethods"} }, "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." }, "AwsAccountNumberList":{ "type":"list", "member":{ "shape":"string", "locationName":"AwsAccountNumber" } }, "BatchTooLarge":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":413}, "exception":true }, "CNAMEAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CacheBehavior":{ "type":"structure", "required":[ "PathPattern", "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "PathPattern":{ "shape":"string", "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." }, "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "DefaultTTL":{ "shape":"long", "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "MaxTTL":{ "shape":"long", "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "Compress":{ "shape":"boolean", "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." } }, "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." }, "CacheBehaviorList":{ "type":"list", "member":{ "shape":"CacheBehavior", "locationName":"CacheBehavior" } }, "CacheBehaviors":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of cache behaviors for this distribution." }, "Items":{ "shape":"CacheBehaviorList", "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CachedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." } }, "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." }, "CertificateSource":{ "type":"string", "enum":[ "cloudfront", "iam", "acm" ] }, "CloudFrontOriginAccessIdentity":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The current configuration information for the identity." } }, "documentation":"CloudFront origin access identity." }, "CloudFrontOriginAccessIdentityAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.", "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityConfig":{ "type":"structure", "required":[ "CallerReference", "Comment" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the origin access identity." } }, "documentation":"Origin access identity configuration." }, "CloudFrontOriginAccessIdentityInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more origin access identities remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." }, "Items":{ "shape":"CloudFrontOriginAccessIdentitySummaryList", "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." } }, "documentation":"The CloudFrontOriginAccessIdentityList type." }, "CloudFrontOriginAccessIdentitySummary":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId", "Comment" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "Comment":{ "shape":"string", "documentation":"The comment for this origin access identity, as originally specified when created." } }, "documentation":"Summary of the information about a CloudFront origin access identity." }, "CloudFrontOriginAccessIdentitySummaryList":{ "type":"list", "member":{ "shape":"CloudFrontOriginAccessIdentitySummary", "locationName":"CloudFrontOriginAccessIdentitySummary" } }, "CookieNameList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "CookieNames":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of whitelisted cookies for this cache behavior." }, "Items":{ "shape":"CookieNameList", "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." }, "CookiePreference":{ "type":"structure", "required":["Forward"], "members":{ "Forward":{ "shape":"ItemSelection", "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." }, "WhitelistedNames":{ "shape":"CookieNames", "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." } }, "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." }, "CreateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["CloudFrontOriginAccessIdentityConfig"], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information.", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} } }, "documentation":"The request to create a new origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "CreateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the origin access identity created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "CreateDistributionRequest":{ "type":"structure", "required":["DistributionConfig"], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} } }, "documentation":"The request to create a new distribution.", "payload":"DistributionConfig" }, "CreateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "CreateDistributionWithTagsRequest":{ "type":"structure", "required":["DistributionConfigWithTags"], "members":{ "DistributionConfigWithTags":{ "shape":"DistributionConfigWithTags", "documentation":"The distribution's configuration information.", "locationName":"DistributionConfigWithTags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} } }, "documentation":"The request to create a new distribution with tags", "payload":"DistributionConfigWithTags" }, "CreateDistributionWithTagsResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "CreateInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "InvalidationBatch" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The batch information for the invalidation.", "locationName":"InvalidationBatch", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} } }, "documentation":"The request to create an invalidation.", "payload":"InvalidationBatch" }, "CreateInvalidationResult":{ "type":"structure", "members":{ "Location":{ "shape":"string", "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.", "location":"header", "locationName":"Location" }, "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "CreateStreamingDistributionRequest":{ "type":"structure", "required":["StreamingDistributionConfig"], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} } }, "documentation":"The request to create a new streaming distribution.", "payload":"StreamingDistributionConfig" }, "CreateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "CreateStreamingDistributionWithTagsRequest":{ "type":"structure", "required":["StreamingDistributionConfigWithTags"], "members":{ "StreamingDistributionConfigWithTags":{ "shape":"StreamingDistributionConfigWithTags", "documentation":"The streaming distribution's configuration information.", "locationName":"StreamingDistributionConfigWithTags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} } }, "documentation":"The request to create a new streaming distribution with tags.", "payload":"StreamingDistributionConfigWithTags" }, "CreateStreamingDistributionWithTagsResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "CustomErrorResponse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{ "shape":"integer", "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." }, "ResponsePagePath":{ "shape":"string", "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." }, "ResponseCode":{ "shape":"string", "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." }, "ErrorCachingMinTTL":{ "shape":"long", "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." } }, "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." }, "CustomErrorResponseList":{ "type":"list", "member":{ "shape":"CustomErrorResponse", "locationName":"CustomErrorResponse" } }, "CustomErrorResponses":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom error responses for this distribution." }, "Items":{ "shape":"CustomErrorResponseList", "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "CustomHeaders":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom headers for this origin." }, "Items":{ "shape":"OriginCustomHeadersList", "documentation":"A complex type that contains the custom headers for this Origin." } }, "documentation":"A complex type that contains the list of Custom Headers for each origin." }, "CustomOriginConfig":{ "type":"structure", "required":[ "HTTPPort", "HTTPSPort", "OriginProtocolPolicy" ], "members":{ "HTTPPort":{ "shape":"integer", "documentation":"The HTTP port the custom origin listens on." }, "HTTPSPort":{ "shape":"integer", "documentation":"The HTTPS port the custom origin listens on." }, "OriginProtocolPolicy":{ "shape":"OriginProtocolPolicy", "documentation":"The origin protocol policy to apply to your origin." }, "OriginSslProtocols":{ "shape":"OriginSslProtocols", "documentation":"The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." } }, "documentation":"A customer origin." }, "DefaultCacheBehavior":{ "type":"structure", "required":[ "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "DefaultTTL":{ "shape":"long", "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "MaxTTL":{ "shape":"long", "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "Compress":{ "shape":"boolean", "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." } }, "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "DeleteCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The origin access identity's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a origin access identity." }, "DeleteDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a distribution." }, "DeleteStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a streaming distribution." }, "Distribution":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "InProgressInvalidationBatches", "DomainName", "ActiveTrustedSigners", "DistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "ARN":{ "shape":"string", "documentation":"The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "InProgressInvalidationBatches":{ "shape":"integer", "documentation":"The number of invalidation batches currently in progress." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The current configuration information for the distribution." } }, "documentation":"A distribution." }, "DistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution.", "error":{"httpStatusCode":409}, "exception":true }, "DistributionConfig":{ "type":"structure", "required":[ "CallerReference", "Origins", "DefaultCacheBehavior", "Comment", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "DefaultRootObject":{ "shape":"string", "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the distribution." }, "Logging":{ "shape":"LoggingConfig", "documentation":"A complex type that controls whether access logs are written for the distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"(Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution." }, "HttpVersion":{ "shape":"HttpVersion", "documentation":"(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version." } }, "documentation":"A distribution Configuration." }, "DistributionConfigWithTags":{ "type":"structure", "required":[ "DistributionConfig", "Tags" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"A distribution Configuration." }, "Tags":{ "shape":"Tags", "documentation":"A complex type that contains zero or more Tag elements." } }, "documentation":"A distribution Configuration and a list of tags to be associated with the distribution." }, "DistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of distributions that were created by the current AWS account." }, "Items":{ "shape":"DistributionSummaryList", "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A distribution list." }, "DistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "DistributionSummary":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "DomainName", "Aliases", "Origins", "DefaultCacheBehavior", "CacheBehaviors", "CustomErrorResponses", "Comment", "PriceClass", "Enabled", "ViewerCertificate", "Restrictions", "WebACLId", "HttpVersion" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "ARN":{ "shape":"string", "documentation":"The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponses elements." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"The Web ACL Id (if any) associated with the distribution." }, "HttpVersion":{ "shape":"HttpVersion", "documentation":"Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version." } }, "documentation":"A summary of the information for an Amazon CloudFront distribution." }, "DistributionSummaryList":{ "type":"list", "member":{ "shape":"DistributionSummary", "locationName":"DistributionSummary" } }, "ForwardedValues":{ "type":"structure", "required":[ "QueryString", "Cookies" ], "members":{ "QueryString":{ "shape":"boolean", "documentation":"

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

  • If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
  • If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
  • If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
" }, "Cookies":{ "shape":"CookiePreference", "documentation":"A complex type that specifies how CloudFront handles cookies." }, "Headers":{ "shape":"Headers", "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." }, "QueryStringCacheKeys":{ "shape":"QueryStringCacheKeys", "documentation":"

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

" } }, "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "GeoRestriction":{ "type":"structure", "required":[ "RestrictionType", "Quantity" ], "members":{ "RestrictionType":{ "shape":"GeoRestrictionType", "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." }, "Quantity":{ "shape":"integer", "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." }, "Items":{ "shape":"LocationList", "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." } }, "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." }, "GeoRestrictionType":{ "type":"string", "enum":[ "blacklist", "whitelist", "none" ] }, "GetCloudFrontOriginAccessIdentityConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an origin access identity's configuration." }, "GetCloudFrontOriginAccessIdentityConfigResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "GetCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an origin access identity's information." }, "GetCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "GetDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a distribution configuration." }, "GetDistributionConfigResult":{ "type":"structure", "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionConfig" }, "GetDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a distribution's information." }, "GetDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "GetInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "Id" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "Id":{ "shape":"string", "documentation":"The invalidation's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an invalidation's information." }, "GetInvalidationResult":{ "type":"structure", "members":{ "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "GetStreamingDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"To request to get a streaming distribution configuration." }, "GetStreamingDistributionConfigResult":{ "type":"structure", "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionConfig" }, "GetStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a streaming distribution's information." }, "GetStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "HeaderList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "Headers":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." }, "Items":{ "shape":"HeaderList", "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." } }, "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." }, "HttpVersion":{ "type":"string", "enum":[ "http1.1", "http2" ] }, "IllegalUpdate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Origin and CallerReference cannot be updated.", "error":{"httpStatusCode":400}, "exception":true }, "InconsistentQuantities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The value of Quantity and the size of Items do not match.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidArgument":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The argument is invalid.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidDefaultRootObject":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The default root object file name is too big or contains an invalid character.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidErrorCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidForwardCookies":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidGeoRestrictionParameter":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidHeadersForS3Origin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidIfMatchVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The If-Match version is missing or not valid for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidLocationCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidMinimumProtocolVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The origin access identity is not valid or doesn't exist.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidProtocolSettings":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI).", "error":{"httpStatusCode":400}, "exception":true }, "InvalidQueryStringParameters":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidRelativePath":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/).", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRequiredProtocol":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"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.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidResponseCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidTTLOrder":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidTagging":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified tagging for a CloudFront resource is invalid. For more information, see the error text.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidViewerCertificate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidWebACLId":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "Invalidation":{ "type":"structure", "required":[ "Id", "Status", "CreateTime", "InvalidationBatch" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." }, "CreateTime":{ "shape":"timestamp", "documentation":"The date and time the invalidation request was first made." }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The current invalidation information for the batch request." } }, "documentation":"An invalidation." }, "InvalidationBatch":{ "type":"structure", "required":[ "Paths", "CallerReference" ], "members":{ "Paths":{ "shape":"Paths", "documentation":"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. 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. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." }, "CallerReference":{ "shape":"string", "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. 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, the response includes the same information returned to the original request. 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, CloudFront returns an InvalidationBatchAlreadyExists error." } }, "documentation":"An invalidation batch." }, "InvalidationList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of invalidation batches that were created by the current AWS account." }, "Items":{ "shape":"InvalidationSummaryList", "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." } }, "documentation":"An invalidation list." }, "InvalidationSummary":{ "type":"structure", "required":[ "Id", "CreateTime", "Status" ], "members":{ "Id":{ "shape":"string", "documentation":"The unique ID for an invalidation request." }, "CreateTime":{"shape":"timestamp"}, "Status":{ "shape":"string", "documentation":"The status of an invalidation request." } }, "documentation":"Summary of an invalidation request." }, "InvalidationSummaryList":{ "type":"list", "member":{ "shape":"InvalidationSummary", "locationName":"InvalidationSummary" } }, "ItemSelection":{ "type":"string", "enum":[ "none", "whitelist", "all" ] }, "KeyPairIdList":{ "type":"list", "member":{ "shape":"string", "locationName":"KeyPairId" } }, "KeyPairIds":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." }, "Items":{ "shape":"KeyPairIdList", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." }, "ListCloudFrontOriginAccessIdentitiesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"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. 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).", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of origin access identities you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list origin access identities." }, "ListCloudFrontOriginAccessIdentitiesResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityList":{ "shape":"CloudFrontOriginAccessIdentityList", "documentation":"The CloudFrontOriginAccessIdentityList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityList" }, "ListDistributionsByWebACLIdRequest":{ "type":"structure", "required":["WebACLId"], "members":{ "Marker":{ "shape":"string", "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", "location":"querystring", "locationName":"MaxItems" }, "WebACLId":{ "shape":"string", "documentation":"The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify \"null\" for the Id, the request returns a list of the distributions that aren't associated with a web ACL.", "location":"uri", "locationName":"WebACLId" } }, "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL." }, "ListDistributionsByWebACLIdResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.", "payload":"DistributionList" }, "ListDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list your distributions." }, "ListDistributionsResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionList" }, "ListInvalidationsRequest":{ "type":"structure", "required":["DistributionId"], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "Marker":{ "shape":"string", "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. 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. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of invalidation batches you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list invalidations." }, "ListInvalidationsResult":{ "type":"structure", "members":{ "InvalidationList":{ "shape":"InvalidationList", "documentation":"Information about invalidation batches." } }, "documentation":"The returned result of the corresponding request.", "payload":"InvalidationList" }, "ListStreamingDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"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. 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).", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of streaming distributions you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list your streaming distributions." }, "ListStreamingDistributionsResult":{ "type":"structure", "members":{ "StreamingDistributionList":{ "shape":"StreamingDistributionList", "documentation":"The StreamingDistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionList" }, "ListTagsForResourceRequest":{ "type":"structure", "required":["Resource"], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"An ARN of a CloudFront resource.", "location":"querystring", "locationName":"Resource" } }, "documentation":"The request to list tags for a CloudFront resource." }, "ListTagsForResourceResult":{ "type":"structure", "required":["Tags"], "members":{ "Tags":{ "shape":"Tags", "documentation":"A complex type that contains zero or more Tag elements." } }, "documentation":"The returned result of the corresponding request.", "payload":"Tags" }, "LocationList":{ "type":"list", "member":{ "shape":"string", "locationName":"Location" } }, "LoggingConfig":{ "type":"structure", "required":[ "Enabled", "IncludeCookies", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." }, "IncludeCookies":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for the distribution." }, "Method":{ "type":"string", "enum":[ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ] }, "MethodsList":{ "type":"list", "member":{ "shape":"Method", "locationName":"Method" } }, "MinimumProtocolVersion":{ "type":"string", "enum":[ "SSLv3", "TLSv1" ] }, "MissingBody":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set.", "error":{"httpStatusCode":400}, "exception":true }, "NoSuchCloudFrontOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified origin access identity does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified distribution does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchInvalidation":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified invalidation does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"No origin exists with the specified Origin Id.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchResource":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified CloudFront resource does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchStreamingDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified streaming distribution does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "Origin":{ "type":"structure", "required":[ "Id", "DomainName" ], "members":{ "Id":{ "shape":"string", "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." }, "DomainName":{ "shape":"string", "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." }, "OriginPath":{ "shape":"string", "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." }, "CustomHeaders":{ "shape":"CustomHeaders", "documentation":"A complex type that contains information about the custom headers associated with this Origin." }, "S3OriginConfig":{ "shape":"S3OriginConfig", "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "CustomOriginConfig":{ "shape":"CustomOriginConfig", "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." } }, "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." }, "OriginCustomHeader":{ "type":"structure", "required":[ "HeaderName", "HeaderValue" ], "members":{ "HeaderName":{ "shape":"string", "documentation":"The header's name." }, "HeaderValue":{ "shape":"string", "documentation":"The header's value." } }, "documentation":"A complex type that contains information related to a Header" }, "OriginCustomHeadersList":{ "type":"list", "member":{ "shape":"OriginCustomHeader", "locationName":"OriginCustomHeader" } }, "OriginList":{ "type":"list", "member":{ "shape":"Origin", "locationName":"Origin" }, "min":1 }, "OriginProtocolPolicy":{ "type":"string", "enum":[ "http-only", "match-viewer", "https-only" ] }, "OriginSslProtocols":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." }, "Items":{ "shape":"SslProtocolsList", "documentation":"A complex type that contains one SslProtocol element for each SSL/TLS protocol that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." } }, "documentation":"A complex type that contains the list of SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." }, "Origins":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of origins for this distribution." }, "Items":{ "shape":"OriginList", "documentation":"A complex type that contains origins for this distribution." } }, "documentation":"A complex type that contains information about origins for this distribution." }, "PathList":{ "type":"list", "member":{ "shape":"string", "locationName":"Path" } }, "Paths":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of objects that you want to invalidate." }, "Items":{ "shape":"PathList", "documentation":"A complex type that contains a list of the objects that you want to invalidate." } }, "documentation":"A complex type that contains information about the objects that you want to invalidate." }, "PreconditionFailed":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The precondition given in one or more of the request-header fields evaluated to false.", "error":{"httpStatusCode":412}, "exception":true }, "PriceClass":{ "type":"string", "enum":[ "PriceClass_100", "PriceClass_200", "PriceClass_All" ] }, "QueryStringCacheKeys":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of whitelisted query string parameters for this cache behavior." }, "Items":{ "shape":"QueryStringCacheKeysList", "documentation":"Optional: A list that contains the query string parameters that you want CloudFront to use as a basis for caching for this cache behavior. If Quantity is 0, you can omit Items." } } }, "QueryStringCacheKeysList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "ResourceARN":{ "type":"string", "pattern":"arn:aws:cloudfront::[0-9]+:.*" }, "Restrictions":{ "type":"structure", "required":["GeoRestriction"], "members":{ "GeoRestriction":{"shape":"GeoRestriction"} }, "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." }, "S3Origin":{ "type":"structure", "required":[ "DomainName", "OriginAccessIdentity" ], "members":{ "DomainName":{ "shape":"string", "documentation":"The DNS name of the S3 origin." }, "OriginAccessIdentity":{ "shape":"string", "documentation":"Your S3 origin's origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "S3OriginConfig":{ "type":"structure", "required":["OriginAccessIdentity"], "members":{ "OriginAccessIdentity":{ "shape":"string", "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "SSLSupportMethod":{ "type":"string", "enum":[ "sni-only", "vip" ] }, "Signer":{ "type":"structure", "members":{ "AwsAccountNumber":{ "shape":"string", "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." }, "KeyPairIds":{ "shape":"KeyPairIds", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." }, "SignerList":{ "type":"list", "member":{ "shape":"Signer", "locationName":"Signer" } }, "SslProtocol":{ "type":"string", "enum":[ "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2" ] }, "SslProtocolsList":{ "type":"list", "member":{ "shape":"SslProtocol", "locationName":"SslProtocol" } }, "StreamingDistribution":{ "type":"structure", "required":[ "Id", "ARN", "Status", "DomainName", "ActiveTrustedSigners", "StreamingDistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." }, "ARN":{ "shape":"string", "documentation":"The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." }, "Status":{ "shape":"string", "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The current configuration information for the streaming distribution." } }, "documentation":"A streaming distribution." }, "StreamingDistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionConfig":{ "type":"structure", "required":[ "CallerReference", "S3Origin", "Comment", "TrustedSigners", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the streaming distribution." }, "Logging":{ "shape":"StreamingLoggingConfig", "documentation":"A complex type that controls whether access logs are written for the streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this streaming distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." } }, "documentation":"The configuration for the streaming distribution." }, "StreamingDistributionConfigWithTags":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Tags" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"A streaming distribution Configuration." }, "Tags":{ "shape":"Tags", "documentation":"A complex type that contains zero or more Tag elements." } }, "documentation":"A streaming distribution Configuration and a list of tags to be associated with the streaming distribution." }, "StreamingDistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more streaming distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of streaming distributions that were created by the current AWS account." }, "Items":{ "shape":"StreamingDistributionSummaryList", "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A streaming distribution list." }, "StreamingDistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionSummary":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "DomainName", "S3Origin", "Aliases", "TrustedSigners", "Comment", "PriceClass", "Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "ARN":{ "shape":"string", "documentation":"The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." }, "Status":{ "shape":"string", "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." } }, "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." }, "StreamingDistributionSummaryList":{ "type":"list", "member":{ "shape":"StreamingDistributionSummary", "locationName":"StreamingDistributionSummary" } }, "StreamingLoggingConfig":{ "type":"structure", "required":[ "Enabled", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for this streaming distribution." }, "Tag":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"TagKey", "documentation":"A string that contains Tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @." }, "Value":{ "shape":"TagValue", "documentation":"A string that contains an optional Tag value. The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @." } }, "documentation":"A complex type that contains Tag key and Tag value." }, "TagKey":{ "type":"string", "documentation":"A string that contains Tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeyList":{ "type":"list", "member":{ "shape":"TagKey", "locationName":"Key" } }, "TagKeys":{ "type":"structure", "members":{ "Items":{ "shape":"TagKeyList", "documentation":"A complex type that contains Tag key elements" } }, "documentation":"A complex type that contains zero or more Tag elements." }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"Tag" } }, "TagResourceRequest":{ "type":"structure", "required":[ "Resource", "Tags" ], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"An ARN of a CloudFront resource.", "location":"querystring", "locationName":"Resource" }, "Tags":{ "shape":"Tags", "documentation":"A complex type that contains zero or more Tag elements.", "locationName":"Tags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} } }, "documentation":"The request to add tags to a CloudFront resource.", "payload":"Tags" }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Tags":{ "type":"structure", "members":{ "Items":{ "shape":"TagList", "documentation":"A complex type that contains Tag elements" } }, "documentation":"A complex type that contains zero or more Tag elements." }, "TooManyCacheBehaviors":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore cache behaviors for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCertificates":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore custom ssl certificates.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCloudFrontOriginAccessIdentities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCookieNamesInWhiteList":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more CNAMEs than are allowed per distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyHeadersInForwardedValues":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyInvalidationsInProgress":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyOriginCustomHeaders":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyOrigins":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore origins for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyQueryStringParameters":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyTrustedSigners":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more trusted signers than are allowed per distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSignerDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"One or more of your trusted signers do not exist.", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." }, "Quantity":{ "shape":"integer", "documentation":"The number of trusted signers for this cache behavior." }, "Items":{ "shape":"AwsAccountNumberList", "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "UntagResourceRequest":{ "type":"structure", "required":[ "Resource", "TagKeys" ], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"An ARN of a CloudFront resource.", "location":"querystring", "locationName":"Resource" }, "TagKeys":{ "shape":"TagKeys", "documentation":"A complex type that contains zero or more Tag key elements.", "locationName":"TagKeys", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} } }, "documentation":"The request to remove tags from a CloudFront resource.", "payload":"TagKeys" }, "UpdateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":[ "CloudFrontOriginAccessIdentityConfig", "Id" ], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The identity's configuration information.", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} }, "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update an origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "UpdateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "UpdateDistributionRequest":{ "type":"structure", "required":[ "DistributionConfig", "Id" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} }, "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update a distribution.", "payload":"DistributionConfig" }, "UpdateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "UpdateStreamingDistributionRequest":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Id" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} }, "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update a streaming distribution.", "payload":"StreamingDistributionConfig" }, "UpdateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "ViewerCertificate":{ "type":"structure", "members":{ "CloudFrontDefaultCertificate":{ "shape":"boolean", "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an ACMCertificateArn or IAMCertificateId." }, "IAMCertificateId":{ "shape":"string", "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value, ACMCertificateArn, or CloudFrontDefaultCertificate." }, "ACMCertificateArn":{ "shape":"string", "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the ACM certificate ARN of the custom viewer certificate for this distribution. Specify either this value, IAMCertificateId, or CloudFrontDefaultCertificate." }, "SSLSupportMethod":{ "shape":"SSLSupportMethod", "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." }, "MinimumProtocolVersion":{ "shape":"MinimumProtocolVersion", "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." }, "Certificate":{ "shape":"string", "documentation":"Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].", "deprecated":true }, "CertificateSource":{ "shape":"CertificateSource", "documentation":"Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].", "deprecated":true } }, "documentation":"A complex type that contains information about viewer certificates for this distribution." }, "ViewerProtocolPolicy":{ "type":"string", "enum":[ "allow-all", "https-only", "redirect-to-https" ] }, "boolean":{"type":"boolean"}, "integer":{"type":"integer"}, "long":{"type":"long"}, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} }, "documentation":"Amazon CloudFront

Amazon CloudFront is a global content delivery network (CDN) service that accelerates delivery of your websites, APIs, video content or other web assets. It integrates with other Amazon Web Services products to give developers and businesses an easy way to accelerate content to end users with no minimum usage commitments.

" } botocore-1.5.7/botocore/data/cloudfront/2016-09-29/0000777454262600001440000000000013042511307022360 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudfront/2016-09-29/waiters-2.json0000666454262600001440000000224013042511306025065 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DistributionDeployed": { "delay": 60, "operation": "GetDistribution", "maxAttempts": 25, "description": "Wait until a distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "Distribution.Status" } ] }, "InvalidationCompleted": { "delay": 20, "operation": "GetInvalidation", "maxAttempts": 60, "description": "Wait until an invalidation has completed.", "acceptors": [ { "expected": "Completed", "matcher": "path", "state": "success", "argument": "Invalidation.Status" } ] }, "StreamingDistributionDeployed": { "delay": 60, "operation": "GetStreamingDistribution", "maxAttempts": 25, "description": "Wait until a streaming distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "StreamingDistribution.Status" } ] } } } botocore-1.5.7/botocore/data/cloudfront/2016-09-29/paginators-1.json0000666454262600001440000000214613042511306025562 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListCloudFrontOriginAccessIdentities": { "input_token": "Marker", "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", "limit_key": "MaxItems", "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", "result_key": "CloudFrontOriginAccessIdentityList.Items" }, "ListDistributions": { "input_token": "Marker", "output_token": "DistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "DistributionList.IsTruncated", "result_key": "DistributionList.Items" }, "ListInvalidations": { "input_token": "Marker", "output_token": "InvalidationList.NextMarker", "limit_key": "MaxItems", "more_results": "InvalidationList.IsTruncated", "result_key": "InvalidationList.Items" }, "ListStreamingDistributions": { "input_token": "Marker", "output_token": "StreamingDistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "StreamingDistributionList.IsTruncated", "result_key": "StreamingDistributionList.Items" } } } botocore-1.5.7/botocore/data/cloudfront/2016-09-29/service-2.json0000666454262600001440000057433013042511306025065 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-09-29", "endpointPrefix":"cloudfront", "globalEndpoint":"cloudfront.amazonaws.com", "protocol":"rest-xml", "serviceAbbreviation":"CloudFront", "serviceFullName":"Amazon CloudFront", "signatureVersion":"v4" }, "operations":{ "CreateCloudFrontOriginAccessIdentity":{ "name":"CreateCloudFrontOriginAccessIdentity2016_09_29", "http":{ "method":"POST", "requestUri":"/2016-09-29/origin-access-identity/cloudfront", "responseCode":201 }, "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, {"shape":"MissingBody"}, {"shape":"TooManyCloudFrontOriginAccessIdentities"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" }, "CreateDistribution":{ "name":"CreateDistribution2016_09_29", "http":{ "method":"POST", "requestUri":"/2016-09-29/distribution", "responseCode":201 }, "input":{"shape":"CreateDistributionRequest"}, "output":{"shape":"CreateDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"DistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"MissingBody"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"TooManyDistributions"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidProtocolSettings"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"}, {"shape":"TooManyQueryStringParameters"}, {"shape":"InvalidQueryStringParameters"} ], "documentation":"

Creates a new web distribution. Send a GET request to the /CloudFront API version/distribution/distribution ID resource.

" }, "CreateDistributionWithTags":{ "name":"CreateDistributionWithTags2016_09_29", "http":{ "method":"POST", "requestUri":"/2016-09-29/distribution?WithTags", "responseCode":201 }, "input":{"shape":"CreateDistributionWithTagsRequest"}, "output":{"shape":"CreateDistributionWithTagsResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"DistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"MissingBody"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"TooManyDistributions"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidProtocolSettings"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"}, {"shape":"InvalidTagging"}, {"shape":"TooManyQueryStringParameters"}, {"shape":"InvalidQueryStringParameters"} ], "documentation":"

Create a new distribution with tags.

" }, "CreateInvalidation":{ "name":"CreateInvalidation2016_09_29", "http":{ "method":"POST", "requestUri":"/2016-09-29/distribution/{DistributionId}/invalidation", "responseCode":201 }, "input":{"shape":"CreateInvalidationRequest"}, "output":{"shape":"CreateInvalidationResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"MissingBody"}, {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"BatchTooLarge"}, {"shape":"TooManyInvalidationsInProgress"}, {"shape":"InconsistentQuantities"} ], "documentation":"

Create a new invalidation.

" }, "CreateStreamingDistribution":{ "name":"CreateStreamingDistribution2016_09_29", "http":{ "method":"POST", "requestUri":"/2016-09-29/streaming-distribution", "responseCode":201 }, "input":{"shape":"CreateStreamingDistributionRequest"}, "output":{"shape":"CreateStreamingDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"StreamingDistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"MissingBody"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"TooManyStreamingDistributions"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"

Creates a new RMTP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP.

To create a new web distribution, submit a POST request to the CloudFront API version/distribution resource. The request body must include a document with a StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig element and returns other information about the RTMP distribution.

To get the status of your request, use the GET StreamingDistribution API action. When the value of Enabled is true and the value of Status is Deployed, your distribution is ready. A distribution usually deploys in less than 15 minutes.

For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide.

Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the Quantity element and the number of values specified.

" }, "CreateStreamingDistributionWithTags":{ "name":"CreateStreamingDistributionWithTags2016_09_29", "http":{ "method":"POST", "requestUri":"/2016-09-29/streaming-distribution?WithTags", "responseCode":201 }, "input":{"shape":"CreateStreamingDistributionWithTagsRequest"}, "output":{"shape":"CreateStreamingDistributionWithTagsResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"StreamingDistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"MissingBody"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"TooManyStreamingDistributions"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"}, {"shape":"InvalidTagging"} ], "documentation":"

Create a new streaming distribution with tags.

" }, "DeleteCloudFrontOriginAccessIdentity":{ "name":"DeleteCloudFrontOriginAccessIdentity2016_09_29", "http":{ "method":"DELETE", "requestUri":"/2016-09-29/origin-access-identity/cloudfront/{Id}", "responseCode":204 }, "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"PreconditionFailed"}, {"shape":"CloudFrontOriginAccessIdentityInUse"} ], "documentation":"

Delete an origin access identity.

" }, "DeleteDistribution":{ "name":"DeleteDistribution2016_09_29", "http":{ "method":"DELETE", "requestUri":"/2016-09-29/distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"DistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"

Delete a distribution.

" }, "DeleteStreamingDistribution":{ "name":"DeleteStreamingDistribution2016_09_29", "http":{ "method":"DELETE", "requestUri":"/2016-09-29/streaming-distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteStreamingDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"StreamingDistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"

Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.

To delete an RTMP distribution using the CloudFront API:

  1. Disable the RTMP distribution.

  2. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  5. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  8. Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" }, "GetCloudFrontOriginAccessIdentity":{ "name":"GetCloudFrontOriginAccessIdentity2016_09_29", "http":{ "method":"GET", "requestUri":"/2016-09-29/origin-access-identity/cloudfront/{Id}" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"

Get the information about an origin access identity.

" }, "GetCloudFrontOriginAccessIdentityConfig":{ "name":"GetCloudFrontOriginAccessIdentityConfig2016_09_29", "http":{ "method":"GET", "requestUri":"/2016-09-29/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"

Get the configuration information about an origin access identity.

" }, "GetDistribution":{ "name":"GetDistribution2016_09_29", "http":{ "method":"GET", "requestUri":"/2016-09-29/distribution/{Id}" }, "input":{"shape":"GetDistributionRequest"}, "output":{"shape":"GetDistributionResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"

Get the information about a distribution.

" }, "GetDistributionConfig":{ "name":"GetDistributionConfig2016_09_29", "http":{ "method":"GET", "requestUri":"/2016-09-29/distribution/{Id}/config" }, "input":{"shape":"GetDistributionConfigRequest"}, "output":{"shape":"GetDistributionConfigResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"

Get the configuration information about a distribution.

" }, "GetInvalidation":{ "name":"GetInvalidation2016_09_29", "http":{ "method":"GET", "requestUri":"/2016-09-29/distribution/{DistributionId}/invalidation/{Id}" }, "input":{"shape":"GetInvalidationRequest"}, "output":{"shape":"GetInvalidationResult"}, "errors":[ {"shape":"NoSuchInvalidation"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"

Get the information about an invalidation.

" }, "GetStreamingDistribution":{ "name":"GetStreamingDistribution2016_09_29", "http":{ "method":"GET", "requestUri":"/2016-09-29/streaming-distribution/{Id}" }, "input":{"shape":"GetStreamingDistributionRequest"}, "output":{"shape":"GetStreamingDistributionResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"

Gets information about a specified RTMP distribution, including the distribution configuration.

" }, "GetStreamingDistributionConfig":{ "name":"GetStreamingDistributionConfig2016_09_29", "http":{ "method":"GET", "requestUri":"/2016-09-29/streaming-distribution/{Id}/config" }, "input":{"shape":"GetStreamingDistributionConfigRequest"}, "output":{"shape":"GetStreamingDistributionConfigResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"

Get the configuration information about a streaming distribution.

" }, "ListCloudFrontOriginAccessIdentities":{ "name":"ListCloudFrontOriginAccessIdentities2016_09_29", "http":{ "method":"GET", "requestUri":"/2016-09-29/origin-access-identity/cloudfront" }, "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"

Lists origin access identities.

" }, "ListDistributions":{ "name":"ListDistributions2016_09_29", "http":{ "method":"GET", "requestUri":"/2016-09-29/distribution" }, "input":{"shape":"ListDistributionsRequest"}, "output":{"shape":"ListDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"

List distributions.

" }, "ListDistributionsByWebACLId":{ "name":"ListDistributionsByWebACLId2016_09_29", "http":{ "method":"GET", "requestUri":"/2016-09-29/distributionsByWebACLId/{WebACLId}" }, "input":{"shape":"ListDistributionsByWebACLIdRequest"}, "output":{"shape":"ListDistributionsByWebACLIdResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"InvalidWebACLId"} ], "documentation":"

List the distributions that are associated with a specified AWS WAF web ACL.

" }, "ListInvalidations":{ "name":"ListInvalidations2016_09_29", "http":{ "method":"GET", "requestUri":"/2016-09-29/distribution/{DistributionId}/invalidation" }, "input":{"shape":"ListInvalidationsRequest"}, "output":{"shape":"ListInvalidationsResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"

Lists invalidation batches.

" }, "ListStreamingDistributions":{ "name":"ListStreamingDistributions2016_09_29", "http":{ "method":"GET", "requestUri":"/2016-09-29/streaming-distribution" }, "input":{"shape":"ListStreamingDistributionsRequest"}, "output":{"shape":"ListStreamingDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"

List streaming distributions.

" }, "ListTagsForResource":{ "name":"ListTagsForResource2016_09_29", "http":{ "method":"GET", "requestUri":"/2016-09-29/tagging" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"

List tags for a CloudFront resource.

" }, "TagResource":{ "name":"TagResource2016_09_29", "http":{ "method":"POST", "requestUri":"/2016-09-29/tagging?Operation=Tag", "responseCode":204 }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"

Add tags to a CloudFront resource.

" }, "UntagResource":{ "name":"UntagResource2016_09_29", "http":{ "method":"POST", "requestUri":"/2016-09-29/tagging?Operation=Untag", "responseCode":204 }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"

Remove tags from a CloudFront resource.

" }, "UpdateCloudFrontOriginAccessIdentity":{ "name":"UpdateCloudFrontOriginAccessIdentity2016_09_29", "http":{ "method":"PUT", "requestUri":"/2016-09-29/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"PreconditionFailed"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"

Update an origin access identity.

" }, "UpdateDistribution":{ "name":"UpdateDistribution2016_09_29", "http":{ "method":"PUT", "requestUri":"/2016-09-29/distribution/{Id}/config" }, "input":{"shape":"UpdateDistributionRequest"}, "output":{"shape":"UpdateDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"}, {"shape":"TooManyQueryStringParameters"}, {"shape":"InvalidQueryStringParameters"} ], "documentation":"

Update a distribution.

" }, "UpdateStreamingDistribution":{ "name":"UpdateStreamingDistribution2016_09_29", "http":{ "method":"PUT", "requestUri":"/2016-09-29/streaming-distribution/{Id}/config" }, "input":{"shape":"UpdateStreamingDistributionRequest"}, "output":{"shape":"UpdateStreamingDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InconsistentQuantities"} ], "documentation":"

Update a streaming distribution.

" } }, "shapes":{ "AccessDenied":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Access denied.

", "error":{"httpStatusCode":403}, "exception":true }, "ActiveTrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"

Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this RTMP distribution have active CloudFront key pairs. If not, Enabled is false.

For more information, see ActiveTrustedSigners.

" }, "Quantity":{ "shape":"integer", "documentation":"

A complex type that contains one Signer complex type for each trusted signer specified in the TrustedSigners complex type.

For more information, see ActiveTrustedSigners.

" }, "Items":{ "shape":"SignerList", "documentation":"

A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type.

For more information, see ActiveTrustedSigners.

" } }, "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" }, "AliasList":{ "type":"list", "member":{ "shape":"string", "locationName":"CNAME" } }, "Aliases":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of CNAME aliases, if any, that you want to associate with this distribution.

" }, "Items":{ "shape":"AliasList", "documentation":"

A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

" } }, "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" }, "AllowedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).

" }, "Items":{ "shape":"MethodsList", "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

" }, "CachedMethods":{"shape":"CachedMethods"} }, "documentation":"

A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:

  • CloudFront forwards only GET and HEAD requests.

  • CloudFront forwards only GET, HEAD, and OPTIONS requests.

  • CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests.

If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.

" }, "AwsAccountNumberList":{ "type":"list", "member":{ "shape":"string", "locationName":"AwsAccountNumber" } }, "BatchTooLarge":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":413}, "exception":true }, "CNAMEAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CacheBehavior":{ "type":"structure", "required":[ "PathPattern", "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "PathPattern":{ "shape":"string", "documentation":"

The pattern (for example, images/*.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/*.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

" }, "TargetOriginId":{ "shape":"string", "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.

" }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" }, "MinTTL":{ "shape":"long", "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" }, "DefaultTTL":{ "shape":"long", "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" }, "MaxTTL":{ "shape":"long", "documentation":"

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" }, "Compress":{ "shape":"boolean", "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" } }, "documentation":"

A complex type that describes how CloudFront processes requests.

You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.

For the current limit on the number of cache behaviors that you can add to a distribution, see Amazon CloudFront Limits in the AWS General Reference.

If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error.

To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.

To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.

For more information about cache behaviors, see Cache Behaviors in the Amazon CloudFront Developer Guide.

" }, "CacheBehaviorList":{ "type":"list", "member":{ "shape":"CacheBehavior", "locationName":"CacheBehavior" } }, "CacheBehaviors":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of cache behaviors for this distribution.

" }, "Items":{ "shape":"CacheBehaviorList", "documentation":"

Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.

" } }, "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" }, "CachedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).

" }, "Items":{ "shape":"MethodsList", "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to cache responses to.

" } }, "documentation":"

A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:

  • CloudFront caches responses to GET and HEAD requests.

  • CloudFront caches responses to GET, HEAD, and OPTIONS requests.

If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.

" }, "CertificateSource":{ "type":"string", "enum":[ "cloudfront", "iam", "acm" ] }, "CloudFrontOriginAccessIdentity":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId" ], "members":{ "Id":{ "shape":"string", "documentation":"

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

" }, "S3CanonicalUserId":{ "shape":"string", "documentation":"

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.

" }, "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"

The current configuration information for the identity.

" } }, "documentation":"

CloudFront origin access identity.

" }, "CloudFrontOriginAccessIdentityAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

", "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityConfig":{ "type":"structure", "required":[ "CallerReference", "Comment" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"

A unique number that ensures the request can't be replayed.

If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.

If the CallerReference is a value already sent in a previous identity request, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request.

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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

" }, "Comment":{ "shape":"string", "documentation":"

Any comments you want to include about the origin access identity.

" } }, "documentation":"

Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource.

" }, "CloudFrontOriginAccessIdentityInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"

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. 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).

" }, "NextMarker":{ "shape":"string", "documentation":"

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.

" }, "MaxItems":{ "shape":"integer", "documentation":"

The maximum number of origin access identities you want in the response body.

" }, "IsTruncated":{ "shape":"boolean", "documentation":"

A flag that indicates whether more origin access identities remain to be listed. 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.

" }, "Quantity":{ "shape":"integer", "documentation":"

The number of CloudFront origin access identities that were created by the current AWS account.

" }, "Items":{ "shape":"CloudFrontOriginAccessIdentitySummaryList", "documentation":"

A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account.

" } }, "documentation":"

Lists the origin access identities for CloudFront.Send a GET request to the /CloudFront API version/origin-access-identity/cloudfront resource. The response includes a CloudFrontOriginAccessIdentityList element with zero or more CloudFrontOriginAccessIdentitySummary child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the MaxItems and Marker parameters.

" }, "CloudFrontOriginAccessIdentitySummary":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId", "Comment" ], "members":{ "Id":{ "shape":"string", "documentation":"

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

" }, "S3CanonicalUserId":{ "shape":"string", "documentation":"

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.

" }, "Comment":{ "shape":"string", "documentation":"

The comment for this origin access identity, as originally specified when created.

" } }, "documentation":"

Summary of the information about a CloudFront origin access identity.

" }, "CloudFrontOriginAccessIdentitySummaryList":{ "type":"list", "member":{ "shape":"CloudFrontOriginAccessIdentitySummary", "locationName":"CloudFrontOriginAccessIdentitySummary" } }, "CookieNameList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "CookieNames":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

" }, "Items":{ "shape":"CookieNameList", "documentation":"

A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

" } }, "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" }, "CookiePreference":{ "type":"structure", "required":["Forward"], "members":{ "Forward":{ "shape":"ItemSelection", "documentation":"

Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.

" }, "WhitelistedNames":{ "shape":"CookieNames", "documentation":"

Required if you specify whitelist for the value of Forward:. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.

If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.

For the current limit on the number of cookie names that you can whitelist for each cache behavior, see Amazon CloudFront Limits in the AWS General Reference.

" } }, "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" }, "CreateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["CloudFrontOriginAccessIdentityConfig"], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"

The current configuration information for the identity.

", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} } }, "documentation":"

The request to create a new origin access identity.

", "payload":"CloudFrontOriginAccessIdentityConfig" }, "CreateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"

The origin access identity's information.

" }, "Location":{ "shape":"string", "documentation":"

The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.

", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"

The current version of the origin access identity created.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"CloudFrontOriginAccessIdentity" }, "CreateDistributionRequest":{ "type":"structure", "required":["DistributionConfig"], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"

The distribution's configuration information.

", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} } }, "documentation":"

The request to create a new distribution.

", "payload":"DistributionConfig" }, "CreateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"

The distribution's information.

" }, "Location":{ "shape":"string", "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"

The current version of the distribution created.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"Distribution" }, "CreateDistributionWithTagsRequest":{ "type":"structure", "required":["DistributionConfigWithTags"], "members":{ "DistributionConfigWithTags":{ "shape":"DistributionConfigWithTags", "documentation":"

The distribution's configuration information.

", "locationName":"DistributionConfigWithTags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} } }, "documentation":"

The request to create a new distribution with tags.

", "payload":"DistributionConfigWithTags" }, "CreateDistributionWithTagsResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"

The distribution's information.

" }, "Location":{ "shape":"string", "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"

The current version of the distribution created.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"Distribution" }, "CreateInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "InvalidationBatch" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"

The distribution's id.

", "location":"uri", "locationName":"DistributionId" }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"

The batch information for the invalidation.

", "locationName":"InvalidationBatch", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} } }, "documentation":"

The request to create an invalidation.

", "payload":"InvalidationBatch" }, "CreateInvalidationResult":{ "type":"structure", "members":{ "Location":{ "shape":"string", "documentation":"

The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.

", "location":"header", "locationName":"Location" }, "Invalidation":{ "shape":"Invalidation", "documentation":"

The invalidation's information.

" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"Invalidation" }, "CreateStreamingDistributionRequest":{ "type":"structure", "required":["StreamingDistributionConfig"], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"

The streaming distribution's configuration information.

", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} } }, "documentation":"

The request to create a new streaming distribution.

", "payload":"StreamingDistributionConfig" }, "CreateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"

The streaming distribution's information.

" }, "Location":{ "shape":"string", "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"

The current version of the streaming distribution created.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"StreamingDistribution" }, "CreateStreamingDistributionWithTagsRequest":{ "type":"structure", "required":["StreamingDistributionConfigWithTags"], "members":{ "StreamingDistributionConfigWithTags":{ "shape":"StreamingDistributionConfigWithTags", "documentation":"

The streaming distribution's configuration information.

", "locationName":"StreamingDistributionConfigWithTags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} } }, "documentation":"

The request to create a new streaming distribution with tags.

", "payload":"StreamingDistributionConfigWithTags" }, "CreateStreamingDistributionWithTagsResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"

The streaming distribution's information.

" }, "Location":{ "shape":"string", "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"StreamingDistribution" }, "CustomErrorResponse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{ "shape":"integer", "documentation":"

The HTTP status code for which you want to specify a custom error page and/or a caching duration.

" }, "ResponsePagePath":{ "shape":"string", "documentation":"

The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:

  • The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/*.

  • The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.

If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.

" }, "ResponseCode":{ "shape":"string", "documentation":"

The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:

  • Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted.

  • If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors.

  • You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down.

If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

" }, "ErrorCachingMinTTL":{ "shape":"long", "documentation":"

The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.

If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" } }, "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" }, "CustomErrorResponseList":{ "type":"list", "member":{ "shape":"CustomErrorResponse", "locationName":"CustomErrorResponse" } }, "CustomErrorResponses":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.

" }, "Items":{ "shape":"CustomErrorResponseList", "documentation":"

A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.

" } }, "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" }, "CustomHeaders":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of custom headers, if any, for this distribution.

" }, "Items":{ "shape":"OriginCustomHeadersList", "documentation":"

Optional: A list that contains one OriginCustomHeader element for each custom header that you want CloudFront to forward to the origin. If Quantity is 0, omit Items.

" } }, "documentation":"

A complex type that contains the list of Custom Headers for each origin.

" }, "CustomOriginConfig":{ "type":"structure", "required":[ "HTTPPort", "HTTPSPort", "OriginProtocolPolicy" ], "members":{ "HTTPPort":{ "shape":"integer", "documentation":"

The HTTP port the custom origin listens on.

" }, "HTTPSPort":{ "shape":"integer", "documentation":"

The HTTPS port the custom origin listens on.

" }, "OriginProtocolPolicy":{ "shape":"OriginProtocolPolicy", "documentation":"

The origin protocol policy to apply to your origin.

" }, "OriginSslProtocols":{ "shape":"OriginSslProtocols", "documentation":"

The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

" } }, "documentation":"

A customer origin.

" }, "DefaultCacheBehavior":{ "type":"structure", "required":[ "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "TargetOriginId":{ "shape":"string", "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.

" }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" }, "MinTTL":{ "shape":"long", "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" }, "DefaultTTL":{ "shape":"long", "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" }, "MaxTTL":{"shape":"long"}, "Compress":{ "shape":"boolean", "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" } }, "documentation":"

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" }, "DeleteCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The origin access identity's ID.

", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"

The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"If-Match" } }, "documentation":"

Deletes a origin access identity.

" }, "DeleteDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The distribution ID.

", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"

The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"If-Match" } }, "documentation":"

This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.

To delete a web distribution using the CloudFront API:

  1. Disable the web distribution

  2. Submit a GET Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 2.

  5. Review the response to the PUT Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Distribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 6.

  8. Review the response to your DELETE Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" }, "DeleteStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The distribution ID.

", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"

The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"If-Match" } }, "documentation":"

The request to delete a streaming distribution.

" }, "Distribution":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "InProgressInvalidationBatches", "DomainName", "ActiveTrustedSigners", "DistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" }, "ARN":{ "shape":"string", "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" }, "Status":{ "shape":"string", "documentation":"

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"

The date and time the distribution was last modified.

" }, "InProgressInvalidationBatches":{ "shape":"integer", "documentation":"

The number of invalidation batches currently in progress.

" }, "DomainName":{ "shape":"string", "documentation":"

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

" }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"

CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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.

" }, "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"

The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.

" } }, "documentation":"

The distribution's information.

" }, "DistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The caller reference you attempted to create the distribution with is associated with another distribution.

", "error":{"httpStatusCode":409}, "exception":true }, "DistributionConfig":{ "type":"structure", "required":[ "CallerReference", "Origins", "DefaultCacheBehavior", "Comment", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value you already sent in a previous request to create a distribution, and if the content of the DistributionConfig is identical to the original request (ignoring white space), CloudFront returns the same the response that it returned to the original request.

If 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, CloudFront returns a DistributionAlreadyExists error.

" }, "Aliases":{ "shape":"Aliases", "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" }, "DefaultRootObject":{ "shape":"string", "documentation":"

The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

Specify only the object name, for example, index.html. Do not add a / before the object name.

If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

To replace the default root object, update the distribution configuration and specify the new object.

For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

" }, "Origins":{ "shape":"Origins", "documentation":"

A complex type that contains information about origins for this distribution.

" }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"

A complex type that controls the following:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" }, "Comment":{ "shape":"string", "documentation":"

Any comments you want to include about the distribution.

If you don't want to specify a comment, include an empty Comment element.

To delete an existing comment, update the distribution configuration and include an empty Comment element.

To add or change a comment, update the distribution configuration and specify the new comment.

" }, "Logging":{ "shape":"LoggingConfig", "documentation":"

A complex type that controls whether access logs are written for the distribution.

For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.

" }, "PriceClass":{ "shape":"PriceClass", "documentation":"

The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes map to CloudFront regions, see Amazon CloudFront Pricing.

" }, "Enabled":{ "shape":"boolean", "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket.

If you do not want to enable logging when you create a distribution, or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements.

If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

" }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.

AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide.

" }, "HttpVersion":{ "shape":"HttpVersion", "documentation":"

(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.

For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for \"http/2 optimization.\"

" }, "IsIPV6Enabled":{ "shape":"boolean", "documentation":"

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, do not enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:

  • You enable IPv6 for the distribution

  • You're using alternate domain names in the URLs for your objects

For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 Developer Guide.

If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

" } }, "documentation":"

A distribution configuration.

" }, "DistributionConfigWithTags":{ "type":"structure", "required":[ "DistributionConfig", "Tags" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"

A distribution configuration.

" }, "Tags":{ "shape":"Tags", "documentation":"

A complex type that contains zero or more Tag elements.

" } }, "documentation":"

A distribution Configuration and a list of tags to be associated with the distribution.

" }, "DistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"

The value you provided for the Marker request parameter.

" }, "NextMarker":{ "shape":"string", "documentation":"

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.

" }, "MaxItems":{ "shape":"integer", "documentation":"

The value you provided for the MaxItems request parameter.

" }, "IsTruncated":{ "shape":"boolean", "documentation":"

A flag that indicates whether more distributions remain to be listed. 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.

" }, "Quantity":{ "shape":"integer", "documentation":"

The number of distributions that were created by the current AWS account.

" }, "Items":{ "shape":"DistributionSummaryList", "documentation":"

A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account.

" } }, "documentation":"

A distribution list.

" }, "DistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "DistributionSummary":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "DomainName", "Aliases", "Origins", "DefaultCacheBehavior", "CacheBehaviors", "CustomErrorResponses", "Comment", "PriceClass", "Enabled", "ViewerCertificate", "Restrictions", "WebACLId", "HttpVersion", "IsIPV6Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" }, "ARN":{ "shape":"string", "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" }, "Status":{ "shape":"string", "documentation":"

The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"

The date and time the distribution was last modified.

" }, "DomainName":{ "shape":"string", "documentation":"

The domain name that corresponds to the distribution. For example: d604721fxaaqy9.cloudfront.net.

" }, "Aliases":{ "shape":"Aliases", "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" }, "Origins":{ "shape":"Origins", "documentation":"

A complex type that contains information about origins for this distribution.

" }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"

A complex type that contains zero or more CustomErrorResponses elements.

" }, "Comment":{ "shape":"string", "documentation":"

The comment originally specified when this distribution was created.

" }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"

Whether the distribution is enabled to accept user requests for content.

" }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"

The Web ACL Id (if any) associated with the distribution.

" }, "HttpVersion":{ "shape":"HttpVersion", "documentation":"

Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.

" }, "IsIPV6Enabled":{ "shape":"boolean", "documentation":"

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

" } }, "documentation":"

A summary of the information about a CloudFront distribution.

" }, "DistributionSummaryList":{ "type":"list", "member":{ "shape":"DistributionSummary", "locationName":"DistributionSummary" } }, "ForwardedValues":{ "type":"structure", "required":[ "QueryString", "Cookies" ], "members":{ "QueryString":{ "shape":"boolean", "documentation":"

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

" }, "Cookies":{ "shape":"CookiePreference", "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" }, "Headers":{ "shape":"Headers", "documentation":"

A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior.

" }, "QueryStringCacheKeys":{ "shape":"QueryStringCacheKeys", "documentation":"

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

" } }, "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" }, "GeoRestriction":{ "type":"structure", "required":[ "RestrictionType", "Quantity" ], "members":{ "RestrictionType":{ "shape":"GeoRestrictionType", "documentation":"

The method that you want to use to restrict distribution of your content by country:

  • none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.

  • blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content.

  • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

" }, "Quantity":{ "shape":"integer", "documentation":"

When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.

" }, "Items":{ "shape":"LocationList", "documentation":"

A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes.

" } }, "documentation":"

A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.

" }, "GeoRestrictionType":{ "type":"string", "enum":[ "blacklist", "whitelist", "none" ] }, "GetCloudFrontOriginAccessIdentityConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The identity's ID.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfigComplexType.

" }, "GetCloudFrontOriginAccessIdentityConfigResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"

The origin access identity's configuration information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"CloudFrontOriginAccessIdentityConfig" }, "GetCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The identity's ID.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The request to get an origin access identity's information.

" }, "GetCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"

The origin access identity's information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"CloudFrontOriginAccessIdentity" }, "GetDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The distribution's ID.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The request to get a distribution configuration.

" }, "GetDistributionConfigResult":{ "type":"structure", "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"

The distribution's configuration information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"DistributionConfig" }, "GetDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The distribution's ID.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The request to get a distribution's information.

" }, "GetDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"

The distribution's information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the distribution's information. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"Distribution" }, "GetInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "Id" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"

The distribution's ID.

", "location":"uri", "locationName":"DistributionId" }, "Id":{ "shape":"string", "documentation":"

The identifier for the invalidation request, for example, IDFDVBD632BHDS5.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The request to get an invalidation's information.

" }, "GetInvalidationResult":{ "type":"structure", "members":{ "Invalidation":{ "shape":"Invalidation", "documentation":"

The invalidation's information. For more information, see Invalidation Complex Type.

" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"Invalidation" }, "GetStreamingDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The streaming distribution's ID.

", "location":"uri", "locationName":"Id" } }, "documentation":"

To request to get a streaming distribution configuration.

" }, "GetStreamingDistributionConfigResult":{ "type":"structure", "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"

The streaming distribution's configuration information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"StreamingDistributionConfig" }, "GetStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"

The streaming distribution's ID.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The request to get a streaming distribution's information.

" }, "GetStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"

The streaming distribution's information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"StreamingDistribution" }, "HeaderList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "Headers":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of different headers that you want CloudFront to forward to the origin for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

    If you configure CloudFront to forward all headers to your origin, CloudFront doesn't cache the objects associated with this cache behavior. Instead, it sends every request to the origin.

  • Forward a whitelist of headers you specify: Specify the number of headers that you want to forward, and specify the header names in Name elements. CloudFront caches your objects based on the values in all of the specified headers. CloudFront also forwards the headers that it forwards by default, but it caches your objects based only on the headers that you specify.

  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

" }, "Items":{ "shape":"HeaderList", "documentation":"

A complex type that contains one Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items.

" } }, "documentation":"

A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior.

For the headers that you specify, CloudFront also caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to cache your content based on values in the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see How CloudFront Forwards and Caches Headers in the Amazon CloudFront Developer Guide.

" }, "HttpVersion":{ "type":"string", "enum":[ "http1.1", "http2" ] }, "IllegalUpdate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Origin and CallerReference cannot be updated.

", "error":{"httpStatusCode":400}, "exception":true }, "InconsistentQuantities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The value of Quantity and the size of Items do not match.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidArgument":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The argument is invalid.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidDefaultRootObject":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The default root object file name is too big or contains an invalid character.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidErrorCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidForwardCookies":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidGeoRestrictionParameter":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidHeadersForS3Origin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidIfMatchVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The If-Match version is missing or not valid for the distribution.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidLocationCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidMinimumProtocolVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The origin access identity is not valid or doesn't exist.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidProtocolSettings":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidQueryStringParameters":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidRelativePath":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The relative path is too big, is not URL-encoded, or does not begin with a slash (/).

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRequiredProtocol":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

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.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidResponseCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidTTLOrder":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidTagging":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidViewerCertificate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidWebACLId":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "Invalidation":{ "type":"structure", "required":[ "Id", "Status", "CreateTime", "InvalidationBatch" ], "members":{ "Id":{ "shape":"string", "documentation":"

The identifier for the invalidation request. For example: IDFDVBD632BHDS5.

" }, "Status":{ "shape":"string", "documentation":"

The status of the invalidation request. When the invalidation batch is finished, the status is Completed.

" }, "CreateTime":{ "shape":"timestamp", "documentation":"

The date and time the invalidation request was first made.

" }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"

The current invalidation information for the batch request.

" } }, "documentation":"

An invalidation.

" }, "InvalidationBatch":{ "type":"structure", "required":[ "Paths", "CallerReference" ], "members":{ "Paths":{ "shape":"Paths", "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" }, "CallerReference":{ "shape":"string", "documentation":"

A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp, for example, 20120301090000.

If you make a second invalidation request with the same value for CallerReference, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference.

If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.

" } }, "documentation":"

An invalidation batch.

" }, "InvalidationList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"

The value that you provided for the Marker request parameter.

" }, "NextMarker":{ "shape":"string", "documentation":"

If IsTruncated is true, this element is present and contains the value that you can use for the Marker request parameter to continue listing your invalidation batches where they left off.

" }, "MaxItems":{ "shape":"integer", "documentation":"

The value that you provided for the MaxItems request parameter.

" }, "IsTruncated":{ "shape":"boolean", "documentation":"

A flag that indicates whether more invalidation batch requests remain to be listed. 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.

" }, "Quantity":{ "shape":"integer", "documentation":"

The number of invalidation batches that were created by the current AWS account.

" }, "Items":{ "shape":"InvalidationSummaryList", "documentation":"

A complex type that contains one InvalidationSummary element for each invalidation batch created by the current AWS account.

" } }, "documentation":"

The InvalidationList complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.

" }, "InvalidationSummary":{ "type":"structure", "required":[ "Id", "CreateTime", "Status" ], "members":{ "Id":{ "shape":"string", "documentation":"

The unique ID for an invalidation request.

" }, "CreateTime":{"shape":"timestamp"}, "Status":{ "shape":"string", "documentation":"

The status of an invalidation request.

" } }, "documentation":"

A summary of an invalidation request.

" }, "InvalidationSummaryList":{ "type":"list", "member":{ "shape":"InvalidationSummary", "locationName":"InvalidationSummary" } }, "ItemSelection":{ "type":"string", "enum":[ "none", "whitelist", "all" ] }, "KeyPairIdList":{ "type":"list", "member":{ "shape":"string", "locationName":"KeyPairId" } }, "KeyPairIds":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of active CloudFront key pairs for AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" }, "Items":{ "shape":"KeyPairIdList", "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" } }, "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" }, "ListCloudFrontOriginAccessIdentitiesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"

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. 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).

", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"

The maximum number of origin access identities you want in the response body.

", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"

The request to list origin access identities.

" }, "ListCloudFrontOriginAccessIdentitiesResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityList":{ "shape":"CloudFrontOriginAccessIdentityList", "documentation":"

The CloudFrontOriginAccessIdentityList type.

" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"CloudFrontOriginAccessIdentityList" }, "ListDistributionsByWebACLIdRequest":{ "type":"structure", "required":["WebACLId"], "members":{ "Marker":{ "shape":"string", "documentation":"

Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)

", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"

The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.

", "location":"querystring", "locationName":"MaxItems" }, "WebACLId":{ "shape":"string", "documentation":"

The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify \"null\" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.

", "location":"uri", "locationName":"WebACLId" } }, "documentation":"

The request to list distributions that are associated with a specified AWS WAF web ACL.

" }, "ListDistributionsByWebACLIdResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"

The DistributionList type.

" } }, "documentation":"

The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.

", "payload":"DistributionList" }, "ListDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"

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. 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).

", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"

The maximum number of distributions you want in the response body.

", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"

The request to list your distributions.

" }, "ListDistributionsResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"

The DistributionList type.

" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"DistributionList" }, "ListInvalidationsRequest":{ "type":"structure", "required":["DistributionId"], "members":{ "DistributionId":{ "shape":"string", "documentation":"

The distribution's ID.

", "location":"uri", "locationName":"DistributionId" }, "Marker":{ "shape":"string", "documentation":"

Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. 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. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.

", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"

The maximum number of invalidation batches that you want in the response body.

", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"

The request to list invalidations.

" }, "ListInvalidationsResult":{ "type":"structure", "members":{ "InvalidationList":{ "shape":"InvalidationList", "documentation":"

Information about invalidation batches.

" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"InvalidationList" }, "ListStreamingDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"

The value that you provided for the Marker request parameter.

", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"

The value that you provided for the MaxItems request parameter.

", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"

The request to list your streaming distributions.

" }, "ListStreamingDistributionsResult":{ "type":"structure", "members":{ "StreamingDistributionList":{ "shape":"StreamingDistributionList", "documentation":"

The StreamingDistributionList type.

" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"StreamingDistributionList" }, "ListTagsForResourceRequest":{ "type":"structure", "required":["Resource"], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"

An ARN of a CloudFront resource.

", "location":"querystring", "locationName":"Resource" } }, "documentation":"

The request to list tags for a CloudFront resource.

" }, "ListTagsForResourceResult":{ "type":"structure", "required":["Tags"], "members":{ "Tags":{ "shape":"Tags", "documentation":"

A complex type that contains zero or more Tag elements.

" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"Tags" }, "LocationList":{ "type":"list", "member":{ "shape":"string", "locationName":"Location" } }, "LoggingConfig":{ "type":"structure", "required":[ "Enabled", "IncludeCookies", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.

" }, "IncludeCookies":{ "shape":"boolean", "documentation":"

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.

" }, "Bucket":{ "shape":"string", "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" }, "Prefix":{ "shape":"string", "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" } }, "documentation":"

A complex type that controls whether access logs are written for the distribution.

" }, "Method":{ "type":"string", "enum":[ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ] }, "MethodsList":{ "type":"list", "member":{ "shape":"Method", "locationName":"Method" } }, "MinimumProtocolVersion":{ "type":"string", "enum":[ "SSLv3", "TLSv1" ] }, "MissingBody":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

", "error":{"httpStatusCode":400}, "exception":true }, "NoSuchCloudFrontOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The specified origin access identity does not exist.

", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The specified distribution does not exist.

", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchInvalidation":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The specified invalidation does not exist.

", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

No origin exists with the specified Origin Id.

", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchResource":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true }, "NoSuchStreamingDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The specified streaming distribution does not exist.

", "error":{"httpStatusCode":404}, "exception":true }, "Origin":{ "type":"structure", "required":[ "Id", "DomainName" ], "members":{ "Id":{ "shape":"string", "documentation":"

A unique identifier for the origin. The value of Id must be unique within the distribution.

When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

" }, "DomainName":{ "shape":"string", "documentation":"

Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com.

Constraints for Amazon S3 origins:

  • If you configured Amazon S3 Transfer Acceleration for your bucket, do not specify the s3-accelerate endpoint for DomainName.

  • The bucket name must be between 3 and 63 characters long (inclusive).

  • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

  • The bucket name must not contain adjacent periods.

Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

Constraints for custom origins:

  • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

  • The name cannot exceed 128 characters.

" }, "OriginPath":{ "shape":"string", "documentation":"

An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName, for example, example.com/production. Do not include a / at the end of the directory name.

For example, suppose you've specified the following values for your distribution:

  • DomainName: An Amazon S3 bucket named myawsbucket.

  • OriginPath: /production

  • CNAME: example.com

When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

" }, "CustomHeaders":{ "shape":"CustomHeaders", "documentation":"

A complex type that contains names and values for the custom headers that you want.

" }, "S3OriginConfig":{ "shape":"S3OriginConfig", "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" }, "CustomOriginConfig":{ "shape":"CustomOriginConfig", "documentation":"

A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead.

" } }, "documentation":"

A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files. You must create at least one origin.

For the current limit on the number of origins that you can create for a distribution, see Amazon CloudFront Limits in the AWS General Reference.

" }, "OriginCustomHeader":{ "type":"structure", "required":[ "HeaderName", "HeaderValue" ], "members":{ "HeaderName":{ "shape":"string", "documentation":"

The name of a header that you want CloudFront to forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

" }, "HeaderValue":{ "shape":"string", "documentation":"

The value for the header that you specified in the HeaderName field.

" } }, "documentation":"

A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.

" }, "OriginCustomHeadersList":{ "type":"list", "member":{ "shape":"OriginCustomHeader", "locationName":"OriginCustomHeader" } }, "OriginList":{ "type":"list", "member":{ "shape":"Origin", "locationName":"Origin" }, "min":1 }, "OriginProtocolPolicy":{ "type":"string", "enum":[ "http-only", "match-viewer", "https-only" ] }, "OriginSslProtocols":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

" }, "Items":{ "shape":"SslProtocolsList", "documentation":"

A list that contains allowed SSL/TLS protocols for this distribution.

" } }, "documentation":"

A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

" }, "Origins":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of origins for this distribution.

" }, "Items":{ "shape":"OriginList", "documentation":"

A complex type that contains origins for this distribution.

" } }, "documentation":"

A complex type that contains information about origins for this distribution.

" }, "PathList":{ "type":"list", "member":{ "shape":"string", "locationName":"Path" } }, "Paths":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of objects that you want to invalidate.

" }, "Items":{ "shape":"PathList", "documentation":"

A complex type that contains a list of the paths that you want to invalidate.

" } }, "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" }, "PreconditionFailed":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

The precondition given in one or more of the request-header fields evaluated to false.

", "error":{"httpStatusCode":412}, "exception":true }, "PriceClass":{ "type":"string", "enum":[ "PriceClass_100", "PriceClass_200", "PriceClass_All" ] }, "QueryStringCacheKeys":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"

The number of whitelisted query string parameters for this cache behavior.

" }, "Items":{ "shape":"QueryStringCacheKeysList", "documentation":"

(Optional) A list that contains the query string parameters that you want CloudFront to use as a basis for caching for this cache behavior. If Quantity is 0, you can omit Items.

" } } }, "QueryStringCacheKeysList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "ResourceARN":{ "type":"string", "pattern":"arn:aws:cloudfront::[0-9]+:.*" }, "Restrictions":{ "type":"structure", "required":["GeoRestriction"], "members":{ "GeoRestriction":{"shape":"GeoRestriction"} }, "documentation":"

A complex type that identifies ways in which you want to restrict distribution of your content.

" }, "S3Origin":{ "type":"structure", "required":[ "DomainName", "OriginAccessIdentity" ], "members":{ "DomainName":{ "shape":"string", "documentation":"

The DNS name of the Amazon S3 origin.

" }, "OriginAccessIdentity":{ "shape":"string", "documentation":"

The CloudFront origin access identity to associate with the RTMP distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.

If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon Amazon CloudFront Developer Guide.

" } }, "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" }, "S3OriginConfig":{ "type":"structure", "required":["OriginAccessIdentity"], "members":{ "OriginAccessIdentity":{ "shape":"string", "documentation":"

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/CloudFront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" } }, "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" }, "SSLSupportMethod":{ "type":"string", "enum":[ "sni-only", "vip" ] }, "Signer":{ "type":"structure", "members":{ "AwsAccountNumber":{ "shape":"string", "documentation":"

An AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid values include:

  • self, which is the AWS account used to create the distribution.

  • An AWS account number.

" }, "KeyPairIds":{ "shape":"KeyPairIds", "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

" } }, "documentation":"

A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any.

" }, "SignerList":{ "type":"list", "member":{ "shape":"Signer", "locationName":"Signer" } }, "SslProtocol":{ "type":"string", "enum":[ "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2" ] }, "SslProtocolsList":{ "type":"list", "member":{ "shape":"SslProtocol", "locationName":"SslProtocol" } }, "StreamingDistribution":{ "type":"structure", "required":[ "Id", "ARN", "Status", "DomainName", "ActiveTrustedSigners", "StreamingDistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"

The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.

" }, "ARN":{"shape":"string"}, "Status":{ "shape":"string", "documentation":"

The current status of the RTMP distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"

The date and time that the distribution was last modified.

" }, "DomainName":{ "shape":"string", "documentation":"

The domain name that corresponds to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net.

" }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" }, "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"

The current configuration information for the RTMP distribution.

" } }, "documentation":"

A streaming distribution.

" }, "StreamingDistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionConfig":{ "type":"structure", "required":[ "CallerReference", "S3Origin", "Comment", "TrustedSigners", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"

A unique number that ensures that the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value that 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), the response includes the same information returned to the original request. If the CallerReference is a value that you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

" }, "S3Origin":{ "shape":"S3Origin", "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" }, "Aliases":{ "shape":"Aliases", "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" }, "Comment":{ "shape":"string", "documentation":"

Any comments you want to include about the streaming distribution.

" }, "Logging":{ "shape":"StreamingLoggingConfig", "documentation":"

A complex type that controls whether access logs are written for the streaming distribution.

" }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"

A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" }, "PriceClass":{ "shape":"PriceClass", "documentation":"

A complex type that contains information about price class for this streaming distribution.

" }, "Enabled":{ "shape":"boolean", "documentation":"

Whether the streaming distribution is enabled to accept user requests for content.

" } }, "documentation":"

The RTMP distribution's configuration information.

" }, "StreamingDistributionConfigWithTags":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Tags" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"

A streaming distribution Configuration.

" }, "Tags":{ "shape":"Tags", "documentation":"

A complex type that contains zero or more Tag elements.

" } }, "documentation":"

A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.

" }, "StreamingDistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"

The value you provided for the Marker request parameter.

" }, "NextMarker":{ "shape":"string", "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP distributions where they left off.

" }, "MaxItems":{ "shape":"integer", "documentation":"

The value you provided for the MaxItems request parameter.

" }, "IsTruncated":{ "shape":"boolean", "documentation":"

A flag that indicates whether more streaming distributions remain to be listed. 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.

" }, "Quantity":{ "shape":"integer", "documentation":"

The number of streaming distributions that were created by the current AWS account.

" }, "Items":{ "shape":"StreamingDistributionSummaryList", "documentation":"

A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.

" } }, "documentation":"

A streaming distribution list.

" }, "StreamingDistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionSummary":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "DomainName", "S3Origin", "Aliases", "TrustedSigners", "Comment", "PriceClass", "Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" }, "ARN":{ "shape":"string", "documentation":"

The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" }, "Status":{ "shape":"string", "documentation":"

Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

" }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"

The date and time the distribution was last modified.

" }, "DomainName":{ "shape":"string", "documentation":"

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

" }, "S3Origin":{ "shape":"S3Origin", "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" }, "Aliases":{ "shape":"Aliases", "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items.If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" }, "Comment":{ "shape":"string", "documentation":"

The comment originally specified when this distribution was created.

" }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"

Whether the distribution is enabled to accept end user requests for content.

" } }, "documentation":"

A summary of the information for an Amazon CloudFront streaming distribution.

" }, "StreamingDistributionSummaryList":{ "type":"list", "member":{ "shape":"StreamingDistributionSummary", "locationName":"StreamingDistributionSummary" } }, "StreamingLoggingConfig":{ "type":"structure", "required":[ "Enabled", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

" }, "Bucket":{ "shape":"string", "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" }, "Prefix":{ "shape":"string", "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" } }, "documentation":"

A complex type that controls whether access logs are written for this streaming distribution.

" }, "Tag":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"TagKey", "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" }, "Value":{ "shape":"TagValue", "documentation":"

A string that contains an optional Tag value.

The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" } }, "documentation":"

A complex type that contains Tag key and Tag value.

" }, "TagKey":{ "type":"string", "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeyList":{ "type":"list", "member":{ "shape":"TagKey", "locationName":"Key" } }, "TagKeys":{ "type":"structure", "members":{ "Items":{ "shape":"TagKeyList", "documentation":"

A complex type that contains Tag key elements.

" } }, "documentation":"

A complex type that contains zero or more Tag elements.

" }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"Tag" } }, "TagResourceRequest":{ "type":"structure", "required":[ "Resource", "Tags" ], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"

An ARN of a CloudFront resource.

", "location":"querystring", "locationName":"Resource" }, "Tags":{ "shape":"Tags", "documentation":"

A complex type that contains zero or more Tag elements.

", "locationName":"Tags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} } }, "documentation":"

The request to add tags to a CloudFront resource.

", "payload":"Tags" }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Tags":{ "type":"structure", "members":{ "Items":{ "shape":"TagList", "documentation":"

A complex type that contains Tag elements.

" } }, "documentation":"

A complex type that contains zero or more Tag elements.

" }, "TooManyCacheBehaviors":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

You cannot create more cache behaviors for the distribution.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCertificates":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

You cannot create anymore custom SSL/TLS certificates.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCloudFrontOriginAccessIdentities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Processing your request would cause you to exceed the maximum number of origin access identities allowed.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCookieNamesInWhiteList":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Your request contains more cookie names in the whitelist than are allowed per cache behavior.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Your request contains more CNAMEs than are allowed per distribution.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Processing your request would cause you to exceed the maximum number of distributions allowed.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyHeadersInForwardedValues":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyInvalidationsInProgress":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyOriginCustomHeaders":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyOrigins":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

You cannot create more origins for the distribution.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyQueryStringParameters":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Processing your request would cause you to exceed the maximum number of streaming distributions allowed.

", "error":{"httpStatusCode":400}, "exception":true }, "TooManyTrustedSigners":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

Your request contains more trusted signers than are allowed per distribution.

", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSignerDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"

One or more of your trusted signers do not exist.

", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"

Specifies whether you want to require viewers to use signed URLs to access the files specified by PathPattern and TargetOriginId.

" }, "Quantity":{ "shape":"integer", "documentation":"

The number of trusted signers for this cache behavior.

" }, "Items":{ "shape":"AwsAccountNumberList", "documentation":"

Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.

" } }, "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

For more information about updating the distribution configuration, see DistributionConfig .

" }, "UntagResourceRequest":{ "type":"structure", "required":[ "Resource", "TagKeys" ], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"

An ARN of a CloudFront resource.

", "location":"querystring", "locationName":"Resource" }, "TagKeys":{ "shape":"TagKeys", "documentation":"

A complex type that contains zero or more Tag key elements.

", "locationName":"TagKeys", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} } }, "documentation":"

The request to remove tags from a CloudFront resource.

", "payload":"TagKeys" }, "UpdateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":[ "CloudFrontOriginAccessIdentityConfig", "Id" ], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"

The identity's configuration information.

", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} }, "Id":{ "shape":"string", "documentation":"

The identity's id.

", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"

The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"If-Match" } }, "documentation":"

The request to update an origin access identity.

", "payload":"CloudFrontOriginAccessIdentityConfig" }, "UpdateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"

The origin access identity's information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"CloudFrontOriginAccessIdentity" }, "UpdateDistributionRequest":{ "type":"structure", "required":[ "DistributionConfig", "Id" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"

The distribution's configuration information.

", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} }, "Id":{ "shape":"string", "documentation":"

The distribution's id.

", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"

The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"If-Match" } }, "documentation":"

The request to update a distribution.

", "payload":"DistributionConfig" }, "UpdateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"

The distribution's information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"Distribution" }, "UpdateStreamingDistributionRequest":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Id" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"

The streaming distribution's configuration information.

", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} }, "Id":{ "shape":"string", "documentation":"

The streaming distribution's id.

", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"

The value of the ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"If-Match" } }, "documentation":"

The request to update a streaming distribution.

", "payload":"StreamingDistributionConfig" }, "UpdateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"

The streaming distribution's information.

" }, "ETag":{ "shape":"string", "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", "location":"header", "locationName":"ETag" } }, "documentation":"

The returned result of the corresponding request.

", "payload":"StreamingDistribution" }, "ViewerCertificate":{ "type":"structure", "members":{ "CloudFrontDefaultCertificate":{ "shape":"boolean", "documentation":"

If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an ACMCertificateArn or IAMCertificateId.

" }, "IAMCertificateId":{ "shape":"string", "documentation":"

If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value, ACMCertificateArn, or CloudFrontDefaultCertificate.

" }, "ACMCertificateArn":{ "shape":"string", "documentation":"

If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the ACM certificate ARN of the custom viewer certificate for this distribution. Specify either this value, IAMCertificateId, or CloudFrontDefaultCertificate.

" }, "SSLSupportMethod":{ "shape":"SSLSupportMethod", "documentation":"

If you specify a value for ACMCertificateArn or for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:

  • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges.

  • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:

    • Use the vip option (dedicated IP addresses) instead of sni-only.

    • Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.

    • If you can control which browser your users use, upgrade the browser to one that supports SNI.

    • Use HTTP instead of HTTPS.

Do not specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

" }, "MinimumProtocolVersion":{ "shape":"MinimumProtocolVersion", "documentation":"

Specify the minimum version of the SSL/TLS protocol that you want CloudFront to use for HTTPS connections between viewers and CloudFront: SSLv3 or TLSv1. CloudFront serves your objects only to viewers that support SSL/TLS version that you specify and later versions. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. Note the following:

  • If you specify <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>, the minimum SSL protocol version is TLSv1 and can't be changed.

  • If you're using a custom certificate (if you specify a value for ACMCertificateArn or for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion.

" }, "Certificate":{ "shape":"string", "documentation":"

Include one of these values to specify the following:

  • Whether you want viewers to use HTTP or HTTPS to request your objects.

  • If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net.

  • If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.

You must specify one (and only one) of the three values. Do not specify false for CloudFrontDefaultCertificate.

If you want viewers to use HTTP to request your objects: Specify the following value:

<CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

In addition, specify allow-all for ViewerProtocolPolicy for all of your cache behaviors.

If you want viewers to use HTTPS to request your objects: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:

  • If you're using an alternate domain name, such as example.com: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:

    • <ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.

    • <IAMCertificateId>IAM certificate ID<IAMCertificateId> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.

    If you specify ACMCertificateArn or IAMCertificateId, you must also specify a value for SSLSupportMethod.

    If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (https://example.com/logo.jpg). If you use the domain name that is associated with your CloudFront distribution (https://d111111abcdef8.cloudfront.net/logo.jpg) and the viewer supports SNI, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for SSLSupportMethod:

    • vip: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.

    • sni-only: CloudFront drops the connection with the browser without returning the object.

  • If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net : Specify the following value:

    <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

    If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:

    • <ViewerProtocolPolicy>https-only<ViewerProtocolPolicy>

    • <ViewerProtocolPolicy>redirect-to-https<ViewerProtocolPolicy>

    You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:

    • <OriginProtocolPolicy>https-only<OriginProtocolPolicy>

    • <OriginProtocolPolicy>match-viewer<OriginProtocolPolicy>

    For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

", "deprecated":true }, "CertificateSource":{ "shape":"CertificateSource", "documentation":"

This field is deprecated. You can use one of the following: [ACMCertificateArn, IAMCertificateId, or CloudFrontDefaultCertificate].

", "deprecated":true } }, "documentation":"

A complex type that specifies the following:

  • Which SSL/TLS certificate to use when viewers request objects using HTTPS

  • Whether you want CloudFront to use dedicated IP addresses or SNI when you're using alternate domain names in your object names

  • The minimum protocol version that you want CloudFront to use when communicating with viewers

For more information, see Using an HTTPS Connection to Access Your Objects in the Amazon Amazon CloudFront Developer Guide.

" }, "ViewerProtocolPolicy":{ "type":"string", "enum":[ "allow-all", "https-only", "redirect-to-https" ] }, "boolean":{"type":"boolean"}, "integer":{"type":"integer"}, "long":{"type":"long"}, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} }, "documentation":"Amazon CloudFront

This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about the CloudFront API actions, data types, and errors. For detailed information about CloudFront features and their associated API calls, see the Amazon CloudFront Developer Guide.

" } botocore-1.5.7/botocore/data/cloudfront/2016-08-20/0000777454262600001440000000000013042511307022346 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudfront/2016-08-20/waiters-2.json0000666454262600001440000000224013042511306025053 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DistributionDeployed": { "delay": 60, "operation": "GetDistribution", "maxAttempts": 25, "description": "Wait until a distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "Distribution.Status" } ] }, "InvalidationCompleted": { "delay": 20, "operation": "GetInvalidation", "maxAttempts": 60, "description": "Wait until an invalidation has completed.", "acceptors": [ { "expected": "Completed", "matcher": "path", "state": "success", "argument": "Invalidation.Status" } ] }, "StreamingDistributionDeployed": { "delay": 60, "operation": "GetStreamingDistribution", "maxAttempts": 25, "description": "Wait until a streaming distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "StreamingDistribution.Status" } ] } } } botocore-1.5.7/botocore/data/cloudfront/2016-08-20/paginators-1.json0000666454262600001440000000214613042511306025550 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListCloudFrontOriginAccessIdentities": { "input_token": "Marker", "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", "limit_key": "MaxItems", "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", "result_key": "CloudFrontOriginAccessIdentityList.Items" }, "ListDistributions": { "input_token": "Marker", "output_token": "DistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "DistributionList.IsTruncated", "result_key": "DistributionList.Items" }, "ListInvalidations": { "input_token": "Marker", "output_token": "InvalidationList.NextMarker", "limit_key": "MaxItems", "more_results": "InvalidationList.IsTruncated", "result_key": "InvalidationList.Items" }, "ListStreamingDistributions": { "input_token": "Marker", "output_token": "StreamingDistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "StreamingDistributionList.IsTruncated", "result_key": "StreamingDistributionList.Items" } } } botocore-1.5.7/botocore/data/cloudfront/2016-08-20/service-2.json0000666454262600001440000044665013042511306025056 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-08-20", "endpointPrefix":"cloudfront", "globalEndpoint":"cloudfront.amazonaws.com", "protocol":"rest-xml", "serviceAbbreviation":"CloudFront", "serviceFullName":"Amazon CloudFront", "signatureVersion":"v4" }, "operations":{ "CreateCloudFrontOriginAccessIdentity":{ "name":"CreateCloudFrontOriginAccessIdentity2016_08_20", "http":{ "method":"POST", "requestUri":"/2016-08-20/origin-access-identity/cloudfront", "responseCode":201 }, "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, {"shape":"MissingBody"}, {"shape":"TooManyCloudFrontOriginAccessIdentities"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new origin access identity." }, "CreateDistribution":{ "name":"CreateDistribution2016_08_20", "http":{ "method":"POST", "requestUri":"/2016-08-20/distribution", "responseCode":201 }, "input":{"shape":"CreateDistributionRequest"}, "output":{"shape":"CreateDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"DistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"MissingBody"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"TooManyDistributions"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidProtocolSettings"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"}, {"shape":"TooManyQueryStringParameters"}, {"shape":"InvalidQueryStringParameters"} ], "documentation":"Create a new distribution." }, "CreateDistributionWithTags":{ "name":"CreateDistributionWithTags2016_08_20", "http":{ "method":"POST", "requestUri":"/2016-08-20/distribution?WithTags", "responseCode":201 }, "input":{"shape":"CreateDistributionWithTagsRequest"}, "output":{"shape":"CreateDistributionWithTagsResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"DistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"MissingBody"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"TooManyDistributions"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidProtocolSettings"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"}, {"shape":"InvalidTagging"}, {"shape":"TooManyQueryStringParameters"}, {"shape":"InvalidQueryStringParameters"} ], "documentation":"Create a new distribution with tags." }, "CreateInvalidation":{ "name":"CreateInvalidation2016_08_20", "http":{ "method":"POST", "requestUri":"/2016-08-20/distribution/{DistributionId}/invalidation", "responseCode":201 }, "input":{"shape":"CreateInvalidationRequest"}, "output":{"shape":"CreateInvalidationResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"MissingBody"}, {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"BatchTooLarge"}, {"shape":"TooManyInvalidationsInProgress"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new invalidation." }, "CreateStreamingDistribution":{ "name":"CreateStreamingDistribution2016_08_20", "http":{ "method":"POST", "requestUri":"/2016-08-20/streaming-distribution", "responseCode":201 }, "input":{"shape":"CreateStreamingDistributionRequest"}, "output":{"shape":"CreateStreamingDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"StreamingDistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"MissingBody"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"TooManyStreamingDistributions"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new streaming distribution." }, "CreateStreamingDistributionWithTags":{ "name":"CreateStreamingDistributionWithTags2016_08_20", "http":{ "method":"POST", "requestUri":"/2016-08-20/streaming-distribution?WithTags", "responseCode":201 }, "input":{"shape":"CreateStreamingDistributionWithTagsRequest"}, "output":{"shape":"CreateStreamingDistributionWithTagsResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"StreamingDistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"MissingBody"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"TooManyStreamingDistributions"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"}, {"shape":"InvalidTagging"} ], "documentation":"Create a new streaming distribution with tags." }, "DeleteCloudFrontOriginAccessIdentity":{ "name":"DeleteCloudFrontOriginAccessIdentity2016_08_20", "http":{ "method":"DELETE", "requestUri":"/2016-08-20/origin-access-identity/cloudfront/{Id}", "responseCode":204 }, "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"PreconditionFailed"}, {"shape":"CloudFrontOriginAccessIdentityInUse"} ], "documentation":"Delete an origin access identity." }, "DeleteDistribution":{ "name":"DeleteDistribution2016_08_20", "http":{ "method":"DELETE", "requestUri":"/2016-08-20/distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"DistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"Delete a distribution." }, "DeleteStreamingDistribution":{ "name":"DeleteStreamingDistribution2016_08_20", "http":{ "method":"DELETE", "requestUri":"/2016-08-20/streaming-distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteStreamingDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"StreamingDistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"Delete a streaming distribution." }, "GetCloudFrontOriginAccessIdentity":{ "name":"GetCloudFrontOriginAccessIdentity2016_08_20", "http":{ "method":"GET", "requestUri":"/2016-08-20/origin-access-identity/cloudfront/{Id}" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about an origin access identity." }, "GetCloudFrontOriginAccessIdentityConfig":{ "name":"GetCloudFrontOriginAccessIdentityConfig2016_08_20", "http":{ "method":"GET", "requestUri":"/2016-08-20/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about an origin access identity." }, "GetDistribution":{ "name":"GetDistribution2016_08_20", "http":{ "method":"GET", "requestUri":"/2016-08-20/distribution/{Id}" }, "input":{"shape":"GetDistributionRequest"}, "output":{"shape":"GetDistributionResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about a distribution." }, "GetDistributionConfig":{ "name":"GetDistributionConfig2016_08_20", "http":{ "method":"GET", "requestUri":"/2016-08-20/distribution/{Id}/config" }, "input":{"shape":"GetDistributionConfigRequest"}, "output":{"shape":"GetDistributionConfigResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about a distribution." }, "GetInvalidation":{ "name":"GetInvalidation2016_08_20", "http":{ "method":"GET", "requestUri":"/2016-08-20/distribution/{DistributionId}/invalidation/{Id}" }, "input":{"shape":"GetInvalidationRequest"}, "output":{"shape":"GetInvalidationResult"}, "errors":[ {"shape":"NoSuchInvalidation"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about an invalidation." }, "GetStreamingDistribution":{ "name":"GetStreamingDistribution2016_08_20", "http":{ "method":"GET", "requestUri":"/2016-08-20/streaming-distribution/{Id}" }, "input":{"shape":"GetStreamingDistributionRequest"}, "output":{"shape":"GetStreamingDistributionResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about a streaming distribution." }, "GetStreamingDistributionConfig":{ "name":"GetStreamingDistributionConfig2016_08_20", "http":{ "method":"GET", "requestUri":"/2016-08-20/streaming-distribution/{Id}/config" }, "input":{"shape":"GetStreamingDistributionConfigRequest"}, "output":{"shape":"GetStreamingDistributionConfigResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about a streaming distribution." }, "ListCloudFrontOriginAccessIdentities":{ "name":"ListCloudFrontOriginAccessIdentities2016_08_20", "http":{ "method":"GET", "requestUri":"/2016-08-20/origin-access-identity/cloudfront" }, "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List origin access identities." }, "ListDistributions":{ "name":"ListDistributions2016_08_20", "http":{ "method":"GET", "requestUri":"/2016-08-20/distribution" }, "input":{"shape":"ListDistributionsRequest"}, "output":{"shape":"ListDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List distributions." }, "ListDistributionsByWebACLId":{ "name":"ListDistributionsByWebACLId2016_08_20", "http":{ "method":"GET", "requestUri":"/2016-08-20/distributionsByWebACLId/{WebACLId}" }, "input":{"shape":"ListDistributionsByWebACLIdRequest"}, "output":{"shape":"ListDistributionsByWebACLIdResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"InvalidWebACLId"} ], "documentation":"List the distributions that are associated with a specified AWS WAF web ACL." }, "ListInvalidations":{ "name":"ListInvalidations2016_08_20", "http":{ "method":"GET", "requestUri":"/2016-08-20/distribution/{DistributionId}/invalidation" }, "input":{"shape":"ListInvalidationsRequest"}, "output":{"shape":"ListInvalidationsResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"List invalidation batches." }, "ListStreamingDistributions":{ "name":"ListStreamingDistributions2016_08_20", "http":{ "method":"GET", "requestUri":"/2016-08-20/streaming-distribution" }, "input":{"shape":"ListStreamingDistributionsRequest"}, "output":{"shape":"ListStreamingDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List streaming distributions." }, "ListTagsForResource":{ "name":"ListTagsForResource2016_08_20", "http":{ "method":"GET", "requestUri":"/2016-08-20/tagging" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"List tags for a CloudFront resource." }, "TagResource":{ "name":"TagResource2016_08_20", "http":{ "method":"POST", "requestUri":"/2016-08-20/tagging?Operation=Tag", "responseCode":204 }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"Add tags to a CloudFront resource." }, "UntagResource":{ "name":"UntagResource2016_08_20", "http":{ "method":"POST", "requestUri":"/2016-08-20/tagging?Operation=Untag", "responseCode":204 }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"Remove tags from a CloudFront resource." }, "UpdateCloudFrontOriginAccessIdentity":{ "name":"UpdateCloudFrontOriginAccessIdentity2016_08_20", "http":{ "method":"PUT", "requestUri":"/2016-08-20/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"PreconditionFailed"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Update an origin access identity." }, "UpdateDistribution":{ "name":"UpdateDistribution2016_08_20", "http":{ "method":"PUT", "requestUri":"/2016-08-20/distribution/{Id}/config" }, "input":{"shape":"UpdateDistributionRequest"}, "output":{"shape":"UpdateDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"}, {"shape":"TooManyQueryStringParameters"}, {"shape":"InvalidQueryStringParameters"} ], "documentation":"Update a distribution." }, "UpdateStreamingDistribution":{ "name":"UpdateStreamingDistribution2016_08_20", "http":{ "method":"PUT", "requestUri":"/2016-08-20/streaming-distribution/{Id}/config" }, "input":{"shape":"UpdateStreamingDistributionRequest"}, "output":{"shape":"UpdateStreamingDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InconsistentQuantities"} ], "documentation":"Update a streaming distribution." } }, "shapes":{ "AccessDenied":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Access denied.", "error":{"httpStatusCode":403}, "exception":true }, "ActiveTrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Each active trusted signer." }, "Quantity":{ "shape":"integer", "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." }, "Items":{ "shape":"SignerList", "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." } }, "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." }, "AliasList":{ "type":"list", "member":{ "shape":"string", "locationName":"CNAME" } }, "Aliases":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of CNAMEs, if any, for this distribution." }, "Items":{ "shape":"AliasList", "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "AllowedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." }, "CachedMethods":{"shape":"CachedMethods"} }, "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." }, "AwsAccountNumberList":{ "type":"list", "member":{ "shape":"string", "locationName":"AwsAccountNumber" } }, "BatchTooLarge":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":413}, "exception":true }, "CNAMEAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CacheBehavior":{ "type":"structure", "required":[ "PathPattern", "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "PathPattern":{ "shape":"string", "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." }, "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "DefaultTTL":{ "shape":"long", "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "MaxTTL":{ "shape":"long", "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "Compress":{ "shape":"boolean", "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." } }, "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." }, "CacheBehaviorList":{ "type":"list", "member":{ "shape":"CacheBehavior", "locationName":"CacheBehavior" } }, "CacheBehaviors":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of cache behaviors for this distribution." }, "Items":{ "shape":"CacheBehaviorList", "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CachedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." } }, "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." }, "CertificateSource":{ "type":"string", "enum":[ "cloudfront", "iam", "acm" ] }, "CloudFrontOriginAccessIdentity":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The current configuration information for the identity." } }, "documentation":"CloudFront origin access identity." }, "CloudFrontOriginAccessIdentityAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.", "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityConfig":{ "type":"structure", "required":[ "CallerReference", "Comment" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the origin access identity." } }, "documentation":"Origin access identity configuration." }, "CloudFrontOriginAccessIdentityInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more origin access identities remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." }, "Items":{ "shape":"CloudFrontOriginAccessIdentitySummaryList", "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." } }, "documentation":"The CloudFrontOriginAccessIdentityList type." }, "CloudFrontOriginAccessIdentitySummary":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId", "Comment" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "Comment":{ "shape":"string", "documentation":"The comment for this origin access identity, as originally specified when created." } }, "documentation":"Summary of the information about a CloudFront origin access identity." }, "CloudFrontOriginAccessIdentitySummaryList":{ "type":"list", "member":{ "shape":"CloudFrontOriginAccessIdentitySummary", "locationName":"CloudFrontOriginAccessIdentitySummary" } }, "CookieNameList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "CookieNames":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of whitelisted cookies for this cache behavior." }, "Items":{ "shape":"CookieNameList", "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." }, "CookiePreference":{ "type":"structure", "required":["Forward"], "members":{ "Forward":{ "shape":"ItemSelection", "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." }, "WhitelistedNames":{ "shape":"CookieNames", "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." } }, "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." }, "CreateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["CloudFrontOriginAccessIdentityConfig"], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information.", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} } }, "documentation":"The request to create a new origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "CreateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the origin access identity created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "CreateDistributionRequest":{ "type":"structure", "required":["DistributionConfig"], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} } }, "documentation":"The request to create a new distribution.", "payload":"DistributionConfig" }, "CreateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "CreateDistributionWithTagsRequest":{ "type":"structure", "required":["DistributionConfigWithTags"], "members":{ "DistributionConfigWithTags":{ "shape":"DistributionConfigWithTags", "documentation":"The distribution's configuration information.", "locationName":"DistributionConfigWithTags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} } }, "documentation":"The request to create a new distribution with tags", "payload":"DistributionConfigWithTags" }, "CreateDistributionWithTagsResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "CreateInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "InvalidationBatch" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The batch information for the invalidation.", "locationName":"InvalidationBatch", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} } }, "documentation":"The request to create an invalidation.", "payload":"InvalidationBatch" }, "CreateInvalidationResult":{ "type":"structure", "members":{ "Location":{ "shape":"string", "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.", "location":"header", "locationName":"Location" }, "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "CreateStreamingDistributionRequest":{ "type":"structure", "required":["StreamingDistributionConfig"], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} } }, "documentation":"The request to create a new streaming distribution.", "payload":"StreamingDistributionConfig" }, "CreateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "CreateStreamingDistributionWithTagsRequest":{ "type":"structure", "required":["StreamingDistributionConfigWithTags"], "members":{ "StreamingDistributionConfigWithTags":{ "shape":"StreamingDistributionConfigWithTags", "documentation":"The streaming distribution's configuration information.", "locationName":"StreamingDistributionConfigWithTags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} } }, "documentation":"The request to create a new streaming distribution with tags.", "payload":"StreamingDistributionConfigWithTags" }, "CreateStreamingDistributionWithTagsResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "CustomErrorResponse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{ "shape":"integer", "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." }, "ResponsePagePath":{ "shape":"string", "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." }, "ResponseCode":{ "shape":"string", "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." }, "ErrorCachingMinTTL":{ "shape":"long", "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." } }, "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." }, "CustomErrorResponseList":{ "type":"list", "member":{ "shape":"CustomErrorResponse", "locationName":"CustomErrorResponse" } }, "CustomErrorResponses":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom error responses for this distribution." }, "Items":{ "shape":"CustomErrorResponseList", "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "CustomHeaders":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom headers for this origin." }, "Items":{ "shape":"OriginCustomHeadersList", "documentation":"A complex type that contains the custom headers for this Origin." } }, "documentation":"A complex type that contains the list of Custom Headers for each origin." }, "CustomOriginConfig":{ "type":"structure", "required":[ "HTTPPort", "HTTPSPort", "OriginProtocolPolicy" ], "members":{ "HTTPPort":{ "shape":"integer", "documentation":"The HTTP port the custom origin listens on." }, "HTTPSPort":{ "shape":"integer", "documentation":"The HTTPS port the custom origin listens on." }, "OriginProtocolPolicy":{ "shape":"OriginProtocolPolicy", "documentation":"The origin protocol policy to apply to your origin." }, "OriginSslProtocols":{ "shape":"OriginSslProtocols", "documentation":"The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." } }, "documentation":"A customer origin." }, "DefaultCacheBehavior":{ "type":"structure", "required":[ "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "DefaultTTL":{ "shape":"long", "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "MaxTTL":{ "shape":"long", "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "Compress":{ "shape":"boolean", "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." } }, "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "DeleteCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The origin access identity's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a origin access identity." }, "DeleteDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a distribution." }, "DeleteStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a streaming distribution." }, "Distribution":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "InProgressInvalidationBatches", "DomainName", "ActiveTrustedSigners", "DistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "ARN":{ "shape":"string", "documentation":"The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "InProgressInvalidationBatches":{ "shape":"integer", "documentation":"The number of invalidation batches currently in progress." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The current configuration information for the distribution." } }, "documentation":"A distribution." }, "DistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution.", "error":{"httpStatusCode":409}, "exception":true }, "DistributionConfig":{ "type":"structure", "required":[ "CallerReference", "Origins", "DefaultCacheBehavior", "Comment", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "DefaultRootObject":{ "shape":"string", "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the distribution." }, "Logging":{ "shape":"LoggingConfig", "documentation":"A complex type that controls whether access logs are written for the distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"(Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution." } }, "documentation":"A distribution Configuration." }, "DistributionConfigWithTags":{ "type":"structure", "required":[ "DistributionConfig", "Tags" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"A distribution Configuration." }, "Tags":{ "shape":"Tags", "documentation":"A complex type that contains zero or more Tag elements." } }, "documentation":"A distribution Configuration and a list of tags to be associated with the distribution." }, "DistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of distributions that were created by the current AWS account." }, "Items":{ "shape":"DistributionSummaryList", "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A distribution list." }, "DistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "DistributionSummary":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "DomainName", "Aliases", "Origins", "DefaultCacheBehavior", "CacheBehaviors", "CustomErrorResponses", "Comment", "PriceClass", "Enabled", "ViewerCertificate", "Restrictions", "WebACLId" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "ARN":{ "shape":"string", "documentation":"The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponses elements." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"The Web ACL Id (if any) associated with the distribution." } }, "documentation":"A summary of the information for an Amazon CloudFront distribution." }, "DistributionSummaryList":{ "type":"list", "member":{ "shape":"DistributionSummary", "locationName":"DistributionSummary" } }, "ForwardedValues":{ "type":"structure", "required":[ "QueryString", "Cookies" ], "members":{ "QueryString":{ "shape":"boolean", "documentation":"

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

  • If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
  • If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
  • If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
" }, "Cookies":{ "shape":"CookiePreference", "documentation":"A complex type that specifies how CloudFront handles cookies." }, "Headers":{ "shape":"Headers", "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." }, "QueryStringCacheKeys":{ "shape":"QueryStringCacheKeys", "documentation":"

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

" } }, "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "GeoRestriction":{ "type":"structure", "required":[ "RestrictionType", "Quantity" ], "members":{ "RestrictionType":{ "shape":"GeoRestrictionType", "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." }, "Quantity":{ "shape":"integer", "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." }, "Items":{ "shape":"LocationList", "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." } }, "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." }, "GeoRestrictionType":{ "type":"string", "enum":[ "blacklist", "whitelist", "none" ] }, "GetCloudFrontOriginAccessIdentityConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an origin access identity's configuration." }, "GetCloudFrontOriginAccessIdentityConfigResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "GetCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an origin access identity's information." }, "GetCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "GetDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a distribution configuration." }, "GetDistributionConfigResult":{ "type":"structure", "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionConfig" }, "GetDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a distribution's information." }, "GetDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "GetInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "Id" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "Id":{ "shape":"string", "documentation":"The invalidation's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an invalidation's information." }, "GetInvalidationResult":{ "type":"structure", "members":{ "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "GetStreamingDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"To request to get a streaming distribution configuration." }, "GetStreamingDistributionConfigResult":{ "type":"structure", "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionConfig" }, "GetStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a streaming distribution's information." }, "GetStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "HeaderList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "Headers":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." }, "Items":{ "shape":"HeaderList", "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." } }, "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." }, "IllegalUpdate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Origin and CallerReference cannot be updated.", "error":{"httpStatusCode":400}, "exception":true }, "InconsistentQuantities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The value of Quantity and the size of Items do not match.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidArgument":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The argument is invalid.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidDefaultRootObject":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The default root object file name is too big or contains an invalid character.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidErrorCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidForwardCookies":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidGeoRestrictionParameter":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidHeadersForS3Origin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidIfMatchVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The If-Match version is missing or not valid for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidLocationCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidMinimumProtocolVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The origin access identity is not valid or doesn't exist.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidProtocolSettings":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI).", "error":{"httpStatusCode":400}, "exception":true }, "InvalidQueryStringParameters":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidRelativePath":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/).", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRequiredProtocol":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"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.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidResponseCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidTTLOrder":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidTagging":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified tagging for a CloudFront resource is invalid. For more information, see the error text.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidViewerCertificate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidWebACLId":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "Invalidation":{ "type":"structure", "required":[ "Id", "Status", "CreateTime", "InvalidationBatch" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." }, "CreateTime":{ "shape":"timestamp", "documentation":"The date and time the invalidation request was first made." }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The current invalidation information for the batch request." } }, "documentation":"An invalidation." }, "InvalidationBatch":{ "type":"structure", "required":[ "Paths", "CallerReference" ], "members":{ "Paths":{ "shape":"Paths", "documentation":"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. 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. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." }, "CallerReference":{ "shape":"string", "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. 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, the response includes the same information returned to the original request. 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, CloudFront returns an InvalidationBatchAlreadyExists error." } }, "documentation":"An invalidation batch." }, "InvalidationList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of invalidation batches that were created by the current AWS account." }, "Items":{ "shape":"InvalidationSummaryList", "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." } }, "documentation":"An invalidation list." }, "InvalidationSummary":{ "type":"structure", "required":[ "Id", "CreateTime", "Status" ], "members":{ "Id":{ "shape":"string", "documentation":"The unique ID for an invalidation request." }, "CreateTime":{"shape":"timestamp"}, "Status":{ "shape":"string", "documentation":"The status of an invalidation request." } }, "documentation":"Summary of an invalidation request." }, "InvalidationSummaryList":{ "type":"list", "member":{ "shape":"InvalidationSummary", "locationName":"InvalidationSummary" } }, "ItemSelection":{ "type":"string", "enum":[ "none", "whitelist", "all" ] }, "KeyPairIdList":{ "type":"list", "member":{ "shape":"string", "locationName":"KeyPairId" } }, "KeyPairIds":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." }, "Items":{ "shape":"KeyPairIdList", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." }, "ListCloudFrontOriginAccessIdentitiesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"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. 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).", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of origin access identities you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list origin access identities." }, "ListCloudFrontOriginAccessIdentitiesResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityList":{ "shape":"CloudFrontOriginAccessIdentityList", "documentation":"The CloudFrontOriginAccessIdentityList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityList" }, "ListDistributionsByWebACLIdRequest":{ "type":"structure", "required":["WebACLId"], "members":{ "Marker":{ "shape":"string", "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", "location":"querystring", "locationName":"MaxItems" }, "WebACLId":{ "shape":"string", "documentation":"The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify \"null\" for the Id, the request returns a list of the distributions that aren't associated with a web ACL.", "location":"uri", "locationName":"WebACLId" } }, "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL." }, "ListDistributionsByWebACLIdResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.", "payload":"DistributionList" }, "ListDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list your distributions." }, "ListDistributionsResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionList" }, "ListInvalidationsRequest":{ "type":"structure", "required":["DistributionId"], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "Marker":{ "shape":"string", "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. 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. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of invalidation batches you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list invalidations." }, "ListInvalidationsResult":{ "type":"structure", "members":{ "InvalidationList":{ "shape":"InvalidationList", "documentation":"Information about invalidation batches." } }, "documentation":"The returned result of the corresponding request.", "payload":"InvalidationList" }, "ListStreamingDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"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. 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).", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of streaming distributions you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list your streaming distributions." }, "ListStreamingDistributionsResult":{ "type":"structure", "members":{ "StreamingDistributionList":{ "shape":"StreamingDistributionList", "documentation":"The StreamingDistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionList" }, "ListTagsForResourceRequest":{ "type":"structure", "required":["Resource"], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"An ARN of a CloudFront resource.", "location":"querystring", "locationName":"Resource" } }, "documentation":"The request to list tags for a CloudFront resource." }, "ListTagsForResourceResult":{ "type":"structure", "required":["Tags"], "members":{ "Tags":{ "shape":"Tags", "documentation":"A complex type that contains zero or more Tag elements." } }, "documentation":"The returned result of the corresponding request.", "payload":"Tags" }, "LocationList":{ "type":"list", "member":{ "shape":"string", "locationName":"Location" } }, "LoggingConfig":{ "type":"structure", "required":[ "Enabled", "IncludeCookies", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." }, "IncludeCookies":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for the distribution." }, "Method":{ "type":"string", "enum":[ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ] }, "MethodsList":{ "type":"list", "member":{ "shape":"Method", "locationName":"Method" } }, "MinimumProtocolVersion":{ "type":"string", "enum":[ "SSLv3", "TLSv1" ] }, "MissingBody":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set.", "error":{"httpStatusCode":400}, "exception":true }, "NoSuchCloudFrontOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified origin access identity does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified distribution does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchInvalidation":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified invalidation does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"No origin exists with the specified Origin Id.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchResource":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified CloudFront resource does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchStreamingDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified streaming distribution does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "Origin":{ "type":"structure", "required":[ "Id", "DomainName" ], "members":{ "Id":{ "shape":"string", "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." }, "DomainName":{ "shape":"string", "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." }, "OriginPath":{ "shape":"string", "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." }, "CustomHeaders":{ "shape":"CustomHeaders", "documentation":"A complex type that contains information about the custom headers associated with this Origin." }, "S3OriginConfig":{ "shape":"S3OriginConfig", "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "CustomOriginConfig":{ "shape":"CustomOriginConfig", "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." } }, "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." }, "OriginCustomHeader":{ "type":"structure", "required":[ "HeaderName", "HeaderValue" ], "members":{ "HeaderName":{ "shape":"string", "documentation":"The header's name." }, "HeaderValue":{ "shape":"string", "documentation":"The header's value." } }, "documentation":"A complex type that contains information related to a Header" }, "OriginCustomHeadersList":{ "type":"list", "member":{ "shape":"OriginCustomHeader", "locationName":"OriginCustomHeader" } }, "OriginList":{ "type":"list", "member":{ "shape":"Origin", "locationName":"Origin" }, "min":1 }, "OriginProtocolPolicy":{ "type":"string", "enum":[ "http-only", "match-viewer", "https-only" ] }, "OriginSslProtocols":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." }, "Items":{ "shape":"SslProtocolsList", "documentation":"A complex type that contains one SslProtocol element for each SSL/TLS protocol that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." } }, "documentation":"A complex type that contains the list of SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." }, "Origins":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of origins for this distribution." }, "Items":{ "shape":"OriginList", "documentation":"A complex type that contains origins for this distribution." } }, "documentation":"A complex type that contains information about origins for this distribution." }, "PathList":{ "type":"list", "member":{ "shape":"string", "locationName":"Path" } }, "Paths":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of objects that you want to invalidate." }, "Items":{ "shape":"PathList", "documentation":"A complex type that contains a list of the objects that you want to invalidate." } }, "documentation":"A complex type that contains information about the objects that you want to invalidate." }, "PreconditionFailed":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The precondition given in one or more of the request-header fields evaluated to false.", "error":{"httpStatusCode":412}, "exception":true }, "PriceClass":{ "type":"string", "enum":[ "PriceClass_100", "PriceClass_200", "PriceClass_All" ] }, "QueryStringCacheKeys":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of whitelisted query string parameters for this cache behavior." }, "Items":{ "shape":"QueryStringCacheKeysList", "documentation":"Optional: A list that contains the query string parameters that you want CloudFront to use as a basis for caching for this cache behavior. If Quantity is 0, you can omit Items." } } }, "QueryStringCacheKeysList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "ResourceARN":{ "type":"string", "pattern":"arn:aws:cloudfront::[0-9]+:.*" }, "Restrictions":{ "type":"structure", "required":["GeoRestriction"], "members":{ "GeoRestriction":{"shape":"GeoRestriction"} }, "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." }, "S3Origin":{ "type":"structure", "required":[ "DomainName", "OriginAccessIdentity" ], "members":{ "DomainName":{ "shape":"string", "documentation":"The DNS name of the S3 origin." }, "OriginAccessIdentity":{ "shape":"string", "documentation":"Your S3 origin's origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "S3OriginConfig":{ "type":"structure", "required":["OriginAccessIdentity"], "members":{ "OriginAccessIdentity":{ "shape":"string", "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "SSLSupportMethod":{ "type":"string", "enum":[ "sni-only", "vip" ] }, "Signer":{ "type":"structure", "members":{ "AwsAccountNumber":{ "shape":"string", "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." }, "KeyPairIds":{ "shape":"KeyPairIds", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." }, "SignerList":{ "type":"list", "member":{ "shape":"Signer", "locationName":"Signer" } }, "SslProtocol":{ "type":"string", "enum":[ "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2" ] }, "SslProtocolsList":{ "type":"list", "member":{ "shape":"SslProtocol", "locationName":"SslProtocol" } }, "StreamingDistribution":{ "type":"structure", "required":[ "Id", "ARN", "Status", "DomainName", "ActiveTrustedSigners", "StreamingDistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." }, "ARN":{ "shape":"string", "documentation":"The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." }, "Status":{ "shape":"string", "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The current configuration information for the streaming distribution." } }, "documentation":"A streaming distribution." }, "StreamingDistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionConfig":{ "type":"structure", "required":[ "CallerReference", "S3Origin", "Comment", "TrustedSigners", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the streaming distribution." }, "Logging":{ "shape":"StreamingLoggingConfig", "documentation":"A complex type that controls whether access logs are written for the streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this streaming distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." } }, "documentation":"The configuration for the streaming distribution." }, "StreamingDistributionConfigWithTags":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Tags" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"A streaming distribution Configuration." }, "Tags":{ "shape":"Tags", "documentation":"A complex type that contains zero or more Tag elements." } }, "documentation":"A streaming distribution Configuration and a list of tags to be associated with the streaming distribution." }, "StreamingDistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more streaming distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of streaming distributions that were created by the current AWS account." }, "Items":{ "shape":"StreamingDistributionSummaryList", "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A streaming distribution list." }, "StreamingDistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionSummary":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "DomainName", "S3Origin", "Aliases", "TrustedSigners", "Comment", "PriceClass", "Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "ARN":{ "shape":"string", "documentation":"The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." }, "Status":{ "shape":"string", "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." } }, "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." }, "StreamingDistributionSummaryList":{ "type":"list", "member":{ "shape":"StreamingDistributionSummary", "locationName":"StreamingDistributionSummary" } }, "StreamingLoggingConfig":{ "type":"structure", "required":[ "Enabled", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for this streaming distribution." }, "Tag":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"TagKey", "documentation":"A string that contains Tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @." }, "Value":{ "shape":"TagValue", "documentation":"A string that contains an optional Tag value. The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @." } }, "documentation":"A complex type that contains Tag key and Tag value." }, "TagKey":{ "type":"string", "documentation":"A string that contains Tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeyList":{ "type":"list", "member":{ "shape":"TagKey", "locationName":"Key" } }, "TagKeys":{ "type":"structure", "members":{ "Items":{ "shape":"TagKeyList", "documentation":"A complex type that contains Tag key elements" } }, "documentation":"A complex type that contains zero or more Tag elements." }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"Tag" } }, "TagResourceRequest":{ "type":"structure", "required":[ "Resource", "Tags" ], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"An ARN of a CloudFront resource.", "location":"querystring", "locationName":"Resource" }, "Tags":{ "shape":"Tags", "documentation":"A complex type that contains zero or more Tag elements.", "locationName":"Tags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} } }, "documentation":"The request to add tags to a CloudFront resource.", "payload":"Tags" }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Tags":{ "type":"structure", "members":{ "Items":{ "shape":"TagList", "documentation":"A complex type that contains Tag elements" } }, "documentation":"A complex type that contains zero or more Tag elements." }, "TooManyCacheBehaviors":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore cache behaviors for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCertificates":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore custom ssl certificates.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCloudFrontOriginAccessIdentities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCookieNamesInWhiteList":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more CNAMEs than are allowed per distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyHeadersInForwardedValues":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyInvalidationsInProgress":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyOriginCustomHeaders":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyOrigins":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore origins for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyQueryStringParameters":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyTrustedSigners":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more trusted signers than are allowed per distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSignerDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"One or more of your trusted signers do not exist.", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." }, "Quantity":{ "shape":"integer", "documentation":"The number of trusted signers for this cache behavior." }, "Items":{ "shape":"AwsAccountNumberList", "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "UntagResourceRequest":{ "type":"structure", "required":[ "Resource", "TagKeys" ], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"An ARN of a CloudFront resource.", "location":"querystring", "locationName":"Resource" }, "TagKeys":{ "shape":"TagKeys", "documentation":"A complex type that contains zero or more Tag key elements.", "locationName":"TagKeys", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} } }, "documentation":"The request to remove tags from a CloudFront resource.", "payload":"TagKeys" }, "UpdateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":[ "CloudFrontOriginAccessIdentityConfig", "Id" ], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The identity's configuration information.", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} }, "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update an origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "UpdateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "UpdateDistributionRequest":{ "type":"structure", "required":[ "DistributionConfig", "Id" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} }, "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update a distribution.", "payload":"DistributionConfig" }, "UpdateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "UpdateStreamingDistributionRequest":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Id" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} }, "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update a streaming distribution.", "payload":"StreamingDistributionConfig" }, "UpdateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "ViewerCertificate":{ "type":"structure", "members":{ "CloudFrontDefaultCertificate":{ "shape":"boolean", "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an ACMCertificateArn or IAMCertificateId." }, "IAMCertificateId":{ "shape":"string", "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value, ACMCertificateArn, or CloudFrontDefaultCertificate." }, "ACMCertificateArn":{ "shape":"string", "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the ACM certificate ARN of the custom viewer certificate for this distribution. Specify either this value, IAMCertificateId, or CloudFrontDefaultCertificate." }, "SSLSupportMethod":{ "shape":"SSLSupportMethod", "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." }, "MinimumProtocolVersion":{ "shape":"MinimumProtocolVersion", "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." }, "Certificate":{ "shape":"string", "documentation":"Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].", "deprecated":true }, "CertificateSource":{ "shape":"CertificateSource", "documentation":"Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].", "deprecated":true } }, "documentation":"A complex type that contains information about viewer certificates for this distribution." }, "ViewerProtocolPolicy":{ "type":"string", "enum":[ "allow-all", "https-only", "redirect-to-https" ] }, "boolean":{"type":"boolean"}, "integer":{"type":"integer"}, "long":{"type":"long"}, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} }, "documentation":"Amazon CloudFront

Amazon CloudFront is a global content delivery network (CDN) service that accelerates delivery of your websites, APIs, video content or other web assets. It integrates with other Amazon Web Services products to give developers and businesses an easy way to accelerate content to end users with no minimum usage commitments.

" } botocore-1.5.7/botocore/data/cloudfront/2016-01-13/0000777454262600001440000000000013042511307022341 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudfront/2016-01-13/waiters-2.json0000666454262600001440000000224013042511306025046 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DistributionDeployed": { "delay": 60, "operation": "GetDistribution", "maxAttempts": 25, "description": "Wait until a distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "Distribution.Status" } ] }, "InvalidationCompleted": { "delay": 20, "operation": "GetInvalidation", "maxAttempts": 60, "description": "Wait until an invalidation has completed.", "acceptors": [ { "expected": "Completed", "matcher": "path", "state": "success", "argument": "Invalidation.Status" } ] }, "StreamingDistributionDeployed": { "delay": 60, "operation": "GetStreamingDistribution", "maxAttempts": 25, "description": "Wait until a streaming distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "StreamingDistribution.Status" } ] } } } botocore-1.5.7/botocore/data/cloudfront/2016-01-13/paginators-1.json0000666454262600001440000000214613042511306025543 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListCloudFrontOriginAccessIdentities": { "input_token": "Marker", "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", "limit_key": "MaxItems", "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", "result_key": "CloudFrontOriginAccessIdentityList.Items" }, "ListDistributions": { "input_token": "Marker", "output_token": "DistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "DistributionList.IsTruncated", "result_key": "DistributionList.Items" }, "ListInvalidations": { "input_token": "Marker", "output_token": "InvalidationList.NextMarker", "limit_key": "MaxItems", "more_results": "InvalidationList.IsTruncated", "result_key": "InvalidationList.Items" }, "ListStreamingDistributions": { "input_token": "Marker", "output_token": "StreamingDistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "StreamingDistributionList.IsTruncated", "result_key": "StreamingDistributionList.Items" } } } botocore-1.5.7/botocore/data/cloudfront/2016-01-13/service-2.json0000666454262600001440000040533213042511306025041 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-01-13", "endpointPrefix":"cloudfront", "globalEndpoint":"cloudfront.amazonaws.com", "protocol":"rest-xml", "serviceAbbreviation":"CloudFront", "serviceFullName":"Amazon CloudFront", "signatureVersion":"v4" }, "operations":{ "CreateCloudFrontOriginAccessIdentity":{ "name":"CreateCloudFrontOriginAccessIdentity2016_01_13", "http":{ "method":"POST", "requestUri":"/2016-01-13/origin-access-identity/cloudfront", "responseCode":201 }, "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, {"shape":"MissingBody"}, {"shape":"TooManyCloudFrontOriginAccessIdentities"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new origin access identity." }, "CreateDistribution":{ "name":"CreateDistribution2016_01_13", "http":{ "method":"POST", "requestUri":"/2016-01-13/distribution", "responseCode":201 }, "input":{"shape":"CreateDistributionRequest"}, "output":{"shape":"CreateDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"DistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"MissingBody"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"TooManyDistributions"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidProtocolSettings"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"} ], "documentation":"Create a new distribution." }, "CreateInvalidation":{ "name":"CreateInvalidation2016_01_13", "http":{ "method":"POST", "requestUri":"/2016-01-13/distribution/{DistributionId}/invalidation", "responseCode":201 }, "input":{"shape":"CreateInvalidationRequest"}, "output":{"shape":"CreateInvalidationResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"MissingBody"}, {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"BatchTooLarge"}, {"shape":"TooManyInvalidationsInProgress"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new invalidation." }, "CreateStreamingDistribution":{ "name":"CreateStreamingDistribution2016_01_13", "http":{ "method":"POST", "requestUri":"/2016-01-13/streaming-distribution", "responseCode":201 }, "input":{"shape":"CreateStreamingDistributionRequest"}, "output":{"shape":"CreateStreamingDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"StreamingDistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"MissingBody"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"TooManyStreamingDistributions"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new streaming distribution." }, "DeleteCloudFrontOriginAccessIdentity":{ "name":"DeleteCloudFrontOriginAccessIdentity2016_01_13", "http":{ "method":"DELETE", "requestUri":"/2016-01-13/origin-access-identity/cloudfront/{Id}", "responseCode":204 }, "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"PreconditionFailed"}, {"shape":"CloudFrontOriginAccessIdentityInUse"} ], "documentation":"Delete an origin access identity." }, "DeleteDistribution":{ "name":"DeleteDistribution2016_01_13", "http":{ "method":"DELETE", "requestUri":"/2016-01-13/distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"DistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"Delete a distribution." }, "DeleteStreamingDistribution":{ "name":"DeleteStreamingDistribution2016_01_13", "http":{ "method":"DELETE", "requestUri":"/2016-01-13/streaming-distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteStreamingDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"StreamingDistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"Delete a streaming distribution." }, "GetCloudFrontOriginAccessIdentity":{ "name":"GetCloudFrontOriginAccessIdentity2016_01_13", "http":{ "method":"GET", "requestUri":"/2016-01-13/origin-access-identity/cloudfront/{Id}" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about an origin access identity." }, "GetCloudFrontOriginAccessIdentityConfig":{ "name":"GetCloudFrontOriginAccessIdentityConfig2016_01_13", "http":{ "method":"GET", "requestUri":"/2016-01-13/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about an origin access identity." }, "GetDistribution":{ "name":"GetDistribution2016_01_13", "http":{ "method":"GET", "requestUri":"/2016-01-13/distribution/{Id}" }, "input":{"shape":"GetDistributionRequest"}, "output":{"shape":"GetDistributionResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about a distribution." }, "GetDistributionConfig":{ "name":"GetDistributionConfig2016_01_13", "http":{ "method":"GET", "requestUri":"/2016-01-13/distribution/{Id}/config" }, "input":{"shape":"GetDistributionConfigRequest"}, "output":{"shape":"GetDistributionConfigResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about a distribution." }, "GetInvalidation":{ "name":"GetInvalidation2016_01_13", "http":{ "method":"GET", "requestUri":"/2016-01-13/distribution/{DistributionId}/invalidation/{Id}" }, "input":{"shape":"GetInvalidationRequest"}, "output":{"shape":"GetInvalidationResult"}, "errors":[ {"shape":"NoSuchInvalidation"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about an invalidation." }, "GetStreamingDistribution":{ "name":"GetStreamingDistribution2016_01_13", "http":{ "method":"GET", "requestUri":"/2016-01-13/streaming-distribution/{Id}" }, "input":{"shape":"GetStreamingDistributionRequest"}, "output":{"shape":"GetStreamingDistributionResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about a streaming distribution." }, "GetStreamingDistributionConfig":{ "name":"GetStreamingDistributionConfig2016_01_13", "http":{ "method":"GET", "requestUri":"/2016-01-13/streaming-distribution/{Id}/config" }, "input":{"shape":"GetStreamingDistributionConfigRequest"}, "output":{"shape":"GetStreamingDistributionConfigResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about a streaming distribution." }, "ListCloudFrontOriginAccessIdentities":{ "name":"ListCloudFrontOriginAccessIdentities2016_01_13", "http":{ "method":"GET", "requestUri":"/2016-01-13/origin-access-identity/cloudfront" }, "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List origin access identities." }, "ListDistributions":{ "name":"ListDistributions2016_01_13", "http":{ "method":"GET", "requestUri":"/2016-01-13/distribution" }, "input":{"shape":"ListDistributionsRequest"}, "output":{"shape":"ListDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List distributions." }, "ListDistributionsByWebACLId":{ "name":"ListDistributionsByWebACLId2016_01_13", "http":{ "method":"GET", "requestUri":"/2016-01-13/distributionsByWebACLId/{WebACLId}" }, "input":{"shape":"ListDistributionsByWebACLIdRequest"}, "output":{"shape":"ListDistributionsByWebACLIdResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"InvalidWebACLId"} ], "documentation":"List the distributions that are associated with a specified AWS WAF web ACL." }, "ListInvalidations":{ "name":"ListInvalidations2016_01_13", "http":{ "method":"GET", "requestUri":"/2016-01-13/distribution/{DistributionId}/invalidation" }, "input":{"shape":"ListInvalidationsRequest"}, "output":{"shape":"ListInvalidationsResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"List invalidation batches." }, "ListStreamingDistributions":{ "name":"ListStreamingDistributions2016_01_13", "http":{ "method":"GET", "requestUri":"/2016-01-13/streaming-distribution" }, "input":{"shape":"ListStreamingDistributionsRequest"}, "output":{"shape":"ListStreamingDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List streaming distributions." }, "UpdateCloudFrontOriginAccessIdentity":{ "name":"UpdateCloudFrontOriginAccessIdentity2016_01_13", "http":{ "method":"PUT", "requestUri":"/2016-01-13/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"PreconditionFailed"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Update an origin access identity." }, "UpdateDistribution":{ "name":"UpdateDistribution2016_01_13", "http":{ "method":"PUT", "requestUri":"/2016-01-13/distribution/{Id}/config" }, "input":{"shape":"UpdateDistributionRequest"}, "output":{"shape":"UpdateDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"} ], "documentation":"Update a distribution." }, "UpdateStreamingDistribution":{ "name":"UpdateStreamingDistribution2016_01_13", "http":{ "method":"PUT", "requestUri":"/2016-01-13/streaming-distribution/{Id}/config" }, "input":{"shape":"UpdateStreamingDistributionRequest"}, "output":{"shape":"UpdateStreamingDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InconsistentQuantities"} ], "documentation":"Update a streaming distribution." } }, "shapes":{ "AccessDenied":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Access denied.", "error":{"httpStatusCode":403}, "exception":true }, "ActiveTrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Each active trusted signer." }, "Quantity":{ "shape":"integer", "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." }, "Items":{ "shape":"SignerList", "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." } }, "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." }, "AliasList":{ "type":"list", "member":{ "shape":"string", "locationName":"CNAME" } }, "Aliases":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of CNAMEs, if any, for this distribution." }, "Items":{ "shape":"AliasList", "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "AllowedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." }, "CachedMethods":{"shape":"CachedMethods"} }, "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." }, "AwsAccountNumberList":{ "type":"list", "member":{ "shape":"string", "locationName":"AwsAccountNumber" } }, "BatchTooLarge":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":413}, "exception":true }, "CNAMEAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CacheBehavior":{ "type":"structure", "required":[ "PathPattern", "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "PathPattern":{ "shape":"string", "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." }, "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "DefaultTTL":{ "shape":"long", "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "MaxTTL":{ "shape":"long", "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "Compress":{ "shape":"boolean", "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." } }, "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." }, "CacheBehaviorList":{ "type":"list", "member":{ "shape":"CacheBehavior", "locationName":"CacheBehavior" } }, "CacheBehaviors":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of cache behaviors for this distribution." }, "Items":{ "shape":"CacheBehaviorList", "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CachedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." } }, "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." }, "CertificateSource":{ "type":"string", "enum":[ "cloudfront", "iam" ] }, "CloudFrontOriginAccessIdentity":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The current configuration information for the identity." } }, "documentation":"CloudFront origin access identity." }, "CloudFrontOriginAccessIdentityAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.", "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityConfig":{ "type":"structure", "required":[ "CallerReference", "Comment" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the origin access identity." } }, "documentation":"Origin access identity configuration." }, "CloudFrontOriginAccessIdentityInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more origin access identities remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." }, "Items":{ "shape":"CloudFrontOriginAccessIdentitySummaryList", "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." } }, "documentation":"The CloudFrontOriginAccessIdentityList type." }, "CloudFrontOriginAccessIdentitySummary":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId", "Comment" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "Comment":{ "shape":"string", "documentation":"The comment for this origin access identity, as originally specified when created." } }, "documentation":"Summary of the information about a CloudFront origin access identity." }, "CloudFrontOriginAccessIdentitySummaryList":{ "type":"list", "member":{ "shape":"CloudFrontOriginAccessIdentitySummary", "locationName":"CloudFrontOriginAccessIdentitySummary" } }, "CookieNameList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "CookieNames":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of whitelisted cookies for this cache behavior." }, "Items":{ "shape":"CookieNameList", "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." }, "CookiePreference":{ "type":"structure", "required":["Forward"], "members":{ "Forward":{ "shape":"ItemSelection", "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." }, "WhitelistedNames":{ "shape":"CookieNames", "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." } }, "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." }, "CreateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["CloudFrontOriginAccessIdentityConfig"], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information.", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-13/"} } }, "documentation":"The request to create a new origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "CreateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the origin access identity created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "CreateDistributionRequest":{ "type":"structure", "required":["DistributionConfig"], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-13/"} } }, "documentation":"The request to create a new distribution.", "payload":"DistributionConfig" }, "CreateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "CreateInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "InvalidationBatch" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The batch information for the invalidation.", "locationName":"InvalidationBatch", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-13/"} } }, "documentation":"The request to create an invalidation.", "payload":"InvalidationBatch" }, "CreateInvalidationResult":{ "type":"structure", "members":{ "Location":{ "shape":"string", "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.", "location":"header", "locationName":"Location" }, "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "CreateStreamingDistributionRequest":{ "type":"structure", "required":["StreamingDistributionConfig"], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-13/"} } }, "documentation":"The request to create a new streaming distribution.", "payload":"StreamingDistributionConfig" }, "CreateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "CustomErrorResponse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{ "shape":"integer", "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." }, "ResponsePagePath":{ "shape":"string", "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." }, "ResponseCode":{ "shape":"string", "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." }, "ErrorCachingMinTTL":{ "shape":"long", "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." } }, "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." }, "CustomErrorResponseList":{ "type":"list", "member":{ "shape":"CustomErrorResponse", "locationName":"CustomErrorResponse" } }, "CustomErrorResponses":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom error responses for this distribution." }, "Items":{ "shape":"CustomErrorResponseList", "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "CustomHeaders":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom headers for this origin." }, "Items":{ "shape":"OriginCustomHeadersList", "documentation":"A complex type that contains the custom headers for this Origin." } }, "documentation":"A complex type that contains the list of Custom Headers for each origin." }, "CustomOriginConfig":{ "type":"structure", "required":[ "HTTPPort", "HTTPSPort", "OriginProtocolPolicy" ], "members":{ "HTTPPort":{ "shape":"integer", "documentation":"The HTTP port the custom origin listens on." }, "HTTPSPort":{ "shape":"integer", "documentation":"The HTTPS port the custom origin listens on." }, "OriginProtocolPolicy":{ "shape":"OriginProtocolPolicy", "documentation":"The origin protocol policy to apply to your origin." }, "OriginSslProtocols":{ "shape":"OriginSslProtocols", "documentation":"The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." } }, "documentation":"A customer origin." }, "DefaultCacheBehavior":{ "type":"structure", "required":[ "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "DefaultTTL":{ "shape":"long", "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "MaxTTL":{ "shape":"long", "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "Compress":{ "shape":"boolean", "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." } }, "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "DeleteCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The origin access identity's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a origin access identity." }, "DeleteDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a distribution." }, "DeleteStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a streaming distribution." }, "Distribution":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "InProgressInvalidationBatches", "DomainName", "ActiveTrustedSigners", "DistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "InProgressInvalidationBatches":{ "shape":"integer", "documentation":"The number of invalidation batches currently in progress." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The current configuration information for the distribution." } }, "documentation":"A distribution." }, "DistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution.", "error":{"httpStatusCode":409}, "exception":true }, "DistributionConfig":{ "type":"structure", "required":[ "CallerReference", "Origins", "DefaultCacheBehavior", "Comment", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "DefaultRootObject":{ "shape":"string", "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the distribution." }, "Logging":{ "shape":"LoggingConfig", "documentation":"A complex type that controls whether access logs are written for the distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"(Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution." } }, "documentation":"A distribution Configuration." }, "DistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of distributions that were created by the current AWS account." }, "Items":{ "shape":"DistributionSummaryList", "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A distribution list." }, "DistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "DistributionSummary":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "DomainName", "Aliases", "Origins", "DefaultCacheBehavior", "CacheBehaviors", "CustomErrorResponses", "Comment", "PriceClass", "Enabled", "ViewerCertificate", "Restrictions", "WebACLId" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponses elements." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"The Web ACL Id (if any) associated with the distribution." } }, "documentation":"A summary of the information for an Amazon CloudFront distribution." }, "DistributionSummaryList":{ "type":"list", "member":{ "shape":"DistributionSummary", "locationName":"DistributionSummary" } }, "ForwardedValues":{ "type":"structure", "required":[ "QueryString", "Cookies" ], "members":{ "QueryString":{ "shape":"boolean", "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "Cookies":{ "shape":"CookiePreference", "documentation":"A complex type that specifies how CloudFront handles cookies." }, "Headers":{ "shape":"Headers", "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." } }, "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "GeoRestriction":{ "type":"structure", "required":[ "RestrictionType", "Quantity" ], "members":{ "RestrictionType":{ "shape":"GeoRestrictionType", "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." }, "Quantity":{ "shape":"integer", "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." }, "Items":{ "shape":"LocationList", "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." } }, "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." }, "GeoRestrictionType":{ "type":"string", "enum":[ "blacklist", "whitelist", "none" ] }, "GetCloudFrontOriginAccessIdentityConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an origin access identity's configuration." }, "GetCloudFrontOriginAccessIdentityConfigResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "GetCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an origin access identity's information." }, "GetCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "GetDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a distribution configuration." }, "GetDistributionConfigResult":{ "type":"structure", "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionConfig" }, "GetDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a distribution's information." }, "GetDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "GetInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "Id" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "Id":{ "shape":"string", "documentation":"The invalidation's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an invalidation's information." }, "GetInvalidationResult":{ "type":"structure", "members":{ "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "GetStreamingDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"To request to get a streaming distribution configuration." }, "GetStreamingDistributionConfigResult":{ "type":"structure", "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionConfig" }, "GetStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a streaming distribution's information." }, "GetStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "HeaderList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "Headers":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." }, "Items":{ "shape":"HeaderList", "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." } }, "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." }, "IllegalUpdate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Origin and CallerReference cannot be updated.", "error":{"httpStatusCode":400}, "exception":true }, "InconsistentQuantities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The value of Quantity and the size of Items do not match.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidArgument":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The argument is invalid.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidDefaultRootObject":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The default root object file name is too big or contains an invalid character.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidErrorCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidForwardCookies":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidGeoRestrictionParameter":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidHeadersForS3Origin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidIfMatchVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The If-Match version is missing or not valid for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidLocationCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidMinimumProtocolVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The origin access identity is not valid or doesn't exist.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidProtocolSettings":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI).", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRelativePath":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/).", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRequiredProtocol":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"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.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidResponseCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidTTLOrder":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidViewerCertificate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidWebACLId":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "Invalidation":{ "type":"structure", "required":[ "Id", "Status", "CreateTime", "InvalidationBatch" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." }, "CreateTime":{ "shape":"timestamp", "documentation":"The date and time the invalidation request was first made." }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The current invalidation information for the batch request." } }, "documentation":"An invalidation." }, "InvalidationBatch":{ "type":"structure", "required":[ "Paths", "CallerReference" ], "members":{ "Paths":{ "shape":"Paths", "documentation":"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. 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. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." }, "CallerReference":{ "shape":"string", "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. 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, the response includes the same information returned to the original request. 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, CloudFront returns an InvalidationBatchAlreadyExists error." } }, "documentation":"An invalidation batch." }, "InvalidationList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of invalidation batches that were created by the current AWS account." }, "Items":{ "shape":"InvalidationSummaryList", "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." } }, "documentation":"An invalidation list." }, "InvalidationSummary":{ "type":"structure", "required":[ "Id", "CreateTime", "Status" ], "members":{ "Id":{ "shape":"string", "documentation":"The unique ID for an invalidation request." }, "CreateTime":{"shape":"timestamp"}, "Status":{ "shape":"string", "documentation":"The status of an invalidation request." } }, "documentation":"Summary of an invalidation request." }, "InvalidationSummaryList":{ "type":"list", "member":{ "shape":"InvalidationSummary", "locationName":"InvalidationSummary" } }, "ItemSelection":{ "type":"string", "enum":[ "none", "whitelist", "all" ] }, "KeyPairIdList":{ "type":"list", "member":{ "shape":"string", "locationName":"KeyPairId" } }, "KeyPairIds":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." }, "Items":{ "shape":"KeyPairIdList", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." }, "ListCloudFrontOriginAccessIdentitiesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"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. 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).", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of origin access identities you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list origin access identities." }, "ListCloudFrontOriginAccessIdentitiesResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityList":{ "shape":"CloudFrontOriginAccessIdentityList", "documentation":"The CloudFrontOriginAccessIdentityList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityList" }, "ListDistributionsByWebACLIdRequest":{ "type":"structure", "required":["WebACLId"], "members":{ "Marker":{ "shape":"string", "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", "location":"querystring", "locationName":"MaxItems" }, "WebACLId":{ "shape":"string", "documentation":"The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify \"null\" for the Id, the request returns a list of the distributions that aren't associated with a web ACL.", "location":"uri", "locationName":"WebACLId" } }, "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL." }, "ListDistributionsByWebACLIdResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.", "payload":"DistributionList" }, "ListDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list your distributions." }, "ListDistributionsResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionList" }, "ListInvalidationsRequest":{ "type":"structure", "required":["DistributionId"], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "Marker":{ "shape":"string", "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. 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. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of invalidation batches you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list invalidations." }, "ListInvalidationsResult":{ "type":"structure", "members":{ "InvalidationList":{ "shape":"InvalidationList", "documentation":"Information about invalidation batches." } }, "documentation":"The returned result of the corresponding request.", "payload":"InvalidationList" }, "ListStreamingDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"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. 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).", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of streaming distributions you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list your streaming distributions." }, "ListStreamingDistributionsResult":{ "type":"structure", "members":{ "StreamingDistributionList":{ "shape":"StreamingDistributionList", "documentation":"The StreamingDistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionList" }, "LocationList":{ "type":"list", "member":{ "shape":"string", "locationName":"Location" } }, "LoggingConfig":{ "type":"structure", "required":[ "Enabled", "IncludeCookies", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." }, "IncludeCookies":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for the distribution." }, "Method":{ "type":"string", "enum":[ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ] }, "MethodsList":{ "type":"list", "member":{ "shape":"Method", "locationName":"Method" } }, "MinimumProtocolVersion":{ "type":"string", "enum":[ "SSLv3", "TLSv1" ] }, "MissingBody":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set.", "error":{"httpStatusCode":400}, "exception":true }, "NoSuchCloudFrontOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified origin access identity does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified distribution does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchInvalidation":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified invalidation does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"No origin exists with the specified Origin Id.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchStreamingDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified streaming distribution does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "Origin":{ "type":"structure", "required":[ "Id", "DomainName" ], "members":{ "Id":{ "shape":"string", "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." }, "DomainName":{ "shape":"string", "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." }, "OriginPath":{ "shape":"string", "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." }, "CustomHeaders":{ "shape":"CustomHeaders", "documentation":"A complex type that contains information about the custom headers associated with this Origin." }, "S3OriginConfig":{ "shape":"S3OriginConfig", "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "CustomOriginConfig":{ "shape":"CustomOriginConfig", "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." } }, "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." }, "OriginCustomHeader":{ "type":"structure", "required":[ "HeaderName", "HeaderValue" ], "members":{ "HeaderName":{ "shape":"string", "documentation":"The header's name." }, "HeaderValue":{ "shape":"string", "documentation":"The header's value." } }, "documentation":"A complex type that contains information related to a Header" }, "OriginCustomHeadersList":{ "type":"list", "member":{ "shape":"OriginCustomHeader", "locationName":"OriginCustomHeader" } }, "OriginList":{ "type":"list", "member":{ "shape":"Origin", "locationName":"Origin" }, "min":1 }, "OriginProtocolPolicy":{ "type":"string", "enum":[ "http-only", "match-viewer", "https-only" ] }, "OriginSslProtocols":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." }, "Items":{ "shape":"SslProtocolsList", "documentation":"A complex type that contains one SslProtocol element for each SSL/TLS protocol that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." } }, "documentation":"A complex type that contains the list of SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." }, "Origins":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of origins for this distribution." }, "Items":{ "shape":"OriginList", "documentation":"A complex type that contains origins for this distribution." } }, "documentation":"A complex type that contains information about origins for this distribution." }, "PathList":{ "type":"list", "member":{ "shape":"string", "locationName":"Path" } }, "Paths":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of objects that you want to invalidate." }, "Items":{ "shape":"PathList", "documentation":"A complex type that contains a list of the objects that you want to invalidate." } }, "documentation":"A complex type that contains information about the objects that you want to invalidate." }, "PreconditionFailed":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The precondition given in one or more of the request-header fields evaluated to false.", "error":{"httpStatusCode":412}, "exception":true }, "PriceClass":{ "type":"string", "enum":[ "PriceClass_100", "PriceClass_200", "PriceClass_All" ] }, "Restrictions":{ "type":"structure", "required":["GeoRestriction"], "members":{ "GeoRestriction":{"shape":"GeoRestriction"} }, "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." }, "S3Origin":{ "type":"structure", "required":[ "DomainName", "OriginAccessIdentity" ], "members":{ "DomainName":{ "shape":"string", "documentation":"The DNS name of the S3 origin." }, "OriginAccessIdentity":{ "shape":"string", "documentation":"Your S3 origin's origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "S3OriginConfig":{ "type":"structure", "required":["OriginAccessIdentity"], "members":{ "OriginAccessIdentity":{ "shape":"string", "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "SSLSupportMethod":{ "type":"string", "enum":[ "sni-only", "vip" ] }, "Signer":{ "type":"structure", "members":{ "AwsAccountNumber":{ "shape":"string", "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." }, "KeyPairIds":{ "shape":"KeyPairIds", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." }, "SignerList":{ "type":"list", "member":{ "shape":"Signer", "locationName":"Signer" } }, "SslProtocol":{ "type":"string", "enum":[ "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2" ] }, "SslProtocolsList":{ "type":"list", "member":{ "shape":"SslProtocol", "locationName":"SslProtocol" } }, "StreamingDistribution":{ "type":"structure", "required":[ "Id", "Status", "DomainName", "ActiveTrustedSigners", "StreamingDistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." }, "Status":{ "shape":"string", "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The current configuration information for the streaming distribution." } }, "documentation":"A streaming distribution." }, "StreamingDistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionConfig":{ "type":"structure", "required":[ "CallerReference", "S3Origin", "Comment", "TrustedSigners", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the streaming distribution." }, "Logging":{ "shape":"StreamingLoggingConfig", "documentation":"A complex type that controls whether access logs are written for the streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this streaming distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." } }, "documentation":"The configuration for the streaming distribution." }, "StreamingDistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more streaming distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of streaming distributions that were created by the current AWS account." }, "Items":{ "shape":"StreamingDistributionSummaryList", "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A streaming distribution list." }, "StreamingDistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionSummary":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "DomainName", "S3Origin", "Aliases", "TrustedSigners", "Comment", "PriceClass", "Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." } }, "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." }, "StreamingDistributionSummaryList":{ "type":"list", "member":{ "shape":"StreamingDistributionSummary", "locationName":"StreamingDistributionSummary" } }, "StreamingLoggingConfig":{ "type":"structure", "required":[ "Enabled", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for this streaming distribution." }, "TooManyCacheBehaviors":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore cache behaviors for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCertificates":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore custom ssl certificates.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCloudFrontOriginAccessIdentities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCookieNamesInWhiteList":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more CNAMEs than are allowed per distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyHeadersInForwardedValues":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyInvalidationsInProgress":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyOriginCustomHeaders":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyOrigins":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore origins for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyTrustedSigners":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more trusted signers than are allowed per distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSignerDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"One or more of your trusted signers do not exist.", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." }, "Quantity":{ "shape":"integer", "documentation":"The number of trusted signers for this cache behavior." }, "Items":{ "shape":"AwsAccountNumberList", "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "UpdateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":[ "CloudFrontOriginAccessIdentityConfig", "Id" ], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The identity's configuration information.", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-13/"} }, "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update an origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "UpdateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "UpdateDistributionRequest":{ "type":"structure", "required":[ "DistributionConfig", "Id" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-13/"} }, "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update a distribution.", "payload":"DistributionConfig" }, "UpdateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "UpdateStreamingDistributionRequest":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Id" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-13/"} }, "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update a streaming distribution.", "payload":"StreamingDistributionConfig" }, "UpdateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "ViewerCertificate":{ "type":"structure", "members":{ "Certificate":{ "shape":"string", "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), you can use your own IAM or ACM certificate. For ACM, set to the ACM certificate ARN. For IAM, set to the IAM certificate identifier." }, "CertificateSource":{ "shape":"CertificateSource", "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to \"cloudfront\". If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), you can use your own IAM or ACM certificate. To use an ACM certificate, set to \"acm\" and update the Certificate to the ACM certificate ARN. To use an IAM certificate, set to \"iam\" and update the Certificate to the IAM certificate identifier." }, "SSLSupportMethod":{ "shape":"SSLSupportMethod", "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." }, "MinimumProtocolVersion":{ "shape":"MinimumProtocolVersion", "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." }, "IAMCertificateId":{ "shape":"string", "documentation":"Note: this field is deprecated. Please use \"iam\" as CertificateSource and specify the IAM certificate Id as the Certificate. If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate.", "deprecated":true }, "CloudFrontDefaultCertificate":{ "shape":"boolean", "documentation":"Note: this field is deprecated. Please use \"cloudfront\" as CertificateSource and omit specifying a Certificate. If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId.", "deprecated":true } }, "documentation":"A complex type that contains information about viewer certificates for this distribution." }, "ViewerProtocolPolicy":{ "type":"string", "enum":[ "allow-all", "https-only", "redirect-to-https" ] }, "boolean":{"type":"boolean"}, "integer":{"type":"integer"}, "long":{"type":"long"}, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} } } botocore-1.5.7/botocore/data/cloudfront/2016-01-28/0000777454262600001440000000000013042511307022347 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudfront/2016-01-28/waiters-2.json0000666454262600001440000000224013042511306025054 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DistributionDeployed": { "delay": 60, "operation": "GetDistribution", "maxAttempts": 25, "description": "Wait until a distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "Distribution.Status" } ] }, "InvalidationCompleted": { "delay": 20, "operation": "GetInvalidation", "maxAttempts": 60, "description": "Wait until an invalidation has completed.", "acceptors": [ { "expected": "Completed", "matcher": "path", "state": "success", "argument": "Invalidation.Status" } ] }, "StreamingDistributionDeployed": { "delay": 60, "operation": "GetStreamingDistribution", "maxAttempts": 25, "description": "Wait until a streaming distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "StreamingDistribution.Status" } ] } } } botocore-1.5.7/botocore/data/cloudfront/2016-01-28/paginators-1.json0000666454262600001440000000214613042511306025551 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListCloudFrontOriginAccessIdentities": { "input_token": "Marker", "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", "limit_key": "MaxItems", "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", "result_key": "CloudFrontOriginAccessIdentityList.Items" }, "ListDistributions": { "input_token": "Marker", "output_token": "DistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "DistributionList.IsTruncated", "result_key": "DistributionList.Items" }, "ListInvalidations": { "input_token": "Marker", "output_token": "InvalidationList.NextMarker", "limit_key": "MaxItems", "more_results": "InvalidationList.IsTruncated", "result_key": "InvalidationList.Items" }, "ListStreamingDistributions": { "input_token": "Marker", "output_token": "StreamingDistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "StreamingDistributionList.IsTruncated", "result_key": "StreamingDistributionList.Items" } } } botocore-1.5.7/botocore/data/cloudfront/2016-01-28/service-2.json0000666454262600001440000040442213042511306025046 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-01-28", "endpointPrefix":"cloudfront", "globalEndpoint":"cloudfront.amazonaws.com", "protocol":"rest-xml", "serviceAbbreviation":"CloudFront", "serviceFullName":"Amazon CloudFront", "signatureVersion":"v4" }, "operations":{ "CreateCloudFrontOriginAccessIdentity":{ "name":"CreateCloudFrontOriginAccessIdentity2016_01_28", "http":{ "method":"POST", "requestUri":"/2016-01-28/origin-access-identity/cloudfront", "responseCode":201 }, "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, {"shape":"MissingBody"}, {"shape":"TooManyCloudFrontOriginAccessIdentities"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new origin access identity." }, "CreateDistribution":{ "name":"CreateDistribution2016_01_28", "http":{ "method":"POST", "requestUri":"/2016-01-28/distribution", "responseCode":201 }, "input":{"shape":"CreateDistributionRequest"}, "output":{"shape":"CreateDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"DistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"MissingBody"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"TooManyDistributions"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidProtocolSettings"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"} ], "documentation":"Create a new distribution." }, "CreateInvalidation":{ "name":"CreateInvalidation2016_01_28", "http":{ "method":"POST", "requestUri":"/2016-01-28/distribution/{DistributionId}/invalidation", "responseCode":201 }, "input":{"shape":"CreateInvalidationRequest"}, "output":{"shape":"CreateInvalidationResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"MissingBody"}, {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"BatchTooLarge"}, {"shape":"TooManyInvalidationsInProgress"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new invalidation." }, "CreateStreamingDistribution":{ "name":"CreateStreamingDistribution2016_01_28", "http":{ "method":"POST", "requestUri":"/2016-01-28/streaming-distribution", "responseCode":201 }, "input":{"shape":"CreateStreamingDistributionRequest"}, "output":{"shape":"CreateStreamingDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"StreamingDistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"MissingBody"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"TooManyStreamingDistributions"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new streaming distribution." }, "DeleteCloudFrontOriginAccessIdentity":{ "name":"DeleteCloudFrontOriginAccessIdentity2016_01_28", "http":{ "method":"DELETE", "requestUri":"/2016-01-28/origin-access-identity/cloudfront/{Id}", "responseCode":204 }, "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"PreconditionFailed"}, {"shape":"CloudFrontOriginAccessIdentityInUse"} ], "documentation":"Delete an origin access identity." }, "DeleteDistribution":{ "name":"DeleteDistribution2016_01_28", "http":{ "method":"DELETE", "requestUri":"/2016-01-28/distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"DistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"Delete a distribution." }, "DeleteStreamingDistribution":{ "name":"DeleteStreamingDistribution2016_01_28", "http":{ "method":"DELETE", "requestUri":"/2016-01-28/streaming-distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteStreamingDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"StreamingDistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"Delete a streaming distribution." }, "GetCloudFrontOriginAccessIdentity":{ "name":"GetCloudFrontOriginAccessIdentity2016_01_28", "http":{ "method":"GET", "requestUri":"/2016-01-28/origin-access-identity/cloudfront/{Id}" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about an origin access identity." }, "GetCloudFrontOriginAccessIdentityConfig":{ "name":"GetCloudFrontOriginAccessIdentityConfig2016_01_28", "http":{ "method":"GET", "requestUri":"/2016-01-28/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about an origin access identity." }, "GetDistribution":{ "name":"GetDistribution2016_01_28", "http":{ "method":"GET", "requestUri":"/2016-01-28/distribution/{Id}" }, "input":{"shape":"GetDistributionRequest"}, "output":{"shape":"GetDistributionResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about a distribution." }, "GetDistributionConfig":{ "name":"GetDistributionConfig2016_01_28", "http":{ "method":"GET", "requestUri":"/2016-01-28/distribution/{Id}/config" }, "input":{"shape":"GetDistributionConfigRequest"}, "output":{"shape":"GetDistributionConfigResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about a distribution." }, "GetInvalidation":{ "name":"GetInvalidation2016_01_28", "http":{ "method":"GET", "requestUri":"/2016-01-28/distribution/{DistributionId}/invalidation/{Id}" }, "input":{"shape":"GetInvalidationRequest"}, "output":{"shape":"GetInvalidationResult"}, "errors":[ {"shape":"NoSuchInvalidation"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about an invalidation." }, "GetStreamingDistribution":{ "name":"GetStreamingDistribution2016_01_28", "http":{ "method":"GET", "requestUri":"/2016-01-28/streaming-distribution/{Id}" }, "input":{"shape":"GetStreamingDistributionRequest"}, "output":{"shape":"GetStreamingDistributionResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about a streaming distribution." }, "GetStreamingDistributionConfig":{ "name":"GetStreamingDistributionConfig2016_01_28", "http":{ "method":"GET", "requestUri":"/2016-01-28/streaming-distribution/{Id}/config" }, "input":{"shape":"GetStreamingDistributionConfigRequest"}, "output":{"shape":"GetStreamingDistributionConfigResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about a streaming distribution." }, "ListCloudFrontOriginAccessIdentities":{ "name":"ListCloudFrontOriginAccessIdentities2016_01_28", "http":{ "method":"GET", "requestUri":"/2016-01-28/origin-access-identity/cloudfront" }, "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List origin access identities." }, "ListDistributions":{ "name":"ListDistributions2016_01_28", "http":{ "method":"GET", "requestUri":"/2016-01-28/distribution" }, "input":{"shape":"ListDistributionsRequest"}, "output":{"shape":"ListDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List distributions." }, "ListDistributionsByWebACLId":{ "name":"ListDistributionsByWebACLId2016_01_28", "http":{ "method":"GET", "requestUri":"/2016-01-28/distributionsByWebACLId/{WebACLId}" }, "input":{"shape":"ListDistributionsByWebACLIdRequest"}, "output":{"shape":"ListDistributionsByWebACLIdResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"InvalidWebACLId"} ], "documentation":"List the distributions that are associated with a specified AWS WAF web ACL." }, "ListInvalidations":{ "name":"ListInvalidations2016_01_28", "http":{ "method":"GET", "requestUri":"/2016-01-28/distribution/{DistributionId}/invalidation" }, "input":{"shape":"ListInvalidationsRequest"}, "output":{"shape":"ListInvalidationsResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"List invalidation batches." }, "ListStreamingDistributions":{ "name":"ListStreamingDistributions2016_01_28", "http":{ "method":"GET", "requestUri":"/2016-01-28/streaming-distribution" }, "input":{"shape":"ListStreamingDistributionsRequest"}, "output":{"shape":"ListStreamingDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List streaming distributions." }, "UpdateCloudFrontOriginAccessIdentity":{ "name":"UpdateCloudFrontOriginAccessIdentity2016_01_28", "http":{ "method":"PUT", "requestUri":"/2016-01-28/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"PreconditionFailed"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Update an origin access identity." }, "UpdateDistribution":{ "name":"UpdateDistribution2016_01_28", "http":{ "method":"PUT", "requestUri":"/2016-01-28/distribution/{Id}/config" }, "input":{"shape":"UpdateDistributionRequest"}, "output":{"shape":"UpdateDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"} ], "documentation":"Update a distribution." }, "UpdateStreamingDistribution":{ "name":"UpdateStreamingDistribution2016_01_28", "http":{ "method":"PUT", "requestUri":"/2016-01-28/streaming-distribution/{Id}/config" }, "input":{"shape":"UpdateStreamingDistributionRequest"}, "output":{"shape":"UpdateStreamingDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InconsistentQuantities"} ], "documentation":"Update a streaming distribution." } }, "shapes":{ "AccessDenied":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Access denied.", "error":{"httpStatusCode":403}, "exception":true }, "ActiveTrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Each active trusted signer." }, "Quantity":{ "shape":"integer", "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." }, "Items":{ "shape":"SignerList", "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." } }, "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." }, "AliasList":{ "type":"list", "member":{ "shape":"string", "locationName":"CNAME" } }, "Aliases":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of CNAMEs, if any, for this distribution." }, "Items":{ "shape":"AliasList", "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "AllowedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." }, "CachedMethods":{"shape":"CachedMethods"} }, "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." }, "AwsAccountNumberList":{ "type":"list", "member":{ "shape":"string", "locationName":"AwsAccountNumber" } }, "BatchTooLarge":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":413}, "exception":true }, "CNAMEAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CacheBehavior":{ "type":"structure", "required":[ "PathPattern", "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "PathPattern":{ "shape":"string", "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." }, "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "DefaultTTL":{ "shape":"long", "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "MaxTTL":{ "shape":"long", "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "Compress":{ "shape":"boolean", "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." } }, "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." }, "CacheBehaviorList":{ "type":"list", "member":{ "shape":"CacheBehavior", "locationName":"CacheBehavior" } }, "CacheBehaviors":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of cache behaviors for this distribution." }, "Items":{ "shape":"CacheBehaviorList", "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CachedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." } }, "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." }, "CertificateSource":{ "type":"string", "enum":[ "cloudfront", "iam", "acm" ] }, "CloudFrontOriginAccessIdentity":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The current configuration information for the identity." } }, "documentation":"CloudFront origin access identity." }, "CloudFrontOriginAccessIdentityAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.", "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityConfig":{ "type":"structure", "required":[ "CallerReference", "Comment" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the origin access identity." } }, "documentation":"Origin access identity configuration." }, "CloudFrontOriginAccessIdentityInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more origin access identities remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." }, "Items":{ "shape":"CloudFrontOriginAccessIdentitySummaryList", "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." } }, "documentation":"The CloudFrontOriginAccessIdentityList type." }, "CloudFrontOriginAccessIdentitySummary":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId", "Comment" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "Comment":{ "shape":"string", "documentation":"The comment for this origin access identity, as originally specified when created." } }, "documentation":"Summary of the information about a CloudFront origin access identity." }, "CloudFrontOriginAccessIdentitySummaryList":{ "type":"list", "member":{ "shape":"CloudFrontOriginAccessIdentitySummary", "locationName":"CloudFrontOriginAccessIdentitySummary" } }, "CookieNameList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "CookieNames":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of whitelisted cookies for this cache behavior." }, "Items":{ "shape":"CookieNameList", "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." }, "CookiePreference":{ "type":"structure", "required":["Forward"], "members":{ "Forward":{ "shape":"ItemSelection", "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." }, "WhitelistedNames":{ "shape":"CookieNames", "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." } }, "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." }, "CreateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["CloudFrontOriginAccessIdentityConfig"], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information.", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-28/"} } }, "documentation":"The request to create a new origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "CreateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the origin access identity created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "CreateDistributionRequest":{ "type":"structure", "required":["DistributionConfig"], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-28/"} } }, "documentation":"The request to create a new distribution.", "payload":"DistributionConfig" }, "CreateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "CreateInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "InvalidationBatch" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The batch information for the invalidation.", "locationName":"InvalidationBatch", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-28/"} } }, "documentation":"The request to create an invalidation.", "payload":"InvalidationBatch" }, "CreateInvalidationResult":{ "type":"structure", "members":{ "Location":{ "shape":"string", "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.", "location":"header", "locationName":"Location" }, "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "CreateStreamingDistributionRequest":{ "type":"structure", "required":["StreamingDistributionConfig"], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-28/"} } }, "documentation":"The request to create a new streaming distribution.", "payload":"StreamingDistributionConfig" }, "CreateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "CustomErrorResponse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{ "shape":"integer", "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." }, "ResponsePagePath":{ "shape":"string", "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." }, "ResponseCode":{ "shape":"string", "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." }, "ErrorCachingMinTTL":{ "shape":"long", "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." } }, "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." }, "CustomErrorResponseList":{ "type":"list", "member":{ "shape":"CustomErrorResponse", "locationName":"CustomErrorResponse" } }, "CustomErrorResponses":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom error responses for this distribution." }, "Items":{ "shape":"CustomErrorResponseList", "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "CustomHeaders":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom headers for this origin." }, "Items":{ "shape":"OriginCustomHeadersList", "documentation":"A complex type that contains the custom headers for this Origin." } }, "documentation":"A complex type that contains the list of Custom Headers for each origin." }, "CustomOriginConfig":{ "type":"structure", "required":[ "HTTPPort", "HTTPSPort", "OriginProtocolPolicy" ], "members":{ "HTTPPort":{ "shape":"integer", "documentation":"The HTTP port the custom origin listens on." }, "HTTPSPort":{ "shape":"integer", "documentation":"The HTTPS port the custom origin listens on." }, "OriginProtocolPolicy":{ "shape":"OriginProtocolPolicy", "documentation":"The origin protocol policy to apply to your origin." }, "OriginSslProtocols":{ "shape":"OriginSslProtocols", "documentation":"The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." } }, "documentation":"A customer origin." }, "DefaultCacheBehavior":{ "type":"structure", "required":[ "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "DefaultTTL":{ "shape":"long", "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "MaxTTL":{ "shape":"long", "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "Compress":{ "shape":"boolean", "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." } }, "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "DeleteCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The origin access identity's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a origin access identity." }, "DeleteDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a distribution." }, "DeleteStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a streaming distribution." }, "Distribution":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "InProgressInvalidationBatches", "DomainName", "ActiveTrustedSigners", "DistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "InProgressInvalidationBatches":{ "shape":"integer", "documentation":"The number of invalidation batches currently in progress." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The current configuration information for the distribution." } }, "documentation":"A distribution." }, "DistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution.", "error":{"httpStatusCode":409}, "exception":true }, "DistributionConfig":{ "type":"structure", "required":[ "CallerReference", "Origins", "DefaultCacheBehavior", "Comment", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "DefaultRootObject":{ "shape":"string", "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the distribution." }, "Logging":{ "shape":"LoggingConfig", "documentation":"A complex type that controls whether access logs are written for the distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"(Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution." } }, "documentation":"A distribution Configuration." }, "DistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of distributions that were created by the current AWS account." }, "Items":{ "shape":"DistributionSummaryList", "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A distribution list." }, "DistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "DistributionSummary":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "DomainName", "Aliases", "Origins", "DefaultCacheBehavior", "CacheBehaviors", "CustomErrorResponses", "Comment", "PriceClass", "Enabled", "ViewerCertificate", "Restrictions", "WebACLId" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponses elements." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"The Web ACL Id (if any) associated with the distribution." } }, "documentation":"A summary of the information for an Amazon CloudFront distribution." }, "DistributionSummaryList":{ "type":"list", "member":{ "shape":"DistributionSummary", "locationName":"DistributionSummary" } }, "ForwardedValues":{ "type":"structure", "required":[ "QueryString", "Cookies" ], "members":{ "QueryString":{ "shape":"boolean", "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "Cookies":{ "shape":"CookiePreference", "documentation":"A complex type that specifies how CloudFront handles cookies." }, "Headers":{ "shape":"Headers", "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." } }, "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "GeoRestriction":{ "type":"structure", "required":[ "RestrictionType", "Quantity" ], "members":{ "RestrictionType":{ "shape":"GeoRestrictionType", "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." }, "Quantity":{ "shape":"integer", "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." }, "Items":{ "shape":"LocationList", "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." } }, "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." }, "GeoRestrictionType":{ "type":"string", "enum":[ "blacklist", "whitelist", "none" ] }, "GetCloudFrontOriginAccessIdentityConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an origin access identity's configuration." }, "GetCloudFrontOriginAccessIdentityConfigResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "GetCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an origin access identity's information." }, "GetCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "GetDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a distribution configuration." }, "GetDistributionConfigResult":{ "type":"structure", "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionConfig" }, "GetDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a distribution's information." }, "GetDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "GetInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "Id" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "Id":{ "shape":"string", "documentation":"The invalidation's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an invalidation's information." }, "GetInvalidationResult":{ "type":"structure", "members":{ "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "GetStreamingDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"To request to get a streaming distribution configuration." }, "GetStreamingDistributionConfigResult":{ "type":"structure", "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionConfig" }, "GetStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a streaming distribution's information." }, "GetStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "HeaderList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "Headers":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." }, "Items":{ "shape":"HeaderList", "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." } }, "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." }, "IllegalUpdate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Origin and CallerReference cannot be updated.", "error":{"httpStatusCode":400}, "exception":true }, "InconsistentQuantities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The value of Quantity and the size of Items do not match.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidArgument":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The argument is invalid.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidDefaultRootObject":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The default root object file name is too big or contains an invalid character.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidErrorCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidForwardCookies":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidGeoRestrictionParameter":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidHeadersForS3Origin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidIfMatchVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The If-Match version is missing or not valid for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidLocationCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidMinimumProtocolVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The origin access identity is not valid or doesn't exist.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidProtocolSettings":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI).", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRelativePath":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/).", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRequiredProtocol":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"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.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidResponseCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidTTLOrder":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidViewerCertificate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidWebACLId":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "Invalidation":{ "type":"structure", "required":[ "Id", "Status", "CreateTime", "InvalidationBatch" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." }, "CreateTime":{ "shape":"timestamp", "documentation":"The date and time the invalidation request was first made." }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The current invalidation information for the batch request." } }, "documentation":"An invalidation." }, "InvalidationBatch":{ "type":"structure", "required":[ "Paths", "CallerReference" ], "members":{ "Paths":{ "shape":"Paths", "documentation":"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. 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. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." }, "CallerReference":{ "shape":"string", "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. 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, the response includes the same information returned to the original request. 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, CloudFront returns an InvalidationBatchAlreadyExists error." } }, "documentation":"An invalidation batch." }, "InvalidationList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of invalidation batches that were created by the current AWS account." }, "Items":{ "shape":"InvalidationSummaryList", "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." } }, "documentation":"An invalidation list." }, "InvalidationSummary":{ "type":"structure", "required":[ "Id", "CreateTime", "Status" ], "members":{ "Id":{ "shape":"string", "documentation":"The unique ID for an invalidation request." }, "CreateTime":{"shape":"timestamp"}, "Status":{ "shape":"string", "documentation":"The status of an invalidation request." } }, "documentation":"Summary of an invalidation request." }, "InvalidationSummaryList":{ "type":"list", "member":{ "shape":"InvalidationSummary", "locationName":"InvalidationSummary" } }, "ItemSelection":{ "type":"string", "enum":[ "none", "whitelist", "all" ] }, "KeyPairIdList":{ "type":"list", "member":{ "shape":"string", "locationName":"KeyPairId" } }, "KeyPairIds":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." }, "Items":{ "shape":"KeyPairIdList", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." }, "ListCloudFrontOriginAccessIdentitiesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"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. 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).", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of origin access identities you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list origin access identities." }, "ListCloudFrontOriginAccessIdentitiesResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityList":{ "shape":"CloudFrontOriginAccessIdentityList", "documentation":"The CloudFrontOriginAccessIdentityList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityList" }, "ListDistributionsByWebACLIdRequest":{ "type":"structure", "required":["WebACLId"], "members":{ "Marker":{ "shape":"string", "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", "location":"querystring", "locationName":"MaxItems" }, "WebACLId":{ "shape":"string", "documentation":"The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify \"null\" for the Id, the request returns a list of the distributions that aren't associated with a web ACL.", "location":"uri", "locationName":"WebACLId" } }, "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL." }, "ListDistributionsByWebACLIdResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.", "payload":"DistributionList" }, "ListDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list your distributions." }, "ListDistributionsResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionList" }, "ListInvalidationsRequest":{ "type":"structure", "required":["DistributionId"], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "Marker":{ "shape":"string", "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. 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. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of invalidation batches you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list invalidations." }, "ListInvalidationsResult":{ "type":"structure", "members":{ "InvalidationList":{ "shape":"InvalidationList", "documentation":"Information about invalidation batches." } }, "documentation":"The returned result of the corresponding request.", "payload":"InvalidationList" }, "ListStreamingDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"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. 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).", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of streaming distributions you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list your streaming distributions." }, "ListStreamingDistributionsResult":{ "type":"structure", "members":{ "StreamingDistributionList":{ "shape":"StreamingDistributionList", "documentation":"The StreamingDistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionList" }, "LocationList":{ "type":"list", "member":{ "shape":"string", "locationName":"Location" } }, "LoggingConfig":{ "type":"structure", "required":[ "Enabled", "IncludeCookies", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." }, "IncludeCookies":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for the distribution." }, "Method":{ "type":"string", "enum":[ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ] }, "MethodsList":{ "type":"list", "member":{ "shape":"Method", "locationName":"Method" } }, "MinimumProtocolVersion":{ "type":"string", "enum":[ "SSLv3", "TLSv1" ] }, "MissingBody":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set.", "error":{"httpStatusCode":400}, "exception":true }, "NoSuchCloudFrontOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified origin access identity does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified distribution does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchInvalidation":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified invalidation does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"No origin exists with the specified Origin Id.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchStreamingDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified streaming distribution does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "Origin":{ "type":"structure", "required":[ "Id", "DomainName" ], "members":{ "Id":{ "shape":"string", "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." }, "DomainName":{ "shape":"string", "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." }, "OriginPath":{ "shape":"string", "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." }, "CustomHeaders":{ "shape":"CustomHeaders", "documentation":"A complex type that contains information about the custom headers associated with this Origin." }, "S3OriginConfig":{ "shape":"S3OriginConfig", "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "CustomOriginConfig":{ "shape":"CustomOriginConfig", "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." } }, "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." }, "OriginCustomHeader":{ "type":"structure", "required":[ "HeaderName", "HeaderValue" ], "members":{ "HeaderName":{ "shape":"string", "documentation":"The header's name." }, "HeaderValue":{ "shape":"string", "documentation":"The header's value." } }, "documentation":"A complex type that contains information related to a Header" }, "OriginCustomHeadersList":{ "type":"list", "member":{ "shape":"OriginCustomHeader", "locationName":"OriginCustomHeader" } }, "OriginList":{ "type":"list", "member":{ "shape":"Origin", "locationName":"Origin" }, "min":1 }, "OriginProtocolPolicy":{ "type":"string", "enum":[ "http-only", "match-viewer", "https-only" ] }, "OriginSslProtocols":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." }, "Items":{ "shape":"SslProtocolsList", "documentation":"A complex type that contains one SslProtocol element for each SSL/TLS protocol that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." } }, "documentation":"A complex type that contains the list of SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." }, "Origins":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of origins for this distribution." }, "Items":{ "shape":"OriginList", "documentation":"A complex type that contains origins for this distribution." } }, "documentation":"A complex type that contains information about origins for this distribution." }, "PathList":{ "type":"list", "member":{ "shape":"string", "locationName":"Path" } }, "Paths":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of objects that you want to invalidate." }, "Items":{ "shape":"PathList", "documentation":"A complex type that contains a list of the objects that you want to invalidate." } }, "documentation":"A complex type that contains information about the objects that you want to invalidate." }, "PreconditionFailed":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The precondition given in one or more of the request-header fields evaluated to false.", "error":{"httpStatusCode":412}, "exception":true }, "PriceClass":{ "type":"string", "enum":[ "PriceClass_100", "PriceClass_200", "PriceClass_All" ] }, "Restrictions":{ "type":"structure", "required":["GeoRestriction"], "members":{ "GeoRestriction":{"shape":"GeoRestriction"} }, "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." }, "S3Origin":{ "type":"structure", "required":[ "DomainName", "OriginAccessIdentity" ], "members":{ "DomainName":{ "shape":"string", "documentation":"The DNS name of the S3 origin." }, "OriginAccessIdentity":{ "shape":"string", "documentation":"Your S3 origin's origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "S3OriginConfig":{ "type":"structure", "required":["OriginAccessIdentity"], "members":{ "OriginAccessIdentity":{ "shape":"string", "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "SSLSupportMethod":{ "type":"string", "enum":[ "sni-only", "vip" ] }, "Signer":{ "type":"structure", "members":{ "AwsAccountNumber":{ "shape":"string", "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." }, "KeyPairIds":{ "shape":"KeyPairIds", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." }, "SignerList":{ "type":"list", "member":{ "shape":"Signer", "locationName":"Signer" } }, "SslProtocol":{ "type":"string", "enum":[ "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2" ] }, "SslProtocolsList":{ "type":"list", "member":{ "shape":"SslProtocol", "locationName":"SslProtocol" } }, "StreamingDistribution":{ "type":"structure", "required":[ "Id", "Status", "DomainName", "ActiveTrustedSigners", "StreamingDistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." }, "Status":{ "shape":"string", "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The current configuration information for the streaming distribution." } }, "documentation":"A streaming distribution." }, "StreamingDistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionConfig":{ "type":"structure", "required":[ "CallerReference", "S3Origin", "Comment", "TrustedSigners", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the streaming distribution." }, "Logging":{ "shape":"StreamingLoggingConfig", "documentation":"A complex type that controls whether access logs are written for the streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this streaming distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." } }, "documentation":"The configuration for the streaming distribution." }, "StreamingDistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more streaming distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of streaming distributions that were created by the current AWS account." }, "Items":{ "shape":"StreamingDistributionSummaryList", "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A streaming distribution list." }, "StreamingDistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionSummary":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "DomainName", "S3Origin", "Aliases", "TrustedSigners", "Comment", "PriceClass", "Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." } }, "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." }, "StreamingDistributionSummaryList":{ "type":"list", "member":{ "shape":"StreamingDistributionSummary", "locationName":"StreamingDistributionSummary" } }, "StreamingLoggingConfig":{ "type":"structure", "required":[ "Enabled", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for this streaming distribution." }, "TooManyCacheBehaviors":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore cache behaviors for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCertificates":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore custom ssl certificates.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCloudFrontOriginAccessIdentities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCookieNamesInWhiteList":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more CNAMEs than are allowed per distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyHeadersInForwardedValues":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyInvalidationsInProgress":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyOriginCustomHeaders":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyOrigins":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore origins for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyTrustedSigners":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more trusted signers than are allowed per distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSignerDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"One or more of your trusted signers do not exist.", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." }, "Quantity":{ "shape":"integer", "documentation":"The number of trusted signers for this cache behavior." }, "Items":{ "shape":"AwsAccountNumberList", "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "UpdateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":[ "CloudFrontOriginAccessIdentityConfig", "Id" ], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The identity's configuration information.", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-28/"} }, "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update an origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "UpdateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "UpdateDistributionRequest":{ "type":"structure", "required":[ "DistributionConfig", "Id" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-28/"} }, "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update a distribution.", "payload":"DistributionConfig" }, "UpdateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "UpdateStreamingDistributionRequest":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Id" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-28/"} }, "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update a streaming distribution.", "payload":"StreamingDistributionConfig" }, "UpdateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "ViewerCertificate":{ "type":"structure", "members":{ "CloudFrontDefaultCertificate":{ "shape":"boolean", "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an ACMCertificateArn or IAMCertificateId." }, "IAMCertificateId":{ "shape":"string", "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value, ACMCertificateArn, or CloudFrontDefaultCertificate." }, "ACMCertificateArn":{ "shape":"string", "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the ACM certificate ARN of the custom viewer certificate for this distribution. Specify either this value, IAMCertificateId, or CloudFrontDefaultCertificate." }, "SSLSupportMethod":{ "shape":"SSLSupportMethod", "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." }, "MinimumProtocolVersion":{ "shape":"MinimumProtocolVersion", "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." }, "Certificate":{ "shape":"string", "documentation":"Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].", "deprecated":true }, "CertificateSource":{ "shape":"CertificateSource", "documentation":"Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].", "deprecated":true } }, "documentation":"A complex type that contains information about viewer certificates for this distribution." }, "ViewerProtocolPolicy":{ "type":"string", "enum":[ "allow-all", "https-only", "redirect-to-https" ] }, "boolean":{"type":"boolean"}, "integer":{"type":"integer"}, "long":{"type":"long"}, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} } } botocore-1.5.7/botocore/data/cloudfront/2016-08-01/0000777454262600001440000000000013042511307022345 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudfront/2016-08-01/waiters-2.json0000666454262600001440000000224013042511306025052 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DistributionDeployed": { "delay": 60, "operation": "GetDistribution", "maxAttempts": 25, "description": "Wait until a distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "Distribution.Status" } ] }, "InvalidationCompleted": { "delay": 20, "operation": "GetInvalidation", "maxAttempts": 60, "description": "Wait until an invalidation has completed.", "acceptors": [ { "expected": "Completed", "matcher": "path", "state": "success", "argument": "Invalidation.Status" } ] }, "StreamingDistributionDeployed": { "delay": 60, "operation": "GetStreamingDistribution", "maxAttempts": 25, "description": "Wait until a streaming distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "StreamingDistribution.Status" } ] } } } botocore-1.5.7/botocore/data/cloudfront/2016-08-01/paginators-1.json0000666454262600001440000000214613042511306025547 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListCloudFrontOriginAccessIdentities": { "input_token": "Marker", "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", "limit_key": "MaxItems", "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", "result_key": "CloudFrontOriginAccessIdentityList.Items" }, "ListDistributions": { "input_token": "Marker", "output_token": "DistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "DistributionList.IsTruncated", "result_key": "DistributionList.Items" }, "ListInvalidations": { "input_token": "Marker", "output_token": "InvalidationList.NextMarker", "limit_key": "MaxItems", "more_results": "InvalidationList.IsTruncated", "result_key": "InvalidationList.Items" }, "ListStreamingDistributions": { "input_token": "Marker", "output_token": "StreamingDistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "StreamingDistributionList.IsTruncated", "result_key": "StreamingDistributionList.Items" } } } botocore-1.5.7/botocore/data/cloudfront/2016-08-01/service-2.json0000666454262600001440000044160213042511306025045 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-08-01", "endpointPrefix":"cloudfront", "globalEndpoint":"cloudfront.amazonaws.com", "protocol":"rest-xml", "serviceAbbreviation":"CloudFront", "serviceFullName":"Amazon CloudFront", "signatureVersion":"v4" }, "operations":{ "CreateCloudFrontOriginAccessIdentity":{ "name":"CreateCloudFrontOriginAccessIdentity2016_08_01", "http":{ "method":"POST", "requestUri":"/2016-08-01/origin-access-identity/cloudfront", "responseCode":201 }, "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, {"shape":"MissingBody"}, {"shape":"TooManyCloudFrontOriginAccessIdentities"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new origin access identity." }, "CreateDistribution":{ "name":"CreateDistribution2016_08_01", "http":{ "method":"POST", "requestUri":"/2016-08-01/distribution", "responseCode":201 }, "input":{"shape":"CreateDistributionRequest"}, "output":{"shape":"CreateDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"DistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"MissingBody"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"TooManyDistributions"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidProtocolSettings"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"} ], "documentation":"Create a new distribution." }, "CreateDistributionWithTags":{ "name":"CreateDistributionWithTags2016_08_01", "http":{ "method":"POST", "requestUri":"/2016-08-01/distribution?WithTags", "responseCode":201 }, "input":{"shape":"CreateDistributionWithTagsRequest"}, "output":{"shape":"CreateDistributionWithTagsResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"DistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"MissingBody"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"TooManyDistributions"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidProtocolSettings"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"}, {"shape":"InvalidTagging"} ], "documentation":"Create a new distribution with tags." }, "CreateInvalidation":{ "name":"CreateInvalidation2016_08_01", "http":{ "method":"POST", "requestUri":"/2016-08-01/distribution/{DistributionId}/invalidation", "responseCode":201 }, "input":{"shape":"CreateInvalidationRequest"}, "output":{"shape":"CreateInvalidationResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"MissingBody"}, {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"BatchTooLarge"}, {"shape":"TooManyInvalidationsInProgress"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new invalidation." }, "CreateStreamingDistribution":{ "name":"CreateStreamingDistribution2016_08_01", "http":{ "method":"POST", "requestUri":"/2016-08-01/streaming-distribution", "responseCode":201 }, "input":{"shape":"CreateStreamingDistributionRequest"}, "output":{"shape":"CreateStreamingDistributionResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"StreamingDistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"MissingBody"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"TooManyStreamingDistributions"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Create a new streaming distribution." }, "CreateStreamingDistributionWithTags":{ "name":"CreateStreamingDistributionWithTags2016_08_01", "http":{ "method":"POST", "requestUri":"/2016-08-01/streaming-distribution?WithTags", "responseCode":201 }, "input":{"shape":"CreateStreamingDistributionWithTagsRequest"}, "output":{"shape":"CreateStreamingDistributionWithTagsResult"}, "errors":[ {"shape":"CNAMEAlreadyExists"}, {"shape":"StreamingDistributionAlreadyExists"}, {"shape":"InvalidOrigin"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"AccessDenied"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"MissingBody"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"TooManyStreamingDistributions"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"}, {"shape":"InvalidTagging"} ], "documentation":"Create a new streaming distribution with tags." }, "DeleteCloudFrontOriginAccessIdentity":{ "name":"DeleteCloudFrontOriginAccessIdentity2016_08_01", "http":{ "method":"DELETE", "requestUri":"/2016-08-01/origin-access-identity/cloudfront/{Id}", "responseCode":204 }, "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"PreconditionFailed"}, {"shape":"CloudFrontOriginAccessIdentityInUse"} ], "documentation":"Delete an origin access identity." }, "DeleteDistribution":{ "name":"DeleteDistribution2016_08_01", "http":{ "method":"DELETE", "requestUri":"/2016-08-01/distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"DistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"Delete a distribution." }, "DeleteStreamingDistribution":{ "name":"DeleteStreamingDistribution2016_08_01", "http":{ "method":"DELETE", "requestUri":"/2016-08-01/streaming-distribution/{Id}", "responseCode":204 }, "input":{"shape":"DeleteStreamingDistributionRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"StreamingDistributionNotDisabled"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"} ], "documentation":"Delete a streaming distribution." }, "GetCloudFrontOriginAccessIdentity":{ "name":"GetCloudFrontOriginAccessIdentity2016_08_01", "http":{ "method":"GET", "requestUri":"/2016-08-01/origin-access-identity/cloudfront/{Id}" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about an origin access identity." }, "GetCloudFrontOriginAccessIdentityConfig":{ "name":"GetCloudFrontOriginAccessIdentityConfig2016_08_01", "http":{ "method":"GET", "requestUri":"/2016-08-01/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, "errors":[ {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about an origin access identity." }, "GetDistribution":{ "name":"GetDistribution2016_08_01", "http":{ "method":"GET", "requestUri":"/2016-08-01/distribution/{Id}" }, "input":{"shape":"GetDistributionRequest"}, "output":{"shape":"GetDistributionResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about a distribution." }, "GetDistributionConfig":{ "name":"GetDistributionConfig2016_08_01", "http":{ "method":"GET", "requestUri":"/2016-08-01/distribution/{Id}/config" }, "input":{"shape":"GetDistributionConfigRequest"}, "output":{"shape":"GetDistributionConfigResult"}, "errors":[ {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about a distribution." }, "GetInvalidation":{ "name":"GetInvalidation2016_08_01", "http":{ "method":"GET", "requestUri":"/2016-08-01/distribution/{DistributionId}/invalidation/{Id}" }, "input":{"shape":"GetInvalidationRequest"}, "output":{"shape":"GetInvalidationResult"}, "errors":[ {"shape":"NoSuchInvalidation"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about an invalidation." }, "GetStreamingDistribution":{ "name":"GetStreamingDistribution2016_08_01", "http":{ "method":"GET", "requestUri":"/2016-08-01/streaming-distribution/{Id}" }, "input":{"shape":"GetStreamingDistributionRequest"}, "output":{"shape":"GetStreamingDistributionResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the information about a streaming distribution." }, "GetStreamingDistributionConfig":{ "name":"GetStreamingDistributionConfig2016_08_01", "http":{ "method":"GET", "requestUri":"/2016-08-01/streaming-distribution/{Id}/config" }, "input":{"shape":"GetStreamingDistributionConfigRequest"}, "output":{"shape":"GetStreamingDistributionConfigResult"}, "errors":[ {"shape":"NoSuchStreamingDistribution"}, {"shape":"AccessDenied"} ], "documentation":"Get the configuration information about a streaming distribution." }, "ListCloudFrontOriginAccessIdentities":{ "name":"ListCloudFrontOriginAccessIdentities2016_08_01", "http":{ "method":"GET", "requestUri":"/2016-08-01/origin-access-identity/cloudfront" }, "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List origin access identities." }, "ListDistributions":{ "name":"ListDistributions2016_08_01", "http":{ "method":"GET", "requestUri":"/2016-08-01/distribution" }, "input":{"shape":"ListDistributionsRequest"}, "output":{"shape":"ListDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List distributions." }, "ListDistributionsByWebACLId":{ "name":"ListDistributionsByWebACLId2016_08_01", "http":{ "method":"GET", "requestUri":"/2016-08-01/distributionsByWebACLId/{WebACLId}" }, "input":{"shape":"ListDistributionsByWebACLIdRequest"}, "output":{"shape":"ListDistributionsByWebACLIdResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"InvalidWebACLId"} ], "documentation":"List the distributions that are associated with a specified AWS WAF web ACL." }, "ListInvalidations":{ "name":"ListInvalidations2016_08_01", "http":{ "method":"GET", "requestUri":"/2016-08-01/distribution/{DistributionId}/invalidation" }, "input":{"shape":"ListInvalidationsRequest"}, "output":{"shape":"ListInvalidationsResult"}, "errors":[ {"shape":"InvalidArgument"}, {"shape":"NoSuchDistribution"}, {"shape":"AccessDenied"} ], "documentation":"List invalidation batches." }, "ListStreamingDistributions":{ "name":"ListStreamingDistributions2016_08_01", "http":{ "method":"GET", "requestUri":"/2016-08-01/streaming-distribution" }, "input":{"shape":"ListStreamingDistributionsRequest"}, "output":{"shape":"ListStreamingDistributionsResult"}, "errors":[ {"shape":"InvalidArgument"} ], "documentation":"List streaming distributions." }, "ListTagsForResource":{ "name":"ListTagsForResource2016_08_01", "http":{ "method":"GET", "requestUri":"/2016-08-01/tagging" }, "input":{"shape":"ListTagsForResourceRequest"}, "output":{"shape":"ListTagsForResourceResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"List tags for a CloudFront resource." }, "TagResource":{ "name":"TagResource2016_08_01", "http":{ "method":"POST", "requestUri":"/2016-08-01/tagging?Operation=Tag", "responseCode":204 }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"Add tags to a CloudFront resource." }, "UntagResource":{ "name":"UntagResource2016_08_01", "http":{ "method":"POST", "requestUri":"/2016-08-01/tagging?Operation=Untag", "responseCode":204 }, "input":{"shape":"UntagResourceRequest"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"InvalidArgument"}, {"shape":"InvalidTagging"}, {"shape":"NoSuchResource"} ], "documentation":"Remove tags from a CloudFront resource." }, "UpdateCloudFrontOriginAccessIdentity":{ "name":"UpdateCloudFrontOriginAccessIdentity2016_08_01", "http":{ "method":"PUT", "requestUri":"/2016-08-01/origin-access-identity/cloudfront/{Id}/config" }, "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, {"shape":"PreconditionFailed"}, {"shape":"InvalidArgument"}, {"shape":"InconsistentQuantities"} ], "documentation":"Update an origin access identity." }, "UpdateDistribution":{ "name":"UpdateDistribution2016_08_01", "http":{ "method":"PUT", "requestUri":"/2016-08-01/distribution/{Id}/config" }, "input":{"shape":"UpdateDistributionRequest"}, "output":{"shape":"UpdateDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyDistributionCNAMEs"}, {"shape":"InvalidDefaultRootObject"}, {"shape":"InvalidRelativePath"}, {"shape":"InvalidErrorCode"}, {"shape":"InvalidResponseCode"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InvalidViewerCertificate"}, {"shape":"InvalidMinimumProtocolVersion"}, {"shape":"InvalidRequiredProtocol"}, {"shape":"NoSuchOrigin"}, {"shape":"TooManyOrigins"}, {"shape":"TooManyCacheBehaviors"}, {"shape":"TooManyCookieNamesInWhiteList"}, {"shape":"InvalidForwardCookies"}, {"shape":"TooManyHeadersInForwardedValues"}, {"shape":"InvalidHeadersForS3Origin"}, {"shape":"InconsistentQuantities"}, {"shape":"TooManyCertificates"}, {"shape":"InvalidLocationCode"}, {"shape":"InvalidGeoRestrictionParameter"}, {"shape":"InvalidTTLOrder"}, {"shape":"InvalidWebACLId"}, {"shape":"TooManyOriginCustomHeaders"} ], "documentation":"Update a distribution." }, "UpdateStreamingDistribution":{ "name":"UpdateStreamingDistribution2016_08_01", "http":{ "method":"PUT", "requestUri":"/2016-08-01/streaming-distribution/{Id}/config" }, "input":{"shape":"UpdateStreamingDistributionRequest"}, "output":{"shape":"UpdateStreamingDistributionResult"}, "errors":[ {"shape":"AccessDenied"}, {"shape":"CNAMEAlreadyExists"}, {"shape":"IllegalUpdate"}, {"shape":"InvalidIfMatchVersion"}, {"shape":"MissingBody"}, {"shape":"NoSuchStreamingDistribution"}, {"shape":"PreconditionFailed"}, {"shape":"TooManyStreamingDistributionCNAMEs"}, {"shape":"InvalidArgument"}, {"shape":"InvalidOriginAccessIdentity"}, {"shape":"TooManyTrustedSigners"}, {"shape":"TrustedSignerDoesNotExist"}, {"shape":"InconsistentQuantities"} ], "documentation":"Update a streaming distribution." } }, "shapes":{ "AccessDenied":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Access denied.", "error":{"httpStatusCode":403}, "exception":true }, "ActiveTrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Each active trusted signer." }, "Quantity":{ "shape":"integer", "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." }, "Items":{ "shape":"SignerList", "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." } }, "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." }, "AliasList":{ "type":"list", "member":{ "shape":"string", "locationName":"CNAME" } }, "Aliases":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of CNAMEs, if any, for this distribution." }, "Items":{ "shape":"AliasList", "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "AllowedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." }, "CachedMethods":{"shape":"CachedMethods"} }, "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." }, "AwsAccountNumberList":{ "type":"list", "member":{ "shape":"string", "locationName":"AwsAccountNumber" } }, "BatchTooLarge":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":413}, "exception":true }, "CNAMEAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CacheBehavior":{ "type":"structure", "required":[ "PathPattern", "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "PathPattern":{ "shape":"string", "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." }, "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "DefaultTTL":{ "shape":"long", "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "MaxTTL":{ "shape":"long", "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "Compress":{ "shape":"boolean", "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." } }, "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." }, "CacheBehaviorList":{ "type":"list", "member":{ "shape":"CacheBehavior", "locationName":"CacheBehavior" } }, "CacheBehaviors":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of cache behaviors for this distribution." }, "Items":{ "shape":"CacheBehaviorList", "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CachedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." } }, "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." }, "CertificateSource":{ "type":"string", "enum":[ "cloudfront", "iam", "acm" ] }, "CloudFrontOriginAccessIdentity":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The current configuration information for the identity." } }, "documentation":"CloudFront origin access identity." }, "CloudFrontOriginAccessIdentityAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.", "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityConfig":{ "type":"structure", "required":[ "CallerReference", "Comment" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the origin access identity." } }, "documentation":"Origin access identity configuration." }, "CloudFrontOriginAccessIdentityInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more origin access identities remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." }, "Items":{ "shape":"CloudFrontOriginAccessIdentitySummaryList", "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." } }, "documentation":"The CloudFrontOriginAccessIdentityList type." }, "CloudFrontOriginAccessIdentitySummary":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId", "Comment" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "Comment":{ "shape":"string", "documentation":"The comment for this origin access identity, as originally specified when created." } }, "documentation":"Summary of the information about a CloudFront origin access identity." }, "CloudFrontOriginAccessIdentitySummaryList":{ "type":"list", "member":{ "shape":"CloudFrontOriginAccessIdentitySummary", "locationName":"CloudFrontOriginAccessIdentitySummary" } }, "CookieNameList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "CookieNames":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of whitelisted cookies for this cache behavior." }, "Items":{ "shape":"CookieNameList", "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." }, "CookiePreference":{ "type":"structure", "required":["Forward"], "members":{ "Forward":{ "shape":"ItemSelection", "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." }, "WhitelistedNames":{ "shape":"CookieNames", "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." } }, "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." }, "CreateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["CloudFrontOriginAccessIdentityConfig"], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information.", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} } }, "documentation":"The request to create a new origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "CreateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the origin access identity created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "CreateDistributionRequest":{ "type":"structure", "required":["DistributionConfig"], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} } }, "documentation":"The request to create a new distribution.", "payload":"DistributionConfig" }, "CreateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "CreateDistributionWithTagsRequest":{ "type":"structure", "required":["DistributionConfigWithTags"], "members":{ "DistributionConfigWithTags":{ "shape":"DistributionConfigWithTags", "documentation":"The distribution's configuration information.", "locationName":"DistributionConfigWithTags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} } }, "documentation":"The request to create a new distribution with tags", "payload":"DistributionConfigWithTags" }, "CreateDistributionWithTagsResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "CreateInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "InvalidationBatch" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The batch information for the invalidation.", "locationName":"InvalidationBatch", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} } }, "documentation":"The request to create an invalidation.", "payload":"InvalidationBatch" }, "CreateInvalidationResult":{ "type":"structure", "members":{ "Location":{ "shape":"string", "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.", "location":"header", "locationName":"Location" }, "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "CreateStreamingDistributionRequest":{ "type":"structure", "required":["StreamingDistributionConfig"], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} } }, "documentation":"The request to create a new streaming distribution.", "payload":"StreamingDistributionConfig" }, "CreateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "CreateStreamingDistributionWithTagsRequest":{ "type":"structure", "required":["StreamingDistributionConfigWithTags"], "members":{ "StreamingDistributionConfigWithTags":{ "shape":"StreamingDistributionConfigWithTags", "documentation":"The streaming distribution's configuration information.", "locationName":"StreamingDistributionConfigWithTags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} } }, "documentation":"The request to create a new streaming distribution with tags.", "payload":"StreamingDistributionConfigWithTags" }, "CreateStreamingDistributionWithTagsResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "Location":{ "shape":"string", "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", "location":"header", "locationName":"Location" }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution created.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "CustomErrorResponse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{ "shape":"integer", "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." }, "ResponsePagePath":{ "shape":"string", "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." }, "ResponseCode":{ "shape":"string", "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." }, "ErrorCachingMinTTL":{ "shape":"long", "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." } }, "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." }, "CustomErrorResponseList":{ "type":"list", "member":{ "shape":"CustomErrorResponse", "locationName":"CustomErrorResponse" } }, "CustomErrorResponses":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom error responses for this distribution." }, "Items":{ "shape":"CustomErrorResponseList", "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "CustomHeaders":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom headers for this origin." }, "Items":{ "shape":"OriginCustomHeadersList", "documentation":"A complex type that contains the custom headers for this Origin." } }, "documentation":"A complex type that contains the list of Custom Headers for each origin." }, "CustomOriginConfig":{ "type":"structure", "required":[ "HTTPPort", "HTTPSPort", "OriginProtocolPolicy" ], "members":{ "HTTPPort":{ "shape":"integer", "documentation":"The HTTP port the custom origin listens on." }, "HTTPSPort":{ "shape":"integer", "documentation":"The HTTPS port the custom origin listens on." }, "OriginProtocolPolicy":{ "shape":"OriginProtocolPolicy", "documentation":"The origin protocol policy to apply to your origin." }, "OriginSslProtocols":{ "shape":"OriginSslProtocols", "documentation":"The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." } }, "documentation":"A customer origin." }, "DefaultCacheBehavior":{ "type":"structure", "required":[ "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "DefaultTTL":{ "shape":"long", "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "MaxTTL":{ "shape":"long", "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "Compress":{ "shape":"boolean", "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." } }, "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "DeleteCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The origin access identity's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a origin access identity." }, "DeleteDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a distribution." }, "DeleteStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to delete a streaming distribution." }, "Distribution":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "InProgressInvalidationBatches", "DomainName", "ActiveTrustedSigners", "DistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "ARN":{ "shape":"string", "documentation":"The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "InProgressInvalidationBatches":{ "shape":"integer", "documentation":"The number of invalidation batches currently in progress." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The current configuration information for the distribution." } }, "documentation":"A distribution." }, "DistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution.", "error":{"httpStatusCode":409}, "exception":true }, "DistributionConfig":{ "type":"structure", "required":[ "CallerReference", "Origins", "DefaultCacheBehavior", "Comment", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "DefaultRootObject":{ "shape":"string", "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the distribution." }, "Logging":{ "shape":"LoggingConfig", "documentation":"A complex type that controls whether access logs are written for the distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"(Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution." } }, "documentation":"A distribution Configuration." }, "DistributionConfigWithTags":{ "type":"structure", "required":[ "DistributionConfig", "Tags" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"A distribution Configuration." }, "Tags":{ "shape":"Tags", "documentation":"A complex type that contains zero or more Tag elements." } }, "documentation":"A distribution Configuration and a list of tags to be associated with the distribution." }, "DistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of distributions that were created by the current AWS account." }, "Items":{ "shape":"DistributionSummaryList", "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A distribution list." }, "DistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "DistributionSummary":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "DomainName", "Aliases", "Origins", "DefaultCacheBehavior", "CacheBehaviors", "CustomErrorResponses", "Comment", "PriceClass", "Enabled", "ViewerCertificate", "Restrictions", "WebACLId" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "ARN":{ "shape":"string", "documentation":"The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponses elements." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"The Web ACL Id (if any) associated with the distribution." } }, "documentation":"A summary of the information for an Amazon CloudFront distribution." }, "DistributionSummaryList":{ "type":"list", "member":{ "shape":"DistributionSummary", "locationName":"DistributionSummary" } }, "ForwardedValues":{ "type":"structure", "required":[ "QueryString", "Cookies" ], "members":{ "QueryString":{ "shape":"boolean", "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "Cookies":{ "shape":"CookiePreference", "documentation":"A complex type that specifies how CloudFront handles cookies." }, "Headers":{ "shape":"Headers", "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." } }, "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "GeoRestriction":{ "type":"structure", "required":[ "RestrictionType", "Quantity" ], "members":{ "RestrictionType":{ "shape":"GeoRestrictionType", "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." }, "Quantity":{ "shape":"integer", "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." }, "Items":{ "shape":"LocationList", "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." } }, "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." }, "GeoRestrictionType":{ "type":"string", "enum":[ "blacklist", "whitelist", "none" ] }, "GetCloudFrontOriginAccessIdentityConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an origin access identity's configuration." }, "GetCloudFrontOriginAccessIdentityConfigResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "GetCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an origin access identity's information." }, "GetCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "GetDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a distribution configuration." }, "GetDistributionConfigResult":{ "type":"structure", "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionConfig" }, "GetDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a distribution's information." }, "GetDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "GetInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "Id" ], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "Id":{ "shape":"string", "documentation":"The invalidation's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get an invalidation's information." }, "GetInvalidationResult":{ "type":"structure", "members":{ "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "GetStreamingDistributionConfigRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"To request to get a streaming distribution configuration." }, "GetStreamingDistributionConfigResult":{ "type":"structure", "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionConfig" }, "GetStreamingDistributionRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" } }, "documentation":"The request to get a streaming distribution's information." }, "GetStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "HeaderList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "Headers":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." }, "Items":{ "shape":"HeaderList", "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." } }, "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." }, "IllegalUpdate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Origin and CallerReference cannot be updated.", "error":{"httpStatusCode":400}, "exception":true }, "InconsistentQuantities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The value of Quantity and the size of Items do not match.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidArgument":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The argument is invalid.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidDefaultRootObject":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The default root object file name is too big or contains an invalid character.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidErrorCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidForwardCookies":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidGeoRestrictionParameter":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidHeadersForS3Origin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidIfMatchVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The If-Match version is missing or not valid for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidLocationCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidMinimumProtocolVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The origin access identity is not valid or doesn't exist.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidProtocolSettings":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI).", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRelativePath":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/).", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRequiredProtocol":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"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.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidResponseCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidTTLOrder":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidTagging":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified tagging for a CloudFront resource is invalid. For more information, see the error text.", "error":{"httpStatusCode":400}, "exception":true }, "InvalidViewerCertificate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidWebACLId":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "Invalidation":{ "type":"structure", "required":[ "Id", "Status", "CreateTime", "InvalidationBatch" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." }, "CreateTime":{ "shape":"timestamp", "documentation":"The date and time the invalidation request was first made." }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The current invalidation information for the batch request." } }, "documentation":"An invalidation." }, "InvalidationBatch":{ "type":"structure", "required":[ "Paths", "CallerReference" ], "members":{ "Paths":{ "shape":"Paths", "documentation":"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. 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. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." }, "CallerReference":{ "shape":"string", "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. 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, the response includes the same information returned to the original request. 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, CloudFront returns an InvalidationBatchAlreadyExists error." } }, "documentation":"An invalidation batch." }, "InvalidationList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of invalidation batches that were created by the current AWS account." }, "Items":{ "shape":"InvalidationSummaryList", "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." } }, "documentation":"An invalidation list." }, "InvalidationSummary":{ "type":"structure", "required":[ "Id", "CreateTime", "Status" ], "members":{ "Id":{ "shape":"string", "documentation":"The unique ID for an invalidation request." }, "CreateTime":{"shape":"timestamp"}, "Status":{ "shape":"string", "documentation":"The status of an invalidation request." } }, "documentation":"Summary of an invalidation request." }, "InvalidationSummaryList":{ "type":"list", "member":{ "shape":"InvalidationSummary", "locationName":"InvalidationSummary" } }, "ItemSelection":{ "type":"string", "enum":[ "none", "whitelist", "all" ] }, "KeyPairIdList":{ "type":"list", "member":{ "shape":"string", "locationName":"KeyPairId" } }, "KeyPairIds":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." }, "Items":{ "shape":"KeyPairIdList", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." }, "ListCloudFrontOriginAccessIdentitiesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"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. 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).", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of origin access identities you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list origin access identities." }, "ListCloudFrontOriginAccessIdentitiesResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityList":{ "shape":"CloudFrontOriginAccessIdentityList", "documentation":"The CloudFrontOriginAccessIdentityList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityList" }, "ListDistributionsByWebACLIdRequest":{ "type":"structure", "required":["WebACLId"], "members":{ "Marker":{ "shape":"string", "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", "location":"querystring", "locationName":"MaxItems" }, "WebACLId":{ "shape":"string", "documentation":"The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify \"null\" for the Id, the request returns a list of the distributions that aren't associated with a web ACL.", "location":"uri", "locationName":"WebACLId" } }, "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL." }, "ListDistributionsByWebACLIdResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.", "payload":"DistributionList" }, "ListDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list your distributions." }, "ListDistributionsResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionList" }, "ListInvalidationsRequest":{ "type":"structure", "required":["DistributionId"], "members":{ "DistributionId":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"DistributionId" }, "Marker":{ "shape":"string", "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. 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. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of invalidation batches you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list invalidations." }, "ListInvalidationsResult":{ "type":"structure", "members":{ "InvalidationList":{ "shape":"InvalidationList", "documentation":"Information about invalidation batches." } }, "documentation":"The returned result of the corresponding request.", "payload":"InvalidationList" }, "ListStreamingDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "documentation":"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. 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).", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"string", "documentation":"The maximum number of streaming distributions you want in the response body.", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"The request to list your streaming distributions." }, "ListStreamingDistributionsResult":{ "type":"structure", "members":{ "StreamingDistributionList":{ "shape":"StreamingDistributionList", "documentation":"The StreamingDistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionList" }, "ListTagsForResourceRequest":{ "type":"structure", "required":["Resource"], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"An ARN of a CloudFront resource.", "location":"querystring", "locationName":"Resource" } }, "documentation":"The request to list tags for a CloudFront resource." }, "ListTagsForResourceResult":{ "type":"structure", "required":["Tags"], "members":{ "Tags":{ "shape":"Tags", "documentation":"A complex type that contains zero or more Tag elements." } }, "documentation":"The returned result of the corresponding request.", "payload":"Tags" }, "LocationList":{ "type":"list", "member":{ "shape":"string", "locationName":"Location" } }, "LoggingConfig":{ "type":"structure", "required":[ "Enabled", "IncludeCookies", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." }, "IncludeCookies":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for the distribution." }, "Method":{ "type":"string", "enum":[ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ] }, "MethodsList":{ "type":"list", "member":{ "shape":"Method", "locationName":"Method" } }, "MinimumProtocolVersion":{ "type":"string", "enum":[ "SSLv3", "TLSv1" ] }, "MissingBody":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set.", "error":{"httpStatusCode":400}, "exception":true }, "NoSuchCloudFrontOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified origin access identity does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified distribution does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchInvalidation":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified invalidation does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"No origin exists with the specified Origin Id.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchResource":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified CloudFront resource does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "NoSuchStreamingDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The specified streaming distribution does not exist.", "error":{"httpStatusCode":404}, "exception":true }, "Origin":{ "type":"structure", "required":[ "Id", "DomainName" ], "members":{ "Id":{ "shape":"string", "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." }, "DomainName":{ "shape":"string", "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." }, "OriginPath":{ "shape":"string", "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." }, "CustomHeaders":{ "shape":"CustomHeaders", "documentation":"A complex type that contains information about the custom headers associated with this Origin." }, "S3OriginConfig":{ "shape":"S3OriginConfig", "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "CustomOriginConfig":{ "shape":"CustomOriginConfig", "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." } }, "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." }, "OriginCustomHeader":{ "type":"structure", "required":[ "HeaderName", "HeaderValue" ], "members":{ "HeaderName":{ "shape":"string", "documentation":"The header's name." }, "HeaderValue":{ "shape":"string", "documentation":"The header's value." } }, "documentation":"A complex type that contains information related to a Header" }, "OriginCustomHeadersList":{ "type":"list", "member":{ "shape":"OriginCustomHeader", "locationName":"OriginCustomHeader" } }, "OriginList":{ "type":"list", "member":{ "shape":"Origin", "locationName":"Origin" }, "min":1 }, "OriginProtocolPolicy":{ "type":"string", "enum":[ "http-only", "match-viewer", "https-only" ] }, "OriginSslProtocols":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." }, "Items":{ "shape":"SslProtocolsList", "documentation":"A complex type that contains one SslProtocol element for each SSL/TLS protocol that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." } }, "documentation":"A complex type that contains the list of SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." }, "Origins":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of origins for this distribution." }, "Items":{ "shape":"OriginList", "documentation":"A complex type that contains origins for this distribution." } }, "documentation":"A complex type that contains information about origins for this distribution." }, "PathList":{ "type":"list", "member":{ "shape":"string", "locationName":"Path" } }, "Paths":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of objects that you want to invalidate." }, "Items":{ "shape":"PathList", "documentation":"A complex type that contains a list of the objects that you want to invalidate." } }, "documentation":"A complex type that contains information about the objects that you want to invalidate." }, "PreconditionFailed":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"The precondition given in one or more of the request-header fields evaluated to false.", "error":{"httpStatusCode":412}, "exception":true }, "PriceClass":{ "type":"string", "enum":[ "PriceClass_100", "PriceClass_200", "PriceClass_All" ] }, "ResourceARN":{ "type":"string", "pattern":"arn:aws:cloudfront::[0-9]+:.*" }, "Restrictions":{ "type":"structure", "required":["GeoRestriction"], "members":{ "GeoRestriction":{"shape":"GeoRestriction"} }, "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." }, "S3Origin":{ "type":"structure", "required":[ "DomainName", "OriginAccessIdentity" ], "members":{ "DomainName":{ "shape":"string", "documentation":"The DNS name of the S3 origin." }, "OriginAccessIdentity":{ "shape":"string", "documentation":"Your S3 origin's origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "S3OriginConfig":{ "type":"structure", "required":["OriginAccessIdentity"], "members":{ "OriginAccessIdentity":{ "shape":"string", "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "SSLSupportMethod":{ "type":"string", "enum":[ "sni-only", "vip" ] }, "Signer":{ "type":"structure", "members":{ "AwsAccountNumber":{ "shape":"string", "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." }, "KeyPairIds":{ "shape":"KeyPairIds", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." }, "SignerList":{ "type":"list", "member":{ "shape":"Signer", "locationName":"Signer" } }, "SslProtocol":{ "type":"string", "enum":[ "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2" ] }, "SslProtocolsList":{ "type":"list", "member":{ "shape":"SslProtocol", "locationName":"SslProtocol" } }, "StreamingDistribution":{ "type":"structure", "required":[ "Id", "ARN", "Status", "DomainName", "ActiveTrustedSigners", "StreamingDistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." }, "ARN":{ "shape":"string", "documentation":"The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." }, "Status":{ "shape":"string", "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The current configuration information for the streaming distribution." } }, "documentation":"A streaming distribution." }, "StreamingDistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionConfig":{ "type":"structure", "required":[ "CallerReference", "S3Origin", "Comment", "TrustedSigners", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the streaming distribution." }, "Logging":{ "shape":"StreamingLoggingConfig", "documentation":"A complex type that controls whether access logs are written for the streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this streaming distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." } }, "documentation":"The configuration for the streaming distribution." }, "StreamingDistributionConfigWithTags":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Tags" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"A streaming distribution Configuration." }, "Tags":{ "shape":"Tags", "documentation":"A complex type that contains zero or more Tag elements." } }, "documentation":"A streaming distribution Configuration and a list of tags to be associated with the streaming distribution." }, "StreamingDistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more streaming distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of streaming distributions that were created by the current AWS account." }, "Items":{ "shape":"StreamingDistributionSummaryList", "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A streaming distribution list." }, "StreamingDistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionSummary":{ "type":"structure", "required":[ "Id", "ARN", "Status", "LastModifiedTime", "DomainName", "S3Origin", "Aliases", "TrustedSigners", "Comment", "PriceClass", "Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "ARN":{ "shape":"string", "documentation":"The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." }, "Status":{ "shape":"string", "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." } }, "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." }, "StreamingDistributionSummaryList":{ "type":"list", "member":{ "shape":"StreamingDistributionSummary", "locationName":"StreamingDistributionSummary" } }, "StreamingLoggingConfig":{ "type":"structure", "required":[ "Enabled", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for this streaming distribution." }, "Tag":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"TagKey", "documentation":"A string that contains Tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @." }, "Value":{ "shape":"TagValue", "documentation":"A string that contains an optional Tag value. The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @." } }, "documentation":"A complex type that contains Tag key and Tag value." }, "TagKey":{ "type":"string", "documentation":"A string that contains Tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeyList":{ "type":"list", "member":{ "shape":"TagKey", "locationName":"Key" } }, "TagKeys":{ "type":"structure", "members":{ "Items":{ "shape":"TagKeyList", "documentation":"A complex type that contains Tag key elements" } }, "documentation":"A complex type that contains zero or more Tag elements." }, "TagList":{ "type":"list", "member":{ "shape":"Tag", "locationName":"Tag" } }, "TagResourceRequest":{ "type":"structure", "required":[ "Resource", "Tags" ], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"An ARN of a CloudFront resource.", "location":"querystring", "locationName":"Resource" }, "Tags":{ "shape":"Tags", "documentation":"A complex type that contains zero or more Tag elements.", "locationName":"Tags", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} } }, "documentation":"The request to add tags to a CloudFront resource.", "payload":"Tags" }, "TagValue":{ "type":"string", "max":256, "min":0, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Tags":{ "type":"structure", "members":{ "Items":{ "shape":"TagList", "documentation":"A complex type that contains Tag elements" } }, "documentation":"A complex type that contains zero or more Tag elements." }, "TooManyCacheBehaviors":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore cache behaviors for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCertificates":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore custom ssl certificates.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCloudFrontOriginAccessIdentities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyCookieNamesInWhiteList":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more CNAMEs than are allowed per distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyHeadersInForwardedValues":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyInvalidationsInProgress":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyOriginCustomHeaders":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyOrigins":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"You cannot create anymore origins for the distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed.", "error":{"httpStatusCode":400}, "exception":true }, "TooManyTrustedSigners":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"Your request contains more trusted signers than are allowed per distribution.", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSignerDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "documentation":"One or more of your trusted signers do not exist.", "error":{"httpStatusCode":400}, "exception":true }, "TrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." }, "Quantity":{ "shape":"integer", "documentation":"The number of trusted signers for this cache behavior." }, "Items":{ "shape":"AwsAccountNumberList", "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "UntagResourceRequest":{ "type":"structure", "required":[ "Resource", "TagKeys" ], "members":{ "Resource":{ "shape":"ResourceARN", "documentation":"An ARN of a CloudFront resource.", "location":"querystring", "locationName":"Resource" }, "TagKeys":{ "shape":"TagKeys", "documentation":"A complex type that contains zero or more Tag key elements.", "locationName":"TagKeys", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} } }, "documentation":"The request to remove tags from a CloudFront resource.", "payload":"TagKeys" }, "UpdateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":[ "CloudFrontOriginAccessIdentityConfig", "Id" ], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The identity's configuration information.", "locationName":"CloudFrontOriginAccessIdentityConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} }, "Id":{ "shape":"string", "documentation":"The identity's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update an origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "UpdateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "UpdateDistributionRequest":{ "type":"structure", "required":[ "DistributionConfig", "Id" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "locationName":"DistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} }, "Id":{ "shape":"string", "documentation":"The distribution's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update a distribution.", "payload":"DistributionConfig" }, "UpdateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "UpdateStreamingDistributionRequest":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Id" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "locationName":"StreamingDistributionConfig", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} }, "Id":{ "shape":"string", "documentation":"The streaming distribution's id.", "location":"uri", "locationName":"Id" }, "IfMatch":{ "shape":"string", "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"If-Match" } }, "documentation":"The request to update a streaming distribution.", "payload":"StreamingDistributionConfig" }, "UpdateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", "location":"header", "locationName":"ETag" } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "ViewerCertificate":{ "type":"structure", "members":{ "CloudFrontDefaultCertificate":{ "shape":"boolean", "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an ACMCertificateArn or IAMCertificateId." }, "IAMCertificateId":{ "shape":"string", "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value, ACMCertificateArn, or CloudFrontDefaultCertificate." }, "ACMCertificateArn":{ "shape":"string", "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the ACM certificate ARN of the custom viewer certificate for this distribution. Specify either this value, IAMCertificateId, or CloudFrontDefaultCertificate." }, "SSLSupportMethod":{ "shape":"SSLSupportMethod", "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." }, "MinimumProtocolVersion":{ "shape":"MinimumProtocolVersion", "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." }, "Certificate":{ "shape":"string", "documentation":"Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].", "deprecated":true }, "CertificateSource":{ "shape":"CertificateSource", "documentation":"Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].", "deprecated":true } }, "documentation":"A complex type that contains information about viewer certificates for this distribution." }, "ViewerProtocolPolicy":{ "type":"string", "enum":[ "allow-all", "https-only", "redirect-to-https" ] }, "boolean":{"type":"boolean"}, "integer":{"type":"integer"}, "long":{"type":"long"}, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} }, "documentation":"Amazon CloudFront

Amazon CloudFront is a global content delivery network (CDN) service that accelerates delivery of your websites, APIs, video content or other web assets. It integrates with other Amazon Web Services products to give developers and businesses an easy way to accelerate content to end users with no minimum usage commitments.

" } botocore-1.5.7/botocore/data/cloudfront/2015-07-27/0000777454262600001440000000000013042511307022353 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudfront/2015-07-27/waiters-2.json0000666454262600001440000000224013042511306025060 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DistributionDeployed": { "delay": 60, "operation": "GetDistribution", "maxAttempts": 25, "description": "Wait until a distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "Distribution.Status" } ] }, "InvalidationCompleted": { "delay": 20, "operation": "GetInvalidation", "maxAttempts": 60, "description": "Wait until an invalidation has completed.", "acceptors": [ { "expected": "Completed", "matcher": "path", "state": "success", "argument": "Invalidation.Status" } ] }, "StreamingDistributionDeployed": { "delay": 60, "operation": "GetStreamingDistribution", "maxAttempts": 25, "description": "Wait until a streaming distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "StreamingDistribution.Status" } ] } } } botocore-1.5.7/botocore/data/cloudfront/2015-07-27/paginators-1.json0000666454262600001440000000214613042511306025555 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListCloudFrontOriginAccessIdentities": { "input_token": "Marker", "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", "limit_key": "MaxItems", "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", "result_key": "CloudFrontOriginAccessIdentityList.Items" }, "ListDistributions": { "input_token": "Marker", "output_token": "DistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "DistributionList.IsTruncated", "result_key": "DistributionList.Items" }, "ListInvalidations": { "input_token": "Marker", "output_token": "InvalidationList.NextMarker", "limit_key": "MaxItems", "more_results": "InvalidationList.IsTruncated", "result_key": "InvalidationList.Items" }, "ListStreamingDistributions": { "input_token": "Marker", "output_token": "StreamingDistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "StreamingDistributionList.IsTruncated", "result_key": "StreamingDistributionList.Items" } } } botocore-1.5.7/botocore/data/cloudfront/2015-07-27/service-2.json0000666454262600001440000045575613042511306025072 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-07-27", "endpointPrefix":"cloudfront", "globalEndpoint":"cloudfront.amazonaws.com", "serviceAbbreviation":"CloudFront", "serviceFullName":"Amazon CloudFront", "signatureVersion":"v4", "protocol":"rest-xml" }, "operations":{ "CreateCloudFrontOriginAccessIdentity":{ "name":"CreateCloudFrontOriginAccessIdentity2015_07_27", "http":{ "method":"POST", "requestUri":"/2015-07-27/origin-access-identity/cloudfront", "responseCode":201 }, "input":{ "shape":"CreateCloudFrontOriginAccessIdentityRequest", "documentation":"The request to create a new origin access identity." }, "output":{ "shape":"CreateCloudFrontOriginAccessIdentityResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"CloudFrontOriginAccessIdentityAlreadyExists", "error":{"httpStatusCode":409}, "exception":true, "documentation":"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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"TooManyCloudFrontOriginAccessIdentities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Create a new origin access identity." }, "CreateDistribution":{ "name":"CreateDistribution2015_07_27", "http":{ "method":"POST", "requestUri":"/2015-07-27/distribution", "responseCode":201 }, "input":{ "shape":"CreateDistributionRequest", "documentation":"The request to create a new distribution." }, "output":{ "shape":"CreateDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"DistributionAlreadyExists", "error":{"httpStatusCode":409}, "exception":true, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." }, { "shape":"InvalidOrigin", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"InvalidViewerCertificate", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidMinimumProtocolVersion", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"TooManyDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more CNAMEs than are allowed per distribution." }, { "shape":"TooManyDistributions", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." }, { "shape":"InvalidDefaultRootObject", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The default root object file name is too big or contains an invalid character." }, { "shape":"InvalidRelativePath", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." }, { "shape":"InvalidErrorCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidResponseCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InvalidRequiredProtocol", "error":{"httpStatusCode":400}, "exception":true, "documentation":"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." }, { "shape":"NoSuchOrigin", "error":{"httpStatusCode":404}, "exception":true, "documentation":"No origin exists with the specified Origin Id." }, { "shape":"TooManyOrigins", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore origins for the distribution." }, { "shape":"TooManyCacheBehaviors", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore cache behaviors for the distribution." }, { "shape":"TooManyCookieNamesInWhiteList", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." }, { "shape":"InvalidForwardCookies", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." }, { "shape":"TooManyHeadersInForwardedValues", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidHeadersForS3Origin", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." }, { "shape":"TooManyCertificates", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore custom ssl certificates." }, { "shape":"InvalidLocationCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidGeoRestrictionParameter", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidProtocolSettings", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." }, { "shape":"InvalidTTLOrder", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidWebACLId", "error":{"httpStatusCode":400}, "exception":true } ], "documentation":"Create a new distribution." }, "CreateInvalidation":{ "name":"CreateInvalidation2015_07_27", "http":{ "method":"POST", "requestUri":"/2015-07-27/distribution/{DistributionId}/invalidation", "responseCode":201 }, "input":{ "shape":"CreateInvalidationRequest", "documentation":"The request to create an invalidation." }, "output":{ "shape":"CreateInvalidationResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"BatchTooLarge", "error":{"httpStatusCode":413}, "exception":true }, { "shape":"TooManyInvalidationsInProgress", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Create a new invalidation." }, "CreateStreamingDistribution":{ "name":"CreateStreamingDistribution2015_07_27", "http":{ "method":"POST", "requestUri":"/2015-07-27/streaming-distribution", "responseCode":201 }, "input":{ "shape":"CreateStreamingDistributionRequest", "documentation":"The request to create a new streaming distribution." }, "output":{ "shape":"CreateStreamingDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"StreamingDistributionAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"InvalidOrigin", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"TooManyStreamingDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyStreamingDistributions", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Create a new streaming distribution." }, "DeleteCloudFrontOriginAccessIdentity":{ "name":"DeleteCloudFrontOriginAccessIdentity2015_07_27", "http":{ "method":"DELETE", "requestUri":"/2015-07-27/origin-access-identity/cloudfront/{Id}", "responseCode":204 }, "input":{ "shape":"DeleteCloudFrontOriginAccessIdentityRequest", "documentation":"The request to delete a origin access identity." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"CloudFrontOriginAccessIdentityInUse", "error":{"httpStatusCode":409}, "exception":true } ], "documentation":"Delete an origin access identity." }, "DeleteDistribution":{ "name":"DeleteDistribution2015_07_27", "http":{ "method":"DELETE", "requestUri":"/2015-07-27/distribution/{Id}", "responseCode":204 }, "input":{ "shape":"DeleteDistributionRequest", "documentation":"The request to delete a distribution." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"DistributionNotDisabled", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." } ], "documentation":"Delete a distribution." }, "DeleteStreamingDistribution":{ "name":"DeleteStreamingDistribution2015_07_27", "http":{ "method":"DELETE", "requestUri":"/2015-07-27/streaming-distribution/{Id}", "responseCode":204 }, "input":{ "shape":"DeleteStreamingDistributionRequest", "documentation":"The request to delete a streaming distribution." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"StreamingDistributionNotDisabled", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." } ], "documentation":"Delete a streaming distribution." }, "GetCloudFrontOriginAccessIdentity":{ "name":"GetCloudFrontOriginAccessIdentity2015_07_27", "http":{ "method":"GET", "requestUri":"/2015-07-27/origin-access-identity/cloudfront/{Id}" }, "input":{ "shape":"GetCloudFrontOriginAccessIdentityRequest", "documentation":"The request to get an origin access identity's information." }, "output":{ "shape":"GetCloudFrontOriginAccessIdentityResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about an origin access identity." }, "GetCloudFrontOriginAccessIdentityConfig":{ "name":"GetCloudFrontOriginAccessIdentityConfig2015_07_27", "http":{ "method":"GET", "requestUri":"/2015-07-27/origin-access-identity/cloudfront/{Id}/config" }, "input":{ "shape":"GetCloudFrontOriginAccessIdentityConfigRequest", "documentation":"The request to get an origin access identity's configuration." }, "output":{ "shape":"GetCloudFrontOriginAccessIdentityConfigResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the configuration information about an origin access identity." }, "GetDistribution":{ "name":"GetDistribution2015_07_27", "http":{ "method":"GET", "requestUri":"/2015-07-27/distribution/{Id}" }, "input":{ "shape":"GetDistributionRequest", "documentation":"The request to get a distribution's information." }, "output":{ "shape":"GetDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about a distribution." }, "GetDistributionConfig":{ "name":"GetDistributionConfig2015_07_27", "http":{ "method":"GET", "requestUri":"/2015-07-27/distribution/{Id}/config" }, "input":{ "shape":"GetDistributionConfigRequest", "documentation":"The request to get a distribution configuration." }, "output":{ "shape":"GetDistributionConfigResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the configuration information about a distribution." }, "GetInvalidation":{ "name":"GetInvalidation2015_07_27", "http":{ "method":"GET", "requestUri":"/2015-07-27/distribution/{DistributionId}/invalidation/{Id}" }, "input":{ "shape":"GetInvalidationRequest", "documentation":"The request to get an invalidation's information." }, "output":{ "shape":"GetInvalidationResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchInvalidation", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified invalidation does not exist." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about an invalidation." }, "GetStreamingDistribution":{ "name":"GetStreamingDistribution2015_07_27", "http":{ "method":"GET", "requestUri":"/2015-07-27/streaming-distribution/{Id}" }, "input":{ "shape":"GetStreamingDistributionRequest", "documentation":"The request to get a streaming distribution's information." }, "output":{ "shape":"GetStreamingDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about a streaming distribution." }, "GetStreamingDistributionConfig":{ "name":"GetStreamingDistributionConfig2015_07_27", "http":{ "method":"GET", "requestUri":"/2015-07-27/streaming-distribution/{Id}/config" }, "input":{ "shape":"GetStreamingDistributionConfigRequest", "documentation":"To request to get a streaming distribution configuration." }, "output":{ "shape":"GetStreamingDistributionConfigResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the configuration information about a streaming distribution." }, "ListCloudFrontOriginAccessIdentities":{ "name":"ListCloudFrontOriginAccessIdentities2015_07_27", "http":{ "method":"GET", "requestUri":"/2015-07-27/origin-access-identity/cloudfront" }, "input":{ "shape":"ListCloudFrontOriginAccessIdentitiesRequest", "documentation":"The request to list origin access identities." }, "output":{ "shape":"ListCloudFrontOriginAccessIdentitiesResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." } ], "documentation":"List origin access identities." }, "ListDistributions":{ "name":"ListDistributions2015_07_27", "http":{ "method":"GET", "requestUri":"/2015-07-27/distribution" }, "input":{ "shape":"ListDistributionsRequest", "documentation":"The request to list your distributions." }, "output":{ "shape":"ListDistributionsResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." } ], "documentation":"List distributions." }, "ListDistributionsByWebACLId":{ "name":"ListDistributionsByWebACLId2015_07_27", "http":{ "method":"GET", "requestUri":"/2015-07-27/distributionsByWebACLId/{WebACLId}" }, "input":{ "shape":"ListDistributionsByWebACLIdRequest", "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL." }, "output":{ "shape":"ListDistributionsByWebACLIdResult", "documentation":"The response to a request to list the distributions that are associated with a specified AWS WAF web ACL." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InvalidWebACLId", "error":{"httpStatusCode":400}, "exception":true } ], "documentation":"List the distributions that are associated with a specified AWS WAF web ACL." }, "ListInvalidations":{ "name":"ListInvalidations2015_07_27", "http":{ "method":"GET", "requestUri":"/2015-07-27/distribution/{DistributionId}/invalidation" }, "input":{ "shape":"ListInvalidationsRequest", "documentation":"The request to list invalidations." }, "output":{ "shape":"ListInvalidationsResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"List invalidation batches." }, "ListStreamingDistributions":{ "name":"ListStreamingDistributions2015_07_27", "http":{ "method":"GET", "requestUri":"/2015-07-27/streaming-distribution" }, "input":{ "shape":"ListStreamingDistributionsRequest", "documentation":"The request to list your streaming distributions." }, "output":{ "shape":"ListStreamingDistributionsResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." } ], "documentation":"List streaming distributions." }, "UpdateCloudFrontOriginAccessIdentity":{ "name":"UpdateCloudFrontOriginAccessIdentity2015_07_27", "http":{ "method":"PUT", "requestUri":"/2015-07-27/origin-access-identity/cloudfront/{Id}/config" }, "input":{ "shape":"UpdateCloudFrontOriginAccessIdentityRequest", "documentation":"The request to update an origin access identity." }, "output":{ "shape":"UpdateCloudFrontOriginAccessIdentityResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"IllegalUpdate", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Update an origin access identity." }, "UpdateDistribution":{ "name":"UpdateDistribution2015_07_27", "http":{ "method":"PUT", "requestUri":"/2015-07-27/distribution/{Id}/config" }, "input":{ "shape":"UpdateDistributionRequest", "documentation":"The request to update a distribution." }, "output":{ "shape":"UpdateDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"IllegalUpdate", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"TooManyDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more CNAMEs than are allowed per distribution." }, { "shape":"InvalidDefaultRootObject", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The default root object file name is too big or contains an invalid character." }, { "shape":"InvalidRelativePath", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." }, { "shape":"InvalidErrorCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidResponseCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"InvalidViewerCertificate", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidMinimumProtocolVersion", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidRequiredProtocol", "error":{"httpStatusCode":400}, "exception":true, "documentation":"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." }, { "shape":"NoSuchOrigin", "error":{"httpStatusCode":404}, "exception":true, "documentation":"No origin exists with the specified Origin Id." }, { "shape":"TooManyOrigins", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore origins for the distribution." }, { "shape":"TooManyCacheBehaviors", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore cache behaviors for the distribution." }, { "shape":"TooManyCookieNamesInWhiteList", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." }, { "shape":"InvalidForwardCookies", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." }, { "shape":"TooManyHeadersInForwardedValues", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidHeadersForS3Origin", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." }, { "shape":"TooManyCertificates", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore custom ssl certificates." }, { "shape":"InvalidLocationCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidGeoRestrictionParameter", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidTTLOrder", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidWebACLId", "error":{"httpStatusCode":400}, "exception":true } ], "documentation":"Update a distribution." }, "UpdateStreamingDistribution":{ "name":"UpdateStreamingDistribution2015_07_27", "http":{ "method":"PUT", "requestUri":"/2015-07-27/streaming-distribution/{Id}/config" }, "input":{ "shape":"UpdateStreamingDistributionRequest", "documentation":"The request to update a streaming distribution." }, "output":{ "shape":"UpdateStreamingDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"IllegalUpdate", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"TooManyStreamingDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Update a streaming distribution." } }, "shapes":{ "AccessDenied":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, "ActiveTrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Each active trusted signer." }, "Quantity":{ "shape":"integer", "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." }, "Items":{ "shape":"SignerList", "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." } }, "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." }, "AliasList":{ "type":"list", "member":{ "shape":"string", "locationName":"CNAME" } }, "Aliases":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of CNAMEs, if any, for this distribution." }, "Items":{ "shape":"AliasList", "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "AllowedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." }, "CachedMethods":{"shape":"CachedMethods"} }, "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." }, "AwsAccountNumberList":{ "type":"list", "member":{ "shape":"string", "locationName":"AwsAccountNumber" } }, "BatchTooLarge":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":413}, "exception":true }, "CNAMEAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CacheBehavior":{ "type":"structure", "required":[ "PathPattern", "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "PathPattern":{ "shape":"string", "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." }, "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "DefaultTTL":{ "shape":"long", "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "MaxTTL":{ "shape":"long", "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." } }, "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." }, "CacheBehaviorList":{ "type":"list", "member":{ "shape":"CacheBehavior", "locationName":"CacheBehavior" } }, "CacheBehaviors":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of cache behaviors for this distribution." }, "Items":{ "shape":"CacheBehaviorList", "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CachedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." } }, "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." }, "CloudFrontOriginAccessIdentity":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The current configuration information for the identity." } }, "documentation":"CloudFront origin access identity." }, "CloudFrontOriginAccessIdentityAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, "CloudFrontOriginAccessIdentityConfig":{ "type":"structure", "required":[ "CallerReference", "Comment" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the origin access identity." } }, "documentation":"Origin access identity configuration." }, "CloudFrontOriginAccessIdentityInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more origin access identities remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." }, "Items":{ "shape":"CloudFrontOriginAccessIdentitySummaryList", "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." } }, "documentation":"The CloudFrontOriginAccessIdentityList type." }, "CloudFrontOriginAccessIdentitySummary":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId", "Comment" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "Comment":{ "shape":"string", "documentation":"The comment for this origin access identity, as originally specified when created." } }, "documentation":"Summary of the information about a CloudFront origin access identity." }, "CloudFrontOriginAccessIdentitySummaryList":{ "type":"list", "member":{ "shape":"CloudFrontOriginAccessIdentitySummary", "locationName":"CloudFrontOriginAccessIdentitySummary" } }, "CookieNameList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "CookieNames":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of whitelisted cookies for this cache behavior." }, "Items":{ "shape":"CookieNameList", "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." }, "CookiePreference":{ "type":"structure", "required":["Forward"], "members":{ "Forward":{ "shape":"ItemSelection", "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." }, "WhitelistedNames":{ "shape":"CookieNames", "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." } }, "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." }, "CreateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["CloudFrontOriginAccessIdentityConfig"], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-07-27/"}, "locationName":"CloudFrontOriginAccessIdentityConfig" } }, "documentation":"The request to create a new origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "CreateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the origin access identity created." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "CreateDistributionRequest":{ "type":"structure", "required":["DistributionConfig"], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-07-27/"}, "locationName":"DistributionConfig" } }, "documentation":"The request to create a new distribution.", "payload":"DistributionConfig" }, "CreateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the distribution created." } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "CreateInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "InvalidationBatch" ], "members":{ "DistributionId":{ "shape":"string", "location":"uri", "locationName":"DistributionId", "documentation":"The distribution's id." }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The batch information for the invalidation.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-07-27/"}, "locationName":"InvalidationBatch" } }, "documentation":"The request to create an invalidation.", "payload":"InvalidationBatch" }, "CreateInvalidationResult":{ "type":"structure", "members":{ "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID." }, "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "CreateStreamingDistributionRequest":{ "type":"structure", "required":["StreamingDistributionConfig"], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-07-27/"}, "locationName":"StreamingDistributionConfig" } }, "documentation":"The request to create a new streaming distribution.", "payload":"StreamingDistributionConfig" }, "CreateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the streaming distribution created." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "CustomErrorResponse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{ "shape":"integer", "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." }, "ResponsePagePath":{ "shape":"string", "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." }, "ResponseCode":{ "shape":"string", "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." }, "ErrorCachingMinTTL":{ "shape":"long", "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." } }, "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." }, "CustomErrorResponseList":{ "type":"list", "member":{ "shape":"CustomErrorResponse", "locationName":"CustomErrorResponse" } }, "CustomErrorResponses":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom error responses for this distribution." }, "Items":{ "shape":"CustomErrorResponseList", "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "CustomOriginConfig":{ "type":"structure", "required":[ "HTTPPort", "HTTPSPort", "OriginProtocolPolicy" ], "members":{ "HTTPPort":{ "shape":"integer", "documentation":"The HTTP port the custom origin listens on." }, "HTTPSPort":{ "shape":"integer", "documentation":"The HTTPS port the custom origin listens on." }, "OriginProtocolPolicy":{ "shape":"OriginProtocolPolicy", "documentation":"The origin protocol policy to apply to your origin." } }, "documentation":"A customer origin." }, "DefaultCacheBehavior":{ "type":"structure", "required":[ "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "DefaultTTL":{ "shape":"long", "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "MaxTTL":{ "shape":"long", "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." } }, "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "DeleteCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The origin access identity's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to delete a origin access identity.", "required":["Id"] }, "DeleteDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to delete a distribution.", "required":["Id"] }, "DeleteStreamingDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to delete a streaming distribution.", "required":["Id"] }, "Distribution":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "InProgressInvalidationBatches", "DomainName", "ActiveTrustedSigners", "DistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "InProgressInvalidationBatches":{ "shape":"integer", "documentation":"The number of invalidation batches currently in progress." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The current configuration information for the distribution." } }, "documentation":"A distribution." }, "DistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." }, "DistributionConfig":{ "type":"structure", "required":[ "CallerReference", "Origins", "DefaultCacheBehavior", "Comment", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "DefaultRootObject":{ "shape":"string", "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the distribution." }, "Logging":{ "shape":"LoggingConfig", "documentation":"A complex type that controls whether access logs are written for the distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"(Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution." } }, "documentation":"A distribution Configuration." }, "DistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of distributions that were created by the current AWS account." }, "Items":{ "shape":"DistributionSummaryList", "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A distribution list." }, "DistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "DistributionSummary":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "DomainName", "Aliases", "Origins", "DefaultCacheBehavior", "CacheBehaviors", "CustomErrorResponses", "Comment", "PriceClass", "Enabled", "ViewerCertificate", "Restrictions", "WebACLId" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponses elements." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"}, "WebACLId":{ "shape":"string", "documentation":"The Web ACL Id (if any) associated with the distribution." } }, "documentation":"A summary of the information for an Amazon CloudFront distribution." }, "DistributionSummaryList":{ "type":"list", "member":{ "shape":"DistributionSummary", "locationName":"DistributionSummary" } }, "ForwardedValues":{ "type":"structure", "required":[ "QueryString", "Cookies" ], "members":{ "QueryString":{ "shape":"boolean", "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "Cookies":{ "shape":"CookiePreference", "documentation":"A complex type that specifies how CloudFront handles cookies." }, "Headers":{ "shape":"Headers", "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." } }, "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "GeoRestriction":{ "type":"structure", "required":[ "RestrictionType", "Quantity" ], "members":{ "RestrictionType":{ "shape":"GeoRestrictionType", "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." }, "Quantity":{ "shape":"integer", "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." }, "Items":{ "shape":"LocationList", "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." } }, "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." }, "GeoRestrictionType":{ "type":"string", "enum":[ "blacklist", "whitelist", "none" ] }, "GetCloudFrontOriginAccessIdentityConfigRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The identity's id." } }, "documentation":"The request to get an origin access identity's configuration.", "required":["Id"] }, "GetCloudFrontOriginAccessIdentityConfigResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "GetCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The identity's id." } }, "documentation":"The request to get an origin access identity's information.", "required":["Id"] }, "GetCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "GetDistributionConfigRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution's id." } }, "documentation":"The request to get a distribution configuration.", "required":["Id"] }, "GetDistributionConfigResult":{ "type":"structure", "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionConfig" }, "GetDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution's id." } }, "documentation":"The request to get a distribution's information.", "required":["Id"] }, "GetDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "GetInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "Id" ], "members":{ "DistributionId":{ "shape":"string", "location":"uri", "locationName":"DistributionId", "documentation":"The distribution's id." }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The invalidation's id." } }, "documentation":"The request to get an invalidation's information." }, "GetInvalidationResult":{ "type":"structure", "members":{ "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "GetStreamingDistributionConfigRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The streaming distribution's id." } }, "documentation":"To request to get a streaming distribution configuration.", "required":["Id"] }, "GetStreamingDistributionConfigResult":{ "type":"structure", "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionConfig" }, "GetStreamingDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The streaming distribution's id." } }, "documentation":"The request to get a streaming distribution's information.", "required":["Id"] }, "GetStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "HeaderList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "Headers":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." }, "Items":{ "shape":"HeaderList", "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." } }, "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." }, "IllegalUpdate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, "InconsistentQuantities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." }, "InvalidArgument":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, "InvalidDefaultRootObject":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The default root object file name is too big or contains an invalid character." }, "InvalidErrorCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidForwardCookies":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." }, "InvalidGeoRestrictionParameter":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidHeadersForS3Origin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidIfMatchVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, "InvalidLocationCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidMinimumProtocolVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." }, "InvalidOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, "InvalidProtocolSettings":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." }, "InvalidRelativePath":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." }, "InvalidRequiredProtocol":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"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." }, "InvalidResponseCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidTTLOrder":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidViewerCertificate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidWebACLId":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "Invalidation":{ "type":"structure", "required":[ "Id", "Status", "CreateTime", "InvalidationBatch" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." }, "CreateTime":{ "shape":"timestamp", "documentation":"The date and time the invalidation request was first made." }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The current invalidation information for the batch request." } }, "documentation":"An invalidation." }, "InvalidationBatch":{ "type":"structure", "required":[ "Paths", "CallerReference" ], "members":{ "Paths":{ "shape":"Paths", "documentation":"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. 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. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." }, "CallerReference":{ "shape":"string", "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. 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, the response includes the same information returned to the original request. 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, CloudFront returns an InvalidationBatchAlreadyExists error." } }, "documentation":"An invalidation batch." }, "InvalidationList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of invalidation batches that were created by the current AWS account." }, "Items":{ "shape":"InvalidationSummaryList", "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." } }, "documentation":"An invalidation list." }, "InvalidationSummary":{ "type":"structure", "required":[ "Id", "CreateTime", "Status" ], "members":{ "Id":{ "shape":"string", "documentation":"The unique ID for an invalidation request." }, "CreateTime":{"shape":"timestamp"}, "Status":{ "shape":"string", "documentation":"The status of an invalidation request." } }, "documentation":"Summary of an invalidation request." }, "InvalidationSummaryList":{ "type":"list", "member":{ "shape":"InvalidationSummary", "locationName":"InvalidationSummary" } }, "ItemSelection":{ "type":"string", "enum":[ "none", "whitelist", "all" ] }, "KeyPairIdList":{ "type":"list", "member":{ "shape":"string", "locationName":"KeyPairId" } }, "KeyPairIds":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." }, "Items":{ "shape":"KeyPairIdList", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." }, "ListCloudFrontOriginAccessIdentitiesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"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. 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)." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of origin access identities you want in the response body." } }, "documentation":"The request to list origin access identities." }, "ListCloudFrontOriginAccessIdentitiesResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityList":{ "shape":"CloudFrontOriginAccessIdentityList", "documentation":"The CloudFrontOriginAccessIdentityList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityList" }, "ListDistributionsByWebACLIdRequest":{ "type":"structure", "required":["WebACLId"], "members":{ "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)" }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100." }, "WebACLId":{ "shape":"string", "location":"uri", "locationName":"WebACLId", "documentation":"The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify \"null\" for the Id, the request returns a list of the distributions that aren't associated with a web ACL." } }, "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL." }, "ListDistributionsByWebACLIdResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.", "payload":"DistributionList" }, "ListDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)" }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100." } }, "documentation":"The request to list your distributions." }, "ListDistributionsResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionList" }, "ListInvalidationsRequest":{ "type":"structure", "required":["DistributionId"], "members":{ "DistributionId":{ "shape":"string", "location":"uri", "locationName":"DistributionId", "documentation":"The distribution's id." }, "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. 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. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of invalidation batches you want in the response body." } }, "documentation":"The request to list invalidations." }, "ListInvalidationsResult":{ "type":"structure", "members":{ "InvalidationList":{ "shape":"InvalidationList", "documentation":"Information about invalidation batches." } }, "documentation":"The returned result of the corresponding request.", "payload":"InvalidationList" }, "ListStreamingDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"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. 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)." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of streaming distributions you want in the response body." } }, "documentation":"The request to list your streaming distributions." }, "ListStreamingDistributionsResult":{ "type":"structure", "members":{ "StreamingDistributionList":{ "shape":"StreamingDistributionList", "documentation":"The StreamingDistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionList" }, "LocationList":{ "type":"list", "member":{ "shape":"string", "locationName":"Location" } }, "LoggingConfig":{ "type":"structure", "required":[ "Enabled", "IncludeCookies", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." }, "IncludeCookies":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for the distribution." }, "Method":{ "type":"string", "enum":[ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ] }, "MethodsList":{ "type":"list", "member":{ "shape":"Method", "locationName":"Method" } }, "MinimumProtocolVersion":{ "type":"string", "enum":[ "SSLv3", "TLSv1" ] }, "MissingBody":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, "NoSuchCloudFrontOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, "NoSuchDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, "NoSuchInvalidation":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified invalidation does not exist." }, "NoSuchOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"No origin exists with the specified Origin Id." }, "NoSuchStreamingDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, "Origin":{ "type":"structure", "required":[ "Id", "DomainName" ], "members":{ "Id":{ "shape":"string", "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." }, "DomainName":{ "shape":"string", "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." }, "OriginPath":{ "shape":"string", "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." }, "S3OriginConfig":{ "shape":"S3OriginConfig", "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "CustomOriginConfig":{ "shape":"CustomOriginConfig", "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." } }, "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." }, "OriginList":{ "type":"list", "member":{ "shape":"Origin", "locationName":"Origin" }, "min":1 }, "OriginProtocolPolicy":{ "type":"string", "enum":[ "http-only", "match-viewer" ] }, "Origins":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of origins for this distribution." }, "Items":{ "shape":"OriginList", "documentation":"A complex type that contains origins for this distribution." } }, "documentation":"A complex type that contains information about origins for this distribution." }, "PathList":{ "type":"list", "member":{ "shape":"string", "locationName":"Path" } }, "Paths":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of objects that you want to invalidate." }, "Items":{ "shape":"PathList", "documentation":"A complex type that contains a list of the objects that you want to invalidate." } }, "documentation":"A complex type that contains information about the objects that you want to invalidate." }, "PreconditionFailed":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, "PriceClass":{ "type":"string", "enum":[ "PriceClass_100", "PriceClass_200", "PriceClass_All" ] }, "Restrictions":{ "type":"structure", "required":["GeoRestriction"], "members":{ "GeoRestriction":{"shape":"GeoRestriction"} }, "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." }, "S3Origin":{ "type":"structure", "required":[ "DomainName", "OriginAccessIdentity" ], "members":{ "DomainName":{ "shape":"string", "documentation":"The DNS name of the S3 origin." }, "OriginAccessIdentity":{ "shape":"string", "documentation":"Your S3 origin's origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "S3OriginConfig":{ "type":"structure", "required":["OriginAccessIdentity"], "members":{ "OriginAccessIdentity":{ "shape":"string", "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "SSLSupportMethod":{ "type":"string", "enum":[ "sni-only", "vip" ] }, "Signer":{ "type":"structure", "members":{ "AwsAccountNumber":{ "shape":"string", "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." }, "KeyPairIds":{ "shape":"KeyPairIds", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." }, "SignerList":{ "type":"list", "member":{ "shape":"Signer", "locationName":"Signer" } }, "StreamingDistribution":{ "type":"structure", "required":[ "Id", "Status", "DomainName", "ActiveTrustedSigners", "StreamingDistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." }, "Status":{ "shape":"string", "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The current configuration information for the streaming distribution." } }, "documentation":"A streaming distribution." }, "StreamingDistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionConfig":{ "type":"structure", "required":[ "CallerReference", "S3Origin", "Comment", "TrustedSigners", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the streaming distribution." }, "Logging":{ "shape":"StreamingLoggingConfig", "documentation":"A complex type that controls whether access logs are written for the streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this streaming distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." } }, "documentation":"The configuration for the streaming distribution." }, "StreamingDistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more streaming distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of streaming distributions that were created by the current AWS account." }, "Items":{ "shape":"StreamingDistributionSummaryList", "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A streaming distribution list." }, "StreamingDistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionSummary":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "DomainName", "S3Origin", "Aliases", "TrustedSigners", "Comment", "PriceClass", "Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." } }, "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." }, "StreamingDistributionSummaryList":{ "type":"list", "member":{ "shape":"StreamingDistributionSummary", "locationName":"StreamingDistributionSummary" } }, "StreamingLoggingConfig":{ "type":"structure", "required":[ "Enabled", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for this streaming distribution." }, "TooManyCacheBehaviors":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore cache behaviors for the distribution." }, "TooManyCertificates":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore custom ssl certificates." }, "TooManyCloudFrontOriginAccessIdentities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." }, "TooManyCookieNamesInWhiteList":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." }, "TooManyDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more CNAMEs than are allowed per distribution." }, "TooManyDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." }, "TooManyHeadersInForwardedValues":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyInvalidationsInProgress":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." }, "TooManyOrigins":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore origins for the distribution." }, "TooManyStreamingDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." }, "TooManyTrustedSigners":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, "TrustedSignerDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, "TrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." }, "Quantity":{ "shape":"integer", "documentation":"The number of trusted signers for this cache behavior." }, "Items":{ "shape":"AwsAccountNumberList", "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "UpdateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":[ "CloudFrontOriginAccessIdentityConfig", "Id" ], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The identity's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-07-27/"}, "locationName":"CloudFrontOriginAccessIdentityConfig" }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The identity's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to update an origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "UpdateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "UpdateDistributionRequest":{ "type":"structure", "required":[ "DistributionConfig", "Id" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-07-27/"}, "locationName":"DistributionConfig" }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to update a distribution.", "payload":"DistributionConfig" }, "UpdateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "UpdateStreamingDistributionRequest":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Id" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-07-27/"}, "locationName":"StreamingDistributionConfig" }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The streaming distribution's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to update a streaming distribution.", "payload":"StreamingDistributionConfig" }, "UpdateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "ViewerCertificate":{ "type":"structure", "members":{ "IAMCertificateId":{ "shape":"string", "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate." }, "CloudFrontDefaultCertificate":{ "shape":"boolean", "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId." }, "SSLSupportMethod":{ "shape":"SSLSupportMethod", "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." }, "MinimumProtocolVersion":{ "shape":"MinimumProtocolVersion", "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." } }, "documentation":"A complex type that contains information about viewer certificates for this distribution." }, "ViewerProtocolPolicy":{ "type":"string", "enum":[ "allow-all", "https-only", "redirect-to-https" ] }, "boolean":{"type":"boolean"}, "integer":{"type":"integer"}, "long":{"type":"long"}, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} }, "examples":{ } } botocore-1.5.7/botocore/data/cloudfront/2014-11-06/0000777454262600001440000000000013042511307022342 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/cloudfront/2014-11-06/waiters-2.json0000666454262600001440000000224013042511306025047 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "DistributionDeployed": { "delay": 60, "operation": "GetDistribution", "maxAttempts": 25, "description": "Wait until a distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "Distribution.Status" } ] }, "InvalidationCompleted": { "delay": 20, "operation": "GetInvalidation", "maxAttempts": 60, "description": "Wait until an invalidation has completed.", "acceptors": [ { "expected": "Completed", "matcher": "path", "state": "success", "argument": "Invalidation.Status" } ] }, "StreamingDistributionDeployed": { "delay": 60, "operation": "GetStreamingDistribution", "maxAttempts": 25, "description": "Wait until a streaming distribution is deployed.", "acceptors": [ { "expected": "Deployed", "matcher": "path", "state": "success", "argument": "StreamingDistribution.Status" } ] } } } botocore-1.5.7/botocore/data/cloudfront/2014-11-06/paginators-1.json0000666454262600001440000000214613042511306025544 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListCloudFrontOriginAccessIdentities": { "input_token": "Marker", "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", "limit_key": "MaxItems", "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", "result_key": "CloudFrontOriginAccessIdentityList.Items" }, "ListDistributions": { "input_token": "Marker", "output_token": "DistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "DistributionList.IsTruncated", "result_key": "DistributionList.Items" }, "ListInvalidations": { "input_token": "Marker", "output_token": "InvalidationList.NextMarker", "limit_key": "MaxItems", "more_results": "InvalidationList.IsTruncated", "result_key": "InvalidationList.Items" }, "ListStreamingDistributions": { "input_token": "Marker", "output_token": "StreamingDistributionList.NextMarker", "limit_key": "MaxItems", "more_results": "StreamingDistributionList.IsTruncated", "result_key": "StreamingDistributionList.Items" } } } botocore-1.5.7/botocore/data/cloudfront/2014-11-06/service-2.json0000666454262600001440000044032613042511306025044 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2014-11-06", "endpointPrefix":"cloudfront", "globalEndpoint":"cloudfront.amazonaws.com", "serviceAbbreviation":"CloudFront", "serviceFullName":"Amazon CloudFront", "signatureVersion":"v4", "protocol":"rest-xml" }, "operations":{ "CreateCloudFrontOriginAccessIdentity":{ "name":"CreateCloudFrontOriginAccessIdentity2014_11_06", "http":{ "method":"POST", "requestUri":"/2014-11-06/origin-access-identity/cloudfront", "responseCode":201 }, "input":{ "shape":"CreateCloudFrontOriginAccessIdentityRequest", "documentation":"The request to create a new origin access identity." }, "output":{ "shape":"CreateCloudFrontOriginAccessIdentityResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"CloudFrontOriginAccessIdentityAlreadyExists", "error":{"httpStatusCode":409}, "exception":true, "documentation":"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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"TooManyCloudFrontOriginAccessIdentities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Create a new origin access identity." }, "CreateDistribution":{ "name":"CreateDistribution2014_11_06", "http":{ "method":"POST", "requestUri":"/2014-11-06/distribution", "responseCode":201 }, "input":{ "shape":"CreateDistributionRequest", "documentation":"The request to create a new distribution." }, "output":{ "shape":"CreateDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"DistributionAlreadyExists", "error":{"httpStatusCode":409}, "exception":true, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." }, { "shape":"InvalidOrigin", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"InvalidViewerCertificate", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"TooManyDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more CNAMEs than are allowed per distribution." }, { "shape":"TooManyDistributions", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." }, { "shape":"InvalidDefaultRootObject", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The default root object file name is too big or contains an invalid character." }, { "shape":"InvalidRelativePath", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." }, { "shape":"InvalidErrorCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidResponseCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InvalidRequiredProtocol", "error":{"httpStatusCode":400}, "exception":true, "documentation":"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." }, { "shape":"NoSuchOrigin", "error":{"httpStatusCode":404}, "exception":true, "documentation":"No origin exists with the specified Origin Id." }, { "shape":"TooManyOrigins", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore origins for the distribution." }, { "shape":"TooManyCacheBehaviors", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore cache behaviors for the distribution." }, { "shape":"TooManyCookieNamesInWhiteList", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." }, { "shape":"InvalidForwardCookies", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." }, { "shape":"TooManyHeadersInForwardedValues", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidHeadersForS3Origin", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." }, { "shape":"TooManyCertificates", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore custom ssl certificates." }, { "shape":"InvalidLocationCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidGeoRestrictionParameter", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidProtocolSettings", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." } ], "documentation":"Create a new distribution." }, "CreateInvalidation":{ "name":"CreateInvalidation2014_11_06", "http":{ "method":"POST", "requestUri":"/2014-11-06/distribution/{DistributionId}/invalidation", "responseCode":201 }, "input":{ "shape":"CreateInvalidationRequest", "documentation":"The request to create an invalidation." }, "output":{ "shape":"CreateInvalidationResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"BatchTooLarge", "error":{"httpStatusCode":413}, "exception":true }, { "shape":"TooManyInvalidationsInProgress", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Create a new invalidation." }, "CreateStreamingDistribution":{ "name":"CreateStreamingDistribution2014_11_06", "http":{ "method":"POST", "requestUri":"/2014-11-06/streaming-distribution", "responseCode":201 }, "input":{ "shape":"CreateStreamingDistributionRequest", "documentation":"The request to create a new streaming distribution." }, "output":{ "shape":"CreateStreamingDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"StreamingDistributionAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"InvalidOrigin", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"TooManyStreamingDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"TooManyStreamingDistributions", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Create a new streaming distribution." }, "DeleteCloudFrontOriginAccessIdentity":{ "name":"DeleteCloudFrontOriginAccessIdentity2014_11_06", "http":{ "method":"DELETE", "requestUri":"/2014-11-06/origin-access-identity/cloudfront/{Id}", "responseCode":204 }, "input":{ "shape":"DeleteCloudFrontOriginAccessIdentityRequest", "documentation":"The request to delete a origin access identity." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"CloudFrontOriginAccessIdentityInUse", "error":{"httpStatusCode":409}, "exception":true } ], "documentation":"Delete an origin access identity." }, "DeleteDistribution":{ "name":"DeleteDistribution2014_11_06", "http":{ "method":"DELETE", "requestUri":"/2014-11-06/distribution/{Id}", "responseCode":204 }, "input":{ "shape":"DeleteDistributionRequest", "documentation":"The request to delete a distribution." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"DistributionNotDisabled", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." } ], "documentation":"Delete a distribution." }, "DeleteStreamingDistribution":{ "name":"DeleteStreamingDistribution2014_11_06", "http":{ "method":"DELETE", "requestUri":"/2014-11-06/streaming-distribution/{Id}", "responseCode":204 }, "input":{ "shape":"DeleteStreamingDistributionRequest", "documentation":"The request to delete a streaming distribution." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"StreamingDistributionNotDisabled", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." } ], "documentation":"Delete a streaming distribution." }, "GetCloudFrontOriginAccessIdentity":{ "name":"GetCloudFrontOriginAccessIdentity2014_11_06", "http":{ "method":"GET", "requestUri":"/2014-11-06/origin-access-identity/cloudfront/{Id}" }, "input":{ "shape":"GetCloudFrontOriginAccessIdentityRequest", "documentation":"The request to get an origin access identity's information." }, "output":{ "shape":"GetCloudFrontOriginAccessIdentityResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about an origin access identity." }, "GetCloudFrontOriginAccessIdentityConfig":{ "name":"GetCloudFrontOriginAccessIdentityConfig2014_11_06", "http":{ "method":"GET", "requestUri":"/2014-11-06/origin-access-identity/cloudfront/{Id}/config" }, "input":{ "shape":"GetCloudFrontOriginAccessIdentityConfigRequest", "documentation":"The request to get an origin access identity's configuration." }, "output":{ "shape":"GetCloudFrontOriginAccessIdentityConfigResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the configuration information about an origin access identity." }, "GetDistribution":{ "name":"GetDistribution2014_11_06", "http":{ "method":"GET", "requestUri":"/2014-11-06/distribution/{Id}" }, "input":{ "shape":"GetDistributionRequest", "documentation":"The request to get a distribution's information." }, "output":{ "shape":"GetDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about a distribution." }, "GetDistributionConfig":{ "name":"GetDistributionConfig2014_11_06", "http":{ "method":"GET", "requestUri":"/2014-11-06/distribution/{Id}/config" }, "input":{ "shape":"GetDistributionConfigRequest", "documentation":"The request to get a distribution configuration." }, "output":{ "shape":"GetDistributionConfigResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the configuration information about a distribution." }, "GetInvalidation":{ "name":"GetInvalidation2014_11_06", "http":{ "method":"GET", "requestUri":"/2014-11-06/distribution/{DistributionId}/invalidation/{Id}" }, "input":{ "shape":"GetInvalidationRequest", "documentation":"The request to get an invalidation's information." }, "output":{ "shape":"GetInvalidationResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchInvalidation", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified invalidation does not exist." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about an invalidation." }, "GetStreamingDistribution":{ "name":"GetStreamingDistribution2014_11_06", "http":{ "method":"GET", "requestUri":"/2014-11-06/streaming-distribution/{Id}" }, "input":{ "shape":"GetStreamingDistributionRequest", "documentation":"The request to get a streaming distribution's information." }, "output":{ "shape":"GetStreamingDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the information about a streaming distribution." }, "GetStreamingDistributionConfig":{ "name":"GetStreamingDistributionConfig2014_11_06", "http":{ "method":"GET", "requestUri":"/2014-11-06/streaming-distribution/{Id}/config" }, "input":{ "shape":"GetStreamingDistributionConfigRequest", "documentation":"To request to get a streaming distribution configuration." }, "output":{ "shape":"GetStreamingDistributionConfigResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"Get the configuration information about a streaming distribution." }, "ListCloudFrontOriginAccessIdentities":{ "name":"ListCloudFrontOriginAccessIdentities2014_11_06", "http":{ "method":"GET", "requestUri":"/2014-11-06/origin-access-identity/cloudfront" }, "input":{ "shape":"ListCloudFrontOriginAccessIdentitiesRequest", "documentation":"The request to list origin access identities." }, "output":{ "shape":"ListCloudFrontOriginAccessIdentitiesResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." } ], "documentation":"List origin access identities." }, "ListDistributions":{ "name":"ListDistributions2014_11_06", "http":{ "method":"GET", "requestUri":"/2014-11-06/distribution" }, "input":{ "shape":"ListDistributionsRequest", "documentation":"The request to list your distributions." }, "output":{ "shape":"ListDistributionsResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." } ], "documentation":"List distributions." }, "ListInvalidations":{ "name":"ListInvalidations2014_11_06", "http":{ "method":"GET", "requestUri":"/2014-11-06/distribution/{DistributionId}/invalidation" }, "input":{ "shape":"ListInvalidationsRequest", "documentation":"The request to list invalidations." }, "output":{ "shape":"ListInvalidationsResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." } ], "documentation":"List invalidation batches." }, "ListStreamingDistributions":{ "name":"ListStreamingDistributions2014_11_06", "http":{ "method":"GET", "requestUri":"/2014-11-06/streaming-distribution" }, "input":{ "shape":"ListStreamingDistributionsRequest", "documentation":"The request to list your streaming distributions." }, "output":{ "shape":"ListStreamingDistributionsResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." } ], "documentation":"List streaming distributions." }, "UpdateCloudFrontOriginAccessIdentity":{ "name":"UpdateCloudFrontOriginAccessIdentity2014_11_06", "http":{ "method":"PUT", "requestUri":"/2014-11-06/origin-access-identity/cloudfront/{Id}/config" }, "input":{ "shape":"UpdateCloudFrontOriginAccessIdentityRequest", "documentation":"The request to update an origin access identity." }, "output":{ "shape":"UpdateCloudFrontOriginAccessIdentityResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"IllegalUpdate", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"NoSuchCloudFrontOriginAccessIdentity", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Update an origin access identity." }, "UpdateDistribution":{ "name":"UpdateDistribution2014_11_06", "http":{ "method":"PUT", "requestUri":"/2014-11-06/distribution/{Id}/config" }, "input":{ "shape":"UpdateDistributionRequest", "documentation":"The request to update a distribution." }, "output":{ "shape":"UpdateDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"IllegalUpdate", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"NoSuchDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"TooManyDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more CNAMEs than are allowed per distribution." }, { "shape":"InvalidDefaultRootObject", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The default root object file name is too big or contains an invalid character." }, { "shape":"InvalidRelativePath", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." }, { "shape":"InvalidErrorCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidResponseCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"InvalidViewerCertificate", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidRequiredProtocol", "error":{"httpStatusCode":400}, "exception":true, "documentation":"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." }, { "shape":"NoSuchOrigin", "error":{"httpStatusCode":404}, "exception":true, "documentation":"No origin exists with the specified Origin Id." }, { "shape":"TooManyOrigins", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore origins for the distribution." }, { "shape":"TooManyCacheBehaviors", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore cache behaviors for the distribution." }, { "shape":"TooManyCookieNamesInWhiteList", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." }, { "shape":"InvalidForwardCookies", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." }, { "shape":"TooManyHeadersInForwardedValues", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidHeadersForS3Origin", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." }, { "shape":"TooManyCertificates", "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore custom ssl certificates." }, { "shape":"InvalidLocationCode", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidGeoRestrictionParameter", "error":{"httpStatusCode":400}, "exception":true } ], "documentation":"Update a distribution." }, "UpdateStreamingDistribution":{ "name":"UpdateStreamingDistribution2014_11_06", "http":{ "method":"PUT", "requestUri":"/2014-11-06/streaming-distribution/{Id}/config" }, "input":{ "shape":"UpdateStreamingDistributionRequest", "documentation":"The request to update a streaming distribution." }, "output":{ "shape":"UpdateStreamingDistributionResult", "documentation":"The returned result of the corresponding request." }, "errors":[ { "shape":"AccessDenied", "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, { "shape":"CNAMEAlreadyExists", "error":{"httpStatusCode":409}, "exception":true }, { "shape":"IllegalUpdate", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, { "shape":"InvalidIfMatchVersion", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, { "shape":"MissingBody", "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, { "shape":"NoSuchStreamingDistribution", "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, { "shape":"PreconditionFailed", "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, { "shape":"TooManyStreamingDistributionCNAMEs", "error":{"httpStatusCode":400}, "exception":true }, { "shape":"InvalidArgument", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, { "shape":"InvalidOriginAccessIdentity", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, { "shape":"TooManyTrustedSigners", "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, { "shape":"TrustedSignerDoesNotExist", "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, { "shape":"InconsistentQuantities", "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." } ], "documentation":"Update a streaming distribution." } }, "shapes":{ "AccessDenied":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":403}, "exception":true, "documentation":"Access denied." }, "ActiveTrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Each active trusted signer." }, "Quantity":{ "shape":"integer", "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." }, "Items":{ "shape":"SignerList", "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." } }, "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." }, "AliasList":{ "type":"list", "member":{ "shape":"string", "locationName":"CNAME" } }, "Aliases":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of CNAMEs, if any, for this distribution." }, "Items":{ "shape":"AliasList", "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "AllowedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." }, "CachedMethods":{"shape":"CachedMethods"} }, "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." }, "AwsAccountNumberList":{ "type":"list", "member":{ "shape":"string", "locationName":"AwsAccountNumber" } }, "BatchTooLarge":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":413}, "exception":true }, "CNAMEAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CacheBehavior":{ "type":"structure", "required":[ "PathPattern", "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "PathPattern":{ "shape":"string", "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." }, "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." } }, "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." }, "CacheBehaviorList":{ "type":"list", "member":{ "shape":"CacheBehavior", "locationName":"CacheBehavior" } }, "CacheBehaviors":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of cache behaviors for this distribution." }, "Items":{ "shape":"CacheBehaviorList", "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CachedMethods":{ "type":"structure", "required":[ "Quantity", "Items" ], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." }, "Items":{ "shape":"MethodsList", "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." } }, "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." }, "CloudFrontOriginAccessIdentity":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The current configuration information for the identity." } }, "documentation":"CloudFront origin access identity." }, "CloudFrontOriginAccessIdentityAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, "CloudFrontOriginAccessIdentityConfig":{ "type":"structure", "required":[ "CallerReference", "Comment" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the origin access identity." } }, "documentation":"Origin access identity configuration." }, "CloudFrontOriginAccessIdentityInUse":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "CloudFrontOriginAccessIdentityList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more origin access identities remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." }, "Items":{ "shape":"CloudFrontOriginAccessIdentitySummaryList", "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." } }, "documentation":"The CloudFrontOriginAccessIdentityList type." }, "CloudFrontOriginAccessIdentitySummary":{ "type":"structure", "required":[ "Id", "S3CanonicalUserId", "Comment" ], "members":{ "Id":{ "shape":"string", "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." }, "S3CanonicalUserId":{ "shape":"string", "documentation":"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." }, "Comment":{ "shape":"string", "documentation":"The comment for this origin access identity, as originally specified when created." } }, "documentation":"Summary of the information about a CloudFront origin access identity." }, "CloudFrontOriginAccessIdentitySummaryList":{ "type":"list", "member":{ "shape":"CloudFrontOriginAccessIdentitySummary", "locationName":"CloudFrontOriginAccessIdentitySummary" } }, "CookieNameList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "CookieNames":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of whitelisted cookies for this cache behavior." }, "Items":{ "shape":"CookieNameList", "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." }, "CookiePreference":{ "type":"structure", "required":["Forward"], "members":{ "Forward":{ "shape":"ItemSelection", "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." }, "WhitelistedNames":{ "shape":"CookieNames", "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." } }, "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." }, "CreateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":["CloudFrontOriginAccessIdentityConfig"], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-11-06/"}, "locationName":"CloudFrontOriginAccessIdentityConfig" } }, "documentation":"The request to create a new origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "CreateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the origin access identity created." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "CreateDistributionRequest":{ "type":"structure", "required":["DistributionConfig"], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-11-06/"}, "locationName":"DistributionConfig" } }, "documentation":"The request to create a new distribution.", "payload":"DistributionConfig" }, "CreateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the distribution created." } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "CreateInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "InvalidationBatch" ], "members":{ "DistributionId":{ "shape":"string", "location":"uri", "locationName":"DistributionId", "documentation":"The distribution's id." }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The batch information for the invalidation.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-11-06/"}, "locationName":"InvalidationBatch" } }, "documentation":"The request to create an invalidation.", "payload":"InvalidationBatch" }, "CreateInvalidationResult":{ "type":"structure", "members":{ "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID." }, "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "CreateStreamingDistributionRequest":{ "type":"structure", "required":["StreamingDistributionConfig"], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-11-06/"}, "locationName":"StreamingDistributionConfig" } }, "documentation":"The request to create a new streaming distribution.", "payload":"StreamingDistributionConfig" }, "CreateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "Location":{ "shape":"string", "location":"header", "locationName":"Location", "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the streaming distribution created." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "CustomErrorResponse":{ "type":"structure", "required":["ErrorCode"], "members":{ "ErrorCode":{ "shape":"integer", "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." }, "ResponsePagePath":{ "shape":"string", "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." }, "ResponseCode":{ "shape":"string", "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." }, "ErrorCachingMinTTL":{ "shape":"long", "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." } }, "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." }, "CustomErrorResponseList":{ "type":"list", "member":{ "shape":"CustomErrorResponse", "locationName":"CustomErrorResponse" } }, "CustomErrorResponses":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of custom error responses for this distribution." }, "Items":{ "shape":"CustomErrorResponseList", "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "CustomOriginConfig":{ "type":"structure", "required":[ "HTTPPort", "HTTPSPort", "OriginProtocolPolicy" ], "members":{ "HTTPPort":{ "shape":"integer", "documentation":"The HTTP port the custom origin listens on." }, "HTTPSPort":{ "shape":"integer", "documentation":"The HTTPS port the custom origin listens on." }, "OriginProtocolPolicy":{ "shape":"OriginProtocolPolicy", "documentation":"The origin protocol policy to apply to your origin." } }, "documentation":"A customer origin." }, "DefaultCacheBehavior":{ "type":"structure", "required":[ "TargetOriginId", "ForwardedValues", "TrustedSigners", "ViewerProtocolPolicy", "MinTTL" ], "members":{ "TargetOriginId":{ "shape":"string", "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." }, "ForwardedValues":{ "shape":"ForwardedValues", "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "ViewerProtocolPolicy":{ "shape":"ViewerProtocolPolicy", "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." }, "MinTTL":{ "shape":"long", "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." }, "AllowedMethods":{"shape":"AllowedMethods"}, "SmoothStreaming":{ "shape":"boolean", "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." } }, "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "DeleteCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The origin access identity's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to delete a origin access identity.", "required":["Id"] }, "DeleteDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to delete a distribution.", "required":["Id"] }, "DeleteStreamingDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to delete a streaming distribution.", "required":["Id"] }, "Distribution":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "InProgressInvalidationBatches", "DomainName", "ActiveTrustedSigners", "DistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "InProgressInvalidationBatches":{ "shape":"integer", "documentation":"The number of invalidation batches currently in progress." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The current configuration information for the distribution." } }, "documentation":"A distribution." }, "DistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true, "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." }, "DistributionConfig":{ "type":"structure", "required":[ "CallerReference", "Origins", "DefaultCacheBehavior", "Comment", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "DefaultRootObject":{ "shape":"string", "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponse elements." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the distribution." }, "Logging":{ "shape":"LoggingConfig", "documentation":"A complex type that controls whether access logs are written for the distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"} }, "documentation":"A distribution Configuration." }, "DistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of distributions that were created by the current AWS account." }, "Items":{ "shape":"DistributionSummaryList", "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A distribution list." }, "DistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "DistributionSummary":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "DomainName", "Aliases", "Origins", "DefaultCacheBehavior", "CacheBehaviors", "CustomErrorResponses", "Comment", "PriceClass", "Enabled", "ViewerCertificate", "Restrictions" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "Origins":{ "shape":"Origins", "documentation":"A complex type that contains information about origins for this distribution." }, "DefaultCacheBehavior":{ "shape":"DefaultCacheBehavior", "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." }, "CacheBehaviors":{ "shape":"CacheBehaviors", "documentation":"A complex type that contains zero or more CacheBehavior elements." }, "CustomErrorResponses":{ "shape":"CustomErrorResponses", "documentation":"A complex type that contains zero or more CustomErrorResponses elements." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." }, "ViewerCertificate":{"shape":"ViewerCertificate"}, "Restrictions":{"shape":"Restrictions"} }, "documentation":"A summary of the information for an Amazon CloudFront distribution." }, "DistributionSummaryList":{ "type":"list", "member":{ "shape":"DistributionSummary", "locationName":"DistributionSummary" } }, "ForwardedValues":{ "type":"structure", "required":[ "QueryString", "Cookies" ], "members":{ "QueryString":{ "shape":"boolean", "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." }, "Cookies":{ "shape":"CookiePreference", "documentation":"A complex type that specifies how CloudFront handles cookies." }, "Headers":{ "shape":"Headers", "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." } }, "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." }, "GeoRestriction":{ "type":"structure", "required":[ "RestrictionType", "Quantity" ], "members":{ "RestrictionType":{ "shape":"GeoRestrictionType", "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." }, "Quantity":{ "shape":"integer", "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." }, "Items":{ "shape":"LocationList", "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." } }, "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." }, "GeoRestrictionType":{ "type":"string", "enum":[ "blacklist", "whitelist", "none" ] }, "GetCloudFrontOriginAccessIdentityConfigRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The identity's id." } }, "documentation":"The request to get an origin access identity's configuration.", "required":["Id"] }, "GetCloudFrontOriginAccessIdentityConfigResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The origin access identity's configuration information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "GetCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The identity's id." } }, "documentation":"The request to get an origin access identity's information.", "required":["Id"] }, "GetCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "GetDistributionConfigRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution's id." } }, "documentation":"The request to get a distribution configuration.", "required":["Id"] }, "GetDistributionConfigResult":{ "type":"structure", "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionConfig" }, "GetDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution's id." } }, "documentation":"The request to get a distribution's information.", "required":["Id"] }, "GetDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "GetInvalidationRequest":{ "type":"structure", "required":[ "DistributionId", "Id" ], "members":{ "DistributionId":{ "shape":"string", "location":"uri", "locationName":"DistributionId", "documentation":"The distribution's id." }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The invalidation's id." } }, "documentation":"The request to get an invalidation's information." }, "GetInvalidationResult":{ "type":"structure", "members":{ "Invalidation":{ "shape":"Invalidation", "documentation":"The invalidation's information." } }, "documentation":"The returned result of the corresponding request.", "payload":"Invalidation" }, "GetStreamingDistributionConfigRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The streaming distribution's id." } }, "documentation":"To request to get a streaming distribution configuration.", "required":["Id"] }, "GetStreamingDistributionConfigResult":{ "type":"structure", "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionConfig" }, "GetStreamingDistributionRequest":{ "type":"structure", "members":{ "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The streaming distribution's id." } }, "documentation":"The request to get a streaming distribution's information.", "required":["Id"] }, "GetStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "HeaderList":{ "type":"list", "member":{ "shape":"string", "locationName":"Name" } }, "Headers":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." }, "Items":{ "shape":"HeaderList", "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." } }, "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." }, "IllegalUpdate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Origin and CallerReference cannot be updated." }, "InconsistentQuantities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The value of Quantity and the size of Items do not match." }, "InvalidArgument":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The argument is invalid." }, "InvalidDefaultRootObject":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The default root object file name is too big or contains an invalid character." }, "InvalidErrorCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidForwardCookies":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." }, "InvalidGeoRestrictionParameter":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidHeadersForS3Origin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidIfMatchVersion":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The If-Match version is missing or not valid for the distribution." }, "InvalidLocationCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." }, "InvalidOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The origin access identity is not valid or doesn't exist." }, "InvalidProtocolSettings":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." }, "InvalidRelativePath":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." }, "InvalidRequiredProtocol":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"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." }, "InvalidResponseCode":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "InvalidViewerCertificate":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "Invalidation":{ "type":"structure", "required":[ "Id", "Status", "CreateTime", "InvalidationBatch" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." }, "CreateTime":{ "shape":"timestamp", "documentation":"The date and time the invalidation request was first made." }, "InvalidationBatch":{ "shape":"InvalidationBatch", "documentation":"The current invalidation information for the batch request." } }, "documentation":"An invalidation." }, "InvalidationBatch":{ "type":"structure", "required":[ "Paths", "CallerReference" ], "members":{ "Paths":{ "shape":"Paths", "documentation":"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. 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. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." }, "CallerReference":{ "shape":"string", "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. 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, the response includes the same information returned to the original request. 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, CloudFront returns an InvalidationBatchAlreadyExists error." } }, "documentation":"An invalidation batch." }, "InvalidationList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of invalidation batches that were created by the current AWS account." }, "Items":{ "shape":"InvalidationSummaryList", "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." } }, "documentation":"An invalidation list." }, "InvalidationSummary":{ "type":"structure", "required":[ "Id", "CreateTime", "Status" ], "members":{ "Id":{ "shape":"string", "documentation":"The unique ID for an invalidation request." }, "CreateTime":{"shape":"timestamp"}, "Status":{ "shape":"string", "documentation":"The status of an invalidation request." } }, "documentation":"Summary of an invalidation request." }, "InvalidationSummaryList":{ "type":"list", "member":{ "shape":"InvalidationSummary", "locationName":"InvalidationSummary" } }, "ItemSelection":{ "type":"string", "enum":[ "none", "whitelist", "all" ] }, "KeyPairIdList":{ "type":"list", "member":{ "shape":"string", "locationName":"KeyPairId" } }, "KeyPairIds":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." }, "Items":{ "shape":"KeyPairIdList", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." }, "ListCloudFrontOriginAccessIdentitiesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"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. 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)." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of origin access identities you want in the response body." } }, "documentation":"The request to list origin access identities." }, "ListCloudFrontOriginAccessIdentitiesResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentityList":{ "shape":"CloudFrontOriginAccessIdentityList", "documentation":"The CloudFrontOriginAccessIdentityList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentityList" }, "ListDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"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. 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)." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of distributions you want in the response body." } }, "documentation":"The request to list your distributions." }, "ListDistributionsResult":{ "type":"structure", "members":{ "DistributionList":{ "shape":"DistributionList", "documentation":"The DistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"DistributionList" }, "ListInvalidationsRequest":{ "type":"structure", "required":["DistributionId"], "members":{ "DistributionId":{ "shape":"string", "location":"uri", "locationName":"DistributionId", "documentation":"The distribution's id." }, "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. 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. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of invalidation batches you want in the response body." } }, "documentation":"The request to list invalidations." }, "ListInvalidationsResult":{ "type":"structure", "members":{ "InvalidationList":{ "shape":"InvalidationList", "documentation":"Information about invalidation batches." } }, "documentation":"The returned result of the corresponding request.", "payload":"InvalidationList" }, "ListStreamingDistributionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"string", "location":"querystring", "locationName":"Marker", "documentation":"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. 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)." }, "MaxItems":{ "shape":"string", "location":"querystring", "locationName":"MaxItems", "documentation":"The maximum number of streaming distributions you want in the response body." } }, "documentation":"The request to list your streaming distributions." }, "ListStreamingDistributionsResult":{ "type":"structure", "members":{ "StreamingDistributionList":{ "shape":"StreamingDistributionList", "documentation":"The StreamingDistributionList type." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistributionList" }, "LocationList":{ "type":"list", "member":{ "shape":"string", "locationName":"Location" } }, "LoggingConfig":{ "type":"structure", "required":[ "Enabled", "IncludeCookies", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." }, "IncludeCookies":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for the distribution." }, "Method":{ "type":"string", "enum":[ "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE" ] }, "MethodsList":{ "type":"list", "member":{ "shape":"Method", "locationName":"Method" } }, "MinimumProtocolVersion":{ "type":"string", "enum":[ "SSLv3", "TLSv1" ] }, "MissingBody":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." }, "NoSuchCloudFrontOriginAccessIdentity":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified origin access identity does not exist." }, "NoSuchDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified distribution does not exist." }, "NoSuchInvalidation":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified invalidation does not exist." }, "NoSuchOrigin":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"No origin exists with the specified Origin Id." }, "NoSuchStreamingDistribution":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"The specified streaming distribution does not exist." }, "Origin":{ "type":"structure", "required":[ "Id", "DomainName" ], "members":{ "Id":{ "shape":"string", "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." }, "DomainName":{ "shape":"string", "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." }, "OriginPath":{ "shape":"string", "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." }, "S3OriginConfig":{ "shape":"S3OriginConfig", "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "CustomOriginConfig":{ "shape":"CustomOriginConfig", "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." } }, "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." }, "OriginList":{ "type":"list", "member":{ "shape":"Origin", "locationName":"Origin" }, "min":1 }, "OriginProtocolPolicy":{ "type":"string", "enum":[ "http-only", "match-viewer" ] }, "Origins":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of origins for this distribution." }, "Items":{ "shape":"OriginList", "documentation":"A complex type that contains origins for this distribution." } }, "documentation":"A complex type that contains information about origins for this distribution." }, "PathList":{ "type":"list", "member":{ "shape":"string", "locationName":"Path" } }, "Paths":{ "type":"structure", "required":["Quantity"], "members":{ "Quantity":{ "shape":"integer", "documentation":"The number of objects that you want to invalidate." }, "Items":{ "shape":"PathList", "documentation":"A complex type that contains a list of the objects that you want to invalidate." } }, "documentation":"A complex type that contains information about the objects that you want to invalidate." }, "PreconditionFailed":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":412}, "exception":true, "documentation":"The precondition given in one or more of the request-header fields evaluated to false." }, "PriceClass":{ "type":"string", "enum":[ "PriceClass_100", "PriceClass_200", "PriceClass_All" ] }, "Restrictions":{ "type":"structure", "required":["GeoRestriction"], "members":{ "GeoRestriction":{"shape":"GeoRestriction"} }, "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." }, "S3Origin":{ "type":"structure", "required":[ "DomainName", "OriginAccessIdentity" ], "members":{ "DomainName":{ "shape":"string", "documentation":"The DNS name of the S3 origin." }, "OriginAccessIdentity":{ "shape":"string", "documentation":"Your S3 origin's origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "S3OriginConfig":{ "type":"structure", "required":["OriginAccessIdentity"], "members":{ "OriginAccessIdentity":{ "shape":"string", "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." } }, "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." }, "SSLSupportMethod":{ "type":"string", "enum":[ "sni-only", "vip" ] }, "Signer":{ "type":"structure", "members":{ "AwsAccountNumber":{ "shape":"string", "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." }, "KeyPairIds":{ "shape":"KeyPairIds", "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." } }, "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." }, "SignerList":{ "type":"list", "member":{ "shape":"Signer", "locationName":"Signer" } }, "StreamingDistribution":{ "type":"structure", "required":[ "Id", "Status", "DomainName", "ActiveTrustedSigners", "StreamingDistributionConfig" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." }, "Status":{ "shape":"string", "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." }, "ActiveTrustedSigners":{ "shape":"ActiveTrustedSigners", "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). 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." }, "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The current configuration information for the streaming distribution." } }, "documentation":"A streaming distribution." }, "StreamingDistributionAlreadyExists":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionConfig":{ "type":"structure", "required":[ "CallerReference", "S3Origin", "Comment", "TrustedSigners", "Enabled" ], "members":{ "CallerReference":{ "shape":"string", "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. 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), the response includes the same information returned to the original request. 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, CloudFront returns a DistributionAlreadyExists error." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "Comment":{ "shape":"string", "documentation":"Any comments you want to include about the streaming distribution." }, "Logging":{ "shape":"StreamingLoggingConfig", "documentation":"A complex type that controls whether access logs are written for the streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "PriceClass":{ "shape":"PriceClass", "documentation":"A complex type that contains information about price class for this streaming distribution." }, "Enabled":{ "shape":"boolean", "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." } }, "documentation":"The configuration for the streaming distribution." }, "StreamingDistributionList":{ "type":"structure", "required":[ "Marker", "MaxItems", "IsTruncated", "Quantity" ], "members":{ "Marker":{ "shape":"string", "documentation":"The value you provided for the Marker request parameter." }, "NextMarker":{ "shape":"string", "documentation":"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." }, "MaxItems":{ "shape":"integer", "documentation":"The value you provided for the MaxItems request parameter." }, "IsTruncated":{ "shape":"boolean", "documentation":"A flag that indicates whether more streaming distributions remain to be listed. 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." }, "Quantity":{ "shape":"integer", "documentation":"The number of streaming distributions that were created by the current AWS account." }, "Items":{ "shape":"StreamingDistributionSummaryList", "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." } }, "documentation":"A streaming distribution list." }, "StreamingDistributionNotDisabled":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":409}, "exception":true }, "StreamingDistributionSummary":{ "type":"structure", "required":[ "Id", "Status", "LastModifiedTime", "DomainName", "S3Origin", "Aliases", "TrustedSigners", "Comment", "PriceClass", "Enabled" ], "members":{ "Id":{ "shape":"string", "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." }, "Status":{ "shape":"string", "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." }, "LastModifiedTime":{ "shape":"timestamp", "documentation":"The date and time the distribution was last modified." }, "DomainName":{ "shape":"string", "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." }, "S3Origin":{ "shape":"S3Origin", "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." }, "Aliases":{ "shape":"Aliases", "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." }, "TrustedSigners":{ "shape":"TrustedSigners", "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "Comment":{ "shape":"string", "documentation":"The comment originally specified when this distribution was created." }, "PriceClass":{"shape":"PriceClass"}, "Enabled":{ "shape":"boolean", "documentation":"Whether the distribution is enabled to accept end user requests for content." } }, "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." }, "StreamingDistributionSummaryList":{ "type":"list", "member":{ "shape":"StreamingDistributionSummary", "locationName":"StreamingDistributionSummary" } }, "StreamingLoggingConfig":{ "type":"structure", "required":[ "Enabled", "Bucket", "Prefix" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." }, "Bucket":{ "shape":"string", "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." }, "Prefix":{ "shape":"string", "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." } }, "documentation":"A complex type that controls whether access logs are written for this streaming distribution." }, "TooManyCacheBehaviors":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore cache behaviors for the distribution." }, "TooManyCertificates":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore custom ssl certificates." }, "TooManyCloudFrontOriginAccessIdentities":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." }, "TooManyCookieNamesInWhiteList":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." }, "TooManyDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more CNAMEs than are allowed per distribution." }, "TooManyDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." }, "TooManyHeadersInForwardedValues":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyInvalidationsInProgress":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." }, "TooManyOrigins":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"You cannot create anymore origins for the distribution." }, "TooManyStreamingDistributionCNAMEs":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true }, "TooManyStreamingDistributions":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." }, "TooManyTrustedSigners":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"Your request contains more trusted signers than are allowed per distribution." }, "TrustedSignerDoesNotExist":{ "type":"structure", "members":{ "Message":{"shape":"string"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"One or more of your trusted signers do not exist." }, "TrustedSigners":{ "type":"structure", "required":[ "Enabled", "Quantity" ], "members":{ "Enabled":{ "shape":"boolean", "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." }, "Quantity":{ "shape":"integer", "documentation":"The number of trusted signers for this cache behavior." }, "Items":{ "shape":"AwsAccountNumberList", "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." } }, "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." }, "UpdateCloudFrontOriginAccessIdentityRequest":{ "type":"structure", "required":[ "CloudFrontOriginAccessIdentityConfig", "Id" ], "members":{ "CloudFrontOriginAccessIdentityConfig":{ "shape":"CloudFrontOriginAccessIdentityConfig", "documentation":"The identity's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-11-06/"}, "locationName":"CloudFrontOriginAccessIdentityConfig" }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The identity's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to update an origin access identity.", "payload":"CloudFrontOriginAccessIdentityConfig" }, "UpdateCloudFrontOriginAccessIdentityResult":{ "type":"structure", "members":{ "CloudFrontOriginAccessIdentity":{ "shape":"CloudFrontOriginAccessIdentity", "documentation":"The origin access identity's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"CloudFrontOriginAccessIdentity" }, "UpdateDistributionRequest":{ "type":"structure", "required":[ "DistributionConfig", "Id" ], "members":{ "DistributionConfig":{ "shape":"DistributionConfig", "documentation":"The distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-11-06/"}, "locationName":"DistributionConfig" }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The distribution's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to update a distribution.", "payload":"DistributionConfig" }, "UpdateDistributionResult":{ "type":"structure", "members":{ "Distribution":{ "shape":"Distribution", "documentation":"The distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"Distribution" }, "UpdateStreamingDistributionRequest":{ "type":"structure", "required":[ "StreamingDistributionConfig", "Id" ], "members":{ "StreamingDistributionConfig":{ "shape":"StreamingDistributionConfig", "documentation":"The streaming distribution's configuration information.", "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-11-06/"}, "locationName":"StreamingDistributionConfig" }, "Id":{ "shape":"string", "location":"uri", "locationName":"Id", "documentation":"The streaming distribution's id." }, "IfMatch":{ "shape":"string", "location":"header", "locationName":"If-Match", "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The request to update a streaming distribution.", "payload":"StreamingDistributionConfig" }, "UpdateStreamingDistributionResult":{ "type":"structure", "members":{ "StreamingDistribution":{ "shape":"StreamingDistribution", "documentation":"The streaming distribution's information." }, "ETag":{ "shape":"string", "location":"header", "locationName":"ETag", "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." } }, "documentation":"The returned result of the corresponding request.", "payload":"StreamingDistribution" }, "ViewerCertificate":{ "type":"structure", "members":{ "IAMCertificateId":{ "shape":"string", "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate." }, "CloudFrontDefaultCertificate":{ "shape":"boolean", "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId." }, "SSLSupportMethod":{ "shape":"SSLSupportMethod", "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." }, "MinimumProtocolVersion":{ "shape":"MinimumProtocolVersion", "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." } }, "documentation":"A complex type that contains information about viewer certificates for this distribution." }, "ViewerProtocolPolicy":{ "type":"string", "enum":[ "allow-all", "https-only", "redirect-to-https" ] }, "boolean":{"type":"boolean"}, "integer":{"type":"integer"}, "long":{"type":"long"}, "string":{"type":"string"}, "timestamp":{"type":"timestamp"} } } botocore-1.5.7/botocore/data/shield/0000777454262600001440000000000013042511307020403 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/shield/2016-06-02/0000777454262600001440000000000013042511307021435 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/shield/2016-06-02/service-2.json0000666454262600001440000005432213042511306024134 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-06-02", "endpointPrefix":"shield", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"AWS Shield", "serviceFullName":"AWS Shield", "signatureVersion":"v4", "targetPrefix":"AWSShield_20160616", "uid":"shield-2016-06-02" }, "operations":{ "CreateProtection":{ "name":"CreateProtection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateProtectionRequest"}, "output":{"shape":"CreateProtectionResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"InvalidResourceException"}, {"shape":"InvalidOperationException"}, {"shape":"LimitsExceededException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"OptimisticLockException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, or an Amazon Route 53 hosted zone.

" }, "CreateSubscription":{ "name":"CreateSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSubscriptionRequest"}, "output":{"shape":"CreateSubscriptionResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"ResourceAlreadyExistsException"} ], "documentation":"

Activates AWS Shield Advanced for an account.

" }, "DeleteProtection":{ "name":"DeleteProtection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteProtectionRequest"}, "output":{"shape":"DeleteProtectionResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OptimisticLockException"} ], "documentation":"

Deletes an AWS Shield Advanced Protection.

" }, "DeleteSubscription":{ "name":"DeleteSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSubscriptionRequest"}, "output":{"shape":"DeleteSubscriptionResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"LockedSubscriptionException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Removes AWS Shield Advanced from an account.

" }, "DescribeAttack":{ "name":"DescribeAttack", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAttackRequest"}, "output":{"shape":"DescribeAttackResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Describes the details of a DDoS attack.

" }, "DescribeProtection":{ "name":"DescribeProtection", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeProtectionRequest"}, "output":{"shape":"DescribeProtectionResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists the details of a Protection object.

" }, "DescribeSubscription":{ "name":"DescribeSubscription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSubscriptionRequest"}, "output":{"shape":"DescribeSubscriptionResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Provides details about the AWS Shield Advanced subscription for an account.

" }, "ListAttacks":{ "name":"ListAttacks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAttacksRequest"}, "output":{"shape":"ListAttacksResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidOperationException"} ], "documentation":"

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.

" }, "ListProtections":{ "name":"ListProtections", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListProtectionsRequest"}, "output":{"shape":"ListProtectionsResponse"}, "errors":[ {"shape":"InternalErrorException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists all Protection objects for the account.

" } }, "shapes":{ "AttackDetail":{ "type":"structure", "members":{ "AttackId":{ "shape":"AttackId", "documentation":"

The unique identifier (ID) of the attack.

" }, "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The ARN (Amazon Resource Name) of the resource that was attacked.

" }, "SubResources":{ "shape":"SubResourceSummaryList", "documentation":"

If applicable, additional detail about the resource being attacked, for example, IP address or URL.

" }, "StartTime":{ "shape":"AttackTimestamp", "documentation":"

The time the attack started, in the format 2016-12-16T13:50Z.

" }, "EndTime":{ "shape":"AttackTimestamp", "documentation":"

The time the attack ended, in the format 2016-12-16T13:50Z.

" }, "AttackCounters":{ "shape":"SummarizedCounterList", "documentation":"

List of counters that describe the attack for the specified time period.

" }, "Mitigations":{ "shape":"MitigationList", "documentation":"

List of mitigation actions taken for the attack.

" } }, "documentation":"

The details of a DDoS attack.

" }, "AttackId":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z0-9\\\\-]*" }, "AttackSummaries":{ "type":"list", "member":{"shape":"AttackSummary"} }, "AttackSummary":{ "type":"structure", "members":{ "AttackId":{ "shape":"String", "documentation":"

The unique identifier (ID) of the attack.

" }, "ResourceArn":{ "shape":"String", "documentation":"

The ARN (Amazon Resource Name) of the resource that was attacked.

" }, "StartTime":{ "shape":"AttackTimestamp", "documentation":"

The start time of the attack, in the format 2016-12-16T13:50Z.

" }, "EndTime":{ "shape":"AttackTimestamp", "documentation":"

The end time of the attack, in the format 2016-12-16T13:50Z.

" }, "AttackVectors":{ "shape":"AttackVectorDescriptionList", "documentation":"

The list of attacks for a specified time period.

" } }, "documentation":"

Summarizes all DDoS attacks for a specified time period.

" }, "AttackTimestamp":{"type":"timestamp"}, "AttackVectorDescription":{ "type":"structure", "required":["VectorType"], "members":{ "VectorType":{ "shape":"String", "documentation":"

The attack type, for example, SNMP reflection or SYN flood.

" } }, "documentation":"

Describes the attack.

" }, "AttackVectorDescriptionList":{ "type":"list", "member":{"shape":"AttackVectorDescription"} }, "CreateProtectionRequest":{ "type":"structure", "required":[ "Name", "ResourceArn" ], "members":{ "Name":{ "shape":"ProtectionName", "documentation":"

Friendly name for the Protection you are creating.

" }, "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The ARN (Amazon Resource Name) of the resource to be protected.

" } } }, "CreateProtectionResponse":{ "type":"structure", "members":{ "ProtectionId":{ "shape":"ProtectionId", "documentation":"

The unique identifier (ID) for the Protection object that is created.

" } } }, "CreateSubscriptionRequest":{ "type":"structure", "members":{ } }, "CreateSubscriptionResponse":{ "type":"structure", "members":{ } }, "DeleteProtectionRequest":{ "type":"structure", "required":["ProtectionId"], "members":{ "ProtectionId":{ "shape":"ProtectionId", "documentation":"

The unique identifier (ID) for the Protection object to be deleted.

" } } }, "DeleteProtectionResponse":{ "type":"structure", "members":{ } }, "DeleteSubscriptionRequest":{ "type":"structure", "members":{ } }, "DeleteSubscriptionResponse":{ "type":"structure", "members":{ } }, "DescribeAttackRequest":{ "type":"structure", "required":["AttackId"], "members":{ "AttackId":{ "shape":"AttackId", "documentation":"

The unique identifier (ID) for the attack that to be described.

" } } }, "DescribeAttackResponse":{ "type":"structure", "members":{ "Attack":{ "shape":"AttackDetail", "documentation":"

The attack that is described.

" } } }, "DescribeProtectionRequest":{ "type":"structure", "required":["ProtectionId"], "members":{ "ProtectionId":{ "shape":"ProtectionId", "documentation":"

The unique identifier (ID) for the Protection object that is described.

" } } }, "DescribeProtectionResponse":{ "type":"structure", "members":{ "Protection":{ "shape":"Protection", "documentation":"

The Protection object that is described.

" } } }, "DescribeSubscriptionRequest":{ "type":"structure", "members":{ } }, "DescribeSubscriptionResponse":{ "type":"structure", "members":{ "Subscription":{ "shape":"Subscription", "documentation":"

The AWS Shield Advanced subscription details for an account.

" } } }, "Double":{"type":"double"}, "DurationInSeconds":{ "type":"long", "min":0 }, "Integer":{"type":"integer"}, "InternalErrorException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

", "exception":true, "fault":true }, "InvalidOperationException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

Exception that indicates that the operation would not cause any change to occur.

", "exception":true }, "InvalidParameterException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

Exception that indicates that the parameters passed to the API are invalid.

", "exception":true }, "InvalidResourceException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.

", "exception":true }, "LimitNumber":{"type":"long"}, "LimitType":{"type":"string"}, "LimitsExceededException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"}, "Type":{"shape":"LimitType"}, "Limit":{"shape":"LimitNumber"} }, "documentation":"

Exception that indicates that the operation would exceed a limit.

", "exception":true }, "ListAttacksRequest":{ "type":"structure", "members":{ "ResourceArns":{ "shape":"ResourceArnFilterList", "documentation":"

The ARN (Amazon Resource Name) of the resource that was attacked. If this is left blank, all applicable resources for this account will be included.

" }, "StartTime":{ "shape":"TimeRange", "documentation":"

The time period for the attacks.

" }, "EndTime":{ "shape":"TimeRange", "documentation":"

The end of the time period for the attacks.

" }, "NextToken":{ "shape":"Token", "documentation":"

The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. Pass null if this is the first call.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of AttackSummary objects to be returned. If this is left blank, the first 20 results will be returned.

" } } }, "ListAttacksResponse":{ "type":"structure", "members":{ "AttackSummaries":{ "shape":"AttackSummaries", "documentation":"

The attack information for the specified time range.

" }, "NextToken":{ "shape":"Token", "documentation":"

The token returned by a previous call to indicate that there is more data available. If not null, more results are available. Pass this value for the NextMarker parameter in a subsequent call to ListAttacks to retrieve the next set of items.

" } } }, "ListProtectionsRequest":{ "type":"structure", "members":{ "NextToken":{ "shape":"Token", "documentation":"

The ListProtectionsRequest.NextToken value from a previous call to ListProtections. Pass null if this is the first call.

" }, "MaxResults":{ "shape":"MaxResults", "documentation":"

The maximum number of Protection objects to be returned. If this is left blank the first 20 results will be returned.

" } } }, "ListProtectionsResponse":{ "type":"structure", "members":{ "Protections":{ "shape":"Protections", "documentation":"

The array of enabled Protection objects.

" }, "NextToken":{ "shape":"Token", "documentation":"

If you specify a value for MaxResults and you have more Protections than the value of MaxResults, AWS Shield Advanced returns a NextToken value in the response that allows you to list another group of Protections. For the second and subsequent ListProtections requests, specify the value of NextToken from the previous response to get information about another batch of Protections.

" } } }, "LockedSubscriptionException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

Exception that indicates that the subscription has been modified by another client. You can retry the request.

", "exception":true }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":0 }, "Mitigation":{ "type":"structure", "members":{ "MitigationName":{ "shape":"String", "documentation":"

The name of the mitigation taken for this attack.

" } }, "documentation":"

The mitigation applied to a DDoS attack.

" }, "MitigationList":{ "type":"list", "member":{"shape":"Mitigation"} }, "OptimisticLockException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

Exception that indicates that the protection state has been modified by another client. You can retry the request.

", "exception":true }, "Protection":{ "type":"structure", "members":{ "Id":{ "shape":"ProtectionId", "documentation":"

The unique identifier (ID) of the protection.

" }, "Name":{ "shape":"ProtectionName", "documentation":"

The friendly name of the protection. For example, My CloudFront distributions.

" }, "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The ARN (Amazon Resource Name) of the AWS resource that is protected.

" } }, "documentation":"

An object that represents a resource that is under DDoS protection.

" }, "ProtectionId":{ "type":"string", "max":36, "min":1, "pattern":"[a-zA-Z0-9\\\\-]*" }, "ProtectionName":{ "type":"string", "max":128, "min":1, "pattern":"[ a-zA-Z0-9_\\\\.\\\\-]*" }, "Protections":{ "type":"list", "member":{"shape":"Protection"} }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

Exception indicating the specified resource already exists.

", "exception":true }, "ResourceArn":{ "type":"string", "min":1 }, "ResourceArnFilterList":{ "type":"list", "member":{"shape":"ResourceArn"} }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

Exception indicating the specified resource does not exist.

", "exception":true }, "String":{"type":"string"}, "SubResourceSummary":{ "type":"structure", "members":{ "Type":{ "shape":"SubResourceType", "documentation":"

The SubResource type.

" }, "Id":{ "shape":"String", "documentation":"

The unique identifier (ID) of the SubResource.

" }, "AttackVectors":{ "shape":"SummarizedAttackVectorList", "documentation":"

The list of attack types and associated counters.

" }, "Counters":{ "shape":"SummarizedCounterList", "documentation":"

The counters that describe the details of the attack.

" } }, "documentation":"

The attack information for the specified SubResource.

" }, "SubResourceSummaryList":{ "type":"list", "member":{"shape":"SubResourceSummary"} }, "SubResourceType":{ "type":"string", "enum":[ "IP", "URL" ] }, "Subscription":{ "type":"structure", "members":{ "StartTime":{ "shape":"Timestamp", "documentation":"

The start time of the subscription, in the format \"2016-12-16T13:50Z\".

" }, "TimeCommitmentInSeconds":{ "shape":"DurationInSeconds", "documentation":"

The length, in seconds, of the AWS Shield Advanced subscription for the account.

" } }, "documentation":"

Information about the AWS Shield Advanced subscription for an account.

" }, "SummarizedAttackVector":{ "type":"structure", "required":["VectorType"], "members":{ "VectorType":{ "shape":"String", "documentation":"

The attack type, for example, SNMP reflection or SYN flood.

" }, "VectorCounters":{ "shape":"SummarizedCounterList", "documentation":"

The list of counters that describe the details of the attack.

" } }, "documentation":"

A summary of information about the attack.

" }, "SummarizedAttackVectorList":{ "type":"list", "member":{"shape":"SummarizedAttackVector"} }, "SummarizedCounter":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The counter name.

" }, "Max":{ "shape":"Double", "documentation":"

The maximum value of the counter for a specified time period.

" }, "Average":{ "shape":"Double", "documentation":"

The average value of the counter for a specified time period.

" }, "Sum":{ "shape":"Double", "documentation":"

The total of counter values for a specified time period.

" }, "N":{ "shape":"Integer", "documentation":"

The number of counters for a specified time period.

" }, "Unit":{ "shape":"String", "documentation":"

The unit of the counters.

" } }, "documentation":"

The counter that describes a DDoS attack.

" }, "SummarizedCounterList":{ "type":"list", "member":{"shape":"SummarizedCounter"} }, "TimeRange":{ "type":"structure", "members":{ "FromInclusive":{ "shape":"AttackTimestamp", "documentation":"

The start time, in the format 2016-12-16T13:50Z.

" }, "ToExclusive":{ "shape":"AttackTimestamp", "documentation":"

The end time, in the format 2016-12-16T15:50Z.

" } }, "documentation":"

The time range.

" }, "Timestamp":{"type":"timestamp"}, "Token":{ "type":"string", "min":1 }, "errorMessage":{"type":"string"} }, "documentation":"AWS Shield Advanced

This is the AWS Shield Advanced API Reference. This guide is for developers who need detailed information about the AWS Shield Advanced API actions, data types, and errors. For detailed information about AWS WAF and AWS Shield Advanced features and an overview of how to use the AWS WAF and AWS Shield Advanced APIs, see the AWS WAF and AWS Shield Developer Guide.

" } botocore-1.5.7/botocore/data/iam/0000777454262600001440000000000013042511307017701 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/iam/2010-05-08/0000777454262600001440000000000013042511307020732 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/iam/2010-05-08/waiters-2.json0000666454262600001440000000136213042511306023443 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "InstanceProfileExists": { "delay": 1, "operation": "GetInstanceProfile", "maxAttempts": 40, "acceptors": [ { "expected": 200, "matcher": "status", "state": "success" }, { "state": "retry", "matcher": "status", "expected": 404 } ] }, "UserExists": { "delay": 1, "operation": "GetUser", "maxAttempts": 20, "acceptors": [ { "state": "success", "matcher": "status", "expected": 200 }, { "state": "retry", "matcher": "error", "expected": "NoSuchEntity" } ] } } } botocore-1.5.7/botocore/data/iam/2010-05-08/paginators-1.json0000666454262600001440000001255313042511306024137 0ustar pysdk-ciamazon00000000000000{ "pagination": { "GetAccountAuthorizationDetails": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": [ "UserDetailList", "GroupDetailList", "RoleDetailList", "Policies" ] }, "GetGroup": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "Users", "non_aggregate_keys": [ "Group" ] }, "ListAccessKeys": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "AccessKeyMetadata" }, "ListAccountAliases": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "AccountAliases" }, "ListAttachedGroupPolicies": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "AttachedPolicies" }, "ListAttachedRolePolicies": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "AttachedPolicies" }, "ListAttachedUserPolicies": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "AttachedPolicies" }, "ListEntitiesForPolicy": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": [ "PolicyGroups", "PolicyUsers", "PolicyRoles" ] }, "ListGroupPolicies": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "PolicyNames" }, "ListGroups": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "Groups" }, "ListGroupsForUser": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "Groups" }, "ListInstanceProfiles": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "InstanceProfiles" }, "ListInstanceProfilesForRole": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "InstanceProfiles" }, "ListMFADevices": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "MFADevices" }, "ListPolicies": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "Policies" }, "ListPolicyVersions": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "Versions" }, "ListRolePolicies": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "PolicyNames" }, "ListRoles": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "Roles" }, "ListServerCertificates": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "ServerCertificateMetadataList" }, "ListSigningCertificates": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "Certificates" }, "ListSSHPublicKeys": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "SSHPublicKeys" }, "ListUserPolicies": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "PolicyNames" }, "ListUsers": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "Users" }, "ListVirtualMFADevices": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "VirtualMFADevices" }, "SimulateCustomPolicy": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "EvaluationResults" }, "SimulatePrincipalPolicy": { "input_token": "Marker", "limit_key": "MaxItems", "more_results": "IsTruncated", "output_token": "Marker", "result_key": "EvaluationResults" } } }botocore-1.5.7/botocore/data/iam/2010-05-08/service-2.json0000666454262600001440000144227113042511306023436 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2010-05-08", "endpointPrefix":"iam", "globalEndpoint":"iam.amazonaws.com", "protocol":"query", "serviceAbbreviation":"IAM", "serviceFullName":"AWS Identity and Access Management", "signatureVersion":"v4", "uid":"iam-2010-05-08", "xmlNamespace":"https://iam.amazonaws.com/doc/2010-05-08/" }, "operations":{ "AddClientIDToOpenIDConnectProvider":{ "name":"AddClientIDToOpenIDConnectProvider", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddClientIDToOpenIDConnectProviderRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.

This action is idempotent; it does not fail or return an error if you add an existing client ID to the provider.

" }, "AddRoleToInstanceProfile":{ "name":"AddRoleToInstanceProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddRoleToInstanceProfileRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"EntityAlreadyExistsException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Adds the specified IAM role to the specified instance profile.

The caller of this API must be granted the PassRole permission on the IAM role by a permission policy.

For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.

" }, "AddUserToGroup":{ "name":"AddUserToGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddUserToGroupRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Adds the specified user to the specified group.

" }, "AttachGroupPolicy":{ "name":"AttachGroupPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachGroupPolicyRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Attaches the specified managed policy to the specified IAM group.

You use this API to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy.

For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" }, "AttachRolePolicy":{ "name":"AttachRolePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachRolePolicyRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Attaches the specified managed policy to the specified IAM role.

When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy. You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy.

Use this API to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" }, "AttachUserPolicy":{ "name":"AttachUserPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AttachUserPolicyRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Attaches the specified managed policy to the specified user.

You use this API to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy.

For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" }, "ChangePassword":{ "name":"ChangePassword", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ChangePasswordRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"InvalidUserTypeException"}, {"shape":"LimitExceededException"}, {"shape":"EntityTemporarilyUnmodifiableException"}, {"shape":"PasswordPolicyViolationException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Changes the password of the IAM user who is calling this action. The root account password is not affected by this action.

To change the password for a different user, see UpdateLoginProfile. For more information about modifying passwords, see Managing Passwords in the IAM User Guide.

" }, "CreateAccessKey":{ "name":"CreateAccessKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAccessKeyRequest"}, "output":{ "shape":"CreateAccessKeyResponse", "resultWrapper":"CreateAccessKeyResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is Active.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

For information about limits on the number of keys you can create, see Limitations on IAM Entities in the IAM User Guide.

To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.

" }, "CreateAccountAlias":{ "name":"CreateAccountAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAccountAliasRequest"}, "errors":[ {"shape":"EntityAlreadyExistsException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates an alias for your AWS account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.

" }, "CreateGroup":{ "name":"CreateGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateGroupRequest"}, "output":{ "shape":"CreateGroupResponse", "resultWrapper":"CreateGroupResult" }, "errors":[ {"shape":"LimitExceededException"}, {"shape":"EntityAlreadyExistsException"}, {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates a new group.

For information about the number of groups you can create, see Limitations on IAM Entities in the IAM User Guide.

" }, "CreateInstanceProfile":{ "name":"CreateInstanceProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInstanceProfileRequest"}, "output":{ "shape":"CreateInstanceProfileResponse", "resultWrapper":"CreateInstanceProfileResult" }, "errors":[ {"shape":"EntityAlreadyExistsException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates a new instance profile. For information about instance profiles, go to About Instance Profiles.

For information about the number of instance profiles you can create, see Limitations on IAM Entities in the IAM User Guide.

" }, "CreateLoginProfile":{ "name":"CreateLoginProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateLoginProfileRequest"}, "output":{ "shape":"CreateLoginProfileResponse", "resultWrapper":"CreateLoginProfileResult" }, "errors":[ {"shape":"EntityAlreadyExistsException"}, {"shape":"NoSuchEntityException"}, {"shape":"PasswordPolicyViolationException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see Managing Passwords in the IAM User Guide.

" }, "CreateOpenIDConnectProvider":{ "name":"CreateOpenIDConnectProvider", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateOpenIDConnectProviderRequest"}, "output":{ "shape":"CreateOpenIDConnectProviderResponse", "resultWrapper":"CreateOpenIDConnectProviderResult" }, "errors":[ {"shape":"InvalidInputException"}, {"shape":"EntityAlreadyExistsException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).

The OIDC provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and the OIDC provider.

When you create the IAM OIDC provider, you specify the URL of the OIDC identity provider (IdP) to trust, a list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider, and a list of thumbprints of the server certificate(s) that the IdP uses. You get all of this information from the OIDC IdP that you want to use for access to AWS.

Because trust for the OIDC provider is ultimately derived from the IAM provider that this action creates, it is a best practice to limit access to the CreateOpenIDConnectProvider action to highly-privileged users.

" }, "CreatePolicy":{ "name":"CreatePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePolicyRequest"}, "output":{ "shape":"CreatePolicyResponse", "resultWrapper":"CreatePolicyResult" }, "errors":[ {"shape":"InvalidInputException"}, {"shape":"LimitExceededException"}, {"shape":"EntityAlreadyExistsException"}, {"shape":"MalformedPolicyDocumentException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates a new managed policy for your AWS account.

This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for Managed Policies in the IAM User Guide.

For more information about managed policies in general, see Managed Policies and Inline Policies in the IAM User Guide.

" }, "CreatePolicyVersion":{ "name":"CreatePolicyVersion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreatePolicyVersionRequest"}, "output":{ "shape":"CreatePolicyVersionResponse", "resultWrapper":"CreatePolicyVersionResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"MalformedPolicyDocumentException"}, {"shape":"InvalidInputException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.

Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

" }, "CreateRole":{ "name":"CreateRole", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRoleRequest"}, "output":{ "shape":"CreateRoleResponse", "resultWrapper":"CreateRoleResult" }, "errors":[ {"shape":"LimitExceededException"}, {"shape":"EntityAlreadyExistsException"}, {"shape":"MalformedPolicyDocumentException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates a new role for your AWS account. For more information about roles, go to Working with Roles. For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities in the IAM User Guide.

" }, "CreateSAMLProvider":{ "name":"CreateSAMLProvider", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSAMLProviderRequest"}, "output":{ "shape":"CreateSAMLProviderResponse", "resultWrapper":"CreateSAMLProviderResult" }, "errors":[ {"shape":"InvalidInputException"}, {"shape":"EntityAlreadyExistsException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.

The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy to enable federated users who sign-in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS.

When you create the SAML provider resource, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.

This operation requires Signature Version 4.

For more information, see Enabling SAML 2.0 Federated Users to Access the AWS Management Console and About SAML 2.0-based Federation in the IAM User Guide.

" }, "CreateServiceSpecificCredential":{ "name":"CreateServiceSpecificCredential", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateServiceSpecificCredentialRequest"}, "output":{ "shape":"CreateServiceSpecificCredentialResponse", "resultWrapper":"CreateServiceSpecificCredentialResult" }, "errors":[ {"shape":"LimitExceededException"}, {"shape":"NoSuchEntityException"}, {"shape":"ServiceNotSupportedException"} ], "documentation":"

Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service.

You can have a maximum of two sets of service-specific credentials for each supported service per user.

The only supported service at this time is AWS CodeCommit.

You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential.

For more information about service-specific credentials, see Using IAM with AWS CodeCommit: Git Credentials, SSH Keys, and AWS Access Keys in the IAM User Guide.

" }, "CreateUser":{ "name":"CreateUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateUserRequest"}, "output":{ "shape":"CreateUserResponse", "resultWrapper":"CreateUserResult" }, "errors":[ {"shape":"LimitExceededException"}, {"shape":"EntityAlreadyExistsException"}, {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Creates a new IAM user for your AWS account.

For information about limitations on the number of IAM users you can create, see Limitations on IAM Entities in the IAM User Guide.

" }, "CreateVirtualMFADevice":{ "name":"CreateVirtualMFADevice", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateVirtualMFADeviceRequest"}, "output":{ "shape":"CreateVirtualMFADeviceResponse", "resultWrapper":"CreateVirtualMFADeviceResult" }, "errors":[ {"shape":"LimitExceededException"}, {"shape":"EntityAlreadyExistsException"}, {"shape":"ServiceFailureException"} ], "documentation":"

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 creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.

For information about limits on the number of MFA devices you can create, see Limitations on Entities in the IAM User Guide.

The seed information contained in the QR code and the Base32 string should be treated like any other secret access information, such as your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.

" }, "DeactivateMFADevice":{ "name":"DeactivateMFADevice", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeactivateMFADeviceRequest"}, "errors":[ {"shape":"EntityTemporarilyUnmodifiableException"}, {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.

For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.

" }, "DeleteAccessKey":{ "name":"DeleteAccessKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAccessKeyRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the access key pair associated with the specified IAM user.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

" }, "DeleteAccountAlias":{ "name":"DeleteAccountAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAccountAliasRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the specified AWS account alias. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.

" }, "DeleteAccountPasswordPolicy":{ "name":"DeleteAccountPasswordPolicy", "http":{ "method":"POST", "requestUri":"/" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the password policy for the AWS account. There are no parameters.

" }, "DeleteGroup":{ "name":"DeleteGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteGroupRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"DeleteConflictException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the specified IAM group. The group must not contain any users or have any attached policies.

" }, "DeleteGroupPolicy":{ "name":"DeleteGroupPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteGroupPolicyRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the specified inline policy that is embedded in the specified IAM group.

A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

" }, "DeleteInstanceProfile":{ "name":"DeleteInstanceProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteInstanceProfileRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"DeleteConflictException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the specified instance profile. The instance profile must not have an associated role.

Make sure you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

For more information about instance profiles, go to About Instance Profiles.

" }, "DeleteLoginProfile":{ "name":"DeleteLoginProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteLoginProfileRequest"}, "errors":[ {"shape":"EntityTemporarilyUnmodifiableException"}, {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the password for the specified IAM user, which terminates the user's ability to access AWS services through the AWS Management Console.

Deleting a user's password does not prevent a user from accessing AWS through the command line interface or the API. To prevent all user access you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey.

" }, "DeleteOpenIDConnectProvider":{ "name":"DeleteOpenIDConnectProvider", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteOpenIDConnectProviderRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes an OpenID Connect identity provider (IdP) resource object in IAM.

Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.

This action is idempotent; it does not fail or return an error if you call the action for a provider that does not exist.

" }, "DeletePolicy":{ "name":"DeletePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePolicyRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidInputException"}, {"shape":"DeleteConflictException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the specified managed policy.

Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to, and you must delete all of the policy's versions. The following steps describe the process for deleting a managed policy:

  • Detach the policy from all users, groups, and roles that the policy is attached to, using the DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy APIs. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.

  • Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.

  • Delete the policy (this automatically deletes the policy's default version) using this API.

For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.

" }, "DeletePolicyVersion":{ "name":"DeletePolicyVersion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeletePolicyVersionRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidInputException"}, {"shape":"DeleteConflictException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the specified version from the specified managed policy.

You cannot delete the default version from a policy using this API. To delete the default version from a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

For information about versions for managed policies, see Versioning for Managed Policies in the IAM User Guide.

" }, "DeleteRole":{ "name":"DeleteRole", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRoleRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"DeleteConflictException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the specified role. The role must not have any policies attached. For more information about roles, go to Working with Roles.

Make sure you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

" }, "DeleteRolePolicy":{ "name":"DeleteRolePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRolePolicyRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the specified inline policy that is embedded in the specified IAM role.

A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

" }, "DeleteSAMLProvider":{ "name":"DeleteSAMLProvider", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSAMLProviderRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"LimitExceededException"}, {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes a SAML provider resource in IAM.

Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.

This operation requires Signature Version 4.

" }, "DeleteSSHPublicKey":{ "name":"DeleteSSHPublicKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSSHPublicKeyRequest"}, "errors":[ {"shape":"NoSuchEntityException"} ], "documentation":"

Deletes the specified SSH public key.

The SSH public key deleted by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

" }, "DeleteServerCertificate":{ "name":"DeleteServerCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteServerCertificateRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"DeleteConflictException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the specified server certificate.

For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.

If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, go to DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference.

" }, "DeleteServiceSpecificCredential":{ "name":"DeleteServiceSpecificCredential", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteServiceSpecificCredentialRequest"}, "errors":[ {"shape":"NoSuchEntityException"} ], "documentation":"

Deletes the specified service-specific credential.

" }, "DeleteSigningCertificate":{ "name":"DeleteSigningCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSigningCertificateRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes a signing certificate associated with the specified IAM user.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated IAM users.

" }, "DeleteUser":{ "name":"DeleteUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteUserRequest"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"NoSuchEntityException"}, {"shape":"DeleteConflictException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the specified IAM user. The user must not belong to any groups or have any access keys, signing certificates, or attached policies.

" }, "DeleteUserPolicy":{ "name":"DeleteUserPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteUserPolicyRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes the specified inline policy that is embedded in the specified IAM user.

A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

" }, "DeleteVirtualMFADevice":{ "name":"DeleteVirtualMFADevice", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteVirtualMFADeviceRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"DeleteConflictException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Deletes a virtual MFA device.

You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.

" }, "DetachGroupPolicy":{ "name":"DetachGroupPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachGroupPolicyRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Removes the specified managed policy from the specified IAM group.

A group can also have inline policies embedded with it. To delete an inline policy, use the DeleteGroupPolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" }, "DetachRolePolicy":{ "name":"DetachRolePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachRolePolicyRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Removes the specified managed policy from the specified role.

A role can also have inline policies embedded with it. To delete an inline policy, use the DeleteRolePolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" }, "DetachUserPolicy":{ "name":"DetachUserPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DetachUserPolicyRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Removes the specified managed policy from the specified user.

A user can also have inline policies embedded with it. To delete an inline policy, use the DeleteUserPolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" }, "EnableMFADevice":{ "name":"EnableMFADevice", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableMFADeviceRequest"}, "errors":[ {"shape":"EntityAlreadyExistsException"}, {"shape":"EntityTemporarilyUnmodifiableException"}, {"shape":"InvalidAuthenticationCodeException"}, {"shape":"LimitExceededException"}, {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device.

" }, "GenerateCredentialReport":{ "name":"GenerateCredentialReport", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"GenerateCredentialReportResponse", "resultWrapper":"GenerateCredentialReportResult" }, "errors":[ {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.

" }, "GetAccessKeyLastUsed":{ "name":"GetAccessKeyLastUsed", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAccessKeyLastUsedRequest"}, "output":{ "shape":"GetAccessKeyLastUsedResponse", "resultWrapper":"GetAccessKeyLastUsedResult" }, "errors":[ {"shape":"NoSuchEntityException"} ], "documentation":"

Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the AWS service and region that were specified in the last request made with that key.

" }, "GetAccountAuthorizationDetails":{ "name":"GetAccountAuthorizationDetails", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAccountAuthorizationDetailsRequest"}, "output":{ "shape":"GetAccountAuthorizationDetailsResponse", "resultWrapper":"GetAccountAuthorizationDetailsResult" }, "errors":[ {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.

You can optionally filter the results using the Filter parameter. You can paginate the results using the MaxItems and Marker parameters.

" }, "GetAccountPasswordPolicy":{ "name":"GetAccountPasswordPolicy", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"GetAccountPasswordPolicyResponse", "resultWrapper":"GetAccountPasswordPolicyResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.

" }, "GetAccountSummary":{ "name":"GetAccountSummary", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"GetAccountSummaryResponse", "resultWrapper":"GetAccountSummaryResult" }, "errors":[ {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves information about IAM entity usage and IAM quotas in the AWS account.

For information about limitations on IAM entities, see Limitations on IAM Entities in the IAM User Guide.

" }, "GetContextKeysForCustomPolicy":{ "name":"GetContextKeysForCustomPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetContextKeysForCustomPolicyRequest"}, "output":{ "shape":"GetContextKeysForPolicyResponse", "resultWrapper":"GetContextKeysForCustomPolicyResult" }, "errors":[ {"shape":"InvalidInputException"} ], "documentation":"

Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.

" }, "GetContextKeysForPrincipalPolicy":{ "name":"GetContextKeysForPrincipalPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetContextKeysForPrincipalPolicyRequest"}, "output":{ "shape":"GetContextKeysForPolicyResponse", "resultWrapper":"GetContextKeysForPrincipalPolicyResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"InvalidInputException"} ], "documentation":"

Gets a list of all of the context keys referenced in all of the IAM policies attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.

You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.

Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.

" }, "GetCredentialReport":{ "name":"GetCredentialReport", "http":{ "method":"POST", "requestUri":"/" }, "output":{ "shape":"GetCredentialReportResponse", "resultWrapper":"GetCredentialReportResult" }, "errors":[ {"shape":"CredentialReportNotPresentException"}, {"shape":"CredentialReportExpiredException"}, {"shape":"CredentialReportNotReadyException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.

" }, "GetGroup":{ "name":"GetGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetGroupRequest"}, "output":{ "shape":"GetGroupResponse", "resultWrapper":"GetGroupResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters.

" }, "GetGroupPolicy":{ "name":"GetGroupPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetGroupPolicyRequest"}, "output":{ "shape":"GetGroupPolicyResponse", "resultWrapper":"GetGroupPolicyResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the specified inline policy document that is embedded in the specified IAM group.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" }, "GetInstanceProfile":{ "name":"GetInstanceProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInstanceProfileRequest"}, "output":{ "shape":"GetInstanceProfileResponse", "resultWrapper":"GetInstanceProfileResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see About Instance Profiles in the IAM User Guide.

" }, "GetLoginProfile":{ "name":"GetLoginProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetLoginProfileRequest"}, "output":{ "shape":"GetLoginProfileResponse", "resultWrapper":"GetLoginProfileResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the user name and password-creation date for the specified IAM user. If the user has not been assigned a password, the action returns a 404 (NoSuchEntity) error.

" }, "GetOpenIDConnectProvider":{ "name":"GetOpenIDConnectProvider", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetOpenIDConnectProviderRequest"}, "output":{ "shape":"GetOpenIDConnectProviderResponse", "resultWrapper":"GetOpenIDConnectProviderResult" }, "errors":[ {"shape":"InvalidInputException"}, {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.

" }, "GetPolicy":{ "name":"GetPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPolicyRequest"}, "output":{ "shape":"GetPolicyResponse", "resultWrapper":"GetPolicyResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API. This API returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.

This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.

For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" }, "GetPolicyVersion":{ "name":"GetPolicyVersion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPolicyVersionRequest"}, "output":{ "shape":"GetPolicyVersionResponse", "resultWrapper":"GetPolicyVersionResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves information about the specified version of the specified managed policy, including the policy document.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

To list the available versions for a policy, use ListPolicyVersions.

This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.

For more information about the types of policies, see Managed Policies and Inline Policies in the IAM User Guide.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

" }, "GetRole":{ "name":"GetRole", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRoleRequest"}, "output":{ "shape":"GetRoleResponse", "resultWrapper":"GetRoleResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see Working with Roles.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

" }, "GetRolePolicy":{ "name":"GetRolePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRolePolicyRequest"}, "output":{ "shape":"GetRolePolicyResponse", "resultWrapper":"GetRolePolicyResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the specified inline policy document that is embedded with the specified IAM role.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

For more information about roles, see Using Roles to Delegate Permissions and Federate Identities.

" }, "GetSAMLProvider":{ "name":"GetSAMLProvider", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSAMLProviderRequest"}, "output":{ "shape":"GetSAMLProviderResponse", "resultWrapper":"GetSAMLProviderResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.

This operation requires Signature Version 4.

" }, "GetSSHPublicKey":{ "name":"GetSSHPublicKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSSHPublicKeyRequest"}, "output":{ "shape":"GetSSHPublicKeyResponse", "resultWrapper":"GetSSHPublicKeyResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"UnrecognizedPublicKeyEncodingException"} ], "documentation":"

Retrieves the specified SSH public key, including metadata about the key.

The SSH public key retrieved by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

" }, "GetServerCertificate":{ "name":"GetServerCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetServerCertificateRequest"}, "output":{ "shape":"GetServerCertificateResponse", "resultWrapper":"GetServerCertificateResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves information about the specified server certificate stored in IAM.

For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.

" }, "GetUser":{ "name":"GetUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetUserRequest"}, "output":{ "shape":"GetUserResponse", "resultWrapper":"GetUserResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request to this API.

" }, "GetUserPolicy":{ "name":"GetUserPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetUserPolicyRequest"}, "output":{ "shape":"GetUserPolicyResponse", "resultWrapper":"GetUserPolicyResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Retrieves the specified inline policy document that is embedded in the specified IAM user.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" }, "ListAccessKeys":{ "name":"ListAccessKeys", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAccessKeysRequest"}, "output":{ "shape":"ListAccessKeysResponse", "resultWrapper":"ListAccessKeysResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Returns information about the access key IDs associated with the specified IAM user. If there are none, the action returns an empty list.

Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.

If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

To ensure the security of your AWS account, the secret access key is accessible only during key and user creation.

" }, "ListAccountAliases":{ "name":"ListAccountAliases", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAccountAliasesRequest"}, "output":{ "shape":"ListAccountAliasesResponse", "resultWrapper":"ListAccountAliasesResult" }, "errors":[ {"shape":"ServiceFailureException"} ], "documentation":"

Lists the account alias associated with the AWS account (Note: you can have only one). For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.

" }, "ListAttachedGroupPolicies":{ "name":"ListAttachedGroupPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAttachedGroupPoliciesRequest"}, "output":{ "shape":"ListAttachedGroupPoliciesResponse", "resultWrapper":"ListAttachedGroupPoliciesResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists all managed policies that are attached to the specified IAM group.

An IAM group can also have inline policies embedded with it. To list the inline policies for a group, use the ListGroupPolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list.

" }, "ListAttachedRolePolicies":{ "name":"ListAttachedRolePolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAttachedRolePoliciesRequest"}, "output":{ "shape":"ListAttachedRolePoliciesResponse", "resultWrapper":"ListAttachedRolePoliciesResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists all managed policies that are attached to the specified IAM role.

An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use the ListRolePolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the action returns an empty list.

" }, "ListAttachedUserPolicies":{ "name":"ListAttachedUserPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAttachedUserPoliciesRequest"}, "output":{ "shape":"ListAttachedUserPoliciesResponse", "resultWrapper":"ListAttachedUserPoliciesResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists all managed policies that are attached to the specified IAM user.

An IAM user can also have inline policies embedded with it. To list the inline policies for a user, use the ListUserPolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list.

" }, "ListEntitiesForPolicy":{ "name":"ListEntitiesForPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListEntitiesForPolicyRequest"}, "output":{ "shape":"ListEntitiesForPolicyResponse", "resultWrapper":"ListEntitiesForPolicyResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists all IAM users, groups, and roles that the specified managed policy is attached to.

You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role.

You can paginate the results using the MaxItems and Marker parameters.

" }, "ListGroupPolicies":{ "name":"ListGroupPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListGroupPoliciesRequest"}, "output":{ "shape":"ListGroupPoliciesResponse", "resultWrapper":"ListGroupPoliciesResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the names of the inline policies that are embedded in the specified IAM group.

An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the action returns an empty list.

" }, "ListGroups":{ "name":"ListGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListGroupsRequest"}, "output":{ "shape":"ListGroupsResponse", "resultWrapper":"ListGroupsResult" }, "errors":[ {"shape":"ServiceFailureException"} ], "documentation":"

Lists the IAM groups that have the specified path prefix.

You can paginate the results using the MaxItems and Marker parameters.

" }, "ListGroupsForUser":{ "name":"ListGroupsForUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListGroupsForUserRequest"}, "output":{ "shape":"ListGroupsForUserResponse", "resultWrapper":"ListGroupsForUserResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the IAM groups that the specified IAM user belongs to.

You can paginate the results using the MaxItems and Marker parameters.

" }, "ListInstanceProfiles":{ "name":"ListInstanceProfiles", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListInstanceProfilesRequest"}, "output":{ "shape":"ListInstanceProfilesResponse", "resultWrapper":"ListInstanceProfilesResult" }, "errors":[ {"shape":"ServiceFailureException"} ], "documentation":"

Lists the instance profiles that have the specified path prefix. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.

You can paginate the results using the MaxItems and Marker parameters.

" }, "ListInstanceProfilesForRole":{ "name":"ListInstanceProfilesForRole", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListInstanceProfilesForRoleRequest"}, "output":{ "shape":"ListInstanceProfilesForRoleResponse", "resultWrapper":"ListInstanceProfilesForRoleResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the instance profiles that have the specified associated IAM role. If there are none, the action returns an empty list. For more information about instance profiles, go to About Instance Profiles.

You can paginate the results using the MaxItems and Marker parameters.

" }, "ListMFADevices":{ "name":"ListMFADevices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListMFADevicesRequest"}, "output":{ "shape":"ListMFADevicesResponse", "resultWrapper":"ListMFADevicesResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this action lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request for this API.

You can paginate the results using the MaxItems and Marker parameters.

" }, "ListOpenIDConnectProviders":{ "name":"ListOpenIDConnectProviders", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListOpenIDConnectProvidersRequest"}, "output":{ "shape":"ListOpenIDConnectProvidersResponse", "resultWrapper":"ListOpenIDConnectProvidersResult" }, "errors":[ {"shape":"ServiceFailureException"} ], "documentation":"

Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.

" }, "ListPolicies":{ "name":"ListPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPoliciesRequest"}, "output":{ "shape":"ListPoliciesResponse", "resultWrapper":"ListPoliciesResult" }, "errors":[ {"shape":"ServiceFailureException"} ], "documentation":"

Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies.

You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your AWS account, set Scope to Local. To list only AWS managed policies, set Scope to AWS.

You can paginate the results using the MaxItems and Marker parameters.

For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.

" }, "ListPolicyVersions":{ "name":"ListPolicyVersions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListPolicyVersionsRequest"}, "output":{ "shape":"ListPolicyVersionsResponse", "resultWrapper":"ListPolicyVersionsResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"InvalidInputException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.

For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.

" }, "ListRolePolicies":{ "name":"ListRolePolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRolePoliciesRequest"}, "output":{ "shape":"ListRolePoliciesResponse", "resultWrapper":"ListRolePoliciesResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the names of the inline policies that are embedded in the specified IAM role.

An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the action returns an empty list.

" }, "ListRoles":{ "name":"ListRoles", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRolesRequest"}, "output":{ "shape":"ListRolesResponse", "resultWrapper":"ListRolesResult" }, "errors":[ {"shape":"ServiceFailureException"} ], "documentation":"

Lists the IAM roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to Working with Roles.

You can paginate the results using the MaxItems and Marker parameters.

" }, "ListSAMLProviders":{ "name":"ListSAMLProviders", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSAMLProvidersRequest"}, "output":{ "shape":"ListSAMLProvidersResponse", "resultWrapper":"ListSAMLProvidersResult" }, "errors":[ {"shape":"ServiceFailureException"} ], "documentation":"

Lists the SAML provider resource objects defined in IAM in the account.

This operation requires Signature Version 4.

" }, "ListSSHPublicKeys":{ "name":"ListSSHPublicKeys", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSSHPublicKeysRequest"}, "output":{ "shape":"ListSSHPublicKeysResponse", "resultWrapper":"ListSSHPublicKeysResult" }, "errors":[ {"shape":"NoSuchEntityException"} ], "documentation":"

Returns information about the SSH public keys associated with the specified IAM user. If there are none, the action returns an empty list.

The SSH public keys returned by this action are used only for authenticating the IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.

" }, "ListServerCertificates":{ "name":"ListServerCertificates", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListServerCertificatesRequest"}, "output":{ "shape":"ListServerCertificatesResponse", "resultWrapper":"ListServerCertificatesResult" }, "errors":[ {"shape":"ServiceFailureException"} ], "documentation":"

Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the action returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.

" }, "ListServiceSpecificCredentials":{ "name":"ListServiceSpecificCredentials", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListServiceSpecificCredentialsRequest"}, "output":{ "shape":"ListServiceSpecificCredentialsResponse", "resultWrapper":"ListServiceSpecificCredentialsResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceNotSupportedException"} ], "documentation":"

Returns information about the service-specific credentials associated with the specified IAM user. If there are none, the action returns an empty list. The service-specific credentials returned by this action are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an AWS service, see Set Up service-specific credentials in the AWS CodeCommit User Guide.

" }, "ListSigningCertificates":{ "name":"ListSigningCertificates", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSigningCertificatesRequest"}, "output":{ "shape":"ListSigningCertificatesResponse", "resultWrapper":"ListSigningCertificatesResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Returns information about the signing certificates associated with the specified IAM user. If there are none, the action returns an empty list.

Although each user is limited to a small number of signing certificates, you can still paginate the results using the MaxItems and Marker parameters.

If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request for this API. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

" }, "ListUserPolicies":{ "name":"ListUserPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListUserPoliciesRequest"}, "output":{ "shape":"ListUserPoliciesResponse", "resultWrapper":"ListUserPoliciesResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Lists the names of the inline policies embedded in the specified IAM user.

An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified user, the action returns an empty list.

" }, "ListUsers":{ "name":"ListUsers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListUsersRequest"}, "output":{ "shape":"ListUsersResponse", "resultWrapper":"ListUsersResult" }, "errors":[ {"shape":"ServiceFailureException"} ], "documentation":"

Lists the IAM users that have the specified path prefix. If no path prefix is specified, the action returns all users in the AWS account. If there are none, the action returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

" }, "ListVirtualMFADevices":{ "name":"ListVirtualMFADevices", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListVirtualMFADevicesRequest"}, "output":{ "shape":"ListVirtualMFADevicesResponse", "resultWrapper":"ListVirtualMFADevicesResult" }, "documentation":"

Lists the virtual MFA devices defined in the AWS account by assignment status. If you do not specify an assignment status, the action returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any.

You can paginate the results using the MaxItems and Marker parameters.

" }, "PutGroupPolicy":{ "name":"PutGroupPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutGroupPolicyRequest"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"MalformedPolicyDocumentException"}, {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Adds or updates an inline policy document that is embedded in the specified IAM group.

A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.

" }, "PutRolePolicy":{ "name":"PutRolePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutRolePolicyRequest"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"MalformedPolicyDocumentException"}, {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Adds or updates an inline policy document that is embedded in the specified IAM role.

When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. For more information about IAM roles, go to Using Roles to Delegate Permissions and Federate Identities.

A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutRolePolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.

" }, "PutUserPolicy":{ "name":"PutUserPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutUserPolicyRequest"}, "errors":[ {"shape":"LimitExceededException"}, {"shape":"MalformedPolicyDocumentException"}, {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Adds or updates an inline policy document that is embedded in the specified IAM user.

An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.

" }, "RemoveClientIDFromOpenIDConnectProvider":{ "name":"RemoveClientIDFromOpenIDConnectProvider", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveClientIDFromOpenIDConnectProviderRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.

This action is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist.

" }, "RemoveRoleFromInstanceProfile":{ "name":"RemoveRoleFromInstanceProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveRoleFromInstanceProfileRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Removes the specified IAM role from the specified EC2 instance profile.

Make sure you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance break any applications running on the instance.

For more information about IAM roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.

" }, "RemoveUserFromGroup":{ "name":"RemoveUserFromGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveUserFromGroupRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Removes the specified user from the specified group.

" }, "ResetServiceSpecificCredential":{ "name":"ResetServiceSpecificCredential", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResetServiceSpecificCredentialRequest"}, "output":{ "shape":"ResetServiceSpecificCredentialResponse", "resultWrapper":"ResetServiceSpecificCredentialResult" }, "errors":[ {"shape":"NoSuchEntityException"} ], "documentation":"

Resets the password for a service-specific credential. The new password is AWS generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user.

" }, "ResyncMFADevice":{ "name":"ResyncMFADevice", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ResyncMFADeviceRequest"}, "errors":[ {"shape":"InvalidAuthenticationCodeException"}, {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Synchronizes the specified MFA device with its IAM resource object on the AWS servers.

For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.

" }, "SetDefaultPolicyVersion":{ "name":"SetDefaultPolicyVersion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetDefaultPolicyVersionRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"InvalidInputException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Sets the specified version of the specified policy as the policy's default (operative) version.

This action affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API.

For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.

" }, "SimulateCustomPolicy":{ "name":"SimulateCustomPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SimulateCustomPolicyRequest"}, "output":{ "shape":"SimulatePolicyResponse", "resultWrapper":"SimulateCustomPolicyResult" }, "errors":[ {"shape":"InvalidInputException"}, {"shape":"PolicyEvaluationException"} ], "documentation":"

Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API actions and AWS resources to determine the policies' effective permissions. The policies are provided as strings.

The simulation does not perform the API actions; it only checks the authorization to determine if the simulated policies allow or deny the actions.

If you want to simulate existing policies attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.

If the output is long, you can use MaxItems and Marker parameters to paginate the results.

" }, "SimulatePrincipalPolicy":{ "name":"SimulatePrincipalPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SimulatePrincipalPolicyRequest"}, "output":{ "shape":"SimulatePolicyResponse", "resultWrapper":"SimulatePrincipalPolicyResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"InvalidInputException"}, {"shape":"PolicyEvaluationException"} ], "documentation":"

Simulate how a set of IAM policies attached to an IAM entity works with a list of API actions and AWS resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to .

You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead.

You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation.

The simulation does not perform the API actions, it only checks the authorization to determine if the simulated policies allow or deny the actions.

Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.

If the output is long, you can use the MaxItems and Marker parameters to paginate the results.

" }, "UpdateAccessKey":{ "name":"UpdateAccessKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAccessKeyRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user's key as part of a key rotation work flow.

If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

For information about rotating keys, see Managing Keys and Certificates in the IAM User Guide.

" }, "UpdateAccountPasswordPolicy":{ "name":"UpdateAccountPasswordPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAccountPasswordPolicyRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"MalformedPolicyDocumentException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates the password policy settings for the AWS account.

This action does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value.

For more information about using a password policy, see Managing an IAM Password Policy in the IAM User Guide.

" }, "UpdateAssumeRolePolicy":{ "name":"UpdateAssumeRolePolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAssumeRolePolicyRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"MalformedPolicyDocumentException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the \"role trust policy\". For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities.

" }, "UpdateGroup":{ "name":"UpdateGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateGroupRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"EntityAlreadyExistsException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates the name and/or the path of the specified IAM group.

You should understand the implications of changing a group's path or name. For more information, see Renaming Users and Groups in the IAM User Guide.

To change an IAM group name the requester must have appropriate permissions on both the source object and the target object. For example, to change \"Managers\" to \"MGRs\", the entity making the request must have permission on both \"Managers\" and \"MGRs\", or must have permission on all (*). For more information about permissions, see Permissions and Policies.

" }, "UpdateLoginProfile":{ "name":"UpdateLoginProfile", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateLoginProfileRequest"}, "errors":[ {"shape":"EntityTemporarilyUnmodifiableException"}, {"shape":"NoSuchEntityException"}, {"shape":"PasswordPolicyViolationException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Changes the password for the specified IAM user.

IAM users can change their own passwords by calling ChangePassword. For more information about modifying passwords, see Managing Passwords in the IAM User Guide.

" }, "UpdateOpenIDConnectProviderThumbprint":{ "name":"UpdateOpenIDConnectProviderThumbprint", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateOpenIDConnectProviderThumbprintRequest"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.

The list that you pass with this action completely replaces the existing list of thumbprints. (The lists are not merged.)

Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.

Because trust for the OIDC provider is ultimately derived from the provider's certificate and is validated by the thumbprint, it is a best practice to limit access to the UpdateOpenIDConnectProviderThumbprint action to highly-privileged users.

" }, "UpdateSAMLProvider":{ "name":"UpdateSAMLProvider", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateSAMLProviderRequest"}, "output":{ "shape":"UpdateSAMLProviderResponse", "resultWrapper":"UpdateSAMLProviderResult" }, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"InvalidInputException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates the metadata document for an existing SAML provider resource object.

This operation requires Signature Version 4.

" }, "UpdateSSHPublicKey":{ "name":"UpdateSSHPublicKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateSSHPublicKeyRequest"}, "errors":[ {"shape":"NoSuchEntityException"} ], "documentation":"

Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This action can be used to disable a user's SSH public key as part of a key rotation work flow.

The SSH public key affected by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

" }, "UpdateServerCertificate":{ "name":"UpdateServerCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateServerCertificateRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"EntityAlreadyExistsException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates the name and/or the path of the specified server certificate stored in IAM.

For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.

You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a Server Certificate in the IAM User Guide.

To change a server certificate name the requester must have appropriate permissions on both the source object and the target object. For example, to change the name from \"ProductionCert\" to \"ProdCert\", the entity making the request must have permission on \"ProductionCert\" and \"ProdCert\", or must have permission on all (*). For more information about permissions, see Access Management in the IAM User Guide.

" }, "UpdateServiceSpecificCredential":{ "name":"UpdateServiceSpecificCredential", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateServiceSpecificCredentialRequest"}, "errors":[ {"shape":"NoSuchEntityException"} ], "documentation":"

Sets the status of a service-specific credential to Active or Inactive. Service-specific credentials that are inactive cannot be used for authentication to the service. This action can be used to disable a user’s service-specific credential as part of a credential rotation work flow.

" }, "UpdateSigningCertificate":{ "name":"UpdateSigningCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateSigningCertificateRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Changes the status of the specified user signing certificate from active to disabled, or vice versa. This action can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.

If the UserName field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

" }, "UpdateUser":{ "name":"UpdateUser", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateUserRequest"}, "errors":[ {"shape":"NoSuchEntityException"}, {"shape":"LimitExceededException"}, {"shape":"EntityAlreadyExistsException"}, {"shape":"EntityTemporarilyUnmodifiableException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Updates the name and/or the path of the specified IAM user.

You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM User and Renaming an IAM Group in the IAM User Guide.

To change a user name the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and Policies.

" }, "UploadSSHPublicKey":{ "name":"UploadSSHPublicKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UploadSSHPublicKeyRequest"}, "output":{ "shape":"UploadSSHPublicKeyResponse", "resultWrapper":"UploadSSHPublicKeyResult" }, "errors":[ {"shape":"LimitExceededException"}, {"shape":"NoSuchEntityException"}, {"shape":"InvalidPublicKeyException"}, {"shape":"DuplicateSSHPublicKeyException"}, {"shape":"UnrecognizedPublicKeyEncodingException"} ], "documentation":"

Uploads an SSH public key and associates it with the specified IAM user.

The SSH public key uploaded by this action can be used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

" }, "UploadServerCertificate":{ "name":"UploadServerCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UploadServerCertificateRequest"}, "output":{ "shape":"UploadServerCertificateResponse", "resultWrapper":"UploadServerCertificateResult" }, "errors":[ {"shape":"LimitExceededException"}, {"shape":"EntityAlreadyExistsException"}, {"shape":"MalformedCertificateException"}, {"shape":"KeyPairMismatchException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.

For more information about working with server certificates, including a list of AWS services that can use the server certificates that you manage with IAM, go to Working with Server Certificates in the IAM User Guide.

For information about the number of server certificates you can upload, see Limitations on IAM Entities and Objects in the IAM User Guide.

Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Calling the API by Making HTTP Query Requests in the IAM User Guide.

" }, "UploadSigningCertificate":{ "name":"UploadSigningCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UploadSigningCertificateRequest"}, "output":{ "shape":"UploadSigningCertificateResponse", "resultWrapper":"UploadSigningCertificateResult" }, "errors":[ {"shape":"LimitExceededException"}, {"shape":"EntityAlreadyExistsException"}, {"shape":"MalformedCertificateException"}, {"shape":"InvalidCertificateException"}, {"shape":"DuplicateCertificateException"}, {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], "documentation":"

Uploads an X.509 signing certificate and associates it with the specified IAM user. Some AWS services use X.509 signing certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active.

If the UserName field is not specified, the IAM user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users.

Because the body of a X.509 certificate can be large, you should use POST rather than GET when calling UploadSigningCertificate. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.

" } }, "shapes":{ "AccessKey":{ "type":"structure", "required":[ "UserName", "AccessKeyId", "Status", "SecretAccessKey" ], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the IAM user that the access key is associated with.

" }, "AccessKeyId":{ "shape":"accessKeyIdType", "documentation":"

The ID for this access key.

" }, "Status":{ "shape":"statusType", "documentation":"

The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.

" }, "SecretAccessKey":{ "shape":"accessKeySecretType", "documentation":"

The secret key used to sign requests.

" }, "CreateDate":{ "shape":"dateType", "documentation":"

The date when the access key was created.

" } }, "documentation":"

Contains information about an AWS access key.

This data type is used as a response element in the CreateAccessKey and ListAccessKeys actions.

The SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key.

" }, "AccessKeyLastUsed":{ "type":"structure", "required":[ "LastUsedDate", "ServiceName", "Region" ], "members":{ "LastUsedDate":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the access key was most recently used. This field is null when:

  • The user does not have an access key.

  • An access key exists but has never been used, at least not since IAM started tracking this information on April 22nd, 2015.

  • There is no sign-in data associated with the user

" }, "ServiceName":{ "shape":"stringType", "documentation":"

The name of the AWS service with which this access key was most recently used. This field is null when:

  • The user does not have an access key.

  • An access key exists but has never been used, at least not since IAM started tracking this information on April 22nd, 2015.

  • There is no sign-in data associated with the user

" }, "Region":{ "shape":"stringType", "documentation":"

The AWS region where this access key was most recently used. This field is null when:

  • The user does not have an access key.

  • An access key exists but has never been used, at least not since IAM started tracking this information on April 22nd, 2015.

  • There is no sign-in data associated with the user

For more information about AWS regions, see Regions and Endpoints in the Amazon Web Services General Reference.

" } }, "documentation":"

Contains information about the last time an AWS access key was used.

This data type is used as a response element in the GetAccessKeyLastUsed action.

" }, "AccessKeyMetadata":{ "type":"structure", "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the IAM user that the key is associated with.

" }, "AccessKeyId":{ "shape":"accessKeyIdType", "documentation":"

The ID for this access key.

" }, "Status":{ "shape":"statusType", "documentation":"

The status of the access key. Active means the key is valid for API calls; Inactive means it is not.

" }, "CreateDate":{ "shape":"dateType", "documentation":"

The date when the access key was created.

" } }, "documentation":"

Contains information about an AWS access key, without its secret key.

This data type is used as a response element in the ListAccessKeys action.

" }, "ActionNameListType":{ "type":"list", "member":{"shape":"ActionNameType"} }, "ActionNameType":{ "type":"string", "max":128, "min":3 }, "AddClientIDToOpenIDConnectProviderRequest":{ "type":"structure", "required":[ "OpenIDConnectProviderArn", "ClientID" ], "members":{ "OpenIDConnectProviderArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.

" }, "ClientID":{ "shape":"clientIDType", "documentation":"

The client ID (also known as audience) to add to the IAM OpenID Connect provider resource.

" } } }, "AddRoleToInstanceProfileRequest":{ "type":"structure", "required":[ "InstanceProfileName", "RoleName" ], "members":{ "InstanceProfileName":{ "shape":"instanceProfileNameType", "documentation":"

The name of the instance profile to update.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "RoleName":{ "shape":"roleNameType", "documentation":"

The name of the role to add.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "AddUserToGroupRequest":{ "type":"structure", "required":[ "GroupName", "UserName" ], "members":{ "GroupName":{ "shape":"groupNameType", "documentation":"

The name of the group to update.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the user to add.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "AttachGroupPolicyRequest":{ "type":"structure", "required":[ "GroupName", "PolicyArn" ], "members":{ "GroupName":{ "shape":"groupNameType", "documentation":"

The name (friendly name, not ARN) of the group to attach the policy to.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" } } }, "AttachRolePolicyRequest":{ "type":"structure", "required":[ "RoleName", "PolicyArn" ], "members":{ "RoleName":{ "shape":"roleNameType", "documentation":"

The name (friendly name, not ARN) of the role to attach the policy to.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" } } }, "AttachUserPolicyRequest":{ "type":"structure", "required":[ "UserName", "PolicyArn" ], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name (friendly name, not ARN) of the IAM user to attach the policy to.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" } } }, "AttachedPolicy":{ "type":"structure", "members":{ "PolicyName":{ "shape":"policyNameType", "documentation":"

The friendly name of the attached policy.

" }, "PolicyArn":{"shape":"arnType"} }, "documentation":"

Contains information about an attached policy.

An attached policy is a managed policy that has been attached to a user, group, or role. This data type is used as a response element in the ListAttachedGroupPolicies, ListAttachedRolePolicies, ListAttachedUserPolicies, and GetAccountAuthorizationDetails actions.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

" }, "BootstrapDatum":{ "type":"blob", "sensitive":true }, "ChangePasswordRequest":{ "type":"structure", "required":[ "OldPassword", "NewPassword" ], "members":{ "OldPassword":{ "shape":"passwordType", "documentation":"

The IAM user's current password.

" }, "NewPassword":{ "shape":"passwordType", "documentation":"

The new password. The new password must conform to the AWS account's password policy, if one exists.

The regex pattern used to validate this parameter is a string of characters consisting of almost any printable ASCII character from the space (\\u0020) through the end of the ASCII character range (\\u00FF). You can also include the tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) characters. Although any of these characters are valid in a password, note that many tools, such as the AWS Management Console, might restrict the ability to enter certain characters because they have special meaning within that tool.

" } } }, "ColumnNumber":{"type":"integer"}, "ContextEntry":{ "type":"structure", "members":{ "ContextKeyName":{ "shape":"ContextKeyNameType", "documentation":"

The full name of a condition context key, including the service prefix. For example, aws:SourceIp or s3:VersionId.

" }, "ContextKeyValues":{ "shape":"ContextKeyValueListType", "documentation":"

The value (or values, if the condition context key supports multiple values) to provide to the simulation for use when the key is referenced by a Condition element in an input policy.

" }, "ContextKeyType":{ "shape":"ContextKeyTypeEnum", "documentation":"

The data type of the value (or values) specified in the ContextKeyValues parameter.

" } }, "documentation":"

Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the Condition elements of the input policies.

This data type is used as an input parameter to SimulateCustomPolicy and SimulateCustomPolicy .

" }, "ContextEntryListType":{ "type":"list", "member":{"shape":"ContextEntry"} }, "ContextKeyNameType":{ "type":"string", "max":256, "min":5 }, "ContextKeyNamesResultListType":{ "type":"list", "member":{"shape":"ContextKeyNameType"} }, "ContextKeyTypeEnum":{ "type":"string", "enum":[ "string", "stringList", "numeric", "numericList", "boolean", "booleanList", "ip", "ipList", "binary", "binaryList", "date", "dateList" ] }, "ContextKeyValueListType":{ "type":"list", "member":{"shape":"ContextKeyValueType"} }, "ContextKeyValueType":{"type":"string"}, "CreateAccessKeyRequest":{ "type":"structure", "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the IAM user that the new key will belong to.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "CreateAccessKeyResponse":{ "type":"structure", "required":["AccessKey"], "members":{ "AccessKey":{ "shape":"AccessKey", "documentation":"

A structure with details about the access key.

" } }, "documentation":"

Contains the response to a successful CreateAccessKey request.

" }, "CreateAccountAliasRequest":{ "type":"structure", "required":["AccountAlias"], "members":{ "AccountAlias":{ "shape":"accountAliasType", "documentation":"

The account alias to create.

This parameter allows (per its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.

" } } }, "CreateGroupRequest":{ "type":"structure", "required":["GroupName"], "members":{ "Path":{ "shape":"pathType", "documentation":"

The path to the group. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "GroupName":{ "shape":"groupNameType", "documentation":"

The name of the group to create. Do not include the path in this value.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-. The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both \"ADMINS\" and \"admins\".

" } } }, "CreateGroupResponse":{ "type":"structure", "required":["Group"], "members":{ "Group":{ "shape":"Group", "documentation":"

A structure containing details about the new group.

" } }, "documentation":"

Contains the response to a successful CreateGroup request.

" }, "CreateInstanceProfileRequest":{ "type":"structure", "required":["InstanceProfileName"], "members":{ "InstanceProfileName":{ "shape":"instanceProfileNameType", "documentation":"

The name of the instance profile to create.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "Path":{ "shape":"pathType", "documentation":"

The path to the instance profile. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" } } }, "CreateInstanceProfileResponse":{ "type":"structure", "required":["InstanceProfile"], "members":{ "InstanceProfile":{ "shape":"InstanceProfile", "documentation":"

A structure containing details about the new instance profile.

" } }, "documentation":"

Contains the response to a successful CreateInstanceProfile request.

" }, "CreateLoginProfileRequest":{ "type":"structure", "required":[ "UserName", "Password" ], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the IAM user to create a password for. The user must already exist.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "Password":{ "shape":"passwordType", "documentation":"

The new password for the user.

The regex pattern used to validate this parameter is a string of characters consisting of almost any printable ASCII character from the space (\\u0020) through the end of the ASCII character range (\\u00FF). You can also include the tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) characters. Although any of these characters are valid in a password, note that many tools, such as the AWS Management Console, might restrict the ability to enter certain characters because they have special meaning within that tool.

" }, "PasswordResetRequired":{ "shape":"booleanType", "documentation":"

Specifies whether the user is required to set a new password on next sign-in.

" } } }, "CreateLoginProfileResponse":{ "type":"structure", "required":["LoginProfile"], "members":{ "LoginProfile":{ "shape":"LoginProfile", "documentation":"

A structure containing the user name and password create date.

" } }, "documentation":"

Contains the response to a successful CreateLoginProfile request.

" }, "CreateOpenIDConnectProviderRequest":{ "type":"structure", "required":[ "Url", "ThumbprintList" ], "members":{ "Url":{ "shape":"OpenIDConnectProviderUrlType", "documentation":"

The URL of the identity provider. The URL must begin with \"https://\" and should correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a host name, like \"https://server.example.org\" or \"https://example.com\".

You cannot register the same provider multiple times in a single AWS account. If you try to submit a URL that has already been used for an OpenID Connect provider in the AWS account, you will get an error.

" }, "ClientIDList":{ "shape":"clientIDListType", "documentation":"

A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)

You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.

There is no defined format for a client ID. The CreateOpenIDConnectProviderRequest action accepts client IDs up to 255 characters long.

" }, "ThumbprintList":{ "shape":"thumbprintListType", "documentation":"

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s). Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.

The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.

You must provide at least one thumbprint when creating an IAM OIDC provider. For example, if the OIDC provider is server.example.com and the provider stores its keys at \"https://keys.server.example.com/openid-connect\", the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com.

For more information about obtaining the OIDC provider's thumbprint, see Obtaining the Thumbprint for an OpenID Connect Provider in the IAM User Guide.

" } } }, "CreateOpenIDConnectProviderResponse":{ "type":"structure", "members":{ "OpenIDConnectProviderArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the new IAM OpenID Connect provider that is created. For more information, see OpenIDConnectProviderListEntry.

" } }, "documentation":"

Contains the response to a successful CreateOpenIDConnectProvider request.

" }, "CreatePolicyRequest":{ "type":"structure", "required":[ "PolicyName", "PolicyDocument" ], "members":{ "PolicyName":{ "shape":"policyNameType", "documentation":"

The friendly name of the policy.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "Path":{ "shape":"policyPathType", "documentation":"

The path for the policy.

For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "PolicyDocument":{ "shape":"policyDocumentType", "documentation":"

The JSON policy document that you want to use as the content for the new policy.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" }, "Description":{ "shape":"policyDescriptionType", "documentation":"

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, \"Grants access to production DynamoDB tables.\"

The policy description is immutable. After a value is assigned, it cannot be changed.

" } } }, "CreatePolicyResponse":{ "type":"structure", "members":{ "Policy":{ "shape":"Policy", "documentation":"

A structure containing details about the new policy.

" } }, "documentation":"

Contains the response to a successful CreatePolicy request.

" }, "CreatePolicyVersionRequest":{ "type":"structure", "required":[ "PolicyArn", "PolicyDocument" ], "members":{ "PolicyArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" }, "PolicyDocument":{ "shape":"policyDocumentType", "documentation":"

The JSON policy document that you want to use as the content for this new version of the policy.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" }, "SetAsDefault":{ "shape":"booleanType", "documentation":"

Specifies whether to set this version as the policy's default version.

When this parameter is true, the new policy version becomes the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

" } } }, "CreatePolicyVersionResponse":{ "type":"structure", "members":{ "PolicyVersion":{ "shape":"PolicyVersion", "documentation":"

A structure containing details about the new policy version.

" } }, "documentation":"

Contains the response to a successful CreatePolicyVersion request.

" }, "CreateRoleRequest":{ "type":"structure", "required":[ "RoleName", "AssumeRolePolicyDocument" ], "members":{ "Path":{ "shape":"pathType", "documentation":"

The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "RoleName":{ "shape":"roleNameType", "documentation":"

The name of the role to create.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-. Role names are not distinguished by case. For example, you cannot create roles named both \"PRODROLE\" and \"prodrole\".

" }, "AssumeRolePolicyDocument":{ "shape":"policyDocumentType", "documentation":"

The trust relationship policy document that grants an entity permission to assume the role.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" } } }, "CreateRoleResponse":{ "type":"structure", "required":["Role"], "members":{ "Role":{ "shape":"Role", "documentation":"

A structure containing details about the new role.

" } }, "documentation":"

Contains the response to a successful CreateRole request.

" }, "CreateSAMLProviderRequest":{ "type":"structure", "required":[ "SAMLMetadataDocument", "Name" ], "members":{ "SAMLMetadataDocument":{ "shape":"SAMLMetadataDocumentType", "documentation":"

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see About SAML 2.0-based Federation in the IAM User Guide

" }, "Name":{ "shape":"SAMLProviderNameType", "documentation":"

The name of the provider to create.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "CreateSAMLProviderResponse":{ "type":"structure", "members":{ "SAMLProviderArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the new SAML provider resource in IAM.

" } }, "documentation":"

Contains the response to a successful CreateSAMLProvider request.

" }, "CreateServiceSpecificCredentialRequest":{ "type":"structure", "required":[ "UserName", "ServiceName" ], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the IAM user that is to be associated with the credentials. The new service-specific credentials have the same permissions as the associated user except that they can be used only to access the specified service.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "ServiceName":{ "shape":"serviceName", "documentation":"

The name of the AWS service that is to be associated with the credentials. The service you specify here is the only service that can be accessed using these credentials.

" } } }, "CreateServiceSpecificCredentialResponse":{ "type":"structure", "members":{ "ServiceSpecificCredential":{ "shape":"ServiceSpecificCredential", "documentation":"

A structure that contains information about the newly created service-specific credential.

This is the only time that the password for this credential set is available. It cannot be recovered later. Instead, you will have to reset the password with ResetServiceSpecificCredential.

" } } }, "CreateUserRequest":{ "type":"structure", "required":["UserName"], "members":{ "Path":{ "shape":"pathType", "documentation":"

The path for the user name. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "UserName":{ "shape":"userNameType", "documentation":"

The name of the user to create.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-. User names are not distinguished by case. For example, you cannot create users named both \"TESTUSER\" and \"testuser\".

" } } }, "CreateUserResponse":{ "type":"structure", "members":{ "User":{ "shape":"User", "documentation":"

A structure with details about the new IAM user.

" } }, "documentation":"

Contains the response to a successful CreateUser request.

" }, "CreateVirtualMFADeviceRequest":{ "type":"structure", "required":["VirtualMFADeviceName"], "members":{ "Path":{ "shape":"pathType", "documentation":"

The path for the virtual MFA device. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "VirtualMFADeviceName":{ "shape":"virtualMFADeviceName", "documentation":"

The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "CreateVirtualMFADeviceResponse":{ "type":"structure", "required":["VirtualMFADevice"], "members":{ "VirtualMFADevice":{ "shape":"VirtualMFADevice", "documentation":"

A structure containing details about the new virtual MFA device.

" } }, "documentation":"

Contains the response to a successful CreateVirtualMFADevice request.

" }, "CredentialReportExpiredException":{ "type":"structure", "members":{ "message":{"shape":"credentialReportExpiredExceptionMessage"} }, "documentation":"

The request was rejected because the most recent credential report has expired. To generate a new credential report, use GenerateCredentialReport. For more information about credential report expiration, see Getting Credential Reports in the IAM User Guide.

", "error":{ "code":"ReportExpired", "httpStatusCode":410, "senderFault":true }, "exception":true }, "CredentialReportNotPresentException":{ "type":"structure", "members":{ "message":{"shape":"credentialReportNotPresentExceptionMessage"} }, "documentation":"

The request was rejected because the credential report does not exist. To generate a credential report, use GenerateCredentialReport.

", "error":{ "code":"ReportNotPresent", "httpStatusCode":410, "senderFault":true }, "exception":true }, "CredentialReportNotReadyException":{ "type":"structure", "members":{ "message":{"shape":"credentialReportNotReadyExceptionMessage"} }, "documentation":"

The request was rejected because the credential report is still being generated.

", "error":{ "code":"ReportInProgress", "httpStatusCode":404, "senderFault":true }, "exception":true }, "DeactivateMFADeviceRequest":{ "type":"structure", "required":[ "UserName", "SerialNumber" ], "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the user whose MFA device you want to deactivate.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "SerialNumber":{ "shape":"serialNumberType", "documentation":"

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =/:,.@-

" } } }, "DeleteAccessKeyRequest":{ "type":"structure", "required":["AccessKeyId"], "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the user whose access key pair you want to delete.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "AccessKeyId":{ "shape":"accessKeyIdType", "documentation":"

The access key ID for the access key ID and secret access key you want to delete.

This parameter allows (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" } } }, "DeleteAccountAliasRequest":{ "type":"structure", "required":["AccountAlias"], "members":{ "AccountAlias":{ "shape":"accountAliasType", "documentation":"

The name of the account alias to delete.

This parameter allows (per its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.

" } } }, "DeleteConflictException":{ "type":"structure", "members":{ "message":{"shape":"deleteConflictMessage"} }, "documentation":"

The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.

", "error":{ "code":"DeleteConflict", "httpStatusCode":409, "senderFault":true }, "exception":true }, "DeleteGroupPolicyRequest":{ "type":"structure", "required":[ "GroupName", "PolicyName" ], "members":{ "GroupName":{ "shape":"groupNameType", "documentation":"

The name (friendly name, not ARN) identifying the group that the policy is embedded in.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyName":{ "shape":"policyNameType", "documentation":"

The name identifying the policy document to delete.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "DeleteGroupRequest":{ "type":"structure", "required":["GroupName"], "members":{ "GroupName":{ "shape":"groupNameType", "documentation":"

The name of the IAM group to delete.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "DeleteInstanceProfileRequest":{ "type":"structure", "required":["InstanceProfileName"], "members":{ "InstanceProfileName":{ "shape":"instanceProfileNameType", "documentation":"

The name of the instance profile to delete.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "DeleteLoginProfileRequest":{ "type":"structure", "required":["UserName"], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the user whose password you want to delete.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "DeleteOpenIDConnectProviderRequest":{ "type":"structure", "required":["OpenIDConnectProviderArn"], "members":{ "OpenIDConnectProviderArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource object to delete. You can get a list of OpenID Connect provider resource ARNs by using the ListOpenIDConnectProviders action.

" } } }, "DeletePolicyRequest":{ "type":"structure", "required":["PolicyArn"], "members":{ "PolicyArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to delete.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" } } }, "DeletePolicyVersionRequest":{ "type":"structure", "required":[ "PolicyArn", "VersionId" ], "members":{ "PolicyArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a version.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" }, "VersionId":{ "shape":"policyVersionIdType", "documentation":"

The policy version to delete.

This parameter allows (per its regex pattern) a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

" } } }, "DeleteRolePolicyRequest":{ "type":"structure", "required":[ "RoleName", "PolicyName" ], "members":{ "RoleName":{ "shape":"roleNameType", "documentation":"

The name (friendly name, not ARN) identifying the role that the policy is embedded in.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyName":{ "shape":"policyNameType", "documentation":"

The name of the inline policy to delete from the specified IAM role.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "DeleteRoleRequest":{ "type":"structure", "required":["RoleName"], "members":{ "RoleName":{ "shape":"roleNameType", "documentation":"

The name of the role to delete.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "DeleteSAMLProviderRequest":{ "type":"structure", "required":["SAMLProviderArn"], "members":{ "SAMLProviderArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the SAML provider to delete.

" } } }, "DeleteSSHPublicKeyRequest":{ "type":"structure", "required":[ "UserName", "SSHPublicKeyId" ], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the IAM user associated with the SSH public key.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "SSHPublicKeyId":{ "shape":"publicKeyIdType", "documentation":"

The unique identifier for the SSH public key.

This parameter allows (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" } } }, "DeleteServerCertificateRequest":{ "type":"structure", "required":["ServerCertificateName"], "members":{ "ServerCertificateName":{ "shape":"serverCertificateNameType", "documentation":"

The name of the server certificate you want to delete.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "DeleteServiceSpecificCredentialRequest":{ "type":"structure", "required":["ServiceSpecificCredentialId"], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "ServiceSpecificCredentialId":{ "shape":"serviceSpecificCredentialId", "documentation":"

The unique identifier of the service-specific credential. You can get this value by calling ListServiceSpecificCredentials.

This parameter allows (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" } } }, "DeleteSigningCertificateRequest":{ "type":"structure", "required":["CertificateId"], "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the user the signing certificate belongs to.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "CertificateId":{ "shape":"certificateIdType", "documentation":"

The ID of the signing certificate to delete.

The format of this parameter, as described by its regex pattern, is a string of characters that can be upper- or lower-cased letters or digits.

" } } }, "DeleteUserPolicyRequest":{ "type":"structure", "required":[ "UserName", "PolicyName" ], "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name (friendly name, not ARN) identifying the user that the policy is embedded in.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyName":{ "shape":"policyNameType", "documentation":"

The name identifying the policy document to delete.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "DeleteUserRequest":{ "type":"structure", "required":["UserName"], "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the user to delete.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "DeleteVirtualMFADeviceRequest":{ "type":"structure", "required":["SerialNumber"], "members":{ "SerialNumber":{ "shape":"serialNumberType", "documentation":"

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =/:,.@-

" } } }, "DetachGroupPolicyRequest":{ "type":"structure", "required":[ "GroupName", "PolicyArn" ], "members":{ "GroupName":{ "shape":"groupNameType", "documentation":"

The name (friendly name, not ARN) of the IAM group to detach the policy from.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" } } }, "DetachRolePolicyRequest":{ "type":"structure", "required":[ "RoleName", "PolicyArn" ], "members":{ "RoleName":{ "shape":"roleNameType", "documentation":"

The name (friendly name, not ARN) of the IAM role to detach the policy from.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" } } }, "DetachUserPolicyRequest":{ "type":"structure", "required":[ "UserName", "PolicyArn" ], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name (friendly name, not ARN) of the IAM user to detach the policy from.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" } } }, "DuplicateCertificateException":{ "type":"structure", "members":{ "message":{"shape":"duplicateCertificateMessage"} }, "documentation":"

The request was rejected because the same certificate is associated with an IAM user in the account.

", "error":{ "code":"DuplicateCertificate", "httpStatusCode":409, "senderFault":true }, "exception":true }, "DuplicateSSHPublicKeyException":{ "type":"structure", "members":{ "message":{"shape":"duplicateSSHPublicKeyMessage"} }, "documentation":"

The request was rejected because the SSH public key is already associated with the specified IAM user.

", "error":{ "code":"DuplicateSSHPublicKey", "httpStatusCode":400, "senderFault":true }, "exception":true }, "EnableMFADeviceRequest":{ "type":"structure", "required":[ "UserName", "SerialNumber", "AuthenticationCode1", "AuthenticationCode2" ], "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the IAM user for whom you want to enable the MFA device.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "SerialNumber":{ "shape":"serialNumberType", "documentation":"

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =/:,.@-

" }, "AuthenticationCode1":{ "shape":"authenticationCodeType", "documentation":"

An authentication code emitted by the device.

The format for this parameter is a string of 6 digits.

" }, "AuthenticationCode2":{ "shape":"authenticationCodeType", "documentation":"

A subsequent authentication code emitted by the device.

The format for this parameter is a string of 6 digits.

" } } }, "EntityAlreadyExistsException":{ "type":"structure", "members":{ "message":{"shape":"entityAlreadyExistsMessage"} }, "documentation":"

The request was rejected because it attempted to create a resource that already exists.

", "error":{ "code":"EntityAlreadyExists", "httpStatusCode":409, "senderFault":true }, "exception":true }, "EntityTemporarilyUnmodifiableException":{ "type":"structure", "members":{ "message":{"shape":"entityTemporarilyUnmodifiableMessage"} }, "documentation":"

The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.

", "error":{ "code":"EntityTemporarilyUnmodifiable", "httpStatusCode":409, "senderFault":true }, "exception":true }, "EntityType":{ "type":"string", "enum":[ "User", "Role", "Group", "LocalManagedPolicy", "AWSManagedPolicy" ] }, "EvalDecisionDetailsType":{ "type":"map", "key":{"shape":"EvalDecisionSourceType"}, "value":{"shape":"PolicyEvaluationDecisionType"} }, "EvalDecisionSourceType":{ "type":"string", "max":256, "min":3 }, "EvaluationResult":{ "type":"structure", "required":[ "EvalActionName", "EvalDecision" ], "members":{ "EvalActionName":{ "shape":"ActionNameType", "documentation":"

The name of the API action tested on the indicated resource.

" }, "EvalResourceName":{ "shape":"ResourceNameType", "documentation":"

The ARN of the resource that the indicated API action was tested on.

" }, "EvalDecision":{ "shape":"PolicyEvaluationDecisionType", "documentation":"

The result of the simulation.

" }, "MatchedStatements":{ "shape":"StatementListType", "documentation":"

A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the action on the resource, if only one statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.

" }, "MissingContextValues":{ "shape":"ContextKeyNamesResultListType", "documentation":"

A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when the resource in a simulation is \"*\", either explicitly, or when the ResourceArns parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

" }, "EvalDecisionDetails":{ "shape":"EvalDecisionDetailsType", "documentation":"

Additional details about the results of the evaluation decision. When there are both IAM policies and resource policies, this parameter explains how each set of policies contributes to the final evaluation decision. When simulating cross-account access to a resource, both the resource-based policy and the caller's IAM policy must grant access. See How IAM Roles Differ from Resource-based Policies

" }, "ResourceSpecificResults":{ "shape":"ResourceSpecificResultListType", "documentation":"

The individual results of the simulation of the API action specified in EvalActionName on each resource.

" } }, "documentation":"

Contains the results of a simulation.

This data type is used by the return parameter of SimulateCustomPolicy and SimulatePrincipalPolicy .

" }, "EvaluationResultsListType":{ "type":"list", "member":{"shape":"EvaluationResult"} }, "GenerateCredentialReportResponse":{ "type":"structure", "members":{ "State":{ "shape":"ReportStateType", "documentation":"

Information about the state of the credential report.

" }, "Description":{ "shape":"ReportStateDescriptionType", "documentation":"

Information about the credential report.

" } }, "documentation":"

Contains the response to a successful GenerateCredentialReport request.

" }, "GetAccessKeyLastUsedRequest":{ "type":"structure", "required":["AccessKeyId"], "members":{ "AccessKeyId":{ "shape":"accessKeyIdType", "documentation":"

The identifier of an access key.

This parameter allows (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" } } }, "GetAccessKeyLastUsedResponse":{ "type":"structure", "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the AWS IAM user that owns this access key.

" }, "AccessKeyLastUsed":{ "shape":"AccessKeyLastUsed", "documentation":"

Contains information about the last time the access key was used.

" } }, "documentation":"

Contains the response to a successful GetAccessKeyLastUsed request. It is also returned as a member of the AccessKeyMetaData structure returned by the ListAccessKeys action.

" }, "GetAccountAuthorizationDetailsRequest":{ "type":"structure", "members":{ "Filter":{ "shape":"entityListType", "documentation":"

A list of entity types used to filter the results. Only the entities that match the types you specify are included in the output. Use the value LocalManagedPolicy to include customer managed policies.

The format for this parameter is a comma-separated (if more than one) list of strings. Each string value in the list must be one of the valid values listed below.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" } } }, "GetAccountAuthorizationDetailsResponse":{ "type":"structure", "members":{ "UserDetailList":{ "shape":"userDetailListType", "documentation":"

A list containing information about IAM users.

" }, "GroupDetailList":{ "shape":"groupDetailListType", "documentation":"

A list containing information about IAM groups.

" }, "RoleDetailList":{ "shape":"roleDetailListType", "documentation":"

A list containing information about IAM roles.

" }, "Policies":{ "shape":"ManagedPolicyDetailListType", "documentation":"

A list containing information about managed policies.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful GetAccountAuthorizationDetails request.

" }, "GetAccountPasswordPolicyResponse":{ "type":"structure", "required":["PasswordPolicy"], "members":{ "PasswordPolicy":{ "shape":"PasswordPolicy", "documentation":"

Contains information about the account password policy.

" } }, "documentation":"

Contains the response to a successful GetAccountPasswordPolicy request.

" }, "GetAccountSummaryResponse":{ "type":"structure", "members":{ "SummaryMap":{ "shape":"summaryMapType", "documentation":"

A set of key value pairs containing information about IAM entity usage and IAM quotas.

" } }, "documentation":"

Contains the response to a successful GetAccountSummary request.

" }, "GetContextKeysForCustomPolicyRequest":{ "type":"structure", "required":["PolicyInputList"], "members":{ "PolicyInputList":{ "shape":"SimulationPolicyListType", "documentation":"

A list of policies for which you want the list of context keys referenced in those policies. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" } } }, "GetContextKeysForPolicyResponse":{ "type":"structure", "members":{ "ContextKeyNames":{ "shape":"ContextKeyNamesResultListType", "documentation":"

The list of context keys that are referenced in the input policies.

" } }, "documentation":"

Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.

" }, "GetContextKeysForPrincipalPolicyRequest":{ "type":"structure", "required":["PolicySourceArn"], "members":{ "PolicySourceArn":{ "shape":"arnType", "documentation":"

The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" }, "PolicyInputList":{ "shape":"SimulationPolicyListType", "documentation":"

An optional list of additional policies for which you want the list of context keys that are referenced.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" } } }, "GetCredentialReportResponse":{ "type":"structure", "members":{ "Content":{ "shape":"ReportContentType", "documentation":"

Contains the credential report. The report is Base64-encoded.

" }, "ReportFormat":{ "shape":"ReportFormatType", "documentation":"

The format (MIME type) of the credential report.

" }, "GeneratedTime":{ "shape":"dateType", "documentation":"

The date and time when the credential report was created, in ISO 8601 date-time format.

" } }, "documentation":"

Contains the response to a successful GetCredentialReport request.

" }, "GetGroupPolicyRequest":{ "type":"structure", "required":[ "GroupName", "PolicyName" ], "members":{ "GroupName":{ "shape":"groupNameType", "documentation":"

The name of the group the policy is associated with.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyName":{ "shape":"policyNameType", "documentation":"

The name of the policy document to get.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "GetGroupPolicyResponse":{ "type":"structure", "required":[ "GroupName", "PolicyName", "PolicyDocument" ], "members":{ "GroupName":{ "shape":"groupNameType", "documentation":"

The group the policy is associated with.

" }, "PolicyName":{ "shape":"policyNameType", "documentation":"

The name of the policy.

" }, "PolicyDocument":{ "shape":"policyDocumentType", "documentation":"

The policy document.

" } }, "documentation":"

Contains the response to a successful GetGroupPolicy request.

" }, "GetGroupRequest":{ "type":"structure", "required":["GroupName"], "members":{ "GroupName":{ "shape":"groupNameType", "documentation":"

The name of the group.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "GetGroupResponse":{ "type":"structure", "required":[ "Group", "Users" ], "members":{ "Group":{ "shape":"Group", "documentation":"

A structure that contains details about the group.

" }, "Users":{ "shape":"userListType", "documentation":"

A list of users in the group.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful GetGroup request.

" }, "GetInstanceProfileRequest":{ "type":"structure", "required":["InstanceProfileName"], "members":{ "InstanceProfileName":{ "shape":"instanceProfileNameType", "documentation":"

The name of the instance profile to get information about.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "GetInstanceProfileResponse":{ "type":"structure", "required":["InstanceProfile"], "members":{ "InstanceProfile":{ "shape":"InstanceProfile", "documentation":"

A structure containing details about the instance profile.

" } }, "documentation":"

Contains the response to a successful GetInstanceProfile request.

" }, "GetLoginProfileRequest":{ "type":"structure", "required":["UserName"], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the user whose login profile you want to retrieve.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "GetLoginProfileResponse":{ "type":"structure", "required":["LoginProfile"], "members":{ "LoginProfile":{ "shape":"LoginProfile", "documentation":"

A structure containing the user name and password create date for the user.

" } }, "documentation":"

Contains the response to a successful GetLoginProfile request.

" }, "GetOpenIDConnectProviderRequest":{ "type":"structure", "required":["OpenIDConnectProviderArn"], "members":{ "OpenIDConnectProviderArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to get information for. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders action.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" } } }, "GetOpenIDConnectProviderResponse":{ "type":"structure", "members":{ "Url":{ "shape":"OpenIDConnectProviderUrlType", "documentation":"

The URL that the IAM OIDC provider resource object is associated with. For more information, see CreateOpenIDConnectProvider.

" }, "ClientIDList":{ "shape":"clientIDListType", "documentation":"

A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

" }, "ThumbprintList":{ "shape":"thumbprintListType", "documentation":"

A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

" }, "CreateDate":{ "shape":"dateType", "documentation":"

The date and time when the IAM OIDC provider resource object was created in the AWS account.

" } }, "documentation":"

Contains the response to a successful GetOpenIDConnectProvider request.

" }, "GetPolicyRequest":{ "type":"structure", "required":["PolicyArn"], "members":{ "PolicyArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" } } }, "GetPolicyResponse":{ "type":"structure", "members":{ "Policy":{ "shape":"Policy", "documentation":"

A structure containing details about the policy.

" } }, "documentation":"

Contains the response to a successful GetPolicy request.

" }, "GetPolicyVersionRequest":{ "type":"structure", "required":[ "PolicyArn", "VersionId" ], "members":{ "PolicyArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" }, "VersionId":{ "shape":"policyVersionIdType", "documentation":"

Identifies the policy version to retrieve.

This parameter allows (per its regex pattern) a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.

" } } }, "GetPolicyVersionResponse":{ "type":"structure", "members":{ "PolicyVersion":{ "shape":"PolicyVersion", "documentation":"

A structure containing details about the policy version.

" } }, "documentation":"

Contains the response to a successful GetPolicyVersion request.

" }, "GetRolePolicyRequest":{ "type":"structure", "required":[ "RoleName", "PolicyName" ], "members":{ "RoleName":{ "shape":"roleNameType", "documentation":"

The name of the role associated with the policy.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyName":{ "shape":"policyNameType", "documentation":"

The name of the policy document to get.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "GetRolePolicyResponse":{ "type":"structure", "required":[ "RoleName", "PolicyName", "PolicyDocument" ], "members":{ "RoleName":{ "shape":"roleNameType", "documentation":"

The role the policy is associated with.

" }, "PolicyName":{ "shape":"policyNameType", "documentation":"

The name of the policy.

" }, "PolicyDocument":{ "shape":"policyDocumentType", "documentation":"

The policy document.

" } }, "documentation":"

Contains the response to a successful GetRolePolicy request.

" }, "GetRoleRequest":{ "type":"structure", "required":["RoleName"], "members":{ "RoleName":{ "shape":"roleNameType", "documentation":"

The name of the IAM role to get information about.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "GetRoleResponse":{ "type":"structure", "required":["Role"], "members":{ "Role":{ "shape":"Role", "documentation":"

A structure containing details about the IAM role.

" } }, "documentation":"

Contains the response to a successful GetRole request.

" }, "GetSAMLProviderRequest":{ "type":"structure", "required":["SAMLProviderArn"], "members":{ "SAMLProviderArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" } } }, "GetSAMLProviderResponse":{ "type":"structure", "members":{ "SAMLMetadataDocument":{ "shape":"SAMLMetadataDocumentType", "documentation":"

The XML metadata document that includes information about an identity provider.

" }, "CreateDate":{ "shape":"dateType", "documentation":"

The date and time when the SAML provider was created.

" }, "ValidUntil":{ "shape":"dateType", "documentation":"

The expiration date and time for the SAML provider.

" } }, "documentation":"

Contains the response to a successful GetSAMLProvider request.

" }, "GetSSHPublicKeyRequest":{ "type":"structure", "required":[ "UserName", "SSHPublicKeyId", "Encoding" ], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the IAM user associated with the SSH public key.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "SSHPublicKeyId":{ "shape":"publicKeyIdType", "documentation":"

The unique identifier for the SSH public key.

This parameter allows (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" }, "Encoding":{ "shape":"encodingType", "documentation":"

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

" } } }, "GetSSHPublicKeyResponse":{ "type":"structure", "members":{ "SSHPublicKey":{ "shape":"SSHPublicKey", "documentation":"

A structure containing details about the SSH public key.

" } }, "documentation":"

Contains the response to a successful GetSSHPublicKey request.

" }, "GetServerCertificateRequest":{ "type":"structure", "required":["ServerCertificateName"], "members":{ "ServerCertificateName":{ "shape":"serverCertificateNameType", "documentation":"

The name of the server certificate you want to retrieve information about.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "GetServerCertificateResponse":{ "type":"structure", "required":["ServerCertificate"], "members":{ "ServerCertificate":{ "shape":"ServerCertificate", "documentation":"

A structure containing details about the server certificate.

" } }, "documentation":"

Contains the response to a successful GetServerCertificate request.

" }, "GetUserPolicyRequest":{ "type":"structure", "required":[ "UserName", "PolicyName" ], "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the user who the policy is associated with.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyName":{ "shape":"policyNameType", "documentation":"

The name of the policy document to get.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "GetUserPolicyResponse":{ "type":"structure", "required":[ "UserName", "PolicyName", "PolicyDocument" ], "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The user the policy is associated with.

" }, "PolicyName":{ "shape":"policyNameType", "documentation":"

The name of the policy.

" }, "PolicyDocument":{ "shape":"policyDocumentType", "documentation":"

The policy document.

" } }, "documentation":"

Contains the response to a successful GetUserPolicy request.

" }, "GetUserRequest":{ "type":"structure", "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the user to get information about.

This parameter is optional. If it is not included, it defaults to the user making the request. This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "GetUserResponse":{ "type":"structure", "required":["User"], "members":{ "User":{ "shape":"User", "documentation":"

A structure containing details about the IAM user.

" } }, "documentation":"

Contains the response to a successful GetUser request.

" }, "Group":{ "type":"structure", "required":[ "Path", "GroupName", "GroupId", "Arn", "CreateDate" ], "members":{ "Path":{ "shape":"pathType", "documentation":"

The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.

" }, "GroupName":{ "shape":"groupNameType", "documentation":"

The friendly name that identifies the group.

" }, "GroupId":{ "shape":"idType", "documentation":"

The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.

" }, "Arn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.

" }, "CreateDate":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the group was created.

" } }, "documentation":"

Contains information about an IAM group entity.

This data type is used as a response element in the following actions:

" }, "GroupDetail":{ "type":"structure", "members":{ "Path":{ "shape":"pathType", "documentation":"

The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.

" }, "GroupName":{ "shape":"groupNameType", "documentation":"

The friendly name that identifies the group.

" }, "GroupId":{ "shape":"idType", "documentation":"

The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.

" }, "Arn":{"shape":"arnType"}, "CreateDate":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the group was created.

" }, "GroupPolicyList":{ "shape":"policyDetailListType", "documentation":"

A list of the inline policies embedded in the group.

" }, "AttachedManagedPolicies":{ "shape":"attachedPoliciesListType", "documentation":"

A list of the managed policies attached to the group.

" } }, "documentation":"

Contains information about an IAM group, including all of the group's policies.

This data type is used as a response element in the GetAccountAuthorizationDetails action.

" }, "InstanceProfile":{ "type":"structure", "required":[ "Path", "InstanceProfileName", "InstanceProfileId", "Arn", "CreateDate", "Roles" ], "members":{ "Path":{ "shape":"pathType", "documentation":"

The path to the instance profile. For more information about paths, see IAM Identifiers in the Using IAM guide.

" }, "InstanceProfileName":{ "shape":"instanceProfileNameType", "documentation":"

The name identifying the instance profile.

" }, "InstanceProfileId":{ "shape":"idType", "documentation":"

The stable and unique string identifying the instance profile. For more information about IDs, see IAM Identifiers in the Using IAM guide.

" }, "Arn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.

" }, "CreateDate":{ "shape":"dateType", "documentation":"

The date when the instance profile was created.

" }, "Roles":{ "shape":"roleListType", "documentation":"

The role associated with the instance profile.

" } }, "documentation":"

Contains information about an instance profile.

This data type is used as a response element in the following actions:

" }, "InvalidAuthenticationCodeException":{ "type":"structure", "members":{ "message":{"shape":"invalidAuthenticationCodeMessage"} }, "documentation":"

The request was rejected because the authentication code was not recognized. The error message describes the specific error.

", "error":{ "code":"InvalidAuthenticationCode", "httpStatusCode":403, "senderFault":true }, "exception":true }, "InvalidCertificateException":{ "type":"structure", "members":{ "message":{"shape":"invalidCertificateMessage"} }, "documentation":"

The request was rejected because the certificate is invalid.

", "error":{ "code":"InvalidCertificate", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidInputException":{ "type":"structure", "members":{ "message":{"shape":"invalidInputMessage"} }, "documentation":"

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

", "error":{ "code":"InvalidInput", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidPublicKeyException":{ "type":"structure", "members":{ "message":{"shape":"invalidPublicKeyMessage"} }, "documentation":"

The request was rejected because the public key is malformed or otherwise invalid.

", "error":{ "code":"InvalidPublicKey", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidUserTypeException":{ "type":"structure", "members":{ "message":{"shape":"invalidUserTypeMessage"} }, "documentation":"

The request was rejected because the type of user for the transaction was incorrect.

", "error":{ "code":"InvalidUserType", "httpStatusCode":400, "senderFault":true }, "exception":true }, "KeyPairMismatchException":{ "type":"structure", "members":{ "message":{"shape":"keyPairMismatchMessage"} }, "documentation":"

The request was rejected because the public key certificate and the private key do not match.

", "error":{ "code":"KeyPairMismatch", "httpStatusCode":400, "senderFault":true }, "exception":true }, "LimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"limitExceededMessage"} }, "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

", "error":{ "code":"LimitExceeded", "httpStatusCode":409, "senderFault":true }, "exception":true }, "LineNumber":{"type":"integer"}, "ListAccessKeysRequest":{ "type":"structure", "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the user.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListAccessKeysResponse":{ "type":"structure", "required":["AccessKeyMetadata"], "members":{ "AccessKeyMetadata":{ "shape":"accessKeyMetadataListType", "documentation":"

A list of objects containing metadata about the access keys.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListAccessKeys request.

" }, "ListAccountAliasesRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListAccountAliasesResponse":{ "type":"structure", "required":["AccountAliases"], "members":{ "AccountAliases":{ "shape":"accountAliasListType", "documentation":"

A list of aliases associated with the account. AWS supports only one alias per account.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListAccountAliases request.

" }, "ListAttachedGroupPoliciesRequest":{ "type":"structure", "required":["GroupName"], "members":{ "GroupName":{ "shape":"groupNameType", "documentation":"

The name (friendly name, not ARN) of the group to list attached policies for.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PathPrefix":{ "shape":"policyPathType", "documentation":"

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListAttachedGroupPoliciesResponse":{ "type":"structure", "members":{ "AttachedPolicies":{ "shape":"attachedPoliciesListType", "documentation":"

A list of the attached policies.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListAttachedGroupPolicies request.

" }, "ListAttachedRolePoliciesRequest":{ "type":"structure", "required":["RoleName"], "members":{ "RoleName":{ "shape":"roleNameType", "documentation":"

The name (friendly name, not ARN) of the role to list attached policies for.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PathPrefix":{ "shape":"policyPathType", "documentation":"

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListAttachedRolePoliciesResponse":{ "type":"structure", "members":{ "AttachedPolicies":{ "shape":"attachedPoliciesListType", "documentation":"

A list of the attached policies.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListAttachedRolePolicies request.

" }, "ListAttachedUserPoliciesRequest":{ "type":"structure", "required":["UserName"], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name (friendly name, not ARN) of the user to list attached policies for.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PathPrefix":{ "shape":"policyPathType", "documentation":"

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListAttachedUserPoliciesResponse":{ "type":"structure", "members":{ "AttachedPolicies":{ "shape":"attachedPoliciesListType", "documentation":"

A list of the attached policies.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListAttachedUserPolicies request.

" }, "ListEntitiesForPolicyRequest":{ "type":"structure", "required":["PolicyArn"], "members":{ "PolicyArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" }, "EntityFilter":{ "shape":"EntityType", "documentation":"

The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned. The argument for this parameter must be one of the valid values listed below.

" }, "PathPrefix":{ "shape":"pathType", "documentation":"

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListEntitiesForPolicyResponse":{ "type":"structure", "members":{ "PolicyGroups":{ "shape":"PolicyGroupListType", "documentation":"

A list of IAM groups that the policy is attached to.

" }, "PolicyUsers":{ "shape":"PolicyUserListType", "documentation":"

A list of IAM users that the policy is attached to.

" }, "PolicyRoles":{ "shape":"PolicyRoleListType", "documentation":"

A list of IAM roles that the policy is attached to.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListEntitiesForPolicy request.

" }, "ListGroupPoliciesRequest":{ "type":"structure", "required":["GroupName"], "members":{ "GroupName":{ "shape":"groupNameType", "documentation":"

The name of the group to list policies for.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListGroupPoliciesResponse":{ "type":"structure", "required":["PolicyNames"], "members":{ "PolicyNames":{ "shape":"policyNameListType", "documentation":"

A list of policy names.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListGroupPolicies request.

" }, "ListGroupsForUserRequest":{ "type":"structure", "required":["UserName"], "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the user to list groups for.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListGroupsForUserResponse":{ "type":"structure", "required":["Groups"], "members":{ "Groups":{ "shape":"groupListType", "documentation":"

A list of groups.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListGroupsForUser request.

" }, "ListGroupsRequest":{ "type":"structure", "members":{ "PathPrefix":{ "shape":"pathPrefixType", "documentation":"

The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListGroupsResponse":{ "type":"structure", "required":["Groups"], "members":{ "Groups":{ "shape":"groupListType", "documentation":"

A list of groups.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListGroups request.

" }, "ListInstanceProfilesForRoleRequest":{ "type":"structure", "required":["RoleName"], "members":{ "RoleName":{ "shape":"roleNameType", "documentation":"

The name of the role to list instance profiles for.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListInstanceProfilesForRoleResponse":{ "type":"structure", "required":["InstanceProfiles"], "members":{ "InstanceProfiles":{ "shape":"instanceProfileListType", "documentation":"

A list of instance profiles.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListInstanceProfilesForRole request.

" }, "ListInstanceProfilesRequest":{ "type":"structure", "members":{ "PathPrefix":{ "shape":"pathPrefixType", "documentation":"

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all instance profiles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles. This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListInstanceProfilesResponse":{ "type":"structure", "required":["InstanceProfiles"], "members":{ "InstanceProfiles":{ "shape":"instanceProfileListType", "documentation":"

A list of instance profiles.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListInstanceProfiles request.

" }, "ListMFADevicesRequest":{ "type":"structure", "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the user whose MFA devices you want to list.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListMFADevicesResponse":{ "type":"structure", "required":["MFADevices"], "members":{ "MFADevices":{ "shape":"mfaDeviceListType", "documentation":"

A list of MFA devices.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListMFADevices request.

" }, "ListOpenIDConnectProvidersRequest":{ "type":"structure", "members":{ } }, "ListOpenIDConnectProvidersResponse":{ "type":"structure", "members":{ "OpenIDConnectProviderList":{ "shape":"OpenIDConnectProviderListType", "documentation":"

The list of IAM OIDC provider resource objects defined in the AWS account.

" } }, "documentation":"

Contains the response to a successful ListOpenIDConnectProviders request.

" }, "ListPoliciesRequest":{ "type":"structure", "members":{ "Scope":{ "shape":"policyScopeType", "documentation":"

The scope to use for filtering the results.

To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS account, set Scope to Local.

This parameter is optional. If it is not included, or if it is set to All, all policies are returned.

" }, "OnlyAttached":{ "shape":"booleanType", "documentation":"

A flag to filter the results to only the attached policies.

When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

" }, "PathPrefix":{ "shape":"policyPathType", "documentation":"

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListPoliciesResponse":{ "type":"structure", "members":{ "Policies":{ "shape":"policyListType", "documentation":"

A list of policies.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListPolicies request.

" }, "ListPolicyVersionsRequest":{ "type":"structure", "required":["PolicyArn"], "members":{ "PolicyArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListPolicyVersionsResponse":{ "type":"structure", "members":{ "Versions":{ "shape":"policyDocumentVersionListType", "documentation":"

A list of policy versions.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListPolicyVersions request.

" }, "ListRolePoliciesRequest":{ "type":"structure", "required":["RoleName"], "members":{ "RoleName":{ "shape":"roleNameType", "documentation":"

The name of the role to list policies for.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListRolePoliciesResponse":{ "type":"structure", "required":["PolicyNames"], "members":{ "PolicyNames":{ "shape":"policyNameListType", "documentation":"

A list of policy names.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListRolePolicies request.

" }, "ListRolesRequest":{ "type":"structure", "members":{ "PathPrefix":{ "shape":"pathPrefixType", "documentation":"

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListRolesResponse":{ "type":"structure", "required":["Roles"], "members":{ "Roles":{ "shape":"roleListType", "documentation":"

A list of roles.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListRoles request.

" }, "ListSAMLProvidersRequest":{ "type":"structure", "members":{ } }, "ListSAMLProvidersResponse":{ "type":"structure", "members":{ "SAMLProviderList":{ "shape":"SAMLProviderListType", "documentation":"

The list of SAML provider resource objects defined in IAM for this AWS account.

" } }, "documentation":"

Contains the response to a successful ListSAMLProviders request.

" }, "ListSSHPublicKeysRequest":{ "type":"structure", "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the IAM user to list SSH public keys for. If none is specified, the UserName field is determined implicitly based on the AWS access key used to sign the request.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListSSHPublicKeysResponse":{ "type":"structure", "members":{ "SSHPublicKeys":{ "shape":"SSHPublicKeyListType", "documentation":"

A list of the SSH public keys assigned to IAM user.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListSSHPublicKeys request.

" }, "ListServerCertificatesRequest":{ "type":"structure", "members":{ "PathPrefix":{ "shape":"pathPrefixType", "documentation":"

The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates. This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListServerCertificatesResponse":{ "type":"structure", "required":["ServerCertificateMetadataList"], "members":{ "ServerCertificateMetadataList":{ "shape":"serverCertificateMetadataListType", "documentation":"

A list of server certificates.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListServerCertificates request.

" }, "ListServiceSpecificCredentialsRequest":{ "type":"structure", "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the user whose service-specific credentials you want information about. If this value is not specified then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "ServiceName":{ "shape":"serviceName", "documentation":"

Filters the returned results to only those for the specified AWS service. If not specified, then AWS returns service-specific credentials for all services.

" } } }, "ListServiceSpecificCredentialsResponse":{ "type":"structure", "members":{ "ServiceSpecificCredentials":{ "shape":"ServiceSpecificCredentialsListType", "documentation":"

A list of structures that each contain details about a service-specific credential.

" } } }, "ListSigningCertificatesRequest":{ "type":"structure", "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the IAM user whose signing certificates you want to examine.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListSigningCertificatesResponse":{ "type":"structure", "required":["Certificates"], "members":{ "Certificates":{ "shape":"certificateListType", "documentation":"

A list of the user's signing certificate information.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListSigningCertificates request.

" }, "ListUserPoliciesRequest":{ "type":"structure", "required":["UserName"], "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the user to list policies for.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListUserPoliciesResponse":{ "type":"structure", "required":["PolicyNames"], "members":{ "PolicyNames":{ "shape":"policyNameListType", "documentation":"

A list of policy names.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListUserPolicies request.

" }, "ListUsersRequest":{ "type":"structure", "members":{ "PathPrefix":{ "shape":"pathPrefixType", "documentation":"

The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names. This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListUsersResponse":{ "type":"structure", "required":["Users"], "members":{ "Users":{ "shape":"userListType", "documentation":"

A list of users.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListUsers request.

" }, "ListVirtualMFADevicesRequest":{ "type":"structure", "members":{ "AssignmentStatus":{ "shape":"assignmentStatusType", "documentation":"

The status (Unassigned or Assigned) of the devices to list. If you do not specify an AssignmentStatus, the action defaults to Any which lists both assigned and unassigned virtual MFA devices.

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" } } }, "ListVirtualMFADevicesResponse":{ "type":"structure", "required":["VirtualMFADevices"], "members":{ "VirtualMFADevices":{ "shape":"virtualMFADeviceListType", "documentation":"

The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful ListVirtualMFADevices request.

" }, "LoginProfile":{ "type":"structure", "required":[ "UserName", "CreateDate" ], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the user, which can be used for signing in to the AWS Management Console.

" }, "CreateDate":{ "shape":"dateType", "documentation":"

The date when the password for the user was created.

" }, "PasswordResetRequired":{ "shape":"booleanType", "documentation":"

Specifies whether the user is required to set a new password on next sign-in.

" } }, "documentation":"

Contains the user name and password create date for a user.

This data type is used as a response element in the CreateLoginProfile and GetLoginProfile actions.

" }, "MFADevice":{ "type":"structure", "required":[ "UserName", "SerialNumber", "EnableDate" ], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The user with whom the MFA device is associated.

" }, "SerialNumber":{ "shape":"serialNumberType", "documentation":"

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

" }, "EnableDate":{ "shape":"dateType", "documentation":"

The date when the MFA device was enabled for the user.

" } }, "documentation":"

Contains information about an MFA device.

This data type is used as a response element in the ListMFADevices action.

" }, "MalformedCertificateException":{ "type":"structure", "members":{ "message":{"shape":"malformedCertificateMessage"} }, "documentation":"

The request was rejected because the certificate was malformed or expired. The error message describes the specific error.

", "error":{ "code":"MalformedCertificate", "httpStatusCode":400, "senderFault":true }, "exception":true }, "MalformedPolicyDocumentException":{ "type":"structure", "members":{ "message":{"shape":"malformedPolicyDocumentMessage"} }, "documentation":"

The request was rejected because the policy document was malformed. The error message describes the specific error.

", "error":{ "code":"MalformedPolicyDocument", "httpStatusCode":400, "senderFault":true }, "exception":true }, "ManagedPolicyDetail":{ "type":"structure", "members":{ "PolicyName":{ "shape":"policyNameType", "documentation":"

The friendly name (not ARN) identifying the policy.

" }, "PolicyId":{ "shape":"idType", "documentation":"

The stable and unique string identifying the policy.

For more information about IDs, see IAM Identifiers in the Using IAM guide.

" }, "Arn":{"shape":"arnType"}, "Path":{ "shape":"policyPathType", "documentation":"

The path to the policy.

For more information about paths, see IAM Identifiers in the Using IAM guide.

" }, "DefaultVersionId":{ "shape":"policyVersionIdType", "documentation":"

The identifier for the version of the policy that is set as the default (operative) version.

For more information about policy versions, see Versioning for Managed Policies in the Using IAM guide.

" }, "AttachmentCount":{ "shape":"attachmentCountType", "documentation":"

The number of principal entities (users, groups, and roles) that the policy is attached to.

" }, "IsAttachable":{ "shape":"booleanType", "documentation":"

Specifies whether the policy can be attached to an IAM user, group, or role.

" }, "Description":{ "shape":"policyDescriptionType", "documentation":"

A friendly description of the policy.

" }, "CreateDate":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the policy was created.

" }, "UpdateDate":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

" }, "PolicyVersionList":{ "shape":"policyDocumentVersionListType", "documentation":"

A list containing information about the versions of the policy.

" } }, "documentation":"

Contains information about a managed policy, including the policy's ARN, versions, and the number of principal entities (users, groups, and roles) that the policy is attached to.

This data type is used as a response element in the GetAccountAuthorizationDetails action.

For more information about managed policies, see Managed Policies and Inline Policies in the Using IAM guide.

" }, "ManagedPolicyDetailListType":{ "type":"list", "member":{"shape":"ManagedPolicyDetail"} }, "NoSuchEntityException":{ "type":"structure", "members":{ "message":{"shape":"noSuchEntityMessage"} }, "documentation":"

The request was rejected because it referenced an entity that does not exist. The error message describes the entity.

", "error":{ "code":"NoSuchEntity", "httpStatusCode":404, "senderFault":true }, "exception":true }, "OpenIDConnectProviderListEntry":{ "type":"structure", "members":{ "Arn":{"shape":"arnType"} }, "documentation":"

Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider.

" }, "OpenIDConnectProviderListType":{ "type":"list", "member":{"shape":"OpenIDConnectProviderListEntry"}, "documentation":"

Contains a list of IAM OpenID Connect providers.

" }, "OpenIDConnectProviderUrlType":{ "type":"string", "documentation":"

Contains a URL that specifies the endpoint for an OpenID Connect provider.

", "max":255, "min":1 }, "PasswordPolicy":{ "type":"structure", "members":{ "MinimumPasswordLength":{ "shape":"minimumPasswordLengthType", "documentation":"

Minimum length to require for IAM user passwords.

" }, "RequireSymbols":{ "shape":"booleanType", "documentation":"

Specifies whether to require symbols for IAM user passwords.

" }, "RequireNumbers":{ "shape":"booleanType", "documentation":"

Specifies whether to require numbers for IAM user passwords.

" }, "RequireUppercaseCharacters":{ "shape":"booleanType", "documentation":"

Specifies whether to require uppercase characters for IAM user passwords.

" }, "RequireLowercaseCharacters":{ "shape":"booleanType", "documentation":"

Specifies whether to require lowercase characters for IAM user passwords.

" }, "AllowUsersToChangePassword":{ "shape":"booleanType", "documentation":"

Specifies whether IAM users are allowed to change their own password.

" }, "ExpirePasswords":{ "shape":"booleanType", "documentation":"

Indicates whether passwords in the account expire. Returns true if MaxPasswordAge is contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.

" }, "MaxPasswordAge":{ "shape":"maxPasswordAgeType", "documentation":"

The number of days that an IAM user password is valid.

" }, "PasswordReusePrevention":{ "shape":"passwordReusePreventionType", "documentation":"

Specifies the number of previous passwords that IAM users are prevented from reusing.

" }, "HardExpiry":{ "shape":"booleanObjectType", "documentation":"

Specifies whether IAM users are prevented from setting a new password after their password has expired.

" } }, "documentation":"

Contains information about the account password policy.

This data type is used as a response element in the GetAccountPasswordPolicy action.

" }, "PasswordPolicyViolationException":{ "type":"structure", "members":{ "message":{"shape":"passwordPolicyViolationMessage"} }, "documentation":"

The request was rejected because the provided password did not meet the requirements imposed by the account password policy.

", "error":{ "code":"PasswordPolicyViolation", "httpStatusCode":400, "senderFault":true }, "exception":true }, "Policy":{ "type":"structure", "members":{ "PolicyName":{ "shape":"policyNameType", "documentation":"

The friendly name (not ARN) identifying the policy.

" }, "PolicyId":{ "shape":"idType", "documentation":"

The stable and unique string identifying the policy.

For more information about IDs, see IAM Identifiers in the Using IAM guide.

" }, "Arn":{"shape":"arnType"}, "Path":{ "shape":"policyPathType", "documentation":"

The path to the policy.

For more information about paths, see IAM Identifiers in the Using IAM guide.

" }, "DefaultVersionId":{ "shape":"policyVersionIdType", "documentation":"

The identifier for the version of the policy that is set as the default version.

" }, "AttachmentCount":{ "shape":"attachmentCountType", "documentation":"

The number of entities (users, groups, and roles) that the policy is attached to.

" }, "IsAttachable":{ "shape":"booleanType", "documentation":"

Specifies whether the policy can be attached to an IAM user, group, or role.

" }, "Description":{ "shape":"policyDescriptionType", "documentation":"

A friendly description of the policy.

This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

" }, "CreateDate":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the policy was created.

" }, "UpdateDate":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

" } }, "documentation":"

Contains information about a managed policy.

This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies actions.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

" }, "PolicyDetail":{ "type":"structure", "members":{ "PolicyName":{ "shape":"policyNameType", "documentation":"

The name of the policy.

" }, "PolicyDocument":{ "shape":"policyDocumentType", "documentation":"

The policy document.

" } }, "documentation":"

Contains information about an IAM policy, including the policy document.

This data type is used as a response element in the GetAccountAuthorizationDetails action.

" }, "PolicyEvaluationDecisionType":{ "type":"string", "enum":[ "allowed", "explicitDeny", "implicitDeny" ] }, "PolicyEvaluationException":{ "type":"structure", "members":{ "message":{"shape":"policyEvaluationErrorMessage"} }, "documentation":"

The request failed because a provided policy could not be successfully evaluated. An additional detail message indicates the source of the failure.

", "error":{ "code":"PolicyEvaluation", "httpStatusCode":500 }, "exception":true }, "PolicyGroup":{ "type":"structure", "members":{ "GroupName":{ "shape":"groupNameType", "documentation":"

The name (friendly name, not ARN) identifying the group.

" }, "GroupId":{ "shape":"idType", "documentation":"

The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the IAM User Guide.

" } }, "documentation":"

Contains information about a group that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy action.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

" }, "PolicyGroupListType":{ "type":"list", "member":{"shape":"PolicyGroup"} }, "PolicyIdentifierType":{"type":"string"}, "PolicyRole":{ "type":"structure", "members":{ "RoleName":{ "shape":"roleNameType", "documentation":"

The name (friendly name, not ARN) identifying the role.

" }, "RoleId":{ "shape":"idType", "documentation":"

The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the IAM User Guide.

" } }, "documentation":"

Contains information about a role that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy action.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

" }, "PolicyRoleListType":{ "type":"list", "member":{"shape":"PolicyRole"} }, "PolicySourceType":{ "type":"string", "enum":[ "user", "group", "role", "aws-managed", "user-managed", "resource", "none" ] }, "PolicyUser":{ "type":"structure", "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name (friendly name, not ARN) identifying the user.

" }, "UserId":{ "shape":"idType", "documentation":"

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM User Guide.

" } }, "documentation":"

Contains information about a user that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy action.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

" }, "PolicyUserListType":{ "type":"list", "member":{"shape":"PolicyUser"} }, "PolicyVersion":{ "type":"structure", "members":{ "Document":{ "shape":"policyDocumentType", "documentation":"

The policy document.

The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.

" }, "VersionId":{ "shape":"policyVersionIdType", "documentation":"

The identifier for the policy version.

Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.

" }, "IsDefaultVersion":{ "shape":"booleanType", "documentation":"

Specifies whether the policy version is set as the policy's default version.

" }, "CreateDate":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the policy version was created.

" } }, "documentation":"

Contains information about a version of a managed policy.

This data type is used as a response element in the CreatePolicyVersion, GetPolicyVersion, ListPolicyVersions, and GetAccountAuthorizationDetails actions.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

" }, "Position":{ "type":"structure", "members":{ "Line":{ "shape":"LineNumber", "documentation":"

The line containing the specified position in the document.

" }, "Column":{ "shape":"ColumnNumber", "documentation":"

The column in the line containing the specified position in the document.

" } }, "documentation":"

Contains the row and column of a location of a Statement element in a policy document.

This data type is used as a member of the Statement type.

" }, "PutGroupPolicyRequest":{ "type":"structure", "required":[ "GroupName", "PolicyName", "PolicyDocument" ], "members":{ "GroupName":{ "shape":"groupNameType", "documentation":"

The name of the group to associate the policy with.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyName":{ "shape":"policyNameType", "documentation":"

The name of the policy document.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyDocument":{ "shape":"policyDocumentType", "documentation":"

The policy document.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" } } }, "PutRolePolicyRequest":{ "type":"structure", "required":[ "RoleName", "PolicyName", "PolicyDocument" ], "members":{ "RoleName":{ "shape":"roleNameType", "documentation":"

The name of the role to associate the policy with.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyName":{ "shape":"policyNameType", "documentation":"

The name of the policy document.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyDocument":{ "shape":"policyDocumentType", "documentation":"

The policy document.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" } } }, "PutUserPolicyRequest":{ "type":"structure", "required":[ "UserName", "PolicyName", "PolicyDocument" ], "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the user to associate the policy with.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyName":{ "shape":"policyNameType", "documentation":"

The name of the policy document.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyDocument":{ "shape":"policyDocumentType", "documentation":"

The policy document.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" } } }, "RemoveClientIDFromOpenIDConnectProviderRequest":{ "type":"structure", "required":[ "OpenIDConnectProviderArn", "ClientID" ], "members":{ "OpenIDConnectProviderArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" }, "ClientID":{ "shape":"clientIDType", "documentation":"

The client ID (also known as audience) to remove from the IAM OIDC provider resource. For more information about client IDs, see CreateOpenIDConnectProvider.

" } } }, "RemoveRoleFromInstanceProfileRequest":{ "type":"structure", "required":[ "InstanceProfileName", "RoleName" ], "members":{ "InstanceProfileName":{ "shape":"instanceProfileNameType", "documentation":"

The name of the instance profile to update.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "RoleName":{ "shape":"roleNameType", "documentation":"

The name of the role to remove.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "RemoveUserFromGroupRequest":{ "type":"structure", "required":[ "GroupName", "UserName" ], "members":{ "GroupName":{ "shape":"groupNameType", "documentation":"

The name of the group to update.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the user to remove.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "ReportContentType":{"type":"blob"}, "ReportFormatType":{ "type":"string", "enum":["text/csv"] }, "ReportStateDescriptionType":{"type":"string"}, "ReportStateType":{ "type":"string", "enum":[ "STARTED", "INPROGRESS", "COMPLETE" ] }, "ResetServiceSpecificCredentialRequest":{ "type":"structure", "required":["ServiceSpecificCredentialId"], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "ServiceSpecificCredentialId":{ "shape":"serviceSpecificCredentialId", "documentation":"

The unique identifier of the service-specific credential.

This parameter allows (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" } } }, "ResetServiceSpecificCredentialResponse":{ "type":"structure", "members":{ "ServiceSpecificCredential":{ "shape":"ServiceSpecificCredential", "documentation":"

A structure with details about the updated service-specific credential, including the new password.

This is the only time that you can access the password. You cannot recover the password later, but you can reset it again.

" } } }, "ResourceHandlingOptionType":{ "type":"string", "max":64, "min":1 }, "ResourceNameListType":{ "type":"list", "member":{"shape":"ResourceNameType"} }, "ResourceNameType":{ "type":"string", "max":2048, "min":1 }, "ResourceSpecificResult":{ "type":"structure", "required":[ "EvalResourceName", "EvalResourceDecision" ], "members":{ "EvalResourceName":{ "shape":"ResourceNameType", "documentation":"

The name of the simulated resource, in Amazon Resource Name (ARN) format.

" }, "EvalResourceDecision":{ "shape":"PolicyEvaluationDecisionType", "documentation":"

The result of the simulation of the simulated API action on the resource specified in EvalResourceName.

" }, "MatchedStatements":{ "shape":"StatementListType", "documentation":"

A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the action on the resource, if any statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.

" }, "MissingContextValues":{ "shape":"ContextKeyNamesResultListType", "documentation":"

A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when a list of ARNs is included in the ResourceArns parameter instead of \"*\". If you do not specify individual resources, by setting ResourceArns to \"*\" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

" }, "EvalDecisionDetails":{ "shape":"EvalDecisionDetailsType", "documentation":"

Additional details about the results of the evaluation decision. When there are both IAM policies and resource policies, this parameter explains how each set of policies contributes to the final evaluation decision. When simulating cross-account access to a resource, both the resource-based policy and the caller's IAM policy must grant access.

" } }, "documentation":"

Contains the result of the simulation of a single API action call on a single resource.

This data type is used by a member of the EvaluationResult data type.

" }, "ResourceSpecificResultListType":{ "type":"list", "member":{"shape":"ResourceSpecificResult"} }, "ResyncMFADeviceRequest":{ "type":"structure", "required":[ "UserName", "SerialNumber", "AuthenticationCode1", "AuthenticationCode2" ], "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the user whose MFA device you want to resynchronize.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "SerialNumber":{ "shape":"serialNumberType", "documentation":"

Serial number that uniquely identifies the MFA device.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "AuthenticationCode1":{ "shape":"authenticationCodeType", "documentation":"

An authentication code emitted by the device.

The format for this parameter is a sequence of six digits.

" }, "AuthenticationCode2":{ "shape":"authenticationCodeType", "documentation":"

A subsequent authentication code emitted by the device.

The format for this parameter is a sequence of six digits.

" } } }, "Role":{ "type":"structure", "required":[ "Path", "RoleName", "RoleId", "Arn", "CreateDate" ], "members":{ "Path":{ "shape":"pathType", "documentation":"

The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.

" }, "RoleName":{ "shape":"roleNameType", "documentation":"

The friendly name that identifies the role.

" }, "RoleId":{ "shape":"idType", "documentation":"

The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.

" }, "Arn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.

" }, "CreateDate":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the role was created.

" }, "AssumeRolePolicyDocument":{ "shape":"policyDocumentType", "documentation":"

The policy that grants an entity permission to assume the role.

" } }, "documentation":"

Contains information about an IAM role.

This data type is used as a response element in the following actions:

" }, "RoleDetail":{ "type":"structure", "members":{ "Path":{ "shape":"pathType", "documentation":"

The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.

" }, "RoleName":{ "shape":"roleNameType", "documentation":"

The friendly name that identifies the role.

" }, "RoleId":{ "shape":"idType", "documentation":"

The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.

" }, "Arn":{"shape":"arnType"}, "CreateDate":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the role was created.

" }, "AssumeRolePolicyDocument":{ "shape":"policyDocumentType", "documentation":"

The trust policy that grants permission to assume the role.

" }, "InstanceProfileList":{ "shape":"instanceProfileListType", "documentation":"

A list of instance profiles that contain this role.

" }, "RolePolicyList":{ "shape":"policyDetailListType", "documentation":"

A list of inline policies embedded in the role. These policies are the role's access (permissions) policies.

" }, "AttachedManagedPolicies":{ "shape":"attachedPoliciesListType", "documentation":"

A list of managed policies attached to the role. These policies are the role's access (permissions) policies.

" } }, "documentation":"

Contains information about an IAM role, including all of the role's policies.

This data type is used as a response element in the GetAccountAuthorizationDetails action.

" }, "SAMLMetadataDocumentType":{ "type":"string", "max":10000000, "min":1000 }, "SAMLProviderListEntry":{ "type":"structure", "members":{ "Arn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the SAML provider.

" }, "ValidUntil":{ "shape":"dateType", "documentation":"

The expiration date and time for the SAML provider.

" }, "CreateDate":{ "shape":"dateType", "documentation":"

The date and time when the SAML provider was created.

" } }, "documentation":"

Contains the list of SAML providers for this account.

" }, "SAMLProviderListType":{ "type":"list", "member":{"shape":"SAMLProviderListEntry"} }, "SAMLProviderNameType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w._-]+" }, "SSHPublicKey":{ "type":"structure", "required":[ "UserName", "SSHPublicKeyId", "Fingerprint", "SSHPublicKeyBody", "Status" ], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the IAM user associated with the SSH public key.

" }, "SSHPublicKeyId":{ "shape":"publicKeyIdType", "documentation":"

The unique identifier for the SSH public key.

" }, "Fingerprint":{ "shape":"publicKeyFingerprintType", "documentation":"

The MD5 message digest of the SSH public key.

" }, "SSHPublicKeyBody":{ "shape":"publicKeyMaterialType", "documentation":"

The SSH public key.

" }, "Status":{ "shape":"statusType", "documentation":"

The status of the SSH public key. Active means the key can be used for authentication with an AWS CodeCommit repository. Inactive means the key cannot be used.

" }, "UploadDate":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.

" } }, "documentation":"

Contains information about an SSH public key.

This data type is used as a response element in the GetSSHPublicKey and UploadSSHPublicKey actions.

" }, "SSHPublicKeyListType":{ "type":"list", "member":{"shape":"SSHPublicKeyMetadata"} }, "SSHPublicKeyMetadata":{ "type":"structure", "required":[ "UserName", "SSHPublicKeyId", "Status", "UploadDate" ], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the IAM user associated with the SSH public key.

" }, "SSHPublicKeyId":{ "shape":"publicKeyIdType", "documentation":"

The unique identifier for the SSH public key.

" }, "Status":{ "shape":"statusType", "documentation":"

The status of the SSH public key. Active means the key can be used for authentication with an AWS CodeCommit repository. Inactive means the key cannot be used.

" }, "UploadDate":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.

" } }, "documentation":"

Contains information about an SSH public key, without the key's body or fingerprint.

This data type is used as a response element in the ListSSHPublicKeys action.

" }, "ServerCertificate":{ "type":"structure", "required":[ "ServerCertificateMetadata", "CertificateBody" ], "members":{ "ServerCertificateMetadata":{ "shape":"ServerCertificateMetadata", "documentation":"

The meta information of the server certificate, such as its name, path, ID, and ARN.

" }, "CertificateBody":{ "shape":"certificateBodyType", "documentation":"

The contents of the public key certificate.

" }, "CertificateChain":{ "shape":"certificateChainType", "documentation":"

The contents of the public key certificate chain.

" } }, "documentation":"

Contains information about a server certificate.

This data type is used as a response element in the GetServerCertificate action.

" }, "ServerCertificateMetadata":{ "type":"structure", "required":[ "Path", "ServerCertificateName", "ServerCertificateId", "Arn" ], "members":{ "Path":{ "shape":"pathType", "documentation":"

The path to the server certificate. For more information about paths, see IAM Identifiers in the Using IAM guide.

" }, "ServerCertificateName":{ "shape":"serverCertificateNameType", "documentation":"

The name that identifies the server certificate.

" }, "ServerCertificateId":{ "shape":"idType", "documentation":"

The stable and unique string identifying the server certificate. For more information about IDs, see IAM Identifiers in the Using IAM guide.

" }, "Arn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.

" }, "UploadDate":{ "shape":"dateType", "documentation":"

The date when the server certificate was uploaded.

" }, "Expiration":{ "shape":"dateType", "documentation":"

The date on which the certificate is set to expire.

" } }, "documentation":"

Contains information about a server certificate without its certificate body, certificate chain, and private key.

This data type is used as a response element in the UploadServerCertificate and ListServerCertificates actions.

" }, "ServiceFailureException":{ "type":"structure", "members":{ "message":{"shape":"serviceFailureExceptionMessage"} }, "documentation":"

The request processing has failed because of an unknown error, exception or failure.

", "error":{ "code":"ServiceFailure", "httpStatusCode":500 }, "exception":true }, "ServiceNotSupportedException":{ "type":"structure", "members":{ "message":{"shape":"serviceNotSupportedMessage"} }, "documentation":"

The specified service does not support service-specific credentials.

", "error":{ "code":"NotSupportedService", "httpStatusCode":404, "senderFault":true }, "exception":true }, "ServiceSpecificCredential":{ "type":"structure", "required":[ "CreateDate", "ServiceName", "ServiceUserName", "ServicePassword", "ServiceSpecificCredentialId", "UserName", "Status" ], "members":{ "CreateDate":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the service-specific credential were created.

" }, "ServiceName":{ "shape":"serviceName", "documentation":"

The name of the service associated with the service-specific credential.

" }, "ServiceUserName":{ "shape":"serviceUserName", "documentation":"

The generated user name for the service-specific credential. This value is generated by combining the IAM user's name combined with the ID number of the AWS account, as in jane-at-123456789012, for example. This value cannot be configured by the user.

" }, "ServicePassword":{ "shape":"servicePassword", "documentation":"

The generated password for the service-specific credential.

" }, "ServiceSpecificCredentialId":{ "shape":"serviceSpecificCredentialId", "documentation":"

The unique identifier for the service-specific credential.

" }, "UserName":{ "shape":"userNameType", "documentation":"

The name of the IAM user associated with the service-specific credential.

" }, "Status":{ "shape":"statusType", "documentation":"

The status of the service-specific credential. Active means the key is valid for API calls, while Inactive means it is not.

" } }, "documentation":"

Contains the details of a service specific credential.

" }, "ServiceSpecificCredentialMetadata":{ "type":"structure", "required":[ "UserName", "Status", "ServiceUserName", "CreateDate", "ServiceSpecificCredentialId", "ServiceName" ], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the IAM user associated with the service-specific credential.

" }, "Status":{ "shape":"statusType", "documentation":"

The status of the service-specific credential. Active means the key is valid for API calls, while Inactive means it is not.

" }, "ServiceUserName":{ "shape":"serviceUserName", "documentation":"

The generated user name for the service-specific credential.

" }, "CreateDate":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the service-specific credential were created.

" }, "ServiceSpecificCredentialId":{ "shape":"serviceSpecificCredentialId", "documentation":"

The unique identifier for the service-specific credential.

" }, "ServiceName":{ "shape":"serviceName", "documentation":"

The name of the service associated with the service-specific credential.

" } }, "documentation":"

Contains additional details about a service-specific credential.

" }, "ServiceSpecificCredentialsListType":{ "type":"list", "member":{"shape":"ServiceSpecificCredentialMetadata"} }, "SetDefaultPolicyVersionRequest":{ "type":"structure", "required":[ "PolicyArn", "VersionId" ], "members":{ "PolicyArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the IAM policy whose default version you want to set.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" }, "VersionId":{ "shape":"policyVersionIdType", "documentation":"

The version of the policy to set as the default (operative) version.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

" } } }, "SigningCertificate":{ "type":"structure", "required":[ "UserName", "CertificateId", "CertificateBody", "Status" ], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the user the signing certificate is associated with.

" }, "CertificateId":{ "shape":"certificateIdType", "documentation":"

The ID for the signing certificate.

" }, "CertificateBody":{ "shape":"certificateBodyType", "documentation":"

The contents of the signing certificate.

" }, "Status":{ "shape":"statusType", "documentation":"

The status of the signing certificate. Active means the key is valid for API calls, while Inactive means it is not.

" }, "UploadDate":{ "shape":"dateType", "documentation":"

The date when the signing certificate was uploaded.

" } }, "documentation":"

Contains information about an X.509 signing certificate.

This data type is used as a response element in the UploadSigningCertificate and ListSigningCertificates actions.

" }, "SimulateCustomPolicyRequest":{ "type":"structure", "required":[ "PolicyInputList", "ActionNames" ], "members":{ "PolicyInputList":{ "shape":"SimulationPolicyListType", "documentation":"

A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be \"scope-down\" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole APIs to restrict what a user can do while using the temporary credentials.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" }, "ActionNames":{ "shape":"ActionNameListType", "documentation":"

A list of names of API actions to evaluate in the simulation. Each action is evaluated against each resource. Each action must include the service identifier, such as iam:CreateUser.

" }, "ResourceArns":{ "shape":"ResourceNameListType", "documentation":"

A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" }, "ResourcePolicy":{ "shape":"policyDocumentType", "documentation":"

A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" }, "ResourceOwner":{ "shape":"ResourceNameType", "documentation":"

An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

" }, "CallerArn":{ "shape":"ResourceNameType", "documentation":"

The ARN of the IAM user that you want to use as the simulated caller of the APIs. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy.

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

" }, "ContextEntries":{ "shape":"ContextEntryListType", "documentation":"

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.

" }, "ResourceHandlingOption":{ "shape":"ResourceHandlingOptionType", "documentation":"

Specifies the type of simulation to run. Different APIs that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the AWS EC2 User Guide.

  • EC2-Classic-InstanceStore

    instance, image, security-group

  • EC2-Classic-EBS

    instance, image, security-group, volume

  • EC2-VPC-InstanceStore

    instance, image, security-group, network-interface

  • EC2-VPC-InstanceStore-Subnet

    instance, image, security-group, network-interface, subnet

  • EC2-VPC-EBS

    instance, image, security-group, network-interface, volume

  • EC2-VPC-EBS-Subnet

    instance, image, security-group, network-interface, subnet, volume

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" } } }, "SimulatePolicyResponse":{ "type":"structure", "members":{ "EvaluationResults":{ "shape":"EvaluationResultsListType", "documentation":"

The results of the simulation.

" }, "IsTruncated":{ "shape":"booleanType", "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all of your results.

" }, "Marker":{ "shape":"markerType", "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" } }, "documentation":"

Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request.

" }, "SimulatePrincipalPolicyRequest":{ "type":"structure", "required":[ "PolicySourceArn", "ActionNames" ], "members":{ "PolicySourceArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" }, "PolicyInputList":{ "shape":"SimulationPolicyListType", "documentation":"

An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" }, "ActionNames":{ "shape":"ActionNameListType", "documentation":"

A list of names of API actions to evaluate in the simulation. Each action is evaluated for each resource. Each action must include the service identifier, such as iam:CreateUser.

" }, "ResourceArns":{ "shape":"ResourceNameListType", "documentation":"

A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" }, "ResourcePolicy":{ "shape":"policyDocumentType", "documentation":"

A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" }, "ResourceOwner":{ "shape":"ResourceNameType", "documentation":"

An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN, such as an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

" }, "CallerArn":{ "shape":"ResourceNameType", "documentation":"

The ARN of the IAM user that you want to specify as the simulated caller of the APIs. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the APIs as Bob, as if Bob had David's policies.

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" }, "ContextEntries":{ "shape":"ContextEntryListType", "documentation":"

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.

" }, "ResourceHandlingOption":{ "shape":"ResourceHandlingOptionType", "documentation":"

Specifies the type of simulation to run. Different APIs that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the AWS EC2 User Guide.

  • EC2-Classic-InstanceStore

    instance, image, security-group

  • EC2-Classic-EBS

    instance, image, security-group, volume

  • EC2-VPC-InstanceStore

    instance, image, security-group, network-interface

  • EC2-VPC-InstanceStore-Subnet

    instance, image, security-group, network-interface, subnet

  • EC2-VPC-EBS

    instance, image, security-group, network-interface, volume

  • EC2-VPC-EBS-Subnet

    instance, image, security-group, network-interface, subnet, volume

" }, "MaxItems":{ "shape":"maxItemsType", "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" }, "Marker":{ "shape":"markerType", "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" } } }, "SimulationPolicyListType":{ "type":"list", "member":{"shape":"policyDocumentType"} }, "Statement":{ "type":"structure", "members":{ "SourcePolicyId":{ "shape":"PolicyIdentifierType", "documentation":"

The identifier of the policy that was provided as an input.

" }, "SourcePolicyType":{ "shape":"PolicySourceType", "documentation":"

The type of the policy.

" }, "StartPosition":{ "shape":"Position", "documentation":"

The row and column of the beginning of the Statement in an IAM policy.

" }, "EndPosition":{ "shape":"Position", "documentation":"

The row and column of the end of a Statement in an IAM policy.

" } }, "documentation":"

Contains a reference to a Statement element in a policy document that determines the result of the simulation.

This data type is used by the MatchedStatements member of the EvaluationResult type.

" }, "StatementListType":{ "type":"list", "member":{"shape":"Statement"} }, "UnrecognizedPublicKeyEncodingException":{ "type":"structure", "members":{ "message":{"shape":"unrecognizedPublicKeyEncodingMessage"} }, "documentation":"

The request was rejected because the public key encoding format is unsupported or unrecognized.

", "error":{ "code":"UnrecognizedPublicKeyEncoding", "httpStatusCode":400, "senderFault":true }, "exception":true }, "UpdateAccessKeyRequest":{ "type":"structure", "required":[ "AccessKeyId", "Status" ], "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the user whose key you want to update.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "AccessKeyId":{ "shape":"accessKeyIdType", "documentation":"

The access key ID of the secret access key you want to update.

This parameter allows (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" }, "Status":{ "shape":"statusType", "documentation":"

The status you want to assign to the secret access key. Active means the key can be used for API calls to AWS, while Inactive means the key cannot be used.

" } } }, "UpdateAccountPasswordPolicyRequest":{ "type":"structure", "members":{ "MinimumPasswordLength":{ "shape":"minimumPasswordLengthType", "documentation":"

The minimum number of characters allowed in an IAM user password.

Default value: 6

" }, "RequireSymbols":{ "shape":"booleanType", "documentation":"

Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:

! @ # $ % ^ &amp; * ( ) _ + - = [ ] { } | '

Default value: false

" }, "RequireNumbers":{ "shape":"booleanType", "documentation":"

Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).

Default value: false

" }, "RequireUppercaseCharacters":{ "shape":"booleanType", "documentation":"

Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).

Default value: false

" }, "RequireLowercaseCharacters":{ "shape":"booleanType", "documentation":"

Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).

Default value: false

" }, "AllowUsersToChangePassword":{ "shape":"booleanType", "documentation":"

Allows all IAM users in your account to use the AWS Management Console to change their own passwords. For more information, see Letting IAM Users Change Their Own Passwords in the IAM User Guide.

Default value: false

" }, "MaxPasswordAge":{ "shape":"maxPasswordAgeType", "documentation":"

The number of days that an IAM user password is valid. The default value of 0 means IAM user passwords never expire.

Default value: 0

" }, "PasswordReusePrevention":{ "shape":"passwordReusePreventionType", "documentation":"

Specifies the number of previous passwords that IAM users are prevented from reusing. The default value of 0 means IAM users are not prevented from reusing previous passwords.

Default value: 0

" }, "HardExpiry":{ "shape":"booleanObjectType", "documentation":"

Prevents IAM users from setting a new password after their password has expired.

Default value: false

" } } }, "UpdateAssumeRolePolicyRequest":{ "type":"structure", "required":[ "RoleName", "PolicyDocument" ], "members":{ "RoleName":{ "shape":"roleNameType", "documentation":"

The name of the role to update with the new policy.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "PolicyDocument":{ "shape":"policyDocumentType", "documentation":"

The policy that grants an entity permission to assume the role.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" } } }, "UpdateGroupRequest":{ "type":"structure", "required":["GroupName"], "members":{ "GroupName":{ "shape":"groupNameType", "documentation":"

Name of the IAM group to update. If you're changing the name of the group, this is the original name.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "NewPath":{ "shape":"pathType", "documentation":"

New path for the IAM group. Only include this if changing the group's path.

This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "NewGroupName":{ "shape":"groupNameType", "documentation":"

New name for the IAM group. Only include this if changing the group's name.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "UpdateLoginProfileRequest":{ "type":"structure", "required":["UserName"], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the user whose password you want to update.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "Password":{ "shape":"passwordType", "documentation":"

The new password for the specified IAM user.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D). However, the format can be further restricted by the account administrator by setting a password policy on the AWS account. For more information, see UpdateAccountPasswordPolicy.

" }, "PasswordResetRequired":{ "shape":"booleanObjectType", "documentation":"

Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in.

" } } }, "UpdateOpenIDConnectProviderThumbprintRequest":{ "type":"structure", "required":[ "OpenIDConnectProviderArn", "ThumbprintList" ], "members":{ "OpenIDConnectProviderArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the IAM OIDC provider resource object for which you want to update the thumbprint. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" }, "ThumbprintList":{ "shape":"thumbprintListType", "documentation":"

A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider.

" } } }, "UpdateSAMLProviderRequest":{ "type":"structure", "required":[ "SAMLMetadataDocument", "SAMLProviderArn" ], "members":{ "SAMLMetadataDocument":{ "shape":"SAMLMetadataDocumentType", "documentation":"

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

" }, "SAMLProviderArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the SAML provider to update.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" } } }, "UpdateSAMLProviderResponse":{ "type":"structure", "members":{ "SAMLProviderArn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) of the SAML provider that was updated.

" } }, "documentation":"

Contains the response to a successful UpdateSAMLProvider request.

" }, "UpdateSSHPublicKeyRequest":{ "type":"structure", "required":[ "UserName", "SSHPublicKeyId", "Status" ], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the IAM user associated with the SSH public key.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "SSHPublicKeyId":{ "shape":"publicKeyIdType", "documentation":"

The unique identifier for the SSH public key.

This parameter allows (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" }, "Status":{ "shape":"statusType", "documentation":"

The status to assign to the SSH public key. Active means the key can be used for authentication with an AWS CodeCommit repository. Inactive means the key cannot be used.

" } } }, "UpdateServerCertificateRequest":{ "type":"structure", "required":["ServerCertificateName"], "members":{ "ServerCertificateName":{ "shape":"serverCertificateNameType", "documentation":"

The name of the server certificate that you want to update.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "NewPath":{ "shape":"pathType", "documentation":"

The new path for the server certificate. Include this only if you are updating the server certificate's path.

This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "NewServerCertificateName":{ "shape":"serverCertificateNameType", "documentation":"

The new name for the server certificate. Include this only if you are updating the server certificate's name. The name of the certificate cannot contain any spaces.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "UpdateServiceSpecificCredentialRequest":{ "type":"structure", "required":[ "ServiceSpecificCredentialId", "Status" ], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the IAM user associated with the service-specific credential. If you do not specify this value, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "ServiceSpecificCredentialId":{ "shape":"serviceSpecificCredentialId", "documentation":"

The unique identifier of the service-specific credential.

This parameter allows (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" }, "Status":{ "shape":"statusType", "documentation":"

The status to be assigned to the service-specific credential.

" } } }, "UpdateSigningCertificateRequest":{ "type":"structure", "required":[ "CertificateId", "Status" ], "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the IAM user the signing certificate belongs to.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "CertificateId":{ "shape":"certificateIdType", "documentation":"

The ID of the signing certificate you want to update.

This parameter allows (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" }, "Status":{ "shape":"statusType", "documentation":"

The status you want to assign to the certificate. Active means the certificate can be used for API calls to AWS, while Inactive means the certificate cannot be used.

" } } }, "UpdateUserRequest":{ "type":"structure", "required":["UserName"], "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

Name of the user to update. If you're changing the name of the user, this is the original user name.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "NewPath":{ "shape":"pathType", "documentation":"

New path for the IAM user. Include this parameter only if you're changing the user's path.

This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" }, "NewUserName":{ "shape":"userNameType", "documentation":"

New name for the user. Include this parameter only if you're changing the user's name.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" } } }, "UploadSSHPublicKeyRequest":{ "type":"structure", "required":[ "UserName", "SSHPublicKeyBody" ], "members":{ "UserName":{ "shape":"userNameType", "documentation":"

The name of the IAM user to associate the SSH public key with.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "SSHPublicKeyBody":{ "shape":"publicKeyMaterialType", "documentation":"

The SSH public key. The public key must be encoded in ssh-rsa format or PEM format.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" } } }, "UploadSSHPublicKeyResponse":{ "type":"structure", "members":{ "SSHPublicKey":{ "shape":"SSHPublicKey", "documentation":"

Contains information about the SSH public key.

" } }, "documentation":"

Contains the response to a successful UploadSSHPublicKey request.

" }, "UploadServerCertificateRequest":{ "type":"structure", "required":[ "ServerCertificateName", "CertificateBody", "PrivateKey" ], "members":{ "Path":{ "shape":"pathType", "documentation":"

The path for the server certificate. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/). This paramater allows (per its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (\\u0021) thru the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the --path option. The path must begin with /cloudfront and must include a trailing slash (for example, /cloudfront/test/).

" }, "ServerCertificateName":{ "shape":"serverCertificateNameType", "documentation":"

The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "CertificateBody":{ "shape":"certificateBodyType", "documentation":"

The contents of the public key certificate in PEM-encoded format.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" }, "PrivateKey":{ "shape":"privateKeyType", "documentation":"

The contents of the private key in PEM-encoded format.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" }, "CertificateChain":{ "shape":"certificateChainType", "documentation":"

The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" } } }, "UploadServerCertificateResponse":{ "type":"structure", "members":{ "ServerCertificateMetadata":{ "shape":"ServerCertificateMetadata", "documentation":"

The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.

" } }, "documentation":"

Contains the response to a successful UploadServerCertificate request.

" }, "UploadSigningCertificateRequest":{ "type":"structure", "required":["CertificateBody"], "members":{ "UserName":{ "shape":"existingUserNameType", "documentation":"

The name of the user the signing certificate is for.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" }, "CertificateBody":{ "shape":"certificateBodyType", "documentation":"

The contents of the signing certificate.

The regex pattern used to validate this parameter is a string of characters consisting of any printable ASCII character ranging from the space character (\\u0020) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF). It also includes the special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D).

" } } }, "UploadSigningCertificateResponse":{ "type":"structure", "required":["Certificate"], "members":{ "Certificate":{ "shape":"SigningCertificate", "documentation":"

Information about the certificate.

" } }, "documentation":"

Contains the response to a successful UploadSigningCertificate request.

" }, "User":{ "type":"structure", "required":[ "Path", "UserName", "UserId", "Arn", "CreateDate" ], "members":{ "Path":{ "shape":"pathType", "documentation":"

The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.

" }, "UserName":{ "shape":"userNameType", "documentation":"

The friendly name identifying the user.

" }, "UserId":{ "shape":"idType", "documentation":"

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.

" }, "Arn":{ "shape":"arnType", "documentation":"

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the Using IAM guide.

" }, "CreateDate":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the user was created.

" }, "PasswordLastUsed":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the Credential Reports topic in the Using IAM guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. This field is null (not present) when:

  • The user does not have a password

  • The password exists but has never been used (at least not since IAM started tracking this information on October 20th, 2014

  • there is no sign-in data associated with the user

This value is returned only in the GetUser and ListUsers actions.

" } }, "documentation":"

Contains information about an IAM user entity.

This data type is used as a response element in the following actions:

" }, "UserDetail":{ "type":"structure", "members":{ "Path":{ "shape":"pathType", "documentation":"

The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.

" }, "UserName":{ "shape":"userNameType", "documentation":"

The friendly name identifying the user.

" }, "UserId":{ "shape":"idType", "documentation":"

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.

" }, "Arn":{"shape":"arnType"}, "CreateDate":{ "shape":"dateType", "documentation":"

The date and time, in ISO 8601 date-time format, when the user was created.

" }, "UserPolicyList":{ "shape":"policyDetailListType", "documentation":"

A list of the inline policies embedded in the user.

" }, "GroupList":{ "shape":"groupNameListType", "documentation":"

A list of IAM groups that the user is in.

" }, "AttachedManagedPolicies":{ "shape":"attachedPoliciesListType", "documentation":"

A list of the managed policies attached to the user.

" } }, "documentation":"

Contains information about an IAM user, including all the user's policies and all the IAM groups the user is in.

This data type is used as a response element in the GetAccountAuthorizationDetails action.

" }, "VirtualMFADevice":{ "type":"structure", "required":["SerialNumber"], "members":{ "SerialNumber":{ "shape":"serialNumberType", "documentation":"

The serial number associated with VirtualMFADevice.

" }, "Base32StringSeed":{ "shape":"BootstrapDatum", "documentation":"

The Base32 seed defined as specified in RFC3548. The Base32StringSeed is Base64-encoded.

" }, "QRCodePNG":{ "shape":"BootstrapDatum", "documentation":"

A QR code PNG image that encodes otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String where $virtualMFADeviceName is one of the create call arguments, AccountName is the user name if set (otherwise, the account ID otherwise), and Base32String is the seed in Base32 format. The Base32String value is Base64-encoded.

" }, "User":{ "shape":"User", "documentation":"

The user to whom the MFA device is assigned.

" }, "EnableDate":{ "shape":"dateType", "documentation":"

The date and time on which the virtual MFA device was enabled.

" } }, "documentation":"

Contains information about a virtual MFA device.

" }, "accessKeyIdType":{ "type":"string", "max":32, "min":16, "pattern":"[\\w]+" }, "accessKeyMetadataListType":{ "type":"list", "member":{"shape":"AccessKeyMetadata"}, "documentation":"

Contains a list of access key metadata.

This data type is used as a response element in the ListAccessKeys action.

" }, "accessKeySecretType":{ "type":"string", "sensitive":true }, "accountAliasListType":{ "type":"list", "member":{"shape":"accountAliasType"} }, "accountAliasType":{ "type":"string", "max":63, "min":3, "pattern":"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$" }, "arnType":{ "type":"string", "documentation":"

The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

", "max":2048, "min":20 }, "assignmentStatusType":{ "type":"string", "enum":[ "Assigned", "Unassigned", "Any" ] }, "attachedPoliciesListType":{ "type":"list", "member":{"shape":"AttachedPolicy"} }, "attachmentCountType":{"type":"integer"}, "authenticationCodeType":{ "type":"string", "max":6, "min":6, "pattern":"[\\d]+" }, "booleanObjectType":{ "type":"boolean", "box":true }, "booleanType":{"type":"boolean"}, "certificateBodyType":{ "type":"string", "max":16384, "min":1, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" }, "certificateChainType":{ "type":"string", "max":2097152, "min":1, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" }, "certificateIdType":{ "type":"string", "max":128, "min":24, "pattern":"[\\w]+" }, "certificateListType":{ "type":"list", "member":{"shape":"SigningCertificate"}, "documentation":"

Contains a list of signing certificates.

This data type is used as a response element in the ListSigningCertificates action.

" }, "clientIDListType":{ "type":"list", "member":{"shape":"clientIDType"} }, "clientIDType":{ "type":"string", "max":255, "min":1 }, "credentialReportExpiredExceptionMessage":{"type":"string"}, "credentialReportNotPresentExceptionMessage":{"type":"string"}, "credentialReportNotReadyExceptionMessage":{"type":"string"}, "dateType":{"type":"timestamp"}, "deleteConflictMessage":{"type":"string"}, "duplicateCertificateMessage":{"type":"string"}, "duplicateSSHPublicKeyMessage":{"type":"string"}, "encodingType":{ "type":"string", "enum":[ "SSH", "PEM" ] }, "entityAlreadyExistsMessage":{"type":"string"}, "entityListType":{ "type":"list", "member":{"shape":"EntityType"} }, "entityTemporarilyUnmodifiableMessage":{"type":"string"}, "existingUserNameType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w+=,.@-]+" }, "groupDetailListType":{ "type":"list", "member":{"shape":"GroupDetail"} }, "groupListType":{ "type":"list", "member":{"shape":"Group"}, "documentation":"

Contains a list of IAM groups.

This data type is used as a response element in the ListGroups action.

" }, "groupNameListType":{ "type":"list", "member":{"shape":"groupNameType"} }, "groupNameType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w+=,.@-]+" }, "idType":{ "type":"string", "max":32, "min":16, "pattern":"[\\w]+" }, "instanceProfileListType":{ "type":"list", "member":{"shape":"InstanceProfile"}, "documentation":"

Contains a list of instance profiles.

" }, "instanceProfileNameType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w+=,.@-]+" }, "invalidAuthenticationCodeMessage":{"type":"string"}, "invalidCertificateMessage":{"type":"string"}, "invalidInputMessage":{"type":"string"}, "invalidPublicKeyMessage":{"type":"string"}, "invalidUserTypeMessage":{"type":"string"}, "keyPairMismatchMessage":{"type":"string"}, "limitExceededMessage":{"type":"string"}, "malformedCertificateMessage":{"type":"string"}, "malformedPolicyDocumentMessage":{"type":"string"}, "markerType":{ "type":"string", "max":320, "min":1, "pattern":"[\\u0020-\\u00FF]+" }, "maxItemsType":{ "type":"integer", "max":1000, "min":1 }, "maxPasswordAgeType":{ "type":"integer", "box":true, "max":1095, "min":1 }, "mfaDeviceListType":{ "type":"list", "member":{"shape":"MFADevice"}, "documentation":"

Contains a list of MFA devices.

This data type is used as a response element in the ListMFADevices and ListVirtualMFADevices actions.

" }, "minimumPasswordLengthType":{ "type":"integer", "max":128, "min":6 }, "noSuchEntityMessage":{"type":"string"}, "passwordPolicyViolationMessage":{"type":"string"}, "passwordReusePreventionType":{ "type":"integer", "box":true, "max":24, "min":1 }, "passwordType":{ "type":"string", "max":128, "min":1, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "sensitive":true }, "pathPrefixType":{ "type":"string", "max":512, "min":1, "pattern":"\\u002F[\\u0021-\\u007F]*" }, "pathType":{ "type":"string", "max":512, "min":1, "pattern":"(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)" }, "policyDescriptionType":{ "type":"string", "max":1000 }, "policyDetailListType":{ "type":"list", "member":{"shape":"PolicyDetail"} }, "policyDocumentType":{ "type":"string", "max":131072, "min":1, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" }, "policyDocumentVersionListType":{ "type":"list", "member":{"shape":"PolicyVersion"} }, "policyEvaluationErrorMessage":{"type":"string"}, "policyListType":{ "type":"list", "member":{"shape":"Policy"} }, "policyNameListType":{ "type":"list", "member":{"shape":"policyNameType"}, "documentation":"

Contains a list of policy names.

This data type is used as a response element in the ListPolicies action.

" }, "policyNameType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w+=,.@-]+" }, "policyPathType":{ "type":"string", "pattern":"((/[A-Za-z0-9\\.,\\+@=_-]+)*)/" }, "policyScopeType":{ "type":"string", "enum":[ "All", "AWS", "Local" ] }, "policyVersionIdType":{ "type":"string", "pattern":"v[1-9][0-9]*(\\.[A-Za-z0-9-]*)?" }, "privateKeyType":{ "type":"string", "max":16384, "min":1, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "sensitive":true }, "publicKeyFingerprintType":{ "type":"string", "max":48, "min":48, "pattern":"[:\\w]+" }, "publicKeyIdType":{ "type":"string", "max":128, "min":20, "pattern":"[\\w]+" }, "publicKeyMaterialType":{ "type":"string", "max":16384, "min":1, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" }, "roleDetailListType":{ "type":"list", "member":{"shape":"RoleDetail"} }, "roleListType":{ "type":"list", "member":{"shape":"Role"}, "documentation":"

Contains a list of IAM roles.

This data type is used as a response element in the ListRoles action.

" }, "roleNameType":{ "type":"string", "max":64, "min":1, "pattern":"[\\w+=,.@-]+" }, "serialNumberType":{ "type":"string", "max":256, "min":9, "pattern":"[\\w+=/:,.@-]+" }, "serverCertificateMetadataListType":{ "type":"list", "member":{"shape":"ServerCertificateMetadata"} }, "serverCertificateNameType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w+=,.@-]+" }, "serviceFailureExceptionMessage":{"type":"string"}, "serviceName":{"type":"string"}, "serviceNotSupportedMessage":{"type":"string"}, "servicePassword":{ "type":"string", "sensitive":true }, "serviceSpecificCredentialId":{ "type":"string", "max":128, "min":20, "pattern":"[\\w]+" }, "serviceUserName":{ "type":"string", "max":200, "min":17, "pattern":"[\\w+=,.@-]+" }, "statusType":{ "type":"string", "enum":[ "Active", "Inactive" ] }, "stringType":{"type":"string"}, "summaryKeyType":{ "type":"string", "enum":[ "Users", "UsersQuota", "Groups", "GroupsQuota", "ServerCertificates", "ServerCertificatesQuota", "UserPolicySizeQuota", "GroupPolicySizeQuota", "GroupsPerUserQuota", "SigningCertificatesPerUserQuota", "AccessKeysPerUserQuota", "MFADevices", "MFADevicesInUse", "AccountMFAEnabled", "AccountAccessKeysPresent", "AccountSigningCertificatesPresent", "AttachedPoliciesPerGroupQuota", "AttachedPoliciesPerRoleQuota", "AttachedPoliciesPerUserQuota", "Policies", "PoliciesQuota", "PolicySizeQuota", "PolicyVersionsInUse", "PolicyVersionsInUseQuota", "VersionsPerPolicyQuota" ] }, "summaryMapType":{ "type":"map", "key":{"shape":"summaryKeyType"}, "value":{"shape":"summaryValueType"} }, "summaryValueType":{"type":"integer"}, "thumbprintListType":{ "type":"list", "member":{"shape":"thumbprintType"}, "documentation":"

Contains a list of thumbprints of identity provider server certificates.

" }, "thumbprintType":{ "type":"string", "documentation":"

Contains a thumbprint for an identity provider's server certificate.

The identity provider's server certificate thumbprint is the hex-encoded SHA-1 hash value of the self-signed X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.

", "max":40, "min":40 }, "unrecognizedPublicKeyEncodingMessage":{"type":"string"}, "userDetailListType":{ "type":"list", "member":{"shape":"UserDetail"} }, "userListType":{ "type":"list", "member":{"shape":"User"}, "documentation":"

Contains a list of users.

This data type is used as a response element in the GetGroup and ListUsers actions.

" }, "userNameType":{ "type":"string", "max":64, "min":1, "pattern":"[\\w+=,.@-]+" }, "virtualMFADeviceListType":{ "type":"list", "member":{"shape":"VirtualMFADevice"} }, "virtualMFADeviceName":{ "type":"string", "min":1, "pattern":"[\\w+=,.@-]+" } }, "documentation":"AWS Identity and Access Management

AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions under your AWS account. This guide provides descriptions of IAM actions that you can call programmatically. For general information about IAM, see AWS Identity and Access Management (IAM). For the user guide for IAM, see Using IAM.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to IAM and AWS. For example, the SDKs take care of tasks such as cryptographically signing requests (see below), 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.

We recommend that you use the AWS SDKs to make programmatic API calls to IAM. However, you can also use the IAM Query API to make direct calls to the IAM web service. To learn more about the IAM Query API, see Making Query Requests in the Using IAM guide. IAM supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.

Signing Requests

Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret access key for everyday work with IAM. You can use the access key ID and secret access key for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials and use those to sign requests.

To sign requests, we recommend that you use Signature Version 4. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement.

Additional Resources

For more information, see the following:

  • AWS Security Credentials. This topic provides general information about the types of credentials used for accessing AWS.

  • IAM Best Practices. This topic presents a list of suggestions for using the IAM service to help secure your AWS resources.

  • Signing AWS API Requests. This set of topics walk you through the process of signing a request using an access key ID and secret access key.

" } botocore-1.5.7/botocore/data/codebuild/0000777454262600001440000000000013042511307021065 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/codebuild/2016-10-06/0000777454262600001440000000000013042511307022116 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/codebuild/2016-10-06/service-2.json0000666454262600001440000014447213042511306024623 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2016-10-06", "endpointPrefix":"codebuild", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"AWS CodeBuild", "signatureVersion":"v4", "targetPrefix":"CodeBuild_20161006", "uid":"codebuild-2016-10-06" }, "operations":{ "BatchGetBuilds":{ "name":"BatchGetBuilds", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetBuildsInput"}, "output":{"shape":"BatchGetBuildsOutput"}, "errors":[ {"shape":"InvalidInputException"} ], "documentation":"

Gets information about builds.

" }, "BatchGetProjects":{ "name":"BatchGetProjects", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetProjectsInput"}, "output":{"shape":"BatchGetProjectsOutput"}, "errors":[ {"shape":"InvalidInputException"} ], "documentation":"

Gets information about build projects.

" }, "CreateProject":{ "name":"CreateProject", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateProjectInput"}, "output":{"shape":"CreateProjectOutput"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"AccountLimitExceededException"} ], "documentation":"

Creates a build project.

" }, "DeleteProject":{ "name":"DeleteProject", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteProjectInput"}, "output":{"shape":"DeleteProjectOutput"}, "errors":[ {"shape":"InvalidInputException"} ], "documentation":"

Deletes a build project.

" }, "ListBuilds":{ "name":"ListBuilds", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListBuildsInput"}, "output":{"shape":"ListBuildsOutput"}, "errors":[ {"shape":"InvalidInputException"} ], "documentation":"

Gets a list of build IDs, with each build ID representing a single build.

" }, "ListBuildsForProject":{ "name":"ListBuildsForProject", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListBuildsForProjectInput"}, "output":{"shape":"ListBuildsForProjectOutput"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Gets a list of build IDs for the specified build project, with each build ID representing a single build.

" }, "ListCuratedEnvironmentImages":{ "name":"ListCuratedEnvironmentImages", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListCuratedEnvironmentImagesInput"}, "output":{"shape":"ListCuratedEnvironmentImagesOutput"}, "documentation":"

Gets information about Docker images that are managed by AWS CodeBuild.

" }, "ListProjects":{ "name":"ListProjects", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListProjectsInput"}, "output":{"shape":"ListProjectsOutput"}, "errors":[ {"shape":"InvalidInputException"} ], "documentation":"

Gets a list of build project names, with each build project name representing a single build project.

" }, "StartBuild":{ "name":"StartBuild", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartBuildInput"}, "output":{"shape":"StartBuildOutput"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccountLimitExceededException"} ], "documentation":"

Starts running a build.

" }, "StopBuild":{ "name":"StopBuild", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopBuildInput"}, "output":{"shape":"StopBuildOutput"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Attempts to stop running a build.

" }, "UpdateProject":{ "name":"UpdateProject", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateProjectInput"}, "output":{"shape":"UpdateProjectOutput"}, "errors":[ {"shape":"InvalidInputException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Changes the settings of a build project.

" } }, "shapes":{ "AccountLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

An AWS service limit was exceeded for the calling AWS account.

", "exception":true }, "ArtifactNamespace":{ "type":"string", "enum":[ "NONE", "BUILD_ID" ] }, "ArtifactPackaging":{ "type":"string", "enum":[ "NONE", "ZIP" ] }, "ArtifactsType":{ "type":"string", "enum":[ "CODEPIPELINE", "S3", "NO_ARTIFACTS" ] }, "BatchGetBuildsInput":{ "type":"structure", "required":["ids"], "members":{ "ids":{ "shape":"BuildIds", "documentation":"

The IDs of the builds.

" } } }, "BatchGetBuildsOutput":{ "type":"structure", "members":{ "builds":{ "shape":"Builds", "documentation":"

Information about the requested builds.

" }, "buildsNotFound":{ "shape":"BuildIds", "documentation":"

The IDs of builds for which information could not be found.

" } } }, "BatchGetProjectsInput":{ "type":"structure", "required":["names"], "members":{ "names":{ "shape":"ProjectNames", "documentation":"

The names of the build projects.

" } } }, "BatchGetProjectsOutput":{ "type":"structure", "members":{ "projects":{ "shape":"Projects", "documentation":"

Information about the requested build projects.

" }, "projectsNotFound":{ "shape":"ProjectNames", "documentation":"

The names of build projects for which information could not be found.

" } } }, "Boolean":{"type":"boolean"}, "Build":{ "type":"structure", "members":{ "id":{ "shape":"NonEmptyString", "documentation":"

The unique ID for the build.

" }, "arn":{ "shape":"NonEmptyString", "documentation":"

The Amazon Resource Name (ARN) of the build.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

When the build process started, expressed in Unix time format.

" }, "endTime":{ "shape":"Timestamp", "documentation":"

When the build process ended, expressed in Unix time format.

" }, "currentPhase":{ "shape":"String", "documentation":"

The current build phase.

" }, "buildStatus":{ "shape":"StatusType", "documentation":"

The current status of the build. Valid values include:

  • FAILED: The build failed.

  • FAULT: The build faulted.

  • IN_PROGRESS: The build is still in progress.

  • STOPPED: The build stopped.

  • SUCCEEDED: The build succeeded.

  • TIMED_OUT: The build timed out.

" }, "sourceVersion":{ "shape":"NonEmptyString", "documentation":"

Any version identifier for the version of the source code to be built.

" }, "projectName":{ "shape":"NonEmptyString", "documentation":"

The name of the build project.

" }, "phases":{ "shape":"BuildPhases", "documentation":"

Information about all previous build phases that are completed and information about any current build phase that is not yet complete.

" }, "source":{ "shape":"ProjectSource", "documentation":"

Information about the source code to be built.

" }, "artifacts":{ "shape":"BuildArtifacts", "documentation":"

Information about the output artifacts for the build.

" }, "environment":{ "shape":"ProjectEnvironment", "documentation":"

Information about the build environment for this build.

" }, "logs":{ "shape":"LogsLocation", "documentation":"

Information about the build's logs in Amazon CloudWatch Logs.

" }, "timeoutInMinutes":{ "shape":"WrapperInt", "documentation":"

How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.

" }, "buildComplete":{ "shape":"Boolean", "documentation":"

Whether the build has finished. True if completed; otherwise, false.

" }, "initiator":{ "shape":"String", "documentation":"

The entity that started the build. Valid values include:

  • If AWS CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).

  • If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example MyUserName).

  • If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

" } }, "documentation":"

Information about a build.

" }, "BuildArtifacts":{ "type":"structure", "members":{ "location":{ "shape":"String", "documentation":"

Information about the location of the build artifacts.

" }, "sha256sum":{ "shape":"String", "documentation":"

The SHA-256 hash of the build artifact.

You can use this hash along with a checksum tool to confirm both file integrity and authenticity.

This value is available only if the build project's packaging value is set to ZIP.

" }, "md5sum":{ "shape":"String", "documentation":"

The MD5 hash of the build artifact.

You can use this hash along with a checksum tool to confirm both file integrity and authenticity.

This value is available only if the build project's packaging value is set to ZIP.

" } }, "documentation":"

Information about build output artifacts.

" }, "BuildIds":{ "type":"list", "member":{"shape":"NonEmptyString"}, "max":100, "min":1 }, "BuildPhase":{ "type":"structure", "members":{ "phaseType":{ "shape":"BuildPhaseType", "documentation":"

The name of the build phase. Valid values include:

  • BUILD: Core build activities typically occur in this build phase.

  • COMPLETED: The build has been completed.

  • DOWNLOAD_SOURCE: Source code is being downloaded in this build phase.

  • FINALIZING: The build process is completing in this build phase.

  • INSTALL: Installation activities typically occur in this build phase.

  • POST_BUILD: Post-build activities typically occur in this build phase.

  • PRE_BUILD: Pre-build activities typically occur in this build phase.

  • PROVISIONING: The build environment is being set up.

  • SUBMITTED: The build has been submitted.

  • UPLOAD_ARTIFACTS: Build output artifacts are being uploaded to the output location.

" }, "phaseStatus":{ "shape":"StatusType", "documentation":"

The current status of the build phase. Valid values include:

  • FAILED: The build phase failed.

  • FAULT: The build phase faulted.

  • IN_PROGRESS: The build phase is still in progress.

  • STOPPED: The build phase stopped.

  • SUCCEEDED: The build phase succeeded.

  • TIMED_OUT: The build phase timed out.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

When the build phase started, expressed in Unix time format.

" }, "endTime":{ "shape":"Timestamp", "documentation":"

When the build phase ended, expressed in Unix time format.

" }, "durationInSeconds":{ "shape":"WrapperLong", "documentation":"

How long, in seconds, between the starting and ending times of the build's phase.

" }, "contexts":{ "shape":"PhaseContexts", "documentation":"

Additional information about a build phase, especially to help troubleshoot a failed build.

" } }, "documentation":"

Information about a stage for a build.

" }, "BuildPhaseType":{ "type":"string", "enum":[ "SUBMITTED", "PROVISIONING", "DOWNLOAD_SOURCE", "INSTALL", "PRE_BUILD", "BUILD", "POST_BUILD", "UPLOAD_ARTIFACTS", "FINALIZING", "COMPLETED" ] }, "BuildPhases":{ "type":"list", "member":{"shape":"BuildPhase"} }, "Builds":{ "type":"list", "member":{"shape":"Build"} }, "ComputeType":{ "type":"string", "enum":[ "BUILD_GENERAL1_SMALL", "BUILD_GENERAL1_MEDIUM", "BUILD_GENERAL1_LARGE" ] }, "CreateProjectInput":{ "type":"structure", "required":[ "name", "source", "artifacts", "environment" ], "members":{ "name":{ "shape":"ProjectName", "documentation":"

The name of the build project.

" }, "description":{ "shape":"ProjectDescription", "documentation":"

A description that makes the build project easy to identify.

" }, "source":{ "shape":"ProjectSource", "documentation":"

Information about the build input source code for the build project.

" }, "artifacts":{ "shape":"ProjectArtifacts", "documentation":"

Information about the build output artifacts for the build project.

" }, "environment":{ "shape":"ProjectEnvironment", "documentation":"

Information about the build environment for the build project.

" }, "serviceRole":{ "shape":"NonEmptyString", "documentation":"

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

" }, "timeoutInMinutes":{ "shape":"TimeOut", "documentation":"

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any build that has not been marked as completed. The default is 60 minutes.

" }, "encryptionKey":{ "shape":"NonEmptyString", "documentation":"

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.

You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format alias/alias-name ).

" }, "tags":{ "shape":"TagList", "documentation":"

A set of tags for this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

" } } }, "CreateProjectOutput":{ "type":"structure", "members":{ "project":{ "shape":"Project", "documentation":"

Information about the build project that was created.

" } } }, "DeleteProjectInput":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"NonEmptyString", "documentation":"

The name of the build project.

" } } }, "DeleteProjectOutput":{ "type":"structure", "members":{ } }, "EnvironmentImage":{ "type":"structure", "members":{ "name":{ "shape":"String", "documentation":"

The name of the Docker image.

" }, "description":{ "shape":"String", "documentation":"

The description of the Docker image.

" } }, "documentation":"

Information about a Docker image that is managed by AWS CodeBuild.

" }, "EnvironmentImages":{ "type":"list", "member":{"shape":"EnvironmentImage"} }, "EnvironmentLanguage":{ "type":"structure", "members":{ "language":{ "shape":"LanguageType", "documentation":"

The programming language for the Docker images.

" }, "images":{ "shape":"EnvironmentImages", "documentation":"

The list of Docker images that are related by the specified programming language.

" } }, "documentation":"

A set of Docker images that are related by programming language and are managed by AWS CodeBuild.

" }, "EnvironmentLanguages":{ "type":"list", "member":{"shape":"EnvironmentLanguage"} }, "EnvironmentPlatform":{ "type":"structure", "members":{ "platform":{ "shape":"PlatformType", "documentation":"

The platform's name.

" }, "languages":{ "shape":"EnvironmentLanguages", "documentation":"

The list of programming languages that are available for the specified platform.

" } }, "documentation":"

A set of Docker images that are related by platform and are managed by AWS CodeBuild.

" }, "EnvironmentPlatforms":{ "type":"list", "member":{"shape":"EnvironmentPlatform"} }, "EnvironmentType":{ "type":"string", "enum":["LINUX_CONTAINER"] }, "EnvironmentVariable":{ "type":"structure", "required":[ "name", "value" ], "members":{ "name":{ "shape":"NonEmptyString", "documentation":"

The name or key of the environment variable.

" }, "value":{ "shape":"String", "documentation":"

The value of the environment variable.

" } }, "documentation":"

Information about an environment variable for a build project or a build.

" }, "EnvironmentVariables":{ "type":"list", "member":{"shape":"EnvironmentVariable"} }, "InvalidInputException":{ "type":"structure", "members":{ }, "documentation":"

The input value that was provided is not valid.

", "exception":true }, "KeyInput":{ "type":"string", "max":127, "min":1, "pattern":"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=@+\\\\-]*)$" }, "LanguageType":{ "type":"string", "enum":[ "JAVA", "PYTHON", "NODE_JS", "RUBY", "GOLANG", "DOCKER", "ANDROID", "BASE" ] }, "ListBuildsForProjectInput":{ "type":"structure", "required":["projectName"], "members":{ "projectName":{ "shape":"NonEmptyString", "documentation":"

The name of the build project.

" }, "sortOrder":{ "shape":"SortOrderType", "documentation":"

The order to list build IDs. Valid values include:

  • ASCENDING: List the build IDs in ascending order by build ID.

  • DESCENDING: List the build IDs in descending order by build ID.

" }, "nextToken":{ "shape":"String", "documentation":"

During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

" } } }, "ListBuildsForProjectOutput":{ "type":"structure", "members":{ "ids":{ "shape":"BuildIds", "documentation":"

A list of build IDs for the specified build project, with each build ID representing a single build.

" }, "nextToken":{ "shape":"String", "documentation":"

If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

" } } }, "ListBuildsInput":{ "type":"structure", "members":{ "sortOrder":{ "shape":"SortOrderType", "documentation":"

The order to list build IDs. Valid values include:

  • ASCENDING: List the build IDs in ascending order by build ID.

  • DESCENDING: List the build IDs in descending order by build ID.

" }, "nextToken":{ "shape":"String", "documentation":"

During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

" } } }, "ListBuildsOutput":{ "type":"structure", "members":{ "ids":{ "shape":"BuildIds", "documentation":"

A list of build IDs, with each build ID representing a single build.

" }, "nextToken":{ "shape":"String", "documentation":"

If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

" } } }, "ListCuratedEnvironmentImagesInput":{ "type":"structure", "members":{ } }, "ListCuratedEnvironmentImagesOutput":{ "type":"structure", "members":{ "platforms":{ "shape":"EnvironmentPlatforms", "documentation":"

Information about supported platforms for Docker images that are managed by AWS CodeBuild.

" } } }, "ListProjectsInput":{ "type":"structure", "members":{ "sortBy":{ "shape":"ProjectSortByType", "documentation":"

The criterion to be used to list build project names. Valid values include:

  • CREATED_TIME: List the build project names based on when each build project was created.

  • LAST_MODIFIED_TIME: List the build project names based on when information about each build project was last changed.

  • NAME: List the build project names based on each build project's name.

Use sortOrder to specify in what order to list the build project names based on the preceding criteria.

" }, "sortOrder":{ "shape":"SortOrderType", "documentation":"

The order in which to list build projects. Valid values include:

  • ASCENDING: List the build project names in ascending order.

  • DESCENDING: List the build project names in descending order.

Use sortBy to specify the criterion to be used to list build project names.

" }, "nextToken":{ "shape":"NonEmptyString", "documentation":"

During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

" } } }, "ListProjectsOutput":{ "type":"structure", "members":{ "nextToken":{ "shape":"String", "documentation":"

If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

" }, "projects":{ "shape":"ProjectNames", "documentation":"

The list of build project names, with each build project name representing a single build project.

" } } }, "LogsLocation":{ "type":"structure", "members":{ "groupName":{ "shape":"String", "documentation":"

The name of the Amazon CloudWatch Logs group for the build logs.

" }, "streamName":{ "shape":"String", "documentation":"

The name of the Amazon CloudWatch Logs stream for the build logs.

" }, "deepLink":{ "shape":"String", "documentation":"

The URL to an individual build log in Amazon CloudWatch Logs.

" } }, "documentation":"

Information about build logs in Amazon CloudWatch Logs.

" }, "NonEmptyString":{ "type":"string", "min":1 }, "PhaseContext":{ "type":"structure", "members":{ "statusCode":{ "shape":"String", "documentation":"

The status code for the context of the build phase.

" }, "message":{ "shape":"String", "documentation":"

An explanation of the build phase's context. This explanation might include a command ID and an exit code.

" } }, "documentation":"

Additional information about a build phase that has an error. You can use this information to help troubleshoot a failed build.

" }, "PhaseContexts":{ "type":"list", "member":{"shape":"PhaseContext"} }, "PlatformType":{ "type":"string", "enum":[ "DEBIAN", "AMAZON_LINUX", "UBUNTU" ] }, "Project":{ "type":"structure", "members":{ "name":{ "shape":"ProjectName", "documentation":"

The name of the build project.

" }, "arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the build project.

" }, "description":{ "shape":"ProjectDescription", "documentation":"

A description that makes the build project easy to identify.

" }, "source":{ "shape":"ProjectSource", "documentation":"

Information about the build input source code for this build project.

" }, "artifacts":{ "shape":"ProjectArtifacts", "documentation":"

Information about the build output artifacts for the build project.

" }, "environment":{ "shape":"ProjectEnvironment", "documentation":"

Information about the build environment for this build project.

" }, "serviceRole":{ "shape":"NonEmptyString", "documentation":"

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

" }, "timeoutInMinutes":{ "shape":"TimeOut", "documentation":"

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.

" }, "encryptionKey":{ "shape":"NonEmptyString", "documentation":"

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.

This is expressed either as the CMK's Amazon Resource Name (ARN) or, if specified, the CMK's alias (using the format alias/alias-name ).

" }, "tags":{ "shape":"TagList", "documentation":"

The tags for this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

" }, "created":{ "shape":"Timestamp", "documentation":"

When the build project was created, expressed in Unix time format.

" }, "lastModified":{ "shape":"Timestamp", "documentation":"

When the build project's settings were last modified, expressed in Unix time format.

" } }, "documentation":"

Information about a build project.

" }, "ProjectArtifacts":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"ArtifactsType", "documentation":"

The type of build output artifact. Valid values include:

  • CODEPIPELINE: The build project will have build output generated through AWS CodePipeline.

  • NO_ARTIFACTS: The build project will not produce any build output.

  • S3: The build project will store build output in Amazon Simple Storage Service (Amazon S3).

" }, "location":{ "shape":"String", "documentation":"

Information about the build output artifact location, as follows:

  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

  • If type is set to S3, this is the name of the output bucket.

" }, "path":{ "shape":"String", "documentation":"

Along with namespaceType and name, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:

  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

  • If type is set to S3, this is the path to the output artifact. If path is not specified, then path will not be used.

For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, then the output artifact would be stored in the output bucket at MyArtifacts/MyArtifact.zip.

" }, "namespaceType":{ "shape":"ArtifactNamespace", "documentation":"

Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:

  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

  • If type is set to S3, then valid values include:

    • BUILD_ID: Include the build ID in the location of the build output artifact.

    • NONE: Do not include the build ID. This is the default if namespaceType is not specified.

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.

" }, "name":{ "shape":"String", "documentation":"

Along with path and namespaceType, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:

  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

  • If type is set to S3, this is the name of the output artifact object.

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.

" }, "packaging":{ "shape":"ArtifactPackaging", "documentation":"

The type of build output artifact to create, as follows:

  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

  • If type is set to S3, valid values include:

    • NONE: AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.

    • ZIP: AWS CodeBuild will create in the output bucket a ZIP file containing the build output.

" } }, "documentation":"

Information about the build output artifacts for the build project.

" }, "ProjectDescription":{ "type":"string", "max":255, "min":0 }, "ProjectEnvironment":{ "type":"structure", "required":[ "type", "image", "computeType" ], "members":{ "type":{ "shape":"EnvironmentType", "documentation":"

The type of build environment to use for related builds.

" }, "image":{ "shape":"NonEmptyString", "documentation":"

The ID of the Docker image to use for this build project.

" }, "computeType":{ "shape":"ComputeType", "documentation":"

Information about the compute resources the build project will use. Available values include:

  • BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.

  • BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.

  • BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds.

" }, "environmentVariables":{ "shape":"EnvironmentVariables", "documentation":"

A set of environment variables to make available to builds for this build project.

" } }, "documentation":"

Information about the build environment of the build project.

" }, "ProjectName":{ "type":"string", "max":255, "min":2, "pattern":"[A-Za-z0-9][A-Za-z0-9\\-_]{1,254}" }, "ProjectNames":{ "type":"list", "member":{"shape":"NonEmptyString"}, "max":100, "min":1 }, "ProjectSortByType":{ "type":"string", "enum":[ "NAME", "CREATED_TIME", "LAST_MODIFIED_TIME" ] }, "ProjectSource":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"SourceType", "documentation":"

The type of repository that contains the source code to be built. Valid values include:

  • CODECOMMIT: The source code is in an AWS CodeCommit repository.

  • CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS CodePipeline.

  • GITHUB: The source code is in a GitHub repository.

  • S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.

" }, "location":{ "shape":"String", "documentation":"

Information about the location of the source code to be built. Valid values include:

  • For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.

  • For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).

  • For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip)

  • For source code in a GitHub repository, instead of specifying a value here, you connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project, and follow the on-screen instructions to complete the connection. (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the source object, set the auth object's type value to OAUTH.

" }, "buildspec":{ "shape":"String", "documentation":"

The build spec declaration to use for the builds in this build project.

If this value is not specified, a build spec must be included along with the source code to be built.

" }, "auth":{ "shape":"SourceAuth", "documentation":"

Information about the authorization settings for AWS CodeBuild to access the source code to be built.

This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source type value is GITHUB).

" } }, "documentation":"

Information about the build input source code for the build project.

" }, "Projects":{ "type":"list", "member":{"shape":"Project"} }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ }, "documentation":"

The specified AWS resource cannot be created, because an AWS resource with the same settings already exists.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified AWS resource cannot be found.

", "exception":true }, "SortOrderType":{ "type":"string", "enum":[ "ASCENDING", "DESCENDING" ] }, "SourceAuth":{ "type":"structure", "required":["type"], "members":{ "type":{ "shape":"SourceAuthType", "documentation":"

The authorization type to use. The only valid value is OAUTH, which represents the OAuth authorization type.

" }, "resource":{ "shape":"String", "documentation":"

The resource value that applies to the specified authorization type.

" } }, "documentation":"

Information about the authorization settings for AWS CodeBuild to access the source code to be built.

This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source type value is GITHUB).

" }, "SourceAuthType":{ "type":"string", "enum":["OAUTH"] }, "SourceType":{ "type":"string", "enum":[ "CODECOMMIT", "CODEPIPELINE", "GITHUB", "S3" ] }, "StartBuildInput":{ "type":"structure", "required":["projectName"], "members":{ "projectName":{ "shape":"NonEmptyString", "documentation":"

The name of the build project to start running a build.

" }, "sourceVersion":{ "shape":"String", "documentation":"

A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:

  • For AWS CodeCommit or GitHub: the commit ID to use.

  • For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.

" }, "artifactsOverride":{ "shape":"ProjectArtifacts", "documentation":"

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

" }, "environmentVariablesOverride":{ "shape":"EnvironmentVariables", "documentation":"

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

" }, "buildspecOverride":{ "shape":"String", "documentation":"

A build spec declaration that overrides, for this build only, the latest one already defined in the build project.

" }, "timeoutInMinutesOverride":{ "shape":"TimeOut", "documentation":"

The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

" } } }, "StartBuildOutput":{ "type":"structure", "members":{ "build":{ "shape":"Build", "documentation":"

Information about the build to be run.

" } } }, "StatusType":{ "type":"string", "enum":[ "SUCCEEDED", "FAILED", "FAULT", "TIMED_OUT", "IN_PROGRESS", "STOPPED" ] }, "StopBuildInput":{ "type":"structure", "required":["id"], "members":{ "id":{ "shape":"NonEmptyString", "documentation":"

The ID of the build.

" } } }, "StopBuildOutput":{ "type":"structure", "members":{ "build":{ "shape":"Build", "documentation":"

Information about the build.

" } } }, "String":{"type":"string"}, "Tag":{ "type":"structure", "members":{ "key":{ "shape":"KeyInput", "documentation":"

The tag's key.

" }, "value":{ "shape":"ValueInput", "documentation":"

The tag's value.

" } }, "documentation":"

A tag, consisting of a key and a value.

This tag is available for use by AWS services that support tags in AWS CodeBuild.

" }, "TagList":{ "type":"list", "member":{"shape":"Tag"}, "max":50, "min":0 }, "TimeOut":{ "type":"integer", "max":480, "min":1 }, "Timestamp":{"type":"timestamp"}, "UpdateProjectInput":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"NonEmptyString", "documentation":"

The name of the build project.

You cannot change a build project's name.

" }, "description":{ "shape":"ProjectDescription", "documentation":"

A new or replacement description of the build project.

" }, "source":{ "shape":"ProjectSource", "documentation":"

Information to be changed about the build input source code for the build project.

" }, "artifacts":{ "shape":"ProjectArtifacts", "documentation":"

Information to be changed about the build output artifacts for the build project.

" }, "environment":{ "shape":"ProjectEnvironment", "documentation":"

Information to be changed about the build environment for the build project.

" }, "serviceRole":{ "shape":"NonEmptyString", "documentation":"

The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

" }, "timeoutInMinutes":{ "shape":"TimeOut", "documentation":"

The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.

" }, "encryptionKey":{ "shape":"NonEmptyString", "documentation":"

The replacement AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.

You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format alias/alias-name ).

" }, "tags":{ "shape":"TagList", "documentation":"

The replacement set of tags for this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

" } } }, "UpdateProjectOutput":{ "type":"structure", "members":{ "project":{ "shape":"Project", "documentation":"

Information about the build project that was changed.

" } } }, "ValueInput":{ "type":"string", "max":255, "min":1, "pattern":"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=@+\\\\-]*)$" }, "WrapperInt":{"type":"integer"}, "WrapperLong":{"type":"long"} }, "documentation":"AWS CodeBuild

AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apach Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests, and you pay only for the build time you consume. For more information about AWS CodeBuild, see the AWS CodeBuild User Guide.

AWS CodeBuild supports these operations:

  • BatchGetProjects: Gets information about one or more build projects. A build project defines how AWS CodeBuild will run a build. This includes information such as where to get the source code to build, the build environment to use, the build commands to run, and where to store the build output. A build environment represents a combination of operating system, programming language runtime, and tools that AWS CodeBuild will use to run a build. Also, you can add tags to build projects to help manage your resources and costs.

  • CreateProject: Creates a build project.

  • DeleteProject: Deletes a build project.

  • ListProjects: Gets a list of build project names, with each build project name representing a single build project.

  • UpdateProject: Changes the settings of an existing build project.

  • BatchGetBuilds: Gets information about one or more builds.

  • ListBuilds: Gets a list of build IDs, with each build ID representing a single build.

  • ListBuildsForProject: Gets a list of build IDs for the specified build project, with each build ID representing a single build.

  • StartBuild: Starts running a build.

  • StopBuild: Attempts to stop running a build.

  • ListCuratedEnvironmentImages: Gets information about Docker images that are managed by AWS CodeBuild.

" } botocore-1.5.7/botocore/data/elastictranscoder/0000777454262600001440000000000013042511307022644 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/elastictranscoder/2012-09-25/0000777454262600001440000000000013042511307023702 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/elastictranscoder/2012-09-25/waiters-2.json0000666454262600001440000000114513042511306026412 0ustar pysdk-ciamazon00000000000000{ "version": 2, "waiters": { "JobComplete": { "delay": 30, "operation": "ReadJob", "maxAttempts": 120, "acceptors": [ { "expected": "Complete", "matcher": "path", "state": "success", "argument": "Job.Status" }, { "expected": "Canceled", "matcher": "path", "state": "failure", "argument": "Job.Status" }, { "expected": "Error", "matcher": "path", "state": "failure", "argument": "Job.Status" } ] } } } botocore-1.5.7/botocore/data/elastictranscoder/2012-09-25/paginators-1.json0000666454262600001440000000105713042511306027104 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListJobsByPipeline": { "input_token": "PageToken", "output_token": "NextPageToken", "result_key": "Jobs" }, "ListJobsByStatus": { "input_token": "PageToken", "output_token": "NextPageToken", "result_key": "Jobs" }, "ListPipelines": { "input_token": "PageToken", "output_token": "NextPageToken", "result_key": "Pipelines" }, "ListPresets": { "input_token": "PageToken", "output_token": "NextPageToken", "result_key": "Presets" } } } botocore-1.5.7/botocore/data/elastictranscoder/2012-09-25/service-2.json0000666454262600001440000061056013042511306026403 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"elastictranscoder-2012-09-25", "apiVersion":"2012-09-25", "endpointPrefix":"elastictranscoder", "protocol":"rest-json", "serviceFullName":"Amazon Elastic Transcoder", "signatureVersion":"v4" }, "operations":{ "CancelJob":{ "name":"CancelJob", "http":{ "method":"DELETE", "requestUri":"/2012-09-25/jobs/{Id}", "responseCode":202 }, "input":{"shape":"CancelJobRequest"}, "output":{"shape":"CancelJobResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"} ], "documentation":"

The CancelJob operation cancels an unfinished job.

You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline.

" }, "CreateJob":{ "name":"CreateJob", "http":{ "method":"POST", "requestUri":"/2012-09-25/jobs", "responseCode":201 }, "input":{"shape":"CreateJobRequest"}, "output":{"shape":"CreateJobResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"LimitExceededException"}, {"shape":"InternalServiceException"} ], "documentation":"

When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created.

If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console).

" }, "CreatePipeline":{ "name":"CreatePipeline", "http":{ "method":"POST", "requestUri":"/2012-09-25/pipelines", "responseCode":201 }, "input":{"shape":"CreatePipelineRequest"}, "output":{"shape":"CreatePipelineResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"InternalServiceException"} ], "documentation":"

The CreatePipeline operation creates a pipeline with settings that you specify.

" }, "CreatePreset":{ "name":"CreatePreset", "http":{ "method":"POST", "requestUri":"/2012-09-25/presets", "responseCode":201 }, "input":{"shape":"CreatePresetRequest"}, "output":{"shape":"CreatePresetResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"AccessDeniedException"}, {"shape":"LimitExceededException"}, {"shape":"InternalServiceException"} ], "documentation":"

The CreatePreset operation creates a preset with settings that you specify.

Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (ValidationException) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces.

Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services.

" }, "DeletePipeline":{ "name":"DeletePipeline", "http":{ "method":"DELETE", "requestUri":"/2012-09-25/pipelines/{Id}", "responseCode":202 }, "input":{"shape":"DeletePipelineRequest"}, "output":{"shape":"DeletePipelineResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"} ], "documentation":"

The DeletePipeline operation removes a pipeline.

You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, DeletePipeline returns an error.

" }, "DeletePreset":{ "name":"DeletePreset", "http":{ "method":"DELETE", "requestUri":"/2012-09-25/presets/{Id}", "responseCode":202 }, "input":{"shape":"DeletePresetRequest"}, "output":{"shape":"DeletePresetResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"} ], "documentation":"

The DeletePreset operation removes a preset that you've added in an AWS region.

You can't delete the default presets that are included with Elastic Transcoder.

" }, "ListJobsByPipeline":{ "name":"ListJobsByPipeline", "http":{ "method":"GET", "requestUri":"/2012-09-25/jobsByPipeline/{PipelineId}" }, "input":{"shape":"ListJobsByPipelineRequest"}, "output":{"shape":"ListJobsByPipelineResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"} ], "documentation":"

The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.

Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria.

" }, "ListJobsByStatus":{ "name":"ListJobsByStatus", "http":{ "method":"GET", "requestUri":"/2012-09-25/jobsByStatus/{Status}" }, "input":{"shape":"ListJobsByStatusRequest"}, "output":{"shape":"ListJobsByStatusResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"} ], "documentation":"

The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria.

" }, "ListPipelines":{ "name":"ListPipelines", "http":{ "method":"GET", "requestUri":"/2012-09-25/pipelines" }, "input":{"shape":"ListPipelinesRequest"}, "output":{"shape":"ListPipelinesResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"} ], "documentation":"

The ListPipelines operation gets a list of the pipelines associated with the current AWS account.

" }, "ListPresets":{ "name":"ListPresets", "http":{ "method":"GET", "requestUri":"/2012-09-25/presets" }, "input":{"shape":"ListPresetsRequest"}, "output":{"shape":"ListPresetsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"} ], "documentation":"

The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region.

" }, "ReadJob":{ "name":"ReadJob", "http":{ "method":"GET", "requestUri":"/2012-09-25/jobs/{Id}" }, "input":{"shape":"ReadJobRequest"}, "output":{"shape":"ReadJobResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"} ], "documentation":"

The ReadJob operation returns detailed information about a job.

" }, "ReadPipeline":{ "name":"ReadPipeline", "http":{ "method":"GET", "requestUri":"/2012-09-25/pipelines/{Id}" }, "input":{"shape":"ReadPipelineRequest"}, "output":{"shape":"ReadPipelineResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"} ], "documentation":"

The ReadPipeline operation gets detailed information about a pipeline.

" }, "ReadPreset":{ "name":"ReadPreset", "http":{ "method":"GET", "requestUri":"/2012-09-25/presets/{Id}" }, "input":{"shape":"ReadPresetRequest"}, "output":{"shape":"ReadPresetResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"} ], "documentation":"

The ReadPreset operation gets detailed information about a preset.

" }, "TestRole":{ "name":"TestRole", "http":{ "method":"POST", "requestUri":"/2012-09-25/roleTests", "responseCode":200 }, "input":{"shape":"TestRoleRequest"}, "output":{"shape":"TestRoleResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"} ], "documentation":"

The TestRole operation tests the IAM role used to create the pipeline.

The TestRole action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify.

", "deprecated":true }, "UpdatePipeline":{ "name":"UpdatePipeline", "http":{ "method":"PUT", "requestUri":"/2012-09-25/pipelines/{Id}", "responseCode":200 }, "input":{"shape":"UpdatePipelineRequest"}, "output":{"shape":"UpdatePipelineResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceInUseException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceException"} ], "documentation":"

Use the UpdatePipeline operation to update settings for a pipeline.

When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings.

" }, "UpdatePipelineNotifications":{ "name":"UpdatePipelineNotifications", "http":{ "method":"POST", "requestUri":"/2012-09-25/pipelines/{Id}/notifications" }, "input":{"shape":"UpdatePipelineNotificationsRequest"}, "output":{"shape":"UpdatePipelineNotificationsResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"} ], "documentation":"

With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline.

When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.

" }, "UpdatePipelineStatus":{ "name":"UpdatePipelineStatus", "http":{ "method":"POST", "requestUri":"/2012-09-25/pipelines/{Id}/status" }, "input":{"shape":"UpdatePipelineStatusRequest"}, "output":{"shape":"UpdatePipelineStatusResponse"}, "errors":[ {"shape":"ValidationException"}, {"shape":"IncompatibleVersionException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalServiceException"} ], "documentation":"

The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs.

Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request.

" } }, "shapes":{ "AccessControl":{ "type":"string", "pattern":"(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)" }, "AccessControls":{ "type":"list", "member":{"shape":"AccessControl"}, "max":30 }, "AccessDeniedException":{ "type":"structure", "members":{ }, "documentation":"

General authentication failure. The request was not signed correctly.

", "error":{"httpStatusCode":403}, "exception":true }, "Artwork":{ "type":"structure", "members":{ "InputKey":{ "shape":"WatermarkKey", "documentation":"

The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the InputBucket object in that pipeline identifies the bucket.

If the file name includes a prefix, for example, cooking/pie.jpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

" }, "MaxWidth":{ "shape":"DigitsOrAuto", "documentation":"

The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive.

" }, "MaxHeight":{ "shape":"DigitsOrAuto", "documentation":"

The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive.

" }, "SizingPolicy":{ "shape":"SizingPolicy", "documentation":"

Specify one of the following values to control scaling of the output album art:

  • Fit: Elastic Transcoder scales the output art so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value.

  • Fill: Elastic Transcoder scales the output art so it matches the value that you specified in either MaxWidth or MaxHeight and matches or exceeds the other value. Elastic Transcoder centers the output art and then crops it in the dimension (if any) that exceeds the maximum value.

  • Stretch: Elastic Transcoder stretches the output art to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the input art and the output art are different, the output art will be distorted.

  • Keep: Elastic Transcoder does not scale the output art. If either dimension of the input art exceeds the values that you specified for MaxWidth and MaxHeight, Elastic Transcoder crops the output art.

  • ShrinkToFit: Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the art up.

  • ShrinkToFill Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale the art up.

" }, "PaddingPolicy":{ "shape":"PaddingPolicy", "documentation":"

When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the top and bottom and/or left and right sides of the output album art to make the total size of the output art match the values that you specified for MaxWidth and MaxHeight.

" }, "AlbumArtFormat":{ "shape":"JpgOrPng", "documentation":"

The format of album art, if any. Valid formats are .jpg and .png.

" }, "Encryption":{ "shape":"Encryption", "documentation":"

The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.

" } }, "documentation":"

The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20.

To remove artwork or leave the artwork empty, you can either set Artwork to null, or set the Merge Policy to \"Replace\" and use an empty Artwork array.

To pass through existing artwork unchanged, set the Merge Policy to \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork array.

" }, "Artworks":{ "type":"list", "member":{"shape":"Artwork"} }, "Ascending":{ "type":"string", "pattern":"(^true$)|(^false$)" }, "AspectRatio":{ "type":"string", "pattern":"(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)" }, "AudioBitDepth":{ "type":"string", "pattern":"(^8$)|(^16$)|(^24$)|(^32$)" }, "AudioBitOrder":{ "type":"string", "pattern":"(^LittleEndian$)" }, "AudioBitRate":{ "type":"string", "pattern":"^\\d{1,3}$" }, "AudioChannels":{ "type":"string", "pattern":"(^auto$)|(^0$)|(^1$)|(^2$)" }, "AudioCodec":{ "type":"string", "pattern":"(^AAC$)|(^vorbis$)|(^mp3$)|(^mp2$)|(^pcm$)|(^flac$)" }, "AudioCodecOptions":{ "type":"structure", "members":{ "Profile":{ "shape":"AudioCodecProfile", "documentation":"

You can only choose an audio profile when you specify AAC for the value of Audio:Codec.

Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:

  • auto: If you specify auto, Elastic Transcoder selects the profile based on the bit rate selected for the output file.

  • AAC-LC: The most common AAC profile. Use for bit rates larger than 64 kbps.

  • HE-AAC: Not supported on some older players and devices. Use for bit rates between 40 and 80 kbps.

  • HE-AACv2: Not supported on some players and devices. Use for bit rates less than 48 kbps.

All outputs in a Smooth playlist must have the same value for Profile.

If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated your presets to use AAC-LC. You can change the value as required.

" }, "BitDepth":{ "shape":"AudioBitDepth", "documentation":"

You can only choose an audio bit depth when you specify flac or pcm for the value of Audio:Codec.

The bit depth of a sample is how many bits of information are included in the audio samples. The higher the bit depth, the better the audio, but the larger the file.

Valid values are 16 and 24.

The most common bit depth is 24.

" }, "BitOrder":{ "shape":"AudioBitOrder", "documentation":"

You can only choose an audio bit order when you specify pcm for the value of Audio:Codec.

The order the bits of a PCM sample are stored in.

The supported value is LittleEndian.

" }, "Signed":{ "shape":"AudioSigned", "documentation":"

You can only choose whether an audio sample is signed when you specify pcm for the value of Audio:Codec.

Whether audio samples are represented with negative and positive numbers (signed) or only positive numbers (unsigned).

The supported value is Signed.

" } }, "documentation":"

Options associated with your audio codec.

" }, "AudioCodecProfile":{ "type":"string", "pattern":"(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)" }, "AudioPackingMode":{ "type":"string", "pattern":"(^SingleTrack$)|(^OneChannelPerTrack$)|(^OneChannelPerTrackWithMosTo8Tracks$)" }, "AudioParameters":{ "type":"structure", "members":{ "Codec":{ "shape":"AudioCodec", "documentation":"

The audio codec for the output file. Valid values include aac, flac, mp2, mp3, pcm, and vorbis.

" }, "SampleRate":{ "shape":"AudioSampleRate", "documentation":"

The sample rate of the audio stream in the output file, in Hertz. Valid values include:

auto, 22050, 32000, 44100, 48000, 96000

If you specify auto, Elastic Transcoder automatically detects the sample rate.

" }, "BitRate":{ "shape":"AudioBitRate", "documentation":"

The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.

" }, "Channels":{ "shape":"AudioChannels", "documentation":"

The number of audio channels in the output file. The following values are valid:

auto, 0, 1, 2

One channel carries the information played by a single speaker. For example, a stereo track with two channels sends one channel to the left speaker, and the other channel to the right speaker. The output channels are organized into tracks. If you want Elastic Transcoder to automatically detect the number of audio channels in the input file and use that value for the output file, select auto.

The output of a specific channel value and inputs are as follows:

  • auto channel specified, with any input: Pass through up to eight input channels.

  • 0 channels specified, with any input: Audio omitted from the output.

  • 1 channel specified, with at least one input channel: Mono sound.

  • 2 channels specified, with any input: Two identical mono channels or stereo. For more information about tracks, see Audio:AudioPackingMode.

For more information about how Elastic Transcoder organizes channels and tracks, see Audio:AudioPackingMode.

" }, "AudioPackingMode":{ "shape":"AudioPackingMode", "documentation":"

The method of organizing audio channels and tracks. Use Audio:Channels to specify the number of channels in your output, and Audio:AudioPackingMode to specify the number of tracks and their relation to the channels. If you do not specify an Audio:AudioPackingMode, Elastic Transcoder uses SingleTrack.

The following values are valid:

SingleTrack, OneChannelPerTrack, and OneChannelPerTrackWithMosTo8Tracks

When you specify SingleTrack, Elastic Transcoder creates a single track for your output. The track can have up to eight channels. Use SingleTrack for all non-mxf containers.

The outputs of SingleTrack for a specific channel value and inputs are as follows:

  • 0 channels with any input: Audio omitted from the output

  • 1, 2, or auto channels with no audio input: Audio omitted from the output

  • 1 channel with any input with audio: One track with one channel, downmixed if necessary

  • 2 channels with one track with one channel: One track with two identical channels

  • 2 or auto channels with two tracks with one channel each: One track with two channels

  • 2 or auto channels with one track with two channels: One track with two channels

  • 2 channels with one track with multiple channels: One track with two channels

  • auto channels with one track with one channel: One track with one channel

  • auto channels with one track with multiple channels: One track with multiple channels

When you specify OneChannelPerTrack, Elastic Transcoder creates a new track for every channel in your output. Your output can have up to eight single-channel tracks.

The outputs of OneChannelPerTrack for a specific channel value and inputs are as follows:

  • 0 channels with any input: Audio omitted from the output

  • 1, 2, or auto channels with no audio input: Audio omitted from the output

  • 1 channel with any input with audio: One track with one channel, downmixed if necessary

  • 2 channels with one track with one channel: Two tracks with one identical channel each

  • 2 or auto channels with two tracks with one channel each: Two tracks with one channel each

  • 2 or auto channels with one track with two channels: Two tracks with one channel each

  • 2 channels with one track with multiple channels: Two tracks with one channel each

  • auto channels with one track with one channel: One track with one channel

  • auto channels with one track with multiple channels: Up to eight tracks with one channel each

When you specify OneChannelPerTrackWithMosTo8Tracks, Elastic Transcoder creates eight single-channel tracks for your output. All tracks that do not contain audio data from an input channel are MOS, or Mit Out Sound, tracks.

The outputs of OneChannelPerTrackWithMosTo8Tracks for a specific channel value and inputs are as follows:

  • 0 channels with any input: Audio omitted from the output

  • 1, 2, or auto channels with no audio input: Audio omitted from the output

  • 1 channel with any input with audio: One track with one channel, downmixed if necessary, plus six MOS tracks

  • 2 channels with one track with one channel: Two tracks with one identical channel each, plus six MOS tracks

  • 2 or auto channels with two tracks with one channel each: Two tracks with one channel each, plus six MOS tracks

  • 2 or auto channels with one track with two channels: Two tracks with one channel each, plus six MOS tracks

  • 2 channels with one track with multiple channels: Two tracks with one channel each, plus six MOS tracks

  • auto channels with one track with one channel: One track with one channel, plus seven MOS tracks

  • auto channels with one track with multiple channels: Up to eight tracks with one channel each, plus MOS tracks until there are eight tracks in all

" }, "CodecOptions":{ "shape":"AudioCodecOptions", "documentation":"

If you specified AAC for Audio:Codec, this is the AAC compression profile to use. Valid values include:

auto, AAC-LC, HE-AAC, HE-AACv2

If you specify auto, Elastic Transcoder chooses a profile based on the bit rate of the output file.

" } }, "documentation":"

Parameters required for transcoding audio.

" }, "AudioSampleRate":{ "type":"string", "pattern":"(^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)|(^192000$)" }, "AudioSigned":{ "type":"string", "pattern":"(^Unsigned$)|(^Signed$)" }, "Base64EncodedString":{ "type":"string", "pattern":"^$|(^(?:[A-Za-z0-9\\+/]{4})*(?:[A-Za-z0-9\\+/]{2}==|[A-Za-z0-9\\+/]{3}=)?$)" }, "BucketName":{ "type":"string", "pattern":"^(\\w|\\.|-){1,255}$" }, "CancelJobRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier of the job that you want to cancel.

To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The CancelJobRequest structure.

" }, "CancelJobResponse":{ "type":"structure", "members":{ }, "documentation":"

The response body contains a JSON object. If the job is successfully canceled, the value of Success is true.

" }, "CaptionFormat":{ "type":"structure", "members":{ "Format":{ "shape":"CaptionFormatFormat", "documentation":"

The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.

  • Valid Embedded Caption Formats:

    • for FLAC: None

    • For MP3: None

    • For MP4: mov-text

    • For MPEG-TS: None

    • For ogg: None

    • For webm: None

  • Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

    • For FMP4: dfxp

    • Non-FMP4 outputs: All sidecar types

    fmp4 captions have an extension of .ismt

" }, "Pattern":{ "shape":"CaptionFormatPattern", "documentation":"

The prefix for caption filenames, in the form description-{language}, where:

  • description is a description of the video.

  • {language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.

If you don't include {language} in the file name pattern, Elastic Transcoder automatically appends \"{language}\" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files.

For example, suppose you're transcoding into srt format. When you enter \"Sydney-{language}-sunrise\", and the language of the captions is English (en), the name of the first caption file is be Sydney-en-sunrise00000.srt.

" }, "Encryption":{ "shape":"Encryption", "documentation":"

The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.

" } }, "documentation":"

The file format of the output captions. If you leave this value blank, Elastic Transcoder returns an error.

" }, "CaptionFormatFormat":{ "type":"string", "pattern":"(^mov-text$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)|(^cea-708$)" }, "CaptionFormatPattern":{ "type":"string", "pattern":"(^$)|(^.*\\{language\\}.*$)" }, "CaptionFormats":{ "type":"list", "member":{"shape":"CaptionFormat"}, "max":4 }, "CaptionMergePolicy":{ "type":"string", "pattern":"(^MergeOverride$)|(^MergeRetain$)|(^Override$)" }, "CaptionSource":{ "type":"structure", "members":{ "Key":{ "shape":"LongKey", "documentation":"

The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

" }, "Language":{ "shape":"Key", "documentation":"

A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of:

  • 2-character ISO 639-1 code

  • 3-character ISO 639-2 code

For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

" }, "TimeOffset":{ "shape":"TimeOffset", "documentation":"

For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

" }, "Label":{ "shape":"Name", "documentation":"

The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

" }, "Encryption":{ "shape":"Encryption", "documentation":"

The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.

" } }, "documentation":"

A source file for the input sidecar captions used during the transcoding process.

" }, "CaptionSources":{ "type":"list", "member":{"shape":"CaptionSource"}, "max":20 }, "Captions":{ "type":"structure", "members":{ "MergePolicy":{ "shape":"CaptionMergePolicy", "documentation":"

A policy that determines how Elastic Transcoder handles the existence of multiple captions.

  • MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.

  • MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files.

  • Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources.

MergePolicy cannot be null.

", "deprecated":true }, "CaptionSources":{ "shape":"CaptionSources", "documentation":"

Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.

", "deprecated":true }, "CaptionFormats":{ "shape":"CaptionFormats", "documentation":"

The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.

" } }, "documentation":"

The captions to be created, if any.

" }, "Clip":{ "type":"structure", "members":{ "TimeSpan":{ "shape":"TimeSpan", "documentation":"

Settings that determine when a clip begins and how long it lasts.

" } }, "documentation":"

Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.

", "deprecated":true }, "CodecOption":{ "type":"string", "max":255, "min":1 }, "CodecOptions":{ "type":"map", "key":{"shape":"CodecOption"}, "value":{"shape":"CodecOption"}, "max":30 }, "Composition":{ "type":"list", "member":{"shape":"Clip"}, "deprecated":true }, "CreateJobOutput":{ "type":"structure", "members":{ "Key":{ "shape":"Key", "documentation":"

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails.

" }, "ThumbnailPattern":{ "shape":"ThumbnailPattern", "documentation":"

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:

  • {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file.

    If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job.

  • Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}.

  • {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object.

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.

" }, "ThumbnailEncryption":{ "shape":"Encryption", "documentation":"

The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.

" }, "Rotate":{ "shape":"Rotate", "documentation":"

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270. The value auto generally works only if the file that you're transcoding contains rotation metadata.

" }, "PresetId":{ "shape":"Id", "documentation":"

The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.

" }, "SegmentDuration":{ "shape":"FloatString", "documentation":"

(Outputs in Fragmented MP4 or MPEG-TS format only.

If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the target maximum duration of each segment in seconds. For HLSv3 format playlists, each media segment is stored in a separate .ts file. For HLSv4 and Smooth playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration, though individual segments might be shorter or longer.

The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration.

Elastic Transcoder creates an output-specific playlist for each output HLS output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys of the associated playlist.

" }, "Watermarks":{ "shape":"JobWatermarks", "documentation":"

Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output.

" }, "AlbumArt":{ "shape":"JobAlbumArt", "documentation":"

Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output.

" }, "Composition":{ "shape":"Composition", "documentation":"

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.

", "deprecated":true }, "Captions":{ "shape":"Captions", "documentation":"

You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

  • Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.

    Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text

    Valid outputs include: mov-text

    Elastic Transcoder supports a maximum of one embedded format per output.

  • Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.

    Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt

    Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.

If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.

To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.

For more information on embedded files, see the Subtitles Wikipedia page.

For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

" }, "Encryption":{ "shape":"Encryption", "documentation":"

You can specify encryption settings for any output files that you want to use for a transcoding job. This includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You must specify encryption settings for each file individually.

" } }, "documentation":"

The CreateJobOutput structure.

" }, "CreateJobOutputs":{ "type":"list", "member":{"shape":"CreateJobOutput"}, "max":30 }, "CreateJobPlaylist":{ "type":"structure", "members":{ "Name":{ "shape":"Filename", "documentation":"

The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a / character, the section of the name before the last / must be identical for all Name objects. If you create more than one master playlist, the values of all Name objects must be unique.

Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth playlists). If you include a file extension in Name, the file name will have two extensions.

" }, "Format":{ "shape":"PlaylistFormat", "documentation":"

The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth.

" }, "OutputKeys":{ "shape":"OutputKeys", "documentation":"

For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.

  • If your output is not HLS or does not have a segment duration set, the name of the output file is a concatenation of OutputKeyPrefix and Outputs:Key:

    OutputKeyPrefixOutputs:Key

  • If your output is HLSv3 and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of .m3u8, and a series of .ts files that include a five-digit sequential counter beginning with 00000:

    OutputKeyPrefixOutputs:Key.m3u8

    OutputKeyPrefixOutputs:Key00000.ts

  • If your output is HLSv4, has a segment duration set, and is included in an HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file extension of _v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of _iframe.m3u8:

    OutputKeyPrefixOutputs:Key_v4.m3u8

    OutputKeyPrefixOutputs:Key_iframe.m3u8

    OutputKeyPrefixOutputs:Key.ts

Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.

If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For Smooth playlists, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs.

" }, "HlsContentProtection":{ "shape":"HlsContentProtection", "documentation":"

The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

" }, "PlayReadyDrm":{ "shape":"PlayReadyDrm", "documentation":"

The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

" } }, "documentation":"

Information about the master playlist.

" }, "CreateJobPlaylists":{ "type":"list", "member":{"shape":"CreateJobPlaylist"}, "max":30 }, "CreateJobRequest":{ "type":"structure", "required":["PipelineId"], "members":{ "PipelineId":{ "shape":"Id", "documentation":"

The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

" }, "Input":{ "shape":"JobInput", "documentation":"

A section of the request body that provides information about the file that is being transcoded.

" }, "Inputs":{ "shape":"JobInputs", "documentation":"

A section of the request body that provides information about the files that are being transcoded.

" }, "Output":{ "shape":"CreateJobOutput", "documentation":"

A section of the request body that provides information about the transcoded (target) file. We strongly recommend that you use the Outputs syntax instead of the Output syntax.

" }, "Outputs":{ "shape":"CreateJobOutputs", "documentation":"

A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.

" }, "OutputKeyPrefix":{ "shape":"Key", "documentation":"

The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.

" }, "Playlists":{ "shape":"CreateJobPlaylists", "documentation":"

If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

The maximum number of master playlists in a job is 30.

" }, "UserMetadata":{ "shape":"UserMetadata", "documentation":"

User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs are returned in the same order in which you specify them.

" } }, "documentation":"

The CreateJobRequest structure.

" }, "CreateJobResponse":{ "type":"structure", "members":{ "Job":{ "shape":"Job", "documentation":"

A section of the response body that provides information about the job that is created.

" } }, "documentation":"

The CreateJobResponse structure.

" }, "CreatePipelineRequest":{ "type":"structure", "required":[ "Name", "InputBucket", "Role" ], "members":{ "Name":{ "shape":"Name", "documentation":"

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters.

" }, "InputBucket":{ "shape":"BucketName", "documentation":"

The Amazon S3 bucket in which you saved the media files that you want to transcode.

" }, "OutputBucket":{ "shape":"BucketName", "documentation":"

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)

Specify this value when all of the following are true:

  • You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.

  • You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.

  • You do not want to specify the permissions that Elastic Transcoder grants to the files.

    When Elastic Transcoder saves files in OutputBucket, it grants full control over the files only to the AWS account that owns the role that is specified by Role.

  • You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.

If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead.

" }, "Role":{ "shape":"Role", "documentation":"

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.

" }, "AwsKmsKeyArn":{ "shape":"KeyArn", "documentation":"

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

If you use either S3 or S3-AWS-KMS as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of AES-PKCS7, AES-CTR, or AES-GCM.

" }, "Notifications":{ "shape":"Notifications", "documentation":"

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

  • Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.

  • Completed: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

  • Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

  • Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

" }, "ContentConfig":{ "shape":"PipelineOutputConfig", "documentation":"

The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

  • Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

  • Grantee Type: Specify the type of value that appears in the Grantee object:

    • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content.

      A canonical user ID is not the same as an AWS account number.

    • Email: The value in the Grantee object is the registered email address of an AWS account.

    • Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

  • Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group

  • Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include:

    • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

" }, "ThumbnailConfig":{ "shape":"PipelineOutputConfig", "documentation":"

The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to create thumbnails.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

  • Permissions (Optional): The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

  • GranteeType: Specify the type of value that appears in the Grantee object:

    • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

      A canonical user ID is not the same as an AWS account number.

    • Email: The value in the Grantee object is the registered email address of an AWS account.

    • Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

  • Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.

  • Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:

    • READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

    • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

    • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

" } }, "documentation":"

The CreatePipelineRequest structure.

" }, "CreatePipelineResponse":{ "type":"structure", "members":{ "Pipeline":{ "shape":"Pipeline", "documentation":"

A section of the response body that provides information about the pipeline that is created.

" }, "Warnings":{ "shape":"Warnings", "documentation":"

Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.

Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.

" } }, "documentation":"

When you create a pipeline, Elastic Transcoder returns the values that you specified in the request.

" }, "CreatePresetRequest":{ "type":"structure", "required":[ "Name", "Container" ], "members":{ "Name":{ "shape":"Name", "documentation":"

The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

" }, "Description":{ "shape":"Description", "documentation":"

A description of the preset.

" }, "Container":{ "shape":"PresetContainer", "documentation":"

The container type for the output file. Valid values include flac, flv, fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm.

" }, "Video":{ "shape":"VideoParameters", "documentation":"

A section of the request body that specifies the video parameters.

" }, "Audio":{ "shape":"AudioParameters", "documentation":"

A section of the request body that specifies the audio parameters.

" }, "Thumbnails":{ "shape":"Thumbnails", "documentation":"

A section of the request body that specifies the thumbnail parameters, if any.

" } }, "documentation":"

The CreatePresetRequest structure.

" }, "CreatePresetResponse":{ "type":"structure", "members":{ "Preset":{ "shape":"Preset", "documentation":"

A section of the response body that provides information about the preset that is created.

" }, "Warning":{ "shape":"String", "documentation":"

If the preset settings don't comply with the standards for the video codec but Elastic Transcoder created the preset, this message explains the reason the preset settings don't meet the standard. Elastic Transcoder created the preset because the settings might produce acceptable output.

" } }, "documentation":"

The CreatePresetResponse structure.

" }, "DeletePipelineRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier of the pipeline that you want to delete.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The DeletePipelineRequest structure.

" }, "DeletePipelineResponse":{ "type":"structure", "members":{ }, "documentation":"

The DeletePipelineResponse structure.

" }, "DeletePresetRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier of the preset for which you want to get detailed information.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The DeletePresetRequest structure.

" }, "DeletePresetResponse":{ "type":"structure", "members":{ }, "documentation":"

The DeletePresetResponse structure.

" }, "Description":{ "type":"string", "max":255, "min":0 }, "DetectedProperties":{ "type":"structure", "members":{ "Width":{ "shape":"NullableInteger", "documentation":"

The detected width of the input file, in pixels.

" }, "Height":{ "shape":"NullableInteger", "documentation":"

The detected height of the input file, in pixels.

" }, "FrameRate":{ "shape":"FloatString", "documentation":"

The detected frame rate of the input file, in frames per second.

" }, "FileSize":{ "shape":"NullableLong", "documentation":"

The detected file size of the input file, in bytes.

" }, "DurationMillis":{ "shape":"NullableLong", "documentation":"

The detected duration of the input file, in milliseconds.

" } }, "documentation":"

The detected properties of the input file. Elastic Transcoder identifies these values from the input file.

" }, "Digits":{ "type":"string", "pattern":"^\\d{1,5}$" }, "DigitsOrAuto":{ "type":"string", "pattern":"(^auto$)|(^\\d{2,4}$)" }, "Encryption":{ "type":"structure", "members":{ "Mode":{ "shape":"EncryptionMode", "documentation":"

The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options:

  • S3: Amazon S3 creates and manages the keys used for encrypting your files.

  • S3-AWS-KMS: Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are used for encrypting your files. If you specify S3-AWS-KMS and you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline.

  • AES-CBC-PKCS7: A padded cipher-block mode of operation originally used for HLS files.

  • AES-CTR: AES Counter Mode.

  • AES-GCM: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with fails the decryption process.

For all three AES options, you must provide the following settings, which must be base64-encoded:

  • Key

  • Key MD5

  • Initialization Vector

For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.

" }, "Key":{ "shape":"Base64EncodedString", "documentation":"

The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded:

128, 192, or 256.

The key must also be encrypted by using the Amazon Key Management Service.

" }, "KeyMd5":{ "shape":"Base64EncodedString", "documentation":"

The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.

" }, "InitializationVector":{ "shape":"ZeroTo255String", "documentation":"

The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.

" } }, "documentation":"

The encryption settings, if any, that are used for decrypting your input files or encrypting your output files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file, otherwise you must specify the mode you want Elastic Transcoder to use to encrypt your output files.

" }, "EncryptionMode":{ "type":"string", "pattern":"(^s3$)|(^s3-aws-kms$)|(^aes-cbc-pkcs7$)|(^aes-ctr$)|(^aes-gcm$)" }, "ExceptionMessages":{ "type":"list", "member":{"shape":"String"} }, "Filename":{ "type":"string", "max":255, "min":1 }, "FixedGOP":{ "type":"string", "pattern":"(^true$)|(^false$)" }, "FloatString":{ "type":"string", "pattern":"^\\d{1,5}(\\.\\d{0,5})?$" }, "FrameRate":{ "type":"string", "pattern":"(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)" }, "Grantee":{ "type":"string", "max":255, "min":1 }, "GranteeType":{ "type":"string", "pattern":"(^Canonical$)|(^Email$)|(^Group$)" }, "HlsContentProtection":{ "type":"structure", "members":{ "Method":{ "shape":"HlsContentProtectionMethod", "documentation":"

The content protection method for your output. The only valid value is: aes-128.

This value is written into the method attribute of the EXT-X-KEY metadata tag in the output playlist.

" }, "Key":{ "shape":"Base64EncodedString", "documentation":"

If you want Elastic Transcoder to generate a key for you, leave this field blank.

If you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded:

128, 192, or 256.

" }, "KeyMd5":{ "shape":"Base64EncodedString", "documentation":"

If Elastic Transcoder is generating your key for you, you must leave this field blank.

The MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64- encoded.

" }, "InitializationVector":{ "shape":"ZeroTo255String", "documentation":"

If Elastic Transcoder is generating your key for you, you must leave this field blank.

The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded.

" }, "LicenseAcquisitionUrl":{ "shape":"ZeroTo512String", "documentation":"

The location of the license key required to decrypt your HLS playlist. The URL must be an absolute path, and is referenced in the URI attribute of the EXT-X-KEY metadata tag in the playlist file.

" }, "KeyStoragePolicy":{ "shape":"KeyStoragePolicy", "documentation":"

Specify whether you want Elastic Transcoder to write your HLS license key to an Amazon S3 bucket. If you choose WithVariantPlaylists, LicenseAcquisitionUrl must be left blank and Elastic Transcoder writes your data key into the same bucket as the associated playlist.

" } }, "documentation":"

The HLS content protection settings, if any, that you want Elastic Transcoder to apply to your output files.

" }, "HlsContentProtectionMethod":{ "type":"string", "pattern":"(^aes-128$)" }, "HorizontalAlign":{ "type":"string", "pattern":"(^Left$)|(^Right$)|(^Center$)" }, "Id":{ "type":"string", "pattern":"^\\d{13}-\\w{6}$" }, "IncompatibleVersionException":{ "type":"structure", "members":{ }, "error":{"httpStatusCode":400}, "exception":true }, "InputCaptions":{ "type":"structure", "members":{ "MergePolicy":{ "shape":"CaptionMergePolicy", "documentation":"

A policy that determines how Elastic Transcoder handles the existence of multiple captions.

  • MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.

  • MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files.

  • Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources.

MergePolicy cannot be null.

" }, "CaptionSources":{ "shape":"CaptionSources", "documentation":"

Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.

" } }, "documentation":"

The captions to be created, if any.

" }, "Interlaced":{ "type":"string", "pattern":"(^auto$)|(^true$)|(^false$)" }, "InternalServiceException":{ "type":"structure", "members":{ }, "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

", "exception":true, "fault":true }, "Job":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.

" }, "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the job.

" }, "PipelineId":{ "shape":"Id", "documentation":"

The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

" }, "Input":{ "shape":"JobInput", "documentation":"

A section of the request or response body that provides information about the file that is being transcoded.

" }, "Inputs":{ "shape":"JobInputs", "documentation":"

Information about the files that you're transcoding. If you specified multiple files for this job, Elastic Transcoder stitches the files together to make one output.

" }, "Output":{ "shape":"JobOutput", "documentation":"

If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.

Outputs recommended instead.

A section of the request or response body that provides information about the transcoded (target) file.

" }, "Outputs":{ "shape":"JobOutputs", "documentation":"

Information about the output files. We recommend that you use the Outputs syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both the Outputs and Output syntaxes in the same request. You can create a maximum of 30 outputs per job.

If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.

" }, "OutputKeyPrefix":{ "shape":"Key", "documentation":"

The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of the OutputKeyPrefix.

" }, "Playlists":{ "shape":"Playlists", "documentation":"

Outputs in Fragmented MP4 or MPEG-TS format only.

If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

The maximum number of master playlists in a job is 30.

" }, "Status":{ "shape":"JobStatus", "documentation":"

The status of the job: Submitted, Progressing, Complete, Canceled, or Error.

" }, "UserMetadata":{ "shape":"UserMetadata", "documentation":"

User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs are returned in the same order in which you specify them.

Metadata keys and values must use characters from the following list:

  • 0-9

  • A-Z and a-z

  • Space

  • The following symbols: _.:/=+-%@

" }, "Timing":{ "shape":"Timing", "documentation":"

Details about the timing of a job.

" } }, "documentation":"

A section of the response body that provides information about the job that is created.

" }, "JobAlbumArt":{ "type":"structure", "members":{ "MergePolicy":{ "shape":"MergePolicy", "documentation":"

A policy that determines how Elastic Transcoder handles the existence of multiple album artwork files.

  • Replace: The specified album art replaces any existing album art.

  • Prepend: The specified album art is placed in front of any existing album art.

  • Append: The specified album art is placed after any existing album art.

  • Fallback: If the original input file contains artwork, Elastic Transcoder uses that artwork for the output. If the original input does not contain artwork, Elastic Transcoder uses the specified album art file.

" }, "Artwork":{ "shape":"Artworks", "documentation":"

The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20. Valid formats are .jpg and .png

" } }, "documentation":"

The .jpg or .png file associated with an audio file.

" }, "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$)" }, "JobInput":{ "type":"structure", "members":{ "Key":{ "shape":"LongKey", "documentation":"

The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The InputBucket object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.

If the file name includes a prefix, such as cooking/lasagna.mpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

" }, "FrameRate":{ "shape":"FrameRate", "documentation":"

The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify auto. If you want to specify the frame rate for the input file, enter one of the following values:

10, 15, 23.97, 24, 25, 29.97, 30, 60

If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate.

" }, "Resolution":{ "shape":"Resolution", "documentation":"

This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.

" }, "AspectRatio":{ "shape":"AspectRatio", "documentation":"

The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify auto. If you want to specify the aspect ratio for the output file, enter one of the following values:

1:1, 4:3, 3:2, 16:9

If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio.

" }, "Interlaced":{ "shape":"Interlaced", "documentation":"

Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify auto. If you want to specify whether the input file is interlaced, enter one of the following values:

true, false

If you specify a value other than auto, Elastic Transcoder disables automatic detection of interlacing.

" }, "Container":{ "shape":"JobContainer", "documentation":"

The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify auto. If you want to specify the container type for the input file, enter one of the following values:

3gp, aac, asf, avi, divx, flv, m4a, mkv, mov, mp3, mp4, mpeg, mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm

" }, "Encryption":{ "shape":"Encryption", "documentation":"

The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file.

" }, "TimeSpan":{ "shape":"TimeSpan", "documentation":"

Settings for clipping an input. Each input can have different clip settings.

" }, "InputCaptions":{ "shape":"InputCaptions", "documentation":"

You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

  • Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.

    Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text

    Valid outputs include: mov-text

    Elastic Transcoder supports a maximum of one embedded format per output.

  • Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.

    Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt

    Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.

If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.

To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.

For more information on embedded files, see the Subtitles Wikipedia page.

For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

" }, "DetectedProperties":{ "shape":"DetectedProperties", "documentation":"

The detected properties of the input file.

" } }, "documentation":"

Information about the file that you're transcoding.

" }, "JobInputs":{ "type":"list", "member":{"shape":"JobInput"}, "max":10000 }, "JobOutput":{ "type":"structure", "members":{ "Id":{ "shape":"String", "documentation":"

A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.

" }, "Key":{ "shape":"Key", "documentation":"

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID.

" }, "ThumbnailPattern":{ "shape":"ThumbnailPattern", "documentation":"

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:

  • {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file.

    If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job.

  • Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}.

  • {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object.

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.

" }, "ThumbnailEncryption":{ "shape":"Encryption", "documentation":"

The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.

" }, "Rotate":{ "shape":"Rotate", "documentation":"

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values:

auto, 0, 90, 180, 270

The value auto generally works only if the file that you're transcoding contains rotation metadata.

" }, "PresetId":{ "shape":"Id", "documentation":"

The value of the Id object for the preset that you want to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. To use a preset that you created, specify the preset ID that Elastic Transcoder returned in the response when you created the preset. You can also use the Elastic Transcoder system presets, which you can get with ListPresets.

" }, "SegmentDuration":{ "shape":"FloatString", "documentation":"

(Outputs in Fragmented MP4 or MPEG-TS format only.

If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the target maximum duration of each segment in seconds. For HLSv3 format playlists, each media segment is stored in a separate .ts file. For HLSv4, MPEG-DASH, and Smooth playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration, though individual segments might be shorter or longer.

The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration.

Elastic Transcoder creates an output-specific playlist for each output HLS output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys of the associated playlist.

" }, "Status":{ "shape":"JobStatus", "documentation":"

The status of one output in a job. If you specified only one output for the job, Outputs:Status is always the same as Job:Status. If you specified more than one output:

  • Job:Status and Outputs:Status for all of the outputs is Submitted until Elastic Transcoder starts to process the first output.

  • When Elastic Transcoder starts to process the first output, Outputs:Status for that output and Job:Status both change to Progressing. For each output, the value of Outputs:Status remains Submitted until Elastic Transcoder starts to process the output.

  • Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error.

  • When all of the outputs reach a terminal status, Job:Status changes to Complete only if Outputs:Status for all of the outputs is Complete. If Outputs:Status for one or more outputs is Error, the terminal status for Job:Status is also Error.

The value of Status is one of the following: Submitted, Progressing, Complete, Canceled, or Error.

" }, "StatusDetail":{ "shape":"Description", "documentation":"

Information that further explains Status.

" }, "Duration":{ "shape":"NullableLong", "documentation":"

Duration of the output file, in seconds.

" }, "Width":{ "shape":"NullableInteger", "documentation":"

Specifies the width of the output file in pixels.

" }, "Height":{ "shape":"NullableInteger", "documentation":"

Height of the output file, in pixels.

" }, "FrameRate":{ "shape":"FloatString", "documentation":"

Frame rate of the output file, in frames per second.

" }, "FileSize":{ "shape":"NullableLong", "documentation":"

File size of the output file, in bytes.

" }, "DurationMillis":{ "shape":"NullableLong", "documentation":"

Duration of the output file, in milliseconds.

" }, "Watermarks":{ "shape":"JobWatermarks", "documentation":"

Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset that you specify in Preset for the current output.

Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add covers the first one, the third one covers the second, and the fourth one covers the third.

" }, "AlbumArt":{ "shape":"JobAlbumArt", "documentation":"

The album art to be associated with the output file, if any.

" }, "Composition":{ "shape":"Composition", "documentation":"

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.

", "deprecated":true }, "Captions":{ "shape":"Captions", "documentation":"

You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

  • Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.

    Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text

    Valid outputs include: mov-text

    Elastic Transcoder supports a maximum of one embedded format per output.

  • Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.

    Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt

    Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.

If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.

To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.

For more information on embedded files, see the Subtitles Wikipedia page.

For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

" }, "Encryption":{ "shape":"Encryption", "documentation":"

The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder writes an unencrypted file to your Amazon S3 bucket.

" }, "AppliedColorSpaceConversion":{ "shape":"String", "documentation":"

If Elastic Transcoder used a preset with a ColorSpaceConversionMode to transcode the output file, the AppliedColorSpaceConversion parameter shows the conversion used. If no ColorSpaceConversionMode was defined in the preset, this parameter is not be included in the job response.

" } }, "documentation":"

Outputs recommended instead.

If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.

" }, "JobOutputs":{ "type":"list", "member":{"shape":"JobOutput"} }, "JobStatus":{ "type":"string", "pattern":"(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)" }, "JobWatermark":{ "type":"structure", "members":{ "PresetWatermarkId":{ "shape":"PresetWatermarkId", "documentation":"

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use.

" }, "InputKey":{ "shape":"WatermarkKey", "documentation":"

The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by Pipeline; the Input Bucket object in that pipeline identifies the bucket.

If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

" }, "Encryption":{ "shape":"Encryption", "documentation":"

The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks.

" } }, "documentation":"

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.

" }, "JobWatermarks":{ "type":"list", "member":{"shape":"JobWatermark"} }, "Jobs":{ "type":"list", "member":{"shape":"Job"} }, "JpgOrPng":{ "type":"string", "pattern":"(^jpg$)|(^png$)" }, "Key":{ "type":"string", "max":255, "min":1 }, "KeyArn":{ "type":"string", "max":255, "min":0 }, "KeyIdGuid":{ "type":"string", "pattern":"(^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)|(^[0-9A-Fa-f]{32}$)" }, "KeyStoragePolicy":{ "type":"string", "pattern":"(^NoStore$)|(^WithVariantPlaylists$)" }, "KeyframesMaxDist":{ "type":"string", "pattern":"^\\d{1,6}$" }, "LimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed.

", "error":{"httpStatusCode":429}, "exception":true }, "ListJobsByPipelineRequest":{ "type":"structure", "required":["PipelineId"], "members":{ "PipelineId":{ "shape":"Id", "documentation":"

The ID of the pipeline for which you want to get job information.

", "location":"uri", "locationName":"PipelineId" }, "Ascending":{ "shape":"Ascending", "documentation":"

To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

", "location":"querystring", "locationName":"Ascending" }, "PageToken":{ "shape":"Id", "documentation":"

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

", "location":"querystring", "locationName":"PageToken" } }, "documentation":"

The ListJobsByPipelineRequest structure.

" }, "ListJobsByPipelineResponse":{ "type":"structure", "members":{ "Jobs":{ "shape":"Jobs", "documentation":"

An array of Job objects that are in the specified pipeline.

" }, "NextPageToken":{ "shape":"Id", "documentation":"

A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null.

" } }, "documentation":"

The ListJobsByPipelineResponse structure.

" }, "ListJobsByStatusRequest":{ "type":"structure", "required":["Status"], "members":{ "Status":{ "shape":"JobStatus", "documentation":"

To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error.

", "location":"uri", "locationName":"Status" }, "Ascending":{ "shape":"Ascending", "documentation":"

To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

", "location":"querystring", "locationName":"Ascending" }, "PageToken":{ "shape":"Id", "documentation":"

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

", "location":"querystring", "locationName":"PageToken" } }, "documentation":"

The ListJobsByStatusRequest structure.

" }, "ListJobsByStatusResponse":{ "type":"structure", "members":{ "Jobs":{ "shape":"Jobs", "documentation":"

An array of Job objects that have the specified status.

" }, "NextPageToken":{ "shape":"Id", "documentation":"

A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null.

" } }, "documentation":"

The ListJobsByStatusResponse structure.

" }, "ListPipelinesRequest":{ "type":"structure", "members":{ "Ascending":{ "shape":"Ascending", "documentation":"

To list pipelines in chronological order by the date and time that they were created, enter true. To list pipelines in reverse chronological order, enter false.

", "location":"querystring", "locationName":"Ascending" }, "PageToken":{ "shape":"Id", "documentation":"

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

", "location":"querystring", "locationName":"PageToken" } }, "documentation":"

The ListPipelineRequest structure.

" }, "ListPipelinesResponse":{ "type":"structure", "members":{ "Pipelines":{ "shape":"Pipelines", "documentation":"

An array of Pipeline objects.

" }, "NextPageToken":{ "shape":"Id", "documentation":"

A value that you use to access the second and subsequent pages of results, if any. When the pipelines fit on one page or when you've reached the last page of results, the value of NextPageToken is null.

" } }, "documentation":"

A list of the pipelines associated with the current AWS account.

" }, "ListPresetsRequest":{ "type":"structure", "members":{ "Ascending":{ "shape":"Ascending", "documentation":"

To list presets in chronological order by the date and time that they were created, enter true. To list presets in reverse chronological order, enter false.

", "location":"querystring", "locationName":"Ascending" }, "PageToken":{ "shape":"Id", "documentation":"

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

", "location":"querystring", "locationName":"PageToken" } }, "documentation":"

The ListPresetsRequest structure.

" }, "ListPresetsResponse":{ "type":"structure", "members":{ "Presets":{ "shape":"Presets", "documentation":"

An array of Preset objects.

" }, "NextPageToken":{ "shape":"Id", "documentation":"

A value that you use to access the second and subsequent pages of results, if any. When the presets fit on one page or when you've reached the last page of results, the value of NextPageToken is null.

" } }, "documentation":"

The ListPresetsResponse structure.

" }, "LongKey":{ "type":"string", "max":1024, "min":1 }, "MaxFrameRate":{ "type":"string", "pattern":"(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)" }, "MergePolicy":{ "type":"string", "pattern":"(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)" }, "Name":{ "type":"string", "max":40, "min":1 }, "NonEmptyBase64EncodedString":{ "type":"string", "pattern":"(^(?:[A-Za-z0-9\\+/]{4})*(?:[A-Za-z0-9\\+/]{2}==|[A-Za-z0-9\\+/]{3}=)?$)" }, "Notifications":{ "type":"structure", "members":{ "Progressing":{ "shape":"SnsTopic", "documentation":"

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

" }, "Completed":{ "shape":"SnsTopic", "documentation":"

The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

" }, "Warning":{ "shape":"SnsTopic", "documentation":"

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

" }, "Error":{ "shape":"SnsTopic", "documentation":"

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

" } }, "documentation":"

The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

" }, "NullableInteger":{"type":"integer"}, "NullableLong":{"type":"long"}, "OneTo512String":{ "type":"string", "max":512, "min":1 }, "Opacity":{ "type":"string", "pattern":"^\\d{1,3}(\\.\\d{0,20})?$" }, "OutputKeys":{ "type":"list", "member":{"shape":"Key"}, "max":30 }, "PaddingPolicy":{ "type":"string", "pattern":"(^Pad$)|(^NoPad$)" }, "Permission":{ "type":"structure", "members":{ "GranteeType":{ "shape":"GranteeType", "documentation":"

The type of value that appears in the Grantee object:

  • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

    A canonical user ID is not the same as an AWS account number.

  • Email: The registered email address of an AWS account.

  • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

" }, "Grantee":{ "shape":"Grantee", "documentation":"

The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.

" }, "Access":{ "shape":"AccessControls", "documentation":"

The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

  • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

" } }, "documentation":"

The Permission structure.

" }, "Permissions":{ "type":"list", "member":{"shape":"Permission"}, "max":30 }, "Pipeline":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

" }, "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the pipeline.

" }, "Name":{ "shape":"Name", "documentation":"

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

" }, "Status":{ "shape":"PipelineStatus", "documentation":"

The current status of the pipeline:

  • Active: The pipeline is processing jobs.

  • Paused: The pipeline is not currently processing jobs.

" }, "InputBucket":{ "shape":"BucketName", "documentation":"

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.

" }, "OutputBucket":{ "shape":"BucketName", "documentation":"

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.

" }, "Role":{ "shape":"Role", "documentation":"

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

" }, "AwsKmsKeyArn":{ "shape":"KeyArn", "documentation":"

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

If you use either S3 or S3-AWS-KMS as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of AES-PKCS7, AES-CTR, or AES-GCM.

" }, "Notifications":{ "shape":"Notifications", "documentation":"

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

  • Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

  • Completed (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

  • Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

  • Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

" }, "ContentConfig":{ "shape":"PipelineOutputConfig", "documentation":"

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have.

    • GranteeType: The type of value that appears in the Grantee object:

      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

      • Email: The registered email address of an AWS account.

      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to transcoded files and playlists.

    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

      • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

" }, "ThumbnailConfig":{ "shape":"PipelineOutputConfig", "documentation":"

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have.

    • GranteeType: The type of value that appears in the Grantee object:

      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

        A canonical user ID is not the same as an AWS account number.

      • Email: The registered email address of an AWS account.

      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to thumbnail files.

    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

      • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

" } }, "documentation":"

The pipeline (queue) that is used to manage jobs.

" }, "PipelineOutputConfig":{ "type":"structure", "members":{ "Bucket":{ "shape":"BucketName", "documentation":"

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true:

  • You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.

  • You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.

  • You do not want to specify the permissions that Elastic Transcoder grants to the files.

  • You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.

If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead.

" }, "StorageClass":{ "shape":"StorageClass", "documentation":"

The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

" }, "Permissions":{ "shape":"Permissions", "documentation":"

Optional. The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user.

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group.

" } }, "documentation":"

The PipelineOutputConfig structure.

" }, "PipelineStatus":{ "type":"string", "pattern":"(^Active$)|(^Paused$)" }, "Pipelines":{ "type":"list", "member":{"shape":"Pipeline"} }, "PixelsOrPercent":{ "type":"string", "pattern":"(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)" }, "PlayReadyDrm":{ "type":"structure", "members":{ "Format":{ "shape":"PlayReadyDrmFormatString", "documentation":"

The type of DRM, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

" }, "Key":{ "shape":"NonEmptyBase64EncodedString", "documentation":"

The DRM key for your file, provided by your DRM license provider. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded:

128, 192, or 256.

The key must also be encrypted by using AWS KMS.

" }, "KeyMd5":{ "shape":"NonEmptyBase64EncodedString", "documentation":"

The MD5 digest of the key used for DRM on your file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded.

" }, "KeyId":{ "shape":"KeyIdGuid", "documentation":"

The ID for your DRM key, so that your DRM license provider knows which key to provide.

The key ID must be provided in big endian, and Elastic Transcoder converts it to little endian before inserting it into the PlayReady DRM headers. If you are unsure whether your license server provides your key ID in big or little endian, check with your DRM provider.

" }, "InitializationVector":{ "shape":"ZeroTo255String", "documentation":"

The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your files. The initialization vector must be base64-encoded, and it must be exactly 8 bytes long before being base64-encoded. If no initialization vector is provided, Elastic Transcoder generates one for you.

" }, "LicenseAcquisitionUrl":{ "shape":"OneTo512String", "documentation":"

The location of the license key required to play DRM content. The URL must be an absolute path, and is referenced by the PlayReady header. The PlayReady header is referenced in the protection header of the client manifest for Smooth Streaming outputs, and in the EXT-X-DXDRM and EXT-XDXDRMINFO metadata tags for HLS playlist outputs. An example URL looks like this: https://www.example.com/exampleKey/

" } }, "documentation":"

The PlayReady DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

PlayReady DRM encrypts your media files using AES-CTR encryption.

If you use DRM for an HLSv3 playlist, your outputs must have a master playlist.

" }, "PlayReadyDrmFormatString":{ "type":"string", "pattern":"(^microsoft$)|(^discretix-3.0$)" }, "Playlist":{ "type":"structure", "members":{ "Name":{ "shape":"Filename", "documentation":"

The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a / character, the section of the name before the last / must be identical for all Name objects. If you create more than one master playlist, the values of all Name objects must be unique.

Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth playlists). If you include a file extension in Name, the file name will have two extensions.

" }, "Format":{ "shape":"PlaylistFormat", "documentation":"

The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth.

" }, "OutputKeys":{ "shape":"OutputKeys", "documentation":"

For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.

  • If your output is not HLS or does not have a segment duration set, the name of the output file is a concatenation of OutputKeyPrefix and Outputs:Key:

    OutputKeyPrefixOutputs:Key

  • If your output is HLSv3 and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of .m3u8, and a series of .ts files that include a five-digit sequential counter beginning with 00000:

    OutputKeyPrefixOutputs:Key.m3u8

    OutputKeyPrefixOutputs:Key00000.ts

  • If your output is HLSv4, has a segment duration set, and is included in an HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file extension of _v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of _iframe.m3u8:

    OutputKeyPrefixOutputs:Key_v4.m3u8

    OutputKeyPrefixOutputs:Key_iframe.m3u8

    OutputKeyPrefixOutputs:Key.ts

Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.

If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For Smooth playlists, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs.

" }, "HlsContentProtection":{ "shape":"HlsContentProtection", "documentation":"

The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

" }, "PlayReadyDrm":{ "shape":"PlayReadyDrm", "documentation":"

The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

" }, "Status":{ "shape":"JobStatus", "documentation":"

The status of the job with which the playlist is associated.

" }, "StatusDetail":{ "shape":"Description", "documentation":"

Information that further explains the status.

" } }, "documentation":"

Use Only for Fragmented MP4 or MPEG-TS Outputs. If you specify a preset for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create. We recommend that you create only one master playlist per output format. The maximum number of master playlists in a job is 30.

" }, "PlaylistFormat":{ "type":"string", "pattern":"(^HLSv3$)|(^HLSv4$)|(^Smooth$)|(^MPEG-DASH$)" }, "Playlists":{ "type":"list", "member":{"shape":"Playlist"} }, "Preset":{ "type":"structure", "members":{ "Id":{ "shape":"Id", "documentation":"

Identifier for the new preset. You use this value to get settings for the preset or to delete it.

" }, "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) for the preset.

" }, "Name":{ "shape":"Name", "documentation":"

The name of the preset.

" }, "Description":{ "shape":"Description", "documentation":"

A description of the preset.

" }, "Container":{ "shape":"PresetContainer", "documentation":"

The container type for the output file. Valid values include flac, flv, fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm.

" }, "Audio":{ "shape":"AudioParameters", "documentation":"

A section of the response body that provides information about the audio preset values.

" }, "Video":{ "shape":"VideoParameters", "documentation":"

A section of the response body that provides information about the video preset values.

" }, "Thumbnails":{ "shape":"Thumbnails", "documentation":"

A section of the response body that provides information about the thumbnail preset values, if any.

" }, "Type":{ "shape":"PresetType", "documentation":"

Whether the preset is a default preset provided by Elastic Transcoder (System) or a preset that you have defined (Custom).

" } }, "documentation":"

Presets are templates that contain most of the settings for transcoding media files from one format to another. Elastic Transcoder includes some default presets for common formats, for example, several iPod and iPhone versions. You can also create your own presets for formats that aren't included among the default presets. You specify which preset you want to use when you create a job.

" }, "PresetContainer":{ "type":"string", "pattern":"(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^flac$)|(^oga$)|(^ogg$)|(^fmp4$)|(^mpg$)|(^flv$)|(^gif$)|(^mxf$)|(^wav$)" }, "PresetType":{ "type":"string", "pattern":"(^System$)|(^Custom$)" }, "PresetWatermark":{ "type":"structure", "members":{ "Id":{ "shape":"PresetWatermarkId", "documentation":"

A unique identifier for the settings for one watermark. The value of Id can be up to 40 characters long.

" }, "MaxWidth":{ "shape":"PixelsOrPercent", "documentation":"

The maximum width of the watermark in one of the following formats:

  • number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of MaxWidth.

  • integer percentage (%): The range of valid values is 0 to 100. Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation.

    If you specify the value in pixels, it must be less than or equal to the value of MaxWidth.

" }, "MaxHeight":{ "shape":"PixelsOrPercent", "documentation":"

The maximum height of the watermark in one of the following formats:

  • number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of MaxHeight.

  • integer percentage (%): The range of valid values is 0 to 100. Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation.

If you specify the value in pixels, it must be less than or equal to the value of MaxHeight.

" }, "SizingPolicy":{ "shape":"WatermarkSizingPolicy", "documentation":"

A value that controls scaling of the watermark:

  • Fit: Elastic Transcoder scales the watermark so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value.

  • Stretch: Elastic Transcoder stretches the watermark to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the watermark and the values of MaxWidth and MaxHeight are different, the watermark will be distorted.

  • ShrinkToFit: Elastic Transcoder scales the watermark down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the watermark up.

" }, "HorizontalAlign":{ "shape":"HorizontalAlign", "documentation":"

The horizontal position of the watermark unless you specify a non-zero value for HorizontalOffset:

  • Left: The left edge of the watermark is aligned with the left border of the video.

  • Right: The right edge of the watermark is aligned with the right border of the video.

  • Center: The watermark is centered between the left and right borders.

" }, "HorizontalOffset":{ "shape":"PixelsOrPercent", "documentation":"

The amount by which you want the horizontal position of the watermark to be offset from the position specified by HorizontalAlign:

  • number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of MaxWidth.

  • integer percentage (%): The range of valid values is 0 to 100.

For example, if you specify Left for HorizontalAlign and 5px for HorizontalOffset, the left side of the watermark appears 5 pixels from the left border of the output video.

HorizontalOffset is only valid when the value of HorizontalAlign is Left or Right. If you specify an offset that causes the watermark to extend beyond the left or right border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.

Use the value of Target to specify whether you want to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation.

" }, "VerticalAlign":{ "shape":"VerticalAlign", "documentation":"

The vertical position of the watermark unless you specify a non-zero value for VerticalOffset:

  • Top: The top edge of the watermark is aligned with the top border of the video.

  • Bottom: The bottom edge of the watermark is aligned with the bottom border of the video.

  • Center: The watermark is centered between the top and bottom borders.

" }, "VerticalOffset":{ "shape":"PixelsOrPercent", "documentation":"

VerticalOffset

The amount by which you want the vertical position of the watermark to be offset from the position specified by VerticalAlign:

  • number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of MaxHeight.

  • integer percentage (%): The range of valid values is 0 to 100.

For example, if you specify Top for VerticalAlign and 5px for VerticalOffset, the top of the watermark appears 5 pixels from the top border of the output video.

VerticalOffset is only valid when the value of VerticalAlign is Top or Bottom.

If you specify an offset that causes the watermark to extend beyond the top or bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.

Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation.

" }, "Opacity":{ "shape":"Opacity", "documentation":"

A percentage that indicates how much you want a watermark to obscure the video in the location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the watermark completely obscures the video in the specified location). The datatype of Opacity is float.

Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent portion of the video appears as if you had specified a value of 0 for Opacity. The .jpg file format doesn't support transparency.

" }, "Target":{ "shape":"Target", "documentation":"

A value that determines how Elastic Transcoder interprets values that you specified for HorizontalOffset, VerticalOffset, MaxWidth, and MaxHeight:

  • Content: HorizontalOffset and VerticalOffset values are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any. In addition, MaxWidth and MaxHeight, if specified as a percentage, are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any.

  • Frame: HorizontalOffset and VerticalOffset values are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any. In addition, MaxWidth and MaxHeight, if specified as a percentage, are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any.

" } }, "documentation":"

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video.

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.

When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.

" }, "PresetWatermarkId":{ "type":"string", "max":40, "min":1 }, "PresetWatermarks":{ "type":"list", "member":{"shape":"PresetWatermark"} }, "Presets":{ "type":"list", "member":{"shape":"Preset"} }, "ReadJobRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier of the job for which you want to get detailed information.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The ReadJobRequest structure.

" }, "ReadJobResponse":{ "type":"structure", "members":{ "Job":{ "shape":"Job", "documentation":"

A section of the response body that provides information about the job.

" } }, "documentation":"

The ReadJobResponse structure.

" }, "ReadPipelineRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier of the pipeline to read.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The ReadPipelineRequest structure.

" }, "ReadPipelineResponse":{ "type":"structure", "members":{ "Pipeline":{ "shape":"Pipeline", "documentation":"

A section of the response body that provides information about the pipeline.

" }, "Warnings":{ "shape":"Warnings", "documentation":"

Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.

Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.

" } }, "documentation":"

The ReadPipelineResponse structure.

" }, "ReadPresetRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier of the preset for which you want to get detailed information.

", "location":"uri", "locationName":"Id" } }, "documentation":"

The ReadPresetRequest structure.

" }, "ReadPresetResponse":{ "type":"structure", "members":{ "Preset":{ "shape":"Preset", "documentation":"

A section of the response body that provides information about the preset.

" } }, "documentation":"

The ReadPresetResponse structure.

" }, "Resolution":{ "type":"string", "pattern":"(^auto$)|(^\\d{1,5}x\\d{1,5}$)" }, "ResourceInUseException":{ "type":"structure", "members":{ }, "documentation":"

The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.

", "error":{"httpStatusCode":409}, "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

", "error":{"httpStatusCode":404}, "exception":true }, "Role":{ "type":"string", "pattern":"^arn:aws:iam::\\w{12}:role/.+$" }, "Rotate":{ "type":"string", "pattern":"(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)" }, "SizingPolicy":{ "type":"string", "pattern":"(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)" }, "SnsTopic":{ "type":"string", "pattern":"(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)" }, "SnsTopics":{ "type":"list", "member":{"shape":"SnsTopic"}, "max":30 }, "StorageClass":{ "type":"string", "pattern":"(^ReducedRedundancy$)|(^Standard$)" }, "String":{"type":"string"}, "Success":{ "type":"string", "pattern":"(^true$)|(^false$)" }, "Target":{ "type":"string", "pattern":"(^Content$)|(^Frame$)" }, "TestRoleRequest":{ "type":"structure", "required":[ "Role", "InputBucket", "OutputBucket", "Topics" ], "members":{ "Role":{ "shape":"Role", "documentation":"

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.

" }, "InputBucket":{ "shape":"BucketName", "documentation":"

The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.

" }, "OutputBucket":{ "shape":"BucketName", "documentation":"

The Amazon S3 bucket that Elastic Transcoder writes transcoded media files to. The action attempts to read from this bucket.

" }, "Topics":{ "shape":"SnsTopics", "documentation":"

The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.

" } }, "documentation":"

The TestRoleRequest structure.

", "deprecated":true }, "TestRoleResponse":{ "type":"structure", "members":{ "Success":{ "shape":"Success", "documentation":"

If the operation is successful, this value is true; otherwise, the value is false.

" }, "Messages":{ "shape":"ExceptionMessages", "documentation":"

If the Success element contains false, this value is an array of one or more error messages that were generated during the test process.

" } }, "documentation":"

The TestRoleResponse structure.

", "deprecated":true }, "ThumbnailPattern":{ "type":"string", "pattern":"(^$)|(^.*\\{count\\}.*$)" }, "ThumbnailResolution":{ "type":"string", "pattern":"^\\d{1,5}x\\d{1,5}$" }, "Thumbnails":{ "type":"structure", "members":{ "Format":{ "shape":"JpgOrPng", "documentation":"

The format of thumbnails, if any. Valid values are jpg and png.

You specify whether you want Elastic Transcoder to create thumbnails when you create a job.

" }, "Interval":{ "shape":"Digits", "documentation":"

The approximate number of seconds between thumbnails. Specify an integer value.

" }, "Resolution":{ "shape":"ThumbnailResolution", "documentation":"

To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The width and height of thumbnail files in pixels. Specify a value in the format width x height where both values are even integers. The values cannot exceed the width and height that you specified in the Video:Resolution object.

" }, "AspectRatio":{ "shape":"AspectRatio", "documentation":"

To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The aspect ratio of thumbnails. Valid values include:

auto, 1:1, 4:3, 3:2, 16:9

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file.

" }, "MaxWidth":{ "shape":"DigitsOrAuto", "documentation":"

The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.

" }, "MaxHeight":{ "shape":"DigitsOrAuto", "documentation":"

The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072.

" }, "SizingPolicy":{ "shape":"SizingPolicy", "documentation":"

Specify one of the following values to control scaling of thumbnails:

  • Fit: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value.

  • Fill: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value.

  • Stretch: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnail MaxWidth and MaxHeight settings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted.

  • Keep: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnail MaxWidth and MaxHeight settings, Elastic Transcoder crops the thumbnails.

  • ShrinkToFit: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnail MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.

  • ShrinkToFill: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.

" }, "PaddingPolicy":{ "shape":"PaddingPolicy", "documentation":"

When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail MaxWidth and MaxHeight settings.

" } }, "documentation":"

Thumbnails for videos.

" }, "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})?$)" }, "TimeOffset":{ "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})?$)" }, "TimeSpan":{ "type":"structure", "members":{ "StartTime":{ "shape":"Time", "documentation":"

The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.

" }, "Duration":{ "shape":"Time", "documentation":"

The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder creates an output file from StartTime to the end of the file.

If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the file and returns a warning message.

" } }, "documentation":"

Settings that determine when a clip begins and how long it lasts.

" }, "Timing":{ "type":"structure", "members":{ "SubmitTimeMillis":{ "shape":"NullableLong", "documentation":"

The time the job was submitted to Elastic Transcoder, in epoch milliseconds.

" }, "StartTimeMillis":{ "shape":"NullableLong", "documentation":"

The time the job began transcoding, in epoch milliseconds.

" }, "FinishTimeMillis":{ "shape":"NullableLong", "documentation":"

The time the job finished transcoding, in epoch milliseconds.

" } }, "documentation":"

Details about the timing of a job.

" }, "UpdatePipelineNotificationsRequest":{ "type":"structure", "required":[ "Id", "Notifications" ], "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier of the pipeline for which you want to change notification settings.

", "location":"uri", "locationName":"Id" }, "Notifications":{ "shape":"Notifications", "documentation":"

The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

  • Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

  • Completed: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.

  • Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.

  • Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.

" } }, "documentation":"

The UpdatePipelineNotificationsRequest structure.

" }, "UpdatePipelineNotificationsResponse":{ "type":"structure", "members":{ "Pipeline":{ "shape":"Pipeline", "documentation":"

A section of the response body that provides information about the pipeline associated with this notification.

" } }, "documentation":"

The UpdatePipelineNotificationsResponse structure.

" }, "UpdatePipelineRequest":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"Id", "documentation":"

The ID of the pipeline that you want to update.

", "location":"uri", "locationName":"Id" }, "Name":{ "shape":"Name", "documentation":"

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

" }, "InputBucket":{ "shape":"BucketName", "documentation":"

The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks.

" }, "Role":{ "shape":"Role", "documentation":"

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for this pipeline.

" }, "AwsKmsKeyArn":{ "shape":"KeyArn", "documentation":"

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

If you use either S3 or S3-AWS-KMS as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of AES-PKCS7, AES-CTR, or AES-GCM.

" }, "Notifications":{ "shape":"Notifications", "documentation":"

The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

  • Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

  • Completed: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.

  • Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.

  • Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.

" }, "ContentConfig":{ "shape":"PipelineOutputConfig", "documentation":"

The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

  • Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

  • Grantee Type: Specify the type of value that appears in the Grantee object:

    • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content.

      A canonical user ID is not the same as an AWS account number.

    • Email: The value in the Grantee object is the registered email address of an AWS account.

    • Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

  • Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group

  • Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include:

    • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

" }, "ThumbnailConfig":{ "shape":"PipelineOutputConfig", "documentation":"

The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to create thumbnails.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

  • Permissions (Optional): The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

  • GranteeType: Specify the type of value that appears in the Grantee object:

    • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

      A canonical user ID is not the same as an AWS account number.

    • Email: The value in the Grantee object is the registered email address of an AWS account.

    • Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

  • Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.

  • Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:

    • READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

    • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

    • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

" } }, "documentation":"

The UpdatePipelineRequest structure.

" }, "UpdatePipelineResponse":{ "type":"structure", "members":{ "Pipeline":{ "shape":"Pipeline", "documentation":"

The pipeline updated by this UpdatePipelineResponse call.

" }, "Warnings":{ "shape":"Warnings", "documentation":"

Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.

Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.

" } }, "documentation":"

When you update a pipeline, Elastic Transcoder returns the values that you specified in the request.

" }, "UpdatePipelineStatusRequest":{ "type":"structure", "required":[ "Id", "Status" ], "members":{ "Id":{ "shape":"Id", "documentation":"

The identifier of the pipeline to update.

", "location":"uri", "locationName":"Id" }, "Status":{ "shape":"PipelineStatus", "documentation":"

The desired status of the pipeline:

  • Active: The pipeline is processing jobs.

  • Paused: The pipeline is not currently processing jobs.

" } }, "documentation":"

The UpdatePipelineStatusRequest structure.

" }, "UpdatePipelineStatusResponse":{ "type":"structure", "members":{ "Pipeline":{ "shape":"Pipeline", "documentation":"

A section of the response body that provides information about the pipeline.

" } }, "documentation":"

When you update status for a pipeline, Elastic Transcoder returns the values that you specified in the request.

" }, "UserMetadata":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "ValidationException":{ "type":"structure", "members":{ }, "documentation":"

One or more required parameter values were not provided in the request.

", "error":{"httpStatusCode":400}, "exception":true }, "VerticalAlign":{ "type":"string", "pattern":"(^Top$)|(^Bottom$)|(^Center$)" }, "VideoBitRate":{ "type":"string", "pattern":"(^\\d{2,5}$)|(^auto$)" }, "VideoCodec":{ "type":"string", "pattern":"(^H\\.264$)|(^vp8$)|(^vp9$)|(^mpeg2$)|(^gif$)" }, "VideoParameters":{ "type":"structure", "members":{ "Codec":{ "shape":"VideoCodec", "documentation":"

The video codec for the output file. Valid values include gif, H.264, mpeg2, vp8, and vp9. You can only specify vp8 and vp9 when the container type is webm, gif when the container type is gif, and mpeg2 when the container type is mpg.

" }, "CodecOptions":{ "shape":"CodecOptions", "documentation":"

Profile (H.264/VP8/VP9 Only)

The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:

  • baseline: The profile most commonly used for videoconferencing and for mobile applications.

  • main: The profile used for standard-definition digital TV broadcasts.

  • high: The profile used for high-definition digital TV broadcasts and for Blu-ray discs.

Level (H.264 Only)

The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels:

1, 1b, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2, 4, 4.1

MaxReferenceFrames (H.264 Only)

Applicable only when the value of Video:Codec is H.264. The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following:

Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels * Height in pixels)), 16)

where Width in pixels and Height in pixels represent either MaxWidth and MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends on the value of the Level object. See the list below. (A macroblock is a block of pixels measuring 16x16.)

  • 1 - 396

  • 1b - 396

  • 1.1 - 900

  • 1.2 - 2376

  • 1.3 - 2376

  • 2 - 2376

  • 2.1 - 4752

  • 2.2 - 8100

  • 3 - 8100

  • 3.1 - 18000

  • 3.2 - 20480

  • 4 - 32768

  • 4.1 - 32768

MaxBitRate (Optional, H.264/MPEG2/VP8/VP9 only)

The maximum number of bits per second in a video buffer; the size of the buffer is specified by BufferSize. Specify a value between 16 and 62,500. You can reduce the bandwidth required to stream a video by reducing the maximum bit rate, but this also reduces the quality of the video.

BufferSize (Optional, H.264/MPEG2/VP8/VP9 only)

The maximum number of bits in any x seconds of the output video. This window is commonly 10 seconds, the standard segment duration when you're using FMP4 or MPEG-TS for the container type of the output video. Specify an integer greater than 0. If you specify MaxBitRate and omit BufferSize, Elastic Transcoder sets BufferSize to 10 times the value of MaxBitRate.

InterlacedMode (Optional, H.264/MPEG2 Only)

The interlace mode for the output video.

Interlaced video is used to double the perceived frame rate for a video by interlacing two fields (one field on every other line, the other field on the other lines) so that the human eye registers multiple pictures per frame. Interlacing reduces the bandwidth required for transmitting a video, but can result in blurred images and flickering.

Valid values include Progressive (no interlacing, top to bottom), TopFirst (top field first), BottomFirst (bottom field first), and Auto.

If InterlaceMode is not specified, Elastic Transcoder uses Progressive for the output. If Auto is specified, Elastic Transcoder interlaces the output.

ColorSpaceConversionMode (Optional, H.264/MPEG2 Only)

The color space conversion Elastic Transcoder applies to the output video. Color spaces are the algorithms used by the computer to store information about how to render color. Bt.601 is the standard for standard definition video, while Bt.709 is the standard for high definition video.

Valid values include None, Bt709toBt601, Bt601toBt709, and Auto.

If you chose Auto for ColorSpaceConversionMode and your output is interlaced, your frame rate is one of 23.97, 24, 25, 29.97, 50, or 60, your SegmentDuration is null, and you are using one of the resolution changes from the list below, Elastic Transcoder applies the following color space conversions:

  • Standard to HD, 720x480 to 1920x1080 - Elastic Transcoder applies Bt601ToBt709

  • Standard to HD, 720x576 to 1920x1080 - Elastic Transcoder applies Bt601ToBt709

  • HD to Standard, 1920x1080 to 720x480 - Elastic Transcoder applies Bt709ToBt601

  • HD to Standard, 1920x1080 to 720x576 - Elastic Transcoder applies Bt709ToBt601

Elastic Transcoder may change the behavior of the ColorspaceConversionMode Auto mode in the future. All outputs in a playlist must use the same ColorSpaceConversionMode.

If you do not specify a ColorSpaceConversionMode, Elastic Transcoder does not change the color space of a file. If you are unsure what ColorSpaceConversionMode was applied to your output file, you can check the AppliedColorSpaceConversion parameter included in your job response. If your job does not have an AppliedColorSpaceConversion in its response, no ColorSpaceConversionMode was applied.

ChromaSubsampling

The sampling pattern for the chroma (color) channels of the output video. Valid values include yuv420p and yuv422p.

yuv420p samples the chroma information of every other horizontal and every other vertical line, yuv422p samples the color information of every horizontal line and every other vertical line.

LoopCount (Gif Only)

The number of times you want the output gif to loop. Valid values include Infinite and integers between 0 and 100, inclusive.

" }, "KeyframesMaxDist":{ "shape":"KeyframesMaxDist", "documentation":"

Applicable only when the value of Video:Codec is one of H.264, MPEG2, or VP8.

The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a string; valid values are between 1 (every frame is a key frame) and 100000, inclusive. A higher value results in higher compression but may also discernibly decrease video quality.

For Smooth outputs, the FrameRate must have a constant ratio to the KeyframesMaxDist. This allows Smooth playlists to switch between different quality levels while the file is being played.

For example, an input file can have a FrameRate of 30 with a KeyframesMaxDist of 90. The output file then needs to have a ratio of 1:3. Valid outputs would have FrameRate of 30, 25, and 10, and KeyframesMaxDist of 90, 75, and 30, respectively.

Alternately, this can be achieved by setting FrameRate to auto and having the same values for MaxFrameRate and KeyframesMaxDist.

" }, "FixedGOP":{ "shape":"FixedGOP", "documentation":"

Applicable only when the value of Video:Codec is one of H.264, MPEG2, or VP8.

Whether to use a fixed value for FixedGOP. Valid values are true and false:

  • true: Elastic Transcoder uses the value of KeyframesMaxDist for the distance between key frames (the number of frames in a group of pictures, or GOP).

  • false: The distance between key frames can vary.

FixedGOP must be set to true for fmp4 containers.

" }, "BitRate":{ "shape":"VideoBitRate", "documentation":"

The bit rate of the video stream in the output file, in kilobits/second. Valid values depend on the values of Level and Profile. If you specify auto, Elastic Transcoder uses the detected bit rate of the input source. If you specify a value other than auto, we recommend that you specify a value less than or equal to the maximum H.264-compliant value listed for your level and profile:

Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile)

  • 1 - 64 : 80

  • 1b - 128 : 160

  • 1.1 - 192 : 240

  • 1.2 - 384 : 480

  • 1.3 - 768 : 960

  • 2 - 2000 : 2500

  • 3 - 10000 : 12500

  • 3.1 - 14000 : 17500

  • 3.2 - 20000 : 25000

  • 4 - 20000 : 25000

  • 4.1 - 50000 : 62500

" }, "FrameRate":{ "shape":"FrameRate", "documentation":"

The frames per second for the video stream in the output file. Valid values include:

auto, 10, 15, 23.97, 24, 25, 29.97, 30, 60

If you specify auto, Elastic Transcoder uses the detected frame rate of the input source. If you specify a frame rate, we recommend that you perform the following calculation:

Frame rate = maximum recommended decoding speed in luma samples/second / (width in pixels * height in pixels)

where:

  • width in pixels and height in pixels represent the Resolution of the output video.

  • maximum recommended decoding speed in Luma samples/second is less than or equal to the maximum value listed in the following table, based on the value that you specified for Level.

The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed):

  • 1 - 380160

  • 1b - 380160

  • 1.1 - 76800

  • 1.2 - 1536000

  • 1.3 - 3041280

  • 2 - 3041280

  • 2.1 - 5068800

  • 2.2 - 5184000

  • 3 - 10368000

  • 3.1 - 27648000

  • 3.2 - 55296000

  • 4 - 62914560

  • 4.1 - 62914560

" }, "MaxFrameRate":{ "shape":"MaxFrameRate", "documentation":"

If you specify auto for FrameRate, Elastic Transcoder uses the frame rate of the input video for the frame rate of the output video. Specify the maximum frame rate that you want Elastic Transcoder to use when the frame rate of the input video is greater than the desired maximum frame rate of the output video. Valid values include: 10, 15, 23.97, 24, 25, 29.97, 30, 60.

" }, "Resolution":{ "shape":"Resolution", "documentation":"

To better control resolution and aspect ratio of output videos, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The width and height of the video in the output file, in pixels. Valid values are auto and width x height:

  • auto: Elastic Transcoder attempts to preserve the width and height of the input file, subject to the following rules.

  • width x height : The width and height of the output video in pixels.

Note the following about specifying the width and height:

  • The width must be an even integer between 128 and 4096, inclusive.

  • The height must be an even integer between 96 and 3072, inclusive.

  • If you specify a resolution that is less than the resolution of the input file, Elastic Transcoder rescales the output file to the lower resolution.

  • If you specify a resolution that is greater than the resolution of the input file, Elastic Transcoder rescales the output to the higher resolution.

  • We recommend that you specify a resolution for which the product of width and height is less than or equal to the applicable value in the following list (List - Max width x height value):

    • 1 - 25344

    • 1b - 25344

    • 1.1 - 101376

    • 1.2 - 101376

    • 1.3 - 101376

    • 2 - 101376

    • 2.1 - 202752

    • 2.2 - 404720

    • 3 - 404720

    • 3.1 - 921600

    • 3.2 - 1310720

    • 4 - 2097152

    • 4.1 - 2097152

" }, "AspectRatio":{ "shape":"AspectRatio", "documentation":"

To better control resolution and aspect ratio of output videos, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The display aspect ratio of the video in the output file. Valid values include:

auto, 1:1, 4:3, 3:2, 16:9

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the input file.

If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video.

" }, "MaxWidth":{ "shape":"DigitsOrAuto", "documentation":"

The maximum width of the output video in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 128 and 4096.

" }, "MaxHeight":{ "shape":"DigitsOrAuto", "documentation":"

The maximum height of the output video in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 96 and 3072.

" }, "DisplayAspectRatio":{ "shape":"AspectRatio", "documentation":"

The value that Elastic Transcoder adds to the metadata in the output file.

" }, "SizingPolicy":{ "shape":"SizingPolicy", "documentation":"

Specify one of the following values to control scaling of the output video:

  • Fit: Elastic Transcoder scales the output video so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value.

  • Fill: Elastic Transcoder scales the output video so it matches the value that you specified in either MaxWidth or MaxHeight and matches or exceeds the other value. Elastic Transcoder centers the output video and then crops it in the dimension (if any) that exceeds the maximum value.

  • Stretch: Elastic Transcoder stretches the output video to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the input video and the output video are different, the output video will be distorted.

  • Keep: Elastic Transcoder does not scale the output video. If either dimension of the input video exceeds the values that you specified for MaxWidth and MaxHeight, Elastic Transcoder crops the output video.

  • ShrinkToFit: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the video up.

  • ShrinkToFill: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale the video up.

" }, "PaddingPolicy":{ "shape":"PaddingPolicy", "documentation":"

When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of the output video to make the total size of the output video match the values that you specified for MaxWidth and MaxHeight.

" }, "Watermarks":{ "shape":"PresetWatermarks", "documentation":"

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video.

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.

When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.

" } }, "documentation":"

The VideoParameters structure.

" }, "Warning":{ "type":"structure", "members":{ "Code":{ "shape":"String", "documentation":"

The code of the cross-regional warning.

" }, "Message":{ "shape":"String", "documentation":"

The message explaining what resources are in a different region from the pipeline.

AWS KMS keys must be in the same region as the pipeline.

" } }, "documentation":"

Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.

Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.

" }, "Warnings":{ "type":"list", "member":{"shape":"Warning"} }, "WatermarkKey":{ "type":"string", "max":1024, "min":1, "pattern":"(^.{1,1020}.jpg$)|(^.{1,1019}.jpeg$)|(^.{1,1020}.png$)" }, "WatermarkSizingPolicy":{ "type":"string", "pattern":"(^Fit$)|(^Stretch$)|(^ShrinkToFit$)" }, "ZeroTo255String":{ "type":"string", "max":255, "min":0 }, "ZeroTo512String":{ "type":"string", "max":512, "min":0 } }, "documentation":"AWS Elastic Transcoder Service

The AWS Elastic Transcoder Service.

" } botocore-1.5.7/botocore/data/codecommit/0000777454262600001440000000000013042511307021256 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/codecommit/2015-04-13/0000777454262600001440000000000013042511307022307 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/codecommit/2015-04-13/paginators-1.json0000666454262600001440000000053213042511306025506 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListBranches": { "input_token": "nextToken", "output_token": "nextToken", "result_key": "branches" }, "ListRepositories": { "input_token": "nextToken", "output_token": "nextToken", "result_key": "repositories" } } }botocore-1.5.7/botocore/data/codecommit/2015-04-13/service-2.json0000666454262600001440000016640113042511306025010 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-04-13", "endpointPrefix":"codecommit", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"CodeCommit", "serviceFullName":"AWS CodeCommit", "signatureVersion":"v4", "targetPrefix":"CodeCommit_20150413", "uid":"codecommit-2015-04-13" }, "operations":{ "BatchGetRepositories":{ "name":"BatchGetRepositories", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"BatchGetRepositoriesInput"}, "output":{"shape":"BatchGetRepositoriesOutput"}, "errors":[ {"shape":"RepositoryNamesRequiredException"}, {"shape":"MaximumRepositoryNamesExceededException"}, {"shape":"InvalidRepositoryNameException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"} ], "documentation":"

Returns information about one or more repositories.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

" }, "CreateBranch":{ "name":"CreateBranch", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateBranchInput"}, "errors":[ {"shape":"RepositoryNameRequiredException"}, {"shape":"InvalidRepositoryNameException"}, {"shape":"RepositoryDoesNotExistException"}, {"shape":"BranchNameRequiredException"}, {"shape":"BranchNameExistsException"}, {"shape":"InvalidBranchNameException"}, {"shape":"CommitIdRequiredException"}, {"shape":"CommitDoesNotExistException"}, {"shape":"InvalidCommitIdException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"} ], "documentation":"

Creates a new branch in a repository and points the branch to a commit.

Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.

" }, "CreateRepository":{ "name":"CreateRepository", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRepositoryInput"}, "output":{"shape":"CreateRepositoryOutput"}, "errors":[ {"shape":"RepositoryNameExistsException"}, {"shape":"RepositoryNameRequiredException"}, {"shape":"InvalidRepositoryNameException"}, {"shape":"InvalidRepositoryDescriptionException"}, {"shape":"RepositoryLimitExceededException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"} ], "documentation":"

Creates a new, empty repository.

" }, "DeleteRepository":{ "name":"DeleteRepository", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRepositoryInput"}, "output":{"shape":"DeleteRepositoryOutput"}, "errors":[ {"shape":"RepositoryNameRequiredException"}, {"shape":"InvalidRepositoryNameException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"} ], "documentation":"

Deletes a repository. If a specified repository was already deleted, a null repository ID will be returned.

Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository will fail.

" }, "GetBlob":{ "name":"GetBlob", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetBlobInput"}, "output":{"shape":"GetBlobOutput"}, "errors":[ {"shape":"RepositoryNameRequiredException"}, {"shape":"InvalidRepositoryNameException"}, {"shape":"RepositoryDoesNotExistException"}, {"shape":"BlobIdRequiredException"}, {"shape":"InvalidBlobIdException"}, {"shape":"BlobIdDoesNotExistException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"}, {"shape":"FileTooLargeException"} ], "documentation":"

Returns the base-64 encoded content of an individual blob within a repository.

" }, "GetBranch":{ "name":"GetBranch", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetBranchInput"}, "output":{"shape":"GetBranchOutput"}, "errors":[ {"shape":"RepositoryNameRequiredException"}, {"shape":"RepositoryDoesNotExistException"}, {"shape":"InvalidRepositoryNameException"}, {"shape":"BranchNameRequiredException"}, {"shape":"InvalidBranchNameException"}, {"shape":"BranchDoesNotExistException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"} ], "documentation":"

Returns information about a repository branch, including its name and the last commit ID.

" }, "GetCommit":{ "name":"GetCommit", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCommitInput"}, "output":{"shape":"GetCommitOutput"}, "errors":[ {"shape":"RepositoryNameRequiredException"}, {"shape":"InvalidRepositoryNameException"}, {"shape":"RepositoryDoesNotExistException"}, {"shape":"CommitIdRequiredException"}, {"shape":"InvalidCommitIdException"}, {"shape":"CommitIdDoesNotExistException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"} ], "documentation":"

Returns information about a commit, including commit message and committer information.

" }, "GetDifferences":{ "name":"GetDifferences", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDifferencesInput"}, "output":{"shape":"GetDifferencesOutput"}, "errors":[ {"shape":"RepositoryNameRequiredException"}, {"shape":"RepositoryDoesNotExistException"}, {"shape":"InvalidRepositoryNameException"}, {"shape":"InvalidContinuationTokenException"}, {"shape":"InvalidMaxResultsException"}, {"shape":"InvalidCommitIdException"}, {"shape":"CommitRequiredException"}, {"shape":"InvalidCommitException"}, {"shape":"CommitDoesNotExistException"}, {"shape":"InvalidPathException"}, {"shape":"PathDoesNotExistException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"} ], "documentation":"

Returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified reference). Results can be limited to a specified path.

" }, "GetRepository":{ "name":"GetRepository", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRepositoryInput"}, "output":{"shape":"GetRepositoryOutput"}, "errors":[ {"shape":"RepositoryNameRequiredException"}, {"shape":"RepositoryDoesNotExistException"}, {"shape":"InvalidRepositoryNameException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"} ], "documentation":"

Returns information about a repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

" }, "GetRepositoryTriggers":{ "name":"GetRepositoryTriggers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRepositoryTriggersInput"}, "output":{"shape":"GetRepositoryTriggersOutput"}, "errors":[ {"shape":"RepositoryNameRequiredException"}, {"shape":"InvalidRepositoryNameException"}, {"shape":"RepositoryDoesNotExistException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"} ], "documentation":"

Gets information about triggers configured for a repository.

" }, "ListBranches":{ "name":"ListBranches", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListBranchesInput"}, "output":{"shape":"ListBranchesOutput"}, "errors":[ {"shape":"RepositoryNameRequiredException"}, {"shape":"RepositoryDoesNotExistException"}, {"shape":"InvalidRepositoryNameException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"}, {"shape":"InvalidContinuationTokenException"} ], "documentation":"

Gets information about one or more branches in a repository.

" }, "ListRepositories":{ "name":"ListRepositories", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRepositoriesInput"}, "output":{"shape":"ListRepositoriesOutput"}, "errors":[ {"shape":"InvalidSortByException"}, {"shape":"InvalidOrderException"}, {"shape":"InvalidContinuationTokenException"} ], "documentation":"

Gets information about one or more repositories.

" }, "PutRepositoryTriggers":{ "name":"PutRepositoryTriggers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutRepositoryTriggersInput"}, "output":{"shape":"PutRepositoryTriggersOutput"}, "errors":[ {"shape":"RepositoryDoesNotExistException"}, {"shape":"RepositoryNameRequiredException"}, {"shape":"InvalidRepositoryNameException"}, {"shape":"RepositoryTriggersListRequiredException"}, {"shape":"MaximumRepositoryTriggersExceededException"}, {"shape":"InvalidRepositoryTriggerNameException"}, {"shape":"InvalidRepositoryTriggerDestinationArnException"}, {"shape":"InvalidRepositoryTriggerRegionException"}, {"shape":"InvalidRepositoryTriggerCustomDataException"}, {"shape":"MaximumBranchesExceededException"}, {"shape":"InvalidRepositoryTriggerBranchNameException"}, {"shape":"InvalidRepositoryTriggerEventsException"}, {"shape":"RepositoryTriggerNameRequiredException"}, {"shape":"RepositoryTriggerDestinationArnRequiredException"}, {"shape":"RepositoryTriggerBranchNameListRequiredException"}, {"shape":"RepositoryTriggerEventsListRequiredException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"} ], "documentation":"

Replaces all triggers for a repository. This can be used to create or delete triggers.

" }, "TestRepositoryTriggers":{ "name":"TestRepositoryTriggers", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TestRepositoryTriggersInput"}, "output":{"shape":"TestRepositoryTriggersOutput"}, "errors":[ {"shape":"RepositoryDoesNotExistException"}, {"shape":"RepositoryNameRequiredException"}, {"shape":"InvalidRepositoryNameException"}, {"shape":"RepositoryTriggersListRequiredException"}, {"shape":"MaximumRepositoryTriggersExceededException"}, {"shape":"InvalidRepositoryTriggerNameException"}, {"shape":"InvalidRepositoryTriggerDestinationArnException"}, {"shape":"InvalidRepositoryTriggerRegionException"}, {"shape":"InvalidRepositoryTriggerCustomDataException"}, {"shape":"MaximumBranchesExceededException"}, {"shape":"InvalidRepositoryTriggerBranchNameException"}, {"shape":"InvalidRepositoryTriggerEventsException"}, {"shape":"RepositoryTriggerNameRequiredException"}, {"shape":"RepositoryTriggerDestinationArnRequiredException"}, {"shape":"RepositoryTriggerBranchNameListRequiredException"}, {"shape":"RepositoryTriggerEventsListRequiredException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"} ], "documentation":"

Tests the functionality of repository triggers by sending information to the trigger target. If real data is available in the repository, the test will send data from the last commit. If no data is available, sample data will be generated.

" }, "UpdateDefaultBranch":{ "name":"UpdateDefaultBranch", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateDefaultBranchInput"}, "errors":[ {"shape":"RepositoryNameRequiredException"}, {"shape":"RepositoryDoesNotExistException"}, {"shape":"InvalidRepositoryNameException"}, {"shape":"BranchNameRequiredException"}, {"shape":"InvalidBranchNameException"}, {"shape":"BranchDoesNotExistException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"} ], "documentation":"

Sets or changes the default branch name for the specified repository.

If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.

" }, "UpdateRepositoryDescription":{ "name":"UpdateRepositoryDescription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateRepositoryDescriptionInput"}, "errors":[ {"shape":"RepositoryNameRequiredException"}, {"shape":"RepositoryDoesNotExistException"}, {"shape":"InvalidRepositoryNameException"}, {"shape":"InvalidRepositoryDescriptionException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"} ], "documentation":"

Sets or changes the comment or description for a repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

" }, "UpdateRepositoryName":{ "name":"UpdateRepositoryName", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateRepositoryNameInput"}, "errors":[ {"shape":"RepositoryDoesNotExistException"}, {"shape":"RepositoryNameExistsException"}, {"shape":"RepositoryNameRequiredException"}, {"shape":"InvalidRepositoryNameException"} ], "documentation":"

Renames a repository. The repository name must be unique across the calling AWS account. In addition, repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. The suffix \".git\" is prohibited. For a full description of the limits on repository names, see Limits in the AWS CodeCommit User Guide.

" } }, "shapes":{ "AccountId":{"type":"string"}, "AdditionalData":{"type":"string"}, "Arn":{"type":"string"}, "BatchGetRepositoriesInput":{ "type":"structure", "required":["repositoryNames"], "members":{ "repositoryNames":{ "shape":"RepositoryNameList", "documentation":"

The names of the repositories to get information about.

" } }, "documentation":"

Represents the input of a batch get repositories operation.

" }, "BatchGetRepositoriesOutput":{ "type":"structure", "members":{ "repositories":{ "shape":"RepositoryMetadataList", "documentation":"

A list of repositories returned by the batch get repositories operation.

" }, "repositoriesNotFound":{ "shape":"RepositoryNotFoundList", "documentation":"

Returns a list of repository names for which information could not be found.

" } }, "documentation":"

Represents the output of a batch get repositories operation.

" }, "BlobIdDoesNotExistException":{ "type":"structure", "members":{ }, "documentation":"

The specified blob does not exist.

", "exception":true }, "BlobIdRequiredException":{ "type":"structure", "members":{ }, "documentation":"

A blob ID is required but was not specified.

", "exception":true }, "BlobMetadata":{ "type":"structure", "members":{ "blobId":{ "shape":"ObjectId", "documentation":"

The full ID of the blob.

" }, "path":{ "shape":"Path", "documentation":"

The path to the blob and any associated file name, if any.

" }, "mode":{ "shape":"Mode", "documentation":"

The file mode permissions of the blob. File mode permission codes include:

  • 100644 indicates read/write

  • 100755 indicates read/write/execute

  • 160000 indicates a submodule

  • 120000 indicates a symlink

" } }, "documentation":"

Returns information about a specific Git blob object.

" }, "BranchDoesNotExistException":{ "type":"structure", "members":{ }, "documentation":"

The specified branch does not exist.

", "exception":true }, "BranchInfo":{ "type":"structure", "members":{ "branchName":{ "shape":"BranchName", "documentation":"

The name of the branch.

" }, "commitId":{ "shape":"CommitId", "documentation":"

The ID of the last commit made to the branch.

" } }, "documentation":"

Returns information about a branch.

" }, "BranchName":{ "type":"string", "max":100, "min":1 }, "BranchNameExistsException":{ "type":"structure", "members":{ }, "documentation":"

The specified branch name already exists.

", "exception":true }, "BranchNameList":{ "type":"list", "member":{"shape":"BranchName"} }, "BranchNameRequiredException":{ "type":"structure", "members":{ }, "documentation":"

A branch name is required but was not specified.

", "exception":true }, "ChangeTypeEnum":{ "type":"string", "enum":[ "A", "M", "D" ] }, "CloneUrlHttp":{"type":"string"}, "CloneUrlSsh":{"type":"string"}, "Commit":{ "type":"structure", "members":{ "treeId":{ "shape":"ObjectId", "documentation":"

Tree information for the specified commit.

" }, "parents":{ "shape":"ParentList", "documentation":"

The parent list for the specified commit.

" }, "message":{ "shape":"Message", "documentation":"

The commit message associated with the specified commit.

" }, "author":{ "shape":"UserInfo", "documentation":"

Information about the author of the specified commit. Information includes the date in timestamp format with GMT offset, the name of the author, and the email address for the author, as configured in Git.

" }, "committer":{ "shape":"UserInfo", "documentation":"

Information about the person who committed the specified commit, also known as the committer. Information includes the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as configured in Git.

For more information about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git by Scott Chacon and Ben Straub.

" }, "additionalData":{ "shape":"AdditionalData", "documentation":"

Any additional data associated with the specified commit.

" } }, "documentation":"

Returns information about a specific commit.

" }, "CommitDoesNotExistException":{ "type":"structure", "members":{ }, "documentation":"

The specified commit does not exist or no commit was specified, and the specified repository has no default branch.

", "exception":true }, "CommitId":{"type":"string"}, "CommitIdDoesNotExistException":{ "type":"structure", "members":{ }, "documentation":"

The specified commit ID does not exist.

", "exception":true }, "CommitIdRequiredException":{ "type":"structure", "members":{ }, "documentation":"

A commit ID was not specified.

", "exception":true }, "CommitName":{"type":"string"}, "CommitRequiredException":{ "type":"structure", "members":{ }, "documentation":"

A commit was not specified.

", "exception":true }, "CreateBranchInput":{ "type":"structure", "required":[ "repositoryName", "branchName", "commitId" ], "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository in which you want to create the new branch.

" }, "branchName":{ "shape":"BranchName", "documentation":"

The name of the new branch to create.

" }, "commitId":{ "shape":"CommitId", "documentation":"

The ID of the commit to point the new branch to.

" } }, "documentation":"

Represents the input of a create branch operation.

" }, "CreateRepositoryInput":{ "type":"structure", "required":["repositoryName"], "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the new repository to be created.

The repository name must be unique across the calling AWS account. In addition, repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. For a full description of the limits on repository names, see Limits in the AWS CodeCommit User Guide. The suffix \".git\" is prohibited.

" }, "repositoryDescription":{ "shape":"RepositoryDescription", "documentation":"

A comment or description about the new repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

" } }, "documentation":"

Represents the input of a create repository operation.

" }, "CreateRepositoryOutput":{ "type":"structure", "members":{ "repositoryMetadata":{ "shape":"RepositoryMetadata", "documentation":"

Information about the newly created repository.

" } }, "documentation":"

Represents the output of a create repository operation.

" }, "CreationDate":{"type":"timestamp"}, "Date":{"type":"string"}, "DeleteRepositoryInput":{ "type":"structure", "required":["repositoryName"], "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository to delete.

" } }, "documentation":"

Represents the input of a delete repository operation.

" }, "DeleteRepositoryOutput":{ "type":"structure", "members":{ "repositoryId":{ "shape":"RepositoryId", "documentation":"

The ID of the repository that was deleted.

" } }, "documentation":"

Represents the output of a delete repository operation.

" }, "Difference":{ "type":"structure", "members":{ "beforeBlob":{ "shape":"BlobMetadata", "documentation":"

Information about a beforeBlob data type object, including the ID, the file mode permission code, and the path.

" }, "afterBlob":{ "shape":"BlobMetadata", "documentation":"

Information about an afterBlob data type object, including the ID, the file mode permission code, and the path.

" }, "changeType":{ "shape":"ChangeTypeEnum", "documentation":"

Whether the change type of the difference is an addition (A), deletion (D), or modification (M).

" } }, "documentation":"

Returns information about a set of differences for a commit specifier.

" }, "DifferenceList":{ "type":"list", "member":{"shape":"Difference"} }, "Email":{"type":"string"}, "EncryptionIntegrityChecksFailedException":{ "type":"structure", "members":{ }, "documentation":"

An encryption integrity check failed.

", "exception":true, "fault":true }, "EncryptionKeyAccessDeniedException":{ "type":"structure", "members":{ }, "documentation":"

An encryption key could not be accessed.

", "exception":true }, "EncryptionKeyDisabledException":{ "type":"structure", "members":{ }, "documentation":"

The encryption key is disabled.

", "exception":true }, "EncryptionKeyNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

No encryption key was found.

", "exception":true }, "EncryptionKeyUnavailableException":{ "type":"structure", "members":{ }, "documentation":"

The encryption key is not available.

", "exception":true }, "FileTooLargeException":{ "type":"structure", "members":{ }, "documentation":"

The specified file exceeds the file size limit for AWS CodeCommit. For more information about limits in AWS CodeCommit, see AWS CodeCommit User Guide.

", "exception":true }, "GetBlobInput":{ "type":"structure", "required":[ "repositoryName", "blobId" ], "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository that contains the blob.

" }, "blobId":{ "shape":"ObjectId", "documentation":"

The ID of the blob, which is its SHA-1 pointer.

" } }, "documentation":"

Represents the input of a get blob operation.

" }, "GetBlobOutput":{ "type":"structure", "required":["content"], "members":{ "content":{ "shape":"blob", "documentation":"

The content of the blob, usually a file.

" } }, "documentation":"

Represents the output of a get blob operation.

" }, "GetBranchInput":{ "type":"structure", "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository that contains the branch for which you want to retrieve information.

" }, "branchName":{ "shape":"BranchName", "documentation":"

The name of the branch for which you want to retrieve information.

" } }, "documentation":"

Represents the input of a get branch operation.

" }, "GetBranchOutput":{ "type":"structure", "members":{ "branch":{ "shape":"BranchInfo", "documentation":"

The name of the branch.

" } }, "documentation":"

Represents the output of a get branch operation.

" }, "GetCommitInput":{ "type":"structure", "required":[ "repositoryName", "commitId" ], "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository to which the commit was made.

" }, "commitId":{ "shape":"ObjectId", "documentation":"

The commit ID.

" } }, "documentation":"

Represents the input of a get commit operation.

" }, "GetCommitOutput":{ "type":"structure", "required":["commit"], "members":{ "commit":{ "shape":"Commit", "documentation":"

A commit data type object that contains information about the specified commit.

" } }, "documentation":"

Represents the output of a get commit operation.

" }, "GetDifferencesInput":{ "type":"structure", "required":[ "repositoryName", "afterCommitSpecifier" ], "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository where you want to get differences.

" }, "beforeCommitSpecifier":{ "shape":"CommitName", "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, the full commit ID. Optional. If not specified, all changes prior to the afterCommitSpecifier value will be shown. If you do not use beforeCommitSpecifier in your request, consider limiting the results with maxResults.

" }, "afterCommitSpecifier":{ "shape":"CommitName", "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit.

" }, "beforePath":{ "shape":"Path", "documentation":"

The file path in which to check for differences. Limits the results to this path. Can also be used to specify the previous name of a directory or folder. If beforePath and afterPath are not specified, differences will be shown for all paths.

" }, "afterPath":{ "shape":"Path", "documentation":"

The file path in which to check differences. Limits the results to this path. Can also be used to specify the changed name of a directory or folder, if it has changed. If not specified, differences will be shown for all paths.

" }, "MaxResults":{ "shape":"Limit", "documentation":"

A non-negative integer used to limit the number of returned results.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

An enumeration token that when provided in a request, returns the next batch of the results.

" } } }, "GetDifferencesOutput":{ "type":"structure", "members":{ "differences":{ "shape":"DifferenceList", "documentation":"

A differences data type object that contains information about the differences, including whether the difference is added, modified, or deleted (A, D, M).

" }, "NextToken":{ "shape":"NextToken", "documentation":"

An enumeration token that can be used in a request to return the next batch of the results.

" } } }, "GetRepositoryInput":{ "type":"structure", "required":["repositoryName"], "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository to get information about.

" } }, "documentation":"

Represents the input of a get repository operation.

" }, "GetRepositoryOutput":{ "type":"structure", "members":{ "repositoryMetadata":{ "shape":"RepositoryMetadata", "documentation":"

Information about the repository.

" } }, "documentation":"

Represents the output of a get repository operation.

" }, "GetRepositoryTriggersInput":{ "type":"structure", "required":["repositoryName"], "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository for which the trigger is configured.

" } }, "documentation":"

Represents the input of a get repository triggers operation.

" }, "GetRepositoryTriggersOutput":{ "type":"structure", "members":{ "configurationId":{ "shape":"RepositoryTriggersConfigurationId", "documentation":"

The system-generated unique ID for the trigger.

" }, "triggers":{ "shape":"RepositoryTriggersList", "documentation":"

The JSON block of configuration information for each trigger.

" } }, "documentation":"

Represents the output of a get repository triggers operation.

" }, "InvalidBlobIdException":{ "type":"structure", "members":{ }, "documentation":"

The specified blob is not valid.

", "exception":true }, "InvalidBranchNameException":{ "type":"structure", "members":{ }, "documentation":"

The specified branch name is not valid.

", "exception":true }, "InvalidCommitException":{ "type":"structure", "members":{ }, "documentation":"

The specified commit is not valid.

", "exception":true }, "InvalidCommitIdException":{ "type":"structure", "members":{ }, "documentation":"

The specified commit ID is not valid.

", "exception":true }, "InvalidContinuationTokenException":{ "type":"structure", "members":{ }, "documentation":"

The specified continuation token is not valid.

", "exception":true }, "InvalidMaxResultsException":{ "type":"structure", "members":{ }, "documentation":"

The specified number of maximum results is not valid.

", "exception":true }, "InvalidOrderException":{ "type":"structure", "members":{ }, "documentation":"

The specified sort order is not valid.

", "exception":true }, "InvalidPathException":{ "type":"structure", "members":{ }, "documentation":"

The specified path is not valid.

", "exception":true }, "InvalidRepositoryDescriptionException":{ "type":"structure", "members":{ }, "documentation":"

The specified repository description is not valid.

", "exception":true }, "InvalidRepositoryNameException":{ "type":"structure", "members":{ }, "documentation":"

At least one specified repository name is not valid.

This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.

", "exception":true }, "InvalidRepositoryTriggerBranchNameException":{ "type":"structure", "members":{ }, "documentation":"

One or more branch names specified for the trigger is not valid.

", "exception":true }, "InvalidRepositoryTriggerCustomDataException":{ "type":"structure", "members":{ }, "documentation":"

The custom data provided for the trigger is not valid.

", "exception":true }, "InvalidRepositoryTriggerDestinationArnException":{ "type":"structure", "members":{ }, "documentation":"

The Amazon Resource Name (ARN) for the trigger is not valid for the specified destination. The most common reason for this error is that the ARN does not meet the requirements for the service type.

", "exception":true }, "InvalidRepositoryTriggerEventsException":{ "type":"structure", "members":{ }, "documentation":"

One or more events specified for the trigger is not valid. Check to make sure that all events specified match the requirements for allowed events.

", "exception":true }, "InvalidRepositoryTriggerNameException":{ "type":"structure", "members":{ }, "documentation":"

The name of the trigger is not valid.

", "exception":true }, "InvalidRepositoryTriggerRegionException":{ "type":"structure", "members":{ }, "documentation":"

The region for the trigger target does not match the region for the repository. Triggers must be created in the same region as the target for the trigger.

", "exception":true }, "InvalidSortByException":{ "type":"structure", "members":{ }, "documentation":"

The specified sort by value is not valid.

", "exception":true }, "LastModifiedDate":{"type":"timestamp"}, "Limit":{ "type":"integer", "box":true }, "ListBranchesInput":{ "type":"structure", "required":["repositoryName"], "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository that contains the branches.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

An enumeration token that allows the operation to batch the results.

" } }, "documentation":"

Represents the input of a list branches operation.

" }, "ListBranchesOutput":{ "type":"structure", "members":{ "branches":{ "shape":"BranchNameList", "documentation":"

The list of branch names.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

An enumeration token that returns the batch of the results.

" } }, "documentation":"

Represents the output of a list branches operation.

" }, "ListRepositoriesInput":{ "type":"structure", "members":{ "nextToken":{ "shape":"NextToken", "documentation":"

An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records is retrieved.

" }, "sortBy":{ "shape":"SortByEnum", "documentation":"

The criteria used to sort the results of a list repositories operation.

" }, "order":{ "shape":"OrderEnum", "documentation":"

The order in which to sort the results of a list repositories operation.

" } }, "documentation":"

Represents the input of a list repositories operation.

" }, "ListRepositoriesOutput":{ "type":"structure", "members":{ "repositories":{ "shape":"RepositoryNameIdPairList", "documentation":"

Lists the repositories called by the list repositories operation.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records is retrieved.

" } }, "documentation":"

Represents the output of a list repositories operation.

" }, "MaximumBranchesExceededException":{ "type":"structure", "members":{ }, "documentation":"

The number of branches for the trigger was exceeded.

", "exception":true }, "MaximumRepositoryNamesExceededException":{ "type":"structure", "members":{ }, "documentation":"

The maximum number of allowed repository names was exceeded. Currently, this number is 25.

", "exception":true }, "MaximumRepositoryTriggersExceededException":{ "type":"structure", "members":{ }, "documentation":"

The number of triggers allowed for the repository was exceeded.

", "exception":true }, "Message":{"type":"string"}, "Mode":{"type":"string"}, "Name":{"type":"string"}, "NextToken":{"type":"string"}, "ObjectId":{"type":"string"}, "OrderEnum":{ "type":"string", "enum":[ "ascending", "descending" ] }, "ParentList":{ "type":"list", "member":{"shape":"ObjectId"} }, "Path":{"type":"string"}, "PathDoesNotExistException":{ "type":"structure", "members":{ }, "documentation":"

The specified path does not exist.

", "exception":true }, "PutRepositoryTriggersInput":{ "type":"structure", "required":[ "repositoryName", "triggers" ], "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository where you want to create or update the trigger.

" }, "triggers":{ "shape":"RepositoryTriggersList", "documentation":"

The JSON block of configuration information for each trigger.

" } }, "documentation":"

Represents the input ofa put repository triggers operation.

" }, "PutRepositoryTriggersOutput":{ "type":"structure", "members":{ "configurationId":{ "shape":"RepositoryTriggersConfigurationId", "documentation":"

The system-generated unique ID for the create or update operation.

" } }, "documentation":"

Represents the output of a put repository triggers operation.

" }, "RepositoryDescription":{ "type":"string", "max":1000 }, "RepositoryDoesNotExistException":{ "type":"structure", "members":{ }, "documentation":"

The specified repository does not exist.

", "exception":true }, "RepositoryId":{"type":"string"}, "RepositoryLimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

A repository resource limit was exceeded.

", "exception":true }, "RepositoryMetadata":{ "type":"structure", "members":{ "accountId":{ "shape":"AccountId", "documentation":"

The ID of the AWS account associated with the repository.

" }, "repositoryId":{ "shape":"RepositoryId", "documentation":"

The ID of the repository.

" }, "repositoryName":{ "shape":"RepositoryName", "documentation":"

The repository's name.

" }, "repositoryDescription":{ "shape":"RepositoryDescription", "documentation":"

A comment or description about the repository.

" }, "defaultBranch":{ "shape":"BranchName", "documentation":"

The repository's default branch name.

" }, "lastModifiedDate":{ "shape":"LastModifiedDate", "documentation":"

The date and time the repository was last modified, in timestamp format.

" }, "creationDate":{ "shape":"CreationDate", "documentation":"

The date and time the repository was created, in timestamp format.

" }, "cloneUrlHttp":{ "shape":"CloneUrlHttp", "documentation":"

The URL to use for cloning the repository over HTTPS.

" }, "cloneUrlSsh":{ "shape":"CloneUrlSsh", "documentation":"

The URL to use for cloning the repository over SSH.

" }, "Arn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the repository.

" } }, "documentation":"

Information about a repository.

" }, "RepositoryMetadataList":{ "type":"list", "member":{"shape":"RepositoryMetadata"} }, "RepositoryName":{ "type":"string", "max":100, "min":1, "pattern":"[\\w\\.-]+" }, "RepositoryNameExistsException":{ "type":"structure", "members":{ }, "documentation":"

The specified repository name already exists.

", "exception":true }, "RepositoryNameIdPair":{ "type":"structure", "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name associated with the repository.

" }, "repositoryId":{ "shape":"RepositoryId", "documentation":"

The ID associated with the repository.

" } }, "documentation":"

Information about a repository name and ID.

" }, "RepositoryNameIdPairList":{ "type":"list", "member":{"shape":"RepositoryNameIdPair"} }, "RepositoryNameList":{ "type":"list", "member":{"shape":"RepositoryName"} }, "RepositoryNameRequiredException":{ "type":"structure", "members":{ }, "documentation":"

A repository name is required but was not specified.

", "exception":true }, "RepositoryNamesRequiredException":{ "type":"structure", "members":{ }, "documentation":"

A repository names object is required but was not specified.

", "exception":true }, "RepositoryNotFoundList":{ "type":"list", "member":{"shape":"RepositoryName"} }, "RepositoryTrigger":{ "type":"structure", "required":[ "name", "destinationArn", "events" ], "members":{ "name":{ "shape":"RepositoryTriggerName", "documentation":"

The name of the trigger.

" }, "destinationArn":{ "shape":"Arn", "documentation":"

The ARN of the resource that is the target for a trigger. For example, the ARN of a topic in Amazon Simple Notification Service (SNS).

" }, "customData":{ "shape":"RepositoryTriggerCustomData", "documentation":"

Any custom data associated with the trigger that will be included in the information sent to the target of the trigger.

" }, "branches":{ "shape":"BranchNameList", "documentation":"

The branches that will be included in the trigger configuration. If no branches are specified, the trigger will apply to all branches.

" }, "events":{ "shape":"RepositoryTriggerEventList", "documentation":"

The repository events that will cause the trigger to run actions in another service, such as sending a notification through Amazon Simple Notification Service (SNS).

The valid value \"all\" cannot be used with any other values.

" } }, "documentation":"

Information about a trigger for a repository.

" }, "RepositoryTriggerBranchNameListRequiredException":{ "type":"structure", "members":{ }, "documentation":"

At least one branch name is required but was not specified in the trigger configuration.

", "exception":true }, "RepositoryTriggerCustomData":{"type":"string"}, "RepositoryTriggerDestinationArnRequiredException":{ "type":"structure", "members":{ }, "documentation":"

A destination ARN for the target service for the trigger is required but was not specified.

", "exception":true }, "RepositoryTriggerEventEnum":{ "type":"string", "enum":[ "all", "updateReference", "createReference", "deleteReference" ] }, "RepositoryTriggerEventList":{ "type":"list", "member":{"shape":"RepositoryTriggerEventEnum"} }, "RepositoryTriggerEventsListRequiredException":{ "type":"structure", "members":{ }, "documentation":"

At least one event for the trigger is required but was not specified.

", "exception":true }, "RepositoryTriggerExecutionFailure":{ "type":"structure", "members":{ "trigger":{ "shape":"RepositoryTriggerName", "documentation":"

The name of the trigger that did not run.

" }, "failureMessage":{ "shape":"RepositoryTriggerExecutionFailureMessage", "documentation":"

Additional message information about the trigger that did not run.

" } }, "documentation":"

A trigger failed to run.

" }, "RepositoryTriggerExecutionFailureList":{ "type":"list", "member":{"shape":"RepositoryTriggerExecutionFailure"} }, "RepositoryTriggerExecutionFailureMessage":{"type":"string"}, "RepositoryTriggerName":{"type":"string"}, "RepositoryTriggerNameList":{ "type":"list", "member":{"shape":"RepositoryTriggerName"} }, "RepositoryTriggerNameRequiredException":{ "type":"structure", "members":{ }, "documentation":"

A name for the trigger is required but was not specified.

", "exception":true }, "RepositoryTriggersConfigurationId":{"type":"string"}, "RepositoryTriggersList":{ "type":"list", "member":{"shape":"RepositoryTrigger"} }, "RepositoryTriggersListRequiredException":{ "type":"structure", "members":{ }, "documentation":"

The list of triggers for the repository is required but was not specified.

", "exception":true }, "SortByEnum":{ "type":"string", "enum":[ "repositoryName", "lastModifiedDate" ] }, "TestRepositoryTriggersInput":{ "type":"structure", "required":[ "repositoryName", "triggers" ], "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository in which to test the triggers.

" }, "triggers":{ "shape":"RepositoryTriggersList", "documentation":"

The list of triggers to test.

" } }, "documentation":"

Represents the input of a test repository triggers operation.

" }, "TestRepositoryTriggersOutput":{ "type":"structure", "members":{ "successfulExecutions":{ "shape":"RepositoryTriggerNameList", "documentation":"

The list of triggers that were successfully tested. This list provides the names of the triggers that were successfully tested, separated by commas.

" }, "failedExecutions":{ "shape":"RepositoryTriggerExecutionFailureList", "documentation":"

The list of triggers that were not able to be tested. This list provides the names of the triggers that could not be tested, separated by commas.

" } }, "documentation":"

Represents the output of a test repository triggers operation.

" }, "UpdateDefaultBranchInput":{ "type":"structure", "required":[ "repositoryName", "defaultBranchName" ], "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository to set or change the default branch for.

" }, "defaultBranchName":{ "shape":"BranchName", "documentation":"

The name of the branch to set as the default.

" } }, "documentation":"

Represents the input of an update default branch operation.

" }, "UpdateRepositoryDescriptionInput":{ "type":"structure", "required":["repositoryName"], "members":{ "repositoryName":{ "shape":"RepositoryName", "documentation":"

The name of the repository to set or change the comment or description for.

" }, "repositoryDescription":{ "shape":"RepositoryDescription", "documentation":"

The new comment or description for the specified repository. Repository descriptions are limited to 1,000 characters.

" } }, "documentation":"

Represents the input of an update repository description operation.

" }, "UpdateRepositoryNameInput":{ "type":"structure", "required":[ "oldName", "newName" ], "members":{ "oldName":{ "shape":"RepositoryName", "documentation":"

The existing name of the repository.

" }, "newName":{ "shape":"RepositoryName", "documentation":"

The new name for the repository.

" } }, "documentation":"

Represents the input of an update repository description operation.

" }, "UserInfo":{ "type":"structure", "members":{ "name":{ "shape":"Name", "documentation":"

The name of the user who made the specified commit.

" }, "email":{ "shape":"Email", "documentation":"

The email address associated with the user who made the commit, if any.

" }, "date":{ "shape":"Date", "documentation":"

The date when the specified commit was pushed to the repository.

" } }, "documentation":"

Information about the user who made a specified commit.

" }, "blob":{"type":"blob"} }, "documentation":"AWS CodeCommit

This is the AWS CodeCommit API Reference. This reference provides descriptions of the operations and data types for AWS CodeCommit API along with usage examples.

You can use the AWS CodeCommit API to work with the following objects:

Repositories, by calling the following:

  • BatchGetRepositories, which returns information about one or more repositories associated with your AWS account

  • CreateRepository, which creates an AWS CodeCommit repository

  • DeleteRepository, which deletes an AWS CodeCommit repository

  • GetRepository, which returns information about a specified repository

  • ListRepositories, which lists all AWS CodeCommit repositories associated with your AWS account

  • UpdateRepositoryDescription, which sets or updates the description of the repository

  • UpdateRepositoryName, which changes the name of the repository. If you change the name of a repository, no other users of that repository will be able to access it until you send them the new HTTPS or SSH URL to use.

Branches, by calling the following:

  • CreateBranch, which creates a new branch in a specified repository

  • GetBranch, which returns information about a specified branch

  • ListBranches, which lists all branches for a specified repository

  • UpdateDefaultBranch, which changes the default branch for a repository

Information about committed code in a repository, by calling the following:

  • GetBlob, which returns the base-64 encoded content of an individual Git blob object within a repository

  • GetCommit, which returns information about a commit, including commit messages and author and committer information

  • GetDifferences, which returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified reference)

Triggers, by calling the following:

  • GetRepositoryTriggers, which returns information about triggers configured for a repository

  • PutRepositoryTriggers, which replaces all triggers for a repository and can be used to create or delete triggers

  • TestRepositoryTriggers, which tests the functionality of a repository trigger by sending data to the trigger target

For information about how to use AWS CodeCommit, see the AWS CodeCommit User Guide.

" } botocore-1.5.7/botocore/data/sqs/0000777454262600001440000000000013042511307017741 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/sqs/2012-11-05/0000777454262600001440000000000013042511307020766 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/sqs/2012-11-05/examples-1.json0000666454262600001440000000212413042511306023633 0ustar pysdk-ciamazon00000000000000{ "version": "1.0", "examples": { "CreateQueue": [ { "input": { "QueueName": "MyQueue" }, "output": { "QueueUrl": "https://queue.amazonaws.com/012345678910/MyQueue" }, "comments": { "input": { }, "output": { } }, "description": "The following operation creates an SQS queue named MyQueue.", "id": "create-an-sqs-queue-1445915686197", "title": "Create an SQS queue" } ], "GetQueueUrl": [ { "input": { "QueueName": "MyQueue", "QueueOwnerAWSAccountId": "12345678910" }, "output": { "QueueUrl": "https://queue.amazonaws.com/123456789101112/MyQueue" }, "comments": { "input": { }, "output": { } }, "description": "The following example retrieves the queue ARN.", "id": "retrieve-queue-attributes-from-an-sqs-queue-1445915930574", "title": "Retrieve queue attributes from an SQS queue" } ] } } botocore-1.5.7/botocore/data/sqs/2012-11-05/service-2.json0000777454262600001440000030255513042511306023474 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2012-11-05", "endpointPrefix":"sqs", "protocol":"query", "serviceAbbreviation":"Amazon SQS", "serviceFullName":"Amazon Simple Queue Service", "signatureVersion":"v4", "uid":"sqs-2012-11-05", "xmlNamespace":"http://queue.amazonaws.com/doc/2012-11-05/" }, "operations":{ "AddPermission":{ "name":"AddPermission", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AddPermissionRequest"}, "errors":[ {"shape":"OverLimit"} ], "documentation":"

Adds a permission to a queue for a specific principal. This allows sharing access to the queue.

When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Shared Queues in the Amazon SQS Developer Guide.

AddPermission writes an Amazon-SQS-generated policy. If you want to write your own policy, use SetQueueAttributes to upload your policy. For more information about writing your own policy, see Using The Access Policy Language in the Amazon SQS Developer Guide.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&Attribute.1=this

&Attribute.2=that

" }, "ChangeMessageVisibility":{ "name":"ChangeMessageVisibility", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ChangeMessageVisibilityRequest"}, "errors":[ {"shape":"MessageNotInflight"}, {"shape":"ReceiptHandleIsInvalid"} ], "documentation":"

Changes the visibility timeout of a specified message in a queue to a new value. The maximum allowed timeout value is 12 hours. Thus, you can't extend the timeout of a message in an existing queue to more than a total visibility timeout of 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.

For example, you have a message and with the default visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisiblity with a timeout of 10 minutes. At that time, the timeout for the message is extended by 10 minutes beyond the time of the ChangeMessageVisibility action. This results in a total visibility timeout of 13 minutes. You can continue to call the ChangeMessageVisibility to extend the visibility timeout to a maximum of 12 hours. If you try to extend the visibility timeout beyond 12 hours, your request is rejected.

A message is considered to be in flight after it's received from a queue by a consumer, but not yet deleted from the queue.

For standard queues, there can be a maximum of 120,000 inflight messages per queue. If you reach this limit, Amazon SQS returns the OverLimit error message. To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.

For FIFO queues, there can be a maximum of 20,000 inflight messages per queue. If you reach this limit, Amazon SQS returns no error messages.

If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.

Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.

" }, "ChangeMessageVisibilityBatch":{ "name":"ChangeMessageVisibilityBatch", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ChangeMessageVisibilityBatchRequest"}, "output":{ "shape":"ChangeMessageVisibilityBatchResult", "resultWrapper":"ChangeMessageVisibilityBatchResult" }, "errors":[ {"shape":"TooManyEntriesInBatchRequest"}, {"shape":"EmptyBatchRequest"}, {"shape":"BatchEntryIdsNotDistinct"}, {"shape":"InvalidBatchEntryId"} ], "documentation":"

Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility . The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action.

Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&Attribute.1=this

&Attribute.2=that

" }, "CreateQueue":{ "name":"CreateQueue", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateQueueRequest"}, "output":{ "shape":"CreateQueueResult", "resultWrapper":"CreateQueueResult" }, "errors":[ {"shape":"QueueDeletedRecently"}, {"shape":"QueueNameExists"} ], "documentation":"

Creates a new standard or FIFO queue or returns the URL of an existing queue. You can pass one or more attributes in the request. Keep the following caveats in mind:

  • If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.

    You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon SQS Developer Guide.

  • If you don't provide a value for an attribute, the queue is created with the default value for the attribute.

  • If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.

To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware of existing queue names:

  • If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue.

  • If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue returns an error.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&Attribute.1=this

&Attribute.2=that

" }, "DeleteMessage":{ "name":"DeleteMessage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteMessageRequest"}, "errors":[ {"shape":"InvalidIdFormat"}, {"shape":"ReceiptHandleIsInvalid"} ], "documentation":"

Deletes the specified message from the specified queue. You specify the message by using the message's receipt handle and not the MessageId you receive when you send the message. Even if the message is locked by another reader due to the visibility timeout setting, it is still deleted from the queue. If you leave a message in the queue for longer than the queue's configured retention period, Amazon SQS automatically deletes the message.

The receipt handle is associated with a specific instance of receiving the message. If you receive a message more than once, the receipt handle you get each time you receive the message is different. If you don't provide the most recently received receipt handle for the message when you use the DeleteMessage action, the request succeeds, but the message might not be deleted.

For standard queues, it is possible to receive a message even after you deleting it. This might happen on rare occasions if one of the servers storing a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you on a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.

" }, "DeleteMessageBatch":{ "name":"DeleteMessageBatch", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteMessageBatchRequest"}, "output":{ "shape":"DeleteMessageBatchResult", "resultWrapper":"DeleteMessageBatchResult" }, "errors":[ {"shape":"TooManyEntriesInBatchRequest"}, {"shape":"EmptyBatchRequest"}, {"shape":"BatchEntryIdsNotDistinct"}, {"shape":"InvalidBatchEntryId"} ], "documentation":"

Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage . The result of the action on each message is reported individually in the response.

Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&Attribute.1=this

&Attribute.2=that

" }, "DeleteQueue":{ "name":"DeleteQueue", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteQueueRequest"}, "documentation":"

Deletes the queue specified by the QueueUrl, even if the queue is empty. If the specified queue doesn't exist, Amazon SQS returns a successful response.

Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.

When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after 60 seconds the queue and the message you sent no longer exist.

When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

" }, "GetQueueAttributes":{ "name":"GetQueueAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetQueueAttributesRequest"}, "output":{ "shape":"GetQueueAttributesResult", "resultWrapper":"GetQueueAttributesResult" }, "errors":[ {"shape":"InvalidAttributeName"} ], "documentation":"

Gets attributes for the specified queue.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&Attribute.1=this

&Attribute.2=that

" }, "GetQueueUrl":{ "name":"GetQueueUrl", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetQueueUrlRequest"}, "output":{ "shape":"GetQueueUrlResult", "resultWrapper":"GetQueueUrlResult" }, "errors":[ {"shape":"QueueDoesNotExist"} ], "documentation":"

Returns the URL of an existing queue. This action provides a simple way to retrieve the URL of an Amazon SQS queue.

To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission or see Shared Queues in the Amazon SQS Developer Guide.

" }, "ListDeadLetterSourceQueues":{ "name":"ListDeadLetterSourceQueues", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListDeadLetterSourceQueuesRequest"}, "output":{ "shape":"ListDeadLetterSourceQueuesResult", "resultWrapper":"ListDeadLetterSourceQueuesResult" }, "errors":[ {"shape":"QueueDoesNotExist"} ], "documentation":"

Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead letter queue.

For more information about using dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

" }, "ListQueues":{ "name":"ListQueues", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListQueuesRequest"}, "output":{ "shape":"ListQueuesResult", "resultWrapper":"ListQueuesResult" }, "documentation":"

Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

" }, "PurgeQueue":{ "name":"PurgeQueue", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PurgeQueueRequest"}, "errors":[ {"shape":"QueueDoesNotExist"}, {"shape":"PurgeQueueInProgress"} ], "documentation":"

Deletes the messages in a queue specified by the QueueURL parameter.

When you use the PurgeQueue action, you can't retrieve a message deleted from a queue.

When you purge a queue, the message deletion process takes up to 60 seconds. All messages sent to the queue before calling the PurgeQueue action are deleted. Messages sent to the queue while it is being purged might be deleted. While the queue is being purged, messages sent to the queue before PurgeQueue is called might be received, but are deleted within the next minute.

" }, "ReceiveMessage":{ "name":"ReceiveMessage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReceiveMessageRequest"}, "output":{ "shape":"ReceiveMessageResult", "resultWrapper":"ReceiveMessageResult" }, "errors":[ {"shape":"OverLimit"} ], "documentation":"

Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. For more information, see Amazon SQS Long Polling in the Amazon SQS Developer Guide.

Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.

For each message returned, the response includes the following:

  • The message body.

  • An MD5 digest of the message body. For information on MD5, see RFC1321.

  • The MessageId you received when you sent the message to the queue.

  • The receipt handle.

  • The message attributes.

  • An MD5 digest of the message attributes.

The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.

You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.

A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead letter queue.

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

" }, "RemovePermission":{ "name":"RemovePermission", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemovePermissionRequest"}, "documentation":"

Revokes any permissions in the queue policy that matches the specified Label parameter. Only the owner of the queue can remove permissions.

" }, "SendMessage":{ "name":"SendMessage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SendMessageRequest"}, "output":{ "shape":"SendMessageResult", "resultWrapper":"SendMessageResult" }, "errors":[ {"shape":"InvalidMessageContents"}, {"shape":"UnsupportedOperation"} ], "documentation":"

Delivers a message to the specified queue.

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

" }, "SendMessageBatch":{ "name":"SendMessageBatch", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SendMessageBatchRequest"}, "output":{ "shape":"SendMessageBatchResult", "resultWrapper":"SendMessageBatchResult" }, "errors":[ {"shape":"TooManyEntriesInBatchRequest"}, {"shape":"EmptyBatchRequest"}, {"shape":"BatchEntryIdsNotDistinct"}, {"shape":"BatchRequestTooLong"}, {"shape":"InvalidBatchEntryId"}, {"shape":"UnsupportedOperation"} ], "documentation":"

Delivers up to ten messages to the specified queue. This is a batch version of SendMessage . For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.

The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.

Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

&Attribute.1=this

&Attribute.2=that

" }, "SetQueueAttributes":{ "name":"SetQueueAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"SetQueueAttributesRequest"}, "errors":[ {"shape":"InvalidAttributeName"} ], "documentation":"

Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

" } }, "shapes":{ "AWSAccountIdList":{ "type":"list", "member":{ "shape":"String", "locationName":"AWSAccountId" }, "flattened":true }, "ActionNameList":{ "type":"list", "member":{ "shape":"String", "locationName":"ActionName" }, "flattened":true }, "AddPermissionRequest":{ "type":"structure", "required":[ "QueueUrl", "Label", "AWSAccountIds", "Actions" ], "members":{ "QueueUrl":{ "shape":"String", "documentation":"

The URL of the Amazon SQS queue to which permissions are added.

Queue URLs are case-sensitive.

" }, "Label":{ "shape":"String", "documentation":"

The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

" }, "AWSAccountIds":{ "shape":"AWSAccountIdList", "documentation":"

The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon SQS Developer Guide.

" }, "Actions":{ "shape":"ActionNameList", "documentation":"

The action the client wants to allow for the specified principal. The following values are valid:

  • *

  • ChangeMessageVisibility

  • DeleteMessage

  • GetQueueAttributes

  • GetQueueUrl

  • ReceiveMessage

  • SendMessage

For more information about these actions, see Understanding Permissions in the Amazon SQS Developer Guide.

Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

" } }, "documentation":"

" }, "AttributeNameList":{ "type":"list", "member":{ "shape":"QueueAttributeName", "locationName":"AttributeName" }, "flattened":true }, "BatchEntryIdsNotDistinct":{ "type":"structure", "members":{ }, "documentation":"

Two or more batch entries in the request have the same Id.

", "error":{ "code":"AWS.SimpleQueueService.BatchEntryIdsNotDistinct", "httpStatusCode":400, "senderFault":true }, "exception":true }, "BatchRequestTooLong":{ "type":"structure", "members":{ }, "documentation":"

The length of all the messages put together is more than the limit.

", "error":{ "code":"AWS.SimpleQueueService.BatchRequestTooLong", "httpStatusCode":400, "senderFault":true }, "exception":true }, "BatchResultErrorEntry":{ "type":"structure", "required":[ "Id", "SenderFault", "Code" ], "members":{ "Id":{ "shape":"String", "documentation":"

The Id of an entry in a batch request.

" }, "SenderFault":{ "shape":"Boolean", "documentation":"

Specifies whether the error happened due to the sender's fault.

" }, "Code":{ "shape":"String", "documentation":"

An error code representing why the action failed on this entry.

" }, "Message":{ "shape":"String", "documentation":"

A message explaining why the action failed on this entry.

" } }, "documentation":"

This is used in the responses of batch API to give a detailed description of the result of an action on each entry in the request.

" }, "BatchResultErrorEntryList":{ "type":"list", "member":{ "shape":"BatchResultErrorEntry", "locationName":"BatchResultErrorEntry" }, "flattened":true }, "Binary":{"type":"blob"}, "BinaryList":{ "type":"list", "member":{ "shape":"Binary", "locationName":"BinaryListValue" } }, "Boolean":{"type":"boolean"}, "ChangeMessageVisibilityBatchRequest":{ "type":"structure", "required":[ "QueueUrl", "Entries" ], "members":{ "QueueUrl":{ "shape":"String", "documentation":"

The URL of the Amazon SQS queue whose messages' visibility is changed.

Queue URLs are case-sensitive.

" }, "Entries":{ "shape":"ChangeMessageVisibilityBatchRequestEntryList", "documentation":"

A list of receipt handles of the messages for which the visibility timeout must be changed.

" } }, "documentation":"

" }, "ChangeMessageVisibilityBatchRequestEntry":{ "type":"structure", "required":[ "Id", "ReceiptHandle" ], "members":{ "Id":{ "shape":"String", "documentation":"

An identifier for this particular receipt handle used to communicate the result.

The Ids of a batch request need to be unique within a request

" }, "ReceiptHandle":{ "shape":"String", "documentation":"

A receipt handle.

" }, "VisibilityTimeout":{ "shape":"Integer", "documentation":"

The new value (in seconds) for the message's visibility timeout.

" } }, "documentation":"

Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch .

All of the following list parameters must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value starting with 1. For example, a parameter list for this action might look like this:

&amp;ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2

&amp;ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=<replaceable>Your_Receipt_Handle</replaceable>

&amp;ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45

" }, "ChangeMessageVisibilityBatchRequestEntryList":{ "type":"list", "member":{ "shape":"ChangeMessageVisibilityBatchRequestEntry", "locationName":"ChangeMessageVisibilityBatchRequestEntry" }, "flattened":true }, "ChangeMessageVisibilityBatchResult":{ "type":"structure", "required":[ "Successful", "Failed" ], "members":{ "Successful":{ "shape":"ChangeMessageVisibilityBatchResultEntryList", "documentation":"

A list of ChangeMessageVisibilityBatchResultEntry items.

" }, "Failed":{ "shape":"BatchResultErrorEntryList", "documentation":"

A list of BatchResultErrorEntry items.

" } }, "documentation":"

For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

" }, "ChangeMessageVisibilityBatchResultEntry":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"String", "documentation":"

Represents a message whose visibility timeout has been changed successfully.

" } }, "documentation":"

Encloses the Id of an entry in ChangeMessageVisibilityBatch .

" }, "ChangeMessageVisibilityBatchResultEntryList":{ "type":"list", "member":{ "shape":"ChangeMessageVisibilityBatchResultEntry", "locationName":"ChangeMessageVisibilityBatchResultEntry" }, "flattened":true }, "ChangeMessageVisibilityRequest":{ "type":"structure", "required":[ "QueueUrl", "ReceiptHandle", "VisibilityTimeout" ], "members":{ "QueueUrl":{ "shape":"String", "documentation":"

The URL of the Amazon SQS queue whose message's visibility is changed.

Queue URLs are case-sensitive.

" }, "ReceiptHandle":{ "shape":"String", "documentation":"

The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the ReceiveMessage action.

" }, "VisibilityTimeout":{ "shape":"Integer", "documentation":"

The new value for the message's visibility timeout (in seconds). Values values: 0 to 43200. Maximum: 12 hours.

" } } }, "CreateQueueRequest":{ "type":"structure", "required":["QueueName"], "members":{ "QueueName":{ "shape":"String", "documentation":"

The name of the new queue. The following limits apply to this name:

  • A queue name can have up to 80 characters.

  • Valid values: alphanumeric characters, hyphens (-), and underscores (_).

  • A FIFO queue name must end with the .fifo suffix.

Queue names are case-sensitive.

" }, "Attributes":{ "shape":"QueueAttributeMap", "documentation":"

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:

  • DelaySeconds - The number of seconds for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). The default is 0 (zero).

  • MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB).

  • MessageRetentionPeriod - The number of seconds for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default is 345,600 (4 days).

  • Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.

  • ReceiveMessageWaitTimeSeconds - The number of seconds for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). The default is 0 (zero).

  • RedrivePolicy - The parameters for the dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

    The dead letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead letter queue of a standard queue must also be a standard queue.

  • VisibilityTimeout - The visibility timeout for the queue. Valid values: An integer from 0 to 43,200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to FIFO (first-in-first-out) queues:

  • FifoQueue - Designates a queue as FIFO. You can provide this attribute only during queue creation. You can't change it for an existing queue. When you set this attribute, you must provide a MessageGroupId explicitly.

    For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

  • ContentBasedDeduplication - Enables content-based deduplication. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

    • Every message must have a unique MessageDeduplicationId,

      • You may provide a MessageDeduplicationId explicitly.

      • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

      • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

      • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

    • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

    • You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.

    • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

Any other valid special request parameters (such as the following) are ignored:

  • ApproximateNumberOfMessages

  • ApproximateNumberOfMessagesDelayed

  • ApproximateNumberOfMessagesNotVisible

  • CreatedTimestamp

  • LastModifiedTimestamp

  • QueueArn

", "locationName":"Attribute" } }, "documentation":"

" }, "CreateQueueResult":{ "type":"structure", "members":{ "QueueUrl":{ "shape":"String", "documentation":"

The URL of the created Amazon SQS queue.

" } }, "documentation":"

Returns the QueueUrl attribute of the created queue.

" }, "DeleteMessageBatchRequest":{ "type":"structure", "required":[ "QueueUrl", "Entries" ], "members":{ "QueueUrl":{ "shape":"String", "documentation":"

The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs are case-sensitive.

" }, "Entries":{ "shape":"DeleteMessageBatchRequestEntryList", "documentation":"

A list of receipt handles for the messages to be deleted.

" } }, "documentation":"

" }, "DeleteMessageBatchRequestEntry":{ "type":"structure", "required":[ "Id", "ReceiptHandle" ], "members":{ "Id":{ "shape":"String", "documentation":"

An identifier for this particular receipt handle. This is used to communicate the result.

The Ids of a batch request need to be unique within a request

" }, "ReceiptHandle":{ "shape":"String", "documentation":"

A receipt handle.

" } }, "documentation":"

Encloses a receipt handle and an identifier for it.

" }, "DeleteMessageBatchRequestEntryList":{ "type":"list", "member":{ "shape":"DeleteMessageBatchRequestEntry", "locationName":"DeleteMessageBatchRequestEntry" }, "flattened":true }, "DeleteMessageBatchResult":{ "type":"structure", "required":[ "Successful", "Failed" ], "members":{ "Successful":{ "shape":"DeleteMessageBatchResultEntryList", "documentation":"

A list of DeleteMessageBatchResultEntry items.

" }, "Failed":{ "shape":"BatchResultErrorEntryList", "documentation":"

A list of BatchResultErrorEntry items.

" } }, "documentation":"

For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the message is deleted or a BatchResultErrorEntry tag if the message can't be deleted.

" }, "DeleteMessageBatchResultEntry":{ "type":"structure", "required":["Id"], "members":{ "Id":{ "shape":"String", "documentation":"

Represents a successfully deleted message.

" } }, "documentation":"

Encloses the Id of an entry in DeleteMessageBatch .

" }, "DeleteMessageBatchResultEntryList":{ "type":"list", "member":{ "shape":"DeleteMessageBatchResultEntry", "locationName":"DeleteMessageBatchResultEntry" }, "flattened":true }, "DeleteMessageRequest":{ "type":"structure", "required":[ "QueueUrl", "ReceiptHandle" ], "members":{ "QueueUrl":{ "shape":"String", "documentation":"

The URL of the Amazon SQS queue from which messages are deleted.

Queue URLs are case-sensitive.

" }, "ReceiptHandle":{ "shape":"String", "documentation":"

The receipt handle associated with the message to delete.

" } }, "documentation":"

" }, "DeleteQueueRequest":{ "type":"structure", "required":["QueueUrl"], "members":{ "QueueUrl":{ "shape":"String", "documentation":"

The URL of the Amazon SQS queue to delete.

Queue URLs are case-sensitive.

" } }, "documentation":"

" }, "EmptyBatchRequest":{ "type":"structure", "members":{ }, "documentation":"

The batch request doesn't contain any entries.

", "error":{ "code":"AWS.SimpleQueueService.EmptyBatchRequest", "httpStatusCode":400, "senderFault":true }, "exception":true }, "GetQueueAttributesRequest":{ "type":"structure", "required":["QueueUrl"], "members":{ "QueueUrl":{ "shape":"String", "documentation":"

The URL of the Amazon SQS queue whose attribute information is retrieved.

Queue URLs are case-sensitive.

" }, "AttributeNames":{ "shape":"AttributeNameList", "documentation":"

A list of attributes for which to retrieve information.

In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

The following attributes are supported:

  • All - Returns all values.

  • ApproximateNumberOfMessages - Returns the approximate number of visible messages in a queue. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

  • ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages that are waiting to be added to the queue.

  • ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that have not timed-out and aren't deleted. For more information, see Resources Required to Process Messages in the Amazon SQS Developer Guide.

  • CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).

  • DelaySeconds - Returns the default delay on the queue in seconds.

  • LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).

  • MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

  • MessageRetentionPeriod - Returns the number of seconds for which Amazon SQS retains a message.

  • Policy - Returns the policy of the queue.

  • QueueArn - Returns the Amazon resource name (ARN) of the queue.

  • ReceiveMessageWaitTimeSeconds - Returns the number of seconds for which the ReceiveMessage action waits for a message to arrive.

  • RedrivePolicy - Returns the parameters for dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

  • VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attributes apply only to FIFO (first-in-first-out) queues:

  • FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon SQS Developer Guide.

  • ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

" } }, "documentation":"

" }, "GetQueueAttributesResult":{ "type":"structure", "members":{ "Attributes":{ "shape":"QueueAttributeMap", "documentation":"

A map of attributes to their respective values.

", "locationName":"Attribute" } }, "documentation":"

A list of returned queue attributes.

" }, "GetQueueUrlRequest":{ "type":"structure", "required":["QueueName"], "members":{ "QueueName":{ "shape":"String", "documentation":"

The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_).

Queue names are case-sensitive.

" }, "QueueOwnerAWSAccountId":{ "shape":"String", "documentation":"

The AWS account ID of the account that created the queue.

" } }, "documentation":"

" }, "GetQueueUrlResult":{ "type":"structure", "members":{ "QueueUrl":{ "shape":"String", "documentation":"

The URL of the queue.

" } }, "documentation":"

For more information, see Responses in the Amazon SQS Developer Guide.

" }, "Integer":{"type":"integer"}, "InvalidAttributeName":{ "type":"structure", "members":{ }, "documentation":"

The attribute referred to doesn't exist.

", "exception":true }, "InvalidBatchEntryId":{ "type":"structure", "members":{ }, "documentation":"

The Id of a batch entry in a batch request doesn't abide by the specification.

", "error":{ "code":"AWS.SimpleQueueService.InvalidBatchEntryId", "httpStatusCode":400, "senderFault":true }, "exception":true }, "InvalidIdFormat":{ "type":"structure", "members":{ }, "documentation":"

The receipt handle isn't valid for the current version.

", "exception":true }, "InvalidMessageContents":{ "type":"structure", "members":{ }, "documentation":"

The message contains characters outside the allowed set.

", "exception":true }, "ListDeadLetterSourceQueuesRequest":{ "type":"structure", "required":["QueueUrl"], "members":{ "QueueUrl":{ "shape":"String", "documentation":"

The URL of a dead letter queue.

Queue URLs are case-sensitive.

" } }, "documentation":"

" }, "ListDeadLetterSourceQueuesResult":{ "type":"structure", "required":["queueUrls"], "members":{ "queueUrls":{ "shape":"QueueUrlList", "documentation":"

A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead letter queue.

" } }, "documentation":"

A list of your dead letter source queues.

" }, "ListQueuesRequest":{ "type":"structure", "members":{ "QueueNamePrefix":{ "shape":"String", "documentation":"

A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

Queue names are case-sensitive.

" } }, "documentation":"

" }, "ListQueuesResult":{ "type":"structure", "members":{ "QueueUrls":{ "shape":"QueueUrlList", "documentation":"

A list of queue URLs, up to 1,000 entries.

" } }, "documentation":"

A list of your queues.

" }, "Message":{ "type":"structure", "members":{ "MessageId":{ "shape":"String", "documentation":"

A unique identifier for the message. A MessageIdis considered unique across all AWS accounts for an extended period of time.

" }, "ReceiptHandle":{ "shape":"String", "documentation":"

An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.

" }, "MD5OfBody":{ "shape":"String", "documentation":"

An MD5 digest of the non-URL-encoded message body string.

" }, "Body":{ "shape":"String", "documentation":"

The message's contents (not URL-encoded).

" }, "Attributes":{ "shape":"MessageSystemAttributeMap", "documentation":"

SenderId, SentTimestamp, ApproximateReceiveCount, and/or ApproximateFirstReceiveTimestamp. SentTimestamp and ApproximateFirstReceiveTimestamp are each returned as an integer representing the epoch time in milliseconds.

", "locationName":"Attribute" }, "MD5OfMessageAttributes":{ "shape":"String", "documentation":"

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information on MD5, see RFC1321.

" }, "MessageAttributes":{ "shape":"MessageBodyAttributeMap", "documentation":"

Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items and Validation in the Amazon SQS Developer Guide.

", "locationName":"MessageAttribute" } }, "documentation":"

An Amazon SQS message.

" }, "MessageAttributeName":{"type":"string"}, "MessageAttributeNameList":{ "type":"list", "member":{ "shape":"MessageAttributeName", "locationName":"MessageAttributeName" }, "flattened":true }, "MessageAttributeValue":{ "type":"structure", "required":["DataType"], "members":{ "StringValue":{ "shape":"String", "documentation":"

Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.

" }, "BinaryValue":{ "shape":"Binary", "documentation":"

Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.

" }, "StringListValues":{ "shape":"StringList", "documentation":"

Not implemented. Reserved for future use.

", "flattened":true, "locationName":"StringListValue" }, "BinaryListValues":{ "shape":"BinaryList", "documentation":"

Not implemented. Reserved for future use.

", "flattened":true, "locationName":"BinaryListValue" }, "DataType":{ "shape":"String", "documentation":"

Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

You can also append custom labels. For more information, see Message Attribute Data Types and Validation in the Amazon SQS Developer Guide.

" } }, "documentation":"

The user-specified message attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see SendMessage .

Name, type, value and the message body must not be empty or null. All parts of the message attribute, including Name, Type, and Value, are part of the message size restriction (256 KB or 262,144 bytes).

" }, "MessageBodyAttributeMap":{ "type":"map", "key":{ "shape":"String", "locationName":"Name" }, "value":{ "shape":"MessageAttributeValue", "locationName":"Value" }, "flattened":true }, "MessageList":{ "type":"list", "member":{ "shape":"Message", "locationName":"Message" }, "flattened":true }, "MessageNotInflight":{ "type":"structure", "members":{ }, "documentation":"

The message referred to isn't in flight.

", "error":{ "code":"AWS.SimpleQueueService.MessageNotInflight", "httpStatusCode":400, "senderFault":true }, "exception":true }, "MessageSystemAttributeMap":{ "type":"map", "key":{ "shape":"MessageSystemAttributeName", "locationName":"Name" }, "value":{ "shape":"String", "locationName":"Value" }, "flattened":true, "locationName":"Attribute" }, "MessageSystemAttributeName":{ "type":"string", "enum":[ "SenderId", "SentTimestamp", "ApproximateReceiveCount", "ApproximateFirstReceiveTimestamp", "SequenceNumber", "MessageDeduplicationId", "MessageGroupId" ] }, "OverLimit":{ "type":"structure", "members":{ }, "documentation":"

The action that you requested would violate a limit. For example, ReceiveMessage returns this error if the maximum number of inflight messages is reached. AddPermission returns this error if the maximum number of permissions for the queue is reached.

", "error":{ "code":"OverLimit", "httpStatusCode":403, "senderFault":true }, "exception":true }, "PurgeQueueInProgress":{ "type":"structure", "members":{ }, "documentation":"

Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds (the time it can take to delete the messages in the queue).

", "error":{ "code":"AWS.SimpleQueueService.PurgeQueueInProgress", "httpStatusCode":403, "senderFault":true }, "exception":true }, "PurgeQueueRequest":{ "type":"structure", "required":["QueueUrl"], "members":{ "QueueUrl":{ "shape":"String", "documentation":"

The URL of the queue from which the PurgeQueue action deletes messages.

Queue URLs are case-sensitive.

" } }, "documentation":"

" }, "QueueAttributeMap":{ "type":"map", "key":{ "shape":"QueueAttributeName", "locationName":"Name" }, "value":{ "shape":"String", "locationName":"Value" }, "flattened":true, "locationName":"Attribute" }, "QueueAttributeName":{ "type":"string", "enum":[ "All", "Policy", "VisibilityTimeout", "MaximumMessageSize", "MessageRetentionPeriod", "ApproximateNumberOfMessages", "ApproximateNumberOfMessagesNotVisible", "CreatedTimestamp", "LastModifiedTimestamp", "QueueArn", "ApproximateNumberOfMessagesDelayed", "DelaySeconds", "ReceiveMessageWaitTimeSeconds", "RedrivePolicy", "FifoQueue", "ContentBasedDeduplication" ] }, "QueueDeletedRecently":{ "type":"structure", "members":{ }, "documentation":"

You must wait 60 seconds after deleting a queue before you can create another one with the same name.

", "error":{ "code":"AWS.SimpleQueueService.QueueDeletedRecently", "httpStatusCode":400, "senderFault":true }, "exception":true }, "QueueDoesNotExist":{ "type":"structure", "members":{ }, "documentation":"

The queue referred to doesn't exist.

", "error":{ "code":"AWS.SimpleQueueService.NonExistentQueue", "httpStatusCode":400, "senderFault":true }, "exception":true }, "QueueNameExists":{ "type":"structure", "members":{ }, "documentation":"

A queue already exists with this name. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue.

", "error":{ "code":"QueueAlreadyExists", "httpStatusCode":400, "senderFault":true }, "exception":true }, "QueueUrlList":{ "type":"list", "member":{ "shape":"String", "locationName":"QueueUrl" }, "flattened":true }, "ReceiptHandleIsInvalid":{ "type":"structure", "members":{ }, "documentation":"

The receipt handle provided isn't valid.

", "exception":true }, "ReceiveMessageRequest":{ "type":"structure", "required":["QueueUrl"], "members":{ "QueueUrl":{ "shape":"String", "documentation":"

The URL of the Amazon SQS queue from which messages are received.

Queue URLs are case-sensitive.

" }, "AttributeNames":{ "shape":"AttributeNameList", "documentation":"

A list of attributes that need to be returned along with each message. These attributes include:

  • All - Returns all values.

  • ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds).

  • ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted.

  • SenderId

    • For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.

    • For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

  • SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds).

  • MessageDeduplicationId - Returns the value provided by the sender that calls the SendMessage action.

  • MessageGroupId - Returns the value provided by the sender that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.

  • SequenceNumber - Returns the value provided by Amazon SQS.

Any other valid special request parameters (such as the following) are ignored:

  • ApproximateNumberOfMessages

  • ApproximateNumberOfMessagesDelayed

  • ApproximateNumberOfMessagesNotVisible

  • CreatedTimestamp

  • ContentBasedDeduplication

  • DelaySeconds

  • FifoQueue

  • LastModifiedTimestamp

  • MaximumMessageSize

  • MessageRetentionPeriod

  • Policy

  • QueueArn,

  • ReceiveMessageWaitTimeSeconds

  • RedrivePolicy

  • VisibilityTimeout

" }, "MessageAttributeNames":{ "shape":"MessageAttributeNameList", "documentation":"

The name of the message attribute, where N is the index.

  • The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).

  • The name is case-sensitive and must be unique among all attribute names for the message.

  • The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).

  • The name must not start or end with a period (.), and it should not have periods in succession (..).

  • The name can be up to 256 characters long.

When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. You can also use all message attributes starting with a prefix, for example bar.*.

" }, "MaxNumberOfMessages":{ "shape":"Integer", "documentation":"

The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values are 1 to 10. Default is 1.

" }, "VisibilityTimeout":{ "shape":"Integer", "documentation":"

The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

" }, "WaitTimeSeconds":{ "shape":"Integer", "documentation":"

The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds.

" }, "ReceiveRequestAttemptId":{ "shape":"String", "documentation":"

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, you can retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.

  • You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.

  • When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.

  • If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.

  • You can retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).

  • During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.

    If a caller of the ReceiveMessage action is still processing messages when the visibility timeout expires and messages become visible, another worker reading from the same queue can receive the same messages and therefore process duplicates. Also, if a reader whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.

    To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.

  • While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.

  • If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.

The length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon Simple Queue Service Developer Guide.

" } }, "documentation":"

" }, "ReceiveMessageResult":{ "type":"structure", "members":{ "Messages":{ "shape":"MessageList", "documentation":"

A list of messages.

" } }, "documentation":"

A list of received messages.

" }, "RemovePermissionRequest":{ "type":"structure", "required":[ "QueueUrl", "Label" ], "members":{ "QueueUrl":{ "shape":"String", "documentation":"

The URL of the Amazon SQS queue from which permissions are removed.

Queue URLs are case-sensitive.

" }, "Label":{ "shape":"String", "documentation":"

The identification of the permission to remove. This is the label added using the AddPermission action.

" } }, "documentation":"

" }, "SendMessageBatchRequest":{ "type":"structure", "required":[ "QueueUrl", "Entries" ], "members":{ "QueueUrl":{ "shape":"String", "documentation":"

The URL of the Amazon SQS queue to which batched messages are sent.

Queue URLs are case-sensitive.

" }, "Entries":{ "shape":"SendMessageBatchRequestEntryList", "documentation":"

A list of SendMessageBatchRequestEntry items.

" } }, "documentation":"

" }, "SendMessageBatchRequestEntry":{ "type":"structure", "required":[ "Id", "MessageBody" ], "members":{ "Id":{ "shape":"String", "documentation":"

An identifier for a message in this batch used to communicate the result.

The Ids of a batch request need to be unique within a request

" }, "MessageBody":{ "shape":"String", "documentation":"

The body of the message.

" }, "DelaySeconds":{ "shape":"Integer", "documentation":"

The number of seconds for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied.

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

" }, "MessageAttributes":{ "shape":"MessageBodyAttributeMap", "documentation":"

Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items and Validation in the Amazon SQS Developer Guide.

", "locationName":"MessageAttribute" }, "MessageDeduplicationId":{ "shape":"String", "documentation":"

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

  • Every message must have a unique MessageDeduplicationId,

    • You may provide a MessageDeduplicationId explicitly.

    • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

    • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

    • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

  • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

  • You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.

  • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

The MessageDeduplicationId is available to the recipient of the message (this can be useful for troubleshooting delivery issues).

If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.

" }, "MessageGroupId":{ "shape":"String", "documentation":"

This parameter applies only to FIFO (first-in-first-out) queues.

The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion.

  • You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.

  • ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.

The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.

" } }, "documentation":"

Contains the details of a single Amazon SQS message along with an Id.

" }, "SendMessageBatchRequestEntryList":{ "type":"list", "member":{ "shape":"SendMessageBatchRequestEntry", "locationName":"SendMessageBatchRequestEntry" }, "flattened":true }, "SendMessageBatchResult":{ "type":"structure", "required":[ "Successful", "Failed" ], "members":{ "Successful":{ "shape":"SendMessageBatchResultEntryList", "documentation":"

A list of SendMessageBatchResultEntry items.

" }, "Failed":{ "shape":"BatchResultErrorEntryList", "documentation":"

A list of BatchResultErrorEntry items with error details about each message that can't be enqueued.

" } }, "documentation":"

For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

" }, "SendMessageBatchResultEntry":{ "type":"structure", "required":[ "Id", "MessageId", "MD5OfMessageBody" ], "members":{ "Id":{ "shape":"String", "documentation":"

An identifier for the message in this batch.

" }, "MessageId":{ "shape":"String", "documentation":"

An identifier for the message.

" }, "MD5OfMessageBody":{ "shape":"String", "documentation":"

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information on MD5, see RFC1321.

" }, "MD5OfMessageAttributes":{ "shape":"String", "documentation":"

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information on MD5, see RFC1321.

" }, "SequenceNumber":{ "shape":"String", "documentation":"

This parameter applies only to FIFO (first-in-first-out) queues.

A large, non-consecutive number that Amazon SQS assigns to each message.

The length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId.

" } }, "documentation":"

Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch .

" }, "SendMessageBatchResultEntryList":{ "type":"list", "member":{ "shape":"SendMessageBatchResultEntry", "locationName":"SendMessageBatchResultEntry" }, "flattened":true }, "SendMessageRequest":{ "type":"structure", "required":[ "QueueUrl", "MessageBody" ], "members":{ "QueueUrl":{ "shape":"String", "documentation":"

The URL of the Amazon SQS queue to which a message is sent.

Queue URLs are case-sensitive.

" }, "MessageBody":{ "shape":"String", "documentation":"

The message to send. The maximum string size is 256 KB.

The following list shows the characters (in Unicode) that are allowed in your message, according to the W3C XML specification:

  • #x9

  • #xA

  • #xD

  • #x20 to #xD7FF

  • #xE000 to #xFFFD

  • #x10000 to #x10FFFF

For more information, see RFC1321. If you send any characters that aren't included in this list, your request is rejected.

" }, "DelaySeconds":{ "shape":"Integer", "documentation":"

The number of seconds to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies.

When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

" }, "MessageAttributes":{ "shape":"MessageBodyAttributeMap", "documentation":"

Each message attribute consists of a Name, Type, and Value. For more information, see Message Attribute Items and Validation in the Amazon SQS Developer Guide.

", "locationName":"MessageAttribute" }, "MessageDeduplicationId":{ "shape":"String", "documentation":"

This parameter applies only to FIFO (first-in-first-out) queues.

The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

  • Every message must have a unique MessageDeduplicationId,

    • You may provide a MessageDeduplicationId explicitly.

    • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

    • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

    • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

  • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

  • You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.

  • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

The MessageDeduplicationId is available to the recipient of the message (this can be useful for troubleshooting delivery issues).

If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.

" }, "MessageGroupId":{ "shape":"String", "documentation":"

This parameter applies only to FIFO (first-in-first-out) queues.

The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple readers can process the queue, but the session data of each user is processed in a FIFO fashion.

  • You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.

  • ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.

The length of MessageGroupId is 128 characters. Valid values are alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.

" } }, "documentation":"

" }, "SendMessageResult":{ "type":"structure", "members":{ "MD5OfMessageBody":{ "shape":"String", "documentation":"

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information on MD5, see RFC1321.

" }, "MD5OfMessageAttributes":{ "shape":"String", "documentation":"

An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information on MD5, see RFC1321.

" }, "MessageId":{ "shape":"String", "documentation":"

An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon SQS Developer Guide.

" }, "SequenceNumber":{ "shape":"String", "documentation":"

This parameter applies only to FIFO (first-in-first-out) queues.

A large, non-consecutive number that Amazon SQS assigns to each message.

The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.

" } }, "documentation":"

The MD5OfMessageBody and MessageId elements.

" }, "SetQueueAttributesRequest":{ "type":"structure", "required":[ "QueueUrl", "Attributes" ], "members":{ "QueueUrl":{ "shape":"String", "documentation":"

The URL of the Amazon SQS queue whose attributes are set.

Queue URLs are case-sensitive.

" }, "Attributes":{ "shape":"QueueAttributeMap", "documentation":"

A map of attributes to set.

The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:

  • DelaySeconds - The number of seconds for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). The default is 0 (zero).

  • MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The default is 262,144 (256 KiB).

  • MessageRetentionPeriod - The number of seconds for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). The default is 345,600 (4 days).

  • Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.

  • ReceiveMessageWaitTimeSeconds - The number of seconds for which a ReceiveMessage action waits for a message to arrive. Valid values: an integer from 0 to 20 (seconds). The default is 0.

  • RedrivePolicy - The parameters for the dead letter queue functionality of the source queue. For more information about the redrive policy and dead letter queues, see Using Amazon SQS Dead Letter Queues in the Amazon SQS Developer Guide.

    The dead letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead letter queue of a standard queue must also be a standard queue.

  • VisibilityTimeout - The visibility timeout for the queue. Valid values: an integer from 0 to 43,200 (12 hours). The default is 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.

The following attribute applies only to FIFO (first-in-first-out) queues:

  • ContentBasedDeduplication - Enables content-based deduplication. For more information, see Exactly-Once Processing in the Amazon SQS Developer Guide.

    • Every message must have a unique MessageDeduplicationId,

      • You may provide a MessageDeduplicationId explicitly.

      • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

      • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

      • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

    • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

    • You can also use ContentBasedDeduplication for messages with identical content to be treated as duplicates.

    • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

Any other valid special request parameters (such as the following) are ignored:

  • ApproximateNumberOfMessages

  • ApproximateNumberOfMessagesDelayed

  • ApproximateNumberOfMessagesNotVisible

  • CreatedTimestamp

  • LastModifiedTimestamp

  • QueueArn

", "locationName":"Attribute" } }, "documentation":"

" }, "String":{"type":"string"}, "StringList":{ "type":"list", "member":{ "shape":"String", "locationName":"StringListValue" } }, "TooManyEntriesInBatchRequest":{ "type":"structure", "members":{ }, "documentation":"

The batch request contains more entries than permissible.

", "error":{ "code":"AWS.SimpleQueueService.TooManyEntriesInBatchRequest", "httpStatusCode":400, "senderFault":true }, "exception":true }, "UnsupportedOperation":{ "type":"structure", "members":{ }, "documentation":"

Error code 400. Unsupported operation.

", "error":{ "code":"AWS.SimpleQueueService.UnsupportedOperation", "httpStatusCode":400, "senderFault":true }, "exception":true } }, "documentation":"

Welcome to the Amazon Simple Queue Service API Reference.

Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.

Standard queues are available in all regions. FIFO queues are available in US West (Oregon) and US East (Ohio).

You can use AWS SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:

  • Cryptographically sign your service requests

  • Retry requests

  • Handle error responses

Additional Information

" } botocore-1.5.7/botocore/data/discovery/0000777454262600001440000000000013042511307021142 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/discovery/2015-11-01/0000777454262600001440000000000013042511307022166 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/discovery/2015-11-01/service-2.json0000666454262600001440000014636513042511306024676 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-11-01", "endpointPrefix":"discovery", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"AWS Application Discovery Service", "signatureVersion":"v4", "targetPrefix":"AWSPoseidonService_V2015_11_01", "uid":"discovery-2015-11-01" }, "operations":{ "AssociateConfigurationItemsToApplication":{ "name":"AssociateConfigurationItemsToApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"AssociateConfigurationItemsToApplicationRequest"}, "output":{"shape":"AssociateConfigurationItemsToApplicationResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"} ], "documentation":"

Associates one or more configuration items with an application.

" }, "CreateApplication":{ "name":"CreateApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateApplicationRequest"}, "output":{"shape":"CreateApplicationResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"} ], "documentation":"

Creates an application with the given name and description.

" }, "CreateTags":{ "name":"CreateTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateTagsRequest"}, "output":{"shape":"CreateTagsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"} ], "documentation":"

Creates one or more tags for configuration items. Tags are metadata that help you categorize IT assets. This API accepts a list of multiple configuration items.

" }, "DeleteApplications":{ "name":"DeleteApplications", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteApplicationsRequest"}, "output":{"shape":"DeleteApplicationsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"} ], "documentation":"

Deletes a list of applications and their associations with configuration items.

" }, "DeleteTags":{ "name":"DeleteTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteTagsRequest"}, "output":{"shape":"DeleteTagsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"} ], "documentation":"

Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.

" }, "DescribeAgents":{ "name":"DescribeAgents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeAgentsRequest"}, "output":{"shape":"DescribeAgentsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"} ], "documentation":"

Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an ID.

" }, "DescribeConfigurations":{ "name":"DescribeConfigurations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeConfigurationsRequest"}, "output":{"shape":"DescribeConfigurationsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"} ], "documentation":"

Retrieves attributes for a list of configuration item IDs. All of the supplied IDs must be for the same asset type (server, application, process, or connection). Output fields are specific to the asset type selected. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, and number of network cards.

For a complete list of outputs for each asset type, see Querying Discovered Configuration Items.

" }, "DescribeExportConfigurations":{ "name":"DescribeExportConfigurations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeExportConfigurationsRequest"}, "output":{"shape":"DescribeExportConfigurationsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"} ], "documentation":"

Retrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.

" }, "DescribeTags":{ "name":"DescribeTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeTagsRequest"}, "output":{"shape":"DescribeTagsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"} ], "documentation":"

Retrieves a list of configuration items that are tagged with a specific tag. Or retrieves a list of all tags assigned to a specific configuration item.

" }, "DisassociateConfigurationItemsFromApplication":{ "name":"DisassociateConfigurationItemsFromApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisassociateConfigurationItemsFromApplicationRequest"}, "output":{"shape":"DisassociateConfigurationItemsFromApplicationResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"} ], "documentation":"

Disassociates one or more configuration items from an application.

" }, "ExportConfigurations":{ "name":"ExportConfigurations", "http":{ "method":"POST", "requestUri":"/" }, "output":{"shape":"ExportConfigurationsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"}, {"shape":"OperationNotPermittedException"} ], "documentation":"

Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID which you can query using the DescribeExportConfigurations API. The system imposes a limit of two configuration exports in six hours.

" }, "GetDiscoverySummary":{ "name":"GetDiscoverySummary", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDiscoverySummaryRequest"}, "output":{"shape":"GetDiscoverySummaryResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"} ], "documentation":"

Retrieves a short summary of discovered assets.

" }, "ListConfigurations":{ "name":"ListConfigurations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListConfigurationsRequest"}, "output":{"shape":"ListConfigurationsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"} ], "documentation":"

Retrieves a list of configuration items according to criteria you specify in a filter. The filter criteria identify relationship requirements.

" }, "ListServerNeighbors":{ "name":"ListServerNeighbors", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListServerNeighborsRequest"}, "output":{"shape":"ListServerNeighborsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"} ], "documentation":"

Retrieves a list of servers which are one network hop away from a specified server.

" }, "StartDataCollectionByAgentIds":{ "name":"StartDataCollectionByAgentIds", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartDataCollectionByAgentIdsRequest"}, "output":{"shape":"StartDataCollectionByAgentIdsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"} ], "documentation":"

Instructs the specified agents or Connectors to start collecting data.

" }, "StopDataCollectionByAgentIds":{ "name":"StopDataCollectionByAgentIds", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopDataCollectionByAgentIdsRequest"}, "output":{"shape":"StopDataCollectionByAgentIdsResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"} ], "documentation":"

Instructs the specified agents or Connectors to stop collecting data.

" }, "UpdateApplication":{ "name":"UpdateApplication", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateApplicationRequest"}, "output":{"shape":"UpdateApplicationResponse"}, "errors":[ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidParameterException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ServerInternalErrorException"} ], "documentation":"

Updates metadata about an application.

" } }, "shapes":{ "AgentConfigurationStatus":{ "type":"structure", "members":{ "agentId":{ "shape":"String", "documentation":"

The agent/Connector ID.

" }, "operationSucceeded":{ "shape":"Boolean", "documentation":"

Information about the status of the StartDataCollection and StopDataCollection operations. The system has recorded the data collection operation. The agent/Connector receives this command the next time it polls for a new command.

" }, "description":{ "shape":"String", "documentation":"

A description of the operation performed.

" } }, "documentation":"

Information about agents or Connectors that were instructed to start collecting data. Information includes the agent/Connector ID, a description of the operation, and whether or not the agent/Connector configuration was updated.

" }, "AgentConfigurationStatusList":{ "type":"list", "member":{"shape":"AgentConfigurationStatus"} }, "AgentId":{"type":"string"}, "AgentIds":{ "type":"list", "member":{"shape":"AgentId"} }, "AgentInfo":{ "type":"structure", "members":{ "agentId":{ "shape":"AgentId", "documentation":"

The agent or connector ID.

" }, "hostName":{ "shape":"String", "documentation":"

The name of the host where the agent or connector resides. The host can be a server or virtual machine.

" }, "agentNetworkInfoList":{ "shape":"AgentNetworkInfoList", "documentation":"

Network details about the host where the agent or connector resides.

" }, "connectorId":{ "shape":"String", "documentation":"

The ID of the connector.

" }, "version":{ "shape":"String", "documentation":"

The agent or connector version.

" }, "health":{ "shape":"AgentStatus", "documentation":"

The health of the agent or connector.

" }, "lastHealthPingTime":{ "shape":"String", "documentation":"

Time since agent or connector health was reported.

" }, "collectionStatus":{ "shape":"String", "documentation":"

Status of the collection process for an agent or connector.

" }, "agentType":{ "shape":"String", "documentation":"

Type of agent.

" }, "registeredTime":{ "shape":"String", "documentation":"

Agent's first registration time stamp in UTC.

" } }, "documentation":"

Information about agents or connectors associated with the user’s AWS account. Information includes agent or connector IDs, IP addresses, media access control (MAC) addresses, agent or connector health, hostname where the agent or connector resides, and agent version for each agent.

" }, "AgentNetworkInfo":{ "type":"structure", "members":{ "ipAddress":{ "shape":"String", "documentation":"

The IP address for the host where the agent/Connector resides.

" }, "macAddress":{ "shape":"String", "documentation":"

The MAC address for the host where the agent/Connector resides.

" } }, "documentation":"

Network details about the host where the agent/Connector resides.

" }, "AgentNetworkInfoList":{ "type":"list", "member":{"shape":"AgentNetworkInfo"} }, "AgentStatus":{ "type":"string", "enum":[ "HEALTHY", "UNHEALTHY", "RUNNING", "UNKNOWN", "BLACKLISTED", "SHUTDOWN" ] }, "AgentsInfo":{ "type":"list", "member":{"shape":"AgentInfo"} }, "ApplicationId":{"type":"string"}, "ApplicationIdsList":{ "type":"list", "member":{"shape":"ApplicationId"} }, "AssociateConfigurationItemsToApplicationRequest":{ "type":"structure", "required":[ "applicationConfigurationId", "configurationIds" ], "members":{ "applicationConfigurationId":{ "shape":"ApplicationId", "documentation":"

The configuration ID of an application with which items are to be associated.

" }, "configurationIds":{ "shape":"ConfigurationIdList", "documentation":"

The ID of each configuration item to be associated with an application.

" } } }, "AssociateConfigurationItemsToApplicationResponse":{ "type":"structure", "members":{ } }, "AuthorizationErrorException":{ "type":"structure", "members":{ "message":{"shape":"Message"} }, "documentation":"

The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.

", "exception":true }, "Boolean":{"type":"boolean"}, "BoxedInteger":{ "type":"integer", "box":true }, "Condition":{"type":"string"}, "Configuration":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "ConfigurationId":{"type":"string"}, "ConfigurationIdList":{ "type":"list", "member":{"shape":"ConfigurationId"} }, "ConfigurationItemType":{ "type":"string", "enum":[ "SERVER", "PROCESS", "CONNECTION", "APPLICATION" ] }, "ConfigurationTag":{ "type":"structure", "members":{ "configurationType":{ "shape":"ConfigurationItemType", "documentation":"

A type of IT asset that you want to tag.

" }, "configurationId":{ "shape":"ConfigurationId", "documentation":"

The configuration ID for the item you want to tag. You can specify a list of keys and values.

" }, "key":{ "shape":"TagKey", "documentation":"

A type of tag to filter on. For example, serverType.

" }, "value":{ "shape":"TagValue", "documentation":"

A value to filter on. For example key = serverType and value = web server.

" }, "timeOfCreation":{ "shape":"TimeStamp", "documentation":"

The time the configuration tag was created in Coordinated Universal Time (UTC).

" } }, "documentation":"

Tags for a configuration item. Tags are metadata that help you categorize IT assets.

" }, "ConfigurationTagSet":{ "type":"list", "member":{ "shape":"ConfigurationTag", "locationName":"item" } }, "Configurations":{ "type":"list", "member":{"shape":"Configuration"} }, "ConfigurationsDownloadUrl":{"type":"string"}, "ConfigurationsExportId":{"type":"string"}, "CreateApplicationRequest":{ "type":"structure", "required":["name"], "members":{ "name":{ "shape":"String", "documentation":"

Name of the application to be created.

" }, "description":{ "shape":"String", "documentation":"

Description of the application to be created.

" } } }, "CreateApplicationResponse":{ "type":"structure", "members":{ "configurationId":{ "shape":"String", "documentation":"

Configuration ID of an application to be created.

" } } }, "CreateTagsRequest":{ "type":"structure", "required":[ "configurationIds", "tags" ], "members":{ "configurationIds":{ "shape":"ConfigurationIdList", "documentation":"

A list of configuration items that you want to tag.

" }, "tags":{ "shape":"TagSet", "documentation":"

Tags that you want to associate with one or more configuration items. Specify the tags that you want to create in a key-value format. For example:

{\"key\": \"serverType\", \"value\": \"webServer\"}

" } } }, "CreateTagsResponse":{ "type":"structure", "members":{ } }, "CustomerAgentInfo":{ "type":"structure", "required":[ "activeAgents", "healthyAgents", "blackListedAgents", "shutdownAgents", "unhealthyAgents", "totalAgents", "unknownAgents" ], "members":{ "activeAgents":{ "shape":"Integer", "documentation":"

Number of active discovery agents.

" }, "healthyAgents":{ "shape":"Integer", "documentation":"

Number of healthy discovery agents

" }, "blackListedAgents":{ "shape":"Integer", "documentation":"

Number of blacklisted discovery agents.

" }, "shutdownAgents":{ "shape":"Integer", "documentation":"

Number of discovery agents with status SHUTDOWN.

" }, "unhealthyAgents":{ "shape":"Integer", "documentation":"

Number of unhealthy discovery agents.

" }, "totalAgents":{ "shape":"Integer", "documentation":"

Total number of discovery agents.

" }, "unknownAgents":{ "shape":"Integer", "documentation":"

Number of unknown discovery agents.

" } }, "documentation":"

Inventory data for installed discovery agents.

" }, "CustomerConnectorInfo":{ "type":"structure", "required":[ "activeConnectors", "healthyConnectors", "blackListedConnectors", "shutdownConnectors", "unhealthyConnectors", "totalConnectors", "unknownConnectors" ], "members":{ "activeConnectors":{ "shape":"Integer", "documentation":"

Number of active discovery connectors.

" }, "healthyConnectors":{ "shape":"Integer", "documentation":"

Number of healthy discovery connectors.

" }, "blackListedConnectors":{ "shape":"Integer", "documentation":"

Number of blacklisted discovery connectors.

" }, "shutdownConnectors":{ "shape":"Integer", "documentation":"

Number of discovery connectors with status SHUTDOWN,

" }, "unhealthyConnectors":{ "shape":"Integer", "documentation":"

Number of unhealthy discovery connectors.

" }, "totalConnectors":{ "shape":"Integer", "documentation":"

Total number of discovery connectors.

" }, "unknownConnectors":{ "shape":"Integer", "documentation":"

Number of unknown discovery connectors.

" } }, "documentation":"

Inventory data for installed discovery connectors.

" }, "DeleteApplicationsRequest":{ "type":"structure", "required":["configurationIds"], "members":{ "configurationIds":{ "shape":"ApplicationIdsList", "documentation":"

Configuration ID of an application to be deleted.

" } } }, "DeleteApplicationsResponse":{ "type":"structure", "members":{ } }, "DeleteTagsRequest":{ "type":"structure", "required":["configurationIds"], "members":{ "configurationIds":{ "shape":"ConfigurationIdList", "documentation":"

A list of configuration items with tags that you want to delete.

" }, "tags":{ "shape":"TagSet", "documentation":"

Tags that you want to delete from one or more configuration items. Specify the tags that you want to delete in a key-value format. For example:

{\"key\": \"serverType\", \"value\": \"webServer\"}

" } } }, "DeleteTagsResponse":{ "type":"structure", "members":{ } }, "DescribeAgentsRequest":{ "type":"structure", "members":{ "agentIds":{ "shape":"AgentIds", "documentation":"

The agent or the Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your AWS user account.

" }, "filters":{ "shape":"Filters", "documentation":"

You can filter the request using various logical operators and a key-value format. For example:

{\"key\": \"collectionStatus\", \"value\": \"STARTED\"}

For a complete list of filter options and guidance about using them with this action, see Managing AWS Application Discovery Service Agents and the AWS Application Discovery Connector .

" }, "maxResults":{ "shape":"Integer", "documentation":"

The total number of agents/Connectors to return in a single page of output. The maximum value is 100.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

" } } }, "DescribeAgentsResponse":{ "type":"structure", "members":{ "agentsInfo":{ "shape":"AgentsInfo", "documentation":"

Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an agent/Connector ID. The output includes agent/Connector IDs, IP addresses, media access control (MAC) addresses, agent/Connector health, host name where the agent/Connector resides, and the version number of each agent/Connector.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token to retrieve the next set of results. For example, if you specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

" } } }, "DescribeConfigurationsAttribute":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "DescribeConfigurationsAttributes":{ "type":"list", "member":{"shape":"DescribeConfigurationsAttribute"} }, "DescribeConfigurationsRequest":{ "type":"structure", "required":["configurationIds"], "members":{ "configurationIds":{ "shape":"ConfigurationIdList", "documentation":"

One or more configuration IDs.

" } } }, "DescribeConfigurationsResponse":{ "type":"structure", "members":{ "configurations":{ "shape":"DescribeConfigurationsAttributes", "documentation":"

A key in the response map. The value is an array of data.

" } } }, "DescribeExportConfigurationsRequest":{ "type":"structure", "members":{ "exportIds":{ "shape":"ExportIds", "documentation":"

A unique identifier that you can use to query the export status.

" }, "maxResults":{ "shape":"Integer", "documentation":"

The maximum number of results that you want to display as a part of the query.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to get the next set of results. For example, if you specified 100 IDs for DescribeExportConfigurationsRequest$exportIds but set DescribeExportConfigurationsRequest$maxResults to 10, you will get results in a set of 10. Use the token in the query to get the next set of 10.

" } } }, "DescribeExportConfigurationsResponse":{ "type":"structure", "members":{ "exportsInfo":{ "shape":"ExportsInfo", "documentation":"

Returns export details. When the status is complete, the response includes a URL for an Amazon S3 bucket where you can view the data in a CSV file.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to get the next set of results. For example, if you specified 100 IDs for DescribeExportConfigurationsRequest$exportIds but set DescribeExportConfigurationsRequest$maxResults to 10, you will get results in a set of 10. Use the token in the query to get the next set of 10.

" } } }, "DescribeTagsRequest":{ "type":"structure", "members":{ "filters":{ "shape":"TagFilters", "documentation":"

You can filter the list using a key-value format. You can separate these items by using logical operators. Allowed filters include tagKey, tagValue, and configurationId.

For a complete list of filter options and guidance about using them with this action, see Managing AWS Application Discovery Service Agents and the AWS Application Discovery Connector .

" }, "maxResults":{ "shape":"Integer", "documentation":"

The total number of items to return in a single page of output. The maximum value is 100.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

A token to start the list. Use this token to get the next set of results.

" } } }, "DescribeTagsResponse":{ "type":"structure", "members":{ "tags":{ "shape":"ConfigurationTagSet", "documentation":"

Depending on the input, this is a list of configuration items tagged with a specific tag, or a list of tags for a specific configuration item.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The call returns a token. Use this token to get the next set of results.

" } } }, "DisassociateConfigurationItemsFromApplicationRequest":{ "type":"structure", "required":[ "applicationConfigurationId", "configurationIds" ], "members":{ "applicationConfigurationId":{ "shape":"ApplicationId", "documentation":"

Configuration ID of an application from which each item will be disassociated.

" }, "configurationIds":{ "shape":"ConfigurationIdList", "documentation":"

Configuration ID of each item be be disassociated from an application.

" } } }, "DisassociateConfigurationItemsFromApplicationResponse":{ "type":"structure", "members":{ } }, "ExportConfigurationsResponse":{ "type":"structure", "members":{ "exportId":{ "shape":"ConfigurationsExportId", "documentation":"

A unique identifier that you can use to query the export status.

" } } }, "ExportIds":{ "type":"list", "member":{"shape":"ConfigurationsExportId"} }, "ExportInfo":{ "type":"structure", "required":[ "exportId", "exportStatus", "statusMessage", "exportRequestTime" ], "members":{ "exportId":{ "shape":"ConfigurationsExportId", "documentation":"

A unique identifier that you can use to query the export.

" }, "exportStatus":{ "shape":"ExportStatus", "documentation":"

The status of the configuration data export. The status can succeed, fail, or be in-progress.

" }, "statusMessage":{ "shape":"ExportStatusMessage", "documentation":"

Helpful status messages for API callers. For example: Too many exports in the last 6 hours. Export in progress. Export was successful.

" }, "configurationsDownloadUrl":{ "shape":"ConfigurationsDownloadUrl", "documentation":"

A URL for an Amazon S3 bucket where you can review the configuration data. The URL is displayed only if the export succeeded.

" }, "exportRequestTime":{ "shape":"ExportRequestTime", "documentation":"

The time the configuration data export was initiated.

" } }, "documentation":"

Information regarding the export status of the discovered data. The value is an array of objects.

" }, "ExportRequestTime":{"type":"timestamp"}, "ExportStatus":{ "type":"string", "enum":[ "FAILED", "SUCCEEDED", "IN_PROGRESS" ] }, "ExportStatusMessage":{"type":"string"}, "ExportsInfo":{ "type":"list", "member":{"shape":"ExportInfo"} }, "Filter":{ "type":"structure", "required":[ "name", "values", "condition" ], "members":{ "name":{ "shape":"String", "documentation":"

The name of the filter.

" }, "values":{ "shape":"FilterValues", "documentation":"

A string value that you want to filter on. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value.

" }, "condition":{ "shape":"Condition", "documentation":"

A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes all filters as though concatenated by AND. If you specify multiple values for a particular filter, the system differentiates the values using OR. Calling either DescribeConfigurations or ListConfigurations returns attributes of matching configuration items.

" } }, "documentation":"

A filter that can use conditional operators.

for a complete list of filters and guidance for using them with the Application Discovery Service, see Querying Discovered Configuration Items.

" }, "FilterName":{"type":"string"}, "FilterValue":{"type":"string"}, "FilterValues":{ "type":"list", "member":{ "shape":"FilterValue", "locationName":"item" } }, "Filters":{ "type":"list", "member":{"shape":"Filter"} }, "GetDiscoverySummaryRequest":{ "type":"structure", "members":{ } }, "GetDiscoverySummaryResponse":{ "type":"structure", "members":{ "servers":{ "shape":"Long", "documentation":"

Number of servers discovered.

" }, "applications":{ "shape":"Long", "documentation":"

Number of applications discovered.

" }, "serversMappedToApplications":{ "shape":"Long", "documentation":"

Number of servers mapped to applications.

" }, "serversMappedtoTags":{ "shape":"Long", "documentation":"

Number of servers mapped to tags.

" }, "agentSummary":{ "shape":"CustomerAgentInfo", "documentation":"

Details about discovered agents, including agent status and health.

" }, "connectorSummary":{ "shape":"CustomerConnectorInfo", "documentation":"

Details about discovered connectors, including connector status and health.

" } } }, "Integer":{"type":"integer"}, "InvalidParameterException":{ "type":"structure", "members":{ "message":{"shape":"Message"} }, "documentation":"

One or more parameters are not valid. Verify the parameters and try again.

", "exception":true }, "InvalidParameterValueException":{ "type":"structure", "members":{ "message":{"shape":"Message"} }, "documentation":"

The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.

", "exception":true }, "ListConfigurationsRequest":{ "type":"structure", "required":["configurationType"], "members":{ "configurationType":{ "shape":"ConfigurationItemType", "documentation":"

A valid configuration identified by the Discovery Service.

" }, "filters":{ "shape":"Filters", "documentation":"

You can filter the request using various logical operators and a key-value format. For example:

{\"key\": \"serverType\", \"value\": \"webServer\"}

For a complete list of filter options and guidance about using them with this action, see Querying Discovered Configuration Items.

" }, "maxResults":{ "shape":"Integer", "documentation":"

The total number of items to return. The maximum value is 100.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token to retrieve the next set of results. For example, if a previous call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

" }, "orderBy":{ "shape":"OrderByList", "documentation":"

Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see Querying Discovered Configuration Items.

" } } }, "ListConfigurationsResponse":{ "type":"structure", "members":{ "configurations":{ "shape":"Configurations", "documentation":"

Returns configuration details, including the configuration ID, attribute names, and attribute values.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

Token to retrieve the next set of results. For example, if your call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

" } } }, "ListServerNeighborsRequest":{ "type":"structure", "required":["configurationId"], "members":{ "configurationId":{ "shape":"ConfigurationId", "documentation":"

Configuration ID of the server for which neighbors are being listed.

" }, "portInformationNeeded":{ "shape":"Boolean", "documentation":"

Flag to indicate if port and protocol information is needed as part of the response.

" }, "neighborConfigurationIds":{ "shape":"ConfigurationIdList", "documentation":"

List of configuration IDs to test for one-hop-away.

" }, "maxResults":{ "shape":"Integer", "documentation":"

Maximum number of results to return in a single page of output.

" }, "nextToken":{ "shape":"String", "documentation":"

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

" } } }, "ListServerNeighborsResponse":{ "type":"structure", "required":["neighbors"], "members":{ "neighbors":{ "shape":"NeighborDetailsList", "documentation":"

List of distinct servers that are one hop away from the given server.

" }, "nextToken":{ "shape":"String", "documentation":"

Token to retrieve the next set of results. For example, if you specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

" }, "knownDependencyCount":{ "shape":"Long", "documentation":"

Count of distinct servers that are one hop away from the given server.

" } } }, "Long":{"type":"long"}, "Message":{"type":"string"}, "NeighborConnectionDetail":{ "type":"structure", "required":[ "sourceServerId", "destinationServerId", "connectionsCount" ], "members":{ "sourceServerId":{ "shape":"ConfigurationId", "documentation":"

ID of server that opened the network connection.

" }, "destinationServerId":{ "shape":"ConfigurationId", "documentation":"

ID of the server that accepted the networker connection.

" }, "destinationPort":{ "shape":"BoxedInteger", "documentation":"

Destination network port for the connection.

" }, "transportProtocol":{ "shape":"String", "documentation":"

Network protocol used for the connection.

" }, "connectionsCount":{ "shape":"Long", "documentation":"

Number of open network connections with the neighboring server.

" } }, "documentation":"

Details about neighboring servers.

" }, "NeighborDetailsList":{ "type":"list", "member":{"shape":"NeighborConnectionDetail"} }, "NextToken":{"type":"string"}, "OperationNotPermittedException":{ "type":"structure", "members":{ "message":{"shape":"Message"} }, "documentation":"

This operation is not permitted.

", "exception":true }, "OrderByElement":{ "type":"structure", "required":["fieldName"], "members":{ "fieldName":{ "shape":"String", "documentation":"

Field to order on.

" }, "sortOrder":{ "shape":"orderString", "documentation":"

Ordering direction.

" } }, "documentation":"

Field and direction for ordered output.

" }, "OrderByList":{ "type":"list", "member":{"shape":"OrderByElement"} }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"Message"} }, "documentation":"

The specified configuration ID was not located. Verify the configuration ID and try again.

", "exception":true }, "ServerInternalErrorException":{ "type":"structure", "members":{ "message":{"shape":"Message"} }, "documentation":"

The server experienced an internal error. Try again.

", "exception":true, "fault":true }, "StartDataCollectionByAgentIdsRequest":{ "type":"structure", "required":["agentIds"], "members":{ "agentIds":{ "shape":"AgentIds", "documentation":"

The IDs of the agents or Connectors that you want to start collecting data. If you send a request to an agent/Connector ID that you do not have permission to contact, according to your AWS account, the service does not throw an exception. Instead, it returns the error in the Description field. If you send a request to multiple agents/Connectors and you do not have permission to contact some of those agents/Connectors, the system does not throw an exception. Instead, the system shows Failed in the Description field.

" } } }, "StartDataCollectionByAgentIdsResponse":{ "type":"structure", "members":{ "agentsConfigurationStatus":{ "shape":"AgentConfigurationStatusList", "documentation":"

Information about agents or the Connector that were instructed to start collecting data. Information includes the agent/Connector ID, a description of the operation performed, and whether or not the agent/Connector configuration was updated.

" } } }, "StopDataCollectionByAgentIdsRequest":{ "type":"structure", "required":["agentIds"], "members":{ "agentIds":{ "shape":"AgentIds", "documentation":"

The IDs of the agents or Connectors that you want to stop collecting data.

" } } }, "StopDataCollectionByAgentIdsResponse":{ "type":"structure", "members":{ "agentsConfigurationStatus":{ "shape":"AgentConfigurationStatusList", "documentation":"

Information about agents or the Connector that were instructed to stop collecting data. Information includes the agent/Connector ID, a description of the operation performed, and whether or not the agent/Connector configuration was updated.

" } } }, "String":{"type":"string"}, "Tag":{ "type":"structure", "required":[ "key", "value" ], "members":{ "key":{ "shape":"TagKey", "documentation":"

A type of tag to filter on.

" }, "value":{ "shape":"TagValue", "documentation":"

A value for a tag key to filter on.

" } }, "documentation":"

Metadata that help you categorize IT assets.

" }, "TagFilter":{ "type":"structure", "required":[ "name", "values" ], "members":{ "name":{ "shape":"FilterName", "documentation":"

A name of a tag filter.

" }, "values":{ "shape":"FilterValues", "documentation":"

Values of a tag filter.

" } }, "documentation":"

The name of a tag filter. Valid names are: tagKey, tagValue, configurationId.

" }, "TagFilters":{ "type":"list", "member":{"shape":"TagFilter"} }, "TagKey":{"type":"string"}, "TagSet":{ "type":"list", "member":{ "shape":"Tag", "locationName":"item" } }, "TagValue":{"type":"string"}, "TimeStamp":{"type":"timestamp"}, "UpdateApplicationRequest":{ "type":"structure", "required":["configurationId"], "members":{ "configurationId":{ "shape":"ApplicationId", "documentation":"

Configuration ID of the application to be updated.

" }, "name":{ "shape":"String", "documentation":"

New name of the application to be updated.

" }, "description":{ "shape":"String", "documentation":"

New description of the application to be updated.

" } } }, "UpdateApplicationResponse":{ "type":"structure", "members":{ } }, "orderString":{ "type":"string", "enum":[ "ASC", "DESC" ] } }, "documentation":"AWS Application Discovery Service

AWS Application Discovery Service helps you plan application migration projects by automatically identifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects application performance data, which can help you assess the outcome of your migration. The data collected by Application Discovery Service is securely retained in an Amazon-hosted and managed database in the cloud. You can export the data as a CSV or XML file into your preferred visualization tool or cloud-migration solution to plan your migration. For more information, see the Application Discovery Service FAQ.

Application Discovery Service offers two modes of operation.

  • Agentless discovery mode is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment. Agentless discovery doesn't collect information about software and software dependencies. It also doesn't work in non-VMware environments. We recommend that you use agent-based discovery for non-VMware environments and if you want to collect information about software and software dependencies. You can also run agent-based and agentless discovery simultaneously. Use agentless discovery to quickly complete the initial infrastructure assessment and then install agents on select hosts to gather information about software and software dependencies.

  • Agent-based discovery mode collects a richer set of data than agentless discovery by using Amazon software, the AWS Application Discovery Agent, which you install on one or more hosts in your data center. The agent captures infrastructure and application information, including an inventory of installed software applications, system and process performance, resource utilization, and network dependencies between workloads. The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud.

Application Discovery Service integrates with application discovery solutions from AWS Partner Network (APN) partners. Third-party application discovery tools can query the Application Discovery Service and write to the Application Discovery Service database using a public API. You can then import the data into either a visualization tool or cloud-migration solution.

Application Discovery Service doesn't gather sensitive information. All data is handled according to the AWS Privacy Policy. You can operate Application Discovery Service using offline mode to inspect collected data before it is shared with the service.

Your AWS account must be granted access to Application Discovery Service, a process called whitelisting. This is true for AWS partners and customers alike. To request access, sign up for the AWS Application Discovery Service here. We will send you information about how to get started.

This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see AWS SDKs.

This guide is intended for use with the AWS Application Discovery Service User Guide .

" } botocore-1.5.7/botocore/data/waf/0000777454262600001440000000000013042511307017710 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/waf/2015-08-24/0000777454262600001440000000000013042511307020747 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/waf/2015-08-24/paginators-1.json0000666454262600001440000000224613042511306024152 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListByteMatchSets": { "input_token": "NextMarker", "output_token": "NextMarker", "limit_key": "Limit", "result_key": "ByteMatchSets" }, "ListIPSets": { "input_token": "NextMarker", "output_token": "NextMarker", "limit_key": "Limit", "result_key": "IPSets" }, "ListRules": { "input_token": "NextMarker", "output_token": "NextMarker", "limit_key": "Limit", "result_key": "Rules" }, "ListSizeConstraintSets": { "input_token": "NextMarker", "output_token": "NextMarker", "limit_key": "Limit", "result_key": "SizeConstraintSets" }, "ListSqlInjectionMatchSets": { "input_token": "NextMarker", "output_token": "NextMarker", "limit_key": "Limit", "result_key": "SqlInjectionMatchSets" }, "ListWebACLs": { "input_token": "NextMarker", "output_token": "NextMarker", "limit_key": "Limit", "result_key": "WebACLs" }, "ListXssMatchSets": { "input_token": "NextMarker", "output_token": "NextMarker", "limit_key": "Limit", "result_key": "XssMatchSets" } } } botocore-1.5.7/botocore/data/waf/2015-08-24/service-2.json0000666454262600001440000055571213042511306023457 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "uid":"waf-2015-08-24", "apiVersion":"2015-08-24", "endpointPrefix":"waf", "jsonVersion":"1.1", "protocol":"json", "serviceAbbreviation":"WAF", "serviceFullName":"AWS WAF", "signatureVersion":"v4", "targetPrefix":"AWSWAF_20150824", "uid":"waf-2015-08-24" }, "operations":{ "CreateByteMatchSet":{ "name":"CreateByteMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateByteMatchSetRequest"}, "output":{"shape":"CreateByteMatchSetResponse"}, "errors":[ {"shape":"WAFDisallowedNameException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests.

To create and configure a ByteMatchSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request.

  2. Submit a CreateByteMatchSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.

  4. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "CreateIPSet":{ "name":"CreateIPSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateIPSetRequest"}, "output":{"shape":"CreateIPSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFDisallowedNameException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Creates an IPSet, which you use to specify which web requests you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.

To create and configure an IPSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request.

  2. Submit a CreateIPSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

  4. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "CreateRule":{ "name":"CreateRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateRuleRequest"}, "output":{"shape":"CreateRuleResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFDisallowedNameException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose you add the following to a Rule:

  • An IPSet that matches the IP address 192.0.2.44/32

  • A ByteMatchSet that matches BadBot in the User-Agent header

You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.

To create and configure a Rule, perform the following steps:

  1. Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.

  3. Submit a CreateRule request.

  4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.

  5. Submit an UpdateRule request to specify the predicates that you want to include in the Rule.

  6. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "CreateSizeConstraintSet":{ "name":"CreateSizeConstraintSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSizeConstraintSetRequest"}, "output":{"shape":"CreateSizeConstraintSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFDisallowedNameException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.

To create and configure a SizeConstraintSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request.

  2. Submit a CreateSizeConstraintSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.

  4. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "CreateSqlInjectionMatchSet":{ "name":"CreateSqlInjectionMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateSqlInjectionMatchSetRequest"}, "output":{"shape":"CreateSqlInjectionMatchSetResponse"}, "errors":[ {"shape":"WAFDisallowedNameException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

To create and configure a SqlInjectionMatchSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request.

  2. Submit a CreateSqlInjectionMatchSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request.

  4. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "CreateWebACL":{ "name":"CreateWebACL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateWebACLRequest"}, "output":{"shape":"CreateWebACLResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFDisallowedNameException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule.

You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action.

To create and configure a WebACL, perform the following steps:

  1. Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

  2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request.

  4. Submit a CreateWebACL request.

  5. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.

  6. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.

For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.

" }, "CreateXssMatchSet":{ "name":"CreateXssMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateXssMatchSetRequest"}, "output":{"shape":"CreateXssMatchSetResponse"}, "errors":[ {"shape":"WAFDisallowedNameException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

To create and configure an XssMatchSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request.

  2. Submit a CreateXssMatchSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request.

  4. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "DeleteByteMatchSet":{ "name":"DeleteByteMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteByteMatchSetRequest"}, "output":{"shape":"DeleteByteMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters).

If you just want to remove a ByteMatchSet from a Rule, use UpdateRule.

To permanently delete a ByteMatchSet, perform the following steps:

  1. Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request.

  3. Submit a DeleteByteMatchSet request.

" }, "DeleteIPSet":{ "name":"DeleteIPSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteIPSetRequest"}, "output":{"shape":"DeleteIPSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses.

If you just want to remove an IPSet from a Rule, use UpdateRule.

To permanently delete an IPSet from AWS WAF, perform the following steps:

  1. Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request.

  3. Submit a DeleteIPSet request.

" }, "DeleteRule":{ "name":"DeleteRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRuleRequest"}, "output":{"shape":"DeleteRuleResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.

If you just want to remove a Rule from a WebACL, use UpdateWebACL.

To permanently delete a Rule from AWS WAF, perform the following steps:

  1. Update the Rule to remove predicates, if any. For more information, see UpdateRule.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request.

  3. Submit a DeleteRule request.

" }, "DeleteSizeConstraintSet":{ "name":"DeleteSizeConstraintSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSizeConstraintSetRequest"}, "output":{"shape":"DeleteSizeConstraintSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters).

If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule.

To permanently delete a SizeConstraintSet, perform the following steps:

  1. Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request.

  3. Submit a DeleteSizeConstraintSet request.

" }, "DeleteSqlInjectionMatchSet":{ "name":"DeleteSqlInjectionMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSqlInjectionMatchSetRequest"}, "output":{"shape":"DeleteSqlInjectionMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects.

If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule.

To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps:

  1. Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request.

  3. Submit a DeleteSqlInjectionMatchSet request.

" }, "DeleteWebACL":{ "name":"DeleteWebACL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteWebACLRequest"}, "output":{"shape":"DeleteWebACLResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules.

To delete a WebACL, perform the following steps:

  1. Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request.

  3. Submit a DeleteWebACL request.

" }, "DeleteXssMatchSet":{ "name":"DeleteXssMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteXssMatchSetRequest"}, "output":{"shape":"DeleteXssMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFNonEmptyEntityException"} ], "documentation":"

Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects.

If you just want to remove an XssMatchSet from a Rule, use UpdateRule.

To permanently delete an XssMatchSet from AWS WAF, perform the following steps:

  1. Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request.

  3. Submit a DeleteXssMatchSet request.

" }, "GetByteMatchSet":{ "name":"GetByteMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetByteMatchSetRequest"}, "output":{"shape":"GetByteMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

Returns the ByteMatchSet specified by ByteMatchSetId.

" }, "GetChangeToken":{ "name":"GetChangeToken", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetChangeTokenRequest"}, "output":{"shape":"GetChangeTokenResponse"}, "errors":[ {"shape":"WAFInternalErrorException"} ], "documentation":"

When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.

Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request.

When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.

" }, "GetChangeTokenStatus":{ "name":"GetChangeTokenStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetChangeTokenStatusRequest"}, "output":{"shape":"GetChangeTokenStatusResponse"}, "errors":[ {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInternalErrorException"} ], "documentation":"

Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values:

  • PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object.

  • PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.

  • IN_SYNC: Propagation is complete.

" }, "GetIPSet":{ "name":"GetIPSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetIPSetRequest"}, "output":{"shape":"GetIPSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

Returns the IPSet that is specified by IPSetId.

" }, "GetRule":{ "name":"GetRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetRuleRequest"}, "output":{"shape":"GetRuleResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

Returns the Rule that is specified by the RuleId that you included in the GetRule request.

" }, "GetSampledRequests":{ "name":"GetSampledRequests", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSampledRequestsRequest"}, "output":{"shape":"GetSampledRequestsResponse"}, "errors":[ {"shape":"WAFNonexistentItemException"}, {"shape":"WAFInternalErrorException"} ], "documentation":"

Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 100 requests, and you can specify any time range in the previous three hours.

GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

" }, "GetSizeConstraintSet":{ "name":"GetSizeConstraintSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSizeConstraintSetRequest"}, "output":{"shape":"GetSizeConstraintSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

Returns the SizeConstraintSet specified by SizeConstraintSetId.

" }, "GetSqlInjectionMatchSet":{ "name":"GetSqlInjectionMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetSqlInjectionMatchSetRequest"}, "output":{"shape":"GetSqlInjectionMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.

" }, "GetWebACL":{ "name":"GetWebACL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetWebACLRequest"}, "output":{"shape":"GetWebACLResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

Returns the WebACL that is specified by WebACLId.

" }, "GetXssMatchSet":{ "name":"GetXssMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetXssMatchSetRequest"}, "output":{"shape":"GetXssMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFNonexistentItemException"} ], "documentation":"

Returns the XssMatchSet that is specified by XssMatchSetId.

" }, "ListByteMatchSets":{ "name":"ListByteMatchSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListByteMatchSetsRequest"}, "output":{"shape":"ListByteMatchSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

Returns an array of ByteMatchSetSummary objects.

" }, "ListIPSets":{ "name":"ListIPSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListIPSetsRequest"}, "output":{"shape":"ListIPSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

Returns an array of IPSetSummary objects in the response.

" }, "ListRules":{ "name":"ListRules", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRulesRequest"}, "output":{"shape":"ListRulesResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

Returns an array of RuleSummary objects.

" }, "ListSizeConstraintSets":{ "name":"ListSizeConstraintSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSizeConstraintSetsRequest"}, "output":{"shape":"ListSizeConstraintSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

Returns an array of SizeConstraintSetSummary objects.

" }, "ListSqlInjectionMatchSets":{ "name":"ListSqlInjectionMatchSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListSqlInjectionMatchSetsRequest"}, "output":{"shape":"ListSqlInjectionMatchSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

Returns an array of SqlInjectionMatchSet objects.

" }, "ListWebACLs":{ "name":"ListWebACLs", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListWebACLsRequest"}, "output":{"shape":"ListWebACLsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

Returns an array of WebACLSummary objects in the response.

" }, "ListXssMatchSets":{ "name":"ListXssMatchSets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListXssMatchSetsRequest"}, "output":{"shape":"ListXssMatchSetsResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"} ], "documentation":"

Returns an array of XssMatchSet objects.

" }, "UpdateByteMatchSet":{ "name":"UpdateByteMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateByteMatchSetRequest"}, "output":{"shape":"UpdateByteMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.

  • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

  • The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.

  • Where to look, such as at the beginning or the end of a query string.

  • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.

To create and configure a ByteMatchSet, perform the following steps:

  1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.

  3. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "UpdateIPSet":{ "name":"UpdateIPSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateIPSetRequest"}, "output":{"shape":"UpdateIPSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one.

  • The IP address version, IPv4 or IPv6.

  • The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44).

AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

IPv6 addresses can be represented using any of the following formats:

  • 1111:0000:0000:0000:0000:0000:0000:0111/128

  • 1111:0:0:0:0:0:0:0111/128

  • 1111::0111/128

  • 1111::111/128

You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.

To create and configure an IPSet, perform the following steps:

  1. Submit a CreateIPSet request.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

  3. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "UpdateRule":{ "name":"UpdateRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateRuleRequest"}, "output":{"shape":"UpdateRuleResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose you add the following to a Rule:

  • A ByteMatchSet that matches the value BadBot in the User-Agent header

  • An IPSet that matches the IP address 192.0.2.44

You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.

To create and configure a Rule, perform the following steps:

  1. Create and update the predicates that you want to include in the Rule.

  2. Create the Rule. See CreateRule.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.

  4. Submit an UpdateRule request to add predicates to the Rule.

  5. Create and update a WebACL that contains the Rule. See CreateWebACL.

If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "UpdateSizeConstraintSet":{ "name":"UpdateSizeConstraintSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateSizeConstraintSetRequest"}, "output":{"shape":"UpdateSizeConstraintSetResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one.

  • The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header.

  • Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF.

  • A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on.

  • The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.

For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests.

To create and configure a SizeConstraintSet, perform the following steps:

  1. Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.

  3. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "UpdateSqlInjectionMatchSet":{ "name":"UpdateSqlInjectionMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateSqlInjectionMatchSetRequest"}, "output":{"shape":"UpdateSqlInjectionMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:

  • Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.

  • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.

  • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.

You use SqlInjectionMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

To create and configure a SqlInjectionMatchSet, perform the following steps:

  1. Submit a CreateSqlInjectionMatchSet request.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

  3. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "UpdateWebACL":{ "name":"UpdateWebACL", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateWebACLRequest"}, "output":{"shape":"UpdateWebACLResponse"}, "errors":[ {"shape":"WAFStaleDataException"}, {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFReferencedItemException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:

  • A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL.

  • The Rules that you want to add and/or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one.

  • For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule.

  • The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all of the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any.

  • The CloudFront distribution that you want to associate with the WebACL.

To create and configure a WebACL, perform the following steps:

  1. Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

  2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.

  3. Create a WebACL. See CreateWebACL.

  4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.

  5. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" }, "UpdateXssMatchSet":{ "name":"UpdateXssMatchSet", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateXssMatchSetRequest"}, "output":{"shape":"UpdateXssMatchSetResponse"}, "errors":[ {"shape":"WAFInternalErrorException"}, {"shape":"WAFInvalidAccountException"}, {"shape":"WAFInvalidOperationException"}, {"shape":"WAFInvalidParameterException"}, {"shape":"WAFNonexistentContainerException"}, {"shape":"WAFNonexistentItemException"}, {"shape":"WAFStaleDataException"}, {"shape":"WAFLimitsExceededException"} ], "documentation":"

Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:

  • Action: Whether to insert the object into or delete the object from the array. To change a XssMatchTuple, you delete the existing object and add a new one.

  • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header, the name of the header.

  • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.

You use XssMatchSet objects to specify which CloudFront requests you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

To create and configure an XssMatchSet, perform the following steps:

  1. Submit a CreateXssMatchSet request.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

  3. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

" } }, "shapes":{ "Action":{"type":"string"}, "ActivatedRule":{ "type":"structure", "required":[ "Priority", "RuleId", "Action" ], "members":{ "Priority":{ "shape":"RulePriority", "documentation":"

Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

" }, "RuleId":{ "shape":"ResourceId", "documentation":"

The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

" }, "Action":{ "shape":"WafAction", "documentation":"

Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

  • ALLOW: CloudFront responds with the requested object.

  • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.

  • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

" } }, "documentation":"

The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

To specify whether to insert or delete a Rule, use the Action parameter in the WebACLUpdate data type.

" }, "ActivatedRules":{ "type":"list", "member":{"shape":"ActivatedRule"} }, "ByteMatchSet":{ "type":"structure", "required":[ "ByteMatchSetId", "ByteMatchTuples" ], "members":{ "ByteMatchSetId":{ "shape":"ResourceId", "documentation":"

The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

" }, "ByteMatchTuples":{ "shape":"ByteMatchTuples", "documentation":"

Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

" } }, "documentation":"

In a GetByteMatchSet request, ByteMatchSet is a complex type that contains the ByteMatchSetId and Name of a ByteMatchSet, and the values that you specified when you updated the ByteMatchSet.

A complex type that contains ByteMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a ByteMatchSet contains more than one ByteMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

" }, "ByteMatchSetSummaries":{ "type":"list", "member":{"shape":"ByteMatchSetSummary"} }, "ByteMatchSetSummary":{ "type":"structure", "required":[ "ByteMatchSetId", "Name" ], "members":{ "ByteMatchSetId":{ "shape":"ResourceId", "documentation":"

The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF.

ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

" } }, "documentation":"

Returned by ListByteMatchSets. Each ByteMatchSetSummary object includes the Name and ByteMatchSetId for one ByteMatchSet.

" }, "ByteMatchSetUpdate":{ "type":"structure", "required":[ "Action", "ByteMatchTuple" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specifies whether to insert or delete a ByteMatchTuple.

" }, "ByteMatchTuple":{ "shape":"ByteMatchTuple", "documentation":"

Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify DELETE for the value of Action, the ByteMatchTuple values must exactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet.

" } }, "documentation":"

In an UpdateByteMatchSet request, ByteMatchSetUpdate specifies whether to insert or delete a ByteMatchTuple and includes the settings for the ByteMatchTuple.

" }, "ByteMatchSetUpdates":{ "type":"list", "member":{"shape":"ByteMatchSetUpdate"} }, "ByteMatchTargetString":{"type":"blob"}, "ByteMatchTuple":{ "type":"structure", "required":[ "FieldToMatch", "TargetString", "TextTransformation", "PositionalConstraint" ], "members":{ "FieldToMatch":{ "shape":"FieldToMatch", "documentation":"

The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch.

" }, "TargetString":{ "shape":"ByteMatchTargetString", "documentation":"

The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.

Valid values depend on the values that you specified for FieldToMatch:

  • HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header.

  • METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

  • QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character.

  • URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg.

  • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

If you're using the AWS WAF API

Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64 encoding and include the resulting value, QmFkQm90, in the value of TargetString.

If you're using the AWS CLI or one of the AWS SDKs

The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.

" }, "TextTransformation":{ "shape":"TextTransformation", "documentation":"

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

  • Delete the following characters: \\ \" ' ^

  • Delete spaces before the following characters: / (

  • Replace the following characters with a space: , ;

  • Replace multiple spaces with one space

  • Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

  • \\f, formfeed, decimal 12

  • \\t, tab, decimal 9

  • \\n, newline, decimal 10

  • \\r, carriage return, decimal 13

  • \\v, vertical tab, decimal 11

  • non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

  • Replaces (ampersand)quot; with \"

  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

  • Replaces (ampersand)lt; with a \"less than\" symbol

  • Replaces (ampersand)gt; with >

  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

" }, "PositionalConstraint":{ "shape":"PositionalConstraint", "documentation":"

Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:

CONTAINS

The specified part of the web request must include the value of TargetString, but the location doesn't matter.

CONTAINS_WORD

The specified part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, which means one of the following:

  • TargetString exactly matches the value of the specified part of the web request, such as the value of a header.

  • TargetString is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot;.

  • TargetString is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example, ;BadBot.

  • TargetString is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, -BadBot;.

EXACTLY

The value of the specified part of the web request must exactly match the value of TargetString.

STARTS_WITH

The value of TargetString must appear at the beginning of the specified part of the web request.

ENDS_WITH

The value of TargetString must appear at the end of the specified part of the web request.

" } }, "documentation":"

The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

" }, "ByteMatchTuples":{ "type":"list", "member":{"shape":"ByteMatchTuple"} }, "ChangeAction":{ "type":"string", "enum":[ "INSERT", "DELETE" ] }, "ChangeToken":{ "type":"string", "min":1 }, "ChangeTokenStatus":{ "type":"string", "enum":[ "PROVISIONED", "PENDING", "INSYNC" ] }, "ComparisonOperator":{ "type":"string", "enum":[ "EQ", "NE", "LE", "LT", "GE", "GT" ] }, "Country":{"type":"string"}, "CreateByteMatchSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "CreateByteMatchSetResponse":{ "type":"structure", "members":{ "ByteMatchSet":{ "shape":"ByteMatchSet", "documentation":"

A ByteMatchSet that contains no ByteMatchTuple objects.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "CreateIPSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the IPSet. You can't change Name after you create the IPSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "CreateIPSetResponse":{ "type":"structure", "members":{ "IPSet":{ "shape":"IPSet", "documentation":"

The IPSet returned in the CreateIPSet response.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the CreateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "CreateRuleRequest":{ "type":"structure", "required":[ "Name", "MetricName", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the Rule.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "CreateRuleResponse":{ "type":"structure", "members":{ "Rule":{ "shape":"Rule", "documentation":"

The Rule returned in the CreateRule response.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the CreateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "CreateSizeConstraintSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the SizeConstraintSet. You can't change Name after you create a SizeConstraintSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "CreateSizeConstraintSetResponse":{ "type":"structure", "members":{ "SizeConstraintSet":{ "shape":"SizeConstraintSet", "documentation":"

A SizeConstraintSet that contains no SizeConstraint objects.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the CreateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "CreateSqlInjectionMatchSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name after you create the SqlInjectionMatchSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } }, "documentation":"

A request to create a SqlInjectionMatchSet.

" }, "CreateSqlInjectionMatchSetResponse":{ "type":"structure", "members":{ "SqlInjectionMatchSet":{ "shape":"SqlInjectionMatchSet", "documentation":"

A SqlInjectionMatchSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the CreateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } }, "documentation":"

The response to a CreateSqlInjectionMatchSet request.

" }, "CreateWebACLRequest":{ "type":"structure", "required":[ "Name", "MetricName", "DefaultAction", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the WebACL. You can't change Name after you create the WebACL.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the WebACL.

" }, "DefaultAction":{ "shape":"WafAction", "documentation":"

The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "CreateWebACLResponse":{ "type":"structure", "members":{ "WebACL":{ "shape":"WebACL", "documentation":"

The WebACL returned in the CreateWebACL response.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the CreateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "CreateXssMatchSetRequest":{ "type":"structure", "required":[ "Name", "ChangeToken" ], "members":{ "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } }, "documentation":"

A request to create an XssMatchSet.

" }, "CreateXssMatchSetResponse":{ "type":"structure", "members":{ "XssMatchSet":{ "shape":"XssMatchSet", "documentation":"

An XssMatchSet.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } }, "documentation":"

The response to a CreateXssMatchSet request.

" }, "DeleteByteMatchSetRequest":{ "type":"structure", "required":[ "ByteMatchSetId", "ChangeToken" ], "members":{ "ByteMatchSetId":{ "shape":"ResourceId", "documentation":"

The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteByteMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "DeleteIPSetRequest":{ "type":"structure", "required":[ "IPSetId", "ChangeToken" ], "members":{ "IPSetId":{ "shape":"ResourceId", "documentation":"

The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteIPSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the DeleteIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "DeleteRuleRequest":{ "type":"structure", "required":[ "RuleId", "ChangeToken" ], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteRuleResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the DeleteRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "DeleteSizeConstraintSetRequest":{ "type":"structure", "required":[ "SizeConstraintSetId", "ChangeToken" ], "members":{ "SizeConstraintSetId":{ "shape":"ResourceId", "documentation":"

The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteSizeConstraintSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "DeleteSqlInjectionMatchSetRequest":{ "type":"structure", "required":[ "SqlInjectionMatchSetId", "ChangeToken" ], "members":{ "SqlInjectionMatchSetId":{ "shape":"ResourceId", "documentation":"

The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } }, "documentation":"

A request to delete a SqlInjectionMatchSet from AWS WAF.

" }, "DeleteSqlInjectionMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } }, "documentation":"

The response to a request to delete a SqlInjectionMatchSet from AWS WAF.

" }, "DeleteWebACLRequest":{ "type":"structure", "required":[ "WebACLId", "ChangeToken" ], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } } }, "DeleteWebACLResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the DeleteWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "DeleteXssMatchSetRequest":{ "type":"structure", "required":[ "XssMatchSetId", "ChangeToken" ], "members":{ "XssMatchSetId":{ "shape":"ResourceId", "documentation":"

The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" } }, "documentation":"

A request to delete an XssMatchSet from AWS WAF.

" }, "DeleteXssMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the DeleteXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } }, "documentation":"

The response to a request to delete an XssMatchSet from AWS WAF.

" }, "FieldToMatch":{ "type":"structure", "required":["Type"], "members":{ "Type":{ "shape":"MatchFieldType", "documentation":"

The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

  • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

  • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

  • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

  • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

  • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

" }, "Data":{ "shape":"MatchFieldData", "documentation":"

When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. If the value of Type is any other value, omit Data.

The name of the header is not case sensitive.

" } }, "documentation":"

Specifies where in a web request to look for TargetString.

" }, "GetByteMatchSetRequest":{ "type":"structure", "required":["ByteMatchSetId"], "members":{ "ByteMatchSetId":{ "shape":"ResourceId", "documentation":"

The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

" } } }, "GetByteMatchSetResponse":{ "type":"structure", "members":{ "ByteMatchSet":{ "shape":"ByteMatchSet", "documentation":"

Information about the ByteMatchSet that you specified in the GetByteMatchSet request. For more information, see the following topics:

  • ByteMatchSet: Contains ByteMatchSetId, ByteMatchTuples, and Name

  • ByteMatchTuples: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple object contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation

  • FieldToMatch: Contains Data and Type

" } } }, "GetChangeTokenRequest":{ "type":"structure", "members":{ } }, "GetChangeTokenResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request.

" } } }, "GetChangeTokenStatusRequest":{ "type":"structure", "required":["ChangeToken"], "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The change token for which you want to get the status. This change token was previously returned in the GetChangeToken response.

" } } }, "GetChangeTokenStatusResponse":{ "type":"structure", "members":{ "ChangeTokenStatus":{ "shape":"ChangeTokenStatus", "documentation":"

The status of the change token.

" } } }, "GetIPSetRequest":{ "type":"structure", "required":["IPSetId"], "members":{ "IPSetId":{ "shape":"ResourceId", "documentation":"

The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets.

" } } }, "GetIPSetResponse":{ "type":"structure", "members":{ "IPSet":{ "shape":"IPSet", "documentation":"

Information about the IPSet that you specified in the GetIPSet request. For more information, see the following topics:

  • IPSet: Contains IPSetDescriptors, IPSetId, and Name

  • IPSetDescriptors: Contains an array of IPSetDescriptor objects. Each IPSetDescriptor object contains Type and Value

" } } }, "GetRuleRequest":{ "type":"structure", "required":["RuleId"], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules.

" } } }, "GetRuleResponse":{ "type":"structure", "members":{ "Rule":{ "shape":"Rule", "documentation":"

Information about the Rule that you specified in the GetRule request. For more information, see the following topics:

  • Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId

  • Predicate: Each Predicate object contains DataId, Negated, and Type

" } } }, "GetSampledRequestsRequest":{ "type":"structure", "required":[ "WebAclId", "RuleId", "TimeWindow", "MaxItems" ], "members":{ "WebAclId":{ "shape":"ResourceId", "documentation":"

The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

" }, "RuleId":{ "shape":"ResourceId", "documentation":"

RuleId is one of two values:

  • The RuleId of the Rule for which you want GetSampledRequests to return a sample of requests.

  • Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL.

" }, "TimeWindow":{ "shape":"TimeWindow", "documentation":"

The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. Specify the date and time in the following format: \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

" }, "MaxItems":{ "shape":"ListMaxItems", "documentation":"

The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

" } } }, "GetSampledRequestsResponse":{ "type":"structure", "members":{ "SampledRequests":{ "shape":"SampledHTTPRequests", "documentation":"

A complex type that contains detailed information about each of the requests in the sample.

" }, "PopulationSize":{ "shape":"PopulationSize", "documentation":"

The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range.

" }, "TimeWindow":{ "shape":"TimeWindow", "documentation":"

Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests.

" } } }, "GetSizeConstraintSetRequest":{ "type":"structure", "required":["SizeConstraintSetId"], "members":{ "SizeConstraintSetId":{ "shape":"ResourceId", "documentation":"

The SizeConstraintSetId of the SizeConstraintSet that you want to get. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

" } } }, "GetSizeConstraintSetResponse":{ "type":"structure", "members":{ "SizeConstraintSet":{ "shape":"SizeConstraintSet", "documentation":"

Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet request. For more information, see the following topics:

" } } }, "GetSqlInjectionMatchSetRequest":{ "type":"structure", "required":["SqlInjectionMatchSetId"], "members":{ "SqlInjectionMatchSetId":{ "shape":"ResourceId", "documentation":"

The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

" } }, "documentation":"

A request to get a SqlInjectionMatchSet.

" }, "GetSqlInjectionMatchSetResponse":{ "type":"structure", "members":{ "SqlInjectionMatchSet":{ "shape":"SqlInjectionMatchSet", "documentation":"

Information about the SqlInjectionMatchSet that you specified in the GetSqlInjectionMatchSet request. For more information, see the following topics:

" } }, "documentation":"

The response to a GetSqlInjectionMatchSet request.

" }, "GetWebACLRequest":{ "type":"structure", "required":["WebACLId"], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs.

" } } }, "GetWebACLResponse":{ "type":"structure", "members":{ "WebACL":{ "shape":"WebACL", "documentation":"

Information about the WebACL that you specified in the GetWebACL request. For more information, see the following topics:

  • WebACL: Contains DefaultAction, MetricName, Name, an array of Rule objects, and WebACLId

  • DefaultAction (Data type is WafAction): Contains Type

  • Rules: Contains an array of ActivatedRule objects, which contain Action, Priority, and RuleId

  • Action: Contains Type

" } } }, "GetXssMatchSetRequest":{ "type":"structure", "required":["XssMatchSetId"], "members":{ "XssMatchSetId":{ "shape":"ResourceId", "documentation":"

The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

" } }, "documentation":"

A request to get an XssMatchSet.

" }, "GetXssMatchSetResponse":{ "type":"structure", "members":{ "XssMatchSet":{ "shape":"XssMatchSet", "documentation":"

Information about the XssMatchSet that you specified in the GetXssMatchSet request. For more information, see the following topics:

  • XssMatchSet: Contains Name, XssMatchSetId, and an array of XssMatchTuple objects

  • XssMatchTuple: Each XssMatchTuple object contains FieldToMatch and TextTransformation

  • FieldToMatch: Contains Data and Type

" } }, "documentation":"

The response to a GetXssMatchSet request.

" }, "HTTPHeader":{ "type":"structure", "members":{ "Name":{ "shape":"HeaderName", "documentation":"

The name of one of the headers in the sampled web request.

" }, "Value":{ "shape":"HeaderValue", "documentation":"

The value of one of the headers in the sampled web request.

" } }, "documentation":"

The response from a GetSampledRequests request includes an HTTPHeader complex type that appears as Headers in the response syntax. HTTPHeader contains the names and values of all of the headers that appear in one of the web requests that were returned by GetSampledRequests.

" }, "HTTPHeaders":{ "type":"list", "member":{"shape":"HTTPHeader"} }, "HTTPMethod":{"type":"string"}, "HTTPRequest":{ "type":"structure", "members":{ "ClientIP":{ "shape":"IPString", "documentation":"

The IP address that the request originated from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

  • c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request

  • x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

" }, "Country":{ "shape":"Country", "documentation":"

The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.

" }, "URI":{ "shape":"URIString", "documentation":"

The part of a web request that identifies the resource, for example, /images/daily-ad.jpg.

" }, "Method":{ "shape":"HTTPMethod", "documentation":"

The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

" }, "HTTPVersion":{ "shape":"HTTPVersion", "documentation":"

The HTTP version specified in the sampled web request, for example, HTTP/1.1.

" }, "Headers":{ "shape":"HTTPHeaders", "documentation":"

A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.

" } }, "documentation":"

The response from a GetSampledRequests request includes an HTTPRequest complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests that were returned by GetSampledRequests.

" }, "HTTPVersion":{"type":"string"}, "HeaderName":{"type":"string"}, "HeaderValue":{"type":"string"}, "IPSet":{ "type":"structure", "required":[ "IPSetId", "IPSetDescriptors" ], "members":{ "IPSetId":{ "shape":"ResourceId", "documentation":"

The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).

IPSetId is returned by CreateIPSet and by ListIPSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

" }, "IPSetDescriptors":{ "shape":"IPSetDescriptors", "documentation":"

The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

  • c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request

  • x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

" } }, "documentation":"

Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6.

To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/31. To block a range of IP addresses, you can specify a /128, /64, /56, /48, /32, /24, /16, or /8 CIDR. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

" }, "IPSetDescriptor":{ "type":"structure", "required":[ "Type", "Value" ], "members":{ "Type":{ "shape":"IPSetDescriptorType", "documentation":"

Specify IPV4 or IPV6.

" }, "Value":{ "shape":"IPSetDescriptorValue", "documentation":"

Specify an IPv4 address by using CIDR notation. For example:

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

Specify an IPv6 address by using CIDR notation. For example:

  • To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

  • To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

" } }, "documentation":"

Specifies the IP address type (IPV4 or IPV6) and the IP address range (in CIDR format) that web requests originate from.

" }, "IPSetDescriptorType":{ "type":"string", "enum":[ "IPV4", "IPV6" ] }, "IPSetDescriptorValue":{"type":"string"}, "IPSetDescriptors":{ "type":"list", "member":{"shape":"IPSetDescriptor"} }, "IPSetSummaries":{ "type":"list", "member":{"shape":"IPSetSummary"} }, "IPSetSummary":{ "type":"structure", "required":[ "IPSetId", "Name" ], "members":{ "IPSetId":{ "shape":"ResourceId", "documentation":"

The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed information about an IPSet.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

" } }, "documentation":"

Contains the identifier and the name of the IPSet.

" }, "IPSetUpdate":{ "type":"structure", "required":[ "Action", "IPSetDescriptor" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specifies whether to insert or delete an IP address with UpdateIPSet.

" }, "IPSetDescriptor":{ "shape":"IPSetDescriptor", "documentation":"

The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from.

" } }, "documentation":"

Specifies the type of update to perform to an IPSet with UpdateIPSet.

" }, "IPSetUpdates":{ "type":"list", "member":{"shape":"IPSetUpdate"} }, "IPString":{"type":"string"}, "ListByteMatchSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListByteMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more ByteMatchSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ByteMatchSet objects.

" } } }, "ListByteMatchSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you have more ByteMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ByteMatchSet objects, submit another ListByteMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

" }, "ByteMatchSets":{ "shape":"ByteMatchSetSummaries", "documentation":"

An array of ByteMatchSetSummary objects.

" } } }, "ListIPSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you specify a value for Limit and you have more IPSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of IPSets. For the second and subsequent ListIPSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have more IPSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of IPSet objects.

" } } }, "ListIPSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you have more IPSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more IPSet objects, submit another ListIPSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

" }, "IPSets":{ "shape":"IPSetSummaries", "documentation":"

An array of IPSetSummary objects.

" } } }, "ListMaxItems":{ "type":"long", "max":100, "min":1 }, "ListRulesRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

" } } }, "ListRulesResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

" }, "Rules":{ "shape":"RuleSummaries", "documentation":"

An array of RuleSummary objects.

" } } }, "ListSizeConstraintSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you specify a value for Limit and you have more SizeConstraintSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SizeConstraintSets. For the second and subsequent ListSizeConstraintSets requests, specify the value of NextMarker from the previous response to get information about another batch of SizeConstraintSets.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

Specifies the number of SizeConstraintSet objects that you want AWS WAF to return for this request. If you have more SizeConstraintSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of SizeConstraintSet objects.

" } } }, "ListSizeConstraintSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you have more SizeConstraintSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SizeConstraintSet objects, submit another ListSizeConstraintSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

" }, "SizeConstraintSets":{ "shape":"SizeConstraintSetSummaries", "documentation":"

An array of SizeConstraintSetSummary objects.

" } } }, "ListSqlInjectionMatchSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you specify a value for Limit and you have more SqlInjectionMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SqlInjectionMatchSets. For the second and subsequent ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of SqlInjectionMatchSets.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If you have more SqlInjectionMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

" } }, "documentation":"

A request to list the SqlInjectionMatchSet objects created by the current AWS account.

" }, "ListSqlInjectionMatchSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

" }, "SqlInjectionMatchSets":{ "shape":"SqlInjectionMatchSetSummaries", "documentation":"

An array of SqlInjectionMatchSetSummary objects.

" } }, "documentation":"

The response to a ListSqlInjectionMatchSets request.

" }, "ListWebACLsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of WebACL objects. For the second and subsequent ListWebACLs requests, specify the value of NextMarker from the previous response to get information about another batch of WebACL objects.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have more WebACL objects than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of WebACL objects.

" } } }, "ListWebACLsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you have more WebACL objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more WebACL objects, submit another ListWebACLs request, and specify the NextMarker value from the response in the NextMarker value in the next request.

" }, "WebACLs":{ "shape":"WebACLSummaries", "documentation":"

An array of WebACLSummary objects.

" } } }, "ListXssMatchSetsRequest":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you specify a value for Limit and you have more XssMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of XssMatchSets.

" }, "Limit":{ "shape":"PaginationLimit", "documentation":"

Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more XssMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

" } }, "documentation":"

A request to list the XssMatchSet objects created by the current AWS account.

" }, "ListXssMatchSetsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"NextMarker", "documentation":"

If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

" }, "XssMatchSets":{ "shape":"XssMatchSetSummaries", "documentation":"

An array of XssMatchSetSummary objects.

" } }, "documentation":"

The response to a ListXssMatchSets request.

" }, "MatchFieldData":{"type":"string"}, "MatchFieldType":{ "type":"string", "enum":[ "URI", "QUERY_STRING", "HEADER", "METHOD", "BODY" ] }, "MetricName":{"type":"string"}, "Negated":{"type":"boolean"}, "NextMarker":{ "type":"string", "min":1 }, "PaginationLimit":{ "type":"integer", "max":100, "min":0 }, "ParameterExceptionField":{ "type":"string", "enum":[ "CHANGE_ACTION", "WAF_ACTION", "PREDICATE_TYPE", "IPSET_TYPE", "BYTE_MATCH_FIELD_TYPE", "SQL_INJECTION_MATCH_FIELD_TYPE", "BYTE_MATCH_TEXT_TRANSFORMATION", "BYTE_MATCH_POSITIONAL_CONSTRAINT", "SIZE_CONSTRAINT_COMPARISON_OPERATOR" ] }, "ParameterExceptionParameter":{ "type":"string", "min":1 }, "ParameterExceptionReason":{ "type":"string", "enum":[ "INVALID_OPTION", "ILLEGAL_COMBINATION" ] }, "PopulationSize":{"type":"long"}, "PositionalConstraint":{ "type":"string", "enum":[ "EXACTLY", "STARTS_WITH", "ENDS_WITH", "CONTAINS", "CONTAINS_WORD" ] }, "Predicate":{ "type":"structure", "required":[ "Negated", "Type", "DataId" ], "members":{ "Negated":{ "shape":"Negated", "documentation":"

Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

" }, "Type":{ "shape":"PredicateType", "documentation":"

The type of predicate in a Rule, such as ByteMatchSet or IPSet.

" }, "DataId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

" } }, "documentation":"

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.

" }, "PredicateType":{ "type":"string", "enum":[ "IPMatch", "ByteMatch", "SqlInjectionMatch", "SizeConstraint", "XssMatch" ] }, "Predicates":{ "type":"list", "member":{"shape":"Predicate"} }, "ResourceId":{ "type":"string", "max":128, "min":1 }, "ResourceName":{ "type":"string", "max":128, "min":1 }, "Rule":{ "type":"structure", "required":[ "RuleId", "Predicates" ], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the Rule.

" }, "Predicates":{ "shape":"Predicates", "documentation":"

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

" } }, "documentation":"

A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates:

  • An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44

  • A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot.

To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot.

" }, "RulePriority":{"type":"integer"}, "RuleSummaries":{ "type":"list", "member":{"shape":"RuleSummary"} }, "RuleSummary":{ "type":"structure", "required":[ "RuleId", "Name" ], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

RuleId is returned by CreateRule and by ListRules.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

" } }, "documentation":"

Contains the identifier and the friendly name or description of the Rule.

" }, "RuleUpdate":{ "type":"structure", "required":[ "Action", "Predicate" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate from a Rule.

" }, "Predicate":{ "shape":"Predicate", "documentation":"

The ID of the Predicate (such as an IPSet) that you want to add to a Rule.

" } }, "documentation":"

Specifies a Predicate (such as an IPSet) and indicates whether you want to add it to a Rule or delete it from a Rule.

" }, "RuleUpdates":{ "type":"list", "member":{"shape":"RuleUpdate"} }, "SampleWeight":{ "type":"long", "min":0 }, "SampledHTTPRequest":{ "type":"structure", "required":[ "Request", "Weight" ], "members":{ "Request":{ "shape":"HTTPRequest", "documentation":"

A complex type that contains detailed information about the request.

" }, "Weight":{ "shape":"SampleWeight", "documentation":"

A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2 represents roughly twice as many CloudFront web requests as a result that has a weight of 1.

" }, "Timestamp":{ "shape":"Timestamp", "documentation":"

The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

" }, "Action":{ "shape":"Action", "documentation":"

The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT.

" } }, "documentation":"

The response from a GetSampledRequests request includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains one SampledHTTPRequest object for each web request that is returned by GetSampledRequests.

" }, "SampledHTTPRequests":{ "type":"list", "member":{"shape":"SampledHTTPRequest"} }, "Size":{ "type":"long", "max":21474836480, "min":0 }, "SizeConstraint":{ "type":"structure", "required":[ "FieldToMatch", "TextTransformation", "ComparisonOperator", "Size" ], "members":{ "FieldToMatch":{ "shape":"FieldToMatch", "documentation":"

Specifies where in a web request to look for the size constraint.

" }, "TextTransformation":{ "shape":"TextTransformation", "documentation":"

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection.

NONE

Specify NONE if you don't want to perform any text transformations.

CMD_LINE

When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

  • Delete the following characters: \\ \" ' ^

  • Delete spaces before the following characters: / (

  • Replace the following characters with a space: , ;

  • Replace multiple spaces with one space

  • Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

  • \\f, formfeed, decimal 12

  • \\t, tab, decimal 9

  • \\n, newline, decimal 10

  • \\r, carriage return, decimal 13

  • \\v, vertical tab, decimal 11

  • non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

  • Replaces (ampersand)quot; with \"

  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

  • Replaces (ampersand)lt; with a \"less than\" symbol

  • Replaces (ampersand)gt; with >

  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

" }, "ComparisonOperator":{ "shape":"ComparisonOperator", "documentation":"

The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.

EQ: Used to test if the Size is equal to the size of the FieldToMatch

NE: Used to test if the Size is not equal to the size of the FieldToMatch

LE: Used to test if the Size is less than or equal to the size of the FieldToMatch

LT: Used to test if the Size is strictly less than the size of the FieldToMatch

GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch

GT: Used to test if the Size is strictly greater than the size of the FieldToMatch

" }, "Size":{ "shape":"Size", "documentation":"

The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.

Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).

If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

" } }, "documentation":"

Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.

" }, "SizeConstraintSet":{ "type":"structure", "required":[ "SizeConstraintSetId", "SizeConstraints" ], "members":{ "SizeConstraintSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).

SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name, if any, of the SizeConstraintSet.

" }, "SizeConstraints":{ "shape":"SizeConstraints", "documentation":"

Specifies the parts of web requests that you want to inspect the size of.

" } }, "documentation":"

A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match.

" }, "SizeConstraintSetSummaries":{ "type":"list", "member":{"shape":"SizeConstraintSetSummary"} }, "SizeConstraintSetSummary":{ "type":"structure", "required":[ "SizeConstraintSetId", "Name" ], "members":{ "SizeConstraintSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).

SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name of the SizeConstraintSet, if any.

" } }, "documentation":"

The Id and Name of a SizeConstraintSet.

" }, "SizeConstraintSetUpdate":{ "type":"structure", "required":[ "Action", "SizeConstraint" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet.

" }, "SizeConstraint":{ "shape":"SizeConstraint", "documentation":"

Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.

" } }, "documentation":"

Specifies the part of a web request that you want to inspect the size of and indicates whether you want to add the specification to a SizeConstraintSet or delete it from a SizeConstraintSet.

" }, "SizeConstraintSetUpdates":{ "type":"list", "member":{"shape":"SizeConstraintSetUpdate"} }, "SizeConstraints":{ "type":"list", "member":{"shape":"SizeConstraint"} }, "SqlInjectionMatchSet":{ "type":"structure", "required":[ "SqlInjectionMatchSetId", "SqlInjectionMatchTuples" ], "members":{ "SqlInjectionMatchSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet).

SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name, if any, of the SqlInjectionMatchSet.

" }, "SqlInjectionMatchTuples":{ "shape":"SqlInjectionMatchTuples", "documentation":"

Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.

" } }, "documentation":"

A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match.

" }, "SqlInjectionMatchSetSummaries":{ "type":"list", "member":{"shape":"SqlInjectionMatchSetSummary"} }, "SqlInjectionMatchSetSummary":{ "type":"structure", "required":[ "SqlInjectionMatchSetId", "Name" ], "members":{ "SqlInjectionMatchSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet).

SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name of the SqlInjectionMatchSet, if any, specified by Id.

" } }, "documentation":"

The Id and Name of a SqlInjectionMatchSet.

" }, "SqlInjectionMatchSetUpdate":{ "type":"structure", "required":[ "Action", "SqlInjectionMatchTuple" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet.

" }, "SqlInjectionMatchTuple":{ "shape":"SqlInjectionMatchTuple", "documentation":"

Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

" } }, "documentation":"

Specifies the part of a web request that you want to inspect for snippets of malicious SQL code and indicates whether you want to add the specification to a SqlInjectionMatchSet or delete it from a SqlInjectionMatchSet.

" }, "SqlInjectionMatchSetUpdates":{ "type":"list", "member":{"shape":"SqlInjectionMatchSetUpdate"} }, "SqlInjectionMatchTuple":{ "type":"structure", "required":[ "FieldToMatch", "TextTransformation" ], "members":{ "FieldToMatch":{ "shape":"FieldToMatch", "documentation":"

Specifies where in a web request to look for snippets of malicious SQL code.

" }, "TextTransformation":{ "shape":"TextTransformation", "documentation":"

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

  • Delete the following characters: \\ \" ' ^

  • Delete spaces before the following characters: / (

  • Replace the following characters with a space: , ;

  • Replace multiple spaces with one space

  • Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

  • \\f, formfeed, decimal 12

  • \\t, tab, decimal 9

  • \\n, newline, decimal 10

  • \\r, carriage return, decimal 13

  • \\v, vertical tab, decimal 11

  • non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

  • Replaces (ampersand)quot; with \"

  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

  • Replaces (ampersand)lt; with a \"less than\" symbol

  • Replaces (ampersand)gt; with >

  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

" } }, "documentation":"

Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

" }, "SqlInjectionMatchTuples":{ "type":"list", "member":{"shape":"SqlInjectionMatchTuple"} }, "TextTransformation":{ "type":"string", "enum":[ "NONE", "COMPRESS_WHITE_SPACE", "HTML_ENTITY_DECODE", "LOWERCASE", "CMD_LINE", "URL_DECODE" ] }, "TimeWindow":{ "type":"structure", "required":[ "StartTime", "EndTime" ], "members":{ "StartTime":{ "shape":"Timestamp", "documentation":"

The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

" }, "EndTime":{ "shape":"Timestamp", "documentation":"

The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

" } }, "documentation":"

In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want AWS WAF to return a sample of web requests.

In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request.

" }, "Timestamp":{"type":"timestamp"}, "URIString":{"type":"string"}, "UpdateByteMatchSetRequest":{ "type":"structure", "required":[ "ByteMatchSetId", "ChangeToken", "Updates" ], "members":{ "ByteMatchSetId":{ "shape":"ResourceId", "documentation":"

The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"ByteMatchSetUpdates", "documentation":"

An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:

" } } }, "UpdateByteMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the UpdateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "UpdateIPSetRequest":{ "type":"structure", "required":[ "IPSetId", "ChangeToken", "Updates" ], "members":{ "IPSetId":{ "shape":"ResourceId", "documentation":"

The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"IPSetUpdates", "documentation":"

An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types:

" } } }, "UpdateIPSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the UpdateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "UpdateRuleRequest":{ "type":"structure", "required":[ "RuleId", "ChangeToken", "Updates" ], "members":{ "RuleId":{ "shape":"ResourceId", "documentation":"

The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"RuleUpdates", "documentation":"

An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:

" } } }, "UpdateRuleResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the UpdateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "UpdateSizeConstraintSetRequest":{ "type":"structure", "required":[ "SizeConstraintSetId", "ChangeToken", "Updates" ], "members":{ "SizeConstraintSetId":{ "shape":"ResourceId", "documentation":"

The SizeConstraintSetId of the SizeConstraintSet that you want to update. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"SizeConstraintSetUpdates", "documentation":"

An array of SizeConstraintSetUpdate objects that you want to insert into or delete from a SizeConstraintSet. For more information, see the applicable data types:

" } } }, "UpdateSizeConstraintSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the UpdateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "UpdateSqlInjectionMatchSetRequest":{ "type":"structure", "required":[ "SqlInjectionMatchSetId", "ChangeToken", "Updates" ], "members":{ "SqlInjectionMatchSetId":{ "shape":"ResourceId", "documentation":"

The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"SqlInjectionMatchSetUpdates", "documentation":"

An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a SqlInjectionMatchSet. For more information, see the applicable data types:

" } }, "documentation":"

A request to update a SqlInjectionMatchSet.

" }, "UpdateSqlInjectionMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the UpdateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } }, "documentation":"

The response to an UpdateSqlInjectionMatchSets request.

" }, "UpdateWebACLRequest":{ "type":"structure", "required":[ "WebACLId", "ChangeToken" ], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"WebACLUpdates", "documentation":"

An array of updates to make to the WebACL.

An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:

" }, "DefaultAction":{ "shape":"WafAction", "documentation":"

A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL.

" } } }, "UpdateWebACLResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the UpdateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } } }, "UpdateXssMatchSetRequest":{ "type":"structure", "required":[ "XssMatchSetId", "ChangeToken", "Updates" ], "members":{ "XssMatchSetId":{ "shape":"ResourceId", "documentation":"

The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

" }, "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The value returned by the most recent call to GetChangeToken.

" }, "Updates":{ "shape":"XssMatchSetUpdates", "documentation":"

An array of XssMatchSetUpdate objects that you want to insert into or delete from a XssMatchSet. For more information, see the applicable data types:

" } }, "documentation":"

A request to update an XssMatchSet.

" }, "UpdateXssMatchSetResponse":{ "type":"structure", "members":{ "ChangeToken":{ "shape":"ChangeToken", "documentation":"

The ChangeToken that you used to submit the UpdateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

" } }, "documentation":"

The response to an UpdateXssMatchSets request.

" }, "WAFDisallowedNameException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The name specified is invalid.

", "exception":true }, "WAFInternalErrorException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because of a system problem, even though the request was valid. Retry your request.

", "exception":true, "fault":true }, "WAFInvalidAccountException":{ "type":"structure", "members":{ }, "documentation":"

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

", "exception":true }, "WAFInvalidOperationException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because there was nothing to do. For example:

  • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

  • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

  • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

  • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

  • You tried to add an IP address to an IPSet, but the IP address already exists in the specified IPSet.

  • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

", "exception":true }, "WAFInvalidParameterException":{ "type":"structure", "members":{ "field":{"shape":"ParameterExceptionField"}, "parameter":{"shape":"ParameterExceptionParameter"}, "reason":{"shape":"ParameterExceptionReason"} }, "documentation":"

The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

  • You specified an invalid parameter name.

  • You specified an invalid value.

  • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

  • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

  • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

  • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, QUERY_STRING, or URI.

  • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

  • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

", "exception":true }, "WAFLimitsExceededException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.

", "exception":true }, "WAFNonEmptyEntityException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because you tried to delete an object that isn't empty. For example:

  • You tried to delete a WebACL that still contains one or more Rule objects.

  • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

  • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

  • You tried to delete an IPSet that references one or more IP addresses.

", "exception":true }, "WAFNonexistentContainerException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

  • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

  • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

  • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

  • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

", "exception":true }, "WAFNonexistentItemException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because the referenced object doesn't exist.

", "exception":true }, "WAFReferencedItemException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because you tried to delete an object that is still in use. For example:

  • You tried to delete a ByteMatchSet that is still referenced by a Rule.

  • You tried to delete a Rule that is still referenced by a WebACL.

", "exception":true }, "WAFStaleDataException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

", "exception":true }, "WafAction":{ "type":"structure", "required":["Type"], "members":{ "Type":{ "shape":"WafActionType", "documentation":"

Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

  • ALLOW: AWS WAF allows requests

  • BLOCK: AWS WAF blocks requests

  • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

" } }, "documentation":"

For the action that is associated with a rule in a WebACL, specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL, specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL.

" }, "WafActionType":{ "type":"string", "enum":[ "BLOCK", "ALLOW", "COUNT" ] }, "WebACL":{ "type":"structure", "required":[ "WebACLId", "DefaultAction", "Rules" ], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

" }, "MetricName":{ "shape":"MetricName", "documentation":"

A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the WebACL.

" }, "DefaultAction":{ "shape":"WafAction", "documentation":"

The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

" }, "Rules":{ "shape":"ActivatedRules", "documentation":"

An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

" } }, "documentation":"

Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. For more information, see UpdateWebACL.

" }, "WebACLSummaries":{ "type":"list", "member":{"shape":"WebACLSummary"} }, "WebACLSummary":{ "type":"structure", "required":[ "WebACLId", "Name" ], "members":{ "WebACLId":{ "shape":"ResourceId", "documentation":"

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

" }, "Name":{ "shape":"ResourceName", "documentation":"

A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

" } }, "documentation":"

Contains the identifier and the name or description of the WebACL.

" }, "WebACLUpdate":{ "type":"structure", "required":[ "Action", "ActivatedRule" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specifies whether to insert a Rule into or delete a Rule from a WebACL.

" }, "ActivatedRule":{ "shape":"ActivatedRule", "documentation":"

The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

" } }, "documentation":"

Specifies whether to insert a Rule into or delete a Rule from a WebACL.

" }, "WebACLUpdates":{ "type":"list", "member":{"shape":"WebACLUpdate"} }, "XssMatchSet":{ "type":"structure", "required":[ "XssMatchSetId", "XssMatchTuples" ], "members":{ "XssMatchSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name, if any, of the XssMatchSet.

" }, "XssMatchTuples":{ "shape":"XssMatchTuples", "documentation":"

Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

" } }, "documentation":"

A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match.

" }, "XssMatchSetSummaries":{ "type":"list", "member":{"shape":"XssMatchSetSummary"} }, "XssMatchSetSummary":{ "type":"structure", "required":[ "XssMatchSetId", "Name" ], "members":{ "XssMatchSetId":{ "shape":"ResourceId", "documentation":"

A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

" }, "Name":{ "shape":"ResourceName", "documentation":"

The name of the XssMatchSet, if any, specified by Id.

" } }, "documentation":"

The Id and Name of an XssMatchSet.

" }, "XssMatchSetUpdate":{ "type":"structure", "required":[ "Action", "XssMatchTuple" ], "members":{ "Action":{ "shape":"ChangeAction", "documentation":"

Specify INSERT to add a XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove a XssMatchSetUpdate from an XssMatchSet.

" }, "XssMatchTuple":{ "shape":"XssMatchTuple", "documentation":"

Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

" } }, "documentation":"

Specifies the part of a web request that you want to inspect for cross-site scripting attacks and indicates whether you want to add the specification to an XssMatchSet or delete it from an XssMatchSet.

" }, "XssMatchSetUpdates":{ "type":"list", "member":{"shape":"XssMatchSetUpdate"} }, "XssMatchTuple":{ "type":"structure", "required":[ "FieldToMatch", "TextTransformation" ], "members":{ "FieldToMatch":{ "shape":"FieldToMatch", "documentation":"

Specifies where in a web request to look for cross-site scripting attacks.

" }, "TextTransformation":{ "shape":"TextTransformation", "documentation":"

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

CMD_LINE

When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

  • Delete the following characters: \\ \" ' ^

  • Delete spaces before the following characters: / (

  • Replace the following characters with a space: , ;

  • Replace multiple spaces with one space

  • Convert uppercase letters (A-Z) to lowercase (a-z)

COMPRESS_WHITE_SPACE

Use this option to replace the following characters with a space character (decimal 32):

  • \\f, formfeed, decimal 12

  • \\t, tab, decimal 9

  • \\n, newline, decimal 10

  • \\r, carriage return, decimal 13

  • \\v, vertical tab, decimal 11

  • non-breaking space, decimal 160

COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

HTML_ENTITY_DECODE

Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

  • Replaces (ampersand)quot; with \"

  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

  • Replaces (ampersand)lt; with a \"less than\" symbol

  • Replaces (ampersand)gt; with >

  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

LOWERCASE

Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

URL_DECODE

Use this option to decode a URL-encoded value.

NONE

Specify NONE if you don't want to perform any text transformations.

" } }, "documentation":"

Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

" }, "XssMatchTuples":{ "type":"list", "member":{"shape":"XssMatchTuple"} }, "errorMessage":{"type":"string"} }, "documentation":"

This is the AWS WAF API Reference for using AWS WAF with Amazon CloudFront. The AWS WAF actions and data types listed in the reference are available for protecting Amazon CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. This guide is for developers who need detailed information about the AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use the AWS WAF API, see the AWS WAF Developer Guide.

" } botocore-1.5.7/botocore/data/logs/0000777454262600001440000000000013042511307020077 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/logs/2014-03-28/0000777454262600001440000000000013042511307021134 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/logs/2014-03-28/paginators-1.json0000666454262600001440000000207213042511306024334 0ustar pysdk-ciamazon00000000000000{ "pagination": { "DescribeDestinations": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "limit", "result_key": "destinations" }, "DescribeLogGroups": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "limit", "result_key": "logGroups" }, "DescribeLogStreams": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "limit", "result_key": "logStreams" }, "DescribeMetricFilters": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "limit", "result_key": "metricFilters" }, "DescribeSubscriptionFilters": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "limit", "result_key": "subscriptionFilters" }, "FilterLogEvents": { "input_token": "nextToken", "output_token": "nextToken", "limit_key": "limit", "result_key": [ "events", "searchedLogStreams" ] } } } botocore-1.5.7/botocore/data/logs/2014-03-28/service-2.json0000666454262600001440000020612213042511306023630 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2014-03-28", "endpointPrefix":"logs", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Amazon CloudWatch Logs", "signatureVersion":"v4", "targetPrefix":"Logs_20140328", "uid":"logs-2014-03-28" }, "operations":{ "CancelExportTask":{ "name":"CancelExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CancelExportTaskRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidOperationException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

" }, "CreateExportTask":{ "name":"CreateExportTask", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateExportTaskRequest"}, "output":{"shape":"CreateExportTaskResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"LimitExceededException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceAlreadyExistsException"} ], "documentation":"

Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.

This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.

You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix that will be used as the Amazon S3 key prefix for all exported objects.

" }, "CreateLogGroup":{ "name":"CreateLogGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateLogGroupRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"LimitExceededException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Creates a log group with the specified name.

You can create up to 5000 log groups per account.

You must use the following guidelines when naming a log group:

  • Log group names must be unique within a region for an AWS account.

  • Log group names can be between 1 and 512 characters long.

  • Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

" }, "CreateLogStream":{ "name":"CreateLogStream", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateLogStreamRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Creates a log stream for the specified log group.

There is no limit on the number of log streams that you can create for a log group.

You must use the following guidelines when naming a log stream:

  • Log stream names must be unique within the log group.

  • Log stream names can be between 1 and 512 characters long.

  • The ':' (colon) and '*' (asterisk) characters are not allowed.

" }, "DeleteDestination":{ "name":"DeleteDestination", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteDestinationRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.

" }, "DeleteLogGroup":{ "name":"DeleteLogGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteLogGroupRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Deletes the specified log group and permanently deletes all the archived log events associated with the log group.

" }, "DeleteLogStream":{ "name":"DeleteLogStream", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteLogStreamRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.

" }, "DeleteMetricFilter":{ "name":"DeleteMetricFilter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteMetricFilterRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Deletes the specified metric filter.

" }, "DeleteRetentionPolicy":{ "name":"DeleteRetentionPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRetentionPolicyRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Deletes the specified retention policy.

Log events do not expire if they belong to log groups without a retention policy.

" }, "DeleteSubscriptionFilter":{ "name":"DeleteSubscriptionFilter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteSubscriptionFilterRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Deletes the specified subscription filter.

" }, "DescribeDestinations":{ "name":"DescribeDestinations", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeDestinationsRequest"}, "output":{"shape":"DescribeDestinationsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Lists all your destinations. The results are ASCII-sorted by destination name.

" }, "DescribeExportTasks":{ "name":"DescribeExportTasks", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeExportTasksRequest"}, "output":{"shape":"DescribeExportTasksResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

" }, "DescribeLogGroups":{ "name":"DescribeLogGroups", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLogGroupsRequest"}, "output":{"shape":"DescribeLogGroupsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

" }, "DescribeLogStreams":{ "name":"DescribeLogStreams", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeLogStreamsRequest"}, "output":{"shape":"DescribeLogStreamsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

This operation has a limit of five transactions per second, after which transactions are throttled.

" }, "DescribeMetricFilters":{ "name":"DescribeMetricFilters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeMetricFiltersRequest"}, "output":{"shape":"DescribeMetricFiltersResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, and metric namespace. The results are ASCII-sorted by filter name.

" }, "DescribeSubscriptionFilters":{ "name":"DescribeSubscriptionFilters", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeSubscriptionFiltersRequest"}, "output":{"shape":"DescribeSubscriptionFiltersResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.

" }, "FilterLogEvents":{ "name":"FilterLogEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"FilterLogEventsRequest"}, "output":{"shape":"FilterLogEventsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

By default, this operation returns as many log events as can fit in 1MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.

" }, "GetLogEvents":{ "name":"GetLogEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetLogEventsRequest"}, "output":{"shape":"GetLogEventsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Lists log events from the specified log stream. You can list all the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). If the results include tokens, there are more log events available. You can get additional log events by specifying one of the tokens in a subsequent call.

" }, "ListTagsLogGroup":{ "name":"ListTagsLogGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsLogGroupRequest"}, "output":{"shape":"ListTagsLogGroupResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Lists the tags for the specified log group.

To add tags, use TagLogGroup. To remove tags, use UntagLogGroup.

" }, "PutDestination":{ "name":"PutDestination", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutDestinationRequest"}, "output":{"shape":"PutDestinationResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Creates or updates a destination. A destination encapsulates a physical resource (such as a Kinesis stream) and enables you to subscribe to a real-time stream of log events of a different account, ingested using PutLogEvents. Currently, the only supported physical resource is a Amazon Kinesis stream belonging to the same account as the destination.

A destination controls what is written to its Amazon Kinesis stream through an access policy. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

" }, "PutDestinationPolicy":{ "name":"PutDestinationPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutDestinationPolicyRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.

" }, "PutLogEvents":{ "name":"PutLogEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutLogEventsRequest"}, "output":{"shape":"PutLogEventsResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"InvalidSequenceTokenException"}, {"shape":"DataAlreadyAcceptedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Uploads a batch of log events to the specified log stream.

You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams.

The batch of events must satisfy the following constraints:

  • The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

  • None of the log events in the batch can be more than 2 hours in the future.

  • None of the log events in the batch can be older than 14 days or the retention period of the log group.

  • The log events in the batch must be in chronological ordered by their timestamp (the time the event occurred, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC).

  • The maximum number of log events in a batch is 10,000.

  • A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

" }, "PutMetricFilter":{ "name":"PutMetricFilter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutMetricFilterRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents.

The maximum number of metric filters that can be associated with a log group is 100.

" }, "PutRetentionPolicy":{ "name":"PutRetentionPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutRetentionPolicyRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Sets the retention of the specified log group. A retention policy allows you to configure the number of days you want to retain log events in the specified log group.

" }, "PutSubscriptionFilter":{ "name":"PutSubscriptionFilter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutSubscriptionFilterRequest"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ResourceNotFoundException"}, {"shape":"OperationAbortedException"}, {"shape":"LimitExceededException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. Currently, the supported destinations are:

  • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

  • A logical destination that belongs to a different account, for cross-account delivery.

  • An Amazon Kinesis Firehose stream that belongs to the same account as the subscription filter, for same-account delivery.

  • An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.

There can only be one subscription filter associated with a log group.

" }, "TagLogGroup":{ "name":"TagLogGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagLogGroupRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"} ], "documentation":"

Adds or updates the specified tags for the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup.

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.

" }, "TestMetricFilter":{ "name":"TestMetricFilter", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TestMetricFilterRequest"}, "output":{"shape":"TestMetricFilterResponse"}, "errors":[ {"shape":"InvalidParameterException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

" }, "UntagLogGroup":{ "name":"UntagLogGroup", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagLogGroupRequest"}, "errors":[ {"shape":"ResourceNotFoundException"} ], "documentation":"

Removes the specified tags from the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.

" } }, "shapes":{ "AccessPolicy":{ "type":"string", "min":1 }, "Arn":{"type":"string"}, "CancelExportTaskRequest":{ "type":"structure", "required":["taskId"], "members":{ "taskId":{ "shape":"ExportTaskId", "documentation":"

The ID of the export task.

" } } }, "CreateExportTaskRequest":{ "type":"structure", "required":[ "logGroupName", "from", "to", "destination" ], "members":{ "taskName":{ "shape":"ExportTaskName", "documentation":"

The name of the export task.

" }, "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "logStreamNamePrefix":{ "shape":"LogStreamName", "documentation":"

Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.

" }, "from":{ "shape":"Timestamp", "documentation":"

The start time of the range for the request, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not exported.

" }, "to":{ "shape":"Timestamp", "documentation":"

The end time of the range for the request, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.

" }, "destination":{ "shape":"ExportDestinationBucket", "documentation":"

The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.

" }, "destinationPrefix":{ "shape":"ExportDestinationPrefix", "documentation":"

The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs.

" } } }, "CreateExportTaskResponse":{ "type":"structure", "members":{ "taskId":{ "shape":"ExportTaskId", "documentation":"

The ID of the export task.

" } } }, "CreateLogGroupRequest":{ "type":"structure", "required":["logGroupName"], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "tags":{ "shape":"Tags", "documentation":"

The key-value pairs to use for the tags.

" } } }, "CreateLogStreamRequest":{ "type":"structure", "required":[ "logGroupName", "logStreamName" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "logStreamName":{ "shape":"LogStreamName", "documentation":"

The name of the log stream.

" } } }, "DataAlreadyAcceptedException":{ "type":"structure", "members":{ "expectedSequenceToken":{"shape":"SequenceToken"} }, "documentation":"

The event was already logged.

", "exception":true }, "Days":{ "type":"integer", "documentation":"

The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.

" }, "DefaultValue":{"type":"double"}, "DeleteDestinationRequest":{ "type":"structure", "required":["destinationName"], "members":{ "destinationName":{ "shape":"DestinationName", "documentation":"

The name of the destination.

" } } }, "DeleteLogGroupRequest":{ "type":"structure", "required":["logGroupName"], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" } } }, "DeleteLogStreamRequest":{ "type":"structure", "required":[ "logGroupName", "logStreamName" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "logStreamName":{ "shape":"LogStreamName", "documentation":"

The name of the log stream.

" } } }, "DeleteMetricFilterRequest":{ "type":"structure", "required":[ "logGroupName", "filterName" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "filterName":{ "shape":"FilterName", "documentation":"

The name of the metric filter.

" } } }, "DeleteRetentionPolicyRequest":{ "type":"structure", "required":["logGroupName"], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" } } }, "DeleteSubscriptionFilterRequest":{ "type":"structure", "required":[ "logGroupName", "filterName" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "filterName":{ "shape":"FilterName", "documentation":"

The name of the subscription filter.

" } } }, "Descending":{"type":"boolean"}, "DescribeDestinationsRequest":{ "type":"structure", "members":{ "DestinationNamePrefix":{ "shape":"DestinationName", "documentation":"

The prefix to match. If you don't specify a value, no prefix filter is applied.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "limit":{ "shape":"DescribeLimit", "documentation":"

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" } } }, "DescribeDestinationsResponse":{ "type":"structure", "members":{ "destinations":{ "shape":"Destinations", "documentation":"

The destinations.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeExportTasksRequest":{ "type":"structure", "members":{ "taskId":{ "shape":"ExportTaskId", "documentation":"

The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.

" }, "statusCode":{ "shape":"ExportTaskStatusCode", "documentation":"

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "limit":{ "shape":"DescribeLimit", "documentation":"

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" } } }, "DescribeExportTasksResponse":{ "type":"structure", "members":{ "exportTasks":{ "shape":"ExportTasks", "documentation":"

The export tasks.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeLimit":{ "type":"integer", "max":50, "min":1 }, "DescribeLogGroupsRequest":{ "type":"structure", "members":{ "logGroupNamePrefix":{ "shape":"LogGroupName", "documentation":"

The prefix to match.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "limit":{ "shape":"DescribeLimit", "documentation":"

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" } } }, "DescribeLogGroupsResponse":{ "type":"structure", "members":{ "logGroups":{ "shape":"LogGroups", "documentation":"

The log groups.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeLogStreamsRequest":{ "type":"structure", "required":["logGroupName"], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "logStreamNamePrefix":{ "shape":"LogStreamName", "documentation":"

The prefix to match.

You cannot specify this parameter if orderBy is LastEventTime.

" }, "orderBy":{ "shape":"OrderBy", "documentation":"

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

" }, "descending":{ "shape":"Descending", "documentation":"

If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "limit":{ "shape":"DescribeLimit", "documentation":"

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" } } }, "DescribeLogStreamsResponse":{ "type":"structure", "members":{ "logStreams":{ "shape":"LogStreams", "documentation":"

The log streams.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeMetricFiltersRequest":{ "type":"structure", "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "filterNamePrefix":{ "shape":"FilterName", "documentation":"

The prefix to match.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "limit":{ "shape":"DescribeLimit", "documentation":"

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" }, "metricName":{ "shape":"MetricName", "documentation":"

The name of the CloudWatch metric.

" }, "metricNamespace":{ "shape":"MetricNamespace", "documentation":"

The namespace of the CloudWatch metric.

" } } }, "DescribeMetricFiltersResponse":{ "type":"structure", "members":{ "metricFilters":{ "shape":"MetricFilters", "documentation":"

The metric filters.

" }, "nextToken":{"shape":"NextToken"} } }, "DescribeSubscriptionFiltersRequest":{ "type":"structure", "required":["logGroupName"], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "filterNamePrefix":{ "shape":"FilterName", "documentation":"

The prefix to match. If you don't specify a value, no prefix filter is applied.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "limit":{ "shape":"DescribeLimit", "documentation":"

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" } } }, "DescribeSubscriptionFiltersResponse":{ "type":"structure", "members":{ "subscriptionFilters":{ "shape":"SubscriptionFilters", "documentation":"

The subscription filters.

" }, "nextToken":{"shape":"NextToken"} } }, "Destination":{ "type":"structure", "members":{ "destinationName":{ "shape":"DestinationName", "documentation":"

The name of the destination.

" }, "targetArn":{ "shape":"TargetArn", "documentation":"

The Amazon Resource Name (ARN) of the physical target where the log events will be delivered (for example, a Kinesis stream).

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

A role for impersonation, used when delivering log events to the target.

" }, "accessPolicy":{ "shape":"AccessPolicy", "documentation":"

An IAM policy document that governs which AWS accounts can create subscription filters against this destination.

" }, "arn":{ "shape":"Arn", "documentation":"

The ARN of this destination.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

The creation time of the destination.

" } }, "documentation":"

Represents a cross-account destination that receives subscription log events.

" }, "DestinationArn":{ "type":"string", "min":1 }, "DestinationName":{ "type":"string", "max":512, "min":1, "pattern":"[^:*]*" }, "Destinations":{ "type":"list", "member":{"shape":"Destination"} }, "Distribution":{ "type":"string", "enum":[ "Random", "ByLogStream" ] }, "EventId":{"type":"string"}, "EventMessage":{ "type":"string", "min":1 }, "EventNumber":{"type":"long"}, "EventsLimit":{ "type":"integer", "max":10000, "min":1 }, "ExportDestinationBucket":{ "type":"string", "max":512, "min":1 }, "ExportDestinationPrefix":{"type":"string"}, "ExportTask":{ "type":"structure", "members":{ "taskId":{ "shape":"ExportTaskId", "documentation":"

The ID of the export task.

" }, "taskName":{ "shape":"ExportTaskName", "documentation":"

The name of the export task.

" }, "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group from which logs data was exported.

" }, "from":{ "shape":"Timestamp", "documentation":"

The start time, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp prior to this time are not exported.

" }, "to":{ "shape":"Timestamp", "documentation":"

The end time, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.

" }, "destination":{ "shape":"ExportDestinationBucket", "documentation":"

The name of Amazon S3 bucket to which the log data was exported.

" }, "destinationPrefix":{ "shape":"ExportDestinationPrefix", "documentation":"

The prefix that was used as the start of Amazon S3 key for every object exported.

" }, "status":{ "shape":"ExportTaskStatus", "documentation":"

The status of the export task.

" }, "executionInfo":{ "shape":"ExportTaskExecutionInfo", "documentation":"

Execution info about the export task.

" } }, "documentation":"

Represents an export task.

" }, "ExportTaskExecutionInfo":{ "type":"structure", "members":{ "creationTime":{ "shape":"Timestamp", "documentation":"

The creation time of the export task.

" }, "completionTime":{ "shape":"Timestamp", "documentation":"

The completion time of the export task.

" } }, "documentation":"

Represents the status of an export task.

" }, "ExportTaskId":{ "type":"string", "max":512, "min":1 }, "ExportTaskName":{ "type":"string", "max":512, "min":1 }, "ExportTaskStatus":{ "type":"structure", "members":{ "code":{ "shape":"ExportTaskStatusCode", "documentation":"

The status code of the export task.

" }, "message":{ "shape":"ExportTaskStatusMessage", "documentation":"

The status message related to the status code.

" } }, "documentation":"

Represents the status of an export task.

" }, "ExportTaskStatusCode":{ "type":"string", "enum":[ "CANCELLED", "COMPLETED", "FAILED", "PENDING", "PENDING_CANCEL", "RUNNING" ] }, "ExportTaskStatusMessage":{"type":"string"}, "ExportTasks":{ "type":"list", "member":{"shape":"ExportTask"} }, "ExtractedValues":{ "type":"map", "key":{"shape":"Token"}, "value":{"shape":"Value"} }, "FilterCount":{"type":"integer"}, "FilterLogEventsRequest":{ "type":"structure", "required":["logGroupName"], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "logStreamNames":{ "shape":"InputLogStreamNames", "documentation":"

Optional list of log stream names.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

The start of the time range, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp prior to this time are not returned.

" }, "endTime":{ "shape":"Timestamp", "documentation":"

The end of the time range, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

" }, "filterPattern":{ "shape":"FilterPattern", "documentation":"

The filter pattern to use. If not provided, all the events are matched.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of events to return. (You received this token from a previous call.)

" }, "limit":{ "shape":"EventsLimit", "documentation":"

The maximum number of events to return. The default is 10,000 events.

" }, "interleaved":{ "shape":"Interleaved", "documentation":"

If the value is true, the operation makes a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If the value is false all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. The default is false.

" } } }, "FilterLogEventsResponse":{ "type":"structure", "members":{ "events":{ "shape":"FilteredLogEvents", "documentation":"

The matched events.

" }, "searchedLogStreams":{ "shape":"SearchedLogStreams", "documentation":"

Indicates which log streams have been searched and whether each has been searched completely.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token to use when requesting the next set of items. The token expires after 24 hours.

" } } }, "FilterName":{ "type":"string", "max":512, "min":1, "pattern":"[^:*]*" }, "FilterPattern":{ "type":"string", "documentation":"

A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event may contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

", "max":1024, "min":0 }, "FilteredLogEvent":{ "type":"structure", "members":{ "logStreamName":{ "shape":"LogStreamName", "documentation":"

The name of the log stream this event belongs to.

" }, "timestamp":{ "shape":"Timestamp", "documentation":"

The time the event occurred, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

" }, "message":{ "shape":"EventMessage", "documentation":"

The data contained in the log event.

" }, "ingestionTime":{ "shape":"Timestamp", "documentation":"

The time the event was ingested.

" }, "eventId":{ "shape":"EventId", "documentation":"

The ID of the event.

" } }, "documentation":"

Represents a matched event.

" }, "FilteredLogEvents":{ "type":"list", "member":{"shape":"FilteredLogEvent"} }, "GetLogEventsRequest":{ "type":"structure", "required":[ "logGroupName", "logStreamName" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "logStreamName":{ "shape":"LogStreamName", "documentation":"

The name of the log stream.

" }, "startTime":{ "shape":"Timestamp", "documentation":"

The start of the time range, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not included.

" }, "endTime":{ "shape":"Timestamp", "documentation":"

The end of the time range, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not included.

" }, "nextToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" }, "limit":{ "shape":"EventsLimit", "documentation":"

The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1MB, up to 10,000 log events.

" }, "startFromHead":{ "shape":"StartFromHead", "documentation":"

If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

" } } }, "GetLogEventsResponse":{ "type":"structure", "members":{ "events":{ "shape":"OutputLogEvents", "documentation":"

The events.

" }, "nextForwardToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items in the forward direction. The token expires after 24 hours.

" }, "nextBackwardToken":{ "shape":"NextToken", "documentation":"

The token for the next set of items in the backward direction. The token expires after 24 hours.

" } } }, "InputLogEvent":{ "type":"structure", "required":[ "timestamp", "message" ], "members":{ "timestamp":{ "shape":"Timestamp", "documentation":"

The time the event occurred, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

" }, "message":{ "shape":"EventMessage", "documentation":"

The raw event message.

" } }, "documentation":"

Represents a log event, which is a record of activity that was recorded by the application or resource being monitored.

" }, "InputLogEvents":{ "type":"list", "member":{"shape":"InputLogEvent"}, "max":10000, "min":1 }, "InputLogStreamNames":{ "type":"list", "member":{"shape":"LogStreamName"}, "max":100, "min":1 }, "Interleaved":{"type":"boolean"}, "InvalidOperationException":{ "type":"structure", "members":{ }, "documentation":"

The operation is not valid on the specified resource.

", "exception":true }, "InvalidParameterException":{ "type":"structure", "members":{ }, "documentation":"

A parameter is specified incorrectly.

", "exception":true }, "InvalidSequenceTokenException":{ "type":"structure", "members":{ "expectedSequenceToken":{"shape":"SequenceToken"} }, "documentation":"

The sequence token is not valid.

", "exception":true }, "LimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

You have reached the maximum number of resources that can be created.

", "exception":true }, "ListTagsLogGroupRequest":{ "type":"structure", "required":["logGroupName"], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" } } }, "ListTagsLogGroupResponse":{ "type":"structure", "members":{ "tags":{ "shape":"Tags", "documentation":"

The tags.

" } } }, "LogEventIndex":{"type":"integer"}, "LogGroup":{ "type":"structure", "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

The creation time of the log group.

" }, "retentionInDays":{"shape":"Days"}, "metricFilterCount":{ "shape":"FilterCount", "documentation":"

The number of metric filters.

" }, "arn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the log group.

" }, "storedBytes":{ "shape":"StoredBytes", "documentation":"

The number of bytes stored.

" } }, "documentation":"

Represents a log group.

" }, "LogGroupName":{ "type":"string", "max":512, "min":1, "pattern":"[\\.\\-_/#A-Za-z0-9]+" }, "LogGroups":{ "type":"list", "member":{"shape":"LogGroup"} }, "LogStream":{ "type":"structure", "members":{ "logStreamName":{ "shape":"LogStreamName", "documentation":"

The name of the log stream.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

The creation time of the stream.

" }, "firstEventTimestamp":{ "shape":"Timestamp", "documentation":"

The time of the first event, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

" }, "lastEventTimestamp":{ "shape":"Timestamp", "documentation":"

The time of the last event, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

" }, "lastIngestionTime":{ "shape":"Timestamp", "documentation":"

The ingestion time.

" }, "uploadSequenceToken":{ "shape":"SequenceToken", "documentation":"

The sequence token.

" }, "arn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the log stream.

" }, "storedBytes":{ "shape":"StoredBytes", "documentation":"

The number of bytes stored.

" } }, "documentation":"

Represents a log stream, which is a sequence of log events from a single emitter of logs.

" }, "LogStreamName":{ "type":"string", "max":512, "min":1, "pattern":"[^:*]*" }, "LogStreamSearchedCompletely":{"type":"boolean"}, "LogStreams":{ "type":"list", "member":{"shape":"LogStream"} }, "MetricFilter":{ "type":"structure", "members":{ "filterName":{ "shape":"FilterName", "documentation":"

The name of the metric filter.

" }, "filterPattern":{"shape":"FilterPattern"}, "metricTransformations":{ "shape":"MetricTransformations", "documentation":"

The metric transformations.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

The creation time of the metric filter.

" }, "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" } }, "documentation":"

Metric filters express how CloudWatch Logs would extract metric observations from ingested log events and transform them into metric data in a CloudWatch metric.

" }, "MetricFilterMatchRecord":{ "type":"structure", "members":{ "eventNumber":{ "shape":"EventNumber", "documentation":"

The event number.

" }, "eventMessage":{ "shape":"EventMessage", "documentation":"

The raw event data.

" }, "extractedValues":{ "shape":"ExtractedValues", "documentation":"

The values extracted from the event data by the filter.

" } }, "documentation":"

Represents a matched event.

" }, "MetricFilterMatches":{ "type":"list", "member":{"shape":"MetricFilterMatchRecord"} }, "MetricFilters":{ "type":"list", "member":{"shape":"MetricFilter"} }, "MetricName":{ "type":"string", "documentation":"

The name of the CloudWatch metric to which the monitored log information should be published. For example, you may publish to a metric called ErrorCount.

", "max":255, "pattern":"[^:*$]*" }, "MetricNamespace":{ "type":"string", "max":255, "pattern":"[^:*$]*" }, "MetricTransformation":{ "type":"structure", "required":[ "metricName", "metricNamespace", "metricValue" ], "members":{ "metricName":{ "shape":"MetricName", "documentation":"

The name of the CloudWatch metric.

" }, "metricNamespace":{ "shape":"MetricNamespace", "documentation":"

The namespace of the CloudWatch metric.

" }, "metricValue":{ "shape":"MetricValue", "documentation":"

The value to publish to the CloudWatch metric when a filter pattern matches a log event.

" }, "defaultValue":{ "shape":"DefaultValue", "documentation":"

(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.

" } }, "documentation":"

Indicates how to transform ingested log events into metric data in a CloudWatch metric.

" }, "MetricTransformations":{ "type":"list", "member":{"shape":"MetricTransformation"}, "max":1, "min":1 }, "MetricValue":{ "type":"string", "documentation":"

The value to publish to the CloudWatch metric. For example, if you're counting the occurrences of a term like \"Error\", the value is \"1\" for each occurrence. If you're counting the bytes transferred, the value is the value in the log event.

", "max":100 }, "NextToken":{ "type":"string", "documentation":"

The token for the next set of items to return. The token expires after 24 hours.

", "min":1 }, "OperationAbortedException":{ "type":"structure", "members":{ }, "documentation":"

Multiple requests to update the same resource were in conflict.

", "exception":true }, "OrderBy":{ "type":"string", "enum":[ "LogStreamName", "LastEventTime" ] }, "OutputLogEvent":{ "type":"structure", "members":{ "timestamp":{ "shape":"Timestamp", "documentation":"

The time the event occurred, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

" }, "message":{ "shape":"EventMessage", "documentation":"

The data contained in the log event.

" }, "ingestionTime":{ "shape":"Timestamp", "documentation":"

The time the event was ingested.

" } }, "documentation":"

Represents a log event.

" }, "OutputLogEvents":{ "type":"list", "member":{"shape":"OutputLogEvent"} }, "PutDestinationPolicyRequest":{ "type":"structure", "required":[ "destinationName", "accessPolicy" ], "members":{ "destinationName":{ "shape":"DestinationName", "documentation":"

A name for an existing destination.

" }, "accessPolicy":{ "shape":"AccessPolicy", "documentation":"

An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination.

" } } }, "PutDestinationRequest":{ "type":"structure", "required":[ "destinationName", "targetArn", "roleArn" ], "members":{ "destinationName":{ "shape":"DestinationName", "documentation":"

A name for the destination.

" }, "targetArn":{ "shape":"TargetArn", "documentation":"

The ARN of an Amazon Kinesis stream to deliver matching log events to.

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

The ARN of an IAM role that grants CloudWatch Logs permissions to call Amazon Kinesis PutRecord on the destination stream.

" } } }, "PutDestinationResponse":{ "type":"structure", "members":{ "destination":{ "shape":"Destination", "documentation":"

The destination.

" } } }, "PutLogEventsRequest":{ "type":"structure", "required":[ "logGroupName", "logStreamName", "logEvents" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "logStreamName":{ "shape":"LogStreamName", "documentation":"

The name of the log stream.

" }, "logEvents":{ "shape":"InputLogEvents", "documentation":"

The log events.

" }, "sequenceToken":{ "shape":"SequenceToken", "documentation":"

The sequence token.

" } } }, "PutLogEventsResponse":{ "type":"structure", "members":{ "nextSequenceToken":{ "shape":"SequenceToken", "documentation":"

The next sequence token.

" }, "rejectedLogEventsInfo":{ "shape":"RejectedLogEventsInfo", "documentation":"

The rejected events.

" } } }, "PutMetricFilterRequest":{ "type":"structure", "required":[ "logGroupName", "filterName", "filterPattern", "metricTransformations" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "filterName":{ "shape":"FilterName", "documentation":"

A name for the metric filter.

" }, "filterPattern":{ "shape":"FilterPattern", "documentation":"

A filter pattern for extracting metric data out of ingested log events.

" }, "metricTransformations":{ "shape":"MetricTransformations", "documentation":"

A collection of information needed to define how metric data gets emitted.

" } } }, "PutRetentionPolicyRequest":{ "type":"structure", "required":[ "logGroupName", "retentionInDays" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "retentionInDays":{"shape":"Days"} } }, "PutSubscriptionFilterRequest":{ "type":"structure", "required":[ "logGroupName", "filterName", "filterPattern", "destinationArn" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "filterName":{ "shape":"FilterName", "documentation":"

A name for the subscription filter.

" }, "filterPattern":{ "shape":"FilterPattern", "documentation":"

A filter pattern for subscribing to a filtered stream of log events.

" }, "destinationArn":{ "shape":"DestinationArn", "documentation":"

The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:

  • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

  • A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.

  • An Amazon Kinesis Firehose stream belonging to the same account as the subscription filter, for same-account delivery.

  • An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.

" }, "distribution":{ "shape":"Distribution", "documentation":"

The method used to distribute log data to the destination, when the destination is an Amazon Kinesis stream. By default, log data is grouped by log stream. For a more even distribution, you can group log data randomly.

" } } }, "RejectedLogEventsInfo":{ "type":"structure", "members":{ "tooNewLogEventStartIndex":{ "shape":"LogEventIndex", "documentation":"

The log events that are too new.

" }, "tooOldLogEventEndIndex":{ "shape":"LogEventIndex", "documentation":"

The log events that are too old.

" }, "expiredLogEventEndIndex":{ "shape":"LogEventIndex", "documentation":"

The expired log events.

" } }, "documentation":"

Represents the rejected events.

" }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ }, "documentation":"

The specified resource already exists.

", "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

The specified resource does not exist.

", "exception":true }, "RoleArn":{ "type":"string", "min":1 }, "SearchedLogStream":{ "type":"structure", "members":{ "logStreamName":{ "shape":"LogStreamName", "documentation":"

The name of the log stream.

" }, "searchedCompletely":{ "shape":"LogStreamSearchedCompletely", "documentation":"

Indicates whether all the events in this log stream were searched.

" } }, "documentation":"

Represents the search status of a log stream.

" }, "SearchedLogStreams":{ "type":"list", "member":{"shape":"SearchedLogStream"} }, "SequenceToken":{ "type":"string", "min":1 }, "ServiceUnavailableException":{ "type":"structure", "members":{ }, "documentation":"

The service cannot complete the request.

", "exception":true, "fault":true }, "StartFromHead":{"type":"boolean"}, "StoredBytes":{ "type":"long", "min":0 }, "SubscriptionFilter":{ "type":"structure", "members":{ "filterName":{ "shape":"FilterName", "documentation":"

The name of the subscription filter.

" }, "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "filterPattern":{"shape":"FilterPattern"}, "destinationArn":{ "shape":"DestinationArn", "documentation":"

The Amazon Resource Name (ARN) of the destination.

" }, "roleArn":{ "shape":"RoleArn", "documentation":"

" }, "distribution":{ "shape":"Distribution", "documentation":"

The method used to distribute log data to the destination, when the destination is an Amazon Kinesis stream.

" }, "creationTime":{ "shape":"Timestamp", "documentation":"

The creation time of the subscription filter.

" } }, "documentation":"

Represents a subscription filter.

" }, "SubscriptionFilters":{ "type":"list", "member":{"shape":"SubscriptionFilter"} }, "TagKey":{ "type":"string", "max":128, "min":1, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$" }, "TagList":{ "type":"list", "member":{"shape":"TagKey"}, "min":1 }, "TagLogGroupRequest":{ "type":"structure", "required":[ "logGroupName", "tags" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "tags":{ "shape":"Tags", "documentation":"

The key-value pairs to use for the tags.

" } } }, "TagValue":{ "type":"string", "max":256, "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Tags":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":50, "min":1 }, "TargetArn":{ "type":"string", "min":1 }, "TestEventMessages":{ "type":"list", "member":{"shape":"EventMessage"}, "max":50, "min":1 }, "TestMetricFilterRequest":{ "type":"structure", "required":[ "filterPattern", "logEventMessages" ], "members":{ "filterPattern":{"shape":"FilterPattern"}, "logEventMessages":{ "shape":"TestEventMessages", "documentation":"

The log event messages to test.

" } } }, "TestMetricFilterResponse":{ "type":"structure", "members":{ "matches":{ "shape":"MetricFilterMatches", "documentation":"

The matched events.

" } } }, "Timestamp":{ "type":"long", "min":0 }, "Token":{"type":"string"}, "UntagLogGroupRequest":{ "type":"structure", "required":[ "logGroupName", "tags" ], "members":{ "logGroupName":{ "shape":"LogGroupName", "documentation":"

The name of the log group.

" }, "tags":{ "shape":"TagList", "documentation":"

The tag keys. The corresponding tags are removed from the log group.

" } } }, "Value":{"type":"string"} }, "documentation":"

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from EC2 instances, Amazon CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the Amazon CloudWatch console, the CloudWatch Logs commands in the AWS CLI, the CloudWatch Logs API, or the CloudWatch Logs SDK.

You can use CloudWatch Logs to:

  • Monitor Logs from Amazon EC2 Instances in Real-time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as \"NullReferenceException\") or count the number of occurrences of a literal term at a particular position in log data (such as \"404\" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a Amazon CloudWatch metric that you specify.

  • Monitor Amazon CloudTrail Logged Events: You can create alarms in Amazon CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting.

  • Archive Log Data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.

" } botocore-1.5.7/botocore/data/lambda/0000777454262600001440000000000013042511307020353 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/lambda/2014-11-11/0000777454262600001440000000000013042511307021377 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/lambda/2014-11-11/service-2.json0000666454262600001440000011342013042511306024071 0ustar pysdk-ciamazon00000000000000{ "metadata":{ "apiVersion":"2014-11-11", "endpointPrefix":"lambda", "serviceFullName":"AWS Lambda", "signatureVersion":"v4", "protocol":"rest-json" }, "documentation":"AWS Lambda

Overview

This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, go to What is AWS Lambda, and for information about how the service works, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide.

", "operations":{ "AddEventSource":{ "name":"AddEventSource", "http":{ "method":"POST", "requestUri":"/2014-11-13/event-source-mappings/" }, "input":{"shape":"AddEventSourceRequest"}, "output":{ "shape":"EventSourceConfiguration", "documentation":"

Describes mapping between an Amazon Kinesis stream and a Lambda function.

" }, "errors":[ { "shape":"ServiceException", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

The AWS Lambda service encountered an internal error.

" }, { "shape":"InvalidParameterValueException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

" } ], "documentation":"

Identifies a stream as an event source for an AWS Lambda function. It can be either an Amazon Kinesis stream or a Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.

This is the pull model, where AWS Lambda invokes the function. For more information, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide.

This association between an Amazon Kinesis stream and an AWS Lambda function is called the event source mapping. You provide the configuration information (for example, which stream to read from and which AWS Lambda function to invoke) for the event source mapping in the request body.

Each event source, such as a Kinesis stream, can only be associated with one AWS Lambda function. If you call AddEventSource for an event source that is already mapped to another AWS Lambda function, the existing mapping is updated to call the new function instead of the old one.

This operation requires permission for the iam:PassRole action for the IAM role. It also requires permission for the lambda:AddEventSource action.

" }, "DeleteFunction":{ "name":"DeleteFunction", "http":{ "method":"DELETE", "requestUri":"/2014-11-13/functions/{FunctionName}", "responseCode":204 }, "input":{"shape":"DeleteFunctionRequest"}, "errors":[ { "shape":"ServiceException", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

The AWS Lambda service encountered an internal error.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The function or the event source specified in the request does not exist.

" } ], "documentation":"

Deletes the specified Lambda function code and configuration.

This operation requires permission for the lambda:DeleteFunction action.

" }, "GetEventSource":{ "name":"GetEventSource", "http":{ "method":"GET", "requestUri":"/2014-11-13/event-source-mappings/{UUID}", "responseCode":200 }, "input":{"shape":"GetEventSourceRequest"}, "output":{ "shape":"EventSourceConfiguration", "documentation":"

Describes mapping between an Amazon Kinesis stream and a Lambda function.

" }, "errors":[ { "shape":"ServiceException", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

The AWS Lambda service encountered an internal error.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The function or the event source specified in the request does not exist.

" }, { "shape":"InvalidParameterValueException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

" } ], "documentation":"

Returns configuration information for the specified event source mapping (see AddEventSource).

This operation requires permission for the lambda:GetEventSource action.

" }, "GetFunction":{ "name":"GetFunction", "http":{ "method":"GET", "requestUri":"/2014-11-13/functions/{FunctionName}", "responseCode":200 }, "input":{"shape":"GetFunctionRequest"}, "output":{ "shape":"GetFunctionResponse", "documentation":"

This response contains the object for AWS Lambda function location (see API_FunctionCodeLocation

" }, "errors":[ { "shape":"ServiceException", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

The AWS Lambda service encountered an internal error.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The function or the event source specified in the request does not exist.

" } ], "documentation":"

Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with UploadFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.

This operation requires permission for the lambda:GetFunction action.

" }, "GetFunctionConfiguration":{ "name":"GetFunctionConfiguration", "http":{ "method":"GET", "requestUri":"/2014-11-13/functions/{FunctionName}/configuration", "responseCode":200 }, "input":{"shape":"GetFunctionConfigurationRequest"}, "output":{ "shape":"FunctionConfiguration", "documentation":"

A complex type that describes function metadata.

" }, "errors":[ { "shape":"ServiceException", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

The AWS Lambda service encountered an internal error.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The function or the event source specified in the request does not exist.

" } ], "documentation":"

Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using UploadFunction.

This operation requires permission for the lambda:GetFunctionConfiguration operation.

" }, "InvokeAsync":{ "name":"InvokeAsync", "http":{ "method":"POST", "requestUri":"/2014-11-13/functions/{FunctionName}/invoke-async/", "responseCode":202 }, "input":{"shape":"InvokeAsyncRequest"}, "output":{ "shape":"InvokeAsyncResponse", "documentation":"

Upon success, it returns empty response. Otherwise, throws an exception.

" }, "errors":[ { "shape":"ServiceException", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

The AWS Lambda service encountered an internal error.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The function or the event source specified in the request does not exist.

" }, { "shape":"InvalidRequestContentException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request body could not be parsed as JSON.

" } ], "documentation":"

Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch logs console.

This operation requires permission for the lambda:InvokeAsync action.

" }, "ListEventSources":{ "name":"ListEventSources", "http":{ "method":"GET", "requestUri":"/2014-11-13/event-source-mappings/", "responseCode":200 }, "input":{"shape":"ListEventSourcesRequest"}, "output":{ "shape":"ListEventSourcesResponse", "documentation":"

Contains a list of event sources (see API_EventSourceConfiguration)

" }, "errors":[ { "shape":"ServiceException", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

The AWS Lambda service encountered an internal error.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The function or the event source specified in the request does not exist.

" }, { "shape":"InvalidParameterValueException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

" } ], "documentation":"

Returns a list of event source mappings you created using the AddEventSource (see AddEventSource), where you identify a stream as event source. This list does not include Amazon S3 event sources.

For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.

This operation requires permission for the lambda:ListEventSources action.

" }, "ListFunctions":{ "name":"ListFunctions", "http":{ "method":"GET", "requestUri":"/2014-11-13/functions/", "responseCode":200 }, "input":{"shape":"ListFunctionsRequest"}, "output":{ "shape":"ListFunctionsResponse", "documentation":"

Contains a list of AWS Lambda function configurations (see API_FunctionConfiguration.

" }, "errors":[ { "shape":"ServiceException", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

The AWS Lambda service encountered an internal error.

" } ], "documentation":"

Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.

This operation requires permission for the lambda:ListFunctions action.

" }, "RemoveEventSource":{ "name":"RemoveEventSource", "http":{ "method":"DELETE", "requestUri":"/2014-11-13/event-source-mappings/{UUID}", "responseCode":204 }, "input":{"shape":"RemoveEventSourceRequest"}, "errors":[ { "shape":"ServiceException", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

The AWS Lambda service encountered an internal error.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The function or the event source specified in the request does not exist.

" }, { "shape":"InvalidParameterValueException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

" } ], "documentation":"

Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.

This operation requires permission for the lambda:RemoveEventSource action.

" }, "UpdateFunctionConfiguration":{ "name":"UpdateFunctionConfiguration", "http":{ "method":"PUT", "requestUri":"/2014-11-13/functions/{FunctionName}/configuration", "responseCode":200 }, "input":{"shape":"UpdateFunctionConfigurationRequest"}, "output":{ "shape":"FunctionConfiguration", "documentation":"

A complex type that describes function metadata.

" }, "errors":[ { "shape":"ServiceException", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

The AWS Lambda service encountered an internal error.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The function or the event source specified in the request does not exist.

" }, { "shape":"InvalidParameterValueException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

" } ], "documentation":"

Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.

This operation requires permission for the lambda:UpdateFunctionConfiguration action.

" }, "UploadFunction":{ "name":"UploadFunction", "http":{ "method":"PUT", "requestUri":"/2014-11-13/functions/{FunctionName}", "responseCode":201 }, "input":{"shape":"UploadFunctionRequest"}, "output":{ "shape":"FunctionConfiguration", "documentation":"

A complex type that describes function metadata.

" }, "errors":[ { "shape":"ServiceException", "error":{"httpStatusCode":500}, "exception":true, "documentation":"

The AWS Lambda service encountered an internal error.

" }, { "shape":"InvalidParameterValueException", "error":{"httpStatusCode":400}, "exception":true, "documentation":"

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

" }, { "shape":"ResourceNotFoundException", "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The function or the event source specified in the request does not exist.

" } ], "documentation":"

Creates a new Lambda function or updates an existing function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the existing Lambda function is updated with the new code and metadata.

This operation requires permission for the lambda:UploadFunction action.

" } }, "shapes":{ "AddEventSourceRequest":{ "type":"structure", "required":[ "EventSource", "FunctionName", "Role" ], "members":{ "EventSource":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source. Any record added to this stream causes AWS Lambda to invoke your Lambda function. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.

" }, "FunctionName":{ "shape":"FunctionName", "documentation":"

The Lambda function to invoke when AWS Lambda detects an event on the stream.

" }, "Role":{ "shape":"RoleArn", "documentation":"

The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

" }, "BatchSize":{ "shape":"Integer", "documentation":"

The largest number of records that AWS Lambda will give to your function in a single event. The default is 100 records.

" }, "Parameters":{ "shape":"Map", "documentation":"

A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source. Currently, AWS Lambda supports only the InitialPositionInStream key. The valid values are: \"TRIM_HORIZON\" and \"LATEST\". The default value is \"TRIM_HORIZON\". For more information, go to ShardIteratorType in the Amazon Kinesis Service API Reference.

" } } }, "Blob":{ "type":"blob", "streaming":true }, "DeleteFunctionRequest":{ "type":"structure", "required":["FunctionName"], "members":{ "FunctionName":{ "shape":"FunctionName", "location":"uri", "locationName":"FunctionName", "documentation":"

The Lambda function to delete.

" } } }, "Description":{ "type":"string", "min":0, "max":256 }, "EventSourceConfiguration":{ "type":"structure", "members":{ "UUID":{ "shape":"String", "documentation":"

The AWS Lambda assigned opaque identifier for the mapping.

" }, "BatchSize":{ "shape":"Integer", "documentation":"

The largest number of records that AWS Lambda will POST in the invocation request to your function.

" }, "EventSource":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.

" }, "FunctionName":{ "shape":"FunctionName", "documentation":"

The Lambda function to invoke when AWS Lambda detects an event on the stream.

" }, "Parameters":{ "shape":"Map", "documentation":"

The map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source.

" }, "Role":{ "shape":"RoleArn", "documentation":"

The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

" }, "LastModified":{ "shape":"Timestamp", "documentation":"

The UTC time string indicating the last time the event mapping was updated.

" }, "IsActive":{ "shape":"Boolean", "documentation":"

Indicates whether the event source mapping is currently honored. Events are only processes if IsActive is true.

" }, "Status":{ "shape":"String", "documentation":"

The description of the health of the event source mapping. Valid values are: \"PENDING\", \"OK\", and \"PROBLEM:message\". Initially this staus is \"PENDING\". When AWS Lambda begins processing events, it changes the status to \"OK\".

" } }, "documentation":"

Describes mapping between an Amazon Kinesis stream and a Lambda function.

" }, "EventSourceList":{ "type":"list", "member":{"shape":"EventSourceConfiguration"} }, "FunctionArn":{ "type":"string", "pattern":"arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?" }, "FunctionCodeLocation":{ "type":"structure", "members":{ "RepositoryType":{ "shape":"String", "documentation":"

The repository from which you can download the function.

" }, "Location":{ "shape":"String", "documentation":"

The presigned URL you can use to download the function's .zip file that you previously uploaded. The URL is valid for up to 10 minutes.

" } }, "documentation":"

The object for the Lambda function location.

" }, "FunctionConfiguration":{ "type":"structure", "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

The name of the function.

" }, "FunctionARN":{ "shape":"FunctionArn", "documentation":"

The Amazon Resource Name (ARN) assigned to the function.

" }, "ConfigurationId":{ "shape":"String", "documentation":"

A Lambda-assigned unique identifier for the current function code and related configuration.

" }, "Runtime":{ "shape":"Runtime", "documentation":"

The runtime environment for the Lambda function.

" }, "Role":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.

" }, "Handler":{ "shape":"Handler", "documentation":"

The function Lambda calls to begin executing your function.

" }, "Mode":{ "shape":"Mode", "documentation":"

The type of the Lambda function you uploaded.

" }, "CodeSize":{ "shape":"Long", "documentation":"

The size, in bytes, of the function .zip file you uploaded.

" }, "Description":{ "shape":"Description", "documentation":"

The user-provided description.

" }, "Timeout":{ "shape":"Timeout", "documentation":"

The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

" }, "MemorySize":{ "shape":"MemorySize", "documentation":"

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

" }, "LastModified":{ "shape":"Timestamp", "documentation":"

The timestamp of the last time you updated the function.

" } }, "documentation":"

A complex type that describes function metadata.

" }, "FunctionList":{ "type":"list", "member":{"shape":"FunctionConfiguration"} }, "FunctionName":{ "type":"string", "min":1, "max":64, "pattern":"[a-zA-Z0-9-_]+" }, "GetEventSourceRequest":{ "type":"structure", "required":["UUID"], "members":{ "UUID":{ "shape":"String", "location":"uri", "locationName":"UUID", "documentation":"

The AWS Lambda assigned ID of the event source mapping.

" } } }, "GetFunctionConfigurationRequest":{ "type":"structure", "required":["FunctionName"], "members":{ "FunctionName":{ "shape":"FunctionName", "location":"uri", "locationName":"FunctionName", "documentation":"

The name of the Lambda function for which you want to retrieve the configuration information.

" } } }, "GetFunctionRequest":{ "type":"structure", "required":["FunctionName"], "members":{ "FunctionName":{ "shape":"FunctionName", "location":"uri", "locationName":"FunctionName", "documentation":"

The Lambda function name.

" } } }, "GetFunctionResponse":{ "type":"structure", "members":{ "Configuration":{"shape":"FunctionConfiguration"}, "Code":{"shape":"FunctionCodeLocation"} }, "documentation":"

This response contains the object for AWS Lambda function location (see API_FunctionCodeLocation

" }, "Handler":{ "type":"string", "pattern":"[a-zA-Z0-9./\\-_]+" }, "HttpStatus":{"type":"integer"}, "Integer":{"type":"integer"}, "InvalidParameterValueException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "message":{"shape":"String"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

" }, "InvalidRequestContentException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "message":{"shape":"String"} }, "error":{"httpStatusCode":400}, "exception":true, "documentation":"

The request body could not be parsed as JSON.

" }, "InvokeAsyncRequest":{ "type":"structure", "required":[ "FunctionName", "InvokeArgs" ], "members":{ "FunctionName":{ "shape":"FunctionName", "location":"uri", "locationName":"FunctionName", "documentation":"

The Lambda function name.

" }, "InvokeArgs":{ "shape":"Blob", "documentation":"

JSON that you want to provide to your Lambda function as input.

" } }, "payload":"InvokeArgs" }, "InvokeAsyncResponse":{ "type":"structure", "members":{ "Status":{ "shape":"HttpStatus", "location":"statusCode", "documentation":"

It will be 202 upon success.

" } }, "documentation":"

Upon success, it returns empty response. Otherwise, throws an exception.

" }, "ListEventSourcesRequest":{ "type":"structure", "members":{ "EventSourceArn":{ "shape":"String", "location":"querystring", "locationName":"EventSource", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Kinesis stream.

" }, "FunctionName":{ "shape":"FunctionName", "location":"querystring", "locationName":"FunctionName", "documentation":"

The name of the AWS Lambda function.

" }, "Marker":{ "shape":"String", "location":"querystring", "locationName":"Marker", "documentation":"

Optional string. An opaque pagination token returned from a previous ListEventSources operation. If present, specifies to continue the list from where the returning call left off.

" }, "MaxItems":{ "shape":"MaxListItems", "location":"querystring", "locationName":"MaxItems", "documentation":"

Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.

" } } }, "ListEventSourcesResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"String", "documentation":"

A string, present if there are more event source mappings.

" }, "EventSources":{ "shape":"EventSourceList", "documentation":"

An arrary of EventSourceConfiguration objects.

" } }, "documentation":"

Contains a list of event sources (see API_EventSourceConfiguration)

" }, "ListFunctionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "location":"querystring", "locationName":"Marker", "documentation":"

Optional string. An opaque pagination token returned from a previous ListFunctions operation. If present, indicates where to continue the listing.

" }, "MaxItems":{ "shape":"MaxListItems", "location":"querystring", "locationName":"MaxItems", "documentation":"

Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.

" } } }, "ListFunctionsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"String", "documentation":"

A string, present if there are more functions.

" }, "Functions":{ "shape":"FunctionList", "documentation":"

A list of Lambda functions.

" } }, "documentation":"

Contains a list of AWS Lambda function configurations (see API_FunctionConfiguration.

" }, "Long":{"type":"long"}, "Map":{ "type":"map", "key":{"shape":"String"}, "value":{"shape":"String"} }, "MaxListItems":{ "type":"integer", "min":1, "max":10000 }, "MemorySize":{ "type":"integer", "min":128, "max":1024 }, "Mode":{ "type":"string", "enum":["event"] }, "RemoveEventSourceRequest":{ "type":"structure", "required":["UUID"], "members":{ "UUID":{ "shape":"String", "location":"uri", "locationName":"UUID", "documentation":"

The event source mapping ID.

" } } }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "Message":{"shape":"String"} }, "error":{"httpStatusCode":404}, "exception":true, "documentation":"

The function or the event source specified in the request does not exist.

" }, "RoleArn":{ "type":"string", "pattern":"arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" }, "Runtime":{ "type":"string", "enum":["nodejs"] }, "ServiceException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "Message":{"shape":"String"} }, "error":{"httpStatusCode":500}, "exception":true, "documentation":"

The AWS Lambda service encountered an internal error.

" }, "String":{"type":"string"}, "Timeout":{ "type":"integer", "min":1, "max":60 }, "Timestamp":{"type":"string"}, "UpdateFunctionConfigurationRequest":{ "type":"structure", "required":["FunctionName"], "members":{ "FunctionName":{ "shape":"FunctionName", "location":"uri", "locationName":"FunctionName", "documentation":"

The name of the Lambda function.

" }, "Role":{ "shape":"RoleArn", "location":"querystring", "locationName":"Role", "documentation":"

The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.

" }, "Handler":{ "shape":"Handler", "location":"querystring", "locationName":"Handler", "documentation":"

The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.

" }, "Description":{ "shape":"Description", "location":"querystring", "locationName":"Description", "documentation":"

A short user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.

" }, "Timeout":{ "shape":"Timeout", "location":"querystring", "locationName":"Timeout", "documentation":"

The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

" }, "MemorySize":{ "shape":"MemorySize", "location":"querystring", "locationName":"MemorySize", "documentation":"

The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

" } } }, "UploadFunctionRequest":{ "type":"structure", "required":[ "FunctionName", "FunctionZip", "Runtime", "Role", "Handler", "Mode" ], "members":{ "FunctionName":{ "shape":"FunctionName", "location":"uri", "locationName":"FunctionName", "documentation":"

The name you want to assign to the function you are uploading. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda APIs, such as InvokeAsync.

" }, "FunctionZip":{ "shape":"Blob", "documentation":"

A .zip file containing your packaged source code. For more information about creating a .zip file, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide.

" }, "Runtime":{ "shape":"Runtime", "location":"querystring", "locationName":"Runtime", "documentation":"

The runtime environment for the Lambda function you are uploading. Currently, Lambda supports only \"nodejs\" as the runtime.

" }, "Role":{ "shape":"RoleArn", "location":"querystring", "locationName":"Role", "documentation":"

The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.

" }, "Handler":{ "shape":"Handler", "location":"querystring", "locationName":"Handler", "documentation":"

The function that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function.

" }, "Mode":{ "shape":"Mode", "location":"querystring", "locationName":"Mode", "documentation":"

How the Lambda function will be invoked. Lambda supports only the \"event\" mode.

" }, "Description":{ "shape":"Description", "location":"querystring", "locationName":"Description", "documentation":"

A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.

" }, "Timeout":{ "shape":"Timeout", "location":"querystring", "locationName":"Timeout", "documentation":"

The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

" }, "MemorySize":{ "shape":"MemorySize", "location":"querystring", "locationName":"MemorySize", "documentation":"

The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, database operation might need less memory compared to image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

" } }, "payload":"FunctionZip" }, "Boolean":{"type":"boolean"} } } botocore-1.5.7/botocore/data/lambda/2015-03-31/0000777454262600001440000000000013042511307021403 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore/data/lambda/2015-03-31/paginators-1.json0000666454262600001440000000055513042511306024607 0ustar pysdk-ciamazon00000000000000{ "pagination": { "ListEventSourceMappings": { "input_token": "Marker", "output_token": "NextMarker", "limit_key": "MaxItems", "result_key": "EventSourceMappings" }, "ListFunctions": { "input_token": "Marker", "output_token": "NextMarker", "limit_key": "MaxItems", "result_key": "Functions" } } } botocore-1.5.7/botocore/data/lambda/2015-03-31/service-2.json0000666454262600001440000031567113042511306024111 0ustar pysdk-ciamazon00000000000000{ "version":"2.0", "metadata":{ "apiVersion":"2015-03-31", "endpointPrefix":"lambda", "protocol":"rest-json", "serviceFullName":"AWS Lambda", "signatureVersion":"v4", "uid":"lambda-2015-03-31" }, "operations":{ "AddPermission":{ "name":"AddPermission", "http":{ "method":"POST", "requestUri":"/2015-03-31/functions/{FunctionName}/policy", "responseCode":201 }, "input":{"shape":"AddPermissionRequest"}, "output":{"shape":"AddPermissionResponse"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceConflictException"}, {"shape":"InvalidParameterValueException"}, {"shape":"PolicyLengthExceededException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Adds a permission to the resource policy associated with the specified AWS Lambda function. You use resource policies to grant permissions to event sources that use push model. In a push model, event sources (such as Amazon S3 and custom applications) invoke your Lambda function. Each permission you add to the resource policy allows an event source, permission to invoke the Lambda function.

For information about the push model, see AWS Lambda: How it Works.

If you are using versioning, the permissions you add are specific to the Lambda function version or alias you specify in the AddPermission request via the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:AddPermission action.

" }, "CreateAlias":{ "name":"CreateAlias", "http":{ "method":"POST", "requestUri":"/2015-03-31/functions/{FunctionName}/aliases", "responseCode":201 }, "input":{"shape":"CreateAliasRequest"}, "output":{"shape":"AliasConfiguration"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceConflictException"}, {"shape":"InvalidParameterValueException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Creates an alias that points to the specified Lambda function version. For more information, see Introduction to AWS Lambda Aliases.

Alias names are unique for a given function. This requires permission for the lambda:CreateAlias action.

" }, "CreateEventSourceMapping":{ "name":"CreateEventSourceMapping", "http":{ "method":"POST", "requestUri":"/2015-03-31/event-source-mappings/", "responseCode":202 }, "input":{"shape":"CreateEventSourceMappingRequest"}, "output":{"shape":"EventSourceMappingConfiguration"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ResourceConflictException"}, {"shape":"TooManyRequestsException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.

This association between a stream source and a Lambda function is called the event source mapping.

This event source mapping is relevant only in the AWS Lambda pull model, where AWS Lambda invokes the function. For more information, see AWS Lambda: How it Works in the AWS Lambda Developer Guide.

You provide mapping information (for example, which stream to read from and which Lambda function to invoke) in the request body.

Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda function. A given Lambda function can be associated with multiple AWS event sources.

If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:CreateEventSourceMapping action.

" }, "CreateFunction":{ "name":"CreateFunction", "http":{ "method":"POST", "requestUri":"/2015-03-31/functions", "responseCode":201 }, "input":{"shape":"CreateFunctionRequest"}, "output":{"shape":"FunctionConfiguration"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ResourceConflictException"}, {"shape":"TooManyRequestsException"}, {"shape":"CodeStorageExceededException"} ], "documentation":"

Creates a new Lambda function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the operation will fail. Note that the function name is case-sensitive.

If you are using versioning, you can also publish a version of the Lambda function you are creating using the Publish parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:CreateFunction action.

" }, "DeleteAlias":{ "name":"DeleteAlias", "http":{ "method":"DELETE", "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", "responseCode":204 }, "input":{"shape":"DeleteAliasRequest"}, "errors":[ {"shape":"ServiceException"}, {"shape":"InvalidParameterValueException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Deletes the specified Lambda function alias. For more information, see Introduction to AWS Lambda Aliases.

This requires permission for the lambda:DeleteAlias action.

" }, "DeleteEventSourceMapping":{ "name":"DeleteEventSourceMapping", "http":{ "method":"DELETE", "requestUri":"/2015-03-31/event-source-mappings/{UUID}", "responseCode":202 }, "input":{"shape":"DeleteEventSourceMappingRequest"}, "output":{"shape":"EventSourceMappingConfiguration"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.

This operation requires permission for the lambda:DeleteEventSourceMapping action.

" }, "DeleteFunction":{ "name":"DeleteFunction", "http":{ "method":"DELETE", "requestUri":"/2015-03-31/functions/{FunctionName}", "responseCode":204 }, "input":{"shape":"DeleteFunctionRequest"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"InvalidParameterValueException"}, {"shape":"ResourceConflictException"} ], "documentation":"

Deletes the specified Lambda function code and configuration.

If you are using the versioning feature and you don't specify a function version in your DeleteFunction request, AWS Lambda will delete the function, including all its versions, and any aliases pointing to the function versions. To delete a specific function version, you must provide the function version via the Qualifier parameter. For information about function versioning, see AWS Lambda Function Versioning and Aliases.

When you delete a function the associated resource policy is also deleted. You will need to delete the event source mappings explicitly.

This operation requires permission for the lambda:DeleteFunction action.

" }, "GetAccountSettings":{ "name":"GetAccountSettings", "http":{ "method":"GET", "requestUri":"/2016-08-19/account-settings/", "responseCode":200 }, "input":{"shape":"GetAccountSettingsRequest"}, "output":{"shape":"GetAccountSettingsResponse"}, "errors":[ {"shape":"TooManyRequestsException"}, {"shape":"ServiceException"} ], "documentation":"

Returns a customer's account settings.

You can use this operation to retrieve Lambda limits information, such as code size and concurrency limits. For more information about limits, see AWS Lambda Limits. You can also retrieve resource usage statistics, such as code storage usage and function count.

" }, "GetAlias":{ "name":"GetAlias", "http":{ "method":"GET", "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", "responseCode":200 }, "input":{"shape":"GetAliasRequest"}, "output":{"shape":"AliasConfiguration"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Returns the specified alias information such as the alias ARN, description, and function version it is pointing to. For more information, see Introduction to AWS Lambda Aliases.

This requires permission for the lambda:GetAlias action.

" }, "GetEventSourceMapping":{ "name":"GetEventSourceMapping", "http":{ "method":"GET", "requestUri":"/2015-03-31/event-source-mappings/{UUID}", "responseCode":200 }, "input":{"shape":"GetEventSourceMappingRequest"}, "output":{"shape":"EventSourceMappingConfiguration"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Returns configuration information for the specified event source mapping (see CreateEventSourceMapping).

This operation requires permission for the lambda:GetEventSourceMapping action.

" }, "GetFunction":{ "name":"GetFunction", "http":{ "method":"GET", "requestUri":"/2015-03-31/functions/{FunctionName}", "responseCode":200 }, "input":{"shape":"GetFunctionRequest"}, "output":{"shape":"GetFunctionResponse"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"InvalidParameterValueException"} ], "documentation":"

Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with CreateFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.

Using the optional Qualifier parameter, you can specify a specific function version for which you want this information. If you don't specify this parameter, the API uses unqualified function ARN which return information about the $LATEST version of the Lambda function. For more information, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:GetFunction action.

" }, "GetFunctionConfiguration":{ "name":"GetFunctionConfiguration", "http":{ "method":"GET", "requestUri":"/2015-03-31/functions/{FunctionName}/configuration", "responseCode":200 }, "input":{"shape":"GetFunctionConfigurationRequest"}, "output":{"shape":"FunctionConfiguration"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"InvalidParameterValueException"} ], "documentation":"

Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using CreateFunction.

If you are using the versioning feature, you can retrieve this information for a specific function version by using the optional Qualifier parameter and specifying the function version or alias that points to it. If you don't provide it, the API returns information about the $LATEST version of the function. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:GetFunctionConfiguration operation.

" }, "GetPolicy":{ "name":"GetPolicy", "http":{ "method":"GET", "requestUri":"/2015-03-31/functions/{FunctionName}/policy", "responseCode":200 }, "input":{"shape":"GetPolicyRequest"}, "output":{"shape":"GetPolicyResponse"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"TooManyRequestsException"}, {"shape":"InvalidParameterValueException"} ], "documentation":"

Returns the resource policy associated with the specified Lambda function.

If you are using the versioning feature, you can get the resource policy associated with the specific Lambda function version or alias by specifying the version or alias name using the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

For information about adding permissions, see AddPermission.

You need permission for the lambda:GetPolicy action.

" }, "Invoke":{ "name":"Invoke", "http":{ "method":"POST", "requestUri":"/2015-03-31/functions/{FunctionName}/invocations" }, "input":{"shape":"InvocationRequest"}, "output":{"shape":"InvocationResponse"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidRequestContentException"}, {"shape":"RequestTooLargeException"}, {"shape":"UnsupportedMediaTypeException"}, {"shape":"TooManyRequestsException"}, {"shape":"InvalidParameterValueException"}, {"shape":"EC2UnexpectedException"}, {"shape":"SubnetIPAddressLimitReachedException"}, {"shape":"ENILimitReachedException"}, {"shape":"EC2ThrottledException"}, {"shape":"EC2AccessDeniedException"}, {"shape":"InvalidSubnetIDException"}, {"shape":"InvalidSecurityGroupIDException"}, {"shape":"InvalidZipFileException"}, {"shape":"KMSDisabledException"}, {"shape":"KMSInvalidStateException"}, {"shape":"KMSAccessDeniedException"}, {"shape":"KMSNotFoundException"} ], "documentation":"

Invokes a specific Lambda function. For an example, see Create the Lambda Function and Test It Manually.

If you are using the versioning feature, you can invoke the specific function version by providing function version or alias name that is pointing to the function version using the Qualifier parameter in the request. If you don't provide the Qualifier parameter, the $LATEST version of the Lambda function is invoked. Invocations occur at least once in response to an event and functions must be idempotent to handle this. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:InvokeFunction action.

" }, "InvokeAsync":{ "name":"InvokeAsync", "http":{ "method":"POST", "requestUri":"/2014-11-13/functions/{FunctionName}/invoke-async/", "responseCode":202 }, "input":{"shape":"InvokeAsyncRequest"}, "output":{"shape":"InvokeAsyncResponse"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidRequestContentException"} ], "documentation":"

This API is deprecated. We recommend you use Invoke API (see Invoke).

Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch Logs console.

This operation requires permission for the lambda:InvokeFunction action.

", "deprecated":true }, "ListAliases":{ "name":"ListAliases", "http":{ "method":"GET", "requestUri":"/2015-03-31/functions/{FunctionName}/aliases", "responseCode":200 }, "input":{"shape":"ListAliasesRequest"}, "output":{"shape":"ListAliasesResponse"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Returns list of aliases created for a Lambda function. For each alias, the response includes information such as the alias ARN, description, alias name, and the function version to which it points. For more information, see Introduction to AWS Lambda Aliases.

This requires permission for the lambda:ListAliases action.

" }, "ListEventSourceMappings":{ "name":"ListEventSourceMappings", "http":{ "method":"GET", "requestUri":"/2015-03-31/event-source-mappings/", "responseCode":200 }, "input":{"shape":"ListEventSourceMappingsRequest"}, "output":{"shape":"ListEventSourceMappingsResponse"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Returns a list of event source mappings you created using the CreateEventSourceMapping (see CreateEventSourceMapping).

For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.

If you are using the versioning feature, you can get list of event source mappings for a specific Lambda function version or an alias as described in the FunctionName parameter. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:ListEventSourceMappings action.

" }, "ListFunctions":{ "name":"ListFunctions", "http":{ "method":"GET", "requestUri":"/2015-03-31/functions/", "responseCode":200 }, "input":{"shape":"ListFunctionsRequest"}, "output":{"shape":"ListFunctionsResponse"}, "errors":[ {"shape":"ServiceException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.

This operation requires permission for the lambda:ListFunctions action.

If you are using versioning feature, the response returns list of $LATEST versions of your functions. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

" }, "ListVersionsByFunction":{ "name":"ListVersionsByFunction", "http":{ "method":"GET", "requestUri":"/2015-03-31/functions/{FunctionName}/versions", "responseCode":200 }, "input":{"shape":"ListVersionsByFunctionRequest"}, "output":{"shape":"ListVersionsByFunctionResponse"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

List all versions of a function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

" }, "PublishVersion":{ "name":"PublishVersion", "http":{ "method":"POST", "requestUri":"/2015-03-31/functions/{FunctionName}/versions", "responseCode":201 }, "input":{"shape":"PublishVersionRequest"}, "output":{"shape":"FunctionConfiguration"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"TooManyRequestsException"}, {"shape":"CodeStorageExceededException"} ], "documentation":"

Publishes a version of your function from the current snapshot of $LATEST. That is, AWS Lambda takes a snapshot of the function code and configuration information from $LATEST and publishes a new version. The code and configuration cannot be modified after publication. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

" }, "RemovePermission":{ "name":"RemovePermission", "http":{ "method":"DELETE", "requestUri":"/2015-03-31/functions/{FunctionName}/policy/{StatementId}", "responseCode":204 }, "input":{"shape":"RemovePermissionRequest"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

You can remove individual permissions from an resource policy associated with a Lambda function by providing a statement ID that you provided when you added the permission.

If you are using versioning, the permissions you remove are specific to the Lambda function version or alias you specify in the AddPermission request via the Qualifier parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

Note that removal of a permission will cause an active event source to lose permission to the function.

You need permission for the lambda:RemovePermission action.

" }, "UpdateAlias":{ "name":"UpdateAlias", "http":{ "method":"PUT", "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", "responseCode":200 }, "input":{"shape":"UpdateAliasRequest"}, "output":{"shape":"AliasConfiguration"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Using this API you can update the function version to which the alias points and the alias description. For more information, see Introduction to AWS Lambda Aliases.

This requires permission for the lambda:UpdateAlias action.

" }, "UpdateEventSourceMapping":{ "name":"UpdateEventSourceMapping", "http":{ "method":"PUT", "requestUri":"/2015-03-31/event-source-mappings/{UUID}", "responseCode":202 }, "input":{"shape":"UpdateEventSourceMappingRequest"}, "output":{"shape":"EventSourceMappingConfiguration"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"TooManyRequestsException"}, {"shape":"ResourceConflictException"} ], "documentation":"

You can update an event source mapping. This is useful if you want to change the parameters of the existing mapping without losing your position in the stream. You can change which function will receive the stream records, but to change the stream itself, you must create a new mapping.

If you are using the versioning feature, you can update the event source mapping to map to a specific Lambda function version or alias as described in the FunctionName parameter. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

If you disable the event source mapping, AWS Lambda stops polling. If you enable again, it will resume polling from the time it had stopped polling, so you don't lose processing of any records. However, if you delete event source mapping and create it again, it will reset.

This operation requires permission for the lambda:UpdateEventSourceMapping action.

" }, "UpdateFunctionCode":{ "name":"UpdateFunctionCode", "http":{ "method":"PUT", "requestUri":"/2015-03-31/functions/{FunctionName}/code", "responseCode":200 }, "input":{"shape":"UpdateFunctionCodeRequest"}, "output":{"shape":"FunctionConfiguration"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"TooManyRequestsException"}, {"shape":"CodeStorageExceededException"} ], "documentation":"

Updates the code for the specified Lambda function. This operation must only be used on an existing Lambda function and cannot be used to update the function configuration.

If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:UpdateFunctionCode action.

" }, "UpdateFunctionConfiguration":{ "name":"UpdateFunctionConfiguration", "http":{ "method":"PUT", "requestUri":"/2015-03-31/functions/{FunctionName}/configuration", "responseCode":200 }, "input":{"shape":"UpdateFunctionConfigurationRequest"}, "output":{"shape":"FunctionConfiguration"}, "errors":[ {"shape":"ServiceException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterValueException"}, {"shape":"TooManyRequestsException"} ], "documentation":"

Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.

If you are using the versioning feature, note this API will always update the $LATEST version of your Lambda function. For information about the versioning feature, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the lambda:UpdateFunctionConfiguration action.

" } }, "shapes":{ "AccountLimit":{ "type":"structure", "members":{ "TotalCodeSize":{ "shape":"Long", "documentation":"

Maximum size, in megabytes, of a code package you can upload per region. The default size is 75 GB.

" }, "CodeSizeUnzipped":{ "shape":"Long", "documentation":"

Size, in bytes, of code/dependencies that you can zip into a deployment package (uncompressed zip/jar size) for uploading. The default limit is 250 MB.

" }, "CodeSizeZipped":{ "shape":"Long", "documentation":"

Size, in bytes, of a single zipped code/dependencies package you can upload for your Lambda function(.zip/.jar file). Try using Amazon S3 for uploading larger files. Default limit is 50 MB.

" }, "ConcurrentExecutions":{ "shape":"Integer", "documentation":"

Number of simultaneous executions of your function per region. For more information or to request a limit increase for concurrent executions, see Lambda Function Concurrent Executions. The default limit is 100.

" } }, "documentation":"

Provides limits of code size and concurrency associated with the current account and region.

" }, "AccountUsage":{ "type":"structure", "members":{ "TotalCodeSize":{ "shape":"Long", "documentation":"

Total size, in bytes, of the account's deployment packages per region.

" }, "FunctionCount":{ "shape":"Long", "documentation":"

The number of your account's existing functions per region.

" } }, "documentation":"

Provides code size usage and function count associated with the current account and region.

" }, "Action":{ "type":"string", "pattern":"(lambda:[*]|lambda:[a-zA-Z]+|[*])" }, "AddPermissionRequest":{ "type":"structure", "required":[ "FunctionName", "StatementId", "Action", "Principal" ], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

Name of the Lambda function whose resource policy you are updating by adding a new permission.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "location":"uri", "locationName":"FunctionName" }, "StatementId":{ "shape":"StatementId", "documentation":"

A unique statement identifier.

" }, "Action":{ "shape":"Action", "documentation":"

The AWS Lambda action you want to allow in this statement. Each Lambda action is a string starting with lambda: followed by the API name . For example, lambda:CreateFunction. You can use wildcard (lambda:*) to grant permission for all AWS Lambda actions.

" }, "Principal":{ "shape":"Principal", "documentation":"

The principal who is getting this permission. It can be Amazon S3 service Principal (s3.amazonaws.com) if you want Amazon S3 to invoke the function, an AWS account ID if you are granting cross-account permission, or any valid AWS service principal such as sns.amazonaws.com. For example, you might want to allow a custom application in another AWS account to push events to AWS Lambda by invoking your function.

" }, "SourceArn":{ "shape":"Arn", "documentation":"

This is optional; however, when granting Amazon S3 permission to invoke your function, you should specify this field with the Amazon Resource Name (ARN) as its value. This ensures that only events generated from the specified source can invoke the function.

If you add a permission for the Amazon S3 principal without providing the source ARN, any AWS account that creates a mapping to your function ARN can send events to invoke your Lambda function from Amazon S3.

" }, "SourceAccount":{ "shape":"SourceOwner", "documentation":"

This parameter is used for S3, SES, CloudWatch Logs and CloudWatch Rules only. The AWS account ID (without a hyphen) of the source owner. For example, if the SourceArn identifies a bucket, then this is the bucket owner's account ID. You can use this additional condition to ensure the bucket you specify is owned by a specific account (it is possible the bucket owner deleted the bucket and some other AWS account created the bucket). You can also use this condition to specify all sources (that is, you don't specify the SourceArn) owned by a specific account.

" }, "EventSourceToken":{ "shape":"EventSourceToken", "documentation":"

A unique token that must be supplied by the principal invoking the function. This is currently only used for Alexa Smart Home functions.

" }, "Qualifier":{ "shape":"Qualifier", "documentation":"

You can use this optional query parameter to describe a qualified ARN using a function version or an alias name. The permission will then apply to the specific qualified ARN. For example, if you specify function version 2 as the qualifier, then permission applies only when request is made using qualified function ARN:

arn:aws:lambda:aws-region:acct-id:function:function-name:2

If you specify an alias name, for example PROD, then the permission is valid only for requests made using the alias ARN:

arn:aws:lambda:aws-region:acct-id:function:function-name:PROD

If the qualifier is not specified, the permission is valid only when requests is made using unqualified function ARN.

arn:aws:lambda:aws-region:acct-id:function:function-name

", "location":"querystring", "locationName":"Qualifier" } }, "documentation":"

" }, "AddPermissionResponse":{ "type":"structure", "members":{ "Statement":{ "shape":"String", "documentation":"

The permission statement you specified in the request. The response returns the same as a string using a backslash (\"\\\") as an escape character in the JSON.

" } }, "documentation":"

" }, "Alias":{ "type":"string", "max":128, "min":1, "pattern":"(?!^[0-9]+$)([a-zA-Z0-9-_]+)" }, "AliasConfiguration":{ "type":"structure", "members":{ "AliasArn":{ "shape":"FunctionArn", "documentation":"

Lambda function ARN that is qualified using the alias name as the suffix. For example, if you create an alias called BETA that points to a helloworld function version, the ARN is arn:aws:lambda:aws-regions:acct-id:function:helloworld:BETA.

" }, "Name":{ "shape":"Alias", "documentation":"

Alias name.

" }, "FunctionVersion":{ "shape":"Version", "documentation":"

Function version to which the alias points.

" }, "Description":{ "shape":"Description", "documentation":"

Alias description.

" } }, "documentation":"

Provides configuration information about a Lambda function version alias.

" }, "AliasList":{ "type":"list", "member":{"shape":"AliasConfiguration"} }, "Arn":{ "type":"string", "pattern":"arn:aws:([a-zA-Z0-9\\-])+:([a-z]{2}-[a-z]+-\\d{1})?:(\\d{12})?:(.*)" }, "BatchSize":{ "type":"integer", "max":10000, "min":1 }, "Blob":{ "type":"blob", "sensitive":true }, "BlobStream":{ "type":"blob", "streaming":true }, "Boolean":{"type":"boolean"}, "CodeStorageExceededException":{ "type":"structure", "members":{ "Type":{ "shape":"String", "documentation":"

" }, "message":{"shape":"String"} }, "documentation":"

You have exceeded your maximum total code size per account. Limits

", "error":{"httpStatusCode":400}, "exception":true }, "CreateAliasRequest":{ "type":"structure", "required":[ "FunctionName", "Name", "FunctionVersion" ], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

Name of the Lambda function for which you want to create an alias.

", "location":"uri", "locationName":"FunctionName" }, "Name":{ "shape":"Alias", "documentation":"

Name for the alias you are creating.

" }, "FunctionVersion":{ "shape":"Version", "documentation":"

Lambda function version for which you are creating the alias.

" }, "Description":{ "shape":"Description", "documentation":"

Description of the alias.

" } } }, "CreateEventSourceMappingRequest":{ "type":"structure", "required":[ "EventSourceArn", "FunctionName", "StartingPosition" ], "members":{ "EventSourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source. Any record added to this stream could cause AWS Lambda to invoke your Lambda function, it depends on the BatchSize. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.

" }, "FunctionName":{ "shape":"FunctionName", "documentation":"

The Lambda function to invoke when AWS Lambda detects an event on the stream.

You can specify the function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail).

If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases

AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, account-id:Thumbnail).

Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

" }, "Enabled":{ "shape":"Enabled", "documentation":"

Indicates whether AWS Lambda should begin polling the event source. By default, Enabled is true.

" }, "BatchSize":{ "shape":"BatchSize", "documentation":"

The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default is 100 records.

" }, "StartingPosition":{ "shape":"EventSourcePosition", "documentation":"

The position in the stream where AWS Lambda should start reading. Valid only for Kinesis streams. For more information, see ShardIteratorType in the Amazon Kinesis API Reference.

" }, "StartingPositionTimestamp":{ "shape":"Date", "documentation":"

The timestamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. If a record with this exact timestamp does not exist, the iterator returned is for the next (later) record. If the timestamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON). Valid only for Kinesis streams.

" } }, "documentation":"

" }, "CreateFunctionRequest":{ "type":"structure", "required":[ "FunctionName", "Runtime", "Role", "Handler", "Code" ], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

The name you want to assign to the function you are uploading. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda API operations, such as Invoke.

" }, "Runtime":{ "shape":"Runtime", "documentation":"

The runtime environment for the Lambda function you are uploading.

To use the Node.js runtime v4.3, set the value to \"nodejs4.3\". To use earlier runtime (v0.10.42), set the value to \"nodejs\".

You can no longer create functions using the v0.10.42 runtime version as of November, 2016. Existing functions will be supported until early 2017, but we recommend you migrate them to nodejs4.3 runtime version as soon as possible.

" }, "Role":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources. For more information, see AWS Lambda: How it Works.

" }, "Handler":{ "shape":"Handler", "documentation":"

The function within your code that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function. For Java, it can be package.class-name::handler or package.class-name. For more information, see Lambda Function Handler (Java).

" }, "Code":{ "shape":"FunctionCode", "documentation":"

The code for the Lambda function.

" }, "Description":{ "shape":"Description", "documentation":"

A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.

" }, "Timeout":{ "shape":"Timeout", "documentation":"

The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

" }, "MemorySize":{ "shape":"MemorySize", "documentation":"

The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU and memory allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

" }, "Publish":{ "shape":"Boolean", "documentation":"

This boolean parameter can be used to request AWS Lambda to create the Lambda function and publish a version as an atomic operation.

" }, "VpcConfig":{ "shape":"VpcConfig", "documentation":"

If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

" }, "DeadLetterConfig":{ "shape":"DeadLetterConfig", "documentation":"

The parent object that contains the target Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

" }, "Environment":{"shape":"Environment"}, "KMSKeyArn":{ "shape":"KMSKeyArn", "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If not provided, AWS Lambda will use a default service key.

" } }, "documentation":"

" }, "Date":{"type":"timestamp"}, "DeadLetterConfig":{ "type":"structure", "members":{ "TargetArn":{ "shape":"ResourceArn", "documentation":"

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic you specify as your Dead Letter Queue (DLQ).

" } }, "documentation":"

The parent object that contains the target Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

" }, "DeleteAliasRequest":{ "type":"structure", "required":[ "FunctionName", "Name" ], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

The Lambda function name for which the alias is created. Deleting an alias does not delete the function version to which it is pointing.

", "location":"uri", "locationName":"FunctionName" }, "Name":{ "shape":"Alias", "documentation":"

Name of the alias to delete.

", "location":"uri", "locationName":"Name" } } }, "DeleteEventSourceMappingRequest":{ "type":"structure", "required":["UUID"], "members":{ "UUID":{ "shape":"String", "documentation":"

The event source mapping ID.

", "location":"uri", "locationName":"UUID" } }, "documentation":"

" }, "DeleteFunctionRequest":{ "type":"structure", "required":["FunctionName"], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

The Lambda function to delete.

You can specify the function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "location":"uri", "locationName":"FunctionName" }, "Qualifier":{ "shape":"Qualifier", "documentation":"

Using this optional parameter you can specify a function version (but not the $LATEST version) to direct AWS Lambda to delete a specific function version. If the function version has one or more aliases pointing to it, you will get an error because you cannot have aliases pointing to it. You can delete any function version but not the $LATEST, that is, you cannot specify $LATEST as the value of this parameter. The $LATEST version can be deleted only when you want to delete all the function versions and aliases.

You can only specify a function version, not an alias name, using this parameter. You cannot delete a function version using its alias.

If you don't specify this parameter, AWS Lambda will delete the function, including all of its versions and aliases.

", "location":"querystring", "locationName":"Qualifier" } } }, "Description":{ "type":"string", "max":256, "min":0 }, "EC2AccessDeniedException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "Message":{"shape":"String"} }, "documentation":"

", "error":{"httpStatusCode":502}, "exception":true }, "EC2ThrottledException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "Message":{"shape":"String"} }, "documentation":"

AWS Lambda was throttled by Amazon EC2 during Lambda function initialization using the execution role provided for the Lambda function.

", "error":{"httpStatusCode":502}, "exception":true }, "EC2UnexpectedException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "Message":{"shape":"String"}, "EC2ErrorCode":{"shape":"String"} }, "documentation":"

AWS Lambda received an unexpected EC2 client exception while setting up for the Lambda function.

", "error":{"httpStatusCode":502}, "exception":true }, "ENILimitReachedException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "Message":{"shape":"String"} }, "documentation":"

AWS Lambda was not able to create an Elastic Network Interface (ENI) in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached.

", "error":{"httpStatusCode":502}, "exception":true }, "Enabled":{"type":"boolean"}, "Environment":{ "type":"structure", "members":{ "Variables":{ "shape":"EnvironmentVariables", "documentation":"

The key-value pairs that represent your environment's configuration settings. The value you specify cannot contain a \",\".

" } }, "documentation":"

The parent object that contains your environment's configuration settings.

" }, "EnvironmentError":{ "type":"structure", "members":{ "ErrorCode":{ "shape":"String", "documentation":"

The error code returned by the environment error object.

" }, "Message":{ "shape":"SensitiveString", "documentation":"

The message returned by the environment error object.

" } }, "documentation":"

The parent object that contains error information associated with your configuration settings.

" }, "EnvironmentResponse":{ "type":"structure", "members":{ "Variables":{ "shape":"EnvironmentVariables", "documentation":"

The key-value pairs returned that represent your environment's configuration settings or error information.

" }, "Error":{"shape":"EnvironmentError"} }, "documentation":"

The parent object returned that contains your environment's configuration settings or any error information associated with your configuration settings.

" }, "EnvironmentVariableName":{ "type":"string", "pattern":"[a-zA-Z]([a-zA-Z0-9_])+", "sensitive":true }, "EnvironmentVariableValue":{ "type":"string", "pattern":"[^,]*", "sensitive":true }, "EnvironmentVariables":{ "type":"map", "key":{"shape":"EnvironmentVariableName"}, "value":{"shape":"EnvironmentVariableValue"}, "sensitive":true }, "EventSourceMappingConfiguration":{ "type":"structure", "members":{ "UUID":{ "shape":"String", "documentation":"

The AWS Lambda assigned opaque identifier for the mapping.

" }, "BatchSize":{ "shape":"BatchSize", "documentation":"

The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.

" }, "EventSourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.

" }, "FunctionArn":{ "shape":"FunctionArn", "documentation":"

The Lambda function to invoke when AWS Lambda detects an event on the stream.

" }, "LastModified":{ "shape":"Date", "documentation":"

The UTC time string indicating the last time the event mapping was updated.

" }, "LastProcessingResult":{ "shape":"String", "documentation":"

The result of the last AWS Lambda invocation of your Lambda function.

" }, "State":{ "shape":"String", "documentation":"

The state of the event source mapping. It can be Creating, Enabled, Disabled, Enabling, Disabling, Updating, or Deleting.

" }, "StateTransitionReason":{ "shape":"String", "documentation":"

The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.

" } }, "documentation":"

Describes mapping between an Amazon Kinesis stream and a Lambda function.

" }, "EventSourceMappingsList":{ "type":"list", "member":{"shape":"EventSourceMappingConfiguration"} }, "EventSourcePosition":{ "type":"string", "enum":[ "TRIM_HORIZON", "LATEST", "AT_TIMESTAMP" ] }, "EventSourceToken":{ "type":"string", "max":256, "min":0, "pattern":"[a-zA-Z0-9._\\-]+" }, "FunctionArn":{ "type":"string", "pattern":"arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?" }, "FunctionCode":{ "type":"structure", "members":{ "ZipFile":{ "shape":"Blob", "documentation":"

The contents of your zip file containing your deployment package. If you are using the web API directly, the contents of the zip file must be base64-encoded. If you are using the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for you. For more information about creating a .zip file, see Execution Permissions in the AWS Lambda Developer Guide.

" }, "S3Bucket":{ "shape":"S3Bucket", "documentation":"

Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS region where you are creating the Lambda function.

" }, "S3Key":{ "shape":"S3Key", "documentation":"

The Amazon S3 object (the deployment package) key name you want to upload.

" }, "S3ObjectVersion":{ "shape":"S3ObjectVersion", "documentation":"

The Amazon S3 object (the deployment package) version you want to upload.

" } }, "documentation":"

The code for the Lambda function.

" }, "FunctionCodeLocation":{ "type":"structure", "members":{ "RepositoryType":{ "shape":"String", "documentation":"

The repository from which you can download the function.

" }, "Location":{ "shape":"String", "documentation":"

The presigned URL you can use to download the function's .zip file that you previously uploaded. The URL is valid for up to 10 minutes.

" } }, "documentation":"

The object for the Lambda function location.

" }, "FunctionConfiguration":{ "type":"structure", "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

The name of the function.

" }, "FunctionArn":{ "shape":"FunctionArn", "documentation":"

The Amazon Resource Name (ARN) assigned to the function.

" }, "Runtime":{ "shape":"Runtime", "documentation":"

The runtime environment for the Lambda function.

To use the Node.js runtime v4.3, set the value to \"nodejs4.3\". To use earlier runtime (v0.10.42), set the value to \"nodejs\".

" }, "Role":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.

" }, "Handler":{ "shape":"Handler", "documentation":"

The function Lambda calls to begin executing your function.

" }, "CodeSize":{ "shape":"Long", "documentation":"

The size, in bytes, of the function .zip file you uploaded.

" }, "Description":{ "shape":"Description", "documentation":"

The user-provided description.

" }, "Timeout":{ "shape":"Timeout", "documentation":"

The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

" }, "MemorySize":{ "shape":"MemorySize", "documentation":"

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

" }, "LastModified":{ "shape":"Timestamp", "documentation":"

The time stamp of the last time you updated the function.

" }, "CodeSha256":{ "shape":"String", "documentation":"

It is the SHA256 hash of your function deployment package.

" }, "Version":{ "shape":"Version", "documentation":"

The version of the Lambda function.

" }, "VpcConfig":{ "shape":"VpcConfigResponse", "documentation":"

VPC configuration associated with your Lambda function.

" }, "DeadLetterConfig":{ "shape":"DeadLetterConfig", "documentation":"

The parent object that contains the target Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

" }, "Environment":{ "shape":"EnvironmentResponse", "documentation":"

The parent object that contains your environment's configuration settings.

" }, "KMSKeyArn":{ "shape":"KMSKeyArn", "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If empty, it means you are using the AWS Lambda default service key.

" } }, "documentation":"

A complex type that describes function metadata.

" }, "FunctionList":{ "type":"list", "member":{"shape":"FunctionConfiguration"} }, "FunctionName":{ "type":"string", "max":140, "min":1, "pattern":"(arn:aws:lambda:)?([a-z]{2}-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" }, "GetAccountSettingsRequest":{ "type":"structure", "members":{ } }, "GetAccountSettingsResponse":{ "type":"structure", "members":{ "AccountLimit":{"shape":"AccountLimit"}, "AccountUsage":{"shape":"AccountUsage"} } }, "GetAliasRequest":{ "type":"structure", "required":[ "FunctionName", "Name" ], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

Function name for which the alias is created. An alias is a subresource that exists only in the context of an existing Lambda function so you must specify the function name.

", "location":"uri", "locationName":"FunctionName" }, "Name":{ "shape":"Alias", "documentation":"

Name of the alias for which you want to retrieve information.

", "location":"uri", "locationName":"Name" } } }, "GetEventSourceMappingRequest":{ "type":"structure", "required":["UUID"], "members":{ "UUID":{ "shape":"String", "documentation":"

The AWS Lambda assigned ID of the event source mapping.

", "location":"uri", "locationName":"UUID" } }, "documentation":"

" }, "GetFunctionConfigurationRequest":{ "type":"structure", "required":["FunctionName"], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

The name of the Lambda function for which you want to retrieve the configuration information.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "location":"uri", "locationName":"FunctionName" }, "Qualifier":{ "shape":"Qualifier", "documentation":"

Using this optional parameter you can specify a function version or an alias name. If you specify function version, the API uses qualified function ARN and returns information about the specific function version. If you specify an alias name, the API uses the alias ARN and returns information about the function version to which the alias points.

If you don't specify this parameter, the API uses unqualified function ARN, and returns information about the $LATEST function version.

", "location":"querystring", "locationName":"Qualifier" } }, "documentation":"

" }, "GetFunctionRequest":{ "type":"structure", "required":["FunctionName"], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

The Lambda function name.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "location":"uri", "locationName":"FunctionName" }, "Qualifier":{ "shape":"Qualifier", "documentation":"

Using this optional parameter to specify a function version or an alias name. If you specify function version, the API uses qualified function ARN for the request and returns information about the specific Lambda function version. If you specify an alias name, the API uses the alias ARN and returns information about the function version to which the alias points. If you don't provide this parameter, the API uses unqualified function ARN and returns information about the $LATEST version of the Lambda function.

", "location":"querystring", "locationName":"Qualifier" } }, "documentation":"

" }, "GetFunctionResponse":{ "type":"structure", "members":{ "Configuration":{"shape":"FunctionConfiguration"}, "Code":{"shape":"FunctionCodeLocation"} }, "documentation":"

This response contains the object for the Lambda function location (see FunctionCodeLocation.

" }, "GetPolicyRequest":{ "type":"structure", "required":["FunctionName"], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

Function name whose resource policy you want to retrieve.

You can specify the function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "location":"uri", "locationName":"FunctionName" }, "Qualifier":{ "shape":"Qualifier", "documentation":"

You can specify this optional query parameter to specify a function version or an alias name in which case this API will return all permissions associated with the specific qualified ARN. If you don't provide this parameter, the API will return permissions that apply to the unqualified function ARN.

", "location":"querystring", "locationName":"Qualifier" } }, "documentation":"

" }, "GetPolicyResponse":{ "type":"structure", "members":{ "Policy":{ "shape":"String", "documentation":"

The resource policy associated with the specified function. The response returns the same as a string using a backslash (\"\\\") as an escape character in the JSON.

" } }, "documentation":"

" }, "Handler":{ "type":"string", "max":128, "pattern":"[^\\s]+" }, "HttpStatus":{"type":"integer"}, "Integer":{"type":"integer"}, "InvalidParameterValueException":{ "type":"structure", "members":{ "Type":{ "shape":"String", "documentation":"

" }, "message":{ "shape":"String", "documentation":"

" } }, "documentation":"

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidRequestContentException":{ "type":"structure", "members":{ "Type":{ "shape":"String", "documentation":"

" }, "message":{ "shape":"String", "documentation":"

" } }, "documentation":"

The request body could not be parsed as JSON.

", "error":{"httpStatusCode":400}, "exception":true }, "InvalidSecurityGroupIDException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "Message":{"shape":"String"} }, "documentation":"

The Security Group ID provided in the Lambda function VPC configuration is invalid.

", "error":{"httpStatusCode":502}, "exception":true }, "InvalidSubnetIDException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "Message":{"shape":"String"} }, "documentation":"

The Subnet ID provided in the Lambda function VPC configuration is invalid.

", "error":{"httpStatusCode":502}, "exception":true }, "InvalidZipFileException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "Message":{"shape":"String"} }, "documentation":"

AWS Lambda could not unzip the function zip file.

", "error":{"httpStatusCode":502}, "exception":true }, "InvocationRequest":{ "type":"structure", "required":["FunctionName"], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

The Lambda function name.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "location":"uri", "locationName":"FunctionName" }, "InvocationType":{ "shape":"InvocationType", "documentation":"

By default, the Invoke API assumes RequestResponse invocation type. You can optionally request asynchronous execution by specifying Event as the InvocationType. You can also use this parameter to request AWS Lambda to not execute the function but do some verification, such as if the caller is authorized to invoke the function and if the inputs are valid. You request this by specifying DryRun as the InvocationType. This is useful in a cross-account scenario when you want to verify access to a function without running it.

", "location":"header", "locationName":"X-Amz-Invocation-Type" }, "LogType":{ "shape":"LogType", "documentation":"

You can set this optional parameter to Tail in the request only if you specify the InvocationType parameter with value RequestResponse. In this case, AWS Lambda returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result header.

", "location":"header", "locationName":"X-Amz-Log-Type" }, "ClientContext":{ "shape":"String", "documentation":"

Using the ClientContext you can pass client-specific information to the Lambda function you are invoking. You can then process the client information in your Lambda function as you choose through the context variable. For an example of a ClientContext JSON, see PutEvents in the Amazon Mobile Analytics API Reference and User Guide.

The ClientContext JSON must be base64-encoded.

", "location":"header", "locationName":"X-Amz-Client-Context" }, "Payload":{ "shape":"Blob", "documentation":"

JSON that you want to provide to your Lambda function as input.

" }, "Qualifier":{ "shape":"Qualifier", "documentation":"

You can use this optional parameter to specify a Lambda function version or alias name. If you specify a function version, the API uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the API uses the alias ARN to invoke the Lambda function version to which the alias points.

If you don't provide this parameter, then the API uses unqualified function ARN which results in invocation of the $LATEST version.

", "location":"querystring", "locationName":"Qualifier" } }, "documentation":"

", "payload":"Payload" }, "InvocationResponse":{ "type":"structure", "members":{ "StatusCode":{ "shape":"Integer", "documentation":"

The HTTP status code will be in the 200 range for successful request. For the RequestResonse invocation type this status code will be 200. For the Event invocation type this status code will be 202. For the DryRun invocation type the status code will be 204.

", "location":"statusCode" }, "FunctionError":{ "shape":"String", "documentation":"

Indicates whether an error occurred while executing the Lambda function. If an error occurred this field will have one of two values; Handled or Unhandled. Handled errors are errors that are reported by the function while the Unhandled errors are those detected and reported by AWS Lambda. Unhandled errors include out of memory errors and function timeouts. For information about how to report an Handled error, see Programming Model.

", "location":"header", "locationName":"X-Amz-Function-Error" }, "LogResult":{ "shape":"String", "documentation":"

It is the base64-encoded logs for the Lambda function invocation. This is present only if the invocation type is RequestResponse and the logs were requested.

", "location":"header", "locationName":"X-Amz-Log-Result" }, "Payload":{ "shape":"Blob", "documentation":"

It is the JSON representation of the object returned by the Lambda function. This is present only if the invocation type is RequestResponse.

In the event of a function error this field contains a message describing the error. For the Handled errors the Lambda function will report this message. For Unhandled errors AWS Lambda reports the message.

" } }, "documentation":"

Upon success, returns an empty response. Otherwise, throws an exception.

", "payload":"Payload" }, "InvocationType":{ "type":"string", "enum":[ "Event", "RequestResponse", "DryRun" ] }, "InvokeAsyncRequest":{ "type":"structure", "required":[ "FunctionName", "InvokeArgs" ], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

The Lambda function name.

", "location":"uri", "locationName":"FunctionName" }, "InvokeArgs":{ "shape":"BlobStream", "documentation":"

JSON that you want to provide to your Lambda function as input.

" } }, "documentation":"

", "deprecated":true, "payload":"InvokeArgs" }, "InvokeAsyncResponse":{ "type":"structure", "members":{ "Status":{ "shape":"HttpStatus", "documentation":"

It will be 202 upon success.

", "location":"statusCode" } }, "documentation":"

Upon success, it returns empty response. Otherwise, throws an exception.

", "deprecated":true }, "KMSAccessDeniedException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "Message":{"shape":"String"} }, "documentation":"

Lambda was unable to decrypt the environment variables because KMS access was denied. Check the Lambda function's KMS permissions.

", "error":{"httpStatusCode":502}, "exception":true }, "KMSDisabledException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "Message":{"shape":"String"} }, "documentation":"

Lambda was unable to decrypt the environment variables because the KMS key used is disabled. Check the Lambda function's KMS key settings.

", "error":{"httpStatusCode":502}, "exception":true }, "KMSInvalidStateException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "Message":{"shape":"String"} }, "documentation":"

Lambda was unable to decrypt the environment variables because the KMS key used is in an invalid state for Decrypt. Check the function's KMS key settings.

", "error":{"httpStatusCode":502}, "exception":true }, "KMSKeyArn":{ "type":"string", "pattern":"(arn:aws:[a-z0-9-.]+:.*)|()" }, "KMSNotFoundException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "Message":{"shape":"String"} }, "documentation":"

Lambda was unable to decrypt the environment variables because the KMS key was not found. Check the function's KMS key settings.

", "error":{"httpStatusCode":502}, "exception":true }, "ListAliasesRequest":{ "type":"structure", "required":["FunctionName"], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

Lambda function name for which the alias is created.

", "location":"uri", "locationName":"FunctionName" }, "FunctionVersion":{ "shape":"Version", "documentation":"

If you specify this optional parameter, the API returns only the aliases that are pointing to the specific Lambda function version, otherwise the API returns all of the aliases created for the Lambda function.

", "location":"querystring", "locationName":"FunctionVersion" }, "Marker":{ "shape":"String", "documentation":"

Optional string. An opaque pagination token returned from a previous ListAliases operation. If present, indicates where to continue the listing.

", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"MaxListItems", "documentation":"

Optional integer. Specifies the maximum number of aliases to return in response. This parameter value must be greater than 0.

", "location":"querystring", "locationName":"MaxItems" } } }, "ListAliasesResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"String", "documentation":"

A string, present if there are more aliases.

" }, "Aliases":{ "shape":"AliasList", "documentation":"

A list of aliases.

" } } }, "ListEventSourceMappingsRequest":{ "type":"structure", "members":{ "EventSourceArn":{ "shape":"Arn", "documentation":"

The Amazon Resource Name (ARN) of the Amazon Kinesis stream. (This parameter is optional.)

", "location":"querystring", "locationName":"EventSourceArn" }, "FunctionName":{ "shape":"FunctionName", "documentation":"

The name of the Lambda function.

You can specify the function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). AWS Lambda also allows you to specify only the function name with the account ID qualifier (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "location":"querystring", "locationName":"FunctionName" }, "Marker":{ "shape":"String", "documentation":"

Optional string. An opaque pagination token returned from a previous ListEventSourceMappings operation. If present, specifies to continue the list from where the returning call left off.

", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"MaxListItems", "documentation":"

Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.

", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"

" }, "ListEventSourceMappingsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"String", "documentation":"

A string, present if there are more event source mappings.

" }, "EventSourceMappings":{ "shape":"EventSourceMappingsList", "documentation":"

An array of EventSourceMappingConfiguration objects.

" } }, "documentation":"

Contains a list of event sources (see EventSourceMappingConfiguration)

" }, "ListFunctionsRequest":{ "type":"structure", "members":{ "Marker":{ "shape":"String", "documentation":"

Optional string. An opaque pagination token returned from a previous ListFunctions operation. If present, indicates where to continue the listing.

", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"MaxListItems", "documentation":"

Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.

", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"

" }, "ListFunctionsResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"String", "documentation":"

A string, present if there are more functions.

" }, "Functions":{ "shape":"FunctionList", "documentation":"

A list of Lambda functions.

" } }, "documentation":"

Contains a list of AWS Lambda function configurations (see FunctionConfiguration.

" }, "ListVersionsByFunctionRequest":{ "type":"structure", "required":["FunctionName"], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

Function name whose versions to list. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "location":"uri", "locationName":"FunctionName" }, "Marker":{ "shape":"String", "documentation":"

Optional string. An opaque pagination token returned from a previous ListVersionsByFunction operation. If present, indicates where to continue the listing.

", "location":"querystring", "locationName":"Marker" }, "MaxItems":{ "shape":"MaxListItems", "documentation":"

Optional integer. Specifies the maximum number of AWS Lambda function versions to return in response. This parameter value must be greater than 0.

", "location":"querystring", "locationName":"MaxItems" } }, "documentation":"

" }, "ListVersionsByFunctionResponse":{ "type":"structure", "members":{ "NextMarker":{ "shape":"String", "documentation":"

A string, present if there are more function versions.

" }, "Versions":{ "shape":"FunctionList", "documentation":"

A list of Lambda function versions.

" } }, "documentation":"

" }, "LogType":{ "type":"string", "enum":[ "None", "Tail" ] }, "Long":{"type":"long"}, "MaxListItems":{ "type":"integer", "max":10000, "min":1 }, "MemorySize":{ "type":"integer", "max":1536, "min":128 }, "PolicyLengthExceededException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "message":{"shape":"String"} }, "documentation":"

Lambda function access policy is limited to 20 KB.

", "error":{"httpStatusCode":400}, "exception":true }, "Principal":{ "type":"string", "pattern":".*" }, "PublishVersionRequest":{ "type":"structure", "required":["FunctionName"], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

The Lambda function name. You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "location":"uri", "locationName":"FunctionName" }, "CodeSha256":{ "shape":"String", "documentation":"

The SHA256 hash of the deployment package you want to publish. This provides validation on the code you are publishing. If you provide this parameter value must match the SHA256 of the $LATEST version for the publication to succeed.

" }, "Description":{ "shape":"Description", "documentation":"

The description for the version you are publishing. If not provided, AWS Lambda copies the description from the $LATEST version.

" } }, "documentation":"

" }, "Qualifier":{ "type":"string", "max":128, "min":1, "pattern":"(|[a-zA-Z0-9$_-]+)" }, "RemovePermissionRequest":{ "type":"structure", "required":[ "FunctionName", "StatementId" ], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

Lambda function whose resource policy you want to remove a permission from.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "location":"uri", "locationName":"FunctionName" }, "StatementId":{ "shape":"StatementId", "documentation":"

Statement ID of the permission to remove.

", "location":"uri", "locationName":"StatementId" }, "Qualifier":{ "shape":"Qualifier", "documentation":"

You can specify this optional parameter to remove permission associated with a specific function version or function alias. If you don't specify this parameter, the API removes permission associated with the unqualified function ARN.

", "location":"querystring", "locationName":"Qualifier" } }, "documentation":"

" }, "RequestTooLargeException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "message":{"shape":"String"} }, "documentation":"

The request payload exceeded the Invoke request body JSON input limit. For more information, see Limits.

", "error":{"httpStatusCode":413}, "exception":true }, "ResourceArn":{ "type":"string", "pattern":"(arn:aws:[a-z0-9-.]+:.*)|()" }, "ResourceConflictException":{ "type":"structure", "members":{ "Type":{ "shape":"String", "documentation":"

" }, "message":{ "shape":"String", "documentation":"

" } }, "documentation":"

The resource already exists.

", "error":{"httpStatusCode":409}, "exception":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "Message":{"shape":"String"} }, "documentation":"

The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.

", "error":{"httpStatusCode":404}, "exception":true }, "RoleArn":{ "type":"string", "pattern":"arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" }, "Runtime":{ "type":"string", "enum":[ "nodejs", "nodejs4.3", "java8", "python2.7", "dotnetcore1.0", "nodejs4.3-edge" ] }, "S3Bucket":{ "type":"string", "max":63, "min":3, "pattern":"^[0-9A-Za-z\\.\\-_]*(?The AWS Lambda service encountered an internal error.

", "error":{"httpStatusCode":500}, "exception":true }, "SourceOwner":{ "type":"string", "pattern":"\\d{12}" }, "StatementId":{ "type":"string", "max":100, "min":1, "pattern":"([a-zA-Z0-9-_]+)" }, "String":{"type":"string"}, "SubnetIPAddressLimitReachedException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "Message":{"shape":"String"} }, "documentation":"

AWS Lambda was not able to set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.

", "error":{"httpStatusCode":502}, "exception":true }, "SubnetId":{"type":"string"}, "SubnetIds":{ "type":"list", "member":{"shape":"SubnetId"}, "max":16 }, "ThrottleReason":{ "type":"string", "enum":[ "ConcurrentInvocationLimitExceeded", "FunctionInvocationRateLimitExceeded", "CallerRateLimitExceeded" ] }, "Timeout":{ "type":"integer", "min":1 }, "Timestamp":{"type":"string"}, "TooManyRequestsException":{ "type":"structure", "members":{ "retryAfterSeconds":{ "shape":"String", "documentation":"

The number of seconds the caller should wait before retrying.

", "location":"header", "locationName":"Retry-After" }, "Type":{"shape":"String"}, "message":{"shape":"String"}, "Reason":{"shape":"ThrottleReason"} }, "documentation":"

", "error":{"httpStatusCode":429}, "exception":true }, "UnsupportedMediaTypeException":{ "type":"structure", "members":{ "Type":{"shape":"String"}, "message":{"shape":"String"} }, "documentation":"

The content type of the Invoke request body is not JSON.

", "error":{"httpStatusCode":415}, "exception":true }, "UpdateAliasRequest":{ "type":"structure", "required":[ "FunctionName", "Name" ], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

The function name for which the alias is created.

", "location":"uri", "locationName":"FunctionName" }, "Name":{ "shape":"Alias", "documentation":"

The alias name.

", "location":"uri", "locationName":"Name" }, "FunctionVersion":{ "shape":"Version", "documentation":"

Using this parameter you can change the Lambda function version to which the alias points.

" }, "Description":{ "shape":"Description", "documentation":"

You can change the description of the alias using this parameter.

" } } }, "UpdateEventSourceMappingRequest":{ "type":"structure", "required":["UUID"], "members":{ "UUID":{ "shape":"String", "documentation":"

The event source mapping identifier.

", "location":"uri", "locationName":"UUID" }, "FunctionName":{ "shape":"FunctionName", "documentation":"

The Lambda function to which you want the stream records sent.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail).

If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases

Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

" }, "Enabled":{ "shape":"Enabled", "documentation":"

Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

" }, "BatchSize":{ "shape":"BatchSize", "documentation":"

The maximum number of stream records that can be sent to your Lambda function for a single invocation.

" } }, "documentation":"

" }, "UpdateFunctionCodeRequest":{ "type":"structure", "required":["FunctionName"], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

The existing Lambda function name whose code you want to replace.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "location":"uri", "locationName":"FunctionName" }, "ZipFile":{ "shape":"Blob", "documentation":"

The contents of your zip file containing your deployment package. If you are using the web API directly, the contents of the zip file must be base64-encoded. If you are using the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for you. For more information about creating a .zip file, see Execution Permissions in the AWS Lambda Developer Guide.

" }, "S3Bucket":{ "shape":"S3Bucket", "documentation":"

Amazon S3 bucket name where the .zip file containing your deployment package is stored. This bucket must reside in the same AWS Region where you are creating the Lambda function.

" }, "S3Key":{ "shape":"S3Key", "documentation":"

The Amazon S3 object (the deployment package) key name you want to upload.

" }, "S3ObjectVersion":{ "shape":"S3ObjectVersion", "documentation":"

The Amazon S3 object (the deployment package) version you want to upload.

" }, "Publish":{ "shape":"Boolean", "documentation":"

This boolean parameter can be used to request AWS Lambda to update the Lambda function and publish a version as an atomic operation.

" } }, "documentation":"

" }, "UpdateFunctionConfigurationRequest":{ "type":"structure", "required":["FunctionName"], "members":{ "FunctionName":{ "shape":"FunctionName", "documentation":"

The name of the Lambda function.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

", "location":"uri", "locationName":"FunctionName" }, "Role":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.

" }, "Handler":{ "shape":"Handler", "documentation":"

The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.

" }, "Description":{ "shape":"Description", "documentation":"

A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.

" }, "Timeout":{ "shape":"Timeout", "documentation":"

The function execution time at which AWS Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

" }, "MemorySize":{ "shape":"MemorySize", "documentation":"

The amount of memory, in MB, your Lambda function is given. AWS Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

" }, "VpcConfig":{"shape":"VpcConfig"}, "Environment":{ "shape":"Environment", "documentation":"

The parent object that contains your environment's configuration settings.

" }, "Runtime":{ "shape":"Runtime", "documentation":"

The runtime environment for the Lambda function.

To use the Node.js runtime v4.3, set the value to \"nodejs4.3\". To use earlier runtime (v0.10.42), set the value to \"nodejs\".

You can no longer downgrade to the v0.10.42 runtime version. This version will no longer be supported as of early 2017.

" }, "DeadLetterConfig":{ "shape":"DeadLetterConfig", "documentation":"

The parent object that contains the target Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

" }, "KMSKeyArn":{ "shape":"KMSKeyArn", "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If you elect to use the AWS Lambda default service key, pass in an empty string (\"\") for this parameter.

" } }, "documentation":"

" }, "Version":{ "type":"string", "max":1024, "min":1, "pattern":"(\\$LATEST|[0-9]+)" }, "VpcConfig":{ "type":"structure", "members":{ "SubnetIds":{ "shape":"SubnetIds", "documentation":"

A list of one or more subnet IDs in your VPC.

" }, "SecurityGroupIds":{ "shape":"SecurityGroupIds", "documentation":"

A list of one or more security groups IDs in your VPC.

" } }, "documentation":"

If your Lambda function accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

" }, "VpcConfigResponse":{ "type":"structure", "members":{ "SubnetIds":{ "shape":"SubnetIds", "documentation":"

A list of subnet IDs associated with the Lambda function.

" }, "SecurityGroupIds":{ "shape":"SecurityGroupIds", "documentation":"

A list of security group IDs associated with the Lambda function.

" }, "VpcId":{ "shape":"VpcId", "documentation":"

The VPC ID associated with you Lambda function.

" } }, "documentation":"

VPC configuration associated with your Lambda function.

" }, "VpcId":{"type":"string"} }, "documentation":"AWS Lambda

Overview

This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, see What is AWS Lambda, and for information about how the service works, see AWS Lambda: How it Works in the AWS Lambda Developer Guide.

" } botocore-1.5.7/botocore/config.py0000666454262600001440000001563013042511306020045 0ustar pysdk-ciamazon00000000000000# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import copy from botocore.compat import OrderedDict from botocore.endpoint import DEFAULT_TIMEOUT, MAX_POOL_CONNECTIONS from botocore.exceptions import InvalidS3AddressingStyleError class Config(object): """Advanced configuration for Botocore clients. :type region_name: str :param region_name: The region to use in instantiating the client :type signature_version: str :param signature_version: The signature version when signing requests. :type user_agent: str :param user_agent: The value to use in the User-Agent header. :type user_agent_extra: str :param user_agent_extra: The value to append to the current User-Agent header value. :type connect_timeout: int :param connect_timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds. :type read_timeout: int :param read_timeout: The time in seconds till a timeout exception is thrown when attempting to read from a connection. The default is 60 seconds. :type parameter_validation: bool :param parameter_validation: Whether parameter validation should occur when serializing requests. The default is True. You can disable parameter validation for performance reasons. Otherwise, it's recommended to leave parameter validation enabled. :type max_pool_connections: int :param max_pool_connections: The maximum number of connections to keep in a connection pool. If this value is not set, the default value of 10 is used. :type s3: dict :param s3: A dictionary of s3 specific configurations. Valid keys are: * 'use_accelerate_endpoint' -- Refers to whether to use the S3 Accelerate endpoint. The value must be a boolean. If True, the client will use the S3 Accelerate endpoint. If the S3 Accelerate endpoint is being used then the addressing style will always be virtual. * 'payload_signing_enabled' -- Refers to whether or not to SHA256 sign sigv4 payloads. By default, this is disabled for streaming uploads (UploadPart and PutObject). * 'addressing_style' -- Refers to the style in which to address s3 endpoints. Values must be a string that equals: * auto -- Addressing style is chosen for user. Depending on the configuration of client, the endpoint may be addressed in the virtual or the path style. Note that this is the default behavior if no style is specified. * virtual -- Addressing style is always virtual. The name of the bucket must be DNS compatible or an exception will be thrown. Endpoints will be addressed as such: mybucket.s3.amazonaws.com * path -- Addressing style is always by path. Endpoints will be addressed as such: s3.amazonaws.com/mybucket """ OPTION_DEFAULTS = OrderedDict([ ('region_name', None), ('signature_version', None), ('user_agent', None), ('user_agent_extra', None), ('connect_timeout', DEFAULT_TIMEOUT), ('read_timeout', DEFAULT_TIMEOUT), ('parameter_validation', True), ('max_pool_connections', MAX_POOL_CONNECTIONS), ('s3', None) ]) def __init__(self, *args, **kwargs): self._user_provided_options = self._record_user_provided_options( args, kwargs) # Merge the user_provided options onto the default options config_vars = copy.copy(self.OPTION_DEFAULTS) config_vars.update(self._user_provided_options) # Set the attributes based on the config_vars for key, value in config_vars.items(): setattr(self, key, value) # Validate the s3 options self._validate_s3_configuration(self.s3) def _record_user_provided_options(self, args, kwargs): option_order = list(self.OPTION_DEFAULTS) user_provided_options = {} # Iterate through the kwargs passed through to the constructor and # map valid keys to the dictionary for key, value in kwargs.items(): if key in self.OPTION_DEFAULTS: user_provided_options[key] = value # The key must exist in the available options else: raise TypeError( 'Got unexpected keyword argument \'%s\'' % key) # The number of args should not be longer than the allowed # options if len(args) > len(option_order): raise TypeError( 'Takes at most %s arguments (%s given)' % ( len(option_order), len(args))) # Iterate through the args passed through to the constructor and map # them to appropriate keys. for i, arg in enumerate(args): # If it a kwarg was specified for the arg, then error out if option_order[i] in user_provided_options: raise TypeError( 'Got multiple values for keyword argument \'%s\'' % ( option_order[i])) user_provided_options[option_order[i]] = arg return user_provided_options def _validate_s3_configuration(self, s3): if s3 is not None: addressing_style = s3.get('addressing_style') if addressing_style not in ['virtual', 'auto', 'path', None]: raise InvalidS3AddressingStyleError( s3_addressing_style=addressing_style) def merge(self, other_config): """Merges the config object with another config object This will merge in all non-default values from the provided config and return a new config object :type other_config: botocore.config.Config :param other config: Another config object to merge with. The values in the provided config object will take precedence in the merging :returns: A config object built from the merged values of both config objects. """ # Make a copy of the current attributes in the config object. config_options = copy.copy(self._user_provided_options) # Merge in the user provided options from the other config config_options.update(other_config._user_provided_options) # Return a new config object with the merged properties. return Config(**config_options) botocore-1.5.7/botocore/paginate.py0000666454262600001440000005045613042511306020375 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from itertools import tee from six import string_types import jmespath import json import base64 import logging from botocore.exceptions import PaginationError from botocore.compat import zip from botocore.utils import set_value_from_jmespath, merge_dicts log = logging.getLogger(__name__) class PaginatorModel(object): def __init__(self, paginator_config): self._paginator_config = paginator_config['pagination'] def get_paginator(self, operation_name): try: single_paginator_config = self._paginator_config[operation_name] except KeyError: raise ValueError("Paginator for operation does not exist: %s" % operation_name) return single_paginator_config class PageIterator(object): def __init__(self, method, input_token, output_token, more_results, result_keys, non_aggregate_keys, limit_key, max_items, starting_token, page_size, op_kwargs): self._method = method 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._limit_key = limit_key self._starting_token = starting_token self._page_size = page_size self._op_kwargs = op_kwargs self._resume_token = None self._non_aggregate_key_exprs = non_aggregate_keys self._non_aggregate_part = {} @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 not isinstance(value, dict): raise ValueError("Bad starting token: %s" % value) if 'boto_truncate_amount' in value: token_keys = sorted(self._input_token + ['boto_truncate_amount']) else: token_keys = sorted(self._input_token) dict_keys = sorted(value.keys()) if token_keys == dict_keys: self._resume_token = base64.b64encode( json.dumps(value).encode('utf-8')).decode('utf-8') else: raise ValueError("Bad starting token: %s" % value) @property def non_aggregate_part(self): return self._non_aggregate_part def __iter__(self): current_kwargs = self._op_kwargs previous_next_token = None next_token = dict((key, None) for key in 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_params(current_kwargs) while True: response = self._make_request(current_kwargs) parsed = self._extract_parsed_response(response) 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 self._record_non_aggregate_key_values(parsed) current_response = primary_result_key.search(parsed) if current_response is None: current_response = [] num_current_response = len(current_response) 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 response break else: yield response total_items += num_current_response next_token = self._get_next_token(parsed) if all(t is None for t in next_token.values()): 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 search(self, expression): """Applies a JMESPath expression to a paginator Each page of results is searched using the provided JMESPath expression. If the result is not a list, it is yielded directly. If the result is a list, each element in the result is yielded individually (essentially implementing a flatmap in which the JMESPath search is the mapping function). :type expression: str :param expression: JMESPath expression to apply to each page. :return: Returns an iterator that yields the individual elements of applying a JMESPath expression to each page of results. """ compiled = jmespath.compile(expression) for page in self: results = compiled.search(page) if isinstance(results, list): for element in results: yield element else: # Yield result directly if it is not a list. yield results def _make_request(self, current_kwargs): return self._method(**current_kwargs) def _extract_parsed_response(self, response): return response def _record_non_aggregate_key_values(self, response): non_aggregate_keys = {} for expression in self._non_aggregate_key_exprs: result = expression.search(response) set_value_from_jmespath(non_aggregate_keys, expression.expression, result) self._non_aggregate_part = non_aggregate_keys def _inject_starting_params(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) if self._page_size is not None: # Pass the page size as the parameter name for limiting # page size, also known as the limit_key. op_kwargs[self._limit_key] = self._page_size def _inject_token_into_kwargs(self, op_kwargs, next_token): for name, token in next_token.items(): if (token is not None) and (token != 'None'): op_kwargs[name] = token elif name in op_kwargs: del op_kwargs[name] def _handle_first_request(self, parsed, primary_result_key, starting_truncation): # If the payload is an array or string, we need to slice into it # and only return the truncated amount. starting_truncation = self._parse_starting_token()[1] all_data = primary_result_key.search(parsed) if isinstance(all_data, (list, string_types)): data = all_data[starting_truncation:] else: data = None set_value_from_jmespath( parsed, primary_result_key.expression, data ) # 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 sample = token.search(parsed) if isinstance(sample, list): empty_value = [] elif isinstance(sample, string_types): empty_value = '' elif isinstance(sample, (int, float)): empty_value = 0 else: empty_value = None set_value_from_jmespath(parsed, token.expression, empty_value) return starting_truncation def _truncate_response(self, parsed, primary_result_key, truncate_amount, starting_truncation, next_token): original = primary_result_key.search(parsed) if original is None: original = [] amount_to_keep = len(original) - truncate_amount truncated = original[:amount_to_keep] set_value_from_jmespath( parsed, primary_result_key.expression, 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['boto_truncate_amount'] = \ 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 {} next_tokens = {} for output_token, input_key in \ zip(self._output_token, self._input_token): next_token = output_token.search(parsed) # We do not want to include any empty strings as actual tokens. # Treat them as None. if next_token: next_tokens[input_key] = next_token else: next_tokens[input_key] = None 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): complete_result = {} for response in self: page = response # We want to try to catch operation object pagination # and format correctly for those. They come in the form # of a tuple of two elements: (http_response, parsed_responsed). # We want the parsed_response as that is what the page iterator # uses. We can remove it though once operation objects are removed. if isinstance(response, tuple) and len(response) == 2: page = response[1] # We're incrementally building the full response page # by page. For each page in the response we need to # inject the necessary components from the page # into the complete_result. for result_expression in self.result_keys: # In order to incrementally update a result key # we need to search the existing value from complete_result, # then we need to search the _current_ page for the # current result key value. Then we append the current # value onto the existing value, and re-set that value # as the new value. result_value = result_expression.search(page) if result_value is None: continue existing_value = result_expression.search(complete_result) if existing_value is None: # Set the initial result set_value_from_jmespath( complete_result, result_expression.expression, result_value) continue # Now both result_value and existing_value contain something if isinstance(result_value, list): existing_value.extend(result_value) elif isinstance(result_value, (int, float, string_types)): # Modify the existing result with the sum or concatenation set_value_from_jmespath( complete_result, result_expression.expression, existing_value + result_value) merge_dicts(complete_result, self.non_aggregate_part) if self.resume_token is not None: complete_result['NextToken'] = self.resume_token return complete_result def _parse_starting_token(self): if self._starting_token is None: return None # The starting token is a dict passed as a base64 encoded string. next_token = self._starting_token try: next_token = json.loads( base64.b64decode(next_token).decode('utf-8')) index = 0 if 'boto_truncate_amount' in next_token: index = next_token.get('boto_truncate_amount') del next_token['boto_truncate_amount'] except (ValueError, TypeError): next_token, index = self._parse_starting_token_deprecated() return next_token, index def _parse_starting_token_deprecated(self): """ This handles parsing of old style starting tokens, and attempts to coerce them into the new style. """ log.debug("Attempting to fall back to old starting token parser. For " "token: %s" % self._starting_token) 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 self._convert_deprecated_starting_token(next_token), index def _convert_deprecated_starting_token(self, deprecated_token): """ This attempts to convert a deprecated starting token into the new style. """ len_deprecated_token = len(deprecated_token) len_input_token = len(self._input_token) if len_deprecated_token > len_input_token: raise ValueError("Bad starting token: %s" % self._starting_token) elif len_deprecated_token < len_input_token: log.debug("Old format starting token does not contain all input " "tokens. Setting the rest, in order, as None.") for i in range(len_input_token - len_deprecated_token): deprecated_token.append(None) return dict(zip(self._input_token, deprecated_token)) class Paginator(object): PAGE_ITERATOR_CLS = PageIterator def __init__(self, method, pagination_config): self._method = method self._pagination_cfg = pagination_config 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._non_aggregate_keys = self._get_non_aggregate_keys( self._pagination_cfg) self._result_keys = self._get_result_keys(self._pagination_cfg) self._limit_key = self._get_limit_key(self._pagination_cfg) @property def result_keys(self): return self._result_keys def _get_non_aggregate_keys(self, config): keys = [] for key in config.get('non_aggregate_keys', []): keys.append(jmespath.compile(key)) return 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['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_results') 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] result_key = [jmespath.compile(rk) for rk in result_key] return result_key def _get_limit_key(self, config): return config.get('limit_key') def paginate(self, **kwargs): """Create paginator object for an operation. This returns an iterable object. Iterating over this object will yield a single page of a response at a time. """ page_params = self._extract_paging_params(kwargs) return self.PAGE_ITERATOR_CLS( self._method, self._input_token, self._output_token, self._more_results, self._result_keys, self._non_aggregate_keys, self._limit_key, page_params['MaxItems'], page_params['StartingToken'], page_params['PageSize'], kwargs) def _extract_paging_params(self, kwargs): pagination_config = kwargs.pop('PaginationConfig', {}) max_items = pagination_config.get('MaxItems', None) if max_items is not None: max_items = int(max_items) page_size = pagination_config.get('PageSize', None) if page_size is not None: if self._pagination_cfg.get('limit_key', None) is None: raise PaginationError( message="PageSize parameter is not supported for the " "pagination interface for this operation.") page_size = int(page_size) return { 'MaxItems': max_items, 'StartingToken': pagination_config.get('StartingToken', None), 'PageSize': page_size, } class ResultKeyIterator(object): """Iterates over the results of paginated responses. Each iterator is associated with a single result key. Iterating over this object will give you each element in the result key list. :param pages_iterator: An iterator that will give you pages of results (a ``PageIterator`` class). :param result_key: The JMESPath expression representing the result key. """ 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: results = self.result_key.search(page) if results is None: results = [] for result in results: yield result botocore-1.5.7/botocore/compat.py0000666454262600001440000002204613042511306020062 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import copy import datetime import sys import inspect import warnings import hashlib import logging from botocore.vendored import six from botocore.exceptions import MD5UnavailableError from botocore.vendored.requests.packages.urllib3 import exceptions logger = logging.getLogger(__name__) if six.PY3: from six.moves import http_client class HTTPHeaders(http_client.HTTPMessage): pass from urllib.parse import quote from urllib.parse import urlencode from urllib.parse import unquote from urllib.parse import unquote_plus from urllib.parse import urlparse from urllib.parse import urlsplit from urllib.parse import urlunsplit from urllib.parse import urljoin from urllib.parse import parse_qsl from urllib.parse import parse_qs from http.client import HTTPResponse from io import IOBase as _IOBase from base64 import encodebytes from email.utils import formatdate from itertools import zip_longest file_type = _IOBase zip = zip # In python3, unquote takes a str() object, url decodes it, # then takes the bytestring and decodes it to utf-8. # Python2 we'll have to do this ourself (see below). unquote_str = unquote_plus def set_socket_timeout(http_response, timeout): """Set the timeout of the socket from an HTTPResponse. :param http_response: An instance of ``httplib.HTTPResponse`` """ http_response._fp.fp.raw._sock.settimeout(timeout) def accepts_kwargs(func): # In python3.4.1, there's backwards incompatible # changes when using getargspec with functools.partials. return inspect.getfullargspec(func)[2] def ensure_unicode(s, encoding=None, errors=None): # NOOP in Python 3, because every string is already unicode return s def ensure_bytes(s, encoding='utf-8', errors='strict'): if isinstance(s, str): return s.encode(encoding, errors) if isinstance(s, bytes): return s raise ValueError("Expected str or bytes, received %s." % type(s)) else: from urllib import quote from urllib import urlencode from urllib import unquote from urllib import unquote_plus from urlparse import urlparse from urlparse import urlsplit from urlparse import urlunsplit from urlparse import urljoin from urlparse import parse_qsl from urlparse import parse_qs from email.message import Message from email.Utils import formatdate file_type = file from itertools import izip as zip from itertools import izip_longest as zip_longest from httplib import HTTPResponse from base64 import encodestring as encodebytes 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 def unquote_str(value, encoding='utf-8'): # In python2, unquote() gives us a string back that has the urldecoded # bits, but not the unicode parts. We need to decode this manually. # unquote has special logic in which if it receives a unicode object it # will decode it to latin1. This is hard coded. To avoid this, we'll # encode the string with the passed in encoding before trying to # unquote it. byte_string = value.encode(encoding) return unquote_plus(byte_string).decode(encoding) def set_socket_timeout(http_response, timeout): """Set the timeout of the socket from an HTTPResponse. :param http_response: An instance of ``httplib.HTTPResponse`` """ http_response._fp.fp._sock.settimeout(timeout) def accepts_kwargs(func): return inspect.getargspec(func)[2] def ensure_unicode(s, encoding='utf-8', errors='strict'): if isinstance(s, six.text_type): return s return unicode(s, encoding, errors) def ensure_bytes(s, encoding='utf-8', errors='strict'): if isinstance(s, unicode): return s.encode(encoding, errors) if isinstance(s, str): return s raise ValueError("Expected str or unicode, received %s." % type(s)) try: from collections import OrderedDict except ImportError: # Python2.6 we use the 3rd party back port. from ordereddict import OrderedDict if sys.version_info[:2] == (2, 6): import simplejson as json # In py26, invalid xml parsed by element tree # will raise a plain old SyntaxError instead of # a real exception, so we need to abstract this change. XMLParseError = SyntaxError # Handle https://github.com/shazow/urllib3/issues/497 for py2.6. In # python2.6, there is a known issue where sometimes we cannot read the SAN # from an SSL cert (http://bugs.python.org/issue13034). However, newer # versions of urllib3 will warn you when there is no SAN. While we could # just turn off this warning in urllib3 altogether, we _do_ want warnings # when they're legitimate warnings. This method tries to scope the warning # filter to be as specific as possible. def filter_ssl_san_warnings(): warnings.filterwarnings( 'ignore', message="Certificate has no.*subjectAltName.*", category=exceptions.SecurityWarning, module=".*urllib3\.connection") else: import xml.etree.cElementTree XMLParseError = xml.etree.cElementTree.ParseError import json def filter_ssl_san_warnings(): # Noop for non-py26 versions. We will parse the SAN # appropriately. pass def filter_ssl_warnings(): # Ignore warnings related to SNI as it is not being used in validations. warnings.filterwarnings( 'ignore', message="A true SSLContext object is not available.*", category=exceptions.InsecurePlatformWarning, module=".*urllib3\.util\.ssl_") filter_ssl_san_warnings() @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 def total_seconds(delta): """ Returns the total seconds in a ``datetime.timedelta``. Python 2.6 does not have ``timedelta.total_seconds()``, so we have to calculate this ourselves. On 2.7 or better, we'll take advantage of the built-in method. The math was pulled from the ``datetime`` docs (http://docs.python.org/2.7/library/datetime.html#datetime.timedelta.total_seconds). :param delta: The timedelta object :type delta: ``datetime.timedelta`` """ if sys.version_info[:2] != (2, 6): return delta.total_seconds() day_in_seconds = delta.days * 24 * 3600.0 micro_in_seconds = delta.microseconds / 10.0**6 return day_in_seconds + delta.seconds + micro_in_seconds # Checks to see if md5 is available on this system. A given system might not # have access to it for various reasons, such as FIPS mode being enabled. try: hashlib.md5() MD5_AVAILABLE = True except ValueError: MD5_AVAILABLE = False def get_md5(*args, **kwargs): """ Attempts to get an md5 hashing object. :param raise_error_if_unavailable: raise an error if md5 is unavailable on this system. If False, None will be returned if it is unavailable. :type raise_error_if_unavailable: bool :param args: Args to pass to the MD5 constructor :param kwargs: Key word arguments to pass to the MD5 constructor :return: An MD5 hashing object if available. If it is unavailable, None is returned if raise_error_if_unavailable is set to False. """ if MD5_AVAILABLE: return hashlib.md5(*args, **kwargs) else: raise MD5UnavailableError() botocore-1.5.7/botocore/args.py0000666454262600001440000002025113042511306017527 0ustar pysdk-ciamazon00000000000000# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. """Internal module to help with normalizing botocore client args. This module (and all function/classes within this module) should be considered internal, and *not* a public API. """ import copy import logging import botocore.serialize from botocore.signers import RequestSigner from botocore.config import Config from botocore.endpoint import EndpointCreator logger = logging.getLogger(__name__) class ClientArgsCreator(object): def __init__(self, event_emitter, user_agent, response_parser_factory, loader, exceptions_factory): self._event_emitter = event_emitter self._user_agent = user_agent self._response_parser_factory = response_parser_factory self._loader = loader self._exceptions_factory = exceptions_factory def get_client_args(self, service_model, region_name, is_secure, endpoint_url, verify, credentials, scoped_config, client_config, endpoint_bridge): final_args = self.compute_client_args( service_model, client_config, endpoint_bridge, region_name, endpoint_url, is_secure, scoped_config) service_name = final_args['service_name'] parameter_validation = final_args['parameter_validation'] endpoint_config = final_args['endpoint_config'] protocol = final_args['protocol'] config_kwargs = final_args['config_kwargs'] s3_config = final_args['s3_config'] partition = endpoint_config['metadata'].get('partition', None) event_emitter = copy.copy(self._event_emitter) signer = RequestSigner( service_name, endpoint_config['signing_region'], endpoint_config['signing_name'], endpoint_config['signature_version'], credentials, event_emitter) config_kwargs['s3'] = s3_config new_config = Config(**config_kwargs) endpoint_creator = EndpointCreator(event_emitter) endpoint = endpoint_creator.create_endpoint( service_model, region_name=endpoint_config['region_name'], endpoint_url=endpoint_config['endpoint_url'], verify=verify, response_parser_factory=self._response_parser_factory, max_pool_connections=new_config.max_pool_connections, timeout=(new_config.connect_timeout, new_config.read_timeout)) serializer = botocore.serialize.create_serializer( protocol, parameter_validation) response_parser = botocore.parsers.create_parser(protocol) return { 'serializer': serializer, 'endpoint': endpoint, 'response_parser': response_parser, 'event_emitter': event_emitter, 'request_signer': signer, 'service_model': service_model, 'loader': self._loader, 'client_config': new_config, 'partition': partition, 'exceptions_factory': self._exceptions_factory } def compute_client_args(self, service_model, client_config, endpoint_bridge, region_name, endpoint_url, is_secure, scoped_config): service_name = service_model.endpoint_prefix protocol = service_model.metadata['protocol'] parameter_validation = True if client_config and not client_config.parameter_validation: parameter_validation = False elif scoped_config: raw_value = str(scoped_config.get('parameter_validation', '')) if raw_value.lower() == 'false': parameter_validation = False endpoint_config = endpoint_bridge.resolve( service_name, region_name, endpoint_url, is_secure) # Override the user agent if specified in the client config. user_agent = self._user_agent if client_config is not None: if client_config.user_agent is not None: user_agent = client_config.user_agent if client_config.user_agent_extra is not None: user_agent += ' %s' % client_config.user_agent_extra # Create a new client config to be passed to the client based # on the final values. We do not want the user to be able # to try to modify an existing client with a client config. config_kwargs = dict( region_name=endpoint_config['region_name'], signature_version=endpoint_config['signature_version'], user_agent=user_agent) if client_config is not None: config_kwargs.update( connect_timeout=client_config.connect_timeout, read_timeout=client_config.read_timeout, max_pool_connections=client_config.max_pool_connections, ) s3_config = self.compute_s3_config(scoped_config, client_config) return { 'service_name': service_name, 'parameter_validation': parameter_validation, 'user_agent': user_agent, 'endpoint_config': endpoint_config, 'protocol': protocol, 'config_kwargs': config_kwargs, 's3_config': s3_config, } def compute_s3_config(self, scoped_config, client_config): s3_configuration = None # Check the scoped config first. if scoped_config is not None: s3_configuration = scoped_config.get('s3') # Until we have proper validation of the config file (including # nested types), we have to account for the fact that the s3 # key could be parsed as a string, e.g 's3 = foo'. # In the case we'll ignore the key for now. if not isinstance(s3_configuration, dict): logger.debug("The s3 config key is not a dictionary type, " "ignoring its value of: %s", s3_configuration) s3_configuration = None # Convert logic for several s3 keys in the scoped config # so that the various strings map to the appropriate boolean value. if s3_configuration: boolean_keys = ['use_accelerate_endpoint', 'use_dualstack_endpoint', 'payload_signing_enabled'] s3_configuration = self._convert_config_to_bool( s3_configuration, boolean_keys) # Next specific client config values takes precedence over # specific values in the scoped config. if client_config is not None: if client_config.s3 is not None: if s3_configuration is None: s3_configuration = client_config.s3 else: # The current s3_configuration dictionary may be # from a source that only should be read from so # we want to be safe and just make a copy of it to modify # before it actually gets updated. s3_configuration = s3_configuration.copy() s3_configuration.update(client_config.s3) return s3_configuration def _convert_config_to_bool(self, config_dict, keys): # Make sure any further modifications to this section of the config # will not affect the scoped config by making a copy of it. config_copy = config_dict.copy() present_keys = [k for k in keys if k in config_copy] for key in present_keys: # Normalize on different possible values of True if config_copy[key] in [True, 'True', 'true']: config_copy[key] = True else: config_copy[key] = False return config_copy botocore-1.5.7/botocore/validate.py0000666454262600001440000002414413042511306020371 0ustar pysdk-ciamazon00000000000000"""User input parameter validation. This module handles user input parameter validation against a provided input model. Note that the objects in this module do *not* mutate any arguments. No type version happens here. It is up to another layer to properly convert arguments to any required types. Validation Errors ----------------- """ from botocore.compat import six import decimal from datetime import datetime from botocore.utils import parse_to_aware_datetime from botocore.exceptions import ParamValidationError def validate_parameters(params, shape): """Validates input parameters against a schema. This is a convenience function that validates parameters against a schema. You can also instantiate and use the ParamValidator class directly if you want more control. If there are any validation errors then a ParamValidationError will be raised. If there are no validation errors than no exception is raised and a value of None is returned. :param params: The user provided input parameters. :type shape: botocore.model.Shape :param shape: The schema which the input parameters should adhere to. :raise: ParamValidationError """ validator = ParamValidator() report = validator.validate(params, shape) if report.has_errors(): raise ParamValidationError(report=report.generate_report()) def type_check(valid_types): def _create_type_check_guard(func): def _on_passes_type_check(self, param, shape, errors, name): if _type_check(param, errors, name): return func(self, param, shape, errors, name) def _type_check(param, errors, name): if not isinstance(param, valid_types): valid_type_names = [six.text_type(t) for t in valid_types] errors.report(name, 'invalid type', param=param, valid_types=valid_type_names) return False return True return _on_passes_type_check return _create_type_check_guard def range_check(name, value, shape, error_type, errors): failed = False min_allowed = float('-inf') max_allowed = float('inf') if 'min' in shape.metadata: min_allowed = shape.metadata['min'] if value < min_allowed: failed = True if failed: errors.report(name, error_type, param=value, valid_range=[min_allowed, max_allowed]) class ValidationErrors(object): def __init__(self): self._errors = [] def has_errors(self): if self._errors: return True return False def generate_report(self): error_messages = [] for error in self._errors: error_messages.append(self._format_error(error)) return '\n'.join(error_messages) def _format_error(self, error): error_type, name, additional = error name = self._get_name(name) if error_type == 'missing required field': return 'Missing required parameter in %s: "%s"' % ( name, additional['required_name']) elif error_type == 'unknown field': return 'Unknown parameter in %s: "%s", must be one of: %s' % ( name, additional['unknown_param'], ', '.join(additional['valid_names'])) elif error_type == 'invalid type': return 'Invalid type for parameter %s, value: %s, type: %s, ' \ 'valid types: %s' % (name, additional['param'], str(type(additional['param'])), ', '.join(additional['valid_types'])) elif error_type == 'invalid range': min_allowed = additional['valid_range'][0] max_allowed = additional['valid_range'][1] return ('Invalid range for parameter %s, value: %s, valid range: ' '%s-%s' % (name, additional['param'], min_allowed, max_allowed)) elif error_type == 'invalid length': min_allowed = additional['valid_range'][0] max_allowed = additional['valid_range'][1] return ('Invalid length for parameter %s, value: %s, valid range: ' '%s-%s' % (name, additional['param'], min_allowed, max_allowed)) def _get_name(self, name): if not name: return 'input' elif name.startswith('.'): return name[1:] else: return name def report(self, name, reason, **kwargs): self._errors.append((reason, name, kwargs)) class ParamValidator(object): """Validates parameters against a shape model.""" def validate(self, params, shape): """Validate parameters against a shape model. This method will validate the parameters against a provided shape model. All errors will be collected before returning to the caller. This means that this method will not stop at the first error, it will return all possible errors. :param params: User provided dict of parameters :param shape: A shape model describing the expected input. :return: A list of errors. """ errors = ValidationErrors() self._validate(params, shape, errors, name='') return errors def _validate(self, params, shape, errors, name): getattr(self, '_validate_%s' % shape.type_name)( params, shape, errors, name) @type_check(valid_types=(dict,)) def _validate_structure(self, params, shape, errors, name): # Validate required fields. for required_member in shape.metadata.get('required', []): if required_member not in params: errors.report(name, 'missing required field', required_name=required_member, user_params=params) members = shape.members known_params = [] # Validate known params. for param in params: if param not in members: errors.report(name, 'unknown field', unknown_param=param, valid_names=list(members)) else: known_params.append(param) # Validate structure members. for param in known_params: self._validate(params[param], shape.members[param], errors, '%s.%s' % (name, param)) @type_check(valid_types=six.string_types) def _validate_string(self, param, shape, errors, name): # Validate range. For a string, the min/max contraints # are of the string length. # Looks like: # "WorkflowId":{ # "type":"string", # "min":1, # "max":256 # } range_check(name, len(param), shape, 'invalid length', errors) @type_check(valid_types=(list, tuple)) def _validate_list(self, param, shape, errors, name): member_shape = shape.member range_check(name, len(param), shape, 'invalid length', errors) for i, item in enumerate(param): self._validate(item, member_shape, errors, '%s[%s]' % (name, i)) @type_check(valid_types=(dict,)) def _validate_map(self, param, shape, errors, name): key_shape = shape.key value_shape = shape.value for key, value in param.items(): self._validate(key, key_shape, errors, "%s (key: %s)" % (name, key)) self._validate(value, value_shape, errors, '%s.%s' % (name, key)) @type_check(valid_types=six.integer_types) def _validate_integer(self, param, shape, errors, name): range_check(name, param, shape, 'invalid range', errors) def _validate_blob(self, param, shape, errors, name): if isinstance(param, (bytes, bytearray, six.text_type)): return elif hasattr(param, 'read'): # File like objects are also allowed for blob types. return else: errors.report(name, 'invalid type', param=param, valid_types=[str(bytes), str(bytearray), 'file-like object']) @type_check(valid_types=(bool,)) def _validate_boolean(self, param, shape, errors, name): pass @type_check(valid_types=(float, decimal.Decimal) + six.integer_types) def _validate_double(self, param, shape, errors, name): range_check(name, param, shape, 'invalid range', errors) _validate_float = _validate_double @type_check(valid_types=six.integer_types) def _validate_long(self, param, shape, errors, name): range_check(name, param, shape, 'invalid range', errors) def _validate_timestamp(self, param, shape, errors, name): # We don't use @type_check because datetimes are a bit # more flexible. You can either provide a datetime # object, or a string that parses to a datetime. is_valid_type = self._type_check_datetime(param) if not is_valid_type: valid_type_names = [six.text_type(datetime), 'timestamp-string'] errors.report(name, 'invalid type', param=param, valid_types=valid_type_names) def _type_check_datetime(self, value): try: parse_to_aware_datetime(value) return True except (TypeError, ValueError, AttributeError): # Yes, dateutil can sometimes raise an AttributeError # when parsing timestamps. return False class ParamValidationDecorator(object): def __init__(self, param_validator, serializer): self._param_validator = param_validator self._serializer = serializer def serialize_to_request(self, parameters, operation_model): input_shape = operation_model.input_shape if input_shape is not None: report = self._param_validator.validate(parameters, operation_model.input_shape) if report.has_errors(): raise ParamValidationError(report=report.generate_report()) return self._serializer.serialize_to_request(parameters, operation_model) botocore-1.5.7/botocore/translate.py0000666454262600001440000000375313042511306020600 0ustar pysdk-ciamazon00000000000000# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from botocore.utils import merge_dicts def build_retry_config(endpoint_prefix, retry_model, definitions): 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) return 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) botocore-1.5.7/botocore/parsers.py0000666454262600001440000007671213042511306020267 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. """Response parsers for the various protocol types. The module contains classes that can take an HTTP response, and given an output shape, parse the response into a dict according to the rules in the output shape. There are many similarities amongst the different protocols with regard to response parsing, and the code is structured in a way to avoid code duplication when possible. The diagram below is a diagram showing the inheritance hierarchy of the response classes. :: +--------------+ |ResponseParser| +--------------+ ^ ^ ^ +--------------------+ | +-------------------+ | | | +----------+----------+ +------+-------+ +-------+------+ |BaseXMLResponseParser| |BaseRestParser| |BaseJSONParser| +---------------------+ +--------------+ +--------------+ ^ ^ ^ ^ ^ ^ | | | | | | | | | | | | | ++----------+-+ +-+-----------++ | | |RestXMLParser| |RestJSONParser| | +-----+-----+ +-------------+ +--------------+ +----+-----+ |QueryParser| |JSONParser| +-----------+ +----------+ The diagram above shows that there is a base class, ``ResponseParser`` that contains logic that is similar amongst all the different protocols (``query``, ``json``, ``rest-json``, ``rest-xml``). Amongst the various services there is shared logic that can be grouped several ways: * The ``query`` and ``rest-xml`` both have XML bodies that are parsed in the same way. * The ``json`` and ``rest-json`` protocols both have JSON bodies that are parsed in the same way. * The ``rest-json`` and ``rest-xml`` protocols have additional attributes besides body parameters that are parsed the same (headers, query string, status code). This is reflected in the class diagram above. The ``BaseXMLResponseParser`` and the BaseJSONParser contain logic for parsing the XML/JSON body, and the BaseRestParser contains logic for parsing out attributes that come from other parts of the HTTP response. Classes like the ``RestXMLParser`` inherit from the ``BaseXMLResponseParser`` to get the XML body parsing logic and the ``BaseRestParser`` to get the HTTP header/status code/query string parsing. Return Values ============= Each call to ``parse()`` returns a dict has this form:: Standard Response { "ResponseMetadata": {"RequestId": } } Error response { "ResponseMetadata": {"RequestId": } "Error": { "Code": , "Message": , "Type": , } } """ import re import base64 import json import xml.etree.cElementTree import logging from botocore.compat import six, XMLParseError from botocore.utils import parse_timestamp, merge_dicts LOG = logging.getLogger(__name__) DEFAULT_TIMESTAMP_PARSER = parse_timestamp class ResponseParserFactory(object): def __init__(self): self._defaults = {} def set_parser_defaults(self, **kwargs): """Set default arguments when a parser instance is created. You can specify any kwargs that are allowed by a ResponseParser class. There are currently two arguments: * timestamp_parser - A callable that can parse a timetsamp string * blob_parser - A callable that can parse a blob type """ self._defaults.update(kwargs) def create_parser(self, protocol_name): parser_cls = PROTOCOL_PARSERS[protocol_name] return parser_cls(**self._defaults) def create_parser(protocol): return ResponseParserFactory().create_parser(protocol) def _text_content(func): # This decorator hides the difference between # an XML node with text or a plain string. It's used # to ensure that scalar processing operates only on text # strings, which allows the same scalar handlers to be used # for XML nodes from the body and HTTP headers. def _get_text_content(self, shape, node_or_string): if hasattr(node_or_string, 'text'): text = node_or_string.text if text is None: # If an XML node is empty , # we want to parse that as an empty string, # not as a null/None value. text = '' else: text = node_or_string return func(self, shape, text) return _get_text_content class ResponseParserError(Exception): pass class ResponseParser(object): """Base class for response parsing. This class represents the interface that all ResponseParsers for the various protocols must implement. This class will take an HTTP response and a model shape and parse the HTTP response into a dictionary. There is a single public method exposed: ``parse``. See the ``parse`` docstring for more info. """ DEFAULT_ENCODING = 'utf-8' def __init__(self, timestamp_parser=None, blob_parser=None): if timestamp_parser is None: timestamp_parser = DEFAULT_TIMESTAMP_PARSER self._timestamp_parser = timestamp_parser if blob_parser is None: blob_parser = self._default_blob_parser self._blob_parser = blob_parser def _default_blob_parser(self, value): # Blobs are always returned as bytes type (this matters on python3). # We don't decode this to a str because it's entirely possible that the # blob contains binary data that actually can't be decoded. return base64.b64decode(value) def parse(self, response, shape): """Parse the HTTP response given a shape. :param response: The HTTP response dictionary. This is a dictionary that represents the HTTP request. The dictionary must have the following keys, ``body``, ``headers``, and ``status_code``. :param shape: The model shape describing the expected output. :return: Returns a dictionary representing the parsed response described by the model. In addition to the shape described from the model, each response will also have a ``ResponseMetadata`` which contains metadata about the response, which contains at least two keys containing ``RequestId`` and ``HTTPStatusCode``. Some responses may populate additional keys, but ``RequestId`` will always be present. """ LOG.debug('Response headers: %s', response['headers']) LOG.debug('Response body:\n%s', response['body']) if response['status_code'] >= 301: if self._is_generic_error_response(response): parsed = self._do_generic_error_parse(response) else: parsed = self._do_error_parse(response, shape) else: parsed = self._do_parse(response, shape) # Add ResponseMetadata if it doesn't exist and inject the HTTP # status code and headers from the response. if isinstance(parsed, dict): response_metadata = parsed.get('ResponseMetadata', {}) response_metadata['HTTPStatusCode'] = response['status_code'] response_metadata['HTTPHeaders'] = dict(response['headers']) parsed['ResponseMetadata'] = response_metadata return parsed def _is_generic_error_response(self, response): # There are times when a service will respond with a generic # error response such as: # 'Http/1.1 Service Unavailable' # # This can also happen if you're going through a proxy. # In this case the protocol specific _do_error_parse will either # fail to parse the response (in the best case) or silently succeed # and treat the HTML above as an XML response and return # non sensical parsed data. # To prevent this case from happening we first need to check # whether or not this response looks like the generic response. if response['status_code'] >= 500: body = response['body'].strip() return body.startswith(b'') or not body def _do_generic_error_parse(self, response): # There's not really much we can do when we get a generic # html response. LOG.debug("Received a non protocol specific error response from the " "service, unable to populate error code and message.") return { 'Error': {'Code': str(response['status_code']), 'Message': six.moves.http_client.responses.get( response['status_code'], '')}, 'ResponseMetadata': {}, } def _do_parse(self, response, shape): raise NotImplementedError("%s._do_parse" % self.__class__.__name__) def _do_error_parse(self, response, shape): raise NotImplementedError( "%s._do_error_parse" % self.__class__.__name__) def _parse_shape(self, shape, node): handler = getattr(self, '_handle_%s' % shape.type_name, self._default_handle) return handler(shape, node) def _handle_list(self, shape, node): # Enough implementations share list serialization that it's moved # up here in the base class. parsed = [] member_shape = shape.member for item in node: parsed.append(self._parse_shape(member_shape, item)) return parsed def _default_handle(self, shape, value): return value class BaseXMLResponseParser(ResponseParser): def __init__(self, timestamp_parser=None, blob_parser=None): super(BaseXMLResponseParser, self).__init__(timestamp_parser, blob_parser) self._namespace_re = re.compile('{.*}') def _handle_map(self, shape, node): parsed = {} key_shape = shape.key value_shape = shape.value key_location_name = key_shape.serialization.get('name') or 'key' value_location_name = value_shape.serialization.get('name') or 'value' if shape.serialization.get('flattened') and not isinstance(node, list): node = [node] for keyval_node in node: for single_pair in keyval_node: # Within each there's a and a tag_name = self._node_tag(single_pair) if tag_name == key_location_name: key_name = self._parse_shape(key_shape, single_pair) elif tag_name == value_location_name: val_name = self._parse_shape(value_shape, single_pair) else: raise ResponseParserError("Unknown tag: %s" % tag_name) parsed[key_name] = val_name return parsed def _node_tag(self, node): return self._namespace_re.sub('', node.tag) def _handle_list(self, shape, node): # When we use _build_name_to_xml_node, repeated elements are aggregated # into a list. However, we can't tell the difference between a scalar # value and a single element flattened list. So before calling the # real _handle_list, we know that "node" should actually be a list if # it's flattened, and if it's not, then we make it a one element list. if shape.serialization.get('flattened') and not isinstance(node, list): node = [node] return super(BaseXMLResponseParser, self)._handle_list(shape, node) def _handle_structure(self, shape, node): parsed = {} members = shape.members xml_dict = self._build_name_to_xml_node(node) for member_name in members: member_shape = members[member_name] if 'location' in member_shape.serialization: # All members with locations have already been handled, # so we don't need to parse these members. continue xml_name = self._member_key_name(member_shape, member_name) member_node = xml_dict.get(xml_name) if member_node is not None: parsed[member_name] = self._parse_shape( member_shape, member_node) elif member_shape.serialization.get('xmlAttribute'): attribs = {} location_name = member_shape.serialization['name'] for key, value in node.attrib.items(): new_key = self._namespace_re.sub( location_name.split(':')[0] + ':', key) attribs[new_key] = value if location_name in attribs: parsed[member_name] = attribs[location_name] return parsed def _member_key_name(self, shape, member_name): # This method is needed because we have to special case flattened list # with a serialization name. If this is the case we use the # locationName from the list's member shape as the key name for the # surrounding structure. if shape.type_name == 'list' and shape.serialization.get('flattened'): list_member_serialized_name = shape.member.serialization.get( 'name') if list_member_serialized_name is not None: return list_member_serialized_name serialized_name = shape.serialization.get('name') if serialized_name is not None: return serialized_name return member_name def _build_name_to_xml_node(self, parent_node): # If the parent node is actually a list. We should not be trying # to serialize it to a dictionary. Instead, return the first element # in the list. if isinstance(parent_node, list): return self._build_name_to_xml_node(parent_node[0]) xml_dict = {} for item in parent_node: key = self._node_tag(item) if key in xml_dict: # If the key already exists, the most natural # way to handle this is to aggregate repeated # keys into a single list. # 12 -> {'foo': [Node(1), Node(2)]} if isinstance(xml_dict[key], list): xml_dict[key].append(item) else: # Convert from a scalar to a list. xml_dict[key] = [xml_dict[key], item] else: xml_dict[key] = item return xml_dict def _parse_xml_string_to_dom(self, xml_string): try: parser = xml.etree.cElementTree.XMLParser( target=xml.etree.cElementTree.TreeBuilder(), encoding=self.DEFAULT_ENCODING) parser.feed(xml_string) root = parser.close() except XMLParseError as e: raise ResponseParserError( "Unable to parse response (%s), " "invalid XML received:\n%s" % (e, xml_string)) return root def _replace_nodes(self, parsed): for key, value in parsed.items(): if value.getchildren(): sub_dict = self._build_name_to_xml_node(value) parsed[key] = self._replace_nodes(sub_dict) else: parsed[key] = value.text return parsed @_text_content def _handle_boolean(self, shape, text): if text == 'true': return True else: return False @_text_content def _handle_float(self, shape, text): return float(text) @_text_content def _handle_timestamp(self, shape, text): return self._timestamp_parser(text) @_text_content def _handle_integer(self, shape, text): return int(text) @_text_content def _handle_string(self, shape, text): return text @_text_content def _handle_blob(self, shape, text): return self._blob_parser(text) _handle_character = _handle_string _handle_double = _handle_float _handle_long = _handle_integer class QueryParser(BaseXMLResponseParser): def _do_error_parse(self, response, shape): xml_contents = response['body'] root = self._parse_xml_string_to_dom(xml_contents) parsed = self._build_name_to_xml_node(root) self._replace_nodes(parsed) # Once we've converted xml->dict, we need to make one or two # more adjustments to extract nested errors and to be consistent # with ResponseMetadata for non-error responses: # 1. {"Errors": {"Error": {...}}} -> {"Error": {...}} # 2. {"RequestId": "id"} -> {"ResponseMetadata": {"RequestId": "id"}} if 'Errors' in parsed: parsed.update(parsed.pop('Errors')) if 'RequestId' in parsed: parsed['ResponseMetadata'] = {'RequestId': parsed.pop('RequestId')} return parsed def _do_parse(self, response, shape): xml_contents = response['body'] root = self._parse_xml_string_to_dom(xml_contents) parsed = {} if shape is not None: start = root if 'resultWrapper' in shape.serialization: start = self._find_result_wrapped_shape( shape.serialization['resultWrapper'], root) parsed = self._parse_shape(shape, start) self._inject_response_metadata(root, parsed) return parsed def _find_result_wrapped_shape(self, element_name, xml_root_node): mapping = self._build_name_to_xml_node(xml_root_node) return mapping[element_name] def _inject_response_metadata(self, node, inject_into): mapping = self._build_name_to_xml_node(node) child_node = mapping.get('ResponseMetadata') if child_node is not None: sub_mapping = self._build_name_to_xml_node(child_node) for key, value in sub_mapping.items(): sub_mapping[key] = value.text inject_into['ResponseMetadata'] = sub_mapping class EC2QueryParser(QueryParser): def _inject_response_metadata(self, node, inject_into): mapping = self._build_name_to_xml_node(node) child_node = mapping.get('requestId') if child_node is not None: inject_into['ResponseMetadata'] = {'RequestId': child_node.text} def _do_error_parse(self, response, shape): # EC2 errors look like: # # # # InvalidInstanceID.Malformed # Invalid id: "1343124" # # # 12345 # # This is different from QueryParser in that it's RequestID, # not RequestId original = super(EC2QueryParser, self)._do_error_parse(response, shape) original['ResponseMetadata'] = { 'RequestId': original.pop('RequestID') } return original class BaseJSONParser(ResponseParser): def _handle_structure(self, shape, value): member_shapes = shape.members if value is None: # If the comes across the wire as "null" (None in python), # we should be returning this unchanged, instead of as an # empty dict. return None final_parsed = {} for member_name in member_shapes: member_shape = member_shapes[member_name] json_name = member_shape.serialization.get('name', member_name) raw_value = value.get(json_name) if raw_value is not None: final_parsed[member_name] = self._parse_shape( member_shapes[member_name], raw_value) return final_parsed def _handle_map(self, shape, value): parsed = {} key_shape = shape.key value_shape = shape.value for key, value in value.items(): actual_key = self._parse_shape(key_shape, key) actual_value = self._parse_shape(value_shape, value) parsed[actual_key] = actual_value return parsed def _handle_blob(self, shape, value): return self._blob_parser(value) def _handle_timestamp(self, shape, value): return self._timestamp_parser(value) def _do_error_parse(self, response, shape): body = self._parse_body_as_json(response['body']) error = {"Error": {"Message": '', "Code": ''}, "ResponseMetadata": {}} # Error responses can have slightly different structures for json. # The basic structure is: # # {"__type":"ConnectClientException", # "message":"The error message."} # The error message can either come in the 'message' or 'Message' key # so we need to check for both. error['Error']['Message'] = body.get('message', body.get('Message', '')) # if the message did not contain an error code # include the response status code response_code = response.get('status_code') code = body.get('__type', response_code and str(response_code)) if code is not None: # code has a couple forms as well: # * "com.aws.dynamodb.vAPI#ProvisionedThroughputExceededException" # * "ResourceNotFoundException" if '#' in code: code = code.rsplit('#', 1)[1] error['Error']['Code'] = code self._inject_response_metadata(error, response['headers']) return error def _inject_response_metadata(self, parsed, headers): if 'x-amzn-requestid' in headers: parsed.setdefault('ResponseMetadata', {})['RequestId'] = ( headers['x-amzn-requestid']) def _parse_body_as_json(self, body_contents): if not body_contents: return {} body = body_contents.decode(self.DEFAULT_ENCODING) try: original_parsed = json.loads(body) return original_parsed except ValueError: # if the body cannot be parsed, include # the literal string as the message return { 'message': body } class JSONParser(BaseJSONParser): """Response parse for the "json" protocol.""" def _do_parse(self, response, shape): # The json.loads() gives us the primitive JSON types, # but we need to traverse the parsed JSON data to convert # to richer types (blobs, timestamps, etc. parsed = {} if shape is not None: original_parsed = self._parse_body_as_json(response['body']) parsed = self._parse_shape(shape, original_parsed) self._inject_response_metadata(parsed, response['headers']) return parsed class BaseRestParser(ResponseParser): def _do_parse(self, response, shape): final_parsed = {} final_parsed['ResponseMetadata'] = self._populate_response_metadata( response) if shape is None: return final_parsed member_shapes = shape.members self._parse_non_payload_attrs(response, shape, member_shapes, final_parsed) self._parse_payload(response, shape, member_shapes, final_parsed) return final_parsed def _populate_response_metadata(self, response): metadata = {} headers = response['headers'] if 'x-amzn-requestid' in headers: metadata['RequestId'] = headers['x-amzn-requestid'] elif 'x-amz-request-id' in headers: metadata['RequestId'] = headers['x-amz-request-id'] # HostId is what it's called whenver this value is returned # in an XML response body, so to be consistent, we'll always # call is HostId. metadata['HostId'] = headers.get('x-amz-id-2', '') return metadata def _parse_payload(self, response, shape, member_shapes, final_parsed): if 'payload' in shape.serialization: # If a payload is specified in the output shape, then only that # shape is used for the body payload. payload_member_name = shape.serialization['payload'] body_shape = member_shapes[payload_member_name] if body_shape.type_name in ['string', 'blob']: # This is a stream body = response['body'] if isinstance(body, bytes): body = body.decode(self.DEFAULT_ENCODING) final_parsed[payload_member_name] = body else: original_parsed = self._initial_body_parse(response['body']) final_parsed[payload_member_name] = self._parse_shape( body_shape, original_parsed) else: original_parsed = self._initial_body_parse(response['body']) body_parsed = self._parse_shape(shape, original_parsed) final_parsed.update(body_parsed) def _parse_non_payload_attrs(self, response, shape, member_shapes, final_parsed): headers = response['headers'] for name in member_shapes: member_shape = member_shapes[name] location = member_shape.serialization.get('location') if location is None: continue elif location == 'statusCode': final_parsed[name] = self._parse_shape( member_shape, response['status_code']) elif location == 'headers': final_parsed[name] = self._parse_header_map(member_shape, headers) elif location == 'header': header_name = member_shape.serialization.get('name', name) if header_name in headers: final_parsed[name] = self._parse_shape( member_shape, headers[header_name]) def _parse_header_map(self, shape, headers): # Note that headers are case insensitive, so we .lower() # all header names and header prefixes. parsed = {} prefix = shape.serialization.get('name', '').lower() for header_name in headers: if header_name.lower().startswith(prefix): # The key name inserted into the parsed hash # strips off the prefix. name = header_name[len(prefix):] parsed[name] = headers[header_name] return parsed def _initial_body_parse(self, body_contents): # This method should do the initial xml/json parsing of the # body. We we still need to walk the parsed body in order # to convert types, but this method will do the first round # of parsing. raise NotImplementedError("_initial_body_parse") class RestJSONParser(BaseRestParser, BaseJSONParser): def _initial_body_parse(self, body_contents): return self._parse_body_as_json(body_contents) def _do_error_parse(self, response, shape): error = super(RestJSONParser, self)._do_error_parse(response, shape) self._inject_error_code(error, response) return error def _inject_error_code(self, error, response): # The "Code" value can come from either a response # header or a value in the JSON body. body = self._initial_body_parse(response['body']) if 'x-amzn-errortype' in response['headers']: code = response['headers']['x-amzn-errortype'] # Could be: # x-amzn-errortype: ValidationException: code = code.split(':')[0] error['Error']['Code'] = code elif 'code' in body or 'Code' in body: error['Error']['Code'] = body.get( 'code', body.get('Code', '')) class RestXMLParser(BaseRestParser, BaseXMLResponseParser): def _initial_body_parse(self, xml_string): if not xml_string: return xml.etree.cElementTree.Element('') return self._parse_xml_string_to_dom(xml_string) def _do_error_parse(self, response, shape): # We're trying to be service agnostic here, but S3 does have a slightly # different response structure for its errors compared to other # rest-xml serivces (route53/cloudfront). We handle this by just # trying to parse both forms. # First: # # # Sender # InvalidInput # Invalid resource type: foo # # request-id # if response['body']: # If the body ends up being invalid xml, the xml parser should not # blow up. It should at least try to pull information about the # the error response from other sources like the HTTP status code. try: return self._parse_error_from_body(response) except ResponseParserError as e: LOG.debug( 'Exception caught when parsing error response body:', exc_info=True) return self._parse_error_from_http_status(response) def _parse_error_from_http_status(self, response): return { 'Error': { 'Code': str(response['status_code']), 'Message': six.moves.http_client.responses.get( response['status_code'], ''), }, 'ResponseMetadata': { 'RequestId': response['headers'].get('x-amz-request-id', ''), 'HostId': response['headers'].get('x-amz-id-2', ''), } } def _parse_error_from_body(self, response): xml_contents = response['body'] root = self._parse_xml_string_to_dom(xml_contents) parsed = self._build_name_to_xml_node(root) self._replace_nodes(parsed) if root.tag == 'Error': # This is an S3 error response. First we'll populate the # response metadata. metadata = self._populate_response_metadata(response) # The RequestId and the HostId are already in the # ResponseMetadata, but are also duplicated in the XML # body. We don't need these values in both places, # we'll just remove them from the parsed XML body. parsed.pop('RequestId', '') parsed.pop('HostId', '') return {'Error': parsed, 'ResponseMetadata': metadata} elif 'RequestId' in parsed: # Other rest-xml serivces: parsed['ResponseMetadata'] = {'RequestId': parsed.pop('RequestId')} default = {'Error': {'Message': '', 'Code': ''}} merge_dicts(default, parsed) return default PROTOCOL_PARSERS = { 'ec2': EC2QueryParser, 'query': QueryParser, 'json': JSONParser, 'rest-json': RestJSONParser, 'rest-xml': RestXMLParser, } botocore-1.5.7/botocore/__init__.py0000666454262600001440000000701113042511307020332 0ustar pysdk-ciamazon00000000000000# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import os import re import logging __version__ = '1.5.7' 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])') # The regex below handles the special case where some acryonym # name is pluralized, e.g GatewayARNs, ListWebACLs, SomeCNAMEs. _special_case_transform = re.compile('[A-Z]{3,}s$') # Prepopulate the cache with special cases that don't match # our regular transformation. _xform_cache = { ('CreateCachediSCSIVolume', '_'): 'create_cached_iscsi_volume', ('CreateCachediSCSIVolume', '-'): 'create-cached-iscsi-volume', ('DescribeCachediSCSIVolumes', '_'): 'describe_cached_iscsi_volumes', ('DescribeCachediSCSIVolumes', '-'): 'describe-cached-iscsi-volumes', ('DescribeStorediSCSIVolumes', '_'): 'describe_stored_iscsi_volumes', ('DescribeStorediSCSIVolumes', '-'): 'describe-stored-iscsi-volumes', ('CreateStorediSCSIVolume', '_'): 'create_stored_iscsi_volume', ('CreateStorediSCSIVolume', '-'): 'create-stored-iscsi-volume', } # The items in this dict represent partial renames to apply globally to all # services which might have a matching argument or operation. This way a # common mis-translation can be fixed without having to call out each # individual case. _partial_renames = { 'ipv-6': 'ipv6', 'ipv_6': 'ipv6', } ScalarTypes = ('string', 'integer', 'boolean', 'timestamp', 'float', 'double') BOTOCORE_ROOT = os.path.dirname(os.path.abspath(__file__)) # Used to specify anonymous (unsigned) request signature UNSIGNED = object() def xform_name(name, sep='_', _xform_cache=_xform_cache, partial_renames=_partial_renames): """Convert camel case to a "pythonic" name. If the name contains the ``sep`` character, then it is returned unchanged. """ if sep in name: # If the sep is in the name, assume that it's already # transformed and return the string unchanged. return name key = (name, sep) if key not in _xform_cache: if _special_case_transform.search(name) is not None: is_special = _special_case_transform.search(name) matched = is_special.group() # Replace something like ARNs, ACLs with _arns, _acls. name = name[:-len(matched)] + sep + matched.lower() s1 = _first_cap_regex.sub(r'\1' + sep + r'\2', name) s2 = _number_cap_regex.sub(r'\1' + sep + r'\2', s1) transformed = _end_cap_regex.sub(r'\1' + sep + r'\2', s2).lower() # Do partial renames for old, new in partial_renames.items(): if old in transformed: transformed = transformed.replace(old, new) _xform_cache[key] = transformed return _xform_cache[key] botocore-1.5.7/botocore/configloader.py0000666454262600001440000002151613042511306021234 0ustar pysdk-ciamazon00000000000000# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import os import shlex import copy from six.moves import configparser import botocore.exceptions def multi_file_load_config(*filenames): """Load and combine multiple INI configs with profiles. This function will take a list of filesnames and return a single dictionary that represents the merging of the loaded config files. If any of the provided filenames does not exist, then that file is ignored. It is therefore ok to provide a list of filenames, some of which may not exist. Configuration files are **not** deep merged, only the top level keys are merged. The filenames should be passed in order of precedence. The first config file has precedence over the second config file, which has precedence over the third config file, etc. The only exception to this is that the "profiles" key is merged to combine profiles from multiple config files into a single profiles mapping. However, if a profile is defined in multiple config files, then the config file with the highest precedence is used. Profile values themselves are not merged. For example:: FileA FileB FileC [foo] [foo] [bar] a=1 a=2 a=3 b=2 [bar] [baz] [profile a] a=2 a=3 region=e [profile a] [profile b] [profile c] region=c region=d region=f The final result of ``multi_file_load_config(FileA, FileB, FileC)`` would be:: {"foo": {"a": 1}, "bar": {"a": 2}, "baz": {"a": 3}, "profiles": {"a": {"region": "c"}}, {"b": {"region": d"}}, {"c": {"region": "f"}}} Note that the "foo" key comes from A, even though it's defined in both FileA and FileB. Because "foo" was defined in FileA first, then the values for "foo" from FileA are used and the values for "foo" from FileB are ignored. Also note where the profiles originate from. Profile "a" comes FileA, profile "b" comes from FileB, and profile "c" comes from FileC. """ configs = [] profiles = [] for filename in filenames: try: loaded = load_config(filename) except botocore.exceptions.ConfigNotFound: continue profiles.append(loaded.pop('profiles')) configs.append(loaded) merged_config = _merge_list_of_dicts(configs) merged_profiles = _merge_list_of_dicts(profiles) merged_config['profiles'] = merged_profiles return merged_config def _merge_list_of_dicts(list_of_dicts): merged_dicts = {} for single_dict in list_of_dicts: for key, value in single_dict.items(): if key not in merged_dicts: merged_dicts[key] = value return merged_dicts def load_config(config_filename): """Parse a INI config with profiles. This will parse an INI config file and map top level profiles into a top level "profile" key. If you want to parse an INI file and map all section names to top level keys, use ``raw_config_parse`` instead. """ parsed = raw_config_parse(config_filename) return build_profile_map(parsed) def raw_config_parse(config_filename, parse_subsections=True): """Returns the parsed INI config contents. Each section name is a top level key. :param config_filename: The name of the INI file to parse :param parse_subsections: If True, parse indented blocks as subsections that represent their own configuration dictionary. For example, if the config file had the contents:: s3 = signature_version = s3v4 addressing_style = path The resulting ``raw_config_parse`` would be:: {'s3': {'signature_version': 's3v4', 'addressing_style': 'path'}} If False, do not try to parse subsections and return the indented block as its literal value:: {'s3': '\nsignature_version = s3v4\naddressing_style = path'} :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 = config_filename 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: for section in cp.sections(): config[section] = {} for option in cp.options(section): config_value = cp.get(section, option) if parse_subsections and config_value.startswith('\n'): # Then we need to parse the inner contents as # hierarchical. We support a single level # of nesting for now. try: config_value = _parse_nested(config_value) except ValueError: raise botocore.exceptions.ConfigParseError( path=path) config[section][option] = config_value return config def _parse_nested(config_value): # Given a value like this: # \n # foo = bar # bar = baz # We need to parse this into # {'foo': 'bar', 'bar': 'baz} parsed = {} for line in config_value.splitlines(): line = line.strip() if not line: continue # The caller will catch ValueError # and raise an appropriate error # if this fails. key, value = line.split('=', 1) parsed[key.strip()] = value.strip() return parsed def build_profile_map(parsed_ini_config): """Convert the parsed INI config into a profile map. The config file format requires that every profile except the default to be prepended with "profile", e.g.:: [profile test] aws_... = foo aws_... = bar [profile bar] aws_... = foo aws_... = bar # This is *not* a profile [preview] otherstuff = 1 # Neither is this [foobar] morestuff = 2 The build_profile_map will take a parsed INI config file where each top level key represents a section name, and convert into a format where all the profiles are under a single top level "profiles" key, and each key in the sub dictionary is a profile name. For example, the above config file would be converted from:: {"profile test": {"aws_...": "foo", "aws...": "bar"}, "profile bar": {"aws...": "foo", "aws...": "bar"}, "preview": {"otherstuff": ...}, "foobar": {"morestuff": ...}, } into:: {"profiles": {"test": {"aws_...": "foo", "aws...": "bar"}, "bar": {"aws...": "foo", "aws...": "bar"}, "preview": {"otherstuff": ...}, "foobar": {"morestuff": ...}, } If there are no profiles in the provided parsed INI contents, then an empty dict will be the value associated with the ``profiles`` key. .. note:: This will not mutate the passed in parsed_ini_config. Instead it will make a deepcopy and return that value. """ parsed_config = copy.deepcopy(parsed_ini_config) profiles = {} final_config = {} for key, values in parsed_config.items(): if key.startswith("profile"): try: parts = shlex.split(key) except ValueError: continue if len(parts) == 2: profiles[parts[1]] = values elif key == 'default': # default section is special and is considered a profile # name but we don't require you use 'profile "default"' # as a section. profiles[key] = values else: final_config[key] = values final_config['profiles'] = profiles return final_config botocore-1.5.7/botocore/client.py0000666454262600001440000010162113042511306020052 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import logging import functools from botocore import waiter, xform_name from botocore.auth import AUTH_TYPE_MAPS from botocore.awsrequest import prepare_request_dict from botocore.docs.docstring import ClientMethodDocstring from botocore.docs.docstring import PaginatorDocstring from botocore.exceptions import ClientError, DataNotFoundError from botocore.exceptions import OperationNotPageableError from botocore.exceptions import UnknownSignatureVersionError from botocore.hooks import first_non_none_response from botocore.model import ServiceModel from botocore.paginate import Paginator from botocore.utils import CachedProperty from botocore.utils import get_service_module_name from botocore.utils import switch_host_s3_accelerate from botocore.utils import S3RegionRedirector from botocore.utils import fix_s3_host from botocore.utils import switch_to_virtual_host_style from botocore.utils import S3_ACCELERATE_WHITELIST from botocore.args import ClientArgsCreator from botocore.compat import urlsplit # Keep this imported. There's pre-existing code that uses # "from botocore.client import Config". from botocore.config import Config logger = logging.getLogger(__name__) class ClientCreator(object): """Creates client objects for a service.""" def __init__(self, loader, endpoint_resolver, user_agent, event_emitter, retry_handler_factory, retry_config_translator, response_parser_factory=None, exceptions_factory=None): self._loader = loader self._endpoint_resolver = endpoint_resolver self._user_agent = user_agent self._event_emitter = event_emitter self._retry_handler_factory = retry_handler_factory self._retry_config_translator = retry_config_translator self._response_parser_factory = response_parser_factory self._exceptions_factory = exceptions_factory def create_client(self, service_name, region_name, is_secure=True, endpoint_url=None, verify=None, credentials=None, scoped_config=None, api_version=None, client_config=None): service_model = self._load_service_model(service_name, api_version) cls = self._create_client_class(service_name, service_model) endpoint_bridge = ClientEndpointBridge( self._endpoint_resolver, scoped_config, client_config, service_signing_name=service_model.metadata.get('signingName')) client_args = self._get_client_args( service_model, region_name, is_secure, endpoint_url, verify, credentials, scoped_config, client_config, endpoint_bridge) service_client = cls(**client_args) self._register_s3_events(service_client, endpoint_bridge, endpoint_url) return service_client def create_client_class(self, service_name, api_version=None): service_model = self._load_service_model(service_name, api_version) return self._create_client_class(service_name, service_model) def _create_client_class(self, service_name, service_model): class_attributes = self._create_methods(service_model) py_name_to_operation_name = self._create_name_mapping(service_model) class_attributes['_PY_TO_OP_NAME'] = py_name_to_operation_name bases = [BaseClient] self._event_emitter.emit('creating-client-class.%s' % service_name, class_attributes=class_attributes, base_classes=bases) class_name = get_service_module_name(service_model) cls = type(str(class_name), tuple(bases), class_attributes) return cls def _load_service_model(self, service_name, api_version=None): json_model = self._loader.load_service_model(service_name, 'service-2', api_version=api_version) service_model = ServiceModel(json_model, service_name=service_name) self._register_retries(service_model) return service_model def _register_retries(self, service_model): endpoint_prefix = service_model.endpoint_prefix # First, we load the entire retry config for all services, # then pull out just the information we need. original_config = self._loader.load_data('_retry') if not original_config: return retry_config = self._retry_config_translator.build_retry_config( endpoint_prefix, original_config.get('retry', {}), original_config.get('definitions', {})) logger.debug("Registering retry handlers for service: %s", service_model.service_name) handler = self._retry_handler_factory.create_retry_handler( retry_config, endpoint_prefix) unique_id = 'retry-config-%s' % endpoint_prefix self._event_emitter.register('needs-retry.%s' % endpoint_prefix, handler, unique_id=unique_id) def _register_s3_events(self, client, endpoint_bridge, endpoint_url): if client.meta.service_model.service_name != 's3': return S3RegionRedirector(endpoint_bridge, client).register() self._set_s3_addressing_style( endpoint_url, client.meta.config.s3, client.meta.events) # Enable accelerate if the configuration is set to to true or the # endpoint being used matches one of the accelerate endpoints. if self._is_s3_accelerate(endpoint_url, client.meta.config.s3): # Also make sure that the hostname gets switched to # s3-accelerate.amazonaws.com client.meta.events.register_first( 'request-created.s3', switch_host_s3_accelerate) def _set_s3_addressing_style(self, endpoint_url, s3_config, event_emitter): if s3_config is None: s3_config = {} addressing_style = self._get_s3_addressing_style( endpoint_url, s3_config) handler = self._get_s3_addressing_handler( endpoint_url, s3_config, addressing_style) if handler is not None: event_emitter.register('before-sign.s3', handler) def _get_s3_addressing_style(self, endpoint_url, s3_config): # Use virtual host style addressing if accelerate is enabled or if # the given endpoint url is an accelerate endpoint. accelerate = s3_config.get('use_accelerate_endpoint', False) if accelerate or self._is_s3_accelerate(endpoint_url, s3_config): return 'virtual' # If a particular addressing style is configured, use it. configured_addressing_style = s3_config.get('addressing_style') if configured_addressing_style: return configured_addressing_style def _get_s3_addressing_handler(self, endpoint_url, s3_config, addressing_style): # If virtual host style was configured, use it regardless of whether # or not the bucket looks dns compatible. if addressing_style == 'virtual': logger.debug("Using S3 virtual host style addressing.") return switch_to_virtual_host_style # If path style is configured, no additional steps are needed. If # endpoint_url was specified, don't default to virtual. We could # potentially default provided endpoint urls to virtual hosted # style, but for now it is avoided. if addressing_style == 'path' or endpoint_url is not None: logger.debug("Using S3 path style addressing.") return None logger.debug("Defaulting to S3 virtual host style addressing with " "path style addressing fallback.") # For dual stack mode, we need to clear the default endpoint url in # order to use the existing netloc if the bucket is dns compatible. if s3_config.get('use_dualstack_endpoint', False): return functools.partial( fix_s3_host, default_endpoint_url=None) # By default, try to use virtual style with path fallback. return fix_s3_host def _is_s3_accelerate(self, endpoint_url, s3_config): # Accelerate has been explicitly configured. if s3_config is not None and s3_config.get('use_accelerate_endpoint'): return True # Accelerate mode is turned on automatically if an endpoint url is # provided that matches the accelerate scheme. if endpoint_url is None: return False # Accelerate is only valid for Amazon endpoints. netloc = urlsplit(endpoint_url).netloc if not netloc.endswith('amazonaws.com'): return False # The first part of the url should always be s3-accelerate. parts = netloc.split('.') if parts[0] != 's3-accelerate': return False # Url parts between 's3-accelerate' and 'amazonaws.com' which # represent different url features. feature_parts = parts[1:-2] # There should be no duplicate url parts. if len(feature_parts) != len(set(feature_parts)): return False # Remaining parts must all be in the whitelist. return all(p in S3_ACCELERATE_WHITELIST for p in feature_parts) def _get_client_args(self, service_model, region_name, is_secure, endpoint_url, verify, credentials, scoped_config, client_config, endpoint_bridge): args_creator = ClientArgsCreator( self._event_emitter, self._user_agent, self._response_parser_factory, self._loader, self._exceptions_factory) return args_creator.get_client_args( service_model, region_name, is_secure, endpoint_url, verify, credentials, scoped_config, client_config, endpoint_bridge) def _create_methods(self, service_model): op_dict = {} for operation_name in service_model.operation_names: py_operation_name = xform_name(operation_name) op_dict[py_operation_name] = self._create_api_method( py_operation_name, operation_name, service_model) return op_dict def _create_name_mapping(self, service_model): # py_name -> OperationName, for every operation available # for a service. mapping = {} for operation_name in service_model.operation_names: py_operation_name = xform_name(operation_name) mapping[py_operation_name] = operation_name return mapping def _create_api_method(self, py_operation_name, operation_name, service_model): def _api_call(self, *args, **kwargs): # We're accepting *args so that we can give a more helpful # error message than TypeError: _api_call takes exactly # 1 argument. if args: raise TypeError( "%s() only accepts keyword arguments." % py_operation_name) # The "self" in this scope is referring to the BaseClient. return self._make_api_call(operation_name, kwargs) _api_call.__name__ = str(py_operation_name) # Add the docstring to the client method operation_model = service_model.operation_model(operation_name) docstring = ClientMethodDocstring( operation_model=operation_model, method_name=operation_name, event_emitter=self._event_emitter, method_description=operation_model.documentation, example_prefix='response = client.%s' % py_operation_name, include_signature=False ) _api_call.__doc__ = docstring return _api_call class ClientEndpointBridge(object): """Bridges endpoint data and client creation This class handles taking out the relevant arguments from the endpoint resolver and determining which values to use, taking into account any client configuration options and scope configuration options. This class also handles determining what, if any, region to use if no explicit region setting is provided. For example, Amazon S3 client will utilize "us-east-1" by default if no region can be resolved.""" DEFAULT_ENDPOINT = '{service}.{region}.amazonaws.com' def __init__(self, endpoint_resolver, scoped_config=None, client_config=None, default_endpoint=None, service_signing_name=None): self.service_signing_name = service_signing_name self.endpoint_resolver = endpoint_resolver self.scoped_config = scoped_config self.client_config = client_config self.default_endpoint = default_endpoint or self.DEFAULT_ENDPOINT def resolve(self, service_name, region_name=None, endpoint_url=None, is_secure=True): region_name = self._check_default_region(service_name, region_name) resolved = self.endpoint_resolver.construct_endpoint( service_name, region_name) if resolved: return self._create_endpoint( resolved, service_name, region_name, endpoint_url, is_secure) else: return self._assume_endpoint(service_name, region_name, endpoint_url, is_secure) def _check_default_region(self, service_name, region_name): if region_name is not None: return region_name # Use the client_config region if no explicit region was provided. if self.client_config and self.client_config.region_name is not None: return self.client_config.region_name def _create_endpoint(self, resolved, service_name, region_name, endpoint_url, is_secure): region_name, signing_region = self._pick_region_values( resolved, region_name, endpoint_url) if endpoint_url is None: if self._is_s3_dualstack_mode(service_name): endpoint_url = self._create_dualstack_endpoint( service_name, region_name, resolved['dnsSuffix'], is_secure) else: # Use the sslCommonName over the hostname for Python 2.6 compat. hostname = resolved.get('sslCommonName', resolved.get('hostname')) endpoint_url = self._make_url(hostname, is_secure, resolved.get('protocols', [])) signature_version = self._resolve_signature_version( service_name, resolved) signing_name = self._resolve_signing_name(service_name, resolved) return self._create_result( service_name=service_name, region_name=region_name, signing_region=signing_region, signing_name=signing_name, endpoint_url=endpoint_url, metadata=resolved, signature_version=signature_version) def _is_s3_dualstack_mode(self, service_name): if service_name != 's3': return False # TODO: This normalization logic is duplicated from the # ClientArgsCreator class. Consolidate everything to # ClientArgsCreator. _resolve_signature_version also has similarly # duplicated logic. client_config = self.client_config if client_config is not None and client_config.s3 is not None and \ 'use_dualstack_endpoint' in client_config.s3: # Client config trumps scoped config. return client_config.s3['use_dualstack_endpoint'] if self.scoped_config is None: return False enabled = self.scoped_config.get('s3', {}).get( 'use_dualstack_endpoint', False) if enabled in [True, 'True', 'true']: return True return False def _create_dualstack_endpoint(self, service_name, region_name, dns_suffix, is_secure): hostname = '{service}.dualstack.{region}.{dns_suffix}'.format( service=service_name, region=region_name, dns_suffix=dns_suffix) # Dualstack supports http and https so were hardcoding this value for # now. This can potentially move into the endpoints.json file. return self._make_url(hostname, is_secure, ['http', 'https']) def _assume_endpoint(self, service_name, region_name, endpoint_url, is_secure): if endpoint_url is None: # Expand the default hostname URI template. hostname = self.default_endpoint.format( service=service_name, region=region_name) endpoint_url = self._make_url(hostname, is_secure, ['http', 'https']) logger.debug('Assuming an endpoint for %s, %s: %s', service_name, region_name, endpoint_url) # We still want to allow the user to provide an explicit version. signature_version = self._resolve_signature_version( service_name, {'signatureVersions': ['v4']}) signing_name = self._resolve_signing_name(service_name, resolved={}) return self._create_result( service_name=service_name, region_name=region_name, signing_region=region_name, signing_name=signing_name, signature_version=signature_version, endpoint_url=endpoint_url, metadata={}) def _create_result(self, service_name, region_name, signing_region, signing_name, endpoint_url, signature_version, metadata): return { 'service_name': service_name, 'region_name': region_name, 'signing_region': signing_region, 'signing_name': signing_name, 'endpoint_url': endpoint_url, 'signature_version': signature_version, 'metadata': metadata } def _make_url(self, hostname, is_secure, supported_protocols): if is_secure and 'https' in supported_protocols: scheme = 'https' else: scheme = 'http' return '%s://%s' % (scheme, hostname) def _resolve_signing_name(self, service_name, resolved): # CredentialScope overrides everything else. if 'credentialScope' in resolved \ and 'service' in resolved['credentialScope']: return resolved['credentialScope']['service'] # Use the signingName from the model if present. if self.service_signing_name: return self.service_signing_name # Just assume is the same as the service name. return service_name def _pick_region_values(self, resolved, region_name, endpoint_url): signing_region = region_name if endpoint_url is None: # Do not use the region name or signing name from the resolved # endpoint if the user explicitly provides an endpoint_url. This # would happen if we resolve to an endpoint where the service has # a "defaults" section that overrides all endpoint with a single # hostname and credentialScope. This has been the case historically # for how STS has worked. The only way to resolve an STS endpoint # was to provide a region_name and an endpoint_url. In that case, # we would still resolve an endpoint, but we would not use the # resolved endpointName or signingRegion because we want to allow # custom endpoints. region_name = resolved['endpointName'] signing_region = region_name if 'credentialScope' in resolved \ and 'region' in resolved['credentialScope']: signing_region = resolved['credentialScope']['region'] return region_name, signing_region def _resolve_signature_version(self, service_name, resolved): # Client config overrides everything. client = self.client_config if client and client.signature_version is not None: return client.signature_version # Scoped config overrides picking from the endpoint metadata. scoped = self.scoped_config if scoped is not None: service_config = scoped.get(service_name) if service_config is not None and isinstance(service_config, dict): version = service_config.get('signature_version') if version: logger.debug( "Switching signature version for service %s " "to version %s based on config file override.", service_name, version) return version # Pick a signature version from the endpoint metadata if present. if 'signatureVersions' in resolved: potential_versions = resolved['signatureVersions'] if service_name == 's3': # We currently prefer s3 over s3v4. if 's3' in potential_versions: return 's3' elif 's3v4' in potential_versions: return 's3v4' if 'v4' in potential_versions: return 'v4' # Now just iterate over the signature versions in order until we # find the first one that is known to Botocore. for known in AUTH_TYPE_MAPS: if known in potential_versions: return known raise UnknownSignatureVersionError( signature_version=resolved.get('signatureVersions')) class BaseClient(object): # This is actually reassigned with the py->op_name mapping # when the client creator creates the subclass. This value is used # because calls such as client.get_paginator('list_objects') use the # snake_case name, but we need to know the ListObjects form. # xform_name() does the ListObjects->list_objects conversion, but # we need the reverse mapping here. _PY_TO_OP_NAME = {} def __init__(self, serializer, endpoint, response_parser, event_emitter, request_signer, service_model, loader, client_config, partition, exceptions_factory): self._serializer = serializer self._endpoint = endpoint self._response_parser = response_parser self._request_signer = request_signer self._cache = {} self._loader = loader self._client_config = client_config self.meta = ClientMeta(event_emitter, self._client_config, endpoint.host, service_model, self._PY_TO_OP_NAME, partition) self._exceptions_factory = exceptions_factory self._exceptions = None self._register_handlers() def _register_handlers(self): # Register the handler required to sign requests. self.meta.events.register('request-created.%s' % self.meta.service_model.endpoint_prefix, self._request_signer.handler) @property def _service_model(self): return self.meta.service_model def _make_api_call(self, operation_name, api_params): operation_model = self._service_model.operation_model(operation_name) request_context = { 'client_region': self.meta.region_name, 'client_config': self.meta.config, 'has_streaming_input': operation_model.has_streaming_input } request_dict = self._convert_to_request_dict( api_params, operation_model, context=request_context) handler, event_response = self.meta.events.emit_until_response( 'before-call.{endpoint_prefix}.{operation_name}'.format( endpoint_prefix=self._service_model.endpoint_prefix, operation_name=operation_name), model=operation_model, params=request_dict, request_signer=self._request_signer, context=request_context) if event_response is not None: http, parsed_response = event_response else: http, parsed_response = self._endpoint.make_request( operation_model, request_dict) self.meta.events.emit( 'after-call.{endpoint_prefix}.{operation_name}'.format( endpoint_prefix=self._service_model.endpoint_prefix, operation_name=operation_name), http_response=http, parsed=parsed_response, model=operation_model, context=request_context ) if http.status_code >= 300: error_code = parsed_response.get("Error", {}).get("Code") error_class = self.exceptions.from_code(error_code) raise error_class(parsed_response, operation_name) else: return parsed_response def _convert_to_request_dict(self, api_params, operation_model, context=None): # Given the API params provided by the user and the operation_model # we can serialize the request to a request_dict. operation_name = operation_model.name # Emit an event that allows users to modify the parameters at the # beginning of the method. It allows handlers to modify existing # parameters or return a new set of parameters to use. responses = self.meta.events.emit( 'provide-client-params.{endpoint_prefix}.{operation_name}'.format( endpoint_prefix=self._service_model.endpoint_prefix, operation_name=operation_name), params=api_params, model=operation_model, context=context) api_params = first_non_none_response(responses, default=api_params) event_name = ( 'before-parameter-build.{endpoint_prefix}.{operation_name}') self.meta.events.emit( event_name.format( endpoint_prefix=self._service_model.endpoint_prefix, operation_name=operation_name), params=api_params, model=operation_model, context=context) request_dict = self._serializer.serialize_to_request( api_params, operation_model) prepare_request_dict(request_dict, endpoint_url=self._endpoint.host, user_agent=self._client_config.user_agent, context=context) return request_dict def get_paginator(self, operation_name): """Create a paginator for an operation. :type operation_name: string :param operation_name: The operation name. This is the same name as the method name on the client. For example, if the method name is ``create_foo``, and you'd normally invoke the operation as ``client.create_foo(**kwargs)``, if the ``create_foo`` operation can be paginated, you can use the call ``client.get_paginator("create_foo")``. :raise OperationNotPageableError: Raised if the operation is not pageable. You can use the ``client.can_paginate`` method to check if an operation is pageable. :rtype: L{botocore.paginate.Paginator} :return: A paginator object. """ if not self.can_paginate(operation_name): raise OperationNotPageableError(operation_name=operation_name) else: actual_operation_name = self._PY_TO_OP_NAME[operation_name] # Create a new paginate method that will serve as a proxy to # the underlying Paginator.paginate method. This is needed to # attach a docstring to the method. def paginate(self, **kwargs): return Paginator.paginate(self, **kwargs) paginator_config = self._cache['page_config'][ actual_operation_name] # Add the docstring for the paginate method. paginate.__doc__ = PaginatorDocstring( paginator_name=actual_operation_name, event_emitter=self.meta.events, service_model=self.meta.service_model, paginator_config=paginator_config, include_signature=False ) # Rename the paginator class based on the type of paginator. paginator_class_name = str('%s.Paginator.%s' % ( get_service_module_name(self.meta.service_model), actual_operation_name)) # Create the new paginator class documented_paginator_cls = type( paginator_class_name, (Paginator,), {'paginate': paginate}) paginator = documented_paginator_cls( getattr(self, operation_name), paginator_config) return paginator def can_paginate(self, operation_name): """Check if an operation can be paginated. :type operation_name: string :param operation_name: The operation name. This is the same name as the method name on the client. For example, if the method name is ``create_foo``, and you'd normally invoke the operation as ``client.create_foo(**kwargs)``, if the ``create_foo`` operation can be paginated, you can use the call ``client.get_paginator("create_foo")``. :return: ``True`` if the operation can be paginated, ``False`` otherwise. """ if 'page_config' not in self._cache: try: page_config = self._loader.load_service_model( self._service_model.service_name, 'paginators-1', self._service_model.api_version)['pagination'] self._cache['page_config'] = page_config except DataNotFoundError: self._cache['page_config'] = {} actual_operation_name = self._PY_TO_OP_NAME[operation_name] return actual_operation_name in self._cache['page_config'] def _get_waiter_config(self): if 'waiter_config' not in self._cache: try: waiter_config = self._loader.load_service_model( self._service_model.service_name, 'waiters-2', self._service_model.api_version) self._cache['waiter_config'] = waiter_config except DataNotFoundError: self._cache['waiter_config'] = {} return self._cache['waiter_config'] def get_waiter(self, waiter_name): config = self._get_waiter_config() if not config: raise ValueError("Waiter does not exist: %s" % waiter_name) model = waiter.WaiterModel(config) mapping = {} for name in model.waiter_names: mapping[xform_name(name)] = name if waiter_name not in mapping: raise ValueError("Waiter does not exist: %s" % waiter_name) return waiter.create_waiter_with_client( mapping[waiter_name], model, self) @CachedProperty def waiter_names(self): """Returns a list of all available waiters.""" config = self._get_waiter_config() if not config: return [] model = waiter.WaiterModel(config) # Waiter configs is a dict, we just want the waiter names # which are the keys in the dict. return [xform_name(name) for name in model.waiter_names] @property def exceptions(self): if self._exceptions is None: self._exceptions = self._load_exceptions() return self._exceptions def _load_exceptions(self): return self._exceptions_factory.create_client_exceptions( self._service_model) class ClientMeta(object): """Holds additional client methods. This class holds additional information for clients. It exists for two reasons: * To give advanced functionality to clients * To namespace additional client attributes from the operation names which are mapped to methods at runtime. This avoids ever running into collisions with operation names. """ def __init__(self, events, client_config, endpoint_url, service_model, method_to_api_mapping, partition): self.events = events self._client_config = client_config self._endpoint_url = endpoint_url self._service_model = service_model self._method_to_api_mapping = method_to_api_mapping self._partition = partition @property def service_model(self): return self._service_model @property def region_name(self): return self._client_config.region_name @property def endpoint_url(self): return self._endpoint_url @property def config(self): return self._client_config @property def method_to_api_mapping(self): return self._method_to_api_mapping @property def partition(self): return self._partition botocore-1.5.7/setup.py0000666454262600001440000000405613042511306016124 0ustar pysdk-ciamazon00000000000000#!/usr/bin/env python import botocore import sys from setuptools import setup, find_packages requires = ['jmespath>=0.7.1,<1.0.0', 'python-dateutil>=2.1,<3.0.0', 'docutils>=0.10'] 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='Amazon Web Services', url='https://github.com/boto/botocore', scripts=[], packages=find_packages(exclude=['tests*']), package_data={'botocore': ['data/*.json', 'data/*/*.json'], 'botocore.vendored.requests': ['*.pem']}, include_package_data=True, install_requires=requires, extras_require={ ':python_version=="2.6"': [ 'ordereddict==1.1', 'simplejson==3.3.0', ] }, license="Apache License 2.0", classifiers=( 'Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', 'Intended Audience :: System Administrators', 'Natural Language :: English', 'License :: OSI Approved :: Apache Software License', 'Programming Language :: Python', 'Programming Language :: Python :: 2', 'Programming Language :: Python :: 2.6', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3', 'Programming Language :: Python :: 3.3', 'Programming Language :: Python :: 3.4', 'Programming Language :: Python :: 3.5', 'Programming Language :: Python :: 3.6', ), ) botocore-1.5.7/docs/0000777454262600001440000000000013042511310015330 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/docs/make.bat0000666454262600001440000001176513042511306016754 0ustar pysdk-ciamazon00000000000000@ECHO OFF REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set BUILDDIR=build set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source set I18NSPHINXOPTS=%SPHINXOPTS% source if NOT "%PAPER%" == "" ( set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% ) if "%1" == "" goto help if "%1" == "help" ( :help echo.Please use `make ^` where ^ is one of echo. html to make standalone HTML files echo. dirhtml to make HTML files named index.html in directories echo. singlehtml to make a single large HTML file echo. pickle to make pickle files echo. json to make JSON files echo. htmlhelp to make HTML files and a HTML help project echo. qthelp to make HTML files and a qthelp project echo. devhelp to make HTML files and a Devhelp project echo. epub to make an epub echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter echo. text to make text files echo. man to make manual pages echo. texinfo to make Texinfo files echo. gettext to make PO message catalogs echo. changes to make an overview over all changed/added/deprecated items echo. linkcheck to check all external links for integrity echo. doctest to run all doctests embedded in the documentation if enabled goto end ) if "%1" == "clean" ( for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i del /q /s %BUILDDIR%\* goto end ) if "%1" == "html" ( %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/html. goto end ) if "%1" == "dirhtml" ( %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. goto end ) if "%1" == "singlehtml" ( %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. goto end ) if "%1" == "pickle" ( %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the pickle files. goto end ) if "%1" == "json" ( %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the JSON files. goto end ) if "%1" == "htmlhelp" ( %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run HTML Help Workshop with the ^ .hhp project file in %BUILDDIR%/htmlhelp. goto end ) if "%1" == "qthelp" ( %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: echo.^> qcollectiongenerator %BUILDDIR%\qthelp\botocore.qhcp echo.To view the help file: echo.^> assistant -collectionFile %BUILDDIR%\qthelp\botocore.ghc goto end ) if "%1" == "devhelp" ( %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp if errorlevel 1 exit /b 1 echo. echo.Build finished. goto end ) if "%1" == "epub" ( %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub if errorlevel 1 exit /b 1 echo. echo.Build finished. The epub file is in %BUILDDIR%/epub. goto end ) if "%1" == "latex" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex if errorlevel 1 exit /b 1 echo. echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. goto end ) if "%1" == "text" ( %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text if errorlevel 1 exit /b 1 echo. echo.Build finished. The text files are in %BUILDDIR%/text. goto end ) if "%1" == "man" ( %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man if errorlevel 1 exit /b 1 echo. echo.Build finished. The manual pages are in %BUILDDIR%/man. goto end ) if "%1" == "texinfo" ( %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo if errorlevel 1 exit /b 1 echo. echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. goto end ) if "%1" == "gettext" ( %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale if errorlevel 1 exit /b 1 echo. echo.Build finished. The message catalogs are in %BUILDDIR%/locale. goto end ) if "%1" == "changes" ( %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes if errorlevel 1 exit /b 1 echo. echo.The overview file is in %BUILDDIR%/changes. goto end ) if "%1" == "linkcheck" ( %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck if errorlevel 1 exit /b 1 echo. echo.Link check complete; look for any errors in the above output ^ or in %BUILDDIR%/linkcheck/output.txt. goto end ) if "%1" == "doctest" ( %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest if errorlevel 1 exit /b 1 echo. echo.Testing of doctests in the sources finished, look at the ^ results in %BUILDDIR%/doctest/output.txt. goto end ) :end botocore-1.5.7/docs/Makefile0000666454262600001440000001271513042511306017003 0ustar pysdk-ciamazon00000000000000# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" @echo " text to make text files" @echo " man to make manual pages" @echo " texinfo to make Texinfo files" @echo " info to make Texinfo files and run them through makeinfo" @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: -rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/botocore.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/botocore.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/botocore" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/botocore" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." botocore-1.5.7/docs/source/0000777454262600001440000000000013042511310016630 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/docs/source/client_upgrades.rst0000666454262600001440000002026113042511306022540 0ustar pysdk-ciamazon00000000000000.. _client-upgrades: Upgrading to Clients ==================== Background ---------- Version 0.66.0 of botocore added support for clients (10/16/2014) added initial support for clients. This provided an alternate interface to making AWS calls that provided a number of benefits over the existing interface. At the time, both interfaces were added so that users could opt in to trying the new clients. Below is an example of the old interface: .. code-block:: python import botocore.session session = botocore.session.get_session() s3 = session.get_service('s3') endpoint = s3.get_endpoint('us-west-2') list_objects = s3.get_operation('ListObjects') http, response = list_objects.call(endpoint, Bucket='mybucket') if http.status_code == 200: print("Contents: %s" % response['Contents]) else: print("API call failed, status code: %s, error: %s" % ( http.status_code, http.content)) Here's an example of the newer (preferred) client interface: .. code-block:: python import botocore.session session = botocore.session.get_session() s3 = session.create_client('s3', 'us-west-2') response = s3.list_objects(Bucket='mybucket') print("Contents: %s" % response['Contents']) While there are many improvements with the new interface, here's a few notable improvements: * Less boilerplate. With clients, the ``Endpoints`` are abstracted from the user. The ``Operations`` are also abstracted. The user only needs to deal with a single class, the client class. * Exceptions. With clients, exceptions are raised on failed requests. You do not have to check the error code of the http response object * Return values. The http response is abstracted from the user. The client method makes an API call and returns a simple python dict. * More granular context. Clients allow you to have a context that's smaller than on a Service/Operation. For example, you can now create a client and add specific customizations and event handlers that apply to only that specific client, instead of any S3 client. Deprecation Timeline -------------------- Botocore has not had a GA (1.0) release yet. In version 1.0, the Service/Operation object **will be removed**. Leading up to 1.0, we will be deprecating the old interface according to this schedule: * (**done**) Version 0.66.0 introduced client * (**done**) Version 0.96.0 emitted a ``PendingDeprecationWarning`` when using the old interface. By default, these warnings are not printed to stderr. A developer will need to opt in to these warnings to see any emitted warnings. * (**done**) Version 0.99.0 emitted a ``DeprecationWarning`` when using the old interface. This has the same behavior as ``PendingDeprecationWarning``, in which by default nothing is printed to stderr. * Version 0.104.0 emitted an ``ImminentRemovalWarning`` when using the old interface. This warning is now printed to stderr by default. A user can still turn off these warnings via the ``warnings`` module. * The ``develop`` branch on github will be updated to completely remove the old interface. At this point the client interface will be the only interface available when using the ``develop`` branch on github. * A 1.0 alpha version will be released. By default, ``pip`` will not pick up any alpha/beta releases. * A 1.0 beta version will be released. * A GA (1.0) version of botocore will be released. How To Upgrade ============== Migrating to clients is straightforward. This section outlines how to upgrade and some common scenarios and how to upgrade. Keyword Arg Casing ------------------ In botocore's old interface, kwargs could either be snake_cased or CamelCased and botocore would map them to the correct version needed by the service which is CamelCase. Botocore's client interface accepts **only** CamelCased args. More specifically, botocore uses the same casing used by the respective AWS service. Most AWS services uses CamelCasing. Some AWS services use lowerCamelCase. **Old** .. code-block:: python list_objects.call(endpoint, bucket='foo', key='bar') **New** .. code-block:: python client.list_objects(Bucket='foo', Key='bar') Connection Pooling ------------------ In the old interface, the connection pooling was tied to an endpoint object. To reuse existing HTTP connection, you needed to keep a reference to the endpoint objects. With clients, connection pooling is tied to a client. Use a single client to make multiple API calls. **Old** .. code-block:: python service = session.get_service('s3') endpoint = service.get_endpoint('us-west-2') operation = service.get_operation('ListObjects') head_object = service.get_operation('HeadObject') parsed = operation.call(endpoint, Bucket='mybucket')[1] for obj in parsed['Contents']: name = obj['Key'] # Use existing connection be passing in the same endpoint. print(head_object.call(endpoint, Bucket='mybucket', Key=name)) **New** .. code-block:: python s3 = session.get_client('s3', 'us-west-2') for obj in s3.list_objects(Bucket='mybucket')['Contents']: name = obj['Key'] # Using the same client will reuse any existing HTTP # connections the client was using. print(s3.head_object(Bucket='mybucket', Key=name)) Operation and Method Names -------------------------- In the old interface, you would retrieve an API operation using the casing defined by the service, which is typically CamelCase. For example, you'd use ``service.get_operation('ListObjects')``, not ``service.get_operation('list_objects')``. With clients, method names, which map 1 - 1 to operation names are snake_cased, as is common in python code. **Old** .. code-block:: python service = session.get_service('s3') list_objects = service.get_operation('ListObjects') head_object = service.get_operation('HeadObject') get_object = service.get_operation('GetObject') **New** .. code-block:: python s3 = session.get_client('s3', 'us-west-2') list_objects = s3.list_objects head_object = s3.head_object get_object = s3.get_object Return Values ------------- In the old interface, the return value for an ``operation.call`` invocation is a tuple of the HTTP response object, and the parsed dict that results from parsing the HTTP object. In the client interface, only the parsed response is returned. The HTTP response object is not returned. **Old** .. code-block:: python ec2 = session.get_service('ec2') endpoint = ec2.get_endpoint('ec2') describe_instances = ec2.get_operation('DescribeInstances') http, parsed = describe_instances.call(endpoint) **New** .. code-block:: python ec2 = session.get_client('ec2', 'us-west-2') parsed = ec2.describe_instances() The main reason for returning the HTTP response was to check if an error occurred via the HTTP response status code. This is now no longer required (discussed below). Exception are automatically raised. Note that if for some reason you do need to see the response status code, it is available via the ``ResponseMetadata`` in the parsed dict that's returned. .. code-block:: python ec2 = session.get_client('ec2', 'us-west-2') parsed = ec2.describe_instances() print("The status code is:", parsed['ResponseMetadata']['HTTPStatusCode'])) Error Handling -------------- With clients, exceptions are now raised on any non 2xx response. A ``ClientError`` exception has both a ``.msg`` attribute as well as the parsed error response (which is a dictionary). There isn't really equivalent functionality in the old interface, but below is an example of how you can handle an error: **New** .. code-block:: python from botocore.exceptions import ClientError ec2 = session.get_client('ec2', 'us-west-2') try: parsed = ec2.describe_instances(InstanceIds=['i-badid']) except ClientError as e: logger.error("Received error: %s", e, exc_info=True) # Only worry about a specific service error code if e.response['Error']['Code'] == 'InvalidInstanceID.NotFound': raise If you run into any issues migrating from the old interface to the newer client interface, please file an issue on github and let us know. We'd be happy to help. botocore-1.5.7/docs/source/development/0000777454262600001440000000000013042511310021152 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/docs/source/development/changesfor10.rst0000666454262600001440000000041713042511306024173 0ustar pysdk-ciamazon00000000000000Changes for Version 1.0 ======================= Botocore has been under beta/developer preview for a while now. Before getting to a stable 1.0 release, this document outlines the proposed changes that will be made. Changing the Model Schema ========================= botocore-1.5.7/docs/source/development/index.rst0000666454262600001440000000015013042511306023014 0ustar pysdk-ciamazon00000000000000Botocore Development ******************** .. toctree:: :maxdepth: 2 changesfor10 designnotes botocore-1.5.7/docs/source/development/designnotes.rst0000666454262600001440000000462713042511306024244 0ustar pysdk-ciamazon00000000000000Design Notes for Botocore ========================= This document outlines the rationale behind various design decisions in botocore. Casing of Arguments ------------------- One of the most noticeable differences between botocore and boto is that the client objects 1) require parameters to be provided as ``**kwargs`` and 2) require the arguments typically be provided as ``CamelCased`` values. For example:: ddb = session.create_client('dynamodb') ddb.describe_table(TableName='mytable') In boto, the equivalent code would be:: layer1.describe_table(table_name='mytable') There are several reasons why this was changed in botocore. The first reason was because we wanted to have the same casing for inputs as well as outputs. In both boto and botocore, the response for the ``describe_table`` calls is:: {'Table': {'CreationDateTime': 1393007077.387, 'ItemCount': 0, 'KeySchema': {'HashKeyElement': {'AttributeName': 'foo', 'AttributeType': 'S'}}, 'ProvisionedThroughput': {'ReadCapacityUnits': 5, 'WriteCapacityUnits': 5}, 'TableName': 'testtable', 'TableStatus': 'ACTIVE'}} Notice that the response is ``CamelCased``. This makes it more difficult to round trip results. In many cases you want to get the result of a ``describe*`` call and use that value as input through a corresponding ``update*`` call. If the input arguments require ``snake_casing`` but the response data is ``CamelCased`` then you will need to manually convert all the response elements back to ``snake_case`` in order to properly round trip. This makes the case for having consistent casing for both input and output. Why not use ``snake_casing`` for input as well as output? We choose to use ``CamelCasing`` because this is the casing used by AWS services. As a result, we don't have to do any translation from ``CamelCasing`` to ``snake_casing``. We can use the response values exactly as they are returned from AWS services. This also means that if you are reading the AWS API documentation for services, the names and casing referenced there will match what you would provide to botocore. For example, here's the corresponding API documentation for `dynamodb.describe_table `__. botocore-1.5.7/docs/source/reference/0000777454262600001440000000000013042511310020566 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/docs/source/reference/response.rst0000666454262600001440000000025613042511306023166 0ustar pysdk-ciamazon00000000000000.. _ref-response: ================== Response Reference ================== botocore.response ----------------- .. autoclass:: botocore.response.StreamingBody :members: botocore-1.5.7/docs/source/reference/config.rst0000666454262600001440000000022713042511306022573 0ustar pysdk-ciamazon00000000000000.. ref_config: ================ Config Reference ================ botocore.config --------------- .. autoclass:: botocore.config.Config :members:botocore-1.5.7/docs/source/reference/stubber.rst0000666454262600001440000000022713042511306022774 0ustar pysdk-ciamazon00000000000000.. ref_stubber: ================= Stubber Reference ================= botocore.stub ------------- .. autoclass:: botocore.stub.Stubber :members: botocore-1.5.7/docs/source/reference/index.rst0000666454262600001440000000015113042511306022431 0ustar pysdk-ciamazon00000000000000Available Services ================== .. toctree:: :maxdepth: 1 :titlesonly: :glob: services/* botocore-1.5.7/docs/source/reference/loaders.rst0000666454262600001440000000025313042511306022756 0ustar pysdk-ciamazon00000000000000.. ref-loaders ================= Loaders Reference ================= botocore.loaders ---------------- .. automodule:: botocore.loaders :members: :undoc-members: botocore-1.5.7/docs/source/tutorial/0000777454262600001440000000000013042511310020473 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/docs/source/tutorial/index.rst0000666454262600001440000000407513042511306022347 0ustar pysdk-ciamazon00000000000000***************************** Getting Started With botocore ***************************** The ``botocore`` package provides a low-level interface to Amazon services. It is responsible for: * Providing access to all available services * Providing access to all operations within a service * Marshaling all parameters for a particular operation in the correct format * Signing the request with the correct authentication signature * Receiving the response and returning the data in native Python data structures ``botocore`` does not provide higher-level abstractions on top of these services, operations and responses. That is left to the application layer. The goal of ``botocore`` is to handle all of the low-level details of making requests and getting results from a service. The ``botocore`` package is mainly data-driven. Each service has a JSON description which specifies all of the operations the service supports, all of the parameters the operation accepts, all of the documentation related to the service, information about supported regions and endpoints, etc. Because this data can be updated quickly based on the canonical description of these services, it's much easier to keep ``botocore`` current. Using Botocore ============== The first step in using botocore is to create a ``Session`` object. ``Session`` objects then allow you to create individual clients:: import botocore.session session = botocore.session.get_session() client = session.create_client('ec2', region_name='us-west-2') Once you have that client created, each operation provided by the service is mapped to a method. Each method takes ``**kwargs`` that maps to the parameter names exposed by the service. For example, using the ``client`` object created above:: for reservation in client.describe_instances()['Reservations']: for instance in reservation['Instances']: print instance['InstanceId'] # All instances that are in a state of pending. reservations = client.describe_instances( Filters=[{"Name": "instance-state-name", "Values": ["pending"]}]) botocore-1.5.7/docs/source/index.rst0000666454262600001440000000470113042511306020500 0ustar pysdk-ciamazon00000000000000Welcome to botocore =================== Botocore is a low-level interface to a growing number of Amazon Web Services. Botocore serves as the foundation for the `AWS-CLI `_ command line utilities. It will also play an important role in the boto3.x project. The botocore package is compatible with Python versions 2.6.5, Python 2.7.x, and Python 3.3.x and higher. Contents: .. toctree:: :maxdepth: 2 :glob: tutorial/index reference/* topics/index development/index Upgrade Notes ============= Upgrading to 1.0.0rc1 --------------------- * The ``default`` argument to ``session.get_config_variable()`` has been removed. If you need this functionality you can use:: value = session.get_config_variable() or 'default value' Upgrading to 0.104.0 -------------------- * Warnings about imminent removal of service/operation objects are now printed to stderr by default. It is highly encouraged that you switch to clients as soon as possible, as the deprecated service/operation object is going away. See :ref:`client-upgrades` for more information. Upgrading to 0.66.0 ------------------- * The ``before-call`` and ``after-call`` events have been changed such that their ``model`` for the operation is sent instead of the ``operation`` object itself. * The interface to waiters via ``Service.get_waiter`` has changed. An endpoint is now required when creating the waiter via ``get_waiter()`` instead of when calling the waiter ``waiter.wait(endpoint, **kwargs)``. Upgrading to 0.65.0 ------------------- * ``get_scoped_config()`` will now include credentials from the shared credentials file (``~/.aws/credentials``) if present. Upgrading to 0.64.0 ------------------- * ``botocore.parameters`` has been split into several different modules (``validate``, ``serialize``, and ``model``). If you were using the ``Operation.call`` method, you are unaffected by this change. * A ``botocore.client`` module has been added. This is the preferred interface into botocore going forward. * Response keys that are no longer in the HTTP response are not mapped to default values in the response dict. * ``ResponseMetadata`` is now always added to any successful response * ``Errors`` has been switch from a list of errors to a single ``Error`` key. Also consistently populate the ``Error`` dict on errors. Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` botocore-1.5.7/docs/source/conf.py0000666454262600001440000002050513042511307020137 0ustar pysdk-ciamazon00000000000000# -*- coding: utf-8 -*- # # botocore documentation build configuration file, created by # sphinx-quickstart on Sun Dec 2 07:26:23 2012. # # This file is execfile()d with the current directory set to its containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys, os from botocore.session import get_session from botocore.docs import generate_docs generate_docs(os.path.dirname(os.path.abspath(__file__)), get_session()) # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) # -- General configuration ----------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = u'botocore' copyright = u'2013, Mitch Garnaat' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = '1.5' # The full version, including alpha/beta/rc tags. release = '1.5.7' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: #today = '' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = [] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. #add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). #add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. #show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. #html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. html_show_sourcelink = False html_sidebars = { '**': ['logo-text.html', 'globaltoc.html', 'localtoc.html', 'searchbox.html'] } # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} # If false, no module index is generated. #html_domain_indices = True # If false, no index is generated. #html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False # If true, links to the reST sources are added to the pages. #html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. #html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. #html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = 'botocoredoc' import guzzle_sphinx_theme extensions.append("guzzle_sphinx_theme") html_translator_class = 'guzzle_sphinx_theme.HTMLTranslator' html_theme_path = guzzle_sphinx_theme.html_theme_path() html_theme = 'guzzle_sphinx_theme' # Guzzle theme options (see theme.conf for more information) html_theme_options = { # hack to add tracking "google_analytics_account": os.getenv('TRACKING', False), "base_url": "http://docs.aws.amazon.com/aws-sdk-php/guide/latest/" } # -- Options for LaTeX output -------------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'botocore.tex', u'botocore Documentation', u'Mitch Garnaat', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. #latex_use_parts = False # If true, show page references after internal links. #latex_show_pagerefs = False # If true, show URL addresses after external links. #latex_show_urls = False # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output -------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'botocore', u'botocore Documentation', [u'Mitch Garnaat'], 3) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------------ # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'botocore', u'botocore Documentation', u'Mitch Garnaat', 'botocore', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' botocore-1.5.7/docs/source/topics/0000777454262600001440000000000013042511310020131 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/docs/source/topics/paginators.rst0000666454262600001440000001063313042511306023042 0ustar pysdk-ciamazon00000000000000Botocore Paginators =================== Some AWS operations return results that are incomplete and require subsequent requests in order to attain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called *pagination*. For example, the ``list_objects`` operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate ``Marker`` in order to retrieve the next *page* of results. *Paginators* are a feature of botocore that act as an abstraction over the process of iterating over an entire result set of a truncated API operation. Creating Paginators ------------------- Paginators are created via the ``get_paginator()`` method of a botocore client. The ``get_paginator()`` method accepts an operation name and returns a reusable ``Paginator`` object. You then call the ``paginate`` method of the Paginator, passing in any relevant operation parameters to apply to the underlying API operation. The ``paginate`` method then returns an iterable ``PageIterator``:: import botocore.session # Create a session and a client session = botocore.session.get_session() client = session.create_client('s3', region_name='us-west-2') # Create a reusable Paginator paginator = client.get_paginator('list_objects') # Create a PageIterator from the Paginator page_iterator = paginator.paginate(Bucket='my-bucket') for page in page_iterator: print(page['Contents']) Customizing Page Iterators ~~~~~~~~~~~~~~~~~~~~~~~~~~ You must call the ``paginate`` method of a Paginator in order to iterate over the pages of API operation results. The ``paginate`` method accepts a ``PaginationConfig`` named argument that can be used to customize the pagination:: paginator = client.get_paginator('list_objects') page_iterator = paginator.paginate(Bucket='my-bucket', PaginationConfig={'MaxItems': 10}) ``MaxItems`` Limits the maximum number of total returned items returned while paginating. ``StartingToken`` Can be used to modify the starting marker or token of a paginator. This argument if useful for resuming pagination from a previous token or starting pagination at a known position. ``PageSize`` Controls the number of items returned per page of each result. .. note:: Services may choose to return more or fewer items than specified in the ``PageSize`` argument depending on the service, the operation, or the resource you are paginating. Filtering results ----------------- Many Paginators can be filtered server-side with options that are passed through to each underlying API call. For example, :py:meth:`S3.Paginator.list_objects.paginate` accepts a ``Prefix`` parameter used to filter the paginated results by prefix server-side before sending them to the client:: import botocore.session session = botocore.session.get_session() client = session.create_client('s3', region_name='us-west-2') paginator = client.get_paginator('list_objects') operation_parameters = {'Bucket': 'my-bucket', 'Prefix': 'foo/baz'} page_iterator = paginator.paginate(**operation_parameters) for page in page_iterator: print(page['Contents']) Filtering Results with JMESPath ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ `JMESPath `_ is a query language for JSON that can be used directly on paginated results. You can filter results client-side using JMESPath expressions that are applied to each page of results through the ``search`` method of a ``PageIterator``. .. code-block:: python paginator = client.get_paginator('list_objects') page_iterator = paginator.paginate(Bucket='my-bucket') filtered_iterator = page_iterator.search("Contents[?Size > `100`][]") for key_data in filtered_iterator: print(key_data) When filtering with JMESPath expressions, each page of results that is yielded by the paginator is mapped through the JMESPath expression. If a JMESPath expression returns a single value that is not an array, that value is yielded directly. If the the result of applying the JMESPath expression to a page of results is a list, then each value of the list is yielded individually (essentially implementing a flat map). For example, in the above expression, each key that has a ``Size`` greater than `100` is yielded by the ``filtered_iterator``. botocore-1.5.7/docs/source/topics/events.rst0000666454262600001440000000341213042511306022174 0ustar pysdk-ciamazon00000000000000Botocore Events =============== Botocore will emit events during various parts of its execution. Users of the library can register handlers (callables) for these events, such that whenever an event is emitted, all registered handlers for the event will be called. This allows you to customize and extend the behavior of botocore without having to modify the internals. This document covers this event system in detail. Session Events -------------- The main interface for events is through the :class:`botocore.session.Session` class. The ``Session`` object allows you to register and unregister handlers to events. Event Types ----------- The table below shows all of the events emitted by botocore. In some cases, the events are listed as ``..bar``, in which ```` and ```` are replaced with a specific service and operation, for example ``s3.ListObjects.bar``. .. list-table:: Events :header-rows: 1 * - Event Name - Occurance - Arguments - Return Value * - **service-created** - Whenever a service is created via the Sessions ``get_service`` method. - ``service`` - The newly created :class:`botocore.service.Service` object. - Ignored. * - **before-call..** - When an operation is being called (``Operation.call``). - ``operation`` - The newly created :class:`botocore.operation.Operation` object. - Ignored. * - **after-call..** - After an operation has been called, but before the response is parsed. - ``http_response`` - The HTTP response, ``parsed`` - The parsed data. - Ignored. Event Emission -------------- When an event is emitted, the handlers are invoked in the order that they were registered. botocore-1.5.7/docs/source/topics/index.rst0000666454262600001440000000014313042511306021775 0ustar pysdk-ciamazon00000000000000Botocore Topic Guides ********************* .. toctree:: :maxdepth: 2 events paginators botocore-1.5.7/requirements.txt0000666454262600001440000000025413042511306017672 0ustar pysdk-ciamazon00000000000000tox>=2.5.0,<3.0.0 python-dateutil>=2.1,<3.0.0 nose==1.3.0 mock==1.3.0 wheel==0.24.0 docutils>=0.10 behave==1.2.5 -e git://github.com/boto/jmespath.git@develop#egg=jmespath botocore-1.5.7/MANIFEST.in0000666454262600001440000000027513042511306016147 0ustar pysdk-ciamazon00000000000000include README.rst include LICENSE.txt include requirements.txt include botocore/vendored/requests/cacert.pem recursive-include botocore/data *.json graft docs prune docs/build graft tests botocore-1.5.7/PKG-INFO0000666454262600001440000000315413042511310015500 0ustar pysdk-ciamazon00000000000000Metadata-Version: 1.1 Name: botocore Version: 1.5.7 Summary: Low-level, data-driven core of boto 3. Home-page: https://github.com/boto/botocore Author: Amazon Web Services Author-email: UNKNOWN License: Apache License 2.0 Description: botocore ======== .. image:: https://secure.travis-ci.org/boto/botocore.png?branch=develop :target: http://travis-ci.org/boto/botocore .. image:: https://codecov.io/github/boto/botocore/coverage.svg?branch=develop :target: https://codecov.io/github/boto/botocore?branch=develop A low-level interface to a growing number of Amazon Web Services. The botocore package is the foundation for the `AWS CLI `__ as well as `boto3 `__. `Documentation `__ Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Intended Audience :: Developers Classifier: Intended Audience :: System Administrators Classifier: Natural Language :: English Classifier: License :: OSI Approved :: Apache Software License Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 2 Classifier: Programming Language :: Python :: 2.6 Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.3 Classifier: Programming Language :: Python :: 3.4 Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 botocore-1.5.7/setup.cfg0000666454262600001440000000036213042511310016222 0ustar pysdk-ciamazon00000000000000[wheel] universal = 1 [metadata] requires-dist = python-dateutil>=2.1,<3.0.0 jmespath>=0.7.1,<1.0.0 docutils>=0.10 ordereddict==1.1; python_version=="2.6" simplejson==3.3.0; python_version=="2.6" [egg_info] tag_build = tag_date = 0 botocore-1.5.7/botocore.egg-info/0000777454262600001440000000000013042511307017714 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/botocore.egg-info/requires.txt0000666454262600001440000000017713042511307022321 0ustar pysdk-ciamazon00000000000000jmespath>=0.7.1,<1.0.0 python-dateutil>=2.1,<3.0.0 docutils>=0.10 [:python_version=="2.6"] ordereddict==1.1 simplejson==3.3.0 botocore-1.5.7/botocore.egg-info/PKG-INFO0000666454262600001440000000315413042511307021014 0ustar pysdk-ciamazon00000000000000Metadata-Version: 1.1 Name: botocore Version: 1.5.7 Summary: Low-level, data-driven core of boto 3. Home-page: https://github.com/boto/botocore Author: Amazon Web Services Author-email: UNKNOWN License: Apache License 2.0 Description: botocore ======== .. image:: https://secure.travis-ci.org/boto/botocore.png?branch=develop :target: http://travis-ci.org/boto/botocore .. image:: https://codecov.io/github/boto/botocore/coverage.svg?branch=develop :target: https://codecov.io/github/boto/botocore?branch=develop A low-level interface to a growing number of Amazon Web Services. The botocore package is the foundation for the `AWS CLI `__ as well as `boto3 `__. `Documentation `__ Platform: UNKNOWN Classifier: Development Status :: 5 - Production/Stable Classifier: Intended Audience :: Developers Classifier: Intended Audience :: System Administrators Classifier: Natural Language :: English Classifier: License :: OSI Approved :: Apache Software License Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 2 Classifier: Programming Language :: Python :: 2.6 Classifier: Programming Language :: Python :: 2.7 Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.3 Classifier: Programming Language :: Python :: 3.4 Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 botocore-1.5.7/botocore.egg-info/dependency_links.txt0000666454262600001440000000000113042511307023762 0ustar pysdk-ciamazon00000000000000 botocore-1.5.7/botocore.egg-info/SOURCES.txt0000666454262600001440000021064413042511307021607 0ustar pysdk-ciamazon00000000000000LICENSE.txt MANIFEST.in README.rst requirements.txt setup.cfg setup.py botocore/__init__.py botocore/args.py botocore/auth.py botocore/awsrequest.py botocore/client.py botocore/compat.py botocore/config.py botocore/configloader.py botocore/credentials.py botocore/endpoint.py botocore/errorfactory.py botocore/exceptions.py botocore/handlers.py botocore/hooks.py botocore/loaders.py botocore/model.py botocore/paginate.py botocore/parsers.py botocore/regions.py botocore/response.py botocore/retryhandler.py botocore/serialize.py botocore/session.py botocore/signers.py botocore/stub.py botocore/translate.py botocore/utils.py botocore/validate.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/_retry.json botocore/data/endpoints.json botocore/data/acm/2015-12-08/paginators-1.json botocore/data/acm/2015-12-08/service-2.json botocore/data/apigateway/2015-07-09/paginators-1.json botocore/data/apigateway/2015-07-09/service-2.json botocore/data/application-autoscaling/2016-02-06/paginators-1.json botocore/data/application-autoscaling/2016-02-06/service-2.json botocore/data/appstream/2016-12-01/service-2.json botocore/data/autoscaling/2011-01-01/paginators-1.json botocore/data/autoscaling/2011-01-01/service-2.json botocore/data/batch/2016-08-10/service-2.json botocore/data/budgets/2016-10-20/service-2.json botocore/data/clouddirectory/2016-05-10/service-2.json botocore/data/cloudformation/2010-05-15/paginators-1.json botocore/data/cloudformation/2010-05-15/service-2.json botocore/data/cloudformation/2010-05-15/waiters-2.json botocore/data/cloudfront/2014-05-31/paginators-1.json botocore/data/cloudfront/2014-05-31/service-2.json botocore/data/cloudfront/2014-05-31/waiters-2.json botocore/data/cloudfront/2014-10-21/paginators-1.json botocore/data/cloudfront/2014-10-21/service-2.json botocore/data/cloudfront/2014-10-21/waiters-2.json botocore/data/cloudfront/2014-11-06/paginators-1.json botocore/data/cloudfront/2014-11-06/service-2.json botocore/data/cloudfront/2014-11-06/waiters-2.json botocore/data/cloudfront/2015-04-17/paginators-1.json botocore/data/cloudfront/2015-04-17/service-2.json botocore/data/cloudfront/2015-04-17/waiters-2.json botocore/data/cloudfront/2015-07-27/paginators-1.json botocore/data/cloudfront/2015-07-27/service-2.json botocore/data/cloudfront/2015-07-27/waiters-2.json botocore/data/cloudfront/2015-09-17/paginators-1.json botocore/data/cloudfront/2015-09-17/service-2.json botocore/data/cloudfront/2015-09-17/waiters-2.json botocore/data/cloudfront/2016-01-13/paginators-1.json botocore/data/cloudfront/2016-01-13/service-2.json botocore/data/cloudfront/2016-01-13/waiters-2.json botocore/data/cloudfront/2016-01-28/paginators-1.json botocore/data/cloudfront/2016-01-28/service-2.json botocore/data/cloudfront/2016-01-28/waiters-2.json botocore/data/cloudfront/2016-08-01/paginators-1.json botocore/data/cloudfront/2016-08-01/service-2.json botocore/data/cloudfront/2016-08-01/waiters-2.json botocore/data/cloudfront/2016-08-20/paginators-1.json botocore/data/cloudfront/2016-08-20/service-2.json botocore/data/cloudfront/2016-08-20/waiters-2.json botocore/data/cloudfront/2016-09-07/paginators-1.json botocore/data/cloudfront/2016-09-07/service-2.json botocore/data/cloudfront/2016-09-07/waiters-2.json botocore/data/cloudfront/2016-09-29/paginators-1.json botocore/data/cloudfront/2016-09-29/service-2.json botocore/data/cloudfront/2016-09-29/waiters-2.json botocore/data/cloudfront/2016-11-25/paginators-1.json botocore/data/cloudfront/2016-11-25/service-2.json botocore/data/cloudfront/2016-11-25/waiters-2.json botocore/data/cloudhsm/2014-05-30/service-2.json botocore/data/cloudsearch/2011-02-01/service-2.json botocore/data/cloudsearch/2013-01-01/service-2.json botocore/data/cloudsearchdomain/2013-01-01/service-2.json botocore/data/cloudtrail/2013-11-01/service-2.json botocore/data/cloudwatch/2010-08-01/paginators-1.json botocore/data/cloudwatch/2010-08-01/service-2.json botocore/data/codebuild/2016-10-06/service-2.json botocore/data/codecommit/2015-04-13/paginators-1.json botocore/data/codecommit/2015-04-13/service-2.json botocore/data/codedeploy/2014-10-06/service-2.json botocore/data/codedeploy/2014-10-06/waiters-2.json botocore/data/codepipeline/2015-07-09/service-2.json botocore/data/cognito-identity/2014-06-30/service-2.json botocore/data/cognito-idp/2016-04-18/service-2.json botocore/data/cognito-sync/2014-06-30/service-2.json botocore/data/config/2014-11-12/paginators-1.json botocore/data/config/2014-11-12/service-2.json botocore/data/cur/2017-01-06/service-2.json botocore/data/datapipeline/2012-10-29/paginators-1.json botocore/data/datapipeline/2012-10-29/service-2.json botocore/data/devicefarm/2015-06-23/paginators-1.json botocore/data/devicefarm/2015-06-23/service-2.json botocore/data/directconnect/2012-10-25/service-2.json botocore/data/discovery/2015-11-01/service-2.json botocore/data/dms/2016-01-01/service-2.json botocore/data/ds/2015-04-16/service-2.json botocore/data/dynamodb/2012-08-10/paginators-1.json botocore/data/dynamodb/2012-08-10/service-2.json botocore/data/dynamodb/2012-08-10/waiters-2.json botocore/data/dynamodbstreams/2012-08-10/service-2.json botocore/data/ec2/2014-09-01/paginators-1.json botocore/data/ec2/2014-09-01/service-2.json botocore/data/ec2/2014-09-01/waiters-2.json botocore/data/ec2/2014-10-01/paginators-1.json botocore/data/ec2/2014-10-01/service-2.json botocore/data/ec2/2014-10-01/waiters-2.json botocore/data/ec2/2015-03-01/paginators-1.json botocore/data/ec2/2015-03-01/service-2.json botocore/data/ec2/2015-03-01/waiters-2.json botocore/data/ec2/2015-04-15/paginators-1.json botocore/data/ec2/2015-04-15/service-2.json botocore/data/ec2/2015-04-15/waiters-2.json botocore/data/ec2/2015-10-01/paginators-1.json botocore/data/ec2/2015-10-01/service-2.json botocore/data/ec2/2015-10-01/waiters-2.json botocore/data/ec2/2016-04-01/paginators-1.json botocore/data/ec2/2016-04-01/service-2.json botocore/data/ec2/2016-04-01/waiters-2.json botocore/data/ec2/2016-09-15/examples-1.json botocore/data/ec2/2016-09-15/paginators-1.json botocore/data/ec2/2016-09-15/service-2.json botocore/data/ec2/2016-09-15/waiters-2.json botocore/data/ec2/2016-11-15/examples-1.json botocore/data/ec2/2016-11-15/paginators-1.json botocore/data/ec2/2016-11-15/service-2.json botocore/data/ec2/2016-11-15/waiters-2.json botocore/data/ecr/2015-09-21/paginators-1.json botocore/data/ecr/2015-09-21/service-2.json botocore/data/ecs/2014-11-13/paginators-1.json botocore/data/ecs/2014-11-13/service-2.json botocore/data/ecs/2014-11-13/waiters-2.json botocore/data/efs/2015-02-01/service-2.json botocore/data/elasticache/2014-09-30/paginators-1.json botocore/data/elasticache/2014-09-30/service-2.json botocore/data/elasticache/2014-09-30/waiters-2.json botocore/data/elasticache/2015-02-02/paginators-1.json botocore/data/elasticache/2015-02-02/service-2.json botocore/data/elasticache/2015-02-02/waiters-2.json botocore/data/elasticbeanstalk/2010-12-01/examples-1.json botocore/data/elasticbeanstalk/2010-12-01/paginators-1.json botocore/data/elasticbeanstalk/2010-12-01/service-2.json botocore/data/elastictranscoder/2012-09-25/paginators-1.json botocore/data/elastictranscoder/2012-09-25/service-2.json botocore/data/elastictranscoder/2012-09-25/waiters-2.json botocore/data/elb/2012-06-01/paginators-1.json botocore/data/elb/2012-06-01/service-2.json botocore/data/elbv2/2015-12-01/paginators-1.json botocore/data/elbv2/2015-12-01/service-2.json botocore/data/emr/2009-03-31/paginators-1.json botocore/data/emr/2009-03-31/service-2.json botocore/data/emr/2009-03-31/waiters-2.json botocore/data/es/2015-01-01/service-2.json botocore/data/events/2014-02-03/service-2.json botocore/data/events/2015-10-07/service-2.json botocore/data/firehose/2015-08-04/service-2.json botocore/data/gamelift/2015-10-01/service-2.json botocore/data/glacier/2012-06-01/paginators-1.json botocore/data/glacier/2012-06-01/service-2.json botocore/data/health/2016-08-04/paginators-1.json botocore/data/health/2016-08-04/service-2.json botocore/data/iam/2010-05-08/paginators-1.json botocore/data/iam/2010-05-08/service-2.json botocore/data/iam/2010-05-08/waiters-2.json botocore/data/importexport/2010-06-01/paginators-1.json botocore/data/importexport/2010-06-01/service-2.json botocore/data/inspector/2015-08-18/service-2.json botocore/data/inspector/2016-02-16/service-2.json botocore/data/iot-data/2015-05-28/service-2.json botocore/data/iot/2015-05-28/service-2.json botocore/data/kinesis/2013-12-02/paginators-1.json botocore/data/kinesis/2013-12-02/service-2.json botocore/data/kinesis/2013-12-02/waiters-2.json botocore/data/kinesisanalytics/2015-08-14/service-2.json botocore/data/kms/2014-11-01/paginators-1.json botocore/data/kms/2014-11-01/service-2.json botocore/data/lambda/2014-11-11/service-2.json botocore/data/lambda/2015-03-31/paginators-1.json botocore/data/lambda/2015-03-31/service-2.json botocore/data/lightsail/2016-11-28/paginators-1.json botocore/data/lightsail/2016-11-28/service-2.json botocore/data/logs/2014-03-28/paginators-1.json botocore/data/logs/2014-03-28/service-2.json botocore/data/machinelearning/2014-12-12/paginators-1.json botocore/data/machinelearning/2014-12-12/service-2.json botocore/data/machinelearning/2014-12-12/waiters-2.json botocore/data/marketplacecommerceanalytics/2015-07-01/service-2.json botocore/data/meteringmarketplace/2016-01-14/service-2.json botocore/data/opsworks/2013-02-18/service-2.json botocore/data/opsworks/2013-02-18/waiters-2.json botocore/data/opsworkscm/2016-11-01/service-2.json botocore/data/opsworkscm/2016-11-01/waiters-2.json botocore/data/pinpoint/2016-12-01/service-2.json botocore/data/polly/2016-06-10/service-2.json botocore/data/rds/2014-09-01/paginators-1.json botocore/data/rds/2014-09-01/service-2.json botocore/data/rds/2014-09-01/waiters-2.json botocore/data/rds/2014-10-31/paginators-1.json botocore/data/rds/2014-10-31/service-2.json botocore/data/rds/2014-10-31/service-2.sdk-extras.json botocore/data/rds/2014-10-31/waiters-2.json botocore/data/redshift/2012-12-01/paginators-1.json botocore/data/redshift/2012-12-01/service-2.json botocore/data/redshift/2012-12-01/waiters-2.json botocore/data/rekognition/2016-06-27/service-2.json botocore/data/route53/2013-04-01/paginators-1.json botocore/data/route53/2013-04-01/service-2.json botocore/data/route53/2013-04-01/waiters-2.json botocore/data/route53domains/2014-05-15/paginators-1.json botocore/data/route53domains/2014-05-15/service-2.json botocore/data/s3/2006-03-01/paginators-1.json botocore/data/s3/2006-03-01/service-2.json botocore/data/s3/2006-03-01/waiters-2.json botocore/data/sdb/2009-04-15/paginators-1.json botocore/data/sdb/2009-04-15/service-2.json botocore/data/servicecatalog/2015-12-10/service-2.json botocore/data/ses/2010-12-01/paginators-1.json botocore/data/ses/2010-12-01/service-2.json botocore/data/ses/2010-12-01/waiters-2.json botocore/data/shield/2016-06-02/service-2.json botocore/data/sms/2016-10-24/service-2.json botocore/data/snowball/2016-06-30/service-2.json botocore/data/sns/2010-03-31/paginators-1.json botocore/data/sns/2010-03-31/service-2.json botocore/data/sqs/2012-11-05/examples-1.json botocore/data/sqs/2012-11-05/service-2.json botocore/data/ssm/2014-11-06/paginators-1.json botocore/data/ssm/2014-11-06/service-2.json botocore/data/stepfunctions/2016-11-23/service-2.json botocore/data/storagegateway/2013-06-30/paginators-1.json botocore/data/storagegateway/2013-06-30/service-2.json botocore/data/sts/2011-06-15/service-2.json botocore/data/support/2013-04-15/paginators-1.json botocore/data/support/2013-04-15/service-2.json botocore/data/swf/2012-01-25/paginators-1.json botocore/data/swf/2012-01-25/service-2.json botocore/data/waf-regional/2016-11-28/service-2.json botocore/data/waf/2015-08-24/paginators-1.json botocore/data/waf/2015-08-24/service-2.json botocore/data/workspaces/2015-04-08/service-2.json botocore/data/xray/2016-04-12/service-2.json botocore/docs/__init__.py botocore/docs/client.py botocore/docs/docstring.py botocore/docs/example.py botocore/docs/method.py botocore/docs/paginator.py botocore/docs/params.py botocore/docs/service.py botocore/docs/shape.py botocore/docs/sharedexample.py botocore/docs/utils.py botocore/docs/waiter.py botocore/docs/bcdoc/__init__.py botocore/docs/bcdoc/docevents.py botocore/docs/bcdoc/docstringparser.py botocore/docs/bcdoc/restdoc.py botocore/docs/bcdoc/style.py botocore/docs/bcdoc/textwriter.py botocore/vendored/__init__.py botocore/vendored/six.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/chardet/__init__.py botocore/vendored/requests/packages/chardet/big5freq.py botocore/vendored/requests/packages/chardet/big5prober.py botocore/vendored/requests/packages/chardet/chardetect.py botocore/vendored/requests/packages/chardet/chardistribution.py botocore/vendored/requests/packages/chardet/charsetgroupprober.py botocore/vendored/requests/packages/chardet/charsetprober.py botocore/vendored/requests/packages/chardet/codingstatemachine.py botocore/vendored/requests/packages/chardet/compat.py botocore/vendored/requests/packages/chardet/constants.py botocore/vendored/requests/packages/chardet/cp949prober.py botocore/vendored/requests/packages/chardet/escprober.py botocore/vendored/requests/packages/chardet/escsm.py botocore/vendored/requests/packages/chardet/eucjpprober.py botocore/vendored/requests/packages/chardet/euckrfreq.py botocore/vendored/requests/packages/chardet/euckrprober.py botocore/vendored/requests/packages/chardet/euctwfreq.py botocore/vendored/requests/packages/chardet/euctwprober.py botocore/vendored/requests/packages/chardet/gb2312freq.py botocore/vendored/requests/packages/chardet/gb2312prober.py botocore/vendored/requests/packages/chardet/hebrewprober.py botocore/vendored/requests/packages/chardet/jisfreq.py botocore/vendored/requests/packages/chardet/jpcntx.py botocore/vendored/requests/packages/chardet/langbulgarianmodel.py botocore/vendored/requests/packages/chardet/langcyrillicmodel.py botocore/vendored/requests/packages/chardet/langgreekmodel.py botocore/vendored/requests/packages/chardet/langhebrewmodel.py botocore/vendored/requests/packages/chardet/langhungarianmodel.py botocore/vendored/requests/packages/chardet/langthaimodel.py botocore/vendored/requests/packages/chardet/latin1prober.py botocore/vendored/requests/packages/chardet/mbcharsetprober.py botocore/vendored/requests/packages/chardet/mbcsgroupprober.py botocore/vendored/requests/packages/chardet/mbcssm.py botocore/vendored/requests/packages/chardet/sbcharsetprober.py botocore/vendored/requests/packages/chardet/sbcsgroupprober.py botocore/vendored/requests/packages/chardet/sjisprober.py botocore/vendored/requests/packages/chardet/universaldetector.py botocore/vendored/requests/packages/chardet/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/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__.py botocore/vendored/requests/packages/urllib3/packages/ssl_match_hostname/_implementation.py botocore/vendored/requests/packages/urllib3/util/__init__.py botocore/vendored/requests/packages/urllib3/util/connection.py botocore/vendored/requests/packages/urllib3/util/request.py botocore/vendored/requests/packages/urllib3/util/response.py botocore/vendored/requests/packages/urllib3/util/retry.py botocore/vendored/requests/packages/urllib3/util/ssl_.py botocore/vendored/requests/packages/urllib3/util/timeout.py botocore/vendored/requests/packages/urllib3/util/url.py docs/Makefile docs/make.bat docs/source/client_upgrades.rst docs/source/conf.py docs/source/index.rst docs/source/development/changesfor10.rst docs/source/development/designnotes.rst docs/source/development/index.rst docs/source/reference/config.rst docs/source/reference/index.rst docs/source/reference/loaders.rst docs/source/reference/response.rst docs/source/reference/stubber.rst docs/source/topics/events.rst docs/source/topics/index.rst docs/source/topics/paginators.rst docs/source/tutorial/index.rst tests/__init__.py tests/cmd-runner tests/acceptance/features/environment.py tests/acceptance/features/smoke/acm/acm.feature tests/acceptance/features/smoke/autoscaling/autoscaling.feature tests/acceptance/features/smoke/cloudformation/cloudformation.feature tests/acceptance/features/smoke/cloudfront/cloudfront.feature tests/acceptance/features/smoke/cloudhsm/cloudhsm.feature tests/acceptance/features/smoke/cloudsearch/cloudsearch.feature tests/acceptance/features/smoke/cloudtrail/cloudtrail.feature tests/acceptance/features/smoke/cloudwatch/cloudwatch.feature tests/acceptance/features/smoke/cloudwatchlogs/cloudwatchlogs.feature tests/acceptance/features/smoke/codecommit/codecommit.feature tests/acceptance/features/smoke/codedeploy/codedeploy.feature tests/acceptance/features/smoke/codepipeline/codepipeline.feature tests/acceptance/features/smoke/cognitoidentity/cognitoidentity.feature tests/acceptance/features/smoke/cognitosync/cognitosync.feature tests/acceptance/features/smoke/configservice/configservice.feature tests/acceptance/features/smoke/datapipeline/datapipeline.feature tests/acceptance/features/smoke/devicefarm/devicefarm.feature tests/acceptance/features/smoke/directconnect/directconnect.feature tests/acceptance/features/smoke/directoryservice/directoryservice.feature tests/acceptance/features/smoke/dynamodb/dynamodb.feature tests/acceptance/features/smoke/dynamodbstreams/dynamodbstreams.feature tests/acceptance/features/smoke/ec2/ec2.feature tests/acceptance/features/smoke/ecs/ecs.feature tests/acceptance/features/smoke/efs/efs.feature tests/acceptance/features/smoke/elasticache/elasticache.feature tests/acceptance/features/smoke/elasticbeanstalk/elasticbeanstalk.feature tests/acceptance/features/smoke/elasticloadbalancing/elasticloadbalancing.feature tests/acceptance/features/smoke/elastictranscoder/elastictranscoder.feature tests/acceptance/features/smoke/emr/emr.feature tests/acceptance/features/smoke/es/es.feature tests/acceptance/features/smoke/glacier/glacier.feature tests/acceptance/features/smoke/iam/iam.feature tests/acceptance/features/smoke/importexport/importexport.feature tests/acceptance/features/smoke/kinesis/kinesis.feature tests/acceptance/features/smoke/kms/kms.feature tests/acceptance/features/smoke/lambda/lambda.feature tests/acceptance/features/smoke/machinelearning/machinelearning.feature tests/acceptance/features/smoke/opsworks/opsworks.feature tests/acceptance/features/smoke/rds/rds.feature tests/acceptance/features/smoke/redshift/redshift.feature tests/acceptance/features/smoke/route53/route53.feature tests/acceptance/features/smoke/route53domains/route53domains.feature tests/acceptance/features/smoke/ses/ses.feature tests/acceptance/features/smoke/sns/sns.feature tests/acceptance/features/smoke/sqs/sqs.feature tests/acceptance/features/smoke/ssm/ssm.feature tests/acceptance/features/smoke/storagegateway/storagegateway.feature tests/acceptance/features/smoke/sts/sts.feature tests/acceptance/features/smoke/support/support.feature tests/acceptance/features/smoke/swf/swf.feature tests/acceptance/features/smoke/waf/waf.feature tests/acceptance/features/smoke/workspaces/workspaces.feature tests/acceptance/features/steps/base.py tests/functional/__init__.py tests/functional/test_alias.py tests/functional/test_apigateway.py tests/functional/test_client_class_names.py tests/functional/test_client_metadata.py tests/functional/test_cloudformation.py tests/functional/test_cloudsearchdomain.py tests/functional/test_credentials.py tests/functional/test_ec2.py tests/functional/test_endpoints.py tests/functional/test_iot_data.py tests/functional/test_loaders.py tests/functional/test_machinelearning.py tests/functional/test_model_completeness.py tests/functional/test_paginate.py tests/functional/test_paginator_config.py tests/functional/test_public_apis.py tests/functional/test_rds.py tests/functional/test_regions.py tests/functional/test_s3.py tests/functional/test_session.py tests/functional/test_stub.py tests/functional/test_waiter_config.py tests/functional/docs/__init__.py tests/functional/docs/test_alias.py tests/functional/docs/test_autoscaling.py tests/functional/docs/test_ec2.py tests/functional/docs/test_glacier.py tests/functional/docs/test_s3.py tests/functional/docs/test_streaming_body.py tests/functional/leak/__init__.py tests/functional/leak/test_resource_leaks.py tests/integration/__init__.py tests/integration/test-credentials tests/integration/test_apigateway.py tests/integration/test_client.py tests/integration/test_cloudformation.py tests/integration/test_cognito_identity.py tests/integration/test_credentials.py tests/integration/test_ec2.py tests/integration/test_elastictranscoder.py tests/integration/test_emr.py tests/integration/test_glacier.py tests/integration/test_kinesis.py tests/integration/test_loaders.py tests/integration/test_rds.py tests/integration/test_route53.py tests/integration/test_s3.py tests/integration/test_session.py tests/integration/test_smoke.py tests/integration/test_sts.py tests/integration/test_utils.py tests/integration/test_waiters.py tests/unit/__init__.py tests/unit/put_object_data tests/unit/test_args.py tests/unit/test_awsrequest.py tests/unit/test_client.py tests/unit/test_compat.py tests/unit/test_configloader.py tests/unit/test_credentials.py tests/unit/test_endpoint.py tests/unit/test_errorfactory.py tests/unit/test_exceptions.py tests/unit/test_handlers.py tests/unit/test_hooks.py tests/unit/test_idempotency.py tests/unit/test_loaders.py tests/unit/test_model.py tests/unit/test_paginate.py tests/unit/test_parsers.py tests/unit/test_protocols.py tests/unit/test_regions.py tests/unit/test_response.py tests/unit/test_retryhandler.py tests/unit/test_s3_addressing.py tests/unit/test_serialize.py tests/unit/test_session.py tests/unit/test_signers.py tests/unit/test_stub.py tests/unit/test_translate.py tests/unit/test_utils.py tests/unit/test_validate.py tests/unit/test_waiters.py tests/unit/auth/__init__.py tests/unit/auth/test_signers.py tests/unit/auth/test_sigv4.py tests/unit/auth/aws4_testsuite/get-header-key-duplicate.authz tests/unit/auth/aws4_testsuite/get-header-key-duplicate.creq tests/unit/auth/aws4_testsuite/get-header-key-duplicate.req tests/unit/auth/aws4_testsuite/get-header-key-duplicate.sreq tests/unit/auth/aws4_testsuite/get-header-key-duplicate.sts tests/unit/auth/aws4_testsuite/get-header-value-order.authz tests/unit/auth/aws4_testsuite/get-header-value-order.creq tests/unit/auth/aws4_testsuite/get-header-value-order.req tests/unit/auth/aws4_testsuite/get-header-value-order.sreq tests/unit/auth/aws4_testsuite/get-header-value-order.sts tests/unit/auth/aws4_testsuite/get-header-value-trim.authz tests/unit/auth/aws4_testsuite/get-header-value-trim.creq tests/unit/auth/aws4_testsuite/get-header-value-trim.req tests/unit/auth/aws4_testsuite/get-header-value-trim.sreq tests/unit/auth/aws4_testsuite/get-header-value-trim.sts tests/unit/auth/aws4_testsuite/get-relative-relative.authz tests/unit/auth/aws4_testsuite/get-relative-relative.creq tests/unit/auth/aws4_testsuite/get-relative-relative.req tests/unit/auth/aws4_testsuite/get-relative-relative.sreq tests/unit/auth/aws4_testsuite/get-relative-relative.sts tests/unit/auth/aws4_testsuite/get-relative.authz tests/unit/auth/aws4_testsuite/get-relative.creq tests/unit/auth/aws4_testsuite/get-relative.req tests/unit/auth/aws4_testsuite/get-relative.sreq tests/unit/auth/aws4_testsuite/get-relative.sts tests/unit/auth/aws4_testsuite/get-slash-dot-slash.authz tests/unit/auth/aws4_testsuite/get-slash-dot-slash.creq tests/unit/auth/aws4_testsuite/get-slash-dot-slash.req tests/unit/auth/aws4_testsuite/get-slash-dot-slash.sreq tests/unit/auth/aws4_testsuite/get-slash-dot-slash.sts tests/unit/auth/aws4_testsuite/get-slash-pointless-dot.authz tests/unit/auth/aws4_testsuite/get-slash-pointless-dot.creq tests/unit/auth/aws4_testsuite/get-slash-pointless-dot.req tests/unit/auth/aws4_testsuite/get-slash-pointless-dot.sreq tests/unit/auth/aws4_testsuite/get-slash-pointless-dot.sts tests/unit/auth/aws4_testsuite/get-slash.authz tests/unit/auth/aws4_testsuite/get-slash.creq tests/unit/auth/aws4_testsuite/get-slash.req tests/unit/auth/aws4_testsuite/get-slash.sreq tests/unit/auth/aws4_testsuite/get-slash.sts tests/unit/auth/aws4_testsuite/get-slashes.authz tests/unit/auth/aws4_testsuite/get-slashes.creq tests/unit/auth/aws4_testsuite/get-slashes.req tests/unit/auth/aws4_testsuite/get-slashes.sreq tests/unit/auth/aws4_testsuite/get-slashes.sts tests/unit/auth/aws4_testsuite/get-space.authz tests/unit/auth/aws4_testsuite/get-space.creq tests/unit/auth/aws4_testsuite/get-space.req tests/unit/auth/aws4_testsuite/get-space.sreq tests/unit/auth/aws4_testsuite/get-space.sts tests/unit/auth/aws4_testsuite/get-unreserved.authz tests/unit/auth/aws4_testsuite/get-unreserved.creq tests/unit/auth/aws4_testsuite/get-unreserved.req tests/unit/auth/aws4_testsuite/get-unreserved.sreq tests/unit/auth/aws4_testsuite/get-unreserved.sts tests/unit/auth/aws4_testsuite/get-utf8.authz tests/unit/auth/aws4_testsuite/get-utf8.creq tests/unit/auth/aws4_testsuite/get-utf8.req tests/unit/auth/aws4_testsuite/get-utf8.sreq tests/unit/auth/aws4_testsuite/get-utf8.sts tests/unit/auth/aws4_testsuite/get-vanilla-empty-query-key.authz tests/unit/auth/aws4_testsuite/get-vanilla-empty-query-key.creq tests/unit/auth/aws4_testsuite/get-vanilla-empty-query-key.req tests/unit/auth/aws4_testsuite/get-vanilla-empty-query-key.sreq tests/unit/auth/aws4_testsuite/get-vanilla-empty-query-key.sts tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key-case.authz tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key-case.creq tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key-case.req tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key-case.sreq tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key-case.sts tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key.authz tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key.creq tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key.req tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key.sreq tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key.sts tests/unit/auth/aws4_testsuite/get-vanilla-query-order-value.authz tests/unit/auth/aws4_testsuite/get-vanilla-query-order-value.creq tests/unit/auth/aws4_testsuite/get-vanilla-query-order-value.req tests/unit/auth/aws4_testsuite/get-vanilla-query-order-value.sreq tests/unit/auth/aws4_testsuite/get-vanilla-query-order-value.sts tests/unit/auth/aws4_testsuite/get-vanilla-query-unreserved.authz tests/unit/auth/aws4_testsuite/get-vanilla-query-unreserved.creq tests/unit/auth/aws4_testsuite/get-vanilla-query-unreserved.req tests/unit/auth/aws4_testsuite/get-vanilla-query-unreserved.sreq tests/unit/auth/aws4_testsuite/get-vanilla-query-unreserved.sts tests/unit/auth/aws4_testsuite/get-vanilla-query.authz tests/unit/auth/aws4_testsuite/get-vanilla-query.creq tests/unit/auth/aws4_testsuite/get-vanilla-query.req tests/unit/auth/aws4_testsuite/get-vanilla-query.sreq tests/unit/auth/aws4_testsuite/get-vanilla-query.sts tests/unit/auth/aws4_testsuite/get-vanilla-ut8-query.authz tests/unit/auth/aws4_testsuite/get-vanilla-ut8-query.creq tests/unit/auth/aws4_testsuite/get-vanilla-ut8-query.req tests/unit/auth/aws4_testsuite/get-vanilla-ut8-query.sreq tests/unit/auth/aws4_testsuite/get-vanilla-ut8-query.sts tests/unit/auth/aws4_testsuite/get-vanilla.authz tests/unit/auth/aws4_testsuite/get-vanilla.creq tests/unit/auth/aws4_testsuite/get-vanilla.req tests/unit/auth/aws4_testsuite/get-vanilla.sreq tests/unit/auth/aws4_testsuite/get-vanilla.sts tests/unit/auth/aws4_testsuite/post-header-key-case.authz tests/unit/auth/aws4_testsuite/post-header-key-case.creq tests/unit/auth/aws4_testsuite/post-header-key-case.req tests/unit/auth/aws4_testsuite/post-header-key-case.sreq tests/unit/auth/aws4_testsuite/post-header-key-case.sts tests/unit/auth/aws4_testsuite/post-header-key-sort.authz tests/unit/auth/aws4_testsuite/post-header-key-sort.creq tests/unit/auth/aws4_testsuite/post-header-key-sort.req tests/unit/auth/aws4_testsuite/post-header-key-sort.sreq tests/unit/auth/aws4_testsuite/post-header-key-sort.sts tests/unit/auth/aws4_testsuite/post-header-value-case.authz tests/unit/auth/aws4_testsuite/post-header-value-case.creq tests/unit/auth/aws4_testsuite/post-header-value-case.req tests/unit/auth/aws4_testsuite/post-header-value-case.sreq tests/unit/auth/aws4_testsuite/post-header-value-case.sts tests/unit/auth/aws4_testsuite/post-vanilla-empty-query-value.authz tests/unit/auth/aws4_testsuite/post-vanilla-empty-query-value.creq tests/unit/auth/aws4_testsuite/post-vanilla-empty-query-value.req tests/unit/auth/aws4_testsuite/post-vanilla-empty-query-value.sreq tests/unit/auth/aws4_testsuite/post-vanilla-empty-query-value.sts tests/unit/auth/aws4_testsuite/post-vanilla-query-nonunreserved.authz tests/unit/auth/aws4_testsuite/post-vanilla-query-nonunreserved.creq tests/unit/auth/aws4_testsuite/post-vanilla-query-nonunreserved.req tests/unit/auth/aws4_testsuite/post-vanilla-query-nonunreserved.sreq tests/unit/auth/aws4_testsuite/post-vanilla-query-nonunreserved.sts tests/unit/auth/aws4_testsuite/post-vanilla-query-space.authz tests/unit/auth/aws4_testsuite/post-vanilla-query-space.creq tests/unit/auth/aws4_testsuite/post-vanilla-query-space.req tests/unit/auth/aws4_testsuite/post-vanilla-query-space.sreq tests/unit/auth/aws4_testsuite/post-vanilla-query-space.sts tests/unit/auth/aws4_testsuite/post-vanilla-query.authz tests/unit/auth/aws4_testsuite/post-vanilla-query.creq tests/unit/auth/aws4_testsuite/post-vanilla-query.req tests/unit/auth/aws4_testsuite/post-vanilla-query.sreq tests/unit/auth/aws4_testsuite/post-vanilla-query.sts tests/unit/auth/aws4_testsuite/post-vanilla.authz tests/unit/auth/aws4_testsuite/post-vanilla.creq tests/unit/auth/aws4_testsuite/post-vanilla.req tests/unit/auth/aws4_testsuite/post-vanilla.sreq tests/unit/auth/aws4_testsuite/post-vanilla.sts tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded-parameters.authz tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded-parameters.creq tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded-parameters.req tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded-parameters.sreq tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded-parameters.sts tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded.authz tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded.creq tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded.req tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded.sreq tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded.sts tests/unit/cfg/aws_bad_profile tests/unit/cfg/aws_config tests/unit/cfg/aws_config_bad tests/unit/cfg/aws_config_nested tests/unit/cfg/aws_config_nested_bad tests/unit/cfg/aws_config_nocreds tests/unit/cfg/aws_config_other tests/unit/cfg/aws_credentials tests/unit/cfg/aws_third_config tests/unit/cfg/boto_config tests/unit/cfg/boto_config_empty tests/unit/cfg/foo_config tests/unit/data/baz.json tests/unit/data/foo.json tests/unit/data/non_ascii.json tests/unit/data/aws/s3/2006-03-01.normal.json tests/unit/data/someservice/2012-10-01.normal.json tests/unit/data/someservice/2013-08-21.normal.json tests/unit/data/sub/fie.normal.json tests/unit/data_overrides/someservice/2012-10-01.json tests/unit/docs/__init__.py tests/unit/docs/test_client.py tests/unit/docs/test_docs.py tests/unit/docs/test_docstring.py tests/unit/docs/test_example.py tests/unit/docs/test_method.py tests/unit/docs/test_paginator.py tests/unit/docs/test_params.py tests/unit/docs/test_service.py tests/unit/docs/test_sharedexample.py tests/unit/docs/test_utils.py tests/unit/docs/test_waiter.py tests/unit/docs/bcdoc/__init__.py tests/unit/docs/bcdoc/test_docstringparser.py tests/unit/docs/bcdoc/test_document.py tests/unit/docs/bcdoc/test_style.py tests/unit/protocols/input/ec2.json tests/unit/protocols/input/json.json tests/unit/protocols/input/query.json tests/unit/protocols/input/rest-json.json tests/unit/protocols/input/rest-xml.json tests/unit/protocols/output/ec2.json tests/unit/protocols/output/json.json tests/unit/protocols/output/query.json tests/unit/protocols/output/rest-json.json tests/unit/protocols/output/rest-xml.json tests/unit/response_parsing/README.rst tests/unit/response_parsing/__init__.py tests/unit/response_parsing/test_response_parsing.py tests/unit/response_parsing/json/errors/datapipeline-create-pipeline.json tests/unit/response_parsing/json/errors/directconnect-delete-connection.json tests/unit/response_parsing/json/errors/dynamodb-put-item.json tests/unit/response_parsing/json/errors/elastictranscoder-delete-pipeline.json tests/unit/response_parsing/json/errors/opsworks-delete-stack.json tests/unit/response_parsing/json/errors/storagegateway-delete-gateway.json tests/unit/response_parsing/json/errors/swf-deprecate-domain.json tests/unit/response_parsing/json/expected/datapipeline-create-pipeline.json tests/unit/response_parsing/json/expected/directconnect-delete-connection.json tests/unit/response_parsing/json/expected/dynamodb-put-item.json tests/unit/response_parsing/json/expected/elastictranscoder-delete-pipeline.json tests/unit/response_parsing/json/expected/elastictranscoder-list-pipelines.json tests/unit/response_parsing/json/expected/opsworks-delete-stack.json tests/unit/response_parsing/json/expected/storagegateway-delete-gateway.json tests/unit/response_parsing/json/expected/swf-deprecate-domain.json tests/unit/response_parsing/xml/errors/autoscaling-delete-policy.json tests/unit/response_parsing/xml/errors/autoscaling-delete-policy.xml tests/unit/response_parsing/xml/errors/cloudformation-cancel-update-stack.json tests/unit/response_parsing/xml/errors/cloudformation-cancel-update-stack.xml tests/unit/response_parsing/xml/errors/cloudwatch-describe-alarm-history.json tests/unit/response_parsing/xml/errors/cloudwatch-describe-alarm-history.xml tests/unit/response_parsing/xml/errors/ec2-describe-instances.json tests/unit/response_parsing/xml/errors/ec2-describe-instances.xml tests/unit/response_parsing/xml/errors/elb-describe-load-balancers.json tests/unit/response_parsing/xml/errors/elb-describe-load-balancers.xml tests/unit/response_parsing/xml/errors/iam-get-user.json tests/unit/response_parsing/xml/errors/iam-get-user.xml tests/unit/response_parsing/xml/errors/importexport-get-status.json tests/unit/response_parsing/xml/errors/importexport-get-status.xml tests/unit/response_parsing/xml/errors/rds-describe-db-instances.json tests/unit/response_parsing/xml/errors/rds-describe-db-instances.xml tests/unit/response_parsing/xml/errors/route53-get-hosted-zone.json tests/unit/response_parsing/xml/errors/route53-get-hosted-zone.xml tests/unit/response_parsing/xml/errors/s3-create-bucket.json tests/unit/response_parsing/xml/errors/s3-create-bucket.xml tests/unit/response_parsing/xml/errors/s3-list-objects.json tests/unit/response_parsing/xml/errors/s3-list-objects.xml tests/unit/response_parsing/xml/errors/ses-delete-identity.json tests/unit/response_parsing/xml/errors/ses-delete-identity.xml tests/unit/response_parsing/xml/errors/sns-delete-topic.json tests/unit/response_parsing/xml/errors/sns-delete-topic.xml tests/unit/response_parsing/xml/errors/sqs-delete-queue.json tests/unit/response_parsing/xml/errors/sqs-delete-queue.xml tests/unit/response_parsing/xml/errors/sts-get-session-token.json tests/unit/response_parsing/xml/errors/sts-get-session-token.xml tests/unit/response_parsing/xml/responses/autoscaling-describe-adjustment-types.json tests/unit/response_parsing/xml/responses/autoscaling-describe-adjustment-types.xml tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-groups.json tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-groups.xml tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-instances.json tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-instances.xml tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-notification-types.json tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-notification-types.xml tests/unit/response_parsing/xml/responses/autoscaling-describe-launch-configurations.json tests/unit/response_parsing/xml/responses/autoscaling-describe-launch-configurations.xml tests/unit/response_parsing/xml/responses/autoscaling-describe-metric-collection-types.json tests/unit/response_parsing/xml/responses/autoscaling-describe-metric-collection-types.xml tests/unit/response_parsing/xml/responses/autoscaling-describe-notification-configurations.json tests/unit/response_parsing/xml/responses/autoscaling-describe-notification-configurations.xml tests/unit/response_parsing/xml/responses/autoscaling-describe-policies.json tests/unit/response_parsing/xml/responses/autoscaling-describe-policies.xml tests/unit/response_parsing/xml/responses/autoscaling-describe-scaling-activities.json tests/unit/response_parsing/xml/responses/autoscaling-describe-scaling-activities.xml tests/unit/response_parsing/xml/responses/autoscaling-describe-scaling-process-types.json tests/unit/response_parsing/xml/responses/autoscaling-describe-scaling-process-types.xml tests/unit/response_parsing/xml/responses/autoscaling-describe-scheduled-actions.json tests/unit/response_parsing/xml/responses/autoscaling-describe-scheduled-actions.xml tests/unit/response_parsing/xml/responses/autoscaling-describe-tags.json tests/unit/response_parsing/xml/responses/autoscaling-describe-tags.xml tests/unit/response_parsing/xml/responses/autoscaling-describe-termination-policy-types.json tests/unit/response_parsing/xml/responses/autoscaling-describe-termination-policy-types.xml tests/unit/response_parsing/xml/responses/cloudformation-describe-stacks.json tests/unit/response_parsing/xml/responses/cloudformation-describe-stacks.xml tests/unit/response_parsing/xml/responses/cloudformation-get-template.json tests/unit/response_parsing/xml/responses/cloudformation-get-template.xml tests/unit/response_parsing/xml/responses/cloudformation-list-stacks.json tests/unit/response_parsing/xml/responses/cloudformation-list-stacks.xml tests/unit/response_parsing/xml/responses/cloudfront-get-cloud-front-origin-access-identity.json tests/unit/response_parsing/xml/responses/cloudfront-get-cloud-front-origin-access-identity.xml tests/unit/response_parsing/xml/responses/cloudfront-get-distribution.json tests/unit/response_parsing/xml/responses/cloudfront-get-distribution.xml tests/unit/response_parsing/xml/responses/cloudfront-get-invalidation.json tests/unit/response_parsing/xml/responses/cloudfront-get-invalidation.xml tests/unit/response_parsing/xml/responses/cloudfront-get-streaming-distribution.json tests/unit/response_parsing/xml/responses/cloudfront-get-streaming-distribution.xml tests/unit/response_parsing/xml/responses/cloudfront-list-cloud-front-origin-access-identities.json tests/unit/response_parsing/xml/responses/cloudfront-list-cloud-front-origin-access-identities.xml tests/unit/response_parsing/xml/responses/cloudfront-list-distributions.json tests/unit/response_parsing/xml/responses/cloudfront-list-distributions.xml tests/unit/response_parsing/xml/responses/cloudfront-list-invalidations.json tests/unit/response_parsing/xml/responses/cloudfront-list-invalidations.xml tests/unit/response_parsing/xml/responses/cloudfront-list-streaming-distributions.json tests/unit/response_parsing/xml/responses/cloudfront-list-streaming-distributions.xml tests/unit/response_parsing/xml/responses/cloudwatch-describe-alarm-history.json tests/unit/response_parsing/xml/responses/cloudwatch-describe-alarm-history.xml tests/unit/response_parsing/xml/responses/cloudwatch-describe-alarms.json tests/unit/response_parsing/xml/responses/cloudwatch-describe-alarms.xml tests/unit/response_parsing/xml/responses/cloudwatch-list-metrics.json tests/unit/response_parsing/xml/responses/cloudwatch-list-metrics.xml tests/unit/response_parsing/xml/responses/ec2-allocate-address.json tests/unit/response_parsing/xml/responses/ec2-allocate-address.xml tests/unit/response_parsing/xml/responses/ec2-assign-private-ip-addresses.json tests/unit/response_parsing/xml/responses/ec2-assign-private-ip-addresses.xml tests/unit/response_parsing/xml/responses/ec2-associate-address.json tests/unit/response_parsing/xml/responses/ec2-associate-address.xml tests/unit/response_parsing/xml/responses/ec2-associate-route-table.json tests/unit/response_parsing/xml/responses/ec2-associate-route-table.xml tests/unit/response_parsing/xml/responses/ec2-attach-volume.json tests/unit/response_parsing/xml/responses/ec2-attach-volume.xml tests/unit/response_parsing/xml/responses/ec2-attach-vpn-gateway.json tests/unit/response_parsing/xml/responses/ec2-attach-vpn-gateway.xml tests/unit/response_parsing/xml/responses/ec2-bundle-instance.json tests/unit/response_parsing/xml/responses/ec2-bundle-instance.xml tests/unit/response_parsing/xml/responses/ec2-cancel-bundle-task.json tests/unit/response_parsing/xml/responses/ec2-cancel-bundle-task.xml tests/unit/response_parsing/xml/responses/ec2-cancel-reserved-instances-listing.json tests/unit/response_parsing/xml/responses/ec2-cancel-reserved-instances-listing.xml tests/unit/response_parsing/xml/responses/ec2-cancel-spot-instance-requests.json tests/unit/response_parsing/xml/responses/ec2-cancel-spot-instance-requests.xml tests/unit/response_parsing/xml/responses/ec2-confirm-product-instance.json tests/unit/response_parsing/xml/responses/ec2-confirm-product-instance.xml tests/unit/response_parsing/xml/responses/ec2-copy-snapshot.json tests/unit/response_parsing/xml/responses/ec2-copy-snapshot.xml tests/unit/response_parsing/xml/responses/ec2-create-customer-gateway.json tests/unit/response_parsing/xml/responses/ec2-create-customer-gateway.xml tests/unit/response_parsing/xml/responses/ec2-create-dhcp-options.json tests/unit/response_parsing/xml/responses/ec2-create-dhcp-options.xml tests/unit/response_parsing/xml/responses/ec2-create-instance-export-task.json tests/unit/response_parsing/xml/responses/ec2-create-instance-export-task.xml tests/unit/response_parsing/xml/responses/ec2-create-key-pair.json tests/unit/response_parsing/xml/responses/ec2-create-key-pair.xml tests/unit/response_parsing/xml/responses/ec2-create-network-acl.json tests/unit/response_parsing/xml/responses/ec2-create-network-acl.xml tests/unit/response_parsing/xml/responses/ec2-create-network-interface.json tests/unit/response_parsing/xml/responses/ec2-create-network-interface.xml tests/unit/response_parsing/xml/responses/ec2-create-reserved-instances-listing.json tests/unit/response_parsing/xml/responses/ec2-create-reserved-instances-listing.xml tests/unit/response_parsing/xml/responses/ec2-create-route-table.json tests/unit/response_parsing/xml/responses/ec2-create-route-table.xml tests/unit/response_parsing/xml/responses/ec2-create-snapshot.json tests/unit/response_parsing/xml/responses/ec2-create-snapshot.xml tests/unit/response_parsing/xml/responses/ec2-create-spot-datafeed-subscription.json tests/unit/response_parsing/xml/responses/ec2-create-spot-datafeed-subscription.xml tests/unit/response_parsing/xml/responses/ec2-create-subnet.json tests/unit/response_parsing/xml/responses/ec2-create-subnet.xml tests/unit/response_parsing/xml/responses/ec2-create-volume.json tests/unit/response_parsing/xml/responses/ec2-create-volume.xml tests/unit/response_parsing/xml/responses/ec2-create-vpc.json tests/unit/response_parsing/xml/responses/ec2-create-vpc.xml tests/unit/response_parsing/xml/responses/ec2-create-vpn-gateway.json tests/unit/response_parsing/xml/responses/ec2-create-vpn-gateway.xml tests/unit/response_parsing/xml/responses/ec2-delete-internet-gateway.json tests/unit/response_parsing/xml/responses/ec2-delete-internet-gateway.xml tests/unit/response_parsing/xml/responses/ec2-describe-account-attributes.json tests/unit/response_parsing/xml/responses/ec2-describe-account-attributes.xml tests/unit/response_parsing/xml/responses/ec2-describe-addresses.json tests/unit/response_parsing/xml/responses/ec2-describe-addresses.xml tests/unit/response_parsing/xml/responses/ec2-describe-availability-zones.json tests/unit/response_parsing/xml/responses/ec2-describe-availability-zones.xml tests/unit/response_parsing/xml/responses/ec2-describe-bundle-tasks.json tests/unit/response_parsing/xml/responses/ec2-describe-bundle-tasks.xml tests/unit/response_parsing/xml/responses/ec2-describe-customer-gateways.json tests/unit/response_parsing/xml/responses/ec2-describe-customer-gateways.xml tests/unit/response_parsing/xml/responses/ec2-describe-dhcp-options.json tests/unit/response_parsing/xml/responses/ec2-describe-dhcp-options.xml tests/unit/response_parsing/xml/responses/ec2-describe-export-tasks.json tests/unit/response_parsing/xml/responses/ec2-describe-export-tasks.xml tests/unit/response_parsing/xml/responses/ec2-describe-instance-attribute.json tests/unit/response_parsing/xml/responses/ec2-describe-instance-attribute.xml tests/unit/response_parsing/xml/responses/ec2-describe-instance-status.json tests/unit/response_parsing/xml/responses/ec2-describe-instance-status.xml tests/unit/response_parsing/xml/responses/ec2-describe-instances.json tests/unit/response_parsing/xml/responses/ec2-describe-instances.xml tests/unit/response_parsing/xml/responses/ec2-describe-internet-gateways.json tests/unit/response_parsing/xml/responses/ec2-describe-internet-gateways.xml tests/unit/response_parsing/xml/responses/ec2-describe-key-pairs.json tests/unit/response_parsing/xml/responses/ec2-describe-key-pairs.xml tests/unit/response_parsing/xml/responses/ec2-describe-network-acls.json tests/unit/response_parsing/xml/responses/ec2-describe-network-acls.xml tests/unit/response_parsing/xml/responses/ec2-describe-network-interfaces.json tests/unit/response_parsing/xml/responses/ec2-describe-network-interfaces.xml tests/unit/response_parsing/xml/responses/ec2-describe-placement-groups.json tests/unit/response_parsing/xml/responses/ec2-describe-placement-groups.xml tests/unit/response_parsing/xml/responses/ec2-describe-regions.json tests/unit/response_parsing/xml/responses/ec2-describe-regions.xml tests/unit/response_parsing/xml/responses/ec2-describe-reserved-instances-offerings.json tests/unit/response_parsing/xml/responses/ec2-describe-reserved-instances-offerings.xml tests/unit/response_parsing/xml/responses/ec2-describe-reserved-instances.json tests/unit/response_parsing/xml/responses/ec2-describe-reserved-instances.xml tests/unit/response_parsing/xml/responses/ec2-describe-route-tables.json tests/unit/response_parsing/xml/responses/ec2-describe-route-tables.xml tests/unit/response_parsing/xml/responses/ec2-describe-security-groups.json tests/unit/response_parsing/xml/responses/ec2-describe-security-groups.xml tests/unit/response_parsing/xml/responses/ec2-describe-snapshots.json tests/unit/response_parsing/xml/responses/ec2-describe-snapshots.xml tests/unit/response_parsing/xml/responses/ec2-describe-spot-instance-requests.json tests/unit/response_parsing/xml/responses/ec2-describe-spot-instance-requests.xml tests/unit/response_parsing/xml/responses/ec2-describe-spot-price-history.json tests/unit/response_parsing/xml/responses/ec2-describe-spot-price-history.xml tests/unit/response_parsing/xml/responses/ec2-describe-subnets.json tests/unit/response_parsing/xml/responses/ec2-describe-subnets.xml tests/unit/response_parsing/xml/responses/ec2-describe-tags.json tests/unit/response_parsing/xml/responses/ec2-describe-tags.xml tests/unit/response_parsing/xml/responses/ec2-describe-volume-status.json tests/unit/response_parsing/xml/responses/ec2-describe-volume-status.xml tests/unit/response_parsing/xml/responses/ec2-describe-volumes.json tests/unit/response_parsing/xml/responses/ec2-describe-volumes.xml tests/unit/response_parsing/xml/responses/ec2-describe-vpcs.json tests/unit/response_parsing/xml/responses/ec2-describe-vpcs.xml tests/unit/response_parsing/xml/responses/ec2-describe-vpn-connections.json tests/unit/response_parsing/xml/responses/ec2-describe-vpn-connections.xml tests/unit/response_parsing/xml/responses/ec2-describe-vpn-gateways.json tests/unit/response_parsing/xml/responses/ec2-describe-vpn-gateways.xml tests/unit/response_parsing/xml/responses/ec2-detach-network-interface.json tests/unit/response_parsing/xml/responses/ec2-detach-network-interface.xml tests/unit/response_parsing/xml/responses/ec2-detach-volume.json tests/unit/response_parsing/xml/responses/ec2-detach-volume.xml tests/unit/response_parsing/xml/responses/ec2-get-password-data.json tests/unit/response_parsing/xml/responses/ec2-get-password-data.xml tests/unit/response_parsing/xml/responses/ec2-import-instance.json tests/unit/response_parsing/xml/responses/ec2-import-instance.xml tests/unit/response_parsing/xml/responses/ec2-import-key-pair.json tests/unit/response_parsing/xml/responses/ec2-import-key-pair.xml tests/unit/response_parsing/xml/responses/ec2-import-volume.json tests/unit/response_parsing/xml/responses/ec2-import-volume.xml tests/unit/response_parsing/xml/responses/ec2-modify-snapshot-attribute.json tests/unit/response_parsing/xml/responses/ec2-modify-snapshot-attribute.xml tests/unit/response_parsing/xml/responses/ec2-monitor-instances.json tests/unit/response_parsing/xml/responses/ec2-monitor-instances.xml tests/unit/response_parsing/xml/responses/ec2-register-image.json tests/unit/response_parsing/xml/responses/ec2-register-image.xml tests/unit/response_parsing/xml/responses/ec2-replace-network-acl-association.json tests/unit/response_parsing/xml/responses/ec2-replace-network-acl-association.xml tests/unit/response_parsing/xml/responses/ec2-request-spot-instances.json tests/unit/response_parsing/xml/responses/ec2-request-spot-instances.xml tests/unit/response_parsing/xml/responses/ec2-run-instances.json tests/unit/response_parsing/xml/responses/ec2-run-instances.xml tests/unit/response_parsing/xml/responses/ec2-start-instances.json tests/unit/response_parsing/xml/responses/ec2-start-instances.xml tests/unit/response_parsing/xml/responses/ec2-stop-instances.json tests/unit/response_parsing/xml/responses/ec2-stop-instances.xml tests/unit/response_parsing/xml/responses/ec2-unmonitor-instances.json tests/unit/response_parsing/xml/responses/ec2-unmonitor-instances.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-check-dns-availability.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-check-dns-availability.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-application-version.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-application-version.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-application.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-application.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-configuration-template.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-configuration-template.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-environment.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-environment.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-storage-location.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-storage-location.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-delete-application.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-delete-application.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-application-versions.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-application-versions.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-applications.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-applications.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-configuration-options.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-configuration-options.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-environments.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-environments.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-events.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-events.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-list-available-solution-stacks.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-list-available-solution-stacks.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-retrieve-environment-info.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-retrieve-environment-info.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-terminate-environment.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-terminate-environment.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-update-application-version.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-update-application-version.xml tests/unit/response_parsing/xml/responses/elasticbeanstalk-update-application.json tests/unit/response_parsing/xml/responses/elasticbeanstalk-update-application.xml tests/unit/response_parsing/xml/responses/elb-describe-load-balancer-policies.json tests/unit/response_parsing/xml/responses/elb-describe-load-balancer-policies.xml tests/unit/response_parsing/xml/responses/elb-describe-load-balancer-policy-types.json tests/unit/response_parsing/xml/responses/elb-describe-load-balancer-policy-types.xml tests/unit/response_parsing/xml/responses/elb-describe-load-balancers.json tests/unit/response_parsing/xml/responses/elb-describe-load-balancers.xml tests/unit/response_parsing/xml/responses/iam-create-virtual-mfa-device.json tests/unit/response_parsing/xml/responses/iam-create-virtual-mfa-device.xml tests/unit/response_parsing/xml/responses/iam-get-account-summary.json tests/unit/response_parsing/xml/responses/iam-get-account-summary.xml tests/unit/response_parsing/xml/responses/iam-get-group.json tests/unit/response_parsing/xml/responses/iam-get-group.xml tests/unit/response_parsing/xml/responses/iam-get-user-policy.json tests/unit/response_parsing/xml/responses/iam-get-user-policy.xml tests/unit/response_parsing/xml/responses/iam-get-user.json tests/unit/response_parsing/xml/responses/iam-get-user.xml tests/unit/response_parsing/xml/responses/iam-list-access-keys.json tests/unit/response_parsing/xml/responses/iam-list-access-keys.xml tests/unit/response_parsing/xml/responses/iam-list-account-aliases.json tests/unit/response_parsing/xml/responses/iam-list-account-aliases.xml tests/unit/response_parsing/xml/responses/iam-list-groups.json tests/unit/response_parsing/xml/responses/iam-list-groups.xml tests/unit/response_parsing/xml/responses/iam-list-instance-profiles.json tests/unit/response_parsing/xml/responses/iam-list-instance-profiles.xml tests/unit/response_parsing/xml/responses/iam-list-mfa-devices.json tests/unit/response_parsing/xml/responses/iam-list-mfa-devices.xml tests/unit/response_parsing/xml/responses/iam-list-roles.json tests/unit/response_parsing/xml/responses/iam-list-roles.xml tests/unit/response_parsing/xml/responses/iam-list-server-certificates.json tests/unit/response_parsing/xml/responses/iam-list-server-certificates.xml tests/unit/response_parsing/xml/responses/iam-list-signing-certificates.json tests/unit/response_parsing/xml/responses/iam-list-signing-certificates.xml tests/unit/response_parsing/xml/responses/iam-list-users.json tests/unit/response_parsing/xml/responses/iam-list-users.xml tests/unit/response_parsing/xml/responses/iam-list-virtual-mfa-devices.json tests/unit/response_parsing/xml/responses/iam-list-virtual-mfa-devices.xml tests/unit/response_parsing/xml/responses/importexport-list-jobs.json tests/unit/response_parsing/xml/responses/importexport-list-jobs.xml tests/unit/response_parsing/xml/responses/rds-describe-db-engine-versions.json tests/unit/response_parsing/xml/responses/rds-describe-db-engine-versions.xml tests/unit/response_parsing/xml/responses/rds-describe-db-instances.json tests/unit/response_parsing/xml/responses/rds-describe-db-instances.xml tests/unit/response_parsing/xml/responses/rds-describe-db-parameter-groups.json tests/unit/response_parsing/xml/responses/rds-describe-db-parameter-groups.xml tests/unit/response_parsing/xml/responses/rds-describe-db-security-groups.json tests/unit/response_parsing/xml/responses/rds-describe-db-security-groups.xml tests/unit/response_parsing/xml/responses/rds-describe-db-snapshots.json tests/unit/response_parsing/xml/responses/rds-describe-db-snapshots.xml tests/unit/response_parsing/xml/responses/rds-describe-db-subnet-groups.json tests/unit/response_parsing/xml/responses/rds-describe-db-subnet-groups.xml tests/unit/response_parsing/xml/responses/rds-describe-event-categories.json tests/unit/response_parsing/xml/responses/rds-describe-event-categories.xml tests/unit/response_parsing/xml/responses/rds-describe-event-subscriptions.json tests/unit/response_parsing/xml/responses/rds-describe-event-subscriptions.xml tests/unit/response_parsing/xml/responses/rds-describe-events.json tests/unit/response_parsing/xml/responses/rds-describe-events.xml tests/unit/response_parsing/xml/responses/rds-describe-option-groups.json tests/unit/response_parsing/xml/responses/rds-describe-option-groups.xml tests/unit/response_parsing/xml/responses/rds-describe-reserved-db-instances-offerings.json tests/unit/response_parsing/xml/responses/rds-describe-reserved-db-instances-offerings.xml tests/unit/response_parsing/xml/responses/rds-describe-reserved-db-instances.json tests/unit/response_parsing/xml/responses/rds-describe-reserved-db-instances.xml tests/unit/response_parsing/xml/responses/redshift-authorize-cluster-security-group-ingress.json tests/unit/response_parsing/xml/responses/redshift-authorize-cluster-security-group-ingress.xml tests/unit/response_parsing/xml/responses/redshift-copy-cluster-snapshot.json tests/unit/response_parsing/xml/responses/redshift-copy-cluster-snapshot.xml tests/unit/response_parsing/xml/responses/redshift-create-cluster-parameter-group.json tests/unit/response_parsing/xml/responses/redshift-create-cluster-parameter-group.xml tests/unit/response_parsing/xml/responses/redshift-create-cluster-security-group.json tests/unit/response_parsing/xml/responses/redshift-create-cluster-security-group.xml tests/unit/response_parsing/xml/responses/redshift-create-cluster-snapshot.json tests/unit/response_parsing/xml/responses/redshift-create-cluster-snapshot.xml tests/unit/response_parsing/xml/responses/redshift-create-cluster-subnet-group.json tests/unit/response_parsing/xml/responses/redshift-create-cluster-subnet-group.xml tests/unit/response_parsing/xml/responses/redshift-create-cluster.json tests/unit/response_parsing/xml/responses/redshift-create-cluster.xml tests/unit/response_parsing/xml/responses/redshift-delete-cluster-parameter-group.json tests/unit/response_parsing/xml/responses/redshift-delete-cluster-parameter-group.xml tests/unit/response_parsing/xml/responses/redshift-delete-cluster-snapshot.json tests/unit/response_parsing/xml/responses/redshift-delete-cluster-snapshot.xml tests/unit/response_parsing/xml/responses/redshift-delete-cluster.json tests/unit/response_parsing/xml/responses/redshift-delete-cluster.xml tests/unit/response_parsing/xml/responses/redshift-describe-cluster-parameter-groups.json tests/unit/response_parsing/xml/responses/redshift-describe-cluster-parameter-groups.xml tests/unit/response_parsing/xml/responses/redshift-describe-cluster-parameters.json tests/unit/response_parsing/xml/responses/redshift-describe-cluster-parameters.xml tests/unit/response_parsing/xml/responses/redshift-describe-cluster-security-groups.json tests/unit/response_parsing/xml/responses/redshift-describe-cluster-security-groups.xml tests/unit/response_parsing/xml/responses/redshift-describe-cluster-snapshots.json tests/unit/response_parsing/xml/responses/redshift-describe-cluster-snapshots.xml tests/unit/response_parsing/xml/responses/redshift-describe-cluster-subnet-groups.json tests/unit/response_parsing/xml/responses/redshift-describe-cluster-subnet-groups.xml tests/unit/response_parsing/xml/responses/redshift-describe-cluster-versions.json tests/unit/response_parsing/xml/responses/redshift-describe-cluster-versions.xml tests/unit/response_parsing/xml/responses/redshift-describe-clusters.json tests/unit/response_parsing/xml/responses/redshift-describe-clusters.xml tests/unit/response_parsing/xml/responses/redshift-describe-events.json tests/unit/response_parsing/xml/responses/redshift-describe-events.xml tests/unit/response_parsing/xml/responses/redshift-describe-orderable-cluster-options.json tests/unit/response_parsing/xml/responses/redshift-describe-orderable-cluster-options.xml tests/unit/response_parsing/xml/responses/redshift-describe-reserved-node-offerings.json tests/unit/response_parsing/xml/responses/redshift-describe-reserved-node-offerings.xml tests/unit/response_parsing/xml/responses/redshift-describe-reserved-nodes.json tests/unit/response_parsing/xml/responses/redshift-describe-reserved-nodes.xml tests/unit/response_parsing/xml/responses/redshift-describe-resize.json tests/unit/response_parsing/xml/responses/redshift-describe-resize.xml tests/unit/response_parsing/xml/responses/redshift-modify-cluster-parameter-group.json tests/unit/response_parsing/xml/responses/redshift-modify-cluster-parameter-group.xml tests/unit/response_parsing/xml/responses/redshift-purchase-reserved-node-offering.json tests/unit/response_parsing/xml/responses/redshift-purchase-reserved-node-offering.xml tests/unit/response_parsing/xml/responses/redshift-reboot-cluster.json tests/unit/response_parsing/xml/responses/redshift-reboot-cluster.xml tests/unit/response_parsing/xml/responses/redshift-reset-cluster-parameter-group.json tests/unit/response_parsing/xml/responses/redshift-reset-cluster-parameter-group.xml tests/unit/response_parsing/xml/responses/redshift-restore-from-cluster-snapshot.json tests/unit/response_parsing/xml/responses/redshift-restore-from-cluster-snapshot.xml tests/unit/response_parsing/xml/responses/redshift-revoke-cluster-security-group-ingress.json tests/unit/response_parsing/xml/responses/redshift-revoke-cluster-security-group-ingress.xml tests/unit/response_parsing/xml/responses/s3-get-bucket-acl.json tests/unit/response_parsing/xml/responses/s3-get-bucket-acl.xml tests/unit/response_parsing/xml/responses/s3-get-bucket-location.json tests/unit/response_parsing/xml/responses/s3-get-bucket-location.xml tests/unit/response_parsing/xml/responses/s3-get-bucket-logging.json tests/unit/response_parsing/xml/responses/s3-get-bucket-logging.xml tests/unit/response_parsing/xml/responses/s3-get-bucket-policy.json tests/unit/response_parsing/xml/responses/s3-get-bucket-policy.xml tests/unit/response_parsing/xml/responses/s3-list-buckets.json tests/unit/response_parsing/xml/responses/s3-list-buckets.xml tests/unit/response_parsing/xml/responses/s3-list-multipart-uploads#2.json tests/unit/response_parsing/xml/responses/s3-list-multipart-uploads#2.xml tests/unit/response_parsing/xml/responses/s3-list-multipart-uploads.json tests/unit/response_parsing/xml/responses/s3-list-multipart-uploads.xml tests/unit/response_parsing/xml/responses/s3-list-object-versions.json tests/unit/response_parsing/xml/responses/s3-list-object-versions.xml tests/unit/response_parsing/xml/responses/s3-list-objects.json tests/unit/response_parsing/xml/responses/s3-list-objects.xml tests/unit/response_parsing/xml/responses/ses-delete-identity.json tests/unit/response_parsing/xml/responses/ses-delete-identity.xml tests/unit/response_parsing/xml/responses/ses-get-identity-dkim-attributes.json tests/unit/response_parsing/xml/responses/ses-get-identity-dkim-attributes.xml tests/unit/response_parsing/xml/responses/ses-get-identity-notification-attributes.json tests/unit/response_parsing/xml/responses/ses-get-identity-notification-attributes.xml tests/unit/response_parsing/xml/responses/ses-get-identity-verification-attributes.json tests/unit/response_parsing/xml/responses/ses-get-identity-verification-attributes.xml tests/unit/response_parsing/xml/responses/ses-get-send-quota.json tests/unit/response_parsing/xml/responses/ses-get-send-quota.xml tests/unit/response_parsing/xml/responses/ses-get-send-statistics.json tests/unit/response_parsing/xml/responses/ses-get-send-statistics.xml tests/unit/response_parsing/xml/responses/ses-list-identities.json tests/unit/response_parsing/xml/responses/ses-list-identities.xml tests/unit/response_parsing/xml/responses/ses-send-email.json tests/unit/response_parsing/xml/responses/ses-send-email.xml tests/unit/response_parsing/xml/responses/ses-send-raw-email.json tests/unit/response_parsing/xml/responses/ses-send-raw-email.xml tests/unit/response_parsing/xml/responses/ses-set-identity-dkim-enabled.json tests/unit/response_parsing/xml/responses/ses-set-identity-dkim-enabled.xml tests/unit/response_parsing/xml/responses/ses-verify-domain-dkim.json tests/unit/response_parsing/xml/responses/ses-verify-domain-dkim.xml tests/unit/response_parsing/xml/responses/ses-verify-domain-identity.json tests/unit/response_parsing/xml/responses/ses-verify-domain-identity.xml tests/unit/response_parsing/xml/responses/sns-add-permission.json tests/unit/response_parsing/xml/responses/sns-add-permission.xml tests/unit/response_parsing/xml/responses/sns-confirm-subscription.json tests/unit/response_parsing/xml/responses/sns-confirm-subscription.xml tests/unit/response_parsing/xml/responses/sns-create-topic.json tests/unit/response_parsing/xml/responses/sns-create-topic.xml tests/unit/response_parsing/xml/responses/sns-get-subscription-attributes.json tests/unit/response_parsing/xml/responses/sns-get-subscription-attributes.xml tests/unit/response_parsing/xml/responses/sns-get-topic-attributes.json tests/unit/response_parsing/xml/responses/sns-get-topic-attributes.xml tests/unit/response_parsing/xml/responses/sns-list-subscriptions-by-topic.json tests/unit/response_parsing/xml/responses/sns-list-subscriptions-by-topic.xml tests/unit/response_parsing/xml/responses/sns-list-subscriptions.json tests/unit/response_parsing/xml/responses/sns-list-subscriptions.xml tests/unit/response_parsing/xml/responses/sns-list-topics.json tests/unit/response_parsing/xml/responses/sns-list-topics.xml tests/unit/response_parsing/xml/responses/sns-publish.json tests/unit/response_parsing/xml/responses/sns-publish.xml tests/unit/response_parsing/xml/responses/sns-subscribe.json tests/unit/response_parsing/xml/responses/sns-subscribe.xml tests/unit/response_parsing/xml/responses/sqs-add-permission.json tests/unit/response_parsing/xml/responses/sqs-add-permission.xml tests/unit/response_parsing/xml/responses/sqs-change-message-visibility-batch.json tests/unit/response_parsing/xml/responses/sqs-change-message-visibility-batch.xml tests/unit/response_parsing/xml/responses/sqs-create-queue.json tests/unit/response_parsing/xml/responses/sqs-create-queue.xml tests/unit/response_parsing/xml/responses/sqs-delete-message-batch.json tests/unit/response_parsing/xml/responses/sqs-delete-message-batch.xml tests/unit/response_parsing/xml/responses/sqs-get-queue-attributes.json tests/unit/response_parsing/xml/responses/sqs-get-queue-attributes.xml tests/unit/response_parsing/xml/responses/sqs-get-queue-url.json tests/unit/response_parsing/xml/responses/sqs-get-queue-url.xml tests/unit/response_parsing/xml/responses/sqs-list-queues.json tests/unit/response_parsing/xml/responses/sqs-list-queues.xml tests/unit/response_parsing/xml/responses/sqs-receive-message.json tests/unit/response_parsing/xml/responses/sqs-receive-message.xml tests/unit/response_parsing/xml/responses/sqs-send-message-batch.json tests/unit/response_parsing/xml/responses/sqs-send-message-batch.xml tests/unit/response_parsing/xml/responses/sqs-send-message.json tests/unit/response_parsing/xml/responses/sqs-send-message.xml tests/unit/response_parsing/xml/responses/sts-get-session-token.json tests/unit/response_parsing/xml/responses/sts-get-session-token.xmlbotocore-1.5.7/botocore.egg-info/top_level.txt0000666454262600001440000000001113042511307022436 0ustar pysdk-ciamazon00000000000000botocore botocore-1.5.7/README.rst0000666454262600001440000000106513042511306016076 0ustar pysdk-ciamazon00000000000000botocore ======== .. image:: https://secure.travis-ci.org/boto/botocore.png?branch=develop :target: http://travis-ci.org/boto/botocore .. image:: https://codecov.io/github/boto/botocore/coverage.svg?branch=develop :target: https://codecov.io/github/boto/botocore?branch=develop A low-level interface to a growing number of Amazon Web Services. The botocore package is the foundation for the `AWS CLI `__ as well as `boto3 `__. `Documentation `__ botocore-1.5.7/tests/0000777454262600001440000000000013042511310015542 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/0000777454262600001440000000000013042511310016521 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/test_retryhandler.py0000666454262600001440000003525213042511306022651 0ustar pysdk-ciamazon00000000000000#!/usr/bin/env # Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest import mock from botocore.vendored.requests import ConnectionError, Timeout from botocore.vendored.requests.packages.urllib3.exceptions import ClosedPoolError from botocore import retryhandler from botocore.exceptions import ChecksumError HTTP_500_RESPONSE = mock.Mock() HTTP_500_RESPONSE.status_code = 500 HTTP_400_RESPONSE = mock.Mock() HTTP_400_RESPONSE.status_code = 400 HTTP_200_RESPONSE = mock.Mock() HTTP_200_RESPONSE.status_code = 200 class TestRetryCheckers(unittest.TestCase): def assert_should_be_retried(self, response, attempt_number=1, caught_exception=None): self.assertTrue(self.checker( response=response, attempt_number=attempt_number, caught_exception=caught_exception)) def assert_should_not_be_retried(self, response, attempt_number=1, caught_exception=None): self.assertFalse(self.checker( response=response, attempt_number=attempt_number, caught_exception=caught_exception)) def test_status_code_checker(self): self.checker = retryhandler.HTTPStatusCodeChecker(500) self.assert_should_be_retried(response=(HTTP_500_RESPONSE, {})) def test_max_attempts(self): self.checker = retryhandler.MaxAttemptsDecorator( retryhandler.HTTPStatusCodeChecker(500), max_attempts=3) response = {'ResponseMetadata': {}} # Retry up to three times. self.assert_should_be_retried( (HTTP_500_RESPONSE, response), attempt_number=1) self.assert_should_be_retried( (HTTP_500_RESPONSE, {}), attempt_number=2) # On the third failed response, we've reached the # max attempts so we should return False. self.assert_should_not_be_retried( (HTTP_500_RESPONSE, response), attempt_number=3) self.assertTrue(response['ResponseMetadata']['MaxAttemptsReached']) def test_max_attempts_successful(self): self.checker = retryhandler.MaxAttemptsDecorator( retryhandler.HTTPStatusCodeChecker(500), max_attempts=3) self.assert_should_be_retried( (HTTP_500_RESPONSE, {}), attempt_number=1) # The second retry is successful. self.assert_should_not_be_retried( (HTTP_200_RESPONSE, {}), attempt_number=2) # But now we can reuse this object. self.assert_should_be_retried( (HTTP_500_RESPONSE, {}), attempt_number=1) self.assert_should_be_retried( (HTTP_500_RESPONSE, {}), attempt_number=2) self.assert_should_not_be_retried( (HTTP_500_RESPONSE, {}), attempt_number=3) def test_error_code_checker(self): self.checker = retryhandler.ServiceErrorCodeChecker( status_code=400, error_code='Throttled') response = (HTTP_400_RESPONSE, {'Error': {'Code': 'Throttled'}}) self.assert_should_be_retried(response) def test_error_code_checker_does_not_match(self): self.checker = retryhandler.ServiceErrorCodeChecker( status_code=400, error_code='Throttled') response = (HTTP_400_RESPONSE, {'Error': {'Code': 'NotThrottled'}}) self.assert_should_not_be_retried(response) def test_error_code_checker_ignore_caught_exception(self): self.checker = retryhandler.ServiceErrorCodeChecker( status_code=400, error_code='Throttled') self.assert_should_not_be_retried(response=None, caught_exception=RuntimeError()) def test_multi_checker(self): checker = retryhandler.ServiceErrorCodeChecker( status_code=400, error_code='Throttled') checker2 = retryhandler.HTTPStatusCodeChecker(500) self.checker = retryhandler.MultiChecker([checker, checker2]) self.assert_should_be_retried((HTTP_500_RESPONSE, {})) self.assert_should_be_retried( response=(HTTP_400_RESPONSE, {'Error': {'Code': 'Throttled'}})) self.assert_should_not_be_retried( response=(HTTP_200_RESPONSE, {})) def test_exception_checker_ignores_response(self): self.checker = retryhandler.ExceptionRaiser() self.assert_should_not_be_retried( response=(HTTP_200_RESPONSE, {}), caught_exception=None) def test_value_error_raised_when_missing_response_and_exception(self): self.checker = retryhandler.ExceptionRaiser() with self.assertRaises(ValueError): self.checker(1, response=None, caught_exception=None) class TestCreateRetryConfiguration(unittest.TestCase): def setUp(self): self.retry_config = { '__default__': { 'max_attempts': 5, 'delay': { 'type': 'exponential', 'base': 1, 'growth_factor': 2, }, 'policies': { 'throttling': { 'applies_when': { 'response': { 'service_error_code': 'Throttling', 'http_status_code': 400, } } } } }, 'OperationFoo': { 'policies': { 'crc32check': { 'applies_when': { 'response': { 'crc32body': 'x-amz-crc32', } } } } }, 'OperationBar': { 'policies': { 'socket_errors': { 'applies_when': { 'socket_errors': ["GENERAL_CONNECTION_ERROR"], } } } }, } def test_create_retry_single_checker_service_level(self): checker = retryhandler.create_checker_from_retry_config( self.retry_config, operation_name=None) self.assertIsInstance(checker, retryhandler.MaxAttemptsDecorator) # We're reaching into internal fields here, but only to check # that the object is created properly. self.assertEqual(checker._max_attempts, 5) self.assertIsInstance(checker._checker, retryhandler.ServiceErrorCodeChecker) self.assertEqual(checker._checker._error_code, 'Throttling') self.assertEqual(checker._checker._status_code, 400) def test_create_retry_for_operation(self): checker = retryhandler.create_checker_from_retry_config( self.retry_config, operation_name='OperationFoo') self.assertIsInstance(checker, retryhandler.MaxAttemptsDecorator) self.assertEqual(checker._max_attempts, 5) self.assertIsInstance(checker._checker, retryhandler.MultiChecker) def test_retry_with_socket_errors(self): checker = retryhandler.create_checker_from_retry_config( self.retry_config, operation_name='OperationBar') self.assertIsInstance(checker, retryhandler.BaseChecker) all_checkers = checker._checker._checkers self.assertIsInstance(all_checkers[0], retryhandler.ServiceErrorCodeChecker) self.assertIsInstance(all_checkers[1], retryhandler.ExceptionRaiser) def test_create_retry_handler_with_socket_errors(self): handler = retryhandler.create_retry_handler( self.retry_config, operation_name='OperationBar') with self.assertRaises(ConnectionError): handler(response=None, attempts=10, caught_exception=ConnectionError()) # No connection error raised because attempts < max_attempts. sleep_time = handler(response=None, attempts=1, caught_exception=ConnectionError()) self.assertEqual(sleep_time, 1) # But any other exception should be raised even if # attempts < max_attempts. with self.assertRaises(ValueError): sleep_time = handler(response=None, attempts=1, caught_exception=ValueError()) def test_connection_timeouts_are_retried(self): # If a connection times out, we get a Timout exception # from requests. We should be retrying those. handler = retryhandler.create_retry_handler( self.retry_config, operation_name='OperationBar') sleep_time = handler(response=None, attempts=1, caught_exception=Timeout()) self.assertEqual(sleep_time, 1) def test_retry_pool_closed_errors(self): # A ClosedPoolError is retried (this is a workaround for a urllib3 # bug). Can be removed once we upgrade to requests 2.0.0. handler = retryhandler.create_retry_handler( self.retry_config, operation_name='OperationBar') # 4th attempt is retried. sleep_time = handler( response=None, attempts=4, caught_exception=ClosedPoolError('FakePool', 'Message')) self.assertEqual(sleep_time, 8) # But the 5th time propogates the error. with self.assertRaises(ClosedPoolError): handler(response=None, attempts=10, caught_exception=ClosedPoolError('FakePool', 'Message')) def test_create_retry_handler_with_no_operation(self): handler = retryhandler.create_retry_handler( self.retry_config, operation_name=None) self.assertIsInstance(handler, retryhandler.RetryHandler) # No good way to test for the delay function as the action # other than to just invoke it. self.assertEqual(handler._action(attempts=2), 2) self.assertEqual(handler._action(attempts=3), 4) def test_crc32_check_propogates_error(self): handler = retryhandler.create_retry_handler( self.retry_config, operation_name='OperationFoo') http_response = mock.Mock() http_response.status_code = 200 # This is not the crc32 of b'foo', so this should # fail the crc32 check. http_response.headers = {'x-amz-crc32': 2356372768} http_response.content = b'foo' # The first 10 attempts we get a retry. self.assertEqual(handler(response=(http_response, {}), attempts=1, caught_exception=None), 1) with self.assertRaises(ChecksumError): handler(response=(http_response, {}), attempts=10, caught_exception=None) class TestRetryHandler(unittest.TestCase): def test_action_tied_to_policy(self): # When a retry rule matches we should return the # amount of time to sleep, otherwise we should return None. delay_function = retryhandler.create_exponential_delay_function( 1, 2) checker = retryhandler.HTTPStatusCodeChecker(500) handler = retryhandler.RetryHandler(checker, delay_function) response = (HTTP_500_RESPONSE, {}) self.assertEqual( handler(response=response, attempts=1, caught_exception=None), 1) self.assertEqual( handler(response=response, attempts=2, caught_exception=None), 2) self.assertEqual( handler(response=response, attempts=3, caught_exception=None), 4) self.assertEqual( handler(response=response, attempts=4, caught_exception=None), 8) def test_none_response_when_no_matches(self): delay_function = retryhandler.create_exponential_delay_function( 1, 2) checker = retryhandler.HTTPStatusCodeChecker(500) handler = retryhandler.RetryHandler(checker, delay_function) response = (HTTP_200_RESPONSE, {}) self.assertIsNone(handler(response=response, attempts=1, caught_exception=None)) class TestCRC32Checker(unittest.TestCase): def setUp(self): self.checker = retryhandler.CRC32Checker('x-amz-crc32') def test_crc32_matches(self): http_response = mock.Mock() http_response.status_code = 200 # This is the crc32 of b'foo', so this should # pass the crc32 check. http_response.headers = {'x-amz-crc32': 2356372769} http_response.content = b'foo' self.assertIsNone(self.checker( response=(http_response, {}), attempt_number=1, caught_exception=None)) def test_crc32_missing(self): # It's not an error is the crc32 header is missing. http_response = mock.Mock() http_response.status_code = 200 http_response.headers = {} self.assertIsNone(self.checker( response=(http_response, {}), attempt_number=1, caught_exception=None)) def test_crc32_check_fails(self): http_response = mock.Mock() http_response.status_code = 200 # This is not the crc32 of b'foo', so this should # fail the crc32 check. http_response.headers = {'x-amz-crc32': 2356372768} http_response.content = b'foo' with self.assertRaises(ChecksumError): self.checker(response=(http_response, {}), attempt_number=1, caught_exception=None) class TestDelayExponential(unittest.TestCase): def test_delay_with_numeric_base(self): self.assertEqual(retryhandler.delay_exponential(base=3, growth_factor=2, attempts=3), 12) def test_delay_with_rand_string(self): delay = retryhandler.delay_exponential(base='rand', growth_factor=2, attempts=3) # 2 ** (3 - 1) == 4, so the retry is between 0, 4. self.assertTrue(0 <= delay <= 4) def test_value_error_raised_with_non_positive_number(self): with self.assertRaises(ValueError): retryhandler.delay_exponential( base=-1, growth_factor=2, attempts=3) if __name__ == "__main__": unittest.main() botocore-1.5.7/tests/unit/test_handlers.py0000666454262600001440000013562213042511306021750 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest, BaseSessionTest import base64 import mock import copy import os import botocore import botocore.session from botocore.exceptions import ParamValidationError, MD5UnavailableError from botocore.exceptions import AliasConflictParameterError from botocore.awsrequest import AWSRequest from botocore.compat import quote, six from botocore.config import Config from botocore.docs.bcdoc.restdoc import DocumentStructure from botocore.docs.params import RequestParamsDocumenter from botocore.docs.example import RequestExampleDocumenter from botocore.hooks import HierarchicalEmitter from botocore.model import OperationModel, ServiceModel from botocore.model import DenormalizedStructureBuilder from botocore.signers import RequestSigner from botocore.credentials import Credentials from botocore import handlers class TestHandlers(BaseSessionTest): def test_get_console_output(self): parsed = {'Output': base64.b64encode(b'foobar').decode('utf-8')} handlers.decode_console_output(parsed) self.assertEqual(parsed['Output'], 'foobar') def test_get_console_output_cant_be_decoded(self): parsed = {'Output': 1} handlers.decode_console_output(parsed) self.assertEqual(parsed['Output'], 1) def test_get_console_output_bad_unicode_errors(self): original = base64.b64encode(b'before\xffafter').decode('utf-8') parsed = {'Output': original} handlers.decode_console_output(parsed) self.assertEqual(parsed['Output'], u'before\ufffdafter') def test_noop_if_output_key_does_not_exist(self): original = {'foo': 'bar'} parsed = original.copy() handlers.decode_console_output(parsed) # Should be unchanged because the 'Output' # key is not in the output. self.assertEqual(parsed, original) def test_decode_quoted_jsondoc(self): value = quote('{"foo":"bar"}') converted_value = handlers.decode_quoted_jsondoc(value) self.assertEqual(converted_value, {'foo': 'bar'}) def test_cant_decode_quoted_jsondoc(self): value = quote('{"foo": "missing end quote}') converted_value = handlers.decode_quoted_jsondoc(value) self.assertEqual(converted_value, value) def test_disable_signing(self): self.assertEqual(handlers.disable_signing(), botocore.UNSIGNED) def test_only_quote_url_path_not_version_id(self): params = {'CopySource': '/foo/bar++baz?versionId=123'} handlers.handle_copy_source_param(params) self.assertEqual(params['CopySource'], '/foo/bar%2B%2Bbaz?versionId=123') def test_only_version_id_is_special_cased(self): params = {'CopySource': '/foo/bar++baz?notVersion=foo+'} handlers.handle_copy_source_param(params) self.assertEqual(params['CopySource'], '/foo/bar%2B%2Bbaz%3FnotVersion%3Dfoo%2B') def test_copy_source_with_multiple_questions(self): params = {'CopySource': '/foo/bar+baz?a=baz+?versionId=a+'} handlers.handle_copy_source_param(params) self.assertEqual(params['CopySource'], '/foo/bar%2Bbaz%3Fa%3Dbaz%2B?versionId=a+') def test_copy_source_supports_dict(self): params = { 'CopySource': {'Bucket': 'foo', 'Key': 'keyname+'} } handlers.handle_copy_source_param(params) self.assertEqual(params['CopySource'], 'foo/keyname%2B') def test_copy_source_ignored_if_not_dict(self): params = { 'CopySource': 'stringvalue' } handlers.handle_copy_source_param(params) self.assertEqual(params['CopySource'], 'stringvalue') def test_copy_source_supports_optional_version_id(self): params = { 'CopySource': {'Bucket': 'foo', 'Key': 'keyname+', 'VersionId': 'asdf+'} } handlers.handle_copy_source_param(params) self.assertEqual(params['CopySource'], # Note, versionId is not url encoded. 'foo/keyname%2B?versionId=asdf+') def test_copy_source_has_validation_failure(self): with self.assertRaisesRegexp(ParamValidationError, 'Key'): handlers.handle_copy_source_param( {'CopySource': {'Bucket': 'foo'}}) def test_quote_source_header_needs_no_changes(self): params = {'CopySource': '/foo/bar?versionId=123'} handlers.handle_copy_source_param(params) self.assertEqual(params['CopySource'], '/foo/bar?versionId=123') def test_presigned_url_already_present_ec2(self): operation_model = mock.Mock() operation_model.name = 'CopySnapshot' params = {'body': {'PresignedUrl': 'https://foo'}} credentials = Credentials('key', 'secret') event_emitter = HierarchicalEmitter() request_signer = RequestSigner( 'ec2', 'us-east-1', 'ec2', 'v4', credentials, event_emitter) handlers.inject_presigned_url_ec2( params, request_signer, operation_model) self.assertEqual(params['body']['PresignedUrl'], 'https://foo') def test_presigned_url_with_source_region_ec2(self): operation_model = mock.Mock() operation_model.name = 'CopySnapshot' params = { 'body': { 'PresignedUrl': 'https://foo', 'SourceRegion': 'us-east-1' } } credentials = Credentials('key', 'secret') event_emitter = HierarchicalEmitter() request_signer = RequestSigner( 'ec2', 'us-east-1', 'ec2', 'v4', credentials, event_emitter) handlers.inject_presigned_url_ec2( params, request_signer, operation_model) self.assertEqual(params['body']['PresignedUrl'], 'https://foo') self.assertEqual(params['body']['SourceRegion'], 'us-east-1') def test_presigned_url_already_present_rds(self): operation_model = mock.Mock() operation_model.name = 'CopyDBSnapshot' params = {'body': {'PreSignedUrl': 'https://foo'}} credentials = Credentials('key', 'secret') event_emitter = HierarchicalEmitter() request_signer = RequestSigner( 'rds', 'us-east-1', 'rds', 'v4', credentials, event_emitter) handlers.inject_presigned_url_rds( params, request_signer, operation_model) self.assertEqual(params['body']['PreSignedUrl'], 'https://foo') def test_presigned_url_with_source_region_rds(self): operation_model = mock.Mock() operation_model.name = 'CopyDBSnapshot' params = { 'body': { 'PreSignedUrl': 'https://foo', 'SourceRegion': 'us-east-1' } } credentials = Credentials('key', 'secret') event_emitter = HierarchicalEmitter() request_signer = RequestSigner( 'rds', 'us-east-1', 'rds', 'v4', credentials, event_emitter) handlers.inject_presigned_url_rds( params, request_signer, operation_model) self.assertEqual(params['body']['PreSignedUrl'], 'https://foo') self.assertNotIn('SourceRegion', params['body']) def test_inject_presigned_url_ec2(self): operation_model = mock.Mock() operation_model.name = 'CopySnapshot' credentials = Credentials('key', 'secret') event_emitter = HierarchicalEmitter() request_signer = RequestSigner( 'ec2', 'us-east-1', 'ec2', 'v4', credentials, event_emitter) request_dict = {} params = {'SourceRegion': 'us-west-2'} request_dict['body'] = params request_dict['url'] = 'https://ec2.us-east-1.amazonaws.com' request_dict['method'] = 'POST' request_dict['headers'] = {} request_dict['context'] = {} handlers.inject_presigned_url_ec2( request_dict, request_signer, operation_model) self.assertIn('https://ec2.us-west-2.amazonaws.com?', params['PresignedUrl']) self.assertIn('X-Amz-Signature', params['PresignedUrl']) self.assertIn('DestinationRegion', params['PresignedUrl']) # We should also populate the DestinationRegion with the # region_name of the endpoint object. self.assertEqual(params['DestinationRegion'], 'us-east-1') def test_use_event_operation_name(self): operation_model = mock.Mock() operation_model.name = 'FakeOperation' request_signer = mock.Mock() request_signer._region_name = 'us-east-1' request_dict = {} params = {'SourceRegion': 'us-west-2'} request_dict['body'] = params request_dict['url'] = 'https://myservice.us-east-1.amazonaws.com' request_dict['method'] = 'POST' request_dict['headers'] = {} request_dict['context'] = {} handlers.inject_presigned_url_ec2( request_dict, request_signer, operation_model) call_args = request_signer.generate_presigned_url.call_args operation_name = call_args[1].get('operation_name') self.assertEqual(operation_name, 'FakeOperation') def test_destination_region_always_changed(self): # If the user provides a destination region, we will still # override the DesinationRegion with the region_name from # the endpoint object. actual_region = 'us-west-1' operation_model = mock.Mock() operation_model.name = 'CopySnapshot' credentials = Credentials('key', 'secret') event_emitter = HierarchicalEmitter() request_signer = RequestSigner( 'ec2', actual_region, 'ec2', 'v4', credentials, event_emitter) request_dict = {} params = { 'SourceRegion': 'us-west-2', 'DestinationRegion': 'us-east-1'} request_dict['body'] = params request_dict['url'] = 'https://ec2.us-west-1.amazonaws.com' request_dict['method'] = 'POST' request_dict['headers'] = {} request_dict['context'] = {} # The user provides us-east-1, but we will override this to # endpoint.region_name, of 'us-west-1' in this case. handlers.inject_presigned_url_ec2( request_dict, request_signer, operation_model) self.assertIn('https://ec2.us-west-2.amazonaws.com?', params['PresignedUrl']) # Always use the DestinationRegion from the endpoint, regardless of # whatever value the user provides. self.assertEqual(params['DestinationRegion'], actual_region) def test_inject_presigned_url_rds(self): operation_model = mock.Mock() operation_model.name = 'CopyDBSnapshot' credentials = Credentials('key', 'secret') event_emitter = HierarchicalEmitter() request_signer = RequestSigner( 'rds', 'us-east-1', 'rds', 'v4', credentials, event_emitter) request_dict = {} params = {'SourceRegion': 'us-west-2'} request_dict['body'] = params request_dict['url'] = 'https://rds.us-east-1.amazonaws.com' request_dict['method'] = 'POST' request_dict['headers'] = {} request_dict['context'] = {} handlers.inject_presigned_url_rds( request_dict, request_signer, operation_model) self.assertIn('https://rds.us-west-2.amazonaws.com?', params['PreSignedUrl']) self.assertIn('X-Amz-Signature', params['PreSignedUrl']) self.assertIn('DestinationRegion', params['PreSignedUrl']) # We should not populate the destination region for rds self.assertNotIn('DestinationRegion', params) def test_source_region_removed(self): operation_model = mock.Mock() operation_model.name = 'CopyDBSnapshot' credentials = Credentials('key', 'secret') event_emitter = HierarchicalEmitter() request_signer = RequestSigner( 'rds', 'us-east-1', 'rds', 'v4', credentials, event_emitter) request_dict = {} params = {'SourceRegion': 'us-west-2'} request_dict['body'] = params request_dict['url'] = 'https://rds.us-east-1.amazonaws.com' request_dict['method'] = 'POST' request_dict['headers'] = {} request_dict['context'] = {} handlers.inject_presigned_url_rds( params=request_dict, request_signer=request_signer, model=operation_model ) self.assertNotIn('SourceRegion', params) def test_source_region_removed_when_presigned_url_provided_for_rds(self): operation_model = mock.Mock() operation_model.name = 'CopyDBSnapshot' credentials = Credentials('key', 'secret') event_emitter = HierarchicalEmitter() request_signer = RequestSigner( 'rds', 'us-east-1', 'rds', 'v4', credentials, event_emitter) request_dict = {} params = {'SourceRegion': 'us-west-2', 'PreSignedUrl': 'https://foo'} request_dict['body'] = params request_dict['url'] = 'https://rds.us-east-1.amazonaws.com' request_dict['method'] = 'POST' request_dict['headers'] = {} request_dict['context'] = {} handlers.inject_presigned_url_rds( params=request_dict, request_signer=request_signer, model=operation_model ) self.assertNotIn('SourceRegion', params) def test_dest_region_removed(self): operation_model = mock.Mock() operation_model.name = 'CopyDBSnapshot' credentials = Credentials('key', 'secret') event_emitter = HierarchicalEmitter() request_signer = RequestSigner( 'rds', 'us-east-1', 'rds', 'v4', credentials, event_emitter) request_dict = {} params = {'SourceRegion': 'us-west-2'} request_dict['body'] = params request_dict['url'] = 'https://rds.us-east-1.amazonaws.com' request_dict['method'] = 'POST' request_dict['headers'] = {} request_dict['context'] = {} handlers.inject_presigned_url_rds( params=request_dict, request_signer=request_signer, model=operation_model ) self.assertNotIn('DestinationRegion', params) def test_presigned_url_already_present_for_rds(self): operation_model = mock.Mock() operation_model.name = 'CopyDBSnapshot' params = {'body': {'PresignedUrl': 'https://foo'}} credentials = Credentials('key', 'secret') event_emitter = HierarchicalEmitter() request_signer = RequestSigner( 'rds', 'us-east-1', 'rds', 'v4', credentials, event_emitter) handlers.inject_presigned_url_rds( params=params, request_signer=request_signer, model=operation_model ) self.assertEqual(params['body']['PresignedUrl'], 'https://foo') def test_presigned_url_casing_changed_for_rds(self): operation_model = mock.Mock() operation_model.name = 'CopyDBSnapshot' credentials = Credentials('key', 'secret') event_emitter = HierarchicalEmitter() request_signer = RequestSigner( 'rds', 'us-east-1', 'rds', 'v4', credentials, event_emitter) request_dict = {} params = {'SourceRegion': 'us-west-2'} request_dict['body'] = params request_dict['url'] = 'https://rds.us-east-1.amazonaws.com' request_dict['method'] = 'POST' request_dict['headers'] = {} request_dict['context'] = {} handlers.inject_presigned_url_rds( params=request_dict, request_signer=request_signer, model=operation_model ) self.assertNotIn('PresignedUrl', params) self.assertIn('https://rds.us-west-2.amazonaws.com?', params['PreSignedUrl']) self.assertIn('X-Amz-Signature', params['PreSignedUrl']) def test_500_status_code_set_for_200_response(self): http_response = mock.Mock() http_response.status_code = 200 http_response.content = """ AccessDenied Access Denied id hostid """ handlers.check_for_200_error((http_response, {})) self.assertEqual(http_response.status_code, 500) def test_200_response_with_no_error_left_untouched(self): http_response = mock.Mock() http_response.status_code = 200 http_response.content = "" handlers.check_for_200_error((http_response, {})) # We don't touch the status code since there are no errors present. self.assertEqual(http_response.status_code, 200) def test_500_response_can_be_none(self): # A 500 response can raise an exception, which means the response # object is None. We need to handle this case. handlers.check_for_200_error(None) def test_route53_resource_id(self): event = 'before-parameter-build.route53.GetHostedZone' params = {'Id': '/hostedzone/ABC123', 'HostedZoneId': '/hostedzone/ABC123', 'ResourceId': '/hostedzone/DEF456', 'DelegationSetId': '/hostedzone/GHI789', 'Other': '/hostedzone/foo'} operation_def = { 'name': 'GetHostedZone', 'input': { 'shape': 'GetHostedZoneInput' } } service_def = { 'metadata': {}, 'shapes': { 'GetHostedZoneInput': { 'type': 'structure', 'members': { 'Id': { 'shape': 'ResourceId' }, 'HostedZoneId': { 'shape': 'ResourceId' }, 'ResourceId': { 'shape': 'ResourceId' }, 'DelegationSetId': { 'shape': 'DelegationSetId' }, 'Other': { 'shape': 'String' } } }, 'ResourceId': { 'type': 'string' }, 'DelegationSetId': { 'type': 'string' }, 'String': { 'type': 'string' } } } model = OperationModel(operation_def, ServiceModel(service_def)) self.session.emit(event, params=params, model=model) self.assertEqual(params['Id'], 'ABC123') self.assertEqual(params['HostedZoneId'], 'ABC123') self.assertEqual(params['ResourceId'], 'DEF456') self.assertEqual(params['DelegationSetId'], 'GHI789') # This one should have been left alone self.assertEqual(params['Other'], '/hostedzone/foo') def test_route53_resource_id_missing_input_shape(self): event = 'before-parameter-build.route53.GetHostedZone' params = {'HostedZoneId': '/hostedzone/ABC123'} operation_def = { 'name': 'GetHostedZone' } service_def = { 'metadata': {}, 'shapes': {} } model = OperationModel(operation_def, ServiceModel(service_def)) self.session.emit(event, params=params, model=model) self.assertEqual(params['HostedZoneId'], '/hostedzone/ABC123') def test_run_instances_userdata(self): user_data = 'This is a test' b64_user_data = base64.b64encode(six.b(user_data)).decode('utf-8') params = dict(ImageId='img-12345678', MinCount=1, MaxCount=5, UserData=user_data) handlers.base64_encode_user_data(params=params) result = {'ImageId': 'img-12345678', 'MinCount': 1, 'MaxCount': 5, 'UserData': b64_user_data} self.assertEqual(params, result) def test_run_instances_userdata_blob(self): # Ensure that binary can be passed in as user data. # This is valid because you can send gzip compressed files as # user data. user_data = b'\xc7\xa9This is a test' b64_user_data = base64.b64encode(user_data).decode('utf-8') params = dict(ImageId='img-12345678', MinCount=1, MaxCount=5, UserData=user_data) handlers.base64_encode_user_data(params=params) result = {'ImageId': 'img-12345678', 'MinCount': 1, 'MaxCount': 5, 'UserData': b64_user_data} self.assertEqual(params, result) def test_register_retry_for_handlers_with_no_endpoint_prefix(self): no_endpoint_prefix = {'metadata': {}} session = mock.Mock() handlers.register_retries_for_service(service_data=no_endpoint_prefix, session=mock.Mock(), service_name='foo') self.assertFalse(session.register.called) def test_register_retry_handlers(self): service_data = { 'metadata': {'endpointPrefix': 'foo'}, } session = mock.Mock() loader = mock.Mock() session.get_component.return_value = loader loader.load_data.return_value = { 'retry': { '__default__': { 'max_attempts': 10, 'delay': { 'type': 'exponential', 'base': 2, 'growth_factor': 5, }, }, }, } handlers.register_retries_for_service(service_data=service_data, session=session, service_name='foo') session.register.assert_called_with('needs-retry.foo', mock.ANY, unique_id='retry-config-foo') def test_get_template_has_error_response(self): original = {'Error': {'Code': 'Message'}} handler_input = copy.deepcopy(original) handlers.json_decode_template_body(parsed=handler_input) # The handler should not have changed the response because it's # an error response. self.assertEqual(original, handler_input) def test_decode_json_policy(self): parsed = { 'Document': '{"foo": "foobarbaz"}', 'Other': 'bar', } service_def = { 'operations': { 'Foo': { 'output': {'shape': 'PolicyOutput'}, } }, 'shapes': { 'PolicyOutput': { 'type': 'structure', 'members': { 'Document': { 'shape': 'policyDocumentType' }, 'Other': { 'shape': 'stringType' } } }, 'policyDocumentType': { 'type': 'string' }, 'stringType': { 'type': 'string' }, } } model = ServiceModel(service_def) op_model = model.operation_model('Foo') handlers.json_decode_policies(parsed, op_model) self.assertEqual(parsed['Document'], {'foo': 'foobarbaz'}) no_document = {'Other': 'bar'} handlers.json_decode_policies(no_document, op_model) self.assertEqual(no_document, {'Other': 'bar'}) def test_inject_account_id(self): params = {} handlers.inject_account_id(params) self.assertEqual(params['accountId'], '-') def test_account_id_not_added_if_present(self): params = {'accountId': 'foo'} handlers.inject_account_id(params) self.assertEqual(params['accountId'], 'foo') def test_glacier_version_header_added(self): request_dict = { 'headers': {} } model = ServiceModel({'metadata': {'apiVersion': '2012-01-01'}}) handlers.add_glacier_version(model, request_dict) self.assertEqual(request_dict['headers']['x-amz-glacier-version'], '2012-01-01') def test_application_json_header_added(self): request_dict = { 'headers': {} } handlers.add_accept_header(None, request_dict) self.assertEqual(request_dict['headers']['Accept'], 'application/json') def test_accept_header_not_added_if_present(self): request_dict = { 'headers': {'Accept': 'application/yaml'} } handlers.add_accept_header(None, request_dict) self.assertEqual(request_dict['headers']['Accept'], 'application/yaml') def test_glacier_checksums_added(self): request_dict = { 'headers': {}, 'body': six.BytesIO(b'hello world'), } handlers.add_glacier_checksums(request_dict) self.assertIn('x-amz-content-sha256', request_dict['headers']) self.assertIn('x-amz-sha256-tree-hash', request_dict['headers']) self.assertEqual( request_dict['headers']['x-amz-content-sha256'], 'b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9') self.assertEqual( request_dict['headers']['x-amz-sha256-tree-hash'], 'b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9') # And verify that the body can still be read. self.assertEqual(request_dict['body'].read(), b'hello world') def test_tree_hash_added_only_if_not_exists(self): request_dict = { 'headers': { 'x-amz-sha256-tree-hash': 'pre-exists', }, 'body': six.BytesIO(b'hello world'), } handlers.add_glacier_checksums(request_dict) self.assertEqual(request_dict['headers']['x-amz-sha256-tree-hash'], 'pre-exists') def test_checksum_added_only_if_not_exists(self): request_dict = { 'headers': { 'x-amz-content-sha256': 'pre-exists', }, 'body': six.BytesIO(b'hello world'), } handlers.add_glacier_checksums(request_dict) self.assertEqual(request_dict['headers']['x-amz-content-sha256'], 'pre-exists') def test_glacier_checksums_support_raw_bytes(self): request_dict = { 'headers': {}, 'body': b'hello world', } handlers.add_glacier_checksums(request_dict) self.assertEqual( request_dict['headers']['x-amz-content-sha256'], 'b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9') self.assertEqual( request_dict['headers']['x-amz-sha256-tree-hash'], 'b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9') def test_switch_host_with_param(self): request = AWSRequest() url = 'https://machinelearning.us-east-1.amazonaws.com' new_endpoint = 'https://my-custom-endpoint.amazonaws.com' data = '{"PredictEndpoint":"%s"}' % new_endpoint request.data = data.encode('utf-8') request.url = url handlers.switch_host_with_param(request, 'PredictEndpoint') self.assertEqual(request.url, new_endpoint) def test_invalid_char_in_bucket_raises_exception(self): params = { 'Bucket': 'bad/bucket/name', 'Key': 'foo', 'Body': b'asdf', } with self.assertRaises(ParamValidationError): handlers.validate_bucket_name(params) def test_bucket_too_long_raises_exception(self): params = { 'Bucket': 'a' * 300, 'Key': 'foo', 'Body': b'asdf', } with self.assertRaises(ParamValidationError): handlers.validate_bucket_name(params) def test_not_dns_compat_but_still_valid_bucket_name(self): params = { 'Bucket': 'foasdf......bar--baz-a_b_CD10', 'Key': 'foo', 'Body': b'asdf', } self.assertIsNone(handlers.validate_bucket_name(params)) def test_valid_bucket_name_hyphen(self): self.assertIsNone( handlers.validate_bucket_name({'Bucket': 'my-bucket-name'})) def test_valid_bucket_name_underscore(self): self.assertIsNone( handlers.validate_bucket_name({'Bucket': 'my_bucket_name'})) def test_valid_bucket_name_period(self): self.assertIsNone( handlers.validate_bucket_name({'Bucket': 'my.bucket.name'})) def test_validation_is_noop_if_no_bucket_param_exists(self): self.assertIsNone(handlers.validate_bucket_name(params={})) def test_validate_non_ascii_metadata_values(self): with self.assertRaises(ParamValidationError): handlers.validate_ascii_metadata({'Metadata': {'foo': u'\u2713'}}) def test_validate_non_ascii_metadata_keys(self): with self.assertRaises(ParamValidationError): handlers.validate_ascii_metadata( {'Metadata': {u'\u2713': 'bar'}}) def test_validate_non_triggered_when_no_md_specified(self): original = {'NotMetadata': ''} copied = original.copy() handlers.validate_ascii_metadata(copied) self.assertEqual(original, copied) def test_validation_passes_when_all_ascii_chars(self): original = {'Metadata': {'foo': 'bar'}} copied = original.copy() handlers.validate_ascii_metadata(original) self.assertEqual(original, copied) def test_set_encoding_type(self): params = {} context = {} handlers.set_list_objects_encoding_type_url(params, context=context) self.assertEqual(params['EncodingType'], 'url') self.assertTrue(context['encoding_type_auto_set']) params['EncodingType'] = 'new_value' handlers.set_list_objects_encoding_type_url(params, context={}) self.assertEqual(params['EncodingType'], 'new_value') def test_decode_list_objects(self): parsed = { 'Contents': [{'Key': "%C3%A7%C3%B6s%25asd%08"}], 'EncodingType': 'url', } context = {'encoding_type_auto_set': True} handlers.decode_list_object(parsed, context=context) self.assertEqual(parsed['Contents'][0]['Key'], u'\xe7\xf6s%asd\x08') def test_decode_list_objects_does_not_decode_without_context(self): parsed = { 'Contents': [{'Key': "%C3%A7%C3%B6s%25asd"}], 'EncodingType': 'url', } handlers.decode_list_object(parsed, context={}) self.assertEqual(parsed['Contents'][0]['Key'], u'%C3%A7%C3%B6s%25asd') def test_decode_list_objects_with_marker(self): parsed = { 'Marker': "%C3%A7%C3%B6s%25%20asd%08+c", 'EncodingType': 'url', } context = {'encoding_type_auto_set': True} handlers.decode_list_object(parsed, context=context) self.assertEqual(parsed['Marker'], u'\xe7\xf6s% asd\x08 c') def test_decode_list_objects_with_nextmarker(self): parsed = { 'NextMarker': "%C3%A7%C3%B6s%25%20asd%08+c", 'EncodingType': 'url', } context = {'encoding_type_auto_set': True} handlers.decode_list_object(parsed, context=context) self.assertEqual(parsed['NextMarker'], u'\xe7\xf6s% asd\x08 c') def test_decode_list_objects_with_common_prefixes(self): parsed = { 'CommonPrefixes': [{'Prefix': "%C3%A7%C3%B6s%25%20asd%08+c"}], 'EncodingType': 'url', } context = {'encoding_type_auto_set': True} handlers.decode_list_object(parsed, context=context) self.assertEqual(parsed['CommonPrefixes'][0]['Prefix'], u'\xe7\xf6s% asd\x08 c') def test_decode_list_objects_with_delimiter(self): parsed = { 'Delimiter': "%C3%A7%C3%B6s%25%20asd%08+c", 'EncodingType': 'url', } context = {'encoding_type_auto_set': True} handlers.decode_list_object(parsed, context=context) self.assertEqual(parsed['Delimiter'], u'\xe7\xf6s% asd\x08 c') def test_get_bucket_location_optional(self): # This handler should no-op if another hook (i.e. stubber) has already # filled in response response = {"LocationConstraint": "eu-west-1"} handlers.parse_get_bucket_location(response, None), self.assertEqual(response["LocationConstraint"], "eu-west-1") class TestConvertStringBodyToFileLikeObject(BaseSessionTest): def assert_converts_to_file_like_object_with_bytes(self, body, body_bytes): params = {'Body': body} handlers.convert_body_to_file_like_object(params) self.assertTrue(hasattr(params['Body'], 'read')) contents = params['Body'].read() self.assertIsInstance(contents, six.binary_type) self.assertEqual(contents, body_bytes) def test_string(self): self.assert_converts_to_file_like_object_with_bytes('foo', b'foo') def test_binary(self): body = os.urandom(500) body_bytes = body self.assert_converts_to_file_like_object_with_bytes(body, body_bytes) def test_file(self): body = six.StringIO() params = {'Body': body} handlers.convert_body_to_file_like_object(params) self.assertEqual(params['Body'], body) def test_unicode(self): self.assert_converts_to_file_like_object_with_bytes(u'bar', b'bar') def test_non_ascii_characters(self): self.assert_converts_to_file_like_object_with_bytes( u'\u2713', b'\xe2\x9c\x93') class TestRetryHandlerOrder(BaseSessionTest): def get_handler_names(self, responses): names = [] for response in responses: handler = response[0] if hasattr(handler, '__name__'): names.append(handler.__name__) elif hasattr(handler, '__class__'): names.append(handler.__class__.__name__) else: names.append(str(handler)) return names def test_s3_special_case_is_before_other_retry(self): service_model = self.session.get_service_model('s3') operation = service_model.operation_model('CopyObject') responses = self.session.emit( 'needs-retry.s3.CopyObject', response=(mock.Mock(), mock.Mock()), endpoint=mock.Mock(), operation=operation, attempts=1, caught_exception=None) # This is implementation specific, but we're trying to verify that # the check_for_200_error is before any of the retry logic in # botocore.retryhandlers. # Technically, as long as the relative order is preserved, we don't # care about the absolute order. names = self.get_handler_names(responses) self.assertIn('check_for_200_error', names) self.assertIn('RetryHandler', names) s3_200_handler = names.index('check_for_200_error') general_retry_handler = names.index('RetryHandler') self.assertTrue(s3_200_handler < general_retry_handler, "S3 200 error handler was supposed to be before " "the general retry handler, but it was not.") class BaseMD5Test(BaseSessionTest): def setUp(self, **environ): super(BaseMD5Test, self).setUp(**environ) self.md5_object = mock.Mock() self.md5_digest = mock.Mock(return_value=b'foo') self.md5_object.digest = self.md5_digest md5_builder = mock.Mock(return_value=self.md5_object) self.md5_patch = mock.patch('hashlib.md5', md5_builder) self.md5_patch.start() self._md5_available_patch = None self.set_md5_available() def tearDown(self): super(BaseMD5Test, self).tearDown() self.md5_patch.stop() if self._md5_available_patch: self._md5_available_patch.stop() def set_md5_available(self, is_available=True): if self._md5_available_patch: self._md5_available_patch.stop() self._md5_available_patch = \ mock.patch('botocore.compat.MD5_AVAILABLE', is_available) self._md5_available_patch.start() class TestSSEMD5(BaseMD5Test): def test_raises_error_when_md5_unavailable(self): self.set_md5_available(False) with self.assertRaises(MD5UnavailableError): handlers.sse_md5({'SSECustomerKey': b'foo'}) with self.assertRaises(MD5UnavailableError): handlers.copy_source_sse_md5({'CopySourceSSECustomerKey': b'foo'}) def test_sse_params(self): for op in ('HeadObject', 'GetObject', 'PutObject', 'CopyObject', 'CreateMultipartUpload', 'UploadPart', 'UploadPartCopy'): event = 'before-parameter-build.s3.%s' % op params = {'SSECustomerKey': b'bar', 'SSECustomerAlgorithm': 'AES256'} self.session.emit(event, params=params, model=mock.MagicMock()) self.assertEqual(params['SSECustomerKey'], 'YmFy') self.assertEqual(params['SSECustomerKeyMD5'], 'Zm9v') def test_sse_params_as_str(self): event = 'before-parameter-build.s3.PutObject' params = {'SSECustomerKey': 'bar', 'SSECustomerAlgorithm': 'AES256'} self.session.emit(event, params=params, model=mock.MagicMock()) self.assertEqual(params['SSECustomerKey'], 'YmFy') self.assertEqual(params['SSECustomerKeyMD5'], 'Zm9v') def test_copy_source_sse_params(self): for op in ['CopyObject', 'UploadPartCopy']: event = 'before-parameter-build.s3.%s' % op params = {'CopySourceSSECustomerKey': b'bar', 'CopySourceSSECustomerAlgorithm': 'AES256'} self.session.emit(event, params=params, model=mock.MagicMock()) self.assertEqual(params['CopySourceSSECustomerKey'], 'YmFy') self.assertEqual(params['CopySourceSSECustomerKeyMD5'], 'Zm9v') def test_copy_source_sse_params_as_str(self): event = 'before-parameter-build.s3.CopyObject' params = {'CopySourceSSECustomerKey': 'bar', 'CopySourceSSECustomerAlgorithm': 'AES256'} self.session.emit(event, params=params, model=mock.MagicMock()) self.assertEqual(params['CopySourceSSECustomerKey'], 'YmFy') self.assertEqual(params['CopySourceSSECustomerKeyMD5'], 'Zm9v') class TestAddMD5(BaseMD5Test): def get_context(self, s3_config=None): if s3_config is None: s3_config = {} return { 'client_config': Config(s3=s3_config) } def test_adds_md5_when_v4(self): credentials = Credentials('key', 'secret') request_signer = RequestSigner( 's3', 'us-east-1', 's3', 'v4', credentials, mock.Mock()) request_dict = {'body': b'bar', 'url': 'https://s3.us-east-1.amazonaws.com', 'method': 'PUT', 'headers': {}} context = self.get_context() handlers.conditionally_calculate_md5( request_dict, request_signer=request_signer, context=context) self.assertTrue('Content-MD5' in request_dict['headers']) def test_adds_md5_when_s3v4(self): credentials = Credentials('key', 'secret') request_signer = RequestSigner( 's3', 'us-east-1', 's3', 's3v4', credentials, mock.Mock()) request_dict = {'body': b'bar', 'url': 'https://s3.us-east-1.amazonaws.com', 'method': 'PUT', 'headers': {}} context = self.get_context({'payload_signing_enabled': False}) handlers.conditionally_calculate_md5( request_dict, request_signer=request_signer, context=context) self.assertTrue('Content-MD5' in request_dict['headers']) def test_conditional_does_not_add_when_md5_unavailable(self): credentials = Credentials('key', 'secret') request_signer = RequestSigner( 's3', 'us-east-1', 's3', 's3', credentials, mock.Mock()) request_dict = {'body': b'bar', 'url': 'https://s3.us-east-1.amazonaws.com', 'method': 'PUT', 'headers': {}} context = self.get_context() self.set_md5_available(False) with mock.patch('botocore.handlers.MD5_AVAILABLE', False): handlers.conditionally_calculate_md5( request_dict, request_signer=request_signer, context=context) self.assertFalse('Content-MD5' in request_dict['headers']) def test_add_md5_raises_error_when_md5_unavailable(self): credentials = Credentials('key', 'secret') request_signer = RequestSigner( 's3', 'us-east-1', 's3', 's3', credentials, mock.Mock()) request_dict = {'body': b'bar', 'url': 'https://s3.us-east-1.amazonaws.com', 'method': 'PUT', 'headers': {}} self.set_md5_available(False) with self.assertRaises(MD5UnavailableError): handlers.calculate_md5( request_dict, request_signer=request_signer) def test_adds_md5_when_s3v2(self): credentials = Credentials('key', 'secret') request_signer = RequestSigner( 's3', 'us-east-1', 's3', 's3', credentials, mock.Mock()) request_dict = {'body': b'bar', 'url': 'https://s3.us-east-1.amazonaws.com', 'method': 'PUT', 'headers': {}} context = self.get_context() handlers.conditionally_calculate_md5( request_dict, request_signer=request_signer, context=context) self.assertTrue('Content-MD5' in request_dict['headers']) def test_add_md5_with_file_like_body(self): request_dict = { 'body': six.BytesIO(b'foobar'), 'headers': {} } self.md5_digest.return_value = b'8X\xf6"0\xac<\x91_0\x0cfC\x12\xc6?' handlers.calculate_md5(request_dict) self.assertEqual(request_dict['headers']['Content-MD5'], 'OFj2IjCsPJFfMAxmQxLGPw==') def test_add_md5_with_bytes_object(self): request_dict = { 'body': b'foobar', 'headers': {} } self.md5_digest.return_value = b'8X\xf6"0\xac<\x91_0\x0cfC\x12\xc6?' handlers.calculate_md5(request_dict) self.assertEqual( request_dict['headers']['Content-MD5'], 'OFj2IjCsPJFfMAxmQxLGPw==') def test_add_md5_with_bytearray_object(self): request_dict = { 'body': bytearray(b'foobar'), 'headers': {} } self.md5_digest.return_value = b'8X\xf6"0\xac<\x91_0\x0cfC\x12\xc6?' handlers.calculate_md5(request_dict) self.assertEqual( request_dict['headers']['Content-MD5'], 'OFj2IjCsPJFfMAxmQxLGPw==') class TestParameterAlias(unittest.TestCase): def setUp(self): self.original_name = 'original' self.alias_name = 'alias' self.parameter_alias = handlers.ParameterAlias( self.original_name, self.alias_name) self.operation_model = mock.Mock() request_shape = DenormalizedStructureBuilder().with_members( {self.original_name: {'type': 'string'}}).build_model() self.operation_model.input_shape = request_shape self.sample_section = DocumentStructure('') self.event_emitter = HierarchicalEmitter() def test_alias_parameter_in_call(self): value = 'value' params = {self.alias_name: value} self.parameter_alias.alias_parameter_in_call( params, self.operation_model) self.assertEqual(params, {self.original_name: value}) def test_alias_parameter_and_original_in_call(self): params = { self.original_name: 'orginal_value', self.alias_name: 'alias_value' } with self.assertRaises(AliasConflictParameterError): self.parameter_alias.alias_parameter_in_call( params, self.operation_model) def test_alias_parameter_in_call_does_not_touch_original(self): value = 'value' params = {self.original_name: value} self.parameter_alias.alias_parameter_in_call( params, self.operation_model) self.assertEqual(params, {self.original_name: value}) def test_does_not_alias_parameter_for_no_input_shape(self): value = 'value' params = {self.alias_name: value} self.operation_model.input_shape = None self.parameter_alias.alias_parameter_in_call( params, self.operation_model) self.assertEqual(params, {self.alias_name: value}) def test_does_not_alias_parameter_for_not_modeled_member(self): value = 'value' params = {self.alias_name: value} request_shape = DenormalizedStructureBuilder().with_members( {'foo': {'type': 'string'}}).build_model() self.operation_model.input_shape = request_shape self.parameter_alias.alias_parameter_in_call( params, self.operation_model) self.assertEqual(params, {self.alias_name: value}) def test_alias_parameter_in_documentation_request_params(self): RequestParamsDocumenter( 'myservice', 'myoperation', self.event_emitter).document_params( self.sample_section, self.operation_model.input_shape) self.parameter_alias.alias_parameter_in_documentation( 'docs.request-params.myservice.myoperation.complete-section', self.sample_section ) contents = self.sample_section.flush_structure().decode('utf-8') self.assertIn(':type ' + self.alias_name + ':', contents) self.assertIn(':param ' + self.alias_name + ':', contents) self.assertNotIn(':type ' + self.original_name + ':', contents) self.assertNotIn(':param ' + self.original_name + ':', contents) def test_alias_parameter_in_documentation_request_example(self): RequestExampleDocumenter( 'myservice', 'myoperation', self.event_emitter).document_example( self.sample_section, self.operation_model.input_shape) self.parameter_alias.alias_parameter_in_documentation( 'docs.request-example.myservice.myoperation.complete-section', self.sample_section ) contents = self.sample_section.flush_structure().decode('utf-8') self.assertIn(self.alias_name + '=', contents) self.assertNotIn(self.original_name + '=', contents) botocore-1.5.7/tests/unit/data_overrides/0000777454262600001440000000000013042511307021522 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/data_overrides/someservice/0000777454262600001440000000000013042511310024040 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/data_overrides/someservice/2012-10-01.json0000666454262600001440000000022013042511306025752 0ustar pysdk-ciamazon00000000000000{ "Purpose": "Prove that files that come first in the path 'win', overwriting values later in the path.", "api_version": "2013-09-06" } botocore-1.5.7/tests/unit/docs/0000777454262600001440000000000013042511310017451 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/docs/test_sharedexample.py0000666454262600001440000002027013042511306023712 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from botocore.compat import OrderedDict from tests.unit.docs import BaseDocsTest from botocore.docs.sharedexample import SharedExampleDocumenter, \ document_shared_examples class TestDocumentSharedExamples(BaseDocsTest): def setUp(self): super(TestDocumentSharedExamples, self).setUp() self.add_shape({ "foo": { "type": "string" } }) self.add_shape({ "nested": {"type": "string"} }) self.add_shape({ "other": { "type": "structure", "members": {"nested": {"shape": "nested"}} } }) self.add_shape({ "aloha": { "type": "list", "member": {"shape": "other"} } }) self.add_shape_to_params('foo', 'foo') self.add_shape_to_params('aloha', 'aloha') self._examples = [{ "id": "sample-id", "title": "sample-title", "description": "Sample Description.", "input": OrderedDict([ ("aloha", [ "other", { "nested": "fun!" } ]), ("foo", "bar"), ]), "output": OrderedDict([ ("foo", "baz"), ]), "comments": { "input": { "aloha": "mahalo" }, "output": { "foo": "Sample Comment" } } } ] def test_default(self): document_shared_examples( self.doc_structure, self.operation_model, 'response = client.foo', self._examples) self.assert_contains_lines_in_order([ "**Examples**", "Sample Description.", "::", " response = client.foo(", " # mahalo", " aloha=[", " 'other',", " {", " 'nested': 'fun!',", " },", " ],", " foo='bar',", " )", " print(response)", "Expected Output:", "::", " {", " # Sample Comment", " 'foo': 'baz',", " 'ResponseMetadata': {", " '...': '...',", " },", " }", ]) class TestSharedExampleDocumenter(BaseDocsTest): def setUp(self): super(TestSharedExampleDocumenter, self).setUp() self.documenter = SharedExampleDocumenter() def test_is_input(self): self.add_shape_to_params('foo', 'String') self.documenter.document_shared_example( example={ 'input': { 'foo': 'bar' } }, prefix='foo.bar', section=self.doc_structure, operation_model=self.operation_model ) self.assert_contains_lines_in_order([ "foo.bar(", " foo='bar'", ")" ]) def test_dict_example(self): self.add_shape({ 'bar': { "type": "structure", "members": { "bar": {"shape": "String"} } } }) self.add_shape_to_params('foo', 'bar') self.documenter.document_shared_example( example={ 'input': { 'foo': {'bar': 'baz'} } }, prefix='foo.bar', section=self.doc_structure, operation_model=self.operation_model ) self.assert_contains_lines_in_order([ "foo.bar(", " foo={", " 'bar': 'baz',", " },", ")" ]) def test_list_example(self): self.add_shape({ "foo": { "type": "list", "member": {"shape": "String"} } }) self.add_shape_to_params('foo', 'foo') self.documenter.document_shared_example( example={ 'input': { 'foo': ['bar'] } }, prefix='foo.bar', section=self.doc_structure, operation_model=self.operation_model ) self.assert_contains_lines_in_order([ "foo.bar(", " foo=[", " 'bar',", " ],", ")" ]) def test_can_handle_no_input_key(self): self.add_shape_to_params('foo', 'String') self.documenter.document_shared_example( example={}, prefix='foo.bar', section=self.doc_structure, operation_model=self.operation_model ) self.assert_contains_lines_in_order([ "foo.bar(", ")" ]) def test_unicode_string_example(self): self.add_shape_to_params('foo', 'String') self.documenter.document_shared_example( example={ 'input': { 'foo': u'bar' } }, prefix='foo.bar', section=self.doc_structure, operation_model=self.operation_model ) self.assert_contains_lines_in_order([ "foo.bar(", " foo='bar'", ")" ]) def test_timestamp_example(self): self.add_shape({ 'foo': {'type': 'timestamp'} }) self.add_shape_to_params('foo', 'foo') self.documenter.document_shared_example( example={ 'input': { 'foo': 'Fri, 20 Nov 2015 21:13:12 GMT' } }, prefix='foo.bar', section=self.doc_structure, operation_model=self.operation_model ) self.assert_contains_lines_in_order([ "foo.bar(", " foo=datetime(2015, 11, 20, 21, 13, 12, 4, 324, 0)", ")" ]) def test_map_example(self): self.add_shape({ "baz": {"type": "string"} }) self.add_shape({ 'bar': { "type": "map", "key": {"shape": "baz"}, "value": {"shape": "baz"} } }) self.add_shape_to_params('foo', 'bar') self.documenter.document_shared_example( example={ 'input': { 'foo': {'bar': 'baz'} } }, prefix='foo.bar', section=self.doc_structure, operation_model=self.operation_model ) self.assert_contains_lines_in_order([ "foo.bar(", " foo={", " 'bar': 'baz',", " },", ")" ]) def test_add_comment(self): self.add_shape_to_params('foo', 'String') self.documenter.document_shared_example( example={ 'input': { 'foo': 'bar' }, 'comments': { 'input': { 'foo': 'baz' } } }, prefix='foo.bar', section=self.doc_structure, operation_model=self.operation_model ) self.assert_contains_lines_in_order([ "foo.bar(", " # baz", " foo='bar',", ")" ]) botocore-1.5.7/tests/unit/docs/test_example.py0000666454262600001440000003470213042511306022530 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import mock from tests.unit.docs import BaseDocsTest from botocore.hooks import HierarchicalEmitter from botocore.docs.example import ResponseExampleDocumenter from botocore.docs.example import RequestExampleDocumenter from botocore.docs.utils import DocumentedShape class BaseExampleDocumenterTest(BaseDocsTest): def setUp(self): super(BaseExampleDocumenterTest, self).setUp() self.event_emitter = HierarchicalEmitter() self.request_example = RequestExampleDocumenter( service_name='myservice', operation_name='SampleOperation', event_emitter=self.event_emitter) self.response_example = ResponseExampleDocumenter( service_name='myservice', operation_name='SampleOperation', event_emitter=self.event_emitter) class TestDocumentDefaultValue(BaseExampleDocumenterTest): def setUp(self): super(TestDocumentDefaultValue, self).setUp() self.add_shape_to_params('Foo', 'String', 'This describes foo.') def test_request_example(self): self.request_example.document_example( self.doc_structure, self.operation_model.input_shape, prefix='response = myclient.call' ) self.assert_contains_lines_in_order([ '::', ' response = myclient.call(', ' Foo=\'string\'', ' )' ]) def test_response_example(self): self.response_example.document_example( self.doc_structure, self.operation_model.input_shape, ) self.assert_contains_lines_in_order([ '::', ' {', ' \'Foo\': \'string\'', ' }' ]) class TestDocumentNoMembers(BaseExampleDocumenterTest): def setUp(self): super(TestDocumentNoMembers, self).setUp() def test_request_example(self): self.request_example.document_example( self.doc_structure, self.operation_model.input_shape, prefix='response = myclient.call' ) self.assert_contains_lines_in_order([ '::', ' response = myclient.call()' ]) def test_response_example(self): self.response_example.document_example( self.doc_structure, self.operation_model.input_shape, ) self.assert_contains_lines_in_order([ '::', ' {}' ]) class TestTraverseAndDocumentShape(BaseExampleDocumenterTest): def setUp(self): super(TestTraverseAndDocumentShape, self).setUp() self.add_shape_to_params('Foo', 'String', 'This describes foo.') self.event_emitter = mock.Mock() self.request_example = RequestExampleDocumenter( service_name='myservice', operation_name='SampleOperation', event_emitter=self.event_emitter) self.response_example = ResponseExampleDocumenter( service_name='myservice', operation_name='SampleOperation', event_emitter=self.event_emitter) def test_events_emitted_response_example(self): self.response_example.traverse_and_document_shape( section=self.doc_structure, shape=self.operation_model.input_shape, history=[] ) structure_section = self.doc_structure.get_section('structure-value') print(self.event_emitter.emit.call_args_list[0][1]['section'].name) self.assertEqual( self.event_emitter.emit.call_args_list, [mock.call('docs.response-example.myservice.SampleOperation.Foo', section=structure_section.get_section( 'Foo').get_section('member-value')), mock.call(('docs.response-example.myservice.SampleOperation' '.complete-section'), section=self.doc_structure)] ) def test_events_emitted_request_example(self): self.request_example.traverse_and_document_shape( section=self.doc_structure, shape=self.operation_model.input_shape, history=[] ) structure_section = self.doc_structure.get_section('structure-value') self.assertEqual( self.event_emitter.emit.call_args_list, [mock.call('docs.request-example.myservice.SampleOperation.Foo', section=structure_section.get_section( 'Foo').get_section('member-value')), mock.call(('docs.request-example.myservice.SampleOperation' '.complete-section'), section=self.doc_structure)] ) class TestDocumentEnumValue(BaseExampleDocumenterTest): def setUp(self): super(TestDocumentEnumValue, self).setUp() self.add_shape( {'EnumString': { 'type': 'string', 'enum': [ 'foo', 'bar' ] }} ) self.add_shape_to_params('Foo', 'EnumString', 'This describes foo.') def test_request_example(self): self.request_example.document_example( self.doc_structure, self.operation_model.input_shape, prefix='response = myclient.call' ) self.assert_contains_lines_in_order([ '::', ' response = myclient.call(', ' Foo=\'foo\'|\'bar\'', ' )' ]) def test_response_example(self): self.response_example.document_example( self.doc_structure, self.operation_model.input_shape, ) self.assert_contains_lines_in_order([ '::', ' {', ' \'Foo\': \'foo\'|\'bar\'', ' }' ]) class TestDocumentMultipleDefaultValues(BaseExampleDocumenterTest): def setUp(self): super(TestDocumentMultipleDefaultValues, self).setUp() self.add_shape_to_params('Foo', 'String', 'This describes foo.') self.add_shape_to_params('Bar', 'String', 'This describes bar.', is_required=True) def test_request_example(self): self.request_example.document_example( self.doc_structure, self.operation_model.input_shape, prefix='response = myclient.call' ) self.assert_contains_lines_in_order([ '::', ' response = myclient.call(', ' Foo=\'string\',', ' Bar=\'string\'', ' )' ]) def test_response_example(self): self.response_example.document_example( self.doc_structure, self.operation_model.input_shape, ) self.assert_contains_lines_in_order([ '::', ' {', ' \'Foo\': \'string\',', ' \'Bar\': \'string\'', ' }' ]) class TestDocumentInclude(BaseExampleDocumenterTest): def setUp(self): super(TestDocumentInclude, self).setUp() self.add_shape_to_params('Foo', 'String', 'This describes foo.') self.include_params = [ DocumentedShape( name='Baz', type_name='integer', documentation='This describes baz.' ) ] def test_request_example(self): self.request_example.document_example( self.doc_structure, self.operation_model.input_shape, prefix='response = myclient.call', include=self.include_params ) self.assert_contains_lines_in_order([ '::', ' response = myclient.call(', ' Foo=\'string\',', ' Baz=123', ' )' ]) def test_response_example(self): self.response_example.document_example( self.doc_structure, self.operation_model.input_shape, include=self.include_params ) self.assert_contains_lines_in_order([ '::', ' {', ' \'Foo\': \'string\',', ' \'Baz\': 123', ' }' ]) class TestDocumentExclude(BaseExampleDocumenterTest): def setUp(self): super(TestDocumentExclude, self).setUp() self.add_shape_to_params('Foo', 'String', 'This describes foo.') self.add_shape_to_params('Bar', 'String', 'This describes bar.', is_required=True) self.exclude_params = ['Foo'] def test_request_example(self): self.request_example.document_example( self.doc_structure, self.operation_model.input_shape, prefix='response = myclient.call', exclude=self.exclude_params ) self.assert_contains_lines_in_order([ '::', ' response = myclient.call(', ' Bar=\'string\'', ' )' ]) self.assert_not_contains_line(' Foo=\'string\'') def test_response_example(self): self.response_example.document_example( self.doc_structure, self.operation_model.input_shape, exclude=self.exclude_params ) self.assert_contains_lines_in_order([ '::', ' {', ' \'Bar\': \'string\'', ' }' ]) self.assert_not_contains_line('\'Foo\': \'string\',') class TestDocumentList(BaseExampleDocumenterTest): def setUp(self): super(TestDocumentList, self).setUp() self.add_shape( {'List': { 'type': 'list', 'member': {'shape': 'String', 'documentation': 'A string element'}}}) self.add_shape_to_params('Foo', 'List', 'This describes the list.') def test_request_example(self): self.request_example.document_example( self.doc_structure, self.operation_model.input_shape, prefix='response = myclient.call') self.assert_contains_lines_in_order([ '::', ' response = myclient.call(', ' Foo=[', ' \'string\',', ' ]', ' )' ]) def test_response_example(self): self.response_example.document_example( self.doc_structure, self.operation_model.input_shape) self.assert_contains_lines_in_order([ '::', ' {', ' \'Foo\': [', ' \'string\',', ' ]', ' }' ]) class TestDocumentMap(BaseExampleDocumenterTest): def setUp(self): super(TestDocumentMap, self).setUp() self.add_shape( {'Map': { 'type': 'map', 'key': {'shape': 'String'}, 'value': {'shape': 'String'}}}) self.add_shape_to_params('Foo', 'Map', 'This describes the map.') def test_request_example(self): self.request_example.document_example( self.doc_structure, self.operation_model.input_shape, prefix='response = myclient.call') self.assert_contains_lines_in_order([ '::', ' response = myclient.call(', ' Foo={', ' \'string\': \'string\'', ' }', ' )' ]) def test_response_example(self): self.response_example.document_example( self.doc_structure, self.operation_model.input_shape) self.assert_contains_lines_in_order([ '::', ' {', ' \'Foo\': {', ' \'string\': \'string\'', ' }', ' }' ]) class TestDocumentStructure(BaseExampleDocumenterTest): def setUp(self): super(TestDocumentStructure, self).setUp() self.add_shape( {'Structure': { 'type': 'structure', 'members': { 'Member': {'shape': 'String', 'documentation': 'This is its member.'}}}}) self.add_shape_to_params( 'Foo', 'Structure', 'This describes the structure.') def test_request_example(self): self.request_example.document_example( self.doc_structure, self.operation_model.input_shape, prefix='response = myclient.call') self.assert_contains_lines_in_order([ '::', ' response = myclient.call(', ' Foo={', ' \'Member\': \'string\'', ' }', ' )' ]) def test_response_example(self): self.response_example.document_example( self.doc_structure, self.operation_model.input_shape) self.assert_contains_lines_in_order([ '::', ' {', ' \'Foo\': {', ' \'Member\': \'string\'', ' }', ' }' ]) class TestDocumentRecursiveShape(BaseExampleDocumenterTest): def setUp(self): super(TestDocumentRecursiveShape, self).setUp() self.add_shape( {'Structure': { 'type': 'structure', 'members': { 'Foo': { 'shape': 'Structure', 'documentation': 'This is a recursive structure.'}}}}) self.add_shape_to_params( 'Foo', 'Structure', 'This describes the structure.') def test_request_example(self): self.request_example.document_example( self.doc_structure, self.operation_model.input_shape, prefix='response = myclient.call') self.assert_contains_lines_in_order([ '::', ' response = myclient.call(', ' Foo={', ' \'Foo\': {\'... recursive ...\'}', ' }', ' )' ]) def test_response_example(self): self.response_example.document_example( self.doc_structure, self.operation_model.input_shape) self.assert_contains_lines_in_order([ '::', ' {', ' \'Foo\': {', ' \'Foo\': {\'... recursive ...\'}', ' }', ' }' ]) botocore-1.5.7/tests/unit/docs/test_params.py0000666454262600001440000002756213042511306022366 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import mock from tests.unit.docs import BaseDocsTest from botocore.hooks import HierarchicalEmitter from botocore.docs.params import RequestParamsDocumenter from botocore.docs.params import ResponseParamsDocumenter from botocore.docs.utils import DocumentedShape class BaseParamsDocumenterTest(BaseDocsTest): def setUp(self): super(BaseParamsDocumenterTest, self).setUp() self.event_emitter = HierarchicalEmitter() self.request_params = RequestParamsDocumenter( service_name='myservice', operation_name='SampleOperation', event_emitter=self.event_emitter) self.response_params = ResponseParamsDocumenter( service_name='myservice', operation_name='SampleOperation', event_emitter=self.event_emitter) class TestDocumentDefaultValue(BaseParamsDocumenterTest): def setUp(self): super(TestDocumentDefaultValue, self).setUp() self.add_shape_to_params('Foo', 'String', 'This describes foo.') def test_request_params(self): self.request_params.document_params( self.doc_structure, self.operation_model.input_shape) self.assert_contains_lines_in_order([ ':type Foo: string', ':param Foo: This describes foo.' ]) def test_response_params(self): self.response_params.document_params( self.doc_structure, self.operation_model.input_shape) self.assert_contains_lines_in_order([ '- *(dict) --*', ' - **Foo** *(string) --* This describes foo.' ]) class TestTraverseAndDocumentShape(BaseParamsDocumenterTest): def setUp(self): super(TestTraverseAndDocumentShape, self).setUp() self.add_shape_to_params('Foo', 'String', 'This describes foo.') self.event_emitter = mock.Mock() self.request_params = RequestParamsDocumenter( service_name='myservice', operation_name='SampleOperation', event_emitter=self.event_emitter) self.response_params = ResponseParamsDocumenter( service_name='myservice', operation_name='SampleOperation', event_emitter=self.event_emitter) def test_events_emitted_response_params(self): self.response_params.traverse_and_document_shape( section=self.doc_structure, shape=self.operation_model.input_shape, history=[] ) self.assertEqual( self.event_emitter.emit.call_args_list, [mock.call('docs.response-params.myservice.SampleOperation.Foo', section=self.doc_structure.get_section('Foo')), mock.call(('docs.response-params.myservice.SampleOperation' '.complete-section'), section=self.doc_structure)] ) def test_events_emitted_request_params(self): self.request_params.traverse_and_document_shape( section=self.doc_structure, shape=self.operation_model.input_shape, history=[] ) self.assertEqual( self.event_emitter.emit.call_args_list, [mock.call('docs.request-params.myservice.SampleOperation.Foo', section=self.doc_structure.get_section('Foo')), mock.call(('docs.request-params.myservice.SampleOperation' '.complete-section'), section=self.doc_structure)] ) class TestDocumentMultipleDefaultValues(BaseParamsDocumenterTest): def setUp(self): super(TestDocumentMultipleDefaultValues, self).setUp() self.add_shape_to_params('Foo', 'String', 'This describes foo.') self.add_shape_to_params('Bar', 'String', 'This describes bar.', is_required=True) def test_request_params(self): self.request_params.document_params( self.doc_structure, self.operation_model.input_shape) self.assert_contains_lines_in_order([ ':type Foo: string', ':param Foo: This describes foo.', ':type Bar: string', ':param Bar: **[REQUIRED]** This describes bar.' ]) def test_response_params(self): self.response_params.document_params( self.doc_structure, self.operation_model.input_shape) self.assert_contains_lines_in_order([ '- *(dict) --*', ' - **Foo** *(string) --* This describes foo.', ' - **Bar** *(string) --* This describes bar.' ]) class TestDocumentInclude(BaseParamsDocumenterTest): def setUp(self): super(TestDocumentInclude, self).setUp() self.add_shape_to_params('Foo', 'String', 'This describes foo.') self.include_params = [ DocumentedShape( name='Baz', type_name='integer', documentation='This describes baz.' ) ] def test_request_params(self): self.request_params.document_params( self.doc_structure, self.operation_model.input_shape, include=self.include_params ) self.assert_contains_lines_in_order([ ':type Foo: string', ':param Foo: This describes foo.', ':type Baz: int', ':param Baz: This describes baz.' ]) def test_response_params(self): self.response_params.document_params( self.doc_structure, self.operation_model.input_shape, include=self.include_params ) self.assert_contains_lines_in_order([ '- *(dict) --*', ' - **Foo** *(string) --* This describes foo.', ' - **Baz** *(integer) --* This describes baz.' ]) class TestDocumentExclude(BaseParamsDocumenterTest): def setUp(self): super(TestDocumentExclude, self).setUp() self.add_shape_to_params('Foo', 'String', 'This describes foo.') self.add_shape_to_params('Bar', 'String', 'This describes bar.', is_required=True) self.exclude_params = ['Foo'] def test_request_params(self): self.request_params.document_params( self.doc_structure, self.operation_model.input_shape, exclude=self.exclude_params) self.assert_contains_lines_in_order([ ':type Bar: string', ':param Bar: **[REQUIRED]** This describes bar.' ]) self.assert_not_contains_lines([ ':type Foo: string', ':param Foo: This describes foo.' ]) def test_response_params(self): self.response_params.document_params( self.doc_structure, self.operation_model.input_shape, exclude=self.exclude_params) self.assert_contains_lines_in_order([ '- *(dict) --*', ' - **Bar** *(string) --* This describes bar.' ]) self.assert_not_contains_line( ' - **Foo** *(string) --* This describes foo.') class TestDocumentList(BaseParamsDocumenterTest): def setUp(self): super(TestDocumentList, self).setUp() self.add_shape( {'List': { 'type': 'list', 'member': {'shape': 'String', 'documentation': 'A string element'}}}) self.add_shape_to_params( 'Foo', 'List', 'This describes the list. Each element of this list is a string.') def test_request_params(self): self.request_params.document_params( self.doc_structure, self.operation_model.input_shape) self.assert_contains_lines_in_order([ ':type Foo: list', ':param Foo: This describes the list.', ' - *(string) --* A string element' ]) def test_response_params(self): self.response_params.document_params( self.doc_structure, self.operation_model.input_shape) self.assert_contains_lines_in_order([ '- *(dict) --*', (' - **Foo** *(list) --* This describes the list. ' 'Each element of this list is a string.'), ' - *(string) --* A string element' ]) class TestDocumentMap(BaseParamsDocumenterTest): def setUp(self): super(TestDocumentMap, self).setUp() self.add_shape( {'Map': { 'type': 'map', 'key': {'shape': 'String'}, 'value': {'shape': 'String'}}}) self.add_shape_to_params('Foo', 'Map', 'This describes the map.') def test_request_params(self): self.request_params.document_params( self.doc_structure, self.operation_model.input_shape) self.assert_contains_lines_in_order([ ':type Foo: dict', ':param Foo: This describes the map.', ' - *(string) --*', ' - *(string) --*' ]) def test_response_params(self): self.response_params.document_params( self.doc_structure, self.operation_model.input_shape) self.assert_contains_lines_in_order([ '- *(dict) --*', ' - **Foo** *(dict) --* This describes the map.', ' - *(string) --*', ' - *(string) --*' ]) class TestDocumentStructure(BaseParamsDocumenterTest): def setUp(self): super(TestDocumentStructure, self).setUp() self.add_shape( {'Structure': { 'type': 'structure', 'members': { 'Member': {'shape': 'String', 'documentation': 'This is its member.'}}}}) self.add_shape_to_params( 'Foo', 'Structure', 'This describes the structure.') def test_request_params(self): self.request_params.document_params( self.doc_structure, self.operation_model.input_shape) self.assert_contains_lines_in_order([ ':type Foo: dict', ':param Foo: This describes the structure.', ' - **Member** *(string) --* This is its member.' ]) def test_response_params(self): self.response_params.document_params( self.doc_structure, self.operation_model.input_shape) self.assert_contains_lines_in_order([ '- *(dict) --*', ' - **Foo** *(dict) --* This describes the structure.', ' - **Member** *(string) --* This is its member.' ]) class TestDocumentRecursiveShape(BaseParamsDocumenterTest): def setUp(self): super(TestDocumentRecursiveShape, self).setUp() self.add_shape( {'Structure': { 'type': 'structure', 'members': { 'Foo': { 'shape': 'Structure', 'documentation': 'This is a recursive structure.'}}}}) self.add_shape_to_params( 'Foo', 'Structure', 'This describes the structure.') def test_request_params(self): self.request_params.document_params( self.doc_structure, self.operation_model.input_shape) self.assert_contains_lines_in_order([ ':type Foo: dict', ':param Foo: This describes the structure.', ' - **Foo** *(dict) --* This is a recursive structure.' ]) def test_response_params(self): self.response_params.document_params( self.doc_structure, self.operation_model.input_shape) self.assert_contains_lines_in_order([ '- *(dict) --*', ' - **Foo** *(dict) --* This is a recursive structure.', ]) botocore-1.5.7/tests/unit/docs/bcdoc/0000777454262600001440000000000013042511310020523 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/docs/bcdoc/test_style.py0000666454262600001440000002501413042511306023303 0ustar pysdk-ciamazon00000000000000# 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 tests import unittest from botocore.compat import six from botocore.docs.bcdoc.style import ReSTStyle from botocore.docs.bcdoc.restdoc import ReSTDocument class TestStyle(unittest.TestCase): def test_spaces(self): style = ReSTStyle(None, 4) self.assertEqual(style.spaces(), '') style.indent() self.assertEqual(style.spaces(), ' ') style.indent() self.assertEqual(style.spaces(), ' ') style.dedent() self.assertEqual(style.spaces(), ' ') style.dedent() self.assertEqual(style.spaces(), '') style.dedent() self.assertEqual(style.spaces(), '') def test_bold(self): style = ReSTStyle(ReSTDocument()) style.bold('foobar') self.assertEqual(style.doc.getvalue(), six.b('**foobar** ')) def test_italics(self): style = ReSTStyle(ReSTDocument()) style.italics('foobar') self.assertEqual(style.doc.getvalue(), six.b('*foobar* ')) def test_p(self): style = ReSTStyle(ReSTDocument()) style.start_p() style.doc.write('foo') style.end_p() self.assertEqual(style.doc.getvalue(), six.b('\n\nfoo\n\n')) def test_code(self): style = ReSTStyle(ReSTDocument()) style.code('foobar') self.assertEqual(style.doc.getvalue(), six.b('``foobar`` ')) def test_h1(self): style = ReSTStyle(ReSTDocument()) style.h1('foobar fiebaz') self.assertEqual( style.doc.getvalue(), six.b('\n\n*************\nfoobar fiebaz\n*************\n\n')) def test_h2(self): style = ReSTStyle(ReSTDocument()) style.h2('foobar fiebaz') self.assertEqual( style.doc.getvalue(), six.b('\n\n=============\nfoobar fiebaz\n=============\n\n')) def test_h3(self): style = ReSTStyle(ReSTDocument()) style.h3('foobar fiebaz') self.assertEqual( style.doc.getvalue(), six.b('\n\n-------------\nfoobar fiebaz\n-------------\n\n')) def test_ref(self): style = ReSTStyle(ReSTDocument()) style.ref('foobar', 'http://foo.bar.com') self.assertEqual(style.doc.getvalue(), six.b(':doc:`foobar `')) def test_examples(self): style = ReSTStyle(ReSTDocument()) self.assertTrue(style.doc.keep_data) style.start_examples() self.assertFalse(style.doc.keep_data) style.end_examples() self.assertTrue(style.doc.keep_data) def test_codeblock(self): style = ReSTStyle(ReSTDocument()) style.codeblock('foobar') self.assertEqual(style.doc.getvalue(), six.b('::\n\n foobar\n\n\n')) def test_toctree_html(self): style = ReSTStyle(ReSTDocument()) style.doc.target = 'html' style.toctree() style.tocitem('foo') style.tocitem('bar') self.assertEqual( style.doc.getvalue(), six.b('\n.. toctree::\n :maxdepth: 1' '\n :titlesonly:\n\n foo\n bar\n')) def test_toctree_man(self): style = ReSTStyle(ReSTDocument()) style.doc.target = 'man' style.toctree() style.tocitem('foo') style.tocitem('bar') self.assertEqual(style.doc.getvalue(), six.b('\n\n\n* foo\n\n\n* bar\n\n')) def test_hidden_toctree_html(self): style = ReSTStyle(ReSTDocument()) style.doc.target = 'html' style.hidden_toctree() style.hidden_tocitem('foo') style.hidden_tocitem('bar') self.assertEqual( style.doc.getvalue(), six.b('\n.. toctree::\n :maxdepth: 1' '\n :hidden:\n\n foo\n bar\n')) def test_hidden_toctree_non_html(self): style = ReSTStyle(ReSTDocument()) style.doc.target = 'man' style.hidden_toctree() style.hidden_tocitem('foo') style.hidden_tocitem('bar') self.assertEqual( style.doc.getvalue(), six.b('')) def test_escape_href_link(self): style = ReSTStyle(ReSTDocument()) style.start_a(attrs=[('href', 'http://example.org')]) style.doc.write('foo: the next bar') style.end_a() self.assertEqual( style.doc.getvalue(), six.b('`foo\\: the next bar`_ \n\n.. _foo\\: the next ' 'bar: http://example.org\n')) def test_handle_no_text_hrefs(self): style = ReSTStyle(ReSTDocument()) style.start_a(attrs=[('href', 'http://example.org')]) style.end_a() self.assertEqual(style.doc.getvalue(), six.b('``_ ')) def test_sphinx_reference_label_html(self): style = ReSTStyle(ReSTDocument()) style.doc.target = 'html' style.sphinx_reference_label('foo', 'bar') self.assertEqual(style.doc.getvalue(), six.b(':ref:`bar `')) def test_sphinx_reference_label_html_no_text(self): style = ReSTStyle(ReSTDocument()) style.doc.target = 'html' style.sphinx_reference_label('foo') self.assertEqual(style.doc.getvalue(), six.b(':ref:`foo `')) def test_sphinx_reference_label_non_html(self): style = ReSTStyle(ReSTDocument()) style.doc.target = 'man' style.sphinx_reference_label('foo', 'bar') self.assertEqual(style.doc.getvalue(), six.b('bar')) def test_sphinx_reference_label_non_html_no_text(self): style = ReSTStyle(ReSTDocument()) style.doc.target = 'man' style.sphinx_reference_label('foo') self.assertEqual(style.doc.getvalue(), six.b('foo')) def test_table_of_contents(self): style = ReSTStyle(ReSTDocument()) style.table_of_contents() self.assertEqual(style.doc.getvalue(), six.b('.. contents:: ')) def test_table_of_contents_with_title(self): style = ReSTStyle(ReSTDocument()) style.table_of_contents(title='Foo') self.assertEqual(style.doc.getvalue(), six.b('.. contents:: Foo\n')) def test_table_of_contents_with_title_and_depth(self): style = ReSTStyle(ReSTDocument()) style.table_of_contents(title='Foo', depth=2) self.assertEqual(style.doc.getvalue(), six.b('.. contents:: Foo\n :depth: 2\n')) def test_sphinx_py_class(self): style = ReSTStyle(ReSTDocument()) style.start_sphinx_py_class('FooClass') style.end_sphinx_py_class() self.assertEqual(style.doc.getvalue(), six.b('\n\n.. py:class:: FooClass\n\n \n\n')) def test_sphinx_py_method(self): style = ReSTStyle(ReSTDocument()) style.start_sphinx_py_method('method') style.end_sphinx_py_method() self.assertEqual(style.doc.getvalue(), six.b('\n\n.. py:method:: method\n\n \n\n')) def test_sphinx_py_method_with_params(self): style = ReSTStyle(ReSTDocument()) style.start_sphinx_py_method('method', 'foo=None') style.end_sphinx_py_method() self.assertEqual( style.doc.getvalue(), six.b('\n\n.. py:method:: method(foo=None)\n\n \n\n')) def test_sphinx_py_attr(self): style = ReSTStyle(ReSTDocument()) style.start_sphinx_py_attr('Foo') style.end_sphinx_py_attr() self.assertEqual(style.doc.getvalue(), six.b('\n\n.. py:attribute:: Foo\n\n \n\n')) def test_write_py_doc_string(self): style = ReSTStyle(ReSTDocument()) docstring = ( 'This describes a function\n' ':param foo: Describes foo\n' 'returns: None' ) style.write_py_doc_string(docstring) self.assertEqual(style.doc.getvalue(), six.b(docstring + '\n')) def test_new_line(self): style = ReSTStyle(ReSTDocument()) style.new_line() self.assertEqual(style.doc.getvalue(), six.b('\n')) style.do_p = False style.new_line() self.assertEqual(style.doc.getvalue(), six.b('\n\n')) def test_list(self): style = ReSTStyle(ReSTDocument()) style.li('foo') self.assertEqual(style.doc.getvalue(), six.b('\n* foo\n\n')) def test_non_top_level_lists_are_indented(self): style = ReSTStyle(ReSTDocument()) # Start the top level list style.start_ul() # Write one list element style.start_li() style.doc.handle_data('foo') style.end_li() self.assertEqual(style.doc.getvalue(), six.b("\n\n\n* foo\n")) # Start the nested list style.start_ul() # Write an element to the nested list style.start_li() style.doc.handle_data('bar') style.end_li() self.assertEqual(style.doc.getvalue(), six.b("\n\n\n* foo\n\n\n \n * bar\n ")) def test_external_link(self): style = ReSTStyle(ReSTDocument()) style.doc.target = 'html' style.external_link('MyLink', 'http://example.com/foo') self.assertEqual(style.doc.getvalue(), six.b('`MyLink `_')) def test_external_link_in_man_page(self): style = ReSTStyle(ReSTDocument()) style.doc.target = 'man' style.external_link('MyLink', 'http://example.com/foo') self.assertEqual(style.doc.getvalue(), six.b('MyLink')) botocore-1.5.7/tests/unit/docs/bcdoc/test_docstringparser.py0000666454262600001440000001630013042511306025352 0ustar pysdk-ciamazon00000000000000# Copyright 2016 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 mock from tests import unittest import botocore.docs.bcdoc.docstringparser as parser from botocore.docs.bcdoc.restdoc import ReSTDocument class TestDocStringParser(unittest.TestCase): def parse(self, html): docstring_parser = parser.DocStringParser(ReSTDocument()) docstring_parser.feed(html) docstring_parser.close() return docstring_parser.doc.getvalue() def assert_contains_exact_lines_in_order(self, actual, expected): # Get each line and filter out empty lines contents = actual.split(b'\n') contents = [line for line in contents if line and not line.isspace()] for line in expected: self.assertIn(line, contents) beginning = contents.index(line) contents = contents[beginning:] def test_nested_lists(self): html = "
  • Wello
    • Horld
" result = self.parse(html) self.assert_contains_exact_lines_in_order(result, [ b'* Wello', b' * Horld' ]) def test_nested_lists_with_extra_white_space(self): html = "
  • Wello
    • Horld
" result = self.parse(html) self.assert_contains_exact_lines_in_order(result, [ b'* Wello', b' * Horld' ]) class TestHTMLTree(unittest.TestCase): def setUp(self): self.style = mock.Mock() self.doc = mock.Mock() self.doc.style = self.style self.tree = parser.HTMLTree(self.doc) def test_add_tag(self): self.tree.add_tag('foo') self.assertIsInstance(self.tree.current_node, parser.TagNode) self.assertEqual(self.tree.current_node.tag, 'foo') def test_add_unsupported_tag(self): del self.style.start_foo del self.style.end_foo self.tree.add_tag('foo') self.assertIn('foo', self.tree.unhandled_tags) def test_add_data(self): self.tree.add_data('foo') self.assertNotIsInstance(self.tree.current_node, parser.DataNode) node = self.tree.head.children[0] self.assertIsInstance(node, parser.DataNode) self.assertEqual(node.data, 'foo') class TestStemNode(unittest.TestCase): def setUp(self): self.style = mock.Mock() self.doc = mock.Mock() self.doc.style = self.style self.node = parser.StemNode() def test_add_child(self): child = parser.StemNode() self.node.add_child(child) self.assertIn(child, self.node.children) self.assertEqual(child.parent, self.node) def test_write(self): self.node.add_child(mock.Mock()) self.node.add_child(mock.Mock()) self.node.write(mock.Mock()) for child in self.node.children: self.assertTrue(child.write.called) class TestTagNode(unittest.TestCase): def setUp(self): self.style = mock.Mock() self.doc = mock.Mock() self.doc.style = self.style self.tag = 'foo' self.node = parser.TagNode(self.tag) def test_write_calls_style(self): self.node.write(self.doc) self.assertTrue(self.style.start_foo.called) self.assertTrue(self.style.end_foo.called) def test_write_unsupported_tag(self): del self.style.start_foo del self.style.end_foo try: self.node.write(self.doc) except AttributeError as e: self.fail(str(e)) class TestDataNode(unittest.TestCase): def setUp(self): self.style = mock.Mock() self.doc = mock.Mock() self.doc.style = self.style def test_string_data(self): node = parser.DataNode('foo') self.assertEqual(node.data, 'foo') def test_non_string_data_raises_error(self): with self.assertRaises(ValueError): parser.DataNode(5) def test_lstrip(self): node = parser.DataNode(' foo') node.lstrip() self.assertEqual(node.data, 'foo') def test_write(self): node = parser.DataNode('foo bar baz') self.doc.translate_words.return_value = ['foo', 'bar', 'baz'] node.write(self.doc) self.doc.handle_data.assert_called_once_with('foo bar baz') def test_write_space(self): node = parser.DataNode(' ') node.write(self.doc) self.doc.handle_data.assert_called_once_with(' ') self.doc.handle_data.reset_mock() node = parser.DataNode(' ') node.write(self.doc) self.doc.handle_data.assert_called_once_with(' ') def test_write_empty_string(self): node = parser.DataNode('') node.write(self.doc) self.assertFalse(self.doc.handle_data.called) class TestLineItemNode(unittest.TestCase): def setUp(self): self.style = mock.Mock() self.doc = mock.Mock() self.doc.style = self.style self.doc.translate_words.return_value = ['foo'] self.node = parser.LineItemNode() def test_write_strips_white_space(self): self.node.add_child(parser.DataNode(' foo')) self.node.write(self.doc) self.doc.handle_data.assert_called_once_with('foo') def test_write_strips_nested_white_space(self): self.node.add_child(parser.DataNode(' ')) tag_child = parser.TagNode('foo') tag_child.add_child(parser.DataNode(' ')) tag_child_2 = parser.TagNode('foo') tag_child_2.add_child(parser.DataNode(' foo')) tag_child.add_child(tag_child_2) self.node.add_child(tag_child) self.node.write(self.doc) self.doc.handle_data.assert_called_once_with('foo') def test_write_only_strips_until_text_is_found(self): self.node.add_child(parser.DataNode(' ')) tag_child = parser.TagNode('foo') tag_child.add_child(parser.DataNode(' ')) tag_child_2 = parser.TagNode('foo') tag_child_2.add_child(parser.DataNode(' foo')) tag_child_2.add_child(parser.DataNode(' ')) tag_child.add_child(tag_child_2) self.node.add_child(tag_child) self.node.write(self.doc) calls = [mock.call('foo'), mock.call(' ')] self.doc.handle_data.assert_has_calls(calls) botocore-1.5.7/tests/unit/docs/bcdoc/test_document.py0000666454262600001440000001411613042511306023762 0ustar pysdk-ciamazon00000000000000# 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 tests import unittest from botocore.compat import six from botocore.docs.bcdoc.restdoc import ReSTDocument, DocumentStructure class TestReSTDocument(unittest.TestCase): def test_write(self): doc = ReSTDocument() doc.write('foo') self.assertEqual(doc.getvalue(), six.b('foo')) def test_writeln(self): doc = ReSTDocument() doc.writeln('foo') self.assertEqual(doc.getvalue(), six.b('foo\n')) def test_include_doc_string(self): doc = ReSTDocument() doc.include_doc_string('

this is a test

') self.assertEqual(doc.getvalue(), six.b('\n\nthis is a ``test`` \n\n')) def test_remove_doc_string(self): doc = ReSTDocument() doc.writeln('foo') doc.include_doc_string('

this is a test

') doc.remove_last_doc_string() self.assertEqual(doc.getvalue(), six.b('foo\n')) class TestDocumentStructure(unittest.TestCase): def setUp(self): self.name = 'mydoc' self.doc_structure = DocumentStructure(self.name) def test_name(self): self.assertEqual(self.doc_structure.name, self.name) def test_path(self): self.assertEqual(self.doc_structure.path, [self.name]) self.doc_structure.path = ['foo'] self.assertEqual(self.doc_structure.path, ['foo']) def test_add_new_section(self): section = self.doc_structure.add_new_section('mysection') # Ensure the name of the section is correct self.assertEqual(section.name, 'mysection') # Ensure we can get the section. self.assertEqual( self.doc_structure.get_section('mysection'), section) # Ensure the path is correct self.assertEqual(section.path, ['mydoc', 'mysection']) # Ensure some of the necessary attributes are passed to the # the section. self.assertEqual(section.style.indentation, self.doc_structure.style.indentation) self.assertEqual(section.translation_map, self.doc_structure.translation_map) self.assertEqual(section.hrefs, self.doc_structure.hrefs) def test_delete_section(self): section = self.doc_structure.add_new_section('mysection') self.assertEqual( self.doc_structure.get_section('mysection'), section) self.doc_structure.delete_section('mysection') with self.assertRaises(KeyError): section.get_section('mysection') def test_create_sections_at_instantiation(self): sections = ['intro', 'middle', 'end'] self.doc_structure = DocumentStructure( self.name, section_names=sections) # Ensure the sections are attached to the new document structure. for section_name in sections: section = self.doc_structure.get_section(section_name) self.assertEqual(section.name, section_name) def test_flush_structure(self): section = self.doc_structure.add_new_section('mysection') subsection = section.add_new_section('mysubsection') self.doc_structure.writeln('1') section.writeln('2') subsection.writeln('3') second_section = self.doc_structure.add_new_section('mysection2') second_section.writeln('4') contents = self.doc_structure.flush_structure() # Ensure the contents were flushed out correctly self.assertEqual(contents, six.b('1\n2\n3\n4\n')) def test_flush_structure_hrefs(self): section = self.doc_structure.add_new_section('mysection') section.writeln('section contents') self.doc_structure.hrefs['foo'] = 'www.foo.com' section.hrefs['bar'] = 'www.bar.com' contents = self.doc_structure.flush_structure() self.assertIn(six.b('.. _foo: www.foo.com'), contents) self.assertIn(six.b('.. _bar: www.bar.com'), contents) def test_available_sections(self): self.doc_structure.add_new_section('mysection') self.doc_structure.add_new_section('mysection2') self.assertEqual( self.doc_structure.available_sections, ['mysection', 'mysection2'] ) def test_context(self): context = {'Foo': 'Bar'} section = self.doc_structure.add_new_section( 'mysection', context=context) self.assertEqual(section.context, context) # Make sure if context is not specified it is empty. section = self.doc_structure.add_new_section('mysection2') self.assertEqual(section.context, {}) def test_remove_all_sections(self): self.doc_structure.add_new_section('mysection2') self.doc_structure.remove_all_sections() self.assertEqual(self.doc_structure.available_sections, []) def test_clear_text(self): self.doc_structure.write('Foo') self.doc_structure.clear_text() self.assertEqual(self.doc_structure.flush_structure(), six.b('')) botocore-1.5.7/tests/unit/docs/bcdoc/__init__.py0000666454262600001440000000107213042511306022641 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. botocore-1.5.7/tests/unit/docs/test_method.py0000666454262600001440000003047613042511306022361 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest from tests.unit.docs import BaseDocsTest from botocore.hooks import HierarchicalEmitter from botocore.docs.method import document_model_driven_signature from botocore.docs.method import document_custom_signature from botocore.docs.method import document_custom_method from botocore.docs.method import document_model_driven_method from botocore.docs.method import get_instance_public_methods from botocore.docs.utils import DocumentedShape class TestGetInstanceMethods(unittest.TestCase): class MySampleClass(object): def _internal_method(self): pass def public_method(self): pass def test_get_instance_methods(self): instance = self.MySampleClass() instance_methods = get_instance_public_methods(instance) self.assertEqual(len(instance_methods), 1) self.assertIn('public_method', instance_methods) self.assertEqual( instance.public_method, instance_methods['public_method']) class TestDocumentModelDrivenSignature(BaseDocsTest): def setUp(self): super(TestDocumentModelDrivenSignature, self).setUp() self.add_shape_to_params('Foo', 'String') self.add_shape_to_params('Bar', 'String', is_required=True) self.add_shape_to_params('Baz', 'String') def test_document_signature(self): document_model_driven_signature( self.doc_structure, 'my_method', self.operation_model) self.assert_contains_line( '.. py:method:: my_method(**kwargs)') def test_document_signature_exclude_all_kwargs(self): exclude_params = ['Foo', 'Bar', 'Baz'] document_model_driven_signature( self.doc_structure, 'my_method', self.operation_model, exclude=exclude_params) self.assert_contains_line( '.. py:method:: my_method()') def test_document_signature_exclude_and_include(self): exclude_params = ['Foo', 'Bar', 'Baz'] include_params = [ DocumentedShape( name='Biz', type_name='integer', documentation='biz docs') ] document_model_driven_signature( self.doc_structure, 'my_method', self.operation_model, include=include_params, exclude=exclude_params) self.assert_contains_line( '.. py:method:: my_method(**kwargs)') class TestDocumentCustomSignature(BaseDocsTest): def sample_method(self, foo, bar='bar', baz=None): pass def test_document_signature(self): document_custom_signature( self.doc_structure, 'my_method', self.sample_method) self.assert_contains_line( '.. py:method:: my_method(foo, bar=\'bar\', baz=None)') class TestDocumentCustomMethod(BaseDocsTest): def custom_method(self, foo): """This is a custom method :type foo: string :param foo: The foo parameter """ pass def test_document_custom_signature(self): document_custom_method( self.doc_structure, 'my_method', self.custom_method) self.assert_contains_lines_in_order([ '.. py:method:: my_method(foo)', ' This is a custom method', ' :type foo: string', ' :param foo: The foo parameter' ]) class TestDocumentModelDrivenMethod(BaseDocsTest): def setUp(self): super(TestDocumentModelDrivenMethod, self).setUp() self.event_emitter = HierarchicalEmitter() self.add_shape_to_params('Bar', 'String') def test_default(self): document_model_driven_method( self.doc_structure, 'foo', self.operation_model, event_emitter=self.event_emitter, method_description='This describes the foo method.', example_prefix='response = client.foo' ) cross_ref_link = ( 'See also: `AWS API Documentation ' '' ) self.assert_contains_lines_in_order([ '.. py:method:: foo(**kwargs)', ' This describes the foo method.', cross_ref_link, ' **Request Syntax**', ' ::', ' response = client.foo(', ' Bar=\'string\'', ' )', ' :type Bar: string', ' :param Bar:', ' :rtype: dict', ' :returns:', ' **Response Syntax**', ' ::', ' {', ' \'Bar\': \'string\'', ' }', ' **Response Structure**', ' - *(dict) --*', ' - **Bar** *(string) --*' ]) def test_no_input_output_shape(self): del self.json_model['operations']['SampleOperation']['input'] del self.json_model['operations']['SampleOperation']['output'] document_model_driven_method( self.doc_structure, 'foo', self.operation_model, event_emitter=self.event_emitter, method_description='This describes the foo method.', example_prefix='response = client.foo' ) self.assert_contains_lines_in_order([ '.. py:method:: foo()', ' This describes the foo method.', ' **Request Syntax**', ' ::', ' response = client.foo()', ' :returns: None', ]) def test_include_input(self): include_params = [ DocumentedShape( name='Biz', type_name='string', documentation='biz docs') ] document_model_driven_method( self.doc_structure, 'foo', self.operation_model, event_emitter=self.event_emitter, method_description='This describes the foo method.', example_prefix='response = client.foo', include_input=include_params ) self.assert_contains_lines_in_order([ '.. py:method:: foo(**kwargs)', ' This describes the foo method.', ' **Request Syntax**', ' ::', ' response = client.foo(', ' Bar=\'string\',', ' Biz=\'string\'', ' )', ' :type Bar: string', ' :param Bar:', ' :type Biz: string', ' :param Biz: biz docs', ' :rtype: dict', ' :returns:', ' **Response Syntax**', ' ::', ' {', ' \'Bar\': \'string\'', ' }', ' **Response Structure**', ' - *(dict) --*', ' - **Bar** *(string) --*' ]) def test_include_output(self): include_params = [ DocumentedShape( name='Biz', type_name='string', documentation='biz docs') ] document_model_driven_method( self.doc_structure, 'foo', self.operation_model, event_emitter=self.event_emitter, method_description='This describes the foo method.', example_prefix='response = client.foo', include_output=include_params ) self.assert_contains_lines_in_order([ '.. py:method:: foo(**kwargs)', ' This describes the foo method.', ' **Request Syntax**', ' ::', ' response = client.foo(', ' Bar=\'string\'', ' )', ' :type Bar: string', ' :param Bar:', ' :rtype: dict', ' :returns:', ' **Response Syntax**', ' ::', ' {', ' \'Bar\': \'string\'', ' \'Biz\': \'string\'', ' }', ' **Response Structure**', ' - *(dict) --*', ' - **Bar** *(string) --*', ' - **Biz** *(string) --*' ]) def test_exclude_input(self): self.add_shape_to_params('Biz', 'String') document_model_driven_method( self.doc_structure, 'foo', self.operation_model, event_emitter=self.event_emitter, method_description='This describes the foo method.', example_prefix='response = client.foo', exclude_input=['Bar'] ) self.assert_contains_lines_in_order([ '.. py:method:: foo(**kwargs)', ' This describes the foo method.', ' **Request Syntax**', ' ::', ' response = client.foo(', ' Biz=\'string\'', ' )', ' :type Biz: string', ' :param Biz:', ' :rtype: dict', ' :returns:', ' **Response Syntax**', ' ::', ' {', ' \'Bar\': \'string\'', ' \'Biz\': \'string\'', ' }', ' **Response Structure**', ' - *(dict) --*', ' - **Bar** *(string) --*', ' - **Biz** *(string) --*' ]) self.assert_not_contains_lines([ ':param Bar: string', 'Bar=\'string\'' ]) def test_exclude_output(self): self.add_shape_to_params('Biz', 'String') document_model_driven_method( self.doc_structure, 'foo', self.operation_model, event_emitter=self.event_emitter, method_description='This describes the foo method.', example_prefix='response = client.foo', exclude_output=['Bar'] ) self.assert_contains_lines_in_order([ '.. py:method:: foo(**kwargs)', ' This describes the foo method.', ' **Request Syntax**', ' ::', ' response = client.foo(', ' Bar=\'string\'', ' Biz=\'string\'', ' )', ' :type Biz: string', ' :param Biz:', ' :rtype: dict', ' :returns:', ' **Response Syntax**', ' ::', ' {', ' \'Biz\': \'string\'', ' }', ' **Response Structure**', ' - *(dict) --*', ' - **Biz** *(string) --*' ]) self.assert_not_contains_lines([ '\'Bar\': \'string\'', '- **Bar** *(string) --*', ]) def test_streaming_body_in_output(self): self.add_shape_to_params('Body', 'Blob') self.json_model['shapes']['Blob'] = {'type': 'blob'} self.json_model['shapes']['SampleOperationInputOutput']['payload'] = \ 'Body' document_model_driven_method( self.doc_structure, 'foo', self.operation_model, event_emitter=self.event_emitter, method_description='This describes the foo method.', example_prefix='response = client.foo' ) self.assert_contains_line('**Body** (:class:`.StreamingBody`)') def test_streaming_body_in_input(self): del self.json_model['operations']['SampleOperation']['output'] self.add_shape_to_params('Body', 'Blob') self.json_model['shapes']['Blob'] = {'type': 'blob'} self.json_model['shapes']['SampleOperationInputOutput']['payload'] = \ 'Body' document_model_driven_method( self.doc_structure, 'foo', self.operation_model, event_emitter=self.event_emitter, method_description='This describes the foo method.', example_prefix='response = client.foo' ) # The line in the example self.assert_contains_line('Body=b\'bytes\'|file') # The line in the parameter description self.assert_contains_line( ':type Body: bytes or seekable file-like object') botocore-1.5.7/tests/unit/docs/test_waiter.py0000666454262600001440000000405613042511306022367 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests.unit.docs import BaseDocsTest from botocore.docs.waiter import WaiterDocumenter from botocore.waiter import WaiterModel class TestWaiterDocumenter(BaseDocsTest): def setUp(self): super(TestWaiterDocumenter, self).setUp() self.add_shape_to_params('Biz', 'String') self.setup_client() waiter_model = WaiterModel(self.waiter_json_model) self.waiter_documenter = WaiterDocumenter( client=self.client, service_waiter_model=waiter_model) def test_document_waiters(self): self.waiter_documenter.document_waiters( self.doc_structure) self.assert_contains_lines_in_order([ '=======', 'Waiters', '=======', 'The available waiters are:', '* :py:class:`MyService.Waiter.SampleOperationComplete`', '.. py:class:: MyService.Waiter.SampleOperationComplete', ' ::', ' waiter = client.get_waiter(\'sample_operation_complete\')', ' .. py:method:: wait(**kwargs)', (' Polls :py:meth:`MyService.Client.sample_operation` ' 'every 15 seconds until a successful state is reached. An error ' 'is returned after 40 failed checks.'), ' **Request Syntax**', ' ::', ' waiter.wait(', ' Biz=\'string\'', ' )', ' :type Biz: string', ' :param Biz:', ' :returns: None' ]) botocore-1.5.7/tests/unit/docs/test_docs.py0000666454262600001440000000425213042511306022022 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import os import shutil import tempfile import mock from tests.unit.docs import BaseDocsTest from botocore.session import get_session from botocore.docs import generate_docs class TestGenerateDocs(BaseDocsTest): def setUp(self): super(TestGenerateDocs, self).setUp() self.docs_root = tempfile.mkdtemp() self.loader_patch = mock.patch( 'botocore.session.create_loader', return_value=self.loader) self.available_service_patch = mock.patch( 'botocore.session.Session.get_available_services', return_value=['myservice']) self.loader_patch.start() self.available_service_patch.start() def tearDown(self): super(TestGenerateDocs, self).tearDown() shutil.rmtree(self.docs_root) self.loader_patch.stop() self.available_service_patch.stop() def test_generate_docs(self): session = get_session() # Have the rst files get written to the temporary directory generate_docs(self.docs_root, session) reference_services_path = os.path.join( self.docs_root, 'reference', 'services') reference_service_path = os.path.join( reference_services_path, 'myservice.rst') self.assertTrue(os.path.exists(reference_service_path)) # Make sure the rst file has some the expected contents. with open(reference_service_path, 'r') as f: contents = f.read() self.assertIn('AWS MyService', contents) self.assertIn('Client', contents) self.assertIn('Paginators', contents) self.assertIn('Waiters', contents) botocore-1.5.7/tests/unit/docs/test_service.py0000666454262600001440000000571513042511306022537 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import os import mock from tests.unit.docs import BaseDocsTest from botocore.session import get_session from botocore.docs.service import ServiceDocumenter class TestServiceDocumenter(BaseDocsTest): def setUp(self): super(TestServiceDocumenter, self).setUp() self.add_shape_to_params('Biz', 'String') self.setup_client() with mock.patch('botocore.session.create_loader', return_value=self.loader): session = get_session() self.service_documenter = ServiceDocumenter( 'myservice', session) def test_document_service(self): # Note that not everything will be included as it is just # a smoke test to make sure all of the main parts are inluded. contents = self.service_documenter.document_service().decode('utf-8') lines = [ '*********', 'MyService', '*********', '.. contents:: Table of Contents', ' :depth: 2', '======', 'Client', '======', '.. py:class:: MyService.Client', ' A low-level client representing AWS MyService::', ' client = session.create_client(\'myservice\')', ' These are the available methods:', ' * :py:meth:`sample_operation`', ' .. py:method:: sample_operation(**kwargs)', ' **Examples** ', ' Sample Description.', ' ::', ' response = client.sample_operation(', '==========', 'Paginators', '==========', '.. py:class:: MyService.Paginator.SampleOperation', ' .. py:method:: paginate(**kwargs)', '=======', 'Waiters', '=======', '.. py:class:: MyService.Waiter.SampleOperationComplete', ' .. py:method:: wait(**kwargs)' ] for line in lines: self.assertIn(line, contents) def test_document_service_no_paginator(self): os.remove(self.paginator_model_file) contents = self.service_documenter.document_service().decode('utf-8') self.assertNotIn('Paginators', contents) def test_document_service_no_waiter(self): os.remove(self.waiter_model_file) contents = self.service_documenter.document_service().decode('utf-8') self.assertNotIn('Waiters', contents) botocore-1.5.7/tests/unit/docs/test_utils.py0000666454262600001440000002040513042511306022230 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import mock from tests import unittest from tests.unit.docs import BaseDocsTest from botocore.docs.utils import py_type_name from botocore.docs.utils import py_default from botocore.docs.utils import get_official_service_name from botocore.docs.utils import AutoPopulatedParam from botocore.docs.utils import HideParamFromOperations from botocore.docs.utils import AppendParamDocumentation class TestPythonTypeName(unittest.TestCase): def test_structure(self): self.assertEqual('dict', py_type_name('structure')) def test_list(self): self.assertEqual('list', py_type_name('list')) def test_map(self): self.assertEqual('dict', py_type_name('map')) def test_string(self): self.assertEqual('string', py_type_name('string')) def test_character(self): self.assertEqual('string', py_type_name('character')) def test_blob(self): self.assertEqual('bytes', py_type_name('blob')) def test_timestamp(self): self.assertEqual('datetime', py_type_name('timestamp')) def test_integer(self): self.assertEqual('integer', py_type_name('integer')) def test_long(self): self.assertEqual('integer', py_type_name('long')) def test_float(self): self.assertEqual('float', py_type_name('float')) def test_double(self): self.assertEqual('float', py_type_name('double')) class TestPythonDefault(unittest.TestCase): def test_structure(self): self.assertEqual('{...}', py_default('structure')) def test_list(self): self.assertEqual('[...]', py_default('list')) def test_map(self): self.assertEqual('{...}', py_default('map')) def test_string(self): self.assertEqual('\'string\'', py_default('string')) def test_blob(self): self.assertEqual('b\'bytes\'', py_default('blob')) def test_timestamp(self): self.assertEqual('datetime(2015, 1, 1)', py_default('timestamp')) def test_integer(self): self.assertEqual('123', py_default('integer')) def test_long(self): self.assertEqual('123', py_default('long')) def test_double(self): self.assertEqual('123.0', py_default('double')) class TestGetOfficialServiceName(BaseDocsTest): def setUp(self): super(TestGetOfficialServiceName, self).setUp() self.service_model.metadata = { 'serviceFullName': 'Official Name' } def test_no_short_name(self): self.assertEqual('Official Name', get_official_service_name(self.service_model)) def test_aws_short_name(self): self.service_model.metadata['serviceAbbreviation'] = 'AWS Foo' self.assertEqual('Official Name (Foo)', get_official_service_name(self.service_model)) def test_amazon_short_name(self): self.service_model.metadata['serviceAbbreviation'] = 'Amazon Foo' self.assertEqual('Official Name (Foo)', get_official_service_name(self.service_model)) def test_short_name_in_official_name(self): self.service_model.metadata['serviceFullName'] = 'The Foo Service' self.service_model.metadata['serviceAbbreviation'] = 'Amazon Foo' self.assertEqual('The Foo Service', get_official_service_name(self.service_model)) class TestAutopopulatedParam(BaseDocsTest): def setUp(self): super(TestAutopopulatedParam, self).setUp() self.name = 'MyMember' self.param = AutoPopulatedParam(self.name) def test_request_param_not_required(self): section = self.doc_structure.add_new_section(self.name) section.add_new_section('param-documentation') self.param.document_auto_populated_param( 'docs.request-params', self.doc_structure) self.assert_contains_line( 'this parameter is automatically populated') def test_request_param_required(self): section = self.doc_structure.add_new_section(self.name) is_required_section = section.add_new_section('is-required') section.add_new_section('param-documentation') is_required_section.write('**[REQUIRED]**') self.param.document_auto_populated_param( 'docs.request-params', self.doc_structure) self.assert_not_contains_line('**[REQUIRED]**') self.assert_contains_line( 'this parameter is automatically populated') def test_non_default_param_description(self): description = 'This is a custom description' self.param = AutoPopulatedParam(self.name, description) section = self.doc_structure.add_new_section(self.name) section.add_new_section('param-documentation') self.param.document_auto_populated_param( 'docs.request-params', self.doc_structure) self.assert_contains_line(description) def test_request_example(self): top_section = self.doc_structure.add_new_section('structure-value') section = top_section.add_new_section(self.name) example = 'MyMember: \'string\'' section.write(example) self.assert_contains_line(example) self.param.document_auto_populated_param( 'docs.request-example', self.doc_structure) self.assert_not_contains_line(example) def test_param_not_in_section_request_param(self): self.doc_structure.add_new_section('Foo') self.param.document_auto_populated_param( 'docs.request-params', self.doc_structure) self.assertEqual( '', self.doc_structure.flush_structure().decode('utf-8')) def test_param_not_in_section_request_example(self): top_section = self.doc_structure.add_new_section('structure-value') section = top_section.add_new_section('Foo') example = 'Foo: \'string\'' section.write(example) self.assert_contains_line(example) self.param.document_auto_populated_param( 'docs.request-example', self.doc_structure) self.assert_contains_line(example) class TestHideParamFromOperations(BaseDocsTest): def setUp(self): super(TestHideParamFromOperations, self).setUp() self.name = 'MyMember' self.param = HideParamFromOperations( 's3', self.name, ['SampleOperation']) def test_hides_params_from_doc_string(self): section = self.doc_structure.add_new_section(self.name) param_signature = ':param %s: ' % self.name section.write(param_signature) self.assert_contains_line(param_signature) self.param.hide_param( 'docs.request-params.s3.SampleOperation.complete-section', self.doc_structure) self.assert_not_contains_line(param_signature) def test_hides_param_from_example(self): structure = self.doc_structure.add_new_section('structure-value') section = structure.add_new_section(self.name) example = '%s: \'string\'' % self.name section.write(example) self.assert_contains_line(example) self.param.hide_param( 'docs.request-example.s3.SampleOperation.complete-section', self.doc_structure) self.assert_not_contains_line(example) class TestAppendParamDocumentation(BaseDocsTest): def setUp(self): super(TestAppendParamDocumentation, self).setUp() self.name = 'MyMember' self.param = AppendParamDocumentation(self.name, 'hello!') def test_appends_documentation(self): section = self.doc_structure.add_new_section(self.name) param_section = section.add_new_section('param-documentation') param_section.writeln('foo') self.param.append_documentation( 'docs.request-params', self.doc_structure) self.assert_contains_line('foo\n') self.assert_contains_line('hello!') botocore-1.5.7/tests/unit/docs/test_docstring.py0000666454262600001440000000717113042511306023071 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest, mock from botocore.docs.docstring import LazyLoadedDocstring from botocore.docs.docstring import ClientMethodDocstring from botocore.docs.docstring import WaiterDocstring from botocore.docs.docstring import PaginatorDocstring class MockedLazyLoadedDocstring(LazyLoadedDocstring): def __init__(self, *args, **kwargs): super(MockedLazyLoadedDocstring, self).__init__(*args, **kwargs) self.mocked_writer_method = mock.Mock() def _write_docstring(self, *args, **kwargs): self.mocked_writer_method(*args, **kwargs) class TestLazyLoadedDocstring(unittest.TestCase): def test_raises_not_implemented(self): with self.assertRaises(NotImplementedError): str(LazyLoadedDocstring()) def test_expandtabs(self): docstring = MockedLazyLoadedDocstring() docstring.mocked_writer_method.side_effect = ( lambda section: section.write('foo\t')) self.assertEqual('foo ', docstring.expandtabs(1)) def test_str(self): docstring = MockedLazyLoadedDocstring() docstring.mocked_writer_method.side_effect = ( lambda section: section.write('foo')) self.assertEqual('foo', str(docstring)) def test_repr(self): docstring = MockedLazyLoadedDocstring() docstring.mocked_writer_method.side_effect = ( lambda section: section.write('foo')) self.assertEqual('foo', repr(docstring)) def test_is_lazy_loaded(self): docstring = MockedLazyLoadedDocstring() str(docstring) str(docstring) # The mock.ANY represents the DocumentStructure that is filled out. docstring.mocked_writer_method.assert_called_once_with(mock.ANY) def test_args_kwargs_passed(self): args = ['foo', 'bar'] kwargs = {'biz': 'baz'} docstring = MockedLazyLoadedDocstring(*args, **kwargs) str(docstring) # The mock.ANY represents the DocumentStructure that is filled out. docstring.mocked_writer_method.assert_called_with( mock.ANY, *args, **kwargs) class TestClientMethodDocstring(unittest.TestCase): def test_use_correct_docstring_writer(self): with mock.patch( 'botocore.docs.docstring' '.document_model_driven_method') as mock_writer: docstring = ClientMethodDocstring() str(docstring) self.assertTrue(mock_writer.called) class TestWaiterDocstring(unittest.TestCase): def test_use_correct_docstring_writer(self): with mock.patch( 'botocore.docs.docstring' '.document_wait_method') as mock_writer: docstring = WaiterDocstring() str(docstring) self.assertTrue(mock_writer.called) class TestPaginatorDocstring(unittest.TestCase): def test_use_correct_docstring_writer(self): with mock.patch( 'botocore.docs.docstring' '.document_paginate_method') as mock_writer: docstring = PaginatorDocstring() str(docstring) self.assertTrue(mock_writer.called) botocore-1.5.7/tests/unit/docs/__init__.py0000666454262600001440000001633713042511306021601 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import os import json import tempfile import shutil from botocore.docs.bcdoc.restdoc import DocumentStructure import mock from tests import unittest from botocore.compat import OrderedDict from botocore.hooks import HierarchicalEmitter from botocore.model import ServiceModel, OperationModel from botocore.client import ClientCreator from botocore.loaders import Loader class BaseDocsTest(unittest.TestCase): def setUp(self): self.root_dir = tempfile.mkdtemp() self.version_dirs = os.path.join( self.root_dir, 'myservice', '2014-01-01') os.makedirs(self.version_dirs) self.model_file = os.path.join(self.version_dirs, 'service-2.json') self.waiter_model_file = os.path.join( self.version_dirs, 'waiters-2.json') self.paginator_model_file = os.path.join( self.version_dirs, 'paginators-1.json') self.example_model_file = os.path.join( self.version_dirs, 'examples-1.json') self.json_model = {} self.nested_json_model = {} self._setup_models() self.build_models() self.events = HierarchicalEmitter() self.setup_client() self.doc_name = 'MyDoc' self.doc_structure = DocumentStructure(self.doc_name, target='html') def tearDown(self): shutil.rmtree(self.root_dir) def setup_client(self): with open(self.example_model_file, 'w') as f: json.dump(self.example_json_model, f) with open(self.waiter_model_file, 'w') as f: json.dump(self.waiter_json_model, f) with open(self.paginator_model_file, 'w') as f: json.dump(self.paginator_json_model, f) with open(self.model_file, 'w') as f: json.dump(self.json_model, f) self.loader = Loader(extra_search_paths=[self.root_dir]) endpoint_resolver = mock.Mock() endpoint_resolver.construct_endpoint.return_value = { 'hostname': 'foo.us-east-1', 'partition': 'aws', 'endpointName': 'us-east-1', 'signatureVersions': ['v4'] } self.creator = ClientCreator( loader=self.loader, endpoint_resolver=endpoint_resolver, user_agent='user-agent', event_emitter=self.events, retry_handler_factory=mock.Mock(), retry_config_translator=mock.Mock(), exceptions_factory=mock.Mock()) self.client = self.creator.create_client('myservice', 'us-east-1') def _setup_models(self): self.json_model = { 'metadata': { 'apiVersion': '2014-01-01', 'endpointPrefix': 'myservice', 'signatureVersion': 'v4', 'serviceFullName': 'AWS MyService', 'uid': 'myservice-2014-01-01', 'protocol': 'query' }, 'operations': { 'SampleOperation': { 'name': 'SampleOperation', 'input': {'shape': 'SampleOperationInputOutput'}, 'output': {'shape': 'SampleOperationInputOutput'} } }, 'shapes': { 'SampleOperationInputOutput': { 'type': 'structure', 'members': OrderedDict() }, 'String': { 'type': 'string' } } } self.waiter_json_model = { "version": 2, "waiters": { "SampleOperationComplete": { "delay": 15, "operation": "SampleOperation", "maxAttempts": 40, "acceptors": [ {"expected": "complete", "matcher": "pathAll", "state": "success", "argument": "Biz"}, {"expected": "failed", "matcher": "pathAny", "state": "failure", "argument": "Biz"} ] } } } self.paginator_json_model = { "pagination": { "SampleOperation": { "input_token": "NextResult", "output_token": "NextResult", "limit_key": "MaxResults", "result_key": "Biz" } } } self.example_json_model = { "version": 1, "examples": { "SampleOperation": [{ "id": "sample-id", "title": "sample-title", "description": "Sample Description.", "input": OrderedDict([ ("Biz", "foo"), ]), "comments": { "input": { "Biz": "bar" }, } }] } } def build_models(self): self.service_model = ServiceModel(self.json_model) self.operation_model = OperationModel( self.json_model['operations']['SampleOperation'], self.service_model ) def add_shape(self, shape): shape_name = list(shape.keys())[0] self.json_model['shapes'][shape_name] = shape[shape_name] def add_shape_to_params(self, param_name, shape_name, documentation=None, is_required=False): params_shape = self.json_model['shapes']['SampleOperationInputOutput'] member = {'shape': shape_name} if documentation is not None: member['documentation'] = documentation params_shape['members'][param_name] = member if is_required: required_list = params_shape.get('required', []) required_list.append(param_name) params_shape['required'] = required_list def assert_contains_line(self, line): contents = self.doc_structure.flush_structure().decode('utf-8') self.assertIn(line, contents) def assert_contains_lines_in_order(self, lines): contents = self.doc_structure.flush_structure().decode('utf-8') for line in lines: self.assertIn(line, contents) beginning = contents.find(line) contents = contents[(beginning + len(line)):] def assert_not_contains_line(self, line): contents = self.doc_structure.flush_structure().decode('utf-8') self.assertNotIn(line, contents) def assert_not_contains_lines(self, lines): contents = self.doc_structure.flush_structure().decode('utf-8') for line in lines: self.assertNotIn(line, contents) botocore-1.5.7/tests/unit/docs/test_client.py0000666454262600001440000000451213042511306022347 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests.unit.docs import BaseDocsTest from botocore.docs.client import ClientDocumenter class TestClientDocumenter(BaseDocsTest): def setUp(self): super(TestClientDocumenter, self).setUp() self.add_shape_to_params('Biz', 'String') self.setup_client() self.client_documenter = ClientDocumenter(self.client) def test_document_client(self): self.client_documenter.document_client(self.doc_structure) self.assert_contains_lines_in_order([ '======', 'Client', '======', '.. py:class:: MyService.Client', ' A low-level client representing AWS MyService::', ' client = session.create_client(\'myservice\')', ' These are the available methods:', ' * :py:meth:`can_paginate`', ' * :py:meth:`get_paginator`', ' * :py:meth:`get_waiter`', ' * :py:meth:`sample_operation`', ' .. py:method:: can_paginate(operation_name)', ' .. py:method:: get_paginator(operation_name)', ' .. py:method:: get_waiter(waiter_name)', ' .. py:method:: sample_operation(**kwargs)', ' **Request Syntax**', ' ::', ' response = client.sample_operation(', ' Biz=\'string\'', ' )', ' :type Biz: string', ' :param Biz:', ' :rtype: dict', ' :returns:', ' **Response Syntax**', ' ::', ' {', ' \'Biz\': \'string\'', ' }', ' **Response Structure**', ' - *(dict) --*', ' - **Biz** *(string) --*' ]) botocore-1.5.7/tests/unit/docs/test_paginator.py0000666454262600001440000000613613042511306023061 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests.unit.docs import BaseDocsTest from botocore.docs.paginator import PaginatorDocumenter from botocore.paginate import PaginatorModel class TestPaginatorDocumenter(BaseDocsTest): def setUp(self): super(TestPaginatorDocumenter, self).setUp() self.add_shape_to_params('Biz', 'String') self.extra_setup() def extra_setup(self): self.setup_client() paginator_model = PaginatorModel(self.paginator_json_model) self.paginator_documenter = PaginatorDocumenter( client=self.client, service_paginator_model=paginator_model) def test_document_paginators(self): self.paginator_documenter.document_paginators( self.doc_structure) self.assert_contains_lines_in_order([ '==========', 'Paginators', '==========', 'The available paginators are:', '* :py:class:`MyService.Paginator.SampleOperation`', '.. py:class:: MyService.Paginator.SampleOperation', ' ::', ' paginator = client.get_paginator(\'sample_operation\')', ' .. py:method:: paginate(**kwargs)', (' Creates an iterator that will paginate through responses' ' from :py:meth:`MyService.Client.sample_operation`.'), ' **Request Syntax**', ' ::', ' response_iterator = paginator.paginate(', ' Biz=\'string\',', ' PaginationConfig={', ' \'MaxItems\': 123,', ' \'PageSize\': 123,', ' \'StartingToken\': \'string\'', ' }', ' )', ' :type Biz: string', ' :param Biz:', ' :type PaginationConfig: dict', ' :param PaginationConfig:', (' A dictionary that provides parameters to ' 'control pagination.'), ' - **MaxItems** *(integer) --*', ' - **PageSize** *(integer) --*', ' - **StartingToken** *(string) --*', ' :rtype: dict', ' :returns:', ' **Response Syntax**', ' ::', ' {', ' \'Biz\': \'string\',', ' \'NextToken\': \'string\'', ' }', ' **Response Structure**', ' - *(dict) --*', ' - **Biz** *(string) --*', ' - **NextToken** *(string) --*' ]) botocore-1.5.7/tests/unit/test_regions.py0000666454262600001440000002351113042511306021607 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest, create_session import mock from nose.tools import assert_equals from botocore import regions from botocore.client import ClientEndpointBridge from botocore.exceptions import NoRegionError class TestEndpointResolver(unittest.TestCase): def _template(self): return { 'partitions': [ { 'partition': 'aws', 'dnsSuffix': 'amazonaws.com', 'regionRegex': '^(us|eu)\-\w+$', 'defaults': { 'hostname': '{service}.{region}.{dnsSuffix}' }, 'regions': { 'us-foo': {'regionName': 'a'}, 'us-bar': {'regionName': 'b'}, 'eu-baz': {'regionName': 'd'} }, 'services': { 'ec2': { 'endpoints': { 'us-foo': {}, 'us-bar': {}, 'eu-baz': {}, 'd': {} } }, 's3': { 'defaults': { 'sslCommonName': \ '{service}.{region}.{dnsSuffix}' }, 'endpoints': { 'us-foo': { 'sslCommonName': \ '{region}.{service}.{dnsSuffix}' }, 'us-bar': {}, 'eu-baz': {'hostname': 'foo'} } }, 'not-regionalized': { 'isRegionalized': False, 'partitionEndpoint': 'aws', 'endpoints': { 'aws': {'hostname': 'not-regionalized'}, 'us-foo': {}, 'eu-baz': {} } }, 'non-partition': { 'partitionEndpoint': 'aws', 'endpoints': { 'aws': {'hostname': 'host'}, 'us-foo': {} } }, 'merge': { 'defaults': { 'signatureVersions': ['v2'], 'protocols': ['http'] }, 'endpoints': { 'us-foo': {'signatureVersions': ['v4']}, 'us-bar': {'protocols': ['https']} } } } }, { 'partition': 'foo', 'dnsSuffix': 'foo.com', 'regionRegex': '^(foo)\-\w+$', 'defaults': { 'hostname': '{service}.{region}.{dnsSuffix}', 'protocols': ['http'], 'foo': 'bar' }, 'regions': { 'foo-1': {'regionName': '1'}, 'foo-2': {'regionName': '2'}, 'foo-3': {'regionName': '3'} }, 'services': { 'ec2': { 'endpoints': { 'foo-1': { 'foo': 'baz' }, 'foo-2': {}, 'foo-3': {} } } } } ] } def test_ensures_region_is_not_none(self): with self.assertRaises(NoRegionError): resolver = regions.EndpointResolver(self._template()) resolver.construct_endpoint('foo', None) def test_ensures_required_keys_present(self): with self.assertRaises(ValueError): regions.EndpointResolver({}) def test_returns_empty_list_when_listing_for_different_partition(self): resolver = regions.EndpointResolver(self._template()) self.assertEquals([], resolver.get_available_endpoints('ec2', 'bar')) def test_returns_empty_list_when_no_service_found(self): resolver = regions.EndpointResolver(self._template()) self.assertEquals([], resolver.get_available_endpoints('what?')) def test_gets_endpoint_names(self): resolver = regions.EndpointResolver(self._template()) result = resolver.get_available_endpoints( 'ec2', allow_non_regional=True) self.assertEquals(['d', 'eu-baz', 'us-bar', 'us-foo'], sorted(result)) def test_gets_endpoint_names_for_partition(self): resolver = regions.EndpointResolver(self._template()) result = resolver.get_available_endpoints( 'ec2', allow_non_regional=True, partition_name='foo') self.assertEquals(['foo-1', 'foo-2', 'foo-3'], sorted(result)) def test_list_regional_endpoints_only(self): resolver = regions.EndpointResolver(self._template()) result = resolver.get_available_endpoints( 'ec2', allow_non_regional=False) self.assertEquals(['eu-baz', 'us-bar', 'us-foo'], sorted(result)) def test_returns_none_when_no_match(self): resolver = regions.EndpointResolver(self._template()) self.assertIsNone(resolver.construct_endpoint('foo', 'baz')) def test_constructs_regionalized_endpoints_for_exact_matches(self): resolver = regions.EndpointResolver(self._template()) result = resolver.construct_endpoint('not-regionalized', 'eu-baz') self.assertEquals('not-regionalized.eu-baz.amazonaws.com', result['hostname']) self.assertEquals('aws', result['partition']) self.assertEquals('eu-baz', result['endpointName']) def test_constructs_partition_endpoints_for_real_partition_region(self): resolver = regions.EndpointResolver(self._template()) result = resolver.construct_endpoint('not-regionalized', 'us-bar') self.assertEquals('not-regionalized', result['hostname']) self.assertEquals('aws', result['partition']) self.assertEquals('aws', result['endpointName']) def test_constructs_partition_endpoints_for_regex_match(self): resolver = regions.EndpointResolver(self._template()) result = resolver.construct_endpoint('not-regionalized', 'us-abc') self.assertEquals('not-regionalized', result['hostname']) def test_constructs_endpoints_for_regionalized_regex_match(self): resolver = regions.EndpointResolver(self._template()) result = resolver.construct_endpoint('s3', 'us-abc') self.assertEquals('s3.us-abc.amazonaws.com', result['hostname']) def test_constructs_endpoints_for_unknown_service_but_known_region(self): resolver = regions.EndpointResolver(self._template()) result = resolver.construct_endpoint('unknown', 'us-foo') self.assertEquals('unknown.us-foo.amazonaws.com', result['hostname']) def test_merges_service_keys(self): resolver = regions.EndpointResolver(self._template()) us_foo = resolver.construct_endpoint('merge', 'us-foo') us_bar = resolver.construct_endpoint('merge', 'us-bar') self.assertEquals(['http'], us_foo['protocols']) self.assertEquals(['v4'], us_foo['signatureVersions']) self.assertEquals(['https'], us_bar['protocols']) self.assertEquals(['v2'], us_bar['signatureVersions']) def test_merges_partition_default_keys_with_no_overwrite(self): resolver = regions.EndpointResolver(self._template()) resolved = resolver.construct_endpoint('ec2', 'foo-1') self.assertEquals('baz', resolved['foo']) self.assertEquals(['http'], resolved['protocols']) def test_merges_partition_default_keys_with_overwrite(self): resolver = regions.EndpointResolver(self._template()) resolved = resolver.construct_endpoint('ec2', 'foo-2') self.assertEquals('bar', resolved['foo']) self.assertEquals(['http'], resolved['protocols']) def test_gives_hostname_and_common_name_unaltered(self): resolver = regions.EndpointResolver(self._template()) result = resolver.construct_endpoint('s3', 'eu-baz') self.assertEquals('s3.eu-baz.amazonaws.com', result['sslCommonName']) self.assertEquals('foo', result['hostname']) def tests_uses_partition_endpoint_when_no_region_provided(self): resolver = regions.EndpointResolver(self._template()) result = resolver.construct_endpoint('not-regionalized') self.assertEquals('not-regionalized', result['hostname']) self.assertEquals('aws', result['endpointName']) def test_returns_dns_suffix_if_available(self): resolver = regions.EndpointResolver(self._template()) result = resolver.construct_endpoint('not-regionalized') self.assertEqual(result['dnsSuffix'], 'amazonaws.com') botocore-1.5.7/tests/unit/test_credentials.py0000666454262600001440000014220413042511306022437 0ustar pysdk-ciamazon00000000000000# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from datetime import datetime, timedelta import mock import os from dateutil.tz import tzlocal, tzutc from botocore import credentials from botocore.utils import ContainerMetadataFetcher from botocore.credentials import EnvProvider, create_assume_role_refresher import botocore.exceptions import botocore.session from tests import unittest, BaseEnvVar, IntegerRefresher # Passed to session to keep it from finding default config file TESTENVVARS = {'config_file': (None, 'AWS_CONFIG_FILE', None)} raw_metadata = { 'foobar': { 'Code': 'Success', 'LastUpdated': '2012-12-03T14:38:21Z', 'AccessKeyId': 'foo', 'SecretAccessKey': 'bar', 'Token': 'foobar', 'Expiration': '2012-12-03T20:48:03Z', 'Type': 'AWS-HMAC' } } post_processed_metadata = { 'role_name': 'foobar', 'access_key': raw_metadata['foobar']['AccessKeyId'], 'secret_key': raw_metadata['foobar']['SecretAccessKey'], 'token': raw_metadata['foobar']['Token'], 'expiry_time': raw_metadata['foobar']['Expiration'], } def path(filename): return os.path.join(os.path.dirname(__file__), 'cfg', filename) class TestCredentials(BaseEnvVar): def _ensure_credential_is_normalized_as_unicode(self, access, secret): c = credentials.Credentials(access, secret) self.assertTrue(isinstance(c.access_key, type(u'u'))) self.assertTrue(isinstance(c.secret_key, type(u'u'))) def test_detect_nonascii_character(self): self._ensure_credential_is_normalized_as_unicode( 'foo\xe2\x80\x99', 'bar\xe2\x80\x99') def test_unicode_input(self): self._ensure_credential_is_normalized_as_unicode( u'foo', u'bar') class TestRefreshableCredentials(TestCredentials): def setUp(self): super(TestRefreshableCredentials, self).setUp() self.refresher = mock.Mock() self.future_time = datetime.now(tzlocal()) + timedelta(hours=24) self.expiry_time = \ datetime.now(tzlocal()) - timedelta(minutes=30) self.metadata = { 'access_key': 'NEW-ACCESS', 'secret_key': 'NEW-SECRET', 'token': 'NEW-TOKEN', 'expiry_time': self.future_time.isoformat(), 'role_name': 'rolename', } self.refresher.return_value = self.metadata self.mock_time = mock.Mock() self.creds = credentials.RefreshableCredentials( 'ORIGINAL-ACCESS', 'ORIGINAL-SECRET', 'ORIGINAL-TOKEN', self.expiry_time, self.refresher, 'iam-role', time_fetcher=self.mock_time ) def test_refresh_needed(self): # The expiry time was set for 30 minutes ago, so if we # say the current time is utcnow(), then we should need # a refresh. self.mock_time.return_value = datetime.now(tzlocal()) self.assertTrue(self.creds.refresh_needed()) # We should refresh creds, if we try to access "access_key" # or any of the cred vars. self.assertEqual(self.creds.access_key, 'NEW-ACCESS') self.assertEqual(self.creds.secret_key, 'NEW-SECRET') self.assertEqual(self.creds.token, 'NEW-TOKEN') def test_no_refresh_needed(self): # The expiry time was 30 minutes ago, let's say it's an hour # ago currently. That would mean we don't need a refresh. self.mock_time.return_value = ( datetime.now(tzlocal()) - timedelta(minutes=60)) self.assertTrue(not self.creds.refresh_needed()) self.assertEqual(self.creds.access_key, 'ORIGINAL-ACCESS') self.assertEqual(self.creds.secret_key, 'ORIGINAL-SECRET') self.assertEqual(self.creds.token, 'ORIGINAL-TOKEN') def test_get_credentials_set(self): # We need to return a consistent set of credentials to use during the # signing process. self.mock_time.return_value = ( datetime.now(tzlocal()) - timedelta(minutes=60)) self.assertTrue(not self.creds.refresh_needed()) credential_set = self.creds.get_frozen_credentials() self.assertEqual(credential_set.access_key, 'ORIGINAL-ACCESS') self.assertEqual(credential_set.secret_key, 'ORIGINAL-SECRET') self.assertEqual(credential_set.token, 'ORIGINAL-TOKEN') class TestEnvVar(BaseEnvVar): def test_envvars_are_found_no_token(self): environ = { 'AWS_ACCESS_KEY_ID': 'foo', 'AWS_SECRET_ACCESS_KEY': 'bar', } provider = credentials.EnvProvider(environ) creds = provider.load() self.assertIsNotNone(creds) self.assertEqual(creds.access_key, 'foo') self.assertEqual(creds.secret_key, 'bar') self.assertEqual(creds.method, 'env') def test_envvars_found_with_security_token(self): environ = { 'AWS_ACCESS_KEY_ID': 'foo', 'AWS_SECRET_ACCESS_KEY': 'bar', 'AWS_SECURITY_TOKEN': 'baz', } provider = credentials.EnvProvider(environ) creds = provider.load() self.assertIsNotNone(creds) self.assertEqual(creds.access_key, 'foo') self.assertEqual(creds.secret_key, 'bar') self.assertEqual(creds.token, 'baz') self.assertEqual(creds.method, 'env') def test_envvars_found_with_session_token(self): environ = { 'AWS_ACCESS_KEY_ID': 'foo', 'AWS_SECRET_ACCESS_KEY': 'bar', 'AWS_SESSION_TOKEN': 'baz', } provider = credentials.EnvProvider(environ) creds = provider.load() self.assertIsNotNone(creds) self.assertEqual(creds.access_key, 'foo') self.assertEqual(creds.secret_key, 'bar') self.assertEqual(creds.token, 'baz') self.assertEqual(creds.method, 'env') def test_envvars_not_found(self): provider = credentials.EnvProvider(environ={}) creds = provider.load() self.assertIsNone(creds) def test_can_override_env_var_mapping(self): # We can change the env var provider to # use our specified env var names. environ = { 'FOO_ACCESS_KEY': 'foo', 'FOO_SECRET_KEY': 'bar', 'FOO_SESSION_TOKEN': 'baz', } mapping = { 'access_key': 'FOO_ACCESS_KEY', 'secret_key': 'FOO_SECRET_KEY', 'token': 'FOO_SESSION_TOKEN', } provider = credentials.EnvProvider( environ, mapping ) creds = provider.load() self.assertEqual(creds.access_key, 'foo') self.assertEqual(creds.secret_key, 'bar') self.assertEqual(creds.token, 'baz') def test_can_override_partial_env_var_mapping(self): # Only changing the access key mapping. # The other 2 use the default values of # AWS_SECRET_ACCESS_KEY and AWS_SESSION_TOKEN # use our specified env var names. environ = { 'FOO_ACCESS_KEY': 'foo', 'AWS_SECRET_ACCESS_KEY': 'bar', 'AWS_SESSION_TOKEN': 'baz', } provider = credentials.EnvProvider( environ, {'access_key': 'FOO_ACCESS_KEY'} ) creds = provider.load() self.assertEqual(creds.access_key, 'foo') self.assertEqual(creds.secret_key, 'bar') self.assertEqual(creds.token, 'baz') def test_partial_creds_is_an_error(self): # If the user provides an access key, they must also # provide a secret key. Not doing so will generate an # error. environ = { 'AWS_ACCESS_KEY_ID': 'foo', # Missing the AWS_SECRET_ACCESS_KEY } provider = credentials.EnvProvider(environ) with self.assertRaises(botocore.exceptions.PartialCredentialsError): provider.load() class TestSharedCredentialsProvider(BaseEnvVar): def setUp(self): super(TestSharedCredentialsProvider, self).setUp() self.ini_parser = mock.Mock() def test_credential_file_exists_default_profile(self): self.ini_parser.return_value = { 'default': { 'aws_access_key_id': 'foo', 'aws_secret_access_key': 'bar', } } provider = credentials.SharedCredentialProvider( creds_filename='~/.aws/creds', profile_name='default', ini_parser=self.ini_parser) creds = provider.load() self.assertIsNotNone(creds) self.assertEqual(creds.access_key, 'foo') self.assertEqual(creds.secret_key, 'bar') self.assertIsNone(creds.token) self.assertEqual(creds.method, 'shared-credentials-file') def test_partial_creds_raise_error(self): self.ini_parser.return_value = { 'default': { 'aws_access_key_id': 'foo', # Missing 'aws_secret_access_key'. } } provider = credentials.SharedCredentialProvider( creds_filename='~/.aws/creds', profile_name='default', ini_parser=self.ini_parser) with self.assertRaises(botocore.exceptions.PartialCredentialsError): provider.load() def test_credentials_file_exists_with_session_token(self): self.ini_parser.return_value = { 'default': { 'aws_access_key_id': 'foo', 'aws_secret_access_key': 'bar', 'aws_session_token': 'baz', } } provider = credentials.SharedCredentialProvider( creds_filename='~/.aws/creds', profile_name='default', ini_parser=self.ini_parser) creds = provider.load() self.assertIsNotNone(creds) self.assertEqual(creds.access_key, 'foo') self.assertEqual(creds.secret_key, 'bar') self.assertEqual(creds.token, 'baz') self.assertEqual(creds.method, 'shared-credentials-file') def test_credentials_file_with_multiple_profiles(self): self.ini_parser.return_value = { # Here the user has a 'default' and a 'dev' profile. 'default': { 'aws_access_key_id': 'a', 'aws_secret_access_key': 'b', 'aws_session_token': 'c', }, 'dev': { 'aws_access_key_id': 'd', 'aws_secret_access_key': 'e', 'aws_session_token': 'f', }, } # And we specify a profile_name of 'dev'. provider = credentials.SharedCredentialProvider( creds_filename='~/.aws/creds', profile_name='dev', ini_parser=self.ini_parser) creds = provider.load() self.assertIsNotNone(creds) self.assertEqual(creds.access_key, 'd') self.assertEqual(creds.secret_key, 'e') self.assertEqual(creds.token, 'f') self.assertEqual(creds.method, 'shared-credentials-file') def test_credentials_file_does_not_exist_returns_none(self): # It's ok if the credentials file does not exist, we should # just catch the appropriate errors and return None. self.ini_parser.side_effect = botocore.exceptions.ConfigNotFound( path='foo') provider = credentials.SharedCredentialProvider( creds_filename='~/.aws/creds', profile_name='dev', ini_parser=self.ini_parser) creds = provider.load() self.assertIsNone(creds) class TestConfigFileProvider(BaseEnvVar): def setUp(self): super(TestConfigFileProvider, self).setUp() profile_config = { 'aws_access_key_id': 'a', 'aws_secret_access_key': 'b', 'aws_session_token': 'c', # Non creds related configs can be in a session's # config. 'region': 'us-west-2', 'output': 'json', } parsed = {'profiles': {'default': profile_config}} parser = mock.Mock() parser.return_value = parsed self.parser = parser def test_config_file_exists(self): provider = credentials.ConfigProvider('cli.cfg', 'default', self.parser) creds = provider.load() self.assertIsNotNone(creds) self.assertEqual(creds.access_key, 'a') self.assertEqual(creds.secret_key, 'b') self.assertEqual(creds.token, 'c') self.assertEqual(creds.method, 'config-file') def test_config_file_missing_profile_config(self): # Referring to a profile that's not in the config file # will result in session.config returning an empty dict. profile_name = 'NOT-default' provider = credentials.ConfigProvider('cli.cfg', profile_name, self.parser) creds = provider.load() self.assertIsNone(creds) def test_config_file_errors_ignored(self): # We should move on to the next provider if the config file # can't be found. self.parser.side_effect = botocore.exceptions.ConfigNotFound( path='cli.cfg') provider = credentials.ConfigProvider('cli.cfg', 'default', self.parser) creds = provider.load() self.assertIsNone(creds) def test_partial_creds_is_error(self): profile_config = { 'aws_access_key_id': 'a', # Missing aws_secret_access_key } parsed = {'profiles': {'default': profile_config}} parser = mock.Mock() parser.return_value = parsed provider = credentials.ConfigProvider('cli.cfg', 'default', parser) with self.assertRaises(botocore.exceptions.PartialCredentialsError): provider.load() class TestBotoProvider(BaseEnvVar): def setUp(self): super(TestBotoProvider, self).setUp() self.ini_parser = mock.Mock() def test_boto_config_file_exists_in_home_dir(self): environ = {} self.ini_parser.return_value = { 'Credentials': { # boto's config file does not support a session token # so we only test for access_key/secret_key. 'aws_access_key_id': 'a', 'aws_secret_access_key': 'b', } } provider = credentials.BotoProvider(environ=environ, ini_parser=self.ini_parser) creds = provider.load() self.assertIsNotNone(creds) self.assertEqual(creds.access_key, 'a') self.assertEqual(creds.secret_key, 'b') self.assertIsNone(creds.token) self.assertEqual(creds.method, 'boto-config') def test_env_var_set_for_boto_location(self): environ = { 'BOTO_CONFIG': 'alternate-config.cfg' } self.ini_parser.return_value = { 'Credentials': { # boto's config file does not support a session token # so we only test for access_key/secret_key. 'aws_access_key_id': 'a', 'aws_secret_access_key': 'b', } } provider = credentials.BotoProvider(environ=environ, ini_parser=self.ini_parser) creds = provider.load() self.assertIsNotNone(creds) self.assertEqual(creds.access_key, 'a') self.assertEqual(creds.secret_key, 'b') self.assertIsNone(creds.token) self.assertEqual(creds.method, 'boto-config') # Assert that the parser was called with the filename specified # in the env var. self.ini_parser.assert_called_with('alternate-config.cfg') def test_no_boto_config_file_exists(self): self.ini_parser.side_effect = botocore.exceptions.ConfigNotFound( path='foo') provider = credentials.BotoProvider(environ={}, ini_parser=self.ini_parser) creds = provider.load() self.assertIsNone(creds) def test_partial_creds_is_error(self): ini_parser = mock.Mock() ini_parser.return_value = { 'Credentials': { 'aws_access_key_id': 'a', # Missing aws_secret_access_key. } } provider = credentials.BotoProvider(environ={}, ini_parser=ini_parser) with self.assertRaises(botocore.exceptions.PartialCredentialsError): provider.load() class TestOriginalEC2Provider(BaseEnvVar): def test_load_ec2_credentials_file_not_exist(self): provider = credentials.OriginalEC2Provider(environ={}) creds = provider.load() self.assertIsNone(creds) def test_load_ec2_credentials_file_exists(self): environ = { 'AWS_CREDENTIAL_FILE': 'foo.cfg', } parser = mock.Mock() parser.return_value = { 'AWSAccessKeyId': 'a', 'AWSSecretKey': 'b', } provider = credentials.OriginalEC2Provider(environ=environ, parser=parser) creds = provider.load() self.assertIsNotNone(creds) self.assertEqual(creds.access_key, 'a') self.assertEqual(creds.secret_key, 'b') self.assertIsNone(creds.token) self.assertEqual(creds.method, 'ec2-credentials-file') class TestInstanceMetadataProvider(BaseEnvVar): def test_load_from_instance_metadata(self): timeobj = datetime.now(tzlocal()) timestamp = (timeobj + timedelta(hours=24)).isoformat() fetcher = mock.Mock() fetcher.retrieve_iam_role_credentials.return_value = { 'access_key': 'a', 'secret_key': 'b', 'token': 'c', 'expiry_time': timestamp, 'role_name': 'myrole', } provider = credentials.InstanceMetadataProvider( iam_role_fetcher=fetcher) creds = provider.load() self.assertIsNotNone(creds) self.assertEqual(creds.access_key, 'a') self.assertEqual(creds.secret_key, 'b') self.assertEqual(creds.token, 'c') self.assertEqual(creds.method, 'iam-role') def test_no_role_creds_exist(self): fetcher = mock.Mock() fetcher.retrieve_iam_role_credentials.return_value = {} provider = credentials.InstanceMetadataProvider( iam_role_fetcher=fetcher) creds = provider.load() self.assertIsNone(creds) fetcher.retrieve_iam_role_credentials.assert_called_with() class CredentialResolverTest(BaseEnvVar): def setUp(self): super(CredentialResolverTest, self).setUp() self.provider1 = mock.Mock() self.provider1.METHOD = 'provider1' self.provider2 = mock.Mock() self.provider2.METHOD = 'provider2' self.fake_creds = credentials.Credentials('a', 'b', 'c') def test_load_credentials_single_provider(self): self.provider1.load.return_value = self.fake_creds resolver = credentials.CredentialResolver(providers=[self.provider1]) creds = resolver.load_credentials() self.assertEqual(creds.access_key, 'a') self.assertEqual(creds.secret_key, 'b') self.assertEqual(creds.token, 'c') def test_get_provider_by_name(self): resolver = credentials.CredentialResolver(providers=[self.provider1]) result = resolver.get_provider('provider1') self.assertIs(result, self.provider1) def test_get_unknown_provider_raises_error(self): resolver = credentials.CredentialResolver(providers=[self.provider1]) with self.assertRaises(botocore.exceptions.UnknownCredentialError): resolver.get_provider('unknown-foo') def test_first_credential_non_none_wins(self): self.provider1.load.return_value = None self.provider2.load.return_value = self.fake_creds resolver = credentials.CredentialResolver(providers=[self.provider1, self.provider2]) creds = resolver.load_credentials() self.assertEqual(creds.access_key, 'a') self.assertEqual(creds.secret_key, 'b') self.assertEqual(creds.token, 'c') self.provider1.load.assert_called_with() self.provider2.load.assert_called_with() def test_no_creds_loaded(self): self.provider1.load.return_value = None self.provider2.load.return_value = None resolver = credentials.CredentialResolver(providers=[self.provider1, self.provider2]) creds = resolver.load_credentials() self.assertIsNone(creds) def test_inject_additional_providers_after_existing(self): self.provider1.load.return_value = None self.provider2.load.return_value = self.fake_creds resolver = credentials.CredentialResolver(providers=[self.provider1, self.provider2]) # Now, if we were to call resolver.load() now, provider2 would # win because it's returning a non None response. # However we can inject a new provider before provider2 to # override this process. # Providers can be added by the METHOD name of each provider. new_provider = mock.Mock() new_provider.METHOD = 'new_provider' new_provider.load.return_value = credentials.Credentials('d', 'e', 'f') resolver.insert_after('provider1', new_provider) creds = resolver.load_credentials() self.assertIsNotNone(creds) self.assertEqual(creds.access_key, 'd') self.assertEqual(creds.secret_key, 'e') self.assertEqual(creds.token, 'f') # Provider 1 should have been called, but provider2 should # *not* have been called because new_provider already returned # a non-None response. self.provider1.load.assert_called_with() self.assertTrue(not self.provider2.called) def test_inject_provider_before_existing(self): new_provider = mock.Mock() new_provider.METHOD = 'override' new_provider.load.return_value = credentials.Credentials('x', 'y', 'z') resolver = credentials.CredentialResolver(providers=[self.provider1, self.provider2]) resolver.insert_before(self.provider1.METHOD, new_provider) creds = resolver.load_credentials() self.assertEqual(creds.access_key, 'x') self.assertEqual(creds.secret_key, 'y') self.assertEqual(creds.token, 'z') def test_can_remove_providers(self): self.provider1.load.return_value = credentials.Credentials( 'a', 'b', 'c') self.provider2.load.return_value = credentials.Credentials( 'd', 'e', 'f') resolver = credentials.CredentialResolver(providers=[self.provider1, self.provider2]) resolver.remove('provider1') creds = resolver.load_credentials() self.assertIsNotNone(creds) self.assertEqual(creds.access_key, 'd') self.assertEqual(creds.secret_key, 'e') self.assertEqual(creds.token, 'f') self.assertTrue(not self.provider1.load.called) self.provider2.load.assert_called_with() def test_provider_unknown(self): resolver = credentials.CredentialResolver(providers=[self.provider1, self.provider2]) # No error is raised if you try to remove an unknown provider. resolver.remove('providerFOO') # But an error IS raised if you try to insert after an unknown # provider. with self.assertRaises(botocore.exceptions.UnknownCredentialError): resolver.insert_after('providerFoo', None) class TestCreateCredentialResolver(BaseEnvVar): def setUp(self): super(TestCreateCredentialResolver, self).setUp() self.session = mock.Mock() self.session_instance_vars = { 'credentials_file': 'a', 'legacy_config_file': 'b', 'config_file': 'c', 'metadata_service_timeout': 'd', 'metadata_service_num_attempts': 'e', } self.fake_env_vars = {} self.session.get_config_variable = self.fake_get_config_variable def fake_get_config_variable(self, name, methods=None): if methods == ('instance',): return self.session_instance_vars.get(name) elif methods is not None and 'env' in methods: return self.fake_env_vars.get(name) def test_create_credential_resolver(self): resolver = credentials.create_credential_resolver(self.session) self.assertIsInstance(resolver, credentials.CredentialResolver) def test_explicit_profile_ignores_env_provider(self): self.session_instance_vars['profile'] = 'dev' resolver = credentials.create_credential_resolver(self.session) self.assertTrue( all(not isinstance(p, EnvProvider) for p in resolver.providers)) def test_no_profile_checks_env_provider(self): # If no profile is provided, self.session_instance_vars.pop('profile', None) resolver = credentials.create_credential_resolver(self.session) # Then an EnvProvider should be part of our credential lookup chain. self.assertTrue( any(isinstance(p, EnvProvider) for p in resolver.providers)) def test_env_provider_added_if_profile_from_env_set(self): self.fake_env_vars['profile'] = 'profile-from-env' resolver = credentials.create_credential_resolver(self.session) self.assertTrue( any(isinstance(p, EnvProvider) for p in resolver.providers)) class TestAssumeRoleCredentialProvider(unittest.TestCase): maxDiff = None def setUp(self): self.fake_config = { 'profiles': { 'development': { 'role_arn': 'myrole', 'source_profile': 'longterm', }, 'longterm': { 'aws_access_key_id': 'akid', 'aws_secret_access_key': 'skid', } } } def create_config_loader(self, with_config=None): if with_config is None: with_config = self.fake_config load_config = mock.Mock() load_config.return_value = with_config return load_config def create_client_creator(self, with_response): # Create a mock sts client that returns a specific response # for assume_role. client = mock.Mock() if isinstance(with_response, list): client.assume_role.side_effect = with_response else: client.assume_role.return_value = with_response return mock.Mock(return_value=client) def some_future_time(self): timeobj = datetime.now(tzlocal()) return timeobj + timedelta(hours=24) def test_assume_role_with_no_cache(self): response = { 'Credentials': { 'AccessKeyId': 'foo', 'SecretAccessKey': 'bar', 'SessionToken': 'baz', 'Expiration': self.some_future_time().isoformat() }, } client_creator = self.create_client_creator(with_response=response) provider = credentials.AssumeRoleProvider( self.create_config_loader(), client_creator, cache={}, profile_name='development') creds = provider.load() self.assertEqual(creds.access_key, 'foo') self.assertEqual(creds.secret_key, 'bar') self.assertEqual(creds.token, 'baz') def test_assume_role_with_datetime(self): response = { 'Credentials': { 'AccessKeyId': 'foo', 'SecretAccessKey': 'bar', 'SessionToken': 'baz', # Note the lack of isoformat(), we're using # a datetime.datetime type. This will ensure # we test both parsing as well as serializing # from a given datetime because the credentials # are immediately expired. 'Expiration': datetime.now(tzlocal()) + timedelta(hours=20) }, } client_creator = self.create_client_creator(with_response=response) provider = credentials.AssumeRoleProvider( self.create_config_loader(), client_creator, cache={}, profile_name='development') creds = provider.load() self.assertEqual(creds.access_key, 'foo') self.assertEqual(creds.secret_key, 'bar') self.assertEqual(creds.token, 'baz') def test_assume_role_refresher_serializes_datetime(self): client = mock.Mock() time_zone = tzutc() expiration = datetime( year=2016, month=11, day=6, hour=1, minute=30, tzinfo=time_zone) client.assume_role.return_value = { 'Credentials': { 'AccessKeyId': 'foo', 'SecretAccessKey': 'bar', 'SessionToken': 'baz', 'Expiration': expiration, } } refresh = create_assume_role_refresher(client, {}) expiry_time = refresh()['expiry_time'] self.assertEqual(expiry_time, '2016-11-06T01:30:00UTC') def test_assume_role_retrieves_from_cache(self): date_in_future = datetime.utcnow() + timedelta(seconds=1000) utc_timestamp = date_in_future.isoformat() + 'Z' self.fake_config['profiles']['development']['role_arn'] = 'myrole' cache = { 'development--myrole': { 'Credentials': { 'AccessKeyId': 'foo-cached', 'SecretAccessKey': 'bar-cached', 'SessionToken': 'baz-cached', 'Expiration': utc_timestamp, } } } provider = credentials.AssumeRoleProvider( self.create_config_loader(), mock.Mock(), cache=cache, profile_name='development') creds = provider.load() self.assertEqual(creds.access_key, 'foo-cached') self.assertEqual(creds.secret_key, 'bar-cached') self.assertEqual(creds.token, 'baz-cached') def test_cache_key_is_windows_safe(self): response = { 'Credentials': { 'AccessKeyId': 'foo', 'SecretAccessKey': 'bar', 'SessionToken': 'baz', 'Expiration': datetime.now(tzlocal()).isoformat() }, } cache = {} self.fake_config['profiles']['development']['role_arn'] = ( 'arn:aws:iam::foo-role') client_creator = self.create_client_creator(with_response=response) provider = credentials.AssumeRoleProvider( self.create_config_loader(), client_creator, cache=cache, profile_name='development') provider.load() # On windows, you cannot use a a ':' in the filename, so # we need to do some small transformations on the filename # to replace any ':' that come up. self.assertEqual(cache['development--arn_aws_iam__foo-role'], response) def test_cache_key_with_role_session_name(self): response = { 'Credentials': { 'AccessKeyId': 'foo', 'SecretAccessKey': 'bar', 'SessionToken': 'baz', 'Expiration': datetime.now(tzlocal()).isoformat() }, } cache = {} self.fake_config['profiles']['development']['role_arn'] = ( 'arn:aws:iam::foo-role') self.fake_config['profiles']['development']['role_session_name'] = ( 'foo_role_session_name') client_creator = self.create_client_creator(with_response=response) provider = credentials.AssumeRoleProvider( self.create_config_loader(), client_creator, cache=cache, profile_name='development') provider.load() self.assertEqual( cache['development--arn_aws_iam__foo-role--foo_role_session_name'], response) def test_assume_role_in_cache_but_expired(self): expired_creds = datetime.utcnow() valid_creds = expired_creds + timedelta(seconds=60) utc_timestamp = expired_creds.isoformat() + 'Z' response = { 'Credentials': { 'AccessKeyId': 'foo', 'SecretAccessKey': 'bar', 'SessionToken': 'baz', 'Expiration': valid_creds.isoformat() + 'Z', }, } client_creator = self.create_client_creator(with_response=response) cache = { 'development--myrole': { 'Credentials': { 'AccessKeyId': 'foo-cached', 'SecretAccessKey': 'bar-cached', 'SessionToken': 'baz-cached', 'Expiration': utc_timestamp, } } } provider = credentials.AssumeRoleProvider( self.create_config_loader(), client_creator, cache=cache, profile_name='development') creds = provider.load() self.assertEqual(creds.access_key, 'foo') self.assertEqual(creds.secret_key, 'bar') self.assertEqual(creds.token, 'baz') def test_role_session_name_provided(self): dev_profile = self.fake_config['profiles']['development'] dev_profile['role_session_name'] = 'myname' response = { 'Credentials': { 'AccessKeyId': 'foo', 'SecretAccessKey': 'bar', 'SessionToken': 'baz', 'Expiration': datetime.now(tzlocal()).isoformat(), }, } client_creator = self.create_client_creator(with_response=response) provider = credentials.AssumeRoleProvider( self.create_config_loader(), client_creator, cache={}, profile_name='development') provider.load() client = client_creator.return_value client.assume_role.assert_called_with( RoleArn='myrole', RoleSessionName='myname') def test_external_id_provided(self): self.fake_config['profiles']['development']['external_id'] = 'myid' response = { 'Credentials': { 'AccessKeyId': 'foo', 'SecretAccessKey': 'bar', 'SessionToken': 'baz', 'Expiration': datetime.now(tzlocal()).isoformat(), }, } client_creator = self.create_client_creator(with_response=response) provider = credentials.AssumeRoleProvider( self.create_config_loader(), client_creator, cache={}, profile_name='development') provider.load() client = client_creator.return_value client.assume_role.assert_called_with( RoleArn='myrole', ExternalId='myid', RoleSessionName=mock.ANY) def test_assume_role_with_mfa(self): self.fake_config['profiles']['development']['mfa_serial'] = 'mfa' response = { 'Credentials': { 'AccessKeyId': 'foo', 'SecretAccessKey': 'bar', 'SessionToken': 'baz', 'Expiration': datetime.now(tzlocal()).isoformat(), }, } client_creator = self.create_client_creator(with_response=response) prompter = mock.Mock(return_value='token-code') provider = credentials.AssumeRoleProvider( self.create_config_loader(), client_creator, cache={}, profile_name='development', prompter=prompter) provider.load() client = client_creator.return_value # In addition to the normal assume role args, we should also # inject the serial number from the config as well as the # token code that comes from prompting the user (the prompter # object). client.assume_role.assert_called_with( RoleArn='myrole', RoleSessionName=mock.ANY, SerialNumber='mfa', TokenCode='token-code') def test_assume_role_populates_session_name_on_refresh(self): responses = [{ 'Credentials': { 'AccessKeyId': 'foo', 'SecretAccessKey': 'bar', 'SessionToken': 'baz', # We're creating an expiry time in the past so as # soon as we try to access the credentials, the # refresh behavior will be triggered. 'Expiration': ( datetime.now(tzlocal()) - timedelta(seconds=100)).isoformat(), }, }, { 'Credentials': { 'AccessKeyId': 'foo', 'SecretAccessKey': 'bar', 'SessionToken': 'baz', 'Expiration': ( datetime.now(tzlocal()) + timedelta(seconds=100) ).isoformat(), } }] client_creator = self.create_client_creator(with_response=responses) provider = credentials.AssumeRoleProvider( self.create_config_loader(), client_creator, cache={}, profile_name='development', prompter=mock.Mock(return_value='token-code')) # This will trigger the first assume_role() call. It returns # credentials that are expired and will trigger a refresh. creds = provider.load() # This will trigger the second assume_role() call because # a refresh is needed. creds.get_frozen_credentials() client = client_creator.return_value assume_role_calls = client.assume_role.call_args_list self.assertEqual(len(assume_role_calls), 2, assume_role_calls) # The args should be identical. That is, the second # assume_role call should have the exact same args as the # initial assume_role call. self.assertEqual(assume_role_calls[0], assume_role_calls[1]) def test_assume_role_mfa_cannot_refresh_credentials(self): # Note: we should look into supporting optional behavior # in the future that allows for reprompting for credentials. # But for now, if we get temp creds with MFA then when those # creds expire, we can't refresh the credentials. self.fake_config['profiles']['development']['mfa_serial'] = 'mfa' response = { 'Credentials': { 'AccessKeyId': 'foo', 'SecretAccessKey': 'bar', 'SessionToken': 'baz', # We're creating an expiry time in the past so as # soon as we try to access the credentials, the # refresh behavior will be triggered. 'Expiration': ( datetime.now(tzlocal()) - timedelta(seconds=100)).isoformat(), }, } client_creator = self.create_client_creator(with_response=response) provider = credentials.AssumeRoleProvider( self.create_config_loader(), client_creator, cache={}, profile_name='development', prompter=mock.Mock(return_value='token-code')) creds = provider.load() with self.assertRaises(credentials.RefreshWithMFAUnsupportedError): # access_key is a property that will refresh credentials # if they're expired. Because we set the expiry time to # something in the past, this will trigger the refresh # behavior, with with MFA will currently raise an exception. creds.access_key def test_no_config_is_noop(self): self.fake_config['profiles']['development'] = { 'aws_access_key_id': 'foo', 'aws_secret_access_key': 'bar', } provider = credentials.AssumeRoleProvider( self.create_config_loader(), mock.Mock(), cache={}, profile_name='development') # Because a role_arn was not specified, the AssumeRoleProvider # is a noop and will not return credentials (which means we # move on to the next provider). creds = provider.load() self.assertIsNone(creds) def test_source_profile_not_provided(self): del self.fake_config['profiles']['development']['source_profile'] provider = credentials.AssumeRoleProvider( self.create_config_loader(), mock.Mock(), cache={}, profile_name='development') # source_profile is required, we shoudl get an error. with self.assertRaises(botocore.exceptions.PartialCredentialsError): provider.load() def test_source_profile_does_not_exist(self): dev_profile = self.fake_config['profiles']['development'] dev_profile['source_profile'] = 'does-not-exist' provider = credentials.AssumeRoleProvider( self.create_config_loader(), mock.Mock(), cache={}, profile_name='development') # source_profile is required, we shoudl get an error. with self.assertRaises(botocore.exceptions.InvalidConfigError): provider.load() class TestRefreshLogic(unittest.TestCase): def test_mandatory_refresh_needed(self): creds = IntegerRefresher( # These values will immediately trigger # a manadatory refresh. creds_last_for=2, mandatory_refresh=3, advisory_refresh=3) temp = creds.get_frozen_credentials() self.assertEqual( temp, credentials.ReadOnlyCredentials('1', '1', '1')) def test_advisory_refresh_needed(self): creds = IntegerRefresher( # These values will immediately trigger # a manadatory refresh. creds_last_for=4, mandatory_refresh=2, advisory_refresh=5) temp = creds.get_frozen_credentials() self.assertEqual( temp, credentials.ReadOnlyCredentials('1', '1', '1')) def test_refresh_fails_is_not_an_error_during_advisory_period(self): fail_refresh = mock.Mock(side_effect=Exception("refresh failed")) creds = IntegerRefresher( creds_last_for=5, advisory_refresh=7, mandatory_refresh=3, refresh_function=fail_refresh ) temp = creds.get_frozen_credentials() # We should have called the refresh function. self.assertTrue(fail_refresh.called) # The fail_refresh function will raise an exception. # Because we're in the advisory period we'll not propogate # the exception and return the current set of credentials # (generation '1'). self.assertEqual( temp, credentials.ReadOnlyCredentials('0', '0', '0')) def test_exception_propogated_on_error_during_mandatory_period(self): fail_refresh = mock.Mock(side_effect=Exception("refresh failed")) creds = IntegerRefresher( creds_last_for=5, advisory_refresh=10, # Note we're in the mandatory period now (5 < 7< 10). mandatory_refresh=7, refresh_function=fail_refresh ) with self.assertRaisesRegexp(Exception, 'refresh failed'): creds.get_frozen_credentials() def test_exception_propogated_on_expired_credentials(self): fail_refresh = mock.Mock(side_effect=Exception("refresh failed")) creds = IntegerRefresher( # Setting this to 0 mean the credentials are immediately # expired. creds_last_for=0, advisory_refresh=10, mandatory_refresh=7, refresh_function=fail_refresh ) with self.assertRaisesRegexp(Exception, 'refresh failed'): # Because credentials are actually expired, any # failure to refresh should be propagated. creds.get_frozen_credentials() def test_refresh_giving_expired_credentials_raises_exception(self): # This verifies an edge cases where refreshed credentials # still give expired credentials: # 1. We see credentials are expired. # 2. We try to refresh the credentials. # 3. The "refreshed" credentials are still expired. # # In this case, we hard fail and let the user know what # happened. creds = IntegerRefresher( # Negative number indicates that the credentials # have already been expired for 2 seconds, even # on refresh. creds_last_for=-2, ) err_msg = 'refreshed credentials are still expired' with self.assertRaisesRegexp(RuntimeError, err_msg): # Because credentials are actually expired, any # failure to refresh should be propagated. creds.get_frozen_credentials() class TestContainerProvider(BaseEnvVar): def test_noop_if_env_var_is_not_set(self): # The 'AWS_CONTAINER_CREDENTIALS_RELATIVE_URI' env var # is not present as an env var. environ = {} provider = credentials.ContainerProvider(environ) creds = provider.load() self.assertIsNone(creds) def test_retrieve_from_provider_if_env_var_present(self): environ = { 'AWS_CONTAINER_CREDENTIALS_RELATIVE_URI': '/latest/credentials?id=foo' } fetcher = mock.Mock(spec=ContainerMetadataFetcher) timeobj = datetime.now(tzlocal()) timestamp = (timeobj + timedelta(hours=24)).isoformat() fetcher.retrieve_uri.return_value = { "AccessKeyId" : "access_key", "SecretAccessKey" : "secret_key", "Token" : "token", "Expiration" : timestamp, } provider = credentials.ContainerProvider(environ, fetcher) creds = provider.load() fetcher.retrieve_uri.assert_called_with('/latest/credentials?id=foo') self.assertEqual(creds.access_key, 'access_key') self.assertEqual(creds.secret_key, 'secret_key') self.assertEqual(creds.token, 'token') self.assertEqual(creds.method, 'container-role') def test_creds_refresh_when_needed(self): environ = { 'AWS_CONTAINER_CREDENTIALS_RELATIVE_URI': '/latest/credentials?id=foo' } fetcher = mock.Mock(spec=credentials.ContainerMetadataFetcher) timeobj = datetime.now(tzlocal()) expired_timestamp = (timeobj - timedelta(hours=23)).isoformat() future_timestamp = (timeobj + timedelta(hours=1)).isoformat() fetcher.retrieve_uri.side_effect = [ { "AccessKeyId" : "access_key_old", "SecretAccessKey" : "secret_key_old", "Token" : "token_old", "Expiration" : expired_timestamp, }, { "AccessKeyId" : "access_key_new", "SecretAccessKey" : "secret_key_new", "Token" : "token_new", "Expiration" : future_timestamp, } ] provider = credentials.ContainerProvider(environ, fetcher) creds = provider.load() frozen_creds = creds.get_frozen_credentials() self.assertEqual(frozen_creds.access_key, 'access_key_new') self.assertEqual(frozen_creds.secret_key, 'secret_key_new') self.assertEqual(frozen_creds.token, 'token_new') def test_http_error_propagated(self): environ = { 'AWS_CONTAINER_CREDENTIALS_RELATIVE_URI': '/latest/credentials?id=foo' } fetcher = mock.Mock(spec=credentials.ContainerMetadataFetcher) timeobj = datetime.now(tzlocal()) expired_timestamp = (timeobj - timedelta(hours=23)).isoformat() future_timestamp = (timeobj + timedelta(hours=1)).isoformat() exception = botocore.exceptions.CredentialRetrievalError fetcher.retrieve_uri.side_effect = exception(provider='ecs-role', error_msg='fake http error') with self.assertRaises(exception): provider = credentials.ContainerProvider(environ, fetcher) creds = provider.load() def test_http_error_propagated_on_refresh(self): # We should ensure errors are still propagated even in the # case of a failed refresh. environ = { 'AWS_CONTAINER_CREDENTIALS_RELATIVE_URI': '/latest/credentials?id=foo' } fetcher = mock.Mock(spec=credentials.ContainerMetadataFetcher) timeobj = datetime.now(tzlocal()) expired_timestamp = (timeobj - timedelta(hours=23)).isoformat() http_exception = botocore.exceptions.MetadataRetrievalError raised_exception = botocore.exceptions.CredentialRetrievalError fetcher.retrieve_uri.side_effect = [ { "AccessKeyId" : "access_key_old", "SecretAccessKey" : "secret_key_old", "Token" : "token_old", "Expiration" : expired_timestamp, }, http_exception(error_msg='HTTP connection timeout') ] provider = credentials.ContainerProvider(environ, fetcher) # First time works with no issues. creds = provider.load() # Second time with a refresh should propagate an error. with self.assertRaises(raised_exception): frozen_creds = creds.get_frozen_credentials() botocore-1.5.7/tests/unit/test_protocols.py0000666454262600001440000003135413042511306022171 0ustar pysdk-ciamazon00000000000000#!/usr/bin/env python # Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. """Test runner for the JSON models compliance tests This is a test runner for all the JSON tests defined in ``tests/unit/protocols/``, including both the input/output tests. You can use the normal ``nosetests tests/unit/test_protocols.py`` to run this test. In addition, there are several env vars you can use during development. Tests are broken down by filename, test suite, testcase. When a test fails you'll see the protocol (filename), test suite, and test case number of the failed test. :: Description : Scalar members (0:0) <--- (suite_id:test_id) Protocol: : ec2 <--- test file (ec2.json) Given : ... Response : ... Expected serialization: ... Actual serialization : ... Assertion message : ... To run tests from only a single file, you can set the BOTOCORE_TEST env var:: BOTOCORE_TEST=tests/unit/compliance/input/json.json nosetests tests/unit/test_protocols.py To run a single test suite you can set the BOTOCORE_TEST_ID env var: BOTOCORE_TEST=tests/unit/compliance/input/json.json BOTOCORE_TEST_ID=5 \ nosetests tests/unit/test_protocols.py To run a single test case in a suite (useful when debugging a single test), you can set the BOTOCORE_TEST_ID env var with the ``suite_id:test_id`` syntax. BOTOCORE_TEST_ID=5:1 nosetests test/unit/test_protocols.py """ import os import copy from dateutil.tz import tzutc from botocore.compat import json, OrderedDict from botocore.awsrequest import AWSRequest from botocore.model import ServiceModel, OperationModel from botocore.serialize import EC2Serializer, QuerySerializer, \ JSONSerializer, RestJSONSerializer, RestXMLSerializer from botocore.parsers import QueryParser, JSONParser, \ RestJSONParser, RestXMLParser from botocore.utils import parse_timestamp, percent_encode_sequence from calendar import timegm from botocore.compat import urlencode from nose.tools import assert_equal as _assert_equal TEST_DIR = os.path.join( os.path.dirname(os.path.abspath(__file__)), 'protocols') NOT_SPECIFIED = object() PROTOCOL_SERIALIZERS = { 'ec2': EC2Serializer, 'query': QuerySerializer, 'json': JSONSerializer, 'rest-json': RestJSONSerializer, 'rest-xml': RestXMLSerializer, } PROTOCOL_PARSERS = { # ec2/query have the same response parsing logic. 'ec2': QueryParser, 'query': QueryParser, 'json': JSONParser, 'rest-json': RestJSONParser, 'rest-xml': RestXMLParser, } def test_compliance(): for full_path in _walk_files(): if full_path.endswith('.json'): for model, case, basename in _load_cases(full_path): if 'params' in case: yield _test_input, model, case, basename elif 'response' in case: yield _test_output, model, case, basename def _test_input(json_description, case, basename): service_description = copy.deepcopy(json_description) service_description['operations'] = { case.get('name', 'OperationName'): case, } model = ServiceModel(service_description) protocol_type = model.metadata['protocol'] try: protocol_serializer = PROTOCOL_SERIALIZERS[protocol_type] except KeyError: raise RuntimeError("Unknown protocol: %s" % protocol_type) serializer = protocol_serializer() serializer.MAP_TYPE = OrderedDict operation_model = OperationModel(case['given'], model) request = serializer.serialize_to_request(case['params'], operation_model) _serialize_request_description(request) try: _assert_request_body_is_bytes(request['body']) _assert_requests_equal(request, case['serialized']) except AssertionError as e: _input_failure_message(protocol_type, case, request, e) def _assert_request_body_is_bytes(body): if not isinstance(body, bytes): raise AssertionError("Expected body to be serialized as type " "bytes(), instead got: %s" % type(body)) def _test_output(json_description, case, basename): service_description = copy.deepcopy(json_description) service_description['operations'] = { case.get('name', 'OperationName'): case, } try: model = ServiceModel(service_description) operation_model = OperationModel(case['given'], model) parser = PROTOCOL_PARSERS[model.metadata['protocol']]( timestamp_parser=_compliance_timestamp_parser) # We load the json as utf-8, but the response parser is at the # botocore boundary, so it expects to work with bytes. body = case['response']['body'] case['response']['body'] = body.encode('utf-8') parsed = parser.parse(case['response'], operation_model.output_shape) parsed = _fixup_parsed_result(parsed) except Exception as e: msg = ( "\nFailed to run test : %s\n" "Protocol : %s\n" "Description : %s (%s:%s)\n" % ( e, model.metadata['protocol'], case['description'], case['suite_id'], case['test_id'])) raise AssertionError(msg) try: assert_equal(parsed, case['result'], "Body") except Exception as e: _output_failure_message(model.metadata['protocol'], case, parsed, e) def _fixup_parsed_result(parsed): # This function contains all the transformation we need # to do from the response _our_ response parsers give # vs. the expected responses in the protocol tests. # These are implementation specific changes, not any # "we're not following the spec"-type changes. # 1. RequestMetadata. We parse this onto the returned dict, but compliance # tests don't have any specs for how to deal with request metadata. if 'ResponseMetadata' in parsed: del parsed['ResponseMetadata'] # 2. Binary blob types. In the protocol test, blob types, when base64 # decoded, always decode to something that can be expressed via utf-8. # This is not always the case. In python3, the blob type is designed to # return a bytes (not str) object. However, for these tests we'll work for # any bytes type, and decode it as utf-8 because we know that's safe for # the compliance tests. parsed = _convert_bytes_to_str(parsed) return parsed def _convert_bytes_to_str(parsed): if isinstance(parsed, dict): new_dict = {} for key, value in parsed.items(): new_dict[key] = _convert_bytes_to_str(value) return new_dict elif isinstance(parsed, bytes): return parsed.decode('utf-8') elif isinstance(parsed, list): new_list = [] for item in parsed: new_list.append(_convert_bytes_to_str(item)) return new_list else: return parsed def _compliance_timestamp_parser(value): datetime = parse_timestamp(value) # Convert from our time zone to UTC datetime = datetime.astimezone(tzutc()) # Convert to epoch. return int(timegm(datetime.timetuple())) def _output_failure_message(protocol_type, case, actual_parsed, error): j = _try_json_dump error_message = ( "\nDescription : %s (%s:%s)\n" "Protocol: : %s\n" "Given : %s\n" "Response : %s\n" "Expected serialization: %s\n" "Actual serialization : %s\n" "Assertion message : %s\n" % ( case['description'], case['suite_id'], case['test_id'], protocol_type, j(case['given']), j(case['response']), j(case['result']), j(actual_parsed), error)) raise AssertionError(error_message) def _input_failure_message(protocol_type, case, actual_request, error): j = _try_json_dump error_message = ( "\nDescription : %s (%s:%s)\n" "Protocol: : %s\n" "Given : %s\n" "Params : %s\n" "Expected serialization: %s\n" "Actual serialization : %s\n" "Assertion message : %s\n" % ( case['description'], case['suite_id'], case['test_id'], protocol_type, j(case['given']), j(case['params']), j(case['serialized']), j(actual_request), error)) raise AssertionError(error_message) def _try_json_dump(obj): try: return json.dumps(obj) except (ValueError, TypeError) as e: return str(obj) def assert_equal(first, second, prefix): # A better assert equals. It allows you to just provide # prefix instead of the entire message. try: _assert_equal(first, second) except Exception: try: better = "%s (actual != expected)\n%s !=\n%s" % ( prefix, json.dumps(first, indent=2), json.dumps(second, indent=2)) except (ValueError, TypeError) as e: better = "%s (actual != expected)\n%s !=\n%s" % ( prefix, first, second) raise AssertionError(better) def _serialize_request_description(request_dict): if isinstance(request_dict.get('body'), dict): # urlencode the request body. encoded = percent_encode_sequence(request_dict['body']).encode('utf-8') request_dict['body'] = encoded if isinstance(request_dict.get('query_string'), dict): encoded = percent_encode_sequence(request_dict.pop('query_string')) if encoded: # 'requests' automatically handle this, but we in the # test runner we need to handle the case where the url_path # already has query params. if '?' not in request_dict['url_path']: request_dict['url_path'] += '?%s' % encoded else: request_dict['url_path'] += '&%s' % encoded def _assert_requests_equal(actual, expected): assert_equal(actual['body'], expected['body'].encode('utf-8'), 'Body value') actual_headers = dict(actual['headers']) expected_headers = expected.get('headers', {}) assert_equal(actual_headers, expected_headers, "Header values") assert_equal(actual['url_path'], expected.get('uri', ''), "URI") if 'method' in expected: assert_equal(actual['method'], expected['method'], "Method") def _walk_files(): # Check for a shortcut when running the tests interactively. # If a BOTOCORE_TEST env var is defined, that file is used as the # only test to run. Useful when doing feature development. single_file = os.environ.get('BOTOCORE_TEST') if single_file is not None: yield os.path.abspath(single_file) else: for root, _, filenames in os.walk(TEST_DIR): for filename in filenames: yield os.path.join(root, filename) def _load_cases(full_path): # During developement, you can set the BOTOCORE_TEST_ID # to run a specific test suite or even a specific test case. # The format is BOTOCORE_TEST_ID=suite_id:test_id or # BOTOCORE_TEST_ID=suite_id suite_id, test_id = _get_suite_test_id() all_test_data = json.load(open(full_path), object_pairs_hook=OrderedDict) basename = os.path.basename(full_path) for i, test_data in enumerate(all_test_data): if suite_id is not None and i != suite_id: continue cases = test_data.pop('cases') description = test_data['description'] for j, case in enumerate(cases): if test_id is not None and j != test_id: continue case['description'] = description case['suite_id'] = i case['test_id'] = j yield (test_data, case, basename) def _get_suite_test_id(): if 'BOTOCORE_TEST_ID' not in os.environ: return None, None test_id = None suite_id = None split = os.environ['BOTOCORE_TEST_ID'].split(':') try: if len(split) == 2: suite_id, test_id = int(split[0]), int(split[1]) else: suite_id = int(split([0])) except TypeError: # Same exception, just give a better error message. raise TypeError("Invalid format for BOTOCORE_TEST_ID, should be " "suite_id[:test_id], and both values should be " "integers.") return suite_id, test_id botocore-1.5.7/tests/unit/test_args.py0000666454262600001440000001165613042511306021104 0ustar pysdk-ciamazon00000000000000#!/usr/bin/env # Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import botocore.config from tests import unittest import mock from botocore import args from botocore.config import Config class TestCreateClientArgs(unittest.TestCase): def setUp(self): self.args_create = args.ClientArgsCreator(None, None, None, None, None) def test_compute_s3_configuration(self): scoped_config = {} client_config = None self.assertIsNone( self.args_create.compute_s3_config( scoped_config, client_config)) def test_compute_s3_config_only_scoped_config(self): scoped_config = { 's3': {'use_accelerate_endpoint': True}, } client_config = None self.assertEqual( self.args_create.compute_s3_config(scoped_config, client_config), {'use_accelerate_endpoint': True} ) def test_client_s3_accelerate_from_varying_forms_of_true(self): scoped_config= {'s3': {'use_accelerate_endpoint': 'True'}} client_config = None self.assertEqual( self.args_create.compute_s3_config( {'s3': {'use_accelerate_endpoint': 'True'}}, client_config=None), {'use_accelerate_endpoint': True} ) self.assertEqual( self.args_create.compute_s3_config( {'s3': {'use_accelerate_endpoint': 'true'}}, client_config=None), {'use_accelerate_endpoint': True} ) self.assertEqual( self.args_create.compute_s3_config( {'s3': {'use_accelerate_endpoint': True}}, client_config=None), {'use_accelerate_endpoint': True} ) def test_client_s3_accelerate_from_client_config(self): self.assertEqual( self.args_create.compute_s3_config( scoped_config=None, client_config=Config(s3={'use_accelerate_endpoint': True}) ), {'use_accelerate_endpoint': True} ) def test_client_s3_accelerate_client_config_overrides_scoped(self): self.assertEqual( self.args_create.compute_s3_config( scoped_config={'s3': {'use_accelerate_endpoint': False}}, client_config=Config(s3={'use_accelerate_endpoint': True}) ), # client_config beats scoped_config {'use_accelerate_endpoint': True} ) def test_client_s3_dualstack_handles_varying_forms_of_true(self): scoped_config= {'s3': {'use_dualstack_endpoint': 'True'}} client_config = None self.assertEqual( self.args_create.compute_s3_config( {'s3': {'use_dualstack_endpoint': 'True'}}, client_config=None), {'use_dualstack_endpoint': True} ) self.assertEqual( self.args_create.compute_s3_config( {'s3': {'use_dualstack_endpoint': 'true'}}, client_config=None), {'use_dualstack_endpoint': True} ) self.assertEqual( self.args_create.compute_s3_config( {'s3': {'use_dualstack_endpoint': True}}, client_config=None), {'use_dualstack_endpoint': True} ) def test_max_pool_from_client_config_forwarded_to_endpoint_creator(self): args_create = args.ClientArgsCreator( mock.Mock(), None, None, None, None) config = botocore.config.Config(max_pool_connections=20) service_model = mock.Mock() service_model.metadata = { 'serviceFullName': 'MyService', 'protocol': 'query' } service_model.operation_names = [] bridge = mock.Mock() bridge.resolve.return_value = { 'region_name': 'us-west-2', 'signature_version': 'v4', 'endpoint_url': 'https://ec2/', 'signing_name': 'ec2', 'signing_region': 'us-west-2', 'metadata': {}} with mock.patch('botocore.args.EndpointCreator') as m: args_create.get_client_args( service_model, 'us-west-2', True, 'https://ec2/', True, None, {}, config, bridge) m.return_value.create_endpoint.assert_called_with( mock.ANY, endpoint_url='https://ec2/', region_name='us-west-2', response_parser_factory=None, timeout=(60, 60), verify=True, max_pool_connections=20 ) botocore-1.5.7/tests/unit/test_model.py0000666454262600001440000006406613042511306021253 0ustar pysdk-ciamazon00000000000000from tests import unittest from botocore import model from botocore.compat import OrderedDict def test_missing_model_attribute_raises_exception(): # We're using a nose test generator here to cut down # on the duplication. The property names below # all have the same test logic. service_model = model.ServiceModel({'metadata': {'endpointPrefix': 'foo'}}) property_names = ['api_version', 'protocol'] def _test_attribute_raise_exception(attr_name): try: getattr(service_model, attr_name) except model.UndefinedModelAttributeError: # This is what we expect, so the test passes. pass except Exception as e: raise AssertionError("Expected UndefinedModelAttributeError to " "be raised, but %s was raised instead" % (e.__class__)) else: raise AssertionError( "Expected UndefinedModelAttributeError to " "be raised, but no exception was raised for: %s" % attr_name) for name in property_names: yield _test_attribute_raise_exception, name class TestServiceModel(unittest.TestCase): def setUp(self): self.model = { 'metadata': {'protocol': 'query', 'endpointPrefix': 'endpoint-prefix'}, 'documentation': 'Documentation value', 'operations': {}, 'shapes': { 'StringShape': {'type': 'string'} } } self.service_model = model.ServiceModel(self.model) def test_metadata_available(self): # You should be able to access the metadata in a service description # through the service model object. self.assertEqual(self.service_model.metadata.get('protocol'), 'query') def test_service_name_can_be_overriden(self): service_model = model.ServiceModel(self.model, service_name='myservice') self.assertEqual(service_model.service_name, 'myservice') def test_service_name_defaults_to_endpoint_prefix(self): self.assertEqual(self.service_model.service_name, 'endpoint-prefix') def test_operation_does_not_exist(self): with self.assertRaises(model.OperationNotFoundError): self.service_model.operation_model('NoExistOperation') def test_signing_name_defaults_to_endpoint_prefix(self): self.assertEqual(self.service_model.signing_name, 'endpoint-prefix') def test_documentation_exposed_as_property(self): self.assertEqual(self.service_model.documentation, 'Documentation value') def test_shape_names(self): self.assertEqual(self.service_model.shape_names, ['StringShape']) class TestOperationModelFromService(unittest.TestCase): def setUp(self): self.model = { 'metadata': {'protocol': 'query', 'endpointPrefix': 'foo'}, 'documentation': '', 'operations': { 'OperationName': { 'http': { 'method': 'POST', 'requestUri': '/', }, 'name': 'OperationName', 'input': { 'shape': 'OperationNameRequest' }, 'output': { 'shape': 'OperationNameResponse', }, 'errors': [{'shape': 'NoSuchResourceException'}], 'documentation': 'Docs for OperationName', } }, 'shapes': { 'OperationNameRequest': { 'type': 'structure', 'members': { 'Arg1': {'shape': 'stringType'}, 'Arg2': {'shape': 'stringType'}, } }, 'OperationNameResponse': { 'type': 'structure', 'members': { 'String': { 'shape': 'stringType', } } }, 'NoSuchResourceException': { 'type': 'structure', 'members': {} }, 'stringType': { 'type': 'string', } } } self.service_model = model.ServiceModel(self.model) def test_wire_name_always_matches_model(self): service_model = model.ServiceModel(self.model) operation = model.OperationModel( self.model['operations']['OperationName'], service_model, 'Foo') self.assertEqual(operation.name, 'Foo') self.assertEqual(operation.wire_name, 'OperationName') def test_operation_name_in_repr(self): service_model = model.ServiceModel(self.model) operation = service_model.operation_model('OperationName') self.assertIn('OperationName', repr(operation)) def test_name_and_wire_name_defaults_to_same_value(self): service_model = model.ServiceModel(self.model) operation = model.OperationModel( self.model['operations']['OperationName'], service_model) self.assertEqual(operation.name, 'OperationName') self.assertEqual(operation.wire_name, 'OperationName') def test_name_from_service(self): service_model = model.ServiceModel(self.model) operation = service_model.operation_model('OperationName') self.assertEqual(operation.name, 'OperationName') def test_name_from_service_model_when_differs_from_name(self): self.model['operations']['Foo'] = \ self.model['operations']['OperationName'] service_model = model.ServiceModel(self.model) operation = service_model.operation_model('Foo') self.assertEqual(operation.name, 'Foo') def test_operation_input_model(self): service_model = model.ServiceModel(self.model) operation = service_model.operation_model('OperationName') self.assertEqual(operation.name, 'OperationName') # Operations should also have a reference to the top level metadata. self.assertEqual(operation.metadata['protocol'], 'query') self.assertEqual(operation.http['method'], 'POST') self.assertEqual(operation.http['requestUri'], '/') shape = operation.input_shape self.assertEqual(shape.name, 'OperationNameRequest') self.assertEqual(list(sorted(shape.members)), ['Arg1', 'Arg2']) def test_has_documentation_property(self): service_model = model.ServiceModel(self.model) operation = service_model.operation_model('OperationName') self.assertEqual(operation.documentation, 'Docs for OperationName') def test_service_model_available_from_operation_model(self): service_model = model.ServiceModel(self.model) operation = service_model.operation_model('OperationName') # This is an identity comparison because we don't implement # __eq__, so we may need to change this in the future. self.assertEqual( operation.service_model, service_model) def test_operation_output_model(self): service_model = model.ServiceModel(self.model) operation = service_model.operation_model('OperationName') output = operation.output_shape self.assertEqual(list(output.members), ['String']) self.assertFalse(operation.has_streaming_output) def test_operation_shape_not_required(self): # It's ok if there's no output shape. We'll just get a return value of # None. del self.model['operations']['OperationName']['output'] service_model = model.ServiceModel(self.model) operation = service_model.operation_model('OperationName') output_shape = operation.output_shape self.assertIsNone(output_shape) def test_error_shapes(self): service_model = model.ServiceModel(self.model) operation = service_model.operation_model('OperationName') # OperationName only has a NoSuchResourceException self.assertEqual(len(operation.error_shapes), 1) self.assertEqual( operation.error_shapes[0].name, 'NoSuchResourceException') class TestOperationModelStreamingTypes(unittest.TestCase): def setUp(self): super(TestOperationModelStreamingTypes, self).setUp() self.model = { 'metadata': {'protocol': 'query', 'endpointPrefix': 'foo'}, 'documentation': '', 'operations': { 'OperationName': { 'name': 'OperationName', 'input': { 'shape': 'OperationRequest', }, 'output': { 'shape': 'OperationResponse', }, } }, 'shapes': { 'OperationRequest': { 'type': 'structure', 'members': { 'String': { 'shape': 'stringType', }, "Body": { 'shape': 'blobType', } }, 'payload': 'Body' }, 'OperationResponse': { 'type': 'structure', 'members': { 'String': { 'shape': 'stringType', }, "Body": { 'shape': 'blobType', } }, 'payload': 'Body' }, 'stringType': { 'type': 'string', }, 'blobType': { 'type': 'blob' } } } def remove_payload(self, type): self.model['shapes']['Operation' + type].pop('payload') def test_streaming_input_for_operation(self): service_model = model.ServiceModel(self.model) operation = service_model.operation_model('OperationName') self.assertTrue(operation.has_streaming_input) self.assertEqual(operation.get_streaming_input().name, 'blobType') def test_not_streaming_input_for_operation(self): self.remove_payload('Request') service_model = model.ServiceModel(self.model) operation = service_model.operation_model('OperationName') self.assertFalse(operation.has_streaming_input) self.assertEqual(operation.get_streaming_input(), None) def test_streaming_output_for_operation(self): service_model = model.ServiceModel(self.model) operation = service_model.operation_model('OperationName') self.assertTrue(operation.has_streaming_output) self.assertEqual(operation.get_streaming_output().name, 'blobType') def test_not_streaming_output_for_operation(self): self.remove_payload('Response') service_model = model.ServiceModel(self.model) operation = service_model.operation_model('OperationName') self.assertFalse(operation.has_streaming_output) self.assertEqual(operation.get_streaming_output(), None) class TestDeepMerge(unittest.TestCase): def setUp(self): self.shapes = { 'SetQueueAttributes': { 'type': 'structure', 'members': { 'MapExample': {'shape': 'StrToStrMap', 'locationName': 'Attribute'}, } }, 'SetQueueAttributes2': { 'type': 'structure', 'members': { 'MapExample': {'shape': 'StrToStrMap', 'locationName': 'Attribute2'}, } }, 'StrToStrMap': { 'type': 'map', 'key': {'shape': 'StringType', 'locationName': 'Name'}, 'value': {'shape': 'StringType', 'locationName': 'Value'}, 'flattened': True, 'name': 'NotAttribute', }, 'StringType': {'type': 'string'} } self.shape_resolver = model.ShapeResolver(self.shapes) def test_deep_merge(self): shape = self.shape_resolver.get_shape_by_name('SetQueueAttributes') map_merged = shape.members['MapExample'] # map_merged has a serialization as a member trait as well as # in the StrToStrMap. # The member trait should have precedence. self.assertEqual(map_merged.serialization, # member beats the definition. {'name': 'Attribute', # From the definition. 'flattened': True,}) # Ensure we don't merge/mutate the original dicts. self.assertEqual(map_merged.key.serialization['name'], 'Name') self.assertEqual(map_merged.value.serialization['name'], 'Value') self.assertEqual(map_merged.key.serialization['name'], 'Name') def test_merges_copy_dict(self): shape = self.shape_resolver.get_shape_by_name('SetQueueAttributes') map_merged = shape.members['MapExample'] self.assertEqual(map_merged.serialization.get('name'), 'Attribute') shape2 = self.shape_resolver.get_shape_by_name('SetQueueAttributes2') map_merged2 = shape2.members['MapExample'] self.assertEqual(map_merged2.serialization.get('name'), 'Attribute2') class TestShapeResolver(unittest.TestCase): def test_get_shape_by_name(self): shape_map = { 'Foo': { 'type': 'structure', 'members': { 'Bar': {'shape': 'StringType'}, 'Baz': {'shape': 'StringType'}, } }, "StringType": { "type": "string" } } resolver = model.ShapeResolver(shape_map) shape = resolver.get_shape_by_name('Foo') self.assertEqual(shape.name, 'Foo') self.assertEqual(shape.type_name, 'structure') def test_resolve_shape_reference(self): shape_map = { 'Foo': { 'type': 'structure', 'members': { 'Bar': {'shape': 'StringType'}, 'Baz': {'shape': 'StringType'}, } }, "StringType": { "type": "string" } } resolver = model.ShapeResolver(shape_map) shape = resolver.resolve_shape_ref({'shape': 'StringType'}) self.assertEqual(shape.name, 'StringType') self.assertEqual(shape.type_name, 'string') def test_resolve_shape_references_with_member_traits(self): shape_map = { 'Foo': { 'type': 'structure', 'members': { 'Bar': {'shape': 'StringType'}, 'Baz': {'shape': 'StringType', 'locationName': 'other'}, } }, "StringType": { "type": "string" } } resolver = model.ShapeResolver(shape_map) shape = resolver.resolve_shape_ref({'shape': 'StringType', 'locationName': 'other'}) self.assertEqual(shape.serialization['name'], 'other') self.assertEqual(shape.name, 'StringType') def test_serialization_cache(self): shape_map = { 'Foo': { 'type': 'structure', 'members': { 'Baz': {'shape': 'StringType', 'locationName': 'other'}, } }, "StringType": { "type": "string" } } resolver = model.ShapeResolver(shape_map) shape = resolver.resolve_shape_ref({'shape': 'StringType', 'locationName': 'other'}) self.assertEqual(shape.serialization['name'], 'other') # serialization is computed on demand, and a cache is kept. # This is just verifying that trying to access serialization again # gives the same result. We don't actually care that it's cached, # we just care that the cache doesn't mess with correctness. self.assertEqual(shape.serialization['name'], 'other') def test_shape_overrides(self): shape_map = { "StringType": { "type": "string", "documentation": "Original documentation" } } resolver = model.ShapeResolver(shape_map) shape = resolver.get_shape_by_name('StringType') self.assertEqual(shape.documentation, 'Original documentation') shape = resolver.resolve_shape_ref({'shape': 'StringType', 'documentation': 'override'}) self.assertEqual(shape.documentation, 'override') def test_shape_type_structure(self): shapes = { 'ChangePasswordRequest': { 'type': 'structure', 'members': { 'OldPassword': {'shape': 'passwordType'}, 'NewPassword': {'shape': 'passwordType'}, } }, 'passwordType': { "type":"string", } } resolver = model.ShapeResolver(shapes) shape = resolver.get_shape_by_name('ChangePasswordRequest') self.assertEqual(shape.type_name, 'structure') self.assertEqual(shape.name, 'ChangePasswordRequest') self.assertEqual(list(sorted(shape.members)), ['NewPassword', 'OldPassword']) self.assertEqual(shape.members['OldPassword'].name, 'passwordType') self.assertEqual(shape.members['OldPassword'].type_name, 'string') def test_shape_metadata(self): shapes = { 'ChangePasswordRequest': { 'type': 'structure', 'required': ['OldPassword', 'NewPassword'], 'members': { 'OldPassword': {'shape': 'passwordType'}, 'NewPassword': {'shape': 'passwordType'}, } }, 'passwordType': { "type":"string", "min":1, "max":128, "sensitive":True } } resolver = model.ShapeResolver(shapes) shape = resolver.get_shape_by_name('ChangePasswordRequest') self.assertEqual(shape.metadata['required'], ['OldPassword', 'NewPassword']) member = shape.members['OldPassword'] self.assertEqual(member.metadata['min'], 1) self.assertEqual(member.metadata['max'], 128) self.assertEqual(member.metadata['sensitive'], True) def test_shape_list(self): shapes = { 'mfaDeviceListType': { "type":"list", "member": {"shape": "MFADevice"}, }, 'MFADevice': { 'type': 'structure', 'members': { 'UserName': {'shape': 'userNameType'} } }, 'userNameType': { 'type': 'string' } } resolver = model.ShapeResolver(shapes) shape = resolver.get_shape_by_name('mfaDeviceListType') self.assertEqual(shape.member.type_name, 'structure') self.assertEqual(shape.member.name, 'MFADevice') self.assertEqual(list(shape.member.members), ['UserName']) def test_shape_does_not_exist(self): resolver = model.ShapeResolver({}) with self.assertRaises(model.NoShapeFoundError): resolver.get_shape_by_name('NoExistShape') def test_missing_type_key(self): shapes = { 'UnknownType': { 'NotTheTypeKey': 'someUnknownType' } } resolver = model.ShapeResolver(shapes) with self.assertRaises(model.InvalidShapeError): resolver.get_shape_by_name('UnknownType') def test_bad_shape_ref(self): # This is an example of a denormalized model, # which should raise an exception. shapes = { 'Struct': { 'type': 'structure', 'members': { 'A': {'type': 'string'}, 'B': {'type': 'string'}, } } } resolver = model.ShapeResolver(shapes) with self.assertRaises(model.InvalidShapeReferenceError): struct = resolver.get_shape_by_name('Struct') # Resolving the members will fail because # the 'A' and 'B' members are not shape refs. struct.members def test_shape_name_in_repr(self): shapes = { 'StringType': { 'type': 'string', } } resolver = model.ShapeResolver(shapes) self.assertIn('StringType', repr(resolver.get_shape_by_name('StringType'))) class TestBuilders(unittest.TestCase): def test_structure_shape_builder_with_scalar_types(self): b = model.DenormalizedStructureBuilder() shape = b.with_members({ 'A': {'type': 'string'}, 'B': {'type': 'integer'}, }).build_model() self.assertIsInstance(shape, model.StructureShape) self.assertEqual(sorted(list(shape.members)), ['A', 'B']) self.assertEqual(shape.members['A'].type_name, 'string') self.assertEqual(shape.members['B'].type_name, 'integer') def test_structure_shape_with_structure_type(self): b = model.DenormalizedStructureBuilder() shape = b.with_members({ 'A': { 'type': 'structure', 'members': { 'A-1': {'type': 'string'}, } }, }).build_model() self.assertIsInstance(shape, model.StructureShape) self.assertEqual(list(shape.members), ['A']) self.assertEqual(shape.members['A'].type_name, 'structure') self.assertEqual(list(shape.members['A'].members), ['A-1']) def test_structure_shape_with_list(self): b = model.DenormalizedStructureBuilder() shape = b.with_members({ 'A': { 'type': 'list', 'member': { 'type': 'string' } }, }).build_model() self.assertIsInstance(shape.members['A'], model.ListShape) self.assertEqual(shape.members['A'].member.type_name, 'string') def test_structure_shape_with_map_type(self): b = model.DenormalizedStructureBuilder() shape = b.with_members({ 'A': { 'type': 'map', 'key': {'type': 'string'}, 'value': {'type': 'string'}, } }).build_model() self.assertIsInstance(shape.members['A'], model.MapShape) map_shape = shape.members['A'] self.assertEqual(map_shape.key.type_name, 'string') self.assertEqual(map_shape.value.type_name, 'string') def test_nested_structure(self): b = model.DenormalizedStructureBuilder() shape = b.with_members({ 'A': { 'type': 'structure', 'members': { 'B': { 'type': 'structure', 'members': { 'C': { 'type': 'string', } } } } } }).build_model() self.assertEqual( shape.members['A'].members['B'].members['C'].type_name, 'string') def test_enum_values_on_string_used(self): b = model.DenormalizedStructureBuilder() enum_values = ['foo', 'bar', 'baz'] shape = b.with_members({ 'A': { 'type': 'string', 'enum': enum_values, }, }).build_model() self.assertIsInstance(shape, model.StructureShape) string_shape = shape.members['A'] self.assertIsInstance(string_shape, model.StringShape) self.assertEqual(string_shape.metadata['enum'], enum_values) self.assertEqual(string_shape.enum, enum_values) def test_documentation_on_shape_used(self): b = model.DenormalizedStructureBuilder() shape = b.with_members({ 'A': { 'type': 'string', 'documentation': 'MyDocs', }, }).build_model() self.assertEqual(shape.members['A'].documentation, 'MyDocs') def test_use_shape_name_when_provided(self): b = model.DenormalizedStructureBuilder() shape = b.with_members({ 'A': { 'type': 'string', 'shape_name': 'MyStringShape', }, }).build_model() self.assertEqual(shape.members['A'].name, 'MyStringShape') def test_unknown_shape_type(self): b = model.DenormalizedStructureBuilder() with self.assertRaises(model.InvalidShapeError): b.with_members({ 'A': { 'type': 'brand-new-shape-type', }, }).build_model() def test_ordered_shape_builder(self): b = model.DenormalizedStructureBuilder() shape = b.with_members(OrderedDict( [ ('A', { 'type': 'string' }), ('B', { 'type': 'structure', 'members': OrderedDict( [ ('C', { 'type': 'string' }), ('D', { 'type': 'string' }) ] ) }) ] )).build_model() # Members should be in order self.assertEqual(['A', 'B'], list(shape.members.keys())) # Nested structure members should *also* stay ordered self.assertEqual(['C', 'D'], list(shape.members['B'].members.keys())) if __name__ == '__main__': unittest.main() botocore-1.5.7/tests/unit/test_response.py0000666454262600001440000001757113042511306022010 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest from tests.unit import BaseResponseTest import datetime from dateutil.tz import tzutc import botocore from botocore import response from botocore.compat import six from botocore.exceptions import IncompleteReadError from botocore.vendored.requests.models import Response, Request XMLBODY1 = (b'' b'AccessDenied' b'Access Denied' b'XXXXXXXXXXXXXXXX' b'AAAAAAAAAAAAAAAAAAA' b'') XMLBODY2 = (b'' b'' b'mybucket' b'1000false' b'test.png2014-03-01T17:06:40.000Z' b'"00000000000000000000000000000000"6702' b'AAAAAAAAAAAAAAAAAAA' b'dummy' b'STANDARD') class TestStreamWrapper(unittest.TestCase): def test_streaming_wrapper_validates_content_length(self): body = six.BytesIO(b'1234567890') stream = response.StreamingBody(body, content_length=10) self.assertEqual(stream.read(), b'1234567890') def test_streaming_body_with_invalid_length(self): body = six.BytesIO(b'123456789') stream = response.StreamingBody(body, content_length=10) with self.assertRaises(IncompleteReadError): self.assertEqual(stream.read(9), b'123456789') # The next read will have nothing returned and raise # an IncompleteReadError because we were expectd 10 bytes, not 9. stream.read() def test_streaming_body_with_single_read(self): body = six.BytesIO(b'123456789') stream = response.StreamingBody(body, content_length=10) with self.assertRaises(IncompleteReadError): stream.read() def test_streaming_body_closes(self): body = six.BytesIO(b'1234567890') stream = response.StreamingBody(body, content_length=10) self.assertFalse(body.closed) stream.close() self.assertTrue(body.closed) class TestGetResponse(BaseResponseTest): maxDiff = None def test_get_response_streaming_ok(self): http_response = Response() http_response.headers = { 'content-type': 'image/png', 'server': 'AmazonS3', 'AcceptRanges': 'bytes', 'transfer-encoding': 'chunked', 'ETag': '"00000000000000000000000000000000"', } http_response.raw = six.BytesIO(b'\x89PNG\r\n\x1a\n\x00\x00') http_response.status_code = 200 http_response.reason = 'OK' session = botocore.session.get_session() service_model = session.get_service_model('s3') operation_model = service_model.operation_model('GetObject') res = response.get_response(operation_model, http_response) self.assertTrue(isinstance(res[1]['Body'], response.StreamingBody)) self.assertEqual(res[1]['ETag'], '"00000000000000000000000000000000"') def test_get_response_streaming_ng(self): http_response = Response() http_response.headers = { 'content-type': 'application/xml', 'date': 'Sat, 08 Mar 2014 12:05:44 GMT', 'server': 'AmazonS3', 'transfer-encoding': 'chunked', 'x-amz-id-2': 'AAAAAAAAAAAAAAAAAAA', 'x-amz-request-id': 'XXXXXXXXXXXXXXXX'} http_response.raw = six.BytesIO(XMLBODY1) http_response.status_code = 403 http_response.reason = 'Forbidden' session = botocore.session.get_session() service_model = session.get_service_model('s3') operation_model = service_model.operation_model('GetObject') self.assert_response_with_subset_metadata( response.get_response(operation_model, http_response)[1], {'Error': {'Message': 'Access Denied', 'Code': 'AccessDenied'}, 'ResponseMetadata': {'HostId': 'AAAAAAAAAAAAAAAAAAA', 'RequestId': 'XXXXXXXXXXXXXXXX', 'HTTPStatusCode': 403}, } ) def test_get_response_nonstreaming_ok(self): http_response = Response() http_response.headers = { 'content-type': 'application/xml', 'date': 'Sun, 09 Mar 2014 02:55:43 GMT', 'server': 'AmazonS3', 'transfer-encoding': 'chunked', 'x-amz-id-2': 'AAAAAAAAAAAAAAAAAAA', 'x-amz-request-id': 'XXXXXXXXXXXXXXXX'} http_response.raw = six.BytesIO(XMLBODY1) http_response.status_code = 403 http_response.reason = 'Forbidden' http_response.request = Request() session = botocore.session.get_session() service_model = session.get_service_model('s3') operation_model = service_model.operation_model('ListObjects') self.assert_response_with_subset_metadata( response.get_response(operation_model, http_response)[1], { 'ResponseMetadata': { 'RequestId': 'XXXXXXXXXXXXXXXX', 'HostId': 'AAAAAAAAAAAAAAAAAAA', 'HTTPStatusCode': 403 }, 'Error': { 'Message': 'Access Denied', 'Code': 'AccessDenied' } }) def test_get_response_nonstreaming_ng(self): http_response = Response() http_response.headers = { 'content-type': 'application/xml', 'date': 'Sat, 08 Mar 2014 12:05:44 GMT', 'server': 'AmazonS3', 'transfer-encoding': 'chunked', 'x-amz-id-2': 'AAAAAAAAAAAAAAAAAAA', 'x-amz-request-id': 'XXXXXXXXXXXXXXXX'} http_response.raw = six.BytesIO(XMLBODY2) http_response.status_code = 200 http_response.reason = 'ok' http_response.request = Request() session = botocore.session.get_session() service_model = session.get_service_model('s3') operation_model = service_model.operation_model('ListObjects') self.assert_response_with_subset_metadata( response.get_response(operation_model, http_response)[1], {u'Contents': [{u'ETag': '"00000000000000000000000000000000"', u'Key': 'test.png', u'LastModified': datetime.datetime(2014, 3, 1, 17, 6, 40, tzinfo=tzutc()), u'Owner': {u'DisplayName': 'dummy', u'ID': 'AAAAAAAAAAAAAAAAAAA'}, u'Size': 6702, u'StorageClass': 'STANDARD'}], u'IsTruncated': False, u'Marker': "", u'MaxKeys': 1000, u'Name': 'mybucket', u'Prefix': "", 'ResponseMetadata': { 'RequestId': 'XXXXXXXXXXXXXXXX', 'HostId': 'AAAAAAAAAAAAAAAAAAA', 'HTTPStatusCode': 200, }} ) botocore-1.5.7/tests/unit/test_paginate.py0000666454262600001440000012326313042511306021736 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest from botocore.paginate import Paginator from botocore.paginate import PaginatorModel from botocore.exceptions import PaginationError from botocore.compat import six import mock import base64 import json def encode_token(token): return base64.b64encode(json.dumps(token).encode('utf-8')).decode('utf-8') class TestPaginatorModel(unittest.TestCase): def setUp(self): self.paginator_config = {} self.paginator_config['pagination'] = { 'ListFoos': { 'output_token': 'NextToken', 'input_token': 'NextToken', 'result_key': 'Foo' } } self.paginator_model = PaginatorModel(self.paginator_config) def test_get_paginator(self): paginator_config = self.paginator_model.get_paginator('ListFoos') self.assertEqual( paginator_config, {'output_token': 'NextToken', 'input_token': 'NextToken', 'result_key': 'Foo'} ) def test_get_paginator_no_exists(self): with self.assertRaises(ValueError): paginator_config = self.paginator_model.get_paginator('ListBars') class TestPagination(unittest.TestCase): def setUp(self): self.method = mock.Mock() self.paginate_config = { 'output_token': 'NextToken', 'input_token': 'NextToken', 'result_key': 'Foo', } self.paginator = Paginator(self.method, self.paginate_config) def test_result_key_available(self): self.assertEqual( [rk.expression for rk in self.paginator.result_keys], ['Foo'] ) def test_no_next_token(self): response = {'not_the_next_token': 'foobar'} self.method.return_value = response actual = list(self.paginator.paginate()) self.assertEqual(actual, [{'not_the_next_token': 'foobar'}]) def test_next_token_in_response(self): responses = [{'NextToken': 'token1'}, {'NextToken': 'token2'}, {'not_next_token': 'foo'}] self.method.side_effect = responses actual = list(self.paginator.paginate()) self.assertEqual(actual, responses) # The first call has no next token, the second and third call should # have 'token1' and 'token2' respectively. self.assertEqual(self.method.call_args_list, [mock.call(), mock.call(NextToken='token1'), mock.call(NextToken='token2')]) def test_next_token_is_string(self): self.paginate_config = { "output_token": "Marker", "input_token": "Marker", "result_key": "Users", "limit_key": "MaxKeys", } self.paginator = Paginator(self.method, self.paginate_config) responses = [ {"Users": ["User1"], "Marker": "m1"}, {"Users": ["User2"], "Marker": "m2"}, {"Users": ["User3"]} ] self.method.side_effect = responses result = self.paginator.paginate(PaginationConfig={'MaxItems': 1}) result = result.build_full_result() token = result.get('NextToken') self.assertIsInstance(token, six.string_types) def test_any_passed_in_args_are_unmodified(self): responses = [{'NextToken': 'token1'}, {'NextToken': 'token2'}, {'not_next_token': 'foo'}] self.method.side_effect = responses actual = list(self.paginator.paginate(Foo='foo', Bar='bar')) self.assertEqual(actual, responses) self.assertEqual( self.method.call_args_list, [mock.call(Foo='foo', Bar='bar'), mock.call(Foo='foo', Bar='bar', NextToken='token1'), mock.call(Foo='foo', Bar='bar', NextToken='token2')]) def test_exception_raised_if_same_next_token(self): responses = [{'NextToken': 'token1'}, {'NextToken': 'token2'}, {'NextToken': 'token2'}] self.method.side_effect = responses with self.assertRaises(PaginationError): list(self.paginator.paginate()) def test_next_token_with_or_expression(self): self.pagination_config = { 'output_token': 'NextToken || NextToken2', 'input_token': 'NextToken', 'result_key': 'Foo', } self.paginator = Paginator(self.method, self.pagination_config) # Verify that despite varying between NextToken and NextToken2 # we still can extract the right next tokens. responses = [ {'NextToken': 'token1'}, {'NextToken2': 'token2'}, # The first match found wins, so because NextToken is # listed before NextToken2 in the 'output_tokens' config, # 'token3' is chosen over 'token4'. {'NextToken': 'token3', 'NextToken2': 'token4'}, {'not_next_token': 'foo'}, ] self.method.side_effect = responses list(self.paginator.paginate()) self.assertEqual( self.method.call_args_list, [mock.call(), mock.call(NextToken='token1'), mock.call(NextToken='token2'), mock.call(NextToken='token3')]) def test_more_tokens(self): # Some pagination configs have a 'more_token' key that # indicate whether or not the results are being paginated. self.paginate_config = { 'more_results': 'IsTruncated', 'output_token': 'NextToken', 'input_token': 'NextToken', 'result_key': 'Foo', } self.paginator = Paginator(self.method, self.paginate_config) responses = [ {'Foo': [1], 'IsTruncated': True, 'NextToken': 'token1'}, {'Foo': [2], 'IsTruncated': True, 'NextToken': 'token2'}, {'Foo': [3], 'IsTruncated': False, 'NextToken': 'token3'}, {'Foo': [4], 'not_next_token': 'foo'}, ] self.method.side_effect = responses list(self.paginator.paginate()) self.assertEqual( self.method.call_args_list, [mock.call(), mock.call(NextToken='token1'), mock.call(NextToken='token2')]) def test_more_tokens_is_path_expression(self): self.paginate_config = { 'more_results': 'Foo.IsTruncated', 'output_token': 'NextToken', 'input_token': 'NextToken', 'result_key': 'Bar', } self.paginator = Paginator(self.method, self.paginate_config) responses = [ {'Foo': {'IsTruncated': True}, 'NextToken': 'token1'}, {'Foo': {'IsTruncated': False}, 'NextToken': 'token2'}, ] self.method.side_effect = responses list(self.paginator.paginate()) self.assertEqual( self.method.call_args_list, [mock.call(), mock.call(NextToken='token1')]) def test_page_size(self): self.paginate_config = { "output_token": "Marker", "input_token": "Marker", "result_key": "Users", "limit_key": "MaxKeys", } self.paginator = Paginator(self.method, self.paginate_config) responses = [ {"Users": ["User1"], "Marker": "m1"}, {"Users": ["User2"], "Marker": "m2"}, {"Users": ["User3"]}, ] self.method.side_effect = responses users = [] for page in self.paginator.paginate(PaginationConfig={'PageSize': 1}): users += page['Users'] self.assertEqual( self.method.call_args_list, [mock.call(MaxKeys=1), mock.call(Marker='m1', MaxKeys=1), mock.call(Marker='m2', MaxKeys=1)] ) def test_with_empty_markers(self): responses = [ {"Users": ["User1"], "Marker": ""}, {"Users": ["User1"], "Marker": ""}, {"Users": ["User1"], "Marker": ""} ] self.method.side_effect = responses users = [] for page in self.paginator.paginate(): users += page['Users'] # We want to stop paginating if the next token is empty. self.assertEqual( self.method.call_args_list, [mock.call()] ) self.assertEqual(users, ['User1']) def test_build_full_result_with_single_key(self): self.paginate_config = { "output_token": "Marker", "input_token": "Marker", "result_key": "Users", "limit_key": "MaxKeys", } self.paginator = Paginator(self.method, self.paginate_config) responses = [ {"Users": ["User1"], "Marker": "m1"}, {"Users": ["User2"], "Marker": "m2"}, {"Users": ["User3"]} ] self.method.side_effect = responses pages = self.paginator.paginate() complete = pages.build_full_result() self.assertEqual(complete, {'Users': ['User1', 'User2', 'User3']}) class TestPaginatorPageSize(unittest.TestCase): def setUp(self): self.method = mock.Mock() self.paginate_config = { "output_token": "Marker", "input_token": "Marker", "result_key": ["Users", "Groups"], 'limit_key': 'MaxKeys', } self.paginator = Paginator(self.method, self.paginate_config) self.endpoint = mock.Mock() def test_no_page_size(self): kwargs = {'arg1': 'foo', 'arg2': 'bar'} ref_kwargs = {'arg1': 'foo', 'arg2': 'bar'} pages = self.paginator.paginate(**kwargs) pages._inject_starting_params(kwargs) self.assertEqual(kwargs, ref_kwargs) def test_page_size(self): kwargs = {'arg1': 'foo', 'arg2': 'bar', 'PaginationConfig': {'PageSize': 5}} extracted_kwargs = {'arg1': 'foo', 'arg2': 'bar'} # Note that ``MaxKeys`` in ``setUp()`` is the parameter used for # the page size for pagination. ref_kwargs = {'arg1': 'foo', 'arg2': 'bar', 'MaxKeys': 5} pages = self.paginator.paginate(**kwargs) pages._inject_starting_params(extracted_kwargs) self.assertEqual(extracted_kwargs, ref_kwargs) def test_page_size_incorrectly_provided(self): kwargs = {'arg1': 'foo', 'arg2': 'bar', 'PaginationConfig': {'PageSize': 5}} del self.paginate_config['limit_key'] with self.assertRaises(PaginationError): self.paginator.paginate(**kwargs) class TestPaginatorWithPathExpressions(unittest.TestCase): def setUp(self): self.method = mock.Mock() # This is something we'd see in s3 pagination. self.paginate_config = { 'output_token': [ 'NextMarker || ListBucketResult.Contents[-1].Key'], 'input_token': 'next_marker', 'result_key': 'Contents', } self.paginator = Paginator(self.method, self.paginate_config) def test_s3_list_objects(self): responses = [ {'NextMarker': 'token1'}, {'NextMarker': 'token2'}, {'not_next_token': 'foo'}] self.method.side_effect = responses list(self.paginator.paginate()) self.assertEqual( self.method.call_args_list, [mock.call(), mock.call(next_marker='token1'), mock.call(next_marker='token2')]) def test_s3_list_object_complex(self): responses = [ {'NextMarker': 'token1'}, {'ListBucketResult': { 'Contents': [{"Key": "first"}, {"Key": "Last"}]}}, {'not_next_token': 'foo'}] self.method.side_effect = responses list(self.paginator.paginate()) self.assertEqual( self.method.call_args_list, [mock.call(), mock.call(next_marker='token1'), mock.call(next_marker='Last')]) class TestMultipleTokens(unittest.TestCase): def setUp(self): self.method = mock.Mock() # This is something we'd see in s3 pagination. self.paginate_config = { "output_token": ["ListBucketResults.NextKeyMarker", "ListBucketResults.NextUploadIdMarker"], "input_token": ["key_marker", "upload_id_marker"], "result_key": 'Foo', } self.paginator = Paginator(self.method, self.paginate_config) def test_s3_list_multipart_uploads(self): responses = [ {"Foo": [1], "ListBucketResults": {"NextKeyMarker": "key1", "NextUploadIdMarker": "up1"}}, {"Foo": [2], "ListBucketResults": {"NextKeyMarker": "key2", "NextUploadIdMarker": "up2"}}, {"Foo": [3], "ListBucketResults": {"NextKeyMarker": "key3", "NextUploadIdMarker": "up3"}}, {} ] self.method.side_effect = responses list(self.paginator.paginate()) self.assertEqual( self.method.call_args_list, [mock.call(), mock.call(key_marker='key1', upload_id_marker='up1'), mock.call(key_marker='key2', upload_id_marker='up2'), mock.call(key_marker='key3', upload_id_marker='up3'), ]) class TestOptionalTokens(unittest.TestCase): """ Tests a paginator with an optional output token. The Route53 ListResourceRecordSets paginator includes three output tokens, one of which only appears in certain records. If this gets left in the request params from a previous page, the API will skip over a record. """ def setUp(self): self.method = mock.Mock() # This is based on Route53 pagination. self.paginate_config = { "output_token": ["NextRecordName", "NextRecordType", "NextRecordIdentifier"], "input_token": ["StartRecordName", "StartRecordType", "StartRecordIdentifier"], "result_key": 'Foo', } self.paginator = Paginator(self.method, self.paginate_config) def test_clean_token(self): responses = [ {"Foo": [1], "IsTruncated": True, "NextRecordName": "aaa.example.com", "NextRecordType": "A", "NextRecordIdentifier": "id"}, {"Foo": [2], "IsTruncated": True, "NextRecordName": "bbb.example.com", "NextRecordType": "A"}, {"Foo": [3], "IsTruncated": False}, ] self.method.side_effect = responses list(self.paginator.paginate()) self.assertEqual( self.method.call_args_list, [mock.call(), mock.call(StartRecordName='aaa.example.com', StartRecordType='A', StartRecordIdentifier='id'), mock.call(StartRecordName='bbb.example.com', StartRecordType='A') ]) class TestKeyIterators(unittest.TestCase): def setUp(self): self.method = mock.Mock() # This is something we'd see in s3 pagination. self.paginate_config = { "output_token": "Marker", "input_token": "Marker", "result_key": "Users" } self.paginator = Paginator(self.method, self.paginate_config) def test_result_key_iters(self): responses = [ {"Users": ["User1"], "Marker": "m1"}, {"Users": ["User2"], "Marker": "m2"}, {"Users": ["User3"]}, ] self.method.side_effect = responses pages = self.paginator.paginate() iterators = pages.result_key_iters() self.assertEqual(len(iterators), 1) self.assertEqual(list(iterators[0]), ["User1", "User2", "User3"]) def test_build_full_result_with_single_key(self): responses = [ {"Users": ["User1"], "Marker": "m1"}, {"Users": ["User2"], "Marker": "m2"}, {"Users": ["User3"]}, ] self.method.side_effect = responses pages = self.paginator.paginate() complete = pages.build_full_result() self.assertEqual(complete, {'Users': ['User1', 'User2', 'User3']}) def test_max_items_can_be_specified(self): paginator = Paginator(self.method, self.paginate_config) responses = [ {"Users": ["User1"], "Marker": "m1"}, {"Users": ["User2"], "Marker": "m2"}, {"Users": ["User3"]}, ] self.method.side_effect = responses expected_token = encode_token({"Marker": "m1"}) self.assertEqual( paginator.paginate( PaginationConfig={'MaxItems': 1}).build_full_result(), {'Users': ['User1'], 'NextToken': expected_token}) def test_max_items_as_strings(self): # Some services (route53) model MaxItems as a string type. # We need to be able to handle this case. paginator = Paginator(self.method, self.paginate_config) responses = [ {"Users": ["User1"], "Marker": "m1"}, {"Users": ["User2"], "Marker": "m2"}, {"Users": ["User3"]}, ] self.method.side_effect = responses expected_token = encode_token({"Marker": "m1"}) self.assertEqual( # Note MaxItems is a string here. paginator.paginate( PaginationConfig={'MaxItems': '1'}).build_full_result(), {'Users': ['User1'], 'NextToken': expected_token}) def test_next_token_on_page_boundary(self): paginator = Paginator(self.method, self.paginate_config) responses = [ {"Users": ["User1"], "Marker": "m1"}, {"Users": ["User2"], "Marker": "m2"}, {"Users": ["User3"]}, ] self.method.side_effect = responses expected_token = encode_token({"Marker": "m2"}) self.assertEqual( paginator.paginate( PaginationConfig={'MaxItems': 2}).build_full_result(), {'Users': ['User1', 'User2'], 'NextToken': expected_token}) def test_max_items_can_be_specified_truncates_response(self): # We're saying we only want 4 items, but notice that the second # page of results returns users 4-6 so we have to truncated # part of that second page. paginator = Paginator(self.method, self.paginate_config) responses = [ {"Users": ["User1", "User2", "User3"], "Marker": "m1"}, {"Users": ["User4", "User5", "User6"], "Marker": "m2"}, {"Users": ["User7"]}, ] self.method.side_effect = responses expected_token = encode_token( {"Marker": "m1", "boto_truncate_amount": 1}) self.assertEqual( paginator.paginate( PaginationConfig={'MaxItems': 4}).build_full_result(), {'Users': ['User1', 'User2', 'User3', 'User4'], 'NextToken': expected_token}) def test_resume_next_marker_mid_page(self): # This is a simulation of picking up from the response # from test_MaxItems_can_be_specified_truncates_response # We got the first 4 users, when we pick up we should get # User5 - User7. paginator = Paginator(self.method, self.paginate_config) responses = [ {"Users": ["User4", "User5", "User6"], "Marker": "m2"}, {"Users": ["User7"]}, ] self.method.side_effect = responses starting_token = encode_token( {"Marker": "m1", "boto_truncate_amount": 1}) pagination_config = {'StartingToken': starting_token} self.assertEqual( paginator.paginate( PaginationConfig=pagination_config).build_full_result(), {'Users': ['User5', 'User6', 'User7']}) self.assertEqual( self.method.call_args_list, [mock.call(Marker='m1'), mock.call(Marker='m2')]) def test_max_items_exceeds_actual_amount(self): # Because MaxItems=10 > number of users (3), we should just return # all of the users. paginator = Paginator(self.method, self.paginate_config) responses = [ {"Users": ["User1"], "Marker": "m1"}, {"Users": ["User2"], "Marker": "m2"}, {"Users": ["User3"]}, ] self.method.side_effect = responses self.assertEqual( paginator.paginate( PaginationConfig={'MaxItems': 10}).build_full_result(), {'Users': ['User1', 'User2', 'User3']}) def test_bad_input_tokens(self): responses = [ {"Users": ["User1"], "Marker": "m1"}, {"Users": ["User2"], "Marker": "m2"}, {"Users": ["User3"]}, ] self.method.side_effect = responses with self.assertRaisesRegexp(ValueError, 'Bad starting token'): pagination_config = {'StartingToken': 'does___not___work'} self.paginator.paginate( PaginationConfig=pagination_config).build_full_result() class TestMultipleResultKeys(unittest.TestCase): def setUp(self): self.method = mock.Mock() # This is something we'd see in s3 pagination. self.paginate_config = { "output_token": "Marker", "input_token": "Marker", "result_key": ["Users", "Groups"], } self.paginator = Paginator(self.method, self.paginate_config) def test_build_full_result_with_multiple_result_keys(self): responses = [ {"Users": ["User1"], "Groups": ["Group1"], "Marker": "m1"}, {"Users": ["User2"], "Groups": ["Group2"], "Marker": "m2"}, {"Users": ["User3"], "Groups": ["Group3"]}, ] self.method.side_effect = responses pages = self.paginator.paginate() complete = pages.build_full_result() self.assertEqual(complete, {"Users": ['User1', 'User2', 'User3'], "Groups": ['Group1', 'Group2', 'Group3']}) def test_build_full_result_with_different_length_result_keys(self): responses = [ {"Users": ["User1"], "Groups": ["Group1"], "Marker": "m1"}, # Then we stop getting "Users" output, but we get more "Groups" {"Users": [], "Groups": ["Group2"], "Marker": "m2"}, {"Users": [], "Groups": ["Group3"]}, ] self.method.side_effect = responses pages = self.paginator.paginate() complete = pages.build_full_result() self.assertEqual(complete, {"Users": ['User1'], "Groups": ['Group1', 'Group2', 'Group3']}) def test_build_full_result_with_zero_length_result_key(self): responses = [ # In this case the 'Users' key is always empty but we should # have a 'Users' key in the output, it should just have an # empty list for a value. {"Users": [], "Groups": ["Group1"], "Marker": "m1"}, {"Users": [], "Groups": ["Group2"], "Marker": "m2"}, {"Users": [], "Groups": ["Group3"]}, ] self.method.side_effect = responses pages = self.paginator.paginate() complete = pages.build_full_result() self.assertEqual(complete, {"Users": [], "Groups": ['Group1', 'Group2', 'Group3']}) def test_build_result_with_secondary_keys(self): responses = [ {"Users": ["User1", "User2"], "Groups": ["Group1", "Group2"], "Marker": "m1"}, {"Users": ["User3"], "Groups": ["Group3"], "Marker": "m2"}, {"Users": ["User4"], "Groups": ["Group4"]}, ] self.method.side_effect = responses pages = self.paginator.paginate( PaginationConfig={'MaxItems': 1}) complete = pages.build_full_result() expected_token = encode_token( {"Marker": None, "boto_truncate_amount": 1}) self.assertEqual(complete, {"Users": ["User1"], "Groups": ["Group1", "Group2"], "NextToken": expected_token}) def test_resume_with_secondary_keys(self): # This is simulating a continutation of the previous test, # test_build_result_with_secondary_keys. We use the # token specified in the response "None___1" to continue where we # left off. responses = [ {"Users": ["User1", "User2"], "Groups": ["Group1", "Group2"], "Marker": "m1"}, {"Users": ["User3"], "Groups": ["Group3"], "Marker": "m2"}, {"Users": ["User4"], "Groups": ["Group4"]}, ] self.method.side_effect = responses starting_token = encode_token( {"Marker": None, "boto_truncate_amount": 1}) pages = self.paginator.paginate( PaginationConfig={'MaxItems': 1, 'StartingToken': starting_token}) complete = pages.build_full_result() # Note that the secondary keys ("Groups") are all truncated because # they were in the original (first) response. expected_token = encode_token({"Marker": "m1"}) self.assertEqual(complete, {"Users": ["User2"], "Groups": [], "NextToken": expected_token}) def test_resume_with_secondary_result_as_string(self): self.method.return_value = {"Users": ["User1", "User2"], "Groups": "a"} starting_token = encode_token( {"Marker": None, "boto_truncate_amount": 1}) pages = self.paginator.paginate( PaginationConfig={'MaxItems': 1, 'StartingToken': starting_token}) complete = pages.build_full_result() # Note that the secondary keys ("Groups") becomes empty string because # they were in the original (first) response. self.assertEqual(complete, {"Users": ["User2"], "Groups": ""}) def test_resume_with_secondary_result_as_integer(self): self.method.return_value = {"Users": ["User1", "User2"], "Groups": 123} starting_token = encode_token( {"Marker": None, "boto_truncate_amount": 1}) pages = self.paginator.paginate( PaginationConfig={'MaxItems': 1, 'StartingToken': starting_token}) complete = pages.build_full_result() # Note that the secondary keys ("Groups") becomes zero because # they were in the original (first) response. self.assertEqual(complete, {"Users": ["User2"], "Groups": 0}) class TestMultipleInputKeys(unittest.TestCase): def setUp(self): self.method = mock.Mock() # Probably the most complicated example we'll see: # multiple input/output/result keys. self.paginate_config = { "output_token": ["Marker1", "Marker2"], "input_token": ["InMarker1", "InMarker2"], "result_key": ["Users", "Groups"], } self.paginator = Paginator(self.method, self.paginate_config) def test_build_full_result_with_multiple_input_keys(self): responses = [ {"Users": ["User1", "User2"], "Groups": ["Group1"], "Marker1": "m1", "Marker2": "m2"}, {"Users": ["User3", "User4"], "Groups": ["Group2"], "Marker1": "m3", "Marker2": "m4"}, {"Users": ["User5"], "Groups": ["Group3"]} ] self.method.side_effect = responses pages = self.paginator.paginate( PaginationConfig={'MaxItems': 3}) complete = pages.build_full_result() expected_token = encode_token( {"InMarker1": "m1", "InMarker2": "m2", "boto_truncate_amount": 1}) self.assertEqual(complete, {"Users": ['User1', 'User2', 'User3'], "Groups": ['Group1', 'Group2'], "NextToken": expected_token}) def test_resume_with_multiple_input_keys(self): responses = [ {"Users": ["User3", "User4"], "Groups": ["Group2"], "Marker1": "m3", "Marker2": "m4"}, {"Users": ["User5"], "Groups": ["Group3"]}, ] self.method.side_effect = responses starting_token = encode_token( {"InMarker1": "m1", "InMarker2": "m2", "boto_truncate_amount": 1}) pages = self.paginator.paginate( PaginationConfig={'MaxItems': 1, 'StartingToken': starting_token}) complete = pages.build_full_result() expected_token = encode_token( {"InMarker1": "m3", "InMarker2": "m4"}) self.assertEqual(complete, {"Users": ['User4'], "Groups": [], "NextToken": expected_token}) self.assertEqual( self.method.call_args_list, [mock.call(InMarker1='m1', InMarker2='m2')]) def test_resume_encounters_an_empty_payload(self): response = {"not_a_result_key": "it happens in some service"} self.method.return_value = response starting_token = encode_token( {"Marker": None, "boto_truncate_amount": 1}) complete = self.paginator \ .paginate(PaginationConfig={'StartingToken': starting_token}) \ .build_full_result() self.assertEqual(complete, {}) def test_result_key_exposed_on_paginator(self): self.assertEqual( [rk.expression for rk in self.paginator.result_keys], ['Users', 'Groups'] ) def test_result_key_exposed_on_page_iterator(self): pages = self.paginator.paginate(MaxItems=3) self.assertEqual( [rk.expression for rk in pages.result_keys], ['Users', 'Groups'] ) class TestExpressionKeyIterators(unittest.TestCase): def setUp(self): self.method = mock.Mock() # This is something like what we'd see in RDS. self.paginate_config = { "input_token": "Marker", "output_token": "Marker", "limit_key": "MaxRecords", "result_key": "EngineDefaults.Parameters" } self.paginator = Paginator(self.method, self.paginate_config) self.responses = [ {"EngineDefaults": {"Parameters": ["One", "Two"]}, "Marker": "m1"}, {"EngineDefaults": {"Parameters": ["Three", "Four"]}, "Marker": "m2"}, {"EngineDefaults": {"Parameters": ["Five"]}} ] def test_result_key_iters(self): self.method.side_effect = self.responses pages = self.paginator.paginate() iterators = pages.result_key_iters() self.assertEqual(len(iterators), 1) self.assertEqual(list(iterators[0]), ['One', 'Two', 'Three', 'Four', 'Five']) def test_build_full_result_with_single_key(self): self.method.side_effect = self.responses pages = self.paginator.paginate() complete = pages.build_full_result() self.assertEqual(complete, { 'EngineDefaults': { 'Parameters': ['One', 'Two', 'Three', 'Four', 'Five'] }, }) class TestIncludeResultKeys(unittest.TestCase): def setUp(self): self.method = mock.Mock() self.paginate_config = { 'output_token': 'Marker', 'input_token': 'Marker', 'result_key': ['ResultKey', 'Count', 'Log'], } self.paginator = Paginator(self.method, self.paginate_config) def test_different_kinds_of_result_key(self): self.method.side_effect = [ {'ResultKey': ['a'], 'Count': 1, 'Log': 'x', 'Marker': 'a'}, {'not_a_result_key': 'this page will be ignored', 'Marker': '_'}, {'ResultKey': ['b', 'c'], 'Count': 2, 'Log': 'y', 'Marker': 'b'}, {'ResultKey': ['d', 'e', 'f'], 'Count': 3, 'Log': 'z'}, ] pages = self.paginator.paginate() expected = { 'ResultKey': ['a', 'b', 'c', 'd', 'e', 'f'], 'Count': 6, 'Log': 'xyz', } self.assertEqual(pages.build_full_result(), expected) def test_result_key_is_missing(self): self.method.side_effect = [ {'not_a_result_key': 'this page will be ignored', 'Marker': '_'}, {'neither_this_one': 'this page will be ignored, too'}, ] pages = self.paginator.paginate() expected = {} self.assertEqual(pages.build_full_result(), expected) class TestIncludeNonResultKeys(unittest.TestCase): maxDiff = None def setUp(self): self.method = mock.Mock() self.paginate_config = { 'output_token': 'NextToken', 'input_token': 'NextToken', 'result_key': 'ResultKey', 'non_aggregate_keys': ['NotResultKey'], } self.paginator = Paginator(self.method, self.paginate_config) def test_include_non_aggregate_keys(self): self.method.side_effect = [ {'ResultKey': ['foo'], 'NotResultKey': 'a', 'NextToken': 't1'}, {'ResultKey': ['bar'], 'NotResultKey': 'a', 'NextToken': 't2'}, {'ResultKey': ['baz'], 'NotResultKey': 'a'}, ] pages = self.paginator.paginate() actual = pages.build_full_result() self.assertEqual(pages.non_aggregate_part, {'NotResultKey': 'a'}) expected = { 'ResultKey': ['foo', 'bar', 'baz'], 'NotResultKey': 'a', } self.assertEqual(actual, expected) def test_include_with_multiple_result_keys(self): self.paginate_config['result_key'] = ['ResultKey1', 'ResultKey2'] self.paginator = Paginator(self.method, self.paginate_config) self.method.side_effect = [ {'ResultKey1': ['a', 'b'], 'ResultKey2': ['u', 'v'], 'NotResultKey': 'a', 'NextToken': 'token1'}, {'ResultKey1': ['c', 'd'], 'ResultKey2': ['w', 'x'], 'NotResultKey': 'a', 'NextToken': 'token2'}, {'ResultKey1': ['e', 'f'], 'ResultKey2': ['y', 'z'], 'NotResultKey': 'a'} ] pages = self.paginator.paginate() actual = pages.build_full_result() expected = { 'ResultKey1': ['a', 'b', 'c', 'd', 'e', 'f'], 'ResultKey2': ['u', 'v', 'w', 'x', 'y', 'z'], 'NotResultKey': 'a', } self.assertEqual(actual, expected) def test_include_with_nested_result_keys(self): self.paginate_config['result_key'] = 'Result.Key' self.paginate_config['non_aggregate_keys'] = [ 'Outer', 'Result.Inner', ] self.paginator = Paginator(self.method, self.paginate_config) self.method.side_effect = [ # The non result keys shows hypothetical # example. This doesn't actually happen, # but in the case where the non result keys # are different across pages, we use the values # from the first page. {'Result': {'Key': ['foo'], 'Inner': 'v1'}, 'Outer': 'v2', 'NextToken': 't1'}, {'Result': {'Key': ['bar', 'baz'], 'Inner': 'v3'}, 'Outer': 'v4', 'NextToken': 't2'}, {'Result': {'Key': ['qux'], 'Inner': 'v5'}, 'Outer': 'v6', 'NextToken': 't3'}, ] pages = self.paginator.paginate() actual = pages.build_full_result() self.assertEqual(pages.non_aggregate_part, {'Outer': 'v2', 'Result': {'Inner': 'v1'}}) expected = { 'Result': {'Key': ['foo', 'bar', 'baz', 'qux'], 'Inner': 'v1'}, 'Outer': 'v2', } self.assertEqual(actual, expected) class TestSearchOverResults(unittest.TestCase): def setUp(self): self.method = mock.Mock() self.paginate_config = { 'more_results': 'IsTruncated', 'output_token': 'NextToken', 'input_token': 'NextToken', 'result_key': 'Foo', } self.paginator = Paginator(self.method, self.paginate_config) responses = [ {'Foo': [{'a': 1}, {'b': 2}], 'IsTruncated': True, 'NextToken': '1'}, {'Foo': [{'a': 3}, {'b': 4}], 'IsTruncated': True, 'NextToken': '2'}, {'Foo': [{'a': 5}], 'IsTruncated': False, 'NextToken': '3'} ] self.method.side_effect = responses def test_yields_non_list_values(self): result = list(self.paginator.paginate().search('Foo[0].a')) self.assertEqual([1, 3, 5], result) def test_yields_individual_list_values(self): result = list(self.paginator.paginate().search('Foo[].*[]')) self.assertEqual([1, 2, 3, 4, 5], result) def test_empty_when_no_match(self): result = list(self.paginator.paginate().search('Foo[].qux')) self.assertEqual([], result) def test_no_yield_when_no_match_on_page(self): result = list(self.paginator.paginate().search('Foo[].b')) self.assertEqual([2, 4], result) class TestDeprecatedStartingToken(unittest.TestCase): def setUp(self): self.method = mock.Mock() def create_paginator(self, multiple_tokens=False): if multiple_tokens: paginator_config = { "output_token": ["Marker1", "Marker2"], "input_token": ["InMarker1", "InMarker2"], "result_key": ["Users", "Groups"], } else: paginator_config = { 'output_token': 'Marker', 'input_token': 'Marker', 'result_key': 'Users', } return Paginator(self.method, paginator_config) def assert_pagination_result(self, expected, pagination_config, multiple_tokens=False): paginator = self.create_paginator(multiple_tokens) try: actual = paginator.paginate( PaginationConfig=pagination_config).build_full_result() self.assertEqual(actual, expected) except ValueError: self.fail("Deprecated paginator failed.") def test_deprecated_starting_token(self): responses = [ {"Users": ["User1"], "Marker": "m2"}, {"Users": ["User2"], "Marker": "m3"}, {"Users": ["User3"]}, ] self.method.side_effect = responses pagination_config = {'StartingToken': 'm1___0'} expected = {'Users': ['User1', 'User2', 'User3']} self.assert_pagination_result(expected, pagination_config) def test_deprecated_multiple_starting_token(self): responses = [ { "Users": ["User1", "User2"], "Groups": ["Group1"], "Marker1": "m1", "Marker2": "m2" }, { "Users": ["User3", "User4"], "Groups": ["Group2"], "Marker1": "m3", "Marker2": "m4" }, { "Users": ["User5"], "Groups": ["Group3"] } ] self.method.side_effect = responses pagination_config = {'StartingToken': 'm0___m0___1'} expected = { 'Groups': ['Group2', 'Group3'], 'Users': ['User2', 'User3', 'User4', 'User5'] } self.assert_pagination_result( expected, pagination_config, multiple_tokens=True) def test_deprecated_starting_token_returns_new_style_next_token(self): responses = [ {"Users": ["User1"], "Marker": "m2"}, {"Users": ["User2"], "Marker": "m3"}, {"Users": ["User3"], "Marker": "m4"}, ] self.method.side_effect = responses pagination_config = {'StartingToken': 'm1___0', 'MaxItems': 3} expected = { 'Users': ['User1', 'User2', 'User3'], 'NextToken': encode_token({'Marker': 'm4'}) } self.assert_pagination_result(expected, pagination_config) def test_deprecated_starting_token_without_all_input_set_to_none(self): responses = [ { "Users": ["User1", "User2"], "Groups": ["Group1"], "Marker1": "m1", "Marker2": "m2" }, { "Users": ["User3", "User4"], "Groups": ["Group2"], "Marker1": "m3", "Marker2": "m4" }, { "Users": ["User5"], "Groups": ["Group3"] } ] self.method.side_effect = responses pagination_config = {'StartingToken': 'm0'} expected = { 'Groups': ['Group2', 'Group3'], 'Users': ['User1', 'User2', 'User3', 'User4', 'User5'] } self.assert_pagination_result( expected, pagination_config, multiple_tokens=True) def test_deprecated_starting_token_rejects_too_many_input_tokens(self): responses = [ {"Users": ["User1"], "Marker": "m2"}, {"Users": ["User2"], "Marker": "m3"}, {"Users": ["User3"]}, ] self.method.side_effect = responses pagination_config = {'StartingToken': 'm1___m4___0'} expected = {'Users': ['User1', 'User2', 'User3']} paginator = self.create_paginator() with self.assertRaises(ValueError): actual = paginator.paginate( PaginationConfig=pagination_config).build_full_result() self.assertEqual(actual, expected) if __name__ == '__main__': unittest.main() botocore-1.5.7/tests/unit/auth/0000777454262600001440000000000013042511310017462 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/auth/aws4_testsuite/0000777454262600001440000000000013042511310022451 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-space.sreq0000666454262600001440000000042213042511306025220 0ustar pysdk-ciamazon00000000000000GET /%20/foo http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=f309cfbd10197a230c42dd17dbf5cca8a0722564cb40a872d25623cfa758e374 botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query.sts0000666454262600001440000000021213042511306026552 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 366b91fb121d72a00f46bbe8d395f53a102b06dfb7e79636515208ed3fa606b1botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla.authz0000666454262600001440000000026113042511306026143 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=22902d79e148b64e7571c3565769328423fe276eae4b26f83afceda9e767f726botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-unreserved.req0000666454262600001440000000021313042511306026122 0ustar pysdk-ciamazon00000000000000GET /-._~0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-utf8.creq0000666454262600001440000000023513042511306024775 0ustar pysdk-ciamazon00000000000000GET /%25E1%2588%25B4 date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slashes.sts0000666454262600001440000000021213042511306025423 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 6bb4476ee8745730c9cb79f33a0c70baa6d8af29c0077fa12e4e8f1dd17e7098botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded.creq0000666454262600001440000000031413042511306030467 0ustar pysdk-ciamazon00000000000000POST / content-type:application/x-www-form-urlencoded date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com content-type;date;host 3ba8907e7a252327488df390ed517c45b96dead033600219bdca7107d1d3f88abotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key-case.creq0000666454262600001440000000023513042511306031510 0ustar pysdk-ciamazon00000000000000GET / foo=Zoo&foo=aha date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-empty-query-value.creq0000666454262600001440000000022613042511306031354 0ustar pysdk-ciamazon00000000000000POST / foo=bar date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-unreserved.creq0000666454262600001440000000042313042511306031057 0ustar pysdk-ciamazon00000000000000GET / -._~0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz=-._~0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-header-key-case.creq0000666454262600001440000000021713042511306027244 0ustar pysdk-ciamazon00000000000000POST / date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slash.creq0000666454262600001440000000021613042511306025220 0ustar pysdk-ciamazon00000000000000GET / date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-header-key-sort.creq0000666454262600001440000000023713042511306027322 0ustar pysdk-ciamazon00000000000000POST / date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com zoo:zoobar date;host;zoo e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-relative-relative.sreq0000666454262600001440000000043013042511306027550 0ustar pysdk-ciamazon00000000000000GET /foo/bar/../.. http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b27ccfbfa7df52a200ff74193ca6e32d4b48b8856fab7ebf1c595d0670a7e470 botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-relative.sts0000666454262600001440000000021213042511306025574 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 366b91fb121d72a00f46bbe8d395f53a102b06dfb7e79636515208ed3fa606b1botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slash-pointless-dot.sreq0000666454262600001440000000042013042511306030037 0ustar pysdk-ciamazon00000000000000GET /./foo http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=910e4d6c9abafaf87898e1eb4c929135782ea25bb0279703146455745391e63a botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-empty-query-value.sts0000666454262600001440000000021213042511306031226 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request cd4f39132d8e60bb388831d734230460872b564871c47f5de62e62d1a68dbe1ebotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-unreserved.creq0000666454262600001440000000032013042511306026264 0ustar pysdk-ciamazon00000000000000GET /-._~0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-empty-query-value.req0000666454262600001440000000012213042511306031204 0ustar pysdk-ciamazon00000000000000POST /?foo=bar http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-query-nonunreserved.sreq0000666454262600001440000000047613042511306032030 0ustar pysdk-ciamazon00000000000000POST /?@#$%^&+=/,?><`";:\|][{} =@#$%^&+=/,?><`";:\|][{} http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=28675d93ac1d686ab9988d6617661da4dffe7ba848a2285cb75eac6512e861f9 botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded-parameters.authz0000666454262600001440000000027613042511306033040 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=content-type;date;host, Signature=b105eb10c6d318d2294de9d49dd8b031b55e3c3fe139f2e637da70511e9e7b71botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-header-key-sort.authz0000666454262600001440000000026513042511306027524 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host;zoo, Signature=b7a95a52518abbca0964a999a880429ab734f35ebbf1235bd79a5de87756dc4abotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-relative-relative.sts0000666454262600001440000000021213042511306027405 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 366b91fb121d72a00f46bbe8d395f53a102b06dfb7e79636515208ed3fa606b1botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-header-key-sort.sreq0000666454262600001440000000043413042511306027341 0ustar pysdk-ciamazon00000000000000POST / http/1.1 DATE:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com ZOO:zoobar Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host;zoo, Signature=b7a95a52518abbca0964a999a880429ab734f35ebbf1235bd79a5de87756dc4a botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-header-value-trim.req0000666454262600001440000000012513042511306027255 0ustar pysdk-ciamazon00000000000000POST / http/1.1 DATE:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com p: phfft botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla.req0000666454262600001440000000011213042511306025572 0ustar pysdk-ciamazon00000000000000POST / http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-empty-query-key.sts0000666454262600001440000000021213042511306030474 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 0846c2945b0832deb7a463c66af5c4f8bd54ec28c438e67a214445b157c9ddf8botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-ut8-query.authz0000666454262600001440000000026113042511306027616 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=6fb359e9a05394cc7074e0feb42573a2601abc0c869a953e8c5c12e4e01f1a8cbotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-utf8.req0000666454262600001440000000012213042511306024625 0ustar pysdk-ciamazon00000000000000GET /%E1%88%B4 http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key-case.sreq0000666454262600001440000000043313042511306031530 0ustar pysdk-ciamazon00000000000000GET /?foo=Zoo&foo=aha http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=be7148d34ebccdc6423b19085378aa0bee970bdc61d144bd1a8c48c33079ab09 botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key.authz0000666454262600001440000000026113042511306030777 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=0dc122f3b28b831ab48ba65cb47300de53fbe91b577fe113edac383730254a3bbotocore-1.5.7/tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded-parameters.creq0000666454262600001440000000033213042511306032630 0ustar pysdk-ciamazon00000000000000POST / content-type:application/x-www-form-urlencoded; charset=utf8 date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com content-type;date;host 3ba8907e7a252327488df390ed517c45b96dead033600219bdca7107d1d3f88abotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-unreserved.sts0000666454262600001440000000021213042511306030732 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request d2578f3156d4c9d180713d1ff20601d8a3eed0dd35447d24603d7d67414bd6b5botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-space.sts0000666454262600001440000000021213042511306025054 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 35975885599128f8963ce9be7219598b2b5a344321bae304529556c891e9e6babotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-ut8-query.sreq0000666454262600001440000000042313042511306027435 0ustar pysdk-ciamazon00000000000000GET /?ሴ=bar http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=6fb359e9a05394cc7074e0feb42573a2601abc0c869a953e8c5c12e4e01f1a8c botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-header-value-order.creq0000666454262600001440000000023413042511306027561 0ustar pysdk-ciamazon00000000000000POST / date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com p:a,a,p,z date;host;p e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-header-value-order.authz0000666454262600001440000000026313042511306027764 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host;p, Signature=d2973954263943b11624a11d1c963ca81fb274169c7868b2858c04f083199e3dbotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-relative-relative.authz0000666454262600001440000000026113042511306027733 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b27ccfbfa7df52a200ff74193ca6e32d4b48b8856fab7ebf1c595d0670a7e470botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded-parameters.sts0000666454262600001440000000021213042511306032504 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request c4115f9e54b5cecf192b1eaa23b8e88ed8dc5391bd4fde7b3fff3d9c9fe0af1fbotocore-1.5.7/tests/unit/auth/aws4_testsuite/post-header-value-case.req0000666454262600001440000000012613042511306027424 0ustar pysdk-ciamazon00000000000000POST / http/1.1 DATE:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com zoo:ZOOBAR botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-relative-relative.req0000666454262600001440000000012613042511306027367 0ustar pysdk-ciamazon00000000000000GET /foo/bar/../.. http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded.authz0000666454262600001440000000027613042511306030677 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=content-type;date;host, Signature=5a15b22cf462f047318703b92e6f4f38884e4a7ab7b1d6426ca46a8bd1c26cbcbotocore-1.5.7/tests/unit/auth/aws4_testsuite/post-header-key-case.sts0000666454262600001440000000021213042511306027116 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 05da62cee468d24ae84faff3c39f1b85540de60243c1bcaace39c0a2acc7b2c4botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-header-value-case.creq0000666454262600001440000000023713042511306027572 0ustar pysdk-ciamazon00000000000000POST / date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com zoo:ZOOBAR date;host;zoo e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-header-value-trim.sreq0000666454262600001440000000043113042511306027440 0ustar pysdk-ciamazon00000000000000POST / http/1.1 DATE:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com p: phfft Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host;p, Signature=debf546796015d6f6ded8626f5ce98597c33b47b9164cf6b17b4642036fcb592 botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla.sts0000666454262600001440000000021213042511306025615 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 05da62cee468d24ae84faff3c39f1b85540de60243c1bcaace39c0a2acc7b2c4botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slash.sreq0000666454262600001440000000041413042511306025240 0ustar pysdk-ciamazon00000000000000GET // http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b27ccfbfa7df52a200ff74193ca6e32d4b48b8856fab7ebf1c595d0670a7e470 botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slash-pointless-dot.authz0000666454262600001440000000026113042511306030223 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=910e4d6c9abafaf87898e1eb4c929135782ea25bb0279703146455745391e63abotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-order-value.req0000666454262600001440000000012513042511306030756 0ustar pysdk-ciamazon00000000000000GET /?foo=b&foo=a http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-header-key-case.sreq0000666454262600001440000000041413042511306027263 0ustar pysdk-ciamazon00000000000000POST / http/1.1 DATE:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=22902d79e148b64e7571c3565769328423fe276eae4b26f83afceda9e767f726 botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-empty-query-key.req0000666454262600001440000000012113042511306030451 0ustar pysdk-ciamazon00000000000000GET /?foo=bar http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-header-value-trim.sts0000666454262600001440000000021213042511306027274 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request dddd1902add08da1ac94782b05f9278c08dc7468db178a84f8950d93b30b1f35botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-query-space.req0000666454262600001440000000012413042511306030031 0ustar pysdk-ciamazon00000000000000POST /?f oo=b ar http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-empty-query-value.sreq0000666454262600001440000000042413042511306031374 0ustar pysdk-ciamazon00000000000000POST /?foo=bar http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b6e3b79003ce0743a491606ba1035a804593b0efb1e20a11cba83f8c25a57a92 botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-unreserved.authz0000666454262600001440000000026113042511306031260 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=f1498ddb4d6dae767d97c466fb92f1b59a2c71ca29ac954692663f9db03426fbbotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-order-value.sreq0000666454262600001440000000042713042511306031146 0ustar pysdk-ciamazon00000000000000GET /?foo=b&foo=a http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=feb926e49e382bec75c9d7dcb2a1b6dc8aa50ca43c25d2bc51143768c0875acc botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-query-nonunreserved.authz0000666454262600001440000000026113042511306032201 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=28675d93ac1d686ab9988d6617661da4dffe7ba848a2285cb75eac6512e861f9botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-order-value.creq0000666454262600001440000000023113042511306031117 0ustar pysdk-ciamazon00000000000000GET / foo=a&foo=b date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slash-dot-slash.sts0000666454262600001440000000021213042511306026767 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 366b91fb121d72a00f46bbe8d395f53a102b06dfb7e79636515208ed3fa606b1botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-query-space.sts0000666454262600001440000000021213042511306030051 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 0d5f8ed88e9cd0a2a093e1719fff945e3718d30a6b240b9de994cdf9442c89f5botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-query.authz0000666454262600001440000000026113042511306027306 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b6e3b79003ce0743a491606ba1035a804593b0efb1e20a11cba83f8c25a57a92botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slash.req0000666454262600001440000000011213042511306025050 0ustar pysdk-ciamazon00000000000000GET // http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-query.sts0000666454262600001440000000021213042511306026760 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request cd4f39132d8e60bb388831d734230460872b564871c47f5de62e62d1a68dbe1ebotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-unreserved.authz0000666454262600001440000000026113042511306026471 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=830cc36d03f0f84e6ee4953fbe701c1c8b71a0372c63af9255aa364dd183281ebotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-header-key-duplicate.authz0000666454262600001440000000026513042511306030301 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host;zoo, Signature=54afcaaf45b331f81cd2edb974f7b824ff4dd594cbbaa945ed636b48477368edbotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-relative.req0000666454262600001440000000011713042511306025556 0ustar pysdk-ciamazon00000000000000GET /foo/.. http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-space.authz0000666454262600001440000000026113042511306025402 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=2be9e587d1ee1f0fd02128724b86b4358ba3630d39f493b6e06610a19a50779ebotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query.sreq0000666454262600001440000000041313042511306026716 0ustar pysdk-ciamazon00000000000000GET / http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b27ccfbfa7df52a200ff74193ca6e32d4b48b8856fab7ebf1c595d0670a7e470 botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key.sreq0000666454262600001440000000042713042511306030622 0ustar pysdk-ciamazon00000000000000GET /?a=foo&b=foo http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=0dc122f3b28b831ab48ba65cb47300de53fbe91b577fe113edac383730254a3b botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-empty-query-key.sreq0000666454262600001440000000042313042511306030641 0ustar pysdk-ciamazon00000000000000GET /?foo=bar http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=56c054473fd260c13e4e7393eb203662195f5d4a1fada5314b8b52b23f985e9f botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slashes.sreq0000666454262600001440000000042113042511306025566 0ustar pysdk-ciamazon00000000000000GET //foo// http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b00392262853cfe3201e47ccf945601079e9b8a7f51ee4c3d9ee4f187aa9bf19 botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla.sreq0000666454262600001440000000041313042511306025553 0ustar pysdk-ciamazon00000000000000GET / http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b27ccfbfa7df52a200ff74193ca6e32d4b48b8856fab7ebf1c595d0670a7e470 botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla.req0000666454262600001440000000011113042511306025363 0ustar pysdk-ciamazon00000000000000GET / http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slash-dot-slash.sreq0000666454262600001440000000041513042511306027135 0ustar pysdk-ciamazon00000000000000GET /./ http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b27ccfbfa7df52a200ff74193ca6e32d4b48b8856fab7ebf1c595d0670a7e470 botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded.sts0000666454262600001440000000021213042511306030343 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 4c5c6e4b52fb5fb947a8733982a8a5a61b14f04345cbfe6e739236c76dd48f74botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slash.sts0000666454262600001440000000021213042511306025073 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 366b91fb121d72a00f46bbe8d395f53a102b06dfb7e79636515208ed3fa606b1botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded.req0000666454262600001440000000020113042511306030317 0ustar pysdk-ciamazon00000000000000POST / http/1.1 Content-Type:application/x-www-form-urlencoded Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com foo=barbotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key-case.sts0000666454262600001440000000021213042511306031362 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request e25f777ba161a0f1baf778a87faf057187cf5987f17953320e3ca399feb5f00dbotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-ut8-query.req0000666454262600001440000000012113042511306027245 0ustar pysdk-ciamazon00000000000000GET /?ሴ=bar http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-query-space.sreq0000666454262600001440000000042613042511306030221 0ustar pysdk-ciamazon00000000000000POST /?f oo=b ar http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b7eb653abe5f846e7eee4d1dba33b15419dc424aaf215d49b1240732b10cc4ca botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key.sts0000666454262600001440000000021213042511306030451 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 2f23d14fe13caebf6dfda346285c6d9c14f49eaca8f5ec55c627dd7404f7a727botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-header-key-duplicate.sreq0000666454262600001440000000046413042511306030121 0ustar pysdk-ciamazon00000000000000POST / http/1.1 DATE:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com ZOO:zoobar zoo:foobar zoo:zoobar Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host;zoo, Signature=54afcaaf45b331f81cd2edb974f7b824ff4dd594cbbaa945ed636b48477368ed botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query.authz0000666454262600001440000000026113042511306027100 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b27ccfbfa7df52a200ff74193ca6e32d4b48b8856fab7ebf1c595d0670a7e470botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-space.req0000666454262600001440000000012013042511306025030 0ustar pysdk-ciamazon00000000000000GET /%20/foo http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-query-space.creq0000666454262600001440000000022113042511306030172 0ustar pysdk-ciamazon00000000000000POST / f= date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slash-dot-slash.req0000666454262600001440000000011313042511306026745 0ustar pysdk-ciamazon00000000000000GET /./ http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slash-dot-slash.creq0000666454262600001440000000021613042511306027114 0ustar pysdk-ciamazon00000000000000GET / date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-header-value-order.sreq0000666454262600001440000000044213042511306027602 0ustar pysdk-ciamazon00000000000000POST / http/1.1 DATE:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com p:z p:a p:p p:a Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host;p, Signature=d2973954263943b11624a11d1c963ca81fb274169c7868b2858c04f083199e3d botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key.creq0000666454262600001440000000023113042511306030573 0ustar pysdk-ciamazon00000000000000GET / a=foo&b=foo date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-header-value-case.sreq0000666454262600001440000000043413042511306027611 0ustar pysdk-ciamazon00000000000000POST / http/1.1 DATE:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com zoo:ZOOBAR Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host;zoo, Signature=273313af9d0c265c531e11db70bbd653f3ba074c1009239e8559d3987039cad7 botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slashes.creq0000666454262600001440000000022213042511306025545 0ustar pysdk-ciamazon00000000000000GET /foo/ date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-header-value-trim.authz0000666454262600001440000000026313042511306027624 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host;p, Signature=debf546796015d6f6ded8626f5ce98597c33b47b9164cf6b17b4642036fcb592botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-utf8.sreq0000666454262600001440000000042413042511306025015 0ustar pysdk-ciamazon00000000000000GET /%E1%88%B4 http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=8d6634c189aa8c75c2e51e106b6b5121bed103fdb351f7d7d4381c738823af74 botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-relative-relative.creq0000666454262600001440000000021613042511306027532 0ustar pysdk-ciamazon00000000000000GET / date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slash-pointless-dot.req0000666454262600001440000000011613042511306027656 0ustar pysdk-ciamazon00000000000000GET /./foo http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded-parameters.req0000666454262600001440000000021713042511306032467 0ustar pysdk-ciamazon00000000000000POST / http/1.1 Content-Type:application/x-www-form-urlencoded; charset=utf8 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com foo=barbotocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-query.sreq0000666454262600001440000000042413042511306027126 0ustar pysdk-ciamazon00000000000000POST /?foo=bar http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b6e3b79003ce0743a491606ba1035a804593b0efb1e20a11cba83f8c25a57a92 botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla.sts0000666454262600001440000000021213042511306025407 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 366b91fb121d72a00f46bbe8d395f53a102b06dfb7e79636515208ed3fa606b1botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-header-key-case.authz0000666454262600001440000000026113042511306027444 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=22902d79e148b64e7571c3565769328423fe276eae4b26f83afceda9e767f726botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-order-value.authz0000666454262600001440000000026113042511306031323 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=feb926e49e382bec75c9d7dcb2a1b6dc8aa50ca43c25d2bc51143768c0875accbotocore-1.5.7/tests/unit/auth/aws4_testsuite/post-header-key-sort.sts0000666454262600001440000000021213042511306027172 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 34e1bddeb99e76ee01d63b5e28656111e210529efeec6cdfd46a48e4c734545dbotocore-1.5.7/tests/unit/auth/aws4_testsuite/post-header-key-sort.req0000666454262600001440000000012613042511306027154 0ustar pysdk-ciamazon00000000000000POST / http/1.1 DATE:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com ZOO:zoobar botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-unreserved.sreq0000666454262600001440000000051513042511306026312 0ustar pysdk-ciamazon00000000000000GET /-._~0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=830cc36d03f0f84e6ee4953fbe701c1c8b71a0372c63af9255aa364dd183281e botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-relative.sreq0000666454262600001440000000042113042511306025737 0ustar pysdk-ciamazon00000000000000GET /foo/.. http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b27ccfbfa7df52a200ff74193ca6e32d4b48b8856fab7ebf1c595d0670a7e470 botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-query-nonunreserved.req0000666454262600001440000000017413042511306031640 0ustar pysdk-ciamazon00000000000000POST /?@#$%^&+=/,?><`";:\|][{} =@#$%^&+=/,?><`";:\|][{} http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-ut8-query.creq0000666454262600001440000000023313042511306027414 0ustar pysdk-ciamazon00000000000000GET / %E1%88%B4=bar date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-header-value-order.sts0000666454262600001440000000021213042511306027434 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 94c0389fefe0988cbbedc8606f0ca0b485b48da010d09fc844b45b697c8924febotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slash-pointless-dot.creq0000666454262600001440000000022113042511306030016 0ustar pysdk-ciamazon00000000000000GET /foo date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key-case.authz0000666454262600001440000000026113042511306031710 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=be7148d34ebccdc6423b19085378aa0bee970bdc61d144bd1a8c48c33079ab09botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-empty-query-key.creq0000666454262600001440000000022513042511306030621 0ustar pysdk-ciamazon00000000000000GET / foo=bar date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-unreserved.sts0000666454262600001440000000021213042511306026143 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request df63ee3247c0356c696a3b21f8d8490b01fa9cd5bc6550ef5ef5f4636b7b8901botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-query.creq0000666454262600001440000000022613042511306027106 0ustar pysdk-ciamazon00000000000000POST / foo=bar date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query.creq0000666454262600001440000000021613042511306026677 0ustar pysdk-ciamazon00000000000000GET / date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-unreserved.req0000666454262600001440000000031713042511306030716 0ustar pysdk-ciamazon00000000000000GET /?-._~0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz=-._~0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slash-dot-slash.authz0000666454262600001440000000026113042511306027315 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b27ccfbfa7df52a200ff74193ca6e32d4b48b8856fab7ebf1c595d0670a7e470botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla.authz0000666454262600001440000000026113042511306025735 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b27ccfbfa7df52a200ff74193ca6e32d4b48b8856fab7ebf1c595d0670a7e470botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-header-value-case.authz0000666454262600001440000000026513042511306027774 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host;zoo, Signature=273313af9d0c265c531e11db70bbd653f3ba074c1009239e8559d3987039cad7botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-header-value-trim.creq0000666454262600001440000000023213042511306027417 0ustar pysdk-ciamazon00000000000000POST / date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com p:phfft date;host;p e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-query-space.authz0000666454262600001440000000026113042511306030377 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b7eb653abe5f846e7eee4d1dba33b15419dc424aaf215d49b1240732b10cc4cabotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-header-key-duplicate.req0000666454262600001440000000015613042511306027734 0ustar pysdk-ciamazon00000000000000POST / http/1.1 DATE:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com ZOO:zoobar zoo:foobar zoo:zoobar botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slashes.authz0000666454262600001440000000026113042511306025751 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b00392262853cfe3201e47ccf945601079e9b8a7f51ee4c3d9ee4f187aa9bf19botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-header-key-duplicate.sts0000666454262600001440000000021213042511306027747 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 3c52f0eaae2b61329c0a332e3fa15842a37bc5812cf4d80eb64784308850e313botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-order-value.sts0000666454262600001440000000021213042511306030775 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 33dffc220e89131f8f6157a35c40903daa658608d9129ff9489e5cf5bbd9b11bbotocore-1.5.7/tests/unit/auth/aws4_testsuite/post-header-key-case.req0000666454262600001440000000011213042511306027073 0ustar pysdk-ciamazon00000000000000POST / http/1.1 DATE:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slash-pointless-dot.sts0000666454262600001440000000021213042511306027675 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 8021a97572ee460f87ca67f4e8c0db763216d84715f5424a843a5312a3321e2dbotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-relative.authz0000666454262600001440000000026113042511306026122 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b27ccfbfa7df52a200ff74193ca6e32d4b48b8856fab7ebf1c595d0670a7e470botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-header-key-duplicate.creq0000666454262600001440000000025513042511306030077 0ustar pysdk-ciamazon00000000000000POST / date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com zoo:foobar,zoobar,zoobar date;host;zoo e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla.creq0000666454262600001440000000021613042511306025534 0ustar pysdk-ciamazon00000000000000GET / date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-query-nonunreserved.creq0000666454262600001440000000032113042511306031775 0ustar pysdk-ciamazon00000000000000POST / %20=%2F%2C%3F%3E%3C%60%22%3B%3A%5C%7C%5D%5B%7B%7D&%40%23%24%25%5E= date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slashes.req0000666454262600001440000000011713042511306025405 0ustar pysdk-ciamazon00000000000000GET //foo// http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-header-value-case.sts0000666454262600001440000000021213042511306027442 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 3aae6d8274b8c03e2cc96fc7d6bda4b9bd7a0a184309344470b2c96953e124aabotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-relative.creq0000666454262600001440000000021613042511306025721 0ustar pysdk-ciamazon00000000000000GET / date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-utf8.sts0000666454262600001440000000021213042511306024647 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request 47f4456c465167f4db3490a68903fe057412e6e030de38f71d9006467eb4922abotocore-1.5.7/tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded.sreq0000666454262600001440000000052013042511306030506 0ustar pysdk-ciamazon00000000000000POST / http/1.1 Content-Type:application/x-www-form-urlencoded Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=content-type;date;host, Signature=5a15b22cf462f047318703b92e6f4f38884e4a7ab7b1d6426ca46a8bd1c26cbc foo=barbotocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla.creq0000666454262600001440000000021713042511306025743 0ustar pysdk-ciamazon00000000000000POST / date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query.req0000666454262600001440000000011113042511306026526 0ustar pysdk-ciamazon00000000000000GET / http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-query-nonunreserved.sts0000666454262600001440000000021213042511306031653 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request eb3f16b23b20c91e1b5d6f3cd1c1f8c32a6ddcae6024e44bcfa980fbf8561f6cbotocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla.sreq0000666454262600001440000000041413042511306025762 0ustar pysdk-ciamazon00000000000000POST / http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=22902d79e148b64e7571c3565769328423fe276eae4b26f83afceda9e767f726 botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-empty-query-value.authz0000666454262600001440000000026113042511306031554 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b6e3b79003ce0743a491606ba1035a804593b0efb1e20a11cba83f8c25a57a92botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-utf8.authz0000666454262600001440000000026113042511306025175 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=57b1eb3df3b16a8479c0097b66c0b261cfd65b829419a3f2c3d05319722490b8botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-ut8-query.sts0000666454262600001440000000021213042511306027270 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 20110909T233600Z 20110909/us-east-1/host/aws4_request de5065ff39c131e6c2e2bd19cd9345a794bf3b561eab20b8d97b2093fc2a979ebotocore-1.5.7/tests/unit/auth/aws4_testsuite/post-vanilla-query.req0000666454262600001440000000012213042511306026736 0ustar pysdk-ciamazon00000000000000POST /?foo=bar http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key-case.req0000666454262600001440000000013113042511306031340 0ustar pysdk-ciamazon00000000000000GET /?foo=Zoo&foo=aha http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/post-x-www-form-urlencoded-parameters.sreq0000666454262600001440000000053613042511306032656 0ustar pysdk-ciamazon00000000000000POST / http/1.1 Content-Type:application/x-www-form-urlencoded; charset=utf8 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=content-type;date;host, Signature=b105eb10c6d318d2294de9d49dd8b031b55e3c3fe139f2e637da70511e9e7b71 foo=barbotocore-1.5.7/tests/unit/auth/aws4_testsuite/get-header-value-order.req0000666454262600001440000000013613042511306027417 0ustar pysdk-ciamazon00000000000000POST / http/1.1 DATE:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com p:z p:a p:p p:a botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-space.creq0000666454262600001440000000022713042511306025203 0ustar pysdk-ciamazon00000000000000GET /%2520/foo date:Mon, 09 Sep 2011 23:36:00 GMT host:host.foo.com date;host e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-unreserved.sreq0000666454262600001440000000062113042511306031077 0ustar pysdk-ciamazon00000000000000GET /?-._~0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz=-._~0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=f1498ddb4d6dae767d97c466fb92f1b59a2c71ca29ac954692663f9db03426fb botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-query-order-key.req0000666454262600001440000000012513042511306030432 0ustar pysdk-ciamazon00000000000000GET /?a=foo&b=foo http/1.1 Date:Mon, 09 Sep 2011 23:36:00 GMT Host:host.foo.com botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-slash.authz0000666454262600001440000000026113042511306025421 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=b27ccfbfa7df52a200ff74193ca6e32d4b48b8856fab7ebf1c595d0670a7e470botocore-1.5.7/tests/unit/auth/aws4_testsuite/get-vanilla-empty-query-key.authz0000666454262600001440000000026113042511306031022 0ustar pysdk-ciamazon00000000000000AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20110909/us-east-1/host/aws4_request, SignedHeaders=date;host, Signature=56c054473fd260c13e4e7393eb203662195f5d4a1fada5314b8b52b23f985e9fbotocore-1.5.7/tests/unit/auth/test_sigv4.py0000666454262600001440000001602113042511306022134 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. """Signature Version 4 test suite. AWS provides a test suite for signature version 4: http://docs.aws.amazon.com/general/latest/gr/signature-v4-test-suite.html This module contains logic to run these tests. The test files were placed in ./aws4_testsuite, and we're using nose's test generators to dynamically generate testcases based on these files. """ import os import logging import io import datetime from botocore.compat import six from six import BytesIO from six.moves import BaseHTTPServer import nose.tools as t from nose import with_setup import mock import botocore.auth from botocore.awsrequest import AWSRequest from botocore.credentials import Credentials try: from urllib.parse import urlsplit from urllib.parse import parse_qsl except ImportError: from urlparse import urlsplit from urlparse import parse_qsl CREDENTIAL_SCOPE = "KEYNAME/20110909/us-west-1/s3/aws4_request" SECRET_KEY = "wJalrXUtnFEMI/K7MDENG+bPxRfiCYEXAMPLEKEY" ACCESS_KEY = 'AKIDEXAMPLE' DATE_STRING = 'Mon, 09 Sep 2011 23:36:00 GMT' TESTSUITE_DIR = os.path.join( os.path.dirname(os.path.abspath(__file__)), 'aws4_testsuite') # The following tests are not run. Each test has a comment as # to why the test is being ignored. TESTS_TO_IGNORE = [ # Bad POST syntax, python's HTTP parser chokes on this. 'post-vanilla-query-space', # Bad POST syntax, python's HTTP parser chokes on this. 'post-vanilla-query-nonunreserved', # Multiple query params of the same key not supported by # the SDKs. 'get-vanilla-query-order-key-case', # Multiple query params of the same key not supported by # the SDKs. 'get-vanilla-query-order-value', ] if not six.PY3: TESTS_TO_IGNORE += [ # NO support 'get-header-key-duplicate', 'get-header-value-order', ] log = logging.getLogger(__name__) class RawHTTPRequest(BaseHTTPServer.BaseHTTPRequestHandler): def __init__(self, raw_request): if isinstance(raw_request, six.text_type): raw_request = raw_request.encode('utf-8') self.rfile = BytesIO(raw_request) self.raw_requestline = self.rfile.readline() self.error_code = None self.error_message = None self.parse_request() def send_error(self, code, message): self.error_code = code self.error_message = message def test_generator(): datetime_patcher = mock.patch.object( botocore.auth.datetime, 'datetime', mock.Mock(wraps=datetime.datetime) ) mocked_datetime = datetime_patcher.start() mocked_datetime.utcnow.return_value = datetime.datetime(2011, 9, 9, 23, 36) formatdate_patcher = mock.patch('botocore.auth.formatdate') formatdate = formatdate_patcher.start() # We have to change this because Sep 9, 2011 was actually # a Friday, but the tests have this set to a Monday. formatdate.return_value = 'Mon, 09 Sep 2011 23:36:00 GMT' for test_case in set(os.path.splitext(i)[0] for i in os.listdir(TESTSUITE_DIR)): if test_case in TESTS_TO_IGNORE: log.debug("Skipping test: %s", test_case) continue yield (_test_signature_version_4, test_case) datetime_patcher.stop() formatdate_patcher.stop() def create_request_from_raw_request(raw_request): raw_request = raw_request.replace('http/1.1', 'HTTP/1.1') request = AWSRequest() raw = RawHTTPRequest(raw_request) if raw.error_code is not None: raise Exception(raw.error_message) request.method = raw.command datetime_now = datetime.datetime(2011, 9, 9, 23, 36) request.context['timestamp'] = datetime_now.strftime('%Y%m%dT%H%M%SZ') for key, val in raw.headers.items(): request.headers[key] = val request.data = raw.rfile.read() host = raw.headers.get('host', '') # For whatever reason, the BaseHTTPRequestHandler encodes # the first line of the response as 'iso-8859-1', # so we need decode this into utf-8. if isinstance(raw.path, six.text_type): raw.path = raw.path.encode('iso-8859-1').decode('utf-8') url = 'https://%s%s' % (host, raw.path) if '?' in url: split_url = urlsplit(url) params = dict(parse_qsl(split_url.query)) request.url = split_url.path request.params = params else: request.url = url return request def _test_signature_version_4(test_case): test_case = _SignatureTestCase(test_case) request = create_request_from_raw_request(test_case.raw_request) auth = botocore.auth.SigV4Auth(test_case.credentials, 'host', 'us-east-1') actual_canonical_request = auth.canonical_request(request) assert_equal(actual_canonical_request, test_case.canonical_request, test_case.raw_request, 'canonical_request') actual_string_to_sign = auth.string_to_sign(request, actual_canonical_request) assert_equal(actual_string_to_sign, test_case.string_to_sign, test_case.raw_request, 'string_to_sign') auth.add_auth(request) actual_auth_header = request.headers['Authorization'] assert_equal(actual_auth_header, test_case.authorization_header, test_case.raw_request, 'authheader') def assert_equal(actual, expected, raw_request, part): if actual != expected: message = "The %s did not match" % part message += "\nACTUAL:%r !=\nEXPECT:%r" % (actual, expected) message += '\nThe raw request was:\n%s' % raw_request raise AssertionError(message) class _SignatureTestCase(object): def __init__(self, test_case): p = os.path.join # We're using io.open() because we need to open these files with # a specific encoding, and in 2.x io.open is the best way to do this. self.raw_request = io.open(p(TESTSUITE_DIR, test_case + '.req'), encoding='utf-8').read() self.canonical_request = io.open( p(TESTSUITE_DIR, test_case + '.creq'), encoding='utf-8').read().replace('\r', '') self.string_to_sign = io.open( p(TESTSUITE_DIR, test_case + '.sts'), encoding='utf-8').read().replace('\r', '') self.authorization_header = io.open( p(TESTSUITE_DIR, test_case + '.authz'), encoding='utf-8').read().replace('\r', '') self.signed_request = io.open(p(TESTSUITE_DIR, test_case + '.sreq'), encoding='utf-8').read() self.credentials = Credentials(ACCESS_KEY, SECRET_KEY) botocore-1.5.7/tests/unit/auth/test_signers.py0000666454262600001440000011422013042511306022552 0ustar pysdk-ciamazon00000000000000#!/usr/bin/env # Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest import datetime import time import base64 import json import tempfile import mock import botocore.auth import botocore.credentials from botocore.compat import HTTPHeaders, urlsplit, parse_qs, six from botocore.awsrequest import AWSRequest from botocore.vendored.requests.models import Request class BaseTestWithFixedDate(unittest.TestCase): def setUp(self): self.datetime_patch = mock.patch('botocore.auth.datetime') self.datetime_mock = self.datetime_patch.start() self.fixed_date = datetime.datetime(2014, 3, 10, 17, 2, 55, 0) self.datetime_mock.datetime.utcnow.return_value = self.fixed_date self.datetime_mock.datetime.strptime.return_value = self.fixed_date def tearDown(self): self.datetime_patch.stop() class TestHMACV1(unittest.TestCase): maxDiff = None def setUp(self): access_key = '44CF9590006BF252F707' secret_key = 'OtxrzxIsfpFjA7SwPzILwy8Bw21TLhquhboDYROV' self.credentials = botocore.credentials.Credentials(access_key, secret_key) self.hmacv1 = botocore.auth.HmacV1Auth(self.credentials, None, None) self.date_mock = mock.patch('botocore.auth.formatdate') self.formatdate = self.date_mock.start() self.formatdate.return_value = 'Thu, 17 Nov 2005 18:49:58 GMT' def tearDown(self): self.date_mock.stop() def test_put(self): headers = {'Date': 'Thu, 17 Nov 2005 18:49:58 GMT', 'Content-Md5': 'c8fdb181845a4ca6b8fec737b3581d76', 'Content-Type': 'text/html', 'X-Amz-Meta-Author': 'foo@bar.com', 'X-Amz-Magic': 'abracadabra'} http_headers = HTTPHeaders.from_dict(headers) split = urlsplit('/quotes/nelson') cs = self.hmacv1.canonical_string('PUT', split, http_headers) expected_canonical = ( "PUT\nc8fdb181845a4ca6b8fec737b3581d76\ntext/html\n" "Thu, 17 Nov 2005 18:49:58 GMT\nx-amz-magic:abracadabra\n" "x-amz-meta-author:foo@bar.com\n/quotes/nelson") expected_signature = 'jZNOcbfWmD/A/f3hSvVzXZjM2HU=' self.assertEqual(cs, expected_canonical) sig = self.hmacv1.get_signature('PUT', split, http_headers) self.assertEqual(sig, expected_signature) def test_duplicate_headers(self): pairs = [('Date', 'Thu, 17 Nov 2005 18:49:58 GMT'), ('Content-Md5', 'c8fdb181845a4ca6b8fec737b3581d76'), ('Content-Type', 'text/html'), ('X-Amz-Meta-Author', 'bar@baz.com'), ('X-Amz-Meta-Author', 'foo@bar.com'), ('X-Amz-Magic', 'abracadabra')] http_headers = HTTPHeaders.from_pairs(pairs) split = urlsplit('/quotes/nelson') sig = self.hmacv1.get_signature('PUT', split, http_headers) self.assertEqual(sig, 'kIdMxyiYB+F+83zYGR6sSb3ICcE=') def test_query_string(self): split = urlsplit('/quotes/nelson?uploads') pairs = [('Date', 'Thu, 17 Nov 2005 18:49:58 GMT')] sig = self.hmacv1.get_signature('PUT', split, HTTPHeaders.from_pairs(pairs)) self.assertEqual(sig, 'P7pBz3Z4p3GxysRSJ/gR8nk7D4o=') def test_bucket_operations(self): # Check that the standard operations on buckets that are # specified as query strings end up in the canonical resource. operations = ('acl', 'cors', 'lifecycle', 'policy', 'notification', 'logging', 'tagging', 'requestPayment', 'versioning', 'website') for operation in operations: url = '/quotes?%s' % operation split = urlsplit(url) cr = self.hmacv1.canonical_resource(split) self.assertEqual(cr, '/quotes?%s' % operation) def test_sign_with_token(self): credentials = botocore.credentials.Credentials( access_key='foo', secret_key='bar', token='baz') auth = botocore.auth.HmacV1Auth(credentials) request = AWSRequest() request.headers['Date'] = 'Thu, 17 Nov 2005 18:49:58 GMT' request.headers['Content-Type'] = 'text/html' request.method = 'PUT' request.url = 'https://s3.amazonaws.com/bucket/key' auth.add_auth(request) self.assertIn('Authorization', request.headers) # We're not actually checking the signature here, we're # just making sure the auth header has the right format. self.assertTrue(request.headers['Authorization'].startswith('AWS ')) def test_resign_with_token(self): credentials = botocore.credentials.Credentials( access_key='foo', secret_key='bar', token='baz') auth = botocore.auth.HmacV1Auth(credentials) request = AWSRequest() request.headers['Date'] = 'Thu, 17 Nov 2005 18:49:58 GMT' request.headers['Content-Type'] = 'text/html' request.method = 'PUT' request.url = 'https://s3.amazonaws.com/bucket/key' auth.add_auth(request) original_auth = request.headers['Authorization'] # Resigning the request shouldn't change the authorization # header. We are also ensuring that the date stays the same # because we're mocking out the formatdate() call. There's # another unit test that verifies we use the latest time # when we sign the request. auth.add_auth(request) self.assertEqual(request.headers.get_all('Authorization'), [original_auth]) def test_resign_uses_most_recent_date(self): dates = [ 'Thu, 17 Nov 2005 18:49:58 GMT', 'Thu, 17 Nov 2014 20:00:00 GMT', ] self.formatdate.side_effect = dates request = AWSRequest() request.headers['Content-Type'] = 'text/html' request.method = 'PUT' request.url = 'https://s3.amazonaws.com/bucket/key' self.hmacv1.add_auth(request) original_date = request.headers['Date'] self.hmacv1.add_auth(request) modified_date = request.headers['Date'] # Each time we sign a request, we make another call to formatdate() # so we should have a different date header each time. self.assertEqual(original_date, dates[0]) self.assertEqual(modified_date, dates[1]) class TestSigV2(unittest.TestCase): maxDiff = None def setUp(self): access_key = 'foo' secret_key = 'bar' self.credentials = botocore.credentials.Credentials(access_key, secret_key) self.signer = botocore.auth.SigV2Auth(self.credentials) self.time_patcher = mock.patch.object( botocore.auth.time, 'gmtime', mock.Mock(wraps=time.gmtime) ) mocked_time = self.time_patcher.start() mocked_time.return_value = time.struct_time( [2014, 6, 20, 8, 40, 23, 4, 171, 0]) def tearDown(self): self.time_patcher.stop() def test_put(self): request = mock.Mock() request.url = '/' request.method = 'POST' params = {'Foo': u'\u2713'} result = self.signer.calc_signature(request, params) self.assertEqual( result, ('Foo=%E2%9C%93', u'VCtWuwaOL0yMffAT8W4y0AFW3W4KUykBqah9S40rB+Q=')) def test_fields(self): request = Request() request.url = '/' request.method = 'POST' request.data = {'Foo': u'\u2713'} self.signer.add_auth(request) self.assertEqual(request.data['AWSAccessKeyId'], 'foo') self.assertEqual(request.data['Foo'], u'\u2713') self.assertEqual(request.data['Timestamp'], '2014-06-20T08:40:23Z') self.assertEqual(request.data['Signature'], u'Tiecw+t51tok4dTT8B4bg47zxHEM/KcD55f2/x6K22o=') self.assertEqual(request.data['SignatureMethod'], 'HmacSHA256') self.assertEqual(request.data['SignatureVersion'], '2') def test_resign(self): # Make sure that resigning after e.g. retries works request = Request() request.url = '/' request.method = 'POST' params = { 'Foo': u'\u2713', 'Signature': u'VCtWuwaOL0yMffAT8W4y0AFW3W4KUykBqah9S40rB+Q=' } result = self.signer.calc_signature(request, params) self.assertEqual( result, ('Foo=%E2%9C%93', u'VCtWuwaOL0yMffAT8W4y0AFW3W4KUykBqah9S40rB+Q=')) class TestSigV3(unittest.TestCase): maxDiff = None def setUp(self): self.access_key = 'access_key' self.secret_key = 'secret_key' self.credentials = botocore.credentials.Credentials(self.access_key, self.secret_key) self.auth = botocore.auth.SigV3Auth(self.credentials) self.date_mock = mock.patch('botocore.auth.formatdate') self.formatdate = self.date_mock.start() self.formatdate.return_value = 'Thu, 17 Nov 2005 18:49:58 GMT' def tearDown(self): self.date_mock.stop() def test_signature_with_date_headers(self): request = AWSRequest() request.headers = {'Date': 'Thu, 17 Nov 2005 18:49:58 GMT'} request.url = 'https://route53.amazonaws.com' self.auth.add_auth(request) self.assertEqual( request.headers['X-Amzn-Authorization'], ('AWS3-HTTPS AWSAccessKeyId=access_key,Algorithm=HmacSHA256,' 'Signature=M245fo86nVKI8rLpH4HgWs841sBTUKuwciiTpjMDgPs=')) def test_resign_with_token(self): credentials = botocore.credentials.Credentials( access_key='foo', secret_key='bar', token='baz') auth = botocore.auth.SigV3Auth(credentials) request = AWSRequest() request.headers['Date'] = 'Thu, 17 Nov 2005 18:49:58 GMT' request.method = 'PUT' request.url = 'https://route53.amazonaws.com/' auth.add_auth(request) original_auth = request.headers['X-Amzn-Authorization'] # Resigning the request shouldn't change the authorization # header. auth.add_auth(request) self.assertEqual(request.headers.get_all('X-Amzn-Authorization'), [original_auth]) class TestS3SigV4Auth(BaseTestWithFixedDate): maxDiff = None def setUp(self): super(TestS3SigV4Auth, self).setUp() self.credentials = botocore.credentials.Credentials( access_key='foo', secret_key='bar', token='baz') self.auth = botocore.auth.S3SigV4Auth( self.credentials, 'ec2', 'eu-central-1') self.request = AWSRequest(data=six.BytesIO(b"foo bar baz")) self.request.method = 'PUT' self.request.url = 'https://s3.eu-central-1.amazonaws.com/' self.client_config = mock.Mock() self.s3_config = {} self.client_config.s3 = self.s3_config self.request.context = { 'client_config': self.client_config } def test_resign_with_content_hash(self): self.auth.add_auth(self.request) original_auth = self.request.headers['Authorization'] self.auth.add_auth(self.request) self.assertEqual(self.request.headers.get_all('Authorization'), [original_auth]) def test_signature_is_not_normalized(self): request = AWSRequest() request.url = 'https://s3.amazonaws.com/bucket/foo/./bar/../bar' request.method = 'GET' credentials = botocore.credentials.Credentials('access_key', 'secret_key') auth = botocore.auth.S3SigV4Auth(credentials, 's3', 'us-east-1') auth.add_auth(request) self.assertTrue( request.headers['Authorization'].startswith('AWS4-HMAC-SHA256')) def test_query_string_params_in_urls(self): request = AWSRequest() request.url = ( 'https://s3.amazonaws.com/bucket?' 'marker=%C3%A4%C3%B6%C3%BC-01.txt&prefix' ) request.data = {'Action': 'MyOperation'} request.method = 'GET' # Check that the canonical query string is correct formatting # by ensuring that query string paramters that are added to the # canonical query string are correctly formatted. cqs = self.auth.canonical_query_string(request) self.assertEqual('marker=%C3%A4%C3%B6%C3%BC-01.txt&prefix=', cqs) def _test_blacklist_header(self, header, value): request = AWSRequest() request.url = 'https://s3.amazonaws.com/bucket/foo' request.method = 'PUT' request.headers[header] = value credentials = botocore.credentials.Credentials('access_key', 'secret_key') auth = botocore.auth.S3SigV4Auth(credentials, 's3', 'us-east-1') auth.add_auth(request) self.assertNotIn(header, request.headers['Authorization']) def test_blacklist_expect_headers(self): self._test_blacklist_header('expect', '100-continue') def test_blacklist_trace_id(self): self._test_blacklist_header('x-amzn-trace-id', 'Root=foo;Parent=bar;Sampleid=1') def test_blacklist_headers(self): self._test_blacklist_header('user-agent', 'botocore/1.4.11') def test_context_sets_signing_region(self): original_signing_region = 'eu-central-1' new_signing_region = 'us-west-2' self.auth.add_auth(self.request) auth = self.request.headers['Authorization'] self.assertIn(original_signing_region, auth) self.assertNotIn(new_signing_region, auth) self.request.context = {'signing': {'region': new_signing_region}} self.auth.add_auth(self.request) auth = self.request.headers['Authorization'] self.assertIn(new_signing_region, auth) self.assertNotIn(original_signing_region, auth) def test_uses_sha256_if_config_value_is_true(self): self.client_config.s3['payload_signing_enabled'] = True self.auth.add_auth(self.request) sha_header = self.request.headers['X-Amz-Content-SHA256'] self.assertNotEqual(sha_header, 'UNSIGNED-PAYLOAD') def test_does_not_use_sha256_if_config_value_is_false(self): self.client_config.s3['payload_signing_enabled'] = False self.auth.add_auth(self.request) sha_header = self.request.headers['X-Amz-Content-SHA256'] self.assertEqual(sha_header, 'UNSIGNED-PAYLOAD') def test_uses_sha256_if_md5_unset(self): self.request.context['has_streaming_input'] = True self.auth.add_auth(self.request) sha_header = self.request.headers['X-Amz-Content-SHA256'] self.assertNotEqual(sha_header, 'UNSIGNED-PAYLOAD') def test_uses_sha256_if_not_https(self): self.request.context['has_streaming_input'] = True self.request.headers.add_header('Content-MD5', 'foo') self.request.url = 'http://s3.amazonaws.com/bucket' self.auth.add_auth(self.request) sha_header = self.request.headers['X-Amz-Content-SHA256'] self.assertNotEqual(sha_header, 'UNSIGNED-PAYLOAD') def test_uses_sha256_if_not_streaming_upload(self): self.request.context['has_streaming_input'] = False self.request.headers.add_header('Content-MD5', 'foo') self.request.url = 'http://s3.amazonaws.com/bucket' self.auth.add_auth(self.request) sha_header = self.request.headers['X-Amz-Content-SHA256'] self.assertNotEqual(sha_header, 'UNSIGNED-PAYLOAD') def test_does_not_use_sha256_if_md5_set(self): self.request.context['has_streaming_input'] = True self.request.headers.add_header('Content-MD5', 'foo') self.auth.add_auth(self.request) sha_header = self.request.headers['X-Amz-Content-SHA256'] self.assertEqual(sha_header, 'UNSIGNED-PAYLOAD') class TestSigV4(unittest.TestCase): def setUp(self): self.credentials = botocore.credentials.Credentials( access_key='foo', secret_key='bar') def create_signer(self, service_name='myservice', region='us-west-2'): auth = botocore.auth.SigV4Auth( self.credentials, service_name, region) return auth def test_canonical_query_string(self): request = AWSRequest() request.url = ( 'https://search-testdomain1-j67dwxlet67gf7ghwfmik2c67i.us-west-2.' 'cloudsearch.amazonaws.com/' '2013-01-01/search?format=sdk&pretty=true&' 'q.options=%7B%22defaultOperator%22%3A%20%22and%22%2C%20%22' 'fields%22%3A%5B%22directors%5E10%22%5D%7D&q=George%20Lucas' ) request.method = 'GET' auth = self.create_signer('cloudsearchdomain', 'us-west-2') actual = auth.canonical_query_string(request) # Here 'q' should come before 'q.options'. expected = ("format=sdk&pretty=true&q=George%20Lucas&q.options=%7B%22" "defaultOperator%22%3A%20%22and%22%2C%20%22fields%22%3A%5B" "%22directors%5E10%22%5D%7D") self.assertEqual(actual, expected) def test_thread_safe_timestamp(self): request = AWSRequest() request.url = ( 'https://search-testdomain1-j67dwxlet67gf7ghwfmik2c67i.us-west-2.' 'cloudsearch.amazonaws.com/' '2013-01-01/search?format=sdk&pretty=true&' 'q.options=%7B%22defaultOperator%22%3A%20%22and%22%2C%20%22' 'fields%22%3A%5B%22directors%5E10%22%5D%7D&q=George%20Lucas' ) request.method = 'GET' auth = self.create_signer('cloudsearchdomain', 'us-west-2') with mock.patch.object( botocore.auth.datetime, 'datetime', mock.Mock(wraps=datetime.datetime)) as mock_datetime: original_utcnow = datetime.datetime(2014, 1, 1, 0, 0) mock_datetime.utcnow.return_value = original_utcnow # Go through the add_auth process once. This will attach # a timestamp to the request at the beginning of auth. auth.add_auth(request) self.assertEqual(request.context['timestamp'], '20140101T000000Z') # Ensure the date is in the Authorization header self.assertIn('20140101', request.headers['Authorization']) # Now suppose the utc time becomes the next day all of a sudden mock_datetime.utcnow.return_value = datetime.datetime( 2014, 1, 2, 0, 0) # Smaller methods like the canonical request and string_to_sign # should have the timestamp attached to the request in their # body and not what the time is now mocked as. This is to ensure # there is no mismatching in timestamps when signing. cr = auth.canonical_request(request) self.assertIn('x-amz-date:20140101T000000Z', cr) self.assertNotIn('x-amz-date:20140102T000000Z', cr) sts = auth.string_to_sign(request, cr) self.assertIn('20140101T000000Z', sts) self.assertNotIn('20140102T000000Z', sts) def test_payload_is_binary_file(self): request = AWSRequest() request.data = six.BytesIO(u'\u2713'.encode('utf-8')) auth = self.create_signer() payload = auth.payload(request) self.assertEqual( payload, '1dabba21cdad44541f6b15796f8d22978fc7ea10c46aeceeeeb66c23b3ac7604') def test_payload_is_bytes_type(self): request = AWSRequest() request.data = u'\u2713'.encode('utf-8') auth = self.create_signer() payload = auth.payload(request) self.assertEqual( payload, '1dabba21cdad44541f6b15796f8d22978fc7ea10c46aeceeeeb66c23b3ac7604') class TestSigV4Resign(BaseTestWithFixedDate): maxDiff = None def setUp(self): super(TestSigV4Resign, self).setUp() self.credentials = botocore.credentials.Credentials( access_key='foo', secret_key='bar', token='baz') self.auth = botocore.auth.SigV4Auth(self.credentials, 'ec2', 'us-west-2') self.request = AWSRequest() self.request.method = 'PUT' self.request.url = 'https://ec2.amazonaws.com/' def test_resign_request_with_date(self): self.request.headers['Date'] = 'Thu, 17 Nov 2005 18:49:58 GMT' self.auth.add_auth(self.request) original_auth = self.request.headers['Authorization'] self.auth.add_auth(self.request) self.assertEqual(self.request.headers.get_all('Authorization'), [original_auth]) def test_sigv4_without_date(self): self.auth.add_auth(self.request) original_auth = self.request.headers['Authorization'] self.auth.add_auth(self.request) self.assertEqual(self.request.headers.get_all('Authorization'), [original_auth]) class BasePresignTest(unittest.TestCase): def get_parsed_query_string(self, request): query_string_dict = parse_qs(urlsplit(request.url).query) # Also, parse_qs sets each value in the dict to be a list, but # because we know that we won't have repeated keys, we simplify # the dict and convert it back to a single value. for key in query_string_dict: query_string_dict[key] = query_string_dict[key][0] return query_string_dict class TestS3SigV2Presign(BasePresignTest): def setUp(self): self.access_key = 'access_key' self.secret_key = 'secret_key' self.credentials = botocore.credentials.Credentials(self.access_key, self.secret_key) self.expires = 3000 self.auth = botocore.auth.HmacV1QueryAuth( self.credentials, expires=self.expires) self.current_epoch_time = 1427427247.465591 self.time_patch = mock.patch('time.time') self.time_mock = self.time_patch.start() self.time_mock.return_value = self.current_epoch_time self.request = AWSRequest() self.bucket = 'mybucket' self.key = 'myobject' self.path = 'https://s3.amazonaws.com/%s/%s' % ( self.bucket, self.key) self.request.url = self.path self.request.method = 'GET' def tearDown(self): self.time_patch.stop() def test_presign_with_query_string(self): self.request.url = ( u'https://foo-bucket.s3.amazonaws.com/image.jpg' u'?response-content-disposition=' 'attachment%3B%20filename%3D%22download.jpg%22') self.auth.add_auth(self.request) query_string = self.get_parsed_query_string(self.request) # We should have still kept the response-content-disposition # in the query string. self.assertIn('response-content-disposition', query_string) self.assertEqual(query_string['response-content-disposition'], 'attachment; filename="download.jpg"') # But we should have also added the parts from the signer. self.assertEqual(query_string['AWSAccessKeyId'], self.access_key) def test_presign_no_headers(self): self.auth.add_auth(self.request) self.assertTrue(self.request.url.startswith(self.path + '?')) query_string = self.get_parsed_query_string(self.request) self.assertEqual(query_string['AWSAccessKeyId'], self.access_key) self.assertEqual(query_string['Expires'], str(int(self.current_epoch_time) + self.expires)) self.assertEquals(query_string['Signature'], 'ZRSgywstwIruKLTLt/Bcrf9H1K4=') def test_presign_with_x_amz_headers(self): self.request.headers['x-amz-security-token'] = 'foo' self.request.headers['x-amz-acl'] = 'read-only' self.auth.add_auth(self.request) query_string = self.get_parsed_query_string(self.request) self.assertEqual(query_string['x-amz-security-token'], 'foo') self.assertEqual(query_string['x-amz-acl'], 'read-only') self.assertEquals(query_string['Signature'], '5oyMAGiUk1E5Ry2BnFr6cIS3Gus=') def test_presign_with_content_headers(self): self.request.headers['content-type'] = 'txt' self.request.headers['content-md5'] = 'foo' self.auth.add_auth(self.request) query_string = self.get_parsed_query_string(self.request) self.assertEqual(query_string['content-type'], 'txt') self.assertEqual(query_string['content-md5'], 'foo') self.assertEquals(query_string['Signature'], '/YQRFdQGywXP74WrOx2ET/RUqz8=') def test_presign_with_unused_headers(self): self.request.headers['user-agent'] = 'botocore' self.auth.add_auth(self.request) query_string = self.get_parsed_query_string(self.request) self.assertNotIn('user-agent', query_string) self.assertEquals(query_string['Signature'], 'ZRSgywstwIruKLTLt/Bcrf9H1K4=') class TestSigV4Presign(BasePresignTest): maxDiff = None def setUp(self): self.access_key = 'access_key' self.secret_key = 'secret_key' self.credentials = botocore.credentials.Credentials(self.access_key, self.secret_key) self.service_name = 'myservice' self.region_name = 'myregion' self.auth = botocore.auth.SigV4QueryAuth( self.credentials, self.service_name, self.region_name, expires=60) self.datetime_patcher = mock.patch.object( botocore.auth.datetime, 'datetime', mock.Mock(wraps=datetime.datetime) ) mocked_datetime = self.datetime_patcher.start() mocked_datetime.utcnow.return_value = datetime.datetime( 2014, 1, 1, 0, 0) def tearDown(self): self.datetime_patcher.stop() def test_presign_no_params(self): request = AWSRequest() request.method = 'GET' request.url = 'https://ec2.us-east-1.amazonaws.com/' self.auth.add_auth(request) query_string = self.get_parsed_query_string(request) self.assertEqual( query_string, {'X-Amz-Algorithm': 'AWS4-HMAC-SHA256', 'X-Amz-Credential': ('access_key/20140101/myregion/' 'myservice/aws4_request'), 'X-Amz-Date': '20140101T000000Z', 'X-Amz-Expires': '60', 'X-Amz-Signature': ('c70e0bcdb4cd3ee324f71c78195445b878' '8315af0800bbbdbbb6d05a616fb84c'), 'X-Amz-SignedHeaders': 'host'}) def test_operation_params_before_auth_params(self): # The spec is picky about this. request = AWSRequest() request.method = 'GET' request.url = 'https://ec2.us-east-1.amazonaws.com/?Action=MyOperation' self.auth.add_auth(request) # Verify auth params come after the existing params. self.assertIn( '?Action=MyOperation&X-Amz', request.url) def test_operation_params_before_auth_params_in_body(self): request = AWSRequest() request.method = 'GET' request.url = 'https://ec2.us-east-1.amazonaws.com/' request.data = {'Action': 'MyOperation'} self.auth.add_auth(request) # Same situation, the params from request.data come before the auth # params in the query string. self.assertIn( '?Action=MyOperation&X-Amz', request.url) def test_presign_with_spaces_in_param(self): request = AWSRequest() request.method = 'GET' request.url = 'https://ec2.us-east-1.amazonaws.com/' request.data = {'Action': 'MyOperation', 'Description': 'With Spaces'} self.auth.add_auth(request) # Verify we encode spaces as '%20, and we don't use '+'. self.assertIn('Description=With%20Spaces', request.url) def test_presign_with_empty_param_value(self): request = AWSRequest() request.method = 'POST' # actual URL format for creating a multipart upload request.url = 'https://s3.amazonaws.com/mybucket/mykey?uploads' self.auth.add_auth(request) # verify that uploads param is still in URL self.assertIn('uploads', request.url) def test_s3_sigv4_presign(self): auth = botocore.auth.S3SigV4QueryAuth( self.credentials, self.service_name, self.region_name, expires=60) request = AWSRequest() request.method = 'GET' request.url = ( 'https://s3.us-west-2.amazonaws.com/mybucket/keyname/.bar') auth.add_auth(request) query_string = self.get_parsed_query_string(request) # We use a different payload: self.assertEqual(auth.payload(request), 'UNSIGNED-PAYLOAD') # which will result in a different X-Amz-Signature: self.assertEqual( query_string, {'X-Amz-Algorithm': 'AWS4-HMAC-SHA256', 'X-Amz-Credential': ('access_key/20140101/myregion/' 'myservice/aws4_request'), 'X-Amz-Date': '20140101T000000Z', 'X-Amz-Expires': '60', 'X-Amz-Signature': ('ac1b8b9e47e8685c5c963d75e35e8741d55251' 'cd955239cc1efad4dc7201db66'), 'X-Amz-SignedHeaders': 'host'}) def test_presign_with_security_token(self): self.credentials.token = 'security-token' auth = botocore.auth.S3SigV4QueryAuth( self.credentials, self.service_name, self.region_name, expires=60) request = AWSRequest() request.method = 'GET' request.url = 'https://ec2.us-east-1.amazonaws.com/' auth.add_auth(request) query_string = self.get_parsed_query_string(request) self.assertEqual( query_string['X-Amz-Security-Token'], 'security-token') def test_presign_where_body_is_json_bytes(self): request = AWSRequest() request.method = 'GET' request.url = 'https://myservice.us-east-1.amazonaws.com/' request.data = b'{"Param": "value"}' self.auth.add_auth(request) query_string = self.get_parsed_query_string(request) expected_query_string = { 'X-Amz-Algorithm': 'AWS4-HMAC-SHA256', 'X-Amz-Credential': ( 'access_key/20140101/myregion/myservice/aws4_request'), 'X-Amz-Expires': '60', 'X-Amz-Date': '20140101T000000Z', 'X-Amz-Signature': ( '8e1d372d168d532313ce6df8f64a7dc51d' 'e6f312a9cfba6e5b345d8a771e839c'), 'X-Amz-SignedHeaders': 'host', 'Param': 'value' } self.assertEqual(query_string, expected_query_string) def test_presign_where_body_is_json_string(self): request = AWSRequest() request.method = 'GET' request.url = 'https://myservice.us-east-1.amazonaws.com/' request.data = '{"Param": "value"}' self.auth.add_auth(request) query_string = self.get_parsed_query_string(request) expected_query_string = { 'X-Amz-Algorithm': 'AWS4-HMAC-SHA256', 'X-Amz-Credential': ( 'access_key/20140101/myregion/myservice/aws4_request'), 'X-Amz-Expires': '60', 'X-Amz-Date': '20140101T000000Z', 'X-Amz-Signature': ( '8e1d372d168d532313ce6df8f64a7dc51d' 'e6f312a9cfba6e5b345d8a771e839c'), 'X-Amz-SignedHeaders': 'host', 'Param': 'value' } self.assertEqual(query_string, expected_query_string) class BaseS3PresignPostTest(unittest.TestCase): def setUp(self): self.access_key = 'access_key' self.secret_key = 'secret_key' self.credentials = botocore.credentials.Credentials( self.access_key, self.secret_key) self.service_name = 'myservice' self.region_name = 'myregion' self.bucket = 'mybucket' self.key = 'mykey' self.policy = { "expiration": "2007-12-01T12:00:00.000Z", "conditions": [ {"acl": "public-read"}, {"bucket": self.bucket}, ["starts-with", "$key", self.key], ] } self.fields = { 'key': self.key, 'acl': 'public-read', } self.request = AWSRequest() self.request.url = 'https://s3.amazonaws.com/%s' % self.bucket self.request.method = 'POST' self.request.context['s3-presign-post-fields'] = self.fields self.request.context['s3-presign-post-policy'] = self.policy class TestS3SigV2Post(BaseS3PresignPostTest): def setUp(self): super(TestS3SigV2Post, self).setUp() self.auth = botocore.auth.HmacV1PostAuth(self.credentials) self.current_epoch_time = 1427427247.465591 self.time_patch = mock.patch('time.time') self.time_mock = self.time_patch.start() self.time_mock.return_value = self.current_epoch_time def tearDown(self): self.time_patch.stop() def test_presign_post(self): self.auth.add_auth(self.request) result_fields = self.request.context['s3-presign-post-fields'] self.assertEqual( result_fields['AWSAccessKeyId'], self.credentials.access_key) result_policy = json.loads(base64.b64decode( result_fields['policy']).decode('utf-8')) self.assertEqual(result_policy['expiration'], '2007-12-01T12:00:00.000Z') self.assertEqual( result_policy['conditions'], [{"acl": "public-read"}, {"bucket": "mybucket"}, ["starts-with", "$key", "mykey"]]) self.assertIn('signature', result_fields) def test_presign_post_with_security_token(self): self.credentials.token = 'my-token' self.auth = botocore.auth.HmacV1PostAuth(self.credentials) self.auth.add_auth(self.request) result_fields = self.request.context['s3-presign-post-fields'] self.assertEqual(result_fields['x-amz-security-token'], 'my-token') def test_empty_fields_and_policy(self): self.request = AWSRequest() self.request.url = 'https://s3.amazonaws.com/%s' % self.bucket self.request.method = 'POST' self.auth.add_auth(self.request) result_fields = self.request.context['s3-presign-post-fields'] self.assertEqual( result_fields['AWSAccessKeyId'], self.credentials.access_key) result_policy = json.loads(base64.b64decode( result_fields['policy']).decode('utf-8')) self.assertEqual(result_policy['conditions'], []) self.assertIn('signature', result_fields) class TestS3SigV4Post(BaseS3PresignPostTest): def setUp(self): super(TestS3SigV4Post, self).setUp() self.auth = botocore.auth.S3SigV4PostAuth( self.credentials, self.service_name, self.region_name) self.datetime_patcher = mock.patch.object( botocore.auth.datetime, 'datetime', mock.Mock(wraps=datetime.datetime) ) mocked_datetime = self.datetime_patcher.start() mocked_datetime.utcnow.return_value = datetime.datetime( 2014, 1, 1, 0, 0) def tearDown(self): self.datetime_patcher.stop() def test_presign_post(self): self.auth.add_auth(self.request) result_fields = self.request.context['s3-presign-post-fields'] self.assertEqual(result_fields['x-amz-algorithm'], 'AWS4-HMAC-SHA256') self.assertEqual( result_fields['x-amz-credential'], 'access_key/20140101/myregion/myservice/aws4_request') self.assertEqual( result_fields['x-amz-date'], '20140101T000000Z') result_policy = json.loads(base64.b64decode( result_fields['policy']).decode('utf-8')) self.assertEqual(result_policy['expiration'], '2007-12-01T12:00:00.000Z') self.assertEqual( result_policy['conditions'], [{"acl": "public-read"}, {"bucket": "mybucket"}, ["starts-with", "$key", "mykey"], {"x-amz-algorithm": "AWS4-HMAC-SHA256"}, {"x-amz-credential": "access_key/20140101/myregion/myservice/aws4_request"}, {"x-amz-date": "20140101T000000Z"}]) self.assertIn('x-amz-signature', result_fields) def test_presign_post_with_security_token(self): self.credentials.token = 'my-token' self.auth = botocore.auth.S3SigV4PostAuth( self.credentials, self.service_name, self.region_name) self.auth.add_auth(self.request) result_fields = self.request.context['s3-presign-post-fields'] self.assertEqual(result_fields['x-amz-security-token'], 'my-token') def test_empty_fields_and_policy(self): self.request = AWSRequest() self.request.url = 'https://s3.amazonaws.com/%s' % self.bucket self.request.method = 'POST' self.auth.add_auth(self.request) result_fields = self.request.context['s3-presign-post-fields'] self.assertEqual(result_fields['x-amz-algorithm'], 'AWS4-HMAC-SHA256') self.assertEqual( result_fields['x-amz-credential'], 'access_key/20140101/myregion/myservice/aws4_request') self.assertEqual( result_fields['x-amz-date'], '20140101T000000Z') result_policy = json.loads(base64.b64decode( result_fields['policy']).decode('utf-8')) self.assertEqual( result_policy['conditions'], [{"x-amz-algorithm": "AWS4-HMAC-SHA256"}, {"x-amz-credential": "access_key/20140101/myregion/myservice/aws4_request"}, {"x-amz-date": "20140101T000000Z"}]) self.assertIn('x-amz-signature', result_fields) botocore-1.5.7/tests/unit/auth/__init__.py0000666454262600001440000000116213042511306021600 0ustar pysdk-ciamazon00000000000000# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. botocore-1.5.7/tests/unit/put_object_data0000666454262600001440000000003413042511306021575 0ustar pysdk-ciamazon00000000000000This is a test of PutObject.botocore-1.5.7/tests/unit/response_parsing/0000777454262600001440000000000013042511310022102 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/0000777454262600001440000000000013042511307022710 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/0000777454262600001440000000000013042511310024723 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-modify-snapshot-attribute.json0000666454262600001440000000014013042511306033412 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-change-message-visibility-batch.xml0000666454262600001440000000115413042511306034372 0ustar pysdk-ciamazon00000000000000 change_visibility_msg_2 change_visibility_msg_3 ca9668f7-ab1b-4f7a-8859-f15747ab17a7 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-customer-gateways.xml0000666454262600001440000000075713042511306033373 0ustar pysdk-ciamazon00000000000000 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE cgw-b4dc3961 available ipsec.1 12.1.2.3 65534 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-instances.xml0000666454262600001440000001436513042511306031677 0ustar pysdk-ciamazon00000000000000 d15d204f-fc31-4600-85d3-5c86e5483b92 r-9b4f3ca8 123456789012 sg-4e970e7e notebook i-fde9cece ami-30fe7300 80 stopped User initiated (2013-03-01 17:24:16 GMT) aws 0 m1.small 2012-10-16T20:00:13.000Z us-west-2a default aki-98e26fa8 disabled sg-4e970e7e notebook Client.UserInitiatedShutdown Client.UserInitiatedShutdown: User initiated shutdown x86_64 ebs /dev/sda1 /dev/sda1 vol-bc71579a attached 2012-10-16T20:00:21.000Z true paravirtual notebook xen false r-6670ce54 123456789012 sg-72334242 quicklaunch-1 i-78f1b94a ami-c4d643f4 16 running ip-10-253-17-74.us-west-2.compute.internal ec2-54-245-16-142.us-west-2.compute.amazonaws.com aws 0 m1.medium 2013-03-12T01:55:59.000Z us-west-2b default windows disabled 10.253.17.74 54.245.16.142 sg-72334242 quicklaunch-1 x86_64 ebs /dev/sda1 /dev/sda1 vol-a8d2e991 attached 2013-03-09T16:44:07.000Z true hvm aOJaC1362847444140 xen false botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-assign-private-ip-addresses.json0000666454262600001440000000011413042511306033603 0ustar pysdk-ciamazon00000000000000{"ResponseMetadata": {"RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-spot-datafeed-subscription.json0000666454262600001440000000041213042511306034772 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" }, "SpotDatafeedSubscription": { "OwnerId": "111122223333", "Prefix": "spotdata_", "Bucket": "myawsbucket", "State": "Active" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-create-topic.json0000666454262600001440000000023713042511306031005 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "a8dec8b3-33a4-11df-8963-01868b7c937a" }, "TopicArn": "arn:aws:sns:us-east-1:123456789012:My-Topic" }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-reserved-instances-listing.json0000666454262600001440000000614113042511306035010 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "a42481af-335a-4e9e-b291-bd18dexample" }, "ReservedInstancesListings": [ { "ReservedInstancesId": "f127bd27-a218-43a4-926d-870e8example", "Status": "active", "Tags": [], "PriceSchedules": [ { "Active": true, "Term": 11, "CurrencyCode": "USD", "Price": 2.5 }, { "Active": false, "Term": 10, "CurrencyCode": "USD", "Price": 2.5 }, { "Active": false, "Term": 9, "CurrencyCode": "USD", "Price": 2.5 }, { "Active": false, "Term": 8, "CurrencyCode": "USD", "Price": 2.0 }, { "Active": false, "Term": 7, "CurrencyCode": "USD", "Price": 2.0 }, { "Active": false, "Term": 6, "CurrencyCode": "USD", "Price": 2.0 }, { "Active": false, "Term": 5, "CurrencyCode": "USD", "Price": 1.5 }, { "Active": false, "Term": 4, "CurrencyCode": "USD", "Price": 1.5 }, { "Active": false, "Term": 3, "CurrencyCode": "USD", "Price": 0.7 }, { "Active": false, "Term": 2, "CurrencyCode": "USD", "Price": 0.7 }, { "Active": false, "Term": 1, "CurrencyCode": "USD", "Price": 0.1 } ], "CreateDate": "2012-07-17T17:11:09.449Z", "ClientToken": "myIdempToken1", "ReservedInstancesListingId": "5ec28771-05ff-4b9b-aa31-9e57dexample", "UpdateDate": "2012-07-17T17:11:09.468Z", "InstanceCounts": [ { "State": "Available", "InstanceCount": 1 }, { "State": "Sold", "InstanceCount": 0 }, { "State": "Cancelled", "InstanceCount": 0 }, { "State": "Pending", "InstanceCount": 0 } ], "StatusMessage": "ACTIVE" } ] }botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudwatch-list-metrics.xml0000666454262600001440000005421713042511306032235 0ustar pysdk-ciamazon00000000000000 VolumeId vol-267b761f VolumeIdleTime AWS/EBS VolumeId vol-04c7c53d VolumeReadBytes AWS/EBS InstanceId i-d63c6ce4 DiskReadBytes AWS/EC2 QueueName foobar NumberOfEmptyReceives AWS/SQS InstanceId i-78f1b94a NetworkOut AWS/EC2 QueueName foobar ApproximateNumberOfMessagesNotVisible AWS/SQS VolumeId vol-04c7c53d VolumeTotalReadTime AWS/EBS VolumeId vol-203b3919 VolumeWriteOps AWS/EBS VolumeId vol-267b761f VolumeWriteOps AWS/EBS VolumeId vol-a8d2e991 VolumeWriteBytes AWS/EBS InstanceId i-70d08042 StatusCheckFailed_Instance AWS/EC2 QueueName foobar ApproximateNumberOfMessagesDelayed AWS/SQS VolumeId vol-04c7c53d VolumeReadOps AWS/EBS InstanceId i-d63c6ce4 CPUUtilization AWS/EC2 VolumeId vol-267b761f VolumeTotalWriteTime AWS/EBS VolumeId vol-a8d2e991 VolumeWriteOps AWS/EBS InstanceId i-78f1b94a CPUUtilization AWS/EC2 VolumeId vol-267b761f VolumeQueueLength AWS/EBS InstanceId i-20277712 DiskWriteBytes AWS/EC2 VolumeId vol-267b761f VolumeTotalReadTime AWS/EBS VolumeId vol-04c7c53d VolumeWriteOps AWS/EBS InstanceId i-70d08042 CPUUtilization AWS/EC2 InstanceId i-20277712 StatusCheckFailed_Instance AWS/EC2 InstanceId i-20277712 CPUUtilization AWS/EC2 InstanceId i-20277712 DiskReadBytes AWS/EC2 VolumeId vol-04c7c53d VolumeIdleTime AWS/EBS VolumeId vol-203b3919 VolumeQueueLength AWS/EBS InstanceId i-d63c6ce4 DiskReadOps AWS/EC2 VolumeId vol-a8d2e991 VolumeIdleTime AWS/EBS VolumeId vol-267b761f VolumeWriteBytes AWS/EBS QueueName foobar ApproximateNumberOfMessagesVisible AWS/SQS InstanceId i-70d08042 DiskReadBytes AWS/EC2 InstanceId i-78f1b94a StatusCheckFailed_Instance AWS/EC2 VolumeId vol-267b761f VolumeReadOps AWS/EBS InstanceId i-78f1b94a DiskReadOps AWS/EC2 VolumeId vol-a8d2e991 VolumeTotalWriteTime AWS/EBS InstanceId i-d63c6ce4 StatusCheckFailed_System AWS/EC2 InstanceId i-70d08042 NetworkOut AWS/EC2 InstanceId i-d63c6ce4 StatusCheckFailed AWS/EC2 VolumeId vol-a8d2e991 VolumeReadOps AWS/EBS VolumeId vol-203b3919 VolumeTotalWriteTime AWS/EBS VolumeId vol-203b3919 VolumeReadBytes AWS/EBS InstanceId i-d63c6ce4 DiskWriteOps AWS/EC2 InstanceId i-78f1b94a DiskWriteOps AWS/EC2 VolumeId vol-a8d2e991 VolumeQueueLength AWS/EBS VolumeId vol-203b3919 VolumeIdleTime AWS/EBS InstanceId i-78f1b94a StatusCheckFailed AWS/EC2 InstanceId i-70d08042 StatusCheckFailed AWS/EC2 QueueName foobar NumberOfMessagesSent AWS/SQS VolumeId vol-04c7c53d VolumeQueueLength AWS/EBS VolumeId vol-267b761f VolumeReadBytes AWS/EBS TableName fromcli ProvisionedReadCapacityUnits AWS/DynamoDB InstanceId i-70d08042 StatusCheckFailed_System AWS/EC2 QueueName foobar NumberOfMessagesDeleted AWS/SQS VolumeId vol-a8d2e991 VolumeReadBytes AWS/EBS InstanceId i-20277712 DiskWriteOps AWS/EC2 InstanceId i-20277712 NetworkOut AWS/EC2 InstanceId i-20277712 DiskReadOps AWS/EC2 InstanceId i-20277712 StatusCheckFailed_System AWS/EC2 InstanceId i-d63c6ce4 NetworkOut AWS/EC2 InstanceId i-20277712 NetworkIn AWS/EC2 VolumeId vol-203b3919 VolumeWriteBytes AWS/EBS InstanceId i-70d08042 DiskWriteBytes AWS/EC2 QueueName foobar NumberOfMessagesReceived AWS/SQS VolumeId vol-203b3919 VolumeReadOps AWS/EBS VolumeId vol-203b3919 VolumeTotalReadTime AWS/EBS InstanceId i-70d08042 DiskWriteOps AWS/EC2 TableName fromcli ProvisionedWriteCapacityUnits AWS/DynamoDB VolumeId vol-04c7c53d VolumeTotalWriteTime AWS/EBS VolumeId vol-a8d2e991 VolumeTotalReadTime AWS/EBS VolumeId vol-04c7c53d VolumeWriteBytes AWS/EBS InstanceId i-78f1b94a DiskReadBytes AWS/EC2 InstanceId i-d63c6ce4 DiskWriteBytes AWS/EC2 InstanceId i-20277712 StatusCheckFailed AWS/EC2 InstanceId i-d63c6ce4 StatusCheckFailed_Instance AWS/EC2 InstanceId i-70d08042 NetworkIn AWS/EC2 InstanceId i-78f1b94a NetworkIn AWS/EC2 InstanceId i-70d08042 DiskReadOps AWS/EC2 InstanceId i-d63c6ce4 NetworkIn AWS/EC2 InstanceId i-78f1b94a StatusCheckFailed_System AWS/EC2 InstanceId i-78f1b94a DiskWriteBytes AWS/EC2 abea8add-9167-11e2-91d1-9b4c7751b290 botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-list-buckets.json0000666454262600001440000001172513042511306030565 0ustar pysdk-ciamazon00000000000000{ "Owner": { "DisplayName": "mitchaws", "ID": "1936a5d8a2b189cda450d1d1d514f3861b3adc2df5152d2a294487b9445d1e7f" }, "Buckets": [ { "CreationDate": "2012-02-20T17:45:32.000Z", "Name": "botostats" }, { "CreationDate": "2012-12-18T20:38:12.000Z", "Name": "bucket-1355863083" }, { "CreationDate": "2013-01-31T22:24:01.000Z", "Name": "elasticbeanstalk-us-east-1-419278470775" }, { "CreationDate": "2013-03-20T13:29:16.000Z", "Name": "elasticbeanstalk-us-west-2-419278470775" }, { "CreationDate": "2012-03-26T19:02:12.000Z", "Name": "encryption-1332788550" }, { "CreationDate": "2012-09-04T17:27:28.000Z", "Name": "encryption-1346779637" }, { "CreationDate": "2012-01-09T05:53:44.000Z", "Name": "garnaat-amazon" }, { "CreationDate": "2012-01-23T02:54:39.000Z", "Name": "garnaat_test_lifecycle" }, { "CreationDate": "2012-12-18T20:30:10.000Z", "Name": "keytest-1355862601" }, { "CreationDate": "2012-12-19T01:28:24.000Z", "Name": "keytest-1355863376" }, { "CreationDate": "2012-05-14T20:17:26.000Z", "Name": "mgtest2cloudformation" }, { "CreationDate": "2012-05-14T14:36:38.000Z", "Name": "mgtestcloudformation" }, { "CreationDate": "2012-05-14T14:34:13.000Z", "Name": "mitchtestcloudformation" }, { "CreationDate": "2012-12-18T20:31:31.000Z", "Name": "multidelete-1355862684" }, { "CreationDate": "2012-12-19T01:28:25.000Z", "Name": "multidelete-1355862730" }, { "CreationDate": "2012-12-19T01:28:25.000Z", "Name": "multidelete-1355863407" }, { "CreationDate": "2012-12-19T01:28:25.000Z", "Name": "multidelete-1355863439" }, { "CreationDate": "2012-12-19T01:28:25.000Z", "Name": "multidelete-1355863446" }, { "CreationDate": "2012-12-19T01:28:25.000Z", "Name": "multidelete-1355863455" }, { "CreationDate": "2012-12-19T01:28:25.000Z", "Name": "multidelete-1355863464" }, { "CreationDate": "2012-12-18T20:44:38.000Z", "Name": "multidelete-1355863470" }, { "CreationDate": "2012-12-19T01:28:25.000Z", "Name": "multipart-1355862845" }, { "CreationDate": "2012-12-18T20:35:08.000Z", "Name": "multipart-1355862901" }, { "CreationDate": "2012-12-19T01:28:25.000Z", "Name": "multipart-1355863550" }, { "CreationDate": "2012-12-19T01:28:25.000Z", "Name": "multipart-1355863593" }, { "CreationDate": "2013-03-13T05:42:01.000Z", "Name": "pyconprod" }, { "CreationDate": "2012-03-18T19:28:26.000Z", "Name": "src-bucket-1332098908" }, { "CreationDate": "2012-03-26T19:01:49.000Z", "Name": "src-bucket-1332788526" }, { "CreationDate": "2012-03-26T19:10:02.000Z", "Name": "src-bucket-1332789019" }, { "CreationDate": "2012-03-27T17:08:36.000Z", "Name": "src-bucket-1332868116" }, { "CreationDate": "2012-06-13T17:36:12.000Z", "Name": "src-bucket-1339608971" }, { "CreationDate": "2013-01-09T02:50:52.000Z", "Name": "src-bucket-1357699848" }, { "CreationDate": "2012-04-28T20:42:19.000Z", "Name": "stats.pythonboto.org" }, { "CreationDate": "2013-01-10T21:44:06.000Z", "Name": "test-1357854245" }, { "CreationDate": "2013-01-10T21:44:07.000Z", "Name": "test-1357854246" }, { "CreationDate": "2012-09-01T10:25:07.000Z", "Name": "version-1328224364" } ], "ResponseMetadata": {} } botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-get-topic-attributes.xml0000666454262600001440000000215213042511306032332 0ustar pysdk-ciamazon00000000000000 Owner 123456789012 Policy { "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:*"}}}]} TopicArn arn:aws:sns:us-east-1:123456789012:My-Topic 057f074c-33a7-11df-9540-99d0768312d3 botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-list-multipart-uploads#2.json0000666454262600001440000000401113042511306032726 0ustar pysdk-ciamazon00000000000000{ "UploadIdMarker": "", "ResponseMetadata": {}, "NextKeyMarker": "my-movie.m2ts", "Bucket": "bucket", "NextUploadIdMarker": "YW55IGlkZWEgd2h5IGVsdmluZydzIHVwbG9hZCBmYWlsZWQ", "Uploads": [ { "Initiator": { "DisplayName": "user1-11111a31-17b5-4fb7-9df5-b111111f13de", "ID": "arn:aws:iam::111122223333:user/user1-11111a31-17b5-4fb7-9df5-b111111f13de" }, "Initiated": "2010-11-10T20:48:33.000Z", "UploadId": "XMgbGlrZSBlbHZpbmcncyBub3QgaGF2aW5nIG11Y2ggbHVjaw", "StorageClass": "STANDARD", "Key": "my-divisor", "Owner": { "DisplayName": "OwnerDisplayName", "ID": "75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a" } }, { "Initiator": { "DisplayName": "InitiatorDisplayName", "ID": "b1d16700c70b0b05597d7acd6a3f92be" }, "Initiated": "2010-11-10T20:48:33.000Z", "UploadId": "VXBsb2FkIElEIGZvciBlbHZpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZA", "StorageClass": "STANDARD", "Key": "my-movie.m2ts", "Owner": { "DisplayName": "OwnerDisplayName", "ID": "b1d16700c70b0b05597d7acd6a3f92be" } }, { "Initiator": { "DisplayName": "user1-22222a31-17b5-4fb7-9df5-b222222f13de", "ID": "arn:aws:iam::444455556666:user/user1-22222a31-17b5-4fb7-9df5-b222222f13de" }, "Initiated": "2010-11-10T20:49:33.000Z", "UploadId": "YW55IGlkZWEgd2h5IGVsdmluZydzIHVwbG9hZCBmYWlsZWQ", "StorageClass": "STANDARD", "Key": "my-movie.m2ts", "Owner": { "DisplayName": "OwnerDisplayName", "ID": "b1d16700c70b0b05597d7acd6a3f92be" } } ], "KeyMarker": "", "MaxUploads": 3, "IsTruncated": true } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-spot-price-history.json0000666454262600001440000074617413042511306033657 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "a71a795c-276d-4c9b-8212-b9302ccce158" }, "NextToken": "Qj9iZzP9N1Vh5jjNyad6X73sizWaPtVQ6328oKe9/GbmNSbOFX1TIhQaz5vok0nu", "SpotPriceHistory": [ { "Timestamp": "2013-03-20T13:35:55.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T13:31:56.000Z", "ProductDescription": "Windows", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T13:30:15.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T13:24:28.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T13:15:08.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T13:09:34.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T13:04:02.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T12:51:01.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T12:43:25.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T12:35:46.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T12:34:01.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T12:30:33.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T12:28:20.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T12:24:30.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T12:19:08.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T12:11:33.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T12:02:13.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T11:56:27.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T11:50:52.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T11:47:00.000Z", "ProductDescription": "Windows", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T11:43:28.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T11:22:57.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T11:04:09.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T10:58:24.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T10:50:44.000Z", "ProductDescription": "Windows", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T10:41:38.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T10:36:05.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T10:15:32.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T10:11:47.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T10:02:26.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T10:00:46.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T09:56:51.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T09:39:59.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.025000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T09:09:46.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T09:05:57.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T09:00:34.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T09:00:26.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T08:38:19.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T07:51:46.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T07:47:44.000Z", "ProductDescription": "Windows", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T07:38:53.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T07:33:17.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.017000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T07:18:13.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T07:16:43.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T06:42:47.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T06:42:47.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T06:42:47.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T06:42:44.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T06:33:48.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.025000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T06:30:00.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T06:24:45.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T06:24:45.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T06:24:45.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T06:24:32.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T06:23:00.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T06:23:00.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T06:23:00.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T06:22:56.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T06:22:56.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T06:22:56.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T06:20:34.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T06:20:34.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T06:20:34.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T06:18:59.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T06:18:54.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T06:18:54.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T06:18:54.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T06:18:45.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T06:18:45.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T06:18:45.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T06:15:26.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T06:14:57.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T06:11:32.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T06:07:35.000Z", "ProductDescription": "Windows", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T06:07:35.000Z", "ProductDescription": "Windows", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T06:07:35.000Z", "ProductDescription": "Windows", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T06:06:16.000Z", "ProductDescription": "Windows", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T06:06:16.000Z", "ProductDescription": "Windows", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T06:06:16.000Z", "ProductDescription": "Windows", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T06:04:05.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T05:58:27.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T05:58:11.000Z", "ProductDescription": "Windows", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T05:56:57.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T05:56:57.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T05:56:57.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T05:56:56.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T05:56:56.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T05:56:56.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T05:51:10.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T05:51:10.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T05:51:10.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T05:51:08.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T05:51:08.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T05:51:08.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T05:36:11.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T05:36:11.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T05:34:26.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T05:34:15.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T05:32:22.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T05:32:22.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T05:32:22.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T05:28:52.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.013000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T05:14:00.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T04:51:53.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T04:42:30.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T04:38:27.000Z", "ProductDescription": "Windows", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T04:35:00.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T04:27:25.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T04:12:49.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "1.122000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T04:10:52.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.019000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T04:07:17.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T04:03:25.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.016000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T04:01:37.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "1.122000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T03:56:00.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T03:50:28.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T03:50:28.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T03:50:28.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "1.122000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T03:44:54.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T03:40:54.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T03:40:53.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T03:40:53.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T03:37:27.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T03:33:53.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T03:31:57.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T03:30:01.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:49:25.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:47:35.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:47:35.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:44:13.000Z", "ProductDescription": "Windows", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:44:13.000Z", "ProductDescription": "Windows", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:44:13.000Z", "ProductDescription": "Windows", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:42:15.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:42:15.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:42:05.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.025000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:40:08.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:39:59.000Z", "ProductDescription": "Windows", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:39:59.000Z", "ProductDescription": "Windows", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:39:59.000Z", "ProductDescription": "Windows", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:36:24.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.016000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:32:45.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:31:12.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:30:45.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:30:41.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:30:41.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:30:41.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:29:14.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:29:14.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:29:14.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:29:11.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:29:11.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:29:11.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:29:08.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:29:08.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:29:04.000Z", "ProductDescription": "Windows", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:29:04.000Z", "ProductDescription": "Windows", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:29:04.000Z", "ProductDescription": "Windows", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:29:01.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:29:01.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:29:01.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:28:55.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:28:55.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:28:55.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:28:42.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:28:42.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:28:42.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:27:31.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:27:31.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:27:31.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:27:26.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:27:26.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:27:26.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:26:51.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:26:51.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:26:51.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:25:25.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:25:25.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:25:25.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:25:21.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:25:21.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:25:21.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:23:25.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:23:25.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:23:25.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:23:21.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:23:21.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:23:21.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:21:55.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:21:55.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:21:55.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:21:53.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:21:53.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:21:50.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:21:50.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:21:50.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:21:46.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:21:46.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:21:46.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:21:42.000Z", "ProductDescription": "Windows", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:21:39.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:21:39.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:21:39.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:21:38.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:21:38.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:21:38.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:21:34.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:21:34.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:21:34.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:21:22.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:21:22.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:21:22.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:21:20.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:21:20.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:21:19.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:21:19.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:21:19.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:21:18.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:21:18.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:21:18.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:21:18.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:21:18.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:21:18.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:20:03.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:20:03.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:20:03.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:20:01.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:19:59.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:19:59.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:19:58.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:19:58.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:19:58.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:19:56.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:19:56.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:19:56.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:19:47.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T02:19:47.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T02:19:47.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T02:16:06.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.025000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T01:53:55.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T01:44:42.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T01:39:07.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T01:35:40.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T01:35:30.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T01:35:18.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T01:33:30.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T01:18:37.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T01:12:59.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T00:43:22.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T00:41:11.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T00:34:11.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.014000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-20T00:27:06.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T00:24:56.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T00:23:19.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-20T00:17:37.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T00:12:04.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T00:06:26.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-20T00:00:33.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T23:47:57.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T23:46:09.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T23:40:40.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.025000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T23:35:10.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T23:29:36.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.015000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T23:24:22.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T23:20:29.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T23:13:11.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T23:09:50.000Z", "ProductDescription": "Windows", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T23:07:41.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T23:04:17.000Z", "ProductDescription": "Windows", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T23:02:07.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.162000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T23:00:27.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T22:47:19.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T22:45:35.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T22:41:46.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T22:37:57.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T22:32:36.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T22:32:36.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.025000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T22:32:29.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.2xlarge", "SpotPrice": "0.820000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T22:30:49.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T22:27:04.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T22:27:04.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T22:21:36.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T22:14:15.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T22:05:05.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T21:59:30.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T21:57:39.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T21:56:06.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T21:55:57.000Z", "ProductDescription": "Windows", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T21:52:11.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T21:46:36.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T21:39:24.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T21:37:31.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T21:35:48.000Z", "ProductDescription": "Windows", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T21:31:54.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T21:24:35.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T21:24:28.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T21:17:27.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T21:17:27.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T21:17:27.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T21:17:11.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.351000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T21:17:11.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.351000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T21:17:11.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.351000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T21:17:09.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T21:17:09.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T21:17:09.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T21:12:01.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T21:12:01.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T21:11:58.000Z", "ProductDescription": "Windows", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T21:09:58.000Z", "ProductDescription": "Windows", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T21:01:06.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T21:01:06.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.162000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T20:55:41.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T20:50:29.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T20:46:46.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T20:39:22.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T20:35:50.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.240000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T20:28:21.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T20:24:47.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.990000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T20:19:33.000Z", "ProductDescription": "Windows", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T20:19:22.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T20:13:53.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.100000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T20:08:26.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.240000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T19:58:59.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T19:58:57.000Z", "ProductDescription": "Windows", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T19:58:57.000Z", "ProductDescription": "Windows", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T19:41:01.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T19:38:50.000Z", "ProductDescription": "Windows", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T19:35:36.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.240000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T19:35:07.000Z", "ProductDescription": "Windows", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T19:22:39.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T19:20:55.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T19:13:36.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.240000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T19:08:10.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.100000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T19:06:04.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T19:04:42.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T19:04:34.000Z", "ProductDescription": "Windows", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T19:04:17.000Z", "ProductDescription": "Windows", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T19:02:41.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.990000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T19:00:35.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T18:57:11.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.900000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T18:51:41.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T18:44:17.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.900000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T18:38:50.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.240000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T18:33:23.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.900000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T18:27:46.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T18:24:04.000Z", "ProductDescription": "Windows", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T18:20:16.000Z", "ProductDescription": "Windows", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T18:11:12.000Z", "ProductDescription": "Windows", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T17:49:25.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T17:45:35.000Z", "ProductDescription": "Windows", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T17:43:58.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T15:43:52.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T15:38:27.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.018000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T15:33:02.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T15:27:36.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.018000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T15:03:47.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.025000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T13:56:36.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T13:54:47.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T13:49:24.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.015000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T13:42:13.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.025000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T13:31:14.000Z", "ProductDescription": "Windows", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T12:35:09.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T12:30:05.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T12:24:11.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T11:46:06.000Z", "ProductDescription": "Windows", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T11:22:57.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T10:50:06.000Z", "ProductDescription": "Windows", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T10:10:25.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T09:59:48.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T09:16:25.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T09:09:13.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T09:00:12.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T08:54:28.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T08:49:00.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.013000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T08:43:39.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T08:38:16.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.013000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T07:51:13.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T07:47:21.000Z", "ProductDescription": "Windows", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T07:17:03.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T07:15:37.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T06:51:54.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T06:46:31.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T06:42:35.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T06:42:35.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T06:42:35.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T06:42:30.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T06:39:13.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T06:32:01.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T06:23:10.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T06:23:10.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T06:23:10.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T06:21:28.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T06:21:27.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T06:21:27.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T06:21:25.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T06:21:25.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T06:21:25.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T06:19:08.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T06:19:08.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T06:19:08.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T06:17:32.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T06:17:32.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T06:17:32.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T06:17:23.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T06:17:23.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T06:17:23.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T06:14:07.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T06:14:01.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T06:13:41.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T06:06:38.000Z", "ProductDescription": "Windows", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T06:06:38.000Z", "ProductDescription": "Windows", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T06:06:38.000Z", "ProductDescription": "Windows", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T06:05:20.000Z", "ProductDescription": "Windows", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T06:05:20.000Z", "ProductDescription": "Windows", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T06:05:20.000Z", "ProductDescription": "Windows", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T06:03:15.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.025000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T05:57:31.000Z", "ProductDescription": "Windows", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T05:56:18.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T05:56:18.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T05:56:18.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T05:56:17.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T05:56:17.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T05:56:17.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T05:50:38.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T05:50:38.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T05:50:38.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T05:50:37.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T05:50:37.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T05:50:37.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T05:36:09.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T05:36:09.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T05:32:29.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T05:30:38.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T05:30:38.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T05:30:38.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T05:27:17.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T05:21:55.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T05:12:50.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T05:05:42.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T05:05:34.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T05:00:17.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T05:00:08.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.015000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T04:47:29.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T04:38:17.000Z", "ProductDescription": "Windows", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T04:17:07.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T04:00:44.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.025000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T03:49:54.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T03:40:41.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T03:40:40.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T03:40:40.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T03:35:36.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T03:35:36.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T03:33:49.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T03:30:05.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T03:29:54.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T03:14:01.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.031000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T03:05:09.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:59:39.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:52:30.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.500000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:52:12.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.100000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:47:03.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.460000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:47:03.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:47:03.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:43:44.000Z", "ProductDescription": "Windows", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:43:44.000Z", "ProductDescription": "Windows", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:43:44.000Z", "ProductDescription": "Windows", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:41:49.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:41:49.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:41:40.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:41:40.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.700000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:41:40.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.071000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:39:47.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:39:37.000Z", "ProductDescription": "Windows", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:39:37.000Z", "ProductDescription": "Windows", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:39:37.000Z", "ProductDescription": "Windows", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:31:04.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:30:36.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:30:36.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:30:36.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:29:11.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:29:11.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:29:11.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:27:22.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:27:22.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:27:22.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:27:17.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:27:17.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:27:15.000Z", "ProductDescription": "Windows", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:27:15.000Z", "ProductDescription": "Windows", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:27:15.000Z", "ProductDescription": "Windows", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:27:14.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:27:13.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:27:13.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:27:08.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:27:08.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:27:08.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:26:54.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:26:54.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:26:54.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:25:44.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:25:44.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:25:44.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:25:39.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:25:39.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:25:39.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:25:05.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:25:05.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:25:05.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:23:41.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:23:41.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:23:41.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:23:35.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:23:35.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:23:35.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:23:28.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:21:42.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:21:42.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:21:42.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:21:41.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:21:41.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:21:41.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:20:14.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:20:14.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:20:13.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:20:13.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:20:13.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:20:12.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:20:12.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:20:12.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:20:07.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:20:07.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:20:07.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:20:01.000Z", "ProductDescription": "Windows", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:20:00.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:20:00.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:20:00.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:19:58.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:19:58.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:19:58.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:19:55.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:19:55.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:19:55.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:19:45.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:19:45.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:19:45.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:19:42.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:19:42.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:19:42.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:19:42.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:19:42.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:19:40.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:19:40.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:19:40.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:19:39.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:19:39.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:19:39.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:18:27.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:18:27.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:18:27.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:18:26.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:18:24.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:18:24.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:18:22.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:18:22.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:18:22.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:18:19.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:18:19.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:18:19.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:18:13.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:18:13.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T02:18:13.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T02:18:05.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:11:07.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T02:05:49.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T01:35:25.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T01:35:17.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T01:35:03.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T01:26:10.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T01:19:03.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T01:13:42.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T01:08:16.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T00:59:14.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T00:52:06.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T00:50:21.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.013000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T00:46:47.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T00:41:08.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-19T00:25:41.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T00:22:02.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-19T00:16:32.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T00:11:10.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-19T00:00:11.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T23:55:08.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T23:49:46.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T23:46:14.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T23:40:51.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T23:40:51.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T23:35:34.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T23:33:48.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.025000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T23:30:15.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T23:24:54.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T23:23:21.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T23:17:46.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T23:09:11.000Z", "ProductDescription": "Windows", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T23:08:52.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T23:07:03.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T23:03:44.000Z", "ProductDescription": "Windows", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T22:59:58.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T22:58:00.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T22:56:15.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T22:48:55.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T22:45:31.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T22:43:53.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T22:41:54.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T22:36:36.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.025000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T22:33:05.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T22:29:33.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T22:09:56.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T22:04:37.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T21:59:18.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T21:57:30.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T21:56:00.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T21:55:53.000Z", "ProductDescription": "Windows", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T21:53:58.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T21:48:36.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T21:43:18.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T21:41:30.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T21:38:00.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T21:34:27.000Z", "ProductDescription": "Windows", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T21:32:30.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.016000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T21:27:12.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T21:21:50.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.014000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T21:16:32.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T21:16:32.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T21:16:32.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T21:16:23.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T21:16:15.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.351000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T21:16:15.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.351000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T21:16:15.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.351000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T21:16:14.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T21:16:14.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T21:16:14.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T21:11:14.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T21:11:14.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T21:11:13.000Z", "ProductDescription": "Windows", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T21:09:10.000Z", "ProductDescription": "Windows", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T21:07:35.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T21:02:15.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.014000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T20:55:10.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T20:50:08.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T20:18:34.000Z", "ProductDescription": "Windows", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T19:58:37.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T19:58:35.000Z", "ProductDescription": "Windows", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T19:58:35.000Z", "ProductDescription": "Windows", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T19:53:30.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T19:46:32.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.013000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T19:39:31.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T19:37:34.000Z", "ProductDescription": "Windows", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T19:34:15.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.013000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T19:33:55.000Z", "ProductDescription": "Windows", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T19:25:29.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T19:22:08.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T19:20:13.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.013000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T19:06:00.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T19:04:39.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T19:02:47.000Z", "ProductDescription": "Windows", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T19:02:31.000Z", "ProductDescription": "Windows", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T18:58:59.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T18:23:45.000Z", "ProductDescription": "Windows", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T18:20:00.000Z", "ProductDescription": "Windows", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T18:09:23.000Z", "ProductDescription": "Windows", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T17:44:35.000Z", "ProductDescription": "Windows", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T17:42:58.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T16:25:12.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T16:12:55.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T16:07:22.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T16:05:52.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T16:05:51.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T16:00:24.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T16:00:03.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.100000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T15:58:34.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.500000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T15:55:01.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.018000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T15:53:16.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.025000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T15:39:11.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T15:33:54.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.018000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T15:26:47.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T15:21:30.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T15:16:08.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T15:10:54.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T15:05:40.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T15:00:21.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T14:55:03.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T14:36:42.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T14:36:42.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T14:22:59.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.014000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T14:17:44.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T14:12:28.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.014000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T14:07:13.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T14:01:53.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.014000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T13:56:38.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T13:51:24.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T13:46:07.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T13:37:25.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T13:30:11.000Z", "ProductDescription": "Windows", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T12:50:04.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T12:43:06.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T12:36:08.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T12:34:15.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T12:29:21.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T12:27:22.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T12:23:44.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T11:57:38.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T11:48:47.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T11:45:08.000Z", "ProductDescription": "Windows", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T11:40:01.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T11:33:02.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T11:22:31.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T10:49:08.000Z", "ProductDescription": "Windows", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T10:09:02.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T10:03:53.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T09:58:49.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T09:58:37.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T09:15:04.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T09:08:06.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T08:59:25.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T08:22:45.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T08:14:05.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.014000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T08:08:53.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T08:03:39.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.014000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T07:58:22.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T07:53:09.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.016000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T07:49:34.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T07:45:47.000Z", "ProductDescription": "Windows", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T07:40:56.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T07:35:42.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.016000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T07:16:29.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.042000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T07:15:04.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T06:43:35.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T06:41:39.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T06:41:39.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T06:41:39.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T06:41:35.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T06:38:26.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T06:29:38.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T06:21:27.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T06:21:27.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T06:21:27.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T06:21:25.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T06:21:25.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T06:21:25.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T06:21:24.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T06:21:24.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T06:21:24.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T06:17:30.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T06:17:30.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T06:17:30.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T06:15:57.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T06:15:57.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T06:15:57.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T06:15:48.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T06:15:48.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T06:15:48.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T06:12:40.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T06:12:17.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T06:05:30.000Z", "ProductDescription": "Windows", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T06:05:30.000Z", "ProductDescription": "Windows", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T06:05:30.000Z", "ProductDescription": "Windows", "InstanceType": "m3.2xlarge", "SpotPrice": "0.439000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T06:04:13.000Z", "ProductDescription": "Windows", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T06:04:13.000Z", "ProductDescription": "Windows", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T06:04:13.000Z", "ProductDescription": "Windows", "InstanceType": "m3.xlarge", "SpotPrice": "0.220000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T05:56:47.000Z", "ProductDescription": "Windows", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T05:55:33.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T05:55:33.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T05:55:33.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.2xlarge", "SpotPrice": "0.192000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T05:55:33.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T05:55:33.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T05:55:33.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.2xlarge", "SpotPrice": "0.183000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T05:50:08.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T05:50:08.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T05:50:08.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m3.xlarge", "SpotPrice": "0.101000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T05:50:07.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T05:50:07.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T05:50:07.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m3.xlarge", "SpotPrice": "0.092000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T05:34:27.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T05:34:27.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T05:30:54.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T05:29:08.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T05:29:08.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T05:29:08.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T05:20:39.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T05:15:23.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T05:11:46.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T04:57:53.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T04:52:41.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.025000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T04:36:50.000Z", "ProductDescription": "Windows", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T03:48:40.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T03:39:45.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T03:39:45.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T03:29:33.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T03:15:47.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T03:05:25.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T03:00:13.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:43:15.000Z", "ProductDescription": "Windows", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:43:15.000Z", "ProductDescription": "Windows", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:43:15.000Z", "ProductDescription": "Windows", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:41:25.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:41:25.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:39:33.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:39:25.000Z", "ProductDescription": "Windows", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:39:25.000Z", "ProductDescription": "Windows", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:39:25.000Z", "ProductDescription": "Windows", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:37:52.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.025000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:29:26.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:29:02.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:29:02.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:29:02.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:27:39.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:27:39.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:27:39.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:25:51.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:25:51.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:25:51.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:25:47.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:25:47.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:25:44.000Z", "ProductDescription": "Windows", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:25:44.000Z", "ProductDescription": "Windows", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:25:44.000Z", "ProductDescription": "Windows", "InstanceType": "m2.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:25:42.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:25:42.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:25:42.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:25:37.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:25:37.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:25:37.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.050000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:25:25.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:25:25.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:25:25.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:24:15.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:24:15.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:24:15.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:24:11.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:24:11.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:24:11.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:23:39.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:23:39.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:23:39.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.038000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:22:17.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:22:17.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:22:17.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:22:13.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:22:13.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:22:13.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:20:25.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:20:25.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:20:25.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:20:24.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:20:24.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:20:24.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:18:59.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:18:59.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:18:59.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.030000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:18:58.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:18:58.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:18:55.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:18:55.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:18:55.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:18:52.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:18:52.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:18:52.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.234000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:18:48.000Z", "ProductDescription": "Windows", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:18:46.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:18:46.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:18:46.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:18:45.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:18:45.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:18:45.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:18:43.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:18:43.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:18:43.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:18:35.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:18:35.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:18:35.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "c1.xlarge", "SpotPrice": "0.122000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:18:32.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:18:32.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:18:32.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:18:30.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:18:30.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:18:30.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:18:30.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:18:30.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:18:30.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m2.xlarge", "SpotPrice": "0.067000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:18:29.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:18:29.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:18:29.000Z", "ProductDescription": "SUSE Linux (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.090000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:17:17.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:17:17.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:17:17.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:17:16.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:17:13.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:17:13.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:17:13.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:17:13.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:17:13.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:17:11.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:17:11.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:17:11.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T02:17:02.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T02:17:02.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T02:17:02.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "m1.small", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T01:35:22.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T01:35:14.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-18T01:35:01.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T01:28:09.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T00:40:51.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-18T00:23:52.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-18T00:20:23.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T23:59:22.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T23:59:02.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "c1.xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T23:45:21.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T23:23:06.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T23:07:43.000Z", "ProductDescription": "Windows", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T23:05:41.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T23:02:30.000Z", "ProductDescription": "Windows", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T22:58:48.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "m1.xlarge", "SpotPrice": "0.211000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T22:49:51.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T22:48:01.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T22:44:39.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T22:44:37.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T22:43:03.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T22:39:28.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T22:34:17.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T22:32:32.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T22:29:07.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T22:28:58.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T22:27:17.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.013000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T22:23:49.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T22:15:09.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T22:09:55.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.020000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T21:56:05.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.xlarge", "SpotPrice": "0.083000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T21:54:37.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T21:54:29.000Z", "ProductDescription": "Windows", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T21:50:54.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T21:45:44.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T21:37:09.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T21:33:44.000Z", "ProductDescription": "Windows", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T21:33:38.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T21:28:25.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T21:16:27.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T21:16:27.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T21:16:27.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T21:16:18.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T21:16:11.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.351000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T21:16:11.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.351000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T21:16:11.000Z", "ProductDescription": "SUSE Linux", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.351000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T21:16:10.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T21:16:10.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T21:16:10.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "cr1.8xlarge", "SpotPrice": "0.343000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T21:09:40.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T21:09:40.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.253000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T21:09:38.000Z", "ProductDescription": "Windows", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T21:07:41.000Z", "ProductDescription": "Windows", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T21:00:58.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T20:54:10.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T20:54:10.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.medium", "SpotPrice": "0.021000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T20:49:16.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "c1.medium", "SpotPrice": "0.028000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T20:35:15.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T20:28:22.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T20:18:16.000Z", "ProductDescription": "Windows", "InstanceType": "c1.xlarge", "SpotPrice": "0.320000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T20:02:36.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T19:57:27.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T19:57:21.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.2xlarge", "SpotPrice": "0.112000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T19:57:19.000Z", "ProductDescription": "Windows", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T19:57:19.000Z", "ProductDescription": "Windows", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T19:48:52.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T19:43:45.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.013000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T19:36:42.000Z", "ProductDescription": "Windows", "InstanceType": "m1.medium", "SpotPrice": "0.053000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T19:33:09.000Z", "ProductDescription": "Windows", "InstanceType": "c1.medium", "SpotPrice": "0.080000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T19:31:45.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T19:26:35.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T19:21:35.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m2.4xlarge", "SpotPrice": "0.224000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T19:05:52.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "t1.micro", "SpotPrice": "0.004000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T19:04:33.000Z", "ProductDescription": "Windows (Amazon VPC)", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T19:02:39.000Z", "ProductDescription": "Windows", "InstanceType": "cc2.8xlarge", "SpotPrice": "0.456000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T19:02:33.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T19:02:23.000Z", "ProductDescription": "Windows", "InstanceType": "m1.small", "SpotPrice": "0.026000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T18:57:23.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T18:57:18.000Z", "ProductDescription": "Linux/UNIX (Amazon VPC)", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T18:50:37.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T18:43:49.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T18:23:08.000Z", "ProductDescription": "Windows", "InstanceType": "m2.4xlarge", "SpotPrice": "0.448000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T18:19:34.000Z", "ProductDescription": "Windows", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2c" }, { "Timestamp": "2013-03-17T18:18:00.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T18:12:53.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.014000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T18:09:17.000Z", "ProductDescription": "Windows", "InstanceType": "m1.large", "SpotPrice": "0.106000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T17:43:27.000Z", "ProductDescription": "Windows", "InstanceType": "t1.micro", "SpotPrice": "0.009000", "AvailabilityZone": "us-west-2a" }, { "Timestamp": "2013-03-17T16:53:53.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T16:45:25.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T16:40:15.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T16:35:11.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T15:23:38.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T15:18:34.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T15:13:27.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.010000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T15:03:14.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m1.small", "SpotPrice": "0.012000", "AvailabilityZone": "us-west-2b" }, { "Timestamp": "2013-03-17T14:35:51.000Z", "ProductDescription": "Linux/UNIX", "InstanceType": "m2.xlarge", "SpotPrice": "0.056000", "AvailabilityZone": "us-west-2a" } ] } botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-get-user-policy.xml0000666454262600001440000000152213042511306031246 0ustar pysdk-ciamazon00000000000000 test test %7B%0A%20%20%22Statement%22%3A%20%5B%0A%20%20%20%20%7B%0A%20%20%20%20%20%20%22Sid%22%3A%20%22Stmt1331504410389%22%2C%0A%20%20%20%20%20%20%22Action%22%3A%20%5B%0A%20%20%20%20%20%20%20%20%22ec2%3ACreateSnapshot%22%2C%0A%20%20%20%20%20%20%20%20%22ec2%3ADescribeInstances%22%2C%0A%20%20%20%20%20%20%20%20%22ec2%3ADescribeVolumes%22%0A%20%20%20%20%20%20%5D%2C%0A%20%20%20%20%20%20%22Effect%22%3A%20%22Allow%22%2C%0A%20%20%20%20%20%20%22Resource%22%3A%20%22%2A%22%0A%20%20%20%20%7D%0A%20%20%5D%0A%7D 5a2702d5-bcfd-11e2-b2db-2f18d5db5f10 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-instance-export-task.json0000666454262600001440000000117513042511306033622 0ustar pysdk-ciamazon00000000000000{ "ExportTask": { "Description": "Example for docs", "InstanceExportDetails": { "InstanceId": "i-12345678", "TargetEnvironment": "VMWare" }, "ExportTaskId": "export-i-1234wxyz", "State": "active", "StatusMessage": "Running", "ExportToS3Task": { "S3Bucket": "my-bucket-for-exported-vm", "S3Key": "my-exports/ export-i-1234wxyz .ova", "DiskImageFormat": "VMDK", "ContainerFormat": "OVA" } }, "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-parameters.json0000666454262600001440000000455213042511306035037 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "2ba35df4-40d3-11e2-82cf-0b45b05c0221" }, "Parameters": [ { "Description": "Sets the display format for date and time values.", "DataType": "string", "IsModifiable": true, "Source": "engine-default", "ParameterValue": "ISO, MDY", "ParameterName": "datestyle" }, { "Description": "Sets the number of digits displayed for floating-point values", "DataType": "integer", "IsModifiable": true, "AllowedValues": "-15-2", "Source": "engine-default", "ParameterValue": "0", "ParameterName": "extra_float_digits" }, { "Description": "This parameter applies a user-defined label to a group of queries that are run during the same session..", "DataType": "string", "IsModifiable": true, "Source": "engine-default", "ParameterValue": "default", "ParameterName": "query_group" }, { "Description": "require ssl for all databaseconnections", "DataType": "boolean", "IsModifiable": true, "AllowedValues": "true,false", "Source": "engine-default", "ParameterValue": "false", "ParameterName": "require_ssl" }, { "Description": "Sets the schema search order for names that are not schema-qualified.", "DataType": "string", "IsModifiable": true, "Source": "engine-default", "ParameterValue": "$user, public", "ParameterName": "search_path" }, { "Description": "Aborts any statement that takes over the specified number of milliseconds.", "DataType": "integer", "IsModifiable": true, "Source": "engine-default", "ParameterValue": "0", "ParameterName": "statement_timeout" }, { "Description": "wlm json configuration", "DataType": "string", "IsModifiable": true, "Source": "engine-default", "ParameterValue": "[{\"query_concurrency\":5}]", "ParameterName": "wlm_json_configuration" } ] }botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-create-cluster.xml0000666454262600001440000000277113042511306032211 0ustar pysdk-ciamazon00000000000000 **** 1.0 creating 2 1 true false dev sun:10:30-sun:11:00 in-sync default.redshift-1.0 active default dw.hs1.xlarge examplecluster true masteruser e69b1294-64ef-11e2-b07c-f7fbdd006c67 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-volume.xml0000666454262600001440000000061213042511306030670 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE vol-1a2b3c4d 80 us-east-1a creating YYYY-MM-DDTHH:MM:SS.000Z standard botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-application.json0000666454262600001440000000063013042511306034675 0ustar pysdk-ciamazon00000000000000{ "Application": { "ApplicationName": "SampleApp", "Description": "Sample Description", "Versions": [], "DateCreated": "2010-11-16T23:09:20.256Z", "ConfigurationTemplates": [ "Default" ], "DateUpdated": "2010-11-16T23:09:20.256Z" }, "ResponseMetadata": { "RequestId": "8b00e053-f1d6-11df-8a78-9f77047e0d0c" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-option-groups.xml0000666454262600001440000000132613042511306032645 0ustar pysdk-ciamazon00000000000000 true 5.5 default:mysql-5-5 mysql Default option group for mysql 5.5 ab072fb0-9167-11e2-b6fb-e599bc501f26 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-tags.xml0000666454262600001440000000062713042511306030642 0ustar pysdk-ciamazon00000000000000 902d44a6-9456-4df3-9dcf-f2a26b77da7c i-fde9cece instance notebook botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-vpn-gateways.json0000666454262600001440000000064113042511306032476 0ustar pysdk-ciamazon00000000000000{"ResponseMetadata": {"RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE"}, "VpnGateways": [{"AvailabilityZone": "us-east-1a", "State": "available", "Tags": [], "Type": "ipsec.1", "VpcAttachments": [{"State": "attached", "VpcId": "vpc-1a2b3c4d"}], "VpnGatewayId": "vgw-8db04f81"}]} botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-roles.xml0000666454262600001440000000271113042511306030314 0ustar pysdk-ciamazon00000000000000 false /application_abc/component_xyz/ arn:aws:iam::123456789012:role/application_abc/component_xyz/S3Access S3Access %7B%22Version%22%3A%222008-10-17%22%2C%22Statement%22%3A%5B%7B%22Effect%22%3A%22Allow%22%2C%22Principal%22%3A%7B%22Service%22%3A%5B%22ec2.amazonaws.com%22%5D%7D%2C%22Action%22%3A%5B%22sts%3AAssumeRole%22%5D%7D%5D%7D 2012-05-09T15:45:35Z AROACVSVTSZYEXAMPLEYK /application_abc/component_xyz/ arn:aws:iam::123456789012:role/application_abc/component_xyz/SDBAccess SDBAccess %7B%22Version%22%3A%222008-10-17%22%2C%22Statement%22%3A%5B%7B%22Effect%22%3A%22Allow%22%2C%22Principal%22%3A%7B%22Service%22%3A%5B%22ec2.amazonaws.com%22%5D%7D%2C%22Action%22%3A%5B%22sts%3AAssumeRole%22%5D%7D%5D%7D 2012-05-09T15:45:45Z AROAC2ICXG32EXAMPLEWK 20f7279f-99ee-11e1-a4c3-27EXAMPLE804 botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-get-bucket-logging.xml0000666454262600001440000000107013042511306031451 0ustar pysdk-ciamazon00000000000000 mybucketlogs mybucket-access_log-/ user@company.com READ botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-event-subscriptions.json0000666454262600001440000000020213042511306034207 0ustar pysdk-ciamazon00000000000000{ "EventSubscriptionsList": [], "ResponseMetadata": { "RequestId": "a9fd87af-9167-11e2-b691-fdba749921d2" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-events.xml0000666454262600001440000000120213042511306032335 0ustar pysdk-ciamazon00000000000000 Cluster security group securitygroup1 has been updated. Changes need to be applied to all clusters using this cluster security group. cluster-security-group 2012-12-07T23:05:02.660Z securitygroup1 3eeb9efe-40c5-11e2-816a-1bba29fad1f5 botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-list-object-versions.xml0000666454262600001440000000525513042511306032071 0ustar pysdk-ciamazon00000000000000 bucket my 5 false my-image.jpg 3/L4kqtJl40Nr8X8gdRQBpUMLUo true 2009-10-12T17:50:30.000Z "fba9dede5f27731c9771645a39863328" 434234 STANDARD 75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a mtd@amazon.com my-second-image.jpg 03jpff543dhffds434rfdsFDN943fdsFkdmqnh892 true 2009-11-12T17:50:30.000Z 75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a mtd@amazon.com my-second-image.jpg QUpfdndhfd8438MNFDN93jdnJFkdmqnh893 false 2009-10-10T17:50:30.000Z "9b2cf535f27731c974343645a3985328" 166434 STANDARD 75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a mtd@amazon.com my-third-image.jpg 03jpff543dhffds434rfdsFDN943fdsFkdmqnh892 true 2009-10-15T17:50:30.000Z 75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a mtd@amazon.com my-third-image.jpg UIORUnfndfhnw89493jJFJ false 2009-10-11T12:50:30.000Z "772cf535f27731c974343645a3985328" 64 STANDARD 75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a mtd@amazon.com ././@LongLink0000000000000000000000000000015500000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-configuration-template.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-configuration-templ0000666454262600001440000001630213042511306035413 0ustar pysdk-ciamazon00000000000000{ "ApplicationName": "SampleApp", "Description": "ConfigTemplateDescription", "ResponseMetadata": { "RequestId": "846cd905-f1fd-11df-8a78-9f77047e0d0c" }, "TemplateName": "AppTemplate", "DateCreated": "2010-11-17T03:48:19.640Z", "OptionSettings": [ { "Namespace": "aws:autoscaling:launchconfiguration", "OptionName": "ImageId", "Value": "ami-f2f0069b" }, { "Namespace": "aws:elasticbeanstalk:sns:topics", "OptionName": "Notification Endpoint", "Value": "" }, { "Namespace": "aws:elasticbeanstalk:application:environment", "OptionName": "PARAM4", "Value": "" }, { "Namespace": "aws:elasticbeanstalk:application:environment", "OptionName": "JDBC_CONNECTION_STRING", "Value": "" }, { "Namespace": "aws:autoscaling:launchconfiguration", "OptionName": "SecurityGroups", "Value": "elasticbeanstalk-default" }, { "Namespace": "aws:elb:healthcheck", "OptionName": "UnhealthyThreshold", "Value": "5" }, { "Namespace": "aws:autoscaling:launchconfiguration", "OptionName": "InstanceType", "Value": "t1.micro" }, { "Namespace": "aws:autoscaling:trigger", "OptionName": "Statistic", "Value": "Average" }, { "Namespace": "aws:elb:loadbalancer", "OptionName": "LoadBalancerHTTPSPort", "Value": "OFF" }, { "Namespace": "aws:elb:policies", "OptionName": "Stickiness Cookie Expiration", "Value": "0" }, { "Namespace": "aws:elasticbeanstalk:application:environment", "OptionName": "PARAM5", "Value": "" }, { "Namespace": "aws:autoscaling:trigger", "OptionName": "MeasureName", "Value": "NetworkOut" }, { "Namespace": "aws:elb:healthcheck", "OptionName": "Interval", "Value": "30" }, { "Namespace": "aws:elasticbeanstalk:application", "OptionName": "Application Healthcheck URL", "Value": "/" }, { "Namespace": "aws:elasticbeanstalk:sns:topics", "OptionName": "Notification Topic ARN", "Value": "" }, { "Namespace": "aws:autoscaling:trigger", "OptionName": "LowerBreachScaleIncrement", "Value": "-1" }, { "Namespace": "aws:elasticbeanstalk:container:tomcat:jvmoptions", "OptionName": "XX:MaxPermSize", "Value": "64m" }, { "Namespace": "aws:autoscaling:trigger", "OptionName": "UpperBreachScaleIncrement", "Value": "1" }, { "Namespace": "aws:autoscaling:asg", "OptionName": "MinSize", "Value": "1" }, { "Namespace": "aws:autoscaling:asg", "OptionName": "Custom Availability Zones", "Value": "us-east-1a" }, { "Namespace": "aws:autoscaling:asg", "OptionName": "Availability Zones", "Value": "Any 1" }, { "Namespace": "aws:elasticbeanstalk:hostmanager", "OptionName": "LogPublicationControl", "Value": "false" }, { "Namespace": "aws:elasticbeanstalk:container:tomcat:jvmoptions", "OptionName": "JVM Options", "Value": "" }, { "Namespace": "aws:elasticbeanstalk:sns:topics", "OptionName": "Notification Topic Name", "Value": "" }, { "Namespace": "aws:elasticbeanstalk:application:environment", "OptionName": "PARAM2", "Value": "" }, { "Namespace": "aws:elb:loadbalancer", "OptionName": "LoadBalancerHTTPPort", "Value": "80" }, { "Namespace": "aws:elb:healthcheck", "OptionName": "Timeout", "Value": "5" }, { "Namespace": "aws:autoscaling:trigger", "OptionName": "BreachDuration", "Value": "2" }, { "Namespace": "aws:autoscaling:launchconfiguration", "OptionName": "MonitoringInterval", "Value": "5 minute" }, { "Namespace": "aws:elasticbeanstalk:application:environment", "OptionName": "PARAM1", "Value": "" }, { "Namespace": "aws:autoscaling:asg", "OptionName": "MaxSize", "Value": "4" }, { "Namespace": "aws:autoscaling:trigger", "OptionName": "LowerThreshold", "Value": "2000000" }, { "Namespace": "aws:elasticbeanstalk:application:environment", "OptionName": "AWS_SECRET_KEY", "Value": "" }, { "Namespace": "aws:elasticbeanstalk:application:environment", "OptionName": "AWS_ACCESS_KEY_ID", "Value": "" }, { "Namespace": "aws:autoscaling:trigger", "OptionName": "UpperThreshold", "Value": "6000000" }, { "Namespace": "aws:elasticbeanstalk:sns:topics", "OptionName": "Notification Protocol", "Value": "email" }, { "Namespace": "aws:autoscaling:trigger", "OptionName": "Unit", "Value": "Bytes" }, { "Namespace": "aws:elasticbeanstalk:container:tomcat:jvmoptions", "OptionName": "Xmx", "Value": "256m" }, { "Namespace": "aws:autoscaling:asg", "OptionName": "Cooldown", "Value": "360" }, { "Namespace": "aws:autoscaling:trigger", "OptionName": "Period", "Value": "1" }, { "Namespace": "aws:elasticbeanstalk:container:tomcat:jvmoptions", "OptionName": "Xms", "Value": "256m" }, { "Namespace": "aws:autoscaling:launchconfiguration", "OptionName": "EC2KeyName", "Value": "" }, { "Namespace": "aws:elb:policies", "OptionName": "Stickiness Policy", "Value": "false" }, { "Namespace": "aws:elasticbeanstalk:application:environment", "OptionName": "PARAM3", "Value": "" }, { "Namespace": "aws:elb:healthcheck", "OptionName": "HealthyThreshold", "Value": "3" }, { "Namespace": "aws:elb:loadbalancer", "OptionName": "SSLCertificateId", "Value": "" } ], "DateUpdated": "2010-11-17T03:48:19.640Z", "SolutionStackName": "32bit Amazon Linux running Tomcat 7" }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-import-key-pair.json0000666454262600001440000000032413042511306031322 0ustar pysdk-ciamazon00000000000000{ "KeyName": "gsg-keypair", "KeyFingerprint": "00:00:00: 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00", "ResponseMetadata": { "RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-cancel-spot-instance-requests.xml0000666454262600001440000000055013042511306034004 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE sir-1a2b3c4d cancelled botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-groups.xml0000666454262600001440000000226213042511306030510 0ustar pysdk-ciamazon00000000000000 /division_abc/subdivision_xyz/ Admins AGPACKCEVSQ6C2EXAMPLE arn:aws:iam::123456789012:group/Admins /division_abc/subdivision_xyz/product_1234/engineering/ Test AGP2MAB8DPLSRHEXAMPLE arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test /division_abc/subdivision_xyz/product_1234/ Managers AGPIODR4TAW7CSEXAMPLE arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers false 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-clusters.json0000666454262600001440000000213113042511306033050 0ustar pysdk-ciamazon00000000000000{"Clusters": [{"AllowVersionUpgrade": true, "AutomatedSnapshotRetentionPeriod": 1, "AvailabilityZone": "us-east-1a", "ClusterIdentifier": "examplecluster", "ClusterParameterGroups": [{"ParameterApplyStatus": "in-sync", "ParameterGroupName": "default.redshift-1.0"}], "ClusterSecurityGroups": [{"ClusterSecurityGroupName": "default", "Status": "active"}], "ClusterStatus": "creating", "ClusterVersion": "1.0", "DBName": "dev", "Encrypted": false, "MasterUsername": "masteruser", "NodeType": "dw.hs1.xlarge", "NumberOfNodes": 2, "PendingModifiedValues": {"MasterUserPassword": "****"}, "PreferredMaintenanceWindow": "sun:10:30-sun:11:00", "PubliclyAccessible": true, "VpcSecurityGroups": []}], "ResponseMetadata": {"RequestId": "837d45d6-64f0-11e2-b07c-f7fbdd006c67"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-environment.xml0000666454262600001440000000133413042511306034567 0ustar pysdk-ciamazon00000000000000 Version1 Deploying SampleApp Grey e-icsgecu3wf 2010-11-17T03:59:33.520Z 32bit Amazon Linux running Tomcat 7 EnvDescrip SampleApp 2010-11-17T03:59:33.520Z 15db925e-f1ff-11df-8a78-9f77047e0d0c botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-restore-from-cluster-snapshot.xml0000666454262600001440000000274113042511306035224 0ustar pysdk-ciamazon00000000000000 1.0 creating 2 1 true false dev sun:06:30-sun:07:00 in-sync default.redshift-1.0 active default dw.hs1.xlarge examplecluster-restored true adminuser 52a9aee8-6505-11e2-bec0-17624ad140dd botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-send-raw-email.xml0000666454262600001440000000052213042511306031046 0ustar pysdk-ciamazon00000000000000 00000131d51d6b36-1d4f9293-0aee-4503-b573-9ae4e70e9e38-000000 e0abcdfa-c866-11e0-b6d0-273d09173b49 ././@LongLink0000000000000000000000000000015200000000000011213 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-update-application-version.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-update-application-version0000666454262600001440000000073013042511306035430 0ustar pysdk-ciamazon00000000000000{ "ApplicationVersion": { "ApplicationName": "SampleApp", "VersionLabel": "New Version", "Description": "New Release Description", "DateCreated": "2010-11-17T19:26:20.699Z", "DateUpdated": "2010-11-17T20:48:16.632Z", "SourceBundle": { "S3Bucket": "awsemr", "S3Key": "sample.war" } }, "ResponseMetadata": { "RequestId": "00b10aa1-f28c-11df-8a78-9f77047e0d0c" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-list-streaming-distributions.xml0000666454262600001440000000165213042511306035475 0ustar pysdk-ciamazon00000000000000 EGTXBD79EXAMPLE ED4L98SBEXAMPLE 1 true 4 EGTXBD79EXAMPLE Deployed 2012-05-19T19:37:58Z s5c39gqb8ow64r.cloudfront.net mystreamingbucket.s3.amazonaws.com www.example.com product.example.com First distribution PriceClass_All true botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-create-cluster-security-group.xml0000666454262600001440000000103013042511306035173 0ustar pysdk-ciamazon00000000000000 my security group securitygroup1 f9ee270f-64f7-11e2-a8da-655adc216806 botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-check-dns-availability.xml0000666454262600001440000000065013042511306035271 0ustar pysdk-ciamazon00000000000000 sampleapplication.elasticbeanstalk.amazonaws.com true 12f6701f-f1d6-11df-8a78-9f77047e0d0c botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-verify-domain-dkim.xml0000666454262600001440000000077113042511306031742 0ustar pysdk-ciamazon00000000000000 vvjuipp74whm76gqoni7qmwwn4w4qusjiainivf6sf 3frqe7jn4obpuxjpwpolz6ipb3k5nvt2nhjpik2oy wrqplteh7oodxnad7hsl4mixg2uavzneazxv5sxi2 9662c15b-c469-11e1-99d1-797d6ecd6414 botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-delete-cluster-snapshot.xml0000666454262600001440000000165113042511306034041 0ustar pysdk-ciamazon00000000000000 2012-12-07T23:31:02.372Z 5439 snapshot-1234 deleted 2012-12-06T23:09:01.475Z manual 1.0 us-east-1a examplecluster masteruser dw.hs1.xlarge mydb 3 88a31de4-40d1-11e2-8a25-eb010998df4e botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-volume-status.xml0000666454262600001440000000301713042511306032530 0ustar pysdk-ciamazon00000000000000 2e8b63e6-0016-4fa8-9cf0-49bcaa991c6b vol-bc71579a us-west-2a ok
io-enabled passed io-performance not-applicable
vol-a8d2e991 us-west-2b ok
io-enabled passed io-performance not-applicable
botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-copy-snapshot.json0000666454262600001440000000020313042511306031074 0ustar pysdk-ciamazon00000000000000{ "SnapshotId": "snap-2a2b3c4d", "ResponseMetadata": { "RequestId": "60bc441d-fa2c-494d-b155-5d6a3EXAMPLE" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-detach-network-interface.json0000666454262600001440000000012213042511306033142 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": {"RequestId": "ce540707-0635-46bc-97da-33a8a362a0e8"} } botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-confirm-subscription.xml0000666454262600001440000000061613042511306032435 0ustar pysdk-ciamazon00000000000000 arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca 7a50221f-3774-11df-a9b7-05d48da6f042 ././@LongLink0000000000000000000000000000015000000000000011211 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-reserved-node-offerings.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-reserved-node-offerings.j0000666454262600001440000000401413042511306035210 0ustar pysdk-ciamazon00000000000000{ "ReservedNodeOfferings": [ { "OfferingType": "Heavy Utilization", "FixedPrice": 24000.0, "NodeType": "dw.hs1.8xlarge", "UsagePrice": 0.0, "RecurringCharges": [ { "RecurringChargeAmount": 0.912, "RecurringChargeFrequency": "Hourly" } ], "Duration": 94608000, "ReservedNodeOfferingId": "c48ab04c-bc77-4ce4-8ada-b10c15c7b8b3" }, { "OfferingType": "Heavy Utilization", "FixedPrice": 20000.0, "NodeType": "dw.hs1.8xlarge", "UsagePrice": 0.0, "RecurringCharges": [ { "RecurringChargeAmount": 1.72, "RecurringChargeFrequency": "Hourly" } ], "Duration": 31536000, "ReservedNodeOfferingId": "248e7b75-5f85-40dc-9d11-6f1e6c7cf9c2" }, { "OfferingType": "Heavy Utilization", "FixedPrice": 2500.0, "NodeType": "dw.hs1.xlarge", "UsagePrice": 0.0, "RecurringCharges": [ { "RecurringChargeAmount": 0.215, "RecurringChargeFrequency": "Hourly" } ], "Duration": 31536000, "ReservedNodeOfferingId": "d586503b-7006-4cf5-888a-cf8f694e07bb" }, { "OfferingType": "Heavy Utilization", "FixedPrice": 3000.0, "NodeType": "dw.hs1.xlarge", "UsagePrice": 0.0, "RecurringCharges": [ { "RecurringChargeAmount": 0.114, "RecurringChargeFrequency": "Hourly" } ], "Duration": 94608000, "ReservedNodeOfferingId": "4b2293b4-64a6-4e4a-9042-cf617efa3b76" } ], "ResponseMetadata": { "RequestId": "665aecb7-9167-11e2-a970-49138ad38474" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-list-distributions.json0000666454262600001440000000754713042511306033670 0ustar pysdk-ciamazon00000000000000{ "DistributionList": { "Items": [ { "Status": "Deployed", "CacheBehaviors": { "Items": [ { "TrustedSigners": { "Items": [ "self", "111122223333" ], "Enabled": true, "Quantity": 2 }, "TargetOriginId": "example-custom-origin", "ViewerProtocolPolicy": "allow-all", "ForwardedValues": { "Cookies": { "Forward": "all" }, "QueryString": false }, "PathPattern": "*.jpg", "MinTTL": 86400 } ], "Quantity": 1 }, "Origins": { "Items": [ { "S3OriginConfig": { "OriginAccessIdentity": "origin-access-identity/cloudfront/E74FTE3AEXAMPLE" }, "Id": "example-Amazon S3-origin", "DomainName": "myawsbucket.s3.amazonaws.com" }, { "CustomOriginConfig": { "OriginProtocolPolicy": "match-viewer", "HTTPPort": 80, "HTTPSPort": 443 }, "Id": "example-custom-origin", "DomainName": "example.com" } ], "Quantity": 2 }, "DomainName": "d111111abcdef8.cloudfront.net", "PriceClass": "PriceClass_All", "Enabled": true, "DefaultCacheBehavior": { "ViewerProtocolPolicy": "https-only", "ForwardedValues": { "Cookies": { "Forward": "whitelist", "WhitelistedNames": { "Items": [ "example-cookie" ], "Quantity": 1 } }, "QueryString": true }, "TargetOriginId": "example-Amazon S3-origin", "TrustedSigners": { "Items": [ "self", "111122223333", "444455556666" ], "Enabled": true, "Quantity": 3 }, "MinTTL": 0 }, "Comment": "example comment", "ViewerCertificate": { "IAMCertificateId": "AS1A2M3P4L5E67SIIXR3J" }, "LastModifiedTime": "2012-05-19T19:37:58Z", "Id": "EDFDVBD6EXAMPLE", "Aliases": { "Items": [ "www.example.com" ], "Quantity": 1 } } ], "NextMarker": "EMLARXS9EXAMPLE", "MaxItems": 2, "Marker": "RMPARXS293KSTG7", "IsTruncated": true, "Quantity": 1 }, "ResponseMetadata": {} }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-unmonitor-instances.json0000666454262600001440000000063413042511306032314 0ustar pysdk-ciamazon00000000000000{ "InstanceMonitorings": [ { "InstanceId": "i-43a4412a", "Monitoring": { "State": "disabled" } }, { "InstanceId": "i-23a3397d", "Monitoring": { "State": "disabled" } } ], "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" } }././@LongLink0000000000000000000000000000015600000000000011217 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-configuration-options.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-configuration-opt0000666454262600001440000004072213042511306035414 0ustar pysdk-ciamazon00000000000000{ "Options": [ { "Regex": { "Pattern": "^\\S*$", "Label": "nospaces" }, "Name": "AWS_SECRET_KEY", "UserDefined": false, "ValueType": "Scalar", "ChangeSeverity": "RestartApplicationServer", "Namespace": "aws:elasticbeanstalk:application:environment", "MaxLength": 200, "DefaultValue": "" }, { "Name": "PARAM1", "UserDefined": false, "DefaultValue": "", "ChangeSeverity": "RestartApplicationServer", "Namespace": "aws:elasticbeanstalk:application:environment", "MaxLength": 200, "ValueType": "Scalar" }, { "Regex": { "Pattern": "^\\S*$", "Label": "nospaces" }, "Name": "JDBC_CONNECTION_STRING", "UserDefined": false, "ValueType": "Scalar", "ChangeSeverity": "RestartApplicationServer", "Namespace": "aws:elasticbeanstalk:application:environment", "MaxLength": 200, "DefaultValue": "" }, { "Name": "PARAM2", "UserDefined": false, "DefaultValue": "", "ChangeSeverity": "RestartApplicationServer", "Namespace": "aws:elasticbeanstalk:application:environment", "MaxLength": 200, "ValueType": "Scalar" }, { "Regex": { "Pattern": "^\\S*$", "Label": "nospaces" }, "Name": "AWS_ACCESS_KEY_ID", "UserDefined": false, "ValueType": "Scalar", "ChangeSeverity": "RestartApplicationServer", "Namespace": "aws:elasticbeanstalk:application:environment", "MaxLength": 200, "DefaultValue": "" }, { "Name": "PARAM3", "UserDefined": false, "DefaultValue": "", "ChangeSeverity": "RestartApplicationServer", "Namespace": "aws:elasticbeanstalk:application:environment", "MaxLength": 200, "ValueType": "Scalar" }, { "Name": "PARAM4", "UserDefined": false, "DefaultValue": "", "ChangeSeverity": "RestartApplicationServer", "Namespace": "aws:elasticbeanstalk:application:environment", "MaxLength": 200, "ValueType": "Scalar" }, { "Name": "PARAM5", "UserDefined": false, "DefaultValue": "", "ChangeSeverity": "RestartApplicationServer", "Namespace": "aws:elasticbeanstalk:application:environment", "MaxLength": 200, "ValueType": "Scalar" }, { "Regex": { "Pattern": "^\\S*$", "Label": "nospaces" }, "Name": "XX:MaxPermSize", "UserDefined": false, "ValueType": "Scalar", "ChangeSeverity": "RestartApplicationServer", "Namespace": "aws:elasticbeanstalk:container:tomcat:jvmoptions", "MaxLength": 200, "DefaultValue": "64m" }, { "Regex": { "Pattern": "^\\S*$", "Label": "nospaces" }, "Name": "Xms", "UserDefined": false, "ValueType": "Scalar", "ChangeSeverity": "RestartApplicationServer", "Namespace": "aws:elasticbeanstalk:container:tomcat:jvmoptions", "MaxLength": 200, "DefaultValue": "256m" }, { "Regex": { "Pattern": "^\\S*$", "Label": "nospaces" }, "Name": "Xmx", "UserDefined": false, "ValueType": "Scalar", "ChangeSeverity": "RestartApplicationServer", "Namespace": "aws:elasticbeanstalk:container:tomcat:jvmoptions", "MaxLength": 200, "DefaultValue": "256m" }, { "Name": "JVM Options", "UserDefined": false, "DefaultValue": "", "ChangeSeverity": "RestartApplicationServer", "Namespace": "aws:elasticbeanstalk:container:tomcat:jvmoptions", "MaxLength": 200, "ValueType": "Scalar" }, { "Name": "Notification Endpoint", "UserDefined": false, "DefaultValue": "", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elasticbeanstalk:sns:topics", "MaxLength": 200, "ValueType": "Scalar" }, { "Name": "Notification Topic ARN", "UserDefined": false, "DefaultValue": "", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elasticbeanstalk:sns:topics", "MaxLength": 200, "ValueType": "Scalar" }, { "Name": "Notification Protocol", "UserDefined": false, "DefaultValue": "email", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elasticbeanstalk:sns:topics", "ValueType": "Scalar", "ValueOptions": [ "http", "https", "email", "email-json", "sqs" ] }, { "Name": "Notification Topic Name", "UserDefined": false, "DefaultValue": "", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elasticbeanstalk:sns:topics", "MaxLength": 200, "ValueType": "Scalar" }, { "Name": "Stickiness Cookie Expiration", "UserDefined": false, "DefaultValue": "0", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elb:policies", "MaxValue": 1000000, "MinValue": 0, "ValueType": "Scalar" }, { "Name": "Stickiness Policy", "UserDefined": false, "DefaultValue": "false", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elb:policies", "ValueType": "Boolean" }, { "Name": "Interval", "UserDefined": false, "DefaultValue": "30", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elb:healthcheck", "MaxValue": 300, "MinValue": 5, "ValueType": "Scalar" }, { "Name": "UnhealthyThreshold", "UserDefined": false, "DefaultValue": "5", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elb:healthcheck", "MaxValue": 10, "MinValue": 2, "ValueType": "Scalar" }, { "Name": "HealthyThreshold", "UserDefined": false, "DefaultValue": "3", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elb:healthcheck", "MaxValue": 10, "MinValue": 2, "ValueType": "Scalar" }, { "Name": "Timeout", "UserDefined": false, "DefaultValue": "5", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elb:healthcheck", "MaxValue": 60, "MinValue": 2, "ValueType": "Scalar" }, { "Name": "LoadBalancerHTTPPort", "UserDefined": false, "DefaultValue": "80", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elb:loadbalancer", "ValueType": "Scalar", "ValueOptions": [ "OFF", "80" ] }, { "Name": "LoadBalancerHTTPSPort", "UserDefined": false, "DefaultValue": "OFF", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elb:loadbalancer", "ValueType": "Scalar", "ValueOptions": [ "OFF", "443", "8443" ] }, { "Name": "SSLCertificateId", "UserDefined": false, "DefaultValue": "", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elb:loadbalancer", "MaxLength": 200, "ValueType": "Scalar" }, { "Name": "Statistic", "UserDefined": false, "DefaultValue": "Average", "ChangeSeverity": "NoInterruption", "Namespace": "aws:autoscaling:trigger", "ValueType": "Scalar", "ValueOptions": [ "Minimum", "Maximum", "Sum", "Average" ] }, { "Name": "MeasureName", "UserDefined": false, "DefaultValue": "NetworkOut", "ChangeSeverity": "NoInterruption", "Namespace": "aws:autoscaling:trigger", "ValueType": "Scalar", "ValueOptions": [ "CPUUtilization", "NetworkIn", "NetworkOut", "DiskWriteOps", "DiskReadBytes", "DiskReadOps", "DiskWriteBytes", "Latency", "RequestCount", "HealthyHostCount", "UnhealthyHostCount" ] }, { "Name": "Unit", "UserDefined": false, "DefaultValue": "Bytes", "ChangeSeverity": "NoInterruption", "Namespace": "aws:autoscaling:trigger", "ValueType": "Scalar", "ValueOptions": [ "Seconds", "Percent", "Bytes", "Bits", "Count", "Bytes/Second", "Bits/Second", "Count/Second", "None" ] }, { "Name": "LowerThreshold", "UserDefined": false, "DefaultValue": "2000000", "ChangeSeverity": "NoInterruption", "Namespace": "aws:autoscaling:trigger", "MaxValue": 20000000, "MinValue": 0, "ValueType": "Scalar" }, { "Name": "UpperBreachScaleIncrement", "UserDefined": false, "DefaultValue": "1", "ChangeSeverity": "NoInterruption", "Namespace": "aws:autoscaling:trigger", "MaxLength": 200, "ValueType": "Scalar" }, { "Name": "LowerBreachScaleIncrement", "UserDefined": false, "DefaultValue": "-1", "ChangeSeverity": "NoInterruption", "Namespace": "aws:autoscaling:trigger", "MaxLength": 200, "ValueType": "Scalar" }, { "Name": "BreachDuration", "UserDefined": false, "DefaultValue": "5", "ChangeSeverity": "NoInterruption", "Namespace": "aws:autoscaling:trigger", "MaxValue": 600, "MinValue": 1, "ValueType": "Scalar" }, { "Name": "Period", "UserDefined": false, "DefaultValue": "5", "ChangeSeverity": "NoInterruption", "Namespace": "aws:autoscaling:trigger", "MaxValue": 600, "MinValue": 1, "ValueType": "Scalar" }, { "Name": "UpperThreshold", "UserDefined": false, "DefaultValue": "6000000", "ChangeSeverity": "NoInterruption", "Namespace": "aws:autoscaling:trigger", "MaxValue": 20000000, "MinValue": 0, "ValueType": "Scalar" }, { "Name": "MaxSize", "UserDefined": false, "DefaultValue": "4", "ChangeSeverity": "NoInterruption", "Namespace": "aws:autoscaling:asg", "MaxValue": 10000, "MinValue": 1, "ValueType": "Scalar" }, { "Name": "MinSize", "UserDefined": false, "DefaultValue": "1", "ChangeSeverity": "NoInterruption", "Namespace": "aws:autoscaling:asg", "MaxValue": 10000, "MinValue": 1, "ValueType": "Scalar" }, { "Name": "Availability Zones", "UserDefined": false, "DefaultValue": "Any 1", "ChangeSeverity": "NoInterruption", "Namespace": "aws:autoscaling:asg", "ValueType": "Scalar", "ValueOptions": [ "Any 1", "Any 2", "Any" ] }, { "Name": "Cooldown", "UserDefined": false, "DefaultValue": "360", "ChangeSeverity": "NoInterruption", "Namespace": "aws:autoscaling:asg", "MaxValue": 10000, "MinValue": 0, "ValueType": "Scalar" }, { "Name": "Custom Availability Zones", "UserDefined": false, "DefaultValue": "", "ChangeSeverity": "NoInterruption", "Namespace": "aws:autoscaling:asg", "ValueType": "List", "ValueOptions": [ "us-west-2a", "us-west-2b", "us-west-2c" ] }, { "Name": "MonitoringInterval", "UserDefined": false, "DefaultValue": "5 minute", "ChangeSeverity": "RestartEnvironment", "Namespace": "aws:autoscaling:launchconfiguration", "ValueType": "Scalar", "ValueOptions": [ "1 minute", "5 minute" ] }, { "Name": "EC2KeyName", "UserDefined": false, "DefaultValue": "", "ChangeSeverity": "RestartEnvironment", "Namespace": "aws:autoscaling:launchconfiguration", "MaxLength": 200, "ValueType": "Scalar" }, { "Name": "SecurityGroups", "UserDefined": false, "DefaultValue": "elasticbeanstalk-default", "ChangeSeverity": "RestartEnvironment", "Namespace": "aws:autoscaling:launchconfiguration", "MaxLength": 200, "ValueType": "Scalar" }, { "Name": "ImageId", "UserDefined": false, "DefaultValue": "ami-f62fa3c6", "ChangeSeverity": "RestartEnvironment", "Namespace": "aws:autoscaling:launchconfiguration", "MaxLength": 200, "ValueType": "Scalar" }, { "Name": "InstanceType", "UserDefined": false, "DefaultValue": "t1.micro", "ChangeSeverity": "RestartEnvironment", "Namespace": "aws:autoscaling:launchconfiguration", "ValueType": "Scalar", "ValueOptions": [ "t1.micro", "m1.small", "c1.medium", "m1.medium" ] }, { "Regex": { "Pattern": "^\\S*$", "Label": "nospaces" }, "Name": "Application Healthcheck URL", "UserDefined": false, "ValueType": "Scalar", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elasticbeanstalk:application", "MaxLength": 200, "DefaultValue": "/" }, { "Name": "Automatically Terminate Unhealthy Instances", "UserDefined": false, "DefaultValue": "true", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elasticbeanstalk:monitoring", "ValueType": "Boolean" }, { "Name": "LogPublicationControl", "UserDefined": false, "DefaultValue": "false", "ChangeSeverity": "NoInterruption", "Namespace": "aws:elasticbeanstalk:hostmanager", "ValueType": "Boolean" } ], "ResponseMetadata": { "RequestId": "af3d86f9-9167-11e2-a92a-116deff19e14" }, "SolutionStackName": "32bit Amazon Linux running Tomcat 6" } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-reserved-instances.json0000666454262600001440000000142413042511306033655 0ustar pysdk-ciamazon00000000000000{"ReservedInstances": [{"AvailabilityZone": "us-east-1a", "CurrencyCode": "USD", "Duration": 31536000, "FixedPrice": 1820.0, "InstanceCount": 3, "InstanceTenancy": "default", "InstanceType": "m1.xlarge", "OfferingType": "Light Utilization", "ProductDescription": "Linux/UNIX", "RecurringCharges": [], "ReservedInstancesId": "4b2293b4-5813-4cc8-9ce3-1957fc1dcfc8EXAMPLE", "State": "active", "UsagePrice": 0.24}], "ResponseMetadata": {"RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-cancel-bundle-task.json0000666454262600001440000000077113042511306031733 0ustar pysdk-ciamazon00000000000000{ "BundleTask": { "UpdateTime": "2008-10-07T11:51:50.000Z", "InstanceId": "i-12345678", "Storage": { "S3": { "Prefix": "my-new-image", "Bucket": "myawsbucket" } }, "State": "canceling", "StartTime": "2008-10-07T11:41:50.000Z", "Progress": "20%", "BundleId": "bun-cla322b9" }, "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" } }././@LongLink0000000000000000000000000000014700000000000011217 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-purchase-reserved-node-offering.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-purchase-reserved-node-offering.js0000666454262600001440000000121113042511306035236 0ustar pysdk-ciamazon00000000000000{ "ReservedNode": { "OfferingType": "Heavy Utilization", "FixedPrice": 12452.0, "NodeType": "dw.hs1.8xlarge", "ReservedNodeId": "1ba8e2e3-dacf-48d9-841f-cc675182a8a6", "UsagePrice": 0.0, "RecurringCharges": [ { "RecurringChargeAmount": 0.21, "RecurringChargeFrequency": "Hourly" } ], "NodeCount": 2, "State": "payment-pending", "StartTime": "2013-01-18T21:42:44.402Z", "Duration": 94608000 }, "ResponseMetadata": { "RequestId": "fcb117cc-61b7-11e2-b6e9-87e586e4ca38" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-db-snapshots.xml0000666454262600001440000000513513042511306032427 0ustar pysdk-ciamazon00000000000000 3306 2011-05-23T06:29:03.483Z mysql available us-east-1a general-public-license 2011-05-23T06:06:43.110Z 10 simcoprod01 5.1.50 mydbsnapshot manual master myoptiongroupname 3306 2011-03-11T07:20:24.082Z mysql available us-east-1a general-public-license 2010-08-04T23:27:36.420Z 50 mydbinstance 5.1.49 mysnapshot1 manual sa myoptiongroupname 3306 2012-04-02T00:01:24.082Z mysql available us-east-1d general-public-license 2010-07-16T00:06:59.107Z 60 simcoprod01 5.1.47 rds:simcoprod01-2012-04-02-00-01 automated master myoptiongroupname c4191173-8506-11e0-90aa-eb648410240d botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-roles.json0000666454262600001440000000343713042511306030473 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "20f7279f-99ee-11e1-a4c3-27EXAMPLE804" }, "IsTruncated": false, "Roles": [ { "AssumeRolePolicyDocument": { "Version": "2008-10-17", "Statement": [ { "Action": [ "sts:AssumeRole" ], "Effect": "Allow", "Principal": { "Service": [ "ec2.amazonaws.com" ] } } ] }, "RoleId": "AROACVSVTSZYEXAMPLEYK", "CreateDate": "2012-05-09T15:45:35Z", "RoleName": "S3Access", "Path": "/application_abc/component_xyz/", "Arn": "arn:aws:iam::123456789012:role/application_abc/component_xyz/S3Access" }, { "AssumeRolePolicyDocument": { "Version": "2008-10-17", "Statement": [ { "Action": [ "sts:AssumeRole" ], "Effect": "Allow", "Principal": { "Service": [ "ec2.amazonaws.com" ] } } ] }, "RoleId": "AROAC2ICXG32EXAMPLEWK", "CreateDate": "2012-05-09T15:45:45Z", "RoleName": "SDBAccess", "Path": "/application_abc/component_xyz/", "Arn": "arn:aws:iam::123456789012:role/application_abc/component_xyz/SDBAccess" } ] }botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-subnet-groups.xml0000666454262600001440000000226613042511306035340 0ustar pysdk-ciamazon00000000000000 vpc-5d917a30 my subnet group my-subnet-group Complete Active subnet-71c5091c us-east-1a Active subnet-78de1215 us-east-1a 42024b68-6af3-11e2-a726-6368a468fa67 ././@LongLink0000000000000000000000000000014600000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-get-identity-notification-attributes.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-get-identity-notification-attributes.xm0000666454262600001440000000130713042511306035345 0ustar pysdk-ciamazon00000000000000 user@example.com true arn:aws:sns:us-east-1:123456789012:example arn:aws:sns:us-east-1:123456789012:example e038e509-b72a-11e1-901f-1fbd90e8104f botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-dhcp-options.json0000666454262600001440000000117513042511306032463 0ustar pysdk-ciamazon00000000000000{ "DhcpOptions": [ { "DhcpConfigurations": [ { "Values": [ {"Value": "us-west-2.compute.internal"} ], "Key": "domain-name" }, { "Values": [ {"Value": "AmazonProvidedDNS"} ], "Key": "domain-name-servers" } ], "DhcpOptionsId": "dopt-eb291082" } ], "ResponseMetadata": { "RequestId": "684ba87f-78a1-4c29-a70b-f6103a15c162" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-mfa-devices.xml0000666454262600001440000000071713042511306031357 0ustar pysdk-ciamazon00000000000000 Bob R1234 false 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-get-distribution.json0000666454262600001440000001072213042511306033276 0ustar pysdk-ciamazon00000000000000{ "Distribution": { "Status": "Deployed", "DomainName": "d111111abcdef8.cloudfront.net", "InProgressInvalidationBatches": 1, "DistributionConfig": { "Comment": "example comment", "CacheBehaviors": { "Items": [ { "TrustedSigners": { "Items": [ "self", "111122223333" ], "Enabled": true, "Quantity": 2 }, "TargetOriginId": "example-custom-origin", "ViewerProtocolPolicy": "allow-all", "ForwardedValues": { "Cookies": { "Forward": "all" }, "QueryString": false }, "PathPattern": "*.jpg", "MinTTL": 86400 } ], "Quantity": 1 }, "Logging": { "Bucket": "myawslogbucket.s3.amazonaws.com", "Prefix": "example.com.", "Enabled": true, "IncludeCookies": true }, "Origins": { "Items": [ { "S3OriginConfig": { "OriginAccessIdentity": "origin-access-identity/cloudfront/E74FTE3AEXAMPLE" }, "Id": "example-Amazon S3-origin", "DomainName": "myawsbucket.s3.amazonaws.com" }, { "CustomOriginConfig": { "OriginProtocolPolicy": "match-viewer", "HTTPPort": 80, "HTTPSPort": 443 }, "Id": "example-custom-origin", "DomainName": "example.com" } ], "Quantity": 2 }, "DefaultRootObject": "index.html", "PriceClass": "PriceClass_All", "Enabled": true, "DefaultCacheBehavior": { "ViewerProtocolPolicy": "https-only", "ForwardedValues": { "Cookies": { "Forward": "whitelist", "WhitelistedNames": { "Items": [ "example-cookie" ], "Quantity": 1 } }, "QueryString": true }, "TargetOriginId": "example-Amazon S3-origin", "TrustedSigners": { "Items": [ "self", "111122223333", "444455556666" ], "Enabled": true, "Quantity": 3 }, "MinTTL": 0 }, "CallerReference": "example.com2012-04-11-5:09pm", "ViewerCertificate": { "IAMCertificateId": "AS1A2M3P4L5E67SIIXR3J" }, "Aliases": { "Items": [ "www.example.com" ], "Quantity": 1 } }, "ActiveTrustedSigners": { "Items": [ { "KeyPairIds": { "Items": [ "APKA9ONS7QCOWEXAMPLE" ], "Quantity": 1 }, "AwsAccountNumber": "self" }, { "KeyPairIds": { "Quantity": 2 }, "AwsAccountNumber": "111122223333" }, { "KeyPairIds": { "Quantity": 0 }, "AwsAccountNumber": "444455556666" } ], "Quantity": 3 }, "LastModifiedTime": "2012-05-19T19:37:58Z", "Id": "EDFDVBD6EXAMPLE" }, "ResponseMetadata": {} }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-network-interface.json0000666454262600001440000000242313042511306033163 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "bd78c839-0895-4fac-a17f-98b559b6b630" }, "NetworkInterface": { "Status": "pending", "MacAddress": "02:74:b0:70:7f:1a", "SourceDestCheck": true, "VpcId": "vpc-c31dafaa", "Description": "", "NetworkInterfaceId": "eni-1bcb7772", "PrivateIpAddresses": [ { "Primary": true, "PrivateIpAddress": "10.0.2.140" }, { "Primary": false, "PrivateIpAddress": "10.0.2.172" }, { "Primary": false, "PrivateIpAddress": "10.0.2.169" }, { "Primary": false, "PrivateIpAddress": "10.0.2.170" }, { "Primary": false, "PrivateIpAddress": "10.0.2.171" } ], "RequesterManaged": false, "AvailabilityZone": "ap-southeast-1b", "Groups": [ { "GroupName": "default", "GroupId": "sg-1a2b3c4d" } ], "SubnetId": "subnet-a61dafcf", "OwnerId": "251839141158", "TagSet": [], "PrivateIpAddress": "10.0.2.140" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-db-subnet-groups.json0000666454262600001440000000420513042511306033370 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "31d0faee-229b-11e1-81f1-df3a2a803dad" }, "DBSubnetGroups": [ { "Subnets": [ { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-7c5b4115", "SubnetAvailabilityZone": { "Name": "us-east-1c" } }, { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-7b5b4112", "SubnetAvailabilityZone": { "Name": "us-east-1b" } }, { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-3ea6bd57", "SubnetAvailabilityZone": { "Name": "us-east-1d" } } ], "DBSubnetGroupName": "subnet_grp1", "VpcId": "990524496922", "DBSubnetGroupDescription": "description", "SubnetGroupStatus": "Complete" }, { "Subnets": [ { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-7c5b4115", "SubnetAvailabilityZone": { "Name": "us-east-1c" } }, { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-7b5b4112", "SubnetAvailabilityZone": { "Name": "us-east-1b" } }, { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-3ea6bd57", "SubnetAvailabilityZone": { "Name": "us-east-1d" } } ], "DBSubnetGroupName": "subnet_grp2", "VpcId": "990524496922", "DBSubnetGroupDescription": "description", "SubnetGroupStatus": "Complete" } ] }././@LongLink0000000000000000000000000000015300000000000011214 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-termination-policy-types.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-termination-policy-typ0000666454262600001440000000112213042511306035374 0ustar pysdk-ciamazon00000000000000 ClosestToNextInstanceHour Default NewestInstance OldestInstance OldestLaunchConfiguration 67e117a5-9167-11e2-9223-abe83dfc0567 botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-reset-cluster-parameter-group.xml0000666454262600001440000000102313042511306035165 0ustar pysdk-ciamazon00000000000000 Your parameter group has been updated but changes won't get applied until you reboot the associated Clusters. parametergroup1 625d23c1-40dc-11e2-8a25-eb010998df4e botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-spot-instance-requests.json0000666454262600001440000000175713042511306034522 0ustar pysdk-ciamazon00000000000000{"ResponseMetadata": {"RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE"}, "SpotInstanceRequests": [ {"CreateTime": "YYYY-MM-DDTHH:MM:SS.000Z", "InstanceId": "i-1a2b3c4d", "LaunchSpecification": {"EbsOptimized": false, "ImageId": "ami-1a2b3c4d", "InstanceType": "m1.small", "KeyName": "gsg-keypair", "Monitoring": {"Enabled": false}, "SecurityGroups": [{"GroupId": "sg-1a2b3c4d", "GroupName": "default"}]}, "LaunchedAvailabilityZone": "us-east-1c", "ProductDescription": "Linux/UNIX", "SpotInstanceRequestId": "sir-1a2b3c4d", "SpotPrice": "0.09", "State": "active", "Status": {"Code": "fulfilled", "Message": "Your Spot request is fulfilled.", "UpdateTime": "YYYY-MM-DDTHH:MM:SS.000Z"}, "Type": "one-time"} ] } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-volume.json0000666454262600001440000000046113042511306031043 0ustar pysdk-ciamazon00000000000000{ "AvailabilityZone": "us-east-1a", "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" }, "VolumeType": "standard", "VolumeId": "vol-1a2b3c4d", "State": "creating", "SnapshotId": "", "CreateTime": "YYYY-MM-DDTHH:MM:SS.000Z", "Size": 80 } botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-list-multipart-uploads#2.xml0000666454262600001440000000376413042511306032573 0ustar pysdk-ciamazon00000000000000 bucket my-movie.m2ts YW55IGlkZWEgd2h5IGVsdmluZydzIHVwbG9hZCBmYWlsZWQ 3 true my-divisor XMgbGlrZSBlbHZpbmcncyBub3QgaGF2aW5nIG11Y2ggbHVjaw arn:aws:iam::111122223333:user/user1-11111a31-17b5-4fb7-9df5-b111111f13de user1-11111a31-17b5-4fb7-9df5-b111111f13de 75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a OwnerDisplayName STANDARD 2010-11-10T20:48:33.000Z my-movie.m2ts VXBsb2FkIElEIGZvciBlbHZpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZA b1d16700c70b0b05597d7acd6a3f92be InitiatorDisplayName b1d16700c70b0b05597d7acd6a3f92be OwnerDisplayName STANDARD 2010-11-10T20:48:33.000Z my-movie.m2ts YW55IGlkZWEgd2h5IGVsdmluZydzIHVwbG9hZCBmYWlsZWQ arn:aws:iam::444455556666:user/user1-22222a31-17b5-4fb7-9df5-b222222f13de user1-22222a31-17b5-4fb7-9df5-b222222f13de b1d16700c70b0b05597d7acd6a3f92be OwnerDisplayName STANDARD 2010-11-10T20:49:33.000Z botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-cancel-bundle-task.xml0000666454262600001440000000113613042511306031556 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-12345678 bun-cla322b9 canceling 2008-10-07T11:41:50.000Z 2008-10-07T11:51:50.000Z 20% myawsbucket my-new-image ././@LongLink0000000000000000000000000000014700000000000011217 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-security-groups.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-security-groups.x0000666454262600001440000000172013042511306035350 0ustar pysdk-ciamazon00000000000000 0.0.0.0/0 authorized default default my security group securitygroup1 947a8305-64f8-11e2-bec0-17624ad140dd botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-parameters.xml0000666454262600001440000000556013042511306034666 0ustar pysdk-ciamazon00000000000000 ISO, MDY string engine-default true Sets the display format for date and time values. datestyle 0 integer engine-default true Sets the number of digits displayed for floating-point values -15-2 extra_float_digits default string engine-default true This parameter applies a user-defined label to a group of queries that are run during the same session.. query_group false boolean engine-default true require ssl for all databaseconnections true,false require_ssl $user, public string engine-default true Sets the schema search order for names that are not schema-qualified. search_path 0 integer engine-default true Aborts any statement that takes over the specified number of milliseconds. statement_timeout [{"query_concurrency":5}] string engine-default true wlm json configuration wlm_json_configuration 2ba35df4-40d3-11e2-82cf-0b45b05c0221 botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-virtual-mfa-devices.xml0000666454262600001440000000236313042511306033042 0ustar pysdk-ciamazon00000000000000 false arn:aws:iam::123456789012:mfa/MFAdeviceName arn:aws:iam::123456789012:mfa/RootMFAdeviceName 2011-10-20T20:49:03Z 123456789012 arn:aws:iam::123456789012:root 2009-10-13T22:00:36Z arn:aws:iam:::mfa/ExampleUserMFAdeviceName 2011-10-31T20:45:02Z AIDEXAMPLE4EXAMPLEXYZ / ExampleUser arn:aws:iam::111122223333:user/ExampleUser 2011-07-01T17:23:07Z b61ce1b1-0401-11e1-b2f8-2dEXAMPLEbfc botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-set-identity-dkim-enabled.xml0000666454262600001440000000040113042511306033171 0ustar pysdk-ciamazon00000000000000 7aa61362-c469-11e1-aee5-6bbb4608fbcc botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-vpn-gateways.xml0000666454262600001440000000111613042511306032323 0ustar pysdk-ciamazon00000000000000 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE vgw-8db04f81 available ipsec.1 us-east-1a vpc-1a2b3c4d attached botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-db-security-groups.json0000666454262600001440000000152213042511306033736 0ustar pysdk-ciamazon00000000000000{ "DBSecurityGroups": [ { "IPRanges": [], "OwnerId": "123456789012", "DBSecurityGroupDescription": "default", "EC2SecurityGroups": [], "DBSecurityGroupName": "default" }, { "IPRanges": [], "OwnerId": "123456789012", "DBSecurityGroupDescription": "My first security group", "EC2SecurityGroups": [], "DBSecurityGroupName": "testgroup1" }, { "IPRanges": [], "OwnerId": "123456789012", "DBSecurityGroupDescription": "My second security group", "EC2SecurityGroups": [], "DBSecurityGroupName": "testgroup2" } ], "ResponseMetadata": { "RequestId": "aaf3813f-9167-11e2-a2d0-e302f09d52ea" } }././@LongLink0000000000000000000000000000014600000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elb-describe-load-balancer-policy-types.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elb-describe-load-balancer-policy-types.jso0000666454262600001440000005253213042511306035115 0ustar pysdk-ciamazon00000000000000{ "PolicyTypeDescriptions": [ { "PolicyAttributeTypeDescriptions": [ { "Cardinality": "ZERO_OR_ONE", "AttributeName": "CookieExpirationPeriod", "AttributeType": "Long" } ], "PolicyTypeName": "LBCookieStickinessPolicyType", "Description": "Stickiness policy with session lifetimes controlled by the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners." }, { "PolicyAttributeTypeDescriptions": [ { "Cardinality": "ONE_OR_MORE", "AttributeName": "PublicKeyPolicyName", "AttributeType": "PolicyName" } ], "PolicyTypeName": "BackendServerAuthenticationPolicyType", "Description": "Policy that controls authentication to back-end server(s) and contains one or more policies, such as an instance of a PublicKeyPolicyType. This policy can be associated only with back-end servers that are using HTTPS/SSL." }, { "PolicyAttributeTypeDescriptions": [ { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "Protocol-SSLv2", "Description": "A description for Protocol-SSLv2", "AttributeType": "Boolean" }, { "DefaultValue": "true", "Cardinality": "ZERO_OR_ONE", "AttributeName": "Protocol-TLSv1", "Description": "A description for Protocol-TLSv1", "AttributeType": "Boolean" }, { "DefaultValue": "true", "Cardinality": "ZERO_OR_ONE", "AttributeName": "Protocol-SSLv3", "Description": "A description for Protocol-SSLv3", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "DHE-RSA-AES256-SHA", "Description": "A description for DHE-RSA-AES256-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "DHE-DSS-AES256-SHA", "Description": "A description for DHE-DSS-AES256-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "DHE-RSA-CAMELLIA256-SHA", "Description": "A description for DHE-RSA-CAMELLIA256-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "DHE-DSS-CAMELLIA256-SHA", "Description": "A description for DHE-DSS-CAMELLIA256-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "ADH-AES256-SHA", "Description": "A description for ADH-AES256-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "ADH-CAMELLIA256-SHA", "Description": "A description for ADH-CAMELLIA256-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "true", "Cardinality": "ZERO_OR_ONE", "AttributeName": "AES256-SHA", "Description": "A description for AES256-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "CAMELLIA256-SHA", "Description": "A description for CAMELLIA256-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "PSK-AES256-CBC-SHA", "Description": "A description for PSK-AES256-CBC-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EDH-RSA-DES-CBC3-SHA", "Description": "A description for EDH-RSA-DES-CBC3-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EDH-DSS-DES-CBC3-SHA", "Description": "A description for EDH-DSS-DES-CBC3-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "ADH-DES-CBC3-SHA", "Description": "A description for ADH-DES-CBC3-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "true", "Cardinality": "ZERO_OR_ONE", "AttributeName": "DES-CBC3-SHA", "Description": "A description for DES-CBC3-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "DES-CBC3-MD5", "Description": "A description for DES-CBC3-MD5", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "PSK-3DES-EDE-CBC-SHA", "Description": "A description for PSK-3DES-EDE-CBC-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "KRB5-DES-CBC3-SHA", "Description": "A description for KRB5-DES-CBC3-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "KRB5-DES-CBC3-MD5", "Description": "A description for KRB5-DES-CBC3-MD5", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "DHE-RSA-AES128-SHA", "Description": "A description for DHE-RSA-AES128-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "DHE-DSS-AES128-SHA", "Description": "A description for DHE-DSS-AES128-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "DHE-RSA-SEED-SHA", "Description": "A description for DHE-RSA-SEED-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "DHE-DSS-SEED-SHA", "Description": "A description for DHE-DSS-SEED-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "DHE-RSA-CAMELLIA128-SHA", "Description": "A description for DHE-RSA-CAMELLIA128-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "DHE-DSS-CAMELLIA128-SHA", "Description": "A description for DHE-DSS-CAMELLIA128-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "ADH-AES128-SHA", "Description": "A description for ADH-AES128-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "ADH-SEED-SHA", "Description": "A description for ADH-SEED-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "ADH-CAMELLIA128-SHA", "Description": "A description for ADH-CAMELLIA128-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "true", "Cardinality": "ZERO_OR_ONE", "AttributeName": "AES128-SHA", "Description": "A description for AES128-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "SEED-SHA", "Description": "A description for SEED-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "CAMELLIA128-SHA", "Description": "A description for CAMELLIA128-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "RC2-CBC-MD5", "Description": "A description for RC2-CBC-MD5", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "PSK-AES128-CBC-SHA", "Description": "A description for PSK-AES128-CBC-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "ADH-RC4-MD5", "Description": "A description for ADH-RC4-MD5", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "IDEA-CBC-SHA", "Description": "A description for IDEA-CBC-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "true", "Cardinality": "ZERO_OR_ONE", "AttributeName": "RC4-SHA", "Description": "A description for RC4-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "true", "Cardinality": "ZERO_OR_ONE", "AttributeName": "RC4-MD5", "Description": "A description for RC4-MD5", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "PSK-RC4-SHA", "Description": "A description for PSK-RC4-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "KRB5-RC4-SHA", "Description": "A description for KRB5-RC4-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "KRB5-RC4-MD5", "Description": "A description for KRB5-RC4-MD5", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EDH-RSA-DES-CBC-SHA", "Description": "A description for EDH-RSA-DES-CBC-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EDH-DSS-DES-CBC-SHA", "Description": "A description for EDH-DSS-DES-CBC-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "ADH-DES-CBC-SHA", "Description": "A description for ADH-DES-CBC-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "DES-CBC-SHA", "Description": "A description for DES-CBC-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "DES-CBC-MD5", "Description": "A description for DES-CBC-MD5", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "KRB5-DES-CBC-SHA", "Description": "A description for KRB5-DES-CBC-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "KRB5-DES-CBC-MD5", "Description": "A description for KRB5-DES-CBC-MD5", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EXP-EDH-RSA-DES-CBC-SHA", "Description": "A description for EXP-EDH-RSA-DES-CBC-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EXP-EDH-DSS-DES-CBC-SHA", "Description": "A description for EXP-EDH-DSS-DES-CBC-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EXP-ADH-DES-CBC-SHA", "Description": "A description for EXP-ADH-DES-CBC-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EXP-DES-CBC-SHA", "Description": "A description for EXP-DES-CBC-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EXP-RC2-CBC-MD5", "Description": "A description for EXP-RC2-CBC-MD5", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EXP-KRB5-RC2-CBC-SHA", "Description": "A description for EXP-KRB5-RC2-CBC-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EXP-KRB5-DES-CBC-SHA", "Description": "A description for EXP-KRB5-DES-CBC-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EXP-KRB5-RC2-CBC-MD5", "Description": "A description for EXP-KRB5-RC2-CBC-MD5", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EXP-KRB5-DES-CBC-MD5", "Description": "A description for EXP-KRB5-DES-CBC-MD5", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EXP-ADH-RC4-MD5", "Description": "A description for EXP-ADH-RC4-MD5", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EXP-RC4-MD5", "Description": "A description for EXP-RC4-MD5", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EXP-KRB5-RC4-SHA", "Description": "A description for EXP-KRB5-RC4-SHA", "AttributeType": "Boolean" }, { "DefaultValue": "false", "Cardinality": "ZERO_OR_ONE", "AttributeName": "EXP-KRB5-RC4-MD5", "Description": "A description for EXP-KRB5-RC4-MD5", "AttributeType": "Boolean" } ], "PolicyTypeName": "SSLNegotiationPolicyType", "Description": "Listener policy that defines the ciphers and protocols that will be accepted by the load balancer. This policy can be associated only with HTTPS/SSL listeners." }, { "PolicyAttributeTypeDescriptions": [ { "Cardinality": "ONE", "AttributeName": "PublicKey", "AttributeType": "String" } ], "PolicyTypeName": "PublicKeyPolicyType", "Description": "Policy containing a list of public keys to accept when authenticating the back-end server(s). This policy cannot be applied directly to back-end servers or listeners but must be part of a BackendServerAuthenticationPolicyType." }, { "PolicyAttributeTypeDescriptions": [ { "Cardinality": "ONE", "AttributeName": "CookieName", "AttributeType": "String" } ], "PolicyTypeName": "AppCookieStickinessPolicyType", "Description": "Stickiness policy with session lifetimes controlled by the lifetime of the application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners." } ], "ResponseMetadata": { "RequestId": "ab7c8724-9167-11e2-b472-75a63fc08e7f" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-db-subnet-groups.xml0000666454262600001440000000654713042511306033232 0ustar pysdk-ciamazon00000000000000 990524496922 Complete description subnet_grp1 Active subnet-7c5b4115 us-east-1c Active subnet-7b5b4112 us-east-1b Active subnet-3ea6bd57 us-east-1d 990524496922 Complete description subnet_grp2 Active subnet-7c5b4115 us-east-1c Active subnet-7b5b4112 us-east-1b Active subnet-3ea6bd57 us-east-1d 31d0faee-229b-11e1-81f1-df3a2a803dad botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-versions.json0000666454262600001440000000045413042511306034541 0ustar pysdk-ciamazon00000000000000{ "ClusterVersions": [ { "ClusterVersion": "1.0", "Description": "release db engine 1.0.54", "ClusterParameterGroupFamily": "redshift-1.0" } ], "ResponseMetadata": { "RequestId": "6641e675-9167-11e2-a970-49138ad38474" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudformation-get-template.xml0000666454262600001440000001214613042511306033071 0ustar pysdk-ciamazon00000000000000 { "AWSTemplateFormatVersion" : "2010-09-09", "Description" : "AWS CloudFormation Sample Template EC2WithEBSSample: Create an Amazon EC2 instance running the Amazon Linux AMI with a new EBS volume attached. The instance and the volume are pinned to the same availability zone. We recommend that you do untargeted launches rather than pinning instances this way.The AMI is chosen based on the region in which the stack is run. **WARNING** This template creates an Amazon EC2 instance and an EBS Volume. You will be billed for the AWS resources used if you create a stack from this template.", "Parameters" : { "KeyName" : { "Description" : "Name of an existing EC2 KeyPair to enable SSH access to the instance", "Type" : "String" }, "SSHLocation" : { "Description" : "The IP address range that can be used to SSH to the EC2 instances", "Type": "String", "MinLength": "9", "MaxLength": "18", "Default": "0.0.0.0/0", "AllowedPattern": "(\\d{1,3})\\.(\\d{1,3})\\.(\\d{1,3})\\.(\\d{1,3})/(\\d{1,2})", "ConstraintDescription": "must be a valid IP CIDR range of the form x.x.x.x/x." } }, "Mappings" : { "RegionMap" : { "us-east-1" : { "AMI" : "ami-7f418316", "TestAz" : "us-east-1a" }, "us-west-1" : { "AMI" : "ami-951945d0", "TestAz" : "us-west-1a" }, "us-west-2" : { "AMI" : "ami-16fd7026", "TestAz" : "us-west-2a" }, "eu-west-1" : { "AMI" : "ami-24506250", "TestAz" : "eu-west-1a" }, "sa-east-1" : { "AMI" : "ami-3e3be423", "TestAz" : "sa-east-1a" }, "ap-southeast-1" : { "AMI" : "ami-74dda626", "TestAz" : "ap-southeast-1a" }, "ap-southeast-2" : { "AMI" : "ami-b3990e89", "TestAz" : "ap-southeast-2a" }, "ap-northeast-1" : { "AMI" : "ami-dcfa4edd", "TestAz" : "ap-northeast-1a" } } }, "Resources" : { "Ec2Instance" : { "Type" : "AWS::EC2::Instance", "Properties" : { "AvailabilityZone" : { "Fn::FindInMap" : [ "RegionMap", { "Ref" : "AWS::Region" }, "TestAz" ]}, "SecurityGroups" : [ { "Ref" : "InstanceSecurityGroup" } ], "KeyName" : { "Ref" : "KeyName" }, "ImageId" : { "Fn::FindInMap" : [ "RegionMap", { "Ref" : "AWS::Region" }, "AMI" ]}, "Volumes" : [ { "VolumeId" : { "Ref" : "NewVolume" }, "Device" : "/dev/sdk" } ] } }, "InstanceSecurityGroup" : { "Type" : "AWS::EC2::SecurityGroup", "Properties" : { "GroupDescription" : "Enable SSH access via port 22", "SecurityGroupIngress" : [ { "IpProtocol" : "tcp", "FromPort" : "22", "ToPort" : "22", "CidrIp" : { "Ref" : "SSHLocation"} } ] } }, "NewVolume" : { "Type" : "AWS::EC2::Volume", "Properties" : { "Size" : "100", "AvailabilityZone" : { "Fn::FindInMap" : [ "RegionMap", { "Ref" : "AWS::Region" }, "TestAz" ]} } } }, "Outputs" : { "InstanceId" : { "Description" : "InstanceId of the newly created EC2 instance", "Value" : { "Ref" : "Ec2Instance" } }, "PublicIP" : { "Description" : "Public IP address of the newly created EC2 instance", "Value" : { "Fn::GetAtt" : [ "Ec2Instance", "PublicIp" ] } }, "PublicDNS" : { "Description" : "Public DNSName of the newly created EC2 instance", "Value" : { "Fn::GetAtt" : [ "Ec2Instance", "PublicDnsName" ] } } } } 4ca8b6a8-bc40-11e2-95ee-bd3eac9f6692 botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-send-message-batch.json0000666454262600001440000000076613042511306032072 0ustar pysdk-ciamazon00000000000000{ "Successful": [ { "MD5OfMessageBody": "0e024d309850c78cba5eabbeff7cae71", "Id": "test_msg_001", "MessageId": "0a5231c7-8bff-4955-be2e-8dc7c50a25fa" }, { "MD5OfMessageBody": "7fb8146a82f95e0af155278f406862c2", "Id": "test_msg_002", "MessageId": "15ee1ed3-87e7-40c1-bdaa-2e49968ea7e9" } ], "ResponseMetadata": { "RequestId": "ca1ad5d0-8271-408b-8d0f-1351bf547e74" } } ././@LongLink0000000000000000000000000000014600000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-scaling-activities.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-scaling-activities.jso0000666454262600001440000000016613042511306035317 0ustar pysdk-ciamazon00000000000000{ "Activities": [], "ResponseMetadata": { "RequestId": "67459b5a-9167-11e2-b1be-9d56e7e138d4" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-get-user-policy.json0000666454262600001440000000102413042511306031414 0ustar pysdk-ciamazon00000000000000{ "UserName": "test", "PolicyName": "test", "PolicyDocument": { "Statement": [ { "Action": [ "ec2:CreateSnapshot", "ec2:DescribeInstances", "ec2:DescribeVolumes" ], "Resource": "*", "Effect": "Allow", "Sid": "Stmt1331504410389" } ] }, "ResponseMetadata": { "RequestId": "5a2702d5-bcfd-11e2-b2db-2f18d5db5f10" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-register-image.json0000666454262600001440000000017713042511306031203 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" }, "ImageId": "ami-1a2b3c4d" }botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-modify-cluster-parameter-group.xml0000666454262600001440000000102713042511306035336 0ustar pysdk-ciamazon00000000000000 Your parameter group has been updated but changes won't get applied until you reboot the associated Clusters. parametergroup1 86e64043-40de-11e2-8a25-eb010998df4e ././@LongLink0000000000000000000000000000014600000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-purchase-reserved-node-offering.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-purchase-reserved-node-offering.xm0000666454262600001440000000174513042511306035262 0ustar pysdk-ciamazon00000000000000 2013-01-18T21:42:44.402Z Heavy Utilization 94608000 Hourly 0.21 12452.0 0.0 payment-pending dw.hs1.8xlarge 2 1ba8e2e3-dacf-48d9-841f-cc675182a8a6 fcb117cc-61b7-11e2-b6e9-87e586e4ca38 botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudformation-list-stacks.json0000666454262600001440000000017213042511306033107 0ustar pysdk-ciamazon00000000000000{ "StackSummaries": [], "ResponseMetadata": { "RequestId": "ad1ddb34-9167-11e2-a04d-8b5bb98870c1" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-list-subscriptions-by-topic.xml0000666454262600001440000000125613042511306033663 0ustar pysdk-ciamazon00000000000000 arn:aws:sns:us-east-1:123456789012:My-Topic email arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca 123456789012 example@amazon.com b9275252-3774-11df-9540-99d0768312d3 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-subnets.xml0000666454262600001440000000124413042511306031363 0ustar pysdk-ciamazon00000000000000 00759e83-6720-41e3-bb47-7f2cad470782 subnet-812910e8 available vpc-8d2910e4 10.0.0.0/24 251 us-west-2a false false botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-event-categories.json0000666454262600001440000000220413042511306033431 0ustar pysdk-ciamazon00000000000000{ "EventCategoriesMapList": [ { "EventCategories": [ "maintenance", "creation", "backup", "low storage", "configuration change", "failover", "restoration", "availability", "deletion", "notification", "recovery", "failure" ], "SourceType": "db-instance" }, { "EventCategories": [ "configuration change", "failure" ], "SourceType": "db-security-group" }, { "EventCategories": [ "configuration change" ], "SourceType": "db-parameter-group" }, { "EventCategories": [ "creation", "restoration", "deletion" ], "SourceType": "db-snapshot" } ], "ResponseMetadata": { "RequestId": "aa1184e4-9167-11e2-b6fb-e599bc501f26" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-cancel-spot-instance-requests.json0000666454262600001440000000037113042511306034156 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" }, "CancelledSpotInstanceRequests": [ { "State": "cancelled", "SpotInstanceRequestId": "sir-1a2b3c4d" } ] }botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-get-account-summary.json0000666454262600001440000000142213042511306032272 0ustar pysdk-ciamazon00000000000000{ "SummaryMap": { "AccessKeysPerUserQuota": 2, "AssumeRolePolicySizeQuota": 2048, "UsersQuota": 5000, "GroupsPerUserQuota": 10, "Users": 1, "Roles": 0, "MFADevices": 0, "InstanceProfilesQuota": 100, "AccountMFAEnabled": 0, "ServerCertificates": 0, "UserPolicySizeQuota": 2048, "RolePolicySizeQuota": 10240, "MFADevicesInUse": 0, "GroupsQuota": 100, "Groups": 0, "InstanceProfiles": 0, "GroupPolicySizeQuota": 5120, "SigningCertificatesPerUserQuota": 2, "ServerCertificatesQuota": 10, "RolesQuota": 250 }, "ResponseMetadata": { "RequestId": "a8e3b3ed-9167-11e2-8a19-1174a5b297de" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-dhcp-options.xml0000666454262600001440000000141613042511306031773 0ustar pysdk-ciamazon00000000000000 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE dopt-7a8b9c2d domain-name example.com domain-name-servers 10.2.5.1 10.2.5.2 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-attach-volume.xml0000666454262600001440000000052513042511306030674 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE vol-1a2b3c4d i-1a2b3c4d /dev/sdh attaching YYYY-MM-DDTHH:MM:SS.000Z botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-reboot-cluster.json0000666454262600001440000000235513042511306032407 0ustar pysdk-ciamazon00000000000000{ "Cluster": { "NodeType": "dw.hs1.xlarge", "Endpoint": { "Port": 5439, "Address": "examplecluster.cobaosmlqshn.us-east-1.redshift.amazonaws.com" }, "ClusterVersion": "1.0", "PubliclyAccessible": true, "MasterUsername": "adminuser", "Encrypted": false, "ClusterParameterGroups": [ { "ParameterApplyStatus": "in-sync", "ParameterGroupName": "default.redshift-1.0" } ], "ClusterSecurityGroups": [ { "Status": "active", "ClusterSecurityGroupName": "default" } ], "AllowVersionUpgrade": true, "VpcSecurityGroups": [], "AvailabilityZone": "us-east-1c", "ClusterCreateTime": "2013-01-22T19:23:59.368Z", "PreferredMaintenanceWindow": "sun:06:30-sun:07:00", "AutomatedSnapshotRetentionPeriod": 1, "ClusterStatus": "rebooting", "ClusterIdentifier": "examplecluster", "DBName": "dev", "NumberOfNodes": 2, "PendingModifiedValues": {} }, "ResponseMetadata": { "RequestId": "5edee79e-6503-11e2-9e70-918437dd236d" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-policies.xml0000666454262600001440000000045113042511306033346 0ustar pysdk-ciamazon00000000000000 675a0dbe-9167-11e2-b1be-9d56e7e138d4 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-import-instance.xml0000666454262600001440000000230113042511306031231 0ustar pysdk-ciamazon00000000000000 import-i-ffvko9js 2010-12-22T12:01Z 0 us-east-1a VMDK 1179593728 https://s3.amazonaws.com/myawsbucket/a3a5e1b6-590d-43cc-97c1-15c7325d3f41/Win_2008_Server_Data_Center_SP2_32-bit.vmdkmanifest.xml?AWSaccessKeyId=AKIAIOSFODNN7EXAMPLE%26Expires=1294855591%26Signature=5snej01T1TtL0uR7KExtEXAMPLE%3D 12 vol-1a2b3c4d active i-12655a7f 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-event-subscriptions.xml0000666454262600001440000000052013042511306034041 0ustar pysdk-ciamazon00000000000000 a9fd87af-9167-11e2-b691-fdba749921d2 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-vpn-connections.json0000666454262600001440000000066313042511306033200 0ustar pysdk-ciamazon00000000000000{"ResponseMetadata": {"RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE"}, "VpnConnections": [{"CustomerGatewayConfiguration": "Gateway Info", "CustomerGatewayId": "cgw-b4dc3961", "State": "available", "Tags": [], "Type": "ipsec.1", "VpnConnectionId": "vpn-44a8938f", "VpnGatewayId": "vgw-8db04f81"}]} botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-users.json0000666454262600001440000000115713042511306030505 0ustar pysdk-ciamazon00000000000000{ "IsTruncated": false, "ResponseMetadata": {"RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE"}, "Users": [ {"Arn": "arn:aws:iam::123456789012:user\n /division_abc/subdivision_xyz/engineering/Andrew", "Path": "/division_abc/subdivision_xyz/engineering/", "UserId": "AID2MAB8DPLSRHEXAMPLE", "UserName": "Andrew"}, {"Arn": "arn:aws:iam::123456789012:user\n /division_abc/subdivision_xyz/engineering/Jackie", "Path": "/division_abc/subdivision_xyz/engineering/", "UserId": "AIDIODR4TAW7CSEXAMPLE", "UserName": "Jackie"} ] } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-modify-snapshot-attribute.xml0000666454262600001440000000031613042511306033246 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE true botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-copy-snapshot.xml0000666454262600001440000000030713042511306030730 0ustar pysdk-ciamazon00000000000000 60bc441d-fa2c-494d-b155-5d6a3EXAMPLE snap-2a2b3c4d ././@LongLink0000000000000000000000000000014600000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-modify-cluster-parameter-group.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-modify-cluster-parameter-group.jso0000666454262600001440000000043313042511306035331 0ustar pysdk-ciamazon00000000000000{ "ParameterGroupStatus": "Your parameter group has been updated but changes won't get applied until you reboot the associated Clusters.", "ParameterGroupName": "parametergroup1", "ResponseMetadata": { "RequestId": "86e64043-40de-11e2-8a25-eb010998df4e" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/sts-get-session-token.xml0000666454262600001440000000143013042511306031635 0ustar pysdk-ciamazon00000000000000 AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/L To6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3z rkuWJOgQs8IZZaIv2BXIa2R4OlgkBN9bkUDNCJiBeb/AXlzBBko7b15fjrBs2+cTQtp Z3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY 2011-07-11T19:55:29.611Z AKIAIOSFODNN7EXAMPLE 58c5dbae-abef-11e0-8cfe-09039844ac7d botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-subscribe.json0000666454262600001440000000021713042511306030405 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "a169c740-3766-11df-8963-01868b7c937a" }, "SubscriptionArn": "pending confirmation" }././@LongLink0000000000000000000000000000015000000000000011211 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-launch-configurations.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-launch-configurations.0000666454262600001440000000053613042511306035324 0ustar pysdk-ciamazon00000000000000 67f31907-9167-11e2-9223-abe83dfc0567 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-internet-gateways.json0000666454262600001440000000077013042511306033526 0ustar pysdk-ciamazon00000000000000{ "InternetGateways": [ { "Tags": [], "InternetGatewayId": "igw-6228110b", "Attachments": [ { "State": "available", "VpcId": "vpc-8d2910e4" } ] }, { "Tags": [], "InternetGatewayId": "igw-f36c6a9a", "Attachments": [] } ], "ResponseMetadata": { "RequestId": "dbdc612b-2fa3-4ba8-b96d-3a92a7a742b2" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-list-queues.json0000666454262600001440000000040313042511306030704 0ustar pysdk-ciamazon00000000000000{ "QueueUrls": [ "https://us-west-2.queue.amazonaws.com/123456789012/foobar", "https://us-west-2.queue.amazonaws.com/123456789012/fiebaz" ], "ResponseMetadata": { "RequestId": "517c6371-751f-5711-9ebc-2ab2b1a92268" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-dhcp-options.json0000666454262600001440000000112413042511306032140 0ustar pysdk-ciamazon00000000000000{ "DhcpOptions": { "DhcpOptionsId": "dopt-7a8b9c2d", "DhcpConfigurations": [ { "Values": [ {"Value": "example.com"} ], "Key": "domain-name" }, { "Values": [ {"Value": "10.2.5.1"}, {"Value": "10.2.5.2"} ], "Key": "domain-name-servers" } ], "Tags": [] }, "ResponseMetadata": { "RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE" } } ././@LongLink0000000000000000000000000000015100000000000011212 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-launch-configurations.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-launch-configurations.0000666454262600001440000000020013042511306035310 0ustar pysdk-ciamazon00000000000000{ "LaunchConfigurations": [], "ResponseMetadata": { "RequestId": "67f31907-9167-11e2-9223-abe83dfc0567" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-publish.json0000666454262600001440000000023113042511306030066 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "f187a3c1-376f-11df-8963-01868b7c937a" }, "MessageId": "94f20ce6-13c5-43a0-9a9e-ca52d816e90b" }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-verify-domain-identity.xml0000666454262600001440000000056213042511306032645 0ustar pysdk-ciamazon00000000000000 QTKknzFg2J4ygwa+XvHAxUl1hyHoY0gVfZdfjIedHZ0= 94f6368e-9bf2-11e1-8ee7-c98a0037a2b6 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-instance-status.xml0000666454262600001440000000215213042511306033024 0ustar pysdk-ciamazon00000000000000 8be1454b-ea0f-4037-9911-b48eda6d79c8 i-78f1b94a us-west-2b 16 running ok
reachability passed
ok
reachability passed
botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-get-queue-attributes.json0000666454262600001440000000110413042511306032510 0ustar pysdk-ciamazon00000000000000{ "Attributes": { "ApproximateNumberOfMessagesNotVisible": "0", "CreatedTimestamp": "1351044153", "QueueArn": "arn:aws:sqs:us-east-1:123456789012:test1351044153", "ApproximateNumberOfMessages": "0", "DelaySeconds": "0", "VisibilityTimeout": "45", "ApproximateNumberOfMessagesDelayed": "0", "MessageRetentionPeriod": "345600", "LastModifiedTimestamp": "1351044214", "MaximumMessageSize": "65536" }, "ResponseMetadata": { "RequestId": "0c8d2786-b7b4-56e2-a823-6e80a404d6fd" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudformation-get-template.json0000666454262600001440000001354113042511306033242 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "4ca8b6a8-bc40-11e2-95ee-bd3eac9f6692" }, "TemplateBody": { "Description": "AWS CloudFormation Sample Template EC2WithEBSSample: Create an Amazon EC2 instance running the Amazon Linux AMI with a new EBS volume attached. The instance and the volume are pinned to the same availability zone. We recommend that you do untargeted launches rather than pinning instances this way.The AMI is chosen based on the region in which the stack is run. **WARNING** This template creates an Amazon EC2 instance and an EBS Volume. You will be billed for the AWS resources used if you create a stack from this template.", "Parameters": { "SSHLocation": { "ConstraintDescription": "must be a valid IP CIDR range of the form x.x.x.x/x.", "Description": "The IP address range that can be used to SSH to the EC2 instances", "Default": "0.0.0.0/0", "MinLength": "9", "AllowedPattern": "(\\d{1,3})\\.(\\d{1,3})\\.(\\d{1,3})\\.(\\d{1,3})/(\\d{1,2})", "MaxLength": "18", "Type": "String" }, "KeyName": { "Type": "String", "Description": "Name of an existing EC2 KeyPair to enable SSH access to the instance" } }, "AWSTemplateFormatVersion": "2010-09-09", "Outputs": { "InstanceId": { "Description": "InstanceId of the newly created EC2 instance", "Value": { "Ref": "Ec2Instance" } }, "PublicIP": { "Description": "Public IP address of the newly created EC2 instance", "Value": { "Fn::GetAtt": [ "Ec2Instance", "PublicIp" ] } }, "PublicDNS": { "Description": "Public DNSName of the newly created EC2 instance", "Value": { "Fn::GetAtt": [ "Ec2Instance", "PublicDnsName" ] } } }, "Resources": { "InstanceSecurityGroup": { "Type": "AWS::EC2::SecurityGroup", "Properties": { "SecurityGroupIngress": [ { "ToPort": "22", "IpProtocol": "tcp", "CidrIp": { "Ref": "SSHLocation" }, "FromPort": "22" } ], "GroupDescription": "Enable SSH access via port 22" } }, "Ec2Instance": { "Type": "AWS::EC2::Instance", "Properties": { "KeyName": { "Ref": "KeyName" }, "AvailabilityZone": { "Fn::FindInMap": [ "RegionMap", { "Ref": "AWS::Region" }, "TestAz" ] }, "SecurityGroups": [ { "Ref": "InstanceSecurityGroup" } ], "Volumes": [ { "Device": "/dev/sdk", "VolumeId": { "Ref": "NewVolume" } } ], "ImageId": { "Fn::FindInMap": [ "RegionMap", { "Ref": "AWS::Region" }, "AMI" ] } } }, "NewVolume": { "Type": "AWS::EC2::Volume", "Properties": { "AvailabilityZone": { "Fn::FindInMap": [ "RegionMap", { "Ref": "AWS::Region" }, "TestAz" ] }, "Size": "100" } } }, "Mappings": { "RegionMap": { "us-east-1": { "AMI": "ami-7f418316", "TestAz": "us-east-1a" }, "ap-northeast-1": { "AMI": "ami-dcfa4edd", "TestAz": "ap-northeast-1a" }, "sa-east-1": { "AMI": "ami-3e3be423", "TestAz": "sa-east-1a" }, "ap-southeast-1": { "AMI": "ami-74dda626", "TestAz": "ap-southeast-1a" }, "ap-southeast-2": { "AMI": "ami-b3990e89", "TestAz": "ap-southeast-2a" }, "us-west-2": { "AMI": "ami-16fd7026", "TestAz": "us-west-2a" }, "us-west-1": { "AMI": "ami-951945d0", "TestAz": "us-west-1a" }, "eu-west-1": { "AMI": "ami-24506250", "TestAz": "eu-west-1a" } } } } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-security-groups.xml0000666454262600001440000001376013042511306033072 0ustar pysdk-ciamazon00000000000000 4296401f-8b78-4f99-b1fb-71def4fc3701 123456789012 sg-68d8a958 quicklaunch-0 quicklaunch-0 tcp 22 22 0.0.0.0/0 123456789012 sg-72334242 quicklaunch-1 quicklaunch-1 tcp 3389 3389 0.0.0.0/0 123456789012 sg-4e970e7e notebook For iPython notebook. tcp 22 22 0.0.0.0/0 tcp 443 443 0.0.0.0/0 tcp 8888 8888 0.0.0.0/0 123456789012 sg-eab831da default default group tcp 0 65535 123456789012 sg-eab831da default udp 0 65535 123456789012 sg-eab831da default icmp -1 -1 123456789012 sg-eab831da default 123456789012 sg-97b1aefb default default VPC security group vpc-8d2910e4 -1 123456789012 sg-97b1aefb -1 0.0.0.0/0 botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-create-topic.xml0000666454262600001440000000052013042511306030627 0ustar pysdk-ciamazon00000000000000 arn:aws:sns:us-east-1:123456789012:My-Topic a8dec8b3-33a4-11df-8963-01868b7c937a botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-get-bucket-acl.json0000666454262600001440000000076713042511306030747 0ustar pysdk-ciamazon00000000000000{ "Owner": { "DisplayName": "CustomersName@amazon.com", "ID": "75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a" }, "Grants": [ { "Grantee": { "DisplayName": "CustomersName@amazon.com", "ID": "75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a", "Type": "CanonicalUser" }, "Permission": "FULL_CONTROL" } ], "ResponseMetadata": {} } botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-create-cluster.json0000666454262600001440000000204713042511306032356 0ustar pysdk-ciamazon00000000000000{ "Cluster": { "NodeType": "dw.hs1.xlarge", "ClusterVersion": "1.0", "PubliclyAccessible": true, "MasterUsername": "masteruser", "Encrypted": false, "ClusterParameterGroups": [ { "ParameterApplyStatus": "in-sync", "ParameterGroupName": "default.redshift-1.0" } ], "ClusterSecurityGroups": [ { "Status": "active", "ClusterSecurityGroupName": "default" } ], "AllowVersionUpgrade": true, "VpcSecurityGroups": [], "PreferredMaintenanceWindow": "sun:10:30-sun:11:00", "AutomatedSnapshotRetentionPeriod": 1, "ClusterStatus": "creating", "ClusterIdentifier": "examplecluster", "DBName": "dev", "NumberOfNodes": 2, "PendingModifiedValues": { "MasterUserPassword": "****" } }, "ResponseMetadata": { "RequestId": "e69b1294-64ef-11e2-b07c-f7fbdd006c67" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-stop-instances.json0000666454262600001440000000063113042511306031244 0ustar pysdk-ciamazon00000000000000{ "StoppingInstances": [ { "InstanceId": "i-10a64379", "CurrentState": { "Code": 64, "Name": "stopping" }, "PreviousState": { "Code": 16, "Name": "running" } } ], "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-detach-volume.json0000666454262600001440000000040613042511306031027 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" }, "AttachTime": "YYYY-MM-DDTHH:MM:SS.000Z", "InstanceId": "i-1a2b3c4d", "VolumeId": "vol-1a2b3c4d", "State": "detaching", "Device": "/dev/sdh" }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-volumes.xml0000666454262600001440000000346613042511306031402 0ustar pysdk-ciamazon00000000000000 93f17066-e6f7-4fc2-8308-2c49c99ab86b vol-bc71579a 8 snap-2723f74f us-west-2a in-use 2012-10-16T20:00:16.000Z vol-bc71579a i-fde9cece /dev/sda1 attached 2012-10-16T20:00:21.000Z true standard vol-a8d2e991 30 snap-3d367c04 us-west-2b in-use 2013-03-09T16:43:57.000Z vol-a8d2e991 i-78f1b94a /dev/sda1 attached 2013-03-09T16:44:07.000Z true standard botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-key-pair.xml0000666454262600001440000000236113042511306031105 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE gsg-keypair 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00 ---- BEGIN RSA PRIVATE KEY ---- MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= -----END RSA PRIVATE KEY----- botocore-1.5.7/tests/unit/response_parsing/xml/responses/elb-describe-load-balancer-policies.json0000666454262600001440000004257413042511306034446 0ustar pysdk-ciamazon00000000000000{ "PolicyDescriptions": [ { "PolicyAttributeDescriptions": [ { "AttributeName": "Protocol-SSLv2", "AttributeValue": "false" }, { "AttributeName": "ADH-AES256-SHA", "AttributeValue": "false" }, { "AttributeName": "DHE-RSA-AES256-SHA", "AttributeValue": "true" }, { "AttributeName": "DHE-DSS-AES256-SHA", "AttributeValue": "true" }, { "AttributeName": "AES256-SHA", "AttributeValue": "true" }, { "AttributeName": "KRB5-DES-CBC3-MD5", "AttributeValue": "true" }, { "AttributeName": "KRB5-DES-CBC3-SHA", "AttributeValue": "true" }, { "AttributeName": "ADH-DES-CBC3-SHA", "AttributeValue": "false" }, { "AttributeName": "EDH-RSA-DES-CBC3-SHA", "AttributeValue": "true" }, { "AttributeName": "EDH-DSS-DES-CBC3-SHA", "AttributeValue": "true" }, { "AttributeName": "DES-CBC3-SHA", "AttributeValue": "true" }, { "AttributeName": "DES-CBC3-MD5", "AttributeValue": "false" }, { "AttributeName": "ADH-AES128-SHA", "AttributeValue": "false" }, { "AttributeName": "DHE-RSA-AES128-SHA", "AttributeValue": "true" }, { "AttributeName": "DHE-DSS-AES128-SHA", "AttributeValue": "true" }, { "AttributeName": "AES128-SHA", "AttributeValue": "true" }, { "AttributeName": "KRB5-RC4-MD5", "AttributeValue": "true" }, { "AttributeName": "KRB5-RC4-SHA", "AttributeValue": "true" }, { "AttributeName": "ADH-RC4-MD5", "AttributeValue": "false" }, { "AttributeName": "RC4-SHA", "AttributeValue": "true" }, { "AttributeName": "RC4-MD5", "AttributeValue": "true" }, { "AttributeName": "RC2-CBC-MD5", "AttributeValue": "false" }, { "AttributeName": "KRB5-DES-CBC-MD5", "AttributeValue": "true" }, { "AttributeName": "KRB5-DES-CBC-SHA", "AttributeValue": "true" }, { "AttributeName": "ADH-DES-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "EDH-RSA-DES-CBC-SHA", "AttributeValue": "true" }, { "AttributeName": "EDH-DSS-DES-CBC-SHA", "AttributeValue": "true" }, { "AttributeName": "DES-CBC-SHA", "AttributeValue": "true" }, { "AttributeName": "DES-CBC-MD5", "AttributeValue": "false" }, { "AttributeName": "EXP-KRB5-RC4-MD5", "AttributeValue": "true" }, { "AttributeName": "EXP-KRB5-RC2-CBC-MD5", "AttributeValue": "true" }, { "AttributeName": "EXP-KRB5-DES-CBC-MD5", "AttributeValue": "true" }, { "AttributeName": "EXP-KRB5-RC4-SHA", "AttributeValue": "true" }, { "AttributeName": "EXP-KRB5-RC2-CBC-SHA", "AttributeValue": "true" }, { "AttributeName": "EXP-KRB5-DES-CBC-SHA", "AttributeValue": "true" }, { "AttributeName": "EXP-ADH-DES-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "EXP-ADH-RC4-MD5", "AttributeValue": "false" }, { "AttributeName": "EXP-EDH-RSA-DES-CBC-SHA", "AttributeValue": "true" }, { "AttributeName": "EXP-EDH-DSS-DES-CBC-SHA", "AttributeValue": "true" }, { "AttributeName": "EXP-DES-CBC-SHA", "AttributeValue": "true" }, { "AttributeName": "EXP-RC2-CBC-MD5", "AttributeValue": "true" }, { "AttributeName": "EXP-RC4-MD5", "AttributeValue": "true" }, { "AttributeName": "DHE-RSA-CAMELLIA256-SHA", "AttributeValue": "true" }, { "AttributeName": "DHE-DSS-CAMELLIA256-SHA", "AttributeValue": "true" }, { "AttributeName": "ADH-CAMELLIA256-SHA", "AttributeValue": "false" }, { "AttributeName": "CAMELLIA256-SHA", "AttributeValue": "true" }, { "AttributeName": "PSK-AES256-CBC-SHA", "AttributeValue": "true" }, { "AttributeName": "PSK-3DES-EDE-CBC-SHA", "AttributeValue": "true" }, { "AttributeName": "DHE-RSA-SEED-SHA", "AttributeValue": "true" }, { "AttributeName": "DHE-DSS-SEED-SHA", "AttributeValue": "true" }, { "AttributeName": "DHE-RSA-CAMELLIA128-SHA", "AttributeValue": "true" }, { "AttributeName": "DHE-DSS-CAMELLIA128-SHA", "AttributeValue": "true" }, { "AttributeName": "ADH-SEED-SHA", "AttributeValue": "false" }, { "AttributeName": "ADH-CAMELLIA128-SHA", "AttributeValue": "false" }, { "AttributeName": "SEED-SHA", "AttributeValue": "true" }, { "AttributeName": "CAMELLIA128-SHA", "AttributeValue": "true" }, { "AttributeName": "PSK-AES128-CBC-SHA", "AttributeValue": "true" }, { "AttributeName": "PSK-RC4-SHA", "AttributeValue": "true" }, { "AttributeName": "Protocol-TLSv1", "AttributeValue": "true" }, { "AttributeName": "IDEA-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "Protocol-SSLv3", "AttributeValue": "true" } ], "PolicyName": "ELBSample-OpenSSLDefaultCipherPolicy", "PolicyTypeName": "SSLNegotiationPolicyType" }, { "PolicyAttributeDescriptions": [ { "AttributeName": "Protocol-SSLv2", "AttributeValue": "false" }, { "AttributeName": "EDH-DSS-DES-CBC3-SHA", "AttributeValue": "false" }, { "AttributeName": "DHE-RSA-CAMELLIA128-SHA", "AttributeValue": "false" }, { "AttributeName": "DES-CBC-MD5", "AttributeValue": "false" }, { "AttributeName": "KRB5-RC4-SHA", "AttributeValue": "false" }, { "AttributeName": "ADH-CAMELLIA128-SHA", "AttributeValue": "false" }, { "AttributeName": "EXP-KRB5-RC4-MD5", "AttributeValue": "false" }, { "AttributeName": "ADH-RC4-MD5", "AttributeValue": "false" }, { "AttributeName": "PSK-RC4-SHA", "AttributeValue": "false" }, { "AttributeName": "PSK-AES128-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "EXP-EDH-RSA-DES-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "CAMELLIA128-SHA", "AttributeValue": "false" }, { "AttributeName": "DHE-DSS-AES128-SHA", "AttributeValue": "false" }, { "AttributeName": "EDH-RSA-DES-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "DHE-RSA-SEED-SHA", "AttributeValue": "false" }, { "AttributeName": "KRB5-DES-CBC-MD5", "AttributeValue": "false" }, { "AttributeName": "DHE-RSA-CAMELLIA256-SHA", "AttributeValue": "false" }, { "AttributeName": "ADH-DES-CBC3-SHA", "AttributeValue": "false" }, { "AttributeName": "DES-CBC3-MD5", "AttributeValue": "false" }, { "AttributeName": "EXP-KRB5-RC2-CBC-MD5", "AttributeValue": "false" }, { "AttributeName": "EDH-DSS-DES-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "KRB5-DES-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "PSK-AES256-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "ADH-AES256-SHA", "AttributeValue": "false" }, { "AttributeName": "KRB5-DES-CBC3-SHA", "AttributeValue": "false" }, { "AttributeName": "AES128-SHA", "AttributeValue": "true" }, { "AttributeName": "DHE-DSS-SEED-SHA", "AttributeValue": "false" }, { "AttributeName": "ADH-CAMELLIA256-SHA", "AttributeValue": "false" }, { "AttributeName": "EXP-KRB5-RC4-SHA", "AttributeValue": "false" }, { "AttributeName": "EDH-RSA-DES-CBC3-SHA", "AttributeValue": "false" }, { "AttributeName": "EXP-KRB5-DES-CBC-MD5", "AttributeValue": "false" }, { "AttributeName": "Protocol-TLSv1", "AttributeValue": "true" }, { "AttributeName": "PSK-3DES-EDE-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "SEED-SHA", "AttributeValue": "false" }, { "AttributeName": "DHE-DSS-CAMELLIA256-SHA", "AttributeValue": "false" }, { "AttributeName": "IDEA-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "RC2-CBC-MD5", "AttributeValue": "false" }, { "AttributeName": "KRB5-RC4-MD5", "AttributeValue": "false" }, { "AttributeName": "ADH-AES128-SHA", "AttributeValue": "false" }, { "AttributeName": "RC4-SHA", "AttributeValue": "true" }, { "AttributeName": "AES256-SHA", "AttributeValue": "true" }, { "AttributeName": "Protocol-SSLv3", "AttributeValue": "true" }, { "AttributeName": "EXP-DES-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "DES-CBC3-SHA", "AttributeValue": "true" }, { "AttributeName": "DHE-RSA-AES128-SHA", "AttributeValue": "false" }, { "AttributeName": "EXP-EDH-DSS-DES-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "EXP-KRB5-RC2-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "DHE-RSA-AES256-SHA", "AttributeValue": "false" }, { "AttributeName": "KRB5-DES-CBC3-MD5", "AttributeValue": "false" }, { "AttributeName": "RC4-MD5", "AttributeValue": "true" }, { "AttributeName": "EXP-RC2-CBC-MD5", "AttributeValue": "false" }, { "AttributeName": "DES-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "EXP-ADH-RC4-MD5", "AttributeValue": "false" }, { "AttributeName": "EXP-RC4-MD5", "AttributeValue": "false" }, { "AttributeName": "ADH-DES-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "CAMELLIA256-SHA", "AttributeValue": "false" }, { "AttributeName": "DHE-DSS-CAMELLIA128-SHA", "AttributeValue": "false" }, { "AttributeName": "EXP-KRB5-DES-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "EXP-ADH-DES-CBC-SHA", "AttributeValue": "false" }, { "AttributeName": "DHE-DSS-AES256-SHA", "AttributeValue": "false" }, { "AttributeName": "ADH-SEED-SHA", "AttributeValue": "false" } ], "PolicyName": "ELBSample-ELBDefaultCipherPolicy", "PolicyTypeName": "SSLNegotiationPolicyType" } ], "ResponseMetadata": { "RequestId": "ab663f4e-9167-11e2-ab97-3b4060f1aeb3" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-unmonitor-instances.xml0000666454262600001440000000100213042511306032131 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-43a4412a disabled i-23a3397d disabled botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-groups.json0000666454262600001440000000137013042511306030660 0ustar pysdk-ciamazon00000000000000{"Groups": [ {"Arn": "arn:aws:iam::123456789012:group/Admins", "GroupId": "AGPACKCEVSQ6C2EXAMPLE", "GroupName": "Admins", "Path": "/division_abc/subdivision_xyz/"}, {"Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test", "GroupId": "AGP2MAB8DPLSRHEXAMPLE", "GroupName": "Test", "Path": "/division_abc/subdivision_xyz/product_1234/engineering/"}, {"Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers", "GroupId": "AGPIODR4TAW7CSEXAMPLE", "GroupName": "Managers", "Path": "/division_abc/subdivision_xyz/product_1234/"}], "IsTruncated": false, "ResponseMetadata": {"RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE"} } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-internet-gateways.xml0000666454262600001440000000133513042511306033353 0ustar pysdk-ciamazon00000000000000 dbdc612b-2fa3-4ba8-b96d-3a92a7a742b2 igw-6228110b vpc-8d2910e4 available igw-f36c6a9a botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-request-spot-instances.json0000666454262600001440000000160313042511306032732 0ustar pysdk-ciamazon00000000000000{ "SpotInstanceRequests": [ { "ProductDescription": "Linux/UNIX", "SpotInstanceRequestId": "sir-1a2b3c4d", "State": "open", "AvailabilityZoneGroup": "MyAzGroup", "LaunchSpecification": { "EbsOptimized": false, "BlockDeviceMappings": [], "Monitoring": {"Enabled": false}, "SecurityGroups": [ { "GroupName": "", "GroupId": "" } ], "InstanceType": "m1.small", "ImageId": "ami-1a2b3c4d" }, "Type": "one-time", "CreateTime": "YYYY-MM-DDTHH:MM:SS.000Z", "SpotPrice": "0.5" } ], "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-environments.xml0000666454262600001440000000204513042511306035267 0ustar pysdk-ciamazon00000000000000 Version1 Available SampleApp elasticbeanstalk-SampleApp-1394386994.us-east-1.elb.amazonaws.com SampleApp-jxb293wg7n.elasticbeanstalk.amazonaws.com Green e-icsgecu3wf 2010-11-17T04:01:40.668Z 32bit Amazon Linux running Tomcat 7 EnvDescrip SampleApp 2010-11-17T03:59:33.520Z 44790c68-f260-11df-8a78-9f77047e0d0c botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudformation-list-stacks.xml0000666454262600001440000000042313042511306032735 0ustar pysdk-ciamazon00000000000000 ad1ddb34-9167-11e2-a04d-8b5bb98870c1 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-allocate-address.xml0000666454262600001440000000042413042511306031330 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE 198.51.100.1 vpc eipalloc-5723d13e botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-associate-address.xml0000666454262600001440000000036413042511306031522 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE true eipassoc-fc5ca095 botocore-1.5.7/tests/unit/response_parsing/xml/responses/importexport-list-jobs.xml0000666454262600001440000000125413042511306032134 0ustar pysdk-ciamazon00000000000000 Import 2010-04-21T22:21:51Z false ADP7B Import 2010-04-21T22:19:05Z false AVEYF true cc6ea8c0-4da9-11df-81c3-e94d3ca214a8 botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-db-instances.xml0000666454262600001440000000423113042511306032370 0ustar pysdk-ciamazon00000000000000 2011-05-23T06:50:00Z mysql 1 false general-public-license available 5.1.50 3306
simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com
 simcoprod01 in-sync default.mysql5.1 active default 00:00-00:30 true sat:07:30-sat:08:00 us-east-1a 2011-05-23T06:06:43.110Z 10 default.mysql5.1 in-sync db.m1.large master 9135fff3-8509-11e0-bd9b-a7b1ece36d51 botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-delete-cluster-snapshot.json0000666454262600001440000000117013042511306034206 0ustar pysdk-ciamazon00000000000000{ "Snapshot": { "Status": "deleted", "SnapshotCreateTime": "2012-12-07T23:31:02.372Z", "AvailabilityZone": "us-east-1a", "ClusterVersion": "1.0", "MasterUsername": "masteruser", "DBName": "mydb", "ClusterCreateTime": "2012-12-06T23:09:01.475Z", "SnapshotType": "manual", "NodeType": "dw.hs1.xlarge", "ClusterIdentifier": "examplecluster", "Port": 5439, "NumberOfNodes": 3, "SnapshotIdentifier": "snapshot-1234" }, "ResponseMetadata": { "RequestId": "88a31de4-40d1-11e2-8a25-eb010998df4e" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-placement-groups.xml0000666454262600001440000000063613042511306033171 0ustar pysdk-ciamazon00000000000000 d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE Project-cluster cluster available botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-network-interface.xml0000666454262600001440000000325013042511306033011 0ustar pysdk-ciamazon00000000000000 bd78c839-0895-4fac-a17f-98b559b6b630 eni-1bcb7772 subnet-a61dafcf vpc-c31dafaa ap-southeast-1b 251839141158 false pending 02:74:b0:70:7f:1a 10.0.2.140 true sg-1a2b3c4d default 10.0.2.140 true 10.0.2.172 false 10.0.2.169 false 10.0.2.170 false 10.0.2.171 false botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-run-instances.xml0000666454262600001440000000613413042511306030716 0ustar pysdk-ciamazon00000000000000 e86ff3c8-2400-45e3-a4e7-f158a69283d4 r-157ad274 111122223333 i-0ee0356c ami-31814f58 0 pending 0 m1.small 2011-12-20T08:29:31.000Z us-east-1b default aki-805ea7e9 disabled subnet-b2a249da vpc-1ea24976 10.0.0.142 true sg-050c1369 default pending pending i386 ebs /dev/sda1 paravirtual xen eni-c6bb50ae subnet-b2a249da vpc-1ea24976 111122223333 in-use 10.0.0.142 true sg-050c1369 default eni-attach-0326646a 0 attaching 2011-12-20T08:29:31.000Z true botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-network-acl.json0000666454262600001440000000134513042511306031764 0ustar pysdk-ciamazon00000000000000{ "NetworkAcl": { "Associations": [], "NetworkAclId": "acl-5fb85d36", "VpcId": "vpc-11ad4878", "Tags": [], "Entries": [ { "CidrBlock": "0.0.0.0/0", "RuleNumber": 32767, "Protocol": "all", "Egress": true, "RuleAction": "deny" }, { "CidrBlock": "0.0.0.0/0", "RuleNumber": 32767, "Protocol": "all", "Egress": false, "RuleAction": "deny" } ], "IsDefault": false }, "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-list-distributions.xml0000666454262600001440000001012513042511306033501 0ustar pysdk-ciamazon00000000000000 RMPARXS293KSTG7 EMLARXS9EXAMPLE 2 true 1 EDFDVBD6EXAMPLE Deployed 2012-05-19T19:37:58Z d111111abcdef8.cloudfront.net 1 www.example.com 2 example-Amazon S3-origin myawsbucket.s3.amazonaws.com origin-access-identity/cloudfront/E74FTE3AEXAMPLE example-custom-origin example.com 80 443 match-viewer example-Amazon S3-origin true whitelist 1 example-cookie true 3 self 111122223333 444455556666 https-only 0 1 *.jpg example-custom-origin false all true 2 self 111122223333 allow-all 86400 example comment true true myawslogbucket.s3.amazonaws.com example.com. AS1A2M3P4L5E67SIIXR3J PriceClass_All true ././@LongLink0000000000000000000000000000015300000000000011214 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-metric-collection-types.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-metric-collection-type0000666454262600001440000000074513042511306035341 0ustar pysdk-ciamazon00000000000000{ "Metrics": [ {"Metric": "GroupMinSize"}, {"Metric": "GroupMaxSize"}, {"Metric": "GroupDesiredCapacity"}, {"Metric": "GroupInServiceInstances"}, {"Metric": "GroupPendingInstances"}, {"Metric": "GroupTerminatingInstances"}, {"Metric": "GroupTotalInstances"} ], "Granularities": [ { "Granularity": "1Minute" } ], "ResponseMetadata": { "RequestId": "6794a54b-9167-11e2-9223-abe83dfc0567" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-assign-private-ip-addresses.xml0000666454262600001440000000030013042511306033427 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE true botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-db-instances.json0000666454262600001440000000324713042511306032547 0ustar pysdk-ciamazon00000000000000{ "DBInstances": [ { "Endpoint": { "Port": 3306, "Address": "simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com" }, "OptionGroupMemberships": [ { "Status": "in-sync", "OptionGroupName": "default.mysql5.1" } ], "DBInstanceStatus": "available", "MasterUsername": "master", "LicenseModel": "general-public-license", "LatestRestorableTime": "2011-05-23T06:50:00Z", "InstanceCreateTime": "2011-05-23T06:06:43.110Z", "EngineVersion": "5.1.50", "BackupRetentionPeriod": 1, "PendingModifiedValues": {}, "Engine": "mysql", "MultiAZ": false, "AvailabilityZone": "us-east-1a", "DBSecurityGroups": [ { "Status": "active", "DBSecurityGroupName": "default" } ], "DBParameterGroups": [ { "DBParameterGroupName": "default.mysql5.1", "ParameterApplyStatus": "in-sync" } ], "AutoMinorVersionUpgrade": true, "PreferredBackupWindow": "00:00-00:30", "DBInstanceIdentifier": "simcoprod01", "AllocatedStorage": 10, "DBInstanceClass": "db.m1.large", "PreferredMaintenanceWindow": "sat:07:30-sat:08:00", "ReadReplicaDBInstanceIdentifiers": [] } ], "ResponseMetadata": { "RequestId": "9135fff3-8509-11e0-bd9b-a7b1ece36d51" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-replace-network-acl-association.json0000666454262600001440000000021513042511306034441 0ustar pysdk-ciamazon00000000000000{ "NewAssociationId": "aclassoc-17b85d7e", "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-receive-message.json0000666454262600001440000000143513042511306031476 0ustar pysdk-ciamazon00000000000000{ "Messages": [ { "Body": "This is a test message", "Attributes": { "ApproximateFirstReceiveTimestamp": "1250700979248", "SenderId": "195004372649", "ApproximateReceiveCount": "5", "SentTimestamp": "1238099229000" }, "ReceiptHandle": "MbZj6wDWli+JvwwJaBV+3dcjk2YW2vA3+STFFljTM8tJJg6HRG6PYSasuWXPJB+Cw\n Lj1FjgXUv1uSj1gUPAWV66FU/WeR4mq2OKpEGYWbnLmpRCJVAyeMjeU5ZBdtcQ+QE\n auMZc8ZRv37sIW2iJKq3M9MFx1YvV11A2x/KSbkJ0=", "MD5OfBody": "fafb00f5732ab283681e124bf8747ed1", "MessageId": "5fea7756-0ea4-451a-a703-a558b933e274" } ], "ResponseMetadata": { "RequestId": "b6633655-283d-45b4-aee4-4e84e0ae6afa" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-key-pairs.json0000666454262600001440000000036413042511306031757 0ustar pysdk-ciamazon00000000000000{ "KeyPairs": [ { "KeyName": "aws", "KeyFingerprint": "d1:15:f0:ce:7f:ee:94:b5:f2:76:d0:9a:bd:b2:30:18" } ], "ResponseMetadata": { "RequestId": "f01984fe-0227-46e0-bd34-86fadf256477" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-copy-cluster-snapshot.xml0000666454262600001440000000164313042511306033552 0ustar pysdk-ciamazon00000000000000 5439 my-snapshot-456 available manual 1.0 2013-01-22T19:27:58.931Z 2 dev 2013-01-22T19:23:59.368Z us-east-1c dw.hs1.xlarge examplecluster adminuser aebb56f5-64fe-11e2-88c5-53eb05787dfb botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-scheduled-actions.json0000666454262600001440000000020713042511306035305 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "68de155d-9167-11e2-9223-abe83dfc0567" }, "ScheduledUpdateGroupActions": [] }botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-clusters.xml0000666454262600001440000000323013042511306032700 0ustar pysdk-ciamazon00000000000000 **** 1.0 creating 2 1 true false dev sun:10:30-sun:11:00 in-sync default.redshift-1.0 active default us-east-1a dw.hs1.xlarge examplecluster true masteruser 837d45d6-64f0-11e2-b07c-f7fbdd006c67 botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-get-bucket-policy.json0000666454262600001440000000034413042511306031476 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": {}, "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"AddPerm\",\"Effect\":\"Allow\",\"Principal\":\"*\",\"Action\":\"s3:GetObject\",\"Resource\":\"arn:aws:s3:::bucket-name/*\"}]}" } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-customer-gateways.json0000666454262600001440000000054213042511306033534 0ustar pysdk-ciamazon00000000000000{"CustomerGateways": [{"BgpAsn": "65534", "CustomerGatewayId": "cgw-b4dc3961", "IpAddress": "12.1.2.3", "State": "available", "Tags": [], "Type": "ipsec.1"}], "ResponseMetadata": {"RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE"}} ././@LongLink0000000000000000000000000000015000000000000011211 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-reserved-instances-offerings.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-reserved-instances-offerings.j0000666454262600001440000000311313042511306035112 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "404d7db3-3ec5-4400-8d72-74b1553f176e" }, "NextToken": "JqBdtVdGsvMjUysyEgwy/jVBCGAjj9G4/ivkfsXHt9A=", "ReservedInstancesOfferings": [ { "OfferingType": "Heavy Utilization", "AvailabilityZone": "us-west-2c", "InstanceTenancy": "default", "PricingDetails": [], "ProductDescription": "Linux/UNIX (Amazon VPC)", "UsagePrice": 0.0, "RecurringCharges": [ { "Amount": 0.031, "Frequency": "Hourly" } ], "Marketplace": false, "CurrencyCode": "USD", "FixedPrice": 701.0, "Duration": 94608000, "ReservedInstancesOfferingId": "2628c27b-7c1c-4ad6-9f50-a09393f36ecf", "InstanceType": "c1.medium" }, { "OfferingType": "Heavy Utilization", "AvailabilityZone": "us-west-2c", "InstanceTenancy": "default", "PricingDetails": [], "ProductDescription": "Red Hat Enterprise Linux", "UsagePrice": 0.0, "RecurringCharges": [ { "Amount": 0.091, "Frequency": "Hourly" } ], "Marketplace": false, "CurrencyCode": "USD", "FixedPrice": 701.0, "Duration": 94608000, "ReservedInstancesOfferingId": "371f1882-2df3-43b0-8f62-f73956fcfabc", "InstanceType": "c1.medium" } ] } botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-get-topic-attributes.json0000666454262600001440000000147713042511306032514 0ustar pysdk-ciamazon00000000000000{ "Attributes": { "Owner": "123456789012", "Policy": "{\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:*\"}}}]}", "TopicArn": "arn:aws:sns:us-east-1:123456789012:My-Topic" }, "ResponseMetadata": { "RequestId": "057f074c-33a7-11df-9540-99d0768312d3" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-snapshots.json0000666454262600001440000000247513042511306034720 0ustar pysdk-ciamazon00000000000000{"ResponseMetadata": {"RequestId": "56a9daf4-64fa-11e2-a8da-655adc216806"}, "Snapshots": [{"AvailabilityZone": "us-east-1c", "ClusterCreateTime": "2013-01-22T19:23:59.368Z", "ClusterIdentifier": "examplecluster", "ClusterVersion": "1.0", "DBName": "dev", "MasterUsername": "adminuser", "NodeType": "dw.hs1.xlarge", "NumberOfNodes": 2, "Port": 5439, "SnapshotCreateTime": "2013-01-22T19:27:58.931Z", "SnapshotIdentifier": "cm:examplecluster-2013-01-22-19-27-58", "SnapshotType": "automated", "Status": "available"}, {"AvailabilityZone": "us-east-1c", "ClusterCreateTime": "2013-01-22T19:23:59.368Z", "ClusterIdentifier": "examplecluster", "ClusterVersion": "1.0", "DBName": "dev", "MasterUsername": "adminuser", "NodeType": "dw.hs1.xlarge", "NumberOfNodes": 2, "Port": 5439, "SnapshotCreateTime": "2013-01-23T01:09:03.149Z", "SnapshotIdentifier": "my-snapshot-123", "SnapshotType": "manual", "Status": "available"}]} ././@LongLink0000000000000000000000000000014600000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-delete-cluster-parameter-group.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-delete-cluster-parameter-group.jso0000666454262600001440000000013713042511306035305 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "29674ca0-40da-11e2-b679-dba6cf515770" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-applications.xml0000666454262600001440000000132313042511306035224 0ustar pysdk-ciamazon00000000000000 Sample Description SampleApplication 2010-11-16T20:20:51.974Z 2010-11-16T20:20:51.974Z Default 577c70ff-f1d7-11df-8a78-9f77047e0d0c ././@LongLink0000000000000000000000000000016300000000000011215 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-notification-types.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-notificat0000666454262600001440000000056713042511306035314 0ustar pysdk-ciamazon00000000000000{ "AutoScalingNotificationTypes": [ "autoscaling:EC2_INSTANCE_LAUNCH", "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", "autoscaling:EC2_INSTANCE_TERMINATE", "autoscaling:EC2_INSTANCE_TERMINATE_ERROR", "autoscaling:TEST_NOTIFICATION" ], "ResponseMetadata": { "RequestId": "68cc13f5-9167-11e2-9863-c1fc2ead119c" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-cancel-reserved-instances-listing.json0000666454262600001440000000404113042511306034767 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "bec2cf62-98ef-434a-8a15-886fcexample" }, "ReservedInstancesListings": [ { "ReservedInstancesId": "af9f760e-9b3f-417a-ad5e-93f0cexample", "Status": "cancelled", "Tags": [], "PriceSchedules": [ { "Active": false, "Term": 5, "CurrencyCode": "USD", "Price": 166.64 }, { "Active": false, "Term": 4, "CurrencyCode": "USD", "Price": 133.32 }, { "Active": false, "Term": 3, "CurrencyCode": "USD", "Price": 99.99 }, { "Active": false, "Term": 2, "CurrencyCode": "USD", "Price": 66.66 }, { "Active": false, "Term": 1, "CurrencyCode": "USD", "Price": 33.33 } ], "CreateDate": "2012-07-12T16:55:28.000Z", "ClientToken": "XqJIt1342112125076", "ReservedInstancesListingId": "3ebe97b5-f273-43b6-a204-7a18cexample", "UpdateDate": "2012-07-12T16:55:28.000Z", "InstanceCounts": [ { "State": "Available", "InstanceCount": 0 }, { "State": "Sold", "InstanceCount": 0 }, { "State": "Cancelled", "InstanceCount": 1 }, { "State": "Pending", "InstanceCount": 0 } ], "StatusMessage": "CANCELLED" } ] }././@LongLink0000000000000000000000000000015000000000000011211 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-scaling-process-types.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-scaling-process-types.0000666454262600001440000000173613042511306035263 0ustar pysdk-ciamazon00000000000000 AZRebalance AddToLoadBalancer AlarmNotification HealthCheck Launch ReplaceUnhealthy ScheduledActions Terminate 67705466-9167-11e2-9223-abe83dfc0567 botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-versions.xml0000666454262600001440000000110013042511306034355 0ustar pysdk-ciamazon00000000000000 redshift-1.0 release db engine 1.0.54 1.0 6641e675-9167-11e2-a970-49138ad38474 botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-change-message-visibility-batch.json0000666454262600001440000000037613042511306034550 0ustar pysdk-ciamazon00000000000000{ "Successful": [ { "Id": "change_visibility_msg_2" }, { "Id": "change_visibility_msg_3" } ], "ResponseMetadata": { "RequestId": "ca9668f7-ab1b-4f7a-8859-f15747ab17a7" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-subnets.json0000666454262600001440000000070513042511306031535 0ustar pysdk-ciamazon00000000000000{ "Subnets": [ { "VpcId": "vpc-8d2910e4", "CidrBlock": "10.0.0.0/24", "MapPublicIpOnLaunch": false, "DefaultForAz": false, "State": "available", "AvailabilityZone": "us-west-2a", "SubnetId": "subnet-812910e8", "AvailableIpAddressCount": 251 } ], "ResponseMetadata": { "RequestId": "00759e83-6720-41e3-bb47-7f2cad470782" } } ././@LongLink0000000000000000000000000000014700000000000011217 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-get-identity-verification-attributes.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-get-identity-verification-attributes.js0000666454262600001440000000057413042511306035336 0ustar pysdk-ciamazon00000000000000{ "VerificationAttributes": { "user@domain.com": { "VerificationStatus": "Pending" }, "domain.com": { "VerificationToken": "QTKknzFg2J4ygwa+XvHAxUl1hyHoY0gVfZdfjIedHZ0=", "VerificationStatus": "Pending" } }, "ResponseMetadata": { "RequestId": "1d0c29f1-9bf3-11e1-8ee7-c98a0037a2b6" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-monitor-instances.xml0000666454262600001440000000075713042511306031606 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-43a4412a pending i-23a3397d pending botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-instance-export-task.xml0000666454262600001440000000132213042511306033443 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE export-i-1234wxyz Example for docs active Running i-12345678 VMWare VMDK OVA my-bucket-for-exported-vm my-exports/ export-i-1234wxyz .ova botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-attach-vpn-gateway.xml0000666454262600001440000000041013042511306031620 0ustar pysdk-ciamazon00000000000000 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE vpc-1a2b3c4d attaching botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-placement-groups.json0000666454262600001440000000035013042511306033333 0ustar pysdk-ciamazon00000000000000{"PlacementGroups": [{"GroupName": "Project-cluster", "State": "available", "Strategy": "cluster"}], "ResponseMetadata": { "RequestId": "d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-import-key-pair.xml0000666454262600001440000000044313042511306031153 0ustar pysdk-ciamazon00000000000000 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE gsg-keypair 00:00:00: 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00 botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-account-aliases.json0000666454262600001440000000021413042511306032410 0ustar pysdk-ciamazon00000000000000{"AccountAliases": ["foocorporation"], "IsTruncated": false, "ResponseMetadata": {"RequestId": "c5a076e9-f1b0-11df-8fbe-45274EXAMPLE"} } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-snapshot.xml0000666454262600001440000000070113042511306031217 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE snap-1a2b3c4d vol-1a2b3c4d pending YYYY-MM-DDTHH:MM:SS.000Z 60% 111122223333 30 Daily Backup botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-get-invalidation.json0000666454262600001440000000075313042511306033243 0ustar pysdk-ciamazon00000000000000{ "Invalidation": { "Status": "InProgress", "InvalidationBatch": { "Paths": { "Items": [ "/image1.jpg", "/image2.jpg", "/videos/movie.flv" ], "Quantity": 3 }, "CallerReference": "20120301090001" }, "Id": "IDFDVBD632BHDS5", "CreateTime": "2009-11-19T19:37:58Z" }, "ResponseMetadata": {} }botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-subscribe.xml0000666454262600001440000000045213042511306030235 0ustar pysdk-ciamazon00000000000000 pending confirmation a169c740-3766-11df-8963-01868b7c937a botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-reserved-db-instances.xml0000666454262600001440000000212613042511306034206 0ustar pysdk-ciamazon00000000000000 Medium Utilization USD mysql 649fd0c8-cf6d-47a0-bfa6-060f8e75e95f false active myreservationid 1 2010-12-15T00:25:14.131Z 31536000 227.5 0.046 db.m1.small c695119b-2961-11e1-bd06-6fe008f046c3 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-snapshots.json0000666454262600001440000000270713042511306032100 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "928b3baf-8729-4285-a244-1c47c8114916" }, "Snapshots": [ { "Description": "Proxy Sniffer Data Disk NTFS 10 GB", "VolumeId": "vol-ee102886", "State": "completed", "VolumeSize": 10, "Progress": "100%", "StartTime": "2011-12-27T17:20:21.000Z", "SnapshotId": "snap-b253e6da", "OwnerId": "123456789012" }, { "Description": "", "VolumeId": "vol-213dd14a", "State": "completed", "VolumeSize": 90, "Progress": "100%", "StartTime": "2012-01-08T00:41:31.000Z", "SnapshotId": "snap-b6bf0cde", "OwnerId": "123456789012" }, { "Description": "", "VolumeId": "vol-4ab8dc22", "State": "completed", "VolumeSize": 8, "Progress": "100%", "StartTime": "2012-02-22T17:25:10.000Z", "SnapshotId": "snap-1e099276", "OwnerId": "123456789012" }, { "Description": "pvlinux-debian-6.0-x86_0.7.0.62_120223_172028", "VolumeId": "vol-4d1b5c26", "State": "completed", "VolumeSize": 1, "Progress": "100%", "StartTime": "2012-02-23T22:26:43.000Z", "SnapshotId": "snap-d63550be", "OwnerId": "123456789012" } ] } ././@LongLink0000000000000000000000000000014600000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-list-streaming-distributions.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-list-streaming-distributions.jso0000666454262600001440000000122213042511306035461 0ustar pysdk-ciamazon00000000000000{ "StreamingDistributionList": { "Items": [ { "Status": "Deployed", "S3Origin": {}, "DomainName": "s5c39gqb8ow64r.cloudfront.net", "PriceClass": "PriceClass_All", "Enabled": true, "Id": "EGTXBD79EXAMPLE", "LastModifiedTime": "2012-05-19T19:37:58Z", "Comment": "First distribution" } ], "NextMarker": "ED4L98SBEXAMPLE", "MaxItems": 1, "Marker": "EGTXBD79EXAMPLE", "IsTruncated": true, "Quantity": 4 }, "ResponseMetadata": {} }././@LongLink0000000000000000000000000000015500000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-revoke-cluster-security-group-ingress.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-revoke-cluster-security-group-ingr0000666454262600001440000000044213042511306035367 0ustar pysdk-ciamazon00000000000000{ "ClusterSecurityGroup": { "Description": "my security group", "ClusterSecurityGroupName": "securitygroup1", "EC2SecurityGroups": [], "IPRanges": [] }, "ResponseMetadata": { "RequestId": "d8eff363-6502-11e2-a8da-655adc216806" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-get-queue-url.xml0000666454262600001440000000053313042511306030760 0ustar pysdk-ciamazon00000000000000 http://sqs.us-east-1.amazonaws.com/123456789012/testQueue 470a6f13-2ed9-4181-ad8a-2fdea142988e ././@LongLink0000000000000000000000000000014600000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-check-dns-availability.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-check-dns-availability.jso0000666454262600001440000000030713042511306035263 0ustar pysdk-ciamazon00000000000000{ "Available": true, "FullyQualifiedCNAME": "sampleapplication.elasticbeanstalk.amazonaws.com", "ResponseMetadata": { "RequestId": "12f6701f-f1d6-11df-8a78-9f77047e0d0c" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-addresses.xml0000666454262600001440000000127213042511306031656 0ustar pysdk-ciamazon00000000000000 b4cfd51c-a092-494f-8ee0-59912bef0ccc 54.245.81.77 standard 54.245.99.8 standard 50.112.139.73 eipalloc-312e1758 vpc botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-list-invalidations.xml0000666454262600001440000000112113042511306033437 0ustar pysdk-ciamazon00000000000000 EGTXBD79EXAMPLE Invalidation ID 2 true 10 Second Invalidation ID Completed First Invalidation ID Completed botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-network-acls.xml0000666454262600001440000000363113042511306032313 0ustar pysdk-ciamazon00000000000000 44c81884-4c88-40ef-b6e9-b04d207189c9 acl-8c2910e5 vpc-8d2910e4 true 100 -1 allow true 0.0.0.0/0 32767 -1 deny true 0.0.0.0/0 100 -1 allow false 0.0.0.0/0 32767 -1 deny false 0.0.0.0/0 aclassoc-832910ea acl-8c2910e5 subnet-812910e8 botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-scheduled-actions.xml0000666454262600001440000000052513042511306035137 0ustar pysdk-ciamazon00000000000000 68de155d-9167-11e2-9223-abe83dfc0567 ././@LongLink0000000000000000000000000000014600000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-get-identity-verification-attributes.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-get-identity-verification-attributes.xm0000666454262600001440000000143213042511306035340 0ustar pysdk-ciamazon00000000000000 domain.com Pending QTKknzFg2J4ygwa+XvHAxUl1hyHoY0gVfZdfjIedHZ0= user@domain.com Pending 1d0c29f1-9bf3-11e1-8ee7-c98a0037a2b6 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-start-instances.xml0000666454262600001440000000071713042511306031250 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-10a64379 0 pending 80 stopped botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-get-send-statistics.xml0000666454262600001440000000136713042511306032147 0ustar pysdk-ciamazon00000000000000 8 2011-08-03T19:23:00Z 0 0 0 7 2011-08-03T06:53:00Z 0 0 0 c2b66ee5-c866-11e0-b17f-cddb0ab334db botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-get-streaming-distribution.json0000666454262600001440000000362313042511306035267 0ustar pysdk-ciamazon00000000000000{ "StreamingDistribution": { "Status": "Deployed", "StreamingDistributionConfig": { "S3Origin": { "OriginAccessIdentity": "origin-access-identity/cloudfront/E74FTE3AEXAMPLE" }, "Comment": "example comment", "Logging": { "Bucket": "myawslogbucket.s3.amazonaws.com", "Prefix": "myprefix/", "Enabled": true }, "PriceClass": "PriceClass_All", "Enabled": true, "TrustedSigners": { "Items": [ "self", "111122223333", "444455556666" ], "Quantity": 3 }, "CallerReference": "20120229090000", "Aliases": { "Items": [ "www.example.com" ], "Quantity": 1 } }, "DomainName": "s5c39gqb8ow64r.cloudfront.net", "ActiveTrustedSigners": { "Items": [ { "KeyPairIds": { "Items": [ "APKA9ONS7QCOWEXAMPLE" ], "Quantity": 1 }, "AwsAccountNumber": "self" }, { "KeyPairIds": { "Quantity": 2 }, "AwsAccountNumber": "111122223333" }, { "KeyPairIds": { "Quantity": 0 }, "AwsAccountNumber": "444455556666" } ], "Quantity": 3 }, "LastModifiedTime": "2012-05-19T19:37:58Z", "Id": "EGTXBD79EXAMPLE" }, "ResponseMetadata": {} }botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-list-objects.xml0000666454262600001440000000170513042511306030402 0ustar pysdk-ciamazon00000000000000 test-1357854246 1000 false key1 2013-01-10T21:45:09.000Z "1d921b22129502cbbe5cbaf2c8bac682" 10000 1936a5d8a2b189cda450d1d1d514f3861b3adc2df515 aws STANDARD key2 2013-01-10T22:45:09.000Z "1d921b22129502cbbe5cbaf2c8bac682" 1234 1936a5d8a2b189cda450d1d1d514f3861b3adc2df515 aws STANDARD ././@LongLink0000000000000000000000000000015100000000000011212 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-update-application-version.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-update-application-version0000666454262600001440000000135313042511306035432 0ustar pysdk-ciamazon00000000000000 awsemr sample.war New Version New Release Description SampleApp 2010-11-17T19:26:20.699Z 2010-11-17T20:48:16.632Z 00b10aa1-f28c-11df-8a78-9f77047e0d0c botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-volumes.json0000666454262600001440000000264313042511306031547 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "93f17066-e6f7-4fc2-8308-2c49c99ab86b" }, "Volumes": [ { "AvailabilityZone": "us-west-2a", "Attachments": [ { "AttachTime": "2012-10-16T20:00:21.000Z", "InstanceId": "i-fde9cece", "VolumeId": "vol-bc71579a", "State": "attached", "DeleteOnTermination": true, "Device": "/dev/sda1" } ], "VolumeType": "standard", "VolumeId": "vol-bc71579a", "State": "in-use", "SnapshotId": "snap-2723f74f", "CreateTime": "2012-10-16T20:00:16.000Z", "Size": 8 }, { "AvailabilityZone": "us-west-2b", "Attachments": [ { "AttachTime": "2013-03-09T16:44:07.000Z", "InstanceId": "i-78f1b94a", "VolumeId": "vol-a8d2e991", "State": "attached", "DeleteOnTermination": true, "Device": "/dev/sda1" } ], "VolumeType": "standard", "VolumeId": "vol-a8d2e991", "State": "in-use", "SnapshotId": "snap-3d367c04", "CreateTime": "2013-03-09T16:43:57.000Z", "Size": 30 } ] } botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-copy-cluster-snapshot.json0000666454262600001440000000117213042511306033720 0ustar pysdk-ciamazon00000000000000{ "Snapshot": { "Status": "available", "SnapshotCreateTime": "2013-01-22T19:27:58.931Z", "AvailabilityZone": "us-east-1c", "ClusterVersion": "1.0", "MasterUsername": "adminuser", "DBName": "dev", "ClusterCreateTime": "2013-01-22T19:23:59.368Z", "SnapshotType": "manual", "NodeType": "dw.hs1.xlarge", "ClusterIdentifier": "examplecluster", "Port": 5439, "NumberOfNodes": 2, "SnapshotIdentifier": "my-snapshot-456" }, "ResponseMetadata": { "RequestId": "aebb56f5-64fe-11e2-88c5-53eb05787dfb" } }././@LongLink0000000000000000000000000000016200000000000011214 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-notification-types.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-notificat0000666454262600001440000000131413042511306035303 0ustar pysdk-ciamazon00000000000000 autoscaling:EC2_INSTANCE_LAUNCH autoscaling:EC2_INSTANCE_LAUNCH_ERROR autoscaling:EC2_INSTANCE_TERMINATE autoscaling:EC2_INSTANCE_TERMINATE_ERROR autoscaling:TEST_NOTIFICATION 68cc13f5-9167-11e2-9863-c1fc2ead119c botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-policies.json0000666454262600001440000000017313042511306033520 0ustar pysdk-ciamazon00000000000000{ "ScalingPolicies": [], "ResponseMetadata": { "RequestId": "675a0dbe-9167-11e2-b1be-9d56e7e138d4" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-get-group.xml0000666454262600001440000000142413042511306030130 0ustar pysdk-ciamazon00000000000000 AIDAIWOYUHHXRAGTJC6H2 / harry arn:aws:iam::419278470775:user/harry 2013-06-04T13:20:49Z false AGPAIX2UU43C4MKIJO6OE test_admin / arn:aws:iam::419278470775:group/test_admin 2013-06-04T13:19:26Z b23a1f90-d364-11e2-9e37-0baaf58cf1ee botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-get-user.json0000666454262600001440000000036513042511306030126 0ustar pysdk-ciamazon00000000000000{ "User": { "CreateDate": "2011-12-19T23:16:46Z", "UserId": "123456789012", "Arn": "arn:aws:iam::123456789012:root" }, "ResponseMetadata": { "RequestId": "a8ca5eb9-9167-11e2-8395-2fafede00095" } } ././@LongLink0000000000000000000000000000015200000000000011213 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-reserved-db-instances-offerings.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-reserved-db-instances-offering0000666454262600001440000000457513042511306035216 0ustar pysdk-ciamazon00000000000000 M2E5OGJmN2QtYjRjNi00NzNmLWI4MGMtYmFkNzFmNzA2YzUw Heavy Utilization 94608000 USD Hourly 0.139 2058.0 oracle-se1(li) 0.0 248e7b75-0815-427d-a429-b0fed4633e8c false db.m1.large Light Utilization 94608000 USD 548.0 oracle-ee(byol) 0.234 248e7b75-09fe-4f1d-afbc-296929db4f47 false db.m2.xlarge Light Utilization 94608000 USD 2512.0 oracle-se1(li) 1.026 248e7b75-0a34-4615-b83c-e4b445862054 true db.m1.xlarge aa4fed7d-9167-11e2-b691-fdba749921d2 ././@LongLink0000000000000000000000000000015700000000000011220 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-get-cloud-front-origin-access-identity.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-get-cloud-front-origin-access-id0000666454262600001440000000073513042511306035164 0ustar pysdk-ciamazon00000000000000 E74FTE3AEXAMPLE cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE 20120229090000 My comments botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-set-identity-dkim-enabled.json0000666454262600001440000000013713042511306033350 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "7aa61362-c469-11e1-aee5-6bbb4608fbcc" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-events.json0000666454262600001440000000226613042511306031501 0ustar pysdk-ciamazon00000000000000{ "Events": [ { "Date": "2010-08-11T17:12:52.860Z", "Message": "Applied change to security group", "SourceIdentifier": "mydbsecuritygroup", "SourceType": "db-security-group" }, { "Date": "2010-08-11T18:10:15.269Z", "Message": "Database instance created", "SourceIdentifier": "mydbinstance3", "SourceType": "db-instance" }, { "Date": "2010-08-11T18:10:34.690Z", "Message": "Backing up database instance", "SourceIdentifier": "mydbinstance3", "SourceType": "db-instance" }, { "Date": "2010-08-11T18:25:52.263Z", "Message": "Backing up DB Instance", "SourceIdentifier": "mynewdbinstance", "SourceType": "db-instance" }, { "Date": "2010-08-11T18:25:52.263Z", "Message": "Creating user snapshot", "SourceIdentifier": "mynewdbsnapshot3", "SourceType": "db-snapshot" } ], "ResponseMetadata": { "RequestId": "95b948cd-bf45-11de-86a4-97241dfaadff" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-route-table.xml0000666454262600001440000000102613042511306031604 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE rtb-f9ad4890 vpc-11ad4878 10.0.0.0/22 local active botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-snapshots.xml0000666454262600001440000000347513042511306031732 0ustar pysdk-ciamazon00000000000000 928b3baf-8729-4285-a244-1c47c8114916 snap-b253e6da vol-ee102886 completed 2011-12-27T17:20:21.000Z 100% 123456789012 10 Proxy Sniffer Data Disk NTFS 10 GB snap-b6bf0cde vol-213dd14a completed 2012-01-08T00:41:31.000Z 100% 123456789012 90 snap-1e099276 vol-4ab8dc22 completed 2012-02-22T17:25:10.000Z 100% 123456789012 8 snap-d63550be vol-4d1b5c26 completed 2012-02-23T22:26:43.000Z 100% 123456789012 1 pvlinux-debian-6.0-x86_0.7.0.62_120223_172028 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-network-interfaces.json0000666454262600001440000000650113042511306033664 0ustar pysdk-ciamazon00000000000000{"NetworkInterfaces": [{"Attachment": {"AttachTime": "2012-07-01T21:45:27.000Z", "AttachmentId": "eni-attach-6537fc0c", "DeleteOnTermination": true, "DeviceIndex": 0, "InstanceId": "i-22197876", "InstanceOwnerId": "123456789012", "Status": "attached"}, "AvailabilityZone": "ap-southeast-1b", "Description": "", "Groups": [{"GroupId": "sg-3f4b5653", "GroupName": "default"}], "MacAddress": "02:81:60:cb:27:37", "NetworkInterfaceId": "eni-0f62d866", "OwnerId": "123456789012", "PrivateIpAddress": "10.0.0.146", "PrivateIpAddresses": [{"Primary": true, "PrivateIpAddress": "10.0.0.146"}, {"Primary": false, "PrivateIpAddress": "10.0.0.148"}, {"Primary": false, "PrivateIpAddress": "10.0.0.150"}], "RequesterManaged": false, "SourceDestCheck": true, "Status": "in-use", "SubnetId": "subnet-c53c87ac", "TagSet": [], "VpcId": "vpc-cc3c87a5"}, {"Attachment": {"AttachTime": "2012-06-27T20:08:44.000Z", "AttachmentId": "eni-attach-a99c57c0", "DeleteOnTermination": true, "DeviceIndex": 0, "InstanceId": "i-886401dc", "InstanceOwnerId": "123456789012", "Status": "attached"}, "AvailabilityZone": "ap-southeast-1b", "Description": "Primary network interface", "Groups": [{"GroupId": "sg-a2a0b2ce", "GroupName": "quick-start-1"}], "MacAddress": "02:78:d7:00:8a:1e", "NetworkInterfaceId": "eni-a66ed5cf", "OwnerId": "123456789012", "PrivateIpAddress": "10.0.1.233", "PrivateIpAddresses": [{"Primary": true, "PrivateIpAddress": "10.0.1.233"}, {"Primary": false, "PrivateIpAddress": "10.0.1.20"}], "RequesterManaged": false, "SourceDestCheck": true, "Status": "in-use", "SubnetId": "subnet-cd8a35a4", "TagSet": [], "VpcId": "vpc-f28a359b"}], "ResponseMetadata": {"RequestId": "fc45294c-006b-457b-bab9-012f5b3b0e40"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-create-virtual-mfa-device.xml0000666454262600001440000000111213042511306033136 0ustar pysdk-ciamazon00000000000000 Zm9v VTNJV09MNTZFSjNRNUlMWUJMVTZOTFROWlIzVjVTQU9XS1E1QU9FUEVRVVVHUUpGVkRRS09BMk43T0FOVEhCUg== arn:aws:iam::419278470775:mfa/ExampleMFADevice c7bf48a5-d35c-11e2-b096-29dca78bf3ce botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-send-message.xml0000666454262600001440000000062613042511306030635 0ustar pysdk-ciamazon00000000000000 fafb00f5732ab283681e124bf8747ed1 5fea7756-0ea4-451a-a703-a558b933e274 27daac76-34dd-47df-bd01-1f6e873584a0 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-regions.json0000666454262600001440000000203613042511306031517 0ustar pysdk-ciamazon00000000000000{ "Regions": [ { "Endpoint": "ec2.eu-west-1.amazonaws.com", "RegionName": "eu-west-1" }, { "Endpoint": "ec2.sa-east-1.amazonaws.com", "RegionName": "sa-east-1" }, { "Endpoint": "ec2.us-east-1.amazonaws.com", "RegionName": "us-east-1" }, { "Endpoint": "ec2.ap-northeast-1.amazonaws.com", "RegionName": "ap-northeast-1" }, { "Endpoint": "ec2.us-west-2.amazonaws.com", "RegionName": "us-west-2" }, { "Endpoint": "ec2.us-west-1.amazonaws.com", "RegionName": "us-west-1" }, { "Endpoint": "ec2.ap-southeast-1.amazonaws.com", "RegionName": "ap-southeast-1" }, { "Endpoint": "ec2.ap-southeast-2.amazonaws.com", "RegionName": "ap-southeast-2" } ], "ResponseMetadata": { "RequestId": "b5ad0cf6-846e-41be-a10d-767e2c519a71" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-verify-domain-identity.json0000666454262600001440000000025113042511306033011 0ustar pysdk-ciamazon00000000000000{ "VerificationToken": "QTKknzFg2J4ygwa+XvHAxUl1hyHoY0gVfZdfjIedHZ0=", "ResponseMetadata": { "RequestId": "94f6368e-9bf2-11e1-8ee7-c98a0037a2b6" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-get-account-summary.xml0000666454262600001440000000412313042511306032122 0ustar pysdk-ciamazon00000000000000 Users 1 GroupsQuota 100 RolesQuota 250 GroupPolicySizeQuota 5120 ServerCertificates 0 ServerCertificatesQuota 10 Groups 0 MFADevicesInUse 0 UsersQuota 5000 AccountMFAEnabled 0 InstanceProfilesQuota 100 MFADevices 0 AccessKeysPerUserQuota 2 RolePolicySizeQuota 10240 UserPolicySizeQuota 2048 GroupsPerUserQuota 10 SigningCertificatesPerUserQuota 2 AssumeRolePolicySizeQuota 2048 InstanceProfiles 0 Roles 0 a8e3b3ed-9167-11e2-8a19-1174a5b297de botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-vpn-gateway.json0000666454262600001440000000047113042511306031777 0ustar pysdk-ciamazon00000000000000{ "VpnGateway": { "AvailabilityZone": "us-east-1a", "Tags": [], "VpcAttachments": [], "State": "pending", "VpnGatewayId": "vgw-8db04f81", "Type": "ipsec.1" }, "ResponseMetadata": { "RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-reserved-db-instances.json0000666454262600001440000000137213042511306034361 0ustar pysdk-ciamazon00000000000000{ "ReservedDBInstances": [ { "MultiAZ": false, "OfferingType": "Medium Utilization", "FixedPrice": 227.5, "CurrencyCode": "USD", "ProductDescription": "mysql", "ReservedDBInstancesOfferingId": "649fd0c8-cf6d-47a0-bfa6-060f8e75e95f", "RecurringCharges": [], "Duration": 31536000, "State": "active", "DBInstanceCount": 1, "StartTime": "2010-12-15T00:25:14.131Z", "ReservedDBInstanceId": "myreservationid", "DBInstanceClass": "db.m1.small", "UsagePrice": 0.046 } ], "ResponseMetadata": { "RequestId": "c695119b-2961-11e1-bd06-6fe008f046c3" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-send-message-batch.xml0000666454262600001440000000135613042511306031715 0ustar pysdk-ciamazon00000000000000 test_msg_001 0a5231c7-8bff-4955-be2e-8dc7c50a25fa 0e024d309850c78cba5eabbeff7cae71 test_msg_002 15ee1ed3-87e7-40c1-bdaa-2e49968ea7e9 7fb8146a82f95e0af155278f406862c2 ca1ad5d0-8271-408b-8d0f-1351bf547e74 ././@LongLink0000000000000000000000000000015400000000000011215 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-application-versions.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-application-versi0000666454262600001440000000144213042511306035372 0ustar pysdk-ciamazon00000000000000 amazonaws.com sample.war Version1 description SampleApp 2010-11-17T03:21:59.161Z 2010-11-17T03:21:59.161Z 773cd80a-f26c-11df-8a78-9f77047e0d0c botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-list-topics.json0000666454262600001440000000022613042511306030676 0ustar pysdk-ciamazon00000000000000{"ResponseMetadata": {"RequestId": "3f1478c7-33a9-11df-9540-99d0768312d3"}, "Topics": [{"TopicArn": "arn:aws:sns:us-east-1:123456789012:My-Topic"}]} botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-events.xml0000666454262600001440000000267013042511306031327 0ustar pysdk-ciamazon00000000000000 Applied change to security group db-security-group 2010-08-11T17:12:52.860Z mydbsecuritygroup Database instance created db-instance 2010-08-11T18:10:15.269Z mydbinstance3 Backing up database instance db-instance 2010-08-11T18:10:34.690Z mydbinstance3 Backing up DB Instance db-instance 2010-08-11T18:25:52.263Z mynewdbinstance Creating user snapshot db-snapshot 2010-08-11T18:25:52.263Z mynewdbsnapshot3 95b948cd-bf45-11de-86a4-97241dfaadff botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-server-certificates.json0000666454262600001440000000174713042511306033322 0ustar pysdk-ciamazon00000000000000{"IsTruncated": false, "ResponseMetadata": {"RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE"}, "ServerCertificateMetadataList": [ {"Arn": "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert", "Path": "/company/servercerts/", "ServerCertificateId": "ASCACKCEVSQ6CEXAMPLE1", "ServerCertificateName": "ProdServerCert", "UploadDate": "2010-05-08T01:02:03.004Z"}, {"Arn": "arn:aws:iam::123456789012:server-certificate/company/servercerts/BetaServerCert", "Path": "/company/servercerts/", "ServerCertificateId": "ASCACKCEVSQ6CEXAMPLE2", "ServerCertificateName": "BetaServerCert", "UploadDate": "2010-05-08T02:03:01.004Z"}, {"Arn": "arn:aws:iam::123456789012:server-certificate/company/servercerts/TestServerCert", "Path": "/company/servercerts/", "ServerCertificateId": "ASCACKCEVSQ6CEXAMPLE3", "ServerCertificateName": "TestServerCert", "UploadDate": "2010-05-08T03:01:02.004Z"} ] } botocore-1.5.7/tests/unit/response_parsing/xml/responses/elb-describe-load-balancer-policies.xml0000666454262600001440000004522713042511306034273 0ustar pysdk-ciamazon00000000000000 ELBSample-OpenSSLDefaultCipherPolicy SSLNegotiationPolicyType Protocol-SSLv2 false ADH-AES256-SHA false DHE-RSA-AES256-SHA true DHE-DSS-AES256-SHA true AES256-SHA true KRB5-DES-CBC3-MD5 true KRB5-DES-CBC3-SHA true ADH-DES-CBC3-SHA false EDH-RSA-DES-CBC3-SHA true EDH-DSS-DES-CBC3-SHA true DES-CBC3-SHA true DES-CBC3-MD5 false ADH-AES128-SHA false DHE-RSA-AES128-SHA true DHE-DSS-AES128-SHA true AES128-SHA true KRB5-RC4-MD5 true KRB5-RC4-SHA true ADH-RC4-MD5 false RC4-SHA true RC4-MD5 true RC2-CBC-MD5 false KRB5-DES-CBC-MD5 true KRB5-DES-CBC-SHA true ADH-DES-CBC-SHA false EDH-RSA-DES-CBC-SHA true EDH-DSS-DES-CBC-SHA true DES-CBC-SHA true DES-CBC-MD5 false EXP-KRB5-RC4-MD5 true EXP-KRB5-RC2-CBC-MD5 true EXP-KRB5-DES-CBC-MD5 true EXP-KRB5-RC4-SHA true EXP-KRB5-RC2-CBC-SHA true EXP-KRB5-DES-CBC-SHA true EXP-ADH-DES-CBC-SHA false EXP-ADH-RC4-MD5 false EXP-EDH-RSA-DES-CBC-SHA true EXP-EDH-DSS-DES-CBC-SHA true EXP-DES-CBC-SHA true EXP-RC2-CBC-MD5 true EXP-RC4-MD5 true DHE-RSA-CAMELLIA256-SHA true DHE-DSS-CAMELLIA256-SHA true ADH-CAMELLIA256-SHA false CAMELLIA256-SHA true PSK-AES256-CBC-SHA true PSK-3DES-EDE-CBC-SHA true DHE-RSA-SEED-SHA true DHE-DSS-SEED-SHA true DHE-RSA-CAMELLIA128-SHA true DHE-DSS-CAMELLIA128-SHA true ADH-SEED-SHA false ADH-CAMELLIA128-SHA false SEED-SHA true CAMELLIA128-SHA true PSK-AES128-CBC-SHA true PSK-RC4-SHA true Protocol-TLSv1 true IDEA-CBC-SHA false Protocol-SSLv3 true ELBSample-ELBDefaultCipherPolicy SSLNegotiationPolicyType Protocol-SSLv2 false EDH-DSS-DES-CBC3-SHA false DHE-RSA-CAMELLIA128-SHA false DES-CBC-MD5 false KRB5-RC4-SHA false ADH-CAMELLIA128-SHA false EXP-KRB5-RC4-MD5 false ADH-RC4-MD5 false PSK-RC4-SHA false PSK-AES128-CBC-SHA false EXP-EDH-RSA-DES-CBC-SHA false CAMELLIA128-SHA false DHE-DSS-AES128-SHA false EDH-RSA-DES-CBC-SHA false DHE-RSA-SEED-SHA false KRB5-DES-CBC-MD5 false DHE-RSA-CAMELLIA256-SHA false ADH-DES-CBC3-SHA false DES-CBC3-MD5 false EXP-KRB5-RC2-CBC-MD5 false EDH-DSS-DES-CBC-SHA false KRB5-DES-CBC-SHA false PSK-AES256-CBC-SHA false ADH-AES256-SHA false KRB5-DES-CBC3-SHA false AES128-SHA true DHE-DSS-SEED-SHA false ADH-CAMELLIA256-SHA false EXP-KRB5-RC4-SHA false EDH-RSA-DES-CBC3-SHA false EXP-KRB5-DES-CBC-MD5 false Protocol-TLSv1 true PSK-3DES-EDE-CBC-SHA false SEED-SHA false DHE-DSS-CAMELLIA256-SHA false IDEA-CBC-SHA false RC2-CBC-MD5 false KRB5-RC4-MD5 false ADH-AES128-SHA false RC4-SHA true AES256-SHA true Protocol-SSLv3 true EXP-DES-CBC-SHA false DES-CBC3-SHA true DHE-RSA-AES128-SHA false EXP-EDH-DSS-DES-CBC-SHA false EXP-KRB5-RC2-CBC-SHA false DHE-RSA-AES256-SHA false KRB5-DES-CBC3-MD5 false RC4-MD5 true EXP-RC2-CBC-MD5 false DES-CBC-SHA false EXP-ADH-RC4-MD5 false EXP-RC4-MD5 false ADH-DES-CBC-SHA false CAMELLIA256-SHA false DHE-DSS-CAMELLIA128-SHA false EXP-KRB5-DES-CBC-SHA false EXP-ADH-DES-CBC-SHA false DHE-DSS-AES256-SHA false ADH-SEED-SHA false ab663f4e-9167-11e2-ab97-3b4060f1aeb3 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-vpn-connections.xml0000666454262600001440000000112413042511306033020 0ustar pysdk-ciamazon00000000000000 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE vpn-44a8938f available Gateway Info ipsec.1 cgw-b4dc3961 vgw-8db04f81 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-send-email.json0000666454262600001440000000026113042511306030430 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "d5964849-c866-11e0-9beb-01a62d68c57f" }, "MessageId": "00000131d51d2292-159ad6eb-077c-46e6-ad09-ae7c05925ed4-000000" }botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-events.json0000666454262600001440000000277713042511306034231 0ustar pysdk-ciamazon00000000000000{"Events": [{"ApplicationName": "SampleApp", "EnvironmentName": "SampleAppVersion", "EventDate": "2010-11-17T20:25:35.191Z", "Message": "Successfully completed createEnvironment activity.", "RequestId": "bb01fa74-f287-11df-8a78-9f77047e0d0c", "Severity": "INFO", "VersionLabel": "New Version"}, {"ApplicationName": "SampleApp", "EnvironmentName": "SampleAppVersion", "EventDate": "2010-11-17T20:21:30Z", "Message": "Launching a new EC2 instance: i-04a8c569", "Severity": "DEBUG", "VersionLabel": "New Version"}, {"ApplicationName": "SampleApp", "EnvironmentName": "SampleAppVersion", "EventDate": "2010-11-17T20:20:32.008Z", "Message": "At least one EC2 instance has entered the InService lifecycle state.", "RequestId": "bb01fa74-f287-11df-8a78-9f77047e0d0c", "Severity": "INFO", "VersionLabel": "New Version"}, {"ApplicationName": "SampleApp", "EnvironmentName": "SampleAppVersion", "EventDate": "2010-11-17T20:19:28Z", "Message": "Elastic Load Balancer elasticbeanstalk-SampleAppVersion has failed 0 healthy instances - Environment may not be available.", "Severity": "WARN", "VersionLabel": "New Version"}], "ResponseMetadata": {"RequestId": "f10d02dd-f288-11df-8a78-9f77047e0d0c"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-subnet.xml0000666454262600001440000000067413042511306030671 0ustar pysdk-ciamazon00000000000000 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE subnet-9d4a7b6c pending vpc-1a2b3c4d 10.0.1.0/24 251 us-east-1a ././@LongLink0000000000000000000000000000014600000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-groups.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-groups.xm0000666454262600001440000000051713042511306035271 0ustar pysdk-ciamazon00000000000000 681e6e72-9167-11e2-ba50-d18200895d59 ././@LongLink0000000000000000000000000000015600000000000011217 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-notification-configurations.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-notification-configura0000666454262600001440000000057413042511306035407 0ustar pysdk-ciamazon00000000000000 680a7204-9167-11e2-b1be-9d56e7e138d4 botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-receive-message.xml0000666454262600001440000000215613042511306031326 0ustar pysdk-ciamazon00000000000000 5fea7756-0ea4-451a-a703-a558b933e274 MbZj6wDWli+JvwwJaBV+3dcjk2YW2vA3+STFFljTM8tJJg6HRG6PYSasuWXPJB+Cw Lj1FjgXUv1uSj1gUPAWV66FU/WeR4mq2OKpEGYWbnLmpRCJVAyeMjeU5ZBdtcQ+QE auMZc8ZRv37sIW2iJKq3M9MFx1YvV11A2x/KSbkJ0= fafb00f5732ab283681e124bf8747ed1 This is a test message SenderId 195004372649 SentTimestamp 1238099229000 ApproximateReceiveCount 5 ApproximateFirstReceiveTimestamp 1250700979248 b6633655-283d-45b4-aee4-4e84e0ae6afa botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-adjustment-types.json0000666454262600001440000000041413042511306035227 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "6782caf9-9167-11e2-9223-abe83dfc0567" }, "AdjustmentTypes": [ {"AdjustmentType": "ChangeInCapacity"}, {"AdjustmentType": "ExactCapacity"}, {"AdjustmentType": "PercentChangeInCapacity"} ] } botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudwatch-describe-alarm-history.xml0000666454262600001440000000047213042511306034161 0ustar pysdk-ciamazon00000000000000 ac265b36-9167-11e2-bf7e-91c14e278742 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-bundle-tasks.json0000666454262600001440000000076113042511306032450 0ustar pysdk-ciamazon00000000000000{"BundleTasks": [{"BundleId": "bun-c1a540a8", "InstanceId": "i-12345678", "Progress": "20%", "StartTime": "2008-10-07T11:41:50.000Z", "State": "cancelling", "Storage": {"S3": {"Bucket": "myawsbucket", "Prefix": "winami"}}, "UpdateTime": "2008-10-07T11:51:50.000Z"}], "ResponseMetadata": {"RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-spot-instance-requests.xml0000666454262600001440000000254613042511306034346 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE sir-1a2b3c4d 0.09 one-time active fulfilled YYYY-MM-DDTHH:MM:SS.000Z Your Spot request is fulfilled. ami-1a2b3c4d gsg-keypair sg-1a2b3c4d default m1.small false false i-1a2b3c4d YYYY-MM-DDTHH:MM:SS.000Z Linux/UNIX us-east-1c botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-server-certificates.xml0000666454262600001440000000276213042511306033147 0ustar pysdk-ciamazon00000000000000 false ProdServerCert /company/servercerts/ arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert 2010-05-08T01:02:03.004Z ASCACKCEVSQ6CEXAMPLE1 BetaServerCert /company/servercerts/ arn:aws:iam::123456789012:server-certificate/company/servercerts/BetaServerCert 2010-05-08T02:03:01.004Z ASCACKCEVSQ6CEXAMPLE2 TestServerCert /company/servercerts/ arn:aws:iam::123456789012:server-certificate/company/servercerts/TestServerCert 2010-05-08T03:01:02.004Z ASCACKCEVSQ6CEXAMPLE3 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE ././@LongLink0000000000000000000000000000015100000000000011212 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-instances.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-instances0000666454262600001440000000053613042511306035317 0ustar pysdk-ciamazon00000000000000 67af58ee-9167-11e2-ba50-d18200895d59 botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-create-cluster-subnet-group.json0000666454262600001440000000106613042511306035006 0ustar pysdk-ciamazon00000000000000{ "ClusterSubnetGroup": { "Subnets": [ { "SubnetStatus": "Active", "SubnetIdentifier": "subnet-756a591f", "SubnetAvailabilityZone": { "Name": "us-east-1c" } } ], "VpcId": "vpc-796a5913", "SubnetGroupStatus": "Complete", "Description": "My subnet group 1", "ClusterSubnetGroupName": "mysubnetgroup1" }, "ResponseMetadata": { "RequestId": "0a60660f-6a4a-11e2-aad2-71d00c36728e" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-import-volume.json0000666454262600001440000000170013042511306031107 0ustar pysdk-ciamazon00000000000000{ "ConversionTask": { "ConversionTaskId": "import-i-fh95npoc", "ImportVolume": { "Volume": { "Id": "vol-34d8a2ff", "Size": 8 }, "Image": { "Checksum": "ccb1b0536a4a70e86016b85229b5c6b10b14a4eb", "Size": 128696320, "ImportManifestUrl": "https://s3.amazonaws.com/myawsbucket/a3a5e1b6-590d-43cc-97c1-15c7325d3f41/Win_2008_Server_Data_Center_SP2_32-bit.vmdkmanifest.xml?AWSaccessKeyId=AKIAIOSFODNN7EXAMPLE%26Expires=1294855591%26Signature=5snej01T1TtL0uR7KExtEXAMPLE%3D", "Format": "VDMK" }, "BytesConverted": 0, "Description": "", "AvailabilityZone": "us-east-1c" }, "ExpirationTime": "2010-12-22T12:01Z", "State": "active", "StatusMessage": "" }, "ResponseMetadata": {"RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE"} } botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-scaling-activities.xml0000666454262600001440000000051013042511306035315 0ustar pysdk-ciamazon00000000000000 67459b5a-9167-11e2-b1be-9d56e7e138d4 ././@LongLink0000000000000000000000000000016200000000000011214 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-list-cloud-front-origin-access-identities.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-list-cloud-front-origin-access-i0000666454262600001440000000167513042511306035220 0ustar pysdk-ciamazon00000000000000 EDFDVBD6EXAMPLE EMLARXS9EXAMPLE 2 true 4 E74FTE3AEXAMPLE cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE First origin access identity E58SRM2XEXAMPLE 7d843ae7f1792436e72691ab96a9c1414b7c3fbe2ab739a1cf21b0fe2EXAMPLE Another origin access identity botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-route-tables.json0000666454262600001440000000321313042511306032455 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "0a0c3fc4-1246-463b-b276-2823b5bc38e6" }, "RouteTables": [ { "Associations": [ { "SubnetId": "subnet-812910e8", "RouteTableAssociationId": "rtbassoc-822019eb", "RouteTableId": "rtb-2728114e" } ], "RouteTableId": "rtb-2728114e", "VpcId": "vpc-8d2910e4", "PropagatingVgws": [], "Tags": [], "Routes": [ { "GatewayId": "local", "DestinationCidrBlock": "10.0.0.0/16", "Origin": "CreateRouteTable", "State": "active" }, { "GatewayId": "igw-6228110b", "DestinationCidrBlock": "0.0.0.0/0", "Origin": "CreateRoute", "State": "active" } ] }, { "Associations": [ { "RouteTableAssociationId": "rtbassoc-8e2910e7", "Main": true, "RouteTableId": "rtb-8f2910e6" } ], "RouteTableId": "rtb-8f2910e6", "VpcId": "vpc-8d2910e4", "PropagatingVgws": [], "Tags": [], "Routes": [ { "GatewayId": "local", "DestinationCidrBlock": "10.0.0.0/16", "Origin": "CreateRouteTable", "State": "active" } ] } ] } botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-db-engine-versions.json0000666454262600001440000001501213042511306033664 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "aa3623ef-9167-11e2-b6fb-e599bc501f26" }, "DBEngineVersions": [ { "Engine": "mysql", "DBEngineVersionDescription": "MySQL 5.1.57", "DBParameterGroupFamily": "mysql5.1", "DBEngineDescription": "MySQL Community Edition", "EngineVersion": "5.1.57" }, { "Engine": "mysql", "DBEngineVersionDescription": "MySQL 5.1.61", "DBParameterGroupFamily": "mysql5.1", "DBEngineDescription": "MySQL Community Edition", "EngineVersion": "5.1.61" }, { "Engine": "mysql", "DBEngineVersionDescription": "MySQL 5.1.62", "DBParameterGroupFamily": "mysql5.1", "DBEngineDescription": "MySQL Community Edition", "EngineVersion": "5.1.62" }, { "Engine": "mysql", "DBEngineVersionDescription": "MySQL 5.1.63", "DBParameterGroupFamily": "mysql5.1", "DBEngineDescription": "MySQL Community Edition", "EngineVersion": "5.1.63" }, { "Engine": "mysql", "DBEngineVersionDescription": "MySQL 5.5.12", "DBParameterGroupFamily": "mysql5.5", "DBEngineDescription": "MySQL Community Edition", "EngineVersion": "5.5.12" }, { "Engine": "mysql", "DBEngineVersionDescription": "MySQL 5.5.20", "DBParameterGroupFamily": "mysql5.5", "DBEngineDescription": "MySQL Community Edition", "EngineVersion": "5.5.20" }, { "Engine": "mysql", "DBEngineVersionDescription": "MySQL 5.5.23", "DBParameterGroupFamily": "mysql5.5", "DBEngineDescription": "MySQL Community Edition", "EngineVersion": "5.5.23" }, { "Engine": "mysql", "DBEngineVersionDescription": "MySQL 5.5.25a", "DBParameterGroupFamily": "mysql5.5", "DBEngineDescription": "MySQL Community Edition", "EngineVersion": "5.5.25a" }, { "Engine": "mysql", "DBEngineVersionDescription": "MySQL 5.5.27", "DBParameterGroupFamily": "mysql5.5", "DBEngineDescription": "MySQL Community Edition", "EngineVersion": "5.5.27" }, { "Engine": "mysql", "DBEngineVersionDescription": "MySQL 5.5.8", "DBParameterGroupFamily": "mysql5.5", "DBEngineDescription": "MySQL Community Edition", "EngineVersion": "5.5.8" }, { "Engine": "oracle-ee", "DBParameterGroupFamily": "oracle-ee-11.2", "DefaultCharacterSet": { "CharacterSetName": "AL32UTF8", "CharacterSetDescription": "Unicode 5.0 UTF-8 Universal character set" }, "DBEngineDescription": "Oracle Database Enterprise Edition", "EngineVersion": "11.2.0.2.v3", "DBEngineVersionDescription": "Oracle 11.2.0.2.v3" }, { "Engine": "oracle-ee", "DBParameterGroupFamily": "oracle-ee-11.2", "DefaultCharacterSet": { "CharacterSetName": "AL32UTF8", "CharacterSetDescription": "Unicode 5.0 UTF-8 Universal character set" }, "DBEngineDescription": "Oracle Database Enterprise Edition", "EngineVersion": "11.2.0.2.v4", "DBEngineVersionDescription": "Oracle 11.2.0.2.v4" }, { "Engine": "oracle-ee", "DBParameterGroupFamily": "oracle-ee-11.2", "DefaultCharacterSet": { "CharacterSetName": "AL32UTF8", "CharacterSetDescription": "Unicode 5.0 UTF-8 Universal character set" }, "DBEngineDescription": "Oracle Database Enterprise Edition", "EngineVersion": "11.2.0.2.v5", "DBEngineVersionDescription": "Oracle 11.2.0.2.v5" }, { "Engine": "oracle-ee", "DBParameterGroupFamily": "oracle-ee-11.2", "DefaultCharacterSet": { "CharacterSetName": "AL32UTF8", "CharacterSetDescription": "Unicode 5.0 UTF-8 Universal character set" }, "DBEngineDescription": "Oracle Database Enterprise Edition", "EngineVersion": "11.2.0.2.v6", "DBEngineVersionDescription": "Oracle 11.2.0.2.v6" }, { "Engine": "sqlserver-ex", "DBEngineVersionDescription": "SQL Server 2008 R2 10.50.2789.0.v1", "DBParameterGroupFamily": "sqlserver-ex-10.5", "DBEngineDescription": "Microsoft SQL Server Express Edition", "EngineVersion": "10.50.2789.0.v1" }, { "Engine": "sqlserver-ex", "DBEngineVersionDescription": "SQL Server 2012 11.00.2100.60.v1", "DBParameterGroupFamily": "sqlserver-ex-11.0", "DBEngineDescription": "Microsoft SQL Server Express Edition", "EngineVersion": "11.00.2100.60.v1" }, { "Engine": "sqlserver-se", "DBEngineVersionDescription": "SQL Server 2008 R2 10.50.2789.0.v1", "DBParameterGroupFamily": "sqlserver-se-10.5", "DBEngineDescription": "Microsoft SQL Server Standard Edition", "EngineVersion": "10.50.2789.0.v1" }, { "Engine": "sqlserver-se", "DBEngineVersionDescription": "SQL Server 2012 11.00.2100.60.v1", "DBParameterGroupFamily": "sqlserver-se-11.0", "DBEngineDescription": "Microsoft SQL Server Standard Edition", "EngineVersion": "11.00.2100.60.v1" }, { "Engine": "sqlserver-web", "DBEngineVersionDescription": "SQL Server 2008 R2 10.50.2789.0.v1", "DBParameterGroupFamily": "sqlserver-web-10.5", "DBEngineDescription": "Microsoft SQL Server Web Edition", "EngineVersion": "10.50.2789.0.v1" }, { "Engine": "sqlserver-web", "DBEngineVersionDescription": "SQL Server 2012 11.00.2100.60.v1", "DBParameterGroupFamily": "sqlserver-web-11.0", "DBEngineDescription": "Microsoft SQL Server Web Edition", "EngineVersion": "11.00.2100.60.v1" } ] }botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-application.xml0000666454262600001440000000121613042511306034525 0ustar pysdk-ciamazon00000000000000 Sample Description SampleApp 2010-11-16T23:09:20.256Z 2010-11-16T23:09:20.256Z Default 8b00e053-f1d6-11df-8a78-9f77047e0d0c botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-list-multipart-uploads.json0000666454262600001440000000054113042511306032605 0ustar pysdk-ciamazon00000000000000{ "UploadIdMarker": "", "CommonPrefixes": [ {"Prefix": "foo/"}, {"Prefix": "foobar/"} ], "ResponseMetadata": {}, "NextKeyMarker": "", "Bucket": "botocoretest1374528673-218", "Prefix": "foo", "Delimiter": "/", "NextUploadIdMarker": "", "KeyMarker": "", "MaxUploads": 1000, "IsTruncated": false } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-vpcs.json0000666454262600001440000000055013042511306031023 0ustar pysdk-ciamazon00000000000000{ "Vpcs": [ { "VpcId": "vpc-8d2910e4", "InstanceTenancy": "default", "State": "available", "DhcpOptionsId": "dopt-eb291082", "CidrBlock": "10.0.0.0/16", "IsDefault": false } ], "ResponseMetadata": { "RequestId": "ed65eddd-6d71-4eee-bc93-83d3a672c209" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-delete-cluster.json0000666454262600001440000000235613042511306032360 0ustar pysdk-ciamazon00000000000000{ "Cluster": { "NodeType": "dw.hs1.xlarge", "Endpoint": { "Port": 5439, "Address": "examplecluster2.cobbanlpscsn.us-east-1.redshift.amazonaws.com" }, "ClusterVersion": "1.0", "PubliclyAccessible": true, "MasterUsername": "masteruser", "Encrypted": true, "ClusterParameterGroups": [ { "ParameterApplyStatus": "in-sync", "ParameterGroupName": "default.redshift-1.0" } ], "ClusterSecurityGroups": [ { "Status": "active", "ClusterSecurityGroupName": "default" } ], "AllowVersionUpgrade": true, "VpcSecurityGroups": [], "AvailabilityZone": "us-east-1a", "ClusterCreateTime": "2013-01-23T00:11:32.804Z", "PreferredMaintenanceWindow": "sun:10:30-sun:11:00", "AutomatedSnapshotRetentionPeriod": 1, "ClusterStatus": "deleting", "ClusterIdentifier": "examplecluster2", "DBName": "dev", "NumberOfNodes": 2, "PendingModifiedValues": {} }, "ResponseMetadata": { "RequestId": "f2e6b87e-6503-11e2-b343-393adc3f0a21" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-instance-attribute.json0000666454262600001440000000027613042511306033662 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "4c94c806-ef28-4f4c-b1c7-3e601fe39497" }, "InstanceId": "i-12345678", "RootDeviceName": { "Value": "/dev/sda1" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-list-subscriptions.xml0000666454262600001440000000122213042511306032130 0ustar pysdk-ciamazon00000000000000 arn:aws:sns:us-east-1:698519295917:My-Topic email arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca 123456789012 example@amazon.com 384ac68d-3775-11df-8963-01868b7c937a botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-get-queue-url.json0000666454262600001440000000025513042511306031132 0ustar pysdk-ciamazon00000000000000{ "QueueUrl": "http://sqs.us-east-1.amazonaws.com/123456789012/testQueue", "ResponseMetadata": { "RequestId": "470a6f13-2ed9-4181-ad8a-2fdea142988e" } }././@LongLink0000000000000000000000000000015100000000000011212 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-application-version.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-application-version0000666454262600001440000000134313042511306035412 0ustar pysdk-ciamazon00000000000000 amazonaws.com sample.war Version1 description SampleApp 2010-11-17T03:21:59.161Z 2010-11-17T03:21:59.161Z d653efef-f1f9-11df-8a78-9f77047e0d0c botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-tags.json0000666454262600001440000000016013042511306032643 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "67c5c76d-9167-11e2-9863-c1fc2ead119c" }, "Tags": [] }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-get-send-statistics.json0000666454262600001440000000077413042511306032321 0ustar pysdk-ciamazon00000000000000{"ResponseMetadata": {"RequestId": "c2b66ee5-c866-11e0-b17f-cddb0ab334db"}, "SendDataPoints": [{"Bounces": 0, "Complaints": 0, "DeliveryAttempts": 8, "Rejects": 0, "Timestamp": "2011-08-03T19:23:00Z"}, {"Bounces": 0, "Complaints": 0, "DeliveryAttempts": 7, "Rejects": 0, "Timestamp": "2011-08-03T06:53:00Z"}]} botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-get-password-data.xml0000666454262600001440000000054313042511306031451 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-2574e22a 2009-10-24 15:00:00 TGludXggdmVyc2lvbiAyLjYuMTYteGVuVSAoYnVpbGRlckBwYXRjaGJhdC5hbWF6b25zYSkgKGdj botocore-1.5.7/tests/unit/response_parsing/xml/responses/sts-get-session-token.json0000666454262600001440000000110313042511306032003 0ustar pysdk-ciamazon00000000000000{"Credentials": {"AccessKeyId": "AKIAIOSFODNN7EXAMPLE", "Expiration": "2011-07-11T19:55:29.611Z", "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", "SessionToken": "AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/L\n To6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3z\n rkuWJOgQs8IZZaIv2BXIa2R4OlgkBN9bkUDNCJiBeb/AXlzBBko7b15fjrBs2+cTQtp\n Z3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE"}, "ResponseMetadata": {"RequestId": "58c5dbae-abef-11e0-8cfe-09039844ac7d"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-snapshots.xml0000666454262600001440000000326513042511306034545 0ustar pysdk-ciamazon00000000000000 5439 cm:examplecluster-2013-01-22-19-27-58 available automated 1.0 2013-01-22T19:27:58.931Z 2 dev 2013-01-22T19:23:59.368Z us-east-1c dw.hs1.xlarge examplecluster adminuser 5439 my-snapshot-123 available manual 1.0 2013-01-23T01:09:03.149Z 2 dev 2013-01-22T19:23:59.368Z us-east-1c dw.hs1.xlarge examplecluster adminuser 56a9daf4-64fa-11e2-a8da-655adc216806 botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-instance-profiles.xml0000666454262600001440000000206713042511306032621 0ustar pysdk-ciamazon00000000000000 false AIPACIFN4OZXG7EXAMPLE Database /application_abc/component_xyz/ arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Database 2012-05-09T16:27:03Z AIPACZLSXM2EYYEXAMPLE Webserver /application_abc/component_xyz/ arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Webserver 2012-05-09T16:27:11Z fd74fa8d-99f3-11e1-a4c3-27EXAMPLE804 botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-create-queue.xml0000666454262600001440000000053313042511306030644 0ustar pysdk-ciamazon00000000000000 http://sqs.us-east-1.amazonaws.com/123456789012/testQueue 7a62c49f-347e-4fc4-9331-6e8e7a96aa73 botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-mfa-devices.json0000666454262600001440000000025213042511306031522 0ustar pysdk-ciamazon00000000000000{"IsTruncated": false, "MFADevices": [ {"SerialNumber": "R1234", "UserName": "Bob"} ], "ResponseMetadata": {"RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE"} } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-delete-identity.xml0000666454262600001440000000035113042511306031332 0ustar pysdk-ciamazon00000000000000 d96bd874-9bf2-11e1-8ee7-c98a0037a2b6 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-cancel-reserved-instances-listing.xml0000666454262600001440000000502413042511306034620 0ustar pysdk-ciamazon00000000000000 bec2cf62-98ef-434a-8a15-886fcexample 3ebe97b5-f273-43b6-a204-7a18cexample af9f760e-9b3f-417a-ad5e-93f0cexample 2012-07-12T16:55:28.000Z 2012-07-12T16:55:28.000Z cancelled CANCELLED Available 0 Sold 0 Cancelled 1 Pending 0 5 166.64 USD false 4 133.32 USD false 3 99.99 USD false 2 66.66 USD false 1 33.33 USD false XqJIt1342112125076 ././@LongLink0000000000000000000000000000015100000000000011212 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-scaling-process-types.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-scaling-process-types.0000666454262600001440000000070113042511306035252 0ustar pysdk-ciamazon00000000000000{ "Processes": [ {"ProcessName": "AZRebalance"}, {"ProcessName": "AddToLoadBalancer"}, {"ProcessName": "AlarmNotification"}, {"ProcessName": "HealthCheck"}, {"ProcessName": "Launch"}, {"ProcessName": "ReplaceUnhealthy"}, {"ProcessName": "ScheduledActions"}, {"ProcessName": "Terminate"} ], "ResponseMetadata": { "RequestId": "67705466-9167-11e2-9223-abe83dfc0567" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-send-message.json0000666454262600001440000000032613042511306031003 0ustar pysdk-ciamazon00000000000000{ "MD5OfMessageBody": "fafb00f5732ab283681e124bf8747ed1", "ResponseMetadata": { "RequestId": "27daac76-34dd-47df-bd01-1f6e873584a0" }, "MessageId": "5fea7756-0ea4-451a-a703-a558b933e274" }././@LongLink0000000000000000000000000000014700000000000011217 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-reserved-instances-offerings.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-reserved-instances-offerings.x0000666454262600001440000000417713042511306035143 0ustar pysdk-ciamazon00000000000000 404d7db3-3ec5-4400-8d72-74b1553f176e 2628c27b-7c1c-4ad6-9f50-a09393f36ecf c1.medium us-west-2c 94608000 701.0 0.0 Linux/UNIX (Amazon VPC) default USD Heavy Utilization Hourly 0.031 false 371f1882-2df3-43b0-8f62-f73956fcfabc c1.medium us-west-2c 94608000 701.0 0.0 Red Hat Enterprise Linux default USD Heavy Utilization Hourly 0.091 false JqBdtVdGsvMjUysyEgwy/jVBCGAjj9G4/ivkfsXHt9A= botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-start-instances.json0000666454262600001440000000062713042511306031421 0ustar pysdk-ciamazon00000000000000{ "StartingInstances": [ { "InstanceId": "i-10a64379", "CurrentState": { "Code": 0, "Name": "pending" }, "PreviousState": { "Code": 80, "Name": "stopped" } } ], "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-delete-internet-gateway.xml0000666454262600001440000000031013042511306032642 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE true botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-get-invalidation.xml0000666454262600001440000000105213042511306033063 0ustar pysdk-ciamazon00000000000000 IDFDVBD632BHDS5 InProgress 2009-11-19T19:37:58Z 3 /image1.jpg /image2.jpg /videos/movie.flv 20120301090001 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-detach-volume.xml0000666454262600001440000000053313042511306030657 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE vol-1a2b3c4d i-1a2b3c4d /dev/sdh detaching YYYY-MM-DDTHH:MM:SS.000Z botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-get-password-data.json0000666454262600001440000000041613042511306031621 0ustar pysdk-ciamazon00000000000000{ "InstanceId": "i-2574e22a", "Timestamp": "2009-10-24 15:00:00", "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" }, "PasswordData": "TGludXggdmVyc2lvbiAyLjYuMTYteGVuVSAoYnVpbGRlckBwYXRjaGJhdC5hbWF6b25zYSkgKGdj" }././@LongLink0000000000000000000000000000015600000000000011217 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-list-available-solution-stacks.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-list-available-solution-st0000666454262600001440000001031113042511306035345 0ustar pysdk-ciamazon00000000000000{ "SolutionStacks": [ "32bit Amazon Linux running PHP 5.4", "64bit Amazon Linux running PHP 5.4", "32bit Amazon Linux running PHP 5.3", "64bit Amazon Linux running PHP 5.3", "32bit Amazon Linux running Node.js", "64bit Amazon Linux running Node.js", "64bit Windows Server 2008 R2 running IIS 7.5", "64bit Windows Server 2012 running IIS 8", "32bit Amazon Linux running Tomcat 7", "64bit Amazon Linux running Tomcat 7", "32bit Amazon Linux running Tomcat 6", "64bit Amazon Linux running Tomcat 6", "32bit Amazon Linux running Python", "64bit Amazon Linux running Python", "32bit Amazon Linux running Ruby 1.8.7", "64bit Amazon Linux running Ruby 1.8.7", "32bit Amazon Linux running Ruby 1.9.3", "64bit Amazon Linux running Ruby 1.9.3" ], "ResponseMetadata": { "RequestId": "af7e11cd-9167-11e2-9d65-771f0f370017" }, "SolutionStackDetails": [ { "PermittedFileTypes": [ "zip" ], "SolutionStackName": "32bit Amazon Linux running PHP 5.4" }, { "PermittedFileTypes": [ "zip" ], "SolutionStackName": "64bit Amazon Linux running PHP 5.4" }, { "PermittedFileTypes": [ "zip" ], "SolutionStackName": "32bit Amazon Linux running PHP 5.3" }, { "PermittedFileTypes": [ "zip" ], "SolutionStackName": "64bit Amazon Linux running PHP 5.3" }, { "PermittedFileTypes": [ ".zip", ".war" ], "SolutionStackName": "32bit Amazon Linux running Node.js" }, { "PermittedFileTypes": [ ".zip", ".war" ], "SolutionStackName": "64bit Amazon Linux running Node.js" }, { "PermittedFileTypes": [ "zip" ], "SolutionStackName": "64bit Windows Server 2008 R2 running IIS 7.5" }, { "PermittedFileTypes": [ "zip" ], "SolutionStackName": "64bit Windows Server 2012 running IIS 8" }, { "PermittedFileTypes": [ "war", "zip" ], "SolutionStackName": "32bit Amazon Linux running Tomcat 7" }, { "PermittedFileTypes": [ "war", "zip" ], "SolutionStackName": "64bit Amazon Linux running Tomcat 7" }, { "PermittedFileTypes": [ "war", "zip" ], "SolutionStackName": "32bit Amazon Linux running Tomcat 6" }, { "PermittedFileTypes": [ "war", "zip" ], "SolutionStackName": "64bit Amazon Linux running Tomcat 6" }, { "PermittedFileTypes": [ "zip" ], "SolutionStackName": "32bit Amazon Linux running Python" }, { "PermittedFileTypes": [ "zip" ], "SolutionStackName": "64bit Amazon Linux running Python" }, { "PermittedFileTypes": [ "war", "zip" ], "SolutionStackName": "32bit Amazon Linux running Ruby 1.8.7" }, { "PermittedFileTypes": [ "war", "zip" ], "SolutionStackName": "64bit Amazon Linux running Ruby 1.8.7" }, { "PermittedFileTypes": [ "zip", "war" ], "SolutionStackName": "32bit Amazon Linux running Ruby 1.9.3" }, { "PermittedFileTypes": [ "war", "zip" ], "SolutionStackName": "64bit Amazon Linux running Ruby 1.9.3" } ] }botocore-1.5.7/tests/unit/response_parsing/xml/responses/elb-describe-load-balancer-policy-types.xml0000666454262600001440000005450713042511306035126 0ustar pysdk-ciamazon00000000000000 CookieExpirationPeriod Long ZERO_OR_ONE LBCookieStickinessPolicyType Stickiness policy with session lifetimes controlled by the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners. PublicKeyPolicyName PolicyName ONE_OR_MORE BackendServerAuthenticationPolicyType Policy that controls authentication to back-end server(s) and contains one or more policies, such as an instance of a PublicKeyPolicyType. This policy can be associated only with back-end servers that are using HTTPS/SSL. Protocol-SSLv2 A description for Protocol-SSLv2 Boolean false ZERO_OR_ONE Protocol-TLSv1 A description for Protocol-TLSv1 Boolean true ZERO_OR_ONE Protocol-SSLv3 A description for Protocol-SSLv3 Boolean true ZERO_OR_ONE DHE-RSA-AES256-SHA A description for DHE-RSA-AES256-SHA Boolean false ZERO_OR_ONE DHE-DSS-AES256-SHA A description for DHE-DSS-AES256-SHA Boolean false ZERO_OR_ONE DHE-RSA-CAMELLIA256-SHA A description for DHE-RSA-CAMELLIA256-SHA Boolean false ZERO_OR_ONE DHE-DSS-CAMELLIA256-SHA A description for DHE-DSS-CAMELLIA256-SHA Boolean false ZERO_OR_ONE ADH-AES256-SHA A description for ADH-AES256-SHA Boolean false ZERO_OR_ONE ADH-CAMELLIA256-SHA A description for ADH-CAMELLIA256-SHA Boolean false ZERO_OR_ONE AES256-SHA A description for AES256-SHA Boolean true ZERO_OR_ONE CAMELLIA256-SHA A description for CAMELLIA256-SHA Boolean false ZERO_OR_ONE PSK-AES256-CBC-SHA A description for PSK-AES256-CBC-SHA Boolean false ZERO_OR_ONE EDH-RSA-DES-CBC3-SHA A description for EDH-RSA-DES-CBC3-SHA Boolean false ZERO_OR_ONE EDH-DSS-DES-CBC3-SHA A description for EDH-DSS-DES-CBC3-SHA Boolean false ZERO_OR_ONE ADH-DES-CBC3-SHA A description for ADH-DES-CBC3-SHA Boolean false ZERO_OR_ONE DES-CBC3-SHA A description for DES-CBC3-SHA Boolean true ZERO_OR_ONE DES-CBC3-MD5 A description for DES-CBC3-MD5 Boolean false ZERO_OR_ONE PSK-3DES-EDE-CBC-SHA A description for PSK-3DES-EDE-CBC-SHA Boolean false ZERO_OR_ONE KRB5-DES-CBC3-SHA A description for KRB5-DES-CBC3-SHA Boolean false ZERO_OR_ONE KRB5-DES-CBC3-MD5 A description for KRB5-DES-CBC3-MD5 Boolean false ZERO_OR_ONE DHE-RSA-AES128-SHA A description for DHE-RSA-AES128-SHA Boolean false ZERO_OR_ONE DHE-DSS-AES128-SHA A description for DHE-DSS-AES128-SHA Boolean false ZERO_OR_ONE DHE-RSA-SEED-SHA A description for DHE-RSA-SEED-SHA Boolean false ZERO_OR_ONE DHE-DSS-SEED-SHA A description for DHE-DSS-SEED-SHA Boolean false ZERO_OR_ONE DHE-RSA-CAMELLIA128-SHA A description for DHE-RSA-CAMELLIA128-SHA Boolean false ZERO_OR_ONE DHE-DSS-CAMELLIA128-SHA A description for DHE-DSS-CAMELLIA128-SHA Boolean false ZERO_OR_ONE ADH-AES128-SHA A description for ADH-AES128-SHA Boolean false ZERO_OR_ONE ADH-SEED-SHA A description for ADH-SEED-SHA Boolean false ZERO_OR_ONE ADH-CAMELLIA128-SHA A description for ADH-CAMELLIA128-SHA Boolean false ZERO_OR_ONE AES128-SHA A description for AES128-SHA Boolean true ZERO_OR_ONE SEED-SHA A description for SEED-SHA Boolean false ZERO_OR_ONE CAMELLIA128-SHA A description for CAMELLIA128-SHA Boolean false ZERO_OR_ONE RC2-CBC-MD5 A description for RC2-CBC-MD5 Boolean false ZERO_OR_ONE PSK-AES128-CBC-SHA A description for PSK-AES128-CBC-SHA Boolean false ZERO_OR_ONE ADH-RC4-MD5 A description for ADH-RC4-MD5 Boolean false ZERO_OR_ONE IDEA-CBC-SHA A description for IDEA-CBC-SHA Boolean false ZERO_OR_ONE RC4-SHA A description for RC4-SHA Boolean true ZERO_OR_ONE RC4-MD5 A description for RC4-MD5 Boolean true ZERO_OR_ONE PSK-RC4-SHA A description for PSK-RC4-SHA Boolean false ZERO_OR_ONE KRB5-RC4-SHA A description for KRB5-RC4-SHA Boolean false ZERO_OR_ONE KRB5-RC4-MD5 A description for KRB5-RC4-MD5 Boolean false ZERO_OR_ONE EDH-RSA-DES-CBC-SHA A description for EDH-RSA-DES-CBC-SHA Boolean false ZERO_OR_ONE EDH-DSS-DES-CBC-SHA A description for EDH-DSS-DES-CBC-SHA Boolean false ZERO_OR_ONE ADH-DES-CBC-SHA A description for ADH-DES-CBC-SHA Boolean false ZERO_OR_ONE DES-CBC-SHA A description for DES-CBC-SHA Boolean false ZERO_OR_ONE DES-CBC-MD5 A description for DES-CBC-MD5 Boolean false ZERO_OR_ONE KRB5-DES-CBC-SHA A description for KRB5-DES-CBC-SHA Boolean false ZERO_OR_ONE KRB5-DES-CBC-MD5 A description for KRB5-DES-CBC-MD5 Boolean false ZERO_OR_ONE EXP-EDH-RSA-DES-CBC-SHA A description for EXP-EDH-RSA-DES-CBC-SHA Boolean false ZERO_OR_ONE EXP-EDH-DSS-DES-CBC-SHA A description for EXP-EDH-DSS-DES-CBC-SHA Boolean false ZERO_OR_ONE EXP-ADH-DES-CBC-SHA A description for EXP-ADH-DES-CBC-SHA Boolean false ZERO_OR_ONE EXP-DES-CBC-SHA A description for EXP-DES-CBC-SHA Boolean false ZERO_OR_ONE EXP-RC2-CBC-MD5 A description for EXP-RC2-CBC-MD5 Boolean false ZERO_OR_ONE EXP-KRB5-RC2-CBC-SHA A description for EXP-KRB5-RC2-CBC-SHA Boolean false ZERO_OR_ONE EXP-KRB5-DES-CBC-SHA A description for EXP-KRB5-DES-CBC-SHA Boolean false ZERO_OR_ONE EXP-KRB5-RC2-CBC-MD5 A description for EXP-KRB5-RC2-CBC-MD5 Boolean false ZERO_OR_ONE EXP-KRB5-DES-CBC-MD5 A description for EXP-KRB5-DES-CBC-MD5 Boolean false ZERO_OR_ONE EXP-ADH-RC4-MD5 A description for EXP-ADH-RC4-MD5 Boolean false ZERO_OR_ONE EXP-RC4-MD5 A description for EXP-RC4-MD5 Boolean false ZERO_OR_ONE EXP-KRB5-RC4-SHA A description for EXP-KRB5-RC4-SHA Boolean false ZERO_OR_ONE EXP-KRB5-RC4-MD5 A description for EXP-KRB5-RC4-MD5 Boolean false ZERO_OR_ONE SSLNegotiationPolicyType Listener policy that defines the ciphers and protocols that will be accepted by the load balancer. This policy can be associated only with HTTPS/SSL listeners. PublicKey String ONE PublicKeyPolicyType Policy containing a list of public keys to accept when authenticating the back-end server(s). This policy cannot be applied directly to back-end servers or listeners but must be part of a BackendServerAuthenticationPolicyType. CookieName String ONE AppCookieStickinessPolicyType Stickiness policy with session lifetimes controlled by the lifetime of the application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners. ab7c8724-9167-11e2-b472-75a63fc08e7f botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-events.xml0000666454262600001440000000364013042511306034046 0ustar pysdk-ciamazon00000000000000 Successfully completed createEnvironment activity. 2010-11-17T20:25:35.191Z New Version bb01fa74-f287-11df-8a78-9f77047e0d0c SampleApp SampleAppVersion INFO Launching a new EC2 instance: i-04a8c569 2010-11-17T20:21:30Z New Version SampleApp SampleAppVersion DEBUG At least one EC2 instance has entered the InService lifecycle state. 2010-11-17T20:20:32.008Z New Version bb01fa74-f287-11df-8a78-9f77047e0d0c SampleApp SampleAppVersion INFO Elastic Load Balancer elasticbeanstalk-SampleAppVersion has failed 0 healthy instances - Environment may not be available. 2010-11-17T20:19:28Z New Version SampleApp SampleAppVersion WARN f10d02dd-f288-11df-8a78-9f77047e0d0c botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-addresses.json0000666454262600001440000000076413042511306032034 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "b4cfd51c-a092-494f-8ee0-59912bef0ccc" }, "Addresses": [ { "PublicIp": "54.245.81.77", "InstanceId": "", "Domain": "standard" }, { "PublicIp": "54.245.99.8", "InstanceId": "", "Domain": "standard" }, { "PublicIp": "50.112.139.73", "Domain": "vpc", "AllocationId": "eipalloc-312e1758" } ] } botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-get-subscription-attributes.json0000666454262600001440000000052613042511306034114 0ustar pysdk-ciamazon00000000000000{ "Attributes": { "Owner": "123456789012", "DeliveryPolicy": "{\"healthyRetryPolicy\":{\"numRetries\":10}}", "SubscriptionArn": "arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca" }, "ResponseMetadata": { "RequestId": "057f074c-33a7-11df-9540-99d0768312d3" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-delete-cluster.xml0000666454262600001440000000326713042511306032211 0ustar pysdk-ciamazon00000000000000 1.0 5439
examplecluster2.cobbanlpscsn.us-east-1.redshift.amazonaws.com
 deleting 2 1 true true dev sun:10:30-sun:11:00 in-sync default.redshift-1.0 2013-01-23T00:11:32.804Z active default us-east-1a dw.hs1.xlarge examplecluster2 true masteruser f2e6b87e-6503-11e2-b343-393adc3f0a21 botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-add-permission.xml0000666454262600001440000000033013042511306031170 0ustar pysdk-ciamazon00000000000000 9a285199-c8d6-47c2-bdb2-314cb47d599d botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-get-bucket-policy.xml0000666454262600001440000000023113042511306031320 0ustar pysdk-ciamazon00000000000000{"Version":"2012-10-17","Statement":[{"Sid":"AddPerm","Effect":"Allow","Principal":"*","Action":"s3:GetObject","Resource":"arn:aws:s3:::bucket-name/*"}]}botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-bundle-tasks.xml0000666454262600001440000000132613042511306032275 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-12345678 bun-c1a540a8 cancelling 2008-10-07T11:41:50.000Z 2008-10-07T11:51:50.000Z myawsbucket winami 20% ././@LongLink0000000000000000000000000000015200000000000011213 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-metric-collection-types.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-metric-collection-type0000666454262600001440000000175113042511306035337 0ustar pysdk-ciamazon00000000000000 GroupMinSize GroupMaxSize GroupDesiredCapacity GroupInServiceInstances GroupPendingInstances GroupTerminatingInstances GroupTotalInstances 1Minute 6794a54b-9167-11e2-9223-abe83dfc0567 botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-update-application.json0000666454262600001440000000067413042511306034724 0ustar pysdk-ciamazon00000000000000{ "Application": { "ApplicationName": "SampleApp", "Description": "Another Description", "Versions": [ "New Version" ], "DateCreated": "2010-11-17T19:26:20.410Z", "ConfigurationTemplates": [ "Default" ], "DateUpdated": "2010-11-17T20:42:54.611Z" }, "ResponseMetadata": { "RequestId": "40be666b-f28b-11df-8a78-9f77047e0d0c" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-request-spot-instances.xml0000666454262600001440000000212713042511306032563 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE sir-1a2b3c4d 0.5 one-time open MyAzGroup ami-1a2b3c4d m1.small false false YYYY-MM-DDTHH:MM:SS.000Z Linux/UNIX botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-key-pairs.xml0000666454262600001440000000061113042511306031601 0ustar pysdk-ciamazon00000000000000 f01984fe-0227-46e0-bd34-86fadf256477 aws d1:15:f0:ce:7f:ee:94:b5:f2:76:d0:9a:bd:b2:30:18 ././@LongLink0000000000000000000000000000014700000000000011217 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-groups.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-groups.js0000666454262600001440000000017513042511306035261 0ustar pysdk-ciamazon00000000000000{ "AutoScalingGroups": [], "ResponseMetadata": { "RequestId": "681e6e72-9167-11e2-ba50-d18200895d59" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-dhcp-options.xml0000666454262600001440000000173113042511306032310 0ustar pysdk-ciamazon00000000000000 684ba87f-78a1-4c29-a70b-f6103a15c162 dopt-eb291082 domain-name us-west-2.compute.internal domain-name-servers AmazonProvidedDNS botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-reserved-instances.xml0000666454262600001440000000165113042511306033506 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE 4b2293b4-5813-4cc8-9ce3-1957fc1dcfc8EXAMPLE m1.xlarge us-east-1a 31536000 1820.0 0.24 3 Linux/UNIX active default USD Light Utilization botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-list-invalidations.json0000666454262600001440000000074313042511306033621 0ustar pysdk-ciamazon00000000000000{ "InvalidationList": { "Items": [ { "Status": "Completed", "Id": "Second Invalidation ID" }, { "Status": "Completed", "Id": "First Invalidation ID" } ], "NextMarker": "Invalidation ID", "MaxItems": 2, "Marker": "EGTXBD79EXAMPLE", "IsTruncated": true, "Quantity": 10 }, "ResponseMetadata": {} }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-export-tasks.json0000666454262600001440000000132013042511306032510 0ustar pysdk-ciamazon00000000000000{"ExportTasks": [{"Description": "Example for docs", "ExportTaskId": "export-i-1234wxyz", "ExportToS3Task": {"ContainerFormat": "OVA", "DiskImageFormat": "VMDK", "S3Bucket": "my-bucket-for-exported-vm", "S3Key": "my-exports/ export-i-1234wxyz .ova"}, "InstanceExportDetails": {"InstanceId": "i-12345678", "TargetEnvironment": "VMWare"}, "State": "active", "StatusMessage": "Running"}], "ResponseMetadata": {"RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE"}} ././@LongLink0000000000000000000000000000015000000000000011211 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-parameter-groups.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-parameter-groups.0000666454262600001440000000160713042511306035275 0ustar pysdk-ciamazon00000000000000 redshift-1.0 Default parameter group for redshift-1.0 default.redshift-1.0 redshift-1.0 description my parameter group parametergroup1 6d28788b-64f5-11e2-b343-393adc3f0a21 ././@LongLink0000000000000000000000000000014600000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-subnet-groups.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-subnet-groups.jso0000666454262600001440000000113313042511306035323 0ustar pysdk-ciamazon00000000000000{"ClusterSubnetGroups": [ {"ClusterSubnetGroupName": "my-subnet-group", "Description": "my subnet group", "SubnetGroupStatus": "Complete", "Subnets": [{"SubnetAvailabilityZone": {"Name": "us-east-1a"}, "SubnetIdentifier": "subnet-71c5091c", "SubnetStatus": "Active"}, {"SubnetAvailabilityZone": {"Name": "us-east-1a"}, "SubnetIdentifier": "subnet-78de1215", "SubnetStatus": "Active"}], "VpcId": "vpc-5d917a30"}], "ResponseMetadata": {"RequestId": "42024b68-6af3-11e2-a726-6368a468fa67"} } botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-delete-message-batch.xml0000666454262600001440000000076613042511306032232 0ustar pysdk-ciamazon00000000000000 msg1 msg2 d6f86b7a-74d1-4439-b43f-196a1e29cd85 botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-applications.json0000666454262600001440000000063713042511306035404 0ustar pysdk-ciamazon00000000000000{"Applications": [{"ApplicationName": "SampleApplication", "ConfigurationTemplates": ["Default"], "DateCreated": "2010-11-16T20:20:51.974Z", "DateUpdated": "2010-11-16T20:20:51.974Z", "Description": "Sample Description", "Versions": []}], "ResponseMetadata": {"RequestId": "577c70ff-f1d7-11df-8a78-9f77047e0d0c"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-register-image.xml0000666454262600001440000000030213042511306031020 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE ami-1a2b3c4d botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-send-raw-email.json0000666454262600001440000000026113042511306031217 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "e0abcdfa-c866-11e0-b6d0-273d09173b49" }, "MessageId": "00000131d51d6b36-1d4f9293-0aee-4503-b573-9ae4e70e9e38-000000" }botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudformation-describe-stacks.xml0000666454262600001440000000043313042511306033543 0ustar pysdk-ciamazon00000000000000 ad4c8bf2-9167-11e2-991c-f387408da2bf botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-delete-message-batch.json0000666454262600001440000000033013042511306032366 0ustar pysdk-ciamazon00000000000000{ "Successful": [ { "Id": "msg1" }, { "Id": "msg2" } ], "ResponseMetadata": { "RequestId": "d6f86b7a-74d1-4439-b43f-196a1e29cd85" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-volume-status.json0000666454262600001440000000233313042511306032701 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "2e8b63e6-0016-4fa8-9cf0-49bcaa991c6b" }, "VolumeStatuses": [ { "VolumeStatus": { "Status": "ok", "Details": [ { "Status": "passed", "Name": "io-enabled" }, { "Status": "not-applicable", "Name": "io-performance" } ] }, "AvailabilityZone": "us-west-2a", "VolumeId": "vol-bc71579a", "Actions": [], "Events": [] }, { "VolumeStatus": { "Status": "ok", "Details": [ { "Status": "passed", "Name": "io-enabled" }, { "Status": "not-applicable", "Name": "io-performance" } ] }, "AvailabilityZone": "us-west-2b", "VolumeId": "vol-a8d2e991", "Actions": [], "Events": [] } ] } botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-event-categories.xml0000666454262600001440000000361213042511306033264 0ustar pysdk-ciamazon00000000000000 db-instance maintenance creation backup low storage configuration change failover restoration availability deletion notification recovery failure db-security-group configuration change failure db-parameter-group configuration change db-snapshot creation restoration deletion aa1184e4-9167-11e2-b6fb-e599bc501f26 botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-publish.xml0000666454262600001440000000044613042511306027725 0ustar pysdk-ciamazon00000000000000 94f20ce6-13c5-43a0-9a9e-ca52d816e90b f187a3c1-376f-11df-8963-01868b7c937a botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-instances.json0000666454262600001440000001260513042511306032043 0ustar pysdk-ciamazon00000000000000{ "Reservations": [ { "OwnerId": "123456789012", "ReservationId": "r-9b4f3ca8", "Groups": [ { "GroupName": "notebook", "GroupId": "sg-4e970e7e" } ], "Instances": [ { "Monitoring": { "State": "disabled" }, "PublicDnsName": "", "KernelId": "aki-98e26fa8", "State": { "Code": 80, "Name": "stopped" }, "EbsOptimized": false, "LaunchTime": "2012-10-16T20:00:13.000Z", "ProductCodes": [], "StateTransitionReason": "User initiated (2013-03-01 17:24:16 GMT)", "InstanceId": "i-fde9cece", "ImageId": "ami-30fe7300", "PrivateDnsName": "", "KeyName": "aws", "SecurityGroups": [ { "GroupName": "notebook", "GroupId": "sg-4e970e7e" } ], "ClientToken": "", "InstanceType": "m1.small", "NetworkInterfaces": [], "Placement": { "Tenancy": "default", "GroupName": "", "AvailabilityZone": "us-west-2a" }, "Hypervisor": "xen", "BlockDeviceMappings": [ { "DeviceName": "/dev/sda1", "Ebs": { "Status": "attached", "DeleteOnTermination": true, "VolumeId": "vol-bc71579a", "AttachTime": "2012-10-16T20:00:21.000Z" } } ], "Architecture": "x86_64", "StateReason": { "Message": "Client.UserInitiatedShutdown: User initiated shutdown", "Code": "Client.UserInitiatedShutdown" }, "RootDeviceName": "/dev/sda1", "VirtualizationType": "paravirtual", "RootDeviceType": "ebs", "Tags": [ { "Value": "", "Key": "notebook" } ], "AmiLaunchIndex": 0 } ] }, { "OwnerId": "123456789012", "ReservationId": "r-6670ce54", "Groups": [ { "GroupName": "quicklaunch-1", "GroupId": "sg-72334242" } ], "Instances": [ { "Monitoring": { "State": "disabled" }, "PublicDnsName": "ec2-54-245-16-142.us-west-2.compute.amazonaws.com", "Platform": "windows", "State": { "Code": 16, "Name": "running" }, "EbsOptimized": false, "LaunchTime": "2013-03-12T01:55:59.000Z", "PublicIpAddress": "54.245.16.142", "PrivateIpAddress": "10.253.17.74", "ProductCodes": [], "StateTransitionReason": "", "InstanceId": "i-78f1b94a", "ImageId": "ami-c4d643f4", "PrivateDnsName": "ip-10-253-17-74.us-west-2.compute.internal", "KeyName": "aws", "SecurityGroups": [ { "GroupName": "quicklaunch-1", "GroupId": "sg-72334242" } ], "ClientToken": "aOJaC1362847444140", "InstanceType": "m1.medium", "NetworkInterfaces": [], "Placement": { "Tenancy": "default", "GroupName": "", "AvailabilityZone": "us-west-2b" }, "Hypervisor": "xen", "BlockDeviceMappings": [ { "DeviceName": "/dev/sda1", "Ebs": { "Status": "attached", "DeleteOnTermination": true, "VolumeId": "vol-a8d2e991", "AttachTime": "2013-03-09T16:44:07.000Z" } } ], "Architecture": "x86_64", "RootDeviceType": "ebs", "RootDeviceName": "/dev/sda1", "VirtualizationType": "hvm", "AmiLaunchIndex": 0 } ] } ], "ResponseMetadata": { "RequestId": "d15d204f-fc31-4600-85d3-5c86e5483b92" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-delete-application.xml0000666454262600001440000000034313042511306034524 0ustar pysdk-ciamazon00000000000000 1f155abd-f1d7-11df-8a78-9f77047e0d0c botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-signing-certificates.xml0000666454262600001440000000302613042511306033271 0ustar pysdk-ciamazon00000000000000 Bob Bob TA7SMP42TDN5Z26OBPJE7EXAMPLE -----BEGIN CERTIFICATE----- MIICdzCCAeCgAwIBAgIGANc+Ha2wMA0GCSqGSIb3DQEBBQUAMFMxCzAJBgNVBAYT AlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMQwwCgYDVQQLEwNBV1MxITAfBgNVBAMT GEFXUyBMaW1pdGVkLUFzc3VyYW5jZSBDQTAeFw0wOTAyMDQxNzE5MjdaFw0xMDAy MDQxNzE5MjdaMFIxCzAJBgNVBAYTAlVTMRMwEQYDVQQKEwpBbWF6b24uY29tMRcw FQYDVQQLEw5BV1MtRGV2ZWxvcGVyczEVMBMGA1UEAxMMNTdxNDl0c3ZwYjRtMIGf MA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCpB/vsOwmT/O0td1RqzKjttSBaPjbr dqwNe9BrOyB08fw2+Ch5oonZYXfGUrT6mkYXH5fQot9HvASrzAKHO596FdJA6DmL ywdWe1Oggk7zFSXO1Xv+3vPrJtaYxYo3eRIp7w80PMkiOv6M0XK8ubcTouODeJbf suDqcLnLDxwsvwIDAQABo1cwVTAOBgNVHQ8BAf8EBAMCBaAwFgYDVR0lAQH/BAww CgYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQULGNaBphBumaKbDRK CAi0mH8B3mowDQYJKoZIhvcNAQEFBQADgYEAuKxhkXaCLGcqDuweKtO/AEw9ZePH wr0XqsaIK2HZboqruebXEGsojK4Ks0WzwgrEynuHJwTn760xe39rSqXWIOGrOBaX wFpWHVjTFMKk+tSDG1lssLHyYWWdFFU4AnejRGORJYNaRHgVTKjHphc5jEhHm0BX AEaHzTpmEXAMPLE= -----END CERTIFICATE----- Active false 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-export-tasks.xml0000666454262600001440000000143513042511306032346 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE export-i-1234wxyz Example for docs active Running i-12345678 VMWare VMDK OVA my-bucket-for-exported-vm my-exports/ export-i-1234wxyz .ova ././@LongLink0000000000000000000000000000015700000000000011220 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-authorize-cluster-security-group-ingress.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-authorize-cluster-security-group-i0000666454262600001440000000130713042511306035400 0ustar pysdk-ciamazon00000000000000 192.168.40.3/32 authorized my security group securitygroup1 8c7cd4c8-6501-11e2-a8da-655adc216806 botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-list-topics.xml0000666454262600001440000000056513042511306030533 0ustar pysdk-ciamazon00000000000000 arn:aws:sns:us-east-1:123456789012:My-Topic 3f1478c7-33a9-11df-9540-99d0768312d3 botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-resize.json0000666454262600001440000000034713042511306032514 0ustar pysdk-ciamazon00000000000000{ "Status": "SUCCEEDED", "ResponseMetadata": { "RequestId": "ff826bc5-a157-11e2-98d4-3b276285f8df" }, "TargetClusterType": "multi-node", "TargetNodeType": "db.m2.4xlarge", "TargetNumberOfNodes": 2 } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-bundle-instance.xml0000666454262600001440000000112313042511306031171 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-12345678 bun-c1a540a8 bundling 2008-10-07T11:41:50.000Z 2008-10-07T11:51:50.000Z 70% myawsbucket winami botocore-1.5.7/tests/unit/response_parsing/xml/responses/elb-describe-load-balancers.json0000666454262600001440000000020413042511306033004 0ustar pysdk-ciamazon00000000000000{ "LoadBalancerDescriptions": [], "ResponseMetadata": { "RequestId": "ab548cc1-9167-11e2-b472-75a63fc08e7f" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-get-send-quota.json0000666454262600001440000000026013042511306031246 0ustar pysdk-ciamazon00000000000000{ "Max24HourSend": 200.0, "ResponseMetadata": { "RequestId": "65a6913a-9167-11e2-9374-7d889fec53f7" }, "SentLast24Hours": 0.0, "MaxSendRate": 1.0 } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-instance-status.json0000666454262600001440000000152713042511306033202 0ustar pysdk-ciamazon00000000000000{ "InstanceStatuses": [ { "InstanceId": "i-78f1b94a", "InstanceState": { "Code": 16, "Name": "running" }, "AvailabilityZone": "us-west-2b", "SystemStatus": { "Status": "ok", "Details": [ { "Status": "passed", "Name": "reachability" } ] }, "InstanceStatus": { "Status": "ok", "Details": [ { "Status": "passed", "Name": "reachability" } ] } } ], "ResponseMetadata": { "RequestId": "8be1454b-ea0f-4037-9911-b48eda6d79c8" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-vpc.json0000666454262600001440000000047513042511306030331 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE" }, "Vpc": { "VpcId": "vpc-1a2b3c4d", "InstanceTenancy": "default", "Tags": [], "State": "pending", "DhcpOptionsId": "dopt-1a2b3c4d2", "CidrBlock": "10.0.0.0/16" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-list-queues.xml0000666454262600001440000000066013042511306030540 0ustar pysdk-ciamazon00000000000000 https://us-west-2.queue.amazonaws.com/123456789012/foobar https://us-west-2.queue.amazonaws.com/123456789012/fiebaz 517c6371-751f-5711-9ebc-2ab2b1a92268 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-monitor-instances.json0000666454262600001440000000063213042511306031747 0ustar pysdk-ciamazon00000000000000{ "InstanceMonitorings": [ { "InstanceId": "i-43a4412a", "Monitoring": { "State": "pending" } }, { "InstanceId": "i-23a3397d", "Monitoring": { "State": "pending" } } ], "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-get-bucket-logging.json0000666454262600001440000000061613042511306031627 0ustar pysdk-ciamazon00000000000000{ "LoggingEnabled": { "TargetPrefix": "mybucket-access_log-/", "TargetBucket": "mybucketlogs", "TargetGrants": [ { "Grantee": { "EmailAddress": "user@company.com", "Type": "AmazonCustomerByEmail" }, "Permission": "READ" } ] }, "ResponseMetadata": {} } botocore-1.5.7/tests/unit/response_parsing/xml/responses/elb-describe-load-balancers.xml0000666454262600001440000000051713042511306032642 0ustar pysdk-ciamazon00000000000000 ab548cc1-9167-11e2-b472-75a63fc08e7f botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-get-bucket-location.json0000666454262600001440000000010013042511306031775 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": {}, "LocationConstraint": "EU" } botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudwatch-describe-alarms.json0000666454262600001440000000017013042511306033011 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "ac11e96c-9167-11e2-bb93-654a565d340b" }, "MetricAlarms": [] }././@LongLink0000000000000000000000000000015300000000000011214 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-reserved-db-instances-offerings.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-reserved-db-instances-offering0000666454262600001440000000333413042511306035206 0ustar pysdk-ciamazon00000000000000{ "Marker": "M2E5OGJmN2QtYjRjNi00NzNmLWI4MGMtYmFkNzFmNzA2YzUw", "ResponseMetadata": { "RequestId": "aa4fed7d-9167-11e2-b691-fdba749921d2" }, "ReservedDBInstancesOfferings": [ { "MultiAZ": false, "OfferingType": "Heavy Utilization", "FixedPrice": 2058.0, "UsagePrice": 0.0, "ReservedDBInstancesOfferingId": "248e7b75-0815-427d-a429-b0fed4633e8c", "RecurringCharges": [ { "RecurringChargeAmount": 0.139, "RecurringChargeFrequency": "Hourly" } ], "ProductDescription": "oracle-se1(li)", "Duration": 94608000, "DBInstanceClass": "db.m1.large", "CurrencyCode": "USD" }, { "MultiAZ": false, "OfferingType": "Light Utilization", "FixedPrice": 548.0, "UsagePrice": 0.234, "ReservedDBInstancesOfferingId": "248e7b75-09fe-4f1d-afbc-296929db4f47", "RecurringCharges": [], "ProductDescription": "oracle-ee(byol)", "Duration": 94608000, "DBInstanceClass": "db.m2.xlarge", "CurrencyCode": "USD" }, { "MultiAZ": true, "OfferingType": "Light Utilization", "FixedPrice": 2512.0, "UsagePrice": 1.026, "ReservedDBInstancesOfferingId": "248e7b75-0a34-4615-b83c-e4b445862054", "RecurringCharges": [], "ProductDescription": "oracle-se1(li)", "Duration": 94608000, "DBInstanceClass": "db.m1.xlarge", "CurrencyCode": "USD" } ] }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-send-email.xml0000666454262600001440000000050613042511306030261 0ustar pysdk-ciamazon00000000000000 00000131d51d2292-159ad6eb-077c-46e6-ad09-ae7c05925ed4-000000 d5964849-c866-11e0-9beb-01a62d68c57f botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-route-tables.xml0000666454262600001440000000411313042511306032304 0ustar pysdk-ciamazon00000000000000 0a0c3fc4-1246-463b-b276-2823b5bc38e6 rtb-2728114e vpc-8d2910e4 10.0.0.0/16 local active CreateRouteTable 0.0.0.0/0 igw-6228110b active CreateRoute rtbassoc-822019eb rtb-2728114e subnet-812910e8 rtb-8f2910e6 vpc-8d2910e4 10.0.0.0/16 local active CreateRouteTable rtbassoc-8e2910e7 rtb-8f2910e6
true
 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-associate-route-table.xml0000666454262600001440000000034113042511306032313 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE rtbassoc-f8ad4891 botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-create-queue.json0000666454262600001440000000025513042511306031016 0ustar pysdk-ciamazon00000000000000{ "QueueUrl": "http://sqs.us-east-1.amazonaws.com/123456789012/testQueue", "ResponseMetadata": { "RequestId": "7a62c49f-347e-4fc4-9331-6e8e7a96aa73" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-adjustment-types.xml0000666454262600001440000000115213042511306035056 0ustar pysdk-ciamazon00000000000000 ChangeInCapacity ExactCapacity PercentChangeInCapacity 6782caf9-9167-11e2-9223-abe83dfc0567 ././@LongLink0000000000000000000000000000014700000000000011217 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-storage-location.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-storage-location.js0000666454262600001440000000023313042511306035306 0ustar pysdk-ciamazon00000000000000{ "S3Bucket": "elasticbeanstalk-us-east-1-780612358023", "ResponseMetadata": { "RequestId": "ef51b94a-f1d6-11df-8a78-9f77047e0d0c" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-get-bucket-acl.xml0000666454262600001440000000115413042511306030565 0ustar pysdk-ciamazon00000000000000 75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a CustomersName@amazon.com 75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a CustomersName@amazon.com FULL_CONTROL  botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-verify-domain-dkim.json0000666454262600001440000000043413042511306032107 0ustar pysdk-ciamazon00000000000000{ "DkimTokens": [ "vvjuipp74whm76gqoni7qmwwn4w4qusjiainivf6sf", "3frqe7jn4obpuxjpwpolz6ipb3k5nvt2nhjpik2oy", "wrqplteh7oodxnad7hsl4mixg2uavzneazxv5sxi2" ], "ResponseMetadata": { "RequestId": "9662c15b-c469-11e1-99d1-797d6ecd6414" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-confirm-subscription.json0000666454262600001440000000031313042511306032600 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "7a50221f-3774-11df-a9b7-05d48da6f042" }, "SubscriptionArn": "arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca" }botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-db-snapshots.json0000666454262600001440000000410313042511306032572 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "c4191173-8506-11e0-90aa-eb648410240d" }, "DBSnapshots": [ { "Engine": "mysql", "SnapshotCreateTime": "2011-05-23T06:29:03.483Z", "AvailabilityZone": "us-east-1a", "MasterUsername": "master", "LicenseModel": "general-public-license", "Status": "available", "DBSnapshotIdentifier": "mydbsnapshot", "InstanceCreateTime": "2011-05-23T06:06:43.110Z", "OptionGroupName": "myoptiongroupname", "AllocatedStorage": 10, "EngineVersion": "5.1.50", "SnapshotType": "manual", "Port": 3306, "DBInstanceIdentifier": "simcoprod01" }, { "Engine": "mysql", "SnapshotCreateTime": "2011-03-11T07:20:24.082Z", "AvailabilityZone": "us-east-1a", "MasterUsername": "sa", "LicenseModel": "general-public-license", "Status": "available", "DBSnapshotIdentifier": "mysnapshot1", "InstanceCreateTime": "2010-08-04T23:27:36.420Z", "OptionGroupName": "myoptiongroupname", "AllocatedStorage": 50, "EngineVersion": "5.1.49", "SnapshotType": "manual", "Port": 3306, "DBInstanceIdentifier": "mydbinstance" }, { "Engine": "mysql", "SnapshotCreateTime": "2012-04-02T00:01:24.082Z", "AvailabilityZone": "us-east-1d", "MasterUsername": "master", "LicenseModel": "general-public-license", "Status": "available", "DBSnapshotIdentifier": "rds:simcoprod01-2012-04-02-00-01", "InstanceCreateTime": "2010-07-16T00:06:59.107Z", "OptionGroupName": "myoptiongroupname", "AllocatedStorage": 60, "EngineVersion": "5.1.47", "SnapshotType": "automated", "Port": 3306, "DBInstanceIdentifier": "simcoprod01" } ] }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-get-send-quota.xml0000666454262600001440000000056113042511306031101 0ustar pysdk-ciamazon00000000000000 0.0 200.0 1.0 65a6913a-9167-11e2-9374-7d889fec53f7 botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-resize.xml0000666454262600001440000000070013042511306032334 0ustar pysdk-ciamazon00000000000000 multi-node SUCCEEDED db.m2.4xlarge 2 ff826bc5-a157-11e2-98d4-3b276285f8df botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-get-subscription-attributes.xml0000666454262600001440000000132213042511306033736 0ustar pysdk-ciamazon00000000000000 Owner 123456789012 DeliveryPolicy {"healthyRetryPolicy":{"numRetries":10}} SubscriptionArn arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca 057f074c-33a7-11df-9540-99d0768312d3 botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-create-cluster-snapshot.json0000666454262600001440000000117113042511306034210 0ustar pysdk-ciamazon00000000000000{ "Snapshot": { "Status": "creating", "SnapshotCreateTime": "2013-01-23T01:08:29.142Z", "AvailabilityZone": "us-east-1c", "ClusterVersion": "1.0", "MasterUsername": "adminuser", "DBName": "dev", "ClusterCreateTime": "2013-01-22T19:23:59.368Z", "SnapshotType": "manual", "NodeType": "dw.hs1.xlarge", "ClusterIdentifier": "examplecluster", "Port": 5439, "NumberOfNodes": 2, "SnapshotIdentifier": "my-snapshot-123" }, "ResponseMetadata": { "RequestId": "65baef14-64f9-11e2-bea9-49e0ce183f07" } }././@LongLink0000000000000000000000000000015400000000000011215 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-configuration-template.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-configuration-templ0000666454262600001440000001624013042511306035414 0ustar pysdk-ciamazon00000000000000 32bit Amazon Linux running Tomcat 7 ImageId ami-f2f0069b aws:autoscaling:launchconfiguration Notification Endpoint aws:elasticbeanstalk:sns:topics PARAM4 aws:elasticbeanstalk:application:environment JDBC_CONNECTION_STRING aws:elasticbeanstalk:application:environment SecurityGroups elasticbeanstalk-default aws:autoscaling:launchconfiguration UnhealthyThreshold 5 aws:elb:healthcheck InstanceType t1.micro aws:autoscaling:launchconfiguration  Statistic Average aws:autoscaling:trigger LoadBalancerHTTPSPort OFF aws:elb:loadbalancer Stickiness Cookie Expiration 0 aws:elb:policies PARAM5 aws:elasticbeanstalk:application:environment MeasureName NetworkOut aws:autoscaling:trigger Interval 30 aws:elb:healthcheck Application Healthcheck URL / aws:elasticbeanstalk:application Notification Topic ARN aws:elasticbeanstalk:sns:topics LowerBreachScaleIncrement -1 aws:autoscaling:trigger XX:MaxPermSize 64m aws:elasticbeanstalk:container:tomcat:jvmoptions UpperBreachScaleIncrement 1 aws:autoscaling:trigger MinSize 1 aws:autoscaling:asg Custom Availability Zones us-east-1a aws:autoscaling:asg Availability Zones Any 1 aws:autoscaling:asg LogPublicationControl false aws:elasticbeanstalk:hostmanager JVM Options aws:elasticbeanstalk:container:tomcat:jvmoptions Notification Topic Name aws:elasticbeanstalk:sns:topics PARAM2 aws:elasticbeanstalk:application:environment LoadBalancerHTTPPort 80 aws:elb:loadbalancer Timeout 5 aws:elb:healthcheck BreachDuration 2 aws:autoscaling:trigger MonitoringInterval 5 minute aws:autoscaling:launchconfiguration PARAM1 aws:elasticbeanstalk:application:environment  MaxSize 4 aws:autoscaling:asg LowerThreshold 2000000 aws:autoscaling:trigger AWS_SECRET_KEY aws:elasticbeanstalk:application:environment AWS_ACCESS_KEY_ID aws:elasticbeanstalk:application:environment UpperThreshold 6000000 aws:autoscaling:trigger Notification Protocol email aws:elasticbeanstalk:sns:topics Unit Bytes aws:autoscaling:trigger Xmx 256m aws:elasticbeanstalk:container:tomcat:jvmoptions Cooldown 360 aws:autoscaling:asg Period 1 aws:autoscaling:trigger Xms 256m aws:elasticbeanstalk:container:tomcat:jvmoptions  EC2KeyName aws:autoscaling:launchconfiguration Stickiness Policy false aws:elb:policies PARAM3 aws:elasticbeanstalk:application:environment HealthyThreshold 3 aws:elb:healthcheck SSLCertificateId aws:elb:loadbalancer ConfigTemplateDescription SampleApp 2010-11-17T03:48:19.640Z AppTemplate 2010-11-17T03:48:19.640Z 846cd905-f1fd-11df-8a78-9f77047e0d0c botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-allocate-address.json0000666454262600001440000000024113042511306031476 0ustar pysdk-ciamazon00000000000000{"AllocationId": "eipalloc-5723d13e", "Domain": "vpc", "PublicIp": "198.51.100.1", "ResponseMetadata": {"RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-get-identity-dkim-attributes.json0000666454262600001440000000072713042511306034135 0ustar pysdk-ciamazon00000000000000{ "DkimAttributes": { "amazon.com": { "DkimTokens": [ "vvjuipp74whm76gqoni7qmwwn4w4qusjiainivf6f", "3frqe7jn4obpuxjpwpolz6ipb3k5nvt2nhjpik2oy", "wrqplteh7oodxnad7hsl4mixg2uavzneazxv5sxi2" ], "DkimEnabled": true, "DkimVerificationStatus": "Success" } }, "ResponseMetadata": { "RequestId": "bb5a105d-c468-11e1-82eb-dff885ccc06a" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-instance-profiles.json0000666454262600001440000000115413042511306032766 0ustar pysdk-ciamazon00000000000000{"InstanceProfiles": [ {"Arn": "arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Database", "CreateDate": "2012-05-09T16:27:03Z", "InstanceProfileName": "Database", "Path": "/application_abc/component_xyz/", "Roles": []}, {"Arn": "arn:aws:iam::123456789012:instance-profile/application_abc/component_xyz/Webserver", "CreateDate": "2012-05-09T16:27:11Z", "InstanceProfileName": "Webserver", "Path": "/application_abc/component_xyz/", "Roles": []}], "IsTruncated": false, "ResponseMetadata": {"RequestId": "fd74fa8d-99f3-11e1-a4c3-27EXAMPLE804"} } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-get-identity-dkim-attributes.xml0000666454262600001440000000143013042511306033754 0ustar pysdk-ciamazon00000000000000 amazon.com true Success vvjuipp74whm76gqoni7qmwwn4w4qusjiainivf6f 3frqe7jn4obpuxjpwpolz6ipb3k5nvt2nhjpik2oy wrqplteh7oodxnad7hsl4mixg2uavzneazxv5sxi2 bb5a105d-c468-11e1-82eb-dff885ccc06a ././@LongLink0000000000000000000000000000014600000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-create-cluster-parameter-group.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-create-cluster-parameter-group.jso0000666454262600001440000000044113042511306035304 0ustar pysdk-ciamazon00000000000000{ "ClusterParameterGroup": { "ParameterGroupFamily": "redshift-1.0", "Description": "description my parameter group", "ParameterGroupName": "parametergroup1" }, "ResponseMetadata": { "RequestId": "6d6df847-64f3-11e2-bea9-49e0ce183f07" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-reserved-nodes.xml0000666454262600001440000000375413042511306033774 0ustar pysdk-ciamazon00000000000000 2013-01-22T18:46:48.600Z Medium Utilization 31536000 800.0 0.158 payment-pending dw.hs1.xlarge 1 4357912c-9266-469d-beb0-0f1b775e1bc9 2013-01-22T20:09:16.630Z Heavy Utilization 94608000 Hourly 0.21 12452.0 0.0 payment-pending dw.hs1.8xlarge 2 93bbbca2-e88c-4b8b-a600-b64eaabf18a3 2013-01-23T21:49:32.517Z Medium Utilization 31536000 800.0 0.158 payment-pending dw.hs1.xlarge 1 bbcd9749-f2ea-4d01-9b1b-b576f618eb4e 24dc90c8-672d-11e2-b2e1-8f41f0379151 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-network-acl.xml0000666454262600001440000000153113042511306031610 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE acl-5fb85d36 vpc-11ad4878 false 32767 all deny true 0.0.0.0/0 32767 all deny false 0.0.0.0/0 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-associate-route-table.json0000666454262600001440000000016313042511306032466 0ustar pysdk-ciamazon00000000000000{"AssociationId": "rtbassoc-f8ad4891", "ResponseMetadata": {"RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-add-permission.json0000666454262600001440000000013713042511306031343 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "6a213e4e-33a8-11df-9540-99d0768312d3" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-list-multipart-uploads.xml0000666454262600001440000000106613042511306032437 0ustar pysdk-ciamazon00000000000000 botocoretest1374528673-218 / foo 1000 false foo/ foobar/ ././@LongLink0000000000000000000000000000015200000000000011213 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-instances.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-auto-scaling-instances0000666454262600001440000000020013042511306035303 0ustar pysdk-ciamazon00000000000000{ "AutoScalingInstances": [], "ResponseMetadata": { "RequestId": "67af58ee-9167-11e2-ba50-d18200895d59" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-customer-gateway.xml0000666454262600001440000000064013042511306032662 0ustar pysdk-ciamazon00000000000000 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE cgw-b4dc3961 pending ipsec.1 12.1.2.3 65534 ././@LongLink0000000000000000000000000000014700000000000011217 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-get-identity-notification-attributes.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-get-identity-notification-attributes.js0000666454262600001440000000055413042511306035340 0ustar pysdk-ciamazon00000000000000{ "NotificationAttributes": { "user@example.com": { "ForwardingEnabled": true, "ComplaintTopic": "arn:aws:sns:us-east-1:123456789012:example", "BounceTopic": "arn:aws:sns:us-east-1:123456789012:example" } }, "ResponseMetadata": { "RequestId": "e038e509-b72a-11e1-901f-1fbd90e8104f" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-reserved-instances-listing.xml0000666454262600001440000000742413042511306034644 0ustar pysdk-ciamazon00000000000000 a42481af-335a-4e9e-b291-bd18dexample 5ec28771-05ff-4b9b-aa31-9e57dexample f127bd27-a218-43a4-926d-870e8example 2012-07-17T17:11:09.449Z 2012-07-17T17:11:09.468Z active ACTIVE Available 1 Sold 0 Cancelled 0 Pending 0 11 2.5 USD true 10 2.5 USD false 9 2.5 USD false 8 2.0 USD false 7 2.0 USD false 6 2.0 USD false 5 1.5 USD false 4 1.5 USD false 3 0.7 USD false 2 0.7 USD false 1 0.1 USD false myIdempToken1 botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-account-aliases.xml0000666454262600001440000000061113042511306032240 0ustar pysdk-ciamazon00000000000000 false foocorporation c5a076e9-f1b0-11df-8fbe-45274EXAMPLE ././@LongLink0000000000000000000000000000015400000000000011215 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-termination-policy-types.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-termination-policy-typ0000666454262600001440000000043313042511306035400 0ustar pysdk-ciamazon00000000000000{ "TerminationPolicyTypes": [ "ClosestToNextInstanceHour", "Default", "NewestInstance", "OldestInstance", "OldestLaunchConfiguration" ], "ResponseMetadata": { "RequestId": "67e117a5-9167-11e2-9223-abe83dfc0567" } }././@LongLink0000000000000000000000000000015200000000000011213 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-orderable-cluster-options.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-orderable-cluster-options0000666454262600001440000000261413042511306035351 0ustar pysdk-ciamazon00000000000000{ "OrderableClusterOptions": [ { "NodeType": "dw.hs1.8xlarge", "AvailabilityZones": [ { "Name": "us-east-1a" }, { "Name": "us-east-1c" }, { "Name": "us-east-1d" } ], "ClusterVersion": "1.0", "ClusterType": "multi-node" }, { "NodeType": "dw.hs1.xlarge", "AvailabilityZones": [ { "Name": "us-east-1a" }, { "Name": "us-east-1c" }, { "Name": "us-east-1d" } ], "ClusterVersion": "1.0", "ClusterType": "multi-node" }, { "NodeType": "dw.hs1.xlarge", "AvailabilityZones": [ { "Name": "us-east-1a" }, { "Name": "us-east-1c" }, { "Name": "us-east-1d" } ], "ClusterVersion": "1.0", "ClusterType": "single-node" } ], "ResponseMetadata": { "RequestId": "667a0dd4-9167-11e2-800a-8379c2537432" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-get-group.json0000666454262600001440000000114713042511306030303 0ustar pysdk-ciamazon00000000000000{ "Group": { "Path": "/", "CreateDate": "2013-06-04T13:19:26Z", "GroupId": "AGPAIX2UU43C4MKIJO6OE", "Arn": "arn:aws:iam::419278470775:group/test_admin", "GroupName": "test_admin" }, "Users": [ { "UserName": "harry", "Path": "/", "CreateDate": "2013-06-04T13:20:49Z", "UserId": "AIDAIWOYUHHXRAGTJC6H2", "Arn": "arn:aws:iam::419278470775:user/harry" } ], "ResponseMetadata": { "RequestId": "b23a1f90-d364-11e2-9e37-0baaf58cf1ee" }, "IsTruncated": false }botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-db-parameter-groups.xml0000666454262600001440000000114213042511306033674 0ustar pysdk-ciamazon00000000000000 mysql5.5 Default parameter group for mysql5.5 default.mysql5.5 aa23ad55-9167-11e2-b691-fdba749921d2 botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-access-keys.xml0000666454262600001440000000124713042511306031405 0ustar pysdk-ciamazon00000000000000 Bob Bob AKIAIOSFODNN7EXAMPLE Active Bob AKIAI44QH8DHBEXAMPLE Inactive false 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-reboot-cluster.xml0000666454262600001440000000326613042511306032240 0ustar pysdk-ciamazon00000000000000 1.0 5439
examplecluster.cobaosmlqshn.us-east-1.redshift.amazonaws.com
 rebooting 2 1 true false dev sun:06:30-sun:07:00 in-sync default.redshift-1.0 2013-01-22T19:23:59.368Z active default us-east-1c dw.hs1.xlarge examplecluster true adminuser 5edee79e-6503-11e2-9e70-918437dd236d botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-network-interfaces.xml0000666454262600001440000000652313042511306033517 0ustar pysdk-ciamazon00000000000000 fc45294c-006b-457b-bab9-012f5b3b0e40 eni-0f62d866 subnet-c53c87ac vpc-cc3c87a5 ap-southeast-1b 123456789012 false in-use 02:81:60:cb:27:37 10.0.0.146 true sg-3f4b5653 default eni-attach-6537fc0c i-22197876 123456789012 0 attached 2012-07-01T21:45:27.000Z true 10.0.0.146 true 10.0.0.148 false 10.0.0.150 false eni-a66ed5cf subnet-cd8a35a4 vpc-f28a359b ap-southeast-1b Primary network interface 123456789012 false in-use 02:78:d7:00:8a:1e 10.0.1.233 true sg-a2a0b2ce quick-start-1 eni-attach-a99c57c0 i-886401dc 123456789012 0 attached 2012-06-27T20:08:44.000Z true 10.0.1.233 true 10.0.1.20 false botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-delete-internet-gateway.json0000666454262600001440000000014013042511306033014 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-detach-network-interface.xml0000666454262600001440000000031613042511306032776 0ustar pysdk-ciamazon00000000000000 ce540707-0635-46bc-97da-33a8a362a0e8 true botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-regions.xml0000666454262600001440000000270513042511306031351 0ustar pysdk-ciamazon00000000000000 b5ad0cf6-846e-41be-a10d-767e2c519a71 eu-west-1 ec2.eu-west-1.amazonaws.com sa-east-1 ec2.sa-east-1.amazonaws.com us-east-1 ec2.us-east-1.amazonaws.com ap-northeast-1 ec2.ap-northeast-1.amazonaws.com us-west-2 ec2.us-west-2.amazonaws.com us-west-1 ec2.us-west-1.amazonaws.com ap-southeast-1 ec2.ap-southeast-1.amazonaws.com ap-southeast-2 ec2.ap-southeast-2.amazonaws.com botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-create-cluster-snapshot.xml0000666454262600001440000000165213042511306034043 0ustar pysdk-ciamazon00000000000000 5439 my-snapshot-123 creating manual 1.0 2013-01-23T01:08:29.142Z 2 dev 2013-01-22T19:23:59.368Z us-east-1c dw.hs1.xlarge examplecluster adminuser 65baef14-64f9-11e2-bea9-49e0ce183f07 botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-create-cluster-parameter-group.xml0000666454262600001440000000106313042511306035312 0ustar pysdk-ciamazon00000000000000 redshift-1.0 description my parameter group parametergroup1 6d6df847-64f3-11e2-bea9-49e0ce183f07 ././@LongLink0000000000000000000000000000014700000000000011217 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-reserved-node-offerings.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-reserved-node-offerings.x0000666454262600001440000000543313042511306035234 0ustar pysdk-ciamazon00000000000000 Heavy Utilization 94608000 Hourly 0.912 24000.0 c48ab04c-bc77-4ce4-8ada-b10c15c7b8b3 0.0 dw.hs1.8xlarge Heavy Utilization 31536000 Hourly 1.72 20000.0 248e7b75-5f85-40dc-9d11-6f1e6c7cf9c2 0.0 dw.hs1.8xlarge Heavy Utilization 31536000 Hourly 0.215 2500.0 d586503b-7006-4cf5-888a-cf8f694e07bb 0.0 dw.hs1.xlarge Heavy Utilization 94608000 Hourly 0.114 3000.0 4b2293b4-64a6-4e4a-9042-cf617efa3b76 0.0 dw.hs1.xlarge 665aecb7-9167-11e2-a970-49138ad38474 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-account-attributes.json0000666454262600001440000000175513042511306033700 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "14b4e6b1-ad06-4bdc-8dc0-e83bcd376f0c" }, "AccountAttributes": [ { "AttributeName": "vpc-max-security-groups-per-interface", "AttributeValues": [ { "AttributeValue": "5" } ] }, { "AttributeName": "max-instances", "AttributeValues": [ { "AttributeValue": "20" } ] }, { "AttributeName": "supported-platforms", "AttributeValues": [ { "AttributeValue": "EC2" }, { "AttributeValue": "VPC" } ] }, { "AttributeName": "default-vpc", "AttributeValues": [ { "AttributeValue": "none" } ] } ] } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-account-attributes.xml0000666454262600001440000000263313042511306033523 0ustar pysdk-ciamazon00000000000000 14b4e6b1-ad06-4bdc-8dc0-e83bcd376f0c vpc-max-security-groups-per-interface 5 max-instances 20 supported-platforms EC2 VPC default-vpc none botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-stop-instances.xml0000666454262600001440000000071713042511306031100 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-10a64379 64 stopping 16 running botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-get-distribution.xml0000666454262600001440000001124113042511306033122 0ustar pysdk-ciamazon00000000000000 EDFDVBD6EXAMPLE Deployed 2012-05-19T19:37:58Z 1 d111111abcdef8.cloudfront.net 3 self 1 APKA9ONS7QCOWEXAMPLE 111122223333 2 APKAI72T5DYBXEXAMPLE APKAU72D8DYNXEXAMPLE 444455556666 0 example.com2012-04-11-5:09pm 1 www.example.com index.html 2 example-Amazon S3-origin myawsbucket.s3.amazonaws.com origin-access-identity/cloudfront/E74FTE3AEXAMPLE example-custom-origin example.com 80 443 match-viewer example-Amazon S3-origin true whitelist 1 example-cookie true 3 self 111122223333 444455556666 https-only 0 1 *.jpg example-custom-origin false all true 2 self 111122223333 allow-all 86400 example comment true true myawslogbucket.s3.amazonaws.com example.com. AS1A2M3P4L5E67SIIXR3J PriceClass_All true botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-terminate-environment.xml0000666454262600001440000000163513042511306035320 0ustar pysdk-ciamazon00000000000000 Version1 Terminating SampleApp elasticbeanstalk-SampleApp-1394386994.us-east-1.elb.amazon aws.com SampleApp-jxb293wg7n.elasticbeanstalk.amazonaws.com Grey e-icsgecu3wf 2010-11-17T17:10:41.976Z 32bit Amazon Linux running Tomcat 7 EnvDescrip SampleApp 2010-11-17T03:59:33.520Z 9b71af21-f26d-11df-8a78-9f77047e0d0c botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-spot-datafeed-subscription.xml0000666454262600001440000000062113042511306034623 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE 111122223333 myawsbucket spotdata_ Active botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-vpcs.xml0000666454262600001440000000102513042511306030650 0ustar pysdk-ciamazon00000000000000 ed65eddd-6d71-4eee-bc93-83d3a672c209 vpc-8d2910e4 available 10.0.0.0/16 dopt-eb291082 default false botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-list-buckets.xml0000666454262600001440000000764713042511306030424 0ustar pysdk-ciamazon00000000000000 1936a5d8a2b189cda450d1d1d514f3861b3adc2df5152d2a294487b9445d1e7fmitchawsbotostats2012-02-20T17:45:32.000Zbucket-13558630832012-12-18T20:38:12.000Zelasticbeanstalk-us-east-1-4192784707752013-01-31T22:24:01.000Zelasticbeanstalk-us-west-2-4192784707752013-03-20T13:29:16.000Zencryption-13327885502012-03-26T19:02:12.000Zencryption-13467796372012-09-04T17:27:28.000Zgarnaat-amazon2012-01-09T05:53:44.000Zgarnaat_test_lifecycle2012-01-23T02:54:39.000Zkeytest-13558626012012-12-18T20:30:10.000Zkeytest-13558633762012-12-19T01:28:24.000Zmgtest2cloudformation2012-05-14T20:17:26.000Zmgtestcloudformation2012-05-14T14:36:38.000Zmitchtestcloudformation2012-05-14T14:34:13.000Zmultidelete-13558626842012-12-18T20:31:31.000Zmultidelete-13558627302012-12-19T01:28:25.000Zmultidelete-13558634072012-12-19T01:28:25.000Zmultidelete-13558634392012-12-19T01:28:25.000Zmultidelete-13558634462012-12-19T01:28:25.000Zmultidelete-13558634552012-12-19T01:28:25.000Zmultidelete-13558634642012-12-19T01:28:25.000Zmultidelete-13558634702012-12-18T20:44:38.000Zmultipart-13558628452012-12-19T01:28:25.000Zmultipart-13558629012012-12-18T20:35:08.000Zmultipart-13558635502012-12-19T01:28:25.000Zmultipart-13558635932012-12-19T01:28:25.000Zpyconprod2013-03-13T05:42:01.000Zsrc-bucket-13320989082012-03-18T19:28:26.000Zsrc-bucket-13327885262012-03-26T19:01:49.000Zsrc-bucket-13327890192012-03-26T19:10:02.000Zsrc-bucket-13328681162012-03-27T17:08:36.000Zsrc-bucket-13396089712012-06-13T17:36:12.000Zsrc-bucket-13576998482013-01-09T02:50:52.000Zstats.pythonboto.org2012-04-28T20:42:19.000Ztest-13578542452013-01-10T21:44:06.000Ztest-13578542462013-01-10T21:44:07.000Zversion-13282243642012-09-01T10:25:07.000Zbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-create-cluster-security-group.json0000666454262600001440000000044213042511306035352 0ustar pysdk-ciamazon00000000000000{ "ClusterSecurityGroup": { "Description": "my security group", "ClusterSecurityGroupName": "securitygroup1", "EC2SecurityGroups": [], "IPRanges": [] }, "ResponseMetadata": { "RequestId": "f9ee270f-64f7-11e2-a8da-655adc216806" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-list-objects.json0000666454262600001440000000165113042511306030553 0ustar pysdk-ciamazon00000000000000{ "Name": "test-1357854246", "ResponseMetadata": {}, "MaxKeys": 1000, "Prefix": "", "Marker": "", "IsTruncated": false, "Contents": [ { "LastModified": "2013-01-10T21:45:09.000Z", "ETag": "\"1d921b22129502cbbe5cbaf2c8bac682\"", "StorageClass": "STANDARD", "Key": "key1", "Owner": { "DisplayName": "aws", "ID": "1936a5d8a2b189cda450d1d1d514f3861b3adc2df515" }, "Size": 10000 }, { "LastModified": "2013-01-10T22:45:09.000Z", "ETag": "\"1d921b22129502cbbe5cbaf2c8bac682\"", "StorageClass": "STANDARD", "Key": "key2", "Owner": { "DisplayName": "aws", "ID": "1936a5d8a2b189cda450d1d1d514f3861b3adc2df515" }, "Size": 1234 } ] } botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-events.json0000666454262600001440000000061313042511306032513 0ustar pysdk-ciamazon00000000000000{"Events": [{"Date": "2012-12-07T23:05:02.660Z", "Message": "Cluster security group securitygroup1 has been updated. Changes need to be applied to all clusters using this cluster security group.", "SourceIdentifier": "securitygroup1", "SourceType": "cluster-security-group"}], "ResponseMetadata": {"RequestId": "3eeb9efe-40c5-11e2-816a-1bba29fad1f5"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-key-pair.json0000666454262600001440000000225613042511306031261 0ustar pysdk-ciamazon00000000000000{ "KeyMaterial": "---- BEGIN RSA PRIVATE KEY ----\nMIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6\nb24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd\nBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN\nMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD\nVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z\nb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt\nYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ\n21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T\nrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE\nIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4\nnUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb\nFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb\nNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=\n-----END RSA PRIVATE KEY-----", "KeyName": "gsg-keypair", "KeyFingerprint": "00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00", "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-virtual-mfa-devices.json0000666454262600001440000000147313042511306033214 0ustar pysdk-ciamazon00000000000000{"IsTruncated": false, "ResponseMetadata": {"RequestId": "b61ce1b1-0401-11e1-b2f8-2dEXAMPLEbfc"}, "VirtualMFADevices": [ {"SerialNumber": "arn:aws:iam::123456789012:mfa/MFAdeviceName"}, {"EnableDate": "2011-10-20T20:49:03Z", "SerialNumber": "arn:aws:iam::123456789012:mfa/RootMFAdeviceName", "User": {"Arn": "arn:aws:iam::123456789012:root", "CreateDate": "2009-10-13T22:00:36Z", "UserId": "123456789012"}}, {"EnableDate": "2011-10-31T20:45:02Z", "SerialNumber": "arn:aws:iam:::mfa/ExampleUserMFAdeviceName", "User": {"Arn": "arn:aws:iam::111122223333:user/ExampleUser", "CreateDate": "2011-07-01T17:23:07Z", "Path": "/", "UserId": "AIDEXAMPLE4EXAMPLEXYZ", "UserName": "ExampleUser"} } ] } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-availability-zones.json0000666454262600001440000000112713042511306033657 0ustar pysdk-ciamazon00000000000000{ "AvailabilityZones": [ { "State": "available", "RegionName": "us-west-2", "Messages": [], "ZoneName": "us-west-2a" }, { "State": "available", "RegionName": "us-west-2", "Messages": [], "ZoneName": "us-west-2b" }, { "State": "available", "RegionName": "us-west-2", "Messages": [], "ZoneName": "us-west-2c" } ], "ResponseMetadata": { "RequestId": "134223fa-6e75-437d-8235-5e7ad2482839" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-db-security-groups.xml0000666454262600001440000000225213042511306033566 0ustar pysdk-ciamazon00000000000000 default 123456789012 default My first security group 123456789012 testgroup1 My second security group 123456789012 testgroup2 aaf3813f-9167-11e2-a2d0-e302f09d52ea botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-snapshot.json0000666454262600001440000000053713042511306031377 0ustar pysdk-ciamazon00000000000000{ "Description": "Daily Backup", "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" }, "VolumeId": "vol-1a2b3c4d", "State": "pending", "VolumeSize": 30, "StartTime": "YYYY-MM-DDTHH:MM:SS.000Z", "SnapshotId": "snap-1a2b3c4d", "OwnerId": "111122223333", "Progress": "60%" } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-network-acls.json0000666454262600001440000000275613042511306032473 0ustar pysdk-ciamazon00000000000000{ "NetworkAcls": [ { "Associations": [ { "SubnetId": "subnet-812910e8", "NetworkAclId": "acl-8c2910e5", "NetworkAclAssociationId": "aclassoc-832910ea" } ], "NetworkAclId": "acl-8c2910e5", "VpcId": "vpc-8d2910e4", "Tags": [], "Entries": [ { "CidrBlock": "0.0.0.0/0", "RuleNumber": 100, "Protocol": "-1", "Egress": true, "RuleAction": "allow" }, { "CidrBlock": "0.0.0.0/0", "RuleNumber": 32767, "Protocol": "-1", "Egress": true, "RuleAction": "deny" }, { "CidrBlock": "0.0.0.0/0", "RuleNumber": 100, "Protocol": "-1", "Egress": false, "RuleAction": "allow" }, { "CidrBlock": "0.0.0.0/0", "RuleNumber": 32767, "Protocol": "-1", "Egress": false, "RuleAction": "deny" } ], "IsDefault": true } ], "ResponseMetadata": { "RequestId": "44c81884-4c88-40ef-b6e9-b04d207189c9" } } ././@LongLink0000000000000000000000000000015000000000000011211 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-retrieve-environment-info.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-retrieve-environment-info.0000666454262600001440000000137213042511306035363 0ustar pysdk-ciamazon00000000000000 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%26AuthParams 2010-11-17T20:40:23.210Z tail i-92a3ceff e8e785c9-f28a-11df-8a78-9f77047e0d0c botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-environments.json0000666454262600001440000000144713042511306035445 0ustar pysdk-ciamazon00000000000000{"Environments": [{"ApplicationName": "SampleApp", "CNAME": "SampleApp-jxb293wg7n.elasticbeanstalk.amazonaws.com", "DateCreated": "2010-11-17T03:59:33.520Z", "DateUpdated": "2010-11-17T04:01:40.668Z", "Description": "EnvDescrip", "EndpointURL": "elasticbeanstalk-SampleApp-1394386994.us-east-1.elb.amazonaws.com", "EnvironmentId": "e-icsgecu3wf", "EnvironmentName": "SampleApp", "Health": "Green", "SolutionStackName": "32bit Amazon Linux running Tomcat 7", "Status": "Available", "VersionLabel": "Version1"}], "ResponseMetadata": {"RequestId": "44790c68-f260-11df-8a78-9f77047e0d0c"}} ././@LongLink0000000000000000000000000000015100000000000011212 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-retrieve-environment-info.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-retrieve-environment-info.0000666454262600001440000000077613042511306035372 0ustar pysdk-ciamazon00000000000000{ "EnvironmentInfo": [ { "SampleTimestamp": "2010-11-17T20:40:23.210Z", "Message": "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%26AuthParams", "InfoType": "tail", "Ec2InstanceId": "i-92a3ceff" } ], "ResponseMetadata": { "RequestId": "e8e785c9-f28a-11df-8a78-9f77047e0d0c" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-list-identities.xml0000666454262600001440000000055213042511306031356 0ustar pysdk-ciamazon00000000000000 foobar.com foo@bar.com 659700d6-9167-11e2-8db7-37375a39d514 ././@LongLink0000000000000000000000000000015500000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-list-available-solution-stacks.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-list-available-solution-st0000666454262600001440000001256413042511306035361 0ustar pysdk-ciamazon00000000000000 32bit Amazon Linux running PHP 5.4 64bit Amazon Linux running PHP 5.4 32bit Amazon Linux running PHP 5.3 64bit Amazon Linux running PHP 5.3 32bit Amazon Linux running Node.js 64bit Amazon Linux running Node.js 64bit Windows Server 2008 R2 running IIS 7.5 64bit Windows Server 2012 running IIS 8 32bit Amazon Linux running Tomcat 7 64bit Amazon Linux running Tomcat 7 32bit Amazon Linux running Tomcat 6 64bit Amazon Linux running Tomcat 6 32bit Amazon Linux running Python 64bit Amazon Linux running Python 32bit Amazon Linux running Ruby 1.8.7 64bit Amazon Linux running Ruby 1.8.7 32bit Amazon Linux running Ruby 1.9.3 64bit Amazon Linux running Ruby 1.9.3 32bit Amazon Linux running PHP 5.4 zip 64bit Amazon Linux running PHP 5.4 zip 32bit Amazon Linux running PHP 5.3 zip 64bit Amazon Linux running PHP 5.3 zip 32bit Amazon Linux running Node.js .zip .war 64bit Amazon Linux running Node.js .zip .war 64bit Windows Server 2008 R2 running IIS 7.5 zip 64bit Windows Server 2012 running IIS 8 zip 32bit Amazon Linux running Tomcat 7 war zip 64bit Amazon Linux running Tomcat 7 war zip 32bit Amazon Linux running Tomcat 6 war zip 64bit Amazon Linux running Tomcat 6 war zip 32bit Amazon Linux running Python zip 64bit Amazon Linux running Python zip 32bit Amazon Linux running Ruby 1.8.7 war zip 64bit Amazon Linux running Ruby 1.8.7 war zip 32bit Amazon Linux running Ruby 1.9.3 zip war 64bit Amazon Linux running Ruby 1.9.3 war zip af7e11cd-9167-11e2-9d65-771f0f370017 botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-db-parameter-groups.json0000666454262600001440000000050413042511306034046 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "aa23ad55-9167-11e2-b691-fdba749921d2" }, "DBParameterGroups": [ { "DBParameterGroupName": "default.mysql5.5", "DBParameterGroupFamily": "mysql5.5", "Description": "Default parameter group for mysql5.5" } ] }botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-access-keys.json0000666454262600001440000000063013042511306031551 0ustar pysdk-ciamazon00000000000000{"AccessKeyMetadata": [{"AccessKeyId": "AKIAIOSFODNN7EXAMPLE", "Status": "Active", "UserName": "Bob"}, {"AccessKeyId": "AKIAI44QH8DHBEXAMPLE", "Status": "Inactive", "UserName": "Bob"}], "IsTruncated": false, "ResponseMetadata": {"RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-get-streaming-distribution.xml0000666454262600001440000000431713042511306035117 0ustar pysdk-ciamazon00000000000000 EGTXBD79EXAMPLE Deployed 2012-05-19T19:37:58Z s5c39gqb8ow64r.cloudfront.net 3 self 1 APKA9ONS7QCOWEXAMPLE 111122223333 2 APKAI72T5DYBXEXAMPLE APKAU72D8DYNXEXAMPLE 444455556666 0 20120229090000 mystreamingbucket.s3.amazonaws.com origin-access-identity/cloudfront/E74FTE3AEXAMPLE 1 www.example.com example comment true myawslogbucket.s3.amazonaws.com myprefix/ 3 self 111122223333 444455556666 PriceClass_All true botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-add-permission.xml0000666454262600001440000000031513042511306031170 0ustar pysdk-ciamazon00000000000000 6a213e4e-33a8-11df-9540-99d0768312d3 ././@LongLink0000000000000000000000000000016000000000000011212 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-authorize-cluster-security-group-ingress.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-authorize-cluster-security-group-i0000666454262600001440000000063413042511306035402 0ustar pysdk-ciamazon00000000000000{ "ClusterSecurityGroup": { "Description": "my security group", "ClusterSecurityGroupName": "securitygroup1", "EC2SecurityGroups": [], "IPRanges": [ { "Status": "authorized", "CIDRIP": "192.168.40.3/32" } ] }, "ResponseMetadata": { "RequestId": "8c7cd4c8-6501-11e2-a8da-655adc216806" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudwatch-describe-alarm-history.json0000666454262600001440000000017513042511306034332 0ustar pysdk-ciamazon00000000000000{ "AlarmHistoryItems": [], "ResponseMetadata": { "RequestId": "ac265b36-9167-11e2-bf7e-91c14e278742" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-tags.json0000666454262600001440000000041113042511306031002 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "902d44a6-9456-4df3-9dcf-f2a26b77da7c" }, "Tags": [ { "ResourceType": "instance", "ResourceId": "i-fde9cece", "Value": "", "Key": "notebook" } ] } botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-reset-cluster-parameter-group.json0000666454262600001440000000043313042511306035342 0ustar pysdk-ciamazon00000000000000{ "ParameterGroupStatus": "Your parameter group has been updated but changes won't get applied until you reboot the associated Clusters.", "ParameterGroupName": "parametergroup1", "ResponseMetadata": { "RequestId": "625d23c1-40dc-11e2-8a25-eb010998df4e" } }././@LongLink0000000000000000000000000000015100000000000011212 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-parameter-groups.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-parameter-groups.0000666454262600001440000000075313042511306035276 0ustar pysdk-ciamazon00000000000000{"ParameterGroups": [{"Description": "Default parameter group for redshift-1.0", "ParameterGroupFamily": "redshift-1.0", "ParameterGroupName": "default.redshift-1.0"}, {"Description": "description my parameter group", "ParameterGroupFamily": "redshift-1.0", "ParameterGroupName": "parametergroup1"}], "ResponseMetadata": {"RequestId": "6d28788b-64f5-11e2-b343-393adc3f0a21"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-attach-vpn-gateway.json0000666454262600001440000000027513042511306032002 0ustar pysdk-ciamazon00000000000000{ "VpcAttachment": { "State": "attaching", "VpcId": "vpc-1a2b3c4d" }, "ResponseMetadata": { "RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE" } } ././@LongLink0000000000000000000000000000015500000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-application-versions.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-application-versi0000666454262600001440000000102213042511306035364 0ustar pysdk-ciamazon00000000000000{"ApplicationVersions": [{"ApplicationName": "SampleApp", "DateCreated": "2010-11-17T03:21:59.161Z", "DateUpdated": "2010-11-17T03:21:59.161Z", "Description": "description", "SourceBundle": {"S3Bucket": "amazonaws.com", "S3Key": "sample.war"}, "VersionLabel": "Version1"}], "ResponseMetadata": {"RequestId": "773cd80a-f26c-11df-8a78-9f77047e0d0c"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-replace-network-acl-association.xml0000666454262600001440000000037113042511306034273 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE aclassoc-17b85d7e ././@LongLink0000000000000000000000000000015500000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-configuration-options.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-describe-configuration-opt0000666454262600001440000004526613042511306035424 0ustar pysdk-ciamazon00000000000000 32bit Amazon Linux running Tomcat 6 false RestartApplicationServer 200 ^\S*$ AWS_SECRET_KEY Scalar aws:elasticbeanstalk:application:environment false RestartApplicationServer 200 PARAM1 Scalar aws:elasticbeanstalk:application:environment false RestartApplicationServer 200 ^\S*$ JDBC_CONNECTION_STRING Scalar aws:elasticbeanstalk:application:environment false RestartApplicationServer 200 PARAM2 Scalar aws:elasticbeanstalk:application:environment false RestartApplicationServer 200 ^\S*$ AWS_ACCESS_KEY_ID Scalar aws:elasticbeanstalk:application:environment false RestartApplicationServer 200 PARAM3 Scalar aws:elasticbeanstalk:application:environment false RestartApplicationServer 200 PARAM4 Scalar aws:elasticbeanstalk:application:environment false RestartApplicationServer 200 PARAM5 Scalar aws:elasticbeanstalk:application:environment false RestartApplicationServer 200 ^\S*$ XX:MaxPermSize Scalar 64m aws:elasticbeanstalk:container:tomcat:jvmoptions false RestartApplicationServer 200 ^\S*$ Xms Scalar 256m aws:elasticbeanstalk:container:tomcat:jvmoptions false RestartApplicationServer 200 ^\S*$ Xmx Scalar 256m aws:elasticbeanstalk:container:tomcat:jvmoptions false RestartApplicationServer 200 JVM Options Scalar aws:elasticbeanstalk:container:tomcat:jvmoptions false NoInterruption 200 Notification Endpoint Scalar aws:elasticbeanstalk:sns:topics false NoInterruption 200 Notification Topic ARN Scalar aws:elasticbeanstalk:sns:topics false NoInterruption Notification Protocol http https email email-json sqs Scalar email aws:elasticbeanstalk:sns:topics false NoInterruption 200 Notification Topic Name Scalar aws:elasticbeanstalk:sns:topics false NoInterruption 0 Stickiness Cookie Expiration Scalar 0 1000000 aws:elb:policies false NoInterruption Stickiness Policy Boolean false aws:elb:policies false NoInterruption 5 Interval Scalar 30 300 aws:elb:healthcheck false NoInterruption 2 UnhealthyThreshold Scalar 5 10 aws:elb:healthcheck false NoInterruption 2 HealthyThreshold Scalar 3 10 aws:elb:healthcheck false NoInterruption 2 Timeout Scalar 5 60 aws:elb:healthcheck false NoInterruption LoadBalancerHTTPPort OFF 80 Scalar 80 aws:elb:loadbalancer false NoInterruption LoadBalancerHTTPSPort OFF 443 8443 Scalar OFF aws:elb:loadbalancer false NoInterruption 200 SSLCertificateId Scalar aws:elb:loadbalancer false NoInterruption Statistic Minimum Maximum Sum Average Scalar Average aws:autoscaling:trigger false NoInterruption MeasureName CPUUtilization NetworkIn NetworkOut DiskWriteOps DiskReadBytes DiskReadOps DiskWriteBytes Latency RequestCount HealthyHostCount UnhealthyHostCount Scalar NetworkOut aws:autoscaling:trigger false NoInterruption Unit Seconds Percent Bytes Bits Count Bytes/Second Bits/Second Count/Second None Scalar Bytes aws:autoscaling:trigger false NoInterruption 0 LowerThreshold Scalar 2000000 20000000 aws:autoscaling:trigger false NoInterruption 200 UpperBreachScaleIncrement Scalar 1 aws:autoscaling:trigger false NoInterruption 200 LowerBreachScaleIncrement Scalar -1 aws:autoscaling:trigger false NoInterruption 1 BreachDuration Scalar 5 600 aws:autoscaling:trigger false NoInterruption 1 Period Scalar 5 600 aws:autoscaling:trigger false NoInterruption 0 UpperThreshold Scalar 6000000 20000000 aws:autoscaling:trigger false NoInterruption 1 MaxSize Scalar 4 10000 aws:autoscaling:asg false NoInterruption 1 MinSize Scalar 1 10000 aws:autoscaling:asg false NoInterruption Availability Zones Any 1 Any 2 Any Scalar Any 1 aws:autoscaling:asg false NoInterruption 0 Cooldown Scalar 360 10000 aws:autoscaling:asg false NoInterruption Custom Availability Zones us-west-2a us-west-2b us-west-2c List aws:autoscaling:asg false RestartEnvironment MonitoringInterval 1 minute 5 minute Scalar 5 minute aws:autoscaling:launchconfiguration false RestartEnvironment 200 EC2KeyName Scalar aws:autoscaling:launchconfiguration false RestartEnvironment 200 SecurityGroups Scalar elasticbeanstalk-default aws:autoscaling:launchconfiguration false RestartEnvironment 200 ImageId Scalar ami-f62fa3c6 aws:autoscaling:launchconfiguration false RestartEnvironment InstanceType t1.micro m1.small c1.medium m1.medium Scalar t1.micro aws:autoscaling:launchconfiguration false NoInterruption 200 ^\S*$ Application Healthcheck URL Scalar / aws:elasticbeanstalk:application false NoInterruption Automatically Terminate Unhealthy Instances Boolean true aws:elasticbeanstalk:monitoring false NoInterruption LogPublicationControl Boolean false aws:elasticbeanstalk:hostmanager af3d86f9-9167-11e2-a92a-116deff19e14 botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-create-cluster-subnet-group.xml0000666454262600001440000000151713042511306034636 0ustar pysdk-ciamazon00000000000000 vpc-796a5913 My subnet group 1 mysubnetgroup1 Complete Active subnet-756a591f us-east-1c 0a60660f-6a4a-11e2-aad2-71d00c36728e botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-import-instance.json0000666454262600001440000000220713042511306031407 0ustar pysdk-ciamazon00000000000000{ "ConversionTask": { "ConversionTaskId": "import-i-ffvko9js", "ImportInstance": { "InstanceId": "i-12655a7f", "Description": "", "Volumes": [ { "Status": "active", "AvailabilityZone": "us-east-1a", "Description": "", "Image": { "Size": 1179593728, "ImportManifestUrl": "https://s3.amazonaws.com/myawsbucket/a3a5e1b6-590d-43cc-97c1-15c7325d3f41/Win_2008_Server_Data_Center_SP2_32-bit.vmdkmanifest.xml?AWSaccessKeyId=AKIAIOSFODNN7EXAMPLE%26Expires=1294855591%26Signature=5snej01T1TtL0uR7KExtEXAMPLE%3D", "Format": "VMDK" }, "Volume": { "Id": "vol-1a2b3c4d", "Size": 12 }, "BytesConverted": 0, "StatusMessage": "" } ] }, "ExpirationTime": "2010-12-22T12:01Z" }, "ResponseMetadata": {"RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE"} } botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-list-object-versions.json0000666454262600001440000000500713042511306032235 0ustar pysdk-ciamazon00000000000000{ "Name": "bucket", "ResponseMetadata": {}, "Versions": [ { "LastModified": "2009-10-12T17:50:30.000Z", "VersionId": "3/L4kqtJl40Nr8X8gdRQBpUMLUo", "ETag": "\"fba9dede5f27731c9771645a39863328\"", "StorageClass": "STANDARD", "Key": "my-image.jpg", "Owner": { "DisplayName": "mtd@amazon.com", "ID": "75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a" }, "IsLatest": true, "Size": 434234 }, { "LastModified": "2009-10-10T17:50:30.000Z", "VersionId": "QUpfdndhfd8438MNFDN93jdnJFkdmqnh893", "ETag": "\"9b2cf535f27731c974343645a3985328\"", "StorageClass": "STANDARD", "Key": "my-second-image.jpg", "Owner": { "DisplayName": "mtd@amazon.com", "ID": "75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a" }, "IsLatest": false, "Size": 166434 }, { "LastModified": "2009-10-11T12:50:30.000Z", "VersionId": "UIORUnfndfhnw89493jJFJ", "ETag": "\"772cf535f27731c974343645a3985328\"", "StorageClass": "STANDARD", "Key": "my-third-image.jpg", "Owner": { "DisplayName": "mtd@amazon.com", "ID": "75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a" }, "IsLatest": false, "Size": 64 } ], "MaxKeys": 5, "Prefix": "my", "KeyMarker": "", "DeleteMarkers": [ { "Owner": { "DisplayName": "mtd@amazon.com", "ID": "75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a" }, "IsLatest": true, "VersionId": "03jpff543dhffds434rfdsFDN943fdsFkdmqnh892", "Key": "my-second-image.jpg", "LastModified": "2009-11-12T17:50:30.000Z" }, { "Owner": { "DisplayName": "mtd@amazon.com", "ID": "75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a" }, "IsLatest": true, "VersionId": "03jpff543dhffds434rfdsFDN943fdsFkdmqnh892", "Key": "my-third-image.jpg", "LastModified": "2009-10-15T17:50:30.000Z" } ], "IsTruncated": false, "VersionIdMarker": "" } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-import-volume.xml0000666454262600001440000000206413042511306030742 0ustar pysdk-ciamazon00000000000000 import-i-fh95npoc 2010-12-22T12:01Z 0 us-east-1c VDMK 128696320 https://s3.amazonaws.com/myawsbucket/a3a5e1b6-590d-43cc-97c1-15c7325d3f41/Win_2008_Server_Data_Center_SP2_32-bit.vmdkmanifest.xml?AWSaccessKeyId=AKIAIOSFODNN7EXAMPLE%26Expires=1294855591%26Signature=5snej01T1TtL0uR7KExtEXAMPLE%3D ccb1b0536a4a70e86016b85229b5c6b10b14a4eb 8 vol-34d8a2ff active 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-vpn-gateway.xml0000666454262600001440000000057313042511306031631 0ustar pysdk-ciamazon00000000000000 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE vgw-8db04f81 pending ipsec.1 us-east-1a botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-list-subscriptions.json0000666454262600001440000000065013042511306032305 0ustar pysdk-ciamazon00000000000000{"ResponseMetadata": {"RequestId": "384ac68d-3775-11df-8963-01868b7c937a"}, "Subscriptions": [{"Endpoint": "example@amazon.com", "Owner": "123456789012", "Protocol": "email", "SubscriptionArn": "arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca", "TopicArn": "arn:aws:sns:us-east-1:698519295917:My-Topic"}]} botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-reserved-nodes.json0000666454262600001440000000326413042511306034141 0ustar pysdk-ciamazon00000000000000{"ReservedNodes": [{"Duration": 31536000, "FixedPrice": 800.0, "NodeCount": 1, "NodeType": "dw.hs1.xlarge", "OfferingType": "Medium Utilization", "RecurringCharges": [], "ReservedNodeId": "4357912c-9266-469d-beb0-0f1b775e1bc9", "StartTime": "2013-01-22T18:46:48.600Z", "State": "payment-pending", "UsagePrice": 0.158}, {"Duration": 94608000, "FixedPrice": 12452.0, "NodeCount": 2, "NodeType": "dw.hs1.8xlarge", "OfferingType": "Heavy Utilization", "RecurringCharges": [{"RecurringChargeAmount": 0.21, "RecurringChargeFrequency": "Hourly"}], "ReservedNodeId": "93bbbca2-e88c-4b8b-a600-b64eaabf18a3", "StartTime": "2013-01-22T20:09:16.630Z", "State": "payment-pending", "UsagePrice": 0.0}, {"Duration": 31536000, "FixedPrice": 800.0, "NodeCount": 1, "NodeType": "dw.hs1.xlarge", "OfferingType": "Medium Utilization", "RecurringCharges": [], "ReservedNodeId": "bbcd9749-f2ea-4d01-9b1b-b576f618eb4e", "StartTime": "2013-01-23T21:49:32.517Z", "State": "payment-pending", "UsagePrice": 0.158}], "ResponseMetadata": {"RequestId": "24dc90c8-672d-11e2-b2e1-8f41f0379151"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-delete-application.json0000666454262600001440000000013713042511306034676 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "1f155abd-f1d7-11df-8a78-9f77047e0d0c" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-run-instances.json0000666454262600001440000000516213042511306031067 0ustar pysdk-ciamazon00000000000000{ "OwnerId": "111122223333", "ReservationId": "r-157ad274", "ResponseMetadata": { "RequestId": "e86ff3c8-2400-45e3-a4e7-f158a69283d4" }, "Groups": [], "Instances": [ { "Monitoring": { "State": "disabled" }, "PublicDnsName": "", "StateReason": { "Message": "pending", "Code": "pending" }, "State": { "Code": 0, "Name": "pending" }, "LaunchTime": "2011-12-20T08:29:31.000Z", "PrivateIpAddress": "10.0.0.142", "ProductCodes": [], "VpcId": "vpc-1ea24976", "StateTransitionReason": "", "InstanceId": "i-0ee0356c", "ImageId": "ami-31814f58", "PrivateDnsName": "", "SecurityGroups": [ { "GroupName": "default", "GroupId": "sg-050c1369" } ], "ClientToken": "", "SubnetId": "subnet-b2a249da", "InstanceType": "m1.small", "NetworkInterfaces": [ { "Status": "in-use", "SourceDestCheck": true, "VpcId": "vpc-1ea24976", "Description": "", "NetworkInterfaceId": "eni-c6bb50ae", "Attachment": { "Status": "attaching", "DeviceIndex": 0, "DeleteOnTermination": true, "AttachmentId": "eni-attach-0326646a", "AttachTime": "2011-12-20T08:29:31.000Z" }, "Groups": [ { "GroupName": "default", "GroupId": "sg-050c1369" } ], "SubnetId": "subnet-b2a249da", "OwnerId": "111122223333", "PrivateIpAddress": "10.0.0.142" } ], "SourceDestCheck": true, "Placement": { "GroupName": "", "Tenancy": "default", "AvailabilityZone": "us-east-1b" }, "Hypervisor": "xen", "BlockDeviceMappings": [], "Architecture": "i386", "KernelId": "aki-805ea7e9", "RootDeviceName": "/dev/sda1", "VirtualizationType": "paravirtual", "RootDeviceType": "ebs", "AmiLaunchIndex": 0 } ] }botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-tags.xml0000666454262600001440000000041613042511306032476 0ustar pysdk-ciamazon00000000000000 67c5c76d-9167-11e2-9863-c1fc2ead119c ././@LongLink0000000000000000000000000000015000000000000011211 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-security-groups.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-cluster-security-groups.j0000666454262600001440000000120113042511306035324 0ustar pysdk-ciamazon00000000000000{ "ClusterSecurityGroups": [ { "Description": "default", "ClusterSecurityGroupName": "default", "EC2SecurityGroups": [], "IPRanges": [ { "Status": "authorized", "CIDRIP": "0.0.0.0/0" } ] }, { "Description": "my security group", "ClusterSecurityGroupName": "securitygroup1", "EC2SecurityGroups": [], "IPRanges": [] } ], "ResponseMetadata": { "RequestId": "947a8305-64f8-11e2-bec0-17624ad140dd" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-db-engine-versions.xml0000666454262600001440000002064013042511306033516 0ustar pysdk-ciamazon00000000000000 mysql5.1 mysql MySQL Community Edition 5.1.57 MySQL 5.1.57 mysql5.1 mysql MySQL Community Edition 5.1.61 MySQL 5.1.61 mysql5.1 mysql MySQL Community Edition 5.1.62 MySQL 5.1.62 mysql5.1 mysql MySQL Community Edition 5.1.63 MySQL 5.1.63 mysql5.5 mysql MySQL Community Edition 5.5.12 MySQL 5.5.12 mysql5.5 mysql MySQL Community Edition 5.5.20 MySQL 5.5.20 mysql5.5 mysql MySQL Community Edition 5.5.23 MySQL 5.5.23 mysql5.5 mysql MySQL Community Edition 5.5.25a MySQL 5.5.25a mysql5.5 mysql MySQL Community Edition 5.5.27 MySQL 5.5.27 mysql5.5 mysql MySQL Community Edition 5.5.8 MySQL 5.5.8 oracle-ee-11.2 oracle-ee Oracle Database Enterprise Edition AL32UTF8 Unicode 5.0 UTF-8 Universal character set 11.2.0.2.v3 Oracle 11.2.0.2.v3 oracle-ee-11.2 oracle-ee Oracle Database Enterprise Edition AL32UTF8 Unicode 5.0 UTF-8 Universal character set 11.2.0.2.v4 Oracle 11.2.0.2.v4 oracle-ee-11.2 oracle-ee Oracle Database Enterprise Edition AL32UTF8 Unicode 5.0 UTF-8 Universal character set 11.2.0.2.v5 Oracle 11.2.0.2.v5 oracle-ee-11.2 oracle-ee Oracle Database Enterprise Edition AL32UTF8 Unicode 5.0 UTF-8 Universal character set 11.2.0.2.v6 Oracle 11.2.0.2.v6 sqlserver-ex-10.5 sqlserver-ex Microsoft SQL Server Express Edition 10.50.2789.0.v1 SQL Server 2008 R2 10.50.2789.0.v1 sqlserver-ex-11.0 sqlserver-ex Microsoft SQL Server Express Edition 11.00.2100.60.v1 SQL Server 2012 11.00.2100.60.v1 sqlserver-se-10.5 sqlserver-se Microsoft SQL Server Standard Edition 10.50.2789.0.v1 SQL Server 2008 R2 10.50.2789.0.v1 sqlserver-se-11.0 sqlserver-se Microsoft SQL Server Standard Edition 11.00.2100.60.v1 SQL Server 2012 11.00.2100.60.v1 sqlserver-web-10.5 sqlserver-web Microsoft SQL Server Web Edition 10.50.2789.0.v1 SQL Server 2008 R2 10.50.2789.0.v1 sqlserver-web-11.0 sqlserver-web Microsoft SQL Server Web Edition 11.00.2100.60.v1 SQL Server 2012 11.00.2100.60.v1 aa3623ef-9167-11e2-b6fb-e599bc501f26 botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-get-queue-attributes.xml0000666454262600001440000000250013042511306032340 0ustar pysdk-ciamazon00000000000000 QueueArn arn:aws:sqs:us-east-1:123456789012:test1351044153 ApproximateNumberOfMessages 0 ApproximateNumberOfMessagesNotVisible 0 ApproximateNumberOfMessagesDelayed 0 CreatedTimestamp 1351044153 LastModifiedTimestamp 1351044214 VisibilityTimeout 45 MaximumMessageSize 65536 MessageRetentionPeriod 345600 DelaySeconds 0 0c8d2786-b7b4-56e2-a823-6e80a404d6fd botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-create-virtual-mfa-device.json0000666454262600001440000000051113042511306033311 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "c7bf48a5-d35c-11e2-b096-29dca78bf3ce" }, "VirtualMFADevice": { "Base32StringSeed": "U3IWOL56EJ3Q5ILYBLU6NLTNZR3V5SAOWKQ5AOEPEQUUGQJFVDQKOA2N7OANTHBR", "SerialNumber": "arn:aws:iam::419278470775:mfa/ExampleMFADevice", "QRCodePNG": "foo" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/importexport-list-jobs.json0000666454262600001440000000061413042511306032304 0ustar pysdk-ciamazon00000000000000{"IsTruncated": true, "Jobs": [{"CreationDate": "2010-04-21T22:21:51Z", "IsCanceled": false, "JobId": "ADP7B", "JobType": "Import"}, {"CreationDate": "2010-04-21T22:19:05Z", "IsCanceled": false, "JobId": "AVEYF", "JobType": "Import"}], "ResponseMetadata": {"RequestId": "cc6ea8c0-4da9-11df-81c3-e94d3ca214a8"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-attach-volume.json0000666454262600001440000000040613042511306031043 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" }, "AttachTime": "YYYY-MM-DDTHH:MM:SS.000Z", "InstanceId": "i-1a2b3c4d", "VolumeId": "vol-1a2b3c4d", "State": "attaching", "Device": "/dev/sdh" }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-associate-address.json0000666454262600001440000000016313042511306031670 0ustar pysdk-ciamazon00000000000000{"AssociationId": "eipassoc-fc5ca095", "ResponseMetadata": {"RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE"}} botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-get-user.xml0000666454262600001440000000060613042511306027753 0ustar pysdk-ciamazon00000000000000 123456789012 arn:aws:iam::123456789012:root 2011-12-19T23:16:46Z a8ca5eb9-9167-11e2-8395-2fafede00095 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-bundle-instance.json0000666454262600001440000000076213042511306031352 0ustar pysdk-ciamazon00000000000000{ "BundleTask": { "UpdateTime": "2008-10-07T11:51:50.000Z", "InstanceId": "i-12345678", "Storage": { "S3": { "Prefix": "winami", "Bucket": "myawsbucket" } }, "State": "bundling", "StartTime": "2008-10-07T11:41:50.000Z", "Progress": "70%", "BundleId": "bun-c1a540a8" }, "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" } }././@LongLink0000000000000000000000000000016000000000000011212 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-get-cloud-front-origin-access-identity.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-get-cloud-front-origin-access-id0000666454262600001440000000054513042511306035163 0ustar pysdk-ciamazon00000000000000{ "CloudFrontOriginAccessIdentity": { "CloudFrontOriginAccessIdentityConfig": { "Comment": "My comments", "CallerReference": "20120229090000" }, "S3CanonicalUserId": "cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE", "Id": "E74FTE3AEXAMPLE" }, "ResponseMetadata": {} }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-customer-gateway.json0000666454262600001440000000046713042511306033042 0ustar pysdk-ciamazon00000000000000{ "CustomerGateway": { "Tags": [], "Type": "ipsec.1", "State": "pending", "CustomerGatewayId": "cgw-b4dc3961", "BgpAsn": "65534", "IpAddress": "12.1.2.3" }, "ResponseMetadata": { "RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudwatch-describe-alarms.xml0000666454262600001440000000043513042511306032644 0ustar pysdk-ciamazon00000000000000 ac11e96c-9167-11e2-bb93-654a565d340b botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-confirm-product-instance.xml0000666454262600001440000000035413042511306033040 0ustar pysdk-ciamazon00000000000000 59dbff89-35bd-4eac-99ed-be587EXAMPLE true 111122223333 ././@LongLink0000000000000000000000000000014600000000000011216 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-storage-location.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-storage-location.xm0000666454262600001440000000055313042511306035323 0ustar pysdk-ciamazon00000000000000 elasticbeanstalk-us-east-1-780612358023 ef51b94a-f1d6-11df-8a78-9f77047e0d0c ././@LongLink0000000000000000000000000000015700000000000011220 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-notification-configurations.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/autoscaling-describe-notification-configura0000666454262600001440000000020613042511306035377 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "680a7204-9167-11e2-b1be-9d56e7e138d4" }, "NotificationConfigurations": [] }././@LongLink0000000000000000000000000000016300000000000011215 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-list-cloud-front-origin-access-identities.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudfront-list-cloud-front-origin-access-i0000666454262600001440000000134513042511306035212 0ustar pysdk-ciamazon00000000000000{ "CloudFrontOriginAccessIdentityList": { "Items": [ { "Comment": "First origin access identity", "S3CanonicalUserId": "cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE", "Id": "E74FTE3AEXAMPLE" }, { "Comment": "Another origin access identity", "S3CanonicalUserId": "7d843ae7f1792436e72691ab96a9c1414b7c3fbe2ab739a1cf21b0fe2EXAMPLE", "Id": "E58SRM2XEXAMPLE" } ], "NextMarker": "EMLARXS9EXAMPLE", "MaxItems": 2, "Marker": "EDFDVBD6EXAMPLE", "IsTruncated": true, "Quantity": 4 }, "ResponseMetadata": {} }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-route-table.json0000666454262600001440000000066313042511306031763 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" }, "RouteTable": { "Associations": [], "Routes": [ { "GatewayId": "local", "DestinationCidrBlock": "10.0.0.0/22", "State": "active" } ], "RouteTableId": "rtb-f9ad4890", "VpcId": "vpc-11ad4878", "Tags": [] } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-terminate-environment.json0000666454262600001440000000121113042511306035457 0ustar pysdk-ciamazon00000000000000{ "ApplicationName": "SampleApp", "EnvironmentName": "SampleApp", "VersionLabel": "Version1", "Status": "Terminating", "Description": "EnvDescrip", "ResponseMetadata": { "RequestId": "9b71af21-f26d-11df-8a78-9f77047e0d0c" }, "EnvironmentId": "e-icsgecu3wf", "EndpointURL": "elasticbeanstalk-SampleApp-1394386994.us-east-1.elb.amazon\naws.com", "SolutionStackName": "32bit Amazon Linux running Tomcat 7", "CNAME": "SampleApp-jxb293wg7n.elasticbeanstalk.amazonaws.com", "Health": "Grey", "DateUpdated": "2010-11-17T17:10:41.976Z", "DateCreated": "2010-11-17T03:59:33.520Z" } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-instance-attribute.xml0000666454262600001440000000052613042511306033507 0ustar pysdk-ciamazon00000000000000 4c94c806-ef28-4f4c-b1c7-3e601fe39497 i-12345678 /dev/sda1 botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-update-application.xml0000666454262600001440000000130513042511306034543 0ustar pysdk-ciamazon00000000000000 New Version Another Description SampleApp 2010-11-17T19:26:20.410Z 2010-11-17T20:42:54.611Z Default 40be666b-f28b-11df-8a78-9f77047e0d0c botocore-1.5.7/tests/unit/response_parsing/xml/responses/sns-list-subscriptions-by-topic.json0000666454262600001440000000070313042511306034030 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "b9275252-3774-11df-9540-99d0768312d3" }, "Subscriptions": [ { "Owner": "123456789012", "Endpoint": "example@amazon.com", "Protocol": "email", "TopicArn": "arn:aws:sns:us-east-1:123456789012:My-Topic", "SubscriptionArn": "arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca" } ] }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-vpc.xml0000666454262600001440000000061013042511306030147 0ustar pysdk-ciamazon00000000000000 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE vpc-1a2b3c4d pending 10.0.0.0/16 dopt-1a2b3c4d2 default botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudformation-describe-stacks.json0000666454262600001440000000016213042511306033713 0ustar pysdk-ciamazon00000000000000{ "Stacks": [], "ResponseMetadata": { "RequestId": "ad4c8bf2-9167-11e2-991c-f387408da2bf" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-restore-from-cluster-snapshot.json0000666454262600001440000000177513042511306035403 0ustar pysdk-ciamazon00000000000000{ "Cluster": { "NodeType": "dw.hs1.xlarge", "ClusterVersion": "1.0", "PubliclyAccessible": true, "MasterUsername": "adminuser", "Encrypted": false, "ClusterParameterGroups": [ { "ParameterApplyStatus": "in-sync", "ParameterGroupName": "default.redshift-1.0" } ], "ClusterSecurityGroups": [ { "Status": "active", "ClusterSecurityGroupName": "default" } ], "AllowVersionUpgrade": true, "VpcSecurityGroups": [], "PreferredMaintenanceWindow": "sun:06:30-sun:07:00", "AutomatedSnapshotRetentionPeriod": 1, "ClusterStatus": "creating", "ClusterIdentifier": "examplecluster-restored", "DBName": "dev", "NumberOfNodes": 2, "PendingModifiedValues": {} }, "ResponseMetadata": { "RequestId": "52a9aee8-6505-11e2-bec0-17624ad140dd" } }././@LongLink0000000000000000000000000000015400000000000011215 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-revoke-cluster-security-group-ingress.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-revoke-cluster-security-group-ingr0000666454262600001440000000106413042511306035370 0ustar pysdk-ciamazon00000000000000 my security group securitygroup1 d8eff363-6502-11e2-a8da-655adc216806 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-availability-zones.xml0000666454262600001440000000153213042511306033506 0ustar pysdk-ciamazon00000000000000 134223fa-6e75-437d-8235-5e7ad2482839 us-west-2a available us-west-2 us-west-2b available us-west-2 us-west-2c available us-west-2 botocore-1.5.7/tests/unit/response_parsing/xml/responses/sqs-add-permission.json0000666454262600001440000000013713042511306031346 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "9a285199-c8d6-47c2-bdb2-314cb47d599d" } }././@LongLink0000000000000000000000000000015100000000000011212 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-orderable-cluster-options.xmlbotocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-describe-orderable-cluster-options0000666454262600001440000000373313042511306035354 0ustar pysdk-ciamazon00000000000000 multi-node 1.0 dw.hs1.8xlarge us-east-1a us-east-1c us-east-1d multi-node 1.0 dw.hs1.xlarge us-east-1a us-east-1c us-east-1d single-node 1.0 dw.hs1.xlarge us-east-1a us-east-1c us-east-1d 667a0dd4-9167-11e2-800a-8379c2537432 botocore-1.5.7/tests/unit/response_parsing/xml/responses/rds-describe-option-groups.json0000666454262600001440000000067313042511306033022 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "ab072fb0-9167-11e2-b6fb-e599bc501f26" }, "OptionGroupsList": [ { "MajorEngineVersion": "5.5", "OptionGroupDescription": "Default option group for mysql 5.5", "Options": [], "EngineName": "mysql", "AllowsVpcAndNonVpcInstanceMemberships": true, "OptionGroupName": "default:mysql-5-5" } ] }botocore-1.5.7/tests/unit/response_parsing/xml/responses/cloudwatch-list-metrics.json0000666454262600001440000005266413042511306032412 0ustar pysdk-ciamazon00000000000000{ "Metrics": [ { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-267b761f" } ], "MetricName": "VolumeIdleTime" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-04c7c53d" } ], "MetricName": "VolumeReadBytes" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-d63c6ce4" } ], "MetricName": "DiskReadBytes" }, { "Namespace": "AWS/SQS", "Dimensions": [ { "Name": "QueueName", "Value": "foobar" } ], "MetricName": "NumberOfEmptyReceives" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-78f1b94a" } ], "MetricName": "NetworkOut" }, { "Namespace": "AWS/SQS", "Dimensions": [ { "Name": "QueueName", "Value": "foobar" } ], "MetricName": "ApproximateNumberOfMessagesNotVisible" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-04c7c53d" } ], "MetricName": "VolumeTotalReadTime" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-203b3919" } ], "MetricName": "VolumeWriteOps" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-267b761f" } ], "MetricName": "VolumeWriteOps" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-a8d2e991" } ], "MetricName": "VolumeWriteBytes" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-70d08042" } ], "MetricName": "StatusCheckFailed_Instance" }, { "Namespace": "AWS/SQS", "Dimensions": [ { "Name": "QueueName", "Value": "foobar" } ], "MetricName": "ApproximateNumberOfMessagesDelayed" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-04c7c53d" } ], "MetricName": "VolumeReadOps" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-d63c6ce4" } ], "MetricName": "CPUUtilization" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-267b761f" } ], "MetricName": "VolumeTotalWriteTime" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-a8d2e991" } ], "MetricName": "VolumeWriteOps" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-78f1b94a" } ], "MetricName": "CPUUtilization" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-267b761f" } ], "MetricName": "VolumeQueueLength" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-20277712" } ], "MetricName": "DiskWriteBytes" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-267b761f" } ], "MetricName": "VolumeTotalReadTime" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-04c7c53d" } ], "MetricName": "VolumeWriteOps" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-70d08042" } ], "MetricName": "CPUUtilization" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-20277712" } ], "MetricName": "StatusCheckFailed_Instance" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-20277712" } ], "MetricName": "CPUUtilization" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-20277712" } ], "MetricName": "DiskReadBytes" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-04c7c53d" } ], "MetricName": "VolumeIdleTime" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-203b3919" } ], "MetricName": "VolumeQueueLength" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-d63c6ce4" } ], "MetricName": "DiskReadOps" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-a8d2e991" } ], "MetricName": "VolumeIdleTime" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-267b761f" } ], "MetricName": "VolumeWriteBytes" }, { "Namespace": "AWS/SQS", "Dimensions": [ { "Name": "QueueName", "Value": "foobar" } ], "MetricName": "ApproximateNumberOfMessagesVisible" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-70d08042" } ], "MetricName": "DiskReadBytes" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-78f1b94a" } ], "MetricName": "StatusCheckFailed_Instance" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-267b761f" } ], "MetricName": "VolumeReadOps" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-78f1b94a" } ], "MetricName": "DiskReadOps" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-a8d2e991" } ], "MetricName": "VolumeTotalWriteTime" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-d63c6ce4" } ], "MetricName": "StatusCheckFailed_System" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-70d08042" } ], "MetricName": "NetworkOut" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-d63c6ce4" } ], "MetricName": "StatusCheckFailed" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-a8d2e991" } ], "MetricName": "VolumeReadOps" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-203b3919" } ], "MetricName": "VolumeTotalWriteTime" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-203b3919" } ], "MetricName": "VolumeReadBytes" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-d63c6ce4" } ], "MetricName": "DiskWriteOps" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-78f1b94a" } ], "MetricName": "DiskWriteOps" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-a8d2e991" } ], "MetricName": "VolumeQueueLength" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-203b3919" } ], "MetricName": "VolumeIdleTime" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-78f1b94a" } ], "MetricName": "StatusCheckFailed" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-70d08042" } ], "MetricName": "StatusCheckFailed" }, { "Namespace": "AWS/SQS", "Dimensions": [ { "Name": "QueueName", "Value": "foobar" } ], "MetricName": "NumberOfMessagesSent" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-04c7c53d" } ], "MetricName": "VolumeQueueLength" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-267b761f" } ], "MetricName": "VolumeReadBytes" }, { "Namespace": "AWS/DynamoDB", "Dimensions": [ { "Name": "TableName", "Value": "fromcli" } ], "MetricName": "ProvisionedReadCapacityUnits" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-70d08042" } ], "MetricName": "StatusCheckFailed_System" }, { "Namespace": "AWS/SQS", "Dimensions": [ { "Name": "QueueName", "Value": "foobar" } ], "MetricName": "NumberOfMessagesDeleted" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-a8d2e991" } ], "MetricName": "VolumeReadBytes" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-20277712" } ], "MetricName": "DiskWriteOps" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-20277712" } ], "MetricName": "NetworkOut" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-20277712" } ], "MetricName": "DiskReadOps" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-20277712" } ], "MetricName": "StatusCheckFailed_System" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-d63c6ce4" } ], "MetricName": "NetworkOut" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-20277712" } ], "MetricName": "NetworkIn" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-203b3919" } ], "MetricName": "VolumeWriteBytes" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-70d08042" } ], "MetricName": "DiskWriteBytes" }, { "Namespace": "AWS/SQS", "Dimensions": [ { "Name": "QueueName", "Value": "foobar" } ], "MetricName": "NumberOfMessagesReceived" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-203b3919" } ], "MetricName": "VolumeReadOps" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-203b3919" } ], "MetricName": "VolumeTotalReadTime" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-70d08042" } ], "MetricName": "DiskWriteOps" }, { "Namespace": "AWS/DynamoDB", "Dimensions": [ { "Name": "TableName", "Value": "fromcli" } ], "MetricName": "ProvisionedWriteCapacityUnits" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-04c7c53d" } ], "MetricName": "VolumeTotalWriteTime" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-a8d2e991" } ], "MetricName": "VolumeTotalReadTime" }, { "Namespace": "AWS/EBS", "Dimensions": [ { "Name": "VolumeId", "Value": "vol-04c7c53d" } ], "MetricName": "VolumeWriteBytes" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-78f1b94a" } ], "MetricName": "DiskReadBytes" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-d63c6ce4" } ], "MetricName": "DiskWriteBytes" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-20277712" } ], "MetricName": "StatusCheckFailed" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-d63c6ce4" } ], "MetricName": "StatusCheckFailed_Instance" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-70d08042" } ], "MetricName": "NetworkIn" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-78f1b94a" } ], "MetricName": "NetworkIn" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-70d08042" } ], "MetricName": "DiskReadOps" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-d63c6ce4" } ], "MetricName": "NetworkIn" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-78f1b94a" } ], "MetricName": "StatusCheckFailed_System" }, { "Namespace": "AWS/EC2", "Dimensions": [ { "Name": "InstanceId", "Value": "i-78f1b94a" } ], "MetricName": "DiskWriteBytes" } ], "ResponseMetadata": { "RequestId": "abea8add-9167-11e2-91d1-9b4c7751b290" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-security-groups.json0000666454262600001440000001222013042511306033231 0ustar pysdk-ciamazon00000000000000{ "SecurityGroups": [ { "IpPermissionsEgress": [], "Description": "quicklaunch-0", "IpPermissions": [ { "ToPort": 22, "IpProtocol": "tcp", "IpRanges": [ { "CidrIp": "0.0.0.0/0" } ], "UserIdGroupPairs": [], "FromPort": 22 } ], "GroupName": "quicklaunch-0", "OwnerId": "123456789012", "GroupId": "sg-68d8a958" }, { "IpPermissionsEgress": [], "Description": "quicklaunch-1", "IpPermissions": [ { "ToPort": 3389, "IpProtocol": "tcp", "IpRanges": [ { "CidrIp": "0.0.0.0/0" } ], "UserIdGroupPairs": [], "FromPort": 3389 } ], "GroupName": "quicklaunch-1", "OwnerId": "123456789012", "GroupId": "sg-72334242" }, { "IpPermissionsEgress": [], "Description": "For iPython notebook.", "IpPermissions": [ { "ToPort": 22, "IpProtocol": "tcp", "IpRanges": [ { "CidrIp": "0.0.0.0/0" } ], "UserIdGroupPairs": [], "FromPort": 22 }, { "ToPort": 443, "IpProtocol": "tcp", "IpRanges": [ { "CidrIp": "0.0.0.0/0" } ], "UserIdGroupPairs": [], "FromPort": 443 }, { "ToPort": 8888, "IpProtocol": "tcp", "IpRanges": [ { "CidrIp": "0.0.0.0/0" } ], "UserIdGroupPairs": [], "FromPort": 8888 } ], "GroupName": "notebook", "OwnerId": "123456789012", "GroupId": "sg-4e970e7e" }, { "IpPermissionsEgress": [], "Description": "default group", "IpPermissions": [ { "ToPort": 65535, "IpProtocol": "tcp", "IpRanges": [], "UserIdGroupPairs": [ { "GroupName": "default", "UserId": "123456789012", "GroupId": "sg-eab831da" } ], "FromPort": 0 }, { "ToPort": 65535, "IpProtocol": "udp", "IpRanges": [], "UserIdGroupPairs": [ { "GroupName": "default", "UserId": "123456789012", "GroupId": "sg-eab831da" } ], "FromPort": 0 }, { "ToPort": -1, "IpProtocol": "icmp", "IpRanges": [], "UserIdGroupPairs": [ { "GroupName": "default", "UserId": "123456789012", "GroupId": "sg-eab831da" } ], "FromPort": -1 } ], "GroupName": "default", "OwnerId": "123456789012", "GroupId": "sg-eab831da" }, { "VpcId": "vpc-8d2910e4", "Description": "default VPC security group", "IpPermissions": [ { "IpProtocol": "-1", "IpRanges": [], "UserIdGroupPairs": [ { "UserId": "123456789012", "GroupId": "sg-97b1aefb" } ] } ], "GroupName": "default", "IpPermissionsEgress": [ { "IpProtocol": "-1", "IpRanges": [ { "CidrIp": "0.0.0.0/0" } ], "UserIdGroupPairs": [] } ], "OwnerId": "123456789012", "GroupId": "sg-97b1aefb" } ], "ResponseMetadata": { "RequestId": "4296401f-8b78-4f99-b1fb-71def4fc3701" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-users.xml0000666454262600001440000000164613042511306030337 0ustar pysdk-ciamazon00000000000000 /division_abc/subdivision_xyz/engineering/ Andrew AID2MAB8DPLSRHEXAMPLE arn:aws:iam::123456789012:user /division_abc/subdivision_xyz/engineering/Andrew /division_abc/subdivision_xyz/engineering/ Jackie AIDIODR4TAW7CSEXAMPLE arn:aws:iam::123456789012:user /division_abc/subdivision_xyz/engineering/Jackie false 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE botocore-1.5.7/tests/unit/response_parsing/xml/responses/redshift-delete-cluster-parameter-group.xml0000666454262600001440000000035613042511306035315 0ustar pysdk-ciamazon00000000000000 29674ca0-40da-11e2-b679-dba6cf515770 botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-describe-spot-price-history.xml0000666454262600001440000114540513042511306033475 0ustar pysdk-ciamazon00000000000000 a71a795c-276d-4c9b-8212-b9302ccce158 m1.small Linux/UNIX 0.010000 2013-03-20T13:35:55.000Z us-west-2b m1.large Windows 0.106000 2013-03-20T13:31:56.000Z us-west-2c m1.small Linux/UNIX 0.020000 2013-03-20T13:30:15.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-20T13:24:28.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-20T13:15:08.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-20T13:09:34.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-20T13:04:02.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-20T12:51:01.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-20T12:43:25.000Z us-west-2b t1.micro Linux/UNIX 0.004000 2013-03-20T12:35:46.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-20T12:34:01.000Z us-west-2b cc2.8xlarge Linux/UNIX 0.253000 2013-03-20T12:30:33.000Z us-west-2c m1.small Linux/UNIX 0.020000 2013-03-20T12:28:20.000Z us-west-2b t1.micro Linux/UNIX 0.004000 2013-03-20T12:24:30.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-20T12:19:08.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-20T12:11:33.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-20T12:02:13.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-20T11:56:27.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-20T11:50:52.000Z us-west-2b t1.micro Windows 0.009000 2013-03-20T11:47:00.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-20T11:43:28.000Z us-west-2b m2.4xlarge Linux/UNIX 0.224000 2013-03-20T11:22:57.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-20T11:04:09.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-20T10:58:24.000Z us-west-2b m1.large Windows 0.106000 2013-03-20T10:50:44.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-20T10:41:38.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-20T10:36:05.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-20T10:15:32.000Z us-west-2c m1.large Linux/UNIX (Amazon VPC) 0.042000 2013-03-20T10:11:47.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-20T10:02:26.000Z us-west-2b m1.medium Linux/UNIX (Amazon VPC) 0.021000 2013-03-20T10:00:46.000Z us-west-2c m1.small Linux/UNIX 0.020000 2013-03-20T09:56:51.000Z us-west-2b m1.small Linux/UNIX 0.025000 2013-03-20T09:39:59.000Z us-west-2c m1.large Linux/UNIX 0.042000 2013-03-20T09:09:46.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-20T09:05:57.000Z us-west-2b m1.large Linux/UNIX 0.042000 2013-03-20T09:00:34.000Z us-west-2a m1.small Linux/UNIX 0.020000 2013-03-20T09:00:26.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-20T08:38:19.000Z us-west-2c m1.large Linux/UNIX (Amazon VPC) 0.042000 2013-03-20T07:51:46.000Z us-west-2a c1.medium Windows 0.080000 2013-03-20T07:47:44.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-20T07:38:53.000Z us-west-2b m1.small Linux/UNIX 0.017000 2013-03-20T07:33:17.000Z us-west-2b m1.large Linux/UNIX (Amazon VPC) 0.042000 2013-03-20T07:18:13.000Z us-west-2b cc2.8xlarge Linux/UNIX 0.253000 2013-03-20T07:16:43.000Z us-west-2a c1.xlarge Linux/UNIX 0.112000 2013-03-20T06:42:47.000Z us-west-2b c1.xlarge Linux/UNIX 0.112000 2013-03-20T06:42:47.000Z us-west-2a c1.xlarge Linux/UNIX 0.112000 2013-03-20T06:42:47.000Z us-west-2c c1.xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-20T06:42:44.000Z us-west-2b m1.small Linux/UNIX 0.025000 2013-03-20T06:33:48.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-20T06:30:00.000Z us-west-2b m3.2xlarge SUSE Linux (Amazon VPC) 0.192000 2013-03-20T06:24:45.000Z us-west-2b m3.2xlarge SUSE Linux (Amazon VPC) 0.192000 2013-03-20T06:24:45.000Z us-west-2a m3.2xlarge SUSE Linux (Amazon VPC) 0.192000 2013-03-20T06:24:45.000Z us-west-2c m1.small Linux/UNIX 0.012000 2013-03-20T06:24:32.000Z us-west-2b m3.2xlarge Windows (Amazon VPC) 0.439000 2013-03-20T06:23:00.000Z us-west-2b m3.2xlarge Windows (Amazon VPC) 0.439000 2013-03-20T06:23:00.000Z us-west-2a m3.2xlarge Windows (Amazon VPC) 0.439000 2013-03-20T06:23:00.000Z us-west-2c m3.2xlarge Linux/UNIX (Amazon VPC) 0.183000 2013-03-20T06:22:56.000Z us-west-2b m3.2xlarge Linux/UNIX (Amazon VPC) 0.183000 2013-03-20T06:22:56.000Z us-west-2a m3.2xlarge Linux/UNIX (Amazon VPC) 0.183000 2013-03-20T06:22:56.000Z us-west-2c m3.xlarge Linux/UNIX (Amazon VPC) 0.092000 2013-03-20T06:20:34.000Z us-west-2b m3.xlarge Linux/UNIX (Amazon VPC) 0.092000 2013-03-20T06:20:34.000Z us-west-2a m3.xlarge Linux/UNIX (Amazon VPC) 0.092000 2013-03-20T06:20:34.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-20T06:18:59.000Z us-west-2b m3.xlarge Windows (Amazon VPC) 0.220000 2013-03-20T06:18:54.000Z us-west-2b m3.xlarge Windows (Amazon VPC) 0.220000 2013-03-20T06:18:54.000Z us-west-2a m3.xlarge Windows (Amazon VPC) 0.220000 2013-03-20T06:18:54.000Z us-west-2c m3.xlarge SUSE Linux (Amazon VPC) 0.101000 2013-03-20T06:18:45.000Z us-west-2b m3.xlarge SUSE Linux (Amazon VPC) 0.101000 2013-03-20T06:18:45.000Z us-west-2a m3.xlarge SUSE Linux (Amazon VPC) 0.101000 2013-03-20T06:18:45.000Z us-west-2c m1.small Windows (Amazon VPC) 0.026000 2013-03-20T06:15:26.000Z us-west-2a c1.medium Linux/UNIX (Amazon VPC) 0.028000 2013-03-20T06:14:57.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-20T06:11:32.000Z us-west-2b m3.2xlarge Windows 0.439000 2013-03-20T06:07:35.000Z us-west-2b m3.2xlarge Windows 0.439000 2013-03-20T06:07:35.000Z us-west-2a m3.2xlarge Windows 0.439000 2013-03-20T06:07:35.000Z us-west-2c m3.xlarge Windows 0.220000 2013-03-20T06:06:16.000Z us-west-2b m3.xlarge Windows 0.220000 2013-03-20T06:06:16.000Z us-west-2a m3.xlarge Windows 0.220000 2013-03-20T06:06:16.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-20T06:04:05.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-20T05:58:27.000Z us-west-2b m1.medium Windows 0.053000 2013-03-20T05:58:11.000Z us-west-2c m3.2xlarge SUSE Linux 0.192000 2013-03-20T05:56:57.000Z us-west-2b m3.2xlarge SUSE Linux 0.192000 2013-03-20T05:56:57.000Z us-west-2a m3.2xlarge SUSE Linux 0.192000 2013-03-20T05:56:57.000Z us-west-2c m3.2xlarge Linux/UNIX 0.183000 2013-03-20T05:56:56.000Z us-west-2b m3.2xlarge Linux/UNIX 0.183000 2013-03-20T05:56:56.000Z us-west-2a m3.2xlarge Linux/UNIX 0.183000 2013-03-20T05:56:56.000Z us-west-2c m3.xlarge SUSE Linux 0.101000 2013-03-20T05:51:10.000Z us-west-2b m3.xlarge SUSE Linux 0.101000 2013-03-20T05:51:10.000Z us-west-2a m3.xlarge SUSE Linux 0.101000 2013-03-20T05:51:10.000Z us-west-2c m3.xlarge Linux/UNIX 0.092000 2013-03-20T05:51:08.000Z us-west-2b m3.xlarge Linux/UNIX 0.092000 2013-03-20T05:51:08.000Z us-west-2a m3.xlarge Linux/UNIX 0.092000 2013-03-20T05:51:08.000Z us-west-2c t1.micro Windows (Amazon VPC) 0.009000 2013-03-20T05:36:11.000Z us-west-2b t1.micro Windows (Amazon VPC) 0.009000 2013-03-20T05:36:11.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-20T05:34:26.000Z us-west-2b t1.micro Linux/UNIX (Amazon VPC) 0.004000 2013-03-20T05:34:15.000Z us-west-2b t1.micro SUSE Linux (Amazon VPC) 0.009000 2013-03-20T05:32:22.000Z us-west-2b t1.micro SUSE Linux (Amazon VPC) 0.009000 2013-03-20T05:32:22.000Z us-west-2a t1.micro SUSE Linux (Amazon VPC) 0.009000 2013-03-20T05:32:22.000Z us-west-2c m1.small Linux/UNIX 0.013000 2013-03-20T05:28:52.000Z us-west-2b m1.small Linux/UNIX (Amazon VPC) 0.010000 2013-03-20T05:14:00.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-20T04:51:53.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-20T04:42:30.000Z us-west-2b c1.medium Windows 0.080000 2013-03-20T04:38:27.000Z us-west-2c m1.small Linux/UNIX 0.020000 2013-03-20T04:35:00.000Z us-west-2b t1.micro Linux/UNIX 0.004000 2013-03-20T04:27:25.000Z us-west-2b m1.small Linux/UNIX 1.122000 2013-03-20T04:12:49.000Z us-west-2a t1.micro Linux/UNIX 0.019000 2013-03-20T04:10:52.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-20T04:07:17.000Z us-west-2a t1.micro Linux/UNIX 0.016000 2013-03-20T04:03:25.000Z us-west-2b m1.small Linux/UNIX 1.122000 2013-03-20T04:01:37.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-20T03:56:00.000Z us-west-2a m1.xlarge Linux/UNIX 0.083000 2013-03-20T03:50:28.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-20T03:50:28.000Z us-west-2b m1.small Linux/UNIX 1.122000 2013-03-20T03:50:28.000Z us-west-2a m1.small Linux/UNIX 0.020000 2013-03-20T03:44:54.000Z us-west-2b m2.xlarge Linux/UNIX (Amazon VPC) 0.056000 2013-03-20T03:40:54.000Z us-west-2b c1.medium Linux/UNIX (Amazon VPC) 0.028000 2013-03-20T03:40:53.000Z us-west-2a c1.medium Linux/UNIX (Amazon VPC) 0.028000 2013-03-20T03:40:53.000Z us-west-2c t1.micro Linux/UNIX 0.004000 2013-03-20T03:37:27.000Z us-west-2b m2.xlarge Linux/UNIX 0.056000 2013-03-20T03:33:53.000Z us-west-2b t1.micro Linux/UNIX 0.010000 2013-03-20T03:31:57.000Z us-west-2b t1.micro Linux/UNIX (Amazon VPC) 0.004000 2013-03-20T03:30:01.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-20T02:49:25.000Z us-west-2c m2.xlarge Linux/UNIX 0.056000 2013-03-20T02:47:35.000Z us-west-2a m2.xlarge Linux/UNIX 0.056000 2013-03-20T02:47:35.000Z us-west-2c m1.xlarge Windows 0.211000 2013-03-20T02:44:13.000Z us-west-2b m1.xlarge Windows 0.211000 2013-03-20T02:44:13.000Z us-west-2a m1.xlarge Windows 0.211000 2013-03-20T02:44:13.000Z us-west-2c m2.4xlarge Linux/UNIX (Amazon VPC) 0.224000 2013-03-20T02:42:15.000Z us-west-2b m2.4xlarge Linux/UNIX (Amazon VPC) 0.224000 2013-03-20T02:42:15.000Z us-west-2c m1.small Linux/UNIX 0.025000 2013-03-20T02:42:05.000Z us-west-2c t1.micro Windows (Amazon VPC) 0.009000 2013-03-20T02:40:08.000Z us-west-2a m2.2xlarge Windows 0.224000 2013-03-20T02:39:59.000Z us-west-2b m2.2xlarge Windows 0.224000 2013-03-20T02:39:59.000Z us-west-2a m2.2xlarge Windows 0.224000 2013-03-20T02:39:59.000Z us-west-2c t1.micro Linux/UNIX 0.016000 2013-03-20T02:36:24.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-20T02:32:45.000Z us-west-2c cc2.8xlarge Windows (Amazon VPC) 0.456000 2013-03-20T02:31:12.000Z us-west-2c t1.micro Linux/UNIX 0.020000 2013-03-20T02:30:45.000Z us-west-2b t1.micro SUSE Linux 0.009000 2013-03-20T02:30:41.000Z us-west-2b t1.micro SUSE Linux 0.009000 2013-03-20T02:30:41.000Z us-west-2a t1.micro SUSE Linux 0.009000 2013-03-20T02:30:41.000Z us-west-2c m2.xlarge Windows (Amazon VPC) 0.112000 2013-03-20T02:29:14.000Z us-west-2b m2.xlarge Windows (Amazon VPC) 0.112000 2013-03-20T02:29:14.000Z us-west-2a m2.xlarge Windows (Amazon VPC) 0.112000 2013-03-20T02:29:14.000Z us-west-2c m1.large SUSE Linux 0.050000 2013-03-20T02:29:11.000Z us-west-2b m1.large SUSE Linux 0.050000 2013-03-20T02:29:11.000Z us-west-2a m1.large SUSE Linux 0.050000 2013-03-20T02:29:11.000Z us-west-2c m1.small Windows (Amazon VPC) 0.026000 2013-03-20T02:29:08.000Z us-west-2b m1.small Windows (Amazon VPC) 0.026000 2013-03-20T02:29:08.000Z us-west-2c m2.xlarge Windows 0.112000 2013-03-20T02:29:04.000Z us-west-2b m2.xlarge Windows 0.112000 2013-03-20T02:29:04.000Z us-west-2a m2.xlarge Windows 0.112000 2013-03-20T02:29:04.000Z us-west-2c m2.xlarge SUSE Linux 0.067000 2013-03-20T02:29:01.000Z us-west-2b m2.xlarge SUSE Linux 0.067000 2013-03-20T02:29:01.000Z us-west-2a m2.xlarge SUSE Linux 0.067000 2013-03-20T02:29:01.000Z us-west-2c m1.large SUSE Linux (Amazon VPC) 0.050000 2013-03-20T02:28:55.000Z us-west-2b m1.large SUSE Linux (Amazon VPC) 0.050000 2013-03-20T02:28:55.000Z us-west-2a m1.large SUSE Linux (Amazon VPC) 0.050000 2013-03-20T02:28:55.000Z us-west-2c c1.xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-20T02:28:42.000Z us-west-2b c1.xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-20T02:28:42.000Z us-west-2a c1.xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-20T02:28:42.000Z us-west-2c c1.xlarge Windows (Amazon VPC) 0.320000 2013-03-20T02:27:31.000Z us-west-2b c1.xlarge Windows (Amazon VPC) 0.320000 2013-03-20T02:27:31.000Z us-west-2a c1.xlarge Windows (Amazon VPC) 0.320000 2013-03-20T02:27:31.000Z us-west-2c c1.medium SUSE Linux 0.038000 2013-03-20T02:27:26.000Z us-west-2b c1.medium SUSE Linux 0.038000 2013-03-20T02:27:26.000Z us-west-2a c1.medium SUSE Linux 0.038000 2013-03-20T02:27:26.000Z us-west-2c c1.medium SUSE Linux (Amazon VPC) 0.038000 2013-03-20T02:26:51.000Z us-west-2b c1.medium SUSE Linux (Amazon VPC) 0.038000 2013-03-20T02:26:51.000Z us-west-2a c1.medium SUSE Linux (Amazon VPC) 0.038000 2013-03-20T02:26:51.000Z us-west-2c m2.4xlarge SUSE Linux 0.234000 2013-03-20T02:25:25.000Z us-west-2b m2.4xlarge SUSE Linux 0.234000 2013-03-20T02:25:25.000Z us-west-2a m2.4xlarge SUSE Linux 0.234000 2013-03-20T02:25:25.000Z us-west-2c m1.medium SUSE Linux 0.030000 2013-03-20T02:25:21.000Z us-west-2b m1.medium SUSE Linux 0.030000 2013-03-20T02:25:21.000Z us-west-2a m1.medium SUSE Linux 0.030000 2013-03-20T02:25:21.000Z us-west-2c m2.2xlarge SUSE Linux 0.122000 2013-03-20T02:23:25.000Z us-west-2b m2.2xlarge SUSE Linux 0.122000 2013-03-20T02:23:25.000Z us-west-2a m2.2xlarge SUSE Linux 0.122000 2013-03-20T02:23:25.000Z us-west-2c c1.medium Windows (Amazon VPC) 0.080000 2013-03-20T02:23:21.000Z us-west-2b c1.medium Windows (Amazon VPC) 0.080000 2013-03-20T02:23:21.000Z us-west-2a c1.medium Windows (Amazon VPC) 0.080000 2013-03-20T02:23:21.000Z us-west-2c m1.medium SUSE Linux (Amazon VPC) 0.030000 2013-03-20T02:21:55.000Z us-west-2b m1.medium SUSE Linux (Amazon VPC) 0.030000 2013-03-20T02:21:55.000Z us-west-2a m1.medium SUSE Linux (Amazon VPC) 0.030000 2013-03-20T02:21:55.000Z us-west-2c m1.xlarge Windows (Amazon VPC) 0.211000 2013-03-20T02:21:53.000Z us-west-2b m1.xlarge Windows (Amazon VPC) 0.211000 2013-03-20T02:21:53.000Z us-west-2a m2.2xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-20T02:21:50.000Z us-west-2b m2.2xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-20T02:21:50.000Z us-west-2a m2.2xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-20T02:21:50.000Z us-west-2c m2.4xlarge SUSE Linux (Amazon VPC) 0.234000 2013-03-20T02:21:46.000Z us-west-2b m2.4xlarge SUSE Linux (Amazon VPC) 0.234000 2013-03-20T02:21:46.000Z us-west-2a m2.4xlarge SUSE Linux (Amazon VPC) 0.234000 2013-03-20T02:21:46.000Z us-west-2c m2.4xlarge Windows 0.448000 2013-03-20T02:21:42.000Z us-west-2b m2.2xlarge Windows (Amazon VPC) 0.224000 2013-03-20T02:21:39.000Z us-west-2b m2.2xlarge Windows (Amazon VPC) 0.224000 2013-03-20T02:21:39.000Z us-west-2a m2.2xlarge Windows (Amazon VPC) 0.224000 2013-03-20T02:21:39.000Z us-west-2c m1.xlarge SUSE Linux 0.090000 2013-03-20T02:21:38.000Z us-west-2b m1.xlarge SUSE Linux 0.090000 2013-03-20T02:21:38.000Z us-west-2a m1.xlarge SUSE Linux 0.090000 2013-03-20T02:21:38.000Z us-west-2c m1.small SUSE Linux (Amazon VPC) 0.021000 2013-03-20T02:21:34.000Z us-west-2b m1.small SUSE Linux (Amazon VPC) 0.021000 2013-03-20T02:21:34.000Z us-west-2a m1.small SUSE Linux (Amazon VPC) 0.021000 2013-03-20T02:21:34.000Z us-west-2c c1.xlarge SUSE Linux 0.122000 2013-03-20T02:21:22.000Z us-west-2b c1.xlarge SUSE Linux 0.122000 2013-03-20T02:21:22.000Z us-west-2a c1.xlarge SUSE Linux 0.122000 2013-03-20T02:21:22.000Z us-west-2c m1.xlarge Linux/UNIX (Amazon VPC) 0.083000 2013-03-20T02:21:20.000Z us-west-2b m1.xlarge Linux/UNIX (Amazon VPC) 0.083000 2013-03-20T02:21:20.000Z us-west-2a m2.xlarge Linux/UNIX (Amazon VPC) 0.056000 2013-03-20T02:21:19.000Z us-west-2a m2.xlarge Linux/UNIX (Amazon VPC) 0.056000 2013-03-20T02:21:19.000Z us-west-2c c1.xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-20T02:21:19.000Z us-west-2c m2.xlarge SUSE Linux (Amazon VPC) 0.067000 2013-03-20T02:21:18.000Z us-west-2b m2.xlarge SUSE Linux (Amazon VPC) 0.067000 2013-03-20T02:21:18.000Z us-west-2a m2.xlarge SUSE Linux (Amazon VPC) 0.067000 2013-03-20T02:21:18.000Z us-west-2c m1.xlarge SUSE Linux (Amazon VPC) 0.090000 2013-03-20T02:21:18.000Z us-west-2b m1.xlarge SUSE Linux (Amazon VPC) 0.090000 2013-03-20T02:21:18.000Z us-west-2a m1.xlarge SUSE Linux (Amazon VPC) 0.090000 2013-03-20T02:21:18.000Z us-west-2c m1.medium Windows (Amazon VPC) 0.053000 2013-03-20T02:20:03.000Z us-west-2b m1.medium Windows (Amazon VPC) 0.053000 2013-03-20T02:20:03.000Z us-west-2a m1.medium Windows (Amazon VPC) 0.053000 2013-03-20T02:20:03.000Z us-west-2c m1.medium Linux/UNIX (Amazon VPC) 0.021000 2013-03-20T02:20:01.000Z us-west-2b m1.large Windows (Amazon VPC) 0.106000 2013-03-20T02:19:59.000Z us-west-2b m1.large Windows (Amazon VPC) 0.106000 2013-03-20T02:19:59.000Z us-west-2a m1.large Windows (Amazon VPC) 0.106000 2013-03-20T02:19:58.000Z us-west-2c m2.2xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-20T02:19:58.000Z us-west-2a m2.2xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-20T02:19:58.000Z us-west-2c m2.4xlarge Windows (Amazon VPC) 0.448000 2013-03-20T02:19:56.000Z us-west-2b m2.4xlarge Windows (Amazon VPC) 0.448000 2013-03-20T02:19:56.000Z us-west-2a m2.4xlarge Windows (Amazon VPC) 0.448000 2013-03-20T02:19:56.000Z us-west-2c m1.small SUSE Linux 0.021000 2013-03-20T02:19:47.000Z us-west-2b m1.small SUSE Linux 0.021000 2013-03-20T02:19:47.000Z us-west-2a m1.small SUSE Linux 0.021000 2013-03-20T02:19:47.000Z us-west-2c m1.small Linux/UNIX 0.025000 2013-03-20T02:16:06.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-20T01:53:55.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-20T01:44:42.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-20T01:39:07.000Z us-west-2b c1.medium Linux/UNIX 0.028000 2013-03-20T01:35:40.000Z us-west-2a m2.4xlarge Linux/UNIX 0.224000 2013-03-20T01:35:30.000Z us-west-2a m1.small Linux/UNIX (Amazon VPC) 0.010000 2013-03-20T01:35:18.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-20T01:33:30.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-20T01:18:37.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-20T01:12:59.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-20T00:43:22.000Z us-west-2c m1.xlarge Linux/UNIX (Amazon VPC) 0.083000 2013-03-20T00:41:11.000Z us-west-2c m1.small Linux/UNIX 0.014000 2013-03-20T00:34:11.000Z us-west-2c cc2.8xlarge Linux/UNIX 0.253000 2013-03-20T00:27:06.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-20T00:24:56.000Z us-west-2b m1.medium Linux/UNIX (Amazon VPC) 0.021000 2013-03-20T00:23:19.000Z us-west-2a m1.small Linux/UNIX 0.020000 2013-03-20T00:17:37.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-20T00:12:04.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-20T00:06:26.000Z us-west-2b c1.xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-20T00:00:33.000Z us-west-2a m1.xlarge Linux/UNIX 0.083000 2013-03-19T23:47:57.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-19T23:46:09.000Z us-west-2c m1.small Linux/UNIX 0.025000 2013-03-19T23:40:40.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-19T23:35:10.000Z us-west-2b m1.small Linux/UNIX 0.015000 2013-03-19T23:29:36.000Z us-west-2b c1.medium Linux/UNIX 0.028000 2013-03-19T23:24:22.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T23:20:29.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-19T23:13:11.000Z us-west-2b c1.xlarge Windows 0.320000 2013-03-19T23:09:50.000Z us-west-2c m1.medium Linux/UNIX 0.021000 2013-03-19T23:07:41.000Z us-west-2c c1.xlarge Windows 0.320000 2013-03-19T23:04:17.000Z us-west-2b m1.small Linux/UNIX 0.162000 2013-03-19T23:02:07.000Z us-west-2a m1.xlarge Windows (Amazon VPC) 0.211000 2013-03-19T23:00:27.000Z us-west-2c m1.medium Linux/UNIX 0.021000 2013-03-19T22:47:19.000Z us-west-2b m2.2xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-19T22:45:35.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T22:41:46.000Z us-west-2c m2.2xlarge Linux/UNIX 0.112000 2013-03-19T22:37:57.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T22:32:36.000Z us-west-2b m1.small Linux/UNIX 0.025000 2013-03-19T22:32:36.000Z us-west-2c m2.2xlarge Linux/UNIX 0.820000 2013-03-19T22:32:29.000Z us-west-2b m2.4xlarge Linux/UNIX 0.224000 2013-03-19T22:30:49.000Z us-west-2c m1.small Linux/UNIX 0.020000 2013-03-19T22:27:04.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T22:27:04.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-19T22:21:36.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-19T22:14:15.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T22:05:05.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-19T21:59:30.000Z us-west-2b m1.xlarge Linux/UNIX 0.083000 2013-03-19T21:57:39.000Z us-west-2b cc2.8xlarge Windows (Amazon VPC) 0.456000 2013-03-19T21:56:06.000Z us-west-2a cc2.8xlarge Windows 0.456000 2013-03-19T21:55:57.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-19T21:52:11.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-19T21:46:36.000Z us-west-2b cc2.8xlarge Linux/UNIX (Amazon VPC) 0.253000 2013-03-19T21:39:24.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-19T21:37:31.000Z us-west-2b cc2.8xlarge Windows 0.456000 2013-03-19T21:35:48.000Z us-west-2c m1.small Linux/UNIX 0.020000 2013-03-19T21:31:54.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T21:24:35.000Z us-west-2b m2.2xlarge Linux/UNIX 0.112000 2013-03-19T21:24:28.000Z us-west-2c cr1.8xlarge Linux/UNIX (Amazon VPC) 0.343000 2013-03-19T21:17:27.000Z us-west-2b cr1.8xlarge Linux/UNIX (Amazon VPC) 0.343000 2013-03-19T21:17:27.000Z us-west-2a cr1.8xlarge Linux/UNIX (Amazon VPC) 0.343000 2013-03-19T21:17:27.000Z us-west-2c cr1.8xlarge SUSE Linux 0.351000 2013-03-19T21:17:11.000Z us-west-2b cr1.8xlarge SUSE Linux 0.351000 2013-03-19T21:17:11.000Z us-west-2a cr1.8xlarge SUSE Linux 0.351000 2013-03-19T21:17:11.000Z us-west-2c cr1.8xlarge Linux/UNIX 0.343000 2013-03-19T21:17:09.000Z us-west-2b cr1.8xlarge Linux/UNIX 0.343000 2013-03-19T21:17:09.000Z us-west-2a cr1.8xlarge Linux/UNIX 0.343000 2013-03-19T21:17:09.000Z us-west-2c cc2.8xlarge Linux/UNIX (Amazon VPC) 0.253000 2013-03-19T21:12:01.000Z us-west-2b cc2.8xlarge Linux/UNIX (Amazon VPC) 0.253000 2013-03-19T21:12:01.000Z us-west-2a m2.4xlarge Windows 0.448000 2013-03-19T21:11:58.000Z us-west-2a m1.medium Windows 0.053000 2013-03-19T21:09:58.000Z us-west-2a m1.small Linux/UNIX 0.020000 2013-03-19T21:01:06.000Z us-west-2b m1.small Linux/UNIX 0.162000 2013-03-19T21:01:06.000Z us-west-2a m1.medium Linux/UNIX 0.021000 2013-03-19T20:55:41.000Z us-west-2a c1.medium Linux/UNIX 0.028000 2013-03-19T20:50:29.000Z us-west-2c m1.large Linux/UNIX 0.042000 2013-03-19T20:46:46.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T20:39:22.000Z us-west-2b m1.large Linux/UNIX 0.240000 2013-03-19T20:35:50.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-19T20:28:21.000Z us-west-2b m1.large Linux/UNIX 0.990000 2013-03-19T20:24:47.000Z us-west-2b c1.xlarge Windows 0.320000 2013-03-19T20:19:33.000Z us-west-2a m1.large Linux/UNIX 0.042000 2013-03-19T20:19:22.000Z us-west-2b m1.large Linux/UNIX 0.100000 2013-03-19T20:13:53.000Z us-west-2b m1.large Linux/UNIX 0.240000 2013-03-19T20:08:26.000Z us-west-2b m2.2xlarge Linux/UNIX 0.112000 2013-03-19T19:58:59.000Z us-west-2a m1.small Windows 0.026000 2013-03-19T19:58:57.000Z us-west-2a m1.small Windows 0.026000 2013-03-19T19:58:57.000Z us-west-2c m1.large Linux/UNIX 0.042000 2013-03-19T19:41:01.000Z us-west-2b m1.medium Windows 0.053000 2013-03-19T19:38:50.000Z us-west-2b m1.large Linux/UNIX 0.240000 2013-03-19T19:35:36.000Z us-west-2b c1.medium Windows 0.080000 2013-03-19T19:35:07.000Z us-west-2a m2.4xlarge Linux/UNIX (Amazon VPC) 0.224000 2013-03-19T19:22:39.000Z us-west-2a m1.large Linux/UNIX 0.042000 2013-03-19T19:20:55.000Z us-west-2b m1.large Linux/UNIX 0.240000 2013-03-19T19:13:36.000Z us-west-2b m1.large Linux/UNIX 0.100000 2013-03-19T19:08:10.000Z us-west-2b t1.micro Linux/UNIX (Amazon VPC) 0.004000 2013-03-19T19:06:04.000Z us-west-2a cc2.8xlarge Windows (Amazon VPC) 0.456000 2013-03-19T19:04:42.000Z us-west-2b cc2.8xlarge Windows 0.456000 2013-03-19T19:04:34.000Z us-west-2b m1.small Windows 0.026000 2013-03-19T19:04:17.000Z us-west-2b m1.large Linux/UNIX 0.990000 2013-03-19T19:02:41.000Z us-west-2b m1.small Linux/UNIX (Amazon VPC) 0.010000 2013-03-19T19:00:35.000Z us-west-2c m1.large Linux/UNIX 0.900000 2013-03-19T18:57:11.000Z us-west-2b m1.large Linux/UNIX 0.042000 2013-03-19T18:51:41.000Z us-west-2b m1.large Linux/UNIX 0.900000 2013-03-19T18:44:17.000Z us-west-2b m1.large Linux/UNIX 0.240000 2013-03-19T18:38:50.000Z us-west-2b m1.large Linux/UNIX 0.900000 2013-03-19T18:33:23.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T18:27:46.000Z us-west-2c m2.4xlarge Windows 0.448000 2013-03-19T18:24:04.000Z us-west-2c t1.micro Windows 0.009000 2013-03-19T18:20:16.000Z us-west-2c m1.large Windows 0.106000 2013-03-19T18:11:12.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T17:49:25.000Z us-west-2b t1.micro Windows 0.009000 2013-03-19T17:45:35.000Z us-west-2a m1.small Linux/UNIX 0.012000 2013-03-19T17:43:58.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T15:43:52.000Z us-west-2b m1.small Linux/UNIX 0.018000 2013-03-19T15:38:27.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T15:33:02.000Z us-west-2b m1.small Linux/UNIX 0.018000 2013-03-19T15:27:36.000Z us-west-2b m1.small Linux/UNIX 0.025000 2013-03-19T15:03:47.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-19T13:56:36.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-19T13:54:47.000Z us-west-2b m1.small Linux/UNIX 0.015000 2013-03-19T13:49:24.000Z us-west-2b m1.small Linux/UNIX 0.025000 2013-03-19T13:42:13.000Z us-west-2c m1.large Windows 0.106000 2013-03-19T13:31:14.000Z us-west-2c t1.micro Linux/UNIX 0.004000 2013-03-19T12:35:09.000Z us-west-2c cc2.8xlarge Linux/UNIX 0.253000 2013-03-19T12:30:05.000Z us-west-2c t1.micro Linux/UNIX 0.004000 2013-03-19T12:24:11.000Z us-west-2a t1.micro Windows 0.009000 2013-03-19T11:46:06.000Z us-west-2b m2.4xlarge Linux/UNIX 0.224000 2013-03-19T11:22:57.000Z us-west-2b m1.large Windows 0.106000 2013-03-19T10:50:06.000Z us-west-2a m1.large Linux/UNIX (Amazon VPC) 0.042000 2013-03-19T10:10:25.000Z us-west-2c m1.medium Linux/UNIX (Amazon VPC) 0.021000 2013-03-19T09:59:48.000Z us-west-2c m1.large Linux/UNIX 0.042000 2013-03-19T09:16:25.000Z us-west-2b m1.large Linux/UNIX 0.042000 2013-03-19T09:09:13.000Z us-west-2c m1.large Linux/UNIX 0.042000 2013-03-19T09:00:12.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-19T08:54:28.000Z us-west-2b m1.small Linux/UNIX 0.013000 2013-03-19T08:49:00.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T08:43:39.000Z us-west-2b m1.small Linux/UNIX 0.013000 2013-03-19T08:38:16.000Z us-west-2b m1.large Linux/UNIX (Amazon VPC) 0.042000 2013-03-19T07:51:13.000Z us-west-2a c1.medium Windows 0.080000 2013-03-19T07:47:21.000Z us-west-2b m1.large Linux/UNIX (Amazon VPC) 0.042000 2013-03-19T07:17:03.000Z us-west-2b cc2.8xlarge Linux/UNIX 0.253000 2013-03-19T07:15:37.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-19T06:51:54.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-19T06:46:31.000Z us-west-2b c1.xlarge Linux/UNIX 0.112000 2013-03-19T06:42:35.000Z us-west-2b c1.xlarge Linux/UNIX 0.112000 2013-03-19T06:42:35.000Z us-west-2a c1.xlarge Linux/UNIX 0.112000 2013-03-19T06:42:35.000Z us-west-2c c1.xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-19T06:42:30.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T06:39:13.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-19T06:32:01.000Z us-west-2b m3.2xlarge SUSE Linux (Amazon VPC) 0.192000 2013-03-19T06:23:10.000Z us-west-2b m3.2xlarge SUSE Linux (Amazon VPC) 0.192000 2013-03-19T06:23:10.000Z us-west-2a m3.2xlarge SUSE Linux (Amazon VPC) 0.192000 2013-03-19T06:23:10.000Z us-west-2c m3.2xlarge Windows (Amazon VPC) 0.439000 2013-03-19T06:21:28.000Z us-west-2b m3.2xlarge Windows (Amazon VPC) 0.439000 2013-03-19T06:21:27.000Z us-west-2a m3.2xlarge Windows (Amazon VPC) 0.439000 2013-03-19T06:21:27.000Z us-west-2c m3.2xlarge Linux/UNIX (Amazon VPC) 0.183000 2013-03-19T06:21:25.000Z us-west-2b m3.2xlarge Linux/UNIX (Amazon VPC) 0.183000 2013-03-19T06:21:25.000Z us-west-2a m3.2xlarge Linux/UNIX (Amazon VPC) 0.183000 2013-03-19T06:21:25.000Z us-west-2c m3.xlarge Linux/UNIX (Amazon VPC) 0.092000 2013-03-19T06:19:08.000Z us-west-2b m3.xlarge Linux/UNIX (Amazon VPC) 0.092000 2013-03-19T06:19:08.000Z us-west-2a m3.xlarge Linux/UNIX (Amazon VPC) 0.092000 2013-03-19T06:19:08.000Z us-west-2c m3.xlarge Windows (Amazon VPC) 0.220000 2013-03-19T06:17:32.000Z us-west-2b m3.xlarge Windows (Amazon VPC) 0.220000 2013-03-19T06:17:32.000Z us-west-2a m3.xlarge Windows (Amazon VPC) 0.220000 2013-03-19T06:17:32.000Z us-west-2c m3.xlarge SUSE Linux (Amazon VPC) 0.101000 2013-03-19T06:17:23.000Z us-west-2b m3.xlarge SUSE Linux (Amazon VPC) 0.101000 2013-03-19T06:17:23.000Z us-west-2a m3.xlarge SUSE Linux (Amazon VPC) 0.101000 2013-03-19T06:17:23.000Z us-west-2c m1.small Windows (Amazon VPC) 0.026000 2013-03-19T06:14:07.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-19T06:14:01.000Z us-west-2c c1.medium Linux/UNIX (Amazon VPC) 0.028000 2013-03-19T06:13:41.000Z us-west-2b m3.2xlarge Windows 0.439000 2013-03-19T06:06:38.000Z us-west-2b m3.2xlarge Windows 0.439000 2013-03-19T06:06:38.000Z us-west-2a m3.2xlarge Windows 0.439000 2013-03-19T06:06:38.000Z us-west-2c m3.xlarge Windows 0.220000 2013-03-19T06:05:20.000Z us-west-2b m3.xlarge Windows 0.220000 2013-03-19T06:05:20.000Z us-west-2a m3.xlarge Windows 0.220000 2013-03-19T06:05:20.000Z us-west-2c m1.small Linux/UNIX 0.025000 2013-03-19T06:03:15.000Z us-west-2c m1.medium Windows 0.053000 2013-03-19T05:57:31.000Z us-west-2c m3.2xlarge SUSE Linux 0.192000 2013-03-19T05:56:18.000Z us-west-2b m3.2xlarge SUSE Linux 0.192000 2013-03-19T05:56:18.000Z us-west-2a m3.2xlarge SUSE Linux 0.192000 2013-03-19T05:56:18.000Z us-west-2c m3.2xlarge Linux/UNIX 0.183000 2013-03-19T05:56:17.000Z us-west-2b m3.2xlarge Linux/UNIX 0.183000 2013-03-19T05:56:17.000Z us-west-2a m3.2xlarge Linux/UNIX 0.183000 2013-03-19T05:56:17.000Z us-west-2c m3.xlarge SUSE Linux 0.101000 2013-03-19T05:50:38.000Z us-west-2b m3.xlarge SUSE Linux 0.101000 2013-03-19T05:50:38.000Z us-west-2a m3.xlarge SUSE Linux 0.101000 2013-03-19T05:50:38.000Z us-west-2c m3.xlarge Linux/UNIX 0.092000 2013-03-19T05:50:37.000Z us-west-2b m3.xlarge Linux/UNIX 0.092000 2013-03-19T05:50:37.000Z us-west-2a m3.xlarge Linux/UNIX 0.092000 2013-03-19T05:50:37.000Z us-west-2c t1.micro Windows (Amazon VPC) 0.009000 2013-03-19T05:36:09.000Z us-west-2b t1.micro Windows (Amazon VPC) 0.009000 2013-03-19T05:36:09.000Z us-west-2c t1.micro Linux/UNIX (Amazon VPC) 0.004000 2013-03-19T05:32:29.000Z us-west-2b t1.micro SUSE Linux (Amazon VPC) 0.009000 2013-03-19T05:30:38.000Z us-west-2b t1.micro SUSE Linux (Amazon VPC) 0.009000 2013-03-19T05:30:38.000Z us-west-2a t1.micro SUSE Linux (Amazon VPC) 0.009000 2013-03-19T05:30:38.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-19T05:27:17.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-19T05:21:55.000Z us-west-2b m1.small Linux/UNIX (Amazon VPC) 0.010000 2013-03-19T05:12:50.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-19T05:05:42.000Z us-west-2b t1.micro Linux/UNIX 0.004000 2013-03-19T05:05:34.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-19T05:00:17.000Z us-west-2b t1.micro Linux/UNIX 0.015000 2013-03-19T05:00:08.000Z us-west-2b t1.micro Linux/UNIX 0.004000 2013-03-19T04:47:29.000Z us-west-2b c1.medium Windows 0.080000 2013-03-19T04:38:17.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-19T04:17:07.000Z us-west-2c m1.small Linux/UNIX 0.025000 2013-03-19T04:00:44.000Z us-west-2c m1.xlarge Linux/UNIX 0.083000 2013-03-19T03:49:54.000Z us-west-2a m2.xlarge Linux/UNIX (Amazon VPC) 0.056000 2013-03-19T03:40:41.000Z us-west-2b c1.medium Linux/UNIX (Amazon VPC) 0.028000 2013-03-19T03:40:40.000Z us-west-2a c1.medium Linux/UNIX (Amazon VPC) 0.028000 2013-03-19T03:40:40.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-19T03:35:36.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T03:35:36.000Z us-west-2a m2.xlarge Linux/UNIX 0.056000 2013-03-19T03:33:49.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-19T03:30:05.000Z us-west-2b t1.micro Linux/UNIX (Amazon VPC) 0.004000 2013-03-19T03:29:54.000Z us-west-2c m1.small Linux/UNIX 0.031000 2013-03-19T03:14:01.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-19T03:05:09.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-19T02:59:39.000Z us-west-2b m2.xlarge Linux/UNIX 0.500000 2013-03-19T02:52:30.000Z us-west-2b m2.xlarge Linux/UNIX (Amazon VPC) 0.100000 2013-03-19T02:52:12.000Z us-west-2b m2.xlarge Linux/UNIX 0.460000 2013-03-19T02:47:03.000Z us-west-2b m2.xlarge Linux/UNIX 0.056000 2013-03-19T02:47:03.000Z us-west-2a m2.xlarge Linux/UNIX 0.056000 2013-03-19T02:47:03.000Z us-west-2c m1.xlarge Windows 0.211000 2013-03-19T02:43:44.000Z us-west-2b m1.xlarge Windows 0.211000 2013-03-19T02:43:44.000Z us-west-2a m1.xlarge Windows 0.211000 2013-03-19T02:43:44.000Z us-west-2c m2.4xlarge Linux/UNIX (Amazon VPC) 0.224000 2013-03-19T02:41:49.000Z us-west-2b m2.4xlarge Linux/UNIX (Amazon VPC) 0.224000 2013-03-19T02:41:49.000Z us-west-2c m2.xlarge Linux/UNIX 0.320000 2013-03-19T02:41:40.000Z us-west-2b m2.xlarge Linux/UNIX 0.700000 2013-03-19T02:41:40.000Z us-west-2a m2.xlarge Linux/UNIX 0.071000 2013-03-19T02:41:40.000Z us-west-2c t1.micro Windows (Amazon VPC) 0.009000 2013-03-19T02:39:47.000Z us-west-2a m2.2xlarge Windows 0.224000 2013-03-19T02:39:37.000Z us-west-2b m2.2xlarge Windows 0.224000 2013-03-19T02:39:37.000Z us-west-2a m2.2xlarge Windows 0.224000 2013-03-19T02:39:37.000Z us-west-2c cc2.8xlarge Windows (Amazon VPC) 0.456000 2013-03-19T02:31:04.000Z us-west-2c t1.micro SUSE Linux 0.009000 2013-03-19T02:30:36.000Z us-west-2b t1.micro SUSE Linux 0.009000 2013-03-19T02:30:36.000Z us-west-2a t1.micro SUSE Linux 0.009000 2013-03-19T02:30:36.000Z us-west-2c m2.xlarge Windows (Amazon VPC) 0.112000 2013-03-19T02:29:11.000Z us-west-2b m2.xlarge Windows (Amazon VPC) 0.112000 2013-03-19T02:29:11.000Z us-west-2a m2.xlarge Windows (Amazon VPC) 0.112000 2013-03-19T02:29:11.000Z us-west-2c m1.large SUSE Linux 0.050000 2013-03-19T02:27:22.000Z us-west-2b m1.large SUSE Linux 0.050000 2013-03-19T02:27:22.000Z us-west-2a m1.large SUSE Linux 0.050000 2013-03-19T02:27:22.000Z us-west-2c m1.small Windows (Amazon VPC) 0.026000 2013-03-19T02:27:17.000Z us-west-2b m1.small Windows (Amazon VPC) 0.026000 2013-03-19T02:27:17.000Z us-west-2c m2.xlarge Windows 0.112000 2013-03-19T02:27:15.000Z us-west-2b m2.xlarge Windows 0.112000 2013-03-19T02:27:15.000Z us-west-2a m2.xlarge Windows 0.112000 2013-03-19T02:27:15.000Z us-west-2c m2.xlarge SUSE Linux 0.067000 2013-03-19T02:27:14.000Z us-west-2b m2.xlarge SUSE Linux 0.067000 2013-03-19T02:27:13.000Z us-west-2a m2.xlarge SUSE Linux 0.067000 2013-03-19T02:27:13.000Z us-west-2c m1.large SUSE Linux (Amazon VPC) 0.050000 2013-03-19T02:27:08.000Z us-west-2b m1.large SUSE Linux (Amazon VPC) 0.050000 2013-03-19T02:27:08.000Z us-west-2a m1.large SUSE Linux (Amazon VPC) 0.050000 2013-03-19T02:27:08.000Z us-west-2c c1.xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-19T02:26:54.000Z us-west-2b c1.xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-19T02:26:54.000Z us-west-2a c1.xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-19T02:26:54.000Z us-west-2c c1.xlarge Windows (Amazon VPC) 0.320000 2013-03-19T02:25:44.000Z us-west-2b c1.xlarge Windows (Amazon VPC) 0.320000 2013-03-19T02:25:44.000Z us-west-2a c1.xlarge Windows (Amazon VPC) 0.320000 2013-03-19T02:25:44.000Z us-west-2c c1.medium SUSE Linux 0.038000 2013-03-19T02:25:39.000Z us-west-2b c1.medium SUSE Linux 0.038000 2013-03-19T02:25:39.000Z us-west-2a c1.medium SUSE Linux 0.038000 2013-03-19T02:25:39.000Z us-west-2c c1.medium SUSE Linux (Amazon VPC) 0.038000 2013-03-19T02:25:05.000Z us-west-2b c1.medium SUSE Linux (Amazon VPC) 0.038000 2013-03-19T02:25:05.000Z us-west-2a c1.medium SUSE Linux (Amazon VPC) 0.038000 2013-03-19T02:25:05.000Z us-west-2c m2.4xlarge SUSE Linux 0.234000 2013-03-19T02:23:41.000Z us-west-2b m2.4xlarge SUSE Linux 0.234000 2013-03-19T02:23:41.000Z us-west-2a m2.4xlarge SUSE Linux 0.234000 2013-03-19T02:23:41.000Z us-west-2c m1.medium SUSE Linux 0.030000 2013-03-19T02:23:35.000Z us-west-2b m1.medium SUSE Linux 0.030000 2013-03-19T02:23:35.000Z us-west-2a m1.medium SUSE Linux 0.030000 2013-03-19T02:23:35.000Z us-west-2c t1.micro Linux/UNIX 0.020000 2013-03-19T02:23:28.000Z us-west-2b m2.2xlarge SUSE Linux 0.122000 2013-03-19T02:21:42.000Z us-west-2b m2.2xlarge SUSE Linux 0.122000 2013-03-19T02:21:42.000Z us-west-2a m2.2xlarge SUSE Linux 0.122000 2013-03-19T02:21:42.000Z us-west-2c c1.medium Windows (Amazon VPC) 0.080000 2013-03-19T02:21:41.000Z us-west-2b c1.medium Windows (Amazon VPC) 0.080000 2013-03-19T02:21:41.000Z us-west-2a c1.medium Windows (Amazon VPC) 0.080000 2013-03-19T02:21:41.000Z us-west-2c m1.xlarge Windows (Amazon VPC) 0.211000 2013-03-19T02:20:14.000Z us-west-2b m1.xlarge Windows (Amazon VPC) 0.211000 2013-03-19T02:20:14.000Z us-west-2a m1.medium SUSE Linux (Amazon VPC) 0.030000 2013-03-19T02:20:13.000Z us-west-2b m1.medium SUSE Linux (Amazon VPC) 0.030000 2013-03-19T02:20:13.000Z us-west-2a m1.medium SUSE Linux (Amazon VPC) 0.030000 2013-03-19T02:20:13.000Z us-west-2c m2.2xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-19T02:20:12.000Z us-west-2b m2.2xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-19T02:20:12.000Z us-west-2a m2.2xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-19T02:20:12.000Z us-west-2c m2.4xlarge SUSE Linux (Amazon VPC) 0.234000 2013-03-19T02:20:07.000Z us-west-2b m2.4xlarge SUSE Linux (Amazon VPC) 0.234000 2013-03-19T02:20:07.000Z us-west-2a m2.4xlarge SUSE Linux (Amazon VPC) 0.234000 2013-03-19T02:20:07.000Z us-west-2c m2.4xlarge Windows 0.448000 2013-03-19T02:20:01.000Z us-west-2b m2.2xlarge Windows (Amazon VPC) 0.224000 2013-03-19T02:20:00.000Z us-west-2b m2.2xlarge Windows (Amazon VPC) 0.224000 2013-03-19T02:20:00.000Z us-west-2a m2.2xlarge Windows (Amazon VPC) 0.224000 2013-03-19T02:20:00.000Z us-west-2c m1.xlarge SUSE Linux 0.090000 2013-03-19T02:19:58.000Z us-west-2b m1.xlarge SUSE Linux 0.090000 2013-03-19T02:19:58.000Z us-west-2a m1.xlarge SUSE Linux 0.090000 2013-03-19T02:19:58.000Z us-west-2c m1.small SUSE Linux (Amazon VPC) 0.021000 2013-03-19T02:19:55.000Z us-west-2b m1.small SUSE Linux (Amazon VPC) 0.021000 2013-03-19T02:19:55.000Z us-west-2a m1.small SUSE Linux (Amazon VPC) 0.021000 2013-03-19T02:19:55.000Z us-west-2c c1.xlarge SUSE Linux 0.122000 2013-03-19T02:19:45.000Z us-west-2b c1.xlarge SUSE Linux 0.122000 2013-03-19T02:19:45.000Z us-west-2a c1.xlarge SUSE Linux 0.122000 2013-03-19T02:19:45.000Z us-west-2c m2.xlarge Linux/UNIX (Amazon VPC) 0.056000 2013-03-19T02:19:42.000Z us-west-2a m2.xlarge Linux/UNIX (Amazon VPC) 0.056000 2013-03-19T02:19:42.000Z us-west-2c m2.xlarge SUSE Linux (Amazon VPC) 0.067000 2013-03-19T02:19:42.000Z us-west-2b m2.xlarge SUSE Linux (Amazon VPC) 0.067000 2013-03-19T02:19:42.000Z us-west-2a m2.xlarge SUSE Linux (Amazon VPC) 0.067000 2013-03-19T02:19:42.000Z us-west-2c m1.xlarge Linux/UNIX (Amazon VPC) 0.083000 2013-03-19T02:19:40.000Z us-west-2b m1.xlarge Linux/UNIX (Amazon VPC) 0.083000 2013-03-19T02:19:40.000Z us-west-2a c1.xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-19T02:19:40.000Z us-west-2c m1.xlarge SUSE Linux (Amazon VPC) 0.090000 2013-03-19T02:19:39.000Z us-west-2b m1.xlarge SUSE Linux (Amazon VPC) 0.090000 2013-03-19T02:19:39.000Z us-west-2a m1.xlarge SUSE Linux (Amazon VPC) 0.090000 2013-03-19T02:19:39.000Z us-west-2c m1.medium Windows (Amazon VPC) 0.053000 2013-03-19T02:18:27.000Z us-west-2b m1.medium Windows (Amazon VPC) 0.053000 2013-03-19T02:18:27.000Z us-west-2a m1.medium Windows (Amazon VPC) 0.053000 2013-03-19T02:18:27.000Z us-west-2c m1.medium Linux/UNIX (Amazon VPC) 0.021000 2013-03-19T02:18:26.000Z us-west-2b m2.2xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-19T02:18:24.000Z us-west-2a m2.2xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-19T02:18:24.000Z us-west-2c m1.large Windows (Amazon VPC) 0.106000 2013-03-19T02:18:22.000Z us-west-2b m1.large Windows (Amazon VPC) 0.106000 2013-03-19T02:18:22.000Z us-west-2a m1.large Windows (Amazon VPC) 0.106000 2013-03-19T02:18:22.000Z us-west-2c m2.4xlarge Windows (Amazon VPC) 0.448000 2013-03-19T02:18:19.000Z us-west-2b m2.4xlarge Windows (Amazon VPC) 0.448000 2013-03-19T02:18:19.000Z us-west-2a m2.4xlarge Windows (Amazon VPC) 0.448000 2013-03-19T02:18:19.000Z us-west-2c m1.small SUSE Linux 0.021000 2013-03-19T02:18:13.000Z us-west-2b m1.small SUSE Linux 0.021000 2013-03-19T02:18:13.000Z us-west-2a m1.small SUSE Linux 0.021000 2013-03-19T02:18:13.000Z us-west-2c t1.micro Linux/UNIX 0.012000 2013-03-19T02:18:05.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T02:11:07.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-19T02:05:49.000Z us-west-2b c1.medium Linux/UNIX 0.028000 2013-03-19T01:35:25.000Z us-west-2a m2.4xlarge Linux/UNIX 0.224000 2013-03-19T01:35:17.000Z us-west-2a m1.small Linux/UNIX (Amazon VPC) 0.010000 2013-03-19T01:35:03.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T01:26:10.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-19T01:19:03.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T01:13:42.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-19T01:08:16.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-19T00:59:14.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-19T00:52:06.000Z us-west-2b m1.small Linux/UNIX 0.013000 2013-03-19T00:50:21.000Z us-west-2a m1.small Linux/UNIX 0.020000 2013-03-19T00:46:47.000Z us-west-2b m1.xlarge Linux/UNIX (Amazon VPC) 0.083000 2013-03-19T00:41:08.000Z us-west-2c cc2.8xlarge Linux/UNIX 0.253000 2013-03-19T00:25:41.000Z us-west-2b m1.medium Linux/UNIX (Amazon VPC) 0.021000 2013-03-19T00:22:02.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-19T00:16:32.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-19T00:11:10.000Z us-west-2b c1.xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-19T00:00:11.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-18T23:55:08.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-18T23:49:46.000Z us-west-2b m1.xlarge Linux/UNIX 0.083000 2013-03-18T23:46:14.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-18T23:40:51.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T23:40:51.000Z us-west-2c m1.small Linux/UNIX 0.020000 2013-03-18T23:35:34.000Z us-west-2b m1.small Linux/UNIX 0.025000 2013-03-18T23:33:48.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-18T23:30:15.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-18T23:24:54.000Z us-west-2b c1.medium Linux/UNIX 0.028000 2013-03-18T23:23:21.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T23:17:46.000Z us-west-2b c1.xlarge Windows 0.320000 2013-03-18T23:09:11.000Z us-west-2c m1.small Linux/UNIX 0.020000 2013-03-18T23:08:52.000Z us-west-2b m1.medium Linux/UNIX 0.021000 2013-03-18T23:07:03.000Z us-west-2c c1.xlarge Windows 0.320000 2013-03-18T23:03:44.000Z us-west-2b m1.xlarge Windows (Amazon VPC) 0.211000 2013-03-18T22:59:58.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-18T22:58:00.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-18T22:56:15.000Z us-west-2a m2.2xlarge Linux/UNIX 0.112000 2013-03-18T22:48:55.000Z us-west-2b m1.medium Linux/UNIX 0.021000 2013-03-18T22:45:31.000Z us-west-2b m2.2xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-18T22:43:53.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-18T22:41:54.000Z us-west-2a m1.small Linux/UNIX 0.025000 2013-03-18T22:36:36.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-18T22:33:05.000Z us-west-2a m2.4xlarge Linux/UNIX 0.224000 2013-03-18T22:29:33.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-18T22:09:56.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-18T22:04:37.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T21:59:18.000Z us-west-2b m1.xlarge Linux/UNIX 0.083000 2013-03-18T21:57:30.000Z us-west-2b cc2.8xlarge Windows (Amazon VPC) 0.456000 2013-03-18T21:56:00.000Z us-west-2a cc2.8xlarge Windows 0.456000 2013-03-18T21:55:53.000Z us-west-2a m1.small Linux/UNIX 0.020000 2013-03-18T21:53:58.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T21:48:36.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-18T21:43:18.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T21:41:30.000Z us-west-2c cc2.8xlarge Linux/UNIX (Amazon VPC) 0.253000 2013-03-18T21:38:00.000Z us-west-2c cc2.8xlarge Windows 0.456000 2013-03-18T21:34:27.000Z us-west-2c m1.small Linux/UNIX 0.016000 2013-03-18T21:32:30.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-18T21:27:12.000Z us-west-2b m1.small Linux/UNIX 0.014000 2013-03-18T21:21:50.000Z us-west-2b cr1.8xlarge Linux/UNIX (Amazon VPC) 0.343000 2013-03-18T21:16:32.000Z us-west-2b cr1.8xlarge Linux/UNIX (Amazon VPC) 0.343000 2013-03-18T21:16:32.000Z us-west-2a cr1.8xlarge Linux/UNIX (Amazon VPC) 0.343000 2013-03-18T21:16:32.000Z us-west-2c m2.2xlarge Linux/UNIX 0.112000 2013-03-18T21:16:23.000Z us-west-2c cr1.8xlarge SUSE Linux 0.351000 2013-03-18T21:16:15.000Z us-west-2b cr1.8xlarge SUSE Linux 0.351000 2013-03-18T21:16:15.000Z us-west-2a cr1.8xlarge SUSE Linux 0.351000 2013-03-18T21:16:15.000Z us-west-2c cr1.8xlarge Linux/UNIX 0.343000 2013-03-18T21:16:14.000Z us-west-2b cr1.8xlarge Linux/UNIX 0.343000 2013-03-18T21:16:14.000Z us-west-2a cr1.8xlarge Linux/UNIX 0.343000 2013-03-18T21:16:14.000Z us-west-2c cc2.8xlarge Linux/UNIX (Amazon VPC) 0.253000 2013-03-18T21:11:14.000Z us-west-2b cc2.8xlarge Linux/UNIX (Amazon VPC) 0.253000 2013-03-18T21:11:14.000Z us-west-2a m2.4xlarge Windows 0.448000 2013-03-18T21:11:13.000Z us-west-2a m1.medium Windows 0.053000 2013-03-18T21:09:10.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-18T21:07:35.000Z us-west-2b m1.small Linux/UNIX 0.014000 2013-03-18T21:02:15.000Z us-west-2b m1.medium Linux/UNIX 0.021000 2013-03-18T20:55:10.000Z us-west-2a c1.medium Linux/UNIX 0.028000 2013-03-18T20:50:08.000Z us-west-2c c1.xlarge Windows 0.320000 2013-03-18T20:18:34.000Z us-west-2a m2.2xlarge Linux/UNIX 0.112000 2013-03-18T19:58:37.000Z us-west-2a m1.small Windows 0.026000 2013-03-18T19:58:35.000Z us-west-2a m1.small Windows 0.026000 2013-03-18T19:58:35.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-18T19:53:30.000Z us-west-2b m1.small Linux/UNIX 0.013000 2013-03-18T19:46:32.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T19:39:31.000Z us-west-2b m1.medium Windows 0.053000 2013-03-18T19:37:34.000Z us-west-2b m1.small Linux/UNIX 0.013000 2013-03-18T19:34:15.000Z us-west-2b c1.medium Windows 0.080000 2013-03-18T19:33:55.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-18T19:25:29.000Z us-west-2b m2.4xlarge Linux/UNIX (Amazon VPC) 0.224000 2013-03-18T19:22:08.000Z us-west-2a m1.small Linux/UNIX 0.013000 2013-03-18T19:20:13.000Z us-west-2b t1.micro Linux/UNIX (Amazon VPC) 0.004000 2013-03-18T19:06:00.000Z us-west-2a cc2.8xlarge Windows (Amazon VPC) 0.456000 2013-03-18T19:04:39.000Z us-west-2b cc2.8xlarge Windows 0.456000 2013-03-18T19:02:47.000Z us-west-2b m1.small Windows 0.026000 2013-03-18T19:02:31.000Z us-west-2b m1.small Linux/UNIX (Amazon VPC) 0.010000 2013-03-18T18:58:59.000Z us-west-2c m2.4xlarge Windows 0.448000 2013-03-18T18:23:45.000Z us-west-2c t1.micro Windows 0.009000 2013-03-18T18:20:00.000Z us-west-2c m1.large Windows 0.106000 2013-03-18T18:09:23.000Z us-west-2b t1.micro Windows 0.009000 2013-03-18T17:44:35.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-18T17:42:58.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-18T16:25:12.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-18T16:12:55.000Z us-west-2b m2.xlarge Linux/UNIX (Amazon VPC) 0.056000 2013-03-18T16:07:22.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T16:05:52.000Z us-west-2b m2.xlarge Linux/UNIX 0.056000 2013-03-18T16:05:51.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-18T16:00:24.000Z us-west-2b m2.xlarge Linux/UNIX (Amazon VPC) 0.100000 2013-03-18T16:00:03.000Z us-west-2b m2.xlarge Linux/UNIX 0.500000 2013-03-18T15:58:34.000Z us-west-2b m1.small Linux/UNIX 0.018000 2013-03-18T15:55:01.000Z us-west-2b m1.small Linux/UNIX 0.025000 2013-03-18T15:53:16.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-18T15:39:11.000Z us-west-2b m1.small Linux/UNIX 0.018000 2013-03-18T15:33:54.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T15:26:47.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-18T15:21:30.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T15:16:08.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-18T15:10:54.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T15:05:40.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-18T15:00:21.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T14:55:03.000Z us-west-2b m2.xlarge Linux/UNIX 0.056000 2013-03-18T14:36:42.000Z us-west-2a m2.xlarge Linux/UNIX 0.056000 2013-03-18T14:36:42.000Z us-west-2c m1.small Linux/UNIX 0.014000 2013-03-18T14:22:59.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T14:17:44.000Z us-west-2b m1.small Linux/UNIX 0.014000 2013-03-18T14:12:28.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T14:07:13.000Z us-west-2b m1.small Linux/UNIX 0.014000 2013-03-18T14:01:53.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T13:56:38.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-18T13:51:24.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T13:46:07.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-18T13:37:25.000Z us-west-2b m1.large Windows 0.106000 2013-03-18T13:30:11.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-18T12:50:04.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-18T12:43:06.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T12:36:08.000Z us-west-2b t1.micro Linux/UNIX 0.004000 2013-03-18T12:34:15.000Z us-west-2c cc2.8xlarge Linux/UNIX 0.253000 2013-03-18T12:29:21.000Z us-west-2c m1.small Linux/UNIX 0.012000 2013-03-18T12:27:22.000Z us-west-2b t1.micro Linux/UNIX 0.004000 2013-03-18T12:23:44.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-18T11:57:38.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-18T11:48:47.000Z us-west-2b t1.micro Windows 0.009000 2013-03-18T11:45:08.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T11:40:01.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-18T11:33:02.000Z us-west-2b m2.4xlarge Linux/UNIX 0.224000 2013-03-18T11:22:31.000Z us-west-2b m1.large Windows 0.106000 2013-03-18T10:49:08.000Z us-west-2a m1.large Linux/UNIX (Amazon VPC) 0.042000 2013-03-18T10:09:02.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-18T10:03:53.000Z us-west-2b m1.medium Linux/UNIX (Amazon VPC) 0.021000 2013-03-18T09:58:49.000Z us-west-2c m1.small Linux/UNIX 0.012000 2013-03-18T09:58:37.000Z us-west-2b m1.large Linux/UNIX 0.042000 2013-03-18T09:15:04.000Z us-west-2b m1.large Linux/UNIX 0.042000 2013-03-18T09:08:06.000Z us-west-2c m1.large Linux/UNIX 0.042000 2013-03-18T08:59:25.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-18T08:22:45.000Z us-west-2b m1.small Linux/UNIX 0.014000 2013-03-18T08:14:05.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T08:08:53.000Z us-west-2b m1.small Linux/UNIX 0.014000 2013-03-18T08:03:39.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T07:58:22.000Z us-west-2b m1.small Linux/UNIX 0.016000 2013-03-18T07:53:09.000Z us-west-2b m1.large Linux/UNIX (Amazon VPC) 0.042000 2013-03-18T07:49:34.000Z us-west-2a c1.medium Windows 0.080000 2013-03-18T07:45:47.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-18T07:40:56.000Z us-west-2b m1.small Linux/UNIX 0.016000 2013-03-18T07:35:42.000Z us-west-2b m1.large Linux/UNIX (Amazon VPC) 0.042000 2013-03-18T07:16:29.000Z us-west-2b cc2.8xlarge Linux/UNIX 0.253000 2013-03-18T07:15:04.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-18T06:43:35.000Z us-west-2b c1.xlarge Linux/UNIX 0.112000 2013-03-18T06:41:39.000Z us-west-2b c1.xlarge Linux/UNIX 0.112000 2013-03-18T06:41:39.000Z us-west-2a c1.xlarge Linux/UNIX 0.112000 2013-03-18T06:41:39.000Z us-west-2c c1.xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-18T06:41:35.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-18T06:38:26.000Z us-west-2b t1.micro Linux/UNIX 0.004000 2013-03-18T06:29:38.000Z us-west-2b m3.2xlarge Windows (Amazon VPC) 0.439000 2013-03-18T06:21:27.000Z us-west-2b m3.2xlarge Windows (Amazon VPC) 0.439000 2013-03-18T06:21:27.000Z us-west-2a m3.2xlarge Windows (Amazon VPC) 0.439000 2013-03-18T06:21:27.000Z us-west-2c m3.2xlarge Linux/UNIX (Amazon VPC) 0.183000 2013-03-18T06:21:25.000Z us-west-2b m3.2xlarge Linux/UNIX (Amazon VPC) 0.183000 2013-03-18T06:21:25.000Z us-west-2a m3.2xlarge Linux/UNIX (Amazon VPC) 0.183000 2013-03-18T06:21:25.000Z us-west-2c m3.2xlarge SUSE Linux (Amazon VPC) 0.192000 2013-03-18T06:21:24.000Z us-west-2b m3.2xlarge SUSE Linux (Amazon VPC) 0.192000 2013-03-18T06:21:24.000Z us-west-2a m3.2xlarge SUSE Linux (Amazon VPC) 0.192000 2013-03-18T06:21:24.000Z us-west-2c m3.xlarge Linux/UNIX (Amazon VPC) 0.092000 2013-03-18T06:17:30.000Z us-west-2b m3.xlarge Linux/UNIX (Amazon VPC) 0.092000 2013-03-18T06:17:30.000Z us-west-2a m3.xlarge Linux/UNIX (Amazon VPC) 0.092000 2013-03-18T06:17:30.000Z us-west-2c m3.xlarge Windows (Amazon VPC) 0.220000 2013-03-18T06:15:57.000Z us-west-2b m3.xlarge Windows (Amazon VPC) 0.220000 2013-03-18T06:15:57.000Z us-west-2a m3.xlarge Windows (Amazon VPC) 0.220000 2013-03-18T06:15:57.000Z us-west-2c m3.xlarge SUSE Linux (Amazon VPC) 0.101000 2013-03-18T06:15:48.000Z us-west-2b m3.xlarge SUSE Linux (Amazon VPC) 0.101000 2013-03-18T06:15:48.000Z us-west-2a m3.xlarge SUSE Linux (Amazon VPC) 0.101000 2013-03-18T06:15:48.000Z us-west-2c m1.small Windows (Amazon VPC) 0.026000 2013-03-18T06:12:40.000Z us-west-2a c1.medium Linux/UNIX (Amazon VPC) 0.028000 2013-03-18T06:12:17.000Z us-west-2b m3.2xlarge Windows 0.439000 2013-03-18T06:05:30.000Z us-west-2b m3.2xlarge Windows 0.439000 2013-03-18T06:05:30.000Z us-west-2a m3.2xlarge Windows 0.439000 2013-03-18T06:05:30.000Z us-west-2c m3.xlarge Windows 0.220000 2013-03-18T06:04:13.000Z us-west-2b m3.xlarge Windows 0.220000 2013-03-18T06:04:13.000Z us-west-2a m3.xlarge Windows 0.220000 2013-03-18T06:04:13.000Z us-west-2c m1.medium Windows 0.053000 2013-03-18T05:56:47.000Z us-west-2c m3.2xlarge SUSE Linux 0.192000 2013-03-18T05:55:33.000Z us-west-2b m3.2xlarge SUSE Linux 0.192000 2013-03-18T05:55:33.000Z us-west-2a m3.2xlarge SUSE Linux 0.192000 2013-03-18T05:55:33.000Z us-west-2c m3.2xlarge Linux/UNIX 0.183000 2013-03-18T05:55:33.000Z us-west-2b m3.2xlarge Linux/UNIX 0.183000 2013-03-18T05:55:33.000Z us-west-2a m3.2xlarge Linux/UNIX 0.183000 2013-03-18T05:55:33.000Z us-west-2c m3.xlarge SUSE Linux 0.101000 2013-03-18T05:50:08.000Z us-west-2b m3.xlarge SUSE Linux 0.101000 2013-03-18T05:50:08.000Z us-west-2a m3.xlarge SUSE Linux 0.101000 2013-03-18T05:50:08.000Z us-west-2c m3.xlarge Linux/UNIX 0.092000 2013-03-18T05:50:07.000Z us-west-2b m3.xlarge Linux/UNIX 0.092000 2013-03-18T05:50:07.000Z us-west-2a m3.xlarge Linux/UNIX 0.092000 2013-03-18T05:50:07.000Z us-west-2c t1.micro Windows (Amazon VPC) 0.009000 2013-03-18T05:34:27.000Z us-west-2b t1.micro Windows (Amazon VPC) 0.009000 2013-03-18T05:34:27.000Z us-west-2c t1.micro Linux/UNIX (Amazon VPC) 0.004000 2013-03-18T05:30:54.000Z us-west-2b t1.micro SUSE Linux (Amazon VPC) 0.009000 2013-03-18T05:29:08.000Z us-west-2b t1.micro SUSE Linux (Amazon VPC) 0.009000 2013-03-18T05:29:08.000Z us-west-2a t1.micro SUSE Linux (Amazon VPC) 0.009000 2013-03-18T05:29:08.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-18T05:20:39.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-18T05:15:23.000Z us-west-2b m1.small Linux/UNIX (Amazon VPC) 0.010000 2013-03-18T05:11:46.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-18T04:57:53.000Z us-west-2c m1.small Linux/UNIX 0.025000 2013-03-18T04:52:41.000Z us-west-2c c1.medium Windows 0.080000 2013-03-18T04:36:50.000Z us-west-2c m1.xlarge Linux/UNIX 0.083000 2013-03-18T03:48:40.000Z us-west-2a c1.medium Linux/UNIX (Amazon VPC) 0.028000 2013-03-18T03:39:45.000Z us-west-2a c1.medium Linux/UNIX (Amazon VPC) 0.028000 2013-03-18T03:39:45.000Z us-west-2c t1.micro Linux/UNIX (Amazon VPC) 0.004000 2013-03-18T03:29:33.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-18T03:15:47.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-18T03:05:25.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-18T03:00:13.000Z us-west-2b m1.xlarge Windows 0.211000 2013-03-18T02:43:15.000Z us-west-2b m1.xlarge Windows 0.211000 2013-03-18T02:43:15.000Z us-west-2a m1.xlarge Windows 0.211000 2013-03-18T02:43:15.000Z us-west-2c m2.4xlarge Linux/UNIX (Amazon VPC) 0.224000 2013-03-18T02:41:25.000Z us-west-2b m2.4xlarge Linux/UNIX (Amazon VPC) 0.224000 2013-03-18T02:41:25.000Z us-west-2c t1.micro Windows (Amazon VPC) 0.009000 2013-03-18T02:39:33.000Z us-west-2a m2.2xlarge Windows 0.224000 2013-03-18T02:39:25.000Z us-west-2b m2.2xlarge Windows 0.224000 2013-03-18T02:39:25.000Z us-west-2a m2.2xlarge Windows 0.224000 2013-03-18T02:39:25.000Z us-west-2c m1.small Linux/UNIX 0.025000 2013-03-18T02:37:52.000Z us-west-2c cc2.8xlarge Windows (Amazon VPC) 0.456000 2013-03-18T02:29:26.000Z us-west-2c t1.micro SUSE Linux 0.009000 2013-03-18T02:29:02.000Z us-west-2b t1.micro SUSE Linux 0.009000 2013-03-18T02:29:02.000Z us-west-2a t1.micro SUSE Linux 0.009000 2013-03-18T02:29:02.000Z us-west-2c m2.xlarge Windows (Amazon VPC) 0.112000 2013-03-18T02:27:39.000Z us-west-2b m2.xlarge Windows (Amazon VPC) 0.112000 2013-03-18T02:27:39.000Z us-west-2a m2.xlarge Windows (Amazon VPC) 0.112000 2013-03-18T02:27:39.000Z us-west-2c m1.large SUSE Linux 0.050000 2013-03-18T02:25:51.000Z us-west-2b m1.large SUSE Linux 0.050000 2013-03-18T02:25:51.000Z us-west-2a m1.large SUSE Linux 0.050000 2013-03-18T02:25:51.000Z us-west-2c m1.small Windows (Amazon VPC) 0.026000 2013-03-18T02:25:47.000Z us-west-2b m1.small Windows (Amazon VPC) 0.026000 2013-03-18T02:25:47.000Z us-west-2c m2.xlarge Windows 0.112000 2013-03-18T02:25:44.000Z us-west-2b m2.xlarge Windows 0.112000 2013-03-18T02:25:44.000Z us-west-2a m2.xlarge Windows 0.112000 2013-03-18T02:25:44.000Z us-west-2c m2.xlarge SUSE Linux 0.067000 2013-03-18T02:25:42.000Z us-west-2b m2.xlarge SUSE Linux 0.067000 2013-03-18T02:25:42.000Z us-west-2a m2.xlarge SUSE Linux 0.067000 2013-03-18T02:25:42.000Z us-west-2c m1.large SUSE Linux (Amazon VPC) 0.050000 2013-03-18T02:25:37.000Z us-west-2b m1.large SUSE Linux (Amazon VPC) 0.050000 2013-03-18T02:25:37.000Z us-west-2a m1.large SUSE Linux (Amazon VPC) 0.050000 2013-03-18T02:25:37.000Z us-west-2c c1.xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-18T02:25:25.000Z us-west-2b c1.xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-18T02:25:25.000Z us-west-2a c1.xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-18T02:25:25.000Z us-west-2c c1.xlarge Windows (Amazon VPC) 0.320000 2013-03-18T02:24:15.000Z us-west-2b c1.xlarge Windows (Amazon VPC) 0.320000 2013-03-18T02:24:15.000Z us-west-2a c1.xlarge Windows (Amazon VPC) 0.320000 2013-03-18T02:24:15.000Z us-west-2c c1.medium SUSE Linux 0.038000 2013-03-18T02:24:11.000Z us-west-2b c1.medium SUSE Linux 0.038000 2013-03-18T02:24:11.000Z us-west-2a c1.medium SUSE Linux 0.038000 2013-03-18T02:24:11.000Z us-west-2c c1.medium SUSE Linux (Amazon VPC) 0.038000 2013-03-18T02:23:39.000Z us-west-2b c1.medium SUSE Linux (Amazon VPC) 0.038000 2013-03-18T02:23:39.000Z us-west-2a c1.medium SUSE Linux (Amazon VPC) 0.038000 2013-03-18T02:23:39.000Z us-west-2c m2.4xlarge SUSE Linux 0.234000 2013-03-18T02:22:17.000Z us-west-2b m2.4xlarge SUSE Linux 0.234000 2013-03-18T02:22:17.000Z us-west-2a m2.4xlarge SUSE Linux 0.234000 2013-03-18T02:22:17.000Z us-west-2c m1.medium SUSE Linux 0.030000 2013-03-18T02:22:13.000Z us-west-2b m1.medium SUSE Linux 0.030000 2013-03-18T02:22:13.000Z us-west-2a m1.medium SUSE Linux 0.030000 2013-03-18T02:22:13.000Z us-west-2c m2.2xlarge SUSE Linux 0.122000 2013-03-18T02:20:25.000Z us-west-2b m2.2xlarge SUSE Linux 0.122000 2013-03-18T02:20:25.000Z us-west-2a m2.2xlarge SUSE Linux 0.122000 2013-03-18T02:20:25.000Z us-west-2c c1.medium Windows (Amazon VPC) 0.080000 2013-03-18T02:20:24.000Z us-west-2b c1.medium Windows (Amazon VPC) 0.080000 2013-03-18T02:20:24.000Z us-west-2a c1.medium Windows (Amazon VPC) 0.080000 2013-03-18T02:20:24.000Z us-west-2c m1.medium SUSE Linux (Amazon VPC) 0.030000 2013-03-18T02:18:59.000Z us-west-2b m1.medium SUSE Linux (Amazon VPC) 0.030000 2013-03-18T02:18:59.000Z us-west-2a m1.medium SUSE Linux (Amazon VPC) 0.030000 2013-03-18T02:18:59.000Z us-west-2c m1.xlarge Windows (Amazon VPC) 0.211000 2013-03-18T02:18:58.000Z us-west-2b m1.xlarge Windows (Amazon VPC) 0.211000 2013-03-18T02:18:58.000Z us-west-2a m2.2xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-18T02:18:55.000Z us-west-2b m2.2xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-18T02:18:55.000Z us-west-2a m2.2xlarge SUSE Linux (Amazon VPC) 0.122000 2013-03-18T02:18:55.000Z us-west-2c m2.4xlarge SUSE Linux (Amazon VPC) 0.234000 2013-03-18T02:18:52.000Z us-west-2b m2.4xlarge SUSE Linux (Amazon VPC) 0.234000 2013-03-18T02:18:52.000Z us-west-2a m2.4xlarge SUSE Linux (Amazon VPC) 0.234000 2013-03-18T02:18:52.000Z us-west-2c m2.4xlarge Windows 0.448000 2013-03-18T02:18:48.000Z us-west-2b m2.2xlarge Windows (Amazon VPC) 0.224000 2013-03-18T02:18:46.000Z us-west-2b m2.2xlarge Windows (Amazon VPC) 0.224000 2013-03-18T02:18:46.000Z us-west-2a m2.2xlarge Windows (Amazon VPC) 0.224000 2013-03-18T02:18:46.000Z us-west-2c m1.xlarge SUSE Linux 0.090000 2013-03-18T02:18:45.000Z us-west-2b m1.xlarge SUSE Linux 0.090000 2013-03-18T02:18:45.000Z us-west-2a m1.xlarge SUSE Linux 0.090000 2013-03-18T02:18:45.000Z us-west-2c m1.small SUSE Linux (Amazon VPC) 0.021000 2013-03-18T02:18:43.000Z us-west-2b m1.small SUSE Linux (Amazon VPC) 0.021000 2013-03-18T02:18:43.000Z us-west-2a m1.small SUSE Linux (Amazon VPC) 0.021000 2013-03-18T02:18:43.000Z us-west-2c c1.xlarge SUSE Linux 0.122000 2013-03-18T02:18:35.000Z us-west-2b c1.xlarge SUSE Linux 0.122000 2013-03-18T02:18:35.000Z us-west-2a c1.xlarge SUSE Linux 0.122000 2013-03-18T02:18:35.000Z us-west-2c m2.xlarge Linux/UNIX (Amazon VPC) 0.056000 2013-03-18T02:18:32.000Z us-west-2b m2.xlarge Linux/UNIX (Amazon VPC) 0.056000 2013-03-18T02:18:32.000Z us-west-2a m2.xlarge Linux/UNIX (Amazon VPC) 0.056000 2013-03-18T02:18:32.000Z us-west-2c c1.xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-18T02:18:30.000Z us-west-2c m1.xlarge Linux/UNIX (Amazon VPC) 0.083000 2013-03-18T02:18:30.000Z us-west-2b m1.xlarge Linux/UNIX (Amazon VPC) 0.083000 2013-03-18T02:18:30.000Z us-west-2a m2.xlarge SUSE Linux (Amazon VPC) 0.067000 2013-03-18T02:18:30.000Z us-west-2b m2.xlarge SUSE Linux (Amazon VPC) 0.067000 2013-03-18T02:18:30.000Z us-west-2a m2.xlarge SUSE Linux (Amazon VPC) 0.067000 2013-03-18T02:18:30.000Z us-west-2c m1.xlarge SUSE Linux (Amazon VPC) 0.090000 2013-03-18T02:18:29.000Z us-west-2b m1.xlarge SUSE Linux (Amazon VPC) 0.090000 2013-03-18T02:18:29.000Z us-west-2a m1.xlarge SUSE Linux (Amazon VPC) 0.090000 2013-03-18T02:18:29.000Z us-west-2c m1.medium Windows (Amazon VPC) 0.053000 2013-03-18T02:17:17.000Z us-west-2b m1.medium Windows (Amazon VPC) 0.053000 2013-03-18T02:17:17.000Z us-west-2a m1.medium Windows (Amazon VPC) 0.053000 2013-03-18T02:17:17.000Z us-west-2c m1.medium Linux/UNIX (Amazon VPC) 0.021000 2013-03-18T02:17:16.000Z us-west-2b m2.2xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-18T02:17:13.000Z us-west-2a m2.2xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-18T02:17:13.000Z us-west-2c m1.large Windows (Amazon VPC) 0.106000 2013-03-18T02:17:13.000Z us-west-2b m1.large Windows (Amazon VPC) 0.106000 2013-03-18T02:17:13.000Z us-west-2a m1.large Windows (Amazon VPC) 0.106000 2013-03-18T02:17:13.000Z us-west-2c m2.4xlarge Windows (Amazon VPC) 0.448000 2013-03-18T02:17:11.000Z us-west-2b m2.4xlarge Windows (Amazon VPC) 0.448000 2013-03-18T02:17:11.000Z us-west-2a m2.4xlarge Windows (Amazon VPC) 0.448000 2013-03-18T02:17:11.000Z us-west-2c m1.small SUSE Linux 0.021000 2013-03-18T02:17:02.000Z us-west-2b m1.small SUSE Linux 0.021000 2013-03-18T02:17:02.000Z us-west-2a m1.small SUSE Linux 0.021000 2013-03-18T02:17:02.000Z us-west-2c c1.medium Linux/UNIX 0.028000 2013-03-18T01:35:22.000Z us-west-2a m2.4xlarge Linux/UNIX 0.224000 2013-03-18T01:35:14.000Z us-west-2a m1.small Linux/UNIX (Amazon VPC) 0.010000 2013-03-18T01:35:01.000Z us-west-2b m2.xlarge Linux/UNIX 0.056000 2013-03-18T01:28:09.000Z us-west-2b m1.xlarge Linux/UNIX (Amazon VPC) 0.083000 2013-03-18T00:40:51.000Z us-west-2c cc2.8xlarge Linux/UNIX 0.253000 2013-03-18T00:23:52.000Z us-west-2b m1.medium Linux/UNIX (Amazon VPC) 0.021000 2013-03-18T00:20:23.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-17T23:59:22.000Z us-west-2c c1.xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-17T23:59:02.000Z us-west-2a m1.xlarge Linux/UNIX 0.083000 2013-03-17T23:45:21.000Z us-west-2c c1.medium Linux/UNIX 0.028000 2013-03-17T23:23:06.000Z us-west-2b c1.xlarge Windows 0.320000 2013-03-17T23:07:43.000Z us-west-2c m1.medium Linux/UNIX 0.021000 2013-03-17T23:05:41.000Z us-west-2c c1.xlarge Windows 0.320000 2013-03-17T23:02:30.000Z us-west-2b m1.xlarge Windows (Amazon VPC) 0.211000 2013-03-17T22:58:48.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-17T22:49:51.000Z us-west-2b m2.2xlarge Linux/UNIX 0.112000 2013-03-17T22:48:01.000Z us-west-2b m1.medium Linux/UNIX 0.021000 2013-03-17T22:44:39.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-17T22:44:37.000Z us-west-2b m2.2xlarge Linux/UNIX (Amazon VPC) 0.112000 2013-03-17T22:43:03.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-17T22:39:28.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-17T22:34:17.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-17T22:32:32.000Z us-west-2a m2.4xlarge Linux/UNIX 0.224000 2013-03-17T22:29:07.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-17T22:28:58.000Z us-west-2b m1.small Linux/UNIX 0.013000 2013-03-17T22:27:17.000Z us-west-2a m1.small Linux/UNIX 0.020000 2013-03-17T22:23:49.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-17T22:15:09.000Z us-west-2b m1.small Linux/UNIX 0.020000 2013-03-17T22:09:55.000Z us-west-2b m1.xlarge Linux/UNIX 0.083000 2013-03-17T21:56:05.000Z us-west-2b cc2.8xlarge Windows (Amazon VPC) 0.456000 2013-03-17T21:54:37.000Z us-west-2a cc2.8xlarge Windows 0.456000 2013-03-17T21:54:29.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-17T21:50:54.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-17T21:45:44.000Z us-west-2b cc2.8xlarge Linux/UNIX (Amazon VPC) 0.253000 2013-03-17T21:37:09.000Z us-west-2c cc2.8xlarge Windows 0.456000 2013-03-17T21:33:44.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-17T21:33:38.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-17T21:28:25.000Z us-west-2b cr1.8xlarge Linux/UNIX (Amazon VPC) 0.343000 2013-03-17T21:16:27.000Z us-west-2b cr1.8xlarge Linux/UNIX (Amazon VPC) 0.343000 2013-03-17T21:16:27.000Z us-west-2a cr1.8xlarge Linux/UNIX (Amazon VPC) 0.343000 2013-03-17T21:16:27.000Z us-west-2c m2.2xlarge Linux/UNIX 0.112000 2013-03-17T21:16:18.000Z us-west-2c cr1.8xlarge SUSE Linux 0.351000 2013-03-17T21:16:11.000Z us-west-2b cr1.8xlarge SUSE Linux 0.351000 2013-03-17T21:16:11.000Z us-west-2a cr1.8xlarge SUSE Linux 0.351000 2013-03-17T21:16:11.000Z us-west-2c cr1.8xlarge Linux/UNIX 0.343000 2013-03-17T21:16:10.000Z us-west-2b cr1.8xlarge Linux/UNIX 0.343000 2013-03-17T21:16:10.000Z us-west-2a cr1.8xlarge Linux/UNIX 0.343000 2013-03-17T21:16:10.000Z us-west-2c cc2.8xlarge Linux/UNIX (Amazon VPC) 0.253000 2013-03-17T21:09:40.000Z us-west-2b cc2.8xlarge Linux/UNIX (Amazon VPC) 0.253000 2013-03-17T21:09:40.000Z us-west-2a m2.4xlarge Windows 0.448000 2013-03-17T21:09:38.000Z us-west-2a m1.medium Windows 0.053000 2013-03-17T21:07:41.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-17T21:00:58.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-17T20:54:10.000Z us-west-2b m1.medium Linux/UNIX 0.021000 2013-03-17T20:54:10.000Z us-west-2a c1.medium Linux/UNIX 0.028000 2013-03-17T20:49:16.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-17T20:35:15.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-17T20:28:22.000Z us-west-2b c1.xlarge Windows 0.320000 2013-03-17T20:18:16.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-17T20:02:36.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-17T19:57:27.000Z us-west-2b m2.2xlarge Linux/UNIX 0.112000 2013-03-17T19:57:21.000Z us-west-2a m1.small Windows 0.026000 2013-03-17T19:57:19.000Z us-west-2a m1.small Windows 0.026000 2013-03-17T19:57:19.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-17T19:48:52.000Z us-west-2b m1.small Linux/UNIX 0.013000 2013-03-17T19:43:45.000Z us-west-2b m1.medium Windows 0.053000 2013-03-17T19:36:42.000Z us-west-2b c1.medium Windows 0.080000 2013-03-17T19:33:09.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-17T19:31:45.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-17T19:26:35.000Z us-west-2b m2.4xlarge Linux/UNIX (Amazon VPC) 0.224000 2013-03-17T19:21:35.000Z us-west-2a t1.micro Linux/UNIX (Amazon VPC) 0.004000 2013-03-17T19:05:52.000Z us-west-2a cc2.8xlarge Windows (Amazon VPC) 0.456000 2013-03-17T19:04:33.000Z us-west-2b cc2.8xlarge Windows 0.456000 2013-03-17T19:02:39.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-17T19:02:33.000Z us-west-2b m1.small Windows 0.026000 2013-03-17T19:02:23.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-17T18:57:23.000Z us-west-2b m1.small Linux/UNIX (Amazon VPC) 0.010000 2013-03-17T18:57:18.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-17T18:50:37.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-17T18:43:49.000Z us-west-2b m2.4xlarge Windows 0.448000 2013-03-17T18:23:08.000Z us-west-2c t1.micro Windows 0.009000 2013-03-17T18:19:34.000Z us-west-2c m1.small Linux/UNIX 0.010000 2013-03-17T18:18:00.000Z us-west-2b m1.small Linux/UNIX 0.014000 2013-03-17T18:12:53.000Z us-west-2b m1.large Windows 0.106000 2013-03-17T18:09:17.000Z us-west-2b t1.micro Windows 0.009000 2013-03-17T17:43:27.000Z us-west-2a m1.small Linux/UNIX 0.010000 2013-03-17T16:53:53.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-17T16:45:25.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-17T16:40:15.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-17T16:35:11.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-17T15:23:38.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-17T15:18:34.000Z us-west-2b m1.small Linux/UNIX 0.010000 2013-03-17T15:13:27.000Z us-west-2b m1.small Linux/UNIX 0.012000 2013-03-17T15:03:14.000Z us-west-2b m2.xlarge Linux/UNIX 0.056000 2013-03-17T14:35:51.000Z us-west-2a Qj9iZzP9N1Vh5jjNyad6X73sizWaPtVQ6328oKe9/GbmNSbOFX1TIhQaz5vok0nu botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-environment.json0000666454262600001440000000074713042511306034747 0ustar pysdk-ciamazon00000000000000{ "ApplicationName": "SampleApp", "EnvironmentName": "SampleApp", "VersionLabel": "Version1", "Status": "Deploying", "Description": "EnvDescrip", "ResponseMetadata": { "RequestId": "15db925e-f1ff-11df-8a78-9f77047e0d0c" }, "EnvironmentId": "e-icsgecu3wf", "SolutionStackName": "32bit Amazon Linux running Tomcat 7", "Health": "Grey", "DateUpdated": "2010-11-17T03:59:33.520Z", "DateCreated": "2010-11-17T03:59:33.520Z" } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-list-identities.json0000666454262600001440000000024713042511306031530 0ustar pysdk-ciamazon00000000000000{ "Identities": [ "foobar.com", "foo@bar.com" ], "ResponseMetadata": { "RequestId": "659700d6-9167-11e2-8db7-37375a39d514" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-confirm-product-instance.json0000666454262600001440000000022313042511306033204 0ustar pysdk-ciamazon00000000000000{ "OwnerId": "111122223333", "Return": true, "ResponseMetadata": { "RequestId": "59dbff89-35bd-4eac-99ed-be587EXAMPLE" } } botocore-1.5.7/tests/unit/response_parsing/xml/responses/s3-get-bucket-location.xml0000666454262600001440000000020313042511306031630 0ustar pysdk-ciamazon00000000000000 EU botocore-1.5.7/tests/unit/response_parsing/xml/responses/ec2-create-subnet.json0000666454262600001440000000055113042511306031034 0ustar pysdk-ciamazon00000000000000{ "Subnet": { "VpcId": "vpc-1a2b3c4d", "Tags": [], "CidrBlock": "10.0.1.0/24", "State": "pending", "AvailabilityZone": "us-east-1a", "SubnetId": "subnet-9d4a7b6c", "AvailableIpAddressCount": 251 }, "ResponseMetadata": { "RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/iam-list-signing-certificates.json0000666454262600001440000000223513042511306033443 0ustar pysdk-ciamazon00000000000000{"Certificates": [ {"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-----", "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", "Status": "Active", "UserName": "Bob"}], "IsTruncated": false, "ResponseMetadata": {"RequestId": "7a62c49f-347e-4fc4-9331-6e8eEXAMPLE"} } ././@LongLink0000000000000000000000000000015200000000000011213 Lustar 00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-application-version.jsonbotocore-1.5.7/tests/unit/response_parsing/xml/responses/elasticbeanstalk-create-application-version0000666454262600001440000000072013042511306035410 0ustar pysdk-ciamazon00000000000000{ "ApplicationVersion": { "ApplicationName": "SampleApp", "VersionLabel": "Version1", "Description": "description", "DateCreated": "2010-11-17T03:21:59.161Z", "DateUpdated": "2010-11-17T03:21:59.161Z", "SourceBundle": { "S3Bucket": "amazonaws.com", "S3Key": "sample.war" } }, "ResponseMetadata": { "RequestId": "d653efef-f1f9-11df-8a78-9f77047e0d0c" } }botocore-1.5.7/tests/unit/response_parsing/xml/responses/ses-delete-identity.json0000666454262600001440000000013713042511306031505 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": { "RequestId": "d96bd874-9bf2-11e1-8ee7-c98a0037a2b6" } }botocore-1.5.7/tests/unit/response_parsing/xml/errors/0000777454262600001440000000000013042511310024216 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/response_parsing/xml/errors/autoscaling-delete-policy.json0000666454262600001440000000042413042511306032164 0ustar pysdk-ciamazon00000000000000{ "Error": { "Code": "ValidationError", "Message": "The AutoScaling Group name is required when specifying a policy by its name", "Type": "Sender" }, "ResponseMetadata": { "RequestId": "9e27be2f-b7e3-11e2-a0e4-f9780ed1763e" } } botocore-1.5.7/tests/unit/response_parsing/xml/errors/ec2-describe-instances.xml0000666454262600001440000000041113042511306031155 0ustar pysdk-ciamazon00000000000000 InvalidInstanceID.Malformed Invalid id: "foobar" dfb14b43-9a55-4d8e-b676-e8034d12bbeb botocore-1.5.7/tests/unit/response_parsing/xml/errors/sqs-delete-queue.xml0000666454262600001440000000051513042511306030136 0ustar pysdk-ciamazon00000000000000 Sender InvalidAddress The address foobar is not valid for this endpoint. 9b06cd2c-b433-550f-bde2-8728ce9b1a93 botocore-1.5.7/tests/unit/response_parsing/xml/errors/cloudformation-cancel-update-stack.xml0000666454262600001440000000043513042511306033602 0ustar pysdk-ciamazon00000000000000 Sender ValidationError Stack: foobar does not exist 21113b58-b7e4-11e2-91fa-05ec834fa451 botocore-1.5.7/tests/unit/response_parsing/xml/errors/s3-create-bucket.xml0000666454262600001440000000050513042511306030006 0ustar pysdk-ciamazon00000000000000 BucketAlreadyOwnedByYou Your previous request to create the named bucket succeeded and you already own it. garnaat-pdx 96380E1CB938DDF7 uCyKZYcyp+7qYdvAcvwQueBs6VdfDURJZTrhTjc3gTfsqaWjC2n532mPb0P+ZQ4Q botocore-1.5.7/tests/unit/response_parsing/xml/errors/sts-get-session-token.xml0000666454262600001440000000057313042511306031137 0ustar pysdk-ciamazon00000000000000 Sender AccessDenied GetSessionToken call failed, unable to validate MFA code. Please verify your MFA serial number is valid and associated with this user. 8088f6eb-b7fb-11e2-8d25-4b9f3b52b80f botocore-1.5.7/tests/unit/response_parsing/xml/errors/rds-describe-db-instances.xml0000666454262600001440000000042513042511306031664 0ustar pysdk-ciamazon00000000000000 Sender DBInstanceNotFound DBInstance foobar not found. b41f03f1-b7f8-11e2-9b07-955bffd33505 botocore-1.5.7/tests/unit/response_parsing/xml/errors/rds-describe-db-instances.json0000666454262600001440000000035013042511306032032 0ustar pysdk-ciamazon00000000000000{ "Error": { "Code": "DBInstanceNotFound", "Message": "DBInstance foobar not found.", "Type": "Sender" }, "ResponseMetadata": { "RequestId": "b41f03f1-b7f8-11e2-9b07-955bffd33505" } } botocore-1.5.7/tests/unit/response_parsing/xml/errors/sns-delete-topic.xml0000666454262600001440000000037713042511306030133 0ustar pysdk-ciamazon00000000000000 Sender InvalidParameter TopicArn 8c4c8aa7-436b-5b46-91d5-c0a339158557 botocore-1.5.7/tests/unit/response_parsing/xml/errors/importexport-get-status.xml0000666454262600001440000000045013042511306031616 0ustar pysdk-ciamazon00000000000000 Sender InvalidJobIdException No such job foobar for your account 83281264-b7f8-11e2-a9e1-3f6477e78873 botocore-1.5.7/tests/unit/response_parsing/xml/errors/sns-delete-topic.json0000666454262600001440000000032213042511306030272 0ustar pysdk-ciamazon00000000000000{ "Error": { "Code": "InvalidParameter", "Message": "TopicArn", "Type": "Sender" }, "ResponseMetadata": { "RequestId": "8c4c8aa7-436b-5b46-91d5-c0a339158557" } } botocore-1.5.7/tests/unit/response_parsing/xml/errors/s3-list-objects.xml0000666454262600001440000000036513042511306027676 0ustar pysdk-ciamazon00000000000000 AccessDenied Access Denied 9C7D5181867045BB XNe9pgGHhc+EBMJajTIuknWns46Dd3psDfbWyo1pbc0dULg/tkidZSeWG5VNitPJ botocore-1.5.7/tests/unit/response_parsing/xml/errors/iam-get-user.json0000666454262600001440000000036013042511306027414 0ustar pysdk-ciamazon00000000000000{ "Error": { "Code": "NoSuchEntity", "Message": "The user with name foobar cannot be found.", "Type": "Sender" }, "ResponseMetadata": { "RequestId": "358299bb-b7f8-11e2-8d39-e3a125f625ee" } } botocore-1.5.7/tests/unit/response_parsing/xml/errors/cloudwatch-describe-alarm-history.xml0000666454262600001440000000043413042511306033452 0ustar pysdk-ciamazon00000000000000 Sender InvalidNextToken The token 'fiebaz' was invalid 0cbee924-b7f3-11e2-9844-5359a37be512 botocore-1.5.7/tests/unit/response_parsing/xml/errors/sts-get-session-token.json0000666454262600001440000000051513042511306031304 0ustar pysdk-ciamazon00000000000000{ "Error": { "Code": "AccessDenied", "Message": "GetSessionToken call failed, unable to validate MFA code. Please verify your MFA serial number is valid and associated with this user.", "Type": "Sender" }, "ResponseMetadata": { "RequestId": "8088f6eb-b7fb-11e2-8d25-4b9f3b52b80f" } } botocore-1.5.7/tests/unit/response_parsing/xml/errors/ses-delete-identity.xml0000666454262600001440000000050313042511306030624 0ustar pysdk-ciamazon00000000000000 Sender InvalidParameterValue Identity foobar is invalid. Must be a verified email address or domain. 332db868-b7f9-11e2-b4a6-337840b53735 botocore-1.5.7/tests/unit/response_parsing/xml/errors/route53-get-hosted-zone.json0000666454262600001440000000030713042511306031436 0ustar pysdk-ciamazon00000000000000{ "Error": { "Code": "InvalidInput", "Message": "Invalid resource type: foo", "Type": "Sender" }, "ResponseMetadata": { "RequestId": "request_id" } } botocore-1.5.7/tests/unit/response_parsing/xml/errors/ec2-describe-instances.json0000666454262600001440000000032113042511306031326 0ustar pysdk-ciamazon00000000000000{ "Error": { "Code": "InvalidInstanceID.Malformed", "Message": "Invalid id: \"foobar\"" }, "ResponseMetadata": { "RequestId": "dfb14b43-9a55-4d8e-b676-e8034d12bbeb" } } botocore-1.5.7/tests/unit/response_parsing/xml/errors/s3-create-bucket.json0000666454262600001440000000035513042511306030162 0ustar pysdk-ciamazon00000000000000{ "Error": { "BucketName": "garnaat-pdx", "Code": "BucketAlreadyOwnedByYou", "Message": "Your previous request to create the named bucket succeeded and you already own it." }, "ResponseMetadata": {} } botocore-1.5.7/tests/unit/response_parsing/xml/errors/elb-describe-load-balancers.json0000666454262600001440000000035613042511306032307 0ustar pysdk-ciamazon00000000000000{ "Error": { "Code": "LoadBalancerNotFound", "Message": "Cannot find Load Balancer foobar", "Type": "Sender" }, "ResponseMetadata": { "RequestId": "88e880c0-b7f7-11e2-ac25-87bc0c2182b8" } } botocore-1.5.7/tests/unit/response_parsing/xml/errors/importexport-get-status.json0000666454262600001440000000036213042511306031771 0ustar pysdk-ciamazon00000000000000{ "Error": { "Code": "InvalidJobIdException", "Message": "No such job foobar for your account", "Type": "Sender" }, "ResponseMetadata": { "RequestId": "83281264-b7f8-11e2-a9e1-3f6477e78873" } } botocore-1.5.7/tests/unit/response_parsing/xml/errors/elb-describe-load-balancers.xml0000666454262600001440000000045413042511306032135 0ustar pysdk-ciamazon00000000000000 Sender LoadBalancerNotFound Cannot find Load Balancer foobar 88e880c0-b7f7-11e2-ac25-87bc0c2182b8 botocore-1.5.7/tests/unit/response_parsing/xml/errors/sqs-delete-queue.json0000666454262600001440000000042213042511306030304 0ustar pysdk-ciamazon00000000000000{ "Error": { "Code": "InvalidAddress", "Detail": null, "Message": "The address foobar is not valid for this endpoint.", "Type": "Sender" }, "ResponseMetadata": { "RequestId": "9b06cd2c-b433-550f-bde2-8728ce9b1a93" } } botocore-1.5.7/tests/unit/response_parsing/xml/errors/route53-get-hosted-zone.xml0000666454262600001440000000037013042511306031265 0ustar pysdk-ciamazon00000000000000 Sender InvalidInput Invalid resource type: foo request_id botocore-1.5.7/tests/unit/response_parsing/xml/errors/autoscaling-delete-policy.xml0000666454262600001440000000051113042511306032010 0ustar pysdk-ciamazon00000000000000 Sender ValidationError The AutoScaling Group name is required when specifying a policy by its name 9e27be2f-b7e3-11e2-a0e4-f9780ed1763e botocore-1.5.7/tests/unit/response_parsing/xml/errors/s3-list-objects.json0000666454262600001440000000017013042511306030041 0ustar pysdk-ciamazon00000000000000{ "Error": { "Code": "AccessDenied", "Message": "Access Denied" }, "ResponseMetadata": {} } botocore-1.5.7/tests/unit/response_parsing/xml/errors/cloudwatch-describe-alarm-history.json0000666454262600001440000000035013042511306033620 0ustar pysdk-ciamazon00000000000000{ "Error": { "Code": "InvalidNextToken", "Message": "The token 'fiebaz' was invalid", "Type": "Sender" }, "ResponseMetadata": { "RequestId": "0cbee924-b7f3-11e2-9844-5359a37be512" } } botocore-1.5.7/tests/unit/response_parsing/xml/errors/iam-get-user.xml0000666454262600001440000000043613042511306027247 0ustar pysdk-ciamazon00000000000000 Sender NoSuchEntity The user with name foobar cannot be found. 358299bb-b7f8-11e2-8d39-e3a125f625ee botocore-1.5.7/tests/unit/response_parsing/xml/errors/cloudformation-cancel-update-stack.json0000666454262600001440000000034513042511306033753 0ustar pysdk-ciamazon00000000000000{ "Error": { "Code": "ValidationError", "Message": "Stack: foobar does not exist", "Type": "Sender" }, "ResponseMetadata": { "RequestId": "21113b58-b7e4-11e2-91fa-05ec834fa451" } } botocore-1.5.7/tests/unit/response_parsing/xml/errors/ses-delete-identity.json0000666454262600001440000000042613042511306031001 0ustar pysdk-ciamazon00000000000000{ "Error": { "Code": "InvalidParameterValue", "Message": "Identity foobar is invalid. Must be a verified email address or domain.", "Type": "Sender" }, "ResponseMetadata": { "RequestId": "332db868-b7f9-11e2-b4a6-337840b53735" } } botocore-1.5.7/tests/unit/response_parsing/json/0000777454262600001440000000000013042511307023061 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/response_parsing/json/expected/0000777454262600001440000000000013042511310024654 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/response_parsing/json/expected/datapipeline-create-pipeline.json0000666454262600001440000000027613042511306033264 0ustar pysdk-ciamazon00000000000000{ "Error": { "Message": "Operation createPipeline is not allowed to be performed with role identity", "Code": "AccessDeniedException" }, "ResponseMetadata": {} } botocore-1.5.7/tests/unit/response_parsing/json/expected/elastictranscoder-list-pipelines.json0000666454262600001440000000164113042511306034226 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": {}, "NextPageToken": null, "Pipelines": [ { "ContentConfig": { "Bucket": "pipeline-12345", "StorageClass": "Standard", "Permissions": [] }, "Status": "Active", "Name": "test-pipeline", "ThumbnailConfig": { "Bucket": "12345", "StorageClass": "Standard", "Permissions": [] }, "Notifications": { "Completed": "", "Warning": "", "Progressing": "", "Error": "" }, "Role": "arn:aws:iam::12345:role/Elastic_Transcoder_Default_Role", "InputBucket": "12345", "OutputBucket": null, "Id": "12345", "Arn": "arn:aws:elastictranscoder:us-west-2:12345:pipeline/12345" } ] } botocore-1.5.7/tests/unit/response_parsing/json/expected/elastictranscoder-delete-pipeline.json0000666454262600001440000000042713042511306034333 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": {"RequestId": "1234"}, "Error": { "Message": "1 validation error detected: Value 'foobar' at 'id' failed to satisfy constraint: Member must satisfy regular expression pattern: ^\\d{13}-\\w{6}$", "Code": "ValidationException" } } botocore-1.5.7/tests/unit/response_parsing/json/expected/opsworks-delete-stack.json0000666454262600001440000000023313042511306032004 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": {}, "Error": { "Message": "Unable to find stack with ID foobar", "Code": "ResourceNotFoundException" } } botocore-1.5.7/tests/unit/response_parsing/json/expected/directconnect-delete-connection.json0000666454262600001440000000024613042511306033777 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": {}, "Error": { "Message": "Connection ID foobar has an invalid format.", "Code": "DirectConnectClientException" } } botocore-1.5.7/tests/unit/response_parsing/json/expected/swf-deprecate-domain.json0000666454262600001440000000021113042511306031544 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": {}, "Error": { "Message": "Unknown domain: foobar", "Code": "UnknownResourceFault" } } botocore-1.5.7/tests/unit/response_parsing/json/expected/storagegateway-delete-gateway.json0000666454262600001440000000037713042511306033510 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": {}, "Error": { "Message": "1 validation error detected: Value 'foobar' at 'gatewayARN' failed to satisfy constraint: Member must have length greater than or equal to 50", "Code": "ValidationException" } } botocore-1.5.7/tests/unit/response_parsing/json/expected/dynamodb-put-item.json0000666454262600001440000000042513042511306031114 0ustar pysdk-ciamazon00000000000000{ "ResponseMetadata": {}, "Error": { "Message": "The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API", "Code": "ProvisionedThroughputExceededException" } } botocore-1.5.7/tests/unit/response_parsing/json/errors/0000777454262600001440000000000013042511310024367 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/response_parsing/json/errors/datapipeline-create-pipeline.json0000666454262600001440000000017213042511306032772 0ustar pysdk-ciamazon00000000000000{"__type":"AccessDeniedException","Message":"Operation createPipeline is not allowed to be performed with role identity"} botocore-1.5.7/tests/unit/response_parsing/json/errors/elastictranscoder-delete-pipeline.json0000666454262600001440000000063213042511306034044 0ustar pysdk-ciamazon00000000000000{ "message": "1 validation error detected: Value 'foobar' at 'id' failed to satisfy constraint: Member must satisfy regular expression pattern: ^\\d{13}-\\w{6}$", "__headers__": { "x-amzn-requestid": "1234", "content-length": "120", "date": "Wed, 19 Feb 2014 22:13:13 GMT", "nncoection": "close", "content-type": "application/json", "x-amzn-errortype": "ValidationException:" } } botocore-1.5.7/tests/unit/response_parsing/json/errors/opsworks-delete-stack.json0000666454262600001440000000012713042511306031521 0ustar pysdk-ciamazon00000000000000{"__type":"ResourceNotFoundException","message":"Unable to find stack with ID foobar"} botocore-1.5.7/tests/unit/response_parsing/json/errors/directconnect-delete-connection.json0000666454262600001440000000014213042511306033505 0ustar pysdk-ciamazon00000000000000{"__type":"DirectConnectClientException","message":"Connection ID foobar has an invalid format."} botocore-1.5.7/tests/unit/response_parsing/json/errors/swf-deprecate-domain.json0000666454262600001440000000014213042511306031262 0ustar pysdk-ciamazon00000000000000{"__type":"com.amazonaws.swf.base.model#UnknownResourceFault","message":"Unknown domain: foobar"} botocore-1.5.7/tests/unit/response_parsing/json/errors/storagegateway-delete-gateway.json0000666454262600001440000000027313042511306033216 0ustar pysdk-ciamazon00000000000000{"__type":"ValidationException","message":"1 validation error detected: Value 'foobar' at 'gatewayARN' failed to satisfy constraint: Member must have length greater than or equal to 50"} botocore-1.5.7/tests/unit/response_parsing/json/errors/dynamodb-put-item.json0000666454262600001440000000036713042511306030634 0ustar pysdk-ciamazon00000000000000{"__type":"com.amazonaws.dynamodb.v20111205#ProvisionedThroughputExceededException", "message":"The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API"} botocore-1.5.7/tests/unit/response_parsing/test_response_parsing.py0000666454262600001440000003350313042511306027105 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import os import glob import json import pprint import logging import difflib from tests import unittest, create_session from mock import Mock from botocore.vendored.requests.structures import CaseInsensitiveDict import botocore.session from botocore import xform_name #from botocore.response import XmlResponse, JSONResponse, get_response from botocore import response from botocore import parsers from botocore.exceptions import IncompleteReadError log = logging.getLogger(__name__) SPECIAL_CASES = [ 'iam-get-user-policy.xml', # Needs the JSON decode from handlers.py 'iam-list-roles.xml', # Needs the JSON decode from handlers.py for the policy 's3-get-bucket-location.xml', # Confirmed, this will need a special handler #'s3-list-multipart-uploads.xml', # Bug in model, missing delimeter 'cloudformation-get-template.xml', # Need to JSON decode the template body. ] def _test_parsed_response(xmlfile, response_body, operation_model, expected): response = { 'body': response_body, 'status_code': 200, 'headers': {} } for case in SPECIAL_CASES: if case in xmlfile: print("SKIP: %s" % xmlfile) return if 'errors' in xmlfile: response['status_code'] = 400 # Handle the special cased __headers__ key if it exists. if b'__headers__' in response_body: loaded = json.loads(response_body.decode('utf-8')) response['headers'] = loaded.pop('__headers__') response['body'] = json.dumps(loaded).encode('utf-8') protocol = operation_model.service_model.protocol parser_cls = parsers.PROTOCOL_PARSERS[protocol] parser = parser_cls(timestamp_parser=lambda x: x) parsed = parser.parse(response, operation_model.output_shape) parsed = _convert_bytes_to_str(parsed) expected['ResponseMetadata']['HTTPStatusCode'] = response['status_code'] expected['ResponseMetadata']['HTTPHeaders'] = response['headers'] d2 = parsed d1 = expected if d1 != d2: log.debug('-' * 40) log.debug("XML FILE:\n" + xmlfile) log.debug('-' * 40) log.debug("ACTUAL:\n" + pprint.pformat(parsed)) log.debug('-' * 40) log.debug("EXPECTED:\n" + pprint.pformat(expected)) if not d1 == d2: # Borrowed from assertDictEqual, though this doesn't # handle the case when unicode literals are used in one # dict but not in the other (and we want to consider them # as being equal). print(d1) print() print(d2) pretty_d1 = pprint.pformat(d1, width=1).splitlines() pretty_d2 = pprint.pformat(d2, width=1).splitlines() diff = ('\n' + '\n'.join(difflib.ndiff(pretty_d1, pretty_d2))) raise AssertionError("Dicts are not equal:\n%s" % diff) def _convert_bytes_to_str(parsed): if isinstance(parsed, dict): new_dict = {} for key, value in parsed.items(): new_dict[key] = _convert_bytes_to_str(value) return new_dict elif isinstance(parsed, bytes): return parsed.decode('utf-8') elif isinstance(parsed, list): new_list = [] for item in parsed: new_list.append(_convert_bytes_to_str(item)) return new_list else: return parsed def test_xml_parsing(): for dp in ['responses', 'errors']: data_path = os.path.join(os.path.dirname(__file__), 'xml') data_path = os.path.join(data_path, dp) session = create_session() xml_files = glob.glob('%s/*.xml' % data_path) service_names = set() for fn in xml_files: service_names.add(os.path.split(fn)[1].split('-')[0]) for service_name in service_names: service_model = session.get_service_model(service_name) service_xml_files = glob.glob('%s/%s-*.xml' % (data_path, service_name)) for xmlfile in service_xml_files: expected = _get_expected_parsed_result(xmlfile) operation_model = _get_operation_model(service_model, xmlfile) raw_response_body = _get_raw_response_body(xmlfile) yield _test_parsed_response, xmlfile, raw_response_body, \ operation_model, expected def _get_raw_response_body(xmlfile): with open(xmlfile, 'rb') as f: return f.read() def _get_operation_model(service_model, filename): dirname, filename = os.path.split(filename) basename = os.path.splitext(filename)[0] sn, opname = basename.split('-', 1) # In order to have multiple tests for the same # operation a '#' char is used to separate # operation names from some other suffix so that # the tests have a different filename, e.g # my-operation#1.xml, my-operation#2.xml. opname = opname.split('#')[0] operation_names = service_model.operation_names for operation_name in operation_names: if xform_name(operation_name) == opname.replace('-', '_'): return service_model.operation_model(operation_name) return operation def _get_expected_parsed_result(filename): dirname, filename = os.path.split(filename) basename = os.path.splitext(filename)[0] jsonfile = os.path.join(dirname, basename + '.json') with open(jsonfile) as f: return json.load(f) def test_json_errors_parsing(): # The outputs/ directory has sample output responses # For each file in outputs/ there's a corresponding file # in expected/ that has the expected parsed response. base_dir = os.path.join(os.path.dirname(__file__), 'json') json_responses_dir = os.path.join(base_dir, 'errors') expected_parsed_dir = os.path.join(base_dir, 'expected') session = botocore.session.get_session() for json_response_file in os.listdir(json_responses_dir): # Files look like: 'datapipeline-create-pipeline.json' service_name, operation_name = os.path.splitext( json_response_file)[0].split('-', 1) expected_parsed_response = os.path.join(expected_parsed_dir, json_response_file) raw_response_file = os.path.join(json_responses_dir, json_response_file) with open(expected_parsed_response) as f: expected = json.load(f) service_model = session.get_service_model(service_name) operation_names = service_model.operation_names operation_model = None for op_name in operation_names: if xform_name(op_name) == operation_name.replace('-', '_'): operation_model = service_model.operation_model(op_name) with open(raw_response_file, 'rb') as f: raw_response_body = f.read() yield _test_parsed_response, raw_response_file, \ raw_response_body, operation_model, expected def _uhg_test_json_parsing(): input_path = os.path.join(os.path.dirname(__file__), 'json') input_path = os.path.join(input_path, 'inputs') output_path = os.path.join(os.path.dirname(__file__), 'json') output_path = os.path.join(output_path, 'outputs') session = botocore.session.get_session() jsonfiles = glob.glob('%s/*.json' % input_path) service_names = set() for fn in jsonfiles: service_names.add(os.path.split(fn)[1].split('-')[0]) for service_name in service_names: service_model = session.get_service_model(service_name) service_json_files = glob.glob('%s/%s-*.json' % (input_path, service_name)) for jsonfile in service_json_files: expected = _get_expected_parsed_result(jsonfile) operation_model = _get_operation_model(service_model, jsonfile) with open(jsonfile, 'rb') as f: raw_response_body = f.read() yield _test_parsed_response, jsonfile, \ raw_response_body, operation_model, expected # TODO: handle the __headers crap. #class TestHeaderParsing(unittest.TestCase): # # maxDiff = None # # def setUp(self): # self.session = botocore.session.get_session() # self.s3 = self.session.get_service('s3') # # def test_put_object(self): # http_response = Mock() # http_response.encoding = 'utf-8' # http_response.headers = CaseInsensitiveDict( # {'Date': 'Thu, 22 Aug 2013 02:11:57 GMT', # 'Content-Length': '0', # 'x-amz-request-id': '2B74ECB010FF029E', # 'ETag': '"b081e66e7e0c314285c655cafb4d1e71"', # 'x-amz-id-2': 'bKECRRBFttBRVbJPIVBLQwwipI0i+s9HMvNFdttR17ouR0pvQSKEJUR+1c6cW1nQ', # 'Server': 'AmazonS3', # 'content-type': 'text/xml'}) # http_response.content = '' # put_object = self.s3.get_operation('PutObject') # expected = {"ETag": '"b081e66e7e0c314285c655cafb4d1e71"'} # response_data = get_response(self.session, put_object, http_response)[1] # self.assertEqual(response_data, expected) # # def test_head_object(self): # http_response = Mock() # http_response.encoding = 'utf-8' # http_response.headers = CaseInsensitiveDict( # {'Date': 'Thu, 22 Aug 2013 02:11:57 GMT', # 'Content-Length': '265', # 'x-amz-request-id': '2B74ECB010FF029E', # 'ETag': '"40d06eb6194712ac1c915783004ef730"', # 'Server': 'AmazonS3', # 'content-type': 'binary/octet-stream', # 'Content-Type': 'binary/octet-stream', # 'accept-ranges': 'bytes', # 'Last-Modified': 'Tue, 20 Aug 2013 18:33:25 GMT', # 'x-amz-server-side-encryption': 'AES256', # 'x-amz-meta-mykey1': 'value1', # 'x-amz-meta-mykey2': 'value2', # }) # http_response.content = '' # http_response.request.method = 'HEAD' # put_object = self.s3.get_operation('HeadObject') # expected = {"AcceptRanges": "bytes", # "ContentType": "binary/octet-stream", # "LastModified": "Tue, 20 Aug 2013 18:33:25 GMT", # "ContentLength": "265", # "ETag": '"40d06eb6194712ac1c915783004ef730"', # "ServerSideEncryption": "AES256", # "Metadata": { # 'mykey1': 'value1', # 'mykey2': 'value2', # }} # response_data = get_response(self.session, put_object, # http_response)[1] # self.assertEqual(response_data, expected) # # def test_list_objects_with_invalid_content_length(self): # http_response = Mock() # http_response.encoding = 'utf-8' # http_response.headers = CaseInsensitiveDict( # {'Date': 'Thu, 22 Aug 2013 02:11:57 GMT', # # We say we have 265 bytes but we're returning 0, # # this should raise an exception because this is not # # a HEAD request. # 'Content-Length': '265', # 'x-amz-request-id': '2B74ECB010FF029E', # 'ETag': '"40d06eb6194712ac1c915783004ef730"', # 'Server': 'AmazonS3', # 'content-type': 'binary/octet-stream', # 'Content-Type': 'binary/octet-stream', # 'accept-ranges': 'bytes', # 'Last-Modified': 'Tue, 20 Aug 2013 18:33:25 GMT', # 'x-amz-server-side-encryption': 'AES256' # }) # http_response.content = '' # http_response.request.method = 'GET' # list_objects = self.s3.get_operation('ListObjects') # expected = {"AcceptRanges": "bytes", # "ContentType": "binary/octet-stream", # "LastModified": "Tue, 20 Aug 2013 18:33:25 GMT", # "ContentLength": "265", # "ETag": '"40d06eb6194712ac1c915783004ef730"', # "ServerSideEncryption": "AES256" # } # with self.assertRaises(IncompleteReadError): # response_data = get_response(self.session, list_objects, # http_response)[1] # # def test_head_object_with_json(self): # http_response = Mock() # http_response.encoding = 'utf-8' # http_response.headers = CaseInsensitiveDict( # {'Date': 'Thu, 22 Aug 2013 02:11:57 GMT', # 'Content-Length': '0', # 'x-amz-request-id': '2B74ECB010FF029E', # 'ETag': '"40d06eb6194712ac1c915783004ef730"', # 'Server': 'AmazonS3', # 'content-type': 'application/json', # 'Content-Type': 'application/json', # 'accept-ranges': 'bytes', # 'Last-Modified': 'Tue, 20 Aug 2013 18:33:25 GMT', # 'x-amz-server-side-encryption': 'AES256'}) # http_response.content = '' # put_object = self.s3.get_operation('HeadObject') # expected = {"AcceptRanges": "bytes", # "ContentType": "application/json", # "LastModified": "Tue, 20 Aug 2013 18:33:25 GMT", # "ContentLength": "0", # "ETag": '"40d06eb6194712ac1c915783004ef730"', # "ServerSideEncryption": "AES256" # } # response_data = get_response(self.session, put_object, # http_response)[1] # self.assertEqual(response_data, expected) botocore-1.5.7/tests/unit/response_parsing/README.rst0000666454262600001440000000254513042511306023604 0ustar pysdk-ciamazon00000000000000====================== Response Parsing Tests ====================== The purpose of this collection of tests it to determine whether the XML responses from the services are being correctly parsed and transformed into Python data structures. Within the ``data`` directory you will find pairs of files, an XML file and a JSON file using a naming convention of:: -.[xml|json] Each pair of files represents one test. The XML file contains the response sent from the server for that particular request and the JSON file contains the expected Python data structure created from the XML response. The main test is contained in ``test_response_parser.py`` and is implemented as a nose generator. Each time through the loop an XML file is read and passed to a ``botocore.response.XmlResponse`` object. The corresponding JSON file is then parsed and compared to the value created by the parser. If the are equal, the test passes. If they are not equal, both the expected result and the actual result are pretty-printed to stdout and the tests continue. ----------------- Adding More Tests ----------------- You can add more tests by simply placing appropriately named XML and JSON files into the data directory. Make sure you follow the naming convention shown above as that is how the generator determines which service and operation to call. botocore-1.5.7/tests/unit/response_parsing/__init__.py0000666454262600001440000000115513042511306024222 0ustar pysdk-ciamazon00000000000000# Copyright (c) 2012 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. botocore-1.5.7/tests/unit/test_loaders.py0000666454262600001440000004242313042511306021575 0ustar pysdk-ciamazon00000000000000# 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 os import contextlib import copy import mock from botocore.exceptions import DataNotFoundError, UnknownServiceError from botocore.loaders import JSONFileLoader from botocore.loaders import Loader, create_loader from botocore.loaders import ExtrasProcessor from tests import BaseEnvVar class TestJSONFileLoader(BaseEnvVar): def setUp(self): super(TestJSONFileLoader, self).setUp() self.data_path = os.path.join(os.path.dirname(__file__), 'data') self.file_loader = JSONFileLoader() self.valid_file_path = os.path.join(self.data_path, 'foo') def test_load_file(self): data = self.file_loader.load_file(self.valid_file_path) self.assertEqual(len(data), 3) self.assertTrue('test_key_1' in data) def test_load_json_file_does_not_exist_returns_none(self): # None is used to indicate that the loader could not find a # file to load. self.assertIsNone(self.file_loader.load_file('fooasdfasdfasdf')) def test_file_exists_check(self): self.assertTrue(self.file_loader.exists(self.valid_file_path)) def test_file_does_not_exist_returns_false(self): self.assertFalse(self.file_loader.exists( os.path.join(self.data_path, 'does', 'not', 'exist'))) def test_file_with_non_ascii(self): try: filename = os.path.join(self.data_path, 'non_ascii') self.assertTrue(self.file_loader.load_file(filename) is not None) except UnicodeDecodeError: self.fail('Fail to handle data file with non-ascii characters') class TestLoader(BaseEnvVar): def test_default_search_paths(self): loader = Loader() self.assertEqual(len(loader.search_paths), 2) # We should also have ~/.aws/models added to # the search path. To deal with cross platform # issues we'll just check for a path that ends # with .aws/models. home_dir_path = os.path.join('.aws', 'models') self.assertTrue( any(p.endswith(home_dir_path) for p in loader.search_paths)) def test_can_add_to_search_path(self): loader = Loader() loader.search_paths.append('mypath') self.assertIn('mypath', loader.search_paths) def test_can_initialize_with_search_paths(self): loader = Loader(extra_search_paths=['foo', 'bar']) # Note that the extra search paths are before # the customer/builtin data paths. self.assertEqual( loader.search_paths, ['foo', 'bar', loader.CUSTOMER_DATA_PATH, loader.BUILTIN_DATA_PATH]) # The file loader isn't consulted unless the current # search path exists, so we're patching isdir to always # say that a directory exists. @mock.patch('os.path.isdir', mock.Mock(return_value=True)) def test_load_data_uses_loader(self): search_paths = ['foo', 'bar', 'baz'] class FakeLoader(object): def load_file(self, name): expected_ending = os.path.join('bar', 'baz') if name.endswith(expected_ending): return ['loaded data'] loader = Loader(extra_search_paths=search_paths, file_loader=FakeLoader()) loaded = loader.load_data('baz') self.assertEqual(loaded, ['loaded data']) def test_data_not_found_raises_exception(self): class FakeLoader(object): def load_file(self, name): # Returning None indicates that the # loader couldn't find anything. return None loader = Loader(file_loader=FakeLoader()) with self.assertRaises(DataNotFoundError): loader.load_data('baz') @mock.patch('os.path.isdir', mock.Mock(return_value=True)) def test_error_raised_if_service_does_not_exist(self): loader = Loader(extra_search_paths=[], include_default_search_paths=False) with self.assertRaises(DataNotFoundError): loader.determine_latest_version('unknownservice', 'service-2') @mock.patch('os.path.isdir', mock.Mock(return_value=True)) def test_load_service_model(self): class FakeLoader(object): def load_file(self, name): return ['loaded data'] loader = Loader(extra_search_paths=['foo'], file_loader=FakeLoader(), include_default_search_paths=False, include_default_extras=False) loader.determine_latest_version = mock.Mock(return_value='2015-03-01') loader.list_available_services = mock.Mock(return_value=['baz']) loaded = loader.load_service_model('baz', type_name='service-2') self.assertEqual(loaded, ['loaded data']) @mock.patch('os.path.isdir', mock.Mock(return_value=True)) def test_load_service_model_enforces_case(self): class FakeLoader(object): def load_file(self, name): return ['loaded data'] loader = Loader(extra_search_paths=['foo'], file_loader=FakeLoader(), include_default_search_paths=False) loader.determine_latest_version = mock.Mock(return_value='2015-03-01') loader.list_available_services = mock.Mock(return_value=['baz']) # Should have a) the unknown service name and b) list of valid # service names. with self.assertRaisesRegexp(UnknownServiceError, 'Unknown service.*BAZ.*baz'): loader.load_service_model('BAZ', type_name='service-2') def test_load_service_model_uses_provided_type_name(self): loader = Loader(extra_search_paths=['foo'], file_loader=mock.Mock(), include_default_search_paths=False) loader.list_available_services = mock.Mock(return_value=['baz']) # Should have a) the unknown service name and b) list of valid # service names. provided_type_name = 'not-service-2' with self.assertRaisesRegexp(UnknownServiceError, 'Unknown service.*BAZ.*baz'): loader.load_service_model( 'BAZ', type_name=provided_type_name) loader.list_available_services.assert_called_with(provided_type_name) def test_create_loader_parses_data_path(self): search_path = os.pathsep.join(['foo', 'bar', 'baz']) loader = create_loader(search_path) self.assertIn('foo', loader.search_paths) self.assertIn('bar', loader.search_paths) self.assertIn('baz', loader.search_paths) class TestMergeExtras(BaseEnvVar): def setUp(self): super(TestMergeExtras, self).setUp() self.file_loader = mock.Mock() self.data_loader = Loader( extra_search_paths=['datapath'], file_loader=self.file_loader, include_default_search_paths=False) self.data_loader.determine_latest_version = mock.Mock( return_value='2015-03-01') self.data_loader.list_available_services = mock.Mock( return_value=['myservice']) isdir_mock = mock.Mock(return_value=True) self.isdir_patch = mock.patch('os.path.isdir', isdir_mock) self.isdir_patch.start() def tearDown(self): super(TestMergeExtras, self).tearDown() self.isdir_patch.stop() def test_merge_extras(self): service_data = {'foo': 'service', 'bar': 'service'} sdk_extras = {'merge': {'foo': 'sdk'}} self.file_loader.load_file.side_effect = [service_data, sdk_extras] loaded = self.data_loader.load_service_model('myservice', 'service-2') expected = {'foo': 'sdk', 'bar': 'service'} self.assertEqual(loaded, expected) call_args = self.file_loader.load_file.call_args_list call_args = [c[0][0] for c in call_args] base_path = os.path.join('datapath', 'myservice', '2015-03-01') expected_call_args = [ os.path.join(base_path, 'service-2'), os.path.join(base_path, 'service-2.sdk-extras') ] self.assertEqual(call_args, expected_call_args) def test_extras_not_found(self): service_data = {'foo': 'service', 'bar': 'service'} service_data_copy = copy.copy(service_data) self.file_loader.load_file.side_effect = [service_data, None] loaded = self.data_loader.load_service_model('myservice', 'service-2') self.assertEqual(loaded, service_data_copy) def test_no_merge_in_extras(self): service_data = {'foo': 'service', 'bar': 'service'} service_data_copy = copy.copy(service_data) self.file_loader.load_file.side_effect = [service_data, {}] loaded = self.data_loader.load_service_model('myservice', 'service-2') self.assertEqual(loaded, service_data_copy) def test_include_default_extras(self): self.data_loader = Loader( extra_search_paths=['datapath'], file_loader=self.file_loader, include_default_search_paths=False, include_default_extras=False) self.data_loader.determine_latest_version = mock.Mock( return_value='2015-03-01') self.data_loader.list_available_services = mock.Mock( return_value=['myservice']) service_data = {'foo': 'service', 'bar': 'service'} service_data_copy = copy.copy(service_data) sdk_extras = {'merge': {'foo': 'sdk'}} self.file_loader.load_file.side_effect = [service_data, sdk_extras] loaded = self.data_loader.load_service_model('myservice', 'service-2') self.assertEqual(loaded, service_data_copy) def test_append_extra_type(self): service_data = {'foo': 'service', 'bar': 'service'} sdk_extras = {'merge': {'foo': 'sdk'}} cli_extras = {'merge': {'cli': True}} self.file_loader.load_file.side_effect = [ service_data, sdk_extras, cli_extras] self.data_loader.extras_types.append('cli') loaded = self.data_loader.load_service_model('myservice', 'service-2') expected = {'foo': 'sdk', 'bar': 'service', 'cli': True} self.assertEqual(loaded, expected) call_args = self.file_loader.load_file.call_args_list call_args = [c[0][0] for c in call_args] base_path = os.path.join('datapath', 'myservice', '2015-03-01') expected_call_args = [ os.path.join(base_path, 'service-2'), os.path.join(base_path, 'service-2.sdk-extras'), os.path.join(base_path, 'service-2.cli-extras') ] self.assertEqual(call_args, expected_call_args) def test_sdk_empty_extras_skipped(self): service_data = {'foo': 'service', 'bar': 'service'} cli_extras = {'merge': {'foo': 'cli'}} self.file_loader.load_file.side_effect = [ service_data, None, cli_extras] self.data_loader.extras_types.append('cli') loaded = self.data_loader.load_service_model('myservice', 'service-2') expected = {'foo': 'cli', 'bar': 'service'} self.assertEqual(loaded, expected) class TestExtrasProcessor(BaseEnvVar): def setUp(self): super(TestExtrasProcessor, self).setUp() self.processor = ExtrasProcessor() self.service_data = { 'shapes': { 'StringShape': {'type': 'string'}, } } self.service_data_copy = copy.deepcopy(self.service_data) def test_process_empty_list(self): self.processor.process(self.service_data, []) self.assertEqual(self.service_data, self.service_data_copy) def test_process_empty_extras(self): self.processor.process(self.service_data, [{}]) self.assertEqual(self.service_data, self.service_data_copy) def test_process_merge_key(self): extras = {'merge': {'shapes': {'BooleanShape': {'type': 'boolean'}}}} self.processor.process(self.service_data, [extras]) self.assertNotEqual(self.service_data, self.service_data_copy) boolean_shape = self.service_data['shapes'].get('BooleanShape') self.assertEqual(boolean_shape, {'type': 'boolean'}) def test_process_in_order(self): extras = [ {'merge': {'shapes': {'BooleanShape': {'type': 'boolean'}}}}, {'merge': {'shapes': {'BooleanShape': {'type': 'string'}}}} ] self.processor.process(self.service_data, extras) self.assertNotEqual(self.service_data, self.service_data_copy) boolean_shape = self.service_data['shapes'].get('BooleanShape') self.assertEqual(boolean_shape, {'type': 'string'}) class TestLoadersWithDirectorySearching(BaseEnvVar): def setUp(self): super(TestLoadersWithDirectorySearching, self).setUp() self.fake_directories = {} def tearDown(self): super(TestLoadersWithDirectorySearching, self).tearDown() @contextlib.contextmanager def loader_with_fake_dirs(self): mock_file_loader = mock.Mock() mock_file_loader.exists = self.fake_exists search_paths = list(self.fake_directories) loader = Loader(extra_search_paths=search_paths, include_default_search_paths=False, file_loader=mock_file_loader) with mock.patch('os.listdir', self.fake_listdir): with mock.patch('os.path.isdir', mock.Mock(return_value=True)): yield loader def fake_listdir(self, dirname): parts = dirname.split(os.path.sep) result = self.fake_directories while parts: current = parts.pop(0) result = result[current] return list(result) def fake_exists(self, path): parts = path.split(os.sep) result = self.fake_directories while len(parts) > 1: current = parts.pop(0) result = result[current] return parts[0] in result def test_list_available_services(self): self.fake_directories = { 'foo': { 'ec2': { '2010-01-01': ['service-2'], '2014-10-01': ['service-1'], }, 'dynamodb': { '2010-01-01': ['service-2'], }, }, 'bar': { 'ec2': { '2015-03-01': ['service-1'], }, 'rds': { # This will not show up in # list_available_services() for type # service-2 because it does not contains # a service-2. '2012-01-01': ['resource-1'], }, }, } with self.loader_with_fake_dirs() as loader: self.assertEqual( loader.list_available_services(type_name='service-2'), ['dynamodb', 'ec2']) self.assertEqual( loader.list_available_services(type_name='resource-1'), ['rds']) def test_determine_latest(self): # Fake mapping of directories to subdirectories. # In this example, we can see that the 'bar' directory # contains the latest EC2 API version, 2015-03-01, # so loader.determine_latest('ec2') should return # this value 2015-03-01. self.fake_directories = { 'foo': { 'ec2': { '2010-01-01': ['service-2'], # This directory contains the latest API version # for EC2 because its the highest API directory # that contains a service-2. '2014-10-01': ['service-2'], }, }, 'bar': { 'ec2': { '2012-01-01': ['service-2'], # 2015-03-1 is *not* the latest for service-2, # because its directory only has service-1.json. '2015-03-01': ['service-1'], }, }, } with self.loader_with_fake_dirs() as loader: latest = loader.determine_latest_version('ec2', 'service-2') self.assertEqual(loader.determine_latest_version('ec2', 'service-2'), '2014-10-01') self.assertEqual(loader.determine_latest_version('ec2', 'service-1'), '2015-03-01') botocore-1.5.7/tests/unit/test_validate.py0000666454262600001440000003421113042511306021731 0ustar pysdk-ciamazon00000000000000from tests import unittest from datetime import datetime import decimal from botocore.compat import six from botocore.model import ShapeResolver from botocore.model import StructureShape from botocore.validate import ParamValidator BOILER_PLATE_SHAPES = { 'StringType': { 'type': 'string' } } class BaseTestValidate(unittest.TestCase): def assert_has_validation_errors(self, given_shapes, input_params, errors): # Given the shape definitions ``given_shape`` and the user input # parameters ``input_params``, verify that the validation has # validation errors containing the list of ``errors``. # Also, this assumes the input shape name is "Input". errors_found = self.get_validation_error_message( given_shapes, input_params) self.assertTrue(errors_found.has_errors()) error_message = errors_found.generate_report() for error in errors: self.assertIn(error, error_message) def get_validation_error_message(self, given_shapes, input_params): s = ShapeResolver(given_shapes) input_shape = s.get_shape_by_name('Input') validator = ParamValidator() errors_found = validator.validate(input_params, input_shape) error_message = errors_found.generate_report() return errors_found class TestValidateRequiredParams(BaseTestValidate): def test_validate_required_params(self): self.assert_has_validation_errors( given_shapes={ 'Input': { 'type': 'structure', 'required': ['A', 'B'], 'members': { 'A': {'shape': 'StringType'}, 'B': {'shape': 'StringType'} } }, 'StringType': {'type': 'string'} }, input_params={'A': 'foo'}, errors=['Missing required parameter']) def test_validate_nested_required_param(self): self.assert_has_validation_errors( given_shapes={ 'Input': { 'type': 'structure', 'members': { 'A': {'shape': 'SubStruct'} } }, 'SubStruct': { 'type': 'structure', 'required': ['B', 'C'], 'members': { 'B': {'shape': 'StringType'}, 'C': {'shape': 'StringType'}, } }, 'StringType': { 'type': 'string', } }, input_params={'A': {'B': 'foo'}}, errors=['Missing required parameter']) def test_validate_unknown_param(self): self.assert_has_validation_errors( given_shapes={ 'Input': { 'type': 'structure', 'required': ['A'], 'members': { 'A': {'shape': 'StringType'}, } }, 'StringType': {'type': 'string'} }, input_params={'A': 'foo', 'B': 'bar'}, errors=['Unknown parameter']) class TestValidateTypes(BaseTestValidate): def setUp(self): self.shapes = { 'Input': { 'type': 'structure', 'members': { 'Str': {'shape': 'StrType'}, 'Int': {'shape': 'IntType'}, 'Bool': {'shape': 'BoolType'}, 'List': {'shape': 'ListType'}, 'Struct': {'shape': 'StructType'}, 'Double': {'shape': 'DoubleType'}, 'Long': {'shape': 'LongType'}, 'Map': {'shape': 'MapType'}, 'Timestamp': {'shape': 'TimeType'}, } }, 'StrType': {'type': 'string'}, 'IntType': {'type': 'integer'}, 'BoolType': {'type': 'boolean'}, 'ListType': {'type': 'list'}, 'StructType': {'type': 'structure'}, 'DoubleType': {'type': 'double'}, 'LongType': {'type': 'long'}, 'MapType': {'type': 'map'}, 'TimeType': {'type': 'timestamp'}, } def test_validate_string(self): self.assert_has_validation_errors( given_shapes=self.shapes, input_params={ 'Str': 24, 'Int': 'notInt', 'Bool': 'notBool', 'List': 'notList', 'Struct': 'notDict', 'Double': 'notDouble', 'Long': 'notLong', 'Map': 'notDict', 'Timestamp': 'notTimestamp', }, errors=[ 'Invalid type for parameter Str', 'Invalid type for parameter Int', 'Invalid type for parameter Bool', 'Invalid type for parameter List', 'Invalid type for parameter Struct', 'Invalid type for parameter Double', 'Invalid type for parameter Long', 'Invalid type for parameter Map', 'Invalid type for parameter Timestamp', ] ) def test_datetime_type_accepts_datetime_obj(self): errors = self.get_validation_error_message( given_shapes=self.shapes, input_params={'Timestamp': datetime.now(),}) error_msg = errors.generate_report() self.assertEqual(error_msg, '') def test_datetime_accepts_string_timestamp(self): errors = self.get_validation_error_message( given_shapes=self.shapes, input_params={'Timestamp': '2014-01-01 12:00:00'}) error_msg = errors.generate_report() self.assertEqual(error_msg, '') def test_can_handle_none_datetimes(self): # This is specifically to test a workaround a bug in dateutil # where low level exceptions can propogate back up to # us. errors = self.get_validation_error_message( given_shapes=self.shapes, input_params={'Timestamp': None}) error_msg = errors.generate_report() self.assertIn('Invalid type for parameter Timestamp', error_msg) class TestValidateRanges(BaseTestValidate): def setUp(self): self.shapes = { 'Input': { 'type': 'structure', 'members': { 'Int': {'shape': 'IntType'}, 'Long': {'shape': 'IntType'}, 'String': {'shape': 'StringType'}, 'List': {'shape': 'ListType'}, 'OnlyMin': {'shape': 'MinStrOnly'}, 'OnlyMax': {'shape': 'MaxStrOnly'}, } }, 'IntType': { 'type': 'integer', 'min': 0, 'max': 1000, }, 'LongType': { 'type': 'long', 'min': 0, 'max': 1000, }, 'StringType': { 'type': 'string', 'min': 1, 'max': 10, }, 'MinStrOnly': { 'type': 'string', 'min': 1 }, 'MaxStrOnly': { 'type': 'string', 'max': 10 }, 'ListType': { 'type': 'list', 'min': 1, 'max': 5, 'member': { 'shape': 'StringType' } }, } def test_less_than_range(self): self.assert_has_validation_errors( given_shapes=self.shapes, input_params={ 'Int': -10, 'Long': -10, }, errors=[ 'Invalid range for parameter Int', 'Invalid range for parameter Long', ] ) def test_does_not_validate_greater_than_range(self): errors = self.get_validation_error_message( given_shapes=self.shapes, input_params={ 'Int': 100000000, 'Long': 100000000, }, ) error_msg = errors.generate_report() self.assertEqual(error_msg, '') def test_within_range(self): errors = self.get_validation_error_message( given_shapes=self.shapes, input_params={'Int': 10}) error_msg = errors.generate_report() self.assertEqual(error_msg, '') def test_string_min_length_contraint(self): self.assert_has_validation_errors( given_shapes=self.shapes, input_params={ 'String': '', }, errors=[ 'Invalid length for parameter String', ] ) def test_does_not_validate_string_max_length_contraint(self): errors = self.get_validation_error_message( given_shapes=self.shapes, input_params={ 'String': 'more than ten characters', }, ) error_msg = errors.generate_report() self.assertEqual(error_msg, '') def test_list_min_length_constraint(self): self.assert_has_validation_errors( given_shapes=self.shapes, input_params={ 'List': [], }, errors=[ 'Invalid length for parameter List', ] ) def test_does_not_validate_list_max_length_constraint(self): errors = self.get_validation_error_message( given_shapes=self.shapes, input_params={ 'List': ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h'], }, ) error_msg = errors.generate_report() self.assertEqual(error_msg, '') def test_only_min_value_specified(self): # min anx max don't have to both be provided. # It's valid to just have min with no max, and # vice versa. self.assert_has_validation_errors( given_shapes=self.shapes, input_params={ 'OnlyMin': '', }, errors=[ 'Invalid length for parameter OnlyMin', ] ) def test_does_not_validate_max_when_only_max_value_specified(self): errors = self.get_validation_error_message( given_shapes=self.shapes, input_params={ 'OnlyMax': 'more than ten characters', }, ) error_msg = errors.generate_report() self.assertEqual(error_msg, '') class TestValidateMapType(BaseTestValidate): def setUp(self): self.shapes = { 'Input': { 'type': 'structure', 'members': { 'Map': {'shape': 'MapType'}, } }, 'MapType': { 'type': 'map', 'key': {'shape': 'StringType'}, 'value': {'shape': 'StringType'}, }, 'StringType': { 'type': 'string', 'min': 2, }, } def test_validate_keys_and_values(self): self.assert_has_validation_errors( given_shapes=self.shapes, input_params={ 'Map': {'foo': '', 'a': 'foobar'} }, errors=[ 'Invalid length for parameter Map', ] ) class TestValidationFloatType(BaseTestValidate): def setUp(self): self.shapes = { 'Input': { 'type': 'structure', 'members': { 'Float': {'shape': 'FloatType'}, } }, 'FloatType': { 'type': 'float', 'min': 2, 'max': 5, }, } def test_range_float(self): self.assert_has_validation_errors( given_shapes=self.shapes, input_params={ 'Float': 1, }, errors=[ 'Invalid range for parameter Float', ] ) def test_decimal_allowed(self): errors = self.get_validation_error_message( given_shapes=self.shapes, input_params={'Float': decimal.Decimal('2.12345')}) error_msg = errors.generate_report() self.assertEqual(error_msg, '') def test_decimal_still_validates_range(self): self.assert_has_validation_errors( given_shapes=self.shapes, input_params={ 'Float': decimal.Decimal('1'), }, errors=[ 'Invalid range for parameter Float', ] ) class TestValidateTypeBlob(BaseTestValidate): def setUp(self): self.shapes = { 'Input': { 'type': 'structure', 'members': { 'Blob': {'shape': 'BlobType'}, } }, 'BlobType': { 'type': 'blob', 'min': 2, 'max': 5, }, } def test_validates_bytes(self): errors = self.get_validation_error_message( given_shapes=self.shapes, input_params={'Blob': b'12345'} ) error_msg = errors.generate_report() self.assertEqual(error_msg, '') def test_validates_bytearray(self): errors = self.get_validation_error_message( given_shapes=self.shapes, input_params={'Blob': bytearray(b'12345')}, ) error_msg = errors.generate_report() self.assertEqual(error_msg, '') def test_validates_file_like_object(self): value = six.BytesIO(b'foo') errors = self.get_validation_error_message( given_shapes=self.shapes, input_params={'Blob': value}, ) error_msg = errors.generate_report() self.assertEqual(error_msg, '') def test_validate_type(self): self.assert_has_validation_errors( given_shapes=self.shapes, input_params={ 'Blob': 24, }, errors=[ 'Invalid type for parameter Blob', ] ) botocore-1.5.7/tests/unit/test_compat.py0000666454262600001440000000636413042511306021433 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import datetime import mock from botocore.exceptions import MD5UnavailableError from botocore.compat import ( total_seconds, unquote_str, six, ensure_bytes, get_md5 ) from tests import BaseEnvVar, unittest class TotalSecondsTest(BaseEnvVar): def test_total_seconds(self): delta = datetime.timedelta(days=1, seconds=45) remaining = total_seconds(delta) self.assertEqual(remaining, 86445.0) delta = datetime.timedelta(seconds=33, microseconds=772) remaining = total_seconds(delta) self.assertEqual(remaining, 33.000772) class TestUnquoteStr(unittest.TestCase): def test_unquote_str(self): value = u'%E2%9C%93' # Note: decoded to unicode and utf-8 decoded as well. # This would work in python2 and python3. self.assertEqual(unquote_str(value), u'\u2713') def test_unquote_normal(self): value = u'foo' # Note: decoded to unicode and utf-8 decoded as well. # This would work in python2 and python3. self.assertEqual(unquote_str(value), u'foo') def test_unquote_with_spaces(self): value = u'foo+bar' # Note: decoded to unicode and utf-8 decoded as well. # This would work in python2 and python3. self.assertEqual(unquote_str(value), 'foo bar') class TestEnsureBytes(unittest.TestCase): def test_string(self): value = 'foo' response = ensure_bytes(value) self.assertIsInstance(response, six.binary_type) self.assertEqual(response, b'foo') def test_binary(self): value = b'bar' response = ensure_bytes(value) self.assertIsInstance(response, six.binary_type) self.assertEqual(response, b'bar') def test_unicode(self): value = u'baz' response = ensure_bytes(value) self.assertIsInstance(response, six.binary_type) self.assertEqual(response, b'baz') def test_non_ascii(self): value = u'\u2713' response = ensure_bytes(value) self.assertIsInstance(response, six.binary_type) self.assertEqual(response, b'\xe2\x9c\x93') def test_non_string_or_bytes_raises_error(self): value = 500 with self.assertRaises(ValueError): ensure_bytes(value) class TestGetMD5(unittest.TestCase): def test_available(self): md5 = mock.Mock() with mock.patch('botocore.compat.MD5_AVAILABLE', True): with mock.patch('hashlib.md5', mock.Mock(return_value=md5)): self.assertEqual(get_md5(), md5) def test_unavailable_raises_error(self): with mock.patch('botocore.compat.MD5_AVAILABLE', False): with self.assertRaises(MD5UnavailableError): get_md5() botocore-1.5.7/tests/unit/test_awsrequest.py0000666454262600001440000005733213042511306022354 0ustar pysdk-ciamazon00000000000000#!/usr/bin/env # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest import os import tempfile import shutil import io import socket import sys from mock import Mock, patch from botocore.exceptions import UnseekableStreamError from botocore.awsrequest import AWSRequest, AWSPreparedRequest from botocore.awsrequest import AWSHTTPConnection from botocore.awsrequest import prepare_request_dict, create_request_object from botocore.compat import file_type, six class IgnoreCloseBytesIO(io.BytesIO): def close(self): pass class FakeSocket(object): def __init__(self, read_data, fileclass=IgnoreCloseBytesIO): self.sent_data = b'' self.read_data = read_data self.fileclass = fileclass self._fp_object = None def sendall(self, data): self.sent_data += data def makefile(self, mode, bufsize=None): if self._fp_object is None: self._fp_object = self.fileclass(self.read_data) return self._fp_object def close(self): pass class BytesIOWithLen(six.BytesIO): def __len__(self): return len(self.getvalue()) class Unseekable(file_type): def __init__(self, stream): self._stream = stream def read(self): return self._stream.read() def seek(self, offset, whence): # This is a case where seek() exists as part of the object's interface, # but it doesn't actually work (for example socket.makefile(), which # will raise an io.* error on python3). raise ValueError("Underlying stream does not support seeking.") class Seekable(object): """This class represents a bare-bones,seekable file-like object Note it does not include some of the other attributes of other file-like objects such as StringIO's getvalue() and file object's fileno property. If the file-like object does not have either of these attributes requests will not calculate the content length even though it is still possible to calculate it. """ def __init__(self, stream): self._stream = stream def __iter__(self): return iter(self._stream) def read(self): return self._stream.read() def seek(self, offset, whence=0): self._stream.seek(offset, whence) def tell(self): return self._stream.tell() class TestAWSRequest(unittest.TestCase): def setUp(self): self.tempdir = tempfile.mkdtemp() self.request = AWSRequest(url='http://example.com') self.prepared_request = self.request.prepare() self.filename = os.path.join(self.tempdir, 'foo') def tearDown(self): shutil.rmtree(self.tempdir) def test_should_reset_stream(self): with open(self.filename, 'wb') as f: f.write(b'foobarbaz') with open(self.filename, 'rb') as body: self.prepared_request.body = body # Now pretend we try to send the request. # This means that we read the body: body.read() # And create a response object that indicates # a redirect. fake_response = Mock() fake_response.status_code = 307 # Then requests calls our reset_stream hook. self.prepared_request.reset_stream_on_redirect(fake_response) # The stream should now be reset. self.assertEqual(body.tell(), 0) def test_cannot_reset_stream_raises_error(self): with open(self.filename, 'wb') as f: f.write(b'foobarbaz') with open(self.filename, 'rb') as body: self.prepared_request.body = Unseekable(body) # Now pretend we try to send the request. # This means that we read the body: body.read() # And create a response object that indicates # a redirect fake_response = Mock() fake_response.status_code = 307 # Then requests calls our reset_stream hook. with self.assertRaises(UnseekableStreamError): self.prepared_request.reset_stream_on_redirect(fake_response) def test_duck_type_for_file_check(self): # As part of determining whether or not we can rewind a stream # we first need to determine if the thing is a file like object. # We should not be using an isinstance check. Instead, we should # be using duck type checks. class LooksLikeFile(object): def __init__(self): self.seek_called = False def read(self, amount=None): pass def seek(self, where): self.seek_called = True looks_like_file = LooksLikeFile() self.prepared_request.body = looks_like_file fake_response = Mock() fake_response.status_code = 307 # Then requests calls our reset_stream hook. self.prepared_request.reset_stream_on_redirect(fake_response) # The stream should now be reset. self.assertTrue(looks_like_file.seek_called) class TestAWSPreparedRequest(unittest.TestCase): def setUp(self): self.tempdir = tempfile.mkdtemp() self.filename = os.path.join(self.tempdir, 'foo') self.request = AWSRequest(url='http://example.com') self.prepared_request = AWSPreparedRequest(self.request) self.prepared_request.prepare_headers(self.request.headers) def tearDown(self): shutil.rmtree(self.tempdir) def test_prepare_body_content_adds_content_length(self): content = b'foobarbaz' with open(self.filename, 'wb') as f: f.write(content) with open(self.filename, 'rb') as f: data = Seekable(f) self.prepared_request.prepare_body(data=data, files=None) self.assertEqual( self.prepared_request.headers['Content-Length'], str(len(content))) def test_prepare_body_removes_transfer_encoding(self): self.prepared_request.headers['Transfer-Encoding'] = 'chunked' content = b'foobarbaz' with open(self.filename, 'wb') as f: f.write(content) with open(self.filename, 'rb') as f: data = Seekable(f) self.prepared_request.prepare_body(data=data, files=None) self.assertEqual( self.prepared_request.headers['Content-Length'], str(len(content))) self.assertNotIn('Transfer-Encoding', self.prepared_request.headers) def test_prepare_body_ignores_existing_transfer_encoding(self): content = b'foobarbaz' self.prepared_request.headers['Transfer-Encoding'] = 'chunked' with open(self.filename, 'wb') as f: f.write(content) with open(self.filename, 'rb') as f: self.prepared_request.prepare_body(data=f, files=None) # The Transfer-Encoding should not be removed if Content-Length # is not added via the custom logic in the ``prepare_body`` method. # Note requests' ``prepare_body`` is the method that adds the # Content-Length header for this case as the ``data`` is a # regular file handle. self.assertEqual( self.prepared_request.headers['Transfer-Encoding'], 'chunked') class TestAWSHTTPConnection(unittest.TestCase): def create_tunneled_connection(self, url, port, response): s = FakeSocket(response) conn = AWSHTTPConnection(url, port) conn.sock = s conn._tunnel_host = url conn._tunnel_port = port conn._tunnel_headers = {'key': 'value'} # Create a mock response. self.mock_response = Mock() self.mock_response.fp = Mock() # Imitate readline function by creating a list to be sent as # a side effect of the mocked readline to be able to track how the # response is processed in ``_tunnel()``. delimeter = b'\r\n' side_effect = [] response_components = response.split(delimeter) for i in range(len(response_components)): new_component = response_components[i] # Only add the delimeter on if it is not the last component # which should be an empty string. if i != len(response_components) - 1: new_component += delimeter side_effect.append(new_component) self.mock_response.fp.readline.side_effect = side_effect response_components = response.split(b' ') self.mock_response._read_status.return_value = ( response_components[0], int(response_components[1]), response_components[2] ) conn.response_class = Mock() conn.response_class.return_value = self.mock_response return conn def test_expect_100_continue_returned(self): with patch('select.select') as select_mock: # Shows the server first sending a 100 continue response # then a 200 ok response. s = FakeSocket(b'HTTP/1.1 100 Continue\r\n\r\nHTTP/1.1 200 OK\r\n') conn = AWSHTTPConnection('s3.amazonaws.com', 443) conn.sock = s select_mock.return_value = ([s], [], []) conn.request('GET', '/bucket/foo', b'body', {'Expect': '100-continue'}) response = conn.getresponse() # Now we should verify that our final response is the 200 OK self.assertEqual(response.status, 200) def test_handles_expect_100_with_different_reason_phrase(self): with patch('select.select') as select_mock: # Shows the server first sending a 100 continue response # then a 200 ok response. s = FakeSocket(b'HTTP/1.1 100 (Continue)\r\n\r\nHTTP/1.1 200 OK\r\n') conn = AWSHTTPConnection('s3.amazonaws.com', 443) conn.sock = s select_mock.return_value = ([s], [], []) conn.request('GET', '/bucket/foo', six.BytesIO(b'body'), {'Expect': '100-continue', 'Content-Length': '4'}) response = conn.getresponse() # Now we should verify that our final response is the 200 OK. self.assertEqual(response.status, 200) # Verify that we went the request body because we got a 100 # continue. self.assertIn(b'body', s.sent_data) def test_expect_100_sends_connection_header(self): # When using squid as an HTTP proxy, it will also send # a Connection: keep-alive header back with the 100 continue # response. We need to ensure we handle this case. with patch('select.select') as select_mock: # Shows the server first sending a 100 continue response # then a 500 response. We're picking 500 to confirm we # actually parse the response instead of getting the # default status of 200 which happens when we can't parse # the response. s = FakeSocket(b'HTTP/1.1 100 Continue\r\n' b'Connection: keep-alive\r\n' b'\r\n' b'HTTP/1.1 500 Internal Service Error\r\n') conn = AWSHTTPConnection('s3.amazonaws.com', 443) conn.sock = s select_mock.return_value = ([s], [], []) conn.request('GET', '/bucket/foo', b'body', {'Expect': '100-continue'}) response = conn.getresponse() self.assertEqual(response.status, 500) def test_expect_100_continue_sends_307(self): # This is the case where we send a 100 continue and the server # immediately sends a 307 with patch('select.select') as select_mock: # Shows the server first sending a 100 continue response # then a 200 ok response. s = FakeSocket( b'HTTP/1.1 307 Temporary Redirect\r\n' b'Location: http://example.org\r\n') conn = AWSHTTPConnection('s3.amazonaws.com', 443) conn.sock = s select_mock.return_value = ([s], [], []) conn.request('GET', '/bucket/foo', b'body', {'Expect': '100-continue'}) response = conn.getresponse() # Now we should verify that our final response is the 307. self.assertEqual(response.status, 307) def test_expect_100_continue_no_response_from_server(self): with patch('select.select') as select_mock: # Shows the server first sending a 100 continue response # then a 200 ok response. s = FakeSocket( b'HTTP/1.1 307 Temporary Redirect\r\n' b'Location: http://example.org\r\n') conn = AWSHTTPConnection('s3.amazonaws.com', 443) conn.sock = s # By settings select_mock to return empty lists, this indicates # that the server did not send any response. In this situation # we should just send the request anyways. select_mock.return_value = ([], [], []) conn.request('GET', '/bucket/foo', b'body', {'Expect': '100-continue'}) response = conn.getresponse() self.assertEqual(response.status, 307) def test_message_body_is_file_like_object(self): # Shows the server first sending a 100 continue response # then a 200 ok response. body = BytesIOWithLen(b'body contents') s = FakeSocket(b'HTTP/1.1 200 OK\r\n') conn = AWSHTTPConnection('s3.amazonaws.com', 443) conn.sock = s conn.request('GET', '/bucket/foo', body) response = conn.getresponse() self.assertEqual(response.status, 200) def test_no_expect_header_set(self): # Shows the server first sending a 100 continue response # then a 200 ok response. s = FakeSocket(b'HTTP/1.1 200 OK\r\n') conn = AWSHTTPConnection('s3.amazonaws.com', 443) conn.sock = s conn.request('GET', '/bucket/foo', b'body') response = conn.getresponse() self.assertEqual(response.status, 200) def test_tunnel_readline_none_bugfix(self): # Tests whether ``_tunnel`` function is able to work around the # py26 bug of avoiding infinite while loop if nothing is returned. conn = self.create_tunneled_connection( url='s3.amazonaws.com', port=443, response=b'HTTP/1.1 200 OK\r\n', ) conn._tunnel() # Ensure proper amount of readline calls were made. self.assertEqual(self.mock_response.fp.readline.call_count, 2) def test_tunnel_readline_normal(self): # Tests that ``_tunnel`` function behaves normally when it comes # across the usual http ending. conn = self.create_tunneled_connection( url='s3.amazonaws.com', port=443, response=b'HTTP/1.1 200 OK\r\n\r\n', ) conn._tunnel() # Ensure proper amount of readline calls were made. self.assertEqual(self.mock_response.fp.readline.call_count, 2) def test_tunnel_raises_socket_error(self): # Tests that ``_tunnel`` function throws appropriate error when # not 200 status. conn = self.create_tunneled_connection( url='s3.amazonaws.com', port=443, response=b'HTTP/1.1 404 Not Found\r\n\r\n', ) with self.assertRaises(socket.error): conn._tunnel() @unittest.skipIf(sys.version_info[:2] == (2, 6), ("``_tunnel()`` function defaults to standard " "http library function when not py26.")) def test_tunnel_uses_std_lib(self): s = FakeSocket(b'HTTP/1.1 200 OK\r\n') conn = AWSHTTPConnection('s3.amazonaws.com', 443) conn.sock = s # Test that the standard library method was used by patching out # the ``_tunnel`` method and seeing if the std lib method was called. with patch('botocore.vendored.requests.packages.urllib3.connection.' 'HTTPConnection._tunnel') as mock_tunnel: conn._tunnel() self.assertTrue(mock_tunnel.called) def test_encodes_unicode_method_line(self): s = FakeSocket(b'HTTP/1.1 200 OK\r\n') conn = AWSHTTPConnection('s3.amazonaws.com', 443) conn.sock = s # Note the combination of unicode 'GET' and # bytes 'Utf8-Header' value. conn.request(u'GET', '/bucket/foo', b'body', headers={"Utf8-Header": b"\xe5\xb0\x8f"}) response = conn.getresponse() self.assertEqual(response.status, 200) def test_state_reset_on_connection_close(self): # This simulates what urllib3 does with connections # in its connection pool logic. with patch('select.select') as select_mock: # First fast fail with a 500 response when we first # send the expect header. s = FakeSocket(b'HTTP/1.1 500 Internal Server Error\r\n') conn = AWSHTTPConnection('s3.amazonaws.com', 443) conn.sock = s select_mock.return_value = ([s], [], []) conn.request('GET', '/bucket/foo', b'body', {'Expect': '100-continue'}) response = conn.getresponse() self.assertEqual(response.status, 500) # Now what happens in urllib3 is that when the next # request comes along and this conection gets checked # out. We see that the connection needs to be # reset. So first the connection is closed. conn.close() # And then a new connection is established. new_conn = FakeSocket( b'HTTP/1.1 100 (Continue)\r\n\r\nHTTP/1.1 200 OK\r\n') conn.sock = new_conn # And we make a request, we should see the 200 response # that was sent back. select_mock.return_value = ([new_conn], [], []) conn.request('GET', '/bucket/foo', b'body', {'Expect': '100-continue'}) response = conn.getresponse() # This should be 200. If it's a 500 then # the prior response was leaking into our # current response., self.assertEqual(response.status, 200) class TestPrepareRequestDict(unittest.TestCase): def setUp(self): self.user_agent = 'botocore/1.0' self.endpoint_url = 'https://s3.amazonaws.com' self.base_request_dict = { 'body': '', 'headers': {}, 'method': u'GET', 'query_string': '', 'url_path': '/', 'context': {} } def prepare_base_request_dict(self, request_dict, endpoint_url=None, user_agent=None, context=None): self.base_request_dict.update(request_dict) context = context or {} if user_agent is None: user_agent = self.user_agent if endpoint_url is None: endpoint_url = self.endpoint_url prepare_request_dict(self.base_request_dict, endpoint_url=endpoint_url, user_agent=user_agent, context=context) def test_prepare_request_dict_for_get(self): request_dict = { 'method': u'GET', 'url_path': '/' } self.prepare_base_request_dict( request_dict, endpoint_url='https://s3.amazonaws.com') self.assertEqual(self.base_request_dict['method'], 'GET') self.assertEqual(self.base_request_dict['url'], 'https://s3.amazonaws.com/') self.assertEqual(self.base_request_dict['headers']['User-Agent'], self.user_agent) def test_prepare_request_dict_for_get_no_user_agent(self): self.user_agent = None request_dict = { 'method': u'GET', 'url_path': '/' } self.prepare_base_request_dict( request_dict, endpoint_url='https://s3.amazonaws.com') self.assertNotIn('User-Agent', self.base_request_dict['headers']) def test_prepare_request_dict_with_context(self): context = {'foo': 'bar'} self.prepare_base_request_dict({}, context=context) self.assertEqual(self.base_request_dict['context'], context) def test_query_string_serialized_to_url(self): request_dict = { 'method': u'GET', 'query_string': {u'prefix': u'foo'}, 'url_path': u'/mybucket' } self.prepare_base_request_dict(request_dict) self.assertEqual( self.base_request_dict['url'], 'https://s3.amazonaws.com/mybucket?prefix=foo') def test_url_path_combined_with_endpoint_url(self): # This checks the case where a user specifies and # endpoint_url that has a path component, and the # serializer gives us a request_dict that has a url # component as well (say from a rest-* service). request_dict = { 'query_string': {u'prefix': u'foo'}, 'url_path': u'/mybucket' } endpoint_url = 'https://custom.endpoint/foo/bar' self.prepare_base_request_dict(request_dict, endpoint_url) self.assertEqual( self.base_request_dict['url'], 'https://custom.endpoint/foo/bar/mybucket?prefix=foo') def test_url_path_with_trailing_slash(self): self.prepare_base_request_dict( {'url_path': u'/mybucket'}, endpoint_url='https://custom.endpoint/foo/bar/') self.assertEqual( self.base_request_dict['url'], 'https://custom.endpoint/foo/bar/mybucket') def test_url_path_is_slash(self): self.prepare_base_request_dict( {'url_path': u'/'}, endpoint_url='https://custom.endpoint/foo/bar/') self.assertEqual( self.base_request_dict['url'], 'https://custom.endpoint/foo/bar/') def test_url_path_is_slash_with_endpoint_url_no_slash(self): self.prepare_base_request_dict( {'url_path': u'/'}, endpoint_url='https://custom.endpoint/foo/bar') self.assertEqual( self.base_request_dict['url'], 'https://custom.endpoint/foo/bar') def test_custom_endpoint_with_query_string(self): self.prepare_base_request_dict( {'url_path': u'/baz', 'query_string': {'x': 'y'}}, endpoint_url='https://custom.endpoint/foo/bar?foo=bar') self.assertEqual( self.base_request_dict['url'], 'https://custom.endpoint/foo/bar/baz?foo=bar&x=y') class TestCreateRequestObject(unittest.TestCase): def setUp(self): self.request_dict = { 'method': u'GET', 'query_string': {u'prefix': u'foo'}, 'url_path': u'/mybucket', 'headers': {u'User-Agent': u'my-agent'}, 'body': u'my body', 'url': u'https://s3.amazonaws.com/mybucket?prefix=foo', 'context': {'signing': {'region': 'us-west-2'}} } def test_create_request_object(self): request = create_request_object(self.request_dict) self.assertEqual(request.method, self.request_dict['method']) self.assertEqual(request.url, self.request_dict['url']) self.assertEqual(request.data, self.request_dict['body']) self.assertEqual(request.context, self.request_dict['context']) self.assertIn('User-Agent', request.headers) if __name__ == "__main__": unittest.main() botocore-1.5.7/tests/unit/test_exceptions.py0000666454262600001440000000443113042511306022322 0ustar pysdk-ciamazon00000000000000#!/usr/bin/env # Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from nose.tools import assert_equals from botocore import exceptions def test_client_error_can_handle_missing_code_or_message(): response = {'Error': {}} expect = 'An error occurred (Unknown) when calling the blackhole operation: Unknown' assert_equals(str(exceptions.ClientError(response, 'blackhole')), expect) def test_client_error_has_operation_name_set(): response = {'Error': {}} exception = exceptions.ClientError(response, 'blackhole') assert hasattr(exception, 'operation_name') def test_client_error_set_correct_operation_name(): response = {'Error': {}} exception = exceptions.ClientError(response, 'blackhole') assert_equals(exception.operation_name, 'blackhole') def test_retry_info_added_when_present(): response = { 'Error': {}, 'ResponseMetadata': { 'MaxAttemptsReached': True, 'RetryAttempts': 3, } } error_msg = str(exceptions.ClientError(response, 'operation')) if '(reached max retries: 3)' not in error_msg: raise AssertionError("retry information not inject into error " "message: %s" % error_msg) def test_retry_info_not_added_if_retry_attempts_not_present(): response = { 'Error': {}, 'ResponseMetadata': { 'MaxAttemptsReached': True, } } # Because RetryAttempts is missing, retry info is not # in the error message. error_msg = str(exceptions.ClientError(response, 'operation')) if 'max retries' in error_msg: raise AssertionError("Retry information should not be in exception " "message when retry attempts not in response " "metadata: %s" % error_msg) botocore-1.5.7/tests/unit/test_serialize.py0000666454262600001440000004450713042511306022140 0ustar pysdk-ciamazon00000000000000"""Additional tests for request serialization. While there are compliance tests in tests/unit/protocols where the majority of the request serialization/response parsing is tested, this test module contains additional tests that go above and beyond the spec. This can happen for a number of reasons: * We are testing python specific behavior that doesn't make sense as a compliance test. * We are testing behavior that is not strictly part of the spec. These may result in a a coverage gap that would otherwise be untested. """ import base64 import json import datetime import dateutil.tz from tests import unittest from botocore.model import ServiceModel from botocore import serialize from botocore.compat import six from botocore.exceptions import ParamValidationError class BaseModelWithBlob(unittest.TestCase): def setUp(self): self.model = { 'metadata': {'protocol': 'query', 'apiVersion': '2014-01-01'}, 'documentation': '', 'operations': { 'TestOperation': { 'name': 'TestOperation', 'http': { 'method': 'POST', 'requestUri': '/', }, 'input': {'shape': 'InputShape'}, } }, 'shapes': { 'InputShape': { 'type': 'structure', 'members': { 'Blob': {'shape': 'BlobType'}, } }, 'BlobType': { 'type': 'blob', } } } def serialize_to_request(self, input_params): service_model = ServiceModel(self.model) request_serializer = serialize.create_serializer( service_model.metadata['protocol']) return request_serializer.serialize_to_request( input_params, service_model.operation_model('TestOperation')) def assert_serialized_blob_equals(self, request, blob_bytes): # This method handles all the details of the base64 decoding. encoded = base64.b64encode(blob_bytes) # Now the serializers actually have the base64 encoded contents # as str types so we need to decode back. We know that this is # ascii so it's safe to use the ascii encoding. expected = encoded.decode('ascii') self.assertEqual(request['body']['Blob'], expected) class TestBinaryTypes(BaseModelWithBlob): def test_blob_accepts_bytes_type(self): body = b'bytes body' request = self.serialize_to_request(input_params={'Blob': body}) self.assert_serialized_blob_equals( request, blob_bytes=body) def test_blob_accepts_str_type(self): body = u'ascii text' request = self.serialize_to_request(input_params={'Blob': body}) self.assert_serialized_blob_equals( request, blob_bytes=body.encode('ascii')) def test_blob_handles_unicode_chars(self): body = u'\u2713' request = self.serialize_to_request(input_params={'Blob': body}) self.assert_serialized_blob_equals( request, blob_bytes=body.encode('utf-8')) class TestBinaryTypesJSON(BaseModelWithBlob): def setUp(self): super(TestBinaryTypesJSON, self).setUp() self.model['metadata'] = { 'protocol': 'json', 'apiVersion': '2014-01-01', 'jsonVersion': '1.1', 'targetPrefix': 'foo', } def test_blob_accepts_bytes_type(self): body = b'bytes body' request = self.serialize_to_request(input_params={'Blob': body}) serialized_blob = json.loads(request['body'].decode('utf-8'))['Blob'] self.assertEqual( base64.b64encode(body).decode('ascii'), serialized_blob) class TestBinaryTypesWithRestXML(BaseModelWithBlob): def setUp(self): super(TestBinaryTypesWithRestXML, self).setUp() self.model['metadata'] = { 'protocol': 'rest-xml', 'apiVersion': '2014-01-01', } self.model['operations']['TestOperation']['input'] = { 'shape': 'InputShape', 'locationName': 'OperationRequest', 'payload': 'Blob', } def test_blob_serialization_with_file_like_object(self): body = six.BytesIO(b'foobar') request = self.serialize_to_request(input_params={'Blob': body}) self.assertEqual(request['body'], body) def test_blob_serialization_when_payload_is_unicode(self): # When the body is a text type, we should encode the # text to bytes. body = u'\u2713' request = self.serialize_to_request(input_params={'Blob': body}) self.assertEqual(request['body'], body.encode('utf-8')) def test_blob_serialization_when_payload_is_bytes(self): body = b'bytes body' request = self.serialize_to_request(input_params={'Blob': body}) self.assertEqual(request['body'], body) class TestTimestampHeadersWithRestXML(unittest.TestCase): def setUp(self): self.model = { 'metadata': {'protocol': 'rest-xml', 'apiVersion': '2014-01-01'}, 'documentation': '', 'operations': { 'TestOperation': { 'name': 'TestOperation', 'http': { 'method': 'POST', 'requestUri': '/', }, 'input': {'shape': 'InputShape'}, } }, 'shapes': { 'InputShape': { 'type': 'structure', 'members': { 'TimestampHeader': { 'shape': 'TimestampType', 'location': 'header', 'locationName': 'x-timestamp' }, } }, 'TimestampType': { 'type': 'timestamp', } } } self.service_model = ServiceModel(self.model) def serialize_to_request(self, input_params): request_serializer = serialize.create_serializer( self.service_model.metadata['protocol']) return request_serializer.serialize_to_request( input_params, self.service_model.operation_model('TestOperation')) def test_accepts_datetime_object(self): request = self.serialize_to_request( {'TimestampHeader': datetime.datetime(2014, 1, 1, 12, 12, 12, tzinfo=dateutil.tz.tzutc())}) self.assertEqual(request['headers']['x-timestamp'], 'Wed, 01 Jan 2014 12:12:12 GMT') def test_accepts_iso_8601_format(self): request = self.serialize_to_request( {'TimestampHeader': '2014-01-01T12:12:12+00:00'}) self.assertEqual(request['headers']['x-timestamp'], 'Wed, 01 Jan 2014 12:12:12 GMT') def test_accepts_iso_8601_format_non_utc(self): request = self.serialize_to_request( {'TimestampHeader': '2014-01-01T07:12:12-05:00'}) self.assertEqual(request['headers']['x-timestamp'], 'Wed, 01 Jan 2014 12:12:12 GMT') def test_accepts_rfc_822_format(self): request = self.serialize_to_request( {'TimestampHeader': 'Wed, 01 Jan 2014 12:12:12 GMT'}) self.assertEqual(request['headers']['x-timestamp'], 'Wed, 01 Jan 2014 12:12:12 GMT') def test_accepts_unix_timestamp_integer(self): request = self.serialize_to_request( {'TimestampHeader': 1388578332}) self.assertEqual(request['headers']['x-timestamp'], 'Wed, 01 Jan 2014 12:12:12 GMT') class TestTimestamps(unittest.TestCase): def setUp(self): self.model = { 'metadata': {'protocol': 'query', 'apiVersion': '2014-01-01'}, 'documentation': '', 'operations': { 'TestOperation': { 'name': 'TestOperation', 'http': { 'method': 'POST', 'requestUri': '/', }, 'input': {'shape': 'InputShape'}, } }, 'shapes': { 'InputShape': { 'type': 'structure', 'members': { 'Timestamp': {'shape': 'TimestampType'}, } }, 'TimestampType': { 'type': 'timestamp', } } } self.service_model = ServiceModel(self.model) def serialize_to_request(self, input_params): request_serializer = serialize.create_serializer( self.service_model.metadata['protocol']) return request_serializer.serialize_to_request( input_params, self.service_model.operation_model('TestOperation')) def test_accepts_datetime_object(self): request = self.serialize_to_request( {'Timestamp': datetime.datetime(2014, 1, 1, 12, 12, 12, tzinfo=dateutil.tz.tzutc())}) self.assertEqual(request['body']['Timestamp'], '2014-01-01T12:12:12Z') def test_accepts_naive_datetime_object(self): request = self.serialize_to_request( {'Timestamp': datetime.datetime(2014, 1, 1, 12, 12, 12)}) self.assertEqual(request['body']['Timestamp'], '2014-01-01T12:12:12Z') def test_accepts_iso_8601_format(self): request = self.serialize_to_request( {'Timestamp': '2014-01-01T12:12:12Z'}) self.assertEqual(request['body']['Timestamp'], '2014-01-01T12:12:12Z') def test_accepts_timestamp_without_tz_info(self): # If a timezone/utc is not specified, assume they meant # UTC. This is also the previous behavior from older versions # of botocore so we want to make sure we preserve this behavior. request = self.serialize_to_request( {'Timestamp': '2014-01-01T12:12:12'}) self.assertEqual(request['body']['Timestamp'], '2014-01-01T12:12:12Z') def test_microsecond_timestamp_without_tz_info(self): request = self.serialize_to_request( {'Timestamp': '2014-01-01T12:12:12.123456'}) self.assertEqual(request['body']['Timestamp'], '2014-01-01T12:12:12.123456Z') class TestJSONTimestampSerialization(unittest.TestCase): def setUp(self): self.model = { 'metadata': {'protocol': 'json', 'apiVersion': '2014-01-01', 'jsonVersion': '1.1', 'targetPrefix': 'foo'}, 'documentation': '', 'operations': { 'TestOperation': { 'name': 'TestOperation', 'http': { 'method': 'POST', 'requestUri': '/', }, 'input': {'shape': 'InputShape'}, } }, 'shapes': { 'InputShape': { 'type': 'structure', 'members': { 'Timestamp': {'shape': 'TimestampType'}, } }, 'TimestampType': { 'type': 'timestamp', } } } self.service_model = ServiceModel(self.model) def serialize_to_request(self, input_params): request_serializer = serialize.create_serializer( self.service_model.metadata['protocol']) return request_serializer.serialize_to_request( input_params, self.service_model.operation_model('TestOperation')) def test_accepts_iso_8601_format(self): body = json.loads(self.serialize_to_request( {'Timestamp': '1970-01-01T00:00:00'})['body'].decode('utf-8')) self.assertEqual(body['Timestamp'], 0) def test_accepts_epoch(self): body = json.loads(self.serialize_to_request( {'Timestamp': '0'})['body'].decode('utf-8')) self.assertEqual(body['Timestamp'], 0) # Can also be an integer 0. body = json.loads(self.serialize_to_request( {'Timestamp': 0})['body'].decode('utf-8')) self.assertEqual(body['Timestamp'], 0) def test_accepts_partial_iso_format(self): body = json.loads(self.serialize_to_request( {'Timestamp': '1970-01-01'})['body'].decode('utf-8')) self.assertEqual(body['Timestamp'], 0) class TestInstanceCreation(unittest.TestCase): def setUp(self): self.model = { 'metadata': {'protocol': 'query', 'apiVersion': '2014-01-01'}, 'documentation': '', 'operations': { 'TestOperation': { 'name': 'TestOperation', 'http': { 'method': 'POST', 'requestUri': '/', }, 'input': {'shape': 'InputShape'}, } }, 'shapes': { 'InputShape': { 'type': 'structure', 'members': { 'Timestamp': {'shape': 'StringTestType'}, } }, 'StringTestType': { 'type': 'string', 'min': 15 } } } self.service_model = ServiceModel(self.model) def assert_serialize_valid_parameter(self, request_serializer): valid_string = 'valid_string_with_min_15_chars' request = request_serializer.serialize_to_request( {'Timestamp': valid_string}, self.service_model.operation_model('TestOperation')) self.assertEqual(request['body']['Timestamp'], valid_string) def assert_serialize_invalid_parameter(self, request_serializer): invalid_string = 'short string' request = request_serializer.serialize_to_request( {'Timestamp': invalid_string}, self.service_model.operation_model('TestOperation')) self.assertEqual(request['body']['Timestamp'], invalid_string) def test_instantiate_without_validation(self): request_serializer = serialize.create_serializer( self.service_model.metadata['protocol'], False) try: self.assert_serialize_valid_parameter(request_serializer) except ParamValidationError as e: self.fail( "Shouldn't fail serializing valid parameter without validation".format(e)) try: self.assert_serialize_invalid_parameter(request_serializer) except ParamValidationError as e: self.fail( "Shouldn't fail serializing invalid parameter without validation".format(e)) def test_instantiate_with_validation(self): request_serializer = serialize.create_serializer( self.service_model.metadata['protocol'], True) try: self.assert_serialize_valid_parameter(request_serializer) except ParamValidationError as e: self.fail( "Shouldn't fail serializing valid parameter with validation".format(e)) with self.assertRaises(ParamValidationError): self.assert_serialize_invalid_parameter(request_serializer) class TestHeaderSerialization(BaseModelWithBlob): def setUp(self): self.model = { 'metadata': {'protocol': 'rest-xml', 'apiVersion': '2014-01-01'}, 'documentation': '', 'operations': { 'TestOperation': { 'name': 'TestOperation', 'http': { 'method': 'POST', 'requestUri': '/', }, 'input': {'shape': 'InputShape'}, } }, 'shapes': { 'InputShape': { 'type': 'structure', 'members': { 'ContentLength': { 'shape': 'Integer', 'location': 'header', 'locationName': 'Content-Length' }, } }, 'Integer': { 'type': 'integer' }, } } self.service_model = ServiceModel(self.model) def test_always_serialized_as_str(self): request = self.serialize_to_request({'ContentLength': 100}) self.assertEqual(request['headers']['Content-Length'], '100') class TestRestXMLUnicodeSerialization(unittest.TestCase): def setUp(self): self.model = { 'metadata': {'protocol': 'rest-xml', 'apiVersion': '2014-01-01'}, 'documentation': '', 'operations': { 'TestOperation': { 'name': 'TestOperation', 'http': { 'method': 'POST', 'requestUri': '/', }, 'input': {'shape': 'InputShape'}, } }, 'shapes': { 'InputShape': { 'type': 'structure', 'members': { 'Foo': { 'shape': 'FooShape', 'locationName': 'Foo' }, }, 'payload': 'Foo' }, 'FooShape': { 'type': 'list', 'member': {'shape': 'StringShape'} }, 'StringShape': { 'type': 'string', } } } self.service_model = ServiceModel(self.model) def serialize_to_request(self, input_params): request_serializer = serialize.create_serializer( self.service_model.metadata['protocol']) return request_serializer.serialize_to_request( input_params, self.service_model.operation_model('TestOperation')) def test_restxml_serializes_unicode(self): params = { 'Foo': [u'\u65e5\u672c\u8a9e\u3067\u304a\uff4b'] } try: self.serialize_to_request(params) except UnicodeEncodeError: self.fail("RestXML serializer failed to serialize unicode text.") botocore-1.5.7/tests/unit/test_translate.py0000666454262600001440000000552113042511306022137 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest from botocore import translate class TestBuildRetryConfig(unittest.TestCase): def setUp(self): self.retry = { "definitions": { "def_name": { "from": {"definition": "file"} } }, "retry": { "__default__": { "max_attempts": 5, "delay": "global_delay", "policies": { "global_one": "global", "override_me": "global", } }, "sts": { "__default__": { "delay": "service_specific_delay", "policies": { "service_one": "service", "override_me": "service", } }, "AssumeRole": { "policies": { "name": "policy", "other": {"$ref": "def_name"} } } } } } def test_inject_retry_config(self): retry = translate.build_retry_config('sts', self.retry['retry'], self.retry['definitions']) self.assertIn('__default__', retry) self.assertEqual( retry['__default__'], { "max_attempts": 5, "delay": "service_specific_delay", "policies": { "global_one": "global", "override_me": "service", "service_one": "service", } } ) # Policies should be merged. operation_config = retry['AssumeRole'] self.assertEqual(operation_config['policies']['name'], 'policy') def test_resolve_reference(self): retry = translate.build_retry_config('sts', self.retry['retry'], self.retry['definitions']) operation_config = retry['AssumeRole'] # And we should resolve references. self.assertEqual(operation_config['policies']['other'], {"from": {"definition": "file"}}) botocore-1.5.7/tests/unit/test_stub.py0000666454262600001440000001623213042511306021120 0ustar pysdk-ciamazon00000000000000# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest import mock from botocore.stub import Stubber from botocore.exceptions import ParamValidationError, StubResponseError from botocore.model import ServiceModel from botocore import hooks class TestStubber(unittest.TestCase): def setUp(self): self.event_emitter = hooks.HierarchicalEmitter() self.client = mock.Mock() self.client.meta.events = self.event_emitter self.client.meta.method_to_api_mapping.get.return_value = 'foo' self.stubber = Stubber(self.client) self.validate_parameters_mock = mock.Mock() self.validate_parameters_patch = mock.patch( 'botocore.stub.validate_parameters', self.validate_parameters_mock) self.validate_parameters_patch.start() def tearDown(self): self.validate_parameters_patch.stop() def emit_get_response_event(self, model=None, request_dict=None, signer=None, context=None): if model is None: model = mock.Mock() model.name = 'foo' handler, response = self.event_emitter.emit_until_response( event_name='before-call.myservice.foo', model=model, params=request_dict, request_signer=signer, context=context) return response def test_stubber_registers_events(self): self.event_emitter = mock.Mock() self.client.meta.events = self.event_emitter self.stubber.activate() # This just ensures that we register at the correct event # and nothing more self.event_emitter.register_first.assert_called_with( 'before-parameter-build.*.*', mock.ANY, unique_id=mock.ANY) self.event_emitter.register.assert_called_with( 'before-call.*.*', mock.ANY, unique_id=mock.ANY) def test_stubber_unregisters_events(self): self.event_emitter = mock.Mock() self.client.meta.events = self.event_emitter self.stubber.activate() self.stubber.deactivate() self.event_emitter.unregister.assert_any_call( 'before-parameter-build.*.*', mock.ANY, unique_id=mock.ANY) self.event_emitter.unregister.assert_any_call( 'before-call.*.*', mock.ANY, unique_id=mock.ANY) def test_context_manager(self): self.event_emitter = mock.Mock() self.client.meta.events = self.event_emitter with self.stubber: # Ensure events are registered in context self.event_emitter.register_first.assert_called_with( 'before-parameter-build.*.*', mock.ANY, unique_id=mock.ANY) self.event_emitter.register.assert_called_with( 'before-call.*.*', mock.ANY, unique_id=mock.ANY) # Ensure events are no longer registered once we leave the context self.event_emitter.unregister.assert_any_call( 'before-parameter-build.*.*', mock.ANY, unique_id=mock.ANY) self.event_emitter.unregister.assert_any_call( 'before-call.*.*', mock.ANY, unique_id=mock.ANY) def test_add_response(self): response = {'foo': 'bar'} self.stubber.add_response('foo', response) with self.assertRaises(AssertionError): self.stubber.assert_no_pending_responses() def test_add_response_fails_when_missing_client_method(self): del self.client.foo with self.assertRaises(ValueError): self.stubber.add_response('foo', {}) def test_validates_service_response(self): self.stubber.add_response('foo', {}) self.assertTrue(self.validate_parameters_mock.called) def test_validate_ignores_response_metadata(self): service_response = {'ResponseMetadata': {'foo': 'bar'}} service_model = ServiceModel({ 'documentation': '', 'operations': { 'foo': { 'name': 'foo', 'input': {'shape': 'StringShape'}, 'output': {'shape': 'StringShape'} } }, 'shapes': { 'StringShape': {'type': 'string'} } }) op_name = service_model.operation_names[0] output_shape = service_model.operation_model(op_name).output_shape self.client.meta.service_model = service_model self.stubber.add_response('TestOperation', service_response) self.validate_parameters_mock.assert_called_with( {}, output_shape) # Make sure service response hasn't been mutated self.assertEqual( service_response, {'ResponseMetadata': {'foo': 'bar'}}) def test_validates_on_empty_output_shape(self): service_model = ServiceModel({ 'documentation': '', 'operations': { 'foo': { 'name': 'foo' } } }) self.client.meta.service_model = service_model with self.assertRaises(ParamValidationError): self.stubber.add_response('TestOperation', {'foo': 'bar'}) def test_get_response(self): service_response = {'bar': 'baz'} self.stubber.add_response('foo', service_response) self.stubber.activate() response = self.emit_get_response_event() self.assertEqual(response[1], service_response) self.assertEqual(response[0].status_code, 200) def test_get_client_error_response(self): error_code = "foo" service_message = "bar" self.stubber.add_client_error('foo', error_code, service_message) self.stubber.activate() response = self.emit_get_response_event() self.assertEqual(response[1]['Error']['Message'], service_message) self.assertEqual(response[1]['Error']['Code'], error_code) def test_get_client_error_with_extra_keys(self): error_code = "foo" error_message = "bar" error_meta = { "Endpoint": "https://foo.bar.baz", } self.stubber.add_client_error( 'foo', error_code, error_message, http_status_code=301, service_error_meta=error_meta) with self.stubber: response = self.emit_get_response_event() error = response[1]['Error'] self.assertIn('Endpoint', error) self.assertEqual(error['Endpoint'], "https://foo.bar.baz") def test_get_response_errors_with_no_stubs(self): self.stubber.activate() with self.assertRaises(StubResponseError): self.emit_get_response_event() def test_assert_no_responses_remaining(self): self.stubber.add_response('foo', {}) with self.assertRaises(AssertionError): self.stubber.assert_no_pending_responses() botocore-1.5.7/tests/unit/test_waiters.py0000666454262600001440000006715213042511306021630 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import os from tests import unittest, BaseEnvVar import mock import botocore from botocore.compat import six from botocore.exceptions import ClientError, WaiterConfigError, WaiterError from botocore.waiter import Waiter, WaiterModel, SingleWaiterConfig from botocore.waiter import create_waiter_with_client from botocore.waiter import NormalizedOperationMethod from botocore.loaders import Loader from botocore.model import ServiceModel class TestWaiterModel(unittest.TestCase): def setUp(self): self.boiler_plate_config = { 'description': 'Waiter description', 'operation': 'HeadBucket', 'delay': 5, 'maxAttempts': 20, } def create_acceptor_function(self, for_config): single_waiter = { 'acceptors': [for_config] } single_waiter.update(self.boiler_plate_config) config = SingleWaiterConfig(single_waiter) return config.acceptors[0].matcher_func def test_waiter_version(self): self.assertEqual(WaiterModel({'version': 2, 'waiters': {}}).version, 2) def test_wont_load_missing_version_in_config(self): # We only load waiter configs if we know for sure that we're # loading version 2 of the format. waiters = { # Missing the 'version' key. 'waiters': {} } with self.assertRaises(WaiterConfigError): WaiterModel(waiters) def test_unsupported_waiter_version(self): waiters = { 'version': 1, 'waiters': {} } with self.assertRaises(WaiterConfigError): WaiterModel(waiters) def test_waiter_names(self): waiters = { 'version': 2, 'waiters': { 'BarWaiter': {}, 'FooWaiter': {}, } } self.assertEqual(WaiterModel(waiters).waiter_names, ['BarWaiter', 'FooWaiter']) def test_get_single_waiter_config(self): single_waiter = { 'description': 'Waiter description', 'operation': 'HeadBucket', 'delay': 5, 'maxAttempts': 20, 'acceptors': [ {'state': 'success', 'matcher': 'status', 'expected': 200}, {'state': 'retry', 'matcher': 'status', 'expected': 404}, ], } waiters = { 'version': 2, 'waiters': { 'BucketExists': single_waiter, } } model = WaiterModel(waiters) config = model.get_waiter('BucketExists') self.assertEqual(config.operation, 'HeadBucket') def test_get_waiter_does_not_exist(self): waiters = { 'version': 2, 'waiters': {} } model = WaiterModel(waiters) with self.assertRaises(ValueError): model.get_waiter('UnknownWaiter') def test_single_waiter_config_attributes(self): single_waiter = { 'description': 'Waiter description', 'operation': 'HeadBucket', 'delay': 5, 'maxAttempts': 20, 'acceptors': [ ], } config = SingleWaiterConfig(single_waiter) self.assertEqual(config.description, 'Waiter description') self.assertEqual(config.operation, 'HeadBucket') self.assertEqual(config.delay, 5) self.assertEqual(config.max_attempts, 20) def test_single_waiter_acceptors_built_with_matcher_func(self): # When the list of acceptors are requested, we actually will transform # them into values that are easier to use. single_waiter = { 'acceptors': [ {'state': 'success', 'matcher': 'status', 'expected': 200}, ], } single_waiter.update(self.boiler_plate_config) config = SingleWaiterConfig(single_waiter) success_acceptor = config.acceptors[0] self.assertEqual(success_acceptor.state, 'success') self.assertEqual(success_acceptor.matcher, 'status') self.assertEqual(success_acceptor.expected, 200) self.assertTrue(callable(success_acceptor.matcher_func)) def test_single_waiter_acceptor_matches_jmespath(self): single_waiter = { 'acceptors': [ {'state': 'success', 'matcher': 'path', 'argument': 'Table.TableStatus', 'expected': 'ACCEPTED'}, ], } single_waiter.update(self.boiler_plate_config) config = SingleWaiterConfig(single_waiter) success_acceptor = config.acceptors[0].matcher_func # success_acceptor is a callable that takes a response dict and returns # True or False. self.assertTrue( success_acceptor({'Table': {'TableStatus': 'ACCEPTED'}})) self.assertFalse( success_acceptor({'Table': {'TableStatus': 'CREATING'}})) def test_single_waiter_supports_status_code(self): single_waiter = { 'acceptors': [ {'state': 'success', 'matcher': 'status', 'expected': 200} ], } single_waiter.update(self.boiler_plate_config) config = SingleWaiterConfig(single_waiter) success_acceptor = config.acceptors[0].matcher_func self.assertTrue( success_acceptor({'ResponseMetadata': {'HTTPStatusCode': 200}})) self.assertFalse( success_acceptor({'ResponseMetadata': {'HTTPStatusCode': 404}})) def test_single_waiter_supports_error(self): single_waiter = { 'acceptors': [ {'state': 'success', 'matcher': 'error', 'expected': 'DoesNotExistError'} ], } single_waiter.update(self.boiler_plate_config) config = SingleWaiterConfig(single_waiter) success_acceptor = config.acceptors[0].matcher_func self.assertTrue( success_acceptor({'Error': {'Code': 'DoesNotExistError'}})) self.assertFalse( success_acceptor({'Error': {'Code': 'DoesNotExistErorr'}})) def test_unknown_matcher(self): unknown_type = 'arbitrary_type' single_waiter = { 'acceptors': [ {'state': 'success', 'matcher': unknown_type, 'expected': 'foo'} ] } single_waiter.update(self.boiler_plate_config) config = SingleWaiterConfig(single_waiter) with self.assertRaises(WaiterConfigError): config.acceptors def test_single_waiter_supports_path_all(self): matches = self.create_acceptor_function( for_config={'state': 'success', 'matcher': 'pathAll', 'argument': 'Tables[].State', 'expected': 'GOOD'}) self.assertTrue( matches({'Tables': [{"State": "GOOD"}]})) self.assertTrue( matches({'Tables': [{"State": "GOOD"}, {"State": "GOOD"}]})) def test_single_waiter_supports_path_any(self): matches = self.create_acceptor_function( for_config={'state': 'failure', 'matcher': 'pathAny', 'argument': 'Tables[].State', 'expected': 'FAIL'}) self.assertTrue( matches({'Tables': [{"State": "FAIL"}]})) self.assertTrue( matches({'Tables': [{"State": "GOOD"}, {"State": "FAIL"}]})) def test_waiter_handles_error_responses_with_path_matchers(self): path_any = self.create_acceptor_function( for_config={'state': 'success', 'matcher': 'pathAny', 'argument': 'length(Tables) > `0`', 'expected': True}) path_all = self.create_acceptor_function( for_config={'state': 'success', 'matcher': 'pathAll', 'argument': 'length(Tables) > `0`', 'expected': True}) path = self.create_acceptor_function( for_config={'state': 'success', 'matcher': 'path', 'argument': 'length(Tables) > `0`', 'expected': True}) self.assertFalse(path_any({'Error': {'Code': 'DoesNotExist'}})) self.assertFalse(path_all({'Error': {'Code': 'DoesNotExist'}})) self.assertFalse(path({'Error': {'Code': 'DoesNotExist'}})) def test_single_waiter_does_not_match_path_all(self): matches = self.create_acceptor_function( for_config={'state': 'success', 'matcher': 'pathAll', 'argument': 'Tables[].State', 'expected': 'GOOD'}) self.assertFalse( matches({'Tables': [{"State": "GOOD"}, {"State": "BAD"}]})) self.assertFalse( matches({'Tables': [{"State": "BAD"}, {"State": "GOOD"}]})) self.assertFalse( matches({'Tables': [{"State": "BAD"}, {"State": "BAD"}]})) self.assertFalse( matches({'Tables': []})) self.assertFalse( matches({'Tables': [{"State": "BAD"}, {"State": "BAD"}, {"State": "BAD"}, {"State": "BAD"}]})) def test_path_all_missing_field(self): matches = self.create_acceptor_function( for_config={'state': 'success', 'matcher': 'pathAll', 'argument': 'Tables[].State', 'expected': 'GOOD'}) self.assertFalse( matches({'Tables': [{"NotState": "GOOD"}, {"NotState": "BAD"}]})) def test_path_all_matcher_does_not_receive_list(self): matches = self.create_acceptor_function( for_config={'state': 'success', 'matcher': 'pathAll', 'argument': 'Tables[].State', 'expected': 'GOOD'}) self.assertFalse( matches({"NotTables": []})) def test_single_waiter_supports_all_three_states(self): single_waiter = { 'acceptors': [ {'state': 'success', 'matcher': 'error', 'expected': 'DoesNotExistError'}, {'state': 'success', 'matcher': 'status', 'expected': 200}, {'state': 'success', 'matcher': 'path', 'argument': 'Foo.Bar', 'expected': 'baz'}, ], } single_waiter.update(self.boiler_plate_config) config = SingleWaiterConfig(single_waiter) acceptors = config.acceptors # Each acceptors should be able to handle not matching # any type of response. matches_nothing = {} self.assertFalse(acceptors[0].matcher_func(matches_nothing)) self.assertFalse(acceptors[1].matcher_func(matches_nothing)) self.assertFalse(acceptors[2].matcher_func(matches_nothing)) class TestWaitersObjects(unittest.TestCase): def setUp(self): pass def client_responses_are(self, *responses, **kwargs): operation_method = kwargs['for_operation'] operation_method.side_effect = responses return operation_method def create_waiter_config(self, operation='MyOperation', delay=0, max_attempts=3, acceptors=None): if acceptors is None: # Create some arbitrary acceptor that will never match. acceptors = [{'state': 'success', 'matcher': 'status', 'expected': 1000}] waiter_config = { 'operation': operation, 'delay': delay, 'maxAttempts': max_attempts, 'acceptors': acceptors } config = SingleWaiterConfig(waiter_config) return config def test_waiter_waits_until_acceptor_matches(self): config = self.create_waiter_config( max_attempts=3, acceptors=[{'state': 'success', 'matcher': 'path', 'argument': 'Foo', 'expected': 'SUCCESS'}]) # Simulate the client having two calls that don't # match followed by a third call that matches the # acceptor. operation_method = mock.Mock() waiter = Waiter('MyWaiter', config, operation_method) self.client_responses_are( {'Foo': 'FAILURE'}, {'Foo': 'FAILURE'}, {'Foo': 'SUCCESS'}, for_operation=operation_method ) waiter.wait() self.assertEqual(operation_method.call_count, 3) def test_waiter_never_matches(self): # Verify that a matcher will fail after max_attempts # is exceeded. config = self.create_waiter_config(max_attempts=3) operation_method = mock.Mock() self.client_responses_are( {'Foo': 'FAILURE'}, {'Foo': 'FAILURE'}, {'Foo': 'FAILURE'}, for_operation=operation_method ) waiter = Waiter('MyWaiter', config, operation_method) with self.assertRaises(WaiterError): waiter.wait() def test_unspecified_errors_stops_waiter(self): # If a waiter receives an error response, then the # waiter immediately stops. config = self.create_waiter_config() operation_method = mock.Mock() self.client_responses_are( # This is an unknown error that's not called out # in any of the waiter config, so when the # waiter encounters this response it will transition # to the failure state. {'Error': {'Code': 'UnknownError', 'Message': 'bad error'}}, for_operation=operation_method ) waiter = Waiter('MyWaiter', config, operation_method) with self.assertRaises(WaiterError): waiter.wait() def test_last_response_available_on_waiter_error(self): last_response = {'Error': {'Code': 'UnknownError', 'Message': 'bad error'}} config = self.create_waiter_config() operation_method = mock.Mock() self.client_responses_are(last_response, for_operation=operation_method) waiter = Waiter('MyWaiter', config, operation_method) with self.assertRaises(WaiterError) as e: waiter.wait() self.assertEqual(e.exception.last_response, last_response) def test_unspecified_errors_propagate_error_code(self): # If a waiter receives an error response, then the # waiter should pass along the error code config = self.create_waiter_config() operation_method = mock.Mock() error_code = 'error_message' error_message = 'error_message' self.client_responses_are( # This is an unknown error that's not called out # in any of the waiter config, so when the # waiter encounters this response it will transition # to the failure state. {'Error': {'Code': error_code, 'Message': error_message}}, for_operation=operation_method ) waiter = Waiter('MyWaiter', config, operation_method) with self.assertRaisesRegexp(WaiterError, error_message): waiter.wait() def test_waiter_transitions_to_failure_state(self): acceptors = [ # A success state that will never be hit. {'state': 'success', 'matcher': 'status', 'expected': 1000}, {'state': 'failure', 'matcher': 'error', 'expected': 'FailError'}, ] config = self.create_waiter_config(acceptors=acceptors) operation_method = mock.Mock() self.client_responses_are( {'Nothing': 'foo'}, # And on the second attempt, a FailError is seen, which # causes the waiter to fail fast. {'Error': {'Code': 'FailError', 'Message': 'foo'}}, {'WillNeverGetCalled': True}, for_operation=operation_method ) waiter = Waiter('MyWaiter', config, operation_method) with self.assertRaises(WaiterError): waiter.wait() # Not only should we raise an exception, but we should have # only called the operation_method twice because the second # response triggered a fast fail. self.assertEqual(operation_method.call_count, 2) def test_waiter_handles_retry_state(self): acceptor_with_retry_state = [ {'state': 'success', 'matcher': 'status', 'expected': 200}, {'state': 'retry', 'matcher': 'error', 'expected': 'RetryMe'}, ] config = self.create_waiter_config( acceptors=acceptor_with_retry_state) operation_method = mock.Mock() self.client_responses_are( {'Nothing': 'foo'}, {'Error': {'Code': 'RetryMe', 'Message': 'foo'}}, {'Success': True, 'ResponseMetadata': {'HTTPStatusCode': 200}}, {'NeverCalled': True}, for_operation=operation_method ) waiter = Waiter('MyWaiter', config, operation_method) waiter.wait() self.assertEqual(operation_method.call_count, 3) def test_waiter_transitions_to_retry_but_max_attempts_exceeded(self): acceptors = [ {'state': 'success', 'matcher': 'status', 'expected': 200}, {'state': 'retry', 'matcher': 'error', 'expected': 'RetryMe'}, ] config = self.create_waiter_config(acceptors=acceptors) operation_method = mock.Mock() self.client_responses_are( {'Success': False}, {'Error': {'Code': 'RetryMe', 'Message': 'foo'}}, {'Success': False}, {'Success': False}, for_operation=operation_method ) waiter = Waiter('MyWaiter', config, operation_method) with self.assertRaises(WaiterError): waiter.wait() def test_kwargs_are_passed_through(self): acceptors = [ {'state': 'success', 'matcher': 'error', 'expected': 'MyError'}, ] config = self.create_waiter_config(acceptors=acceptors) operation_method = mock.Mock() self.client_responses_are( {'Error': {'Code': 'MyError'}}, for_operation=operation_method) waiter = Waiter('MyWaiter', config, operation_method) waiter.wait(Foo='foo', Bar='bar', Baz='baz') operation_method.assert_called_with(Foo='foo', Bar='bar', Baz='baz') @mock.patch('time.sleep') def test_waiter_honors_delay_time_between_retries(self, sleep_mock): delay_time = 5 config = self.create_waiter_config(delay=delay_time) operation_method = mock.Mock() self.client_responses_are( # This is an unknown error that's not called out # in any of the waiter config, so when the # waiter encounters this response it will transition # to the failure state. {'Success': False}, {'Success': False}, {'Success': False}, for_operation=operation_method ) waiter = Waiter('MyWaiter', config, operation_method) with self.assertRaises(WaiterError): waiter.wait() # We attempt three times, which means we need to sleep # twice, once before each subsequent request. self.assertEqual(sleep_mock.call_count, 2) sleep_mock.assert_called_with(delay_time) class TestCreateWaiter(unittest.TestCase): def setUp(self): self.waiter_config = { 'version': 2, 'waiters': { 'WaiterName': { 'operation': 'Foo', 'delay': 1, 'maxAttempts': 1, 'acceptors': [], }, }, } self.waiter_model = WaiterModel(self.waiter_config) self.service_json_model = { 'metadata': { 'serviceFullName': 'Amazon MyService' }, 'operations': { 'Foo': { 'name': 'Foo', 'input': {'shape': 'FooInputOutput'}, 'output': {'shape': 'FooInputOutput'} } }, 'shapes': { 'FooInputOutput': { 'type': 'structure', 'members': { 'bar': { 'shape': 'String', 'documentation': 'Documents bar' } } }, 'String': { 'type': 'string' } } } self.service_model = ServiceModel(self.service_json_model, 'myservice') self.client = mock.Mock() self.client.meta.service_model = self.service_model def test_can_create_waiter_from_client(self): waiter_name = 'WaiterName' waiter = create_waiter_with_client( waiter_name, self.waiter_model, self.client) self.assertIsInstance(waiter, Waiter) def test_waiter_class_name(self): waiter_name = 'WaiterName' waiter = create_waiter_with_client( waiter_name, self.waiter_model, self.client) self.assertEqual( waiter.__class__.__name__, 'MyService.Waiter.WaiterName' ) def test_waiter_help_documentation(self): waiter_name = 'WaiterName' waiter = create_waiter_with_client( waiter_name, self.waiter_model, self.client) with mock.patch('sys.stdout', six.StringIO()) as mock_stdout: help(waiter.wait) content = mock_stdout.getvalue() lines = [ (' Polls :py:meth:`MyService.Client.foo` every 1 ' 'seconds until a successful state is reached. An error ' 'is returned after 1 failed checks.'), ' **Request Syntax** ', ' ::', ' waiter.wait(', " bar='string'", ' )', ' :type bar: string', ' :param bar: Documents bar', ' :returns: None', ] for line in lines: self.assertIn(line, content) class TestOperationMethods(unittest.TestCase): def test_normalized_op_method_makes_call(self): client_method = mock.Mock() op = NormalizedOperationMethod(client_method) op(Foo='a', Bar='b') client_method.assert_called_with(Foo='a', Bar='b') def test_normalized_op_returns_error_response(self): # Client objects normally throw exceptions when an error # occurs, but we need to return the parsed error response. client_method = mock.Mock() op = NormalizedOperationMethod(client_method) parsed_response = { 'Error': {'Code': 'Foo', 'Message': 'bar'} } exception = ClientError(parsed_response, 'OperationName') client_method.side_effect = exception actual_response = op(Foo='a', Bar='b') self.assertEqual(actual_response, parsed_response) class ServiceWaiterFunctionalTest(BaseEnvVar): """ This class is used as a base class if you want to functionally test the waiters for a specific service. """ def setUp(self): super(ServiceWaiterFunctionalTest, self).setUp() self.data_path = os.path.join( os.path.dirname(botocore.__file__), 'data') self.environ['AWS_DATA_PATH'] = self.data_path self.loader = Loader([self.data_path]) def get_waiter_model(self, service, api_version=None): """Get the waiter model for the service.""" with mock.patch('botocore.loaders.Loader.list_available_services', return_value=[service]): return WaiterModel(self.loader.load_service_model( service, type_name='waiters-2', api_version=api_version)) def get_service_model(self, service, api_version=None): """Get the service model for the service.""" with mock.patch('botocore.loaders.Loader.list_available_services', return_value=[service]): return ServiceModel( self.loader.load_service_model( service, type_name='service-2', api_version=api_version), service_name=service ) class CloudFrontWaitersTest(ServiceWaiterFunctionalTest): def setUp(self): super(CloudFrontWaitersTest, self).setUp() self.client = mock.Mock() self.service = 'cloudfront' self.old_api_versions = ['2014-05-31'] def assert_distribution_deployed_call_count(self, api_version=None): waiter_name = 'DistributionDeployed' waiter_model = self.get_waiter_model(self.service, api_version) self.client.meta.service_model = self.get_service_model( self.service, api_version) self.client.get_distribution.side_effect = [ {'Distribution': {'Status': 'Deployed'}} ] waiter = create_waiter_with_client(waiter_name, waiter_model, self.client) waiter.wait() self.assertEqual(self.client.get_distribution.call_count, 1) def assert_invalidation_completed_call_count(self, api_version=None): waiter_name = 'InvalidationCompleted' waiter_model = self.get_waiter_model(self.service, api_version) self.client.meta.service_model = self.get_service_model( self.service, api_version) self.client.get_invalidation.side_effect = [ {'Invalidation': {'Status': 'Completed'}} ] waiter = create_waiter_with_client(waiter_name, waiter_model, self.client) waiter.wait() self.assertEqual(self.client.get_invalidation.call_count, 1) def assert_streaming_distribution_deployed_call_count( self, api_version=None): waiter_name = 'StreamingDistributionDeployed' waiter_model = self.get_waiter_model(self.service, api_version) self.client.meta.service_model = self.get_service_model( self.service, api_version) self.client.get_streaming_distribution.side_effect = [ {'StreamingDistribution': {'Status': 'Deployed'}} ] waiter = create_waiter_with_client(waiter_name, waiter_model, self.client) waiter.wait() self.assertEqual(self.client.get_streaming_distribution.call_count, 1) def test_distribution_deployed(self): # Test the latest version. self.assert_distribution_deployed_call_count() self.client.reset_mock() # Test previous api versions. for api_version in self.old_api_versions: self.assert_distribution_deployed_call_count(api_version) self.client.reset_mock() def test_invalidation_completed(self): # Test the latest version. self.assert_invalidation_completed_call_count() self.client.reset_mock() # Test previous api versions. for api_version in self.old_api_versions: self.assert_invalidation_completed_call_count(api_version) self.client.reset_mock() def test_streaming_distribution_deployed(self): # Test the latest version. self.assert_streaming_distribution_deployed_call_count() self.client.reset_mock() # Test previous api versions. for api_version in self.old_api_versions: self.assert_streaming_distribution_deployed_call_count(api_version) self.client.reset_mock() botocore-1.5.7/tests/unit/test_signers.py0000666454262600001440000010255413042511306021620 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import mock import datetime import json import botocore import botocore.auth from botocore.compat import six, urlparse, parse_qs from botocore.credentials import Credentials from botocore.credentials import ReadOnlyCredentials from botocore.exceptions import NoRegionError, UnknownSignatureVersionError from botocore.exceptions import UnknownClientMethodError, ParamValidationError from botocore.exceptions import UnsupportedSignatureVersionError from botocore.signers import RequestSigner, S3PostPresigner, CloudFrontSigner from botocore.config import Config from tests import unittest class BaseSignerTest(unittest.TestCase): def setUp(self): self.credentials = Credentials('key', 'secret') self.emitter = mock.Mock() self.emitter.emit_until_response.return_value = (None, None) self.signer = RequestSigner( 'service_name', 'region_name', 'signing_name', 'v4', self.credentials, self.emitter) self.fixed_credentials = self.credentials.get_frozen_credentials() class TestSigner(BaseSignerTest): def test_region_name(self): self.assertEqual(self.signer.region_name, 'region_name') def test_signature_version(self): self.assertEqual(self.signer.signature_version, 'v4') def test_signing_name(self): self.assertEqual(self.signer.signing_name, 'signing_name') def test_region_required_for_sigv4(self): self.signer = RequestSigner( 'service_name', None, 'signing_name', 'v4', self.credentials, self.emitter) with self.assertRaises(NoRegionError): self.signer.sign('operation_name', mock.Mock()) def test_get_auth(self): auth_cls = mock.Mock() with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'v4': auth_cls}): auth = self.signer.get_auth('service_name', 'region_name') self.assertEqual(auth, auth_cls.return_value) auth_cls.assert_called_with( credentials=self.fixed_credentials, service_name='service_name', region_name='region_name') def test_get_auth_signature_override(self): auth_cls = mock.Mock() with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'v4-custom': auth_cls}): auth = self.signer.get_auth( 'service_name', 'region_name', signature_version='v4-custom') self.assertEqual(auth, auth_cls.return_value) auth_cls.assert_called_with( credentials=self.fixed_credentials, service_name='service_name', region_name='region_name') def test_get_auth_bad_override(self): with self.assertRaises(UnknownSignatureVersionError): self.signer.get_auth('service_name', 'region_name', signature_version='bad') def test_emits_choose_signer(self): request = mock.Mock() with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'v4': mock.Mock()}): self.signer.sign('operation_name', request) self.emitter.emit_until_response.assert_called_with( 'choose-signer.service_name.operation_name', signing_name='signing_name', region_name='region_name', signature_version='v4') def test_choose_signer_override(self): request = mock.Mock() auth = mock.Mock() auth.REQUIRES_REGION = False self.emitter.emit_until_response.return_value = (None, 'custom') with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'custom': auth}): self.signer.sign('operation_name', request) auth.assert_called_with(credentials=self.fixed_credentials) auth.return_value.add_auth.assert_called_with(request) def test_emits_before_sign(self): request = mock.Mock() with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'v4': mock.Mock()}): self.signer.sign('operation_name', request) self.emitter.emit.assert_called_with( 'before-sign.service_name.operation_name', request=mock.ANY, signing_name='signing_name', region_name='region_name', signature_version='v4', request_signer=self.signer) def test_disable_signing(self): # Returning botocore.UNSIGNED from choose-signer disables signing! request = mock.Mock() auth = mock.Mock() self.emitter.emit_until_response.return_value = (None, botocore.UNSIGNED) with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'v4': auth}): self.signer.sign('operation_name', request) auth.assert_not_called() def test_generate_url_emits_choose_signer(self): request_dict = { 'headers': {}, 'url': 'https://foo.com', 'body': b'', 'url_path': '/', 'method': 'GET', 'context': {} } with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'v4': mock.Mock()}): self.signer.generate_presigned_url(request_dict, 'operation_name') self.emitter.emit_until_response.assert_called_with( 'choose-signer.service_name.operation_name', signing_name='signing_name', region_name='region_name', signature_version='v4-query') def test_generate_url_choose_signer_override(self): request_dict = { 'headers': {}, 'url': 'https://foo.com', 'body': b'', 'url_path': '/', 'method': 'GET', 'context': {} } auth = mock.Mock() auth.REQUIRES_REGION = False self.emitter.emit_until_response.return_value = (None, 'custom') auth_types_map = {'custom': mock.Mock(), 'custom-query': auth} with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, auth_types_map): self.signer.generate_presigned_url(request_dict, 'operation_name') auth.assert_called_with(credentials=self.fixed_credentials, expires=3600) def test_generate_url_unsigned(self): request_dict = { 'headers': {}, 'url': 'https://foo.com', 'body': b'', 'url_path': '/', 'method': 'GET', 'context': {} } self.emitter.emit_until_response.return_value = ( None, botocore.UNSIGNED) url = self.signer.generate_presigned_url( request_dict, 'operation_name') self.assertEqual(url, 'https://foo.com') def test_generate_presigned_url(self): auth = mock.Mock() auth.REQUIRES_REGION = True request_dict = { 'headers': {}, 'url': 'https://foo.com', 'body': b'', 'url_path': '/', 'method': 'GET', 'context': {} } with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'v4-query': auth}): presigned_url = self.signer.generate_presigned_url( request_dict, operation_name='operation_name') auth.assert_called_with( credentials=self.fixed_credentials, region_name='region_name', service_name='signing_name', expires=3600) self.assertEqual(presigned_url, 'https://foo.com') def test_generate_presigned_url_with_region_override(self): auth = mock.Mock() auth.REQUIRES_REGION = True request_dict = { 'headers': {}, 'url': 'https://foo.com', 'body': b'', 'url_path': '/', 'method': 'GET', 'context': {} } with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'v4-query': auth}): presigned_url = self.signer.generate_presigned_url( request_dict, operation_name='operation_name', region_name='us-west-2') auth.assert_called_with( credentials=self.fixed_credentials, region_name='us-west-2', service_name='signing_name', expires=3600) self.assertEqual(presigned_url, 'https://foo.com') def test_generate_presigned_url_with_exipres_in(self): auth = mock.Mock() auth.REQUIRES_REGION = True request_dict = { 'headers': {}, 'url': 'https://foo.com', 'body': b'', 'url_path': '/', 'method': 'GET', 'context': {} } with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'v4-query': auth}): presigned_url = self.signer.generate_presigned_url( request_dict, operation_name='operation_name', expires_in=900) auth.assert_called_with( credentials=self.fixed_credentials, region_name='region_name', expires=900, service_name='signing_name') self.assertEqual(presigned_url, 'https://foo.com') def test_presigned_url_throws_unsupported_signature_error(self): request_dict = { 'headers': {}, 'url': 'https://s3.amazonaws.com/mybucket/myobject', 'body': b'', 'url_path': '/', 'method': 'GET', 'context': {} } self.signer = RequestSigner( 'service_name', 'region_name', 'signing_name', 'foo', self.credentials, self.emitter) with self.assertRaises(UnsupportedSignatureVersionError): self.signer.generate_presigned_url( request_dict, operation_name='foo') def test_signer_with_refreshable_credentials_gets_credential_set(self): class FakeCredentials(Credentials): def get_frozen_credentials(self): return ReadOnlyCredentials('foo', 'bar', 'baz') self.credentials = FakeCredentials('a', 'b', 'c') self.signer = RequestSigner( 'service_name', 'region_name', 'signing_name', 'v4', self.credentials, self.emitter) auth_cls = mock.Mock() with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'v4': auth_cls}): auth = self.signer.get_auth('service_name', 'region_name') self.assertEqual(auth, auth_cls.return_value) # Note we're called with 'foo', 'bar', 'baz', and *not* # 'a', 'b', 'c'. auth_cls.assert_called_with( credentials=ReadOnlyCredentials('foo', 'bar', 'baz'), service_name='service_name', region_name='region_name') def test_no_credentials_case_is_forwarded_to_signer(self): # If no credentials are given to the RequestSigner, we should # forward that fact on to the Auth class and let them handle # the error (which they already do). self.credentials = None self.signer = RequestSigner( 'service_name', 'region_name', 'signing_name', 'v4', self.credentials, self.emitter) auth_cls = mock.Mock() with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'v4': auth_cls}): auth = self.signer.get_auth_instance( 'service_name', 'region_name', 'v4') auth_cls.assert_called_with( service_name='service_name', region_name='region_name', credentials=None, ) def test_sign_with_signing_type_standard(self): auth = mock.Mock() post_auth = mock.Mock() query_auth = mock.Mock() request = mock.Mock() auth_types = { 'v4-presign-post': post_auth, 'v4-query': query_auth, 'v4': auth } with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, auth_types): self.signer.sign('operation_name', request, signing_type='standard') self.assertFalse(post_auth.called) self.assertFalse(query_auth.called) auth.assert_called_with( credentials=ReadOnlyCredentials('key', 'secret', None), service_name='signing_name', region_name='region_name' ) def test_sign_with_signing_type_presign_url(self): auth = mock.Mock() post_auth = mock.Mock() query_auth = mock.Mock() request = mock.Mock() auth_types = { 'v4-presign-post': post_auth, 'v4-query': query_auth, 'v4': auth } with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, auth_types): self.signer.sign('operation_name', request, signing_type='presign-url') self.assertFalse(post_auth.called) self.assertFalse(auth.called) query_auth.assert_called_with( credentials=ReadOnlyCredentials('key', 'secret', None), service_name='signing_name', region_name='region_name' ) def test_sign_with_signing_type_presign_post(self): auth = mock.Mock() post_auth = mock.Mock() query_auth = mock.Mock() request = mock.Mock() auth_types = { 'v4-presign-post': post_auth, 'v4-query': query_auth, 'v4': auth } with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, auth_types): self.signer.sign('operation_name', request, signing_type='presign-post') self.assertFalse(auth.called) self.assertFalse(query_auth.called) post_auth.assert_called_with( credentials=ReadOnlyCredentials('key', 'secret', None), service_name='signing_name', region_name='region_name' ) def test_sign_with_region_name(self): request = mock.Mock() auth = mock.Mock() auth_types = { 'v4': auth } with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, auth_types): self.signer.sign('operation_name', request, region_name='foo') auth.assert_called_with( credentials=ReadOnlyCredentials('key', 'secret', None), service_name='signing_name', region_name='foo' ) def test_sign_with_expires_in(self): request = mock.Mock() auth = mock.Mock() auth_types = { 'v4': auth } with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, auth_types): self.signer.sign('operation_name', request, expires_in=2) auth.assert_called_with( credentials=ReadOnlyCredentials('key', 'secret', None), service_name='signing_name', region_name='region_name', expires=2 ) def test_unknown_signer_raises_unknown_on_standard(self): request = mock.Mock() auth = mock.Mock() auth_types = { 'v4': auth } self.emitter.emit_until_response.return_value = (None, 'custom') with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, auth_types): with self.assertRaises(UnknownSignatureVersionError): self.signer.sign('operation_name', request, signing_type='standard') def test_unknown_signer_raises_unsupported_when_not_standard(self): request = mock.Mock() auth = mock.Mock() auth_types = { 'v4': auth } self.emitter.emit_until_response.return_value = (None, 'custom') with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, auth_types): with self.assertRaises(UnsupportedSignatureVersionError): self.signer.sign('operation_name', request, signing_type='presign-url') with self.assertRaises(UnsupportedSignatureVersionError): self.signer.sign('operation_name', request, signing_type='presign-post') class TestCloudfrontSigner(unittest.TestCase): def setUp(self): self.signer = CloudFrontSigner("MY_KEY_ID", lambda message: b'signed') # It helps but the long string diff will still be slightly different on # Python 2.6/2.7/3.x. We won't soly rely on that anyway, so it's fine. self.maxDiff = None def test_build_canned_policy(self): policy = self.signer.build_policy('foo', datetime.datetime(2016, 1, 1)) expected = ( '{"Statement":[{"Resource":"foo",' '"Condition":{"DateLessThan":{"AWS:EpochTime":1451606400}}}]}') self.assertEqual(json.loads(policy), json.loads(expected)) self.assertEqual(policy, expected) # This is to ensure the right order def test_build_custom_policy(self): policy = self.signer.build_policy( 'foo', datetime.datetime(2016, 1, 1), date_greater_than=datetime.datetime(2015, 12, 1), ip_address='12.34.56.78/9') expected = { "Statement": [{ "Resource": "foo", "Condition": { "DateGreaterThan": {"AWS:EpochTime": 1448928000}, "DateLessThan": {"AWS:EpochTime": 1451606400}, "IpAddress": {"AWS:SourceIp": "12.34.56.78/9"} }, }] } self.assertEqual(json.loads(policy), expected) def _urlparse(self, url): if isinstance(url, six.binary_type): # Not really necessary, but it helps to reduce noise on Python 2.x url = url.decode('utf8') return dict(urlparse(url)._asdict()) # Needs an unordered dict here def assertEqualUrl(self, url1, url2): # We compare long urls by their dictionary parts parts1 = self._urlparse(url1) parts2 = self._urlparse(url2) self.assertEqual( parse_qs(parts1.pop('query')), parse_qs(parts2.pop('query'))) self.assertEqual(parts1, parts2) def test_generate_presign_url_with_expire_time(self): signed_url = self.signer.generate_presigned_url( 'http://test.com/foo.txt', date_less_than=datetime.datetime(2016, 1, 1)) expected = ( 'http://test.com/foo.txt?Expires=1451606400&Signature=c2lnbmVk' '&Key-Pair-Id=MY_KEY_ID') self.assertEqualUrl(signed_url, expected) def test_generate_presign_url_with_custom_policy(self): policy = self.signer.build_policy( 'foo', datetime.datetime(2016, 1, 1), date_greater_than=datetime.datetime(2015, 12, 1), ip_address='12.34.56.78/9') signed_url = self.signer.generate_presigned_url( 'http://test.com/index.html?foo=bar', policy=policy) expected = ( 'http://test.com/index.html?foo=bar' '&Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiZm9vIiwiQ29uZ' 'Gl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIj' 'oxNDUxNjA2NDAwfSwiSXBBZGRyZXNzIjp7IkFXUzpTb3VyY2VJcCI' '6IjEyLjM0LjU2Ljc4LzkifSwiRGF0ZUdyZWF0ZXJUaGFuIjp7IkFX' 'UzpFcG9jaFRpbWUiOjE0NDg5MjgwMDB9fX1dfQ__' '&Signature=c2lnbmVk&Key-Pair-Id=MY_KEY_ID') self.assertEqualUrl(signed_url, expected) class TestS3PostPresigner(BaseSignerTest): def setUp(self): super(TestS3PostPresigner, self).setUp() self.request_signer = RequestSigner( 'service_name', 'region_name', 'signing_name', 's3v4', self.credentials, self.emitter) self.signer = S3PostPresigner(self.request_signer) self.request_dict = { 'headers': {}, 'url': 'https://s3.amazonaws.com/mybucket', 'body': b'', 'url_path': '/', 'method': 'POST', 'context': {} } self.auth = mock.Mock() self.auth.REQUIRES_REGION = True self.add_auth = mock.Mock() self.auth.return_value.add_auth = self.add_auth self.fixed_credentials = self.credentials.get_frozen_credentials() self.datetime_patch = mock.patch('botocore.signers.datetime') self.datetime_mock = self.datetime_patch.start() self.fixed_date = datetime.datetime(2014, 3, 10, 17, 2, 55, 0) self.fixed_delta = datetime.timedelta(seconds=3600) self.datetime_mock.datetime.utcnow.return_value = self.fixed_date self.datetime_mock.timedelta.return_value = self.fixed_delta def tearDown(self): super(TestS3PostPresigner, self).tearDown() self.datetime_patch.stop() def test_generate_presigned_post(self): with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'s3v4-presign-post': self.auth}): post_form_args = self.signer.generate_presigned_post( self.request_dict) self.auth.assert_called_with( credentials=self.fixed_credentials, region_name='region_name', service_name='signing_name') self.assertEqual(self.add_auth.call_count, 1) ref_request = self.add_auth.call_args[0][0] ref_policy = ref_request.context['s3-presign-post-policy'] self.assertEqual(ref_policy['expiration'], '2014-03-10T18:02:55Z') self.assertEqual(ref_policy['conditions'], []) self.assertEqual(post_form_args['url'], 'https://s3.amazonaws.com/mybucket') self.assertEqual(post_form_args['fields'], {}) def test_generate_presigned_post_emits_choose_signer(self): with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'s3v4-presign-post': self.auth}): self.signer.generate_presigned_post(self.request_dict) self.emitter.emit_until_response.assert_called_with( 'choose-signer.service_name.PutObject', signing_name='signing_name', region_name='region_name', signature_version='s3v4-presign-post') def test_generate_presigned_post_choose_signer_override(self): auth = mock.Mock() self.emitter.emit_until_response.return_value = (None, 'custom') auth_types = { 's3v4-presign-post': self.auth, 'custom-presign-post': auth } with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, auth_types): self.signer.generate_presigned_post(self.request_dict) auth.assert_called_with( credentials=self.fixed_credentials, region_name='region_name', service_name='signing_name') def test_generate_presigne_post_choose_signer_override_known(self): auth = mock.Mock() self.emitter.emit_until_response.return_value = ( None, 's3v4-presign-post') auth_types = { 's3v4-presign-post': self.auth, 'custom-presign-post': auth } with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, auth_types): self.signer.generate_presigned_post(self.request_dict) self.auth.assert_called_with( credentials=self.fixed_credentials, region_name='region_name', service_name='signing_name') def test_generate_presigned_post_bad_signer_raises_error(self): auth = mock.Mock() self.emitter.emit_until_response.return_value = (None, 's3-query') auth_types = { 's3v4-presign-post': self.auth, 's3-query': auth } with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, auth_types): with self.assertRaises(UnsupportedSignatureVersionError): self.signer.generate_presigned_post(self.request_dict) def test_generate_unsigned_post(self): self.emitter.emit_until_response.return_value = ( None, botocore.UNSIGNED) with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'s3v4-presign-post': self.auth}): post_form_args = self.signer.generate_presigned_post( self.request_dict) expected = {'fields': {}, 'url': 'https://s3.amazonaws.com/mybucket'} self.assertEqual(post_form_args, expected) def test_generate_presigned_post_with_conditions(self): conditions = [ {'bucket': 'mybucket'}, ['starts-with', '$key', 'bar'] ] with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'s3v4-presign-post': self.auth}): self.signer.generate_presigned_post( self.request_dict, conditions=conditions) self.auth.assert_called_with( credentials=self.fixed_credentials, region_name='region_name', service_name='signing_name') self.assertEqual(self.add_auth.call_count, 1) ref_request = self.add_auth.call_args[0][0] ref_policy = ref_request.context['s3-presign-post-policy'] self.assertEqual(ref_policy['conditions'], conditions) def test_generate_presigned_post_with_region_override(self): with mock.patch.dict(botocore.auth.AUTH_TYPE_MAPS, {'s3v4-presign-post': self.auth}): self.signer.generate_presigned_post( self.request_dict, region_name='foo') self.auth.assert_called_with( credentials=self.fixed_credentials, region_name='foo', service_name='signing_name') def test_presigned_post_throws_unsupported_signature_error(self): request_dict = { 'headers': {}, 'url': 'https://s3.amazonaws.com/mybucket/myobject', 'body': b'', 'url_path': '/', 'method': 'POST', 'context': {} } self.request_signer = RequestSigner( 'service_name', 'region_name', 'signing_name', 'foo', self.credentials, self.emitter) self.signer = S3PostPresigner(self.request_signer) with self.assertRaises(UnsupportedSignatureVersionError): self.signer.generate_presigned_post(request_dict) class TestGenerateUrl(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() self.client = self.session.create_client('s3', region_name='us-east-1') self.bucket = 'mybucket' self.key = 'mykey' self.client_kwargs = {'Bucket': self.bucket, 'Key': self.key} self.generate_url_patch = mock.patch( 'botocore.signers.RequestSigner.generate_presigned_url') self.generate_url_mock = self.generate_url_patch.start() def tearDown(self): self.generate_url_patch.stop() def test_generate_presigned_url(self): self.client.generate_presigned_url( 'get_object', Params={'Bucket': self.bucket, 'Key': self.key}) ref_request_dict = { 'body': b'', 'url': u'https://s3.amazonaws.com/mybucket/mykey', 'headers': {}, 'query_string': {}, 'url_path': u'/mybucket/mykey', 'method': u'GET', 'context': {}} self.generate_url_mock.assert_called_with( request_dict=ref_request_dict, expires_in=3600, operation_name='GetObject') def test_generate_presigned_url_with_query_string(self): disposition = 'attachment; filename="download.jpg"' self.client.generate_presigned_url( 'get_object', Params={ 'Bucket': self.bucket, 'Key': self.key, 'ResponseContentDisposition': disposition}) ref_request_dict = { 'body': b'', 'url': (u'https://s3.amazonaws.com/mybucket/mykey' '?response-content-disposition=' 'attachment%3B%20filename%3D%22download.jpg%22'), 'headers': {}, 'query_string': {u'response-content-disposition': disposition}, 'url_path': u'/mybucket/mykey', 'method': u'GET', 'context': {}} self.generate_url_mock.assert_called_with( request_dict=ref_request_dict, expires_in=3600, operation_name='GetObject') def test_generate_presigned_url_unknown_method_name(self): with self.assertRaises(UnknownClientMethodError): self.client.generate_presigned_url('getobject') def test_generate_presigned_url_missing_required_params(self): with self.assertRaises(ParamValidationError): self.client.generate_presigned_url('get_object') def test_generate_presigned_url_expires(self): self.client.generate_presigned_url( 'get_object', Params={'Bucket': self.bucket, 'Key': self.key}, ExpiresIn=20) ref_request_dict = { 'body': b'', 'url': u'https://s3.amazonaws.com/mybucket/mykey', 'headers': {}, 'query_string': {}, 'url_path': u'/mybucket/mykey', 'method': u'GET', 'context': {}} self.generate_url_mock.assert_called_with( request_dict=ref_request_dict, expires_in=20, operation_name='GetObject') def test_generate_presigned_url_override_http_method(self): self.client.generate_presigned_url( 'get_object', Params={'Bucket': self.bucket, 'Key': self.key}, HttpMethod='PUT') ref_request_dict = { 'body': b'', 'url': u'https://s3.amazonaws.com/mybucket/mykey', 'headers': {}, 'query_string': {}, 'url_path': u'/mybucket/mykey', 'method': u'PUT', 'context': {}} self.generate_url_mock.assert_called_with( request_dict=ref_request_dict, expires_in=3600, operation_name='GetObject') class TestGeneratePresignedPost(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() self.client = self.session.create_client('s3', region_name='us-east-1') self.bucket = 'mybucket' self.key = 'mykey' self.presign_post_patch = mock.patch( 'botocore.signers.S3PostPresigner.generate_presigned_post') self.presign_post_mock = self.presign_post_patch.start() def tearDown(self): self.presign_post_patch.stop() def test_generate_presigned_post(self): self.client.generate_presigned_post(self.bucket, self.key) _, post_kwargs = self.presign_post_mock.call_args request_dict = post_kwargs['request_dict'] fields = post_kwargs['fields'] conditions = post_kwargs['conditions'] self.assertEqual( request_dict['url'], 'https://s3.amazonaws.com/mybucket') self.assertEqual(post_kwargs['expires_in'], 3600) self.assertEqual( conditions, [{'bucket': 'mybucket'}, {'key': 'mykey'}]) self.assertEqual( fields, {'key': 'mykey'}) def test_generate_presigned_post_with_filename(self): self.key = 'myprefix/${filename}' self.client.generate_presigned_post(self.bucket, self.key) _, post_kwargs = self.presign_post_mock.call_args request_dict = post_kwargs['request_dict'] fields = post_kwargs['fields'] conditions = post_kwargs['conditions'] self.assertEqual( request_dict['url'], 'https://s3.amazonaws.com/mybucket') self.assertEqual(post_kwargs['expires_in'], 3600) self.assertEqual( conditions, [{'bucket': 'mybucket'}, ['starts-with', '$key', 'myprefix/']]) self.assertEqual( fields, {'key': 'myprefix/${filename}'}) def test_generate_presigned_post_expires(self): self.client.generate_presigned_post( self.bucket, self.key, ExpiresIn=50) _, post_kwargs = self.presign_post_mock.call_args request_dict = post_kwargs['request_dict'] fields = post_kwargs['fields'] conditions = post_kwargs['conditions'] self.assertEqual( request_dict['url'], 'https://s3.amazonaws.com/mybucket') self.assertEqual(post_kwargs['expires_in'], 50) self.assertEqual( conditions, [{'bucket': 'mybucket'}, {'key': 'mykey'}]) self.assertEqual( fields, {'key': 'mykey'}) def test_generate_presigned_post_with_prefilled(self): conditions = [{'acl': 'public-read'}] fields = {'acl': 'public-read'} self.client.generate_presigned_post( self.bucket, self.key, Fields=fields, Conditions=conditions) _, post_kwargs = self.presign_post_mock.call_args request_dict = post_kwargs['request_dict'] fields = post_kwargs['fields'] conditions = post_kwargs['conditions'] self.assertEqual( request_dict['url'], 'https://s3.amazonaws.com/mybucket') self.assertEqual( conditions, [{'acl': 'public-read'}, {'bucket': 'mybucket'}, {'key': 'mykey'}]) self.assertEqual(fields['acl'], 'public-read') self.assertEqual( fields, {'key': 'mykey', 'acl': 'public-read'}) def test_generate_presigned_post_non_s3_client(self): self.client = self.session.create_client('ec2', 'us-west-2') with self.assertRaises(AttributeError): self.client.generate_presigned_post() botocore-1.5.7/tests/unit/protocols/0000777454262600001440000000000013042511307020553 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/protocols/input/0000777454262600001440000000000013042511310021704 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/protocols/input/json.json0000666454262600001440000002560513042511306023565 0ustar pysdk-ciamazon00000000000000[ { "description": "Scalar members", "metadata": { "protocol": "json", "jsonVersion": "1.1", "targetPrefix": "com.amazonaws.foo" }, "shapes": { "InputShape": { "type": "structure", "members": { "Name": { "shape": "StringType" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName", "http": { "method": "POST" } }, "params": { "Name": "myname" }, "serialized": { "body": "{\"Name\": \"myname\"}", "headers": { "X-Amz-Target": "com.amazonaws.foo.OperationName", "Content-Type": "application/x-amz-json-1.1" }, "uri": "/" } } ] }, { "description": "Timestamp values", "metadata": { "protocol": "json", "jsonVersion": "1.1", "targetPrefix": "com.amazonaws.foo" }, "shapes": { "InputShape": { "type": "structure", "members": { "TimeArg": { "shape": "TimestampType" } } }, "TimestampType": { "type": "timestamp" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "TimeArg": 1422172800 }, "serialized": { "body": "{\"TimeArg\": 1422172800}", "headers": { "X-Amz-Target": "com.amazonaws.foo.OperationName", "Content-Type": "application/x-amz-json-1.1" }, "uri": "/" } } ] }, { "description": "Base64 encoded Blobs", "metadata": { "protocol": "json", "jsonVersion": "1.1", "targetPrefix": "com.amazonaws.foo" }, "shapes": { "InputShape": { "type": "structure", "members": { "BlobArg": { "shape": "BlobType" }, "BlobMap": { "shape": "BlobMapType" } } }, "BlobType": { "type": "blob" }, "BlobMapType": { "type": "map", "key": {"shape": "StringType"}, "value": {"shape": "BlobType"} }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "BlobArg": "foo" }, "serialized": { "body": "{\"BlobArg\": \"Zm9v\"}", "headers": { "X-Amz-Target": "com.amazonaws.foo.OperationName", "Content-Type": "application/x-amz-json-1.1" }, "uri": "/" } }, { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "BlobMap": { "key1": "foo", "key2": "bar" } }, "serialized": { "body": "{\"BlobMap\": {\"key1\": \"Zm9v\", \"key2\": \"YmFy\"}}", "headers": { "X-Amz-Target": "com.amazonaws.foo.OperationName", "Content-Type": "application/x-amz-json-1.1" }, "uri": "/" } } ] }, { "description": "Nested blobs", "metadata": { "protocol": "json", "jsonVersion": "1.1", "targetPrefix": "com.amazonaws.foo" }, "shapes": { "InputShape": { "type": "structure", "members": { "ListParam": { "shape": "ListOfStructures" } } }, "ListOfStructures": { "type": "list", "member": { "shape": "BlobType" } }, "BlobType": { "type": "blob" } }, "cases": [ { "given": { "http": { "method": "POST" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "ListParam": ["foo", "bar"] }, "serialized": { "body": "{\"ListParam\": [\"Zm9v\", \"YmFy\"]}", "uri": "/", "headers": {"X-Amz-Target": "com.amazonaws.foo.OperationName", "Content-Type": "application/x-amz-json-1.1"} } } ] }, { "description": "Recursive shapes", "metadata": { "protocol": "json", "jsonVersion": "1.1", "targetPrefix": "com.amazonaws.foo" }, "shapes": { "InputShape": { "type": "structure", "members": { "RecursiveStruct": { "shape": "RecursiveStructType" } } }, "RecursiveStructType": { "type": "structure", "members": { "NoRecurse": { "shape": "StringType" }, "RecursiveStruct": { "shape": "RecursiveStructType" }, "RecursiveList": { "shape": "RecursiveListType" }, "RecursiveMap": { "shape": "RecursiveMapType" } } }, "RecursiveListType": { "type": "list", "member": { "shape": "RecursiveStructType" } }, "RecursiveMapType": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "RecursiveStructType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "NoRecurse": "foo" } }, "serialized": { "uri": "/", "headers": { "X-Amz-Target": "com.amazonaws.foo.OperationName", "Content-Type": "application/x-amz-json-1.1" }, "body": "{\"RecursiveStruct\": {\"NoRecurse\": \"foo\"}}" } }, { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveStruct": { "NoRecurse": "foo" } } }, "serialized": { "uri": "/", "headers": { "X-Amz-Target": "com.amazonaws.foo.OperationName", "Content-Type": "application/x-amz-json-1.1" }, "body": "{\"RecursiveStruct\": {\"RecursiveStruct\": {\"NoRecurse\": \"foo\"}}}" } }, { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveStruct": { "RecursiveStruct": { "RecursiveStruct": { "NoRecurse": "foo" } } } } }, "serialized": { "uri": "/", "headers": { "X-Amz-Target": "com.amazonaws.foo.OperationName", "Content-Type": "application/x-amz-json-1.1" }, "body": "{\"RecursiveStruct\": {\"RecursiveStruct\": {\"RecursiveStruct\": {\"RecursiveStruct\": {\"NoRecurse\": \"foo\"}}}}}" } }, { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveList": [ { "NoRecurse": "foo" }, { "NoRecurse": "bar" } ] } }, "serialized": { "uri": "/", "headers": { "X-Amz-Target": "com.amazonaws.foo.OperationName", "Content-Type": "application/x-amz-json-1.1" }, "body": "{\"RecursiveStruct\": {\"RecursiveList\": [{\"NoRecurse\": \"foo\"}, {\"NoRecurse\": \"bar\"}]}}" } }, { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveList": [ { "NoRecurse": "foo" }, { "RecursiveStruct": { "NoRecurse": "bar" } } ] } }, "serialized": { "uri": "/", "headers": { "X-Amz-Target": "com.amazonaws.foo.OperationName", "Content-Type": "application/x-amz-json-1.1" }, "body": "{\"RecursiveStruct\": {\"RecursiveList\": [{\"NoRecurse\": \"foo\"}, {\"RecursiveStruct\": {\"NoRecurse\": \"bar\"}}]}}" } }, { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveMap": { "foo": { "NoRecurse": "foo" }, "bar": { "NoRecurse": "bar" } } } }, "serialized": { "uri": "/", "headers": { "X-Amz-Target": "com.amazonaws.foo.OperationName", "Content-Type": "application/x-amz-json-1.1" }, "body": "{\"RecursiveStruct\": {\"RecursiveMap\": {\"foo\": {\"NoRecurse\": \"foo\"}, \"bar\": {\"NoRecurse\": \"bar\"}}}}" } } ] }, { "description": "Empty maps", "metadata": { "protocol": "json", "jsonVersion": 1.1, "targetPrefix": "com.amazonaws.foo" }, "shapes": { "InputShape": { "type": "structure", "members": { "Map": { "shape": "MapType" } } }, "MapType": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName", "http": { "method": "POST" } }, "params": { "Map": {} }, "serialized": { "body": "{\"Map\": {}}", "headers": { "X-Amz-Target": "com.amazonaws.foo.OperationName", "Content-Type": "application/x-amz-json-1.1" }, "uri": "/" } } ] } ] botocore-1.5.7/tests/unit/protocols/input/query.json0000666454262600001440000004126413042511306023760 0ustar pysdk-ciamazon00000000000000[ { "description": "Scalar members", "metadata": { "protocol": "query", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "Foo": { "shape": "StringType" }, "Bar": { "shape": "StringType" }, "Baz": { "shape": "BooleanType" } } }, "StringType": { "type": "string" }, "BooleanType": { "type": "boolean" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "Foo": "val1", "Bar": "val2" }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&Foo=val1&Bar=val2" } }, { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "Baz": true }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&Baz=true" } }, { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "Baz": false }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&Baz=false" } } ] }, { "description": "Nested structure members", "metadata": { "protocol": "query", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "StructArg": { "shape": "StructType" } } }, "StructType": { "type": "structure", "members": { "ScalarArg": { "shape": "StringType" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "StructArg": { "ScalarArg": "foo" } }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&StructArg.ScalarArg=foo" } } ] }, { "description": "List types", "metadata": { "protocol": "query", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "ListArg": { "shape": "ListType" } } }, "ListType": { "type": "list", "member": { "shape": "Strings" } }, "Strings": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "ListArg": [ "foo", "bar", "baz" ] }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&ListArg.member.1=foo&ListArg.member.2=bar&ListArg.member.3=baz" } }, { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "ListArg": [] }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&ListArg=" } } ] }, { "description": "Flattened list", "metadata": { "protocol": "query", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "ScalarArg": { "shape": "StringType" }, "ListArg": { "shape": "ListType" }, "NamedListArg": { "shape": "NamedListType" } } }, "ListType": { "type": "list", "member": { "shape": "StringType" }, "flattened": true }, "NamedListType": { "type": "list", "member": { "shape": "StringType", "locationName": "Foo" }, "flattened": true }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "ScalarArg": "foo", "ListArg": [ "a", "b", "c" ] }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&ScalarArg=foo&ListArg.1=a&ListArg.2=b&ListArg.3=c" } }, { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "NamedListArg": [ "a" ] }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&Foo.1=a" } } ] }, { "description": "Serialize flattened map type", "metadata": { "protocol": "query", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "MapArg": { "shape": "StringMap" } } }, "StringMap": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "StringType" }, "flattened": true }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "MapArg": { "key1": "val1", "key2": "val2" } }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&MapArg.1.key=key1&MapArg.1.value=val1&MapArg.2.key=key2&MapArg.2.value=val2" } } ] }, { "description": "Non flattened list with LocationName", "metadata": { "protocol": "query", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "ListArg": { "shape": "ListType" } } }, "ListType": { "type": "list", "member": { "shape": "StringType", "locationName": "item" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "ListArg": [ "a", "b", "c" ] }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&ListArg.item.1=a&ListArg.item.2=b&ListArg.item.3=c" } } ] }, { "description": "Flattened list with LocationName", "metadata": { "protocol": "query", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "ScalarArg": { "shape": "StringType" }, "ListArg": { "shape": "ListType" } } }, "ListType": { "type": "list", "member": { "shape": "StringType", "locationName": "ListArgLocation" }, "flattened": true }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "ScalarArg": "foo", "ListArg": [ "a", "b", "c" ] }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&ScalarArg=foo&ListArgLocation.1=a&ListArgLocation.2=b&ListArgLocation.3=c" } } ] }, { "description": "Serialize map type", "metadata": { "protocol": "query", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "MapArg": { "shape": "StringMap" } } }, "StringMap": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "MapArg": { "key1": "val1", "key2": "val2" } }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&MapArg.entry.1.key=key1&MapArg.entry.1.value=val1&MapArg.entry.2.key=key2&MapArg.entry.2.value=val2" } } ] }, { "description": "Serialize map type with locationName", "metadata": { "protocol": "query", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "MapArg": { "shape": "StringMap" } } }, "StringMap": { "type": "map", "key": { "shape": "StringType", "locationName": "TheKey" }, "value": { "shape": "StringType", "locationName": "TheValue" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "MapArg": { "key1": "val1", "key2": "val2" } }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&MapArg.entry.1.TheKey=key1&MapArg.entry.1.TheValue=val1&MapArg.entry.2.TheKey=key2&MapArg.entry.2.TheValue=val2" } } ] }, { "description": "Base64 encoded Blobs", "metadata": { "protocol": "query", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "BlobArg": { "shape": "BlobType" } } }, "BlobType": { "type": "blob" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "BlobArg": "foo" }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&BlobArg=Zm9v" } } ] }, { "description": "Timestamp values", "metadata": { "protocol": "query", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "TimeArg": { "shape": "TimestampType" } } }, "TimestampType": { "type": "timestamp" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "TimeArg": 1422172800 }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&TimeArg=2015-01-25T08%3A00%3A00Z" } } ] }, { "description": "Recursive shapes", "metadata": { "protocol": "query", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "RecursiveStruct": { "shape": "RecursiveStructType" } } }, "RecursiveStructType": { "type": "structure", "members": { "NoRecurse": { "shape": "StringType" }, "RecursiveStruct": { "shape": "RecursiveStructType" }, "RecursiveList": { "shape": "RecursiveListType" }, "RecursiveMap": { "shape": "RecursiveMapType" } } }, "RecursiveListType": { "type": "list", "member": { "shape": "RecursiveStructType" } }, "RecursiveMapType": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "RecursiveStructType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "NoRecurse": "foo" } }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&RecursiveStruct.NoRecurse=foo" } }, { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveStruct": { "NoRecurse": "foo" } } }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&RecursiveStruct.RecursiveStruct.NoRecurse=foo" } }, { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveStruct": { "RecursiveStruct": { "RecursiveStruct": { "NoRecurse": "foo" } } } } }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&RecursiveStruct.RecursiveStruct.RecursiveStruct.RecursiveStruct.NoRecurse=foo" } }, { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveList": [ { "NoRecurse": "foo" }, { "NoRecurse": "bar" } ] } }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&RecursiveStruct.RecursiveList.member.1.NoRecurse=foo&RecursiveStruct.RecursiveList.member.2.NoRecurse=bar" } }, { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveList": [ { "NoRecurse": "foo" }, { "RecursiveStruct": { "NoRecurse": "bar" } } ] } }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&RecursiveStruct.RecursiveList.member.1.NoRecurse=foo&RecursiveStruct.RecursiveList.member.2.RecursiveStruct.NoRecurse=bar" } }, { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveMap": { "foo": { "NoRecurse": "foo" }, "bar": { "NoRecurse": "bar" } } } }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&RecursiveStruct.RecursiveMap.entry.1.key=foo&RecursiveStruct.RecursiveMap.entry.1.value.NoRecurse=foo&RecursiveStruct.RecursiveMap.entry.2.key=bar&RecursiveStruct.RecursiveMap.entry.2.value.NoRecurse=bar" } } ] } ] botocore-1.5.7/tests/unit/protocols/input/rest-json.json0000666454262600001440000005432513042511306024541 0ustar pysdk-ciamazon00000000000000[ { "description": "No parameters", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": {}, "cases": [ { "given": { "http": { "method": "GET", "requestUri": "/2014-01-01/jobs" }, "name": "OperationName" }, "serialized": { "body": "", "uri": "/2014-01-01/jobs", "headers": {} } } ] }, { "description": "URI parameter only with no location name", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "PipelineId": { "shape": "StringType", "location": "uri" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "GET", "requestUri": "/2014-01-01/jobsByPipeline/{PipelineId}" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "PipelineId": "foo" }, "serialized": { "body": "", "uri": "/2014-01-01/jobsByPipeline/foo", "headers": {} } } ] }, { "description": "URI parameter only with location name", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "Foo": { "shape": "StringType", "location": "uri", "locationName": "PipelineId" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "GET", "requestUri": "/2014-01-01/jobsByPipeline/{PipelineId}" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "Foo": "bar" }, "serialized": { "body": "", "uri": "/2014-01-01/jobsByPipeline/bar", "headers": {} } } ] }, { "description": "Querystring list of strings", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "Items": { "shape": "StringList", "location": "querystring", "locationName": "item" } } }, "StringList": { "type": "list", "member": { "shape": "String" } }, "String": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "GET", "requestUri": "/path" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "Items": ["value1", "value2"] }, "serialized": { "body": "", "uri": "/path?item=value1&item=value2", "headers": {} } } ] }, { "description": "String to string maps in querystring", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "PipelineId": { "shape": "StringType", "location": "uri" }, "QueryDoc": { "shape": "MapStringStringType", "location": "querystring" } } }, "MapStringStringType": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "GET", "requestUri": "/2014-01-01/jobsByPipeline/{PipelineId}" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "PipelineId": "foo", "QueryDoc": { "bar": "baz", "fizz": "buzz" } }, "serialized": { "body": "", "uri": "/2014-01-01/jobsByPipeline/foo?bar=baz&fizz=buzz", "headers": {} } } ] }, { "description": "String to string list maps in querystring", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "PipelineId": { "shape": "StringType", "location": "uri" }, "QueryDoc": { "shape": "MapStringStringListType", "location": "querystring" } } }, "MapStringStringListType": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "StringListType" } }, "StringListType": { "type": "list", "member": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "GET", "requestUri": "/2014-01-01/jobsByPipeline/{PipelineId}" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "PipelineId": "id", "QueryDoc": { "foo": ["bar", "baz"], "fizz": ["buzz", "pop"] } }, "serialized": { "body": "", "uri": "/2014-01-01/jobsByPipeline/id?foo=bar&foo=baz&fizz=buzz&fizz=pop", "headers": {} } } ] }, { "description": "URI parameter and querystring params", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "PipelineId": { "shape": "StringType", "location": "uri", "locationName": "PipelineId" }, "Ascending": { "shape": "StringType", "location": "querystring", "locationName": "Ascending" }, "PageToken": { "shape": "StringType", "location": "querystring", "locationName": "PageToken" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "GET", "requestUri": "/2014-01-01/jobsByPipeline/{PipelineId}" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "PipelineId": "foo", "Ascending": "true", "PageToken": "bar" }, "serialized": { "body": "", "uri": "/2014-01-01/jobsByPipeline/foo?Ascending=true&PageToken=bar", "headers": {} } } ] }, { "description": "URI parameter, querystring params and JSON body", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "PipelineId": { "shape": "StringType", "location": "uri", "locationName": "PipelineId" }, "Ascending": { "shape": "StringType", "location": "querystring", "locationName": "Ascending" }, "PageToken": { "shape": "StringType", "location": "querystring", "locationName": "PageToken" }, "Config": { "shape": "StructType" } } }, "StringType": { "type": "string" }, "StructType": { "type": "structure", "members": { "A": { "shape": "StringType" }, "B": { "shape": "StringType" } } } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/2014-01-01/jobsByPipeline/{PipelineId}" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "PipelineId": "foo", "Ascending": "true", "PageToken": "bar", "Config": { "A": "one", "B": "two" } }, "serialized": { "body": "{\"Config\": {\"A\": \"one\", \"B\": \"two\"}}", "uri": "/2014-01-01/jobsByPipeline/foo?Ascending=true&PageToken=bar", "headers": {} } } ] }, { "description": "URI parameter, querystring params, headers and JSON body", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "PipelineId": { "shape": "StringType", "location": "uri", "locationName": "PipelineId" }, "Ascending": { "shape": "StringType", "location": "querystring", "locationName": "Ascending" }, "Checksum": { "shape": "StringType", "location": "header", "locationName": "x-amz-checksum" }, "PageToken": { "shape": "StringType", "location": "querystring", "locationName": "PageToken" }, "Config": { "shape": "StructType" } } }, "StringType": { "type": "string" }, "StructType": { "type": "structure", "members": { "A": { "shape": "StringType" }, "B": { "shape": "StringType" } } } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/2014-01-01/jobsByPipeline/{PipelineId}" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "PipelineId": "foo", "Ascending": "true", "Checksum": "12345", "PageToken": "bar", "Config": { "A": "one", "B": "two" } }, "serialized": { "body": "{\"Config\": {\"A\": \"one\", \"B\": \"two\"}}", "uri": "/2014-01-01/jobsByPipeline/foo?Ascending=true&PageToken=bar", "headers": { "x-amz-checksum": "12345" } } } ] }, { "description": "Streaming payload", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "vaultName": { "shape": "StringType", "location": "uri", "locationName": "vaultName" }, "checksum": { "shape": "StringType", "location": "header", "locationName": "x-amz-sha256-tree-hash" }, "body": { "shape": "Stream" } }, "required": [ "vaultName" ], "payload": "body" }, "StringType": { "type": "string" }, "Stream": { "type": "blob", "streaming": true } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/2014-01-01/vaults/{vaultName}/archives" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "vaultName": "name", "checksum": "foo", "body": "contents" }, "serialized": { "body": "contents", "uri": "/2014-01-01/vaults/name/archives", "headers": { "x-amz-sha256-tree-hash": "foo" } } } ] }, { "description": "Serialize blobs in body", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "Foo": { "shape": "StringType", "location": "uri", "locationName": "Foo" }, "Bar": {"shape": "BlobType"} }, "required": [ "Foo" ] }, "StringType": { "type": "string" }, "BlobType": { "type": "blob" } }, "cases": [ { "given": { "http": { "method": "GET", "requestUri": "/2014-01-01/{Foo}" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "Foo": "foo_name", "Bar": "Blob param" }, "serialized": { "body": "{\"Bar\": \"QmxvYiBwYXJhbQ==\"}", "uri": "/2014-01-01/foo_name" } } ] }, { "description": "Omits null query params, but serializes empty strings", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "foo": { "location":"querystring", "locationName":"param-name", "shape": "Foo" } } }, "Foo": { "type": "string" } }, "cases": [ { "given": { "name": "OperationName", "http": { "method": "POST", "requestUri": "/path" }, "input": { "shape": "InputShape" } }, "params": { "foo": null }, "serialized": { "method": "POST", "body": "", "uri": "/path" } }, { "given": { "name": "OperationName", "http": { "method": "POST", "requestUri": "/path?abc=mno" }, "input": { "shape": "InputShape" } }, "params": { "foo": "" }, "serialized": { "method": "POST", "body": "", "uri": "/path?abc=mno¶m-name=" } } ] }, { "description": "Recursive shapes", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "RecursiveStruct": { "shape": "RecursiveStructType" } } }, "RecursiveStructType": { "type": "structure", "members": { "NoRecurse": { "shape": "StringType" }, "RecursiveStruct": { "shape": "RecursiveStructType" }, "RecursiveList": { "shape": "RecursiveListType" }, "RecursiveMap": { "shape": "RecursiveMapType" } } }, "RecursiveListType": { "type": "list", "member": { "shape": "RecursiveStructType" } }, "RecursiveMapType": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "RecursiveStructType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "http": { "method": "POST", "requestUri": "/path" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "NoRecurse": "foo" } }, "serialized": { "uri": "/path" , "headers": {}, "body": "{\"RecursiveStruct\": {\"NoRecurse\": \"foo\"}}" } }, { "given": { "input": { "shape": "InputShape" }, "http": { "method": "POST", "requestUri": "/path" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveStruct": { "NoRecurse": "foo" } } }, "serialized": { "uri": "/path", "headers": {}, "body": "{\"RecursiveStruct\": {\"RecursiveStruct\": {\"NoRecurse\": \"foo\"}}}" } }, { "given": { "input": { "shape": "InputShape" }, "http": { "method": "POST", "requestUri": "/path" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveStruct": { "RecursiveStruct": { "RecursiveStruct": { "NoRecurse": "foo" } } } } }, "serialized": { "uri": "/path", "headers": {}, "body": "{\"RecursiveStruct\": {\"RecursiveStruct\": {\"RecursiveStruct\": {\"RecursiveStruct\": {\"NoRecurse\": \"foo\"}}}}}" } }, { "given": { "input": { "shape": "InputShape" }, "http": { "method": "POST", "requestUri": "/path" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveList": [ { "NoRecurse": "foo" }, { "NoRecurse": "bar" } ] } }, "serialized": { "uri": "/path", "headers": {}, "body": "{\"RecursiveStruct\": {\"RecursiveList\": [{\"NoRecurse\": \"foo\"}, {\"NoRecurse\": \"bar\"}]}}" } }, { "given": { "input": { "shape": "InputShape" }, "http": { "method": "POST", "requestUri": "/path" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveList": [ { "NoRecurse": "foo" }, { "RecursiveStruct": { "NoRecurse": "bar" } } ] } }, "serialized": { "uri": "/path", "headers": {}, "body": "{\"RecursiveStruct\": {\"RecursiveList\": [{\"NoRecurse\": \"foo\"}, {\"RecursiveStruct\": {\"NoRecurse\": \"bar\"}}]}}" } }, { "given": { "input": { "shape": "InputShape" }, "http": { "method": "POST", "requestUri": "/path" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveMap": { "foo": { "NoRecurse": "foo" }, "bar": { "NoRecurse": "bar" } } } }, "serialized": { "uri": "/path", "headers": {}, "body": "{\"RecursiveStruct\": {\"RecursiveMap\": {\"foo\": {\"NoRecurse\": \"foo\"}, \"bar\": {\"NoRecurse\": \"bar\"}}}}" } } ] }, { "description": "Timestamp values", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "TimeArg": { "shape": "TimestampType" }, "TimeArgInHeader": { "shape": "TimestampType", "location": "header", "locationName": "x-amz-timearg" } } }, "TimestampType": { "type": "timestamp" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "http": { "method": "POST", "requestUri": "/path" }, "name": "OperationName" }, "params": { "TimeArg": 1422172800 }, "serialized": { "uri": "/path", "headers": {}, "body": "{\"TimeArg\": 1422172800}" } }, { "given": { "input": { "shape": "InputShape" }, "http": { "method": "POST", "requestUri": "/path" }, "name": "OperationName" }, "params": { "TimeArgInHeader": 1422172800 }, "serialized": { "uri": "/path", "headers": {"x-amz-timearg": "Sun, 25 Jan 2015 08:00:00 GMT"}, "body": "" } } ] }, { "description": "Named locations in JSON body", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "TimeArg": { "shape": "TimestampType", "locationName": "timestamp_location" } } }, "TimestampType": { "type": "timestamp" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "http": { "method": "POST", "requestUri": "/path" }, "name": "OperationName" }, "params": { "TimeArg": 1422172800 }, "serialized": { "uri": "/path", "headers": {}, "body": "{\"timestamp_location\": 1422172800}" } } ] } ] botocore-1.5.7/tests/unit/protocols/input/rest-xml.json0000666454262600001440000011144213042511306024362 0ustar pysdk-ciamazon00000000000000[ { "description": "Basic XML serialization", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "Name": { "shape": "StringType" }, "Description": { "shape": "StringType" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/2014-01-01/hostedzone" }, "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "name": "OperationName" }, "params": { "Name": "foo", "Description": "bar" }, "serialized": { "method": "POST", "body": "foobar", "uri": "/2014-01-01/hostedzone", "headers": {} } }, { "given": { "http": { "method": "PUT", "requestUri": "/2014-01-01/hostedzone" }, "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "name": "OperationName" }, "params": { "Name": "foo", "Description": "bar" }, "serialized": { "method": "PUT", "body": "foobar", "uri": "/2014-01-01/hostedzone", "headers": {} } }, { "given": { "http": { "method": "GET", "requestUri": "/2014-01-01/hostedzone" }, "name": "OperationName" }, "params": {}, "serialized": { "method": "GET", "body": "", "uri": "/2014-01-01/hostedzone", "headers": {} } } ] }, { "description": "Serialize other scalar types", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "First": { "shape": "BoolType" }, "Second": { "shape": "BoolType" }, "Third": { "shape": "FloatType" }, "Fourth": { "shape": "IntegerType" } } }, "BoolType": { "type": "boolean" }, "FloatType": { "type": "float" }, "IntegerType": { "type": "integer" } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/2014-01-01/hostedzone" }, "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "name": "OperationName" }, "params": { "First": true, "Second": false, "Third": 1.2, "Fourth": 3 }, "serialized": { "method": "POST", "body": "truefalse1.23", "uri": "/2014-01-01/hostedzone", "headers": {} } } ] }, { "description": "Nested structures", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "SubStructure": { "shape": "SubStructure" }, "Description": { "shape": "StringType" } } }, "SubStructure": { "type": "structure", "members": { "Foo": { "shape": "StringType" }, "Bar": { "shape": "StringType" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/2014-01-01/hostedzone" }, "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "name": "OperationName" }, "params": { "SubStructure": { "Foo": "a", "Bar": "b" }, "Description": "baz" }, "serialized": { "method": "POST", "body": "abbaz", "uri": "/2014-01-01/hostedzone", "headers": {} } }, { "given": { "http": { "method": "POST", "requestUri": "/2014-01-01/hostedzone" }, "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "name": "OperationName" }, "params": { "SubStructure": { "Foo": "a", "Bar": null }, "Description": "baz" }, "serialized": { "method": "POST", "body": "abaz", "uri": "/2014-01-01/hostedzone", "headers": {} } } ] }, { "description": "Nested structures", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "SubStructure": { "shape": "SubStructure" }, "Description": { "shape": "StringType" } } }, "SubStructure": { "type": "structure", "members": { "Foo": { "shape": "StringType" }, "Bar": { "shape": "StringType" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/2014-01-01/hostedzone" }, "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "name": "OperationName" }, "params": { "SubStructure": {}, "Description": "baz" }, "serialized": { "method": "POST", "body": "baz", "uri": "/2014-01-01/hostedzone", "headers": {} } } ] }, { "description": "Non flattened lists", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "ListParam": { "shape": "ListShape" } } }, "ListShape": { "type": "list", "member": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/2014-01-01/hostedzone" }, "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "name": "OperationName" }, "params": { "ListParam": [ "one", "two", "three" ] }, "serialized": { "method": "POST", "body": "onetwothree", "uri": "/2014-01-01/hostedzone", "headers": {} } } ] }, { "description": "Non flattened lists with locationName", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "ListParam": { "shape": "ListShape", "locationName": "AlternateName" } } }, "ListShape": { "type": "list", "member": { "shape": "StringType", "locationName": "NotMember" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/2014-01-01/hostedzone" }, "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "name": "OperationName" }, "params": { "ListParam": [ "one", "two", "three" ] }, "serialized": { "method": "POST", "body": "onetwothree", "uri": "/2014-01-01/hostedzone", "headers": {} } } ] }, { "description": "Flattened lists", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "ListParam": { "shape": "ListShape" } } }, "ListShape": { "type": "list", "member": { "shape": "StringType" }, "flattened": true }, "StringType": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/2014-01-01/hostedzone" }, "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "name": "OperationName" }, "params": { "ListParam": [ "one", "two", "three" ] }, "serialized": { "method": "POST", "body": "onetwothree", "uri": "/2014-01-01/hostedzone", "headers": {} } } ] }, { "description": "Flattened lists with locationName", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "ListParam": { "shape": "ListShape", "locationName": "item" } } }, "ListShape": { "type": "list", "member": { "shape": "StringType" }, "flattened": true }, "StringType": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/2014-01-01/hostedzone" }, "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "name": "OperationName" }, "params": { "ListParam": [ "one", "two", "three" ] }, "serialized": { "method": "POST", "body": "onetwothree", "uri": "/2014-01-01/hostedzone", "headers": {} } } ] }, { "description": "List of structures", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "ListParam": { "shape": "ListShape", "locationName": "item" } } }, "ListShape": { "type": "list", "member": { "shape": "SingleFieldStruct" }, "flattened": true }, "StringType": { "type": "string" }, "SingleFieldStruct": { "type": "structure", "members": { "Element": { "shape": "StringType", "locationName": "value" } } } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/2014-01-01/hostedzone" }, "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "name": "OperationName" }, "params": { "ListParam": [ { "Element": "one" }, { "Element": "two" }, { "Element": "three" } ] }, "serialized": { "method": "POST", "body": "onetwothree", "uri": "/2014-01-01/hostedzone", "headers": {} } } ] }, { "description": "Blob and timestamp shapes", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "StructureParam": { "shape": "StructureShape" } } }, "StructureShape": { "type": "structure", "members": { "t": { "shape": "TShape" }, "b": { "shape": "BShape" } } }, "TShape": { "type": "timestamp" }, "BShape": { "type": "blob" } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/2014-01-01/hostedzone" }, "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "name": "OperationName" }, "params": { "StructureParam": { "t": 1422172800, "b": "foo" } }, "serialized": { "method": "POST", "body": "2015-01-25T08:00:00ZZm9v", "uri": "/2014-01-01/hostedzone", "headers": {} } } ] }, { "description": "Header maps", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "foo": { "shape": "FooShape" } } }, "FooShape": { "type": "map", "location": "headers", "locationName": "x-foo-", "key": { "shape": "FooKeyValue" }, "value": { "shape": "FooKeyValue" } }, "FooKeyValue": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "name": "OperationName" }, "params": { "foo": { "a": "b", "c": "d" } }, "serialized": { "method": "POST", "body": "", "uri": "/", "headers": { "x-foo-a": "b", "x-foo-c": "d" } } } ] }, { "description": "Querystring list of strings", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "Items": { "shape": "StringList", "location": "querystring", "locationName": "item" } } }, "StringList": { "type": "list", "member": { "shape": "String" } }, "String": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "GET", "requestUri": "/path" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "Items": ["value1", "value2"] }, "serialized": { "body": "", "uri": "/path?item=value1&item=value2", "headers": {} } } ] }, { "description": "Querystring with boolean", "metadata": { "protocol": "rest-json", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "item" : { "shape": "Boolean", "location": "querystring", "locationName": "item" } } }, "Boolean": { "type": "boolean" } }, "cases": [ { "given": { "http": { "method": "GET", "requestUri": "/path" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "item": true }, "serialized": { "body": "", "uri": "/path?item=true", "headers": {} } } ] }, { "description": "String to string maps in querystring", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "PipelineId": { "shape": "StringType", "location": "uri" }, "QueryDoc": { "shape": "MapStringStringType", "location": "querystring" } } }, "MapStringStringType": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "GET", "requestUri": "/2014-01-01/jobsByPipeline/{PipelineId}" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "PipelineId": "foo", "QueryDoc": { "bar": "baz", "fizz": "buzz" } }, "serialized": { "body": "", "uri": "/2014-01-01/jobsByPipeline/foo?bar=baz&fizz=buzz", "headers": {} } } ] }, { "description": "String to string list maps in querystring", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "PipelineId": { "shape": "StringType", "location": "uri" }, "QueryDoc": { "shape": "MapStringStringListType", "location": "querystring" } } }, "MapStringStringListType": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "StringListType" } }, "StringListType": { "type": "list", "member": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "GET", "requestUri": "/2014-01-01/jobsByPipeline/{PipelineId}" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "PipelineId": "id", "QueryDoc": { "foo": ["bar", "baz"], "fizz": ["buzz", "pop"] } }, "serialized": { "body": "", "uri": "/2014-01-01/jobsByPipeline/id?foo=bar&foo=baz&fizz=buzz&fizz=pop", "headers": {} } } ] }, { "description": "String payload", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "foo": { "shape": "FooShape" } }, "payload": "foo" }, "FooShape": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "foo": "bar" }, "serialized": { "method": "POST", "body": "bar", "uri": "/" } } ] }, { "description": "Blob payload", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "foo": { "shape": "FooShape" } }, "payload": "foo" }, "FooShape": { "type": "blob" } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "foo": "bar" }, "serialized": { "method": "POST", "body": "bar", "uri": "/" } }, { "given": { "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { }, "serialized": { "method": "POST", "body": "", "uri": "/" } } ] }, { "description": "Structure payload", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "foo": { "shape": "FooShape" } }, "payload": "foo" }, "FooShape": { "locationName": "foo", "type": "structure", "members": { "baz": { "shape": "BazShape" } } }, "BazShape": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "foo": { "baz": "bar" } }, "serialized": { "method": "POST", "body": "bar", "uri": "/" } }, { "given": { "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": {}, "serialized": { "method": "POST", "body": "", "uri": "/" } }, { "given": { "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "foo": {} }, "serialized": { "method": "POST", "body": "", "uri": "/" } }, { "given": { "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "foo": null }, "serialized": { "method": "POST", "body": "", "uri": "/" } } ] }, { "description": "XML Attribute", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "Grant": { "shape": "Grant" } }, "payload": "Grant" }, "Grant": { "type": "structure", "locationName": "Grant", "members": { "Grantee": { "shape": "Grantee" } } }, "Grantee": { "type": "structure", "members": { "Type": { "shape": "Type", "locationName": "xsi:type", "xmlAttribute": true }, "EmailAddress": { "shape": "StringType" } }, "xmlNamespace": { "prefix": "xsi", "uri":"http://www.w3.org/2001/XMLSchema-instance" } }, "Type": { "type": "string" }, "StringType": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "Grant": { "Grantee": { "EmailAddress": "foo@example.com", "Type": "CanonicalUser" } } }, "serialized": { "method": "POST", "body": "foo@example.com", "uri": "/" } } ] }, { "description": "Greedy keys", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "Bucket": { "shape": "BucketShape", "location": "uri" }, "Key": { "shape": "KeyShape", "location": "uri" } } }, "BucketShape": { "type": "string" }, "KeyShape": { "type": "string" } }, "cases": [ { "given": { "http": { "method": "GET", "requestUri": "/{Bucket}/{Key+}" }, "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "Key": "testing /123", "Bucket": "my/bucket" }, "serialized": { "method": "GET", "body": "", "uri": "/my%2Fbucket/testing%20/123" } } ] }, { "description": "Omits null query params, but serializes empty strings", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "foo": { "location":"querystring", "locationName":"param-name", "shape": "Foo" } } }, "Foo": { "type": "string" } }, "cases": [ { "given": { "name": "OperationName", "http": { "method": "POST", "requestUri": "/path" }, "input": { "shape": "InputShape" } }, "params": { "foo": null }, "serialized": { "method": "POST", "body": "", "uri": "/path" } }, { "given": { "name": "OperationName", "http": { "method": "POST", "requestUri": "/path?abc=mno" }, "input": { "shape": "InputShape" } }, "params": { "foo": "" }, "serialized": { "method": "POST", "body": "", "uri": "/path?abc=mno¶m-name=" } } ] }, { "description": "Recursive shapes", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "RecursiveStruct": { "shape": "RecursiveStructType" } } }, "RecursiveStructType": { "type": "structure", "members": { "NoRecurse": { "shape": "StringType" }, "RecursiveStruct": { "shape": "RecursiveStructType" }, "RecursiveList": { "shape": "RecursiveListType" }, "RecursiveMap": { "shape": "RecursiveMapType" } } }, "RecursiveListType": { "type": "list", "member": { "shape": "RecursiveStructType" } }, "RecursiveMapType": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "RecursiveStructType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "http": { "method": "POST", "requestUri": "/path" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "NoRecurse": "foo" } }, "serialized": { "uri": "/path", "body": "foo" } }, { "given": { "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "http": { "method": "POST", "requestUri": "/path" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveStruct": { "NoRecurse": "foo" } } }, "serialized": { "uri": "/path", "body": "foo" } }, { "given": { "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "http": { "method": "POST", "requestUri": "/path" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveStruct": { "RecursiveStruct": { "RecursiveStruct": { "NoRecurse": "foo" } } } } }, "serialized": { "uri": "/path", "body": "foo" } }, { "given": { "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "http": { "method": "POST", "requestUri": "/path" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveList": [ { "NoRecurse": "foo" }, { "NoRecurse": "bar" } ] } }, "serialized": { "uri": "/path", "body": "foobar" } }, { "given": { "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "http": { "method": "POST", "requestUri": "/path" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveList": [ { "NoRecurse": "foo" }, { "RecursiveStruct": { "NoRecurse": "bar" } } ] } }, "serialized": { "uri": "/path", "body": "foobar" } }, { "given": { "input": { "shape": "InputShape", "locationName": "OperationRequest", "xmlNamespace": {"uri": "https://foo/"} }, "http": { "method": "POST", "requestUri": "/path" }, "name": "OperationName" }, "params": { "RecursiveStruct": { "RecursiveMap": { "foo": { "NoRecurse": "foo" }, "bar": { "NoRecurse": "bar" } } } }, "serialized": { "uri": "/path", "body": "foofoobarbar" } } ] }, { "description": "Timestamp in header", "metadata": { "protocol": "rest-xml", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "TimeArgInHeader": { "shape": "TimestampType", "location": "header", "locationName": "x-amz-timearg" } } }, "TimestampType": { "type": "timestamp" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "http": { "method": "POST", "requestUri": "/path" }, "name": "OperationName" }, "params": { "TimeArgInHeader": 1422172800 }, "serialized": { "method": "POST", "body": "", "uri": "/path", "headers": {"x-amz-timearg": "Sun, 25 Jan 2015 08:00:00 GMT"} } } ] } ] botocore-1.5.7/tests/unit/protocols/input/ec2.json0000666454262600001440000001646613042511306023272 0ustar pysdk-ciamazon00000000000000[ { "description": "Scalar members", "metadata": { "protocol": "ec2", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "Foo": { "shape": "StringType" }, "Bar": { "shape": "StringType" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "Foo": "val1", "Bar": "val2" }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&Foo=val1&Bar=val2" } } ] }, { "description": "Structure with locationName and queryName applied to members", "metadata": { "protocol": "ec2", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "Foo": { "shape": "StringType" }, "Bar": { "shape": "StringType", "locationName": "barLocationName" }, "Yuck": { "shape": "StringType", "locationName": "yuckLocationName", "queryName": "yuckQueryName" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "Foo": "val1", "Bar": "val2", "Yuck": "val3" }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&Foo=val1&BarLocationName=val2&yuckQueryName=val3" } } ] }, { "description": "Nested structure members", "metadata": { "protocol": "ec2", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "StructArg": { "shape": "StructType", "locationName": "Struct" } } }, "StructType": { "type": "structure", "members": { "ScalarArg": { "shape": "StringType", "locationName": "Scalar" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "StructArg": { "ScalarArg": "foo" } }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&Struct.Scalar=foo" } } ] }, { "description": "List types", "metadata": { "protocol": "ec2", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "ListArg": { "shape": "ListType" } } }, "ListType": { "type": "list", "member": { "shape": "Strings" } }, "Strings": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "ListArg": [ "foo", "bar", "baz" ] }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&ListArg.1=foo&ListArg.2=bar&ListArg.3=baz" } } ] }, { "description": "List with location name applied to member", "metadata": { "protocol": "ec2", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "ListArg": { "shape": "ListType", "locationName": "ListMemberName" } } }, "ListType": { "type": "list", "member": { "shape": "StringType", "LocationName": "item" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "ListArg": [ "a", "b", "c" ] }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&ListMemberName.1=a&ListMemberName.2=b&ListMemberName.3=c" } } ] }, { "description": "List with locationName and queryName", "metadata": { "protocol": "ec2", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "ListArg": { "shape": "ListType", "locationName": "ListMemberName", "queryName": "ListQueryName" } } }, "ListType": { "type": "list", "member": { "shape": "StringType", "LocationName": "item" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "ListArg": [ "a", "b", "c" ] }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&ListQueryName.1=a&ListQueryName.2=b&ListQueryName.3=c" } } ] }, { "description": "Base64 encoded Blobs", "metadata": { "protocol": "ec2", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "BlobArg": { "shape": "BlobType" } } }, "BlobType": { "type": "blob" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "BlobArg": "foo" }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&BlobArg=Zm9v" } } ] }, { "description": "Timestamp values", "metadata": { "protocol": "ec2", "apiVersion": "2014-01-01" }, "shapes": { "InputShape": { "type": "structure", "members": { "TimeArg": { "shape": "TimestampType" } } }, "TimestampType": { "type": "timestamp" } }, "cases": [ { "given": { "input": { "shape": "InputShape" }, "name": "OperationName" }, "params": { "TimeArg": 1422172800 }, "serialized": { "uri": "/", "body": "Action=OperationName&Version=2014-01-01&TimeArg=2015-01-25T08%3A00%3A00Z" } } ] } ] botocore-1.5.7/tests/unit/protocols/output/0000777454262600001440000000000013042511310022105 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/protocols/output/json.json0000666454262600001440000001675213042511306023771 0ustar pysdk-ciamazon00000000000000[ { "description": "Scalar members", "metadata": { "protocol": "json" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Str": { "shape": "StringType" }, "Num": { "shape": "IntegerType" }, "FalseBool": { "shape": "BooleanType" }, "TrueBool": { "shape": "BooleanType" }, "Float": { "shape": "FloatType" }, "Double": { "shape": "DoubleType" }, "Long": { "shape": "LongType" }, "Char": { "shape": "CharType" } } }, "StringType": { "type": "string" }, "IntegerType": { "type": "integer" }, "BooleanType": { "type": "boolean" }, "FloatType": { "type": "float" }, "DoubleType": { "type": "double" }, "LongType": { "type": "long" }, "CharType": { "type": "character" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Str": "myname", "Num": 123, "FalseBool": false, "TrueBool": true, "Float": 1.2, "Double": 1.3, "Long": 200, "Char": "a" }, "response": { "status_code": 200, "headers": {}, "body": "{\"Str\": \"myname\", \"Num\": 123, \"FalseBool\": false, \"TrueBool\": true, \"Float\": 1.2, \"Double\": 1.3, \"Long\": 200, \"Char\": \"a\"}" } } ] }, { "description": "Blob members", "metadata": { "protocol": "json" }, "shapes": { "OutputShape": { "type": "structure", "members": { "BlobMember": { "shape": "BlobType" }, "StructMember": { "shape": "BlobContainer" } } }, "BlobType": { "type": "blob" }, "BlobContainer": { "type": "structure", "members": { "foo": { "shape": "BlobType" } } } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "BlobMember": "hi!", "StructMember": { "foo": "there!" } }, "response": { "status_code": 200, "headers": {}, "body": "{\"BlobMember\": \"aGkh\", \"StructMember\": {\"foo\": \"dGhlcmUh\"}}" } } ] }, { "description": "Timestamp members", "metadata": { "protocol": "json" }, "shapes": { "OutputShape": { "type": "structure", "members": { "TimeMember": { "shape": "TimeType" }, "StructMember": { "shape": "TimeContainer" } } }, "TimeType": { "type": "timestamp" }, "TimeContainer": { "type": "structure", "members": { "foo": { "shape": "TimeType" } } } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "TimeMember": 1398796238, "StructMember": { "foo": 1398796238 } }, "response": { "status_code": 200, "headers": {}, "body": "{\"TimeMember\": 1398796238, \"StructMember\": {\"foo\": 1398796238}}" } } ] }, { "description": "Lists", "metadata": { "protocol": "json" }, "shapes": { "OutputShape": { "type": "structure", "members": { "ListMember": { "shape": "ListType" }, "ListMemberMap": { "shape": "ListTypeMap" }, "ListMemberStruct": { "shape": "ListTypeStruct" } } }, "ListType": { "type": "list", "member": { "shape": "StringType" } }, "ListTypeMap": { "type": "list", "member": { "shape": "MapType" } }, "ListTypeStruct": { "type": "list", "member": { "shape": "StructType" } }, "StringType": { "type": "string" }, "StructType": { "type": "structure", "members": { } }, "MapType": { "type": "string", "key": { "shape": "StringType" }, "value": { "shape": "StringType" } } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ListMember": ["a", "b"] }, "response": { "status_code": 200, "headers": {}, "body": "{\"ListMember\": [\"a\", \"b\"]}" } }, { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ListMember": ["a", null], "ListMemberMap": [{}, null, null, {}], "ListMemberStruct": [{}, null, null, {}] }, "response": { "status_code": 200, "headers": {}, "body": "{\"ListMember\": [\"a\", null], \"ListMemberMap\": [{}, null, null, {}], \"ListMemberStruct\": [{}, null, null, {}]}" } } ] }, { "description": "Maps", "metadata": { "protocol": "json" }, "shapes": { "OutputShape": { "type": "structure", "members": { "MapMember": { "shape": "MapType" } } }, "MapType": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "NumberList" } }, "StringType": { "type": "string" }, "NumberList": { "type": "list", "member": { "shape": "IntegerType" } }, "IntegerType": { "type": "integer" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "MapMember": { "a": [1, 2], "b": [3, 4] } }, "response": { "status_code": 200, "headers": {}, "body": "{\"MapMember\": {\"a\": [1, 2], \"b\": [3, 4]}}" } } ] }, { "description": "Ignores extra data", "metadata": { "protocol": "json" }, "shapes": { "OutputShape": { "type": "structure", "members": { "StrType": { "shape": "StrType" } } }, "StrType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": {}, "response": { "status_code": 200, "headers": {}, "body": "{\"foo\": \"bar\"}" } } ] } ] botocore-1.5.7/tests/unit/protocols/output/query.json0000666454262600001440000004551513042511306024164 0ustar pysdk-ciamazon00000000000000[ { "description": "Scalar members", "metadata": { "protocol": "query" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Str": { "shape": "StringType" }, "Num": { "shape": "IntegerType", "locationName": "FooNum" }, "FalseBool": { "shape": "BooleanType" }, "TrueBool": { "shape": "BooleanType" }, "Float": { "shape": "FloatType" }, "Double": { "shape": "DoubleType" }, "Long": { "shape": "LongType" }, "Char": { "shape": "CharType" }, "Timestamp": { "shape": "TimestampType" } } }, "StringType": { "type": "string" }, "IntegerType": { "type": "integer" }, "BooleanType": { "type": "boolean" }, "FloatType": { "type": "float" }, "DoubleType": { "type": "double" }, "LongType": { "type": "long" }, "CharType": { "type": "character" }, "TimestampType": { "type": "timestamp" } }, "cases": [ { "given": { "output": { "resultWrapper": "OperationNameResult", "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Str": "myname", "Num": 123, "FalseBool": false, "TrueBool": true, "Float": 1.2, "Double": 1.3, "Long": 200, "Char": "a", "Timestamp": 1422172800 }, "response": { "status_code": 200, "headers": {}, "body": "myname123falsetrue1.21.3200a2015-01-25T08:00:00Zrequest-id" } } ] }, { "description": "Not all members in response", "metadata": { "protocol": "query" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Str": { "shape": "StringType" }, "Num": { "shape": "IntegerType" } } }, "StringType": { "type": "string" }, "IntegerType": { "type": "integer" } }, "cases": [ { "given": { "output": { "resultWrapper": "OperationNameResult", "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Str": "myname" }, "response": { "status_code": 200, "headers": {}, "body": "mynamerequest-id" } } ] }, { "description": "Blob", "metadata": { "protocol": "query" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Blob": { "shape": "BlobType" } } }, "BlobType": { "type": "blob" } }, "cases": [ { "given": { "output": { "resultWrapper": "OperationNameResult", "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Blob": "value" }, "response": { "status_code": 200, "headers": {}, "body": "dmFsdWU=requestid" } } ] }, { "description": "Lists", "metadata": { "protocol": "query" }, "shapes": { "OutputShape": { "type": "structure", "members": { "ListMember": { "shape": "ListShape" } } }, "ListShape": { "type": "list", "member": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "resultWrapper": "OperationNameResult", "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ListMember": ["abc", "123"] }, "response": { "status_code": 200, "headers": {}, "body": "abc123requestid" } } ] }, { "description": "List with custom member name", "metadata": { "protocol": "query" }, "shapes": { "OutputShape": { "type": "structure", "members": { "ListMember": { "shape": "ListShape" } } }, "ListShape": { "type": "list", "member": { "shape": "StringType", "locationName": "item" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "resultWrapper": "OperationNameResult", "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ListMember": ["abc", "123"] }, "response": { "status_code": 200, "headers": {}, "body": "abc123requestid" } } ] }, { "description": "Flattened List", "metadata": { "protocol": "query" }, "shapes": { "OutputShape": { "type": "structure", "members": { "ListMember": { "shape": "ListType" } } }, "ListType": { "type": "list", "flattened": true, "member": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "resultWrapper": "OperationNameResult", "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ListMember": ["abc", "123"] }, "response": { "status_code": 200, "headers": {}, "body": "abc123requestid" } } ] }, { "description": "Flattened single element list", "metadata": { "protocol": "query" }, "shapes": { "OutputShape": { "type": "structure", "members": { "ListMember": { "shape": "ListType" } } }, "ListType": { "type": "list", "flattened": true, "member": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "resultWrapper": "OperationNameResult", "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ListMember": ["abc"] }, "response": { "status_code": 200, "headers": {}, "body": "abcrequestid" } } ] }, { "description": "List of structures", "metadata": { "protocol": "query" }, "shapes": { "OutputShape": { "type": "structure", "members": { "List": { "shape": "ListOfStructs" } } }, "ListOfStructs": { "type": "list", "member": { "shape": "StructureShape" } }, "StructureShape": { "type": "structure", "members": { "Foo": { "shape": "StringShape" }, "Bar": { "shape": "StringShape" }, "Baz": { "shape": "StringShape" } } }, "StringShape": { "type": "string" } }, "cases": [ { "given": { "output": { "resultWrapper": "OperationNameResult", "shape": "OutputShape" }, "name": "OperationName" }, "result": { "List": [{"Foo": "firstfoo", "Bar": "firstbar", "Baz": "firstbaz"}, {"Foo": "secondfoo", "Bar": "secondbar", "Baz": "secondbaz"}] }, "response": { "status_code": 200, "headers": {}, "body": "firstfoofirstbarfirstbazsecondfoosecondbarsecondbazrequestid" } } ] }, { "description": "Flattened list of structures", "metadata": { "protocol": "query" }, "shapes": { "OutputShape": { "type": "structure", "resultWrapper": "OperationNameResult", "members": { "List": { "shape": "ListOfStructs" } } }, "ListOfStructs": { "type": "list", "flattened": true, "member": { "shape": "StructureShape" } }, "StructureShape": { "type": "structure", "members": { "Foo": { "shape": "StringShape" }, "Bar": { "shape": "StringShape" }, "Baz": { "shape": "StringShape" } } }, "StringShape": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "List": [{"Foo": "firstfoo", "Bar": "firstbar", "Baz": "firstbaz"}, {"Foo": "secondfoo", "Bar": "secondbar", "Baz": "secondbaz"}] }, "response": { "status_code": 200, "headers": {}, "body": "firstfoofirstbarfirstbazsecondfoosecondbarsecondbazrequestid" } } ] }, { "description": "Flattened list with location name", "metadata": { "protocol": "query" }, "shapes": { "OutputShape": { "type": "structure", "members": { "List": { "shape": "ListType" } } }, "ListType": { "type": "list", "flattened": true, "member": { "shape": "StringShape", "locationName": "NamedList" } }, "StringShape": { "type": "string" } }, "cases": [ { "given": { "output": { "resultWrapper": "OperationNameResult", "shape": "OutputShape" }, "name": "OperationName" }, "result": { "List": ["a", "b"] }, "response": { "status_code": 200, "headers": {}, "body": "abrequestid" } } ] }, { "description": "Normal map", "metadata": { "protocol": "query" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Map": { "shape": "StringMap" } } }, "StringMap": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "StructType" } }, "StringType": { "type": "string" }, "StructType": { "type": "structure", "members": { "foo": { "shape": "StringType" } } } }, "cases": [ { "given": { "output": { "resultWrapper": "OperationNameResult", "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Map": { "qux": { "foo": "bar" }, "baz": { "foo": "bam" } } }, "response": { "status_code": 200, "headers": {}, "body": "quxbarbazbamrequestid" } } ] }, { "description": "Flattened map", "metadata": { "protocol": "query" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Map": { "shape": "StringMap", "flattened": true } } }, "StringMap": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "resultWrapper": "OperationNameResult", "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Map": { "qux": "bar", "baz": "bam" } }, "response": { "status_code": 200, "headers": {}, "body": "quxbarbazbamrequestid" } } ] }, { "description": "Flattened map in shape definition", "metadata": { "protocol": "query" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Map": { "shape": "StringMap", "locationName": "Attribute" } } }, "StringMap": { "type": "map", "key": { "shape": "StringType", "locationName": "Name" }, "value": { "shape": "StringType", "locationName": "Value" }, "flattened": true, "locationName": "Attribute" }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "resultWrapper": "OperationNameResult", "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Map": { "qux": "bar" } }, "response": { "status_code": 200, "headers": {}, "body": "quxbarrequestid" } } ] }, { "description": "Named map", "metadata": { "protocol": "query" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Map": { "shape": "MapType" } } }, "MapType": { "type": "map", "flattened": true, "key": { "locationName": "foo", "shape": "StringType" }, "value": { "locationName": "bar", "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "resultWrapper": "OperationNameResult", "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Map": { "qux": "bar", "baz": "bam" } }, "response": { "status_code": 200, "headers": {}, "body": "quxbarbazbamrequestid" } } ] }, { "description": "Empty string", "metadata": { "protocol": "query" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Foo": { "shape": "StringType" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "resultWrapper": "OperationNameResult", "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Foo": "" }, "response": { "status_code": 200, "headers": {}, "body": "requestid" } } ] } ] botocore-1.5.7/tests/unit/protocols/output/rest-json.json0000666454262600001440000003066213042511306024740 0ustar pysdk-ciamazon00000000000000[ { "description": "Scalar members", "metadata": { "protocol": "rest-json" }, "shapes": { "OutputShape": { "type": "structure", "members": { "ImaHeader": { "shape": "HeaderShape" }, "ImaHeaderLocation": { "shape": "HeaderShape", "locationName": "X-Foo" }, "Status": { "shape": "StatusShape", "location": "statusCode" }, "Str": { "shape": "StringType" }, "Num": { "shape": "IntegerType" }, "FalseBool": { "shape": "BooleanType" }, "TrueBool": { "shape": "BooleanType" }, "Float": { "shape": "FloatType" }, "Double": { "shape": "DoubleType" }, "Long": { "shape": "LongType" }, "Char": { "shape": "CharType" } } }, "HeaderShape": { "type": "string", "location": "header" }, "StatusShape": { "type": "integer" }, "StringType": { "type": "string" }, "IntegerType": { "type": "integer" }, "BooleanType": { "type": "boolean" }, "FloatType": { "type": "float" }, "DoubleType": { "type": "double" }, "LongType": { "type": "long" }, "CharType": { "type": "character" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ImaHeader": "test", "ImaHeaderLocation": "abc", "Status": 200, "Str": "myname", "Num": 123, "FalseBool": false, "TrueBool": true, "Float": 1.2, "Double": 1.3, "Long": 200, "Char": "a" }, "response": { "status_code": 200, "headers": { "ImaHeader": "test", "X-Foo": "abc" }, "body": "{\"Str\": \"myname\", \"Num\": 123, \"FalseBool\": false, \"TrueBool\": true, \"Float\": 1.2, \"Double\": 1.3, \"Long\": 200, \"Char\": \"a\"}" } } ] }, { "description": "Blob members", "metadata": { "protocol": "rest-json" }, "shapes": { "OutputShape": { "type": "structure", "members": { "BlobMember": { "shape": "BlobType" }, "StructMember": { "shape": "BlobContainer" } } }, "BlobType": { "type": "blob" }, "BlobContainer": { "type": "structure", "members": { "foo": { "shape": "BlobType" } } } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "BlobMember": "hi!", "StructMember": { "foo": "there!" } }, "response": { "status_code": 200, "headers": {}, "body": "{\"BlobMember\": \"aGkh\", \"StructMember\": {\"foo\": \"dGhlcmUh\"}}" } } ] }, { "description": "Timestamp members", "metadata": { "protocol": "rest-json" }, "shapes": { "OutputShape": { "type": "structure", "members": { "TimeMember": { "shape": "TimeType" }, "StructMember": { "shape": "TimeContainer" } } }, "TimeType": { "type": "timestamp" }, "TimeContainer": { "type": "structure", "members": { "foo": { "shape": "TimeType" } } } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "TimeMember": 1398796238, "StructMember": { "foo": 1398796238 } }, "response": { "status_code": 200, "headers": {}, "body": "{\"TimeMember\": 1398796238, \"StructMember\": {\"foo\": 1398796238}}" } } ] }, { "description": "Lists", "metadata": { "protocol": "rest-json" }, "shapes": { "OutputShape": { "type": "structure", "members": { "ListMember": { "shape": "ListType" } } }, "ListType": { "type": "list", "member": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ListMember": ["a", "b"] }, "response": { "status_code": 200, "headers": {}, "body": "{\"ListMember\": [\"a\", \"b\"]}" } } ] }, { "description": "Lists with structure member", "metadata": { "protocol": "rest-json" }, "shapes": { "OutputShape": { "type": "structure", "members": { "ListMember": { "shape": "ListType" } } }, "ListType": { "type": "list", "member": { "shape": "SingleStruct" } }, "StringType": { "type": "string" }, "SingleStruct": { "type": "structure", "members": { "Foo": { "shape": "StringType" } } } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ListMember": [{"Foo": "a"}, {"Foo": "b"}] }, "response": { "status_code": 200, "headers": {}, "body": "{\"ListMember\": [{\"Foo\": \"a\"}, {\"Foo\": \"b\"}]}" } } ] }, { "description": "Maps", "metadata": { "protocol": "rest-json" }, "shapes": { "OutputShape": { "type": "structure", "members": { "MapMember": { "shape": "MapType" } } }, "MapType": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "ListType" } }, "ListType": { "type": "list", "member": { "shape": "IntegerType" } }, "StringType": { "type": "string" }, "IntegerType": { "type": "integer" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "MapMember": { "a": [1, 2], "b": [3, 4] } }, "response": { "status_code": 200, "headers": {}, "body": "{\"MapMember\": {\"a\": [1, 2], \"b\": [3, 4]}}" } } ] }, { "description": "Complex Map Values", "metadata": { "protocol": "rest-json" }, "shapes": { "OutputShape": { "type": "structure", "members": { "MapMember": { "shape": "MapType" } } }, "MapType": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "TimeType" } }, "TimeType": { "type": "timestamp" }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "MapMember": { "a": 1398796238, "b": 1398796238 } }, "response": { "status_code": 200, "headers": {}, "body": "{\"MapMember\": {\"a\": 1398796238, \"b\": 1398796238}}" } } ] }, { "description": "Ignores extra data", "metadata": { "protocol": "rest-json" }, "shapes": { "OutputShape": { "type": "structure", "members": { "StrType": { "shape": "StrType" } } }, "StrType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": {}, "response": { "status_code": 200, "headers": {}, "body": "{\"foo\": \"bar\"}" } } ] }, { "description": "Ignores undefined output", "metadata": { "protocol": "rest-json" }, "shapes": {}, "cases": [ { "given": { "name": "OperationName" }, "result": {}, "response": { "status_code": 200, "headers": {}, "body": "OK" } } ] }, { "description": "Supports header maps", "metadata": { "protocol": "rest-json" }, "shapes": { "OutputShape": { "type": "structure", "members": { "AllHeaders": { "shape": "HeaderMap", "location": "headers" }, "PrefixedHeaders": { "shape": "HeaderMap", "location": "headers", "locationName": "X-" } } }, "HeaderMap": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "AllHeaders": { "Content-Length": "10", "x-Foo": "bar", "X-bam": "boo" }, "PrefixedHeaders": { "Foo": "bar", "bam": "boo" } }, "response": { "status_code": 200, "headers": { "Content-Length": "10", "x-Foo": "bar", "X-bam": "boo" }, "body": "{}" } } ] }, { "description": "JSON payload", "metadata": { "protocol": "rest-json" }, "shapes": { "OutputShape": { "type": "structure", "payload": "Data", "members": { "Header": { "shape": "StringType", "location": "header", "locationName": "X-Foo" }, "Data": { "shape": "BodyStructure" } } }, "BodyStructure": { "type": "structure", "members": { "Foo": { "shape": "StringType" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Header": "baz", "Data": { "Foo": "abc" } }, "response": { "status_code": 200, "headers": { "X-Foo": "baz" }, "body": "{\"Foo\": \"abc\"}" } } ] }, { "description": "Streaming payload", "metadata": { "protocol": "rest-json" }, "shapes": { "OutputShape": { "type": "structure", "payload": "Stream", "members": { "Stream": { "shape": "Stream" } } }, "Stream": { "type": "blob" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Stream": "abc" }, "response": { "status_code": 200, "headers": {}, "body": "abc" } } ] } ] botocore-1.5.7/tests/unit/protocols/output/rest-xml.json0000666454262600001440000004224313042511306024565 0ustar pysdk-ciamazon00000000000000[ { "description": "Scalar members", "metadata": { "protocol": "rest-xml" }, "shapes": { "OutputShape": { "type": "structure", "members": { "ImaHeader": { "shape": "HeaderShape" }, "ImaHeaderLocation": { "shape": "HeaderShape", "locationName": "X-Foo" }, "Str": { "shape": "StringType" }, "Num": { "shape": "IntegerType", "locationName": "FooNum" }, "FalseBool": { "shape": "BooleanType" }, "TrueBool": { "shape": "BooleanType" }, "Float": { "shape": "FloatType" }, "Double": { "shape": "DoubleType" }, "Long": { "shape": "LongType" }, "Char": { "shape": "CharType" }, "Timestamp": { "shape": "TimestampType" } } }, "StringType": { "type": "string" }, "IntegerType": { "type": "integer" }, "BooleanType": { "type": "boolean" }, "FloatType": { "type": "float" }, "DoubleType": { "type": "double" }, "LongType": { "type": "long" }, "CharType": { "type": "character" }, "HeaderShape": { "type": "string", "location": "header" }, "StatusShape": { "type": "integer", "location": "statusCode" }, "TimestampType": { "type": "timestamp" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ImaHeader": "test", "ImaHeaderLocation": "abc", "Str": "myname", "Num": 123, "FalseBool": false, "TrueBool": true, "Float": 1.2, "Double": 1.3, "Long": 200, "Char": "a", "Timestamp": 1422172800 }, "response": { "status_code": 200, "headers": { "ImaHeader": "test", "X-Foo": "abc" }, "body": "myname123falsetrue1.21.3200a2015-01-25T08:00:00Z" } }, { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ImaHeader": "test", "ImaHeaderLocation": "abc", "Str": "", "Num": 123, "FalseBool": false, "TrueBool": true, "Float": 1.2, "Double": 1.3, "Long": 200, "Char": "a", "Timestamp": 1422172800 }, "response": { "status_code": 200, "headers": { "ImaHeader": "test", "X-Foo": "abc" }, "body": "123falsetrue1.21.3200a2015-01-25T08:00:00Z" } } ] }, { "description": "Blob", "metadata": { "protocol": "rest-xml" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Blob": { "shape": "BlobType" } } }, "BlobType": { "type": "blob" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Blob": "value" }, "response": { "status_code": 200, "headers": {}, "body": "dmFsdWU=" } } ] }, { "description": "Lists", "metadata": { "protocol": "rest-xml" }, "shapes": { "OutputShape": { "type": "structure", "members": { "ListMember": { "shape": "ListShape" } } }, "ListShape": { "type": "list", "member": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ListMember": ["abc", "123"] }, "response": { "status_code": 200, "headers": {}, "body": "abc123" } } ] }, { "description": "List with custom member name", "metadata": { "protocol": "rest-xml" }, "shapes": { "OutputShape": { "type": "structure", "members": { "ListMember": { "shape": "ListShape" } } }, "ListShape": { "type": "list", "member": { "shape": "StringType", "locationName": "item" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ListMember": ["abc", "123"] }, "response": { "status_code": 200, "headers": {}, "body": "abc123" } } ] }, { "description": "Flattened List", "metadata": { "protocol": "rest-xml" }, "shapes": { "OutputShape": { "type": "structure", "members": { "ListMember": { "shape": "StringList", "flattened": true } } }, "StringList": { "type": "list", "member": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ListMember": ["abc", "123"] }, "response": { "status_code": 200, "headers": {}, "body": "abc123" } } ] }, { "description": "Normal map", "metadata": { "protocol": "rest-xml" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Map": { "shape": "StringMap" } } }, "StringMap": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "SingleStructure" } }, "SingleStructure": { "type": "structure", "members": { "foo": { "shape": "StringType" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Map": { "qux": { "foo": "bar" }, "baz": { "foo": "bam" } } }, "response": { "status_code": 200, "headers": {}, "body": "quxbarbazbam" } } ] }, { "description": "Flattened map", "metadata": { "protocol": "rest-xml" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Map": { "shape": "StringMap", "flattened": true } } }, "StringMap": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Map": { "qux": "bar", "baz": "bam" } }, "response": { "status_code": 200, "headers": {}, "body": "quxbarbazbam" } } ] }, { "description": "Named map", "metadata": { "protocol": "rest-xml" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Map": { "shape": "StringMap" } } }, "StringMap": { "type": "map", "key": { "shape": "StringType", "locationName": "foo" }, "value": { "shape": "StringType", "locationName": "bar" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Map": { "qux": "bar", "baz": "bam" } }, "response": { "status_code": 200, "headers": {}, "body": "quxbarbazbam" } } ] }, { "description": "XML payload", "metadata": { "protocol": "rest-xml" }, "shapes": { "OutputShape": { "type": "structure", "payload": "Data", "members": { "Header": { "shape": "StringType", "location": "header", "locationName": "X-Foo" }, "Data": { "shape": "SingleStructure" } } }, "StringType": { "type": "string" }, "SingleStructure": { "type": "structure", "members": { "Foo": { "shape": "StringType" } } } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Header": "baz", "Data": { "Foo": "abc" } }, "response": { "status_code": 200, "headers": { "X-Foo": "baz" }, "body": "abc" } } ] }, { "description": "Streaming payload", "metadata": { "protocol": "rest-xml" }, "shapes": { "OutputShape": { "type": "structure", "payload": "Stream", "members": { "Stream": { "shape": "BlobStream" } } }, "BlobStream": { "type": "blob" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Stream": "abc" }, "response": { "status_code": 200, "headers": {}, "body": "abc" } } ] }, { "description": "Scalar members in headers", "metadata": { "protocol": "rest-xml" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Str": { "locationName": "x-str", "shape": "StringHeaderType" }, "Integer": { "locationName": "x-int", "shape": "IntegerHeaderType" }, "TrueBool": { "locationName": "x-true-bool", "shape": "BooleanHeaderType" }, "FalseBool": { "locationName": "x-false-bool", "shape": "BooleanHeaderType" }, "Float": { "locationName": "x-float", "shape": "FloatHeaderType" }, "Double": { "locationName": "x-double", "shape": "DoubleHeaderType" }, "Long": { "locationName": "x-long", "shape": "LongHeaderType" }, "Char": { "locationName": "x-char", "shape": "CharHeaderType" }, "Timestamp": { "locationName": "x-timestamp", "shape": "TimestampHeaderType" } } }, "StringHeaderType": { "location": "header", "type": "string" }, "IntegerHeaderType": { "location": "header", "type": "integer" }, "BooleanHeaderType": { "location": "header", "type": "boolean" }, "FloatHeaderType": { "location": "header", "type": "float" }, "DoubleHeaderType": { "location": "header", "type": "double" }, "LongHeaderType": { "location": "header", "type": "long" }, "CharHeaderType": { "location": "header", "type": "character" }, "TimestampHeaderType": { "location": "header", "type": "timestamp" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Str": "string", "Integer": 1, "TrueBool": true, "FalseBool": false, "Float": 1.5, "Double": 1.5, "Long": 100, "Char": "a", "Timestamp": 1422172800 }, "response": { "status_code": 200, "headers": { "x-str": "string", "x-int": "1", "x-true-bool": "true", "x-false-bool": "false", "x-float": "1.5", "x-double": "1.5", "x-long": "100", "x-char": "a", "x-timestamp": "Sun, 25 Jan 2015 08:00:00 GMT" }, "body": "" } } ] }, { "description": "Empty string", "metadata": { "protocol": "rest-xml" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Foo": { "shape": "StringType" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Foo": "" }, "response": { "status_code": 200, "headers": {}, "body": "requestid" } } ] }, { "description": "Parse XML Attributes", "metadata": { "protocol": "rest-xml" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Grants": { "shape": "Grants", "locationName": "AccessControlList" } } }, "Grants": { "type": "list", "member": { "shape": "Grant" } }, "Grant": { "type": "structure", "members": { "Grantee": {"shape": "Grantee"} } }, "Grantee": { "type": "structure", "members": { "DisplayName": {"shape": "String"}, "ID": {"shape": "String"}, "Type": { "shape": "String", "locationName": "xsi:type", "xmlAttribute": true } } }, "String": {"type": "string"} }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Grants": [ { "Grantee": { "DisplayName": "name", "ID": "id", "Type": "CanonicalUser" } } ] }, "response": { "status_code": 200, "headers": {}, "body": "id name" } } ] } ] botocore-1.5.7/tests/unit/protocols/output/ec2.json0000666454262600001440000002321413042511306023460 0ustar pysdk-ciamazon00000000000000[ { "description": "Scalar members", "metadata": { "protocol": "ec2" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Str": { "shape": "StringType" }, "Num": { "shape": "IntegerType", "locationName": "FooNum" }, "FalseBool": { "shape": "BooleanType" }, "TrueBool": { "shape": "BooleanType" }, "Float": { "shape": "FloatType" }, "Double": { "shape": "DoubleType" }, "Long": { "shape": "LongType" }, "Char": { "shape": "CharType" } } }, "StringType": { "type": "string" }, "IntegerType": { "type": "integer" }, "BooleanType": { "type": "boolean" }, "FloatType": { "type": "float" }, "DoubleType": { "type": "double" }, "LongType": { "type": "long" }, "CharType": { "type": "character" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Str": "myname", "Num": 123, "FalseBool": false, "TrueBool": true, "Float": 1.2, "Double": 1.3, "Long": 200, "Char": "a" }, "response": { "status_code": 200, "headers": {}, "body": "myname123falsetrue1.21.3200arequest-id" } } ] }, { "description": "Blob", "metadata": { "protocol": "ec2" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Blob": { "shape": "BlobType" } } }, "BlobType": { "type": "blob" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Blob": "value" }, "response": { "status_code": 200, "headers": {}, "body": "dmFsdWU=requestid" } } ] }, { "description": "Lists", "metadata": { "protocol": "ec2" }, "shapes": { "OutputShape": { "type": "structure", "members": { "ListMember": { "shape": "ListShape" } } }, "ListShape": { "type": "list", "member": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ListMember": ["abc", "123"] }, "response": { "status_code": 200, "headers": {}, "body": "abc123requestid" } } ] }, { "description": "List with custom member name", "metadata": { "protocol": "ec2" }, "shapes": { "OutputShape": { "type": "structure", "members": { "ListMember": { "shape": "ListShape" } } }, "ListShape": { "type": "list", "member": { "shape": "StringType", "locationName": "item" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ListMember": ["abc", "123"] }, "response": { "status_code": 200, "headers": {}, "body": "abc123requestid" } } ] }, { "description": "Flattened List", "metadata": { "protocol": "ec2" }, "shapes": { "OutputShape": { "type": "structure", "members": { "ListMember": { "shape": "ListType", "flattened": true } } }, "ListType": { "type": "list", "member": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "ListMember": ["abc", "123"] }, "response": { "status_code": 200, "headers": {}, "body": "abc123requestid" } } ] }, { "description": "Normal map", "metadata": { "protocol": "ec2" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Map": { "shape": "MapType" } } }, "MapType": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "StructureType" } }, "StructureType": { "type": "structure", "members": { "foo": { "shape": "StringType" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Map": { "qux": { "foo": "bar" }, "baz": { "foo": "bam" } } }, "response": { "status_code": 200, "headers": {}, "body": "quxbarbazbamrequestid" } } ] }, { "description": "Flattened map", "metadata": { "protocol": "ec2" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Map": { "shape": "MapType", "flattened": true } } }, "MapType": { "type": "map", "key": { "shape": "StringType" }, "value": { "shape": "StringType" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Map": { "qux": "bar", "baz": "bam" } }, "response": { "status_code": 200, "headers": {}, "body": "quxbarbazbamrequestid" } } ] }, { "description": "Named map", "metadata": { "protocol": "ec2" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Map": { "shape": "MapType", "flattened": true } } }, "MapType": { "type": "map", "key": { "shape": "StringType", "locationName": "foo" }, "value": { "shape": "StringType", "locationName": "bar" } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Map": { "qux": "bar", "baz": "bam" } }, "response": { "status_code": 200, "headers": {}, "body": "quxbarbazbamrequestid" } } ] }, { "description": "Empty string", "metadata": { "protocol": "ec2" }, "shapes": { "OutputShape": { "type": "structure", "members": { "Foo": { "shape": "StringType" } } }, "StringType": { "type": "string" } }, "cases": [ { "given": { "output": { "shape": "OutputShape" }, "name": "OperationName" }, "result": { "Foo": "" }, "response": { "status_code": 200, "headers": {}, "body": "requestid" } } ] } ] botocore-1.5.7/tests/unit/test_utils.py0000666454262600001440000015573713042511306021321 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest from dateutil.tz import tzutc, tzoffset import datetime import six import mock from botocore import xform_name from botocore.compat import OrderedDict, json from botocore.awsrequest import AWSRequest from botocore.exceptions import InvalidExpressionError, ConfigNotFound from botocore.exceptions import ClientError from botocore.exceptions import InvalidDNSNameError, MetadataRetrievalError from botocore.model import ServiceModel from botocore.vendored import requests from botocore.utils import remove_dot_segments from botocore.utils import normalize_url_path from botocore.utils import validate_jmespath_for_set from botocore.utils import set_value_from_jmespath from botocore.utils import parse_key_val_file_contents from botocore.utils import parse_key_val_file from botocore.utils import parse_timestamp from botocore.utils import parse_to_aware_datetime from botocore.utils import datetime2timestamp from botocore.utils import CachedProperty from botocore.utils import ArgumentGenerator from botocore.utils import calculate_tree_hash from botocore.utils import calculate_sha256 from botocore.utils import is_valid_endpoint_url from botocore.utils import fix_s3_host from botocore.utils import switch_to_virtual_host_style from botocore.utils import instance_cache from botocore.utils import merge_dicts from botocore.utils import get_service_module_name from botocore.utils import percent_encode_sequence from botocore.utils import switch_host_s3_accelerate from botocore.utils import deep_merge from botocore.utils import S3RegionRedirector from botocore.utils import ContainerMetadataFetcher from botocore.model import DenormalizedStructureBuilder from botocore.model import ShapeResolver from botocore.config import Config class TestURINormalization(unittest.TestCase): def test_remove_dot_segments(self): self.assertEqual(remove_dot_segments('../foo'), 'foo') self.assertEqual(remove_dot_segments('../../foo'), 'foo') self.assertEqual(remove_dot_segments('./foo'), 'foo') self.assertEqual(remove_dot_segments('/./'), '/') self.assertEqual(remove_dot_segments('/../'), '/') self.assertEqual(remove_dot_segments('/foo/bar/baz/../qux'), '/foo/bar/qux') self.assertEqual(remove_dot_segments('/foo/..'), '/') self.assertEqual(remove_dot_segments('foo/bar/baz'), 'foo/bar/baz') self.assertEqual(remove_dot_segments('..'), '') self.assertEqual(remove_dot_segments('.'), '') self.assertEqual(remove_dot_segments('/.'), '/') self.assertEqual(remove_dot_segments('/.foo'), '/.foo') self.assertEqual(remove_dot_segments('/..foo'), '/..foo') self.assertEqual(remove_dot_segments(''), '') self.assertEqual(remove_dot_segments('/a/b/c/./../../g'), '/a/g') self.assertEqual(remove_dot_segments('mid/content=5/../6'), 'mid/6') # I don't think this is RFC compliant... self.assertEqual(remove_dot_segments('//foo//'), '/foo/') def test_empty_url_normalization(self): self.assertEqual(normalize_url_path(''), '/') class TestTransformName(unittest.TestCase): def test_upper_camel_case(self): self.assertEqual(xform_name('UpperCamelCase'), 'upper_camel_case') self.assertEqual(xform_name('UpperCamelCase', '-'), 'upper-camel-case') def test_lower_camel_case(self): self.assertEqual(xform_name('lowerCamelCase'), 'lower_camel_case') self.assertEqual(xform_name('lowerCamelCase', '-'), 'lower-camel-case') def test_consecutive_upper_case(self): self.assertEqual(xform_name('HTTPHeaders'), 'http_headers') self.assertEqual(xform_name('HTTPHeaders', '-'), 'http-headers') def test_consecutive_upper_case_middle_string(self): self.assertEqual(xform_name('MainHTTPHeaders'), 'main_http_headers') self.assertEqual(xform_name('MainHTTPHeaders', '-'), 'main-http-headers') def test_s3_prefix(self): self.assertEqual(xform_name('S3BucketName'), 's3_bucket_name') def test_already_snake_cased(self): self.assertEqual(xform_name('leave_alone'), 'leave_alone') self.assertEqual(xform_name('s3_bucket_name'), 's3_bucket_name') self.assertEqual(xform_name('bucket_s3_name'), 'bucket_s3_name') def test_special_cases(self): # Some patterns don't actually match the rules we expect. self.assertEqual(xform_name('SwapEnvironmentCNAMEs'), 'swap_environment_cnames') self.assertEqual(xform_name('SwapEnvironmentCNAMEs', '-'), 'swap-environment-cnames') self.assertEqual(xform_name('CreateCachediSCSIVolume', '-'), 'create-cached-iscsi-volume') self.assertEqual(xform_name('DescribeCachediSCSIVolumes', '-'), 'describe-cached-iscsi-volumes') self.assertEqual(xform_name('DescribeStorediSCSIVolumes', '-'), 'describe-stored-iscsi-volumes') self.assertEqual(xform_name('CreateStorediSCSIVolume', '-'), 'create-stored-iscsi-volume') def test_special_case_ends_with_s(self): self.assertEqual(xform_name('GatewayARNs', '-'), 'gateway-arns') def test_partial_rename(self): transformed = xform_name('IPV6', '-') self.assertEqual(transformed, 'ipv6') transformed = xform_name('IPV6', '_') self.assertEqual(transformed, 'ipv6') class TestValidateJMESPathForSet(unittest.TestCase): def setUp(self): super(TestValidateJMESPathForSet, self).setUp() self.data = { 'Response': { 'Thing': { 'Id': 1, 'Name': 'Thing #1', } }, 'Marker': 'some-token' } def test_invalid_exp(self): with self.assertRaises(InvalidExpressionError): validate_jmespath_for_set('Response.*.Name') with self.assertRaises(InvalidExpressionError): validate_jmespath_for_set('Response.Things[0]') with self.assertRaises(InvalidExpressionError): validate_jmespath_for_set('') with self.assertRaises(InvalidExpressionError): validate_jmespath_for_set('.') class TestSetValueFromJMESPath(unittest.TestCase): def setUp(self): super(TestSetValueFromJMESPath, self).setUp() self.data = { 'Response': { 'Thing': { 'Id': 1, 'Name': 'Thing #1', } }, 'Marker': 'some-token' } def test_single_depth_existing(self): set_value_from_jmespath(self.data, 'Marker', 'new-token') self.assertEqual(self.data['Marker'], 'new-token') def test_single_depth_new(self): self.assertFalse('Limit' in self.data) set_value_from_jmespath(self.data, 'Limit', 100) self.assertEqual(self.data['Limit'], 100) def test_multiple_depth_existing(self): set_value_from_jmespath(self.data, 'Response.Thing.Name', 'New Name') self.assertEqual(self.data['Response']['Thing']['Name'], 'New Name') def test_multiple_depth_new(self): self.assertFalse('Brand' in self.data) set_value_from_jmespath(self.data, 'Brand.New', {'abc': 123}) self.assertEqual(self.data['Brand']['New']['abc'], 123) class TestParseEC2CredentialsFile(unittest.TestCase): def test_parse_ec2_content(self): contents = "AWSAccessKeyId=a\nAWSSecretKey=b\n" self.assertEqual(parse_key_val_file_contents(contents), {'AWSAccessKeyId': 'a', 'AWSSecretKey': 'b'}) def test_parse_ec2_content_empty(self): contents = "" self.assertEqual(parse_key_val_file_contents(contents), {}) def test_key_val_pair_with_blank_lines(self): # The \n\n has an extra blank between the access/secret keys. contents = "AWSAccessKeyId=a\n\nAWSSecretKey=b\n" self.assertEqual(parse_key_val_file_contents(contents), {'AWSAccessKeyId': 'a', 'AWSSecretKey': 'b'}) def test_key_val_parser_lenient(self): # Ignore any line that does not have a '=' char in it. contents = "AWSAccessKeyId=a\nNOTKEYVALLINE\nAWSSecretKey=b\n" self.assertEqual(parse_key_val_file_contents(contents), {'AWSAccessKeyId': 'a', 'AWSSecretKey': 'b'}) def test_multiple_equals_on_line(self): contents = "AWSAccessKeyId=a\nAWSSecretKey=secret_key_with_equals=b\n" self.assertEqual(parse_key_val_file_contents(contents), {'AWSAccessKeyId': 'a', 'AWSSecretKey': 'secret_key_with_equals=b'}) def test_os_error_raises_config_not_found(self): mock_open = mock.Mock() mock_open.side_effect = OSError() with self.assertRaises(ConfigNotFound): parse_key_val_file('badfile', _open=mock_open) class TestParseTimestamps(unittest.TestCase): def test_parse_iso8601(self): self.assertEqual( parse_timestamp('1970-01-01T00:10:00.000Z'), datetime.datetime(1970, 1, 1, 0, 10, tzinfo=tzutc())) def test_parse_epoch(self): self.assertEqual( parse_timestamp(1222172800), datetime.datetime(2008, 9, 23, 12, 26, 40, tzinfo=tzutc())) def test_parse_epoch_zero_time(self): self.assertEqual( parse_timestamp(0), datetime.datetime(1970, 1, 1, 0, 0, 0, tzinfo=tzutc())) def test_parse_epoch_as_string(self): self.assertEqual( parse_timestamp('1222172800'), datetime.datetime(2008, 9, 23, 12, 26, 40, tzinfo=tzutc())) def test_parse_rfc822(self): self.assertEqual( parse_timestamp('Wed, 02 Oct 2002 13:00:00 GMT'), datetime.datetime(2002, 10, 2, 13, 0, tzinfo=tzutc())) def test_parse_gmt_in_uk_time(self): # In the UK the time switches from GMT to BST and back as part of # their daylight savings time. time.tzname will therefore report # both time zones. dateutil sees that the time zone is a local time # zone and so parses it as local time, but it ends up being BST # instead of GMT. To remedy this issue we can provide a time zone # context which will enforce GMT == UTC. with mock.patch('time.tzname', ('GMT', 'BST')): self.assertEqual( parse_timestamp('Wed, 02 Oct 2002 13:00:00 GMT'), datetime.datetime(2002, 10, 2, 13, 0, tzinfo=tzutc())) def test_parse_invalid_timestamp(self): with self.assertRaises(ValueError): parse_timestamp('invalid date') class TestDatetime2Timestamp(unittest.TestCase): def test_datetime2timestamp_naive(self): self.assertEqual( datetime2timestamp(datetime.datetime(1970, 1, 2)), 86400) def test_datetime2timestamp_aware(self): tzinfo = tzoffset("BRST", -10800) self.assertEqual( datetime2timestamp(datetime.datetime(1970, 1, 2, tzinfo=tzinfo)), 97200) class TestParseToUTCDatetime(unittest.TestCase): def test_handles_utc_time(self): original = datetime.datetime(1970, 1, 1, 0, 0, 0, tzinfo=tzutc()) self.assertEqual(parse_to_aware_datetime(original), original) def test_handles_other_timezone(self): tzinfo = tzoffset("BRST", -10800) original = datetime.datetime(2014, 1, 1, 0, 0, 0, tzinfo=tzinfo) self.assertEqual(parse_to_aware_datetime(original), original) def test_handles_naive_datetime(self): original = datetime.datetime(1970, 1, 1, 0, 0, 0) expected = datetime.datetime(1970, 1, 1, 0, 0, 0, tzinfo=tzutc()) self.assertEqual(parse_to_aware_datetime(original), expected) def test_handles_string_epoch(self): expected = datetime.datetime(1970, 1, 1, 0, 0, 0, tzinfo=tzutc()) self.assertEqual(parse_to_aware_datetime('0'), expected) def test_handles_int_epoch(self): expected = datetime.datetime(1970, 1, 1, 0, 0, 0, tzinfo=tzutc()) self.assertEqual(parse_to_aware_datetime(0), expected) def test_handles_full_iso_8601(self): expected = datetime.datetime(1970, 1, 1, 0, 0, 0, tzinfo=tzutc()) self.assertEqual( parse_to_aware_datetime('1970-01-01T00:00:00Z'), expected) def test_year_only_iso_8601(self): expected = datetime.datetime(1970, 1, 1, 0, 0, 0, tzinfo=tzutc()) self.assertEqual(parse_to_aware_datetime('1970-01-01'), expected) class TestCachedProperty(unittest.TestCase): def test_cached_property_same_value(self): class CacheMe(object): @CachedProperty def foo(self): return 'foo' c = CacheMe() self.assertEqual(c.foo, 'foo') self.assertEqual(c.foo, 'foo') def test_cached_property_only_called_once(self): # Note: you would normally never want to cache # a property that returns a new value each time, # but this is done to demonstrate the caching behavior. class NoIncrement(object): def __init__(self): self.counter = 0 @CachedProperty def current_value(self): self.counter += 1 return self.counter c = NoIncrement() self.assertEqual(c.current_value, 1) # If the property wasn't cached, the next value should be # be 2, but because it's cached, we know the value will be 1. self.assertEqual(c.current_value, 1) class TestArgumentGenerator(unittest.TestCase): def setUp(self): self.arg_generator = ArgumentGenerator() def assert_skeleton_from_model_is(self, model, generated_skeleton): shape = DenormalizedStructureBuilder().with_members( model).build_model() actual = self.arg_generator.generate_skeleton(shape) self.assertEqual(actual, generated_skeleton) def test_generate_string(self): self.assert_skeleton_from_model_is( model={ 'A': {'type': 'string'} }, generated_skeleton={ 'A': '' } ) def test_generate_scalars(self): self.assert_skeleton_from_model_is( model={ 'A': {'type': 'string'}, 'B': {'type': 'integer'}, 'C': {'type': 'float'}, 'D': {'type': 'boolean'}, 'E': {'type': 'timestamp'} }, generated_skeleton={ 'A': '', 'B': 0, 'C': 0.0, 'D': True, 'E': datetime.datetime(1970, 1, 1, 0, 0, 0) } ) def test_will_use_member_names_for_string_values(self): self.arg_generator = ArgumentGenerator(use_member_names=True) self.assert_skeleton_from_model_is( model={ 'A': {'type': 'string'}, 'B': {'type': 'integer'}, 'C': {'type': 'float'}, 'D': {'type': 'boolean'}, }, generated_skeleton={ 'A': 'A', 'B': 0, 'C': 0.0, 'D': True, } ) def test_will_use_member_names_for_string_values_of_list(self): self.arg_generator = ArgumentGenerator(use_member_names=True) # We're not using assert_skeleton_from_model_is # because we can't really control the name of strings shapes # being used in the DenormalizedStructureBuilder. We can only # control the name of structures and list shapes. shape_map = ShapeResolver({ 'InputShape': { 'type': 'structure', 'members': { 'StringList': {'shape': 'StringList'}, } }, 'StringList': { 'type': 'list', 'member': {'shape': 'StringType'}, }, 'StringType': { 'type': 'string', } }) shape = shape_map.get_shape_by_name('InputShape') actual = self.arg_generator.generate_skeleton(shape) expected = {'StringList': ['StringType']} self.assertEqual(actual, expected) def test_generate_nested_structure(self): self.assert_skeleton_from_model_is( model={ 'A': { 'type': 'structure', 'members': { 'B': {'type': 'string'}, } } }, generated_skeleton={ 'A': {'B': ''} } ) def test_generate_scalar_list(self): self.assert_skeleton_from_model_is( model={ 'A': { 'type': 'list', 'member': { 'type': 'string' } }, }, generated_skeleton={ 'A': [''], } ) def test_generate_scalar_map(self): self.assert_skeleton_from_model_is( model={ 'A': { 'type': 'map', 'key': {'type': 'string'}, 'value': {'type': 'string'}, } }, generated_skeleton={ 'A': { 'KeyName': '', } } ) def test_handles_recursive_shapes(self): # We're not using assert_skeleton_from_model_is # because we can't use a DenormalizedStructureBuilder, # we need a normalized model to represent recursive # shapes. shape_map = ShapeResolver({ 'InputShape': { 'type': 'structure', 'members': { 'A': {'shape': 'RecursiveStruct'}, 'B': {'shape': 'StringType'}, } }, 'RecursiveStruct': { 'type': 'structure', 'members': { 'C': {'shape': 'RecursiveStruct'}, 'D': {'shape': 'StringType'}, } }, 'StringType': { 'type': 'string', } }) shape = shape_map.get_shape_by_name('InputShape') actual = self.arg_generator.generate_skeleton(shape) expected = { 'A': { 'C': { # For recurisve shapes, we'll just show # an empty dict. }, 'D': '' }, 'B': '' } self.assertEqual(actual, expected) class TestChecksums(unittest.TestCase): def test_empty_hash(self): self.assertEqual( calculate_sha256(six.BytesIO(b''), as_hex=True), 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855') def test_as_hex(self): self.assertEqual( calculate_sha256(six.BytesIO(b'hello world'), as_hex=True), 'b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9') def test_as_binary(self): self.assertEqual( calculate_sha256(six.BytesIO(b'hello world'), as_hex=False), (b"\xb9M'\xb9\x93M>\x08\xa5.R\xd7\xda}\xab\xfa\xc4\x84\xef" b"\xe3zS\x80\xee\x90\x88\xf7\xac\xe2\xef\xcd\xe9")) class TestTreeHash(unittest.TestCase): # Note that for these tests I've independently verified # what the expected tree hashes should be from other # SDK implementations. def test_empty_tree_hash(self): self.assertEqual( calculate_tree_hash(six.BytesIO(b'')), 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855') def test_tree_hash_less_than_one_mb(self): one_k = six.BytesIO(b'a' * 1024) self.assertEqual( calculate_tree_hash(one_k), '2edc986847e209b4016e141a6dc8716d3207350f416969382d431539bf292e4a') def test_tree_hash_exactly_one_mb(self): one_meg_bytestring = b'a' * (1 * 1024 * 1024) one_meg = six.BytesIO(one_meg_bytestring) self.assertEqual( calculate_tree_hash(one_meg), '9bc1b2a288b26af7257a36277ae3816a7d4f16e89c1e7e77d0a5c48bad62b360') def test_tree_hash_multiple_of_one_mb(self): four_mb = six.BytesIO(b'a' * (4 * 1024 * 1024)) self.assertEqual( calculate_tree_hash(four_mb), '9491cb2ed1d4e7cd53215f4017c23ec4ad21d7050a1e6bb636c4f67e8cddb844') def test_tree_hash_offset_of_one_mb_multiple(self): offset_four_mb = six.BytesIO(b'a' * (4 * 1024 * 1024) + b'a' * 20) self.assertEqual( calculate_tree_hash(offset_four_mb), '12f3cbd6101b981cde074039f6f728071da8879d6f632de8afc7cdf00661b08f') class TestIsValidEndpointURL(unittest.TestCase): def test_dns_name_is_valid(self): self.assertTrue(is_valid_endpoint_url('https://s3.amazonaws.com/')) def test_ip_address_is_allowed(self): self.assertTrue(is_valid_endpoint_url('https://10.10.10.10/')) def test_path_component_ignored(self): self.assertTrue( is_valid_endpoint_url('https://foo.bar.com/other/path/')) def test_can_have_port(self): self.assertTrue(is_valid_endpoint_url('https://foo.bar.com:12345/')) def test_ip_can_have_port(self): self.assertTrue(is_valid_endpoint_url('https://10.10.10.10:12345/')) def test_cannot_have_spaces(self): self.assertFalse(is_valid_endpoint_url('https://my invalid name/')) def test_missing_scheme(self): self.assertFalse(is_valid_endpoint_url('foo.bar.com')) def test_no_new_lines(self): self.assertFalse(is_valid_endpoint_url('https://foo.bar.com\nbar/')) def test_long_hostname(self): long_hostname = 'htps://%s.com' % ('a' * 256) self.assertFalse(is_valid_endpoint_url(long_hostname)) def test_hostname_can_end_with_dot(self): self.assertTrue(is_valid_endpoint_url('https://foo.bar.com./')) def test_hostname_no_dots(self): self.assertTrue(is_valid_endpoint_url('https://foo/')) class TestFixS3Host(unittest.TestCase): def test_fix_s3_host_initial(self): request = AWSRequest( method='PUT', headers={}, url='https://s3-us-west-2.amazonaws.com/bucket/key.txt' ) region_name = 'us-west-2' signature_version = 's3' fix_s3_host( request=request, signature_version=signature_version, region_name=region_name) self.assertEqual(request.url, 'https://bucket.s3.amazonaws.com/key.txt') self.assertEqual(request.auth_path, '/bucket/key.txt') def test_fix_s3_host_only_applied_once(self): request = AWSRequest( method='PUT', headers={}, url='https://s3-us-west-2.amazonaws.com/bucket/key.txt' ) region_name = 'us-west-2' signature_version = 's3' fix_s3_host( request=request, signature_version=signature_version, region_name=region_name) # Calling the handler again should not affect the end result: fix_s3_host( request=request, signature_version=signature_version, region_name=region_name) self.assertEqual(request.url, 'https://bucket.s3.amazonaws.com/key.txt') # This was a bug previously. We want to make sure that # calling fix_s3_host() again does not alter the auth_path. # Otherwise we'll get signature errors. self.assertEqual(request.auth_path, '/bucket/key.txt') def test_dns_style_not_used_for_get_bucket_location(self): original_url = 'https://s3-us-west-2.amazonaws.com/bucket?location' request = AWSRequest( method='GET', headers={}, url=original_url, ) signature_version = 's3' region_name = 'us-west-2' fix_s3_host( request=request, signature_version=signature_version, region_name=region_name) # The request url should not have been modified because this is # a request for GetBucketLocation. self.assertEqual(request.url, original_url) def test_can_provide_default_endpoint_url(self): request = AWSRequest( method='PUT', headers={}, url='https://s3-us-west-2.amazonaws.com/bucket/key.txt' ) region_name = 'us-west-2' signature_version = 's3' fix_s3_host( request=request, signature_version=signature_version, region_name=region_name, default_endpoint_url='foo.s3.amazonaws.com') self.assertEqual(request.url, 'https://bucket.foo.s3.amazonaws.com/key.txt') def test_no_endpoint_url_uses_request_url(self): request = AWSRequest( method='PUT', headers={}, url='https://s3-us-west-2.amazonaws.com/bucket/key.txt' ) region_name = 'us-west-2' signature_version = 's3' fix_s3_host( request=request, signature_version=signature_version, region_name=region_name, # A value of None means use the url in the current request. default_endpoint_url=None, ) self.assertEqual(request.url, 'https://bucket.s3-us-west-2.amazonaws.com/key.txt') class TestSwitchToVirtualHostStyle(unittest.TestCase): def test_switch_to_virtual_host_style(self): request = AWSRequest( method='PUT', headers={}, url='https://foo.amazonaws.com/bucket/key.txt' ) region_name = 'us-west-2' signature_version = 's3' switch_to_virtual_host_style( request=request, signature_version=signature_version, region_name=region_name) self.assertEqual(request.url, 'https://bucket.foo.amazonaws.com/key.txt') self.assertEqual(request.auth_path, '/bucket/key.txt') def test_uses_default_endpoint(self): request = AWSRequest( method='PUT', headers={}, url='https://foo.amazonaws.com/bucket/key.txt' ) region_name = 'us-west-2' signature_version = 's3' switch_to_virtual_host_style( request=request, signature_version=signature_version, region_name=region_name, default_endpoint_url='s3.amazonaws.com') self.assertEqual(request.url, 'https://bucket.s3.amazonaws.com/key.txt') self.assertEqual(request.auth_path, '/bucket/key.txt') def test_throws_invalid_dns_name_error(self): request = AWSRequest( method='PUT', headers={}, url='https://foo.amazonaws.com/mybucket.foo/key.txt' ) region_name = 'us-west-2' signature_version = 's3' with self.assertRaises(InvalidDNSNameError): switch_to_virtual_host_style( request=request, signature_version=signature_version, region_name=region_name) def test_fix_s3_host_only_applied_once(self): request = AWSRequest( method='PUT', headers={}, url='https://foo.amazonaws.com/bucket/key.txt' ) region_name = 'us-west-2' signature_version = 's3' switch_to_virtual_host_style( request=request, signature_version=signature_version, region_name=region_name) # Calling the handler again should not affect the end result: switch_to_virtual_host_style( request=request, signature_version=signature_version, region_name=region_name) self.assertEqual(request.url, 'https://bucket.foo.amazonaws.com/key.txt') # This was a bug previously. We want to make sure that # calling fix_s3_host() again does not alter the auth_path. # Otherwise we'll get signature errors. self.assertEqual(request.auth_path, '/bucket/key.txt') def test_virtual_host_style_for_make_bucket(self): request = AWSRequest( method='PUT', headers={}, url='https://foo.amazonaws.com/bucket' ) region_name = 'us-west-2' signature_version = 's3' switch_to_virtual_host_style( request=request, signature_version=signature_version, region_name=region_name) self.assertEqual(request.url, 'https://bucket.foo.amazonaws.com/') def test_virtual_host_style_not_used_for_get_bucket_location(self): original_url = 'https://foo.amazonaws.com/bucket?location' request = AWSRequest( method='GET', headers={}, url=original_url, ) signature_version = 's3' region_name = 'us-west-2' switch_to_virtual_host_style( request=request, signature_version=signature_version, region_name=region_name) # The request url should not have been modified because this is # a request for GetBucketLocation. self.assertEqual(request.url, original_url) def test_virtual_host_style_not_used_for_list_buckets(self): original_url = 'https://foo.amazonaws.com/' request = AWSRequest( method='GET', headers={}, url=original_url, ) signature_version = 's3' region_name = 'us-west-2' switch_to_virtual_host_style( request=request, signature_version=signature_version, region_name=region_name) # The request url should not have been modified because this is # a request for GetBucketLocation. self.assertEqual(request.url, original_url) def test_is_unaffected_by_sigv4(self): request = AWSRequest( method='PUT', headers={}, url='https://foo.amazonaws.com/bucket/key.txt' ) region_name = 'us-west-2' signature_version = 's3v4' switch_to_virtual_host_style( request=request, signature_version=signature_version, region_name=region_name, default_endpoint_url='s3.amazonaws.com') self.assertEqual(request.url, 'https://bucket.s3.amazonaws.com/key.txt') class TestInstanceCache(unittest.TestCase): class DummyClass(object): def __init__(self, cache): self._instance_cache = cache @instance_cache def add(self, x, y): return x + y @instance_cache def sub(self, x, y): return x - y def setUp(self): self.cache = {} def test_cache_single_method_call(self): adder = self.DummyClass(self.cache) self.assertEqual(adder.add(2, 1), 3) # This should result in one entry in the cache. self.assertEqual(len(self.cache), 1) # When we call the method with the same args, # we should reuse the same entry in the cache. self.assertEqual(adder.add(2, 1), 3) self.assertEqual(len(self.cache), 1) def test_can_cache_multiple_methods(self): adder = self.DummyClass(self.cache) adder.add(2, 1) # A different method results in a new cache entry, # so now there should be two elements in the cache. self.assertEqual(adder.sub(2, 1), 1) self.assertEqual(len(self.cache), 2) self.assertEqual(adder.sub(2, 1), 1) def test_can_cache_kwargs(self): adder = self.DummyClass(self.cache) adder.add(x=2, y=1) self.assertEqual(adder.add(x=2, y=1), 3) self.assertEqual(len(self.cache), 1) class TestMergeDicts(unittest.TestCase): def test_merge_dicts_overrides(self): first = { 'foo': {'bar': {'baz': {'one': 'ORIGINAL', 'two': 'ORIGINAL'}}}} second = {'foo': {'bar': {'baz': {'one': 'UPDATE'}}}} merge_dicts(first, second) # The value from the second dict wins. self.assertEqual(first['foo']['bar']['baz']['one'], 'UPDATE') # And we still preserve the other attributes. self.assertEqual(first['foo']['bar']['baz']['two'], 'ORIGINAL') def test_merge_dicts_new_keys(self): first = { 'foo': {'bar': {'baz': {'one': 'ORIGINAL', 'two': 'ORIGINAL'}}}} second = {'foo': {'bar': {'baz': {'three': 'UPDATE'}}}} merge_dicts(first, second) self.assertEqual(first['foo']['bar']['baz']['one'], 'ORIGINAL') self.assertEqual(first['foo']['bar']['baz']['two'], 'ORIGINAL') self.assertEqual(first['foo']['bar']['baz']['three'], 'UPDATE') def test_merge_empty_dict_does_nothing(self): first = {'foo': {'bar': 'baz'}} merge_dicts(first, {}) self.assertEqual(first, {'foo': {'bar': 'baz'}}) def test_more_than_one_sub_dict(self): first = {'one': {'inner': 'ORIGINAL', 'inner2': 'ORIGINAL'}, 'two': {'inner': 'ORIGINAL', 'inner2': 'ORIGINAL'}} second = {'one': {'inner': 'UPDATE'}, 'two': {'inner': 'UPDATE'}} merge_dicts(first, second) self.assertEqual(first['one']['inner'], 'UPDATE') self.assertEqual(first['one']['inner2'], 'ORIGINAL') self.assertEqual(first['two']['inner'], 'UPDATE') self.assertEqual(first['two']['inner2'], 'ORIGINAL') def test_new_keys(self): first = {'one': {'inner': 'ORIGINAL'}, 'two': {'inner': 'ORIGINAL'}} second = {'three': {'foo': {'bar': 'baz'}}} # In this case, second has no keys in common, but we'd still expect # this to get merged. merge_dicts(first, second) self.assertEqual(first['three']['foo']['bar'], 'baz') def test_list_values_no_append(self): dict1 = {'Foo': ['old_foo_value']} dict2 = {'Foo': ['new_foo_value']} merge_dicts(dict1, dict2) self.assertEqual( dict1, {'Foo': ['new_foo_value']}) def test_list_values_append(self): dict1 = {'Foo': ['old_foo_value']} dict2 = {'Foo': ['new_foo_value']} merge_dicts(dict1, dict2, append_lists=True) self.assertEqual( dict1, {'Foo': ['old_foo_value', 'new_foo_value']}) def test_list_values_mismatching_types(self): dict1 = {'Foo': 'old_foo_value'} dict2 = {'Foo': ['new_foo_value']} merge_dicts(dict1, dict2, append_lists=True) self.assertEqual( dict1, {'Foo': ['new_foo_value']}) def test_list_values_missing_key(self): dict1 = {} dict2 = {'Foo': ['foo_value']} merge_dicts(dict1, dict2, append_lists=True) self.assertEqual( dict1, {'Foo': ['foo_value']}) class TestGetServiceModuleName(unittest.TestCase): def setUp(self): self.service_description = { 'metadata': { 'serviceFullName': 'AWS MyService', 'apiVersion': '2014-01-01', 'endpointPrefix': 'myservice', 'signatureVersion': 'v4', 'protocol': 'query' }, 'operations': {}, 'shapes': {}, } self.service_model = ServiceModel( self.service_description, 'myservice') def test_default(self): self.assertEqual( get_service_module_name(self.service_model), 'MyService' ) def test_client_name_with_amazon(self): self.service_description['metadata']['serviceFullName'] = ( 'Amazon MyService') self.assertEqual( get_service_module_name(self.service_model), 'MyService' ) def test_client_name_using_abreviation(self): self.service_description['metadata']['serviceAbbreviation'] = ( 'Abbreviation') self.assertEqual( get_service_module_name(self.service_model), 'Abbreviation' ) def test_client_name_with_non_alphabet_characters(self): self.service_description['metadata']['serviceFullName'] = ( 'Amazon My-Service') self.assertEqual( get_service_module_name(self.service_model), 'MyService' ) def test_client_name_with_no_full_name_or_abbreviation(self): del self.service_description['metadata']['serviceFullName'] self.assertEqual( get_service_module_name(self.service_model), 'myservice' ) class TestPercentEncodeSequence(unittest.TestCase): def test_percent_encode_empty(self): self.assertEqual(percent_encode_sequence({}), '') def test_percent_encode_special_chars(self): self.assertEqual( percent_encode_sequence({'k1': 'with spaces++/'}), 'k1=with%20spaces%2B%2B%2F') def test_percent_encode_string_string_tuples(self): self.assertEqual(percent_encode_sequence([('k1', 'v1'), ('k2', 'v2')]), 'k1=v1&k2=v2') def test_percent_encode_dict_single_pair(self): self.assertEqual(percent_encode_sequence({'k1': 'v1'}), 'k1=v1') def test_percent_encode_dict_string_string(self): self.assertEqual( percent_encode_sequence(OrderedDict([('k1', 'v1'), ('k2', 'v2')])), 'k1=v1&k2=v2') def test_percent_encode_single_list_of_values(self): self.assertEqual(percent_encode_sequence({'k1': ['a', 'b', 'c']}), 'k1=a&k1=b&k1=c') def test_percent_encode_list_values_of_string(self): self.assertEqual( percent_encode_sequence( OrderedDict([('k1', ['a', 'list']), ('k2', ['another', 'list'])])), 'k1=a&k1=list&k2=another&k2=list') class TestSwitchHostS3Accelerate(unittest.TestCase): def setUp(self): self.original_url = 'https://s3.amazonaws.com/foo/key.txt' self.request = AWSRequest( method='PUT', headers={}, url=self.original_url ) self.client_config = Config() self.request.context['client_config'] = self.client_config def test_switch_host(self): switch_host_s3_accelerate(self.request, 'PutObject') self.assertEqual( self.request.url, 'https://s3-accelerate.amazonaws.com/foo/key.txt') def test_do_not_switch_black_listed_operations(self): # It should not get switched for ListBuckets, DeleteBucket, and # CreateBucket blacklist_ops = [ 'ListBuckets', 'DeleteBucket', 'CreateBucket' ] for op_name in blacklist_ops: switch_host_s3_accelerate(self.request, op_name) self.assertEqual(self.request.url, self.original_url) def test_uses_original_endpoint_scheme(self): self.request.url = 'http://s3.amazonaws.com/foo/key.txt' switch_host_s3_accelerate(self.request, 'PutObject') self.assertEqual( self.request.url, 'http://s3-accelerate.amazonaws.com/foo/key.txt') def test_uses_dualstack(self): self.client_config.s3 = {'use_dualstack_endpoint': True} self.original_url = 'https://s3.dualstack.amazonaws.com/foo/key.txt' self.request = AWSRequest( method='PUT', headers={}, url=self.original_url ) self.request.context['client_config'] = self.client_config switch_host_s3_accelerate(self.request, 'PutObject') self.assertEqual( self.request.url, 'https://s3-accelerate.dualstack.amazonaws.com/foo/key.txt') class TestDeepMerge(unittest.TestCase): def test_simple_merge(self): a = {'key': 'value'} b = {'otherkey': 'othervalue'} deep_merge(a, b) expected = {'key': 'value', 'otherkey': 'othervalue'} self.assertEqual(a, expected) def test_merge_list(self): # Lists are treated as opaque data and so no effort should be made to # combine them. a = {'key': ['original']} b = {'key': ['new']} deep_merge(a, b) self.assertEqual(a, {'key': ['new']}) def test_merge_number(self): # The value from b is always taken a = {'key': 10} b = {'key': 45} deep_merge(a, b) self.assertEqual(a, {'key': 45}) a = {'key': 45} b = {'key': 10} deep_merge(a, b) self.assertEqual(a, {'key': 10}) def test_merge_boolean(self): # The value from b is always taken a = {'key': False} b = {'key': True} deep_merge(a, b) self.assertEqual(a, {'key': True}) a = {'key': True} b = {'key': False} deep_merge(a, b) self.assertEqual(a, {'key': False}) def test_merge_string(self): a = {'key': 'value'} b = {'key': 'othervalue'} deep_merge(a, b) self.assertEqual(a, {'key': 'othervalue'}) def test_merge_overrides_value(self): # The value from b is always taken, even when it's a different type a = {'key': 'original'} b = {'key': {'newkey': 'newvalue'}} deep_merge(a, b) self.assertEqual(a, {'key': {'newkey': 'newvalue'}}) a = {'key': {'anotherkey': 'value'}} b = {'key': 'newvalue'} deep_merge(a, b) self.assertEqual(a, {'key': 'newvalue'}) def test_deep_merge(self): a = { 'first': { 'second': { 'key': 'value', 'otherkey': 'othervalue' }, 'key': 'value' } } b = { 'first': { 'second': { 'otherkey': 'newvalue', 'yetanotherkey': 'yetanothervalue' } } } deep_merge(a, b) expected = { 'first': { 'second': { 'key': 'value', 'otherkey': 'newvalue', 'yetanotherkey': 'yetanothervalue' }, 'key': 'value' } } self.assertEqual(a, expected) class TestS3RegionRedirector(unittest.TestCase): def setUp(self): self.endpoint_bridge = mock.Mock() self.endpoint_bridge.resolve.return_value = { 'endpoint_url': 'https://eu-central-1.amazonaws.com' } self.client = mock.Mock() self.cache = {} self.redirector = S3RegionRedirector(self.endpoint_bridge, self.client) self.set_client_response_headers({}) self.operation = mock.Mock() self.operation.name = 'foo' def set_client_response_headers(self, headers): error_response = ClientError({ 'Error': { 'Code': '', 'Message': '' }, 'ResponseMetadata': { 'HTTPHeaders': headers } }, 'HeadBucket') success_response = { 'ResponseMetadata': { 'HTTPHeaders': headers } } self.client.head_bucket.side_effect = [ error_response, success_response] def test_set_request_url(self): params = {'url': 'https://us-west-2.amazonaws.com/foo'} context = {'signing': { 'endpoint': 'https://eu-central-1.amazonaws.com' }} self.redirector.set_request_url(params, context) self.assertEqual( params['url'], 'https://eu-central-1.amazonaws.com/foo') def test_only_changes_request_url_if_endpoint_present(self): params = {'url': 'https://us-west-2.amazonaws.com/foo'} context = {} self.redirector.set_request_url(params, context) self.assertEqual( params['url'], 'https://us-west-2.amazonaws.com/foo') def test_set_request_url_keeps_old_scheme(self): params = {'url': 'http://us-west-2.amazonaws.com/foo'} context = {'signing': { 'endpoint': 'https://eu-central-1.amazonaws.com' }} self.redirector.set_request_url(params, context) self.assertEqual( params['url'], 'http://eu-central-1.amazonaws.com/foo') def test_sets_signing_context_from_cache(self): signing_context = {'endpoint': 'bar'} self.cache['foo'] = signing_context self.redirector = S3RegionRedirector( self.endpoint_bridge, self.client, cache=self.cache) params = {'Bucket': 'foo'} context = {} self.redirector.redirect_from_cache(params, context) self.assertEqual(context.get('signing'), signing_context) def test_only_changes_context_if_bucket_in_cache(self): signing_context = {'endpoint': 'bar'} self.cache['bar'] = signing_context self.redirector = S3RegionRedirector( self.endpoint_bridge, self.client, cache=self.cache) params = {'Bucket': 'foo'} context = {} self.redirector.redirect_from_cache(params, context) self.assertNotEqual(context.get('signing'), signing_context) def test_redirect_from_error(self): request_dict = { 'context': {'signing': {'bucket': 'foo'}}, 'url': 'https://us-west-2.amazonaws.com/foo' } response = (None, { 'Error': { 'Code': 'PermanentRedirect', 'Endpoint': 'foo.eu-central-1.amazonaws.com', 'Bucket': 'foo' }, 'ResponseMetadata': { 'HTTPHeaders': {'x-amz-bucket-region': 'eu-central-1'} } }) redirect_response = self.redirector.redirect_from_error( request_dict, response, self.operation) # The response needs to be 0 so that there is no retry delay self.assertEqual(redirect_response, 0) self.assertEqual( request_dict['url'], 'https://eu-central-1.amazonaws.com/foo') expected_signing_context = { 'endpoint': 'https://eu-central-1.amazonaws.com', 'bucket': 'foo', 'region': 'eu-central-1' } signing_context = request_dict['context'].get('signing') self.assertEqual(signing_context, expected_signing_context) def test_does_not_redirect_unless_permanentredirect_recieved(self): request_dict = {} response = (None, {}) redirect_response = self.redirector.redirect_from_error( request_dict, response, self.operation) self.assertIsNone(redirect_response) self.assertEqual(request_dict, {}) def test_does_not_redirect_if_region_cannot_be_found(self): request_dict = {'url': 'https://us-west-2.amazonaws.com/foo', 'context': {'signing': {'bucket': 'foo'}}} response = (None, { 'Error': { 'Code': 'PermanentRedirect', 'Endpoint': 'foo.eu-central-1.amazonaws.com', 'Bucket': 'foo' }, 'ResponseMetadata': { 'HTTPHeaders': {} } }) redirect_response = self.redirector.redirect_from_error( request_dict, response, self.operation) self.assertIsNone(redirect_response) def test_redirects_301(self): request_dict = {'url': 'https://us-west-2.amazonaws.com/foo', 'context': {'signing': {'bucket': 'foo'}}} response = (None, { 'Error': { 'Code': '301', 'Message': 'Moved Permanently' }, 'ResponseMetadata': { 'HTTPHeaders': {'x-amz-bucket-region': 'eu-central-1'} } }) self.operation.name = 'HeadObject' redirect_response = self.redirector.redirect_from_error( request_dict, response, self.operation) self.assertEqual(redirect_response, 0) self.operation.name = 'ListObjects' redirect_response = self.redirector.redirect_from_error( request_dict, response, self.operation) self.assertIsNone(redirect_response) def test_does_not_redirect_if_None_response(self): request_dict = {'url': 'https://us-west-2.amazonaws.com/foo', 'context': {'signing': {'bucket': 'foo'}}} response = None redirect_response = self.redirector.redirect_from_error( request_dict, response, self.operation) self.assertIsNone(redirect_response) def test_get_region_from_response(self): response = (None, { 'Error': { 'Code': 'PermanentRedirect', 'Endpoint': 'foo.eu-central-1.amazonaws.com', 'Bucket': 'foo' }, 'ResponseMetadata': { 'HTTPHeaders': {'x-amz-bucket-region': 'eu-central-1'} } }) region = self.redirector.get_bucket_region('foo', response) self.assertEqual(region, 'eu-central-1') def test_get_region_from_response_error_body(self): response = (None, { 'Error': { 'Code': 'PermanentRedirect', 'Endpoint': 'foo.eu-central-1.amazonaws.com', 'Bucket': 'foo', 'Region': 'eu-central-1' }, 'ResponseMetadata': { 'HTTPHeaders': {} } }) region = self.redirector.get_bucket_region('foo', response) self.assertEqual(region, 'eu-central-1') def test_get_region_from_head_bucket_error(self): self.set_client_response_headers( {'x-amz-bucket-region': 'eu-central-1'}) response = (None, { 'Error': { 'Code': 'PermanentRedirect', 'Endpoint': 'foo.eu-central-1.amazonaws.com', 'Bucket': 'foo', }, 'ResponseMetadata': { 'HTTPHeaders': {} } }) region = self.redirector.get_bucket_region('foo', response) self.assertEqual(region, 'eu-central-1') def test_get_region_from_head_bucket_success(self): success_response = { 'ResponseMetadata': { 'HTTPHeaders': {'x-amz-bucket-region': 'eu-central-1'} } } self.client.head_bucket.side_effect = None self.client.head_bucket.return_value = success_response response = (None, { 'Error': { 'Code': 'PermanentRedirect', 'Endpoint': 'foo.eu-central-1.amazonaws.com', 'Bucket': 'foo', }, 'ResponseMetadata': { 'HTTPHeaders': {} } }) region = self.redirector.get_bucket_region('foo', response) self.assertEqual(region, 'eu-central-1') class TestContainerMetadataFetcher(unittest.TestCase): def setUp(self): self.responses = [] self.http = mock.Mock() self.sleep = mock.Mock() def create_fetcher(self): return ContainerMetadataFetcher(self.http, sleep=self.sleep) def fake_response(self, status_code, body): response = mock.Mock() response.status_code = status_code response.text = body return response def set_http_responses_to(self, *responses): http_responses = [] for response in responses: if isinstance(response, Exception): # Simulating an error condition. http_response = response elif hasattr(response, 'status_code'): # It's a precreated fake_response. http_response = response else: http_response = self.fake_response( status_code=200, body=json.dumps(response)) http_responses.append(http_response) self.http.get.side_effect = http_responses def test_can_retrieve_uri(self): json_body = { "AccessKeyId" : "a", "SecretAccessKey" : "b", "Token" : "c", "Expiration" : "d" } self.set_http_responses_to(json_body) fetcher = self.create_fetcher() response = fetcher.retrieve_uri('/foo?id=1') self.assertEqual(response, json_body) # Ensure we made calls to the right endpoint. self.http.get.assert_called_with( 'http://169.254.170.2/foo?id=1', headers={'Accept': 'application/json'}, timeout=fetcher.TIMEOUT_SECONDS, ) def test_can_retry_requests(self): success_response = { "AccessKeyId" : "a", "SecretAccessKey" : "b", "Token" : "c", "Expiration" : "d" } self.set_http_responses_to( # First response is a connection error, should # be retried. requests.ConnectionError(), # Second response is the successful JSON response # with credentials. success_response, ) fetcher = self.create_fetcher() response = fetcher.retrieve_uri('/foo?id=1') self.assertEqual(response, success_response) def test_propagates_credential_error_on_http_errors(self): self.set_http_responses_to( # In this scenario, we never get a successful response. requests.ConnectionError(), requests.ConnectionError(), requests.ConnectionError(), requests.ConnectionError(), requests.ConnectionError(), ) # As a result, we expect an appropriate error to be raised. fetcher = self.create_fetcher() with self.assertRaises(MetadataRetrievalError): fetcher.retrieve_uri('/foo?id=1') self.assertEqual(self.http.get.call_count, fetcher.RETRY_ATTEMPTS) def test_error_raised_on_non_200_response(self): self.set_http_responses_to( self.fake_response(status_code=404, body='Error not found'), self.fake_response(status_code=404, body='Error not found'), self.fake_response(status_code=404, body='Error not found'), ) fetcher = self.create_fetcher() with self.assertRaises(MetadataRetrievalError): fetcher.retrieve_uri('/foo?id=1') # Should have tried up to RETRY_ATTEMPTS. self.assertEqual(self.http.get.call_count, fetcher.RETRY_ATTEMPTS) def test_error_raised_on_no_json_response(self): # If the service returns a sucess response but with a body that # does not contain JSON, we should still retry up to RETRY_ATTEMPTS, # but after exhausting retries we propagate the exception. self.set_http_responses_to( self.fake_response(status_code=200, body='Not JSON'), self.fake_response(status_code=200, body='Not JSON'), self.fake_response(status_code=200, body='Not JSON'), ) fetcher = self.create_fetcher() with self.assertRaises(MetadataRetrievalError): fetcher.retrieve_uri('/foo?id=1') # Should have tried up to RETRY_ATTEMPTS. self.assertEqual(self.http.get.call_count, fetcher.RETRY_ATTEMPTS) if __name__ == '__main__': unittest.main() botocore-1.5.7/tests/unit/data/0000777454262600001440000000000013042511310017432 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/data/foo.json0000666454262600001440000000034713042511306021121 0ustar pysdk-ciamazon00000000000000{ "test_key_1": "test_value_1", "test_key_2": ["test_value_2_1", "test_value_2_2"], "test_key_3": [{"name": "test_list_1", "value": "test_list_value_1"}, {"name": "test_list_2", "value":"test_list_value_2"}] } botocore-1.5.7/tests/unit/data/non_ascii.json0000666454262600001440000000032513042511306022274 0ustar pysdk-ciamazon00000000000000{ "Note": "The following special characters show up in doc occasionally", "dash_in_ascii": "-", "dash_0x93": "–", "dash_0x94": "—", "quotation_mark_0x9d": "”", "normal": "ascii" } botocore-1.5.7/tests/unit/data/aws/0000777454262600001440000000000013042511307020232 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/data/aws/s3/0000777454262600001440000000000013042511310020551 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/data/aws/s3/2006-03-01.normal.json0000666454262600001440000000005413042511306023764 0ustar pysdk-ciamazon00000000000000{ "WAS_OVERRIDEN_VIA_DATA_PATH": true } botocore-1.5.7/tests/unit/data/sub/0000777454262600001440000000000013042511310020223 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/data/sub/fie.normal.json0000666454262600001440000000004513042511306023154 0ustar pysdk-ciamazon00000000000000{ "test_key_1": "test_value_1" } botocore-1.5.7/tests/unit/data/baz.json0000666454262600001440000000002313042511306021101 0ustar pysdk-ciamazon00000000000000{"bad": "json", } botocore-1.5.7/tests/unit/data/someservice/0000777454262600001440000000000013042511310021756 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/data/someservice/2012-10-01.normal.json0000666454262600001440000000010513042511306025161 0ustar pysdk-ciamazon00000000000000{ "api_version": "2012-10-01", "something-else": "another" } botocore-1.5.7/tests/unit/data/someservice/2013-08-21.normal.json0000666454262600001440000000010613042511306025174 0ustar pysdk-ciamazon00000000000000{ "api_version": "2013-08-21", "something-else": "whatever" } botocore-1.5.7/tests/unit/test_idempotency.py0000666454262600001440000000300213042511306022452 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest import re import mock from botocore.handlers import generate_idempotent_uuid class TestIdempotencyInjection(unittest.TestCase): def setUp(self): self.mock_model = mock.MagicMock() self.mock_model.idempotent_members = ['RequiredKey'] self.uuid_pattern = re.compile( '^[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$', re.I) def test_injection(self): # No parameters are provided, RequiredKey should be autofilled params = {} generate_idempotent_uuid(params, self.mock_model) self.assertIn('RequiredKey', params) self.assertIsNotNone(self.uuid_pattern.match(params['RequiredKey'])) def test_provided(self): # RequiredKey is provided, should not be replaced params = {'RequiredKey': 'already populated'} generate_idempotent_uuid(params, self.mock_model) self.assertEquals(params['RequiredKey'], 'already populated') botocore-1.5.7/tests/unit/test_hooks.py0000666454262600001440000005641513042511306021275 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import copy import functools from tests import unittest from functools import partial from botocore.hooks import HierarchicalEmitter, first_non_none_response class TestHierarchicalEventEmitter(unittest.TestCase): def setUp(self): self.emitter = HierarchicalEmitter() self.hook_calls = [] def hook(self, **kwargs): self.hook_calls.append(kwargs) def test_non_dot_behavior(self): self.emitter.register('no-dot', self.hook) self.emitter.emit('no-dot') self.assertEqual(len(self.hook_calls), 1) def test_with_dots(self): self.emitter.register('foo.bar.baz', self.hook) self.emitter.emit('foo.bar.baz') self.assertEqual(len(self.hook_calls), 1) def test_catch_all_hook(self): self.emitter.register('foo', self.hook) self.emitter.register('foo.bar', self.hook) self.emitter.register('foo.bar.baz', self.hook) self.emitter.emit('foo.bar.baz') self.assertEqual(len(self.hook_calls), 3, self.hook_calls) # The hook is called with the same event name three times. self.assertEqual([e['event_name'] for e in self.hook_calls], ['foo.bar.baz', 'foo.bar.baz', 'foo.bar.baz']) def test_hook_called_in_proper_order(self): # We should call the hooks from most specific to least # specific. calls = [] self.emitter.register('foo', lambda **kwargs: calls.append('foo')) self.emitter.register('foo.bar', lambda **kwargs: calls.append('foo.bar')) self.emitter.register('foo.bar.baz', lambda **kwargs: calls.append('foo.bar.baz')) self.emitter.emit('foo.bar.baz') self.assertEqual(calls, ['foo.bar.baz', 'foo.bar', 'foo']) class TestStopProcessing(unittest.TestCase): def setUp(self): self.emitter = HierarchicalEmitter() self.hook_calls = [] def hook1(self, **kwargs): self.hook_calls.append('hook1') def hook2(self, **kwargs): self.hook_calls.append('hook2') return 'hook2-response' def hook3(self, **kwargs): self.hook_calls.append('hook3') return 'hook3-response' def test_all_hooks(self): # Here we register three hooks and sanity check # that all three would be called by a normal emit. # This ensures our hook calls are setup properly for # later tests. self.emitter.register('foo', self.hook1) self.emitter.register('foo', self.hook2) self.emitter.register('foo', self.hook3) self.emitter.emit('foo') self.assertEqual(self.hook_calls, ['hook1', 'hook2', 'hook3']) def test_stop_processing_after_first_response(self): # Here we register three hooks, but only the first # two should ever execute. self.emitter.register('foo', self.hook1) self.emitter.register('foo', self.hook2) self.emitter.register('foo', self.hook3) handler, response = self.emitter.emit_until_response('foo') self.assertEqual(response, 'hook2-response') self.assertEqual(self.hook_calls, ['hook1', 'hook2']) def test_no_responses(self): # Here we register a handler that will not return a response # and ensure we get back proper values. self.emitter.register('foo', self.hook1) responses = self.emitter.emit('foo') self.assertEqual(self.hook_calls, ['hook1']) self.assertEqual(responses, [(self.hook1, None)]) def test_no_handlers(self): # Here we have no handlers, but still expect a tuple of return # values. handler, response = self.emitter.emit_until_response('foo') self.assertIsNone(handler) self.assertIsNone(response) class TestFirstNonNoneResponse(unittest.TestCase): def test_all_none(self): self.assertIsNone(first_non_none_response([])) def test_first_non_none(self): correct_value = 'correct_value' wrong_value = 'wrong_value' # The responses are tuples of (handler, response), # and we don't care about the handler so we just use a value of # None. responses = [(None, None), (None, correct_value), (None, wrong_value)] self.assertEqual(first_non_none_response(responses), correct_value) def test_default_value_if_non_none_found(self): responses = [(None, None), (None, None)] # If no response is found and a default value is passed in, it will # be returned. self.assertEqual( first_non_none_response(responses, default='notfound'), 'notfound') class TestWildcardHandlers(unittest.TestCase): def setUp(self): self.emitter = HierarchicalEmitter() self.hook_calls = [] def hook(self, **kwargs): self.hook_calls.append(kwargs) def register(self, event_name): func = partial(self.hook, registered_with=event_name) self.emitter.register(event_name, func) return func def assert_hook_is_called_given_event(self, event): starting = len(self.hook_calls) self.emitter.emit(event) after = len(self.hook_calls) if not after > starting: self.fail("Handler was not called for event: %s" % event) self.assertEqual(self.hook_calls[-1]['event_name'], event) def assert_hook_is_not_called_given_event(self, event): starting = len(self.hook_calls) self.emitter.emit(event) after = len(self.hook_calls) if not after == starting: self.fail("Handler was called for event but was not " "suppose to be called: %s, last_event: %s" % (event, self.hook_calls[-1])) def test_one_level_wildcard_handler(self): self.emitter.register('foo.*.baz', self.hook) # Also register for a number of other events to check # for false positives. self.emitter.register('other.bar.baz', self.hook) self.emitter.register('qqq.baz', self.hook) self.emitter.register('dont.call.me', self.hook) self.emitter.register('dont', self.hook) # These calls should trigger our hook. self.assert_hook_is_called_given_event('foo.bar.baz') self.assert_hook_is_called_given_event('foo.qux.baz') self.assert_hook_is_called_given_event('foo.anything.baz') # These calls should not match our hook. self.assert_hook_is_not_called_given_event('foo') self.assert_hook_is_not_called_given_event('foo.bar') self.assert_hook_is_not_called_given_event('bar.qux.baz') self.assert_hook_is_not_called_given_event('foo-bar') def test_hierarchical_wildcard_handler(self): self.emitter.register('foo.*.baz', self.hook) self.assert_hook_is_called_given_event('foo.bar.baz.qux') self.assert_hook_is_called_given_event('foo.bar.baz.qux.foo') self.assert_hook_is_called_given_event('foo.qux.baz.qux') self.assert_hook_is_called_given_event('foo.qux.baz.qux.foo') self.assert_hook_is_not_called_given_event('bar.qux.baz.foo') def test_multiple_wildcard_events(self): self.emitter.register('foo.*.*.baz', self.hook) self.assert_hook_is_called_given_event('foo.bar.baz.baz') self.assert_hook_is_called_given_event('foo.ANY.THING.baz') self.assert_hook_is_called_given_event('foo.AT.ALL.baz') # More specific than what we registered for. self.assert_hook_is_called_given_event('foo.bar.baz.baz.extra') self.assert_hook_is_called_given_event('foo.bar.baz.baz.extra.stuff') # Too short: self.assert_hook_is_not_called_given_event('foo') self.assert_hook_is_not_called_given_event('foo.bar') self.assert_hook_is_not_called_given_event('foo.bar.baz') # Bad ending segment. self.assert_hook_is_not_called_given_event('foo.ANY.THING.notbaz') self.assert_hook_is_not_called_given_event('foo.ANY.THING.stillnotbaz') def test_can_unregister_for_wildcard_events(self): self.emitter.register('foo.*.*.baz', self.hook) # Call multiple times to verify caching behavior. self.assert_hook_is_called_given_event('foo.bar.baz.baz') self.assert_hook_is_called_given_event('foo.bar.baz.baz') self.assert_hook_is_called_given_event('foo.bar.baz.baz') self.emitter.unregister('foo.*.*.baz', self.hook) self.assert_hook_is_not_called_given_event('foo.bar.baz.baz') self.assert_hook_is_not_called_given_event('foo.bar.baz.baz') self.assert_hook_is_not_called_given_event('foo.bar.baz.baz') self.emitter.register('foo.*.*.baz', self.hook) self.assert_hook_is_called_given_event('foo.bar.baz.baz') self.assert_hook_is_called_given_event('foo.bar.baz.baz') def test_unregister_does_not_exist(self): self.emitter.register('foo.*.*.baz', self.hook) self.emitter.unregister('foo.*.*.baz', self.hook) self.emitter.unregister('foo.*.*.baz', self.hook) self.assert_hook_is_not_called_given_event('foo.bar.baz.baz') def test_cache_cleared_properly(self): self.emitter.register('foo.*.*.baz', self.hook) self.assert_hook_is_called_given_event('foo.bar.baz.baz') self.emitter.register('foo.*.*.bar', self.hook) self.assert_hook_is_called_given_event('foo.bar.baz.baz') self.assert_hook_is_called_given_event('foo.bar.baz.bar') self.emitter.unregister('foo.*.*.baz', self.hook) self.assert_hook_is_called_given_event('foo.bar.baz.bar') self.assert_hook_is_not_called_given_event('foo.bar.baz.baz') def test_complicated_register_unregister(self): r = self.emitter.register u = partial(self.emitter.unregister, handler=self.hook) r('foo.bar.baz.qux', self.hook) r('foo.bar.baz', self.hook) r('foo.bar', self.hook) r('foo', self.hook) u('foo.bar.baz') u('foo') u('foo.bar') self.assert_hook_is_called_given_event('foo.bar.baz.qux') self.assert_hook_is_not_called_given_event('foo.bar.baz') self.assert_hook_is_not_called_given_event('foo.bar') self.assert_hook_is_not_called_given_event('foo') def test_register_multiple_handlers_for_same_event(self): self.emitter.register('foo.bar.baz', self.hook) self.emitter.register('foo.bar.baz', self.hook) self.emitter.emit('foo.bar.baz') self.assertEqual(len(self.hook_calls), 2) def test_register_with_unique_id(self): self.emitter.register('foo.bar.baz', self.hook, unique_id='foo') # Since we're using the same unique_id, this registration is ignored. self.emitter.register('foo.bar.baz', self.hook, unique_id='foo') # This also works across event names, so this registration is ignored # as well. self.emitter.register('foo.other', self.hook, unique_id='foo') self.emitter.emit('foo.bar.baz') self.assertEqual(len(self.hook_calls), 1) self.hook_calls = [] self.emitter.emit('foo.other') self.assertEqual(len(self.hook_calls), 0) def test_remove_handler_with_unique_id(self): hook2 = lambda **kwargs: self.hook_calls.append(kwargs) self.emitter.register('foo.bar.baz', self.hook, unique_id='foo') self.emitter.register('foo.bar.baz', hook2) self.emitter.emit('foo.bar.baz') self.assertEqual(len(self.hook_calls), 2) # Reset the hook calls. self.hook_calls = [] self.emitter.unregister('foo.bar.baz', hook2) self.emitter.emit('foo.bar.baz') self.assertEqual(len(self.hook_calls), 1) self.hook_calls = [] # Can provide the unique_id to unregister. self.emitter.unregister('foo.bar.baz', unique_id='foo') self.emitter.emit('foo.bar.baz') self.assertEqual(len(self.hook_calls), 0) # Same as with not specifying a unique_id, you can call # unregister multiple times and not get an exception. self.emitter.unregister('foo.bar.baz', unique_id='foo') def test_remove_handler_with_and_without_unique_id(self): self.emitter.register('foo.bar.baz', self.hook, unique_id='foo') self.emitter.register('foo.bar.baz', self.hook) self.emitter.unregister('foo.bar.baz', self.hook) self.emitter.emit('foo.bar.baz') self.assertEqual(len(self.hook_calls), 1) self.hook_calls = [] self.emitter.unregister('foo.bar.baz', self.hook) self.emitter.emit('foo.bar.baz') self.assertEqual(len(self.hook_calls), 0) def test_register_with_uses_count_initially(self): self.emitter.register('foo', self.hook, unique_id='foo', unique_id_uses_count=True) # Subsequent calls must set ``unique_id_uses_count`` to True. with self.assertRaises(ValueError): self.emitter.register('foo', self.hook, unique_id='foo') def test_register_with_uses_count_not_initially(self): self.emitter.register('foo', self.hook, unique_id='foo') # Subsequent calls must set ``unique_id_uses_count`` to False. with self.assertRaises(ValueError): self.emitter.register('foo', self.hook, unique_id='foo', unique_id_uses_count=True) def test_register_with_uses_count_unregister(self): self.emitter.register('foo', self.hook, unique_id='foo', unique_id_uses_count=True) self.emitter.register('foo', self.hook, unique_id='foo', unique_id_uses_count=True) # Event was registered to use a count so it must be specified # that a count is used when unregistering with self.assertRaises(ValueError): self.emitter.unregister('foo', self.hook, unique_id='foo') # Event should not have been unregistered. self.emitter.emit('foo') self.assertEqual(len(self.hook_calls), 1) self.emitter.unregister('foo', self.hook, unique_id='foo', unique_id_uses_count=True) # Event still should not be unregistered. self.hook_calls = [] self.emitter.emit('foo') self.assertEqual(len(self.hook_calls), 1) self.emitter.unregister('foo', self.hook, unique_id='foo', unique_id_uses_count=True) # Now the event should be unregistered. self.hook_calls = [] self.emitter.emit('foo') self.assertEqual(len(self.hook_calls), 0) def test_register_with_no_uses_count_unregister(self): self.emitter.register('foo', self.hook, unique_id='foo') # The event was not registered to use a count initially with self.assertRaises(ValueError): self.emitter.unregister('foo', self.hook, unique_id='foo', unique_id_uses_count=True) def test_handlers_called_in_order(self): def handler(call_number, **kwargs): kwargs['call_number'] = call_number self.hook_calls.append(kwargs) self.emitter.register('foo', partial(handler, call_number=1)) self.emitter.register('foo', partial(handler, call_number=2)) self.emitter.emit('foo') self.assertEqual([k['call_number'] for k in self.hook_calls], [1, 2]) def test_handler_call_order_with_hierarchy(self): def handler(call_number, **kwargs): kwargs['call_number'] = call_number self.hook_calls.append(kwargs) # We go from most specific to least specific, and each level is called # in the order they were registered for that particular hierarchy # level. self.emitter.register('foo.bar.baz', partial(handler, call_number=1)) self.emitter.register('foo.bar', partial(handler, call_number=3)) self.emitter.register('foo', partial(handler, call_number=5)) self.emitter.register('foo.bar.baz', partial(handler, call_number=2)) self.emitter.register('foo.bar', partial(handler, call_number=4)) self.emitter.register('foo', partial(handler, call_number=6)) self.emitter.emit('foo.bar.baz') self.assertEqual([k['call_number'] for k in self.hook_calls], [1, 2, 3, 4, 5, 6]) def test_register_first_single_level(self): def handler(call_number, **kwargs): kwargs['call_number'] = call_number self.hook_calls.append(kwargs) # Handlers registered through register_first() are always called # before handlers registered with register(). self.emitter.register('foo', partial(handler, call_number=3)) self.emitter.register('foo', partial(handler, call_number=4)) self.emitter.register_first('foo', partial(handler, call_number=1)) self.emitter.register_first('foo', partial(handler, call_number=2)) self.emitter.register('foo', partial(handler, call_number=5)) self.emitter.emit('foo') self.assertEqual([k['call_number'] for k in self.hook_calls], [1, 2, 3, 4, 5]) def test_register_first_hierarchy(self): def handler(call_number, **kwargs): kwargs['call_number'] = call_number self.hook_calls.append(kwargs) self.emitter.register('foo', partial(handler, call_number=5)) self.emitter.register('foo.bar', partial(handler, call_number=2)) self.emitter.register_first('foo', partial(handler, call_number=4)) self.emitter.register_first('foo.bar', partial(handler, call_number=1)) self.emitter.register('foo', partial(handler, call_number=6)) self.emitter.register('foo.bar', partial(handler, call_number=3)) self.emitter.emit('foo.bar') self.assertEqual([k['call_number'] for k in self.hook_calls], [1, 2, 3, 4, 5, 6]) def test_register_last_hierarchy(self): def handler(call_number, **kwargs): kwargs['call_number'] = call_number self.hook_calls.append(kwargs) self.emitter.register_last('foo', partial(handler, call_number=3)) self.emitter.register('foo', partial(handler, call_number=2)) self.emitter.register_first('foo', partial(handler, call_number=1)) self.emitter.emit('foo') self.assertEqual([k['call_number'] for k in self.hook_calls], [1, 2, 3]) def test_register_unregister_first_last(self): self.emitter.register('foo', self.hook) self.emitter.register_last('foo.bar', self.hook) self.emitter.register_first('foo.bar.baz', self.hook) self.emitter.unregister('foo.bar.baz', self.hook) self.emitter.unregister('foo.bar', self.hook) self.emitter.unregister('foo', self.hook) self.emitter.emit('foo') self.assertEqual(self.hook_calls, []) def test_copy_emitter(self): # Here we're not testing copy directly, we're testing # the observable behavior from copying an event emitter. first = [] def first_handler(id_name, **kwargs): first.append(id_name) second = [] def second_handler(id_name, **kwargs): second.append(id_name) self.emitter.register('foo.bar.baz', first_handler) # First time we emit, only the first handler should be called. self.emitter.emit('foo.bar.baz', id_name='first-time') self.assertEqual(first, ['first-time']) self.assertEqual(second, []) copied_emitter = copy.copy(self.emitter) # If we emit from the copied emitter, we should still # only see the first handler called. copied_emitter.emit('foo.bar.baz', id_name='second-time') self.assertEqual(first, ['first-time', 'second-time']) self.assertEqual(second, []) # However, if we register an event handler with the copied # emitter, the first emitter will not see this. copied_emitter.register('foo.bar.baz', second_handler) copied_emitter.emit('foo.bar.baz', id_name='third-time') self.assertEqual(first, ['first-time', 'second-time', 'third-time']) # And now the second handler is called. self.assertEqual(second, ['third-time']) # And vice-versa, emitting from the original emitter # will not trigger the second_handler. # We'll double check this by unregistering/re-registering # the event handler. self.emitter.unregister('foo.bar.baz', first_handler) self.emitter.register('foo.bar.baz', first_handler) self.emitter.emit('foo.bar.baz', id_name='last-time') self.assertEqual(second, ['third-time']) def test_copy_emitter_with_unique_id_event(self): # Here we're not testing copy directly, we're testing # the observable behavior from copying an event emitter. first = [] def first_handler(id_name, **kwargs): first.append(id_name) second = [] def second_handler(id_name, **kwargs): second.append(id_name) self.emitter.register('foo', first_handler, 'bar') self.emitter.emit('foo', id_name='first-time') self.assertEqual(first, ['first-time']) self.assertEqual(second, []) copied_emitter = copy.copy(self.emitter) # If we register an event handler with the copied # emitter, the event should not get registered again # because the unique id was already used. copied_emitter.register('foo', second_handler, 'bar') copied_emitter.emit('foo', id_name='second-time') self.assertEqual(first, ['first-time', 'second-time']) self.assertEqual(second, []) # If we unregister the first event from the copied emitter, # We should be able to register the second handler. copied_emitter.unregister('foo', first_handler, 'bar') copied_emitter.register('foo', second_handler, 'bar') copied_emitter.emit('foo', id_name='third-time') self.assertEqual(first, ['first-time', 'second-time']) self.assertEqual(second, ['third-time']) # The original event emitter should have the unique id event still # registered though. self.emitter.emit('foo', id_name='fourth-time') self.assertEqual(first, ['first-time', 'second-time', 'fourth-time']) self.assertEqual(second, ['third-time']) def test_copy_events_with_partials(self): # There's a bug in python2.6 where you can't deepcopy # a partial object. We want to ensure that doesn't # break when a partial is hooked up as an event handler. def handler(a, b, **kwargs): return b f = functools.partial(handler, 1) self.emitter.register('a.b', f) copied = copy.copy(self.emitter) self.assertEqual(copied.emit_until_response( 'a.b', b='return-val')[1], 'return-val') if __name__ == '__main__': unittest.main() botocore-1.5.7/tests/unit/test_s3_addressing.py0000666454262600001440000002343413042511306022675 0ustar pysdk-ciamazon00000000000000#!/usr/bin/env python # Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import os from tests import BaseSessionTest from mock import patch, Mock from botocore.compat import OrderedDict from botocore.handlers import set_list_objects_encoding_type_url from botocore.exceptions import UnknownEndpointError class TestS3Addressing(BaseSessionTest): def setUp(self): super(TestS3Addressing, self).setUp() self.region_name = 'us-east-1' self.signature_version = 's3' self.mock_response = Mock() self.mock_response.content = '' self.mock_response.headers = {} self.mock_response.status_code = 200 self.session.unregister('before-parameter-build.s3.ListObjects', set_list_objects_encoding_type_url) def get_prepared_request(self, operation, params, force_hmacv1=False): if force_hmacv1: self.session.register('choose-signer', self.enable_hmacv1) with patch('botocore.endpoint.BotocoreHTTPSession') as \ mock_http_session: mock_send = mock_http_session.return_value.send mock_send.return_value = self.mock_response client = self.session.create_client('s3', self.region_name) getattr(client, operation)(**params) # Return the request that was sent over the wire. return mock_send.call_args[0][0] def enable_hmacv1(self, **kwargs): return 's3' def test_list_objects_dns_name(self): params = {'Bucket': 'safename'} prepared_request = self.get_prepared_request('list_objects', params, force_hmacv1=True) self.assertEqual(prepared_request.url, 'https://safename.s3.amazonaws.com/') def test_list_objects_non_dns_name(self): params = {'Bucket': 'un_safe_name'} prepared_request = self.get_prepared_request('list_objects', params, force_hmacv1=True) self.assertEqual(prepared_request.url, 'https://s3.amazonaws.com/un_safe_name') def test_list_objects_dns_name_non_classic(self): self.region_name = 'us-west-2' params = {'Bucket': 'safename'} prepared_request = self.get_prepared_request('list_objects', params, force_hmacv1=True) self.assertEqual(prepared_request.url, 'https://safename.s3.amazonaws.com/') def test_list_objects_unicode_query_string_eu_central_1(self): self.region_name = 'eu-central-1' params = OrderedDict([('Bucket', 'safename'), ('Marker', u'\xe4\xf6\xfc-01.txt')]) prepared_request = self.get_prepared_request('list_objects', params) self.assertEqual( prepared_request.url, ('https://s3.eu-central-1.amazonaws.com/safename' '?marker=%C3%A4%C3%B6%C3%BC-01.txt') ) def test_list_objects_in_restricted_regions(self): self.region_name = 'us-gov-west-1' params = {'Bucket': 'safename'} prepared_request = self.get_prepared_request('list_objects', params) # Note how we keep the region specific endpoint here. self.assertEqual(prepared_request.url, 'https://s3-us-gov-west-1.amazonaws.com/safename') def test_list_objects_in_fips(self): self.region_name = 'fips-us-gov-west-1' params = {'Bucket': 'safename'} prepared_request = self.get_prepared_request('list_objects', params) # Note how we keep the region specific endpoint here. self.assertEqual( prepared_request.url, 'https://s3-fips-us-gov-west-1.amazonaws.com/safename') def test_list_objects_non_dns_name_non_classic(self): self.region_name = 'us-west-2' params = {'Bucket': 'un_safe_name'} prepared_request = self.get_prepared_request('list_objects', params) self.assertEqual(prepared_request.url, 'https://s3-us-west-2.amazonaws.com/un_safe_name') def test_put_object_dns_name_non_classic(self): self.region_name = 'us-west-2' file_path = os.path.join(os.path.dirname(__file__), 'put_object_data') with open(file_path, 'rb') as fp: params = { 'Bucket': 'my.valid.name', 'Key': 'mykeyname', 'Body': fp, 'ACL': 'public-read', 'ContentLanguage': 'piglatin', 'ContentType': 'text/plain' } prepared_request = self.get_prepared_request('put_object', params) self.assertEqual( prepared_request.url, 'https://s3-us-west-2.amazonaws.com/my.valid.name/mykeyname') def test_put_object_dns_name_classic(self): self.region_name = 'us-east-1' file_path = os.path.join(os.path.dirname(__file__), 'put_object_data') with open(file_path, 'rb') as fp: params = { 'Bucket': 'my.valid.name', 'Key': 'mykeyname', 'Body': fp, 'ACL': 'public-read', 'ContentLanguage': 'piglatin', 'ContentType': 'text/plain' } prepared_request = self.get_prepared_request('put_object', params) self.assertEqual( prepared_request.url, 'https://s3.amazonaws.com/my.valid.name/mykeyname') def test_put_object_dns_name_single_letter_non_classic(self): self.region_name = 'us-west-2' file_path = os.path.join(os.path.dirname(__file__), 'put_object_data') with open(file_path, 'rb') as fp: params = { 'Bucket': 'a.valid.name', 'Key': 'mykeyname', 'Body': fp, 'ACL': 'public-read', 'ContentLanguage': 'piglatin', 'ContentType': 'text/plain' } prepared_request = self.get_prepared_request('put_object', params) self.assertEqual( prepared_request.url, 'https://s3-us-west-2.amazonaws.com/a.valid.name/mykeyname') def test_get_object_non_dns_name_non_classic(self): self.region_name = 'us-west-2' params = { 'Bucket': 'AnInvalidName', 'Key': 'mykeyname' } prepared_request = self.get_prepared_request('get_object', params) self.assertEqual( prepared_request.url, 'https://s3-us-west-2.amazonaws.com/AnInvalidName/mykeyname') def test_get_object_non_dns_name_classic(self): self.region_name = 'us-east-1' params = { 'Bucket': 'AnInvalidName', 'Key': 'mykeyname' } prepared_request = self.get_prepared_request('get_object', params) self.assertEqual(prepared_request.url, 'https://s3.amazonaws.com/AnInvalidName/mykeyname') def test_get_object_ip_address_name_non_classic(self): self.region_name = 'us-west-2' params = { 'Bucket': '192.168.5.4', 'Key': 'mykeyname'} prepared_request = self.get_prepared_request('get_object', params) self.assertEqual( prepared_request.url, 'https://s3-us-west-2.amazonaws.com/192.168.5.4/mykeyname') def test_get_object_almost_an_ip_address_name_non_classic(self): self.region_name = 'us-west-2' params = { 'Bucket': '192.168.5.256', 'Key': 'mykeyname'} prepared_request = self.get_prepared_request('get_object', params) self.assertEqual( prepared_request.url, 'https://s3-us-west-2.amazonaws.com/192.168.5.256/mykeyname') def test_invalid_endpoint_raises_exception(self): with self.assertRaisesRegexp(ValueError, 'Invalid endpoint'): self.session.create_client('s3', 'Invalid region') def test_non_existent_region(self): # If I ask for a region that does not # exist on a global endpoint, such as: client = self.session.create_client('s3', 'us-west-111') # Then the default endpoint heuristic will apply and we'll # get the region name as specified. self.assertEqual(client.meta.region_name, 'us-west-111') # Why not fixed this? Well backwards compatibility for one thing. # The other reason is because it was intended to accommodate this # use case. Let's say I have us-west-2 set as my default region, # possibly through an env var or config variable. Well, by default, # we'd make a call like: client = self.session.create_client('iam', 'us-west-2') # Instead of giving the user an error, we should instead give # them the partition-global endpoint. self.assertEqual(client.meta.region_name, 'aws-global') # But if they request an endpoint that we *do* know about, we use # that specific endpoint. client = self.session.create_client('iam', 'aws-us-gov-global') self.assertEqual(client.meta.region_name, 'aws-us-gov-global') botocore-1.5.7/tests/unit/test_errorfactory.py0000666454262600001440000001274513042511306022671 0ustar pysdk-ciamazon00000000000000# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest from botocore.exceptions import ClientError from botocore.errorfactory import BaseClientExceptions from botocore.errorfactory import ClientExceptionsFactory from botocore.model import ServiceModel class TestBaseClientExceptions(unittest.TestCase): def setUp(self): self.code_to_exception = {} self.exceptions = BaseClientExceptions(self.code_to_exception) def test_has_client_error(self): self.assertIs(self.exceptions.ClientError, ClientError) def test_from_code(self): exception_cls = type('MyException', (ClientError,), {}) self.code_to_exception['MyExceptionCode'] = exception_cls self.assertIs( self.exceptions.from_code('MyExceptionCode'), exception_cls) def test_from_code_nonmatch_defaults_to_client_error(self): self.assertIs( self.exceptions.from_code('SomeUnknownErrorCode'), ClientError) def test_gettattr_message(self): exception_cls = type('MyException', (ClientError,), {}) self.code_to_exception['MyExceptionCode'] = exception_cls with self.assertRaisesRegexp( AttributeError, 'Valid exceptions are: MyException'): self.exceptions.SomeUnmodeledError class TestClientExceptionsFactory(unittest.TestCase): def setUp(self): self.model = { "metadata": { 'endpointPrefix': 'myservice', 'serviceFullName': 'MyService', }, 'operations': { 'OperationName': { 'name': 'OperationName', 'errors': [ {'shape': 'ExceptionMissingCode'}, {'shape': 'ExceptionWithModeledCode'}, ], }, 'AnotherOperationName': { 'name': 'AnotherOperationName', 'errors': [ {'shape': 'ExceptionForAnotherOperation'}, {'shape': 'ExceptionWithModeledCode'}, ], } }, 'shapes': { 'ExceptionWithModeledCode': { 'type': 'structure', 'members': {}, 'error': { 'code': 'ModeledCode' }, 'exception': True, }, 'ExceptionMissingCode': { 'type': 'structure', 'members': {}, 'exception': True, }, 'ExceptionForAnotherOperation': { 'type': 'structure', 'members': {}, 'exception': True, } } } self.service_model = ServiceModel(self.model) self.exceptions_factory = ClientExceptionsFactory() def test_class_name(self): exceptions = self.exceptions_factory.create_client_exceptions( self.service_model) self.assertEqual(exceptions.__class__.__name__, 'MyServiceExceptions') def test_creates_modeled_exception(self): exceptions = self.exceptions_factory.create_client_exceptions( self.service_model) self.assertTrue(hasattr(exceptions, 'ExceptionWithModeledCode')) modeled_exception = exceptions.ExceptionWithModeledCode self.assertEqual( modeled_exception.__name__, 'ExceptionWithModeledCode') self.assertTrue(issubclass(modeled_exception, ClientError)) def test_collects_modeled_exceptions_for_all_operations(self): exceptions = self.exceptions_factory.create_client_exceptions( self.service_model) # Make sure exceptions were added for all operations by checking # an exception only found on an a different operation. self.assertTrue(hasattr(exceptions, 'ExceptionForAnotherOperation')) modeled_exception = exceptions.ExceptionForAnotherOperation self.assertEqual( modeled_exception.__name__, 'ExceptionForAnotherOperation') self.assertTrue(issubclass(modeled_exception, ClientError)) def test_creates_modeled_exception_mapping_that_has_code(self): exceptions = self.exceptions_factory.create_client_exceptions( self.service_model) exception = exceptions.from_code('ModeledCode') self.assertEqual(exception.__name__, 'ExceptionWithModeledCode') self.assertTrue(issubclass(exception, ClientError)) def test_creates_modeled_exception_mapping_that_has_no_code(self): exceptions = self.exceptions_factory.create_client_exceptions( self.service_model) # For exceptions that do not have an explicit code associated to them, # the code is the name of the exception. exception = exceptions.from_code('ExceptionMissingCode') self.assertEqual(exception.__name__, 'ExceptionMissingCode') self.assertTrue(issubclass(exception, ClientError)) botocore-1.5.7/tests/unit/test_parsers.py0000666454262600001440000010646313042511306021630 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest import datetime import collections from dateutil.tz import tzutc from nose.tools import assert_equal from botocore import parsers from botocore import model from botocore.compat import json # HTTP responses will typically return a custom HTTP # dict. We want to ensure we're able to work with any # kind of mutable mapping implementation. class CustomHeaderDict(collections.MutableMapping): def __init__(self, original_dict): self._d = original_dict def __getitem__(self, item): return self._d[item] def __setitem__(self, item, value): self._d[item] = value def __delitem__(self, item): del self._d[item] def __iter__(self): return iter(self._d) def __len__(self): return len(self._d) # These tests contain botocore specific tests that either # don't make sense in the protocol tests or haven't been added # yet. class TestResponseMetadataParsed(unittest.TestCase): def test_response_metadata_parsed_for_query_service(self): parser = parsers.QueryParser() response = ( '' ' myname' ' ' ' request-id' ' ' '').encode('utf-8') output_shape = model.StructureShape( 'OutputShape', { 'type': 'structure', 'resultWrapper': 'OperationNameResult', 'members': { 'Str': { 'shape': 'StringType', }, 'Num': { 'shape': 'IntegerType', } } }, model.ShapeResolver({ 'StringType': { 'type': 'string', }, 'IntegerType': { 'type': 'integer', } }) ) parsed = parser.parse( {'body': response, 'headers': {}, 'status_code': 200}, output_shape) self.assertEqual( parsed, {'Str': 'myname', 'ResponseMetadata': {'RequestId': 'request-id', 'HTTPStatusCode': 200, 'HTTPHeaders': {}}}) def test_metadata_always_exists_for_query(self): # ResponseMetadata is used for more than just the request id. It # should always get populated, even if the request doesn't seem to # have an id. parser = parsers.QueryParser() response = ( '' ' myname' '').encode('utf-8') output_shape = model.StructureShape( 'OutputShape', { 'type': 'structure', 'resultWrapper': 'OperationNameResult', 'members': { 'Str': { 'shape': 'StringType', }, 'Num': { 'shape': 'IntegerType', } } }, model.ShapeResolver({ 'StringType': { 'type': 'string', }, 'IntegerType': { 'type': 'integer', } }) ) parsed = parser.parse( {'body': response, 'headers': {}, 'status_code': 200}, output_shape) expected = { 'Str': 'myname', 'ResponseMetadata': { 'HTTPStatusCode': 200, 'HTTPHeaders': {} } } self.assertEqual(parsed, expected) def test_response_metadata_parsed_for_ec2(self): parser = parsers.EC2QueryParser() response = ( '' ' myname' ' request-id' '').encode('utf-8') output_shape = model.StructureShape( 'OutputShape', { 'type': 'structure', 'members': { 'Str': { 'shape': 'StringType', } } }, model.ShapeResolver({'StringType': {'type': 'string'}}) ) parsed = parser.parse({'headers': {}, 'body': response, 'status_code': 200}, output_shape) # Note that the response metadata is normalized to match the query # protocol, even though this is not how it appears in the output. self.assertEqual( parsed, {'Str': 'myname', 'ResponseMetadata': {'RequestId': 'request-id', 'HTTPStatusCode': 200, 'HTTPHeaders': {}}}) def test_metadata_always_exists_for_ec2(self): # ResponseMetadata is used for more than just the request id. It # should always get populated, even if the request doesn't seem to # have an id. parser = parsers.EC2QueryParser() response = ( '' ' myname' '').encode('utf-8') output_shape = model.StructureShape( 'OutputShape', { 'type': 'structure', 'members': { 'Str': { 'shape': 'StringType', } } }, model.ShapeResolver({'StringType': {'type': 'string'}}) ) parsed = parser.parse( {'headers': {}, 'body': response, 'status_code': 200}, output_shape) expected = { 'Str': 'myname', 'ResponseMetadata': { 'HTTPStatusCode': 200, 'HTTPHeaders': {} } } self.assertEqual( parsed, expected) def test_response_metadata_on_json_request(self): parser = parsers.JSONParser() response = b'{"Str": "mystring"}' headers = {'x-amzn-requestid': 'request-id'} output_shape = model.StructureShape( 'OutputShape', { 'type': 'structure', 'members': { 'Str': { 'shape': 'StringType', } } }, model.ShapeResolver({'StringType': {'type': 'string'}}) ) parsed = parser.parse({'body': response, 'headers': headers, 'status_code': 200}, output_shape) # Note that the response metadata is normalized to match the query # protocol, even though this is not how it appears in the output. self.assertEqual( parsed, {'Str': 'mystring', 'ResponseMetadata': {'RequestId': 'request-id', 'HTTPStatusCode': 200, 'HTTPHeaders': headers}}) def test_metadata_always_exists_for_json(self): # ResponseMetadata is used for more than just the request id. It # should always get populated, even if the request doesn't seem to # have an id. parser = parsers.JSONParser() response = b'{"Str": "mystring"}' headers = {} output_shape = model.StructureShape( 'OutputShape', { 'type': 'structure', 'members': { 'Str': { 'shape': 'StringType', } } }, model.ShapeResolver({'StringType': {'type': 'string'}}) ) parsed = parser.parse( {'body': response, 'headers': headers, 'status_code': 200}, output_shape) expected = { 'Str': 'mystring', 'ResponseMetadata': { 'HTTPStatusCode': 200, 'HTTPHeaders': headers } } self.assertEqual(parsed, expected) def test_response_metadata_on_rest_json_response(self): parser = parsers.RestJSONParser() response = b'{"Str": "mystring"}' headers = {'x-amzn-requestid': 'request-id'} output_shape = model.StructureShape( 'OutputShape', { 'type': 'structure', 'members': { 'Str': { 'shape': 'StringType', } } }, model.ShapeResolver({'StringType': {'type': 'string'}}) ) parsed = parser.parse({'body': response, 'headers': headers, 'status_code': 200}, output_shape) # Note that the response metadata is normalized to match the query # protocol, even though this is not how it appears in the output. self.assertEqual( parsed, {'Str': 'mystring', 'ResponseMetadata': {'RequestId': 'request-id', 'HTTPStatusCode': 200, 'HTTPHeaders': headers}}) def test_metadata_always_exists_on_rest_json_response(self): # ResponseMetadata is used for more than just the request id. It # should always get populated, even if the request doesn't seem to # have an id. parser = parsers.RestJSONParser() response = b'{"Str": "mystring"}' headers = {} output_shape = model.StructureShape( 'OutputShape', { 'type': 'structure', 'members': { 'Str': { 'shape': 'StringType', } } }, model.ShapeResolver({'StringType': {'type': 'string'}}) ) parsed = parser.parse( {'body': response, 'headers': headers, 'status_code': 200}, output_shape) expected = { 'Str': 'mystring', 'ResponseMetadata': { 'HTTPStatusCode': 200, 'HTTPHeaders': headers } } self.assertEqual(parsed, expected) def test_response_metadata_from_s3_response(self): # Even though s3 is a rest-xml service, it's response metadata # is slightly different. It has two request ids, both come from # the response headers, are both are named differently from other # rest-xml responses. headers = { 'x-amz-id-2': 'second-id', 'x-amz-request-id': 'request-id' } parser = parsers.RestXMLParser() parsed = parser.parse( {'body': '', 'headers': headers, 'status_code': 200}, None) self.assertEqual( parsed, {'ResponseMetadata': {'RequestId': 'request-id', 'HostId': 'second-id', 'HTTPStatusCode': 200, 'HTTPHeaders': headers}}) def test_metadata_always_exists_on_rest_xml_response(self): # ResponseMetadata is used for more than just the request id. It # should always get populated, even if the request doesn't seem to # have an id. headers = {} parser = parsers.RestXMLParser() parsed = parser.parse( {'body': '', 'headers': headers, 'status_code': 200}, None) expected = { 'ResponseMetadata': { 'HTTPStatusCode': 200, 'HTTPHeaders': headers } } self.assertEqual(parsed, expected) class TestHeaderResponseInclusion(unittest.TestCase): def create_parser(self): return parsers.JSONParser() def create_arbitary_output_shape(self): output_shape = model.StructureShape( 'OutputShape', { 'type': 'structure', 'members': { 'Str': { 'shape': 'StringType', } } }, model.ShapeResolver({'StringType': {'type': 'string'}}) ) return output_shape def test_can_add_errors_into_response(self): parser = self.create_parser() headers = { 'x-amzn-requestid': 'request-id', 'Header1': 'foo', 'Header2': 'bar', } output_shape = self.create_arbitary_output_shape() parsed = parser.parse( {'body': b'{}', 'headers': headers, 'status_code': 200}, output_shape) # Response headers should be mapped as HTTPHeaders. self.assertEqual( parsed['ResponseMetadata']['HTTPHeaders'], headers) def test_can_always_json_serialize_headers(self): parser = self.create_parser() original_headers = { 'x-amzn-requestid': 'request-id', 'Header1': 'foo', } headers = CustomHeaderDict(original_headers) output_shape = self.create_arbitary_output_shape() parsed = parser.parse( {'body': b'{}', 'headers': headers, 'status_code': 200}, output_shape) metadata = parsed['ResponseMetadata'] # We've had the contract that you can json serialize a # response. So we want to ensure that despite using a CustomHeaderDict # we can always JSON dumps the response metadata. self.assertEqual( json.loads(json.dumps(metadata))['HTTPHeaders']['Header1'], 'foo') class TestResponseParsingDatetimes(unittest.TestCase): def test_can_parse_float_timestamps(self): # The type "timestamp" can come back as both an integer or as a float. # We need to make sure we handle the case where the timestamp comes # back as a float. It might make sense to move this to protocol tests. output_shape = model.Shape(shape_name='datetime', shape_model={'type': 'timestamp'}) parser = parsers.JSONParser() timestamp_as_float = b'1407538750.49' expected_parsed = datetime.datetime( 2014, 8, 8, 22, 59, 10, 490000, tzinfo=tzutc()) parsed = parser.parse( {'body': timestamp_as_float, 'headers': [], 'status_code': 200}, output_shape) self.assertEqual(parsed, expected_parsed) class TestCanDecorateResponseParsing(unittest.TestCase): def setUp(self): self.factory = parsers.ResponseParserFactory() def create_request_dict(self, with_body): return { 'body': with_body, 'headers': [], 'status_code': 200 } def test_normal_blob_parsing(self): output_shape = model.Shape(shape_name='BlobType', shape_model={'type': 'blob'}) parser = self.factory.create_parser('json') hello_world_b64 = b'"aGVsbG8gd29ybGQ="' expected_parsed = b'hello world' parsed = parser.parse( self.create_request_dict(with_body=hello_world_b64), output_shape) self.assertEqual(parsed, expected_parsed) def test_can_decorate_scalar_parsing(self): output_shape = model.Shape(shape_name='BlobType', shape_model={'type': 'blob'}) # Here we're overriding the blob parser so that # we can change it to a noop parser. self.factory.set_parser_defaults( blob_parser=lambda x: x) parser = self.factory.create_parser('json') hello_world_b64 = b'"aGVsbG8gd29ybGQ="' expected_parsed = "aGVsbG8gd29ybGQ=" parsed = parser.parse( self.create_request_dict(with_body=hello_world_b64), output_shape) self.assertEqual(parsed, expected_parsed) def test_can_decorate_timestamp_parser(self): output_shape = model.Shape(shape_name='datetime', shape_model={'type': 'timestamp'}) # Here we're overriding the timestamp parser so that # we can change it to just convert a string to an integer # instead of converting to a datetime. self.factory.set_parser_defaults( timestamp_parser=lambda x: int(x)) parser = self.factory.create_parser('json') timestamp_as_int = b'1407538750' expected_parsed = int(timestamp_as_int) parsed = parser.parse( self.create_request_dict(with_body=timestamp_as_int), output_shape) self.assertEqual(parsed, expected_parsed) class TestHandlesNoOutputShape(unittest.TestCase): """Verify that each protocol handles no output shape properly.""" def test_empty_rest_json_response(self): headers = {'x-amzn-requestid': 'request-id'} parser = parsers.RestJSONParser() output_shape = None parsed = parser.parse( {'body': b'', 'headers': headers, 'status_code': 200}, output_shape) self.assertEqual( parsed, {'ResponseMetadata': {'RequestId': 'request-id', 'HTTPStatusCode': 200, 'HTTPHeaders': headers}}) def test_empty_rest_xml_response(self): # This is the format used by cloudfront, route53. headers = {'x-amzn-requestid': 'request-id'} parser = parsers.RestXMLParser() output_shape = None parsed = parser.parse( {'body': b'', 'headers': headers, 'status_code': 200}, output_shape) self.assertEqual( parsed, {'ResponseMetadata': {'RequestId': 'request-id', 'HTTPStatusCode': 200, 'HTTPHeaders': headers}}) def test_empty_query_response(self): body = ( b'' b' ' b' request-id' b' ' b'' ) parser = parsers.QueryParser() output_shape = None parsed = parser.parse( {'body': body, 'headers': {}, 'status_code': 200}, output_shape) self.assertEqual( parsed, {'ResponseMetadata': {'RequestId': 'request-id', 'HTTPStatusCode': 200, 'HTTPHeaders': {}}}) def test_empty_json_response(self): headers = {'x-amzn-requestid': 'request-id'} # Output shape of None represents no output shape in the model. output_shape = None parser = parsers.JSONParser() parsed = parser.parse( {'body': b'', 'headers': headers, 'status_code': 200}, output_shape) self.assertEqual( parsed, {'ResponseMetadata': {'RequestId': 'request-id', 'HTTPStatusCode': 200, 'HTTPHeaders': headers}}) class TestHandlesInvalidXMLResponses(unittest.TestCase): def test_invalid_xml_shown_in_error_message(self): # Missing the closing XML tags. invalid_xml = ( b'' b' ' ) parser = parsers.QueryParser() output_shape = None # The XML body should be in the error message. with self.assertRaisesRegexp(parsers.ResponseParserError, '' '' ' first_value' ' middle_value' ' last_value' '' ) builder = model.DenormalizedStructureBuilder() output_shape = builder.with_members({ 'Foo': { 'type': 'structure', 'members': { 'Bar': { 'type': 'string', } } } }).build_model() parsed = parser.parse( {'body': body, 'headers': headers, 'status_code': 200}, output_shape) # Ensure the first element is used out of the list. self.assertEqual(parsed['Foo'], {'Bar': 'first_value'}) class TestParseErrorResponses(unittest.TestCase): # This class consolidates all the error parsing tests # across all the protocols. We may potentially pull # this into the shared protocol tests in the future, # so consolidating them into a single class will make # this easier. def test_response_metadata_errors_for_json_protocol(self): parser = parsers.JSONParser() response = { "body": b""" {"__type":"amazon.foo.validate#ValidationException", "message":"this is a message"} """, "status_code": 400, "headers": { "x-amzn-requestid": "request-id" } } parsed = parser.parse(response, None) # Even (especially) on an error condition, the # ResponseMetadata should be populated. self.assertIn('ResponseMetadata', parsed) self.assertEqual(parsed['ResponseMetadata']['RequestId'], 'request-id') self.assertIn('Error', parsed) self.assertEqual(parsed['Error']['Message'], 'this is a message') self.assertEqual(parsed['Error']['Code'], 'ValidationException') def test_response_metadata_errors_alternate_form_json_protocol(self): # Sometimes there is no '#' in the __type. We need to be # able to parse this error message as well. parser = parsers.JSONParser() response = { "body": b""" {"__type":"ValidationException", "message":"this is a message"} """, "status_code": 400, "headers": { "x-amzn-requestid": "request-id" } } parsed = parser.parse(response, None) self.assertIn('Error', parsed) self.assertEqual(parsed['Error']['Message'], 'this is a message') self.assertEqual(parsed['Error']['Code'], 'ValidationException') def test_parse_error_response_for_query_protocol(self): body = ( '' ' ' ' Sender' ' InvalidInput' ' ARN asdf is not valid.' ' ' ' request-id' '' ).encode('utf-8') parser = parsers.QueryParser() parsed = parser.parse({ 'body': body, 'headers': {}, 'status_code': 400}, None) self.assertIn('Error', parsed) self.assertEqual(parsed['Error'], { 'Code': 'InvalidInput', 'Message': 'ARN asdf is not valid.', 'Type': 'Sender', }) def test_can_parse_sdb_error_response_query_protocol(self): body = ( '' ' ' ' ' ' 1' ' msg' ' ' ' ' ' abc-123' '' ).encode('utf-8') parser = parsers.QueryParser() parsed = parser.parse({ 'body': body, 'headers': {}, 'status_code': 500}, None) self.assertIn('Error', parsed) self.assertEqual(parsed['Error'], { 'Code': '1', 'Message': 'msg' }) self.assertEqual(parsed['ResponseMetadata'], { 'RequestId': 'abc-123', 'HTTPStatusCode': 500, 'HTTPHeaders': {} }) def test_can_parser_ec2_errors(self): body = ( '' ' ' ' ' ' InvalidInstanceID.NotFound' ' The instance ID i-12345 does not exist' ' ' ' ' ' 06f382b0-d521-4bb6-988c-ca49d5ae6070' '' ).encode('utf-8') parser = parsers.EC2QueryParser() parsed = parser.parse({ 'body': body, 'headers': {}, 'status_code': 400}, None) self.assertIn('Error', parsed) self.assertEqual(parsed['Error'], { 'Code': 'InvalidInstanceID.NotFound', 'Message': 'The instance ID i-12345 does not exist', }) def test_can_parse_rest_xml_errors(self): body = ( '' ' ' ' Sender' ' NoSuchHostedZone' ' No hosted zone found with ID: foobar' ' ' ' bc269cf3-d44f-11e5-8779-2d21c30eb3f1' '' ).encode('utf-8') parser = parsers.RestXMLParser() parsed = parser.parse({ 'body': body, 'headers': {}, 'status_code': 400}, None) self.assertIn('Error', parsed) self.assertEqual(parsed['Error'], { 'Code': 'NoSuchHostedZone', 'Message': 'No hosted zone found with ID: foobar', 'Type': 'Sender', }) def test_can_parse_rest_json_errors(self): body = ( '{"Message":"Function not found: foo","Type":"User"}' ).encode('utf-8') headers = { 'x-amzn-requestid': 'request-id', 'x-amzn-errortype': 'ResourceNotFoundException:http://url/', } parser = parsers.RestJSONParser() parsed = parser.parse({ 'body': body, 'headers': headers, 'status_code': 400}, None) self.assertIn('Error', parsed) self.assertEqual(parsed['Error'], { 'Code': 'ResourceNotFoundException', 'Message': 'Function not found: foo', }) def test_error_response_with_no_body_rest_json(self): parser = parsers.RestJSONParser() response = b'' headers = {'content-length': '0', 'connection': 'keep-alive'} output_shape = None parsed = parser.parse({'body': response, 'headers': headers, 'status_code': 504}, output_shape) self.assertIn('Error', parsed) self.assertEqual(parsed['Error'], { 'Code': '504', 'Message': 'Gateway Timeout' }) self.assertEqual(parsed['ResponseMetadata'], { 'HTTPStatusCode': 504, 'HTTPHeaders': headers }) def test_error_response_with_string_body_rest_json(self): parser = parsers.RestJSONParser() response = b'HTTP content length exceeded 1049600 bytes.' headers = {'content-length': '0', 'connection': 'keep-alive'} output_shape = None parsed = parser.parse({'body': response, 'headers': headers, 'status_code': 413}, output_shape) self.assertIn('Error', parsed) self.assertEqual(parsed['Error'], { 'Code': '413', 'Message': response.decode('utf-8') }) self.assertEqual(parsed['ResponseMetadata'], { 'HTTPStatusCode': 413, 'HTTPHeaders': headers }) def test_error_response_with_xml_body_rest_json(self): parser = parsers.RestJSONParser() response = ( '' ' Unable to determine service/operation name to be authorized' '' ).encode('utf-8') headers = {'content-length': '0', 'connection': 'keep-alive'} output_shape = None parsed = parser.parse({'body': response, 'headers': headers, 'status_code': 403}, output_shape) self.assertIn('Error', parsed) self.assertEqual(parsed['Error'], { 'Code': '403', 'Message': response.decode('utf-8') }) self.assertEqual(parsed['ResponseMetadata'], { 'HTTPStatusCode': 403, 'HTTPHeaders': headers }) def test_s3_error_response(self): body = ( '' ' NoSuchBucket' ' error message' ' asdf' ' EF1EF43A74415102' ' hostid' '' ).encode('utf-8') headers = { 'x-amz-id-2': 'second-id', 'x-amz-request-id': 'request-id' } parser = parsers.RestXMLParser() parsed = parser.parse( {'body': body, 'headers': headers, 'status_code': 400}, None) self.assertIn('Error', parsed) self.assertEqual(parsed['Error'], { 'Code': 'NoSuchBucket', 'Message': 'error message', 'BucketName': 'asdf', # We don't want the RequestId/HostId because they're already # present in the ResponseMetadata key. }) self.assertEqual(parsed['ResponseMetadata'], { 'RequestId': 'request-id', 'HostId': 'second-id', 'HTTPStatusCode': 400, 'HTTPHeaders': headers }) def test_s3_error_response_with_no_body(self): # If you try to HeadObject a key that does not exist, # you will get an empty body. When this happens # we expect that we will use Code/Message from the # HTTP status code. body = '' headers = { 'x-amz-id-2': 'second-id', 'x-amz-request-id': 'request-id' } parser = parsers.RestXMLParser() parsed = parser.parse( {'body': body, 'headers': headers, 'status_code': 404}, None) self.assertIn('Error', parsed) self.assertEqual(parsed['Error'], { 'Code': '404', 'Message': 'Not Found', }) self.assertEqual(parsed['ResponseMetadata'], { 'RequestId': 'request-id', 'HostId': 'second-id', 'HTTPStatusCode': 404, 'HTTPHeaders': headers }) def test_can_parse_glacier_error_response(self): body = (b'{"code":"AccessDeniedException","type":"Client","message":' b'"Access denied"}') headers = { 'x-amzn-requestid': 'request-id' } parser = parsers.RestJSONParser() parsed = parser.parse( {'body': body, 'headers': headers, 'status_code': 400}, None) self.assertEqual(parsed['Error'], {'Message': 'Access denied', 'Code': 'AccessDeniedException'}) def test_can_parse_restjson_error_code(self): body = b'''{ "status": "error", "errors": [{"message": "[*Deprecated*: blah"}], "adds": 0, "__type": "#WasUnableToParseThis", "message": "blah", "deletes": 0}''' headers = { 'x-amzn-requestid': 'request-id' } parser = parsers.RestJSONParser() parsed = parser.parse( {'body': body, 'headers': headers, 'status_code': 400}, None) self.assertEqual(parsed['Error'], {'Message': 'blah', 'Code': 'WasUnableToParseThis'}) def test_can_parse_with_case_insensitive_keys(self): body = (b'{"Code":"AccessDeniedException","type":"Client","Message":' b'"Access denied"}') headers = { 'x-amzn-requestid': 'request-id' } parser = parsers.RestJSONParser() parsed = parser.parse( {'body': body, 'headers': headers, 'status_code': 400}, None) self.assertEqual(parsed['Error'], {'Message': 'Access denied', 'Code': 'AccessDeniedException'}) def test_can_parse_route53_with_missing_message(self): # The message isn't always in the XML response (or even the headers). # We should be able to handle this gracefully and still at least # populate a "Message" key so that consumers don't have to # conditionally check for this. body = ( '' ' ' ' Sender' ' InvalidInput' ' ' ' id' '' ).encode('utf-8') parser = parsers.RestXMLParser() parsed = parser.parse({ 'body': body, 'headers': {}, 'status_code': 400}, None) error = parsed['Error'] self.assertEqual(error['Code'], 'InvalidInput') # Even though there's no we should # still populate an empty string. self.assertEqual(error['Message'], '') def test_can_handle_generic_error_message(): # There are times when you can get a service to respond with a generic # html error page. We should be able to handle this case. for parser_cls in parsers.PROTOCOL_PARSERS.values(): generic_html_body = ( 'Http/1.1 Service Unavailable' ).encode('utf-8') empty_body = b'' yield _assert_parses_generic_error, parser_cls(), generic_html_body yield _assert_parses_generic_error, parser_cls(), empty_body def _assert_parses_generic_error(parser, body): # There are times when you can get a service to respond with a generic # html error page. We should be able to handle this case. parsed = parser.parse({ 'body': body, 'headers': {}, 'status_code': 503}, None) assert_equal( parsed['Error'], {'Code': '503', 'Message': 'Service Unavailable'}) assert_equal(parsed['ResponseMetadata']['HTTPStatusCode'], 503) botocore-1.5.7/tests/unit/test_session.py0000666454262600001440000007544713042511306021643 0ustar pysdk-ciamazon00000000000000#!/usr/bin/env # Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import botocore.config from tests import unittest, create_session, temporary_file import os import logging import tempfile import shutil import mock import botocore.session import botocore.exceptions from botocore.model import ServiceModel from botocore import client from botocore.hooks import HierarchicalEmitter from botocore.waiter import WaiterModel from botocore.paginate import PaginatorModel import botocore.loaders class BaseSessionTest(unittest.TestCase): def setUp(self): self.env_vars = { 'profile': (None, 'FOO_PROFILE', None, None), 'region': ('foo_region', 'FOO_REGION', None, None), 'data_path': ('data_path', 'FOO_DATA_PATH', None, None), 'config_file': (None, 'FOO_CONFIG_FILE', None, None), 'credentials_file': (None, None, '/tmp/nowhere', None), 'ca_bundle': ('foo_ca_bundle', 'FOO_AWS_CA_BUNDLE', None, None), 'api_versions': ('foo_api_versions', None, {}, None) } self.environ = {} self.environ_patch = mock.patch('os.environ', self.environ) self.environ_patch.start() self.environ['FOO_PROFILE'] = 'foo' self.environ['FOO_REGION'] = 'us-west-11' data_path = os.path.join(os.path.dirname(__file__), 'data') self.environ['FOO_DATA_PATH'] = data_path config_path = os.path.join(os.path.dirname(__file__), 'cfg', 'foo_config') self.environ['FOO_CONFIG_FILE'] = config_path self.session = create_session(session_vars=self.env_vars) def tearDown(self): self.environ_patch.stop() class SessionTest(BaseSessionTest): def close_log_file_handler(self, tempdir, filename): logger = logging.getLogger('botocore') handlers = logger.handlers for handler in handlers[:]: if hasattr(handler, 'stream') and handler.stream.name == filename: handler.stream.close() logger.removeHandler(handler) os.remove(filename) # logging has an atexit handler that will try to flush/close # the file. By setting this flag to False, we'll prevent it # from raising an exception, which is fine because we're # handling the closing of the file ourself. logging.raiseExceptions = False shutil.rmtree(tempdir) def test_supports_multiple_env_vars_for_single_logical_name(self): env_vars = { 'profile': (None, ['BAR_DEFAULT_PROFILE', 'BAR_PROFILE'], None, None), } session = create_session(session_vars=env_vars) self.environ['BAR_DEFAULT_PROFILE'] = 'first' self.environ['BAR_PROFILE'] = 'second' self.assertEqual(session.get_config_variable('profile'), 'first') def test_profile_when_set_explicitly(self): session = create_session(session_vars=self.env_vars, profile='asdf') self.assertEqual(session.profile, 'asdf') def test_profile_when_pulled_from_env(self): self.environ['FOO_PROFILE'] = 'bar' # Even though we didn't explicitly pass in a profile, the # profile property will still look this up for us. self.assertEqual(self.session.profile, 'bar') def test_multiple_env_vars_uses_second_var(self): env_vars = { 'profile': (None, ['BAR_DEFAULT_PROFILE', 'BAR_PROFILE'], None, None), } session = create_session(session_vars=env_vars) self.environ.pop('BAR_DEFAULT_PROFILE', None) self.environ['BAR_PROFILE'] = 'second' self.assertEqual(session.get_config_variable('profile'), 'second') def test_profile(self): self.assertEqual(self.session.get_config_variable('profile'), 'foo') self.assertEqual(self.session.get_config_variable('region'), 'us-west-11') self.session.get_config_variable('profile') == 'default' saved_region = self.environ['FOO_REGION'] del self.environ['FOO_REGION'] saved_profile = self.environ['FOO_PROFILE'] del self.environ['FOO_PROFILE'] session = create_session(session_vars=self.env_vars) self.assertEqual(session.get_config_variable('profile'), None) self.assertEqual(session.get_config_variable('region'), 'us-west-1') self.environ['FOO_REGION'] = saved_region self.environ['FOO_PROFILE'] = saved_profile def test_profile_does_not_exist_raises_exception(self): # Given we have no profile: self.environ['FOO_PROFILE'] = 'profile_that_does_not_exist' session = create_session(session_vars=self.env_vars) with self.assertRaises(botocore.exceptions.ProfileNotFound): session.get_scoped_config() def test_variable_does_not_exist(self): session = create_session(session_vars=self.env_vars) self.assertIsNone(session.get_config_variable('foo/bar')) def test_get_aws_services_in_alphabetical_order(self): session = create_session(session_vars=self.env_vars) services = session.get_available_services() self.assertEqual(sorted(services), services) def test_profile_does_not_exist_with_default_profile(self): session = create_session(session_vars=self.env_vars) config = session.get_scoped_config() # We should have loaded this properly, and we'll check # that foo_access_key which is defined in the config # file should be present in the loaded config dict. self.assertIn('aws_access_key_id', config) def test_type_conversions_occur_when_specified(self): # Specify that we can retrieve the var from the # FOO_TIMEOUT env var, with a conversion function # of int(). self.env_vars['metadata_service_timeout'] = ( None, 'FOO_TIMEOUT', None, int) # Environment variables are always strings. self.environ['FOO_TIMEOUT'] = '10' session = create_session(session_vars=self.env_vars) # But we should type convert this to a string. self.assertEqual( session.get_config_variable('metadata_service_timeout'), 10) def test_default_profile_specified_raises_exception(self): # If you explicity set the default profile and you don't # have that in your config file, an exception is raised. config_path = os.path.join(os.path.dirname(__file__), 'cfg', 'boto_config_empty') self.environ['FOO_CONFIG_FILE'] = config_path self.environ['FOO_PROFILE'] = 'default' session = create_session(session_vars=self.env_vars) # In this case, even though we specified default, because # the boto_config_empty config file does not have a default # profile, we should be raising an exception. with self.assertRaises(botocore.exceptions.ProfileNotFound): session.get_scoped_config() def test_file_logger(self): tempdir = tempfile.mkdtemp() temp_file = os.path.join(tempdir, 'file_logger') self.session.set_file_logger(logging.DEBUG, temp_file) self.addCleanup(self.close_log_file_handler, tempdir, temp_file) self.session.get_credentials() self.assertTrue(os.path.isfile(temp_file)) with open(temp_file) as logfile: s = logfile.read() self.assertTrue('Looking for credentials' in s) def test_full_config_property(self): full_config = self.session.full_config self.assertTrue('foo' in full_config['profiles']) self.assertTrue('default' in full_config['profiles']) def test_full_config_merges_creds_file_data(self): with temporary_file('w') as f: self.session.set_config_variable('credentials_file', f.name) f.write('[newprofile]\n') f.write('aws_access_key_id=FROM_CREDS_FILE_1\n') f.write('aws_secret_access_key=FROM_CREDS_FILE_2\n') f.flush() full_config = self.session.full_config self.assertEqual(full_config['profiles']['newprofile'], {'aws_access_key_id': 'FROM_CREDS_FILE_1', 'aws_secret_access_key': 'FROM_CREDS_FILE_2'}) def test_path_not_in_available_profiles(self): with temporary_file('w') as f: self.session.set_config_variable('credentials_file', f.name) f.write('[newprofile]\n') f.write('aws_access_key_id=FROM_CREDS_FILE_1\n') f.write('aws_secret_access_key=FROM_CREDS_FILE_2\n') f.flush() profiles = self.session.available_profiles self.assertEqual( set(profiles), set(['foo', 'default', 'newprofile'])) def test_emit_delegates_to_emitter(self): calls = [] handler = lambda **kwargs: calls.append(kwargs) self.session.register('foo', handler) self.session.emit('foo') self.assertEqual(len(calls), 1) self.assertEqual(calls[0]['event_name'], 'foo') def test_emitter_can_be_passed_in(self): events = HierarchicalEmitter() session = create_session(session_vars=self.env_vars, event_hooks=events) calls = [] handler = lambda **kwargs: calls.append(kwargs) events.register('foo', handler) session.emit('foo') self.assertEqual(len(calls), 1) def test_emit_first_non_none(self): session = create_session(session_vars=self.env_vars) session.register('foo', lambda **kwargs: None) session.register('foo', lambda **kwargs: 'first') session.register('foo', lambda **kwargs: 'second') response = session.emit_first_non_none_response('foo') self.assertEqual(response, 'first') @mock.patch('logging.getLogger') @mock.patch('logging.FileHandler') def test_logger_name_can_be_passed_in(self, file_handler, get_logger): self.session.set_debug_logger('botocore.hooks') get_logger.assert_called_with('botocore.hooks') self.session.set_file_logger('DEBUG', 'debuglog', 'botocore.service') get_logger.assert_called_with('botocore.service') file_handler.assert_called_with('debuglog') @mock.patch('logging.getLogger') @mock.patch('logging.StreamHandler') @mock.patch('logging.Formatter') def test_general_purpose_logger(self, formatter, file_handler, get_logger): self.session.set_stream_logger('foo.bar', 'ERROR', format_string='foo') get_logger.assert_called_with('foo.bar') get_logger.return_value.setLevel.assert_called_with(logging.DEBUG) formatter.assert_called_with('foo') def test_register_with_unique_id(self): calls = [] handler = lambda **kwargs: calls.append(kwargs) self.session.register('foo', handler, unique_id='bar') self.session.emit('foo') self.assertEqual(calls[0]['event_name'], 'foo') calls = [] self.session.unregister('foo', unique_id='bar') self.session.emit('foo') self.assertEqual(calls, []) class TestBuiltinEventHandlers(BaseSessionTest): def setUp(self): super(TestBuiltinEventHandlers, self).setUp() self.builtin_handlers = [ ('foo', self.on_foo), ] self.foo_called = False self.handler_patch = mock.patch('botocore.handlers.BUILTIN_HANDLERS', self.builtin_handlers) self.handler_patch.start() def on_foo(self, **kwargs): self.foo_called = True def tearDown(self): super(TestBuiltinEventHandlers, self).setUp() self.handler_patch.stop() def test_registered_builtin_handlers(self): session = botocore.session.Session(self.env_vars, None, include_builtin_handlers=True) session.emit('foo') self.assertTrue(self.foo_called) class TestSessionConfigurationVars(BaseSessionTest): def test_per_session_config_vars(self): self.session.session_var_map['foobar'] = (None, 'FOOBAR', 'default', None) # Default value. self.assertEqual(self.session.get_config_variable('foobar'), 'default') # Retrieve from os environment variable. self.environ['FOOBAR'] = 'fromenv' self.assertEqual(self.session.get_config_variable('foobar'), 'fromenv') # Explicit override. self.session.set_config_variable('foobar', 'session-instance') self.assertEqual(self.session.get_config_variable('foobar'), 'session-instance') # Can disable this check via the ``methods`` arg. del self.environ['FOOBAR'] self.assertEqual(self.session.get_config_variable( 'foobar', methods=('env', 'config')), 'default') def test_default_value_can_be_overriden(self): self.session.session_var_map['foobar'] = (None, 'FOOBAR', 'default', None) self.assertEqual(self.session.get_config_variable('foobar'), 'default') class TestSessionPartitionFiles(BaseSessionTest): def test_lists_partitions_on_disk(self): mock_resolver = mock.Mock() mock_resolver.get_available_partitions.return_value = ['foo'] self.session.register_component('endpoint_resolver', mock_resolver) self.assertEquals(['foo'], self.session.get_available_partitions()) def test_proxies_list_endpoints_to_resolver(self): resolver = mock.Mock() resolver.get_available_endpoints.return_value = ['a', 'b'] self.session.register_component('endpoint_resolver', resolver) self.session.get_available_regions('foo', 'bar', True) def test_provides_empty_list_for_unknown_service_regions(self): regions = self.session.get_available_regions('__foo__') self.assertEqual([], regions) class TestSessionUserAgent(BaseSessionTest): def test_can_change_user_agent_name(self): self.session.user_agent_name = 'something-else' self.assertTrue(self.session.user_agent().startswith('something-else')) def test_can_change_user_agent_version(self): self.session.user_agent_version = '24.0' self.assertTrue(self.session.user_agent().startswith('Botocore/24.0')) def test_can_append_to_user_agent(self): self.session.user_agent_extra = 'custom-thing/other' self.assertTrue( self.session.user_agent().endswith('custom-thing/other')) def test_execution_env_not_set(self): self.assertFalse(self.session.user_agent().endswith('FooEnv')) def test_execution_env_set(self): self.environ['AWS_EXECUTION_ENV'] = 'FooEnv' self.assertTrue(self.session.user_agent().endswith(' exec-env/FooEnv')) def test_agent_extra_and_exec_env(self): self.session.user_agent_extra = 'custom-thing/other' self.environ['AWS_EXECUTION_ENV'] = 'FooEnv' user_agent = self.session.user_agent() self.assertTrue(user_agent.endswith('custom-thing/other')) self.assertIn('exec-env/FooEnv', user_agent) class TestConfigLoaderObject(BaseSessionTest): def test_config_loader_delegation(self): session = create_session(session_vars=self.env_vars, profile='credfile-profile') with temporary_file('w') as f: f.write('[credfile-profile]\naws_access_key_id=a\n') f.write('aws_secret_access_key=b\n') f.flush() session.set_config_variable('credentials_file', f.name) # Now trying to retrieve the scoped config should pull in # values from the shared credentials file. self.assertEqual(session.get_scoped_config(), {'aws_access_key_id': 'a', 'aws_secret_access_key': 'b'}) class TestGetServiceModel(BaseSessionTest): def test_get_service_model(self): loader = mock.Mock() loader.load_service_model.return_value = {} self.session.register_component('data_loader', loader) model = self.session.get_service_model('made_up') self.assertIsInstance(model, ServiceModel) self.assertEqual(model.service_name, 'made_up') class TestGetPaginatorModel(BaseSessionTest): def test_get_paginator_model(self): loader = mock.Mock() loader.load_service_model.return_value = {"pagination": {}} self.session.register_component('data_loader', loader) model = self.session.get_paginator_model('foo') # Verify we get a PaginatorModel back self.assertIsInstance(model, PaginatorModel) # Verify we called the loader correctly. loader.load_service_model.assert_called_with( 'foo', 'paginators-1', None) class TestGetWaiterModel(BaseSessionTest): def test_get_waiter_model(self): loader = mock.Mock() loader.load_service_model.return_value = {"version": 2, "waiters": {}} self.session.register_component('data_loader', loader) model = self.session.get_waiter_model('foo') # Verify we (1) get the expected return data, self.assertIsInstance(model, WaiterModel) self.assertEqual(model.waiter_names, []) # and (2) call the loader correctly. loader.load_service_model.assert_called_with( 'foo', 'waiters-2', None) class TestCreateClient(BaseSessionTest): def test_can_create_client(self): sts_client = self.session.create_client('sts', 'us-west-2') self.assertIsInstance(sts_client, client.BaseClient) def test_credential_provider_not_called_when_creds_provided(self): cred_provider = mock.Mock() self.session.register_component( 'credential_provider', cred_provider) self.session.create_client( 'sts', 'us-west-2', aws_access_key_id='foo', aws_secret_access_key='bar', aws_session_token='baz') self.assertFalse(cred_provider.load_credentials.called, "Credential provider was called even though " "explicit credentials were provided to the " "create_client call.") def test_cred_provider_called_when_partial_creds_provided(self): with self.assertRaises(botocore.exceptions.PartialCredentialsError): self.session.create_client( 'sts', 'us-west-2', aws_access_key_id='foo', aws_secret_access_key=None ) with self.assertRaises(botocore.exceptions.PartialCredentialsError): self.session.create_client( 'sts', 'us-west-2', aws_access_key_id=None, aws_secret_access_key='foo', ) @mock.patch('botocore.client.ClientCreator') def test_config_passed_to_client_creator(self, client_creator): # Make sure there is no default set self.assertEqual(self.session.get_default_client_config(), None) # The config passed to the client should be the one that is used # in creating the client. config = botocore.config.Config(region_name='us-west-2') self.session.create_client('sts', config=config) client_creator.return_value.create_client.assert_called_with( service_name=mock.ANY, region_name=mock.ANY, is_secure=mock.ANY, endpoint_url=mock.ANY, verify=mock.ANY, credentials=mock.ANY, scoped_config=mock.ANY, client_config=config, api_version=mock.ANY) @mock.patch('botocore.client.ClientCreator') def test_create_client_with_default_client_config(self, client_creator): config = botocore.config.Config() self.session.set_default_client_config(config) self.session.create_client('sts') client_creator.return_value.create_client.assert_called_with( service_name=mock.ANY, region_name=mock.ANY, is_secure=mock.ANY, endpoint_url=mock.ANY, verify=mock.ANY, credentials=mock.ANY, scoped_config=mock.ANY, client_config=config, api_version=mock.ANY) @mock.patch('botocore.client.ClientCreator') def test_create_client_with_merging_client_configs(self, client_creator): config = botocore.config.Config(region_name='us-west-2') other_config = botocore.config.Config(region_name='us-east-1') self.session.set_default_client_config(config) self.session.create_client('sts', config=other_config) # Grab the client config used in creating the client used_client_config = ( client_creator.return_value.create_client.call_args[1][ 'client_config']) # Check that the client configs were merged self.assertEqual(used_client_config.region_name, 'us-east-1') # Make sure that the client config used is not the default client # config or the one passed in. It should be a new config. self.assertIsNot(used_client_config, config) self.assertIsNot(used_client_config, other_config) def test_create_client_with_region(self): ec2_client = self.session.create_client( 'ec2', 'us-west-2') self.assertEqual(ec2_client.meta.region_name, 'us-west-2') def test_create_client_with_region_and_client_config(self): config = botocore.config.Config() # Use a client config with no region configured. ec2_client = self.session.create_client( 'ec2', region_name='us-west-2', config=config) self.assertEqual(ec2_client.meta.region_name, 'us-west-2') # If the region name is changed, it should not change the # region of the client config.region_name = 'us-east-1' self.assertEqual(ec2_client.meta.region_name, 'us-west-2') # Now make a new client with the updated client config. ec2_client = self.session.create_client( 'ec2', config=config) self.assertEqual(ec2_client.meta.region_name, 'us-east-1') def test_create_client_no_region_and_no_client_config(self): ec2_client = self.session.create_client('ec2') self.assertEqual(ec2_client.meta.region_name, 'us-west-11') @mock.patch('botocore.client.ClientCreator') def test_create_client_with_ca_bundle_from_config(self, client_creator): with temporary_file('w') as f: del self.environ['FOO_PROFILE'] self.environ['FOO_CONFIG_FILE'] = f.name self.session = create_session(session_vars=self.env_vars) f.write('[default]\n') f.write('foo_ca_bundle=config-certs.pem\n') f.flush() self.session.create_client('ec2', 'us-west-2') call_kwargs = client_creator.return_value.\ create_client.call_args[1] self.assertEqual(call_kwargs['verify'], 'config-certs.pem') @mock.patch('botocore.client.ClientCreator') def test_create_client_with_ca_bundle_from_env_var(self, client_creator): self.environ['FOO_AWS_CA_BUNDLE'] = 'env-certs.pem' self.session.create_client('ec2', 'us-west-2') call_kwargs = client_creator.return_value.create_client.call_args[1] self.assertEqual(call_kwargs['verify'], 'env-certs.pem') @mock.patch('botocore.client.ClientCreator') def test_create_client_with_verify_param(self, client_creator): self.session.create_client( 'ec2', 'us-west-2', verify='verify-certs.pem') call_kwargs = client_creator.return_value.create_client.call_args[1] self.assertEqual(call_kwargs['verify'], 'verify-certs.pem') @mock.patch('botocore.client.ClientCreator') def test_create_client_verify_param_overrides_all(self, client_creator): with temporary_file('w') as f: # Set the ca cert using the config file del self.environ['FOO_PROFILE'] self.environ['FOO_CONFIG_FILE'] = f.name self.session = create_session(session_vars=self.env_vars) f.write('[default]\n') f.write('foo_ca_bundle=config-certs.pem\n') f.flush() # Set the ca cert with an environment variable self.environ['FOO_AWS_CA_BUNDLE'] = 'env-certs.pem' # Set the ca cert using the verify parameter self.session.create_client( 'ec2', 'us-west-2', verify='verify-certs.pem') call_kwargs = client_creator.return_value.\ create_client.call_args[1] # The verify parameter should override all the other # configurations self.assertEqual(call_kwargs['verify'], 'verify-certs.pem') @mock.patch('botocore.client.ClientCreator') def test_create_client_use_no_api_version_by_default(self, client_creator): self.session.create_client('myservice', 'us-west-2') call_kwargs = client_creator.return_value.create_client.call_args[1] self.assertEqual(call_kwargs['api_version'], None) @mock.patch('botocore.client.ClientCreator') def test_create_client_uses_api_version_from_config(self, client_creator): config_api_version = '2012-01-01' with temporary_file('w') as f: del self.environ['FOO_PROFILE'] self.environ['FOO_CONFIG_FILE'] = f.name self.session = create_session(session_vars=self.env_vars) f.write('[default]\n') f.write('foo_api_versions =\n' ' myservice = %s\n' % config_api_version) f.flush() self.session.create_client('myservice', 'us-west-2') call_kwargs = client_creator.return_value.\ create_client.call_args[1] self.assertEqual(call_kwargs['api_version'], config_api_version) @mock.patch('botocore.client.ClientCreator') def test_can_specify_multiple_versions_from_config(self, client_creator): config_api_version = '2012-01-01' second_config_api_version = '2013-01-01' with temporary_file('w') as f: del self.environ['FOO_PROFILE'] self.environ['FOO_CONFIG_FILE'] = f.name self.session = create_session(session_vars=self.env_vars) f.write('[default]\n') f.write('foo_api_versions =\n' ' myservice = %s\n' ' myservice2 = %s\n' % ( config_api_version, second_config_api_version) ) f.flush() self.session.create_client('myservice', 'us-west-2') call_kwargs = client_creator.return_value.\ create_client.call_args[1] self.assertEqual(call_kwargs['api_version'], config_api_version) self.session.create_client('myservice2', 'us-west-2') call_kwargs = client_creator.return_value.\ create_client.call_args[1] self.assertEqual( call_kwargs['api_version'], second_config_api_version) @mock.patch('botocore.client.ClientCreator') def test_param_api_version_overrides_config_value(self, client_creator): config_api_version = '2012-01-01' override_api_version = '2014-01-01' with temporary_file('w') as f: del self.environ['FOO_PROFILE'] self.environ['FOO_CONFIG_FILE'] = f.name self.session = create_session(session_vars=self.env_vars) f.write('[default]\n') f.write('foo_api_versions =\n' ' myservice = %s\n' % config_api_version) f.flush() self.session.create_client( 'myservice', 'us-west-2', api_version=override_api_version) call_kwargs = client_creator.return_value.\ create_client.call_args[1] self.assertEqual(call_kwargs['api_version'], override_api_version) class TestComponentLocator(unittest.TestCase): def setUp(self): self.components = botocore.session.ComponentLocator() def test_unknown_component_raises_exception(self): with self.assertRaises(ValueError): self.components.get_component('unknown-component') def test_can_register_and_retrieve_component(self): component = object() self.components.register_component('foo', component) self.assertIs(self.components.get_component('foo'), component) def test_last_registration_wins(self): first = object() second = object() self.components.register_component('foo', first) self.components.register_component('foo', second) self.assertIs(self.components.get_component('foo'), second) def test_can_lazy_register_a_component(self): component = object() lazy = lambda: component self.components.lazy_register_component('foo', lazy) self.assertIs(self.components.get_component('foo'), component) def test_latest_registration_wins_even_if_lazy(self): first = object() second = object() lazy_second = lambda: second self.components.register_component('foo', first) self.components.lazy_register_component('foo', lazy_second) self.assertIs(self.components.get_component('foo'), second) def test_latest_registration_overrides_lazy(self): first = object() second = object() lazy_first = lambda: first self.components.lazy_register_component('foo', lazy_first) self.components.register_component('foo', second) self.assertIs(self.components.get_component('foo'), second) def test_lazy_registration_factory_does_not_remove_from_list_on_error(self): class ArbitraryError(Exception): pass def bad_factory(): raise ArbitraryError("Factory raises an exception.") self.components.lazy_register_component('foo', bad_factory) with self.assertRaises(ArbitraryError): self.components.get_component('foo') # Trying again should raise the same exception, # not an ValueError("Unknown component") with self.assertRaises(ArbitraryError): self.components.get_component('foo') class TestDefaultClientConfig(BaseSessionTest): def test_new_session_has_no_default_client_config(self): self.assertEqual(self.session.get_default_client_config(), None) def test_set_and_get_client_config(self): client_config = botocore.config.Config() self.session.set_default_client_config(client_config) self.assertIs(self.session.get_default_client_config(), client_config) botocore-1.5.7/tests/unit/test_configloader.py0000666454262600001440000001106313042511306022574 0ustar pysdk-ciamazon00000000000000#!/usr/bin/env # Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest, BaseEnvVar import os import botocore.exceptions from botocore.configloader import raw_config_parse, load_config, \ multi_file_load_config def path(filename): return os.path.join(os.path.dirname(__file__), 'cfg', filename) class TestConfigLoader(BaseEnvVar): def test_config_not_found(self): with self.assertRaises(botocore.exceptions.ConfigNotFound): loaded_config = raw_config_parse(path('aws_config_notfound')) def test_config_parse_error(self): filename = path('aws_config_bad') with self.assertRaises(botocore.exceptions.ConfigParseError): raw_config_parse(filename) def test_config(self): loaded_config = raw_config_parse(path('aws_config')) self.assertIn('default', loaded_config) self.assertIn('profile "personal"', loaded_config) def test_profile_map_conversion(self): loaded_config = load_config(path('aws_config')) self.assertIn('profiles', loaded_config) self.assertEqual(sorted(loaded_config['profiles'].keys()), ['default', 'personal']) def test_bad_profiles_are_ignored(self): filename = path('aws_bad_profile') loaded_config = load_config(filename) self.assertEqual(len(loaded_config['profiles']), 3) profiles = loaded_config['profiles'] self.assertIn('my profile', profiles) self.assertIn('personal1', profiles) self.assertIn('default', profiles) def test_nested_hierarchy_parsing(self): filename = path('aws_config_nested') loaded_config = load_config(filename) config = loaded_config['profiles']['default'] self.assertEqual(config['aws_access_key_id'], 'foo') self.assertEqual(config['region'], 'us-west-2') self.assertEqual(config['s3']['signature_version'], 's3v4') self.assertEqual(config['cloudwatch']['signature_version'], 'v4') def test_nested_hierarchy_with_no_subsection_parsing(self): filename = path('aws_config_nested') raw_config = raw_config_parse(filename, False)['default'] self.assertEqual(raw_config['aws_access_key_id'], 'foo') self.assertEqual(raw_config['region'], 'us-west-2') # Specifying False for pase_subsections in raw_config_parse # will make sure that indented sections such as singature_version # will not be treated as another subsection but rather # its literal value. self.assertEqual( raw_config['cloudwatch'], '\nsignature_version = v4') self.assertEqual( raw_config['s3'], '\nsignature_version = s3v4' '\naddressing_style = path' ) def test_nested_bad_config(self): filename = path('aws_config_nested_bad') with self.assertRaises(botocore.exceptions.ConfigParseError): loaded_config = load_config(filename) def test_multi_file_load(self): filenames = [path('aws_config_other'), path('aws_config'), path('aws_third_config'), path('aws_config_notfound')] loaded_config = multi_file_load_config(*filenames) config = loaded_config['profiles']['default'] self.assertEqual(config['aws_access_key_id'], 'other_foo') self.assertEqual(config['aws_secret_access_key'], 'other_bar') second_config = loaded_config['profiles']['personal'] self.assertEqual(second_config['aws_access_key_id'], 'fie') self.assertEqual(second_config['aws_secret_access_key'], 'baz') self.assertEqual(second_config['aws_security_token'], 'fiebaz') third_config = loaded_config['profiles']['third'] self.assertEqual(third_config['aws_access_key_id'], 'third_fie') self.assertEqual(third_config['aws_secret_access_key'], 'third_baz') self.assertEqual(third_config['aws_security_token'], 'third_fiebaz') if __name__ == "__main__": unittest.main() botocore-1.5.7/tests/unit/__init__.py0000666454262600001440000000330213042511306020635 0ustar pysdk-ciamazon00000000000000# Copyright (c) 2012-2013 Mitch Garnaat http://garnaat.org/ # Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import copy from tests import unittest class BaseResponseTest(unittest.TestCase): def assert_response_with_subset_metadata(self, actual_response, expected_response): """ Compares two parsed service responses. For ResponseMetadata, it will only assert that the expected is a proper subset of the actual. This is useful so that when new keys are added to the metadata, tests don't break. """ actual = copy.copy(actual_response) expected = copy.copy(expected_response) actual_metadata = actual.pop('ResponseMetadata', {}) expected_metadata = expected.pop('ResponseMetadata', {}) self.assertEqual(actual, expected) self.assert_dict_is_proper_subset(actual_metadata, expected_metadata) def assert_dict_is_proper_subset(self, superset, subset): """ Asserts that a dictionary is a proper subset of another. """ self.assertTrue(all((k in superset and superset[k] == v) for k, v in subset.items())) botocore-1.5.7/tests/unit/test_client.py0000666454262600001440000024525613042511306021433 0ustar pysdk-ciamazon00000000000000#!/usr/bin/env # Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import botocore.config from tests import unittest import mock import botocore from botocore import utils from botocore import client from botocore.endpoint import DEFAULT_TIMEOUT from botocore import hooks from botocore.client import ClientEndpointBridge from botocore.credentials import Credentials from botocore.exceptions import ParamValidationError from botocore.exceptions import InvalidS3AddressingStyleError from botocore.exceptions import NoRegionError from botocore.exceptions import UnknownEndpointError from botocore.exceptions import UnknownSignatureVersionError from botocore.errorfactory import ClientExceptionsFactory from botocore.stub import Stubber from botocore import exceptions from botocore.compat import six class TestAutoGeneratedClient(unittest.TestCase): def setUp(self): self.service_description = { 'metadata': { 'serviceFullName': 'AWS MyService', 'apiVersion': '2014-01-01', 'endpointPrefix': 'myservice', 'signatureVersion': 'v4', 'protocol': 'query' }, 'operations': { 'TestOperation': { 'name': 'TestOperation', 'http': { 'method': 'POST', 'requestUri': '/', }, 'input': {'shape': 'TestOperationRequest'}, 'errors': [{'shape': 'TestOperationException'}], 'documentation': 'Documents TestOperation' } }, 'shapes': { 'TestOperationRequest': { 'type': 'structure', 'required': ['Foo'], 'members': { 'Foo': {'shape': 'StringType', 'documentation': 'Documents Foo'}, 'Bar': {'shape': 'StringType', 'documentation': 'Documents Bar'}, } }, "TestOperationException": { 'type': 'structure', 'exception': True, 'error': { 'code': 'TestOperationErrorCode' } }, 'StringType': {'type': 'string'} } } self.retry_config = { "retry": { "__default__": { "max_attempts": 5, "delay": { "type": "exponential", "base": "rand", "growth_factor": 2 }, "policies": {} } } } self.loader = mock.Mock() self.loader.load_service_model.return_value = self.service_description self.loader.load_data.return_value = self.retry_config self.credentials = Credentials('access-key', 'secret-key') self.endpoint_creator_patch = mock.patch( 'botocore.args.EndpointCreator') self.endpoint_creator_cls = self.endpoint_creator_patch.start() self.endpoint_creator = self.endpoint_creator_cls.return_value self.endpoint = mock.Mock() self.endpoint.host = 'https://myservice.amazonaws.com' self.endpoint.make_request.return_value = ( mock.Mock(status_code=200), {}) self.endpoint_creator.create_endpoint.return_value = self.endpoint self.resolver = mock.Mock() self.resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'foo', 'endpointName': 'us-west-2', 'signatureVersions': ['v4'], } def tearDown(self): self.endpoint_creator_patch.stop() def create_client_creator(self, endpoint_creator=None, event_emitter=None, retry_handler_factory=None, retry_config_translator=None, response_parser_factory=None, endpoint_prefix=None, exceptions_factory=None): if event_emitter is None: event_emitter = hooks.HierarchicalEmitter() if retry_handler_factory is None: retry_handler_factory = botocore.retryhandler if retry_config_translator is None: retry_config_translator = botocore.translate if endpoint_prefix is not None: self.service_description['metadata']['endpointPrefix']\ = endpoint_prefix if endpoint_creator is not None: self.endpoint_creator_cls.return_value = endpoint_creator if exceptions_factory is None: exceptions_factory = ClientExceptionsFactory() creator = client.ClientCreator( self.loader, self.resolver, 'user-agent', event_emitter, retry_handler_factory, retry_config_translator, response_parser_factory, exceptions_factory) return creator def assert_no_param_error_raised(self, client): try: self.make_api_call_with_missing_param(client) except ParamValidationError: self.fail("ParamValidationError shouldn't be raised " "with validation disabled") def make_api_call_with_missing_param(self, service_client): # Missing required 'Foo' param. service_client.test_operation(Bar='two') def test_client_name(self): creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) self.assertTrue(service_client.__class__.__name__, 'MyService') def test_client_name_with_amazon(self): self.service_description['metadata']['serviceFullName'] = ( 'Amazon MyService') creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) self.assertTrue(service_client.__class__.__name__, 'MyService') def test_client_name_using_abreviation(self): self.service_description['metadata']['serviceAbbreviation'] = ( 'Abbreviation') creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) self.assertTrue(service_client.__class__.__name__, 'Abbreviation') def test_client_name_with_non_alphabet_characters(self): self.service_description['metadata']['serviceFullName'] = ( 'Amazon My-Service') creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) self.assertTrue(service_client.__class__.__name__, 'MyService') def test_client_name_with_no_full_name_or_abbreviation(self): del self.service_description['metadata']['serviceFullName'] creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) self.assertTrue(service_client.__class__.__name__, 'myservice') def test_client_generated_from_model(self): creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) self.assertTrue(hasattr(service_client, 'test_operation')) def test_client_method_docstring(self): creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) method_docstring = str(service_client.test_operation.__doc__) ref_docstring_lines = [ 'Documents TestOperation', '**Request Syntax**', ' response = client.test_operation(', ' Bar=\'string\'', ' Foo=\'string\'', ' )', ':type Bar: string', ':param Bar: Documents Bar', ':type Foo: string', ':param Foo: **[REQUIRED]** Documents Foo' ] for line in ref_docstring_lines: self.assertIn(line, method_docstring) def test_client_method_help(self): creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) with mock.patch('sys.stdout', six.StringIO()) as mock_stdout: help(service_client.test_operation) method_docstring = mock_stdout.getvalue() ref_docstring_lines = [ 'Documents TestOperation', '**Request Syntax**', ' response = client.test_operation(', ' Bar=\'string\'', ' Foo=\'string\'', ' )', ':type Bar: string', ':param Bar: Documents Bar', ':type Foo: string', ':param Foo: **[REQUIRED]** Documents Foo' ] for line in ref_docstring_lines: self.assertIn(line, method_docstring) def test_client_create_unicode(self): creator = self.create_client_creator() service_client = creator.create_client( u'myservice', 'us-west-2', credentials=self.credentials) self.assertTrue(hasattr(service_client, 'test_operation')) def test_client_has_region_name_on_meta(self): creator = self.create_client_creator() region_name = 'us-west-2' self.endpoint.region_name = region_name service_client = creator.create_client( 'myservice', region_name, credentials=self.credentials) self.assertEqual(service_client.meta.region_name, region_name) def test_client_has_endpoint_url_on_meta(self): creator = self.create_client_creator() self.endpoint.host = 'https://foo.bar' service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) self.assertEqual(service_client.meta.endpoint_url, 'https://foo.bar') def test_client_has_standard_partition_on_meta(self): creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) self.assertEqual(service_client.meta.partition, 'aws') def test_client_has_non_standard_partition_on_meta(self): creator = self.create_client_creator() self.resolver.construct_endpoint.return_value = { 'partition': 'aws-cn', 'hostname': 'foo', 'endpointName': 'cn-north-1', 'signatureVersions': ['v4'], } service_client = creator.create_client( 'myservice', 'cn-north-1', credentials=self.credentials) self.assertEqual(service_client.meta.partition, 'aws-cn') def test_client_has_exceptions_attribute(self): creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) self.assertTrue(hasattr(service_client, 'exceptions')) def test_client_has_modeled_exceptions(self): creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) self.assertTrue( issubclass(service_client.exceptions.TestOperationException, client.ClientError) ) def test_api_version_is_passed_to_loader_if_provided(self): creator = self.create_client_creator() self.endpoint.host = 'https://foo.bar' specific_api_version = '2014-03-01' creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials, api_version=specific_api_version) self.loader.load_service_model.assert_called_with( 'myservice', 'service-2', api_version=specific_api_version) def test_create_client_class_creates_class(self): creator = self.create_client_creator() client_class = creator.create_client_class('myservice') self.assertTrue(hasattr(client_class, 'test_operation')) def test_create_client_class_forwards_api_version(self): creator = self.create_client_creator() specific_api_version = '2014-03-01' creator.create_client_class('myservice', api_version=specific_api_version) self.loader.load_service_model.assert_called_with( 'myservice', 'service-2', api_version=specific_api_version) def test_signing_region_does_not_change_client_region(self): with mock.patch('botocore.args.RequestSigner') as mock_signer: credential_scope_region = 'us-east-1' self.resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'endpoint.url', 'endpointName': 'us-west-2', 'signatureVersions': ['v4'], 'credentialScope': {'region': credential_scope_region,} } creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) self.assertEqual(service_client.meta.region_name, 'us-west-2') call_args = mock_signer.call_args self.assertEquals(credential_scope_region, call_args[0][1]) def test_client_uses_signing_region_from_credential_scope(self): with mock.patch('botocore.args.RequestSigner') as mock_signer: credential_scope_region = 'us-east-1' self.resolver.construct_endpoint.return_value = { 'partition': 'aws', 'endpointName': 'us-west-2', 'hostname': 'endpoint.url', 'signatureVersions': ['v4'], 'credentialScope': {'region': credential_scope_region} } creator = self.create_client_creator() service_client = creator.create_client( service_name='myservice', region_name='us-west-2', credentials=self.credentials) # Use the resolved region as the region value. self.assertEqual(service_client.meta.region_name, 'us-west-2') # Ensure that we use the credential scope region for signing, # and not the resolved region name. call_args = mock_signer.call_args self.assertEquals(credential_scope_region, call_args[0][1]) def test_client_uses_signing_name_from_credential_scope(self): with mock.patch('botocore.args.RequestSigner') as mock_signer: self.resolver.construct_endpoint.return_value = { 'partition': 'aws', 'endpointName': 'us-west-2', 'hostname': 'endpoint.url', 'signatureVersions': ['v4'], 'credentialScope': {'service': 'override'} } creator = self.create_client_creator() service_client = creator.create_client( service_name='myservice', region_name='us-west-2', credentials=self.credentials) call_args = mock_signer.call_args self.assertEquals('myservice', call_args[0][0]) self.assertEquals('override', call_args[0][2]) def test_client_uses_given_region_name_and_endpoint_url_when_present(self): with mock.patch('botocore.args.RequestSigner') as mock_signer: credential_scope_region = 'us-east-1' self.resolver.construct_endpoint.return_value = { 'partition': 'aws', 'endpointName': 'us-west-2', 'hostname': 'endpoint.url', 'signatureVersions': ['v4'], 'credentialScope': {'region': credential_scope_region} } creator = self.create_client_creator() service_client = creator.create_client( service_name='myservice', region_name='us-west-2', credentials=self.credentials, endpoint_url='https://foo') self.assertEqual(service_client.meta.region_name, 'us-west-2') call_args = mock_signer.call_args self.assertEquals('us-west-2', call_args[0][1]) def test_client_uses_signing_name_from_model_if_present_if_resolved(self): self.service_description['metadata']['signingName'] = 'otherName' with mock.patch('botocore.args.RequestSigner') as mock_signer: self.resolver.construct_endpoint.return_value = { 'partition': 'aws', 'endpointName': 'us-west-2', 'hostname': 'endpoint.url', 'signatureVersions': ['v4'], } creator = self.create_client_creator() service_client = creator.create_client( service_name='myservice', region_name='us-west-2', credentials=self.credentials, endpoint_url='https://foo') self.assertEqual(service_client.meta.region_name, 'us-west-2') call_args = mock_signer.call_args[0] self.assertEquals('otherName', call_args[2]) def test_client_uses_signing_name_even_with_no_resolve(self): self.service_description['metadata']['signingName'] = 'otherName' with mock.patch('botocore.args.RequestSigner') as mock_signer: self.resolver.construct_endpoint.return_value = {} creator = self.create_client_creator() service_client = creator.create_client( service_name='myservice', region_name='us-west-2', credentials=self.credentials, endpoint_url='https://foo') self.assertEqual(service_client.meta.region_name, 'us-west-2') call_args = mock_signer.call_args[0] self.assertEquals('otherName', call_args[2]) @mock.patch('botocore.args.RequestSigner') def test_client_signature_no_override(self, request_signer): creator = self.create_client_creator() creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials, scoped_config={}) request_signer.assert_called_with( mock.ANY, mock.ANY, mock.ANY, 'v4', mock.ANY, mock.ANY) @mock.patch('botocore.args.RequestSigner') def test_client_signature_override_config_file(self, request_signer): creator = self.create_client_creator() config = { 'myservice': {'signature_version': 'foo'} } creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials, scoped_config=config) request_signer.assert_called_with( mock.ANY, mock.ANY, mock.ANY, 'foo', mock.ANY, mock.ANY) @mock.patch('botocore.args.RequestSigner') def test_client_signature_override_arg(self, request_signer): creator = self.create_client_creator() config = botocore.config.Config(signature_version='foo') creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials, client_config=config) request_signer.assert_called_with( mock.ANY, mock.ANY, mock.ANY, 'foo', mock.ANY, mock.ANY) def test_client_method_to_api_mapping(self): creator = self.create_client_creator() service_client = creator.create_client('myservice', 'us-west-2') self.assertEqual(service_client.meta.method_to_api_mapping, {'test_operation': 'TestOperation'}) def test_anonymous_client_request(self): creator = self.create_client_creator() config = botocore.config.Config(signature_version=botocore.UNSIGNED) service_client = creator.create_client( 'myservice', 'us-west-2', client_config=config) service_client.test_operation(Foo='one') # Make sure a request has been attempted self.assertTrue(self.endpoint.make_request.called) # Make sure the request parameters do NOT include auth # information. The service defined above for these tests # uses sigv4 by default (which we disable). params = dict((k.lower(), v) for k, v in self.endpoint.make_request.call_args[0][1].items()) self.assertNotIn('authorization', params) self.assertNotIn('x-amz-signature', params) def test_client_user_agent_in_request(self): creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2') service_client.test_operation(Foo='one') self.assertTrue(self.endpoint.make_request.called) params = dict((k.lower(), v) for k, v in self.endpoint.make_request.call_args[0][1].items()) self.assertEqual(params['headers']['User-Agent'], 'user-agent') def test_client_custom_user_agent_in_request(self): creator = self.create_client_creator() config = botocore.config.Config(user_agent='baz') service_client = creator.create_client( 'myservice', 'us-west-2', client_config=config) service_client.test_operation(Foo='one') self.assertTrue(self.endpoint.make_request.called) params = dict((k.lower(), v) for k, v in self.endpoint.make_request.call_args[0][1].items()) self.assertEqual(params['headers']['User-Agent'], 'baz') def test_client_custom_user_agent_extra_in_request(self): creator = self.create_client_creator() config = botocore.config.Config(user_agent_extra='extrastuff') service_client = creator.create_client( 'myservice', 'us-west-2', client_config=config) service_client.test_operation(Foo='one') headers = self.endpoint.make_request.call_args[0][1]['headers'] self.assertEqual(headers['User-Agent'], 'user-agent extrastuff') def test_client_registers_request_created_handler(self): event_emitter = mock.Mock() creator = self.create_client_creator(event_emitter=event_emitter) creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) self.assertIn( mock.call('request-created.myservice', mock.ANY), event_emitter.register.call_args_list) def test_client_makes_call(self): creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) self.assertTrue(self.endpoint_creator.create_endpoint.called) response = service_client.test_operation(Foo='one', Bar='two') self.assertEqual(response, {}) def test_client_error_message_for_positional_args(self): creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) with self.assertRaisesRegexp( TypeError, 'only accepts keyword arguments'): service_client.test_operation('foo') @mock.patch('botocore.args.RequestSigner.sign') def test_client_signs_call(self, signer_mock): creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) request = mock.Mock() # Emit the request created event to see if it would be signed. # We tested above to ensure this event is registered when # a client is created. This prevents testing the entire client # call logic. service_client.meta.events.emit( 'request-created.myservice.test_operation', request=request, operation_name='test_operation') signer_mock.assert_called_with( 'test_operation', request) def test_client_validates_params_by_default(self): creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) with self.assertRaises(ParamValidationError): self.make_api_call_with_missing_param(service_client) def test_client_doesnt_validate_params_when_validation_disabled(self): creator = self.create_client_creator() client_config = botocore.config.Config() client_config.parameter_validation = False service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials, client_config=client_config) self.assert_no_param_error_raised(service_client) def test_can_disable_param_validation_from_scoped_config(self): creator = self.create_client_creator() service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials, scoped_config={'parameter_validation': False}) self.assert_no_param_error_raised(service_client) def test_client_config_trumps_scoped_config(self): creator = self.create_client_creator() scoped_config = {'parameter_validation': True} client_config = botocore.config.Config(parameter_validation=False) # Client config should win and param validation is disabled. service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials, scoped_config=scoped_config, client_config=client_config) self.assert_no_param_error_raised(service_client) def test_client_with_custom_both_timeout(self): self.create_client_creator().create_client( 'myservice', 'us-west-2', client_config=botocore.config.Config(connect_timeout=123, read_timeout=234)) call_kwargs = self.endpoint_creator.create_endpoint.call_args[1] self.assertEqual(call_kwargs['timeout'], (123, 234)) def test_client_with_custom_connect_timeout(self): self.create_client_creator().create_client( 'myservice', 'us-west-2', client_config=botocore.config.Config(connect_timeout=123)) call_kwargs = self.endpoint_creator.create_endpoint.call_args[1] self.assertEqual(call_kwargs['timeout'], (123, DEFAULT_TIMEOUT)) def test_client_with_custom_read_timeout(self): self.create_client_creator().create_client( 'myservice', 'us-west-2', client_config=botocore.config.Config(read_timeout=234)) call_kwargs = self.endpoint_creator.create_endpoint.call_args[1] self.assertEqual(call_kwargs['timeout'], (DEFAULT_TIMEOUT, 234)) def test_client_with_custom_neither_timeout(self): self.create_client_creator().create_client('myservice', 'us-west-2') call_kwargs = self.endpoint_creator.create_endpoint.call_args[1] self.assertEqual(call_kwargs['timeout'], (DEFAULT_TIMEOUT, DEFAULT_TIMEOUT)) def test_client_with_custom_params(self): creator = self.create_client_creator() creator.create_client('myservice', 'us-west-2', is_secure=False, verify=False) call_kwargs = self.endpoint_creator.create_endpoint.call_args[1] self.assertFalse(call_kwargs['verify']) self.assertNotIn('is_secure', call_kwargs) def test_client_with_endpoint_url(self): creator = self.create_client_creator() creator.create_client('myservice', 'us-west-2', endpoint_url='http://custom.foo') call_kwargs = self.endpoint_creator.create_endpoint.call_args[1] self.assertEqual(call_kwargs['endpoint_url'], 'http://custom.foo') def test_client_can_use_guessed_endpoints(self): # Ensure the resolver returns None (meaning a guess is made) self.resolver.construct_endpoint.return_value = None creator = self.create_client_creator() client = creator.create_client('myservice', region_name='invalid') self.assertEquals('invalid', client.meta.region_name) def test_client_with_response_parser_factory(self): factory = mock.Mock() creator = self.create_client_creator(response_parser_factory=factory) creator.create_client('myservice', 'us-west-2') call_kwargs = self.endpoint_creator.create_endpoint.call_args[1] self.assertEqual(call_kwargs['response_parser_factory'], factory) def test_operation_cannot_paginate(self): pagination_config = { 'pagination': { # Note that there's no pagination config for # 'TestOperation', indicating that TestOperation # is not pageable. 'SomeOtherOperation': { "input_token": "Marker", "output_token": "Marker", "more_results": "IsTruncated", "limit_key": "MaxItems", "result_key": "Users" } } } self.loader.load_service_model.side_effect = [ self.service_description, pagination_config] creator = self.create_client_creator() service_client = creator.create_client('myservice', 'us-west-2') self.assertFalse(service_client.can_paginate('test_operation')) def test_operation_can_paginate(self): pagination_config = { 'pagination': { 'TestOperation': { "input_token": "Marker", "output_token": "Marker", "more_results": "IsTruncated", "limit_key": "MaxItems", "result_key": "Users" } } } self.loader.load_service_model.side_effect = [ self.service_description, pagination_config] creator = self.create_client_creator() service_client = creator.create_client('myservice', 'us-west-2') self.assertTrue(service_client.can_paginate('test_operation')) # Also, the config is cached, but we want to make sure we get # the same answer when we ask again. self.assertTrue(service_client.can_paginate('test_operation')) def test_service_has_no_pagination_configs(self): # This is the case where there is an actual *.paginator.json, file, # but the specific operation itself is not actually pageable. # If the loader cannot load pagination configs, it communicates # this by raising a DataNotFoundError. self.loader.load_service_model.side_effect = [ self.service_description, exceptions.DataNotFoundError(data_path='/foo')] creator = self.create_client_creator() service_client = creator.create_client('myservice', 'us-west-2') self.assertFalse(service_client.can_paginate('test_operation')) def test_waiter_config_uses_service_name_not_endpoint_prefix(self): waiter_config = { 'version': 2, 'waiters': {} } self.loader.load_service_model.side_effect = [ self.service_description, waiter_config ] creator = self.create_client_creator() # We're going to verify that the loader loads a service called # 'other-service-name', and even though the endpointPrefix is # 'myservice', we use 'other-service-name' for waiters/paginators, etc. service_client = creator.create_client('other-service-name', 'us-west-2') self.assertEqual(service_client.waiter_names, []) # Note we're using other-service-name, not # 'myservice', which is the endpointPrefix. self.loader.load_service_model.assert_called_with( 'other-service-name', 'waiters-2', '2014-01-01') def test_service_has_waiter_configs(self): waiter_config = { 'version': 2, 'waiters': { "Waiter1": { 'operation': 'TestOperation', 'delay': 5, 'maxAttempts': 20, 'acceptors': [], }, "Waiter2": { 'operation': 'TestOperation', 'delay': 5, 'maxAttempts': 20, 'acceptors': [], }, } } self.loader.load_service_model.side_effect = [ self.service_description, waiter_config ] creator = self.create_client_creator() service_client = creator.create_client('myservice', 'us-west-2') self.assertEqual(sorted(service_client.waiter_names), sorted(['waiter_1', 'waiter_2'])) self.assertTrue(hasattr(service_client.get_waiter('waiter_1'), 'wait')) def test_service_has_no_waiter_configs(self): self.loader.load_service_model.side_effect = [ self.service_description, exceptions.DataNotFoundError(data_path='/foo')] creator = self.create_client_creator() service_client = creator.create_client('myservice', 'us-west-2') self.assertEqual(service_client.waiter_names, []) with self.assertRaises(ValueError): service_client.get_waiter("unknown_waiter") def test_service_has_retry_event(self): # A retry event should be registered for the service. event_emitter = mock.Mock() creator = self.create_client_creator(event_emitter=event_emitter) creator.create_client('myservice', 'us-west-2') event_emitter.register.assert_any_call( 'needs-retry.myservice', mock.ANY, unique_id='retry-config-myservice') def test_service_creates_retryhandler(self): # A retry handler with the expected configuration should be # created when instantiating a client. retry_handler_factory = mock.Mock() creator = self.create_client_creator( retry_handler_factory=retry_handler_factory) creator.create_client('myservice', 'us-west-2') retry_handler_factory.create_retry_handler.assert_called_with({ '__default__': { 'delay': { 'growth_factor': 2, 'base': 'rand', 'type': 'exponential' }, 'policies': {}, 'max_attempts': 5 } }, 'myservice') def test_service_registers_retry_handler(self): # The retry handler returned from ``create_retry_handler`` # that was tested above needs to be set as the handler for # the event emitter. retry_handler_factory = mock.Mock() handler = mock.Mock() event_emitter = mock.Mock() retry_handler_factory.create_retry_handler.return_value = handler creator = self.create_client_creator( event_emitter=event_emitter, retry_handler_factory=retry_handler_factory) creator.create_client('myservice', 'us-west-2') event_emitter.register.assert_any_call( mock.ANY, handler, unique_id=mock.ANY) def test_service_retry_missing_config(self): # No config means we should never see any retry events registered. self.loader.load_data.return_value = {} event_emitter = mock.Mock() creator = self.create_client_creator(event_emitter=event_emitter) creator.create_client('myservice', 'us-west-2') for call in event_emitter.register.call_args_list: self.assertNotIn('needs-retry', call[0][0]) def test_try_to_paginate_non_paginated(self): self.loader.load_service_model.side_effect = [ self.service_description, exceptions.DataNotFoundError(data_path='/foo') ] creator = self.create_client_creator() service_client = creator.create_client('myservice', 'us-west-2') with self.assertRaises(exceptions.OperationNotPageableError): service_client.get_paginator('test_operation') def test_successful_pagination_object_created(self): pagination_config = { 'pagination': { 'TestOperation': { "input_token": "Marker", "output_token": "Marker", "more_results": "IsTruncated", "limit_key": "MaxItems", "result_key": "Users" } } } self.loader.load_service_model.side_effect = [ self.service_description, pagination_config ] creator = self.create_client_creator() service_client = creator.create_client('myservice', 'us-west-2') paginator = service_client.get_paginator('test_operation') # The pagination logic itself is tested elsewhere (test_paginate.py), # but we can at least make sure it looks like a paginator. self.assertTrue(hasattr(paginator, 'paginate')) def test_paginator_class_name_from_client(self): pagination_config = { 'pagination': { 'TestOperation': { "input_token": "Marker", "output_token": "Marker", "more_results": "IsTruncated", "limit_key": "MaxItems", "result_key": "Users" } } } self.loader.load_service_model.side_effect = [ self.service_description, pagination_config ] creator = self.create_client_creator() service_client = creator.create_client('myservice', 'us-west-2') paginator = service_client.get_paginator('test_operation') self.assertEqual( paginator.__class__.__name__, 'MyService.Paginator.TestOperation') def test_paginator_help_from_client(self): pagination_config = { 'pagination': { 'TestOperation': { "input_token": "Marker", "output_token": "Marker", "more_results": "IsTruncated", "limit_key": "MaxItems", "result_key": "Users" } } } self.loader.load_service_model.side_effect = [ self.service_description, pagination_config ] creator = self.create_client_creator() service_client = creator.create_client('myservice', 'us-west-2') paginator = service_client.get_paginator('test_operation') with mock.patch('sys.stdout', six.StringIO()) as mock_stdout: help(paginator.paginate) contents = mock_stdout.getvalue() lines = [ (' Creates an iterator that will paginate through responses ' 'from :py:meth:`MyService.Client.test_operation`.'), ' **Request Syntax** ', ' ::', ' response_iterator = paginator.paginate(', " Foo='string',", " Bar='string',", ' PaginationConfig={', " 'MaxItems': 123,", " 'PageSize': 123,", " 'StartingToken': 'string'", ' }', ' )', ' :type Foo: string', ' :param Foo: **[REQUIRED]** Documents Foo', ' :type Bar: string', ' :param Bar: Documents Bar', ' :type PaginationConfig: dict', ' :param PaginationConfig: ', (' A dictionary that provides parameters to control ' 'pagination.'), ' - **MaxItems** *(integer) --* ', (' The total number of items to return. If the total ' 'number of items available is more than the value specified ' 'in max-items then a ``NextToken`` will be provided in the ' 'output that you can use to resume pagination.'), ' - **PageSize** *(integer) --* ', ' The size of each page.', ' - **StartingToken** *(string) --* ', (' A token to specify where to start paginating. This is ' 'the ``NextToken`` from a previous response.'), ' :returns: None', ] for line in lines: self.assertIn(line, contents) def test_can_set_credentials_in_client_init(self): creator = self.create_client_creator() credentials = Credentials( access_key='access_key', secret_key='secret_key', token='session_token') client = creator.create_client( 'myservice', 'us-west-2', credentials=credentials) # Verify that we create an endpoint with a credentials object # matching our creds arguments. self.assertEqual(client._request_signer._credentials, credentials) def test_event_emitted_when_invoked(self): event_emitter = hooks.HierarchicalEmitter() creator = self.create_client_creator(event_emitter=event_emitter) calls = [] handler = lambda **kwargs: calls.append(kwargs) event_emitter.register('before-call', handler) service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) service_client.test_operation(Foo='one', Bar='two') self.assertEqual(len(calls), 1) def test_events_are_per_client(self): event_emitter = hooks.HierarchicalEmitter() creator = self.create_client_creator(event_emitter=event_emitter) first_calls = [] first_handler = lambda **kwargs: first_calls.append(kwargs) second_calls = [] second_handler = lambda **kwargs: second_calls.append(kwargs) first_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) second_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) first_client.meta.events.register('before-call', first_handler) second_client.meta.events.register('before-call', second_handler) # Now, if we invoke an operation from either client, only # the handlers registered with the specific client will be invoked. # So if we invoke the first client. first_client.test_operation(Foo='one', Bar='two') # Only first_calls is populated, not second_calls. self.assertEqual(len(first_calls), 1) self.assertEqual(len(second_calls), 0) # If we invoke an operation from the second client, # only second_calls will be populated, not first_calls. second_client.test_operation(Foo='one', Bar='two') # first_calls == 1 from the previous first_client.test_operation() # call. self.assertEqual(len(first_calls), 1) self.assertEqual(len(second_calls), 1) def test_clients_inherit_handlers_from_session(self): # Even though clients get their own event emitters, they still # inherit any handlers that were registered on the event emitter # at the time the client was created. event_emitter = hooks.HierarchicalEmitter() creator = self.create_client_creator(event_emitter=event_emitter) # So if an event handler is registered before any clients are created: base_calls = [] base_handler = lambda **kwargs: base_calls.append(kwargs) event_emitter.register('before-call', base_handler) # Then any client created from this point forward from the # event_emitter passed into the ClientCreator will have this # handler. first_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) first_client.test_operation(Foo='one', Bar='two') self.assertEqual(len(base_calls), 1) # Same thing if we create another client. second_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) second_client.test_operation(Foo='one', Bar='two') self.assertEqual(len(base_calls), 2) def test_clients_inherit_only_at_create_time(self): # If event handlers are added to the copied event emitter # _after_ a client is created, we don't pick those up. event_emitter = hooks.HierarchicalEmitter() creator = self.create_client_creator(event_emitter=event_emitter) # 1. Create a client. first_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) # 2. Now register an event handler from the originating event emitter. base_calls = [] base_handler = lambda **kwargs: base_calls.append(kwargs) event_emitter.register('before-call', base_handler) # 3. The client will _not_ see this because it already has its # own copy of the event handlers. first_client.test_operation(Foo='one', Bar='two') self.assertEqual(len(base_calls), 0) def test_clients_have_meta_object(self): creator = self.create_client_creator() service_client = creator.create_client('myservice', 'us-west-2') self.assertTrue(hasattr(service_client, 'meta')) self.assertTrue(hasattr(service_client.meta, 'events')) # Sanity check the event emitter has an .emit() method. self.assertTrue(hasattr(service_client.meta.events, 'emit')) def test_client_register_seperate_unique_id_event(self): event_emitter = hooks.HierarchicalEmitter() creator = self.create_client_creator(event_emitter=event_emitter) client1 = creator.create_client('myservice', 'us-west-2') client2 = creator.create_client('myservice', 'us-west-2') def ping(**kwargs): return 'foo' client1.meta.events.register('some-event', ping, 'my-unique-id') client2.meta.events.register('some-event', ping, 'my-unique-id') # Ensure both clients can register a function with an unique id client1_responses = client1.meta.events.emit('some-event') self.assertEqual(len(client1_responses), 1) self.assertEqual(client1_responses[0][1], 'foo') client2_responses = client2.meta.events.emit('some-event') self.assertEqual(len(client2_responses), 1) self.assertEqual(client2_responses[0][1], 'foo') # Ensure when a client is unregistered the other client has # the unique-id event still registered. client1.meta.events.unregister('some-event', ping, 'my-unique-id') client1_responses = client1.meta.events.emit('some-event') self.assertEqual(len(client1_responses), 0) client2_responses = client2.meta.events.emit('some-event') self.assertEqual(len(client2_responses), 1) self.assertEqual(client2_responses[0][1], 'foo') # Ensure that the other client can unregister the event client2.meta.events.unregister('some-event', ping, 'my-unique-id') client2_responses = client2.meta.events.emit('some-event') self.assertEqual(len(client2_responses), 0) def test_client_created_emits_events(self): called = [] def on_client_create(class_attributes, **kwargs): called.append(class_attributes) event_emitter = hooks.HierarchicalEmitter() event_emitter.register('creating-client-class', on_client_create) creator = self.create_client_creator(event_emitter=event_emitter) creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) self.assertEqual(len(called), 1) self.assertIn('test_operation', called[0]) def test_client_method_called_event(self): event_emitter = hooks.HierarchicalEmitter() def inject_params(params, **kwargs): new_params = params.copy() new_params['Foo'] = 'zero' return new_params event_emitter.register( 'provide-client-params.myservice.TestOperation', inject_params) wrapped_emitter = mock.Mock(wraps=event_emitter) creator = self.create_client_creator(event_emitter=wrapped_emitter) service_client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) params = {'Foo': 'one', 'Bar': 'two'} service_client.test_operation(**params) # Ensure that the initial params were not modified in the handler self.assertEqual(params, {'Foo': 'one', 'Bar': 'two'}) # Ensure the handler passed on the correct param values. body = self.endpoint.make_request.call_args[0][1]['body'] self.assertEqual(body['Foo'], 'zero') def test_client_default_for_s3_addressing_style(self): creator = self.create_client_creator() client = creator.create_client('myservice', 'us-west-2') self.assertEqual(client.meta.config.s3, None) def test_client_s3_addressing_style_with_config(self): creator = self.create_client_creator() my_client = creator.create_client( 'myservice', 'us-west-2', client_config=botocore.config.Config(s3={'addressing_style': 'auto'}) ) self.assertEqual( my_client.meta.config.s3['addressing_style'], 'auto') def test_client_s3_addressing_style_with_bad_value(self): creator = self.create_client_creator() client = creator.create_client( 'myservice', 'us-west-2', scoped_config={'s3': ''}, ) self.assertIsNone(client.meta.config.s3) def test_client_s3_addressing_style_with_scoped_config(self): creator = self.create_client_creator() client = creator.create_client( 'myservice', 'us-west-2', scoped_config={'s3': {'addressing_style': 'virtual'}} ) self.assertEqual( client.meta.config.s3['addressing_style'], 'virtual') def test_client_s3_addressing_style_with_incorrect_style(self): with self.assertRaises(InvalidS3AddressingStyleError): botocore.config.Config(s3={'addressing_style': 'foo'}) def test_client_s3_addressing_style_config_overrides_scoped_config(self): creator = self.create_client_creator() my_client = creator.create_client( 'myservice', 'us-west-2', scoped_config={'s3': {'addressing_style': 'virtual'}}, client_config=botocore.config.Config(s3={'addressing_style': 'auto'}) ) self.assertEqual( my_client.meta.config.s3['addressing_style'], 'auto') def test_client_s3_addressing_style_default_registers_correctly(self): event_emitter = mock.Mock() creator = self.create_client_creator(event_emitter=event_emitter) client = creator.create_client('s3', 'us-west-2') self.assertIn( mock.call('before-sign.s3', utils.fix_s3_host), client.meta.events.register.call_args_list ) def test_client_s3_addressing_style_auto_registers_correctly(self): event_emitter = mock.Mock() creator = self.create_client_creator(event_emitter=event_emitter) client = creator.create_client( 's3', 'us-west-2', scoped_config={'s3': {'addressing_style': 'auto'}} ) self.assertIn( mock.call('before-sign.s3', utils.fix_s3_host), client.meta.events.register.call_args_list ) def test_client_s3_addressing_style_virtual_registers_correctly(self): event_emitter = mock.Mock() creator = self.create_client_creator(event_emitter=event_emitter) client = creator.create_client( 's3', 'us-west-2', scoped_config={'s3': {'addressing_style': 'virtual'}} ) self.assertNotIn( mock.call('before-sign.s3', utils.fix_s3_host), client.meta.events.unregister.call_args_list ) self.assertIn( mock.call('before-sign.s3', utils.switch_to_virtual_host_style), client.meta.events.register.call_args_list ) def test_client_s3_addressing_style_path_registers_correctly(self): event_emitter = mock.Mock() creator = self.create_client_creator(event_emitter=event_emitter) client = creator.create_client( 's3', 'us-west-2', scoped_config={'s3': {'addressing_style': 'path'}} ) self.assertNotIn( mock.call('before-sign.s3', utils.fix_s3_host), client.meta.events.register.call_args_list ) self.assertNotIn( mock.call('before-sign.s3', utils.switch_to_virtual_host_style), client.meta.events.register.call_args_list ) def test_custom_endpoint_uses_path_style(self): event_emitter = mock.Mock() creator = self.create_client_creator(event_emitter=event_emitter) # fix_s3_host should be registered if we don't provide a url client = creator.create_client('s3', 'us-west-2') self.assertIn( mock.call('before-sign.s3', utils.fix_s3_host), client.meta.events.register.call_args_list ) # If we do provide a url, fix_s3_host should not be registered event_emitter.reset_mock() client = creator.create_client( 's3', 'us-west-2', endpoint_url="foo.com" ) self.assertNotIn( mock.call('before-sign.s3', mock.ANY), client.meta.events.register.call_args_list ) def test_custom_accelerate_url_forces_virtual_host(self): event_emitter = mock.Mock() creator = self.create_client_creator(event_emitter=event_emitter) client = creator.create_client( 's3', 'us-west-2', endpoint_url='https://s3-accelerate.amazonaws.com' ) self.assertIn( mock.call('before-sign.s3', utils.switch_to_virtual_host_style), client.meta.events.register.call_args_list ) def test_client_payload_signing_from_scoped_config(self): creator = self.create_client_creator() my_client = creator.create_client( 'myservice', 'us-west-2', scoped_config={'s3': {'payload_signing_enabled': True}} ) self.assertEqual( my_client.meta.config.s3['payload_signing_enabled'], True) def test_client_payload_signing_from_varying_forms_of_true(self): creator = self.create_client_creator() my_client = creator.create_client( 'myservice', 'us-west-2', scoped_config={'s3': {'payload_signing_enabled': 'True'}} ) self.assertEqual( my_client.meta.config.s3['payload_signing_enabled'], True) creator = self.create_client_creator() my_client = creator.create_client( 'myservice', 'us-west-2', scoped_config={'s3': {'payload_signing_enabled': 'true'}} ) self.assertEqual( my_client.meta.config.s3['payload_signing_enabled'], True) def test_client_payload_signing_from_client_config(self): creator = self.create_client_creator() my_client = creator.create_client( 'myservice', 'us-west-2', client_config=client.Config(s3={'payload_signing_enabled': True}) ) self.assertEqual( my_client.meta.config.s3['payload_signing_enabled'], True) def test_client_payload_signing_client_config_overrides_scoped(self): creator = self.create_client_creator() my_client = creator.create_client( 'myservice', 'us-west-2', scoped_config={'s3': {'payload_signing_enabled': False}}, client_config=client.Config(s3={'payload_signing_enabled': True}) ) self.assertEqual( my_client.meta.config.s3['payload_signing_enabled'], True) def test_client_s3_accelerate_from_scoped_config(self): creator = self.create_client_creator() my_client = creator.create_client( 'myservice', 'us-west-2', scoped_config={'s3': {'use_accelerate_endpoint': True}} ) self.assertEqual( my_client.meta.config.s3['use_accelerate_endpoint'], True) def test_client_s3_accelerate_from_varying_forms_of_true(self): creator = self.create_client_creator() my_client = creator.create_client( 'myservice', 'us-west-2', scoped_config={'s3': {'use_accelerate_endpoint': 'True'}} ) self.assertEqual( my_client.meta.config.s3['use_accelerate_endpoint'], True) creator = self.create_client_creator() my_client = creator.create_client( 'myservice', 'us-west-2', scoped_config={'s3': {'use_accelerate_endpoint': 'true'}} ) self.assertEqual( my_client.meta.config.s3['use_accelerate_endpoint'], True) def test_client_s3_accelerate_from_client_config(self): creator = self.create_client_creator() my_client = creator.create_client( 'myservice', 'us-west-2', client_config=client.Config(s3={'use_accelerate_endpoint': True}) ) self.assertEqual( my_client.meta.config.s3['use_accelerate_endpoint'], True) def test_client_s3_accelerate_client_config_overrides_scoped(self): creator = self.create_client_creator() my_client = creator.create_client( 'myservice', 'us-west-2', scoped_config={'s3': {'use_accelerate_endpoint': False}}, client_config=client.Config(s3={'use_accelerate_endpoint': True}) ) self.assertEqual( my_client.meta.config.s3['use_accelerate_endpoint'], True) def test_before_call_short_circuits_request(self): def return_mock_tuple(**kwargs): http_mock = mock.Mock() http_mock.status_code = 200 return http_mock, mock.Mock() emitter = hooks.HierarchicalEmitter() emitter.register_last('before-call.*.*', return_mock_tuple) creator = self.create_client_creator(event_emitter=emitter) service_client = creator.create_client( 'myservice', 'us-west-2') service_client.test_operation(Foo='one') self.assertFalse(self.endpoint.make_request.called) class TestClientErrors(TestAutoGeneratedClient): def add_error_response(self, error_response): self.endpoint.make_request.return_value = ( mock.Mock(status_code=400), error_response) def test_client_makes_call_with_error(self): creator = self.create_client_creator() client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) with Stubber(client) as stub: stub.add_client_error( 'test_operation', 'TestOperationErrorCode', 'error occurred') with self.assertRaises(client.exceptions.TestOperationException): client.test_operation(Foo='one', Bar='two') def test_error_with_no_wire_code(self): creator = self.create_client_creator() client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) with Stubber(client) as stub: stub.add_client_error('test_operation', '404', 'Not Found') try: client.test_operation(Foo='one', Bar='two') except client.exceptions.ClientError as e: # This is needed becasue the error could be a subclass of # ClientError. # We explicitly want it to be a generic ClientError though self.assertEqual(e.__class__, exceptions.ClientError) def test_error_with_dot_separated_code(self): creator = self.create_client_creator() client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) with Stubber(client) as stub: stub.add_client_error( 'test_operation', 'InvalidAddress.NotFound', 'Not Found') try: client.test_operation(Foo='one', Bar='two') except client.exceptions.ClientError as e: # This is needed becasue the error could be a subclass of # ClientError. # We explicitly want it to be a generic ClientError though self.assertEqual(e.__class__, exceptions.ClientError) def test_error_with_empty_message(self): creator = self.create_client_creator() client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) with Stubber(client) as stub: stub.add_client_error( 'test_operation', 'TestOperationErrorCode') with self.assertRaises(client.exceptions.TestOperationException): client.test_operation(Foo='one', Bar='two') def test_error_with_empty_code(self): creator = self.create_client_creator() client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) with Stubber(client) as stub: stub.add_client_error('test_operation') try: client.test_operation(Foo='one', Bar='two') except client.exceptions.ClientError as e: # This is needed becasue the error could be a subclass of # ClientError. # We explicitly want it to be a generic ClientError though self.assertEqual(e.__class__, exceptions.ClientError) def test_error_with_missing_code(self): error_response = {'Error': {'Message': 'error occurred'}} # The stubber is not being used because it will always populate the # the message and code. self.endpoint.make_request.return_value = ( mock.Mock(status_code=400), error_response) creator = self.create_client_creator() client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) try: client.test_operation(Foo='one', Bar='two') except client.exceptions.ClientError as e: # This is needed becasue the error could be a subclass of # ClientError. # We explicitly want it to be a generic ClientError though self.assertEqual(e.__class__, exceptions.ClientError) def test_error_with_empty_contents(self): error_response = {'Error': {}} # The stubber is not being used because it will always populate the # the message and code. self.endpoint.make_request.return_value = ( mock.Mock(status_code=400), error_response) creator = self.create_client_creator() client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) try: client.test_operation(Foo='one', Bar='two') except client.exceptions.ClientError as e: # This is needed becasue the error could be a subclass of # ClientError. # We explicitly want it to be a generic ClientError though self.assertEqual(e.__class__, exceptions.ClientError) def test_exception_classes_across_clients_are_the_same(self): creator = self.create_client_creator( exceptions_factory=ClientExceptionsFactory()) client = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) client2 = creator.create_client( 'myservice', 'us-west-2', credentials=self.credentials) with Stubber(client) as stub: stub.add_client_error( 'test_operation', 'TestOperationErrorCode', 'error occurred') try: client.test_operation(Foo='one', Bar='two') except client2.exceptions.TestOperationException as e: # Caught exception should as well be an instance of the # other client's TestOperationException self.assertIsInstance( e, client.exceptions.TestOperationException) class TestConfig(unittest.TestCase): def test_can_use_args_to_construct(self): config = botocore.config.Config(*botocore.config.Config.OPTION_DEFAULTS.values()) for option, default_value in botocore.config.Config.OPTION_DEFAULTS.items(): self.assertTrue(hasattr(config, option)) self.assertEqual(getattr(config, option), default_value) def test_can_use_kwargs_to_construct(self): config = botocore.config.Config(**botocore.config.Config.OPTION_DEFAULTS) for option, default_value in botocore.config.Config.OPTION_DEFAULTS.items(): self.assertTrue(hasattr(config, option)) self.assertEqual(getattr(config, option), default_value) def test_can_use_mix_of_args_and_kwargs(self): config = botocore.config.Config('us-east-1', read_timeout=50) self.assertEqual(config.region_name, 'us-east-1') self.assertEqual(config.read_timeout, 50) def test_invalid_kwargs(self): with self.assertRaisesRegexp(TypeError, 'Got unexpected keyword'): botocore.config.Config(foo='foo') def test_pass_invalid_length_of_args(self): with self.assertRaisesRegexp(TypeError, 'Takes at most'): botocore.config.Config('foo', *botocore.config.Config.OPTION_DEFAULTS.values()) def test_create_with_multiple_kwargs(self): with self.assertRaisesRegexp(TypeError, 'Got multiple values'): botocore.config.Config('us-east-1', region_name='us-east-1') def test_merge_returns_new_config_object(self): config = botocore.config.Config() other_config = botocore.config.Config() new_config = config.merge(other_config) # Check the type is correct self.assertIsInstance(new_config, botocore.config.Config) # Make sure the new config is a brand new config object self.assertIsNot(new_config, config) self.assertIsNot(new_config, other_config) def test_general_merge_keeps_default_values(self): config = botocore.config.Config() other_config = botocore.config.Config() config_properties = vars(config) new_config = config.merge(other_config) # Ensure that the values all stayed the same in the new config self.assertEqual(config_properties, vars(new_config)) def test_merge_overrides_values(self): config = botocore.config.Config(region_name='us-east-1') other_config = botocore.config.Config(region_name='us-west-2') new_config = config.merge(other_config) self.assertEqual(new_config.region_name, 'us-west-2') def test_merge_overrides_values_even_when_using_default(self): config = botocore.config.Config(region_name='us-east-1') other_config = botocore.config.Config(region_name=None) new_config = config.merge(other_config) self.assertEqual(new_config.region_name, None) def test_merge_overrides_values_even_when_using_default_timeout(self): config = botocore.config.Config(read_timeout=30) other_config = botocore.config.Config(read_timeout=DEFAULT_TIMEOUT) new_config = config.merge(other_config) self.assertEqual(new_config.read_timeout, DEFAULT_TIMEOUT) def test_merge_overrides_only_when_user_provided_values(self): config = botocore.config.Config( region_name='us-east-1', signature_version='s3v4') other_config = botocore.config.Config(region_name='us-west-2') new_config = config.merge(other_config) self.assertEqual(new_config.region_name, 'us-west-2') self.assertEqual(new_config.signature_version, 's3v4') class TestClientEndpointBridge(unittest.TestCase): def setUp(self): self.resolver = mock.Mock() self.boilerplate_response = { 'endpointName': 'us-east-1', 'hostname': 's3.amazonaws.com', 'partition': 'aws', 'protocols': ['http', 'https'], 'dnsSuffix': 'amazonaws.com', 'signatureVersions': ['s3', 's3v4'] } self.resolver.construct_endpoint.return_value = \ self.boilerplate_response def test_guesses_endpoint_as_last_resort(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = None bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve('myservice', region_name='guess') self.assertEqual('guess', resolved['region_name']) self.assertEqual('guess', resolved['signing_region']) self.assertEqual('myservice', resolved['signing_name']) self.assertEqual('myservice', resolved['service_name']) self.assertEqual('v4', resolved['signature_version']) self.assertEqual('https://myservice.guess.amazonaws.com', resolved['endpoint_url']) def test_uses_us_east_1_by_default_for_s3(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 's3.amazonaws.com', 'endpointName': 'us-east-1', 'signatureVersions': ['s3', 's3v4'], 'protocols': ['https']} bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve('s3') self.assertEqual('us-east-1', resolved['region_name']) self.assertEqual('us-east-1', resolved['signing_region']) self.assertEqual('https://s3.amazonaws.com', resolved['endpoint_url']) def test_uses_region_from_client_config_if_available(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = None client_config = mock.Mock() client_config.region_name = 'us-foo-bar' bridge = ClientEndpointBridge(resolver, client_config=client_config) resolved = bridge.resolve('test') self.assertEqual('us-foo-bar', resolved['region_name']) self.assertEqual('us-foo-bar', resolved['signing_region']) self.assertEqual('https://test.us-foo-bar.amazonaws.com', resolved['endpoint_url']) def test_can_guess_endpoint_and_use_given_endpoint_url(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = None bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve( 'test', 'guess', endpoint_url='http://test.com') self.assertEqual('guess', resolved['region_name']) self.assertEqual('guess', resolved['signing_region']) self.assertEqual('http://test.com', resolved['endpoint_url']) def test_can_use_endpoint_url_with_resolved_endpoint(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'do-not-use-this', 'endpointName': 'us-west-2', 'signatureVersions': ['v2']} bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve( 'ec2', 'us-west-2', endpoint_url='https://foo') self.assertEqual('us-west-2', resolved['region_name']) self.assertEqual('us-west-2', resolved['signing_region']) self.assertEqual('https://foo', resolved['endpoint_url']) self.assertEqual('v2', resolved['signature_version']) def test_uses_ssl_common_name_over_hostname_if_present(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'do-not-use-this', 'signatureVersions': ['v4'], 'sslCommonName': 'common-name.com', 'endpointName': 'us-west-2', 'protocols': ['https']} bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve('myservice', 'us-west-2') self.assertEqual('us-west-2', resolved['region_name']) self.assertEqual('us-west-2', resolved['signing_region']) self.assertEqual('https://common-name.com', resolved['endpoint_url']) def test_can_create_http_urls(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'host.com', 'signatureVersions': ['v4'], 'endpointName': 'us-foo-baz'} bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve('myservice', 'us-foo-baz', is_secure=False) self.assertEqual('http://host.com', resolved['endpoint_url']) def test_can_create_http_urls(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'host.com', 'signatureVersions': ['v4'], 'endpointName': 'us-foo-baz'} bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve('myservice', 'us-foo-baz', is_secure=False) self.assertEqual('http://host.com', resolved['endpoint_url']) def test_credential_scope_overrides_signing_region(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'host.com', 'endpointName': 'us-foo-baz', 'signatureVersions': ['v4'], 'credentialScope': {'region': 'override'} } bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve('myservice', 'us-foo-baz') self.assertEqual('us-foo-baz', resolved['region_name']) self.assertEqual('override', resolved['signing_region']) def test_cred_scope_does_not_override_signing_region_if_endpoint_url(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'will-not-use.com', 'endpointName': 'us-foo-baz', 'signatureVersions': ['v4'], 'credentialScope': {'region': 'override'} } bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve('myservice', 'us-foo-baz', endpoint_url='https://override.com') self.assertEqual('us-foo-baz', resolved['region_name']) self.assertEqual('us-foo-baz', resolved['signing_region']) self.assertEqual('https://override.com', resolved['endpoint_url']) def test_resolved_region_overrides_region_when_no_endpoint_url(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'host.com', 'signatureVersions': ['v4'], 'endpointName': 'override', 'protocols': ['https'], } bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve('myservice', 'will-not-be-there') self.assertEqual('override', resolved['region_name']) self.assertEqual('override', resolved['signing_region']) self.assertEqual('https://host.com', resolved['endpoint_url']) def test_does_not_use_https_if_not_available(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'host.com', 'signatureVersions': ['v4'], 'endpointName': 'foo', # Note: http, not https 'protocols': ['http'], } bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve('myservice') # We should resolve to http://, not https:// self.assertEqual('http://host.com', resolved['endpoint_url']) def test_uses_signature_version_from_client_config(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'test.com', 'endpointName': 'us-west-2', 'signatureVersions': ['v2']} client_config = mock.Mock() client_config.signature_version = 's3' bridge = ClientEndpointBridge(resolver, client_config=client_config) resolved = bridge.resolve('test', 'us-west-2') self.assertEqual('s3', resolved['signature_version']) def test_uses_signature_version_from_client_config_when_guessing(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = None client_config = mock.Mock() client_config.signature_version = 's3v4' bridge = ClientEndpointBridge(resolver, client_config=client_config) resolved = bridge.resolve('test', 'us-west-2') self.assertEqual('s3v4', resolved['signature_version']) def test_uses_signature_version_from_scoped_config(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'test.com', 'endpointName': 'us-west-2', 'signatureVersions': ['v2']} scoped_config = mock.Mock() scoped_config.get.return_value = {'signature_version': 's3'} bridge = ClientEndpointBridge(resolver, scoped_config) resolved = bridge.resolve('test', 'us-west-2') self.assertEqual('s3', resolved['signature_version']) def test_uses_s3_over_s3v4_for_s3(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'test.com', 'endpointName': 'us-west-2', 'signatureVersions': ['s3v4', 's3']} bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve('s3', 'us-west-2') self.assertEqual('s3', resolved['signature_version']) def test_uses_s3v4_over_others_for_s3(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'test.com', 'endpointName': 'us-west-2', 'signatureVersions': ['s3v4', 'v4']} bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve('s3', 'us-west-2') self.assertEqual('s3v4', resolved['signature_version']) def test_uses_v4_over_other_signers(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'test', 'signatureVersions': ['v2', 'v4'], 'endpointName': 'us-west-2'} bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve('test', 'us-west-2') self.assertEqual('v4', resolved['signature_version']) def test_uses_known_signers_from_list_of_signature_versions(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'test', 'signatureVersions': ['foo', 'baz', 'v3https'], 'endpointName': 'us-west-2'} bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve('test', 'us-west-2') self.assertEqual('v3https', resolved['signature_version']) def test_raises_when_signature_version_is_unknown(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'test', 'endpointName': 'us-west-2', 'signatureVersions': ['foo']} bridge = ClientEndpointBridge(resolver) with self.assertRaises(UnknownSignatureVersionError): bridge.resolve('test', 'us-west-2') def test_raises_when_signature_version_is_not_found(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'test', 'endpointName': 'us-west-2'} bridge = ClientEndpointBridge(resolver) with self.assertRaises(UnknownSignatureVersionError): bridge.resolve('test', 'us-west-2') def test_uses_service_name_as_signing_name(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'test', 'signatureVersions': ['v4'], 'endpointName': 'us-west-2'} bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve('test', 'us-west-2') self.assertEqual('test', resolved['signing_name']) def test_uses_credential_scope_signing_name(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'test', 'endpointName': 'us-west-2', 'signatureVersions': ['v4'], 'credentialScope': {'service': 'override'} } bridge = ClientEndpointBridge(resolver) resolved = bridge.resolve('test', 'us-west-2') self.assertEqual('override', resolved['signing_name']) def test_uses_service_signing_name_when_present_and_no_cred_scope(self): resolver = mock.Mock() resolver.construct_endpoint.return_value = { 'partition': 'aws', 'hostname': 'test', 'signatureVersions': ['v4'], 'endpointName': 'us-west-2'} bridge = ClientEndpointBridge(resolver, service_signing_name='foo') resolved = bridge.resolve('test', 'us-west-2') self.assertEqual('foo', resolved['signing_name']) def test_can_construct_dualstack_endpoint_when_enabled(self): scoped_config = {'s3': {'use_dualstack_endpoint': True}} bridge = ClientEndpointBridge(self.resolver, scoped_config) resolved = bridge.resolve('s3', 'us-east-1') self.assertEqual( resolved['endpoint_url'], 'https://s3.dualstack.us-east-1.amazonaws.com') def test_can_use_client_config(self): config = botocore.config.Config(s3={'use_dualstack_endpoint': True}) bridge = ClientEndpointBridge(self.resolver, client_config=config) resolved = bridge.resolve('s3', 'us-east-1') self.assertEqual( resolved['endpoint_url'], 'https://s3.dualstack.us-east-1.amazonaws.com') def test_client_config_beats_scoped_config(self): scoped_config = {'s3': {'use_dualstack_endpoint': False}} config = botocore.config.Config(s3={'use_dualstack_endpoint': True}) bridge = ClientEndpointBridge(self.resolver, scoped_config, client_config=config) resolved = bridge.resolve('s3', 'us-east-1') self.assertEqual( resolved['endpoint_url'], 'https://s3.dualstack.us-east-1.amazonaws.com') def test_disable_dualstack_explicitly(self): scoped_config = {'s3': {'use_dualstack_endpoint': True}} config = botocore.config.Config(s3={'use_dualstack_endpoint': False}) bridge = ClientEndpointBridge(self.resolver, scoped_config, client_config=config) resolved = bridge.resolve('s3', 'us-east-1') self.assertEqual( resolved['endpoint_url'], 'https://s3.amazonaws.com') def test_honors_dns_suffix(self): scoped_config = {'s3': {'use_dualstack_endpoint': True}} self.boilerplate_response['dnsSuffix'] = 'amazonaws.com.cn' self.boilerplate_response['endpointName'] = 'cn-north-1' bridge = ClientEndpointBridge(self.resolver, scoped_config) resolved = bridge.resolve('s3', 'cn-north-1') self.assertEqual( resolved['endpoint_url'], 'https://s3.dualstack.cn-north-1.amazonaws.com.cn' ) botocore-1.5.7/tests/unit/test_endpoint.py0000666454262600001440000003755313042511306021774 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest from mock import Mock, patch, sentinel from nose.tools import assert_equals from botocore.vendored.requests import ConnectionError from botocore.compat import six from botocore.awsrequest import AWSRequest from botocore.endpoint import Endpoint, DEFAULT_TIMEOUT from botocore.endpoint import EndpointCreator from botocore.endpoint import BotocoreHTTPSession from botocore.exceptions import EndpointConnectionError from botocore.exceptions import ConnectionClosedError from botocore.exceptions import BaseEndpointResolverError def request_dict(): return { 'headers': {}, 'body': '', 'url_path': '/', 'query_string': '', 'method': 'POST', 'url': 'https://example.com', 'context': {} } class RecordStreamResets(six.StringIO): def __init__(self, value): six.StringIO.__init__(self, value) self.total_resets = 0 def seek(self, where): self.total_resets += 1 six.StringIO.seek(self, where) class TestEndpointBase(unittest.TestCase): def setUp(self): self.op = Mock() self.op.has_streaming_output = False self.op.metadata = {'protocol': 'json'} self.event_emitter = Mock() self.event_emitter.emit.return_value = [] self.factory_patch = patch( 'botocore.parsers.ResponseParserFactory') self.factory = self.factory_patch.start() self.endpoint = Endpoint( 'https://ec2.us-west-2.amazonaws.com/', endpoint_prefix='ec2', event_emitter=self.event_emitter) self.http_session = Mock() self.http_session.send.return_value = Mock( status_code=200, headers={}, content=b'{"Foo": "bar"}', ) self.endpoint.http_session = self.http_session def tearDown(self): self.factory_patch.stop() class TestEndpointFeatures(TestEndpointBase): def test_timeout_can_be_specified(self): timeout_override = 120 self.endpoint.timeout = timeout_override self.endpoint.make_request(self.op, request_dict()) kwargs = self.http_session.send.call_args[1] self.assertEqual(kwargs['timeout'], timeout_override) def test_make_request_with_proxies(self): proxies = {'http': 'http://localhost:8888'} self.endpoint.proxies = proxies self.endpoint.make_request(self.op, request_dict()) prepared_request = self.http_session.send.call_args[0][0] self.http_session.send.assert_called_with( prepared_request, verify=True, stream=False, proxies=proxies, timeout=DEFAULT_TIMEOUT) def test_make_request_with_no_auth(self): self.endpoint.auth = None self.endpoint.make_request(self.op, request_dict()) # http_session should be used to send the request. self.assertTrue(self.http_session.send.called) prepared_request = self.http_session.send.call_args[0][0] self.assertNotIn('Authorization', prepared_request.headers) def test_make_request_no_signature_version(self): self.endpoint.make_request(self.op, request_dict()) # http_session should be used to send the request. self.assertTrue(self.http_session.send.called) prepared_request = self.http_session.send.call_args[0][0] self.assertNotIn('Authorization', prepared_request.headers) def test_make_request_injects_better_dns_error_msg(self): fake_request = Mock(url='https://ec2.us-west-2.amazonaws.com') self.http_session.send.side_effect = ConnectionError( "Fake gaierror(8, node or host not known)", request=fake_request) with self.assertRaisesRegexp(EndpointConnectionError, 'Could not connect'): self.endpoint.make_request(self.op, request_dict()) def test_make_request_injects_better_bad_status_line_error_msg(self): fake_request = Mock(url='https://ec2.us-west-2.amazonaws.com') self.http_session.send.side_effect = ConnectionError( """'Connection aborted.', BadStatusLine("''",)""", request=fake_request) with self.assertRaisesRegexp(ConnectionClosedError, 'Connection was closed'): self.endpoint.make_request(self.op, request_dict()) def test_make_request_with_context(self): r = request_dict() r['context'] = {'signing': {'region': 'us-west-2'}} with patch('botocore.endpoint.Endpoint.prepare_request') as prepare: self.endpoint.make_request(self.op, r) request = prepare.call_args[0][0] self.assertEqual(request.context['signing']['region'], 'us-west-2') def test_can_specify_max_pool_connections(self): endpoint = Endpoint('https://ec2.us-west-2.amazonaws.com', 'ec2', self.event_emitter, max_pool_connections=50) # We can look in endpoint.http_session.adapters[0]._pool_maxsize, # but that feels like testing too much implementation detail. self.assertEqual(endpoint.max_pool_connections, 50) class TestRetryInterface(TestEndpointBase): def setUp(self): super(TestRetryInterface, self).setUp() self.retried_on_exception = None def test_retry_events_are_emitted(self): op = Mock() op.name = 'DescribeInstances' op.metadata = {'protocol': 'query'} op.has_streaming_output = False self.endpoint.make_request(op, request_dict()) call_args = self.event_emitter.emit.call_args self.assertEqual(call_args[0][0], 'needs-retry.ec2.DescribeInstances') def test_retry_events_can_alter_behavior(self): op = Mock() op.name = 'DescribeInstances' op.metadata = {'protocol': 'json'} self.event_emitter.emit.side_effect = [ [(None, None)], # Request created. [(None, 0)], # Check if retry needed. Retry needed. [(None, None)], # Request created. [(None, None)] # Check if retry needed. Retry not needed. ] self.endpoint.make_request(op, request_dict()) call_args = self.event_emitter.emit.call_args_list self.assertEqual(self.event_emitter.emit.call_count, 4) # Check that all of the events are as expected. self.assertEqual(call_args[0][0][0], 'request-created.ec2.DescribeInstances') self.assertEqual(call_args[1][0][0], 'needs-retry.ec2.DescribeInstances') self.assertEqual(call_args[2][0][0], 'request-created.ec2.DescribeInstances') self.assertEqual(call_args[3][0][0], 'needs-retry.ec2.DescribeInstances') def test_retry_on_socket_errors(self): op = Mock() op.name = 'DescribeInstances' self.event_emitter.emit.side_effect = [ [(None, None)], # Request created. [(None, 0)], # Check if retry needed. Retry needed. [(None, None)], # Request created [(None, None)] # Check if retry needed. Retry not needed. ] self.http_session.send.side_effect = ConnectionError() with self.assertRaises(ConnectionError): self.endpoint.make_request(op, request_dict()) call_args = self.event_emitter.emit.call_args_list self.assertEqual(self.event_emitter.emit.call_count, 4) # Check that all of the events are as expected. self.assertEqual(call_args[0][0][0], 'request-created.ec2.DescribeInstances') self.assertEqual(call_args[1][0][0], 'needs-retry.ec2.DescribeInstances') self.assertEqual(call_args[2][0][0], 'request-created.ec2.DescribeInstances') self.assertEqual(call_args[3][0][0], 'needs-retry.ec2.DescribeInstances') def test_retry_attempts_added_to_response_metadata(self): op = Mock(name='DescribeInstances') op.metadata = {'protocol': 'query'} self.event_emitter.emit.side_effect = [ [(None, None)], # Request created. [(None, 0)], # Check if retry needed. Retry needed. [(None, None)], # Request created. [(None, None)] # Check if retry needed. Retry not needed. ] parser = Mock() parser.parse.return_value = {'ResponseMetadata': {}} self.factory.return_value.create_parser.return_value = parser response = self.endpoint.make_request(op, request_dict()) self.assertEqual(response[1]['ResponseMetadata']['RetryAttempts'], 1) def test_retry_attempts_is_zero_when_not_retried(self): op = Mock(name='DescribeInstances', metadata={'protocol': 'query'}) self.event_emitter.emit.side_effect = [ [(None, None)], # Request created. [(None, None)], # Check if retry needed. Retry needed. ] parser = Mock() parser.parse.return_value = {'ResponseMetadata': {}} self.factory.return_value.create_parser.return_value = parser response = self.endpoint.make_request(op, request_dict()) self.assertEqual(response[1]['ResponseMetadata']['RetryAttempts'], 0) class TestS3ResetStreamOnRetry(TestEndpointBase): def setUp(self): super(TestS3ResetStreamOnRetry, self).setUp() def max_attempts_retry_handler(self, attempts, **kwargs): # Simulate a max requests of 3. self.total_calls += 1 if attempts == 3: return None else: # Returning anything non-None will trigger a retry, # but 0 here is so that time.sleep(0) happens. return 0 def test_reset_stream_on_retry(self): op = Mock() body = RecordStreamResets('foobar') op.name = 'PutObject' op.has_streaming_output = True op.metadata = {'protocol': 'rest-xml'} request = request_dict() request['body'] = body self.event_emitter.emit.side_effect = [ [(None, None)], # Request created. [(None, 0)], # Check if retry needed. Needs Retry. [(None, None)], # Request created. [(None, 0)], # Check if retry needed again. Needs Retry. [(None, None)], # Request created. [(None, None)], # Finally emit no rety is needed. ] self.endpoint.make_request(op, request) self.assertEqual(body.total_resets, 2) class TestEndpointCreator(unittest.TestCase): def setUp(self): self.service_model = Mock( endpoint_prefix='ec2', signature_version='v2', signing_name='ec2') self.environ = {} self.environ_patch = patch('os.environ', self.environ) self.environ_patch.start() self.creator = EndpointCreator(Mock()) def tearDown(self): self.environ_patch.stop() def test_creates_endpoint_with_configured_url(self): endpoint = self.creator.create_endpoint( self.service_model, region_name='us-east-1', endpoint_url='https://endpoint.url') self.assertEqual(endpoint.host, 'https://endpoint.url') def test_create_endpoint_with_default_timeout(self): endpoint = self.creator.create_endpoint( self.service_model, region_name='us-west-2', endpoint_url='https://example.com') self.assertEqual(endpoint.timeout, DEFAULT_TIMEOUT) def test_create_endpoint_with_customized_timeout(self): endpoint = self.creator.create_endpoint( self.service_model, region_name='us-west-2', endpoint_url='https://example.com', timeout=123) self.assertEqual(endpoint.timeout, 123) def test_get_endpoint_default_verify_ssl(self): endpoint = self.creator.create_endpoint( self.service_model, region_name='us-west-2', endpoint_url='https://example.com') self.assertTrue(endpoint.verify) def test_verify_ssl_can_be_disabled(self): endpoint = self.creator.create_endpoint( self.service_model, region_name='us-west-2', endpoint_url='https://example.com', verify=False) self.assertFalse(endpoint.verify) def test_verify_ssl_can_specify_cert_bundle(self): endpoint = self.creator.create_endpoint( self.service_model, region_name='us-west-2', endpoint_url='https://example.com', verify='/path/cacerts.pem') self.assertEqual(endpoint.verify, '/path/cacerts.pem') def test_honor_cert_bundle_env_var(self): self.environ['REQUESTS_CA_BUNDLE'] = '/env/cacerts.pem' endpoint = self.creator.create_endpoint( self.service_model, region_name='us-west-2', endpoint_url='https://example.com') self.assertEqual(endpoint.verify, '/env/cacerts.pem') def test_env_ignored_if_explicitly_passed(self): self.environ['REQUESTS_CA_BUNDLE'] = '/env/cacerts.pem' endpoint = self.creator.create_endpoint( self.service_model, region_name='us-west-2', endpoint_url='https://example.com', verify='/path/cacerts.pem') # /path/cacerts.pem wins over the value from the env var. self.assertEqual(endpoint.verify, '/path/cacerts.pem') def test_can_specify_max_pool_conns(self): endpoint = self.creator.create_endpoint( self.service_model, region_name='us-west-2', endpoint_url='https://example.com', max_pool_connections=100 ) self.assertEqual(endpoint.max_pool_connections, 100) class TestAWSSession(unittest.TestCase): def test_auth_header_preserved_from_s3_redirects(self): request = AWSRequest() request.url = 'https://bucket.s3.amazonaws.com/' request.method = 'GET' request.headers['Authorization'] = 'original auth header' prepared_request = request.prepare() fake_response = Mock() fake_response.headers = { 'location': 'https://bucket.s3-us-west-2.amazonaws.com'} fake_response.url = request.url fake_response.status_code = 307 fake_response.is_permanent_redirect = False # This line is needed to disable the cookie handling # code in requests. fake_response.raw._original_response = None success_response = Mock() success_response.raw._original_response = None success_response.is_redirect = False success_response.status_code = 200 session = BotocoreHTTPSession() session.send = Mock(return_value=success_response) list(session.resolve_redirects( fake_response, prepared_request, stream=False)) redirected_request = session.send.call_args[0][0] # The Authorization header for the newly sent request should # still have our original Authorization header. self.assertEqual( redirected_request.headers['Authorization'], 'original auth header') def test_max_pool_conns_injects_custom_adapter(self): http_adapter_cls = Mock(return_value=sentinel.HTTP_ADAPTER) session = BotocoreHTTPSession(max_pool_connections=20, http_adapter_cls=http_adapter_cls) http_adapter_cls.assert_called_with(pool_maxsize=20) self.assertEqual(session.adapters['https://'], sentinel.HTTP_ADAPTER) self.assertEqual(session.adapters['http://'], sentinel.HTTP_ADAPTER) botocore-1.5.7/tests/unit/cfg/0000777454262600001440000000000013042511310017260 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/unit/cfg/foo_config0000666454262600001440000000023213042511306021315 0ustar pysdk-ciamazon00000000000000[default] aws_access_key_id = foo aws_secret_access_key = bar foo_region = us-west-1 [profile "foo"] aws_access_key_id = fie aws_secret_access_key = baz botocore-1.5.7/tests/unit/cfg/aws_bad_profile0000666454262600001440000000075613042511306022340 0ustar pysdk-ciamazon00000000000000[default] aws_access_key_id = default aws_secret_access_key = default # Bad format, must be 'profile "name"' for profiles. [profile "personal" "otherkey"] aws_access_key_id = default aws_secret_access_key = default # Spaces are allowed [profile "my profile"] aws_access_key_id = default aws_secret_access_key = default # Missing quote [profile "missing end quote] # Doesn't need to be in quotes [profile personal1] aws_access_key_id = access_personal1 aws_secret_access_key = key_personal1 botocore-1.5.7/tests/unit/cfg/aws_config_nested0000666454262600001440000000026513042511306022674 0ustar pysdk-ciamazon00000000000000[default] aws_access_key_id = foo aws_secret_access_key = bar s3 = signature_version = s3v4 addressing_style = path cloudwatch = signature_version = v4 region=us-west-2 botocore-1.5.7/tests/unit/cfg/boto_config0000666454262600001440000000010213042511306021471 0ustar pysdk-ciamazon00000000000000[Credentials] aws_access_key_id = foo aws_secret_access_key = bar botocore-1.5.7/tests/unit/cfg/boto_config_empty0000666454262600001440000000005413042511306022715 0ustar pysdk-ciamazon00000000000000[Credentials] # Missing secret/access keys. botocore-1.5.7/tests/unit/cfg/aws_config_bad0000666454262600001440000000017613042511306022141 0ustar pysdk-ciamazon00000000000000aws_access_key_id = foo aws_secret_access_key = bar [profile "personal"] aws_access_key_id = fie aws_secret_access_key = baz botocore-1.5.7/tests/unit/cfg/aws_config_nested_bad0000666454262600001440000000022313042511306023474 0ustar pysdk-ciamazon00000000000000[default] aws_access_key_id = foo aws_secret_access_key = bar s3 = bad_syntax @ s3v4 cloudwatch = signature_version = v4 region=us-west-2 botocore-1.5.7/tests/unit/cfg/aws_config_other0000666454262600001440000000026013042511306022526 0ustar pysdk-ciamazon00000000000000[default] aws_access_key_id = other_foo aws_secret_access_key = other_bar [profile "personal"] aws_access_key_id = fie aws_secret_access_key = baz aws_security_token = fiebaz botocore-1.5.7/tests/unit/cfg/aws_credentials0000666454262600001440000000004413042511306022355 0ustar pysdk-ciamazon00000000000000AWSAccessKeyId=foo AWSSecretKey=bar botocore-1.5.7/tests/unit/cfg/aws_config0000666454262600001440000000024413042511306021327 0ustar pysdk-ciamazon00000000000000[default] aws_access_key_id = foo aws_secret_access_key = bar [profile "personal"] aws_access_key_id = fie aws_secret_access_key = baz aws_security_token = fiebaz botocore-1.5.7/tests/unit/cfg/aws_third_config0000666454262600001440000000027713042511306022527 0ustar pysdk-ciamazon00000000000000[default] aws_access_key_id = third_foo aws_secret_access_key = third_bar [profile "third"] aws_access_key_id = third_fie aws_secret_access_key = third_baz aws_security_token = third_fiebaz botocore-1.5.7/tests/unit/cfg/aws_config_nocreds0000666454262600001440000000003513042511306023042 0ustar pysdk-ciamazon00000000000000[default] region = us-west-2 botocore-1.5.7/tests/integration/0000777454262600001440000000000013042511310020065 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/integration/test-credentials0000666454262600001440000000022213042511306023263 0ustar pysdk-ciamazon00000000000000[default] aws_access_key_id = default aws_secret_access_key = default-secret [test] aws_access_key_id = test aws_secret_access_key = test-secret botocore-1.5.7/tests/integration/test_smoke.py0000666454262600001440000003001213042511306022615 0ustar pysdk-ciamazon00000000000000"""Smoke tests to verify basic communication to all AWS services. If you want to control what services/regions are used you can also provide two separate env vars: * AWS_SMOKE_TEST_REGION - The region used to create clients. * AWS_SMOKE_TEST_SERVICES - A CSV list of service names to test. Otherwise, the ``REGION`` variable specifies the default region to use and all the services in SMOKE_TESTS/ERROR_TESTS will be tested. """ import os import mock from pprint import pformat import warnings from nose.tools import assert_equals, assert_true from botocore import xform_name import botocore.session from botocore.client import ClientError from botocore.vendored.requests import adapters from botocore.vendored.requests.exceptions import ConnectionError # Mapping of service -> api calls to try. # Each api call is a dict of OperationName->params. # Empty params means that the operation will be called with no params. This is # used as a quick verification that we can successfully make calls to services. SMOKE_TESTS = { 'acm': {'ListCertificates': {}}, 'apigateway': {'GetRestApis': {}}, 'application-autoscaling': { 'DescribeScalableTargets': { 'ServiceNamespace': 'ecs' }}, 'autoscaling': {'DescribeAccountLimits': {}, 'DescribeAdjustmentTypes': {}}, 'cloudformation': {'DescribeStacks': {}, 'ListStacks': {}}, 'cloudfront': {'ListDistributions': {}, 'ListStreamingDistributions': {}}, 'cloudhsm': {'ListAvailableZones': {}}, 'cloudsearch': {'DescribeDomains': {}, 'ListDomainNames': {}}, 'cloudtrail': {'DescribeTrails': {}}, 'cloudwatch': {'ListMetrics': {}}, 'codecommit': {'ListRepositories': {}}, 'codedeploy': {'ListApplications': {}}, 'codepipeline': {'ListActionTypes': {}}, 'cognito-identity': {'ListIdentityPools': {'MaxResults': 1}}, 'cognito-sync': {'ListIdentityPoolUsage': {}}, 'config': {'DescribeDeliveryChannels': {}}, 'datapipeline': {'ListPipelines': {}}, 'devicefarm': {'ListProjects': {}}, 'directconnect': {'DescribeConnections': {}}, 'ds': {'DescribeDirectories': {}}, 'dynamodb': {'ListTables': {}}, 'dynamodbstreams': {'ListStreams': {}}, 'ec2': {'DescribeRegions': {}, 'DescribeInstances': {}}, 'ecr': {'DescribeRepositories': {}}, 'ecs': {'DescribeClusters': {}}, 'elasticache': {'DescribeCacheClusters': {}}, 'elasticbeanstalk': {'DescribeApplications': {}}, 'elastictranscoder': {'ListPipelines': {}}, 'elb': {'DescribeLoadBalancers': {}}, 'emr': {'ListClusters': {}}, 'es': {'ListDomainNames': {}}, 'events': {'ListRules': {}}, 'firehose': {'ListDeliveryStreams': {}}, 'gamelift': {'ListBuilds': {}}, 'glacier': {'ListVaults': {}}, 'iam': {'ListUsers': {}}, # Does not work with session credentials so # importexport tests are not run. #'importexport': {'ListJobs': {}}, 'importexport': {}, 'inspector': {'DescribeCrossAccountAccessRole': {}}, 'iot': {'DescribeEndpoint': {}}, 'kinesis': {'ListStreams': {}}, 'kms': {'ListKeys': {}}, 'lambda': {'ListFunctions': {}}, 'logs': {'DescribeLogGroups': {}}, 'machinelearning': {'DescribeMLModels': {}}, 'opsworks': {'DescribeStacks': {}}, 'rds': {'DescribeDBInstances': {}}, 'redshift': {'DescribeClusters': {}}, 'route53': {'ListHostedZones': {}}, 'route53domains': {'ListDomains': {}}, 's3': {'ListBuckets': {}}, 'sdb': {'ListDomains': {}}, 'ses': {'ListIdentities': {}}, 'sns': {'ListTopics': {}}, 'sqs': {'ListQueues': {}}, 'ssm': {'ListDocuments': {}}, 'storagegateway': {'ListGateways': {}}, # sts tests would normally go here, but # there aren't any calls you can make when # using session credentials so we don't run any # sts tests. 'sts': {}, #'sts': {'GetSessionToken': {}}, # Subscription needed for support API calls. 'support': {}, 'swf': {'ListDomains': {'registrationStatus': 'REGISTERED'}}, 'waf': {'ListWebACLs': {'Limit': 1}}, 'workspaces': {'DescribeWorkspaces': {}}, } # Same thing as the SMOKE_TESTS hash above, except these verify # that we get an error response back from the server because # we've sent invalid params. ERROR_TESTS = { 'apigateway': {'GetRestApi': {'restApiId': 'fake-id'}}, 'application-autoscaling': { 'DescribeScalableTargets': { 'ServiceNamespace': 'fake-service-namespace' }}, 'autoscaling': {'CreateLaunchConfiguration': { 'LaunchConfigurationName': 'foo', 'ImageId': 'ami-12345678', 'InstanceType': 'm1.small', }}, 'cloudformation': {'CreateStack': { 'StackName': 'fake', 'TemplateURL': 'http://s3.amazonaws.com/foo/bar', }}, 'cloudfront': {'GetDistribution': {'Id': 'fake-id'}}, 'cloudhsm': {'DescribeHapg': {'HapgArn': 'bogus-arn'}}, 'cloudsearch': {'DescribeIndexFields': {'DomainName': 'fakedomain'}}, 'cloudtrail': {'DeleteTrail': {'Name': 'fake-trail'}}, 'cloudwatch': {'SetAlarmState': { 'AlarmName': 'abc', 'StateValue': 'mno', 'StateReason': 'xyz', }}, 'logs': {'GetLogEvents': {'logGroupName': 'a', 'logStreamName': 'b'}}, 'codecommit': {'ListBranches': {'repositoryName': 'fake-repo'}}, 'codedeploy': {'GetDeployment': {'deploymentId': 'fake-id'}}, 'codepipeline': {'GetPipeline': {'name': 'fake-pipeline'}}, 'cognito-identity': {'DescribeIdentityPool': {'IdentityPoolId': 'fake'}}, 'cognito-sync': {'DescribeIdentityPoolUsage': {'IdentityPoolId': 'fake'}}, 'config': { 'GetResourceConfigHistory': {'resourceType': '', 'resourceId': ''}, }, 'datapipeline': {'GetPipelineDefinition': {'pipelineId': 'fake'}}, 'devicefarm': {'GetDevice': {'arn': 'arn:aws:devicefarm:REGION::device:f'}}, 'directconnect': {'DescribeConnections': {'connectionId': 'fake'}}, 'ds': {'CreateDirectory': {'Name': 'n', 'Password': 'p', 'Size': '1'}}, 'dynamodb': {'DescribeTable': {'TableName': 'fake'}}, 'dynamodbstreams': {'DescribeStream': {'StreamArn': 'x'*37}}, 'ec2': {'DescribeInstances': {'InstanceIds': ['i-12345678']}}, 'ecs': {'StopTask': {'task': 'fake'}}, 'efs': {'DeleteFileSystem': {'FileSystemId': 'fake'}}, 'elasticache': {'DescribeCacheClusters': {'CacheClusterId': 'fake'}}, 'elasticbeanstalk': { 'DescribeEnvironmentResources': {'EnvironmentId': 'x'}, }, 'elb': {'DescribeLoadBalancers': {'LoadBalancerNames': ['fake']}}, 'elastictranscoder': {'ReadJob': {'Id': 'fake'}}, 'emr': {'DescribeCluster': {'ClusterId': 'fake'}}, 'es': {'DescribeElasticsearchDomain': {'DomainName': 'not-a-domain'}}, 'gamelift': {'DescribeBuild': {'BuildId': 'fake-build-id'}}, 'glacier': {'ListVaults': {'accountId': 'fake'}}, 'iam': {'GetUser': {'UserName': 'fake'}}, 'importexport': {'CreateJob': { 'JobType': 'Import', 'ValidateOnly': False, 'Manifest': 'fake', }}, 'kinesis': {'DescribeStream': {'StreamName': 'fake'}}, 'kms': {'GetKeyPolicy': {'KeyId': 'fake', 'PolicyName': 'fake'}}, 'lambda': {'Invoke': {'FunctionName': 'fake'}}, 'machinelearning': {'GetBatchPrediction': {'BatchPredictionId': 'fake'}}, 'opsworks': {'DescribeLayers': {'StackId': 'fake'}}, 'rds': {'DescribeDBInstances': {'DBInstanceIdentifier': 'fake'}}, 'redshift': {'DescribeClusters': {'ClusterIdentifier': 'fake'}}, 'route53': {'GetHostedZone': {'Id': 'fake'}}, 'route53domains': {'GetDomainDetail': {'DomainName': 'fake'}}, 's3': {'ListObjects': {'Bucket': 'thisbucketdoesnotexistasdf'}}, 'ses': {'VerifyEmailIdentity': {'EmailAddress': 'fake'}}, 'sdb': {'CreateDomain': {'DomainName': ''}}, 'sns': { 'ConfirmSubscription': {'TopicArn': 'a', 'Token': 'b'}, 'Publish': {'Message': 'hello', 'TopicArn': 'fake'}, }, 'sqs': {'GetQueueUrl': {'QueueName': 'fake'}}, 'ssm': {'GetDocument': {'Name': 'fake'}}, 'storagegateway': {'ListVolumes': {'GatewayARN': 'x'*50}}, 'sts': {'GetFederationToken': {'Name': 'fake', 'Policy': 'fake'}}, 'support': {'CreateCase': { 'subject': 'x', 'communicationBody': 'x', 'categoryCode': 'x', 'serviceCode': 'x', 'severityCode': 'low', }}, 'swf': {'DescribeDomain': {'name': 'fake'}}, 'waf': {'GetWebACL': {'WebACLId': 'fake'}}, 'workspaces': {'DescribeWorkspaces': {'DirectoryId': 'fake'}}, } REGION = 'us-east-1' REGION_OVERRIDES = { 'devicefarm': 'us-west-2', 'efs': 'us-west-2', 'inspector': 'us-west-2', } def _get_client(session, service): if os.environ.get('AWS_SMOKE_TEST_REGION', ''): region_name = os.environ['AWS_SMOKE_TEST_REGION'] else: region_name = REGION_OVERRIDES.get(service, REGION) return session.create_client(service, region_name=region_name) def _list_services(dict_entries): # List all services in the provided dict_entry. # If the AWS_SMOKE_TEST_SERVICES is provided, # it's a comma separated list of services you can provide # if you only want to run the smoke tests for certain services. if 'AWS_SMOKE_TEST_SERVICES' not in os.environ: return dict_entries.keys() else: wanted_services = os.environ.get( 'AWS_SMOKE_TEST_SERVICES', '').split(',') return [key for key in dict_entries if key in wanted_services] def test_can_make_request_with_client(): # Same as test_can_make_request, but with Client objects # instead of service/operations. session = botocore.session.get_session() for service_name in _list_services(SMOKE_TESTS): client = _get_client(session, service_name) for operation_name in SMOKE_TESTS[service_name]: kwargs = SMOKE_TESTS[service_name][operation_name] method_name = xform_name(operation_name) yield _make_client_call, client, method_name, kwargs def _make_client_call(client, operation_name, kwargs): method = getattr(client, operation_name) with warnings.catch_warnings(record=True) as caught_warnings: response = method(**kwargs) assert_equals(len(caught_warnings), 0, "Warnings were emitted during smoke test: %s" % caught_warnings) assert_true('Errors' not in response) def test_can_make_request_and_understand_errors_with_client(): session = botocore.session.get_session() for service_name in _list_services(ERROR_TESTS): client = _get_client(session, service_name) for operation_name in ERROR_TESTS[service_name]: kwargs = ERROR_TESTS[service_name][operation_name] method_name = xform_name(operation_name) yield _make_error_client_call, client, method_name, kwargs def _make_error_client_call(client, operation_name, kwargs): method = getattr(client, operation_name) try: response = method(**kwargs) except ClientError as e: pass else: raise AssertionError("Expected client error was not raised " "for %s.%s" % (client, operation_name)) def test_client_can_retry_request_properly(): session = botocore.session.get_session() for service_name in _list_services(SMOKE_TESTS): client = _get_client(session, service_name) for operation_name in SMOKE_TESTS[service_name]: kwargs = SMOKE_TESTS[service_name][operation_name] yield (_make_client_call_with_errors, client, operation_name, kwargs) def _make_client_call_with_errors(client, operation_name, kwargs): operation = getattr(client, xform_name(operation_name)) original_send = adapters.HTTPAdapter.send def mock_http_adapter_send(self, *args, **kwargs): if not getattr(self, '_integ_test_error_raised', False): self._integ_test_error_raised = True raise ConnectionError("Simulated ConnectionError raised.") else: return original_send(self, *args, **kwargs) with mock.patch('botocore.vendored.requests.adapters.HTTPAdapter.send', mock_http_adapter_send): try: response = operation(**kwargs) except ClientError as e: assert False, ('Request was not retried properly, ' 'received error:\n%s' % pformat(e)) botocore-1.5.7/tests/integration/test_credentials.py0000666454262600001440000001131513042511306024001 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import os import mock import botocore.exceptions from botocore.session import Session from tests import BaseEnvVar, temporary_file class TestCredentialPrecedence(BaseEnvVar): def setUp(self): super(TestCredentialPrecedence, self).setUp() # Set the config file to something that doesn't exist so # that we don't accidentally load a config. os.environ['AWS_CONFIG_FILE'] = '~/.aws/config-missing' def create_session(self, *args, **kwargs): """ Create a new session with the given arguments. Additionally, this method will set the credentials file to the test credentials used by the following test cases. """ kwargs['session_vars'] = { 'credentials_file': ( None, None, os.path.join(os.path.dirname(__file__), 'test-credentials'), None) } return Session(*args, **kwargs) def test_access_secret_vs_profile_env(self): # If all three are given, then the access/secret keys should # take precedence. os.environ['AWS_ACCESS_KEY_ID'] = 'env' os.environ['AWS_SECRET_ACCESS_KEY'] = 'env-secret' os.environ['AWS_DEFAULT_PROFILE'] = 'test' s = self.create_session() credentials = s.get_credentials() self.assertEqual(credentials.access_key, 'env') self.assertEqual(credentials.secret_key, 'env-secret') @mock.patch('botocore.credentials.Credentials') def test_access_secret_vs_profile_code(self, credentials_cls): # If all three are given, then the access/secret keys should # take precedence. s = self.create_session(profile='test') client = s.create_client('s3', aws_access_key_id='code', aws_secret_access_key='code-secret') credentials_cls.assert_called_with( access_key='code', secret_key='code-secret', token=mock.ANY) def test_profile_env_vs_code(self): # If the profile is set both by the env var and by code, # then the one set by code should take precedence. os.environ['AWS_DEFAULT_PROFILE'] = 'test' s = self.create_session(profile='default') credentials = s.get_credentials() self.assertEqual(credentials.access_key, 'default') self.assertEqual(credentials.secret_key, 'default-secret') @mock.patch('botocore.credentials.Credentials') def test_access_secret_env_vs_code(self, credentials_cls): # If the access/secret keys are set both as env vars and via # code, then those set by code should take precedence. os.environ['AWS_ACCESS_KEY_ID'] = 'env' os.environ['AWS_SECRET_ACCESS_KEY'] = 'secret' s = self.create_session() client = s.create_client('s3', aws_access_key_id='code', aws_secret_access_key='code-secret') credentials_cls.assert_called_with( access_key='code', secret_key='code-secret', token=mock.ANY) def test_access_secret_env_vs_profile_code(self): # If access/secret keys are set in the environment, but then a # specific profile is passed via code, then the access/secret # keys defined in that profile should take precedence over # the environment variables. Example: # # ``aws --profile dev s3 ls`` # os.environ['AWS_ACCESS_KEY_ID'] = 'env' os.environ['AWS_SECRET_ACCESS_KEY'] = 'env-secret' s = self.create_session(profile='test') credentials = s.get_credentials() self.assertEqual(credentials.access_key, 'test') self.assertEqual(credentials.secret_key, 'test-secret') def test_honors_aws_shared_credentials_file_env_var(self): with temporary_file('w') as f: f.write('[default]\n' 'aws_access_key_id=custom1\n' 'aws_secret_access_key=custom2\n') f.flush() os.environ['AWS_SHARED_CREDENTIALS_FILE'] = f.name s = Session() credentials = s.get_credentials() self.assertEqual(credentials.access_key, 'custom1') self.assertEqual(credentials.secret_key, 'custom2') botocore-1.5.7/tests/integration/test_apigateway.py0000666454262600001440000000531213042511306023637 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import time from tests import unittest import botocore.session from botocore import exceptions class TestApigateway(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() self.client = self.session.create_client('apigateway', 'us-east-1') # Create a resource to use with this client. self.api_name = 'mytestapi' self.api_id = self.create_rest_api_or_skip() def create_rest_api_or_skip(self): try: api_id = self.client.create_rest_api(name=self.api_name)['id'] except exceptions.ClientError as e: if e.response['Error']['Code'] == 'TooManyRequestsException': raise unittest.SkipTest( "Hit API gateway throttle limit, skipping test.") raise return api_id def delete_api(self): retries = 0 while retries < 10: try: self.client.delete_rest_api(restApiId=self.api_id) break except exceptions.ClientError as e: if e.response['Error']['Code'] == 'TooManyRequestsException': retries += 1 time.sleep(5) else: raise def tearDown(self): self.delete_api() def test_put_integration(self): # The only resource on a brand new api is the path. So use that ID. path_resource_id = self.client.get_resources( restApiId=self.api_id)['items'][0]['id'] # Create a method for the resource. self.client.put_method( restApiId=self.api_id, resourceId=path_resource_id, httpMethod='GET', authorizationType='None' ) # Put an integration on the method. response = self.client.put_integration( restApiId=self.api_id, resourceId=path_resource_id, httpMethod='GET', type='HTTP', integrationHttpMethod='GET', uri='https://api.endpoint.com' ) # Assert the response was successful by checking the integration type self.assertEqual(response['type'], 'HTTP') botocore-1.5.7/tests/integration/test_glacier.py0000666454262600001440000000620213042511306023111 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest from botocore.exceptions import ClientError from botocore.vendored import six import botocore.session class TestGlacier(unittest.TestCase): # We have to use a single vault for all the integration tests. # This is because if we create a vault and upload then delete # an archive, we cannot immediately clean up and delete the vault. # The compromise is that we'll use a single vault and use # get_or_create semantics for the integ tests. This does mean you # need to be careful when writing tests. Assume that other code # is also using this vault in parallel, so don't rely on things like # number of archives in a vault. VAULT_NAME = 'botocore-integ-test-vault' def setUp(self): self.session = botocore.session.get_session() self.client = self.session.create_client('glacier', 'us-west-2') # There's no error if the vault already exists so we don't # need to catch any exceptions here. self.client.create_vault(vaultName=self.VAULT_NAME) def test_can_list_vaults_without_account_id(self): response = self.client.list_vaults() self.assertIn('VaultList', response) def test_can_handle_error_responses(self): with self.assertRaises(ClientError): self.client.list_vaults(accountId='asdf') def test_can_upload_archive(self): body = six.BytesIO(b"bytes content") response = self.client.upload_archive(vaultName=self.VAULT_NAME, archiveDescription='test upload', body=body) self.assertEqual(response['ResponseMetadata']['HTTPStatusCode'], 201) archive_id = response['archiveId'] response = self.client.delete_archive(vaultName=self.VAULT_NAME, archiveId=archive_id) self.assertEqual(response['ResponseMetadata']['HTTPStatusCode'], 204) def test_can_upload_archive_from_bytes(self): response = self.client.upload_archive(vaultName=self.VAULT_NAME, archiveDescription='test upload', body=b'bytes body') self.assertEqual(response['ResponseMetadata']['HTTPStatusCode'], 201) archive_id = response['archiveId'] response = self.client.delete_archive(vaultName=self.VAULT_NAME, archiveId=archive_id) self.assertEqual(response['ResponseMetadata']['HTTPStatusCode'], 204) if __name__ == '__main__': unittest.main() botocore-1.5.7/tests/integration/test_loaders.py0000666454262600001440000000501013042511306023130 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import os from tests import unittest import mock import botocore.session # Basic sanity checks for loader functionality. # We're not using BaseEnvVar here because we don't actually # want to patch out all of os.environ, we just want to ensure # AWS_DATA_PATH doesn't affect our test results. class TestLoaderBasicFunctionality(unittest.TestCase): def setUp(self): self.environ = os.environ.copy() self.patched = mock.patch('os.environ', self.environ) self.patched.start() self.environ.pop('AWS_DATA_PATH', None) self.session = botocore.session.get_session() self.loader = self.session.get_component('data_loader') def tearDown(self): self.patched.stop() def test_search_path_has_at_least_one_entry(self): self.assertTrue(len(self.loader.search_paths) > 0) def test_can_list_available_services(self): # We don't want an exact check, as this list changes over time. # We just need a basic sanity check. available_services = self.loader.list_available_services( type_name='service-2') self.assertIn('ec2', available_services) self.assertIn('s3', available_services) def test_can_determine_latest_version(self): api_versions = self.loader.list_api_versions( service_name='ec2', type_name='service-2') self.assertEqual( self.loader.determine_latest_version( service_name='ec2', type_name='service-2'), max(api_versions)) def test_can_load_service_model(self): waiters = self.loader.load_service_model( service_name='ec2', type_name='waiters-2') self.assertIn('waiters', waiters) def test_can_load_data(self): api_version = self.loader.determine_latest_version( service_name='ec2', type_name='service-2') data = self.loader.load_data( os.path.join('ec2', api_version, 'service-2')) self.assertIn('metadata', data) botocore-1.5.7/tests/integration/test_cloudformation.py0000666454262600001440000000235513042511306024535 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest, random_chars import botocore.session from botocore.exceptions import ClientError class TestCloudformation(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() self.client = self.session.create_client('cloudformation', 'us-east-1') def test_handles_errors_with_template_body(self): # GetTemplate has a customization in handlers.py, so we're ensuring # it handles the case when a stack does not exist. with self.assertRaises(ClientError): self.client.get_template( StackName='does-not-exist-%s' % random_chars(10)) if __name__ == '__main__': unittest.main() botocore-1.5.7/tests/integration/test_s3.py0000666454262600001440000013052213042511306022033 0ustar pysdk-ciamazon00000000000000# -*- coding: utf-8 -*- # Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest, temporary_file, random_chars import os import time from collections import defaultdict import tempfile import shutil import threading import logging import mock from tarfile import TarFile from contextlib import closing from nose.plugins.attrib import attr from botocore.vendored.requests import adapters from botocore.vendored.requests.exceptions import ConnectionError from botocore.compat import six, zip_longest import botocore.session import botocore.auth import botocore.credentials import botocore.vendored.requests as requests from botocore.config import Config from botocore.exceptions import ClientError def random_bucketname(): return 'botocoretest-' + random_chars(10) LOG = logging.getLogger('botocore.tests.integration') _SHARED_BUCKET = random_bucketname() _DEFAULT_REGION = 'us-west-2' def setup_module(): s3 = botocore.session.get_session().create_client('s3') waiter = s3.get_waiter('bucket_exists') params = { 'Bucket': _SHARED_BUCKET, 'CreateBucketConfiguration': { 'LocationConstraint': _DEFAULT_REGION, } } try: s3.create_bucket(**params) except Exception as e: # A create_bucket can fail for a number of reasons. # We're going to defer to the waiter below to make the # final call as to whether or not the bucket exists. LOG.debug("create_bucket() raised an exception: %s", e, exc_info=True) waiter.wait(Bucket=_SHARED_BUCKET) def clear_out_bucket(bucket, region, delete_bucket=False): s3 = botocore.session.get_session().create_client( 's3', region_name=region) page = s3.get_paginator('list_objects') # Use pages paired with batch delete_objects(). for page in page.paginate(Bucket=bucket): keys = [{'Key': obj['Key']} for obj in page.get('Contents', [])] if keys: s3.delete_objects(Bucket=bucket, Delete={'Objects': keys}) if delete_bucket: try: s3.delete_bucket(Bucket=bucket) except Exception as e: # We can sometimes get exceptions when trying to # delete a bucket. We'll let the waiter make # the final call as to whether the bucket was able # to be deleted. LOG.debug("delete_bucket() raised an exception: %s", e, exc_info=True) waiter = s3.get_waiter('bucket_not_exists') waiter.wait(Bucket=bucket) def teardown_module(): clear_out_bucket(_SHARED_BUCKET, _DEFAULT_REGION, delete_bucket=True) class BaseS3ClientTest(unittest.TestCase): def setUp(self): self.bucket_name = _SHARED_BUCKET self.region = _DEFAULT_REGION clear_out_bucket(self.bucket_name, self.region) self.session = botocore.session.get_session() self.client = self.session.create_client('s3', region_name=self.region) def assert_status_code(self, response, status_code): self.assertEqual( response['ResponseMetadata']['HTTPStatusCode'], status_code ) def create_bucket(self, region_name, bucket_name=None, client=None): bucket_client = client or self.client if bucket_name is None: bucket_name = random_bucketname() bucket_kwargs = {'Bucket': bucket_name} if region_name != 'us-east-1': bucket_kwargs['CreateBucketConfiguration'] = { 'LocationConstraint': region_name, } response = bucket_client.create_bucket(**bucket_kwargs) self.assert_status_code(response, 200) waiter = bucket_client.get_waiter('bucket_exists') waiter.wait(Bucket=bucket_name) self.addCleanup(clear_out_bucket, bucket_name, region_name, True) return bucket_name def make_tempdir(self): tempdir = tempfile.mkdtemp() self.addCleanup(shutil.rmtree, tempdir) return tempdir class TestS3BaseWithBucket(BaseS3ClientTest): def setUp(self): super(TestS3BaseWithBucket, self).setUp() self.caught_exceptions = [] def create_object(self, key_name, body='foo'): self.client.put_object( Bucket=self.bucket_name, Key=key_name, Body=body) def create_multipart_upload(self, key_name): parsed = self.client.create_multipart_upload( Bucket=self.bucket_name, Key=key_name) upload_id = parsed['UploadId'] self.addCleanup( self.client.abort_multipart_upload, UploadId=upload_id, Bucket=self.bucket_name, Key=key_name) def abort_multipart_upload(self, bucket_name, key, upload_id): self.client.abort_multipart_upload( UploadId=upload_id, Bucket=self.bucket_name, Key=key) def delete_object(self, key, bucket_name): response = self.client.delete_object(Bucket=bucket_name, Key=key) self.assert_status_code(response, 204) def delete_bucket(self, bucket_name): response = self.client.delete_bucket(Bucket=bucket_name) self.assert_status_code(response, 204) def create_object_catch_exceptions(self, key_name): try: self.create_object(key_name=key_name) except Exception as e: self.caught_exceptions.append(e) def assert_num_uploads_found(self, operation, num_uploads, max_items=None, num_attempts=5): amount_seen = None paginator = self.client.get_paginator(operation) for _ in range(num_attempts): pages = paginator.paginate(Bucket=self.bucket_name, PaginationConfig={ 'MaxItems': max_items}) iterators = pages.result_key_iters() self.assertEqual(len(iterators), 2) self.assertEqual(iterators[0].result_key.expression, 'Uploads') # It sometimes takes a while for all the uploads to show up, # especially if the upload was just created. If we don't # see the expected amount, we retry up to num_attempts time # before failing. amount_seen = len(list(iterators[0])) if amount_seen == num_uploads: # Test passed. return else: # Sleep and try again. time.sleep(2) self.fail("Expected to see %s uploads, instead saw: %s" % ( num_uploads, amount_seen)) def create_client(self): # Even though the default signature_version is s3, # we're being explicit in case this ever changes. client_config = Config(signature_version='s3') return self.session.create_client('s3', self.region, config=client_config) def assert_can_put_object(self, body): client = self.create_client() response = client.put_object( Bucket=self.bucket_name, Key='foo', Body=body) self.assert_status_code(response, 200) self.addCleanup( client.delete_object, Bucket=self.bucket_name, Key='foo') class TestS3Buckets(TestS3BaseWithBucket): def setUp(self): super(TestS3Buckets, self).setUp() def test_can_make_request(self): # Basic smoke test to ensure we can talk to s3. result = self.client.list_buckets() # Can't really assume anything about whether or not they have buckets, # but we can assume something about the structure of the response. self.assertEqual(sorted(list(result.keys())), ['Buckets', 'Owner', 'ResponseMetadata']) def test_can_get_bucket_location(self): result = self.client.get_bucket_location(Bucket=self.bucket_name) self.assertIn('LocationConstraint', result) self.assertEqual(result['LocationConstraint'], self.region) class TestS3Objects(TestS3BaseWithBucket): def increment_auth(self, request, **kwargs): self.auth_paths.append(request.auth_path) def test_can_delete_urlencoded_object(self): key_name = 'a+b/foo' self.create_object(key_name=key_name) bucket_contents = self.client.list_objects( Bucket=self.bucket_name)['Contents'] self.assertEqual(len(bucket_contents), 1) self.assertEqual(bucket_contents[0]['Key'], 'a+b/foo') subdir_contents = self.client.list_objects( Bucket=self.bucket_name, Prefix='a+b')['Contents'] self.assertEqual(len(subdir_contents), 1) self.assertEqual(subdir_contents[0]['Key'], 'a+b/foo') response = self.client.delete_object( Bucket=self.bucket_name, Key=key_name) self.assert_status_code(response, 204) @attr('slow') def test_can_paginate(self): for i in range(5): key_name = 'key%s' % i self.create_object(key_name) # Eventual consistency. time.sleep(3) paginator = self.client.get_paginator('list_objects') generator = paginator.paginate(MaxKeys=1, Bucket=self.bucket_name) responses = list(generator) self.assertEqual(len(responses), 5, responses) key_names = [el['Contents'][0]['Key'] for el in responses] self.assertEqual(key_names, ['key0', 'key1', 'key2', 'key3', 'key4']) @attr('slow') def test_can_paginate_with_page_size(self): for i in range(5): key_name = 'key%s' % i self.create_object(key_name) # Eventual consistency. time.sleep(3) paginator = self.client.get_paginator('list_objects') generator = paginator.paginate(PaginationConfig={'PageSize': 1}, Bucket=self.bucket_name) responses = list(generator) self.assertEqual(len(responses), 5, responses) data = [r for r in responses] key_names = [el['Contents'][0]['Key'] for el in data] self.assertEqual(key_names, ['key0', 'key1', 'key2', 'key3', 'key4']) @attr('slow') def test_result_key_iters(self): for i in range(5): key_name = 'key/%s/%s' % (i, i) self.create_object(key_name) key_name2 = 'key/%s' % i self.create_object(key_name2) time.sleep(3) paginator = self.client.get_paginator('list_objects') generator = paginator.paginate(MaxKeys=2, Prefix='key/', Delimiter='/', Bucket=self.bucket_name) iterators = generator.result_key_iters() response = defaultdict(list) key_names = [i.result_key for i in iterators] for vals in zip_longest(*iterators): for k, val in zip(key_names, vals): response.setdefault(k.expression, []) response[k.expression].append(val) self.assertIn('Contents', response) self.assertIn('CommonPrefixes', response) @attr('slow') def test_can_get_and_put_object(self): self.create_object('foobarbaz', body='body contents') time.sleep(3) data = self.client.get_object( Bucket=self.bucket_name, Key='foobarbaz') self.assertEqual(data['Body'].read().decode('utf-8'), 'body contents') def test_can_put_large_string_body_on_new_bucket(self): body = '*' * (5 * (1024 ** 2)) self.assert_can_put_object(body) def test_get_object_stream_wrapper(self): self.create_object('foobarbaz', body='body contents') response = self.client.get_object( Bucket=self.bucket_name, Key='foobarbaz') body = response['Body'] # Am able to set a socket timeout body.set_socket_timeout(10) self.assertEqual(body.read(amt=1).decode('utf-8'), 'b') self.assertEqual(body.read().decode('utf-8'), 'ody contents') def test_paginate_max_items(self): self.create_multipart_upload('foo/key1') self.create_multipart_upload('foo/key1') self.create_multipart_upload('foo/key1') self.create_multipart_upload('foo/key2') self.create_multipart_upload('foobar/key1') self.create_multipart_upload('foobar/key2') self.create_multipart_upload('bar/key1') self.create_multipart_upload('bar/key2') # Verify when we have MaxItems=None, we get back all 8 uploads. self.assert_num_uploads_found('list_multipart_uploads', max_items=None, num_uploads=8) # Verify when we have MaxItems=1, we get back 1 upload. self.assert_num_uploads_found('list_multipart_uploads', max_items=1, num_uploads=1) paginator = self.client.get_paginator('list_multipart_uploads') # Works similar with build_full_result() pages = paginator.paginate(PaginationConfig={'MaxItems': 1}, Bucket=self.bucket_name) full_result = pages.build_full_result() self.assertEqual(len(full_result['Uploads']), 1) def test_paginate_within_page_boundaries(self): self.create_object('a') self.create_object('b') self.create_object('c') self.create_object('d') paginator = self.client.get_paginator('list_objects') # First do it without a max keys so we're operating on a single page of # results. pages = paginator.paginate(PaginationConfig={'MaxItems': 1}, Bucket=self.bucket_name) first = pages.build_full_result() t1 = first['NextToken'] pages = paginator.paginate( PaginationConfig={'MaxItems': 1, 'StartingToken': t1}, Bucket=self.bucket_name) second = pages.build_full_result() t2 = second['NextToken'] pages = paginator.paginate( PaginationConfig={'MaxItems': 1, 'StartingToken': t2}, Bucket=self.bucket_name) third = pages.build_full_result() t3 = third['NextToken'] pages = paginator.paginate( PaginationConfig={'MaxItems': 1, 'StartingToken': t3}, Bucket=self.bucket_name) fourth = pages.build_full_result() self.assertEqual(first['Contents'][-1]['Key'], 'a') self.assertEqual(second['Contents'][-1]['Key'], 'b') self.assertEqual(third['Contents'][-1]['Key'], 'c') self.assertEqual(fourth['Contents'][-1]['Key'], 'd') def test_unicode_key_put_list(self): # Verify we can upload a key with a unicode char and list it as well. key_name = u'\u2713' self.create_object(key_name) parsed = self.client.list_objects(Bucket=self.bucket_name) self.assertEqual(len(parsed['Contents']), 1) self.assertEqual(parsed['Contents'][0]['Key'], key_name) parsed = self.client.get_object( Bucket=self.bucket_name, Key=key_name) self.assertEqual(parsed['Body'].read().decode('utf-8'), 'foo') def test_unicode_system_character(self): # Verify we can use a unicode system character which would normally # break the xml parser key_name = 'foo\x08' self.create_object(key_name) self.addCleanup(self.delete_object, key_name, self.bucket_name) parsed = self.client.list_objects(Bucket=self.bucket_name) self.assertEqual(len(parsed['Contents']), 1) self.assertEqual(parsed['Contents'][0]['Key'], key_name) parsed = self.client.list_objects(Bucket=self.bucket_name, EncodingType='url') self.assertEqual(len(parsed['Contents']), 1) self.assertEqual(parsed['Contents'][0]['Key'], 'foo%08') def test_thread_safe_auth(self): self.auth_paths = [] self.session.register('before-sign', self.increment_auth) # This test depends on auth_path, which is only added in virtual host # style requests. config = Config(s3={'addressing_style': 'virtual'}) self.client = self.session.create_client('s3', self.region, config=config) self.create_object(key_name='foo1') threads = [] for i in range(10): t = threading.Thread(target=self.create_object_catch_exceptions, args=('foo%s' % i,)) t.daemon = True threads.append(t) for thread in threads: thread.start() for thread in threads: thread.join() self.assertEqual( self.caught_exceptions, [], "Unexpectedly caught exceptions: %s" % self.caught_exceptions) self.assertEqual( len(set(self.auth_paths)), 10, "Expected 10 unique auth paths, instead received: %s" % (self.auth_paths)) def test_non_normalized_key_paths(self): # The create_object method has assertEqual checks for 200 status. self.create_object('key./././name') bucket_contents = self.client.list_objects( Bucket=self.bucket_name)['Contents'] self.assertEqual(len(bucket_contents), 1) self.assertEqual(bucket_contents[0]['Key'], 'key./././name') class TestS3Regions(BaseS3ClientTest): def setUp(self): super(TestS3Regions, self).setUp() self.region = 'us-west-2' self.client = self.session.create_client( 's3', region_name=self.region) def test_reset_stream_on_redirects(self): # Create a bucket in a non classic region. bucket_name = self.create_bucket(self.region) # Then try to put a file like object to this location. tempdir = self.make_tempdir() filename = os.path.join(tempdir, 'foo') with open(filename, 'wb') as f: f.write(b'foo' * 1024) with open(filename, 'rb') as f: self.client.put_object( Bucket=bucket_name, Key='foo', Body=f) data = self.client.get_object( Bucket=bucket_name, Key='foo') self.assertEqual(data['Body'].read(), b'foo' * 1024) class TestS3Copy(TestS3BaseWithBucket): def test_copy_with_quoted_char(self): key_name = 'a+b/foo' self.create_object(key_name=key_name) key_name2 = key_name + 'bar' self.client.copy_object( Bucket=self.bucket_name, Key=key_name2, CopySource='%s/%s' % (self.bucket_name, key_name)) # Now verify we can retrieve the copied object. data = self.client.get_object( Bucket=self.bucket_name, Key=key_name2) self.assertEqual(data['Body'].read().decode('utf-8'), 'foo') def test_copy_with_query_string(self): key_name = 'a+b/foo?notVersionid=bar' self.create_object(key_name=key_name) key_name2 = key_name + 'bar' self.client.copy_object( Bucket=self.bucket_name, Key=key_name2, CopySource='%s/%s' % (self.bucket_name, key_name)) # Now verify we can retrieve the copied object. data = self.client.get_object( Bucket=self.bucket_name, Key=key_name2) self.assertEqual(data['Body'].read().decode('utf-8'), 'foo') def test_can_copy_with_dict_form(self): key_name = 'a+b/foo?versionId=abcd' self.create_object(key_name=key_name) key_name2 = key_name + 'bar' self.client.copy_object( Bucket=self.bucket_name, Key=key_name2, CopySource={'Bucket': self.bucket_name, 'Key': key_name}) # Now verify we can retrieve the copied object. data = self.client.get_object( Bucket=self.bucket_name, Key=key_name2) self.assertEqual(data['Body'].read().decode('utf-8'), 'foo') def test_copy_with_s3_metadata(self): key_name = 'foo.txt' self.create_object(key_name=key_name) copied_key = 'copied.txt' parsed = self.client.copy_object( Bucket=self.bucket_name, Key=copied_key, CopySource='%s/%s' % (self.bucket_name, key_name), MetadataDirective='REPLACE', Metadata={"mykey": "myvalue", "mykey2": "myvalue2"}) self.assert_status_code(parsed, 200) class BaseS3PresignTest(BaseS3ClientTest): def setup_bucket(self): self.key = 'myobject' self.create_object(key_name=self.key) def create_object(self, key_name, body='foo'): self.client.put_object( Bucket=self.bucket_name, Key=key_name, Body=body) class TestS3PresignUsStandard(BaseS3PresignTest): def setUp(self): super(TestS3PresignUsStandard, self).setUp() self.region = 'us-east-1' self.bucket_name = self.create_bucket(self.region) self.client_config = Config( region_name=self.region, signature_version='s3') self.client = self.session.create_client( 's3', config=self.client_config) self.setup_bucket() def test_presign_sigv2(self): presigned_url = self.client.generate_presigned_url( 'get_object', Params={'Bucket': self.bucket_name, 'Key': self.key}) self.assertTrue( presigned_url.startswith( 'https://%s.s3.amazonaws.com/%s' % ( self.bucket_name, self.key)), "Host was suppose to use DNS style, instead " "got: %s" % presigned_url) # Try to retrieve the object using the presigned url. self.assertEqual(requests.get(presigned_url).content, b'foo') def test_presign_with_existing_query_string_values(self): content_disposition = 'attachment; filename=foo.txt;' presigned_url = self.client.generate_presigned_url( 'get_object', Params={ 'Bucket': self.bucket_name, 'Key': self.key, 'ResponseContentDisposition': content_disposition}) response = requests.get(presigned_url) self.assertEqual(response.headers['Content-Disposition'], content_disposition) self.assertEqual(response.content, b'foo') def test_presign_sigv4(self): self.client_config.signature_version = 's3v4' self.client = self.session.create_client( 's3', config=self.client_config) presigned_url = self.client.generate_presigned_url( 'get_object', Params={'Bucket': self.bucket_name, 'Key': self.key}) self.assertTrue( presigned_url.startswith( 'https://s3.amazonaws.com/%s/%s' % ( self.bucket_name, self.key)), "Host was suppose to be the us-east-1 endpoint, instead " "got: %s" % presigned_url) # Try to retrieve the object using the presigned url. self.assertEqual(requests.get(presigned_url).content, b'foo') def test_presign_post_sigv2(self): # Create some of the various supported conditions. conditions = [ {"acl": "public-read"}, ] # Create the fields that follow the policy. fields = { 'acl': 'public-read', } # Retrieve the args for the presigned post. post_args = self.client.generate_presigned_post( self.bucket_name, self.key, Fields=fields, Conditions=conditions) # Make sure that the form can be posted successfully. files = {'file': ('baz', 'some data')} # Make sure the correct endpoint is being used self.assertTrue( post_args['url'].startswith( 'https://%s.s3.amazonaws.com' % self.bucket_name), "Host was suppose to use DNS style, instead " "got: %s" % post_args['url']) # Try to retrieve the object using the presigned url. r = requests.post( post_args['url'], data=post_args['fields'], files=files) self.assertEqual(r.status_code, 204) def test_presign_post_sigv4(self): self.client_config.signature_version = 's3v4' self.client = self.session.create_client( 's3', config=self.client_config) # Create some of the various supported conditions. conditions = [ {"acl": 'public-read'}, ] # Create the fields that follow the policy. fields = { 'acl': 'public-read', } # Retrieve the args for the presigned post. post_args = self.client.generate_presigned_post( self.bucket_name, self.key, Fields=fields, Conditions=conditions) # Make sure that the form can be posted successfully. files = {'file': ('baz', 'some data')} # Make sure the correct endpoint is being used self.assertTrue( post_args['url'].startswith( 'https://s3.amazonaws.com/%s' % self.bucket_name), "Host was suppose to use us-east-1 endpoint, instead " "got: %s" % post_args['url']) r = requests.post( post_args['url'], data=post_args['fields'], files=files) self.assertEqual(r.status_code, 204) class TestS3PresignNonUsStandard(BaseS3PresignTest): def setUp(self): super(TestS3PresignNonUsStandard, self).setUp() self.client_config = Config( region_name=self.region, signature_version='s3') self.client = self.session.create_client( 's3', config=self.client_config) self.setup_bucket() def test_presign_sigv2(self): presigned_url = self.client.generate_presigned_url( 'get_object', Params={'Bucket': self.bucket_name, 'Key': self.key}) self.assertTrue( presigned_url.startswith( 'https://%s.s3.amazonaws.com/%s' % ( self.bucket_name, self.key)), "Host was suppose to use DNS style, instead " "got: %s" % presigned_url) # Try to retrieve the object using the presigned url. self.assertEqual(requests.get(presigned_url).content, b'foo') def test_presign_sigv4(self): self.client_config.signature_version = 's3v4' self.client = self.session.create_client( 's3', config=self.client_config) presigned_url = self.client.generate_presigned_url( 'get_object', Params={'Bucket': self.bucket_name, 'Key': self.key}) self.assertTrue( presigned_url.startswith( 'https://s3-us-west-2.amazonaws.com/%s/%s' % ( self.bucket_name, self.key)), "Host was suppose to be the us-west-2 endpoint, instead " "got: %s" % presigned_url) # Try to retrieve the object using the presigned url. self.assertEqual(requests.get(presigned_url).content, b'foo') def test_presign_post_sigv2(self): # Create some of the various supported conditions. conditions = [ {"acl": "public-read"}, ] # Create the fields that follow the policy. fields = { 'acl': 'public-read', } # Retrieve the args for the presigned post. post_args = self.client.generate_presigned_post( self.bucket_name, self.key, Fields=fields, Conditions=conditions) # Make sure that the form can be posted successfully. files = {'file': ('baz', 'some data')} # Make sure the correct endpoint is being used self.assertTrue( post_args['url'].startswith( 'https://%s.s3.amazonaws.com' % self.bucket_name), "Host was suppose to use DNS style, instead " "got: %s" % post_args['url']) r = requests.post( post_args['url'], data=post_args['fields'], files=files) self.assertEqual(r.status_code, 204) def test_presign_post_sigv4(self): self.client_config.signature_version = 's3v4' self.client = self.session.create_client( 's3', config=self.client_config) # Create some of the various supported conditions. conditions = [ {"acl": "public-read"}, ] # Create the fields that follow the policy. fields = { 'acl': 'public-read', } # Retrieve the args for the presigned post. post_args = self.client.generate_presigned_post( self.bucket_name, self.key, Fields=fields, Conditions=conditions) # Make sure that the form can be posted successfully. files = {'file': ('baz', 'some data')} # Make sure the correct endpoint is being used self.assertTrue( post_args['url'].startswith( 'https://s3-us-west-2.amazonaws.com/%s' % self.bucket_name), "Host was suppose to use DNS style, instead " "got: %s" % post_args['url']) r = requests.post( post_args['url'], data=post_args['fields'], files=files) self.assertEqual(r.status_code, 204) class TestCreateBucketInOtherRegion(TestS3BaseWithBucket): def test_bucket_in_other_region(self): # This verifies expect 100-continue behavior. We previously # had a bug where we did not support this behavior and trying to # create a bucket and immediately PutObject with a file like object # would actually cause errors. client = self.session.create_client('s3', 'us-east-1') with temporary_file('w') as f: f.write('foobarbaz' * 1024 * 1024) f.flush() with open(f.name, 'rb') as body_file: response = client.put_object( Bucket=self.bucket_name, Key='foo.txt', Body=body_file) self.assert_status_code(response, 200) def test_bucket_in_other_region_using_http(self): client = self.session.create_client( 's3', 'us-east-1', endpoint_url='http://s3.amazonaws.com/') with temporary_file('w') as f: f.write('foobarbaz' * 1024 * 1024) f.flush() with open(f.name, 'rb') as body_file: response = client.put_object( Bucket=self.bucket_name, Key='foo.txt', Body=body_file) self.assert_status_code(response, 200) class TestS3SigV4Client(BaseS3ClientTest): def setUp(self): super(TestS3SigV4Client, self).setUp() self.client = self.session.create_client( 's3', self.region, config=Config(signature_version='s3v4')) def test_can_get_bucket_location(self): # Even though the bucket is in us-west-2, we should still be able to # use the us-east-1 endpoint class to get the bucket location. client = self.session.create_client('s3', 'us-east-1') # Also keep in mind that while this test is useful, it doesn't test # what happens once DNS propogates which is arguably more interesting, # as DNS will point us to the eu-central-1 endpoint. response = client.get_bucket_location(Bucket=self.bucket_name) self.assertEqual(response['LocationConstraint'], 'us-west-2') def test_request_retried_for_sigv4(self): body = six.BytesIO(b"Hello world!") original_send = adapters.HTTPAdapter.send state = mock.Mock() state.error_raised = False def mock_http_adapter_send(self, *args, **kwargs): if not state.error_raised: state.error_raised = True raise ConnectionError("Simulated ConnectionError raised.") else: return original_send(self, *args, **kwargs) with mock.patch('botocore.vendored.requests.adapters.HTTPAdapter.send', mock_http_adapter_send): response = self.client.put_object(Bucket=self.bucket_name, Key='foo.txt', Body=body) self.assert_status_code(response, 200) @attr('slow') def test_paginate_list_objects_unicode(self): key_names = [ u'non-ascii-key-\xe4\xf6\xfc-01.txt', u'non-ascii-key-\xe4\xf6\xfc-02.txt', u'non-ascii-key-\xe4\xf6\xfc-03.txt', u'non-ascii-key-\xe4\xf6\xfc-04.txt', ] for key in key_names: response = self.client.put_object(Bucket=self.bucket_name, Key=key, Body='') self.assert_status_code(response, 200) list_objs_paginator = self.client.get_paginator('list_objects') key_refs = [] for response in list_objs_paginator.paginate(Bucket=self.bucket_name, PaginationConfig={ 'PageSize': 2}): for content in response['Contents']: key_refs.append(content['Key']) self.assertEqual(key_names, key_refs) @attr('slow') def test_paginate_list_objects_safe_chars(self): key_names = [ u'-._~safe-chars-key-01.txt', u'-._~safe-chars-key-02.txt', u'-._~safe-chars-key-03.txt', u'-._~safe-chars-key-04.txt', ] for key in key_names: response = self.client.put_object(Bucket=self.bucket_name, Key=key, Body='') self.assert_status_code(response, 200) list_objs_paginator = self.client.get_paginator('list_objects') key_refs = [] for response in list_objs_paginator.paginate(Bucket=self.bucket_name, PaginationConfig={ 'PageSize': 2}): for content in response['Contents']: key_refs.append(content['Key']) self.assertEqual(key_names, key_refs) def test_create_multipart_upload(self): key = 'mymultipartupload' response = self.client.create_multipart_upload( Bucket=self.bucket_name, Key=key ) self.assert_status_code(response, 200) upload_id = response['UploadId'] self.addCleanup( self.client.abort_multipart_upload, Bucket=self.bucket_name, Key=key, UploadId=upload_id ) response = self.client.list_multipart_uploads( Bucket=self.bucket_name, Prefix=key ) # Make sure there is only one multipart upload. self.assertEqual(len(response['Uploads']), 1) # Make sure the upload id is as expected. self.assertEqual(response['Uploads'][0]['UploadId'], upload_id) class TestSSEKeyParamValidation(BaseS3ClientTest): def test_make_request_with_sse(self): key_bytes = os.urandom(32) # Obviously a bad key here, but we just want to ensure we can use # a str/unicode type as a key. key_str = 'abcd' * 8 # Put two objects with an sse key, one with random bytes, # one with str/unicode. Then verify we can GetObject() both # objects. self.client.put_object( Bucket=self.bucket_name, Key='foo.txt', Body=six.BytesIO(b'mycontents'), SSECustomerAlgorithm='AES256', SSECustomerKey=key_bytes) self.addCleanup(self.client.delete_object, Bucket=self.bucket_name, Key='foo.txt') self.client.put_object( Bucket=self.bucket_name, Key='foo2.txt', Body=six.BytesIO(b'mycontents2'), SSECustomerAlgorithm='AES256', SSECustomerKey=key_str) self.addCleanup(self.client.delete_object, Bucket=self.bucket_name, Key='foo2.txt') self.assertEqual( self.client.get_object(Bucket=self.bucket_name, Key='foo.txt', SSECustomerAlgorithm='AES256', SSECustomerKey=key_bytes)['Body'].read(), b'mycontents') self.assertEqual( self.client.get_object(Bucket=self.bucket_name, Key='foo2.txt', SSECustomerAlgorithm='AES256', SSECustomerKey=key_str)['Body'].read(), b'mycontents2') def test_make_request_with_sse_copy_source(self): encrypt_key = 'a' * 32 other_encrypt_key = 'b' * 32 # Upload the object using one encrypt key self.client.put_object( Bucket=self.bucket_name, Key='foo.txt', Body=six.BytesIO(b'mycontents'), SSECustomerAlgorithm='AES256', SSECustomerKey=encrypt_key) self.addCleanup(self.client.delete_object, Bucket=self.bucket_name, Key='foo.txt') # Copy the object using the original encryption key as the copy source # and encrypt with a new encryption key. self.client.copy_object( Bucket=self.bucket_name, CopySource=self.bucket_name+'/foo.txt', Key='bar.txt', CopySourceSSECustomerAlgorithm='AES256', CopySourceSSECustomerKey=encrypt_key, SSECustomerAlgorithm='AES256', SSECustomerKey=other_encrypt_key ) self.addCleanup(self.client.delete_object, Bucket=self.bucket_name, Key='bar.txt') # Download the object using the new encryption key. # The content should not have changed. self.assertEqual( self.client.get_object( Bucket=self.bucket_name, Key='bar.txt', SSECustomerAlgorithm='AES256', SSECustomerKey=other_encrypt_key)['Body'].read(), b'mycontents') class TestS3UTF8Headers(BaseS3ClientTest): def test_can_set_utf_8_headers(self): bucket_name = _SHARED_BUCKET body = six.BytesIO(b"Hello world!") response = self.client.put_object( Bucket=bucket_name, Key="foo.txt", Body=body, ContentDisposition="attachment; filename=5小時接力起跑.jpg;") self.assert_status_code(response, 200) self.addCleanup(self.client.delete_object, Bucket=bucket_name, Key="foo.txt") class TestSupportedPutObjectBodyTypes(TestS3BaseWithBucket): def test_can_put_unicode_content(self): self.assert_can_put_object(body=u'\u2713') def test_can_put_non_ascii_bytes(self): self.assert_can_put_object(body=u'\u2713'.encode('utf-8')) def test_can_put_arbitrary_binary_data(self): body = os.urandom(5 * (1024 ** 2)) self.assert_can_put_object(body) def test_can_put_binary_file(self): tempdir = self.make_tempdir() filename = os.path.join(tempdir, 'foo') with open(filename, 'wb') as f: f.write(u'\u2713'.encode('utf-8')) with open(filename, 'rb') as binary_file: self.assert_can_put_object(body=binary_file) def test_can_put_extracted_file_from_tar(self): tempdir = self.make_tempdir() tarname = os.path.join(tempdir, 'mytar.tar') filename = os.path.join(tempdir, 'foo') # Set up a file to add the tarfile. with open(filename, 'w') as f: f.write('bar') # Setup the tar file by adding the file to it. # Note there is no context handler for TarFile in python 2.6 try: tar = TarFile(tarname, 'w') tar.add(filename, 'foo') finally: tar.close() # See if an extracted file can be uploaded to s3. try: tar = TarFile(tarname, 'r') with closing(tar.extractfile('foo')) as f: self.assert_can_put_object(body=f) finally: tar.close() class TestSupportedPutObjectBodyTypesSigv4(TestSupportedPutObjectBodyTypes): def create_client(self): client_config = Config(signature_version='s3v4') return self.session.create_client('s3', self.region, config=client_config) class TestAutoS3Addressing(BaseS3ClientTest): def setUp(self): super(TestAutoS3Addressing, self).setUp() self.addressing_style = 'auto' self.client = self.create_client() def create_client(self, signature_version='s3'): return self.session.create_client( 's3', region_name=self.region, config=Config(s3={ 'addressing_style': self.addressing_style, 'signature_version': signature_version })) def test_can_list_buckets(self): response = self.client.list_buckets() self.assertIn('Buckets', response) def test_can_make_bucket_and_put_object(self): response = self.client.put_object( Bucket=self.bucket_name, Key='foo', Body='contents') self.assertEqual( response['ResponseMetadata']['HTTPStatusCode'], 200) def test_can_make_bucket_and_put_object_with_sigv4(self): self.region = 'eu-central-1' self.client = self.create_client() bucket_name = self.create_bucket(self.region) response = self.client.put_object( Bucket=bucket_name, Key='foo', Body='contents') self.assertEqual( response['ResponseMetadata']['HTTPStatusCode'], 200) class TestS3VirtualAddressing(TestAutoS3Addressing): def setUp(self): super(TestS3VirtualAddressing, self).setUp() self.addressing_style = 'virtual' self.client = self.create_client() class TestS3PathAddressing(TestAutoS3Addressing): def setUp(self): super(TestS3PathAddressing, self).setUp() self.addressing_style = 'path' self.client = self.create_client() class TestRegionRedirect(BaseS3ClientTest): def setUp(self): super(TestRegionRedirect, self).setUp() self.bucket_region = self.region self.client_region = 'eu-central-1' self.client = self.session.create_client( 's3', region_name=self.client_region, config=Config(signature_version='s3v4')) self.bucket_client = self.session.create_client( 's3', region_name=self.bucket_region, config=Config(signature_version='s3v4') ) def test_region_redirects(self): try: response = self.client.list_objects(Bucket=self.bucket_name) self.assertEqual( response['ResponseMetadata']['HTTPStatusCode'], 200) except ClientError as e: error = e.response['Error'].get('Code', None) if error == 'PermanentRedirect': self.fail("S3 client failed to redirect to the proper region.") def test_region_redirect_sigv2_to_sigv4_raises_error(self): self.bucket_region = 'eu-central-1' sigv2_client = self.session.create_client( 's3', region_name=self.client_region, config=Config(signature_version='s3')) eu_bucket = self.create_bucket(self.bucket_region) msg = 'The authorization mechanism you have provided is not supported.' with self.assertRaisesRegexp(ClientError, msg): sigv2_client.list_objects(Bucket=eu_bucket) def test_region_redirects_multiple_requests(self): try: response = self.client.list_objects(Bucket=self.bucket_name) self.assertEqual( response['ResponseMetadata']['HTTPStatusCode'], 200) second_response = self.client.list_objects(Bucket=self.bucket_name) self.assertEqual( second_response['ResponseMetadata']['HTTPStatusCode'], 200) except ClientError as e: error = e.response['Error'].get('Code', None) if error == 'PermanentRedirect': self.fail("S3 client failed to redirect to the proper region.") def test_redirects_head_bucket(self): response = self.client.head_bucket(Bucket=self.bucket_name) headers = response['ResponseMetadata']['HTTPHeaders'] region = headers.get('x-amz-bucket-region') self.assertEqual(region, self.bucket_region) def test_redirects_head_object(self): key = 'foo' self.bucket_client.put_object( Bucket=self.bucket_name, Key=key, Body='bar') try: response = self.client.head_object( Bucket=self.bucket_name, Key=key) self.assertEqual(response.get('ContentLength'), len(key)) except ClientError as e: self.fail("S3 Client failed to redirect Head Object: %s" % e) botocore-1.5.7/tests/integration/test_ec2.py0000666454262600001440000001341613042511306022161 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest import itertools from nose.plugins.attrib import attr import botocore.session from botocore.exceptions import ClientError class TestEC2(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() self.client = self.session.create_client( 'ec2', region_name='us-west-2') def test_can_make_request(self): # Basic smoke test to ensure we can talk to ec2. result = self.client.describe_availability_zones() zones = list( sorted(a['ZoneName'] for a in result['AvailabilityZones'])) self.assertEqual(zones, ['us-west-2a', 'us-west-2b', 'us-west-2c']) def test_get_console_output_handles_error(self): # Want to ensure the underlying ClientError is propogated # on error. with self.assertRaises(ClientError): self.client.get_console_output(InstanceId='i-12345') class TestEC2Pagination(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() self.client = self.session.create_client( 'ec2', region_name='us-west-2') def test_can_paginate(self): # Using an operation that we know will paginate. paginator = self.client.get_paginator( 'describe_reserved_instances_offerings') pages = paginator.paginate() results = list(itertools.islice(pages, 0, 3)) self.assertEqual(len(results), 3) self.assertTrue(results[0]['NextToken'] != results[1]['NextToken']) def test_can_paginate_with_page_size(self): # Using an operation that we know will paginate. paginator = self.client.get_paginator( 'describe_reserved_instances_offerings') pages = paginator.paginate(PaginationConfig={'PageSize': 1}) results = list(itertools.islice(pages, 0, 3)) self.assertEqual(len(results), 3) for parsed in results: reserved_inst_offer = parsed['ReservedInstancesOfferings'] # There should only be one reserved instance offering on each # page. self.assertEqual(len(reserved_inst_offer), 1) def test_can_fall_back_to_old_starting_token(self): # Using an operation that we know will paginate. paginator = self.client.get_paginator( 'describe_reserved_instances_offerings') pages = paginator.paginate(PaginationConfig={'NextToken': 'None___1'}) try: results = list(itertools.islice(pages, 0, 3)) self.assertEqual(len(results), 3) self.assertTrue(results[0]['NextToken'] != results[1]['NextToken']) except ValueError: self.fail("Old style paginator failed.") @attr('slow') class TestCopySnapshotCustomization(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() # However, all the test fixture setup/cleanup can use # the client interface. self.client = self.session.create_client('ec2', 'us-west-2') self.client_us_east_1 = self.session.create_client( 'ec2', 'us-east-1') def create_volume(self, encrypted=False): available_zones = self.client.describe_availability_zones() first_zone = available_zones['AvailabilityZones'][0]['ZoneName'] response = self.client.create_volume( Size=1, AvailabilityZone=first_zone, Encrypted=encrypted) volume_id = response['VolumeId'] self.addCleanup(self.client.delete_volume, VolumeId=volume_id) self.client.get_waiter('volume_available').wait(VolumeIds=[volume_id]) return volume_id def create_snapshot(self, volume_id): response = self.client.create_snapshot(VolumeId=volume_id) snapshot_id = response['SnapshotId'] self.client.get_waiter('snapshot_completed').wait( SnapshotIds=[snapshot_id]) self.addCleanup(self.client.delete_snapshot, SnapshotId=snapshot_id) return snapshot_id def cleanup_copied_snapshot(self, snapshot_id): dest_client = self.session.create_client('ec2', 'us-east-1') self.addCleanup(dest_client.delete_snapshot, SnapshotId=snapshot_id) dest_client.get_waiter('snapshot_completed').wait( SnapshotIds=[snapshot_id]) def test_can_copy_snapshot(self): volume_id = self.create_volume() snapshot_id = self.create_snapshot(volume_id) result = self.client_us_east_1.copy_snapshot( SourceRegion='us-west-2', SourceSnapshotId=snapshot_id) self.assertIn('SnapshotId', result) # Cleanup code. We can wait for the snapshot to be complete # and then we can delete the snapshot. self.cleanup_copied_snapshot(result['SnapshotId']) def test_can_copy_encrypted_snapshot(self): # Note that we're creating an encrypted volume here. volume_id = self.create_volume(encrypted=True) snapshot_id = self.create_snapshot(volume_id) result = self.client_us_east_1.copy_snapshot( SourceRegion='us-west-2', SourceSnapshotId=snapshot_id) self.assertIn('SnapshotId', result) self.cleanup_copied_snapshot(result['SnapshotId']) if __name__ == '__main__': unittest.main() botocore-1.5.7/tests/integration/test_waiters.py0000666454262600001440000000551513042511306023167 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest, random_chars from nose.plugins.attrib import attr import botocore.session from botocore.exceptions import WaiterError # This is the same test as above, except using the client interface. @attr('slow') class TestWaiterForDynamoDB(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() self.client = self.session.create_client('dynamodb', 'us-west-2') def test_create_table_and_wait(self): table_name = 'botocoretest-%s' % random_chars(10) self.client.create_table( TableName=table_name, ProvisionedThroughput={"ReadCapacityUnits": 5, "WriteCapacityUnits": 5}, KeySchema=[{"AttributeName": "foo", "KeyType": "HASH"}], AttributeDefinitions=[{"AttributeName": "foo", "AttributeType": "S"}]) self.addCleanup(self.client.delete_table, TableName=table_name) waiter = self.client.get_waiter('table_exists') waiter.wait(TableName=table_name) parsed = self.client.describe_table(TableName=table_name) self.assertEqual(parsed['Table']['TableStatus'], 'ACTIVE') class TestCanGetWaitersThroughClientInterface(unittest.TestCase): def test_get_ses_waiter(self): # We're checking this because ses is not the endpoint prefix # for the service, it's email. We want to make sure this does # not affect the lookup process. session = botocore.session.get_session() client = session.create_client('ses', 'us-east-1') # If we have at least one waiter in the list, we know that we have # actually loaded the waiters and this test has passed. self.assertTrue(len(client.waiter_names) > 0) class TestMatchersWithErrors(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() self.client = self.session.create_client( 'ec2', region_name='us-west-2') def test_dont_search_on_error_responses(self): """Test that InstanceExists can handle a nonexistent instance.""" waiter = self.client.get_waiter('instance_exists') waiter.config.max_attempts = 1 with self.assertRaises(WaiterError): waiter.wait(InstanceIds=['i-12345']) botocore-1.5.7/tests/integration/test_rds.py0000666454262600001440000000321713042511306022276 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest import itertools import botocore.session class TestRDSPagination(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() self.client = self.session.create_client('rds', 'us-west-2') def test_can_paginate_reserved_instances(self): # Using an operation that we know will paginate. paginator = self.client.get_paginator( 'describe_reserved_db_instances_offerings') generator = paginator.paginate() results = list(itertools.islice(generator, 0, 3)) self.assertEqual(len(results), 3) self.assertTrue(results[0]['Marker'] != results[1]['Marker']) def test_can_paginate_orderable_db(self): paginator = self.client.get_paginator( 'describe_orderable_db_instance_options') generator = paginator.paginate(Engine='mysql') results = list(itertools.islice(generator, 0, 2)) self.assertEqual(len(results), 2) self.assertTrue(results[0].get('Marker') != results[1].get('Marker')) if __name__ == '__main__': unittest.main() botocore-1.5.7/tests/integration/test_utils.py0000666454262600001440000000461313042511306022647 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import time from tests import unittest import botocore.session from botocore.utils import ArgumentGenerator class ArgumentGeneratorError(AssertionError): def __init__(self, service_name, operation_name, generated, message): full_msg = ( 'Error generating skeleton for %s:%s, %s\nActual:\n%s' % ( service_name, operation_name, message, generated)) super(AssertionError, self).__init__(full_msg) def test_can_generate_all_inputs(): session = botocore.session.get_session() generator = ArgumentGenerator() for service_name in session.get_available_services(): service_model = session.get_service_model(service_name) for operation_name in service_model.operation_names: operation_model = service_model.operation_model(operation_name) input_shape = operation_model.input_shape if input_shape is not None and input_shape.members: yield (_test_can_generate_skeleton, generator, input_shape, service_name, operation_name) def _test_can_generate_skeleton(generator, shape, service_name, operation_name): generated = generator.generate_skeleton(shape) # Do some basic sanity checks to make sure the generated shape # looks right. We're mostly just ensuring that the generate_skeleton # doesn't throw an exception. if not isinstance(generated, dict): raise ArgumentGeneratorError( service_name, operation_name, generated, 'expected a dict') # The generated skeleton also shouldn't be empty (the test # generator has already filtered out input_shapes of None). if len(generated) == 0: raise ArgumentGeneratorError( service_name, operation_name, generated, "generated arguments were empty") botocore-1.5.7/tests/integration/test_route53.py0000666454262600001440000000361713042511306023020 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest import botocore.session from botocore.exceptions import ClientError class TestRoute53Pagination(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() self.client = self.session.create_client('route53', 'us-west-2') def test_paginate_with_max_items(self): # Route53 has a string type for MaxItems. We need to ensure that this # still works without any issues. paginator = self.client.get_paginator('list_hosted_zones') results = list(paginator.paginate(PaginationConfig={'MaxItems': '1'})) self.assertTrue(len(results) >= 0) def test_paginate_with_deprecated_paginator_and_limited_input_tokens(self): paginator = self.client.get_paginator('list_resource_record_sets') # We're making sure the paginator gets set without failing locally, so # a ClientError is acceptable. In this case, the Hosted Zone specified # does not exist. with self.assertRaises(ClientError): results = list(paginator.paginate( PaginationConfig={ 'MaxItems': '1', 'StartingToken': 'my.domain.name.' }, HostedZoneId="foo" )) self.assertTrue(len(results) >= 0) if __name__ == '__main__': unittest.main() botocore-1.5.7/tests/integration/test_cognito_identity.py0000666454262600001440000000226013042511306025056 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest, random_chars import botocore.session class TestCognitoIdentity(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() self.client = self.session.create_client('cognito-identity', 'us-east-1') def test_can_create_and_delete_identity_pool(self): pool_name = 'test%s' % random_chars(10) response = self.client.create_identity_pool( IdentityPoolName=pool_name, AllowUnauthenticatedIdentities=True) self.client.delete_identity_pool(IdentityPoolId=response['IdentityPoolId']) if __name__ == '__main__': unittest.main() botocore-1.5.7/tests/integration/test_sts.py0000666454262600001440000000364613042511306022325 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest import botocore.session from botocore.exceptions import ClientError class TestSTS(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() credentials = self.session.get_credentials() if credentials.token is not None: self.skipTest('STS tests require long-term credentials') def test_regionalized_endpoints(self): sts = self.session.create_client('sts', region_name='ap-southeast-1') response = sts.get_session_token() # Do not want to be revealing any temporary keys if the assertion fails self.assertIn('Credentials', response.keys()) # Since we have to activate STS regionalization, we will test # that you can send an STS request to a regionalized endpoint # by making a call with the explicitly wrong region name sts = self.session.create_client( 'sts', region_name='ap-southeast-1', endpoint_url='https://sts.us-west-2.amazonaws.com') self.assertEqual(sts.meta.region_name, 'ap-southeast-1') self.assertEqual(sts.meta.endpoint_url, 'https://sts.us-west-2.amazonaws.com') # Signing error will be thrown with the incorrect region name included. with self.assertRaisesRegexp(ClientError, 'ap-southeast-1') as e: sts.get_session_token() botocore-1.5.7/tests/integration/test_emr.py0000666454262600001440000000514313042511306022271 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest from nose.tools import assert_true import botocore.session from botocore.paginate import PageIterator from botocore.exceptions import OperationNotPageableError def test_emr_endpoints_work_with_py26(): # Verify that we can talk to all currently supported EMR endpoints. # Python2.6 has an SSL cert bug where it can't read the SAN of # certain SSL certs. We therefore need to always use the CN # as the hostname. session = botocore.session.get_session() for region in ['us-east-1', 'us-west-2', 'us-west-2', 'ap-northeast-1', 'ap-southeast-1', 'ap-southeast-2', 'sa-east-1', 'eu-west-1', 'eu-central-1']: yield _test_can_list_clusters_in_region, session, region def _test_can_list_clusters_in_region(session, region): client = session.create_client('emr', region_name=region) response = client.list_clusters() assert_true('Clusters' in response) # I consider these integration tests because they're # testing more than a single unit, we're ensuring everything # accessible from the session works as expected. class TestEMRGetExtraResources(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() self.client = self.session.create_client('emr', 'us-west-2') def test_can_access_pagination_configs(self): # Using an operation that we know will paginate. paginator = self.client.get_paginator('list_clusters') page_iterator = paginator.paginate() self.assertIsInstance(page_iterator, PageIterator) def test_operation_cant_be_paginated(self): with self.assertRaises(OperationNotPageableError): self.client.get_paginator('add_instance_groups') def test_can_get_waiters(self): waiter = self.client.get_waiter('cluster_running') self.assertTrue(hasattr(waiter, 'wait')) def test_waiter_does_not_exist(self): with self.assertRaises(ValueError): self.client.get_waiter('does_not_exist') if __name__ == '__main__': unittest.main() botocore-1.5.7/tests/integration/test_session.py0000666454262600001440000000413113042511306023165 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest import botocore.session class TestCanChangeParsing(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() def test_can_change_timestamp_with_clients(self): factory = self.session.get_component('response_parser_factory') factory.set_parser_defaults(timestamp_parser=lambda x: str(x)) # Now if we get a response with timestamps in the model, they # will be returned as strings. We're testing service/operation # objects, but we should also add a test for clients. s3 = self.session.create_client('s3', 'us-west-2') parsed = s3.list_buckets() dates = [bucket['CreationDate'] for bucket in parsed['Buckets']] self.assertTrue(all(isinstance(date, str) for date in dates), "Expected all str types but instead got: %s" % dates) def test_maps_service_name_when_overriden(self): ses = self.session.get_service_model('ses') self.assertEqual(ses.endpoint_prefix, 'email') # But we should map the service_name to be the same name # used when calling get_service_model which is different # than the endpoint_prefix. self.assertEqual(ses.service_name, 'ses') def test_maps_service_name_from_client(self): # Same thing as test_maps_service_name_from_client, # except through the client interface. client = self.session.create_client('ses', region_name='us-east-1') self.assertEqual(client.meta.service_model.service_name, 'ses') botocore-1.5.7/tests/integration/__init__.py0000666454262600001440000000106613042511306022206 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. botocore-1.5.7/tests/integration/test_kinesis.py0000666454262600001440000001043013042511306023146 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import time from tests import unittest, random_chars from nose.plugins.attrib import attr import botocore.session class TestKinesisListStreams(unittest.TestCase): REGION = 'us-east-1' def setUp(self): self.client = self.session.create_client('kinesis', self.REGION) @classmethod def setUpClass(cls): cls.session = botocore.session.get_session() cls.stream_name = 'botocore-test-%s' % random_chars(10) client = cls.session.create_client('kinesis', cls.REGION) client.create_stream(StreamName=cls.stream_name, ShardCount=1) waiter = client.get_waiter('stream_exists') waiter.wait(StreamName=cls.stream_name) @classmethod def tearDownClass(cls): client = cls.session.create_client('kinesis', cls.REGION) client.delete_stream(StreamName=cls.stream_name) def test_list_streams(self): parsed = self.client.list_streams() self.assertIn('StreamNames', parsed) @attr('slow') def test_can_put_stream_blob(self): self.client.put_record( StreamName=self.stream_name, PartitionKey='foo', Data='foobar') # Give it a few seconds for the record to get into the stream. time.sleep(10) stream = self.client.describe_stream(StreamName=self.stream_name) shard = stream['StreamDescription']['Shards'][0] shard_iterator = self.client.get_shard_iterator( StreamName=self.stream_name, ShardId=shard['ShardId'], ShardIteratorType='TRIM_HORIZON') records = self.client.get_records( ShardIterator=shard_iterator['ShardIterator']) self.assertTrue(len(records['Records']) > 0) self.assertEqual(records['Records'][0]['Data'], b'foobar') @attr('slow') def test_can_put_records_single_blob(self): self.client.put_records( StreamName=self.stream_name, Records=[{ 'Data': 'foobar', 'PartitionKey': 'foo' }] ) # Give it a few seconds for the record to get into the stream. time.sleep(10) stream = self.client.describe_stream(StreamName=self.stream_name) shard = stream['StreamDescription']['Shards'][0] shard_iterator = self.client.get_shard_iterator( StreamName=self.stream_name, ShardId=shard['ShardId'], ShardIteratorType='TRIM_HORIZON') records = self.client.get_records( ShardIterator=shard_iterator['ShardIterator']) self.assertTrue(len(records['Records']) > 0) self.assertEqual(records['Records'][0]['Data'], b'foobar') @attr('slow') def test_can_put_records_multiple_blob(self): self.client.put_records( StreamName=self.stream_name, Records=[{ 'Data': 'foobar', 'PartitionKey': 'foo' }, { 'Data': 'barfoo', 'PartitionKey': 'foo' }] ) # Give it a few seconds for the record to get into the stream. time.sleep(10) stream = self.client.describe_stream(StreamName=self.stream_name) shard = stream['StreamDescription']['Shards'][0] shard_iterator = self.client.get_shard_iterator( StreamName=self.stream_name, ShardId=shard['ShardId'], ShardIteratorType='TRIM_HORIZON') records = self.client.get_records( ShardIterator=shard_iterator['ShardIterator']) self.assertTrue(len(records['Records']) == 2) # Verify that both made it through. record_data = [r['Data'] for r in records['Records']] self.assertEqual(sorted([b'foobar', b'barfoo']), sorted(record_data)) if __name__ == '__main__': unittest.main() botocore-1.5.7/tests/integration/test_elastictranscoder.py0000666454262600001440000000560613042511306025223 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest, random_chars import functools import botocore.session DEFAULT_ROLE_POLICY = """\ {"Statement": [ { "Action": "sts:AssumeRole", "Principal": { "Service": "elastictranscoder.amazonaws.com" }, "Effect": "Allow", "Sid": "1" } ]} """ class TestElasticTranscoder(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() self.client = self.session.create_client( 'elastictranscoder', 'us-east-1') self.s3_client = self.session.create_client('s3', 'us-east-1') self.iam_client = self.session.create_client('iam', 'us-east-1') def create_bucket(self): bucket_name = 'ets-bucket-1-%s' % random_chars(50) self.s3_client.create_bucket(Bucket=bucket_name) self.addCleanup( self.s3_client.delete_bucket, Bucket=bucket_name) return bucket_name def create_iam_role(self): role_name = 'ets-role-name-1-%s' % random_chars(10) parsed = self.iam_client.create_role( RoleName=role_name, AssumeRolePolicyDocument=DEFAULT_ROLE_POLICY) arn = parsed['Role']['Arn'] self.addCleanup( self.iam_client.delete_role, RoleName=role_name) return arn def test_list_streams(self): parsed = self.client.list_pipelines() self.assertIn('Pipelines', parsed) def test_list_presets(self): parsed = self.client.list_presets(Ascending='true') self.assertIn('Presets', parsed) def test_create_pipeline(self): # In order to create a pipeline, we need to create 2 s3 buckets # and 1 iam role. input_bucket = self.create_bucket() output_bucket = self.create_bucket() role = self.create_iam_role() pipeline_name = 'botocore-test-create-%s' % random_chars(10) parsed = self.client.create_pipeline( InputBucket=input_bucket, OutputBucket=output_bucket, Role=role, Name=pipeline_name, Notifications={'Progressing': '', 'Completed': '', 'Warning': '', 'Error': ''}) pipeline_id = parsed['Pipeline']['Id'] self.addCleanup(self.client.delete_pipeline, Id=pipeline_id) self.assertIn('Pipeline', parsed) if __name__ == '__main__': unittest.main() botocore-1.5.7/tests/integration/test_client.py0000666454262600001440000002165013042511306022765 0ustar pysdk-ciamazon00000000000000# Copyright 2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import time import logging import datetime from tests import unittest, random_chars import botocore.session from botocore.client import ClientError from botocore.compat import six from botocore.exceptions import EndpointConnectionError from six import StringIO class TestBucketWithVersions(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() self.client = self.session.create_client('s3', region_name='us-west-2') self.bucket_name = 'botocoretest%s' % random_chars(50) def extract_version_ids(self, versions): version_ids = [] for marker in versions['DeleteMarkers']: version_ids.append(marker['VersionId']) for version in versions['Versions']: version_ids.append(version['VersionId']) return version_ids def test_create_versioned_bucket(self): # Verifies we can: # 1. Create a bucket # 2. Enable versioning # 3. Put an Object self.client.create_bucket( Bucket=self.bucket_name, CreateBucketConfiguration={ 'LocationConstraint': 'us-west-2' } ) self.addCleanup(self.client.delete_bucket, Bucket=self.bucket_name) self.client.put_bucket_versioning( Bucket=self.bucket_name, VersioningConfiguration={"Status": "Enabled"}) response = self.client.put_object( Bucket=self.bucket_name, Key='testkey', Body='bytes body') self.addCleanup(self.client.delete_object, Bucket=self.bucket_name, Key='testkey', VersionId=response['VersionId']) response = self.client.get_object( Bucket=self.bucket_name, Key='testkey') self.assertEqual(response['Body'].read(), b'bytes body') response = self.client.delete_object(Bucket=self.bucket_name, Key='testkey') # This cleanup step removes the DeleteMarker that's created # from the delete_object call above. self.addCleanup(self.client.delete_object, Bucket=self.bucket_name, Key='testkey', VersionId=response['VersionId']) # Object does not exist anymore. with self.assertRaises(ClientError): self.client.get_object(Bucket=self.bucket_name, Key='testkey') versions = self.client.list_object_versions(Bucket=self.bucket_name) version_ids = self.extract_version_ids(versions) self.assertEqual(len(version_ids), 2) # This is really a combination of testing the debug logging mechanism # as well as the response wire log, which theoretically could be # implemented in any number of modules, which makes it hard to pick # which integration test module this code should live in, so I picked # the client module. class TestResponseLog(unittest.TestCase): def test_debug_log_contains_headers_and_body(self): # This test just verifies that the response headers/body # are in the debug log. It's an integration test so that # we can refactor the code however we want, as long as we don't # lose this feature. session = botocore.session.get_session() client = session.create_client('s3', region_name='us-west-2') debug_log = StringIO() session.set_stream_logger('', logging.DEBUG, debug_log) client.list_buckets() debug_log_contents = debug_log.getvalue() self.assertIn('Response headers', debug_log_contents) self.assertIn('Response body', debug_log_contents) class TestAcceptedDateTimeFormats(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() self.client = self.session.create_client('emr', 'us-west-2') def test_accepts_datetime_object(self): response = self.client.list_clusters( CreatedAfter=datetime.datetime.now()) self.assertIn('Clusters', response) def test_accepts_epoch_format(self): response = self.client.list_clusters(CreatedAfter=0) self.assertIn('Clusters', response) def test_accepts_iso_8601_unaware(self): response = self.client.list_clusters( CreatedAfter='2014-01-01T00:00:00') self.assertIn('Clusters', response) def test_accepts_iso_8601_utc(self): response = self.client.list_clusters( CreatedAfter='2014-01-01T00:00:00Z') self.assertIn('Clusters', response) def test_accepts_iso_8701_local(self): response = self.client.list_clusters( CreatedAfter='2014-01-01T00:00:00-08:00') self.assertIn('Clusters', response) class TestCreateClients(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() def test_client_can_clone_with_service_events(self): # We should also be able to create a client object. client = self.session.create_client('s3', region_name='us-west-2') # We really just want to ensure create_client doesn't raise # an exception, but we'll double check that the client looks right. self.assertTrue(hasattr(client, 'list_buckets')) def test_client_raises_exception_invalid_region(self): with self.assertRaisesRegexp(ValueError, ('Invalid endpoint')): self.session.create_client( 'cloudformation', region_name='invalid region name') class TestClientErrors(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() def test_region_mentioned_in_invalid_region(self): client = self.session.create_client( 'cloudformation', region_name='us-east-999') with self.assertRaisesRegexp(EndpointConnectionError, 'Could not connect to the endpoint URL'): client.list_stacks() def test_client_modeled_exception(self): client = self.session.create_client( 'dynamodb', region_name='us-west-2') with self.assertRaises(client.exceptions.ResourceNotFoundException): client.describe_table(TableName="NonexistentTable") def test_client_modeleded_exception_with_differing_code(self): client = self.session.create_client('iam', region_name='us-west-2') # The NoSuchEntityException should be raised on NoSuchEntity error # code. with self.assertRaises(client.exceptions.NoSuchEntityException): client.get_role(RoleName="NonexistentIAMRole") def test_raises_general_client_error_for_non_modeled_exception(self): client = self.session.create_client('ec2', region_name='us-west-2') try: client.describe_regions(DryRun=True) except client.exceptions.ClientError as e: self.assertIs(e.__class__, ClientError) def test_can_catch_client_exceptions_across_two_different_clients(self): client = self.session.create_client( 'dynamodb', region_name='us-west-2') client2 = self.session.create_client( 'dynamodb', region_name='us-west-2') with self.assertRaises(client2.exceptions.ResourceNotFoundException): client.describe_table(TableName="NonexistentTable") class TestClientMeta(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() def test_region_name_on_meta(self): client = self.session.create_client('s3', 'us-west-2') self.assertEqual(client.meta.region_name, 'us-west-2') def test_endpoint_url_on_meta(self): client = self.session.create_client('s3', 'us-west-2', endpoint_url='https://foo') self.assertEqual(client.meta.endpoint_url, 'https://foo') class TestClientInjection(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() def test_can_inject_client_methods(self): def extra_client_method(self, name): return name def inject_client_method(class_attributes, **kwargs): class_attributes['extra_client_method'] = extra_client_method self.session.register('creating-client-class.s3', inject_client_method) client = self.session.create_client('s3', 'us-west-2') # We should now have access to the extra_client_method above. self.assertEqual(client.extra_client_method('foo'), 'foo') botocore-1.5.7/tests/acceptance/0000777454262600001440000000000013042511307017636 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/0000777454262600001440000000000013042511310021446 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/steps/0000777454262600001440000000000013042511310022604 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/steps/base.py0000666454262600001440000000710613042511306024101 0ustar pysdk-ciamazon00000000000000import json from botocore import xform_name from botocore.exceptions import ClientError import jmespath from behave import when, then from nose.tools import assert_equal from nose.tools import assert_is_instance def _params_from_table(table): # Unfortunately the way we're using table is not quite how # behave expects tables to be used: # They expect: # # | name | department | # | Barry | foo | # | Pudey | bar | # | Two-Lumps | bar | # # Where the first row are headings that indicate the # key name you can use to retrieve row values, # e.g row['name'] -> Barry. # # # We just use: # | LaunchConfigurationName | hello, world | # | ImageId | ami-12345678 | # | InstanceType | m1.small | # # So we have to grab the headings before iterating over # the table rows. params = {table.headings[0]: table.headings[1]} for row in table: params[row[0]] = row[1] return params @when(u'I call the "{}" API') def api_call_no_args(context, operation): context.response = getattr(context.client, xform_name(operation))() @when(u'I call the "{}" API with') def api_call_with_args(context, operation): params = _params_from_table(context.table) context.response = getattr(context.client, xform_name(operation))(**params) @when(u'I call the "{}" API with JSON') def api_call_with_json(context, operation): params = json.loads(context.text) context.response = getattr(context.client, xform_name(operation))(**params) @when(u'I attempt to call the "{}" API with') def api_call_with_error(context, operation): params = _params_from_table(context.table) try: getattr(context.client, xform_name(operation))(**params) except ClientError as e: context.error_response = e @when(u'I attempt to call the "{}" API with JSON') def api_call_with_json_and_error(context, operation): params = json.loads(context.text) try: getattr(context.client, xform_name(operation))(**params) except ClientError as e: context.error_response = e @then(u'I expect the response error code to be "{}"') def then_expected_error(context, code): assert_equal(context.error_response.response['Error']['Code'], code) @then(u'the value at "{}" should be a list') def then_expected_type_is_list(context, expression): # In botocore, if there are no values with an element, # it will not appear in the response dict, so it's actually # ok if the element does not exist (and is not a list). # If an exception happened the test will have already failed, # which makes this step a noop. We'll just verify # the response is a dict to ensure it made it through # our response parser properly. if not isinstance(context.response, dict): raise AssertionError("Response is not a dict: %s" % context.response) @then(u'the response should contain a "{}"') def then_should_contain_key(context, key): # See then_expected_type_is_a_list for more background info. # We really just care that the request succeeded for these # smoke tests. if not isinstance(context.response, dict): raise AssertionError("Response is not a dict: %s" % context.response) @then(u'I expect the response error to contain a message') def then_error_has_message(context): if 'Message' not in context.error_response.response['Error']: raise AssertionError("Message key missing from error response: %s" % context.error_response.response) botocore-1.5.7/tests/acceptance/features/environment.py0000666454262600001440000000322313042511306024371 0ustar pysdk-ciamazon00000000000000import os import botocore.session SESSION = botocore.session.get_session() KNOWN_SERVICES = SESSION.get_available_services() # For the services where the tag name doesn't match # the name we use to create_client(), we need to maintain # a map until we can get these changes pushed upstream. TAG_TO_ENDPOINT_PREFIX = { 'cognitoidentity': 'cognito-identity', 'cognitosync': 'cognito-sync', 'elasticloadbalancing': 'elb', 'elasticfilesystem': 'efs', } REGION = 'us-east-1' REGION_OVERRIDES = { 'devicefarm': 'us-west-2', 'efs': 'us-west-2', } SKIP_SERVICES = set([ # efs/support require subscriptions and may not work on every machine. 'efs', 'support', # sts and importexport are skipped because they do not # work when using temporary credentials. 'sts', 'importexport', ]) def before_feature(context, feature): for tag in feature.tags: if tag in TAG_TO_ENDPOINT_PREFIX: service_name = TAG_TO_ENDPOINT_PREFIX[tag] break elif tag in KNOWN_SERVICES: service_name = tag break else: raise RuntimeError("Unable to create a client for " "feature: %s" % feature) if service_name in SKIP_SERVICES: feature.mark_skipped() return region_name = _get_region_for_service(service_name) context.client = SESSION.create_client(service_name, region_name) def _get_region_for_service(service_name): if os.environ.get('AWS_SMOKE_TEST_REGION', ''): region_name = os.environ['AWS_SMOKE_TEST_REGION'] else: region_name = REGION_OVERRIDES.get(service_name, REGION) return region_name botocore-1.5.7/tests/acceptance/features/smoke/0000777454262600001440000000000013042511307022572 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/cloudwatchlogs/0000777454262600001440000000000013042511310025606 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/cloudwatchlogs/cloudwatchlogs.feature0000666454262600001440000000074313042511306032216 0ustar pysdk-ciamazon00000000000000# language: en @cloudwatchlogs @logs Feature: Amazon CloudWatch Logs Scenario: Making a request When I call the "DescribeLogGroups" API Then the value at "logGroups" should be a list Scenario: Handling errors When I attempt to call the "GetLogEvents" API with: | logGroupName | fakegroup | | logStreamName | fakestream | Then I expect the response error code to be "ResourceNotFoundException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/cognitosync/0000777454262600001440000000000013042511310025123 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/cognitosync/cognitosync.feature0000666454262600001440000000076213042511306031051 0ustar pysdk-ciamazon00000000000000# language: en @cognitosync Feature: Amazon Cognito Sync Scenario: Making a request When I call the "ListIdentityPoolUsage" API Then the value at "IdentityPoolUsages" should be a list Scenario: Handling errors When I attempt to call the "DescribeIdentityPoolUsage" API with: | IdentityPoolId | us-east-1:aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee | Then I expect the response error code to be "ResourceNotFoundException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/ec2/0000777454262600001440000000000013042511310023235 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/ec2/ec2.feature0000666454262600001440000000071413042511306025272 0ustar pysdk-ciamazon00000000000000# language: en @ec2 Feature: Amazon Elastic Compute Cloud Scenario: Making a request When I call the "DescribeRegions" API Then the value at "Regions" should be a list Scenario: Handling errors When I attempt to call the "DescribeInstances" API with JSON: """ {"InstanceIds": ["i-12345678"]} """ Then I expect the response error code to be "InvalidInstanceID.NotFound" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/cloudhsm/0000777454262600001440000000000013042511310024402 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/cloudhsm/cloudhsm.feature0000666454262600001440000000062713042511306027607 0ustar pysdk-ciamazon00000000000000# language: en @cloudhsm Feature: Amazon CloudHSM Scenario: Making a request When I call the "ListHapgs" API Then the value at "HapgList" should be a list Scenario: Handling errors When I attempt to call the "DescribeHapg" API with: | HapgArn | bogus-arn | Then I expect the response error code to be "ValidationException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/codepipeline/0000777454262600001440000000000013042511310025224 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/codepipeline/codepipeline.feature0000666454262600001440000000065113042511306031250 0ustar pysdk-ciamazon00000000000000# language: en @codepipeline Feature: Amazon CodePipeline Scenario: Making a request When I call the "ListPipelines" API Then the value at "pipelines" should be a list Scenario: Handling errors When I attempt to call the "GetPipeline" API with: | name | fake-pipeline | Then I expect the response error code to be "PipelineNotFoundException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/datapipeline/0000777454262600001440000000000013042511310025223 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/datapipeline/datapipeline.feature0000666454262600001440000000066613042511306031254 0ustar pysdk-ciamazon00000000000000# language: en @datapipeline Feature: AWS Data Pipeline Scenario: Making a request When I call the "ListPipelines" API Then the response should contain a "pipelineIdList" Scenario: Handling errors When I attempt to call the "GetPipelineDefinition" API with: | pipelineId | fake-id | Then I expect the response error code to be "PipelineNotFoundException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/elasticloadbalancing/0000777454262600001440000000000013042511310026707 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/elasticloadbalancing/elasticloadbalancing.feature0000666454262600001440000000076513042511306034424 0ustar pysdk-ciamazon00000000000000# language: en @elasticloadbalancing Feature: Elastic Load Balancing Scenario: Making a request When I call the "DescribeLoadBalancers" API Then the value at "LoadBalancerDescriptions" should be a list Scenario: Handling errors When I attempt to call the "DescribeLoadBalancers" API with JSON: """ {"LoadBalancerNames": ["fake_load_balancer"]} """ Then I expect the response error code to be "ValidationError" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/devicefarm/0000777454262600001440000000000013042511310024671 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/devicefarm/devicefarm.feature0000666454262600001440000000071413042511306030362 0ustar pysdk-ciamazon00000000000000# language: en @devicefarm Feature: AWS Device Farm Scenario: Making a request When I call the "ListDevices" API Then the value at "devices" should be a list Scenario: Handling errors When I attempt to call the "GetDevice" API with: | arn | arn:aws:devicefarm:us-west-2::device:000000000000000000000000fake-arn | Then I expect the response error code to be "NotFoundException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/machinelearning/0000777454262600001440000000000013042511310025710 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/machinelearning/machinelearning.feature0000666454262600001440000000074713042511306032426 0ustar pysdk-ciamazon00000000000000# language: en @machinelearning Feature: Amazon Machine Learning I want to use Amazon Machine Learning Scenario: Making a request When I call the "DescribeMLModels" API Then the value at "Results" should be a list Scenario: Error handling When I attempt to call the "GetBatchPrediction" API with: | BatchPredictionId | fake-id | Then I expect the response error code to be "ResourceNotFoundException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/ssm/0000777454262600001440000000000013042511310023366 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/ssm/ssm.feature0000666454262600001440000000063113042511306025552 0ustar pysdk-ciamazon00000000000000# language: en @ssm Feature: Amazon SSM Scenario: Making a request When I call the "ListDocuments" API Then the value at "DocumentIdentifiers" should be a list Scenario: Handling errors When I attempt to call the "GetDocument" API with: | Name | 'fake-name' | Then I expect the response error code to be "ValidationException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/configservice/0000777454262600001440000000000013042511310025412 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/configservice/configservice.feature0000666454262600001440000000076313042511306031630 0ustar pysdk-ciamazon00000000000000# language: en @configservice @config Feature: AWS Config Scenario: Making a request When I call the "DescribeConfigurationRecorders" API Then the value at "ConfigurationRecorders" should be a list Scenario: Handling errors When I attempt to call the "GetResourceConfigHistory" API with: | resourceType | fake-type | | resourceId | fake-id | Then I expect the response error code to be "ValidationException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/cloudformation/0000777454262600001440000000000013042511310025611 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/cloudformation/cloudformation.feature0000666454262600001440000000076113042511306032224 0ustar pysdk-ciamazon00000000000000# language: en @cloudformation Feature: AWS CloudFormation Scenario: Making a request When I call the "ListStacks" API Then the value at "StackSummaries" should be a list Scenario: Handling errors When I attempt to call the "CreateStack" API with: | StackName | fakestack | | TemplateURL | http://s3.amazonaws.com/foo/bar | Then I expect the response error code to be "ValidationError" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/es/0000777454262600001440000000000013042511310023173 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/es/es.feature0000666454262600001440000000073513042511306025171 0ustar pysdk-ciamazon00000000000000# language: en @es @elasticsearchservice Feature: Amazon ElasticsearchService Scenario: Making a request When I call the "ListDomainNames" API Then the value at "DomainNames" should be a list Scenario: Handling errors When I attempt to call the "DescribeElasticsearchDomain" API with: | DomainName | not-a-domain | Then I expect the response error code to be "ResourceNotFoundException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/importexport/0000777454262600001440000000000013042511310025340 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/importexport/importexport.feature0000666454262600001440000000074513042511306031504 0ustar pysdk-ciamazon00000000000000# language: en @importexport Feature: AWS Import Export Scenario: Making a request When I call the "ListJobs" API Then the value at "Jobs" should be a list Scenario: Handling errors When I attempt to call the "CreateJob" API with JSON: """ {"JobType": "Import", "ValidateOnly": false, "Manifest": "invalid-manifest"} """ Then I expect the response error code to be "MalformedManifestException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/rds/0000777454262600001440000000000013042511310023354 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/rds/rds.feature0000666454262600001440000000066413042511306025534 0ustar pysdk-ciamazon00000000000000# language: en @rds Feature: Amazon RDS Scenario: Making a request When I call the "DescribeDBEngineVersions" API Then the value at "DBEngineVersions" should be a list Scenario: Handling errors When I attempt to call the "DescribeDBInstances" API with: | DBInstanceIdentifier | fake-id | Then I expect the response error code to be "DBInstanceNotFound" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/elasticache/0000777454262600001440000000000013042511310025031 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/elasticache/elasticache.feature0000666454262600001440000000065513042511306030666 0ustar pysdk-ciamazon00000000000000# language: en @elasticache Feature: ElastiCache Scenario: Making a request When I call the "DescribeEvents" API Then the value at "Events" should be a list Scenario: Handling errors When I attempt to call the "DescribeCacheClusters" API with: | CacheClusterId | fake_cluster | Then I expect the response error code to be "InvalidParameterValue" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/redshift/0000777454262600001440000000000013042511310024374 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/redshift/redshift.feature0000666454262600001440000000067013042511306027571 0ustar pysdk-ciamazon00000000000000# language: en @redshift Feature: Amazon Redshift Scenario: Making a request When I call the "DescribeClusterVersions" API Then the value at "ClusterVersions" should be a list Scenario: Handling errors When I attempt to call the "DescribeClusters" API with: | ClusterIdentifier | fake-cluster | Then I expect the response error code to be "ClusterNotFound" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/codedeploy/0000777454262600001440000000000013042511310024713 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/codedeploy/codedeploy.feature0000666454262600001440000000067313042511306030432 0ustar pysdk-ciamazon00000000000000# language: en @codedeploy Feature: Amazon CodeDeploy Scenario: Making a request When I call the "ListApplications" API Then the value at "applications" should be a list Scenario: Handling errors When I attempt to call the "GetDeployment" API with: | deploymentId | d-USUAELQEX | Then I expect the response error code to be "DeploymentDoesNotExistException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/cloudwatch/0000777454262600001440000000000013042511310024721 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/cloudwatch/cloudwatch.feature0000666454262600001440000000077013042511306030444 0ustar pysdk-ciamazon00000000000000# language: en @cloudwatch @monitoring Feature: Amazon CloudWatch Scenario: Making a request When I call the "ListMetrics" API with: | Namespace | AWS/EC2 | Then the value at "Metrics" should be a list Scenario: Handling errors When I attempt to call the "SetAlarmState" API with: | AlarmName | abc | | StateValue | mno | | StateReason | xyz | Then I expect the response error code to be "ValidationError" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/kinesis/0000777454262600001440000000000013042511310024231 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/kinesis/kinesis.feature0000666454262600001440000000065113042511306027262 0ustar pysdk-ciamazon00000000000000# language: en @kinesis Feature: AWS Kinesis Scenario: Making a request When I call the "ListStreams" API Then the value at "StreamNames" should be a list Scenario: Handling errors When I attempt to call the "DescribeStream" API with: | StreamName | bogus-stream-name | Then I expect the response error code to be "ResourceNotFoundException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/elasticbeanstalk/0000777454262600001440000000000013042511310026075 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/elasticbeanstalk/elasticbeanstalk.feature0000666454262600001440000000073313042511306032773 0ustar pysdk-ciamazon00000000000000# language: en @elasticbeanstalk Feature: AWS Elastic Beanstalk Scenario: Making a request When I call the "ListAvailableSolutionStacks" API Then the value at "SolutionStacks" should be a list Scenario: Handling errors When I attempt to call the "DescribeEnvironmentResources" API with: | EnvironmentId | fake_environment | Then I expect the response error code to be "InvalidParameterValue" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/directconnect/0000777454262600001440000000000013042511310025410 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/directconnect/directconnect.feature0000666454262600001440000000070613042511306031621 0ustar pysdk-ciamazon00000000000000# language: en @directconnect Feature: AWS Direct Connect Scenario: Making a request When I call the "DescribeConnections" API Then the value at "connections" should be a list Scenario: Handling errors When I attempt to call the "DescribeConnections" API with: | connectionId | fake-connection | Then I expect the response error code to be "DirectConnectClientException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/dynamodb/0000777454262600001440000000000013042511310024361 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/dynamodb/dynamodb.feature0000666454262600001440000000071713042511306027545 0ustar pysdk-ciamazon00000000000000# language: en @dynamodb Feature: Amazon DynamoDB Scenario: Making a request When I call the "ListTables" API with JSON: """ {"Limit": 1} """ Then the value at "TableNames" should be a list Scenario: Handling errors When I attempt to call the "DescribeTable" API with: | TableName | fake-table | Then I expect the response error code to be "ResourceNotFoundException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/route53domains/0000777454262600001440000000000013042511310025445 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/route53domains/route53domains.feature0000666454262600001440000000065213042511306031713 0ustar pysdk-ciamazon00000000000000# language: en @route53domains Feature: Amazon Route53 Domains Scenario: Making a request When I call the "ListDomains" API Then the value at "Domains" should be a list Scenario: Handling errors When I attempt to call the "GetDomainDetail" API with: | DomainName | fake-domain-name | Then I expect the response error code to be "InvalidInput" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/autoscaling/0000777454262600001440000000000013042511310025075 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/autoscaling/autoscaling.feature0000666454262600001440000000104213042511306030765 0ustar pysdk-ciamazon00000000000000# language: en @autoscaling Feature: Auto Scaling Scenario: Making a request When I call the "DescribeScalingProcessTypes" API Then the value at "Processes" should be a list Scenario: Handing errors When I attempt to call the "CreateLaunchConfiguration" API with: | LaunchConfigurationName | hello, world | | ImageId | ami-12345678 | | InstanceType | m1.small | Then I expect the response error code to be "ValidationError" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/route53/0000777454262600001440000000000013042511310024072 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/route53/route53.feature0000666454262600001440000000062713042511306026767 0ustar pysdk-ciamazon00000000000000# language: en @route53 Feature: Amazon Route 53 Scenario: Making a request When I call the "ListHostedZones" API Then the value at "HostedZones" should be a list Scenario: Handling errors When I attempt to call the "GetHostedZone" API with: | Id | fake-zone | Then I expect the response error code to be "NoSuchHostedZone" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/swf/0000777454262600001440000000000013042511310023363 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/swf/swf.feature0000666454262600001440000000072513042511306025550 0ustar pysdk-ciamazon00000000000000# language: en @swf Feature: Amazon Simple Workflow Service Scenario: Making a request When I call the "ListDomains" API with: | registrationStatus | REGISTERED | Then the value at "domainInfos" should be a list Scenario: Handling errors When I attempt to call the "DescribeDomain" API with: | name | fake_domain | Then I expect the response error code to be "UnknownResourceFault" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/ses/0000777454262600001440000000000013042511310023356 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/ses/ses.feature0000666454262600001440000000067213042511306025537 0ustar pysdk-ciamazon00000000000000# language: en @ses @email Feature: Amazon Simple Email Service Scenario: Making a request When I call the "ListIdentities" API Then the value at "Identities" should be a list Scenario: Handling errors When I attempt to call the "VerifyEmailIdentity" API with: | EmailAddress | fake_email | Then I expect the response error code to be "InvalidParameterValue" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/ecs/0000777454262600001440000000000013042511310023336 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/ecs/ecs.feature0000666454262600001440000000062013042511306025470 0ustar pysdk-ciamazon00000000000000# language: en @ecs Feature: Amazon ECS I want to use Amazon ECS Scenario: Making a request When I call the "ListClusters" API Then the value at "clusterArns" should be a list Scenario: Handling errors When I attempt to call the "StopTask" API with: | task | xxxxxxxxxxx-xxxxxxxxxxxx-xxxxxxxxxxx | Then I expect the response error code to be "ClusterNotFoundException" botocore-1.5.7/tests/acceptance/features/smoke/acm/0000777454262600001440000000000013042511310023324 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/acm/acm.feature0000666454262600001440000000067413042511306025455 0ustar pysdk-ciamazon00000000000000# language: en @acm Feature: AWS Certificate Manager Scenario: Making a request When I call the "ListCertificates" API Then the value at "CertificateStatuses" should be a list Scenario: Handling errors When I attempt to call the "GetCertificate" API with: | CertificateArn | arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 | Then I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/opsworks/0000777454262600001440000000000013042511310024453 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/opsworks/opsworks.feature0000666454262600001440000000063713042511306027732 0ustar pysdk-ciamazon00000000000000# language: en @opsworks Feature: AWS OpsWorks Scenario: Making a request When I call the "DescribeStacks" API Then the value at "Stacks" should be a list Scenario: Handling errors When I attempt to call the "DescribeLayers" API with: | StackId | fake_stack | Then I expect the response error code to be "ResourceNotFoundException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/glacier/0000777454262600001440000000000013042511310024172 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/glacier/glacier.feature0000666454262600001440000000063613042511306027167 0ustar pysdk-ciamazon00000000000000# language: en @glacier Feature: Amazon Glacier Scenario: Making a request When I call the "ListVaults" API Then the response should contain a "VaultList" Scenario: Handling errors When I attempt to call the "ListVaults" API with: | accountId | abcmnoxyz | Then I expect the response error code to be "UnrecognizedClientException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/storagegateway/0000777454262600001440000000000013042511310025612 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/storagegateway/storagegateway.feature0000666454262600001440000000073513042511306032227 0ustar pysdk-ciamazon00000000000000# language: en @storagegateway Feature: AWS Storage Gateway Scenario: Making a request When I call the "ListGateways" API Then the value at "Gateways" should be a list Scenario: Handling errors When I attempt to call the "ListVolumes" API with: | GatewayARN | fake_gateway_that_meets_the_minimum_length_restriction | Then I expect the response error code to be "InvalidGatewayRequestException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/sns/0000777454262600001440000000000013042511310023367 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/sns/sns.feature0000666454262600001440000000067313042511306025562 0ustar pysdk-ciamazon00000000000000# language: en @sns Feature: Amazon Simple Notification Service Scenario: Making a request When I call the "ListTopics" API Then the value at "Topics" should be a list Scenario: Handling errors When I attempt to call the "Publish" API with: | Message | hello | | TopicArn | fake_topic | Then I expect the response error code to be "InvalidParameter" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/support/0000777454262600001440000000000013042511310024300 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/support/support.feature0000666454262600001440000000116313042511306027377 0ustar pysdk-ciamazon00000000000000# language: en @support Feature: AWS Support I want to use AWS Support Scenario: Making a request When I call the "DescribeServices" API Then the value at "services" should be a list Scenario: Handling errors When I attempt to call the "CreateCase" API with: | subject | subject | | communicationBody | communication | | categoryCode | category | | serviceCode | amazon-dynamodb | | severityCode | low | Then I expect the response error code to be "InvalidParameterValueException" And the response error contains a message botocore-1.5.7/tests/acceptance/features/smoke/cloudsearch/0000777454262600001440000000000013042511310025060 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/cloudsearch/cloudsearch.feature0000666454262600001440000000066313042511306030743 0ustar pysdk-ciamazon00000000000000# language: en @cloudsearch Feature: Amazon CloudSearch Scenario: Making a request When I call the "DescribeDomains" API Then the response should contain a "DomainStatusList" Scenario: Handling errors When I attempt to call the "DescribeIndexFields" API with: | DomainName | fakedomain | Then I expect the response error code to be "ResourceNotFound" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/directoryservice/0000777454262600001440000000000013042511310026151 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/directoryservice/directoryservice.feature0000666454262600001440000000072713042511306033126 0ustar pysdk-ciamazon00000000000000# language: en @directoryservice @ds Feature: AWS Directory Service I want to use AWS Directory Service Scenario: Making a request When I call the "DescribeDirectories" API Then the value at "DirectoryDescriptions" should be a list Scenario: Handling errors When I attempt to call the "CreateDirectory" API with: | Name | | | Password | | | Size | | Then I expect the response error code to be "ValidationException" botocore-1.5.7/tests/acceptance/features/smoke/cloudtrail/0000777454262600001440000000000013042511310024726 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/cloudtrail/cloudtrail.feature0000666454262600001440000000063413042511306030455 0ustar pysdk-ciamazon00000000000000# language: en @cloudtrail Feature: AWS CloudTrail Scenario: Making a request When I call the "DescribeTrails" API Then the response should contain a "trailList" Scenario: Handling errors When I attempt to call the "DeleteTrail" API with: | Name | faketrail | Then I expect the response error code to be "TrailNotFoundException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/dynamodbstreams/0000777454262600001440000000000013042511310025760 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/dynamodbstreams/dynamodbstreams.feature0000666454262600001440000000077113042511306032543 0ustar pysdk-ciamazon00000000000000# language: en @dynamodbstreams Feature: Amazon DynamoDB Streams Scenario: Making a request When I call the "ListStreams" API Then the value at "Streams" should be a list Scenario: Handling errors When I attempt to call the "DescribeStream" API with: | StreamArn | arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252 | Then I expect the response error code to be "ResourceNotFoundException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/kms/0000777454262600001440000000000013042511310023356 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/kms/kms.feature0000666454262600001440000000076613042511306025543 0ustar pysdk-ciamazon00000000000000# language: en @kms Feature: Amazon Key Management Service Scenario: Making a request When I call the "ListAliases" API Then the value at "Aliases" should be a list Scenario: Handling errors When I attempt to call the "GetKeyPolicy" API with: | KeyId | 12345678-1234-1234-1234-123456789012 | | PolicyName | fake-policy | Then I expect the response error code to be "NotFoundException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/emr/0000777454262600001440000000000013042511310023347 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/emr/emr.feature0000666454262600001440000000066513042511306025523 0ustar pysdk-ciamazon00000000000000# language: en @emr @client @elasticmapreduce Feature: Amazon EMR Scenario: Making a request When I call the "ListClusters" API Then the value at "Clusters" should be a list Scenario: Handling errors When I attempt to call the "DescribeCluster" API with: | ClusterId | fake_cluster | Then I expect the response error code to be "InvalidRequestException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/efs/0000777454262600001440000000000013042511310023341 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/efs/efs.feature0000666454262600001440000000066613042511306025510 0ustar pysdk-ciamazon00000000000000# language: en @efs @elasticfilesystem Feature: Amazon Elastic File System I want to use Amazon Elastic File System Scenario: Making a request When I call the "DescribeFileSystems" API Then the value at "FileSystems" should be a list Scenario: Handling errors When I attempt to call the "DeleteFileSystem" API with: | FileSystemId | fs-c5a1446c | Then I expect the response error code to "FileSystemNotFound" botocore-1.5.7/tests/acceptance/features/smoke/sts/0000777454262600001440000000000013042511310023375 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/sts/sts.feature0000666454262600001440000000070213042511306025567 0ustar pysdk-ciamazon00000000000000# language: en @sts Feature: AWS STS Scenario: Making a request When I call the "GetSessionToken" API Then the response should contain a "Credentials" Scenario: Handling errors When I attempt to call the "GetFederationToken" API with: | Name | temp | | Policy | {\"temp\":true} | Then I expect the response error code to be "MalformedPolicyDocument" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/workspaces/0000777454262600001440000000000013042511310024745 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/workspaces/workspaces.feature0000666454262600001440000000072013042511306030507 0ustar pysdk-ciamazon00000000000000# language: en @workspaces Feature: Amazon WorkSpaces I want to use Amazon WorkSpaces Scenario: Making a request When I call the "DescribeWorkspaces" API Then the value at "Workspaces" should be a list Scenario: Handling errors When I attempt to call the "DescribeWorkspaces" API with: | DirectoryId | fake-id | Then I expect the response error code to be "ValidationException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/cloudfront/0000777454262600001440000000000013042511310024743 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/cloudfront/cloudfront.feature0000666454262600001440000000071313042511306030505 0ustar pysdk-ciamazon00000000000000# language: en @cloudfront Feature: Amazon CloudFront Scenario: Making a basic request When I call the "ListDistributions" API with: | MaxItems | 1 | Then the value at "DistributionList.Items" should be a list Scenario: Error handling When I attempt to call the "GetDistribution" API with: | Id | fake-id | Then I expect the response error code to be "NoSuchDistribution" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/iam/0000777454262600001440000000000013042511310023332 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/iam/iam.feature0000666454262600001440000000062613042511306025466 0ustar pysdk-ciamazon00000000000000# language: en @iam Feature: AWS Identity and Access Management Scenario: Making a request When I call the "ListUsers" API Then the value at "Users" should be a list Scenario: Handling errors When I attempt to call the "GetUser" API with: | UserName | fake_user | Then I expect the response error code to be "NoSuchEntity" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/elastictranscoder/0000777454262600001440000000000013042511310026275 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/elastictranscoder/elastictranscoder.feature0000666454262600001440000000063713042511306033376 0ustar pysdk-ciamazon00000000000000# language: en @elastictranscoder Feature: Amazon Elastic Transcoder Scenario: Making a request When I call the "ListPresets" API Then the value at "Presets" should be a list Scenario: Handling errors When I attempt to call the "ReadJob" API with: | Id | fake_job | Then I expect the response error code to be "ValidationException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/codecommit/0000777454262600001440000000000013042511310024707 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/codecommit/codecommit.feature0000666454262600001440000000067013042511306030417 0ustar pysdk-ciamazon00000000000000# language: en @codecommit Feature: Amazon CodeCommit Scenario: Making a request When I call the "ListRepositories" API Then the value at "repositories" should be a list Scenario: Handling errors When I attempt to call the "ListBranches" API with: | repositoryName | fake-repo | Then I expect the response error code to be "RepositoryDoesNotExistException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/sqs/0000777454262600001440000000000013042511310023372 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/sqs/sqs.feature0000666454262600001440000000066513042511306025571 0ustar pysdk-ciamazon00000000000000# language: en @sqs Feature: Amazon Simple Queue Service Scenario: Making a request When I call the "ListQueues" API Then the value at "QueueUrls" should be a list Scenario: Handling errors When I attempt to call the "GetQueueUrl" API with: | QueueName | fake_queue | Then I expect the response error code to be "AWS.SimpleQueueService.NonExistentQueue" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/waf/0000777454262600001440000000000013042511310023341 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/waf/waf.feature0000666454262600001440000000075213042511306025504 0ustar pysdk-ciamazon00000000000000# language: en @waf Feature: AWS WAF Scenario: Making a request When I call the "ListRules" API with JSON: """ {"Limit":20} """ Then the value at "Rules" should be a list Scenario: Handling errors When I attempt to call the "CreateSqlInjectionMatchSet" API with: | Name | fake_name | | ChangeToken | fake_token | Then I expect the response error code to be "WAFStaleDataException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/lambda/0000777454262600001440000000000013042511310024004 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/lambda/lambda.feature0000666454262600001440000000064113042511306026607 0ustar pysdk-ciamazon00000000000000# language: en @lambda Feature: Amazon Lambda Scenario: Making a request When I call the "ListFunctions" API Then the value at "Functions" should be a list Scenario: Handling errors When I attempt to call the "Invoke" API with: | FunctionName | bogus-function | Then I expect the response error code to be "ResourceNotFoundException" And I expect the response error to contain a message botocore-1.5.7/tests/acceptance/features/smoke/cognitoidentity/0000777454262600001440000000000013042511310026000 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/acceptance/features/smoke/cognitoidentity/cognitoidentity.feature0000666454262600001440000000103513042511306032575 0ustar pysdk-ciamazon00000000000000# language: en @cognitoidentity Feature: Amazon Cognito Idenity Scenario: Making a request When I call the "ListIdentityPools" API with JSON: """ {"MaxResults": 10} """ Then the value at "IdentityPools" should be a list Scenario: Handling errors When I attempt to call the "DescribeIdentityPool" API with: | IdentityPoolId | us-east-1:aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee | Then I expect the response error code to be "ResourceNotFoundException" And I expect the response error to contain a message botocore-1.5.7/tests/cmd-runner0000666454262600001440000002037413042511306017552 0ustar pysdk-ciamazon00000000000000#!/usr/bin/env python # Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. """Driver for client scripts. How it Works ============ This script is part of the infrastructure used for resource leak tests. At a high level, we're trying to verify that specific types of operations don't leak memory. For example: * Creating 100 clients in a loop doesn't leak memory within reason * Making 100 API calls doesn't leak memory * Streaming uploads/downloads to/from S3 have O(1) memory usage. In order to do this, these tests are written to utilize two separate processes: a driver and a runner. The driver sends commands to the runner which performs the actual commands. While the runner is running commands the driver can record various attributes about the runner process. So far this is just memory usage. There's a BaseClientDriverTest test that implements the driver part of the tests. These should read like normal functional/integration tests. This script (cmd-runner) implements the runner. It listens for commands from the driver and runs the commands. The driver and runner communicate via a basic text protocol. Commands are line separated with arguments separated by spaces. Commands are sent to the runner via stdin. On success, the runner response through stdout with "OK". Here's an example:: +--------+ +-------+ | Driver | |Runner | +--------+ +-------+ create_client s3 --------------------------------------------> OK <------------------------------------------- make_aws_request 100 ec2 describe_instances --------------------------------------------> OK <------------------------------------------- stream_s3_upload bucket key /tmp/foo.txt --------------------------------------------> OK <------------------------------------------- exit --------------------------------------------> OK <------------------------------------------- """ import botocore.session import sys class CommandRunner(object): DEFAULT_REGION = 'us-west-2' def __init__(self): self._session = botocore.session.get_session() self._clients = [] self._waiters = [] self._paginators = [] def run(self): while True: line = sys.stdin.readline() parts = line.strip().split() if not parts: break elif parts[0] == 'exit': sys.stdout.write('OK\n') sys.stdout.flush() break else: getattr(self, '_do_%s' % parts[0])(parts[1:]) sys.stdout.write('OK\n') sys.stdout.flush() def _do_create_client(self, args): # The args provided by the user map directly to the args # passed to create_client. At the least you need # to provide the service name. self._clients.append(self._session.create_client(*args)) def _do_create_multiple_clients(self, args): # Args: # * num_clients - Number of clients to create in a loop # * client_args - Variable number of args to pass to create_client num_clients = args[0] client_args = args[1:] for _ in range(int(num_clients)): self._clients.append(self._session.create_client(*client_args)) def _do_free_clients(self, args): # Frees the memory associated with all clients. self._clients = [] def _do_create_waiter(self, args): # Args: # [0] client name used in its instantiation # [1] waiter name used in its instantiation client = self._create_client(args[0]) self._waiters.append(client.get_waiter(args[1])) def _do_create_multiple_waiters(self, args): # Args: # [0] num_waiters - Number of clients to create in a loop # [1] client name used in its instantiation # [2] waiter name used in its instantiation num_waiters = args[0] client = self._create_client(args[1]) for _ in range(int(num_waiters)): self._waiters.append(client.get_waiter(args[2])) def _do_free_waiters(self, args): # Frees the memory associated with all of the waiters. self._waiters = [] def _do_create_paginator(self, args): # Args: # [0] client name used in its instantiation # [1] paginator name used in its instantiation client = self._create_client(args[0]) self._paginators.append(client.get_paginator(args[1])) def _do_create_multiple_paginators(self, args): # Args: # [0] num_paginators - Number of paginators to create in a loop # [1] client name used in its instantiation # [2] paginator name used in its instantiation num_paginators = args[0] client = self._create_client(args[1]) for _ in range(int(num_paginators)): self._paginators.append(client.get_paginator(args[2])) def _do_free_paginators(self, args): # Frees the memory associated with all of the waiters. self._paginators = [] def _do_make_aws_request(self, args): # Create a client and make a number of AWS requests. # Args: # * num_requests - The number of requests to create in a loop # * service_name - The name of the AWS service # * operation_name - The name of the service, snake_cased # * oepration_args - Variable args, kwargs to pass to the API call, # in the format Kwarg1:Val1 Kwarg2:Val2 num_requests = int(args[0]) service_name = args[1] operation_name = args[2] kwargs = dict([v.split(':', 1) for v in args[3:]]) client = self._create_client(service_name) method = getattr(client, operation_name) for _ in range(num_requests): method(**kwargs) def _do_stream_s3_upload(self, args): # Stream an upload to S3 from a local file. # This does *not* create an S3 bucket. You need to create this # before running this command. You will also need to create # the local file to upload before calling this command. # Args: # * bucket - The name of the S3 bucket # * key - The name of the S3 key # * filename - The name of the local filename to upload bucket, key, local_filename = args client = self._create_client('s3') with open(local_filename, 'rb') as f: client.put_object(Bucket=bucket, Key=key, Body=f) def _do_stream_s3_download(self, args): # Stream a download to S3 from a local file. # Before calling this command you'll need to create the S3 bucket # as well as the S3 object. Also, the directory where the # file will be downloaded must already exist. # Args: # * bucket - The name of the S3 bucket # * key - The name of the S3 key # * filename - The local filename where the object will be downloaded bucket, key, local_filename = args client = self._create_client('s3') response = client.get_object(Bucket=bucket, Key=key) body_stream = response['Body'] with open(local_filename, 'wb') as f: for chunk in iter(lambda: body_stream.read(64 * 1024), b''): f.write(chunk) def _create_client(self, service_name): # Create a client using the provided service name. # It will also inject a region name of self.DEFAULT_REGION. return self._session.create_client(service_name, region_name=self.DEFAULT_REGION) def run(): CommandRunner().run() run() botocore-1.5.7/tests/functional/0000777454262600001440000000000013042511310017704 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/functional/test_client_class_names.py0000666454262600001440000000471613042511306025160 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from nose.tools import assert_equals import botocore.session REGION = 'us-east-1' SERVICE_TO_CLASS_NAME = { 'autoscaling': 'AutoScaling', 'cloudformation': 'CloudFormation', 'cloudfront': 'CloudFront', 'cloudhsm': 'CloudHSM', 'cloudsearch': 'CloudSearch', 'cloudsearchdomain': 'CloudSearchDomain', 'cloudtrail': 'CloudTrail', 'cloudwatch': 'CloudWatch', 'codedeploy': 'CodeDeploy', 'cognito-identity': 'CognitoIdentity', 'cognito-sync': 'CognitoSync', 'config': 'ConfigService', 'datapipeline': 'DataPipeline', 'directconnect': 'DirectConnect', 'ds': 'DirectoryService', 'dynamodb': 'DynamoDB', 'ec2': 'EC2', 'ecs': 'ECS', 'efs': 'EFS', 'elasticache': 'ElastiCache', 'elasticbeanstalk': 'ElasticBeanstalk', 'elastictranscoder': 'ElasticTranscoder', 'elb': 'ElasticLoadBalancing', 'emr': 'EMR', 'glacier': 'Glacier', 'iam': 'IAM', 'importexport': 'ImportExport', 'kinesis': 'Kinesis', 'kms': 'KMS', 'lambda': 'Lambda', 'logs': 'CloudWatchLogs', 'machinelearning': 'MachineLearning', 'opsworks': 'OpsWorks', 'rds': 'RDS', 'redshift': 'Redshift', 'route53': 'Route53', 'route53domains': 'Route53Domains', 's3': 'S3', 'sdb': 'SimpleDB', 'ses': 'SES', 'sns': 'SNS', 'sqs': 'SQS', 'ssm': 'SSM', 'storagegateway': 'StorageGateway', 'sts': 'STS', 'support': 'Support', 'swf': 'SWF', 'workspaces': 'WorkSpaces' } def test_client_has_correct_class_name(): session = botocore.session.get_session() for service_name in SERVICE_TO_CLASS_NAME: client = session.create_client(service_name, REGION) yield (_assert_class_name_matches_ref_class_name, client, SERVICE_TO_CLASS_NAME[service_name]) def _assert_class_name_matches_ref_class_name(client, ref_class_name): assert_equals(client.__class__.__name__, ref_class_name) botocore-1.5.7/tests/functional/test_alias.py0000666454262600001440000000525513042511306022422 0ustar pysdk-ciamazon00000000000000# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import botocore.session from botocore.stub import Stubber from botocore.exceptions import ParamValidationError ALIAS_CASES = [ { 'service': 'ec2', 'operation': 'describe_flow_logs', 'original_name': 'Filter', 'new_name': 'Filters', 'parameter_value': [{'Name': 'traffic-type', 'Values': ['ACCEPT']}] }, { 'service': 'cloudsearchdomain', 'operation': 'search', 'original_name': 'return', 'new_name': 'returnFields', 'parameter_value': '_all_fields', 'extra_args': {'query': 'foo'} }, { 'service': 'logs', 'operation': 'create_export_task', 'original_name': 'from', 'new_name': 'fromTime', 'parameter_value': 0, 'extra_args': { 'logGroupName': 'name', 'to': 10, 'destination': 'mybucket' } } ] def test_can_use_alias(): session = botocore.session.get_session() for case in ALIAS_CASES: yield _can_use_parameter_in_client_call, session, case def test_can_use_original_name(): session = botocore.session.get_session() for case in ALIAS_CASES: yield _can_use_parameter_in_client_call, session, case, False def _can_use_parameter_in_client_call(session, case, use_alias=True): client = session.create_client( case['service'], region_name='us-east-1', aws_access_key_id='foo', aws_secret_access_key='bar') stubber = Stubber(client) stubber.activate() operation = case['operation'] params = case.get('extra_args', {}) params = params.copy() param_name = case['original_name'] if use_alias: param_name = case['new_name'] params[param_name] = case['parameter_value'] stubbed_response = case.get('stubbed_response', {}) stubber.add_response(operation, stubbed_response) try: getattr(client, operation)(**params) except ParamValidationError as e: raise AssertionError( 'Expecting %s to be valid parameter for %s.%s but received ' '%s.' % ( case['new_name'], case['service'], case['operation'], e) ) botocore-1.5.7/tests/functional/leak/0000777454262600001440000000000013042511310020620 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/functional/leak/test_resource_leaks.py0000666454262600001440000001262113042511306025246 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import BaseClientDriverTest class TestDoesNotLeakMemory(BaseClientDriverTest): # The user doesn't need to have credentials configured # in order to run the functional tests for resource leaks. # If we don't set this value and a user doesn't have creds # configured, each create_client() call will have to go through # the EC2 Instance Metadata provider's timeout, which can add # a substantial amount of time to the total test run time. INJECT_DUMMY_CREDS = True # We're making up numbers here, but let's say arbitrarily # that the memory can't increase by more than 10MB. MAX_GROWTH_BYTES = 10 * 1024 * 1024 def test_create_single_client_memory_constant(self): self.cmd('create_client', 's3') self.cmd('free_clients') self.record_memory() for _ in range(100): self.cmd('create_client', 's3') self.cmd('free_clients') self.record_memory() start, end = self.memory_samples self.assertTrue((end - start) < self.MAX_GROWTH_BYTES, (end - start)) def test_create_memory_clients_in_loop(self): # We need to first create clients and free then before # recording our memory samples. This is because of two reasons: # 1. Caching. Some of the botocore internals will cache data, so # the first client created will consume more memory than subsequent # clients. We're interested in growing memory, not total # memory usage (for now), so we we care about the memory in the # steady state case. # 2. Python memory allocation. Due to how python allocates memory # via it's small object allocator, arena's aren't freed until the # entire 256kb isn't in use. If a single allocation in a single # pool in a single arena is still in use, the arena is not # freed. This case is easy to hit, and pretty much any # fragmentation guarantees this case is hit. The best we can # do is verify that memory that's released back to python's # allocator (but not to the OS) is at least reused in subsequent # requests to create botocore clients. self.cmd('create_multiple_clients', '200', 's3') self.cmd('free_clients') self.record_memory() # 500 clients in batches of 50. for _ in range(10): self.cmd('create_multiple_clients', '50', 's3') self.cmd('free_clients') self.record_memory() start, end = self.memory_samples self.assertTrue((end - start) < self.MAX_GROWTH_BYTES, (end - start)) def test_create_single_waiter_memory_constant(self): self.cmd('create_waiter', 's3', 'bucket_exists') self.cmd('free_waiters') self.record_memory() for _ in range(100): self.cmd('create_waiter', 's3', 'bucket_exists') self.cmd('free_waiters') self.record_memory() start, end = self.memory_samples self.assertTrue((end - start) < self.MAX_GROWTH_BYTES, (end - start)) def test_create_memory_waiters_in_loop(self): # See ``test_create_memory_clients_in_loop`` to understand why # waiters are first initialized and then freed. Same reason applies. self.cmd('create_multiple_waiters', '200', 's3', 'bucket_exists') self.cmd('free_waiters') self.record_memory() # 500 waiters in batches of 50. for _ in range(10): self.cmd( 'create_multiple_waiters', '50', 's3', 'bucket_exists') self.cmd('free_waiters') self.record_memory() start, end = self.memory_samples self.assertTrue((end - start) < self.MAX_GROWTH_BYTES, (end - start)) def test_create_single_paginator_memory_constant(self): self.cmd('create_paginator', 's3', 'list_objects') self.cmd('free_paginators') self.record_memory() for _ in range(100): self.cmd('create_paginator', 's3', 'list_objects') self.cmd('free_paginators') self.record_memory() start, end = self.memory_samples self.assertTrue((end - start) < self.MAX_GROWTH_BYTES, (end - start)) def test_create_memory_paginators_in_loop(self): # See ``test_create_memory_clients_in_loop`` to understand why # paginators are first initialized and then freed. Same reason applies. self.cmd('create_multiple_paginators', '200', 's3', 'list_objects') self.cmd('free_paginators') self.record_memory() # 500 waiters in batches of 50. for _ in range(10): self.cmd( 'create_multiple_paginators', '50', 's3', 'list_objects') self.cmd('free_paginators') self.record_memory() start, end = self.memory_samples self.assertTrue((end - start) < self.MAX_GROWTH_BYTES, (end - start)) botocore-1.5.7/tests/functional/leak/__init__.py0000666454262600001440000000106113042511306022734 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. botocore-1.5.7/tests/functional/docs/0000777454262600001440000000000013042511310020634 5ustar pysdk-ciamazon00000000000000botocore-1.5.7/tests/functional/docs/test_alias.py0000666454262600001440000000325113042511306023344 0ustar pysdk-ciamazon00000000000000# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests.functional.docs import BaseDocsFunctionalTest from tests.functional.test_alias import ALIAS_CASES class TestAliasesDocumented(BaseDocsFunctionalTest): def test_all_aliases_are_documented_correctly(self): for case in ALIAS_CASES: content = self.get_docstring_for_method( case['service'], case['operation']).decode('utf-8') new_name = case['new_name'] original_name = case['original_name'] param_name_template = ':param %s:' param_type_template = ':type %s:' param_example_template = '%s=' # Make sure the new parameters are in the documentation # but the old names are not. self.assertIn(param_name_template % new_name, content) self.assertIn(param_type_template % new_name, content) self.assertIn(param_example_template % new_name, content) self.assertNotIn(param_name_template % original_name, content) self.assertNotIn(param_type_template % original_name, content) self.assertNotIn(param_example_template % original_name, content) botocore-1.5.7/tests/functional/docs/test_streaming_body.py0000666454262600001440000000333413042511306025263 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from botocore import xform_name from tests.functional.docs import BaseDocsFunctionalTest from botocore.docs.service import ServiceDocumenter class TestStreamingBodyDocumentation(BaseDocsFunctionalTest): def test_all_streaming_body_are_properly_documented(self): for service in self._session.get_available_services(): client = self._session.create_client( service, region_name='us-east-1', aws_access_key_id='foo', aws_secret_access_key='bar') service_model = client.meta.service_model for operation in service_model.operation_names: operation_model = service_model.operation_model(operation) if operation_model.has_streaming_output: self.assert_streaming_body_is_properly_documented( service, xform_name(operation)) def assert_streaming_body_is_properly_documented(self, service, operation): service_docs = ServiceDocumenter( service, self._session).document_service() method_docs = self.get_method_document_block(operation, service_docs) self.assert_contains_line('StreamingBody', method_docs) botocore-1.5.7/tests/functional/docs/test_glacier.py0000666454262600001440000000216413042511306023663 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests.functional.docs import BaseDocsFunctionalTest class TestGlacierDocs(BaseDocsFunctionalTest): def test_account_id(self): self.assert_is_documented_as_autopopulated_param( service_name='glacier', method_name='abort_multipart_upload', param_name='accountId', doc_string='Note: this parameter is set to "-"') def test_checksum(self): self.assert_is_documented_as_autopopulated_param( service_name='glacier', method_name='upload_archive', param_name='checksum') botocore-1.5.7/tests/functional/docs/test_s3.py0000666454262600001440000000546713042511306022613 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests.functional.docs import BaseDocsFunctionalTest from botocore.docs.service import ServiceDocumenter class TestS3Docs(BaseDocsFunctionalTest): def test_auto_populates_sse_customer_key_md5(self): self.assert_is_documented_as_autopopulated_param( service_name='s3', method_name='put_object', param_name='SSECustomerKeyMD5') def test_auto_populates_copy_source_sse_customer_key_md5(self): self.assert_is_documented_as_autopopulated_param( service_name='s3', method_name='copy_object', param_name='CopySourceSSECustomerKeyMD5') def test_hides_content_md5_when_impossible_to_provide(self): modified_methods = ['delete_objects', 'put_bucket_acl', 'put_bucket_cors', 'put_bucket_lifecycle', 'put_bucket_logging', 'put_bucket_policy', 'put_bucket_notification', 'put_bucket_tagging', 'put_bucket_replication', 'put_bucket_website', 'put_bucket_request_payment', 'put_object_acl', 'put_bucket_versioning'] service_contents = ServiceDocumenter( 's3', self._session).document_service() for method_name in modified_methods: method_contents = self.get_method_document_block( method_name, service_contents) self.assertNotIn('ContentMD5=\'string\'', method_contents.decode('utf-8')) def test_copy_source_documented_as_union_type(self): content = self.get_docstring_for_method('s3', 'copy_object') dict_form = ( "{'Bucket': 'string', 'Key': 'string', 'VersionId': 'string'}") self.assert_contains_line( "CopySource='string' or %s" % dict_form, content) def test_copy_source_param_docs_also_modified(self): content = self.get_docstring_for_method('s3', 'copy_object') param_docs = self.get_parameter_document_block('CopySource', content) # We don't want to overspecify the test, so I've picked # an arbitrary line from the customized docs. self.assert_contains_line( "You can also provide this value as a dictionary", param_docs) botocore-1.5.7/tests/functional/docs/test_ec2.py0000666454262600001440000000326513042511306022731 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests.functional.docs import BaseDocsFunctionalTest class TestEc2Docs(BaseDocsFunctionalTest): def test_documents_encoding_of_user_data(self): docs = self.get_parameter_documentation_from_service( 'ec2', 'run_instances', 'UserData') self.assertIn('base64 encoded automatically', docs.decode('utf-8')) def test_copy_snapshot_presigned_url_is_autopopulated(self): self.assert_is_documented_as_autopopulated_param( service_name='ec2', method_name='copy_snapshot', param_name='PresignedUrl') def test_copy_snapshot_destination_region_is_autopopulated(self): self.assert_is_documented_as_autopopulated_param( service_name='ec2', method_name='copy_snapshot', param_name='DestinationRegion') def test_idempotency_documented(self): content = self.get_docstring_for_method('ec2', 'purchase_scheduled_instances') # Client token should have had idempotentcy autopopulated doc appended self.assert_contains_line('This field is autopopulated if not provided', content) botocore-1.5.7/tests/functional/docs/test_autoscaling.py0000666454262600001440000000164313042511306024567 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests.functional.docs import BaseDocsFunctionalTest class TestAutoscalingDocs(BaseDocsFunctionalTest): def test_documents_encoding_of_user_data(self): docs = self.get_parameter_documentation_from_service( 'autoscaling', 'create_launch_configuration', 'UserData') self.assertIn('base64 encoded automatically', docs.decode('utf-8')) botocore-1.5.7/tests/functional/docs/__init__.py0000666454262600001440000001017113042511306022752 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest from botocore.session import get_session from botocore.docs.service import ServiceDocumenter class BaseDocsFunctionalTest(unittest.TestCase): def setUp(self): self._session = get_session() def assert_contains_line(self, line, contents): contents = contents.decode('utf-8') self.assertIn(line, contents) def assert_contains_lines_in_order(self, lines, contents): contents = contents.decode('utf-8') for line in lines: self.assertIn(line, contents) beginning = contents.find(line) contents = contents[(beginning + len(line)):] def assert_not_contains_line(self, line, contents): contents = contents.decode('utf-8') self.assertNotIn(line, contents) def assert_not_contains_lines(self, lines, contents): contents = contents.decode('utf-8') for line in lines: self.assertNotIn(line, contents) def get_method_document_block(self, operation_name, contents): contents = contents.decode('utf-8') start_method_document = ' .. py:method:: %s(' % operation_name start_index = contents.find(start_method_document) self.assertNotEqual(start_index, -1, 'Method is not found in contents') contents = contents[start_index:] end_index = contents.find( ' .. py:method::', len(start_method_document)) contents = contents[:end_index] return contents.encode('utf-8') def get_parameter_document_block(self, param_name, contents): contents = contents.decode('utf-8') start_param_document = ' :type %s:' % param_name start_index = contents.find(start_param_document) self.assertNotEqual(start_index, -1, 'Param is not found in contents') contents = contents[start_index:] end_index = contents.find(' :type', len(start_param_document)) contents = contents[:end_index] return contents.encode('utf-8') def get_parameter_documentation_from_service( self, service_name, method_name, param_name): contents = ServiceDocumenter( service_name, self._session).document_service() method_contents = self.get_method_document_block( method_name, contents) return self.get_parameter_document_block( param_name, method_contents) def get_docstring_for_method(self, service_name, method_name): contents = ServiceDocumenter( service_name, self._session).document_service() method_contents = self.get_method_document_block( method_name, contents) return method_contents def assert_is_documented_as_autopopulated_param( self, service_name, method_name, param_name, doc_string=None): contents = ServiceDocumenter( service_name, self._session).document_service() method_contents = self.get_method_document_block( method_name, contents) # Ensure it is not in the example. self.assert_not_contains_line('%s=\'string\'' % param_name, method_contents) # Ensure it is in the params. param_contents = self.get_parameter_document_block( param_name, method_contents) # Ensure it is not labeled as required. self.assert_not_contains_line('REQUIRED', param_contents) # Ensure the note about autopopulation was added. if doc_string is None: doc_string = 'Please note that this parameter is automatically' self.assert_contains_line(doc_string, param_contents) botocore-1.5.7/tests/functional/test_paginator_config.py0000666454262600001440000001445313042511306024642 0ustar pysdk-ciamazon00000000000000# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import string import jmespath from jmespath.exceptions import JMESPathError import botocore.session KNOWN_PAGE_KEYS = set( ['input_token', 'py_input_token', 'output_token', 'result_key', 'limit_key', 'more_results', 'non_aggregate_keys']) MEMBER_NAME_CHARS = set(string.ascii_letters + string.digits) def test_lint_pagination_configs(): session = botocore.session.get_session() loader = session.get_component('data_loader') services = loader.list_available_services('paginators-1') for service_name in services: service_model = session.get_service_model(service_name) page_config = loader.load_service_model(service_name, 'paginators-1', service_model.api_version) for op_name, single_config in page_config['pagination'].items(): yield ( _lint_single_paginator, op_name, single_config, service_model ) def _lint_single_paginator(operation_name, page_config, service_model): _validate_known_pagination_keys(page_config) _valiate_result_key_exists(page_config) _validate_referenced_operation_exists(operation_name, service_model) _validate_operation_has_output(operation_name, service_model) _validate_input_keys_match(operation_name, page_config, service_model) _validate_output_keys_match(operation_name, page_config, service_model) def _validate_known_pagination_keys(page_config): for key in page_config: if key not in KNOWN_PAGE_KEYS: raise AssertionError("Unknown key '%s' in pagination config: %s" % (key, page_config)) def _valiate_result_key_exists(page_config): if 'result_key' not in page_config: raise AssertionError("Required key 'result_key' is missing " "from pagination config: %s" % page_config) def _validate_referenced_operation_exists(operation_name, service_model): if operation_name not in service_model.operation_names: raise AssertionError("Pagination config refers to operation that " "does not exist: %s" % operation_name) def _validate_operation_has_output(operation_name, service_model): op_model = service_model.operation_model(operation_name) output = op_model.output_shape if output is None or not output.members: raise AssertionError("Pagination config refers to operation " "that does not have any output: %s" % operation_name) def _validate_input_keys_match(operation_name, page_config, service_model): input_tokens = page_config['input_token'] if not isinstance(input_tokens, list): input_tokens = [input_tokens] valid_input_names = service_model.operation_model( operation_name).input_shape.members for token in input_tokens: if token not in valid_input_names: raise AssertionError("input_token '%s' refers to a non existent " "input member for operation: %s" % (token, operation_name)) if 'limit_key' in page_config: limit_key = page_config['limit_key'] if limit_key not in valid_input_names: raise AssertionError("limit_key '%s' refers to a non existent " "input member for operation: %s" % (limit_key, operation_name)) def _validate_output_keys_match(operation_name, page_config, service_model): # NOTE: The original version of this function from translate.py had logic # to ensure that the entire set of output_members was accounted for in the # union of 'result_key', 'output_token', 'more_results', and # 'non_aggregate_keys'. # There's enough state drift (especially with non_aggregate_keys) that # this is no longer a realistic thing to check. Someone would have to # backport the missing keys to all the paginators. output_shape = service_model.operation_model(operation_name).output_shape output_members = output_shape.members for key_name, output_key in _get_all_page_output_keys(page_config): if _looks_like_jmespath(output_key): _validate_jmespath_compiles(output_key) else: if output_key not in output_members: raise AssertionError("Pagination key '%s' refers to an output " "member that does not exist: %s" % ( key_name, output_key)) def _looks_like_jmespath(expression): if all(ch in MEMBER_NAME_CHARS for ch in expression): return False return True def _validate_jmespath_compiles(expression): try: jmespath.compile(expression) except JMESPathError as e: raise AssertionError("Invalid JMESPath expression used " "in pagination config: %s\nerror: %s" % (expression, e)) def _get_all_page_output_keys(page_config): for key in _get_list_value(page_config, 'result_key'): yield 'result_key', key for key in _get_list_value(page_config, 'output_token'): yield 'output_token', key if 'more_results' in page_config: yield 'more_results', page_config['more_results'] for key in page_config.get('non_aggregate_keys', []): yield 'non_aggregate_keys', key def _get_list_value(page_config, key): # Some pagination config values can be a scalar value or a list of scalars. # This function will always return a list of scalar values, converting as # necessary. value = page_config[key] if not isinstance(value, list): value = [value] return value botocore-1.5.7/tests/functional/test_regions.py0000666454262600001440000006264713042511306023007 0ustar pysdk-ciamazon00000000000000# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest, create_session import mock from nose.tools import assert_equals, assert_raises from botocore import regions from botocore.client import ClientEndpointBridge from botocore.exceptions import NoRegionError # NOTE: sqs endpoint updated to be the CN in the SSL cert because # a bug in python2.6 prevents subjectAltNames from being parsed # and subsequently being used in cert validation. # Same thing is needed for rds. KNOWN_REGIONS = { 'ap-northeast-1': { 'apigateway': 'apigateway.ap-northeast-1.amazonaws.com', 'appstream': 'appstream.ap-northeast-1.amazonaws.com', 'autoscaling': 'autoscaling.ap-northeast-1.amazonaws.com', 'cloudformation': 'cloudformation.ap-northeast-1.amazonaws.com', 'cloudhsm': 'cloudhsm.ap-northeast-1.amazonaws.com', 'cloudsearch': 'cloudsearch.ap-northeast-1.amazonaws.com', 'cloudtrail': 'cloudtrail.ap-northeast-1.amazonaws.com', 'codedeploy': 'codedeploy.ap-northeast-1.amazonaws.com', 'cognito-identity': 'cognito-identity.ap-northeast-1.amazonaws.com', 'cognito-sync': 'cognito-sync.ap-northeast-1.amazonaws.com', 'config': 'config.ap-northeast-1.amazonaws.com', 'datapipeline': 'datapipeline.ap-northeast-1.amazonaws.com', 'directconnect': 'directconnect.ap-northeast-1.amazonaws.com', 'ds': 'ds.ap-northeast-1.amazonaws.com', 'dynamodb': 'dynamodb.ap-northeast-1.amazonaws.com', 'ec2': 'ec2.ap-northeast-1.amazonaws.com', 'ecs': 'ecs.ap-northeast-1.amazonaws.com', 'elasticache': 'elasticache.ap-northeast-1.amazonaws.com', 'elasticbeanstalk': 'elasticbeanstalk.ap-northeast-1.amazonaws.com', 'elasticloadbalancing': 'elasticloadbalancing.ap-northeast-1.amazonaws.com', 'elasticmapreduce': 'ap-northeast-1.elasticmapreduce.amazonaws.com', 'elastictranscoder': 'elastictranscoder.ap-northeast-1.amazonaws.com', 'glacier': 'glacier.ap-northeast-1.amazonaws.com', 'iot': 'iot.ap-northeast-1.amazonaws.com', 'kinesis': 'kinesis.ap-northeast-1.amazonaws.com', 'kms': 'kms.ap-northeast-1.amazonaws.com', 'lambda': 'lambda.ap-northeast-1.amazonaws.com', 'logs': 'logs.ap-northeast-1.amazonaws.com', 'monitoring': 'monitoring.ap-northeast-1.amazonaws.com', 'rds': 'rds.ap-northeast-1.amazonaws.com', 'redshift': 'redshift.ap-northeast-1.amazonaws.com', 's3': 's3-ap-northeast-1.amazonaws.com', 'sdb': 'sdb.ap-northeast-1.amazonaws.com', 'sns': 'sns.ap-northeast-1.amazonaws.com', 'sqs': 'ap-northeast-1.queue.amazonaws.com', 'storagegateway': 'storagegateway.ap-northeast-1.amazonaws.com', 'streams.dynamodb': 'streams.dynamodb.ap-northeast-1.amazonaws.com', 'sts': 'sts.amazonaws.com', 'swf': 'swf.ap-northeast-1.amazonaws.com', 'workspaces': 'workspaces.ap-northeast-1.amazonaws.com' }, 'ap-southeast-1': { 'autoscaling': 'autoscaling.ap-southeast-1.amazonaws.com', 'cloudformation': 'cloudformation.ap-southeast-1.amazonaws.com', 'cloudhsm': 'cloudhsm.ap-southeast-1.amazonaws.com', 'cloudsearch': 'cloudsearch.ap-southeast-1.amazonaws.com', 'cloudtrail': 'cloudtrail.ap-southeast-1.amazonaws.com', 'config': 'config.ap-southeast-1.amazonaws.com', 'directconnect': 'directconnect.ap-southeast-1.amazonaws.com', 'ds': 'ds.ap-southeast-1.amazonaws.com', 'dynamodb': 'dynamodb.ap-southeast-1.amazonaws.com', 'ec2': 'ec2.ap-southeast-1.amazonaws.com', 'elasticache': 'elasticache.ap-southeast-1.amazonaws.com', 'elasticbeanstalk': 'elasticbeanstalk.ap-southeast-1.amazonaws.com', 'elasticloadbalancing': 'elasticloadbalancing.ap-southeast-1.amazonaws.com', 'elasticmapreduce': 'ap-southeast-1.elasticmapreduce.amazonaws.com', 'elastictranscoder': 'elastictranscoder.ap-southeast-1.amazonaws.com', 'kinesis': 'kinesis.ap-southeast-1.amazonaws.com', 'kms': 'kms.ap-southeast-1.amazonaws.com', 'logs': 'logs.ap-southeast-1.amazonaws.com', 'monitoring': 'monitoring.ap-southeast-1.amazonaws.com', 'rds': 'rds.ap-southeast-1.amazonaws.com', 'redshift': 'redshift.ap-southeast-1.amazonaws.com', 's3': 's3-ap-southeast-1.amazonaws.com', 'sdb': 'sdb.ap-southeast-1.amazonaws.com', 'sns': 'sns.ap-southeast-1.amazonaws.com', 'sqs': 'ap-southeast-1.queue.amazonaws.com', 'storagegateway': 'storagegateway.ap-southeast-1.amazonaws.com', 'streams.dynamodb': 'streams.dynamodb.ap-southeast-1.amazonaws.com', 'sts': 'sts.amazonaws.com', 'swf': 'swf.ap-southeast-1.amazonaws.com', 'workspaces': 'workspaces.ap-southeast-1.amazonaws.com' }, 'ap-southeast-2': { 'autoscaling': 'autoscaling.ap-southeast-2.amazonaws.com', 'cloudformation': 'cloudformation.ap-southeast-2.amazonaws.com', 'cloudhsm': 'cloudhsm.ap-southeast-2.amazonaws.com', 'cloudsearch': 'cloudsearch.ap-southeast-2.amazonaws.com', 'cloudtrail': 'cloudtrail.ap-southeast-2.amazonaws.com', 'codedeploy': 'codedeploy.ap-southeast-2.amazonaws.com', 'config': 'config.ap-southeast-2.amazonaws.com', 'datapipeline': 'datapipeline.ap-southeast-2.amazonaws.com', 'directconnect': 'directconnect.ap-southeast-2.amazonaws.com', 'ds': 'ds.ap-southeast-2.amazonaws.com', 'dynamodb': 'dynamodb.ap-southeast-2.amazonaws.com', 'ec2': 'ec2.ap-southeast-2.amazonaws.com', 'ecs': 'ecs.ap-southeast-2.amazonaws.com', 'elasticache': 'elasticache.ap-southeast-2.amazonaws.com', 'elasticbeanstalk': 'elasticbeanstalk.ap-southeast-2.amazonaws.com', 'elasticloadbalancing': 'elasticloadbalancing.ap-southeast-2.amazonaws.com', 'elasticmapreduce': 'ap-southeast-2.elasticmapreduce.amazonaws.com', 'glacier': 'glacier.ap-southeast-2.amazonaws.com', 'kinesis': 'kinesis.ap-southeast-2.amazonaws.com', 'kms': 'kms.ap-southeast-2.amazonaws.com', 'logs': 'logs.ap-southeast-2.amazonaws.com', 'monitoring': 'monitoring.ap-southeast-2.amazonaws.com', 'rds': 'rds.ap-southeast-2.amazonaws.com', 'redshift': 'redshift.ap-southeast-2.amazonaws.com', 's3': 's3-ap-southeast-2.amazonaws.com', 'sdb': 'sdb.ap-southeast-2.amazonaws.com', 'sns': 'sns.ap-southeast-2.amazonaws.com', 'sqs': 'ap-southeast-2.queue.amazonaws.com', 'storagegateway': 'storagegateway.ap-southeast-2.amazonaws.com', 'streams.dynamodb': 'streams.dynamodb.ap-southeast-2.amazonaws.com', 'sts': 'sts.amazonaws.com', 'swf': 'swf.ap-southeast-2.amazonaws.com', 'workspaces': 'workspaces.ap-southeast-2.amazonaws.com' }, 'aws-us-gov-global': { 'iam': 'iam.us-gov.amazonaws.com' }, 'cn-north-1': { 'autoscaling': 'autoscaling.cn-north-1.amazonaws.com.cn', 'cloudformation': 'cloudformation.cn-north-1.amazonaws.com.cn', 'cloudtrail': 'cloudtrail.cn-north-1.amazonaws.com.cn', 'directconnect': 'directconnect.cn-north-1.amazonaws.com.cn', 'dynamodb': 'dynamodb.cn-north-1.amazonaws.com.cn', 'ec2': 'ec2.cn-north-1.amazonaws.com.cn', 'elasticache': 'elasticache.cn-north-1.amazonaws.com.cn', 'elasticbeanstalk': 'elasticbeanstalk.cn-north-1.amazonaws.com.cn', 'elasticloadbalancing': 'elasticloadbalancing.cn-north-1.amazonaws.com.cn', 'elasticmapreduce': 'elasticmapreduce.cn-north-1.amazonaws.com.cn', 'glacier': 'glacier.cn-north-1.amazonaws.com.cn', 'iam': 'iam.cn-north-1.amazonaws.com.cn', 'kinesis': 'kinesis.cn-north-1.amazonaws.com.cn', 'monitoring': 'monitoring.cn-north-1.amazonaws.com.cn', 'rds': 'rds.cn-north-1.amazonaws.com.cn', 's3': 's3.cn-north-1.amazonaws.com.cn', 'sns': 'sns.cn-north-1.amazonaws.com.cn', 'sqs': 'cn-north-1.queue.amazonaws.com.cn', 'storagegateway': 'storagegateway.cn-north-1.amazonaws.com.cn', 'streams.dynamodb': 'streams.dynamodb.cn-north-1.amazonaws.com.cn', 'sts': 'sts.cn-north-1.amazonaws.com.cn', 'swf': 'swf.cn-north-1.amazonaws.com.cn' }, 'eu-central-1': { 'autoscaling': 'autoscaling.eu-central-1.amazonaws.com', 'cloudformation': 'cloudformation.eu-central-1.amazonaws.com', 'cloudhsm': 'cloudhsm.eu-central-1.amazonaws.com', 'cloudsearch': 'cloudsearch.eu-central-1.amazonaws.com', 'cloudtrail': 'cloudtrail.eu-central-1.amazonaws.com', 'codedeploy': 'codedeploy.eu-central-1.amazonaws.com', 'config': 'config.eu-central-1.amazonaws.com', 'directconnect': 'directconnect.eu-central-1.amazonaws.com', 'dynamodb': 'dynamodb.eu-central-1.amazonaws.com', 'ec2': 'ec2.eu-central-1.amazonaws.com', 'elasticache': 'elasticache.eu-central-1.amazonaws.com', 'elasticbeanstalk': 'elasticbeanstalk.eu-central-1.amazonaws.com', 'elasticloadbalancing': 'elasticloadbalancing.eu-central-1.amazonaws.com', 'elasticmapreduce': 'elasticmapreduce.eu-central-1.amazonaws.com', 'glacier': 'glacier.eu-central-1.amazonaws.com', 'kinesis': 'kinesis.eu-central-1.amazonaws.com', 'kms': 'kms.eu-central-1.amazonaws.com', 'logs': 'logs.eu-central-1.amazonaws.com', 'monitoring': 'monitoring.eu-central-1.amazonaws.com', 'rds': 'rds.eu-central-1.amazonaws.com', 'redshift': 'redshift.eu-central-1.amazonaws.com', 's3': 's3.eu-central-1.amazonaws.com', 'sns': 'sns.eu-central-1.amazonaws.com', 'sqs': 'eu-central-1.queue.amazonaws.com', 'storagegateway': 'storagegateway.eu-central-1.amazonaws.com', 'streams.dynamodb': 'streams.dynamodb.eu-central-1.amazonaws.com', 'sts': 'sts.amazonaws.com', 'swf': 'swf.eu-central-1.amazonaws.com' }, 'eu-west-1': { 'apigateway': 'apigateway.eu-west-1.amazonaws.com', 'autoscaling': 'autoscaling.eu-west-1.amazonaws.com', 'cloudformation': 'cloudformation.eu-west-1.amazonaws.com', 'cloudhsm': 'cloudhsm.eu-west-1.amazonaws.com', 'cloudsearch': 'cloudsearch.eu-west-1.amazonaws.com', 'cloudtrail': 'cloudtrail.eu-west-1.amazonaws.com', 'codedeploy': 'codedeploy.eu-west-1.amazonaws.com', 'cognito-identity': 'cognito-identity.eu-west-1.amazonaws.com', 'cognito-sync': 'cognito-sync.eu-west-1.amazonaws.com', 'config': 'config.eu-west-1.amazonaws.com', 'datapipeline': 'datapipeline.eu-west-1.amazonaws.com', 'directconnect': 'directconnect.eu-west-1.amazonaws.com', 'ds': 'ds.eu-west-1.amazonaws.com', 'dynamodb': 'dynamodb.eu-west-1.amazonaws.com', 'ec2': 'ec2.eu-west-1.amazonaws.com', 'ecs': 'ecs.eu-west-1.amazonaws.com', 'elasticache': 'elasticache.eu-west-1.amazonaws.com', 'elasticbeanstalk': 'elasticbeanstalk.eu-west-1.amazonaws.com', 'elasticloadbalancing': 'elasticloadbalancing.eu-west-1.amazonaws.com', 'elasticmapreduce': 'eu-west-1.elasticmapreduce.amazonaws.com', 'elastictranscoder': 'elastictranscoder.eu-west-1.amazonaws.com', 'email': 'email.eu-west-1.amazonaws.com', 'glacier': 'glacier.eu-west-1.amazonaws.com', 'iot': 'iot.eu-west-1.amazonaws.com', 'kinesis': 'kinesis.eu-west-1.amazonaws.com', 'kms': 'kms.eu-west-1.amazonaws.com', 'lambda': 'lambda.eu-west-1.amazonaws.com', 'logs': 'logs.eu-west-1.amazonaws.com', 'machinelearning': 'machinelearning.eu-west-1.amazonaws.com', 'monitoring': 'monitoring.eu-west-1.amazonaws.com', 'rds': 'rds.eu-west-1.amazonaws.com', 'redshift': 'redshift.eu-west-1.amazonaws.com', 's3': 's3-eu-west-1.amazonaws.com', 'sdb': 'sdb.eu-west-1.amazonaws.com', 'sns': 'sns.eu-west-1.amazonaws.com', 'sqs': 'eu-west-1.queue.amazonaws.com', 'ssm': 'ssm.eu-west-1.amazonaws.com', 'storagegateway': 'storagegateway.eu-west-1.amazonaws.com', 'streams.dynamodb': 'streams.dynamodb.eu-west-1.amazonaws.com', 'sts': 'sts.amazonaws.com', 'swf': 'swf.eu-west-1.amazonaws.com', 'workspaces': 'workspaces.eu-west-1.amazonaws.com' }, 'fips-us-gov-west-1': { 's3': 's3-fips-us-gov-west-1.amazonaws.com' }, 'local': { 'dynamodb': 'localhost:8000' }, 's3-external-1': { 's3': 's3-external-1.amazonaws.com' }, 'sa-east-1': { 'autoscaling': 'autoscaling.sa-east-1.amazonaws.com', 'cloudformation': 'cloudformation.sa-east-1.amazonaws.com', 'cloudsearch': 'cloudsearch.sa-east-1.amazonaws.com', 'cloudtrail': 'cloudtrail.sa-east-1.amazonaws.com', 'config': 'config.sa-east-1.amazonaws.com', 'directconnect': 'directconnect.sa-east-1.amazonaws.com', 'dynamodb': 'dynamodb.sa-east-1.amazonaws.com', 'ec2': 'ec2.sa-east-1.amazonaws.com', 'elasticache': 'elasticache.sa-east-1.amazonaws.com', 'elasticbeanstalk': 'elasticbeanstalk.sa-east-1.amazonaws.com', 'elasticloadbalancing': 'elasticloadbalancing.sa-east-1.amazonaws.com', 'elasticmapreduce': 'sa-east-1.elasticmapreduce.amazonaws.com', 'kms': 'kms.sa-east-1.amazonaws.com', 'monitoring': 'monitoring.sa-east-1.amazonaws.com', 'rds': 'rds.sa-east-1.amazonaws.com', 's3': 's3-sa-east-1.amazonaws.com', 'sdb': 'sdb.sa-east-1.amazonaws.com', 'sns': 'sns.sa-east-1.amazonaws.com', 'sqs': 'sa-east-1.queue.amazonaws.com', 'storagegateway': 'storagegateway.sa-east-1.amazonaws.com', 'streams.dynamodb': 'streams.dynamodb.sa-east-1.amazonaws.com', 'sts': 'sts.amazonaws.com', 'swf': 'swf.sa-east-1.amazonaws.com' }, 'us-east-1': { 'apigateway': 'apigateway.us-east-1.amazonaws.com', 'appstream': 'appstream.us-east-1.amazonaws.com', 'autoscaling': 'autoscaling.us-east-1.amazonaws.com', 'cloudformation': 'cloudformation.us-east-1.amazonaws.com', 'cloudfront': 'cloudfront.amazonaws.com', 'cloudhsm': 'cloudhsm.us-east-1.amazonaws.com', 'cloudsearch': 'cloudsearch.us-east-1.amazonaws.com', 'cloudtrail': 'cloudtrail.us-east-1.amazonaws.com', 'codecommit': 'codecommit.us-east-1.amazonaws.com', 'codedeploy': 'codedeploy.us-east-1.amazonaws.com', 'codepipeline': 'codepipeline.us-east-1.amazonaws.com', 'cognito-identity': 'cognito-identity.us-east-1.amazonaws.com', 'cognito-sync': 'cognito-sync.us-east-1.amazonaws.com', 'config': 'config.us-east-1.amazonaws.com', 'datapipeline': 'datapipeline.us-east-1.amazonaws.com', 'directconnect': 'directconnect.us-east-1.amazonaws.com', 'ds': 'ds.us-east-1.amazonaws.com', 'dynamodb': 'dynamodb.us-east-1.amazonaws.com', 'ec2': 'ec2.us-east-1.amazonaws.com', 'ecs': 'ecs.us-east-1.amazonaws.com', 'elasticache': 'elasticache.us-east-1.amazonaws.com', 'elasticbeanstalk': 'elasticbeanstalk.us-east-1.amazonaws.com', 'elasticloadbalancing': 'elasticloadbalancing.us-east-1.amazonaws.com', 'elasticmapreduce': 'elasticmapreduce.us-east-1.amazonaws.com', 'elastictranscoder': 'elastictranscoder.us-east-1.amazonaws.com', 'email': 'email.us-east-1.amazonaws.com', 'glacier': 'glacier.us-east-1.amazonaws.com', 'iam': 'iam.amazonaws.com', 'importexport': 'importexport.amazonaws.com', 'iot': 'iot.us-east-1.amazonaws.com', 'kinesis': 'kinesis.us-east-1.amazonaws.com', 'kms': 'kms.us-east-1.amazonaws.com', 'lambda': 'lambda.us-east-1.amazonaws.com', 'logs': 'logs.us-east-1.amazonaws.com', 'machinelearning': 'machinelearning.us-east-1.amazonaws.com', 'mobileanalytics': 'mobileanalytics.us-east-1.amazonaws.com', 'monitoring': 'monitoring.us-east-1.amazonaws.com', 'opsworks': 'opsworks.us-east-1.amazonaws.com', 'rds': 'rds.amazonaws.com', 'redshift': 'redshift.us-east-1.amazonaws.com', 'route53': 'route53.amazonaws.com', 'route53domains': 'route53domains.us-east-1.amazonaws.com', 's3': 's3.amazonaws.com', 'sdb': 'sdb.amazonaws.com', 'sns': 'sns.us-east-1.amazonaws.com', 'sqs': 'queue.amazonaws.com', 'ssm': 'ssm.us-east-1.amazonaws.com', 'storagegateway': 'storagegateway.us-east-1.amazonaws.com', 'streams.dynamodb': 'streams.dynamodb.us-east-1.amazonaws.com', 'sts': 'sts.amazonaws.com', 'support': 'support.us-east-1.amazonaws.com', 'swf': 'swf.us-east-1.amazonaws.com', 'workspaces': 'workspaces.us-east-1.amazonaws.com', 'waf': 'waf.amazonaws.com' }, 'us-gov-west-1': { 'autoscaling': 'autoscaling.us-gov-west-1.amazonaws.com', 'cloudformation': 'cloudformation.us-gov-west-1.amazonaws.com', 'cloudhsm': 'cloudhsm.us-gov-west-1.amazonaws.com', 'cloudtrail': 'cloudtrail.us-gov-west-1.amazonaws.com', 'dynamodb': 'dynamodb.us-gov-west-1.amazonaws.com', 'ec2': 'ec2.us-gov-west-1.amazonaws.com', 'elasticache': 'elasticache.us-gov-west-1.amazonaws.com', 'elasticloadbalancing': 'elasticloadbalancing.us-gov-west-1.amazonaws.com', 'elasticmapreduce': 'elasticmapreduce.us-gov-west-1.amazonaws.com', 'glacier': 'glacier.us-gov-west-1.amazonaws.com', 'iam': 'iam.us-gov.amazonaws.com', 'kms': 'kms.us-gov-west-1.amazonaws.com', 'monitoring': 'monitoring.us-gov-west-1.amazonaws.com', 'rds': 'rds.us-gov-west-1.amazonaws.com', 'redshift': 'redshift.us-gov-west-1.amazonaws.com', 's3': 's3-us-gov-west-1.amazonaws.com', 'sns': 'sns.us-gov-west-1.amazonaws.com', 'sqs': 'us-gov-west-1.queue.amazonaws.com', 'sts': 'sts.us-gov-west-1.amazonaws.com', 'swf': 'swf.us-gov-west-1.amazonaws.com' }, 'us-west-1': { 'autoscaling': 'autoscaling.us-west-1.amazonaws.com', 'cloudformation': 'cloudformation.us-west-1.amazonaws.com', 'cloudsearch': 'cloudsearch.us-west-1.amazonaws.com', 'cloudtrail': 'cloudtrail.us-west-1.amazonaws.com', 'config': 'config.us-west-1.amazonaws.com', 'directconnect': 'directconnect.us-west-1.amazonaws.com', 'dynamodb': 'dynamodb.us-west-1.amazonaws.com', 'ec2': 'ec2.us-west-1.amazonaws.com', 'ecs': 'ecs.us-west-1.amazonaws.com', 'elasticache': 'elasticache.us-west-1.amazonaws.com', 'elasticbeanstalk': 'elasticbeanstalk.us-west-1.amazonaws.com', 'elasticloadbalancing': 'elasticloadbalancing.us-west-1.amazonaws.com', 'elasticmapreduce': 'us-west-1.elasticmapreduce.amazonaws.com', 'elastictranscoder': 'elastictranscoder.us-west-1.amazonaws.com', 'glacier': 'glacier.us-west-1.amazonaws.com', 'kinesis': 'kinesis.us-west-1.amazonaws.com', 'kms': 'kms.us-west-1.amazonaws.com', 'logs': 'logs.us-west-1.amazonaws.com', 'monitoring': 'monitoring.us-west-1.amazonaws.com', 'rds': 'rds.us-west-1.amazonaws.com', 's3': 's3-us-west-1.amazonaws.com', 'sdb': 'sdb.us-west-1.amazonaws.com', 'sns': 'sns.us-west-1.amazonaws.com', 'sqs': 'us-west-1.queue.amazonaws.com', 'storagegateway': 'storagegateway.us-west-1.amazonaws.com', 'streams.dynamodb': 'streams.dynamodb.us-west-1.amazonaws.com', 'sts': 'sts.amazonaws.com', 'swf': 'swf.us-west-1.amazonaws.com' }, 'us-west-2': { 'apigateway': 'apigateway.us-west-2.amazonaws.com', 'autoscaling': 'autoscaling.us-west-2.amazonaws.com', 'cloudformation': 'cloudformation.us-west-2.amazonaws.com', 'cloudhsm': 'cloudhsm.us-west-2.amazonaws.com', 'cloudsearch': 'cloudsearch.us-west-2.amazonaws.com', 'cloudtrail': 'cloudtrail.us-west-2.amazonaws.com', 'codedeploy': 'codedeploy.us-west-2.amazonaws.com', 'codepipeline': 'codepipeline.us-west-2.amazonaws.com', 'config': 'config.us-west-2.amazonaws.com', 'datapipeline': 'datapipeline.us-west-2.amazonaws.com', 'devicefarm': 'devicefarm.us-west-2.amazonaws.com', 'directconnect': 'directconnect.us-west-2.amazonaws.com', 'ds': 'ds.us-west-2.amazonaws.com', 'dynamodb': 'dynamodb.us-west-2.amazonaws.com', 'ec2': 'ec2.us-west-2.amazonaws.com', 'ecs': 'ecs.us-west-2.amazonaws.com', 'elasticache': 'elasticache.us-west-2.amazonaws.com', 'elasticbeanstalk': 'elasticbeanstalk.us-west-2.amazonaws.com', 'elasticfilesystem': 'elasticfilesystem.us-west-2.amazonaws.com', 'elasticloadbalancing': 'elasticloadbalancing.us-west-2.amazonaws.com', 'elasticmapreduce': 'us-west-2.elasticmapreduce.amazonaws.com', 'elastictranscoder': 'elastictranscoder.us-west-2.amazonaws.com', 'email': 'email.us-west-2.amazonaws.com', 'glacier': 'glacier.us-west-2.amazonaws.com', 'iot': 'iot.us-west-2.amazonaws.com', 'kinesis': 'kinesis.us-west-2.amazonaws.com', 'kms': 'kms.us-west-2.amazonaws.com', 'lambda': 'lambda.us-west-2.amazonaws.com', 'logs': 'logs.us-west-2.amazonaws.com', 'monitoring': 'monitoring.us-west-2.amazonaws.com', 'rds': 'rds.us-west-2.amazonaws.com', 'redshift': 'redshift.us-west-2.amazonaws.com', 's3': 's3-us-west-2.amazonaws.com', 'sdb': 'sdb.us-west-2.amazonaws.com', 'sns': 'sns.us-west-2.amazonaws.com', 'sqs': 'us-west-2.queue.amazonaws.com', 'ssm': 'ssm.us-west-2.amazonaws.com', 'storagegateway': 'storagegateway.us-west-2.amazonaws.com', 'streams.dynamodb': 'streams.dynamodb.us-west-2.amazonaws.com', 'sts': 'sts.amazonaws.com', 'swf': 'swf.us-west-2.amazonaws.com', 'workspaces': 'workspaces.us-west-2.amazonaws.com' } } # Lists the services in the aws partition that do not require a region # when resolving an endpoint because these services have partitionWide # endpoints. KNOWN_AWS_PARTITION_WIDE = { 'importexport': 'https://importexport.amazonaws.com', 'cloudfront': 'https://cloudfront.amazonaws.com', 'waf': 'https://waf.amazonaws.com', 'route53': 'https://route53.amazonaws.com', 's3': 'https://s3.amazonaws.com', 'sts': 'https://sts.amazonaws.com', 'iam': 'https://iam.amazonaws.com' } def _get_patched_session(): with mock.patch('os.environ') as environ: environ['AWS_ACCESS_KEY_ID'] = 'access_key' environ['AWS_SECRET_ACCESS_KEY'] = 'secret_key' environ['AWS_CONFIG_FILE'] = 'no-exist-foo' session = create_session() return session def test_known_endpoints(): # Verify the actual values from the partition files. While # TestEndpointHeuristics verified the generic functionality given any # endpoints file, this test actually verifies the partition data against a # fixed list of known endpoints. This list doesn't need to be kept 100% up # to date, but serves as a basis for regressions as the endpoint data # logic evolves. resolver = _get_patched_session().get_component('endpoint_resolver') for region_name, service_dict in KNOWN_REGIONS.items(): for service_name, endpoint in service_dict.items(): yield (_test_single_service_region, service_name, region_name, endpoint, resolver) def _test_single_service_region(service_name, region_name, expected_endpoint, resolver): bridge = ClientEndpointBridge(resolver, None, None) result = bridge.resolve(service_name, region_name) expected = 'https://%s' % expected_endpoint assert_equals(result['endpoint_url'], expected) # Ensure that all S3 regions use s3v4 instead of v4 def test_all_s3_endpoints_have_s3v4(): session = _get_patched_session() partitions = session.get_available_partitions() resolver = session.get_component('endpoint_resolver') for partition_name in partitions: for endpoint in session.get_available_regions('s3', partition_name): resolved = resolver.construct_endpoint('s3', endpoint) assert 's3v4' in resolved['signatureVersions'] assert 'v4' not in resolved['signatureVersions'] def test_known_endpoints(): resolver = _get_patched_session().get_component('endpoint_resolver') for service_name, endpoint in KNOWN_AWS_PARTITION_WIDE.items(): yield (_test_single_service_partition_endpoint, service_name, endpoint, resolver) def _test_single_service_partition_endpoint(service_name, expected_endpoint, resolver): bridge = ClientEndpointBridge(resolver) result = bridge.resolve(service_name) assert_equals(result['endpoint_url'], expected_endpoint) def test_non_partition_endpoint_requires_region(): resolver = _get_patched_session().get_component('endpoint_resolver') assert_raises(NoRegionError, resolver.construct_endpoint, 'ec2') botocore-1.5.7/tests/functional/test_endpoints.py0000666454262600001440000000451613042511306023333 0ustar pysdk-ciamazon00000000000000# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from nose.tools import assert_equal from botocore.session import get_session # Several services have names that don't match for one reason or another. SERVICE_RENAMES = { 'application-autoscaling': 'autoscaling', 'appstream': 'appstream2', 'dynamodbstreams': 'streams.dynamodb', 'cloudwatch': 'monitoring', 'efs': 'elasticfilesystem', 'elb': 'elasticloadbalancing', 'elbv2': 'elasticloadbalancing', 'emr': 'elasticmapreduce', 'iot-data': 'data.iot', 'meteringmarketplace': 'metering.marketplace', 'opsworkscm': 'opsworks-cm', 'ses': 'email', 'stepfunctions': 'states' } def test_service_name_matches_endpoint_prefix(): # Generates tests for each service to verify that the endpoint prefix # matches the service name unless there is an explicit exception. session = get_session() loader = session.get_component('data_loader') # Load the list of available services. The names here represent what # will become the client names. services = loader.list_available_services('service-2') for service in services: yield _assert_service_name_matches_endpoint_prefix, loader, service def _assert_service_name_matches_endpoint_prefix(loader, service_name): # Load the service model and grab its endpoint prefix service_model = loader.load_service_model(service_name, 'service-2') endpoint_prefix = service_model['metadata']['endpointPrefix'] # Handle known exceptions where we have renamed the service directory # for one reason or another. expected_endpoint_prefix = SERVICE_RENAMES.get(service_name, service_name) assert_equal( endpoint_prefix, expected_endpoint_prefix, "Service name `%s` does not match endpoint prefix `%s`." % ( service_name, expected_endpoint_prefix)) botocore-1.5.7/tests/functional/test_credentials.py0000666454262600001440000000767213042511306023633 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest, mock, IntegerRefresher import datetime import threading import math import time from dateutil.tz import tzlocal from botocore import credentials from botocore import utils class TestCredentialRefreshRaces(unittest.TestCase): def assert_consistent_credentials_seen(self, creds, func): collected = [] threads = [] for _ in range(20): threads.append(threading.Thread(target=func, args=(collected,))) start = time.time() for thread in threads: thread.start() for thread in threads: thread.join() for creds in collected: # During testing, the refresher uses it's current # refresh count as the values for the access, secret, and # token value. This means that at any given point in time, # the credentials should be something like: # # ReadOnlyCredentials('1', '1', '1') # ReadOnlyCredentials('2', '2', '2') # ... # ReadOnlyCredentials('30', '30', '30') # # This makes it really easy to verify we see a consistent # set of credentials from the same time period. We just # check if all the credential values are the same. If # we ever see something like: # # ReadOnlyCredentials('1', '2', '1') # # We fail. This is because we're using the access_key # from the first refresh ('1'), the secret key from # the second refresh ('2'), and the token from the # first refresh ('1'). self.assertTrue(creds[0] == creds[1] == creds[2], creds) def test_has_no_race_conditions(self): creds = IntegerRefresher( creds_last_for=2, advisory_refresh=1, mandatory_refresh=0 ) def _run_in_thread(collected): for _ in range(4000): frozen = creds.get_frozen_credentials() collected.append((frozen.access_key, frozen.secret_key, frozen.token)) start = time.time() self.assert_consistent_credentials_seen(creds, _run_in_thread) end = time.time() # creds_last_for = 2 seconds (from above) # So, for example, if execution time took 6.1 seconds, then # we should see a maximum number of refreshes being (6 / 2.0) + 1 = 4 max_calls_allowed = math.ceil((end - start) / 2.0) + 1 self.assertTrue(creds.refresh_counter <= max_calls_allowed, "Too many cred refreshes, max: %s, actual: %s, " "time_delta: %.4f" % (max_calls_allowed, creds.refresh_counter, (end - start))) def test_no_race_for_immediate_advisory_expiration(self): creds = IntegerRefresher( creds_last_for=1, advisory_refresh=1, mandatory_refresh=0 ) def _run_in_thread(collected): for _ in range(100): frozen = creds.get_frozen_credentials() collected.append((frozen.access_key, frozen.secret_key, frozen.token)) self.assert_consistent_credentials_seen(creds, _run_in_thread) botocore-1.5.7/tests/functional/test_paginate.py0000666454262600001440000000415113042511306023113 0ustar pysdk-ciamazon00000000000000# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest from botocore.stub import Stubber, StubAssertionError import botocore.session class TestRDSPagination(unittest.TestCase): def setUp(self): self.region = 'us-west-2' self.session = botocore.session.get_session() self.client = self.session.create_client( 'rds', self.region) self.stubber = Stubber(self.client) def test_can_specify_zero_marker(self): service_response = { 'LogFileData': 'foo', 'Marker': '2', 'AdditionalDataPending': True } expected_params = { 'DBInstanceIdentifier': 'foo', 'LogFileName': 'bar', 'NumberOfLines': 2, 'Marker': '0' } function_name = 'download_db_log_file_portion' # The stubber will assert that the function is called with the expected # parameters. self.stubber.add_response( function_name, service_response, expected_params) self.stubber.activate() try: paginator = self.client.get_paginator(function_name) result = paginator.paginate( DBInstanceIdentifier='foo', LogFileName='bar', NumberOfLines=2, PaginationConfig={ 'StartingToken': '0', 'MaxItems': 3 }).build_full_result() self.assertEqual(result['LogFileData'], 'foo') self.assertIn('NextToken', result) except StubAssertionError as e: self.fail(str(e)) botocore-1.5.7/tests/functional/test_apigateway.py0000666454262600001440000000301213042511306023451 0ustar pysdk-ciamazon00000000000000# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import mock from botocore.stub import Stubber from tests import BaseSessionTest class TestApiGateway(BaseSessionTest): def setUp(self): super(TestApiGateway, self).setUp() self.region = 'us-west-2' self.client = self.session.create_client( 'apigateway', self.region) self.stubber = Stubber(self.client) def test_get_export(self): params = { 'restApiId': 'foo', 'stageName': 'bar', 'exportType': 'swagger', 'accepts': 'application/yaml' } with mock.patch('botocore.endpoint.Session.send') as _send: _send.return_value = mock.Mock( status_code=200, headers={}, content=b'{}') self.client.get_export(**params) sent_request = _send.call_args[0][0] self.assertEqual(sent_request.method, 'GET') self.assertEqual( sent_request.headers.get('Accept'), b'application/yaml') botocore-1.5.7/tests/functional/test_loaders.py0000666454262600001440000000311513042511306022753 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import os import shutil from botocore import loaders from tests import unittest, temporary_file class TestLoaderAllowsDataPathOverride(unittest.TestCase): def create_file(self, f, contents, name): f.write(contents) f.flush() dirname = os.path.dirname(os.path.abspath(f.name)) override_name = os.path.join(dirname, name) shutil.copy(f.name, override_name) return override_name def test_can_override_session(self): with temporary_file('w') as f: # We're going to override _retry.json in # botocore/data by setting our own data directory. override_name = self.create_file( f, contents='{"foo": "bar"}', name='_retry.json') new_data_path = os.path.dirname(override_name) loader = loaders.create_loader(search_path_string=new_data_path) new_content = loader.load_data('_retry') # This should contain the content we just created. self.assertEqual(new_content, {"foo": "bar"}) botocore-1.5.7/tests/functional/test_machinelearning.py0000666454262600001440000000306313042511306024450 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import mock from tests import BaseSessionTest class TestMachineLearning(BaseSessionTest): def setUp(self): super(TestMachineLearning, self).setUp() self.region = 'us-west-2' self.client = self.session.create_client( 'machinelearning', self.region) def test_predict(self): with mock.patch('botocore.endpoint.Session.send') as \ http_session_send_patch: http_response = mock.Mock() http_response.status_code = 200 http_response.content = b'{}' http_response.headers = {} http_session_send_patch.return_value = http_response custom_endpoint = 'https://myendpoint.amazonaws.com/' self.client.predict( MLModelId='ml-foo', Record={'Foo': 'Bar'}, PredictEndpoint=custom_endpoint ) sent_request = http_session_send_patch.call_args[0][0] self.assertEqual(sent_request.url, custom_endpoint) botocore-1.5.7/tests/functional/test_waiter_config.py0000666454262600001440000000753513042511306024154 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import jmespath import botocore.session from botocore.utils import ArgumentGenerator def test_lint_waiter_configs(): session = botocore.session.get_session() for service_name in session.get_available_services(): client = session.create_client(service_name, 'us-east-1') service_model = client.meta.service_model for waiter_name in client.waiter_names: yield _lint_single_waiter, client, waiter_name, service_model def _lint_single_waiter(client, waiter_name, service_model): try: waiter = client.get_waiter(waiter_name) # The 'acceptors' property is dynamic and will create # the acceptor configs when first accessed. This is still # considered a failure to construct the waiter which is # why it's in this try/except block. # This catches things like: # * jmespath expression compiles # * matcher has a known value acceptors = waiter.config.acceptors except Exception as e: raise AssertionError("Could not create waiter '%s': %s" % (waiter_name, e)) operation_name = waiter.config.operation # Needs to reference an existing operation name. if operation_name not in service_model.operation_names: raise AssertionError("Waiter config references unknown " "operation: %s" % operation_name) # Needs to have at least one acceptor. if not waiter.config.acceptors: raise AssertionError("Waiter config must have at least " "one acceptor state: %s" % waiter.name) op_model = service_model.operation_model(operation_name) for acceptor in acceptors: _validate_acceptor(acceptor, op_model, waiter.name) def _validate_acceptor(acceptor, op_model, waiter_name): if acceptor.matcher.startswith('path'): expression = acceptor.argument # The JMESPath expression should have the potential to match something # in the response shape. output_shape = op_model.output_shape assert output_shape is not None, ( "Waiter '%s' has JMESPath expression with no output shape: %s" % (waiter_name, op_model)) # We want to check if the JMESPath expression makes sense. # To do this, we'll generate sample output and evaluate the # JMESPath expression against the output. We'll then # check a few things about this returned search result. search_result = _search_jmespath_expression(expression, op_model) if not search_result: raise AssertionError("JMESPath expression did not match " "anything for waiter '%s': %s" % (waiter_name, expression)) if acceptor.matcher in ['pathAll', 'pathAny']: assert isinstance(search_result, list), \ ("Attempted to use '%s' matcher in waiter '%s' " "with non list result in JMESPath expression: %s" % (acceptor.matcher, waiter_name, expression)) def _search_jmespath_expression(expression, op_model): arg_gen = ArgumentGenerator(use_member_names=True) sample_output = arg_gen.generate_skeleton(op_model.output_shape) search_result = jmespath.search(expression, sample_output) return search_result botocore-1.5.7/tests/functional/test_cloudformation.py0000666454262600001440000000227413042511306024354 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests.functional.docs import BaseDocsFunctionalTest from botocore.docs.service import ServiceDocumenter class TestCloudFormationDocs(BaseDocsFunctionalTest): def test_get_template_response_documented_as_dict(self): content = self.get_docstring_for_method('cloudformation', 'get_template') # String return type should be gone self.assert_not_contains_line( "(*string*) --", content) # Check for template body returning a dict self.assert_contains_line( "(*dict*) --", content) # Check the specifics of the returned dict self.assert_contains_line('{}', content) botocore-1.5.7/tests/functional/test_s3.py0000666454262600001440000006247313042511306021663 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest, mock, BaseSessionTest, create_session from nose.tools import assert_equal import botocore.session from botocore.config import Config from botocore.exceptions import ParamValidationError class TestS3BucketValidation(unittest.TestCase): def test_invalid_bucket_name_raises_error(self): session = botocore.session.get_session() s3 = session.create_client('s3') with self.assertRaises(ParamValidationError): s3.put_object(Bucket='adfgasdfadfs/bucket/name', Key='foo', Body=b'asdf') class BaseS3OperationTest(BaseSessionTest): def setUp(self): super(BaseS3OperationTest, self).setUp() self.region = 'us-west-2' self.client = self.session.create_client( 's3', self.region) self.session_send_patch = mock.patch('botocore.endpoint.Session.send') self.http_session_send_mock = self.session_send_patch.start() def tearDown(self): super(BaseSessionTest, self).tearDown() self.session_send_patch.stop() class TestOnlyAsciiCharsAllowed(BaseS3OperationTest): def test_validates_non_ascii_chars_trigger_validation_error(self): self.http_session_send_mock.return_value = mock.Mock(status_code=200, headers={}, content=b'') with self.assertRaises(ParamValidationError): self.client.put_object( Bucket='foo', Key='bar', Metadata={ 'goodkey': 'good', 'non-ascii': u'\u2713'}) class TestS3GetBucketLifecycle(BaseS3OperationTest): def test_multiple_transitions_returns_one(self): http_response = mock.Mock() http_response.status_code = 200 http_response.content = ( '' '' ' ' ' transitionRule' ' foo' ' Enabled' ' ' ' 40' ' STANDARD_IA' ' ' ' ' ' 70' ' GLACIER' ' ' ' ' ' ' ' noncurrentVersionRule' ' bar' ' Enabled' ' ' ' 40' ' STANDARD_IA' ' ' ' ' ' 70' ' GLACIER' ' ' ' ' '' ).encode('utf-8') http_response.headers = {} self.http_session_send_mock.return_value = http_response s3 = self.session.create_client('s3') response = s3.get_bucket_lifecycle(Bucket='mybucket') # Each Transition member should have at least one of the # transitions provided. self.assertEqual( response['Rules'][0]['Transition'], {'Days': 40, 'StorageClass': 'STANDARD_IA'} ) self.assertEqual( response['Rules'][1]['NoncurrentVersionTransition'], {'NoncurrentDays': 40, 'StorageClass': 'STANDARD_IA'} ) class TestS3PutObject(BaseS3OperationTest): def test_500_error_with_non_xml_body(self): # Note: This exact test case may not be applicable from # an integration standpoint if the issue is fixed in the future. # # The issue is that: # S3 returns a 200 response but the received response from urllib3 has # a 500 status code and the headers are in the body of the # the response. Botocore will try to parse out the error body as xml, # but the body is invalid xml because it is full of headers. # So instead of blowing up on an XML parsing error, we # should at least use the 500 status code because that can be # retried. # # We are unsure of what exactly causes the response to be mangled # but we expect it to be how 100 continues are handled. non_xml_content = ( 'x-amz-id-2: foo\r\n' 'x-amz-request-id: bar\n' 'Date: Tue, 06 Oct 2015 03:20:38 GMT\r\n' 'ETag: "a6d856bc171fc6aa1b236680856094e2"\r\n' 'Content-Length: 0\r\n' 'Server: AmazonS3\r\n' ).encode('utf-8') http_500_response = mock.Mock() http_500_response.status_code = 500 http_500_response.content = non_xml_content http_500_response.headers = {} success_response = mock.Mock() success_response.status_code = 200 success_response.content = b'' success_response.headers = {} self.http_session_send_mock.side_effect = [ http_500_response, success_response ] s3 = self.session.create_client('s3') response = s3.put_object(Bucket='mybucket', Key='mykey', Body=b'foo') # The first response should have been retried even though the xml is # invalid and eventually return the 200 response. self.assertEqual(response['ResponseMetadata']['HTTPStatusCode'], 200) class TestS3SigV4(BaseS3OperationTest): def setUp(self): super(TestS3SigV4, self).setUp() self.client = self.session.create_client( 's3', self.region, config=Config(signature_version='s3v4')) self.response_mock = mock.Mock() self.response_mock.content = b'' self.response_mock.headers = {} self.response_mock.status_code = 200 self.http_session_send_mock.return_value = self.response_mock def get_sent_headers(self): return self.http_session_send_mock.mock_calls[0][1][0].headers def test_content_md5_set(self): self.client.put_object(Bucket='foo', Key='bar', Body='baz') self.assertIn('content-md5', self.get_sent_headers()) def test_content_sha256_set_if_config_value_is_true(self): config = Config(signature_version='s3v4', s3={ 'payload_signing_enabled': True }) self.client = self.session.create_client( 's3', self.region, config=config) self.client.put_object(Bucket='foo', Key='bar', Body='baz') sent_headers = self.get_sent_headers() sha_header = sent_headers.get('x-amz-content-sha256') self.assertNotEqual(sha_header, b'UNSIGNED-PAYLOAD') def test_content_sha256_not_set_if_config_value_is_false(self): config = Config(signature_version='s3v4', s3={ 'payload_signing_enabled': False }) self.client = self.session.create_client( 's3', self.region, config=config) self.client.put_object(Bucket='foo', Key='bar', Body='baz') sent_headers = self.get_sent_headers() sha_header = sent_headers.get('x-amz-content-sha256') self.assertEqual(sha_header, b'UNSIGNED-PAYLOAD') def test_content_sha256_set_if_md5_is_unavailable(self): with mock.patch('botocore.auth.MD5_AVAILABLE', False): with mock.patch('botocore.handlers.MD5_AVAILABLE', False): self.client.put_object(Bucket='foo', Key='bar', Body='baz') sent_headers = self.get_sent_headers() unsigned = 'UNSIGNED-PAYLOAD' self.assertNotEqual(sent_headers['x-amz-content-sha256'], unsigned) self.assertNotIn('content-md5', sent_headers) class TestCanSendIntegerHeaders(BaseSessionTest): def test_int_values_with_sigv4(self): s3 = self.session.create_client( 's3', config=Config(signature_version='s3v4')) with mock.patch('botocore.endpoint.Session.send') as mock_send: mock_send.return_value = mock.Mock(status_code=200, content=b'', headers={}) s3.upload_part(Bucket='foo', Key='bar', Body=b'foo', UploadId='bar', PartNumber=1, ContentLength=3) headers = mock_send.call_args[0][0].headers # Verify that the request integer value of 3 has been converted to # string '3'. This also means we've made it pass the signer which # expects string values in order to sign properly. self.assertEqual(headers['Content-Length'], '3') class TestRegionRedirect(BaseS3OperationTest): def setUp(self): super(TestRegionRedirect, self).setUp() self.client = self.session.create_client( 's3', 'us-west-2', config=Config(signature_version='s3v4')) self.redirect_response = mock.Mock() self.redirect_response.headers = { 'x-amz-bucket-region': 'eu-central-1' } self.redirect_response.status_code = 301 self.redirect_response.content = ( b'\n' b'' b' PermanentRedirect' b' The bucket you are attempting to access must be ' b' addressed using the specified endpoint. Please send all ' b' future requests to this endpoint.' b' ' b' foo' b' foo.s3.eu-central-1.amazonaws.com' b'') self.success_response = mock.Mock() self.success_response.headers = {} self.success_response.status_code = 200 self.success_response.content = ( b'\n' b'' b' foo' b' ' b' ' b' 1000' b' url' b' false' b'') def test_region_redirect(self): self.http_session_send_mock.side_effect = [ self.redirect_response, self.success_response] response = self.client.list_objects(Bucket='foo') self.assertEqual(response['ResponseMetadata']['HTTPStatusCode'], 200) self.assertEqual(self.http_session_send_mock.call_count, 2) calls = [c[0][0] for c in self.http_session_send_mock.call_args_list] initial_url = ('https://s3-us-west-2.amazonaws.com/foo' '?encoding-type=url') self.assertEqual(calls[0].url, initial_url) fixed_url = ('https://s3.eu-central-1.amazonaws.com/foo' '?encoding-type=url') self.assertEqual(calls[1].url, fixed_url) def test_region_redirect_cache(self): self.http_session_send_mock.side_effect = [ self.redirect_response, self.success_response, self.success_response] first_response = self.client.list_objects(Bucket='foo') self.assertEqual( first_response['ResponseMetadata']['HTTPStatusCode'], 200) second_response = self.client.list_objects(Bucket='foo') self.assertEqual( second_response['ResponseMetadata']['HTTPStatusCode'], 200) self.assertEqual(self.http_session_send_mock.call_count, 3) calls = [c[0][0] for c in self.http_session_send_mock.call_args_list] initial_url = ('https://s3-us-west-2.amazonaws.com/foo' '?encoding-type=url') self.assertEqual(calls[0].url, initial_url) fixed_url = ('https://s3.eu-central-1.amazonaws.com/foo' '?encoding-type=url') self.assertEqual(calls[1].url, fixed_url) self.assertEqual(calls[2].url, fixed_url) class TestGeneratePresigned(BaseS3OperationTest): def test_generate_unauthed_url(self): config = Config(signature_version=botocore.UNSIGNED) client = self.session.create_client('s3', self.region, config=config) url = client.generate_presigned_url( ClientMethod='get_object', Params={ 'Bucket': 'foo', 'Key': 'bar' }) self.assertEqual(url, 'https://foo.s3.amazonaws.com/bar') def test_generate_unauthed_post(self): config = Config(signature_version=botocore.UNSIGNED) client = self.session.create_client('s3', self.region, config=config) parts = client.generate_presigned_post(Bucket='foo', Key='bar') expected = { 'fields': {'key': 'bar'}, 'url': 'https://foo.s3.amazonaws.com/' } self.assertEqual(parts, expected) def test_correct_url_used_for_s3(): # Test that given various sets of config options and bucket names, # we construct the expect endpoint url. t = S3AddressingCases(_verify_expected_endpoint_url) # The default behavior. DNS compatible buckets yield t.case(region='us-west-2', bucket='bucket', key='key', expected_url='https://bucket.s3.amazonaws.com/key') yield t.case(region='us-east-1', bucket='bucket', key='key', expected_url='https://bucket.s3.amazonaws.com/key') yield t.case(region='us-west-1', bucket='bucket', key='key', expected_url='https://bucket.s3.amazonaws.com/key') yield t.case(region='us-west-1', bucket='bucket', key='key', is_secure=False, expected_url='http://bucket.s3.amazonaws.com/key') # If you don't have a DNS compatible bucket, we use path style. yield t.case( region='us-west-2', bucket='bucket.dot', key='key', expected_url='https://s3-us-west-2.amazonaws.com/bucket.dot/key') yield t.case( region='us-east-1', bucket='bucket.dot', key='key', expected_url='https://s3.amazonaws.com/bucket.dot/key') # Custom endpoint url should always be used. yield t.case( customer_provided_endpoint='https://my-custom-s3/', bucket='foo', key='bar', expected_url='https://my-custom-s3/foo/bar') yield t.case( customer_provided_endpoint='https://my-custom-s3/', bucket='bucket.dots', key='bar', expected_url='https://my-custom-s3/bucket.dots/bar') # Doesn't matter what region you specify, a custom endpoint url always # wins. yield t.case( customer_provided_endpoint='https://my-custom-s3/', region='us-west-2', bucket='foo', key='bar', expected_url='https://my-custom-s3/foo/bar') # Explicitly configuring "virtual" addressing_style. virtual_hosting = {'addressing_style': 'virtual'} yield t.case( region='us-east-1', bucket='bucket', key='key', s3_config=virtual_hosting, expected_url='https://bucket.s3.amazonaws.com/key') yield t.case( region='us-west-2', bucket='bucket', key='key', s3_config=virtual_hosting, expected_url='https://bucket.s3-us-west-2.amazonaws.com/key') yield t.case( region='eu-central-1', bucket='bucket', key='key', s3_config=virtual_hosting, expected_url='https://bucket.s3.eu-central-1.amazonaws.com/key') yield t.case( region='us-east-1', bucket='bucket', key='key', s3_config=virtual_hosting, customer_provided_endpoint='https://foo.amazonaws.com', expected_url='https://bucket.foo.amazonaws.com/key') # Test us-gov with virtual addressing. yield t.case( region='us-gov-west-1', bucket='bucket', key='key', s3_config=virtual_hosting, expected_url='https://bucket.s3-us-gov-west-1.amazonaws.com/key') # Test path style addressing. path_style = {'addressing_style': 'path'} yield t.case( region='us-east-1', bucket='bucket', key='key', s3_config=path_style, expected_url='https://s3.amazonaws.com/bucket/key') yield t.case( region='us-east-1', bucket='bucket', key='key', s3_config=path_style, customer_provided_endpoint='https://foo.amazonaws.com/', expected_url='https://foo.amazonaws.com/bucket/key') # S3 accelerate use_accelerate = {'use_accelerate_endpoint': True} yield t.case( region='us-east-1', bucket='bucket', key='key', s3_config=use_accelerate, expected_url='https://bucket.s3-accelerate.amazonaws.com/key') yield t.case( # region is ignored with S3 accelerate. region='us-west-2', bucket='bucket', key='key', s3_config=use_accelerate, expected_url='https://bucket.s3-accelerate.amazonaws.com/key') # Provided endpoints still get recognized as accelerate endpoints. yield t.case( region='us-east-1', bucket='bucket', key='key', customer_provided_endpoint='https://s3-accelerate.amazonaws.com', expected_url='https://bucket.s3-accelerate.amazonaws.com/key') yield t.case( region='us-east-1', bucket='bucket', key='key', customer_provided_endpoint='http://s3-accelerate.amazonaws.com', expected_url='http://bucket.s3-accelerate.amazonaws.com/key') yield t.case( region='us-east-1', bucket='bucket', key='key', s3_config=use_accelerate, is_secure=False, # Note we're using http:// because is_secure=False. expected_url='http://bucket.s3-accelerate.amazonaws.com/key') yield t.case( region='us-east-1', bucket='bucket', key='key', # s3-accelerate must be the first part of the url. customer_provided_endpoint='https://foo.s3-accelerate.amazonaws.com', expected_url='https://foo.s3-accelerate.amazonaws.com/bucket/key') yield t.case( region='us-east-1', bucket='bucket', key='key', # The endpoint must be an Amazon endpoint. customer_provided_endpoint='https://s3-accelerate.notamazon.com', expected_url='https://s3-accelerate.notamazon.com/bucket/key') yield t.case( region='us-east-1', bucket='bucket', key='key', # Extra components must be whitelisted. customer_provided_endpoint='https://s3-accelerate.foo.amazonaws.com', expected_url='https://s3-accelerate.foo.amazonaws.com/bucket/key') # Use virtual even if path is specified for s3 accelerate because # path style will not work with S3 accelerate. yield t.case( region='us-east-1', bucket='bucket', key='key', s3_config={'use_accelerate_endpoint': True, 'addressing_style': 'path'}, expected_url='https://bucket.s3-accelerate.amazonaws.com/key') # S3 dual stack endpoints. use_dualstack = {'use_dualstack_endpoint': True} yield t.case( region='us-east-1', bucket='bucket', key='key', s3_config=use_dualstack, # Still default to virtual hosted when possible. expected_url='https://bucket.s3.dualstack.us-east-1.amazonaws.com/key') yield t.case( region='us-west-2', bucket='bucket', key='key', s3_config=use_dualstack, # Still default to virtual hosted when possible. expected_url=( 'https://bucket.s3.dualstack.us-west-2.amazonaws.com/key')) # Non DNS compatible buckets use path style for dual stack. yield t.case( region='us-west-2', bucket='bucket.dot', key='key', s3_config=use_dualstack, # Still default to virtual hosted when possible. expected_url=( 'https://s3.dualstack.us-west-2.amazonaws.com/bucket.dot/key')) # Supports is_secure (use_ssl=False in create_client()). yield t.case( region='us-west-2', bucket='bucket.dot', key='key', is_secure=False, s3_config=use_dualstack, # Still default to virtual hosted when possible. expected_url=( 'http://s3.dualstack.us-west-2.amazonaws.com/bucket.dot/key')) # Is path style is requested, we should use it, even if the bucket is # DNS compatible. force_path_style = { 'use_dualstack_endpoint': True, 'addressing_style': 'path', } yield t.case( region='us-west-2', bucket='bucket', key='key', s3_config=force_path_style, # Still default to virtual hosted when possible. expected_url='https://s3.dualstack.us-west-2.amazonaws.com/bucket/key') # Accelerate + dual stack use_accelerate_dualstack = { 'use_accelerate_endpoint': True, 'use_dualstack_endpoint': True, } yield t.case( region='us-east-1', bucket='bucket', key='key', s3_config=use_accelerate_dualstack, expected_url=( 'https://bucket.s3-accelerate.dualstack.amazonaws.com/key')) yield t.case( # Region is ignored with S3 accelerate. region='us-west-2', bucket='bucket', key='key', s3_config=use_accelerate_dualstack, expected_url=( 'https://bucket.s3-accelerate.dualstack.amazonaws.com/key')) # Only s3-accelerate overrides a customer endpoint. yield t.case( region='us-east-1', bucket='bucket', key='key', s3_config=use_dualstack, customer_provided_endpoint='https://s3-accelerate.amazonaws.com', expected_url=( 'https://bucket.s3-accelerate.amazonaws.com/key')) yield t.case( region='us-east-1', bucket='bucket', key='key', # Dualstack is whitelisted. customer_provided_endpoint=( 'https://s3-accelerate.dualstack.amazonaws.com'), expected_url=( 'https://bucket.s3-accelerate.dualstack.amazonaws.com/key')) yield t.case( region='us-east-1', bucket='bucket', key='key', # Even whitelisted parts cannot be duplicated. customer_provided_endpoint=( 'https://s3-accelerate.dualstack.dualstack.amazonaws.com'), expected_url=( 'https://s3-accelerate.dualstack.dualstack' '.amazonaws.com/bucket/key')) yield t.case( region='us-east-1', bucket='bucket', key='key', # More than two extra parts is not allowed. customer_provided_endpoint=( 'https://s3-accelerate.dualstack.dualstack.dualstack' '.amazonaws.com'), expected_url=( 'https://s3-accelerate.dualstack.dualstack.dualstack.amazonaws.com' '/bucket/key')) yield t.case( region='us-east-1', bucket='bucket', key='key', # Extra components must be whitelisted. customer_provided_endpoint='https://s3-accelerate.foo.amazonaws.com', expected_url='https://s3-accelerate.foo.amazonaws.com/bucket/key') yield t.case( region='us-east-1', bucket='bucket', key='key', s3_config=use_accelerate_dualstack, is_secure=False, # Note we're using http:// because is_secure=False. expected_url=( 'http://bucket.s3-accelerate.dualstack.amazonaws.com/key')) # Use virtual even if path is specified for s3 accelerate because # path style will not work with S3 accelerate. use_accelerate_dualstack['addressing_style'] = 'path' yield t.case( region='us-east-1', bucket='bucket', key='key', s3_config=use_accelerate_dualstack, expected_url=( 'https://bucket.s3-accelerate.dualstack.amazonaws.com/key')) class S3AddressingCases(object): def __init__(self, verify_function): self._verify = verify_function def case(self, region=None, bucket='bucket', key='key', s3_config=None, is_secure=True, customer_provided_endpoint=None, expected_url=None): return ( self._verify, region, bucket, key, s3_config, is_secure, customer_provided_endpoint, expected_url ) def _verify_expected_endpoint_url(region, bucket, key, s3_config, is_secure=True, customer_provided_endpoint=None, expected_url=None): http_response = mock.Mock() http_response.status_code = 200 http_response.headers = {} http_response.content = b'' environ = {} with mock.patch('os.environ', environ): environ['AWS_ACCESS_KEY_ID'] = 'access_key' environ['AWS_SECRET_ACCESS_KEY'] = 'secret_key' environ['AWS_CONFIG_FILE'] = 'no-exist-foo' session = create_session() session.config_filename = 'no-exist-foo' config = None if s3_config is not None: config = Config(s3=s3_config) s3 = session.create_client('s3', region_name=region, use_ssl=is_secure, config=config, endpoint_url=customer_provided_endpoint) with mock.patch('botocore.endpoint.Session.send') as mock_send: mock_send.return_value = http_response s3.put_object(Bucket=bucket, Key=key, Body=b'bar') request_sent = mock_send.call_args[0][0] assert_equal(request_sent.url, expected_url) botocore-1.5.7/tests/functional/test_iot_data.py0000666454262600001440000000333513042511306023112 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import sys import warnings from tests import unittest, mock, BaseSessionTest from botocore.exceptions import UnsupportedTLSVersionWarning @unittest.skipIf(sys.version_info[:2] == (2, 6), ("py26 is unable to detect openssl version")) class TestOpensslVersion(BaseSessionTest): def test_incompatible_openssl_version(self): with mock.patch('ssl.OPENSSL_VERSION_INFO', new=(0, 9, 8, 11, 15)): with mock.patch('warnings.warn') as mock_warn: self.session.create_client('iot-data', 'us-east-1') call_args = mock_warn.call_args[0] warning_message = call_args[0] warning_type = call_args[1] # We should say something specific about the service. self.assertIn('iot-data', warning_message) self.assertEqual(warning_type, UnsupportedTLSVersionWarning) def test_compatible_openssl_version(self): with mock.patch('ssl.OPENSSL_VERSION_INFO', new=(1, 0, 1, 1, 1)): with mock.patch('warnings.warn') as mock_warn: self.session.create_client('iot-data', 'us-east-1') self.assertFalse(mock_warn.called) botocore-1.5.7/tests/functional/test_model_completeness.py0000666454262600001440000000340513042511306025205 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from botocore.session import Session from botocore.loaders import Loader from botocore.exceptions import DataNotFoundError def _test_model_is_not_lost(service_name, type_name, previous_version, latest_version): # Make sure if a paginator and/or waiter exists in previous version, # there will be a successor existing in latest version. loader = Loader() try: previous = loader.load_service_model( service_name, type_name, previous_version) except DataNotFoundError: pass else: try: latest = loader.load_service_model( service_name, type_name, latest_version) except DataNotFoundError as e: raise AssertionError( "%s must exist for %s: %s" % (type_name, service_name, e)) def test_paginators_and_waiters_are_not_lost_in_new_version(): for service_name in Session().get_available_services(): versions = Loader().list_api_versions(service_name, 'service-2') if len(versions) > 1: for type_name in ['paginators-1', 'waiters-2']: yield (_test_model_is_not_lost, service_name, type_name, versions[-2], versions[-1]) botocore-1.5.7/tests/functional/test_ec2.py0000666454262600001440000000515413042511306022000 0ustar pysdk-ciamazon00000000000000# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest from tests.functional.docs import BaseDocsFunctionalTest from botocore.stub import Stubber, StubAssertionError, ANY import botocore.session class TestIdempotencyToken(unittest.TestCase): def setUp(self): self.function_name = 'purchase_scheduled_instances' self.region = 'us-west-2' self.session = botocore.session.get_session() self.client = self.session.create_client( 'ec2', self.region) self.stubber = Stubber(self.client) self.service_response = {} self.params_seen = [] # Record all the parameters that get seen self.client.meta.events.register_first( 'before-call.*.*', self.collect_params, unique_id='TestIdempotencyToken') def collect_params(self, model, params, *args, **kwargs): self.params_seen.extend(params['body'].keys()) def test_provided_idempotency_token(self): expected_params = { 'PurchaseRequests': [ {'PurchaseToken': 'foo', 'InstanceCount': 123}], 'ClientToken': ANY } self.stubber.add_response( self.function_name, self.service_response, expected_params) with self.stubber: self.client.purchase_scheduled_instances( PurchaseRequests=[{'PurchaseToken': 'foo', 'InstanceCount': 123}], ClientToken='foobar') self.assertIn('ClientToken', self.params_seen) def test_insert_idempotency_token(self): expected_params = { 'PurchaseRequests': [ {'PurchaseToken': 'foo', 'InstanceCount': 123}], } self.stubber.add_response( self.function_name, self.service_response, expected_params) with self.stubber: self.client.purchase_scheduled_instances( PurchaseRequests=[{'PurchaseToken': 'foo', 'InstanceCount': 123}]) self.assertIn('ClientToken', self.params_seen) botocore-1.5.7/tests/functional/test_stub.py0000666454262600001440000002361313042511306022304 0ustar pysdk-ciamazon00000000000000# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import botocore.config from tests import unittest import botocore import botocore.session import botocore.stub as stub from botocore.stub import Stubber from botocore.exceptions import StubResponseError, ClientError, \ StubAssertionError from botocore.exceptions import ParamValidationError import botocore.client import botocore.retryhandler import botocore.translate class TestStubber(unittest.TestCase): def setUp(self): session = botocore.session.get_session() config = botocore.config.Config(signature_version=botocore.UNSIGNED) self.client = session.create_client('s3', config=config) self.stubber = Stubber(self.client) def test_stubber_returns_response(self): service_response = {'ResponseMetadata': {'foo': 'bar'}} self.stubber.add_response('list_objects', service_response) self.stubber.activate() response = self.client.list_objects(Bucket='foo') self.assertEqual(response, service_response) def test_context_manager_returns_response(self): service_response = {'ResponseMetadata': {'foo': 'bar'}} self.stubber.add_response('list_objects', service_response) with self.stubber: response = self.client.list_objects(Bucket='foo') self.assertEqual(response, service_response) def test_activated_stubber_errors_with_no_registered_stubs(self): self.stubber.activate() # Params one per line for readability. with self.assertRaisesRegexp(StubResponseError, "'Bucket': 'asdfasdfasdfasdf',\n"): self.client.list_objects( Bucket='asdfasdfasdfasdf', Delimiter='asdfasdfasdfasdf', Prefix='asdfasdfasdfasdf', EncodingType='url') def test_stubber_errors_when_stubs_are_used_up(self): self.stubber.add_response('list_objects', {}) self.stubber.activate() self.client.list_objects(Bucket='foo') with self.assertRaises(StubResponseError): self.client.list_objects(Bucket='foo') def test_client_error_response(self): error_code = "AccessDenied" error_message = "Access Denied" self.stubber.add_client_error( 'list_objects', error_code, error_message) self.stubber.activate() with self.assertRaises(ClientError): self.client.list_objects(Bucket='foo') def test_can_add_expected_params_to_client_error(self): self.stubber.add_client_error( 'list_objects', 'Error', 'error', expected_params={'Bucket': 'foo'} ) self.stubber.activate() with self.assertRaises(ClientError): self.client.list_objects(Bucket='foo') def test_can_expected_param_fails_in_client_error(self): self.stubber.add_client_error( 'list_objects', 'Error', 'error', expected_params={'Bucket': 'foo'} ) self.stubber.activate() # We expect an AssertionError instead of a ClientError # because we're calling the operation with the wrong # param value. with self.assertRaises(AssertionError): self.client.list_objects(Bucket='wrong-argument-value') def test_expected_params_success(self): service_response = {} expected_params = {'Bucket': 'foo'} self.stubber.add_response( 'list_objects', service_response, expected_params) self.stubber.activate() # This should be called successfully with no errors being thrown # for mismatching expected params. response = self.client.list_objects(Bucket='foo') self.assertEqual(response, service_response) def test_expected_params_fail(self): service_response = {} expected_params = {'Bucket': 'bar'} self.stubber.add_response( 'list_objects', service_response, expected_params) self.stubber.activate() # This should call should raise an for mismatching expected params. with self.assertRaisesRegexp(StubResponseError, "{'Bucket': 'bar'},\n"): self.client.list_objects(Bucket='foo') def test_expected_params_mixed_with_errors_responses(self): # Add an error response error_code = "AccessDenied" error_message = "Access Denied" self.stubber.add_client_error( 'list_objects', error_code, error_message) # Add a response with incorrect expected params service_response = {} expected_params = {'Bucket': 'bar'} self.stubber.add_response( 'list_objects', service_response, expected_params) self.stubber.activate() # The first call should throw and error as expected. with self.assertRaises(ClientError): self.client.list_objects(Bucket='foo') # The second call should throw an error for unexpected parameters with self.assertRaisesRegexp(StubResponseError, 'Expected parameters'): self.client.list_objects(Bucket='foo') def test_can_continue_to_call_after_expected_params_fail(self): service_response = {} expected_params = {'Bucket': 'bar'} self.stubber.add_response( 'list_objects', service_response, expected_params) self.stubber.activate() # Throw an error for unexpected parameters with self.assertRaises(StubResponseError): self.client.list_objects(Bucket='foo') # The stubber should still have the responses queued up # even though the original parameters did not match the expected ones. self.client.list_objects(Bucket='bar') self.stubber.assert_no_pending_responses() def test_still_relies_on_param_validation_with_expected_params(self): service_response = {} expected_params = {'Buck': 'bar'} self.stubber.add_response( 'list_objects', service_response, expected_params) self.stubber.activate() # Throw an error for invalid parameters with self.assertRaises(ParamValidationError): self.client.list_objects(Buck='bar') def test_any_ignores_param_for_validation(self): service_response = {} expected_params = {'Bucket': stub.ANY} self.stubber.add_response( 'list_objects', service_response, expected_params) self.stubber.add_response( 'list_objects', service_response, expected_params) try: with self.stubber: self.client.list_objects(Bucket='foo') self.client.list_objects(Bucket='bar') except StubAssertionError: self.fail("stub.ANY failed to ignore parameter for validation.") def test_mixed_any_and_concrete_params(self): service_response = {} expected_params = {'Bucket': stub.ANY, 'Key': 'foo.txt'} self.stubber.add_response( 'head_object', service_response, expected_params) self.stubber.add_response( 'head_object', service_response, expected_params) try: with self.stubber: self.client.head_object(Bucket='foo', Key='foo.txt') self.client.head_object(Bucket='bar', Key='foo.txt') except StubAssertionError: self.fail("stub.ANY failed to ignore parameter for validation.") def test_nested_any_param(self): service_response = {} expected_params = { 'Bucket': 'foo', 'Key': 'bar.txt', 'Metadata': { 'MyMeta': stub.ANY, } } self.stubber.add_response( 'put_object', service_response, expected_params) self.stubber.add_response( 'put_object', service_response, expected_params) try: with self.stubber: self.client.put_object( Bucket='foo', Key='bar.txt', Metadata={ 'MyMeta': 'Foo', } ) self.client.put_object( Bucket='foo', Key='bar.txt', Metadata={ 'MyMeta': 'Bar', } ) except StubAssertionError: self.fail( "stub.ANY failed to ignore nested parameter for validation.") def test_ANY_repr(self): self.assertEqual(repr(stub.ANY), '') def test_none_param(self): service_response = {} expected_params = {'Buck': None} self.stubber.add_response( 'list_objects', service_response, expected_params) self.stubber.activate() # Throw an error for invalid parameters with self.assertRaises(StubAssertionError): self.client.list_objects(Buck='bar') def test_many_expected_params(self): service_response = {} expected_params = { 'Bucket': 'mybucket', 'Prefix': 'myprefix', 'Delimiter': '/', 'EncodingType': 'url' } self.stubber.add_response( 'list_objects', service_response, expected_params) try: with self.stubber: self.client.list_objects(**expected_params) except StubAssertionError: self.fail( "Stubber inappropriately raised error for same parameters.") botocore-1.5.7/tests/functional/test_cloudsearchdomain.py0000666454262600001440000000257513042511306025017 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import mock from tests import BaseSessionTest class TestCloudsearchdomain(BaseSessionTest): def setUp(self): super(TestCloudsearchdomain, self).setUp() self.region = 'us-west-2' self.client = self.session.create_client( 'cloudsearchdomain', self.region) def test_search(self): with mock.patch('botocore.endpoint.Session.send') as _send: _send.return_value = mock.Mock( status_code=200, headers={}, content=b'{}') self.client.search(query='foo') sent_request = _send.call_args[0][0] self.assertEqual(sent_request.method, 'POST') self.assertEqual( sent_request.headers.get('Content-Type'), b'application/x-www-form-urlencoded') self.assertIn('q=foo', sent_request.body) botocore-1.5.7/tests/functional/test_client_metadata.py0000666454262600001440000000351013042511306024437 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest import botocore.session class TestClientMeta(unittest.TestCase): def setUp(self): self.session = botocore.session.get_session() def test_region_name_on_meta(self): client = self.session.create_client('s3', 'us-west-2') self.assertEqual(client.meta.region_name, 'us-west-2') def test_endpoint_url_on_meta(self): client = self.session.create_client('s3', 'us-west-2', endpoint_url='https://foo') self.assertEqual(client.meta.endpoint_url, 'https://foo') def test_client_has_standard_partition_on_meta(self): client = self.session.create_client('s3', 'us-west-2') self.assertEqual(client.meta.partition, 'aws') def test_client_has_china_partition_on_meta(self): client = self.session.create_client('s3', 'cn-north-1') self.assertEqual(client.meta.partition, 'aws-cn') def test_client_has_gov_partition_on_meta(self): client = self.session.create_client('s3', 'us-gov-west-1') self.assertEqual(client.meta.partition, 'aws-us-gov') def test_client_has_no_partition_on_meta_if_custom_region(self): client = self.session.create_client('s3', 'myregion') self.assertEqual(client.meta.partition, None) botocore-1.5.7/tests/functional/test_public_apis.py0000666454262600001440000000546613042511306023627 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from collections import defaultdict import mock from botocore.session import Session from botocore.exceptions import NoCredentialsError from botocore import xform_name REGIONS = defaultdict(lambda: 'us-east-1') PUBLIC_API_TESTS = { "cognito-identity": { "GetId": {"IdentityPoolId": "region:1234"}, "GetOpenIdToken": {"IdentityId": "region:1234"}, "UnlinkIdentity": { "IdentityId": "region:1234", "Logins": {}, "LoginsToRemove": []}, "GetCredentialsForIdentity": {"IdentityId": "region:1234"}, }, "sts": { "AssumeRoleWithSaml": { "PrincipalArn": "a"*20, "RoleArn": "a"*20, "SAMLAssertion": "abcd", }, "AssumeRoleWithWebIdentity": { "RoleArn": "a"*20, "RoleSessionName": "foo", "WebIdentityToken": "abcd", }, }, } class EarlyExit(BaseException): pass def _test_public_apis_will_not_be_signed(func, kwargs): with mock.patch('botocore.endpoint.Session.send') as _send: _send.side_effect = EarlyExit("we don't care about response here") try: func(**kwargs) except EarlyExit: pass except NoCredentialsError: assert False, "NoCredentialsError should not be triggered" request = _send.call_args[0][0] sig_v2_disabled = 'SignatureVersion=2' not in request.url assert sig_v2_disabled, "SigV2 is incorrectly enabled" sig_v3_disabled = 'X-Amzn-Authorization' not in request.headers assert sig_v3_disabled, "SigV3 is incorrectly enabled" sig_v4_disabled = 'Authorization' not in request.headers assert sig_v4_disabled, "SigV4 is incorrectly enabled" def test_public_apis_will_not_be_signed(): session = Session() # Mimic the scenario that user does not have aws credentials setup session.get_credentials = mock.Mock(return_value=None) for service_name in PUBLIC_API_TESTS: client = session.create_client(service_name, REGIONS[service_name]) for operation_name in PUBLIC_API_TESTS[service_name]: kwargs = PUBLIC_API_TESTS[service_name][operation_name] method = getattr(client, xform_name(operation_name)) yield (_test_public_apis_will_not_be_signed, method, kwargs) botocore-1.5.7/tests/functional/test_rds.py0000666454262600001440000000527413042511306022122 0ustar pysdk-ciamazon00000000000000# Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import mock from contextlib import contextmanager import botocore.session from tests import BaseSessionTest class TestRDSPresignUrlInjection(BaseSessionTest): def setUp(self): super(TestRDSPresignUrlInjection, self).setUp() self.client = self.session.create_client('rds', 'us-west-2') @contextmanager def patch_http_layer(self, response, status_code=200): with mock.patch('botocore.endpoint.Session.send') as send: send.return_value = mock.Mock(status_code=status_code, headers={}, content=response) yield send def assert_presigned_url_injected_in_request(self, body): self.assertIn('PreSignedUrl', body) self.assertNotIn('SourceRegion', body) def test_copy_snapshot(self): params = { 'SourceDBSnapshotIdentifier': 'source-db', 'TargetDBSnapshotIdentifier': 'target-db', 'SourceRegion': 'us-east-1' } response_body = ( b'' b'' b'' ) with self.patch_http_layer(response_body) as send: self.client.copy_db_snapshot(**params) sent_request = send.call_args[0][0] self.assert_presigned_url_injected_in_request(sent_request.body) def test_create_db_instance_read_replica(self): params = { 'SourceDBInstanceIdentifier': 'source-db', 'DBInstanceIdentifier': 'target-db', 'SourceRegion': 'us-east-1' } response_body = ( b'' b'' b'' b'' ) with self.patch_http_layer(response_body) as send: self.client.create_db_instance_read_replica(**params) sent_request = send.call_args[0][0] self.assert_presigned_url_injected_in_request(sent_request.body) botocore-1.5.7/tests/functional/test_session.py0000666454262600001440000001074013042511306023007 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. from tests import unittest, temporary_file import mock import botocore.session from botocore.exceptions import ProfileNotFound class TestSession(unittest.TestCase): def setUp(self): self.environ = {} self.env_patch = mock.patch('os.environ', self.environ) self.env_patch.start() self.session = botocore.session.get_session() def tearDown(self): self.env_patch.stop() def test_profile_precedence(self): self.environ['AWS_PROFILE'] = 'from_env_var' self.session.set_config_variable('profile', 'from_session_instance') self.assertEqual(self.session.profile, 'from_session_instance') def test_credentials_with_profile_precedence(self): self.environ['AWS_PROFILE'] = 'from_env_var' self.session.set_config_variable('profile', 'from_session_instance') try: creds = self.session.get_credentials() except ProfileNotFound as e: self.assertNotIn('from_env_var', str(e)) self.assertIn('from_session_instance', str(e)) def test_session_profile_overrides_env_vars(self): # If the ".profile" attribute is set then the associated # creds for that profile take precedence over the environment # variables. with temporary_file('w') as f: # We test this by creating creds in two places, # env vars and a fake shared creds file. We ensure # that if an explicit profile is set we pull creds # from the shared creds file. self.environ['AWS_ACCESS_KEY_ID'] = 'env_var_akid' self.environ['AWS_SECRET_ACCESS_KEY'] = 'env_var_sak' self.environ['AWS_SHARED_CREDENTIALS_FILE'] = f.name f.write( '[from_session_instance]\n' 'aws_access_key_id=shared_creds_akid\n' 'aws_secret_access_key=shared_creds_sak\n' ) f.flush() self.session.set_config_variable('profile', 'from_session_instance') creds = self.session.get_credentials() self.assertEqual(creds.access_key, 'shared_creds_akid') self.assertEqual(creds.secret_key, 'shared_creds_sak') def test_profile_does_not_win_if_all_from_env_vars(self): # Creds should be pulled from the env vars because # if access_key/secret_key/profile are all specified on # the same "level", then the explicit creds take # precedence. with temporary_file('w') as f: self.environ['AWS_SHARED_CREDENTIALS_FILE'] = f.name self.environ['AWS_PROFILE'] = 'myprofile' # Even though we don't use the profile for credentials, # if you have a profile configured in any way # (env vars, set when creating a session, etc.) that profile # must exist. So we need to create an empty profile # matching the value from AWS_PROFILE. f.write( '[myprofile]\n' ) f.flush() self.environ['AWS_ACCESS_KEY_ID'] = 'env_var_akid' self.environ['AWS_SECRET_ACCESS_KEY'] = 'env_var_sak' creds = self.session.get_credentials() self.assertEqual(creds.access_key, 'env_var_akid') self.assertEqual(creds.secret_key, 'env_var_sak') def test_provides_available_regions_for_same_endpoint_prefix(self): regions = self.session.get_available_regions('s3') self.assertTrue(regions) def test_provides_available_regions_for_different_endpoint_prefix(self): regions = self.session.get_available_regions('elb') self.assertTrue(regions) def test_does_not_provide_regions_for_mismatch_service_name(self): # elb's endpoint prefix is elasticloadbalancing, but users should # still be using the service name when getting regions regions = self.session.get_available_regions('elasticloadbalancing') self.assertEqual(regions, []) botocore-1.5.7/tests/functional/__init__.py0000666454262600001440000000334213042511306022024 0ustar pysdk-ciamazon00000000000000# Copyright 2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import os import uuid _ORIGINAL = os.environ.copy() # These are environment variables that allow users to control # the location of config files used by botocore. _CONFIG_FILE_ENV_VARS = [ 'AWS_CONFIG_FILE', 'AWS_SHARED_CREDENTIALS_FILE', 'BOTO_CONFIG', ] _CREDENTIAL_ENV_VARS = [ 'AWS_ACCESS_KEY_ID', 'AWS_SECRET_ACCESS_KEY', 'AWS_SESSION_TOKEN', ] def setup_package(): # We're using a random uuid to ensure we're pointing # AWS_CONFIG_FILE and other env vars at a filename that # does not exist. random_file = str(uuid.uuid4()) for varname in _CONFIG_FILE_ENV_VARS: # The reason we're doing this is to ensure we don't automatically pick # up any credentials a developer might have configured on their local # machine. Travis will not have any credentials available, so without # this fixture setup, it's possible to have all the tests pass on your # local machine (if you have credentials configured) but still fail on # travis. os.environ[varname] = random_file for credvar in _CREDENTIAL_ENV_VARS: os.environ.pop(credvar, None) def teardown_package(): os.environ = _ORIGINAL botocore-1.5.7/tests/__init__.py0000666454262600001440000002443513042511306017670 0ustar pysdk-ciamazon00000000000000# Copyright 2012-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"). You # may not use this file except in compliance with the License. A copy of # the License is located at # # http://aws.amazon.com/apache2.0/ # # or in the "license" file accompanying this file. This file is # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF # ANY KIND, either express or implied. See the License for the specific # language governing permissions and limitations under the License. import os import sys import mock import time import random import shutil import contextlib import tempfile import binascii import platform import select import datetime from subprocess import Popen, PIPE from dateutil.tz import tzlocal # The unittest module got a significant overhaul # in 2.7, so if we're in 2.6 we can use the backported # version unittest2. if sys.version_info[:2] == (2, 6): import unittest2 as unittest else: import unittest import botocore.loaders import botocore.session from botocore import utils from botocore import credentials _LOADER = botocore.loaders.Loader() def skip_unless_has_memory_collection(cls): """Class decorator to skip tests that require memory collection. Any test that uses memory collection (such as the resource leak tests) can decorate their class with skip_unless_has_memory_collection to indicate that if the platform does not support memory collection the tests should be skipped. """ if platform.system() not in ['Darwin', 'Linux']: return unittest.skip('Memory tests only supported on mac/linux.')(cls) return cls def random_chars(num_chars): """Returns random hex characters. Useful for creating resources with random names. """ return binascii.hexlify(os.urandom(int(num_chars / 2))).decode('ascii') def create_session(**kwargs): # Create a Session object. By default, # the _LOADER object is used as the loader # so that we reused the same models across tests. session = botocore.session.Session(**kwargs) session.register_component('data_loader', _LOADER) session.set_config_variable('credentials_file', 'noexist/foo/botocore') return session @contextlib.contextmanager def temporary_file(mode): """This is a cross platform temporary file creation. tempfile.NamedTemporary file on windows creates a secure temp file that can't be read by other processes and can't be opened a second time. For tests, we generally *want* them to be read multiple times. The test fixture writes the temp file contents, the test reads the temp file. """ temporary_directory = tempfile.mkdtemp() basename = 'tmpfile-%s-%s' % (int(time.time()), random.randint(1, 1000)) full_filename = os.path.join(temporary_directory, basename) open(full_filename, 'w').close() try: with open(full_filename, mode) as f: yield f finally: shutil.rmtree(temporary_directory) class BaseEnvVar(unittest.TestCase): def setUp(self): # Automatically patches out os.environ for you # and gives you a self.environ attribute that simulates # the environment. Also will automatically restore state # for you in tearDown() self.environ = {} self.environ_patch = mock.patch('os.environ', self.environ) self.environ_patch.start() def tearDown(self): self.environ_patch.stop() class BaseSessionTest(BaseEnvVar): """Base class used to provide credentials. This class can be used as a base class that want to use a real session class but want to be completely isolated from the external environment (including environment variables). This class will also set credential vars so you can make fake requests to services. """ def setUp(self, **environ): super(BaseSessionTest, self).setUp() self.environ['AWS_ACCESS_KEY_ID'] = 'access_key' self.environ['AWS_SECRET_ACCESS_KEY'] = 'secret_key' self.environ['AWS_CONFIG_FILE'] = 'no-exist-foo' self.environ.update(environ) self.session = create_session() self.session.config_filename = 'no-exist-foo' @skip_unless_has_memory_collection class BaseClientDriverTest(unittest.TestCase): INJECT_DUMMY_CREDS = False def setUp(self): self.driver = ClientDriver() env = None if self.INJECT_DUMMY_CREDS: env = {'AWS_ACCESS_KEY_ID': 'foo', 'AWS_SECRET_ACCESS_KEY': 'bar'} self.driver.start(env=env) def cmd(self, *args): self.driver.cmd(*args) def send_cmd(self, *args): self.driver.send_cmd(*args) def record_memory(self): self.driver.record_memory() @property def memory_samples(self): return self.driver.memory_samples def tearDown(self): self.driver.stop() class ClientDriver(object): CLIENT_SERVER = os.path.join( os.path.dirname(os.path.abspath(__file__)), 'cmd-runner' ) def __init__(self): self._popen = None self.memory_samples = [] def _get_memory_with_ps(self, pid): # It would be better to eventually switch to psutil, # which should allow us to test on windows, but for now # we'll just use ps and run on POSIX platforms. command_list = ['ps', '-p', str(pid), '-o', 'rss'] p = Popen(command_list, stdout=PIPE) stdout = p.communicate()[0] if not p.returncode == 0: raise RuntimeError("Could not retrieve memory") else: # Get the RSS from output that looks like this: # RSS # 4496 return int(stdout.splitlines()[1].split()[0]) * 1024 def record_memory(self): mem = self._get_memory_with_ps(self._popen.pid) self.memory_samples.append(mem) def start(self, env=None): """Start up the command runner process.""" self._popen = Popen([sys.executable, self.CLIENT_SERVER], stdout=PIPE, stdin=PIPE, env=env) def stop(self): """Shutdown the command runner process.""" self.cmd('exit') self._popen.wait() def send_cmd(self, *cmd): """Send a command and return immediately. This is a lower level method than cmd(). This method will instruct the cmd-runner process to execute a command, but this method will immediately return. You will need to use ``is_cmd_finished()`` to check that the command is finished. This method is useful if you want to record attributes about the process while an operation is occurring. For example, if you want to instruct the cmd-runner process to upload a 1GB file to S3 and you'd like to record the memory during the upload process, you can use send_cmd() instead of cmd(). """ cmd_str = ' '.join(cmd) + '\n' cmd_bytes = cmd_str.encode('utf-8') self._popen.stdin.write(cmd_bytes) self._popen.stdin.flush() def is_cmd_finished(self): rlist = [self._popen.stdout.fileno()] result = select.select(rlist, [], [], 0.01) if result[0]: return True return False def cmd(self, *cmd): """Send a command and block until it finishes. This method will send a command to the cmd-runner process to run. It will block until the cmd-runner process is finished executing the command and sends back a status response. """ self.send_cmd(*cmd) result = self._popen.stdout.readline().strip() if result != b'OK': raise RuntimeError( "Error from command '%s': %s" % (cmd, result)) # This is added to this file because it's used in both # the functional and unit tests for cred refresh. class IntegerRefresher(credentials.RefreshableCredentials): """Refreshable credentials to help with testing. This class makes testing refreshable credentials easier. It has the following functionality: * A counter, self.refresh_counter, to indicate how many times refresh was called. * A way to specify how many seconds to make credentials valid. * Configurable advisory/mandatory refresh. * An easy way to check consistency. Each time creds are refreshed, all the cred values are set to the next incrementing integer. Frozen credentials should always have this value. """ _advisory_refresh_timeout = 2 _mandatory_refresh_timeout = 1 _credentials_expire = 3 def __init__(self, creds_last_for=_credentials_expire, advisory_refresh=_advisory_refresh_timeout, mandatory_refresh=_mandatory_refresh_timeout, refresh_function=None): expires_in = ( self._current_datetime() + datetime.timedelta(seconds=creds_last_for)) if refresh_function is None: refresh_function = self._do_refresh super(IntegerRefresher, self).__init__( '0', '0', '0', expires_in, refresh_function, 'INTREFRESH') self.creds_last_for = creds_last_for self.refresh_counter = 0 self._advisory_refresh_timeout = advisory_refresh self._mandatory_refresh_timeout = mandatory_refresh def _do_refresh(self): self.refresh_counter += 1 current = int(self._access_key) next_id = str(current + 1) return { 'access_key': next_id, 'secret_key': next_id, 'token': next_id, 'expiry_time': self._seconds_later(self.creds_last_for), } def _seconds_later(self, num_seconds): # We need to guarantee at *least* num_seconds. # Because this doesn't handle subsecond precision # we'll round up to the next second. num_seconds += 1 t = self._current_datetime() + datetime.timedelta(seconds=num_seconds) return self._to_timestamp(t) def _to_timestamp(self, datetime_obj): obj = utils.parse_to_aware_datetime(datetime_obj) return obj.strftime('%Y-%m-%dT%H:%M:%SZ') def _current_timestamp(self): return self._to_timestamp(self._current_datetime()) def _current_datetime(self): return datetime.datetime.now(tzlocal()) botocore-1.5.7/LICENSE.txt0000666454262600001440000000104513042511306016230 0ustar pysdk-ciamazon00000000000000Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with the License. A copy of the License is located at http://aws.amazon.com/apache2.0/ or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.